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