| //////////////////////////////////////////////////////////////////////////////// |
| // |
| // Licensed to the Apache Software Foundation (ASF) under one or more |
| // contributor license agreements. See the NOTICE file distributed with |
| // this work for additional information regarding copyright ownership. |
| // The ASF licenses this file to You 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.apache.royale.linter.rules; |
| |
| import java.util.Collection; |
| import java.util.HashMap; |
| import java.util.Map; |
| |
| import org.apache.royale.compiler.problems.CompilerProblem; |
| import org.apache.royale.compiler.problems.ICompilerProblem; |
| import org.apache.royale.compiler.tree.ASTNodeID; |
| import org.apache.royale.compiler.tree.as.IFunctionNode; |
| import org.apache.royale.linter.LinterRule; |
| import org.apache.royale.linter.NodeVisitor; |
| import org.apache.royale.linter.TokenQuery; |
| |
| /** |
| * Checks the number of function parameters. |
| */ |
| public class MaxParametersRule extends LinterRule { |
| @Override |
| public Map<ASTNodeID, NodeVisitor> getNodeVisitors() { |
| Map<ASTNodeID, NodeVisitor> result = new HashMap<>(); |
| result.put(ASTNodeID.FunctionID, (node, tokenQuery, problems) -> { |
| checkFunctionNode((IFunctionNode) node, tokenQuery, problems); |
| }); |
| return result; |
| } |
| |
| public int maximum = 6; |
| |
| private void checkFunctionNode(IFunctionNode functionNode, TokenQuery tokenQuery, Collection<ICompilerProblem> problems) { |
| if (functionNode.getParameterNodes().length <= maximum) { |
| return; |
| } |
| problems.add(new MaxParametersLinterProblem(functionNode, maximum)); |
| } |
| |
| public static class MaxParametersLinterProblem extends CompilerProblem { |
| public static final String DESCRIPTION = "Function '${functionName}' has ${params} parameters, but expected no more than ${maxParams} parameters"; |
| |
| public MaxParametersLinterProblem(IFunctionNode node, int maxParams) |
| { |
| super(node.getParametersContainerNode()); |
| this.maxParams = maxParams; |
| params = node.getParameterNodes().length; |
| functionName = node.getName(); |
| } |
| |
| public String functionName; |
| public int params; |
| public int maxParams; |
| } |
| } |