pkg/analysis_server/doc/api.html - Issue 449213002: Rework "analysis.updateContent" analysis server request.

Unified Diff: pkg/analysis_server/doc/api.html

Issue 449213002: Rework "analysis.updateContent" analysis server request. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart

Patch Set: Created 6 years, 4 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

Download patch

Index: pkg/analysis_server/doc/api.html

diff --git a/pkg/analysis_server/doc/api.html b/pkg/analysis_server/doc/api.html

index e8226e61ad2af6ab4d6894e48ccc80c3b2b6f318..e742d8ab6a8615e4d50e5951af6a6e6db088102a 100644

--- a/pkg/analysis_server/doc/api.html

+++ b/pkg/analysis_server/doc/api.html

@@ -561,7 +561,7 @@ dt {

"id": String

"method": "analysis.updateContent"

"params": {

- "files": Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_ContentChange">ContentChange</a>>

+ "files": Map<<a href="#type_FilePath">FilePath</a>, object>

}

}</pre> <pre>response: {

"id": String

@@ -578,11 +578,13 @@ dt {

filesystem.

- <h4>Parameters</h4><dl><dt class="field">files ( Map<<a href="#type_FilePath">FilePath</a>, <a href="#type_ContentChange">ContentChange</a>> )</dt><dd>

+ <h4>Parameters</h4><dl><dt class="field">files ( Map<<a href="#type_FilePath">FilePath</a>, object> )</dt><dd>

- A table mapping the files whose content has changed to

- a description of the content.

+ A table mapping the files whose content has changed to a

+ description of the content change. Each value should be

+ one of the following types: <a href="#type_AddContentOverlay">AddContentOverlay</a>, <a href="#type_ChangeContentOverlay">ChangeContentOverlay</a>,

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

</dd></dl></dd><dt class="request">analysis.updateOptions</dt><dd><div class="box"><pre>request: {

"id": String

@@ -1668,7 +1670,26 @@ dt {

- <dl><dt class="typeDefinition"><a name="type_AnalysisError">AnalysisError: object</a></dt><dd>

+ <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOverlay: object</a></dt><dd>

+

+ 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.

+

+ <dl><dt class="field">type = "add"</dt><dd></dd><dt class="field">content ( String )</dt><dd>

+

+ The new content of the file.

+

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisError">AnalysisError: object</a></dt><dd>

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

by the analysis.

@@ -1776,6 +1797,36 @@ dt {

The name of the current target of analysis. This field is

omitted if analyzing is false.

+ </dd></dl></dd><dt class="typeDefinition"><a name="type_ChangeContentOverlay">ChangeContentOverlay: object</a></dt><dd>

+

+ A directive to modify an existing file content overlay. A

+ range of text is deleted from the old file content overlay

+ and replaced with new text.

+

+

+ It is an error to use this directive is used 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>).

+

+ <dl><dt class="field">type = "change"</dt><dd></dd><dt class="field">offset ( int )</dt><dd>

+

+ The offset of the text to be remove from the file

+ content overlay.

+

+ </dd><dt class="field">oldLength ( int )</dt><dd>

+

+ The length of the text to be removed from the file

+ content overlay, or 0 if no text should be removed.

+

+ </dd><dt class="field">replacement ( String )</dt><dd>

+

+ The new text which should be inserted in place of the

+ removed text.

+

</dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionId">CompletionId: String</a></dt><dd>

@@ -1912,36 +1963,7 @@ dt {

in a completion suggestion.

- <dl><dt class="value">ARGUMENT_LIST</dt><dt class="value">CLASS</dt><dt class="value">CLASS_ALIAS</dt><dt class="value">CONSTRUCTOR</dt><dt class="value">FIELD</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">IMPORT</dt><dt class="value">LIBRARY_PREFIX</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="value">METHOD</dt><dt class="value">METHOD_NAME</dt><dt class="value">NAMED_ARGUMENT</dt><dt class="value">OPTIONAL_ARGUMENT</dt><dt class="value">PARAMETER</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="value">TYPE_PARAMETER</dt></dl></dd><dt class="typeDefinition"><a name="type_ContentChange">ContentChange: object</a></dt><dd>

-

- A description of the change to the content of a file. The

- optional fields are omitted if there is no single range of

- characters that was modified. If any of the optional fields

- are provided then all of the optional fields must be provided.

-

- <dl><dt class="field">content ( String )</dt><dd>

-

- The new content of the file, or null if the content of the

- file should be read from disk.

-

- </dd><dt class="field">offset ( optional int )</dt><dd>

-

- The offset of the region that was modified.

-

- </dd><dt class="field">oldLength ( optional int )</dt><dd>

-

- The length of the region that was removed.

-

- </dd><dt class="field">newLength ( optional int )</dt><dd>

-

- The length of the region that was added.

-

- </dd></dl></dd><dt class="typeDefinition"><a name="type_DebugContextId">DebugContextId: String</a></dt><dd>

+ <dl><dt class="value">ARGUMENT_LIST</dt><dt class="value">CLASS</dt><dt class="value">CLASS_ALIAS</dt><dt class="value">CONSTRUCTOR</dt><dt class="value">FIELD</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE_ALIAS</dt><dt class="value">GETTER</dt><dt class="value">IMPORT</dt><dt class="value">LIBRARY_PREFIX</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="value">METHOD</dt><dt class="value">METHOD_NAME</dt><dt class="value">NAMED_ARGUMENT</dt><dt class="value">OPTIONAL_ARGUMENT</dt><dt class="value">PARAMETER</dt><dt class="value">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="value">TYPE_PARAMETER</dt></dl></dd><dt class="typeDefinition"><a name="type_DebugContextId">DebugContextId: String</a></dt><dd>

The identifier for a debug context.

@@ -2481,7 +2503,18 @@ dt {

returned by the refactoring requests.

- <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="value">ERROR</dt><dt class="value">FATAL</dt></dl></dd><dt class="typeDefinition"><a name="type_SearchId">SearchId: String</a></dt><dd>

+ <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="value">ERROR</dt><dt class="value">FATAL</dt></dl></dd><dt class="typeDefinition"><a name="type_RemoveContentOverlay">RemoveContentOverlay: object</a></dt><dd>

+

+ 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.

+

+ <dl><dt class="field">type = "remove"</dt><dd></dd></dl></dd><dt class="typeDefinition"><a name="type_SearchId">SearchId: String</a></dt><dd>

An identifier used to associate search results with a search

« no previous file with comments | « no previous file | pkg/analysis_server/lib/src/analysis_server.dart » ('j') | pkg/analysis_server/lib/src/domain_analysis.dart » ('J')