pkg/analyzer_plugin/tool/spec/common_types_spec.html - Issue 2876023003: Allow the common spec types to be in a separate document

Unified Diff: pkg/analyzer_plugin/tool/spec/common_types_spec.html

Issue 2876023003: Allow the common spec types to be in a separate document (Closed)

Patch Set: Created 3 years, 7 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Index: pkg/analyzer_plugin/tool/spec/common_types_spec.html

diff --git a/pkg/analyzer_plugin/tool/spec/common_types_spec.html b/pkg/analyzer_plugin/tool/spec/common_types_spec.html

new file mode 100644

index 0000000000000000000000000000000000000000..eacb915283ae2c04290897ea3e8971fd910ab175

--- /dev/null

+++ b/pkg/analyzer_plugin/tool/spec/common_types_spec.html

@@ -0,0 +1,1357 @@

+<!doctype html>

+<html>

+<head>

+ <meta charset="UTF-8"/>

+ <title>Common Types</title>

+</head>

+<body>

+<h1>Common Types</h1>

+<version>1.0.0</version>

+

+ This document contains a specification of the types that are common between

+ the analysis server wire protocol and the analysis server plugin wire

+ protocol. While those protocols are versioned, the common types are not

+ versioned separately.

+

+

+ When those protocols have identical definitions of a type, the type definition

+ should be removed from the two individual specifications and added to this

+ document. Two definitions of a type are identical if the HTML that defines the

+ types is identical and if all of the types referenced by those two types are

+ identical.

+

+

+ When it becomes necessary to change the definition of a common type in one

+ protocol such that the type will no longer be common, that type and any types

+ that reference that type must be removed from this document and added to both

+ of the documents that include this document.

+

+<types>

+ <type name="AddContentOverlay">

+

+ A directive to begin overlaying the contents of a file. The supplied

+ content will be used for analysis in place of the file contents in the

+ filesystem.

+

+

+ If this directive is used on a file that already has a file content

+ overlay, the old overlay is discarded and replaced with the new one.

+

+ <object>

+ <field name="type" value="add">

+ <ref>String</ref>

+ </field>

+ <field name="content">

+ <ref>String</ref>

+

+ The new content of the file.

+

+ </field>

+ </object>

+ </type>

+ <type name="AnalysisError">

+

+ An indication of an error, warning, or hint that was produced by the

+ analysis.

+

+ <object>

+ <field name="severity">

+ <ref>AnalysisErrorSeverity</ref>

+

+ The severity of the error.

+

+ </field>

+ <field name="type">

+ <ref>AnalysisErrorType</ref>

+

+ The type of the error.

+

+ </field>

+ <field name="location">

+ <ref>Location</ref>

+

+ The location associated with the error.

+

+ </field>

+ <field name="message">

+ <ref>String</ref>

+

+ The message to be displayed for this error. The message should

+ indicate what is wrong with the code and why it is wrong.

+

+ </field>

+ <field name="correction" optional="true">

+ <ref>String</ref>

+

+ The correction message to be displayed for this error. The correction

+ message should indicate how the user can fix the error. The field is

+ omitted if there is no correction message associated with the error

+ code.

+

+ </field>

+ <field name="code">

+ <ref>String</ref>

+

+ The name, as a string, of the error code associated with this error.

+

+ </field>

+ <field name="hasFix" optional="true">

+ <ref>bool</ref>

+

+ A hint to indicate to interested clients that this error has an

+ associated fix (or fixes). The absence of this field implies there

+ are not known to be fixes. Note that since the operation to calculate

+ whether fixes apply needs to be performant it is possible that

+ complicated tests will be skipped and a false negative returned. For

+ this reason, this attribute should be treated as a "hint". Despite the

+ possibility of false negatives, no false positives should be returned.

+ If a client sees this flag set they can proceed with the confidence

+ that there are in fact associated fixes.

+

+ </field>

+ </object>

+ </type>

+ <type name="AnalysisErrorSeverity">

+

+ An enumeration of the possible severities of analysis errors.

+

+ <enum>

+ <value><code>INFO</code></value>

+ <value><code>WARNING</code></value>

+ <value><code>ERROR</code></value>

+ </enum>

+ </type>

+ <type name="AnalysisErrorType">

+

+ An enumeration of the possible types of analysis errors.

+

+ <enum>

+ <value><code>CHECKED_MODE_COMPILE_TIME_ERROR</code></value>

+ <value><code>COMPILE_TIME_ERROR</code></value>

