javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/PageProcessor.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Mon, 21 Jan 2013 11:55:27 +0100
branchmodel
changeset 500 f9e80d48e9b4
parent 498 607f062485cc
child 505 4198be34b516
permissions -rw-r--r--
@ComputedProperty methods can't access the model
jaroslav@26
     1
/**
jaroslav@106
     2
 * Back 2 Browser Bytecode Translator
jaroslav@106
     3
 * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
jaroslav@26
     4
 *
jaroslav@26
     5
 * This program is free software: you can redistribute it and/or modify
jaroslav@26
     6
 * it under the terms of the GNU General Public License as published by
jaroslav@26
     7
 * the Free Software Foundation, version 2 of the License.
jaroslav@26
     8
 *
jaroslav@26
     9
 * This program is distributed in the hope that it will be useful,
jaroslav@26
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
jaroslav@26
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
jaroslav@26
    12
 * GNU General Public License for more details.
jaroslav@26
    13
 *
jaroslav@26
    14
 * You should have received a copy of the GNU General Public License
jaroslav@26
    15
 * along with this program. Look for COPYING file in the top folder.
jaroslav@26
    16
 * If not, see http://opensource.org/licenses/GPL-2.0.
jaroslav@26
    17
 */
jaroslav@26
    18
package org.apidesign.bck2brwsr.htmlpage;
jaroslav@26
    19
jaroslav@26
    20
import java.io.IOException;
jaroslav@26
    21
import java.io.InputStream;
jaroslav@26
    22
import java.io.OutputStreamWriter;
jaroslav@26
    23
import java.io.Writer;
jaroslav@117
    24
import java.util.ArrayList;
jaroslav@491
    25
import java.util.Collection;
jaroslav@117
    26
import java.util.Collections;
jaroslav@498
    27
import java.util.HashMap;
jaroslav@498
    28
import java.util.LinkedHashSet;
jaroslav@117
    29
import java.util.List;
jaroslav@26
    30
import java.util.Locale;
jaroslav@498
    31
import java.util.Map;
jaroslav@26
    32
import java.util.Set;
jaroslav@26
    33
import javax.annotation.processing.AbstractProcessor;
jaroslav@117
    34
import javax.annotation.processing.Completion;
jaroslav@117
    35
import javax.annotation.processing.Completions;
jaroslav@26
    36
import javax.annotation.processing.Processor;
jaroslav@26
    37
import javax.annotation.processing.RoundEnvironment;
jaroslav@26
    38
import javax.annotation.processing.SupportedAnnotationTypes;
jaroslav@117
    39
import javax.lang.model.element.AnnotationMirror;
jaroslav@26
    40
import javax.lang.model.element.Element;
jaroslav@491
    41
import javax.lang.model.element.ElementKind;
jaroslav@28
    42
import javax.lang.model.element.ExecutableElement;
jaroslav@28
    43
import javax.lang.model.element.Modifier;
jaroslav@26
    44
import javax.lang.model.element.PackageElement;
jaroslav@26
    45
import javax.lang.model.element.TypeElement;
jaroslav@491
    46
import javax.lang.model.element.VariableElement;
jaroslav@490
    47
import javax.lang.model.type.MirroredTypeException;
jaroslav@124
    48
import javax.lang.model.type.TypeMirror;
jaroslav@26
    49
import javax.tools.Diagnostic;
jaroslav@26
    50
import javax.tools.FileObject;
jaroslav@26
    51
import javax.tools.StandardLocation;
jaroslav@491
    52
import org.apidesign.bck2brwsr.htmlpage.api.ComputedProperty;
jaroslav@435
    53
import org.apidesign.bck2brwsr.htmlpage.api.On;
jaroslav@26
    54
import org.apidesign.bck2brwsr.htmlpage.api.Page;
jaroslav@490
    55
import org.apidesign.bck2brwsr.htmlpage.api.Property;
jaroslav@26
    56
import org.openide.util.lookup.ServiceProvider;
jaroslav@26
    57
jaroslav@26
    58
