/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2012 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2012 Sun Microsystems, Inc.

 */

package org.netbeans.modules.apisupport.hints;

import com.sun.source.tree.ModifiersTree;

import java.util.LinkedHashMap;

import java.util.Map;

import java.util.concurrent.Callable;

import javax.lang.model.element.Element;

import org.netbeans.api.java.source.GeneratorUtilities;

import org.netbeans.api.java.source.WorkingCopy;

import static org.netbeans.modules.apisupport.hints.Bundle.*;

import org.openide.DialogDisplayer;

import org.openide.NotifyDescriptor;

import org.openide.filesystems.FileObject;

import org.openide.util.NbBundle.Messages;

import org.openide.util.lookup.ServiceProvider;

@ServiceProvider(service=Hinter.class)

public class NavigatorHinter implements Hinter {

    private static final String PANELS_FOLDER = "Navigator/Panels/";

    private static final String REGISTRATION_BINARY = "org.netbeans.spi.navigator.NavigatorPanel$Registration";

    @Messages("NavigatorHinter.missing_dep=You must be using org.netbeans.spi.navigator 1.22+ before using this fix.")

    @Override public void process(final Context ctx) throws Exception {

        final FileObject file = ctx.file();

        if (!file.getPath().startsWith(PANELS_FOLDER)) {

            return;

        }

        final Object instanceCreate = ctx.instanceAttribute(file);

        if (instanceCreate != null) {

            ctx.addStandardAnnotationHint(new Callable<Void>() {

                public @Override Void call() throws Exception {

                    if (!ctx.canAccess(REGISTRATION_BINARY)) {

                        DialogDisplayer.getDefault().notify(new NotifyDescriptor.Message(NavigatorHinter_missing_dep(), NotifyDescriptor.WARNING_MESSAGE));

                        return null;

                    }

                    ctx.findAndModifyDeclaration(instanceCreate, new Context.ModifyDeclarationTask() {

                        @Override public void run(WorkingCopy wc, Element declaration, ModifiersTree modifiers) throws Exception {

                            Map<String,Object> params = new LinkedHashMap<String,Object>();

                            params.put("mimeType", file.getParent().getPath().substring(PANELS_FOLDER.length()));

                            params.put("position", file.getAttribute("position"));

                            params.put("displayName", "#TODO");

                            String canon = REGISTRATION_BINARY.replace('$', '.');

                            ModifiersTree nue = ctx.addAnnotation(wc, modifiers, canon, canon + "s", params);

                            ctx.delete(file);

                            wc.rewrite(modifiers, GeneratorUtilities.get(wc).importFQNs(nue));

                        }

                    });

                    return null;

                }

            });

        }

    }

}

@NavigatorPanel.Registration(mimeType="text/x-java", position=500, displayName="#LBL_BeanPatterns")

                    <code-name-base>org.netbeans.spi.navigator</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <release-version>1</release-version>

                        <specification-version>1.22</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

@NavigatorPanel.Registrations({

    @NavigatorPanel.Registration(mimeType="image/png", displayName="#Navigator_DisplayName"),

    @NavigatorPanel.Registration(mimeType="image/jpeg", displayName="#Navigator_DisplayName"),

    @NavigatorPanel.Registration(mimeType="image/bmp", displayName="#Navigator_DisplayName"),

    @NavigatorPanel.Registration(mimeType="image/gif", displayName="#Navigator_DisplayName")

})

                        <specification-version>1.22</specification-version>

@NavigatorPanel.Registrations({

    @NavigatorPanel.Registration(mimeType="text/x-java", position=100, displayName="#LBL_members"),

    @NavigatorPanel.Registration(mimeType="application/x-class-file", displayName="#LBL_members")

})

import org.netbeans.modules.maven.api.Constants;

@NavigatorPanel.Registration(mimeType=Constants.POM_MIME_TYPE, position=200, displayName="#POM_NAME")

import org.netbeans.modules.maven.api.Constants;

@NavigatorPanel.Registration(mimeType=Constants.POM_MIME_TYPE, position=100, displayName="#POM_MODEL_NAME")

import org.apache.tools.ant.module.loader.AntProjectDataObject;

@NavigatorPanel.Registration(mimeType=AntProjectDataObject.MIME_TYPE, displayName="#ANP_label")

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2012 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2012 Sun Microsystems, Inc.

 */

package org.netbeans.modules.navigator;

import java.util.Map;

import javax.swing.JComponent;

import org.netbeans.spi.navigator.NavigatorPanel;

import org.netbeans.spi.navigator.NavigatorPanelWithUndo;

import org.openide.awt.UndoRedo;

import org.openide.util.Lookup;

/**

 * Delegating panel for use from {@link NavigatorPanel.Registration}.

 */

public class LazyPanel implements NavigatorPanelWithUndo {

