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.Writer;
24 import java.util.ArrayList;
25 import java.util.Collection;
26 import java.util.Collections;
27 import java.util.HashMap;
28 import java.util.LinkedHashSet;
29 import java.util.List;
30 import java.util.Locale;
33 import javax.annotation.processing.AbstractProcessor;
34 import javax.annotation.processing.Completion;
35 import javax.annotation.processing.Completions;
36 import javax.annotation.processing.Processor;
37 import javax.annotation.processing.RoundEnvironment;
38 import javax.annotation.processing.SupportedAnnotationTypes;
39 import javax.lang.model.element.AnnotationMirror;
40 import javax.lang.model.element.Element;
41 import javax.lang.model.element.ElementKind;
42 import javax.lang.model.element.ExecutableElement;
43 import javax.lang.model.element.Modifier;
44 import javax.lang.model.element.PackageElement;
45 import javax.lang.model.element.TypeElement;
46 import javax.lang.model.element.VariableElement;
47 import javax.lang.model.type.MirroredTypeException;
48 import javax.lang.model.type.TypeMirror;
49 import javax.tools.Diagnostic;
50 import javax.tools.FileObject;
51 import javax.tools.StandardLocation;
52 import org.apidesign.bck2brwsr.htmlpage.api.ComputedProperty;
53 import org.apidesign.bck2brwsr.htmlpage.api.On;
54 import org.apidesign.bck2brwsr.htmlpage.api.Page;
55 import org.apidesign.bck2brwsr.htmlpage.api.Property;
56 import org.openide.util.lookup.ServiceProvider;
58 /** Annotation processor to process an XHTML page and generate appropriate
61 * @author Jaroslav Tulach <jtulach@netbeans.org>
63 @ServiceProvider(service=Processor.class)
64 @SupportedAnnotationTypes({
65 "org.apidesign.bck2brwsr.htmlpage.api.Page",
66 "org.apidesign.bck2brwsr.htmlpage.api.On"
68 public final class PageProcessor extends AbstractProcessor {
70 public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
71 for (Element e : roundEnv.getElementsAnnotatedWith(Page.class)) {
72 Page p = e.getAnnotation(Page.class);
76 PackageElement pe = (PackageElement)e.getEnclosingElement();
77 String pkg = pe.getQualifiedName().toString();
81 InputStream is = openStream(pkg, p.xhtml());
82 pp = ProcessPage.readPage(is);
84 } catch (IOException iOException) {
85 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't read " + p.xhtml(), e);
89 String className = p.className();
90 if (className.isEmpty()) {
91 int indx = p.xhtml().indexOf('.');
92 className = p.xhtml().substring(0, indx);
95 FileObject java = processingEnv.getFiler().createSourceFile(pkg + '.' + className, e);
96 w = new OutputStreamWriter(java.openOutputStream());
98 w.append("package " + pkg + ";\n");
99 w.append("import org.apidesign.bck2brwsr.htmlpage.api.*;\n");
100 w.append("import org.apidesign.bck2brwsr.htmlpage.KOList;\n");
101 w.append("final class ").append(className).append(" {\n");
102 w.append(" private boolean locked;\n");
103 if (!initializeOnClick(className, (TypeElement) e, w, pp)) {
106 for (String id : pp.ids()) {
107 String tag = pp.tagNameForId(id);
108 String type = type(tag);
109 w.append(" ").append("public final ").
110 append(type).append(' ').append(cnstnt(id)).append(" = new ").
111 append(type).append("(\"").append(id).append("\");\n");
113 List<String> propsGetSet = new ArrayList<String>();
114 Map<String,Collection<String>> propsDeps = new HashMap<String, Collection<String>>();
115 generateComputedProperties(w, e.getEnclosedElements(), propsGetSet, propsDeps);
116 generateProperties(w, p.properties(), propsGetSet, propsDeps);
117 w.append(" private org.apidesign.bck2brwsr.htmlpage.Knockout ko;\n");
118 if (!propsGetSet.isEmpty()) {
119 w.write("public " + className + " applyBindings() {\n");
120 w.write(" ko = org.apidesign.bck2brwsr.htmlpage.Knockout.applyBindings(");
121 w.write(className + ".class, this, ");
122 w.write("new String[] {\n");
124 for (String n : propsGetSet) {
129 w.write(" \"" + n + "\"");
133 w.write("\n });\n return this;\n}\n");
135 w.write("public void triggerEvent(Element e, OnEvent ev) {\n");
136 w.write(" org.apidesign.bck2brwsr.htmlpage.Knockout.triggerEvent(e.getId(), ev.getElementPropertyName());\n");
143 } catch (IOException ex) {
144 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
151 private InputStream openStream(String pkg, String name) throws IOException {
153 FileObject fo = processingEnv.getFiler().getResource(
154 StandardLocation.SOURCE_PATH, pkg, name);
155 return fo.openInputStream();
156 } catch (IOException ex) {
157 return processingEnv.getFiler().getResource(StandardLocation.CLASS_OUTPUT, pkg, name).openInputStream();
161 private static String type(String tag) {
162 if (tag.equals("title")) {
165 if (tag.equals("button")) {
168 if (tag.equals("input")) {
171 if (tag.equals("canvas")) {
174 if (tag.equals("img")) {
180 private static String cnstnt(String id) {
181 return id.toUpperCase(Locale.ENGLISH).replace('.', '_').replace('-', '_');
184 private boolean initializeOnClick(
185 String className, TypeElement type, Writer w, ProcessPage pp
186 ) throws IOException {
187 TypeMirror stringType = processingEnv.getElementUtils().getTypeElement("java.lang.String").asType();
188 { //for (Element clazz : pe.getEnclosedElements()) {
189 // if (clazz.getKind() != ElementKind.CLASS) {
192 w.append(" public ").append(className).append("() {\n");
193 StringBuilder dispatch = new StringBuilder();
195 for (Element method : type.getEnclosedElements()) {
196 On oc = method.getAnnotation(On.class);
198 for (String id : oc.id()) {
199 if (pp.tagNameForId(id) == null) {
200 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "id = " + id + " does not exist in the HTML page. Found only " + pp.ids(), method);
203 ExecutableElement ee = (ExecutableElement)method;
204 StringBuilder params = new StringBuilder();
206 boolean first = true;
207 for (VariableElement ve : ee.getParameters()) {
212 if (ve.asType() == stringType) {
213 params.append('"').append(id).append('"');
216 String rn = ve.asType().toString();
217 int last = rn.lastIndexOf('.');
219 rn = rn.substring(last + 1);
221 if (rn.equals(className)) {
222 params.append(className).append(".this");
225 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR,
226 "@On method can only accept String or " + className + " arguments",
232 if (!ee.getModifiers().contains(Modifier.STATIC)) {
233 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method has to be static", ee);
236 if (ee.getModifiers().contains(Modifier.PRIVATE)) {
237 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method can't be private", ee);
240 w.append(" OnEvent." + oc.event()).append(".of(").append(cnstnt(id)).
241 append(").perform(new OnDispatch(" + dispatchCnt + "));\n");
244 append(" case ").append(dispatchCnt).append(": ").
245 append(type.getSimpleName().toString()).
246 append('.').append(ee.getSimpleName()).append("(").
248 append("); break;\n");
255 if (dispatchCnt > 0) {
256 w.append("class OnDispatch implements Runnable {\n");
257 w.append(" private final int dispatch;\n");
258 w.append(" OnDispatch(int d) { dispatch = d; }\n");
259 w.append(" public void run() {\n");
260 w.append(" switch (dispatch) {\n");
273 public Iterable<? extends Completion> getCompletions(
274 Element element, AnnotationMirror annotation,
275 ExecutableElement member, String userText
277 if (!userText.startsWith("\"")) {
278 return Collections.emptyList();
281 Element cls = findClass(element);
282 Page p = cls.getAnnotation(Page.class);
283 PackageElement pe = (PackageElement) cls.getEnclosingElement();
284 String pkg = pe.getQualifiedName().toString();
287 InputStream is = openStream(pkg, p.xhtml());
288 pp = ProcessPage.readPage(is);
290 } catch (IOException iOException) {
291 return Collections.emptyList();
294 List<Completion> cc = new ArrayList<Completion>();
295 userText = userText.substring(1);
296 for (String id : pp.ids()) {
297 if (id.startsWith(userText)) {
298 cc.add(Completions.of("\"" + id + "\"", id));
304 private static Element findClass(Element e) {
308 Page p = e.getAnnotation(Page.class);
312 return e.getEnclosingElement();
315 private static void generateProperties(
316 Writer w, Property[] properties, Collection<String> props,
317 Map<String,Collection<String>> deps
318 ) throws IOException {
319 for (Property p : properties) {
320 final String tn = typeName(p);
321 String[] gs = toGetSet(p.name(), tn, p.array());
324 w.write("private KOList<" + tn + "> prop_" + p.name() + " = new KOList<" + tn + ">(\""
326 final Collection<String> dependants = deps.get(p.name());
327 if (dependants != null) {
328 for (String depProp : dependants) {
336 w.write("public java.util.List<" + tn + "> " + gs[0] + "() {\n");
337 w.write(" if (locked) throw new IllegalStateException();\n");
338 w.write(" prop_" + p.name() + ".assign(ko);\n");
339 w.write(" return prop_" + p.name() + ";\n");
341 w.write("private Object[] " + gs[0] + "ToArray() {\n");
342 w.write(" return " + gs[0] + "().toArray(new Object[0]);\n");
345 w.write("private " + tn + " prop_" + p.name() + ";\n");
346 w.write("public " + tn + " " + gs[0] + "() {\n");
347 w.write(" if (locked) throw new IllegalStateException();\n");
348 w.write(" return prop_" + p.name() + ";\n");
350 w.write("public void " + gs[1] + "(" + tn + " v) {\n");
351 w.write(" if (locked) throw new IllegalStateException();\n");
352 w.write(" prop_" + p.name() + " = v;\n");
353 w.write(" if (ko != null) {\n");
354 w.write(" ko.valueHasMutated(\"" + p.name() + "\");\n");
355 final Collection<String> dependants = deps.get(p.name());
356 if (dependants != null) {
357 for (String depProp : dependants) {
358 w.write(" ko.valueHasMutated(\"" + depProp + "\");\n");
372 private boolean generateComputedProperties(
373 Writer w, Collection<? extends Element> arr, Collection<String> props,
374 Map<String,Collection<String>> deps
375 ) throws IOException {
376 for (Element e : arr) {
377 if (e.getKind() != ElementKind.METHOD) {
380 if (e.getAnnotation(ComputedProperty.class) == null) {
383 ExecutableElement ee = (ExecutableElement)e;
384 final String tn = ee.getReturnType().toString();
385 final String sn = ee.getSimpleName().toString();
386 String[] gs = toGetSet(sn, tn, false);
388 w.write("public " + tn + " " + gs[0] + "() {\n");
389 w.write(" if (locked) throw new IllegalStateException();\n");
391 for (VariableElement pe : ee.getParameters()) {
392 final String dn = pe.getSimpleName().toString();
393 final String dt = pe.asType().toString();
394 String[] call = toGetSet(dn, dt, false);
395 w.write(" " + dt + " arg" + (++arg) + " = ");
396 w.write(call[0] + "();\n");
398 Collection<String> depends = deps.get(dn);
399 if (depends == null) {
400 depends = new LinkedHashSet<String>();
401 deps.put(dn, depends);
406 w.write(" locked = true;\n");
407 w.write(" return " + e.getEnclosingElement().getSimpleName() + '.' + e.getSimpleName() + "(");
409 for (int i = 1; i <= arg; i++) {
415 w.write(" } finally {\n");
416 w.write(" locked = false;\n");
420 props.add(e.getSimpleName().toString());
429 private static String[] toGetSet(String name, String type, boolean array) {
430 String n = Character.toUpperCase(name.charAt(0)) + name.substring(1);
431 String bck2brwsrType = "L" + type.replace('.', '_') + "_2";
432 if ("int".equals(type)) {
435 if ("double".equals(type)) {
439 if ("boolean".equals(type)) {
443 final String nu = n.replace('.', '_');
445 return new String[] {
448 "get" + nu + "ToArray___3Ljava_lang_Object_2",
455 pref + nu + "__" + bck2brwsrType,
456 "set" + nu + "__V" + bck2brwsrType
460 private static String typeName(Property p) {
463 ret = p.type().getName();
464 } catch (MirroredTypeException ex) {
465 ret = ex.getTypeMirror().toString();
468 if (ret.equals("byte")) {
469 return Byte.class.getName();
471 if (ret.equals("short")) {
472 return Short.class.getName();
474 if (ret.equals("char")) {
475 return Character.class.getName();
477 if (ret.equals("int")) {
478 return Integer.class.getName();
480 if (ret.equals("long")) {
481 return Long.class.getName();
483 if (ret.equals("float")) {
484 return Float.class.getName();
486 if (ret.equals("double")) {
487 return Double.class.getName();