/** Annotation processor to process an XHTML page and generate appropriate 
jaroslav@26
    59
 * "id" file.
jaroslav@26
    60
 *
jaroslav@26
    61
 * @author Jaroslav Tulach <jtulach@netbeans.org>
jaroslav@26
    62
 */
jaroslav@26
    63
@ServiceProvider(service=Processor.class)
jaroslav@28
    64
@SupportedAnnotationTypes({
jaroslav@28
    65
    "org.apidesign.bck2brwsr.htmlpage.api.Page",
jaroslav@435
    66
    "org.apidesign.bck2brwsr.htmlpage.api.On"
jaroslav@28
    67
})
jaroslav@26
    68
public final class PageProcessor extends AbstractProcessor {
jaroslav@26
    69
    @Override
jaroslav@26
    70
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
jaroslav@26
    71
        for (Element e : roundEnv.getElementsAnnotatedWith(Page.class)) {
jaroslav@26
    72
            Page p = e.getAnnotation(Page.class);
jaroslav@100
    73
            PackageElement pe = (PackageElement)e.getEnclosingElement();
jaroslav@26
    74
            String pkg = pe.getQualifiedName().toString();
jaroslav@26
    75
            
jaroslav@26
    76
            ProcessPage pp;
jaroslav@26
    77
            try {
jaroslav@26
    78
                InputStream is = openStream(pkg, p.xhtml());
jaroslav@26
    79
                pp = ProcessPage.readPage(is);
jaroslav@26
    80
                is.close();
jaroslav@26
    81
            } catch (IOException iOException) {
jaroslav@26
    82
                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't read " + p.xhtml(), e);
jaroslav@26
    83
                return false;
jaroslav@26
    84
            }
jaroslav@26
    85
            Writer w;
jaroslav@108
    86
            String className = p.className();
jaroslav@108
    87
            if (className.isEmpty()) {
jaroslav@108
    88
                int indx = p.xhtml().indexOf('.');
jaroslav@108
    89
                className = p.xhtml().substring(0, indx);
jaroslav@108
    90
            }
jaroslav@26
    91
            try {
jaroslav@108
    92
                FileObject java = processingEnv.getFiler().createSourceFile(pkg + '.' + className, e);
jaroslav@26
    93
                w = new OutputStreamWriter(java.openOutputStream());
jaroslav@28
    94
                try {
jaroslav@28
    95
                    w.append("package " + pkg + ";\n");
jaroslav@28
    96
                    w.append("import org.apidesign.bck2brwsr.htmlpage.api.*;\n");
jaroslav@108
    97
                    w.append("class ").append(className).append(" {\n");
jaroslav@500
    98
                    w.append("  private static boolean locked;\n");
jaroslav@492
    99
                    w.append("  private ").append(className).append("() {}\n");
jaroslav@28
   100
                    for (String id : pp.ids()) {
jaroslav@28
   101
                        String tag = pp.tagNameForId(id);
jaroslav@28
   102
                        String type = type(tag);
jaroslav@28
   103
                        w.append("  ").append("public static final ").
jaroslav@28
   104
                            append(type).append(' ').append(cnstnt(id)).append(" = new ").
jaroslav@28
   105
                            append(type).append("(\"").append(id).append("\");\n");
jaroslav@28
   106
                    }
jaroslav@28
   107
                    w.append("  static {\n");
jaroslav@489
   108
                    if (!initializeOnClick((TypeElement) e, w, pp)) {
jaroslav@28
   109
                        return false;
jaroslav@28
   110
                    }
jaroslav@28
   111
                    w.append("  }\n");
jaroslav@492
   112
                    List<String> propsGetSet = new ArrayList<String>();
jaroslav@498
   113
                    Map<String,Collection<String>> propsDeps = new HashMap<String, Collection<String>>();
jaroslav@498
   114
                    generateComputedProperties(w, e.getEnclosedElements(), propsGetSet, propsDeps);
jaroslav@498
   115
                    generateProperties(w, p.properties(), propsGetSet, propsDeps);
jaroslav@496
   116
                    w.append("  private static org.apidesign.bck2brwsr.htmlpage.Knockout ko;\n");
jaroslav@492
   117
                    if (!propsGetSet.isEmpty()) {
jaroslav@492
   118
                        w.write("public static void applyBindings() {\n");
jaroslav@496
   119
                        w.write("  ko = org.apidesign.bck2brwsr.htmlpage.Knockout.applyBindings(");
jaroslav@492
   120
                        w.write(className + ".class, new " + className + "(), ");
jaroslav@492
   121
                        w.write("new String[] {\n");
jaroslav@492
   122
                        String sep = "";
jaroslav@492
   123
                        for (String n : propsGetSet) {
jaroslav@492
   124
                            w.write(sep);
jaroslav@492
   125
                            if (n == null) {
jaroslav@492
   126
                                w.write("    null");
jaroslav@492
   127
                            } else {
jaroslav@492
   128
                                w.write("    \"" + n + "\"");
jaroslav@492
   129
                            }
jaroslav@492
   130
                            sep = ",\n";
jaroslav@492
   131
                        }
jaroslav@492
   132
                        w.write("\n  });\n}\n");
jaroslav@492
   133
                        //w.write("static { applyBindings(); }\n");
jaroslav@492
   134
                    }
jaroslav@28
   135
                    w.append("}\n");
jaroslav@28
   136
                } finally {
jaroslav@28
   137
                    w.close();
jaroslav@26
   138
                }
jaroslav@26
   139
            } catch (IOException ex) {
jaroslav@108
   140
                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
jaroslav@26
   141
                return false;
jaroslav@26
   142
            }
jaroslav@26
   143
        }
jaroslav@26
   144
        return true;
jaroslav@26
   145
    }
