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.Elements;
52 import javax.lang.model.util.Types;
53 import javax.tools.Diagnostic;
54 import javax.tools.FileObject;
55 import javax.tools.StandardLocation;
56 import org.apidesign.bck2brwsr.htmlpage.api.ComputedProperty;
57 import org.apidesign.bck2brwsr.htmlpage.api.Model;
58 import org.apidesign.bck2brwsr.htmlpage.api.On;
59 import org.apidesign.bck2brwsr.htmlpage.api.OnFunction;
60 import org.apidesign.bck2brwsr.htmlpage.api.Page;
61 import org.apidesign.bck2brwsr.htmlpage.api.Property;
62 import org.openide.util.lookup.ServiceProvider;
64 /** Annotation processor to process an XHTML page and generate appropriate
67 * @author Jaroslav Tulach <jtulach@netbeans.org>
69 @ServiceProvider(service=Processor.class)
70 @SupportedAnnotationTypes({
71 "org.apidesign.bck2brwsr.htmlpage.api.Model",
72 "org.apidesign.bck2brwsr.htmlpage.api.Page",
73 "org.apidesign.bck2brwsr.htmlpage.api.OnFunction",
74 "org.apidesign.bck2brwsr.htmlpage.api.On"
76 public final class PageProcessor extends AbstractProcessor {
77 private final Map<Element,String> models = new WeakHashMap<>();
79 public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
81 for (Element e : roundEnv.getElementsAnnotatedWith(Model.class)) {
82 if (!processModel(e)) {
86 for (Element e : roundEnv.getElementsAnnotatedWith(Page.class)) {
87 if (!processPage(e)) {
91 if (roundEnv.processingOver()) {
97 private InputStream openStream(String pkg, String name) throws IOException {
99 FileObject fo = processingEnv.getFiler().getResource(
100 StandardLocation.SOURCE_PATH, pkg, name);
101 return fo.openInputStream();
102 } catch (IOException ex) {
103 return processingEnv.getFiler().getResource(StandardLocation.CLASS_OUTPUT, pkg, name).openInputStream();
107 private boolean processModel(Element e) {
109 Model m = e.getAnnotation(Model.class);
113 String pkg = findPkgName(e);
115 String className = m.className();
117 StringWriter body = new StringWriter();
118 List<String> propsGetSet = new ArrayList<>();
119 List<String> functions = new ArrayList<>();
120 Map<String, Collection<String>> propsDeps = new HashMap<>();
121 if (!generateComputedProperties(body, m.properties(), e.getEnclosedElements(), propsGetSet, propsDeps)) {
124 if (!generateProperties(e, body, m.properties(), propsGetSet, propsDeps)) {
127 if (!generateFunctions(e, body, className, e.getEnclosedElements(), functions)) {
130 FileObject java = processingEnv.getFiler().createSourceFile(pkg + '.' + className, e);
131 w = new OutputStreamWriter(java.openOutputStream());
133 w.append("package " + pkg + ";\n");
134 w.append("import org.apidesign.bck2brwsr.htmlpage.api.*;\n");
135 w.append("import org.apidesign.bck2brwsr.htmlpage.KOList;\n");
136 w.append("import org.apidesign.bck2brwsr.core.JavaScriptOnly;\n");
137 w.append("final class ").append(className).append(" {\n");
138 w.append(" private Object json;\n");
139 w.append(" private boolean locked;\n");
140 w.append(" private org.apidesign.bck2brwsr.htmlpage.Knockout ko;\n");
141 w.append(body.toString());
142 w.append(" private static Class<" + inPckName(e) + "> modelFor() { return null; }\n");
143 w.append(" public ").append(className).append("() {\n");
144 w.append(" ko = org.apidesign.bck2brwsr.htmlpage.Knockout.applyBindings(this, ");
145 writeStringArray(propsGetSet, w);
147 writeStringArray(functions, w);
150 writeToString(m.properties(), w);
155 } catch (IOException ex) {
156 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
162 private boolean processPage(Element e) {
164 Page p = e.getAnnotation(Page.class);
168 String pkg = findPkgName(e);
171 try (InputStream is = openStream(pkg, p.xhtml())) {
172 pp = ProcessPage.readPage(is);
174 } catch (IOException iOException) {
175 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't read " + p.xhtml() + " as " + iOException.getMessage(), e);
180 String className = p.className();
181 if (className.isEmpty()) {
182 int indx = p.xhtml().indexOf('.');
183 className = p.xhtml().substring(0, indx);
186 StringWriter body = new StringWriter();
187 List<String> propsGetSet = new ArrayList<>();
188 List<String> functions = new ArrayList<>();
189 Map<String, Collection<String>> propsDeps = new HashMap<>();
190 if (!generateComputedProperties(body, p.properties(), e.getEnclosedElements(), propsGetSet, propsDeps)) {
193 if (!generateProperties(e, body, p.properties(), propsGetSet, propsDeps)) {
196 if (!generateFunctions(e, body, className, e.getEnclosedElements(), functions)) {
200 FileObject java = processingEnv.getFiler().createSourceFile(pkg + '.' + className, e);
201 w = new OutputStreamWriter(java.openOutputStream());
203 w.append("package " + pkg + ";\n");
204 w.append("import org.apidesign.bck2brwsr.htmlpage.api.*;\n");
205 w.append("import org.apidesign.bck2brwsr.htmlpage.KOList;\n");
206 w.append("final class ").append(className).append(" {\n");
207 w.append(" private boolean locked;\n");
208 if (!initializeOnClick(className, (TypeElement) e, w, pp)) {
211 if (pp != null) for (String id : pp.ids()) {
212 String tag = pp.tagNameForId(id);
213 String type = type(tag);
214 w.append(" ").append("public final ").
215 append(type).append(' ').append(cnstnt(id)).append(" = new ").
216 append(type).append("(\"").append(id).append("\");\n");
219 w.append(" private org.apidesign.bck2brwsr.htmlpage.Knockout ko;\n");
220 w.append(body.toString());
221 if (!propsGetSet.isEmpty()) {
222 w.write("public " + className + " applyBindings() {\n");
223 w.write(" ko = org.apidesign.bck2brwsr.htmlpage.Knockout.applyBindings(");
224 w.write(className + ".class, this, ");
225 writeStringArray(propsGetSet, w);
227 writeStringArray(functions, w);
228 w.write(");\n return this;\n}\n");
230 w.write("public void triggerEvent(Element e, OnEvent ev) {\n");
231 w.write(" org.apidesign.bck2brwsr.htmlpage.Knockout.triggerEvent(e.getId(), ev.getElementPropertyName());\n");
238 } catch (IOException ex) {
239 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
245 private static String type(String tag) {
246 if (tag.equals("title")) {
249 if (tag.equals("button")) {
252 if (tag.equals("input")) {
255 if (tag.equals("canvas")) {
258 if (tag.equals("img")) {
264 private static String cnstnt(String id) {
265 return id.replace('.', '_').replace('-', '_');
268 private boolean initializeOnClick(
269 String className, TypeElement type, Writer w, ProcessPage pp
270 ) throws IOException {
272 TypeMirror stringType = processingEnv.getElementUtils().getTypeElement("java.lang.String").asType();
273 { //for (Element clazz : pe.getEnclosedElements()) {
274 // if (clazz.getKind() != ElementKind.CLASS) {
277 w.append(" public ").append(className).append("() {\n");
278 StringBuilder dispatch = new StringBuilder();
280 for (Element method : type.getEnclosedElements()) {
281 On oc = method.getAnnotation(On.class);
283 for (String id : oc.id()) {
285 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "id = " + id + " not found in HTML page.");
289 if (pp.tagNameForId(id) == null) {
290 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "id = " + id + " does not exist in the HTML page. Found only " + pp.ids(), method);
294 ExecutableElement ee = (ExecutableElement)method;
295 CharSequence params = wrapParams(ee, id, className, "ev", null);
296 if (!ee.getModifiers().contains(Modifier.STATIC)) {
297 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method has to be static", ee);
301 if (ee.getModifiers().contains(Modifier.PRIVATE)) {
302 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method can't be private", ee);
306 w.append(" OnEvent." + oc.event()).append(".of(").append(cnstnt(id)).
307 append(").perform(new OnDispatch(" + dispatchCnt + "));\n");
310 append(" case ").append(dispatchCnt).append(": ").
311 append(type.getSimpleName().toString()).
312 append('.').append(ee.getSimpleName()).append("(").
314 append("); break;\n");
321 if (dispatchCnt > 0) {
322 w.append("class OnDispatch implements OnHandler {\n");
323 w.append(" private final int dispatch;\n");
324 w.append(" OnDispatch(int d) { dispatch = d; }\n");
325 w.append(" public void onEvent(Object ev) {\n");
326 w.append(" switch (dispatch) {\n");
339 public Iterable<? extends Completion> getCompletions(
340 Element element, AnnotationMirror annotation,
341 ExecutableElement member, String userText
343 if (!userText.startsWith("\"")) {
344 return Collections.emptyList();
347 Element cls = findClass(element);
348 Page p = cls.getAnnotation(Page.class);
349 String pkg = findPkgName(cls);
352 InputStream is = openStream(pkg, p.xhtml());
353 pp = ProcessPage.readPage(is);
355 } catch (IOException iOException) {
356 return Collections.emptyList();
359 List<Completion> cc = new ArrayList<>();
360 userText = userText.substring(1);
361 for (String id : pp.ids()) {
362 if (id.startsWith(userText)) {
363 cc.add(Completions.of("\"" + id + "\"", id));
369 private static Element findClass(Element e) {
373 Page p = e.getAnnotation(Page.class);
377 return e.getEnclosingElement();
380 private boolean generateProperties(
382 Writer w, Property[] properties,
383 Collection<String> props, Map<String,Collection<String>> deps
384 ) throws IOException {
386 for (Property p : properties) {
388 tn = typeName(where, p);
389 String[] gs = toGetSet(p.name(), tn, p.array());
392 w.write("private KOList<" + tn + "> prop_" + p.name() + " = new KOList<" + tn + ">(\""
394 final Collection<String> dependants = deps.get(p.name());
395 if (dependants != null) {
396 for (String depProp : dependants) {
404 w.write("public java.util.List<" + tn + "> " + gs[0] + "() {\n");
405 w.write(" if (locked) throw new IllegalStateException();\n");
406 w.write(" prop_" + p.name() + ".assign(ko);\n");
407 w.write(" return prop_" + p.name() + ";\n");
410 w.write("private " + tn + " prop_" + p.name() + ";\n");
411 w.write("public " + tn + " " + gs[0] + "() {\n");
412 w.write(" if (locked) throw new IllegalStateException();\n");
413 w.write(" return prop_" + p.name() + ";\n");
415 w.write("public void " + gs[1] + "(" + tn + " v) {\n");
416 w.write(" if (locked) throw new IllegalStateException();\n");
417 w.write(" prop_" + p.name() + " = v;\n");
418 w.write(" if (ko != null) {\n");
419 w.write(" ko.valueHasMutated(\"" + p.name() + "\");\n");
420 final Collection<String> dependants = deps.get(p.name());
421 if (dependants != null) {
422 for (String depProp : dependants) {
423 w.write(" ko.valueHasMutated(\"" + depProp + "\");\n");
438 private boolean generateComputedProperties(
439 Writer w, Property[] fixedProps,
440 Collection<? extends Element> arr, Collection<String> props,
441 Map<String,Collection<String>> deps
442 ) throws IOException {
444 for (Element e : arr) {
445 if (e.getKind() != ElementKind.METHOD) {
448 if (e.getAnnotation(ComputedProperty.class) == null) {
451 ExecutableElement ee = (ExecutableElement)e;
452 final TypeMirror rt = ee.getReturnType();
453 final Types tu = processingEnv.getTypeUtils();
454 TypeMirror ert = tu.erasure(rt);
455 String tn = fqn(ert, ee);
456 boolean array = false;
457 if (tn.equals("java.util.List")) {
461 final String sn = ee.getSimpleName().toString();
462 String[] gs = toGetSet(sn, tn, array);
464 w.write("public " + tn + " " + gs[0] + "() {\n");
465 w.write(" if (locked) throw new IllegalStateException();\n");
467 for (VariableElement pe : ee.getParameters()) {
468 final String dn = pe.getSimpleName().toString();
470 if (!verifyPropName(pe, dn, fixedProps)) {
474 final String dt = fqn(pe.asType(), ee);
475 String[] call = toGetSet(dn, dt, false);
476 w.write(" " + dt + " arg" + (++arg) + " = ");
477 w.write(call[0] + "();\n");
479 Collection<String> depends = deps.get(dn);
480 if (depends == null) {
481 depends = new LinkedHashSet<>();
482 deps.put(dn, depends);
487 w.write(" locked = true;\n");
488 w.write(" return " + e.getEnclosingElement().getSimpleName() + '.' + e.getSimpleName() + "(");
490 for (int i = 1; i <= arg; i++) {
496 w.write(" } finally {\n");
497 w.write(" locked = false;\n");
501 props.add(e.getSimpleName().toString());
510 private static String[] toGetSet(String name, String type, boolean array) {
511 String n = Character.toUpperCase(name.charAt(0)) + name.substring(1);
512 String bck2brwsrType = "L" + type.replace('.', '_') + "_2";
513 if ("int".equals(type)) {
516 if ("double".equals(type)) {
520 if ("boolean".equals(type)) {
524 final String nu = n.replace('.', '_');
526 return new String[] {
529 "get" + nu + "__Ljava_util_List_2",
536 pref + nu + "__" + bck2brwsrType,
537 "set" + nu + "__V" + bck2brwsrType
541 private String typeName(Element where, Property p) {
543 boolean isModel = false;
544 boolean isEnum = false;
546 ret = p.type().getName();
547 } catch (MirroredTypeException ex) {
548 TypeMirror tm = processingEnv.getTypeUtils().erasure(ex.getTypeMirror());
549 final Element e = processingEnv.getTypeUtils().asElement(tm);
550 final Model m = e == null ? null : e.getAnnotation(Model.class);
552 ret = findPkgName(e) + '.' + m.className();
554 models.put(e, m.className());
558 TypeMirror enm = processingEnv.getElementUtils().getTypeElement("java.lang.Enum").asType();
559 enm = processingEnv.getTypeUtils().erasure(enm);
560 isEnum = processingEnv.getTypeUtils().isSubtype(tm, enm);
563 String bt = findBoxedType(ret);
568 if (!isModel && !"java.lang.String".equals(ret) && !isEnum) {
569 String bt = findBoxedType(ret);
571 processingEnv.getMessager().printMessage(
572 Diagnostic.Kind.ERROR,
573 "Only primitive types supported in the mapping. Not " + ret,
581 private static String findBoxedType(String ret) {
582 if (ret.equals("boolean")) {
583 return Boolean.class.getName();
585 if (ret.equals("byte")) {
586 return Byte.class.getName();
588 if (ret.equals("short")) {
589 return Short.class.getName();
591 if (ret.equals("char")) {
592 return Character.class.getName();
594 if (ret.equals("int")) {
595 return Integer.class.getName();
597 if (ret.equals("long")) {
598 return Long.class.getName();
600 if (ret.equals("float")) {
601 return Float.class.getName();
603 if (ret.equals("double")) {
604 return Double.class.getName();
609 private boolean verifyPropName(Element e, String propName, Property[] existingProps) {
610 StringBuilder sb = new StringBuilder();
612 for (Property property : existingProps) {
613 if (property.name().equals(propName)) {
618 sb.append(property.name());
622 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR,
623 propName + " is not one of known properties: " + sb
629 private static String findPkgName(Element e) {
631 if (e.getKind() == ElementKind.PACKAGE) {
632 return ((PackageElement)e).getQualifiedName().toString();
634 e = e.getEnclosingElement();
638 private boolean generateFunctions(
639 Element clazz, StringWriter body, String className,
640 List<? extends Element> enclosedElements, List<String> functions
642 for (Element m : enclosedElements) {
643 if (m.getKind() != ElementKind.METHOD) {
646 ExecutableElement e = (ExecutableElement)m;
647 OnFunction onF = e.getAnnotation(OnFunction.class);
651 if (!e.getModifiers().contains(Modifier.STATIC)) {
652 processingEnv.getMessager().printMessage(
653 Diagnostic.Kind.ERROR, "@OnFunction method needs to be static", e
657 if (e.getModifiers().contains(Modifier.PRIVATE)) {
658 processingEnv.getMessager().printMessage(
659 Diagnostic.Kind.ERROR, "@OnFunction method cannot be private", e
663 if (e.getReturnType().getKind() != TypeKind.VOID) {
664 processingEnv.getMessager().printMessage(
665 Diagnostic.Kind.ERROR, "@OnFunction method should return void", e
669 String n = e.getSimpleName().toString();
670 body.append("private void ").append(n).append("(Object data, Object ev) {\n");
671 body.append(" ").append(clazz.getSimpleName()).append(".").append(n).append("(");
672 body.append(wrapParams(e, null, className, "ev", "data"));
677 functions.add(n + "__VLjava_lang_Object_2Ljava_lang_Object_2");
682 private CharSequence wrapParams(
683 ExecutableElement ee, String id, String className, String evName, String dataName
685 TypeMirror stringType = processingEnv.getElementUtils().getTypeElement("java.lang.String").asType();
686 StringBuilder params = new StringBuilder();
687 boolean first = true;
688 for (VariableElement ve : ee.getParameters()) {
693 String toCall = null;
694 if (ve.asType() == stringType) {
695 if (ve.getSimpleName().contentEquals("id")) {
696 params.append('"').append(id).append('"');
699 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toString(";
701 if (ve.asType().getKind() == TypeKind.DOUBLE) {
702 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toDouble(";
704 if (ve.asType().getKind() == TypeKind.INT) {
705 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toInt(";
707 if (dataName != null && ve.getSimpleName().contentEquals(dataName) && isModel(ve.asType())) {
708 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toModel(" + ve.asType() + ".class, ";
711 if (toCall != null) {
712 params.append(toCall);
713 if (dataName != null && ve.getSimpleName().contentEquals(dataName)) {
714 params.append(dataName);
715 params.append(", null");
717 params.append(evName);
718 params.append(", \"");
719 params.append(ve.getSimpleName().toString());
725 String rn = fqn(ve.asType(), ee);
726 int last = rn.lastIndexOf('.');
728 rn = rn.substring(last + 1);
730 if (rn.equals(className)) {
731 params.append(className).append(".this");
734 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR,
735 "@On method can only accept String named 'id' or " + className + " arguments",
742 private boolean isModel(TypeMirror tm) {
743 final Element e = processingEnv.getTypeUtils().asElement(tm);
747 for (Element ch : e.getEnclosedElements()) {
748 if (ch.getKind() == ElementKind.METHOD) {
749 ExecutableElement ee = (ExecutableElement)ch;
750 if (ee.getParameters().isEmpty() && ee.getSimpleName().contentEquals("modelFor")) {
755 return models.values().contains(e.getSimpleName().toString());
758 private void writeStringArray(List<String> strings, Writer w) throws IOException {
759 w.write("new String[] {\n");
761 for (String n : strings) {
766 w.write(" \"" + n + "\"");
773 private void writeToString(Property[] props, Writer w) throws IOException {
774 w.write(" public String toString() {\n");
775 w.write(" StringBuilder sb = new StringBuilder();\n");
776 w.write(" sb.append('{');\n");
778 for (Property p : props) {
780 w.append(" sb.append(\"" + p.name() + ": \");\n");
781 w.append(" sb.append(org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toJSON(prop_");
782 w.append(p.name()).append("));\n");
783 sep = " sb.append(',');\n";
785 w.write(" sb.append('}');\n");
786 w.write(" return sb.toString();\n");
790 private String inPckName(Element e) {
791 StringBuilder sb = new StringBuilder();
792 while (e.getKind() != ElementKind.PACKAGE) {
793 if (sb.length() == 0) {
794 sb.append(e.getSimpleName());
797 sb.insert(0, e.getSimpleName());
799 e = e.getEnclosingElement();
801 return sb.toString();
804 private String fqn(TypeMirror pt, Element relative) {
805 if (pt.getKind() == TypeKind.ERROR) {
806 final Elements eu = processingEnv.getElementUtils();
807 PackageElement pckg = eu.getPackageOf(relative);
808 return pckg.getQualifiedName() + "." + pt.toString();
810 return pt.toString();