javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/PageProcessor.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Tue, 22 Jan 2013 19:27:00 +0100
branchmodel
changeset 529 8140ba8c005b
parent 528 08cd5a0c967e
parent 522 ca0fcd9240ea
child 530 3ce069ec3312
permissions -rw-r--r--
Merge with default branch to bring in @HtmlElement and @BrwsrTest
     1 /**
     2  * Back 2 Browser Bytecode Translator
     3  * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
     4  *
     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.
     8  *
     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.
    13  *
    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.
    17  */
    18 package org.apidesign.bck2brwsr.htmlpage;
    19 
    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;
    31 import java.util.Map;
    32 import java.util.Set;
    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;
    57 
    58 /** Annotation processor to process an XHTML page and generate appropriate 
    59  * "id" file.
    60  *
    61  * @author Jaroslav Tulach <jtulach@netbeans.org>
    62  */
    63 @ServiceProvider(service=Processor.class)
    64 @SupportedAnnotationTypes({
    65     "org.apidesign.bck2brwsr.htmlpage.api.Page",
    66     "org.apidesign.bck2brwsr.htmlpage.api.On"
    67 })
    68 public final class PageProcessor extends AbstractProcessor {
    69     @Override
    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();
    75             
    76             ProcessPage pp;
    77             try {
    78                 InputStream is = openStream(pkg, p.xhtml());
    79                 pp = ProcessPage.readPage(is);
    80                 is.close();
    81             } catch (IOException iOException) {
    82                 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't read " + p.xhtml(), e);
    83                 return false;
    84             }
    85             Writer w;
    86             String className = p.className();
    87             if (className.isEmpty()) {
    88                 int indx = p.xhtml().indexOf('.');
    89                 className = p.xhtml().substring(0, indx);
    90             }
    91             try {
    92                 FileObject java = processingEnv.getFiler().createSourceFile(pkg + '.' + className, e);
    93                 w = new OutputStreamWriter(java.openOutputStream());
    94                 try {
    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)) {
   100                         return false;
   101                     }
   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");
   108                     }
   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");
   119                         String sep = "";
   120                         for (String n : propsGetSet) {
   121                             w.write(sep);
   122                             if (n == null) {
   123                                 w.write("    null");
   124                             } else {
   125                                 w.write("    \"" + n + "\"");
   126                             }
   127                             sep = ",\n";
   128                         }
   129                         w.write("\n  });\n  return this;\n}\n");
   130                     }
   131                     w.append("}\n");
   132                 } finally {
   133                     w.close();
   134                 }
   135             } catch (IOException ex) {
   136                 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
   137                 return false;
   138             }
   139         }
   140         return true;
   141     }
   142 
   143     private InputStream openStream(String pkg, String name) throws IOException {
   144         try {
   145             FileObject fo = processingEnv.getFiler().getResource(
   146                 StandardLocation.SOURCE_PATH, pkg, name);
   147             return fo.openInputStream();
   148         } catch (IOException ex) {
   149             return processingEnv.getFiler().getResource(StandardLocation.CLASS_OUTPUT, pkg, name).openInputStream();
   150         }
   151     }
   152 
   153     private static String type(String tag) {
   154         if (tag.equals("title")) {
   155             return "Title";
   156         }
   157         if (tag.equals("button")) {
   158             return "Button";
   159         }
   160         if (tag.equals("input")) {
   161             return "Input";
   162         }
   163         if (tag.equals("canvas")) {
   164             return "Canvas";
   165         }
   166         if (tag.equals("img")) {
   167             return "Image";
   168         }
   169         return "Element";
   170     }
   171 
   172     private static String cnstnt(String id) {
   173         return id.toUpperCase(Locale.ENGLISH).replace('.', '_').replace('-', '_');
   174     }
   175 
   176     private boolean initializeOnClick(
   177         String className, TypeElement type, Writer w, ProcessPage pp
   178     ) throws IOException {
   179         TypeMirror stringType = processingEnv.getElementUtils().getTypeElement("java.lang.String").asType();
   180         { //for (Element clazz : pe.getEnclosedElements()) {
   181           //  if (clazz.getKind() != ElementKind.CLASS) {
   182             //    continue;
   183            // }
   184             w.append("  public ").append(className).append("() {\n");
   185             StringBuilder dispatch = new StringBuilder();
   186             int dispatchCnt = 0;
   187             for (Element method : type.getEnclosedElements()) {
   188                 On oc = method.getAnnotation(On.class);
   189                 if (oc != null) {
   190                     for (String id : oc.id()) {
   191                         if (pp.tagNameForId(id) == null) {
   192                             processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "id = " + id + " does not exist in the HTML page. Found only " + pp.ids(), method);
   193                             return false;
   194                         }
   195                         ExecutableElement ee = (ExecutableElement)method;
   196                         StringBuilder params = new StringBuilder();
   197                         {
   198                             boolean first = true;
   199                             for (VariableElement ve : ee.getParameters()) {
   200                                 if (!first) {
   201                                     params.append(", ");
   202                                 }
   203                                 first = false;
   204                                 if (ve.asType() == stringType) {
   205                                     params.append('"').append(id).append('"');
   206                                     continue;
   207                                 }
   208                                 if (ve.asType().toString().equals(className)) {
   209                                     params.append(className).append(".this");
   210                                     continue;
   211                                 }
   212                                 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, 
   213                                     "@On method can only accept String or " + className + " arguments",
   214                                     ee
   215                                 );
   216                                 return false;
   217                             }
   218                         }
   219                         if (!ee.getModifiers().contains(Modifier.STATIC)) {
   220                             processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method has to be static", ee);
   221                             return false;
   222                         }
   223                         if (ee.getModifiers().contains(Modifier.PRIVATE)) {
   224                             processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method can't be private", ee);
   225                             return false;
   226                         }
   227                         w.append("  OnEvent." + oc.event()).append(".of(").append(cnstnt(id)).
   228                             append(").perform(new OnDispatch(" + dispatchCnt + "));\n");
   229 
   230                         dispatch.
   231                             append("      case ").append(dispatchCnt).append(": ").
   232                             append(type.getSimpleName().toString()).
   233                             append('.').append(ee.getSimpleName()).append("(").
   234                             append(params).
   235                             append("); break;\n");
   236                         
   237                         dispatchCnt++;
   238                     }
   239                 }
   240             }
   241             w.append("  }\n");
   242             if (dispatchCnt > 0) {
   243                 w.append("class OnDispatch implements Runnable {\n");
   244                 w.append("  private final int dispatch;\n");
   245                 w.append("  OnDispatch(int d) { dispatch = d; }\n");
   246                 w.append("  public void run() {\n");
   247                 w.append("    switch (dispatch) {\n");
   248                 w.append(dispatch);
   249                 w.append("    }\n");
   250                 w.append("  }\n");
   251                 w.append("}\n");
   252             }
   253             
   254 
   255         }
   256         return true;
   257     }
   258 
   259     @Override
   260     public Iterable<? extends Completion> getCompletions(
   261         Element element, AnnotationMirror annotation, 
   262         ExecutableElement member, String userText
   263     ) {
   264         if (!userText.startsWith("\"")) {
   265             return Collections.emptyList();
   266         }
   267         
   268         Element cls = findClass(element);
   269         Page p = cls.getAnnotation(Page.class);
   270         PackageElement pe = (PackageElement) cls.getEnclosingElement();
   271         String pkg = pe.getQualifiedName().toString();
   272         ProcessPage pp;
   273         try {
   274             InputStream is = openStream(pkg, p.xhtml());
   275             pp = ProcessPage.readPage(is);
   276             is.close();
   277         } catch (IOException iOException) {
   278             return Collections.emptyList();
   279         }
   280         
   281         List<Completion> cc = new ArrayList<Completion>();
   282         userText = userText.substring(1);
   283         for (String id : pp.ids()) {
   284             if (id.startsWith(userText)) {
   285                 cc.add(Completions.of("\"" + id + "\"", id));
   286             }
   287         }
   288         return cc;
   289     }
   290     
   291     private static Element findClass(Element e) {
   292         if (e == null) {
   293             return null;
   294         }
   295         Page p = e.getAnnotation(Page.class);
   296         if (p != null) {
   297             return e;
   298         }
   299         return e.getEnclosingElement();
   300     }
   301 
   302     private static void generateProperties(
   303         Writer w, Property[] properties, Collection<String> props,
   304         Map<String,Collection<String>> deps
   305     ) throws IOException {
   306         for (Property p : properties) {
   307             final String tn = typeName(p);
   308             String[] gs = toGetSet(p.name(), tn);
   309 
   310             w.write("private " + tn + " prop_" + p.name() + ";\n");
   311             w.write("public " + tn + " " + gs[0] + "() {\n");
   312             w.write("  if (locked) throw new IllegalStateException();\n");
   313             w.write("  return prop_" + p.name() + ";\n");
   314             w.write("}\n");
   315             w.write("public void " + gs[1] + "(" + tn + " v) {\n");
   316             w.write("  if (locked) throw new IllegalStateException();\n");
   317             w.write("  prop_" + p.name() + " = v;\n");
   318             w.write("  if (ko != null) {\n");
   319             w.write("    ko.valueHasMutated(\"" + p.name() + "\");\n");
   320             final Collection<String> dependants = deps.get(p.name());
   321             if (dependants != null) {
   322                 for (String depProp : dependants) {
   323                     w.write("    ko.valueHasMutated(\"" + depProp + "\");\n");
   324                 }
   325             }
   326             w.write("  }\n");
   327             w.write("}\n");
   328             
   329             props.add(p.name());
   330             props.add(gs[2]);
   331             props.add(gs[3]);
   332         }
   333     }
   334 
   335     private boolean generateComputedProperties(
   336         Writer w, Collection<? extends Element> arr, Collection<String> props,
   337         Map<String,Collection<String>> deps
   338     ) throws IOException {
   339         for (Element e : arr) {
   340             if (e.getKind() != ElementKind.METHOD) {
   341                 continue;
   342             }
   343             if (e.getAnnotation(ComputedProperty.class) == null) {
   344                 continue;
   345             }
   346             ExecutableElement ee = (ExecutableElement)e;
   347             final String tn = ee.getReturnType().toString();
   348             final String sn = ee.getSimpleName().toString();
   349             String[] gs = toGetSet(sn, tn);
   350             
   351             w.write("public " + tn + " " + gs[0] + "() {\n");
   352             w.write("  if (locked) throw new IllegalStateException();\n");
   353             int arg = 0;
   354             for (VariableElement pe : ee.getParameters()) {
   355                 final String dn = pe.getSimpleName().toString();
   356                 final String dt = pe.asType().toString();
   357                 String[] call = toGetSet(dn, dt);
   358                 w.write("  " + dt + " arg" + (++arg) + " = ");
   359                 w.write(call[0] + "();\n");
   360                 
   361                 Collection<String> depends = deps.get(dn);
   362                 if (depends == null) {
   363                     depends = new LinkedHashSet<String>();
   364                     deps.put(dn, depends);
   365                 }
   366                 depends.add(sn);
   367             }
   368             w.write("  try {\n");
   369             w.write("    locked = true;\n");
   370             w.write("    return " + e.getEnclosingElement().getSimpleName() + '.' + e.getSimpleName() + "(");
   371             String sep = "";
   372             for (int i = 1; i <= arg; i++) {
   373                 w.write(sep);
   374                 w.write("arg" + i);
   375                 sep = ", ";
   376             }
   377             w.write(");\n");
   378             w.write("  } finally {\n");
   379             w.write("    locked = false;\n");
   380             w.write("  }\n");
   381             w.write("}\n");
   382             
   383             props.add(e.getSimpleName().toString());
   384             props.add(gs[2]);
   385             props.add(null);
   386         }
   387         
   388         return true;
   389     }
   390 
   391     private static String[] toGetSet(String name, String type) {
   392         String n = Character.toUpperCase(name.charAt(0)) + name.substring(1);
   393         String bck2brwsrType = "L" + type.replace('.', '_') + "_2";
   394         if ("int".equals(type)) {
   395             bck2brwsrType = "I";
   396         }
   397         if ("double".equals(type)) {
   398             bck2brwsrType = "D";
   399         }
   400         String pref = "get";
   401         if ("boolean".equals(type)) {
   402             pref = "is";
   403             bck2brwsrType = "Z";
   404         }
   405         final String nu = n.replace('.', '_');
   406         return new String[]{
   407             pref + n, 
   408             "set" + n, 
   409             pref + nu + "__" + bck2brwsrType,
   410             "set" + nu + "__V" + bck2brwsrType
   411         };
   412     }
   413 
   414     private static String typeName(Property p) {
   415         try {
   416             return p.type().getName();
   417         } catch (MirroredTypeException ex) {
   418             return ex.getTypeMirror().toString();
   419         }
   420     }
   421 }