javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/PageProcessor.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Sun, 20 Jan 2013 18:20:18 +0100
branchmodel
changeset 492 854286e49061
parent 491 14268cd404a4
child 496 a06c98795b01
permissions -rw-r--r--
Basic support for knockout.js. It can read and write model 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@117
    27
import java.util.List;
jaroslav@26
    28
import java.util.Locale;
jaroslav@26
    29
import java.util.Set;
jaroslav@26
    30
import javax.annotation.processing.AbstractProcessor;
jaroslav@117
    31
import javax.annotation.processing.Completion;
jaroslav@117
    32
import javax.annotation.processing.Completions;
jaroslav@26
    33
import javax.annotation.processing.Processor;
jaroslav@26
    34
import javax.annotation.processing.RoundEnvironment;
jaroslav@26
    35
import javax.annotation.processing.SupportedAnnotationTypes;
jaroslav@117
    36
import javax.lang.model.element.AnnotationMirror;
jaroslav@26
    37
import javax.lang.model.element.Element;
jaroslav@491
    38
import javax.lang.model.element.ElementKind;
jaroslav@28
    39
import javax.lang.model.element.ExecutableElement;
jaroslav@28
    40
import javax.lang.model.element.Modifier;
jaroslav@26
    41
import javax.lang.model.element.PackageElement;
jaroslav@26
    42
import javax.lang.model.element.TypeElement;
jaroslav@491
    43
import javax.lang.model.element.VariableElement;
jaroslav@490
    44
import javax.lang.model.type.MirroredTypeException;
jaroslav@124
    45
import javax.lang.model.type.TypeMirror;
jaroslav@26
    46
import javax.tools.Diagnostic;
jaroslav@26
    47
import javax.tools.FileObject;
jaroslav@26
    48
import javax.tools.StandardLocation;
jaroslav@491
    49
import org.apidesign.bck2brwsr.htmlpage.api.ComputedProperty;
jaroslav@435
    50
import org.apidesign.bck2brwsr.htmlpage.api.On;
jaroslav@26
    51
import org.apidesign.bck2brwsr.htmlpage.api.Page;
jaroslav@490
    52
import org.apidesign.bck2brwsr.htmlpage.api.Property;
jaroslav@26
    53
import org.openide.util.lookup.ServiceProvider;
jaroslav@26
    54
jaroslav@26
    55
/** Annotation processor to process an XHTML page and generate appropriate 
jaroslav@26
    56
 * "id" file.
jaroslav@26
    57
 *
jaroslav@26
    58
 * @author Jaroslav Tulach <jtulach@netbeans.org>
jaroslav@26
    59
 */
jaroslav@26
    60
@ServiceProvider(service=Processor.class)
jaroslav@28
    61
@SupportedAnnotationTypes({
jaroslav@28
    62
    "org.apidesign.bck2brwsr.htmlpage.api.Page",
jaroslav@435
    63
    "org.apidesign.bck2brwsr.htmlpage.api.On"
jaroslav@28
    64
})
jaroslav@26
    65
