javaquery/api/src/main/java/org/apidesign/bck2brwsr/htmlpage/PageProcessor.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Fri, 09 Nov 2012 11:47:00 +0100
changeset 140 590958fcb7d7
parent 124 htmlpage/src/main/java/org/apidesign/bck2brwsr/htmlpage/PageProcessor.java@a5f8cb32549e
child 435 fb4ed6cc0d4b
child 463 3641fd0663d3
permissions -rw-r--r--
Moving the htmlpage API into a submodule in preparation of adding in an example of its usage
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@117
    25
import java.util.Collections;
jaroslav@117
    26
import java.util.List;
jaroslav@26
    27
import java.util.Locale;
jaroslav@26
    28
import java.util.Set;
jaroslav@26
    29
import javax.annotation.processing.AbstractProcessor;
jaroslav@117
    30
import javax.annotation.processing.Completion;
jaroslav@117
    31
import javax.annotation.processing.Completions;
jaroslav@26
    32
import javax.annotation.processing.Processor;
jaroslav@26
    33
import javax.annotation.processing.RoundEnvironment;
jaroslav@26
    34
import javax.annotation.processing.SupportedAnnotationTypes;
jaroslav@117
    35
import javax.lang.model.element.AnnotationMirror;
jaroslav@26
    36
import javax.lang.model.element.Element;
jaroslav@28
    37
import javax.lang.model.element.ElementKind;
jaroslav@28
    38
import javax.lang.model.element.ExecutableElement;
jaroslav@28
    39
import javax.lang.model.element.Modifier;
jaroslav@26
    40
import javax.lang.model.element.PackageElement;
jaroslav@26
    41
import javax.lang.model.element.TypeElement;
jaroslav@124
    42
import javax.lang.model.type.TypeMirror;
jaroslav@26
    43
import javax.tools.Diagnostic;
jaroslav@26
    44
import javax.tools.FileObject;
jaroslav@26
    45
import javax.tools.StandardLocation;
jaroslav@28
    46
import org.apidesign.bck2brwsr.htmlpage.api.OnClick;
jaroslav@26
    47
import org.apidesign.bck2brwsr.htmlpage.api.Page;
jaroslav@26
    48
import org.openide.util.lookup.ServiceProvider;
jaroslav@26
    49
jaroslav@26
    50
/** Annotation processor to process an XHTML page and generate appropriate 
jaroslav@26
    51
 * "id" file.
jaroslav@26
    52
 *
jaroslav@26
    53
 * @author Jaroslav Tulach <jtulach@netbeans.org>
jaroslav@26
    54
 */
jaroslav@26
    55
@ServiceProvider(service=Processor.class)
jaroslav@28
    56
@SupportedAnnotationTypes({
jaroslav@28
    57
    "org.apidesign.bck2brwsr.htmlpage.api.Page",
jaroslav@28
    58
    "org.apidesign.bck2brwsr.htmlpage.api.OnClick"
jaroslav@28
    59
})
jaroslav@26
    60
