| 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 Plugin API Specification</title> | 5 <title>Analysis Server Plugin API Specification</title> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <h1>Analysis Server Plugin API Specification</h1> | 8 <h1>Analysis Server Plugin API Specification</h1> |
| 9 <h1 style="color:#999999">Version | 9 <h1 style="color:#999999">Version |
| 10 <version>1.0.0-alpha.0</version> | 10 <version>1.0.0-alpha.0</version> |
| (...skipping 775 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 786 </field> | 786 </field> |
| 787 </result> | 787 </result> |
| 788 </request> | 788 </request> |
| 789 </domain> | 789 </domain> |
| 790 <types> | 790 <types> |
| 791 <h2 class="domain"><a name="types">Types</a></h2> | 791 <h2 class="domain"><a name="types">Types</a></h2> |
| 792 <p> | 792 <p> |
| 793 This section contains descriptions of the data types referenced in the API’s | 793 This section contains descriptions of the data types referenced in the API’s |
| 794 of the various domains. | 794 of the various domains. |
| 795 </p> | 795 </p> |
| 796 <type name="AddContentOverlay"> | 796 <include path="common_types_spec.html"></include> |
| 797 <p> | |
| 798 A directive to begin overlaying the contents of a file. The supplied | |
| 799 content will be used for analysis in place of the file contents in the | |
| 800 filesystem. | |
| 801 </p> | |
| 802 <p> | |
| 803 If this directive is used on a file that already has a file content | |
| 804 overlay, the old overlay is discarded and replaced with the new one. | |
| 805 </p> | |
| 806 <object> | |
| 807 <field name="type" value="add"><ref>String</ref></field> | |
| 808 <field name="content"> | |
| 809 <ref>String</ref> | |
| 810 <p> | |
| 811 The new content of the file. | |
| 812 </p> | |
| 813 </field> | |
| 814 </object> | |
| 815 </type> | |
| 816 <type name="AnalysisError"> | |
| 817 <p> | |
| 818 An indication of an error, warning, or hint that was produced by the | |
| 819 analysis. | |
| 820 </p> | |
| 821 <object> | |
| 822 <field name="severity"> | |
| 823 <ref>AnalysisErrorSeverity</ref> | |
| 824 <p> | |
| 825 The severity of the error. | |
| 826 </p> | |
| 827 </field> | |
| 828 <field name="type"> | |
| 829 <ref>AnalysisErrorType</ref> | |
| 830 <p> | |
| 831 The type of the error. | |
| 832 </p> | |
| 833 </field> | |
| 834 <field name="location"> | |
| 835 <ref>Location</ref> | |
| 836 <p> | |
| 837 The location associated with the error. | |
| 838 </p> | |
| 839 </field> | |
| 840 <field name="message"> | |
| 841 <ref>String</ref> | |
| 842 <p> | |
| 843 The message to be displayed for this error. The message should | |
| 844 indicate what is wrong with the code and why it is wrong. | |
| 845 </p> | |
| 846 </field> | |
| 847 <field name="correction" optional="true"> | |
| 848 <ref>String</ref> | |
| 849 <p> | |
| 850 The correction message to be displayed for this error. The correction | |
| 851 message should indicate how the user can fix the error. The field is | |
| 852 omitted if there is no correction message associated with the error | |
| 853 code. | |
| 854 </p> | |
| 855 </field> | |
| 856 <field name="code"> | |
| 857 <ref>String</ref> | |
| 858 <p> | |
| 859 The name, as a string, of the error code associated with this error. | |
| 860 </p> | |
| 861 </field> | |
| 862 <field name="hasFix" optional="true"> | |
| 863 <ref>bool</ref> | |
| 864 <p> | |
| 865 A hint to indicate to interested clients that this error has an | |
| 866 associated fix (or fixes). The absence of this field implies there | |
| 867 are not known to be fixes. Note that since the operation to calculate | |
| 868 whether fixes apply needs to be performant it is possible that | |
| 869 complicated tests will be skipped and a false negative returned. For | |
| 870 this reason, this attribute should be treated as a "hint". Despite the | |
| 871 possibility of false negatives, no false positives should be returned. | |
| 872 If a client sees this flag set they can proceed with the confidence | |
| 873 that there are in fact associated fixes. | |
| 874 </p> | |
| 875 </field> | |
| 876 </object> | |
| 877 </type> | |
| 878 <type name="AnalysisErrorFixes"> | 797 <type name="AnalysisErrorFixes"> |
| 879 <p> | 798 <p> |
| 880 A list of fixes associated with a specific error | 799 A list of fixes associated with a specific error |
| 881 </p> | 800 </p> |
| 882 <object> | 801 <object> |
| 883 <field name="error"> | 802 <field name="error"> |
| 884 <ref>AnalysisError</ref> | 803 <ref>AnalysisError</ref> |
| 885 <p> | 804 <p> |
| 886 The error with which the fixes are associated. | 805 The error with which the fixes are associated. |
| 887 </p> | 806 </p> |
| 888 </field> | 807 </field> |
| 889 <field name="fixes"> | 808 <field name="fixes"> |
| 890 <list><ref>PrioritizedSourceChange</ref></list> | 809 <list> |
| 810 <ref>PrioritizedSourceChange</ref> |
| 811 </list> |
| 891 <p> | 812 <p> |
| 892 The fixes associated with the error. | 813 The fixes associated with the error. |
| 893 </p> | 814 </p> |
| 894 </field> | 815 </field> |
| 895 </object> | 816 </object> |
| 896 </type> | 817 </type> |
| 897 <type name="AnalysisErrorSeverity"> | |
| 898 <p> | |
| 899 An enumeration of the possible severities of analysis errors. | |
| 900 </p> | |
| 901 <enum> | |
| 902 <value><code>INFO</code></value> | |
| 903 <value><code>WARNING</code></value> | |
| 904 <value><code>ERROR</code></value> | |
| 905 </enum> | |
| 906 </type> | |
| 907 <type name="AnalysisErrorType"> | |
| 908 <p> | |
| 909 An enumeration of the possible types of analysis errors. | |
| 910 </p> | |
| 911 <enum> | |
| 912 <value><code>CHECKED_MODE_COMPILE_TIME_ERROR</code></value> | |
| 913 <value><code>COMPILE_TIME_ERROR</code></value> | |
| 914 <value><code>HINT</code></value> | |
| 915 <value><code>LINT</code></value> | |
| 916 <value><code>STATIC_TYPE_WARNING</code></value> | |
| 917 <value><code>STATIC_WARNING</code></value> | |
| 918 <value><code>SYNTACTIC_ERROR</code></value> | |
| 919 <value><code>TODO</code></value> | |
| 920 </enum> | |
| 921 </type> | |
| 922 <type name="AnalysisService"> | 818 <type name="AnalysisService"> |
| 923 <p> | 819 <p> |
| 924 An enumeration of the services provided by the analysis domain that are | 820 An enumeration of the services provided by the analysis domain that are |
| 925 related to a specific list of files. | 821 related to a specific list of files. |
| 926 </p> | 822 </p> |
| 927 <enum> | 823 <enum> |
| 928 <value><code>FOLDING</code></value> | 824 <value><code>FOLDING</code></value> |
| 929 <value><code>HIGHLIGHTS</code></value> | 825 <value><code>HIGHLIGHTS</code></value> |
| 930 <value><code>NAVIGATION</code></value> | 826 <value><code>NAVIGATION</code></value> |
| 931 <value><code>OCCURRENCES</code></value> | 827 <value><code>OCCURRENCES</code></value> |
| 932 <value><code>OUTLINE</code></value> | 828 <value><code>OUTLINE</code></value> |
| 933 </enum> | 829 </enum> |
| 934 </type> | 830 </type> |
| 935 <type name="ChangeContentOverlay"> | |
| 936 <p> | |
| 937 A directive to modify an existing file content overlay. One or more ranges | |
| 938 of text are deleted from the old file content overlay and replaced with | |
| 939 new text. | |
| 940 </p> | |
| 941 <p> | |
| 942 The edits are applied in the order in which they occur in the list. This | |
| 943 means that the offset of each edit must be correct under the assumption | |
| 944 that all previous edits have been applied. | |
| 945 </p> | |
| 946 <p> | |
| 947 It is an error to use this overlay on a file that does not yet have a file | |
| 948 content overlay or that has had its overlay removed via | |
| 949 <a href="#type_RemoveContentOverlay">RemoveContentOverlay</a>. | |
| 950 </p> | |
| 951 <p> | |
| 952 If any of the edits cannot be applied due to its offset or length being | |
| 953 out of range, an <tt>INVALID_OVERLAY_CHANGE</tt> error will be reported. | |
| 954 </p> | |
| 955 <object> | |
| 956 <field name="type" value="change"><ref>String</ref></field> | |
| 957 <field name="edits"> | |
| 958 <list><ref>SourceEdit</ref></list> | |
| 959 <p> | |
| 960 The edits to be applied to the file. | |
| 961 </p> | |
| 962 </field> | |
| 963 </object> | |
| 964 </type> | |
| 965 <type name="CompletionSuggestion"> | |
| 966 <p> | |
| 967 A suggestion for how to complete partially entered text. Many of the | |
| 968 fields are optional, depending on the kind of element being suggested. | |
| 969 </p> | |
| 970 <object> | |
| 971 <field name="kind"> | |
| 972 <ref>CompletionSuggestionKind</ref> | |
| 973 <p> | |
| 974 The kind of element being suggested. | |
| 975 </p> | |
| 976 </field> | |
| 977 <field name="relevance"> | |
| 978 <ref>int</ref> | |
| 979 <p> | |
| 980 The relevance of this completion suggestion where a higher number | |
| 981 indicates a higher relevance. | |
| 982 </p> | |
| 983 </field> | |
| 984 <field name="completion"> | |
| 985 <ref>String</ref> | |
| 986 <p> | |
| 987 The identifier to be inserted if the suggestion is selected. If the | |
| 988 suggestion is for a method or function, the client might want to | |
| 989 additionally insert a template for the parameters. The information | |
| 990 required in order to do so is contained in other fields. | |
| 991 </p> | |
| 992 </field> | |
| 993 <field name="selectionOffset"> | |
| 994 <ref>int</ref> | |
| 995 <p> | |
| 996 The offset, relative to the beginning of the completion, of where the | |
| 997 selection should be placed after insertion. | |
| 998 </p> | |
| 999 </field> | |
| 1000 <field name="selectionLength"> | |
| 1001 <ref>int</ref> | |
| 1002 <p> | |
| 1003 The number of characters that should be selected after insertion. | |
| 1004 </p> | |
| 1005 </field> | |
| 1006 <field name="isDeprecated"> | |
| 1007 <ref>bool</ref> | |
| 1008 <p> | |
| 1009 True if the suggested element is deprecated. | |
| 1010 </p> | |
| 1011 </field> | |
| 1012 <field name="isPotential"> | |
| 1013 <ref>bool</ref> | |
| 1014 <p> | |
| 1015 True if the element is not known to be valid for the target. This | |
| 1016 happens if the type of the target is dynamic. | |
| 1017 </p> | |
| 1018 </field> | |
| 1019 <field name="docSummary" optional="true"> | |
| 1020 <ref>String</ref> | |
| 1021 <p> | |
| 1022 An abbreviated version of the Dartdoc associated with the element | |
| 1023 being suggested, This field is omitted if there is no Dartdoc | |
| 1024 associated with the element. | |
| 1025 </p> | |
| 1026 </field> | |
| 1027 <field name="docComplete" optional="true"> | |
| 1028 <ref>String</ref> | |
| 1029 <p> | |
| 1030 The Dartdoc associated with the element being suggested. This field is | |
| 1031 omitted if there is no Dartdoc associated with the element. | |
| 1032 </p> | |
| 1033 </field> | |
| 1034 <field name="declaringType" optional="true"> | |
| 1035 <ref>String</ref> | |
| 1036 <p> | |
| 1037 The class that declares the element being suggested. This field is | |
| 1038 omitted if the suggested element is not a member of a class. | |
| 1039 </p> | |
| 1040 </field> | |
| 1041 <field name="defaultArgumentListString" optional="true"> | |
| 1042 <ref>String</ref> | |
| 1043 <p> | |
| 1044 A default String for use in generating argument list source contents | |
| 1045 on the client side. | |
| 1046 </p> | |
| 1047 </field> | |
| 1048 <field name="defaultArgumentListTextRanges" optional="true"> | |
| 1049 <list><ref>int</ref></list> | |
| 1050 <p> | |
| 1051 Pairs of offsets and lengths describing 'defaultArgumentListString' | |
| 1052 text ranges suitable for use by clients to set up linked edits of | |
| 1053 default argument source contents. For example, given an argument list | |
| 1054 string 'x, y', the corresponding text range [0, 1, 3, 1], indicates | |
| 1055 two text ranges of length 1, starting at offsets 0 and 3. Clients can | |
| 1056 use these ranges to treat the 'x' and 'y' values specially for linked | |
| 1057 edits. | |
| 1058 </p> | |
| 1059 </field> | |
| 1060 <field name="element" optional="true"> | |
| 1061 <ref>Element</ref> | |
| 1062 <p> | |
| 1063 Information about the element reference being suggested. | |
| 1064 </p> | |
| 1065 </field> | |
| 1066 <field name="returnType" optional="true"> | |
| 1067 <ref>String</ref> | |
| 1068 <p> | |
| 1069 The return type of the getter, function or method or the type of the | |
| 1070 field being suggested. This field is omitted if the suggested element | |
| 1071 is not a getter, function or method. | |
| 1072 </p> | |
| 1073 </field> | |
| 1074 <field name="parameterNames" optional="true"> | |
| 1075 <list><ref>String</ref></list> | |
| 1076 <p> | |
| 1077 The names of the parameters of the function or method being suggested. | |
| 1078 This field is omitted if the suggested element is not a setter, | |
| 1079 function or method. | |
| 1080 </p> | |
| 1081 </field> | |
| 1082 <field name="parameterTypes" optional="true"> | |
| 1083 <list><ref>String</ref></list> | |
| 1084 <p> | |
| 1085 The types of the parameters of the function or method being suggested. | |
| 1086 This field is omitted if the parameterNames field is omitted. | |
| 1087 </p> | |
| 1088 </field> | |
| 1089 <field name="requiredParameterCount" optional="true"> | |
| 1090 <ref>int</ref> | |
| 1091 <p> | |
| 1092 The number of required parameters for the function or method being | |
| 1093 suggested. This field is omitted if the parameterNames field is | |
| 1094 omitted. | |
| 1095 </p> | |
| 1096 </field> | |
| 1097 <field name="hasNamedParameters" optional="true"> | |
| 1098 <ref>bool</ref> | |
| 1099 <p> | |
| 1100 True if the function or method being suggested has at least one named | |
| 1101 parameter. This field is omitted if the parameterNames field is | |
| 1102 omitted. | |
| 1103 </p> | |
| 1104 </field> | |
| 1105 <field name="parameterName" optional="true"> | |
| 1106 <ref>String</ref> | |
| 1107 <p> | |
| 1108 The name of the optional parameter being suggested. This field is | |
| 1109 omitted if the suggestion is not the addition of an optional argument | |
| 1110 within an argument list. | |
| 1111 </p> | |
| 1112 </field> | |
| 1113 <field name="parameterType" optional="true"> | |
| 1114 <ref>String</ref> | |
| 1115 <p> | |
| 1116 The type of the options parameter being suggested. This field is | |
| 1117 omitted if the parameterName field is omitted. | |
| 1118 </p> | |
| 1119 </field> | |
| 1120 <field name="importUri" optional="true"> | |
| 1121 <ref>String</ref> | |
| 1122 <p> | |
| 1123 The import to be added if the suggestion is out of scope and needs | |
| 1124 an import to be added to be in scope. | |
| 1125 </p> | |
| 1126 </field> | |
| 1127 </object> | |
| 1128 </type> | |
| 1129 <type name="CompletionSuggestionKind"> | |
| 1130 <p> | |
| 1131 An enumeration of the kinds of elements that can be included in a | |
| 1132 completion suggestion. | |
| 1133 </p> | |
| 1134 <enum> | |
| 1135 <value> | |
| 1136 <code>ARGUMENT_LIST</code> | |
| 1137 <p> | |
| 1138 A list of arguments for the method or function that is being | |
| 1139 invoked. For this suggestion kind, the completion field is a | |
| 1140 textual representation of the invocation and the parameterNames, | |
| 1141 parameterTypes, and requiredParameterCount attributes are defined. | |
| 1142 </p> | |
| 1143 </value> | |
| 1144 <value><code>IMPORT</code></value> | |
| 1145 <value> | |
| 1146 <code>IDENTIFIER</code> | |
| 1147 <p> | |
| 1148 The element identifier should be inserted at the completion | |
| 1149 location. For example "someMethod" in <tt>import 'myLib.dart' show | |
| 1150 someMethod;</tt>. For suggestions of this kind, the element | |
| 1151 attribute is defined and the completion field is the element's | |
| 1152 identifier. | |
| 1153 </p> | |
| 1154 </value> | |
| 1155 <value> | |
| 1156 <code>INVOCATION</code> | |
| 1157 <p> | |
| 1158 The element is being invoked at the completion location. For | |
| 1159 example, 'someMethod' in <tt>x.someMethod();</tt>. For suggestions | |
| 1160 of this kind, the element attribute is defined and the completion | |
| 1161 field is the element's identifier. | |
| 1162 </p> | |
| 1163 </value> | |
| 1164 <value> | |
| 1165 <code>KEYWORD</code> | |
| 1166 <p> | |
| 1167 A keyword is being suggested. For suggestions of this kind, the | |
| 1168 completion is the keyword. | |
| 1169 </p> | |
| 1170 </value> | |
| 1171 <value> | |
| 1172 <code>NAMED_ARGUMENT</code> | |
| 1173 <p> | |
| 1174 A named argument for the current call site is being suggested. For | |
| 1175 suggestions of this kind, the completion is the named argument | |
| 1176 identifier including a trailing ':' and a space. | |
| 1177 </p> | |
| 1178 </value> | |
| 1179 <value><code>OPTIONAL_ARGUMENT</code></value> | |
| 1180 <value><code>PARAMETER</code></value> | |
| 1181 </enum> | |
| 1182 </type> | |
| 1183 <type name="ContextBuilderOptions"> | 831 <type name="ContextBuilderOptions"> |
| 1184 <p> | 832 <p> |
| 1185 The options used to build an analysis context. | 833 The options used to build an analysis context. |
| 1186 </p> | 834 </p> |
| 1187 <object> | 835 <object> |
| 1188 <field name="dartSdkSummaryPath" optional="true"> | 836 <field name="dartSdkSummaryPath" optional="true"> |
| 1189 <ref>String</ref> | 837 <ref>String</ref> |
| 1190 <p> | 838 <p> |
| 1191 The file path of the file containing the summary of the SDK that | 839 The file path of the file containing the summary of the SDK that |
| 1192 should be used to "analyze" the SDK. The field will be omitted if the | 840 should be used to "analyze" the SDK. The field will be omitted if the |
| (...skipping 76 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1269 <field name="exclude"> | 917 <field name="exclude"> |
| 1270 <list> | 918 <list> |
| 1271 <ref>String</ref> | 919 <ref>String</ref> |
| 1272 </list> | 920 </list> |
| 1273 <p> | 921 <p> |
| 1274 A list of the absolute paths of files and directories within the root | 922 A list of the absolute paths of files and directories within the root |
| 1275 directory that should not be analyzed. | 923 directory that should not be analyzed. |
| 1276 </p> | 924 </p> |
| 1277 </field> | 925 </field> |
| 1278 </object> | 926 </object> |
| 1279 </type> | |
| 1280 <type name="Element"> | |
| 1281 <p> | |
| 1282 Information about an element (something that can be declared in code). | |
| 1283 </p> | |
| 1284 <object> | |
| 1285 <field name="kind"> | |
| 1286 <ref>ElementKind</ref> | |
| 1287 <p> | |
| 1288 The kind of the element. | |
| 1289 </p> | |
| 1290 </field> | |
| 1291 <field name="name"> | |
| 1292 <ref>String</ref> | |
| 1293 <p> | |
| 1294 The name of the element. This is typically used as the label in the ou
tline. | |
| 1295 </p> | |
| 1296 </field> | |
| 1297 <field name="location" optional="true"> | |
| 1298 <ref>Location</ref> | |
| 1299 <p> | |
| 1300 The location of the name in the declaration of the element. | |
| 1301 </p> | |
| 1302 </field> | |
| 1303 <field name="flags"> | |
| 1304 <ref>int</ref> | |
| 1305 <p> | |
| 1306 A bit-map containing the following flags: | |
| 1307 </p> | |
| 1308 <ul> | |
| 1309 <li> | |
| 1310 0x01 - set if the element is explicitly or implicitly abstract | |
| 1311 </li> | |
| 1312 <li> | |
| 1313 0x02 - set if the element was declared to be ‘const’ | |
| 1314 </li> | |
| 1315 <li> | |
| 1316 0x04 - set if the element was declared to be ‘final’ | |
| 1317 </li> | |
| 1318 <li> | |
| 1319 0x08 - set if the element is a static member of a class or is a | |
| 1320 top-level function or field | |
| 1321 </li> | |
| 1322 <li> | |
| 1323 0x10 - set if the element is private | |
| 1324 </li> | |
| 1325 <li> | |
| 1326 0x20 - set if the element is deprecated | |
| 1327 </li> | |
| 1328 </ul> | |
| 1329 </field> | |
| 1330 <field name="parameters" optional="true"> | |
| 1331 <ref>String</ref> | |
| 1332 <p> | |
| 1333 The parameter list for the element. If the element is not a method or | |
| 1334 function this field will not be defined. If the element doesn't have | |
| 1335 parameters (e.g. getter), this field will not be defined. If the | |
| 1336 element has zero parameters, this field will have a value of "()". | |
| 1337 </p> | |
| 1338 </field> | |
| 1339 <field name="returnType" optional="true"> | |
| 1340 <ref>String</ref> | |
| 1341 <p> | |
| 1342 The return type of the element. If the element is not a method or | |
| 1343 function this field will not be defined. If the element does not have | |
| 1344 a declared return type, this field will contain an empty string. | |
| 1345 </p> | |
| 1346 </field> | |
| 1347 <field name="typeParameters" optional="true"> | |
| 1348 <ref>String</ref> | |
| 1349 <p> | |
| 1350 The type parameter list for the element. If the element doesn't have | |
| 1351 type parameters, this field will not be defined. | |
| 1352 </p> | |
| 1353 </field> | |
| 1354 </object> | |
| 1355 </type> | |
| 1356 <type name="ElementKind"> | |
| 1357 <p> | |
| 1358 An enumeration of the kinds of elements. | |
| 1359 </p> | |
| 1360 <enum> | |
| 1361 <value><code>CLASS</code></value> | |
| 1362 <value><code>CLASS_TYPE_ALIAS</code></value> | |
| 1363 <value><code>COMPILATION_UNIT</code></value> | |
| 1364 <value><code>CONSTRUCTOR</code></value> | |
| 1365 <value><code>ENUM</code></value> | |
| 1366 <value><code>ENUM_CONSTANT</code></value> | |
| 1367 <value><code>FIELD</code></value> | |
| 1368 <value><code>FILE</code></value> | |
| 1369 <value><code>FUNCTION</code></value> | |
| 1370 <value><code>FUNCTION_TYPE_ALIAS</code></value> | |
| 1371 <value><code>GETTER</code></value> | |
| 1372 <value><code>LABEL</code></value> | |
| 1373 <value><code>LIBRARY</code></value> | |
| 1374 <value><code>LOCAL_VARIABLE</code></value> | |
| 1375 <value><code>METHOD</code></value> | |
| 1376 <value><code>PARAMETER</code></value> | |
| 1377 <value><code>PREFIX</code></value> | |
| 1378 <value><code>SETTER</code></value> | |
| 1379 <value><code>TOP_LEVEL_VARIABLE</code></value> | |
| 1380 <value><code>TYPE_PARAMETER</code></value> | |
| 1381 <value><code>UNKNOWN</code></value> | |
| 1382 </enum> | |
| 1383 </type> | |
| 1384 <type name="FilePath"> | |
| 1385 <ref>String</ref> | |
| 1386 <p> | |
| 1387 The absolute, normalized path of a file. | |
| 1388 </p> | |
| 1389 <p> | |
| 1390 If the format of a file path in a request is not valid, e.g. the path is | |
| 1391 not absolute or is not normalized, then an error of type | |
| 1392 <tt>INVALID_FILE_PATH_FORMAT</tt> will be generated. | |
| 1393 </p> | |
| 1394 </type> | |
| 1395 <type name="FoldingKind"> | |
| 1396 <p> | |
| 1397 An enumeration of the kinds of folding regions. | |
| 1398 </p> | |
| 1399 <enum> | |
| 1400 <value><code>COMMENT</code></value> | |
| 1401 <value><code>CLASS_MEMBER</code></value> | |
| 1402 <value><code>DIRECTIVES</code></value> | |
| 1403 <value><code>DOCUMENTATION_COMMENT</code></value> | |
| 1404 <value><code>TOP_LEVEL_DECLARATION</code></value> | |
| 1405 </enum> | |
| 1406 </type> | |
| 1407 <type name="FoldingRegion"> | |
| 1408 <p> | |
| 1409 A description of a region that can be folded. | |
| 1410 </p> | |
| 1411 <object> | |
| 1412 <field name="kind"> | |
| 1413 <ref>FoldingKind</ref> | |
| 1414 <p> | |
| 1415 The kind of the region. | |
| 1416 </p> | |
| 1417 </field> | |
| 1418 <field name="offset"> | |
| 1419 <ref>int</ref> | |
| 1420 <p> | |
| 1421 The offset of the region to be folded. | |
| 1422 </p> | |
| 1423 </field> | |
| 1424 <field name="length"> | |
| 1425 <ref>int</ref> | |
| 1426 <p> | |
| 1427 The length of the region to be folded. | |
| 1428 </p> | |
| 1429 </field> | |
| 1430 </object> | |
| 1431 </type> | |
| 1432 <type name="HighlightRegion"> | |
| 1433 <p> | |
| 1434 A description of a region that could have special highlighting associated | |
| 1435 with it. | |
| 1436 </p> | |
| 1437 <object> | |
| 1438 <field name="type"> | |
| 1439 <ref>HighlightRegionType</ref> | |
| 1440 <p> | |
| 1441 The type of highlight associated with the region. | |
| 1442 </p> | |
| 1443 </field> | |
| 1444 <field name="offset"> | |
| 1445 <ref>int</ref> | |
| 1446 <p> | |
| 1447 The offset of the region to be highlighted. | |
| 1448 </p> | |
| 1449 </field> | |
| 1450 <field name="length"> | |
| 1451 <ref>int</ref> | |
| 1452 <p> | |
| 1453 The length of the region to be highlighted. | |
| 1454 </p> | |
| 1455 </field> | |
| 1456 </object> | |
| 1457 </type> | |
| 1458 <type name="HighlightRegionType"> | |
| 1459 <p> | |
| 1460 An enumeration of the kinds of highlighting that can be applied to files. | |
| 1461 </p> | |
| 1462 <enum> | |
| 1463 <value><code>ANNOTATION</code></value> | |
| 1464 <value><code>BUILT_IN</code></value> | |
| 1465 <value><code>CLASS</code></value> | |
| 1466 <value><code>COMMENT_BLOCK</code></value> | |
| 1467 <value><code>COMMENT_DOCUMENTATION</code></value> | |
| 1468 <value><code>COMMENT_END_OF_LINE</code></value> | |
| 1469 <value><code>CONSTRUCTOR</code></value> | |
| 1470 <value><code>DIRECTIVE</code></value> | |
| 1471 <value> | |
| 1472 <code>DYNAMIC_TYPE</code> | |
| 1473 <p>Only for version 1 of highlight.</p> | |
| 1474 </value> | |
| 1475 <value> | |
| 1476 <code>DYNAMIC_LOCAL_VARIABLE_DECLARATION</code> | |
| 1477 <p>Only for version 2 of highlight.</p> | |
| 1478 </value> | |
| 1479 <value> | |
| 1480 <code>DYNAMIC_LOCAL_VARIABLE_REFERENCE</code> | |
| 1481 <p>Only for version 2 of highlight.</p> | |
| 1482 </value> | |
| 1483 <value> | |
| 1484 <code>DYNAMIC_PARAMETER_DECLARATION</code> | |
| 1485 <p>Only for version 2 of highlight.</p> | |
| 1486 </value> | |
| 1487 <value> | |
| 1488 <code>DYNAMIC_PARAMETER_REFERENCE</code> | |
| 1489 <p>Only for version 2 of highlight.</p> | |
| 1490 </value> | |
| 1491 <value><code>ENUM</code></value> | |
| 1492 <value><code>ENUM_CONSTANT</code></value> | |
| 1493 <value> | |
| 1494 <code>FIELD</code> | |
| 1495 <p>Only for version 1 of highlight.</p> | |
| 1496 </value> | |
| 1497 <value> | |
| 1498 <code>FIELD_STATIC</code> | |
| 1499 <p>Only for version 1 of highlight.</p> | |
| 1500 </value> | |
| 1501 <value> | |
| 1502 <code>FUNCTION</code> | |
| 1503 <p>Only for version 1 of highlight.</p> | |
| 1504 </value> | |
| 1505 <value> | |
| 1506 <code>FUNCTION_DECLARATION</code> | |
| 1507 <p>Only for version 1 of highlight.</p> | |
| 1508 </value> | |
| 1509 <value><code>FUNCTION_TYPE_ALIAS</code></value> | |
| 1510 <value> | |
| 1511 <code>GETTER_DECLARATION</code> | |
| 1512 <p>Only for version 1 of highlight.</p> | |
| 1513 </value> | |
| 1514 <value><code>IDENTIFIER_DEFAULT</code></value> | |
| 1515 <value><code>IMPORT_PREFIX</code></value> | |
| 1516 <value> | |
| 1517 <code>INSTANCE_FIELD_DECLARATION</code> | |
| 1518 <p>Only for version 2 of highlight.</p> | |
| 1519 </value> | |
| 1520 <value> | |
| 1521 <code>INSTANCE_FIELD_REFERENCE</code> | |
| 1522 <p>Only for version 2 of highlight.</p> | |
| 1523 </value> | |
| 1524 <value> | |
| 1525 <code>INSTANCE_GETTER_DECLARATION</code> | |
| 1526 <p>Only for version 2 of highlight.</p> | |
| 1527 </value> | |
| 1528 <value> | |
| 1529 <code>INSTANCE_GETTER_REFERENCE</code> | |
| 1530 <p>Only for version 2 of highlight.</p> | |
| 1531 </value> | |
| 1532 <value> | |
| 1533 <code>INSTANCE_METHOD_DECLARATION</code> | |
| 1534 <p>Only for version 2 of highlight.</p> | |
| 1535 </value> | |
| 1536 <value> | |
| 1537 <code>INSTANCE_METHOD_REFERENCE</code> | |
| 1538 <p>Only for version 2 of highlight.</p> | |
| 1539 </value> | |
| 1540 <value> | |
| 1541 <code>INSTANCE_SETTER_DECLARATION</code> | |
| 1542 <p>Only for version 2 of highlight.</p> | |
| 1543 </value> | |
| 1544 <value> | |
| 1545 <code>INSTANCE_SETTER_REFERENCE</code> | |
| 1546 <p>Only for version 2 of highlight.</p> | |
| 1547 </value> | |
| 1548 <value> | |
| 1549 <code>INVALID_STRING_ESCAPE</code> | |
| 1550 <p>Only for version 2 of highlight.</p> | |
| 1551 </value> | |
| 1552 <value><code>KEYWORD</code></value> | |
| 1553 <value><code>LABEL</code></value> | |
| 1554 <value> | |
| 1555 <code>LIBRARY_NAME</code> | |
| 1556 <p>Only for version 2 of highlight.</p> | |
| 1557 </value> | |
| 1558 <value><code>LITERAL_BOOLEAN</code></value> | |
| 1559 <value><code>LITERAL_DOUBLE</code></value> | |
| 1560 <value><code>LITERAL_INTEGER</code></value> | |
| 1561 <value><code>LITERAL_LIST</code></value> | |
| 1562 <value><code>LITERAL_MAP</code></value> | |
| 1563 <value><code>LITERAL_STRING</code></value> | |
| 1564 <value> | |
| 1565 <code>LOCAL_FUNCTION_DECLARATION</code> | |
| 1566 <p>Only for version 2 of highlight.</p> | |
| 1567 </value> | |
| 1568 <value> | |
| 1569 <code>LOCAL_FUNCTION_REFERENCE</code> | |
| 1570 <p>Only for version 2 of highlight.</p> | |
| 1571 </value> | |
| 1572 <value> | |
| 1573 <code>LOCAL_VARIABLE</code> | |
| 1574 <p>Only for version 1 of highlight.</p> | |
| 1575 </value> | |
| 1576 <value><code>LOCAL_VARIABLE_DECLARATION</code></value> | |
| 1577 <value> | |
| 1578 <code>LOCAL_VARIABLE_REFERENCE</code> | |
| 1579 <p>Only for version 2 of highlight.</p> | |
| 1580 </value> | |
| 1581 <value> | |
| 1582 <code>METHOD</code> | |
| 1583 <p>Only for version 1 of highlight.</p> | |
| 1584 </value> | |
| 1585 <value> | |
| 1586 <code>METHOD_DECLARATION</code> | |
| 1587 <p>Only for version 1 of highlight.</p> | |
| 1588 </value> | |
| 1589 <value> | |
| 1590 <code>METHOD_DECLARATION_STATIC</code> | |
| 1591 <p>Only for version 1 of highlight.</p> | |
| 1592 </value> | |
| 1593 <value> | |
| 1594 <code>METHOD_STATIC</code> | |
| 1595 <p>Only for version 1 of highlight.</p> | |
| 1596 </value> | |
| 1597 <value> | |
| 1598 <code>PARAMETER</code> | |
| 1599 <p>Only for version 1 of highlight.</p> | |
| 1600 </value> | |
| 1601 <value> | |
| 1602 <code>SETTER_DECLARATION</code> | |
| 1603 <p>Only for version 1 of highlight.</p> | |
| 1604 </value> | |
| 1605 <value> | |
| 1606 <code>TOP_LEVEL_VARIABLE</code> | |
| 1607 <p>Only for version 1 of highlight.</p> | |
| 1608 </value> | |
| 1609 <value> | |
| 1610 <code>PARAMETER_DECLARATION</code> | |
| 1611 <p>Only for version 2 of highlight.</p> | |
| 1612 </value> | |
| 1613 <value> | |
| 1614 <code>PARAMETER_REFERENCE</code> | |
| 1615 <p>Only for version 2 of highlight.</p> | |
| 1616 </value> | |
| 1617 <value> | |
| 1618 <code>STATIC_FIELD_DECLARATION</code> | |
| 1619 <p>Only for version 2 of highlight.</p> | |
| 1620 </value> | |
| 1621 <value> | |
| 1622 <code>STATIC_GETTER_DECLARATION</code> | |
| 1623 <p>Only for version 2 of highlight.</p> | |
| 1624 </value> | |
| 1625 <value> | |
| 1626 <code>STATIC_GETTER_REFERENCE</code> | |
| 1627 <p>Only for version 2 of highlight.</p> | |
| 1628 </value> | |
| 1629 <value> | |
| 1630 <code>STATIC_METHOD_DECLARATION</code> | |
| 1631 <p>Only for version 2 of highlight.</p> | |
| 1632 </value> | |
| 1633 <value> | |
| 1634 <code>STATIC_METHOD_REFERENCE</code> | |
| 1635 <p>Only for version 2 of highlight.</p> | |
| 1636 </value> | |
| 1637 <value> | |
| 1638 <code>STATIC_SETTER_DECLARATION</code> | |
| 1639 <p>Only for version 2 of highlight.</p> | |
| 1640 </value> | |
| 1641 <value> | |
| 1642 <code>STATIC_SETTER_REFERENCE</code> | |
| 1643 <p>Only for version 2 of highlight.</p> | |
| 1644 </value> | |
| 1645 <value> | |
| 1646 <code>TOP_LEVEL_FUNCTION_DECLARATION</code> | |
| 1647 <p>Only for version 2 of highlight.</p> | |
| 1648 </value> | |
| 1649 <value> | |
| 1650 <code>TOP_LEVEL_FUNCTION_REFERENCE</code> | |
| 1651 <p>Only for version 2 of highlight.</p> | |
| 1652 </value> | |
| 1653 <value> | |
| 1654 <code>TOP_LEVEL_GETTER_DECLARATION</code> | |
| 1655 <p>Only for version 2 of highlight.</p> | |
| 1656 </value> | |
| 1657 <value> | |
| 1658 <code>TOP_LEVEL_GETTER_REFERENCE</code> | |
| 1659 <p>Only for version 2 of highlight.</p> | |
| 1660 </value> | |
| 1661 <value> | |
| 1662 <code>TOP_LEVEL_SETTER_DECLARATION</code> | |
| 1663 <p>Only for version 2 of highlight.</p> | |
| 1664 </value> | |
| 1665 <value> | |
| 1666 <code>TOP_LEVEL_SETTER_REFERENCE</code> | |
| 1667 <p>Only for version 2 of highlight.</p> | |
| 1668 </value> | |
| 1669 <value> | |
| 1670 <code>TOP_LEVEL_VARIABLE_DECLARATION</code> | |
| 1671 <p>Only for version 2 of highlight.</p> | |
| 1672 </value> | |
| 1673 <value><code>TYPE_NAME_DYNAMIC</code></value> | |
| 1674 <value><code>TYPE_PARAMETER</code></value> | |
| 1675 <value> | |
| 1676 <code>UNRESOLVED_INSTANCE_MEMBER_REFERENCE</code> | |
| 1677 <p>Only for version 2 of highlight.</p> | |
| 1678 </value> | |
| 1679 <value> | |
| 1680 <code>VALID_STRING_ESCAPE</code> | |
| 1681 <p>Only for version 2 of highlight.</p> | |
| 1682 </value> | |
| 1683 </enum> | |
| 1684 </type> | |
| 1685 <type name="LinkedEditGroup"> | |
| 1686 <p> | |
| 1687 A collection of positions that should be linked (edited simultaneously) | |
| 1688 for the purposes of updating code after a source change. For example, if a | |
| 1689 set of edits introduced a new variable name, the group would contain all | |
| 1690 of the positions of the variable name so that if the client wanted to let | |
| 1691 the user edit the variable name after the operation, all occurrences of | |
| 1692 the name could be edited simultaneously. | |
| 1693 </p> | |
| 1694 <object> | |
| 1695 <field name="positions"> | |
| 1696 <list><ref>Position</ref></list> | |
| 1697 <p> | |
| 1698 The positions of the regions that should be edited simultaneously. | |
| 1699 </p> | |
| 1700 </field> | |
| 1701 <field name="length"> | |
| 1702 <ref>int</ref> | |
| 1703 <p> | |
| 1704 The length of the regions that should be edited simultaneously. | |
| 1705 </p> | |
| 1706 </field> | |
| 1707 <field name="suggestions"> | |
| 1708 <list><ref>LinkedEditSuggestion</ref></list> | |
| 1709 <p> | |
| 1710 Pre-computed suggestions for what every region might want to be | |
| 1711 changed to. | |
| 1712 </p> | |
| 1713 </field> | |
| 1714 </object> | |
| 1715 </type> | |
| 1716 <type name="LinkedEditSuggestion"> | |
| 1717 <p> | |
| 1718 A suggestion of a value that could be used to replace all of the linked | |
| 1719 edit regions in a <a href="#type_LinkedEditGroup">LinkedEditGroup</a>. | |
| 1720 </p> | |
| 1721 <object> | |
| 1722 <field name="value"> | |
| 1723 <ref>String</ref> | |
| 1724 <p> | |
| 1725 The value that could be used to replace all of the linked edit | |
| 1726 regions. | |
| 1727 </p> | |
| 1728 </field> | |
| 1729 <field name="kind"> | |
| 1730 <ref>LinkedEditSuggestionKind</ref> | |
| 1731 <p> | |
| 1732 The kind of value being proposed. | |
| 1733 </p> | |
| 1734 </field> | |
| 1735 </object> | |
| 1736 </type> | |
| 1737 <type name="LinkedEditSuggestionKind"> | |
| 1738 <p> | |
| 1739 An enumeration of the kind of values that can be suggested for a linked | |
| 1740 edit. | |
| 1741 </p> | |
| 1742 <enum> | |
| 1743 <value><code>METHOD</code></value> | |
| 1744 <value><code>PARAMETER</code></value> | |
| 1745 <value><code>TYPE</code></value> | |
| 1746 <value><code>VARIABLE</code></value> | |
| 1747 </enum> | |
| 1748 </type> | |
| 1749 <type name="Location"> | |
| 1750 <p> | |
| 1751 A location (character range) within a file. | |
| 1752 </p> | |
| 1753 <object> | |
| 1754 <field name="file"> | |
| 1755 <ref>FilePath</ref> | |
| 1756 <p> | |
| 1757 The file containing the range. | |
| 1758 </p> | |
| 1759 </field> | |
| 1760 <field name="offset"> | |
| 1761 <ref>int</ref> | |
| 1762 <p> | |
| 1763 The offset of the range. | |
| 1764 </p> | |
| 1765 </field> | |
| 1766 <field name="length"> | |
| 1767 <ref>int</ref> | |
| 1768 <p> | |
| 1769 The length of the range. | |
| 1770 </p> | |
| 1771 </field> | |
| 1772 <field name="startLine"> | |
| 1773 <ref>int</ref> | |
| 1774 <p> | |
| 1775 The one-based index of the line containing the first character of the | |
| 1776 range. | |
| 1777 </p> | |
| 1778 </field> | |
| 1779 <field name="startColumn"> | |
| 1780 <ref>int</ref> | |
| 1781 <p> | |
| 1782 The one-based index of the column containing the first character of | |
| 1783 the range. | |
| 1784 </p> | |
| 1785 </field> | |
| 1786 </object> | |
| 1787 </type> | |
| 1788 <type name="NavigationRegion"> | |
| 1789 <p> | |
| 1790 A description of a region from which the user can navigate to the | |
| 1791 declaration of an element. | |
| 1792 </p> | |
| 1793 <object> | |
| 1794 <field name="offset"> | |
| 1795 <ref>int</ref> | |
| 1796 <p> | |
| 1797 The offset of the region from which the user can navigate. | |
| 1798 </p> | |
| 1799 </field> | |
| 1800 <field name="length"> | |
| 1801 <ref>int</ref> | |
| 1802 <p> | |
| 1803 The length of the region from which the user can navigate. | |
| 1804 </p> | |
| 1805 </field> | |
| 1806 <field name="targets"> | |
| 1807 <list><ref>int</ref></list> | |
| 1808 <p> | |
| 1809 The indexes of the targets (in the enclosing navigation response) to | |
| 1810 which the given region is bound. By opening the target, clients can | |
| 1811 implement one form of navigation. This list cannot be empty. | |
| 1812 </p> | |
| 1813 </field> | |
| 1814 </object> | |
| 1815 </type> | |
| 1816 <type name="NavigationTarget"> | |
| 1817 <p> | |
| 1818 A description of a target to which the user can navigate. | |
| 1819 </p> | |
| 1820 <object> | |
| 1821 <field name="kind"> | |
| 1822 <ref>ElementKind</ref> | |
| 1823 <p> | |
| 1824 The kind of the element. | |
| 1825 </p> | |
| 1826 </field> | |
| 1827 <field name="fileIndex"> | |
| 1828 <ref>int</ref> | |
| 1829 <p> | |
| 1830 The index of the file (in the enclosing navigation response) to | |
| 1831 navigate to. | |
| 1832 </p> | |
| 1833 </field> | |
| 1834 <field name="offset"> | |
| 1835 <ref>int</ref> | |
| 1836 <p> | |
| 1837 The offset of the region to which the user can navigate. | |
| 1838 </p> | |
| 1839 </field> | |
| 1840 <field name="length"> | |
| 1841 <ref>int</ref> | |
| 1842 <p> | |
| 1843 The length of the region to which the user can navigate. | |
| 1844 </p> | |
| 1845 </field> | |
| 1846 <field name="startLine"> | |
| 1847 <ref>int</ref> | |
| 1848 <p> | |
| 1849 The one-based index of the line containing the first character of the | |
| 1850 region. | |
| 1851 </p> | |
| 1852 </field> | |
| 1853 <field name="startColumn"> | |
| 1854 <ref>int</ref> | |
| 1855 <p> | |
| 1856 The one-based index of the column containing the first character of | |
| 1857 the region. | |
| 1858 </p> | |
| 1859 </field> | |
| 1860 </object> | |
| 1861 </type> | |
| 1862 <type name="Occurrences"> | |
| 1863 <p> | |
| 1864 A description of the references to a single element within a single file. | |
| 1865 </p> | |
| 1866 <object> | |
| 1867 <field name="element"> | |
| 1868 <ref>Element</ref> | |
| 1869 <p> | |
| 1870 The element that was referenced. | |
| 1871 </p> | |
| 1872 </field> | |
| 1873 <field name="offsets"> | |
| 1874 <list><ref>int</ref></list> | |
| 1875 <p> | |
| 1876 The offsets of the name of the referenced element within the file. | |
| 1877 </p> | |
| 1878 </field> | |
| 1879 <field name="length"> | |
| 1880 <ref>int</ref> | |
| 1881 <p> | |
| 1882 The length of the name of the referenced element. | |
| 1883 </p> | |
| 1884 </field> | |
| 1885 </object> | |
| 1886 </type> | |
| 1887 <type name="Outline"> | |
| 1888 <p> | |
| 1889 An node in the outline structure of a file. | |
| 1890 </p> | |
| 1891 <object> | |
| 1892 <field name="element"> | |
| 1893 <ref>Element</ref> | |
| 1894 <p> | |
| 1895 A description of the element represented by this node. | |
| 1896 </p> | |
| 1897 </field> | |
| 1898 <field name="offset"> | |
| 1899 <ref>int</ref> | |
| 1900 <p> | |
| 1901 The offset of the first character of the element. This is different | |
| 1902 than the offset in the Element, which is the offset of the name of the | |
| 1903 element. It can be used, for example, to map locations in the file | |
| 1904 back to an outline. | |
| 1905 </p> | |
| 1906 </field> | |
| 1907 <field name="length"> | |
| 1908 <ref>int</ref> | |
| 1909 <p> | |
| 1910 The length of the element. | |
| 1911 </p> | |
| 1912 </field> | |
| 1913 <field name="children" optional="true"> | |
| 1914 <list><ref>Outline</ref></list> | |
| 1915 <p> | |
| 1916 The children of the node. The field will be omitted if the node has no | |
| 1917 children. | |
| 1918 </p> | |
| 1919 </field> | |
| 1920 </object> | |
| 1921 </type> | |
| 1922 <type name="Position"> | |
| 1923 <p> | |
| 1924 A position within a file. | |
| 1925 </p> | |
| 1926 <object> | |
| 1927 <field name="file"> | |
| 1928 <ref>FilePath</ref> | |
| 1929 <p> | |
| 1930 The file containing the position. | |
| 1931 </p> | |
| 1932 </field> | |
| 1933 <field name="offset"> | |
| 1934 <ref>int</ref> | |
| 1935 <p> | |
| 1936 The offset of the position. | |
| 1937 </p> | |
| 1938 </field> | |
| 1939 </object> | |
| 1940 </type> | 927 </type> |
| 1941 <type name="PrioritizedSourceChange"> | 928 <type name="PrioritizedSourceChange"> |
| 1942 <p> | 929 <p> |
| 1943 A source change that has a priority associated with it. | 930 A source change that has a priority associated with it. |
| 1944 </p> | 931 </p> |
| 1945 <object> | 932 <object> |
| 1946 <field name="priority"> | 933 <field name="priority"> |
| 1947 <ref>int</ref> | 934 <ref>int</ref> |
| 1948 <p> | 935 <p> |
| 1949 The priority of the change. The value is expected to be non-negative, | 936 The priority of the change. The value is expected to be non-negative, |
| 1950 and zero (0) is the lowest priority. | 937 and zero (0) is the lowest priority. |
| 1951 </p> | 938 </p> |
| 1952 </field> | 939 </field> |
| 1953 <field name="change"> | 940 <field name="change"> |
| 1954 <ref>SourceChange</ref> | 941 <ref>SourceChange</ref> |
| 1955 <p> | 942 <p> |
| 1956 The change with which the relevance is associated. | 943 The change with which the relevance is associated. |
| 1957 </p> | 944 </p> |
| 1958 </field> | 945 </field> |
| 1959 </object> | 946 </object> |
| 1960 </type> | 947 </type> |
| 1961 <type name="RefactoringFeedback"> | |
| 1962 <p> | |
| 1963 An abstract superclass of all refactoring feedbacks. | |
| 1964 </p> | |
| 1965 <object> | |
| 1966 </object> | |
| 1967 </type> | |
| 1968 <type name="RefactoringKind"> | |
| 1969 <p> | |
| 1970 An enumeration of the kinds of refactorings that can be created. | |
| 1971 </p> | |
| 1972 <enum> | |
| 1973 <value><code>CONVERT_GETTER_TO_METHOD</code></value> | |
| 1974 <value><code>CONVERT_METHOD_TO_GETTER</code></value> | |
| 1975 <value><code>EXTRACT_LOCAL_VARIABLE</code></value> | |
| 1976 <value><code>EXTRACT_METHOD</code></value> | |
| 1977 <value><code>INLINE_LOCAL_VARIABLE</code></value> | |
| 1978 <value><code>INLINE_METHOD</code></value> | |
| 1979 <value><code>MOVE_FILE</code></value> | |
| 1980 <value><code>RENAME</code></value> | |
| 1981 <value><code>SORT_MEMBERS</code></value> | |
| 1982 </enum> | |
| 1983 </type> | |
| 1984 <type name="RefactoringMethodParameter"> | |
| 1985 <!-- This type does not appear to be referenced yet. --> | |
| 1986 <p> | |
| 1987 A description of a parameter in a method refactoring. | |
| 1988 </p> | |
| 1989 <object> | |
| 1990 <field name="id" optional="true"> | |
| 1991 <ref>String</ref> | |
| 1992 <p> | |
| 1993 The unique identifier of the parameter. Clients may omit this field | |
| 1994 for the parameters they want to add. | |
| 1995 </p> | |
| 1996 </field> | |
| 1997 <field name="kind"> | |
| 1998 <ref>RefactoringMethodParameterKind</ref> | |
| 1999 <p> | |
| 2000 The kind of the parameter. | |
| 2001 </p> | |
| 2002 </field> | |
| 2003 <field name="type"> | |
| 2004 <ref>String</ref> | |
| 2005 <p> | |
| 2006 The type that should be given to the parameter, or the return type of | |
| 2007 the parameter's function type. | |
| 2008 </p> | |
| 2009 </field> | |
| 2010 <field name="name"> | |
| 2011 <ref>String</ref> | |
| 2012 <p> | |
| 2013 The name that should be given to the parameter. | |
| 2014 </p> | |
| 2015 </field> | |
| 2016 <field name="parameters" optional="true"> | |
| 2017 <ref>String</ref> | |
| 2018 <p> | |
| 2019 The parameter list of the parameter's function type. If the parameter | |
| 2020 is not of a function type, this field will not be defined. If the | |
| 2021 function type has zero parameters, this field will have a value of | |
| 2022 '()'. | |
| 2023 </p> | |
| 2024 </field> | |
| 2025 </object> | |
| 2026 </type> | |
| 2027 <type name="RefactoringOptions"> | |
| 2028 <p> | |
| 2029 An abstract superclass of all refactoring options. | |
| 2030 </p> | |
| 2031 <object> | |
| 2032 </object> | |
| 2033 </type> | |
| 2034 <type name="RefactoringMethodParameterKind"> | |
| 2035 <p> | |
| 2036 An enumeration of the kinds of parameters. | |
| 2037 </p> | |
| 2038 <enum> | |
| 2039 <value><code>REQUIRED</code></value> | |
| 2040 <value><code>POSITIONAL</code></value> | |
| 2041 <value><code>NAMED</code></value> | |
| 2042 </enum> | |
| 2043 </type> | |
| 2044 <type name="RefactoringProblem"> | |
| 2045 <p> | |
| 2046 A description of a problem related to a refactoring. | |
| 2047 </p> | |
| 2048 <object> | |
| 2049 <field name="severity"> | |
| 2050 <ref>RefactoringProblemSeverity</ref> | |
| 2051 <p> | |
| 2052 The severity of the problem being represented. | |
| 2053 </p> | |
| 2054 </field> | |
| 2055 <field name="message"> | |
| 2056 <ref>String</ref> | |
| 2057 <p> | |
| 2058 A human-readable description of the problem being represented. | |
| 2059 </p> | |
| 2060 </field> | |
| 2061 <field name="location" optional="true"> | |
| 2062 <ref>Location</ref> | |
| 2063 <p> | |
| 2064 The location of the problem being represented. This field is omitted | |
| 2065 unless there is a specific location associated with the problem (such | |
| 2066 as a location where an element being renamed will be shadowed). | |
| 2067 </p> | |
| 2068 </field> | |
| 2069 </object> | |
| 2070 </type> | |
| 2071 <type name="RefactoringProblemSeverity"> | |
| 2072 <p> | |
| 2073 An enumeration of the severities of problems that can be returned by the | |
| 2074 refactoring requests. | |
| 2075 </p> | |
| 2076 <enum> | |
| 2077 <value> | |
| 2078 <code>INFO</code> | |
| 2079 <p> | |
| 2080 A minor code problem. No example, because it is not used yet. | |
| 2081 </p> | |
| 2082 </value> | |
| 2083 <value> | |
| 2084 <code>WARNING</code> | |
| 2085 <p> | |
| 2086 A minor code problem. For example names of local variables should be | |
| 2087 camel case and start with a lower case letter. Staring the name of a | |
| 2088 variable with an upper case is OK from the language point of view, but | |
| 2089 it is nice to warn the user. | |
| 2090 </p> | |
| 2091 </value> | |
| 2092 <value> | |
| 2093 <code>ERROR</code> | |
| 2094 <p> | |
| 2095 The refactoring technically can be performed, but there is a logical | |
| 2096 problem. For example the name of a local variable being extracted | |
| 2097 conflicts with another name in the scope, or duplicate parameter names | |
| 2098 in the method being extracted, or a conflict between a parameter name | |
| 2099 and a local variable, etc. In some cases the location of the problem | |
| 2100 is also provided, so the IDE can show user the location and the | |
| 2101 problem, and let the user decide whether they want to perform the | |
| 2102 refactoring. For example the name conflict might be expected, and the | |
| 2103 user wants to fix it afterwards. | |
| 2104 </p> | |
| 2105 </value> | |
| 2106 <value> | |
| 2107 <code>FATAL</code> | |
| 2108 <p> | |
| 2109 A fatal error, which prevents performing the refactoring. For example | |
| 2110 the name of a local variable being extracted is not a valid | |
| 2111 identifier, or selection is not a valid expression. | |
| 2112 </p> | |
| 2113 </value> | |
| 2114 </enum> | |
| 2115 </type> | |
| 2116 <type name="RemoveContentOverlay"> | |
| 2117 <p> | |
| 2118 A directive to remove an existing file content overlay. After processing | |
| 2119 this directive, the file contents will once again be read from the file | |
| 2120 system. | |
| 2121 </p> | |
| 2122 <p> | |
| 2123 If this directive is used on a file that doesn't currently have a content | |
| 2124 overlay, it has no effect. | |
| 2125 </p> | |
| 2126 <object> | |
| 2127 <field name="type" value="remove"><ref>String</ref></field> | |
| 2128 </object> | |
| 2129 </type> | |
| 2130 <type name="RequestError"> | 948 <type name="RequestError"> |
| 2131 <p> | 949 <p> |
| 2132 An indication of a problem with the execution of the server, | 950 An indication of a problem with the execution of the server, |
| 2133 typically in response to a request. | 951 typically in response to a request. |
| 2134 </p> | 952 </p> |
| 2135 <object> | 953 <object> |
| 2136 <field name="code"> | 954 <field name="code"> |
| 2137 <ref>RequestErrorCode</ref> | 955 <ref>RequestErrorCode</ref> |
| 2138 <p> | 956 <p> |
| 2139 A code that uniquely identifies the error that occurred. | 957 A code that uniquely identifies the error that occurred. |
| (...skipping 163 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2303 <value> | 1121 <value> |
| 2304 <code>UNSUPPORTED_FEATURE</code> | 1122 <code>UNSUPPORTED_FEATURE</code> |
| 2305 <p> | 1123 <p> |
| 2306 The plugin received a requested to perform an action that is not | 1124 The plugin received a requested to perform an action that is not |
| 2307 supported. | 1125 supported. |
| 2308 </p> | 1126 </p> |
| 2309 </value> | 1127 </value> |
| 2310 --> | 1128 --> |
| 2311 </enum> | 1129 </enum> |
| 2312 </type> | 1130 </type> |
| 2313 <type name="SourceChange"> | |
| 2314 <p> | |
| 2315 A description of a set of edits that implement a single conceptual change. | |
| 2316 </p> | |
| 2317 <object> | |
| 2318 <field name="message"> | |
| 2319 <ref>String</ref> | |
| 2320 <p> | |
| 2321 A human-readable description of the change to be applied. | |
| 2322 </p> | |
| 2323 </field> | |
| 2324 <field name="edits"> | |
| 2325 <list><ref>SourceFileEdit</ref></list> | |
| 2326 <p> | |
| 2327 A list of the edits used to effect the change, grouped by file. | |
| 2328 </p> | |
| 2329 </field> | |
| 2330 <field name="linkedEditGroups"> | |
| 2331 <list><ref>LinkedEditGroup</ref></list> | |
| 2332 <p> | |
| 2333 A list of the linked editing groups used to customize the changes that | |
| 2334 were made. | |
| 2335 </p> | |
| 2336 </field> | |
| 2337 <field name="selection" optional="true"> | |
| 2338 <ref>Position</ref> | |
| 2339 <p> | |
| 2340 The position that should be selected after the edits have been | |
| 2341 applied. | |
| 2342 </p> | |
| 2343 </field> | |
| 2344 </object> | |
| 2345 </type> | |
| 2346 <type name="SourceEdit"> | |
| 2347 <p> | |
| 2348 A description of a single change to a single file. | |
| 2349 </p> | |
| 2350 <object> | |
| 2351 <field name="offset"> | |
| 2352 <ref>int</ref> | |
| 2353 <p> | |
| 2354 The offset of the region to be modified. | |
| 2355 </p> | |
| 2356 </field> | |
| 2357 <field name="length"> | |
| 2358 <ref>int</ref> | |
| 2359 <p> | |
| 2360 The length of the region to be modified. | |
| 2361 </p> | |
| 2362 </field> | |
| 2363 <field name="replacement"> | |
| 2364 <ref>String</ref> | |
| 2365 <p> | |
| 2366 The code that is to replace the specified region in the original code. | |
| 2367 </p> | |
| 2368 </field> | |
| 2369 <field name="id" optional="true"> | |
| 2370 <ref>String</ref> | |
| 2371 <p> | |
| 2372 An identifier that uniquely identifies this source edit from other | |
| 2373 edits in the same response. This field is omitted unless a containing | |
| 2374 structure needs to be able to identify the edit for some reason. | |
| 2375 </p> | |
| 2376 <p> | |
| 2377 For example, some refactoring operations can produce edits that might | |
| 2378 not be appropriate (referred to as potential edits). Such edits will | |
| 2379 have an id so that they can be referenced. Edits in the same response | |
| 2380 that do not need to be referenced will not have an id. | |
| 2381 </p> | |
| 2382 </field> | |
| 2383 </object> | |
| 2384 </type> | |
| 2385 <type name="SourceFileEdit"> | |
| 2386 <p> | |
| 2387 A description of a set of changes to a single file. | |
| 2388 </p> | |
| 2389 <object> | |
| 2390 <field name="file"> | |
| 2391 <ref>FilePath</ref> | |
| 2392 <p> | |
| 2393 The file containing the code to be modified. | |
| 2394 </p> | |
| 2395 </field> | |
| 2396 <field name="fileStamp"> | |
| 2397 <ref>long</ref> | |
| 2398 <p> | |
| 2399 The modification stamp of the file at the moment when the change was | |
| 2400 created, in milliseconds since the "Unix epoch". Will be -1 if the | |
| 2401 file did not exist and should be created. The client may use this | |
| 2402 field to make sure that the file was not changed since then, so it is | |
| 2403 safe to apply the change. | |
| 2404 </p> | |
| 2405 </field> | |
| 2406 <field name="edits"> | |
| 2407 <list><ref>SourceEdit</ref></list> | |
| 2408 <p> | |
| 2409 A list of the edits used to effect the change. | |
| 2410 </p> | |
| 2411 </field> | |
| 2412 </object> | |
| 2413 </type> | |
| 2414 <type name="WatchEvent"> | 1131 <type name="WatchEvent"> |
| 2415 <p> | 1132 <p> |
| 2416 A watch event sent by the server when the file system has been modified. | 1133 A watch event sent by the server when the file system has been modified. |
| 2417 </p> | 1134 </p> |
| 2418 <object> | 1135 <object> |
| 2419 <field name="type"> | 1136 <field name="type"> |
| 2420 <ref>WatchEventType</ref> | 1137 <ref>WatchEventType</ref> |
| 2421 <p> | 1138 <p> |
| 2422 The type of change represented by this event. | 1139 The type of change represented by this event. |
| 2423 </p> | 1140 </p> |
| (...skipping 389 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 2813 The name that the element should have after the refactoring. | 1530 The name that the element should have after the refactoring. |
| 2814 </p> | 1531 </p> |
| 2815 </field> | 1532 </field> |
| 2816 </options> | 1533 </options> |
| 2817 </refactoring> | 1534 </refactoring> |
| 2818 </refactorings> | 1535 </refactorings> |
| 2819 <h2 class="domain"><a name="index">Index</a></h2> | 1536 <h2 class="domain"><a name="index">Index</a></h2> |
| 2820 <index></index> | 1537 <index></index> |
| 2821 </body> | 1538 </body> |
| 2822 </html> | 1539 </html> |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 2876023003:
Allow the common spec types to be in a separate document (Closed)
