pkg/analysis_server/lib/src/flutter/flutter_correction.dart

// Copyright (c) 2018, the Dart project authors.  Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

import 'dart:async';

import 'package:analysis_server/src/services/correction/util.dart';
import 'package:analyzer/dart/analysis/session.dart';
import 'package:analyzer/dart/ast/ast.dart';
import 'package:analyzer/src/dart/ast/utilities.dart';
import 'package:analyzer/src/generated/source.dart';
import 'package:analyzer_plugin/protocol/protocol_common.dart' hide Element;
import 'package:analyzer_plugin/utilities/change_builder/change_builder_dart.dart';
import 'package:meta/meta.dart';

class FlutterCorrections {
  final String file;
  final String fileContent;

  final int selectionOffset;
  final int selectionLength;
  final int selectionEnd;
  final SourceRange selectionRange;

  final AnalysisSession session;
  final CompilationUnit unit;

  AstNode node;
  CorrectionUtils utils;

  FlutterCorrections(
      {@required this.file,
      @required this.fileContent,
      @required this.selectionOffset,
      @required this.selectionLength,
      @required this.session,
      @required this.unit})
      : assert(file != null),
        assert(fileContent != null),
        assert(selectionOffset != null),
        assert(selectionLength != null),
        assert(session != null),
        assert(unit != null),
        selectionEnd = selectionOffset + selectionLength,
        selectionRange = new SourceRange(selectionOffset, selectionLength) {
    node = new NodeLocator(selectionOffset, selectionEnd).searchWithin(unit);
    utils = new CorrectionUtils(unit, buffer: fileContent);
  }

  /**
   * Returns the EOL to use for this [CompilationUnit].
   */
  String get eol => utils.endOfLine;

  Future<SourceChange> addForDesignTimeConstructor() async {
    // TODO(brianwilkerson) Determine whether this await is necessary.
    await null;
    final node = this.node;
    if (node is ClassDeclaration) {
      var className = node.name.name;
      var location = utils.prepareNewConstructorLocation(node);
      var changeBuilder = new DartChangeBuilder(session);
      await changeBuilder.addFileEdit(file, (builder) {
        builder.addInsertion(location.offset, (builder) {
          builder.write(location.prefix);

          // If there are no constructors, we need to add also default.
          bool hasConstructors =
              node.members.any((m) => m is ConstructorDeclaration);
          if (!hasConstructors) {
            builder.writeln('$className();');
            builder.writeln();
            builder.write('  ');
          }

          builder.writeln('factory $className.forDesignTime() {');
          builder.writeln('    // TODO: add arguments');
          builder.writeln('    return new $className();');
          builder.write('  }');
          builder.write(location.suffix);
        });
      });
      return changeBuilder.sourceChange;
    }
    return null;
  }
}