+ <value><code>HINT</code></value>

+ <value><code>LINT</code></value>

+ <value><code>STATIC_TYPE_WARNING</code></value>

+ <value><code>STATIC_WARNING</code></value>

+ <value><code>SYNTACTIC_ERROR</code></value>

+ <value><code>TODO</code></value>

+ </enum>

+ </type>

+ <type name="ChangeContentOverlay">

+

+ A directive to modify an existing file content overlay. One or more ranges

+ of text are deleted from the old file content overlay and replaced with

+ new text.

+

+

+ The edits are applied in the order in which they occur in the list. This

+ means that the offset of each edit must be correct under the assumption

+ that all previous edits have been applied.

+

+

+ It is an error to use this overlay on a file that does not yet have a file

+ content overlay or that has had its overlay removed via

+ <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>.

+

+

+ If any of the edits cannot be applied due to its offset or length being

+ out of range, an <tt>INVALID_OVERLAY_CHANGE</tt> error will be reported.

+

+ <object>

+ <field name="type" value="change">

+ <ref>String</ref>

+ </field>

+ <field name="edits">

+ <list>

+ <ref>SourceEdit</ref>

+ </list>

+

+ The edits to be applied to the file.

+

+ </field>

+ </object>

+ </type>

+ <type name="CompletionSuggestion">

+

+ A suggestion for how to complete partially entered text. Many of the

+ fields are optional, depending on the kind of element being suggested.

+

+ <object>

+ <field name="kind">

+ <ref>CompletionSuggestionKind</ref>

+

+ The kind of element being suggested.

+

+ </field>

+ <field name="relevance">

+ <ref>int</ref>

+

+ The relevance of this completion suggestion where a higher number

+ indicates a higher relevance.

+

+ </field>

+ <field name="completion">

+ <ref>String</ref>

+

+ The identifier to be inserted if the suggestion is selected. If the

+ suggestion is for a method or function, the client might want to

+ additionally insert a template for the parameters. The information

+ required in order to do so is contained in other fields.

+

+ </field>

+ <field name="selectionOffset">

+ <ref>int</ref>

+

+ The offset, relative to the beginning of the completion, of where the

+ selection should be placed after insertion.

+

+ </field>

+ <field name="selectionLength">

+ <ref>int</ref>

+

+ The number of characters that should be selected after insertion.

+

+ </field>

+ <field name="isDeprecated">

+ <ref>bool</ref>

+

+ True if the suggested element is deprecated.

+

+ </field>

+ <field name="isPotential">

+ <ref>bool</ref>

+

+ True if the element is not known to be valid for the target. This

+ happens if the type of the target is dynamic.

+

+ </field>

+ <field name="docSummary" optional="true">

+ <ref>String</ref>

+

+ An abbreviated version of the Dartdoc associated with the element

+ being suggested, This field is omitted if there is no Dartdoc

+ associated with the element.

+

+ </field>

+ <field name="docComplete" optional="true">

+ <ref>String</ref>

+

+ The Dartdoc associated with the element being suggested. This field is

+ omitted if there is no Dartdoc associated with the element.

+

+ </field>

+ <field name="declaringType" optional="true">

+ <ref>String</ref>

+

+ The class that declares the element being suggested. This field is

+ omitted if the suggested element is not a member of a class.

+

+ </field>

+ <field name="defaultArgumentListString" optional="true">

+ <ref>String</ref>

+

+ A default String for use in generating argument list source contents

+ on the client side.

+

+ </field>

+ <field name="defaultArgumentListTextRanges" optional="true">

+ <list>

+ <ref>int</ref>

+ </list>

+

+ Pairs of offsets and lengths describing 'defaultArgumentListString'

+ text ranges suitable for use by clients to set up linked edits of

+ default argument source contents. For example, given an argument list

+ string 'x, y', the corresponding text range [0, 1, 3, 1], indicates

+ two text ranges of length 1, starting at offsets 0 and 3. Clients can

+ use these ranges to treat the 'x' and 'y' values specially for linked

+ edits.

+

+ </field>

+ <field name="element" optional="true">

+ <ref>Element</ref>

+

+ Information about the element reference being suggested.

+

+ </field>

+ <field name="returnType" optional="true">

+ <ref>String</ref>

+

+ The return type of the getter, function or method or the type of the

+ field being suggested. This field is omitted if the suggested element

+ is not a getter, function or method.

+

+ </field>

+ <field name="parameterNames" optional="true">

