| OLD | NEW |
|---|
| 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>h1 { | 4 <style>body { |
| 5 font-family: sans-serif, serif; |
| 6 padding-left: 5%; |
| 7 padding-right: 5%; |
| 8 } |
| 9 h1 { |
| 5 text-align: center; | 10 text-align: center; |
| 6 } | 11 } |
| 12 h2.domain { |
| 13 border-bottom: 3px solid rgb(160, 160, 160); |
| 14 } |
| 7 pre { | 15 pre { |
| 8 margin: 0px; | 16 margin: 0px; |
| 9 } | 17 } |
| 10 div.box { | 18 div.box { |
| 11 border: 1px solid rgb(0, 0, 0); | 19 border: 1px solid rgb(0, 0, 0); |
| 12 background-color: rgb(207, 226, 243); | 20 background-color: rgb(207, 226, 243); |
| 13 padding: 0.5em; | 21 padding: 0.5em; |
| 14 } | 22 } |
| 23 div.hangingIndent { |
| 24 padding-left: 3em; |
| 25 text-indent: -3em; |
| 26 } |
| 15 dt { | 27 dt { |
| 16 margin-top: 1em; | 28 margin-top: 1em; |
| 17 margin-bottom: 1em; | 29 margin-bottom: 1em; |
| 18 } | 30 } |
| 19 div.hangingIndent { | 31 dt.notification { |
| 20 padding-left: 3em; | 32 font-weight: bold; |
| 21 text-indent: -3em; | 33 } |
| 34 dt.refactoring { |
| 35 font-weight: bold; |
| 36 } |
| 37 dt.request { |
| 38 font-weight: bold; |
| 39 } |
| 40 dt.typeDefinition { |
| 41 font-weight: bold; |
| 22 } | 42 } |
| 23 </style></head> | 43 </style></head> |
| 24 <body> | 44 <body> |
| 25 <h1>Analysis Server API Specification</h1> | 45 <h1>Analysis Server API Specification</h1> |
| 26 <h1 style="color:#999999">WORKING DRAFT - Version 0.3</h1> | 46 <h1 style="color:#999999">WORKING DRAFT - Version 0.3</h1> |
| 27 <p> | 47 <p> |
| 28 This document contains a specification of the API provided by | 48 This document contains a specification of the API provided by |
| 29 the analysis server. The API in this document is currently under | 49 the analysis server. The API in this document is currently under |
| 30 development and should be expected to change. In some cases | 50 development and should be expected to change. In some cases |
| 31 those changes will be substantial. | 51 those changes will be substantial. |
| (...skipping 114 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 146 <h4>Options</h4> | 166 <h4>Options</h4> |
| 147 <dl> | 167 <dl> |
| 148 <dt>--no-error-notification</dt> | 168 <dt>--no-error-notification</dt> |
| 149 <dd></dd> | 169 <dd></dd> |
| 150 </dl> | 170 </dl> |
| 151 <p> | 171 <p> |
| 152 Disable notifications about errors (see analysis.error). If this | 172 Disable notifications about errors (see analysis.error). If this |
| 153 flag is not specified then notifications will be sent for all | 173 flag is not specified then notifications will be sent for all |
| 154 errors produced for all files in the actual analysis roots. | 174 errors produced for all files in the actual analysis roots. |
| 155 </p> | 175 </p> |
| 156 <h2><a name="domain_server">Domain: server</a></h2> | 176 <h2 class="domain"><a name="domain_server">Domain: server</a></h2> |
| 157 <p> | 177 <p> |
| 158 The server domain contains API’s related to the execution of | 178 The server domain contains API’s related to the execution of |
| 159 the server. | 179 the server. |
| 160 </p> | 180 </p> |
| 161 | 181 |
| 162 | 182 |
| 163 | 183 |
| 164 | 184 |
| 165 | 185 |
| 166 | 186 |
| (...skipping 122 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 289 </p> | 309 </p> |
| 290 | 310 |
| 291 <h4>Parameters</h4><dl><dt class="field"><b><i>analysis ( <span style="col
or:#999999">optional</span> <a href="#type_AnalysisStatus">AnalysisStatus</a> )<
/i></b></dt><dd> | 311 <h4>Parameters</h4><dl><dt class="field"><b><i>analysis ( <span style="col
or:#999999">optional</span> <a href="#type_AnalysisStatus">AnalysisStatus</a> )<
/i></b></dt><dd> |
| 292 | 312 |
| 293 <p> | 313 <p> |
| 294 The current status of analysis, including whether | 314 The current status of analysis, including whether |
| 295 analysis is being performed and if so what is being | 315 analysis is being performed and if so what is being |
| 296 analyzed. | 316 analyzed. |
| 297 </p> | 317 </p> |
| 298 </dd></dl></dd></dl> | 318 </dd></dl></dd></dl> |
| 299 <h2><a name="domain_analysis">Domain: analysis</a></h2> | 319 <h2 class="domain"><a name="domain_analysis">Domain: analysis</a></h2> |
| 300 <p> | 320 <p> |
| 301 The analysis domain contains API’s related to the analysis of | 321 The analysis domain contains API’s related to the analysis of |
| 302 files. | 322 files. |
| 303 </p> | 323 </p> |
| 304 | 324 |
| 305 | 325 |
| 306 | 326 |
| 307 | 327 |
| 308 | 328 |
| 309 | 329 |
| (...skipping 538 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 848 | 868 |
| 849 <p> | 869 <p> |
| 850 The file with which the overrides are associated. | 870 The file with which the overrides are associated. |
| 851 </p> | 871 </p> |
| 852 </dd><dt class="field"><b><i>overrides ( List<<a href="#type_Overri
de">Override</a>> )</i></b></dt><dd> | 872 </dd><dt class="field"><b><i>overrides ( List<<a href="#type_Overri
de">Override</a>> )</i></b></dt><dd> |
| 853 | 873 |
| 854 <p> | 874 <p> |
| 855 The overrides associated with the file. | 875 The overrides associated with the file. |
| 856 </p> | 876 </p> |
| 857 </dd></dl></dd></dl> | 877 </dd></dl></dd></dl> |
| 858 <h2><a name="domain_completion">Domain: completion</a></h2> | 878 <h2 class="domain"><a name="domain_completion">Domain: completion</a></h2> |
| 859 <p> | 879 <p> |
| 860 The code completion domain contains commands related to | 880 The code completion domain contains commands related to |
| 861 getting code completion suggestions. | 881 getting code completion suggestions. |
| 862 </p> | 882 </p> |
| 863 | 883 |
| 864 | 884 |
| 865 <h3>Requests</h3><dl><dt class="request">completion.getSuggestions</dt><dd><
div class="box"><pre>request: { | 885 <h3>Requests</h3><dl><dt class="request">completion.getSuggestions</dt><dd><
div class="box"><pre>request: { |
| 866 "id": String | 886 "id": String |
| 867 "method": "completion.getSuggestions" | 887 "method": "completion.getSuggestions" |
| 868 "params": { | 888 "params": { |
| (...skipping 76 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 945 <p> | 965 <p> |
| 946 The completion suggestions being reported. | 966 The completion suggestions being reported. |
| 947 </p> | 967 </p> |
| 948 </dd><dt class="field"><b><i>last ( bool )</i></b></dt><dd> | 968 </dd><dt class="field"><b><i>last ( bool )</i></b></dt><dd> |
| 949 | 969 |
| 950 <p> | 970 <p> |
| 951 True if this is that last set of results that will be | 971 True if this is that last set of results that will be |
| 952 returned for the indicated completion. | 972 returned for the indicated completion. |
| 953 </p> | 973 </p> |
| 954 </dd></dl></dd></dl> | 974 </dd></dl></dd></dl> |
| 955 <h2><a name="domain_search">Domain: search</a></h2> | 975 <h2 class="domain"><a name="domain_search">Domain: search</a></h2> |
| 956 <p> | 976 <p> |
| 957 The search domain contains commands related to searches that | 977 The search domain contains commands related to searches that |
| 958 can be performed against the code base. | 978 can be performed against the code base. |
| 959 </p> | 979 </p> |
| 960 | 980 |
| 961 | 981 |
| 962 | 982 |
| 963 | 983 |
| 964 | 984 |
| 965 | 985 |
| (...skipping 237 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1203 <p> | 1223 <p> |
| 1204 The search results being reported. | 1224 The search results being reported. |
| 1205 </p> | 1225 </p> |
| 1206 </dd><dt class="field"><b><i>last ( bool )</i></b></dt><dd> | 1226 </dd><dt class="field"><b><i>last ( bool )</i></b></dt><dd> |
| 1207 | 1227 |
| 1208 <p> | 1228 <p> |
| 1209 True if this is that last set of results that will be | 1229 True if this is that last set of results that will be |
| 1210 returned for the indicated search. | 1230 returned for the indicated search. |
| 1211 </p> | 1231 </p> |
| 1212 </dd></dl></dd></dl> | 1232 </dd></dl></dd></dl> |
| 1213 <h2><a name="domain_edit">Domain: edit</a></h2> | 1233 <h2 class="domain"><a name="domain_edit">Domain: edit</a></h2> |
| 1214 <p> | 1234 <p> |
| 1215 The edit domain contains commands related to edits that can be | 1235 The edit domain contains commands related to edits that can be |
| 1216 applied to the code. | 1236 applied to the code. |
| 1217 </p> | 1237 </p> |
| 1218 | 1238 |
| 1219 | 1239 |
| 1220 | 1240 |
| 1221 | 1241 |
| 1222 <h3>Requests</h3><dl><dt class="request">edit.getAssists</dt><dd><div class=
"box"><pre>request: { | 1242 <h3>Requests</h3><dl><dt class="request">edit.getAssists</dt><dd><div class=
"box"><pre>request: { |
| 1223 "id": String | 1243 "id": String |
| (...skipping 213 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1437 | 1457 |
| 1438 <p> | 1458 <p> |
| 1439 The changes that are to be applied to affect the | 1459 The changes that are to be applied to affect the |
| 1440 refactoring. This field will be omitted if there are | 1460 refactoring. This field will be omitted if there are |
| 1441 problems that prevent a set of changed from being | 1461 problems that prevent a set of changed from being |
| 1442 computed, such as having no options specified for a | 1462 computed, such as having no options specified for a |
| 1443 refactoring that requires them, or if only validation | 1463 refactoring that requires them, or if only validation |
| 1444 was requested. | 1464 was requested. |
| 1445 </p> | 1465 </p> |
| 1446 </dd></dl></dd></dl> | 1466 </dd></dl></dd></dl> |
| 1447 <h2><a name="domain_debug">Domain: debug</a></h2> | 1467 <h2 class="domain"><a name="domain_debug">Domain: debug</a></h2> |
| 1448 <p> | 1468 <p> |
| 1449 The debugging domain contains commands related to providing a | 1469 The debugging domain contains commands related to providing a |
| 1450 debugging experience. | 1470 debugging experience. |
| 1451 </p> | 1471 </p> |
| 1452 | 1472 |
| 1453 | 1473 |
| 1454 | 1474 |
| 1455 | 1475 |
| 1456 | 1476 |
| 1457 <h3>Requests</h3><dl><dt class="request">debug.createContext</dt><dd><div cl
ass="box"><pre>request: { | 1477 <h3>Requests</h3><dl><dt class="request">debug.createContext</dt><dd><div cl
ass="box"><pre>request: { |
| (...skipping 276 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1734 correction message should indicate how the user can fix | 1754 correction message should indicate how the user can fix |
| 1735 the error. The field is omitted if there is no correction | 1755 the error. The field is omitted if there is no correction |
| 1736 message associated with the error code. | 1756 message associated with the error code. |
| 1737 </p> | 1757 </p> |
| 1738 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisOption
s">AnalysisOptions: object</a></dt><dd> | 1758 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisOption
s">AnalysisOptions: object</a></dt><dd> |
| 1739 <p> | 1759 <p> |
| 1740 A set of options controlling what kind of analysis is to be | 1760 A set of options controlling what kind of analysis is to be |
| 1741 performed. If the value of a field is omitted the value of the | 1761 performed. If the value of a field is omitted the value of the |
| 1742 option will not be changed. | 1762 option will not be changed. |
| 1743 </p> | 1763 </p> |
| 1744 <p> | |
| 1745 NOTE: These options need to change. | |
| 1746 </p> | |
| 1747 | 1764 |
| 1748 <dl><dt class="field"><b><i>analyzeAngular ( <span style="color:#999999">o
ptional</span> bool )</i></b></dt><dd> | 1765 <dl><dt class="field"><b><i>enableAsync ( <span style="color:#999999">opti
onal</span> bool )</i></b></dt><dd> |
| 1749 | |
| 1750 <p> | |
| 1751 True if the client wants Angular code to be analyzed. | |
| 1752 </p> | |
| 1753 </dd><dt class="field"><b><i>analyzePolymer ( <span style="color:#9999
99">optional</span> bool )</i></b></dt><dd> | |
| 1754 | |
| 1755 <p> | |
| 1756 True if the client wants Polymer code to be analyzed. | |
| 1757 </p> | |
| 1758 </dd><dt class="field"><b><i>enableAsync ( <span style="color:#999999"
>optional</span> bool )</i></b></dt><dd> | |
| 1759 | 1766 |
| 1760 <p> | 1767 <p> |
| 1761 True if the client wants to enable support for the | 1768 True if the client wants to enable support for the |
| 1762 proposed async feature. | 1769 proposed async feature. |
| 1763 </p> | 1770 </p> |
| 1764 </dd><dt class="field"><b><i>enableDeferredLoading ( <span style="colo
r:#999999">optional</span> bool )</i></b></dt><dd> | 1771 </dd><dt class="field"><b><i>enableDeferredLoading ( <span style="colo
r:#999999">optional</span> bool )</i></b></dt><dd> |
| 1765 | 1772 |
| 1766 <p> | 1773 <p> |
| 1767 True if the client wants to enable support for the | 1774 True if the client wants to enable support for the |
| 1768 proposed deferred loading feature. | 1775 proposed deferred loading feature. |
| 1769 </p> | 1776 </p> |
| 1770 </dd><dt class="field"><b><i>enableEnums ( <span style="color:#999999"
>optional</span> bool )</i></b></dt><dd> | 1777 </dd><dt class="field"><b><i>enableEnums ( <span style="color:#999999"
>optional</span> bool )</i></b></dt><dd> |
| 1771 | 1778 |
| 1772 <p> | 1779 <p> |
| 1773 True if the client wants to enable support for the | 1780 True if the client wants to enable support for the |
| 1774 proposed enum feature. | 1781 proposed enum feature. |
| 1775 </p> | 1782 </p> |
| 1776 </dd><dt class="field"><b><i>generateDart2jsHints ( <span style="color
:#999999">optional</span> bool )</i></b></dt><dd> | 1783 </dd><dt class="field"><b><i>generateDart2jsHints ( <span style="color
:#999999">optional</span> bool )</i></b></dt><dd> |
| 1777 | 1784 |
| 1778 <p> | 1785 <p> |
| 1779 True if hints that are specific to dart2js should be | 1786 True if hints that are specific to dart2js should be |
| 1780 generated. This option is ignored if either provideErrors | 1787 generated. This option is ignored if generateHints is false. |
| 1781 or generateHints is false. | |
| 1782 </p> | 1788 </p> |
| 1783 </dd><dt class="field"><b><i>generateHints ( <span style="color:#99999
9">optional</span> bool )</i></b></dt><dd> | 1789 </dd><dt class="field"><b><i>generateHints ( <span style="color:#99999
9">optional</span> bool )</i></b></dt><dd> |
| 1784 | 1790 |
| 1785 <p> | 1791 <p> |
| 1786 True is hints should be generated as part of generating | 1792 True is hints should be generated as part of generating |
| 1787 errors and warnings. This option is ignored if | 1793 errors and warnings. |
| 1788 provideErrors is false. | |
| 1789 </p> | 1794 </p> |
| 1790 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisServic
e">AnalysisService: String</a></dt><dd> | 1795 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisServic
e">AnalysisService: String</a></dt><dd> |
| 1791 <p> | 1796 <p> |
| 1792 An enumeration of the services provided by the analysis | 1797 An enumeration of the services provided by the analysis |
| 1793 domain. | 1798 domain. |
| 1794 </p> | 1799 </p> |
| 1795 | 1800 |
| 1796 <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> | 1801 <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> |
| 1797 <p> | 1802 <p> |
| 1798 An indication of the current state of analysis. | 1803 An indication of the current state of analysis. |
| 1799 </p> | 1804 </p> |
| 1800 | 1805 |
| 1801 <dl><dt class="field"><b><i>analyzing ( bool )</i></b></dt><dd> | 1806 <dl><dt class="field"><b><i>analyzing ( bool )</i></b></dt><dd> |
| 1802 | 1807 |
| 1803 <p>True if analysis is currently being performed.</p> | 1808 <p>True if analysis is currently being performed.</p> |
| 1804 </dd><dt class="field"><b><i>analysisTarget ( <span style="color:#9999
99">optional</span> String )</i></b></dt><dd> | 1809 </dd><dt class="field"><b><i>analysisTarget ( <span style="color:#9999
99">optional</span> String )</i></b></dt><dd> |
| 1805 | 1810 |
| 1806 <p> | 1811 <p> |
| 1807 The name of the current target of analysis. This field is | 1812 The name of the current target of analysis. This field is |
| 1808 omitted if analyzing is false. | 1813 omitted if analyzing is false. |
| 1809 </p> | 1814 </p> |
| 1810 </dd></dl></dd><dt class="typeDefinition"><a name="type_ChangeContentO
verlay">ChangeContentOverlay: object</a></dt><dd> | 1815 </dd></dl></dd><dt class="typeDefinition"><a name="type_ChangeContentO
verlay">ChangeContentOverlay: object</a></dt><dd> |
| 1811 <p> | 1816 <p> |
| 1812 A directive to modify an existing file content overlay. A | 1817 A directive to modify an existing file content overlay. One or more |
| 1813 range of text is deleted from the old file content overlay | 1818 ranges of text are deleted from the old file content overlay and |
| 1814 and replaced with new text. | 1819 replaced with new text. |
| 1815 </p> | 1820 </p> |
| 1816 <p> | 1821 <p> |
| 1817 It is an error to use this directive is used on a file that | 1822 The edits are applied in the order in which they occur in the list. |
| 1818 does not yet have a file content overlay (or that has had | 1823 This means that the offset of each edit must be correct under the |
| 1819 its overlay removed via <a href="#type_RemoveContentOverlay">RemoveCon
tentOverlay</a>). | 1824 assumption that all previous edits have been applied. |
| 1825 </p> |
| 1826 <p> |
| 1827 It is an error to use this overlay on a file that does not yet have |
| 1828 a file content overlay or that has had its overlay removed via |
| 1829 <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>. |
| 1820 </p> | 1830 </p> |
| 1821 | 1831 |
| 1822 <dl><dt class="field"><b><i>type = "change"</i></b></dt><dd></dd><dt class
="field"><b><i>offset ( int )</i></b></dt><dd> | 1832 <dl><dt class="field"><b><i>type = "change"</i></b></dt><dd></dd><dt class
="field"><b><i>edits ( List<<a href="#type_SourceEdit">SourceEdit</a>> )</
i></b></dt><dd> |
| 1823 | 1833 |
| 1824 <p> | 1834 <p> |
| 1825 The offset of the text to be remove from the file | 1835 The edits to be applied to the file. |
| 1826 content overlay. | |
| 1827 </p> | |
| 1828 </dd><dt class="field"><b><i>length ( int )</i></b></dt><dd> | |
| 1829 | |
| 1830 <p> | |
| 1831 The length of the text to be removed from the file | |
| 1832 content overlay, or 0 if no text should be removed. | |
| 1833 </p> | |
| 1834 </dd><dt class="field"><b><i>replacement ( String )</i></b></dt><dd> | |
| 1835 | |
| 1836 <p> | |
| 1837 The new text which should be inserted in place of the | |
| 1838 removed text. | |
| 1839 </p> | 1836 </p> |
| 1840 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionId">
CompletionId: String</a></dt><dd> | 1837 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionId">
CompletionId: String</a></dt><dd> |
| 1841 | 1838 |
| 1842 <p> | 1839 <p> |
| 1843 An identifier used to associate completion results with a | 1840 An identifier used to associate completion results with a |
| 1844 completion request. | 1841 completion request. |
| 1845 </p> | 1842 </p> |
| 1846 </dd><dt class="typeDefinition"><a name="type_CompletionRelevance">Complet
ionRelevance: String</a></dt><dd> | 1843 </dd><dt class="typeDefinition"><a name="type_CompletionRelevance">Complet
ionRelevance: String</a></dt><dd> |
| 1847 <p> | 1844 <p> |
| 1848 An enumeration of the relevance of a completion | 1845 An enumeration of the relevance of a completion |
| (...skipping 1123 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2972 <p> | 2969 <p> |
| 2973 This section contains a list of all of the errors that are | 2970 This section contains a list of all of the errors that are |
| 2974 produced by the server and the data that is returned with each. | 2971 produced by the server and the data that is returned with each. |
| 2975 </p> | 2972 </p> |
| 2976 <p> | 2973 <p> |
| 2977 TBD | 2974 TBD |
| 2978 </p> | 2975 </p> |
| 2979 | 2976 |
| 2980 | 2977 |
| 2981 </body></html> | 2978 </body></html> |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 461283002:
Improve spec style and minor changes (Closed)
Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart