javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/PageProcessor.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Mon, 21 Jan 2013 15:57:30 +0100
branchmodel
changeset 510 aaf86ae88f46
parent 508 46fc57ff6553
child 512 1c3fda8898a1
permissions -rw-r--r--
Injection of 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@505
    97
                    w.append("final class ").append(className).append(" {\n");
jaroslav@500
    98
                    w.append("  private static boolean locked;\n");
jaroslav@505
    99
                    w.append("  public ").append(className).append("() {\n");
jaroslav@510
   100
                    if (!initializeOnClick(className, (TypeElement) e, w, pp)) {
jaroslav@28
   101
                        return false;
jaroslav@28
   102
                    }
jaroslav@28
   103
                    w.append("  }\n");
jaroslav@505
   104
                    for (String id : pp.ids()) {
jaroslav@505
   105
                        String tag = pp.tagNameForId(id);
jaroslav@505
   106
                        String type = type(tag);
jaroslav@505
   107
                        w.append("  ").append("public final ").
jaroslav@505
   108
                            append(type).append(' ').append(cnstnt(id)).append(" = new ").
jaroslav@505
   109
                            append(type).append("(\"").append(id).append("\");\n");
jaroslav@505
   110
                    }
jaroslav@492
   111
                    List<String> propsGetSet = new ArrayList<String>();
jaroslav@498
   112
                    Map<String,Collection<String>> propsDeps = new HashMap<String, Collection<String>>();
jaroslav@498
   113
                    generateComputedProperties(w, e.getEnclosedElements(), propsGetSet, propsDeps);
jaroslav@498
   114
                    generateProperties(w, p.properties(), propsGetSet, propsDeps);
jaroslav@505
   115
                    w.append("  private org.apidesign.bck2brwsr.htmlpage.Knockout ko;\n");
jaroslav@492
   116
                    if (!propsGetSet.isEmpty()) {
jaroslav@505
   117
                        w.write("public " + className + " applyBindings() {\n");
jaroslav@496
   118
                        w.write("  ko = org.apidesign.bck2brwsr.htmlpage.Knockout.applyBindings(");
jaroslav@508
   119
                        w.write(className + ".class, this, ");
jaroslav@492
   120
                        w.write("new String[] {\n");
jaroslav@492
   121
                        String sep = "";
jaroslav@492
   122
                        for (String n : propsGetSet) {
jaroslav@492
   123
                            w.write(sep);
jaroslav@492
   124
                            if (n == null) {
jaroslav@492
   125
                                w.write("    null");
jaroslav@492
   126
                            } else {
jaroslav@492
   127
                                w.write("    \"" + n + "\"");
jaroslav@492
   128
                            }
jaroslav@492
   129
                            sep = ",\n";
jaroslav@492
   130
                        }
jaroslav@505
   131
                        w.write("\n  });\n  return this;\n}\n");
jaroslav@492
   132
                    }
jaroslav@28
   133
                    w.append("}\n");
jaroslav@28
   134
                } finally {
jaroslav@28
   135
                    w.close();
jaroslav@26
   136
                }
jaroslav@26
   137
            } catch (IOException ex) {
jaroslav@108
   138
                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
jaroslav@26
   139
                return false;
jaroslav@26
   140
            }
jaroslav@26
   141
        }
jaroslav@26
   142
        return true;
jaroslav@26
   143
    }
jaroslav@26
   144
jaroslav@26
   145
    private InputStream openStream(String pkg, String name) throws IOException {
jaroslav@26
   146
        try {
jaroslav@107
   147
            FileObject fo = processingEnv.getFiler().getResource(
jaroslav@107
   148
                StandardLocation.SOURCE_PATH, pkg, name);
jaroslav@26
   149
            return fo.openInputStream();
jaroslav@26
   150
        } catch (IOException ex) {
jaroslav@26
   151
            return processingEnv.getFiler().getResource(StandardLocation.CLASS_OUTPUT, pkg, name).openInputStream();
jaroslav@26
   152
        }
jaroslav@26
   153
    }
jaroslav@26
   154
