Add paging support

pkg/analysis_server/tool/spec/spec_input.html

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..bfa6af86239c9a7f4ebe6c6d6116cccfb63504a1 100644
--- a/pkg/analysis_server/tool/spec/spec_input.html
+++ b/pkg/analysis_server/tool/spec/spec_input.html
@@ -310,15 +310,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 +334,65 @@
           </field>
         </result>
       </request>
+      <request method="getNavigation">
+        <p>
+          Return the navigation information associated with the given region of
+          the given file.
+        </p>
+        <p>
+          If a navigation region is partially contained in (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 line in the file.
+        </p>

[Paul Berry, 2014/12/01 22:54:21]

Can you clarify what happens in the corner case where getNavigation.start ==
region.end or getNavigation.end == region.start?  It's not clear to me whether
the region should be included in this case or not.

[Brian Wilkerson, 2014/12/02 21:35:04]

I have changed the API to use an offset and length rather than start and end.
Let me know whether that helps with the description.

+        <params>
+          <field name="file">
+            <ref>FilePath</ref>
+            <p>
+              The file in which navigation information is being requested.
+            </p>
+          </field>
+          <field name="start">
+            <ref>int</ref>
+            <p>
+              The offset of the start of the region for which hover information

[scheglov, 2014/12/01 22:56:46]

Replace "hover" with "navigation".

[Brian Wilkerson, 2014/12/02 21:35:04]

Done

+              is being requested.
+            </p>
+          </field>
+          <field name="end">
+            <ref>int</ref>
+            <p>
+              The offset of the end of the region for which hover 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 +714,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="start">
+            <ref>int</ref>
+            <p>
+              The offset of the start of the invalidated region.
+            </p>
+          </field>
+          <field name="end">
+            <ref>int</ref>
+            <p>
+              The offset of the end 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 +1768,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>