jaroslav@26
   146
jaroslav@26
   147
    private InputStream openStream(String pkg, String name) throws IOException {
jaroslav@26
   148
        try {
jaroslav@107
   149
            FileObject fo = processingEnv.getFiler().getResource(
jaroslav@107
   150
                StandardLocation.SOURCE_PATH, pkg, name);
jaroslav@26
   151
            return fo.openInputStream();
jaroslav@26
   152
        } catch (IOException ex) {
jaroslav@26
   153
            return processingEnv.getFiler().getResource(StandardLocation.CLASS_OUTPUT, pkg, name).openInputStream();
jaroslav@26
   154
        }
jaroslav@26
   155
    }
jaroslav@26
   156
jaroslav@26
   157
    private static String type(String tag) {
jaroslav@26
   158
        if (tag.equals("title")) {
jaroslav@26
   159
            return "Title";
jaroslav@26
   160
        }
jaroslav@26
   161
        if (tag.equals("button")) {
jaroslav@26
   162
            return "Button";
jaroslav@26
   163
        }
jaroslav@26
   164
        if (tag.equals("input")) {
jaroslav@26
   165
            return "Input";
jaroslav@26
   166
        }
jaroslav@26
   167
        return "Element";
jaroslav@26
   168
    }
jaroslav@26
   169
jaroslav@26
   170
    private static String cnstnt(String id) {
jaroslav@26
   171
        return id.toUpperCase(Locale.ENGLISH).replace('.', '_');
jaroslav@26
   172
    }
jaroslav@28
   173
