htmlpage/src/main/java/org/apidesign/bck2brwsr/htmlpage/PageProcessor.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Mon, 29 Oct 2012 13:05:56 +0100
changeset 117 02618d8bec44
parent 108 7e3f72897a83
child 124 a5f8cb32549e
permissions -rw-r--r--
Code completion for the ids in the XHTML page
     1 /**
     2  * Back 2 Browser Bytecode Translator
     3  * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
     4  *
     5  * This program is free software: you can redistribute it and/or modify
     6  * it under the terms of the GNU General Public License as published by
     7  * the Free Software Foundation, version 2 of the License.
     8  *
     9  * This program is distributed in the hope that it will be useful,
    10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    12  * GNU General Public License for more details.
    13  *
    14  * You should have received a copy of the GNU General Public License
    15  * along with this program. Look for COPYING file in the top folder.
    16  * If not, see http://opensource.org/licenses/GPL-2.0.
    17  */
    18 package org.apidesign.bck2brwsr.htmlpage;
    19 
    20 import java.io.IOException;
    21 import java.io.InputStream;
    22 import java.io.OutputStreamWriter;
    23 import java.io.Writer;
    24 import java.util.ArrayList;
    25 import java.util.Collections;
    26 import java.util.List;
    27 import java.util.Locale;
    28 import java.util.Set;
    29 import javax.annotation.processing.AbstractProcessor;
    30 import javax.annotation.processing.Completion;
    31 import javax.annotation.processing.Completions;
    32 import javax.annotation.processing.Processor;
    33 import javax.annotation.processing.RoundEnvironment;
    34 import javax.annotation.processing.SupportedAnnotationTypes;
    35 import javax.lang.model.element.AnnotationMirror;
    36 import javax.lang.model.element.Element;
    37 import javax.lang.model.element.ElementKind;
    38 import javax.lang.model.element.ExecutableElement;
    39 import javax.lang.model.element.Modifier;
    40 import javax.lang.model.element.PackageElement;
    41 import javax.lang.model.element.TypeElement;
    42 import javax.tools.Diagnostic;
    43 import javax.tools.FileObject;
    44 import javax.tools.StandardLocation;
    45 import org.apidesign.bck2brwsr.htmlpage.api.OnClick;
    46 import org.apidesign.bck2brwsr.htmlpage.api.Page;
    47 import org.openide.util.lookup.ServiceProvider;
    48 
    49 /** Annotation processor to process an XHTML page and generate appropriate 
    50  * "id" file.
    51  *
    52  * @author Jaroslav Tulach <jtulach@netbeans.org>
    53  */
    54 @ServiceProvider(service=Processor.class)
    55 @SupportedAnnotationTypes({
    56     "org.apidesign.bck2brwsr.htmlpage.api.Page",
    57     "org.apidesign.bck2brwsr.htmlpage.api.OnClick"
    58 })
    59 public final class PageProcessor extends AbstractProcessor {
    60     @Override
    61     public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
    62         for (Element e : roundEnv.getElementsAnnotatedWith(Page.class)) {
    63             Page p = e.getAnnotation(Page.class);
    64             PackageElement pe = (PackageElement)e.getEnclosingElement();
    65             String pkg = pe.getQualifiedName().toString();
    66             
    67             ProcessPage pp;
    68             try {
    69                 InputStream is = openStream(pkg, p.xhtml());
    70                 pp = ProcessPage.readPage(is);
    71                 is.close();
    72             } catch (IOException iOException) {
    73                 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't read " + p.xhtml(), e);
    74                 return false;
    75             }
    76             Writer w;
    77             String className = p.className();
    78             if (className.isEmpty()) {
    79                 int indx = p.xhtml().indexOf('.');
    80                 className = p.xhtml().substring(0, indx);
    81             }
    82             try {
    83                 FileObject java = processingEnv.getFiler().createSourceFile(pkg + '.' + className, e);
    84                 w = new OutputStreamWriter(java.openOutputStream());
    85                 try {
    86                     w.append("package " + pkg + ";\n");
    87                     w.append("import org.apidesign.bck2brwsr.htmlpage.api.*;\n");
    88                     w.append("class ").append(className).append(" {\n");
    89                     for (String id : pp.ids()) {
    90                         String tag = pp.tagNameForId(id);
    91                         String type = type(tag);
    92                         w.append("  ").append("public static final ").
    93                             append(type).append(' ').append(cnstnt(id)).append(" = new ").
    94                             append(type).append("(\"").append(id).append("\");\n");
    95                     }
    96                     w.append("  static {\n");
    97                     if (!initializeOnClick(pe, w, pp)) {
    98                         return false;
    99                     }
   100                     w.append("  }\n");
   101                     w.append("}\n");
   102                 } finally {
   103                     w.close();
   104                 }
   105             } catch (IOException ex) {
   106                 processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "Can't create " + className + ".java", e);
   107                 return false;
   108             }
   109         }
   110         return true;
   111     }
   112 
   113     private InputStream openStream(String pkg, String name) throws IOException {
   114         try {
   115             FileObject fo = processingEnv.getFiler().getResource(
   116                 StandardLocation.SOURCE_PATH, pkg, name);
   117             return fo.openInputStream();
   118         } catch (IOException ex) {
   119             return processingEnv.getFiler().getResource(StandardLocation.CLASS_OUTPUT, pkg, name).openInputStream();
   120         }
   121     }
   122 
   123     private static String type(String tag) {
   124         if (tag.equals("title")) {
   125             return "Title";
   126         }
   127         if (tag.equals("button")) {
   128             return "Button";
   129         }
   130         if (tag.equals("input")) {
   131             return "Input";
   132         }
   133         return "Element";
   134     }
   135 
   136     private static String cnstnt(String id) {
   137         return id.toUpperCase(Locale.ENGLISH).replace('.', '_');
   138     }
   139 
   140     private boolean initializeOnClick(PackageElement pe, Writer w, ProcessPage pp) throws IOException {
   141         for (Element clazz : pe.getEnclosedElements()) {
   142             if (clazz.getKind() != ElementKind.CLASS) {
   143                 continue;
   144             }
   145             TypeElement type = (TypeElement)clazz;
   146             for (Element method : clazz.getEnclosedElements()) {
   147                 OnClick oc = method.getAnnotation(OnClick.class);
   148                 if (oc != null) {
   149                     if (pp.tagNameForId(oc.id()) == null) {
   150                         processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "id = " + oc.id() + " does not exist in the HTML page. Found only " + pp.ids(), method);
   151                         return false;
   152                     }
   153                     ExecutableElement ee = (ExecutableElement)method;
   154                     if (!ee.getParameters().isEmpty()) {
   155                         processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@OnClose method can't take arguments", ee);
   156                         return false;
   157                     }
   158                     if (!ee.getModifiers().contains(Modifier.STATIC)) {
   159                         processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@OnClose method has to be static", ee);
   160                         return false;
   161                     }
   162                     if (ee.getModifiers().contains(Modifier.PRIVATE)) {
   163                         processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "@OnClose method can't be private", ee);
   164                         return false;
   165                     }
   166                     w.append("  ").append(cnstnt(oc.id())).
   167                         append(".addOnClick(new Runnable() { public void run() {\n");
   168                     w.append("    ").append(type.getSimpleName().toString()).
   169                         append('.').append(ee.getSimpleName()).append("();\n");
   170                     w.append("  }});\n");
   171                 }
   172             }
   173         }
   174         return true;
   175     }
   176 
   177     @Override
   178     public Iterable<? extends Completion> getCompletions(
   179         Element element, AnnotationMirror annotation, 
   180         ExecutableElement member, String userText
   181     ) {
   182         if (!userText.startsWith("\"")) {
   183             return Collections.emptyList();
   184         }
   185         
   186         Element cls = findClass(element);
   187         Page p = cls.getAnnotation(Page.class);
   188         PackageElement pe = (PackageElement) cls.getEnclosingElement();
   189         String pkg = pe.getQualifiedName().toString();
   190         ProcessPage pp;
   191         try {
   192             InputStream is = openStream(pkg, p.xhtml());
   193             pp = ProcessPage.readPage(is);
   194             is.close();
   195         } catch (IOException iOException) {
   196             return Collections.emptyList();
   197         }
   198         
   199         List<Completion> cc = new ArrayList<Completion>();
   200         userText = userText.substring(1);
   201         for (String id : pp.ids()) {
   202             if (id.startsWith(userText)) {
   203                 cc.add(Completions.of("\"" + id + "\"", id));
   204             }
   205         }
   206         return cc;
   207     }
   208     
   209     private static Element findClass(Element e) {
   210         if (e == null) {
   211             return null;
   212         }
   213         Page p = e.getAnnotation(Page.class);
   214         if (p != null) {
   215             return e;
   216         }
   217         return e.getEnclosingElement();
   218     }
   219 }