public final class PageProcessor extends AbstractProcessor {
jaroslav@26
    66
    @Override
jaroslav@26
    67
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
jaroslav@26
    68
        for (Element e : roundEnv.getElementsAnnotatedWith(Page.class)) {
jaroslav@26
    69
            Page p = e.getAnnotation(Page.class);
jaroslav@100
    70
            PackageElement pe = (PackageElement)e.getEnclosingElement();
jaroslav@26
    71
            String pkg = pe.getQualifiedName().toString();
jaroslav@26
    72
            
jaroslav@26
    73
            ProcessPage pp;
jaroslav@26
    74
            try {
jaroslav@26
    75
                InputStream is = openStream(pkg, p.xhtml());
jaroslav@26
    76
                pp = ProcessPage.readPage(is);
jaroslav@26
    77
                is.close();
jaroslav@26
    78
            } catch (IOException iOException) {
jaroslav@26
    79
                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't read " + p.xhtml(), e);
jaroslav@26
    80
                return false;
jaroslav@26
    81
            }
jaroslav@26
    82
            Writer w;
jaroslav@108
    83
            String className = p.className();
jaroslav@108
    84
            if (className.isEmpty()) {
jaroslav@108
    85
                int indx = p.xhtml().indexOf('.');
jaroslav@108
    86
                className = p.xhtml().substring(0, indx);
jaroslav@108
    87
            }
jaroslav@26
    88
            try {
jaroslav@108
    89
                FileObject java = processingEnv.getFiler().createSourceFile(pkg + '.' + className, e);
jaroslav@26
    90
                w = new OutputStreamWriter(java.openOutputStream());
jaroslav@28
    91
                try {
jaroslav@28
    92
                    w.append("package " + pkg + ";\n");
jaroslav@28
    93
                    w.append("import org.apidesign.bck2brwsr.htmlpage.api.*;\n");
jaroslav@108
    94
                    w.append("class ").append(className).append(" {\n");
jaroslav@492
    95
                    w.append("  private ").append(className).append("() {}\n");
jaroslav@28
    96
                    for (String id : pp.ids()) {
jaroslav@28
    97
                        String tag = pp.tagNameForId(id);
jaroslav@28
    98
                        String type = type(tag);
jaroslav@28
    99
                        w.append("  ").append("public static final ").
jaroslav@28
   100
                            append(type).append(' ').append(cnstnt(id)).append(" = new ").
jaroslav@28
   101
                            append(type).append("(\"").append(id).append("\");\n");
jaroslav@28
   102
                    }
jaroslav@28
   103
                    w.append("  static {\n");
jaroslav@489
   104
                    if (!initializeOnClick((TypeElement) e, w, pp)) {
jaroslav@28
   105
                        return false;
jaroslav@28
   106
                    }
jaroslav@28
   107
                    w.append("  }\n");
jaroslav@492
   108
                    List<String> propsGetSet = new ArrayList<String>();
jaroslav@492
   109
                    generateProperties(w, p.properties(), propsGetSet);
jaroslav@492
   110
                    generateComputedProperties(w, e.getEnclosedElements(), propsGetSet);
jaroslav@492
   111
                    if (!propsGetSet.isEmpty()) {
jaroslav@492
   112
                        w.write("public static void applyBindings() {\n");
jaroslav@492
   113
                        w.write("  org.apidesign.bck2brwsr.htmlpage.Knockout.applyBindings(");
jaroslav@492
   114
                        w.write(className + ".class, new " + className + "(), ");
jaroslav@492
   115
                        w.write("new String[] {\n");
jaroslav@492
   116
                        String sep = "";
jaroslav@492
   117
                        for (String n : propsGetSet) {
jaroslav@492
   118
                            w.write(sep);
jaroslav@492
   119
                            if (n == null) {
jaroslav@492
   120
                                w.write("    null");
jaroslav@492
   121
                            } else {
jaroslav@492
   122
                                w.write("    \"" + n + "\"");
jaroslav@492
   123
                            }
jaroslav@492
   124
                            sep = ",\n";
jaroslav@492
   125
                        }
jaroslav@492
   126
                        w.write("\n  });\n}\n");
jaroslav@492
   127
                        //w.write("static { applyBindings(); }\n");
jaroslav@492
   128
                    }
jaroslav@28
   129
                    w.append("}\n");
jaroslav@28
   130
                } finally {
jaroslav@28
   131
                    w.close();
jaroslav@26
   132
                }
jaroslav@26
   133
            } catch (IOException ex) {
jaroslav@108
   134
                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
jaroslav@26
   135
                return false;
jaroslav@26
   136
            }
jaroslav@26
   137
        }
jaroslav@26
   138
        return true;
jaroslav@26
   139
    }
jaroslav@26
   140
