/*
 * Copyright 2013-2016 Grzegorz Ligas <ligasgr@gmail.com> and other contributors
 * (see the CONTRIBUTORS file).
 *
 * Licensed 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.intellij.xquery.inspection.namespace;

import com.intellij.codeInspection.InspectionManager;
import com.intellij.codeInspection.LocalInspectionTool;
import com.intellij.codeInspection.ProblemDescriptor;
import com.intellij.psi.PsiFile;
import org.intellij.xquery.inspection.imports.UnusedNamespaceSourceFinder;
import org.intellij.xquery.psi.XQueryFile;
import org.intellij.xquery.psi.XQueryNamespaceDecl;
import org.jetbrains.annotations.NotNull;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import static com.intellij.codeInspection.ProblemHighlightType.LIKE_UNUSED_SYMBOL;

public class UnusedNamespaceDeclarationInspection extends LocalInspectionTool {

    public static final String UNUSED_NAMESPACE_DECLARATION = "Unused namespace declaration";
    public static final String REMOVE_UNUSED_NAMESPACE_DECLARATION_QUICKFIX_NAME = "Remove unused namespace declaration";

    private final UnusedNamespaceSourceFinder<XQueryNamespaceDecl> unusedNamespaceDeclarationsFinder = new UnusedNamespaceSourceFinder<XQueryNamespaceDecl>() {
        @NotNull
        @Override
        protected Collection<XQueryNamespaceDecl> getAllNamespaceSources(XQueryFile xQueryFile) {
            return xQueryFile.getNamespaceDeclarations();
        }
    };

    @Override
    public ProblemDescriptor[] checkFile(PsiFile file, InspectionManager manager, boolean isOnTheFly) {
        if (!(file instanceof XQueryFile)) {
            return null;
        }
        List<ProblemDescriptor> problems = getUnusedNamespaceDeclarationProblems((XQueryFile) file, manager);
        return problems.toArray(new ProblemDescriptor[problems.size()]);
    }

    private List<ProblemDescriptor> getUnusedNamespaceDeclarationProblems(XQueryFile xQueryFile, InspectionManager manager) {
        Collection<XQueryNamespaceDecl> unusedNamespaceDeclarations = unusedNamespaceDeclarationsFinder.getUnusedNamespaceSources(xQueryFile);
        List<ProblemDescriptor> problems = new ArrayList<ProblemDescriptor>();
        for (XQueryNamespaceDecl unused : unusedNamespaceDeclarations) {
            problems.add(manager.createProblemDescriptor(unused, UNUSED_NAMESPACE_DECLARATION,
                    new RemoveElementQuickFix(REMOVE_UNUSED_NAMESPACE_DECLARATION_QUICKFIX_NAME),
                    LIKE_UNUSED_SYMBOL, true));
        }

        return problems;
    }
}