2 * Back 2 Browser Bytecode Translator
3 * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, version 2 of the License.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. Look for COPYING file in the top folder.
16 * If not, see http://opensource.org/licenses/GPL-2.0.
18 package org.apidesign.bck2brwsr.htmlpage;
20 import java.io.IOException;
21 import java.io.InputStream;
22 import java.io.OutputStreamWriter;
23 import java.io.StringWriter;
24 import java.io.Writer;
25 import java.util.ArrayList;
26 import java.util.Collection;
27 import java.util.Collections;
28 import java.util.HashMap;
29 import java.util.LinkedHashSet;
30 import java.util.List;
33 import java.util.WeakHashMap;
34 import javax.annotation.processing.AbstractProcessor;
35 import javax.annotation.processing.Completion;
36 import javax.annotation.processing.Completions;
37 import javax.annotation.processing.Processor;
38 import javax.annotation.processing.RoundEnvironment;
39 import javax.annotation.processing.SupportedAnnotationTypes;
40 import javax.lang.model.element.AnnotationMirror;
41 import javax.lang.model.element.Element;
42 import javax.lang.model.element.ElementKind;
43 import javax.lang.model.element.ExecutableElement;
44 import javax.lang.model.element.Modifier;
45 import javax.lang.model.element.PackageElement;
46 import javax.lang.model.element.TypeElement;
47 import javax.lang.model.element.VariableElement;
48 import javax.lang.model.type.MirroredTypeException;
49 import javax.lang.model.type.TypeKind;
50 import javax.lang.model.type.TypeMirror;
51 import javax.lang.model.util.Types;
52 import javax.tools.Diagnostic;
53 import javax.tools.FileObject;
54 import javax.tools.StandardLocation;
55 import org.apidesign.bck2brwsr.htmlpage.api.ComputedProperty;
56 import org.apidesign.bck2brwsr.htmlpage.api.Model;
57 import org.apidesign.bck2brwsr.htmlpage.api.On;
58 import org.apidesign.bck2brwsr.htmlpage.api.OnFunction;
59 import org.apidesign.bck2brwsr.htmlpage.api.Page;
60 import org.apidesign.bck2brwsr.htmlpage.api.Property;
61 import org.openide.util.lookup.ServiceProvider;
63 /** Annotation processor to process an XHTML page and generate appropriate
66 * @author Jaroslav Tulach <jtulach@netbeans.org>
68 @ServiceProvider(service=Processor.class)
69 @SupportedAnnotationTypes({
70 "org.apidesign.bck2brwsr.htmlpage.api.Model",
71 "org.apidesign.bck2brwsr.htmlpage.api.Page",
72 "org.apidesign.bck2brwsr.htmlpage.api.OnFunction",
73 "org.apidesign.bck2brwsr.htmlpage.api.On"
75 public final class PageProcessor extends AbstractProcessor {
76 private final Map<Element,String> models = new WeakHashMap<>();
78 public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
80 for (Element e : roundEnv.getElementsAnnotatedWith(Model.class)) {
81 if (!processModel(e)) {
85 for (Element e : roundEnv.getElementsAnnotatedWith(Page.class)) {
86 if (!processPage(e)) {
90 if (roundEnv.processingOver()) {
96 private InputStream openStream(String pkg, String name) throws IOException {
98 FileObject fo = processingEnv.getFiler().getResource(
99 StandardLocation.SOURCE_PATH, pkg, name);
100 return fo.openInputStream();
101 } catch (IOException ex) {
102 return processingEnv.getFiler().getResource(StandardLocation.CLASS_OUTPUT, pkg, name).openInputStream();
106 private boolean processModel(Element e) {
108 Model m = e.getAnnotation(Model.class);
112 String pkg = findPkgName(e);
114 String className = m.className();
116 StringWriter body = new StringWriter();
117 List<String> propsGetSet = new ArrayList<>();
118 List<String> functions = new ArrayList<>();
119 Map<String, Collection<String>> propsDeps = new HashMap<>();
120 if (!generateComputedProperties(body, m.properties(), e.getEnclosedElements(), propsGetSet, propsDeps)) {
123 if (!generateProperties(e, body, m.properties(), propsGetSet, propsDeps)) {
126 if (!generateFunctions(e, body, className, e.getEnclosedElements(), functions)) {
129 FileObject java = processingEnv.getFiler().createSourceFile(pkg + '.' + className, e);
130 w = new OutputStreamWriter(java.openOutputStream());
132 w.append("package " + pkg + ";\n");
133 w.append("import org.apidesign.bck2brwsr.htmlpage.api.*;\n");
134 w.append("import org.apidesign.bck2brwsr.htmlpage.KOList;\n");
135 w.append("import org.apidesign.bck2brwsr.core.JavaScriptOnly;\n");
136 w.append("final class ").append(className).append(" {\n");
137 w.append(" private Object json;\n");
138 w.append(" private boolean locked;\n");
139 w.append(" private org.apidesign.bck2brwsr.htmlpage.Knockout ko;\n");
140 w.append(body.toString());
141 w.append(" private static Class<" + e.getSimpleName() + "> modelFor() { return null; }\n");
142 w.append(" public ").append(className).append("() {\n");
143 w.append(" ko = org.apidesign.bck2brwsr.htmlpage.Knockout.applyBindings(this, ");
144 writeStringArray(propsGetSet, w);
146 writeStringArray(functions, w);
153 } catch (IOException ex) {
154 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
160 private boolean processPage(Element e) {
162 Page p = e.getAnnotation(Page.class);
166 String pkg = findPkgName(e);
169 try (InputStream is = openStream(pkg, p.xhtml())) {
170 pp = ProcessPage.readPage(is);
172 } catch (IOException iOException) {
173 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't read " + p.xhtml(), e);
178 String className = p.className();
179 if (className.isEmpty()) {
180 int indx = p.xhtml().indexOf('.');
181 className = p.xhtml().substring(0, indx);
184 StringWriter body = new StringWriter();
185 List<String> propsGetSet = new ArrayList<>();
186 List<String> functions = new ArrayList<>();
187 Map<String, Collection<String>> propsDeps = new HashMap<>();
188 if (!generateComputedProperties(body, p.properties(), e.getEnclosedElements(), propsGetSet, propsDeps)) {
191 if (!generateProperties(e, body, p.properties(), propsGetSet, propsDeps)) {
194 if (!generateFunctions(e, body, className, e.getEnclosedElements(), functions)) {
198 FileObject java = processingEnv.getFiler().createSourceFile(pkg + '.' + className, e);
199 w = new OutputStreamWriter(java.openOutputStream());
201 w.append("package " + pkg + ";\n");
202 w.append("import org.apidesign.bck2brwsr.htmlpage.api.*;\n");
203 w.append("import org.apidesign.bck2brwsr.htmlpage.KOList;\n");
204 w.append("final class ").append(className).append(" {\n");
205 w.append(" private boolean locked;\n");
206 if (!initializeOnClick(className, (TypeElement) e, w, pp)) {
209 for (String id : pp.ids()) {
210 String tag = pp.tagNameForId(id);
211 String type = type(tag);
212 w.append(" ").append("public final ").
213 append(type).append(' ').append(cnstnt(id)).append(" = new ").
214 append(type).append("(\"").append(id).append("\");\n");
217 w.append(" private org.apidesign.bck2brwsr.htmlpage.Knockout ko;\n");
218 w.append(body.toString());
219 if (!propsGetSet.isEmpty()) {
220 w.write("public " + className + " applyBindings() {\n");
221 w.write(" ko = org.apidesign.bck2brwsr.htmlpage.Knockout.applyBindings(");
222 w.write(className + ".class, this, ");
223 writeStringArray(propsGetSet, w);
225 writeStringArray(functions, w);
226 w.write(");\n return this;\n}\n");
228 w.write("public void triggerEvent(Element e, OnEvent ev) {\n");
229 w.write(" org.apidesign.bck2brwsr.htmlpage.Knockout.triggerEvent(e.getId(), ev.getElementPropertyName());\n");
236 } catch (IOException ex) {
237 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
243 private static String type(String tag) {
244 if (tag.equals("title")) {
247 if (tag.equals("button")) {
250 if (tag.equals("input")) {
253 if (tag.equals("canvas")) {
256 if (tag.equals("img")) {
262 private static String cnstnt(String id) {
263 return id.replace('.', '_').replace('-', '_');
266 private boolean initializeOnClick(
267 String className, TypeElement type, Writer w, ProcessPage pp
268 ) throws IOException {
270 TypeMirror stringType = processingEnv.getElementUtils().getTypeElement("java.lang.String").asType();
271 { //for (Element clazz : pe.getEnclosedElements()) {
272 // if (clazz.getKind() != ElementKind.CLASS) {
275 w.append(" public ").append(className).append("() {\n");
276 StringBuilder dispatch = new StringBuilder();
278 for (Element method : type.getEnclosedElements()) {
279 On oc = method.getAnnotation(On.class);
281 for (String id : oc.id()) {
283 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "id = " + id + " not found in HTML page.");
287 if (pp.tagNameForId(id) == null) {
288 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "id = " + id + " does not exist in the HTML page. Found only " + pp.ids(), method);
292 ExecutableElement ee = (ExecutableElement)method;
293 CharSequence params = wrapParams(ee, id, className, "ev", null);
294 if (!ee.getModifiers().contains(Modifier.STATIC)) {
295 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method has to be static", ee);
299 if (ee.getModifiers().contains(Modifier.PRIVATE)) {
300 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method can't be private", ee);
304 w.append(" OnEvent." + oc.event()).append(".of(").append(cnstnt(id)).
305 append(").perform(new OnDispatch(" + dispatchCnt + "));\n");
308 append(" case ").append(dispatchCnt).append(": ").
309 append(type.getSimpleName().toString()).
310 append('.').append(ee.getSimpleName()).append("(").
312 append("); break;\n");
319 if (dispatchCnt > 0) {
320 w.append("class OnDispatch implements OnHandler {\n");
321 w.append(" private final int dispatch;\n");
322 w.append(" OnDispatch(int d) { dispatch = d; }\n");
323 w.append(" public void onEvent(Object ev) {\n");
324 w.append(" switch (dispatch) {\n");
337 public Iterable<? extends Completion> getCompletions(
338 Element element, AnnotationMirror annotation,
339 ExecutableElement member, String userText
341 if (!userText.startsWith("\"")) {
342 return Collections.emptyList();
345 Element cls = findClass(element);
346 Page p = cls.getAnnotation(Page.class);
347 String pkg = findPkgName(cls);
350 InputStream is = openStream(pkg, p.xhtml());
351 pp = ProcessPage.readPage(is);
353 } catch (IOException iOException) {
354 return Collections.emptyList();
357 List<Completion> cc = new ArrayList<>();
358 userText = userText.substring(1);
359 for (String id : pp.ids()) {
360 if (id.startsWith(userText)) {
361 cc.add(Completions.of("\"" + id + "\"", id));
367 private static Element findClass(Element e) {
371 Page p = e.getAnnotation(Page.class);
375 return e.getEnclosingElement();
378 private boolean generateProperties(
380 Writer w, Property[] properties,
381 Collection<String> props, Map<String,Collection<String>> deps
382 ) throws IOException {
384 for (Property p : properties) {
386 tn = typeName(where, p);
387 String[] gs = toGetSet(p.name(), tn, p.array());
390 w.write("private KOList<" + tn + "> prop_" + p.name() + " = new KOList<" + tn + ">(\""
392 final Collection<String> dependants = deps.get(p.name());
393 if (dependants != null) {
394 for (String depProp : dependants) {
402 w.write("public java.util.List<" + tn + "> " + gs[0] + "() {\n");
403 w.write(" if (locked) throw new IllegalStateException();\n");
404 w.write(" prop_" + p.name() + ".assign(ko);\n");
405 w.write(" return prop_" + p.name() + ";\n");
408 w.write("private " + tn + " prop_" + p.name() + ";\n");
409 w.write("public " + tn + " " + gs[0] + "() {\n");
410 w.write(" if (locked) throw new IllegalStateException();\n");
411 w.write(" return prop_" + p.name() + ";\n");
413 w.write("public void " + gs[1] + "(" + tn + " v) {\n");
414 w.write(" if (locked) throw new IllegalStateException();\n");
415 w.write(" prop_" + p.name() + " = v;\n");
416 w.write(" if (ko != null) {\n");
417 w.write(" ko.valueHasMutated(\"" + p.name() + "\");\n");
418 final Collection<String> dependants = deps.get(p.name());
419 if (dependants != null) {
420 for (String depProp : dependants) {
421 w.write(" ko.valueHasMutated(\"" + depProp + "\");\n");
436 private boolean generateComputedProperties(
437 Writer w, Property[] fixedProps,
438 Collection<? extends Element> arr, Collection<String> props,
439 Map<String,Collection<String>> deps
440 ) throws IOException {
442 for (Element e : arr) {
443 if (e.getKind() != ElementKind.METHOD) {
446 if (e.getAnnotation(ComputedProperty.class) == null) {
449 ExecutableElement ee = (ExecutableElement)e;
450 final TypeMirror rt = ee.getReturnType();
451 final Types tu = processingEnv.getTypeUtils();
452 TypeMirror ert = tu.erasure(rt);
453 String tn = ert.toString();
454 boolean array = false;
455 if (tn.equals("java.util.List")) {
459 final String sn = ee.getSimpleName().toString();
460 String[] gs = toGetSet(sn, tn, array);
462 w.write("public " + tn + " " + gs[0] + "() {\n");
463 w.write(" if (locked) throw new IllegalStateException();\n");
465 for (VariableElement pe : ee.getParameters()) {
466 final String dn = pe.getSimpleName().toString();
468 if (!verifyPropName(pe, dn, fixedProps)) {
472 final String dt = pe.asType().toString();
473 String[] call = toGetSet(dn, dt, false);
474 w.write(" " + dt + " arg" + (++arg) + " = ");
475 w.write(call[0] + "();\n");
477 Collection<String> depends = deps.get(dn);
478 if (depends == null) {
479 depends = new LinkedHashSet<>();
480 deps.put(dn, depends);
485 w.write(" locked = true;\n");
486 w.write(" return " + e.getEnclosingElement().getSimpleName() + '.' + e.getSimpleName() + "(");
488 for (int i = 1; i <= arg; i++) {
494 w.write(" } finally {\n");
495 w.write(" locked = false;\n");
499 props.add(e.getSimpleName().toString());
508 private static String[] toGetSet(String name, String type, boolean array) {
509 String n = Character.toUpperCase(name.charAt(0)) + name.substring(1);
510 String bck2brwsrType = "L" + type.replace('.', '_') + "_2";
511 if ("int".equals(type)) {
514 if ("double".equals(type)) {
518 if ("boolean".equals(type)) {
522 final String nu = n.replace('.', '_');
524 return new String[] {
527 "get" + nu + "__Ljava_util_List_2",
534 pref + nu + "__" + bck2brwsrType,
535 "set" + nu + "__V" + bck2brwsrType
539 private String typeName(Element where, Property p) {
541 boolean isModel = false;
542 boolean isEnum = false;
544 ret = p.type().getName();
545 } catch (MirroredTypeException ex) {
546 TypeMirror tm = processingEnv.getTypeUtils().erasure(ex.getTypeMirror());
547 final Element e = processingEnv.getTypeUtils().asElement(tm);
548 final Model m = e == null ? null : e.getAnnotation(Model.class);
550 ret = findPkgName(e) + '.' + m.className();
552 models.put(e, m.className());
556 TypeMirror enm = processingEnv.getElementUtils().getTypeElement("java.lang.Enum").asType();
557 enm = processingEnv.getTypeUtils().erasure(enm);
558 isEnum = processingEnv.getTypeUtils().isSubtype(tm, enm);
561 String bt = findBoxedType(ret);
566 if (!isModel && !"java.lang.String".equals(ret) && !isEnum) {
567 String bt = findBoxedType(ret);
569 processingEnv.getMessager().printMessage(
570 Diagnostic.Kind.ERROR,
571 "Only primitive types supported in the mapping. Not " + ret,
579 private static String findBoxedType(String ret) {
580 if (ret.equals("boolean")) {
581 return Boolean.class.getName();
583 if (ret.equals("byte")) {
584 return Byte.class.getName();
586 if (ret.equals("short")) {
587 return Short.class.getName();
589 if (ret.equals("char")) {
590 return Character.class.getName();
592 if (ret.equals("int")) {
593 return Integer.class.getName();
595 if (ret.equals("long")) {
596 return Long.class.getName();
598 if (ret.equals("float")) {
599 return Float.class.getName();
601 if (ret.equals("double")) {
602 return Double.class.getName();
607 private boolean verifyPropName(Element e, String propName, Property[] existingProps) {
608 StringBuilder sb = new StringBuilder();
610 for (Property property : existingProps) {
611 if (property.name().equals(propName)) {
616 sb.append(property.name());
620 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR,
621 propName + " is not one of known properties: " + sb
627 private static String findPkgName(Element e) {
629 if (e.getKind() == ElementKind.PACKAGE) {
630 return ((PackageElement)e).getQualifiedName().toString();
632 e = e.getEnclosingElement();
636 private boolean generateFunctions(
637 Element clazz, StringWriter body, String className,
638 List<? extends Element> enclosedElements, List<String> functions
640 for (Element m : enclosedElements) {
641 if (m.getKind() != ElementKind.METHOD) {
644 ExecutableElement e = (ExecutableElement)m;
645 OnFunction onF = e.getAnnotation(OnFunction.class);
649 if (!e.getModifiers().contains(Modifier.STATIC)) {
650 processingEnv.getMessager().printMessage(
651 Diagnostic.Kind.ERROR, "@OnFunction method needs to be static", e
655 if (e.getModifiers().contains(Modifier.PRIVATE)) {
656 processingEnv.getMessager().printMessage(
657 Diagnostic.Kind.ERROR, "@OnFunction method cannot be private", e
661 if (e.getReturnType().getKind() != TypeKind.VOID) {
662 processingEnv.getMessager().printMessage(
663 Diagnostic.Kind.ERROR, "@OnFunction method should return void", e
667 String n = e.getSimpleName().toString();
668 body.append("void ").append(n).append("(Object data, Object ev) {\n");
669 body.append(" ").append(clazz.getSimpleName()).append(".").append(n).append("(");
670 body.append(wrapParams(e, null, className, "ev", "data"));
675 functions.add(n + "__VLjava_lang_Object_2Ljava_lang_Object_2");
680 private CharSequence wrapParams(
681 ExecutableElement ee, String id, String className, String evName, String dataName
683 TypeMirror stringType = processingEnv.getElementUtils().getTypeElement("java.lang.String").asType();
684 StringBuilder params = new StringBuilder();
685 boolean first = true;
686 for (VariableElement ve : ee.getParameters()) {
691 String toCall = null;
692 if (ve.asType() == stringType) {
693 if (ve.getSimpleName().contentEquals("id")) {
694 params.append('"').append(id).append('"');
697 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toString(";
699 if (ve.asType().getKind() == TypeKind.DOUBLE) {
700 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toDouble(";
702 if (ve.asType().getKind() == TypeKind.INT) {
703 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toInt(";
705 if (dataName != null && ve.getSimpleName().contentEquals(dataName) && isModel(ve.asType())) {
706 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toModel(" + ve.asType() + ".class, ";
709 if (toCall != null) {
710 params.append(toCall);
711 if (dataName != null && ve.getSimpleName().contentEquals(dataName)) {
712 params.append(dataName);
713 params.append(", null");
715 params.append(evName);
716 params.append(", \"");
717 params.append(ve.getSimpleName().toString());
723 String rn = ve.asType().toString();
724 int last = rn.lastIndexOf('.');
726 rn = rn.substring(last + 1);
728 if (rn.equals(className)) {
729 params.append(className).append(".this");
732 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR,
733 "@On method can only accept String named 'id' or " + className + " arguments",
740 private boolean isModel(TypeMirror tm) {
741 final Element e = processingEnv.getTypeUtils().asElement(tm);
745 for (Element ch : e.getEnclosedElements()) {
746 if (ch.getKind() == ElementKind.METHOD) {
747 ExecutableElement ee = (ExecutableElement)ch;
748 if (ee.getParameters().isEmpty() && ee.getSimpleName().contentEquals("modelFor")) {
753 return models.values().contains(e.getSimpleName().toString());
756 private void writeStringArray(List<String> strings, Writer w) throws IOException {
757 w.write("new String[] {\n");
759 for (String n : strings) {
764 w.write(" \"" + n + "\"");