| Index: pkg/analysis_server/tool/spec/spec_input.html
|
| diff --git a/pkg/analysis_server/tool/spec/spec_input.html b/pkg/analysis_server/tool/spec/spec_input.html
|
| index 023d28023ccaa8a2f36c7a4ca0996588cb1911b9..70b88bf97e3ea3b62217ee659b79d0150000cf50 100644
|
| --- a/pkg/analysis_server/tool/spec/spec_input.html
|
| +++ b/pkg/analysis_server/tool/spec/spec_input.html
|
| @@ -266,7 +266,9 @@
|
| for the file cannot be computed, then the subset of the
|
| errors that can be computed will be returned and the
|
| response will contain an error to indicate why the errors
|
| - could not be computed.
|
| + could not be computed. If the content of the file changes after this
|
| + request was received but before a response could be sent, then an
|
| + error of type <tt>CONTENT_MODIFIED</tt> will be generated.
|
| </p>
|
| <p>
|
| This request is intended to be used by clients that cannot
|
| @@ -310,15 +312,13 @@
|
| <field name="file">
|
| <ref>FilePath</ref>
|
| <p>
|
| - The file in which hover information is being
|
| - requested.
|
| + The file in which hover information is being requested.
|
| </p>
|
| </field>
|
| <field name="offset">
|
| <ref>int</ref>
|
| <p>
|
| - The offset for which hover information is being
|
| - requested.
|
| + The offset for which hover information is being requested.
|
| </p>
|
| </field>
|
| </params>
|
| @@ -336,6 +336,71 @@
|
| </field>
|
| </result>
|
| </request>
|
| + <request method="getNavigation">
|
| + <p>
|
| + Return the navigation information associated with the given region of
|
| + the given file. If the navigation information for the given file has
|
| + not yet been computed, or the most recently computed navigation
|
| + information for the given file is out of date, then the response for
|
| + this request will be delayed until it has been computed. If the
|
| + content of the file changes after this request was received but before
|
| + a response could be sent, then an error of type
|
| + <tt>CONTENT_MODIFIED</tt> will be generated.
|
| + </p>
|
| + <p>
|
| + If a navigation region overlaps (but extends either before or after)
|
| + the given region of the file it will be included in the result. This
|
| + means that it is theoretically possible to get the same navigation
|
| + region in response to multiple requests. Clients can avoid this by
|
| + always choosing a region that starts at the beginning of a line and
|
| + ends at the end of a (possibly different) line in the file.
|
| + </p>
|
| + <params>
|
| + <field name="file">
|
| + <ref>FilePath</ref>
|
| + <p>
|
| + The file in which navigation information is being requested.
|
| + </p>
|
| + </field>
|
| + <field name="offset">
|
| + <ref>int</ref>
|
| + <p>
|
| + The offset of the region for which navigation information is being
|
| + requested.
|
| + </p>
|
| + </field>
|
| + <field name="length">
|
| + <ref>int</ref>
|
| + <p>
|
| + The length of the region for which navigation information is being
|
| + requested.
|
| + </p>
|
| + </field>
|
| + </params>
|
| + <result>
|
| + <field name="files">
|
| + <list><ref>FilePath</ref></list>
|
| + <p>
|
| + A list of the paths of files that are referenced by the navigation
|
| + targets.
|
| + </p>
|
| + </field>
|
| + <field name="targets">
|
| + <list><ref>NavigationTarget</ref></list>
|
| + <p>
|
| + A list of the navigation targets that are referenced by the
|
| + navigation regions.
|
| + </p>
|
| + </field>
|
| + <field name="regions">
|
| + <list><ref>NavigationRegion</ref></list>
|
| + <p>
|
| + A list of the navigation regions within the requested region of
|
| + the file.
|
| + </p>
|
| + </field>
|
| + </result>
|
| + </request>
|
| <request method="reanalyze">
|
| <p>
|
| Force the re-analysis of everything contained in the
|
| @@ -657,6 +722,45 @@
|
| </field>
|
| </params>
|
| </notification>
|
| + <notification event="invalidate">
|
| + <p>
|
| + Reports that the navigation information associated with a region of a
|
| + single file has become invalid and should be re-requested.
|
| + </p>
|
| + <p>
|
| + This notification is not subscribed to by default. Clients can
|
| + subscribe by including the value <tt>"INVALIDATE"</tt> in the list of
|
| + services passed in an analysis.setSubscriptions request.
|
| + </p>
|
| + <params>
|
| + <field name="file">
|
| + <ref>FilePath</ref>
|
| + <p>
|
| + The file whose information has been invalidated.
|
| + </p>
|
| + </field>
|
| + <field name="offset">
|
| + <ref>int</ref>
|
| + <p>
|
| + The offset of the invalidated region.
|
| + </p>
|
| + </field>
|
| + <field name="length">
|
| + <ref>int</ref>
|
| + <p>
|
| + The length of the invalidated region.
|
| + </p>
|
| + </field>
|
| + <field name="delta">
|
| + <ref>int</ref>
|
| + <p>
|
| + The delta to be applied to the offsets in information that follows
|
| + the invalidated region in order to update it so that it doesn't
|
| + need to be re-requested.
|
| + </p>
|
| + </field>
|
| + </params>
|
| + </notification>
|
| <notification event="navigation">
|
| <p>
|
| Reports the navigation targets associated with a given file.
|
| @@ -1672,6 +1776,7 @@
|
| <enum>
|
| <value><code>FOLDING</code></value>
|
| <value><code>HIGHLIGHTS</code></value>
|
| + <value><code>INVALIDATE</code></value>
|
| <value><code>NAVIGATION</code></value>
|
| <value><code>OCCURRENCES</code></value>
|
| <value><code>OUTLINE</code></value>
|
| @@ -2764,6 +2869,14 @@
|
| </p>
|
| <enum>
|
| <value>
|
| + <code>CONTENT_MODIFIED</code>
|
| + <p>
|
| + An "analysis.getErrors" or "analysis.getNavigation" request could
|
| + not be satisfied because the content of the file changed before
|
| + the requested results could be computed.
|
| + </p>
|
| + </value>
|
| + <value>
|
| <code>GET_ERRORS_INVALID_FILE</code>
|
| <p>
|
| An "analysis.getErrors" request specified a FilePath
|
|
|