jaroslav@489
   174
    private boolean initializeOnClick(TypeElement type, Writer w, ProcessPage pp) throws IOException {
jaroslav@124
   175
        TypeMirror stringType = processingEnv.getElementUtils().getTypeElement("java.lang.String").asType();
jaroslav@489
   176
        { //for (Element clazz : pe.getEnclosedElements()) {
jaroslav@489
   177
          //  if (clazz.getKind() != ElementKind.CLASS) {
jaroslav@489
   178
            //    continue;
jaroslav@489
   179
           // }
jaroslav@489
   180
            for (Element method : type.getEnclosedElements()) {
jaroslav@435
   181
                On oc = method.getAnnotation(On.class);
jaroslav@28
   182
                if (oc != null) {
jaroslav@124
   183
                    for (String id : oc.id()) {
jaroslav@124
   184
                        if (pp.tagNameForId(id) == null) {
jaroslav@435
   185
                            processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "id = " + id + " does not exist in the HTML page. Found only " + pp.ids(), method);
jaroslav@124
   186
                            return false;
jaroslav@124
   187
                        }
jaroslav@124
   188
                        ExecutableElement ee = (ExecutableElement)method;
jaroslav@124
   189
                        boolean hasParam;
jaroslav@124
   190
                        if (ee.getParameters().isEmpty()) {
jaroslav@124
   191
                            hasParam = false;
jaroslav@124
   192
                        } else {
jaroslav@124
   193
                            if (ee.getParameters().size() != 1 || ee.getParameters().get(0).asType() != stringType) {
jaroslav@435
   194
                                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method should either have no arguments or one String argument", ee);
jaroslav@124
   195
                                return false;
jaroslav@124
   196
                            }
jaroslav@124
   197
                            hasParam = true;
jaroslav@124
   198
                        }
jaroslav@124
   199
                        if (!ee.getModifiers().contains(Modifier.STATIC)) {
jaroslav@435
   200
                            processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method has to be static", ee);
jaroslav@124
   201
                            return false;
jaroslav@124
   202
                        }
jaroslav@124
   203
                        if (ee.getModifiers().contains(Modifier.PRIVATE)) {
jaroslav@435
   204
                            processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method can't be private", ee);
jaroslav@124
   205
                            return false;
jaroslav@124
   206
                        }
jaroslav@435
   207
                        w.append("  OnEvent." + oc.event()).append(".of(").append(cnstnt(id)).
jaroslav@435
   208
                            append(").perform(new Runnable() { public void run() {\n");
jaroslav@124
   209
                        w.append("    ").append(type.getSimpleName().toString()).
jaroslav@124
   210
                            append('.').append(ee.getSimpleName()).append("(");
jaroslav@124
   211
                        if (hasParam) {
jaroslav@124
   212
                            w.append("\"").append(id).append("\"");
jaroslav@124
   213
                        }
jaroslav@124
   214
                        w.append(");\n");
jaroslav@124
   215
                        w.append("  }});\n");
jaroslav@124
   216
                    }           
jaroslav@28
   217
                }
jaroslav@28
   218
            }
jaroslav@28
   219
        }
jaroslav@28
   220
        return true;
jaroslav@28
   221
    }
jaroslav@117
   222
jaroslav@117
   223
    @Override
jaroslav@117
   224
    public Iterable<? extends Completion> getCompletions(
jaroslav@117
   225
        Element element, AnnotationMirror annotation, 
jaroslav@117
   226
        ExecutableElement member, String userText
jaroslav@117
   227
    ) {
jaroslav@117
   228
        if (!userText.startsWith("\"")) {
jaroslav@117
   229
            return Collections.emptyList();
jaroslav@117
   230
        }
jaroslav@117
   231
        
jaroslav@117
   232
        Element cls = findClass(element);
jaroslav@117
   233
        Page p = cls.getAnnotation(Page.class);
jaroslav@117
   234
        PackageElement pe = (PackageElement) cls.getEnclosingElement();
jaroslav@117
   235
        String pkg = pe.getQualifiedName().toString();
jaroslav@117
   236
        ProcessPage pp;
jaroslav@117
   237
        try {
jaroslav@117
   238
            InputStream is = openStream(pkg, p.xhtml());
jaroslav@117
   239
            pp = ProcessPage.readPage(is);
jaroslav@117
   240
            is.close();
jaroslav@117
   241
        } catch (IOException iOException) {
jaroslav@117
   242
            return Collections.emptyList();
jaroslav@117
   243
        }
jaroslav@117
   244
        
jaroslav@117
   245
        List<Completion> cc = new ArrayList<Completion>();
jaroslav@117
   246
        userText = userText.substring(1);
jaroslav@117
   247
        for (String id : pp.ids()) {
jaroslav@117
   248
            if (id.startsWith(userText)) {
jaroslav@117
   249
                cc.add(Completions.of("\"" + id + "\"", id));
jaroslav@117
   250
            }
jaroslav@117
   251
        }
jaroslav@117
   252
        return cc;
jaroslav@117
   253
    }
