author | rfield |
Fri, 01 Jul 2016 14:41:07 -0700 | |
changeset 39370 | 437ba9bd2582 |
parent 38908 | f0c186d76c8a |
child 40498 | f54048be4a57 |
permissions | -rw-r--r-- |
33362 | 1 |
/* |
2 |
* Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved. |
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
7 |
* published by the Free Software Foundation. Oracle designates this |
|
8 |
* particular file as subject to the "Classpath" exception as provided |
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
|
10 |
* |
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
24 |
*/ |
|
25 |
||
26 |
package jdk.jshell; |
|
27 |
||
39370
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
28 |
import java.util.Collection; |
33362 | 29 |
import java.util.List; |
30 |
||
31 |
/** |
|
32 |
* Provides analysis utilities for source code input. |
|
33 |
* Optional functionality that provides for a richer interactive experience. |
|
34 |
* Includes completion analysis: |
|
35 |
* Is the input a complete snippet of code? |
|
36 |
* Do I need to prompt for more input? |
|
37 |
* Would adding a semicolon make it complete? |
|
38 |
* Is there more than one snippet? |
|
39 |
* etc. |
|
40 |
* Also includes completion suggestions, as might be used in tab-completion. |
|
41 |
* |
|
42 |
*/ |
|
43 |
public abstract class SourceCodeAnalysis { |
|
44 |
||
45 |
/** |
|
46 |
* Given an input string, find the first snippet of code (one statement, |
|
47 |
* definition, import, or expression) and evaluate if it is complete. |
|
48 |
* @param input the input source string |
|
49 |
* @return a CompletionInfo instance with location and completeness info |
|
50 |
*/ |
|
51 |
public abstract CompletionInfo analyzeCompletion(String input); |
|
52 |
||
53 |
/** |
|
54 |
* Compute possible follow-ups for the given input. |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
55 |
* Uses information from the current {@code JShell} state, including |
33362 | 56 |
* type information, to filter the suggestions. |
57 |
* @param input the user input, so far |
|
58 |
* @param cursor the current position of the cursors in the given {@code input} text |
|
59 |
* @param anchor outgoing parameter - when an option will be completed, the text between |
|
60 |
* the anchor and cursor will be deleted and replaced with the given option |
|
61 |
* @return list of candidate continuations of the given input. |
|
62 |
*/ |
|
63 |
public abstract List<Suggestion> completionSuggestions(String input, int cursor, int[] anchor); |
|
64 |
||
65 |
/** |
|
66 |
* Compute a description/help string for the given user's input. |
|
67 |
* @param input the snippet the user wrote so far |
|
68 |
* @param cursor the current position of the cursors in the given {@code input} text |
|
69 |
* @return description/help string for the given user's input |
|
70 |
*/ |
|
71 |
public abstract String documentation(String input, int cursor); |
|
72 |
||
73 |
/** |
|
36160
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
74 |
* Infer the type of the given expression. The expression spans from the beginning of {@code code} |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
75 |
* to the given {@code cursor} position. Returns null if the type of the expression cannot |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
76 |
* be inferred. |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
77 |
* |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
78 |
* @param code the expression for which the type should be inferred |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
79 |
* @param cursor current cursor position in the given code |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
80 |
* @return the inferred type, or null if it cannot be inferred |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
81 |
*/ |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
82 |
public abstract String analyzeType(String code, int cursor); |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
83 |
|
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
84 |
/** |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
85 |
* List qualified names known for the simple name in the given code immediately |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
86 |
* to the left of the given cursor position. The qualified names are gathered by inspecting the |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
87 |
* classpath used by eval (see {@link JShell#addToClasspath(java.lang.String)}). |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
88 |
* |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
89 |
* @param code the expression for which the candidate qualified names should be computed |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
90 |
* @param cursor current cursor position in the given code |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
91 |
* @return the known qualified names |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
92 |
*/ |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
93 |
public abstract QualifiedNames listQualifiedNames(String code, int cursor); |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
94 |
|
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
95 |
/** |
39370
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
96 |
* Returns the wrapper information for the {@code Snippet}. The wrapper changes as |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
97 |
* the environment changes, so calls to this method at different times may |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
98 |
* yield different results. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
99 |
* |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
100 |
* @param snippet the {@code Snippet} from which to retrieve the wrapper |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
101 |
* @return information on the wrapper |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
102 |
*/ |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
103 |
public abstract SnippetWrapper wrapper(Snippet snippet); |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
104 |
|
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
105 |
/** |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
106 |
* Returns the wrapper information for the snippet within the |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
107 |
* input source string. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
108 |
* <p> |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
109 |
* Wrapper information for malformed and incomplete |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
110 |
* snippets also generate wrappers. The list is in snippet encounter |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
111 |
* order. The wrapper changes as the environment changes, so calls to this |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
112 |
* method at different times may yield different results. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
113 |
* <p> |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
114 |
* The input should be |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
115 |
* exactly one complete snippet of source code, that is, one expression, |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
116 |
* statement, variable declaration, method declaration, class declaration, |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
117 |
* or import. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
118 |
* To break arbitrary input into individual complete snippets, use |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
119 |
* {@link SourceCodeAnalysis#analyzeCompletion(String)}. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
120 |
* <p> |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
121 |
* The wrapper may not match that returned by |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
122 |
* {@link SourceCodeAnalysis#wrapper(Snippet) wrapper(Snippet)}, |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
123 |
* were the source converted to a {@code Snippet}. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
124 |
* |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
125 |
* @param input the source input from which to generate wrappers |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
126 |
* @return a list of wrapper information |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
127 |
*/ |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
128 |
public abstract List<SnippetWrapper> wrappers(String input); |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
129 |
|
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
130 |
/** |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
131 |
* Returns a collection of {@code Snippet}s which might need updating if the |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
132 |
* given {@code Snippet} is updated. The returned collection is designed to |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
133 |
* be inclusive and may include many false positives. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
134 |
* |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
135 |
* @param snippet the {@code Snippet} whose dependents are requested |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
136 |
* @return the collection of dependents |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
137 |
*/ |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
138 |
public abstract Collection<Snippet> dependents(Snippet snippet); |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
139 |
|
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
140 |
/** |
33362 | 141 |
* Internal only constructor |
142 |
*/ |
|
143 |
SourceCodeAnalysis() {} |
|
144 |
||
145 |
/** |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
146 |
* The result of {@code analyzeCompletion(String input)}. |
33362 | 147 |
* Describes the completeness and position of the first snippet in the given input. |
148 |
*/ |
|
149 |
public static class CompletionInfo { |
|
150 |
||
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
151 |
private final Completeness completeness; |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
152 |
private final int unitEndPos; |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
153 |
private final String source; |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
154 |
private final String remaining; |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
155 |
|
36160
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
156 |
CompletionInfo(Completeness completeness, int unitEndPos, String source, String remaining) { |
33362 | 157 |
this.completeness = completeness; |
158 |
this.unitEndPos = unitEndPos; |
|
159 |
this.source = source; |
|
160 |
this.remaining = remaining; |
|
161 |
} |
|
162 |
||
163 |
/** |
|
164 |
* The analyzed completeness of the input. |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
165 |
* |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
166 |
* @return an enum describing the completeness of the input string. |
33362 | 167 |
*/ |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
168 |
public Completeness completeness() { |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
169 |
return completeness; |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
170 |
} |
33362 | 171 |
|
172 |
/** |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
173 |
* Input remaining after the complete part of the source. |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
174 |
* |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
175 |
* @return the portion of the input string that remains after the |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
176 |
* complete Snippet |
33362 | 177 |
*/ |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
178 |
public String remaining() { |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
179 |
return remaining; |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
180 |
} |
33362 | 181 |
|
182 |
/** |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
183 |
* Source code for the first Snippet of code input. For example, first |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
184 |
* statement, or first method declaration. Trailing semicolons will be |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
185 |
* added, as needed. |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
186 |
* |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
187 |
* @return the source of the first encountered Snippet |
33362 | 188 |
*/ |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
189 |
public String source() { |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
190 |
return source; |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
191 |
} |
33362 | 192 |
|
193 |
/** |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
194 |
* The end of the first Snippet of source. |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
195 |
* |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
196 |
* @return the position of the end of the first Snippet in the input. |
33362 | 197 |
*/ |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
198 |
public int unitEndPos() { |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
199 |
return unitEndPos; |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
200 |
} |
33362 | 201 |
} |
202 |
||
203 |
/** |
|
204 |
* Describes the completeness of the given input. |
|
205 |
*/ |
|
206 |
public enum Completeness { |
|
207 |
/** |
|
208 |
* The input is a complete source snippet (declaration or statement) as is. |
|
209 |
*/ |
|
210 |
COMPLETE(true), |
|
211 |
||
212 |
/** |
|
213 |
* With this addition of a semicolon the input is a complete source snippet. |
|
214 |
* This will only be returned when the end of input is encountered. |
|
215 |
*/ |
|
216 |
COMPLETE_WITH_SEMI(true), |
|
217 |
||
218 |
/** |
|
219 |
* There must be further source beyond the given input in order for it |
|
220 |
* to be complete. A semicolon would not complete it. |
|
221 |
* This will only be returned when the end of input is encountered. |
|
222 |
*/ |
|
223 |
DEFINITELY_INCOMPLETE(false), |
|
224 |
||
225 |
/** |
|
226 |
* A statement with a trailing (non-terminated) empty statement. |
|
227 |
* Though technically it would be a complete statement |
|
228 |
* with the addition of a semicolon, it is rare |
|
229 |
* that that assumption is the desired behavior. |
|
230 |
* The input is considered incomplete. Comments and white-space are |
|
231 |
* still considered empty. |
|
232 |
*/ |
|
233 |
CONSIDERED_INCOMPLETE(false), |
|
234 |
||
235 |
||
236 |
/** |
|
237 |
* An empty input. |
|
238 |
* The input is considered incomplete. Comments and white-space are |
|
239 |
* still considered empty. |
|
240 |
*/ |
|
241 |
EMPTY(false), |
|
242 |
||
243 |
/** |
|
244 |
* The completeness of the input could not be determined because it |
|
245 |
* contains errors. Error detection is not a goal of completeness |
|
246 |
* analysis, however errors interfered with determining its completeness. |
|
247 |
* The input is considered complete because evaluating is the best |
|
248 |
* mechanism to get error information. |
|
249 |
*/ |
|
250 |
UNKNOWN(true); |
|
251 |
||
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
252 |
private final boolean isComplete; |
33362 | 253 |
|
254 |
Completeness(boolean isComplete) { |
|
255 |
this.isComplete = isComplete; |
|
256 |
} |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
257 |
|
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
258 |
/** |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
259 |
* Indicates whether the first snippet of source is complete. |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
260 |
* For example, "{@code x=}" is not |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
261 |
* complete, but "{@code x=2}" is complete, even though a subsequent line could |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
262 |
* make it "{@code x=2+2}". Already erroneous code is marked complete. |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
263 |
* |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
264 |
* @return {@code true} if the input is or begins a complete Snippet; |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
265 |
* otherwise {@code false} |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
266 |
*/ |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
267 |
public boolean isComplete() { |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
268 |
return isComplete; |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
269 |
} |
33362 | 270 |
} |
271 |
||
272 |
/** |
|
273 |
* A candidate for continuation of the given user's input. |
|
274 |
*/ |
|
275 |
public static class Suggestion { |
|
276 |
||
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
277 |
private final String continuation; |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
278 |
private final boolean matchesType; |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
279 |
|
33362 | 280 |
/** |
281 |
* Create a {@code Suggestion} instance. |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
282 |
* |
33362 | 283 |
* @param continuation a candidate continuation of the user's input |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
284 |
* @param matchesType does the candidate match the target type |
33362 | 285 |
*/ |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
286 |
public Suggestion(String continuation, boolean matchesType) { |
33362 | 287 |
this.continuation = continuation; |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
288 |
this.matchesType = matchesType; |
33362 | 289 |
} |
290 |
||
291 |
/** |
|
292 |
* The candidate continuation of the given user's input. |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
293 |
* |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
294 |
* @return the continuation string |
33362 | 295 |
*/ |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
296 |
public String continuation() { |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
297 |
return continuation; |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
298 |
} |
33362 | 299 |
|
300 |
/** |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
301 |
* Indicates whether input continuation matches the target type and is thus |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
302 |
* more likely to be the desired continuation. A matching continuation is |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
303 |
* preferred. |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
304 |
* |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
305 |
* @return {@code true} if this suggested continuation matches the |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
306 |
* target type; otherwise {@code false} |
33362 | 307 |
*/ |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
308 |
public boolean matchesType() { |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
309 |
return matchesType; |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
310 |
} |
33362 | 311 |
} |
36160
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
312 |
|
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
313 |
/** |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
314 |
* List of possible qualified names. |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
315 |
*/ |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
316 |
public static final class QualifiedNames { |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
317 |
|
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
318 |
private final List<String> names; |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
319 |
private final int simpleNameLength; |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
320 |
private final boolean upToDate; |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
321 |
private final boolean resolvable; |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
322 |
|
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
323 |
QualifiedNames(List<String> names, int simpleNameLength, boolean upToDate, boolean resolvable) { |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
324 |
this.names = names; |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
325 |
this.simpleNameLength = simpleNameLength; |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
326 |
this.upToDate = upToDate; |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
327 |
this.resolvable = resolvable; |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
328 |
} |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
329 |
|
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
330 |
/** |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
331 |
* Known qualified names for the given simple name in the original code. |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
332 |
* |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
333 |
* @return known qualified names |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
334 |
*/ |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
335 |
public List<String> getNames() { |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
336 |
return names; |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
337 |
} |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
338 |
|
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
339 |
/** |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
340 |
* The length of the simple name in the original code for which the |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
341 |
* qualified names where gathered. |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
342 |
* |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
343 |
* @return the length of the simple name; -1 if there is no name immediately left to the cursor for |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
344 |
* which the candidates could be computed |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
345 |
*/ |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
346 |
public int getSimpleNameLength() { |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
347 |
return simpleNameLength; |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
348 |
} |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
349 |
|
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
350 |
/** |
39370
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
351 |
* Indicates whether the result is based on up-to-date data. The |
36160
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
352 |
* {@link SourceCodeAnalysis#listQualifiedNames(java.lang.String, int) listQualifiedNames} |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
353 |
* method may return before the classpath is fully inspected, in which case this method will |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
354 |
* return {@code false}. If the result is based on a fully inspected classpath, this method |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
355 |
* will return {@code true}. |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
356 |
* |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
357 |
* @return {@code true} if the result is based on up-to-date data; |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
358 |
* otherwise {@code false} |
36160
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
359 |
*/ |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
360 |
public boolean isUpToDate() { |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
361 |
return upToDate; |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
362 |
} |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
363 |
|
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
364 |
/** |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
365 |
* Indicates whether the given simple name in the original code refers |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
366 |
* to a resolvable element. |
36160
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
367 |
* |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
368 |
* @return {@code true} if the given simple name in the original code |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
36160
diff
changeset
|
369 |
* refers to a resolvable element; otherwise {@code false} |
36160
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
370 |
*/ |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
371 |
public boolean isResolvable() { |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
372 |
return resolvable; |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
373 |
} |
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
374 |
|
f42d362d0d17
8131027: JShell API/tool: suggest imports for a class
jlahoda
parents:
33362
diff
changeset
|
375 |
} |
39370
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
376 |
|
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
377 |
/** |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
378 |
* The wrapping of a snippet of Java source into valid top-level Java |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
379 |
* source. The wrapping will always either be an import or include a |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
380 |
* synthetic class at the top-level. If a synthetic class is generated, it |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
381 |
* will be proceeded by the package and import declarations, and may contain |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
382 |
* synthetic class members. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
383 |
* <p> |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
384 |
* This interface, in addition to the mapped form, provides the context and |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
385 |
* position mapping information. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
386 |
*/ |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
387 |
public interface SnippetWrapper { |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
388 |
|
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
389 |
/** |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
390 |
* Returns the input that is wrapped. For |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
391 |
* {@link SourceCodeAnalysis#wrappers(java.lang.String) wrappers(String)}, |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
392 |
* this is the source of the snippet within the input. A variable |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
393 |
* declaration of {@code N} variables will map to {@code N} wrappers |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
394 |
* with the source separated. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
395 |
* <p> |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
396 |
* For {@link SourceCodeAnalysis#wrapper(Snippet) wrapper(Snippet)}, |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
397 |
* this is {@link Snippet#source() }. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
398 |
* |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
399 |
* @return the input source corresponding to the wrapper. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
400 |
*/ |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
401 |
String source(); |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
402 |
|
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
403 |
/** |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
404 |
* Returns a Java class definition that wraps the |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
405 |
* {@link SnippetWrapper#source()} or, if an import, the import source. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
406 |
* <p> |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
407 |
* If the input is not a valid Snippet, this will not be a valid |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
408 |
* class/import definition. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
409 |
* <p> |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
410 |
* The source may be divided and mapped to different locations within |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
411 |
* the wrapped source. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
412 |
* |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
413 |
* @return the source wrapped into top-level Java code |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
414 |
*/ |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
415 |
String wrapped(); |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
416 |
|
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
417 |
/** |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
418 |
* Returns the fully qualified class name of the |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
419 |
* {@link SnippetWrapper#wrapped() } class. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
420 |
* For erroneous input, a best guess is returned. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
421 |
* |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
422 |
* @return the name of the synthetic wrapped class; if an import, the |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
423 |
* name is not defined |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
424 |
*/ |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
425 |
String fullClassName(); |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
426 |
|
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
427 |
/** |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
428 |
* Returns the {@link Snippet.Kind} of the |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
429 |
* {@link SnippetWrapper#source()}. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
430 |
* |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
431 |
* @return an enum representing the general kind of snippet. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
432 |
*/ |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
433 |
Snippet.Kind kind(); |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
434 |
|
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
435 |
/** |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
436 |
* Maps character position within the source to character position |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
437 |
* within the wrapped. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
438 |
* |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
439 |
* @param pos the position in {@link SnippetWrapper#source()} |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
440 |
* @return the corresponding position in |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
441 |
* {@link SnippetWrapper#wrapped() } |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
442 |
*/ |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
443 |
int sourceToWrappedPosition(int pos); |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
444 |
|
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
445 |
/** |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
446 |
* Maps character position within the wrapped to character position |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
447 |
* within the source. |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
448 |
* |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
449 |
* @param pos the position in {@link SnippetWrapper#wrapped()} |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
450 |
* @return the corresponding position in |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
451 |
* {@link SnippetWrapper#source() } |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
452 |
*/ |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
453 |
int wrappedToSourcePosition(int pos); |
437ba9bd2582
8159111: JShell API: Add access to wrappers and dependencies
rfield
parents:
38908
diff
changeset
|
454 |
} |
33362 | 455 |
} |