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

Side by Side Diff: pkg/analysis_server/tool/spec/spec_input.html

Issue 547753002: Rename debug domain to execution (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 6 years, 3 months 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 | « pkg/analysis_server/test/integration/protocol_matchers.dart ('k') | no next file » | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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 96 matching lines...) Expand 10 before | Expand all | Expand 10 after
107 <p> 107 <p>
108 For convenience, the API is divided into domains. Each domain is 108 For convenience, the API is divided into domains. Each domain is
109 specified in a separate section below: 109 specified in a separate section below:
110 </p> 110 </p>
111 <ul> 111 <ul>
112 <li><a href="#domain_server">Server</a></li> 112 <li><a href="#domain_server">Server</a></li>
113 <li><a href="#domain_analysis">Analysis</a></li> 113 <li><a href="#domain_analysis">Analysis</a></li>
114 <li><a href="#domain_completion">Code Completion</a></li> 114 <li><a href="#domain_completion">Code Completion</a></li>
115 <li><a href="#domain_search">Search</a></li> 115 <li><a href="#domain_search">Search</a></li>
116 <li><a href="#domain_edit">Edit</a></li> 116 <li><a href="#domain_edit">Edit</a></li>
117 <li><a href="#domain_debug">Debugging</a></li> 117 <li><a href="#domain_execution">Execution</a></li>
118 </ul> 118 </ul>
119 <p> 119 <p>
120 The specifications of the API’s refer to data structures beyond 120 The specifications of the API’s refer to data structures beyond
121 the standard JSON primitives. These data structures are 121 the standard JSON primitives. These data structures are
122 documented in the section titled <a href="#types">Types</a>. 122 documented in the section titled <a href="#types">Types</a>.
123 </p> 123 </p>
124 <h3>Command-line Arguments</h3> 124 <h3>Command-line Arguments</h3>
125 <p> 125 <p>
126 The command-line arguments that can be passed to the server. 126 The command-line arguments that can be passed to the server.
127 </p> 127 </p>
(...skipping 144 matching lines...) Expand 10 before | Expand all | Expand 10 after
272 asynchronously apply updated error information. Clients that 272 asynchronously apply updated error information. Clients that
273 <b>can</b> apply error information as it becomes available 273 <b>can</b> apply error information as it becomes available
274 should use the information provided by the 'analysis.errors' 274 should use the information provided by the 'analysis.errors'
275 notification. 275 notification.
276 </p> 276 </p>
277 <p> 277 <p>
278 If a request is made for a file which does not exist, or 278 If a request is made for a file which does not exist, or
279 which is not currently subject to analysis (e.g. because it 279 which is not currently subject to analysis (e.g. because it
280 is not associated with any analysis root specified to 280 is not associated with any analysis root specified to
281 analysis.setAnalysisRoots), an error of type 281 analysis.setAnalysisRoots), an error of type
282 GET_ERRORS_INVALID_FILE will be generated. 282 <tt>GET_ERRORS_INVALID_FILE</tt> will be generated.
283 </p> 283 </p>
284 <params> 284 <params>
285 <field name="file"> 285 <field name="file">
286 <ref>FilePath</ref> 286 <ref>FilePath</ref>
287 <p> 287 <p>
288 The file for which errors are being requested. 288 The file for which errors are being requested.
289 </p> 289 </p>
290 </field> 290 </field>
291 </params> 291 </params>
292 <result> 292 <result>
(...skipping 865 matching lines...) Expand 10 before | Expand all | Expand 10 after
1158 <p> 1158 <p>
1159 The offset used to select the errors for which fixes 1159 The offset used to select the errors for which fixes
1160 will be returned. 1160 will be returned.
1161 </p> 1161 </p>
1162 </field> 1162 </field>
1163 </params> 1163 </params>
1164 <result> 1164 <result>
1165 <field name="fixes"> 1165 <field name="fixes">
1166 <list><ref>AnalysisErrorFixes</ref></list> 1166 <list><ref>AnalysisErrorFixes</ref></list>
1167 <p> 1167 <p>
1168 The fixes that are available for each of the analysis 1168 The fixes that are available for the errors at the given offset.
1169 errors. There is a one-to-one correspondence between the
1170 analysis errors in the request and the lists of changes
1171 in the response. In particular, it is always the case
1172 that errors.length == fixes.length and that fixes[i] is
1173 the list of fixes for the error in errors[i]. The list
1174 of changes corresponding to an error can be empty if
1175 there are no fixes available for that error.
1176 </p> 1169 </p>
1177 </field> 1170 </field>
1178 </result> 1171 </result>
1179 </request> 1172 </request>
1180 <request method="getRefactoring"> 1173 <request method="getRefactoring">
1181 <p> 1174 <p>
1182 Get the changes required to perform a refactoring. 1175 Get the changes required to perform a refactoring.
1183 </p> 1176 </p>
1184 <params> 1177 <params>
1185 <field name="kind"> 1178 <field name="kind">
(...skipping 80 matching lines...) Expand 10 before | Expand all | Expand 10 after
1266 for the server to be able to determine whether or not the code 1259 for the server to be able to determine whether or not the code
1267 needs to be modified, such as when a member is being renamed and 1260 needs to be modified, such as when a member is being renamed and
1268 there is a reference to a member from an unknown type. This field 1261 there is a reference to a member from an unknown type. This field
1269 will be omitted if the change field is omitted or if there are no 1262 will be omitted if the change field is omitted or if there are no
1270 potential edits for the refactoring. 1263 potential edits for the refactoring.
1271 </p> 1264 </p>
1272 </field> 1265 </field>
1273 </result> 1266 </result>
1274 </request> 1267 </request>
1275 </domain> 1268 </domain>
1276 <domain name="debug"> 1269 <domain name="execution">
1277 <p> 1270 <p>
1278 The debugging domain contains commands related to providing a 1271 The execution domain contains commands related to providing an execution
1279 debugging experience. 1272 or debugging experience.
1280 </p> 1273 </p>
1281 <request method="createContext"> 1274 <request method="createContext">
1282 <p> 1275 <p>
1283 Create a debugging context for the executable file with the 1276 Create an execution context for the executable file with the given
1284 given path. The context that is created will persist until 1277 path. The context that is created will persist until
1285 debug.deleteContext is used to delete it. Clients, 1278 execution.deleteContext is used to delete it. Clients, therefore, are
1286 therefore, are responsible for managing the lifetime of 1279 responsible for managing the lifetime of execution contexts.
1287 debugging contexts.
1288 </p> 1280 </p>
1289 <params> 1281 <params>
1290 <field name="contextRoot"> 1282 <field name="contextRoot">
1291 <ref>FilePath</ref> 1283 <ref>FilePath</ref>
1292 <p> 1284 <p>
1293 The path of the Dart or HTML file that will be launched. 1285 The path of the Dart or HTML file that will be launched.
1294 </p> 1286 </p>
1295 </field> 1287 </field>
1296 </params> 1288 </params>
1297 <result> 1289 <result>
1298 <field name="id"> 1290 <field name="id">
1299 <ref>DebugContextId</ref> 1291 <ref>ExecutionContextId</ref>
1300 <p> 1292 <p>
1301 The identifier used to refer to the debugging context 1293 The identifier used to refer to the execution context that was
1302 that was created. 1294 created.
1303 </p> 1295 </p>
1304 </field> 1296 </field>
1305 </result> 1297 </result>
1306 </request> 1298 </request>
1307 <request method="deleteContext"> 1299 <request method="deleteContext">
1308 <p> 1300 <p>
1309 Delete the debugging context with the given identifier. The 1301 Delete the execution context with the given identifier. The context id
1310 context id is no longer valid after this command. The server 1302 is no longer valid after this command. The server is allowed to re-use
1311 is allowed to re-use ids when they are no longer valid. 1303 ids when they are no longer valid.
1312 </p> 1304 </p>
1313 <params> 1305 <params>
1314 <field name="id"> 1306 <field name="id">
1315 <ref>DebugContextId</ref> 1307 <ref>ExecutionContextId</ref>
1316 <p> 1308 <p>
1317 The identifier of the debugging context that is to be 1309 The identifier of the execution context that is to be deleted.
1318 deleted.
1319 </p> 1310 </p>
1320 </field> 1311 </field>
1321 </params> 1312 </params>
1322 </request> 1313 </request>
1323 <request method="mapUri"> 1314 <request method="mapUri">
1324 <p> 1315 <p>
1325 Map a URI from the debugging context to the file that it 1316 Map a URI from the execution context to the file that it corresponds
1326 corresponds to, or map a file to the URI that it corresponds 1317 to, or map a file to the URI that it corresponds to in the execution
1327 to in the debugging context. 1318 context.
1328 </p> 1319 </p>
1329 <p> 1320 <p>
1330 Exactly one of the file and uri fields must be provided. 1321 Exactly one of the file and uri fields must be provided.
1331 </p> 1322 </p>
1332 <params> 1323 <params>
1333 <field name="id"> 1324 <field name="id">
1334 <ref>DebugContextId</ref> 1325 <ref>ExecutionContextId</ref>
1335 <p> 1326 <p>
1336 The identifier of the debugging context in which the URI 1327 The identifier of the execution context in which the URI is to be
1337 is to be mapped. 1328 mapped.
1338 </p> 1329 </p>
1339 </field> 1330 </field>
1340 <field name="file" optional="true"> 1331 <field name="file" optional="true">
1341 <ref>FilePath</ref> 1332 <ref>FilePath</ref>
1342 <p> 1333 <p>
1343 The path of the file to be mapped into a URI. 1334 The path of the file to be mapped into a URI.
1344 </p> 1335 </p>
1345 </field> 1336 </field>
1346 <field name="uri" optional="true"> 1337 <field name="uri" optional="true">
1347 <ref>String</ref> 1338 <ref>String</ref>
1348 <p> 1339 <p>
1349 The URI to be mapped into a file path. 1340 The URI to be mapped into a file path.
1350 </p> 1341 </p>
1351 </field> 1342 </field>
1352 </params> 1343 </params>
1353 <result> 1344 <result>
1354 <field name="file" optional="true"> 1345 <field name="file" optional="true">
1355 <ref>FilePath</ref> 1346 <ref>FilePath</ref>
1356 <p> 1347 <p>
1357 The file to which the URI was mapped. This field is 1348 The file to which the URI was mapped. This field is omitted if the
1358 omitted if the uri field was not given in the request. 1349 uri field was not given in the request.
1359 </p> 1350 </p>
1360 </field> 1351 </field>
1361 <field name="uri" optional="true"> 1352 <field name="uri" optional="true">
1362 <ref>String</ref> 1353 <ref>String</ref>
1363 <p> 1354 <p>
1364 The URI to which the file path was mapped. This field is 1355 The URI to which the file path was mapped. This field is omitted
1365 omitted if the file field was not given in the request. 1356 if the file field was not given in the request.
1366 </p> 1357 </p>
1367 </field> 1358 </field>
1368 </result> 1359 </result>
1369 </request> 1360 </request>
1370 <request method="setSubscriptions"> 1361 <request method="setSubscriptions">
1371 <p> 1362 <p>
1372 Subscribe for services. All previous subscriptions are 1363 Subscribe for services. All previous subscriptions are replaced by the
1373 replaced by the given set of services. 1364 given set of services.
1374 </p> 1365 </p>
1375 <p> 1366 <p>
1376 It is an error if any of the elements in the list are not 1367 It is an error if any of the elements in the list are not valid
1377 valid services. If there is an error, then the current 1368 services. If there is an error, then the current subscriptions will
1378 subscriptions will remain unchanged. 1369 remain unchanged.
1379 </p> 1370 </p>
1380 <params> 1371 <params>
1381 <field name="subscriptions"> 1372 <field name="subscriptions">
1382 <list><ref>DebugService</ref></list> 1373 <list><ref>ExecutionService</ref></list>
1383 <p> 1374 <p>
1384 A list of the services being subscribed to. 1375 A list of the services being subscribed to.
1385 </p> 1376 </p>
1386 </field> 1377 </field>
1387 </params> 1378 </params>
1388 </request> 1379 </request>
1389 <notification event="launchData"> 1380 <notification event="launchData">
1390 <p> 1381 <p>
1391 Reports information needed to allow applications within the 1382 Reports information needed to allow applications within the given
1392 given context to be launched. 1383 context to be launched.
1393 </p> 1384 </p>
1394 <p> 1385 <p>
1395 This notification is not subscribed to by default. Clients 1386 This notification is not subscribed to by default. Clients can
1396 can subscribe by including the value "LAUNCH_DATA" in the 1387 subscribe by including the value "LAUNCH_DATA" in the list of services
1397 list of services passed in a debug.setSubscriptions request. 1388 passed in a execution.setSubscriptions request.
1398 </p> 1389 </p>
1399 <params> 1390 <params>
1400 <field name="executables"> 1391 <field name="executables">
1401 <list><ref>ExecutableFile</ref></list> 1392 <list><ref>ExecutableFile</ref></list>
1402 <p> 1393 <p>
1403 A list of the files that are executable in the given 1394 A list of the files that are executable in the given context. This
1404 context. This list replaces any previous list provided 1395 list replaces any previous list provided for the given context.
1405 for the given context.
1406 </p> 1396 </p>
1407 </field> 1397 </field>
1408 <field name="dartToHtml"> 1398 <field name="dartToHtml">
1409 <map> 1399 <map>
1410 <key><ref>FilePath</ref></key> 1400 <key><ref>FilePath</ref></key>
1411 <value> 1401 <value>
1412 <list><ref>FilePath</ref></list> 1402 <list><ref>FilePath</ref></list>
1413 </value> 1403 </value>
1414 </map> 1404 </map>
1415 <p> 1405 <p>
1416 A mapping from the paths of Dart files that are 1406 A mapping from the paths of Dart files that are referenced by HTML
1417 referenced by HTML files to a list of the HTML files 1407 files to a list of the HTML files that reference the Dart files.
1418 that reference the Dart files.
1419 </p> 1408 </p>
1420 </field> 1409 </field>
1421 <field name="htmlToDart"> 1410 <field name="htmlToDart">
1422 <map> 1411 <map>
1423 <key><ref>FilePath</ref></key> 1412 <key><ref>FilePath</ref></key>
1424 <value> 1413 <value>
1425 <list><ref>FilePath</ref></list> 1414 <list><ref>FilePath</ref></list>
1426 </value> 1415 </value>
1427 </map> 1416 </map>
1428 <p> 1417 <p>
1429 A mapping from the paths of HTML files that reference 1418 A mapping from the paths of HTML files that reference Dart files
1430 Dart files to a list of the Dart files they reference. 1419 to a list of the Dart files they reference.
1431 </p> 1420 </p>
1432 </field> 1421 </field>
1433 </params> 1422 </params>
1434 </notification> 1423 </notification>
1435 </domain> 1424 </domain>
1436 <types> 1425 <types>
1437 <h2><a name="types">Types</a></h2> 1426 <h2><a name="types">Types</a></h2>
1438 <p> 1427 <p>
1439 This section contains descriptions of the data types referenced 1428 This section contains descriptions of the data types referenced
1440 in the API’s of the various domains. 1429 in the API’s of the various domains.
(...skipping 383 matching lines...) Expand 10 before | Expand all | Expand 10 after
1824 <value><code>METHOD</code></value> 1813 <value><code>METHOD</code></value>
1825 <value><code>METHOD_NAME</code></value> 1814 <value><code>METHOD_NAME</code></value>
1826 <value><code>NAMED_ARGUMENT</code></value> 1815 <value><code>NAMED_ARGUMENT</code></value>
1827 <value><code>OPTIONAL_ARGUMENT</code></value> 1816 <value><code>OPTIONAL_ARGUMENT</code></value>
1828 <value><code>PARAMETER</code></value> 1817 <value><code>PARAMETER</code></value>
1829 <value><code>SETTER</code></value> 1818 <value><code>SETTER</code></value>
1830 <value><code>TOP_LEVEL_VARIABLE</code></value> 1819 <value><code>TOP_LEVEL_VARIABLE</code></value>
1831 <value><code>TYPE_PARAMETER</code></value> 1820 <value><code>TYPE_PARAMETER</code></value>
1832 </enum> 1821 </enum>
1833 </type> 1822 </type>
1834 <type name="DebugContextId">
1835 <ref>String</ref>
1836 <p>
1837 The identifier for a debug context.
1838 </p>
1839 </type>
1840 <type name="DebugService">
1841 <p>
1842 An enumeration of the services provided by the debug
1843 domain.
1844 </p>
1845 <enum>
1846 <value><code>LAUNCH_DATA</code></value>
1847 </enum>
1848 </type>
1849 <type name="Element"> 1823 <type name="Element">
1850 <p> 1824 <p>
1851 Information about an element (something that can be declared 1825 Information about an element (something that can be declared
1852 in code). 1826 in code).
1853 </p> 1827 </p>
1854 <object> 1828 <object>
1855 <field name="kind"> 1829 <field name="kind">
1856 <ref>ElementKind</ref> 1830 <ref>ElementKind</ref>
1857 <p> 1831 <p>
1858 The kind of the element. 1832 The kind of the element.
(...skipping 94 matching lines...) Expand 10 before | Expand all | Expand 10 after
1953 <type name="ExecutableKind"> 1927 <type name="ExecutableKind">
1954 <p> 1928 <p>
1955 An enumeration of the kinds of executable files. 1929 An enumeration of the kinds of executable files.
1956 </p> 1930 </p>
1957 <enum> 1931 <enum>
1958 <value><code>CLIENT</code></value> 1932 <value><code>CLIENT</code></value>
1959 <value><code>EITHER</code></value> 1933 <value><code>EITHER</code></value>
1960 <value><code>SERVER</code></value> 1934 <value><code>SERVER</code></value>
1961 </enum> 1935 </enum>
1962 </type> 1936 </type>
1937 <type name="ExecutionContextId">
1938 <ref>String</ref>
1939 <p>
1940 The identifier for a execution context.
1941 </p>
1942 </type>
1943 <type name="ExecutionService">
1944 <p>
1945 An enumeration of the services provided by the execution
1946 domain.
1947 </p>
1948 <enum>
1949 <value><code>LAUNCH_DATA</code></value>
1950 </enum>
1951 </type>
1963 <type name="FilePath"> 1952 <type name="FilePath">
1964 <ref>String</ref> 1953 <ref>String</ref>
1965 <p> 1954 <p>
1966 The absolute path of a file. 1955 The absolute path of a file.
1967 </p> 1956 </p>
1968 </type> 1957 </type>
1969 <type name="FoldingKind"> 1958 <type name="FoldingKind">
1970 <p> 1959 <p>
1971 An enumeration of the kinds of folding regions. 1960 An enumeration of the kinds of folding regions.
1972 </p> 1961 </p>
(...skipping 1137 matching lines...) Expand 10 before | Expand all | Expand 10 after
3110 <field name="name"> 3099 <field name="name">
3111 <ref>String</ref> 3100 <ref>String</ref>
3112 <p> 3101 <p>
3113 The name that the method should be given. 3102 The name that the method should be given.
3114 </p> 3103 </p>
3115 </field> 3104 </field>
3116 <field name="parameters"> 3105 <field name="parameters">
3117 <list><ref>RefactoringMethodParameter</ref></list> 3106 <list><ref>RefactoringMethodParameter</ref></list>
3118 <p> 3107 <p>
3119 The parameters that should be defined for the method. 3108 The parameters that should be defined for the method.
3120 <p>
3121 It is an error if a REQUIRED or NAMED parameter follows a
3122 POSITIONAL parameter.
3123 It is an error if a REQUIRED or POSITIONAL parameter follows a
3124 NAMED parameter.
3125 </p>
3126 <ul>
3127 <li>
3128 To change the order and/or update proposed paramerers, add
3129 parameters with the same identifiers as proposed.
3130 </li>
3131 <li>To add new parameters, omit their identifier.</li>
3132 <li>To remove some parameters, omit them in this list.</li>
3133 </ul>
3134 </p> 3109 </p>
3110 <p>
3111 It is an error if a REQUIRED or NAMED parameter follows a
3112 POSITIONAL parameter.
3113 It is an error if a REQUIRED or POSITIONAL parameter follows a
3114 NAMED parameter.
3115 </p>
3116 <ul>
3117 <li>
3118 To change the order and/or update proposed paramerers, add
3119 parameters with the same identifiers as proposed.
3120 </li>
3121 <li>To add new parameters, omit their identifier.</li>
3122 <li>To remove some parameters, omit them in this list.</li>
3123 </ul>
3135 </field> 3124 </field>
3136 <field name="extractAll"> 3125 <field name="extractAll">
3137 <ref>bool</ref> 3126 <ref>bool</ref>
3138 <p> 3127 <p>
3139 True if all occurrences of the expression or statements 3128 True if all occurrences of the expression or statements
3140 should be replaced by an invocation of the method. The 3129 should be replaced by an invocation of the method. The
3141 expression or statements used to initiate the 3130 expression or statements used to initiate the
3142 refactoring will always be replaced. 3131 refactoring will always be replaced.
3143 </p> 3132 </p>
3144 </field> 3133 </field>
(...skipping 91 matching lines...) Expand 10 before | Expand all | Expand 10 after
3236 <h2>Errors</h2> 3225 <h2>Errors</h2>
3237 <p> 3226 <p>
3238 This section contains a list of all of the errors that are 3227 This section contains a list of all of the errors that are
3239 produced by the server and the data that is returned with each. 3228 produced by the server and the data that is returned with each.
3240 </p> 3229 </p>
3241 <p> 3230 <p>
3242 TBD 3231 TBD
3243 </p> 3232 </p>
3244 </body> 3233 </body>
3245 </html> 3234 </html>
OLDNEW
« no previous file with comments | « pkg/analysis_server/test/integration/protocol_matchers.dart ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698