TouchInstinct
/
checkstyle
306
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Tim Tyler's check for descendant token counts

This commit is contained in:
Rick Giles 2003-07-20 13:57:58 +00:00
parent e4eebb4d88
commit 8acc405dd3
3 changed files with 456 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

367
contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/coding/DescendantTokenCheck.java Normal file
View File

@ -0,0 +1,367 @@
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2003 Oliver Burn
//
// This library 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 2.1 of the License, or (at your option) any later version.
//
// This library 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 library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.coding;
import java.util.Arrays;
import java.util.Iterator;
import java.util.Set;
import antlr.collections.AST;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* <p>
* Checks for restricted tokens beneath other tokens.
* <p>
* Examples of how to configure the check:
* </p>
* <pre>
* &lt;!-- String literal equality check --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="EQUAL,NOT_EQUAL"/&gt;
* &lt;property name="limitedTokens" value="STRING_LITERAL"/&gt;
* &lt;property name="maximumNumber" value="0"/&gt;
* &lt;/module&gt;
*
* &lt;!-- Switch with no default --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="LITERAL_SWITCH"/&gt;
* &lt;property name="maximumDepth" value="2"/&gt;
* &lt;property name="limitedTokens" value="LITERAL_DEFAULT"/&gt;
* &lt;property name="minimumNumber" value="1"/&gt;
* &lt;/module&gt;
*
* &lt;!-- Assert statement may have side effects --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="LITERAL_ASSERT"/&gt;
* &lt;property name="limitedTokens" value="ASSIGN,DEC,INC,POST_DEC,POST_INC,PLUS_ASSIGN,MINUS_ASSIGN,STAR_ASSIGN,DIV_ASSIGN,MOD_ASSIGN,BSR_ASSIGN,SR_ASSIGN,SL_ASSIGN,BAND_ASSIGN,BXOR_ASSIGN,BOR_ASSIGN,METHOD_CALL"/&gt;
* &lt;property name="maximumNumber" value="0"/&gt;
* &lt;/module&gt;
*
* &lt;!-- Initialiser in for performs no setup - use while instead? --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="FOR_INIT"/&gt;
* &lt;property name="limitedTokens" value="EXPR"/&gt;
* &lt;property name="minimumNumber" value="1"/&gt;
* &lt;/module&gt;
*
* &lt;!-- Condition in for performs no check --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="FOR_CONDITION"/&gt;
* &lt;property name="limitedTokens" value="EXPR"/&gt;
* &lt;property name="minimumNumber" value="1"/&gt;
* &lt;/module&gt;
*
* &lt;!-- Switch within switch --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="LITERAL_SWITCH"/&gt;
* &lt;property name="limitedTokens" value="LITERAL_SWITCH"/&gt;
* &lt;property name="maximumNumber" value="0"/&gt;
* &lt;property name="minimumDepth" value="1"/&gt;
* &lt;/module&gt;
*
* &lt;!-- Return from within a catch or finally block --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="LITERAL_FINALLY,LITERAL_CATCH"/&gt;
* &lt;property name="limitedTokens" value="LITERAL_RETURN"/&gt;
* &lt;property name="maximumNumber" value="0"/&gt;
* &lt;/module&gt;
*
* &lt;!-- Try within catch or finally block --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="LITERAL_CATCH,LITERAL_FINALLY"/&gt;
* &lt;property name="limitedTokens" value="LITERAL_TRY"/&gt;
* &lt;property name="maximumNumber" value="0"/&gt;
* &lt;/module&gt;
*
* &lt;!-- Too many cases within a switch --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="LITERAL_SWITCH"/&gt;
* &lt;property name="limitedTokens" value="LITERAL_CASE"/&gt;
* &lt;property name="maximumDepth" value="2"/&gt;
* &lt;property name="maximumNumber" value="10"/&gt;
* &lt;/module&gt;
*
* &lt;!-- Too many local variables within a method --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="METHOD_DEF"/&gt;
* &lt;property name="limitedTokens" value="VARIABLE_DEF"/&gt;
* &lt;property name="maximumDepth" value="2"/&gt;
* &lt;property name="maximumNumber" value="10"/&gt;
* &lt;/module&gt;
*
* &lt;!-- Too many returns from within a method --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="METHOD_DEF"/&gt;
* &lt;property name="limitedTokens" value="LITERAL_RETURN"/&gt;
* &lt;property name="maximumNumber" value="3"/&gt;
* &lt;/module&gt;
*
* &lt;!-- Too many fields within an interface --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="INTERFACE_DEF"/&gt;
* &lt;property name="limitedTokens" value="VARIABLE_DEF"/&gt;
* &lt;property name="maximumDepth" value="2"/&gt;
* &lt;property name="maximumNumber" value="0"/&gt;
* &lt;/module&gt;
*
* &lt;!-- Limit the number of exceptions a method can throw --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="LITERAL_THROWS"/&gt;
* &lt;property name="limitedTokens" value="IDENT"/&gt;
* &lt;property name="maximumNumber" value="1"/&gt;
* &lt;/module&gt;
*
* &lt;!-- Limit the number of expressions in a method --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="METHOD_DEF"/&gt;
* &lt;property name="limitedTokens" value="EXPR"/&gt;
* &lt;property name="maximumNumber" value="200"/&gt;
* &lt;/module&gt;
*
* &lt;!-- Disallow empty statements --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="EMPTY_STAT"/&gt;
* &lt;property name="limitedTokens" value="EMPTY_STAT"/&gt;
* &lt;property name="maximumNumber" value="0"/&gt;
* &lt;property name="maximumDepth" value="0"/&gt;
* &lt;property name="maximumMessage" value="Empty statement is not allowed."/&gt;
* &lt;/module&gt;
*
* &lt;!-- Too many fields within a class --&gt;
* &lt;module name="DescendantToken"&gt;
* &lt;property name="tokens" value="CLASS_DEF"/&gt;
* &lt;property name="limitedTokens" value="VARIABLE_DEF"/&gt;
* &lt;property name="maximumDepth" value="2"/&gt;
* &lt;property name="maximumNumber" value="10"/&gt;
* &lt;/module&gt;
* </pre>
* <p>
* @author Tim Tyler &lt;tim@tt1.org&gt;
* @author Rick Giles
*/
public class DescendantTokenCheck extends Check
{
/** minimum depth */
private int mMinimumDepth = 0;
/** maximum depth */
private int mMaximumDepth = Integer.MAX_VALUE;
/** minimum number */
private int mMinimumNumber = 0;
/** maximum number */
private int mMaximumNumber = Integer.MAX_VALUE;
/** limited tokens */
private int[] mLimitedTokens = new int[0];
/** error message when minimum count not reached */
private String mMinimumMessage = "descendant.token.min";
/** error message when maximum count exceeded */
private String mMaximumMessage = "descendant.token.max";
/**
* Counts of descendant tokens.
* Indexed by (token ID - 1) for performance.
*/
private int[] mCounts = new int[0];
/** @see com.puppycrawl.tools.checkstyle.api.Check#getDefaultTokens() */
public int[] getDefaultTokens()
{
return new int[0];
}
/** @see com.puppycrawl.tools.checkstyle.api.Check */
public void visitToken(DetailAST aAST)
{
//reset counts
Arrays.fill(mCounts, 0);
countTokens(aAST, 0);
// name of this token
final String name = TokenTypes.getTokenName(aAST.getType());
for (int i = 0; i < mLimitedTokens.length; i++) {
final int tokenCount = mCounts[mLimitedTokens[i] - 1];
if (tokenCount < mMinimumNumber) {
final String descendantName =
TokenTypes.getTokenName(mLimitedTokens[i]);
log(
aAST.getLineNo(),
aAST.getColumnNo(),
mMinimumMessage,
new String[] {
"" + tokenCount,
"" + mMinimumNumber,
name,
descendantName,
});
}
if (tokenCount > mMaximumNumber) {
final String descendantName =
TokenTypes.getTokenName(mLimitedTokens[i]);
log(
aAST.getLineNo(),
aAST.getColumnNo(),
mMaximumMessage,
new String[] {
"" + tokenCount,
"" + mMaximumNumber,
name,
descendantName,
});
}
}
}
/**
* Counts the number of occurrences of descendant tokens.
* @param aAST the root token for descendants.
* @param aDepth the maximum depth of the counted descendants.
*/
private void countTokens(AST aAST, int aDepth)
{
if (aDepth <= mMaximumDepth) {
//update count
if (aDepth >= mMinimumDepth) {
final int type = aAST.getType();
if (type <= mCounts.length) {
mCounts[type - 1]++;
}
}
AST child = aAST.getFirstChild();
final int nextDepth = aDepth + 1;
while (child != null) {
countTokens(child, nextDepth);
child = child.getNextSibling();
}
}
}
/** @see com.puppycrawl.tools.checkstyle.api.Check */
public int[] getAcceptableTokens()
{
// Any tokens set by property 'tokens' are acceptable
final Set tokenNames = getTokenNames();
final int[] result = new int[tokenNames.size()];
int i = 0;
final Iterator it = tokenNames.iterator();
while (it.hasNext()) {
final String name = (String) it.next();
result[i] = TokenTypes.getTokenId(name);
i++;
}
return result;
}
/**
* Sets the tokens to ignore in the check.
* @param aLimitedTokens - list of tokens to ignore.
*/
public void setLimitedTokens(String[] aLimitedTokens)
{
mLimitedTokens = new int[aLimitedTokens.length];
int maxToken = 0;
for (int i = 0; i < aLimitedTokens.length; i++) {
mLimitedTokens[i] = TokenTypes.getTokenId(aLimitedTokens[i]);
if (mLimitedTokens[i] > maxToken) {
maxToken = mLimitedTokens[i];
}
}
mCounts = new int[maxToken];
}
/**
* Sets the mimimum depth for descendant counts.
* @param aMinimumDepth the mimimum depth for descendant counts.
*/
public void setMinimumDepth(int aMinimumDepth)
{
mMinimumDepth = aMinimumDepth;
}
/**
* Sets the maximum depth for descendant counts.
* @param aMaximumDepth the maximum depth for descendant counts.
*/
public void setMaximumDepth(int aMaximumDepth)
{
mMaximumDepth = aMaximumDepth;
}
/**
* Sets a minimum count for descendants.
* @param aMinimumNumber the minimum count for descendants.
*/
public void setMinimumNumber(int aMinimumNumber)
{
mMinimumNumber = aMinimumNumber;
}
/**
* Sets a maximum count for descendants.
* @param aMaximumNumber the maximum count for descendants.
*/
public void setMaximumNumber(int aMaximumNumber)
{
mMaximumNumber = aMaximumNumber;
}
/**
* Sets the error message for minimum count not reached.
* @param aMessage the error message for minimum count not reached.
* Used as a <code>MessageFormat</code> pattern with arguments
* <ul>
* <li>{0} - token count</li>
* <li>{1} - minimum number</li>
* <li>{2} - name of token</li>
* <li>{3} - name of limited token</li>
* </ul>
*/
public void setMinimumMessage(String aMessage)
{
mMinimumMessage = aMessage;
}
/**
* Sets the error message for maximum count exceeded.
* @param aMessage the error message for maximum count exceeded.
* Used as a <code>MessageFormat</code> pattern with arguments
* <ul>
* <li>{0} - token count</li>
* <li>{1} - maximum number</li>
* <li>{2} - name of token</li>
* <li>{3} - name of limited token</li>
* </ul>
*/
public void setMaximumMessage(String aMessage)
{
mMaximumMessage = aMessage;
}
}

