Chromium Code Reviews| OLD | NEW |
|---|---|
| 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 671 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 682 Each navigation region represents a list of targets | 682 Each navigation region represents a list of targets |
| 683 associated with some range. The lists will usually | 683 associated with some range. The lists will usually |
| 684 contain a single target, but can contain more in the | 684 contain a single target, but can contain more in the |
| 685 case of a part that is included in multiple libraries | 685 case of a part that is included in multiple libraries |
| 686 or in Dart code that is compiled against multiple | 686 or in Dart code that is compiled against multiple |
| 687 versions of a package. Note that the navigation | 687 versions of a package. Note that the navigation |
| 688 regions that are returned do not overlap other | 688 regions that are returned do not overlap other |
| 689 navigation regions. | 689 navigation regions. |
| 690 </p> | 690 </p> |
| 691 </field> | 691 </field> |
| 692 <field name="targets"> | |
| 693 <list><ref>NavigationTarget</ref></list> | |
| 694 <p> | |
| 695 The navigation targets referenced in the file. | |
| 696 They are referenced by <tt>NavigationRegion</tt>s by their | |
| 697 index in this array. | |
| 698 </p> | |
| 699 </field> | |
| 700 <field name="targetFiles"> | |
|
Brian Wilkerson
2014/12/01 21:42:14
How about "files"? The name "targetFiles" is a lit
scheglov
2014/12/01 22:20:32
Done.
| |
| 701 <list><ref>FilePath</ref></list> | |
| 702 <p> | |
| 703 The files containing navigation targets referenced in the file. | |
| 704 They are referenced by <tt>NavigationTarget</tt>s by their | |
| 705 index in this array. | |
| 706 </p> | |
| 707 </field> | |
| 692 </params> | 708 </params> |
| 693 </notification> | 709 </notification> |
| 694 <notification event="occurrences"> | 710 <notification event="occurrences"> |
| 695 <p> | 711 <p> |
| 696 Reports the occurrences of references to elements within a | 712 Reports the occurrences of references to elements within a |
| 697 single file. | 713 single file. |
| 698 </p> | 714 </p> |
| 699 <p> | 715 <p> |
| 700 This notification is not subscribed to by default. Clients | 716 This notification is not subscribed to by default. Clients |
| 701 can subscribe by including the value <tt>"OCCURRENCES"</tt> | 717 can subscribe by including the value <tt>"OCCURRENCES"</tt> |
| (...skipping 1184 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 1886 of the invocation and the parameterNames, parameterTypes, and requ iredParameterCount | 1902 of the invocation and the parameterNames, parameterTypes, and requ iredParameterCount |
| 1887 attributes are defined. | 1903 attributes are defined. |
| 1888 </p> | 1904 </p> |
| 1889 </value> | 1905 </value> |
| 1890 <value><code>IMPORT</code></value> | 1906 <value><code>IMPORT</code></value> |
| 1891 <value> | 1907 <value> |
| 1892 <code>IDENTIFIER</code> | 1908 <code>IDENTIFIER</code> |
| 1893 <p> | 1909 <p> |
| 1894 The element identifier should be inserted at the completion locati on. | 1910 The element identifier should be inserted at the completion locati on. |
| 1895 For example "someMethod" in import 'myLib.dart' show someMethod; . | 1911 For example "someMethod" in import 'myLib.dart' show someMethod; . |
| 1896 For suggestions of this kind, the element attribute is defined | 1912 For suggestions of this kind, the element attribute is defined |
| 1897 and the completion field is the element's identifier. | 1913 and the completion field is the element's identifier. |
| 1898 </p> | 1914 </p> |
| 1899 </value> | 1915 </value> |
| 1900 <value> | 1916 <value> |
| 1901 <code>INVOCATION</code> | 1917 <code>INVOCATION</code> |
| 1902 <p> | 1918 <p> |
| 1903 The element is being invoked at the completion location. | 1919 The element is being invoked at the completion location. |
| 1904 For example, "someMethod" in x.someMethod(); . | 1920 For example, "someMethod" in x.someMethod(); . |
| 1905 For suggestions of this kind, the element attribute is defined | 1921 For suggestions of this kind, the element attribute is defined |
| 1906 and the completion field is the element's identifier. | 1922 and the completion field is the element's identifier. |
| 1907 </p> | 1923 </p> |
| 1908 </value> | 1924 </value> |
| 1909 <value> | 1925 <value> |
| 1910 <code>KEYWORD</code> | 1926 <code>KEYWORD</code> |
| 1911 <p> | 1927 <p> |
| 1912 A keyword is being suggested. | 1928 A keyword is being suggested. |
| 1913 For suggestions of this kind, the completion is the keyword. | 1929 For suggestions of this kind, the completion is the keyword. |
| 1914 </p> | 1930 </p> |
| 1915 </value> | 1931 </value> |
| (...skipping 460 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 2376 <p> | 2392 <p> |
| 2377 The offset of the region from which the user can navigate. | 2393 The offset of the region from which the user can navigate. |
| 2378 </p> | 2394 </p> |
| 2379 </field> | 2395 </field> |
| 2380 <field name="length"> | 2396 <field name="length"> |
| 2381 <ref>int</ref> | 2397 <ref>int</ref> |
| 2382 <p> | 2398 <p> |
| 2383 The length of the region from which the user can navigate. | 2399 The length of the region from which the user can navigate. |
| 2384 </p> | 2400 </p> |
| 2385 </field> | 2401 </field> |
| 2386 <field name="targets"> | 2402 <field name="targetIndexes"> |
|
Brian Wilkerson
2014/12/01 21:42:14
I'd rather leave this as "targets". We didn't add
scheglov
2014/12/01 22:20:32
Done.
| |
| 2387 <list><ref>Element</ref></list> | 2403 <list><ref>int</ref></list> |
| 2388 <p> | 2404 <p> |
| 2389 The elements to which the given region is bound. By | 2405 The indexes of the targets (in the enclosing navigation response) |
|
Paul Berry
2014/12/01 21:50:37
s/indexes/indices/
| |
| 2390 opening the declaration of the elements, clients can | 2406 to which the given region is bound. By opening the target, clients |
| 2391 implement one form of navigation. | 2407 can implement one form of navigation. |
| 2392 </p> | 2408 </p> |
| 2393 </field> | 2409 </field> |
| 2394 </object> | 2410 </object> |
| 2411 </type> | |
| 2412 <type name="NavigationTarget"> | |
| 2413 <p> | |
| 2414 A description of a target to which the user can navigate to. | |
|
Brian Wilkerson
2014/12/01 21:42:14
Remove second "to".
scheglov
2014/12/01 22:20:32
Done.
| |
| 2415 </p> | |
| 2416 <object> | |
| 2417 <field name="kind"> | |
| 2418 <ref>ElementKind</ref> | |
| 2419 <p> | |
| 2420 The kind of the element. | |
| 2421 </p> | |
| 2422 </field> | |
| 2423 <field name="fileIndex"> | |
| 2424 <ref>int</ref> | |
| 2425 <p> | |
| 2426 The index of the file (in the enclosing navigation response) to | |
| 2427 navigate to. | |
| 2428 </p> | |
| 2429 </field> | |
| 2430 <field name="offset"> | |
| 2431 <ref>int</ref> | |
| 2432 <p> | |
| 2433 The offset of the region from which the user can navigate. | |
| 2434 </p> | |
| 2435 </field> | |
| 2436 <field name="length"> | |
| 2437 <ref>int</ref> | |
| 2438 <p> | |
| 2439 The length of the region from which the user can navigate. | |
| 2440 </p> | |
| 2441 </field> | |
| 2442 <field name="startLine"> | |
| 2443 <ref>int</ref> | |
| 2444 <p> | |
| 2445 The one-based index of the line containing the first | |
| 2446 character of the region. | |
| 2447 </p> | |
| 2448 </field> | |
| 2449 <field name="startColumn"> | |
| 2450 <ref>int</ref> | |
| 2451 <p> | |
| 2452 The one-based index of the column containing the first | |
| 2453 character of the region. | |
| 2454 </p> | |
| 2455 </field> | |
| 2456 </object> | |
| 2395 </type> | 2457 </type> |
| 2396 <type name="Occurrences"> | 2458 <type name="Occurrences"> |
| 2397 <p> | 2459 <p> |
| 2398 A description of the references to a single element within a | 2460 A description of the references to a single element within a |
| 2399 single file. | 2461 single file. |
| 2400 </p> | 2462 </p> |
| 2401 <object> | 2463 <object> |
| 2402 <field name="element"> | 2464 <field name="element"> |
| 2403 <ref>Element</ref> | 2465 <ref>Element</ref> |
| 2404 <p> | 2466 <p> |
| (...skipping 1025 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... | |
| 3430 <h2>Errors</h2> | 3492 <h2>Errors</h2> |
| 3431 <p> | 3493 <p> |
| 3432 This section contains a list of all of the errors that are | 3494 This section contains a list of all of the errors that are |
| 3433 produced by the server and the data that is returned with each. | 3495 produced by the server and the data that is returned with each. |
| 3434 </p> | 3496 </p> |
| 3435 <p> | 3497 <p> |
| 3436 TBD | 3498 TBD |
| 3437 </p> | 3499 </p> |
| 3438 </body> | 3500 </body> |
| 3439 </html> | 3501 </html> |
| OLD | NEW |