jaroslav@117
   254
    
jaroslav@117
   255
    private static Element findClass(Element e) {
jaroslav@117
   256
        if (e == null) {
jaroslav@117
   257
            return null;
jaroslav@117
   258
        }
jaroslav@117
   259
        Page p = e.getAnnotation(Page.class);
jaroslav@117
   260
        if (p != null) {
jaroslav@117
   261
            return e;
jaroslav@117
   262
        }
jaroslav@117
   263
        return e.getEnclosingElement();
jaroslav@117
   264
    }
jaroslav@490
   265
jaroslav@492
   266
    private static void generateProperties(
jaroslav@498
   267
        Writer w, Property[] properties, Collection<String> props,
jaroslav@498
   268
        Map<String,Collection<String>> deps
jaroslav@492
   269
    ) throws IOException {
jaroslav@490
   270
        for (Property p : properties) {
jaroslav@492
   271
            final String tn = typeName(p);
jaroslav@492
   272
            String[] gs = toGetSet(p.name(), tn);
jaroslav@490
   273
jaroslav@490
   274
            w.write("private static " + tn + " prop_" + p.name() + ";\n");
jaroslav@490
   275
            w.write("public static " + tn + " " + gs[0] + "() {\n");
jaroslav@500
   276
            w.write("  if (locked) throw new IllegalStateException();\n");
jaroslav@490
   277
            w.write("  return prop_" + p.name() + ";\n");
jaroslav@490
   278
            w.write("}\n");
jaroslav@490
   279
            w.write("public static void " + gs[1] + "(" + tn + " v) {\n");
jaroslav@500
   280
            w.write("  if (locked) throw new IllegalStateException();\n");
jaroslav@490
   281
            w.write("  prop_" + p.name() + " = v;\n");
jaroslav@498
   282
            w.write("  if (ko != null) {\n");
jaroslav@498
   283
            w.write("    ko.valueHasMutated(\"" + p.name() + "\");\n");
jaroslav@498
   284
            final Collection<String> dependants = deps.get(p.name());
jaroslav@498
   285
            if (dependants != null) {
jaroslav@498
   286
                for (String depProp : dependants) {
jaroslav@498
   287
                    w.write("    ko.valueHasMutated(\"" + depProp + "\");\n");
jaroslav@498
   288
                }
jaroslav@498
   289
            }
jaroslav@498
   290
            w.write("  }\n");
jaroslav@490
   291
            w.write("}\n");
jaroslav@492
   292
            
jaroslav@492
   293
            props.add(p.name());
jaroslav@492
   294
            props.add(gs[2]);
jaroslav@492
   295
            props.add(gs[3]);
jaroslav@490
   296
        }
jaroslav@490
   297
    }
jaroslav@490
   298
