| 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 85 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 96 * analyzing it. Similarly, server will stop analyzing files that are removed
from the file system | 96 * analyzing it. Similarly, server will stop analyzing files that are removed
from the file system |
| 97 * but they will remain in the set of requested roots. | 97 * but they will remain in the set of requested roots. |
| 98 * | 98 * |
| 99 * If an included path represents a file, then server will look in the directo
ry containing the | 99 * If an included path represents a file, then server will look in the directo
ry containing the |
| 100 * file for a pubspec.yaml file. If none is found, then the parents of the dir
ectory will be | 100 * file for a pubspec.yaml file. If none is found, then the parents of the dir
ectory will be |
| 101 * searched until such a file is found or the root of the file system is reach
ed. If such a file is | 101 * searched until such a file is found or the root of the file system is reach
ed. If such a file is |
| 102 * found, it will be used to resolve package: URI’s within the file. | 102 * found, it will be used to resolve package: URI’s within the file. |
| 103 * | 103 * |
| 104 * @param included A list of the files and directories that should be analyzed
. | 104 * @param included A list of the files and directories that should be analyzed
. |
| 105 * @param excluded A list of the files and directories within the included dir
ectories that should | 105 * @param excluded A list of the files and directories within the included dir
ectories that should |
| 106 * not be analyzed. | 106 * not be analyzed. |
| 107 */ | 107 */ |
| 108 // public void analysis_setAnalysisRoots(List<String> included, List<String> e
xcluded); | 108 // public void analysis_setAnalysisRoots(List<String> included, List<String> e
xcluded); |
| 109 | 109 |
| 110 /** | 110 /** |
| 111 * {@code analysis.setPriorityFiles} | 111 * {@code analysis.setPriorityFiles} |
| 112 * | 112 * |
| 113 * Set the priority files to the files in the given list. A priority file is a
file that is given | 113 * Set the priority files to the files in the given list. A priority file is a
file that is given |
| 114 * priority when scheduling which analysis work to do first. The list typicall
y contains those | 114 * priority when scheduling which analysis work to do first. The list typicall
y contains those |
| 115 * files that are visible to the user and those for which analysis results wil
l have the biggest | 115 * files that are visible to the user and those for which analysis results wil
l have the biggest |
| 116 * impact on the user experience. The order of the files within the list is si
gnificant: the first | 116 * impact on the user experience. The order of the files within the list is si
gnificant: the first |
| (...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 148 * subscriptions is unchanged. | 148 * subscriptions is unchanged. |
| 149 * | 149 * |
| 150 * If a requested subscription is a directory it is ignored, but remains in th
e set of requested | 150 * If a requested subscription is a directory it is ignored, but remains in th
e set of requested |
| 151 * subscriptions so that if it later becomes a file it can be included in the
set of actual | 151 * subscriptions so that if it later becomes a file it can be included in the
set of actual |
| 152 * subscriptions. | 152 * subscriptions. |
| 153 * | 153 * |
| 154 * It is an error if any of the keys in the map are not valid services. If the
re is an error, then | 154 * It is an error if any of the keys in the map are not valid services. If the
re is an error, then |
| 155 * the existing subscriptions will remain unchanged. | 155 * the existing subscriptions will remain unchanged. |
| 156 * | 156 * |
| 157 * @param subscriptions A table mapping services to a list of the files being
subscribed to the | 157 * @param subscriptions A table mapping services to a list of the files being
subscribed to the |
| 158 * service. | 158 * service. |
| 159 */ | 159 */ |
| 160 // public void analysis_setSubscriptions(Map<String, List<String>> subscriptio
ns); | 160 // public void analysis_setSubscriptions(Map<String, List<String>> subscriptio
ns); |
| 161 | 161 |
| 162 /** | 162 /** |
| 163 * {@code analysis.updateContent} | 163 * {@code analysis.updateContent} |
| 164 * | 164 * |
| 165 * Update the content of one or more files. Files that were previously updated
but not included in | 165 * Update the content of one or more files. Files that were previously updated
but not included in |
| 166 * this update remain unchanged. This effectively represents an overlay of the
filesystem. The | 166 * this update remain unchanged. This effectively represents an overlay of the
filesystem. The |
| 167 * files whose content is overridden are therefore seen by server as being fil
es with the given | 167 * files whose content is overridden are therefore seen by server as being fil
es with the given |
| 168 * content, even if the files do not exist on the filesystem or if the file pa
th represents the | 168 * content, even if the files do not exist on the filesystem or if the file pa
th represents the |
| 169 * path to a directory on the filesystem. | 169 * path to a directory on the filesystem. |
| 170 * | 170 * |
| 171 * @param files A table mapping the files whose content has changed to a descr
iption of the content | 171 * @param files A table mapping the files whose content has changed to a descr
iption of the content |
| 172 * change. Each value should be one of the following types: AddContentOverlay, | 172 * change. Each value should be one of the following types: AddContent
Overlay, |
| 173 * ChangeContentOverlay, or RemoveContentOverlay. | 173 * ChangeContentOverlay, or RemoveContentOverlay. |
| 174 */ | 174 */ |
| 175 // public void analysis_updateContent(Map<String, Object> files); | 175 // public void analysis_updateContent(Map<String, Object> files); |
| 176 | 176 |
| 177 /** | 177 /** |
| 178 * {@code analysis.updateOptions} | 178 * {@code analysis.updateOptions} |
| 179 * | 179 * |
| 180 * Update the options controlling analysis based on the given set of options.
Any options that are | 180 * Update the options controlling analysis based on the given set of options.
Any options that are |
| 181 * not included in the analysis options will not be changed. If there are opti
ons in the analysis | 181 * not included in the analysis options will not be changed. If there are opti
ons in the analysis |
| 182 * options that are not valid an error will be reported but the values of the
valid options will | 182 * options that are not valid an error will be reported but the values of the
valid options will |
| 183 * still be updated. | 183 * still be updated. |
| (...skipping 97 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 281 /** | 281 /** |
| 282 * {@code edit.getRefactoring} | 282 * {@code edit.getRefactoring} |
| 283 * | 283 * |
| 284 * Get the changes required to perform a refactoring. | 284 * Get the changes required to perform a refactoring. |
| 285 * | 285 * |
| 286 * @param kindId The identifier of the kind of refactoring to be performed. | 286 * @param kindId The identifier of the kind of refactoring to be performed. |
| 287 * @param file The file containing the code involved in the refactoring. | 287 * @param file The file containing the code involved in the refactoring. |
| 288 * @param offset The offset of the region involved in the refactoring. | 288 * @param offset The offset of the region involved in the refactoring. |
| 289 * @param length The length of the region involved in the refactoring. | 289 * @param length The length of the region involved in the refactoring. |
| 290 * @param validateOnly True if the client is only requesting that the values o
f the options be | 290 * @param validateOnly True if the client is only requesting that the values o
f the options be |
| 291 * validated and no change be generated. | 291 * validated and no change be generated. |
| 292 * @param options Data used to provide values provided by the user. The struct
ure of the data is | 292 * @param options Data used to provide values provided by the user. The struct
ure of the data is |
| 293 * dependent on the kind of refactoring being performed. The data that is expe
cted is documented in | 293 * dependent on the kind of refactoring being performed. The data that
is expected is |
| 294 * the section titled Refactorings, labeled as “Options”. This field can be om
itted if the | 294 * documented in the section titled Refactorings, labeled as “Options”
. This field can be |
| 295 * refactoring does not require any options or if the values of those options
are not known. | 295 * omitted if the refactoring does not require any options or if the v
alues of those |
| 296 * options are not known. |
| 296 */ | 297 */ |
| 297 // public void edit_getRefactoring(String kindId, String file, int offset, int
length, boolean validateOnly, Object options, GetRefactoringConsumer consumer); | 298 // public void edit_getRefactoring(String kindId, String file, int offset, int
length, boolean validateOnly, Object options, GetRefactoringConsumer consumer); |
| 298 | 299 |
| 299 /** | 300 /** |
| 300 * {@code search.findElementReferences} | 301 * {@code search.findElementReferences} |
| 301 * | 302 * |
| 302 * Perform a search for references to the element defined or referenced at the
given offset in the | 303 * Perform a search for references to the element defined or referenced at the
given offset in the |
| 303 * given file. | 304 * given file. |
| 304 * | 305 * |
| 305 * An identifier is returned immediately, and individual results will be retur
ned via the | 306 * An identifier is returned immediately, and individual results will be retur
ned via the |
| 306 * search.results notification as they become available. | 307 * search.results notification as they become available. |
| 307 * | 308 * |
| 308 * @param file The file containing the declaration of or reference to the elem
ent used to define | 309 * @param file The file containing the declaration of or reference to the elem
ent used to define |
| 309 * the search. | 310 * the search. |
| 310 * @param offset The offset within the file of the declaration of or reference
to the element. | 311 * @param offset The offset within the file of the declaration of or reference
to the element. |
| 311 * @param includePotential True if potential matches are to be included in the
results. | 312 * @param includePotential True if potential matches are to be included in the
results. |
| 312 */ | 313 */ |
| 313 // public void search_findElementReferences(String file, int offset, boolean i
ncludePotential, FindElementReferencesConsumer consumer); | 314 // public void search_findElementReferences(String file, int offset, boolean i
ncludePotential, FindElementReferencesConsumer consumer); |
| 314 | 315 |
| 315 /** | 316 /** |
| 316 * {@code search.findMemberDeclarations} | 317 * {@code search.findMemberDeclarations} |
| 317 * | 318 * |
| 318 * Perform a search for declarations of members whose name is equal to the giv
en name. | 319 * Perform a search for declarations of members whose name is equal to the giv
en name. |
| 319 * | 320 * |
| (...skipping 30 matching lines...) Expand all Loading... |
| 350 * @param pattern The regular expression used to match the names of the declar
ations to be found. | 351 * @param pattern The regular expression used to match the names of the declar
ations to be found. |
| 351 */ | 352 */ |
| 352 // public void search_findTopLevelDeclarations(String pattern, FindTopLevelDec
larationsConsumer consumer); | 353 // public void search_findTopLevelDeclarations(String pattern, FindTopLevelDec
larationsConsumer consumer); |
| 353 | 354 |
| 354 /** | 355 /** |
| 355 * {@code search.getTypeHierarchy} | 356 * {@code search.getTypeHierarchy} |
| 356 * | 357 * |
| 357 * Return the type hierarchy of the class declared or referenced at the given
location. | 358 * Return the type hierarchy of the class declared or referenced at the given
location. |
| 358 * | 359 * |
| 359 * @param file The file containing the declaration or reference to the type fo
r which a hierarchy | 360 * @param file The file containing the declaration or reference to the type fo
r which a hierarchy |
| 360 * is being requested. | 361 * is being requested. |
| 361 * @param offset The offset of the name of the type within the file. | 362 * @param offset The offset of the name of the type within the file. |
| 362 */ | 363 */ |
| 363 // public void search_getTypeHierarchy(String file, int offset, GetTypeHierarc
hyConsumer consumer); | 364 // public void search_getTypeHierarchy(String file, int offset, GetTypeHierarc
hyConsumer consumer); |
| 364 | 365 |
| 365 /** | 366 /** |
| 366 * {@code server.getVersion} | 367 * {@code server.getVersion} |
| 367 * | 368 * |
| 368 * Return the version number of the analysis server. | 369 * Return the version number of the analysis server. |
| 369 */ | 370 */ |
| 370 // public void server_getVersion(GetVersionConsumer consumer); | 371 // public void server_getVersion(GetVersionConsumer consumer); |
| (...skipping 13 matching lines...) Expand all Loading... |
| 384 /** | 385 /** |
| 385 * {@code server.shutdown} | 386 * {@code server.shutdown} |
| 386 * | 387 * |
| 387 * Cleanly shutdown the analysis server. Requests that are received after this
request will not be | 388 * Cleanly shutdown the analysis server. Requests that are received after this
request will not be |
| 388 * processed. Requests that were received before this request, but for which a
response has not yet | 389 * processed. Requests that were received before this request, but for which a
response has not yet |
| 389 * been sent, will not be responded to. No further responses or notifications
will be sent after | 390 * been sent, will not be responded to. No further responses or notifications
will be sent after |
| 390 * the response to this request has been sent. | 391 * the response to this request has been sent. |
| 391 */ | 392 */ |
| 392 // public void server_shutdown(); | 393 // public void server_shutdown(); |
| 393 } | 394 } |
| OLD | NEW |