-
Notifications
You must be signed in to change notification settings - Fork 0
/
FxClassGenerator.java
380 lines (327 loc) · 17.4 KB
/
FxClassGenerator.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
package org.fulib.fx;
import org.fulib.fx.annotation.controller.*;
import org.fulib.fx.annotation.event.onDestroy;
import org.fulib.fx.annotation.event.onInit;
import org.fulib.fx.annotation.event.onRender;
import org.fulib.fx.annotation.param.Param;
import org.fulib.fx.annotation.param.Params;
import org.fulib.fx.annotation.param.ParamsMap;
import org.fulib.fx.util.ControllerUtil;
import javax.annotation.processing.ProcessingEnvironment;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.Modifier;
import javax.lang.model.element.TypeElement;
import javax.lang.model.element.VariableElement;
import javax.lang.model.type.DeclaredType;
import javax.lang.model.type.ExecutableType;
import javax.lang.model.type.TypeMirror;
import javax.tools.JavaFileObject;
import java.io.IOException;
import java.io.PrintWriter;
import java.lang.annotation.Annotation;
import java.util.*;
import java.util.stream.Stream;
public class FxClassGenerator {
private static final String CLASS_SUFFIX = "_Fx";
private final ProcessingEnvironment processingEnv;
/**
* The (erased) `javafx.beans.value.WritableValue` type.
*/
private final TypeMirror writableValue;
/**
* The `setValue` method of `javafx.beans.value.WritableValue`.
*/
private final ExecutableElement genericSetValue;
/**
* The `javafx.scene.Parent` type.
*/
private final TypeMirror parent;
public FxClassGenerator(ProcessingEnvironment processingEnv) {
this.processingEnv = processingEnv;
final TypeElement writableValue = processingEnv.getElementUtils().getTypeElement("javafx.beans.value.WritableValue");
this.writableValue = processingEnv.getTypeUtils().erasure(writableValue.asType());
genericSetValue = writableValue.getEnclosedElements()
.stream()
.filter(e -> e instanceof ExecutableElement)
.map(e -> (ExecutableElement) e)
.filter(e -> "setValue".equals(e.getSimpleName().toString()))
.findFirst()
.orElseThrow();
parent = processingEnv.getElementUtils().getTypeElement("javafx.scene.Parent").asType();
}
public void generateSidecar(TypeElement componentClass) {
try {
final JavaFileObject builderFile = processingEnv.getFiler()
.createSourceFile(componentClass.getQualifiedName() + CLASS_SUFFIX);
try (PrintWriter out = new PrintWriter(builderFile.openWriter())) {
this.generateSidecar(out, componentClass);
}
} catch (IOException e) {
throw new RuntimeException(e);
}
}
private void generateSidecar(PrintWriter out, TypeElement componentClass) throws IOException {
final String className = componentClass.getQualifiedName().toString();
String packageName = null;
int lastDot = className.lastIndexOf('.');
if (lastDot > 0) {
packageName = className.substring(0, lastDot);
}
String simpleClassName = className.substring(lastDot + 1);
String builderClassName = className + CLASS_SUFFIX;
String builderSimpleClassName = builderClassName.substring(lastDot + 1);
if (packageName != null) {
out.println("package " + packageName + ";");
out.println();
}
out.println("import java.util.Map;");
out.println("import java.util.ResourceBundle;");
out.println("import javafx.scene.Node;");
out.println("import org.fulib.fx.controller.ControllerManager;");
out.println("import org.fulib.fx.controller.internal.FxSidecar;");
out.println();
out.printf("public class %s implements FxSidecar<%s> {%n", builderSimpleClassName, simpleClassName);
out.println(" private final ControllerManager controllerManager;");
out.printf(" public %s(ControllerManager cm) {%n", builderSimpleClassName);
out.println(" this.controllerManager = cm;");
out.println(" }");
out.println(" @Override");
out.printf(" public void init(%s instance, Map<String, Object> params) {%n", simpleClassName);
generateSidecarInit(out, componentClass);
out.println(" }");
out.println(" @Override");
out.printf(" public Node render(%s instance, Map<String, Object> params) {%n", simpleClassName);
generateSidecarRender(out, componentClass);
out.println(" }");
out.println(" @Override");
out.printf(" public void destroy(%s instance) {%n", simpleClassName);
generateSidecarDestroy(out, componentClass);
out.println(" }");
out.println(" @Override");
out.printf(" public ResourceBundle getResources(%s instance) {%n", simpleClassName);
generateSidecarResources(out, componentClass);
out.println(" }");
out.println(" @Override");
out.printf(" public String getTitle(%s instance) {%n", simpleClassName);
generateSidecarTitle(out, componentClass);
out.println(" }");
out.println("}");
}
private void generateSidecarInit(PrintWriter out, TypeElement componentClass) {
generateParametersIntoFields(out, componentClass);
generateCallParamMethods(out, componentClass, Param.class);
generateCallParamMethods(out, componentClass, Params.class);
generateCallParamMethods(out, componentClass, ParamsMap.class);
generateCallInitMethods(out, componentClass);
generateCallSubComponents(out, componentClass, "init");
}
private void generateParametersIntoFields(PrintWriter out, TypeElement componentClass) {
streamAllFields(componentClass, Param.class).forEach(field -> {
final Param param = field.getAnnotation(Param.class);
final String fieldName = field.getSimpleName().toString();
final String fieldType = field.asType().toString();
final String paramNameLiteral = stringLiteral(param.value());
out.printf(" if (params.containsKey(%s)) {%n", paramNameLiteral);
// TODO field must be public, package-private or protected -- add a diagnostic if it's private
if (processingEnv.getTypeUtils().isAssignable(field.asType(), writableValue)) {
// We use the `setValue` method to infer the actual type of the field,
// E.g. if the field is a `StringProperty` which extends `WritableValue<String>`,
// we can infer that the actual type is `String`.
final ExecutableType asMemberOf = (ExecutableType) processingEnv.getTypeUtils().asMemberOf((DeclaredType) field.asType(), genericSetValue);
final TypeMirror typeArg = asMemberOf.getParameterTypes().get(0);
final String writableType = typeArg.toString();
if (field.getModifiers().contains(Modifier.FINAL)) {
out.printf(" instance.%s.setValue((%s) params.get(%s));%n", fieldName, writableType, paramNameLiteral);
} else {
// final Object param = params.get(<paramNameLiteral>);
// if (param instanceof <writableValue>) {
// instance.<fieldName> = (<fieldType>) param);
// } else {
// instance.<fieldName>.setValue((<writableType>) param);
// }
out.printf(" final Object param = params.get(%s);%n", paramNameLiteral);
out.printf(" if (param instanceof %s) {%n", writableValue);
out.printf(" instance.%s = (%s) param;%n", fieldName, fieldType);
out.println(" } else {");
out.printf(" instance.%s.setValue((%s) param);%n", fieldName, writableType);
out.println(" }");
}
} else {
out.printf(" instance.%s = (%s) params.get(%s);%n", fieldName, fieldType, paramNameLiteral);
}
out.println(" }");
});
streamAllFields(componentClass, ParamsMap.class).forEach(field -> {
final String fieldName = field.getSimpleName().toString();
if (field.getModifiers().contains(Modifier.FINAL)) {
out.printf(" instance.%s.clear();%n", fieldName);
out.printf(" instance.%s.putAll(params);%n", fieldName);
} else {
out.printf(" instance.%s = params;%n", fieldName);
}
});
}
private void generateCallInitMethods(PrintWriter out, TypeElement componentClass) {
streamAllMethods(componentClass, onInit.class)
.sorted(Comparator.comparingInt(a -> a.getAnnotation(onInit.class).value()))
.forEach(methodElement -> generateCall(out, methodElement));
}
private void generateCallParamMethods(PrintWriter out, TypeElement componentClass, Class<? extends Annotation> annotation) {
streamAllMethods(componentClass, annotation)
.forEach(methodElement -> generateCall(out, methodElement));
}
private void generateCall(PrintWriter out, ExecutableElement methodElement) {
final List<? extends VariableElement> parameters = methodElement.getParameters();
final List<String> arguments = Arrays.asList(new String[parameters.size()]);
fillMethodArguments(methodElement, arguments, parameters);
for (int i = 0; i < parameters.size(); i++) {
final VariableElement parameter = parameters.get(i);
final Param paramAnnotation = parameter.getAnnotation(Param.class);
if (paramAnnotation != null) {
arguments.set(i, "(%s) params.get(%s)".formatted(parameter.asType(), stringLiteral(paramAnnotation.value())));
continue;
}
final ParamsMap paramsMapAnnotation = parameter.getAnnotation(ParamsMap.class);
if (paramsMapAnnotation != null) {
arguments.set(i, "params");
continue;
}
}
out.printf(" instance.%s(%s);%n", methodElement.getSimpleName(), String.join(", ", arguments));
}
private void fillMethodArguments(ExecutableElement methodElement, List<String> arguments, List<? extends VariableElement> parameters) {
final Param paramAnnotation = methodElement.getAnnotation(Param.class);
if (paramAnnotation != null) {
arguments.set(0, "(%s) params.get(%s)".formatted(parameters.get(0).asType(), stringLiteral(paramAnnotation.value())));
}
final Params paramsAnnotation = methodElement.getAnnotation(Params.class);
if (paramsAnnotation != null) {
final String[] paramNames = paramsAnnotation.value();
for (int i = 0; i < paramNames.length; i++) {
final VariableElement parameter = parameters.get(i);
arguments.set(i, "(%s) params.get(%s)".formatted(parameter.asType(), stringLiteral(paramNames[i])));
}
}
final ParamsMap paramsMapAnnotation = methodElement.getAnnotation(ParamsMap.class);
if (paramsMapAnnotation != null) {
arguments.set(0, "params");
}
}
private void generateCallSubComponents(PrintWriter out, TypeElement componentClass, String method) {
streamAllFields(componentClass, SubComponent.class).forEach(field -> {
if (field.asType().toString().startsWith("javax.inject.Provider")) {
// Provider fields are initialized on demand
return;
}
final String fieldName = field.getSimpleName().toString();
out.printf(" this.controllerManager.%s(instance.%s, params);%n", method, fieldName);
});
}
private void generateSidecarDestroy(PrintWriter out, TypeElement componentClass) {
generateDestroySubComponents(out, componentClass);
generateCallDestroyMethods(out, componentClass);
}
private void generateCallDestroyMethods(PrintWriter out, TypeElement componentClass) {
streamAllMethods(componentClass, onDestroy.class)
.sorted(Comparator.comparingInt(a -> a.getAnnotation(onDestroy.class).value()))
.forEach(element -> generateCall(out, element));
}
private void generateDestroySubComponents(PrintWriter out, TypeElement componentClass) {
final List<String> fieldNames = new ArrayList<>();
streamAllFields(componentClass, SubComponent.class).forEach(field -> {
if (field.asType().toString().startsWith("javax.inject.Provider")) {
// Provider fields are destroyed on demand
return;
}
final String fieldName = field.getSimpleName().toString();
fieldNames.add(fieldName);
});
Collections.reverse(fieldNames);
for (String fieldName : fieldNames) {
out.printf(" this.controllerManager.destroy(instance.%s);%n", fieldName);
}
}
private void generateSidecarRender(PrintWriter out, TypeElement componentClass) {
generateCallSubComponents(out, componentClass, "render");
generateRenderResult(out, componentClass);
generateCallRenderMethods(out, componentClass);
// TODO Register key events
out.println(" return result;");
}
private void generateRenderResult(PrintWriter out, TypeElement componentClass) {
final Component component = componentClass.getAnnotation(Component.class);
final Controller controller = componentClass.getAnnotation(Controller.class);
if (component != null) {
final String view = component.view();
if (view.isEmpty()) {
out.println(" final Node result = instance;");
} else {
if (processingEnv.getTypeUtils().isAssignable(componentClass.asType(), parent)) {
out.println(" instance.getChildren().clear();");
}
out.printf(" final Node result = this.controllerManager.loadFXML(%s, instance, true);%n", stringLiteral(view));
}
} else if (controller != null) {
final String view = controller.view();
if (view.startsWith("#")) {
out.printf(" final Node result = instance.%s();%n", view.substring(1));
} else {
final String inferredView = view.isEmpty() ? ControllerUtil.transform(componentClass.getSimpleName().toString()) + ".fxml" : view;
out.printf(" final Node result = this.controllerManager.loadFXML(%s, instance, false);%n", stringLiteral(inferredView));
}
}
}
private void generateCallRenderMethods(PrintWriter out, TypeElement componentClass) {
streamAllMethods(componentClass, onRender.class)
.sorted(Comparator.comparingInt(a -> a.getAnnotation(onRender.class).value()))
.forEach(element -> generateCall(out, element));
}
private void generateSidecarResources(PrintWriter out, TypeElement componentClass) {
streamAllFields(componentClass, Resource.class)
.findFirst()
.ifPresentOrElse(
field -> out.printf(" return instance.%s;%n", field.getSimpleName()),
() -> out.println(" return controllerManager.getDefaultResourceBundle();")
);
}
private void generateSidecarTitle(PrintWriter out, TypeElement componentClass) {
final Title title = componentClass.getAnnotation(Title.class);
if (title == null) {
out.println(" return null;");
return;
}
if (title.value().startsWith("%")) {
out.printf(" return getResources(instance).getString(%s);%n", stringLiteral(title.value().substring(1)));
} else if ("$name".equals(title.value())) {
out.printf(" return %s;%n", stringLiteral(ControllerUtil.transform(componentClass.getSimpleName().toString())));
} else {
out.printf(" return %s;%n", stringLiteral(title.value()));
}
}
private String stringLiteral(String value) {
return processingEnv.getElementUtils().getConstantExpression(value);
}
private Stream<ExecutableElement> streamAllMethods(TypeElement componentClass, Class<? extends Annotation> annotation) {
return streamSuperClasses(componentClass).flatMap(e -> streamMethods(e, annotation));
}
private Stream<ExecutableElement> streamMethods(TypeElement componentClass, Class<? extends Annotation> annotation) {
return componentClass
.getEnclosedElements()
.stream()
.filter(element -> element instanceof ExecutableElement && element.getAnnotation(annotation) != null)
.map(element -> (ExecutableElement) element);
}
private Stream<VariableElement> streamAllFields(TypeElement componentClass, Class<? extends Annotation> annotation) {
return streamSuperClasses(componentClass).flatMap(e -> streamFields(e, annotation));
}
private Stream<VariableElement> streamFields(TypeElement componentClass, Class<? extends Annotation> annotation) {
return componentClass
.getEnclosedElements()
.stream()
.filter(element -> element instanceof VariableElement && element.getAnnotation(annotation) != null)
.map(element -> (VariableElement) element);
}
private Stream<TypeElement> streamSuperClasses(TypeElement componentClass) {
return Stream.iterate(componentClass, Objects::nonNull, e -> (TypeElement) processingEnv.getTypeUtils().asElement(e.getSuperclass()));
}
}