jaroslav@498
   299
    private boolean generateComputedProperties(
jaroslav@498
   300
        Writer w, Collection<? extends Element> arr, Collection<String> props,
jaroslav@498
   301
        Map<String,Collection<String>> deps
jaroslav@492
   302
    ) throws IOException {
jaroslav@491
   303
        for (Element e : arr) {
jaroslav@491
   304
            if (e.getKind() != ElementKind.METHOD) {
jaroslav@491
   305
                continue;
jaroslav@491
   306
            }
jaroslav@491
   307
            if (e.getAnnotation(ComputedProperty.class) == null) {
jaroslav@491
   308
                continue;
jaroslav@491
   309
            }
jaroslav@491
   310
            ExecutableElement ee = (ExecutableElement)e;
jaroslav@492
   311
            final String tn = ee.getReturnType().toString();
jaroslav@498
   312
            final String sn = ee.getSimpleName().toString();
jaroslav@498
   313
            String[] gs = toGetSet(sn, tn);
jaroslav@498
   314
            
jaroslav@491
   315
            w.write("public static " + tn + " " + gs[0] + "() {\n");
jaroslav@500
   316
            w.write("  if (locked) throw new IllegalStateException();\n");
jaroslav@500
   317
            int arg = 0;
jaroslav@491
   318
            for (VariableElement pe : ee.getParameters()) {
jaroslav@498
   319
                final String dn = pe.getSimpleName().toString();
jaroslav@500
   320
                final String dt = pe.asType().toString();
jaroslav@500
   321
                String[] call = toGetSet(dn, dt);
jaroslav@500
   322
                w.write("  " + dt + " arg" + (++arg) + " = ");
jaroslav@500
   323
                w.write(call[0] + "();\n");
jaroslav@498
   324
                
jaroslav@498
   325
                Collection<String> depends = deps.get(dn);
jaroslav@498
   326
                if (depends == null) {
jaroslav@498
   327
                    depends = new LinkedHashSet<String>();
jaroslav@498
   328
                    deps.put(dn, depends);
jaroslav@498
   329
                }
jaroslav@498
   330
                depends.add(sn);
jaroslav@491
   331
            }
jaroslav@500
   332
            w.write("  try {\n");
jaroslav@500
   333
            w.write("    locked = true;\n");
jaroslav@500
   334
            w.write("    return " + e.getEnclosingElement().getSimpleName() + '.' + e.getSimpleName() + "(");
jaroslav@500
   335
            String sep = "";
jaroslav@500
   336
            for (int i = 1; i <= arg; i++) {
jaroslav@500
   337
                w.write(sep);
jaroslav@500
   338
                w.write("arg" + i);
jaroslav@500
   339
                sep = ", ";
jaroslav@500
   340
            }
jaroslav@491
   341
            w.write(");\n");
jaroslav@500
   342
            w.write("  } finally {\n");
jaroslav@500
   343
            w.write("    locked = false;\n");
jaroslav@500
   344
            w.write("  }\n");
jaroslav@491
   345
            w.write("}\n");
jaroslav@492
   346
            
jaroslav@492
   347
            props.add(e.getSimpleName().toString());
jaroslav@492
   348
            props.add(gs[2]);
jaroslav@492
   349
            props.add(null);
jaroslav@491
   350
        }
jaroslav@498
   351
        
jaroslav@498
   352
        return true;
jaroslav@491
   353
    }
jaroslav@491
   354
jaroslav@492
   355
    private static String[] toGetSet(String name, String type) {
jaroslav@491
   356
        String n = Character.toUpperCase(name.charAt(0)) + name.substring(1);
jaroslav@492
   357
        String bck2brwsrType = "L" + type.replace('.', '_') + "_2";
jaroslav@492
   358
        if ("int".equals(type)) {
jaroslav@492
   359
            bck2brwsrType = "I";
jaroslav@492
   360
        }
jaroslav@492
   361
        if ("double".equals(type)) {
jaroslav@492
   362
            bck2brwsrType = "D";
jaroslav@492
   363
        }
jaroslav@492
   364
        String pref = "get";
jaroslav@492
   365
        if ("boolean".equals(type)) {
jaroslav@492
   366
            pref = "is";
jaroslav@492
   367
            bck2brwsrType = "Z";
jaroslav@492
   368
        }
jaroslav@498
   369
        final String nu = n.replace('.', '_');
jaroslav@492
   370
        return new String[]{
jaroslav@492
   371
            pref + n, 
jaroslav@492
   372
            "set" + n, 
jaroslav@498
   373
            pref + nu + "__" + bck2brwsrType,
jaroslav@498
   374
            "set" + nu + "__V" + bck2brwsrType
jaroslav@492
   375
        };
jaroslav@490
   376
    }
jaroslav@490
   377
jaroslav@490
   378
    private static String typeName(Property p) {
jaroslav@490
   379
        try {
jaroslav@490
   380
            return p.type().getName();
jaroslav@490
   381
        } catch (MirroredTypeException ex) {
jaroslav@498
   382
            return ex.getTypeMirror().toString();
jaroslav@490
   383
        }
jaroslav@490
   384
    }
jaroslav@26
   385
}