jaroslav@26
   155
    private static String type(String tag) {
jaroslav@26
   156
        if (tag.equals("title")) {
jaroslav@26
   157
            return "Title";
jaroslav@26
   158
        }
jaroslav@26
   159
        if (tag.equals("button")) {
jaroslav@26
   160
            return "Button";
jaroslav@26
   161
        }
jaroslav@26
   162
        if (tag.equals("input")) {
jaroslav@26
   163
            return "Input";
jaroslav@26
   164
        }
jaroslav@26
   165
        return "Element";
jaroslav@26
   166
    }
jaroslav@26
   167
jaroslav@26
   168
    private static String cnstnt(String id) {
jaroslav@26
   169
        return id.toUpperCase(Locale.ENGLISH).replace('.', '_');
jaroslav@26
   170
    }
jaroslav@28
   171
jaroslav@510
   172
    private boolean initializeOnClick(
jaroslav@510
   173
        String className, TypeElement type, Writer w, ProcessPage pp
jaroslav@510
   174
    ) 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@510
   189
                        StringBuilder params = new StringBuilder();
jaroslav@510
   190
                        {
jaroslav@510
   191
                            boolean first = true;
jaroslav@510
   192
                            for (VariableElement ve : ee.getParameters()) {
jaroslav@510
   193
                                if (!first) {
jaroslav@510
   194
                                    params.append(", ");
jaroslav@510
   195
                                }
jaroslav@510
   196
                                first = false;
jaroslav@510
   197
                                if (ve.asType() == stringType) {
jaroslav@510
   198
                                    params.append('"').append(id).append('"');
jaroslav@510
   199
                                    continue;
jaroslav@510
   200
                                }
jaroslav@510
   201
                                if (ve.asType().toString().equals(className)) {
jaroslav@510
   202
                                    params.append(className).append(".this");
jaroslav@510
   203
                                    continue;
jaroslav@510
   204
                                }
jaroslav@510
   205
                                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, 
jaroslav@510
   206
                                    "@On method can only accept String or " + className + " arguments",
jaroslav@510
   207
                                    ee
jaroslav@510
   208
                                );
jaroslav@124
   209
                                return false;
jaroslav@124
   210
                            }
jaroslav@124
   211
                        }
jaroslav@124
   212
                        if (!ee.getModifiers().contains(Modifier.STATIC)) {
jaroslav@435
   213
                            processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method has to be static", ee);
jaroslav@124
   214
                            return false;
jaroslav@124
   215
                        }
jaroslav@124
   216
                        if (ee.getModifiers().contains(Modifier.PRIVATE)) {
jaroslav@435
   217
                            processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method can't be private", ee);
jaroslav@124
   218
                            return false;
jaroslav@124
   219
                        }
jaroslav@435
   220
                        w.append("  OnEvent." + oc.event()).append(".of(").append(cnstnt(id)).
jaroslav@435
   221
                            append(").perform(new Runnable() { public void run() {\n");
jaroslav@124
   222
                        w.append("    ").append(type.getSimpleName().toString()).
jaroslav@124
   223
                            append('.').append(ee.getSimpleName()).append("(");
jaroslav@510
   224
                        w.append(params);
jaroslav@124
   225
                        w.append(");\n");
jaroslav@124
   226
                        w.append("  }});\n");
jaroslav@124
   227
                    }           
jaroslav@28
   228
                }
jaroslav@28
   229
            }
jaroslav@28
   230
        }
jaroslav@28
   231
        return true;
jaroslav@28
   232
    }
jaroslav@117
   233
jaroslav@117
   234
    @Override
jaroslav@117
   235
    public Iterable<? extends Completion> getCompletions(
jaroslav@117
   236
        Element element, AnnotationMirror annotation, 
jaroslav@117
   237
        ExecutableElement member, String userText
jaroslav@117
   238
    ) {
jaroslav@117
   239
        if (!userText.startsWith("\"")) {
jaroslav@117
   240
            return Collections.emptyList();
jaroslav@117
   241
        }
jaroslav@117
   242
        
jaroslav@117
   243
        Element cls = findClass(element);
jaroslav@117
   244
        Page p = cls.getAnnotation(Page.class);
jaroslav@117
   245
        PackageElement pe = (PackageElement) cls.getEnclosingElement();
jaroslav@117
   246
        String pkg = pe.getQualifiedName().toString();
jaroslav@117
   247
        ProcessPage pp;
jaroslav@117
   248
        try {
jaroslav@117
   249
            InputStream is = openStream(pkg, p.xhtml());
jaroslav@117
   250
            pp = ProcessPage.readPage(is);
jaroslav@117
   251
            is.close();
jaroslav@117
   252
        } catch (IOException iOException) {
jaroslav@117
   253
            return Collections.emptyList();
jaroslav@117
   254
        }
jaroslav@117
   255
        
jaroslav@117
   256
        List<Completion> cc = new ArrayList<Completion>();
jaroslav@117
   257
        userText = userText.substring(1);
jaroslav@117
   258
        for (String id : pp.ids()) {
jaroslav@117
   259
            if (id.startsWith(userText)) {
jaroslav@117
   260
                cc.add(Completions.of("\"" + id + "\"", id));
jaroslav@117
   261
            }
jaroslav@117
   262
        }
jaroslav@117
   263
        return cc;
jaroslav@117
   264
    }
