com.xenoamess.p3c.pmd.lang.java.util.ViolationUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of p3c-pmd Show documentation
Alibaba Java Coding Guidelines PMD implementations(XenoAmess TPM)
There is a newer version: 2.2.1.0x
/*
 * Copyright 1999-2017 Alibaba Group.
 *
 * 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.xenoamess.p3c.pmd.lang.java.util;

import com.xenoamess.p3c.pmd.lang.java.util.namelist.NameListConfig;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.java.ast.ASTCompilationUnit;
import net.sourceforge.pmd.lang.java.ast.ASTFieldDeclaration;
import net.sourceforge.pmd.lang.java.ast.ASTMethodDeclaration;
import net.sourceforge.pmd.lang.java.ast.ASTMethodDeclarator;
import net.sourceforge.pmd.lang.java.ast.ASTVariableDeclaratorId;
import net.sourceforge.pmd.lang.java.symboltable.ClassScope;
import net.sourceforge.pmd.lang.rule.AbstractRule;
import net.sourceforge.pmd.lang.symboltable.Scope;
import net.sourceforge.pmd.lang.symboltable.ScopedNode;
import org.jetbrains.annotations.Nullable;

/**
 * @author caikang
 * @date 2017/01/14
 */
public class ViolationUtils {
    public static void addViolationWithPrecisePosition(AbstractRule rule, Node node, Object data) {
        addViolationWithPrecisePosition(rule, node, data, null);
    }

    public static void addViolationWithPrecisePosition(AbstractRule rule, Node node, Object data,
                                                       String message) {
        if (shouldIgnoreViolation(rule.getClass(), node)) {
            return;
        }

        if (node instanceof ASTFieldDeclaration) {
            ASTVariableDeclaratorId variableDeclaratorId = node.getFirstDescendantOfType(ASTVariableDeclaratorId.class);
            addViolation(rule, variableDeclaratorId, data, message);
            return;
        }
        if (node instanceof ASTMethodDeclaration) {
            ASTMethodDeclarator declarator = node.getFirstChildOfType(ASTMethodDeclarator.class);
            addViolation(rule, declarator, data, message);
            return;
        }
        addViolation(rule, node, data, message);
    }

    private static void addViolation(AbstractRule rule, Node node, Object data, String message) {
        if (message == null) {
            rule.addViolation(data, node);
        } else {
            rule.addViolationWithMessage(data, node, message);
        }
    }

    public static boolean shouldIgnoreViolation(Class ruleClass, Node node) {
        if (NameListConfig.getNameListService().ifRuleClassInRuleBlackList(ruleClass)) {
            return true;
        }

        ASTCompilationUnit nodeRoot = getNodeRoot(node);
        if (nodeRoot != null) {
            String packageName = nodeRoot.getPackageName();
            if (NameListConfig.getNameListService().ifPackageNameInPackageBlackList(packageName)) {
                return true;
            }
        }

        if (node instanceof ScopedNode) {
            ScopedNode scopedNode = (ScopedNode) node;
            Scope scope = scopedNode.getScope();
            while (scope != null && !(scope instanceof ClassScope)) {
                scope = scope.getParent();
            }
            if (scope != null) {
                String className = ((ClassScope) scope).getClassName();
                if (NameListConfig.getNameListService().ifClassNameInClassBlackList(className)) {
                    return true;
                }
                return NameListConfig.getNameListService().ifRuleClassNameClassNamePairInPairIgnoreList(ruleClass,
                        className);
            }
        }

        return false;
    }

    @Nullable
    private static ASTCompilationUnit getNodeRoot(@Nullable Node node) {
        while (node != null) {
            if (node instanceof ASTCompilationUnit) {
                return (ASTCompilationUnit) node;
            }
            node = node.getParent();
        }
        return null;
    }

}