org.sonar.flex.checks.utils.Function.java Source code

Introduction

Here is the source code for org.sonar.flex.checks.utils.Function.java

Source

/*
 * SonarQube Flex Plugin
 * Copyright (C) 2010 SonarSource
 * sonarqube@googlegroups.com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.flex.checks.utils;

import com.google.common.base.Preconditions;
import com.google.common.collect.Lists;
import com.sonar.sslr.api.AstNode;
import org.sonar.flex.FlexGrammar;
import org.sonar.flex.FlexKeyword;

import java.util.List;

public class Function {

    private Function() {
    }

    public static String getName(AstNode functionDef) {
        Preconditions.checkArgument(functionDef.is(FlexGrammar.FUNCTION_DEF));
        return functionDef.getFirstChild(FlexGrammar.FUNCTION_NAME).getFirstChild(FlexGrammar.IDENTIFIER)
                .getTokenValue();
    }

    public static boolean isAccessor(AstNode functionDef) {
        Preconditions.checkArgument(functionDef.is(FlexGrammar.FUNCTION_DEF));
        return functionDef.getFirstChild(FlexGrammar.FUNCTION_NAME).getFirstChild(FlexKeyword.GET,
                FlexKeyword.SET) != null;
    }

    public static boolean isEmptyConstructor(AstNode functionDef, String className) {
        Preconditions.checkArgument(functionDef.is(FlexGrammar.FUNCTION_DEF));
        AstNode functionBlock = functionDef.getFirstChild(FlexGrammar.FUNCTION_COMMON)
                .getFirstChild(FlexGrammar.BLOCK);

        return isConstructor(functionDef, className) && (functionBlock == null
                || functionBlock.getFirstChild(FlexGrammar.DIRECTIVES).getChildren().isEmpty());
    }

    public static boolean isConstructor(AstNode functionDef, String className) {
        Preconditions.checkArgument(functionDef.is(FlexGrammar.FUNCTION_DEF));
        return functionDef.getFirstChild(FlexGrammar.FUNCTION_NAME).getNumberOfChildren() == 1 && functionDef
                .getFirstChild(FlexGrammar.FUNCTION_NAME).getFirstChild().getTokenValue().equals(className);
    }

    public static List<AstNode> getParametersIdentifiers(AstNode functionDef) {
        Preconditions.checkArgument(functionDef.is(FlexGrammar.FUNCTION_DEF, FlexGrammar.FUNCTION_EXPR));
        List<AstNode> paramIdentifier = Lists.newArrayList();
        AstNode parameters = functionDef.getFirstChild(FlexGrammar.FUNCTION_COMMON)
                .getFirstChild(FlexGrammar.FUNCTION_SIGNATURE).getFirstChild(FlexGrammar.PARAMETERS);

        if (parameters != null) {
            for (AstNode parameter : parameters.getChildren(FlexGrammar.PARAMETER, FlexGrammar.REST_PARAMETERS)) {
                if (parameter.getFirstChild(FlexGrammar.TYPED_IDENTIFIER) != null) {
                    paramIdentifier.add(parameter.getFirstChild(FlexGrammar.TYPED_IDENTIFIER)
                            .getFirstChild(FlexGrammar.IDENTIFIER));
                }
            }
        }
        return paramIdentifier;
    }

    public static boolean isOverriding(AstNode functionDef) {
        Preconditions.checkArgument(functionDef.is(FlexGrammar.FUNCTION_DEF));
        AstNode attributesNode = functionDef.getPreviousAstNode();

        if (attributesNode != null && attributesNode.is(FlexGrammar.ATTRIBUTES)) {

            for (AstNode attribute : attributesNode.getChildren()) {
                if (attribute.getFirstChild().is(FlexGrammar.ATTRIBUTE_EXPR)
                        && attribute.getFirstChild().getNumberOfChildren() == 1
                        && attribute.getFirstChild().getFirstChild(FlexGrammar.IDENTIFIER).getTokenValue()
                                .equals(FlexKeyword.OVERRIDE.getValue())) {
                    return true;
                }
            }
        }
        return false;
    }
}