| 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 27 matching lines...) Expand all Loading... |
| 38 public void addAnalysisServerListener(AnalysisServerListener listener); | 38 public void addAnalysisServerListener(AnalysisServerListener listener); |
| 39 | 39 |
| 40 /** | 40 /** |
| 41 * {@code analysis.getErrors} | 41 * {@code analysis.getErrors} |
| 42 * | 42 * |
| 43 * Return the errors associated with the given file. If the errors for the giv
en file have not yet | 43 * Return the errors associated with the given file. If the errors for the giv
en file have not yet |
| 44 * been computed, or the most recently computed errors for the given file are
out of date, then the | 44 * been computed, or the most recently computed errors for the given file are
out of date, then the |
| 45 * response for this request will be delayed until they have been computed. If
some or all of the | 45 * response for this request will be delayed until they have been computed. If
some or all of the |
| 46 * errors for the file cannot be computed, then the subset of the errors that
can be computed will | 46 * errors for the file cannot be computed, then the subset of the errors that
can be computed will |
| 47 * be returned and the response will contain an error to indicate why the erro
rs could not be | 47 * be returned and the response will contain an error to indicate why the erro
rs could not be |
| 48 * computed. | 48 * computed. If the content of the file changes after this request was receive
d but before a |
| 49 * response could be sent, then an error of type CONTENT_MODIFIED will be gene
rated. |
| 49 * | 50 * |
| 50 * This request is intended to be used by clients that cannot asynchronously a
pply updated error | 51 * This request is intended to be used by clients that cannot asynchronously a
pply updated error |
| 51 * information. Clients that can apply error information as it becomes availab
le should use the | 52 * information. Clients that can apply error information as it becomes availab
le should use the |
| 52 * information provided by the 'analysis.errors' notification. | 53 * information provided by the 'analysis.errors' notification. |
| 53 * | 54 * |
| 54 * If a request is made for a file which does not exist, or which is not curre
ntly subject to | 55 * If a request is made for a file which does not exist, or which is not curre
ntly subject to |
| 55 * analysis (e.g. because it is not associated with any analysis root specifie
d to | 56 * analysis (e.g. because it is not associated with any analysis root specifie
d to |
| 56 * analysis.setAnalysisRoots), an error of type GET_ERRORS_INVALID_FILE will b
e generated. | 57 * analysis.setAnalysisRoots), an error of type GET_ERRORS_INVALID_FILE will b
e generated. |
| 57 * | 58 * |
| 58 * @param file The file for which errors are being requested. | 59 * @param file The file for which errors are being requested. |
| 59 */ | 60 */ |
| 60 public void analysis_getErrors(String file, GetErrorsConsumer consumer); | 61 public void analysis_getErrors(String file, GetErrorsConsumer consumer); |
| 61 | 62 |
| 62 /** | 63 /** |
| 63 * {@code analysis.getHover} | 64 * {@code analysis.getHover} |
| 64 * | 65 * |
| 65 * Return the hover information associate with the given location. If some or
all of the hover | 66 * Return the hover information associate with the given location. If some or
all of the hover |
| 66 * information is not available at the time this request is processed the info
rmation will be | 67 * information is not available at the time this request is processed the info
rmation will be |
| 67 * omitted from the response. | 68 * omitted from the response. |
| 68 * | 69 * |
| 69 * @param file The file in which hover information is being requested. | 70 * @param file The file in which hover information is being requested. |
| 70 * @param offset The offset for which hover information is being requested. | 71 * @param offset The offset for which hover information is being requested. |
| 71 */ | 72 */ |
| 72 public void analysis_getHover(String file, int offset, GetHoverConsumer consum
er); | 73 public void analysis_getHover(String file, int offset, GetHoverConsumer consum
er); |
| 73 | 74 |
| 74 /** | 75 /** |
| 76 * {@code analysis.getNavigation} |
| 77 * |
| 78 * Return the navigation information associated with the given region of the g
iven file. If the |
| 79 * navigation information for the given file has not yet been computed, or the
most recently |
| 80 * computed navigation information for the given file is out of date, then the
response for this |
| 81 * request will be delayed until it has been computed. If the content of the f
ile changes after |
| 82 * this request was received but before a response could be sent, then an erro
r of type |
| 83 * CONTENT_MODIFIED will be generated. |
| 84 * |
| 85 * If a navigation region overlaps (but extends either before or after) the gi
ven region of the |
| 86 * file it will be included in the result. This means that it is theoretically
possible to get the |
| 87 * same navigation region in response to multiple requests. Clients can avoid
this by always |
| 88 * choosing a region that starts at the beginning of a line and ends at the en
d of a (possibly |
| 89 * different) line in the file. |
| 90 * |
| 91 * @param file The file in which navigation information is being requested. |
| 92 * @param offset The offset of the region for which navigation information is
being requested. |
| 93 * @param length The length of the region for which navigation information is
being requested. |
| 94 */ |
| 95 public void analysis_getNavigation(String file, int offset, int length, GetNav
igationConsumer consumer); |
| 96 |
| 97 /** |
| 75 * {@code analysis.reanalyze} | 98 * {@code analysis.reanalyze} |
| 76 * | 99 * |
| 77 * Force the re-analysis of everything contained in the existing analysis root
s. This will cause | 100 * Force the re-analysis of everything contained in the existing analysis root
s. This will cause |
| 78 * all previously computed analysis results to be discarded and recomputed, an
d will cause all | 101 * all previously computed analysis results to be discarded and recomputed, an
d will cause all |
| 79 * subscribed notifications to be re-sent. | 102 * subscribed notifications to be re-sent. |
| 80 */ | 103 */ |
| 81 public void analysis_reanalyze(); | 104 public void analysis_reanalyze(); |
| 82 | 105 |
| 83 /** | 106 /** |
| 84 * {@code analysis.setAnalysisRoots} | 107 * {@code analysis.setAnalysisRoots} |
| (...skipping 334 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 419 * the response to this request has been sent. | 442 * the response to this request has been sent. |
| 420 */ | 443 */ |
| 421 public void server_shutdown(); | 444 public void server_shutdown(); |
| 422 | 445 |
| 423 /** | 446 /** |
| 424 * Start the analysis server. | 447 * Start the analysis server. |
| 425 */ | 448 */ |
| 426 public void start() throws Exception; | 449 public void start() throws Exception; |
| 427 | 450 |
| 428 } | 451 } |
| OLD | NEW |