| OLD | NEW |
|---|
| 1 | 1 |
| 2 <html> | 2 <html> |
| 3 <head> | 3 <head> |
| 4 <meta charset="UTF-8"/> | 4 <meta charset="UTF-8"/> |
| 5 <title>Analysis Server API Specification</title> | 5 <title>Analysis Server API Specification</title> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <h1>Analysis Server API Specification</h1> | 8 <h1>Analysis Server API Specification</h1> |
| 9 <h1 style="color:#999999">Version <version>1.0.0</version></h1> | 9 <h1 style="color:#999999">Version <version>1.1.0</version></h1> |
| 10 <p> | 10 <p> |
| 11 This document contains a specification of the API provided by the | 11 This document contains a specification of the API provided by the |
| 12 analysis server. The API in this document is currently under | 12 analysis server. The API in this document is currently under |
| 13 development. Changes to the API will be accompanied by an update to the | 13 development. Changes to the API will be accompanied by an update to the |
| 14 protocol version number according to the principles of semantic | 14 protocol version number according to the principles of semantic |
| 15 versioning <a href="http://semver.org/">http://semver.org/</a>. | 15 versioning <a href="http://semver.org/">http://semver.org/</a>. |
| 16 </p> | 16 </p> |
| 17 <h2>Overview</h2> | 17 <h2>Overview</h2> |
| 18 <p> | 18 <p> |
| 19 The analysis server API is a bi-directional client-server | 19 The analysis server API is a bi-directional client-server |
| (...skipping 441 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 461 <list><ref>NavigationRegion</ref></list> | 461 <list><ref>NavigationRegion</ref></list> |
| 462 <p> | 462 <p> |
| 463 A list of the navigation regions within the requested region of | 463 A list of the navigation regions within the requested region of |
| 464 the file. | 464 the file. |
| 465 </p> | 465 </p> |
| 466 </field> | 466 </field> |
| 467 </result> | 467 </result> |
| 468 </request> | 468 </request> |
| 469 <request method="reanalyze"> | 469 <request method="reanalyze"> |
| 470 <p> | 470 <p> |
| 471 Force the re-analysis of everything contained in the | 471 Force the re-analysis of everything contained in the specified |
| 472 existing analysis roots. This will cause all previously | 472 analysis roots. This will cause all previously computed analysis |
| 473 computed analysis results to be discarded and recomputed, | 473 results to be discarded and recomputed, and will cause all subscribed |
| 474 and will cause all subscribed notifications to be re-sent. | 474 notifications to be re-sent. |
| 475 </p> | 475 </p> |
| 476 <p> |
| 477 If no analysis roots are provided, then all current analysis roots |
| 478 will be re-analyzed. If an empty list of analysis roots is provided, |
| 479 then nothing will be re-analyzed. If the list contains one or more |
| 480 paths that are not currently analysis roots, then an error of type |
| 481 <tt>INVALID_ANALYSIS_ROOT</tt> will be generated. |
| 482 </p> |
| 483 <params> |
| 484 <field name="roots" optional="true"> |
| 485 <list><ref>FilePath</ref></list> |
| 486 <p> |
| 487 A list of the analysis roots that are to be re-analyzed. |
| 488 </p> |
| 489 </field> |
| 490 </params> |
| 476 </request> | 491 </request> |
| 477 <request method="setAnalysisRoots"> | 492 <request method="setAnalysisRoots"> |
| 478 <p> | 493 <p> |
| 479 Sets the root paths used to determine which files to | 494 Sets the root paths used to determine which files to |
| 480 analyze. The set of files to be analyzed are all of the | 495 analyze. The set of files to be analyzed are all of the |
| 481 files in one of the root paths that are not also in one of | 496 files in one of the root paths that are not also in one of |
| 482 the excluded paths. | 497 the excluded paths. |
| 483 </p> | 498 </p> |
| 484 <p> | 499 <p> |
| 485 Note that this request determines the set of requested | 500 Note that this request determines the set of requested |
| (...skipping 789 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1275 <p> | 1290 <p> |
| 1276 The edit domain contains commands related to edits that can be | 1291 The edit domain contains commands related to edits that can be |
| 1277 applied to the code. | 1292 applied to the code. |
| 1278 </p> | 1293 </p> |
| 1279 <request method="format"> | 1294 <request method="format"> |
| 1280 <p> | 1295 <p> |
| 1281 Format the contents of a single file. The currently selected region of | 1296 Format the contents of a single file. The currently selected region of |
| 1282 text is passed in so that the selection can be preserved across the | 1297 text is passed in so that the selection can be preserved across the |
| 1283 formatting operation. The updated selection will be as close to | 1298 formatting operation. The updated selection will be as close to |
| 1284 matching the original as possible, but whitespace at the beginning or | 1299 matching the original as possible, but whitespace at the beginning or |
| 1285 end of the selected region will be ignored. | 1300 end of the selected region will be ignored. If preserving selection |
| 1301 information is not required, zero (0) can be specified for both the |
| 1302 selection offset and selection length. |
| 1286 </p> | 1303 </p> |
| 1287 <p> | 1304 <p> |
| 1288 If a request is made for a file which does not exist, or | 1305 If a request is made for a file which does not exist, or |
| 1289 which is not currently subject to analysis (e.g. because it | 1306 which is not currently subject to analysis (e.g. because it |
| 1290 is not associated with any analysis root specified to | 1307 is not associated with any analysis root specified to |
| 1291 analysis.setAnalysisRoots), an error of type | 1308 analysis.setAnalysisRoots), an error of type |
| 1292 <tt>FORMAT_INVALID_FILE</tt> will be generated. | 1309 <tt>FORMAT_INVALID_FILE</tt> will be generated. |
| 1293 </p> | 1310 </p> |
| 1294 <params> | 1311 <params> |
| 1295 <field name="file"> | 1312 <field name="file"> |
| 1296 <ref>FilePath</ref> | 1313 <ref>FilePath</ref> |
| 1297 <p> | 1314 <p> |
| 1298 The file containing the code to be formatted. | 1315 The file containing the code to be formatted. |
| 1299 </p> | 1316 </p> |
| 1300 </field> | 1317 </field> |
| 1301 <field name="selectionOffset"> | 1318 <field name="selectionOffset"> |
| 1302 <ref>int</ref> | 1319 <ref>int</ref> |
| 1303 <p> | 1320 <p> |
| 1304 The offset of the current selection in the file. In case | 1321 The offset of the current selection in the file. |
| 1305 preserving, selection information is not required, 0 can be | |
| 1306 specified for both selection offset and length. | |
| 1307 </p> | 1322 </p> |
| 1308 </field> | 1323 </field> |
| 1309 <field name="selectionLength"> | 1324 <field name="selectionLength"> |
| 1310 <ref>int</ref> | 1325 <ref>int</ref> |
| 1311 <p> | 1326 <p> |
| 1312 The length of the current selection in the file. In case | 1327 The length of the current selection in the file. |
| 1313 preserving, selection information is not required, 0 can be | |
| 1314 specified for both selection offset and length. | |
| 1315 </p> | 1328 </p> |
| 1316 </field> | 1329 </field> |
| 1317 <!-- | 1330 <!-- |
| 1318 <field name="selectionOnly" optional="true"> | 1331 <field name="selectionOnly" optional="true"> |
| 1319 <ref>bool</ref> | 1332 <ref>bool</ref> |
| 1320 <p> | 1333 <p> |
| 1321 True if the code to be formatted should be limited to the selected | 1334 True if the code to be formatted should be limited to the selected |
| 1322 text (or the smallest portion of text that encloses the selected | 1335 text (or the smallest portion of text that encloses the selected |
| 1323 text that can be formatted). | 1336 text that can be formatted). |
| 1324 </p> | 1337 </p> |
| (...skipping 2471 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3796 <h2>Errors</h2> | 3809 <h2>Errors</h2> |
| 3797 <p> | 3810 <p> |
| 3798 This section contains a list of all of the errors that are | 3811 This section contains a list of all of the errors that are |
| 3799 produced by the server and the data that is returned with each. | 3812 produced by the server and the data that is returned with each. |
| 3800 </p> | 3813 </p> |
| 3801 <p> | 3814 <p> |
| 3802 TBD | 3815 TBD |
| 3803 </p> | 3816 </p> |
| 3804 </body> | 3817 </body> |
| 3805 </html> | 3818 </html> |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 882643004:
Spec changes for issue 22254 (Closed)
Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart