Analysis server format service wiring (and protocol doc update).

pkg/analysis_server/lib/src/edit/edit_domain.dart

 // Copyright (c) 2014, 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.
 
 library edit.domain;
 
 import 'dart:async';
 
 import 'package:analysis_server/src/analysis_server.dart';
 import 'package:analysis_server/src/collections.dart';
 import 'package:analysis_server/src/constants.dart';
 import 'package:analysis_server/src/protocol_server.dart' hide Element;
 import 'package:analysis_server/src/services/correction/assist.dart';
 import 'package:analysis_server/src/services/correction/fix.dart';
 import 'package:analysis_server/src/services/correction/sort_members.dart';
 import 'package:analysis_server/src/services/correction/status.dart';
 import 'package:analysis_server/src/services/refactoring/refactoring.dart';
 import 'package:analysis_server/src/services/search/search_engine.dart';
 import 'package:analyzer/src/generated/ast.dart';
 import 'package:analyzer/src/generated/element.dart';
 import 'package:analyzer/src/generated/engine.dart' as engine;
 import 'package:analyzer/src/generated/error.dart' as engine;
 import 'package:analyzer/src/generated/parser.dart' as engine;
 import 'package:analyzer/src/generated/scanner.dart' as engine;
 import 'package:analyzer/src/generated/source.dart';
+import 'package:dart_style/dart_style.dart';

[danrubel, 2015/01/13 19:35:18]

Do we need to update the analysis_server pubspec?

[pquitslund, 2015/01/13 20:06:55]

Why not!  Done.

 
 
 bool test_simulateRefactoringException_change = false;
 bool test_simulateRefactoringException_final = false;
 bool test_simulateRefactoringException_init = false;
 
 
 /**
  * Instances of the class [EditDomainHandler] implement a [RequestHandler]
  * that handles requests in the edit domain.
@@ skipping 13 matching lines @@
 
   /**
    * Initialize a newly created handler to handle requests for the given [server].
    */
   EditDomainHandler(this.server) {
     searchEngine = server.searchEngine;
     refactoringManager = new _RefactoringManager(server, searchEngine);
   }
 
   Response format(Request request) {
-    throw new RequestFailure(
-        new Response.unsupportedFeature(
-            request.id,
-            'The edit.format request is not yet supported'));
 
-//    EditFormatParams params = new EditFormatParams.fromRequest(request);
-//    String file = params.file;
-//    int initialOffset = params.selectionOffset;
-//    int initialLength = params.selectionLength;
-//
-//    List<SourceEdit> edits = <SourceEdit>[];
-//    int finalOffset = initialOffset;
-//    int finalLength = initialLength;
-//    return new EditFormatResult(edits, finalOffset, finalLength).toResponse(request.id);
+    EditFormatParams params = new EditFormatParams.fromRequest(request);
+    String file = params.file;
+
+    engine.AnalysisContext context = server.getAnalysisContext(file);
+    if (context == null) {
+      return new Response.formatInvalidFile(request);
+    }

[pquitslund, 2015/01/13 18:54:08]

Comments welcome especially on error handling.  Should I add more?

+
+    Source source = server.getSource(file);
+    engine.TimestampedData<String> contents = context.getContents(source);

[Brian Wilkerson, 2015/01/13 19:29:47]

The method getContents will throw an exception if the contents cannot be
accessed (for example, if the file doesn't exist). This should be wrapped in a
try/catch and a formatInvalidFile response should be returned.

[pquitslund, 2015/01/13 20:06:54]

Done.

+    String unformattedSource = contents.data;
+
+    SourceCode code = new SourceCode(
+        unformattedSource,
+        uri: null,
+        isCompilationUnit: true,
+        selectionStart: params.selectionOffset,
+        selectionLength: params.selectionLength);
+    DartFormatter formatter = new DartFormatter();
+    SourceCode formattedResult = formatter.formatSource(code);
+    String formattedSource = formattedResult.text;
+
+    List<SourceEdit> edits = <SourceEdit>[];
+
+    if (formattedSource != unformattedSource) {
+      SourceEdit edit =

[Brian Wilkerson, 2015/01/13 19:29:47]

Perhaps add a TODO to consider producing more efficient results (smaller edits).
A discussion of the techniques we've discussed would be good, just so we don't
forget.

[pquitslund, 2015/01/13 20:06:54]

Done.

+          new SourceEdit(0, unformattedSource.length, formattedSource);
+      edits.add(edit);
+    }
+
+    return new EditFormatResult(
+        edits,
+        formattedResult.selectionStart,
+        formattedResult.selectionLength).toResponse(request.id);
   }
 
   Response getAssists(Request request) {
     var params = new EditGetAssistsParams.fromRequest(request);
     List<SourceChange> changes = <SourceChange>[];
     List<CompilationUnit> units =
         server.getResolvedCompilationUnits(params.file);
     if (units.isNotEmpty) {
       CompilationUnit unit = units[0];
       List<Assist> assists =
@@ skipping 461 matching lines @@
     }
     if (refactoring is RenameRefactoring) {
       RenameRefactoring renameRefactoring = refactoring;
       RenameOptions renameOptions = params.options;
       renameRefactoring.newName = renameOptions.newName;
       return renameRefactoring.checkNewName();
     }
     return new RefactoringStatus();
   }
 }