public final class PageProcessor extends AbstractProcessor {
jaroslav@26
    61
    @Override
jaroslav@26
    62
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
jaroslav@26
    63
        for (Element e : roundEnv.getElementsAnnotatedWith(Page.class)) {
jaroslav@26
    64
            Page p = e.getAnnotation(Page.class);
jaroslav@100
    65
            PackageElement pe = (PackageElement)e.getEnclosingElement();
jaroslav@26
    66
            String pkg = pe.getQualifiedName().toString();
jaroslav@26
    67
            
jaroslav@26
    68
            ProcessPage pp;
jaroslav@26
    69
            try {
jaroslav@26
    70
                InputStream is = openStream(pkg, p.xhtml());
jaroslav@26
    71
                pp = ProcessPage.readPage(is);
jaroslav@26
    72
                is.close();
jaroslav@26
    73
            } catch (IOException iOException) {
jaroslav@26
    74
                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't read " + p.xhtml(), e);
jaroslav@26
    75
                return false;
jaroslav@26
    76
            }
jaroslav@26
    77
            Writer w;
jaroslav@108
    78
            String className = p.className();
jaroslav@108
    79
            if (className.isEmpty()) {
jaroslav@108
    80
                int indx = p.xhtml().indexOf('.');
jaroslav@108
    81
                className = p.xhtml().substring(0, indx);
jaroslav@108
    82
            }
jaroslav@26
    83
            try {
jaroslav@108
    84
                FileObject java = processingEnv.getFiler().createSourceFile(pkg + '.' + className, e);
jaroslav@26
    85
                w = new OutputStreamWriter(java.openOutputStream());
jaroslav@28
    86
                try {
jaroslav@28
    87
                    w.append("package " + pkg + ";\n");
jaroslav@28
    88
                    w.append("import org.apidesign.bck2brwsr.htmlpage.api.*;\n");
jaroslav@108
    89
                    w.append("class ").append(className).append(" {\n");
jaroslav@28
    90
                    for (String id : pp.ids()) {
jaroslav@28
    91
                        String tag = pp.tagNameForId(id);
jaroslav@28
    92
                        String type = type(tag);
jaroslav@28
    93
                        w.append("  ").append("public static final ").
jaroslav@28
    94
                            append(type).append(' ').append(cnstnt(id)).append(" = new ").
jaroslav@28
    95
                            append(type).append("(\"").append(id).append("\");\n");
jaroslav@28
    96
                    }
jaroslav@28
    97
                    w.append("  static {\n");
jaroslav@28
    98
                    if (!initializeOnClick(pe, w, pp)) {
jaroslav@28
    99
                        return false;
jaroslav@28
   100
                    }
jaroslav@28
   101
                    w.append("  }\n");
jaroslav@28
   102
                    w.append("}\n");
jaroslav@28
   103
                } finally {
jaroslav@28
   104
                    w.close();
jaroslav@26
   105
                }
jaroslav@26
   106
            } catch (IOException ex) {
jaroslav@108
   107
                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
jaroslav@26
   108
                return false;
jaroslav@26
   109
            }
jaroslav@26
   110
        }
jaroslav@26
   111
        return true;
jaroslav@26
   112
    }
jaroslav@26
   113
jaroslav@26
   114
    private InputStream openStream(String pkg, String name) throws IOException {
jaroslav@26
   115
        try {
jaroslav@107
   116
            FileObject fo = processingEnv.getFiler().getResource(
jaroslav@107
   117
                StandardLocation.SOURCE_PATH, pkg, name);
jaroslav@26
   118
            return fo.openInputStream();
jaroslav@26
   119
        } catch (IOException ex) {
jaroslav@26
   120
            return processingEnv.getFiler().getResource(StandardLocation.CLASS_OUTPUT, pkg, name).openInputStream();
jaroslav@26
   121
        }
jaroslav@26
   122
    }
jaroslav@26
   123
jaroslav@26
   124
    private static String type(String tag) {
jaroslav@26
   125
        if (tag.equals("title")) {
jaroslav@26
   126
            return "Title";
jaroslav@26
   127
        }
jaroslav@26
   128
        if (tag.equals("button")) {
jaroslav@26
   129
            return "Button";
jaroslav@26
   130
        }
jaroslav@26
   131
        if (tag.equals("input")) {
jaroslav@26
   132
            return "Input";
jaroslav@26
   133
        }
jaroslav@26
   134
        return "Element";
jaroslav@26
   135
    }
jaroslav@26
   136
jaroslav@26
   137
    private static String cnstnt(String id) {
jaroslav@26
   138
        return id.toUpperCase(Locale.ENGLISH).replace('.', '_');
jaroslav@26
   139
    }
jaroslav@28
   140