jaroslav@117
   265
    
jaroslav@117
   266
    private static Element findClass(Element e) {
jaroslav@117
   267
        if (e == null) {
jaroslav@117
   268
            return null;
jaroslav@117
   269
        }
jaroslav@117
   270
        Page p = e.getAnnotation(Page.class);
jaroslav@117
   271
        if (p != null) {
jaroslav@117
   272
            return e;
jaroslav@117
   273
        }
jaroslav@117
   274
        return e.getEnclosingElement();
jaroslav@117
   275
    }
jaroslav@490
   276
jaroslav@492
   277
    private static void generateProperties(
jaroslav@498
   278
        Writer w, Property[] properties, Collection<String> props,
jaroslav@498
   279
        Map<String,Collection<String>> deps
jaroslav@492
   280
    ) throws IOException {
jaroslav@490
   281
        for (Property p : properties) {
jaroslav@492
   282
            final String tn = typeName(p);
jaroslav@492
   283
            String[] gs = toGetSet(p.name(), tn);
jaroslav@490
   284
jaroslav@505
   285
            w.write("private " + tn + " prop_" + p.name() + ";\n");
jaroslav@505
   286
            w.write("public " + tn + " " + gs[0] + "() {\n");
jaroslav@500
   287
            w.write("  if (locked) throw new IllegalStateException();\n");
jaroslav@490
   288
            w.write("  return prop_" + p.name() + ";\n");
jaroslav@490
   289
            w.write("}\n");
jaroslav@505
   290
            w.write("public void " + gs[1] + "(" + tn + " v) {\n");
jaroslav@500
   291
            w.write("  if (locked) throw new IllegalStateException();\n");
jaroslav@490
   292
            w.write("  prop_" + p.name() + " = v;\n");
jaroslav@498
   293
            w.write("  if (ko != null) {\n");
jaroslav@498
   294
            w.write("    ko.valueHasMutated(\"" + p.name() + "\");\n");
jaroslav@498
   295
            final Collection<String> dependants = deps.get(p.name());
jaroslav@498
   296
            if (dependants != null) {
jaroslav@498
   297
                for (String depProp : dependants) {
jaroslav@498
   298
                    w.write("    ko.valueHasMutated(\"" + depProp + "\");\n");
jaroslav@498
   299
                }
jaroslav@498
   300
            }
jaroslav@498
   301
            w.write("  }\n");
jaroslav@490
   302
            w.write("}\n");
jaroslav@492
   303
            
jaroslav@492
   304
            props.add(p.name());
jaroslav@492
   305
            props.add(gs[2]);
jaroslav@492
   306
            props.add(gs[3]);
jaroslav@490
   307
        }
jaroslav@490
   308
    }
jaroslav@490
   309
