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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 766323002: Compressed/optimized navigation notification. (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 | « editor/tools/plugins/com.google.dart.tools.ui/src/com/google/dart/tools/ui/internal/text/editor/DartNavigationRegionHyperlink_NEW.java ('k') | pkg/analysis_server/lib/src/computer/computer_navigation.dart » ('j') | pkg/analysis_server/lib/src/computer/computer_navigation.dart » ('J')
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 766 matching lines...) Expand 10 before | Expand all | Expand 10 after
777 semantic meaning associated with some range. Note that 777 semantic meaning associated with some range. Note that
778 the highlight regions that are returned can overlap 778 the highlight regions that are returned can overlap
779 other highlight regions if there is more than one 779 other highlight regions if there is more than one
780 meaning associated with a particular region. 780 meaning associated with a particular region.
781 </p> 781 </p>
782 </dd></dl></dd><dt class="notification">analysis.navigation</dt><dd><d iv class="box"><pre>notification: { 782 </dd></dl></dd><dt class="notification">analysis.navigation</dt><dd><d iv class="box"><pre>notification: {
783 "event": "analysis.navigation" 783 "event": "analysis.navigation"
784 "params": { 784 "params": {
785 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 785 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
786 "<b>regions</b>": List&lt;<a href="#type_NavigationRegion">NavigationRegion< /a>&gt; 786 "<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;
788 "<b>targetFiles</b>": List&lt;<a href="#type_FilePath">FilePath</a>&gt;
787 } 789 }
788 }</pre></div> 790 }</pre></div>
789 <p> 791 <p>
790 Reports the navigation targets associated with a given file. 792 Reports the navigation targets associated with a given file.
791 </p> 793 </p>
792 <p> 794 <p>
793 This notification is not subscribed to by default. Clients 795 This notification is not subscribed to by default. Clients
794 can subscribe by including the value <tt>"NAVIGATION"</tt> 796 can subscribe by including the value <tt>"NAVIGATION"</tt>
795 in the list of services passed in an 797 in the list of services passed in an
796 analysis.setSubscriptions request. 798 analysis.setSubscriptions request.
(...skipping 11 matching lines...) Expand all
808 The regions are sorted by their offsets. 810 The regions are sorted by their offsets.
809 Each navigation region represents a list of targets 811 Each navigation region represents a list of targets
810 associated with some range. The lists will usually 812 associated with some range. The lists will usually
811 contain a single target, but can contain more in the 813 contain a single target, but can contain more in the
812 case of a part that is included in multiple libraries 814 case of a part that is included in multiple libraries
813 or in Dart code that is compiled against multiple 815 or in Dart code that is compiled against multiple
814 versions of a package. Note that the navigation 816 versions of a package. Note that the navigation
815 regions that are returned do not overlap other 817 regions that are returned do not overlap other
816 navigation regions. 818 navigation regions.
817 </p> 819 </p>
820 </dd><dt class="field"><b><i>targets ( List&lt;<a href="#type_Navigati onTarget">NavigationTarget</a>&gt; )</i></b></dt><dd>
821
822 <p>
823 The navigation targets referenced in the file.
824 They are referenced by <tt>NavigationRegion</tt>s by their
825 index in this array.
826 </p>
827 </dd><dt class="field"><b><i>targetFiles ( List&lt;<a href="#type_File Path">FilePath</a>&gt; )</i></b></dt><dd>
828
829 <p>
830 The files containing navigation targets referenced in the file.
831 They are referenced by <tt>NavigationTarget</tt>s by their
832 index in this array.
833 </p>
818 </dd></dl></dd><dt class="notification">analysis.occurrences</dt><dd>< div class="box"><pre>notification: { 834 </dd></dl></dd><dt class="notification">analysis.occurrences</dt><dd>< div class="box"><pre>notification: {
819 "event": "analysis.occurrences" 835 "event": "analysis.occurrences"
820 "params": { 836 "params": {
821 "<b>file</b>": <a href="#type_FilePath">FilePath</a> 837 "<b>file</b>": <a href="#type_FilePath">FilePath</a>
822 "<b>occurrences</b>": List&lt;<a href="#type_Occurrences">Occurrences</a>&gt ; 838 "<b>occurrences</b>": List&lt;<a href="#type_Occurrences">Occurrences</a>&gt ;
823 } 839 }
824 }</pre></div> 840 }</pre></div>
825 <p> 841 <p>
826 Reports the occurrences of references to elements within a 842 Reports the occurrences of references to elements within a
827 single file. 843 single file.
(...skipping 967 matching lines...) Expand 10 before | Expand all | Expand 10 after
1795 1811
1796 1812
1797 1813
1798 1814
1799 1815
1800 1816
1801 1817
1802 1818
1803 1819
1804 1820
1821
1805 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv erlay: object</a></dt><dd> 1822 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv erlay: object</a></dt><dd>
1806 <p> 1823 <p>
1807 A directive to begin overlaying the contents of a file. The 1824 A directive to begin overlaying the contents of a file. The
1808 supplied content will be used for analysis in place of the 1825 supplied content will be used for analysis in place of the
1809 file contents in the filesystem. 1826 file contents in the filesystem.
1810 </p> 1827 </p>
1811 <p> 1828 <p>
1812 If this directive is used on a file that already has a file 1829 If this directive is used on a file that already has a file
1813 content overlay, the old overlay is discarded and replaced 1830 content overlay, the old overlay is discarded and replaced
1814 with the new one. 1831 with the new one.
(...skipping 297 matching lines...) Expand 10 before | Expand all | Expand 10 after
2112 A list of arguments for the method or function that is being invok ed. 2129 A list of arguments for the method or function that is being invok ed.
2113 For this suggestion kind, the completion field is a textual repres entation 2130 For this suggestion kind, the completion field is a textual repres entation
2114 of the invocation and the parameterNames, parameterTypes, and requ iredParameterCount 2131 of the invocation and the parameterNames, parameterTypes, and requ iredParameterCount
2115 attributes are defined. 2132 attributes are defined.
2116 </p> 2133 </p>
2117 </dd><dt class="value">IMPORT</dt><dt class="value">IDENTIFIER</dt><dd > 2134 </dd><dt class="value">IMPORT</dt><dt class="value">IDENTIFIER</dt><dd >
2118 2135
2119 <p> 2136 <p>
2120 The element identifier should be inserted at the completion locati on. 2137 The element identifier should be inserted at the completion locati on.
2121 For example "someMethod" in import 'myLib.dart' show someMethod; . 2138 For example "someMethod" in import 'myLib.dart' show someMethod; .
2122 For suggestions of this kind, the element attribute is defined 2139 For suggestions of this kind, the element attribute is defined
2123 and the completion field is the element's identifier. 2140 and the completion field is the element's identifier.
2124 </p> 2141 </p>
2125 </dd><dt class="value">INVOCATION</dt><dd> 2142 </dd><dt class="value">INVOCATION</dt><dd>
2126 2143
2127 <p> 2144 <p>
2128 The element is being invoked at the completion location. 2145 The element is being invoked at the completion location.
2129 For example, "someMethod" in x.someMethod(); . 2146 For example, "someMethod" in x.someMethod(); .
2130 For suggestions of this kind, the element attribute is defined 2147 For suggestions of this kind, the element attribute is defined
2131 and the completion field is the element's identifier. 2148 and the completion field is the element's identifier.
2132 </p> 2149 </p>
2133 </dd><dt class="value">KEYWORD</dt><dd> 2150 </dd><dt class="value">KEYWORD</dt><dd>
2134 2151
2135 <p> 2152 <p>
2136 A keyword is being suggested. 2153 A keyword is being suggested.
2137 For suggestions of this kind, the completion is the keyword. 2154 For suggestions of this kind, the completion is the keyword.
2138 </p> 2155 </p>
2139 </dd><dt class="value">NAMED_ARGUMENT</dt><dt class="value">OPTIONAL_A RGUMENT</dt><dt class="value">PARAMETER</dt></dl></dd><dt class="typeDefinition" ><a name="type_Element">Element: object</a></dt><dd> 2156 </dd><dt class="value">NAMED_ARGUMENT</dt><dt class="value">OPTIONAL_A RGUMENT</dt><dt class="value">PARAMETER</dt></dl></dd><dt class="typeDefinition" ><a name="type_Element">Element: object</a></dt><dd>
2140 <p> 2157 <p>
(...skipping 315 matching lines...) Expand 10 before | Expand all | Expand 10 after
2456 <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd> 2473 <dl><dt class="field"><b><i>offset ( int )</i></b></dt><dd>
2457 2474
2458 <p> 2475 <p>
2459 The offset of the region from which the user can navigate. 2476 The offset of the region from which the user can navigate.
2460 </p> 2477 </p>
2461 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> 2478 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>
2462 2479
2463 <p> 2480 <p>
2464 The length of the region from which the user can navigate. 2481 The length of the region from which the user can navigate.
2465 </p> 2482 </p>
2466 </dd><dt class="field"><b><i>targets ( List&lt;<a href="#type_Element" >Element</a>&gt; )</i></b></dt><dd> 2483 </dd><dt class="field"><b><i>targetIndexes ( List&lt;int&gt; )</i></b> </dt><dd>
2467 2484
2468 <p> 2485 <p>
2469 The elements to which the given region is bound. By 2486 The indexes of the targets (in the enclosing navigation response)
2470 opening the declaration of the elements, clients can 2487 to which the given region is bound. By opening the target, clients
2471 implement one form of navigation. 2488 can implement one form of navigation.
2489 </p>
2490 </dd></dl></dd><dt class="typeDefinition"><a name="type_NavigationTarg et">NavigationTarget: object</a></dt><dd>
2491 <p>
2492 A description of a target to which the user can navigate to.
2493 </p>
2494
2495 <dl><dt class="field"><b><i>kind ( <a href="#type_ElementKind">ElementKind </a> )</i></b></dt><dd>
2496
2497 <p>
2498 The kind of the element.
2499 </p>
2500 </dd><dt class="field"><b><i>fileIndex ( int )</i></b></dt><dd>
2501
2502 <p>
2503 The index of the file (in the enclosing navigation response) to
2504 navigate to.
2505 </p>
2506 </dd><dt class="field"><b><i>offset ( int )</i></b></dt><dd>
2507
2508 <p>
2509 The offset of the region from which the user can navigate.
2510 </p>
2511 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd>
2512
2513 <p>
2514 The length of the region from which the user can navigate.
2515 </p>
2516 </dd><dt class="field"><b><i>startLine ( int )</i></b></dt><dd>
2517
2518 <p>
2519 The one-based index of the line containing the first
2520 character of the region.
2521 </p>
2522 </dd><dt class="field"><b><i>startColumn ( int )</i></b></dt><dd>
2523
2524 <p>
2525 The one-based index of the column containing the first
2526 character of the region.
2472 </p> 2527 </p>
2473 </dd></dl></dd><dt class="typeDefinition"><a name="type_Occurrences">O ccurrences: object</a></dt><dd> 2528 </dd></dl></dd><dt class="typeDefinition"><a name="type_Occurrences">O ccurrences: object</a></dt><dd>
2474 <p> 2529 <p>
2475 A description of the references to a single element within a 2530 A description of the references to a single element within a
2476 single file. 2531 single file.
2477 </p> 2532 </p>
2478 2533
2479 <dl><dt class="field"><b><i>element ( <a href="#type_Element">Element</a> )</i></b></dt><dd> 2534 <dl><dt class="field"><b><i>element ( <a href="#type_Element">Element</a> )</i></b></dt><dd>
2480 2535
2481 <p> 2536 <p>
(...skipping 854 matching lines...) Expand 10 before | Expand all | Expand 10 after
3336 <p> 3391 <p>
3337 This section contains a list of all of the errors that are 3392 This section contains a list of all of the errors that are
3338 produced by the server and the data that is returned with each. 3393 produced by the server and the data that is returned with each.
3339 </p> 3394 </p>
3340 <p> 3395 <p>
3341 TBD 3396 TBD
3342 </p> 3397 </p>
3343 3398
3344 3399
3345 </body></html> 3400 </body></html>
OLDNEW
« no previous file with comments | « editor/tools/plugins/com.google.dart.tools.ui/src/com/google/dart/tools/ui/internal/text/editor/DartNavigationRegionHyperlink_NEW.java ('k') | pkg/analysis_server/lib/src/computer/computer_navigation.dart » ('j') | pkg/analysis_server/lib/src/computer/computer_navigation.dart » ('J')

Powered by Google App Engine
This is Rietveld 408576698