OLD | NEW |
1 /* | 1 /* |
2 * Copyright (c) 2014, the Dart project authors. | 2 * Copyright (c) 2014, the Dart project authors. |
3 * | 3 * |
4 * Licensed under the Eclipse Public License v1.0 (the "License"); you may not u
se this file except | 4 * Licensed under the Eclipse Public License v1.0 (the "License"); you may not u
se this file except |
5 * in compliance with the License. You may obtain a copy of the License at | 5 * in compliance with the License. You may obtain a copy of the License at |
6 * | 6 * |
7 * http://www.eclipse.org/legal/epl-v10.html | 7 * http://www.eclipse.org/legal/epl-v10.html |
8 * | 8 * |
9 * Unless required by applicable law or agreed to in writing, software distribut
ed under the License | 9 * Unless required by applicable law or agreed to in writing, software distribut
ed under the License |
10 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY K
IND, either express | 10 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY K
IND, either express |
(...skipping 68 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
79 * @param file The file in which hover information is being requested. | 79 * @param file The file in which hover information is being requested. |
80 * @param offset The offset for which hover information is being requested. | 80 * @param offset The offset for which hover information is being requested. |
81 */ | 81 */ |
82 public void analysis_getHover(String file, int offset, GetHoverConsumer consum
er); | 82 public void analysis_getHover(String file, int offset, GetHoverConsumer consum
er); |
83 | 83 |
84 /** | 84 /** |
85 * {@code analysis.getLibraryDependencies} | 85 * {@code analysis.getLibraryDependencies} |
86 * | 86 * |
87 * Return library dependency information for use in client-side indexing and p
ackage URI | 87 * Return library dependency information for use in client-side indexing and p
ackage URI |
88 * resolution. | 88 * resolution. |
| 89 * |
| 90 * Clients that are only using the libraries field should consider using the a
nalyzedFiles |
| 91 * notification instead. |
89 */ | 92 */ |
90 public void analysis_getLibraryDependencies(GetLibraryDependenciesConsumer con
sumer); | 93 public void analysis_getLibraryDependencies(GetLibraryDependenciesConsumer con
sumer); |
91 | 94 |
92 /** | 95 /** |
93 * {@code analysis.getNavigation} | 96 * {@code analysis.getNavigation} |
94 * | 97 * |
95 * Return the navigation information associated with the given region of the g
iven file. If the | 98 * Return the navigation information associated with the given region of the g
iven file. If the |
96 * navigation information for the given file has not yet been computed, or the
most recently | 99 * navigation information for the given file has not yet been computed, or the
most recently |
97 * computed navigation information for the given file is out of date, then the
response for this | 100 * computed navigation information for the given file is out of date, then the
response for this |
98 * request will be delayed until it has been computed. If the content of the f
ile changes after | 101 * request will be delayed until it has been computed. If the content of the f
ile changes after |
(...skipping 64 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
163 * package: URI to the corresponding path within the target directory.
The effect is the | 166 * package: URI to the corresponding path within the target directory.
The effect is the |
164 * same as specifying the target directory as a "--package_root" param
eter to the Dart VM | 167 * same as specifying the target directory as a "--package_root" param
eter to the Dart VM |
165 * when executing any Dart file inside the source directory. Files in
any directories that | 168 * when executing any Dart file inside the source directory. Files in
any directories that |
166 * are not overridden by this mapping have their package: URI's resolv
ed using the normal | 169 * are not overridden by this mapping have their package: URI's resolv
ed using the normal |
167 * pubspec.yaml mechanism. If this field is absent, or the empty map i
s specified, that | 170 * pubspec.yaml mechanism. If this field is absent, or the empty map i
s specified, that |
168 * indicates that the normal pubspec.yaml mechanism should always be u
sed. | 171 * indicates that the normal pubspec.yaml mechanism should always be u
sed. |
169 */ | 172 */ |
170 public void analysis_setAnalysisRoots(List<String> included, List<String> excl
uded, Map<String, String> packageRoots); | 173 public void analysis_setAnalysisRoots(List<String> included, List<String> excl
uded, Map<String, String> packageRoots); |
171 | 174 |
172 /** | 175 /** |
| 176 * {@code analysis.setGeneralSubscriptions} |
| 177 * |
| 178 * Subscribe for general services (that is, services that are not specific to
individual files). |
| 179 * All previous subscriptions are replaced by the given set of services. |
| 180 * |
| 181 * It is an error if any of the elements in the list are not valid services. I
f there is an error, |
| 182 * then the current subscriptions will remain unchanged. |
| 183 * |
| 184 * @param subscriptions A list of the services being subscribed to. |
| 185 */ |
| 186 public void analysis_setGeneralSubscriptions(List<String> subscriptions); |
| 187 |
| 188 /** |
173 * {@code analysis.setPriorityFiles} | 189 * {@code analysis.setPriorityFiles} |
174 * | 190 * |
175 * Set the priority files to the files in the given list. A priority file is a
file that is given | 191 * Set the priority files to the files in the given list. A priority file is a
file that is given |
176 * priority when scheduling which analysis work to do first. The list typicall
y contains those | 192 * priority when scheduling which analysis work to do first. The list typicall
y contains those |
177 * files that are visible to the user and those for which analysis results wil
l have the biggest | 193 * files that are visible to the user and those for which analysis results wil
l have the biggest |
178 * impact on the user experience. The order of the files within the list is si
gnificant: the first | 194 * impact on the user experience. The order of the files within the list is si
gnificant: the first |
179 * file will be given higher priority than the second, the second higher prior
ity than the third, | 195 * file will be given higher priority than the second, the second higher prior
ity than the third, |
180 * and so on. | 196 * and so on. |
181 * | 197 * |
182 * Note that this request determines the set of requested priority files. The
actual set of | 198 * Note that this request determines the set of requested priority files. The
actual set of |
183 * priority files is the intersection of the requested set of priority files w
ith the set of files | 199 * priority files is the intersection of the requested set of priority files w
ith the set of files |
184 * currently subject to analysis. (See analysis.setSubscriptions for a descrip
tion of files that | 200 * currently subject to analysis. (See analysis.setSubscriptions for a descrip
tion of files that |
185 * are subject to analysis.) | 201 * are subject to analysis.) |
186 * | 202 * |
187 * If a requested priority file is a directory it is ignored, but remains in t
he set of requested | 203 * If a requested priority file is a directory it is ignored, but remains in t
he set of requested |
188 * priority files so that if it later becomes a file it can be included in the
set of actual | 204 * priority files so that if it later becomes a file it can be included in the
set of actual |
189 * priority files. | 205 * priority files. |
190 * | 206 * |
191 * @param files The files that are to be a priority for analysis. | 207 * @param files The files that are to be a priority for analysis. |
192 */ | 208 */ |
193 public void analysis_setPriorityFiles(List<String> files); | 209 public void analysis_setPriorityFiles(List<String> files); |
194 | 210 |
195 /** | 211 /** |
196 * {@code analysis.setSubscriptions} | 212 * {@code analysis.setSubscriptions} |
197 * | 213 * |
198 * Subscribe for services. All previous subscriptions are replaced by the curr
ent set of | 214 * Subscribe for services that are specific to individual files. All previous
subscriptions are |
199 * subscriptions. If a given service is not included as a key in the map then
no files will be | 215 * replaced by the current set of subscriptions. If a given service is not inc
luded as a key in the |
200 * subscribed to the service, exactly as if the service had been included in t
he map with an | 216 * map then no files will be subscribed to the service, exactly as if the serv
ice had been included |
201 * explicit empty list of files. | 217 * in the map with an explicit empty list of files. |
202 * | 218 * |
203 * Note that this request determines the set of requested subscriptions. The a
ctual set of | 219 * Note that this request determines the set of requested subscriptions. The a
ctual set of |
204 * subscriptions at any given time is the intersection of this set with the se
t of files currently | 220 * subscriptions at any given time is the intersection of this set with the se
t of files currently |
205 * subject to analysis. The files currently subject to analysis are the set of
files contained | 221 * subject to analysis. The files currently subject to analysis are the set of
files contained |
206 * within an actual analysis root but not excluded, plus all of the files tran
sitively reachable | 222 * within an actual analysis root but not excluded, plus all of the files tran
sitively reachable |
207 * from those files via import, export and part directives. (See analysis.setA
nalysisRoots for an | 223 * from those files via import, export and part directives. (See analysis.setA
nalysisRoots for an |
208 * explanation of how the actual analysis roots are determined.) When the actu
al analysis roots | 224 * explanation of how the actual analysis roots are determined.) When the actu
al analysis roots |
209 * change, the actual set of subscriptions is automatically updated, but the s
et of requested | 225 * change, the actual set of subscriptions is automatically updated, but the s
et of requested |
210 * subscriptions is unchanged. | 226 * subscriptions is unchanged. |
211 * | 227 * |
(...skipping 304 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
516 * the response to this request has been sent. | 532 * the response to this request has been sent. |
517 */ | 533 */ |
518 public void server_shutdown(); | 534 public void server_shutdown(); |
519 | 535 |
520 /** | 536 /** |
521 * Start the analysis server. | 537 * Start the analysis server. |
522 */ | 538 */ |
523 public void start() throws Exception; | 539 public void start() throws Exception; |
524 | 540 |
525 } | 541 } |
OLD | NEW |