org.netbeans.modules.sendopts.OptionAnnotationProcessorImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org-netbeans-modules-sendopts Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.netbeans.modules.sendopts;

import java.util.HashSet;
import java.util.Set;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.element.*;
import javax.lang.model.type.ArrayType;
import javax.lang.model.type.PrimitiveType;
import javax.lang.model.type.TypeKind;
import javax.lang.model.type.TypeMirror;
import org.netbeans.spi.sendopts.Arg;
import org.netbeans.spi.sendopts.Description;
import org.netbeans.spi.sendopts.Option;
import org.netbeans.spi.sendopts.OptionProcessor;
import org.openide.filesystems.annotations.LayerBuilder.File;
import org.openide.filesystems.annotations.LayerGeneratingProcessor;
import org.openide.filesystems.annotations.LayerGenerationException;

/**
 *
 * @author Jaroslav Tulach 
 */
final class OptionAnnotationProcessorImpl extends LayerGeneratingProcessor {

    @Override
    public Set getSupportedAnnotationTypes() {
        Set set = new HashSet();
        set.add(Arg.class.getName());
        return set;
    }

    @Override
    protected boolean handleProcess(Set annotations, RoundEnvironment roundEnv) throws LayerGenerationException {
        PrimitiveType boolType = processingEnv.getTypeUtils().getPrimitiveType(TypeKind.BOOLEAN);
        TypeMirror stringType = processingEnv.getElementUtils().getTypeElement("java.lang.String").asType();
        ArrayType stringArray = processingEnv.getTypeUtils().getArrayType(stringType);

        Set processors = new HashSet();
        for (Element e : roundEnv.getElementsAnnotatedWith(Arg.class)) {
            if (e.getModifiers().contains(Modifier.STATIC)) {
                throw new LayerGenerationException("@Arg can be applied only to non-static fields", e);
            }
            if (!e.getModifiers().contains(Modifier.PUBLIC)) {
                throw new LayerGenerationException("@Arg can be applied only to public fields", e);
            }
            if (e.getModifiers().contains(Modifier.FINAL)) {
                throw new LayerGenerationException("@Arg can be applied only to non-final fields", e);
            }
            Arg arg = e.getAnnotation(Arg.class);
            if (arg.longName().isEmpty() && arg.shortName() == Option.NO_SHORT_NAME) {
                throw new LayerGenerationException("At least one of longName or shortName attributes needs to be non-empty", e);
            }
            if (arg.implicit() && !e.asType().equals(stringArray)) {
                throw new LayerGenerationException("implicit @Arg can only be applied to String[] fields", e);
            }
            
            processors.add(TypeElement.class.cast(e.getEnclosingElement()));
        }
        
        for (TypeElement te : processors) {
            int cnt = 1;
            final String typeName = processingEnv.getElementUtils().getBinaryName(te).toString().replace('.', '-');
            File f = layer(te).file("Services/OptionProcessors/" + typeName + ".instance");
            f.methodvalue("instanceCreate", DefaultProcessor.class.getName(), "create");
            f.stringvalue("instanceOf", OptionProcessor.class.getName());
            f.stringvalue("class", processingEnv.getElementUtils().getBinaryName(te).toString());
            for (Element e : te.getEnclosedElements()) {
                Arg o = e.getAnnotation(Arg.class);
                if (o == null) {
                    continue;
                }
                Description d = e.getAnnotation(Description.class);

                if (o.shortName() != Option.NO_SHORT_NAME) {
                    f.charvalue(cnt + ".shortName", o.shortName());
                }
                if (!o.longName().isEmpty()) {
                    f.stringvalue(cnt + ".longName", o.longName());
                }
                if (boolType == e.asType()) {
                    f.stringvalue(cnt + ".type", "withoutArgument");
                } else if (stringType == e.asType()) {
                    if (o.defaultValue().equals("\u0000")) {
                        f.stringvalue(cnt + ".type", "requiredArgument");
                    } else {
                        f.stringvalue(cnt + ".type", "optionalArgument");
                    }
                } else {
                    if (!stringArray.equals(e.asType())) {
                        throw new LayerGenerationException("Field type has to be either boolean, String or String[]!", e);
                    }
                    f.stringvalue(cnt + ".type", "additionalArguments");
                }
                if (o.implicit()) {
                    f.boolvalue(cnt + ".implicit", true);
                }
                if (d != null) {
                    writeBundle(f, cnt + ".displayName", d.displayName(), e);
                    writeBundle(f, cnt + ".shortDescription", d.shortDescription(), e);
                }
                cnt++;
            }            
            f.write();
        }
        return true;
    }

    private void writeBundle(File f, String key, String value, Element e) throws LayerGenerationException {
        if (value.isEmpty()) {
            return;
        }
        // test first; note that cannot call bundlevalue on f since its originatingElement is wrong
        layer(e).file("dummy/file").bundlevalue(key, value);
        
        if (value.startsWith("#")) {
            Element referenceElement = e;
            while (referenceElement != null && referenceElement.getKind() != ElementKind.PACKAGE) {
                referenceElement = referenceElement.getEnclosingElement();
            }
            if (referenceElement == null) {
                throw new LayerGenerationException("No reference element to determine package in '" + value + "'", e);
            }
            value = ((PackageElement) referenceElement).getQualifiedName() + ".Bundle" + value;
        }
        
        f.stringvalue(key, value);
    }
}