Add analysis server API specification and related tools.

pkg/analysis_server/test/integration/protocol_matchers.dart

-// Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
+// Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file');

[Brian Wilkerson, 2014/08/06 18:12:05]

Remove the trailing ');

[jwren, 2014/08/06 18:12:52]

');   ..  typo?  Doesn't look generated

[Paul Berry, 2014/08/06 18:32:43]

Done.

 // 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.
+//
+// This file has been automatically generated.  Please do not edit it manually.
+// To regenerate the file, use the script
+// "pkg/analysis_server/spec/generate_files".
 
 /**
  * Matchers for data types defined in the analysis server API
  */
 library test.integration.protocol.matchers;
 
 import 'package:unittest/unittest.dart';
 
 import 'integration_tests.dart';
 
+
 /**
  * server.getVersion params
  */
 final Matcher isServerGetVersionParams = isNull;
 
 /**
  * server.getVersion result
  *
  * {
  *   "version": String
@@ skipping 205 matching lines @@
   "analysis.updateOptions params", {
     "options": isAnalysisOptions
   });
 
 /**
  * analysis.updateOptions result
  */
 final Matcher isAnalysisUpdateOptionsResult = isNull;
 
 /**
- * analysis.updateSdks params
- *
- * {
- *   "added": List<FilePath>
- *   "removed": List<FilePath>
- *   "default": optional FilePath
- * }
- */
-final Matcher isAnalysisUpdateSdksParams = new MatchesJsonObject(
-  "analysis.updateSdks params", {
-    "added": isListOf(isFilePath),
-    "removed": isListOf(isFilePath)
-  }, optionalFields: {
-    "default": isFilePath
-  });
-
-/**
- * analysis.updateSdks result
- */
-final Matcher isAnalysisUpdateSdksResult = isNull;
-
-/**
  * analysis.errors params
  *
  * {
  *   "file": FilePath
  *   "errors": List<AnalysisError>
  * }
  */
 final Matcher isAnalysisErrorsParams = new MatchesJsonObject(
   "analysis.errors params", {
     "file": isFilePath,
     "errors": isListOf(isAnalysisError)
   });
 
 /**
+ * analysis.flushResults params
+ *
+ * {
+ *   "files": List<FilePath>
+ * }
+ */
+final Matcher isAnalysisFlushResultsParams = new MatchesJsonObject(
+  "analysis.flushResults params", {
+    "files": isListOf(isFilePath)
+  });
+
+/**
  * analysis.folding params
  *
  * {
  *   "file": FilePath
  *   "regions": List<FoldingRegion>
  * }
  */
 final Matcher isAnalysisFoldingParams = new MatchesJsonObject(
   "analysis.folding params", {
     "file": isFilePath,
@@ skipping 229 matching lines @@
 final Matcher isSearchGetTypeHierarchyParams = new MatchesJsonObject(
   "search.getTypeHierarchy params", {
     "file": isFilePath,
     "offset": isInt
   });
 
 /**
  * search.getTypeHierarchy result
  *
  * {
- *   "hierarchy": TypeHierarchyItem
+ *   "hierarchyItems": List<TypeHierarchyItem>
  * }
  */
 final Matcher isSearchGetTypeHierarchyResult = new MatchesJsonObject(
   "search.getTypeHierarchy result", {
-    "hierarchy": isTypeHierarchyItem
+    "hierarchyItems": isListOf(isTypeHierarchyItem)
   });
 
 /**
  * search.results params
  *
  * {
  *   "id": SearchId
  *   "results": List<SearchResult>
  *   "last": bool
  * }
  */
 final Matcher isSearchResultsParams = new MatchesJsonObject(
   "search.results params", {
     "id": isSearchId,
     "results": isListOf(isSearchResult),
     "last": isBool
   });
 
 /**
- * edit.applyRefactoring params
+ * edit.getAssists params
  *
  * {
- *   "id": RefactoringId
- * }
- */
-final Matcher isEditApplyRefactoringParams = new MatchesJsonObject(
-  "edit.applyRefactoring params", {
-    "id": isRefactoringId
-  });
-
-/**
- * edit.applyRefactoring result
- *
- * {
- *   "status": List<RefactoringProblem>
- *   "change": SourceChange
- * }
- */
-final Matcher isEditApplyRefactoringResult = new MatchesJsonObject(
-  "edit.applyRefactoring result", {
-    "status": isListOf(isRefactoringProblem),
-    "change": isSourceChange
-  });
-
-/**
- * edit.createRefactoring params
- *
- * {
- *   "kindId": RefactoringKind
  *   "file": FilePath
  *   "offset": int
  *   "length": int
  * }
  */
-final Matcher isEditCreateRefactoringParams = new MatchesJsonObject(
-  "edit.createRefactoring params", {
-    "kindId": isRefactoringKind,
+final Matcher isEditGetAssistsParams = new MatchesJsonObject(
+  "edit.getAssists params", {
     "file": isFilePath,
     "offset": isInt,
     "length": isInt
   });
 
 /**
- * edit.createRefactoring result
+ * edit.getAssists result
  *
  * {
- *   "id": RefactoringId
- *   "status": List<RefactoringProblem>
+ *   "assists": List<SourceChange>
  * }
  */
-final Matcher isEditCreateRefactoringResult = new MatchesJsonObject(
-  "edit.createRefactoring result", {
-    "id": isRefactoringId,
-    "status": isListOf(isRefactoringProblem)
+final Matcher isEditGetAssistsResult = new MatchesJsonObject(
+  "edit.getAssists result", {
+    "assists": isListOf(isSourceChange)
   });
 
 /**
- * edit.deleteRefactoring params
- *
- * {
- *   "id": RefactoringId
- * }
- */
-final Matcher isEditDeleteRefactoringParams = new MatchesJsonObject(
-  "edit.deleteRefactoring params", {
-    "id": isRefactoringId
-  });
-
-/**
- * edit.deleteRefactoring result
- */
-final Matcher isEditDeleteRefactoringResult = isNull;
-
-/**
- * edit.getAssists params
+ * edit.getAvailableRefactorings params
  *
  * {
  *   "file": FilePath
  *   "offset": int
  *   "length": int
  * }
  */
-final Matcher isEditGetAssistsParams = new MatchesJsonObject(
-  "edit.getAssists params", {
+final Matcher isEditGetAvailableRefactoringsParams = new MatchesJsonObject(
+  "edit.getAvailableRefactorings params", {
     "file": isFilePath,
     "offset": isInt,
     "length": isInt
   });
 
 /**
- * edit.getAssists result
+ * edit.getAvailableRefactorings result
  *
  * {
- *   "assists": List<SourceChange>
+ *   "kinds": List<RefactoringKind>
  * }
  */
-final Matcher isEditGetAssistsResult = new MatchesJsonObject(
-  "edit.getAssists result", {
-    "assists": isListOf(isSourceChange)
+final Matcher isEditGetAvailableRefactoringsResult = new MatchesJsonObject(
+  "edit.getAvailableRefactorings result", {
+    "kinds": isListOf(isRefactoringKind)
   });
 
 /**
  * edit.getFixes params
  *
  * {
  *   "file": FilePath
  *   "offset": int
  * }
  */
 final Matcher isEditGetFixesParams = new MatchesJsonObject(
   "edit.getFixes params", {
     "file": isFilePath,
     "offset": isInt
   });
 
 /**
  * edit.getFixes result
  *
  * {
  *   "fixes": List<ErrorFixes>
  * }
  */
 final Matcher isEditGetFixesResult = new MatchesJsonObject(
   "edit.getFixes result", {
     "fixes": isListOf(isErrorFixes)
   });
 
 /**
- * edit.getRefactorings params
+ * edit.getRefactoring params
  *
  * {
+ *   "kindId": RefactoringKind
  *   "file": FilePath
  *   "offset": int
  *   "length": int
+ *   "validateOnly": bool
+ *   "options": optional object
  * }
  */
-final Matcher isEditGetRefactoringsParams = new MatchesJsonObject(
-  "edit.getRefactorings params", {
+final Matcher isEditGetRefactoringParams = new MatchesJsonObject(
+  "edit.getRefactoring params", {
+    "kindId": isRefactoringKind,
     "file": isFilePath,
     "offset": isInt,
-    "length": isInt
+    "length": isInt,
+    "validateOnly": isBool
+  }, optionalFields: {
+    "options": isObject
   });
 
 /**
- * edit.getRefactorings result
+ * edit.getRefactoring result
  *
  * {
- *   "kinds": List<RefactoringKind>
+ *   "status": List<RefactoringProblem>
+ *   "feedback": optional object
+ *   "change": optional SourceChange
  * }
  */
-final Matcher isEditGetRefactoringsResult = new MatchesJsonObject(
-  "edit.getRefactorings result", {
-    "kinds": isListOf(isRefactoringKind)
+final Matcher isEditGetRefactoringResult = new MatchesJsonObject(
+  "edit.getRefactoring result", {
+    "status": isListOf(isRefactoringProblem)
+  }, optionalFields: {
+    "feedback": isObject,
+    "change": isSourceChange
   });
 
 /**
- * edit.setRefactoringOptions params
- *
- * {
- *   "id": RefactoringId
- * }
- */
-final Matcher isEditSetRefactoringOptionsParams = new MatchesJsonObject(
-  "edit.setRefactoringOptions params", {
-    "id": isRefactoringId
-  });
-
-/**
- * edit.setRefactoringOptions result
- *
- * {
- *   "status": List<RefactoringProblem>
- * }
- */
-final Matcher isEditSetRefactoringOptionsResult = new MatchesJsonObject(
-  "edit.setRefactoringOptions result", {
-    "status": isListOf(isRefactoringProblem)
-  });
-
-/**
  * debug.createContext params
  *
  * {
  *   "contextRoot": FilePath
  * }
  */
 final Matcher isDebugCreateContextParams = new MatchesJsonObject(
   "debug.createContext params", {
     "contextRoot": isFilePath
   });
@@ skipping 133 matching lines @@
     "enableDeferredLoading": isBool,
     "enableEnums": isBool,
     "generateDart2jsHints": isBool,
     "generateHints": isBool
   });
 
 /**
  * AnalysisService
  *
  * enum {
- *   ERRORS
  *   FOLDING
  *   HIGHLIGHTS
  *   NAVIGATION
  *   OCCURRENCES
  *   OUTLINE
  *   OVERRIDES
  * }
  */
 final Matcher isAnalysisService = isIn([
-  "ERRORS",
   "FOLDING",
   "HIGHLIGHTS",
   "NAVIGATION",
   "OCCURRENCES",
   "OUTLINE",
   "OVERRIDES"
 ]);
 
 /**
  * AnalysisStatus
@@ skipping 84 matching lines @@
  *   ARGUMENT_LIST
  *   CLASS
  *   CLASS_ALIAS
  *   CONSTRUCTOR
  *   FIELD
  *   FUNCTION
  *   FUNCTION_TYPE_ALIAS
  *   GETTER
  *   IMPORT
  *   LIBRARY_PREFIX
+ *   LOCAL_VARIABLE
  *   METHOD
  *   METHOD_NAME
  *   NAMED_ARGUMENT
  *   OPTIONAL_ARGUMENT
  *   PARAMETER
  *   SETTER
  *   TOP_LEVEL_VARIABLE
  *   TYPE_PARAMETER
- *   VARIABLE
  * }
  */
 final Matcher isCompletionSuggestionKind = isIn([
   "ARGUMENT_LIST",
   "CLASS",
   "CLASS_ALIAS",
   "CONSTRUCTOR",
   "FIELD",
   "FUNCTION",
   "FUNCTION_TYPE_ALIAS",
   "GETTER",
   "IMPORT",
   "LIBRARY_PREFIX",
+  "LOCAL_VARIABLE",
   "METHOD",
   "METHOD_NAME",
   "NAMED_ARGUMENT",
   "OPTIONAL_ARGUMENT",
   "PARAMETER",
   "SETTER",
   "TOP_LEVEL_VARIABLE",
-  "TYPE_PARAMETER",
-  "VARIABLE"
+  "TYPE_PARAMETER"
 ]);
 
 /**
  * ContentChange
  *
  * {
  *   "content": String
  *   "offset": optional int
  *   "oldLength": optional int
  *   "newLength": optional int
@@ skipping 25 matching lines @@
 final Matcher isDebugService = isIn([
   "LAUNCH_DATA"
 ]);
 
 /**
  * Element
  *
  * {
  *   "kind": ElementKind
  *   "name": String
- *   "location": Location
+ *   "location": optional Location
  *   "flags": int
  *   "parameters": optional String
  *   "returnType": optional String
  * }
  */
 final Matcher isElement = new MatchesJsonObject(
   "Element", {
     "kind": isElementKind,
     "name": isString,
-    "location": isLocation,
     "flags": isInt
   }, optionalFields: {
+    "location": isLocation,
     "parameters": isString,
     "returnType": isString
   });
 
 /**
  * ElementKind
  *
  * enum {
  *   CLASS
  *   CLASS_TYPE_ALIAS
@@ skipping 31 matching lines @@
   "TYPE_PARAMETER",
   "UNKNOWN",
   "UNIT_TEST_GROUP",
   "UNIT_TEST_TEST"
 ]);
 
 /**
  * Error
  *
  * {
- *   "code": String
+ *   "code": int
  *   "message": String
  *   "data": optional object
  * }
  */
 final Matcher isError = new MatchesJsonObject(
   "Error", {
-    // TODO(paulberry): the API spec says "code" should be a string, but the
-    // server is currently outputting integers.
     "code": isInt,
     "message": isString
   }, optionalFields: {
     "data": isObject
   });
 
 /**
  * ErrorFixes
  *
  * {
@@ skipping 234 matching lines @@
     "containingLibraryName": isString,
     "dartdoc": isString,
     "elementDescription": isString,
     "elementKind": isString,
     "parameter": isString,
     "propagatedType": isString,
     "staticType": isString
   });
 
 /**
+ * LinkedEditGroup
+ *
+ * {
+ *   "positions": List<Position>
+ *   "length": int
+ *   "suggestions": List<LinkedEditSuggestion>
+ * }
+ */
+final Matcher isLinkedEditGroup = new MatchesJsonObject(
+  "LinkedEditGroup", {
+    "positions": isListOf(isPosition),
+    "length": isInt,
+    "suggestions": isListOf(isLinkedEditSuggestion)
+  });
+
+/**
+ * LinkedEditSuggestion
+ *
+ * {
+ *   "value": String
+ *   "kind": LinkedEditSuggestionKind
+ * }
+ */
+final Matcher isLinkedEditSuggestion = new MatchesJsonObject(
+  "LinkedEditSuggestion", {
+    "value": isString,
+    "kind": isLinkedEditSuggestionKind
+  });
+
+/**
+ * LinkedEditSuggestionKind
+ *
+ * enum {
+ *   METHOD
+ *   PARAMETER
+ *   TYPE
+ *   VARIABLE
+ * }
+ */
+final Matcher isLinkedEditSuggestionKind = isIn([
+  "METHOD",
+  "PARAMETER",
+  "TYPE",
+  "VARIABLE"
+]);
+
+/**
  * Location
  *
  * {
  *   "file": FilePath
  *   "offset": int
  *   "length": int
  *   "startLine": int
  *   "startColumn": int
  * }
  */
@@ skipping 98 matching lines @@
  *   "name": String
  * }
  */
 final Matcher isParameter = new MatchesJsonObject(
   "Parameter", {
     "type": isString,
     "name": isString
   });
 
 /**
+ * Position
+ *
+ * {
+ *   "file": FilePath
+ *   "offset": int
+ * }
+ */
+final Matcher isPosition = new MatchesJsonObject(
+  "Position", {
+    "file": isFilePath,
+    "offset": isInt
+  });
+
+/**
  * RefactoringId
  *
  * String
  */
 final Matcher isRefactoringId = isString;
 
 /**
  * RefactoringKind
  *
  * enum {
@@ skipping 105 matching lines @@
 final Matcher isServerService = isIn([
   "STATUS"
 ]);
 
 /**
  * SourceChange
  *
  * {
  *   "message": String
  *   "edits": List<SourceFileEdit>
+ *   "linkedEditGroups": List<LinkedEditGroup>
+ *   "selection": optional Position
  * }
  */
 final Matcher isSourceChange = new MatchesJsonObject(
   "SourceChange", {
     "message": isString,
-    "edits": isListOf(isSourceFileEdit)
+    "edits": isListOf(isSourceFileEdit),
+    "linkedEditGroups": isListOf(isLinkedEditGroup)
+  }, optionalFields: {
+    "selection": isPosition
   });
 
 /**
  * SourceEdit
  *
  * {
  *   "offset": int
  *   "length": int
  *   "replacement": String
  * }
@@ skipping 19 matching lines @@
     "edits": isListOf(isSourceEdit)
   });
 
 /**
  * TypeHierarchyItem
  *
  * {
  *   "classElement": Element
  *   "displayName": optional String
  *   "memberElement": optional Element
- *   "superclass": optional TypeHierarchyItem
- *   "interfaces": List<TypeHierarchyItem>
- *   "mixins": List<TypeHierarchyItem>
- *   "subclasses": List<TypeHierarchyItem>
+ *   "superclass": optional int
+ *   "interfaces": List<int>
+ *   "mixins": List<int>
+ *   "subclasses": List<int>
  * }
  */
 final Matcher isTypeHierarchyItem = new MatchesJsonObject(
   "TypeHierarchyItem", {
     "classElement": isElement,
-    "interfaces": isListOf(isTypeHierarchyItem),
-    "mixins": isListOf(isTypeHierarchyItem),
-    "subclasses": isListOf(isTypeHierarchyItem)
+    "interfaces": isListOf(isInt),
+    "mixins": isListOf(isInt),
+    "subclasses": isListOf(isInt)
   }, optionalFields: {
     "displayName": isString,
     "memberElement": isElement,
-    "superclass": isTypeHierarchyItem
+    "superclass": isInt
   });
 
+/**
+ * convertGetterToMethod feedback
+ */
+final Matcher isConvertGetterToMethodFeedback = isNull;
+
+/**
+ * convertGetterToMethod options
+ */
+final Matcher isConvertGetterToMethodOptions = isNull;
+
+/**
+ * convertMethodToGetter feedback
+ */
+final Matcher isConvertMethodToGetterFeedback = isNull;
+
+/**
+ * convertMethodToGetter options
+ */
+final Matcher isConvertMethodToGetterOptions = isNull;
+
+/**
+ * extractLocalVariable feedback
+ *
+ * {
+ *   "names": List<String>
+ *   "offsets": List<int>
+ *   "lengths": List<int>
+ * }
+ */
+final Matcher isExtractLocalVariableFeedback = new MatchesJsonObject(
+  "extractLocalVariable feedback", {
+    "names": isListOf(isString),
+    "offsets": isListOf(isInt),
+    "lengths": isListOf(isInt)
+  });
+
+/**
+ * extractLocalVariable options
+ *
+ * {
+ *   "name": String
+ *   "extractAll": bool
+ * }
+ */
+final Matcher isExtractLocalVariableOptions = new MatchesJsonObject(
+  "extractLocalVariable options", {
+    "name": isString,
+    "extractAll": isBool
+  });
+
+/**
+ * extractMethod feedback
+ *
+ * {
+ *   "offset": int
+ *   "length": int
+ *   "returnType": String
+ *   "names": List<String>
+ *   "canCreateGetter": bool
+ *   "parameters": List<Parameter>
+ *   "occurrences": int
+ *   "offsets": List<int>
+ *   "lengths": List<int>
+ * }
+ */
+final Matcher isExtractMethodFeedback = new MatchesJsonObject(
+  "extractMethod feedback", {
+    "offset": isInt,
+    "length": isInt,
+    "returnType": isString,
+    "names": isListOf(isString),
+    "canCreateGetter": isBool,
+    "parameters": isListOf(isParameter),
+    "occurrences": isInt,
+    "offsets": isListOf(isInt),
+    "lengths": isListOf(isInt)
+  });
+
+/**
+ * extractMethod options
+ *
+ * {
+ *   "returnType": String
+ *   "createGetter": bool
+ *   "name": String
+ *   "parameters": List<Parameter>
+ *   "extractAll": bool
+ * }
+ */
+final Matcher isExtractMethodOptions = new MatchesJsonObject(
+  "extractMethod options", {
+    "returnType": isString,
+    "createGetter": isBool,
+    "name": isString,
+    "parameters": isListOf(isParameter),
+    "extractAll": isBool
+  });
+
+/**
+ * inlineLocalVariable feedback
+ */
+final Matcher isInlineLocalVariableFeedback = isNull;
+
+/**
+ * inlineLocalVariable options
+ */
+final Matcher isInlineLocalVariableOptions = isNull;
+
+/**
+ * inlineMethod feedback
+ */
+final Matcher isInlineMethodFeedback = isNull;
+
+/**
+ * inlineMethod options
+ *
+ * {
+ *   "deleteSource": bool
+ *   "inlineAll": bool
+ * }
+ */
+final Matcher isInlineMethodOptions = new MatchesJsonObject(
+  "inlineMethod options", {
+    "deleteSource": isBool,
+    "inlineAll": isBool
+  });
+
+/**
+ * rename feedback
+ *
+ * {
+ *   "offset": int
+ *   "length": int
+ * }
+ */
+final Matcher isRenameFeedback = new MatchesJsonObject(
+  "rename feedback", {
+    "offset": isInt,
+    "length": isInt
+  });
+
+/**
+ * rename options
+ *
+ * {
+ *   "newName": String
+ * }
+ */
+final Matcher isRenameOptions = new MatchesJsonObject(
+  "rename options", {
+    "newName": isString
+  });
+