jaroslav@26
   141
    private InputStream openStream(String pkg, String name) throws IOException {
jaroslav@26
   142
        try {
jaroslav@107
   143
            FileObject fo = processingEnv.getFiler().getResource(
jaroslav@107
   144
                StandardLocation.SOURCE_PATH, pkg, name);
jaroslav@26
   145
            return fo.openInputStream();
jaroslav@26
   146
        } catch (IOException ex) {
jaroslav@26
   147
            return processingEnv.getFiler().getResource(StandardLocation.CLASS_OUTPUT, pkg, name).openInputStream();
jaroslav@26
   148
        }
jaroslav@26
   149
    }
jaroslav@26
   150
jaroslav@26
   151
    private static String type(String tag) {
jaroslav@26
   152
        if (tag.equals("title")) {
jaroslav@26
   153
            return "Title";
jaroslav@26
   154
        }
jaroslav@26
   155
        if (tag.equals("button")) {
jaroslav@26
   156
            return "Button";
jaroslav@26
   157
        }
jaroslav@26
   158
        if (tag.equals("input")) {
jaroslav@26
   159
            return "Input";
jaroslav@26
   160
        }
jaroslav@26
   161
        return "Element";
jaroslav@26
   162
    }
jaroslav@26
   163
jaroslav@26
   164
    private static String cnstnt(String id) {
jaroslav@26
   165
        return id.toUpperCase(Locale.ENGLISH).replace('.', '_');
jaroslav@26
   166
    }
jaroslav@28
   167
jaroslav@489
   168
    private boolean initializeOnClick(TypeElement type, Writer w, ProcessPage pp) throws IOException {
jaroslav@124
   169
        TypeMirror stringType = processingEnv.getElementUtils().getTypeElement("java.lang.String").asType();
jaroslav@489
   170
        { //for (Element clazz : pe.getEnclosedElements()) {
jaroslav@489
   171
          //  if (clazz.getKind() != ElementKind.CLASS) {
jaroslav@489
   172
            //    continue;
jaroslav@489
   173
           // }
jaroslav@489
   174
            for (Element method : type.getEnclosedElements()) {
jaroslav@435
   175
                On oc = method.getAnnotation(On.class);
jaroslav@28
   176
                if (oc != null) {
jaroslav@124
   177
                    for (String id : oc.id()) {
jaroslav@124
   178
                        if (pp.tagNameForId(id) == null) {
jaroslav@435
   179
                            processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "id = " + id + " does not exist in the HTML page. Found only " + pp.ids(), method);
jaroslav@124
   180
                            return false;
jaroslav@124
   181
                        }
jaroslav@124
   182
                        ExecutableElement ee = (ExecutableElement)method;
jaroslav@124
   183
                        boolean hasParam;
jaroslav@124
   184
                        if (ee.getParameters().isEmpty()) {
jaroslav@124
   185
                            hasParam = false;
jaroslav@124
   186
                        } else {
jaroslav@124
   187
                            if (ee.getParameters().size() != 1 || ee.getParameters().get(0).asType() != stringType) {
jaroslav@435
   188
                                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method should either have no arguments or one String argument", ee);
jaroslav@124
   189
                                return false;
jaroslav@124
   190
                            }
jaroslav@124
   191
                            hasParam = true;
jaroslav@124
   192
                        }
jaroslav@124
   193
                        if (!ee.getModifiers().contains(Modifier.STATIC)) {
jaroslav@435
   194
                            processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method has to be static", ee);
jaroslav@124
   195
                            return false;
jaroslav@124
   196
                        }
jaroslav@124
   197
                        if (ee.getModifiers().contains(Modifier.PRIVATE)) {
jaroslav@435
   198
                            processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@On method can't be private", ee);
jaroslav@124
   199
                            return false;
jaroslav@124
   200
                        }
jaroslav@435
   201
                        w.append("  OnEvent." + oc.event()).append(".of(").append(cnstnt(id)).
jaroslav@435
   202
                            append(").perform(new Runnable() { public void run() {\n");
jaroslav@124
   203
                        w.append("    ").append(type.getSimpleName().toString()).
jaroslav@124
   204
                            append('.').append(ee.getSimpleName()).append("(");
jaroslav@124
   205
                        if (hasParam) {
jaroslav@124
   206
                            w.append("\"").append(id).append("\"");
jaroslav@124
   207
                        }
jaroslav@124
   208
                        w.append(");\n");
jaroslav@124
   209
                        w.append("  }});\n");
jaroslav@124
   210
                    }           
jaroslav@28
   211
                }
jaroslav@28
   212
            }
jaroslav@28
   213
        }