+ <list>

+ <ref>String</ref>

+ </list>

+

+ The names of the parameters of the function or method being suggested.

+ This field is omitted if the suggested element is not a setter,

+ function or method.

+

+ </field>

+ <field name="parameterTypes" optional="true">

+ <list>

+ <ref>String</ref>

+ </list>

+

+ The types of the parameters of the function or method being suggested.

+ This field is omitted if the parameterNames field is omitted.

+

+ </field>

+ <field name="requiredParameterCount" optional="true">

+ <ref>int</ref>

+

+ The number of required parameters for the function or method being

+ suggested. This field is omitted if the parameterNames field is

+ omitted.

+

+ </field>

+ <field name="hasNamedParameters" optional="true">

+ <ref>bool</ref>

+

+ True if the function or method being suggested has at least one named

+ parameter. This field is omitted if the parameterNames field is

+ omitted.

+

+ </field>

+ <field name="parameterName" optional="true">

+ <ref>String</ref>

+

+ The name of the optional parameter being suggested. This field is

+ omitted if the suggestion is not the addition of an optional argument

+ within an argument list.

+

+ </field>

+ <field name="parameterType" optional="true">

+ <ref>String</ref>

+

+ The type of the options parameter being suggested. This field is

+ omitted if the parameterName field is omitted.

+

+ </field>

+ <field name="importUri" optional="true">

+ <ref>String</ref>

+

+ The import to be added if the suggestion is out of scope and needs

+ an import to be added to be in scope.

+

+ </field>

+ </object>

+ </type>

+ <type name="CompletionSuggestionKind">

+

+ An enumeration of the kinds of elements that can be included in a

+ completion suggestion.

+

+ <enum>

+ <value>

+ <code>ARGUMENT_LIST</code>

+

+ A list of arguments for the method or function that is being

+ invoked. For this suggestion kind, the completion field is a

+ textual representation of the invocation and the parameterNames,

+ parameterTypes, and requiredParameterCount attributes are defined.

+

+ </value>

+ <value><code>IMPORT</code></value>

+ <value>

+ <code>IDENTIFIER</code>

+

+ The element identifier should be inserted at the completion

+ location. For example "someMethod" in <tt>import 'myLib.dart' show

+ someMethod;</tt>. For suggestions of this kind, the element

+ attribute is defined and the completion field is the element's

+ identifier.

+

+ </value>

+ <value>

+ <code>INVOCATION</code>

+

+ The element is being invoked at the completion location. For

+ example, 'someMethod' in <tt>x.someMethod();</tt>. For suggestions

+ of this kind, the element attribute is defined and the completion

+ field is the element's identifier.

+

+ </value>

+ <value>

+ <code>KEYWORD</code>

+

+ A keyword is being suggested. For suggestions of this kind, the

+ completion is the keyword.

+

+ </value>

+ <value>

+ <code>NAMED_ARGUMENT</code>

+

+ A named argument for the current call site is being suggested. For

+ suggestions of this kind, the completion is the named argument

+ identifier including a trailing ':' and a space.

+

+ </value>

+ <value><code>OPTIONAL_ARGUMENT</code></value>

+ <value><code>PARAMETER</code></value>

+ </enum>

+ </type>

+ <type name="Element">

+

+ Information about an element (something that can be declared in code).

+

+ <object>

+ <field name="kind">

+ <ref>ElementKind</ref>

+

+ The kind of the element.

+

+ </field>

+ <field name="name">

+ <ref>String</ref>

+

+ The name of the element. This is typically used as the label in the

+ outline.

+

+ </field>

+ <field name="location" optional="true">

+ <ref>Location</ref>

+

+ The location of the name in the declaration of the element.

+

+ </field>

+ <field name="flags">

+ <ref>int</ref>

+

+ A bit-map containing the following flags:

+

+ <ul>

+ <li>

+ 0x01 - set if the element is explicitly or implicitly abstract

+ </li>

+ <li>

+ 0x02 - set if the element was declared to be ‘const’

+ </li>

+ <li>

+ 0x04 - set if the element was declared to be ‘final’

+ </li>

+ <li>

+ 0x08 - set if the element is a static member of a class or is a

+ top-level function or field

+ </li>

+ <li>

+ 0x10 - set if the element is private

+ </li>

+ <li>

+ 0x20 - set if the element is deprecated

+ </li>

+ </ul>

+ </field>

+ <field name="parameters" optional="true">

+ <ref>String</ref>

