| OLD | NEW |
| 1 <!doctype html> | 1 <!doctype html> |
| 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.18.0</version></h1> | 9 <h1 style="color:#999999">Version <version>1.18.0</version></h1> |
| 10 <p> | 10 <p> |
| (...skipping 23 matching lines...) Expand all Loading... |
| 34 for readability. | 34 for readability. |
| 35 </p> | 35 </p> |
| 36 <p> | 36 <p> |
| 37 It is the client's responsibility to read output from the server to | 37 It is the client's responsibility to read output from the server to |
| 38 avoid its blocking. | 38 avoid its blocking. |
| 39 </p> | 39 </p> |
| 40 <p> | 40 <p> |
| 41 To ease interoperability with Lisp-based clients (which may not | 41 To ease interoperability with Lisp-based clients (which may not |
| 42 be able to easily distinguish between empty lists, empty maps, | 42 be able to easily distinguish between empty lists, empty maps, |
| 43 and null), client-to-server communication is allowed to replace | 43 and null), client-to-server communication is allowed to replace |
| 44 any instance of “<tt>{}</tt>” or “<tt>[]</tt>” with null. The | 44 any instance of "<tt>{}</tt>" or "<tt>[]</tt>" with null. The |
| 45 server will always properly represent empty lists as | 45 server will always properly represent empty lists as |
| 46 “<tt>[]</tt>” and empty maps as “<tt>{}</tt>”. | 46 "<tt>[]</tt>" and empty maps as "<tt>{}</tt>". |
| 47 </p> | 47 </p> |
| 48 <h3>Communication Structure</h3> | 48 <h3>Communication Structure</h3> |
| 49 <p> | 49 <p> |
| 50 Clients can make a request of the server and the server will | 50 Clients can make a request of the server and the server will |
| 51 provide a response for each request that it receives. While many | 51 provide a response for each request that it receives. While many |
| 52 of the requests that can be made by a client are informational | 52 of the requests that can be made by a client are informational |
| 53 in nature, we have chosen to always return a response so that | 53 in nature, we have chosen to always return a response so that |
| 54 clients can know whether the request was received and was | 54 clients can know whether the request was received and was |
| 55 correct. | 55 correct. |
| 56 </p> | 56 </p> |
| (...skipping 1666 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1723 </p> | 1723 </p> |
| 1724 </field> | 1724 </field> |
| 1725 <field name="options" optional="true"> | 1725 <field name="options" optional="true"> |
| 1726 <ref>RefactoringOptions</ref> | 1726 <ref>RefactoringOptions</ref> |
| 1727 <p> | 1727 <p> |
| 1728 Data used to provide values provided by the user. The | 1728 Data used to provide values provided by the user. The |
| 1729 structure of the data is dependent on the kind of | 1729 structure of the data is dependent on the kind of |
| 1730 refactoring being performed. The data that is expected is | 1730 refactoring being performed. The data that is expected is |
| 1731 documented in the section titled <a | 1731 documented in the section titled <a |
| 1732 href="#refactorings">Refactorings</a>, labeled as | 1732 href="#refactorings">Refactorings</a>, labeled as |
| 1733 “Options”. This field can be omitted if the refactoring | 1733 "Options". This field can be omitted if the refactoring |
| 1734 does not require any options or if the values of those | 1734 does not require any options or if the values of those |
| 1735 options are not known. | 1735 options are not known. |
| 1736 </p> | 1736 </p> |
| 1737 </field> | 1737 </field> |
| 1738 </params> | 1738 </params> |
| 1739 <result> | 1739 <result> |
| 1740 <field name="initialProblems"> | 1740 <field name="initialProblems"> |
| 1741 <list><ref>RefactoringProblem</ref></list> | 1741 <list><ref>RefactoringProblem</ref></list> |
| 1742 <p> | 1742 <p> |
| 1743 The initial status of the refactoring, i.e. problems related to | 1743 The initial status of the refactoring, i.e. problems related to |
| (...skipping 20 matching lines...) Expand all Loading... |
| 1764 </p> | 1764 </p> |
| 1765 </field> | 1765 </field> |
| 1766 <field name="feedback" optional="true"> | 1766 <field name="feedback" optional="true"> |
| 1767 <ref>RefactoringFeedback</ref> | 1767 <ref>RefactoringFeedback</ref> |
| 1768 <p> | 1768 <p> |
| 1769 Data used to provide feedback to the user. The structure | 1769 Data used to provide feedback to the user. The structure |
| 1770 of the data is dependent on the kind of refactoring | 1770 of the data is dependent on the kind of refactoring |
| 1771 being created. The data that is returned is documented | 1771 being created. The data that is returned is documented |
| 1772 in the section titled <a | 1772 in the section titled <a |
| 1773 href="#refactorings">Refactorings</a>, labeled as | 1773 href="#refactorings">Refactorings</a>, labeled as |
| 1774 “Feedback”. | 1774 "Feedback". |
| 1775 </p> | 1775 </p> |
| 1776 </field> | 1776 </field> |
| 1777 <field name="change" optional="true"> | 1777 <field name="change" optional="true"> |
| 1778 <ref>SourceChange</ref> | 1778 <ref>SourceChange</ref> |
| 1779 <p> | 1779 <p> |
| 1780 The changes that are to be applied to affect the | 1780 The changes that are to be applied to affect the |
| 1781 refactoring. This field will be omitted if there are | 1781 refactoring. This field will be omitted if there are |
| 1782 problems that prevent a set of changes from being | 1782 problems that prevent a set of changes from being |
| 1783 computed, such as having no options specified for a | 1783 computed, such as having no options specified for a |
| 1784 refactoring that requires them, or if only validation | 1784 refactoring that requires them, or if only validation |
| (...skipping 190 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1975 <ref>String</ref> | 1975 <ref>String</ref> |
| 1976 <p> | 1976 <p> |
| 1977 The URI to which the file path was mapped. This field is omitted | 1977 The URI to which the file path was mapped. This field is omitted |
| 1978 if the file field was not given in the request. | 1978 if the file field was not given in the request. |
| 1979 </p> | 1979 </p> |
| 1980 </field> | 1980 </field> |
| 1981 </result> | 1981 </result> |
| 1982 </request> | 1982 </request> |
| 1983 <request method="setSubscriptions"> | 1983 <request method="setSubscriptions"> |
| 1984 <p> | 1984 <p> |
| 1985 <b><i>Deprecated</i></b>: the analysis server no longer fires |
| 1986 <tt>LAUNCH_DATA</tt> events. |
| 1987 </p> |
| 1988 <p> |
| 1985 Subscribe for services. All previous subscriptions are replaced by the | 1989 Subscribe for services. All previous subscriptions are replaced by the |
| 1986 given set of services. | 1990 given set of services. |
| 1987 </p> | 1991 </p> |
| 1988 <p> | 1992 <p> |
| 1989 It is an error if any of the elements in the list are not valid | 1993 It is an error if any of the elements in the list are not valid |
| 1990 services. If there is an error, then the current subscriptions will | 1994 services. If there is an error, then the current subscriptions will |
| 1991 remain unchanged. | 1995 remain unchanged. |
| 1992 </p> | 1996 </p> |
| 1993 <params> | 1997 <params> |
| 1994 <field name="subscriptions"> | 1998 <field name="subscriptions"> |
| (...skipping 1122 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 3117 <p> | 3121 <p> |
| 3118 A human-readable description of the element being | 3122 A human-readable description of the element being |
| 3119 referenced. This data is omitted if there is no referenced | 3123 referenced. This data is omitted if there is no referenced |
| 3120 element. | 3124 element. |
| 3121 </p> | 3125 </p> |
| 3122 </field> | 3126 </field> |
| 3123 <field name="elementKind" optional="true"> | 3127 <field name="elementKind" optional="true"> |
| 3124 <ref>String</ref> | 3128 <ref>String</ref> |
| 3125 <p> | 3129 <p> |
| 3126 A human-readable description of the kind of element being | 3130 A human-readable description of the kind of element being |
| 3127 referenced (such as “class” or “function type | 3131 referenced (such as "class" or "function type |
| 3128 alias”). This data is omitted if there is no referenced | 3132 alias"). This data is omitted if there is no referenced |
| 3129 element. | 3133 element. |
| 3130 </p> | 3134 </p> |
| 3131 </field> | 3135 </field> |
| 3132 <field name="isDeprecated" optional="true"> | 3136 <field name="isDeprecated" optional="true"> |
| 3133 <ref>bool</ref> | 3137 <ref>bool</ref> |
| 3134 <p> | 3138 <p> |
| 3135 True if the referenced element is deprecated. | 3139 True if the referenced element is deprecated. |
| 3136 </p> | 3140 </p> |
| 3137 </field> | 3141 </field> |
| 3138 <field name="parameter" optional="true"> | 3142 <field name="parameter" optional="true"> |
| (...skipping 1407 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 4546 <field name="length"> | 4550 <field name="length"> |
| 4547 <ref>int</ref> | 4551 <ref>int</ref> |
| 4548 <p> | 4552 <p> |
| 4549 The length of the name selected to be renamed. | 4553 The length of the name selected to be renamed. |
| 4550 </p> | 4554 </p> |
| 4551 </field> | 4555 </field> |
| 4552 <field name="elementKindName"> | 4556 <field name="elementKindName"> |
| 4553 <ref>String</ref> | 4557 <ref>String</ref> |
| 4554 <p> | 4558 <p> |
| 4555 The human-readable description of the kind of element being | 4559 The human-readable description of the kind of element being |
| 4556 renamed (such as “class” or “function type | 4560 renamed (such as "class" or "function type |
| 4557 alias”). | 4561 alias"). |
| 4558 </p> | 4562 </p> |
| 4559 </field> | 4563 </field> |
| 4560 <field name="oldName"> | 4564 <field name="oldName"> |
| 4561 <ref>String</ref> | 4565 <ref>String</ref> |
| 4562 <p> | 4566 <p> |
| 4563 The old name of the element before the refactoring. | 4567 The old name of the element before the refactoring. |
| 4564 </p> | 4568 </p> |
| 4565 </field> | 4569 </field> |
| 4566 </feedback> | 4570 </feedback> |
| 4567 <options> | 4571 <options> |
| (...skipping 12 matching lines...) Expand all Loading... |
| 4580 This section contains a list of all of the errors that are | 4584 This section contains a list of all of the errors that are |
| 4581 produced by the server and the data that is returned with each. | 4585 produced by the server and the data that is returned with each. |
| 4582 </p> | 4586 </p> |
| 4583 <p> | 4587 <p> |
| 4584 TODO: TBD | 4588 TODO: TBD |
| 4585 </p> | 4589 </p> |
| 4586 <h2 class="domain"><a name="index">Index</a></h2> | 4590 <h2 class="domain"><a name="index">Index</a></h2> |
| 4587 <index></index> | 4591 <index></index> |
| 4588 </body> | 4592 </body> |
| 4589 </html> | 4593 </html> |
| OLD | NEW |