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);
73 PackageElement pe = (PackageElement)e.getEnclosingElement();
74 String pkg = pe.getQualifiedName().toString();
78 InputStream is = openStream(pkg, p.xhtml());
79 pp = ProcessPage.readPage(is);
81 } catch (IOException iOException) {
82 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't read " + p.xhtml(), e);
86 String className = p.className();
87 if (className.isEmpty()) {
88 int indx = p.xhtml().indexOf('.');
89 className = p.xhtml().substring(0, indx);
92 FileObject java = processingEnv.getFiler().createSourceFile(pkg + '.' + className, e);
93 w = new OutputStreamWriter(java.openOutputStream());
95 w.append("package " + pkg + ";\n");
96 w.append("import org.apidesign.bck2brwsr.htmlpage.api.*;\n");
97 w.append("final class ").append(className).append(" {\n");
98 w.append(" private boolean locked;\n");
99 if (!initializeOnClick(className, (TypeElement) e, w, pp)) {
102 for (String id : pp.ids()) {
103 String tag = pp.tagNameForId(id);
104 String type = type(tag);
105 w.append(" ").append("public final ").
106 append(type).append(' ').append(cnstnt(id)).append(" = new ").
107 append(type).append("(\"").append(id).append("\");\n");
109 List<String> propsGetSet = new ArrayList<String>();
110 Map<String,Collection<String>> propsDeps = new HashMap<String, Collection<String>>();
111 generateComputedProperties(w, e.getEnclosedElements(), propsGetSet, propsDeps);
112 generateProperties(w, p.properties(), propsGetSet, propsDeps);
113 w.append(" private org.apidesign.bck2brwsr.htmlpage.Knockout ko;\n");
114 if (!propsGetSet.isEmpty()) {
115 w.write("public " + className + " applyBindings() {\n");
116 w.write(" ko = org.apidesign.bck2brwsr.htmlpage.Knockout.applyBindings(");
117 w.write(className + ".class, this, ");
118 w.write("new String[] {\n");
120 for (String n : propsGetSet) {
125 w.write(" \"" + n + "\"");
129 w.write("\n });\n return this;\n}\n");
131 w.write("public void triggerEvent(Element e, OnEvent ev) {\n");
132 w.write(" org.apidesign.bck2brwsr.htmlpage.Knockout.triggerEvent(e.getId(), ev.getElementPropertyName());\n");
139 } catch (IOException ex) {
140 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
147 private InputStream openStream(String pkg, String name) throws IOException {
149 FileObject fo = processingEnv.getFiler().getResource(
150 StandardLocation.SOURCE_PATH, pkg, name);
151 return fo.openInputStream();
152 } catch (IOException ex) {
153 return processingEnv.getFiler().getResource(StandardLocation.CLASS_OUTPUT, pkg, name).openInputStream();
157 private static String type(String tag) {
158 if (tag.equals("title")) {
161 if (tag.equals("button")) {
164 if (tag.equals("input")) {
167 if (tag.equals("canvas")) {
170 if (tag.equals("img")) {
176 private static String cnstnt(String id) {
177 return id.toUpperCase(Locale.ENGLISH).replace('.', '_').replace('-', '_');
180 private boolean initializeOnClick(
181 String className, TypeElement type, Writer w, ProcessPage pp
182 ) throws IOException {
183 TypeMirror stringType = processingEnv.getElementUtils().getTypeElement("java.lang.String").asType();
184 { //for (Element clazz : pe.getEnclosedElements()) {
185 // if (clazz.getKind() != ElementKind.CLASS) {
188 w.append(" public ").append(className).append("() {\n");
189 StringBuilder dispatch = new StringBuilder();
191 for (Element method : type.getEnclosedElements()) {
192 On oc = method.getAnnotation(On.class);
194 for (String id : oc.id()) {
195 if (pp.tagNameForId(id) == null) {
196 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "id = " + id + " does not exist in the HTML page. Found only " + pp.ids(), method);
199 ExecutableElement ee = (ExecutableElement)method;
200 StringBuilder params = new StringBuilder();
202 boolean first = true;
203 for (VariableElement ve : ee.getParameters()) {
208 if (ve.asType() == stringType) {
209 params.append('"').append(id).append('"');
212 if (ve.asType().toString().equals(className)) {
213 params.append(className).append(".this");
216 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR,
217 "@On method can only accept String or " + className + " arguments",
223 if (!ee.getModifiers().contains(Modifier.STATIC)) {
224 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method has to be static", ee);
227 if (ee.getModifiers().contains(Modifier.PRIVATE)) {
228 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method can't be private", ee);
231 w.append(" OnEvent." + oc.event()).append(".of(").append(cnstnt(id)).
232 append(").perform(new OnDispatch(" + dispatchCnt + "));\n");
235 append(" case ").append(dispatchCnt).append(": ").
236 append(type.getSimpleName().toString()).
237 append('.').append(ee.getSimpleName()).append("(").
239 append("); break;\n");
246 if (dispatchCnt > 0) {
247 w.append("class OnDispatch implements Runnable {\n");
248 w.append(" private final int dispatch;\n");
249 w.append(" OnDispatch(int d) { dispatch = d; }\n");
250 w.append(" public void run() {\n");
251 w.append(" switch (dispatch) {\n");
264 public Iterable<? extends Completion> getCompletions(
265 Element element, AnnotationMirror annotation,
266 ExecutableElement member, String userText
268 if (!userText.startsWith("\"")) {
269 return Collections.emptyList();
272 Element cls = findClass(element);
273 Page p = cls.getAnnotation(Page.class);
274 PackageElement pe = (PackageElement) cls.getEnclosingElement();
275 String pkg = pe.getQualifiedName().toString();
278 InputStream is = openStream(pkg, p.xhtml());
279 pp = ProcessPage.readPage(is);
281 } catch (IOException iOException) {
282 return Collections.emptyList();
285 List<Completion> cc = new ArrayList<Completion>();
286 userText = userText.substring(1);
287 for (String id : pp.ids()) {
288 if (id.startsWith(userText)) {
289 cc.add(Completions.of("\"" + id + "\"", id));
295 private static Element findClass(Element e) {
299 Page p = e.getAnnotation(Page.class);
303 return e.getEnclosingElement();
306 private static void generateProperties(
307 Writer w, Property[] properties, Collection<String> props,
308 Map<String,Collection<String>> deps
309 ) throws IOException {
310 for (Property p : properties) {
311 final String tn = typeName(p);
312 String[] gs = toGetSet(p.name(), tn);
314 w.write("private " + tn + " prop_" + p.name() + ";\n");
315 w.write("public " + tn + " " + gs[0] + "() {\n");
316 w.write(" if (locked) throw new IllegalStateException();\n");
317 w.write(" return prop_" + p.name() + ";\n");
319 w.write("public void " + gs[1] + "(" + tn + " v) {\n");
320 w.write(" if (locked) throw new IllegalStateException();\n");
321 w.write(" prop_" + p.name() + " = v;\n");
322 w.write(" if (ko != null) {\n");
323 w.write(" ko.valueHasMutated(\"" + p.name() + "\");\n");
324 final Collection<String> dependants = deps.get(p.name());
325 if (dependants != null) {
326 for (String depProp : dependants) {
327 w.write(" ko.valueHasMutated(\"" + depProp + "\");\n");
340 private boolean generateComputedProperties(
341 Writer w, Collection<? extends Element> arr, Collection<String> props,
342 Map<String,Collection<String>> deps
343 ) throws IOException {
344 for (Element e : arr) {
345 if (e.getKind() != ElementKind.METHOD) {
348 if (e.getAnnotation(ComputedProperty.class) == null) {
351 ExecutableElement ee = (ExecutableElement)e;
352 final String tn = ee.getReturnType().toString();
353 final String sn = ee.getSimpleName().toString();
354 String[] gs = toGetSet(sn, tn);
356 w.write("public " + tn + " " + gs[0] + "() {\n");
357 w.write(" if (locked) throw new IllegalStateException();\n");
359 for (VariableElement pe : ee.getParameters()) {
360 final String dn = pe.getSimpleName().toString();
361 final String dt = pe.asType().toString();
362 String[] call = toGetSet(dn, dt);
363 w.write(" " + dt + " arg" + (++arg) + " = ");
364 w.write(call[0] + "();\n");
366 Collection<String> depends = deps.get(dn);
367 if (depends == null) {
368 depends = new LinkedHashSet<String>();
369 deps.put(dn, depends);
374 w.write(" locked = true;\n");
375 w.write(" return " + e.getEnclosingElement().getSimpleName() + '.' + e.getSimpleName() + "(");
377 for (int i = 1; i <= arg; i++) {
383 w.write(" } finally {\n");
384 w.write(" locked = false;\n");
388 props.add(e.getSimpleName().toString());
397 private static String[] toGetSet(String name, String type) {
398 String n = Character.toUpperCase(name.charAt(0)) + name.substring(1);
399 String bck2brwsrType = "L" + type.replace('.', '_') + "_2";
400 if ("int".equals(type)) {
403 if ("double".equals(type)) {
407 if ("boolean".equals(type)) {
411 final String nu = n.replace('.', '_');
415 pref + nu + "__" + bck2brwsrType,
416 "set" + nu + "__V" + bck2brwsrType
420 private static String typeName(Property p) {
422 return p.type().getName();
423 } catch (MirroredTypeException ex) {
424 return ex.getTypeMirror().toString();