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 Map<String, Collection<String>> propsDeps = new HashMap<>();
119 if (!generateComputedProperties(body, m.properties(), e.getEnclosedElements(), propsGetSet, propsDeps)) {
122 if (!generateProperties(e, body, m.properties(), propsGetSet, propsDeps)) {
125 FileObject java = processingEnv.getFiler().createSourceFile(pkg + '.' + className, e);
126 w = new OutputStreamWriter(java.openOutputStream());
128 w.append("package " + pkg + ";\n");
129 w.append("import org.apidesign.bck2brwsr.htmlpage.api.*;\n");
130 w.append("import org.apidesign.bck2brwsr.htmlpage.KOList;\n");
131 w.append("import org.apidesign.bck2brwsr.core.JavaScriptOnly;\n");
132 w.append("final class ").append(className).append(" {\n");
133 w.append(" private Object json;\n");
134 w.append(" private boolean locked;\n");
135 w.append(" private org.apidesign.bck2brwsr.htmlpage.Knockout ko;\n");
136 w.append(body.toString());
137 w.append(" private static Class<" + e.getSimpleName() + "> modelFor() { return null; }\n");
138 w.append(" public ").append(className).append("() {\n");
139 w.append(" ko = org.apidesign.bck2brwsr.htmlpage.Knockout.applyBindings(this, ");
140 writeStringArray(propsGetSet, w);
142 writeStringArray(Collections.<String>emptyList(), w);
149 } catch (IOException ex) {
150 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
156 private boolean processPage(Element e) {
158 Page p = e.getAnnotation(Page.class);
162 String pkg = findPkgName(e);
165 try (InputStream is = openStream(pkg, p.xhtml())) {
166 pp = ProcessPage.readPage(is);
168 } catch (IOException iOException) {
169 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't read " + p.xhtml(), e);
174 String className = p.className();
175 if (className.isEmpty()) {
176 int indx = p.xhtml().indexOf('.');
177 className = p.xhtml().substring(0, indx);
180 StringWriter body = new StringWriter();
181 List<String> propsGetSet = new ArrayList<>();
182 List<String> functions = new ArrayList<>();
183 Map<String, Collection<String>> propsDeps = new HashMap<>();
184 if (!generateComputedProperties(body, p.properties(), e.getEnclosedElements(), propsGetSet, propsDeps)) {
187 if (!generateProperties(e, body, p.properties(), propsGetSet, propsDeps)) {
190 if (!generateFunctions(e, body, className, e.getEnclosedElements(), functions)) {
194 FileObject java = processingEnv.getFiler().createSourceFile(pkg + '.' + className, e);
195 w = new OutputStreamWriter(java.openOutputStream());
197 w.append("package " + pkg + ";\n");
198 w.append("import org.apidesign.bck2brwsr.htmlpage.api.*;\n");
199 w.append("import org.apidesign.bck2brwsr.htmlpage.KOList;\n");
200 w.append("final class ").append(className).append(" {\n");
201 w.append(" private boolean locked;\n");
202 if (!initializeOnClick(className, (TypeElement) e, w, pp)) {
205 for (String id : pp.ids()) {
206 String tag = pp.tagNameForId(id);
207 String type = type(tag);
208 w.append(" ").append("public final ").
209 append(type).append(' ').append(cnstnt(id)).append(" = new ").
210 append(type).append("(\"").append(id).append("\");\n");
213 w.append(" private org.apidesign.bck2brwsr.htmlpage.Knockout ko;\n");
214 w.append(body.toString());
215 if (!propsGetSet.isEmpty()) {
216 w.write("public " + className + " applyBindings() {\n");
217 w.write(" ko = org.apidesign.bck2brwsr.htmlpage.Knockout.applyBindings(");
218 w.write(className + ".class, this, ");
219 writeStringArray(propsGetSet, w);
221 writeStringArray(functions, w);
222 w.write(");\n return this;\n}\n");
224 w.write("public void triggerEvent(Element e, OnEvent ev) {\n");
225 w.write(" org.apidesign.bck2brwsr.htmlpage.Knockout.triggerEvent(e.getId(), ev.getElementPropertyName());\n");
232 } catch (IOException ex) {
233 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
239 private static String type(String tag) {
240 if (tag.equals("title")) {
243 if (tag.equals("button")) {
246 if (tag.equals("input")) {
249 if (tag.equals("canvas")) {
252 if (tag.equals("img")) {
258 private static String cnstnt(String id) {
259 return id.replace('.', '_').replace('-', '_');
262 private boolean initializeOnClick(
263 String className, TypeElement type, Writer w, ProcessPage pp
264 ) throws IOException {
266 TypeMirror stringType = processingEnv.getElementUtils().getTypeElement("java.lang.String").asType();
267 { //for (Element clazz : pe.getEnclosedElements()) {
268 // if (clazz.getKind() != ElementKind.CLASS) {
271 w.append(" public ").append(className).append("() {\n");
272 StringBuilder dispatch = new StringBuilder();
274 for (Element method : type.getEnclosedElements()) {
275 On oc = method.getAnnotation(On.class);
277 for (String id : oc.id()) {
279 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "id = " + id + " not found in HTML page.");
283 if (pp.tagNameForId(id) == null) {
284 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "id = " + id + " does not exist in the HTML page. Found only " + pp.ids(), method);
288 ExecutableElement ee = (ExecutableElement)method;
289 CharSequence params = wrapParams(ee, id, className, "ev", null);
290 if (!ee.getModifiers().contains(Modifier.STATIC)) {
291 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method has to be static", ee);
295 if (ee.getModifiers().contains(Modifier.PRIVATE)) {
296 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method can't be private", ee);
300 w.append(" OnEvent." + oc.event()).append(".of(").append(cnstnt(id)).
301 append(").perform(new OnDispatch(" + dispatchCnt + "));\n");
304 append(" case ").append(dispatchCnt).append(": ").
305 append(type.getSimpleName().toString()).
306 append('.').append(ee.getSimpleName()).append("(").
308 append("); break;\n");
315 if (dispatchCnt > 0) {
316 w.append("class OnDispatch implements OnHandler {\n");
317 w.append(" private final int dispatch;\n");
318 w.append(" OnDispatch(int d) { dispatch = d; }\n");
319 w.append(" public void onEvent(Object ev) {\n");
320 w.append(" switch (dispatch) {\n");
333 public Iterable<? extends Completion> getCompletions(
334 Element element, AnnotationMirror annotation,
335 ExecutableElement member, String userText
337 if (!userText.startsWith("\"")) {
338 return Collections.emptyList();
341 Element cls = findClass(element);
342 Page p = cls.getAnnotation(Page.class);
343 String pkg = findPkgName(cls);
346 InputStream is = openStream(pkg, p.xhtml());
347 pp = ProcessPage.readPage(is);
349 } catch (IOException iOException) {
350 return Collections.emptyList();
353 List<Completion> cc = new ArrayList<>();
354 userText = userText.substring(1);
355 for (String id : pp.ids()) {
356 if (id.startsWith(userText)) {
357 cc.add(Completions.of("\"" + id + "\"", id));
363 private static Element findClass(Element e) {
367 Page p = e.getAnnotation(Page.class);
371 return e.getEnclosingElement();
374 private boolean generateProperties(
376 Writer w, Property[] properties,
377 Collection<String> props, Map<String,Collection<String>> deps
378 ) throws IOException {
380 for (Property p : properties) {
382 tn = typeName(where, p);
383 String[] gs = toGetSet(p.name(), tn, p.array());
386 w.write("private KOList<" + tn + "> prop_" + p.name() + " = new KOList<" + tn + ">(\""
388 final Collection<String> dependants = deps.get(p.name());
389 if (dependants != null) {
390 for (String depProp : dependants) {
398 w.write("public java.util.List<" + tn + "> " + gs[0] + "() {\n");
399 w.write(" if (locked) throw new IllegalStateException();\n");
400 w.write(" prop_" + p.name() + ".assign(ko);\n");
401 w.write(" return prop_" + p.name() + ";\n");
404 w.write("private " + tn + " prop_" + p.name() + ";\n");
405 w.write("public " + tn + " " + gs[0] + "() {\n");
406 w.write(" if (locked) throw new IllegalStateException();\n");
407 w.write(" return prop_" + p.name() + ";\n");
409 w.write("public void " + gs[1] + "(" + tn + " v) {\n");
410 w.write(" if (locked) throw new IllegalStateException();\n");
411 w.write(" prop_" + p.name() + " = v;\n");
412 w.write(" if (ko != null) {\n");
413 w.write(" ko.valueHasMutated(\"" + p.name() + "\");\n");
414 final Collection<String> dependants = deps.get(p.name());
415 if (dependants != null) {
416 for (String depProp : dependants) {
417 w.write(" ko.valueHasMutated(\"" + depProp + "\");\n");
432 private boolean generateComputedProperties(
433 Writer w, Property[] fixedProps,
434 Collection<? extends Element> arr, Collection<String> props,
435 Map<String,Collection<String>> deps
436 ) throws IOException {
438 for (Element e : arr) {
439 if (e.getKind() != ElementKind.METHOD) {
442 if (e.getAnnotation(ComputedProperty.class) == null) {
445 ExecutableElement ee = (ExecutableElement)e;
446 final TypeMirror rt = ee.getReturnType();
447 final Types tu = processingEnv.getTypeUtils();
448 TypeMirror ert = tu.erasure(rt);
449 String tn = ert.toString();
450 boolean array = false;
451 if (tn.equals("java.util.List")) {
455 final String sn = ee.getSimpleName().toString();
456 String[] gs = toGetSet(sn, tn, array);
458 w.write("public " + tn + " " + gs[0] + "() {\n");
459 w.write(" if (locked) throw new IllegalStateException();\n");
461 for (VariableElement pe : ee.getParameters()) {
462 final String dn = pe.getSimpleName().toString();
464 if (!verifyPropName(pe, dn, fixedProps)) {
468 final String dt = pe.asType().toString();
469 String[] call = toGetSet(dn, dt, false);
470 w.write(" " + dt + " arg" + (++arg) + " = ");
471 w.write(call[0] + "();\n");
473 Collection<String> depends = deps.get(dn);
474 if (depends == null) {
475 depends = new LinkedHashSet<>();
476 deps.put(dn, depends);
481 w.write(" locked = true;\n");
482 w.write(" return " + e.getEnclosingElement().getSimpleName() + '.' + e.getSimpleName() + "(");
484 for (int i = 1; i <= arg; i++) {
490 w.write(" } finally {\n");
491 w.write(" locked = false;\n");
495 props.add(e.getSimpleName().toString());
504 private static String[] toGetSet(String name, String type, boolean array) {
505 String n = Character.toUpperCase(name.charAt(0)) + name.substring(1);
506 String bck2brwsrType = "L" + type.replace('.', '_') + "_2";
507 if ("int".equals(type)) {
510 if ("double".equals(type)) {
514 if ("boolean".equals(type)) {
518 final String nu = n.replace('.', '_');
520 return new String[] {
523 "get" + nu + "__Ljava_util_List_2",
530 pref + nu + "__" + bck2brwsrType,
531 "set" + nu + "__V" + bck2brwsrType
535 private String typeName(Element where, Property p) {
537 boolean isModel = false;
539 ret = p.type().getName();
540 } catch (MirroredTypeException ex) {
541 TypeMirror tm = processingEnv.getTypeUtils().erasure(ex.getTypeMirror());
542 final Element e = processingEnv.getTypeUtils().asElement(tm);
543 final Model m = e == null ? null : e.getAnnotation(Model.class);
545 ret = findPkgName(e) + '.' + m.className();
547 models.put(e, m.className());
553 String bt = findBoxedType(ret);
558 if (!isModel && !"java.lang.String".equals(ret)) {
559 String bt = findBoxedType(ret);
561 processingEnv.getMessager().printMessage(
562 Diagnostic.Kind.ERROR,
563 "Only primitive types supported in the mapping. Not " + ret,
571 private static String findBoxedType(String ret) {
572 if (ret.equals("boolean")) {
573 return Boolean.class.getName();
575 if (ret.equals("byte")) {
576 return Byte.class.getName();
578 if (ret.equals("short")) {
579 return Short.class.getName();
581 if (ret.equals("char")) {
582 return Character.class.getName();
584 if (ret.equals("int")) {
585 return Integer.class.getName();
587 if (ret.equals("long")) {
588 return Long.class.getName();
590 if (ret.equals("float")) {
591 return Float.class.getName();
593 if (ret.equals("double")) {
594 return Double.class.getName();
599 private boolean verifyPropName(Element e, String propName, Property[] existingProps) {
600 StringBuilder sb = new StringBuilder();
602 for (Property property : existingProps) {
603 if (property.name().equals(propName)) {
608 sb.append(property.name());
612 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR,
613 propName + " is not one of known properties: " + sb
619 private static String findPkgName(Element e) {
621 if (e.getKind() == ElementKind.PACKAGE) {
622 return ((PackageElement)e).getQualifiedName().toString();
624 e = e.getEnclosingElement();
628 private boolean generateFunctions(
629 Element clazz, StringWriter body, String className,
630 List<? extends Element> enclosedElements, List<String> functions
632 for (Element m : enclosedElements) {
633 if (m.getKind() != ElementKind.METHOD) {
636 ExecutableElement e = (ExecutableElement)m;
637 OnFunction onF = e.getAnnotation(OnFunction.class);
641 if (!e.getModifiers().contains(Modifier.STATIC)) {
642 processingEnv.getMessager().printMessage(
643 Diagnostic.Kind.ERROR, "@OnFunction method needs to be static", e
647 if (e.getModifiers().contains(Modifier.PRIVATE)) {
648 processingEnv.getMessager().printMessage(
649 Diagnostic.Kind.ERROR, "@OnFunction method cannot be private", e
653 if (e.getReturnType().getKind() != TypeKind.VOID) {
654 processingEnv.getMessager().printMessage(
655 Diagnostic.Kind.ERROR, "@OnFunction method should return void", e
659 String n = e.getSimpleName().toString();
660 body.append("void ").append(n).append("(Object data, Object ev) {\n");
661 body.append(" ").append(clazz.getSimpleName()).append(".").append(n).append("(");
662 body.append(wrapParams(e, null, className, "ev", "data"));
667 functions.add(n + "__VLjava_lang_Object_2Ljava_lang_Object_2");
672 private CharSequence wrapParams(
673 ExecutableElement ee, String id, String className, String evName, String dataName
675 TypeMirror stringType = processingEnv.getElementUtils().getTypeElement("java.lang.String").asType();
676 StringBuilder params = new StringBuilder();
677 boolean first = true;
678 for (VariableElement ve : ee.getParameters()) {
683 String toCall = null;
684 if (ve.asType() == stringType) {
685 if (ve.getSimpleName().contentEquals("id")) {
686 params.append('"').append(id).append('"');
689 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toString(";
691 if (ve.asType().getKind() == TypeKind.DOUBLE) {
692 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toDouble(";
694 if (ve.asType().getKind() == TypeKind.INT) {
695 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toInt(";
697 if (dataName != null && ve.getSimpleName().contentEquals(dataName) && isModel(ve.asType())) {
698 toCall = "org.apidesign.bck2brwsr.htmlpage.ConvertTypes.toModel(" + ve.asType() + ".class, ";
701 if (toCall != null) {
702 params.append(toCall);
703 if (dataName != null && ve.getSimpleName().contentEquals(dataName)) {
704 params.append(dataName);
705 params.append(", null");
707 params.append(evName);
708 params.append(", \"");
709 params.append(ve.getSimpleName().toString());
715 String rn = ve.asType().toString();
716 int last = rn.lastIndexOf('.');
718 rn = rn.substring(last + 1);
720 if (rn.equals(className)) {
721 params.append(className).append(".this");
724 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR,
725 "@On method can only accept String named 'id' or " + className + " arguments",
732 private boolean isModel(TypeMirror tm) {
733 final Element e = processingEnv.getTypeUtils().asElement(tm);
737 for (Element ch : e.getEnclosedElements()) {
738 if (ch.getKind() == ElementKind.METHOD) {
739 ExecutableElement ee = (ExecutableElement)ch;
740 if (ee.getParameters().isEmpty() && ee.getSimpleName().contentEquals("modelFor")) {
745 return models.values().contains(e.getSimpleName().toString());
748 private void writeStringArray(List<String> strings, Writer w) throws IOException {
749 w.write("new String[] {\n");
751 for (String n : strings) {
756 w.write(" \"" + n + "\"");