jaroslav@28
   214
        return true;
jaroslav@28
   215
    }
jaroslav@117
   216
jaroslav@117
   217
    @Override
jaroslav@117
   218
    public Iterable<? extends Completion> getCompletions(
jaroslav@117
   219
        Element element, AnnotationMirror annotation, 
jaroslav@117
   220
        ExecutableElement member, String userText
jaroslav@117
   221
    ) {
jaroslav@117
   222
        if (!userText.startsWith("\"")) {
jaroslav@117
   223
            return Collections.emptyList();
jaroslav@117
   224
        }
jaroslav@117
   225
        
jaroslav@117
   226
        Element cls = findClass(element);
jaroslav@117
   227
        Page p = cls.getAnnotation(Page.class);
jaroslav@117
   228
        PackageElement pe = (PackageElement) cls.getEnclosingElement();
jaroslav@117
   229
        String pkg = pe.getQualifiedName().toString();
jaroslav@117
   230
        ProcessPage pp;
jaroslav@117
   231
        try {
jaroslav@117
   232
            InputStream is = openStream(pkg, p.xhtml());
jaroslav@117
   233
            pp = ProcessPage.readPage(is);
jaroslav@117
   234
            is.close();
jaroslav@117
   235
        } catch (IOException iOException) {
jaroslav@117
   236
            return Collections.emptyList();
jaroslav@117
   237
        }
jaroslav@117
   238
        
jaroslav@117
   239
        List<Completion> cc = new ArrayList<Completion>();
jaroslav@117
   240
        userText = userText.substring(1);
jaroslav@117
   241
        for (String id : pp.ids()) {
jaroslav@117
   242
            if (id.startsWith(userText)) {
jaroslav@117
   243
                cc.add(Completions.of("\"" + id + "\"", id));
jaroslav@117
   244
            }
jaroslav@117
   245
        }
jaroslav@117
   246
        return cc;
jaroslav@117
   247
    }
jaroslav@117
   248
    
jaroslav@117
   249
    private static Element findClass(Element e) {
jaroslav@117
   250
        if (e == null) {
jaroslav@117
   251
            return null;
jaroslav@117
   252
        }
jaroslav@117
   253
        Page p = e.getAnnotation(Page.class);
jaroslav@117
   254
        if (p != null) {
jaroslav@117
   255
            return e;
jaroslav@117
   256
        }
jaroslav@117
   257
        return e.getEnclosingElement();
jaroslav@117
   258
    }
jaroslav@490
   259
jaroslav@492
   260
    private static void generateProperties(
jaroslav@492
   261
        Writer w, Property[] properties, Collection<String> props
jaroslav@492
   262
    ) throws IOException {
jaroslav@490
   263
        for (Property p : properties) {
jaroslav@492
   264
            final String tn = typeName(p);
jaroslav@492
   265
            String[] gs = toGetSet(p.name(), tn);
jaroslav@490
   266
jaroslav@490
   267
            w.write("private static " + tn + " prop_" + p.name() + ";\n");
jaroslav@490
   268
            w.write("public static " + tn + " " + gs[0] + "() {\n");
jaroslav@490
   269
            w.write("  return prop_" + p.name() + ";\n");
jaroslav@490
   270
            w.write("}\n");
jaroslav@490
   271
            w.write("public static void " + gs[1] + "(" + tn + " v) {\n");
jaroslav@490
   272
            w.write("  prop_" + p.name() + " = v;\n");
jaroslav@490
   273
            w.write("}\n");
jaroslav@492
   274
            
jaroslav@492
   275
            props.add(p.name());
jaroslav@492
   276
            props.add(gs[2]);
jaroslav@492
   277
            props.add(gs[3]);
jaroslav@490
   278
        }
jaroslav@490
   279
    }
