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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: pkg/analysis_server/doc/api.html

Issue 769963003: Add paging support (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Address comments 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 | « editor/tools/plugins/com.google.dart.server/src/com/google/dart/server/generated/types/RequestErrorCode.java ('k') | pkg/analysis_server/lib/src/generated_protocol.dart » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <html><head> 1 <html><head>
2 <meta charset="UTF-8"> 2 <meta charset="UTF-8">
3 <title>Analysis Server API Specification</title> 3 <title>Analysis Server API Specification</title>
4 <style>body { 4 <style>body {
5 font-family: sans-serif, serif; 5 font-family: sans-serif, serif;
6 padding-left: 5%; 6 padding-left: 5%;
7 padding-right: 5%; 7 padding-right: 5%;
8 } 8 }
9 h1 { 9 h1 {
10 text-align: center; 10 text-align: center;
(...skipping 320 matching lines...) Expand 10 before | Expand all | Expand 10 after
331 331
332 332
333 333
334 334
335 335
336 336
337 337
338 338
339 339
340 340
341
342
341 <h3>Requests</h3><dl><dt class="request">analysis.getErrors</dt><dd><div cla ss="box"><pre>request: { 343 <h3>Requests</h3><dl><dt class="request">analysis.getErrors</dt><dd><div cla ss="box"><pre>request: {
342 "id": String 344 "id": String
343 "method": "analysis.getErrors" 345 "method": "analysis.getErrors"
344 "params": { 346 "params": {
345 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 347 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
346 } 348 }
347 }</pre><br><pre>response: { 349 }</pre><br><pre>response: {
348 "id": String 350 "id": String
349 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 351 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
350 "result": { 352 "result": {
351 "<b>errors</b>": List&lt;<a href="#type_AnalysisError">AnalysisError</a>&gt; 353 "<b>errors</b>": List&lt;<a href="#type_AnalysisError">AnalysisError</a>&gt;
352 } 354 }
353 }</pre></div> 355 }</pre></div>
354 <p> 356 <p>
355 Return the errors associated with the given file. If the 357 Return the errors associated with the given file. If the
356 errors for the given file have not yet been computed, or the 358 errors for the given file have not yet been computed, or the
357 most recently computed errors for the given file are out of 359 most recently computed errors for the given file are out of
358 date, then the response for this request will be delayed 360 date, then the response for this request will be delayed
359 until they have been computed. If some or all of the errors 361 until they have been computed. If some or all of the errors
360 for the file cannot be computed, then the subset of the 362 for the file cannot be computed, then the subset of the
361 errors that can be computed will be returned and the 363 errors that can be computed will be returned and the
362 response will contain an error to indicate why the errors 364 response will contain an error to indicate why the errors
363 could not be computed. 365 could not be computed. If the content of the file changes after this
366 request was received but before a response could be sent, then an
367 error of type <tt>CONTENT_MODIFIED</tt> will be generated.
364 </p> 368 </p>
365 <p> 369 <p>
366 This request is intended to be used by clients that cannot 370 This request is intended to be used by clients that cannot
367 asynchronously apply updated error information. Clients that 371 asynchronously apply updated error information. Clients that
368 <b>can</b> apply error information as it becomes available 372 <b>can</b> apply error information as it becomes available
369 should use the information provided by the 'analysis.errors' 373 should use the information provided by the 'analysis.errors'
370 notification. 374 notification.
371 </p> 375 </p>
372 <p> 376 <p>
373 If a request is made for a file which does not exist, or 377 If a request is made for a file which does not exist, or
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after
406 Return the hover information associate with the given 410 Return the hover information associate with the given
407 location. If some or all of the hover information is not 411 location. If some or all of the hover information is not
408 available at the time this request is processed the 412 available at the time this request is processed the
409 information will be omitted from the response. 413 information will be omitted from the response.
410 </p> 414 </p>
411 415
412 416
413 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd> 417 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>
414 418
415 <p> 419 <p>
416 The file in which hover information is being 420 The file in which hover information is being requested.
417 requested.
418 </p> 421 </p>
419 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd> 422 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>
420 423
421 <p> 424 <p>
422 The offset for which hover information is being 425 The offset for which hover information is being requested.
423 requested.
424 </p> 426 </p>
425 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hovers ( List&lt ;<a href="#type_HoverInformation">HoverInformation</a>&gt; )</i></b></dt><dd> 427 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>hovers ( List&lt ;<a href="#type_HoverInformation">HoverInformation</a>&gt; )</i></b></dt><dd>
426 428
427 <p> 429 <p>
428 The hover information associated with the 430 The hover information associated with the
429 location. The list will be empty if no information 431 location. The list will be empty if no information
430 could be determined for the location. The list can 432 could be determined for the location. The list can
431 contain multiple items if the file is being analyzed 433 contain multiple items if the file is being analyzed
432 in multiple contexts in conflicting ways (such as a 434 in multiple contexts in conflicting ways (such as a
433 part that is included in multiple libraries). 435 part that is included in multiple libraries).
434 </p> 436 </p>
437 </dd></dl></dd><dt class="request">analysis.getNavigation</dt><dd><div class="box"><pre>request: {
438 "id": String
439 "method": "analysis.getNavigation"
440 "params": {
441 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
442 "<b>offset</b>": int
443 "<b>length</b>": int
444 }
445 }</pre><br><pre>response: {
446 "id": String
447 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
448 "result": {
449 "<b>files</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt;
450 "<b>targets</b>": List&lt;<a href="#type_NavigationTarget">NavigationTarget< /a>&gt;
451 "<b>regions</b>": List&lt;<a href="#type_NavigationRegion">NavigationRegion< /a>&gt;
452 }
453 }</pre></div>
454 <p>
455 Return the navigation information associated with the given region of
456 the given file. If the navigation information for the given file has
457 not yet been computed, or the most recently computed navigation
458 information for the given file is out of date, then the response for
459 this request will be delayed until it has been computed. If the
460 content of the file changes after this request was received but before
461 a response could be sent, then an error of type
462 <tt>CONTENT_MODIFIED</tt> will be generated.
463 </p>
464 <p>
465 If a navigation region overlaps (but extends either before or after)
466 the given region of the file it will be included in the result. This
467 means that it is theoretically possible to get the same navigation
468 region in response to multiple requests. Clients can avoid this by
469 always choosing a region that starts at the beginning of a line and
470 ends at the end of a (possibly different) line in the file.
471 </p>
472
473
474 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>
475
476 <p>
477 The file in which navigation information is being requested.
478 </p>
479 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>
480
481 <p>
482 The offset of the region for which navigation information is being
483 requested.
484 </p>
485 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>
486
487 <p>
488 The length of the region for which navigation information is being
489 requested.
490 </p>
491 </dd></dl><h4>Returns</h4><dl><dt class="field"><b><i>files ( List&lt; <a href="#type_FilePath">FilePath</a>&gt; )</i></b></dt><dd>
492
493 <p>
494 A list of the paths of files that are referenced by the navigation
495 targets.
496 </p>
497 </dd><dt class="field"><b><i>targets ( List&lt;<a href="#type_Navigati onTarget">NavigationTarget</a>&gt; )</i></b></dt><dd>
498
499 <p>
500 A list of the navigation targets that are referenced by the
501 navigation regions.
502 </p>
503 </dd><dt class="field"><b><i>regions ( List&lt;<a href="#type_Navigati onRegion">NavigationRegion</a>&gt; )</i></b></dt><dd>
504
505 <p>
506 A list of the navigation regions within the requested region of
507 the file.
508 </p>
435 </dd></dl></dd><dt class="request">analysis.reanalyze</dt><dd><div cla ss="box"><pre>request: { 509 </dd></dl></dd><dt class="request">analysis.reanalyze</dt><dd><div cla ss="box"><pre>request: {
436 "id": String 510 "id": String
437 "method": "analysis.reanalyze" 511 "method": "analysis.reanalyze"
438 }</pre><br><pre>response: { 512 }</pre><br><pre>response: {
439 "id": String 513 "id": String
440 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a> 514 "error": <span style="color:#999999">optional</span> <a href="#type_RequestErr or">RequestError</a>
441 }</pre></div> 515 }</pre></div>
442 <p> 516 <p>
443 Force the re-analysis of everything contained in the 517 Force the re-analysis of everything contained in the
444 existing analysis roots. This will cause all previously 518 existing analysis roots. This will cause all previously
(...skipping 327 matching lines...) Expand 10 before | Expand all | Expand 10 after
772 </dd><dt class="field"><b><i>regions ( List&lt;<a href="#type_Highligh tRegion">HighlightRegion</a>&gt; )</i></b></dt><dd> 846 </dd><dt class="field"><b><i>regions ( List&lt;<a href="#type_Highligh tRegion">HighlightRegion</a>&gt; )</i></b></dt><dd>
773 847
774 <p> 848 <p>
775 The highlight regions contained in the file. Each 849 The highlight regions contained in the file. Each
776 highlight region represents a particular syntactic or 850 highlight region represents a particular syntactic or
777 semantic meaning associated with some range. Note that 851 semantic meaning associated with some range. Note that
778 the highlight regions that are returned can overlap 852 the highlight regions that are returned can overlap
779 other highlight regions if there is more than one 853 other highlight regions if there is more than one
780 meaning associated with a particular region. 854 meaning associated with a particular region.
781 </p> 855 </p>
856 </dd></dl></dd><dt class="notification">analysis.invalidate</dt><dd><d iv class="box"><pre>notification: {
857 "event": "analysis.invalidate"
858 "params": {
859 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
860 "<b>offset</b>": int
861 "<b>length</b>": int
862 "<b>delta</b>": int
863 }
864 }</pre></div>
865 <p>
866 Reports that the navigation information associated with a region of a
867 single file has become invalid and should be re-requested.
868 </p>
869 <p>
870 This notification is not subscribed to by default. Clients can
871 subscribe by including the value <tt>"INVALIDATE"</tt> in the list of
872 services passed in an analysis.setSubscriptions request.
873 </p>
874
875 <h4>Parameters</h4><dl><dt class="field"><b><i>file ( <a href="#type_FileP ath">FilePath</a> )</i></b></dt><dd>
876
877 <p>
878 The file whose information has been invalidated.
879 </p>
880 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>
881
882 <p>
883 The offset of the invalidated region.
884 </p>
885 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>
886
887 <p>
888 The length of the invalidated region.
889 </p>
890 </dd><dt class="field"><b><i>delta ( int )</i></b></dt><dd>
891
892 <p>
893 The delta to be applied to the offsets in information that follows
894 the invalidated region in order to update it so that it doesn't
895 need to be re-requested.
896 </p>
782 </dd></dl></dd><dt class="notification">analysis.navigation</dt><dd><d iv class="box"><pre>notification: { 897 </dd></dl></dd><dt class="notification">analysis.navigation</dt><dd><d iv class="box"><pre>notification: {
783 "event": "analysis.navigation" 898 "event": "analysis.navigation"
784 "params": { 899 "params": {
785 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 900 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
786 "<b>regions</b>": List&lt;<a href="#type_NavigationRegion">NavigationRegion< /a>&gt; 901 "<b>regions</b>": List&lt;<a href="#type_NavigationRegion">NavigationRegion< /a>&gt;
787 "<b>targets</b>": List&lt;<a href="#type_NavigationTarget">NavigationTarget< /a>&gt; 902 "<b>targets</b>": List&lt;<a href="#type_NavigationTarget">NavigationTarget< /a>&gt;
788 "<b>files</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt; 903 "<b>files</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt;
789 } 904 }
790 }</pre></div> 905 }</pre></div>
791 <p> 906 <p>
(...skipping 1142 matching lines...) Expand 10 before | Expand all | Expand 10 after
1934 <p> 2049 <p>
1935 True is hints should be generated as part of generating 2050 True is hints should be generated as part of generating
1936 errors and warnings. 2051 errors and warnings.
1937 </p> 2052 </p>
1938 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisServic e">AnalysisService: String</a></dt><dd> 2053 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisServic e">AnalysisService: String</a></dt><dd>
1939 <p> 2054 <p>
1940 An enumeration of the services provided by the analysis 2055 An enumeration of the services provided by the analysis
1941 domain. 2056 domain.
1942 </p> 2057 </p>
1943 2058
1944 <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt cla ss="value">NAVIGATION</dt><dt class="value">OCCURRENCES</dt><dt class="value">OU TLINE</dt><dt class="value">OVERRIDES</dt></dl></dd><dt class="typeDefinition">< a name="type_AnalysisStatus">AnalysisStatus: object</a></dt><dd> 2059 <dl><dt class="value">FOLDING</dt><dt class="value">HIGHLIGHTS</dt><dt cla ss="value">INVALIDATE</dt><dt class="value">NAVIGATION</dt><dt class="value">OCC URRENCES</dt><dt class="value">OUTLINE</dt><dt class="value">OVERRIDES</dt></dl> </dd><dt class="typeDefinition"><a name="type_AnalysisStatus">AnalysisStatus: ob ject</a></dt><dd>
1945 <p> 2060 <p>
1946 An indication of the current state of analysis. 2061 An indication of the current state of analysis.
1947 </p> 2062 </p>
1948 2063
1949 <dl><dt class="field"><b><i>isAnalyzing ( bool )</i></b></dt><dd> 2064 <dl><dt class="field"><b><i>isAnalyzing ( bool )</i></b></dt><dd>
1950 2065
1951 <p>True if analysis is currently being performed.</p> 2066 <p>True if analysis is currently being performed.</p>
1952 </dd><dt class="field"><b><i>analysisTarget ( <span style="color:#9999 99">optional</span> String )</i></b></dt><dd> 2067 </dd><dt class="field"><b><i>analysisTarget ( <span style="color:#9999 99">optional</span> String )</i></b></dt><dd>
1953 2068
1954 <p> 2069 <p>
(...skipping 800 matching lines...) Expand 10 before | Expand all | Expand 10 after
2755 <p> 2870 <p>
2756 The stack trace associated with processing the request, 2871 The stack trace associated with processing the request,
2757 used for debugging the server. 2872 used for debugging the server.
2758 </p> 2873 </p>
2759 </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestErrorCo de">RequestErrorCode: String</a></dt><dd> 2874 </dd></dl></dd><dt class="typeDefinition"><a name="type_RequestErrorCo de">RequestErrorCode: String</a></dt><dd>
2760 <p> 2875 <p>
2761 An enumeration of the types of errors that can occur in the 2876 An enumeration of the types of errors that can occur in the
2762 execution of the server. 2877 execution of the server.
2763 </p> 2878 </p>
2764 2879
2765 <dl><dt class="value">GET_ERRORS_INVALID_FILE</dt><dd> 2880 <dl><dt class="value">CONTENT_MODIFIED</dt><dd>
2881
2882 <p>
2883 An "analysis.getErrors" or "analysis.getNavigation" request could
2884 not be satisfied because the content of the file changed before
2885 the requested results could be computed.
2886 </p>
2887 </dd><dt class="value">GET_ERRORS_INVALID_FILE</dt><dd>
2766 2888
2767 <p> 2889 <p>
2768 An "analysis.getErrors" request specified a FilePath 2890 An "analysis.getErrors" request specified a FilePath
2769 which does not match a file currently subject to 2891 which does not match a file currently subject to
2770 analysis. 2892 analysis.
2771 </p> 2893 </p>
2772 </dd><dt class="value">INVALID_OVERLAY_CHANGE</dt><dd> 2894 </dd><dt class="value">INVALID_OVERLAY_CHANGE</dt><dd>
2773 2895
2774 <p> 2896 <p>
2775 An analysis.updateContent request contained a 2897 An analysis.updateContent request contained a
(...skipping 615 matching lines...) Expand 10 before | Expand all | Expand 10 after
3391 <p> 3513 <p>
3392 This section contains a list of all of the errors that are 3514 This section contains a list of all of the errors that are
3393 produced by the server and the data that is returned with each. 3515 produced by the server and the data that is returned with each.
3394 </p> 3516 </p>
3395 <p> 3517 <p>
3396 TBD 3518 TBD
3397 </p> 3519 </p>
3398 3520
3399 3521
3400 </body></html> 3522 </body></html>
OLDNEW
« no previous file with comments | « editor/tools/plugins/com.google.dart.server/src/com/google/dart/server/generated/types/RequestErrorCode.java ('k') | pkg/analysis_server/lib/src/generated_protocol.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698