+

+ The parameter list for the element. If the element is not a method or

+ function this field will not be defined. If the element doesn't have

+ parameters (e.g. getter), this field will not be defined. If the

+ element has zero parameters, this field will have a value of "()".

+

+ </field>

+ <field name="returnType" optional="true">

+ <ref>String</ref>

+

+ The return type of the element. If the element is not a method or

+ function this field will not be defined. If the element does not have

+ a declared return type, this field will contain an empty string.

+

+ </field>

+ <field name="typeParameters" optional="true">

+ <ref>String</ref>

+

+ The type parameter list for the element. If the element doesn't have

+ type parameters, this field will not be defined.

+

+ </field>

+ </object>

+ </type>

+ <type name="ElementKind">

+

+ An enumeration of the kinds of elements.

+

+ <enum>

+ <value><code>CLASS</code></value>

+ <value><code>CLASS_TYPE_ALIAS</code></value>

+ <value><code>COMPILATION_UNIT</code></value>

+ <value><code>CONSTRUCTOR</code></value>

+ <value><code>ENUM</code></value>

+ <value><code>ENUM_CONSTANT</code></value>

+ <value><code>FIELD</code></value>

+ <value><code>FILE</code></value>

+ <value><code>FUNCTION</code></value>

+ <value><code>FUNCTION_TYPE_ALIAS</code></value>

+ <value><code>GETTER</code></value>

+ <value><code>LABEL</code></value>

+ <value><code>LIBRARY</code></value>

+ <value><code>LOCAL_VARIABLE</code></value>

+ <value><code>METHOD</code></value>

+ <value><code>PARAMETER</code></value>

+ <value><code>PREFIX</code></value>

+ <value><code>SETTER</code></value>

+ <value><code>TOP_LEVEL_VARIABLE</code></value>

+ <value><code>TYPE_PARAMETER</code></value>

+ <value deprecated="true">

+ <code>UNIT_TEST_GROUP</code>

+ Deprecated: support for tests was removed.

+ </value>

+ <value deprecated="true">

+ <code>UNIT_TEST_TEST</code>

+ Deprecated: support for tests was removed.

+ </value>

+ <value><code>UNKNOWN</code></value>

+ </enum>

+ </type>

+ <type name="FilePath">

+ <ref>String</ref>

+

+ The absolute, normalized path of a file.

+

+

+ If the format of a file path in a request is not valid, e.g. the path is

+ not absolute or is not normalized, then an error of type

+ <tt>INVALID_FILE_PATH_FORMAT</tt> will be generated.

+

+ </type>

+ <type name="FoldingKind">

+

+ An enumeration of the kinds of folding regions.

+

+ <enum>

+ <value><code>COMMENT</code></value>

+ <value><code>CLASS_MEMBER</code></value>

+ <value><code>DIRECTIVES</code></value>

+ <value><code>DOCUMENTATION_COMMENT</code></value>

+ <value><code>TOP_LEVEL_DECLARATION</code></value>

+ </enum>

+ </type>

+ <type name="FoldingRegion">

+

+ A description of a region that can be folded.

+

+ <object>

+ <field name="kind">

+ <ref>FoldingKind</ref>

+

+ The kind of the region.

+

+ </field>

+ <field name="offset">

+ <ref>int</ref>

+

+ The offset of the region to be folded.

+

+ </field>

+ <field name="length">

+ <ref>int</ref>

+

+ The length of the region to be folded.

+

+ </field>

+ </object>

+ </type>

+ <type name="HighlightRegion">

+

+ A description of a region that could have special highlighting associated

+ with it.

+

+ <object>

+ <field name="type">

+ <ref>HighlightRegionType</ref>

+

+ The type of highlight associated with the region.

+

+ </field>

+ <field name="offset">

+ <ref>int</ref>

+

+ The offset of the region to be highlighted.

+

+ </field>

+ <field name="length">

+ <ref>int</ref>

+

+ The length of the region to be highlighted.

+

+ </field>

+ </object>

+ </type>

+ <type name="HighlightRegionType">

+

+ An enumeration of the kinds of highlighting that can be applied to files.

+

+ <enum>

+ <value><code>ANNOTATION</code></value>

+ <value><code>BUILT_IN</code></value>

+ <value><code>CLASS</code></value>

+ <value><code>COMMENT_BLOCK</code></value>

+ <value><code>COMMENT_DOCUMENTATION</code></value>

+ <value><code>COMMENT_END_OF_LINE</code></value>

