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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: pkg/analysis_server/doc/api.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
« no previous file with comments | « no previous file | pkg/analysis_server/lib/src/analysis_server.dart » ('j') | pkg/analysis_server/lib/src/domain_analysis.dart » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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>h1 {
5 text-align: center; 5 text-align: center;
6 } 6 }
7 pre { 7 pre {
8 margin: 0px; 8 margin: 0px;
9 } 9 }
10 div.box { 10 div.box {
(...skipping 543 matching lines...) Expand 10 before | Expand all | Expand 10 after
554 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( Map&lt;<a h ref="#type_AnalysisService">AnalysisService</a>, List&lt;<a href="#type_FilePath ">FilePath</a>&gt;&gt; )</i></b></dt><dd> 554 <h4>Parameters</h4><dl><dt class="field"><b><i>subscriptions ( Map&lt;<a h ref="#type_AnalysisService">AnalysisService</a>, List&lt;<a href="#type_FilePath ">FilePath</a>&gt;&gt; )</i></b></dt><dd>
555 555
556 <p> 556 <p>
557 A table mapping services to a list of the files being 557 A table mapping services to a list of the files being
558 subscribed to the service. 558 subscribed to the service.
559 </p> 559 </p>
560 </dd></dl></dd><dt class="request">analysis.updateContent</dt><dd><div class="box"><pre>request: { 560 </dd></dl></dd><dt class="request">analysis.updateContent</dt><dd><div class="box"><pre>request: {
561 "id": String 561 "id": String
562 "method": "analysis.updateContent" 562 "method": "analysis.updateContent"
563 "params": { 563 "params": {
564 "<b>files</b>": Map&lt;<a href="#type_FilePath">FilePath</a>, <a href="#type _ContentChange">ContentChange</a>&gt; 564 "<b>files</b>": Map&lt;<a href="#type_FilePath">FilePath</a>, object&gt;
565 } 565 }
566 }</pre><br><pre>response: { 566 }</pre><br><pre>response: {
567 "id": String 567 "id": String
568 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 568 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a>
569 }</pre></div> 569 }</pre></div>
570 <p> 570 <p>
571 Update the content of one or more files. Files that were 571 Update the content of one or more files. Files that were
572 previously updated but not included in this update remain 572 previously updated but not included in this update remain
573 unchanged. This effectively represents an overlay of the 573 unchanged. This effectively represents an overlay of the
574 filesystem. The files whose content is overridden are 574 filesystem. The files whose content is overridden are
575 therefore seen by server as being files with the given 575 therefore seen by server as being files with the given
576 content, even if the files do not exist on the filesystem or 576 content, even if the files do not exist on the filesystem or
577 if the file path represents the path to a directory on the 577 if the file path represents the path to a directory on the
578 filesystem. 578 filesystem.
579 </p> 579 </p>
580 580
581 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( Map&lt;<a href="#ty pe_FilePath">FilePath</a>, <a href="#type_ContentChange">ContentChange</a>&gt; ) </i></b></dt><dd> 581 <h4>Parameters</h4><dl><dt class="field"><b><i>files ( Map&lt;<a href="#ty pe_FilePath">FilePath</a>, object&gt; )</i></b></dt><dd>
582 582
583 <p> 583 <p>
584 A table mapping the files whose content has changed to 584 A table mapping the files whose content has changed to a
585 a description of the content. 585 description of the content change. Each value should be
586 one of the following types: <a href="#type_AddContentOverlay">AddC ontentOverlay</a>, <a href="#type_ChangeContentOverlay">ChangeContentOverlay</a> ,
587 or <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>.
586 </p> 588 </p>
587 </dd></dl></dd><dt class="request">analysis.updateOptions</dt><dd><div class="box"><pre>request: { 589 </dd></dl></dd><dt class="request">analysis.updateOptions</dt><dd><div class="box"><pre>request: {
588 "id": String 590 "id": String
589 "method": "analysis.updateOptions" 591 "method": "analysis.updateOptions"
590 "params": { 592 "params": {
591 "<b>options</b>": <a href="#type_AnalysisOptions">AnalysisOptions</a> 593 "<b>options</b>": <a href="#type_AnalysisOptions">AnalysisOptions</a>
592 } 594 }
593 }</pre><br><pre>response: { 595 }</pre><br><pre>response: {
594 "id": String 596 "id": String
595 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a> 597 "error": <span style="color:#999999">optional</span> <a href="#type_Error">Err or</a>
(...skipping 1065 matching lines...) Expand 10 before | Expand all | Expand 10 after
1661 1663
1662 1664
1663 1665
1664 1666
1665 1667
1666 1668
1667 1669
1668 1670
1669 1671
1670 1672
1671 <dl><dt class="typeDefinition"><a name="type_AnalysisError">AnalysisError: o bject</a></dt><dd> 1673
1674
1675 <dl><dt class="typeDefinition"><a name="type_AddContentOverlay">AddContentOv erlay: object</a></dt><dd>
1676 <p>
1677 A directive to begin overlaying the contents of a file. The
1678 supplied content will be used for analysis in place of the
1679 file contents in the filesystem.
1680 </p>
1681 <p>
1682 If this directive is used on a file that already has a file
1683 content overlay, the old overlay is discarded and replaced
1684 with the new one.
1685 </p>
1686
1687 <dl><dt class="field"><b><i>type = "add"</i></b></dt><dd></dd><dt class="f ield"><b><i>content ( String )</i></b></dt><dd>
1688
1689 <p>
1690 The new content of the file.
1691 </p>
1692 </dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisError" >AnalysisError: object</a></dt><dd>
1672 <p> 1693 <p>
1673 An indication of an error, warning, or hint that was produced 1694 An indication of an error, warning, or hint that was produced
1674 by the analysis. 1695 by the analysis.
1675 </p> 1696 </p>
1676 1697
1677 <dl><dt class="field"><b><i>severity ( <a href="#type_ErrorSeverity">Error Severity</a> )</i></b></dt><dd> 1698 <dl><dt class="field"><b><i>severity ( <a href="#type_ErrorSeverity">Error Severity</a> )</i></b></dt><dd>
1678 1699
1679 <p> 1700 <p>
1680 The severity of the error. 1701 The severity of the error.
1681 </p> 1702 </p>
(...skipping 87 matching lines...) Expand 10 before | Expand all | Expand 10 after
1769 1790
1770 <dl><dt class="field"><b><i>analyzing ( bool )</i></b></dt><dd> 1791 <dl><dt class="field"><b><i>analyzing ( bool )</i></b></dt><dd>
1771 1792
1772 <p>True if analysis is currently being performed.</p> 1793 <p>True if analysis is currently being performed.</p>
1773 </dd><dt class="field"><b><i>analysisTarget ( <span style="color:#9999 99">optional</span> String )</i></b></dt><dd> 1794 </dd><dt class="field"><b><i>analysisTarget ( <span style="color:#9999 99">optional</span> String )</i></b></dt><dd>
1774 1795
1775 <p> 1796 <p>
1776 The name of the current target of analysis. This field is 1797 The name of the current target of analysis. This field is
1777 omitted if analyzing is false. 1798 omitted if analyzing is false.
1778 </p> 1799 </p>
1800 </dd></dl></dd><dt class="typeDefinition"><a name="type_ChangeContentO verlay">ChangeContentOverlay: object</a></dt><dd>
1801 <p>
1802 A directive to modify an existing file content overlay. A
1803 range of text is deleted from the old file content overlay
1804 and replaced with new text.
1805 </p>
1806 <p>
1807 It is an error to use this directive is used on a file that
1808 does not yet have a file content overlay (or that has had
1809 its overlay removed via <a href="#type_RemoveContentOverlay">RemoveCon tentOverlay</a>).
1810 </p>
1811
1812 <dl><dt class="field"><b><i>type = "change"</i></b></dt><dd></dd><dt class ="field"><b><i>offset ( int )</i></b></dt><dd>
1813
1814 <p>
1815 The offset of the text to be remove from the file
1816 content overlay.
1817 </p>
1818 </dd><dt class="field"><b><i>oldLength ( int )</i></b></dt><dd>
1819
1820 <p>
1821 The length of the text to be removed from the file
1822 content overlay, or 0 if no text should be removed.
1823 </p>
1824 </dd><dt class="field"><b><i>replacement ( String )</i></b></dt><dd>
1825
1826 <p>
1827 The new text which should be inserted in place of the
1828 removed text.
1829 </p>
1779 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionId"> CompletionId: String</a></dt><dd> 1830 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionId"> CompletionId: String</a></dt><dd>
1780 1831
1781 <p> 1832 <p>
1782 An identifier used to associate completion results with a 1833 An identifier used to associate completion results with a
1783 completion request. 1834 completion request.
1784 </p> 1835 </p>
1785 </dd><dt class="typeDefinition"><a name="type_CompletionRelevance">Complet ionRelevance: String</a></dt><dd> 1836 </dd><dt class="typeDefinition"><a name="type_CompletionRelevance">Complet ionRelevance: String</a></dt><dd>
1786 <p> 1837 <p>
1787 An enumeration of the relevance of a completion 1838 An enumeration of the relevance of a completion
1788 suggestion. 1839 suggestion.
(...skipping 116 matching lines...) Expand 10 before | Expand all | Expand 10 after
1905 <p> 1956 <p>
1906 The type of the options parameter being suggested. This 1957 The type of the options parameter being suggested. This
1907 field is omitted if the parameterName field is omitted. 1958 field is omitted if the parameterName field is omitted.
1908 </p> 1959 </p>
1909 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSugg estionKind">CompletionSuggestionKind: String</a></dt><dd> 1960 </dd></dl></dd><dt class="typeDefinition"><a name="type_CompletionSugg estionKind">CompletionSuggestionKind: String</a></dt><dd>
1910 <p> 1961 <p>
1911 An enumeration of the kinds of elements that can be included 1962 An enumeration of the kinds of elements that can be included
1912 in a completion suggestion. 1963 in a completion suggestion.
1913 </p> 1964 </p>
1914 1965
1915 <dl><dt class="value">ARGUMENT_LIST</dt><dt class="value">CLASS</dt><dt cl ass="value">CLASS_ALIAS</dt><dt class="value">CONSTRUCTOR</dt><dt class="value"> FIELD</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE_ALIAS</ dt><dt class="value">GETTER</dt><dt class="value">IMPORT</dt><dt class="value">L IBRARY_PREFIX</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="value">METHOD< /dt><dt class="value">METHOD_NAME</dt><dt class="value">NAMED_ARGUMENT</dt><dt c lass="value">OPTIONAL_ARGUMENT</dt><dt class="value">PARAMETER</dt><dt class="va lue">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="value">TYPE_ PARAMETER</dt></dl></dd><dt class="typeDefinition"><a name="type_ContentChange"> ContentChange: object</a></dt><dd> 1966 <dl><dt class="value">ARGUMENT_LIST</dt><dt class="value">CLASS</dt><dt cl ass="value">CLASS_ALIAS</dt><dt class="value">CONSTRUCTOR</dt><dt class="value"> FIELD</dt><dt class="value">FUNCTION</dt><dt class="value">FUNCTION_TYPE_ALIAS</ dt><dt class="value">GETTER</dt><dt class="value">IMPORT</dt><dt class="value">L IBRARY_PREFIX</dt><dt class="value">LOCAL_VARIABLE</dt><dt class="value">METHOD< /dt><dt class="value">METHOD_NAME</dt><dt class="value">NAMED_ARGUMENT</dt><dt c lass="value">OPTIONAL_ARGUMENT</dt><dt class="value">PARAMETER</dt><dt class="va lue">SETTER</dt><dt class="value">TOP_LEVEL_VARIABLE</dt><dt class="value">TYPE_ PARAMETER</dt></dl></dd><dt class="typeDefinition"><a name="type_DebugContextId" >DebugContextId: String</a></dt><dd>
1916 <p>
1917 A description of the change to the content of a file. The
1918 optional fields are omitted if there is no single range of
1919 characters that was modified. If any of the optional fields
1920 are provided then all of the optional fields must be provided.
1921 </p>
1922
1923 <dl><dt class="field"><b><i>content ( String )</i></b></dt><dd>
1924
1925 <p>
1926 The new content of the file, or null if the content of the
1927 file should be read from disk.
1928 </p>
1929 </dd><dt class="field"><b><i>offset ( <span style="color:#999999">opti onal</span> int )</i></b></dt><dd>
1930
1931 <p>
1932 The offset of the region that was modified.
1933 </p>
1934 </dd><dt class="field"><b><i>oldLength ( <span style="color:#999999">o ptional</span> int )</i></b></dt><dd>
1935
1936 <p>
1937 The length of the region that was removed.
1938 </p>
1939 </dd><dt class="field"><b><i>newLength ( <span style="color:#999999">o ptional</span> int )</i></b></dt><dd>
1940
1941 <p>
1942 The length of the region that was added.
1943 </p>
1944 </dd></dl></dd><dt class="typeDefinition"><a name="type_DebugContextId ">DebugContextId: String</a></dt><dd>
1945 1967
1946 <p> 1968 <p>
1947 The identifier for a debug context. 1969 The identifier for a debug context.
1948 </p> 1970 </p>
1949 </dd><dt class="typeDefinition"><a name="type_DebugService">DebugService: String</a></dt><dd> 1971 </dd><dt class="typeDefinition"><a name="type_DebugService">DebugService: String</a></dt><dd>
1950 <p> 1972 <p>
1951 An enumeration of the services provided by the debug 1973 An enumeration of the services provided by the debug
1952 domain. 1974 domain.
1953 </p> 1975 </p>
1954 1976
(...skipping 519 matching lines...) Expand 10 before | Expand all | Expand 10 after
2474 2496
2475 <p> 2497 <p>
2476 The location of the problem being represented. 2498 The location of the problem being represented.
2477 </p> 2499 </p>
2478 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringPro blemSeverity">RefactoringProblemSeverity: String</a></dt><dd> 2500 </dd></dl></dd><dt class="typeDefinition"><a name="type_RefactoringPro blemSeverity">RefactoringProblemSeverity: String</a></dt><dd>
2479 <p> 2501 <p>
2480 An enumeration of the severities of problems that can be 2502 An enumeration of the severities of problems that can be
2481 returned by the refactoring requests. 2503 returned by the refactoring requests.
2482 </p> 2504 </p>
2483 2505
2484 <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="va lue">ERROR</dt><dt class="value">FATAL</dt></dl></dd><dt class="typeDefinition"> <a name="type_SearchId">SearchId: String</a></dt><dd> 2506 <dl><dt class="value">INFO</dt><dt class="value">WARNING</dt><dt class="va lue">ERROR</dt><dt class="value">FATAL</dt></dl></dd><dt class="typeDefinition"> <a name="type_RemoveContentOverlay">RemoveContentOverlay: object</a></dt><dd>
2507 <p>
2508 A directive to remove an existing file content overlay.
2509 After processing this directive, the file contents will once
2510 again be read from the file system.
2511 </p>
2512 <p>
2513 If this directive is used on a file that doesn't currently
2514 have a content overlay, it has no effect.
2515 </p>
2516
2517 <dl><dt class="field"><b><i>type = "remove"</i></b></dt><dd></dd></dl></dd ><dt class="typeDefinition"><a name="type_SearchId">SearchId: String</a></dt><dd >
2485 2518
2486 <p> 2519 <p>
2487 An identifier used to associate search results with a search 2520 An identifier used to associate search results with a search
2488 request. 2521 request.
2489 </p> 2522 </p>
2490 </dd><dt class="typeDefinition"><a name="type_SearchResult">SearchResult: object</a></dt><dd> 2523 </dd><dt class="typeDefinition"><a name="type_SearchResult">SearchResult: object</a></dt><dd>
2491 <p> 2524 <p>
2492 A single result from a search request. 2525 A single result from a search request.
2493 </p> 2526 </p>
2494 2527
(...skipping 434 matching lines...) Expand 10 before | Expand all | Expand 10 after
2929 <p> 2962 <p>
2930 This section contains a list of all of the errors that are 2963 This section contains a list of all of the errors that are
2931 produced by the server and the data that is returned with each. 2964 produced by the server and the data that is returned with each.
2932 </p> 2965 </p>
2933 <p> 2966 <p>
2934 TBD 2967 TBD
2935 </p> 2968 </p>
2936 2969
2937 2970
2938 </body></html> 2971 </body></html>
OLDNEW
« no previous file with comments | « no previous file | pkg/analysis_server/lib/src/analysis_server.dart » ('j') | pkg/analysis_server/lib/src/domain_analysis.dart » ('J')

Powered by Google App Engine
This is Rietveld 408576698