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);
149 writeToString(m.properties(), w);
154 } catch (IOException ex) {
155 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
161 private boolean processPage(Element e) {
163 Page p = e.getAnnotation(Page.class);
167 String pkg = findPkgName(e);
170 try (InputStream is = openStream(pkg, p.xhtml())) {
171 pp = ProcessPage.readPage(is);
173 } catch (IOException iOException) {
174 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't read " + p.xhtml(), e);
179 String className = p.className();
180 if (className.isEmpty()) {
181 int indx = p.xhtml().indexOf('.');
182 className = p.xhtml().substring(0, indx);
185 StringWriter body = new StringWriter();
186 List<String> propsGetSet = new ArrayList<>();
187 List<String> functions = new ArrayList<>();
188 Map<String, Collection<String>> propsDeps = new HashMap<>();
189 if (!generateComputedProperties(body, p.properties(), e.getEnclosedElements(), propsGetSet, propsDeps)) {
192 if (!generateProperties(e, body, p.properties(), propsGetSet, propsDeps)) {
195 if (!generateFunctions(e, body, className, e.getEnclosedElements(), functions)) {
199 FileObject java = processingEnv.getFiler().createSourceFile(pkg + '.' + className, e);
200 w = new OutputStreamWriter(java.openOutputStream());
202 w.append("package " + pkg + ";\n");
203 w.append("import org.apidesign.bck2brwsr.htmlpage.api.*;\n");
204 w.append("import org.apidesign.bck2brwsr.htmlpage.KOList;\n");
205 w.append("final class ").append(className).append(" {\n");
206 w.append(" private boolean locked;\n");
207 if (!initializeOnClick(className, (TypeElement) e, w, pp)) {
210 for (String id : pp.ids()) {
211 String tag = pp.tagNameForId(id);
212 String type = type(tag);
213 w.append(" ").append("public final ").
214 append(type).append(' ').append(cnstnt(id)).append(" = new ").
215 append(type).append("(\"").append(id).append("\");\n");
218 w.append(" private org.apidesign.bck2brwsr.htmlpage.Knockout ko;\n");
219 w.append(body.toString());
220 if (!propsGetSet.isEmpty()) {
221 w.write("public " + className + " applyBindings() {\n");
222 w.write(" ko = org.apidesign.bck2brwsr.htmlpage.Knockout.applyBindings(");
223 w.write(className + ".class, this, ");
224 writeStringArray(propsGetSet, w);
226 writeStringArray(functions, w);
227 w.write(");\n return this;\n}\n");
229 w.write("public void triggerEvent(Element e, OnEvent ev) {\n");
230 w.write(" org.apidesign.bck2brwsr.htmlpage.Knockout.triggerEvent(e.getId(), ev.getElementPropertyName());\n");
237 } catch (IOException ex) {
238 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
244 private static String type(String tag) {
245 if (tag.equals("title")) {
248 if (tag.equals("button")) {
251 if (tag.equals("input")) {
254 if (tag.equals("canvas")) {
257 if (tag.equals("img")) {
263 private static String cnstnt(String id) {
264 return id.replace('.', '_').replace('-', '_');
267 private boolean initializeOnClick(
268 String className, TypeElement type, Writer w, ProcessPage pp
269 ) throws IOException {
271 TypeMirror stringType = processingEnv.getElementUtils().getTypeElement("java.lang.String").asType();
272 { //for (Element clazz : pe.getEnclosedElements()) {
273 // if (clazz.getKind() != ElementKind.CLASS) {
276 w.append(" public ").append(className).append("() {\n");
277 StringBuilder dispatch = new StringBuilder();
279 for (Element method : type.getEnclosedElements()) {
280 On oc = method.getAnnotation(On.class);
282 for (String id : oc.id()) {
284 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "id = " + id + " not found in HTML page.");
288 if (pp.tagNameForId(id) == null) {
289 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "id = " + id + " does not exist in the HTML page. Found only " + pp.ids(), method);
293 ExecutableElement ee = (ExecutableElement)method;
294 CharSequence params = wrapParams(ee, id, className, "ev", null);
295 if (!ee.getModifiers().contains(Modifier.STATIC)) {
296 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method has to be static", ee);
300 if (ee.getModifiers().contains(Modifier.PRIVATE)) {
301 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method can't be private", ee);
305 w.append(" OnEvent." + oc.event()).append(".of(").append(cnstnt(id)).
306 append(").perform(new OnDispatch(" + dispatchCnt + "));\n");
309 append(" case ").append(dispatchCnt).append(": ").
310 append(type.getSimpleName().toString()).
311 append('.').append(ee.getSimpleName()).append("(").
313 append("); break;\n");
320 if (dispatchCnt > 0) {
321 w.append("class OnDispatch implements OnHandler {\n");
322 w.append(" private final int dispatch;\n");
323 w.append(" OnDispatch(int d) { dispatch = d; }\n");
324 w.append(" public void onEvent(Object ev) {\n");
325 w.append(" switch (dispatch) {\n");
338 public Iterable<? extends Completion> getCompletions(
339 Element element, AnnotationMirror annotation,
340 ExecutableElement member, String userText
342 if (!userText.startsWith("\"")) {
343 return Collections.emptyList();
346 Element cls = findClass(element);
347 Page p = cls.getAnnotation(Page.class);
348 String pkg = findPkgName(cls);
351 InputStream is = openStream(pkg, p.xhtml());
352 pp = ProcessPage.readPage(is);
354 } catch (IOException iOException) {
355 return Collections.emptyList();
358 List<Completion> cc = new ArrayList<>();
359 userText = userText.substring(1);
360 for (String id : pp.ids()) {
361 if (id.startsWith(userText)) {
362 cc.add(Completions.of("\"" + id + "\"", id));
368 private static Element findClass(Element e) {
372 Page p = e.getAnnotation(Page.class);
376 return e.getEnclosingElement();
379 private boolean generateProperties(
381 Writer w, Property[] properties,
382 Collection<String> props, Map<String,Collection<String>> deps
383 ) throws IOException {
385 for (Property p : properties) {
387 tn = typeName(where, p);
388 String[] gs = toGetSet(p.name(), tn, p.array());
391 w.write("private KOList<" + tn + "> prop_" + p.name() + " = new KOList<" + tn + ">(\""
393 final Collection<String> dependants = deps.get(p.name());
394 if (dependants != null) {
395 for (String depProp : dependants) {
403 w.write("public java.util.List<" + tn + "> " + gs[0] + "() {\n");
404 w.write(" if (locked) throw new IllegalStateException();\n");
405 w.write(" prop_" + p.name() + ".assign(ko);\n");
406 w.write(" return prop_" + p.name() + ";\n");
409 w.write("private " + tn + " prop_" + p.name() + ";\n");
410 w.write("public " + tn + " " + gs[0] + "() {\n");
411 w.write(" if (locked) throw new IllegalStateException();\n");
412 w.write(" return prop_" + p.name() + ";\n");
414 w.write("public void " + gs[1] + "(" + tn + " v) {\n");
415 w.write(" if (locked) throw new IllegalStateException();\n");
416 w.write(" prop_" + p.name() + " = v;\n");
417 w.write(" if (ko != null) {\n");
418 w.write(" ko.valueHasMutated(\"" + p.name() + "\");\n");
419 final Collection<String> dependants = deps.get(p.name());
420 if (dependants != null) {
421 for (String depProp : dependants) {
422 w.write(" ko.valueHasMutated(\"" + depProp + "\");\n");
437 private boolean generateComputedProperties(
438 Writer w, Property[] fixedProps,
439 Collection<? extends Element> arr, Collection<String> props,
440 Map<String,Collection<String>> deps
441 ) throws IOException {
443 for (Element e : arr) {
444 if (e.getKind() != ElementKind.METHOD) {
447 if (e.getAnnotation(ComputedProperty.class) == null) {
450 ExecutableElement ee = (ExecutableElement)e;
451 final TypeMirror rt = ee.getReturnType();
452 final Types tu = processingEnv.getTypeUtils();
453 TypeMirror ert = tu.erasure(rt);
454 String tn = ert.toString();
455 boolean array = false;
456 if (tn.equals("java.util.List")) {
460 final String sn = ee.getSimpleName().toString();
461 String[] gs = toGetSet(sn, tn, array);
463 w.write("public " + tn + " " + gs[0] + "() {\n");
464 w.write(" if (locked) throw new IllegalStateException();\n");
466 for (VariableElement pe : ee.getParameters()) {
467 final String dn = pe.getSimpleName().toString();
469 if (!verifyPropName(pe, dn, fixedProps)) {
473 final String dt = pe.asType().toString();
474 String[] call = toGetSet(dn, dt, false);
475 w.write(" " + dt + " arg" + (++arg) + " = ");
476 w.write(call[0] + "();\n");
478 Collection<String> depends = deps.get(dn);
479 if (depends == null) {
480 depends = new LinkedHashSet<>();
481 deps.put(dn, depends);
486 w.write(" locked = true;\n");
487 w.write(" return " + e.getEnclosingElement().getSimpleName() + '.' + e.getSimpleName() + "(");
489 for (int i = 1; i <= arg; i++) {
495 w.write(" } finally {\n");
496 w.write(" locked = false;\n");
500 props.add(e.getSimpleName().toString());
509 private static String[] toGetSet(String name, String type, boolean array) {
510 String n = Character.toUpperCase(name.charAt(0)) + name.substring(1);
511 String bck2brwsrType = "L" + type.replace('.', '_') + "_2";
512 if ("int".equals(type)) {
515 if ("double".equals(type)) {
519 if ("boolean".equals(type)) {
523 final String nu = n.replace('.', '_');
525 return new String[] {
528 "get" + nu + "__Ljava_util_List_2",
535 pref + nu + "__" + bck2brwsrType,
536 "set" + nu + "__V" + bck2brwsrType
540 private String typeName(Element where, Property p) {
542 boolean isModel = false;
543 boolean isEnum = false;
545 ret = p.type().getName();
546 } catch (MirroredTypeException ex) {
547 TypeMirror tm = processingEnv.getTypeUtils().erasure(ex.getTypeMirror());
548 final Element e = processingEnv.getTypeUtils().asElement(tm);
549 final Model m = e == null ? null : e.getAnnotation(Model.class);
551 ret = findPkgName(e) + '.' + m.className();
553 models.put(e, m.className());
557 TypeMirror enm = processingEnv.getElementUtils().getTypeElement("java.lang.Enum").asType();
558 enm = processingEnv.getTypeUtils().erasure(enm);
559 isEnum = processingEnv.getTypeUtils().isSubtype(tm, enm);
562 String bt = findBoxedType(ret);
567 if (!isModel && !"java.lang.String".equals(ret) && !isEnum) {
568 String bt = findBoxedType(ret);
570 processingEnv.getMessager().printMessage(
571 Diagnostic.Kind.ERROR,
572 "Only primitive types supported in the mapping. Not " + ret,
580 private static String findBoxedType(String ret) {
581 if (ret.equals("boolean")) {
582 return Boolean.class.getName();
584 if (ret.equals("byte")) {
585 return Byte.class.getName();
587 if (ret.equals("short")) {
588 return Short.class.getName();
590 if (ret.equals("char")) {
591 return Character.class.getName();
593 if (ret.equals("int")) {
594 return Integer.class.getName();
596 if (ret.equals("long")) {
597 return Long.class.getName();
599 if (ret.equals("float")) {
600 return Float.class.getName();
602 if (ret.equals("double")) {
603 return Double.class.getName();
608 private boolean verifyPropName(Element e, String propName, Property[] existingProps) {
609 StringBuilder sb = new StringBuilder();
611 for (Property property : existingProps) {
612 if (property.name().equals(propName)) {
617 sb.append(property.name());
621 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR,
622 propName + " is not one of known properties: " + sb
628 private static String findPkgName(Element e) {
630 if (e.getKind() == ElementKind.PACKAGE) {
631 return ((PackageElement)e).getQualifiedName().toString();
633 e = e.getEnclosingElement();
637 private boolean generateFunctions(
638 Element clazz, StringWriter body, String className,
639 List<? extends Element> enclosedElements, List<String> functions
641 for (Element m : enclosedElements) {
642 if (m.getKind() != ElementKind.METHOD) {
645 ExecutableElement e = (ExecutableElement)m;
646 OnFunction onF = e.getAnnotation(OnFunction.class);
650 if (!e.getModifiers().contains(Modifier.STATIC)) {
651 processingEnv.getMessager().printMessage(
652 Diagnostic.Kind.ERROR, "@OnFunction method needs to be static", e
656 if (e.getModifiers().contains(Modifier.PRIVATE)) {
657 processingEnv.getMessager().printMessage(
658 Diagnostic.Kind.ERROR, "@OnFunction method cannot be private", e
662 if (e.getReturnType().getKind() != TypeKind.VOID) {
663 processingEnv.getMessager().printMessage(
664 Diagnostic.Kind.ERROR, "@OnFunction method should return void", e
668 String n = e.getSimpleName().toString();
669 body.append("void ").append(n).append("(Object data, Object ev) {\n");
670 body.append(" ").append(clazz.getSimpleName()).append(".").append(n).append("(");
671 body.append(wrapParams(e, null, className, "ev", "data"));
676 functions.add(n + "__VLjava_lang_Object_2Ljava_lang_Object_2");
681 private CharSequence wrapParams(
682 ExecutableElement ee, String id, String className, String evName, String dataName
684 TypeMirror stringType = processingEnv.getElementUtils().getTypeElement("java.lang.String").asType();
685 StringBuilder params = new StringBuilder();
686 boolean first = true;
687 for (VariableElement ve : ee.getParameters()) {
692 String toCall = null;
693 if (ve.asType() == stringType) {
694 if (ve.getSimpleName().contentEquals("id")) {
695 params.append('"').append(id).append('"');
698 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toString(";
700 if (ve.asType().getKind() == TypeKind.DOUBLE) {
701 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toDouble(";
703 if (ve.asType().getKind() == TypeKind.INT) {
704 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toInt(";
706 if (dataName != null && ve.getSimpleName().contentEquals(dataName) && isModel(ve.asType())) {
707 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toModel(" + ve.asType() + ".class, ";
710 if (toCall != null) {
711 params.append(toCall);
712 if (dataName != null && ve.getSimpleName().contentEquals(dataName)) {
713 params.append(dataName);
714 params.append(", null");
716 params.append(evName);
717 params.append(", \"");
718 params.append(ve.getSimpleName().toString());
724 String rn = ve.asType().toString();
725 int last = rn.lastIndexOf('.');
727 rn = rn.substring(last + 1);
729 if (rn.equals(className)) {
730 params.append(className).append(".this");
733 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR,
734 "@On method can only accept String named 'id' or " + className + " arguments",
741 private boolean isModel(TypeMirror tm) {
742 final Element e = processingEnv.getTypeUtils().asElement(tm);
746 for (Element ch : e.getEnclosedElements()) {
747 if (ch.getKind() == ElementKind.METHOD) {
748 ExecutableElement ee = (ExecutableElement)ch;
749 if (ee.getParameters().isEmpty() && ee.getSimpleName().contentEquals("modelFor")) {
754 return models.values().contains(e.getSimpleName().toString());
757 private void writeStringArray(List<String> strings, Writer w) throws IOException {
758 w.write("new String[] {\n");
760 for (String n : strings) {
765 w.write(" \"" + n + "\"");
772 private void writeToString(Property[] props, Writer w) throws IOException {
773 w.write(" public String toString() {\n");
774 w.write(" StringBuilder sb = new StringBuilder();\n");
775 w.write(" sb.append('{');\n");
777 for (Property p : props) {
779 w.append(" sb.append(\"" + p.name() + ": \");\n");
780 w.append(" sb.append('\"');");
781 w.append(" sb.append(prop_").append(p.name()).append(");\n");
782 w.append(" sb.append('\"');");
783 sep = " sb.append(',');\n";
785 w.write(" sb.append('}');\n");
786 w.write(" return sb.toString();\n");