+ <value><code>CONSTRUCTOR</code></value>

+ <value><code>DIRECTIVE</code></value>

+ <value>

+ <code>DYNAMIC_TYPE</code>

+ Only for version 1 of highlight.

+ </value>

+ <value>

+ <code>DYNAMIC_LOCAL_VARIABLE_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>DYNAMIC_LOCAL_VARIABLE_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>DYNAMIC_PARAMETER_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>DYNAMIC_PARAMETER_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value><code>ENUM</code></value>

+ <value><code>ENUM_CONSTANT</code></value>

+ <value>

+ <code>FIELD</code>

+ Only for version 1 of highlight.

+ </value>

+ <value>

+ <code>FIELD_STATIC</code>

+ Only for version 1 of highlight.

+ </value>

+ <value>

+ <code>FUNCTION</code>

+ Only for version 1 of highlight.

+ </value>

+ <value>

+ <code>FUNCTION_DECLARATION</code>

+ Only for version 1 of highlight.

+ </value>

+ <value><code>FUNCTION_TYPE_ALIAS</code></value>

+ <value>

+ <code>GETTER_DECLARATION</code>

+ Only for version 1 of highlight.

+ </value>

+ <value><code>IDENTIFIER_DEFAULT</code></value>

+ <value><code>IMPORT_PREFIX</code></value>

+ <value>

+ <code>INSTANCE_FIELD_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>INSTANCE_FIELD_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>INSTANCE_GETTER_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>INSTANCE_GETTER_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>INSTANCE_METHOD_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>INSTANCE_METHOD_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>INSTANCE_SETTER_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>INSTANCE_SETTER_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>INVALID_STRING_ESCAPE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value><code>KEYWORD</code></value>

+ <value><code>LABEL</code></value>

+ <value>

+ <code>LIBRARY_NAME</code>

+ Only for version 2 of highlight.

+ </value>

+ <value><code>LITERAL_BOOLEAN</code></value>

+ <value><code>LITERAL_DOUBLE</code></value>

+ <value><code>LITERAL_INTEGER</code></value>

+ <value><code>LITERAL_LIST</code></value>

+ <value><code>LITERAL_MAP</code></value>

+ <value><code>LITERAL_STRING</code></value>

+ <value>

+ <code>LOCAL_FUNCTION_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>LOCAL_FUNCTION_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>LOCAL_VARIABLE</code>

+ Only for version 1 of highlight.

+ </value>

+ <value><code>LOCAL_VARIABLE_DECLARATION</code></value>

+ <value>

+ <code>LOCAL_VARIABLE_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>METHOD</code>

+ Only for version 1 of highlight.

+ </value>

+ <value>

+ <code>METHOD_DECLARATION</code>

+ Only for version 1 of highlight.

+ </value>

+ <value>

+ <code>METHOD_DECLARATION_STATIC</code>

+ Only for version 1 of highlight.

+ </value>

+ <value>

+ <code>METHOD_STATIC</code>

+ Only for version 1 of highlight.

+ </value>

+ <value>

+ <code>PARAMETER</code>

+ Only for version 1 of highlight.

+ </value>

+ <value>

+ <code>SETTER_DECLARATION</code>

+ Only for version 1 of highlight.

+ </value>

+ <value>

+ <code>TOP_LEVEL_VARIABLE</code>

+ Only for version 1 of highlight.

+ </value>

+ <value>

+ <code>PARAMETER_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>PARAMETER_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>STATIC_FIELD_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>STATIC_GETTER_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>STATIC_GETTER_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>STATIC_METHOD_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>STATIC_METHOD_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>STATIC_SETTER_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>STATIC_SETTER_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>TOP_LEVEL_FUNCTION_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>TOP_LEVEL_FUNCTION_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>TOP_LEVEL_GETTER_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>TOP_LEVEL_GETTER_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>TOP_LEVEL_SETTER_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>TOP_LEVEL_SETTER_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>TOP_LEVEL_VARIABLE_DECLARATION</code>

+ Only for version 2 of highlight.

+ </value>

+ <value><code>TYPE_NAME_DYNAMIC</code></value>

+ <value><code>TYPE_PARAMETER</code></value>

+ <value>

+ <code>UNRESOLVED_INSTANCE_MEMBER_REFERENCE</code>

+ Only for version 2 of highlight.

+ </value>

+ <value>

+ <code>VALID_STRING_ESCAPE</code>

+ Only for version 2 of highlight.