jaroslav@28
   141
    private boolean initializeOnClick(PackageElement pe, Writer w, ProcessPage pp) throws IOException {
jaroslav@124
   142
        TypeMirror stringType = processingEnv.getElementUtils().getTypeElement("java.lang.String").asType();
jaroslav@28
   143
        for (Element clazz : pe.getEnclosedElements()) {
jaroslav@28
   144
            if (clazz.getKind() != ElementKind.CLASS) {
jaroslav@28
   145
                continue;
jaroslav@28
   146
            }
jaroslav@28
   147
            TypeElement type = (TypeElement)clazz;
jaroslav@28
   148
            for (Element method : clazz.getEnclosedElements()) {
jaroslav@28
   149
                OnClick oc = method.getAnnotation(OnClick.class);
jaroslav@28
   150
                if (oc != null) {
jaroslav@124
   151
                    for (String id : oc.id()) {
jaroslav@124
   152
                        if (pp.tagNameForId(id) == null) {
jaroslav@124
   153
                            processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "id = " + oc.id() + " does not exist in the HTML page. Found only " + pp.ids(), method);
jaroslav@124
   154
                            return false;
jaroslav@124
   155
                        }
jaroslav@124
   156
                        ExecutableElement ee = (ExecutableElement)method;
jaroslav@124
   157
                        boolean hasParam;
jaroslav@124
   158
                        if (ee.getParameters().isEmpty()) {
jaroslav@124
   159
                            hasParam = false;
jaroslav@124
   160
                        } else {
jaroslav@124
   161
                            if (ee.getParameters().size() != 1 || ee.getParameters().get(0).asType() != stringType) {
jaroslav@124
   162
                                processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@OnClick method should either have no arguments or one String argument", ee);
jaroslav@124
   163
                                return false;
jaroslav@124
   164
                            }
jaroslav@124
   165
                            hasParam = true;
jaroslav@124
   166
                        }
jaroslav@124
   167
                        if (!ee.getModifiers().contains(Modifier.STATIC)) {
jaroslav@124
   168
                            processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@OnClick method has to be static", ee);
jaroslav@124
   169
                            return false;
jaroslav@124
   170
                        }
jaroslav@124
   171
                        if (ee.getModifiers().contains(Modifier.PRIVATE)) {
jaroslav@124
   172
                            processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@OnClick method can't be private", ee);
jaroslav@124
   173
                            return false;
jaroslav@124
   174
                        }
jaroslav@124
   175
                        w.append("  ").append(cnstnt(id)).
jaroslav@124
   176
                            append(".addOnClick(new Runnable() { public void run() {\n");
jaroslav@124
   177
                        w.append("    ").append(type.getSimpleName().toString()).
jaroslav@124
   178
                            append('.').append(ee.getSimpleName()).append("(");
jaroslav@124
   179
                        if (hasParam) {
jaroslav@124
   180
                            w.append("\"").append(id).append("\"");
jaroslav@124
   181
                        }
jaroslav@124
   182
                        w.append(");\n");
jaroslav@124
   183
                        w.append("  }});\n");
jaroslav@124
   184
                    }           
jaroslav@28
   185
                }
jaroslav@28
   186
            }
jaroslav@28
   187
        }
jaroslav@28
   188
        return true;
jaroslav@28
   189
    }
jaroslav@117
   190
jaroslav@117
   191
    @Override
jaroslav@117
   192
    public Iterable<? extends Completion> getCompletions(
jaroslav@117
   193
        Element element, AnnotationMirror annotation, 
jaroslav@117
   194
        ExecutableElement member, String userText
jaroslav@117
   195
    ) {
jaroslav@117
   196
        if (!userText.startsWith("\"")) {
jaroslav@117
   197
            return Collections.emptyList();
jaroslav@117
   198
        }
jaroslav@117
   199
        
jaroslav@117
   200
        Element cls = findClass(element);
jaroslav@117
   201
        Page p = cls.getAnnotation(Page.class);
jaroslav@117
   202
        PackageElement pe = (PackageElement) cls.getEnclosingElement();
jaroslav@117
   203
        String pkg = pe.getQualifiedName().toString();
jaroslav@117
   204
        ProcessPage pp;
jaroslav@117
   205
        try {
jaroslav@117
   206
            InputStream is = openStream(pkg, p.xhtml());
jaroslav@117
   207
            pp = ProcessPage.readPage(is);
jaroslav@117
   208
            is.close();
jaroslav@117
   209
        } catch (IOException iOException) {
jaroslav@117
   210
            return Collections.emptyList();
jaroslav@117
   211
        }
jaroslav@117
   212
        
jaroslav@117
   213
        List<Completion> cc = new ArrayList<Completion>();
jaroslav@117
   214
        userText = userText.substring(1);
jaroslav@117
   215
        for (String id : pp.ids()) {
jaroslav@117
   216
            if (id.startsWith(userText)) {
jaroslav@117
   217
                cc.add(Completions.of("\"" + id + "\"", id));
jaroslav@117
   218
            }
jaroslav@117
   219
        }
jaroslav@117
   220
        return cc;
jaroslav@117
   221
    }
jaroslav@117
   222
    
jaroslav@117
   223
    private static Element findClass(Element e) {
jaroslav@117
   224
        if (e == null) {
jaroslav@117
   225
            return null;
jaroslav@117
   226
        }
jaroslav@117
   227
        Page p = e.getAnnotation(Page.class);
jaroslav@117
   228
        if (p != null) {
jaroslav@117
   229
            return e;
jaroslav@117
   230
        }
jaroslav@117
   231
        return e.getEnclosingElement();
jaroslav@117
   232
    }
jaroslav@26
   233
}