    /**

     * Referenced from generated layer.

     */

    public static NavigatorPanel create(Map<String,?> attrs) {

        return new LazyPanel(attrs);

    }

    private final Map<String,?> attrs;

    private NavigatorPanel delegate;

    private LazyPanel(Map<String,?> attrs) {

        this.attrs = attrs;

    }

    private synchronized NavigatorPanel initialize() {

        if (delegate == null) {

            delegate = (NavigatorPanel) attrs.get("delegate");

        }

        return delegate;

    }

    @Override public String getDisplayName() {

        if (delegate != null) {

            return delegate.getDisplayName();

        } else {

            return (String) attrs.get("displayName");

        }

    }

    @Override public String getDisplayHint() {

        if (delegate != null) {

            return delegate.getDisplayHint();

        } else { // unused currently, so no separate attr

            return (String) attrs.get("displayName");

        }

    }

    @Override public JComponent getComponent() {

        return initialize().getComponent();

    }

    @Override public void panelActivated(Lookup context) {

        initialize().panelActivated(context);

    }

    @Override public void panelDeactivated() {

        initialize().panelDeactivated();

    }

    @Override public Lookup getLookup() {

        return initialize().getLookup();

    }

    @Override public UndoRedo getUndoRedo() {

        NavigatorPanel p = initialize();

        return p instanceof NavigatorPanelWithUndo ? ((NavigatorPanelWithUndo) p).getUndoRedo() : UndoRedo.NONE;

    }

}

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2012 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2012 Sun Microsystems, Inc.

 */

package org.netbeans.modules.navigator;

import java.util.Arrays;

import java.util.HashSet;

import java.util.Set;

import javax.annotation.processing.Processor;

import javax.annotation.processing.RoundEnvironment;

import javax.annotation.processing.SupportedSourceVersion;

import javax.lang.model.SourceVersion;

import javax.lang.model.element.Element;

import javax.lang.model.element.TypeElement;

import org.netbeans.spi.navigator.NavigatorPanel;

import org.openide.filesystems.annotations.LayerGeneratingProcessor;

import org.openide.filesystems.annotations.LayerGenerationException;

import org.openide.util.lookup.ServiceProvider;

@ServiceProvider(service=Processor.class)

@SupportedSourceVersion(SourceVersion.RELEASE_6)

public class NavigatorPanelRegistrationProcessor extends LayerGeneratingProcessor {

    @Override public Set<String> getSupportedAnnotationTypes() {

        return new HashSet<String>(Arrays.asList(NavigatorPanel.Registration.class.getCanonicalName(), NavigatorPanel.Registrations.class.getCanonicalName()));

    }

    @Override protected boolean handleProcess(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) throws LayerGenerationException {

        if (roundEnv.processingOver()) {

            return false;

        }

        for (Element e : roundEnv.getElementsAnnotatedWith(NavigatorPanel.Registration.class)) {

            NavigatorPanel.Registration r = e.getAnnotation(NavigatorPanel.Registration.class);

            if (r == null) {

                continue;

            }

            register(e, r);

        }

        for (Element e : roundEnv.getElementsAnnotatedWith(NavigatorPanel.Registrations.class)) {

            NavigatorPanel.Registrations rr = e.getAnnotation(NavigatorPanel.Registrations.class);

            if (rr == null) {

                continue;

            }

            for (NavigatorPanel.Registration r : rr.value()) {

                register(e, r);

            }

        }

        return true;

    }

    private void register(Element e, NavigatorPanel.Registration r) throws LayerGenerationException {

        String suffix = layer(e).instanceFile("dummy", null, null, r, null).getPath().substring("dummy".length()); // e.g. /my-Panel.instance

        layer(e).file(ProviderRegistry.PANELS_FOLDER + r.mimeType() + suffix).

                methodvalue("instanceCreate", LazyPanel.class.getName(), "create").

                instanceAttribute("delegate", NavigatorPanel.class, r, null).

                position(r.position()).

                bundlevalue("displayName", r.displayName()).

                write();

    }

}

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

    /**

     * Registers a navigator panel.

     * @since 1.22

     */

    @Target({ElementType.TYPE, ElementType.METHOD})

    @Retention(RetentionPolicy.SOURCE)

    @interface Registration {

        /**

         * MIME type to register under.

         * For example: {@code text/javascript}

         */

        String mimeType();

        /**

         * Optional position for this panel among others of the same type.

         */

        int position() default Integer.MAX_VALUE;

        /**

         * Label for this view to be used in a switcher UI.

         * Will be replaced with {@link NavigatorPanel#getDisplayName}

         * if and when the panel is actually shown.

         * May use {@code pkg.Bundle#key} or {@code #key} syntax.

         */

        String displayName();

    }

@NavigatorPanel.Registration(mimeType="text/plain", displayName="Dummy View")