jaroslav@490
   280
jaroslav@492
   281
    private void generateComputedProperties(
jaroslav@492
   282
        Writer w, Collection<? extends Element> arr, Collection<String> props
jaroslav@492
   283
    ) throws IOException {
jaroslav@491
   284
        for (Element e : arr) {
jaroslav@491
   285
            if (e.getKind() != ElementKind.METHOD) {
jaroslav@491
   286
                continue;
jaroslav@491
   287
            }
jaroslav@491
   288
            if (e.getAnnotation(ComputedProperty.class) == null) {
jaroslav@491
   289
                continue;
jaroslav@491
   290
            }
jaroslav@491
   291
            ExecutableElement ee = (ExecutableElement)e;
jaroslav@492
   292
            final String tn = ee.getReturnType().toString();
jaroslav@492
   293
            String[] gs = toGetSet(ee.getSimpleName().toString(), tn);
jaroslav@491
   294
jaroslav@491
   295
            w.write("public static " + tn + " " + gs[0] + "() {\n");
jaroslav@491
   296
            w.write("  return " + e.getEnclosingElement().getSimpleName() + '.' + e.getSimpleName() + "(");
jaroslav@491
   297
            String sep = "";
jaroslav@491
   298
            for (VariableElement pe : ee.getParameters()) {
jaroslav@492
   299
                String[] call = toGetSet(pe.getSimpleName().toString(), pe.asType().toString());
jaroslav@491
   300
                w.write(sep);
jaroslav@491
   301
                w.write(call[0] + "()");
jaroslav@491
   302
                sep = ", ";
jaroslav@491
   303
            }
jaroslav@491
   304
            w.write(");\n");
jaroslav@491
   305
            w.write("}\n");
jaroslav@492
   306
            
jaroslav@492
   307
            props.add(e.getSimpleName().toString());
jaroslav@492
   308
            props.add(gs[2]);
jaroslav@492
   309
            props.add(null);
jaroslav@491
   310
        }
jaroslav@491
   311
    }
jaroslav@491
   312
jaroslav@492
   313
    private static String[] toGetSet(String name, String type) {
jaroslav@491
   314
        String n = Character.toUpperCase(name.charAt(0)) + name.substring(1);
jaroslav@492
   315
        String bck2brwsrType = "L" + type.replace('.', '_') + "_2";
jaroslav@492
   316
        if ("int".equals(type)) {
jaroslav@492
   317
            bck2brwsrType = "I";
jaroslav@492
   318
        }
jaroslav@492
   319
        if ("double".equals(type)) {
jaroslav@492
   320
            bck2brwsrType = "D";
jaroslav@492
   321
        }
jaroslav@492
   322
        String pref = "get";
jaroslav@492
   323
        if ("boolean".equals(type)) {
jaroslav@492
   324
            pref = "is";
jaroslav@492
   325
            bck2brwsrType = "Z";
jaroslav@492
   326
        }
jaroslav@492
   327
        return new String[]{
jaroslav@492
   328
            pref + n, 
jaroslav@492
   329
            "set" + n, 
jaroslav@492
   330
            pref + n + "__" + bck2brwsrType,
jaroslav@492
   331
            "set" + n + "__V" + bck2brwsrType
jaroslav@492
   332
        };
jaroslav@490
   333
    }
jaroslav@490
   334
jaroslav@490
   335
    private static String typeName(Property p) {
jaroslav@490
   336
        try {
jaroslav@490
   337
            return p.type().getName();
jaroslav@490
   338
        } catch (MirroredTypeException ex) {
jaroslav@490
   339
            if (ex.getTypeMirror().getKind().isPrimitive()) {
jaroslav@490
   340
                return ex.getTypeMirror().toString();
jaroslav@490
   341
            }
jaroslav@490
   342
            throw ex;
jaroslav@490
   343
        }
jaroslav@490
   344
    }
jaroslav@26
   345
}