+ </value>

+ </enum>

+ </type>

+ <type name="LinkedEditGroup">

+

+ A collection of positions that should be linked (edited simultaneously)

+ for the purposes of updating code after a source change. For example, if a

+ set of edits introduced a new variable name, the group would contain all

+ of the positions of the variable name so that if the client wanted to let

+ the user edit the variable name after the operation, all occurrences of

+ the name could be edited simultaneously.

+

+ <object>

+ <field name="positions">

+ <list>

+ <ref>Position</ref>

+ </list>

+

+ The positions of the regions that should be edited simultaneously.

+

+ </field>

+ <field name="length">

+ <ref>int</ref>

+

+ The length of the regions that should be edited simultaneously.

+

+ </field>

+ <field name="suggestions">

+ <list>

+ <ref>LinkedEditSuggestion</ref>

+ </list>

+

+ Pre-computed suggestions for what every region might want to be

+ changed to.

+

+ </field>

+ </object>

+ </type>

+ <type name="LinkedEditSuggestion">

+

+ A suggestion of a value that could be used to replace all of the linked

+ edit regions in a <a href="#type_LinkedEditGroup">LinkedEditGroup</a>.

+

+ <object>

+ <field name="value">

+ <ref>String</ref>

+

+ The value that could be used to replace all of the linked edit

+ regions.

+

+ </field>

+ <field name="kind">

+ <ref>LinkedEditSuggestionKind</ref>

+

+ The kind of value being proposed.

+

+ </field>

+ </object>

+ </type>

+ <type name="LinkedEditSuggestionKind">

+

+ An enumeration of the kind of values that can be suggested for a linked

+ edit.

+

+ <enum>

+ <value><code>METHOD</code></value>

+ <value><code>PARAMETER</code></value>

+ <value><code>TYPE</code></value>

+ <value><code>VARIABLE</code></value>

+ </enum>

+ </type>

+ <type name="Location">

+

+ A location (character range) within a file.

+

+ <object>

+ <field name="file">

+ <ref>FilePath</ref>

+

+ The file containing the range.

+

+ </field>

+ <field name="offset">

+ <ref>int</ref>

+

+ The offset of the range.

+

+ </field>

+ <field name="length">

+ <ref>int</ref>

+

+ The length of the range.

+

+ </field>

+ <field name="startLine">

+ <ref>int</ref>

+

+ The one-based index of the line containing the first character of the

+ range.

+

+ </field>

+ <field name="startColumn">

+ <ref>int</ref>

+

+ The one-based index of the column containing the first character of

+ the range.

+

+ </field>

+ </object>

+ </type>

+ <type name="NavigationRegion">

+

+ A description of a region from which the user can navigate to the

+ declaration of an element.

+

+ <object>

+ <field name="offset">

+ <ref>int</ref>

+

+ The offset of the region from which the user can navigate.

+

+ </field>

+ <field name="length">

+ <ref>int</ref>

+

+ The length of the region from which the user can navigate.

+

+ </field>

+ <field name="targets">

+ <list>

+ <ref>int</ref>

+ </list>

+

+ The indexes of the targets (in the enclosing navigation response) to

+ which the given region is bound. By opening the target, clients can

+ implement one form of navigation. This list cannot be empty.

+

+ </field>

+ </object>

+ </type>

+ <type name="NavigationTarget">

+

+ A description of a target to which the user can navigate.

+

+ <object>

+ <field name="kind">

+ <ref>ElementKind</ref>

+

+ The kind of the element.

+

+ </field>

+ <field name="fileIndex">

+ <ref>int</ref>

+

+ The index of the file (in the enclosing navigation response) to

+ navigate to.

+

+ </field>

+ <field name="offset">

+ <ref>int</ref>

+

+ The offset of the region to which the user can navigate.

+

+ </field>

+ <field name="length">

+ <ref>int</ref>

+

+ The length of the region to which the user can navigate.

+

+ </field>

+ <field name="startLine">

+ <ref>int</ref>

+

+ The one-based index of the line containing the first character of the

+ region.

+

+ </field>

+ <field name="startColumn">

+ <ref>int</ref>

+

+ The one-based index of the column containing the first character of

+ the region.

+

+ </field>

+ </object>

+ </type>

+ <type name="Occurrences">

+

+ A description of the references to a single element within a single file.

+

+ <object>

+ <field name="element">

+ <ref>Element</ref>

+

+ The element that was referenced.

+

+ </field>

