/*
 * Copyright 2005-2016 Sixth and Red River Software, Bas Leijdekkers
 *
 *  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 com.sixrr.stockmetrics.fileTypeMetrics;

import com.intellij.psi.PsiElementVisitor;
import com.intellij.psi.PsiFile;
import com.intellij.psi.PsiRecursiveElementVisitor;
import com.intellij.psi.search.PsiTodoSearchHelper;
import com.sixrr.metrics.MetricCalculator;
import com.sixrr.metrics.MetricType;
import com.sixrr.stockmetrics.i18n.StockMetricsBundle;
import org.jetbrains.annotations.NotNull;

/**
 * @author Bas Leijdekkers
 */
public class TodoCommentCountFileTypeMetric extends FileTypeMetric {

    @NotNull
    @Override
    public String getDisplayName() {
        return StockMetricsBundle.message("number.of.todo.comments.display.name");
    }

    @NotNull
    @Override
    public String getAbbreviation() {
        return StockMetricsBundle.message("number.of.todo.comments.abbreviation");
    }

    @NotNull
    @Override
    public MetricType getType() {
        return MetricType.Count;
    }

    @NotNull
    @Override
    public MetricCalculator createCalculator() {
        return new TodoCommentCountFileTypeCalculator();
    }

    private static class TodoCommentCountFileTypeCalculator extends ElementCountFileTypeCalculator {

        @Override
        protected PsiElementVisitor createVisitor() {
            return new PsiRecursiveElementVisitor() {

                @Override
                public void visitFile(PsiFile file) {
                    super.visitFile(file);
                    final PsiTodoSearchHelper todoSearchHelper =
                            PsiTodoSearchHelper.SERVICE.getInstance(file.getProject());
                    final int count = todoSearchHelper.getTodoItemsCount(file);
                    incrementCount(file, count);
                }
            };
        }
    }
}