Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(243)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: pkg/analysis_server/tool/spec/spec_input.html

Issue 769963003: Add paging support (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 6 years 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 unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « pkg/analysis_server/test/integration/protocol_matchers.dart ('k') | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <html> 1 <html>
2 <head> 2 <head>
3 <meta charset="UTF-8"/> 3 <meta charset="UTF-8"/>
4 <title>Analysis Server API Specification</title> 4 <title>Analysis Server API Specification</title>
5 </head> 5 </head>
6 <body> 6 <body>
7 <h1>Analysis Server API Specification</h1> 7 <h1>Analysis Server API Specification</h1>
8 <h1 style="color:#999999">WORKING DRAFT - Version <version>0.3</version></h1 > 8 <h1 style="color:#999999">WORKING DRAFT - Version <version>0.3</version></h1 >
9 <p> 9 <p>
10 This document contains a specification of the API provided by 10 This document contains a specification of the API provided by
(...skipping 292 matching lines...) Expand 10 before | Expand all | Expand 10 after
303 <p> 303 <p>
304 Return the hover information associate with the given 304 Return the hover information associate with the given
305 location. If some or all of the hover information is not 305 location. If some or all of the hover information is not
306 available at the time this request is processed the 306 available at the time this request is processed the
307 information will be omitted from the response. 307 information will be omitted from the response.
308 </p> 308 </p>
309 <params> 309 <params>
310 <field name="file"> 310 <field name="file">
311 <ref>FilePath</ref> 311 <ref>FilePath</ref>
312 <p> 312 <p>
313 The file in which hover information is being 313 The file in which hover information is being requested.
314 requested.
315 </p> 314 </p>
316 </field> 315 </field>
317 <field name="offset"> 316 <field name="offset">
318 <ref>int</ref> 317 <ref>int</ref>
319 <p> 318 <p>
320 The offset for which hover information is being 319 The offset for which hover information is being requested.
321 requested.
322 </p> 320 </p>
323 </field> 321 </field>
324 </params> 322 </params>
325 <result> 323 <result>
326 <field name="hovers"> 324 <field name="hovers">
327 <list><ref>HoverInformation</ref></list> 325 <list><ref>HoverInformation</ref></list>
328 <p> 326 <p>
329 The hover information associated with the 327 The hover information associated with the
330 location. The list will be empty if no information 328 location. The list will be empty if no information
331 could be determined for the location. The list can 329 could be determined for the location. The list can
332 contain multiple items if the file is being analyzed 330 contain multiple items if the file is being analyzed
333 in multiple contexts in conflicting ways (such as a 331 in multiple contexts in conflicting ways (such as a
334 part that is included in multiple libraries). 332 part that is included in multiple libraries).
335 </p> 333 </p>
336 </field> 334 </field>
337 </result> 335 </result>
338 </request> 336 </request>
337 <request method="getNavigation">
338 <p>
339 Return the navigation information associated with the given region of
340 the given file.
341 </p>
342 <p>
343 If a navigation region is partially contained in (but extends either
344 before or after) the given region of the file it will be included in
345 the result. This means that it is theoretically possible to get the
346 same navigation region in response to multiple requests. Clients can
347 avoid this by always choosing a region that starts at the beginning of
348 a line and ends at the end of a line in the file.
349 </p>
Paul Berry 2014/12/01 22:54:21 Can you clarify what happens in the corner case wh
Brian Wilkerson 2014/12/02 21:35:04 I have changed the API to use an offset and length
350 <params>
351 <field name="file">
352 <ref>FilePath</ref>
353 <p>
354 The file in which navigation information is being requested.
355 </p>
356 </field>
357 <field name="start">
358 <ref>int</ref>
359 <p>
360 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
361 is being requested.
362 </p>
363 </field>
364 <field name="end">
365 <ref>int</ref>
366 <p>
367 The offset of the end of the region for which hover information is
368 being requested.
369 </p>
370 </field>
371 </params>
372 <result>
373 <field name="files">
374 <list><ref>FilePath</ref></list>
375 <p>
376 A list of the paths of files that are referenced by the navigation
377 targets.
378 </p>
379 </field>
380 <field name="targets">
381 <list><ref>NavigationTarget</ref></list>
382 <p>
383 A list of the navigation targets that are referenced by the
384 navigation regions.
385 </p>
386 </field>
387 <field name="regions">
388 <list><ref>NavigationRegion</ref></list>
389 <p>
390 A list of the navigation regions within the requested region of
391 the file.
392 </p>
393 </field>
394 </result>
395 </request>
339 <request method="reanalyze"> 396 <request method="reanalyze">
340 <p> 397 <p>
341 Force the re-analysis of everything contained in the 398 Force the re-analysis of everything contained in the
342 existing analysis roots. This will cause all previously 399 existing analysis roots. This will cause all previously
343 computed analysis results to be discarded and recomputed, 400 computed analysis results to be discarded and recomputed,
344 and will cause all subscribed notifications to be re-sent. 401 and will cause all subscribed notifications to be re-sent.
345 </p> 402 </p>
346 </request> 403 </request>
347 <request method="setAnalysisRoots"> 404 <request method="setAnalysisRoots">
348 <p> 405 <p>
(...skipping 301 matching lines...) Expand 10 before | Expand all | Expand 10 after
650 The highlight regions contained in the file. Each 707 The highlight regions contained in the file. Each
651 highlight region represents a particular syntactic or 708 highlight region represents a particular syntactic or
652 semantic meaning associated with some range. Note that 709 semantic meaning associated with some range. Note that
653 the highlight regions that are returned can overlap 710 the highlight regions that are returned can overlap
654 other highlight regions if there is more than one 711 other highlight regions if there is more than one
655 meaning associated with a particular region. 712 meaning associated with a particular region.
656 </p> 713 </p>
657 </field> 714 </field>
658 </params> 715 </params>
659 </notification> 716 </notification>
717 <notification event="invalidate">
718 <p>
719 Reports that the navigation information associated with a region of a
720 single file has become invalid and should be re-requested.
721 </p>
722 <p>
723 This notification is not subscribed to by default. Clients can
724 subscribe by including the value <tt>"INVALIDATE"</tt> in the list of
725 services passed in an analysis.setSubscriptions request.
726 </p>
727 <params>
728 <field name="file">
729 <ref>FilePath</ref>
730 <p>
731 The file whose information has been invalidated.
732 </p>
733 </field>
734 <field name="start">
735 <ref>int</ref>
736 <p>
737 The offset of the start of the invalidated region.
738 </p>
739 </field>
740 <field name="end">
741 <ref>int</ref>
742 <p>
743 The offset of the end of the invalidated region.
744 </p>
745 </field>
746 <field name="delta">
747 <ref>int</ref>
748 <p>
749 The delta to be applied to the offsets in information that follows
750 the invalidated region in order to update it so that it doesn't
751 need to be re-requested.
752 </p>
753 </field>
754 </params>
755 </notification>
660 <notification event="navigation"> 756 <notification event="navigation">
661 <p> 757 <p>
662 Reports the navigation targets associated with a given file. 758 Reports the navigation targets associated with a given file.
663 </p> 759 </p>
664 <p> 760 <p>
665 This notification is not subscribed to by default. Clients 761 This notification is not subscribed to by default. Clients
666 can subscribe by including the value <tt>"NAVIGATION"</tt> 762 can subscribe by including the value <tt>"NAVIGATION"</tt>
667 in the list of services passed in an 763 in the list of services passed in an
668 analysis.setSubscriptions request. 764 analysis.setSubscriptions request.
669 </p> 765 </p>
(...skipping 995 matching lines...) Expand 10 before | Expand all | Expand 10 after
1665 </object> 1761 </object>
1666 </type> 1762 </type>
1667 <type name="AnalysisService"> 1763 <type name="AnalysisService">
1668 <p> 1764 <p>
1669 An enumeration of the services provided by the analysis 1765 An enumeration of the services provided by the analysis
1670 domain. 1766 domain.
1671 </p> 1767 </p>
1672 <enum> 1768 <enum>
1673 <value><code>FOLDING</code></value> 1769 <value><code>FOLDING</code></value>
1674 <value><code>HIGHLIGHTS</code></value> 1770 <value><code>HIGHLIGHTS</code></value>
1771 <value><code>INVALIDATE</code></value>
1675 <value><code>NAVIGATION</code></value> 1772 <value><code>NAVIGATION</code></value>
1676 <value><code>OCCURRENCES</code></value> 1773 <value><code>OCCURRENCES</code></value>
1677 <value><code>OUTLINE</code></value> 1774 <value><code>OUTLINE</code></value>
1678 <value><code>OVERRIDES</code></value> 1775 <value><code>OVERRIDES</code></value>
1679 </enum> 1776 </enum>
1680 </type> 1777 </type>
1681 <type name="AnalysisStatus"> 1778 <type name="AnalysisStatus">
1682 <p> 1779 <p>
1683 An indication of the current state of analysis. 1780 An indication of the current state of analysis.
1684 </p> 1781 </p>
(...skipping 1807 matching lines...) Expand 10 before | Expand all | Expand 10 after
3492 <h2>Errors</h2> 3589 <h2>Errors</h2>
3493 <p> 3590 <p>
3494 This section contains a list of all of the errors that are 3591 This section contains a list of all of the errors that are
3495 produced by the server and the data that is returned with each. 3592 produced by the server and the data that is returned with each.
3496 </p> 3593 </p>
3497 <p> 3594 <p>
3498 TBD 3595 TBD
3499 </p> 3596 </p>
3500 </body> 3597 </body>
3501 </html> 3598 </html>
OLDNEW
« no previous file with comments | « pkg/analysis_server/test/integration/protocol_matchers.dart ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698