+ <field name="offsets">

+ <list>

+ <ref>int</ref>

+ </list>

+

+ The offsets of the name of the referenced element within the file.

+

+ </field>

+ <field name="length">

+ <ref>int</ref>

+

+ The length of the name of the referenced element.

+

+ </field>

+ </object>

+ </type>

+ <type name="Outline">

+

+ An node in the outline structure of a file.

+

+ <object>

+ <field name="element">

+ <ref>Element</ref>

+

+ A description of the element represented by this node.

+

+ </field>

+ <field name="offset">

+ <ref>int</ref>

+

+ The offset of the first character of the element. This is different

+ than the offset in the Element, which is the offset of the name of the

+ element. It can be used, for example, to map locations in the file

+ back to an outline.

+

+ </field>

+ <field name="length">

+ <ref>int</ref>

+

+ The length of the element.

+

+ </field>

+ <field name="children" optional="true">

+ <list>

+ <ref>Outline</ref>

+ </list>

+

+ The children of the node. The field will be omitted if the node has no

+ children.

+

+ </field>

+ </object>

+ </type>

+ <type name="Position">

+

+ A position within a file.

+

+ <object>

+ <field name="file">

+ <ref>FilePath</ref>

+

+ The file containing the position.

+

+ </field>

+ <field name="offset">

+ <ref>int</ref>

+

+ The offset of the position.

+

+ </field>

+ </object>

+ </type>

+ <type name="RefactoringFeedback">

+

+ An abstract superclass of all refactoring feedbacks.

+

+ <object>

+ </object>

+ </type>

+ <type name="RefactoringKind">

+

+ An enumeration of the kinds of refactorings that can be created.

+

+ <enum>

+ <value><code>CONVERT_GETTER_TO_METHOD</code></value>

+ <value><code>CONVERT_METHOD_TO_GETTER</code></value>

+ <value><code>EXTRACT_LOCAL_VARIABLE</code></value>

+ <value><code>EXTRACT_METHOD</code></value>

+ <value><code>INLINE_LOCAL_VARIABLE</code></value>

+ <value><code>INLINE_METHOD</code></value>

+ <value><code>MOVE_FILE</code></value>

+ <value><code>RENAME</code></value>

+ <value><code>SORT_MEMBERS</code></value>

+ </enum>

+ </type>

+ <type name="RefactoringMethodParameter">

+

+

+ A description of a parameter in a method refactoring.

+

+ <object>

+ <field name="id" optional="true">

+ <ref>String</ref>

+

+ The unique identifier of the parameter. Clients may omit this field

+ for the parameters they want to add.

+

+ </field>

+ <field name="kind">

+ <ref>RefactoringMethodParameterKind</ref>

+

+ The kind of the parameter.

+

+ </field>

+ <field name="type">

+ <ref>String</ref>

+

+ The type that should be given to the parameter, or the return type of

+ the parameter's function type.

+

+ </field>

+ <field name="name">

+ <ref>String</ref>

+

+ The name that should be given to the parameter.

+

+ </field>

+ <field name="parameters" optional="true">

+ <ref>String</ref>

+

+ The parameter list of the parameter's function type. If the parameter

+ is not of a function type, this field will not be defined. If the

+ function type has zero parameters, this field will have a value of

+ '()'.

+

+ </field>

+ </object>

+ </type>

+ <type name="RefactoringOptions">

+

+ An abstract superclass of all refactoring options.

+

+ <object>

+ </object>

+ </type>

+ <type name="RefactoringMethodParameterKind">

+

+ An enumeration of the kinds of parameters.

+

+ <enum>

+ <value><code>REQUIRED</code></value>

+ <value><code>POSITIONAL</code></value>

+ <value><code>NAMED</code></value>

+ </enum>

+ </type>

+ <type name="RefactoringProblem">

+

+ A description of a problem related to a refactoring.

+

+ <object>

+ <field name="severity">

+ <ref>RefactoringProblemSeverity</ref>

+

+ The severity of the problem being represented.

+

+ </field>

+ <field name="message">

+ <ref>String</ref>

+

+ A human-readable description of the problem being represented.

+

+ </field>

+ <field name="location" optional="true">

+ <ref>Location</ref>

+

+ The location of the problem being represented. This field is omitted

+ unless there is a specific location associated with the problem (such

+ as a location where an element being renamed will be shadowed).

+

+ </field>

+ </object>

+ </type>

+ <type name="RefactoringProblemSeverity">

+

