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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 449213002: Rework "analysis.updateContent" analysis server request. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 6 years, 4 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
« pkg/analysis_server/lib/src/domain_analysis.dart ('K') | « pkg/analysis_server/tool/spec/codegen_matchers.dart ('k') | pkg/analysis_server/tool/spec/to_html.dart » ('j') | 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 464 matching lines...) Expand 10 before | Expand all | Expand 10 after
475 filesystem. The files whose content is overridden are 475 filesystem. The files whose content is overridden are
476 therefore seen by server as being files with the given 476 therefore seen by server as being files with the given
477 content, even if the files do not exist on the filesystem or 477 content, even if the files do not exist on the filesystem or
478 if the file path represents the path to a directory on the 478 if the file path represents the path to a directory on the
479 filesystem. 479 filesystem.
480 </p> 480 </p>
481 <params> 481 <params>
482 <field name="files"> 482 <field name="files">
483 <map> 483 <map>
484 <key><ref>FilePath</ref></key> 484 <key><ref>FilePath</ref></key>
485 <value><ref>ContentChange</ref></value> 485 <value><ref>object</ref></value>
486 </map> 486 </map>
487 <p> 487 <p>
488 A table mapping the files whose content has changed to 488 A table mapping the files whose content has changed to a
489 a description of the content. 489 description of the content change. Each value should be
490 one of the following types: <a
491 href="#type_AddContentOverlay">AddContentOverlay</a>, <a
492 href="#type_ChangeContentOverlay">ChangeContentOverlay</a>,
493 or <a
494 href="#type_RemoveContentOverlay">RemoveContentOverlay</a>.
490 </p> 495 </p>
491 </field> 496 </field>
492 </params> 497 </params>
493 </request> 498 </request>
494 <request method="updateOptions"> 499 <request method="updateOptions">
495 <p> 500 <p>
496 Update the options controlling analysis based on the given 501 Update the options controlling analysis based on the given
497 set of options. Any options that are not included in the 502 set of options. Any options that are not included in the
498 analysis options will not be changed. If there are options 503 analysis options will not be changed. If there are options
499 in the analysis options that are not valid an error will be 504 in the analysis options that are not valid an error will be
(...skipping 892 matching lines...) Expand 10 before | Expand all | Expand 10 after
1392 </field> 1397 </field>
1393 </params> 1398 </params>
1394 </notification> 1399 </notification>
1395 </domain> 1400 </domain>
1396 <types> 1401 <types>
1397 <h2><a name="types">Types</a></h2> 1402 <h2><a name="types">Types</a></h2>
1398 <p> 1403 <p>
1399 This section contains descriptions of the data types referenced 1404 This section contains descriptions of the data types referenced
1400 in the API’s of the various domains. 1405 in the API’s of the various domains.
1401 </p> 1406 </p>
1407 <type name="AddContentOverlay">
1408 <p>
1409 A directive to begin overlaying the contents of a file. The
1410 supplied content will be used for analysis in place of the
1411 file contents in the filesystem.
1412 </p>
1413 <p>
1414 If this directive is used on a file that already has a file
1415 content overlay, the old overlay is discarded and replaced
1416 with the new one.
1417 </p>
1418 <object>
1419 <field name="type" value="add"><ref>String</ref></field>
1420 <field name="content">
1421 <ref>String</ref>
1422 <p>
1423 The new content of the file.
1424 </p>
1425 </field>
1426 </object>
1427 </type>
1402 <type name="AnalysisError"> 1428 <type name="AnalysisError">
1403 <p> 1429 <p>
1404 An indication of an error, warning, or hint that was produced 1430 An indication of an error, warning, or hint that was produced
1405 by the analysis. 1431 by the analysis.
1406 </p> 1432 </p>
1407 <object> 1433 <object>
1408 <field name="severity"> 1434 <field name="severity">
1409 <ref>ErrorSeverity</ref> 1435 <ref>ErrorSeverity</ref>
1410 <p> 1436 <p>
1411 The severity of the error. 1437 The severity of the error.
(...skipping 116 matching lines...) Expand 10 before | Expand all | Expand 10 after
1528 </field> 1554 </field>
1529 <field name="analysisTarget" optional="true"> 1555 <field name="analysisTarget" optional="true">
1530 <ref>String</ref> 1556 <ref>String</ref>
1531 <p> 1557 <p>
1532 The name of the current target of analysis. This field is 1558 The name of the current target of analysis. This field is
1533 omitted if analyzing is false. 1559 omitted if analyzing is false.
1534 </p> 1560 </p>
1535 </field> 1561 </field>
1536 </object> 1562 </object>
1537 </type> 1563 </type>
1564 <type name="ChangeContentOverlay">
1565 <p>
1566 A directive to modify an existing file content overlay. A
1567 range of text is deleted from the old file content overlay
1568 and replaced with new text.
1569 </p>
1570 <p>
1571 It is an error to use this directive is used on a file that
1572 does not yet have a file content overlay (or that has had
1573 its overlay removed via <a
1574 href="#type_RemoveContentOverlay">RemoveContentOverlay</a>).
1575 </p>
1576 <object>
1577 <field name="type" value="change"><ref>String</ref></field>
1578 <field name="offset">
1579 <ref>int</ref>
1580 <p>
1581 The offset of the text to be remove from the file
1582 content overlay.
1583 </p>
1584 </field>
1585 <field name="oldLength">
Brian Wilkerson 2014/08/07 22:15:22 "oldLength" --> "length"
Paul Berry 2014/08/07 23:58:09 Done.
1586 <ref>int</ref>
1587 <p>
1588 The length of the text to be removed from the file
1589 content overlay, or 0 if no text should be removed.
1590 </p>
1591 </field>
1592 <field name="replacement">
1593 <ref>String</ref>
1594 <p>
1595 The new text which should be inserted in place of the
1596 removed text.
1597 </p>
1598 </field>
1599 </object>
1600 </type>
1538 <type name="CompletionId"> 1601 <type name="CompletionId">
1539 <ref>String</ref> 1602 <ref>String</ref>
1540 <p> 1603 <p>
1541 An identifier used to associate completion results with a 1604 An identifier used to associate completion results with a
1542 completion request. 1605 completion request.
1543 </p> 1606 </p>
1544 </type> 1607 </type>
1545 <type name="CompletionRelevance"> 1608 <type name="CompletionRelevance">
1546 <p> 1609 <p>
1547 An enumeration of the relevance of a completion 1610 An enumeration of the relevance of a completion
(...skipping 162 matching lines...) Expand 10 before | Expand all | Expand 10 after
1710 <value><code>METHOD</code></value> 1773 <value><code>METHOD</code></value>
1711 <value><code>METHOD_NAME</code></value> 1774 <value><code>METHOD_NAME</code></value>
1712 <value><code>NAMED_ARGUMENT</code></value> 1775 <value><code>NAMED_ARGUMENT</code></value>
1713 <value><code>OPTIONAL_ARGUMENT</code></value> 1776 <value><code>OPTIONAL_ARGUMENT</code></value>
1714 <value><code>PARAMETER</code></value> 1777 <value><code>PARAMETER</code></value>
1715 <value><code>SETTER</code></value> 1778 <value><code>SETTER</code></value>
1716 <value><code>TOP_LEVEL_VARIABLE</code></value> 1779 <value><code>TOP_LEVEL_VARIABLE</code></value>
1717 <value><code>TYPE_PARAMETER</code></value> 1780 <value><code>TYPE_PARAMETER</code></value>
1718 </enum> 1781 </enum>
1719 </type> 1782 </type>
1720 <type name="ContentChange">
1721 <p>
1722 A description of the change to the content of a file. The
1723 optional fields are omitted if there is no single range of
1724 characters that was modified. If any of the optional fields
1725 are provided then all of the optional fields must be provided.
1726 </p>
1727 <object>
1728 <field name="content">
1729 <ref>String</ref>
1730 <p>
1731 The new content of the file, or null if the content of the
1732 file should be read from disk.
1733 </p>
1734 </field>
1735 <field name="offset" optional="true">
1736 <ref>int</ref>
1737 <p>
1738 The offset of the region that was modified.
1739 </p>
1740 </field>
1741 <field name="oldLength" optional="true">
1742 <ref>int</ref>
1743 <p>
1744 The length of the region that was removed.
1745 </p>
1746 </field>
1747 <field name="newLength" optional="true">
1748 <ref>int</ref>
1749 <p>
1750 The length of the region that was added.
1751 </p>
1752 </field>
1753 </object>
1754 </type>
1755 <type name="DebugContextId"> 1783 <type name="DebugContextId">
1756 <ref>String</ref> 1784 <ref>String</ref>
1757 <p> 1785 <p>
1758 The identifier for a debug context. 1786 The identifier for a debug context.
1759 </p> 1787 </p>
1760 </type> 1788 </type>
1761 <type name="DebugService"> 1789 <type name="DebugService">
1762 <p> 1790 <p>
1763 An enumeration of the services provided by the debug 1791 An enumeration of the services provided by the debug
1764 domain. 1792 domain.
(...skipping 725 matching lines...) Expand 10 before | Expand all | Expand 10 after
2490 An enumeration of the severities of problems that can be 2518 An enumeration of the severities of problems that can be
2491 returned by the refactoring requests. 2519 returned by the refactoring requests.
2492 </p> 2520 </p>
2493 <enum> 2521 <enum>
2494 <value><code>INFO</code></value> 2522 <value><code>INFO</code></value>
2495 <value><code>WARNING</code></value> 2523 <value><code>WARNING</code></value>
2496 <value><code>ERROR</code></value> 2524 <value><code>ERROR</code></value>
2497 <value><code>FATAL</code></value> 2525 <value><code>FATAL</code></value>
2498 </enum> 2526 </enum>
2499 </type> 2527 </type>
2528 <type name="RemoveContentOverlay">
2529 <p>
2530 A directive to remove an existing file content overlay.
2531 After processing this directive, the file contents will once
2532 again be read from the file system.
2533 </p>
2534 <p>
2535 If this directive is used on a file that doesn't currently
2536 have a content overlay, it has no effect.
2537 </p>
2538 <object>
2539 <field name="type" value="remove"><ref>String</ref></field>
2540 </object>
2541 </type>
2500 <type name="SearchId"> 2542 <type name="SearchId">
2501 <ref>String</ref> 2543 <ref>String</ref>
2502 <p> 2544 <p>
2503 An identifier used to associate search results with a search 2545 An identifier used to associate search results with a search
2504 request. 2546 request.
2505 </p> 2547 </p>
2506 </type> 2548 </type>
2507 <type name="SearchResult"> 2549 <type name="SearchResult">
2508 <p> 2550 <p>
2509 A single result from a search request. 2551 A single result from a search request.
(...skipping 507 matching lines...) Expand 10 before | Expand all | Expand 10 after
3017 <h2>Errors</h2> 3059 <h2>Errors</h2>
3018 <p> 3060 <p>
3019 This section contains a list of all of the errors that are 3061 This section contains a list of all of the errors that are
3020 produced by the server and the data that is returned with each. 3062 produced by the server and the data that is returned with each.
3021 </p> 3063 </p>
3022 <p> 3064 <p>
3023 TBD 3065 TBD
3024 </p> 3066 </p>
3025 </body> 3067 </body>
3026 </html> 3068 </html>
OLDNEW
« pkg/analysis_server/lib/src/domain_analysis.dart ('K') | « pkg/analysis_server/tool/spec/codegen_matchers.dart ('k') | pkg/analysis_server/tool/spec/to_html.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698