/*

 * 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.HashMap;

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 org.openide.DialogDisplayer;

import org.openide.NotifyDescriptor;

import org.openide.filesystems.FileObject;

import org.openide.loaders.DataObject;

import org.openide.util.NbBundle.Messages;

import org.openide.util.lookup.ServiceProvider;

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

/**

 * #207219: {@code DataObject.Registration} conversion.

 *  

 */

@ServiceProvider(service = Hinter.class)

public class DataObjectRegistrationHinter implements Hinter {

    private static final String LOADERS_FOLDER = "Loaders/";

    private static final String FACTORIES_FOLDER = "Factories";

    @Override

    public void process(final Context ctx) throws Exception {

        final FileObject file = ctx.file();

        final Object instanceCreate = ctx.instanceAttribute(file);

        if (instanceCreate == null) {

            return;

        }

        if (file.getPath().startsWith(LOADERS_FOLDER) && file.getPath().contains(FACTORIES_FOLDER)) {

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

                @Override

                public Void call() throws Exception {

                    if (!annotationsAvailable(ctx)) {

                        return null;

                    }

                    ctx.findAndModifyDeclaration(instanceCreate, new RegisterDataObject(ctx));

                    return null;

                }

            });

        }

    }

    @Messages("DataObjectRegistrationHinter.missing_dep=You must add a dependency on org.openide.loaders (7.36+) before using this fix.")

    private boolean annotationsAvailable(Context ctx) {

        if (ctx.canAccess(DataObject.Registration.class.getName()) && ctx.canAccess(DataObject.Registrations.class.getName())) {

            return true;

        } else {

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

            return false;

        }

    }

    private static class RegisterDataObject implements Context.ModifyDeclarationTask {

        private static final String DATAOBJECT_REGISTRATION = "org.openide.loaders.DataObject.Registration";

        private static final String DATAOBJECT_REGISTRATIONS = "org.openide.loaders.DataObject.Registrations";

        private final Context ctx;

        private RegisterDataObject(Context ctx) {

            this.ctx = ctx;

        }

        @Override

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

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

            FileObject file = ctx.file();

            String displayName = ctx.bundlevalue(file.getAttribute("literal:displayName"), declaration); 

            if (displayName == null) {

                displayName = "#TODO";

            }

            // parameter of annotation

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

            params.put("displayName", displayName);

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

            params.put("mimeType", getMimeTypeFromPath(file.getPath()));

            ModifiersTree mt = ctx.addAnnotation(wc, modifiers, DATAOBJECT_REGISTRATION, DATAOBJECT_REGISTRATIONS, params);

            ctx.delete(file);

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

        }

        private String getMimeTypeFromPath(String path) {

            String mimeType = path.replace(LOADERS_FOLDER, "");

            mimeType = mimeType.substring(0, mimeType.indexOf(FACTORIES_FOLDER) - 1);// -1 to remove last file separator

            return mimeType;

        }

    }

}