87
contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/coding/DescendantTokenCheckTest.java Normal file
View File

@ -0,0 +1,87 @@
package com.puppycrawl.tools.checkstyle.checks.coding;
import com.puppycrawl.tools.checkstyle.BaseCheckTestCase;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
public class DescendantTokenCheckTest
extends BaseCheckTestCase
{
public void testDefault()
throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(DescendantTokenCheck.class);
final String[] expected = {};
verify(checkConfig, getPath("InputIllegalTokens.java"), expected);
}
public void testMaximumNumber()
throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(DescendantTokenCheck.class);
checkConfig.addAttribute("tokens", "LITERAL_NATIVE");
checkConfig.addAttribute("limitedTokens", "LITERAL_NATIVE");
checkConfig.addAttribute("maximumNumber", "0");
final String[] expected = {
"20:12: Count of 1 for 'LITERAL_NATIVE' descendant 'LITERAL_NATIVE' exceeds maximum count 0.",
};
verify(checkConfig, getPath("InputIllegalTokens.java"), expected);
}
public void testMessage()
throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(DescendantTokenCheck.class);
checkConfig.addAttribute("tokens", "LITERAL_NATIVE");
checkConfig.addAttribute("limitedTokens", "LITERAL_NATIVE");
checkConfig.addAttribute("maximumNumber", "0");
checkConfig.addAttribute("maximumMessage", "Using ''native'' is not allowed.");
final String[] expected = {
"20:12: Using 'native' is not allowed.",
};
verify(checkConfig, getPath("InputIllegalTokens.java"), expected);
}
public void testMinimumNumber()
throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(DescendantTokenCheck.class);
checkConfig.addAttribute("tokens", "LITERAL_SWITCH");
checkConfig.addAttribute("limitedTokens", "LITERAL_DEFAULT");
checkConfig.addAttribute("minimumNumber", "2");
final String[] expected = {
"11:9: Count of 1 for 'LITERAL_SWITCH' descendant 'LITERAL_DEFAULT' is less than minimum count 2.",
};
verify(checkConfig, getPath("InputIllegalTokens.java"), expected);
}
public void testMinimumDepth()
throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(DescendantTokenCheck.class);
checkConfig.addAttribute("tokens", "LITERAL_SWITCH");
checkConfig.addAttribute("limitedTokens", "LITERAL_DEFAULT");
checkConfig.addAttribute("maximumNumber", "0");
checkConfig.addAttribute("minimumDepth", "3");
final String[] expected = {};
verify(checkConfig, getPath("InputIllegalTokens.java"), expected);
}
public void testMaximumDepth()
throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(DescendantTokenCheck.class);
checkConfig.addAttribute("tokens", "LITERAL_SWITCH");
checkConfig.addAttribute("limitedTokens", "LITERAL_DEFAULT");
checkConfig.addAttribute("maximumNumber", "0");
checkConfig.addAttribute("maximumDepth", "1");
final String[] expected = {};
verify(checkConfig, getPath("InputIllegalTokens.java"), expected);
}
}

2
contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/coding/messages.properties Normal file
View File

@ -0,0 +1,2 @@
descendant.token.min=Count of {0} for ''{2}'' descendant ''{3}'' is less than minimum count {1}.
descendant.token.max=Count of {0} for ''{2}'' descendant ''{3}'' exceeds maximum count {1}.