+ An enumeration of the severities of problems that can be returned by the

+ refactoring requests.

+

+ <enum>

+ <value>

+ <code>INFO</code>

+

+ A minor code problem. No example, because it is not used yet.

+

+ </value>

+ <value>

+ <code>WARNING</code>

+

+ A minor code problem. For example names of local variables should be

+ camel case and start with a lower case letter. Staring the name of a

+ variable with an upper case is OK from the language point of view, but

+ it is nice to warn the user.

+

+ </value>

+ <value>

+ <code>ERROR</code>

+

+ The refactoring technically can be performed, but there is a logical

+ problem. For example the name of a local variable being extracted

+ conflicts with another name in the scope, or duplicate parameter names

+ in the method being extracted, or a conflict between a parameter name

+ and a local variable, etc. In some cases the location of the problem

+ is also provided, so the IDE can show user the location and the

+ problem, and let the user decide whether they want to perform the

+ refactoring. For example the name conflict might be expected, and the

+ user wants to fix it afterwards.

+

+ </value>

+ <value>

+ <code>FATAL</code>

+

+ A fatal error, which prevents performing the refactoring. For example

+ the name of a local variable being extracted is not a valid

+ identifier, or selection is not a valid expression.

+

+ </value>

+ </enum>

+ </type>

+ <type name="RemoveContentOverlay">

+

+ A directive to remove an existing file content overlay. After processing

+ this directive, the file contents will once again be read from the file

+ system.

+

+

+ If this directive is used on a file that doesn't currently have a content

+ overlay, it has no effect.

+

+ <object>

+ <field name="type" value="remove">

+ <ref>String</ref>

+ </field>

+ </object>

+ </type>

+ <type name="SourceChange">

+

+ A description of a set of edits that implement a single conceptual change.

+

+ <object>

+ <field name="message">

+ <ref>String</ref>

+

+ A human-readable description of the change to be applied.

+

+ </field>

+ <field name="edits">

+ <list>

+ <ref>SourceFileEdit</ref>

+ </list>

+

+ A list of the edits used to effect the change, grouped by file.

+

+ </field>

+ <field name="linkedEditGroups">

+ <list>

+ <ref>LinkedEditGroup</ref>

+ </list>

+

+ A list of the linked editing groups used to customize the changes that

+ were made.

+

+ </field>

+ <field name="selection" optional="true">

+ <ref>Position</ref>

+

+ The position that should be selected after the edits have been

+ applied.

+

+ </field>

+ </object>

+ </type>

+ <type name="SourceEdit">

+

+ A description of a single change to a single file.

+

+ <object>

+ <field name="offset">

+ <ref>int</ref>

+

+ The offset of the region to be modified.

+

+ </field>

+ <field name="length">

+ <ref>int</ref>

+

+ The length of the region to be modified.

+

+ </field>

+ <field name="replacement">

+ <ref>String</ref>

+

+ The code that is to replace the specified region in the original code.

+

+ </field>

+ <field name="id" optional="true">

+ <ref>String</ref>

+

+ An identifier that uniquely identifies this source edit from other

+ edits in the same response. This field is omitted unless a containing

+ structure needs to be able to identify the edit for some reason.

+

+

+ For example, some refactoring operations can produce edits that might

+ not be appropriate (referred to as potential edits). Such edits will

+ have an id so that they can be referenced. Edits in the same response

+ that do not need to be referenced will not have an id.

+

+ </field>

+ </object>

+ </type>

+ <type name="SourceFileEdit">

+

+ A description of a set of changes to a single file.

+

+ <object>

+ <field name="file">

+ <ref>FilePath</ref>

+

+ The file containing the code to be modified.

+

+ </field>

+ <field name="fileStamp">

+ <ref>long</ref>

+

+ The modification stamp of the file at the moment when the change was

+ created, in milliseconds since the "Unix epoch". Will be -1 if the

+ file did not exist and should be created. The client may use this

+ field to make sure that the file was not changed since then, so it is

+ safe to apply the change.

+

+ </field>

+ <field name="edits">

+ <list>

+ <ref>SourceEdit</ref>

+ </list>

+

+ A list of the edits used to effect the change.

+

+ </field>

+ </object>

+ </type>

+</types>

+</body>

+</html>

« no previous file with comments | « pkg/analyzer_plugin/tool/spec/codegen_matchers.dart ('k') | pkg/analyzer_plugin/tool/spec/from_html.dart » ('j') | no next file with comments »