jaroslav@498
   310
    private boolean generateComputedProperties(
jaroslav@498
   311
        Writer w, Collection<? extends Element> arr, Collection<String> props,
jaroslav@498
   312
        Map<String,Collection<String>> deps
jaroslav@492
   313
    ) throws IOException {
jaroslav@491
   314
        for (Element e : arr) {
jaroslav@491
   315
            if (e.getKind() != ElementKind.METHOD) {
jaroslav@491
   316
                continue;
jaroslav@491
   317
            }
jaroslav@491
   318
            if (e.getAnnotation(ComputedProperty.class) == null) {
jaroslav@491
   319
                continue;
jaroslav@491
   320
            }
jaroslav@491
   321
            ExecutableElement ee = (ExecutableElement)e;
jaroslav@492
   322
            final String tn = ee.getReturnType().toString();
jaroslav@498
   323
            final String sn = ee.getSimpleName().toString();
jaroslav@498
   324
            String[] gs = toGetSet(sn, tn);
jaroslav@498
   325
            
jaroslav@505
   326
            w.write("public " + tn + " " + gs[0] + "() {\n");
jaroslav@500
   327
            w.write("  if (locked) throw new IllegalStateException();\n");
jaroslav@500
   328
            int arg = 0;
jaroslav@491
   329
            for (VariableElement pe : ee.getParameters()) {
jaroslav@498
   330
                final String dn = pe.getSimpleName().toString();
jaroslav@500
   331
                final String dt = pe.asType().toString();
jaroslav@500
   332
                String[] call = toGetSet(dn, dt);
jaroslav@500
   333
                w.write("  " + dt + " arg" + (++arg) + " = ");
jaroslav@500
   334
                w.write(call[0] + "();\n");
jaroslav@498
   335
                
jaroslav@498
   336
                Collection<String> depends = deps.get(dn);
jaroslav@498
   337
                if (depends == null) {
jaroslav@498
   338
                    depends = new LinkedHashSet<String>();
jaroslav@498
   339
                    deps.put(dn, depends);
jaroslav@498
   340
                }
jaroslav@498
   341
                depends.add(sn);
jaroslav@491
   342
            }
jaroslav@500
   343
            w.write("  try {\n");
jaroslav@500
   344
            w.write("    locked = true;\n");
jaroslav@500
   345
            w.write("    return " + e.getEnclosingElement().getSimpleName() + '.' + e.getSimpleName() + "(");
jaroslav@500
   346
            String sep = "";
jaroslav@500
   347
            for (int i = 1; i <= arg; i++) {
jaroslav@500
   348
                w.write(sep);
jaroslav@500
   349
                w.write("arg" + i);
jaroslav@500
   350
                sep = ", ";
jaroslav@500
   351
            }
jaroslav@491
   352
            w.write(");\n");
jaroslav@500
   353
            w.write("  } finally {\n");
jaroslav@500
   354
            w.write("    locked = false;\n");
jaroslav@500
   355
            w.write("  }\n");
jaroslav@491
   356
            w.write("}\n");
jaroslav@492
   357
            
jaroslav@492
   358
            props.add(e.getSimpleName().toString());
jaroslav@492
   359
            props.add(gs[2]);
jaroslav@492
   360
            props.add(null);
jaroslav@491
   361
        }
jaroslav@498
   362
        
jaroslav@498
   363
        return true;
jaroslav@491
   364
    }
jaroslav@491
   365
jaroslav@492
   366
    private static String[] toGetSet(String name, String type) {
jaroslav@491
   367
        String n = Character.toUpperCase(name.charAt(0)) + name.substring(1);
jaroslav@492
   368
        String bck2brwsrType = "L" + type.replace('.', '_') + "_2";
jaroslav@492
   369
        if ("int".equals(type)) {
jaroslav@492
   370
            bck2brwsrType = "I";
jaroslav@492
   371
        }
jaroslav@492
   372
        if ("double".equals(type)) {
jaroslav@492
   373
            bck2brwsrType = "D";
jaroslav@492
   374
        }
jaroslav@492
   375
        String pref = "get";
jaroslav@492
   376
        if ("boolean".equals(type)) {
jaroslav@492
   377
            pref = "is";
jaroslav@492
   378
            bck2brwsrType = "Z";
jaroslav@492
   379
        }
jaroslav@498
   380
        final String nu = n.replace('.', '_');
jaroslav@492
   381
        return new String[]{
jaroslav@492
   382
            pref + n, 
jaroslav@492
   383
            "set" + n, 
jaroslav@498
   384
            pref + nu + "__" + bck2brwsrType,
jaroslav@498
   385
            "set" + nu + "__V" + bck2brwsrType
jaroslav@492
   386
        };
jaroslav@490
   387
    }
jaroslav@490
   388
jaroslav@490
   389
    private static String typeName(Property p) {
jaroslav@490
   390
        try {
jaroslav@490
   391
            return p.type().getName();
jaroslav@490
   392
        } catch (MirroredTypeException ex) {
jaroslav@498
   393
            return ex.getTypeMirror().toString();
jaroslav@490
   394
        }
jaroslav@490
   395
    }
jaroslav@26
   396
}