/
GroovyVisitorContext.java
388 lines (339 loc) · 14.3 KB
/
GroovyVisitorContext.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
/*
* Copyright 2017-2020 original authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.micronaut.ast.groovy.visitor;
import groovy.lang.GroovyClassLoader;
import io.micronaut.ast.groovy.GroovyNativeElementHelper;
import io.micronaut.ast.groovy.annotation.GroovyAnnotationMetadataBuilder;
import io.micronaut.ast.groovy.annotation.GroovyElementAnnotationMetadataFactory;
import io.micronaut.ast.groovy.scan.ClassPathAnnotationScanner;
import io.micronaut.ast.groovy.utils.AstMessageUtils;
import io.micronaut.core.annotation.Internal;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.core.convert.ArgumentConversionContext;
import io.micronaut.core.convert.value.MutableConvertibleValues;
import io.micronaut.core.convert.value.MutableConvertibleValuesMap;
import io.micronaut.core.reflect.ClassUtils;
import io.micronaut.core.util.ArgumentUtils;
import io.micronaut.core.util.CollectionUtils;
import io.micronaut.expressions.context.DefaultExpressionCompilationContextFactory;
import io.micronaut.expressions.context.ExpressionCompilationContextFactory;
import io.micronaut.inject.ast.ClassElement;
import io.micronaut.inject.ast.Element;
import io.micronaut.inject.ast.annotation.ElementAnnotationMetadataFactory;
import io.micronaut.inject.visitor.VisitorContext;
import io.micronaut.inject.visitor.util.VisitorContextUtils;
import io.micronaut.inject.writer.AbstractBeanDefinitionBuilder;
import io.micronaut.inject.writer.ClassWriterOutputVisitor;
import io.micronaut.inject.writer.GeneratedFile;
import org.codehaus.groovy.ast.ASTNode;
import org.codehaus.groovy.ast.ClassHelper;
import org.codehaus.groovy.ast.ClassNode;
import org.codehaus.groovy.control.ClassNodeResolver;
import org.codehaus.groovy.control.CompilationUnit;
import org.codehaus.groovy.control.Janitor;
import org.codehaus.groovy.control.SourceUnit;
import java.io.IOException;
import java.io.OutputStream;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Enumeration;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
/**
* The visitor context when visiting Groovy code.
*
* @author James Kleeh
* @author Graeme Rocher
* @since 1.0
*/
@Internal
public class GroovyVisitorContext implements VisitorContext {
private static final MutableConvertibleValues<Object> VISITOR_ATTRIBUTES = new MutableConvertibleValuesMap<>();
private final CompilationUnit compilationUnit;
private final ClassWriterOutputVisitor outputVisitor;
private final SourceUnit sourceUnit;
private final MutableConvertibleValues<Object> attributes;
private final List<String> generatedResources = new ArrayList<>();
private final GroovyElementFactory groovyElementFactory;
private final List<AbstractBeanDefinitionBuilder> beanDefinitionBuilders = new ArrayList<>();
private final GroovyElementAnnotationMetadataFactory elementAnnotationMetadataFactory;
private final ExpressionCompilationContextFactory expressionCompilationContextFactory;
private final GroovyNativeElementHelper nativeElementHelper;
private final GroovyAnnotationMetadataBuilder annotationMetadataBuilder;
/**
* @param sourceUnit The source unit
* @param compilationUnit The compilation unit
*/
public GroovyVisitorContext(SourceUnit sourceUnit, @Nullable CompilationUnit compilationUnit) {
this(sourceUnit, compilationUnit, new GroovyClassWriterOutputVisitor(compilationUnit));
}
/**
* @param sourceUnit The source unit
* @param compilationUnit The compilation unit
* @param outputVisitor The class writer output visitor
*/
public GroovyVisitorContext(SourceUnit sourceUnit, @Nullable CompilationUnit compilationUnit, ClassWriterOutputVisitor outputVisitor) {
this.sourceUnit = sourceUnit;
this.compilationUnit = compilationUnit;
this.outputVisitor = outputVisitor;
this.attributes = VISITOR_ATTRIBUTES;
this.nativeElementHelper = new GroovyNativeElementHelper();
this.groovyElementFactory = new GroovyElementFactory(this);
this.annotationMetadataBuilder = new GroovyAnnotationMetadataBuilder(sourceUnit, compilationUnit, nativeElementHelper, this);
this.elementAnnotationMetadataFactory = new GroovyElementAnnotationMetadataFactory(false, annotationMetadataBuilder);
this.expressionCompilationContextFactory = new DefaultExpressionCompilationContextFactory(this);
}
@Override
public Language getLanguage() {
return Language.GROOVY;
}
@NonNull
@Override
public Iterable<URL> getClasspathResources(@NonNull String path) {
try {
final Enumeration<URL> resources = compilationUnit.getClassLoader().getResources(path);
return CollectionUtils.enumerationToIterable(resources);
} catch (IOException e) {
return Collections.emptyList();
}
}
@Override
public Optional<ClassElement> getClassElement(String name) {
return getClassElement(name, getElementAnnotationMetadataFactory());
}
@Override
public Optional<ClassElement> getClassElement(String name, ElementAnnotationMetadataFactory annotationMetadataFactory) {
if (name == null) {
return Optional.empty();
} else if (compilationUnit == null) {
return Optional.ofNullable(classNodeFromClassLoader(name)).map(cn ->
groovyElementFactory.newClassElement(cn, annotationMetadataFactory)
);
}
ClassNodeResolver.LookupResult lookupResult = compilationUnit.getClassNodeResolver().resolveName(name, compilationUnit);
Optional<ClassNode> classNode;
if (lookupResult != null) {
classNode = Optional.ofNullable(lookupResult.getClassNode());
} else {
classNode = Optional.ofNullable(compilationUnit.getClassNode(name));
}
ClassNode finalClassNode = classNode.orElseGet(() -> classNodeFromClassLoader(name));
return Optional.ofNullable(finalClassNode).map(cn -> groovyElementFactory.newClassElement(cn, annotationMetadataFactory));
}
private ClassNode classNodeFromClassLoader(String name) {
ClassNode cn = null;
if (sourceUnit != null) {
GroovyClassLoader classLoader = sourceUnit.getClassLoader();
if (classLoader != null) {
cn = ClassUtils.forName(name, classLoader).map(ClassHelper::make).orElse(null);
}
}
return cn;
}
@Override
public Optional<ClassElement> getClassElement(Class<?> type) {
final ClassNode classNode = ClassHelper.makeCached(type);
return Optional.of(groovyElementFactory.newClassElement(classNode, getElementAnnotationMetadataFactory()));
}
@NonNull
@Override
public ClassElement[] getClassElements(@NonNull String aPackage, @NonNull String... stereotypes) {
ArgumentUtils.requireNonNull("aPackage", aPackage);
ArgumentUtils.requireNonNull("stereotypes", stereotypes);
if (compilationUnit == null) {
return ClassElement.ZERO_CLASS_ELEMENTS;
}
ClassPathAnnotationScanner scanner = new ClassPathAnnotationScanner(compilationUnit.getClassLoader());
List<ClassElement> classElements = new ArrayList<>();
for (String s : stereotypes) {
scanner.scan(s, aPackage).forEach(aClass -> {
final ClassNode classNode = ClassHelper.make(aClass);
classElements.add(groovyElementFactory.newClassElement(classNode, getElementAnnotationMetadataFactory()));
});
}
return classElements.toArray(ClassElement.ZERO_CLASS_ELEMENTS);
}
@NonNull
@Override
public GroovyElementFactory getElementFactory() {
return groovyElementFactory;
}
@NonNull
@Override
public GroovyElementAnnotationMetadataFactory getElementAnnotationMetadataFactory() {
return elementAnnotationMetadataFactory;
}
@Override
public ExpressionCompilationContextFactory getExpressionCompilationContextFactory() {
return this.expressionCompilationContextFactory;
}
@Override
public GroovyAnnotationMetadataBuilder getAnnotationMetadataBuilder() {
return annotationMetadataBuilder;
}
@Override
public void info(String message, @Nullable Element element) {
StringBuilder msg = new StringBuilder("Note: ").append(message);
if (element instanceof AbstractGroovyElement abstractGroovyElement) {
ASTNode expr = abstractGroovyElement.getNativeType().annotatedNode();
final String sample = sourceUnit.getSample(expr.getLineNumber(), expr.getColumnNumber(), new Janitor());
msg.append("\n\n").append(sample);
}
System.out.println(msg);
}
@Override
public void info(String message) {
System.out.println("Note: " + message);
}
@Override
public void fail(String message, @Nullable Element element) {
if (element instanceof AbstractGroovyElement abstractGroovyElement) {
AstMessageUtils.error(sourceUnit, abstractGroovyElement.getNativeType().annotatedNode(), message);
} else {
AstMessageUtils.error(sourceUnit, null, message);
}
}
public final void fail(String message, ASTNode expr) {
AstMessageUtils.error(sourceUnit, expr, message);
}
@Override
public void warn(String message, @Nullable Element element) {
if (element instanceof AbstractGroovyElement abstractGroovyElement) {
AstMessageUtils.warning(sourceUnit, abstractGroovyElement.getNativeType().annotatedNode(), message);
} else {
AstMessageUtils.warning(sourceUnit, null, message);
}
}
@Override
public OutputStream visitClass(String classname, @Nullable Element originatingElement) throws IOException {
return outputVisitor.visitClass(classname, originatingElement);
}
@Override
public OutputStream visitClass(String classname, Element... originatingElements) throws IOException {
return outputVisitor.visitClass(classname, originatingElements);
}
@Override
public void visitServiceDescriptor(String type, String classname) {
outputVisitor.visitServiceDescriptor(type, classname);
}
@Override
public void visitServiceDescriptor(String type, String classname, Element originatingElement) {
outputVisitor.visitServiceDescriptor(type, classname, originatingElement);
}
@Override
public Optional<GeneratedFile> visitMetaInfFile(String path, Element... originatingElements) {
return outputVisitor.visitMetaInfFile(path, originatingElements);
}
@Override
public Optional<GeneratedFile> visitGeneratedFile(String path) {
return outputVisitor.visitGeneratedFile(path);
}
@Override
public Optional<GeneratedFile> visitGeneratedFile(String path, Element... originatingElements) {
return outputVisitor.visitGeneratedFile(path, originatingElements);
}
@Override
public Optional<GeneratedFile> visitGeneratedSourceFile(String packageName, String fileNameWithoutExtension, Element... originatingElements) {
return outputVisitor.visitGeneratedSourceFile(packageName, fileNameWithoutExtension, originatingElements);
}
@Override
public void finish() {
outputVisitor.finish();
}
/**
* @return The source unit
*/
SourceUnit getSourceUnit() {
return sourceUnit;
}
/**
* @return The compilation unit
*/
@Internal
public CompilationUnit getCompilationUnit() {
return compilationUnit;
}
/**
* @return The native element helper
*/
@Internal
public GroovyNativeElementHelper getNativeElementHelper() {
return nativeElementHelper;
}
/**
* Groovy options source are {@link System#getProperties()} based.
* <p><b>All properties MUST start with {@link GroovyVisitorContext#MICRONAUT_BASE_OPTION_NAME}</b></p>
* @return options {@link Map}
*/
@Override
public Map<String, String> getOptions() {
return VisitorContextUtils.getSystemOptions();
}
@Override
public MutableConvertibleValues<Object> put(CharSequence key, @Nullable Object value) {
return attributes.put(key, value);
}
@Override
public MutableConvertibleValues<Object> remove(CharSequence key) {
return attributes.remove(key);
}
@Override
public MutableConvertibleValues<Object> clear() {
return attributes.clear();
}
@Override
public Set<String> names() {
return attributes.names();
}
@Override
public Collection<Object> values() {
return attributes.values();
}
@Override
public <T> Optional<T> get(CharSequence name, ArgumentConversionContext<T> conversionContext) {
return attributes.get(name, conversionContext);
}
@Override
public Collection<String> getGeneratedResources() {
return Collections.unmodifiableCollection(generatedResources);
}
@Override
public void addGeneratedResource(@NonNull String resource) {
generatedResources.add(resource);
}
/**
* @return Gets the produced bean definition builders.
*/
@Internal
public List<AbstractBeanDefinitionBuilder> getBeanElementBuilders() {
final ArrayList<AbstractBeanDefinitionBuilder> current = new ArrayList<>(beanDefinitionBuilders);
beanDefinitionBuilders.clear();
return current;
}
/**
* Adds a java bean definition builder.
* @param groovyBeanDefinitionBuilder The groovy bean definition builder
*/
@Internal
void addBeanDefinitionBuilder(GroovyBeanDefinitionBuilder groovyBeanDefinitionBuilder) {
this.beanDefinitionBuilders.add(groovyBeanDefinitionBuilder);
}
}