Back to topsubstring-after($path, '\')ab
checkstyle-5.6/contrib/checkstyle-csv.xsl 100644 0 0 723 11451071612 15750 0 ustar 0 0
, , , , ,
checkstyle-5.6/contrib/checkstyle-frames-errors.xsl 100644 0 0 35315 11451071612 20011 0 ustar 0 0 CheckStyle Audit
<h2>Frame Alert</h2>
<p>
This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client.
</p>
ab
checkstyle-5.6/contrib/checkstyle-frames.xsl 100644 0 0 34307 11451071612 16477 0 ustar 0 0 CheckStyle Audit
<h2>Frame Alert</h2>
<p>
This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client.
</p>
ab
checkstyle-5.6/contrib/checkstyle-simple.xsl 100644 0 0 3550 11451071612 16467 0 ustar 0 0
Sun Coding Style Violations
Coding Style Check Results
Summary
Total files checked
Files with errors
Total errors
Errors per file
The following are violations of the Sun Coding-Style Standards:
File:
Line Number
Error Message
checkstyle-5.6/contrib/checkstyle-text.xsl 100644 0 0 1762 11451071612 16165 0 ustar 0 0
Coding Style Check Results
--------------------------
Total files checked:
Files with errors:
Total errors:
Errors per file:
File: : - checkstyle-5.6/contrib/examples/checks/all-checkstyle-checks.xml 100644 0 0 152504 11521515665 22331 0 ustar 0 0
checkstyle-5.6/contrib/examples/checks/com/mycompany/checks/LimitImplementationFiles.java 100644 0 0 3630 11451071612 27233 0 ustar 0 0 package com.mycompany.checks;
import java.io.File;
import com.puppycrawl.tools.checkstyle.api.*;
/**
* An example for a user provided FileSetCheck,
* checks that the number of files does not excced a certain limit.
*
* This Class is provided for educational purposes only, we do not
* consider it useful to check your production code.
*
* @author lkuehne
*/
public class LimitImplementationFiles
extends AbstractFileSetCheck
{
/**
* the maximium number of implementation files,
* default is 100.
*/
private int max = 100;
/**
* Give user a chance to configure max in the
* config file.
*
* @param aMax the user specified maximum.
*/
public void setMax(int aMax)
{
max = aMax;
}
/**
* @see FileSetCheck
*/
public void process(File[] files)
{
if (files != null && files.length > max) {
// figure out the file that contains the error
final String path = files[max].getPath();
// message collector is used to collect error messages,
// needs to be reset before starting to collect error messages
// for a file.
getMessageCollector().reset();
// message dispatcher is used to fire AuditEvents
MessageDispatcher dispatcher = getMessageDispatcher();
// signal start of file to AuditListeners
dispatcher.fireFileStarted(path);
// log the message
log(0, "max.files.exceeded", new Integer(max));
// you can call log() multiple times to flag multiple
// errors in the same file
// fire the errors for this file to the AuditListeners
fireErrors(path);
// signal end of file to AuditListeners
dispatcher.fireFileFinished(path);
}
}
}
checkstyle-5.6/contrib/examples/checks/com/mycompany/checks/messages.properties 100644 0 0 201 11451071612 25315 0 ustar 0 0 max.files.exceeded=Too many implementation files, only {0} are allowed
too.many.methods=Too many methods, only {0} are allowed
checkstyle-5.6/contrib/examples/checks/com/mycompany/checks/MethodLimitCheck.java 100644 0 0 3450 11451071612 25441 0 ustar 0 0 package com.mycompany.checks;
import com.puppycrawl.tools.checkstyle.api.*;
public class MethodLimitCheck extends Check
{
/** the maximum number of methods per class/interface */
private int max = 30;
/**
* Give user a chance to configure max in the config file.
* @param aMax the user specified maximum parsed from configuration property.
*/
public void setMax(int aMax)
{
max = aMax;
}
/**
* We are interested in CLASS_DEF and INTERFACE_DEF Tokens.
* @see Check
*/
public int[] getDefaultTokens()
{
return new int[]{TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF};
}
/**
* @see Check
*/
public void visitToken(DetailAST ast)
{
// the tree below a CLASS_DEF/INTERFACE_DEF looks like this:
// CLASS_DEF
// MODIFIERS
// class name (IDENT token type)
// EXTENDS_CLAUSE
// IMPLEMENTS_CLAUSE
// OBJBLOCK
// {
// some other stuff like variable declarations etc.
// METHOD_DEF
// more stuff, the users might mix methods, variables, etc.
// METHOD_DEF
// ...and so on
// }
// We use helper methods to navigate in the syntax tree
// find the OBJBLOCK node below the CLASS_DEF/INTERFACE_DEF
DetailAST objBlock = ast.findFirstToken(TokenTypes.OBJBLOCK);
// count the number of direct children of the OBJBLOCK
// that are METHOD_DEFS
int methodDefs = objBlock.getChildCount(TokenTypes.METHOD_DEF);
// report error if limit is reached
if (methodDefs > max) {
log(ast.getLineNo(), "too.many.methods", new Integer(max));
}
}
}
checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/Attribute.java 100644 0 0 5616 11451071612 31051 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// 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.xpath;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
* Data holder for an XPath attribute of an element. The parent
* element of an Attribute is a DetailAST. The name and value
* of an Attribute are Strings.
* @author Rick Giles
*/
public class Attribute
{
/** element owning this attribute */
private DetailAST mParent;
/** name */
private String mName;
/** value */
private String mValue;
/**
* Constructs an Attribute.
* @param aParent the parent element.
* @param aName the name.
* @param aValue the value.
*/
public Attribute(DetailAST aParent, String aName, String aValue)
{
mParent = aParent;
mName = aName;
mValue = aValue;
}
/** Returns the name of the attribute.
* @return the name of the attribute.
*/
public String getName()
{
return mName;
}
/**
* Returns the value of the attribute.
* @return the value of the attribute.
*/
public String getValue()
{
return mValue;
}
/**
* Sets the name of the attribute.
* @param aName The name to set.
*/
public void setName(String aName)
{
mName = aName;
}
/**
* Sets the value of the attribute.
* @param aValue The value to set.
*/
public void setValue(String aValue)
{
mValue = aValue;
}
/**
* Returns the parent of the attribute.
* @return the parent of the attribute.
*/
public DetailAST getParent()
{
return mParent;
}
/**
* Sets the parent of the attribute.
* @param aParent the parent of the attribute.
*/
public void setParent(DetailAST aParent)
{
mParent = aParent;
}
}
././@LongLink 100644 0 0 157 12026055133 10253 L ustar 0 0 checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/AttributeAxisIterator.java checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/AttributeAxisIte100644 0 0 6515 11451071612 31417 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// 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.xpath;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.commons.beanutils.BeanUtils;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
* Iterator for an attribute axis of an XPath element. The XPath
* element is a DetailAST. Attributes correspond to bean
* properties of the DetailAST.
* @author Rick Giles
*/
public class AttributeAxisIterator
implements Iterator
{
/** actual iterator */
private Iterator mIter = (new ArrayList()).iterator();
/**
* Constructs a AttributeAxisIterator for a
* DetailAST element.
* @param aAST the DetailAST element
*/
public AttributeAxisIterator(DetailAST aAST)
{
Map props = new HashMap();
//use BeanUtils to get the properties
try {
props = BeanUtils.describe(aAST);
}
catch (IllegalAccessException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
catch (InvocationTargetException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
catch (NoSuchMethodException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
// add attributes for the properties to a list and
// set the iterator to an iterator over that list.
final List attributes = new ArrayList(props.size());
final Set values = props.keySet();
for (Iterator iter = values.iterator(); iter.hasNext();) {
final String name = (String) iter.next();
final String value = (String) props.get(name);
attributes.add(new Attribute(aAST, name, value));
}
mIter = attributes.iterator();
}
/**@see java.util.Iterator#next() */
public Object next()
{
return mIter.next();
}
/** @see java.util.Iterator#hasNext() */
public boolean hasNext()
{
return mIter.hasNext();
}
/** @see java.util.Iterator#remove() */
public void remove()
{
mIter.remove();
}
} ././@LongLink 100644 0 0 153 12026055133 10247 L ustar 0 0 checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/DocumentNavigator.java checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/DocumentNavigato100644 0 0 31111 11451071612 31442 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// 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.xpath;
import java.util.ArrayList;
import java.util.Iterator;
import org.jaxen.DefaultNavigator;
import org.jaxen.XPath;
import org.jaxen.util.SingleObjectIterator;
import org.saxpath.SAXPathException;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Navigates around a DetailAST, using XPath semantics.
* Requires jaxen, http://jaxen.sourceforge.net and
* saxpath, http://sourceforge.net/projects/saxpath/.
* Idea shamelessly stolen from the equivalent PMD code (pmd.sourceforge.net).
* @author Rick Giles
*/
public class DocumentNavigator
extends DefaultNavigator
{
/** Iterator for an empty sequence */
private static final Iterator EMPTY_ITERATOR = new ArrayList().iterator();
/**
* @see org.jaxen.DefaultNavigator#getAttributeName(java.lang.Object)
*/
public String getAttributeName(Object aObject)
{
return ((Attribute) aObject).getName();
}
/**
* @see org.jaxen.DefaultNavigator#getAttributeNamespaceUri
*/
public String getAttributeNamespaceUri(Object aObject)
{
return null;
}
/**
* @see org.jaxen.DefaultNavigator#getAttributeQName(java.lang.Object)
*/
public String getAttributeQName(Object aObject)
{
return ((Attribute) aObject).getName();
}
/**
* @see org.jaxen.DefaultNavigator#getAttributeStringValue(java.lang.Object)
*/
public String getAttributeStringValue(Object aObject)
{
return ((Attribute) aObject).getValue();
}
/**
* @see org.jaxen.DefaultNavigator#getCommentStringValue(java.lang.Object)
*/
public String getCommentStringValue(Object aObject)
{
return null;
}
/**
* @see org.jaxen.DefaultNavigator#getElementName(java.lang.Object)
*/
public String getElementName(Object aObject)
{
final int type = ((DetailAST) aObject).getType();
return TokenTypes.getTokenName(type);
}
/**
* @see org.jaxen.DefaultNavigator#getElementNamespaceUri(java.lang.Object)
*/
public String getElementNamespaceUri(Object aObject)
{
return null;
}
/**
* @see org.jaxen.DefaultNavigator#getElementQName(java.lang.Object)
*/
public String getElementQName(Object aObject)
{
return getElementName(aObject);
}
/**
* @see org.jaxen.DefaultNavigator#getElementStringValue(java.lang.Object)
*/
public String getElementStringValue(Object aObject)
{
return null;
}
/**
* @see org.jaxen.DefaultNavigator#getNamespacePrefix(java.lang.Object)
*/
public String getNamespacePrefix(Object aObject)
{
return null;
}
/**
* @see org.jaxen.DefaultNavigator#getNamespaceStringValue(java.lang.Object)
*/
public String getNamespaceStringValue(Object aObject)
{
return null;
}
/**
* @see org.jaxen.DefaultNavigator#getTextStringValue(java.lang.Object)
*/
public String getTextStringValue(Object aObject)
{
return null;
}
/**
* @see org.jaxen.DefaultNavigator#isAttribute(java.lang.Object)
*/
public boolean isAttribute(Object aObject)
{
return aObject instanceof Attribute;
}
/**
* @see org.jaxen.DefaultNavigator#isComment(java.lang.Object)
*/
public boolean isComment(Object aObject)
{
return false;
}
/**
* @see org.jaxen.DefaultNavigator#isDocument(java.lang.Object)
*/
public boolean isDocument(Object aObject)
{
if (aObject instanceof DetailAST) {
final DetailAST node = (DetailAST) aObject;
return (node.getType() == TokenTypes.EOF);
}
else {
return false;
}
}
/**
* @see org.jaxen.DefaultNavigator#isElement(java.lang.Object)
*/
public boolean isElement(Object aObject)
{
return aObject instanceof DetailAST;
}
/**
* @see org.jaxen.DefaultNavigator#isNamespace(java.lang.Object)
*/
public boolean isNamespace(Object aObject)
{
return false;
}
/**
* @see org.jaxen.DefaultNavigator#isProcessingInstruction(java.lang.Object)
*/
public boolean isProcessingInstruction(Object aObject)
{
return false;
}
/**
* @see org.jaxen.DefaultNavigator#isText(java.lang.Object)
*/
public boolean isText(Object aObject)
{
return false;
}
/**
* @see org.jaxen.DefaultNavigator#parseXPath(java.lang.String)
*/
public XPath parseXPath(String aObject)
throws SAXPathException
{
return null;
}
/**
* @see org.jaxen.Navigator#getParentNode(java.lang.Object)
*/
public Object getParentNode(Object aObject)
{
if (aObject instanceof DetailAST) {
return ((DetailAST) aObject).getParent();
}
else {
return ((Attribute) aObject).getParent();
}
}
/**
* @see org.jaxen.Navigator#getAttributeAxisIterator(java.lang.Object)
*/
public Iterator getAttributeAxisIterator(Object aObject)
{
final DetailAST contextNode = (DetailAST) aObject;
return new AttributeAxisIterator(contextNode);
}
/**
* Get an iterator over all of this node's children.
*
* @param aObject The context node for the child axis.
* @return A possibly-empty iterator (not null).
*/
public Iterator getChildAxisIterator(Object aObject)
{
return new NodeIterator((DetailAST) aObject)
{
/** @see NodeIterator */
protected DetailAST getFirstNode(DetailAST aAST)
{
return getFirstChild(aAST);
}
/** @see NodeIterator */
protected DetailAST getNextNode(DetailAST aAST)
{
return getNextSibling(aAST);
}
};
}
/**
* Get a (single-member) iterator over this node's parent.
*
* @param aObject the context node for the parent axis.
* @return A possibly-empty iterator (not null).
*/
public Iterator getParentAxisIterator(Object aObject)
{
if (isAttribute(aObject)) {
return new SingleObjectIterator(((Attribute) aObject).getParent());
}
else {
DetailAST parent = ((DetailAST) aObject).getParent();
if (parent != null) {
return new SingleObjectIterator(parent);
}
else {
return EMPTY_ITERATOR;
}
}
}
/**
* Get an iterator over all following siblings.
*
* @param aObject the context node for the sibling iterator.
* @return A possibly-empty iterator (not null).
*/
public Iterator getFollowingSiblingAxisIterator(Object aObject)
{
return new NodeIterator((DetailAST) aObject)
{
/** @see NodeIterator */
protected DetailAST getFirstNode(DetailAST aAST)
{
return getNextNode(aAST);
}
/** @see NodeIterator */
protected DetailAST getNextNode(DetailAST aAST)
{
return getNextSibling(aAST);
}
};
}
/**
* Get an iterator over all preceding siblings.
*
* @param aObject The context node for the preceding sibling axis.
* @return A possibly-empty iterator (not null).
*/
public Iterator getPrecedingSiblingAxisIterator(Object aObject)
{
return new NodeIterator((DetailAST) aObject)
{
/** @see NodeIterator */
protected DetailAST getFirstNode(DetailAST aAST)
{
return getNextNode(aAST);
}
/** @see NodeIterator */
protected DetailAST getNextNode(DetailAST aAST)
{
return getPreviousSibling(aAST);
}
};
}
/**
* Get an iterator over all following nodes, depth-first.
*
* @param aObject The context node for the following axis.
* @return A possibly-empty iterator (not null).
*/
public Iterator getFollowingAxisIterator(Object aObject)
{
return new NodeIterator((DetailAST) aObject)
{
/** @see NodeIterator */
protected DetailAST getFirstNode(DetailAST aAST)
{
if (aAST == null) {
return null;
}
else {
final DetailAST sibling = getNextSibling(aAST);
if (sibling == null) {
return getFirstNode(aAST.getParent());
}
else {
return sibling;
}
}
}
/** @see NodeIterator */
protected DetailAST getNextNode(DetailAST aAST)
{
if (aAST == null) {
return null;
}
else {
DetailAST n = getFirstChild(aAST);
if (n == null) {
n = getNextSibling(aAST);
}
if (n == null) {
return getFirstNode(aAST.getParent());
}
else {
return n;
}
}
}
};
}
/**
* Get an iterator over all preceding nodes, depth-first.
*
* @param aObject The context node for the preceding axis.
* @return A possibly-empty iterator (not null).
*/
public Iterator getPrecedingAxisIterator(Object aObject)
{
return new NodeIterator((DetailAST) aObject)
{
/** @see NodeIterator */
protected DetailAST getFirstNode(DetailAST aAST)
{
if (aAST == null) {
return null;
}
else {
final DetailAST sibling = getPreviousSibling(aAST);
if (sibling == null) {
return getFirstNode(aAST.getParent());
}
else {
return sibling;
}
}
}
/** @see NodeIterator */
protected DetailAST getNextNode(DetailAST aAST)
{
if (aAST == null) {
return null;
}
else {
DetailAST n = getLastChild(aAST);
if (n == null) {
n = getPreviousSibling(aAST);
}
if (n == null) {
return getFirstNode(aAST.getParent());
}
else {
return n;
}
}
}
};
}
/** @see org.jaxen.Navigator#getDocumentNode(java.lang.Object) */
public Object getDocumentNode(Object aObject)
{
if (isDocument(aObject)) {
return aObject;
}
else {
return getDocumentNode(getParentNode(aObject));
}
}
}
././@LongLink 100644 0 0 146 12026055133 10251 L ustar 0 0 checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/jaxen_LICENSE.txt checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/jaxen_LICENSE.tx100644 0 0 5044 11451071612 31062 0 ustar 0 0 /*--
$Id: jaxen_LICENSE.txt,v 1.1 2003-07-23 14:22:41 rickgiles Exp $
Copyright (C) 2000-2002 bob mcwhirter & James Strachan.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions, and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions, and the disclaimer that follows
these conditions in the documentation and/or other materials
provided with the distribution.
3. The name "Jaxen" must not be used to endorse or promote products
derived from this software without prior written permission. For
written permission, please contact license@jaxen.org.
4. Products derived from this software may not be called "Jaxen", nor
may "Jaxen" appear in their name, without prior written permission
from the Jaxen Project Management (pm@jaxen.org).
In addition, we request (but do not require) that you include in the
end-user documentation provided with the redistribution and/or in the
software itself an acknowledgement equivalent to the following:
"This product includes software developed by the
Jaxen Project (http://www.jaxen.org/)."
Alternatively, the acknowledgment may be graphical using the logos
available at http://www.jaxen.org/
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE Jaxen AUTHORS OR THE PROJECT
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
This software consists of voluntary contributions made by many
individuals on behalf of the Jaxen Project and was originally
created by bob mcwhirter and
James Strachan . For more information on the
Jaxen Project, please see .
*/
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/messages.properties checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/messages.propert100644 0 0 423 11451071612 31436 0 ustar 0 0 block.empty=Empty {0} block.
hex.case.constant="Case constant ''{0}'' must not start with ''0x'' or ''0X''.
needBraces=''{0}'' construct must use '''{}'''s.
short.variable.name=Short variable name ''{0}''.
string.conditional=String literal {0} must not be an operand.
././@LongLink 100644 0 0 146 12026055133 10251 L ustar 0 0 checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/NodeIterator.java checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/NodeIterator.jav100644 0 0 7137 11451071612 31344 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// 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.xpath;
import java.util.Iterator;
import java.util.NoSuchElementException;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
* Iterator for DetailAST nodes in a syntax tree.
* @author Rick Giles
*/
public abstract class NodeIterator
implements Iterator
{
/** The DetailAST for this iterator */
private DetailAST mNode;
/**
* Constructs a NodeIterator for a DetailAST.
* @param aAST the DetailAST.
*/
public NodeIterator(DetailAST aAST)
{
this.mNode = getFirstNode(aAST);
}
/** @see java.util.Iterator#hasNext() */
public boolean hasNext()
{
return mNode != null;
}
/** @see java.util.Iterator#next() */
public Object next()
{
if (mNode == null) {
throw new NoSuchElementException();
}
final DetailAST ret = mNode;
mNode = getNextNode(mNode);
return ret;
}
/** @see java.util.Iterator#remove() */
public void remove()
{
throw new UnsupportedOperationException();
}
/**
* Gets the first node of an iterator over a DetailAST.
* @param aAST the DetailAST.
* @return the first node of an iterator over aAST.
*/
protected abstract DetailAST getFirstNode(DetailAST aAST);
/**
* Gets the next node for an iterator over a DetailAST.
* @param aAST the DetailAST.
* @return the next node of aAST.
*/
protected abstract DetailAST getNextNode(DetailAST aAST);
/**
* Gets the previous sibling of a DetailAST.
* @param aAST the DetailAST.
* @return the previous sibling of aAST.
*/
protected DetailAST getPreviousSibling(DetailAST aAST)
{
return aAST.getPreviousSibling();
}
/**
* Get the next sibling of a DetailAST.
* @param aAST the DetailAST.
* @return the next sibling of aAST.
*/
protected DetailAST getNextSibling(DetailAST aAST)
{
return (DetailAST) aAST.getNextSibling();
}
/**
* Get the first child of a DetailAST.
* @param aAST the DetailAST.
* @return the first child of aAST.
*/
protected DetailAST getFirstChild(DetailAST aAST)
{
return (DetailAST) aAST.getFirstChild();
}
/**
* Get the last child of a DetailAST.
* @param aAST the DetailAST.
* @return the last child of aAST.
*/
protected DetailAST getLastChild(DetailAST aAST)
{
return aAST.getLastChild();
}
} checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/package.html 100644 0 0 246 11451071612 30476 0 ustar 0 0
Contains a Check for XPath semantics in a syntac tree.
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/saxpath_LICENSE.txt checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/saxpath_LICENSE.100644 0 0 6033 11451071612 31050 0 ustar 0 0 /*
* $Header: /opt/shared/tmp/checkstyle-cvsbackup/checkstyle/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/saxpath_LICENSE.txt,v 1.1 2003-07-23 14:22:41 rickgiles Exp $
* $Revision: 1.1 $
* $Date: 2003-07-23 14:22:41 $
*
* ====================================================================
*
* Copyright (C) 2000-2002 werken digital.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions, and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions, and the disclaimer that follows
* these conditions in the documentation and/or other materials
* provided with the distribution.
*
* 3. The name "SAXPath" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact license@saxpath.org.
*
* 4. Products derived from this software may not be called "SAXPath", nor
* may "SAXPath" appear in their name, without prior written permission
* from the SAXPath Project Management (pm@saxpath.org).
*
* In addition, we request (but do not require) that you include in the
* end-user documentation provided with the redistribution and/or in the
* software itself an acknowledgement equivalent to the following:
* "This product includes software developed by the
* SAXPath Project (http://www.saxpath.org/)."
* Alternatively, the acknowledgment may be graphical using the logos
* available at http://www.saxpath.org/
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE SAXPath AUTHORS OR THE PROJECT
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* ====================================================================
* This software consists of voluntary contributions made by many
* individuals on behalf of the SAXPath Project and was originally
* created by bob mcwhirter and
* James Strachan . For more information on the
* SAXPath Project, please see .
*
* $Id: saxpath_LICENSE.txt,v 1.1 2003-07-23 14:22:41 rickgiles Exp $
*/
checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/XPathCheck.java 100644 0 0 7173 11451071612 31070 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// 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.xpath;
import java.util.Iterator;
import org.jaxen.BaseXPath;
import org.jaxen.JaxenException;
import org.jaxen.XPath;
import antlr.ASTFactory;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Checks for an XPath in the root AST. Path elements are named
* according to token types. Attributes of an element are bean
* properties.
* Requires jaxen, http://jaxen.sourceforge.net and
* saxpath, http://sourceforge.net/projects/saxpath/.
* Idea shamelessly stolen from the equivalent PMD rule (pmd.sourceforge.net).
* @author Rick Giles
*/
public class XPathCheck extends Check
{
/** XPath for this check */
private XPath mXPath;
/** error message */
private String mMessage = "illegal.xpath";
/** @see com.puppycrawl.tools.checkstyle.api.Check#getDefaultTokens() */
public int[] getDefaultTokens()
{
return new int[0];
}
/** @see com.puppycrawl.tools.checkstyle.api.Check */
public void beginTree(DetailAST aAST)
{
if (mXPath != null) {
final ASTFactory factory = new ASTFactory();
factory.setASTNodeType(DetailAST.class.getName());
// TODO: Need to resolve if need a fake root node....
final DetailAST root =
(DetailAST) factory.create(TokenTypes.EOF, "ROOT");
root.setFirstChild(aAST);
try {
final Iterator it = mXPath.selectNodes(aAST).iterator();
while (it.hasNext()) {
final DetailAST node = (DetailAST) it.next();
log(
node.getLineNo(),
node.getColumnNo(),
mMessage,
new String[] {node.getText()});
}
}
catch (JaxenException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}
/**
* Sets the error message for this check.
* @param aMessage error message for this check.
*/
public void setMessage(String aMessage)
{
mMessage = aMessage;
}
/**
* Sets the XPath for this check.
* @param aXPath the XPath for this check.
* @throws JaxenException if there is an error.
*/
public void setXPath(String aXPath)
throws JaxenException
{
mXPath = new BaseXPath(aXPath, new DocumentNavigator());
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/xpath_config.xml checkstyle-5.6/contrib/examples/checks/com/puppycrawl/tools/checkstyle/checks/xpath/xpath_config.xml100644 0 0 3466 11451071612 31437 0 ustar 0 0
checkstyle-5.6/contrib/examples/checks/mycompany_conf.xml 100644 0 0 2253 11451071612 21132 0 ustar 0 0
checkstyle-5.6/contrib/examples/conf/BlochEffectiveJava.xml 100644 0 0 7714 11451071612 21257 0 ustar 0 0
checkstyle-5.6/contrib/examples/conf/openorb.xml 100644 0 0 12555 11451071612 17270 0 ustar 0 0
checkstyle-5.6/contrib/examples/conf/template_config.xml 100644 0 0 110215 11451071612 20774 0 ustar 0 0
checkstyle-5.6/contrib/examples/filters/com/mycompany/filters/FilesFilter.java 100644 0 0 1563 11451071612 25117 0 ustar 0 0 package com.mycompany.filters;
import org.apache.regexp.RE;
import org.apache.regexp.RESyntaxException;
import com.puppycrawl.tools.checkstyle.api.AuditEvent;
import com.puppycrawl.tools.checkstyle.api.AutomaticBean;
import com.puppycrawl.tools.checkstyle.api.Filter;
import com.puppycrawl.tools.checkstyle.api.Utils;
public class FilesFilter
extends AutomaticBean
implements Filter
{
private RE mFileRegexp;
public FilesFilter()
throws RESyntaxException
{
setFiles("^$");
}
public boolean accept(AuditEvent aEvent)
{
final String fileName = aEvent.getFileName();
return ((fileName == null) || !mFileRegexp.match(fileName));
}
public void setFiles(String aFilesPattern)
throws RESyntaxException
{
mFileRegexp = Utils.getRE(aFilesPattern);
}
}
checkstyle-5.6/contrib/examples/linkErrors2Source/build.xml 100644 0 0 5275 11451071612 21354 0 ustar 0 0
checkstyle-5.6/contrib/examples/linkErrors2Source/checkstyle-noframes.xsl 100644 0 0 15125 11451071612 24244 0 ustar 0 0
MailLogger.failure.to [required if failure mail to be sent] - Address
* to send failure messages to
*
MailLogger.success.to [required if success mail to be sent] - Address
* to send success messages to
*
MailLogger.failure.subject [default: "Build Failure"] - Subject of
* failed build
*
MailLlistener.success.subject [default: "Build Success"] - Subject of
* successful build
*
* These properties are set using standard property setting mechanisms
* (command-line -D, ant <property>, etc).Properties can be overridden
* by specifying the filename of a properties file in the
* MailLogger.properties.file property . Any properties defined in that
* file will override properties.
* Based on
* org.apache.tools.ant.listener.MailLogger>org.apache.tools.ant.listener.MailLogger
* @author Erik Hatcher
* ehatcher@apache.org
* @author Rick Giles
*/
public class MailLogger
implements AuditListener
{
/** output stream for logger */
private ByteArrayOutputStream mOutputStream;
/** adapted listener */
private DefaultLogger mLogger;
/** count of the number of errors and exceptions */
private int mErrors;
/**
* Constructs a MailLogger
*/
public MailLogger()
{
mOutputStream = new ByteArrayOutputStream();
mLogger = new DefaultLogger(mOutputStream, false);
mErrors = 0;
}
/** @see com.puppycrawl.tools.checkstyle.api.AuditListener */
public void auditStarted(AuditEvent aEvt)
{
mLogger.auditStarted(aEvt);
}
/**
* Sends an e-mail with the log results.
* @see com.puppycrawl.tools.checkstyle.api.AuditListener
*/
public void auditFinished(AuditEvent aEvt)
{
mLogger.auditFinished(aEvt);
final Properties properties = System.getProperties();
// overlay specified properties file (if any), which overrides project
// settings
final Properties fileProperties = new Properties();
final String filename =
(String) properties.get("MailLogger.properties.file");
if (filename != null) {
InputStream is = null;
try {
is = new FileInputStream(filename);
fileProperties.load(is);
}
catch (IOException ioe) {
// ignore because properties file is not required
;
}
finally {
if (is != null) {
try {
is.close();
}
catch (IOException e) {
;
}
}
}
}
for (Enumeration e = fileProperties.keys(); e.hasMoreElements();) {
final String key = (String) e.nextElement();
final String value = fileProperties.getProperty(key);
properties.put(key, value);
}
final boolean success = (mErrors == 0);
final String prefix = success ? "success" : "failure";
try {
final String mailhost =
getValue(properties, "mailhost", "localhost");
final String from = getValue(properties, "from", null);
final String toList = getValue(properties, prefix + ".to", null);
final String subject = getValue(properties, prefix + ".subject",
(success)
? "Checkstyle Audit Success"
: "Checkstyle Audit Failure");
sendMail(mailhost, from, toList, subject, mOutputStream.toString());
}
catch (Exception e) {
System.out.println("MailLogger failed to send e-mail!");
e.printStackTrace(System.err);
}
}
/** @see com.puppycrawl.tools.checkstyle.api.AuditListener */
public void fileStarted(AuditEvent aEvt)
{
mLogger.fileStarted(aEvt);
}
/** @see com.puppycrawl.tools.checkstyle.api.AuditListener */
public void fileFinished(AuditEvent aEvt)
{
mLogger.fileFinished(aEvt);
}
/** @see com.puppycrawl.tools.checkstyle.api.AuditListener */
public void addError(AuditEvent aEvt)
{
if (SeverityLevel.ERROR.equals(aEvt.getSeverityLevel())) {
mLogger.addError(aEvt);
mErrors++;
}
}
/** @see com.puppycrawl.tools.checkstyle.api.AuditListener */
public void addException(AuditEvent aEvt, Throwable aThrowable)
{
mLogger.addException(aEvt, aThrowable);
mErrors++;
}
/**
* Gets the value of a property.
*
* @param aProperties Properties to obtain value from.
* @param aName suffix of property name. "MailLogger." will be
* prepended internally.
* @param aDefaultValue value returned if not present in the properties.
* Set to null to make required.
* @return The value of the property, or default value.
* @throws CheckstyleException if no default value is specified and the
* property is not present in properties.
*/
private String getValue(Properties aProperties, String aName,
String aDefaultValue) throws CheckstyleException
{
final String propertyName = "MailLogger." + aName;
String value = (String) aProperties.get(propertyName);
if (value == null) {
value = aDefaultValue;
}
if (value == null) {
throw new CheckstyleException(
"Missing required parameter: " + propertyName);
}
return value;
}
/**
* Send the mail
*
* @param aMailhost mail server
* @param aFrom from address
* @param aToList comma-separated recipient list
* @param aSubject mail subject
* @param aText mail body
* @throws Exception if sending message fails
*/
private void sendMail(String aMailhost, String aFrom, String aToList,
String aSubject, String aText)
throws Exception
{
// Get system properties
final Properties props = System.getProperties();
// Setup mail server
props.put("mail.smtp.host", aMailhost);
// Get session
final Session session = Session.getDefaultInstance(props, null);
// Define message
final MimeMessage message = new MimeMessage(session);
message.setFrom(new InternetAddress(aFrom));
final StringTokenizer t = new StringTokenizer(aToList, ", ", false);
while (t.hasMoreTokens()) {
message.addRecipient(
MimeMessage.RecipientType.TO,
new InternetAddress(t.nextToken()));
}
message.setSubject(aSubject);
message.setText(aText);
Transport.send(message);
}
}
checkstyle-5.6/contrib/examples/listeners/com/mycompany/listeners/VerboseListener.java 100644 0 0 6537 11451071612 26730 0 ustar 0 0 package com.mycompany.listeners;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.OutputStream;
import java.io.PrintWriter;
import com.puppycrawl.tools.checkstyle.api.AuditEvent;
import com.puppycrawl.tools.checkstyle.api.AuditListener;
import com.puppycrawl.tools.checkstyle.api.AutomaticBean;
import com.puppycrawl.tools.checkstyle.api.SeverityLevel;
/**
* An AuditListener that reports every event to an output stream.
* @author Rick Giles
*/
public class VerboseListener
extends AutomaticBean
implements AuditListener
{
/** where to write messages */
private PrintWriter mWriter = new PrintWriter(System.out);
/** close output stream */
private boolean mCloseOut = false;
/** total number of errors and exceptions */
private int mTotalErrors;
/** number of errors and exceptions in the audit of one file */
private int mErrors;
/**
* Sets the output stream to a file.
* @param aFileName name of the output file.
* @throws FileNotFoundException if an error occurs.
*/
public void setFile(String aFileName)
throws FileNotFoundException
{
final OutputStream out = new FileOutputStream(aFileName);
mWriter = new PrintWriter(out);
mCloseOut = true;
}
/** @see com.puppycrawl.tools.checkstyle.api.AuditListener */
public void auditStarted(AuditEvent aEvt)
{
mTotalErrors = 0;
mWriter.println("Audit started.");
}
/** @see com.puppycrawl.tools.checkstyle.api.AuditListener */
public void auditFinished(AuditEvent aEvt)
{
mWriter.println("Audit finished. Total errors: " + mTotalErrors);
mWriter.flush();
if (mCloseOut) {
mWriter.close();
}
}
/** @see com.puppycrawl.tools.checkstyle.api.AuditListener */
public void fileStarted(AuditEvent aEvt)
{
mErrors = 0;
mWriter.println(
"Started checking file '" + aEvt.getFileName() + "'.");
}
/** @see com.puppycrawl.tools.checkstyle.api.AuditListener */
public void fileFinished(AuditEvent aEvt)
{
mWriter.println("Finished checking file '" + aEvt.getFileName()
+ "'. Errors: " + mErrors);
}
/** @see com.puppycrawl.tools.checkstyle.api.AuditListener */
public void addError(AuditEvent aEvt)
{
printEvent(aEvt);
if (SeverityLevel.ERROR.equals(aEvt.getSeverityLevel())) {
mErrors++;
mTotalErrors++;
}
}
/** @see com.puppycrawl.tools.checkstyle.api.AuditListener */
public void addException(AuditEvent aEvt, Throwable aThrowable)
{
printEvent(aEvt);
aThrowable.printStackTrace(System.out);
mErrors++;
mTotalErrors++;
}
/**
* Prints event information to standard output.
* @param aEvt the event to print.
*/
private void printEvent(AuditEvent aEvt)
{
mWriter.println("Logging error -"
+ " file: '" + aEvt.getFileName() + "'"
+ " line: " + aEvt.getLine()
+ " column: " + aEvt.getColumn()
+ " severity: " + aEvt.getSeverityLevel()
+ " message: " + aEvt.getMessage()
+ " source: " + aEvt.getSourceName());
}
}
checkstyle-5.6/contrib/examples/XInclude/config.xml 100644 0 0 1145 11451071612 17630 0 ustar 0 0
]>
checkstyle-5.6/contrib/examples/XInclude/index.html 100644 0 0 13157 11451071612 17664 0 ustar 0 0
XInclude Processing
XInclude Processing
Description
This is an example of how you can separate a Checkstyle configuration file
into several files and process the configuration using
XInclude processing.
This requires a SAX parser that supports XML namespaces.
First we give an example a SAX parser factory that produces parsers supporting XML namespaces
and indicate how to configure your system to use this factory.
Then we give an example XML configuration files with XInclude processing and
an ant target that uses the Checkstyle ant task
to check a Java source file with the configuration files.
Parsers
SAX parser factory NamespacesSAXParserFactoryImpl
is an example of a factory that produces parsers
supporting XML namespaces:
package com.puppycrawl.tools.checkstyle;
import org.apache.xerces.jaxp.SAXParserFactoryImpl;
/**
* A parser factory that produces parsers that support XML namespaces.
* @author Rick Giles
* @version May 28, 2004
*/
public class NamespacesSAXParserFactoryImpl extends SAXParserFactoryImpl
{
/**
* Constructs a NamespacesSAXParserFactoryImpl. Initializes
* it to produce parsers that support XML namespaces.
*/
public NamespacesSAXParserFactoryImpl()
{
super();
setNamespaceAware(true);
}
}
In order to use NamespacesSAXParserFactoryImpl as the
SAX parser factory, place NamespacesSAXParserFactoryImpl
in the classpath and
configure your system
to load
NamespacesSAXParserFactoryImpl
as the SAXParserFactory.
For example, you can create a file called jaxp.properties
in the lib subdirectory of the JRE installation with contents
XInclude processing requires an XML parser that implements XML inclusions.
Here we use the Xerces parser
that is in the ant distribution. In order
to enable Xinclude processing,
you can change the parser configuration by creating a file called xerces.properties
in the lib subdirectory of the JRE installation with contents
Notice that the configuration of treewalker.xml
applies property ${typename.format}.
That propery is set in the following segment of an ant build file that uses the
Checkstyle ant task to check file InputHeader.java
with the configuration of config.xml:
checkstyle-5.6/contrib/examples/XInclude/NamespacesSAXParserFactoryImpl.java 100644 0 0 1065 11451071612 24467 0 ustar 0 0 package com.puppycrawl.tools.checkstyle;
import org.apache.xerces.jaxp.SAXParserFactoryImpl;
/**
* A parser factory that produces parsers that support XML namespaces.
* @author Rick Giles
* @version May 28, 2004
*/
public class NamespacesSAXParserFactoryImpl extends SAXParserFactoryImpl
{
/**
* Constructs a NamespacesSAXParserFactoryImpl. Initializes
* it to produce parsers that support XML namespaces.
*/
public NamespacesSAXParserFactoryImpl()
{
super();
setNamespaceAware(true);
}
}
checkstyle-5.6/contrib/examples/XInclude/treewalker.xml 100644 0 0 403 11451071612 20504 0 ustar 0 0
checkstyle-5.6/contrib/hooks/git-pre-commit-hook.pl 100644 0 0 3563 11451071612 17571 0 ustar 0 0 #!/usr/bin/perl
#
# Pre-commit hook for running checkstyle on changed Java sources
#
# To use this you need:
# 1. checkstyle's jar file somewhere
# 2. a checkstyle XML check file somewhere
# 3. To configure git:
# * git config --add checkstyle.jar
# * git config --add checkstyle.checkfile
# * git config --add java.command [optional
# defaults to assuming it's in your path]
# 4. Put this in your .git/hooks directory as pre-commit
#
# Now, when you commit, you will be disallowed from doing so
# until you pass your checkstyle checks.
$command = "git-diff-index --cached HEAD 2>&1 | sed 's/^:.* //' | uniq";
open (FILES,$command . "|") || die "Cannot run '$command': $!\n";
$CONFIG_CHECK_FILE = "checkstyle.checkfile";
$CONFIG_JAR = "checkstyle.jar";
$CONFIG_JAVA = "java.command";
$check_file = `git config --get $CONFIG_CHECK_FILE`;
$checkstyle_jar = `git config --get $CONFIG_JAR`;
$java_command = `git config --get $CONFIG_JAVA`;
if (!$check_file || !$checkstyle_jar)
{
die "You must configure checkstyle in your git config:\n"
. "\t$CONFIG_CHECK_FILE - path to your checkstyle.xml file\n"
. "\t$CONFIG_JAR - path to your checkstyle jar file\n"
. "\t$CONFIG_JAVA - path to your java executable (optional)\n"
;
}
$java_command = "java" if (!$java_command);
chomp $check_file;
chomp $checkstyle_jar;
chomp $java_command;
$command = "$java_command -jar $checkstyle_jar -c $check_file";
@java_files = ();
foreach ()
{
chomp;
next if (!(/\.java$/));
push @java_files,$_;
$command .= " ";
$command .= $_;
}
if ($#java_files >= 0)
{
if (&run_and_log_system ($command))
{
print STDERR "Commit aborted.\n";
exit -1;
}
}
exit 0;
sub run_and_log_system
{
($cmd) = @_;
system $cmd;
} checkstyle-5.6/contrib/JavadocCheckDefault.java 100644 0 0 4103 11451071611 16761 0 ustar 0 0
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Tool that generates Javadoc description of the default tokens for a Check.
* @author Rick Giles
* @version 27-Nov-2002
*/
public class JavadocCheckDefault
{
private static void usage()
{
System.out.println("Usage: java JavadocCheckDefault check element");
System.exit(0);
}
public static void main(String[] args)
{
if (args.length < 2) {
usage();
}
final String header =
" *
By default the check will check the following "
+ args[1] + ":\n";
final String footer = ".\n *
\n";
final String prefix = " * {@link TokenTypes#";
try {
final Class clazz = Class.forName(args[0]);
final Check check = (Check) clazz.newInstance();
final int[] defaultTokens = check.getDefaultTokens();
if (defaultTokens.length > 0) {
final StringBuffer buf = new StringBuffer();
buf.append(header);
final ArrayList tokenNames = new ArrayList();
for (int i = 0; i < defaultTokens.length; i++) {
tokenNames.add(TokenTypes.getTokenName(defaultTokens[i]));
}
Collections.sort(tokenNames);
final Iterator it = tokenNames.iterator();
String token = (String) it.next();
buf.append(prefix + token + " " + token + "}");
while (it.hasNext()) {
token = (String) it.next();
buf.append(",\n" + prefix + token + " " + token + "}");
}
buf.append(footer);
System.out.println(buf);
}
}
catch (Exception ex) {
ex.printStackTrace();
System.exit(0);
}
}
}
././@LongLink 100644 0 0 161 12026055133 10246 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/AbstractUsageCheck.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/AbstractUsa100644 0 0 14675 11451071612 31362 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2005 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.usage;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
import com.puppycrawl.tools.checkstyle.checks.usage.transmogrify.ASTManager;
import com.puppycrawl.tools.checkstyle.checks.usage.transmogrify.ClassManager;
import com.puppycrawl.tools.checkstyle.checks.usage.transmogrify.Definition;
import com.puppycrawl.tools.checkstyle.checks.usage.transmogrify.SymTabAST;
import com.puppycrawl.tools.checkstyle.checks.usage.transmogrify.
SymbolTableException;
import java.util.Iterator;
import java.util.Set;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.apache.commons.beanutils.ConversionException;
/**
* Performs a usage check for fields, methods, parameters, variables.
* @author Rick Giles
*/
public abstract class AbstractUsageCheck
extends Check
{
/** the regexp to match against */
private Pattern mRegexp;
/** the format string of the regexp */
private String mIgnoreFormat;
/**
* Constructs an AbstractUsageCheck.
*/
public AbstractUsageCheck()
{
setIgnoreFormat("^$");
}
/**
* Set the ignore format to the specified regular expression.
* @param aFormat a String value
* @throws ConversionException unable to parse aFormat
*/
public void setIgnoreFormat(String aFormat)
throws ConversionException
{
try {
mRegexp = Utils.getPattern(aFormat);
mIgnoreFormat = aFormat;
}
catch (PatternSyntaxException e) {
throw new ConversionException("unable to parse " + aFormat, e);
}
}
/** @return the regexp to match against */
public Pattern getRegexp()
{
return mRegexp;
}
/** @return the regexp format */
public String getIgnoreFormat()
{
return mIgnoreFormat;
}
/** @see com.puppycrawl.tools.checkstyle.api.Check */
public void beginTree(DetailAST aRootAST)
{
// use my class loader
ClassManager.setClassLoader(getClassLoader());
final String fileName = getFileContents().getFilename();
getASTManager().addTree(fileName, aRootAST);
}
/** @see com.puppycrawl.tools.checkstyle.api.Check */
public void visitToken(DetailAST aAST)
{
if (mustCheckReferenceCount(aAST)) {
final DetailAST nameAST = aAST.findFirstToken(TokenTypes.IDENT);
Pattern regexp = getRegexp();
if ((regexp == null)
|| !regexp.matcher(nameAST.getText()).find())
{
getASTManager().registerCheckNode(this, nameAST);
}
}
}
/** @see com.puppycrawl.tools.checkstyle.api.Check */
public void finishTree(DetailAST aAST)
{
if (aAST == null) {
// we have nothing to check
return;
}
try {
final Set nodes = getASTManager().getCheckNodes(this);
if (nodes != null) {
applyTo(nodes);
}
}
catch (SymbolTableException ste) {
logError(ste);
}
getASTManager().removeCheck(this);
}
/**
* Logs an exception.
* @param aException the exception to log.
*/
public void logError(Exception aException)
{
log(0, "general.exception", new String[] {aException.getMessage()});
Utils.getExceptionLogger().debug("An exception occured.", aException);
}
/**
* Determines the reference count for a DetailAST.
* @param aAST the DetailAST to count.
* @return the number of references to aAST.
*/
private int getReferenceCount(DetailAST aAST)
{
final SymTabAST ident = getASTManager().get(aAST);
if (ident == null) {
return 0;
}
final Definition definition =
(Definition) ident.getDefinition();
if (definition != null) {
return definition.getNumReferences();
}
return 0;
}
/**
* Returns the key for the Checkstyle error message.
* @return the key for the Checkstyle error message.
*/
public abstract String getErrorKey();
/**
* Determines whether the reference count of an aAST is required.
* @param aAST the node to check.
* @return true if the reference count of aAST is required.
*/
public abstract boolean mustCheckReferenceCount(DetailAST aAST);
/**
* Applies this check to a set of nodes.
* @param aNodes the nodes to check.
*/
public void applyTo(Set aNodes)
{
final Iterator it = aNodes.iterator();
while (it.hasNext()) {
final DetailAST nameAST = (DetailAST) it.next();
if (getReferenceCount(nameAST) == 1) {
log(
nameAST.getLineNo(),
nameAST.getColumnNo(),
getErrorKey(),
nameAST.getText());
}
}
}
/**
* Gets the manager for AST nodes.
* @return the AST manager.
*/
protected ASTManager getASTManager()
{
return ASTManager.getInstance();
}
}
././@LongLink 100644 0 0 155 12026055133 10251 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/messages.properties checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/messages.pr100644 0 0 367 11451071612 31326 0 ustar 0 0 one.method.private.field=Field ''{0}'' is used in only one method.
unused.local=Unused local variable ''{0}''.
unused.parameter=Unused parameter ''{0}''.
unused.field=Unused private field ''{0}''.
unused.method=Unused private method ''{0}''.
././@LongLink 100644 0 0 160 12026055133 10245 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/messages_fi.properties checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/messages_fi100644 0 0 462 11451071612 31360 0 ustar 0 0 one.method.private.field=Muuttujaa ''{0}'' k¤ytet¤¤n vain yhdess¤ metodissa.
unused.local=K¤ytt¤m¤ton paikallinen muuttuja ''{0}''.
unused.parameter=K¤ytt¤m¤tĥn parameteri ''{0}''.
unused.field=K¤ytt¤m¤tĥn private muuttuja ''{0}''.
unused.method=K¤ytt¤m¤tĥn private metodi ''{0}''.
././@LongLink 100644 0 0 160 12026055133 10245 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/messages_fr.properties checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/messages_fr100644 0 0 435 11451071612 31371 0 ustar 0 0 one.method.private.field=L''attribut privé ''{0}'' est utilisé dans une seule méthode.
unused.local=Variable locale non utilisée ''{0}''.
unused.parameter=Paramètre ''{0}'' inutilisé.
unused.field=Attribut privé ''{0}'' inutilisé.
unused.method=Méthode privée ''{0}'' inutilisée.
././@LongLink 100644 0 0 171 12026055133 10247 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/OneMethodPrivateFieldCheck.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/OneMethodPr100644 0 0 12265 11451071612 31323 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2005 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.usage;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.Scope;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.usage.transmogrify.Definition;
import com.puppycrawl.tools.checkstyle.checks.usage.transmogrify.Reference;
import com.puppycrawl.tools.checkstyle.checks.usage.transmogrify.SymTabAST;
/**
*
Checks that a private field is used in more than one method,
* constructor, or initializer.
*
*
* Rationale: a private field used in only one method, constructor, or
* initializer should be replaced by a local variable.
*
*
* An example of how to configure the check is:
*
*
* <module name="usage.OneMethodPrivateField"/>
*
*
* @author Rick Giles
*/
public class OneMethodPrivateFieldCheck
extends AbstractUsageCheck
{
/** @see com.puppycrawl.tools.checkstyle.api.Check */
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.VARIABLE_DEF,
};
}
/** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
public String getErrorKey()
{
return "one.method.private.field";
}
/** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
public boolean mustCheckReferenceCount(DetailAST aAST)
{
final DetailAST mods = aAST.findFirstToken(TokenTypes.MODIFIERS);
return ((mods != null)
&& (ScopeUtils.getScopeFromMods(mods) == Scope.PRIVATE));
}
/** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
public void applyTo(Set aNodes)
{
// apply the check to each private field
final Set methods = new HashSet();
final Iterator it = aNodes.iterator();
while (it.hasNext()) {
methods.clear();
final DetailAST nameAST = (DetailAST) it.next();
// find methods using the field
final Iterator refIt = getReferences(nameAST);
while (refIt.hasNext()) {
final Reference ref = (Reference) refIt.next();
final SymTabAST refNode = ref.getTreeNode();
final DetailAST refDetail = refNode.getDetailNode();
// don't need to check a self-reference
if (refDetail == nameAST) {
continue;
}
DetailAST parent = refDetail.getParent();
while (parent != null) {
final int type = parent.getType();
if ((type == TokenTypes.METHOD_DEF)
|| (type == TokenTypes.CTOR_DEF)
|| (type == TokenTypes.INSTANCE_INIT)
|| (type == TokenTypes.STATIC_INIT))
{
methods.add(parent);
break;
}
// initializer for inner class?
else if (type == TokenTypes.CLASS_DEF) {
break;
}
parent = parent.getParent();
}
}
if (methods.size() == 1) {
log(
nameAST.getLineNo(),
nameAST.getColumnNo(),
getErrorKey(),
nameAST.getText());
}
}
}
/**
* Returns the references to an AST.
* @param aAST the AST for the references.
* @return an iterator for the references to aAST.
*/
private Iterator getReferences(DetailAST aAST)
{
final SymTabAST ident = getASTManager().get(aAST);
final Definition definition =
(Definition) ident.getDefinition();
if (definition != null) {
return definition.getReferences();
}
final Set dummy = new HashSet();
return dummy.iterator();
}
}
././@LongLink 100644 0 0 146 12026055133 10251 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/package.html checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/package.htm100644 0 0 266 11451071612 31257 0 ustar 0 0
Contains the Usage checks that are bundled with the main distribution.
././@LongLink 100644 0 0 177 12026055133 10255 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/AnonymousInnerClass.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 5002 11451071612 31441 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
public class AnonymousInnerClass extends ClassDef {
protected SymTabAST _objblock;
protected SymTabAST _classExtended;
public AnonymousInnerClass(SymTabAST objblock,
SymTabAST classExtended,
Scope parentScope) {
super(parentScope.getName() + "$" + parentScope.getEnclosingClass().getNextAnonymousId(),
parentScope,
objblock);
_objblock = objblock;
_classExtended = classExtended;
}
public void finishMakingDefinition() {
if (_classExtended != null) {
String extendedClassName = ASTUtil.constructDottedName(_classExtended);
IClass superclass = getClassDefinition(extendedClassName);
if (superclass != null) {
setSuperclass(superclass);
superclass.addSubclass(this);
}
}
}
}
././@LongLink 100644 0 0 164 12026055133 10251 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ArrayDef.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 10407 11451071612 31466 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Vector;
//import com.puppycrawl.tools.checkstyle.checks.lint.parser.JavaTokenTypes;
public class ArrayDef implements IClass {
private final static IVariable LENGTH_MEMBER = new ArrayLengthMember();
private IClass _type;
public ArrayDef(IClass type){
_type = type;
}
public IClass getType(){
return _type;
}
public IClass getSuperclass() {
return new ArrayDef(getType().getSuperclass());
}
public IClass[] getInterfaces() {
return new IClass[0];
}
public IClass[] getInnerClasses() {
return new IClass[0];
}
public IClass getClassDefinition(String name) {
return null;
}
public IMethod getMethodDefinition(String name,
ISignature signature) {
return new ExternalClass(Object.class).getMethodDefinition(name,
signature);
}
public IVariable getVariableDefinition(String name) {
IVariable result = null;
if (name.equals("length")) {
result = LENGTH_MEMBER;
}
return result;
}
public void addSubclass(ClassDef subclass) {}
public void addReference(Reference reference) {}
public Iterator getReferences() {
return new Vector().iterator();
}
public int getNumReferences() {
return 0;
}
public List getSubclasses() {
return new ArrayList();
}
public void addImplementor(ClassDef implementor) {}
public List getImplementors() {
return new ArrayList();
}
public boolean isCompatibleWith(IClass type) {
boolean result = false;
if (type.equals(new ExternalClass(Object.class))) {
result = true;
}
else if (type instanceof ArrayDef) {
result = getType().isCompatibleWith(((ArrayDef)type).getType());
}
return result;
}
public boolean isSourced() {
return getType().isSourced();
}
public String getName() {
return getType().getName() + "[]";
}
public String getQualifiedName() {
return getType().getQualifiedName() + "[]";
}
public boolean isPrimitive() {
return false;
}
public boolean equals(Object obj) {
boolean result = false;
if (obj instanceof ArrayDef) {
ArrayDef compared = (ArrayDef)obj;
result = (getType().equals(compared.getType()));
}
return result;
}
public int hashCode() {
return getType().hashCode();
}
public String toString() {
return getQualifiedName() + "[]";
}
}
././@LongLink 100644 0 0 175 12026055133 10253 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ArrayLengthMember.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 3735 11451071612 31454 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
public class ArrayLengthMember extends ExternalVariable {
public ArrayLengthMember() {
super(null);
}
public String getName() {
return "length";
}
public String getQualifiedName() {
return getName();
}
public IClass getType() {
return LiteralResolver.getDefinition("int");
}
}
././@LongLink 100644 0 0 166 12026055133 10253 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ASTManager.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 15565 11451071612 31500 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// 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.usage.transmogrify;
import java.io.File;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import antlr.collections.AST;
import com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck;
/**
* Manages AST trees and nodes. Capable of managing multiple parse trees, which
* is useful for inter-file checks.
* @author Rick Giles
*/
public final class ASTManager
{
/** singleton */
private static final ASTManager INSTANCE = new ASTManager();
/**
* Maps DetailASTs to SymTabASTs.
* A HashMap is acceptable provided DetailAST method hashCode() returns
* distinct integers for distinct objects.
* If not, a structure such as IdentityHashMap must be employed.
*/
private Map mMap = new HashMap();
/** root with subtrees for a set of files */
private SymTabAST mCompleteTree = null;
/** Map for parse trees, keyed on File name */
private Map mTrees = new HashMap();
/** Set of checks and their nodes to check */
private Map mCheckNodes = new HashMap();
/** prevent client creation */
private ASTManager()
{
}
/**
* Returns the singleon ASTManager.
* @return the singleon ASTManager.
*/
public static ASTManager getInstance()
{
return INSTANCE;
}
/**
* Add the parse tree for a file to the set of parse trees.
* Postcondition: since all checks are local to one source file,
* all managed elements are cleared.
* @param aFileName the name of the file.
* @param aRoot the root of the AST.
*/
public void addTree(String aFileName, AST aRoot)
{
clear();
mTrees.put(aFileName, aRoot);
}
/**
* Clears all managed elements.
*/
private void clear() {
mCheckNodes.clear();
mTrees.clear();
mMap.clear();
mCompleteTree = null;
}
/**
* Builds the complete tree for all added parse trees.
* @throws SymbolTableException if there is an error.
*/
private void buildTree()
throws SymbolTableException
{
mCompleteTree = SymTabASTFactory.create(0, "AST Root");
final Set keys = mTrees.keySet();
final Iterator it = keys.iterator();
while (it.hasNext()) {
final String fileName = (String) it.next();
final File file = new File(fileName);
final AST rootAST = (AST) mTrees.get(fileName);
addToCompleteTree(file, rootAST);
}
// Walk of the complete tree.
// TODO: This is a hack. Find a better way.
new TableMaker(mCompleteTree).getTable();
}
/**
* Adds a file and a DetailAST to the root SymTabAST tree. Normally, the
* DetailAST will be the parse tree for the file.
* @param aFile the file to add.
* @param aAST the DetailAST to add.
*/
private void addToCompleteTree(File aFile, AST aAST)
{
// add aFile to the root
final SymTabAST fileNode =
SymTabASTFactory.create(0, aFile.getAbsolutePath());
fileNode.setFile(aFile);
mCompleteTree.addChild(fileNode);
fileNode.setParent(mCompleteTree);
// add aAST to aFile
final SymTabAST child = SymTabASTFactory.create(aAST);
child.setFile(aFile);
fileNode.addChild(child);
child.setParent(fileNode);
fileNode.finishDefinition(aFile, mCompleteTree);
}
/**
* Registers a node for checking.
* @param aCheck the check to apply.
* @param aNode the node to check.
*/
public void registerCheckNode(AbstractUsageCheck aCheck, AST aNode)
{
Set nodeSet = (Set) mCheckNodes.get(aCheck);
if (nodeSet == null) {
nodeSet = new HashSet();
nodeSet.add(aNode);
mCheckNodes.put(aCheck, nodeSet);
}
else {
nodeSet.add(aNode);
}
}
/**
* Gets the nodes to check with a usage check.
* @param aCheck the usage check.
* @return the nodes to check with aCheck.
* @throws SymbolTableException if there is an error.
*/
public Set getCheckNodes(AbstractUsageCheck aCheck)
throws SymbolTableException
{
// lazy initialization
if (mCompleteTree == null) {
buildTree();
}
Set result = (Set) mCheckNodes.get(aCheck);
if (result == null) {
result = new HashSet();
}
return result;
}
/**
* Maps a AST to its associated SymTabAST.
* @param aAST the AST.
* @param aSymTabAST the SymTabAST associated with aAST.
*/
public void put(AST aAST, SymTabAST aSymTabAST)
{
mMap.put(aAST, aSymTabAST);
}
/**
* Gets the SymTabAST associated with a AST.
* @param aAST the AST.
* @return the the SymTabAST associated with aAST.
*/
public SymTabAST get(AST aAST)
{
return (SymTabAST) mMap.get(aAST);
}
/**
* Clears all associations from DetailsASTs to SymTabASTs.
*/
public void clearDetailsMap()
{
mMap.clear();
}
/**
* Determines whether the map from DetailsASTs to SymTabASTs is empty.
* @return true if the map is empty.
*/
public boolean isEmptyDetailsMap()
{
return mMap.isEmpty();
}
/**
* Removes a check and its check nodes. Clears all managed elements if
* last check removed.
* @param aCheck the check to remove.
*/
public void removeCheck(AbstractUsageCheck aCheck)
{
mCheckNodes.remove(aCheck);
if (mCheckNodes.isEmpty()) {
clear();
}
}
}
././@LongLink 100644 0 0 163 12026055133 10250 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ASTUtil.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 17130 11451071612 31466 0 ustar 0 0 // Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.io.File;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* ASTUtil is a Utility Class that contains utility code
* for managing our SymTabAST.
*
* @see Definition
* @see TypedDef
*/
public class ASTUtil {
/**
* gets a line number for the tree; if the current SymTabAST node does not have one associated
* with it, traverse its children until a line number is found. Failure results in line
* number value of 0.
*
* @param tree the SymTabAST to process
*
* @return int the resulting line number (0 if none is found)
*/
public static int getLine(SymTabAST tree) {
SymTabAST indexedNode = tree;
// find a node that actually has line number info
if (indexedNode.getLineNo() == 0) {
indexedNode = (SymTabAST) indexedNode.getFirstChild();
while (indexedNode != null && indexedNode.getLineNo() == 0) {
indexedNode = (SymTabAST) indexedNode.getNextSibling();
}
if (indexedNode == null) {
// we're screwed
indexedNode = tree;
}
}
return indexedNode.getLineNo();
}
/**
* gets a column number for the tree; if the current SymTabAST node does not have one associated
* with it, traverse its children until a column number is found. Failure results in column
* number value of 0.
*
* @param tree the SymTabAST to process
*
* @return int the resulting line number (0 if none is found)
*/
public static int getColumn(SymTabAST tree) {
SymTabAST indexedNode = tree;
// find a node that actually has line number info
// REDTAG -- a label's ':' is a real token and has (the wrong) column info
// because it is the parent of the ident node that people will want
if (indexedNode.getColumnNo() == 0
|| indexedNode.getType() == TokenTypes.LABELED_STAT) {
indexedNode = (SymTabAST) indexedNode.getFirstChild();
while (indexedNode != null && indexedNode.getColumnNo() == 0) {
indexedNode = (SymTabAST) indexedNode.getNextSibling();
}
if (indexedNode == null) {
// we're screwed
indexedNode = tree;
}
}
return indexedNode.getColumnNo();
}
/**
* Builds the dotted name String representation of the object contained within
* the SymTabAST.
*
* @return String
* @param tree the SymTabAST contaning the entire hierarcy of the object
*/
public static String constructDottedName(SymTabAST tree) {
String result;
if (tree.getType() == TokenTypes.DOT) {
SymTabAST left = (SymTabAST) tree.getFirstChild();
SymTabAST right = (SymTabAST) left.getNextSibling();
result =
constructDottedName(left) + "." + constructDottedName(right);
}
else if (tree.getType() == TokenTypes.ARRAY_DECLARATOR) {
StringBuffer buf = new StringBuffer();
SymTabAST left = (SymTabAST) tree.getFirstChild();
SymTabAST right = (SymTabAST) left.getNextSibling();
buf.append(constructDottedName(left));
if (right != null) {
buf.append(".");
buf.append(constructDottedName(right));
}
buf.append(" []");
result = buf.toString();
}
else if (tree.getType() == TokenTypes.METHOD_CALL) {
result =
constructDottedName((SymTabAST) tree.getFirstChild()) + "()";
}
else {
result = tree.getText();
}
return result;
}
/**
* Returns the Package name in the hierarchy represented by the SymTabAST.
*
* @return String
* @param tree the SymTabAST contaning the entire hierarcy of the object
*/
public static String constructPackage(SymTabAST tree) {
String fullName = constructDottedName(tree);
return fullName.substring(0, fullName.lastIndexOf("."));
}
/**
* Returns the top Class name in the hierarchy represented by the SymTabAST.
*
* @return String
* @param tree the SymTabAST contaning the entire hierarcy of the object
*/
public static String constructClass(SymTabAST tree) {
String fullName = constructDottedName(tree);
return fullName.substring(
fullName.lastIndexOf(".") + 1,
fullName.length());
}
public static boolean treesBelowFilesAreEqual(
SymTabAST firstRoot,
File[] firstFiles,
SymTabAST secondRoot,
File[] secondFiles) {
boolean result = true;
if (firstFiles.length == secondFiles.length) {
for (int i = 0; i < firstFiles.length; i++) {
SymTabAST firstTree =
(SymTabAST) getFileNode(firstRoot, firstFiles[i])
.getFirstChild();
SymTabAST secondTree =
(SymTabAST) getFileNode(secondRoot, secondFiles[i])
.getFirstChild();
if (!firstTree.equalsList(secondTree)) {
result = false;
break;
}
}
}
else {
result = false;
}
return result;
}
public static SymTabAST getFileNode(SymTabAST root, File file)
{
SymTabAST result = null;
SymTabAST fileNode = (SymTabAST) root.getFirstChild();
while (fileNode != null && result == null) {
if (file.equals(fileNode.getFile())) {
result = fileNode;
}
fileNode = (SymTabAST) fileNode.getNextSibling();
}
return result;
}
}
././@LongLink 100644 0 0 165 12026055133 10252 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/BaseScope.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 6466 11451071612 31460 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
/**
* the bottom scope of the scope stack, contains some extra information
* to make resolution easier.
*/
public class BaseScope extends DefaultScope {
private SymbolTable table;
public BaseScope( SymbolTable symbolTable ) {
super("~BASE~", null, null);
this.table = symbolTable;
}
public boolean isBaseScope() {
return true;
}
public void addDefinition(IPackage def) {
elements.put(def.getName(), def);
}
/**
* gets the package associated with a fully qualified name
*
* @param fullyQualifiedName the name of the package
*
* @return the package that was gotten
*/
public IPackage getPackageDefinition(String fullyQualifiedName) {
return (IPackage)(table.getPackages().get(fullyQualifiedName));
}
public IClass getClassDefinition(String name) {
IClass result = null;
result = LiteralResolver.getDefinition(name);
if (result == null) {
int lastDot = name.lastIndexOf(".");
if (lastDot > 0) {
String packageName = name.substring(0, lastDot);
String className = name.substring(lastDot + 1);
IPackage pkg = getPackageDefinition(packageName);
if (pkg != null) {
result = pkg.getClass(className);
}
}
}
if (result == null) {
Class theClass = null;
try {
theClass = ClassManager.getClassLoader().loadClass(name);
result = new ExternalClass(theClass);
}
catch (ClassNotFoundException e) {
// no-op
}
catch (NoClassDefFoundError e) {
// no-op, checkstyle bug 842781
}
}
return result;
}
}
././@LongLink 100644 0 0 164 12026055133 10251 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/BlockDef.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 4275 11451071612 31454 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
/**
* BlockDef is a Scope which contains
* information about everything that defines a nameless block of java code.
* There are provisions for keeping the name of several anonymous
* blocks of java code within the same parent scope to have unique names.
*
* @see Scope
* @see Resolvable
*/
public class BlockDef extends DefaultScope
{
private static long id = 0;
public BlockDef(Scope parentScope, SymTabAST node)
{
super("~Anonymous~" + id++, parentScope, node);
}
}
././@LongLink 100644 0 0 164 12026055133 10251 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ClassDef.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 25566 11451071612 31502 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.Vector;
/**
* ClassDef contains all the information needed to
* represent a java class or interface. This includes the superclass,
* whether it's a class or an interface, the interfaces it implements,
* a list of its (direct?) subclasses, and the classes that implement
* it if it is an interface
*
* @see Scope
*/
public class ClassDef extends DefaultScope implements IClass {
private long id = 0;
private IClass superclass = null;
private List interfaces = new Vector();
private List subclasses = new Vector();
private List implementors = new Vector();
private Set importedPackages = new HashSet();
// variable definitions will use elements from parent
private Set methods = new HashSet();
private Hashtable imports = new Hashtable();
private Vector unprocessedImports = null;
protected MethodDef _defaultConstructor;
public ClassDef(String name, Scope parentScope, SymTabAST node) {
super(name, parentScope, node);
_defaultConstructor = new DefaultConstructor(this);
addDefinition(_defaultConstructor);
}
public long getNextAnonymousId() {
return ++id;
}
public void setSuperclass(IClass newSuperclass) {
this.superclass = newSuperclass;
}
public IClass getSuperclass() {
return superclass;
}
public void addUnprocessedImports(Vector aImports) {
unprocessedImports = (Vector) (aImports.clone());
}
public Vector getUnprocessedImports() {
return unprocessedImports;
}
public void importPackage(IPackage pkg) {
importedPackages.add(pkg);
}
public void importClass(IClass imported) {
imports.put(imported.getName(), imported);
}
// begin definitions interface
public void addDefinition(MethodDef method) {
if (method.getName().equals(getName())) {
methods.remove(_defaultConstructor);
}
methods.add(method);
}
protected Enumeration getDefinitions() {
Vector allElements = new Vector();
allElements.addAll(elements.values());
allElements.addAll(methods);
allElements.addAll(labels.values());
allElements.addAll(classes.values());
return allElements.elements();
}
public IClass getClassDefinition(String name) {
IClass result = null;
result = (ClassDef) (classes.get(name));
if (result == null) {
result = (IClass) (imports.get(name));
}
if (result == null) {
Iterator it = importedPackages.iterator();
while (it.hasNext() && result == null) {
IPackage pkg = (IPackage) it.next();
result = pkg.getClass(name);
}
}
if (result == null) {
result = getParentScope().getClassDefinition(name);
}
//TODO: check for a class in the same package?
if (result == null) {
final String packageName = getParentScope().getQualifiedName();
final String fullName = packageName + "." + name;
Class theClass = null;
try {
theClass = ClassManager.getClassLoader().loadClass(fullName);
result = new ExternalClass(theClass);
}
catch (ClassNotFoundException e) {
// no-op
}
}
return result;
}
public IMethod getMethodDefinition(String name, ISignature signature) {
IMethod result = null;
result = getDeclaredMethod(name, signature);
if (result == null) {
result = getMostCompatibleMethod(name, signature);
}
if (result == null) {
if (superclass != null) {
result = superclass.getMethodDefinition(name, signature);
}
}
if (result == null) {
IClass[] myInterfaces = getInterfaces();
for (int index = 0;
index < myInterfaces.length && result == null;
index++) {
result = myInterfaces[index].getMethodDefinition(name, signature);
}
}
// not sure why this is here -- inner classes, maybe?
// regardless, write better
if (result == null) {
if (getParentScope() != null) {
result = getParentScope().getMethodDefinition(name, signature);
}
}
return result;
}
public IMethod getMostCompatibleMethod(String name, ISignature signature) {
IMethod result = null;
SortedSet compatibleMethods =
new TreeSet(new MethodSpecificityComparator());
Iterator it = methods.iterator();
while (it.hasNext()) {
MethodDef method = (MethodDef) it.next();
if (name.equals(method.getName())) {
if (method.hasCompatibleSignature(signature)) {
compatibleMethods.add(method);
}
}
}
if (!compatibleMethods.isEmpty()) {
result = (IMethod) compatibleMethods.first();
}
return result;
}
public IMethod getDeclaredMethod(String name, ISignature signature) {
// finds methods declared by this class with the given signature
IMethod result = null;
Iterator it = methods.iterator();
while (it.hasNext()) {
MethodDef method = (MethodDef) it.next();
if (name.equals(method.getName())) {
if (method.hasSameSignature(signature)) {
result = method;
break;
}
}
}
return result;
}
public IVariable getVariableDefinition(String name) {
IVariable result = null;
// in keeping with getField in java.lang.Class
// 1) current class
// 2) direct superinterfaces
// 3) superclass
// then we do the parent scope in case its an inner class
result = (VariableDef) (elements.get(name));
if (result == null) {
IClass[] superinterfaces = getInterfaces();
for (int i = 0;
i < superinterfaces.length && result == null;
i++) {
result = superinterfaces[i].getVariableDefinition(name);
}
}
if (result == null) {
if (superclass != null) {
result = superclass.getVariableDefinition(name);
}
}
if (result == null) {
if (getParentScope() != null) {
result = getParentScope().getVariableDefinition(name);
}
}
return result;
}
// end definitions interface
public void addInterface(IClass implemented) {
interfaces.add(implemented);
}
public IClass[] getInterfaces() {
IClass[] type = new IClass[0];
return (IClass[]) interfaces.toArray(type);
}
public ClassDef getEnclosingClass() {
return this;
}
public void addSubclass(ClassDef subclass) {
subclasses.add(subclass);
}
public List getSubclasses() {
return subclasses;
}
public void addImplementor(ClassDef implementor) {
implementors.add(implementor);
}
public List getImplementors() {
return implementors;
}
public IClass[] getInnerClasses() {
Iterator it = getClasses();
List result = new ArrayList();
while (it.hasNext()) {
result.add(it.next());
}
return (IClass[]) result.toArray(new IClass[0]);
}
public boolean isSuperclassOf(IClass possibleChild) {
// justify my existence
boolean result = subclasses.contains(possibleChild);
/*
Iterator it = subclasses.iterator();
while (it.hasNext() && !result) {
IClass child = (IClass)it.next();
result = child.isSuperclassOf(possibleChild);
}
*/
return result;
}
public boolean isCompatibleWith(IClass type) {
boolean result = false;
// check myself
if (type.equals(this)) {
result = true;
}
// check my superclass
else if (superclass != null && superclass.isCompatibleWith(type)) {
result = true;
}
// check my interfaces
else if (!interfaces.isEmpty()) {
Iterator it = interfaces.iterator();
while (it.hasNext() && !result) {
IClass current = (IClass) it.next();
if (current.isCompatibleWith(type)) {
result = true;
}
}
}
return result;
}
public boolean isPrimitive() {
return false;
}
}
././@LongLink 100644 0 0 200 12026055133 10240 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ClassImportException.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 3432 11451071612 31446 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
public class ClassImportException extends SymbolTableException {
public ClassImportException(String name) {
super(name);
}
} ././@LongLink 100644 0 0 170 12026055133 10246 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ClassManager.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 3672 11451071612 31454 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
public class ClassManager {
private static ClassLoader _classLoader = ClassLoader.getSystemClassLoader();
public static void setClassLoader(ClassLoader classLoader) {
_classLoader = classLoader;
}
public static ClassLoader getClassLoader() {
return _classLoader;
}
} ././@LongLink 100644 0 0 176 12026055133 10254 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/DefaultConstructor.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 4712 11451071612 31450 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.Vector;
public class DefaultConstructor extends MethodDef {
protected ClassDef _classConstructed;
public DefaultConstructor(ClassDef classConstructed) {
super(classConstructed.getName(), classConstructed, null);
_classConstructed = classConstructed;
}
public IClass getType() {
return _classConstructed;
}
public ISignature getSignature() {
return new MethodSignature(new Vector());
}
public boolean equals(Object o) {
boolean result = false;
if (o instanceof DefaultConstructor) {
DefaultConstructor constructor = (DefaultConstructor)o;
result = getType().equals(constructor.getType());
}
return result;
}
public void setType() {}
public void addParameter() {}
public void addException() {}
}
././@LongLink 100644 0 0 170 12026055133 10246 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/DefaultScope.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 5744 11451071612 31456 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
public class DefaultScope extends Scope {
public DefaultScope(String name, Scope parentScope, SymTabAST node) {
super(name, parentScope, node);
}
public void addDefinition(IPackage def) {
throw new UnsupportedOperationException(getClass().getName());
}
public IClass getClassDefinition( String name ) {
IClass result = (ClassDef)classes.get(name);
if ( result == null && getParentScope() != null ) {
result = getParentScope().getClassDefinition( name );
}
return result;
}
public IMethod getMethodDefinition(String name,
ISignature signature) {
IMethod result = null;
if (getParentScope() != null) {
result = getParentScope().getMethodDefinition(name, signature);
}
return result;
}
public IVariable getVariableDefinition( String name ) {
IVariable result = (VariableDef)elements.get(name);
if ( result == null && getParentScope() != null ) {
result = getParentScope().getVariableDefinition( name );
}
return result;
}
public LabelDef getLabelDefinition(String name) {
LabelDef result = (LabelDef)labels.get(name);
if (result == null && getParentScope() != null) {
result = getParentScope().getLabelDefinition(name);
}
return result;
}
}
././@LongLink 100644 0 0 166 12026055133 10253 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/Definition.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 13443 11451071612 31471 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.Iterator;
import java.util.SortedSet;
import java.util.TreeSet;
/**
* Definition contains basic information for everything
* that is defined in a java source file. A definition has a list
* of References, an Occurrence, a name, and
* a parent Scope.
*
* @see Occurrence
* @see Scope
* @see Reference
*/
public abstract class Definition implements IDefinition, Comparable {
private String _name = null;
private Scope _parentScope = null;
private SymTabAST _node = null;
private SortedSet _references;
private Occurrence _occurrence = null;
public Definition(String name, Scope parentScope, SymTabAST node) {
_name = name;
_parentScope = parentScope;
_node = node;
_references = new TreeSet();
if ( node != null ) {
_occurrence = new Occurrence( _node.getFile(),
ASTUtil.getLine( _node ),
ASTUtil.getColumn( _node ));
}
}
public boolean isSourced() {
return true;
}
/**
* returns the name of the definition
*
* @return String
*/
public String getName() {
return _name;
}
/**
* returns the node in the AST that represents this definition
*
* @return the node in the AST that represents this definition
*/
public SymTabAST getTreeNode() {
return _node;
}
/**
* Adds a Reference to the collection of References
*
* @param reference the Reference to add
*/
public void addReference( Reference reference ) {
_references.add( reference );
}
/**
* Returns the References to this definition
*
* @return the References to this definition
*/
public Iterator getReferences() {
return _references.iterator();
}
public int getNumReferences() {
return _references.size();
}
/**
* Returns the scope in which this definition is defined
*
* @return the scope in which this definition is defined
*/
public Scope getParentScope() {
return _parentScope;
}
/**
* returns the fully qualifed name of this defintion. The name of
* the parentScope and all of its parents are considered when constructing
* this name.
*
* @return the fully qualified name of this definition
*/
public String getQualifiedName() {
String nameToUse = _name;
String result;
if (_name == null) {
nameToUse = "~NO NAME~";
}
if (getParentScope() != null &&
!(getParentScope() instanceof BaseScope)) {
result = getParentScope().getQualifiedName() + "." + nameToUse;
}
else {
result = nameToUse;
}
return result;
}
/**
* Returns the Occurrence for the location of this definition
*
* @return the Occurrence for the location of this definition
*/
public Occurrence getOccurrence() {
return _occurrence;
}
/**
* Returns the ClassDef that this scope is contained in.
*
* @return the ClassDef this definition is contained in
*/
public ClassDef getEnclosingClass() {
ClassDef result = null;
if ( getParentScope() != null ) {
result = getParentScope().getEnclosingClass();
}
return result;
}
public IPackage getEnclosingPackage() {
IPackage result = null;
if (getParentScope() != null) {
result = getParentScope().getEnclosingPackage();
}
return result;
}
/**
* returns a String representation of the definition. This string includes
* the class of the defintion and its qualified name
*
* @return String
*/
public String toString() {
return getClass().getName() + "[" + getQualifiedName() + "]";
}
public int compareTo(Object o) {
int result = 0;
if (!(o instanceof Definition)) {
throw new ClassCastException(o.getClass().getName());
}
result = getQualifiedName().compareTo(((Definition)o).getQualifiedName());
return result;
}
}
././@LongLink 100644 0 0 177 12026055133 10255 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/DefinitionTraverser.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 11203 11451071612 31461 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.Enumeration;
import java.util.Iterator;
public class DefinitionTraverser {
protected SymbolTable _symbolTable;
public DefinitionTraverser( SymbolTable symbolTable ) {
_symbolTable = symbolTable;
}
public void traverse() {
Enumeration packages = _symbolTable.getPackages().elements();
while ( packages.hasMoreElements() ) {
traverse( (PackageDef)(packages.nextElement()) );
}
}
private void traverse( Definition def ) {
if ( def instanceof PackageDef ) {
traverse( (PackageDef)def );
}
else if (def instanceof AnonymousInnerClass) {
traverse((AnonymousInnerClass)def);
}
else if ( def instanceof ClassDef ) {
traverse( (ClassDef)def );
}
else if (def instanceof DefaultConstructor) {
traverse((DefaultConstructor)def);
}
else if ( def instanceof MethodDef ) {
traverse( (MethodDef)def );
}
else if ( def instanceof BlockDef ) {
traverse( (BlockDef)def );
}
else if ( def instanceof VariableDef ) {
traverse( (VariableDef)def );
}
else if ( def instanceof LabelDef ) {
traverse( (LabelDef)def );
}
}
private void traverse(PackageDef pkg) {
handlePackage(pkg);
traversePackage(pkg);
}
private void traverse(AnonymousInnerClass innerClass) {
handleAnonymousInnerClass(innerClass);
traverseChildren(innerClass);
}
private void traverse( ClassDef classDef ) {
handleClass( classDef );
traverseChildren( classDef );
}
private void traverse(DefaultConstructor constructor) {
handleDefaultConstructor(constructor);
}
private void traverse( MethodDef method ) {
handleMethod( method );
traverseChildren( method );
}
private void traverse( BlockDef block ) {
handleBlock( block );
traverseChildren( block );
}
private void traverse( VariableDef variable ) {
handleVariable( variable );
}
private void traverse( LabelDef label ) {
handleLabel( label );
}
private void traversePackage(PackageDef pkg) {
Iterator definitions = pkg.getClasses();
while (definitions.hasNext()) {
ClassDef classDef = (ClassDef)definitions.next();
traverse(classDef);
}
}
private void traverseChildren(Scope scope) {
Enumeration definitions = scope.getDefinitions();
while ( definitions.hasMoreElements() ) {
Definition def = (Definition)(definitions.nextElement());
traverse(def);
}
}
protected void handlePackage( PackageDef pkg ) {}
protected void handleAnonymousInnerClass(AnonymousInnerClass innerClass) {}
protected void handleClass( ClassDef classDef ) {}
protected void handleDefaultConstructor(DefaultConstructor constructor) {}
protected void handleMethod( MethodDef method ) {}
protected void handleBlock( BlockDef block ) {}
protected void handleVariable( VariableDef variable ) {}
protected void handleLabel( LabelDef label ) {}
}
././@LongLink 100644 0 0 167 12026055133 10254 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/DotIterator.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 6643 11451071612 31455 0 ustar 0 0 // Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* An iterator for dot ('.') delimited tokens.
*
* @version 1.0
* @since 1.0
* @see Iterator
*/
public class DotIterator implements Iterator {
Iterator _nodesIter;
List _nodes;
public DotIterator(SymTabAST topNode)
{
_nodes = new ArrayList();
makeNodes(topNode);
_nodesIter = _nodes.iterator();
}
private void makeNodes(SymTabAST node)
{
if (node.getType() == TokenTypes.DOT) {
SymTabAST left = (SymTabAST) node.getFirstChild();
SymTabAST right = (SymTabAST) left.getNextSibling();
makeNodes(left);
makeNodes(right);
}
else {
_nodes.add(node);
}
}
/**
* Returns true if the iteration has more elements. (In other words,
* returns true if next would return an element rather than throwing an
* exception.)
*
* @return true if the iterator has more elements.
*/
public boolean hasNext()
{
return _nodesIter.hasNext();
}
/**
* Returns the next portion of the dotted name.
*
* @return the next node in the dotted name.
*/
public Object next()
{
return _nodesIter.next();
}
/**
* Returns the next portion of the dotted name.
*
* @return the next node in the dotted name.
*/
public SymTabAST nextNode()
{
return (SymTabAST) _nodesIter.next();
}
/**
* Unsupported operation.
*
*/
public void remove()
{
throw new UnsupportedOperationException();
}
}
././@LongLink 100644 0 0 171 12026055133 10247 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ExternalClass.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 24355 11451071612 31475 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
//import com.puppycrawl.tools.checkstyle.checks.lint.parser.DotUtils;
public class ExternalClass extends ExternalDefinition implements IClass {
private Class _javaClass;
private List _subclasses;
private List _implementors;
private Set _methods;
public ExternalClass(Class javaClass) {
_javaClass = javaClass;
_subclasses = new ArrayList();
_implementors = new ArrayList();
}
public Class getJavaClass() {
return _javaClass;
}
public String getName() {
return getLocalName();
}
private String getLocalName() {
String fullName = _javaClass.getName();
return fullName.substring(fullName.lastIndexOf(".") + 1);
}
public IClass getSuperclass() {
IClass result = null;
Class javaSuperclass = _javaClass.getSuperclass();
if (javaSuperclass != null) {
result = new ExternalClass(javaSuperclass);
}
else {
if (_javaClass.isInterface()) {
// according to Java, java.lang.Object is not the superclass of
// interfaces, which makes sense. However, we need Object to be
// the superclass of everything to make type compatibility work.
result = new ExternalClass(Object.class);
}
}
return result;
}
public IClass[] getInterfaces() {
Class[] javaInterfaces = _javaClass.getInterfaces();
IClass[] result = new IClass[javaInterfaces.length];
// should we cache this?
for (int i = 0; i < javaInterfaces.length; i++) {
result[i] = new ExternalClass(javaInterfaces[i]);
}
return result;
}
public IClass getClassDefinition(String name) {
IClass result = null;
String qualifiedName = getQualifiedName() + "$" + name;
Class[] classes = getJavaClass().getClasses();
for (int i = 0; i < classes.length; i++) {
String candidateQualifiedName = classes[i].getName();
if (qualifiedName.equals(candidateQualifiedName)) {
result = new ExternalClass(classes[i]);
break;
}
}
return result;
}
// REDTAG -- this should be a template method!
public IVariable getVariableDefinition(String name) {
IVariable result = null;
Field javaField = null;
try {
javaField = _javaClass.getDeclaredField(name);
}
catch (NoSuchFieldException ignoreMe) {}
if (javaField == null) {
Class[] interfaces = _javaClass.getInterfaces();
for (int i = 0; i < interfaces.length && javaField == null; i++) {
try {
javaField = interfaces[i].getDeclaredField(name);
}
catch (NoSuchFieldException ignoreMe) {}
}
}
if (javaField != null) {
result = new ExternalVariable(javaField);
}
else {
if (getSuperclass() != null) {
result = getSuperclass().getVariableDefinition(name);
}
}
return result;
}
public IMethod getMethodDefinition(String name,
ISignature signature) {
IMethod result = null;
if (name.equals(getName())) {
result = getConstructorDefinition(signature);
}
else {
Method[] methods = _javaClass.getDeclaredMethods();
for (int i = 0; i < methods.length; i++) {
if (name.equals(methods[i].getName())) {
IMethod method = new ExternalMethod(methods[i]);
if (method.hasSameSignature(signature)) {
result = method;
break;
}
}
}
if (result == null) {
result = getMostCompatibleMethod(name, signature);
}
if (result == null) {
if (getSuperclass() != null) {
result = getSuperclass().getMethodDefinition(name, signature);
}
}
if (result == null) {
IClass[] interfaces = getInterfaces();
for (int i = 0; i < interfaces.length; i++) {
result = interfaces[i].getMethodDefinition(name, signature);
if (result != null) {
break;
}
}
}
}
return result;
}
public IMethod getMostCompatibleMethod(String name, ISignature signature) {
IMethod result = null;
SortedSet compatibleMethods
= new TreeSet(new MethodSpecificityComparator());
Iterator it = getMethods().iterator();
while (it.hasNext()) {
IMethod method = (IMethod)it.next();
if ( name.equals( method.getName() ) ) {
if ( method.hasCompatibleSignature( signature ) ) {
compatibleMethods.add(method);
}
}
}
if (!compatibleMethods.isEmpty()) {
result = (IMethod)compatibleMethods.first();
}
return result;
}
private Collection getMethods() {
if (_methods == null) {
_methods = new HashSet();
Method[] methods = _javaClass.getDeclaredMethods();
for (int i = 0; i < methods.length; i++) {
_methods.add(new ExternalMethod(methods[i]));
}
}
return _methods;
}
public IMethod getConstructorDefinition(ISignature signature) {
IMethod result = null;
if (_javaClass.isInterface()) {
result = getInterfaceConstructor(signature);
}
else {
result = getClassConstructor(signature);
}
return result;
}
private IMethod getInterfaceConstructor(ISignature signature) {
IMethod result = null;
if (signature.getParameters().length == 0) {
result = new InterfaceConstructor(_javaClass);
}
return result;
}
private IMethod getClassConstructor(ISignature signature) {
IMethod result = null;
Constructor[] constructors = _javaClass.getConstructors();
for (int i = 0; i < constructors.length; i++) {
IMethod constructor = new ExternalConstructor(constructors[i]);
if (constructor.hasSameSignature(signature)) {
result = constructor;
break;
}
}
if (result == null) {
for (int i = 0; i < constructors.length; i++) {
IMethod constructor = new ExternalConstructor(constructors[i]);
if (constructor.hasCompatibleSignature(signature)) {
result = constructor;
break;
}
}
}
return result;
}
public boolean isCompatibleWith(IClass type) {
boolean result = false;
if (isPrimitive() && type.isPrimitive()) {
result = PrimitiveClasses.typesAreCompatible((ExternalClass)type,
this);
}
else {
// check myself
if (type.equals(this)) {
result = true;
}
// check my superclass
else if (getSuperclass() != null && getSuperclass().isCompatibleWith(type)) {
result = true;
}
// check my interfaces
else if (_javaClass.getInterfaces().length > 0) {
Class[] interfaces = _javaClass.getInterfaces();
for (int i = 0; i < interfaces.length; i++) {
if (new ExternalClass(interfaces[i]).isCompatibleWith(type)) {
result = true;
break;
}
}
}
}
return result;
}
public void addImplementor(ClassDef implementor) {
_implementors.add(implementor);
}
public List getImplementors() {
return _implementors;
}
public void addSubclass(ClassDef subclass) {
_subclasses.add(subclass);
}
public List getSubclasses() {
return _subclasses;
}
public String getQualifiedName() {
return _javaClass.getName();
}
public boolean isPrimitive() {
return getJavaClass().isPrimitive();
}
public IClass[] getInnerClasses() {
Class[] innerJavaClasses = getJavaClass().getDeclaredClasses();
IClass[] result = new IClass[innerJavaClasses.length];
for (int i = 0; i < result.length; i++) {
result[i] = new ExternalClass(innerJavaClasses[i]);
}
return result;
}
public String toString() {
return getClass() + "[" + getQualifiedName() + "]";
}
public boolean equals(Object o) {
boolean result = false;
if (o instanceof ExternalClass) {
ExternalClass compared = (ExternalClass)o;
result = (getJavaClass().equals(compared.getJavaClass()));
}
return result;
}
public int hashCode() {
return getJavaClass().hashCode();
}
}
././@LongLink 100644 0 0 177 12026055133 10255 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ExternalConstructor.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 6656 11451071612 31461 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.lang.reflect.Constructor;
public class ExternalConstructor extends ExternalDefinition implements IMethod {
private Constructor _javaConstructor;
private ISignature _signature;
public ExternalConstructor(Constructor javaConstructor) {
_javaConstructor = javaConstructor;
_signature = new ExternalSignature(_javaConstructor.getParameterTypes());
}
public String getName() {
return _javaConstructor.getDeclaringClass().getName();
}
public IClass getType() {
return new ExternalClass(_javaConstructor.getDeclaringClass());
}
public ISignature getSignature() {
return _signature;
}
public boolean hasSameSignature(ISignature signature) {
return getSignature().isSame(signature);
}
public boolean hasCompatibleSignature(ISignature signature) {
return signature.isCompatibleWith(getSignature());
}
public String getQualifiedName() {
return getName() + getSignature();
}
public Constructor getJavaConstructor() {
return _javaConstructor;
}
public IClass[] getExceptions() {
Class[] javaExceptions = getJavaConstructor().getExceptionTypes();
IClass[] result = new IClass[javaExceptions.length];
for (int i = 0; i < result.length; i++) {
result[i] = new ExternalClass(javaExceptions[i]);
}
return result;
}
public String toString() {
return getQualifiedName();
}
public boolean equals(Object o) {
boolean result = false;
if (o instanceof ExternalConstructor) {
ExternalConstructor constructor = (ExternalConstructor)o;
result = getJavaConstructor().equals(constructor.getJavaConstructor());
}
return result;
}
public int hashCode() {
return getJavaConstructor().hashCode();
}
}
././@LongLink 100644 0 0 176 12026055133 10254 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ExternalDefinition.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 4012 11451071612 31441 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.Iterator;
import java.util.Vector;
public abstract class ExternalDefinition implements IDefinition {
public boolean isSourced() {
return false;
}
public void addReference(Reference reference) {}
public Iterator getReferences() {
return new Vector().iterator();
}
public int getNumReferences() {
return 0;
}
} ././@LongLink 100644 0 0 172 12026055133 10250 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ExternalMethod.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 7751 11451071612 31456 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.lang.reflect.Method;
/**
* MethodDef contains all the pertinent information for
* a method, including return type, formal parameters, and exceptions
* thrown
*
* @see ClassDef
* @see MethodSignature
*/
public class ExternalMethod extends ExternalDefinition implements IMethod {
private Method _javaMethod;
private ISignature _signature;
public ExternalMethod(Method javaMethod) {
_javaMethod = javaMethod;
_signature = new ExternalSignature(_javaMethod.getParameterTypes());
}
public String getName() {
return _javaMethod.getName();
}
/**
* Returns the ClassDef for the return type of this method.
*
* @return the ClassDef for the return type of this method
*/
public IClass getType() {
IClass result = null;
if (_javaMethod.getReturnType().isArray()) {
result = new ArrayDef(new ExternalClass(_javaMethod.getReturnType().getComponentType()));
}
else {
result = new ExternalClass(_javaMethod.getReturnType());
}
return result;
}
/**
* Returns the signature of this method.
*
* @return the signature of this method
*/
public ISignature getSignature() {
return _signature;
}
public boolean hasSameSignature(ISignature signature) {
return _signature.isSame(signature);
}
public boolean hasCompatibleSignature(ISignature signature) {
return signature.isCompatibleWith(getSignature());
}
public String getQualifiedName() {
return getName() + getSignature();
}
public Method getJavaMethod() {
return _javaMethod;
}
public IClass[] getExceptions() {
Class[] javaExceptions = getJavaMethod().getExceptionTypes();
IClass[] result = new IClass[javaExceptions.length];
for (int i = 0; i < result.length; i++) {
result[i] = new ExternalClass(javaExceptions[i]);
}
return result;
}
public String toString() {
return getQualifiedName();
}
public boolean equals(Object o) {
boolean result = false;
if (o instanceof ExternalMethod) {
ExternalMethod compared = (ExternalMethod)o;
result = getJavaMethod().equals(compared.getJavaMethod());
}
return result;
}
public int hashCode() {
return getJavaMethod().hashCode();
}
}
././@LongLink 100644 0 0 173 12026055133 10251 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ExternalPackage.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 5766 11451071612 31462 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.HashMap;
import java.util.Map;
/**
* PackageDef contains all pertinent information about a
* package.
*/
public class ExternalPackage extends ExternalDefinition implements IPackage {
String _name;
IPackage _parent;
Map _packages;
public ExternalPackage(String name, IPackage parent) {
_name = name;
_parent = parent;
_packages = new HashMap();
}
public IClass getClass(String name) {
IClass result = null;
try {
Class theClass
= ClassManager.getClassLoader().loadClass(getQualifiedName()
+ "."
+ name);
result = new ExternalClass(theClass);
}
catch (ClassNotFoundException e) {
// look elsewhere for the class
}
return result;
}
public void addDefinition(IPackage pkg) {
_packages.put(pkg.getName(), pkg);
}
public IPackage getEnclosingPackage() {
return _parent;
}
public String getName() {
return _name;
}
public String getQualifiedName() {
StringBuffer result = new StringBuffer();
if (_parent != null) {
result.append(_parent.getQualifiedName());
result.append(".");
}
result.append(getName());
return result.toString();
}
}
././@LongLink 100644 0 0 175 12026055133 10253 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ExternalSignature.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 6763 11451071612 31460 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
public class ExternalSignature implements ISignature {
private IClass[] _parameters;
public ExternalSignature(Class[] parameters) {
_parameters = new IClass[parameters.length];
for (int i = 0; i < parameters.length; i++) {
if (parameters[i].isArray()) {
_parameters[i] =
new ArrayDef(new ExternalClass(parameters[i].getComponentType()));
}
else {
_parameters[i] = new ExternalClass(parameters[i]);
}
}
}
/**
* Whether this method signature is compatible with the signature of the
* argument. That is to say, each type for this signature are subclasses,
* subinterfaces, or implement the interface for each corresponding type
* in the argument signature.
*
* @param signature the signature of the method definition being compared
* @return whether the signatures are compatible
*/
public boolean isCompatibleWith(ISignature signature) {
boolean result = true;
if (_parameters.length == signature.getParameters().length) {
for (int i = 0; i < _parameters.length; i++) {
if (!getParameters()[i].isCompatibleWith(signature.getParameters()[i])) {
result = false;
break;
}
}
}
else {
result = false;
}
return result;
}
public boolean isSame(ISignature signature) {
return java.util.Arrays.equals(_parameters, signature.getParameters());
}
public IClass[] getParameters() {
return _parameters;
}
public String toString() {
StringBuffer result = new StringBuffer();
result.append("(");
for (int i = 0; i < _parameters.length; i++) {
result.append(_parameters[i]);
if (i < _parameters.length - 1) {
result.append(", ");
}
}
result.append(")");
return result.toString();
}
}
././@LongLink 100644 0 0 174 12026055133 10252 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ExternalVariable.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 5301 11451071612 31443 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.lang.reflect.Field;
/**
* VariableDef is a Definition that contains
* information about the definition of a variable.
*
* @see Definition
* @see TypedDef
*/
public class ExternalVariable extends ExternalDefinition implements IVariable {
Field _javaField;
public ExternalVariable(Field javaField) {
_javaField = javaField;
}
public String getName() {
return _javaField.getName();
}
public String getQualifiedName() {
return new ExternalClass(_javaField.getDeclaringClass()).getQualifiedName() + "." + getName();
}
/**
* Returns the Type of the variable.
*
* @see TypedDef
*
* @return the Type of the variable
*/
public IClass getType() {
IClass result = null;
if (_javaField.getType().isArray()) {
result = new ArrayDef(new ExternalClass(_javaField.getType().getComponentType()));
}
else {
result = new ExternalClass(_javaField.getType());
}
return result;
}
}
././@LongLink 100644 0 0 162 12026055133 10247 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/IClass.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 11510 11451071612 31462 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.List;
/**
* interface implemented by classes/interfaces definition, for source or
* non-sourced classes and interfaces
* The implementor of this class have all information about its inner classes,
* methods, variables, subclasses, etc.
* @see net.sourceforge.transmogrify.symtab.ClassDef
* @see net.sourceforge.transmogrify.symtab.ExternalClass
*/
public interface IClass extends IDefinition {
/**
* gets superclass definition of this class
* @return superclass of this class definition
*/
public IClass getSuperclass();
/**
* gets interfaces definition implemented by this class definition
* @return interfaces implemented
*/
public IClass[] getInterfaces();
/**
* gets subclasses definition of this class definition
* @return list of subclasses definition
*/
public List getSubclasses();
/**
* gets class definition referenced by this class, including its inner classes,
* imported classes, packages, and its parent scope referenced class definitions
* @param name name of the class definition to be searched
* @return class definition that matches the input name
*/
public IClass getClassDefinition(String name);
/**
* gets the method associated with the given name and signature
*
* @param name the name of the method
* @param signature the signature (formal parameter types) of the method
*
* @return MethodDef
*
* @see MethodSignature
*/
public IMethod getMethodDefinition(String name,
ISignature signature);
/**
* gets the VariableDef associated with the given name
*
* @param name the name of the variable
*
* @return VariableDef
*/
public IVariable getVariableDefinition(String name);
// end definitions interface
/**
* adds ClassDef to the collection of (direct?) subclasses of
* this class
*
* @param subclass the class to add
* @return void
*/
public void addSubclass(ClassDef subclass);
/**
* adds ClassDef to the collection of implemented interfaces
* of this class
*
* @param implementor the interface to add
* @return void
*/
public void addImplementor(ClassDef implementor);
/**
* gets the list of ClassDefs that implmement this interface
*
* @return Vector the list of implementors
*/
public List getImplementors();
/**
* verifies if the input type is equal to this class or its superclass or
* its interfaces
* @param type class to be compared with
* @return true if the input type is equals
* false otherwise
*/
public boolean isCompatibleWith(IClass type);
/**
* verifies if this class is of primitive Java type
* @return true if the class is a primitive type
* false otherwise
*/
public boolean isPrimitive();
/**
* gets inner classes definition associated with this class
* @return array of inner classes
*/
public IClass[] getInnerClasses();
}
././@LongLink 100644 0 0 167 12026055133 10254 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/IDefinition.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 6322 11451071612 31447 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.Iterator;
/**
* implemented by all definitions of the SymTabAST tree, including
* source/non-sourced node
* @see net.sourceforge.transmogrify.symtab.Definition
* @see net.sourceforge.transmogrify.symtab.ExternalDefinition
*/
public interface IDefinition {
/**
* verifies if this definition node is source/non-sourced(with no source-code)
* @return true if the node is parsed from a source code
* false otherwise
*/
public boolean isSourced();
/**
* gets the name that identified this particular definition/node
* @return name for this definition
*/
public String getName();
/**
* gets the fully qualified name of the definition, ie. dotted name for classes,
* or method name with its signature for methods, etc
* @return qualified name for this node
*/
public String getQualifiedName();
/**
* adds any reference that this definition have to its collection of
* _references
* @param reference reference to be added which has SymTabAST node
* @return void
* @see net.sourceforge.transmogrify.symtab.antlr.SymTabAST
*/
public void addReference(Reference reference);
/**
* gets the collection of references refer to by this definition
* @return iterator of the references
*/
public Iterator getReferences();
/**
* gets the number of references refer to by this definition
* @return number of references
*/
public int getNumReferences();
} ././@LongLink 100644 0 0 163 12026055133 10250 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/IMethod.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 5342 11451071612 31450 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
/**
* MethodDef contains all the pertinent information for
* a method, including return type, formal parameters, and exceptions
* thrown
*
* @see ClassDef
* @see MethodSignature
* @see net.sourceforge.transmogrify.symtab.ExternalMethod
* @see net.sourceforge.transmogrify.symtab.MethodDef
*/
public interface IMethod extends Typed {
/**
* Returns the signature of this method.
*
* @return the signature of this method
*/
public ISignature getSignature();
/**
* verifies if the input signature is the same with signatures of this method
* @return true if the two set signatures are equal
* false otherwise
*/
public boolean hasSameSignature(ISignature signature);
/**
* verifies if the input signature type is compatible with this method signature
* @return true if the two set of signatures are compatible
* false otherwise
*/
public boolean hasCompatibleSignature(ISignature signature);
public IClass[] getExceptions();
} ././@LongLink 100644 0 0 200 12026055133 10240 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/InterfaceConstructor.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 5751 11451071612 31454 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.lang.reflect.Constructor;
import java.util.Vector;
public class InterfaceConstructor extends ExternalDefinition implements IMethod {
protected Class _classConstructed;
public InterfaceConstructor(Class classConstructed) {
_classConstructed = classConstructed;
}
public String getName() {
return _classConstructed.getName();
}
public IClass getType() {
return new ExternalClass(_classConstructed);
}
public ISignature getSignature() {
return new MethodSignature(new Vector());
}
public boolean hasSameSignature(ISignature signature) {
return getSignature().isSame(signature);
}
public boolean hasCompatibleSignature(ISignature signature) {
return signature.isCompatibleWith(getSignature());
}
public Constructor getJavaConstructor() {
return null;
}
public IClass[] getExceptions() {
return new IClass[0];
}
public String getQualifiedName() {
return getName() + getSignature();
}
public boolean equals(Object o) {
boolean result = false;
if (o instanceof InterfaceConstructor) {
InterfaceConstructor constructor = (InterfaceConstructor)o;
result = getType().equals(constructor.getType());
}
return result;
}
public int hashCode() {
return getType().hashCode();
}
}
././@LongLink 100644 0 0 164 12026055133 10251 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/IPackage.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 4670 11451071612 31453 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
/**
* PackageDef contains all pertinent information about a
* package.
* @see net.sourceforge.transmogrify.symtab.ExternalPackage
* @see net.sourceforge.transmogrify.symtab.PackageDef
*/
public interface IPackage extends IDefinition {
/**
* return class definition associated with this package
* @param name of the class to be returned
* @return the class definition
*/
public IClass getClass(String name);
/**
* gets the Package definition of itself
* @return Package definition
*/
public IPackage getEnclosingPackage();
/**
* adds a package definition to its parent's list of package definitions
* @param def package definition
* @return void
*/
public void addDefinition(IPackage def);
} ././@LongLink 100644 0 0 166 12026055133 10253 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ISignature.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 5172 11451071612 31451 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
/**
* implemented by signatures of methods
* @see net.sourceforge.transmogrify.symtab.MethodSignature
* @see net.sourceforge.transmogrify.symtab.ExternalSignature
*/
public interface ISignature {
public IClass[] getParameters();
/**
* Whether this method signature is compatible with the signature of the
* argument. That is to say, each type for this signature are subclasses,
* subinterfaces, or implement the interface for each corresponding type
* in the argument signature.
*
* @param signature the signature of the method definition being compared
* @return whether the signatures are compatible
*/
public boolean isCompatibleWith(ISignature signature);
/**
* if both signature has the same set of parameters
* @param signature signature to be compared
* @return true if the two set of parameters are equal
* false otherwise
*/
public boolean isSame(ISignature signature);
}
././@LongLink 100644 0 0 165 12026055133 10252 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/IVariable.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 3662 11451071612 31453 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
/**
* contains information about type of a variable or its Field,
* in case of non-source variable
* @see net.sourceforge.transmogrify.symtab.VariableDef
* @see net.sourceforge.transmogrify.symtab.ExternalVariable
*/
public interface IVariable extends Typed {} ././@LongLink 100644 0 0 164 12026055133 10251 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/LabelDef.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 3732 11451071612 31451 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
/**
* LabelDef is a Definition that contains information
* about the definition of a Label.
*
* @see Definition
*/
public class LabelDef extends Definition {
public LabelDef( String name, Scope parentScope, SymTabAST node ) {
super( name, parentScope, node );
}
}
././@LongLink 100644 0 0 173 12026055133 10251 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/LiteralResolver.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 13745 11451071612 31476 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.HashMap;
import java.util.Map;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Resolves primitive identifiers (int, double) to their corresponding
* ClassDef. This class uses the Singleton pattern.
*
* @author andrew
* @version 1.0
* @since 1.0
*/
public class LiteralResolver {
private static Map intMap;
private static Map nameMap;
private static Map classMap;
static {
nameMap = new HashMap();
nameMap.put("boolean", new ExternalClass(Boolean.TYPE));
nameMap.put("byte", new ExternalClass(Byte.TYPE));
nameMap.put("char", new ExternalClass(Character.TYPE));
nameMap.put("short", new ExternalClass(Short.TYPE));
nameMap.put("int", new ExternalClass(Integer.TYPE));
nameMap.put("float", new ExternalClass(Float.TYPE));
nameMap.put("long", new ExternalClass(Long.TYPE));
nameMap.put("double", new ExternalClass(Double.TYPE));
intMap = new HashMap();
intMap.put(
new Integer(TokenTypes.LITERAL_BOOLEAN),
new ExternalClass(Boolean.TYPE));
intMap.put(
new Integer(TokenTypes.LITERAL_BYTE),
new ExternalClass(Byte.TYPE));
intMap.put(
new Integer(TokenTypes.LITERAL_CHAR),
new ExternalClass(Character.TYPE));
intMap.put(
new Integer(TokenTypes.LITERAL_SHORT),
new ExternalClass(Short.TYPE));
intMap.put(
new Integer(TokenTypes.LITERAL_INT),
new ExternalClass(Integer.TYPE));
intMap.put(
new Integer(TokenTypes.LITERAL_FLOAT),
new ExternalClass(Float.TYPE));
intMap.put(
new Integer(TokenTypes.LITERAL_LONG),
new ExternalClass(Long.TYPE));
intMap.put(
new Integer(TokenTypes.LITERAL_DOUBLE),
new ExternalClass(Double.TYPE));
intMap.put(
new Integer(TokenTypes.STRING_LITERAL),
new ExternalClass("".getClass()));
classMap = new HashMap();
classMap.put(
new ExternalClass(Boolean.TYPE),
SymTabASTFactory.create(TokenTypes.LITERAL_BOOLEAN, "boolean"));
classMap.put(
new ExternalClass(Byte.TYPE),
SymTabASTFactory.create(TokenTypes.LITERAL_BYTE, "byte"));
classMap.put(
new ExternalClass(Character.TYPE),
SymTabASTFactory.create(TokenTypes.LITERAL_CHAR, "char"));
classMap.put(
new ExternalClass(Short.TYPE),
SymTabASTFactory.create(TokenTypes.LITERAL_SHORT, "short"));
classMap.put(
new ExternalClass(Integer.TYPE),
SymTabASTFactory.create(TokenTypes.LITERAL_INT, "int"));
classMap.put(
new ExternalClass(Float.TYPE),
SymTabASTFactory.create(TokenTypes.LITERAL_FLOAT, "float"));
classMap.put(
new ExternalClass(Long.TYPE),
SymTabASTFactory.create(TokenTypes.LITERAL_LONG, "long"));
classMap.put(
new ExternalClass(Double.TYPE),
SymTabASTFactory.create(TokenTypes.LITERAL_DOUBLE, "double"));
}
/**
* Returns a LiteralResolver
*
* @return a LiteralResolver
*/
public static LiteralResolver getResolver() {
return new LiteralResolver();
}
/**
* Returns the ClassDef for a primitive type reference.
*
*
* We could probably do without passing in the context, if we could figure
* out a way to access the base scope.
*
*
* @param literalType the JavaTokenType for the literal type
* @param context the scope in which the search performed
* @return returns the ClassDefcorresponding to the primitive
* type
*/
public static IClass getDefinition(int literalType) {
Integer key = new Integer(literalType);
return (IClass) intMap.get(key);
}
public static IClass getDefinition(String name) {
return (IClass) nameMap.get(name);
}
public static SymTabAST getASTNode(IClass primitive) {
return (SymTabAST) classMap.get(primitive);
}
}
././@LongLink 100644 0 0 165 12026055133 10252 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/MethodDef.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 11336 11451071612 31470 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.List;
import java.util.Vector;
/**
* MethodDef contains all the pertinent information for
* a method, including return type, formal parameters, and exceptions
* thrown
*
* @see ClassDef
* @see MethodSignature
*/
public class MethodDef extends DefaultScope implements IMethod {
private IClass returnType;
private List exceptions;
private List parameters;
public MethodDef(String name, Scope parentScope, SymTabAST node) {
super(name, parentScope, node);
parameters = new Vector();
}
/**
* Returns the ClassDef for the return type of this method.
*
* @return the ClassDef for the return type of this method
*/
public IClass getType() {
return returnType;
}
/**
* Sets the return type of this method.
*
* @param type the ClassDef for the return type
*/
public void setType(IClass type) {
returnType = type;
}
/**
* Adds a parameter to the collection of formal parameters
*
* @param parameter the VariableDef to add
*/
public void addParameter(VariableDef parameter) {
parameters.add( parameter );
addDefinition(parameter);
}
/**
* Whether this method has the same signature as the given signature.
*
* @param signature the MethodSignature to compare
*
* @return whether the signatures are equal
*/
public boolean hasSameSignature(ISignature signature) {
return getSignature().equals(signature);
}
/**
* Whether this method has a signature compatible with the given signature.
*
* @param signature the signature being compared
* @return whether the signatures are compatible
*/
public boolean hasCompatibleSignature(ISignature signature) {
return signature.isCompatibleWith(getSignature());
}
/**
* Returns the signature of this method.
*
* @return the signature of this method
*/
public ISignature getSignature() {
Vector argTypes = new Vector();
for (int i = 0; i < parameters.size(); i++) {
argTypes.add(getParameterAt(i).getType());
}
return new MethodSignature(argTypes);
}
/**
* Gets the ith parameter of this method
*
* @param i the index of the parameter
*
* @return the VariableDef of the ith parameter
*/
private VariableDef getParameterAt( int i ) {
return (VariableDef)(parameters.get( i ));
}
/**
* Adds an exception that this method throws.
*
* @param exception the exception to add
*/
public void addException(IClass exception) {
if (exceptions == null) {
exceptions = new Vector();
}
exceptions.add(exception);
}
/**
* Returns the exceptions this method throws
*
* @return the exceptions this method throws
*/
public IClass[] getExceptions() {
return (IClass[])exceptions.toArray(new IClass[0]);
}
public String getQualifiedName() {
return super.getQualifiedName() + getSignature();
}
} ././@LongLink 100644 0 0 173 12026055133 10251 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/MethodSignature.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 10731 11451071612 31466 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.Vector;
/**
* MethodSignature is used to resolve various methods
* in the same scope of the same name based on formal parameter lists
*
* @see MethodDef
*/
public class MethodSignature implements ISignature{
private IClass[] _argTypes = null;
public MethodSignature(IClass[] argTypes) {
_argTypes = argTypes;
}
public MethodSignature(Vector argTypes) {
_argTypes = new IClass[argTypes.size()];
argTypes.toArray(_argTypes);
}
/**
* returns an array of the types of the arguments in the signature
*
* @return ClassDef[]
*/
public IClass[] getParameters() {
return _argTypes;
}
/**
* Whether this method signature is compatible with the signature of the
* argument. That is to say, each type for this signature are subclasses,
* subinterfaces, or implement the interface for each corresponding type
* in the argument signature.
*
* @param signature the signature of the method definition being compared
* @return whether the signatures are compatible
*/
public boolean isCompatibleWith(ISignature signature) {
boolean result = true;
IClass[] comparedArgTypes = signature.getParameters();
if (_argTypes.length != comparedArgTypes.length) {
result = false;
}
else {
for (int i = 0; i < _argTypes.length; i++) {
// TODO: Checkstyle modification. Why can _argTypes[i] be null?
// if (!_argTypes[i].isCompatibleWith(comparedArgTypes[i])) {
if ((_argTypes[i] != null)
&& !_argTypes[i].isCompatibleWith(comparedArgTypes[i]))
{
result = false;
break;
}
}
}
return result;
}
public boolean isSame(ISignature signature) {
return equals(signature);
}
/**
* compares two objects for equality. If the compared object is a
* MethodSignature and the argTypes match, they are the
* same
*
* @return boolean
*/
public boolean equals(Object o) {
boolean result = false;
if (o instanceof MethodSignature) {
MethodSignature signature = (MethodSignature)o;
result = java.util.Arrays.equals(getParameters(), signature.getParameters());
}
return result;
}
/**
* returns a String representation of this object. Includes information
* about the types of the arguments in the signature
*
* @return String
*/
public String toString() {
StringBuffer result = new StringBuffer( "(" );
for ( int i = 0; i < _argTypes.length; i++ ) {
result.append( _argTypes[i] != null ? _argTypes[i].getName() : "[null]" );
if ( i < (_argTypes.length - 1) ) {
result.append( ", " );
}
}
result.append( ")" );
return result.toString();
}
}
././@LongLink 100644 0 0 207 12026055133 10247 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/MethodSpecificityComparator.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 4317 11451071612 31451 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.Comparator;
public class MethodSpecificityComparator implements Comparator {
public int compare(Object o1, Object o2) {
int result = 0;
IMethod method1 = (IMethod)o1;
IMethod method2 = (IMethod)o2;
if (method1.equals(method2)) {
result = 0;
}
else {
ISignature sig1 = method1.getSignature();
ISignature sig2 = method2.getSignature();
if (sig1.isCompatibleWith(sig2)) {
result = -1;
}
else {
result = 1;
}
}
return result;
}
}
././@LongLink 100644 0 0 165 12026055133 10252 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/NullClass.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 6002 11451071612 31442 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
public class NullClass implements IClass {
public Iterator getReferences() {
return new ArrayList().iterator();
}
public int getNumReferences() {
return 0;
}
public void addReference(Reference ref) {}
public String getName() {
return "null";
}
public String getQualifiedName() {
return getName();
}
public boolean isSourced() {
return false;
}
public IClass getSuperclass() {
return null;
}
public IClass[] getInterfaces() {
return new IClass[0];
}
public IClass[] getInnerClasses() {
return new IClass[0];
}
public List getSubclasses() {
return new ArrayList();
}
public IClass getClassDefinition(String name) {
return null;
}
public IMethod getMethodDefinition(String name,
ISignature signature) {
return null;
}
public IVariable getVariableDefinition(String name) {
return null;
}
public void addSubclass(ClassDef subclass) {}
public void addImplementor(ClassDef implementor) {}
public List getImplementors() {
return new ArrayList();
}
public boolean isCompatibleWith(IClass type) {
return true;
}
public boolean isPrimitive() {
return false;
}
}
././@LongLink 100644 0 0 166 12026055133 10253 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/Occurrence.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 7342 11451071612 31452 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.io.File;
/**
* Occurrence contains file and line number information.
* It is used to denote the location of various Definintions
* and References
*
* @see Reference
* @see Definition
*/
public class Occurrence implements Comparable {
private File _file;
private int _line;
private int _column;
public Occurrence(File file, int line, int column) {
_file = file;
_line = line;
_column = column;
}
public Occurrence(SymTabAST node) {
_file = node.getFile();
_line = node.getLineNo();
_column = node.getColumnNo();
}
/**
* returns the File of this Occurrence
*
* @return File
*/
public File getFile() {
return _file;
}
/**
* returns the line number of this Occurrence
*
* @return the line number of this Occurrence
*/
public int getLine() {
return _line;
}
/**
* returns the column that this token starts at
*
* @return the column that this token starts at
*/
public int getColumn() {
return _column;
}
public int compareTo(Object o) {
if (!(o instanceof Occurrence)) {
throw new ClassCastException(getClass().getName());
}
Occurrence other = (Occurrence)o;
int result = 0;
result = getFile().compareTo(other.getFile());
if (result == 0) {
result = getLine() - other.getLine();
}
if (result == 0) {
result = getColumn() - other.getColumn();
}
return result;
}
public boolean equals(Object o) {
boolean result = false;
if (o instanceof Occurrence) {
Occurrence occ = (Occurrence)o;
result = (getFile().equals(occ.getFile())
&& getLine() == occ.getLine()
&& getColumn() == occ.getColumn());
}
return result;
}
public int hashCode() {
return getFile().hashCode();
}
public String toString() {
return "[" + getFile() + ":" + getLine() + "," + getColumn() + "]";
}
}
././@LongLink 100644 0 0 166 12026055133 10253 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/PackageDef.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 4663 11451071612 31455 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
/**
* PackageDef contains all pertinent information about a
* package.
*/
public class PackageDef extends DefaultScope implements IPackage {
public PackageDef(String name, Scope parentScope, SymTabAST node) {
super(name, parentScope, node);
}
public LabelDef getLabelDefinition(String name) {
throw new UnsupportedOperationException(getClass().getName());
}
public IClass getClass(String name) {
return (IClass)classes.get(name);
}
public IPackage getEnclosingPackage() {
return this;
}
public IVariable getVariableDefinition(String name) {
return null;
}
public void addDefinition(IPackage def) {
if (elements.get(def.getName()) == null) {
elements.put(def.getName(), def);
}
}
}
././@LongLink 100644 0 0 174 12026055133 10252 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/PrimitiveClasses.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 7302 11451071612 31446 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.ArrayList;
import java.util.List;
public class PrimitiveClasses {
public static final ExternalClass BOOLEAN = new ExternalClass(Boolean.TYPE);
public static final ExternalClass CHAR = new ExternalClass(Character.TYPE);
public static final ExternalClass BYTE = new ExternalClass(Byte.TYPE);
public static final ExternalClass SHORT = new ExternalClass(Short.TYPE);
public static final ExternalClass INT = new ExternalClass(Integer.TYPE);
public static final ExternalClass LONG = new ExternalClass(Long.TYPE);
public static final ExternalClass FLOAT = new ExternalClass(Float.TYPE);
public static final ExternalClass DOUBLE = new ExternalClass(Double.TYPE);
private static List order;
static {
order = new ArrayList();
order.add(DOUBLE);
order.add(FLOAT);
order.add(LONG);
order.add(INT);
order.add(SHORT);
order.add(BYTE);
}
public static boolean typesAreCompatible(ExternalClass hole,
ExternalClass peg) {
boolean result = false;
if (hole.equals(BOOLEAN)) {
result = peg.equals(BOOLEAN);
}
else if (hole.equals(CHAR)) {
result = peg.equals(CHAR);
}
else if (peg.equals(CHAR)) {
result = (hole.equals(CHAR) ||
order.indexOf(hole) <= order.indexOf(INT));
}
else {
result = (order.indexOf(hole) <= order.indexOf(peg));
}
return result;
}
public static IClass unaryPromote(IClass type) {
IClass result = type;
if (type.equals(BYTE) || type.equals(SHORT) || type.equals(CHAR)) {
result = INT;
}
return result;
}
public static IClass binaryPromote(IClass a, IClass b) {
IClass result = null;
if (a.equals(DOUBLE) || b.equals(DOUBLE)) {
result = DOUBLE;
}
else if (a.equals(FLOAT) || b.equals(FLOAT)) {
result = FLOAT;
}
else if (a.equals(LONG) || b.equals(LONG)) {
result = LONG;
}
else {
result = INT;
}
return result;
}
}
././@LongLink 100644 0 0 167 12026055133 10254 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/QueryEngine.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 13157 11451071612 31473 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.io.File;
import java.util.Iterator;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* a wrapper around a SymbolTable that makes Definition and
* reference lookup easier
*/
public class QueryEngine {
private SymbolTable symbolTable;
private ScopeIndex index;
public QueryEngine(SymbolTable aSymbolTable) {
this.symbolTable = aSymbolTable;
setIndex();
}
/**
* sets the scope index that this QueryEngine uses
*/
private void setIndex() {
index = symbolTable.getScopeIndex();
}
/**
* gets a symbol from the associated symbol table
*
* @param name the name of the symbol to get
* @param location the location of that symbol
*
* @return Object the (possibly null) result of the lookup
*/
public Reference getSymbol(String name, Occurrence location) {
Scope enclosingScope = index.lookup(location);
Reference result = enclosingScope.getSymbol(name, location);
// REDTAG -- for cases like a label on the same line as the
// block it names, e.g. 'bar: for(int i = 0; ...'
if (result == null) {
result = enclosingScope.getParentScope().getSymbol(name, location);
}
return result;
}
/**
* gets the definition of the given symbol
*
* @param name the name of the symbol to consider
* @param location the Occurrence that represents the
* location of the symbol
*
* @return Definition the (possibly null) result of the lookup
*/
public IDefinition getDefinition(String name, Occurrence location) {
Reference symbol = getSymbol(name, location);
//if (symbol != null) {
// System.out.println(" found " + name);
//}
//else {
// System.out.println(" !could not find " + name);
//}
return resolveDefinition(symbol);
}
public IDefinition getDefinition(Occurrence location) {
IDefinition result = null;
SymTabAST node = getWordNodeAtOccurrence(location);
if ( node != null ) {
result = node.getDefinition();
}
return result;
}
private IDefinition resolveDefinition(Reference reference) {
IDefinition result = null;
if ( reference != null ) {
result = reference.getDefinition();
}
return result;
}
/**
* gets a collection of references determined by a symbol and location
*
* @param name the name of the symbol to consider
* @param location the Occurrence that represents its location
*
* @return
*/
public Iterator getReferences(String name, Occurrence location) {
Reference symbol = getSymbol(name, location);
return resolveReferences(symbol);
}
public Iterator getReferences(Occurrence location) {
Iterator result = null;
SymTabAST node = getWordNodeAtOccurrence(location);
if ( node != null && node.getDefinition() != null ) {
result = node.getDefinition().getReferences();
}
return result;
}
private Iterator resolveReferences(Reference reference) {
return reference.getDefinition().getReferences();
}
public SymTabAST getFileNode(File file) {
return ASTUtil.getFileNode(symbolTable.getTree(), file);
}
private SymTabAST getWordNodeAtOccurrence(Occurrence location) {
SymTabAST result = null;
SymTabAST fileNode = getFileNode(location.getFile());
if ( fileNode != null ) {
SymTabAST node = fileNode.getEnclosingNode(location.getLine(),
location.getColumn());
if ( (node != null) && (node.getType() == TokenTypes.IDENT) ) {
result = node;
}
}
return result;
}
public String getWordAtOccurrence(Occurrence location ) {
String result = null;
SymTabAST node = getWordNodeAtOccurrence(location);
if ( node != null ) {
result = node.getText();
}
return result;
}
}
././@LongLink 100644 0 0 165 12026055133 10252 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/Reference.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 10407 11451071612 31466 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.io.File;
/**
* represents a place where a definition is used. There are two flavors
* of references -- resolved (those that have a definition associated with
* them) and unresolved (those that don't have a definition associated).
* The goal of the resolution step is to get all of the references in the
* symbol table to fall into the resolved category.
*/
public class Reference implements Comparable {
private SymTabAST _node;
private Occurrence _occurrence;
public Reference( SymTabAST node ) {
_node = node;
_occurrence = new Occurrence( _node.getFile(), ASTUtil.getLine(_node), ASTUtil.getColumn(_node) );
}
/**
* gets the definition associated with this reference
*
* @return Definition the (possibly null) definition associated with
* this reference
*/
public IDefinition getDefinition() {
return _node.getDefinition();
}
/**
* return the node that was passed in during ctor
*/
public SymTabAST getTreeNode() {
return _node;
}
/**
* gets the occurrence of this reference
*
* @return Occurrence
*/
public Occurrence getOccurrence() {
return _occurrence;
}
/**
* gets the line where the node resides
*/
public int getLine() {
return getOccurrence().getLine();
}
/**
* gets the column for where the node resides
*/
public int getColumn() {
return getOccurrence().getColumn();
}
/**
* gets the enclosing file for the node
*/
public File getFile() {
return getOccurrence().getFile();
}
/**
* gets the name of the reference
*
* @return String the name of the definition associated with this reference
* if this reference is resolved, else null
*/
public String getName() {
return _node.getName();
}
/**
* returns a string representation of the reference.
*
* @return String
*/
public String toString() {
return getOccurrence().toString();
}
/**
* returns whether the References are equal
*
* @return whether the References are equal
*/
// REDTAG -- not finished
public boolean equals(Object obj){
boolean result = false;
if (obj instanceof Reference) {
result = getOccurrence().equals(((Reference)obj).getOccurrence());
}
return result;
}
public int compareTo(Object o) {
if (!(o instanceof Reference)) {
throw new ClassCastException(getClass().getName());
}
return getOccurrence().compareTo(((Reference)o).getOccurrence());
}
}
././@LongLink 100644 0 0 174 12026055133 10252 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ReferenceCounter.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 6145 11451071612 31452 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.ArrayList;
import java.util.List;
import java.util.ListIterator;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* This class is for counting the reference
*/
public class ReferenceCounter extends ReferenceTool {
private List _references = new ArrayList();
private List _resolvedReferences = new ArrayList();
private List _unresolvedReferences = new ArrayList();
public ReferenceCounter(SymbolTable table) {
super(table.getTree());
countReferences();
}
/**
* Return the number of references
*/
public int numberOfReferences() {
return _references.size();
}
/**
* Return the number of resolved references
*/
public int numberOfResolvedReferences() {
return _resolvedReferences.size();
}
public int numberOfUnresolvedReferences() {
return _unresolvedReferences.size();
}
public ListIterator getUnresolvedReferences() {
return _unresolvedReferences.listIterator();
}
private void countReferences() {
handleNode( _tree );
}
protected void handleNode( SymTabAST node ) {
if (node.getType() == TokenTypes.IDENT && node.isMeaningful()) {
_references.add( node );
if (node.getDefinition() != null && !(node.getDefinition() instanceof UnknownClass)) {
_resolvedReferences.add( node );
}
else {
_unresolvedReferences.add( node );
}
}
walkChildren( node );
}
}
././@LongLink 100644 0 0 176 12026055133 10254 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ReferenceThreshold.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 5541 11451071612 31451 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.Set;
import java.util.TreeSet;
public class ReferenceThreshold extends ReferenceTool {
private Set _underreferencedDefinitions;
private int _threshold;
public ReferenceThreshold(SymbolTable table, int threshold) {
super(table.getTree());
_threshold = threshold;
_underreferencedDefinitions = new TreeSet();
go();
}
private void go() {
collectUnderreferencedDefinitions();
}
private void collectUnderreferencedDefinitions() {
handleNode(_tree);
}
protected void handleNode(SymTabAST node) {
if (node.isMeaningful()) {
IDefinition def = node.getDefinition();
if (def != null &&
def.getNumReferences() <= _threshold &&
def instanceof Definition) {
// this is inheritently hackish
// basically we want to ignore
// all test cases and main() methods
if (def.getQualifiedName().indexOf("test") < 0 &&
def.getQualifiedName().indexOf("main") < 0) {
_underreferencedDefinitions.add(def);
}
}
}
walkChildren(node);
}
public Set getUnderreferencedDefinitions() {
return _underreferencedDefinitions;
}
}
././@LongLink 100644 0 0 171 12026055133 10247 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ReferenceTool.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 4430 11451071612 31445 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
public abstract class ReferenceTool {
protected SymTabAST _tree = null;
public ReferenceTool(SymTabAST tree) {
_tree = tree;
}
protected void walkChildren( SymTabAST node ) {
if ( node.getFirstChild() != null ) {
walkSelfAndSiblings( (SymTabAST)node.getFirstChild() );
}
}
private void walkSelfAndSiblings( SymTabAST node ) {
handleNode( node );
SymTabAST sibling = (SymTabAST)node.getNextSibling();
while ( sibling != null ) {
handleNode( sibling );
sibling = (SymTabAST)sibling.getNextSibling();
}
}
protected abstract void handleNode(SymTabAST node);
} ././@LongLink 100644 0 0 164 12026055133 10251 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/Resolver.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 203512 11451071612 31507 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.Vector;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogConfigurationException;
import org.apache.commons.logging.LogFactory;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* The resolver is responsible for traversing all the various
* definitions in a symbol table and resolving references in them.
*
* @see SymbolTable
*/
public class Resolver extends DefinitionTraverser {
/** true if the log factory has been initialized */
private boolean mInitialized = false;
/** Factory for creating org.apache.commons.logging.Log instances */
private LogFactory mLogFactory;
/**
* constructor with SymbolTable to be resolved
*/
public Resolver(SymbolTable symbolTable) {
super(symbolTable);
try {
mLogFactory = LogFactory.getFactory();
}
catch (LogConfigurationException e) {
System.out.println("log configuration exception" + e);
}
mInitialized = true;
}
/**
* resolves the symbol table
* @return void
* @see #traverse()
*/
public void resolve() {
traverse();
}
protected void handleSList(SymTabAST node, Scope scope) {
SymTabASTIterator iterator = node.getChildren();
while (iterator.hasNext()) {
SymTabAST current = iterator.nextChild();
resolveExpression(current, scope, null, true);
}
}
protected void handleAnonymousInnerClass(AnonymousInnerClass innerClass) {
SymTabAST objblock = innerClass.getTreeNode();
SymTabAST expression = (SymTabAST) objblock.getFirstChild();
while (expression != null) {
resolveExpression(expression, innerClass, null, true);
expression = (SymTabAST) expression.getNextSibling();
}
}
/**
* processes a ClassDef and resolves references in it
*
* @param classDef the ClassDef to process
*/
protected void handleClass(ClassDef classDef) {
SymTabAST node = classDef.getTreeNode();
if (node != null) {
SymTabAST nameNode = node.findFirstToken(TokenTypes.IDENT);
nameNode.setDefinition(classDef, classDef, true);
SymTabAST extendsClause =
node.findFirstToken(TokenTypes.EXTENDS_CLAUSE);
if(extendsClause != null) {
SymTabAST extendedClassNode =
(SymTabAST) extendsClause.getFirstChild();
while (extendedClassNode != null) {
IClass superClass =
resolveClass(extendedClassNode, classDef, null, true);
extendedClassNode.setDefinition(superClass, classDef, true);
extendedClassNode =
(SymTabAST) extendedClassNode.getNextSibling();
}
}
SymTabAST implementsNode =
node.findFirstToken(TokenTypes.IMPLEMENTS_CLAUSE);
if (implementsNode != null) {
SymTabAST interfaceNode =
(SymTabAST) (implementsNode.getFirstChild());
while (interfaceNode != null) {
resolveClass(interfaceNode, classDef, null, true);
interfaceNode =
(SymTabAST) (interfaceNode.getNextSibling());
}
}
}
}
/**
* processes a MethodDef and resolves references in it
*
* @param method the MethodDef to process
*/
protected void handleMethod(MethodDef method) {
SymTabAST node = method.getTreeNode();
SymTabAST nameNode = node.findFirstToken(TokenTypes.IDENT);
nameNode.setDefinition(method, method, true);
// references to classes in return type
SymTabAST returnTypeNode = node.findFirstToken(TokenTypes.TYPE);
if (returnTypeNode != null) {
// this is not a constructor
resolveExpression(returnTypeNode, method, null, true);
}
SymTabAST throwsNode =
node.findFirstToken(TokenTypes.LITERAL_THROWS);
if (throwsNode != null) {
SymTabAST exception = (SymTabAST) throwsNode.getFirstChild();
while (exception != null) {
// handle Checkstyle grammar
if (exception.getType() != TokenTypes.COMMA) {
resolveClass(exception, method, null, true);
}
exception = (SymTabAST) exception.getNextSibling();
}
}
// references to classes in parameters
// the body -- this would be better its own function
SymTabAST slist = node.findFirstToken(TokenTypes.SLIST);
if (slist != null) {
handleSList(slist, method);
}
}
/**
* processes a BlockDef and resolves references in it
*
* @param block the BlockDef to process
*/
protected void handleBlock(BlockDef block) {
SymTabAST node = block.getTreeNode();
switch (node.getType()) {
case TokenTypes.LITERAL_FOR :
handleFor(block);
break;
case TokenTypes.LITERAL_IF :
handleIf(block);
break;
case TokenTypes.LITERAL_WHILE :
handleWhileAndSynchronized(block);
break;
case TokenTypes.LITERAL_DO :
handleDoWhile(block);
break;
case TokenTypes.LITERAL_TRY :
case TokenTypes.LITERAL_FINALLY :
SymTabAST slist = node.findFirstToken(TokenTypes.SLIST);
handleSList(slist, block);
break;
case TokenTypes.LITERAL_CATCH :
handleCatch(block);
break;
case TokenTypes.LITERAL_SWITCH :
handleSwitch(block);
break;
case TokenTypes.SLIST :
handleSList(node, block);
break;
case TokenTypes.EXPR :
resolveExpression(node, block, null, true);
break;
case TokenTypes.INSTANCE_INIT :
case TokenTypes.STATIC_INIT :
handleSList((SymTabAST) node.getFirstChild(), block);
break;
case TokenTypes.LITERAL_SYNCHRONIZED :
handleWhileAndSynchronized(block);
break;
case TokenTypes.LITERAL_ASSERT :
handleAssert(block);
break;
default :
if (mInitialized) {
final Log log = mLogFactory.getInstance(this.getClass());
log.error(
"Unhandled block "
+ block
+ " of type "
+ node.getType());
}
}
}
/**
* @param block
*/
private void handleAssert(BlockDef block) {
SymTabAST node = block.getTreeNode();
SymTabAST conditional =
(node.findFirstToken(TokenTypes.EXPR));
resolveExpression(conditional, block, null, true);
SymTabAST message = (SymTabAST) conditional.getNextSibling();
while ((message != null) && (message.getType() != TokenTypes.EXPR)) {
message = (SymTabAST) message.getNextSibling();
}
if (message != null) {
resolveExpression(message, block, null, true);
}
}
/**
* processes a switch statement and resolves references in it
*
* @param block the BlockDef to process
*/
private void handleSwitch(BlockDef block) {
SymTabAST node = block.getTreeNode();
SymTabAST expr = node.findFirstToken(TokenTypes.EXPR);
resolveExpression(expr, block, null, true);
SymTabAST caseGroup = (SymTabAST) (expr.getNextSibling());
while (caseGroup != null
&& (caseGroup.getType() != TokenTypes.CASE_GROUP)) {
caseGroup = (SymTabAST) caseGroup.getNextSibling();
}
if (caseGroup != null) {
while (caseGroup.getType() == TokenTypes.CASE_GROUP) {
SymTabAST caseNode =
caseGroup.findFirstToken(TokenTypes.LITERAL_CASE);
while (caseNode != null
&& caseNode.getType() == TokenTypes.LITERAL_CASE) {
resolveExpression(
(SymTabAST) caseNode.getFirstChild(),
block,
null,
true);
caseNode = (SymTabAST) caseNode.getNextSibling();
}
SymTabAST caseSlist =
caseGroup.findFirstToken(TokenTypes.SLIST);
handleSList(caseSlist, block);
caseGroup = (SymTabAST) (caseGroup.getNextSibling());
}
}
}
/**
* processes a catch block and resolves references in it
*
* @param block the BlockDef to process
*/
private void handleCatch(BlockDef block) {
SymTabAST node = block.getTreeNode();
SymTabAST slist = node.findFirstToken(TokenTypes.SLIST);
handleSList(slist, block);
}
/**
* processes a for loop and resolves references in it
*
* @param block the BlockDef to process
*/
private void handleFor(BlockDef block) {
SymTabAST node = block.getTreeNode();
SymTabAST body;
SymTabAST forEach = node.findFirstToken(TokenTypes.FOR_EACH_CLAUSE);
if (forEach == null) {
SymTabAST init = node.findFirstToken(TokenTypes.FOR_INIT);
// only need to handle the elist case. if the init node is a variable
// definition, the variable def will be handled later on in the resolution
if (init.getFirstChild() != null) {
if (init.getFirstChild().getType() == TokenTypes.ELIST) {
resolveExpression(
(SymTabAST) (init.getFirstChild()),
block,
null,
true);
}
}
SymTabAST cond = node.findFirstToken(TokenTypes.FOR_CONDITION);
if (cond.getFirstChild() != null) {
resolveExpression(
(SymTabAST) (cond.getFirstChild()),
block,
null,
true);
}
SymTabAST iterator = node.findFirstToken(TokenTypes.FOR_ITERATOR);
if (iterator.getFirstChild() != null) {
resolveExpression(
(SymTabAST) (iterator.getFirstChild()),
block,
null,
true);
}
body = (SymTabAST) (iterator.getNextSibling());
}
else {
resolveExpression(
(forEach.findFirstToken(TokenTypes.EXPR)),
block,
null,
true);
body = (SymTabAST) (forEach.getNextSibling());
}
//could be an SLIST, EXPR or an EMPTY_STAT
if (body.getType() == TokenTypes.RPAREN) {
body = (SymTabAST) body.getNextSibling();
}
if (body.getType() == TokenTypes.SLIST) {
handleSList(body, block);
}
else {
resolveExpression(body, block, null, true);
}
}
/**
* processes an if statement and resolves references in it
*
* @param block the BlockDef to process
*/
private void handleIf(BlockDef block) {
SymTabAST node = block.getTreeNode();
SymTabAST conditional =
(node.findFirstToken(TokenTypes.EXPR));
resolveExpression(conditional, block, null, true);
SymTabAST body = (SymTabAST) conditional.getNextSibling();
// Handle Checkstyle grammar
if (body.getType() == TokenTypes.RPAREN) {
body = (SymTabAST) body.getNextSibling();
}
if (body != null) {
if (body.getType() == TokenTypes.SLIST) {
handleSList(body, block);
}
else {
resolveExpression(body, block, null, true);
}
SymTabAST elseBody = (SymTabAST) body.getNextSibling();
//handle Checkstyle grammar
while ((elseBody != null)
&& (elseBody.getType() != TokenTypes.LITERAL_ELSE)) {
elseBody = (SymTabAST) elseBody.getNextSibling();
}
/*
if (elseBody != null && elseBody.getType() == TokenTypes.SLIST) {
handleSList(elseBody, block);
}else{
resolveExpression(elseBody, block, null, true);
}
*/
if (elseBody != null) {
elseBody = (SymTabAST) elseBody.getFirstChild();
}
if (elseBody != null) {
resolveExpression(elseBody, block.getParentScope(), null, true);
}
}
}
/**
* processes a while loop and resolves references in it
*
* @param block the BlockDef to process
*/
private void handleWhileAndSynchronized(BlockDef block) {
SymTabAST node = block.getTreeNode();
SymTabAST condition =
(node.findFirstToken(TokenTypes.EXPR));
SymTabAST slist = (SymTabAST) (condition.getNextSibling());
// handle Checkstyle grammar
if (slist.getType() == TokenTypes.RPAREN) {
slist = (SymTabAST) slist.getNextSibling();
}
resolveExpression(condition, block, null, true);
handleSList(slist, block);
}
private void handleDoWhile(BlockDef block) {
SymTabAST node = block.getTreeNode();
SymTabAST slist = (SymTabAST) node.getFirstChild();
SymTabAST condition =
node.findFirstToken(TokenTypes.EXPR);
handleSList(slist, block);
resolveExpression(condition, block, null, true);
}
/**
* processes a variable definition and resolves references in it
*
* @param variable the VariableDef to process
*/
protected void handleVariable(VariableDef variable) {
SymTabAST node = variable.getTreeNode();
Scope location = variable.getParentScope();
SymTabAST nameNode = node.findFirstToken(TokenTypes.IDENT);
nameNode.setDefinition(variable, location, true);
SymTabAST typeNode = node.findFirstToken(TokenTypes.TYPE);
resolveType(typeNode, location, null, true);
SymTabAST assignmentNode = node.findFirstToken(TokenTypes.ASSIGN);
if (assignmentNode != null) {
resolveExpression(
(SymTabAST) (assignmentNode.getFirstChild()),
variable.getParentScope(),
null,
true);
}
}
/**
* processes a label and resolves references in it
*
* @param label the LabelDef to process
*/
protected void handleLabel(LabelDef label) {
SymTabAST node = label.getTreeNode();
((SymTabAST) node.getFirstChild()).setDefinition(
label,
label.getParentScope(),
true);
}
/**
* Resolves Java expressions, returning the type to which the expression
* evalutes. If this is the reference creation phase, any references found during resolution are created and
* resolved.
*
* @param expression the SymTabAST representing the expression
* @param location the Scope in which the expression occours.
* @param context the Scope in which the search for the
* definition will start
* @param referencePhase whether or not this is the reference phase of
* table construction
*
* @return the ClassDef representing the type to which the
* expression evalutes.
*/
public IClass resolveExpression(
SymTabAST expression,
Scope location,
IClass context,
boolean referencePhase) {
IClass result = null;
try {
switch (expression.getType()) {
case TokenTypes.TYPECAST :
result =
resolveTypecast(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.EXPR :
case TokenTypes.LITERAL_RETURN :
if (expression.getFirstChild() != null) {
result =
resolveExpression(
(SymTabAST) expression.getFirstChild(),
location,
context,
referencePhase);
}
else {
// YOU WRITE BAD CODE!
}
break;
case TokenTypes.ELIST :
SymTabAST child = (SymTabAST) (expression.getFirstChild());
while (child != null) {
if (child.getType() != TokenTypes.COMMA) {
resolveExpression(
child,
location,
context,
referencePhase);
}
child = (SymTabAST) (child.getNextSibling());
}
break;
case TokenTypes.IDENT :
result =
resolveIdent(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.TYPE :
result =
resolveType(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.METHOD_CALL :
//case TokenTypes.SUPER_CTOR_CALL :
result =
resolveMethod(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.LITERAL_THIS :
result = resolveLiteralThis(expression, location, context);
break;
case TokenTypes.LITERAL_SUPER :
result = resolveLiteralSuper(expression, location, context);
break;
case TokenTypes.DOT :
result =
resolveDottedName(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.LITERAL_NEW :
case TokenTypes.CTOR_CALL :
case TokenTypes.SUPER_CTOR_CALL :
result =
resolveNew(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.LITERAL_BOOLEAN :
case TokenTypes.LITERAL_DOUBLE :
case TokenTypes.LITERAL_FLOAT :
case TokenTypes.LITERAL_LONG :
case TokenTypes.LITERAL_INT :
case TokenTypes.LITERAL_SHORT :
case TokenTypes.LITERAL_BYTE :
case TokenTypes.LITERAL_CHAR :
result =
resolvePrimitiveType(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.NUM_INT :
case TokenTypes.NUM_LONG :
result = resolveNumInt(expression, location, context);
break;
case TokenTypes.NUM_FLOAT :
case TokenTypes.NUM_DOUBLE :
result = resolveNumFloat(expression, location, context);
break;
case TokenTypes.STRING_LITERAL :
result =
resolveStringLiteral(expression, location, context);
break;
case TokenTypes.CHAR_LITERAL :
result = resolveCharLiteral(expression, location, context);
break;
case TokenTypes.ASSIGN :
case TokenTypes.PLUS_ASSIGN :
case TokenTypes.MINUS_ASSIGN :
case TokenTypes.STAR_ASSIGN :
case TokenTypes.DIV_ASSIGN :
case TokenTypes.MOD_ASSIGN :
case TokenTypes.SR_ASSIGN :
case TokenTypes.BSR_ASSIGN :
case TokenTypes.SL_ASSIGN :
case TokenTypes.BAND_ASSIGN :
case TokenTypes.BXOR_ASSIGN :
case TokenTypes.BOR_ASSIGN :
resolveAssignment(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.LOR :
case TokenTypes.LAND :
case TokenTypes.NOT_EQUAL :
case TokenTypes.EQUAL :
case TokenTypes.LT :
case TokenTypes.GT :
case TokenTypes.LE :
case TokenTypes.GE :
result =
resolveBooleanExpression(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.LITERAL_INSTANCEOF :
result =
resolveInstanceOf(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.LITERAL_TRUE :
case TokenTypes.LITERAL_FALSE :
result =
resolveBooleanLiteral(expression, location, context);
break;
case TokenTypes.LNOT :
result =
resolveBooleanUnary(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.INC :
case TokenTypes.POST_INC :
case TokenTypes.DEC :
case TokenTypes.POST_DEC :
case TokenTypes.UNARY_PLUS :
case TokenTypes.UNARY_MINUS :
result =
resolveUnaryExpression(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.PLUS :
case TokenTypes.MINUS :
case TokenTypes.DIV :
case TokenTypes.STAR :
case TokenTypes.BAND :
case TokenTypes.BOR :
case TokenTypes.BXOR :
case TokenTypes.MOD :
result =
resolveArithmeticExpression(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.LITERAL_BREAK :
case TokenTypes.LITERAL_CONTINUE :
resolveGoto(expression, location, context, referencePhase);
break;
case TokenTypes.LPAREN :
result = resolveExpression(
//TODO: child || sibling?
(SymTabAST) (expression.getNextSibling()),
//(SymTabAST) (expression.getFirstChild()),
location, context, referencePhase);
break;
case TokenTypes.INDEX_OP :
result =
resolveArrayAccess(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.LITERAL_NULL :
result = new NullClass();
break;
case TokenTypes.QUESTION :
result =
resolveQuestion(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.LITERAL_CLASS :
result = resolveLiteralClass();
break;
case TokenTypes.ARRAY_INIT :
resolveArrayInitializer(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.LITERAL_THROW :
resolveThrowExpression(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.SL :
case TokenTypes.SR :
case TokenTypes.BSR :
result =
resolveShiftOperator(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.BNOT :
resolveBitwiseNot(
expression,
location,
context,
referencePhase);
break;
case TokenTypes.LITERAL_ASSERT :
// resolveAssert(
// expression,
// location,
// context,
// referencePhase);
break;
case TokenTypes.RPAREN :
case TokenTypes.EMPTY_STAT :
// case TokenTypes.ML_COMMENT:
// case TokenTypes.SL_COMMENT:
case TokenTypes.VARIABLE_DEF :
case TokenTypes.METHOD_DEF :
case TokenTypes.CLASS_DEF :
case TokenTypes.LITERAL_FOR :
case TokenTypes.LITERAL_WHILE :
case TokenTypes.LITERAL_IF :
case TokenTypes.LITERAL_VOID :
// case TokenTypes.LITERAL_INTERFACE:
case TokenTypes.LITERAL_DO :
case TokenTypes.LITERAL_SWITCH :
case TokenTypes.LITERAL_STATIC :
case TokenTypes.LITERAL_TRANSIENT :
case TokenTypes.LITERAL_NATIVE :
// case TokenTypes.LITERAL_threadsafe:
case TokenTypes.LITERAL_SYNCHRONIZED :
case TokenTypes.LITERAL_VOLATILE :
case TokenTypes.LITERAL_TRY :
case TokenTypes.LITERAL_CATCH :
case TokenTypes.LITERAL_FINALLY :
case TokenTypes.LABELED_STAT :
case TokenTypes.LCURLY :
case TokenTypes.RCURLY :
case TokenTypes.SLIST :
case TokenTypes.SEMI :
case TokenTypes.COMMA :
case TokenTypes.ARRAY_DECLARATOR :
break;
default :
//TODO: throw exception
if (mInitialized) {
final Log log =
mLogFactory.getInstance(this.getClass());
log.error(
"Unhandled expression type: "
+ expression.getType());
}
break;
}
}
catch (Exception e) {
result = new UnknownClass(expression.getText(), expression);
// TODO: This really should be logged
// if (mInitialized) {
// final Log log = mLogFactory.getInstance(this.getClass());
// log.error("Error resolving near " + expression);
// }
}
return result;
}
private IClass resolveTypecast(
SymTabAST node,
Scope location,
IClass context,
boolean referencePhase) {
SymTabAST typeNode = (SymTabAST) node.getFirstChild();
SymTabAST exprNode = (SymTabAST) typeNode.getNextSibling();
//handle Checkstyle grammar
if (exprNode.getType() == TokenTypes.RPAREN) {
exprNode = (SymTabAST) exprNode.getNextSibling();
}
IClass type = null;
final SymTabAST child = (SymTabAST) typeNode.getFirstChild();
// TODO: Checkstyle change.
// Do not create references from typecast.
// Original transmogrify code is equivalent to
// final boolean createReference = referencePhase;
// which creates non-existant references for variables.
final boolean createReference = false;
if (child.getType()
== TokenTypes.ARRAY_DECLARATOR) {
type =
new ArrayDef(
resolveType(
(SymTabAST) typeNode.getFirstChild(),
location,
context,
createReference));
}
else {
type = resolveType(typeNode, location, context, createReference);
}
resolveExpression(exprNode, location, context, referencePhase);
//TODO: Checkstyle change. Can this be ignored?
if (type != null) {
((SymTabAST) typeNode.getFirstChild()).setDefinition(
type,
location,
referencePhase);
}
return type;
}
private IClass resolveArrayAccess(
SymTabAST node,
Scope location,
IClass context,
boolean referencePhase) {
SymTabAST arrayNode = (SymTabAST) (node.getFirstChild());
SymTabAST exprNode = (SymTabAST) (arrayNode.getNextSibling());
//resolve index expressions
while (arrayNode.getType() == TokenTypes.INDEX_OP) {
resolveExpression(exprNode, location, context, referencePhase);
arrayNode = (SymTabAST) (arrayNode.getFirstChild());
exprNode = (SymTabAST) (arrayNode.getNextSibling());
}
ArrayDef array =
(ArrayDef) resolveExpression(arrayNode,
location,
context,
referencePhase);
resolveExpression(exprNode, location, context, referencePhase);
return array.getType();
}
private IClass resolveLiteralClass() {
return new ExternalClass(Class.class);
}
/**
* Resolves any dotted reference, returning the Scope
* identified by the reference.
*
* @param tree the root node of the dotted reference
* @param location the Scope in which the expression occours.
* @param context the Scope in which the search for the
* definition will start
* @return the Scope indentified by the reference
*/
private IClass resolveDottedName(
SymTabAST tree,
Scope location,
IClass context,
boolean referencePhase) {
IClass result = null;
IClass localContext = context;
String name = null;
DotIterator it = new DotIterator(tree);
while (it.hasNext()) {
SymTabAST node = it.nextNode();
if (node.getType() != TokenTypes.COMMA) {
localContext =
resolveExpression(
node,
location,
localContext,
referencePhase);
if (localContext == null) {
node.setMeaningfulness(false);
name = node.getText();
while (localContext == null && it.hasNext()) {
SymTabAST next = it.nextNode();
name = name + "." + next.getText();
localContext = location.getClassDefinition(name);
if (localContext != null && referencePhase) {
next.setDefinition(
localContext,
location,
referencePhase);
}
else {
next.setMeaningfulness(false);
}
}
}
}
}
if (localContext != null) {
result = localContext;
}
else {
result = new UnknownClass(name, tree);
}
return result;
}
/**
* Resolves a method call.
*
* @param methodNode the SymTabAST for the METHOD_CALL node
* @param location the Scope where the expression occurs
* @param context the Scope in which the expression occurs
* (where the search for a defintion begins)
* @param referencePhase whether or not this is the reference phase of
* table construction
*
* @return the ClassDef for the type returned by the method
*/
private IClass resolveMethod(
SymTabAST methodNode,
Scope location,
IClass context,
boolean referencePhase) {
IClass result = new UnknownClass(methodNode.getText(), methodNode);
IClass newContext = null;
if (context == null) {
newContext = location.getEnclosingClass();
}
else {
newContext = context;
}
String name = null;
boolean createReference = true;
SymTabAST nameNode = (SymTabAST) (methodNode.getFirstChild());
SymTabAST parametersNode = (SymTabAST) (nameNode.getNextSibling());
ISignature signature =
resolveParameters(
parametersNode,
location,
context,
referencePhase);
if (nameNode.getType() == TokenTypes.IDENT) {
name = nameNode.getText();
}
else if (
nameNode.getType() == TokenTypes.LITERAL_SUPER
|| (nameNode.getType() == TokenTypes.SUPER_CTOR_CALL)) {
IClass superclass = location.getEnclosingClass().getSuperclass();
newContext = superclass;
name = superclass.getName();
createReference = false;
}
else if (nameNode.getType() == TokenTypes.LITERAL_THIS) {
newContext = location.getEnclosingClass();
name = newContext.getName();
createReference = false;
}
else {
// REDTAG -- doing dotted name resolution on its own
SymTabAST contextNode = (SymTabAST) (nameNode.getFirstChild());
//TODO: handle Checkstyle grammar
nameNode = (SymTabAST) contextNode.getNextSibling();
//skip to IDENT
while (nameNode.getType() != TokenTypes.IDENT) {
nameNode = (SymTabAST) nameNode.getNextSibling();
}
name = nameNode.getText();
newContext =
resolveExpression(
contextNode,
location,
context,
referencePhase);
}
if (newContext != null) {
IMethod method = newContext.getMethodDefinition(name, signature);
if (method != null) {
if (createReference && referencePhase) {
nameNode.setDefinition(method, location, referencePhase);
}
result = method.getType();
}
}
if (result == null) {
result = new UnknownClass(methodNode.getText(), methodNode);
}
return result;
}
/**
* resolves a literal "this"
*
* @param expression the SymTabAST of the expression
* @param location the Scope where the expression occurs
* @param context the Scope in which the expression occurs
* (where the search for a defintion begins)
*
* @return the resulting scope of the expression (the type to which it evaluates)
*/
private IClass resolveLiteralThis(
SymTabAST thisNode,
Scope location,
IClass context) {
return location.getEnclosingClass();
}
/**
* resolves a literal "super"
*
* @param expression the SymTabAST of the expression
* @param location the Scope where the expression occurs
* @param context the Scope in which the expression occurs
* (where the search for a defintion begins)
*
* @return the resulting scope of the expression (the type to which it evaluates)
*/
private IClass resolveLiteralSuper(
SymTabAST superNode,
Scope location,
IClass context) {
return location.getEnclosingClass().getSuperclass();
}
private boolean newIsConstructor(SymTabAST newNode) {
boolean result = false;
SymTabAST typeNode =
(SymTabAST) (newNode.getFirstChild().getNextSibling());
//handle Checkstyle grammar
if (typeNode.getType() == TokenTypes.LPAREN) {
typeNode = (SymTabAST) typeNode.getNextSibling();
}
if (typeNode.getType() == TokenTypes.ELIST) {
result = true;
}
return result;
}
/**
* resolves and expression of type TokenTypes.TYPE
*
* @param expression the SymTabAST of the expression
* @param location the Scope where the expression occurs
* @param context the Scope in which the expression occurs
* (where the search for a defintion begins)
* @param referencePhase whether or not this is the reference phase of
* table construction
* @return the resulting scope of the expression (the type to which it evaluates)
* @see #resolveDottedName(SymTabAST, Scope, IClass, boolean)
* @see #resolveClassIdent(SymTabAST, Scope, IClass, boolean)
*/
public IClass resolveType(
SymTabAST expr,
Scope location,
IClass context,
boolean referencePhase) {
IClass result = null;
SymTabAST nameNode = (SymTabAST) expr.getFirstChild();
// TODO: Checkstyle change.
// Do not create references from typecast.
// Original transmogrify code is equivalent to
// final boolean createReference = referencePhase;
// which creates non-existant references for variables.
final boolean createReference = false;
if (nameNode.getType() == TokenTypes.DOT) {
result =
resolveDottedName(nameNode, location, context, createReference);
}
else {
result =
resolveClassIdent(nameNode, location, context, createReference);
}
return result;
}
/**
* resolves Class type expression
* @param expr node to be resolved
* @param location scope of the expr
* @param context context of the expr if exists
* @param referencePhase true if this method is used to during
* finding reference phase
* false otherwise
* @return IClass representing the type to which the
* expression evalutes.
* @see #resolveDottedName(SymTabAST, Scope, IClass, boolean)
*/
public IClass resolveClass(
SymTabAST expr,
Scope location,
IClass context,
boolean referencePhase) {
IClass result =
resolveDottedName(expr, location, context, referencePhase);
if (result != null && referencePhase) {
expr.setDefinition(result, location, referencePhase);
}
return result;
}
/**
* resolves expression with JavaTokenTypes other than DOT
* @param expr expression to be resolved
* @param location scope of the expression
* @param context context of the expression if any
* @param referencePhase true if this method is used to during
* finding reference phase
* false otherwise
* @return IClass representing the type to which the
* expression evalutes.
*/
public IClass resolveClassIdent(
SymTabAST expr,
Scope location,
IClass context,
boolean referencePhase) {
IClass result = location.getClassDefinition(expr.getText());
if (result != null) {
expr.setDefinition(result, location, referencePhase);
}
return result;
}
private IClass resolveNew(
SymTabAST newNode,
Scope location,
IClass context,
boolean referencePhase) {
IClass result;
if (newIsConstructor(newNode)) {
result =
resolveConstructor(newNode, location, context, referencePhase);
}
else {
result =
resolveNewArray(newNode, location, context, referencePhase);
}
return result;
}
private IClass resolveNewArray(
SymTabAST newNode,
Scope location,
IClass context,
boolean referencePhase) {
IClass arrayType;
SymTabAST typeNode = (SymTabAST) (newNode.getFirstChild());
SymTabAST declaratorNode = (SymTabAST) (typeNode.getNextSibling());
SymTabAST initializerNode =
(SymTabAST) (declaratorNode.getNextSibling());
arrayType = resolveClass(typeNode, location, context, referencePhase);
if (declaratorNode.getFirstChild() != null) {
resolveExpression(
((SymTabAST) declaratorNode.getFirstChild()),
location,
context,
referencePhase);
}
if (initializerNode != null) {
resolveArrayInitializer(
initializerNode,
location,
context,
referencePhase);
}
return new ArrayDef(arrayType);
}
private IClass resolveQuestion(
SymTabAST question,
Scope location,
IClass context,
boolean referencePhase) {
SymTabAST test = (SymTabAST) question.getFirstChild();
while (test.getType() == TokenTypes.LPAREN) {
test = (SymTabAST) test.getNextSibling();
}
SymTabAST leftBranch = (SymTabAST) test.getNextSibling();
while (leftBranch.getType() == TokenTypes.RPAREN) {
leftBranch = (SymTabAST) leftBranch.getNextSibling();
}
SymTabAST rightBranch = (SymTabAST) leftBranch.getNextSibling();
while (rightBranch.getType() != TokenTypes.COLON) {
rightBranch = (SymTabAST) rightBranch.getNextSibling();
}
rightBranch = (SymTabAST) rightBranch.getNextSibling();
resolveExpression(test, location, context, referencePhase);
IClass leftClass =
resolveExpression(leftBranch, location, context, referencePhase);
IClass rightClass =
resolveExpression(rightBranch, location, context, referencePhase);
return moreGeneral(leftClass, rightClass);
}
private IClass moreGeneral(IClass a, IClass b) {
return (a.isCompatibleWith(b)) ? b : a;
}
/**
* Resolves a constructor call.
*
* @param tree the root node of the constructor call
* @return the ClassDef for the class instantiated by the
* constructor
*/
private IClass resolveConstructor(
SymTabAST constructor,
Scope location,
IClass context,
boolean referencePhase) {
IClass classConstructed = null;
SymTabAST nameNode = (SymTabAST) (constructor.getFirstChild());
//SymTabAST parametersNode = (SymTabAST) (nameNode.getNextSibling());
SymTabAST parametersNode =
constructor.findFirstToken(TokenTypes.ELIST);
SymTabAST nameIdent = null;
if (nameNode.getType() == TokenTypes.IDENT) {
nameIdent = nameNode;
}
else {
nameIdent = (SymTabAST) nameNode.getFirstChild().getNextSibling();
}
classConstructed = resolveClass(nameNode, location, context, false);
if (classConstructed != null) {
MethodSignature signature =
resolveParameters(
parametersNode,
location,
context,
referencePhase);
IMethod constructorDef =
classConstructed.getMethodDefinition(
nameIdent.getText(),
signature);
if (constructorDef != null && referencePhase) {
nameIdent.setDefinition(
constructorDef,
location,
referencePhase);
}
}
return classConstructed;
}
/**
* Resolves the types found in a method call. Any references found
* in the process are created. Returns a MethodSignature for
* the types of the parameters.
*
* @param elist The SymTabAST for the list of parameters
* @return the signature of the parameters
*/
private MethodSignature resolveParameters(
SymTabAST elist,
Scope location,
IClass context,
boolean referencePhase) {
Vector parameters = new Vector();
SymTabAST expr = (SymTabAST) (elist.getFirstChild());
while (expr != null) {
if (expr.getType() != TokenTypes.COMMA) {
IClass parameter =
resolveExpression((SymTabAST) (expr
.getFirstChild()),
location,
context,
referencePhase);
parameters.add(parameter);
}
expr = (SymTabAST) (expr.getNextSibling());
}
return new MethodSignature(parameters);
}
/**
* Resolves an IDENT node of an AST, creating the appropriate reference and
* returning the scope of the identifer.
*
* @param ident the IDENT node
* @param location the Scope in which the IDENT is found
* @return the Scope the identifier identifies
*/
private IClass resolveIdent(
SymTabAST ident,
Scope location,
IClass context,
boolean referencePhase) {
IClass result = null;
IDefinition def = null;
String name = ident.getText();
// look for var
if (context != null) {
def = context.getVariableDefinition(name);
}
else {
def = location.getVariableDefinition(name);
}
if (def != null) {
result = ((IVariable) def).getType();
}
else {
// look for class
if (context != null) {
result = context.getClassDefinition(name);
}
else {
result = location.getClassDefinition(name);
}
def = result;
}
if (def != null) {
ident.setDefinition(def, location, referencePhase);
}
return result;
}
/**
* Resolves a (binary) boolean expression. The left and right sides of the
* expression
* are resolved in the process.
*
* @param expression the SymTabAST representing the boolean
* expression.
* @return the Scope for the boolean primitive type.
*/
private IClass resolveBooleanExpression(
SymTabAST expression,
Scope location,
IClass context,
boolean referencePhase) {
IClass result = null;
SymTabAST leftChild = findLeftChild(expression);
resolveExpression(leftChild, location, context, referencePhase);
SymTabAST rightChild = findRightSibling(leftChild);
resolveExpression(rightChild, location, context, referencePhase);
result = LiteralResolver.getDefinition(TokenTypes.LITERAL_BOOLEAN);
return result;
}
/**
* resolves references in an assignment expression
*
* @param expression the SymTabAST of the expression
* @param location the Scope where the expression occurs
* @param context the Scope in which the expression occurs
* (where the search for a defintion begins)
*
* @return the resulting scope of the expression (the type to which it evaluates)
*/
private IClass resolveAssignment(
SymTabAST expression,
Scope location,
IClass context,
boolean referencePhase) {
IClass result = null;
SymTabAST leftNode = (SymTabAST) (expression.getFirstChild());
SymTabAST rightNode = (SymTabAST) (leftNode.getNextSibling());
result = resolveExpression(leftNode, location, context, referencePhase);
resolveExpression(rightNode, location, context, referencePhase);
return result;
}
/**
* Resolves a unary expression. Returns the type of the expression,
* creating any references found along the way. Unary expressions are
* increment (x++), decrement (x--), unary plus (+x), and unary minus (-x)
*
* @param expression the SymTabAST of the unary expression.
* @return the Scope for the type to which the expression
* evalutes.
*/
private IClass resolveUnaryExpression(
SymTabAST expression,
Scope location,
IClass context,
boolean referencePhase) {
SymTabAST operatee = (SymTabAST) (expression.getFirstChild());
return resolveExpression(operatee, location, context, referencePhase);
}
/**
* Resolves an arithmetic expression. Returns the Scope for
* the type to which the expression resolves. Any references found during
* resolution are created and resolved.
*
* @param expression the SymTabAST representing the arithmetic
* expression.
*
* @return the Scope for the type to which the expression
* evaluates.
*/
private IClass resolveArithmeticExpression(
SymTabAST expression,
Scope location,
IClass context,
boolean referencePhase) {
IClass result = null;
SymTabAST leftChild = findLeftChild(expression);
IClass leftType =
(resolveExpression(leftChild,
location,
context,
referencePhase));
SymTabAST rightChild = findRightSibling(leftChild);
IClass rightType =
(resolveExpression(rightChild,
location,
context,
referencePhase));
result = binaryResultType(leftType, rightType);
return result;
}
/**
* Finds the left child of a binary operator, skipping parentheses.
* @param aExpression the node for the binary operator.
* @return the node for the left child.
*/
private SymTabAST findLeftChild(SymTabAST aExpression) {
SymTabAST leftChild = (SymTabAST) (aExpression.getFirstChild());
// handle Checkstyle grammar
while (leftChild.getType() == TokenTypes.LPAREN) {
leftChild = (SymTabAST) leftChild.getNextSibling();
}
return leftChild;
}
/**
* Finds the right sibling of the left child of a binary operator,
* skipping parentheses.
* @param aLeftChild the left child of a binary operator.
* @return the node of the right sibling.
*/
private SymTabAST findRightSibling(SymTabAST aLeftChild) {
SymTabAST rightChild = (SymTabAST) (aLeftChild.getNextSibling());
// handle Checkstyle grammar
while ((rightChild != null)
&& (rightChild.getType() == TokenTypes.RPAREN))
{
rightChild = (SymTabAST) rightChild.getNextSibling();
}
return rightChild;
}
/**
* Returns the ClassDef for the type to which arithmetic
* expressions evaluate.
*
* @param a the ClassDef of the first operand.
* @param b the ClassDef of the second operand.
*
* @return the ClassDef to which the expression evaluates.
*/
private IClass binaryResultType(IClass a, IClass b) {
IClass result = null;
// These may or may not be in line with the rules set forth in the java
// language specification. Not being in line would be a BadThing(r).
IClass string = new ExternalClass(java.lang.String.class);
if (a.equals(string) || b.equals(string)) {
result = string;
}
else if (a.equals(PrimitiveClasses.BOOLEAN)) {
result = PrimitiveClasses.BOOLEAN;
}
else {
result =
PrimitiveClasses.binaryPromote(
a,
b);
}
return result;
}
/**
* resolves references in an instanceof expression
*
* @param expression the SymTabAST of the expression
* @param location the Scope where the expression occurs
* @param context the Scope in which the expression occurs
* (where the search for a defintion begins)
*
* @return the resulting scope of the expression (the type to which it evaluates)
*/
private IClass resolveInstanceOf(
SymTabAST expression,
Scope location,
IClass context,
boolean referencePhase) {
SymTabAST leftNode = (SymTabAST) (expression.getFirstChild());
SymTabAST rightNode = (SymTabAST) (leftNode.getNextSibling());
resolveExpression(leftNode, location, context, referencePhase);
SymTabAST classNameNode = (SymTabAST) (rightNode.getFirstChild());
resolveClass(classNameNode, location, context, referencePhase);
return LiteralResolver.getDefinition(TokenTypes.LITERAL_BOOLEAN);
}
/**
* resolves references in a a break statement
*
* @param expression the SymTabAST for the expression
* @param location the Scope where the expression occurs
* @param context the Scope in which the expression occurs
* (where the search for a defintion begins)
*
* @return the Scope for the int primitive type
*/
private IClass resolveGoto(
SymTabAST expression,
Scope location,
IClass context,
boolean referencePhase) {
SymTabAST label = (SymTabAST) (expression.getFirstChild());
// handle Checkstyle grammar
if (label != null && (label.getType() != TokenTypes.SEMI)) {
LabelDef def = location.getLabelDefinition(label.getText());
if (def != null) {
label.setDefinition(def, location, referencePhase);
}
}
return null;
}
private IClass resolvePrimitiveType(
SymTabAST primitive,
Scope location,
IClass context,
boolean referencePhase) {
IClass result =
LiteralResolver.getDefinition(primitive.getType());
primitive.setDefinition(result, location, referencePhase);
return result;
}
/**
* Returns the ClassDef of the int primitive type. This may
* need to be amended, based on the Java Language spec, to return a long
* if the literal is larger than an int can hold.
*
* @param expression the SymTabAST for the integer literal
* @param location the Scope where the expression occurs
* @param context the Scope in which the expression occurs
* (where the search for a defintion begins)
*
* @return the Scope for the int primitive type
*/
private IClass resolveNumInt(
SymTabAST expression,
Scope location,
IClass context) {
return PrimitiveClasses.INT;
}
/**
* Returns the ClassDef type of the float primitive type.
* This may need to be amended, based on the Java Language spec, to return
* a double if the literal is larger than a float can hold.
*
* @param expression the SymTabAST for the floating point
literal
* @param location the Scope where the expression occurs
* @param context the Scope in which the expression occurs
* (where the search for a defintion begins)
*
* @return the Scope for the float primitive type
*/
private IClass resolveNumFloat(
SymTabAST expression,
Scope location,
IClass context) {
return PrimitiveClasses.DOUBLE;
}
/**
* Returns the ClassDef type of a string literal
*
* @param expression the SymTabAST for a string literal
* @param location the Scope where the expression occurs
* @param context the Scope in which the expression occurs
* (where the search for a defintion begins)
*
* @return the Scope type of a string literal
*/
private IClass resolveStringLiteral(
SymTabAST expression,
Scope location,
IClass context) {
return LiteralResolver.getDefinition(
TokenTypes.STRING_LITERAL);
}
/**
* Returns the ClassDef type of a character literal
*
* @param expression the SymTabAST for a string literal
* @param location the Scope where the expression occurs
* @param context the Scope in which the expression occurs
* (where the search for a defintion begins)
*
* @return the Scope type of a character literal
*/
private IClass resolveCharLiteral(
SymTabAST expression,
Scope location,
IClass context) {
return LiteralResolver.getDefinition(
TokenTypes.LITERAL_CHAR);
}
/**
* Describe resolveBooleanLiteral method here.
*
* @param expression the SymTabAST of the expression
* @param location the Scope where the expression occurs
* @param context the Scope in which the expression occurs
* (where the search for a defintion begins)
*
* @return the Scope for the boolean primitive.
*/
private IClass resolveBooleanLiteral(
SymTabAST expression,
Scope location,
IClass context) {
return LiteralResolver.getDefinition(TokenTypes.LITERAL_BOOLEAN);
}
private IClass resolveBooleanUnary(
SymTabAST expression,
Scope location,
IClass context,
boolean referencePhase) {
SymTabAST child = (SymTabAST) expression.getFirstChild();
resolveExpression(child, location, context, referencePhase);
return LiteralResolver.getDefinition(TokenTypes.LITERAL_BOOLEAN);
}
/**
* Resolves a constructor call.
*
* @param tree the root node of the constructor call
* @return the ClassDef for the class instantiated by the
* constructor
*/
private void resolveArrayInitializer(
SymTabAST initializerNode,
Scope location,
IClass context,
boolean referencePhase) {
SymTabAST child = (SymTabAST) (initializerNode.getFirstChild());
while (child != null) {
if (child.getType() != TokenTypes.COMMA) {
resolveExpression(child, location, context, referencePhase);
}
child = (SymTabAST) (child.getNextSibling());
}
}
/**
* Resolves a constructor call.
*
* @param tree the root node of the constructor call
* @return the ClassDef for the class instantiated by the
* constructor
*/
private void resolveThrowExpression(
SymTabAST throwNode,
Scope location,
IClass context,
boolean referencePhase) {
SymTabAST nameNode = (SymTabAST) (throwNode.getFirstChild());
resolveExpression(nameNode, location, context, referencePhase);
}
private IClass resolveShiftOperator(
SymTabAST expression,
Scope location,
IClass context,
boolean referencePhase) {
IClass result = null;
SymTabAST leftChild = findLeftChild(expression);
SymTabAST rightChild = findRightSibling(leftChild);
result =
resolveExpression(leftChild, location, context, referencePhase);
resolveExpression(rightChild, location, context, referencePhase);
result = PrimitiveClasses.unaryPromote(result);
return result;
}
private IClass resolveBitwiseNot(
SymTabAST expression,
Scope location,
IClass context,
boolean referencePhase) {
IClass result = null;
SymTabAST child = (SymTabAST) expression.getFirstChild();
result = resolveExpression(child, location, context, referencePhase);
result = PrimitiveClasses.unaryPromote(result);
return result;
}
}
././@LongLink 100644 0 0 161 12026055133 10246 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/Scope.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 10062 11451071612 31463 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.Vector;
/**
* Represents a scope of Java code.
*
* @author andrew mccormick, dave wood
* @version 1.0
* @since 1.0
* @see Definition
* @see Resolvable
*/
public abstract class Scope extends Definition {
// rename to references?
protected SortedSet referencesInScope = new TreeSet();
protected Hashtable elements = new Hashtable();
protected Hashtable labels = new Hashtable();
protected Hashtable classes = new Hashtable();
public Scope( String name, Scope parentScope, SymTabAST node ) {
super( name, parentScope, node );
}
public void addDefinition(VariableDef def) {
elements.put(def.getName(), def);
}
public void addDefinition(BlockDef def) {
elements.put(def.getName(), def);
}
public void addDefinition(ClassDef def) {
classes.put(def.getName(), def);
}
public void addDefinition(LabelDef def) {
labels.put(def.getName(), def);
}
public abstract void addDefinition(IPackage def);
protected Enumeration getDefinitions() {
Vector allElements = new Vector();
allElements.addAll(elements.values());
allElements.addAll(labels.values());
allElements.addAll(classes.values());
return allElements.elements();
}
protected Iterator getClasses() {
return classes.values().iterator();
}
public abstract IMethod getMethodDefinition(String name, ISignature signature);
public abstract IVariable getVariableDefinition(String name);
public abstract LabelDef getLabelDefinition(String name);
public abstract IClass getClassDefinition(String name);
public Iterator getReferencesIn() {
return referencesInScope.iterator();
}
public Reference getSymbol(String name, Occurrence location) {
Reference result = null;
for (Iterator it = getReferencesIn(); it.hasNext(); ) {
Reference reference = (Reference)it.next();
// if (name.equals(reference.getName())) {
if (reference.getLine() == location.getLine() &&
reference.getColumn() == location.getColumn()) {
result = reference;
break;
}
// }
}
return result;
}
public void addReferenceInScope( Reference reference ) {
referencesInScope.add( reference );
}
}
././@LongLink 100644 0 0 166 12026055133 10253 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/ScopeIndex.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 11601 11451071612 31463 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.Hashtable;
import java.util.Vector;
/**
* ScopeIndex provides methods for finding Scopes
* related to a known Occurrence
*/
public class ScopeIndex {
//This is a Hashtable full of Vectors. The keys to this hashtable are filenames.
//Each vector contains all of the scope objects from the specific file.
private Hashtable indexOfFiles = new Hashtable();
public Hashtable getIndex() {
return indexOfFiles;
}
/**
* returns the most specific Scope to which the specified
* Occurence belongs.
*
* @param occ the Occurrence whose Scope we're interested in.
* @return Scope
*/
public Scope lookup(Occurrence occ) {
String key = occ.getFile().getAbsolutePath();
Vector scopeList = getFileVector(key);
Scope result = findScope(scopeList, occ);
return result;
}
/**
* returns the most specific Scope to which the specified
* Occurence belongs from the specified Vector
* of Scopes.
*
* @param occ the Occurrence whose Scope we're interested in.
* @param scopeList the Vector of Scopes to chose from.
* @return Scope
*/
public Scope findScope(Vector scopeList, Occurrence occ) {
int i = 0;
Scope bestSoFar = (Scope) scopeList.elementAt(i);
while (!bestSoFar
.getTreeNode()
.getSpan()
.contains(occ.getLine(), occ.getColumn())) {
i++;
bestSoFar = (Scope) scopeList.elementAt(i);
}
for (; i < scopeList.size(); i++) {
Scope currentScope = (Scope) scopeList.elementAt(i);
if (currentScope
.getTreeNode()
.getSpan()
.contains(occ.getLine(), occ.getColumn())) {
if (bestSoFar
.getTreeNode()
.getSpan()
.contains(currentScope.getTreeNode().getSpan())) {
bestSoFar = currentScope;
}
}
}
return bestSoFar;
}
/**
* adds a Scope to the ScopeIndex for searching.
*
* @param scope the Scope to add.
*/
public void addScope(Scope scope) {
final SymTabAST SymTabAST = scope.getTreeNode();
SymTabAST.getFile();
Vector fileVector =
getFileVector(scope.getTreeNode().getFile().getAbsolutePath());
fileVector.addElement(scope);
}
/**
* returns the Vector containing the Scopes related
* to the specified filename.
*
* @param fileName the fileName to find scopes for.
* @return Vector
*/
private Vector getFileVector(String fileName) {
Vector result = (Vector) indexOfFiles.get(fileName);
if (result == null) {
result = new Vector();
indexOfFiles.put(fileName, result);
}
return result;
}
} ././@LongLink 100644 0 0 160 12026055133 10245 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/Span.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 11220 11451071612 31460 0 ustar 0 0 //Transmogrify License
//
//Copyright (c) 2001, ThoughtWorks, Inc.
//All rights reserved.
//Redistribution and use in source and binary forms, with or without
//modification, are permitted provided that the following conditions
//are met:
//- Redistributions of source code must retain the above copyright notice,
//this list of conditions and the following disclaimer.
//- Redistributions in binary form must reproduce the above copyright
//notice, this list of conditions and the following disclaimer in the
//documentation and/or other materials provided with the distribution.
//Neither the name of the ThoughtWorks, Inc. nor the names of its
//contributors may be used to endorse or promote products derived from this
//software without specific prior written permission.
//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
//"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
//TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
//PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
//CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
//EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
//PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
//OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
//WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
//OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
//ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
public class Span {
private int _startLine;
private int _startColumn;
private int _endLine;
private int _endColumn;
public Span() {}
public Span(int startLine, int startColumn, int endLine, int endColumn) {
setStart(startLine, startColumn);
setEnd(endLine, endColumn);
}
public Span( Span span ) {
this( span.getStartLine(), span.getStartColumn(),
span.getEndLine(), span.getEndColumn() );
}
public void setStart(int startLine, int startColumn) {
_startLine = startLine;
_startColumn = startColumn;
}
public void setEnd(int endLine, int endColumn) {
_endLine = endLine;
_endColumn = endColumn;
}
public int getStartLine() {
return _startLine;
}
public int getStartColumn() {
return _startColumn;
}
public int getEndLine() {
return _endLine;
}
public int getEndColumn() {
return _endColumn;
}
public boolean contains( Span span ) {
return ( contains(span.getStartLine(), span.getStartColumn())
&& contains( span.getEndLine(), span.getEndColumn()) );
}
public boolean contains(int line, int column) {
boolean afterStart = false;
boolean beforeEnd = false;
if ( getStartLine() < line ) {
afterStart = true;
}
else if ( getStartLine() == line && getStartColumn() <= column ) {
afterStart = true;
}
if ( getEndLine() > line ) {
beforeEnd = true;
}
else if ( getEndLine() == line && getEndColumn() >= column ) {
beforeEnd = true;
}
return ( afterStart && beforeEnd );
}
protected boolean startsBefore( Span span ) {
boolean result = false;
if ( getStartLine() < span.getStartLine() ) {
result = true;
}
else if ( getStartLine() == span.getStartLine()
&& getStartColumn() <= span.getStartColumn() ) {
result = true;
}
return result;
}
protected boolean endsAfter( Span span ) {
boolean result = false;
if ( getEndLine() > span.getEndLine() ) {
result = true;
}
else if ( getEndLine() == span.getEndLine()
&& getEndColumn() >= span.getEndColumn() ) {
result = true;
}
return result;
}
public void compose( Span span ) {
if ( span.startsBefore( this ) ) {
setStart( span.getStartLine(), span.getStartColumn() );
}
if ( span.endsAfter( this ) ) {
setEnd( span.getEndLine(), span.getEndColumn() );
}
}
public boolean equals(Object o) {
boolean result = false;
if ( o instanceof Span ) {
Span span = (Span)o;
result = ( span.getStartLine() == getStartLine()
&& span.getStartColumn() == getStartColumn()
&& span.getEndLine() == getEndLine()
&& span.getEndColumn() == getEndColumn() );
}
return result;
}
public String toString() {
return "[" + getStartLine() + "," + getStartColumn()
+ ":" + getEndLine() + "," + getEndColumn() + "]";
}
}
././@LongLink 100644 0 0 167 12026055133 10254 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/SymbolTable.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 16505 11451071612 31473 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.io.File;
import java.util.Hashtable;
import java.util.Stack;
/**
* this class contains all of the definitions, references, and scopes
* created by the system.
*
* Other stuff this class does:
*
*
holds the "base" scope containing primitive definitions
*
holds the java.lang package
*
holds the definition of java.lang.Object, which is the base class
* of all class hierarchies
*
kicks off the resolve step
*
does some of the work of constructing object definitions
*
*/
public class SymbolTable {
private Hashtable packages = new Hashtable();
private Stack scopes = new Stack();
private ScopeIndex index = new ScopeIndex();
private File currentFile;
private BaseScope baseScope;
private SymTabAST root;
// private boolean outOfDate;
/**
* constructor takes SymTabAST
* @param aRoot root of the SymTabAST tree
*/
public SymbolTable(SymTabAST aRoot) {
scopes = new Stack();
this.root = aRoot;
baseScope = new BaseScope( this );
pushScope(baseScope);
}
/**
* gets the root node
* @return SymTabAST
*/
public SymTabAST getTree() {
return root;
}
// /**
// * sets the outOfDate data member to true
// * @return void
// */
// public void expire() {
// outOfDate = true;
// }
//
// /**
// * sets outOfDate member to false
// * @param lastUpdated
// * @return void
// */
// public void update(long lastUpdated) {
// outOfDate = false;
// }
/**
* returns the "base" scope
*
* @return Scope the base scope
*/
// REDTAG -- this should eventually be replaced by a call
// to the lookup method that traverses scopes
public BaseScope getBaseScope() {
return baseScope;
}
/**
* returns the current scope. Scopes are nested in a stack (FIFO queue)
* and pushed/popped based on the structure of the AST
* @return Scope
*/
public Scope getCurrentScope() {
return (Scope)scopes.peek();
}
/**
* pushes a new scope onto the stack
*
* @param scope the Scope to push
* @return void
*/
public void pushScope(Scope scope) {
scopes.push(scope);
}
/**
* pops a scope from the stack.
*
* @return Scope
*
*/
public Scope popScope() {
Scope scope = (Scope)(scopes.pop());
return scope;
}
/**
* gets all packages stored in this symbol table
* @return Hashtable
*/
public Hashtable getPackages() {
// REDTAG -- think about making this available as something simpler,
// perhaps an enumeration
return packages;
}
/**
* gets package by its name
* @param name
* @return PackageDef
*/
public PackageDef getPackage( String name ) {
return (PackageDef)(packages.get( name ));
}
/**
* adds PackageDef to its parent scope and stores the
* PackageDef in packages
* @param pkg
* @param parent
* @return void
*/
public void definePackage( PackageDef pkg, Scope parent ) {
parent.addDefinition(pkg);
packages.put(pkg.getQualifiedName(), pkg);
}
/**
* defines a class in the symbol table.
*
* @param def the class to define
* @return void
* @see #indexScope(Scope)
* @see #getCurrentScope()
*/
public void defineClass(ClassDef def) {
indexScope(def);
getCurrentScope().addDefinition(def);
}
/**
* defines a method in the symbol table
*
* @param method the method to be defined
* @return void
* @see #indexScope(Scope)
* @see #getCurrentScope()
*/
public void defineMethod(MethodDef method) {
indexScope(method);
((ClassDef)getCurrentScope()).addDefinition(method);
}
/**
* defines a variable in the symbol table
*
* @param v the variable to define
* @return void
* @see #getCurrentScope()
*/
public void defineVariable(VariableDef v) {
getCurrentScope().addDefinition(v);
}
/**
* defines a block within the symbol table
*
* @param blockDef the block to define
* @return void
* @see #indexScope(Scope)
* @see #getCurrentScope()
*/
public void defineBlock(BlockDef blockDef) {
indexScope(blockDef);
getCurrentScope().addDefinition(blockDef);
}
/**
* defines a label within the symbol table
*
* @param labelDef the label to define
* @return void
* @see #getCurrentScope()
*/
// REDTAG -- label does not define a new scope
public void defineLabel(LabelDef labelDef) {
getCurrentScope().addDefinition(labelDef);
}
/**
* places a scope in the symbol table's index
*
* @param scope the scope to index
* @return void
*/
public void indexScope(Scope scope) {
index.addScope(scope);
}
/**
* gets the symbol table's scope index
*
* @return ScopeIndex
*/
public ScopeIndex getScopeIndex() {
return index;
}
/**
* sets the current file that the symbol table is processing
*
* @param file the File to use
* @return void
*/
public void setCurrentFile(File file) {
currentFile = file;
}
/**
* gets the file that the symbol table is currently processing
*
* @return File
*/
public File getCurrentFile() {
return currentFile;
}
}
././@LongLink 100644 0 0 200 12026055133 10240 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/SymbolTableException.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 3425 11451071612 31450 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
public class SymbolTableException extends Exception {
public SymbolTableException(String message) {
super(message);
}
} ././@LongLink 100644 0 0 165 12026055133 10252 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/SymTabAST.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 40205 11451071612 31465 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.io.File;
import antlr.collections.AST;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* an extension of antlr.CommonAST that includes
* extra information about the AST's location. This information
* is the file and line number where the AST was created.
*
* To use this AST node in your tree structure, assuming your
* antlr.TreeParser is called parser, use
*
* parser.setASTNOdeCLass(SymTabAST.class.getName());
*
* make sure you also call setTokenObjectClass for the lexer as well
*
*
* @see SymTabToken
*/
//TODO: Should be an adapter of DetailAST
public class SymTabAST
extends antlr.CommonASTWithHiddenTokens
{
private Scope _scope;
private IDefinition _definition = null;
private boolean _isMeaningful = true;
private File _file;
private int _line;
private int _column;
// parent is not used by Checkstyle
// private SymTabAST parent;
private Span _span;
/** original syntax tree node */
private DetailAST detailNode;
// /**
// * gets parent of this node
// * @return SymTabAST
// */
// public SymTabAST getParent() {
// return parent;
// }
// /**
// * gets previous sibling of this node
// * @return SymTabAST
// */
// public SymTabAST getPreviousSibling() {
// return prevSibling;
// }
/**
* sets parent of this node
* @param parent
* @return void
*/
public void setParent(SymTabAST parent) {
//parent is not used by Checkstyle
// this.parent = parent;
}
/**
* gets the scope of this node
* @return Scope
*/
public Scope getScope() {
return _scope;
}
/**
* sets the scope of this node
* @param scope
* @return void
*/
public void setScope(Scope scope) {
_scope = scope;
}
/**
* sets Definition for this node
* @param definition
* @param scope
* @return void
* @see #setDefinition(IDefinition, Scope, boolean)
*/
public void setDefinition(IDefinition definition, Scope scope) {
setDefinition(definition, scope, true);
}
/**
* sets Definition for this node and adds Reference
* to the _definition and scope
* @param definition
* @param scope
* @param createReference
* @return void
* @see net.sourceforge.transmogrify.symtab.Reference
*/
public void setDefinition(
IDefinition definition,
Scope scope,
boolean createReference) {
_definition = definition;
Reference reference = new Reference(this);
if (scope != null) {
scope.addReferenceInScope(reference);
}
if (definition.isSourced() && createReference) {
_definition.addReference(reference);
}
}
/**
* gets _definitin
* @return IDefinition
*/
public IDefinition getDefinition() {
return _definition;
}
/**
* tests if this node is meaningful or should be ignored
* @return boolean
*/
public boolean isMeaningful() {
return _isMeaningful;
}
/**
* sets _isMeaningful member
* @param isMeaningful
* @return void
*/
public void setMeaningfulness(boolean isMeaningful) {
_isMeaningful = isMeaningful;
}
/**
* sets meaningfulness for this node and its children
* @return void
* @see #setMeaningfulness(boolean)
*/
public void ignoreChildren() {
if (getType() == TokenTypes.IDENT) {
setMeaningfulness(false);
}
SymTabAST child = (SymTabAST) getFirstChild();
while (child != null) {
child.ignoreChildren();
child = (SymTabAST) child.getNextSibling();
}
}
/**
* sets file where this node belong to
* @param file
* @return void
*/
public void setFile(File file) {
_file = file;
}
/**
* finishes process for adding node to its parent
* @param file file where this node belongs to
* @param parent parent of this node
* @param previousSibling previous sibling of this node
* @return Span the span of this node
* @see #setFile(File)
* @see #setParent(SymTabAST)
* @see #setPreviousSibling(SymTabAST)
* @see #finishChildren(File)
* @see #setSpan(Span)
*/
public Span finishDefinition(
File file,
SymTabAST parent) {
setFile(file);
setParent(parent);
Span result = finishChildren(file);
if (getLineNo() != 0) {
result.compose(
new Span(
getLineNo(),
getColumnNo(),
getLineNo(),
getColumnNo()
+ ((getText() == null) ? 0 : getText().length() - 1)));
}
setSpan(result);
return result;
}
/**
* finishes children of this node definition process
* @param file file where this node belongs to
* @return Span
* @see #finishDefinition(File, SymTabAST, SymTabAST)
*/
public Span finishChildren(File file) {
Span result = null;
SymTabAST current = (SymTabAST) getFirstChild();
if (current == null) {
result = getSpan();
}
else {
while (current != null) {
Span childSpan =
current.finishDefinition(file, this);
if (childSpan != null) {
if (result == null) {
result = new Span(childSpan);
}
else {
result.compose(childSpan);
}
}
current = (SymTabAST) current.getNextSibling();
}
}
return result;
}
/**
* gets file where this node belongs to
* @return File
*/
public File getFile() {
return _file;
}
/**
* sets the line where this node reside
* @return void
*/
public void setLine(int line) {
_line = line;
}
/**
* gets the line where this node reside
* @return int
*/
public int getLineNo() {
return _line;
}
/**
* sets the column where this node reside
* @param column
*/
public void setColumn(int column) {
_column = column;
}
/**
* gets the column where this node reside
* @return int
*/
public int getColumnNo() {
return _column;
}
/**
* gets the definition name of this node
* @return String
* @see net.sourceforge.transmogrify.symtab.IDefinition
*/
public String getName() {
String result = null;
if (_definition != null) {
result = _definition.getName();
}
return result;
}
/**
* prints the line, column and file for this node for debugging purpose
* @return String
*/
public String toString() {
//StringBuffer resultBuffer = new StringBuffer(super.toString());
StringBuffer resultBuffer = new StringBuffer(prefixString(true));
resultBuffer.append("[" + getLineNo() + "," + getColumnNo() + "]");
//if ( getSpan() != null ) {
// resultBuffer.append( " spans " + getSpan() );
//}
resultBuffer.append(" in " + getFile());
//resultBuffer.append(" type: " + getType());
return resultBuffer.toString();
}
public String prefixString(boolean verboseStringConversion) {
StringBuffer b = new StringBuffer();
try {
final String name = TokenTypes.getTokenName(getType());
// if verbose and type name not same as text (keyword probably)
if (verboseStringConversion && !getText().equalsIgnoreCase(name)) {
b.append('[');
b.append(getText());
b.append(",<");
b.append(name);
b.append(">]");
return b.toString();
}
}
catch (Exception ex) {
;
}
return getText();
}
/**
* gets Span of this node
* @return Span
*/
public Span getSpan() {
if ((_span == null)) {
int endColumn = getColumnNo() + 1;
final String text = getText();
if (text != null) {
endColumn += text.length() - 1;
}
_span = new Span(getLineNo(), getColumnNo() + 1, getLineNo(), endColumn);
}
return _span;
}
/**
* sets Span for this node
* @param span
* @return void
*/
public void setSpan(Span span) {
_span = span;
}
// not used by Checkstyle
// /**
// * tests if this node is inside the span
// * @param line
// * @param column
// * @return booleantrue if this node is within the span
// * false otherwise
// */
// public boolean contains(int line, int column) {
// return getSpan().contains(line, column);
// }
/**
* gets enclosing node for this node based on line and column
* @param line
* @param column
* @return SymTabAST
* @see #getSpan()
*/
public SymTabAST getEnclosingNode(int line, int column) {
SymTabAST result = null;
if ((getSpan() != null) && (getSpan().contains(line, column))) {
SymTabAST child = (SymTabAST) getFirstChild();
while (child != null && result == null) {
result = child.getEnclosingNode(line, column);
child = (SymTabAST) child.getNextSibling();
}
// if none of the children contain it, I'm the best node
if (result == null) {
result = this;
}
}
return result;
}
public AST getFirstChild()
{
if (super.getFirstChild() == null) {
DetailAST childDetailAST = null;
final DetailAST detailAST = getDetailNode();
if (detailAST != null) {
childDetailAST = (DetailAST) detailAST.getFirstChild();
if (childDetailAST != null) {
final SymTabAST child =
SymTabASTFactory.create(childDetailAST);
setFirstChild(child);
child.setParent(this);
child.setFile(getFile());
}
}
}
return super.getFirstChild();
}
public AST getNextSibling()
{
if (super.getNextSibling() == null) {
DetailAST siblingDetailAST = null;
final DetailAST detailAST = getDetailNode();
if (detailAST != null) {
siblingDetailAST = (DetailAST) detailAST.getNextSibling();
if (siblingDetailAST != null) {
final SymTabAST sibling =
SymTabASTFactory.create(siblingDetailAST);
setNextSibling(sibling);
// sibling.setParent(this.getParent());
sibling.setFile(getFile());
}
}
}
return super.getNextSibling();
}
/**
* initialized this node with input node
* @param aAST the node to initialize from. Must be a
* DetailAST object.
*/
public void initialize(AST aAST)
{
if (aAST != null) {
super.initialize(aAST);
final DetailAST detailAST = (DetailAST) aAST;
setDetailNode(detailAST);
_column = detailAST.getColumnNo() + 1;
_line = detailAST.getLineNo();
}
}
/**
* Gets first occurence of the child node with a certain type
* @param type
* @return SymTabAST
* @see #getType()
*/
public SymTabAST findFirstToken(int type) {
SymTabAST result = null;
AST sibling = getFirstChild();
while (sibling != null) {
if (sibling.getType() == type) {
result = (SymTabAST) sibling;
break;
}
sibling = sibling.getNextSibling();
}
return result;
}
// not used by Checkstyle
// /**
// * adds a node to the last position of this node children
// * @param child
// * @return void
// */
// public void addChild(SymTabAST child)
// {
// SymTabAST lastChild = (SymTabAST) getFirstChild();
// if (lastChild == null) {
// setFirstChild(child);
// child.setParent(this);
// child.setNextSibling(null);
// }
// else {
// while (lastChild.getNextSibling() != null) {
// lastChild = (SymTabAST) lastChild.getNextSibling();
// }
// lastChild.setNextSibling(child);
// child.setNextSibling(null);
// child.setParent(this);
// }
// }
/**
* Gets Iterator for this node
* @return SymTabASTIterator
*/
public SymTabASTIterator getChildren()
{
return new SymTabASTIterator(this);
}
/**
* Returns the DetailAST associated with this node.
* @return the DetailAST associated with this node.
*/
public DetailAST getDetailNode()
{
return detailNode;
}
/**
* Sets the DetailAST associated with this node.
* @param aDetailAST the DetailAST associated with this node.
*/
public void setDetailNode(DetailAST aDetailAST)
{
detailNode = aDetailAST;
ASTManager.getInstance().put(aDetailAST, this);
}
} ././@LongLink 100644 0 0 174 12026055133 10252 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/SymTabASTFactory.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 5550 11451071612 31451 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import antlr.ASTFactory;
import antlr.collections.AST;
/**
* Factory for SymTabAST objects.
* @author Rick Giles
*/
public class SymTabASTFactory
{
/** singleton factory */
private static ASTFactory factory;
static
{
factory = new ASTFactory();
factory.setASTNodeClass(SymTabAST.class.getName());
}
/**
* Creates a SymTabAST with a given type and text.
* @param aType the type for the new SymTabAST.
* @param aText the text for the new SymTabAST.
* @return the new SymTabAST.
*/
public static SymTabAST create(int aType, String aText)
{
return (SymTabAST) factory.create(aType, aText);
}
/**
* Creates an SymTabAST from a given AST.
* @param aAST the AST for the new SymTabAST.
* @return the new SymTabAST.
*/
public static SymTabAST create(AST aAST)
{
return (SymTabAST) factory.create(aAST);
}
///CLOVER:OFF
/** prevent instantiation */
private SymTabASTFactory()
{
}
///CLOVER:ON
}
././@LongLink 100644 0 0 175 12026055133 10253 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/SymTabASTIterator.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 5771 11451071612 31456 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.Iterator;
import java.util.NoSuchElementException;
/**
* An iterator for the children of a tree node.
*
* @version 1.0
* @since 1.0
* @see Iterator
*/
public class SymTabASTIterator implements Iterator {
private SymTabAST _current;
/**
* Creates a new SymTabASTIterator.
*
* @param parent the node whose children will be iterated over.
*/
public SymTabASTIterator(SymTabAST parent) {
_current = (SymTabAST)parent.getFirstChild();
}
/**
* Whether the node has another child. (In other words, returns
* true if next would return an element rather than
* throwing an exception.)
*
* @return the next child node.
*/
public boolean hasNext() {
return (_current != null);
}
/**
* The next child node.
*
* @return the next child node.
*/
public Object next() {
if (!hasNext()) {
throw new NoSuchElementException();
}
Object result = _current;
_current = (SymTabAST)_current.getNextSibling();
return result;
}
/**
* The next child node.
*
* @return the next child node.
*/
public SymTabAST nextChild() {
return (SymTabAST)next();
}
/**
* Unsupported operation
*/
public void remove() {
throw new UnsupportedOperationException();
}
}
././@LongLink 100644 0 0 166 12026055133 10253 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/TableMaker.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 130210 11451071612 31501 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.io.File;
import java.util.Enumeration;
import java.util.Vector;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* this is the class that does the work of the "walking" step --
* going through the SymTabAST and constructing the definitions and
* references. The SymTabAST is constructed in a DOMish fashion, i.e.
* each node knows about its first child and its next sibling. The
* DFS search is carried out by two functions -- walkTree, which
* deals with a single SymTabAST node, and walkSibilngs, which deals with
* all the siblings of an SymTabAST node.
*/
public class TableMaker {
private SymbolTable symbolTable;
private SymTabAST _tree;
private File currentFile;
private Vector imports = new Vector();
/**
* Constructor for the TableMaker class
*
* @param tree is theSymTabAST from which to
* build the TableMaker. It is the tree which wil be walked
* in order to build definitions and references.
*/
public TableMaker(SymTabAST tree)
{
_tree = tree;
}
/**
* returns the SymTabAST which is the
* SymTabAST generated from the parsed Java Source files.
*
* @return SymTabAST
*/
public SymTabAST getTree() {
return _tree;
}
/**
* returns the SymbolTable that has been constructed by
* this TableMaker
*
* @return SymbolTable
* @throws SymbolTableException
*/
public SymbolTable getTable() throws SymbolTableException {
if (symbolTable == null) {
symbolTable = new SymbolTable( _tree );
createDefinitions();
resolveReferences();
}
return symbolTable;
}
/**
* walks the tree and finishes creating definitions.
*
* @return void
* @throws SymbolTableException
* @see #walkTree()
* @see #finishCreatingDefinitions()
*/
private void createDefinitions() throws SymbolTableException {
walkTree();
finishCreatingDefinitions();
}
/**
* finishes up creating definitions process
* starts at the base of the Table
*
* @return void
* @throws SymbolTableException
* @see net.sourceforge.transmogrify.symtab.SymbolTable
* @see #finishCreatingDefinition(Definition)
*/
private void finishCreatingDefinitions() throws SymbolTableException {
finishCreatingDefinition(symbolTable.getBaseScope());
}
/**
* begins at the base of the Table and starts finishing definition creation.
*
* @param def Definition needs to be completed
* @return void
* @throws SymbolTableException
* @see ClassFinisher
* @see VariableFinisher
* @see MethodFinisher
* @see CatchFinisher
*/
private void finishCreatingDefinition(Definition def) throws SymbolTableException {
if (def instanceof AnonymousInnerClass) {
AnonymousInnerClass innerClass = (AnonymousInnerClass)def;
innerClass.finishMakingDefinition();
}
else if (def instanceof ClassDef) {
new ClassFinisher(def).finish();
}
else if ( def instanceof VariableDef ) {
new VariableFinisher( def ).finish();
}
else if (def instanceof DefaultConstructor) {}
else if ( def instanceof MethodDef ) {
new MethodFinisher( def ).finish();
}
else if (def instanceof BlockDef) {
SymTabAST firstChild = (SymTabAST)def.getTreeNode().getFirstChild();
//handle Checkstyle grammar
if (firstChild.getType() == TokenTypes.LPAREN) {
firstChild = (SymTabAST) firstChild.getNextSibling();
}
if (firstChild.getType() == TokenTypes.PARAMETER_DEF) {
// this is a catch block
new CatchFinisher((BlockDef)def).finish();
}
}
if ( def instanceof Scope ) {
finishCreatingChildren((Scope)def);
}
}
/**
* iterates through all the definitions in the Scope
* finishes creating each Scope.
*
* @param scope Scope where defininitions will be finished.
* @return void
* @throws SymbolTableException
* @see net.sourceforge.transmogrify.symtab.Scope
* @see #finishCreatingDefinition(Definition)
*/
private void finishCreatingChildren( Scope scope ) throws SymbolTableException {
Enumeration definitions = scope.getDefinitions();
while ( definitions.hasMoreElements() ) {
Definition child = (Definition)(definitions.nextElement());
finishCreatingDefinition(child);
}
}
/**
* resolves SymbolTable using Resolver
*
* @return void
* @see net.sourceforge.transmogrify.symtab.Resolver
* @see net.sourceforge.transmogrify.symtab.SymbolTable
*/
private void resolveReferences() {
new Resolver( symbolTable ).resolve();
}
/**
* starts walking the SymTabAST
*
* @return void
* @see #walkSiblings(SymTabAST,boolean)
* @see net.sourceforge.transmogrify.symtab.antlr.SymTabAST
*/
public void walkTree() {
walkSiblings((SymTabAST)_tree.getFirstChild(), false);
}
/**
* processes a single SymTabAST node based on its type and passes of its
* children for further processing where appropriate.
*
* @param tree the SymTabAST node to process
* @param makeAnonymousScopes sets to false after walking Class,
* Methods and Try otherwise sets to true
* @return void
* @see #walkSiblings(SymTabAST, boolean)
* @see #processAnonymousInnerClass(SymTabAST, SymTabAST)
* @see #processBlock(SymTabAST, boolean)
* @see #processClass(SymTabAST)
* @see #processConstructorDef(SymTabAST)
* @see #processElse(SymTabAST)
* @see #processFile(SymTabAST)
* @see #processFinally(SymTabAST)
* @see #processFor(SymTabAST)
* @see #processImplicitPackage(SymTabAST)
* @see #processImport(SymTabAST)
* @see #processLabel(SymTabAST)
* @see #processMethodDef(SymTabAST)
* @see #processPackage(SymTabAST)
* @see #processTry(SymTabAST)
* @see net.sourceforge.transmogrify.symtab.antlr.SymTabAST
* @see net.sourceforge.transmogrify.symtab.antlr.JavaTokenTypes
*/
public void walkTree(SymTabAST tree, boolean makeAnonymousScopes) {
if (tree != null) {
tree.setScope( symbolTable.getCurrentScope() );
switch(tree.getType()) {
case 0:
processFile(tree);
if ( tree.getFirstChild().getType() != TokenTypes.PACKAGE_DEF ) {
processImplicitPackage( tree.getFile() );
}
walkSiblings((SymTabAST)tree.getFirstChild(), false);
// pop package scope
symbolTable.popScope();
clearImports();
break;
case TokenTypes.LITERAL_NEW:
SymTabAST symtabTree = tree;
//walk parameters, in case of anonymous inner class
walkTree(symtabTree.findFirstToken(TokenTypes.ELIST),
makeAnonymousScopes);
SymTabAST objblock
= symtabTree.findFirstToken(TokenTypes.OBJBLOCK);
if (objblock != null) {
SymTabAST classExtended
= symtabTree.findFirstToken(TokenTypes.IDENT);
processAnonymousInnerClass(objblock, classExtended);
}
break;
case TokenTypes.SLIST:
if (makeAnonymousScopes) {
processBlock(tree, true);
}
else {
walkSiblings((SymTabAST)tree.getFirstChild(), true);
}
break;
case TokenTypes.CTOR_DEF:
processConstructorDef(tree);
break;
case TokenTypes.METHOD_DEF:
processMethodDef(tree);
break;
case TokenTypes.LITERAL_FINALLY:
processFinally(tree);
break;
case TokenTypes.LITERAL_TRY:
processTry(tree);
break;
case TokenTypes.VARIABLE_DEF:
processVariableDef(tree);
break;
case TokenTypes.PACKAGE_DEF:
processPackage(tree);
break;
case TokenTypes.LABELED_STAT:
processLabel(tree);
break;
case TokenTypes.IMPORT:
processImport(tree);
break;
case TokenTypes.CLASS_DEF:
case TokenTypes.INTERFACE_DEF:
processClass(tree);
break;
case TokenTypes.LITERAL_FOR:
processFor(tree);
break;
case TokenTypes.LITERAL_IF:
processIf(tree);
break;
case TokenTypes.LITERAL_ASSERT:
processAssert(tree);
break;
case TokenTypes.LITERAL_CATCH:
case TokenTypes.LITERAL_WHILE:
case TokenTypes.LITERAL_SWITCH:
case TokenTypes.LITERAL_DO:
case TokenTypes.LITERAL_SYNCHRONIZED:
case TokenTypes.STATIC_INIT:
case TokenTypes.INSTANCE_INIT:
processBlock(tree, false);
break;
default:
walkSiblings((SymTabAST)tree.getFirstChild(), false);
}
}
}
/**
* @param tree
*/
public void processAssert(SymTabAST tree) {
BlockDef block = makeBlock(tree);
SymTabAST expr = tree.findFirstToken(TokenTypes.EXPR);
SymTabAST message = (SymTabAST)expr.getNextSibling();
while ((message != null) && (message.getType() != TokenTypes.EXPR)) {
message = (SymTabAST) message.getNextSibling();
}
symbolTable.pushScope( block );
walkTree(expr, false);
if (message != null) {
walkTree(message, false);
}
symbolTable.popScope();
}
/**
* processes the given SymTabAST and each of its siblings
*
* @param tree SymTabAST node to process
* @param makeAnonymousScopes
*
* @return void
* @see #walkTree(SymTabAST, boolean)
* @see net.sourceforge.transmogrify.symtab.antlr.SymTabAST
*/
public void walkSiblings(SymTabAST tree, boolean makeAnonymousScopes) {
while(tree != null) {
walkTree(tree, makeAnonymousScopes);
tree = (SymTabAST)tree.getNextSibling();
}
}
/**
* processes the given SymTabAST as a package defintion
*
* @param tree the SymTabAST to process
* @return void
* @see net.sourceforge.transmogrify.symtab.antlr.SymTabAST
* @see net.sourceforge.transmogrify.symtab.PackageDef
* @see net.sourceforge.transmogrify.symtab.SymbolTable
*/
public void processPackage(SymTabAST tree) {
SymTabAST firstChild = (SymTabAST)tree.getFirstChild();
String name = ASTUtil.constructDottedName(firstChild);
firstChild.ignoreChildren();
PackageDef pkg = symbolTable.getPackage(name);
if (pkg == null) {
pkg = createPackage( (SymTabAST)(tree.getFirstChild()) );
}
symbolTable.pushScope(pkg);
}
/**
* processes a java class that use default no package
*
* @param file File object of the java class
* @return void
* @see net.sourceforge.transmogrify.symtab.PackageDef
* @see net.sourceforge.transmogrify.symtab.SymbolTable
*/
public void processImplicitPackage( File file ) {
String name = file.getParent();
if (name == null) {
name = "";
}
PackageDef pkg = symbolTable.getPackage( name );
if ( pkg == null ) {
pkg = new PackageDef( name, symbolTable.getBaseScope(), null );
symbolTable.definePackage( pkg, symbolTable.getBaseScope() );
}
symbolTable.pushScope( pkg );
}
/**
* gets the package represented by the tree. The method
* analyzes the tree, constructs an appropriate package name
* and fetches it from the internal package list. If the package does not
* exist it is created.
*
* @param tree SymTabAST to consider
*
* @return PackageDef the resulting package definition
* @see #getPackage(Scope, SymTabAST)
*/
private PackageDef createPackage( SymTabAST tree ) {
PackageDef result = null;
if (tree.getType() == TokenTypes.DOT) {
// find the package result of left child
SymTabAST leftChild = (SymTabAST)tree.getFirstChild();
SymTabAST rightChild = (SymTabAST)leftChild.getNextSibling();
PackageDef context = createPackage(leftChild);
result = getPackage( context, rightChild );
}
else {
result = getPackage(symbolTable.getBaseScope(), tree);
}
return result;
}
/**
* gets the package determined by the tree and parent package def.
* The method analyzes the tree and parent scope and retrieves the
* appropriate package definition from the internal package list.
* If the package does not exist it is created.
*
* @param tree SymTabAST to consider
* @param parent the parent package definition
*
* @return PackageDef the resulting package definition
* @see net.sourceforge.transmogrify.symtab.PackageDef
* @see net.sourceforge.transmogrify.symtab.SymbolTable
* @see net.sourceforge.transmogrify.symtab.antlr.SymTabAST
*/
private PackageDef getPackage(Scope parent, SymTabAST tree ) {
String name = tree.getText();
PackageDef result = null;
if (!(parent instanceof BaseScope)) {
result = symbolTable.getPackage(parent.getQualifiedName() + "." + name);
}
else {
result = symbolTable.getPackage(name);
}
if (result == null) {
result = new PackageDef(tree.getText(), parent, tree);
symbolTable.definePackage(result, parent);
}
return result;
}
/**
* process the given SymTabAST as a file definition
*
* @param tree the SymTabAST to process
* @return void
* @see #setCurrentFile(String)
*/
public void processFile(SymTabAST tree) {
setCurrentFile(tree.getText());
}
/**
* adds the given SymTabAST to imports member
*
* @param tree the SymTabAST to process
* @return void
*/
public void processImport(SymTabAST tree) {
imports.add( tree );
}
/**
* clears the imports member
* @return void
*/
private void clearImports() {
imports.clear();
}
/**
* process the given SymTabAST as a label definition
*
* @param tree the SymTabAST to process
* @return void
* @see com.trwx.symtab.antlr.SymTabAST
* @see net.sourceforge.transmogrify.symtab.LabelDef
* @see #walkTree(SymTabAST, boolean)
*/
public void processLabel(SymTabAST tree) {
String name = tree.findFirstToken(TokenTypes.IDENT).getText();
LabelDef label = new LabelDef( name, symbolTable.getCurrentScope(),
tree );
symbolTable.defineLabel( label );
walkTree((SymTabAST)tree.getFirstChild().getNextSibling(), false);
}
/**
* process the given SymTabAST as a class definition
*
* @param tree the SymTabAST to process
* @return void
* @see #makeClass(String, SymTabAST)
* @see #walkSiblings(SymTabAST, boolean)
* @see net.sourceforge.transmogrify.symtab.antlr.SymTabAST
*/
public void processClass(SymTabAST tree) {
String name = tree.findFirstToken(TokenTypes.IDENT).getText();
makeClass(name, tree);
final SymTabAST objblock =
tree.findFirstToken(TokenTypes.OBJBLOCK);
SymTabAST start = (SymTabAST)objblock.getFirstChild();
if (start != null) {
//skip LPAREN
if (start.getType() == TokenTypes.LPAREN) {
start = (SymTabAST)start.getNextSibling();
}
walkSiblings(start, false);
}
symbolTable.popScope();
}
/**
* creates ClassDef for the current class node and add it to the
* symbol table
* @param name name of the class
* @param tree current node to be processed
* @return void
* @see net.sourceforge.transmogrify.symtab.ClassDef
* @see net.sourceforge.transmogrify.symtab.SymbolTable
*/
public void makeClass(String name, SymTabAST tree) {
ClassDef def = new ClassDef(name, symbolTable.getCurrentScope(), tree);
def.addUnprocessedImports(imports);
symbolTable.defineClass(def);
symbolTable.pushScope(def);
}
/**
* processes anonymous inner class encountered in the tree
* @param objblock the anonymous block
* @param classExtended
* @return void
* @see net.sourceforge.transmogrify.symtab.AnonymousInnerClass
* @see net.sourceforge.transmogrify.symtab.SymbolTable
*/
public void processAnonymousInnerClass(SymTabAST objblock,
SymTabAST classExtended) {
ClassDef def = new AnonymousInnerClass(objblock,
classExtended,
symbolTable.getCurrentScope());
symbolTable.defineClass(def);
symbolTable.pushScope(def);
walkSiblings((SymTabAST)objblock.getFirstChild(), false);
symbolTable.popScope();
}
/**
* process the given SymTabAST as a variable definition
*
* @param tree the SymTabAST to process
* @return void
* @see net.sourceforge.transmogrify.symtab.VariableDef
* @see net.sourceforge.transmogrify.symtab.SymbolTable
* @see net.sourceforge.transmogrify.symtab.antlr.SymTabAST
* @see #makeVariableDef(SymTabAST, Scope)
* @see #walkTree(SymTabAST, boolean)
*/
private void processVariableDef(SymTabAST tree) {
VariableDef def = makeVariableDef( tree, symbolTable.getCurrentScope() );
symbolTable.defineVariable(def);
SymTabAST assignmentNode
= tree.findFirstToken(TokenTypes.ASSIGN);
if (assignmentNode != null) {
walkTree((SymTabAST)assignmentNode.getFirstChild(), false);
}
}
/**
* creates VariableDef based on the current tree node and scope
* @param tree the current tree node
* @param scope the current scope
* @return VariableDef
* @see net.sourceforge.transmogrify.symtab.VariableDef
*/
public VariableDef makeVariableDef(SymTabAST tree, Scope scope) {
String name = tree.findFirstToken(TokenTypes.IDENT).getText();
VariableDef result = new VariableDef(name, scope, tree);
return result;
}
/**
* process the given SymTabAST as a try block
*
* @param tree the SymTabAST to process
* @return void
* @see #makeBlock(SymTabAST)
* @see net.sourceforge.transmogrify.symtab.antlr.SymTabAST
* @see #walkTree(SymTabAST, boolean)
* @see #walkSiblings(SymTabAST, boolean)
*/
public void processTry(SymTabAST tree){
BlockDef block = makeBlock(tree);
SymTabAST slist = tree.findFirstToken(TokenTypes.SLIST);
SymTabAST everythingElse = (SymTabAST)slist.getNextSibling();
symbolTable.pushScope( block );
walkTree( slist, false );
symbolTable.popScope();
walkSiblings( everythingElse, false );
}
/**
* process the given SymTabAST as a finally block
*
* @param tree the SymTabAST to process
* @return void
* @see #makeBlock(SymTabAST)
* @see #walkTree(SymTabAST, boolean)
*/
public void processFinally(SymTabAST tree){
BlockDef block = makeBlock(tree);
SymTabAST slist = tree.findFirstToken(TokenTypes.SLIST);
SymTabAST tryBlock = tree.findFirstToken(TokenTypes.LITERAL_TRY);
symbolTable.pushScope( block );
walkTree( slist, false );
symbolTable.popScope();
walkTree( tryBlock, false );
}
/**
* process the given SymTabAST as a method definition
*
* @param tree the SymTabAST to process
* @return void
* @see net.sourceforge.transmogrify.symtab.MethodDef
* @see net.sourceforge.transmogrify.symtab.SymbolTable
* @see #walkTree(SymTabAST, boolean)
*/
public void processMethodDef(SymTabAST tree) {
String name = tree.findFirstToken(TokenTypes.IDENT).getText();
MethodDef method = new MethodDef(name, symbolTable.getCurrentScope(),
tree);
symbolTable.defineMethod( method );
symbolTable.pushScope( method );
walkTree(tree.findFirstToken(TokenTypes.SLIST), false);
symbolTable.popScope();
}
/**
* process the given SymTabAST as a constructor definition
*
* @param tree the SymTabAST to process
* @return void
* @see net.sourceforge.transmogrify.symtab.MethodDef
* @see net.sourceforge.transmogrify.symtab.SymbolTable
* @see #walkTree(SymTabAST, boolean)
*/
public void processConstructorDef(SymTabAST tree) {
processMethodDef(tree);
}
/**
* process the given SymTabAST as a for block
*
* @param tree the SymTabAST to process
* @return void
* @see #makeBlock(SymTabAST)
* @see #walkTree(SymTabAST, boolean)
*/
public void processFor(SymTabAST tree) {
BlockDef block = makeBlock(tree);
symbolTable.pushScope( block );
SymTabAST body;
SymTabAST forEach = tree.findFirstToken(TokenTypes.FOR_EACH_CLAUSE);
if (forEach != null) {
walkTree(forEach, false);
body = (SymTabAST)forEach.getNextSibling();
}
else {
walkTree(tree.findFirstToken(TokenTypes.FOR_INIT), false);
walkTree(tree.findFirstToken(TokenTypes.FOR_CONDITION), false);
SymTabAST forIter = tree.findFirstToken(TokenTypes.FOR_ITERATOR);
walkTree(forIter, false);
body = (SymTabAST)forIter.getNextSibling();
}
//handle Checkstyle grammar
if (body.getType() == TokenTypes.RPAREN) {
body = (SymTabAST) body.getNextSibling();
}
walkTree(body, false);
symbolTable.popScope();
}
/**
* process the given SymTabAST as an if block
*
* @param tree the SymTabAST to process
* @return void
* @see #makeBlock(SymTabAST)
* @see #walkTree(SymTabAST, boolean)
* @see #processElse(SymTabAST)
*/
public void processIf(SymTabAST tree) {
BlockDef block = makeBlock(tree);
SymTabAST expr = tree.findFirstToken(TokenTypes.EXPR);
SymTabAST ifBranch = (SymTabAST)expr.getNextSibling();
// handle Checkstyle grammar
if (ifBranch.getType() == TokenTypes.RPAREN) {
ifBranch = (SymTabAST) ifBranch.getNextSibling();
}
SymTabAST elseBranch = (SymTabAST)ifBranch.getNextSibling();
// handle Checkstyle grammar
if ((elseBranch != null) && (elseBranch.getType() == TokenTypes.SEMI)) {
elseBranch = (SymTabAST) elseBranch.getNextSibling();
}
if ((elseBranch != null) && (elseBranch.getType() == TokenTypes.LITERAL_ELSE)) {
elseBranch = (SymTabAST) elseBranch.getFirstChild();
}
symbolTable.pushScope( block );
walkTree(expr, false);
walkTree(ifBranch, false);
symbolTable.popScope();
processElse(elseBranch);
}
/**
* process the given SymTabAST as an else block
*
* @param tree the SymTabAST to process
* @return void
* @see #processIf(SymTabAST)
* @see #makeElseBlock(SymTabAST)
*/
public void processElse(SymTabAST tree) {
if (tree != null) {
if (tree.getType() == TokenTypes.LITERAL_IF) {
processIf(tree);
}
else {
makeElseBlock(tree);
}
}
}
/**
* defines an anonymous block to enclose the scope of an else block
*
* @param tree the SymTabAST to process
* @return void
* @see #makeBlock(SymTabAST)
* @see #walkTree(SymTabAST, boolean)
*/
public void makeElseBlock(SymTabAST tree) {
if (tree.getType() == TokenTypes.SLIST) {
BlockDef block = makeBlock(tree);
symbolTable.pushScope( block );
walkTree(tree, false);
symbolTable.popScope();
}
else {
walkTree(tree, false);
}
}
/**
* processes the current tree node as BlockDef
* @param tree current tree node
* @param makeAnonymousScopes
* @return void
*/
public void processBlock(SymTabAST tree, boolean makeAnonymousScopes) {
BlockDef block = makeBlock(tree);
symbolTable.pushScope(block);
//handle Checkstyle grammar
SymTabAST child = (SymTabAST)tree.getFirstChild();
if ((child != null) && (child.getType() == TokenTypes.LPAREN)) {
child = (SymTabAST) child.getNextSibling();
}
walkSiblings(child, makeAnonymousScopes);
symbolTable.popScope();
}
/**
* set the current file to the named file
*
* @param fileName the name of the file
* @return void
*/
public void setCurrentFile(String fileName) {
currentFile = new File(fileName);
symbolTable.setCurrentFile(currentFile);
}
/**
* creates a new BlockDef in the SymbolTable
*
* @param tree is a SymTabAST whose root begins the new block
* @return BlockDef
* @see net.sourceforge.transmogrify.symtab.BlockDef
* @see net.sourceforge.transmogrify.symtab.SymbolTable
*/
private BlockDef makeBlock( SymTabAST tree ) {
BlockDef block = new BlockDef( symbolTable.getCurrentScope(), tree );
symbolTable.defineBlock( block );
return block;
}
/**
* returns the SymTabAST that contains the parameter classDef's
* extends nodes
*
* @param classDef is a ClassDef whose extends nodes we want
* @return SymTabAST
*/
public static SymTabAST getExtendsNode(ClassDef classDef) {
SymTabAST result = null;
SymTabAST extendsClause = null;
SymTabAST classDefTreeNode = classDef.getTreeNode();
extendsClause =
classDefTreeNode.findFirstToken(TokenTypes.EXTENDS_CLAUSE);
if (extendsClause != null) {
result = (SymTabAST)(extendsClause.getFirstChild());
}
return result;
}
/**
* Superclass for different kind of XXXFinisher subclass
* @see CatchFinisher
* @see ClassFinisher
* @see DefinitionFinisher
* @see MethodFinisher
* @see VariableFinisher
*/
class DefinitionFinisher {
protected SymTabAST _node = null;
/**
* Constructor. It finishes the definition passed to it
*
*/
public DefinitionFinisher( Definition def ) {
_node = def.getTreeNode();
}
public void finish() throws SymbolTableException {}
/**
* gets the classDef that represents the type of the given definition
*
*
* @param def the definition whose type to find
* @param typeNode the TokenTypes.TYPE node associated with the def
*
* @return the resulting class definition
*/
protected IClass getType( Definition def, SymTabAST typeNode ) {
IClass result = null;
SymTabAST typeClassNode = null;
boolean isArray = false;
if ( typeNode.getFirstChild().getType()
== TokenTypes.ARRAY_DECLARATOR ) {
isArray = true;
typeClassNode = (SymTabAST)typeNode.getFirstChild().getFirstChild();
}
else {
typeClassNode = (SymTabAST)typeNode.getFirstChild();
}
Scope lookupScope = null;
if (def instanceof Scope) {
lookupScope = (Scope)def;
}
else {
lookupScope = def.getParentScope();
}
Resolver resolver = new Resolver(symbolTable);
IClass typeClass = resolver.resolveClass(typeClassNode, lookupScope, null, false);
if ( isArray ) {
result = new ArrayDef( typeClass );
}
else {
result = typeClass;
}
return result;
}
}
class ClassFinisher extends DefinitionFinisher {
private ClassDef _def = null;
/**
* Constructor. Creates a ClassFinisher from a Definition
*
* @param def is a Definition
*/
public ClassFinisher( Definition def ) {
super( def );
_def = (ClassDef)def;
}
/**
* Completes all tasks required for finishing a ClassDef
* Including adding imports, setting super classes and adding
* interfaces.
* @return void
* @throws SymbolTableException
* @see #addImports()
* @see #setSuperclass()
* @see #addInterfaces()
*/
public void finish() throws SymbolTableException {
if ( _node != null ) {
addImports();
setSuperclass();
addInterfaces();
}
}
/**
* Adds all packages and classes that are imported by this class
* to the class for later reference
*/
private void addImports() throws ClassImportException {
IPackage java = new ExternalPackage("java", null);
IPackage lang = new ExternalPackage("lang", java);
java.addDefinition(lang);
_def.importPackage(lang);
Vector unprocessedImports = _def.getUnprocessedImports();
for ( int i = 0; i < unprocessedImports.size(); i++ ) {
SymTabAST importNode = (SymTabAST)unprocessedImports.get(i);
SymTabAST imported = (SymTabAST)importNode.getFirstChild();
SymTabAST lastPart = (SymTabAST)imported.getFirstChild().getNextSibling();
DotIterator it = new DotIterator(imported);
SymTabAST current = null;
String className = null;
IClass importedClass = null;
// attempt at each token to find the class
// first in source
// then on classpath
//
// if there are more tokens left
// continue until you hit the last token
// if it's a star
// import all inner classes
// else
// import the explicitly named inner class
// else import the class
//
// if no classes were found, import the package
while(it.hasNext()) {
current = it.nextNode();
if (className == null) {
className = current.getText();
}
else {
if (!current.getText().equals("*")) {
className += "." + current.getText();
}
else {
break;
}
}
importedClass = findOrLoadClass(className, importedClass);
if (importedClass != null) {
break;
}
}
if (it.hasNext()) {
boolean isImported = false;
while(it.hasNext()) {
current = it.nextNode();
if (current.getText().equals("*")) {
importInnerClasses(importedClass);
isImported = true;
}
else {
className += "$" + current.getText();
importedClass = findOrLoadClass(className, importedClass);
}
}
if (!isImported) {
_def.importClass(importedClass);
}
}
else {
if (importedClass != null) {
_def.importClass(importedClass);
}
else {
if (current != null && current.getText().equals("*")) {
IPackage pkg = symbolTable.getPackage(className);
if (pkg == null) {
pkg = getPackage(className);
}
_def.importPackage(pkg);
}
else {
//TODO: can we safely ignore this?
//throw new ClassImportException(className);
;
}
}
}
// now set definitions where appropriate
imported.ignoreChildren();
if ((lastPart.getType() == TokenTypes.IDENT)
//TODO: guard added for class not loaded
//This is OK for single file processing, but not
//multiple files.
&& (importedClass != null)
)
{
lastPart.setDefinition(importedClass, null, true);
lastPart.setMeaningfulness(true);
}
}
}
/**
* creates ExternalPackage
* @param packageName name of the package
* @return ExternalPackage
* @see net.sourceforge.transmogrify.symtab.ExternalPackage
*/
private ExternalPackage getPackage(String packageName) {
return new ExternalPackage(packageName, null);
}
/**
* stores the inner classes in the approriate ClassDef
* @param outerClass
* @return void
*/
private void importInnerClasses(IClass outerClass) {
IClass[] innerClasses = outerClass.getInnerClasses();
for (int i = 0; i < innerClasses.length; i++) {
_def.importClass(innerClasses[i]);
}
}
/**
* creates ExternalClass based on a java class
* @param className class to be loaded
* @return IClass
* @see net.sourceforge.transmogrify.symtab.ExternalClass
*/
private IClass loadClass(String className) {
IClass result = null;
try {
Class javaClass
= ClassManager.getClassLoader().loadClass(className);
result = new ExternalClass(javaClass);
}
catch (ClassNotFoundException ignoreMe) {}
return result;
}
/**
* find a class from BaseCode or its parent
* @param className name of the class to be load or found
* @param parentClass its parent class
* @return IClass
* @see net.sourceforge.transmogrify.symtab.SymbolTable
* @see net.sourceforge.transmogrify.symtab.IClass
* @see #loadClass(String)
*/
private IClass findOrLoadClass(String className, IClass parentClass) {
IClass result = null;
if (parentClass == null) {
result = symbolTable.getBaseScope().getClassDefinition(className);
}
else {
int index = className.lastIndexOf("$");
if (index < 0) {
index = className.lastIndexOf(".");
}
result = parentClass.getClassDefinition(className.substring(index + 1));
}
if (result == null) {
result = loadClass(className);
}
return result;
}
/**
*
* If the class has a super class a reference to this super class
* is added to this class.
* @return void
* @see net.sourceforge.transmogrify.symtab.ClassDef
*/
private void setSuperclass() {
if (_def.getTreeNode().getType() == TokenTypes.CLASS_DEF) {
SymTabAST extendsNode = getExtendsNode(_def);
if ( extendsNode != null ) {
String superclassName = ASTUtil.constructDottedName(extendsNode);
IClass superclass = _def.getClassDefinition(superclassName);
if ( superclass != null ) {
_def.setSuperclass( superclass );
superclass.addSubclass( _def );
}
}
else {
_def.setSuperclass(new ExternalClass(Object.class));
}
}
else {
_def.setSuperclass(new ExternalClass(Object.class));
}
}
/**
*
* If the class implements an interface a reference to this interface
* is added to this class.
* @return void
* @see net.sourceforge.transmogrify.symtab.ClassDef
*/
private void addInterfaces() {
SymTabAST implementsClause = null;
if (_def.getTreeNode().getType() == TokenTypes.CLASS_DEF) {
implementsClause
= _node.findFirstToken(TokenTypes.IMPLEMENTS_CLAUSE);
}
else {
implementsClause
= _node.findFirstToken(TokenTypes.EXTENDS_CLAUSE);
}
if ( implementsClause != null ) {
SymTabAST interfaceNode = (SymTabAST)implementsClause.getFirstChild();
while ( interfaceNode != null ) {
IClass implemented =
_def.getClassDefinition(interfaceNode.getText());
if ( implemented != null ) {
_def.addInterface( implemented );
implemented.addImplementor( _def );
}
interfaceNode = (SymTabAST)(interfaceNode.getNextSibling());
}
}
}
}
/**
*
* Completes a Variable by setting all required references
*
*/
class VariableFinisher extends DefinitionFinisher {
VariableDef _def = null;
/**
*
* Constructor. Creates a VariableFinishes from the Definition
* @param def VariableDef to be finished
* @see net.sourceforge.transmogrify.symtab.VariableDef
*/
public VariableFinisher( Definition def ) {
super( def );
_def = (VariableDef)def;
}
/**
*
* Finishes the variable by setting the Type
* @return void
* @see #getType(Definition, SymTabAST)
* @see net.sourceforge.transmogrify.symtab.VariableDef
*/
public void finish() {
SymTabAST typeNode = _node.findFirstToken(TokenTypes.TYPE);
SymTabAST typeTextNode = (SymTabAST)(typeNode.getFirstChild());
if ( typeTextNode.getType() == TokenTypes.ARRAY_DECLARATOR ) {
typeTextNode = (SymTabAST)(typeTextNode.getFirstChild());
}
typeTextNode.setLine(ASTUtil.getLine( _def.getTreeNode() ));
IClass varType = getType(_def, typeNode);
_def.setType( varType );
}
}
/**
*
* Completes a Variable by setting all required references
*
*/
class MethodFinisher extends DefinitionFinisher {
MethodDef _def = null;
/**
*
* Creates a MethodFinisher from a Definition
* @param def MethodDef to be finished
* @see net.sourceforge.transmogrify.symtab.MethodDef
*/
public MethodFinisher( Definition def ) {
super( def );
_def = (MethodDef)def;
}
/**
*
* Completes a method by setting all references to return types,
* signatures and exceptions.
* @return void
* @see #setReturnType()
* @see #setSignature()
* @see #setExceptionsThrown()
*/
public void finish() {
setReturnType();
setSignature();
setExceptionsThrown();
}
/**
*
* setReturnType adds a reference to the methods return type
* to the method definition
* @return void
* @see net.sourceforge.transmogrify.symtab.MethodDef
* @see #getType(Definition, SymTabAST)
* @see #getTypeNode()
*/
private void setReturnType() {
IClass type = null;
if ( isConstructor() ) {
type = _def.getEnclosingClass();
}
else {
type = getType(_def, getTypeNode());
}
_def.setType(type);
}
/**
*
* setSignature adds a reference to the methods paramaters
* to the method definition
* @return void
* @see #makeVariableDef(SymTabAST, Definition)
* @see VariableFinisher
* @see net.sourceforge.transmogrify.symtab.MethodDef
*/
private void setSignature() {
SymTabAST parametersNode
= _node.findFirstToken(TokenTypes.PARAMETERS);
SymTabAST parameterNode = (SymTabAST)(parametersNode.getFirstChild());
while ( parameterNode != null ) {
if (parameterNode.getType() == TokenTypes.PARAMETER_DEF) {
VariableDef parameter = makeVariableDef( parameterNode, _def );
new VariableFinisher( parameter ).finish();
_def.addParameter( parameter );
}
parameterNode = (SymTabAST)(parameterNode.getNextSibling());
}
}
/**
*
* setExceptionsThrown adds a reference to the methods Exceptions
* to the method definition
* @return void
* @see net.sourceforge.transmogrify.symtab.SymbolTable
* @see net.sourceforge.transmogrify.symtab.PackageDef
* @see net.sourceforge.transmogrify.symtab.MethodDef
*/
private void setExceptionsThrown() {
IClass exception = null;
SymTabAST throwsNode
= _node.findFirstToken(TokenTypes.LITERAL_THROWS);
if ( throwsNode != null ) {
SymTabAST exceptionNode = (SymTabAST)(throwsNode.getFirstChild());
while (exceptionNode != null ) {
if (exceptionNode.getType() == TokenTypes.DOT) {
PackageDef pkg = symbolTable.getPackage(ASTUtil.constructPackage(exceptionNode));
if ( pkg != null ) {
exception = pkg.getClassDefinition(ASTUtil.constructClass(exceptionNode));
}
}
else {
exception = _def.getClassDefinition(exceptionNode.getText());
}
_def.addException(exception);
exceptionNode = (SymTabAST)(exceptionNode.getNextSibling());
}
}
}
/**
*
* isConstructor sets the flag in the method definition to indicate
* whether it is a constructor or not
* @return booleantrue if a node has no return type
* false if a node has a return type
* @see #getTypeNode()
*/
private boolean isConstructor() {
boolean result = false;
if ( getTypeNode() == null ) {
result = true;
}
return result;
}
/**
*
* getTypeNode returnss the SymTabAST node that is the
* return type of this method
*
* @return SymTabAST
*/
private SymTabAST getTypeNode() {
return _node.findFirstToken(TokenTypes.TYPE);
}
}
class CatchFinisher extends DefinitionFinisher {
BlockDef _def = null;
/**
* constructor that takes a BlockDef
* @param def BlockDef for the catch block
*/
public CatchFinisher(BlockDef def) {
super(def);
_def = def;
}
/**
* finishes definition creation
* @return void
* @see #createExceptionVariable()
*/
public void finish() {
createExceptionVariable();
}
/**
* creates VariableDef and finishes creation definition for
* arguments in the catch clause
* @return void
* @see net.sourceforge.transmogrify.symtab.VariableDef
* @see #makeVariableDef(SymTabAST, Definition)
* @see VariableFinisher
*/
private void createExceptionVariable() {
SymTabAST exceptionNode
= _def.getTreeNode().findFirstToken(TokenTypes.PARAMETER_DEF);
VariableDef exception = makeVariableDef(exceptionNode, _def);
new VariableFinisher(exception).finish();
_def.addDefinition(exception);
}
}
}
././@LongLink 100644 0 0 161 12026055133 10246 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/Typed.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 3626 11451071612 31453 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
/**
* classes that implement this interface have a notion
* of "type" like int, String, GerblinkenLight, etc.
*/
public interface Typed extends IDefinition {
/**
* gets the type of this definition
*/
public IClass getType();
}
././@LongLink 100644 0 0 170 12026055133 10246 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/UnknownClass.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 11417 11451071612 31470 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import java.util.Iterator;
import java.util.List;
import java.util.Vector;
public class UnknownClass implements IClass {
String _name;
SymTabAST _node;
public UnknownClass(String name, SymTabAST node) {
_name = name;
_node = node;
//System.out.println("Creating unknown class [" + name + " : " + node + "]");
}
/**
* returns the ClassDef that for the superclass
*
* @return the ClassDef for the superclass
*/
public IClass getSuperclass() {
return null;
}
public IClass[] getInterfaces() {
return new IClass[0];
}
/**
* returns a collection of the direct subclasses of this class
*
* @return a collection of the direct subclasses of this class
*/
public List getSubclasses() {
return new Vector();
}
public IClass getClassDefinition(String name) {
return null;
}
/**
* gets the method associated with the given name and signature
*
* @param name the name of the method
* @param signature the signature (formal parameter types) of the method
*
* @return MethodDef
*
* @see MethodSignature
*/
public IMethod getMethodDefinition(String name,
ISignature signature) {
return null;
}
/**
* gets the VariableDef associated with the given name
*
* @param name the name of the variable
*
* @return VariableDef
*/
public IVariable getVariableDefinition(String name) {
return null;
}
// end definitions interface
/**
* adds ClassDef to the collection of (direct?) subclasses of
* this class
*
* @param subclass the class to add
*/
public void addSubclass(ClassDef subclass) {}
/**
* adds ClassDef to the collection of implemented interfaces
* of this class
*
* @param implementor the interface to add
*/
public void addImplementor(ClassDef implementor) {}
/**
* gets the list of ClassDefs that implmement this interface
*
* @return Vector the list of implementors
*/
public List getImplementors() {
return new Vector();
}
public boolean isCompatibleWith(IClass type) {
return false;
}
public void addReference(Reference reference) {}
public Iterator getReferences() {
return new Vector().iterator();
}
public int getNumReferences() {
return 0;
}
public boolean isPrimitive() {
return false;
}
public boolean isSourced() {
return false;
}
public IClass[] getInnerClasses() {
return new IClass[0];
}
public String getName() {
return _name;
}
public String getQualifiedName() {
return _name;
}
public boolean equals(Object o) {
//TODO: handle Checkstyle condition for two unknown classes
if (o instanceof UnknownClass) {
final UnknownClass other = (UnknownClass) o;
return other.getName().equals(getName());
}
return false;
}
public String toString() {
return UnknownClass.class + "[" + getName() + "]";
}
}
././@LongLink 100644 0 0 167 12026055133 10254 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/VariableDef.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/transmogrif100644 0 0 10712 11451071612 31465 0 ustar 0 0
// Transmogrify License
//
// Copyright (c) 2001, ThoughtWorks, Inc.
// All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// - Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// - Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// Neither the name of the ThoughtWorks, Inc. nor the names of its
// contributors may be used to endorse or promote products derived from this
// software without specific prior written permission.
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* VariableDef is a Definition that contains
* information about the definition of a variable.
*
* @see Definition
* @see TypedDef
*/
public class VariableDef extends Definition implements IVariable {
public static final int PRIVATE_VISIBILITY = 0;
public static final int PROTECTED_VISIBILITY = 1;
public static final int PUBLIC_VISIBILITY = 2;
public static final int DEFAULT_VISIBILITY = 3;
private IClass _type = null;
public VariableDef(String name, Scope parentScope, SymTabAST node) {
super(name, parentScope, node);
}
/**
* Returns the Type of the variable.
*
* @see TypedDef
*
* @return the Type of the variable
*/
public IClass getType() {
return _type;
}
/**
* Sets the type of the variable.
*
* @see TypedDef
*
* @param def the Type object that represents the type of the
* variable.
*/
public void setType(IClass type) {
_type = type;
}
public int getVisibility() {
int result = DEFAULT_VISIBILITY;
SymTabAST visibilityNode = getVisibilityNode();
if (visibilityNode != null) {
if (visibilityNode.getType() == TokenTypes.LITERAL_PRIVATE) {
result = PRIVATE_VISIBILITY;
}
else if (
visibilityNode.getType() == TokenTypes.LITERAL_PROTECTED) {
result = PROTECTED_VISIBILITY;
}
else if (visibilityNode.getType() == TokenTypes.LITERAL_PUBLIC) {
result = PUBLIC_VISIBILITY;
}
}
return result;
}
private SymTabAST getVisibilityNode() {
SymTabAST result = null;
SymTabAST modifiersNode =
getTreeNode().findFirstToken(TokenTypes.MODIFIERS);
SymTabAST modifier = (SymTabAST) modifiersNode.getFirstChild();
while (modifier != null) {
if (isVisibilityNode(modifier)) {
result = modifier;
break;
}
modifier = (SymTabAST) modifier.getNextSibling();
}
return result;
}
private boolean isVisibilityNode(SymTabAST node) {
return (
node.getType() == TokenTypes.LITERAL_PUBLIC
|| node.getType() == TokenTypes.LITERAL_PROTECTED
|| node.getType() == TokenTypes.LITERAL_PRIVATE);
}
public boolean isAssignedAtDeclaration() {
boolean result = false;
if (getTreeNode().findFirstToken(TokenTypes.ASSIGN) != null) {
result = true;
}
return result;
}
}
././@LongLink 100644 0 0 167 12026055133 10254 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/UnusedLocalVariableCheck.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/UnusedLocal100644 0 0 4112 11451071612 31325 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2005 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.usage;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
Checks that a local variable is read.
*
*
* An example of how to configure the check is:
*
*
* <module name="usage.UnusedLocalVariable"/>
*
*
* @author Rick Giles
*/
public class UnusedLocalVariableCheck extends AbstractUsageCheck
{
/** @see com.puppycrawl.tools.checkstyle.api.Check */
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.VARIABLE_DEF,
};
}
/** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
public String getErrorKey()
{
return "unused.local";
}
/** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
public boolean mustCheckReferenceCount(DetailAST aAST)
{
return ScopeUtils.isLocalVariableDef(aAST);
}
}
././@LongLink 100644 0 0 163 12026055133 10250 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/UnusedParameterCheck.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/UnusedParam100644 0 0 10763 11451071612 31364 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2005 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.usage;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
Checks that a parameter is used.
*
*
* An example of how to configure the check is:
*
*
* <module name="usage.UnusedParameter"/>
*
*
* @author Rick Giles
*/
public class UnusedParameterCheck extends AbstractUsageCheck
{
/** controls checking of catch clause parameter */
private boolean mIgnoreCatch = true;
/** controls checking of public/protected/package methods */
private boolean mIgnoreNonLocal;
/** @see com.puppycrawl.tools.checkstyle.api.Check */
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.PARAMETER_DEF,
};
}
/** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
public String getErrorKey()
{
return "unused.parameter";
}
/** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
public boolean mustCheckReferenceCount(DetailAST aAST)
{
boolean result = false;
final DetailAST parent = aAST.getParent();
if (parent != null) {
if (parent.getType() == TokenTypes.PARAMETERS) {
final DetailAST grandparent = parent.getParent();
if (grandparent != null) {
result = hasBody(grandparent)
&& (!mIgnoreNonLocal || isLocal(grandparent));
}
}
else if (parent.getType() == TokenTypes.LITERAL_CATCH) {
result = !mIgnoreCatch;
}
}
return result;
}
/**
* Determines whether an AST is a method definition with a body, or is
* a constructor definition.
* @param aAST the AST to check.
* @return if AST has a body.
*/
private boolean hasBody(DetailAST aAST)
{
if (aAST.getType() == TokenTypes.METHOD_DEF) {
return aAST.branchContains(TokenTypes.SLIST);
}
else if (aAST.getType() == TokenTypes.CTOR_DEF) {
return true;
}
return false;
}
/**
* Checks if a given method is local, i.e. either static or private.
* @param aAST method def for check
* @return true if a given method is iether static or private.
*/
private boolean isLocal(DetailAST aAST)
{
if (aAST.getType() == TokenTypes.METHOD_DEF) {
final DetailAST modifiers =
aAST.findFirstToken(TokenTypes.MODIFIERS);
return (modifiers == null)
|| modifiers.branchContains(TokenTypes.LITERAL_STATIC)
|| modifiers.branchContains(TokenTypes.LITERAL_PRIVATE);
}
return true;
}
/**
* Control whether unused catch clause parameters are flagged.
* @param aIgnoreCatch whether unused catch clause parameters
* should be flagged.
*/
public void setIgnoreCatch(boolean aIgnoreCatch)
{
mIgnoreCatch = aIgnoreCatch;
}
/**
* Controls whether public/protected/paskage methods shouldn't be checked.
* @param aIgnoreNonLocal whether we should check any other methods
* except static and private should be checked.
*/
public void setIgnoreNonLocal(boolean aIgnoreNonLocal)
{
mIgnoreNonLocal = aIgnoreNonLocal;
}
}
././@LongLink 100644 0 0 166 12026055133 10253 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/UnusedPrivateFieldCheck.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/UnusedPriva100644 0 0 4374 11451071612 31366 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2005 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.usage;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.Scope;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
Checks that a private field is used.
*
*
* An example of how to configure the check is:
*
*
* <module name="usage.UnusedPrivateField"/>
*
*
* @author Rick Giles
*/
public class UnusedPrivateFieldCheck
extends AbstractUsageCheck
{
/** @see com.puppycrawl.tools.checkstyle.api.Check */
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.VARIABLE_DEF,
};
}
/** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
public String getErrorKey()
{
return "unused.field";
}
/** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
public boolean mustCheckReferenceCount(DetailAST aAST)
{
final DetailAST mods = aAST.findFirstToken(TokenTypes.MODIFIERS);
return ((mods != null)
&& (ScopeUtils.getScopeFromMods(mods) == Scope.PRIVATE));
}
}
././@LongLink 100644 0 0 167 12026055133 10254 L ustar 0 0 checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/UnusedPrivateMethodCheck.java checkstyle-5.6/contrib/usage/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/UnusedPriva100644 0 0 21651 11451071612 31403 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2005 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.usage;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.Scope;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
Checks that a private method is used.
*
*
* An example of how to configure the check is:
*
*
* <module name="usage.UnusedPrivateMethod"/>
*
*
* @author Rick Giles
*/
public class UnusedPrivateMethodCheck
extends AbstractUsageCheck
{
/** Controls if checks skips serialization methods.*/
private boolean mAllowSerializationMethods;
/** @see com.puppycrawl.tools.checkstyle.api.Check */
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.METHOD_DEF,
};
}
/** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
public String getErrorKey()
{
return "unused.method";
}
/**
* Configure the check to allow (or not) serialization-related methods.
* @param aFlag new value for allowSerializationMethods value.
*/
public void setAllowSerializationMethods(boolean aFlag)
{
mAllowSerializationMethods = aFlag;
}
/** @see com.puppycrawl.tools.checkstyle.checks.usage.AbstractUsageCheck */
public boolean mustCheckReferenceCount(DetailAST aAST)
{
final DetailAST mods = aAST.findFirstToken(TokenTypes.MODIFIERS);
if ((mods == null)
|| (ScopeUtils.getScopeFromMods(mods) != Scope.PRIVATE))
{
return false;
}
return !mAllowSerializationMethods
|| !(isWriteObject(aAST) || isReadObject(aAST)
|| isWriteReplaceOrReadResolve(aAST));
}
/**
* Checks if a given method is writeObject().
* @param aAST method def to check
* @return true if this is a writeObject() definition
*/
private boolean isWriteObject(DetailAST aAST)
{
// name is writeObject...
final DetailAST ident = aAST.findFirstToken(TokenTypes.IDENT);
if (!"writeObject".equals(ident.getText())) {
return false;
}
// returns void...
final DetailAST typeAST =
(DetailAST) aAST.findFirstToken(TokenTypes.TYPE).getFirstChild();
if (typeAST.getType() != TokenTypes.LITERAL_VOID) {
return false;
}
// should have one parameter...
final DetailAST params = aAST.findFirstToken(TokenTypes.PARAMETERS);
if (params == null || params.getChildCount() != 1) {
return false;
}
// and paramter's type should be java.io.ObjectOutputStream
final DetailAST type =
(DetailAST) ((DetailAST) params.getFirstChild())
.findFirstToken(TokenTypes.TYPE).getFirstChild();
final String typeName = FullIdent.createFullIdent(type).getText();
if (!"java.io.ObjectOutputStream".equals(typeName)
&& !"ObjectOutputStream".equals(typeName))
{
return false;
}
// and, finally, it should throws java.io.IOException
final DetailAST throwsAST =
aAST.findFirstToken(TokenTypes.LITERAL_THROWS);
if (throwsAST == null || throwsAST.getChildCount() != 1) {
return false;
}
final DetailAST expt = (DetailAST) throwsAST.getFirstChild();
final String exceptionName = FullIdent.createFullIdent(expt).getText();
if (!"java.io.IOException".equals(exceptionName)
&& !"IOException".equals(exceptionName))
{
return false;
}
return true;
}
/**
* Checks if a given method is readObject().
* @param aAST method def to check
* @return true if this is a readObject() definition
*/
private boolean isReadObject(DetailAST aAST)
{
// name is readObject...
final DetailAST ident = aAST.findFirstToken(TokenTypes.IDENT);
if (!"readObject".equals(ident.getText())) {
return false;
}
// returns void...
final DetailAST typeAST =
(DetailAST) aAST.findFirstToken(TokenTypes.TYPE).getFirstChild();
if (typeAST.getType() != TokenTypes.LITERAL_VOID) {
return false;
}
// should have one parameter...
final DetailAST params = aAST.findFirstToken(TokenTypes.PARAMETERS);
if (params == null || params.getChildCount() != 1) {
return false;
}
// and paramter's type should be java.io.ObjectInputStream
final DetailAST type =
(DetailAST) ((DetailAST) params.getFirstChild())
.findFirstToken(TokenTypes.TYPE).getFirstChild();
final String typeName = FullIdent.createFullIdent(type).getText();
if (!"java.io.ObjectInputStream".equals(typeName)
&& !"ObjectInputStream".equals(typeName))
{
return false;
}
// and, finally, it should throws java.io.IOException
// and java.lang.ClassNotFoundException
final DetailAST throwsAST =
aAST.findFirstToken(TokenTypes.LITERAL_THROWS);
if (throwsAST == null || throwsAST.getChildCount() != 3) {
return false;
}
final DetailAST excpt1 = (DetailAST) throwsAST.getFirstChild();
final String exception1 = FullIdent.createFullIdent(excpt1).getText();
final String exception2 =
FullIdent.createFullIdent(throwsAST.getLastChild()).getText();
if (!"java.io.IOException".equals(exception1)
&& !"IOException".equals(exception1)
&& !"java.io.IOException".equals(exception2)
&& !"IOException".equals(exception2)
|| !"java.lang.ClassNotFoundException".equals(exception1)
&& !"ClassNotFoundException".equals(exception1)
&& !"java.lang.ClassNotFoundException".equals(exception2)
&& !"ClassNotFoundException".equals(exception2))
{
return false;
}
return true;
}
/**
* Checks if a given method is writeReplace() or readResolve().
* @param aAST method def to check
* @return true if this is a writeReplace() definition
*/
private boolean isWriteReplaceOrReadResolve(DetailAST aAST)
{
// name is writeReplace or readResolve...
final DetailAST ident = aAST.findFirstToken(TokenTypes.IDENT);
if (!"writeReplace".equals(ident.getText())
&& !"readResolve".equals(ident.getText()))
{
return false;
}
// returns Object...
final DetailAST typeAST =
(DetailAST) aAST.findFirstToken(TokenTypes.TYPE).getFirstChild();
if (typeAST.getType() != TokenTypes.DOT
&& typeAST.getType() != TokenTypes.IDENT)
{
return false;
}
// should have no parameters...
final DetailAST params = aAST.findFirstToken(TokenTypes.PARAMETERS);
if (params != null && params.getChildCount() != 0) {
return false;
}
// and, finally, it should throws java.io.ObjectStreamException
final DetailAST throwsAST =
aAST.findFirstToken(TokenTypes.LITERAL_THROWS);
if (throwsAST == null || throwsAST.getChildCount() != 1) {
return false;
}
final DetailAST excpt = (DetailAST) throwsAST.getFirstChild();
final String exception = FullIdent.createFullIdent(excpt).getText();
if (!"java.io.ObjectStreamException".equals(exception)
&& !"ObjectStreamException".equals(exception))
{
return false;
}
return true;
}
}
././@LongLink 100644 0 0 146 12026055133 10251 L ustar 0 0 checkstyle-5.6/contrib/usage/src/testinputs/com/puppycrawl/tools/checkstyle/usage/InputEmptyFile.java checkstyle-5.6/contrib/usage/src/testinputs/com/puppycrawl/tools/checkstyle/usage/InputEmptyFile.jav100644 0 0 66 11451071612 31374 0 ustar 0 0 // this is an empty file
// it's a test for 1165855
././@LongLink 100644 0 0 154 12026055133 10250 L ustar 0 0 checkstyle-5.6/contrib/usage/src/testinputs/com/puppycrawl/tools/checkstyle/usage/InputInnerUsedMethod.java checkstyle-5.6/contrib/usage/src/testinputs/com/puppycrawl/tools/checkstyle/usage/InputInnerUsedMeth100644 0 0 732 11451071612 31451 0 ustar 0 0 package com.puppycrawl.tools.checkstyle.usage;
import java.awt.event.ActionEvent;
import javax.swing.AbstractAction;
import javax.swing.JButton;
public final class InputInnerUsedMethod
{
public static void show()
{
JButton b = new JButton(new AbstractAction()
{
public void actionPerformed(ActionEvent e)
{
doSomething();
}
});
}
private static void doSomething()
{
}
}
././@LongLink 100644 0 0 162 12026055133 10247 L ustar 0 0 checkstyle-5.6/contrib/usage/src/testinputs/com/puppycrawl/tools/checkstyle/usage/InputOneMethodPrivateField.java checkstyle-5.6/contrib/usage/src/testinputs/com/puppycrawl/tools/checkstyle/usage/InputOneMethodPriv100644 0 0 4040 11451071612 31476 0 ustar 0 0 package com.puppycrawl.tools.checkstyle.usage;
/** Test input for one method private field check */
public class InputOneMethodPrivateField
{
private static int SFIELD0;
private static int SFIELD1;
private static int SFIELD2;
private static int SFIELD3;
private int mField0;
private int mField1;
private int mField2;
private int mField3;
private int mField4;
private int mIgnore;
public InputOneMethodPrivateField()
{
SFIELD0 = 0;
mField0 = 0;
mField3 = 0;
}
private void method()
{
SFIELD1 = 0;
mField1 = 0;
mField3++;
mField4 = 0;
}
{
SFIELD2 = 0;
mField2 = 0;
mField4 = 1;
}
static
{
SFIELD3 = 0;
}
}
class Outer2
{
private int mField0;
private int mField1;
private int mField2;
private int mField3;
private class Inner
{
public Inner()
{
int i = mField0;
}
public void method()
{
mField1 = 0;
mField3++;
}
{
mField2 = 0;
}
}
private void method()
{
mField3 = 0;
}
}
class Outer3
{
private int mField0;
private int mField1;
private void method()
{
final class Inner
{
public int mInner = mField0;
}
}
/** tests NPE with dotted class name (bug 842781) */
public void dotted()
{
java.lang.Thread th
= new java.lang.Thread() {
public void run() {
;
}
};
th.start();
}
}
/** Tests NPE with foreach statements (bug 1109222) */
class Outer4
{
private int[] mField;
private void method()
{
for (int someInt : mField)
{
someInt = someInt ^ 2;
}
}
} ././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/contrib/usage/src/testinputs/com/puppycrawl/tools/checkstyle/usage/InputUnusedField.java checkstyle-5.6/contrib/usage/src/testinputs/com/puppycrawl/tools/checkstyle/usage/InputUnusedField.j100644 0 0 3641 11451071612 31420 0 ustar 0 0 package com.puppycrawl.tools.checkstyle.usage;
import java.awt.Rectangle;
/** Test input for unused field check */
public class InputUnusedField
{
private int mReadPrimitive;
private int mPrimitive;
private int mUnreadPrimitive;
private String mReadString;
private String mReadString2;
private Rectangle mRectangle;
private int[] mArray;
private int[] mArray2;
private int[] mUnreadArray;
private int mThisPrimitive;
private int mInitializer = 0;
private int mUnused2 = mInitializer;
private static final int SUNUSED = 0;
private static int USED;
static
{
USED = 0;
}
public InputUnusedField()
{
int i = mReadPrimitive;
}
private void method()
{
int i = mReadString.length();
"".equals(mReadString2);
int j = mRectangle.x;
i = mArray[0];
mArray2[0] = 0;
this.mThisPrimitive = 1;
}
private void shadow()
{
int mUnreadPrimitive = 0;
mUnreadPrimitive++;
int[] mUnreadArray = {0};
int i = mUnreadArray[0];
}
{
mPrimitive = 0;
}
}
class Outer
{
private int mUsed1;
private int mUsed2;
private int mUsed3;
private int mUnused;
private class Inner
{
public Inner()
{
int i = mUsed1;
}
public void method()
{
mUsed2 = 0;
}
{
mUsed3 = 0;
}
}
}
class ParenthesizedExpression
{
private int mUsed1 = 1;
private int mUsed2 = 1;
private boolean mUsed3 = true;
public void testParentheses()
{
int x = 0;
int a = (x++) / mUsed1;
int b = (a - 1) << mUsed2;
boolean c = (a == b) || mUsed3;
}
}
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/contrib/usage/src/testinputs/com/puppycrawl/tools/checkstyle/usage/InputUnusedLocal.java checkstyle-5.6/contrib/usage/src/testinputs/com/puppycrawl/tools/checkstyle/usage/InputUnusedLocal.j100644 0 0 2460 11451071612 31425 0 ustar 0 0 package com.puppycrawl.tools.checkstyle.usage;
import java.awt.Rectangle;
/** Test input for unused local variable check */
public class InputUnusedLocal
{
private int mUnreadPrimitive = 0;
public InputUnusedLocal()
{
int readPrimitive = 0;
int mUnreadPrimitive = 0;
int i = readPrimitive;
i++;
this.mUnreadPrimitive++;
}
private void method()
{
String readObject = "";
Rectangle rectangle = null;
Object unreadObject;
int i = readObject.length();
int j = rectangle.x;
i += j;
}
private void methodArrays()
{
int[] array = {};
int[] array2 = {};
int[] unreadArray;
int i = array[0];
array2[0] = 0;
i++;
}
/** tests that neither type nor typecast are considered to be a reference */
public void method2()
{
int java;
java.io.File file = (java.io.File) null;
if (file != null) {
}
}
/** tests array index references */
public void testArrayIndex()
{
int [][][] a = new int[1][1][1];
int i = 0;
int j = 0;
int k = 0;
a[i][j][k]++;
}
}
././@LongLink 100644 0 0 151 12026055133 10245 L ustar 0 0 checkstyle-5.6/contrib/usage/src/testinputs/com/puppycrawl/tools/checkstyle/usage/InputUnusedMethod.java checkstyle-5.6/contrib/usage/src/testinputs/com/puppycrawl/tools/checkstyle/usage/InputUnusedMethod.100644 0 0 6744 11451071612 31452 0 ustar 0 0 package com.puppycrawl.tools.checkstyle.usage;
/** Test input for unread method check */
public class InputUnusedMethod
{
private void methodUnused0()
{
}
private void methodUsed0()
{
}
private void methodUsed1(int aParam)
{
}
private void methodUsed1(double aParam)
{
}
private void methodUsed1(String aParam)
{
}
public static void main(String[] args)
{
InputUnusedMethod method = new InputUnusedMethod();
method.methodUsed0();
method.methodUsed1(0 + 4);
method.methodUsed1(Math.sqrt(2.0));
method.methodUsed1("" + "a");
}
}
interface InterfaceMethod
{
public void method(int aParam);
}
abstract class AbstractClassMethod
{
public abstract void method(int aParam);
}
/** Test for bug 880954: false positive when parentheses around second term
* of ternary operator.
*/
class Ternary
{
private int m()
{
return 1;
}
public void m1()
{
int i = 0;
int j = (i == 0) ? (i) : m();
}
}
class SerializableTest implements java.io.Serializable
{
private void writeObject(java.io.ObjectOutputStream out) throws java.io.IOException
{
// it's ok to have this method in serializable class
}
private void readObject(java.io.ObjectInputStream in) throws java.io.IOException, ClassNotFoundException
{
// it's ok to have this method in serializable class
}
private Object writeReplace() throws java.io.ObjectStreamException
{
// it's ok to have this method in serializable class
return new SerializableTest();
}
private Object readResolve() throws java.io.ObjectStreamException
{
// it's ok to have this method in serializable class
return new SerializableTest();
}
}
class BadSerializableTest1 implements java.io.Serializable
{
private void writeObject(Object out) throws java.io.IOException
{
}
private void writeObject(java.io.ObjectOutputStream out, int i) throws java.io.IOException
{
}
private void writeObject(java.io.ObjectOutputStream out)
{
}
private void readObject(java.io.ObjectInputStream in) throws java.io.IOException
{
}
private void readObject(Object in) throws java.io.IOException, ClassNotFoundException
{
}
private int writeReplace() throws java.io.ObjectStreamException
{
return 1;
}
private Object writeReplace(int i) throws java.io.ObjectStreamException
{
return new SerializableTest();
}
private int readResolve() throws java.io.ObjectStreamException
{
return 1;
}
private Object readResolve(int i) throws java.io.ObjectStreamException
{
return new SerializableTest();
}
}
class BadSerializableTest2 implements java.io.Serializable
{
private int writeObject(java.io.ObjectOutputStream out) throws java.io.IOException
{
return 1;
}
private void readObject(java.io.ObjectInputStream in) throws ClassNotFoundException
{
}
private Object readResolve()
{
return new SerializableTest();
}
}
class BadSerializableTest3 implements java.io.Serializable
{
private int readObject(java.io.ObjectInputStream in) throws java.io.IOException, ClassNotFoundException
{
return 1;
}
}
././@LongLink 100644 0 0 154 12026055133 10250 L ustar 0 0 checkstyle-5.6/contrib/usage/src/testinputs/com/puppycrawl/tools/checkstyle/usage/InputUnusedParameter.java checkstyle-5.6/contrib/usage/src/testinputs/com/puppycrawl/tools/checkstyle/usage/InputUnusedParamet100644 0 0 2041 11451071612 31527 0 ustar 0 0 package com.puppycrawl.tools.checkstyle.usage;
import java.awt.Rectangle;
/** Test input for unread parameter check */
public class InputUnusedParameter
{
public InputUnusedParameter(int aReadPrimitive, int aUnreadPrimitive)
{
int i = aReadPrimitive;
}
public void method(
String aReadObject,
Rectangle aRectangle,
Object aUnreadObject)
{
int i = aReadObject.length();
int j = aRectangle.x;
try {
i++;
}
catch (Exception unreadException) {
}
}
private void methodArrays(int[] aArray, int[] aArray2, int[] aUnreadArray)
{
int i = aArray[0];
aArray2[0] = 0;
}
private int member = 1;
private void methodSameLocalVariable(int member)
{
int x = member; // refers to the param, not the member
}
}
interface Interface
{
public void method(int aParam);
}
abstract class AbstractClass
{
public abstract void method(int aParam);
}
checkstyle-5.6/contrib/usage/src/tests/com/puppycrawl/tools/checkstyle/checks/usage/AllTests.java 100644 0 0 1457 11451071612 30577 0 ustar 0 0 package com.puppycrawl.tools.checkstyle.checks.usage;
import junit.framework.Test;
import junit.framework.TestSuite;
public class AllTests {
public static void main(String[] args) {
junit.textui.TestRunner.run(AllTests.suite());
}
public static Test suite() {
TestSuite suite =
new TestSuite("Test for com.puppycrawl.tools.checkstyle.checks.usage");
suite.addTest(new TestSuite(OneMethodPrivateFieldCheckTest.class));
suite.addTest(new TestSuite(UnusedLocalVariableCheckTest.class));
suite.addTest(new TestSuite(UnusedParameterCheckTest.class));
suite.addTest(new TestSuite(UnusedPrivateFieldCheckTest.class));
suite.addTest(new TestSuite(UnusedPrivateMethodCheckTest.class));
return suite;
}
}
././@LongLink 100644 0 0 170 12026055133 10246 L ustar 0 0 checkstyle-5.6/contrib/usage/src/tests/com/puppycrawl/tools/checkstyle/checks/usage/OneMethodPrivateFieldCheckTest.java checkstyle-5.6/contrib/usage/src/tests/com/puppycrawl/tools/checkstyle/checks/usage/OneMethodPrivate100644 0 0 4367 11451071612 31344 0 ustar 0 0 package com.puppycrawl.tools.checkstyle.checks.usage;
import com.puppycrawl.tools.checkstyle.BaseCheckTestCase;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
public class OneMethodPrivateFieldCheckTest
extends BaseCheckTestCase
{
public void testDefault() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(OneMethodPrivateFieldCheck.class);
final String[] expected = {
"6:24: Field 'SFIELD0' is used in only one method.",
"7:24: Field 'SFIELD1' is used in only one method.",
"8:24: Field 'SFIELD2' is used in only one method.",
"9:24: Field 'SFIELD3' is used in only one method.",
"11:17: Field 'mField0' is used in only one method.",
"12:17: Field 'mField1' is used in only one method.",
"13:17: Field 'mField2' is used in only one method.",
"47:17: Field 'mField0' is used in only one method.",
"48:17: Field 'mField1' is used in only one method.",
"49:17: Field 'mField2' is used in only one method.",
"105:19: Field 'mField' is used in only one method.",
};
verify(checkConfig, getPath("usage/InputOneMethodPrivateField.java"), expected);
}
public void testIgnoreFormat() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(OneMethodPrivateFieldCheck.class);
checkConfig.addAttribute("ignoreFormat", "2$");
final String[] expected = {
"6:24: Field 'SFIELD0' is used in only one method.",
"7:24: Field 'SFIELD1' is used in only one method.",
"9:24: Field 'SFIELD3' is used in only one method.",
"11:17: Field 'mField0' is used in only one method.",
"12:17: Field 'mField1' is used in only one method.",
"47:17: Field 'mField0' is used in only one method.",
"48:17: Field 'mField1' is used in only one method.",
"105:19: Field 'mField' is used in only one method.",
};
verify(checkConfig, getPath("usage/InputOneMethodPrivateField.java"), expected);
}
}
././@LongLink 100644 0 0 166 12026055133 10253 L ustar 0 0 checkstyle-5.6/contrib/usage/src/tests/com/puppycrawl/tools/checkstyle/checks/usage/UnusedLocalVariableCheckTest.java checkstyle-5.6/contrib/usage/src/tests/com/puppycrawl/tools/checkstyle/checks/usage/UnusedLocalVaria100644 0 0 2574 11451071612 31326 0 ustar 0 0 package com.puppycrawl.tools.checkstyle.checks.usage;
import com.puppycrawl.tools.checkstyle.BaseCheckTestCase;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
public class UnusedLocalVariableCheckTest
extends BaseCheckTestCase
{
public void testDefault() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(UnusedLocalVariableCheck.class);
final String[] expected = {
"13:13: Unused local variable 'mUnreadPrimitive'.",
"24:16: Unused local variable 'unreadObject'.",
"36:15: Unused local variable 'unreadArray'.",
"45:13: Unused local variable 'java'.",
};
verify(checkConfig, getPath("usage/InputUnusedLocal.java"), expected);
}
public void testIgnoreFormat() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(UnusedLocalVariableCheck.class);
checkConfig.addAttribute("ignoreFormat", "Array$");
final String[] expected = {
"13:13: Unused local variable 'mUnreadPrimitive'.",
"24:16: Unused local variable 'unreadObject'.",
"45:13: Unused local variable 'java'.",
};
verify(checkConfig, getPath("usage/InputUnusedLocal.java"), expected);
}
}
././@LongLink 100644 0 0 162 12026055133 10247 L ustar 0 0 checkstyle-5.6/contrib/usage/src/tests/com/puppycrawl/tools/checkstyle/checks/usage/UnusedParameterCheckTest.java checkstyle-5.6/contrib/usage/src/tests/com/puppycrawl/tools/checkstyle/checks/usage/UnusedParameterC100644 0 0 4504 11451071612 31327 0 ustar 0 0 package com.puppycrawl.tools.checkstyle.checks.usage;
import com.puppycrawl.tools.checkstyle.BaseCheckTestCase;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
public class UnusedParameterCheckTest
extends BaseCheckTestCase
{
public void testDefault() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(UnusedParameterCheck.class);
final String[] expected = {
"8:57: Unused parameter 'aUnreadPrimitive'.",
"16:16: Unused parameter 'aUnreadObject'.",
"29:66: Unused parameter 'aUnreadArray'.",
};
verify(checkConfig, getPath("usage/InputUnusedParameter.java"), expected);
}
public void testException() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(UnusedParameterCheck.class);
checkConfig.addAttribute("ignoreCatch", Boolean.FALSE.toString());
final String[] expected = {
"8:57: Unused parameter 'aUnreadPrimitive'.",
"16:16: Unused parameter 'aUnreadObject'.",
"25:26: Unused parameter 'unreadException'.",
"29:66: Unused parameter 'aUnreadArray'.",
};
verify(checkConfig, getPath("usage/InputUnusedParameter.java"), expected);
}
public void testIgnoreFormat() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(UnusedParameterCheck.class);
checkConfig.addAttribute("ignoreFormat", "Array$");
final String[] expected = {
"8:57: Unused parameter 'aUnreadPrimitive'.",
"16:16: Unused parameter 'aUnreadObject'.",
};
verify(checkConfig, getPath("usage/InputUnusedParameter.java"), expected);
}
public void testIgnoreNonLocal() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(UnusedParameterCheck.class);
checkConfig.addAttribute("ignoreNonLocal", "true");
final String[] expected = {
"8:57: Unused parameter 'aUnreadPrimitive'.",
"29:66: Unused parameter 'aUnreadArray'.",
};
verify(checkConfig, getPath("usage/InputUnusedParameter.java"), expected);
}
}
././@LongLink 100644 0 0 165 12026055133 10252 L ustar 0 0 checkstyle-5.6/contrib/usage/src/tests/com/puppycrawl/tools/checkstyle/checks/usage/UnusedPrivateFieldCheckTest.java checkstyle-5.6/contrib/usage/src/tests/com/puppycrawl/tools/checkstyle/checks/usage/UnusedPrivateFie100644 0 0 2756 11451071612 31351 0 ustar 0 0 package com.puppycrawl.tools.checkstyle.checks.usage;
import com.puppycrawl.tools.checkstyle.BaseCheckTestCase;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
public class UnusedPrivateFieldCheckTest
extends BaseCheckTestCase
{
public void testDefault() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(UnusedPrivateFieldCheck.class);
final String[] expected = {
"10:17: Unused private field 'mUnreadPrimitive'.",
"16:19: Unused private field 'mUnreadArray'.",
"20:17: Unused private field 'mUnused2'.",
"22:30: Unused private field 'SUNUSED'.",
"64:17: Unused private field 'mUnused'.",
};
verify(checkConfig, getPath("usage/InputUnusedField.java"), expected);
}
public void testIgnoreFormat() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(UnusedPrivateFieldCheck.class);
checkConfig.addAttribute("ignoreFormat", "Array$");
final String[] expected = {
"10:17: Unused private field 'mUnreadPrimitive'.",
"20:17: Unused private field 'mUnused2'.",
"22:30: Unused private field 'SUNUSED'.",
"64:17: Unused private field 'mUnused'.",
};
verify(checkConfig, getPath("usage/InputUnusedField.java"), expected);
}
}
././@LongLink 100644 0 0 166 12026055133 10253 L ustar 0 0 checkstyle-5.6/contrib/usage/src/tests/com/puppycrawl/tools/checkstyle/checks/usage/UnusedPrivateMethodCheckTest.java checkstyle-5.6/contrib/usage/src/tests/com/puppycrawl/tools/checkstyle/checks/usage/UnusedPrivateMet100644 0 0 6660 11451071612 31371 0 ustar 0 0 package com.puppycrawl.tools.checkstyle.checks.usage;
import com.puppycrawl.tools.checkstyle.BaseCheckTestCase;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
public class UnusedPrivateMethodCheckTest
extends BaseCheckTestCase
{
public void testDefault() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(UnusedPrivateMethodCheck.class);
final String[] expected = {
"7:18: Unused private method 'methodUnused0'.",
"66:18: Unused private method 'writeObject'.",
"71:18: Unused private method 'readObject'.",
"76:20: Unused private method 'writeReplace'.",
"82:20: Unused private method 'readResolve'.",
"91:18: Unused private method 'writeObject'.",
"95:18: Unused private method 'writeObject'.",
"99:18: Unused private method 'writeObject'.",
"103:18: Unused private method 'readObject'.",
"107:18: Unused private method 'readObject'.",
"111:17: Unused private method 'writeReplace'.",
"116:20: Unused private method 'writeReplace'.",
"121:17: Unused private method 'readResolve'.",
"126:20: Unused private method 'readResolve'.",
"134:17: Unused private method 'writeObject'.",
"139:18: Unused private method 'readObject'.",
"143:20: Unused private method 'readResolve'.",
"151:17: Unused private method 'readObject'.",
};
verify(checkConfig, getPath("usage/InputUnusedMethod.java"), expected);
}
public void testAllowSerializationMethods() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(UnusedPrivateMethodCheck.class);
checkConfig.addAttribute("allowSerializationMethods", "true");
final String[] expected = {
"7:18: Unused private method 'methodUnused0'.",
"91:18: Unused private method 'writeObject'.",
"95:18: Unused private method 'writeObject'.",
"99:18: Unused private method 'writeObject'.",
"103:18: Unused private method 'readObject'.",
"107:18: Unused private method 'readObject'.",
"111:17: Unused private method 'writeReplace'.",
"116:20: Unused private method 'writeReplace'.",
"121:17: Unused private method 'readResolve'.",
"126:20: Unused private method 'readResolve'.",
"134:17: Unused private method 'writeObject'.",
"139:18: Unused private method 'readObject'.",
"143:20: Unused private method 'readResolve'.",
"151:17: Unused private method 'readObject'.",
};
verify(checkConfig, getPath("usage/InputUnusedMethod.java"), expected);
}
public void testInner() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(UnusedPrivateMethodCheck.class);
final String[] expected = {
};
verify(checkConfig, getPath("usage/InputInnerUsedMethod.java"), expected);
}
public void testEmptyFile() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(UnusedPrivateMethodCheck.class);
final String[] expected = {
};
verify(checkConfig, getPath("usage/InputEmptyFile.java"), expected);
}
}
checkstyle-5.6/contrib/usage/src/xdocs/config_usage.xml 100644 0 0 25442 11451071612 20524 0 ustar 0 0
Usage ChecksCheckstyle Development Team
Checks that a private field is used in more than one method,
constructor, or initializer.
Rationale: a private field used in only one method,
constructor, or initializer should be replaced by a local
variable.
The classpath may need to be configured to locate
parameter type information. The classpath configuration is
dependent on the mechanism used to invoke Checkstyle.
checkstyle-5.6/import-control.xml 100644 0 0 3751 11451071612 14367 0 ustar 0 0
checkstyle-5.6/java.header 100644 0 0 2007 12026050216 12735 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
checkstyle-5.6/LICENSE 100644 0 0 64466 11451071611 11713 0 ustar 0 0 GNU LESSER GENERAL PUBLIC LICENSE
Version 2.1, February 1999
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
[This is the first released version of the Lesser GPL. It also counts
as the successor of the GNU Library Public License, version 2, hence
the version number 2.1.]
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
free software--to make sure the software is free for all its users.
This license, the Lesser General Public License, applies to some
specially designated software packages--typically libraries--of the
Free Software Foundation and other authors who decide to use it. You
can use it too, but we suggest you first think carefully about whether
this license or the ordinary General Public License is the better
strategy to use in any particular case, based on the explanations below.
When we speak of free software, we are referring to freedom of use,
not price. Our General Public Licenses are designed to make sure that
you have the freedom to distribute copies of free software (and charge
for this service if you wish); that you receive source code or can get
it if you want it; that you can change the software and use pieces of
it in new free programs; and that you are informed that you can do
these things.
To protect your rights, we need to make restrictions that forbid
distributors to deny you these rights or to ask you to surrender these
rights. These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it.
For example, if you distribute copies of the library, whether gratis
or for a fee, you must give the recipients all the rights that we gave
you. You must make sure that they, too, receive or can get the source
code. If you link other code with the library, you must provide
complete object files to the recipients, so that they can relink them
with the library after making changes to the library and recompiling
it. And you must show them these terms so they know their rights.
We protect your rights with a two-step method: (1) we copyright the
library, and (2) we offer you this license, which gives you legal
permission to copy, distribute and/or modify the library.
To protect each distributor, we want to make it very clear that
there is no warranty for the free library. Also, if the library is
modified by someone else and passed on, the recipients should know
that what they have is not the original version, so that the original
author's reputation will not be affected by problems that might be
introduced by others.
Finally, software patents pose a constant threat to the existence of
any free program. We wish to make sure that a company cannot
effectively restrict the users of a free program by obtaining a
restrictive license from a patent holder. Therefore, we insist that
any patent license obtained for a version of the library must be
consistent with the full freedom of use specified in this license.
Most GNU software, including some libraries, is covered by the
ordinary GNU General Public License. This license, the GNU Lesser
General Public License, applies to certain designated libraries, and
is quite different from the ordinary General Public License. We use
this license for certain libraries in order to permit linking those
libraries into non-free programs.
When a program is linked with a library, whether statically or using
a shared library, the combination of the two is legally speaking a
combined work, a derivative of the original library. The ordinary
General Public License therefore permits such linking only if the
entire combination fits its criteria of freedom. The Lesser General
Public License permits more lax criteria for linking other code with
the library.
We call this license the "Lesser" General Public License because it
does Less to protect the user's freedom than the ordinary General
Public License. It also provides other free software developers Less
of an advantage over competing non-free programs. These disadvantages
are the reason we use the ordinary General Public License for many
libraries. However, the Lesser license provides advantages in certain
special circumstances.
For example, on rare occasions, there may be a special need to
encourage the widest possible use of a certain library, so that it becomes
a de-facto standard. To achieve this, non-free programs must be
allowed to use the library. A more frequent case is that a free
library does the same job as widely used non-free libraries. In this
case, there is little to gain by limiting the free library to free
software only, so we use the Lesser General Public License.
In other cases, permission to use a particular library in non-free
programs enables a greater number of people to use a large body of
free software. For example, permission to use the GNU C Library in
non-free programs enables many more people to use the whole GNU
operating system, as well as its variant, the GNU/Linux operating
system.
Although the Lesser General Public License is Less protective of the
users' freedom, it does ensure that the user of a program that is
linked with the Library has the freedom and the wherewithal to run
that program using a modified version of the Library.
The precise terms and conditions for copying, distribution and
modification follow. Pay close attention to the difference between a
"work based on the library" and a "work that uses the library". The
former contains code derived from the library, whereas the latter must
be combined with the library in order to run.
GNU LESSER GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any software library or other
program which contains a notice placed by the copyright holder or
other authorized party saying it may be distributed under the terms of
this Lesser General Public License (also called "this License").
Each licensee is addressed as "you".
A "library" means a collection of software functions and/or data
prepared so as to be conveniently linked with application programs
(which use some of those functions and data) to form executables.
The "Library", below, refers to any such software library or work
which has been distributed under these terms. A "work based on the
Library" means either the Library or any derivative work under
copyright law: that is to say, a work containing the Library or a
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language. (Hereinafter, translation is
included without limitation in the term "modification".)
"Source code" for a work means the preferred form of the work for
making modifications to it. For a library, complete source code means
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation
and installation of the library.
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does
and what the program that uses the Library does.
1. You may copy and distribute verbatim copies of the Library's
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an
appropriate copyright notice and disclaimer of warranty; keep intact
all the notices that refer to this License and to the absence of any
warranty; and distribute a copy of this License along with the
Library.
You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.
2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) The modified work must itself be a software library.
b) You must cause the files modified to carry prominent notices
stating that you changed the files and the date of any change.
c) You must cause the whole of the work to be licensed at no
charge to all third parties under the terms of this License.
d) If a facility in the modified Library refers to a function or a
table of data to be supplied by an application program that uses
the facility, other than as an argument passed when the facility
is invoked, then you must make a good faith effort to ensure that,
in the event an application does not supply such function or
table, the facility still operates, and performs whatever part of
its purpose remains meaningful.
(For example, a function in a library to compute square roots has
a purpose that is entirely well-defined independent of the
application. Therefore, Subsection 2d requires that any
application-supplied function or table used by this function must
be optional: if the application does not supply it, the square
root function must still compute square roots.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Library, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote
it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Library.
In addition, mere aggregation of another work not based on the Library
with the Library (or with a work based on the Library) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may opt to apply the terms of the ordinary GNU General Public
License instead of this License to a given copy of the Library. To do
this, you must alter all the notices that refer to this License, so
that they refer to the ordinary GNU General Public License, version 2,
instead of to this License. (If a newer version than version 2 of the
ordinary GNU General Public License has appeared, then you can specify
that version instead if you wish.) Do not make any other change in
these notices.
Once this change is made in a given copy, it is irreversible for
that copy, so the ordinary GNU General Public License applies to all
subsequent copies and derivative works made from that copy.
This option is useful when you wish to copy part of the code of
the Library into a program that is not a library.
4. You may copy and distribute the Library (or a portion or
derivative of it, under Section 2) in object code or executable form
under the terms of Sections 1 and 2 above provided that you accompany
it with the complete corresponding machine-readable source code, which
must be distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange.
If distribution of object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the
source code from the same place satisfies the requirement to
distribute the source code, even though third parties are not
compelled to copy the source along with the object code.
5. A program that contains no derivative of any portion of the
Library, but is designed to work with the Library by being compiled or
linked with it, is called a "work that uses the Library". Such a
work, in isolation, is not a derivative work of the Library, and
therefore falls outside the scope of this License.
However, linking a "work that uses the Library" with the Library
creates an executable that is a derivative of the Library (because it
contains portions of the Library), rather than a "work that uses the
library". The executable is therefore covered by this License.
Section 6 states terms for distribution of such executables.
When a "work that uses the Library" uses material from a header file
that is part of the Library, the object code for the work may be a
derivative work of the Library even though the source code is not.
Whether this is true is especially significant if the work can be
linked without the Library, or if the work is itself a library. The
threshold for this to be true is not precisely defined by law.
If such an object file uses only numerical parameters, data
structure layouts and accessors, and small macros and small inline
functions (ten lines or less in length), then the use of the object
file is unrestricted, regardless of whether it is legally a derivative
work. (Executables containing this object code plus portions of the
Library will still fall under Section 6.)
Otherwise, if the work is a derivative of the Library, you may
distribute the object code for the work under the terms of Section 6.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself.
6. As an exception to the Sections above, you may also combine or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse
engineering for debugging such modifications.
You must give prominent notice with each copy of the work that the
Library is used in it and that the Library and its use are covered by
this License. You must supply a copy of this License. If the work
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License. Also, you must do one
of these things:
a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever
changes were used in the work (which must be distributed under
Sections 1 and 2 above); and, if the work is an executable linked
with the Library, with the complete machine-readable "work that
uses the Library", as object code and/or source code, so that the
user can modify the Library and then relink to produce a modified
executable containing the modified Library. (It is understood
that the user who changes the contents of definitions files in the
Library will not necessarily be able to recompile the application
to use the modified definitions.)
b) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (1) uses at run time a
copy of the library already present on the user's computer system,
rather than copying library functions into the executable, and (2)
will operate properly with a modified version of the library, if
the user installs one, as long as the modified version is
interface-compatible with the version that the work was made with.
c) Accompany the work with a written offer, valid for at
least three years, to give the same user the materials
specified in Subsection 6a, above, for a charge no more
than the cost of performing this distribution.
d) If distribution of the work is made by offering access to copy
from a designated place, offer equivalent access to copy the above
specified materials from the same place.
e) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy.
For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it. However, as a special exception,
the materials to be distributed need not include anything that is
normally distributed (in either source or binary form) with the major
components (compiler, kernel, and so on) of the operating system on
which the executable runs, unless that component itself accompanies
the executable.
It may happen that this requirement contradicts the license
restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.
7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
library, provided that the separate distribution of the work based on
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:
a) Accompany the combined library with a copy of the same work
based on the Library, uncombined with any other library
facilities. This must be distributed under the terms of the
Sections above.
b) Give prominent notice with the combined library of the fact
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
8. You may not copy, modify, sublicense, link with, or distribute
the Library except as expressly provided under this License. Any
attempt otherwise to copy, modify, sublicense, link with, or
distribute the Library is void, and will automatically terminate your
rights under this License. However, parties who have received copies,
or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
9. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Library or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Library (or any work based on the
Library), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Library or works based on it.
10. Each time you redistribute the Library (or any work based on the
Library), the recipient automatically receives a license from the
original licensor to copy, distribute, link with or modify the Library
subject to these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties with
this License.
11. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Library at all. For example, if a patent
license would not permit royalty-free redistribution of the Library by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Library.
If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply,
and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
12. If the distribution and/or use of the Library is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Library under this License may add
an explicit geographical distribution limitation excluding those countries,
so that distribution is permitted only in or among countries not thus
excluded. In such case, this License incorporates the limitation as if
written in the body of this License.
13. The Free Software Foundation may publish revised and/or new
versions of the Lesser General Public License from time to time.
Such new versions will be similar in spirit to the present version,
but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Library
specifies a version number of this License which applies to it and
"any later version", you have the option of following the terms and
conditions either of that version or of any later version published by
the Free Software Foundation. If the Library does not specify a
license version number, you may choose any version ever published by
the Free Software Foundation.
14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these,
write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this. Our
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change. You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of the
ordinary General Public License).
To apply these terms, attach the following notices to the library. It is
safest to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
Copyright (C)
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
Also add information on how to contact you by electronic and paper mail.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the library, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!
checkstyle-5.6/LICENSE.apache20 100644 0 0 26450 11451071611 13264 0 ustar 0 0
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
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.
checkstyle-5.6/pom.xml 100644 0 0 45125 12026054767 12226 0 ustar 0 0
oss-parentorg.sonatype.oss54.0.0com.puppycrawl.toolscheckstyle5.6jarcheckstylehttp://checkstyle.sourceforge.net/SourceForgehttp://sourceforge.net/tracker/?group_id=29721hudsonhttp://hudson.fazend.com:8081/hudson/job/Checkstyle2001Checkstyle is a development tool to help programmers write Java code that adheres to a coding standardGNU Lesser General Public Licensehttp://www.gnu.org/licenses/old-licenses/lgpl-2.1.txtscm:hg:http://checkstyle.hg.sourceforge.net:8000/hgroot/checkstyle/checkstylescm:hg:ssh://oburn@checkstyle.hg.sourceforge.net/hgroot/checkstyle/checkstylehttp://checkstyle.hg.sourceforge.net/hgweb/checkstyle/checkstyle-snapshot-siteSnapshot Sitescp://shell.sourceforge.net/home/groups/c/ch/checkstyle/htdocs/snapshotoburnOliver BurnfounderlkuehneLars KĵhnedeveloperrickgilesRick Gilesdevelopero_sukhodolskyOleg SukhodolskydevelopermstudmanMichael StudmandevelopertschneebergerTravis Schneebergerdevelopercheckstyle-announcehttps://sourceforge.net/mailarchive/forum.php?forum_name=checkstyle-announcehttps://lists.sourceforge.net/mailman/listinfo/checkstyle-announcehttps://lists.sourceforge.net/mailman/listinfo/checkstyle-announcecheckstyle-commitshttps://sourceforge.net/mailarchive/forum.php?forum_name=checkstyle-commitshttps://lists.sourceforge.net/mailman/listinfo/checkstyle-commitshttps://lists.sourceforge.net/mailman/listinfo/checkstyle-commitscheckstyle-develhttps://sourceforge.net/mailarchive/forum.php?forum_name=checkstyle-develhttps://lists.sourceforge.net/mailman/listinfo/checkstyle-develhttps://lists.sourceforge.net/mailman/listinfo/checkstyle-develcheckstyle-userhttps://sourceforge.net/mailarchive/forum.php?forum_name=checkstyle-userhttps://lists.sourceforge.net/mailman/listinfo/checkstyle-userhttps://lists.sourceforge.net/mailman/listinfo/checkstyle-useriso-8859-1${basedir}/src/testinputs/com/puppycrawl/tools/checkstyle${basedir}/src/tests/com/puppycrawl/tools/checkstyle${project.version}1.5.0${java.home}/../lib/tools.jarantlrantlr2.7.7commons-beanutilscommons-beanutils-core1.8.3commons-clicommons-cli1.2com.google.collectionsgoogle-collections1.0org.apache.antant1.7.0providedjunitjunit4.10testsrc/checkstyle${basedir}/src/checkstyle**/*.dtd**/*.properties**/*.xmlsrc/testinputs/resourcessrc/testsorg.apache.maven.pluginsmaven-compiler-plugin2.3.21.51.5org.apache.maven.pluginsmaven-site-plugin3.0-beta-3${basedir}/src/xdocstrueorg.apache.maven.pluginsmaven-enforcer-plugin1.0.1enforce-versionsenforce1.5org.codehaus.mojoantlr-maven-plugin2.2${basedir}/src/checkstyle/com/puppycrawl/tools/checkstyle/grammarsjava.ggenerateorg.apache.maven.pluginsmaven-antrun-plugin1.7ant-phase-compilecompilerunant-phase-verifyverifyrunorg.apache.antant-nodeps1.7.1org.apache.maven.pluginsmaven-surefire-plugin2.9testinputs.dir${testinputs.dir}testsrcs.dir${testsrcs.dir}-Duser.language=en -Duser.country=USorg.codehaus.mojoexec-maven-plugin1.2runnerjavacom.puppycrawl.tools.checkstyle.gui.Mainruntimeorg.apache.maven.pluginsmaven-jar-plugin2.3.1truetrueorg.codehaus.mojocobertura-maven-plugin2.5.1com/puppycrawl/tools/checkstyle/CheckStyleTask*.classcom/puppycrawl/tools/checkstyle/doclets/*.classcom/puppycrawl/tools/checkstyle/grammars/*.classcom/puppycrawl/tools/checkstyle/gui/*.classorg.apache.maven.pluginsmaven-linkcheck-plugin1.1org.apache.maven.pluginsmaven-eclipse-plugin2.8truetrueorg.apache.maven.pluginsmaven-javadoc-plugin2.81.5defaultjavadocdistroorg.apache.maven.pluginsmaven-site-plugin3.0-beta-3gen-siteprepare-packagesiteorg.apache.maven.pluginsmaven-shade-plugin1.4packageshadetrueallcom.puppycrawl.tools.checkstyle.Mainmaven-assembly-plugin2.2.1config/assembly-bin.xmlconfig/assembly-src.xmlmake-bundlepackagesinglereleasecheckstyle-siteDefault Sitescp://shell.sourceforge.net/home/groups/c/ch/checkstyle/htdocsrelease-sign-artifactsperformReleasetrueorg.apache.maven.pluginsmaven-gpg-plugin1.4sign-artifactsverifysigntools.jar-sunjava.vendorSun Microsystems Inc.com.suntools${tools.jar.version}system${tools.jar.path}default-tools.jar-oraclejava.vendorOracle Corporationcom.suntools${tools.jar.version}system${tools.jar.path}
checkstyle-5.6/README 100644 0 0 2524 11451071611 11531 0 ustar 0 0 CHECKSTYLE
==========
This directory contains the distribution for checkstyle. It is a tool for
checking Java source code for adherence to a set of rules.
The latest version can be found at http://checkstyle.sourceforge.net
Documentation is available in HTML format, in the "site" directory.
Licensing
=========
This software is licensed under the terms in the file named "LICENSE" in this
directory.
The software uses the ANTLR package (http://www.antlr.org). Its license terms
are in the file named "RIGHTS.antlr" in this directory.
This product includes software developed by
The Apache Software Foundation (http://www.apache.org/).
The software uses the Cli, Logging and Beanutils packages from the
Apache Commons project (http://commons.apache.org/). The license terms
of these packages are in the file named "LICENSE.apache20" in this
directory.
The software uses the Google Collections Library
(http://code.google.com/p/google-collections/). The license terms of
these packages are in the file named "LICENSE.apache20" in this
directory.
Feedback
========
Please send any feedback to checkstyle-user@lists.sourceforge.net.
Bugs should be reported to the checkstyle bugtracker at
http://sourceforge.net/tracker/?atid=397078&group_id=29721&func=browse
Thanks for trying out checkstyle!
Oliver Burn
checkstyle-5.6/README-Eclipse.txt 100644 0 0 421 11451075477 13721 0 ustar 0 0 To run the JUnit tests in the Eclipse, you need to set the following VM arguments:
-Dtestinputs.dir=${project_loc}\src\testinputs\com\puppycrawl\tools\checkstyle
-Dtestsrcs.dir=${project_loc}\src\tests\com\puppycrawl\tools\checkstyle
-Dcheckstyle.root=${project_loc}
checkstyle-5.6/RIGHTS.antlr 100644 0 0 2355 11451071611 12715 0 ustar 0 0
SOFTWARE RIGHTS
$Id: RIGHTS.antlr,v 1.1 2001-06-22 13:11:01 oburn Exp $
ANTLR 1989-2000 Developed by jGuru.com (MageLang Institute),
http://www.ANTLR.org and http://www.jGuru.com
We reserve no legal rights to the ANTLR--it is fully in the
public domain. An individual or company may do whatever
they wish with source code distributed with ANTLR or the
code generated by ANTLR, including the incorporation of
ANTLR, or its output, into commerical software.
We encourage users to develop software with ANTLR. However,
we do ask that credit is given to us for developing
ANTLR. By "credit", we mean that if you use ANTLR or
incorporate any source code into one of your programs
(commercial product, research project, or otherwise) that
you acknowledge this fact somewhere in the documentation,
research report, etc... If you like ANTLR and have
developed a nice tool with the output, please mention that
you developed it using ANTLR. In addition, we ask that the
headers remain intact in our source code. As long as these
guidelines are kept, we expect to continue enhancing this
system and expect to make other tools available as they are
completed.
The primary ANTLR guy:
Terence Parr
http://www.jGuru.com
parrt@jguru.com
checkstyle-5.6/src/checkstyle/checkstyletask.properties 100644 0 0 73 11451071612 20673 0 ustar 0 0 checkstyle=com.puppycrawl.tools.checkstyle.CheckStyleTask
checkstyle-5.6/src/checkstyle/checkstyle_packages.xml 100644 0 0 1555 11451071612 20320 0 ustar 0 0
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/antlib.xml 100644 0 0 246 11451071612 24033 0 ustar 0 0
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/AbstractFileSetCheck.java 100644 0 0 15050 12026051074 27467 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import java.io.File;
import java.util.List;
import java.util.TreeSet;
/**
* Provides common functionality for many FileSetChecks.
*
* @author lkuehne
* @author oliver
*/
public abstract class AbstractFileSetCheck
extends AbstractViolationReporter
implements FileSetCheck
{
/** The dispatcher errors are fired to. */
private MessageDispatcher mDispatcher;
/** the file extensions that are accepted by this filter */
private String[] mFileExtensions = {};
/** collects the error messages */
private final LocalizedMessages mMessages = new LocalizedMessages();
/**
* Called to process a file that matches the specified file extensions.
* @param aFile the file to be processed
* @param aLines an immutable list of the contents of the file.
*/
protected abstract void processFiltered(File aFile, List aLines);
/** {@inheritDoc} */
public void init()
{
}
/** {@inheritDoc} */
public void destroy()
{
}
/** {@inheritDoc} */
public void beginProcessing(String aCharset)
{
}
/** {@inheritDoc} */
public final TreeSet process(File aFile,
List aLines)
{
getMessageCollector().reset();
// Process only what interested in
if (fileExtensionMatches(aFile)) {
processFiltered(aFile, aLines);
}
return getMessageCollector().getMessages();
}
/** {@inheritDoc} */
public void finishProcessing()
{
}
/** {@inheritDoc} */
public final void setMessageDispatcher(MessageDispatcher aDispatcher)
{
mDispatcher = aDispatcher;
}
/**
* A message dispatcher is used to fire violation messages to
* interested audit listeners.
*
* @return the current MessageDispatcher.
*/
protected final MessageDispatcher getMessageDispatcher()
{
return mDispatcher;
}
/**
* Sets the file extensions that identify the files that pass the
* filter of this FileSetCheck.
* @param aExtensions the set of file extensions. A missing
* initial '.' character of an extension is automatically added.
*/
public final void setFileExtensions(String[] aExtensions)
{
if (aExtensions == null) {
mFileExtensions = null;
return;
}
mFileExtensions = new String[aExtensions.length];
for (int i = 0; i < aExtensions.length; i++) {
final String extension = aExtensions[i];
if (extension.startsWith(".")) {
mFileExtensions[i] = extension;
}
else {
mFileExtensions[i] = "." + extension;
}
}
}
/**
* Returns the collector for violation messages.
* Subclasses can use the collector to find out the violation
* messages to fire via the message dispatcher.
*
* @return the collector for localized messages.
*/
protected final LocalizedMessages getMessageCollector()
{
return mMessages;
}
@Override
public final void log(int aLine, String aKey, Object... aArgs)
{
log(aLine, 0, aKey, aArgs);
}
@Override
public final void log(int aLineNo, int aColNo, String aKey,
Object... aArgs)
{
getMessageCollector().add(
new LocalizedMessage(aLineNo,
aColNo,
getMessageBundle(),
aKey,
aArgs,
getSeverityLevel(),
getId(),
this.getClass(),
this.getCustomMessages().get(aKey)));
}
/**
* Notify all listeners about the errors in a file.
* Calls MessageDispatcher.fireErrors() with
* all logged errors and than clears errors' list.
* @param aFileName the audited file
*/
protected final void fireErrors(String aFileName)
{
final TreeSet errors = getMessageCollector()
.getMessages();
getMessageCollector().reset();
getMessageDispatcher().fireErrors(aFileName, errors);
}
/**
* Returns whether the file extension matches what we are meant to
* process.
* @param aFile the file to be checked.
* @return whether there is a match.
*/
private boolean fileExtensionMatches(File aFile)
{
if ((null == mFileExtensions) || (mFileExtensions.length == 0)) {
return true;
}
// normalize extensions so all of them have a leading dot
final String[] withDotExtensions = new String[mFileExtensions.length];
for (int i = 0; i < mFileExtensions.length; i++) {
final String extension = mFileExtensions[i];
if (extension.startsWith(".")) {
withDotExtensions[i] = extension;
}
else {
withDotExtensions[i] = "." + extension;
}
}
final String fileName = aFile.getName();
for (final String fileExtension : withDotExtensions) {
if (fileName.endsWith(fileExtension)) {
return true;
}
}
return false;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/AbstractLoader.java 100644 0 0 12252 12026051074 26405 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import com.google.common.collect.Maps;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParserFactory;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
import org.xml.sax.XMLReader;
import org.xml.sax.helpers.DefaultHandler;
/**
* Contains the common implementation of a loader, for loading a configuration
* from an XML file.
*
* The error handling policy can be described as being austere, dead set,
* disciplinary, dour, draconian, exacting, firm, forbidding, grim, hard, hard-
* boiled, harsh, harsh, in line, iron-fisted, no-nonsense, oppressive,
* persnickety, picky, prudish, punctilious, puritanical, rigid, rigorous,
* scrupulous, set, severe, square, stern, stickler, straight, strait-laced,
* stringent, stuffy, stuffy, tough, unpermissive, unsparing and uptight.
*
* @author Oliver Burn
*/
public abstract class AbstractLoader
extends DefaultHandler
{
/** maps public id to resolve to esource name for the DTD */
private final Map mPublicIdToResourceNameMap;
/** parser to read XML files **/
private final XMLReader mParser;
/**
* Creates a new instance.
* @param aPublicId the public ID for the DTD to resolve
* @param aDtdResourceName the resource for the DTD
* @throws SAXException if an error occurs
* @throws ParserConfigurationException if an error occurs
*/
protected AbstractLoader(String aPublicId, String aDtdResourceName)
throws SAXException, ParserConfigurationException
{
this(new HashMap(1));
mPublicIdToResourceNameMap.put(aPublicId, aDtdResourceName);
}
/**
* Creates a new instance.
* @param aPublicIdToResourceNameMap maps public IDs to DTD resource names
* @throws SAXException if an error occurs
* @throws ParserConfigurationException if an error occurs
*/
protected AbstractLoader(Map aPublicIdToResourceNameMap)
throws SAXException, ParserConfigurationException
{
mPublicIdToResourceNameMap =
Maps.newHashMap(aPublicIdToResourceNameMap);
final SAXParserFactory factory = SAXParserFactory.newInstance();
factory.setValidating(true);
factory.setNamespaceAware(true);
mParser = factory.newSAXParser().getXMLReader();
mParser.setContentHandler(this);
mParser.setEntityResolver(this);
mParser.setErrorHandler(this);
}
/**
* Parses the specified input source.
* @param aInputSource the input source to parse.
* @throws IOException if an error occurs
* @throws SAXException in an error occurs
*/
public void parseInputSource(InputSource aInputSource)
throws IOException, SAXException
{
mParser.parse(aInputSource);
}
@Override
public InputSource resolveEntity(String aPublicId, String aSystemId)
throws SAXException, IOException
{
if (mPublicIdToResourceNameMap.keySet().contains(aPublicId)) {
final String dtdResourceName =
mPublicIdToResourceNameMap.get(aPublicId);
final ClassLoader loader =
this.getClass().getClassLoader();
final InputStream dtdIS =
loader.getResourceAsStream(dtdResourceName);
if (dtdIS == null) {
throw new SAXException(
"Unable to load internal dtd " + dtdResourceName);
}
return new InputSource(dtdIS);
}
return super.resolveEntity(aPublicId, aSystemId);
}
@Override
public void warning(SAXParseException aEx) throws SAXException
{
throw aEx;
}
@Override
public void error(SAXParseException aEx) throws SAXException
{
throw aEx;
}
@Override
public void fatalError(SAXParseException aEx) throws SAXException
{
throw aEx;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/AbstractViolationReporter.java 100644 0 0 13313 12026051073 30664 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import java.util.Map;
/**
* Serves as an abstract base class for all modules that report inspection
* findings. Such modules have a Severity level which is used for the
* {@link LocalizedMessage localized messages} that are created by the module.
*
* @author lkuehne
*/
public abstract class AbstractViolationReporter
extends AutomaticBean
{
/** the severity level of any violations found */
private SeverityLevel mSeverityLevel = SeverityLevel.ERROR;
/** the identifier of the reporter */
private String mId;
/**
* Returns the severity level of the messages generated by this module.
* @return the severity level
* @see SeverityLevel
* @see LocalizedMessage#getSeverityLevel
*/
public final SeverityLevel getSeverityLevel()
{
return mSeverityLevel;
}
/**
* Sets the severity level. The string should be one of the names
* defined in the SeverityLevel class.
*
* @param aSeverity The new severity level
* @see SeverityLevel
*/
public final void setSeverity(String aSeverity)
{
mSeverityLevel = SeverityLevel.getInstance(aSeverity);
}
/**
* Get the severity level's name.
*
* @return the check's severity level name.
*/
public final String getSeverity()
{
return mSeverityLevel.getName();
}
/**
* Returns the identifier of the reporter. Can be null.
* @return the id
*/
public final String getId()
{
return mId;
}
/**
* Sets the identifier of the reporter. Can be null.
* @param aId the id
*/
public final void setId(final String aId)
{
mId = aId;
}
/**
* Helper method to log a LocalizedMessage.
*
* @param aAST a node to get line and column numbers associated
* with the message
* @param aKey key to locale message format
* @param aArgs arguments to format
*/
protected final void log(DetailAST aAST, String aKey, Object... aArgs)
{
log(aAST.getLineNo(), aAST.getColumnNo(), aKey, aArgs);
}
/**
* Returns the message bundle name resourcebundle that contains the messages
* used by this module.
*
* The default implementation expects the resource files to be named
* messages.properties, messages_de.properties, etc. The file must
* be placed in the same package as the module implementation.
*
*
* Example: If you write com/foo/MyCoolCheck, create resource files
* com/foo/messages.properties, com/foo/messages_de.properties, etc.
*
*
* @return name of a resource bundle that contains the messages
* used by this module.
*/
protected String getMessageBundle()
{
final String className = this.getClass().getName();
return getMessageBundle(className);
}
/**
* Returns an unmodifiable map instance containing the custom messages
* for this configuration.
* @return unmodifiable map containing custom messages
*/
protected Map getCustomMessages()
{
return getConfiguration().getMessages();
}
/**
* for unit tests, especially with a class with no package name.
* @param aClassName class name of the module.
* @return name of a resource bundle that contains the messages
* used by the module.
*/
String getMessageBundle(final String aClassName)
{
final int endIndex = aClassName.lastIndexOf('.');
final String messages = "messages";
if (endIndex < 0) {
return messages;
}
final String packageName = aClassName.substring(0, endIndex);
return packageName + "." + messages;
}
/**
* Log a message that has no column information.
*
* @param aLine the line number where the error was found
* @param aKey the message that describes the error
* @param aArgs the details of the message
*
* @see java.text.MessageFormat
*/
public abstract void log(int aLine, String aKey, Object... aArgs);
/**
* Log a message that has column information.
*
* @param aLine the line number where the error was found
* @param aCol the column number where the error was found
* @param aKey the message that describes the error
* @param aArgs the details of the message
*
* @see java.text.MessageFormat
*/
public abstract void log(int aLine, int aCol, String aKey,
Object... aArgs);
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/AnnotationUtility.java 100644 0 0 16107 12026051073 27213 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
/**
* Contains utility methods designed to work with annotations.
*
* @author Travis Schneeberger
*/
public final class AnnotationUtility
{
/**
* private utility constructor.
* @throws UnsupportedOperationException if called
*/
private AnnotationUtility()
{
throw new UnsupportedOperationException("do not instantiate.");
}
/**
* Checks to see if the AST is annotated with
* the passed in annotation.
*
*
* This method will not look for imports or package
* statements to detect the passed in annotation.
*
*
*
* To check if an AST contains a passed in annotation
* taking into account fully-qualified names
* (ex: java.lang.Override, Override)
* this method will need to be called twice. Once for each
* name given.
*
*
* @param aAST the current node
* @param aAnnotation the annotation name to check for
* @return true if contains the annotation
* @throws NullPointerException if the aAST or
* aAnnotation is null
*/
public static boolean containsAnnotation(final DetailAST aAST,
String aAnnotation)
{
return AnnotationUtility.getAnnotation(aAST, aAnnotation) != null;
}
/**
* Checks to see if the AST is annotated with
* any annotation.
*
* @param aAST the current node
* @return true if contains an annotation
* @throws NullPointerException if the aAST is null
*/
public static boolean containsAnnotation(final DetailAST aAST)
{
final DetailAST holder = AnnotationUtility.getAnnotationHolder(aAST);
return holder != null && holder.branchContains(TokenTypes.ANNOTATION);
}
/**
* Gets the AST that holds a series of annotations for the
* potentially annotated AST. Returns null
* the passed in AST is not have an Annotation Holder.
*
* @param aAST the current node
* @return the Annotation Holder
* @throws NullPointerException if the aAST is null
*/
public static DetailAST getAnnotationHolder(DetailAST aAST)
{
if (aAST == null) {
throw new NullPointerException("the aAST is null");
}
final DetailAST annotationHolder;
if (aAST.getType() == TokenTypes.ENUM_CONSTANT_DEF
|| aAST.getType() == TokenTypes.PACKAGE_DEF)
{
annotationHolder = aAST.findFirstToken(TokenTypes.ANNOTATIONS);
}
else {
annotationHolder = aAST.findFirstToken(TokenTypes.MODIFIERS);
}
return annotationHolder;
}
/**
* Checks to see if the AST is annotated with
* the passed in annotation and return the AST
* representing that annotation.
*
*
* This method will not look for imports or package
* statements to detect the passed in annotation.
*
*
*
* To check if an AST contains a passed in annotation
* taking into account fully-qualified names
* (ex: java.lang.Override, Override)
* this method will need to be called twice. Once for each
* name given.
*
*
* @param aAST the current node
* @param aAnnotation the annotation name to check for
* @return the AST representing that annotation
* @throws NullPointerException if the aAST or
* aAnnotation is null
*/
public static DetailAST getAnnotation(final DetailAST aAST,
String aAnnotation)
{
if (aAST == null) {
throw new NullPointerException("the aAST is null");
}
if (aAnnotation == null) {
throw new NullPointerException("the aAnnotation is null");
}
if (aAnnotation.trim().length() == 0) {
throw new IllegalArgumentException("the aAnnotation"
+ "is empty or spaces");
}
final DetailAST holder = AnnotationUtility.getAnnotationHolder(aAST);
for (DetailAST child = holder.getFirstChild();
child != null; child = child.getNextSibling())
{
if (child.getType() == TokenTypes.ANNOTATION) {
final DetailAST at = child.getFirstChild();
final String aName =
FullIdent.createFullIdent(at.getNextSibling()).getText();
if (aAnnotation.equals(aName)) {
return child;
}
}
}
return null;
}
/**
* Checks to see what the passed in AST (representing
* an annotation) is annotating.
*
* @param aAST the AST representing an annotation.
* @return the AST the annotation is annotating.
* @throws NullPointerException if the aAST is null
* @throws IllegalArgumentException if the aAST is not
* an {@link TokenTypes#ANNOTATION}
*/
public static DetailAST annotatingWhat(DetailAST aAST)
{
if (aAST == null) {
throw new NullPointerException("the aAST is null");
}
if (aAST.getType() != TokenTypes.ANNOTATION) {
throw new IllegalArgumentException(
"The aAST is not an annotation. AST: " + aAST);
}
return aAST.getParent().getParent();
}
/**
* Checks to see if the passed in AST (representing
* an annotation) is annotating the passed in type.
* @param aAST the AST representing an annotation
* @param aTokenType the passed in type
* @return true if the annotation is annotating a type
* equal to the passed in type
* @throws NullPointerException if the aAST is null
* @throws IllegalArgumentException if the aAST is not
* an {@link TokenTypes#ANNOTATION}
*/
public static boolean isAnnotatingType(DetailAST aAST, int aTokenType)
{
final DetailAST ast = AnnotationUtility.annotatingWhat(aAST);
return ast.getType() == aTokenType;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/AuditEvent.java 100644 0 0 10707 12026051073 25565 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import java.util.EventObject;
/**
* Raw event for audit.
*
*
* I'm not very satisfied about the design of this event since there are
* optional methods that will return null in most of the case. This will
* need some work to clean it up especially if we want to introduce
* a more sequential reporting action rather than a packet error
* reporting. This will allow for example to follow the process quickly
* in an interface or a servlet (yep, that's cool to run a check via
* a web interface in a source repository ;-)
*
* @author Stephane Bailliez
* @see AuditListener
*/
public final class AuditEvent
extends EventObject
{
/** Record a version. */
private static final long serialVersionUID = -3774725606973812736L;
/** filename event associated with **/
private final String mFileName;
/** message associated with the event **/
private final transient LocalizedMessage mMessage;
/**
* Creates a new instance.
* @param aSource the object that created the event
*/
public AuditEvent(Object aSource)
{
this(aSource, null);
}
/**
* Creates a new AuditEvent instance.
* @param aSrc source of the event
* @param aFileName file associated with the event
*/
public AuditEvent(Object aSrc, String aFileName)
{
this(aSrc, aFileName, null);
}
/**
* Creates a new AuditEvent instance.
*
* @param aSrc source of the event
* @param aFileName file associated with the event
* @param aMessage the actual message
*/
public AuditEvent(Object aSrc, String aFileName, LocalizedMessage aMessage)
{
super(aSrc);
mFileName = aFileName;
mMessage = aMessage;
}
/**
* @return the file name currently being audited or null if there is
* no relation to a file.
*/
public String getFileName()
{
return mFileName;
}
/**
* return the line number on the source file where the event occurred.
* This may be 0 if there is no relation to a file content.
* @return an integer representing the line number in the file source code.
*/
public int getLine()
{
return mMessage.getLineNo();
}
/**
* return the message associated to the event.
* @return the event message
*/
public String getMessage()
{
return mMessage.getMessage();
}
/** @return the column associated with the message **/
public int getColumn()
{
return mMessage.getColumnNo();
}
/** @return the audit event severity level **/
public SeverityLevel getSeverityLevel()
{
return (mMessage == null)
? SeverityLevel.INFO
: mMessage.getSeverityLevel();
}
/**
* @return the identifier of the module that generated the event. Can return
* null.
*/
public String getModuleId()
{
return mMessage.getModuleId();
}
/** @return the name of the source for the message **/
public String getSourceName()
{
return mMessage.getSourceName();
}
/** @return the localized message **/
public LocalizedMessage getLocalizedMessage()
{
return mMessage;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/AuditListener.java 100644 0 0 4674 12026051073 26257 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import java.util.EventListener;
/**
* Listener in charge of receiving events from the Checker.
* Typical events sequence is:
*
* @author Stephane Bailliez
*/
public interface AuditListener
extends EventListener
{
/**
* Notify that the audit is about to start.
* @param aEvt the event details
*/
void auditStarted(AuditEvent aEvt);
/**
* Notify that the audit is finished.
* @param aEvt the event details
*/
void auditFinished(AuditEvent aEvt);
/**
* Notify that audit is about to start on a specific file.
* @param aEvt the event details
*/
void fileStarted(AuditEvent aEvt);
/**
* Notify that audit is finished on a specific file.
* @param aEvt the event details
*/
void fileFinished(AuditEvent aEvt);
/**
* Notify that an audit error was discovered on a specific file.
* @param aEvt the event details
*/
void addError(AuditEvent aEvt);
/**
* Notify that an exception happened while performing audit.
* @param aEvt the event details
* @param aThrowable details of the exception
*/
void addException(AuditEvent aEvt, Throwable aThrowable);
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/AutomaticBean.java 100644 0 0 30416 12026051073 26230 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import com.google.common.collect.Lists;
import java.beans.PropertyDescriptor;
import java.lang.reflect.InvocationTargetException;
import java.util.Collection;
import java.util.List;
import java.util.StringTokenizer;
import org.apache.commons.beanutils.BeanUtilsBean;
import org.apache.commons.beanutils.ConversionException;
import org.apache.commons.beanutils.ConvertUtilsBean;
import org.apache.commons.beanutils.Converter;
import org.apache.commons.beanutils.PropertyUtils;
import org.apache.commons.beanutils.PropertyUtilsBean;
import org.apache.commons.beanutils.converters.ArrayConverter;
import org.apache.commons.beanutils.converters.BooleanConverter;
import org.apache.commons.beanutils.converters.ByteConverter;
import org.apache.commons.beanutils.converters.CharacterConverter;
import org.apache.commons.beanutils.converters.DoubleConverter;
import org.apache.commons.beanutils.converters.FloatConverter;
import org.apache.commons.beanutils.converters.IntegerConverter;
import org.apache.commons.beanutils.converters.LongConverter;
import org.apache.commons.beanutils.converters.ShortConverter;
/**
* A Java Bean that implements the component lifecycle interfaces by
* calling the bean's setters for all configuration attributes.
* @author lkuehne
*/
public class AutomaticBean
implements Configurable, Contextualizable
{
/** the configuration of this bean */
private Configuration mConfiguration;
/**
* Creates a BeanUtilsBean that is configured to use
* type converters that throw a ConversionException
* instead of using the default value when something
* goes wrong.
*
* @return a configured BeanUtilsBean
*/
private static BeanUtilsBean createBeanUtilsBean()
{
final ConvertUtilsBean cub = new ConvertUtilsBean();
// TODO: is there a smarter way to tell beanutils not to use defaults?
cub.register(new BooleanConverter(), Boolean.TYPE);
cub.register(new BooleanConverter(), Boolean.class);
cub.register(new ArrayConverter(
boolean[].class, new BooleanConverter()), boolean[].class);
cub.register(new ByteConverter(), Byte.TYPE);
cub.register(new ByteConverter(), Byte.class);
cub.register(new ArrayConverter(byte[].class, new ByteConverter()),
byte[].class);
cub.register(new CharacterConverter(), Character.TYPE);
cub.register(new CharacterConverter(), Character.class);
cub.register(new ArrayConverter(char[].class, new CharacterConverter()),
char[].class);
cub.register(new DoubleConverter(), Double.TYPE);
cub.register(new DoubleConverter(), Double.class);
cub.register(new ArrayConverter(double[].class, new DoubleConverter()),
double[].class);
cub.register(new FloatConverter(), Float.TYPE);
cub.register(new FloatConverter(), Float.class);
cub.register(new ArrayConverter(float[].class, new FloatConverter()),
float[].class);
cub.register(new IntegerConverter(), Integer.TYPE);
cub.register(new IntegerConverter(), Integer.class);
cub.register(new ArrayConverter(int[].class, new IntegerConverter()),
int[].class);
cub.register(new LongConverter(), Long.TYPE);
cub.register(new LongConverter(), Long.class);
cub.register(new ArrayConverter(long[].class, new LongConverter()),
long[].class);
cub.register(new ShortConverter(), Short.TYPE);
cub.register(new ShortConverter(), Short.class);
cub.register(new ArrayConverter(short[].class, new ShortConverter()),
short[].class);
cub.register(new RelaxedStringArrayConverter(), String[].class);
// BigDecimal, BigInteger, Class, Date, String, Time, TimeStamp
// do not use defaults in the default configuration of ConvertUtilsBean
return new BeanUtilsBean(cub, new PropertyUtilsBean());
}
/**
* Implements the Configurable interface using bean introspection.
*
* Subclasses are allowed to add behaviour. After the bean
* based setup has completed first the method
* {@link #finishLocalSetup finishLocalSetup}
* is called to allow completion of the bean's local setup,
* after that the method {@link #setupChild setupChild}
* is called for each {@link Configuration#getChildren child Configuration}
* of aConfiguration.
*
* @param aConfiguration {@inheritDoc}
* @throws CheckstyleException {@inheritDoc}
* @see Configurable
*/
public final void configure(Configuration aConfiguration)
throws CheckstyleException
{
mConfiguration = aConfiguration;
final BeanUtilsBean beanUtils = createBeanUtilsBean();
// TODO: debug log messages
final String[] attributes = aConfiguration.getAttributeNames();
for (final String key : attributes) {
final String value = aConfiguration.getAttribute(key);
try {
// BeanUtilsBean.copyProperties silently ignores missing setters
// for key, so we have to go through great lengths here to
// figure out if the bean property really exists.
final PropertyDescriptor pd =
PropertyUtils.getPropertyDescriptor(this, key);
if ((pd == null) || (pd.getWriteMethod() == null)) {
throw new CheckstyleException(
"Property '" + key + "' in module "
+ aConfiguration.getName()
+ " does not exist, please check the documentation");
}
// finally we can set the bean property
beanUtils.copyProperty(this, key, value);
}
catch (final InvocationTargetException e) {
throw new CheckstyleException(
"Cannot set property '" + key + "' in module "
+ aConfiguration.getName() + " to '" + value
+ "': " + e.getTargetException().getMessage(), e);
}
catch (final IllegalAccessException e) {
throw new CheckstyleException(
"cannot access " + key + " in "
+ this.getClass().getName(), e);
}
catch (final NoSuchMethodException e) {
throw new CheckstyleException(
"cannot access " + key + " in "
+ this.getClass().getName(), e);
}
catch (final IllegalArgumentException e) {
throw new CheckstyleException(
"illegal value '" + value + "' for property '" + key
+ "' of module " + aConfiguration.getName(), e);
}
catch (final ConversionException e) {
throw new CheckstyleException(
"illegal value '" + value + "' for property '" + key
+ "' of module " + aConfiguration.getName(), e);
}
}
finishLocalSetup();
final Configuration[] childConfigs = aConfiguration.getChildren();
for (final Configuration childConfig : childConfigs) {
setupChild(childConfig);
}
}
/**
* Implements the Contextualizable interface using bean introspection.
* @param aContext {@inheritDoc}
* @throws CheckstyleException {@inheritDoc}
* @see Contextualizable
*/
public final void contextualize(Context aContext)
throws CheckstyleException
{
final BeanUtilsBean beanUtils = createBeanUtilsBean();
// TODO: debug log messages
final Collection attributes = aContext.getAttributeNames();
for (final String key : attributes) {
final Object value = aContext.get(key);
try {
beanUtils.copyProperty(this, key, value);
}
catch (final InvocationTargetException e) {
// TODO: log.debug("The bean " + this.getClass()
// + " is not interested in " + value)
throw new CheckstyleException("cannot set property "
+ key + " to value " + value + " in bean "
+ this.getClass().getName(), e);
}
catch (final IllegalAccessException e) {
throw new CheckstyleException(
"cannot access " + key + " in "
+ this.getClass().getName(), e);
}
catch (final IllegalArgumentException e) {
throw new CheckstyleException(
"illegal value '" + value + "' for property '" + key
+ "' of bean " + this.getClass().getName(), e);
}
catch (final ConversionException e) {
throw new CheckstyleException(
"illegal value '" + value + "' for property '" + key
+ "' of bean " + this.getClass().getName(), e);
}
}
}
/**
* Returns the configuration that was used to configure this component.
* @return the configuration that was used to configure this component.
*/
protected final Configuration getConfiguration()
{
return mConfiguration;
}
/**
* Provides a hook to finish the part of this component's setup that
* was not handled by the bean introspection.
*
* The default implementation does nothing.
*
* @throws CheckstyleException if there is a configuration error.
*/
protected void finishLocalSetup() throws CheckstyleException
{
}
/**
* Called by configure() for every child of this component's Configuration.
*
* The default implementation does nothing.
*
* @param aChildConf a child of this component's Configuration
* @throws CheckstyleException if there is a configuration error.
* @see Configuration#getChildren
*/
protected void setupChild(Configuration aChildConf)
throws CheckstyleException
{
}
/**
* A converter that does not care whether the array elements contain String
* characters like '*' or '_'. The normal ArrayConverter class has problems
* with this characters.
*/
private static class RelaxedStringArrayConverter implements Converter
{
/** {@inheritDoc} */
public Object convert(@SuppressWarnings("rawtypes") Class aType,
Object aValue)
{
if (null == aType) {
throw new ConversionException("Cannot convert from null.");
}
// Convert to a String and trim it for the tokenizer.
final StringTokenizer st = new StringTokenizer(
aValue.toString().trim(), ",");
final List result = Lists.newArrayList();
while (st.hasMoreTokens()) {
final String token = st.nextToken();
result.add(token.trim());
}
return result.toArray(new String[result.size()]);
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/Check.java 100644 0 0 16511 12026051072 24530 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import com.google.common.collect.Sets;
import java.util.Set;
/**
* The base class for checks.
*
* @author Oliver Burn
* @version 1.0
* @see Writing
* your own checks
*/
public abstract class Check extends AbstractViolationReporter
{
/** default tab width for column reporting */
private static final int DEFAULT_TAB_WIDTH = 8;
/** the current file contents */
private FileContents mFileContents;
/** the tokens the check is interested in */
private final Set mTokens = Sets.newHashSet();
/** the object for collecting messages. */
private LocalizedMessages mMessages;
/** the tab width for column reporting */
private int mTabWidth = DEFAULT_TAB_WIDTH; // meaningful default
/**
* The class loader to load external classes. Not initialised as this must
* be set by my creator.
*/
private ClassLoader mLoader;
/**
* Returns the default token a check is interested in. Only used if the
* configuration for a check does not define the tokens.
* @return the default tokens
* @see TokenTypes
*/
public abstract int[] getDefaultTokens();
/**
* The configurable token set.
* Used to protect Checks against malicious users who specify an
* unacceptable token set in the configuration file.
* The default implementation returns the check's default tokens.
* @return the token set this check is designed for.
* @see TokenTypes
*/
public int[] getAcceptableTokens()
{
final int[] defaultTokens = getDefaultTokens();
final int[] copy = new int[defaultTokens.length];
System.arraycopy(defaultTokens, 0, copy, 0, defaultTokens.length);
return copy;
}
/**
* The tokens that this check must be registered for.
* @return the token set this must be registered for.
* @see TokenTypes
*/
public int[] getRequiredTokens()
{
return new int[] {};
}
/**
* Adds a set of tokens the check is interested in.
* @param aStrRep the string representation of the tokens interested in
*/
public final void setTokens(String[] aStrRep)
{
for (final String s : aStrRep) {
mTokens.add(s);
}
}
/**
* Returns the tokens registered for the check.
* @return the set of token names
*/
public final Set getTokenNames()
{
return mTokens;
}
/**
* Set the global object used to collect messages.
* @param aMessages the messages to log with
*/
public final void setMessages(LocalizedMessages aMessages)
{
mMessages = aMessages;
}
/**
* Initialise the check. This is the time to verify that the check has
* everything required to perform it job.
*/
public void init()
{
}
/**
* Destroy the check. It is being retired from service.
*/
public void destroy()
{
}
/**
* Called before the starting to process a tree. Ideal place to initialise
* information that is to be collected whilst processing a tree.
* @param aRootAST the root of the tree
*/
public void beginTree(DetailAST aRootAST)
{
}
/**
* Called after finished processing a tree. Ideal place to report on
* information collected whilst processing a tree.
* @param aRootAST the root of the tree
*/
public void finishTree(DetailAST aRootAST)
{
}
/**
* Called to process a token.
* @param aAST the token to process
*/
public void visitToken(DetailAST aAST)
{
}
/**
* Called after all the child nodes have been process.
* @param aAST the token leaving
*/
public void leaveToken(DetailAST aAST)
{
}
/**
* Returns the lines associated with the tree.
* @return the file contents
*/
public final String[] getLines()
{
return getFileContents().getLines();
}
/**
* Set the file contents associated with the tree.
* @param aContents the manager
*/
public final void setFileContents(FileContents aContents)
{
mFileContents = aContents;
}
/**
* Returns the file contents associated with the tree.
* @return the file contents
*/
public final FileContents getFileContents()
{
return mFileContents;
}
/**
* Set the class loader associated with the tree.
* @param aLoader the class loader
*/
public final void setClassLoader(ClassLoader aLoader)
{
mLoader = aLoader;
}
/**
* Returns the class loader associated with the tree.
* @return the class loader
*/
public final ClassLoader getClassLoader()
{
return mLoader;
}
/** @return the tab width to report errors with */
protected final int getTabWidth()
{
return mTabWidth;
}
/**
* Set the tab width to report errors with.
* @param aTabWidth an int value
*/
public final void setTabWidth(int aTabWidth)
{
mTabWidth = aTabWidth;
}
@Override
public final void log(int aLine, String aKey, Object... aArgs)
{
mMessages.add(
new LocalizedMessage(
aLine,
getMessageBundle(),
aKey,
aArgs,
getSeverityLevel(),
getId(),
this.getClass(),
this.getCustomMessages().get(aKey)));
}
@Override
public final void log(int aLineNo, int aColNo, String aKey,
Object... aArgs)
{
final int col = 1 + Utils.lengthExpandedTabs(
getLines()[aLineNo - 1], aColNo, getTabWidth());
mMessages.add(
new LocalizedMessage(
aLineNo,
col,
getMessageBundle(),
aKey,
aArgs,
getSeverityLevel(),
getId(),
this.getClass(),
this.getCustomMessages().get(aKey)));
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/CheckstyleException.java 100644 0 0 3710 12026051072 27445 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
/**
* Represents an error condition within Checkstyle.
*
* @author Oliver Burn
* @version 1.0
*/
public class CheckstyleException extends Exception
{
/** For Serialisation that will never happen. */
private static final long serialVersionUID = -3517342299748221108L;
/**
* Creates a new CheckstyleException instance.
*
* @param aMessage a String value
*/
public CheckstyleException(String aMessage)
{
super(aMessage);
}
/**
* Creates a new CheckstyleException instance
* that was caused by another exception.
*
* @param aMessage a message that explains this exception
* @param aCause the Exception that is wrapped by this exception
*/
public CheckstyleException(String aMessage, Throwable aCause)
{
super(aMessage, aCause);
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/Comment.java 100644 0 0 7110 12026051072 25070 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
/**
* Representation of the comment block.
*
* @author o_sukhodolsky
*/
public class Comment implements TextBlock
{
/** text of the comment. */
private final String[] mText;
/** number of first line of the comment. */
private final int mFirstLine;
/** number of last line of the comment. */
private final int mLastLine;
/** number of first column of the comment. */
private final int mFirstCol;
/** number of last column of the comment. */
private final int mLastCol;
/**
* Creates new instance.
* @param aText the lines that make up the comment.
* @param aFirstCol number of the first column of the comment.
* @param aLastLine number of the last line of the comment.
* @param aLastCol number of the last column of the comment.
*/
public Comment(final String[] aText, final int aFirstCol,
final int aLastLine, final int aLastCol)
{
mText = new String[aText.length];
System.arraycopy(aText, 0, mText, 0, mText.length);
mFirstLine = aLastLine - mText.length + 1;
mLastLine = aLastLine;
mFirstCol = aFirstCol;
mLastCol = aLastCol;
}
/** {@inheritDoc} */
public final String[] getText()
{
return mText.clone();
}
/** {@inheritDoc} */
public final int getStartLineNo()
{
return mFirstLine;
}
/** {@inheritDoc} */
public final int getEndLineNo()
{
return mLastLine;
}
/** {@inheritDoc} */
public int getStartColNo()
{
return mFirstCol;
}
/** {@inheritDoc} */
public int getEndColNo()
{
return mLastCol;
}
/** {@inheritDoc} */
public boolean intersects(int aStartLineNo, int aStartColNo,
int aEndLineNo, int aEndColNo)
{
// compute a single number for start and end
// to simpify conditional logic
final long multiplier = Integer.MAX_VALUE;
final long thisStart = mFirstLine * multiplier + mFirstCol;
final long thisEnd = mLastLine * multiplier + mLastCol;
final long inStart = aStartLineNo * multiplier + aStartColNo;
final long inEnd = aEndLineNo * multiplier + aEndColNo;
return !((thisEnd < inStart) || (inEnd < thisStart));
}
@Override
public String toString()
{
return "Comment[" + mFirstLine + ":" + mFirstCol + "-"
+ mLastLine + ":" + mLastCol + "]";
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/Configurable.java 100644 0 0 3105 12026051072 26066 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
/**
* A component that can be configured. The general idea of
* Configuration/Configurable was taken from Jakarta's Avalon framework.
* @author lkuehne
*/
public interface Configurable
{
/**
* Configures this component.
* @param aConfiguration the configuration to use.
* @throws CheckstyleException if there is a configuration error.
*/
void configure(Configuration aConfiguration) throws CheckstyleException;
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/Configuration.java 100644 0 0 4634 12026051071 26304 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import com.google.common.collect.ImmutableMap;
import java.io.Serializable;
/**
* A Configuration is used to configure a Configurable component. The general
* idea of Configuration/Configurable was taken from Jakarta's Avalon framework.
* @author lkuehne
*/
public interface Configuration extends Serializable
{
/**
* The set of attribute names.
* @return The set of attribute names, never null.
*/
String[] getAttributeNames();
/**
* The attribute value for an attribute name.
* @param aName the attribute name
* @return the value that is associated with aName
* @throws CheckstyleException if aName is not a valid attribute name
*/
String getAttribute(String aName) throws CheckstyleException;
/**
* The set of child configurations.
* @return The set of child configurations, never null.
*/
Configuration[] getChildren();
/**
* The name of this configuration.
* @return The name of this configuration.
*/
String getName();
/**
* Returns an unmodifiable map instance containing the custom messages
* for this configuration.
* @return unmodifiable map containing custom messages
*/
ImmutableMap getMessages();
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/Context.java 100644 0 0 3521 12026051071 25113 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import com.google.common.collect.ImmutableCollection;
/**
* A context to be used in subcomponents. The general idea of
* Context/Contextualizable was taken from Jakarta's Avalon framework.
* @author lkuehne
* @see Contextualizable
*/
public interface Context
{
/**
* Searches for the value with the specified attribute key in this context.
* @param aKey the attribute key.
* @return the value in this context with the specified attribute key value.
*/
Object get(String aKey);
/**
* Returns the names of all atttributes of this context.
* @return the names of all atttributes of this context.
*/
ImmutableCollection getAttributeNames();
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/Contextualizable.java 100644 0 0 3353 12026051071 27007 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
/**
* A Component that needs context information from it's container to work.
* The container will create a Context object and pass it to this
* Contextualizable. Contextualization will occur before configuration. The
* general idea of Context/Contextualizable was taken from Jakarta's Avalon framework.
* @author lkuehne
*/
public interface Contextualizable
{
/**
* Sets the context for this Component.
* @param aContext the context.
* @throws CheckstyleException if there is a contextualization error.
*/
void contextualize(Context aContext) throws CheckstyleException;
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/DetailAST.java 100644 0 0 22135 12026051071 25263 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import java.util.BitSet;
import antlr.CommonAST;
import antlr.Token;
import antlr.collections.AST;
/**
* An extension of the CommonAST that records the line and column
* number. The idea was taken from Java Guru
* FAQ: How can I include line numbers in automatically generated
* ASTs?.
* @author Oliver Burn
* @author lkuehne
* @version 1.0
* @see ANTLR Website
*/
public final class DetailAST extends CommonAST
{
/** For Serialisation that will never happen. */
private static final long serialVersionUID = -2580884815577559874L;
/** constant to indicate if not calculated the child count */
private static final int NOT_INITIALIZED = Integer.MIN_VALUE;
/** the line number **/
private int mLineNo = NOT_INITIALIZED;
/** the column number **/
private int mColumnNo = NOT_INITIALIZED;
/** number of children */
private int mChildCount = NOT_INITIALIZED;
/** the parent token */
private DetailAST mParent;
/** previous sibling */
private DetailAST mPreviousSibling;
/**
* All token types in this branch.
* Token 'x' (where x is an int) is in this branch
* if mBranchTokenTypes.get(x) is true.
*/
private BitSet mBranchTokenTypes;
@Override
public void initialize(Token aTok)
{
super.initialize(aTok);
mLineNo = aTok.getLine();
mColumnNo = aTok.getColumn() - 1; // expect columns to start @ 0
}
@Override
public void initialize(AST aAST)
{
final DetailAST da = (DetailAST) aAST;
setText(da.getText());
setType(da.getType());
mLineNo = da.getLineNo();
mColumnNo = da.getColumnNo();
}
@Override
public void setFirstChild(AST aAST)
{
mChildCount = NOT_INITIALIZED;
super.setFirstChild(aAST);
if (aAST != null) {
((DetailAST) aAST).setParent(this);
}
}
@Override
public void setNextSibling(AST aAST)
{
super.setNextSibling(aAST);
if ((aAST != null) && (mParent != null)) {
((DetailAST) aAST).setParent(mParent);
}
if (aAST != null) {
((DetailAST) aAST).setPreviousSibling(this);
}
}
/**
* Sets previous sibling.
* @param aAST a previous sibling
*/
void setPreviousSibling(DetailAST aAST)
{
mPreviousSibling = aAST;
}
@Override
public void addChild(AST aAST)
{
super.addChild(aAST);
if (aAST != null) {
((DetailAST) aAST).setParent(this);
(getFirstChild()).setParent(this);
}
}
/**
* Returns the number of child nodes one level below this node. That is is
* does not recurse down the tree.
* @return the number of child nodes
*/
public int getChildCount()
{
// lazy init
if (mChildCount == NOT_INITIALIZED) {
mChildCount = 0;
AST child = getFirstChild();
while (child != null) {
mChildCount += 1;
child = child.getNextSibling();
}
}
return mChildCount;
}
/**
* Set the parent token.
* @param aParent the parent token
*/
// TODO: should be private but that breaks the DetailASTTest
// until we manage parent in DetailAST instead of externally
void setParent(DetailAST aParent)
{
// TODO: Check visibility, could be private
// if set in setFirstChild() and friends
mParent = aParent;
final DetailAST nextSibling = getNextSibling();
if (nextSibling != null) {
nextSibling.setParent(aParent);
nextSibling.setPreviousSibling(this);
}
}
/**
* Returns the parent token.
* @return the parent token
*/
public DetailAST getParent()
{
return mParent;
}
/** @return the line number **/
public int getLineNo()
{
if (mLineNo == NOT_INITIALIZED) {
// an inner AST that has been initialized
// with initialize(String text)
final DetailAST child = getFirstChild();
final DetailAST sibling = getNextSibling();
if (child != null) {
return child.getLineNo();
}
else if (sibling != null) {
return sibling.getLineNo();
}
}
return mLineNo;
}
/** @return the column number **/
public int getColumnNo()
{
if (mColumnNo == NOT_INITIALIZED) {
// an inner AST that has been initialized
// with initialize(String text)
final DetailAST child = getFirstChild();
final DetailAST sibling = getNextSibling();
if (child != null) {
return child.getColumnNo();
}
else if (sibling != null) {
return sibling.getColumnNo();
}
}
return mColumnNo;
}
/** @return the last child node */
public DetailAST getLastChild()
{
DetailAST ast = getFirstChild();
while ((ast != null) && (ast.getNextSibling() != null)) {
ast = ast.getNextSibling();
}
return ast;
}
/**
* @return the token types that occur in the branch as a sorted set.
*/
private BitSet getBranchTokenTypes()
{
// lazy init
if (mBranchTokenTypes == null) {
mBranchTokenTypes = new BitSet();
mBranchTokenTypes.set(getType());
// add union of all childs
DetailAST child = getFirstChild();
while (child != null) {
final BitSet childTypes = child.getBranchTokenTypes();
mBranchTokenTypes.or(childTypes);
child = child.getNextSibling();
}
}
return mBranchTokenTypes;
}
/**
* Checks if this branch of the parse tree contains a token
* of the provided type.
* @param aType a TokenType
* @return true if and only if this branch (including this node)
* contains a token of type aType.
*/
public boolean branchContains(int aType)
{
return getBranchTokenTypes().get(aType);
}
/**
* Returns the number of direct child tokens that have the specified type.
* @param aType the token type to match
* @return the number of matching token
*/
public int getChildCount(int aType)
{
int count = 0;
for (AST i = getFirstChild(); i != null; i = i.getNextSibling()) {
if (i.getType() == aType) {
count++;
}
}
return count;
}
/**
* Returns the previous sibling or null if no such sibling exists.
* @return the previous sibling or null if no such sibling exists.
*/
public DetailAST getPreviousSibling()
{
return mPreviousSibling;
}
/**
* Returns the first child token that makes a specified type.
* @param aType the token type to match
* @return the matching token, or null if no match
*/
public DetailAST findFirstToken(int aType)
{
DetailAST retVal = null;
for (DetailAST i = getFirstChild(); i != null; i = i.getNextSibling()) {
if (i.getType() == aType) {
retVal = i;
break;
}
}
return retVal;
}
@Override
public String toString()
{
return super.toString() + "[" + getLineNo() + "x" + getColumnNo() + "]";
}
@Override
public DetailAST getNextSibling()
{
return (DetailAST) super.getNextSibling();
}
@Override
public DetailAST getFirstChild()
{
return (DetailAST) super.getFirstChild();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/FastStack.java 100644 0 0 10251 12026051071 25370 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import com.google.common.collect.Lists;
import java.util.Iterator;
import java.util.List;
/**
* Simple implementation of a LIFO Stack that can be used instead of
* {@link java.util.Vector} which is synchronized.
* @author oliverb
* @param The type to hold.
*/
public class FastStack implements Iterable
{
/** Hold the entries in the stack. */
private final List mEntries = Lists.newArrayList();
/**
* Pushes the supplied element onto the stack.
* @param aElement the element to push onto the stack.
*/
public void push(E aElement)
{
mEntries.add(aElement);
}
/**
* Returns whether the stack is empty.
* @return whether the stack is empty.
*/
public boolean isEmpty()
{
return mEntries.isEmpty();
}
/**
* Returns the number of entries in the stack.
* @return the number of entries in the stack.
*/
public int size()
{
return mEntries.size();
}
/**
* Returns the entry at the top of the stack without removing it.
* @return the top entry
* @throws IllegalStateException if the stack is empty.
*/
public E peek()
{
if (mEntries.isEmpty()) {
throw new IllegalStateException("FastStack is empty");
}
return mEntries.get(mEntries.size() - 1);
}
/**
* Returns the entry at the top of the stack by removing it.
* @return the top entry
* @throws IllegalStateException if the stack is empty.
*/
public E pop()
{
if (mEntries.isEmpty()) {
throw new IllegalStateException("FastStack is empty");
}
return mEntries.remove(mEntries.size() - 1);
}
/**
* Return the element at the specified index. It does not remove the
* element from the stack.
* @param aIndex the index to return
* @return the element at the index
* @throws IllegalArgumentException if index out of range
*/
public E peek(int aIndex)
{
if ((aIndex < 0) || (aIndex >= mEntries.size())) {
throw new IllegalArgumentException("index out of range.");
}
return mEntries.get(aIndex);
}
/**
* Returns if the stack contains the specified element.
* @param aElement the element to find
* @return whether the stack contains the entry
*/
public boolean contains(E aElement)
{
return mEntries.contains(aElement);
}
/**
* Clears the stack.
*/
public void clear()
{
mEntries.clear();
}
/**
* Returns an iterator that goes from the oldest element to the newest.
* @return an iterator
*/
public Iterator iterator()
{
return mEntries.iterator();
}
/**
* Factory method to create a new instance.
* @param the type of elements to hold in the stack.
* @return a new instance of {@link FastStack}
*/
public static FastStack newInstance()
{
return new FastStack();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/FileContents.java 100644 0 0 26363 12026051071 26115 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.puppycrawl.tools.checkstyle.grammars.CommentListener;
import java.io.File;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;
/**
* Represents the contents of a file.
*
* @author Oliver Burn
* @version 1.0
*/
public final class FileContents implements CommentListener
{
/**
* the pattern to match a single line comment containing only the comment
* itself -- no code.
*/
private static final String MATCH_SINGLELINE_COMMENT_PAT = "^\\s*//.*$";
/** compiled regexp to match a single-line comment line */
private static final Pattern MATCH_SINGLELINE_COMMENT = Pattern
.compile(MATCH_SINGLELINE_COMMENT_PAT);
/** the file name */
private final String mFilename;
/** the text */
private final FileText mText;
/** map of the Javadoc comments indexed on the last line of the comment.
* The hack is it assumes that there is only one Javadoc comment per line.
*/
private final Map mJavadocComments = Maps.newHashMap();
/** map of the C++ comments indexed on the first line of the comment. */
private final Map mCPlusPlusComments =
Maps.newHashMap();
/**
* map of the C comments indexed on the first line of the comment to a list
* of comments on that line
*/
private final Map> mCComments = Maps.newHashMap();
/**
* Creates a new FileContents instance.
*
* @param aFilename name of the file
* @param aLines the contents of the file
* @deprecated Use {@link #FileContents(FileText)} instead
* in order to preserve the original line breaks where possible.
*/
@Deprecated public FileContents(String aFilename, String[] aLines)
{
mFilename = aFilename;
mText = FileText.fromLines(new File(aFilename), Arrays.asList(aLines));
}
/**
* Creates a new FileContents instance.
*
* @param aText the contents of the file
*/
public FileContents(FileText aText)
{
mFilename = aText.getFile().toString();
mText = aText;
}
/** {@inheritDoc} */
public void reportSingleLineComment(String aType, int aStartLineNo,
int aStartColNo)
{
reportCppComment(aStartLineNo, aStartColNo);
}
/** {@inheritDoc} */
public void reportBlockComment(String aType, int aStartLineNo,
int aStartColNo, int aEndLineNo, int aEndColNo)
{
reportCComment(aStartLineNo, aStartColNo, aEndLineNo, aEndColNo);
}
/**
* Report the location of a C++ style comment.
* @param aStartLineNo the starting line number
* @param aStartColNo the starting column number
**/
public void reportCppComment(int aStartLineNo, int aStartColNo)
{
final String line = line(aStartLineNo - 1);
final String[] txt = new String[] {line.substring(aStartColNo)};
final Comment comment = new Comment(txt, aStartColNo, aStartLineNo,
line.length() - 1);
mCPlusPlusComments.put(aStartLineNo, comment);
}
/**
* Returns a map of all the C++ style comments. The key is a line number,
* the value is the comment {@link TextBlock} at the line.
* @return the Map of comments
*/
public ImmutableMap getCppComments()
{
return ImmutableMap.copyOf(mCPlusPlusComments);
}
/**
* Report the location of a C-style comment.
* @param aStartLineNo the starting line number
* @param aStartColNo the starting column number
* @param aEndLineNo the ending line number
* @param aEndColNo the ending column number
**/
public void reportCComment(int aStartLineNo, int aStartColNo,
int aEndLineNo, int aEndColNo)
{
final String[] cc = extractCComment(aStartLineNo, aStartColNo,
aEndLineNo, aEndColNo);
final Comment comment = new Comment(cc, aStartColNo, aEndLineNo,
aEndColNo);
// save the comment
if (mCComments.containsKey(aStartLineNo)) {
final List entries = mCComments.get(aStartLineNo);
entries.add(comment);
}
else {
final List entries = Lists.newArrayList();
entries.add(comment);
mCComments.put(aStartLineNo, entries);
}
// Remember if possible Javadoc comment
if (line(aStartLineNo - 1).indexOf("/**", aStartColNo) != -1) {
mJavadocComments.put(aEndLineNo - 1, comment);
}
}
/**
* Returns a map of all C style comments. The key is the line number, the
* value is a {@link List} of C style comment {@link TextBlock}s
* that start at that line.
* @return the map of comments
*/
public ImmutableMap> getCComments()
{
return ImmutableMap.copyOf(mCComments);
}
/**
* Returns the specified C comment as a String array.
* @return C comment as a array
* @param aStartLineNo the starting line number
* @param aStartColNo the starting column number
* @param aEndLineNo the ending line number
* @param aEndColNo the ending column number
**/
private String[] extractCComment(int aStartLineNo, int aStartColNo,
int aEndLineNo, int aEndColNo)
{
String[] retVal;
if (aStartLineNo == aEndLineNo) {
retVal = new String[1];
retVal[0] = line(aStartLineNo - 1).substring(aStartColNo,
aEndColNo + 1);
}
else {
retVal = new String[aEndLineNo - aStartLineNo + 1];
retVal[0] = line(aStartLineNo - 1).substring(aStartColNo);
for (int i = aStartLineNo; i < aEndLineNo; i++) {
retVal[i - aStartLineNo + 1] = line(i);
}
retVal[retVal.length - 1] = line(aEndLineNo - 1).substring(0,
aEndColNo + 1);
}
return retVal;
}
/**
* Returns the Javadoc comment before the specified line.
* A return value of null means there is no such comment.
* @return the Javadoc comment, or null if none
* @param aLineNo the line number to check before
**/
public TextBlock getJavadocBefore(int aLineNo)
{
// Lines start at 1 to the callers perspective, so need to take off 2
int lineNo = aLineNo - 2;
// skip blank lines
while ((lineNo > 0) && (lineIsBlank(lineNo) || lineIsComment(lineNo))) {
lineNo--;
}
return mJavadocComments.get(lineNo);
}
/**
* Get a single line.
* For internal use only, as getText().get(lineNo) is just as
* suitable for external use and avoids method duplication.
* @param aLineNo the number of the line to get
* @return the corresponding line, without terminator
* @throws IndexOutOfBoundsException if lineNo is invalid
*/
private String line(int aLineNo)
{
return mText.get(aLineNo);
}
/**
* Get the full text of the file.
* @return an object containing the full text of the file
*/
public FileText getText()
{
return mText;
}
/** @return the lines in the file */
public String[] getLines()
{
return mText.toLinesArray();
}
/** @return the name of the file */
public String getFilename()
{
return mFilename;
}
/**
* Checks if the specified line is blank.
* @param aLineNo the line number to check
* @return if the specified line consists only of tabs and spaces.
**/
public boolean lineIsBlank(int aLineNo)
{
// possible improvement: avoid garbage creation in trim()
return "".equals(line(aLineNo).trim());
}
/**
* Checks if the specified line is a single-line comment without code.
* @param aLineNo the line number to check
* @return if the specified line consists of only a single line comment
* without code.
**/
public boolean lineIsComment(int aLineNo)
{
return MATCH_SINGLELINE_COMMENT.matcher(line(aLineNo)).matches();
}
/**
* Checks if the specified position intersects with a comment.
* @param aStartLineNo the starting line number
* @param aStartColNo the starting column number
* @param aEndLineNo the ending line number
* @param aEndColNo the ending column number
* @return true if the positions intersects with a comment.
**/
public boolean hasIntersectionWithComment(int aStartLineNo,
int aStartColNo, int aEndLineNo, int aEndColNo)
{
// Check C comments (all comments should be checked)
final Collection> values = mCComments.values();
for (final List row : values) {
for (final TextBlock comment : row) {
if (comment.intersects(aStartLineNo, aStartColNo, aEndLineNo,
aEndColNo))
{
return true;
}
}
}
// Check CPP comments (line searching is possible)
for (int lineNumber = aStartLineNo; lineNumber <= aEndLineNo;
lineNumber++)
{
final TextBlock comment = mCPlusPlusComments.get(lineNumber);
if ((comment != null)
&& comment.intersects(aStartLineNo, aStartColNo,
aEndLineNo, aEndColNo))
{
return true;
}
}
return false;
}
/**
* Checks if the current file is a package-info.java file.
* @return true if the package file.
*/
public boolean inPackageInfo()
{
return this.getFilename().endsWith("package-info.java");
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/FileSetCheck.java 100644 0 0 6027 12026051070 25763 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import java.io.File;
import java.util.List;
import java.util.TreeSet;
/**
* Interface for Checking a set of files for some criteria.
*
* @author lkuehne
* @author oliver
*/
public interface FileSetCheck
extends Configurable, Contextualizable
{
/**
* Sets the MessageDispatcher that is used to dispatch error
* messages to AuditListeners during processing.
* @param aDispatcher the dispatcher
*/
void setMessageDispatcher(MessageDispatcher aDispatcher);
/**
* Initialise the instance. This is the time to verify that everything
* required to perform it job.
*/
void init();
/** Cleans up the object. **/
void destroy();
/**
* Called when about to be called to process a set of files.
* @param aCharset the character set used to read the files.
*/
void beginProcessing(String aCharset);
/**
* Request to process a file. The implementation should use the supplied
* contents and not read the contents again. This reduces the amount of
* file I/O.
*
* The file set to process might contain files that are not
* interesting to the FileSetCheck. Such files should be ignored,
* no error message should be fired for them. For example a FileSetCheck
* that checks java files should ignore HTML or properties files.
*
* The method should return the set of messages to be logged.
*
* @param aFile the file to be processed
* @param aLines an immutable list of the contents of the file.
* @return the list of messages to be logged.
*/
TreeSet process(File aFile, List aLines);
/**
* Called when all the files have been processed. This is the time to
* perform any checks that need to be done across a set of files. In this
* method, the implementation is responsible for the logging of messages.
*/
void finishProcessing();
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/FileText.java 100644 0 0 27422 12026051070 25240 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.UnsupportedEncodingException;
import java.nio.ByteBuffer;
import java.nio.charset.Charset;
import java.nio.charset.CharsetDecoder;
import java.nio.charset.CodingErrorAction;
import java.nio.charset.UnsupportedCharsetException;
import java.util.AbstractList;
import java.util.Arrays;
import java.util.ConcurrentModificationException;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* Represents the text contents of a file of arbitrary plain text type.
*
* This class will be passed to instances of class FileSetCheck by
* Checker. It implements a string list to ensure backwards
* compatibility, but can be extended in the future to allow more
* flexible, more powerful or more efficient handling of certain
* situations.
*
* @author Martin von Gagern
*/
public final class FileText extends AbstractList
{
/**
* The number of characters to read in one go.
*/
private static final int READ_BUFFER_SIZE = 1024;
/**
* Regular expression pattern matching all line terminators.
*/
private static final Pattern LINE_TERMINATOR =
Utils.getPattern("\\n|\\r\\n?");
// For now, we always keep both full text and lines array.
// In the long run, however, the one passed at initialization might be
// enough, while the other could be lazily created when requested.
// This would save memory but cost CPU cycles.
/**
* The name of the file.
* null if no file name is available for whatever reason.
*/
private final File mFile;
/**
* The charset used to read the file.
* null if the file was reconstructed from a list of lines.
*/
private final Charset mCharset;
/**
* The full text contents of the file.
*/
private final CharSequence mFullText;
/**
* The lines of the file, without terminators.
*/
private final String[] mLines;
/**
* The first position of each line within the full text.
*/
private int[] mLineBreaks;
/**
* Creates a new file text representation.
*
* The file will be read using the specified encoding, replacing
* malformed input and unmappable characters with the default
* replacement character.
*
* @param aFile the name of the file
* @param aCharsetName the encoding to use when reading the file
* @throws NullPointerException if the text is null
* @throws IOException if the file could not be read
*/
public FileText(File aFile, String aCharsetName) throws IOException
{
mFile = aFile;
// We use our own decoder, to be sure we have complete control
// about replacements.
final CharsetDecoder decoder;
try {
mCharset = Charset.forName(aCharsetName);
decoder = mCharset.newDecoder();
decoder.onMalformedInput(CodingErrorAction.REPLACE);
decoder.onUnmappableCharacter(CodingErrorAction.REPLACE);
}
catch (final UnsupportedCharsetException ex) {
final String message = "Unsuppored charset: " + aCharsetName;
final UnsupportedEncodingException ex2;
ex2 = new UnsupportedEncodingException(message);
ex2.initCause(ex);
throw ex2;
}
final char[] chars = new char[READ_BUFFER_SIZE];
final StringBuilder buf = new StringBuilder();
final FileInputStream stream = new FileInputStream(aFile);
final Reader reader = new InputStreamReader(stream, decoder);
try {
while (true) {
final int len = reader.read(chars);
if (len < 0) {
break;
}
buf.append(chars, 0, len);
}
}
finally {
Utils.closeQuietly(reader);
}
// buf.trimToSize(); // could be used instead of toString().
mFullText = buf.toString();
final String[] lines = LINE_TERMINATOR.split(mFullText, -1);
if (lines.length > 0 && lines[lines.length - 1].length() == 0) {
// drop empty line after last newline
mLines = new String[lines.length - 1];
System.arraycopy(lines, 0, mLines, 0, lines.length - 1);
}
else {
// no newline at end, so we keep the last line as is
mLines = lines;
}
}
/**
* Compatibility constructor.
*
* This constructor reconstructs the text of the file by joining
* lines with linefeed characters. This process does not restore
* the original line terminators and should therefore be avoided.
*
* @param aFile the name of the file
* @param aLines the lines of the text, without terminators
* @throws NullPointerException if the lines array is null
*/
private FileText(File aFile, List aLines)
{
final StringBuilder buf = new StringBuilder();
for (final String line : aLines) {
buf.append(line).append('\n');
}
buf.trimToSize();
mFile = aFile;
mCharset = null;
mFullText = buf;
mLines = aLines.toArray(new String[aLines.size()]);
}
/**
* Compatibility conversion.
*
* This method can be used to convert the arguments passed to
* {@link FileSetCheck#process(File,List)} to a FileText
* object. If the list of lines already is a FileText, it is
* returned as is. Otherwise, a new FileText is constructed by
* joining the lines using line feed characters.
*
* @param aFile the name of the file
* @param aLines the lines of the text, without terminators
* @return an object representing the denoted text file
*/
public static FileText fromLines(File aFile, List aLines)
{
return (aLines instanceof FileText)
? (FileText) aLines
: new FileText(aFile, aLines);
}
/**
* Get the name of the file.
* @return an object containing the name of the file
*/
public File getFile()
{
return mFile;
}
/**
* Get the character set which was used to read the file.
* Will be null for a file reconstructed from its lines.
* @return the charset used when the file was read
*/
public Charset getCharset()
{
return mCharset;
}
/**
* Get the binary contents of the file.
* The returned object must not be modified.
* @return a buffer containing the bytes making up the file
* @throws IOException if the bytes could not be read from the file
*/
public ByteBuffer getBytes() throws IOException
{
// We might decide to cache file bytes in the future.
if (mFile == null) {
return null;
}
if (mFile.length() > Integer.MAX_VALUE) {
throw new IOException("File too large.");
}
byte[] bytes = new byte[(int) mFile.length() + 1];
final FileInputStream stream = new FileInputStream(mFile);
try {
int fill = 0;
while (true) {
if (fill >= bytes.length) {
// shouldn't happen, but it might nevertheless
final byte[] newBytes = new byte[bytes.length * 2 + 1];
System.arraycopy(bytes, 0, newBytes, 0, fill);
bytes = newBytes;
}
final int len = stream.read(bytes, fill,
bytes.length - fill);
if (len == -1) {
break;
}
fill += len;
}
return ByteBuffer.wrap(bytes, 0, fill).asReadOnlyBuffer();
}
finally {
Utils.closeQuietly(stream);
}
}
/**
* Retrieve the full text of the file.
* @return the full text of the file
*/
public CharSequence getFullText()
{
return mFullText;
}
/**
* Returns an array of all lines.
* {@code text.toLinesArray()} is equivalent to
* {@code text.toArray(new String[text.size()])}.
* @return an array of all lines of the text
*/
public String[] toLinesArray()
{
return mLines.clone();
}
/**
* Find positions of line breaks in the full text.
* @return an array giving the first positions of each line.
*/
private int[] lineBreaks()
{
if (mLineBreaks == null) {
final int[] lineBreaks = new int[size() + 1];
lineBreaks[0] = 0;
int lineNo = 1;
final Matcher matcher = LINE_TERMINATOR.matcher(mFullText);
while (matcher.find()) {
lineBreaks[lineNo++] = matcher.end();
}
if (lineNo < lineBreaks.length) {
lineBreaks[lineNo++] = mFullText.length();
}
if (lineNo != lineBreaks.length) {
throw new ConcurrentModificationException("Text changed.");
}
mLineBreaks = lineBreaks;
}
return mLineBreaks;
}
/**
* Determine line and column numbers in full text.
* @param aPos the character position in the full text
* @return the line and column numbers of this character
*/
public LineColumn lineColumn(int aPos)
{
final int[] lineBreaks = lineBreaks();
int lineNo = Arrays.binarySearch(lineBreaks, aPos);
if (lineNo < 0) {
// we have: lineNo = -(insertion point) - 1
// we want: lineNo = (insertion point) - 1
lineNo = -lineNo - 2;
}
final int startOfLine = lineBreaks[lineNo];
final int columnNo = aPos - startOfLine;
// now we have lineNo and columnNo, both starting at zero.
return new LineColumn(lineNo + 1, columnNo);
}
/**
* Retrieves a line of the text by its number.
* The returned line will not contain a trailing terminator.
* @param aLineNo the number of the line to get, starting at zero
* @return the line with the given number
*/
@Override
public String get(final int aLineNo)
{
return mLines[aLineNo];
}
/**
* Counts the lines of the text.
* @return the number of lines in the text
*/
@Override
public int size()
{
return mLines.length;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/Filter.java 100644 0 0 2604 12026051070 24714 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
/**
* An interface for filtering AuditEvents.
* @author Rick Giles
*/
public interface Filter
{
/**
* Determines whether or not a filtered AuditEvent is accepted.
* @param aEvent the AudtiEvent to filter.
* @return true if the aEvent is accepted.
*/
boolean accept(AuditEvent aEvent);
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/FilterSet.java 100644 0 0 5460 12026051070 25373 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import com.google.common.collect.Sets;
import java.util.Set;
/**
* A filter set applies filters to AuditEvents.
* If a filter in the set rejects an AuditEvent, then the
* AuditEvent is rejected. Otherwise, the AuditEvent is accepted.
* @author Rick Giles
*/
public class FilterSet
implements Filter
{
/** filter set */
private final Set mFilters = Sets.newHashSet();
/**
* Adds a Filter to the set.
* @param aFilter the Filter to add.
*/
public void addFilter(Filter aFilter)
{
mFilters.add(aFilter);
}
/**
* Removes filter.
* @param aFilter filter to remove.
*/
public void removeFilter(Filter aFilter)
{
mFilters.remove(aFilter);
}
/**
* Returns the Filters of the filter set.
* @return the Filters of the filter set.
*/
protected Set getFilters()
{
return mFilters;
}
@Override
public String toString()
{
return mFilters.toString();
}
@Override
public int hashCode()
{
return mFilters.hashCode();
}
@Override
public boolean equals(Object aObject)
{
if (aObject instanceof FilterSet) {
final FilterSet other = (FilterSet) aObject;
return this.mFilters.equals(other.mFilters);
}
return false;
}
/** {@inheritDoc} */
public boolean accept(AuditEvent aEvent)
{
for (Filter filter : mFilters) {
if (!filter.accept(aEvent)) {
return false;
}
}
return true;
}
/** Clears the FilterSet. */
public void clear()
{
mFilters.clear();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/FullIdent.java 100644 0 0 10634 12026051070 25377 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
/**
* Represents a full identifier, including dots, with associated
* position information.
*
*
* Identifiers such as java.util.HashMap are spread across
* multiple AST nodes in the syntax tree (three IDENT nodes, two DOT nodes).
* A FullIdent represents the whole String (excluding any intermediate
* whitespace), which is often easier to work with in Checks.
*
*
* @author Oliver Burn
* @see TokenTypes#DOT
* @see TokenTypes#IDENT
**/
public final class FullIdent
{
/** the string **/
private final StringBuffer mBuffer = new StringBuffer();
/** the line number **/
private int mLineNo;
/** the column number **/
private int mColNo;
/** hide default constructor */
private FullIdent()
{
}
/** @return the text **/
public String getText()
{
return mBuffer.toString();
}
/** @return the line number **/
public int getLineNo()
{
return mLineNo;
}
/** @return the column number **/
public int getColumnNo()
{
return mColNo;
}
/**
* Append the specified text.
* @param aText the text to append
*/
private void append(String aText)
{
mBuffer.append(aText);
}
/**
* Append the specified token and also recalibrate the first line and
* column.
* @param aAST the token to append
*/
private void append(DetailAST aAST)
{
mBuffer.append(aAST.getText());
if (mLineNo == 0) {
mLineNo = aAST.getLineNo();
}
else if (aAST.getLineNo() > 0) {
mLineNo = Math.min(mLineNo, aAST.getLineNo());
}
// TODO: make a function
if (mColNo == 0) {
mColNo = aAST.getColumnNo();
}
else if (aAST.getColumnNo() > 0) {
mColNo = Math.min(mColNo, aAST.getColumnNo());
}
}
/**
* Creates a new FullIdent starting from the specified node.
* @param aAST the node to start from
* @return a FullIdent value
*/
public static FullIdent createFullIdent(DetailAST aAST)
{
final FullIdent fi = new FullIdent();
extractFullIdent(fi, aAST);
return fi;
}
/**
* Creates a new FullIdent starting from the child of the specified node.
* @param aAST the parent node from where to start from
* @return a FullIdent value
*/
public static FullIdent createFullIdentBelow(DetailAST aAST)
{
return createFullIdent(aAST.getFirstChild());
}
/**
* Recursively extract a FullIdent.
*
* @param aFull the FullIdent to add to
* @param aAST the node to recurse from
*/
private static void extractFullIdent(FullIdent aFull, DetailAST aAST)
{
if (aAST == null) {
return;
}
if (aAST.getType() == TokenTypes.DOT) {
extractFullIdent(aFull, aAST.getFirstChild());
aFull.append(".");
extractFullIdent(
aFull, aAST.getFirstChild().getNextSibling());
}
else {
aFull.append(aAST);
}
}
@Override
public String toString()
{
return getText() + "[" + getLineNo() + "x" + getColumnNo() + "]";
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/JavadocTagInfo.java 100644 0 0 50213 12026051067 26333 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import com.google.common.collect.ImmutableMap;
import java.util.Map;
/**
* This enum defines the various Javadoc tags and there properties.
*
*
* Some of this documentation was a little incomplete (ex: valid placement of
* code, value, and literal tags).
*
*
*
* Whenever an inconsistency was found the author's judgment was used.
*
*
*
* For now, the number of required/optional tag arguments are not included
* because some Javadoc tags have very complex rules for determining this
* (ex: {@code {@value}} tag).
*
*
*
* Also, the {@link #isValidOn(DetailAST) isValidOn} method does not consider
* classes defined in a local code block (method, init block, etc.).
*
*
* @author Travis Schneeberger
*/
public enum JavadocTagInfo
{
/**
* {@code @author}.
*/
AUTHOR("@author", "author", Type.BLOCK, true, true)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.PACKAGE_DEF
|| type == TokenTypes.CLASS_DEF
|| type == TokenTypes.INTERFACE_DEF
|| type == TokenTypes.ENUM_DEF
|| type == TokenTypes.ANNOTATION_DEF;
}
},
/**
* {@code {@code}}.
*/
CODE("{@code}", "code", Type.INLINE, true, true)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.PACKAGE_DEF
|| type == TokenTypes.CLASS_DEF
|| type == TokenTypes.INTERFACE_DEF
|| type == TokenTypes.ENUM_DEF
|| type == TokenTypes.ANNOTATION_DEF
|| type == TokenTypes.METHOD_DEF
|| type == TokenTypes.CTOR_DEF
|| (type == TokenTypes.VARIABLE_DEF
&& !ScopeUtils.isLocalVariableDef(aAst));
}
},
/**
* {@code {@docRoot}}.
*/
DOC_ROOT("{@docRoot}", "docRoot", Type.INLINE, true, true)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.PACKAGE_DEF
|| type == TokenTypes.CLASS_DEF
|| type == TokenTypes.INTERFACE_DEF
|| type == TokenTypes.ENUM_DEF
|| type == TokenTypes.ANNOTATION_DEF
|| type == TokenTypes.METHOD_DEF || type == TokenTypes.CTOR_DEF
|| (type == TokenTypes.VARIABLE_DEF
&& !ScopeUtils.isLocalVariableDef(aAst));
}
},
/**
* {@code @deprecated}.
*/
DEPRECATED("@deprecated", "deprecated", Type.BLOCK, false, false)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.CLASS_DEF
|| type == TokenTypes.INTERFACE_DEF
|| type == TokenTypes.ENUM_DEF
|| type == TokenTypes.ANNOTATION_DEF
|| type == TokenTypes.METHOD_DEF
|| type == TokenTypes.CTOR_DEF
|| type == TokenTypes.ENUM_CONSTANT_DEF
|| type == TokenTypes.ANNOTATION_FIELD_DEF
|| (type == TokenTypes.VARIABLE_DEF
&& !ScopeUtils.isLocalVariableDef(aAst));
}
},
/**
* {@code @exception}.
*/
EXCEPTION("@exception", "exception", Type.BLOCK, false, false)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.METHOD_DEF || type == TokenTypes.CTOR_DEF;
}
},
/**
* {@code {@inheritDoc}}.
*/
INHERIT_DOC("{@inheritDoc}", "inheritDoc", Type.INLINE, false, false)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.METHOD_DEF
&& !aAst.branchContains(TokenTypes.LITERAL_STATIC)
&& ScopeUtils.getScopeFromMods(aAst
.findFirstToken(TokenTypes.MODIFIERS)) != Scope.PRIVATE;
}
},
/**
* {@code {@link}}.
*/
LINK("{@link}", "link", Type.INLINE, true, true)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.PACKAGE_DEF
|| type == TokenTypes.CLASS_DEF
|| type == TokenTypes.INTERFACE_DEF
|| type == TokenTypes.ENUM_DEF
|| type == TokenTypes.ANNOTATION_DEF
|| type == TokenTypes.METHOD_DEF || type == TokenTypes.CTOR_DEF
|| (type == TokenTypes.VARIABLE_DEF
&& !ScopeUtils.isLocalVariableDef(aAst));
}
},
/**
* {@code {@linkplain}}.
*/
LINKPLAIN("{@linkplain}", "linkplain", Type.INLINE, true, true)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.PACKAGE_DEF
|| type == TokenTypes.CLASS_DEF
|| type == TokenTypes.INTERFACE_DEF
|| type == TokenTypes.ENUM_DEF
|| type == TokenTypes.ANNOTATION_DEF
|| type == TokenTypes.METHOD_DEF || type == TokenTypes.CTOR_DEF
|| (type == TokenTypes.VARIABLE_DEF
&& !ScopeUtils.isLocalVariableDef(aAst));
}
},
/**
* {@code {@literal}}.
*/
LITERAL("{@literal}", "literal", Type.INLINE, true, true)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.PACKAGE_DEF
|| type == TokenTypes.CLASS_DEF
|| type == TokenTypes.INTERFACE_DEF
|| type == TokenTypes.ENUM_DEF
|| type == TokenTypes.ANNOTATION_DEF
|| type == TokenTypes.METHOD_DEF || type == TokenTypes.CTOR_DEF
|| (type == TokenTypes.VARIABLE_DEF
&& !ScopeUtils.isLocalVariableDef(aAst));
}
},
/**
* {@code @param}.
*/
PARAM("@param", "param", Type.BLOCK, false, false)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.CLASS_DEF
|| type == TokenTypes.INTERFACE_DEF
|| type == TokenTypes.METHOD_DEF
|| type == TokenTypes.CTOR_DEF;
}
},
/**
* {@code @return}.
*/
RETURN("@return", "return", Type.BLOCK, false, false)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
final DetailAST returnType = aAst.findFirstToken(TokenTypes.TYPE);
return type == TokenTypes.METHOD_DEF
&& returnType.getFirstChild().getType()
!= TokenTypes.LITERAL_VOID;
}
},
/**
* {@code @see}.
*/
SEE("@see", "see", Type.BLOCK, true, true)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.PACKAGE_DEF
|| type == TokenTypes.CLASS_DEF
|| type == TokenTypes.INTERFACE_DEF
|| type == TokenTypes.ENUM_DEF
|| type == TokenTypes.ANNOTATION_DEF
|| type == TokenTypes.METHOD_DEF
|| type == TokenTypes.CTOR_DEF
|| (type == TokenTypes.VARIABLE_DEF
&& !ScopeUtils.isLocalVariableDef(aAst));
}
},
/**
* {@code @serial}.
*/
SERIAL("@serial", "serial", Type.BLOCK, true, false)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.VARIABLE_DEF
&& !ScopeUtils.isLocalVariableDef(aAst);
}
},
/**
* {@code @serialData}.
*/
SERIAL_DATA("@serialData", "serialData", Type.BLOCK, false, false)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
final DetailAST methodNameAst = aAst
.findFirstToken(TokenTypes.IDENT);
final String methodName = methodNameAst.getText();
return type == TokenTypes.METHOD_DEF
&& ("writeObject".equals(methodName)
|| "readObject".equals(methodName)
|| "writeExternal".equals(methodName)
|| "readExternal".equals(methodName)
|| "writeReplace".equals(methodName)
|| "readResolve"
.equals(methodName));
}
},
/**
* {@code @serialField}.
*/
SERIAL_FIELD("@serialField", "serialField", Type.BLOCK, false, false)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
final DetailAST varType = aAst.findFirstToken(TokenTypes.TYPE);
return type == TokenTypes.VARIABLE_DEF
&& varType.getType() == TokenTypes.ARRAY_DECLARATOR
&& "ObjectStreamField"
.equals(varType.getFirstChild().getText());
}
},
/**
* {@code @since}.
*/
SINCE("@since", "since", Type.BLOCK, true, true)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.PACKAGE_DEF
|| type == TokenTypes.CLASS_DEF
|| type == TokenTypes.INTERFACE_DEF
|| type == TokenTypes.ENUM_DEF
|| type == TokenTypes.ANNOTATION_DEF
|| type == TokenTypes.METHOD_DEF
|| type == TokenTypes.CTOR_DEF
|| (type == TokenTypes.VARIABLE_DEF
&& !ScopeUtils.isLocalVariableDef(aAst));
}
},
/**
* {@code @throws}.
*/
THROWS("@throws", "throws", Type.BLOCK, false, false)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.METHOD_DEF
|| type == TokenTypes.CTOR_DEF;
}
},
/**
* {@code {@value}}.
*/
VALUE("{@value}", "value", Type.INLINE, true, true)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.PACKAGE_DEF
|| type == TokenTypes.CLASS_DEF
|| type == TokenTypes.INTERFACE_DEF
|| type == TokenTypes.ENUM_DEF
|| type == TokenTypes.ANNOTATION_DEF
|| type == TokenTypes.METHOD_DEF
|| type == TokenTypes.CTOR_DEF
|| (type == TokenTypes.VARIABLE_DEF
&& !ScopeUtils.isLocalVariableDef(aAst));
}
},
/**
* {@code @version}.
*/
VERSION("@version", "version", Type.BLOCK, true, true)
{
/** {@inheritDoc} */
@Override
public boolean isValidOn(final DetailAST aAst)
{
final int type = aAst.getType();
return type == TokenTypes.PACKAGE_DEF
|| type == TokenTypes.CLASS_DEF
|| type == TokenTypes.INTERFACE_DEF
|| type == TokenTypes.ENUM_DEF
|| type == TokenTypes.ANNOTATION_DEF;
}
};
/** holds tag text to tag enum mappings **/
private static final Map TEXT_TO_TAG;
/** holds tag name to tag enum mappings **/
private static final Map NAME_TO_TAG;
static
{
final ImmutableMap.Builder textToTagBuilder =
new ImmutableMap.Builder();
final ImmutableMap.Builder nameToTagBuilder =
new ImmutableMap.Builder();
for (final JavadocTagInfo tag : JavadocTagInfo.values()) {
textToTagBuilder.put(tag.getText(), tag);
nameToTagBuilder.put(tag.getName(), tag);
}
TEXT_TO_TAG = textToTagBuilder.build();
NAME_TO_TAG = nameToTagBuilder.build();
}
/** the tag text **/
private final String mText;
/** the tag name **/
private final String mName;
/** the tag type **/
private final Type mType;
/** if tag is valid in package.html **/
private final boolean mValidInPackageHtml;
/** if tag is valid in overview.html **/
private final boolean mValidInOverviewHtml;
/**
* Sets the various properties of a Javadoc tag.
*
* @param aText the tag text
* @param aName the tag name
* @param aType the type of tag
* @param aValidInPackageHtml whether the tag is valid
* in package.html file
* @param aValidInOverviewHtml whether the tag is valid
* in overview.html file
*/
private JavadocTagInfo(final String aText, final String aName,
final Type aType, final boolean aValidInPackageHtml,
final boolean aValidInOverviewHtml)
{
this.mText = aText;
this.mName = aName;
this.mType = aType;
this.mValidInPackageHtml = aValidInPackageHtml;
this.mValidInOverviewHtml = aValidInOverviewHtml;
}
/**
* Checks if a particular Javadoc tag is valid within a Javadoc block of a
* given AST.
*
*
* For example: Given a call to
* JavadocTag.RETURN{@link #isValidOn(DetailAST)}.
*
*
*
* If passing in a DetailAST representing a non-void METHOD_DEF
* true would be returned. If passing in a DetailAST
* representing a CLASS_DEF false would be returned because
* CLASS_DEF's cannot return a value.
*
*
* @param aAST the AST representing a type that can be Javadoc'd
* @return true if tag is valid.
*/
public abstract boolean isValidOn(DetailAST aAST);
/**
* Checks if tag is valid in a package.html Javadoc file.
*
* @return true if tag is valid.
*/
public boolean isValidInPackageHtml()
{
return this.mValidInPackageHtml;
}
/**
* Checks if tag is valid in a overview.html Javadoc file.
*
* @return true if tag is valid.
*/
public boolean isValidInOverviewHtml()
{
return this.mValidInOverviewHtml;
}
/**
* Gets the tag text.
* @return the tag text
*/
public String getText()
{
return this.mText;
}
/**
* Gets the tag name.
* @return the tag name
*/
public String getName()
{
return this.mName;
}
/**
* Gets the Tag type defined by {@link JavadocTagInfo.Type Type}.
* @return the Tag type
*/
public Type getType()
{
return this.mType;
}
/**
* returns a JavadocTag from the tag text.
* @param aText String representing the tag text
* @return Returns a JavadocTag type from a String representing the tag
* @throws NullPointerException if the text is null
* @throws IllegalArgumentException if the text is not a valid tag
*/
public static JavadocTagInfo fromText(final String aText)
{
if (aText == null) {
throw new NullPointerException("the text is null");
}
final JavadocTagInfo tag = TEXT_TO_TAG.get(aText);
if (tag == null) {
throw new IllegalArgumentException("the text [" + aText
+ "] is not a valid Javadoc tag text");
}
return tag;
}
/**
* returns a JavadocTag from the tag name.
* @param aName String name of the tag
* @return Returns a JavadocTag type from a String representing the tag
* @throws NullPointerException if the text is null
* @throws IllegalArgumentException if the text is not a valid tag. The name
* can be checked using {@link JavadocTagInfo#isValidName(String)}
*/
public static JavadocTagInfo fromName(final String aName)
{
if (aName == null) {
throw new NullPointerException("the name is null");
}
final JavadocTagInfo tag = NAME_TO_TAG.get(aName);
if (tag == null) {
throw new IllegalArgumentException("the name [" + aName
+ "] is not a valid Javadoc tag name");
}
return tag;
}
/**
* Returns whether the provided name is for a valid tag.
* @param aName the tag name to check.
* @return whether the provided name is for a valid tag.
*/
public static boolean isValidName(final String aName)
{
return NAME_TO_TAG.containsKey(aName);
}
/**
* {@inheritDoc}
*/
@Override
public String toString()
{
return "text [" + this.mText + "] name [" + this.mName
+ "] type [" + this.mType
+ "] validInPackageHtml [" + this.mValidInPackageHtml
+ "] validInOverviewHtml [" + this.mValidInOverviewHtml + "]";
}
/**
* The Javadoc Type.
*
* For example a {@code @param} tag is a block tag while a
* {@code {@link}} tag is a inline tag.
*
* @author Travis Schneeberger
*/
public enum Type
{
/** block type. **/
BLOCK,
/** inline type. **/
INLINE;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/LineColumn.java 100644 0 0 4130 12026051067 25536 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
/**
* Immutable line and column numbers.
*
* @author Martin von Gagern
*/
public class LineColumn implements Comparable
{
/** The one-based line number */
private final int mLine;
/** The zero-based column number */
private final int mCol;
/**
* Constructs a new pair of line and column numbers.
* @param aLine the one-based line number
* @param aCol the zero-based column number
*/
public LineColumn(int aLine, int aCol)
{
mLine = aLine;
mCol = aCol;
}
/** @return the one-based line number */
public int getLine()
{
return mLine;
}
/** @return the zero-based column number */
public int getColumn()
{
return mCol;
}
/** {@inheritDoc} */
public int compareTo(LineColumn aLineColumn)
{
return (this.getLine() != aLineColumn.getLine())
? this.getLine() - aLineColumn.getLine()
: this.getColumn() - aLineColumn.getColumn();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/LocalizedMessage.java 100644 0 0 31234 12026051067 26731 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import java.io.Serializable;
import java.text.MessageFormat;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.MissingResourceException;
import java.util.ResourceBundle;
/**
* Represents a message that can be localised. The translations come from
* message.properties files. The underlying implementation uses
* java.text.MessageFormat.
*
* @author Oliver Burn
* @author lkuehne
* @version 1.0
*/
public final class LocalizedMessage
implements Comparable, Serializable
{
/** Required for serialization. */
private static final long serialVersionUID = 5675176836184862150L;
/** hash function multiplicand */
private static final int HASH_MULT = 29;
/** the locale to localise messages to **/
private static Locale sLocale = Locale.getDefault();
/**
* A cache that maps bundle names to RessourceBundles.
* Avoids repetitive calls to ResourceBundle.getBundle().
* TODO: The cache should be cleared at some point.
*/
private static final Map BUNDLE_CACHE =
Collections.synchronizedMap(new HashMap());
/** the line number **/
private final int mLineNo;
/** the column number **/
private final int mColNo;
/** the severity level **/
private final SeverityLevel mSeverityLevel;
/** the id of the module generating the message. */
private final String mModuleId;
/** the default severity level if one is not specified */
private static final SeverityLevel DEFAULT_SEVERITY = SeverityLevel.ERROR;
/** key for the message format **/
private final String mKey;
/** arguments for MessageFormat **/
private final Object[] mArgs;
/** name of the resource bundle to get messages from **/
private final String mBundle;
/** class of the source for this LocalizedMessage */
private final Class mSourceClass;
/** a custom message overriding the default message from the bundle. */
private final String mCustomMessage;
@Override
public boolean equals(Object aObject)
{
if (this == aObject) {
return true;
}
if (!(aObject instanceof LocalizedMessage)) {
return false;
}
final LocalizedMessage localizedMessage = (LocalizedMessage) aObject;
if (mColNo != localizedMessage.mColNo) {
return false;
}
if (mLineNo != localizedMessage.mLineNo) {
return false;
}
if (!mKey.equals(localizedMessage.mKey)) {
return false;
}
if (!Arrays.equals(mArgs, localizedMessage.mArgs)) {
return false;
}
// ignoring mBundle for perf reasons.
// we currently never load the same error from different bundles.
return true;
}
@Override
public int hashCode()
{
int result;
result = mLineNo;
result = HASH_MULT * result + mColNo;
result = HASH_MULT * result + mKey.hashCode();
for (final Object element : mArgs) {
result = HASH_MULT * result + element.hashCode();
}
return result;
}
/**
* Creates a new LocalizedMessage instance.
*
* @param aLineNo line number associated with the message
* @param aColNo column number associated with the message
* @param aBundle resource bundle name
* @param aKey the key to locate the translation
* @param aArgs arguments for the translation
* @param aSeverityLevel severity level for the message
* @param aModuleId the id of the module the message is associated with
* @param aSourceClass the Class that is the source of the message
* @param aCustomMessage optional custom message overriding the default
*/
public LocalizedMessage(int aLineNo,
int aColNo,
String aBundle,
String aKey,
Object[] aArgs,
SeverityLevel aSeverityLevel,
String aModuleId,
Class aSourceClass,
String aCustomMessage)
{
mLineNo = aLineNo;
mColNo = aColNo;
mKey = aKey;
mArgs = (null == aArgs) ? null : aArgs.clone();
mBundle = aBundle;
mSeverityLevel = aSeverityLevel;
mModuleId = aModuleId;
mSourceClass = aSourceClass;
mCustomMessage = aCustomMessage;
}
/**
* Creates a new LocalizedMessage instance.
*
* @param aLineNo line number associated with the message
* @param aColNo column number associated with the message
* @param aBundle resource bundle name
* @param aKey the key to locate the translation
* @param aArgs arguments for the translation
* @param aModuleId the id of the module the message is associated with
* @param aSourceClass the Class that is the source of the message
* @param aCustomMessage optional custom message overriding the default
*/
public LocalizedMessage(int aLineNo,
int aColNo,
String aBundle,
String aKey,
Object[] aArgs,
String aModuleId,
Class aSourceClass,
String aCustomMessage)
{
this(aLineNo,
aColNo,
aBundle,
aKey,
aArgs,
DEFAULT_SEVERITY,
aModuleId,
aSourceClass,
aCustomMessage);
}
/**
* Creates a new LocalizedMessage instance.
*
* @param aLineNo line number associated with the message
* @param aBundle resource bundle name
* @param aKey the key to locate the translation
* @param aArgs arguments for the translation
* @param aSeverityLevel severity level for the message
* @param aModuleId the id of the module the message is associated with
* @param aSourceClass the source class for the message
* @param aCustomMessage optional custom message overriding the default
*/
public LocalizedMessage(int aLineNo,
String aBundle,
String aKey,
Object[] aArgs,
SeverityLevel aSeverityLevel,
String aModuleId,
Class aSourceClass,
String aCustomMessage)
{
this(aLineNo, 0, aBundle, aKey, aArgs, aSeverityLevel, aModuleId,
aSourceClass, aCustomMessage);
}
/**
* Creates a new LocalizedMessage instance. The column number
* defaults to 0.
*
* @param aLineNo line number associated with the message
* @param aBundle name of a resource bundle that contains error messages
* @param aKey the key to locate the translation
* @param aArgs arguments for the translation
* @param aModuleId the id of the module the message is associated with
* @param aSourceClass the name of the source for the message
* @param aCustomMessage optional custom message overriding the default
*/
public LocalizedMessage(
int aLineNo,
String aBundle,
String aKey,
Object[] aArgs,
String aModuleId,
Class aSourceClass,
String aCustomMessage)
{
this(aLineNo, 0, aBundle, aKey, aArgs, DEFAULT_SEVERITY, aModuleId,
aSourceClass, aCustomMessage);
}
/** @return the translated message **/
public String getMessage()
{
final String customMessage = getCustomMessage();
if (customMessage != null) {
return customMessage;
}
try {
// Important to use the default class loader, and not the one in
// the GlobalProperties object. This is because the class loader in
// the GlobalProperties is specified by the user for resolving
// custom classes.
final ResourceBundle bundle = getBundle(mBundle);
final String pattern = bundle.getString(mKey);
return MessageFormat.format(pattern, mArgs);
}
catch (final MissingResourceException ex) {
// If the Check author didn't provide i18n resource bundles
// and logs error messages directly, this will return
// the author's original message
return MessageFormat.format(mKey, mArgs);
}
}
/**
* Returns the formatted custom message if one is configured.
* @return the formatted custom message or null
* if there is no custom message
*/
private String getCustomMessage()
{
if (mCustomMessage == null) {
return null;
}
return MessageFormat.format(mCustomMessage, mArgs);
}
/**
* Find a ResourceBundle for a given bundle name. Uses the classloader
* of the class emitting this message, to be sure to get the correct
* bundle.
* @param aBundleName the bundle name
* @return a ResourceBundle
*/
private ResourceBundle getBundle(String aBundleName)
{
synchronized (BUNDLE_CACHE) {
ResourceBundle bundle = BUNDLE_CACHE
.get(aBundleName);
if (bundle == null) {
bundle = ResourceBundle.getBundle(aBundleName, sLocale,
mSourceClass.getClassLoader());
BUNDLE_CACHE.put(aBundleName, bundle);
}
return bundle;
}
}
/** @return the line number **/
public int getLineNo()
{
return mLineNo;
}
/** @return the column number **/
public int getColumnNo()
{
return mColNo;
}
/** @return the severity level **/
public SeverityLevel getSeverityLevel()
{
return mSeverityLevel;
}
/** @return the module identifier. */
public String getModuleId()
{
return mModuleId;
}
/**
* Returns the message key to locate the translation, can also be used
* in IDE plugins to map error messages to corrective actions.
*
* @return the message key
*/
public String getKey()
{
return mKey;
}
/** @return the name of the source for this LocalizedMessage */
public String getSourceName()
{
return mSourceClass.getName();
}
/** @param aLocale the locale to use for localization **/
public static void setLocale(Locale aLocale)
{
sLocale = aLocale;
}
////////////////////////////////////////////////////////////////////////////
// Interface Comparable methods
////////////////////////////////////////////////////////////////////////////
/** {@inheritDoc} */
public int compareTo(LocalizedMessage aOther)
{
if (getLineNo() == aOther.getLineNo()) {
if (getColumnNo() == aOther.getColumnNo()) {
return getMessage().compareTo(aOther.getMessage());
}
return (getColumnNo() < aOther.getColumnNo()) ? -1 : 1;
}
return (getLineNo() < aOther.getLineNo()) ? -1 : 1;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/LocalizedMessages.java 100644 0 0 4117 12026051067 27074 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
// TODO: check that this class is in the right package
// as soon as architecture has settled. At the time of writing
// this class is not necessary as a part of the public api
import com.google.common.collect.Sets;
import java.util.TreeSet;
/**
* Collection of messages.
* @author Oliver Burn
* @version 1.0
*/
public final class LocalizedMessages
{
/** contains the messages logged **/
private final TreeSet mMessages = Sets.newTreeSet();
/** @return the logged messages **/
public TreeSet getMessages()
{
return Sets.newTreeSet(mMessages);
}
/** Reset the object. **/
public void reset()
{
mMessages.clear();
}
/**
* Logs a message to be reported.
* @param aMsg the message to log
**/
public void add(LocalizedMessage aMsg)
{
mMessages.add(aMsg);
}
/** @return the number of messages */
public int size()
{
return mMessages.size();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/MessageDispatcher.java 100644 0 0 3464 12026051067 27075 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import java.util.TreeSet;
/**
* Used by FileSetChecks to distribute AuditEvents to AuditListeners.
* @author lkuehne
*/
public interface MessageDispatcher
{
/**
* Notify all listeners about the beginning of a file audit.
* @param aFileName the file to be audited
*/
void fireFileStarted(String aFileName);
/**
* Notify all listeners about the end of a file audit.
* @param aFileName the audited file
*/
void fireFileFinished(String aFileName);
/**
* Notify all listeners about the errors in a file.
* @param aFileName the audited file
* @param aErrors the audit errors from the file
*/
void fireErrors(String aFileName, TreeSet aErrors);
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/package-info.java 100644 0 0 2321 12026051065 26013 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* Contains the core API to be used to implement checks. If you want to
* implement your own check, you should be referring to this package.
*/
package com.puppycrawl.tools.checkstyle.api;
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/Scope.java 100644 0 0 4577 12026051067 24561 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
/**
* Represents a Java visibility scope.
*
* @author Lars Kühne
* @author Travis Schneeberger
*/
public enum Scope
{
/** nothing scope. */
NOTHING,
/** protected scope. */
PUBLIC,
/** protected scope. */
PROTECTED,
/** package or default scope. */
PACKAGE,
/** private scope. */
PRIVATE,
/** anonymous inner scope. */
ANONINNER;
@Override
public String toString()
{
return getName();
}
/**
* @return the name of this severity level.
*/
public String getName()
{
return name().toLowerCase();
}
/**
* Checks if this scope is a subscope of another scope.
* Example: PUBLIC is a subscope of PRIVATE.
*
* @param aScope a Scope value
* @return if this is a subscope of aScope.
*/
public boolean isIn(Scope aScope)
{
return (compareTo(aScope) <= 0);
}
/**
* Scope factory method.
*
* @param aScopeName scope name, such as "nothing", "public", etc.
* @return the Scope associated with aScopeName
*/
public static Scope getInstance(String aScopeName)
{
return valueOf(Scope.class, aScopeName.trim().toUpperCase());
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/ScopeUtils.java 100644 0 0 23645 12026051066 25616 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import antlr.collections.AST;
/**
* Contains utility methods for working on scope.
*
* @author Oliver Burn
* @version 1.0
*/
public final class ScopeUtils
{
///CLOVER:OFF
/** prevent instantiation */
private ScopeUtils()
{
}
///CLOVER:ON
/**
* Returns the Scope specified by the modifier set.
*
* @param aMods root node of a modifier set
* @return a Scope value
*/
public static Scope getScopeFromMods(DetailAST aMods)
{
Scope retVal = Scope.PACKAGE; // default scope
for (AST token = aMods.getFirstChild();
token != null;
token = token.getNextSibling())
{
if ("public".equals(token.getText())) {
retVal = Scope.PUBLIC;
break;
}
else if ("protected".equals(token.getText())) {
retVal = Scope.PROTECTED;
break;
}
else if ("private".equals(token.getText())) {
retVal = Scope.PRIVATE;
break;
}
}
return retVal;
}
/**
* Returns the scope of the surrounding "block".
* @param aAST the node to return the scope for
* @return the Scope of the surrounding block
*/
public static Scope getSurroundingScope(DetailAST aAST)
{
Scope retVal = null;
for (DetailAST token = aAST.getParent();
token != null;
token = token.getParent())
{
final int type = token.getType();
if ((type == TokenTypes.CLASS_DEF)
|| (type == TokenTypes.INTERFACE_DEF)
|| (type == TokenTypes.ANNOTATION_DEF)
|| (type == TokenTypes.ENUM_DEF))
{
final DetailAST mods =
token.findFirstToken(TokenTypes.MODIFIERS);
final Scope modScope = ScopeUtils.getScopeFromMods(mods);
if ((retVal == null) || (retVal.isIn(modScope))) {
retVal = modScope;
}
}
else if (type == TokenTypes.LITERAL_NEW) {
retVal = Scope.ANONINNER;
break; //because Scope.ANONINNER is not in any other Scope
}
}
return retVal;
}
/**
* Returns whether a node is directly contained within an interface block.
*
* @param aAST the node to check if directly contained within an interface
* block
* @return a boolean value
*/
public static boolean inInterfaceBlock(DetailAST aAST)
{
boolean retVal = false;
// Loop up looking for a containing interface block
for (DetailAST token = aAST.getParent();
token != null;
token = token.getParent())
{
final int type = token.getType();
if ((type == TokenTypes.CLASS_DEF)
|| (type == TokenTypes.ENUM_DEF)
|| (type == TokenTypes.ANNOTATION_DEF))
{
break; // in a class, enum or annotation
}
else if (type == TokenTypes.LITERAL_NEW) {
break; // inner implementation
}
else if (type == TokenTypes.INTERFACE_DEF) {
retVal = true;
break;
}
}
return retVal;
}
/**
* Returns whether a node is directly contained within an annotation block.
*
* @param aAST the node to check if directly contained within an annotation
* block
* @return a boolean value
*/
public static boolean inAnnotationBlock(DetailAST aAST)
{
boolean retVal = false;
// Loop up looking for a containing interface block
for (DetailAST token = aAST.getParent();
token != null;
token = token.getParent())
{
final int type = token.getType();
if ((type == TokenTypes.CLASS_DEF)
|| (type == TokenTypes.ENUM_DEF)
|| (type == TokenTypes.INTERFACE_DEF))
{
break; // in a class, enum or interface
}
else if (type == TokenTypes.LITERAL_NEW) {
break; // inner implementation
}
else if (type == TokenTypes.ANNOTATION_DEF) {
retVal = true;
break;
}
}
return retVal;
}
/**
* Returns whether a node is directly contained within an interface or
* annotation block.
*
* @param aAST the node to check if directly contained within an interface
* or annotation block
* @return a boolean value
*/
public static boolean inInterfaceOrAnnotationBlock(DetailAST aAST)
{
return inInterfaceBlock(aAST) || inAnnotationBlock(aAST);
}
/**
* Returns whether a node is directly contained within an enum block.
*
* @param aAST the node to check if directly contained within an enum
* block
* @return a boolean value
*/
public static boolean inEnumBlock(DetailAST aAST)
{
boolean retVal = false;
// Loop up looking for a containing interface block
for (DetailAST token = aAST.getParent();
token != null;
token = token.getParent())
{
final int type = token.getType();
if ((type == TokenTypes.INTERFACE_DEF)
|| (type == TokenTypes.ANNOTATION_DEF)
|| (type == TokenTypes.CLASS_DEF))
{
break; // in an interface, annotation or class
}
else if (type == TokenTypes.LITERAL_NEW) {
break; // inner implementation, enums can't be inner classes
}
else if (type == TokenTypes.ENUM_DEF) {
retVal = true;
break;
}
}
return retVal;
}
/**
* Returns whether the scope of a node is restricted to a code block.
* A code block is a method or constructor body, or a initialiser block.
*
* @param aAST the node to check
* @return a boolean value
*/
public static boolean inCodeBlock(DetailAST aAST)
{
boolean retVal = false;
// Loop up looking for a containing code block
for (DetailAST token = aAST.getParent();
token != null;
token = token.getParent())
{
final int type = token.getType();
if ((type == TokenTypes.METHOD_DEF)
|| (type == TokenTypes.CTOR_DEF)
|| (type == TokenTypes.INSTANCE_INIT)
|| (type == TokenTypes.STATIC_INIT))
{
retVal = true;
break;
}
}
return retVal;
}
/**
* Returns whether a node is contained in the outer most type block.
*
* @param aAST the node to check
* @return a boolean value
*/
public static boolean isOuterMostType(DetailAST aAST)
{
boolean retVal = true;
for (DetailAST parent = aAST.getParent();
parent != null;
parent = parent.getParent())
{
if ((parent.getType() == TokenTypes.CLASS_DEF)
|| (parent.getType() == TokenTypes.INTERFACE_DEF)
|| (parent.getType() == TokenTypes.ANNOTATION_DEF)
|| (parent.getType() == TokenTypes.ENUM_DEF))
{
retVal = false;
break;
}
}
return retVal;
}
/**
* Determines whether a node is a local variable definition.
* I.e. if it is declared in a code block, a for initializer,
* or a catch parameter.
* @param aAST the node to check.
* @return whether aAST is a local variable definition.
*/
public static boolean isLocalVariableDef(DetailAST aAST)
{
// variable declaration?
if (aAST.getType() == TokenTypes.VARIABLE_DEF) {
final DetailAST parent = aAST.getParent();
if (parent != null) {
final int type = parent.getType();
return (type == TokenTypes.SLIST)
|| (type == TokenTypes.FOR_INIT)
|| (type == TokenTypes.FOR_EACH_CLAUSE);
}
}
// catch parameter?
else if (aAST.getType() == TokenTypes.PARAMETER_DEF) {
final DetailAST parent = aAST.getParent();
if (parent != null) {
return (parent.getType() == TokenTypes.LITERAL_CATCH);
}
}
return false;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/SeverityLevel.java 100644 0 0 4253 12026051066 26300 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
/**
*
* Severity level for a check violation.
*
*
* Each violation of an audit check is assigned one of the severity levels
* defined here.
*
*
* @author David Schneider
* @author Travis Schneeberger
*/
public enum SeverityLevel
{
/** security level ignore. */
IGNORE,
/** security level info. */
INFO,
/** security level warning. */
WARNING,
/** security level error. */
ERROR;
@Override
public String toString()
{
return getName();
}
/**
* @return the name of this severity level.
*/
public String getName()
{
return name().toLowerCase();
}
/**
* SeverityLevel factory method.
*
* @param aSecurityLevelName level name, such as "ignore", "info", etc.
* @return the SeverityLevel
* associated with aSecurityLevelName
*/
public static SeverityLevel getInstance(String aSecurityLevelName)
{
return valueOf(SeverityLevel.class, aSecurityLevelName.trim()
.toUpperCase());
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/SeverityLevelCounter.java 100644 0 0 5303 12026051066 27635 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
/**
* An audit listener that counts how many {@link AuditEvent AuditEvents}
* of a given severity have been generated.
*
* @author lkuehne
*/
public final class SeverityLevelCounter implements AuditListener
{
/** The severity level to watch out for. */
private SeverityLevel mLevel;
/** Keeps track of the number of counted events. */
private int mCount;
/**
* Creates a new counter.
* @param aLevel the severity level events need to have, must be non-null.
*/
public SeverityLevelCounter(SeverityLevel aLevel)
{
if (aLevel == null) {
throw new IllegalArgumentException();
}
mLevel = aLevel;
}
/** {@inheritDoc} */
public void addError(AuditEvent aEvt)
{
if (mLevel.equals(aEvt.getSeverityLevel())) {
mCount++;
}
}
/** {@inheritDoc} */
public void addException(AuditEvent aEvt, Throwable aThrowable)
{
if (SeverityLevel.ERROR.equals(mLevel)) {
mCount++;
}
}
/** {@inheritDoc} */
public void auditStarted(AuditEvent aEvt)
{
mCount = 0;
}
/** {@inheritDoc} */
public void fileStarted(AuditEvent aEvt)
{
}
/** {@inheritDoc} */
public void auditFinished(AuditEvent aEvt)
{
}
/** {@inheritDoc} */
public void fileFinished(AuditEvent aEvt)
{
}
/**
* Returns the number of counted events since audit started.
* @return the number of counted events since audit started.
*/
public int getCount()
{
return mCount;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/TextBlock.java 100644 0 0 5361 12026051066 25376 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
/**
* A block of text from an inputfile that does not necessarily
* have any grammatical structure.
*
* @author lkuehne
*/
public interface TextBlock
{
/**
* The text content of the text block.
* Each line is represented by one array entry.
* The linebreak characters are not part of the text content.
*
* @return the text content of the text block.
*/
String[] getText();
/**
* The line in the inputfile where the text block starts.
* Counting starts from 1.
* @return first line of the text block
*/
int getStartLineNo();
/**
* The last line of the text block in the inputfile.
* Counting starts from 1.
* @return last line of the text block
*/
int getEndLineNo();
/**
* The column in the inputfile where the text block starts.
* Counting starts from 0.
* @return first line of the text block
*/
int getStartColNo();
/**
* The column in the inputfile where the text block ends.
* Counting starts from 0.
* @return last line of the text block
*/
int getEndColNo();
/**
* Checks if this comment intersects with a specified
* part of the file.
*
* @param aStartLineNo the starting line number in the file
* @param aStartColNo the starting column number in the file
* @param aEndLineNo the ending line number in the file
* @param aEndColNo the ending column number in the file
* @return true if the positions intersects with this comment.
*/
boolean intersects(int aStartLineNo, int aStartColNo,
int aEndLineNo, int aEndColNo);
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/TokenTypes.java 100644 0 0 314360 12026051065 25645 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import com.google.common.collect.ImmutableMap;
import com.puppycrawl.tools.checkstyle.grammars.GeneratedJavaTokenTypes;
import java.lang.reflect.Field;
import java.util.ResourceBundle;
/**
* Contains the constants for all the tokens contained in the Abstract
* Syntax Tree.
*
*
Implementation detail: This class has been introduced to break
* the circular dependency between packages.
*
* @author Oliver Burn
* @author Peter Dobratz
* @version 1.0
*/
public final class TokenTypes
{
///CLOVER:OFF
/** prevent instantiation */
private TokenTypes()
{
}
///CLOVER:ON
// The following three types are never part of an AST,
// left here as a reminder so nobody will read them accidentally
/* * token representing a NULL_TREE_LOOKAHEAD */
// public static final int NULL_TREE_LOOKAHEAD = 3;
/* * token representing a BLOCK */
// public static final int BLOCK = 4;
/* * token representing a VOCAB */
// public static final int VOCAB = 149;
// These are the types that can actually occur in an AST
// it makes sense to register Checks for these types
/**
* The end of file token. This is the root node for the source
* file. It's children are an optional package definition, zero
* or more import statements, and one or more class or interface
* definitions.
*
* @see #PACKAGE_DEF
* @see #IMPORT
* @see #CLASS_DEF
* @see #INTERFACE_DEF
**/
public static final int EOF = GeneratedJavaTokenTypes.EOF;
/**
* Modifiers for type, method, and field declarations. The
* modifiers element is always present even though it may have no
* children.
*
* @see Java
* Language Specification, Chapter 8
* @see #LITERAL_PUBLIC
* @see #LITERAL_PROTECTED
* @see #LITERAL_PRIVATE
* @see #ABSTRACT
* @see #LITERAL_STATIC
* @see #FINAL
* @see #LITERAL_TRANSIENT
* @see #LITERAL_VOLATILE
* @see #LITERAL_SYNCHRONIZED
* @see #LITERAL_NATIVE
* @see #STRICTFP
* @see #ANNOTATION
**/
public static final int MODIFIERS = GeneratedJavaTokenTypes.MODIFIERS;
/**
* An object block. These are children of class, interface, enum,
* annotation and enum constant declarations.
* Also, object blocks are children of the new keyword when defining
* anonymous inner types.
*
* @see #LCURLY
* @see #INSTANCE_INIT
* @see #STATIC_INIT
* @see #CLASS_DEF
* @see #CTOR_DEF
* @see #METHOD_DEF
* @see #VARIABLE_DEF
* @see #RCURLY
* @see #INTERFACE_DEF
* @see #LITERAL_NEW
* @see #ENUM_DEF
* @see #ENUM_CONSTANT_DEF
* @see #ANNOTATION_DEF
**/
public static final int OBJBLOCK = GeneratedJavaTokenTypes.OBJBLOCK;
/**
* A list of statements.
*
* @see #RCURLY
* @see #EXPR
* @see #LABELED_STAT
* @see #LITERAL_THROWS
* @see #LITERAL_RETURN
* @see #SEMI
* @see #METHOD_DEF
* @see #CTOR_DEF
* @see #LITERAL_FOR
* @see #LITERAL_WHILE
* @see #LITERAL_IF
* @see #LITERAL_ELSE
* @see #CASE_GROUP
**/
public static final int SLIST = GeneratedJavaTokenTypes.SLIST;
/**
* A constructor declaration.
*
*
*
* @see #OBJBLOCK
* @see #CLASS_DEF
**/
public static final int CTOR_DEF = GeneratedJavaTokenTypes.CTOR_DEF;
/**
* A method declaration. The children are modifiers, type parameters,
* return type, method name, parameter list, an optional throws list, and
* statement list. The statement list is omitted if the method
* declaration appears in an interface declaration. Method
* declarations may appear inside object blocks of class
* declarations, interface declarations, enum declarations,
* enum constant declarations or anonymous inner-class declarations.
*
*
For example:
*
*
* public static int square(int x)
* {
* return x*x;
* }
*
*
* @see #MODIFIERS
* @see #TYPE_PARAMETERS
* @see #TYPE
* @see #IDENT
* @see #PARAMETERS
* @see #LITERAL_THROWS
* @see #SLIST
* @see #OBJBLOCK
**/
public static final int METHOD_DEF = GeneratedJavaTokenTypes.METHOD_DEF;
/**
* A field or local variable declaration. The children are
* modifiers, type, the identifier name, and an optional
* assignment statement.
*
* @see #MODIFIERS
* @see #TYPE
* @see #IDENT
* @see #ASSIGN
**/
public static final int VARIABLE_DEF =
GeneratedJavaTokenTypes.VARIABLE_DEF;
/**
* An instance initializer. Zero or more instance initializers
* may appear in class and enum definitions. This token will be a child
* of the object block of the declaring type.
*
* @see Java
* Language Specification§8.6
* @see #SLIST
* @see #OBJBLOCK
**/
public static final int INSTANCE_INIT =
GeneratedJavaTokenTypes.INSTANCE_INIT;
/**
* A static initialization block. Zero or more static
* initializers may be children of the object block of a class
* or enum declaration (interfaces cannot have static initializers). The
* first and only child is a statement list.
*
* @see Java
* Language Specification, §8.7
* @see #SLIST
* @see #OBJBLOCK
**/
public static final int STATIC_INIT =
GeneratedJavaTokenTypes.STATIC_INIT;
/**
* A type. This is either a return type of a method or a type of
* a variable or field. The first child of this element is the
* actual type. This may be a primitive type, an identifier, a
* dot which is the root of a fully qualified type, or an array of
* any of these. The second child may be type arguments to the type.
*
* @see #VARIABLE_DEF
* @see #METHOD_DEF
* @see #PARAMETER_DEF
* @see #IDENT
* @see #DOT
* @see #LITERAL_VOID
* @see #LITERAL_BOOLEAN
* @see #LITERAL_BYTE
* @see #LITERAL_CHAR
* @see #LITERAL_SHORT
* @see #LITERAL_INT
* @see #LITERAL_FLOAT
* @see #LITERAL_LONG
* @see #LITERAL_DOUBLE
* @see #ARRAY_DECLARATOR
* @see #TYPE_ARGUMENTS
**/
public static final int TYPE = GeneratedJavaTokenTypes.TYPE;
/**
* A class declaration.
*
*
For example:
*
* public class MyClass
* implements Serializable
* {
* }
*
*
* @see Java
* Language Specification, Chapter 9
* @see #MODIFIERS
* @see #IDENT
* @see #EXTENDS_CLAUSE
* @see #OBJBLOCK
**/
public static final int INTERFACE_DEF =
GeneratedJavaTokenTypes.INTERFACE_DEF;
/**
* The package declaration. This is optional, but if it is
* included, then there is only one package declaration per source
* file and it must be the first non-comment in the file. A package
* declaration may be annotated in which case the annotations comes
* before the rest of the declaration (and are the first children).
*
*
*
* @see Java
* Language Specification §7.4
* @see #DOT
* @see #IDENT
* @see #SEMI
* @see #ANNOTATIONS
* @see FullIdent
**/
public static final int PACKAGE_DEF = GeneratedJavaTokenTypes.PACKAGE_DEF;
/**
* An array declaration.
*
*
If the array declaration represents a type, then the type of
* the array elements is the first child. Multidimensional arrays
* may be regarded as arrays of arrays. In other words, the first
* child of the array declaration is another array
* declaration.
The array declaration may also represent an inline array
* definition. In this case, the first child will be either an
* expression specifying the length of the array or an array
* initialization block.
*
* @see Java
* Language Specification Chapter 10
* @see #TYPE
* @see #ARRAY_INIT
**/
public static final int ARRAY_DECLARATOR =
GeneratedJavaTokenTypes.ARRAY_DECLARATOR;
/**
* An extends clause. This appear as part of class and interface
* definitions. This element appears even if the
* extends keyword is not explicitly used. The child
* is an optional identifier.
*
*
*
* @see #IDENT
* @see #DOT
* @see #CLASS_DEF
* @see #INTERFACE_DEF
* @see FullIdent
**/
public static final int EXTENDS_CLAUSE =
GeneratedJavaTokenTypes.EXTENDS_CLAUSE;
/**
* An implements clause. This always appears in a class or enum
* declaration, even if there are no implemented interfaces. The
* children are a comma separated list of zero or more
* identifiers.
*
*
*
* @see #IDENT
* @see #DOT
* @see #COMMA
* @see #CLASS_DEF
* @see #ENUM_DEF
**/
public static final int IMPLEMENTS_CLAUSE =
GeneratedJavaTokenTypes.IMPLEMENTS_CLAUSE;
/**
* A list of parameters to a method or constructor. The children
* are zero or more parameter declarations separated by commas.
*
*
*
* @see #PARAMETER_DEF
* @see #COMMA
* @see #METHOD_DEF
* @see #CTOR_DEF
**/
public static final int PARAMETERS = GeneratedJavaTokenTypes.PARAMETERS;
/**
* A parameter declaration. The last parameter in a list of parameters may
* be variable length (indicated by the ELLIPSIS child node immediately
* after the TYPE child).
*
* @see #MODIFIERS
* @see #TYPE
* @see #IDENT
* @see #PARAMETERS
* @see #ELLIPSIS
**/
public static final int PARAMETER_DEF =
GeneratedJavaTokenTypes.PARAMETER_DEF;
/**
* A labeled statement.
*
*
*
* @see Java
* Language Specification, §14.7
* @see #SLIST
**/
public static final int LABELED_STAT =
GeneratedJavaTokenTypes.LABELED_STAT;
/**
* A type-cast.
*
*
*
* @see #EXPR
**/
public static final int INDEX_OP = GeneratedJavaTokenTypes.INDEX_OP;
/**
* The ++ (postfix increment) operator.
*
* @see Java
* Language Specification, §15.14.1
* @see #EXPR
* @see #INC
**/
public static final int POST_INC = GeneratedJavaTokenTypes.POST_INC;
/**
* The -- (postfix decrement) operator.
*
* @see Java
* Language Specification, §15.14.2
* @see #EXPR
* @see #DEC
**/
public static final int POST_DEC = GeneratedJavaTokenTypes.POST_DEC;
/**
* A method call. A method call may have type arguments however these
* are attached to the appropriate node in the qualified method name.
*
*
*
* @see #IDENT
* @see #TYPE_ARGUMENTS
* @see #DOT
* @see #ELIST
* @see #RPAREN
* @see FullIdent
**/
public static final int METHOD_CALL = GeneratedJavaTokenTypes.METHOD_CALL;
/**
* An expression. Operators with lower precedence appear at a
* higher level in the tree than operators with higher precedence.
* Parentheses are siblings to the operator they enclose.
*
*
*
* @see #ELIST
* @see #ASSIGN
* @see #LPAREN
* @see #RPAREN
**/
public static final int EXPR = GeneratedJavaTokenTypes.EXPR;
/**
* An array initialization. This may occur as part of an array
* declaration or inline with new.
*
*
*
* @see #ARRAY_DECLARATOR
* @see #TYPE
* @see #LITERAL_NEW
* @see #COMMA
**/
public static final int ARRAY_INIT = GeneratedJavaTokenTypes.ARRAY_INIT;
/**
* An import declaration. Import declarations are option, but
* must appear after the package declaration and before the first type
* declaration.
*
*
*
* @see Java
* Language Specification §7.5
* @see #DOT
* @see #IDENT
* @see #STAR
* @see #SEMI
* @see FullIdent
**/
public static final int IMPORT = GeneratedJavaTokenTypes.IMPORT;
/**
* The - (unary minus) operator.
*
* @see Java
* Language Specification, §15.15.4
* @see #EXPR
**/
public static final int UNARY_MINUS = GeneratedJavaTokenTypes.UNARY_MINUS;
/**
* The + (unary plus) operator.
*
* @see Java
* Language Specification, §15.15.3
* @see #EXPR
**/
public static final int UNARY_PLUS = GeneratedJavaTokenTypes.UNARY_PLUS;
/**
* A group of case clauses. Case clauses with no associated
* statements are grouped together into a case group. The last
* child is a statement list containing the statements to execute
* upon a match.
*
*
*
* @see #LITERAL_CASE
* @see #LITERAL_DEFAULT
* @see #LITERAL_SWITCH
**/
public static final int CASE_GROUP = GeneratedJavaTokenTypes.CASE_GROUP;
/**
* An expression list. The children are a comma separated list of
* expressions.
*
* @see #LITERAL_NEW
* @see #FOR_INIT
* @see #FOR_ITERATOR
* @see #EXPR
* @see #METHOD_CALL
* @see #CTOR_CALL
* @see #SUPER_CTOR_CALL
**/
public static final int ELIST = GeneratedJavaTokenTypes.ELIST;
/**
* A for loop initializer. This is a child of
* LITERAL_FOR. The children of this element may be
* a comma separated list of variable declarations, an expression
* list, or empty.
*
* @see #VARIABLE_DEF
* @see #ELIST
* @see #LITERAL_FOR
**/
public static final int FOR_INIT = GeneratedJavaTokenTypes.FOR_INIT;
/**
* A for loop condition. This is a child of
* LITERAL_FOR. The child of this element is an
* optional expression.
*
* @see #EXPR
* @see #LITERAL_FOR
**/
public static final int FOR_CONDITION =
GeneratedJavaTokenTypes.FOR_CONDITION;
/**
* A for loop iterator. This is a child of
* LITERAL_FOR. The child of this element is an
* optional expression list.
*
* @see #ELIST
* @see #LITERAL_FOR
**/
public static final int FOR_ITERATOR =
GeneratedJavaTokenTypes.FOR_ITERATOR;
/**
* The empty statement. This goes in place of an
* SLIST for a for or while
* loop body.
*
* @see Java
* Language Specification, §14.6
* @see #LITERAL_FOR
* @see #LITERAL_WHILE
**/
public static final int EMPTY_STAT = GeneratedJavaTokenTypes.EMPTY_STAT;
/**
* The final keyword.
*
* @see #MODIFIERS
**/
public static final int FINAL = GeneratedJavaTokenTypes.FINAL;
/**
* The abstract keyword.
*
* @see #MODIFIERS
**/
public static final int ABSTRACT = GeneratedJavaTokenTypes.ABSTRACT;
/**
* The strictfp keyword.
*
* @see #MODIFIERS
**/
public static final int STRICTFP = GeneratedJavaTokenTypes.STRICTFP;
/**
* A super constructor call.
*
* @see #ELIST
* @see #RPAREN
* @see #SEMI
* @see #CTOR_CALL
**/
public static final int SUPER_CTOR_CALL =
GeneratedJavaTokenTypes.SUPER_CTOR_CALL;
/**
* A constructor call.
*
*
*
* @see #ELIST
* @see #RPAREN
* @see #SEMI
* @see #SUPER_CTOR_CALL
**/
public static final int CTOR_CALL = GeneratedJavaTokenTypes.CTOR_CALL;
/* *
* This token does not appear in the tree.
*
* @see #PACKAGE_DEF
**/
//public static final int LITERAL_PACKAGE =
// GeneratedJavaTokenTypes.LITERAL_package;
/**
* The statement terminator (;). Depending on the
* context, this make occur as a sibling, a child, or not at all.
*
* @see #PACKAGE_DEF
* @see #IMPORT
* @see #SLIST
* @see #ARRAY_INIT
* @see #LITERAL_FOR
**/
public static final int SEMI = GeneratedJavaTokenTypes.SEMI;
/* *
* This token does not appear in the tree.
*
* @see #IMPORT
**/
// public static final int LITERAL_IMPORT =
// GeneratedJavaTokenTypes.LITERAL_import;
/* *
* This token does not appear in the tree.
*
* @see #INDEX_OP
* @see #ARRAY_DECLARATOR
**/
//public static final int LBRACK = GeneratedJavaTokenTypes.LBRACK;
/**
* The ] symbol.
*
* @see #INDEX_OP
* @see #ARRAY_DECLARATOR
**/
public static final int RBRACK = GeneratedJavaTokenTypes.RBRACK;
/**
* The void keyword.
*
* @see #TYPE
**/
public static final int LITERAL_VOID =
GeneratedJavaTokenTypes.LITERAL_void;
/**
* The boolean keyword.
*
* @see #TYPE
**/
public static final int LITERAL_BOOLEAN =
GeneratedJavaTokenTypes.LITERAL_boolean;
/**
* The byte keyword.
*
* @see #TYPE
**/
public static final int LITERAL_BYTE =
GeneratedJavaTokenTypes.LITERAL_byte;
/**
* The char keyword.
*
* @see #TYPE
**/
public static final int LITERAL_CHAR =
GeneratedJavaTokenTypes.LITERAL_char;
/**
* The short keyword.
*
* @see #TYPE
**/
public static final int LITERAL_SHORT =
GeneratedJavaTokenTypes.LITERAL_short;
/**
* The int keyword.
*
* @see #TYPE
**/
public static final int LITERAL_INT = GeneratedJavaTokenTypes.LITERAL_int;
/**
* The float keyword.
*
* @see #TYPE
**/
public static final int LITERAL_FLOAT =
GeneratedJavaTokenTypes.LITERAL_float;
/**
* The long keyword.
*
* @see #TYPE
**/
public static final int LITERAL_LONG =
GeneratedJavaTokenTypes.LITERAL_long;
/**
* The double keyword.
*
* @see #TYPE
**/
public static final int LITERAL_DOUBLE =
GeneratedJavaTokenTypes.LITERAL_double;
/**
* An identifier. These can be names of types, subpackages,
* fields, methods, parameters, and local variables.
**/
public static final int IDENT = GeneratedJavaTokenTypes.IDENT;
/**
* The . (dot) operator.
*
* @see FullIdent
**/
public static final int DOT = GeneratedJavaTokenTypes.DOT;
/**
* The * (multiplication or wildcard) operator.
*
* @see Java
* Language Specification, §7.5.2
* @see Java
* Language Specification, §15.17.1
* @see #EXPR
* @see #IMPORT
**/
public static final int STAR = GeneratedJavaTokenTypes.STAR;
/**
* The private keyword.
*
* @see #MODIFIERS
**/
public static final int LITERAL_PRIVATE =
GeneratedJavaTokenTypes.LITERAL_private;
/**
* The public keyword.
*
* @see #MODIFIERS
**/
public static final int LITERAL_PUBLIC =
GeneratedJavaTokenTypes.LITERAL_public;
/**
* The protected keyword.
*
* @see #MODIFIERS
**/
public static final int LITERAL_PROTECTED =
GeneratedJavaTokenTypes.LITERAL_protected;
/**
* The static keyword.
*
* @see #MODIFIERS
**/
public static final int LITERAL_STATIC =
GeneratedJavaTokenTypes.LITERAL_static;
/**
* The transient keyword.
*
* @see #MODIFIERS
**/
public static final int LITERAL_TRANSIENT =
GeneratedJavaTokenTypes.LITERAL_transient;
/**
* The native keyword.
*
* @see #MODIFIERS
**/
public static final int LITERAL_NATIVE =
GeneratedJavaTokenTypes.LITERAL_native;
/**
* The synchronized keyword. This may be used as a
* modifier of a method or in the definition of a synchronized
* block.
*
*
*
* @see #MODIFIERS
* @see #LPAREN
* @see #EXPR
* @see #RPAREN
* @see #SLIST
* @see #RCURLY
**/
public static final int LITERAL_SYNCHRONIZED =
GeneratedJavaTokenTypes.LITERAL_synchronized;
/**
* The volatile keyword.
*
* @see #MODIFIERS
**/
public static final int LITERAL_VOLATILE =
GeneratedJavaTokenTypes.LITERAL_volatile;
/**
* The class keyword. This element appears both
* as part of a class declaration, and inline to reference a
* class object.
*
*
*
* @see #DOT
* @see #IDENT
* @see #CLASS_DEF
* @see FullIdent
**/
public static final int LITERAL_CLASS =
GeneratedJavaTokenTypes.LITERAL_class;
/* *
* This token does not appear in the tree.
*
* @see #EXTENDS_CLAUSE
**/
//public static final int LITERAL_EXTENDS =
// GeneratedJavaTokenTypes.LITERAL_extends;
/**
* The interface keyword. This token appears in
* interface definition.
*
* @see #INTERFACE_DEF
**/
public static final int LITERAL_INTERFACE =
GeneratedJavaTokenTypes.LITERAL_interface;
/**
* A left (curly) brace ({).
*
* @see #OBJBLOCK
* @see #ARRAY_INIT
* @see #SLIST
**/
public static final int LCURLY = GeneratedJavaTokenTypes.LCURLY;
/**
* A right (curly) brace (}).
*
* @see #OBJBLOCK
* @see #ARRAY_INIT
* @see #SLIST
**/
public static final int RCURLY = GeneratedJavaTokenTypes.RCURLY;
/**
* The , (comma) operator.
*
* @see #ARRAY_INIT
* @see #FOR_INIT
* @see #FOR_ITERATOR
* @see #LITERAL_THROWS
* @see #IMPLEMENTS_CLAUSE
**/
public static final int COMMA = GeneratedJavaTokenTypes.COMMA;
/* *
* This token does not appear in the tree.
*
* @see #IMPLEMENTS_CLAUSE
**/
// public static final int LITERAL_IMPLEMENTS =
// GeneratedJavaTokenTypes.LITERAL_implements;
/**
* A left parenthesis (().
*
* @see #LITERAL_FOR
* @see #LITERAL_NEW
* @see #EXPR
* @see #LITERAL_SWITCH
* @see #LITERAL_CATCH
**/
public static final int LPAREN = GeneratedJavaTokenTypes.LPAREN;
/**
* A right parenthesis ()).
*
* @see #LITERAL_FOR
* @see #LITERAL_NEW
* @see #METHOD_CALL
* @see #TYPECAST
* @see #EXPR
* @see #LITERAL_SWITCH
* @see #LITERAL_CATCH
**/
public static final int RPAREN = GeneratedJavaTokenTypes.RPAREN;
/**
* The this keyword.
*
* @see #EXPR
* @see #CTOR_CALL
**/
public static final int LITERAL_THIS =
GeneratedJavaTokenTypes.LITERAL_this;
/**
* The super keyword.
*
* @see #EXPR
* @see #SUPER_CTOR_CALL
**/
public static final int LITERAL_SUPER =
GeneratedJavaTokenTypes.LITERAL_super;
/**
* The = (assignment) operator.
*
* @see Java
* Language Specification, §15.26.1
* @see #EXPR
**/
public static final int ASSIGN = GeneratedJavaTokenTypes.ASSIGN;
/**
* The throws keyword. The children are a number of
* one or more identifiers separated by commas.
*
* @see Java
* Language Specification, §8.4.4
* @see #IDENT
* @see #DOT
* @see #COMMA
* @see #METHOD_DEF
* @see #CTOR_DEF
* @see FullIdent
**/
public static final int LITERAL_THROWS =
GeneratedJavaTokenTypes.LITERAL_throws;
/**
* The : (colon) operator. This will appear as part
* of the conditional operator (? :).
*
* @see #QUESTION
* @see #LABELED_STAT
* @see #CASE_GROUP
**/
public static final int COLON = GeneratedJavaTokenTypes.COLON;
/**
* The if keyword.
*
*
*
* @see #LPAREN
* @see #EXPR
* @see #RPAREN
* @see #SLIST
* @see #EMPTY_STAT
* @see #LITERAL_ELSE
**/
public static final int LITERAL_IF = GeneratedJavaTokenTypes.LITERAL_if;
/**
* The for keyword. The children are (,
* an initializer, a condition, an iterator, a ) and
* either a statement list, a single expression, or an empty
* statement.
*
*
For example:
*
* for(int i = 0, n = myArray.length; i < n; i++)
* {
* }
*
**/
public static final int LITERAL_WHILE =
GeneratedJavaTokenTypes.LITERAL_while;
/**
* The do keyword. Note the the while token does not
* appear as part of the do-while construct.
*
*
For example:
*
* do
* {
* x = rand.nextInt(10);
* }
* while(x < 5);
*
*
* @see #SLIST
* @see #EXPR
* @see #EMPTY_STAT
* @see #LPAREN
* @see #RPAREN
* @see #SEMI
**/
public static final int LITERAL_DO = GeneratedJavaTokenTypes.LITERAL_do;
/**
* Literal while in do-while loop.
* @see #LITERAL_DO
*/
public static final int DO_WHILE = GeneratedJavaTokenTypes.DO_WHILE;
/**
* The break keyword. The first child is an optional
* identifier and the last child is a semicolon.
*
* @see #IDENT
* @see #SEMI
* @see #SLIST
**/
public static final int LITERAL_BREAK =
GeneratedJavaTokenTypes.LITERAL_break;
/**
* The continue keyword. The first child is an
* optional identifier and the last child is a semicolon.
*
* @see #IDENT
* @see #SEMI
* @see #SLIST
**/
public static final int LITERAL_CONTINUE =
GeneratedJavaTokenTypes.LITERAL_continue;
/**
* The return keyword. The first child is an
* optional expression for the return value. The last child is a
* semi colon.
*
* @see #EXPR
* @see #SEMI
* @see #SLIST
**/
public static final int LITERAL_RETURN =
GeneratedJavaTokenTypes.LITERAL_return;
/**
* The switch keyword.
*
*
*
* @see Java
* Language Specification, §14.10
* @see #LPAREN
* @see #EXPR
* @see #RPAREN
* @see #LCURLY
* @see #CASE_GROUP
* @see #RCURLY
* @see #SLIST
**/
public static final int LITERAL_SWITCH =
GeneratedJavaTokenTypes.LITERAL_switch;
/**
* The throw keyword. The first child is an
* expression that evaluates to a Throwable instance.
*
* @see Java
* Language Specification, §14.17
* @see #SLIST
* @see #EXPR
**/
public static final int LITERAL_THROW =
GeneratedJavaTokenTypes.LITERAL_throw;
/**
* The else keyword. This appears as a child of an
* if statement.
*
* @see #SLIST
* @see #EXPR
* @see #EMPTY_STAT
* @see #LITERAL_IF
**/
public static final int LITERAL_ELSE =
GeneratedJavaTokenTypes.LITERAL_else;
/**
* The case keyword. The first child is a constant
* expression that evaluates to a integer.
*
* @see #CASE_GROUP
* @see #EXPR
**/
public static final int LITERAL_CASE =
GeneratedJavaTokenTypes.LITERAL_case;
/**
* The default keyword. This element has no
* children.
*
* @see #CASE_GROUP
**/
public static final int LITERAL_DEFAULT =
GeneratedJavaTokenTypes.LITERAL_default;
/**
* The try keyword. The children are a statement
* list, zero or more catch blocks and then an optional finally
* block.
*
*
*
* @see #LPAREN
* @see #RESOURCES
* @see #RESOURCE
* @see #SEMI
* @see #RPAREN
* @see #LITERAL_TRY
**/
public static final int RESOURCE_SPECIFICATION =
GeneratedJavaTokenTypes.RESOURCE_SPECIFICATION;
/**
* Java 7 try-with-resources construct.
*
* @see #RESOURCE_SPECIFICATION
**/
public static final int RESOURCES =
GeneratedJavaTokenTypes.RESOURCES;
/**
* Java 7 try-with-resources construct.
*
* @see #RESOURCE_SPECIFICATION
**/
public static final int RESOURCE =
GeneratedJavaTokenTypes.RESOURCE;
/**
* The catch keyword.
*
* @see #LPAREN
* @see #PARAMETER_DEF
* @see #RPAREN
* @see #SLIST
* @see #LITERAL_TRY
**/
public static final int LITERAL_CATCH =
GeneratedJavaTokenTypes.LITERAL_catch;
/**
* The finally keyword.
*
* @see #SLIST
* @see #LITERAL_TRY
**/
public static final int LITERAL_FINALLY =
GeneratedJavaTokenTypes.LITERAL_finally;
/**
* The += (addition assignment) operator.
*
* @see Java
* Language Specification, §15.26.2
* @see #EXPR
**/
public static final int PLUS_ASSIGN = GeneratedJavaTokenTypes.PLUS_ASSIGN;
/**
* The -= (subtraction assignment) operator.
*
* @see Java
* Language Specification, §15.26.2
* @see #EXPR
**/
public static final int MINUS_ASSIGN =
GeneratedJavaTokenTypes.MINUS_ASSIGN;
/**
* The *= (multiplication assignment) operator.
*
* @see Java
* Language Specification, §15.26.2
* @see #EXPR
**/
public static final int STAR_ASSIGN = GeneratedJavaTokenTypes.STAR_ASSIGN;
/**
* The /= (division assignment) operator.
*
* @see Java
* Language Specification, §15.26.2
* @see #EXPR
**/
public static final int DIV_ASSIGN = GeneratedJavaTokenTypes.DIV_ASSIGN;
/**
* The %= (remainder assignment) operator.
*
* @see Java
* Language Specification, §15.26.2
* @see #EXPR
**/
public static final int MOD_ASSIGN = GeneratedJavaTokenTypes.MOD_ASSIGN;
/**
* The >>= (signed right shift assignment)
* operator.
*
* @see Java
* Language Specification, §15.26.2
* @see #EXPR
**/
public static final int SR_ASSIGN = GeneratedJavaTokenTypes.SR_ASSIGN;
/**
* The >>>= (unsigned right shift assignment)
* operator.
*
* @see Java
* Language Specification, §15.26.2
* @see #EXPR
**/
public static final int BSR_ASSIGN = GeneratedJavaTokenTypes.BSR_ASSIGN;
/**
* The <<= (left shift assignment) operator.
*
* @see Java
* Language Specification, §15.26.2
* @see #EXPR
**/
public static final int SL_ASSIGN = GeneratedJavaTokenTypes.SL_ASSIGN;
/**
* The &= (bitwise AND assignment) operator.
*
* @see Java
* Language Specification, §15.26.2
* @see #EXPR
**/
public static final int BAND_ASSIGN = GeneratedJavaTokenTypes.BAND_ASSIGN;
/**
* The ^= (bitwise exclusive OR assignment) operator.
*
* @see Java
* Language Specification, §15.26.2
* @see #EXPR
**/
public static final int BXOR_ASSIGN = GeneratedJavaTokenTypes.BXOR_ASSIGN;
/**
* The |= (bitwise OR assignment) operator.
*
* @see Java
* Language Specification, §15.26.2
* @see #EXPR
**/
public static final int BOR_ASSIGN = GeneratedJavaTokenTypes.BOR_ASSIGN;
/**
* The ? (conditional) operator. Technically,
* the colon is also part of this operator, but it appears as a
* separate token.
*
*
*
* @see Java
* Language Specification, §15.25
* @see #EXPR
* @see #COLON
**/
public static final int QUESTION = GeneratedJavaTokenTypes.QUESTION;
/**
* The || (conditional OR) operator.
*
* @see Java
* Language Specification, §15.24
* @see #EXPR
**/
public static final int LOR = GeneratedJavaTokenTypes.LOR;
/**
* The && (conditional AND) operator.
*
* @see Java
* Language Specification, §15.23
* @see #EXPR
**/
public static final int LAND = GeneratedJavaTokenTypes.LAND;
/**
* The | (bitwise OR) operator.
*
* @see Java
* Language Specification, §15.22.1
* @see #EXPR
**/
public static final int BOR = GeneratedJavaTokenTypes.BOR;
/**
* The ^ (bitwise exclusive OR) operator.
*
* @see Java
* Language Specification, §15.22.1
* @see #EXPR
**/
public static final int BXOR = GeneratedJavaTokenTypes.BXOR;
/**
* The & (bitwise AND) operator.
*
* @see Java
* Language Specification, §15.22.1
* @see #EXPR
**/
public static final int BAND = GeneratedJavaTokenTypes.BAND;
/**
* The != (not equal) operator.
*
* @see #EXPR
**/
public static final int NOT_EQUAL = GeneratedJavaTokenTypes.NOT_EQUAL;
/**
* The == (equal) operator.
*
* @see #EXPR
**/
public static final int EQUAL = GeneratedJavaTokenTypes.EQUAL;
/**
* The < (less than) operator.
*
* @see #EXPR
**/
public static final int LT = GeneratedJavaTokenTypes.LT;
/**
* The > (greater than) operator.
*
* @see #EXPR
**/
public static final int GT = GeneratedJavaTokenTypes.GT;
/**
* The <= (less than or equal) operator.
*
* @see #EXPR
**/
public static final int LE = GeneratedJavaTokenTypes.LE;
/**
* The >= (greater than or equal) operator.
*
* @see #EXPR
**/
public static final int GE = GeneratedJavaTokenTypes.GE;
/**
* The instanceof operator. The first child is an
* object reference or something that evaluates to an object
* reference. The second child is a reference type.
*
* @see Java
* Language Specification, §15.20.2
* @see #EXPR
* @see #METHOD_CALL
* @see #IDENT
* @see #DOT
* @see #TYPE
* @see FullIdent
**/
public static final int LITERAL_INSTANCEOF =
GeneratedJavaTokenTypes.LITERAL_instanceof;
/**
* The << (shift left) operator.
*
* @see Java
* Language Specification, §15.19
* @see #EXPR
**/
public static final int SL = GeneratedJavaTokenTypes.SL;
/**
* The >> (signed shift right) operator.
*
* @see Java
* Language Specification, §15.19
* @see #EXPR
**/
public static final int SR = GeneratedJavaTokenTypes.SR;
/**
* The >>> (unsigned shift right) operator.
*
* @see Java
* Language Specification, §15.19
* @see #EXPR
**/
public static final int BSR = GeneratedJavaTokenTypes.BSR;
/**
* The + (addition) operator.
*
* @see Java
* Language Specification, §15.18
* @see #EXPR
**/
public static final int PLUS = GeneratedJavaTokenTypes.PLUS;
/**
* The - (subtraction) operator.
*
* @see Java
* Language Specification, §15.18
* @see #EXPR
**/
public static final int MINUS = GeneratedJavaTokenTypes.MINUS;
/**
* The / (division) operator.
*
* @see Java
* Language Specification, §15.17.2
* @see #EXPR
**/
public static final int DIV = GeneratedJavaTokenTypes.DIV;
/**
* The % (remainder) operator.
*
* @see Java
* Language Specification, §15.17.3
* @see #EXPR
**/
public static final int MOD = GeneratedJavaTokenTypes.MOD;
/**
* The ++ (prefix increment) operator.
*
* @see Java
* Language Specification, §15.15.1
* @see #EXPR
* @see #POST_INC
**/
public static final int INC = GeneratedJavaTokenTypes.INC;
/**
* The -- (prefix decrement) operator.
*
* @see Java
* Language Specification, §15.15.2
* @see #EXPR
* @see #POST_DEC
**/
public static final int DEC = GeneratedJavaTokenTypes.DEC;
/**
* The ~ (bitwise complement) operator.
*
* @see Java
* Language Specification, §15.15.5
* @see #EXPR
**/
public static final int BNOT = GeneratedJavaTokenTypes.BNOT;
/**
* The ! (logical complement) operator.
*
* @see Java
* Language Specification, §15.15.6
* @see #EXPR
**/
public static final int LNOT = GeneratedJavaTokenTypes.LNOT;
/**
* The true keyword.
*
* @see Java
* Language Specification, §3.10.3
* @see #EXPR
* @see #LITERAL_FALSE
**/
public static final int LITERAL_TRUE =
GeneratedJavaTokenTypes.LITERAL_true;
/**
* The false keyword.
*
* @see Java
* Language Specification, §3.10.3
* @see #EXPR
* @see #LITERAL_TRUE
**/
public static final int LITERAL_FALSE =
GeneratedJavaTokenTypes.LITERAL_false;
/**
* The null keyword.
*
* @see Java
* Language Specification, §3.10.7
* @see #EXPR
**/
public static final int LITERAL_NULL =
GeneratedJavaTokenTypes.LITERAL_null;
/**
* The new keyword. This element is used to define
* new instances of objects, new arrays, and new anonymous inner
* classes.
*
*
*
* @see #IDENT
* @see #DOT
* @see #LPAREN
* @see #ELIST
* @see #RPAREN
* @see #OBJBLOCK
* @see #ARRAY_INIT
* @see FullIdent
**/
public static final int LITERAL_NEW = GeneratedJavaTokenTypes.LITERAL_new;
/**
* An integer literal. These may be specified in decimal,
* hexadecimal, or octal form.
*
* @see Java
* Language Specification, §3.10.1
* @see #EXPR
* @see #NUM_LONG
**/
public static final int NUM_INT = GeneratedJavaTokenTypes.NUM_INT;
/**
* A character literal. This is a (possibly escaped) character
* enclosed in single quotes.
*
* @see Java
* Language Specification, §3.10.4
* @see #EXPR
**/
public static final int CHAR_LITERAL =
GeneratedJavaTokenTypes.CHAR_LITERAL;
/**
* A string literal. This is a sequence of (possibly escaped)
* characters enclosed in double quotes.
*
* @see Java
* Language Specification, §3.10.5
* @see #EXPR
**/
public static final int STRING_LITERAL =
GeneratedJavaTokenTypes.STRING_LITERAL;
/**
* A single precision floating point literal. This is a floating
* point number with an F or f suffix.
*
* @see Java
* Language Specification, §3.10.2
* @see #EXPR
* @see #NUM_DOUBLE
**/
public static final int NUM_FLOAT = GeneratedJavaTokenTypes.NUM_FLOAT;
/**
* A long integer literal. These are almost the same as integer
* literals, but they have an L or l
* (ell) suffix.
*
* @see Java
* Language Specification, §3.10.1
* @see #EXPR
* @see #NUM_INT
**/
public static final int NUM_LONG = GeneratedJavaTokenTypes.NUM_LONG;
/**
* A double precision floating point literal. This is a floating
* point number with an optional D or d
* suffix.
*
* @see Java
* Language Specification, §3.10.2
* @see #EXPR
* @see #NUM_FLOAT
**/
public static final int NUM_DOUBLE = GeneratedJavaTokenTypes.NUM_DOUBLE;
/* *
* This token does not appear in the tree.
*
* @see Java
* Language Specification, §3.6
* @see FileContents
**/
//public static final int WS = GeneratedJavaTokenTypes.WS;
/* *
* This token does not appear in the tree.
*
* @see Java
* Language Specification, §3.7
* @see FileContents
**/
//public static final int SL_COMMENT = GeneratedJavaTokenTypes.SL_COMMENT;
/* *
* This token does not appear in the tree.
*
* @see Java
* Language Specification, §3.7
* @see FileContents
**/
//public static final int ML_COMMENT = GeneratedJavaTokenTypes.ML_COMMENT;
/* *
* This token does not appear in the tree.
*
* @see Java
* Language Specification, §3.10.6
* @see #CHAR_LITERAL
* @see #STRING_LITERAL
**/
//public static final int ESC = GeneratedJavaTokenTypes.ESC;
/* *
* This token does not appear in the tree.
*
* @see #NUM_INT
* @see #NUM_LONG
**/
//public static final int HEX_DIGIT = GeneratedJavaTokenTypes.HEX_DIGIT;
/* *
* This token does not appear in the tree.
*
* @see #NUM_FLOAT
* @see #NUM_DOUBLE
**/
//public static final int EXPONENT = GeneratedJavaTokenTypes.EXPONENT;
/* *
* This token does not appear in the tree.
*
* @see #NUM_FLOAT
* @see #NUM_DOUBLE
**/
// public static final int FLOAT_SUFFIX =
// GeneratedJavaTokenTypes.FLOAT_SUFFIX;
/**
* The assert keyword. This is only for Java 1.4 and
* later.
*
*
**/
public static final int LITERAL_ASSERT = GeneratedJavaTokenTypes.ASSERT;
/**
* A static import declaration. Static import declarations are optional,
* but must appear after the package declaration and before the type
* declaration.
*
*
*
* @see
* JSR201
* @see #LITERAL_STATIC
* @see #DOT
* @see #IDENT
* @see #STAR
* @see #SEMI
* @see FullIdent
**/
public static final int STATIC_IMPORT =
GeneratedJavaTokenTypes.STATIC_IMPORT;
/**
* An enum declaration. Its notable children are
* enum constant declarations followed by
* any construct that may be expected in a class body.
*
*
*
* @see
* JSR201
* @see #MODIFIERS
* @see #ENUM
* @see #IDENT
* @see #EXTENDS_CLAUSE
* @see #IMPLEMENTS_CLAUSE
* @see #OBJBLOCK
* @see #LITERAL_NEW
* @see #ENUM_CONSTANT_DEF
**/
public static final int ENUM_DEF =
GeneratedJavaTokenTypes.ENUM_DEF;
/**
* The enum keyword. This element appears
* as part of an enum declaration.
**/
public static final int ENUM =
GeneratedJavaTokenTypes.ENUM;
/**
* An enum constant declaration. Its notable children are annotations,
* arguments and object block akin to an annonymous
* inner class' body.
*
*
*
* @see
* JSR201
* @see #ANNOTATIONS
* @see #MODIFIERS
* @see #IDENT
* @see #ELIST
* @see #OBJBLOCK
**/
public static final int ENUM_CONSTANT_DEF =
GeneratedJavaTokenTypes.ENUM_CONSTANT_DEF;
/**
* A for-each clause. This is a child of
* LITERAL_FOR. The children of this element may be
* a parameter definition, the colon literal and an expression.
*
* @see #VARIABLE_DEF
* @see #ELIST
* @see #LITERAL_FOR
**/
public static final int FOR_EACH_CLAUSE =
GeneratedJavaTokenTypes.FOR_EACH_CLAUSE;
/**
* An annotation declaration. The notable children are the name of the
* annotation type, annotation field declarations and (constant) fields.
*
*
For example:
*
* public @interface MyAnnotation
* {
* int someValue();
* }
*
*
* @see
* JSR201
* @see #MODIFIERS
* @see #LITERAL_INTERFACE
* @see #IDENT
* @see #OBJBLOCK
* @see #ANNOTATION_FIELD_DEF
**/
public static final int ANNOTATION_DEF =
GeneratedJavaTokenTypes.ANNOTATION_DEF;
/**
* An annotation field declaration. The notable children are modifiers,
* field type, field name and an optional default value (a conditional
* compile-time constant expression). Default values may also by
* annotations.
*
*
*
* @see
* JSR201
* @see #MODIFIERS
* @see #TYPE
* @see #LITERAL_DEFAULT
*/
public static final int ANNOTATION_FIELD_DEF =
GeneratedJavaTokenTypes.ANNOTATION_FIELD_DEF;
// note: @ is the html escape for '@',
// used here to avoid confusing the javadoc tool
/**
* A collection of annotations on a package or enum constant.
* A collections of annotations will only occur on these nodes
* as all other nodes that may be qualified with an annotation can
* be qualified with any other modifier and hence these annotations
* would be contained in a {@link #MODIFIERS} node.
*
*
*
* @see
* JSR201
* @see #ANNOTATION
* @see #AT
* @see #IDENT
*/
public static final int ANNOTATIONS =
GeneratedJavaTokenTypes.ANNOTATIONS;
// note: @ is the html escape for '@',
// used here to avoid confusing the javadoc tool
/**
* An annotation of a package, type, field, parameter or variable.
* An annotation may occur anywhere modifiers occur (it is a
* type of modifier) and may also occur prior to a package definition.
* The notable children are: The annotation name and either a single
* default annotation value or a sequence of name value pairs.
* Annotation values may also be annotations themselves.
*
*
*
* @see
* JSR201
* @see #MODIFIERS
* @see #IDENT
* @see #ANNOTATION_MEMBER_VALUE_PAIR
*/
public static final int ANNOTATION =
GeneratedJavaTokenTypes.ANNOTATION;
/**
* An initialisation of an annotation member with a value.
* Its children are the name of the member, the assignment literal
* and the (compile-time constant conditional expression) value.
*
* @see
* JSR201
* @see #ANNOTATION
* @see #IDENT
*/
public static final int ANNOTATION_MEMBER_VALUE_PAIR =
GeneratedJavaTokenTypes.ANNOTATION_MEMBER_VALUE_PAIR;
/**
* An annotation array member initialisation.
* Initializers can not be nested.
* Am initializer may be present as a default to a annotation
* member, as the single default value to an annotation
* (e.g. @Annotation({1,2})) or as the value of an annotation
* member value pair.
*
*
*
* @see
* JSR201
* @see #ANNOTATION
* @see #IDENT
* @see #ANNOTATION_MEMBER_VALUE_PAIR
*/
public static final int ANNOTATION_ARRAY_INIT =
GeneratedJavaTokenTypes.ANNOTATION_ARRAY_INIT;
/**
* A list of type parameters to a class, interface or
* method definition. Children are LT, at least one
* TYPE_PARAMETER, zero or more of: a COMMAs followed by a single
* TYPE_PARAMETER and a final GT.
*
*
*
* @see
* JSR14
* @see #GENERIC_START
* @see #GENERIC_END
* @see #TYPE_PARAMETER
* @see #COMMA
*/
public static final int TYPE_PARAMETERS =
GeneratedJavaTokenTypes.TYPE_PARAMETERS;
/**
* A type parameter to a class, interface or method definition.
* Children are the type name and an optional TYPE_UPPER_BOUNDS.
*
*
*
* @see
* JSR14
* @see #IDENT
* @see #WILDCARD_TYPE
* @see #TYPE_UPPER_BOUNDS
*/
public static final int TYPE_PARAMETER =
GeneratedJavaTokenTypes.TYPE_PARAMETER;
/**
* A list of type arguments to a type reference or
* a method/ctor invocation. Children are GENERIC_START, at least one
* TYPE_ARGUMENT, zero or more of a COMMAs followed by a single
* TYPE_ARGUMENT, and a final GENERIC_END.
*
*
*
* @see #GENERIC_START
* @see #GENERIC_END
* @see #TYPE_ARGUMENT
* @see #COMMA
*/
public static final int TYPE_ARGUMENTS =
GeneratedJavaTokenTypes.TYPE_ARGUMENTS;
/**
* A type arguments to a type reference or a method/ctor invocation.
* Children are either: type name or wildcard type with possible type
* upper or lower bounds.
*
*
*
* @see
* JSR14
* @see #WILDCARD_TYPE
* @see #TYPE_UPPER_BOUNDS
* @see #TYPE_LOWER_BOUNDS
*/
public static final int TYPE_ARGUMENT =
GeneratedJavaTokenTypes.TYPE_ARGUMENT;
/**
* The type that refers to all types. This node has no children.
*
* @see
* JSR14
* @see #TYPE_ARGUMENT
* @see #TYPE_UPPER_BOUNDS
* @see #TYPE_LOWER_BOUNDS
*/
public static final int WILDCARD_TYPE =
GeneratedJavaTokenTypes.WILDCARD_TYPE;
/**
* An upper bounds on a wildcard type argument or type parameter.
* This node has one child - the type that is being used for
* the bounding.
*
* @see
* JSR14
* @see #TYPE_PARAMETER
* @see #TYPE_ARGUMENT
* @see #WILDCARD_TYPE
*/
public static final int TYPE_UPPER_BOUNDS =
GeneratedJavaTokenTypes.TYPE_UPPER_BOUNDS;
/**
* A lower bounds on a wildcard type argument. This node has one child
* - the type that is being used for the bounding.
*
* @see
* JSR14
* @see #TYPE_ARGUMENT
* @see #WILDCARD_TYPE
*/
public static final int TYPE_LOWER_BOUNDS =
GeneratedJavaTokenTypes.TYPE_LOWER_BOUNDS;
/**
* An 'at' symbol - signifying an annotation instance or the prefix
* to the interface literal signifying the definition of an annotation
* declaration.
*
* @see
* JSR201
*/
public static final int AT = GeneratedJavaTokenTypes.AT;
/**
* A triple dot for variable-length parameters. This token only ever occurs
* in a parameter declaration immediately after the type of the parameter.
*
* @see
* JSR201
*/
public static final int ELLIPSIS = GeneratedJavaTokenTypes.ELLIPSIS;
/**
* '&' symbol when used in a generic upper or lower bounds constrain
* e.g. Comparable.
*/
public static final int TYPE_EXTENSION_AND =
GeneratedJavaTokenTypes.TYPE_EXTENSION_AND;
/**
* '<' symbol signifying the start of type arguments or type parameters.
*/
public static final int GENERIC_START =
GeneratedJavaTokenTypes.GENERIC_START;
/**
* '>' symbol signifying the end of type arguments or type parameters.
*/
public static final int GENERIC_END = GeneratedJavaTokenTypes.GENERIC_END;
////////////////////////////////////////////////////////////////////////
// The interesting code goes here
////////////////////////////////////////////////////////////////////////
/** maps from a token name to value */
private static final ImmutableMap TOKEN_NAME_TO_VALUE;
/** maps from a token value to name */
private static final String[] TOKEN_VALUE_TO_NAME;
// initialise the constants
static {
final ImmutableMap.Builder builder =
ImmutableMap.builder();
final Field[] fields = TokenTypes.class.getDeclaredFields();
String[] tempTokenValueToName = new String[0];
for (final Field f : fields) {
// Only process the int declarations.
if (f.getType() != Integer.TYPE) {
continue;
}
final String name = f.getName();
try {
final int tokenValue = f.getInt(name);
builder.put(name, tokenValue);
if (tokenValue > tempTokenValueToName.length - 1) {
final String[] temp = new String[tokenValue + 1];
System.arraycopy(tempTokenValueToName, 0,
temp, 0, tempTokenValueToName.length);
tempTokenValueToName = temp;
}
tempTokenValueToName[tokenValue] = name;
}
catch (final IllegalArgumentException e) {
e.printStackTrace();
System.exit(1);
}
catch (final IllegalAccessException e) {
e.printStackTrace();
System.exit(1);
}
}
TOKEN_NAME_TO_VALUE = builder.build();
TOKEN_VALUE_TO_NAME = tempTokenValueToName;
}
/**
* Returns the name of a token for a given ID.
* @param aID the ID of the token name to get
* @return a token name
*/
public static String getTokenName(int aID)
{
if (aID > TOKEN_VALUE_TO_NAME.length - 1) {
throw new IllegalArgumentException("given id " + aID);
}
final String name = TOKEN_VALUE_TO_NAME[aID];
if (name == null) {
throw new IllegalArgumentException("given id " + aID);
}
return name;
}
/**
* Returns the ID of a token for a given name.
* @param aName the name of the token ID to get
* @return a token ID
*/
public static int getTokenId(String aName)
{
final Integer id = TOKEN_NAME_TO_VALUE.get(aName);
if (id == null) {
throw new IllegalArgumentException("given name " + aName);
}
return id.intValue();
}
/**
* Returns the short description of a token for a given name.
* @param aName the name of the token ID to get
* @return a short description
*/
public static String getShortDescription(String aName)
{
if (!TOKEN_NAME_TO_VALUE.containsKey(aName)) {
throw new IllegalArgumentException("given name " + aName);
}
final String tokentypes =
"com.puppycrawl.tools.checkstyle.api.tokentypes";
final ResourceBundle bundle = ResourceBundle.getBundle(tokentypes);
return bundle.getString(aName);
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/api/Utils.java 100644 0 0 24012 12026051065 24610 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.api;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import java.io.Closeable;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.LineNumberReader;
import java.io.UnsupportedEncodingException;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.apache.commons.beanutils.ConversionException;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Contains utility methods.
*
* @author Oliver Burn
* @version 1.0
*/
public final class Utils
{
/** Map of all created regular expressions **/
private static final Map CREATED_RES = Maps.newHashMap();
/** Shared instance of logger for exception logging. */
private static final Log EXCEPTION_LOG =
LogFactory.getLog("com.puppycrawl.tools.checkstyle.ExceptionLog");
///CLOVER:OFF
/** stop instances being created **/
private Utils()
{
}
///CLOVER:ON
/**
* Accessor for shared instance of logger which should be
* used to log all exceptions occurred during FileSetCheck
* work (debug() should be used).
* @return shared exception logger.
*/
public static Log getExceptionLogger()
{
return EXCEPTION_LOG;
}
/**
* Returns whether the specified string contains only whitespace up to the
* specified index.
*
* @param aIndex index to check up to
* @param aLine the line to check
* @return whether there is only whitespace
*/
public static boolean whitespaceBefore(int aIndex, String aLine)
{
for (int i = 0; i < aIndex; i++) {
if (!Character.isWhitespace(aLine.charAt(i))) {
return false;
}
}
return true;
}
/**
* Returns the length of a string ignoring all trailing whitespace. It is a
* pity that there is not a trim() like method that only removed the
* trailing whitespace.
* @param aLine the string to process
* @return the length of the string ignoring all trailing whitespace
**/
public static int lengthMinusTrailingWhitespace(String aLine)
{
int len = aLine.length();
for (int i = len - 1; i >= 0; i--) {
if (!Character.isWhitespace(aLine.charAt(i))) {
break;
}
len--;
}
return len;
}
/**
* Returns the length of a String prefix with tabs expanded.
* Each tab is counted as the number of characters is takes to
* jump to the next tab stop.
* @param aString the input String
* @param aToIdx index in aString (exclusive) where the calculation stops
* @param aTabWidth the distance between tab stop position.
* @return the length of aString.substring(0, aToIdx) with tabs expanded.
*/
public static int lengthExpandedTabs(String aString,
int aToIdx,
int aTabWidth)
{
int len = 0;
final char[] chars = aString.toCharArray();
for (int idx = 0; idx < aToIdx; idx++) {
if (chars[idx] == '\t') {
len = (len / aTabWidth + 1) * aTabWidth;
}
else {
len++;
}
}
return len;
}
/**
* This is a factory method to return an Pattern object for the specified
* regular expression. It calls {@link #getPattern(String, int)} with the
* compile flags defaults to 0.
* @return an Pattern object for the supplied pattern
* @param aPattern the regular expression pattern
* @throws PatternSyntaxException an invalid pattern was supplied
**/
public static Pattern getPattern(String aPattern)
throws PatternSyntaxException
{
return getPattern(aPattern, 0);
}
/**
* This is a factory method to return an Pattern object for the specified
* regular expression and compile flags.
*
* This method is not MT safe, but neither are the returned Pattern objects.
* @return an Pattern object for the supplied pattern
* @param aPattern the regular expression pattern
* @param aCompileFlags the compilation flags
* @throws PatternSyntaxException an invalid pattern was supplied
**/
public static Pattern getPattern(String aPattern, int aCompileFlags)
throws PatternSyntaxException
{
final String key = aPattern + ":flags-" + aCompileFlags;
Pattern retVal = CREATED_RES.get(key);
if (retVal == null) {
retVal = Pattern.compile(aPattern, aCompileFlags);
CREATED_RES.put(key, retVal);
}
return retVal;
}
/**
* Loads the contents of a file in a String array.
* @return the lines in the file
* @param aFileName the name of the file to load
* @throws IOException error occurred
* @deprecated consider using {@link FileText} instead
**/
@Deprecated
public static String[] getLines(String aFileName)
throws IOException
{
return getLines(
aFileName,
System.getProperty("file.encoding", "UTF-8"));
}
/**
* Loads the contents of a file in a String array using
* the named charset.
* @return the lines in the file
* @param aFileName the name of the file to load
* @param aCharsetName the name of a supported charset
* @throws IOException error occurred
* @deprecated consider using {@link FileText} instead
**/
@Deprecated
public static String[] getLines(String aFileName, String aCharsetName)
throws IOException
{
final List lines = Lists.newArrayList();
final FileInputStream fr = new FileInputStream(aFileName);
LineNumberReader lnr = null;
try {
lnr = new LineNumberReader(new InputStreamReader(fr, aCharsetName));
}
catch (final UnsupportedEncodingException ex) {
final String message = "unsupported charset: " + ex.getMessage();
throw new UnsupportedEncodingException(message);
}
try {
while (true) {
final String l = lnr.readLine();
if (l == null) {
break;
}
lines.add(l);
}
}
finally {
Utils.closeQuietly(lnr);
}
return lines.toArray(new String[lines.size()]);
}
/**
* Helper method to create a regular expression.
* @param aPattern the pattern to match
* @return a created regexp object
* @throws ConversionException if unable to create Pattern object.
**/
public static Pattern createPattern(String aPattern)
throws ConversionException
{
Pattern retVal = null;
try {
retVal = getPattern(aPattern);
}
catch (final PatternSyntaxException e) {
throw new ConversionException(
"Failed to initialise regexp expression " + aPattern, e);
}
return retVal;
}
/**
* @return the base class name from a fully qualified name
* @param aType the fully qualified name. Cannot be null
*/
public static String baseClassname(String aType)
{
final int i = aType.lastIndexOf(".");
return (i == -1) ? aType : aType.substring(i + 1);
}
/**
* Create a stripped down version of a filename.
* @param aBasedir the prefix to strip off the original filename
* @param aFileName the original filename
* @return the filename where an initial prefix of basedir is stripped
*/
public static String getStrippedFileName(
final String aBasedir, final String aFileName)
{
final String stripped;
if ((aBasedir == null) || !aFileName.startsWith(aBasedir)) {
stripped = aFileName;
}
else {
// making the assumption that there is text after basedir
final int skipSep = aBasedir.endsWith(File.separator) ? 0 : 1;
stripped = aFileName.substring(aBasedir.length() + skipSep);
}
return stripped;
}
/**
* Closes the supplied {@link Closeable} object ignoring an
* {@link IOException} if it is thrown. Honestly, what are you going to
* do if you cannot close a file.
* @param aShutting the object to be closed.
*/
public static void closeQuietly(Closeable aShutting)
{
if (null != aShutting) {
try {
aShutting.close();
}
catch (IOException e) {
; // ignore
}
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/Checker.java 100644 0 0 50721 12026051077 24314 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.AuditEvent;
import com.puppycrawl.tools.checkstyle.api.AuditListener;
import com.puppycrawl.tools.checkstyle.api.AutomaticBean;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.Configuration;
import com.puppycrawl.tools.checkstyle.api.Context;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.FileSetCheck;
import com.puppycrawl.tools.checkstyle.api.FileText;
import com.puppycrawl.tools.checkstyle.api.Filter;
import com.puppycrawl.tools.checkstyle.api.FilterSet;
import com.puppycrawl.tools.checkstyle.api.LocalizedMessage;
import com.puppycrawl.tools.checkstyle.api.MessageDispatcher;
import com.puppycrawl.tools.checkstyle.api.SeverityLevel;
import com.puppycrawl.tools.checkstyle.api.SeverityLevelCounter;
import com.puppycrawl.tools.checkstyle.api.Utils;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;
import java.util.List;
import java.util.Locale;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.TreeSet;
/**
* This class provides the functionality to check a set of files.
* @author Oliver Burn
* @author Stephane Bailliez
* @author lkuehne
*/
public class Checker extends AutomaticBean implements MessageDispatcher
{
/** maintains error count */
private final SeverityLevelCounter mCounter = new SeverityLevelCounter(
SeverityLevel.ERROR);
/** vector of listeners */
private final List mListeners = Lists.newArrayList();
/** vector of fileset checks */
private final List mFileSetChecks = Lists.newArrayList();
/** class loader to resolve classes with. **/
private ClassLoader mLoader = Thread.currentThread()
.getContextClassLoader();
/** the basedir to strip off in filenames */
private String mBasedir;
/** locale country to report messages **/
private String mLocaleCountry = Locale.getDefault().getCountry();
/** locale language to report messages **/
private String mLocaleLanguage = Locale.getDefault().getLanguage();
/** The factory for instantiating submodules */
private ModuleFactory mModuleFactory;
/** The classloader used for loading Checkstyle module classes. */
private ClassLoader mModuleClassLoader;
/** the context of all child components */
private Context mChildContext;
/** The audit event filters */
private final FilterSet mFilters = new FilterSet();
/**
* The severity level of any violations found by submodules.
* The value of this property is passed to submodules via
* contextualize().
*
* Note: Since the Checker is merely a container for modules
* it does not make sense to implement logging functionality
* here. Consequently Checker does not extend AbstractViolationReporter,
* leading to a bit of duplicated code for severity level setting.
*/
private SeverityLevel mSeverityLevel = SeverityLevel.ERROR;
/** Name of a charset */
private String mCharset = System.getProperty("file.encoding", "UTF-8");
/**
* Creates a new Checker instance.
* The instance needs to be contextualized and configured.
*
* @throws CheckstyleException if an error occurs
*/
public Checker() throws CheckstyleException
{
addListener(mCounter);
}
@Override
public void finishLocalSetup() throws CheckstyleException
{
final Locale locale = new Locale(mLocaleLanguage, mLocaleCountry);
LocalizedMessage.setLocale(locale);
if (mModuleFactory == null) {
if (mModuleClassLoader == null) {
throw new CheckstyleException(
"if no custom moduleFactory is set, "
+ "moduleClassLoader must be specified");
}
final Set packageNames = PackageNamesLoader
.getPackageNames(mModuleClassLoader);
mModuleFactory = new PackageObjectFactory(packageNames,
mModuleClassLoader);
}
final DefaultContext context = new DefaultContext();
context.add("charset", mCharset);
context.add("classLoader", mLoader);
context.add("moduleFactory", mModuleFactory);
context.add("severity", mSeverityLevel.getName());
context.add("basedir", mBasedir);
mChildContext = context;
}
@Override
protected void setupChild(Configuration aChildConf)
throws CheckstyleException
{
final String name = aChildConf.getName();
try {
final Object child = mModuleFactory.createModule(name);
if (child instanceof AutomaticBean) {
final AutomaticBean bean = (AutomaticBean) child;
bean.contextualize(mChildContext);
bean.configure(aChildConf);
}
if (child instanceof FileSetCheck) {
final FileSetCheck fsc = (FileSetCheck) child;
addFileSetCheck(fsc);
}
else if (child instanceof Filter) {
final Filter filter = (Filter) child;
addFilter(filter);
}
else if (child instanceof AuditListener) {
final AuditListener listener = (AuditListener) child;
addListener(listener);
}
else {
throw new CheckstyleException(name
+ " is not allowed as a child in Checker");
}
}
catch (final Exception ex) {
// TODO i18n
throw new CheckstyleException("cannot initialize module " + name
+ " - " + ex.getMessage(), ex);
}
}
/**
* Adds a FileSetCheck to the list of FileSetChecks
* that is executed in process().
* @param aFileSetCheck the additional FileSetCheck
*/
public void addFileSetCheck(FileSetCheck aFileSetCheck)
{
aFileSetCheck.setMessageDispatcher(this);
mFileSetChecks.add(aFileSetCheck);
}
/**
* Adds a filter to the end of the audit event filter chain.
* @param aFilter the additional filter
*/
public void addFilter(Filter aFilter)
{
mFilters.addFilter(aFilter);
}
/**
* Removes filter.
* @param aFilter filter to remove.
*/
public void removeFilter(Filter aFilter)
{
mFilters.removeFilter(aFilter);
}
/** Cleans up the object. **/
public void destroy()
{
mListeners.clear();
mFilters.clear();
}
/**
* Add the listener that will be used to receive events from the audit.
* @param aListener the nosy thing
*/
public final void addListener(AuditListener aListener)
{
mListeners.add(aListener);
}
/**
* Removes a given listener.
* @param aListener a listener to remove
*/
public void removeListener(AuditListener aListener)
{
mListeners.remove(aListener);
}
/**
* Processes a set of files with all FileSetChecks.
* Once this is done, it is highly recommended to call for
* the destroy method to close and remove the listeners.
* @param aFiles the list of files to be audited.
* @return the total number of errors found
* @see #destroy()
*/
public int process(List aFiles)
{
// Prepare to start
fireAuditStarted();
for (final FileSetCheck fsc : mFileSetChecks) {
fsc.beginProcessing(mCharset);
}
// Process each file
for (final File f : aFiles) {
final String fileName = f.getAbsolutePath();
fireFileStarted(fileName);
final TreeSet fileMessages = Sets.newTreeSet();
try {
final FileText theText = new FileText(f.getAbsoluteFile(),
mCharset);
for (final FileSetCheck fsc : mFileSetChecks) {
fileMessages.addAll(fsc.process(f, theText));
}
}
catch (final FileNotFoundException fnfe) {
Utils.getExceptionLogger().debug(
"FileNotFoundException occured.", fnfe);
fileMessages.add(new LocalizedMessage(0,
Defn.CHECKSTYLE_BUNDLE, "general.fileNotFound", null,
null, this.getClass(), null));
}
catch (final IOException ioe) {
Utils.getExceptionLogger().debug("IOException occured.", ioe);
fileMessages.add(new LocalizedMessage(0,
Defn.CHECKSTYLE_BUNDLE, "general.exception",
new String[] {ioe.getMessage()}, null, this.getClass(),
null));
}
fireErrors(fileName, fileMessages);
fireFileFinished(fileName);
}
// Finish up
for (final FileSetCheck fsc : mFileSetChecks) {
// They may also log!!!
fsc.finishProcessing();
fsc.destroy();
}
final int errorCount = mCounter.getCount();
fireAuditFinished();
return errorCount;
}
/**
* Create a stripped down version of a filename.
* @param aFileName the original filename
* @return the filename where an initial prefix of basedir is stripped
*/
private String getStrippedFileName(final String aFileName)
{
return Utils.getStrippedFileName(mBasedir, aFileName);
}
/** @param aBasedir the base directory to strip off in filenames */
public void setBasedir(String aBasedir)
{
// we use getAbsolutePath() instead of getCanonicalPath()
// because normalize() removes all . and .. so path
// will be canonical by default.
mBasedir = normalize(aBasedir);
}
/**
* "normalize" the given absolute path.
*
*
This includes:
*
*
Uppercase the drive letter if there is one.
*
Remove redundant slashes after the drive spec.
*
resolve all ./, .\, ../ and ..\ sequences.
*
DOS style paths that start with a drive letter will have
* \ as the separator.
*
*
* @param aPath a path for "normalizing"
* @return "normalized" file name
* @throws java.lang.NullPointerException if the file path is
* equal to null.
*/
public String normalize(String aPath)
{
final String osName = System.getProperty("os.name").toLowerCase(
Locale.US);
final boolean onNetWare = (osName.indexOf("netware") > -1);
String path = aPath.replace('/', File.separatorChar).replace('\\',
File.separatorChar);
// make sure we are dealing with an absolute path
final int colon = path.indexOf(":");
if (!onNetWare) {
if (!path.startsWith(File.separator)
&& !((path.length() >= 2)
&& Character.isLetter(path.charAt(0)) && (colon == 1)))
{
final String msg = path + " is not an absolute path";
throw new IllegalArgumentException(msg);
}
}
else {
if (!path.startsWith(File.separator) && (colon == -1)) {
final String msg = path + " is not an absolute path";
throw new IllegalArgumentException(msg);
}
}
boolean dosWithDrive = false;
String root = null;
// Eliminate consecutive slashes after the drive spec
if ((!onNetWare && (path.length() >= 2)
&& Character.isLetter(path.charAt(0)) && (path.charAt(1) == ':'))
|| (onNetWare && (colon > -1)))
{
dosWithDrive = true;
final char[] ca = path.replace('/', '\\').toCharArray();
final StringBuffer sbRoot = new StringBuffer();
for (int i = 0; i < colon; i++) {
sbRoot.append(Character.toUpperCase(ca[i]));
}
sbRoot.append(':');
if (colon + 1 < path.length()) {
sbRoot.append(File.separatorChar);
}
root = sbRoot.toString();
// Eliminate consecutive slashes after the drive spec
final StringBuffer sbPath = new StringBuffer();
for (int i = colon + 1; i < ca.length; i++) {
if ((ca[i] != '\\') || ((ca[i] == '\\') && (ca[i - 1] != '\\')))
{
sbPath.append(ca[i]);
}
}
path = sbPath.toString().replace('\\', File.separatorChar);
}
else {
if (path.length() == 1) {
root = File.separator;
path = "";
}
else if (path.charAt(1) == File.separatorChar) {
// UNC drive
root = File.separator + File.separator;
path = path.substring(2);
}
else {
root = File.separator;
path = path.substring(1);
}
}
final FastStack s = FastStack.newInstance();
s.push(root);
final StringTokenizer tok = new StringTokenizer(path, File.separator);
while (tok.hasMoreTokens()) {
final String thisToken = tok.nextToken();
if (".".equals(thisToken)) {
continue;
}
else if ("..".equals(thisToken)) {
if (s.size() < 2) {
throw new IllegalArgumentException("Cannot resolve path "
+ aPath);
}
s.pop();
}
else { // plain component
s.push(thisToken);
}
}
final StringBuffer sb = new StringBuffer();
for (int i = 0; i < s.size(); i++) {
if (i > 1) {
// not before the filesystem root and not after it, since root
// already contains one
sb.append(File.separatorChar);
}
sb.append(s.peek(i));
}
path = sb.toString();
if (dosWithDrive) {
path = path.replace('/', '\\');
}
return path;
}
/** @return the base directory property used in unit-test. */
public final String getBasedir()
{
return mBasedir;
}
/** notify all listeners about the audit start */
protected void fireAuditStarted()
{
final AuditEvent evt = new AuditEvent(this);
for (final AuditListener listener : mListeners) {
listener.auditStarted(evt);
}
}
/** notify all listeners about the audit end */
protected void fireAuditFinished()
{
final AuditEvent evt = new AuditEvent(this);
for (final AuditListener listener : mListeners) {
listener.auditFinished(evt);
}
}
/**
* Notify all listeners about the beginning of a file audit.
*
* @param aFileName
* the file to be audited
*/
public void fireFileStarted(String aFileName)
{
final String stripped = getStrippedFileName(aFileName);
final AuditEvent evt = new AuditEvent(this, stripped);
for (final AuditListener listener : mListeners) {
listener.fileStarted(evt);
}
}
/**
* Notify all listeners about the end of a file audit.
*
* @param aFileName
* the audited file
*/
public void fireFileFinished(String aFileName)
{
final String stripped = getStrippedFileName(aFileName);
final AuditEvent evt = new AuditEvent(this, stripped);
for (final AuditListener listener : mListeners) {
listener.fileFinished(evt);
}
}
/**
* notify all listeners about the errors in a file.
*
* @param aFileName the audited file
* @param aErrors the audit errors from the file
*/
public void fireErrors(String aFileName, TreeSet aErrors)
{
final String stripped = getStrippedFileName(aFileName);
for (final LocalizedMessage element : aErrors) {
final AuditEvent evt = new AuditEvent(this, stripped, element);
if (mFilters.accept(evt)) {
for (final AuditListener listener : mListeners) {
listener.addError(evt);
}
}
}
}
/**
* Sets the factory for creating submodules.
*
* @param aModuleFactory the factory for creating FileSetChecks
*/
public void setModuleFactory(ModuleFactory aModuleFactory)
{
mModuleFactory = aModuleFactory;
}
/** @param aLocaleCountry the country to report messages **/
public void setLocaleCountry(String aLocaleCountry)
{
mLocaleCountry = aLocaleCountry;
}
/** @param aLocaleLanguage the language to report messages **/
public void setLocaleLanguage(String aLocaleLanguage)
{
mLocaleLanguage = aLocaleLanguage;
}
/**
* Sets the severity level. The string should be one of the names
* defined in the SeverityLevel class.
*
* @param aSeverity The new severity level
* @see SeverityLevel
*/
public final void setSeverity(String aSeverity)
{
mSeverityLevel = SeverityLevel.getInstance(aSeverity);
}
/**
* Sets the classloader that is used to contextualize filesetchecks.
* Some Check implementations will use that classloader to improve the
* quality of their reports, e.g. to load a class and then analyze it via
* reflection.
* @param aLoader the new classloader
*/
public final void setClassloader(ClassLoader aLoader)
{
mLoader = aLoader;
}
/**
* Sets the classloader used to load Checkstyle core and custom module
* classes when the module tree is being built up.
* If no custom ModuleFactory is being set for the Checker module then
* this module classloader must be specified.
* @param aModuleClassLoader the classloader used to load module classes
*/
public final void setModuleClassLoader(ClassLoader aModuleClassLoader)
{
mModuleClassLoader = aModuleClassLoader;
}
/**
* Sets a named charset.
* @param aCharset the name of a charset
* @throws UnsupportedEncodingException if aCharset is unsupported.
*/
public void setCharset(String aCharset)
throws UnsupportedEncodingException
{
if (!Charset.isSupported(aCharset)) {
final String message = "unsupported charset: '" + aCharset + "'";
throw new UnsupportedEncodingException(message);
}
mCharset = aCharset;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/AbstractFormatCheck.java 100644 0 0 10322 12026051065 30050 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.Utils;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.apache.commons.beanutils.ConversionException;
/**
*
Abstract class for checks that verify strings using a
* {@link java.util.regex.Pattern regular expression}. It
* provides support for setting the regular
* expression using the property name format.
*
* @author Oliver Burn
* @version 1.0
*/
public abstract class AbstractFormatCheck
extends Check
{
/** the flags to create the regular expression with */
private int mCompileFlags;
/** the regexp to match against */
private Pattern mRegexp;
/** the format string of the regexp */
private String mFormat;
/**
* Creates a new AbstractFormatCheck instance. Defaults the
* compile flag to 0 (the default).
* @param aDefaultFormat default format
* @throws ConversionException unable to parse aDefaultFormat
*/
public AbstractFormatCheck(String aDefaultFormat)
throws ConversionException
{
this(aDefaultFormat, 0);
}
/**
* Creates a new AbstractFormatCheck instance.
* @param aDefaultFormat default format
* @param aCompileFlags the Pattern flags to compile the regexp with.
* See {@link Pattern#compile(java.lang.String, int)}
* @throws ConversionException unable to parse aDefaultFormat
*/
public AbstractFormatCheck(String aDefaultFormat, int aCompileFlags)
throws ConversionException
{
updateRegexp(aDefaultFormat, aCompileFlags);
}
/**
* Set the format to the specified regular expression.
* @param aFormat a String value
* @throws ConversionException unable to parse aFormat
*/
public final void setFormat(String aFormat)
throws ConversionException
{
updateRegexp(aFormat, mCompileFlags);
}
/**
* Set the compile flags for the regular expression.
* @param aCompileFlags the compile flags to use.
*/
public final void setCompileFlags(int aCompileFlags)
{
updateRegexp(mFormat, aCompileFlags);
}
/** @return the regexp to match against */
public final Pattern getRegexp()
{
return mRegexp;
}
/** @return the regexp format */
public final String getFormat()
{
return mFormat;
}
/**
* Updates the regular expression using the supplied format and compiler
* flags. Will also update the member variables.
* @param aFormat the format of the regular expression.
* @param aCompileFlags the compiler flags to use.
*/
private void updateRegexp(String aFormat, int aCompileFlags)
{
try {
mRegexp = Utils.getPattern(aFormat, aCompileFlags);
mFormat = aFormat;
mCompileFlags |= aCompileFlags;
}
catch (final PatternSyntaxException e) {
throw new ConversionException("unable to parse " + aFormat, e);
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/AbstractOptionCheck.java 100644 0 0 5763 12026051065 30065 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import org.apache.commons.beanutils.ConversionException;
import com.puppycrawl.tools.checkstyle.api.Check;
/**
* Abstract class for checks with a parameter named option, where the
* option is identified by a {@link Enum}. The logic to convert from a string
* representation to the {@link Enum} is to {@link String#trim()} the string
* and convert using {@link String#toUpperCase()} and then look up using
* {@link Enum#valueOf}.
* @param the type of the option.
* @author Oliver Burn
* @author Rick Giles
*/
public abstract class AbstractOptionCheck>
extends Check
{
/** Since I cannot get this by going T.class. */
private final Class mOptionClass;
/** the policy to enforce */
private T mOption;
/**
* Creates a new AbstractOptionCheck instance.
* @param aDefault the default option.
* @param aOptionClass the class for the option. Required due to a quirk
* in the Java language.
*/
public AbstractOptionCheck(T aDefault, Class aOptionClass)
{
mOption = aDefault;
mOptionClass = aOptionClass;
}
/**
* Set the option to enforce.
* @param aOption string to decode option from
* @throws ConversionException if unable to decode
*/
public void setOption(String aOption) throws ConversionException
{
try {
mOption = Enum.valueOf(mOptionClass, aOption.trim().toUpperCase());
}
catch (IllegalArgumentException iae) {
throw new ConversionException("unable to parse " + aOption, iae);
}
}
/**
* @return the AbstractOption set
*/
public T getAbstractOption()
{
// WARNING!! Do not rename this method to getOption(). It breaks
// BeanUtils, which will silently not call setOption. Very annoying!
return mOption;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/AbstractTypeAwareCheck.java 100644 0 0 46443 12026051064 30535 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.LocalizedMessage;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.util.Map;
import java.util.Set;
/**
* Abstract class that endeavours to maintain type information for the Java
* file being checked. It provides helper methods for performing type
* information functions.
*
* @author Oliver Burn
* @version 1.0
*/
public abstract class AbstractTypeAwareCheck extends Check
{
/** imports details **/
private final Set mImports = Sets.newHashSet();
/** full identifier for package of the method **/
private FullIdent mPackageFullIdent;
/** Name of current class. */
private String mCurrentClass;
/** ClassResolver instance for current tree. */
private ClassResolver mClassResolver;
/** Stack of maps for type params. */
private final FastStack> mTypeParams =
FastStack.newInstance();
/**
* Whether to log class loading errors to the checkstyle report
* instead of throwing a RTE.
*
* Logging errors will avoid stopping checkstyle completely
* because of a typo in javadoc. However, with modern IDEs that
* support automated refactoring and generate javadoc this will
* occur rarely, so by default we assume a configuration problem
* in the checkstyle classpath and throw an execption.
*
* This configuration option was triggered by bug 1422462.
*/
private boolean mLogLoadErrors = true;
/**
* Controls whether to log class loading errors to the checkstyle report
* instead of throwing a RTE.
*
* @param aLogLoadErrors true if errors should be logged
*/
public final void setLogLoadErrors(boolean aLogLoadErrors)
{
mLogLoadErrors = aLogLoadErrors;
}
/**
* Whether to show class loading errors in the checkstyle report.
* Request ID 1491630
*/
private boolean mSuppressLoadErrors;
/**
* Controls whether to show class loading errors in the checkstyle report.
*
* @param aSuppressLoadErrors true if errors shouldn't be shown
*/
public final void setSuppressLoadErrors(boolean aSuppressLoadErrors)
{
mSuppressLoadErrors = aSuppressLoadErrors;
}
/**
* Called to process an AST when visiting it.
* @param aAST the AST to process. Guaranteed to not be PACKAGE_DEF or
* IMPORT tokens.
*/
protected abstract void processAST(DetailAST aAST);
@Override
public final int[] getRequiredTokens()
{
return new int[] {
TokenTypes.PACKAGE_DEF,
TokenTypes.IMPORT,
TokenTypes.CLASS_DEF,
TokenTypes.ENUM_DEF,
};
}
@Override
public void beginTree(DetailAST aRootAST)
{
mPackageFullIdent = FullIdent.createFullIdent(null);
mImports.clear();
// add java.lang.* since it's always imported
mImports.add("java.lang.*");
mClassResolver = null;
mCurrentClass = "";
mTypeParams.clear();
}
@Override
public final void visitToken(DetailAST aAST)
{
if (aAST.getType() == TokenTypes.PACKAGE_DEF) {
processPackage(aAST);
}
else if (aAST.getType() == TokenTypes.IMPORT) {
processImport(aAST);
}
else if ((aAST.getType() == TokenTypes.CLASS_DEF)
|| (aAST.getType() == TokenTypes.ENUM_DEF))
{
processClass(aAST);
}
else {
if (aAST.getType() == TokenTypes.METHOD_DEF) {
processTypeParams(aAST);
}
processAST(aAST);
}
}
@Override
public final void leaveToken(DetailAST aAST)
{
if ((aAST.getType() == TokenTypes.CLASS_DEF)
|| (aAST.getType() == TokenTypes.ENUM_DEF))
{
// perhaps it was inner class
int dotIdx = mCurrentClass.lastIndexOf("$");
if (dotIdx == -1) {
// perhaps just a class
dotIdx = mCurrentClass.lastIndexOf(".");
}
if (dotIdx == -1) {
// looks like a topmost class
mCurrentClass = "";
}
else {
mCurrentClass = mCurrentClass.substring(0, dotIdx);
}
mTypeParams.pop();
}
else if (aAST.getType() == TokenTypes.METHOD_DEF) {
mTypeParams.pop();
}
else if ((aAST.getType() != TokenTypes.PACKAGE_DEF)
&& (aAST.getType() != TokenTypes.IMPORT))
{
leaveAST(aAST);
}
}
/**
* Called when exiting an AST. A no-op by default, extending classes
* may choose to override this to augment their processing.
* @param aAST the AST we are departing. Guaranteed to not be PACKAGE_DEF,
* CLASS_DEF, or IMPORT
*/
protected void leaveAST(DetailAST aAST)
{
}
/**
* Is exception is unchecked (subclass of RuntimeException
* or Error
*
* @param aException Class of exception to check
* @return true if exception is unchecked
* false if exception is checked
*/
protected boolean isUnchecked(Class aException)
{
return isSubclass(aException, RuntimeException.class)
|| isSubclass(aException, Error.class);
}
/**
* Checks if one class is subclass of another
*
* @param aChild Class of class
* which should be child
* @param aParent Class of class
* which should be parent
* @return true if aChild is subclass of aParent
* false otherwise
*/
protected boolean isSubclass(Class aChild, Class aParent)
{
return (aParent != null) && (aChild != null)
&& aParent.isAssignableFrom(aChild);
}
/** @return ClassResolver for current tree. */
private ClassResolver getClassResolver()
{
if (mClassResolver == null) {
mClassResolver =
new ClassResolver(getClassLoader(),
mPackageFullIdent.getText(),
mImports);
}
return mClassResolver;
}
/**
* Attempts to resolve the Class for a specified name.
* @param aClassName name of the class to resolve
* @param aCurrentClass name of surrounding class.
* @return the resolved class or null
* if unable to resolve the class.
*/
protected final Class resolveClass(String aClassName,
String aCurrentClass)
{
try {
return getClassResolver().resolve(aClassName, aCurrentClass);
}
catch (final ClassNotFoundException e) {
return null;
}
}
/**
* Tries to load class. Logs error if unable.
* @param aIdent name of class which we try to load.
* @param aCurrentClass name of surrounding class.
* @return Class for a ident.
*/
protected final Class tryLoadClass(Token aIdent, String aCurrentClass)
{
final Class clazz = resolveClass(aIdent.getText(), aCurrentClass);
if (clazz == null) {
logLoadError(aIdent);
}
return clazz;
}
/**
* Logs error if unable to load class information.
* Abstract, should be overrided in subclasses.
* @param aIdent class name for which we can no load class.
*/
protected abstract void logLoadError(Token aIdent);
/**
* Common implementation for logLoadError() method.
* @param aLineNo line number of the problem.
* @param aColumnNo column number of the problem.
* @param aMsgKey message key to use.
* @param aValues values to fill the message out.
*/
protected final void logLoadErrorImpl(int aLineNo, int aColumnNo,
String aMsgKey, Object... aValues)
{
if (!mLogLoadErrors) {
final LocalizedMessage msg = new LocalizedMessage(aLineNo,
aColumnNo,
getMessageBundle(),
aMsgKey,
aValues,
getSeverityLevel(),
getId(),
this.getClass(),
null);
throw new RuntimeException(msg.getMessage());
}
if (!mSuppressLoadErrors) {
log(aLineNo, aColumnNo, aMsgKey, aValues);
}
}
/**
* Collects the details of a package.
* @param aAST node containing the package details
*/
private void processPackage(DetailAST aAST)
{
final DetailAST nameAST = aAST.getLastChild().getPreviousSibling();
mPackageFullIdent = FullIdent.createFullIdent(nameAST);
}
/**
* Collects the details of imports.
* @param aAST node containing the import details
*/
private void processImport(DetailAST aAST)
{
final FullIdent name = FullIdent.createFullIdentBelow(aAST);
if (name != null) {
mImports.add(name.getText());
}
}
/**
* Process type params (if any) for given class, enum or method.
* @param aAST class, enum or method to process.
*/
private void processTypeParams(DetailAST aAST)
{
final DetailAST typeParams =
aAST.findFirstToken(TokenTypes.TYPE_PARAMETERS);
final Map paramsMap = Maps.newHashMap();
mTypeParams.push(paramsMap);
if (typeParams == null) {
return;
}
for (DetailAST child = typeParams.getFirstChild();
child != null;
child = child.getNextSibling())
{
if (child.getType() == TokenTypes.TYPE_PARAMETER) {
final DetailAST param = child;
final String alias =
param.findFirstToken(TokenTypes.IDENT).getText();
final DetailAST bounds =
param.findFirstToken(TokenTypes.TYPE_UPPER_BOUNDS);
if (bounds != null) {
final FullIdent name =
FullIdent.createFullIdentBelow(bounds);
final ClassInfo ci =
createClassInfo(new Token(name), getCurrentClassName());
paramsMap.put(alias, ci);
}
}
}
}
/**
* Processes class definition.
* @param aAST class definition to process.
*/
private void processClass(DetailAST aAST)
{
final DetailAST ident = aAST.findFirstToken(TokenTypes.IDENT);
mCurrentClass += ("".equals(mCurrentClass) ? "" : "$")
+ ident.getText();
processTypeParams(aAST);
}
/**
* Returns current class.
* @return name of current class.
*/
protected final String getCurrentClassName()
{
return mCurrentClass;
}
/**
* Creates class info for given name.
* @param aName name of type.
* @param aSurroundingClass name of surrounding class.
* @return class infor for given name.
*/
protected final ClassInfo createClassInfo(final Token aName,
final String aSurroundingClass)
{
final ClassInfo ci = findClassAlias(aName.getText());
if (ci != null) {
return new ClassAlias(aName, ci);
}
return new RegularClass(aName, aSurroundingClass, this);
}
/**
* Looking if a given name is alias.
* @param aName given name
* @return ClassInfo for alias if it exists, null otherwise
*/
protected final ClassInfo findClassAlias(final String aName)
{
ClassInfo ci = null;
for (int i = mTypeParams.size() - 1; i >= 0; i--) {
final Map paramMap = mTypeParams.peek(i);
ci = paramMap.get(aName);
if (ci != null) {
break;
}
}
return ci;
}
/**
* Contains class's Token.
*/
protected abstract static class ClassInfo
{
/** FullIdent associated with this class. */
private final Token mName;
/** @return class name */
public final Token getName()
{
return mName;
}
/** @return Class associated with an object. */
public abstract Class getClazz();
/**
* Creates new instance of class inforamtion object.
* @param aName token which represents class name.
*/
protected ClassInfo(final Token aName)
{
if (aName == null) {
throw new NullPointerException(
"ClassInfo's name should be non-null");
}
mName = aName;
}
}
/** Represents regular classes/enumes. */
private static final class RegularClass extends ClassInfo
{
/** name of surrounding class. */
private final String mSurroundingClass;
/** is class loadable. */
private boolean mIsLoadable = true;
/** Class object of this class if it's loadable. */
private Class mClass;
/** the check we use to resolve classes. */
private final AbstractTypeAwareCheck mCheck;
/**
* Creates new instance of of class information object.
* @param aName FullIdent associated with new object.
* @param aSurroundingClass name of current surrounding class.
* @param aCheck the check we use to load class.
*/
private RegularClass(final Token aName,
final String aSurroundingClass,
final AbstractTypeAwareCheck aCheck)
{
super(aName);
mSurroundingClass = aSurroundingClass;
mCheck = aCheck;
}
/** @return if class is loadable ot not. */
private boolean isLoadable()
{
return mIsLoadable;
}
@Override
public Class getClazz()
{
if (isLoadable() && (mClass == null)) {
setClazz(mCheck.tryLoadClass(getName(), mSurroundingClass));
}
return mClass;
}
/**
* Associates Class with an object.
* @param aClass Class to associate with.
*/
private void setClazz(Class aClass)
{
mClass = aClass;
mIsLoadable = (mClass != null);
}
@Override
public String toString()
{
return "RegularClass[name=" + getName()
+ ", in class=" + mSurroundingClass
+ ", loadable=" + mIsLoadable
+ ", class=" + mClass + "]";
}
}
/** Represents type param which is "alias" for real type. */
private static class ClassAlias extends ClassInfo
{
/** Class information associated with the alias. */
private final ClassInfo mClassInfo;
/**
* Creates nnew instance of the class.
* @param aName token which represents name of class alias.
* @param aClassInfo class information associated with the alias.
*/
ClassAlias(final Token aName, ClassInfo aClassInfo)
{
super(aName);
mClassInfo = aClassInfo;
}
@Override
public final Class getClazz()
{
return mClassInfo.getClazz();
}
@Override
public String toString()
{
return "ClassAlias[alias " + getName()
+ " for " + mClassInfo + "]";
}
}
/**
* Represents text element with location in the text.
*/
protected static class Token
{
/** token's column number. */
private final int mColumn;
/** token's line number. */
private final int mLine;
/** token's text. */
private final String mText;
/**
* Creates token.
* @param aText token's text
* @param aLine token's line number
* @param aColumn token's column number
*/
public Token(String aText, int aLine, int aColumn)
{
mText = aText;
mLine = aLine;
mColumn = aColumn;
}
/**
* Converts FullIdent to Token.
* @param aFullIdent full ident to convert.
*/
public Token(FullIdent aFullIdent)
{
mText = aFullIdent.getText();
mLine = aFullIdent.getLineNo();
mColumn = aFullIdent.getColumnNo();
}
/** @return line number of the token */
public int getLineNo()
{
return mLine;
}
/** @return column number of the token */
public int getColumnNo()
{
return mColumn;
}
/** @return text of the token */
public String getText()
{
return mText;
}
@Override
public String toString()
{
return "Token[" + getText() + "(" + getLineNo()
+ "x" + getColumnNo() + ")]";
}
}
}
././@LongLink 100644 0 0 155 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/AnnotationUseStyleCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/AnnotationUseStyleCh100644 0 0 40205 12026051060 31511 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.annotation;
import org.apache.commons.beanutils.ConversionException;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* This check controls the style with the usage of annotations.
*
*
* Annotations have three element styles starting with the least verbose.
*
* To not enforce an element style
* a {@link ElementStyle#IGNORE IGNORE} type is provided. The desired style
* can be set through the elementStyle property.
*
*
*
* Using the EXPANDED style is more verbose. The expanded version
* is sometimes referred to as "named parameters" in other languages.
*
*
*
* Using the COMPACT style is less verbose. This style can only
* be used when there is an element called 'value' which is either
* the sole element or all other elements have default valuess.
*
*
*
* Using the COMPACT_NO_ARRAY style is less verbose. It is similar
* to the COMPACT style but single value arrays are flagged. With
* annotations a single value array does not need to be placed in an
* array initializer. This style can only be used when there is an
* element called 'value' which is either the sole element or all other
* elements have default values.
*
*
*
* The ending parenthesis are optional when using annotations with no elements.
* To always require ending parenthesis use the
* {@link ClosingParens#ALWAYS ALWAYS} type. To never have ending parenthesis
* use the {@link ClosingParens#NEVER NEVER} type. To not enforce a
* closing parenthesis preference a {@link ClosingParens#IGNORE IGNORE} type is
* provided. Set this through the closingParens property.
*
*
*
* Annotations also allow you to specify arrays of elements in a standard
* format. As with normal arrays, a trailing comma is optional. To always
* require a trailing comma use the {@link TrailingArrayComma#ALWAYS ALWAYS}
* type. To never have a trailing comma use the
* {@link TrailingArrayComma#NEVER NEVER} type. To not enforce a trailing
* array comma preference a {@link TrailingArrayComma#IGNORE IGNORE} type
* is provided. Set this through the trailingArrayComma property.
*
*
*
* By default the ElementStyle is set to EXPANDED, the TrailingArrayComma
* is set to NEVER, and the ClosingParans is set to ALWAYS.
*
*
*
* According to the JLS, it is legal to include a trailing comma
* in arrays used in annotations but Sun's Java 5 & 6 compilers will not
* compile with this syntax. This may in be a bug in Sun's compilers
* since eclipse 3.4's built-in compiler does allow this syntax as
* defined in the JLS. Note: this was tested with compilers included with
* JDK versions 1.5.0.17 and 1.6.0.11 and the compiler included with eclipse
* 3.4.1.
*
* See
* Java Language specification, sections 9.7.
*
*
*
* An example shown below is set to enforce an EXPANDED style, with a
* trailing array comma set to NEVER and always including the closing
* parenthesis.
*
*
* @author Travis Schneeberger
*/
public final class AnnotationUseStyleCheck extends Check
{
/**
* the element name used to receive special linguistic support
* for annotation use.
*/
private static final String ANNOTATION_ELEMENT_SINGLE_NAME =
"value";
//not extending AbstractOptionCheck because check
//has more than one option type.
/** @see #setElementStyle(String) */
private ElementStyle mStyle = ElementStyle.COMPACT_NO_ARRAY;
//defaulting to NEVER because of the strange compiler behavior
/** @see #setTrailingArrayComma(String) */
private TrailingArrayComma mComma = TrailingArrayComma.NEVER;
/** @see #setClosingParans(String) */
private ClosingParens mParens = ClosingParens.NEVER;
/**
* Sets the ElementStyle from a string.
*
* @param aStyle string representation
* @throws ConversionException if cannot convert string.
*/
public void setElementStyle(final String aStyle)
{
this.mStyle = this.getOption(ElementStyle.class, aStyle);
}
/**
* Sets the TrailingArrayComma from a string.
*
* @param aComma string representation
* @throws ConversionException if cannot convert string.
*/
public void setTrailingArrayComma(final String aComma)
{
this.mComma = this.getOption(TrailingArrayComma.class, aComma);
}
/**
* Sets the ClosingParens from a string.
*
* @param aParens string representation
* @throws ConversionException if cannot convert string.
*/
public void setClosingParens(final String aParens)
{
this.mParens = this.getOption(ClosingParens.class, aParens);
}
/**
* Retrieves an {@link Enum Enum} type from a @{link String String}.
* @param the enum type
* @param aEnumClass the enum class
* @param aString the string representing the enum
* @return the enum type
*/
private > T getOption(final Class aEnumClass,
final String aString)
{
try {
return Enum.valueOf(aEnumClass, aString.trim().toUpperCase());
}
catch (final IllegalArgumentException iae) {
throw new ConversionException("unable to parse " + aString, iae);
}
}
/** {@inheritDoc} */
@Override
public int[] getDefaultTokens()
{
return this.getRequiredTokens();
}
/** {@inheritDoc} */
@Override
public int[] getRequiredTokens()
{
return new int[] {
TokenTypes.ANNOTATION,
};
}
/** {@inheritDoc} */
@Override
public int[] getAcceptableTokens()
{
return this.getRequiredTokens();
}
/** {@inheritDoc} */
@Override
public void visitToken(final DetailAST aAST)
{
this.checkStyleType(aAST);
this.checkCheckClosingParens(aAST);
this.checkTrailingComma(aAST);
}
/**
* Checks to see if the
* {@link ElementStyle AnnotationElementStyle}
* is correct.
*
* @param aAnnotation the annotation token
*/
private void checkStyleType(final DetailAST aAnnotation)
{
if (ElementStyle.IGNORE.equals(this.mStyle)
|| this.mStyle == null)
{
return;
}
if (ElementStyle.COMPACT_NO_ARRAY.equals(this.mStyle)) {
this.checkCompactNoArrayStyle(aAnnotation);
}
else if (ElementStyle.COMPACT.equals(this.mStyle)) {
this.checkCompactStyle(aAnnotation);
}
else if (ElementStyle.EXPANDED.equals(this.mStyle)) {
this.checkExpandedStyle(aAnnotation);
}
}
/**
* Checks for expanded style type violations.
*
* @param aAnnotation the annotation token
*/
private void checkExpandedStyle(final DetailAST aAnnotation)
{
final int valuePairCount =
aAnnotation.getChildCount(TokenTypes.ANNOTATION_MEMBER_VALUE_PAIR);
if (valuePairCount == 0
&& aAnnotation.branchContains(TokenTypes.EXPR))
{
this.log(aAnnotation.getLineNo(), "annotation.incorrect.style",
ElementStyle.EXPANDED);
}
}
/**
* Checks for compact style type violations.
*
* @param aAnnotation the annotation token
*/
private void checkCompactStyle(final DetailAST aAnnotation)
{
final int valuePairCount =
aAnnotation.getChildCount(
TokenTypes.ANNOTATION_MEMBER_VALUE_PAIR);
final DetailAST valuePair =
aAnnotation.findFirstToken(
TokenTypes.ANNOTATION_MEMBER_VALUE_PAIR);
if (valuePairCount == 1
&& AnnotationUseStyleCheck.ANNOTATION_ELEMENT_SINGLE_NAME.equals(
valuePair.getFirstChild().getText()))
{
this.log(aAnnotation.getLineNo(), "annotation.incorrect.style",
ElementStyle.COMPACT);
}
}
/**
* Checks for compact no array style type violations.
*
* @param aAnnotation the annotation token
*/
private void checkCompactNoArrayStyle(final DetailAST aAnnotation)
{
final DetailAST arrayInit =
aAnnotation.findFirstToken(TokenTypes.ANNOTATION_ARRAY_INIT);
final int valuePairCount =
aAnnotation.getChildCount(TokenTypes.ANNOTATION_MEMBER_VALUE_PAIR);
final DetailAST valuePair =
aAnnotation.findFirstToken(TokenTypes.ANNOTATION_MEMBER_VALUE_PAIR);
//in compact style with one value
if (arrayInit != null
&& arrayInit.getChildCount(TokenTypes.EXPR) == 1)
{
this.log(aAnnotation.getLineNo(), "annotation.incorrect.style",
ElementStyle.COMPACT_NO_ARRAY);
}
//in expanded style with one value and the correct element name
else if (valuePairCount == 1) {
final DetailAST nestedArrayInit =
valuePair.findFirstToken(TokenTypes.ANNOTATION_ARRAY_INIT);
if (nestedArrayInit != null
&& AnnotationUseStyleCheck.
ANNOTATION_ELEMENT_SINGLE_NAME.equals(
valuePair.getFirstChild().getText())
&& nestedArrayInit.getChildCount(TokenTypes.EXPR) == 1)
{
this.log(aAnnotation.getLineNo(), "annotation.incorrect.style",
ElementStyle.COMPACT_NO_ARRAY);
}
}
}
/**
* Checks to see if the trailing comma is present if required or
* prohibited.
*
* @param aAnnotation the annotation token
*/
private void checkTrailingComma(final DetailAST aAnnotation)
{
if (TrailingArrayComma.IGNORE.equals(this.mComma)
|| this.mComma == null)
{
return;
}
DetailAST child = aAnnotation.getFirstChild();
while (child != null) {
DetailAST arrayInit = null;
if (child.getType()
== TokenTypes.ANNOTATION_MEMBER_VALUE_PAIR)
{
arrayInit =
child.findFirstToken(TokenTypes.ANNOTATION_ARRAY_INIT);
}
else if (child.getType() == TokenTypes.ANNOTATION_ARRAY_INIT) {
arrayInit = child;
}
if (arrayInit != null) {
this.logCommaViolation(arrayInit);
}
child = child.getNextSibling();
}
}
/**
* logs a trailing array comma violation if one exists.
*
* @param aAST the array init
* {@link TokenTypes#ANNOTATION_ARRAY_INIT ANNOTATION_ARRAY_INIT}.
*/
private void logCommaViolation(final DetailAST aAST)
{
final DetailAST rCurly = aAST.findFirstToken(TokenTypes.RCURLY);
//comma can be null if array is empty
final DetailAST comma = rCurly.getPreviousSibling();
if (TrailingArrayComma.ALWAYS.equals(this.mComma)
&& (comma == null || comma.getType() != TokenTypes.COMMA))
{
this.log(rCurly.getLineNo(),
rCurly.getColumnNo(), "annotation.trailing.comma.missing");
}
else if (TrailingArrayComma.NEVER.equals(this.mComma)
&& comma != null && comma.getType() == TokenTypes.COMMA)
{
this.log(comma.getLineNo(),
comma.getColumnNo(), "annotation.trailing.comma.present");
}
}
/**
* Checks to see if the closing parenthesis are present if required or
* prohibited.
*
* @param aAST the annotation token
*/
private void checkCheckClosingParens(final DetailAST aAST)
{
if (ClosingParens.IGNORE.equals(this.mParens)
|| this.mParens == null)
{
return;
}
final DetailAST paren = aAST.getLastChild();
final boolean parenExists = paren.getType() == TokenTypes.RPAREN;
if (ClosingParens.ALWAYS.equals(this.mParens)
&& !parenExists)
{
this.log(aAST.getLineNo(), "annotation.parens.missing");
}
else if (ClosingParens.NEVER.equals(this.mParens)
&& !aAST.branchContains(TokenTypes.EXPR)
&& parenExists)
{
this.log(aAST.getLineNo(), "annotation.parens.present");
}
}
/**
* Defines the styles for defining elements in an annotation.
* @author Travis Schneeberger
*/
public static enum ElementStyle {
/**
* expanded example
*
*
@SuppressWarnings(value={"unchecked","unused",})
.
*/
EXPANDED,
/**
* compact example
*
*
@SuppressWarnings({"unchecked","unused",})
* or
*
@SuppressWarnings("unchecked")
.
*/
COMPACT,
/**
* compact example.]
*
*
@SuppressWarnings("unchecked")
.
*/
COMPACT_NO_ARRAY,
/**
* mixed styles.
*/
IGNORE,
}
/**
* Defines the two styles for defining
* elements in an annotation.
*
* @author Travis Schneeberger
*/
public static enum TrailingArrayComma {
/**
* with comma example
*
*
@SuppressWarnings(value={"unchecked","unused",})
.
*/
ALWAYS,
/**
* without comma example
*
*
@SuppressWarnings(value={"unchecked","unused"})
.
*/
NEVER,
/**
* mixed styles.
*/
IGNORE,
}
/**
* Defines the two styles for defining
* elements in an annotation.
*
* @author Travis Schneeberger
*/
public static enum ClosingParens {
/**
* with parens example
*
*
@Deprecated()
.
*/
ALWAYS,
/**
* without parens example
*
*
@Deprecated
.
*/
NEVER,
/**
* mixed styles.
*/
IGNORE,
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/messages.properties 100644 0 0 2012 11451071612 31410 0 ustar 0 0 annotation.missing.deprecated=Must include both @java.lang.Deprecated annotation and @deprecated Javadoc tag with description.
annotation.missing.override=Must include @java.lang.Override annotation when '{'@inheritDoc'}' Javadoc tag exists.
annotation.not.valid.on=The annotation {0} is not valid at this location.
annotation.incorrect.style=Annotation style must be ''{0}''.
annotation.trailing.comma.missing=Annotation array values must contain trailing comma.
annotation.trailing.comma.present=Annotation array values cannot contain trailing comma.
annotation.parens.missing=Annotation must have closing parenthesis.
annotation.parens.present=Annotation cannot have closing parenthesis.
annotation.package.location=Package annotations must be in the package-info.java info.
suppressed.warning.not.allowed=The warning ''{0}'' cannot be suppressed at this location.
javadoc.duplicateTag=Duplicate {0} tag.
javadoc.missing=Missing a Javadoc comment.
tag.not.valid.on=The Javadoc {0} tag is not valid at this location.
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/messages_de.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/messages_de.properti100644 0 0 2 11451071612 31445 0 ustar 0 0
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/messages_es.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/messages_es.properti100644 0 0 4 11451071612 31466 0 ustar 0 0
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/messages_tr.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/messages_tr.properti100644 0 0 2645 11744664014 31612 0 ustar 0 0 #Generated by ResourceBundle Editor (http://eclipse-rbe.sourceforge.net)
annotation.incorrect.style = Anotasyon stili \u015Fu \u015Fekilde olmal\u0131: ''{0}''.
annotation.missing.deprecated = @java.lang.Deprecated anotasyonu ve @deprecated Javadoc etiketi (a\u00E7\u0131klamas\u0131yla birlikte) birlikte kullan\u0131lmal\u0131.
annotation.missing.override = @inheritDoc Javadoc etiketi kullan\u0131ld\u0131\u011F\u0131nda @java.lang.Override anotasyonu da kullan\u0131lmal\u0131.
annotation.not.valid.on = {0} anotasyonu bu konumda ge\u00E7erli de\u011Fil.
annotation.package.location = Paket anotasyonlar\u0131 package-info.java dosyas\u0131nda tan\u0131mlanmal\u0131.
annotation.parens.missing = Anotasyonun kapatma parantezi ('')'') olmal\u0131.
annotation.parens.present = Anotasyonun kapatma parantezi ('')'') olmamal\u0131.
annotation.trailing.comma.missing = Anotasyonun dizi de\u011Ferlerini takip eden bir virg\u00FCl kullan\u0131lmal\u0131d\u0131r.
annotation.trailing.comma.present = Anotasyonun dizi de\u011Ferlerini takip eden bir virg\u00FCl kullan\u0131lmamal\u0131d\u0131r.
javadoc.duplicateTag = Tekrarlanm\u0131\u015F {0} etiketi.
javadoc.missing = Javadoc a\u00E7\u0131klamas\u0131 eksik.
suppressed.warning.not.allowed = ''{0}'' uyar\u0131s\u0131 bu konumda bast\u0131r\u0131lamaz.
tag.not.valid.on = {0} Javadoc etiketi bu konumda ge\u00E7ersiz.
././@LongLink 100644 0 0 154 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/MissingDeprecatedCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/MissingDeprecatedChe100644 0 0 17771 12026051057 31462 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.annotation;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import com.puppycrawl.tools.checkstyle.api.AnnotationUtility;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.JavadocTagInfo;
import com.puppycrawl.tools.checkstyle.api.TextBlock;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
/**
*
* This class is used to verify that both the
* {@link java.lang.Deprecated Deprecated} annotation
* and the deprecated javadoc tag are present when
* either one is present.
*
*
*
* Both ways of flagging deprecation serve their own purpose. The
* {@link java.lang.Deprecated Deprecated} annotation is used for
* compilers and development tools. The deprecated javadoc tag is
* used to document why something is deprecated and what, if any,
* alternatives exist.
*
*
*
* In order to properly mark something as deprecated both forms of
* deprecation should be present.
*
*
*
* Package deprecation is a exception to the rule of always using the
* javadoc tag and annotation to deprecate. Only the package-info.java
* file can contain a Deprecated annotation and it CANNOT contain
* a deprecated javadoc tag. This is the case with
* Sun's javadoc tool released with JDK 1.6.0_11. As a result, this check
* does not deal with Deprecated packages in any way. No official
* documentation was found confirming this behavior is correct
* (of the javadoc tool).
*
*
*
* To configure this check do the following:
*
*
*
* <module name="JavadocDeprecated"/>
*
*
* @author Travis Schneeberger
*/
public final class MissingDeprecatedCheck extends Check
{
/** {@link Deprecated Deprecated} annotation name */
private static final String DEPRECATED = "Deprecated";
/** fully-qualified {@link Deprecated Deprecated} annotation name */
private static final String FQ_DEPRECATED = "java.lang." + DEPRECATED;
/** compiled regexp to match Javadoc tag with no argument * */
private static final Pattern MATCH_DEPRECATED =
Utils.createPattern("@(deprecated)\\s+\\S");
/** compiled regexp to match first part of multilineJavadoc tags * */
private static final Pattern MATCH_DEPRECATED_MULTILINE_START =
Utils.createPattern("@(deprecated)\\s*$");
/** compiled regexp to look for a continuation of the comment * */
private static final Pattern MATCH_DEPRECATED_MULTILINE_CONT =
Utils.createPattern("(\\*/|@|[^\\s\\*])");
/** Multiline finished at end of comment * */
private static final String END_JAVADOC = "*/";
/** Multiline finished at next Javadoc * */
private static final String NEXT_TAG = "@";
/** {@inheritDoc} */
@Override
public int[] getDefaultTokens()
{
return this.getAcceptableTokens();
}
/** {@inheritDoc} */
@Override
public int[] getAcceptableTokens()
{
return new int[] {
TokenTypes.INTERFACE_DEF,
TokenTypes.CLASS_DEF,
TokenTypes.ANNOTATION_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.CTOR_DEF,
TokenTypes.VARIABLE_DEF,
TokenTypes.ENUM_CONSTANT_DEF,
TokenTypes.ANNOTATION_FIELD_DEF,
};
}
/** {@inheritDoc} */
@Override
public void visitToken(final DetailAST aAST)
{
final TextBlock javadoc =
this.getFileContents().getJavadocBefore(aAST.getLineNo());
final boolean containsAnnotation =
AnnotationUtility.containsAnnotation(aAST, DEPRECATED)
|| AnnotationUtility.containsAnnotation(aAST, FQ_DEPRECATED);
final boolean containsJavadocTag = this.containsJavadocTag(javadoc);
if (containsAnnotation ^ containsJavadocTag) {
this.log(aAST.getLineNo(), "annotation.missing.deprecated");
}
}
/**
* Checks to see if the text block contains a deprecated tag.
*
* @param aJavadoc the javadoc of the AST
* @return true if contains the tag
*/
private boolean containsJavadocTag(final TextBlock aJavadoc)
{
if (aJavadoc == null) {
return false;
}
final String[] lines = aJavadoc.getText();
boolean found = false;
int currentLine = aJavadoc.getStartLineNo() - 1;
for (int i = 0; i < lines.length; i++) {
currentLine++;
final String line = lines[i];
final Matcher javadocNoargMatcher =
MissingDeprecatedCheck.MATCH_DEPRECATED.matcher(line);
final Matcher noargMultilineStart =
MissingDeprecatedCheck.
MATCH_DEPRECATED_MULTILINE_START.matcher(line);
if (javadocNoargMatcher.find()) {
if (found) {
this.log(currentLine, "javadoc.duplicateTag",
JavadocTagInfo.DEPRECATED.getText());
}
found = true;
}
else if (noargMultilineStart.find()) {
// Look for the rest of the comment if all we saw was
// the tag and the name. Stop when we see '*/' (end of
// Javadoc), '@' (start of next tag), or anything that's
// not whitespace or '*' characters.
for (int remIndex = i + 1;
remIndex < lines.length; remIndex++)
{
final Matcher multilineCont =
MissingDeprecatedCheck.MATCH_DEPRECATED_MULTILINE_CONT
.matcher(lines[remIndex]);
if (multilineCont.find()) {
remIndex = lines.length;
final String lFin = multilineCont.group(1);
if (!lFin.equals(MissingDeprecatedCheck.NEXT_TAG)
&& !lFin.equals(MissingDeprecatedCheck.END_JAVADOC))
{
if (found) {
this.log(currentLine, "javadoc.duplicateTag",
JavadocTagInfo.DEPRECATED.getText());
}
found = true;
}
else {
this.log(currentLine, "javadoc.missing");
if (found) {
this.log(currentLine, "javadoc.duplicateTag",
JavadocTagInfo.DEPRECATED.getText());
}
found = true;
}
}
}
}
}
return found;
}
}
././@LongLink 100644 0 0 152 12026055133 10246 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/MissingOverrideCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/MissingOverrideCheck100644 0 0 15167 12026051057 31514 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.annotation;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import com.puppycrawl.tools.checkstyle.api.AnnotationUtility;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.JavadocTagInfo;
import com.puppycrawl.tools.checkstyle.api.TextBlock;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
/**
*
* This class is used to verify that the {@link java.lang.Override Override}
* annotation is present when the inheritDoc javadoc tag is present.
*
*
*
* Rationale: The {@link java.lang.Override Override} annotation helps
* compiler tools ensure that an override is actually occurring. It is
* quite easy to accidentally overload a method or hide a static method
* and using the {@link java.lang.Override Override} annotation points
* out these problems.
*
*
*
* This check will log a violation if using the inheritDoc tag on a method that
* is not valid (ex: private, or static method).
*
*
*
* There is a slight difference between the Override annotation in Java 5 versus
* Java 6 and above. In Java 5, any method overridden from an interface cannot
* be annotated with Override. In Java 6 this behavior is allowed.
*
*
*
* As a result of the aforementioned difference between Java 5 and Java 6, a
* property called javaFiveCompatibility is available. This
* property will only check classes, interfaces, etc. that do not contain the
* extends or implements keyword or are not anonymous classes. This means it
* only checks methods overridden from java.lang.Object
*
* Java 5 Compatibility mode severely limits this check. It is recommended to
* only use it on Java 5 source
*
*
* @author Travis Schneeberger
*/
public final class MissingOverrideCheck extends Check
{
/** {@link Override Override} annotation name */
private static final String OVERRIDE = "Override";
/** fully-qualified {@link Override Override} annotation name */
private static final String FQ_OVERRIDE = "java.lang." + OVERRIDE;
/** compiled regexp to match Javadoc tags with no argument and {} * */
private static final Pattern MATCH_INHERITDOC =
Utils.createPattern("\\{\\s*@(inheritDoc)\\s*\\}");
/** @see MissingDeprecatedCheck#setJavaFiveCompatibility(boolean) */
private boolean mJavaFiveCompatibility;
/**
* Sets Java 5 compatibility mode.
*
*
* In Java 5, this check could flag code that is not valid for the Override
* annotation even though it is a proper override. See the class
* documentation for more information.
*
*
*
* Set this to true to turn on Java 5 compatibility mode. Set this to
* false to turn off Java 5 compatibility mode.
*
*
* @param aCompatibility compatibility or not
*/
public void setJavaFiveCompatibility(final boolean aCompatibility)
{
this.mJavaFiveCompatibility = aCompatibility;
}
/** {@inheritDoc} */
@Override
public int[] getDefaultTokens()
{
return this.getRequiredTokens();
}
/** {@inheritDoc} */
@Override
public int[] getAcceptableTokens()
{
return this.getRequiredTokens();
}
/** {@inheritDoc} */
@Override
public int[] getRequiredTokens()
{
return new int[]
{TokenTypes.METHOD_DEF, };
}
/** {@inheritDoc} */
@Override
public void visitToken(final DetailAST aAST)
{
final TextBlock javadoc =
this.getFileContents().getJavadocBefore(aAST.getLineNo());
final boolean containsTag = this.containsJavadocTag(javadoc);
if (containsTag && !JavadocTagInfo.INHERIT_DOC.isValidOn(aAST)) {
this.log(aAST.getLineNo(), "tag.not.valid.on",
JavadocTagInfo.INHERIT_DOC.getText());
return;
}
if (this.mJavaFiveCompatibility) {
final DetailAST defOrNew = aAST.getParent().getParent();
if (defOrNew.branchContains(TokenTypes.EXTENDS_CLAUSE)
|| defOrNew.branchContains(TokenTypes.IMPLEMENTS_CLAUSE)
|| defOrNew.getType() == TokenTypes.LITERAL_NEW)
{
return;
}
}
if (containsTag
&& (!AnnotationUtility.containsAnnotation(aAST, OVERRIDE)
&& !AnnotationUtility.containsAnnotation(aAST, FQ_OVERRIDE)))
{
this.log(aAST.getLineNo(), "annotation.missing.override");
}
}
/**
* Checks to see if the text block contains a inheritDoc tag.
*
* @param aJavadoc the javadoc of the AST
* @return true if contains the tag
*/
private boolean containsJavadocTag(final TextBlock aJavadoc)
{
if (aJavadoc == null) {
return false;
}
final String[] lines = aJavadoc.getText();
for (final String line : lines) {
final Matcher matchInheritDoc =
MissingOverrideCheck.MATCH_INHERITDOC.matcher(line);
if (matchInheritDoc.find()) {
return true;
}
}
return false;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/package-info.java 100644 0 0 2307 12026051057 30661 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* Contains the Annotation checks that are
* bundled with the main distribution.
*/
package com.puppycrawl.tools.checkstyle.checks.annotation;
././@LongLink 100644 0 0 154 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/PackageAnnotationCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/PackageAnnotationChe100644 0 0 5445 12026051057 31431 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.annotation;
import com.puppycrawl.tools.checkstyle.api.AnnotationUtility;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* This check makes sure that all package annotations are in the
* package-info.java file.
*
*
* According to the Java JLS 3rd ed.
*
*
*
* The JLS does not enforce the placement of package annotations.
* This placement may vary based on implementation. The JLS
* does highly recommend that all package annotations are
* placed in the package-info.java file.
*
* See
* Java Language specification, sections 7.4.1.1.
*
* @author Travis Schneeberger
*/
public class PackageAnnotationCheck extends Check
{
/** {@inheritDoc} */
@Override
public int[] getDefaultTokens()
{
return this.getRequiredTokens();
}
/** {@inheritDoc} */
@Override
public int[] getRequiredTokens()
{
return new int[] {
TokenTypes.PACKAGE_DEF,
};
}
/** {@inheritDoc} */
@Override
public int[] getAcceptableTokens()
{
return this.getRequiredTokens();
}
/** {@inheritDoc} */
@Override
public void visitToken(final DetailAST aAST)
{
final boolean containsAnnotation =
AnnotationUtility.containsAnnotation(aAST);
final boolean inPackageInfo =
this.getFileContents().inPackageInfo();
if (containsAnnotation && !inPackageInfo) {
this.log(aAST.getLine(), "annotation.package.location");
}
}
}
././@LongLink 100644 0 0 153 12026055133 10247 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/SuppressWarningsCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/annotation/SuppressWarningsChec100644 0 0 25025 12026051057 31557 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.annotation;
import java.util.regex.Matcher;
import com.puppycrawl.tools.checkstyle.api.AnnotationUtility;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck;
/**
*
* This check allows you to specify what warnings that
* {@link SuppressWarnings SuppressWarnings} is not
* allowed to suppress. You can also specify a list
* of TokenTypes that the configured warning(s) cannot
* be suppressed on.
*
*
*
* The {@link AbstractFormatCheck#setFormat warnings} property is a
* regex pattern. Any warning being suppressed matching
* this pattern will be flagged.
*
*
*
* By default, any warning specified will be disallowed on
* all legal TokenTypes unless otherwise specified via
* the
* {@link com.puppycrawl.tools.checkstyle.api.Check#setTokens(String[]) tokens}
* property.
*
* Also, by default warnings that are empty strings or all
* whitespace (regex: ^$|^\s+$) are flagged. By specifying,
* the format property these defaults no longer apply.
*
*
*
* Limitations: This check does not consider conditionals
* inside the SuppressWarnings annotation.
* For example:
* {@code @SupressWarnings((false) ? (true) ? "unchecked" : "foo" : "unused")}
* According to the above example, the "unused" warning is being suppressed
* not the "unchecked" or "foo" warnings. All of these warnings will be
* considered and matched against regardless of what the conditional
* evaluates to.
*
*
*
* This check can be configured so that the "unchecked"
* and "unused" warnings cannot be suppressed on
* anything but variable and parameter declarations.
* See below of an example.
*
* @author Travis Schneeberger
*/
public class SuppressWarningsCheck extends AbstractFormatCheck
{
/** {@link SuppressWarnings SuppressWarnings} annotation name */
private static final String SUPPRESS_WARNINGS = "SuppressWarnings";
/**
* fully-qualified {@link SuppressWarnings SuppressWarnings}
* annotation name
*/
private static final String FQ_SUPPRESS_WARNINGS =
"java.lang." + SUPPRESS_WARNINGS;
/**
* Ctor that specifies the default for the format property
* as specified in the class javadocs.
*/
public SuppressWarningsCheck()
{
super("^$|^\\s+$");
}
/** {@inheritDoc} */
@Override
public final int[] getDefaultTokens()
{
return this.getAcceptableTokens();
}
/** {@inheritDoc} */
@Override
public final int[] getAcceptableTokens()
{
return new int[] {
TokenTypes.CLASS_DEF,
TokenTypes.INTERFACE_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.ANNOTATION_DEF,
TokenTypes.ANNOTATION_FIELD_DEF,
TokenTypes.ENUM_CONSTANT_DEF,
TokenTypes.PARAMETER_DEF,
TokenTypes.VARIABLE_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.CTOR_DEF,
};
}
/** {@inheritDoc} */
@Override
public void visitToken(final DetailAST aAST)
{
final DetailAST annotation = this.getSuppressWarnings(aAST);
if (annotation == null) {
return;
}
final DetailAST warningHolder =
this.findWarningsHolder(annotation);
DetailAST warning = warningHolder.findFirstToken(TokenTypes.EXPR);
//rare case with empty array ex: @SuppressWarnings({})
if (warning == null) {
//check to see if empty warnings are forbidden -- are by default
this.logMatch(warningHolder.getLineNo(),
warningHolder.getColumnNo(), "");
return;
}
while (warning != null) {
if (warning.getType() == TokenTypes.EXPR) {
final DetailAST fChild = warning.getFirstChild();
//typical case
if (fChild.getType() == TokenTypes.STRING_LITERAL) {
final String warningText =
this.removeQuotes(warning.getFirstChild().getText());
this.logMatch(warning.getLineNo(),
warning.getColumnNo(), warningText);
//conditional case
//ex: @SupressWarnings((false) ? (true) ? "unchecked" : "foo" : "unused")
}
else if (fChild.getType() == TokenTypes.QUESTION) {
this.walkConditional(fChild);
}
else {
assert false : "Should never get here, type: "
+ fChild.getType() + " text: " + fChild.getText();
}
}
warning = warning.getNextSibling();
}
}
/**
* Gets the {@link SuppressWarnings SuppressWarnings} annotation
* that is annotating the AST. If the annotation does not exist
* this method will return {@code null}.
*
* @param aAST the AST
* @return the {@link SuppressWarnings SuppressWarnings} annotation
*/
private DetailAST getSuppressWarnings(DetailAST aAST)
{
final DetailAST annotation = AnnotationUtility.getAnnotation(
aAST, SuppressWarningsCheck.SUPPRESS_WARNINGS);
return (annotation != null) ? annotation
: AnnotationUtility.getAnnotation(
aAST, SuppressWarningsCheck.FQ_SUPPRESS_WARNINGS);
}
/**
* This method looks for a warning that matches a configured expression.
* If found it logs a violation at the given line and column number.
*
* @param aLineNo the line number
* @param aColNum the column number
* @param aWarningText the warning.
*/
private void logMatch(final int aLineNo,
final int aColNum, final String aWarningText)
{
final Matcher matcher = this.getRegexp().matcher(aWarningText);
if (matcher.matches()) {
this.log(aLineNo, aColNum,
"suppressed.warning.not.allowed", aWarningText);
}
}
/**
* Find the parent (holder) of the of the warnings (Expr).
*
* @param aAnnotation the annotation
* @return a Token representing the expr.
*/
private DetailAST findWarningsHolder(final DetailAST aAnnotation)
{
final DetailAST annValuePair =
aAnnotation.findFirstToken(TokenTypes.ANNOTATION_MEMBER_VALUE_PAIR);
final DetailAST annArrayInit;
if (annValuePair != null) {
annArrayInit =
annValuePair.findFirstToken(TokenTypes.ANNOTATION_ARRAY_INIT);
}
else {
annArrayInit =
aAnnotation.findFirstToken(TokenTypes.ANNOTATION_ARRAY_INIT);
}
if (annArrayInit != null) {
return annArrayInit;
}
return aAnnotation;
}
/**
* Strips a single double quote from the front and back of a string.
*
* For example:
*
* Input String = "unchecked"
*
* Output String = unchecked
*
* @param aWarning the warning string
* @return the string without two quotes
*/
private String removeQuotes(final String aWarning)
{
assert aWarning != null : "the aWarning was null";
assert aWarning.charAt(0) == '"';
assert aWarning.charAt(aWarning.length() - 1) == '"';
return aWarning.substring(1, aWarning.length() - 1);
}
/**
* Recursively walks a conditional expression checking the left
* and right sides, checking for matches and
* logging violations.
*
* @param aCond a Conditional type
* {@link TokenTypes#QUESTION QUESTION}
*/
private void walkConditional(final DetailAST aCond)
{
if (aCond.getType() != TokenTypes.QUESTION) {
final String warningText =
this.removeQuotes(aCond.getText());
this.logMatch(aCond.getLineNo(), aCond.getColumnNo(), warningText);
return;
}
this.walkConditional(this.getCondLeft(aCond));
this.walkConditional(this.getCondRight(aCond));
}
/**
* Retrieves the left side of a conditional.
*
* @param aCond aCond a conditional type
* {@link TokenTypes#QUESTION QUESTION}
* @return either the value
* or another conditional
*/
private DetailAST getCondLeft(final DetailAST aCond)
{
final DetailAST colon = aCond.findFirstToken(TokenTypes.COLON);
return colon.getPreviousSibling();
}
/**
* Retrieves the right side of a conditional.
*
* @param aCond a conditional type
* {@link TokenTypes#QUESTION QUESTION}
* @return either the value
* or another conditional
*/
private DetailAST getCondRight(final DetailAST aCond)
{
final DetailAST colon = aCond.findFirstToken(TokenTypes.COLON);
return colon.getNextSibling();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/ArrayTypeStyleCheck.java 100644 0 0 5536 12026051064 30067 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Checks the style of array type definitions.
* Some like Java-style: public static void main(String[] args)
* and some like C-style: public static void main(String args[])
*
* By default the Check enforces Java style.
* @author lkuehne
*/
public class ArrayTypeStyleCheck extends Check
{
/** controls whether to use Java or C style */
private boolean mJavaStyle = true;
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.ARRAY_DECLARATOR};
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST typeAST = aAST.getParent();
if (typeAST.getType() != TokenTypes.TYPE) {
return;
}
final DetailAST declAST = typeAST.getParent();
if (declAST.getType() == TokenTypes.METHOD_DEF) {
// Do not check method's return type.
// We have no alternatives here.
return;
}
final DetailAST variableAST = typeAST.getNextSibling();
if (variableAST != null) {
final boolean isJavaStyle =
(variableAST.getLineNo() > aAST.getLineNo())
|| (variableAST.getColumnNo() > aAST.getColumnNo());
if (isJavaStyle != mJavaStyle) {
log(aAST.getLineNo(), aAST.getColumnNo(), "array.type.style");
}
}
}
/**
* Controls whether to check for Java or C style.
* @param aJavaStyle true if Java style should be used.
*/
public void setJavaStyle(boolean aJavaStyle)
{
mJavaStyle = aJavaStyle;
}
}
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/AvoidNestedBlocksCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/AvoidNestedBlocksCheck.j100644 0 0 7303 12026051056 31251 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.blocks;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
* Finds nested blocks.
*
*
* For example this Check flags confusing code like
*
*
* public void guessTheOutput()
* {
* int whichIsWich = 0;
* {
* int whichIsWhich = 2;
* }
* System.out.println("value = " + whichIsWhich);
* }
*
*
* and debugging / refactoring leftovers such as
*
*
* A case in a switch statement does not implicitly form a block.
* Thus to be able to introduce local variables that have case scope
* it is necessary to open a nested block. This is supported, set
* the allowInSwitchCase property to true and include all statements
* of the case in the block.
*
*
*
* switch (a)
* {
* case 0:
* // Never OK, break outside block
* {
* x = 1;
* }
* break;
* case 1:
* // Never OK, statement outside block
* System.out.println("Hello");
* {
* x = 2;
* break;
* }
* case 1:
* // OK if allowInSwitchCase is true
* {
* System.out.println("Hello");
* x = 2;
* break;
* }
* }
*
*
* @author lkuehne
*/
public class AvoidNestedBlocksCheck extends Check
{
/**
* Whether nested blocks are allowed if they are the
* only child of a switch case.
*/
private boolean mAllowInSwitchCase;
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.SLIST};
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST parent = aAST.getParent();
if (parent.getType() == TokenTypes.SLIST) {
if (mAllowInSwitchCase
&& (parent.getParent().getType() == TokenTypes.CASE_GROUP)
&& (parent.getNumberOfChildren() == 1))
{
return;
}
log(aAST.getLineNo(), aAST.getColumnNo(), "block.nested");
}
}
/**
* Setter for allowInSwitchCase property.
* @param aAllowInSwitchCase whether nested blocks are allowed
* if they are the only child of a switch case.
*/
public void setAllowInSwitchCase(boolean aAllowInSwitchCase)
{
mAllowInSwitchCase = aAllowInSwitchCase;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/BlockOption.java 100644 0 0 3301 12026051056 27655 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.blocks;
/**
* Represents the policy for checking block statements.
* @see com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck
* @author Rick Giles
*/
public enum BlockOption
{
/**
* Represents the policy that there is some text in the block. For example:
*
*
* catch (Exception ex) {
* // This is a bad coding practice
* }
*
*/
TEXT,
/**
* Represents the policy that there is a statement in the block. For
* example:
*
*
* finally {
* lock.release();
* }
*
*/
STMT;
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/EmptyBlockCheck.java 100644 0 0 13547 12026051056 30476 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.blocks;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck;
/**
* Checks for empty blocks. The policy to verify is specified using the {@link
* BlockOption} class and defaults to {@link BlockOption#STMT}.
*
*
By default the check will check the following blocks:
* {@link TokenTypes#LITERAL_WHILE LITERAL_WHILE},
* {@link TokenTypes#LITERAL_TRY LITERAL_TRY},
* {@link TokenTypes#LITERAL_CATCH LITERAL_CATCH},
* {@link TokenTypes#LITERAL_FINALLY LITERAL_FINALLY},
* {@link TokenTypes#LITERAL_DO LITERAL_DO},
* {@link TokenTypes#LITERAL_IF LITERAL_IF},
* {@link TokenTypes#LITERAL_ELSE LITERAL_ELSE},
* {@link TokenTypes#LITERAL_FOR LITERAL_FOR},
* {@link TokenTypes#STATIC_INIT STATIC_INIT}.
*
*
*
An example of how to configure the check is:
*
*
* <module name="EmptyBlock"/>
*
*
*
An example of how to configure the check for the {@link
* BlockOption#TEXT} policy and only catch blocks is:
*
*
* @author Lars Kühne
*/
public class EmptyBlockCheck
extends AbstractOptionCheck
{
/**
* Creates a new EmptyBlockCheck instance.
*/
public EmptyBlockCheck()
{
super(BlockOption.STMT, BlockOption.class);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.LITERAL_WHILE,
TokenTypes.LITERAL_TRY,
TokenTypes.LITERAL_CATCH,
TokenTypes.LITERAL_FINALLY,
TokenTypes.LITERAL_DO,
TokenTypes.LITERAL_IF,
TokenTypes.LITERAL_ELSE,
TokenTypes.LITERAL_FOR,
TokenTypes.INSTANCE_INIT,
TokenTypes.STATIC_INIT,
// TODO: need to handle....
//TokenTypes.LITERAL_SWITCH,
//TODO: does this handle TokenTypes.LITERAL_SYNCHRONIZED?
};
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST slistAST = aAST.findFirstToken(TokenTypes.SLIST);
if (slistAST != null) {
if (getAbstractOption() == BlockOption.STMT) {
if (slistAST.getChildCount() <= 1) {
log(slistAST.getLineNo(),
slistAST.getColumnNo(),
"block.noStmt",
aAST.getText());
}
}
else if (getAbstractOption() == BlockOption.TEXT) {
if (!hasText(slistAST)) {
log(slistAST.getLineNo(),
slistAST.getColumnNo(),
"block.empty",
aAST.getText());
}
}
}
}
/**
* @param aSlistAST a DetailAST value
* @return whether the SLIST token contains any text.
*/
protected boolean hasText(final DetailAST aSlistAST)
{
boolean retVal = false;
final DetailAST rcurlyAST = aSlistAST.findFirstToken(TokenTypes.RCURLY);
if (rcurlyAST != null) {
final int slistLineNo = aSlistAST.getLineNo();
final int slistColNo = aSlistAST.getColumnNo();
final int rcurlyLineNo = rcurlyAST.getLineNo();
final int rcurlyColNo = rcurlyAST.getColumnNo();
final String[] lines = getLines();
if (slistLineNo == rcurlyLineNo) {
// Handle braces on the same line
final String txt = lines[slistLineNo - 1]
.substring(slistColNo + 1, rcurlyColNo);
if (txt.trim().length() != 0) {
retVal = true;
}
}
else {
// check only whitespace of first & last lines
if ((lines[slistLineNo - 1]
.substring(slistColNo + 1).trim().length() != 0)
|| (lines[rcurlyLineNo - 1]
.substring(0, rcurlyColNo).trim().length() != 0))
{
retVal = true;
}
else {
// check if all lines are also only whitespace
for (int i = slistLineNo; i < (rcurlyLineNo - 1); i++) {
if (lines[i].trim().length() > 0) {
retVal = true;
break;
}
}
}
}
}
return retVal;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/LeftCurlyCheck.java 100644 0 0 25632 12026051056 30334 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.blocks;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
import com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck;
/**
*
* Checks the placement of left curly braces on types, methods and
* other blocks:
* {@link TokenTypes#LITERAL_CATCH LITERAL_CATCH}, {@link
* TokenTypes#LITERAL_DO LITERAL_DO}, {@link TokenTypes#LITERAL_ELSE
* LITERAL_ELSE}, {@link TokenTypes#LITERAL_FINALLY LITERAL_FINALLY}, {@link
* TokenTypes#LITERAL_FOR LITERAL_FOR}, {@link TokenTypes#LITERAL_IF
* LITERAL_IF}, {@link TokenTypes#LITERAL_SWITCH LITERAL_SWITCH}, {@link
* TokenTypes#LITERAL_SYNCHRONIZED LITERAL_SYNCHRONIZED}, {@link
* TokenTypes#LITERAL_TRY LITERAL_TRY}, {@link TokenTypes#LITERAL_WHILE
* LITERAL_WHILE}.
*
*
*
* The policy to verify is specified using the {@link LeftCurlyOption} class and
* defaults to {@link LeftCurlyOption#EOL}. Policies {@link LeftCurlyOption#EOL}
* and {@link LeftCurlyOption#NLOW} take into account property maxLineLength.
* The default value for maxLineLength is 80.
*
*
* An example of how to configure the check is:
*
*
* <module name="LeftCurly"/>
*
*
* An example of how to configure the check with policy
* {@link LeftCurlyOption#NLOW} and maxLineLength 120 is:
*
*
* @author Oliver Burn
* @author lkuehne
* @version 1.0
*/
public class LeftCurlyCheck
extends AbstractOptionCheck
{
/** default maximum line length */
private static final int DEFAULT_MAX_LINE_LENGTH = 80;
/** TODO: replace this ugly hack **/
private int mMaxLineLength = DEFAULT_MAX_LINE_LENGTH;
/**
* Creates a default instance and sets the policy to EOL.
*/
public LeftCurlyCheck()
{
super(LeftCurlyOption.EOL, LeftCurlyOption.class);
}
/**
* Sets the maximum line length used in calculating the placement of the
* left curly brace.
* @param aMaxLineLength the max allowed line length
*/
public void setMaxLineLength(int aMaxLineLength)
{
mMaxLineLength = aMaxLineLength;
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.INTERFACE_DEF,
TokenTypes.CLASS_DEF,
TokenTypes.ANNOTATION_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.CTOR_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.ENUM_CONSTANT_DEF,
TokenTypes.LITERAL_WHILE,
TokenTypes.LITERAL_TRY,
TokenTypes.LITERAL_CATCH,
TokenTypes.LITERAL_FINALLY,
TokenTypes.LITERAL_SYNCHRONIZED,
TokenTypes.LITERAL_SWITCH,
TokenTypes.LITERAL_DO,
TokenTypes.LITERAL_IF,
TokenTypes.LITERAL_ELSE,
TokenTypes.LITERAL_FOR,
// TODO: need to handle....
//TokenTypes.STATIC_INIT,
};
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST startToken;
final DetailAST brace;
switch (aAST.getType()) {
case TokenTypes.CTOR_DEF :
case TokenTypes.METHOD_DEF :
startToken = skipAnnotationOnlyLines(aAST);
brace = aAST.findFirstToken(TokenTypes.SLIST);
break;
case TokenTypes.INTERFACE_DEF :
case TokenTypes.CLASS_DEF :
case TokenTypes.ANNOTATION_DEF :
case TokenTypes.ENUM_DEF :
case TokenTypes.ENUM_CONSTANT_DEF :
startToken = skipAnnotationOnlyLines(aAST);
final DetailAST objBlock = aAST.findFirstToken(TokenTypes.OBJBLOCK);
brace = (objBlock == null)
? null
: (DetailAST) objBlock.getFirstChild();
break;
case TokenTypes.LITERAL_WHILE:
case TokenTypes.LITERAL_CATCH:
case TokenTypes.LITERAL_SYNCHRONIZED:
case TokenTypes.LITERAL_FOR:
case TokenTypes.LITERAL_TRY:
case TokenTypes.LITERAL_FINALLY:
case TokenTypes.LITERAL_DO:
case TokenTypes.LITERAL_IF :
startToken = aAST;
brace = aAST.findFirstToken(TokenTypes.SLIST);
break;
case TokenTypes.LITERAL_ELSE :
startToken = aAST;
final DetailAST candidate = aAST.getFirstChild();
brace =
(candidate.getType() == TokenTypes.SLIST)
? candidate
: null; // silently ignore
break;
case TokenTypes.LITERAL_SWITCH :
startToken = aAST;
brace = aAST.findFirstToken(TokenTypes.LCURLY);
break;
default :
startToken = null;
brace = null;
}
if ((brace != null) && (startToken != null)) {
verifyBrace(brace, startToken);
}
}
/**
* Skip lines that only contain TokenTypes.ANNOTATIONs.
* If the received DetailAST
* has annotations within its modifiers then first token on the line
* of the first token afer all annotations is return. This might be
* an annotation.
* Otherwise, the received DetailAST is returned.
* @param aAST DetailAST.
* @return DetailAST.
*/
private DetailAST skipAnnotationOnlyLines(DetailAST aAST)
{
final DetailAST modifiers = aAST.findFirstToken(TokenTypes.MODIFIERS);
if (modifiers == null) {
return aAST;
}
DetailAST lastAnnot = findLastAnnotation(modifiers);
if (lastAnnot == null) {
// There are no annotations.
return aAST;
}
final DetailAST tokenAfterLast = lastAnnot.getNextSibling() != null
? lastAnnot.getNextSibling()
: modifiers.getNextSibling();
if (tokenAfterLast.getLineNo() > lastAnnot.getLineNo()) {
return tokenAfterLast;
}
final int lastAnnotLineNumber = lastAnnot.getLineNo();
while (lastAnnot.getPreviousSibling() != null
&& (lastAnnot.getPreviousSibling().getLineNo()
== lastAnnotLineNumber))
{
lastAnnot = lastAnnot.getPreviousSibling();
}
return lastAnnot;
}
/**
* Find the last token of type TokenTypes.ANNOTATION
* under the given set of modifiers.
* @param aModifiers DetailAST.
* @return DetailAST or null if there are no annotations.
*/
private DetailAST findLastAnnotation(DetailAST aModifiers)
{
DetailAST aAnnot = aModifiers.findFirstToken(TokenTypes.ANNOTATION);
while (aAnnot != null && aAnnot.getNextSibling() != null
&& aAnnot.getNextSibling().getType() == TokenTypes.ANNOTATION)
{
aAnnot = aAnnot.getNextSibling();
}
return aAnnot;
}
/**
* Verifies that a specified left curly brace is placed correctly
* according to policy.
* @param aBrace token for left curly brace
* @param aStartToken token for start of expression
*/
private void verifyBrace(final DetailAST aBrace,
final DetailAST aStartToken)
{
final String braceLine = getLines()[aBrace.getLineNo() - 1];
// calculate the previous line length without trailing whitespace. Need
// to handle the case where there is no previous line, cause the line
// being check is the first line in the file.
final int prevLineLen = (aBrace.getLineNo() == 1)
? mMaxLineLength
: Utils.lengthMinusTrailingWhitespace(
getLines()[aBrace.getLineNo() - 2]);
// Check for being told to ignore, or have '{}' which is a special case
if ((braceLine.length() > (aBrace.getColumnNo() + 1))
&& (braceLine.charAt(aBrace.getColumnNo() + 1) == '}'))
{
; // ignore
}
else if (getAbstractOption() == LeftCurlyOption.NL) {
if (!Utils.whitespaceBefore(aBrace.getColumnNo(), braceLine)) {
log(aBrace.getLineNo(), aBrace.getColumnNo(),
"line.new", "{");
}
}
else if (getAbstractOption() == LeftCurlyOption.EOL) {
if (Utils.whitespaceBefore(aBrace.getColumnNo(), braceLine)
&& ((prevLineLen + 2) <= mMaxLineLength))
{
log(aBrace.getLineNo(), aBrace.getColumnNo(),
"line.previous", "{");
}
}
else if (getAbstractOption() == LeftCurlyOption.NLOW) {
if (aStartToken.getLineNo() == aBrace.getLineNo()) {
; // all ok as on the same line
}
else if ((aStartToken.getLineNo() + 1) == aBrace.getLineNo()) {
if (!Utils.whitespaceBefore(aBrace.getColumnNo(), braceLine)) {
log(aBrace.getLineNo(), aBrace.getColumnNo(),
"line.new", "{");
}
else if ((prevLineLen + 2) <= mMaxLineLength) {
log(aBrace.getLineNo(), aBrace.getColumnNo(),
"line.previous", "{");
}
}
else if (!Utils.whitespaceBefore(aBrace.getColumnNo(), braceLine)) {
log(aBrace.getLineNo(), aBrace.getColumnNo(),
"line.new", "{");
}
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/LeftCurlyOption.java 100644 0 0 4450 12026051055 30541 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.blocks;
/**
* Represents the options for placing the left curly brace '{'.
*
* @author Oliver Burn
* @version 1
*/
public enum LeftCurlyOption
{
/**
* Represents the policy for placing the brace at the end of line. For
* example:
*
* if (condition) {
* ...
*
**/
EOL,
/**
* Represents the policy that if the brace will fit on the first line of
* the statement, taking into account maximum line length, then apply
* EOL rule. Otherwise apply the NL
* rule. NLOW is a mnemonic for "new line on wrap".
*
*
For the example above Checkstyle will enforce:
*
*
* if (condition) {
* ...
*
*
* But for a statement spanning multiple lines, Checkstyle will enforce:
*
*
**/
NLOW,
/**
* Represents the policy that the brace must always be on a new line. For
* example:
*
* if (condition)
* {
* ...
*
*/
NL;
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/messages.properties 100644 0 0 551 11451071612 30501 0 ustar 0 0 block.empty=Empty {0} block.
block.nested=Avoid nested blocks.
block.noStmt=Must have at least one statement.
line.alone=''{0}'' should be alone on a line.
line.new=''{0}'' should be on a new line.
line.previous=''{0}'' should be on the previous line.
line.same=''{0}'' should be on the same line.
needBraces=''{0}'' construct must use '''{}'''s.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/messages_de.properties 100644 0 0 667 11451071612 31161 0 ustar 0 0 block.empty=Leerer {0}-Block.
block.nested=Verschachtelte Blöcke sollten vermieden werden.
block.noStmt=Muss mindestens ein Statement beinhalten.
line.alone=''{0}'' sollte allein in der Zeile stehen.
line.new=''{0}'' sollte in einer neuen Zeile stehen.
line.previous=''{0}'' sollte in der vorhergehenden Zeile stehen.
line.same=''{0}'' sollte in derselben Zeile stehen.
needBraces=Das ''{0}''-Konstrukt muss '''{}''' benutzen.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/messages_es.properties 100644 0 0 625 11451071612 31172 0 ustar 0 0 block.empty=Bloque {0} vacío.
block.nested=Evitar bloques anidados.
block.noStmt=Debe tener al menos una sentencia.
line.alone=''{0}'' debería estar solo en una línea.
line.new=''{0}'' debería estar en una nueva línea.
line.previous=''{0}'' debería estar en la línea anterior.
line.same=''{0}'' debería estar en la misma línea.
needBraces=La construcción ''{0}'' debe usar '''{}'' (llaves).
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/messages_fi.properties 100644 0 0 607 11451071612 31161 0 ustar 0 0 block.empty=Tyhj¤ {0}-rakenne.
block.nested=Avoid nested blocks.
block.noStmt=Pit¤¤ olla ainakin yksi lause.
line.alone=''{0}'' pit¤¤ olla yksin¤¤n rivill¤.
line.new=''{0}'' pit¤¤ olla uudella rivill¤.
line.previous=''{0}'' pit¤¤ olla edellisell¤ rivill¤.
line.same=''{0}'' pit¤¤ olla samalla rivill¤.
needBraces=''{0}''-rakenteen pit¤¤ k¤ytt¤¤ '''{}'':a.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/messages_fr.properties 100644 0 0 706 11451071612 31172 0 ustar 0 0 block.empty=Bloc ''{0}'' vide.
block.nested=Evitez d''imbriquer les blocs.
block.noStmt=Le bloc devrait contenir au moins une instruction.
line.alone=''{0}'' devrait être seul sur sa ligne.
line.new=''{0}'' devrait être sur une nouvelle ligne.
line.previous=''{0}'' devrait être sur la ligne précédente.
line.same=''{0}'' devrait être sur la même ligne.
needBraces=L''instruction ''{0}'' devrait utiliser des accolades ('''{''' et '''}''').
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/messages_ja.properties 100644 0 0 1471 11451071612 31175 0 ustar 0 0
block.empty=\u7a7a\u306e {0} \u30d6\u30ed\u30c3\u30af\u3067\u3059\u3002
block.nested=\u30cd\u30b9\u30c8\u3057\u305f\u30d6\u30ed\u30c3\u30af\u306f\u907f\u3051\u3066\u304f\u3060\u3055\u3044\u3002
block.noStmt=\u5c11\u306a\u304f\u3068\u30821\u6587\u306f\u3042\u308b\u306f\u305a\u3067\u3059\u3002
line.alone=''{0}'' \u306f\u72ec\u7acb\u3057\u305f\u884c\u306b\u3042\u308b\u3079\u304d\u3067\u3059\u3002
line.new=''{0}'' \u306f\u65b0\u3057\u3044\u884c\u306b\u3042\u308b\u3079\u304d\u3067\u3059\u3002
line.previous=''{0}'' \u306f\u524d\u306e\u884c\u306b\u3042\u308b\u3079\u304d\u3067\u3059\u3002
line.same=''{0}'' \u306f\u540c\u4e00\u884c\u306b\u3042\u308b\u3079\u304d\u3067\u3059\u3002
needBraces=''{0}'' \u6587\u3067\u306f '''{}''' \u3092\u4f7f\u7528\u3057\u306a\u3051\u308c\u3070\u306a\u308a\u307e\u305b\u3093\u3002
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/messages_pt.properties 100644 0 0 601 11451071612 31200 0 ustar 0 0 block.empty=Block {0} vazio.
block.nested=Avoid nested blocks.
block.noStmt=Tem que ter pelo menos uma instruço.
line.alone=''{0}'' deve estar sozinho numa linha.
line.new=''{0}'' deve estar numa nova linha.
line.previous=''{0}'' deve estar na linha anterior.
line.same=''{0}'' deve estar na mesma linha.
needBraces=A estrutura sintáctica ''{0}'' deve utilizar '''{}'''s.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/messages_tr.properties 100644 0 0 1172 11744664014 31237 0 ustar 0 0 #Generated by ResourceBundle Editor (http://eclipse-rbe.sourceforge.net)
block.empty = Bo\u015F blok bulundu: {0}
block.nested = \u0130\u00E7 i\u00E7e bloklar kullan\u0131lmamal\u0131d\u0131r.
block.noStmt = Blok en az bir ifade i\u00E7ermeli.
line.alone = ''{0}'' ifadesi sat\u0131rda tek ba\u015F\u0131na olmal\u0131.
line.new = ''{0}'' ifadesi yeni sat\u0131rda olmal\u0131.
line.previous = ''{0}'' ifadesi \u00F6nceki sat\u0131rda olmal\u0131.
line.same = ''{0}'' ifadesi ayn\u0131 sat\u0131rda olmal\u0131.
needBraces = ''{0}'' yap\u0131s\u0131 s\u00FCsl\u00FC parantezler ('''{}''') kullanmal\u0131.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/NeedBracesCheck.java 100644 0 0 5536 12026051055 30376 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.blocks;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks for braces around code blocks.
*
*
By default the check will check the following blocks:
* {@link TokenTypes#LITERAL_DO LITERAL_DO},
* {@link TokenTypes#LITERAL_ELSE LITERAL_ELSE},
* {@link TokenTypes#LITERAL_FOR LITERAL_FOR},
* {@link TokenTypes#LITERAL_IF LITERAL_IF},
* {@link TokenTypes#LITERAL_WHILE LITERAL_WHILE}.
*
*
* An example of how to configure the check is:
*
*
* <module name="NeedBraces"/>
*
*
An example of how to configure the check for if and
* else blocks is:
*
*
* @author Rick Giles
* @version 1.0
*/
public class NeedBracesCheck extends Check
{
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.LITERAL_DO,
TokenTypes.LITERAL_ELSE,
TokenTypes.LITERAL_FOR,
TokenTypes.LITERAL_IF,
TokenTypes.LITERAL_WHILE,
};
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST slistAST = aAST.findFirstToken(TokenTypes.SLIST);
boolean isElseIf = false;
if ((aAST.getType() == TokenTypes.LITERAL_ELSE)
&& (aAST.findFirstToken(TokenTypes.LITERAL_IF) != null))
{
isElseIf = true;
}
if ((slistAST == null) && !isElseIf) {
log(aAST.getLineNo(), "needBraces", aAST.getText());
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/package-info.java 100644 0 0 2276 12026051054 27766 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* Contains the Block checks that are
* bundled with the main distribution.
*/
package com.puppycrawl.tools.checkstyle.checks.blocks;
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/RightCurlyCheck.java 100644 0 0 15453 12026051055 30516 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.blocks;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
import com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
/**
*
* Checks the placement of right curly braces.
* The policy to verify is specified using the {@link RightCurlyOption} class
* and defaults to {@link RightCurlyOption#SAME}.
*
*
By default the check will check the following tokens:
* {@link TokenTypes#LITERAL_TRY LITERAL_TRY}.
* {@link TokenTypes#LITERAL_CATCH LITERAL_CATCH},
* {@link TokenTypes#LITERAL_FINALLY LITERAL_FINALLY}.
* {@link TokenTypes#LITERAL_IF LITERAL_IF},
* {@link TokenTypes#LITERAL_ELSE LITERAL_ELSE},
*
*
* An example of how to configure the check is:
*
*
* <module name="RightCurly"/>
*
*
* An example of how to configure the check with policy
* {@link RightCurlyOption#ALONE} for else tokens is:
*
*
* @author Oliver Burn
* @author lkuehne
* @author o_sukhodolsky
* @version 2.0
*/
public class RightCurlyCheck extends AbstractOptionCheck
{
/** Do we need to check if rculry starts line. */
private boolean mShouldStartLine = true;
/**
* Sets the right curly option to same.
*/
public RightCurlyCheck()
{
super(RightCurlyOption.SAME, RightCurlyOption.class);
}
/**
* Does the check need to check if rcurly starts line.
* @param aFlag new value of this property.
*/
public void setShouldStartLine(boolean aFlag)
{
mShouldStartLine = aFlag;
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.LITERAL_TRY,
TokenTypes.LITERAL_CATCH,
TokenTypes.LITERAL_FINALLY,
TokenTypes.LITERAL_IF,
TokenTypes.LITERAL_ELSE,
};
}
@Override
public void visitToken(DetailAST aAST)
{
// Attempt to locate the tokens to do the check
DetailAST rcurly;
DetailAST lcurly;
DetailAST nextToken;
boolean shouldCheckLastRcurly = false;
switch (aAST.getType()) {
case TokenTypes.LITERAL_TRY:
lcurly = aAST.getFirstChild();
nextToken = lcurly.getNextSibling();
rcurly = lcurly.getLastChild();
break;
case TokenTypes.LITERAL_CATCH:
nextToken = aAST.getNextSibling();
lcurly = aAST.getLastChild();
rcurly = lcurly.getLastChild();
if (nextToken == null) {
shouldCheckLastRcurly = true;
nextToken = getNextToken(aAST);
}
break;
case TokenTypes.LITERAL_IF:
nextToken = aAST.findFirstToken(TokenTypes.LITERAL_ELSE);
if (nextToken != null) {
lcurly = nextToken.getPreviousSibling();
rcurly = lcurly.getLastChild();
}
else {
shouldCheckLastRcurly = true;
nextToken = getNextToken(aAST);
lcurly = aAST.getLastChild();
rcurly = lcurly.getLastChild();
}
break;
case TokenTypes.LITERAL_ELSE:
shouldCheckLastRcurly = true;
nextToken = getNextToken(aAST);
lcurly = aAST.getFirstChild();
rcurly = lcurly.getLastChild();
break;
case TokenTypes.LITERAL_FINALLY:
shouldCheckLastRcurly = true;
nextToken = getNextToken(aAST);
lcurly = aAST.getFirstChild();
rcurly = lcurly.getLastChild();
break;
default:
throw new RuntimeException("Unexpected token type ("
+ TokenTypes.getTokenName(aAST.getType()) + ")");
}
if ((rcurly == null) || (rcurly.getType() != TokenTypes.RCURLY)) {
// we need to have both tokens to perform the check
return;
}
if (shouldCheckLastRcurly) {
if (rcurly.getLineNo() == nextToken.getLineNo()) {
log(rcurly, "line.alone", "}");
}
}
else if ((getAbstractOption() == RightCurlyOption.SAME)
&& (rcurly.getLineNo() != nextToken.getLineNo()))
{
log(rcurly, "line.same", "}");
}
else if ((getAbstractOption() == RightCurlyOption.ALONE)
&& (rcurly.getLineNo() == nextToken.getLineNo()))
{
log(rcurly, "line.alone", "}");
}
if (!mShouldStartLine) {
return;
}
final boolean startsLine =
Utils.whitespaceBefore(rcurly.getColumnNo(),
getLines()[rcurly.getLineNo() - 1]);
if (!startsLine && (lcurly.getLineNo() != rcurly.getLineNo())) {
log(rcurly, "line.new", "}");
}
}
/**
* Finds next token after the given one.
* @param aAST the given node.
* @return the token which represents next lexical item.
*/
private DetailAST getNextToken(DetailAST aAST)
{
DetailAST next = null;
DetailAST parent = aAST;
while ((parent != null) && (next == null)) {
next = parent.getNextSibling();
parent = parent.getParent();
}
return CheckUtils.getFirstNode(next);
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/blocks/RightCurlyOption.java 100644 0 0 3255 12026051055 30726 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.blocks;
/**
* Represents the options for placing the right curly brace '}'.
*
* @author Oliver Burn
* @version 1
*/
public enum RightCurlyOption
{
/**
* Represents the policy that the brace must be alone on the line. For
* example:
*
*
* try {
* ...
* }
* finally {
*
**/
ALONE,
/**
* Represents the policy that the brace must be on the same line as the
* next statement. For example:
*
*
* try {
* ...
* } finally {
*
**/
SAME;
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/CheckUtils.java 100644 0 0 27346 12026051064 26251 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import com.google.common.collect.Lists;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.util.List;
/**
* Contains utility methods for the checks.
*
* @author Oliver Burn
* @author Simon Harris
* @author o_sukhodolsky
*/
public final class CheckUtils
{
/** prevent instances */
private CheckUtils()
{
throw new UnsupportedOperationException();
}
/**
* Tests whether a method definition AST defines an equals covariant.
* @param aAST the method definition AST to test.
* Precondition: aAST is a TokenTypes.METHOD_DEF node.
* @return true if aAST defines an equals covariant.
*/
public static boolean isEqualsMethod(DetailAST aAST)
{
if (aAST.getType() != TokenTypes.METHOD_DEF) {
// A node must be method def
return false;
}
// non-static, non-abstract?
final DetailAST modifiers = aAST.findFirstToken(TokenTypes.MODIFIERS);
if (modifiers.branchContains(TokenTypes.LITERAL_STATIC)
|| modifiers.branchContains(TokenTypes.ABSTRACT))
{
return false;
}
// named "equals"?
final DetailAST nameNode = aAST.findFirstToken(TokenTypes.IDENT);
final String name = nameNode.getText();
if (!"equals".equals(name)) {
return false;
}
// one parameter?
final DetailAST paramsNode = aAST.findFirstToken(TokenTypes.PARAMETERS);
return (paramsNode.getChildCount() == 1);
}
/**
* Returns whether a token represents an ELSE as part of an ELSE / IF set.
* @param aAST the token to check
* @return whether it is
*/
public static boolean isElseIf(DetailAST aAST)
{
final DetailAST parentAST = aAST.getParent();
return (aAST.getType() == TokenTypes.LITERAL_IF)
&& (isElse(parentAST) || isElseWithCurlyBraces(parentAST));
}
/**
* Returns whether a token represents an ELSE.
* @param aAST the token to check
* @return whether the token represents an ELSE
*/
private static boolean isElse(DetailAST aAST)
{
return aAST.getType() == TokenTypes.LITERAL_ELSE;
}
/**
* Returns whether a token represents an SLIST as part of an ELSE
* statement.
* @param aAST the token to check
* @return whether the toke does represent an SLIST as part of an ELSE
*/
private static boolean isElseWithCurlyBraces(DetailAST aAST)
{
return (aAST.getType() == TokenTypes.SLIST)
&& (aAST.getChildCount() == 2)
&& isElse(aAST.getParent());
}
/**
* Creates FullIdent for given type node.
* @param aTypeAST a type node.
* @return FullIdent for given type.
*/
public static FullIdent createFullType(DetailAST aTypeAST)
{
final DetailAST arrayDeclAST =
aTypeAST.findFirstToken(TokenTypes.ARRAY_DECLARATOR);
return createFullTypeNoArrays(arrayDeclAST == null ? aTypeAST
: arrayDeclAST);
}
/**
* @param aTypeAST a type node (no array)
* @return FullIdent for given type.
*/
private static FullIdent createFullTypeNoArrays(DetailAST aTypeAST)
{
return FullIdent.createFullIdent(aTypeAST.getFirstChild());
}
// constants for parseDouble()
/** octal radix */
private static final int BASE_8 = 8;
/** decimal radix */
private static final int BASE_10 = 10;
/** hex radix */
private static final int BASE_16 = 16;
/**
* Returns the value represented by the specified string of the specified
* type. Returns 0 for types other than float, double, int, and long.
* @param aText the string to be parsed.
* @param aType the token type of the text. Should be a constant of
* {@link com.puppycrawl.tools.checkstyle.api.TokenTypes}.
* @return the double value represented by the string argument.
*/
public static double parseDouble(String aText, int aType)
{
String txt = aText;
double result = 0;
switch (aType) {
case TokenTypes.NUM_FLOAT:
case TokenTypes.NUM_DOUBLE:
result = Double.parseDouble(txt);
break;
case TokenTypes.NUM_INT:
case TokenTypes.NUM_LONG:
int radix = BASE_10;
if (txt.startsWith("0x") || txt.startsWith("0X")) {
radix = BASE_16;
txt = txt.substring(2);
}
else if (txt.charAt(0) == '0') {
radix = BASE_8;
txt = txt.substring(1);
}
if ((txt.endsWith("L")) || (txt.endsWith("l"))) {
txt = txt.substring(0, txt.length() - 1);
}
if (txt.length() > 0) {
if (aType == TokenTypes.NUM_INT) {
result = parseInt(txt, radix);
}
else {
result = parseLong(txt, radix);
}
}
break;
default:
break;
}
return result;
}
/**
* Parses the string argument as a signed integer in the radix specified by
* the second argument. The characters in the string must all be digits of
* the specified radix. Handles negative values, which method
* java.lang.Integer.parseInt(String, int) does not.
* @param aText the String containing the integer representation to be
* parsed. Precondition: aText contains a parsable int.
* @param aRadix the radix to be used while parsing aText.
* @return the integer represented by the string argument in the specified
* radix.
*/
public static int parseInt(String aText, int aRadix)
{
int result = 0;
final int max = aText.length();
for (int i = 0; i < max; i++) {
final int digit = Character.digit(aText.charAt(i), aRadix);
result *= aRadix;
result += digit;
}
return result;
}
/**
* Parses the string argument as a signed long in the radix specified by
* the second argument. The characters in the string must all be digits of
* the specified radix. Handles negative values, which method
* java.lang.Integer.parseInt(String, int) does not.
* @param aText the String containing the integer representation to be
* parsed. Precondition: aText contains a parsable int.
* @param aRadix the radix to be used while parsing aText.
* @return the long represented by the string argument in the specified
* radix.
*/
public static long parseLong(String aText, int aRadix)
{
long result = 0;
final int max = aText.length();
for (int i = 0; i < max; i++) {
final int digit = Character.digit(aText.charAt(i), aRadix);
result *= aRadix;
result += digit;
}
return result;
}
/**
* Returns the value represented by the specified string of the specified
* type. Returns 0 for types other than float, double, int, and long.
* @param aText the string to be parsed.
* @param aType the token type of the text. Should be a constant of
* {@link com.puppycrawl.tools.checkstyle.api.TokenTypes}.
* @return the float value represented by the string argument.
*/
public static double parseFloat(String aText, int aType)
{
return (float) parseDouble(aText, aType);
}
/**
* Finds sub-node for given node minimal (line, column) pair.
* @param aNode the root of tree for search.
* @return sub-node with minimal (line, column) pair.
*/
public static DetailAST getFirstNode(final DetailAST aNode)
{
DetailAST currentNode = aNode;
DetailAST child = aNode.getFirstChild();
while (child != null) {
final DetailAST newNode = getFirstNode(child);
if ((newNode.getLineNo() < currentNode.getLineNo())
|| ((newNode.getLineNo() == currentNode.getLineNo())
&& (newNode.getColumnNo() < currentNode.getColumnNo())))
{
currentNode = newNode;
}
child = child.getNextSibling();
}
return currentNode;
}
/**
* Retrieves the names of the type parameters to the node.
* @param aNode the parameterised AST node
* @return a list of type parameter names
*/
public static List getTypeParameterNames(final DetailAST aNode)
{
final DetailAST typeParameters =
aNode.findFirstToken(TokenTypes.TYPE_PARAMETERS);
final List typeParamNames = Lists.newArrayList();
if (typeParameters != null) {
final DetailAST typeParam =
typeParameters.findFirstToken(TokenTypes.TYPE_PARAMETER);
typeParamNames.add(
typeParam.findFirstToken(TokenTypes.IDENT).getText());
DetailAST sibling = typeParam.getNextSibling();
while (sibling != null) {
if (sibling.getType() == TokenTypes.TYPE_PARAMETER) {
typeParamNames.add(
sibling.findFirstToken(TokenTypes.IDENT).getText());
}
sibling = sibling.getNextSibling();
}
}
return typeParamNames;
}
/**
* Retrieves the type parameters to the node.
* @param aNode the parameterised AST node
* @return a list of type parameter names
*/
public static List getTypeParameters(final DetailAST aNode)
{
final DetailAST typeParameters =
aNode.findFirstToken(TokenTypes.TYPE_PARAMETERS);
final List typeParams = Lists.newArrayList();
if (typeParameters != null) {
final DetailAST typeParam =
typeParameters.findFirstToken(TokenTypes.TYPE_PARAMETER);
typeParams.add(typeParam);
DetailAST sibling = typeParam.getNextSibling();
while (sibling != null) {
if (sibling.getType() == TokenTypes.TYPE_PARAMETER) {
typeParams.add(sibling);
}
sibling = sibling.getNextSibling();
}
}
return typeParams;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/ClassResolver.java 100644 0 0 14604 12026051064 26773 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import java.util.Set;
/**
* Utility class to resolve a class name to an actual class. Note that loaded
* classes are not initialized.
*
Limitations: this does not handle inner classes very well.
*
* @author Oliver Burn
* @version 1.0
*/
public class ClassResolver
{
/** name of the package to check if the class belongs to **/
private final String mPkg;
/** set of imports to check against **/
private final Set mImports;
/** use to load classes **/
private final ClassLoader mLoader;
/**
* Creates a new ClassResolver instance.
*
* @param aLoader the ClassLoader to load classes with.
* @param aPkg the name of the package the class may belong to
* @param aImports set of imports to check if the class belongs to
*/
public ClassResolver(ClassLoader aLoader, String aPkg, Set aImports)
{
mLoader = aLoader;
mPkg = aPkg;
mImports = aImports;
mImports.add("java.lang.*");
}
/**
* Attempts to resolve the Class for a specified name. The algorithm is
* to check:
* - fully qualified name
* - explicit imports
* - enclosing package
* - star imports
* @param aName name of the class to resolve
* @param aCurrentClass name of current class (for inner classes).
* @return the resolved class
* @throws ClassNotFoundException if unable to resolve the class
*/
public Class resolve(String aName, String aCurrentClass)
throws ClassNotFoundException
{
// See if the class is full qualified
Class clazz = resolveQualifiedName(aName);
if (clazz != null) {
return clazz;
}
// try matching explicit imports
for (String imp : mImports) {
// Very important to add the "." in the check below. Otherwise you
// when checking for "DataException", it will match on
// "SecurityDataException". This has been the cause of a very
// difficult bug to resolve!
if (imp.endsWith("." + aName)) {
clazz = resolveQualifiedName(imp);
if (clazz != null) {
return clazz;
}
}
}
// See if in the package
if (!"".equals(mPkg)) {
clazz = resolveQualifiedName(mPkg + "." + aName);
if (clazz != null) {
return clazz;
}
}
//inner class of this class???
if (!"".equals(aCurrentClass)) {
final String innerClass = (!"".equals(mPkg) ? (mPkg + ".") : "")
+ aCurrentClass + "$" + aName;
if (isLoadable(innerClass)) {
return safeLoad(innerClass);
}
}
// try star imports
for (String imp : mImports) {
if (imp.endsWith(".*")) {
final String fqn = imp.substring(0, imp.lastIndexOf('.') + 1)
+ aName;
clazz = resolveQualifiedName(fqn);
if (clazz != null) {
return clazz;
}
}
}
// Giving up, the type is unknown, so load the class to generate an
// exception
return safeLoad(aName);
}
/**
* @return whether a specified class is loadable with safeLoad().
* @param aName name of the class to check
*/
public boolean isLoadable(String aName)
{
try {
safeLoad(aName);
return true;
}
catch (final ClassNotFoundException e) {
return false;
}
}
/**
* Will load a specified class is such a way that it will NOT be
* initialised.
* @param aName name of the class to load
* @return the Class for the specified class
* @throws ClassNotFoundException if an error occurs
*/
public Class safeLoad(String aName)
throws ClassNotFoundException
{
// The next line will load the class using the specified class
// loader. The magic is having the "false" parameter. This means the
// class will not be initialised. Very, very important.
return Class.forName(aName, false, mLoader);
}
/**
* Tries to resolve a class for fully-specified name.
* @param aName a given name of class.
* @return Class object for the given name or null.
*/
private Class resolveQualifiedName(final String aName)
{
try {
if (isLoadable(aName)) {
return safeLoad(aName);
}
//Perhaps it's fully-qualified inner class
final int dot = aName.lastIndexOf(".");
if (dot != -1) {
final String innerName =
aName.substring(0, dot) + "$" + aName.substring(dot + 1);
if (isLoadable(innerName)) {
return safeLoad(innerName);
}
}
}
catch (final ClassNotFoundException ex) {
// we shouldn't get this exception here,
// so this is unexpected runtime exception
throw new RuntimeException(ex);
}
return null;
}
}
././@LongLink 100644 0 0 146 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/AbstractIllegalCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/AbstractIllegalCheck.jav100644 0 0 5336 12026051054 31262 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.Check;
import java.util.Set;
/**
* Support for checks that look for usage of illegal types.
* @author Oliver Burn
*/
public abstract class AbstractIllegalCheck extends Check
{
/** Illegal class names */
private final Set mIllegalClassNames = Sets.newHashSet();
/**
* Constructs an object.
* @param aInitialNames the initial class names to treat as illegal
*/
protected AbstractIllegalCheck(final String[] aInitialNames)
{
assert aInitialNames != null;
setIllegalClassNames(aInitialNames);
}
/**
* Checks if given class is illegal.
*
* @param aIdent
* ident to check.
* @return true if given ident is illegal.
*/
protected final boolean isIllegalClassName(final String aIdent)
{
return mIllegalClassNames.contains(aIdent);
}
/**
* Set the list of illegal classes.
*
* @param aClassNames
* array of illegal exception classes
*/
public final void setIllegalClassNames(final String[] aClassNames)
{
assert aClassNames != null;
mIllegalClassNames.clear();
for (final String name : aClassNames) {
mIllegalClassNames.add(name);
final int lastDot = name.lastIndexOf(".");
if ((lastDot > 0) && (lastDot < (name.length() - 1))) {
final String shortName = name
.substring(name.lastIndexOf(".") + 1);
mIllegalClassNames.add(shortName);
}
}
}
}
././@LongLink 100644 0 0 154 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/AbstractIllegalMethodCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/AbstractIllegalMethodChe100644 0 0 5055 12026051054 31324 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Provide support for checking for a method with a specified name and no
* arguments.
* @author Oliver Burn
*/
public abstract class AbstractIllegalMethodCheck extends Check
{
/** Name of method to disallow. */
private final String mMethodName;
/** The error key to report with. */
private final String mErrorKey;
/**
* Creates an instance.
* @param aMethodName name of the method to disallow.
* @param aErrorKey the error key to report with.
*/
public AbstractIllegalMethodCheck(String aMethodName, String aErrorKey)
{
mMethodName = aMethodName;
mErrorKey = aErrorKey;
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.METHOD_DEF};
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST mid = aAST.findFirstToken(TokenTypes.IDENT);
final String methodName = mid.getText();
if (mMethodName.equals(methodName)) {
final DetailAST params = aAST.findFirstToken(TokenTypes.PARAMETERS);
final boolean hasEmptyParamList =
!params.branchContains(TokenTypes.PARAMETER_DEF);
if (hasEmptyParamList) {
log(aAST.getLineNo(), mErrorKey);
}
}
}
}
././@LongLink 100644 0 0 152 12026055133 10246 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/AbstractNestedDepthCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/AbstractNestedDepthCheck100644 0 0 5377 12026051054 31346 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
* Abstract class which provides helpers functionality for nestedchecks.
*
* @author Simon Harris
*/
public abstract class AbstractNestedDepthCheck extends Check
{
/** maximum allowed nesting depth */
private int mMax;
/** curren nesting depth */
private int mDepth;
/**
* Creates new instance of checks.
* @param aMax default allowed nesting depth.
*/
public AbstractNestedDepthCheck(int aMax)
{
setMax(aMax);
}
@Override
public final int[] getRequiredTokens()
{
return getDefaultTokens();
}
@Override
public void beginTree(DetailAST aRootAST)
{
mDepth = 0;
}
/**
* Getter for maximum allowed nesting depth.
* @return maximum allowed nesting depth.
*/
public final int getMax()
{
return mMax;
}
/**
* Setter for maximum allowed nesting depth.
* @param aMax maximum allowed nesting depth.
*/
public final void setMax(int aMax)
{
mMax = aMax;
}
/**
* Increasing current nesting depth.
* @param aAST note which increases nesting.
* @param aMessageId message id for logging error.
*/
protected final void nestIn(DetailAST aAST, String aMessageId)
{
if (mDepth > mMax) {
log(aAST, aMessageId, mDepth, mMax);
}
++mDepth;
}
/** Decreasing current nesting depth */
protected final void nestOut()
{
--mDepth;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/AbstractSuperCheck.java 100644 0 0 16120 12026051053 31160 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 antlr.collections.AST;
import com.google.common.collect.Lists;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.util.LinkedList;
/**
*
* Abstract class for checking that an overriding method with no parameters
* invokes the super method.
*
* @author Rick Giles
*/
public abstract class AbstractSuperCheck
extends Check
{
/**
* Stack node for a method definition and a record of
* whether the method has a call to the super method.
* @author Rick Giles
*/
private static class MethodNode
{
/** method definition */
private final DetailAST mMethod;
/** true if the overriding method calls the super method */
private boolean mCallsSuper;
/**
* Constructs a stack node for a method definition.
* @param aAST AST for the method definition.
*/
public MethodNode(DetailAST aAST)
{
mMethod = aAST;
mCallsSuper = false;
}
/**
* Records that the overriding method has a call to the super method.
*/
public void setCallsSuper()
{
mCallsSuper = true;
}
/**
* Determines whether the overriding method has a call to the super
* method.
* @return true if the overriding method has a call to the super
* method.
*/
public boolean getCallsSuper()
{
return mCallsSuper;
}
/**
* Returns the overriding method definition AST.
* @return the overriding method definition AST.
*/
public DetailAST getMethod()
{
return mMethod;
}
}
/** stack of methods */
private final LinkedList mMethodStack = Lists.newLinkedList();
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.METHOD_DEF,
TokenTypes.LITERAL_SUPER,
};
}
/**
* Returns the name of the overriding method.
* @return the name of the overriding method.
*/
protected abstract String getMethodName();
@Override
public void beginTree(DetailAST aRootAST)
{
mMethodStack.clear();
}
@Override
public void visitToken(DetailAST aAST)
{
if (isOverridingMethod(aAST)) {
mMethodStack.add(new MethodNode(aAST));
}
else if (isSuperCall(aAST)) {
final MethodNode methodNode = mMethodStack.getLast();
methodNode.setCallsSuper();
}
}
/**
* Determines whether a 'super' literal is a call to the super method
* for this check.
* @param aAST the AST node of a 'super' literal.
* @return true if aAST is a call to the super method
* for this check.
*/
private boolean isSuperCall(DetailAST aAST)
{
if (aAST.getType() != TokenTypes.LITERAL_SUPER) {
return false;
}
// dot operator?
DetailAST parent = aAST.getParent();
if ((parent == null) || (parent.getType() != TokenTypes.DOT)) {
return false;
}
// same name of method
AST sibling = aAST.getNextSibling();
// ignore type parameters
if ((sibling != null)
&& (sibling.getType() == TokenTypes.TYPE_ARGUMENTS))
{
sibling = sibling.getNextSibling();
}
if ((sibling == null) || (sibling.getType() != TokenTypes.IDENT)) {
return false;
}
final String name = sibling.getText();
if (!getMethodName().equals(name)) {
return false;
}
// 0 parameters?
final DetailAST args = parent.getNextSibling();
if ((args == null) || (args.getType() != TokenTypes.ELIST)) {
return false;
}
if (args.getChildCount() != 0) {
return false;
}
// in an overriding method for this check?
while (parent != null) {
if (parent.getType() == TokenTypes.METHOD_DEF) {
return isOverridingMethod(parent);
}
else if ((parent.getType() == TokenTypes.CTOR_DEF)
|| (parent.getType() == TokenTypes.INSTANCE_INIT))
{
return false;
}
parent = parent.getParent();
}
return false;
}
@Override
public void leaveToken(DetailAST aAST)
{
if (isOverridingMethod(aAST)) {
final MethodNode methodNode =
mMethodStack.removeLast();
if (!methodNode.getCallsSuper()) {
final DetailAST methodAST = methodNode.getMethod();
final DetailAST nameAST =
methodAST.findFirstToken(TokenTypes.IDENT);
log(nameAST.getLineNo(), nameAST.getColumnNo(),
"missing.super.call", nameAST.getText());
}
}
}
/**
* Determines whether an AST is a method definition for this check,
* with 0 parameters.
* @param aAST the method definition AST.
* @return true if the method of aAST is a method for this check.
*/
private boolean isOverridingMethod(DetailAST aAST)
{
if ((aAST.getType() != TokenTypes.METHOD_DEF)
|| ScopeUtils.inInterfaceOrAnnotationBlock(aAST))
{
return false;
}
final DetailAST nameAST = aAST.findFirstToken(TokenTypes.IDENT);
final String name = nameAST.getText();
if (!getMethodName().equals(name)) {
return false;
}
final DetailAST params = aAST.findFirstToken(TokenTypes.PARAMETERS);
return (params.getChildCount() == 0);
}
}
././@LongLink 100644 0 0 151 12026055133 10245 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/ArrayTrailingCommaCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/ArrayTrailingCommaCheck.100644 0 0 4564 12026051053 31252 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
*
* Checks if array initialization contains optional trailing comma.
*
*
* Rationale: Putting this comma in make is easier to change the
* order of the elements or add new elements on the end.
*
*
* An example of how to configure the check is:
*
*
* <module name="ArrayTrailingComma"/>
*
* @author o_sukhodolsky
*/
public class ArrayTrailingCommaCheck extends Check
{
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.ARRAY_INIT};
}
@Override
public void visitToken(DetailAST aArrayInit)
{
final DetailAST rcurly = aArrayInit.findFirstToken(TokenTypes.RCURLY);
// if curlys are on the same line
// or array is empty then check nothing
if ((aArrayInit.getLineNo() == rcurly.getLineNo())
|| (aArrayInit.getChildCount() == 1))
{
return;
}
final DetailAST prev = rcurly.getPreviousSibling();
if (prev.getType() != TokenTypes.COMMA) {
log(rcurly.getLineNo(), "array.trailing.comma");
}
}
}
././@LongLink 100644 0 0 156 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/AvoidInlineConditionalsCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/AvoidInlineConditionalsC100644 0 0 4245 12026051053 31360 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
* Detects inline conditionals.
*
* An example inline conditional is this:
*
* String a = getParameter("a");
* String b = (a==null || a.length<1) ? null : a.substring(1);
*
*
* Rationale: Some developers find inline conditionals hard to read,
* so their company's coding standards forbids them.
*
* @author lkuehne
*/
public class AvoidInlineConditionalsCheck extends Check
{
@Override
public int[] getDefaultTokens()
{
return new int[]{TokenTypes.QUESTION};
}
@Override
public int[] getRequiredTokens()
{
return getDefaultTokens();
}
@Override
public void visitToken(DetailAST aAST)
{
// the only place a QUESTION token can occur is in inline conditionals
// so no need to do any further tricks here - pretty trivial Check!
log(aAST.getLineNo(), aAST.getColumnNo(), "inline.conditional.avoid");
}
}
././@LongLink 100644 0 0 146 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/CovariantEqualsCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/CovariantEqualsCheck.jav100644 0 0 10742 12026051053 31342 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
import java.util.Set;
/**
*
Checks that if a class defines a covariant method equals,
* then it defines method equals(java.lang.Object).
* Inspired by findbugs,
* http://www.cs.umd.edu/~pugh/java/bugs/docs/findbugsPaper.pdf
*
*
* An example of how to configure the check is:
*
*
* <module name="CovariantEquals"/>
*
* @author Rick Giles
* @version 1.0
*/
public class CovariantEqualsCheck extends Check
{
/** Set of equals method definitions */
private final Set mEqualsMethods = Sets.newHashSet();
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.CLASS_DEF, TokenTypes.LITERAL_NEW, };
}
@Override
public int[] getRequiredTokens()
{
return getDefaultTokens();
}
@Override
public void visitToken(DetailAST aAST)
{
mEqualsMethods.clear();
boolean hasEqualsObject = false;
// examine method definitions for equals methods
final DetailAST objBlock = aAST.findFirstToken(TokenTypes.OBJBLOCK);
if (objBlock != null) {
DetailAST child = objBlock.getFirstChild();
while (child != null) {
if (child.getType() == TokenTypes.METHOD_DEF) {
if (CheckUtils.isEqualsMethod(child)) {
if (hasObjectParameter(child)) {
hasEqualsObject = true;
}
else {
mEqualsMethods.add(child);
}
}
}
child = child.getNextSibling();
}
// report equals method definitions
if (!hasEqualsObject) {
for (DetailAST equalsAST : mEqualsMethods) {
final DetailAST nameNode = equalsAST
.findFirstToken(TokenTypes.IDENT);
log(nameNode.getLineNo(), nameNode.getColumnNo(),
"covariant.equals");
}
}
}
}
/**
* Tests whether a method definition AST has exactly one
* parameter of type Object.
* @param aAST the method definition AST to test.
* Precondition: aAST is a TokenTypes.METHOD_DEF node.
* @return true if aAST has exactly one parameter of type Object.
*/
private boolean hasObjectParameter(DetailAST aAST)
{
// one parameter?
final DetailAST paramsNode = aAST.findFirstToken(TokenTypes.PARAMETERS);
if (paramsNode.getChildCount() != 1) {
return false;
}
// parameter type "Object"?
final DetailAST paramNode =
paramsNode.findFirstToken(TokenTypes.PARAMETER_DEF);
final DetailAST typeNode = paramNode.findFirstToken(TokenTypes.TYPE);
final FullIdent fullIdent = FullIdent.createFullIdentBelow(typeNode);
final String name = fullIdent.getText();
return ("Object".equals(name) || "java.lang.Object".equals(name));
}
}
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/DeclarationOrderCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/DeclarationOrderCheck.ja100644 0 0 17004 12026051053 31272 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.Scope;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
Class (static) variables. First the public class variables, then
* the protected, then package level (no access modifier), and then
* the private.
*
Instance variables. First the public class variables, then
* the protected, then package level (no access modifier), and then
* the private.
*
Constructors
*
Methods
*
*
*
* An example of how to configure the check is:
*
*
* <module name="DeclarationOrder"/>
*
*
* @author r_auckenthaler
*/
public class DeclarationOrderCheck extends Check
{
/** State for the VARIABLE_DEF */
private static final int STATE_STATIC_VARIABLE_DEF = 1;
/** State for the VARIABLE_DEF */
private static final int STATE_INSTANCE_VARIABLE_DEF = 2;
/** State for the CTOR_DEF */
private static final int STATE_CTOR_DEF = 3;
/** State for the METHOD_DEF */
private static final int STATE_METHOD_DEF = 4;
/**
* List of Declaration States. This is necessary due to
* inner classes that have their own state
*/
private final FastStack mScopeStates = FastStack.newInstance();
/**
* private class to encapsulate the state
*/
private static class ScopeState
{
/** The state the check is in */
private int mScopeState = STATE_STATIC_VARIABLE_DEF;
/** The sub-state the check is in */
private Scope mDeclarationAccess = Scope.PUBLIC;
}
/** If true, ignores the check to constructors. */
private boolean mIgnoreConstructors;
/** If true, ignore the check to methods. */
private boolean mIgnoreMethods;
/** If true, ignore the check to modifiers (fields, ...). */
private boolean mIgnoreModifiers;
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.CTOR_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.MODIFIERS,
TokenTypes.OBJBLOCK,
};
}
@Override
public void visitToken(DetailAST aAST)
{
final int parentType = aAST.getParent().getType();
ScopeState state;
switch(aAST.getType()) {
case TokenTypes.OBJBLOCK:
mScopeStates.push(new ScopeState());
break;
case TokenTypes.CTOR_DEF:
if (parentType != TokenTypes.OBJBLOCK) {
return;
}
state = mScopeStates.peek();
if (state.mScopeState > STATE_CTOR_DEF) {
if (!mIgnoreConstructors) {
log(aAST, "declaration.order.constructor");
}
}
else {
state.mScopeState = STATE_CTOR_DEF;
}
break;
case TokenTypes.METHOD_DEF:
state = mScopeStates.peek();
if (parentType != TokenTypes.OBJBLOCK) {
return;
}
if (state.mScopeState > STATE_METHOD_DEF) {
if (!mIgnoreMethods) {
log(aAST, "declaration.order.method");
}
}
else {
state.mScopeState = STATE_METHOD_DEF;
}
break;
case TokenTypes.MODIFIERS:
if ((parentType != TokenTypes.VARIABLE_DEF)
|| (aAST.getParent().getParent().getType()
!= TokenTypes.OBJBLOCK))
{
return;
}
state = mScopeStates.peek();
if (aAST.findFirstToken(TokenTypes.LITERAL_STATIC) != null) {
if (state.mScopeState > STATE_STATIC_VARIABLE_DEF) {
if (!mIgnoreModifiers
|| state.mScopeState > STATE_INSTANCE_VARIABLE_DEF)
{
log(aAST, "declaration.order.static");
}
}
else {
state.mScopeState = STATE_STATIC_VARIABLE_DEF;
}
}
else {
if (state.mScopeState > STATE_INSTANCE_VARIABLE_DEF) {
log(aAST, "declaration.order.instance");
}
else if (state.mScopeState == STATE_STATIC_VARIABLE_DEF) {
state.mDeclarationAccess = Scope.PUBLIC;
state.mScopeState = STATE_INSTANCE_VARIABLE_DEF;
}
}
final Scope access = ScopeUtils.getScopeFromMods(aAST);
if (state.mDeclarationAccess.compareTo(access) > 0) {
if (!mIgnoreModifiers) {
log(aAST, "declaration.order.access");
}
}
else {
state.mDeclarationAccess = access;
}
break;
default:
}
}
@Override
public void leaveToken(DetailAST aAST)
{
switch(aAST.getType()) {
case TokenTypes.OBJBLOCK:
mScopeStates.pop();
break;
default:
}
}
/**
* Sets whether to ignore constructors.
* @param aIgnoreConstructors whether to ignore constructors.
*/
public void setIgnoreConstructors(boolean aIgnoreConstructors)
{
mIgnoreConstructors = aIgnoreConstructors;
}
/**
* Sets whether to ignore methods.
* @param aIgnoreMethods whether to ignore methods.
*/
public void setIgnoreMethods(boolean aIgnoreMethods)
{
mIgnoreMethods = aIgnoreMethods;
}
/**
* Sets whether to ignore modifiers.
* @param aIgnoreModifiers whether to ignore modifiers.
*/
public void setIgnoreModifiers(boolean aIgnoreModifiers)
{
mIgnoreModifiers = aIgnoreModifiers;
}
}
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/DefaultComesLastCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/DefaultComesLastCheck.ja100644 0 0 5575 12026051052 31241 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Check that the default is after all the cases
* in a switch statement.
*
*
* Rationale: Java allows default anywhere within the
* switch statement. But if it comes after the last
* case then it is more readable.
*
*
* An example of how to configure the check is:
*
*
* <module name="DefaultComesLast"/>
*
* @author o_sukhodolsky
*/
public class DefaultComesLastCheck extends Check
{
/** Creates new instance of the check. */
public DefaultComesLastCheck()
{
// do nothing
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.LITERAL_DEFAULT,
};
}
@Override
public int[] getAcceptableTokens()
{
return getDefaultTokens();
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST defaultGroupAST = aAST.getParent();
//default keywords used in annotations too - not what we're
//interested in
if (defaultGroupAST.getType() != TokenTypes.ANNOTATION_FIELD_DEF) {
final DetailAST switchAST = defaultGroupAST.getParent();
final DetailAST lastGroupAST =
switchAST.getLastChild().getPreviousSibling();
if ((defaultGroupAST.getLineNo() != lastGroupAST.getLineNo())
|| (defaultGroupAST.getColumnNo()
!= lastGroupAST.getColumnNo()))
{
log(aAST, "default.comes.last");
}
}
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/EmptyStatementCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/EmptyStatementCheck.java100644 0 0 3714 12026051052 31345 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
*
* Detects empty statements (standalone ';').
* Empty statements often introduce bugs
* that are hard to spot, such as in
*
*
* if (someCondition);
* doConditionalStuff();
* doUnconditionalStuff();
*
*
* An example of how to configure the check is:
*
*
* <module name="EmptyStatement"/>
*
* @author Rick Giles
* @version 1.0
*/
public class EmptyStatementCheck extends Check
{
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.EMPTY_STAT};
}
@Override
public void visitToken(DetailAST aAST)
{
log(aAST.getLineNo(), aAST.getColumnNo(), "empty.statement");
}
}
././@LongLink 100644 0 0 146 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/EqualsAvoidNullCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/EqualsAvoidNullCheck.jav100644 0 0 17732 12026051052 31316 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 antlr.collections.AST;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks that any combination of String literals with optional
* assignment is on the left side of an equals() comparison.
*
*
*
* Rationale: Calling the equals() method on String literals
* will avoid a potential NullPointerException. Also, it is
* pretty common to see null check right before equals comparisons
* which is not necessary in the below example.
*
* For example:
*
*
* Limitations: If the equals method is overridden or
* a covariant equals method is defined and the implementation
* is incorrect (where s.equals(t) does not return the same result
* as t.equals(s)) then rearranging the called on object and
* parameter may have unexpected results
*
*
*
* Java's Autoboxing feature has an affect
* on how this check is implemented. Pre Java 5 all IDENT + IDENT
* object concatenations would not cause a NullPointerException even
* if null. Those situations could have been included in this check.
* They would simply act as if they surrounded by String.valueof()
* which would concatenate the String null.
*
*
* The following example will cause a
* NullPointerException as a result of what autoboxing does.
*
* Integer i = null, j = null;
* String number = "5"
* number.equals(i + j);
*
*
*
* Since, it is difficult to determine what kind of Object is being
* concatenated all ident concatenation is considered unsafe.
*
* @author Travis Schneeberger
* version 1.0
*/
public class EqualsAvoidNullCheck extends Check
{
/** Whether to process equalsIgnoreCase() invocations. */
private boolean mIgnoreEqualsIgnoreCase;
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.METHOD_CALL};
}
@Override
public void visitToken(final DetailAST aMethodCall)
{
final DetailAST dot = aMethodCall.getFirstChild();
if (dot.getType() != TokenTypes.DOT) {
return;
}
final DetailAST objCalledOn = dot.getFirstChild();
//checks for calling equals on String literal and
//anon object which cannot be null
//Also, checks if calling using strange inner class
//syntax outter.inner.equals(otherObj) by looking
//for the dot operator which cannot be improved
if ((objCalledOn.getType() == TokenTypes.STRING_LITERAL)
|| (objCalledOn.getType() == TokenTypes.LITERAL_NEW)
|| (objCalledOn.getType() == TokenTypes.DOT))
{
return;
}
final DetailAST method = objCalledOn.getNextSibling();
final DetailAST expr = dot.getNextSibling().getFirstChild();
if ("equals".equals(method.getText())
|| (!mIgnoreEqualsIgnoreCase && "equalsIgnoreCase"
.equals(method.getText())))
{
if (containsOneArg(expr) && containsAllSafeTokens(expr)) {
log(aMethodCall.getLineNo(), aMethodCall.getColumnNo(),
"equals".equals(method.getText())
? "equals.avoid.null"
: "equalsIgnoreCase.avoid.null");
}
}
}
/**
* Checks if a method contains no arguments
* starting at with the argument expression.
*
* @param aExpr the argument expression
* @return true if the method contains no args, false if not
*/
private boolean containsNoArgs(final AST aExpr)
{
return (aExpr == null);
}
/**
* Checks if a method contains multiple arguments
* starting at with the argument expression.
*
* @param aExpr the argument expression
* @return true if the method contains multiple args, false if not
*/
private boolean containsMultiArgs(final AST aExpr)
{
final AST comma = aExpr.getNextSibling();
return (comma != null) && (comma.getType() == TokenTypes.COMMA);
}
/**
* Checks if a method contains a single argument
* starting at with the argument expression.
*
* @param aExpr the argument expression
* @return true if the method contains a single arg, false if not
*/
private boolean containsOneArg(final AST aExpr)
{
return !containsNoArgs(aExpr) && !containsMultiArgs(aExpr);
}
/**
*
* Looks for all "safe" Token combinations in the argument
* expression branch.
*
*
*
* See class documentation for details on autoboxing's affect
* on this method implementation.
*
*
* @param aExpr the argument expression
* @return - true if any child matches the set of tokens, false if not
*/
private boolean containsAllSafeTokens(final DetailAST aExpr)
{
DetailAST arg = aExpr.getFirstChild();
if (arg.branchContains(TokenTypes.METHOD_CALL)) {
return false;
}
arg = skipVariableAssign(arg);
//Plus assignment can have ill affects
//do not want to recommend moving expression
//See example:
//String s = "SweetString";
//s.equals(s += "SweetString"); //false
//s = "SweetString";
//(s += "SweetString").equals(s); //true
//arg = skipVariablePlusAssign(arg);
if ((arg).branchContains(TokenTypes.PLUS_ASSIGN)
|| (arg).branchContains(TokenTypes.IDENT))
{
return false;
}
//must be just String literals if got here
return true;
}
/**
* Skips over an inner assign portion of an argument expression.
* @param aCurrentAST current token in the argument expression
* @return the next relevant token
*/
private DetailAST skipVariableAssign(final DetailAST aCurrentAST)
{
if ((aCurrentAST.getType() == TokenTypes.ASSIGN)
&& (aCurrentAST.getFirstChild().getType() == TokenTypes.IDENT))
{
return aCurrentAST.getFirstChild().getNextSibling();
}
return aCurrentAST;
}
/**
* Whether to ignore checking {@code String.equalsIgnoreCase(String)}.
* @param aNewValue whether to ignore checking
* {@code String.equalsIgnoreCase(String)}.
*/
public void setIgnoreEqualsIgnoreCase(boolean aNewValue)
{
mIgnoreEqualsIgnoreCase = aNewValue;
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/EqualsHashCodeCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/EqualsHashCodeCheck.java100644 0 0 12155 12026051051 31231 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 antlr.collections.AST;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.util.Map;
import java.util.Set;
/**
*
* Checks that classes that override equals() also override hashCode().
*
*
* Rationale: The contract of equals() and hashCode() requires that
* equal objects have the same hashCode. Hence, whenever you override
* equals() you must override hashCode() to ensure that your class can
* be used in collections that are hash based.
*
*
* An example of how to configure the check is:
*
*
* <module name="EqualsHashCode"/>
*
* @author lkuehne
*/
public class EqualsHashCodeCheck
extends Check
{
// implementation note: we have to use the following members to
// keep track of definitions in different inner classes
/** maps OBJ_BLOCK to the method definition of equals() */
private final Map mObjBlockEquals = Maps.newHashMap();
/** the set of OBJ_BLOCKs that contain a definition of hashCode() */
private final Set mObjBlockWithHashCode = Sets.newHashSet();
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.METHOD_DEF};
}
@Override
public void beginTree(DetailAST aRootAST)
{
mObjBlockEquals.clear();
mObjBlockWithHashCode.clear();
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST modifiers = aAST.getFirstChild();
final AST type = aAST.findFirstToken(TokenTypes.TYPE);
final AST methodName = aAST.findFirstToken(TokenTypes.IDENT);
final DetailAST parameters = aAST.findFirstToken(TokenTypes.PARAMETERS);
if ((type.getFirstChild().getType() == TokenTypes.LITERAL_BOOLEAN)
&& "equals".equals(methodName.getText())
&& modifiers.branchContains(TokenTypes.LITERAL_PUBLIC)
&& (parameters.getChildCount() == 1)
&& isObjectParam(parameters.getFirstChild())
)
{
mObjBlockEquals.put(aAST.getParent(), aAST);
}
else if ((type.getFirstChild().getType() == TokenTypes.LITERAL_INT)
&& "hashCode".equals(methodName.getText())
&& modifiers.branchContains(TokenTypes.LITERAL_PUBLIC)
&& (parameters.getFirstChild() == null)) // no params
{
mObjBlockWithHashCode.add(aAST.getParent());
}
}
/**
* Determines if an AST is a formal param of type Object (or subclass).
* @param aFirstChild the AST to check
* @return true iff aFirstChild is a parameter of an Object type.
*/
private boolean isObjectParam(AST aFirstChild)
{
final AST modifiers = aFirstChild.getFirstChild();
final AST type = modifiers.getNextSibling();
switch (type.getFirstChild().getType()) {
case TokenTypes.LITERAL_BOOLEAN:
case TokenTypes.LITERAL_BYTE:
case TokenTypes.LITERAL_CHAR:
case TokenTypes.LITERAL_DOUBLE:
case TokenTypes.LITERAL_FLOAT:
case TokenTypes.LITERAL_INT:
case TokenTypes.LITERAL_LONG:
case TokenTypes.LITERAL_SHORT:
return false;
default:
return true;
}
}
@Override
public void finishTree(DetailAST aRootAST)
{
final Set equalsDefs = mObjBlockEquals.keySet();
for (DetailAST objBlock : equalsDefs) {
if (!mObjBlockWithHashCode.contains(objBlock)) {
final DetailAST equalsAST = mObjBlockEquals.get(objBlock);
log(equalsAST.getLineNo(), equalsAST.getColumnNo(),
"equals.noHashCode");
}
}
mObjBlockEquals.clear();
mObjBlockWithHashCode.clear();
}
}
././@LongLink 100644 0 0 155 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/ExplicitInitializationCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/ExplicitInitializationCh100644 0 0 13615 12026051051 31470 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
/**
*
* Checks if any class or object member explicitly initialized
* to default for its type value (null for object
* references, zero for numeric types and char
* and false for boolean.
*
*
* Rationale: each instance variable gets
* initialized twice, to the same value. Java
* initializes each instance variable to its default
* value (0 or null) before performing any
* initialization specified in the code. So in this case,
* x gets initialized to 0 twice, and bar gets initialized
* to null twice. So there is a minor inefficiency. This style of
* coding is a hold-over from C/C++ style coding,
* and it shows that the developer isn't really confident that
* Java really initializes instance variables to default
* values.
*
*
* @author o_sukhodolsky
*/
public class ExplicitInitializationCheck extends Check
{
@Override
public final int[] getDefaultTokens()
{
return new int[] {TokenTypes.VARIABLE_DEF};
}
@Override
public final int[] getRequiredTokens()
{
return getDefaultTokens();
}
@Override
public void visitToken(DetailAST aAST)
{
// do not check local variables and
// fields declared in interface/annotations
if (ScopeUtils.isLocalVariableDef(aAST)
|| ScopeUtils.inInterfaceOrAnnotationBlock(aAST))
{
return;
}
final DetailAST assign = aAST.findFirstToken(TokenTypes.ASSIGN);
if (assign == null) {
// no assign - no check
return;
}
final DetailAST modifiers = aAST.findFirstToken(TokenTypes.MODIFIERS);
if ((modifiers != null)
&& modifiers.branchContains(TokenTypes.FINAL))
{
// do not check final variables
return;
}
final DetailAST type = aAST.findFirstToken(TokenTypes.TYPE);
final DetailAST ident = aAST.findFirstToken(TokenTypes.IDENT);
final DetailAST exprStart =
assign.getFirstChild().getFirstChild();
if (isObjectType(type)
&& (exprStart.getType() == TokenTypes.LITERAL_NULL))
{
log(ident, "explicit.init", ident.getText(), "null");
}
final int primitiveType = type.getFirstChild().getType();
if ((primitiveType == TokenTypes.LITERAL_BOOLEAN)
&& (exprStart.getType() == TokenTypes.LITERAL_FALSE))
{
log(ident, "explicit.init", ident.getText(), "false");
}
if (isNumericType(primitiveType) && isZero(exprStart)) {
log(ident, "explicit.init", ident.getText(), "0");
}
if ((primitiveType == TokenTypes.LITERAL_CHAR)
&& (isZero(exprStart)
|| ((exprStart.getType() == TokenTypes.CHAR_LITERAL)
&& "'\\0'".equals(exprStart.getText()))))
{
log(ident, "explicit.init", ident.getText(), "\\0");
}
}
/**
* Determines if a giiven type is an object type.
* @param aType type to check.
* @return true if it is an object type.
*/
private boolean isObjectType(DetailAST aType)
{
final int type = aType.getFirstChild().getType();
return ((type == TokenTypes.IDENT) || (type == TokenTypes.DOT)
|| (type == TokenTypes.ARRAY_DECLARATOR));
}
/**
* Determine if a given type is a numeric type.
* @param aType code of the type for check.
* @return true if it's a numeric type.
* @see TokenTypes
*/
private boolean isNumericType(int aType)
{
return ((aType == TokenTypes.LITERAL_BYTE)
|| (aType == TokenTypes.LITERAL_SHORT)
|| (aType == TokenTypes.LITERAL_INT)
|| (aType == TokenTypes.LITERAL_FLOAT)
|| (aType == TokenTypes.LITERAL_LONG)
|| (aType == TokenTypes.LITERAL_DOUBLE));
}
/**
* @param aExpr node to check.
* @return true if given node contains numeric constant for zero.
*/
private boolean isZero(DetailAST aExpr)
{
final int type = aExpr.getType();
switch (type) {
case TokenTypes.NUM_FLOAT:
case TokenTypes.NUM_DOUBLE:
case TokenTypes.NUM_INT:
case TokenTypes.NUM_LONG:
final String text = aExpr.getText();
return (0 == CheckUtils.parseFloat(text, type));
default:
return false;
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/FallThroughCheck.java 100644 0 0 32354 12026051051 30622 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.regex.Matcher;
import java.util.regex.Pattern;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
/**
* Checks for fall through in switch statements
* Finds locations where a case contains Java code -
* but lacks a break, return, throw or continue statement.
*
*
* The check honors special comments to suppress warnings about
* the fall through. By default the comments "fallthru",
* "fall through", "falls through" and "fallthrough" are recognized.
*
*
* The following fragment of code will NOT trigger the check,
* because of the comment "fallthru".
*
*
* case 3:
* x = 2;
* // fallthru
* case 4:
*
*
* The recognized relief comment can be configured with the property
* reliefPattern. Default value of this regular expression
* is "fallthru|fall through|fallthrough|falls through".
*
*
* @author o_sukhodolsky
*/
public class FallThroughCheck extends Check
{
/** Do we need to check last case group. */
private boolean mCheckLastGroup;
/** Relief pattern to allow fall throught to the next case branch. */
private String mReliefPattern = "fallthru|falls? ?through";
/** Relief regexp. */
private Pattern mRegExp;
/** Creates new instance of the check. */
public FallThroughCheck()
{
// do nothing
}
@Override
public int[] getDefaultTokens()
{
return new int[]{TokenTypes.CASE_GROUP};
}
@Override
public int[] getRequiredTokens()
{
return getDefaultTokens();
}
/**
* Set the relief pattern.
*
* @param aPattern
* The regular expression pattern.
*/
public void setReliefPattern(String aPattern)
{
mReliefPattern = aPattern;
}
/**
* Configures whether we need to check last case group or not.
* @param aValue new value of the property.
*/
public void setCheckLastCaseGroup(boolean aValue)
{
mCheckLastGroup = aValue;
}
@Override
public void init()
{
super.init();
mRegExp = Utils.getPattern(mReliefPattern);
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST nextGroup = aAST.getNextSibling();
final boolean isLastGroup =
((nextGroup == null)
|| (nextGroup.getType() != TokenTypes.CASE_GROUP));
if (isLastGroup && !mCheckLastGroup) {
// we do not need to check last group
return;
}
final DetailAST slist = aAST.findFirstToken(TokenTypes.SLIST);
if (!isTerminated(slist, true, true)) {
if (!hasFallTruComment(aAST, nextGroup)) {
if (!isLastGroup) {
log(nextGroup, "fall.through");
}
else {
log(aAST, "fall.through.last");
}
}
}
}
/**
* Checks if a given subtree terminated by return, throw or,
* if allowed break, continue.
* @param aAST root of given subtree
* @param aUseBreak should we consider break as terminator.
* @param aUseContinue should we consider continue as terminator.
* @return true if the subtree is terminated.
*/
private boolean isTerminated(final DetailAST aAST, boolean aUseBreak,
boolean aUseContinue)
{
switch (aAST.getType()) {
case TokenTypes.LITERAL_RETURN:
case TokenTypes.LITERAL_THROW:
return true;
case TokenTypes.LITERAL_BREAK:
return aUseBreak;
case TokenTypes.LITERAL_CONTINUE:
return aUseContinue;
case TokenTypes.SLIST:
return checkSlist(aAST, aUseBreak, aUseContinue);
case TokenTypes.LITERAL_IF:
return checkIf(aAST, aUseBreak, aUseContinue);
case TokenTypes.LITERAL_FOR:
case TokenTypes.LITERAL_WHILE:
case TokenTypes.LITERAL_DO:
return checkLoop(aAST);
case TokenTypes.LITERAL_TRY:
return checkTry(aAST, aUseBreak, aUseContinue);
case TokenTypes.LITERAL_SWITCH:
return checkSwitch(aAST, aUseContinue);
default:
return false;
}
}
/**
* Checks if a given SLIST terminated by return, throw or,
* if allowed break, continue.
* @param aAST SLIST to check
* @param aUseBreak should we consider break as terminator.
* @param aUseContinue should we consider continue as terminator.
* @return true if SLIST is terminated.
*/
private boolean checkSlist(final DetailAST aAST, boolean aUseBreak,
boolean aUseContinue)
{
DetailAST lastStmt = aAST.getLastChild();
if (lastStmt == null) {
// if last case in switch is empty then slist is empty
// since this is a last case it is not a fall-through
return true;
}
if (lastStmt.getType() == TokenTypes.RCURLY) {
lastStmt = lastStmt.getPreviousSibling();
}
return (lastStmt != null)
&& isTerminated(lastStmt, aUseBreak, aUseContinue);
}
/**
* Checks if a given IF terminated by return, throw or,
* if allowed break, continue.
* @param aAST IF to check
* @param aUseBreak should we consider break as terminator.
* @param aUseContinue should we consider continue as terminator.
* @return true if IF is terminated.
*/
private boolean checkIf(final DetailAST aAST, boolean aUseBreak,
boolean aUseContinue)
{
final DetailAST thenStmt = aAST.findFirstToken(TokenTypes.RPAREN)
.getNextSibling();
final DetailAST elseStmt = thenStmt.getNextSibling();
boolean isTerminated = isTerminated(thenStmt, aUseBreak, aUseContinue);
if (isTerminated && (elseStmt != null)) {
isTerminated = isTerminated(elseStmt.getFirstChild(),
aUseBreak, aUseContinue);
}
return isTerminated;
}
/**
* Checks if a given loop terminated by return, throw or,
* if allowed break, continue.
* @param aAST loop to check
* @return true if loop is terminated.
*/
private boolean checkLoop(final DetailAST aAST)
{
DetailAST loopBody = null;
if (aAST.getType() == TokenTypes.LITERAL_DO) {
final DetailAST lparen = aAST.findFirstToken(TokenTypes.DO_WHILE);
loopBody = lparen.getPreviousSibling();
}
else {
final DetailAST rparen = aAST.findFirstToken(TokenTypes.RPAREN);
loopBody = rparen.getNextSibling();
}
return isTerminated(loopBody, false, false);
}
/**
* Checks if a given try/catch/finally block terminated by return, throw or,
* if allowed break, continue.
* @param aAST loop to check
* @param aUseBreak should we consider break as terminator.
* @param aUseContinue should we consider continue as terminator.
* @return true if try/cath/finally block is terminated.
*/
private boolean checkTry(final DetailAST aAST, boolean aUseBreak,
boolean aUseContinue)
{
final DetailAST finalStmt = aAST.getLastChild();
if (finalStmt.getType() == TokenTypes.LITERAL_FINALLY) {
return isTerminated(finalStmt.findFirstToken(TokenTypes.SLIST),
aUseBreak, aUseContinue);
}
boolean isTerminated = isTerminated(aAST.getFirstChild(),
aUseBreak, aUseContinue);
DetailAST catchStmt = aAST.findFirstToken(TokenTypes.LITERAL_CATCH);
while ((catchStmt != null) && isTerminated) {
final DetailAST catchBody =
catchStmt.findFirstToken(TokenTypes.SLIST);
isTerminated &= isTerminated(catchBody, aUseBreak, aUseContinue);
catchStmt = catchStmt.getNextSibling();
}
return isTerminated;
}
/**
* Checks if a given switch terminated by return, throw or,
* if allowed break, continue.
* @param aAST loop to check
* @param aUseContinue should we consider continue as terminator.
* @return true if switch is terminated.
*/
private boolean checkSwitch(final DetailAST aAST, boolean aUseContinue)
{
DetailAST caseGroup = aAST.findFirstToken(TokenTypes.CASE_GROUP);
boolean isTerminated = (caseGroup != null);
while (isTerminated && (caseGroup != null)
&& (caseGroup.getType() != TokenTypes.RCURLY))
{
final DetailAST caseBody =
caseGroup.findFirstToken(TokenTypes.SLIST);
isTerminated &= isTerminated(caseBody, false, aUseContinue);
caseGroup = caseGroup.getNextSibling();
}
return isTerminated;
}
/**
* Determines if the fall through case between aCurrentCase and
* aNextCase is reliefed by a appropriate comment.
*
* @param aCurrentCase AST of the case that falls through to the next case.
* @param aNextCase AST of the next case.
* @return True if a relief comment was found
*/
private boolean hasFallTruComment(DetailAST aCurrentCase,
DetailAST aNextCase)
{
final int startLineNo = aCurrentCase.getLineNo();
final int endLineNo = aNextCase.getLineNo();
final int endColNo = aNextCase.getColumnNo();
/*
* Remember: The lines number returned from the AST is 1-based, but
* the lines number in this array are 0-based. So you will often
* see a "lineNo-1" etc.
*/
final String[] lines = getLines();
/*
* Handle:
* case 1:
* /+ FALLTHRU +/ case 2:
* ....
* and
* switch(i) {
* default:
* /+ FALLTHRU +/}
*/
final String linepart = lines[endLineNo - 1].substring(0, endColNo);
if (commentMatch(mRegExp, linepart, endLineNo)) {
return true;
}
/*
* Handle:
* case 1:
* .....
* // FALLTHRU
* case 2:
* ....
* and
* switch(i) {
* default:
* // FALLTHRU
* }
*/
for (int i = endLineNo - 2; i > startLineNo - 1; i--) {
if (lines[i].trim().length() != 0) {
return commentMatch(mRegExp, lines[i], i + 1);
}
}
// Well -- no relief comment found.
return false;
}
/**
* Does a regular expression match on the given line and checks that a
* possible match is within a comment.
* @param aPattern The regular expression pattern to use.
* @param aLine The line of test to do the match on.
* @param aLineNo The line number in the file.
* @return True if a match was found inside a comment.
*/
private boolean commentMatch(Pattern aPattern, String aLine, int aLineNo
)
{
final Matcher matcher = aPattern.matcher(aLine);
final boolean hit = matcher.find();
if (hit) {
final int startMatch = matcher.start();
// -1 because it returns the char position beyond the match
final int endMatch = matcher.end() - 1;
return getFileContents().hasIntersectionWithComment(aLineNo,
startMatch, aLineNo, endMatch);
}
return false;
}
}
././@LongLink 100644 0 0 151 12026055133 10245 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/FinalLocalVariableCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/FinalLocalVariableCheck.100644 0 0 16550 12026051051 31213 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.util.HashMap;
import java.util.Map;
/**
*
* Ensures that local variables that never get their values changed,
* must be declared final.
*
* @author k_gibbs, r_auckenthaler
*/
public class FinalLocalVariableCheck extends Check
{
/** Scope Stack */
private final FastStack> mScopeStack =
FastStack.newInstance();
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.IDENT,
TokenTypes.CTOR_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.VARIABLE_DEF,
TokenTypes.INSTANCE_INIT,
TokenTypes.STATIC_INIT,
TokenTypes.LITERAL_FOR,
TokenTypes.SLIST,
TokenTypes.OBJBLOCK,
};
}
@Override
public int[] getAcceptableTokens()
{
return new int[] {
TokenTypes.VARIABLE_DEF,
TokenTypes.PARAMETER_DEF,
};
}
@Override
public int[] getRequiredTokens()
{
return new int[] {
TokenTypes.IDENT,
TokenTypes.CTOR_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.INSTANCE_INIT,
TokenTypes.STATIC_INIT,
TokenTypes.LITERAL_FOR,
TokenTypes.SLIST,
TokenTypes.OBJBLOCK,
};
}
@Override
public void visitToken(DetailAST aAST)
{
switch(aAST.getType()) {
case TokenTypes.OBJBLOCK:
case TokenTypes.SLIST:
case TokenTypes.LITERAL_FOR:
case TokenTypes.METHOD_DEF:
case TokenTypes.CTOR_DEF:
case TokenTypes.STATIC_INIT:
case TokenTypes.INSTANCE_INIT:
mScopeStack.push(new HashMap());
break;
case TokenTypes.PARAMETER_DEF:
if (ScopeUtils.inInterfaceBlock(aAST)
|| inAbstractMethod(aAST))
{
break;
}
case TokenTypes.VARIABLE_DEF:
if ((aAST.getParent().getType() != TokenTypes.OBJBLOCK)
&& (aAST.getParent().getType() != TokenTypes.FOR_EACH_CLAUSE))
{
insertVariable(aAST);
}
break;
case TokenTypes.IDENT:
final int parentType = aAST.getParent().getType();
if ((TokenTypes.POST_DEC == parentType)
|| (TokenTypes.DEC == parentType)
|| (TokenTypes.POST_INC == parentType)
|| (TokenTypes.INC == parentType)
|| (TokenTypes.ASSIGN == parentType)
|| (TokenTypes.PLUS_ASSIGN == parentType)
|| (TokenTypes.MINUS_ASSIGN == parentType)
|| (TokenTypes.DIV_ASSIGN == parentType)
|| (TokenTypes.STAR_ASSIGN == parentType)
|| (TokenTypes.MOD_ASSIGN == parentType)
|| (TokenTypes.SR_ASSIGN == parentType)
|| (TokenTypes.BSR_ASSIGN == parentType)
|| (TokenTypes.SL_ASSIGN == parentType)
|| (TokenTypes.BXOR_ASSIGN == parentType)
|| (TokenTypes.BOR_ASSIGN == parentType)
|| (TokenTypes.BAND_ASSIGN == parentType))
{
// TODO: is there better way to check is aAST
// in left part of assignment?
if (aAST.getParent().getFirstChild() == aAST) {
removeVariable(aAST);
}
}
break;
default:
}
}
/**
* Determines whether an AST is a descentant of an abstract method.
* @param aAST the AST to check.
* @return true if aAST is a descentant of an abstract method.
*/
private boolean inAbstractMethod(DetailAST aAST)
{
DetailAST parent = aAST.getParent();
while (parent != null) {
if (parent.getType() == TokenTypes.METHOD_DEF) {
final DetailAST modifiers =
parent.findFirstToken(TokenTypes.MODIFIERS);
return modifiers.branchContains(TokenTypes.ABSTRACT);
}
parent = parent.getParent();
}
return false;
}
/**
* Inserts a variable at the topmost scope stack
* @param aAST the variable to insert
*/
private void insertVariable(DetailAST aAST)
{
if (!aAST.branchContains(TokenTypes.FINAL)) {
final Map state = mScopeStack.peek();
final DetailAST ast = aAST.findFirstToken(TokenTypes.IDENT);
state.put(ast.getText(), ast);
}
}
/**
* Removes the variable from the Stacks
* @param aAST Variable to remove
*/
private void removeVariable(DetailAST aAST)
{
for (int i = mScopeStack.size() - 1; i >= 0; i--) {
final Map state = mScopeStack.peek(i);
final Object obj = state.remove(aAST.getText());
if (obj != null) {
break;
}
}
}
@Override
public void leaveToken(DetailAST aAST)
{
super.leaveToken(aAST);
switch(aAST.getType()) {
case TokenTypes.OBJBLOCK:
case TokenTypes.SLIST:
case TokenTypes.LITERAL_FOR:
case TokenTypes.CTOR_DEF:
case TokenTypes.STATIC_INIT:
case TokenTypes.INSTANCE_INIT:
case TokenTypes.METHOD_DEF:
final Map state = mScopeStack.pop();
for (DetailAST var : state.values()) {
log(var.getLineNo(), var.getColumnNo(), "final.variable", var
.getText());
}
break;
default:
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/HiddenFieldCheck.java 100644 0 0 40475 12026051050 30544 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
import java.util.Set;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.apache.commons.beanutils.ConversionException;
/**
*
Checks that a local variable or a parameter does not shadow
* a field that is defined in the same class.
*
*
* An example of how to configure the check is:
*
*
* <module name="HiddenField"/>
*
*
* An example of how to configure the check so that it checks variables but not
* parameters is:
*
* @author Rick Giles
* @version 1.0
*/
public class HiddenFieldCheck
extends Check
{
/** stack of sets of field names,
* one for each class of a set of nested classes.
*/
private FieldFrame mCurrentFrame;
/** the regexp to match against */
private Pattern mRegexp;
/** controls whether to check the parameter of a property setter method */
private boolean mIgnoreSetter;
/** controls whether to check the parameter of a constructor */
private boolean mIgnoreConstructorParameter;
/** controls whether to check the parameter of abstract methods. */
private boolean mIgnoreAbstractMethods;
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.VARIABLE_DEF,
TokenTypes.PARAMETER_DEF,
TokenTypes.CLASS_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.ENUM_CONSTANT_DEF,
};
}
@Override
public int[] getAcceptableTokens()
{
return new int[] {
TokenTypes.VARIABLE_DEF,
TokenTypes.PARAMETER_DEF,
};
}
@Override
public int[] getRequiredTokens()
{
return new int[] {
TokenTypes.CLASS_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.ENUM_CONSTANT_DEF,
};
}
@Override
public void beginTree(DetailAST aRootAST)
{
mCurrentFrame = new FieldFrame(null, true);
}
@Override
public void visitToken(DetailAST aAST)
{
if ((aAST.getType() == TokenTypes.VARIABLE_DEF)
|| (aAST.getType() == TokenTypes.PARAMETER_DEF))
{
processVariable(aAST);
return;
}
//A more thorough check of enum constant class bodies is
//possible (checking for hidden fields against the enum
//class body in addition to enum constant class bodies)
//but not attempted as it seems out of the scope of this
//check.
final DetailAST typeMods = aAST.findFirstToken(TokenTypes.MODIFIERS);
final boolean isStaticInnerType =
(typeMods != null)
&& typeMods.branchContains(TokenTypes.LITERAL_STATIC);
final FieldFrame frame =
new FieldFrame(mCurrentFrame, isStaticInnerType);
//add fields to container
final DetailAST objBlock = aAST.findFirstToken(TokenTypes.OBJBLOCK);
// enum constants may not have bodies
if (objBlock != null) {
DetailAST child = objBlock.getFirstChild();
while (child != null) {
if (child.getType() == TokenTypes.VARIABLE_DEF) {
final String name =
child.findFirstToken(TokenTypes.IDENT).getText();
final DetailAST mods =
child.findFirstToken(TokenTypes.MODIFIERS);
if (mods.branchContains(TokenTypes.LITERAL_STATIC)) {
frame.addStaticField(name);
}
else {
frame.addInstanceField(name);
}
}
child = child.getNextSibling();
}
}
// push container
mCurrentFrame = frame;
}
@Override
public void leaveToken(DetailAST aAST)
{
if ((aAST.getType() == TokenTypes.CLASS_DEF)
|| (aAST.getType() == TokenTypes.ENUM_DEF)
|| (aAST.getType() == TokenTypes.ENUM_CONSTANT_DEF))
{
//pop
mCurrentFrame = mCurrentFrame.getParent();
}
}
/**
* Process a variable token.
* Check whether a local variable or parameter shadows a field.
* Store a field for later comparison with local variables and parameters.
* @param aAST the variable token.
*/
private void processVariable(DetailAST aAST)
{
if (ScopeUtils.inInterfaceOrAnnotationBlock(aAST)
|| (!ScopeUtils.isLocalVariableDef(aAST)
&& (aAST.getType() != TokenTypes.PARAMETER_DEF)))
{
// do nothing
return;
}
//local variable or parameter. Does it shadow a field?
final DetailAST nameAST = aAST.findFirstToken(TokenTypes.IDENT);
final String name = nameAST.getText();
if ((mCurrentFrame.containsStaticField(name)
|| (!inStatic(aAST) && mCurrentFrame.containsInstanceField(name)))
&& ((mRegexp == null) || (!getRegexp().matcher(name).find()))
&& !isIgnoredSetterParam(aAST, name)
&& !isIgnoredConstructorParam(aAST)
&& !isIgnoredParamOfAbstractMethod(aAST))
{
log(nameAST, "hidden.field", name);
}
}
/**
* Determines whether an AST node is in a static method or static
* initializer.
* @param aAST the node to check.
* @return true if aAST is in a static method or a static block;
*/
private static boolean inStatic(DetailAST aAST)
{
DetailAST parent = aAST.getParent();
while (parent != null) {
switch (parent.getType()) {
case TokenTypes.STATIC_INIT:
return true;
case TokenTypes.METHOD_DEF:
final DetailAST mods =
parent.findFirstToken(TokenTypes.MODIFIERS);
return mods.branchContains(TokenTypes.LITERAL_STATIC);
default:
parent = parent.getParent();
}
}
return false;
}
/**
* Decides whether to ignore an AST node that is the parameter of a
* setter method, where the property setter method for field 'xyz' has
* name 'setXyz', one parameter named 'xyz', and return type void.
* @param aAST the AST to check.
* @param aName the name of aAST.
* @return true if aAST should be ignored because check property
* ignoreSetter is true and aAST is the parameter of a setter method.
*/
private boolean isIgnoredSetterParam(DetailAST aAST, String aName)
{
if (aAST.getType() != TokenTypes.PARAMETER_DEF
|| !mIgnoreSetter)
{
return false;
}
//single parameter?
final DetailAST parametersAST = aAST.getParent();
if (parametersAST.getChildCount() != 1) {
return false;
}
//method parameter, not constructor parameter?
final DetailAST methodAST = parametersAST.getParent();
if (methodAST.getType() != TokenTypes.METHOD_DEF) {
return false;
}
//void?
final DetailAST typeAST = methodAST.findFirstToken(TokenTypes.TYPE);
if (!typeAST.branchContains(TokenTypes.LITERAL_VOID)) {
return false;
}
//property setter name?
final String methodName =
methodAST.findFirstToken(TokenTypes.IDENT).getText();
final String expectedName = "set" + capitalize(aName);
return methodName.equals(expectedName);
}
/**
* Capitalizes a given property name the way we expect to see it in
* a setter name.
* @param aName a property name
* @return capitalized property name
*/
private static String capitalize(final String aName)
{
if (aName == null || aName.length() == 0) {
return aName;
}
// we should not capitalize the first character if the second
// one is a capital one, since according to JavaBeans spec
// setXYzz() is a setter for XYzz property, not for xYzz one.
if (aName.length() > 1 && Character.isUpperCase(aName.charAt(1))) {
return aName;
}
return aName.substring(0, 1).toUpperCase() + aName.substring(1);
}
/**
* Decides whether to ignore an AST node that is the parameter of a
* constructor.
* @param aAST the AST to check.
* @return true if aAST should be ignored because check property
* ignoreConstructorParameter is true and aAST is a constructor parameter.
*/
private boolean isIgnoredConstructorParam(DetailAST aAST)
{
if ((aAST.getType() != TokenTypes.PARAMETER_DEF)
|| !mIgnoreConstructorParameter)
{
return false;
}
final DetailAST parametersAST = aAST.getParent();
final DetailAST constructorAST = parametersAST.getParent();
return (constructorAST.getType() == TokenTypes.CTOR_DEF);
}
/**
* Decides whether to ignore an AST node that is the parameter of an
* abstract method.
* @param aAST the AST to check.
* @return true if aAST should be ignored because check property
* ignoreAbstactMethods is true and aAST is a parameter of abstract
* methods.
*/
private boolean isIgnoredParamOfAbstractMethod(DetailAST aAST)
{
if ((aAST.getType() != TokenTypes.PARAMETER_DEF)
|| !mIgnoreAbstractMethods)
{
return false;
}
final DetailAST method = aAST.getParent().getParent();
if (method.getType() != TokenTypes.METHOD_DEF) {
return false;
}
final DetailAST mods = method.findFirstToken(TokenTypes.MODIFIERS);
return ((mods != null) && mods.branchContains(TokenTypes.ABSTRACT));
}
/**
* Set the ignore format to the specified regular expression.
* @param aFormat a String value
* @throws ConversionException unable to parse aFormat
*/
public void setIgnoreFormat(String aFormat)
throws ConversionException
{
try {
mRegexp = Utils.getPattern(aFormat);
}
catch (final PatternSyntaxException e) {
throw new ConversionException("unable to parse " + aFormat, e);
}
}
/**
* Set whether to ignore the parameter of a property setter method.
* @param aIgnoreSetter decide whether to ignore the parameter of
* a property setter method.
*/
public void setIgnoreSetter(boolean aIgnoreSetter)
{
mIgnoreSetter = aIgnoreSetter;
}
/**
* Set whether to ignore constructor parameters.
* @param aIgnoreConstructorParameter decide whether to ignore
* constructor parameters.
*/
public void setIgnoreConstructorParameter(
boolean aIgnoreConstructorParameter)
{
mIgnoreConstructorParameter = aIgnoreConstructorParameter;
}
/**
* Set whether to ignore parameters of abstract methods.
* @param aIgnoreAbstractMethods decide whether to ignore
* parameters of abstract methods.
*/
public void setIgnoreAbstractMethods(
boolean aIgnoreAbstractMethods)
{
mIgnoreAbstractMethods = aIgnoreAbstractMethods;
}
/** @return the regexp to match against */
public Pattern getRegexp()
{
return mRegexp;
}
/**
* Holds the names of static and instance fields of a type.
* @author Rick Giles
* Describe class FieldFrame
* @author Rick Giles
* @version Oct 26, 2003
*/
private static class FieldFrame
{
/** is this a static inner type */
private final boolean mStaticType;
/** parent frame. */
private final FieldFrame mParent;
/** set of instance field names */
private final Set mInstanceFields = Sets.newHashSet();
/** set of static field names */
private final Set mStaticFields = Sets.newHashSet();
/** Creates new frame.
* @param aStaticType is this a static inner type (class or enum).
* @param aParent parent frame.
*/
public FieldFrame(FieldFrame aParent, boolean aStaticType)
{
mParent = aParent;
mStaticType = aStaticType;
}
/** Is this frame for static inner type.
* @return is this field frame for static inner type.
*/
boolean isStaticType()
{
return mStaticType;
}
/**
* Adds an instance field to this FieldFrame.
* @param aField the name of the instance field.
*/
public void addInstanceField(String aField)
{
mInstanceFields.add(aField);
}
/**
* Adds a static field to this FieldFrame.
* @param aField the name of the instance field.
*/
public void addStaticField(String aField)
{
mStaticFields.add(aField);
}
/**
* Determines whether this FieldFrame contains an instance field.
* @param aField the field to check.
* @return true if this FieldFrame contains instance field aField.
*/
public boolean containsInstanceField(String aField)
{
return mInstanceFields.contains(aField)
|| !isStaticType()
&& (mParent != null)
&& mParent.containsInstanceField(aField);
}
/**
* Determines whether this FieldFrame contains a static field.
* @param aField the field to check.
* @return true if this FieldFrame contains static field aField.
*/
public boolean containsStaticField(String aField)
{
return mStaticFields.contains(aField)
|| (mParent != null)
&& mParent.containsStaticField(aField);
}
/**
* Getter for parent frame.
* @return parent frame.
*/
public FieldFrame getParent()
{
return mParent;
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalCatchCheck.java 100644 0 0 5217 12026051050 30674 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
/**
* Catching java.lang.Exception, java.lang.Error or java.lang.RuntimeException
* is almost never acceptable.
* @author Simon Harris
*/
public final class IllegalCatchCheck extends AbstractIllegalCheck
{
/** Creates new instance of the check. */
public IllegalCatchCheck()
{
super(new String[] {"Exception", "Error",
"RuntimeException", "Throwable",
"java.lang.Error",
"java.lang.Exception",
"java.lang.RuntimeException",
"java.lang.Throwable",
});
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.LITERAL_CATCH};
}
@Override
public int[] getRequiredTokens()
{
return getDefaultTokens();
}
@Override
public void visitToken(DetailAST aDetailAST)
{
final DetailAST paramDef =
aDetailAST.findFirstToken(TokenTypes.PARAMETER_DEF);
final DetailAST excType = paramDef.findFirstToken(TokenTypes.TYPE);
final FullIdent ident = CheckUtils.createFullType(excType);
if (isIllegalClassName(ident.getText())) {
log(aDetailAST, "illegal.catch", ident.getText());
}
}
}
././@LongLink 100644 0 0 153 12026055133 10247 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalInstantiationCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalInstantiationChec100644 0 0 26151 12026051050 31423 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 antlr.collections.AST;
import com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
import java.util.Set;
import java.util.StringTokenizer;
// TODO: Clean up potential duplicate code here and in UnusedImportsCheck
/**
*
* Checks for illegal instantiations where a factory method is preferred.
*
*
* Rationale: Depending on the project, for some classes it might be
* preferable to create instances through factory methods rather than
* calling the constructor.
*
*
* A simple example is the java.lang.Boolean class, to save memory and CPU
* cycles it is preferable to use the predeifined constants TRUE and FALSE.
* Constructor invocations should be replaced by calls to Boolean.valueOf().
*
*
* Some extremely performance sensitive projects may require the use of factory
* methods for other classes as well, to enforce the usage of number caches or
* object pools.
*
*
* Limitations: It is currently not possible to specify array classes.
*
*
* An example of how to configure the check is:
*
*
* <module name="IllegalInstantiation"/>
*
* @author lkuehne
*/
public class IllegalInstantiationCheck
extends Check
{
/** Set of fully qualified classnames. E.g. "java.lang.Boolean" */
private final Set mIllegalClasses = Sets.newHashSet();
/** name of the package */
private String mPkgName;
/** the imports for the file */
private final Set mImports = Sets.newHashSet();
/** the class names defined in the file */
private final Set mClassNames = Sets.newHashSet();
/** the instantiations in the file */
private final Set mInstantiations = Sets.newHashSet();
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.IMPORT,
TokenTypes.LITERAL_NEW,
TokenTypes.PACKAGE_DEF,
TokenTypes.CLASS_DEF,
};
}
@Override
public int[] getAcceptableTokens()
{
// Return an empty array to not allow user to change configuration.
return new int[] {};
}
@Override
public int[] getRequiredTokens()
{
return new int[] {
TokenTypes.IMPORT,
TokenTypes.LITERAL_NEW,
TokenTypes.PACKAGE_DEF,
};
}
@Override
public void beginTree(DetailAST aRootAST)
{
super.beginTree(aRootAST);
mPkgName = null;
mImports.clear();
mInstantiations.clear();
mClassNames.clear();
}
@Override
public void visitToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.LITERAL_NEW:
processLiteralNew(aAST);
break;
case TokenTypes.PACKAGE_DEF:
processPackageDef(aAST);
break;
case TokenTypes.IMPORT:
processImport(aAST);
break;
case TokenTypes.CLASS_DEF:
processClassDef(aAST);
break;
default:
throw new IllegalArgumentException("Unknown type " + aAST);
}
}
@Override
public void finishTree(DetailAST aRootAST)
{
for (DetailAST literalNewAST : mInstantiations) {
postprocessLiteralNew(literalNewAST);
}
}
/**
* Collects classes defined in the source file. Required
* to avoid false alarms for local vs. java.lang classes.
*
* @param aAST the classdef token.
*/
private void processClassDef(DetailAST aAST)
{
final DetailAST identToken = aAST.findFirstToken(TokenTypes.IDENT);
final String className = identToken.getText();
mClassNames.add(className);
}
/**
* Perform processing for an import token
* @param aAST the import token
*/
private void processImport(DetailAST aAST)
{
final FullIdent name = FullIdent.createFullIdentBelow(aAST);
if (name != null) {
// Note: different from UnusedImportsCheck.processImport(),
// '.*' imports are also added here
mImports.add(name);
}
}
/**
* Perform processing for an package token
* @param aAST the package token
*/
private void processPackageDef(DetailAST aAST)
{
final DetailAST packageNameAST = aAST.getLastChild()
.getPreviousSibling();
final FullIdent packageIdent =
FullIdent.createFullIdent(packageNameAST);
mPkgName = packageIdent.getText();
}
/**
* Collects a "new" token.
* @param aAST the "new" token
*/
private void processLiteralNew(DetailAST aAST)
{
mInstantiations.add(aAST);
}
/**
* Processes one of the collected "new" tokens when treewalking
* has finished.
* @param aAST the "new" token.
*/
private void postprocessLiteralNew(DetailAST aAST)
{
final DetailAST typeNameAST = aAST.getFirstChild();
final AST nameSibling = typeNameAST.getNextSibling();
if ((nameSibling != null)
&& (nameSibling.getType() == TokenTypes.ARRAY_DECLARATOR))
{
// aAST == "new Boolean[]"
return;
}
final FullIdent typeIdent = FullIdent.createFullIdent(typeNameAST);
final String typeName = typeIdent.getText();
final int lineNo = aAST.getLineNo();
final int colNo = aAST.getColumnNo();
final String fqClassName = getIllegalInstantiation(typeName);
if (fqClassName != null) {
log(lineNo, colNo, "instantiation.avoid", fqClassName);
}
}
/**
* Checks illegal instantiations.
* @param aClassName instantiated class, may or may not be qualified
* @return the fully qualified class name of aClassName
* or null if instantiation of aClassName is OK
*/
private String getIllegalInstantiation(String aClassName)
{
final String javaLang = "java.lang.";
if (mIllegalClasses.contains(aClassName)) {
return aClassName;
}
final int clsNameLen = aClassName.length();
final int pkgNameLen = (mPkgName == null) ? 0 : mPkgName.length();
for (String illegal : mIllegalClasses) {
final int illegalLen = illegal.length();
// class from java.lang
if (((illegalLen - javaLang.length()) == clsNameLen)
&& illegal.endsWith(aClassName)
&& illegal.startsWith(javaLang))
{
// java.lang needs no import, but a class without import might
// also come from the same file or be in the same package.
// E.g. if a class defines an inner class "Boolean",
// the expression "new Boolean()" refers to that class,
// not to java.lang.Boolean
final boolean isSameFile = mClassNames.contains(aClassName);
boolean isSamePackage = false;
try {
final ClassLoader classLoader = getClassLoader();
if (classLoader != null) {
final String fqName = mPkgName + "." + aClassName;
classLoader.loadClass(fqName);
// no ClassNotFoundException, fqName is a known class
isSamePackage = true;
}
}
catch (final ClassNotFoundException ex) {
// not a class from the same package
isSamePackage = false;
}
if (!(isSameFile || isSamePackage)) {
return illegal;
}
}
// class from same package
// the toplevel package (mPkgName == null) is covered by the
// "illegalInsts.contains(aClassName)" check above
// the test is the "no garbage" version of
// illegal.equals(mPkgName + "." + aClassName)
if ((mPkgName != null)
&& (clsNameLen == illegalLen - pkgNameLen - 1)
&& (illegal.charAt(pkgNameLen) == '.')
&& illegal.endsWith(aClassName)
&& illegal.startsWith(mPkgName))
{
return illegal;
}
// import statements
for (FullIdent importLineText : mImports) {
final String importArg = importLineText.getText();
if (importArg.endsWith(".*")) {
final String fqClass =
importArg.substring(0, importArg.length() - 1)
+ aClassName;
// assume that illegalInsts only contain existing classes
// or else we might create a false alarm here
if (mIllegalClasses.contains(fqClass)) {
return fqClass;
}
}
else {
if (Utils.baseClassname(importArg).equals(aClassName)
&& mIllegalClasses.contains(importArg))
{
return importArg;
}
}
}
}
return null;
}
/**
* Sets the classes that are illegal to instantiate.
* @param aClassNames a comma seperate list of class names
*/
public void setClasses(String aClassNames)
{
mIllegalClasses.clear();
final StringTokenizer tok = new StringTokenizer(aClassNames, ",");
while (tok.hasMoreTokens()) {
mIllegalClasses.add(tok.nextToken());
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalThrowsCheck.java 100644 0 0 7460 12026051050 31142 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.util.Set;
/**
* Throwing java.lang.Error or java.lang.RuntimeException
* is almost never acceptable.
* @author Oliver Burn
*/
public final class IllegalThrowsCheck extends AbstractIllegalCheck
{
/** Default ignored method names. */
private static final String[] DEFAULT_IGNORED_METHOD_NAMES = {
"finalize",
};
/** methods which should be ignored. */
private final Set mIgnoredMethodNames = Sets.newHashSet();
/** Creates new instance of the check. */
public IllegalThrowsCheck()
{
super(new String[] {"Error",
"RuntimeException", "Throwable",
"java.lang.Error",
"java.lang.RuntimeException",
"java.lang.Throwable",
});
setIgnoredMethodNames(DEFAULT_IGNORED_METHOD_NAMES);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.LITERAL_THROWS};
}
@Override
public int[] getRequiredTokens()
{
return getDefaultTokens();
}
@Override
public void visitToken(DetailAST aDetailAST)
{
DetailAST token = aDetailAST.getFirstChild();
// Check if the method with the given name should be ignored.
if (!(shouldIgnoreMethod(aDetailAST.getParent().findFirstToken(
TokenTypes.IDENT).getText())))
{
while (token != null) {
if (token.getType() != TokenTypes.COMMA) {
final FullIdent ident = FullIdent.createFullIdent(token);
if (isIllegalClassName(ident.getText())) {
log(token, "illegal.throw", ident.getText());
}
}
token = token.getNextSibling();
}
}
}
/**
* Check if the method is specified in the ignore method list
* @param aName the name to check
* @return whether the method with the passed name should be ignored
*/
private boolean shouldIgnoreMethod(String aName)
{
return mIgnoredMethodNames.contains(aName);
}
/**
* Set the list of ignore method names.
* @param aMethodNames array of ignored method names
*/
public void setIgnoredMethodNames(String[] aMethodNames)
{
mIgnoredMethodNames.clear();
for (String element : aMethodNames) {
mIgnoredMethodNames.add(element);
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTokenCheck.java 100644 0 0 6256 12026051050 30736 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.util.Set;
/**
*
* Checks for illegal tokens.
*
*
* Rational: Certain language features are often lead to hard to
* maintain code or are non-obvious to novice developers. Others
* may be discouraged in certain frameworks, such as not having
* native methods in EJB components.
*
*
* An example of how to configure the check is:
*
*
* <module name="IllegalToken"/>
*
*
An example of how to configure the check to forbid
* a {@link TokenTypes#LITERAL_NATIVE LITERAL_NATIVE} token is:
*
* @author Simon Harris
* @author Rick Giles
*/
public class IllegalTokenCheck
extends Check
{
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.LITERAL_SWITCH,
TokenTypes.POST_INC,
TokenTypes.POST_DEC,
};
}
@Override
public int[] getAcceptableTokens()
{
// Any tokens set by property 'tokens' are acceptable
int[] tokensToCopy = getDefaultTokens();
final Set tokenNames = getTokenNames();
if (!tokenNames.isEmpty()) {
tokensToCopy = new int[tokenNames.size()];
int i = 0;
for (String name : tokenNames) {
tokensToCopy[i] = TokenTypes.getTokenId(name);
i++;
}
}
final int[] copy = new int[tokensToCopy.length];
System.arraycopy(tokensToCopy, 0, copy, 0, tokensToCopy.length);
return copy;
}
@Override
public void visitToken(DetailAST aAST)
{
log(
aAST.getLineNo(),
aAST.getColumnNo(),
"illegal.token",
aAST.getText());
}
}
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTokenTextCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTokenTextCheck.ja100644 0 0 10461 12026051050 31265 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck;
import java.util.Set;
import java.util.regex.Pattern;
/**
*
* Checks for illegal token text.
*
*
An example of how to configure the check to forbid String literals
* containing "a href" is:
*
* @author Rick Giles
*/
public class IllegalTokenTextCheck
extends AbstractFormatCheck
{
/**
* Custom message for report if illegal regexp found
* ignored if empty.
*/
private String mMessage = "";
/**
* Instantiates a new instance.
*/
public IllegalTokenTextCheck()
{
super("$^"); // the empty language
}
@Override
public void beginTree(DetailAST aRootAST)
{
}
@Override
public int[] getDefaultTokens()
{
return new int[0];
}
@Override
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;
for (final String name : tokenNames) {
result[i] = TokenTypes.getTokenId(name);
i++;
}
return result;
}
@Override
public void visitToken(DetailAST aAST)
{
final String text = aAST.getText();
if (getRegexp().matcher(text).find()) {
String message = getMessage();
if ("".equals(message)) {
message = "illegal.token.text";
}
log(
aAST.getLineNo(),
aAST.getColumnNo(),
message,
getFormat());
}
}
/**
* Setter for message property.
* @param aMessage custom message which should be used
* to report about violations.
*/
public void setMessage(String aMessage)
{
mMessage = (null == aMessage) ? "" : aMessage;
}
/**
* Getter for message property.
* @return custom message which should be used
* to report about violations.
*/
public String getMessage()
{
return mMessage;
}
/**
* Set whether or not the match is case sensitive.
* @param aCaseInsensitive true if the match is case insensitive.
*/
public void setIgnoreCase(boolean aCaseInsensitive)
{
if (aCaseInsensitive) {
setCompileFlags(Pattern.CASE_INSENSITIVE);
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/IllegalTypeCheck.java 100644 0 0 21224 12026051047 30615 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
import java.util.Set;
/**
*
* Checks that particular class are never used as types in variable
* declarations, return values or parameters. Includes
* a pattern check that by default disallows abstract classes.
*
*
* Rationale:
* Helps reduce coupling on concrete classes. In addition abstract
* classes should be thought of a convenience base class
* implementations of interfaces and as such are not types themsleves.
*
* @author Simon Harris
*/
public final class IllegalTypeCheck extends AbstractFormatCheck
{
/** Default value of pattern for illegal class name. */
private static final String DEFAULT_FORMAT = "^(.*[\\.])?Abstract.*$";
/** Abstract classes legal by default. */
private static final String[] DEFAULT_LEGAL_ABSTRACT_NAMES = {};
/** Types illegal by default. */
private static final String[] DEFAULT_ILLEGAL_TYPES = {
"GregorianCalendar",
"Hashtable",
"HashSet",
"HashMap",
"ArrayList",
"LinkedList",
"LinkedHashMap",
"LinkedHashSet",
"TreeSet",
"TreeMap",
"Vector",
"java.util.GregorianCalendar",
"java.util.Hashtable",
"java.util.HashSet",
"java.util.HashMap",
"java.util.ArrayList",
"java.util.LinkedList",
"java.util.LinkedHashMap",
"java.util.LinkedHashSet",
"java.util.TreeSet",
"java.util.TreeMap",
"java.util.Vector",
};
/** Default ignored method names. */
private static final String[] DEFAULT_IGNORED_METHOD_NAMES = {
"getInitialContext",
"getEnvironment",
};
/** illegal classes. */
private final Set mIllegalClassNames = Sets.newHashSet();
/** legal abstract classes. */
private final Set mLegalAbstractClassNames = Sets.newHashSet();
/** methods which should be ignored. */
private final Set mIgnoredMethodNames = Sets.newHashSet();
/** Creates new instance of the check. */
public IllegalTypeCheck()
{
super(DEFAULT_FORMAT);
setIllegalClassNames(DEFAULT_ILLEGAL_TYPES);
setLegalAbstractClassNames(DEFAULT_LEGAL_ABSTRACT_NAMES);
setIgnoredMethodNames(DEFAULT_IGNORED_METHOD_NAMES);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.VARIABLE_DEF,
TokenTypes.PARAMETER_DEF,
TokenTypes.METHOD_DEF,
};
}
@Override
public void visitToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.METHOD_DEF:
visitMethodDef(aAST);
break;
case TokenTypes.VARIABLE_DEF:
visitVariableDef(aAST);
break;
case TokenTypes.PARAMETER_DEF:
visitParameterDef(aAST);
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
/**
* Checks return type of a given method.
* @param aAST method for check.
*/
private void visitMethodDef(DetailAST aAST)
{
if (isCheckedMethod(aAST)) {
checkClassName(aAST);
}
}
/**
* Checks type of parameters.
* @param aAST parameter list for check.
*/
private void visitParameterDef(DetailAST aAST)
{
final DetailAST grandParentAST = aAST.getParent().getParent();
if ((grandParentAST.getType() == TokenTypes.METHOD_DEF)
&& isCheckedMethod(grandParentAST))
{
checkClassName(aAST);
}
}
/**
* Checks type of given variable.
* @param aAST variable to check.
*/
private void visitVariableDef(DetailAST aAST)
{
checkClassName(aAST);
}
/**
* Checks type of given method, parameter or variable.
* @param aAST node to check.
*/
private void checkClassName(DetailAST aAST)
{
final DetailAST type = aAST.findFirstToken(TokenTypes.TYPE);
final FullIdent ident = CheckUtils.createFullType(type);
if (isMatchingClassName(ident.getText())) {
log(ident.getLineNo(), ident.getColumnNo(),
"illegal.type", ident.getText());
}
}
/**
* @param aClassName class name to check.
* @return true if given class name is one of illegal classes
* or if it matches to abstract class names pattern.
*/
private boolean isMatchingClassName(String aClassName)
{
return mIllegalClassNames.contains(aClassName)
|| (!mLegalAbstractClassNames.contains(aClassName)
&& getRegexp().matcher(aClassName).find());
}
/**
* @param aAST method def to check.
* @return true if we should check this method.
*/
private boolean isCheckedMethod(DetailAST aAST)
{
final String methodName =
aAST.findFirstToken(TokenTypes.IDENT).getText();
return !mIgnoredMethodNames.contains(methodName);
}
/**
* Set the list of illegal variable types.
* @param aClassNames array of illegal variable types
*/
public void setIllegalClassNames(String[] aClassNames)
{
mIllegalClassNames.clear();
for (String name : aClassNames) {
mIllegalClassNames.add(name);
final int lastDot = name.lastIndexOf(".");
if ((lastDot > 0) && (lastDot < (name.length() - 1))) {
final String shortName =
name.substring(name.lastIndexOf(".") + 1);
mIllegalClassNames.add(shortName);
}
}
}
/**
* Get the list of illegal variable types.
* @return array of illegal variable types
*/
public String[] getIllegalClassNames()
{
return mIllegalClassNames.toArray(
new String[mIllegalClassNames.size()]);
}
/**
* Set the list of ignore method names.
* @param aMethodNames array of ignored method names
*/
public void setIgnoredMethodNames(String[] aMethodNames)
{
mIgnoredMethodNames.clear();
for (String element : aMethodNames) {
mIgnoredMethodNames.add(element);
}
}
/**
* Get the list of ignored method names.
* @return array of ignored method names
*/
public String[] getIgnoredMethodNames()
{
return mIgnoredMethodNames.toArray(
new String[mIgnoredMethodNames.size()]);
}
/**
* Set the list of legal abstract class names.
* @param aClassNames array of legal abstract class names
*/
public void setLegalAbstractClassNames(String[] aClassNames)
{
mLegalAbstractClassNames.clear();
for (String element : aClassNames) {
mLegalAbstractClassNames.add(element);
}
}
/**
* Get the list of legal abstract class names.
* @return array of legal abstract class names
*/
public String[] getLegalAbstractClassNames()
{
return mLegalAbstractClassNames.toArray(
new String[mLegalAbstractClassNames.size()]);
}
}
././@LongLink 100644 0 0 146 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/InnerAssignmentCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/InnerAssignmentCheck.jav100644 0 0 16566 12026051047 31362 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 antlr.collections.AST;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
*
* Checks for assignments in subexpressions, such as in
* String s = Integer.toString(i = 2);.
*
*
* Rationale: With the exception of for iterators, all assignments
* should occur in their own toplevel statement to increase readability.
* With inner assignments like the above it is difficult to see all places
* where a variable is set.
*
*
* @author lkuehne
*/
public class InnerAssignmentCheck
extends Check
{
/**
* list of allowed AST types from an assignement AST node
* towards the root.
*/
private static final int[][] ALLOWED_ASSIGMENT_CONTEXT = {
{TokenTypes.EXPR, TokenTypes.SLIST},
{TokenTypes.VARIABLE_DEF},
{TokenTypes.EXPR, TokenTypes.ELIST, TokenTypes.FOR_INIT},
{TokenTypes.EXPR, TokenTypes.ELIST, TokenTypes.FOR_ITERATOR},
{TokenTypes.ANNOTATION_MEMBER_VALUE_PAIR},
{
TokenTypes.RESOURCE,
TokenTypes.RESOURCES,
TokenTypes.RESOURCE_SPECIFICATION,
},
};
/**
* list of allowed AST types from an assignement AST node
* towards the root.
*/
private static final int[][] CONTROL_CONTEXT = {
{TokenTypes.EXPR, TokenTypes.LITERAL_DO},
{TokenTypes.EXPR, TokenTypes.LITERAL_FOR},
{TokenTypes.EXPR, TokenTypes.LITERAL_WHILE},
{TokenTypes.EXPR, TokenTypes.LITERAL_IF},
{TokenTypes.EXPR, TokenTypes.LITERAL_ELSE},
};
/**
* list of allowed AST types from a comparison node (above an assignement)
* towards the root.
*/
private static final int[][] ALLOWED_ASSIGMENT_IN_COMPARISON_CONTEXT = {
{TokenTypes.EXPR, TokenTypes.LITERAL_WHILE, },
};
/**
* The token types that identify comparison operators.
*/
private static final int[] COMPARISON_TYPES = {
TokenTypes.EQUAL,
TokenTypes.GE,
TokenTypes.GT,
TokenTypes.LE,
TokenTypes.LT,
TokenTypes.NOT_EQUAL,
};
static {
Arrays.sort(COMPARISON_TYPES);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.ASSIGN, // '='
TokenTypes.DIV_ASSIGN, // "/="
TokenTypes.PLUS_ASSIGN, // "+="
TokenTypes.MINUS_ASSIGN, //"-="
TokenTypes.STAR_ASSIGN, // "*="
TokenTypes.MOD_ASSIGN, // "%="
TokenTypes.SR_ASSIGN, // ">>="
TokenTypes.BSR_ASSIGN, // ">>>="
TokenTypes.SL_ASSIGN, // "<<="
TokenTypes.BXOR_ASSIGN, // "^="
TokenTypes.BOR_ASSIGN, // "|="
TokenTypes.BAND_ASSIGN, // "&="
};
}
@Override
public void visitToken(DetailAST aAST)
{
if (isInContext(aAST, ALLOWED_ASSIGMENT_CONTEXT)) {
return;
}
if (isInNoBraceControlStatement(aAST)) {
return;
}
if (isInWhileIdiom(aAST)) {
return;
}
log(aAST.getLineNo(), aAST.getColumnNo(), "assignment.inner.avoid");
}
/**
* Determines if aAST is in the body of a flow control statement without
* braces. An example of such a statement would be
*
*
* if (y < 0)
* x = y;
*
*
* This leads to the following AST structure:
*
*
* LITERAL_IF
* LPAREN
* EXPR // test
* RPAREN
* EXPR // body
* SEMI
*
*
* We need to ensure that aAST is in the body and not in the test.
*
* @param aAST an assignment operator AST
* @return whether aAST is in the body of a flow control statement
*/
private static boolean isInNoBraceControlStatement(DetailAST aAST)
{
if (!isInContext(aAST, CONTROL_CONTEXT)) {
return false;
}
final DetailAST expr = aAST.getParent();
final AST exprNext = expr.getNextSibling();
return (exprNext != null) && (exprNext.getType() == TokenTypes.SEMI);
}
/**
* Tests whether the given AST is used in the "assignment in while test"
* idiom.
*
*
* while ((b = is.read()) != -1) {
* // work with b
* }
*
* @param aAST assignment AST
* @return whether the context of the assignemt AST indicates the idiom
*/
private boolean isInWhileIdiom(DetailAST aAST)
{
if (!isComparison(aAST.getParent())) {
return false;
}
return isInContext(
aAST.getParent(), ALLOWED_ASSIGMENT_IN_COMPARISON_CONTEXT);
}
/**
* Checks if an AST is a comparison operator.
* @param aAST the AST to check
* @return true iff aAST is a comparison operator.
*/
private static boolean isComparison(DetailAST aAST)
{
final int astType = aAST.getType();
return (Arrays.binarySearch(COMPARISON_TYPES, astType) >= 0);
}
/**
* Tests whether the provided AST is in
* one of the given contexts.
*
* @param aAST the AST from which to start walking towards root
* @param aContextSet the contexts to test against.
*
* @return whether the parents nodes of aAST match
* one of the allowed type paths
*/
private static boolean isInContext(DetailAST aAST, int[][] aContextSet)
{
for (int[] element : aContextSet) {
DetailAST current = aAST;
final int len = element.length;
for (int j = 0; j < len; j++) {
current = current.getParent();
final int expectedType = element[j];
if ((current == null) || (current.getType() != expectedType)) {
break;
}
if (j == len - 1) {
return true;
}
}
}
return false;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/JUnitTestCaseCheck.java 100644 0 0 17574 12026051047 31104 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
/**
* Ensures that the setUp(), tearDown()methods are named correctly,
* have no arguments, return void and are either public or protected.
* Also ensures that suite() is named correctly, have no arguments, return
* junit.framewotk.Test, public and static.
*
* Rationale: often times developers will misname one or more of these
* methods and not realise that the method is not being called.
*
* @author Simon Harris
*/
public final class JUnitTestCaseCheck extends Check
{
/** setUp() method name. */
private static final String SET_UP_METHOD_NAME = "setUp";
/** tearDown() method name. */
private static final String TEAR_DOWN_METHOD_NAME = "tearDown";
/** suite() method name. */
private static final String SUITE_METHOD_NAME = "suite";
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.METHOD_DEF};
}
@Override
public int[] getRequiredTokens()
{
return getDefaultTokens();
}
@Override
public void visitToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.METHOD_DEF:
visitMethodDef(aAST);
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
/**
* Checks given method definition.
* @param aAST a method def node for check
*/
private void visitMethodDef(DetailAST aAST)
{
final String name = aAST.findFirstToken(TokenTypes.IDENT).getText();
if (name.equalsIgnoreCase(SET_UP_METHOD_NAME)) {
checkSetUpTearDownMethod(aAST, name, SET_UP_METHOD_NAME);
}
else if (name.equalsIgnoreCase(TEAR_DOWN_METHOD_NAME)) {
checkSetUpTearDownMethod(aAST, name, TEAR_DOWN_METHOD_NAME);
}
else if (name.equalsIgnoreCase(SUITE_METHOD_NAME)) {
checkSuiteMethod(aAST, name);
}
}
/**
* Checks signature/name of suite().
* @param aAST method definition node
* @param aActualName method name
*/
private void checkSuiteMethod(DetailAST aAST, String aActualName)
{
if (!aActualName.equals(SUITE_METHOD_NAME)) {
log(aAST, "junit.method.name", SUITE_METHOD_NAME);
}
if (!isPublicAndStatic(aAST)) {
log(aAST, "junit.method.public.and.static", SUITE_METHOD_NAME);
}
// let's check return type
final DetailAST typeAST = aAST.findFirstToken(TokenTypes.TYPE);
final boolean isArray =
(typeAST.findFirstToken(TokenTypes.ARRAY_DECLARATOR) != null);
final String type = CheckUtils.createFullType(typeAST).getText();
if (isArray
|| (!"Test".equals(type)
&& !"junit.framework.Test".equals(type)))
{
log(aAST, "junit.method.return.type",
SUITE_METHOD_NAME, "junit.framework.Test");
}
checkParameters(aAST, SUITE_METHOD_NAME);
}
/**
* Checks signature/name of setUp()/tearDown.
* @param aAST method definition node
* @param aActualName actual method name
* @param aExpectedName expected method name
*/
private void checkSetUpTearDownMethod(DetailAST aAST, String aActualName,
String aExpectedName)
{
if (!aActualName.equals(aExpectedName)) {
log(aAST, "junit.method.name", aActualName, aExpectedName);
}
if (!isPublicOrProtected(aAST)) {
log(aAST, "junit.method.protected.or.public", aExpectedName);
}
if (isStatic(aAST)) {
log(aAST, "junit.method.static", aExpectedName);
}
checkReturnValue(aAST, aActualName);
checkParameters(aAST, aActualName);
}
/**
* Checks that given method returns void.
* @param aAST method definition node
* @param aName method name
*/
private void checkReturnValue(DetailAST aAST, String aName)
{
final DetailAST returnValueAST = aAST.findFirstToken(TokenTypes.TYPE);
if (returnValueAST.findFirstToken(TokenTypes.LITERAL_VOID) == null) {
log(aAST, "junit.method.return.type", aName, "void");
}
}
/**
* Checks return value of given method.
* @param aAST method definition node
* @param aName method name
*/
private void checkParameters(DetailAST aAST, String aName)
{
final DetailAST parametersAST =
aAST.findFirstToken(TokenTypes.PARAMETERS);
if (parametersAST.getChildCount() != 0) {
log(aAST, "junit.method.parameters", aName);
}
}
/**
* Checks if given method declared as public or
* protected and non-static.
* @param aAST method definition node
* @return true if given method is declared as public or protected
*/
private boolean isPublicOrProtected(DetailAST aAST)
{
final DetailAST modifiersAST =
aAST.findFirstToken(TokenTypes.MODIFIERS);
final DetailAST publicAST =
modifiersAST.findFirstToken(TokenTypes.LITERAL_PUBLIC);
final DetailAST protectedAST =
modifiersAST.findFirstToken(TokenTypes.LITERAL_PROTECTED);
return (publicAST != null) || (protectedAST != null);
}
/**
* Checks if given method declared as public and
* static.
* @param aAST method definition node
* @return true if given method is declared as public and static
*/
private boolean isPublicAndStatic(DetailAST aAST)
{
final DetailAST modifiersAST =
aAST.findFirstToken(TokenTypes.MODIFIERS);
final DetailAST publicAST =
modifiersAST.findFirstToken(TokenTypes.LITERAL_PUBLIC);
final DetailAST staticAST =
modifiersAST.findFirstToken(TokenTypes.LITERAL_STATIC);
return (publicAST != null) && (staticAST != null);
}
/**
* Checks if given method declared as static.
* @param aAST method definition node
* @return true if given method is declared as static
*/
private boolean isStatic(DetailAST aAST)
{
final DetailAST modifiersAST =
aAST.findFirstToken(TokenTypes.MODIFIERS);
final DetailAST staticAST =
modifiersAST.findFirstToken(TokenTypes.LITERAL_STATIC);
return (staticAST != null);
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/MagicNumberCheck.java 100644 0 0 23265 12026051047 30602 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
import java.util.Arrays;
/**
*
* Checks for magic numbers.
*
*
* An example of how to configure the check to ignore
* numbers 0, 1, 1.5, 2:
*
* @author Rick Giles
* @author Lars Kühne
* @author Daniel Solano Gómez
*/
public class MagicNumberCheck extends Check
{
/**
* The token types that are allowed in the AST path from the
* number literal to the enclosing constant definition.
*/
private static final int[] ALLOWED_PATH_TOKENTYPES = {
TokenTypes.ASSIGN,
TokenTypes.ARRAY_INIT,
TokenTypes.EXPR,
TokenTypes.UNARY_PLUS,
TokenTypes.UNARY_MINUS,
TokenTypes.TYPECAST,
TokenTypes.ELIST,
TokenTypes.LITERAL_NEW,
TokenTypes.METHOD_CALL,
TokenTypes.STAR,
};
static {
Arrays.sort(ALLOWED_PATH_TOKENTYPES);
}
/** the numbers to ignore in the check, sorted */
private double[] mIgnoreNumbers = {-1, 0, 1, 2};
/** Whether to ignore magic numbers in a hash code method. */
private boolean mIgnoreHashCodeMethod;
/** Whether to ignore magic numbers in annotation. */
private boolean mIgnoreAnnotation;
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.NUM_DOUBLE,
TokenTypes.NUM_FLOAT,
TokenTypes.NUM_INT,
TokenTypes.NUM_LONG,
};
}
@Override
public void visitToken(DetailAST aAST)
{
if (mIgnoreAnnotation && isInAnnotation(aAST)) {
return;
}
if (inIgnoreList(aAST)
|| (mIgnoreHashCodeMethod && isInHashCodeMethod(aAST)))
{
return;
}
final DetailAST constantDefAST = findContainingConstantDef(aAST);
if (constantDefAST == null) {
reportMagicNumber(aAST);
}
else {
DetailAST ast = aAST.getParent();
while (ast != constantDefAST) {
final int type = ast.getType();
if (Arrays.binarySearch(ALLOWED_PATH_TOKENTYPES, type) < 0) {
reportMagicNumber(aAST);
break;
}
ast = ast.getParent();
}
}
}
/**
* Finds the constant definition that contains aAST.
* @param aAST the AST
* @return the constant def or null if aAST is not
* contained in a constant definition
*/
private DetailAST findContainingConstantDef(DetailAST aAST)
{
DetailAST varDefAST = aAST;
while ((varDefAST != null)
&& (varDefAST.getType() != TokenTypes.VARIABLE_DEF)
&& (varDefAST.getType() != TokenTypes.ENUM_CONSTANT_DEF))
{
varDefAST = varDefAST.getParent();
}
// no containing variable definition?
if (varDefAST == null) {
return null;
}
// implicit constant?
if (ScopeUtils.inInterfaceOrAnnotationBlock(varDefAST)
|| (varDefAST.getType() == TokenTypes.ENUM_CONSTANT_DEF))
{
return varDefAST;
}
// explicit constant
final DetailAST modifiersAST =
varDefAST.findFirstToken(TokenTypes.MODIFIERS);
if (modifiersAST.branchContains(TokenTypes.FINAL)) {
return varDefAST;
}
return null;
}
/**
* Reports aAST as a magic number, includes unary operators as needed.
* @param aAST the AST node that contains the number to report
*/
private void reportMagicNumber(DetailAST aAST)
{
String text = aAST.getText();
final DetailAST parent = aAST.getParent();
DetailAST reportAST = aAST;
if (parent.getType() == TokenTypes.UNARY_MINUS) {
reportAST = parent;
text = "-" + text;
}
else if (parent.getType() == TokenTypes.UNARY_PLUS) {
reportAST = parent;
text = "+" + text;
}
log(reportAST.getLineNo(),
reportAST.getColumnNo(),
"magic.number",
text);
}
/**
* Determines whether or not the given AST is in a valid hash code method.
* A valid hash code method is considered to be a method of the signature
* {@code public int hashCode()}.
*
* @param aAST the AST from which to search for an enclosing hash code
* method definition
*
* @return {@code true} if {@code aAST} is in the scope of a valid hash
* code method
*/
private boolean isInHashCodeMethod(DetailAST aAST)
{
// if not in a code block, can't be in hashCode()
if (!ScopeUtils.inCodeBlock(aAST)) {
return false;
}
// find the method definition AST
DetailAST methodDefAST = aAST.getParent();
while ((null != methodDefAST)
&& (TokenTypes.METHOD_DEF != methodDefAST.getType()))
{
methodDefAST = methodDefAST.getParent();
}
if (null == methodDefAST) {
return false;
}
// Check for 'hashCode' name.
final DetailAST identAST =
methodDefAST.findFirstToken(TokenTypes.IDENT);
if (!"hashCode".equals(identAST.getText())) {
return false;
}
// Check for no arguments.
final DetailAST paramAST =
methodDefAST.findFirstToken(TokenTypes.PARAMETERS);
if (0 != paramAST.getChildCount()) {
return false;
}
// we are in a 'public int hashCode()' method! The compiler will ensure
// the method returns an 'int' and is public.
return true;
}
/**
* Decides whether the number of an AST is in the ignore list of this
* check.
* @param aAST the AST to check
* @return true if the number of aAST is in the ignore list of this
* check.
*/
private boolean inIgnoreList(DetailAST aAST)
{
double value = CheckUtils.parseDouble(aAST.getText(), aAST.getType());
final DetailAST parent = aAST.getParent();
if (parent.getType() == TokenTypes.UNARY_MINUS) {
value = -1 * value;
}
return (Arrays.binarySearch(mIgnoreNumbers, value) >= 0);
}
/**
* Sets the numbers to ignore in the check.
* BeanUtils converts numeric token list to double array automatically.
* @param aList list of numbers to ignore.
*/
public void setIgnoreNumbers(double[] aList)
{
if ((aList == null) || (aList.length == 0)) {
mIgnoreNumbers = new double[0];
}
else {
mIgnoreNumbers = new double[aList.length];
System.arraycopy(aList, 0, mIgnoreNumbers, 0, aList.length);
Arrays.sort(mIgnoreNumbers);
}
}
/**
* Set whether to ignore hashCode methods.
* @param aIgnoreHashCodeMethod decide whether to ignore
* hash code methods
*/
public void setIgnoreHashCodeMethod(boolean aIgnoreHashCodeMethod)
{
mIgnoreHashCodeMethod = aIgnoreHashCodeMethod;
}
/**
* Set whether to ignore Annotations.
* @param aIgnoreAnnotation decide whether to ignore annotations
*/
public void setIgnoreAnnotation(boolean aIgnoreAnnotation)
{
mIgnoreAnnotation = aIgnoreAnnotation;
}
/**
* Determines if the column displays a token type of annotation or
* annotation member
*
* @param aAST the AST from which to search for annotations
*
* @return {@code true} if the token type for this node is a annotation
*/
private boolean isInAnnotation(DetailAST aAST)
{
if ((null == aAST.getParent())
|| (null == aAST.getParent().getParent()))
{
return false;
}
return (TokenTypes.ANNOTATION == aAST.getParent().getParent().getType())
|| (TokenTypes.ANNOTATION_MEMBER_VALUE_PAIR
== aAST.getParent().getParent().getType());
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/messages.properties 100644 0 0 10737 11743005374 30544 0 ustar 0 0 array.trailing.comma=Array should contain trailing comma.
assignment.inner.avoid=Inner assignments should be avoided.
avoid.finalizer.method=Avoid using finalizer method.
avoid.clone.method=Avoid using clone method.
covariant.equals=covariant equals without overriding equals(java.lang.Object).
declaration.order.constructor=Constructor definition in wrong order.
declaration.order.method=Method definition in wrong order.
declaration.order.static=Static variable definition in wrong order.
declaration.order.instance=Instance variable definition in wrong order.
declaration.order.access=Variable access definition in wrong order.
default.comes.last=Default should be last label in the switch.
empty.statement=Empty statement.
equals.avoid.null=String literal expressions should be on the left side of an equals comparison.
equalsIgnoreCase.avoid.null=String literal expressions should be on the left side of an equalsIgnoreCase comparison.
equals.noHashCode=Definition of ''equals()'' without corresponding definition of ''hashCode()''.
explicit.init=Variable ''{0}'' explicitly initialized to ''{1}'' (default value for its type).
fall.through=Fall through from previous branch of the switch statement.
fall.through.last=Fall through from the last branch of the switch statement.
final.variable=Variable ''{0}'' should be declared final.
hidden.field=''{0}'' hides a field.
illegal.catch=Catching ''{0}'' is not allowed.
illegal.throw=Throwing ''{0}'' is not allowed.
illegal.token=Using ''{0}'' is not allowed.
illegal.token.text=Token text matches the illegal pattern ''{0}''.
illegal.type=Declaring variables, return values or parameters of type ''{0}'' is not allowed.
inline.conditional.avoid=Avoid inline conditionals.
instantiation.avoid=Instantiation of {0} should be avoided.
junit.method.name=The method ''{0}'' should be named ''{1}''.
junit.method.return.type=The method ''{0}'' must be declared with a {1} return type.
junit.method.parameters=The method ''{0}'' must be declared with no parameters.
junit.method.public.and.static=The method ''{0}'' must be declared static.
junit.method.protected.or.public=The method ''{0}'' must be public or protected.
junit.method.static=The method ''{0}'' shouldn''t be static.
magic.number=''{0}'' is a magic number.
missing.ctor=Class should define a constructor.
missing.package.declaration=Missing package declaration.
missing.super.call=Method ''{0}'' should call ''super.{0}''.
missing.switch.default=switch without \"default\" clause.
modified.control.variable=Control variable ''{0}'' is modified.
multiple.statements.line=Only one statement per line allowed.
multiple.string.literal=The String {0} appears {1} times in the file.
multiple.variable.declarations=Only one variable definition per line allowed.
multiple.variable.declarations.comma=Each variable declaration must be in its own statement.
nested.for.depth=Nested for depth is {0,number,integer} (max allowed is {1,number,integer}).
nested.if.depth=Nested if-else depth is {0,number,integer} (max allowed is {1,number,integer}).
nested.try.depth=Nested try depth is {0,number,integer} (max allowed is {1,number,integer}).
parameter.assignment=Assignment of parameter ''{0}'' is not allowed.
redundant.throws.classInfo=Unable to get class information for {0}.
redundant.throws.duplicate=Redundant throws: ''{0}'' listed more then one time.
redundant.throws.subclass=Redundant throws: ''{0}'' is subclass of ''{1}''.
redundant.throws.unchecked=Redundant throws: ''{0}'' is unchecked exception.
require.this.variable=Reference to instance variable ''{0}'' needs \"this.\".
require.this.unfound.variable=Unable find where ''{0}'' is declared.
require.this.method=Method call to ''{0}'' needs \"this.\".
return.count=Return count is {0,number,integer} (max allowed is {1,number,integer}).
simplify.boolreturn=Conditional logic can be removed.
simplify.expression=Expression can be simplified.
string.literal.equality=Literal Strings should be compared using equals(), not ''{0}''.
unnecessary.paren.assign=Unnecessary parentheses around assignment right-hand side.
unnecessary.paren.expr=Unnecessary parentheses around expression.
unnecessary.paren.ident=Unnecessary parentheses around identifier ''{0}''.
unnecessary.paren.literal=Unnecessary parentheses around literal ''{0}''.
unnecessary.paren.return=Unnecessary parentheses around return value.
unnecessary.paren.string=Unnecessary parentheses around string {0}.
package.dir.mismatch=Package declaration does not match directory ''{0}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/messages_de.properties 100644 0 0 10703 11743005374 31205 0 ustar 0 0 array.trailing.comma=Array sollte mit einem Komma abheschlossen werden.
assignment.inner.avoid=Innere Zuweisungen sollten vermieden werden.
avoid.finalizer.method=Die Verwendung von finalizer Methoden sollte vermieden werden.
covariant.equals=Kovariante Definition von equals() ohne equals(java.lang.Object) zu überschreiben.
declaration.order.constructor=Konstruktordefinition in falscher Reihenfolge.
declaration.order.method=Methodendefinition in falscher Reihenfolge.
declaration.order.static=Statische Variablendefinition in falscher Reihenfolge.
declaration.order.instance=Instanzvariablendefinition in falscher Reihenfolge.
declaration.order.access=Fehlerhafte Deklarationsreihenfolge für diesen Scope.
default.comes.last=Default sollte das letzte Label im switch sein.
empty.statement=Leere Anweisung.
equals.noHashCode=Definition von ''equals()'' ohne korrespondierende Definition von ''hashCode()''.
explicit.init=Variable ''{0}'' wird explizit mit ''{1}'' initialisiert (Defaultwert für ihren Typ).
fall.through=Fall through vom vorherigen Zweig der switch Anweisung.
fall.through.last=Fall through von letzten Zweig der switch Anweisung.
final.variable=Variable ''{0}'' sollte als final deklariert werden.
hidden.field=''{0}'' verbirgt ein Feld.
illegal.catch=Catch von ''{0}'' ist nicht erlaubt.
illegal.throw=Werfen von ''{0}'' ist nicht erlaubt.
illegal.token=Benutzung von ''{0}'' ist nicht erlaubt.
illegal.token.text=Tokentext entspricht dem Muster ''{0}''.
illegal.type=Deklaration von Variablen, Rückgabewerten oder Parametern des Typs ''{0}'' is nicht erlaubt.
inline.conditional.avoid=Der Bedingungsoperator sollte vermieden werden.
instantiation.avoid=Instantiierung von {0} sollte vermieden werden.
junit.method.name=Die Methode ''{0}'' sollte zu ''{1}'' umbenannt werden.
junit.method.return.type=Die Methode ''{0}'' muss den Rückgabetyp {1} haben.
junit.method.parameters=Die Methode ''{0}'' muss parameterlos sein.
junit.method.public.and.static=Die Methode ''{0}'' muss als static deklariert sein.
junit.method.protected.or.public=Die Methode ''{0}'' muss public oder protected sein.
junit.method.static=Die Methode ''{0}'' sollte nicht static sein.
magic.number=''{0}'' sollte durch eine Konstante definiert sein.
missing.ctor=Die Klasse sollte einen Konstruktor definieren.
missing.package.declaration=Fehlende Package-Deklaration.
missing.super.call=Die Methode ''{0}'' sollte ''super.{0}'' aufrufen.
missing.switch.default=switch ohne \"default\".
modified.control.variable=Die Kontrollvariable ''{0}'' wird modifiziert.
multiple.string.literal=Der String {0} wird in dieser Datei {1} mal benutzt.
multiple.variable.declarations=Nur eine Variablendefinition pro Zeile ist erlaubt.
multiple.variable.declarations.comma=Jede Variablendeklaration muss in einer eigenen Anweisung erfolgen.
nested.if.depth=Verschachtelungstiefe von if-else ist {0,number,integer} (Obergrenze ist {1,number,integer}).
nested.try.depth=Verschachtelungstiefe von try Blöcken ist {0,number,integer} (Obergrenze ist {1,number,integer}).
parameter.assignment=Zuweisung an den Parameter ''{0}'' is nicht erlaubt.
redundant.throws.classInfo=Klassen-Information für {0} nicht verfügbar.
redundant.throws.duplicate=Überflüssige throws-Deklaration: ''{0}'' ist mehrfach aufgeführt.
redundant.throws.subclass=Überflüssige throws-Deklaration: ''{0}'' ist Unterklasse von ''{1}''.
redundant.throws.unchecked=Überflüssige throws-Deklaration: ''{0}'' ist eine unchecked Exception (abgeleitet von RuntimeException).
require.this.method=Methodenaufruf ''{0}'' muss über \"this.\" erfolgen.
require.this.unfound.variable=Checkstyle kann Deklaration von ''{0}'' nicht finden.
require.this.variable=Dereferenzierung der Instanzvariable ''{0}'' muss über \"this.\" erfolgen.
return.count={0,number,integer} return-Anweisungen (Obergrenze ist {1,number,integer}).
simplify.boolreturn=Die Verzweigung sollte entfernt werden.
simplify.expression=Der Ausdruck kann vereinfacht werden.
string.literal.equality=String-Literale sollten mit equals() verglichen werden, nicht mit ''{0}''.
unnecessary.paren.assign=Überflüssige Klammern um die rechte Seite der Zuweisung.
unnecessary.paren.expr=Überflüssige Klammern um Ausdruck.
unnecessary.paren.ident=Überflüssige Klammern um den Bezeichner ''{0}''.
unnecessary.paren.literal=Überflüssige Klammern um das Literal ''{0}''.
unnecessary.paren.return=Überflüssige Klammern um den return-Wert.
unnecessary.paren.string=Überflüssige Klammern um den String {0}.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/messages_es.properties 100644 0 0 10370 11743005374 31224 0 ustar 0 0 array.trailing.comma=El array debería llevar una coma al final.
assignment.inner.avoid=Deben evitarse las asignaciones internas.
covariant.equals=equals covariante sin sobrescribir equals(java.lang.Object).
empty.statement=Sentencia vacía.
equals.noHashCode=Definición de ''equals()'' sin la correspondiente definición de ''hashCode()''.
final.variable=La variable ''{0}'' debe declararse final.
hidden.field=''{0}'' oculta un campo.
illegal.token=El uso de ''{0}'' no esta permitido.
illegal.token.text=El texto del token coincide con el patrón ilegal ''{0}''.
instantiation.avoid=Debería evitarse la instanciación de {0}.
inline.conditional.avoid=Evitar los condicionales en línea.
magic.number=''{0}'' es un número mágico.
missing.super.call=El método ''{0}'' debería llamar a ''super.{0}''.
missing.switch.default=switch sin etiqueta \"default\".
multiple.string.literal=La cadena {0} aparece {1} veces en el fichero.
redundant.throws.classInfo=No se puede obtener la información de clase de {0}.
redundant.throws.duplicate=Sentencia throws redundante: ''{0}'' aparece más de una vez.
redundant.throws.subclass=Sentencia throws redundante: ''{0}'' es una subclase de ''{1}''.
redundant.throws.unchecked=Sentencia throws redundante: ''{0}'' es una excepción no comprobada.
simplify.boolreturn=Se puede eliminar la lógica condicional.
simplify.expression=Se puede simplificar la expresión.
nested.if.depth=La profundidad de if-else anidados es {0,number,integer} (máximo permitido es {1,number,integer}).
nested.try.depth=La profundidad de try anidados es {0,number,integer} (máximo permitido es {1,number,integer}).
string.literal.equality=Las cadenas literales deben compararse usando equals(), no ''{0}''.
illegal.catch=Capturar la excepción ''{0}'' no está permitido.
missing.package.declaration=Falta la declaración de paquete.
junit.method.name=El método ''{0}'' debería llamarse ''{1}''.
junit.method.return.type=El método ''{0}'' debe declararse con tipo de retorno {1}.
junit.method.parameters=El método ''{0}'' debe declararse sin parámetros.
junit.method.public.and.static=El método ''{0}'' debe declararse static.
junit.method.protected.or.public=El método ''{0}'' debe ser public o protected.
junit.method.static=El método ''{0}'' no debería ser static.
return.count=El número de sentencias return es {0,number,integer} (máximo permitido es {1,number,integer}).
illegal.type=La declaración de variables, valores de retorno o parámetros de tipo ''{0}'' no está permitida.
declaration.order.constructor=Definición de constructor en orden incorrecto.
declaration.order.method=Definición de método en orden incorrecto.
declaration.order.static=Definición de variable static en orden incorrecto.
declaration.order.instance=Definición de variable de instancia en orden incorrecto.
declaration.order.access=Definición de acceso a variable en orden incorrecto.
parameter.assignment=No esta permitida la asignación del parámetro ''{0}''.
modified.control.variable=Se modifica la variable de control ''{0}''.
explicit.init=La variable ''{0}'' se inicializa explicitamente a ''{1}'' (valor por defecto para su tipo).
default.comes.last=La etiqueta default debe ser la última etiqueta en el switch.
missing.ctor=La clase debería definir un constructor.
fall.through=Caída desde la etiqueta anterior en la sentencia switch.
require.this.variable=La referencia a la variable de instancia ''{0}'' necesita \"this.\".
require.this.unfound.variable=No se puede encontrar la declaración de ''{0}''.
require.this.method=La llamada al método ''{0}'' necesita \"this.\".
multiple.variable.declarations=Sólo se permite una definición de variable por línea.
multiple.variable.declarations.comma=Cada declaración de variable debe estar en su línea.
unnecessary.paren.assign=Paréntesis innecesarios alrededor de la parte derecha de una asignación.
unnecessary.paren.expr=Paréntesis innecesarios alrededor de la expresión.
unnecessary.paren.ident=Paréntesis innecesarios alrededor del identificador ''{0}''.
unnecessary.paren.literal=Paréntesis innecesarios alrededor del literal ''{0}''.
unnecessary.paren.return=Paréntesis innecesarios alrededor del valor de retorno.
unnecessary.paren.string=Paréntesis innecesarios alrededor de la cadena {0}.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/messages_fi.properties 100644 0 0 2251 11451071613 31165 0 ustar 0 0 assignment.inner.avoid=l¤ k¤yt¤ sis¤kk¤isi¤ sijoituksia.
equals.noHashCode=''equals()'' m¤¤ritelty ilman vastaavaa ''hashCode()''-m¤¤rittely¤.
final.variable=Muuttujan ''{0}'' pit¤isi olla final.
hidden.field=''{0}'' piilottaa muuttujan.
illegal.token=''{0}'':n k¤yttĥ ei ole sallittu.
instantiation.avoid=l¤ instantioi {0}:a.
missing.super.call=Metodin ''{0}'' pit¤isi kutsua ''super.{0}'':aa.
redundant.throws.duplicate=Ylim¤¤r¤inen throws: ''{0}'' mainittu useamman kuin yhden kerran.
redundant.throws.subclass=Ylim¤¤r¤inen throws: ''{0}'' on ''{1}'':n aliluokka.
redundant.throws.unchecked=Ylim¤¤r¤inen throws: ''{0}'' on tarkistamaton poikkeus.
simplify.boolreturn=Konditionaalilogiikan voisi poistaa.
simplify.expression=Ilmaisua voisi yksinkertaistaa.
nested.if.depth=Sis¤kk¤isten if-else -lausekkeiden syvyys on {0,number,integer} (suurin sallittu on {1,number,integer}).
nested.if.depth=Sis¤kk¤isten try -lausekkeiden syvyys on {0,number,integer} (suurin sallittu on {1,number,integer}).
junit.method.name=Metodin ''{0}'' nimi pit¤isi olla ''{1}''.
junit.method.static=Metodin ''{0}'' ei pit¤isi olla staattinen.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/messages_fr.properties 100644 0 0 11455 11743005374 31231 0 ustar 0 0 array.trailing.comma=La dernière valeur d''un tableau devrait être suivie d''une virgule.
assignment.inner.avoid=Evitez d''affecter une valeur à une variable au sein d''une expression.
covariant.equals=Votre méthode equals compare uniquement les objets de votre classe. N''oubliez pas de surcharger la méthode equals(java.lang.Object).
empty.statement=Instruction vide.
equals.noHashCode=La définition de la méthode ''equals()'' doit toujours être accompagnée de la définition de la méthode ''hashCode()''.
final.variable=La variable ''{0}'' devrait être finale.
hidden.field=''{0}'' masque un attribut.
illegal.token=Il est interdit d''utiliser ''{0}''.
illegal.token.text=Chaîne de caractères interdite ''{0}''.
instantiation.avoid=L''instantiation de la classe {0} est prohibée.
inline.conditional.avoid=L'utilisation de l'opérateur conditionel est prohibée.
magic.number=''{0}'' devrait être défini comme une constante.
missing.super.call=La méthode ''{0}'' devrait appeler ''super.{0}''.
missing.switch.default=Il manque le cas \"default\" dans le bloc \"switch\".
multiple.string.literal=La chaîne {0} apparait {1} fois dans le fichier.
redundant.throws.classInfo=Impossible d''obtenir les informations relatives à {0}.
redundant.throws.duplicate=Clause throws redondante : ''{0}'' est présent plus d''une fois.
redundant.throws.subclass=Clause throws redondante : ''{0}'' est une sous-classe de ''{1}''.
redundant.throws.unchecked=Clause throws redondante : ''{0}'' est une exception non vérifiée.
simplify.boolreturn=Le test peut être supprimé et l''expression directement retournée.
simplify.expression=L''expression peut être simplifiée.
nested.if.depth=Le nombre de ''if'' imbriqué est de {0,number,integer}, alors que le maximum autorisé est de {1,number,integer}.
nested.try.depth=Le nombre de ''try'' imbriqué est de {0,number,integer}, alors que le maximum autorisé est de {1,number,integer}.
string.literal.equality=Les chaines de caractères littérales devraient être comparées avec la méthode equals() et pas avec ''{0}''.
illegal.catch=Catcher l''exception ''{0}'' est prohibé.
missing.package.declaration=Déclaration de package manquante.
junit.method.name=La méthode ''{0}'' devrait être renommée ''{1}''.
junit.method.return.type=La méthode ''{0}'' devrait être déclarée avec un type de retour {1}.
junit.method.parameters=La méthode ''{0}'' devrait être déclarée sans paramètres.
junit.method.public.and.static=La méthode ''{0}'' devrait être déclarée statique.
junit.method.protected.or.public=La méthode ''{0}'' devrait être protégée ou publique.
junit.method.static=La méthode ''{0}'' ne devrait pas être statique.
return.count=Le nombre de return est de {0,number,integer} alors que le maximum autorisé est de {1,number,integer}.
illegal.type=Déclarer des variables, des valeurs de retour ou des paramètres de type ''{0}'' est interdit.
declaration.order.constructor=La définition des constructeurs n''apparait pas dans le bon ordre.
declaration.order.method=La définition des méthodes n''apparait pas dans le bon ordre.
declaration.order.static=La définition des variables statiques n''apparait pas dans le bon ordre.
declaration.order.instance=La définition des variables d''instance n''apparait pas dans le bon ordre.
declaration.order.access=La définition des variables n''est pas triée suivant leur portée.
parameter.assignment=Il est interdit d''affecter une valeur au paramètre ''{0}''.
modified.control.variable=La variable de controle ''{0}'' est modifiée.
explicit.init=L''initialisation explicite de la variable ''{0}'' à la valeur ''{1}'' est inutile, c''est la valeur par défaut pour ce type.
default.comes.last=Le cas \"default\" devrait apparaitre en dernier dans le bloc \"switch\".
missing.ctor=Il manque un constructeur à la classe.
fall.through=Le cas précédent du \"switch\" ne contient pas de break, return, throw ou continue.
require.this.variable=La référence à la variable d''instance ''{0}'' doit utiliser \"this.\".
require.this.unfound.variable=Impossible de trouver où ''{0}'' est déclaré.
require.this.method=L''appel à la méthode ''{0}'' nécessite l''utilisation de \"this.\".
multiple.variable.declarations=Ne déclarez pas plus d''une variable par ligne.
multiple.variable.declarations.comma=Chaque déclaration de variable doit faire l''objet d''une instruction à part.
unnecessary.paren.assign=Parenthèses inutiles autour la partie droite de l''affectation.
unnecessary.paren.expr=Parenthèses inutiles autour de l''expression.
unnecessary.paren.ident=Parenthèses inutiles autour de l''identifiant ''{0}''.
unnecessary.paren.literal=Parenthèses inutiles autour de la chaîne littérale ''{0}''.
unnecessary.paren.return=Parenthèses inutiles autour de la valeur de retour.
unnecessary.paren.string=Parenthèses inutiles autour de la chaîne {0}.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/messages_ja.properties 100644 0 0 12766 11743005373 31221 0 ustar 0 0 array.trailing.comma=\u914d\u5217\u3067\u306f\u30ab\u30f3\u30de\u304c\u884c\u672b\u306b\u6765\u308b\u3088\u3046\u306b\u3059\u3079\u304d\u3067\u3059\u3002
assignment.inner.avoid=\u5f0f\u5185\u90e8\u3067\u306e\u4ee3\u5165\u306f\u907f\u3051\u308b\u3079\u304d\u3067\u3059\u3002
covariant.equals=equals(java.lang.Object) \u3092\u30aa\u30fc\u30d0\u30fc\u30e9\u30a4\u30c9\u305b\u305a\u306b covariant \u306a equals \u3092\u5b9a\u7fa9\u3057\u3066\u3044\u307e\u3059\u3002
empty.statement=\u7a7a\u306e\u6587\u3067\u3059\u3002
equals.noHashCode=''equals()'' \u3092\u5b9a\u7fa9\u3057\u3066\u3044\u307e\u3059\u304c\u3001\u3053\u308c\u306b\u5bfe\u5fdc\u3059\u308b ''hashCode()'' \u306e\u5b9a\u7fa9\u304c\u3042\u308a\u307e\u305b\u3093\u3002
final.variable=\u5909\u6570 ''{0}'' \u306f final \u3068\u3057\u3066\u5ba3\u8a00\u3059\u3079\u304d\u3067\u3059\u3002
hidden.field=''{0}'' \u304c\u30d5\u30a3\u30fc\u30eb\u30c9\u3092\u96a0\u3057\u3066\u3044\u307e\u3059\u3002
illegal.token=''{0}'' \u306e\u4f7f\u7528\u306f\u8a31\u53ef\u3055\u308c\u3066\u3044\u307e\u305b\u3093\u3002
illegal.token.text=\u30c8\u30fc\u30af\u30f3\u306e\u30c6\u30ad\u30b9\u30c8\u304c\u4e0d\u6b63\u306a\u30d1\u30bf\u30fc\u30f3 ''{0}'' \u306b\u4e00\u81f4\u3057\u3066\u3044\u307e\u3059\u3002
instantiation.avoid={0} \u306e\u30a4\u30f3\u30b9\u30bf\u30f3\u30b9\u5316\u306f\u907f\u3051\u308b\u3079\u304d\u3067\u3059\u3002
magic.number=''{0}'' \u306f\u30de\u30b8\u30c3\u30af\u30ca\u30f3\u30d0\u30fc\u3067\u3059\u3002
missing.super.call=\u30e1\u30bd\u30c3\u30c9 ''{0}'' \u306f ''super.{0}'' \u3092\u547c\u3076\u3079\u304d\u3067\u3059\u3002
missing.switch.default=\"default\" \u7bc0\u306e\u7121\u3044 switch \u6587\u3067\u3059\u3002
redundant.throws.classInfo={0} \u306e\u30af\u30e9\u30b9\u60c5\u5831\u304c\u53d6\u5f97\u3067\u304d\u307e\u305b\u3093\u3002
redundant.throws.duplicate=\u5197\u9577\u306a throws: ''{0}'' \u304c\u91cd\u8907\u3057\u3066\u3044\u307e\u3059\u3002
redundant.throws.subclass=\u5197\u9577\u306a throws: ''{0}'' \u306f ''{1}'' \u306e\u30b5\u30d6\u30af\u30e9\u30b9\u3067\u3059\u3002
redundant.throws.unchecked=\u5197\u9577\u306a throws: ''{0}'' \u306f\u30c1\u30a7\u30c3\u30af\u3055\u308c\u306a\u3044\u4f8b\u5916\u3067\u3059\u3002
simplify.boolreturn=\u6761\u4ef6\u30ed\u30b8\u30c3\u30af\u306f\u306a\u304f\u305b\u307e\u3059\u3002
simplify.expression=\u8868\u73fe\u306f\u7c21\u6f54\u306b\u3067\u304d\u307e\u3059\u3002
nested.if.depth=\u30cd\u30b9\u30c8\u3057\u305f if-else \u306e\u6df1\u3055\u304c {0,number,integer} \uff08\u6700\u5927 {1,number,integer} \u307e\u3067\uff09\u3067\u3059\u3002
nested.try.depth=\u30cd\u30b9\u30c8\u3057\u305f try \u306e\u6df1\u3055\u304c {0,number,integer} \uff08\u6700\u5927 {1,number,integer} \u307e\u3067\uff09\u3067\u3059\u3002
string.literal.equality=\u30ea\u30c6\u30e9\u30eb\u306e\u6587\u5b57\u5217\u306f ''{0}'' \u3067\u306f\u306a\u304f\u3001 equals() \u3092\u4f7f\u7528\u3057\u3066\u6bd4\u8f03\u3059\u308b\u3079\u304d\u3067\u3059\u3002
illegal.catch=''{0}'' \u3092\u30ad\u30e3\u30c3\u30c1\u3059\u308b\u3053\u3068\u306f\u8a31\u53ef\u3055\u308c\u3066\u3044\u307e\u305b\u3093\u3002
missing.package.declaration=package \u5ba3\u8a00\u304c\u898b\u3064\u304b\u308a\u307e\u305b\u3093\u3002
junit.method.name=\u30e1\u30bd\u30c3\u30c9 ''{0}'' \u306f ''{1}'' \u3068\u547d\u540d\u3059\u3079\u304d\u3067\u3059\u3002
junit.method.return.type=\u30e1\u30bd\u30c3\u30c9 ''{0}'' \u306f\u623b\u308a\u5024\u306e\u578b\u3092 {1} \u3068\u3057\u3066\u5ba3\u8a00\u3059\u3079\u304d\u3067\u3059\u3002
junit.method.parameters=\u30e1\u30bd\u30c3\u30c9 ''{0}'' \u306f\u30d1\u30e9\u30e1\u30fc\u30bf\u306a\u3057\u3067\u5ba3\u8a00\u3059\u3079\u304d\u3067\u3059\u3002
junit.method.public.and.static=\u30e1\u30bd\u30c3\u30c9 ''{0}'' \u306f static \u3068\u3057\u3066\u5ba3\u8a00\u3059\u3079\u304d\u3067\u3059\u3002
junit.method.protected.or.public=\u30e1\u30bd\u30c3\u30c9 ''{0}'' \u306f public \u304b protected \u3067\u306a\u3051\u308c\u3070\u306a\u308a\u307e\u305b\u3093\u3002
junit.method.static=\u30e1\u30bd\u30c3\u30c9 ''{0}'' \u306f static \u3067\u3042\u308b\u3079\u304d\u3067\u306f\u3042\u308a\u307e\u305b\u3093\u3002
return.count=return \u304c {0,number,integer} \u500b\u6240\u3042\u308a\u307e\u3059\uff08\u6700\u5927 {1,number,integer} \u307e\u3067\uff09\u3002
illegal.type=''{0}'' \u578b\u306e\u5909\u6570\u3001\u623b\u308a\u5024\u3001\u30d1\u30e9\u30e1\u30fc\u30bf\u3092\u5ba3\u8a00\u3059\u308b\u3053\u3068\u306f\u8a31\u53ef\u3055\u308c\u3066\u3044\u307e\u305b\u3093\u3002
declaration.order.constructor=\u30b3\u30f3\u30b9\u30c8\u30e9\u30af\u30bf\u306e\u5b9a\u7fa9\u9806\u5e8f\u304c\u9593\u9055\u3063\u3066\u3044\u307e\u3059\u3002
declaration.order.method=\u30e1\u30bd\u30c3\u30c9\u306e\u5b9a\u7fa9\u9806\u5e8f\u304c\u9593\u9055\u3063\u3066\u3044\u307e\u3059\u3002
declaration.order.static=static \u5909\u6570\u306e\u5b9a\u7fa9\u9806\u5e8f\u304c\u9593\u9055\u3063\u3066\u3044\u307e\u3059\u3002
declaration.order.instance=\u30a4\u30f3\u30b9\u30bf\u30f3\u30b9\u5909\u6570\u306e\u5b9a\u7fa9\u9806\u5e8f\u304c\u9593\u9055\u3063\u3066\u3044\u307e\u3059\u3002
declaration.order.access=\u5909\u6570\u30a2\u30af\u30bb\u30b9\u306e\u5b9a\u7fa9\u9806\u5e8f\u304c\u9593\u9055\u3063\u3066\u3044\u307e\u3059\u3002
parameter.assignment=\u30d1\u30e9\u30e1\u30fc\u30bf ''{0}'' \u3078\u306e\u4ee3\u5165\u306f\u8a31\u53ef\u3055\u308c\u3066\u3044\u307e\u305b\u3093\u3002
explicit.init=\u5909\u6570 ''{0}'' \u304c\u660e\u793a\u7684\u306b ''{1}'' \uff08\u3053\u306e\u578b\u306e\u30c7\u30d5\u30a9\u30eb\u30c8\u5024\uff09\u306b\u521d\u671f\u5316\u3055\u308c\u3066\u3044\u307e\u3059\u3002
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/messages_pt.properties 100644 0 0 5427 11743005373 31226 0 ustar 0 0 array.trailing.comma=O vector deve ter uma virgula final.
assignment.inner.avoid=As atribuiçġes internas devem ser evitadas.
covariant.equals=\"equals\" covariante sem implementar equals(java.lang.Object).
declaration.order.access=Definiço de acesso a variável em ordem errada.
declaration.order.constructor=Definiço de construtor em ordem errada.
declaration.order.instance=Definiço de variável de instância em ordem errada.
declaration.order.method=Definiço de método em ordem errada.
declaration.order.static=Definiço de variável estática em ordem errada.
empty.statement=Declaraço vazia.
equals.noHashCode=Definiço de ''equals()'' sem a definiço de ''hashCode()''.
explicit.init=Variável ''{0}'' inicializada explicitamente para ''{1}'' (valor por omisso para o seu tipo).
final.variable=Variável ''{0}'' deve ser declarada final.
hidden.field=''{0}'' esconde um campo.
illegal.catch=O tratamento de ''{0}'' no é permitido.
illegal.token.text=Texto do elemento coincide com o padro ilegal ''{0}''.
illegal.token=No é permitida a utilizaço de ''{0}''.
illegal.type=A declaraço de variáveis, valores de retorno ou parâmetros do tipo ''{0}'' no é permitida.
instantiation.avoid=A instanciaço de {0} deve ser evitada.
junit.method.name=O método ''{0}'' deveria ser chamado ''{1}''.
junit.method.parameters=O método ''{0}'' deve ser declarado sem parâmetros.
junit.method.protected.or.public=O método ''{0}'' deve ser público ou protegido.
junit.method.public.and.static=O método ''{0}'' deve ser declarado estático.
junit.method.return.type=O método ''{0}'' deve ser declarado com o tipo de retorno {1}.
junit.method.static=O método ''{0}'' no deve ser estático.
magic.number=''{0}'' é um número mágico.
missing.package.declaration=Falta a declaraço do pacote.
missing.super.call=Method ''{0}'' deve chamar ''super.{0}''.
missing.switch.default=switch sem o ramo \"default\".
nested.if.depth=Profundidade de \"if-else\" é {0,number,integer} (máximo permitido é {1,number,integer}).
nested.try.depth=Profundidade de \"try\" é {0,number,integer} (máximo permitido é {1,number,integer}).
parameter.assignment=A atribuiço ao parâmetro ''{0}'' no é permitda.
redundant.throws.classInfo=No foi possível obter os dados da classe {0}.
redundant.throws.duplicate=throws redundante: ''{0}'' listado mais do que uma vez.
redundant.throws.subclass=throws redundante: ''{0}'' é uma sub-classe de ''{1}''.
redundant.throws.unchecked=throws redundante: ''{0}'' é um excepço no-verificada.
return.count=O número de \"return\"s é {0,number,integer} (máximo permitido é {1,number,integer}).
simplify.boolreturn=A lógica condicional pode ser removida.
simplify.expression=Expresso pode ser simplicada.
string.literal.equality=\"Strings\" literais devem ser comparadas com equals(), no ''{0}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/messages_tr.properties 100644 0 0 16406 11744664214 31255 0 ustar 0 0 #Generated by ResourceBundle Editor (http://eclipse-rbe.sourceforge.net)
array.trailing.comma = Dizi, takip eden bir virg\u00FCl i\u00E7ermelidir.
assignment.inner.avoid = Dahili atamalar kullan\u0131lmamal\u0131d\u0131r.
avoid.clone.method = ''clone'' metodu kullan\u0131lmamal\u0131d\u0131r.
avoid.finalizer.method = ''finalize'' metodu kullan\u0131lmamal\u0131d\u0131r.
covariant.equals = java.lang.Object s\u0131n\u0131f\u0131n\u0131n ''equals'' metodundan ba\u015Fka bir ''equals'' metodu tan\u0131mlanm\u0131\u015F, java.lang.Object s\u0131n\u0131f\u0131ndan gelen ''equals'' metodu da ezilmelidir (override).
declaration.order.access = De\u011Fi\u015Fken, eri\u015Fim seviyesine g\u00F6re yanl\u0131\u015F s\u0131rada tan\u0131mlanm\u0131\u015F.
declaration.order.constructor = ''constructor'' tan\u0131m\u0131 yanl\u0131\u015F s\u0131rada yap\u0131lm\u0131\u015F.
declaration.order.instance = De\u011Fi\u015Fken tan\u0131m\u0131 yanl\u0131\u015F s\u0131rada yap\u0131lm\u0131\u015F.
declaration.order.method = Metot tan\u0131m\u0131 yanl\u0131\u015F s\u0131rada yap\u0131lm\u0131\u015F.
declaration.order.static = ''static'' de\u011Fi\u015Fken tan\u0131m\u0131 yanl\u0131\u015F s\u0131rada yap\u0131lm\u0131\u015F.
default.comes.last = ''switch'' i\u00E7erisindeki ''default'' ifadesi son durum olarak yer almal\u0131d\u0131r.
doublechecked.locking.avoid = Double-Checked Locking (DCL - lock mekanizmas\u0131nda ikili kontrol) yap\u0131lmam\u0131\u015F.
empty.statement = Bo\u015F ifade.
equals.avoid.null = ''equals'' metodunda kullan\u0131lan harflerden olu\u015Fan ifadeler ''equals'' metodunun sol taraf\u0131nda yer almal\u0131d\u0131r.
equals.noHashCode = ''equals'' metodu tan\u0131mlayan s\u0131n\u0131flar ''hashCode'' metodunu da tan\u0131mlamal\u0131d\u0131r.
equalsIgnoreCase.avoid.null = ''equalsIgnoreCase'' metodunda kullan\u0131lan harflerden olu\u015Fan ifadeler ''equalsIgnoreCase'' metodunun sol taraf\u0131nda yer almal\u0131d\u0131r.
explicit.init = ''{0}'' de\u011Fi\u015Fkeni (verilmese bile zaten ilklendirme de\u011Feri olan) ''{1}'' de\u011Feriyle ilklendirilmi\u015F.
fall.through = ''switch'' ifadesinin bir \u00F6nceki durumundan a\u015Fa\u011F\u0131 d\u00FC\u015Fme mevcut (''break'' kullan\u0131lmam\u0131\u015F olabilir).
fall.through.last = ''switch'' ifadesinin son durumundan a\u015Fa\u011F\u0131 d\u00FC\u015Fme mevcut (''break'' kullan\u0131lmam\u0131\u015F olabilir).
final.variable = ''{0}'' de\u011Fi\u015Fkeni ''final'' olarak tan\u0131mlanmal\u0131d\u0131r.
hidden.field = ''{0}'', ba\u015Fka bir alan\u0131 gizliyor.
illegal.catch = ''{0}'' istisnas\u0131n\u0131/hatas\u0131n\u0131 yakalamaya izin verilmiyor.
illegal.throw = ''{0}'' istisnas\u0131n\u0131/hatas\u0131n\u0131 f\u0131rlatmaya izin verilmiyor.
illegal.token = ''{0}'' kullan\u0131m\u0131na izin verilmiyor.
illegal.token.text = \u0130zin verilmeyen bir kal\u0131p kullan\u0131lm\u0131\u015F ''{0}''.
illegal.type = ''{0}'' tipinde de\u011Fi\u015Fken, d\u00F6n\u00FC\u015F de\u011Feri ya da parametre tan\u0131mlanmamal\u0131d\u0131r.
inline.conditional.avoid = Sat\u0131r i\u00E7i ko\u015Fullu ifadeler kullan\u0131lmamal\u0131d\u0131r.
instantiation.avoid = {0} s\u0131n\u0131f\u0131n\u0131n yeni nesnesi \u00FCretilmemelidir.
junit.method.name = ''{0}'' metodu ''{1}'' olarak adland\u0131r\u0131lmal\u0131d\u0131r.
junit.method.parameters = ''{0}'' metodu parametresiz olarak tan\u0131mlanmal\u0131.
junit.method.protected.or.public = ''{0}'' metodu ''public'' ya da ''protected'' olmal\u0131.
junit.method.public.and.static = ''{0}'' metodu ''static'' olarak tan\u0131mlanmal\u0131.
junit.method.return.type = ''{0}'' metodunun d\u00F6n\u00FC\u015F tipi ''{1}'' olmal\u0131.
junit.method.static = ''{0}'' metodu ''static'' olarak tan\u0131mlanmamal\u0131.
magic.number = ''{0}'' say\u0131s\u0131 ''magic number''d\u0131r. \u00D6nce tan\u0131mlanmal\u0131, sonra kullan\u0131lmal\u0131.
missing.ctor = S\u0131n\u0131f, bir ''constructor'' tan\u0131mlamal\u0131.
missing.package.declaration = Paket tan\u0131m\u0131 yap\u0131lmam\u0131\u015F.
missing.super.call = ''{0}'' metodu ''super.{0}'' metodunu \u00E7a\u011F\u0131rmal\u0131.
missing.switch.default = ''default'' olmadan ''switch'' kullan\u0131lm\u0131\u015F.
modified.control.variable = Kontrol de\u011Fi\u015Fkeninin de\u011Feri de\u011Fi\u015Ftirilmi\u015F.
multiple.statements.line = Her sat\u0131rda sadece bir ifade olmal\u0131d\u0131r.
multiple.string.literal = ''{0}'' de\u011Feri dosyada {1} defa kullan\u0131lm\u0131\u015F.
multiple.variable.declarations = Her sat\u0131rda sadece bir de\u011Fi\u015Fken tan\u0131mlanmal\u0131.
multiple.variable.declarations.comma = Her de\u011Fi\u015Fken tan\u0131m\u0131 kendi ifadesinde yer almal\u0131.
nested.for.depth = \u0130\u00E7 i\u00E7e kullan\u0131lan ''for'' say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
nested.if.depth = \u0130\u00E7 i\u00E7e kullan\u0131lan ''if-else'' say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
nested.try.depth = \u0130\u00E7 i\u00E7e kullan\u0131lan ''try'' say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
package.dir.mismatch = Paket tan\u0131m\u0131 ''{0}'' klas\u00F6r\u00FCyle e\u015Fle\u015Fmiyor.
parameter.assignment = ''{0}'' parametresine atama yap\u0131lamaz.
redundant.throws.classInfo = {0} i\u00E7in s\u0131n\u0131f bilgisi al\u0131nam\u0131yor.
redundant.throws.duplicate = ''throws'' ifadesinde ''{0}'' tekrardan kullan\u0131lm\u0131\u015F.
redundant.throws.subclass = ''{0}'', ''{1}'' s\u0131n\u0131f\u0131n\u0131n alt s\u0131n\u0131f\u0131d\u0131r, ''throws'' kullan\u0131m\u0131 gereksizdir.
redundant.throws.unchecked = ''{0}'' ''unchecked'' bir istisnad\u0131r, ''throws'' kullan\u0131m\u0131 gereksizdir.
require.this.method = ''{0}'' metoduna eri\u015Fim "this." kullan\u0131larak yap\u0131lmal\u0131d\u0131r.
require.this.unfound.variable = ''{0}'' ifadesinin nerede tan\u0131mland\u0131\u011F\u0131 bilinmiyor.
require.this.variable = ''{0}'' de\u011Fi\u015Fkenine eri\u015Fim "this." kullan\u0131larak yap\u0131lmal\u0131d\u0131r.
return.count = Kullan\u0131lan ''return'' say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
simplify.boolreturn = Ko\u015Ful mant\u0131\u011F\u0131 kald\u0131r\u0131labilir.
simplify.expression = \u0130fade sadele\u015Ftirilebilir.
string.literal.equality = ''String'' ifadeleri ''{0}'' kullanarak de\u011Fil, equals() metodu kullanarak kar\u015F\u0131la\u015Ft\u0131r\u0131lmal\u0131.
unnecessary.paren.assign = Atama ifadesinin sa\u011F taraf\u0131nda gereksiz parantez mevcut.
unnecessary.paren.expr = \u0130fadenin etraf\u0131nda gereksiz parantez mevcut.
unnecessary.paren.ident = ''{0}'' belirte\u00E7inin etraf\u0131nda gereksiz parantez mevcut.
unnecessary.paren.literal = ''{0}'' etraf\u0131nda gereksiz parantez mevcut.
unnecessary.paren.return = Geri d\u00F6n\u00FC\u015F de\u011Feri etraf\u0131nda gereksiz parantez mevcut.
unnecessary.paren.string = ''{0}'' etraf\u0131nda gereksiz parantez mevcut.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/MissingCtorCheck.java 100644 0 0 4752 12026051047 30632 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck;
/**
*
* Checks that classes (except abstract one) define a ctor and don't rely
* on the default one.
*
*
* An example of how to configure the check is:
*
*
* <module name="MissingCtor"/>
*
*
* @author o_sukhodolsky
*/
public class MissingCtorCheck extends DescendantTokenCheck
{
/** Creates new instance of the check. */
public MissingCtorCheck()
{
setLimitedTokens(new String[] {
TokenTypes.getTokenName(TokenTypes.CTOR_DEF),
});
setMinimumNumber(1);
setMaximumDepth(2);
setMinimumMessage("missing.ctor");
}
@Override
public int[] getDefaultTokens()
{
return new int[]{TokenTypes.CLASS_DEF};
}
@Override
public int[] getAcceptableTokens()
{
return getDefaultTokens();
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST modifiers = aAST.findFirstToken(TokenTypes.MODIFIERS);
if ((modifiers != null)
&& modifiers.branchContains(TokenTypes.ABSTRACT))
{
// should apply the check to abtract class
return;
}
super.visitToken(aAST);
}
}
././@LongLink 100644 0 0 153 12026055133 10247 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/MissingSwitchDefaultCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/MissingSwitchDefaultChec100644 0 0 4710 12026051046 31367 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.DescendantTokenCheck;
/**
*
* Checks that switch statement has "default" clause.
*
*
* Rationale: It's usually a good idea to introduce a
* default case in every switch statement. Even if
* the developer is sure that all currently possible
* cases are covered, this should be expressed in the
* default branch, e.g. by using an assertion. This way
* the code is protected aginst later changes, e.g.
* introduction of new types in an enumeration type.
*
*
* An example of how to configure the check is:
*
*
* <module name="MissingSwitchDefault"/>
*
* @author o_sukhodolsky
*/
public class MissingSwitchDefaultCheck extends DescendantTokenCheck
{
/** Creates new instance of the check. */
public MissingSwitchDefaultCheck()
{
setLimitedTokens(new String[] {
TokenTypes.getTokenName(TokenTypes.LITERAL_DEFAULT),
});
setMinimumNumber(1);
setMaximumDepth(2);
setMinimumMessage("missing.switch.default");
}
@Override
public int[] getDefaultTokens()
{
return new int[]{TokenTypes.LITERAL_SWITCH};
}
@Override
public int[] getAcceptableTokens()
{
return getDefaultTokens();
}
}
././@LongLink 100644 0 0 156 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/ModifiedControlVariableCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/ModifiedControlVariableC100644 0 0 17622 12026051046 31364 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Check for ensuring that for loop control variables are not modified
* inside the for block.
*
* @author Daniel Grenner
*/
public final class ModifiedControlVariableCheck extends Check
{
/** Current set of parameters. */
private FastStack mCurrentVariables = FastStack.newInstance();
/** Stack of block parameters. */
private final FastStack> mVariableStack =
FastStack.newInstance();
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.OBJBLOCK,
TokenTypes.LITERAL_FOR,
TokenTypes.FOR_ITERATOR,
TokenTypes.FOR_EACH_CLAUSE,
TokenTypes.ASSIGN,
TokenTypes.PLUS_ASSIGN,
TokenTypes.MINUS_ASSIGN,
TokenTypes.STAR_ASSIGN,
TokenTypes.DIV_ASSIGN,
TokenTypes.MOD_ASSIGN,
TokenTypes.SR_ASSIGN,
TokenTypes.BSR_ASSIGN,
TokenTypes.SL_ASSIGN,
TokenTypes.BAND_ASSIGN,
TokenTypes.BXOR_ASSIGN,
TokenTypes.BOR_ASSIGN,
TokenTypes.INC,
TokenTypes.POST_INC,
TokenTypes.DEC,
TokenTypes.POST_DEC,
};
}
@Override
public int[] getRequiredTokens()
{
return getDefaultTokens();
}
@Override
public void beginTree(DetailAST aRootAST)
{
// clear data
mCurrentVariables.clear();
mVariableStack.clear();
}
@Override
public void visitToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.OBJBLOCK:
enterBlock();
break;
case TokenTypes.LITERAL_FOR:
case TokenTypes.FOR_ITERATOR:
case TokenTypes.FOR_EACH_CLAUSE:
break;
case TokenTypes.ASSIGN:
case TokenTypes.PLUS_ASSIGN:
case TokenTypes.MINUS_ASSIGN:
case TokenTypes.STAR_ASSIGN:
case TokenTypes.DIV_ASSIGN:
case TokenTypes.MOD_ASSIGN:
case TokenTypes.SR_ASSIGN:
case TokenTypes.BSR_ASSIGN:
case TokenTypes.SL_ASSIGN:
case TokenTypes.BAND_ASSIGN:
case TokenTypes.BXOR_ASSIGN:
case TokenTypes.BOR_ASSIGN:
case TokenTypes.INC:
case TokenTypes.POST_INC:
case TokenTypes.DEC:
case TokenTypes.POST_DEC:
checkIdent(aAST);
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
@Override
public void leaveToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.FOR_ITERATOR:
leaveForIter(aAST.getParent());
break;
case TokenTypes.FOR_EACH_CLAUSE:
leaveForEach(aAST);
break;
case TokenTypes.LITERAL_FOR:
leaveForDef(aAST);
break;
case TokenTypes.OBJBLOCK:
exitBlock();
break;
case TokenTypes.ASSIGN:
case TokenTypes.PLUS_ASSIGN:
case TokenTypes.MINUS_ASSIGN:
case TokenTypes.STAR_ASSIGN:
case TokenTypes.DIV_ASSIGN:
case TokenTypes.MOD_ASSIGN:
case TokenTypes.SR_ASSIGN:
case TokenTypes.BSR_ASSIGN:
case TokenTypes.SL_ASSIGN:
case TokenTypes.BAND_ASSIGN:
case TokenTypes.BXOR_ASSIGN:
case TokenTypes.BOR_ASSIGN:
case TokenTypes.INC:
case TokenTypes.POST_INC:
case TokenTypes.DEC:
case TokenTypes.POST_DEC:
// Do nothing
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
/**
* Enters an inner class, which requires a new variable set.
*/
private void enterBlock()
{
mVariableStack.push(mCurrentVariables);
mCurrentVariables = FastStack.newInstance();
}
/**
* Leave an inner class, so restore variable set.
*/
private void exitBlock()
{
mCurrentVariables = mVariableStack.pop();
}
/**
* Check if ident is parameter.
* @param aAST ident to check.
*/
private void checkIdent(DetailAST aAST)
{
if ((mCurrentVariables != null) && !mCurrentVariables.isEmpty()) {
final DetailAST identAST = aAST.getFirstChild();
if ((identAST != null)
&& (identAST.getType() == TokenTypes.IDENT)
&& mCurrentVariables.contains(identAST.getText()))
{
log(aAST.getLineNo(), aAST.getColumnNo(),
"modified.control.variable", identAST.getText());
}
}
}
/**
* Push current variables to the stack.
* @param aAST a for definition.
*/
private void leaveForIter(DetailAST aAST)
{
final DetailAST forInitAST = aAST.findFirstToken(TokenTypes.FOR_INIT);
DetailAST parameterDefAST =
forInitAST.findFirstToken(TokenTypes.VARIABLE_DEF);
for (; parameterDefAST != null;
parameterDefAST = parameterDefAST.getNextSibling())
{
if (parameterDefAST.getType() == TokenTypes.VARIABLE_DEF) {
final DetailAST param =
parameterDefAST.findFirstToken(TokenTypes.IDENT);
mCurrentVariables.push(param.getText());
}
}
}
/**
* Push current variables to the stack.
* @param aForEach a for-each clause
*/
private void leaveForEach(DetailAST aForEach)
{
final DetailAST paramDef =
aForEach.findFirstToken(TokenTypes.VARIABLE_DEF);
final DetailAST paramName = paramDef.findFirstToken(TokenTypes.IDENT);
mCurrentVariables.push(paramName.getText());
}
/**
* Pops the variables from the stack.
* @param aAST a for definition.
*/
private void leaveForDef(DetailAST aAST)
{
final DetailAST forInitAST = aAST.findFirstToken(TokenTypes.FOR_INIT);
if (forInitAST != null) {
DetailAST parameterDefAST =
forInitAST.findFirstToken(TokenTypes.VARIABLE_DEF);
for (; parameterDefAST != null;
parameterDefAST = parameterDefAST.getNextSibling())
{
if (parameterDefAST.getType() == TokenTypes.VARIABLE_DEF) {
mCurrentVariables.pop();
}
}
}
else {
// this is for-each loop, just pop veriables
mCurrentVariables.pop();
}
}
}
././@LongLink 100644 0 0 155 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/MultipleStringLiteralsCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/MultipleStringLiteralsCh100644 0 0 15563 12026051046 31471 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
import java.util.BitSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;
/**
* Checks for multiple occurrences of the same string literal within a
* single file.
*
* @author Daniel Grenner
*/
public class MultipleStringLiteralsCheck extends Check
{
/**
* The found strings and their positions.
* , with the ArrayList containing StringInfo objects.
*/
private final Map> mStringMap = Maps.newHashMap();
/**
* Marks the TokenTypes where duplicate strings should be ignored.
*/
private final BitSet mIgnoreOccurrenceContext = new BitSet();
/**
* The allowed number of string duplicates in a file before an error is
* generated.
*/
private int mAllowedDuplicates = 1;
/**
* Sets the maximum allowed duplicates of a string.
* @param aAllowedDuplicates The maximum number of duplicates.
*/
public void setAllowedDuplicates(int aAllowedDuplicates)
{
mAllowedDuplicates = aAllowedDuplicates;
}
/**
* Pattern for matching ignored strings.
*/
private Pattern mPattern;
/**
* Construct an instance with default values.
*/
public MultipleStringLiteralsCheck()
{
setIgnoreStringsRegexp("^\"\"$");
mIgnoreOccurrenceContext.set(TokenTypes.ANNOTATION);
}
/**
* Sets regexp pattern for ignored strings.
* @param aIgnoreStringsRegexp regexp pattern for ignored strings
*/
public void setIgnoreStringsRegexp(String aIgnoreStringsRegexp)
{
if ((aIgnoreStringsRegexp != null)
&& (aIgnoreStringsRegexp.length() > 0))
{
mPattern = Utils.getPattern(aIgnoreStringsRegexp);
}
else {
mPattern = null;
}
}
/**
* Adds a set of tokens the check is interested in.
* @param aStrRep the string representation of the tokens interested in
*/
public final void setIgnoreOccurrenceContext(String[] aStrRep)
{
mIgnoreOccurrenceContext.clear();
for (final String s : aStrRep) {
final int type = TokenTypes.getTokenId(s);
mIgnoreOccurrenceContext.set(type);
}
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.STRING_LITERAL};
}
@Override
public void visitToken(DetailAST aAST)
{
if (isInIgnoreOccurrenceContext(aAST)) {
return;
}
final String currentString = aAST.getText();
if ((mPattern == null) || !mPattern.matcher(currentString).find()) {
List hitList = mStringMap.get(currentString);
if (hitList == null) {
hitList = Lists.newArrayList();
mStringMap.put(currentString, hitList);
}
final int line = aAST.getLineNo();
final int col = aAST.getColumnNo();
hitList.add(new StringInfo(line, col));
}
}
/**
* Analyses the path from the AST root to a given AST for occurrences
* of the token types in {@link #mIgnoreOccurrenceContext}.
*
* @param aAST the node from where to start searching towards the root node
* @return whether the path from the root node to aAST contains one of the
* token type in {@link #mIgnoreOccurrenceContext}.
*/
private boolean isInIgnoreOccurrenceContext(DetailAST aAST)
{
for (DetailAST token = aAST;
token.getParent() != null;
token = token.getParent())
{
final int type = token.getType();
if (mIgnoreOccurrenceContext.get(type)) {
return true;
}
}
return false;
}
@Override
public void beginTree(DetailAST aRootAST)
{
super.beginTree(aRootAST);
mStringMap.clear();
}
@Override
public void finishTree(DetailAST aRootAST)
{
final Set keys = mStringMap.keySet();
for (String key : keys) {
final List hits = mStringMap.get(key);
if (hits.size() > mAllowedDuplicates) {
final StringInfo firstFinding = hits.get(0);
final int line = firstFinding.getLine();
final int col = firstFinding.getCol();
log(line, col, "multiple.string.literal", key, hits.size());
}
}
}
/**
* This class contains information about where a string was found.
*/
private static final class StringInfo
{
/**
* Line of finding
*/
private final int mLine;
/**
* Column of finding
*/
private final int mCol;
/**
* Creates information about a string position.
* @param aLine int
* @param aCol int
*/
private StringInfo(int aLine, int aCol)
{
mLine = aLine;
mCol = aCol;
}
/**
* The line where a string was found.
* @return int Line of the string.
*/
private int getLine()
{
return mLine;
}
/**
* The column where a string was found.
* @return int Column of the string.
*/
private int getCol()
{
return mCol;
}
}
}
././@LongLink 100644 0 0 163 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/MultipleVariableDeclarationsCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/MultipleVariableDeclarat100644 0 0 11015 12026051046 31421 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
/**
*
* Checks that each variable declaration is in its own statement
* and on its own line.
*
* @author o_sukhodolsky
*/
public class MultipleVariableDeclarationsCheck extends Check
{
/** Creates new instance of the check. */
public MultipleVariableDeclarationsCheck()
{
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.VARIABLE_DEF};
}
@Override
public void visitToken(DetailAST aAST)
{
DetailAST nextNode = aAST.getNextSibling();
final boolean isCommaSeparated =
((nextNode != null) && (nextNode.getType() == TokenTypes.COMMA));
if (nextNode == null) {
// no next statement - no check
return;
}
if ((nextNode.getType() == TokenTypes.COMMA)
|| (nextNode.getType() == TokenTypes.SEMI))
{
nextNode = nextNode.getNextSibling();
}
if ((nextNode != null)
&& (nextNode.getType() == TokenTypes.VARIABLE_DEF))
{
final DetailAST firstNode = CheckUtils.getFirstNode(aAST);
if (isCommaSeparated) {
// Check if the multiple variable declarations are in a
// for loop initializer. If they are, then no warning
// should be displayed. Declaring multiple variables in
// a for loop initializer is a good way to minimize
// variable scope. Refer Feature Request Id - 2895985
// for more details
if (aAST.getParent().getType() != TokenTypes.FOR_INIT) {
log(firstNode, "multiple.variable.declarations.comma");
}
return;
}
final DetailAST lastNode = getLastNode(aAST);
final DetailAST firstNextNode = CheckUtils.getFirstNode(nextNode);
if (firstNextNode.getLineNo() == lastNode.getLineNo()) {
log(firstNode, "multiple.variable.declarations");
}
}
}
/**
* Finds sub-node for given node maximum (line, column) pair.
* @param aNode the root of tree for search.
* @return sub-node with maximum (line, column) pair.
*/
private static DetailAST getLastNode(final DetailAST aNode)
{
DetailAST currentNode = aNode;
DetailAST child = aNode.getFirstChild();
while (child != null) {
final DetailAST newNode = getLastNode(child);
if ((newNode.getLineNo() > currentNode.getLineNo())
|| ((newNode.getLineNo() == currentNode.getLineNo())
&& (newNode.getColumnNo() > currentNode.getColumnNo())))
{
currentNode = newNode;
}
child = child.getNextSibling();
}
return currentNode;
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/NestedForDepthCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/NestedForDepthCheck.java100644 0 0 5743 12026051046 31247 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Check the number of nested for -statements. The maximum
* number of nested layers can be configured. The default value is 1. Most of
* the logic is implemented in the parent class. The code for the class is
* copied from the NestedIfDepthCheck-class. The only difference is the
* intercepted token (for instead of if). Example:
*
* @author Alexander Jesse
* @see com.puppycrawl.tools.checkstyle.checks.coding.AbstractNestedDepthCheck
* @see com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck
*/
public final class NestedForDepthCheck extends AbstractNestedDepthCheck
{
/** default allowed nesting depth. */
private static final int DEFAULT_MAX = 1;
/** Creates new check instance with default allowed nesting depth. */
public NestedForDepthCheck()
{
super(DEFAULT_MAX);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.LITERAL_FOR};
}
@Override
public void visitToken(DetailAST aAST)
{
if (TokenTypes.LITERAL_FOR == aAST.getType()) {
nestIn(aAST, "nested.for.depth");
}
}
@Override
public void leaveToken(DetailAST aAST)
{
if (TokenTypes.LITERAL_FOR == aAST.getType()) {
nestOut();
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/NestedIfDepthCheck.java 100644 0 0 5571 12026051045 31055 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
/**
* Restricts nested if-else blocks to a specified depth (default = 1).
*
* @author Simon Harris
*/
public final class NestedIfDepthCheck extends AbstractNestedDepthCheck
{
/** default allowed nesting depth. */
private static final int DEFAULT_MAX = 1;
/** Creates new check instance with default allowed nesting depth. */
public NestedIfDepthCheck()
{
super(DEFAULT_MAX);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.LITERAL_IF};
}
@Override
public void visitToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.LITERAL_IF:
visitLiteralIf(aAST);
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
@Override
public void leaveToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.LITERAL_IF:
leaveLiteralIf(aAST);
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
/**
* Increases current nesting depth.
* @param aIf node for if.
*/
private void visitLiteralIf(DetailAST aIf)
{
if (!CheckUtils.isElseIf(aIf)) {
nestIn(aIf, "nested.if.depth");
}
}
/**
* Decreases current nesting depth.
* @param aIf node for if.
*/
private void leaveLiteralIf(DetailAST aIf)
{
if (!CheckUtils.isElseIf(aIf)) {
nestOut();
}
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/NestedTryDepthCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/NestedTryDepthCheck.java100644 0 0 5237 12026051045 31274 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Restricts nested try-catch-finally blocks to a specified depth (default = 1).
* @author Simon Harris
*/
public final class NestedTryDepthCheck extends AbstractNestedDepthCheck
{
/** default allowed nesting depth */
private static final int DEFAULT_MAX = 1;
/** Creates new check instance with default allowed nesting depth. */
public NestedTryDepthCheck()
{
super(DEFAULT_MAX);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.LITERAL_TRY};
}
@Override
public void visitToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.LITERAL_TRY:
visitLiteralTry(aAST);
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
@Override
public void leaveToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.LITERAL_TRY:
leaveLiteralTry();
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
/**
* Increases current nesting depth.
* @param aTry node for try.
*/
private void visitLiteralTry(DetailAST aTry)
{
nestIn(aTry, "nested.try.depth");
}
/** Decreases current nesting depth */
private void leaveLiteralTry()
{
nestOut();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/NoCloneCheck.java 100644 0 0 11651 12026051045 27740 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
/**
*
* Checks that the clone method is not overridden from the
* Object class.
*
*
*
* Rationale: The clone method relies on strange/hard to follow rules that
* do not work it all situations. Consequently, it is difficult to
* override correctly. Below are some of the rules/reasons why the clone
* method should be avoided.
*
*
*
* Classes supporting the clone method should implement the Cloneable
* interface but the Cloneable interface does not include the clone method.
* As a result, it doesn't enforce the method override.
*
*
* The Cloneable interface forces the Object's clone method to work
* correctly. Without implementing it, the Object's clone method will
* throw a CloneNotSupportedException.
*
*
* Non-final classes must return the object returned from a call to
* super.clone().
*
*
* Final classes can use a constructor to create a clone which is different
* from non-final classes.
*
*
* If a super class implements the clone method incorrectly all subclasses
* calling super.clone() are doomed to failure.
*
*
* If a class has references to mutable objects then those object
* references must be replaced with copies in the clone method
* after calling super.clone().
*
*
* The clone method does not work correctly with final mutable object
* references because final references cannot be reassigned.
*
*
* If a super class overrides the clone method then all subclasses must
* provide a correct clone implementation.
*
*
*
*
*
* Two alternatives to the clone method, in some cases, is a copy constructor
* or a static factory method to return copies of an object. Both of these
* approaches are simpler and do not conflict with final fields. The do not
* force the calling client to handle a CloneNotSuportException. They also
* are typed therefore no casting is necessary. Finally, they are more
* flexible since they can take interface types rather than concrete classes.
*
*
*
* Sometimes a copy constructor or static factory is not an acceptable
* alternative to the clone method. The example below highlights the
* limitation of a copy constructor (or static factory). Assume
* Square is a subclass for Shape.
*
*
*
* ...assume at this point the code knows nothing of s1 being a Square
* that's the beauty of polymorphism but the code wants to copy
* the Square which is declared as a Shape, its super type...
*
*
* Shape s2 = new Shape(s1); //using the copy constructor
* System.out.println(s2 instanceof Square); //false
*
*
* The working solution (without knowing about all subclasses and doing many
* casts) is to do the following (assuming correct clone implementation).
*
*
*
* Just keep in mind if this type of polymorphic cloning is required
* then a properly implemented clone method may be the best choice.
*
*
*
* Much of this information was taken from Effective Java:
* Programming Language Guide First Edition by Joshua Bloch
* pages 45-52. Give Bloch credit for writing an excellent book.
*
*
*
* This check is almost exactly the same as the {@link NoFinalizerCheck}
*
*
* @author Travis Schneeberger
* @version 1.0
* @see java.lang.Object#clone()
* @see java.lang.Cloneable
* @see java.lang.CloneNotSupportedException
*/
public class NoCloneCheck extends AbstractIllegalMethodCheck
{
/**
* Creates an instance.
*/
public NoCloneCheck()
{
super("clone", "avoid.clone.method");
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/NoFinalizerCheck.java 100644 0 0 2764 12026051045 30610 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
/**
* Checks that no method having zero parameters is defined
* using the name finalize.
*
* @author fqian@google.com (Feng Qian)
* @author smckay@google.com (Steve McKay)
* @author lkuehne
*/
public class NoFinalizerCheck extends AbstractIllegalMethodCheck
{
/**
* Creates an instance.
*/
public NoFinalizerCheck()
{
super("finalize", "avoid.finalizer.method");
}
}
././@LongLink 100644 0 0 152 12026055133 10246 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/OneStatementPerLineCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/OneStatementPerLineCheck100644 0 0 7414 12026051045 31332 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Restricts the number of statements per line to one.
* @author Alexander Jesse
* @author Oliver Burn
*/
public final class OneStatementPerLineCheck extends Check
{
/** hold the line-number where the last statement ended. */
private int mLastStatementEnd = -1;
/** tracks the depth of EXPR tokens. */
private int mExprDepth;
/**
* The for-header usually has 3 statements on one line, but THIS IS OK.
*/
private boolean mInForHeader;
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.EXPR, TokenTypes.SEMI, TokenTypes.FOR_INIT,
TokenTypes.FOR_ITERATOR,
};
}
@Override
public void beginTree(DetailAST aRootAST)
{
mExprDepth = 0;
mInForHeader = false;
mLastStatementEnd = -1;
}
@Override
public void visitToken(DetailAST aAst)
{
switch (aAst.getType()) {
case TokenTypes.EXPR:
visitExpr(aAst);
break;
case TokenTypes.SEMI:
visitSemi(aAst);
break;
case TokenTypes.FOR_INIT:
mInForHeader = true;
break;
default:
break;
}
}
@Override
public void leaveToken(DetailAST aAst)
{
switch (aAst.getType()) {
case TokenTypes.FOR_ITERATOR:
mInForHeader = false;
break;
case TokenTypes.EXPR:
mExprDepth--;
break;
default:
break;
}
}
/**
* Mark the state-change for the statement (entering) and remember the
* first line of the last statement. If the first line of the new
* statement is the same as the last line of the last statement and we are
* not within a for-statement, then the rule is violated.
* @param aAst token for the {@link TokenTypes#EXPR}.
*/
private void visitExpr(DetailAST aAst)
{
mExprDepth++;
if (mExprDepth == 1) {
if (!mInForHeader && (mLastStatementEnd == aAst.getLineNo())) {
log(aAst, "multiple.statements.line");
}
}
}
/**
* Mark the state-change for the statement (leaving) and remember the last
* line of the last statement.
* @param aAst for the {@link TokenTypes#SEMI}.
*/
private void visitSemi(DetailAST aAst)
{
if (mExprDepth == 0) {
mLastStatementEnd = aAst.getLineNo();
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/package-info.java 100644 0 0 2277 12026051042 27752 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* Contains the Coding checks that are
* bundled with the main distribution.
*/
package com.puppycrawl.tools.checkstyle.checks.coding;
././@LongLink 100644 0 0 151 12026055133 10245 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/PackageDeclarationCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/PackageDeclarationCheck.100644 0 0 7043 12026051044 31221 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.io.File;
/**
* Ensures there is a package declaration.
* Rationale: Classes that live in the null package cannot be
* imported. Many novice developers are not aware of this.
*
* @author Simon Harris
* @author Oliver Burn
*/
public final class PackageDeclarationCheck extends Check
{
/** is package defined. */
private boolean mDefined;
/** whether to ignore the directory name matches the package. */
private boolean mIgnoreDirectoryName;
/**
* Set whether to ignore checking the directory name.
* @param aValue the new value.
*/
public void setIgnoreDirectoryName(boolean aValue)
{
mIgnoreDirectoryName = aValue;
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.PACKAGE_DEF};
}
@Override
public int[] getRequiredTokens()
{
return getDefaultTokens();
}
@Override
public void beginTree(DetailAST aAST)
{
mDefined = false;
}
@Override
public void finishTree(DetailAST aAST)
{
if (!mDefined) {
log(aAST.getLineNo(), "missing.package.declaration");
}
}
@Override
public void visitToken(DetailAST aAST)
{
mDefined = true;
if (mIgnoreDirectoryName) {
return;
}
// Calculate the directory name, but stripping off the last
// part.
final String fname = getFileContents().getFilename();
final int lastPos = fname.lastIndexOf(File.separatorChar);
final String dirname = fname.substring(0, lastPos);
// Convert the found package name into the expected directory name.
final DetailAST nameAST = aAST.getLastChild().getPreviousSibling();
final FullIdent full = FullIdent.createFullIdent(nameAST);
final String expected = full.getText().replace('.', File.separatorChar);
// Finally see that the real directory ends with the expected directory
if (!dirname.endsWith(expected)) {
log(full.getLineNo(),
full.getColumnNo(),
"package.dir.mismatch",
expected);
}
}
}
././@LongLink 100644 0 0 152 12026055133 10246 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/ParameterAssignmentCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/ParameterAssignmentCheck100644 0 0 16130 12026051044 31430 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.util.Set;
/**
*
* Disallow assignment of parameters.
*
*
* Rationale:
* Parameter assignment is often considered poor
* programming practice. Forcing developers to declare
* parameters as final is often onerous. Having a check
* ensure that parameters are never assigned would give
* the best of both worlds.
*
* @author Simon Harris
*/
public final class ParameterAssignmentCheck extends Check
{
/** Stack of methods' parameters. */
private final FastStack> mParameterNamesStack =
FastStack.newInstance();
/** Current set of perameters. */
private Set mParameterNames;
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.CTOR_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.ASSIGN,
TokenTypes.PLUS_ASSIGN,
TokenTypes.MINUS_ASSIGN,
TokenTypes.STAR_ASSIGN,
TokenTypes.DIV_ASSIGN,
TokenTypes.MOD_ASSIGN,
TokenTypes.SR_ASSIGN,
TokenTypes.BSR_ASSIGN,
TokenTypes.SL_ASSIGN,
TokenTypes.BAND_ASSIGN,
TokenTypes.BXOR_ASSIGN,
TokenTypes.BOR_ASSIGN,
TokenTypes.INC,
TokenTypes.POST_INC,
TokenTypes.DEC,
TokenTypes.POST_DEC,
};
}
@Override
public int[] getRequiredTokens()
{
return getDefaultTokens();
}
@Override
public void beginTree(DetailAST aRootAST)
{
// clear data
mParameterNamesStack.clear();
mParameterNames = null;
}
@Override
public void visitToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.CTOR_DEF:
case TokenTypes.METHOD_DEF:
visitMethodDef(aAST);
break;
case TokenTypes.ASSIGN:
case TokenTypes.PLUS_ASSIGN:
case TokenTypes.MINUS_ASSIGN:
case TokenTypes.STAR_ASSIGN:
case TokenTypes.DIV_ASSIGN:
case TokenTypes.MOD_ASSIGN:
case TokenTypes.SR_ASSIGN:
case TokenTypes.BSR_ASSIGN:
case TokenTypes.SL_ASSIGN:
case TokenTypes.BAND_ASSIGN:
case TokenTypes.BXOR_ASSIGN:
case TokenTypes.BOR_ASSIGN:
visitAssign(aAST);
break;
case TokenTypes.INC:
case TokenTypes.POST_INC:
case TokenTypes.DEC:
case TokenTypes.POST_DEC:
visitIncDec(aAST);
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
@Override
public void leaveToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.CTOR_DEF:
case TokenTypes.METHOD_DEF:
leaveMethodDef();
break;
case TokenTypes.ASSIGN:
case TokenTypes.PLUS_ASSIGN:
case TokenTypes.MINUS_ASSIGN:
case TokenTypes.STAR_ASSIGN:
case TokenTypes.DIV_ASSIGN:
case TokenTypes.MOD_ASSIGN:
case TokenTypes.SR_ASSIGN:
case TokenTypes.BSR_ASSIGN:
case TokenTypes.SL_ASSIGN:
case TokenTypes.BAND_ASSIGN:
case TokenTypes.BXOR_ASSIGN:
case TokenTypes.BOR_ASSIGN:
case TokenTypes.INC:
case TokenTypes.POST_INC:
case TokenTypes.DEC:
case TokenTypes.POST_DEC:
// Do nothing
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
/**
* Ckecks if this is assignments of parameter.
* @param aAST assignment to check.
*/
private void visitAssign(DetailAST aAST)
{
checkIdent(aAST);
}
/**
* Checks if this is increment/decrement of parameter.
* @param aAST dec/inc to check.
*/
private void visitIncDec(DetailAST aAST)
{
checkIdent(aAST);
}
/**
* Check if ident is parameter.
* @param aAST ident to check.
*/
private void checkIdent(DetailAST aAST)
{
if ((mParameterNames != null) && !mParameterNames.isEmpty()) {
final DetailAST identAST = aAST.getFirstChild();
if ((identAST != null)
&& (identAST.getType() == TokenTypes.IDENT)
&& mParameterNames.contains(identAST.getText()))
{
log(aAST.getLineNo(), aAST.getColumnNo(),
"parameter.assignment", identAST.getText());
}
}
}
/**
* Creates new set of parameters and store old one in stack.
* @param aAST a method to process.
*/
private void visitMethodDef(DetailAST aAST)
{
mParameterNamesStack.push(mParameterNames);
mParameterNames = Sets.newHashSet();
visitMethodParameters(aAST.findFirstToken(TokenTypes.PARAMETERS));
}
/** Restores old set of parameters. */
private void leaveMethodDef()
{
mParameterNames = mParameterNamesStack.pop();
}
/**
* Creates new parameter set for given method.
* @param aAST a method for process.
*/
private void visitMethodParameters(DetailAST aAST)
{
DetailAST parameterDefAST =
aAST.findFirstToken(TokenTypes.PARAMETER_DEF);
for (; parameterDefAST != null;
parameterDefAST = parameterDefAST.getNextSibling())
{
if (parameterDefAST.getType() == TokenTypes.PARAMETER_DEF) {
final DetailAST param =
parameterDefAST.findFirstToken(TokenTypes.IDENT);
mParameterNames.add(param.getText());
}
}
}
}
././@LongLink 100644 0 0 146 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/RedundantThrowsCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/RedundantThrowsCheck.jav100644 0 0 14521 12026051044 31373 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.google.common.collect.Lists;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck;
import java.util.Iterator;
import java.util.List;
/**
* Checks for redundant exceptions declared in throws clause
* such as duplicates, unchecked exceptions or subclasses of
* another declared exception.
*
*
* @author o_sukhodolsky
*/
public class RedundantThrowsCheck extends AbstractTypeAwareCheck
{
/**
* whether unchecked exceptions in throws
* are allowed or not
*/
private boolean mAllowUnchecked;
/**
* whether subclass of another declared
* exception is allowed in throws clause
*/
private boolean mAllowSubclasses;
/**
* Getter for allowUnchecked property.
* @param aAllowUnchecked whether unchecked excpetions in throws
* are allowed or not
*/
public void setAllowUnchecked(boolean aAllowUnchecked)
{
mAllowUnchecked = aAllowUnchecked;
}
/**
* Getter for allowSubclasses property.
* @param aAllowSubclasses whether subclass of another declared
* exception is allowed in throws clause
*/
public void setAllowSubclasses(boolean aAllowSubclasses)
{
mAllowSubclasses = aAllowSubclasses;
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.PACKAGE_DEF,
TokenTypes.IMPORT,
TokenTypes.CLASS_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.CTOR_DEF,
};
}
@Override
protected final void processAST(DetailAST aAST)
{
final List knownExcs = Lists.newLinkedList();
final DetailAST throwsAST =
aAST.findFirstToken(TokenTypes.LITERAL_THROWS);
if (throwsAST != null) {
DetailAST child = throwsAST.getFirstChild();
while (child != null) {
if ((child.getType() == TokenTypes.IDENT)
|| (child.getType() == TokenTypes.DOT))
{
final FullIdent fi = FullIdent.createFullIdent(child);
checkException(fi, knownExcs);
}
child = child.getNextSibling();
}
}
}
@Override
protected final void logLoadError(Token aIdent)
{
logLoadErrorImpl(aIdent.getLineNo(), aIdent.getColumnNo(),
"redundant.throws.classInfo", aIdent.getText());
}
/**
* Checks if an exception is already know (list of known
* exceptions contains it or its superclass) and it's not
* a superclass for some known exception and it's not
* an unchecked exception.
* If it's unknown then it will be added to ist of known exception.
* All subclasses of this exception will be deleted from known
* and the exception will be added instead.
*
* @param aExc FullIdent of exception to check
* @param aKnownExcs list of already known exception
*/
private void checkException(FullIdent aExc, List aKnownExcs)
{
// Let's try to load class.
final ClassInfo newClassInfo =
createClassInfo(new Token(aExc), getCurrentClassName());
if (!mAllowUnchecked) {
if (isUnchecked(newClassInfo.getClazz())) {
log(aExc.getLineNo(), aExc.getColumnNo(),
"redundant.throws.unchecked", aExc.getText());
}
}
boolean shouldAdd = true;
for (final Iterator known = aKnownExcs.iterator(); known
.hasNext();)
{
final ClassInfo ci = known.next();
final Token fi = ci.getName();
if (ci.getClazz() == newClassInfo.getClazz()) {
shouldAdd = false;
log(aExc.getLineNo(), aExc.getColumnNo(),
"redundant.throws.duplicate", aExc.getText());
}
else if (!mAllowSubclasses) {
if (isSubclass(ci.getClazz(), newClassInfo.getClazz())) {
known.remove();
log(fi.getLineNo(), fi.getColumnNo(),
"redundant.throws.subclass",
fi.getText(), aExc.getText());
}
else if (isSubclass(newClassInfo.getClazz(), ci.getClazz())) {
shouldAdd = false;
log(aExc.getLineNo(), aExc.getColumnNo(),
"redundant.throws.subclass",
aExc.getText(), fi.getText());
}
}
}
if (shouldAdd) {
aKnownExcs.add(newClassInfo);
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/RequireThisCheck.java 100644 0 0 15034 12026051044 30645 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.DeclarationCollector;
/**
*
Checks that code doesn't rely on the "this" default.
* That is references to instance variables and methods of the present
* object are explicitly of the form "this.varName" or
* "this.methodName(args)".
*
*
Examples of use:
*
* <module name="RequireThis"/>
*
* An example of how to configure to check this qualifier for
* methods only:
*
Limitations: I'm not currently doing anything about static variables
* or catch-blocks. Static methods invoked on a class name seem to be OK;
* both the class name and the method name have a DOT parent.
* Non-static methods invoked on either this or a variable name seem to be
* OK, likewise.
*
Much of the code for this check was cribbed from Rick Giles's
* HiddenFieldCheck.
*
* @author Stephen Bloch
* @author o_sukhodolsky
*/
public class RequireThisCheck extends DeclarationCollector
{
/** whether we should check fields usage. */
private boolean mCheckFields = true;
/** whether we should check methods usage. */
private boolean mCheckMethods = true;
/**
* Setter for checkFields property.
* @param aCheckFields should we check fields usage or not.
*/
public void setCheckFields(boolean aCheckFields)
{
mCheckFields = aCheckFields;
}
/**
* @return true if we should check fields usage false otherwise.
*/
public boolean getCheckFields()
{
return mCheckFields;
}
/**
* Setter for checkMethods property.
* @param aCheckMethods should we check methods usage or not.
*/
public void setCheckMethods(boolean aCheckMethods)
{
mCheckMethods = aCheckMethods;
}
/**
* @return true if we should check methods usage false otherwise.
*/
public boolean getCheckMethods()
{
return mCheckMethods;
}
/** Creates new instance of the check. */
public RequireThisCheck()
{
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.CLASS_DEF,
TokenTypes.CTOR_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.IDENT,
TokenTypes.INTERFACE_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.PARAMETER_DEF,
TokenTypes.SLIST,
TokenTypes.VARIABLE_DEF,
};
}
@Override
public int[] getRequiredTokens()
{
return getDefaultTokens();
}
@Override
public void visitToken(DetailAST aAST)
{
super.visitToken(aAST);
if (aAST.getType() == TokenTypes.IDENT) {
processIDENT(aAST);
}
} // end visitToken
/**
* Checks if a given IDENT is method call or field name which
* require explicit this qualifier.
*
* @param aAST IDENT to check.
*/
private void processIDENT(DetailAST aAST)
{
final int parentType = aAST.getParent().getType();
if (parentType == TokenTypes.ANNOTATION_MEMBER_VALUE_PAIR
|| parentType == TokenTypes.ANNOTATION
|| parentType == TokenTypes.ANNOTATION_FIELD_DEF)
{
//cannot refer to 'this' from annotations
return;
}
// let's check method calls
if (parentType == TokenTypes.METHOD_CALL) {
if (mCheckMethods && isClassField(aAST.getText())) {
log(aAST, "require.this.method", aAST.getText());
}
return;
}
// let's check fields
if (!mCheckFields) {
// we shouldn't check fields
return;
}
if (ScopeUtils.getSurroundingScope(aAST) == null) {
// it is not a class or interface it's
// either import or package
// we shouldn't checks this
return;
}
if ((parentType == TokenTypes.DOT)
&& (aAST.getPreviousSibling() != null))
{
// it's the method name in a method call; no problem
return;
}
if ((parentType == TokenTypes.TYPE)
|| (parentType == TokenTypes.LITERAL_NEW))
{
// it's a type name; no problem
return;
}
if ((parentType == TokenTypes.VARIABLE_DEF)
|| (parentType == TokenTypes.CTOR_DEF)
|| (parentType == TokenTypes.METHOD_DEF)
|| (parentType == TokenTypes.CLASS_DEF)
|| (parentType == TokenTypes.ENUM_DEF)
|| (parentType == TokenTypes.INTERFACE_DEF)
|| (parentType == TokenTypes.PARAMETER_DEF))
{
// it's being declared; no problem
return;
}
final String name = aAST.getText();
if (isClassField(name)) {
log(aAST, "require.this.variable", name);
}
}
} // end class RequireThis
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/ReturnCountCheck.java 100644 0 0 13577 12026051044 30703 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck;
/**
*
* Restricts return statements to a specified count (default = 2).
* Ignores specified methods (equals() by default).
*
*
* Rationale: Too many return points can be indication that code is
* attempting to do too much or may be difficult to understand.
*
*
* @author Simon Harris
* TODO: Test for inside a static block
*/
public final class ReturnCountCheck extends AbstractFormatCheck
{
/** Default allowed number of return statements. */
private static final int DEFAULT_MAX = 2;
/** Stack of method contexts. */
private final FastStack mContextStack = FastStack.newInstance();
/** Maximum allowed number of return stmts. */
private int mMax;
/** Current method context. */
private Context mContext;
/** Creates new instance of the checks. */
public ReturnCountCheck()
{
super("^equals$");
setMax(DEFAULT_MAX);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.CTOR_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.LITERAL_RETURN,
};
}
@Override
public int[] getRequiredTokens()
{
return new int[]{
TokenTypes.CTOR_DEF,
TokenTypes.METHOD_DEF,
};
}
/**
* Getter for max property.
* @return maximum allowed number of return statements.
*/
public int getMax()
{
return mMax;
}
/**
* Setter for max property.
* @param aMax maximum allowed number of return statements.
*/
public void setMax(int aMax)
{
mMax = aMax;
}
@Override
public void beginTree(DetailAST aRootAST)
{
mContext = null;
mContextStack.clear();
}
@Override
public void visitToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.CTOR_DEF:
case TokenTypes.METHOD_DEF:
visitMethodDef(aAST);
break;
case TokenTypes.LITERAL_RETURN:
mContext.visitLiteralReturn();
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
@Override
public void leaveToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.CTOR_DEF:
case TokenTypes.METHOD_DEF:
leaveMethodDef(aAST);
break;
case TokenTypes.LITERAL_RETURN:
// Do nothing
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
/**
* Creates new method context and places old one on the stack.
* @param aAST method definition for check.
*/
private void visitMethodDef(DetailAST aAST)
{
mContextStack.push(mContext);
final DetailAST methodNameAST = aAST.findFirstToken(TokenTypes.IDENT);
mContext =
new Context(!getRegexp().matcher(methodNameAST.getText()).find());
}
/**
* Checks number of return statments and restore
* previous method context.
* @param aAST method def node.
*/
private void leaveMethodDef(DetailAST aAST)
{
mContext.checkCount(aAST);
mContext = mContextStack.pop();
}
/**
* Class to encapsulate information about one method.
* @author Simon Harris
*/
private class Context
{
/** Whether we should check this method or not. */
private final boolean mChecking;
/** Counter for return statements. */
private int mCount;
/**
* Creates new method context.
* @param aChecking should we check this method or not.
*/
public Context(boolean aChecking)
{
mChecking = aChecking;
mCount = 0;
}
/** Increase number of return statements. */
public void visitLiteralReturn()
{
++mCount;
}
/**
* Checks if number of return statements in method more
* than allowed.
* @param aAST method def associated with this context.
*/
public void checkCount(DetailAST aAST)
{
if (mChecking && (mCount > getMax())) {
log(aAST.getLineNo(), aAST.getColumnNo(), "return.count",
mCount, getMax());
}
}
}
}
././@LongLink 100644 0 0 160 12026055133 10245 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/SimplifyBooleanExpressionCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/SimplifyBooleanExpressio100644 0 0 5313 12026051043 31477 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
*
* Checks for overly complicated boolean expressions. Currently finds code like
* if (b == true), b || true, !false,
* etc.
*
*
* Rationale: Complex boolean logic makes code hard to understand and maintain.
*
*
* An example of how to configure the check is:
*
*
* <module name="SimplifyBooleanExpression"/>
*
* @author lkuehne
*/
public class SimplifyBooleanExpressionCheck
extends Check
{
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.LITERAL_TRUE, TokenTypes.LITERAL_FALSE};
}
@Override
public int[] getAcceptableTokens()
{
// Return empty list to prevent user changing tokens in the
// configuration.
return new int[] {};
}
@Override
public int[] getRequiredTokens()
{
return new int[] {TokenTypes.LITERAL_TRUE, TokenTypes.LITERAL_FALSE};
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST parent = aAST.getParent();
switch (parent.getType()) {
case TokenTypes.NOT_EQUAL:
case TokenTypes.EQUAL:
case TokenTypes.LNOT:
case TokenTypes.LOR:
case TokenTypes.LAND:
log(parent.getLineNo(), parent.getColumnNo(),
"simplify.expression");
break;
default:
break;
}
}
}
././@LongLink 100644 0 0 154 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/SimplifyBooleanReturnCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/SimplifyBooleanReturnChe100644 0 0 11414 12026051043 31434 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 antlr.collections.AST;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
*
* Checks for overly complicated boolean return statements.
* Idea shamelessly stolen from the equivalent PMD rule (pmd.sourceforge.net).
*
*
* An example of how to configure the check is:
*
*
* <module name="SimplifyBooleanReturn"/>
*
* @author Lars Kühne
*/
public class SimplifyBooleanReturnCheck
extends Check
{
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.LITERAL_IF};
}
@Override
public void visitToken(DetailAST aAST)
{
// LITERAL_IF has the following four or five children:
// '('
// condition
// ')'
// thenStatement
// [ LITERAL_ELSE (with the elseStatement as a child) ]
// don't bother if this is not if then else
final AST elseLiteral =
aAST.findFirstToken(TokenTypes.LITERAL_ELSE);
if (elseLiteral == null) {
return;
}
final AST elseStatement = elseLiteral.getFirstChild();
// skip '(' and ')'
// TODO: Introduce helpers in DetailAST
final AST condition = aAST.getFirstChild().getNextSibling();
final AST thenStatement = condition.getNextSibling().getNextSibling();
if (returnsOnlyBooleanLiteral(thenStatement)
&& returnsOnlyBooleanLiteral(elseStatement))
{
log(aAST.getLineNo(), aAST.getColumnNo(), "simplify.boolreturn");
}
}
/**
* Returns if an AST is a return statment with a boolean literal
* or a compound statement that contains only such a return statement.
*
* Returns true iff aAST represents
*
*
* return true/false;
*
* or
*
*
* {
* return true/false;
* }
*
*
* @param aAST the sytax tree to check
* @return if aAST is a return statment with a boolean literal.
*/
private static boolean returnsOnlyBooleanLiteral(AST aAST)
{
if (isBooleanLiteralReturnStatement(aAST)) {
return true;
}
final AST firstStmnt = aAST.getFirstChild();
return isBooleanLiteralReturnStatement(firstStmnt);
}
/**
* Returns if an AST is a return statment with a boolean literal.
*
* Returns true iff aAST represents
*
*
* return true/false;
*
*
* @param aAST the sytax tree to check
* @return if aAST is a return statment with a boolean literal.
*/
private static boolean isBooleanLiteralReturnStatement(AST aAST)
{
if ((aAST == null) || (aAST.getType() != TokenTypes.LITERAL_RETURN)) {
return false;
}
final AST expr = aAST.getFirstChild();
if ((expr == null) || (expr.getType() == TokenTypes.SEMI)) {
return false;
}
final AST value = expr.getFirstChild();
return isBooleanLiteralType(value.getType());
}
/**
* Checks if a token type is a literal true or false.
* @param aTokenType the TokenType
* @return true iff aTokenType is LITERAL_TRUE or LITERAL_FALSE
*/
private static boolean isBooleanLiteralType(final int aTokenType)
{
final boolean isTrue = (aTokenType == TokenTypes.LITERAL_TRUE);
final boolean isFalse = (aTokenType == TokenTypes.LITERAL_FALSE);
return isTrue || isFalse;
}
}
././@LongLink 100644 0 0 154 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/StringLiteralEqualityCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/StringLiteralEqualityChe100644 0 0 4510 12026051043 31420 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import antlr.collections.AST;
/**
*
Checks that string literals are not used with
* == or !=.
*
*
* Rationale: Novice Java programmers often use code like
* if (x == "something") when they mean
* if ("something".equals(x)).
*
*
* @author Lars Kühne
*/
public class StringLiteralEqualityCheck extends Check
{
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.EQUAL, TokenTypes.NOT_EQUAL};
}
@Override
public void visitToken(DetailAST aAST)
{
// no need to check for nulls here, == and != always have two children
final AST firstChild = aAST.getFirstChild();
final AST secondChild = firstChild.getNextSibling();
if ((firstChild.getType() == TokenTypes.STRING_LITERAL)
|| (secondChild.getType() == TokenTypes.STRING_LITERAL))
{
log(aAST.getLineNo(), aAST.getColumnNo(),
"string.literal.equality", aAST.getText());
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/SuperCloneCheck.java 100644 0 0 3135 12026051043 30436 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
/**
*
* Checks that an overriding clone() method invokes super.clone().
*
* @author Rick Giles
*/
public class SuperCloneCheck extends AbstractSuperCheck
{
@Override
protected String getMethodName()
{
return "clone";
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/SuperFinalizeCheck.java 100644 0 0 3175 12026051042 31142 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
/**
*
* Checks that an overriding finalize() method invokes super.finalize().
*
* @author Rick Giles
*/
public class SuperFinalizeCheck extends AbstractSuperCheck
{
@Override
protected String getMethodName()
{
return "finalize";
}
}
././@LongLink 100644 0 0 155 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/UnnecessaryParenthesesCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/coding/UnnecessaryParenthesesCh100644 0 0 25035 12026051042 31477 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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 antlr.collections.AST;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks if unnecessary parentheses are used in a statement or expression.
* The check will flag the following with warnings:
*
*
* return (x); // parens around identifier
* return (x + 1); // parens around return value
* int x = (y / 2 + 1); // parens around assignment rhs
* for (int i = (0); i < 10; i++) { // parens around literal
* t -= (z + 1); // parens around assignment rhs
*
* The check is not "type aware", that is to say, it can't tell if parentheses
* are unnecessary based on the types in an expression. It also doesn't know
* about operator precedence and associatvity; therefore it won't catch
* something like
*
*
* int x = (a + b) + c;
*
* In the above case, given that a, b, and c are
* all int variables, the parentheses around a + b
* are not needed.
*
*
* @author Eric Roe
*/
public class UnnecessaryParenthesesCheck extends Check
{
/** The minimum number of child nodes to consider for a match. */
private static final int MIN_CHILDREN_FOR_MATCH = 3;
/** The maximum string length before we chop the string. */
private static final int MAX_QUOTED_LENGTH = 25;
/** Token types for literals. */
private static final int [] LITERALS = {
TokenTypes.NUM_DOUBLE,
TokenTypes.NUM_FLOAT,
TokenTypes.NUM_INT,
TokenTypes.NUM_LONG,
TokenTypes.STRING_LITERAL,
TokenTypes.LITERAL_NULL,
TokenTypes.LITERAL_FALSE,
TokenTypes.LITERAL_TRUE,
};
/** Token types for assignment operations. */
private static final int [] ASSIGNMENTS = {
TokenTypes.ASSIGN,
TokenTypes.BAND_ASSIGN,
TokenTypes.BOR_ASSIGN,
TokenTypes.BSR_ASSIGN,
TokenTypes.BXOR_ASSIGN,
TokenTypes.DIV_ASSIGN,
TokenTypes.MINUS_ASSIGN,
TokenTypes.MOD_ASSIGN,
TokenTypes.PLUS_ASSIGN,
TokenTypes.SL_ASSIGN,
TokenTypes.SR_ASSIGN,
TokenTypes.STAR_ASSIGN,
};
/**
* Used to test if logging a warning in a parent node may be skipped
* because a warning was already logged on an immediate child node.
*/
private DetailAST mParentToSkip;
/** Depth of nested assignments. Normally this will be 0 or 1. */
private int mAssignDepth;
@Override
public int[] getDefaultTokens()
{
return new int [] {
TokenTypes.EXPR,
TokenTypes.IDENT,
TokenTypes.NUM_DOUBLE,
TokenTypes.NUM_FLOAT,
TokenTypes.NUM_INT,
TokenTypes.NUM_LONG,
TokenTypes.STRING_LITERAL,
TokenTypes.LITERAL_NULL,
TokenTypes.LITERAL_FALSE,
TokenTypes.LITERAL_TRUE,
TokenTypes.ASSIGN,
TokenTypes.BAND_ASSIGN,
TokenTypes.BOR_ASSIGN,
TokenTypes.BSR_ASSIGN,
TokenTypes.BXOR_ASSIGN,
TokenTypes.DIV_ASSIGN,
TokenTypes.MINUS_ASSIGN,
TokenTypes.MOD_ASSIGN,
TokenTypes.PLUS_ASSIGN,
TokenTypes.SL_ASSIGN,
TokenTypes.SR_ASSIGN,
TokenTypes.STAR_ASSIGN,
};
}
@Override
public void visitToken(DetailAST aAST)
{
final int type = aAST.getType();
final boolean surrounded = isSurrounded(aAST);
final DetailAST parent = aAST.getParent();
if ((type == TokenTypes.ASSIGN)
&& (parent.getType() == TokenTypes.ANNOTATION_MEMBER_VALUE_PAIR))
{
// shouldn't process assign in annotation pairs
return;
}
// An identifier surrounded by parentheses.
if (surrounded && (type == TokenTypes.IDENT)) {
mParentToSkip = aAST.getParent();
log(aAST, "unnecessary.paren.ident", aAST.getText());
return;
}
// A literal (numeric or string) surrounded by parentheses.
if (surrounded && inTokenList(type, LITERALS)) {
mParentToSkip = aAST.getParent();
if (type == TokenTypes.STRING_LITERAL) {
log(aAST, "unnecessary.paren.string",
chopString(aAST.getText()));
}
else {
log(aAST, "unnecessary.paren.literal", aAST.getText());
}
return;
}
// The rhs of an assignment surrounded by parentheses.
if (inTokenList(type, ASSIGNMENTS)) {
mAssignDepth++;
final DetailAST last = aAST.getLastChild();
if (last.getType() == TokenTypes.RPAREN) {
log(aAST, "unnecessary.paren.assign");
}
}
}
@Override
public void leaveToken(DetailAST aAST)
{
final int type = aAST.getType();
final DetailAST parent = aAST.getParent();
if ((type == TokenTypes.ASSIGN)
&& (parent.getType() == TokenTypes.ANNOTATION_MEMBER_VALUE_PAIR))
{
// shouldn't process assign in annotation pairs
return;
}
// An expression is surrounded by parentheses.
if (type == TokenTypes.EXPR) {
// If 'mParentToSkip' == 'aAST', then we've already logged a
// warning about an immediate child node in visitToken, so we don't
// need to log another one here.
if ((mParentToSkip != aAST) && exprSurrounded(aAST)) {
if (mAssignDepth >= 1) {
log(aAST, "unnecessary.paren.assign");
}
else if (aAST.getParent().getType()
== TokenTypes.LITERAL_RETURN)
{
log(aAST, "unnecessary.paren.return");
}
else {
log(aAST, "unnecessary.paren.expr");
}
}
mParentToSkip = null;
}
else if (inTokenList(type, ASSIGNMENTS)) {
mAssignDepth--;
}
super.leaveToken(aAST);
}
/**
* Tests if the given DetailAST is surrounded by parentheses.
* In short, does aAST have a previous sibling whose type is
* TokenTypes.LPAREN and a next sibling whose type is
* TokenTypes.RPAREN.
* @param aAST the DetailAST to check if it is surrounded by
* parentheses.
* @return true if aAST is surrounded by
* parentheses.
*/
private boolean isSurrounded(DetailAST aAST)
{
final DetailAST prev = aAST.getPreviousSibling();
final DetailAST next = aAST.getNextSibling();
return (prev != null) && (prev.getType() == TokenTypes.LPAREN)
&& (next != null) && (next.getType() == TokenTypes.RPAREN);
}
/**
* Tests if the given expression node is surrounded by parentheses.
* @param aAST a DetailAST whose type is
* TokenTypes.EXPR.
* @return true if the expression is surrounded by
* parentheses.
* @throws IllegalArgumentException if aAST.getType() is not
* equal to TokenTypes.EXPR.
*/
private boolean exprSurrounded(DetailAST aAST)
{
if (aAST.getType() != TokenTypes.EXPR) {
throw new IllegalArgumentException("Not an expression node.");
}
boolean surrounded = false;
if (aAST.getChildCount() >= MIN_CHILDREN_FOR_MATCH) {
final AST n1 = aAST.getFirstChild();
final AST nn = aAST.getLastChild();
surrounded = (n1.getType() == TokenTypes.LPAREN)
&& (nn.getType() == TokenTypes.RPAREN);
}
return surrounded;
}
/**
* Check if the given token type can be found in an array of token types.
* @param aType the token type.
* @param aTokens an array of token types to search.
* @return true if aType was found in
* aTokens.
*/
private boolean inTokenList(int aType, int [] aTokens)
{
// NOTE: Given the small size of the two arrays searched, I'm not sure
// it's worth bothering with doing a binary search or using a
// HashMap to do the searches.
boolean found = false;
for (int i = 0; (i < aTokens.length) && !found; i++) {
found = aTokens[i] == aType;
}
return found;
}
/**
* Returns the specified string chopped to MAX_QUOTED_LENGTH
* plus an ellipsis (...) if the length of the string exceeds
* MAX_QUOTED_LENGTH.
* @param aString the string to potentially chop.
* @return the chopped string if aString is longer than
* MAX_QUOTED_LENGTH; otherwise aString.
*/
private String chopString(String aString)
{
if (aString.length() > MAX_QUOTED_LENGTH) {
return aString.substring(0, MAX_QUOTED_LENGTH) + "...\"";
}
return aString;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/DeclarationCollector.java 100644 0 0 23630 12026051063 30276 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.util.LinkedList;
import java.util.Set;
/**
* Abstract class for checks which need to collect information about
* declared members/parameters/variables.
*
* @author o_sukhodolsky
*/
public abstract class DeclarationCollector extends Check
{
/** Stack of variable declaration frames. */
private FrameStack mFrames;
@Override
public void beginTree(DetailAST aRootAST)
{
mFrames = new FrameStack();
}
@Override
public void visitToken(DetailAST aAST)
{
final LexicalFrame frame = this.mFrames.current();
switch (aAST.getType()) {
case TokenTypes.VARIABLE_DEF : {
final String name =
aAST.findFirstToken(TokenTypes.IDENT).getText();
if (frame instanceof ClassFrame) {
final DetailAST mods =
aAST.findFirstToken(TokenTypes.MODIFIERS);
if (mods.branchContains(TokenTypes.LITERAL_STATIC)) {
((ClassFrame) frame).addStaticMember(name);
}
else {
((ClassFrame) frame).addInstanceMember(name);
}
}
else {
frame.addName(name);
}
break;
}
case TokenTypes.PARAMETER_DEF : {
final DetailAST nameAST = aAST.findFirstToken(TokenTypes.IDENT);
frame.addName(nameAST.getText());
break;
}
case TokenTypes.CLASS_DEF :
case TokenTypes.INTERFACE_DEF :
case TokenTypes.ENUM_DEF :
case TokenTypes.ANNOTATION_DEF : {
final DetailAST nameAST = aAST.findFirstToken(TokenTypes.IDENT);
frame.addName(nameAST.getText());
this.mFrames.enter(new ClassFrame());
break;
}
case TokenTypes.SLIST :
this.mFrames.enter(new BlockFrame());
break;
case TokenTypes.METHOD_DEF : {
final String name = aAST.findFirstToken(TokenTypes.IDENT).getText();
if (frame instanceof ClassFrame) {
final DetailAST mods =
aAST.findFirstToken(TokenTypes.MODIFIERS);
if (mods.branchContains(TokenTypes.LITERAL_STATIC)) {
((ClassFrame) frame).addStaticMember(name);
}
else {
((ClassFrame) frame).addInstanceMember(name);
}
}
}
case TokenTypes.CTOR_DEF :
this.mFrames.enter(new MethodFrame());
break;
default:
// do nothing
}
}
@Override
public void leaveToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.CLASS_DEF :
case TokenTypes.INTERFACE_DEF :
case TokenTypes.ENUM_DEF :
case TokenTypes.ANNOTATION_DEF :
case TokenTypes.SLIST :
case TokenTypes.METHOD_DEF :
case TokenTypes.CTOR_DEF :
this.mFrames.leave();
break;
default :
// do nothing
}
}
/**
* Check if given name is a name for class field in current environment.
* @param aName a name to check
* @return true is the given name is name of method or member.
*/
protected final boolean isClassField(String aName)
{
final LexicalFrame frame = mFrames.findFrame(aName);
return (frame instanceof ClassFrame)
&& ((ClassFrame) frame).hasInstanceMember(aName);
}
/**
* A declaration frame.
* @author Stephen Bloch
* June 19, 2003
*/
private abstract static class LexicalFrame
{
/** Set of name of variables declared in this frame. */
private final Set mVarNames;
/** constructor -- invokable only via super() from subclasses */
protected LexicalFrame()
{
mVarNames = Sets.newHashSet();
}
/** add a name to the frame.
* @param aNameToAdd the name we're adding
*/
void addName(String aNameToAdd)
{
mVarNames.add(aNameToAdd);
}
/** check whether the frame contains a given name.
* @param aNameToFind the name we're looking for
* @return whether it was found
*/
boolean contains(String aNameToFind)
{
return mVarNames.contains(aNameToFind);
}
}
/**
* The global frame; should hold only class names.
* @author Stephen Bloch
*/
private static class GlobalFrame extends LexicalFrame
{
}
/**
* A frame initiated at method definition; holds parameter names.
* @author Stephen Bloch
*/
private static class MethodFrame extends LexicalFrame
{
}
/**
* A frame initiated at class definition; holds instance variable
* names. For the present, I'm not worried about other class names,
* method names, etc.
* @author Stephen Bloch
*/
private static class ClassFrame extends LexicalFrame
{
/** Set of name of instance members declared in this frame. */
private final Set mInstanceMembers;
/** Set of name of variables declared in this frame. */
private final Set mStaticMembers;
/**
* Creates new instance of ClassFrame
*/
public ClassFrame()
{
super();
mInstanceMembers = Sets.newHashSet();
mStaticMembers = Sets.newHashSet();
}
/**
* Adds static member's name.
* @param aName a name of static member of the class
*/
public void addStaticMember(final String aName)
{
mStaticMembers.add(aName);
}
/**
* Adds instance member's name.
* @param aName a name of instance member of the class
*/
public void addInstanceMember(final String aName)
{
mInstanceMembers.add(aName);
}
/**
* Checks if a given name is a known instance member of the class.
* @param aName a name to check
* @return true is the given name is a name of a known
* instance member of the class
*/
public boolean hasInstanceMember(final String aName)
{
return mInstanceMembers.contains(aName);
}
@Override
boolean contains(String aNameToFind)
{
return super.contains(aNameToFind)
|| mInstanceMembers.contains(aNameToFind)
|| mStaticMembers.contains(aNameToFind);
}
}
/**
* A frame initiated on entering a statement list; holds local variable
* names. For the present, I'm not worried about other class names,
* method names, etc.
* @author Stephen Bloch
*/
private static class BlockFrame extends LexicalFrame
{
}
/**
* A stack of LexicalFrames. Standard issue....
* @author Stephen Bloch
*/
private static class FrameStack
{
/** List of lexical frames. */
private final LinkedList mFrameList;
/** Creates an empty FrameStack. */
FrameStack()
{
mFrameList = Lists.newLinkedList();
this.enter(new GlobalFrame());
}
/**
* Enter a scope, i.e. push a frame on the stack.
* @param aNewFrame the already-created frame to push
*/
void enter(LexicalFrame aNewFrame)
{
mFrameList.addFirst(aNewFrame);
}
/** Leave a scope, i.e. pop a frame from the stack. */
void leave()
{
mFrameList.removeFirst();
}
/**
* Get current scope, i.e. top frame on the stack.
* @return the current frame
*/
LexicalFrame current()
{
return mFrameList.getFirst();
}
/**
* Search this and containing frames for a given name.
* @param aNameToFind the name we're looking for
* @return the frame in which it was found, or null if not found
*/
LexicalFrame findFrame(String aNameToFind)
{
for (LexicalFrame thisFrame : mFrameList) {
if (thisFrame.contains(aNameToFind)) {
return thisFrame;
}
}
return null;
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/DescendantTokenCheck.java 100644 0 0 34616 12026051063 30217 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
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;
import java.util.Arrays;
import java.util.Set;
/**
*
* Checks for restricted tokens beneath other tokens.
*
*
* Examples of how to configure the check:
*
*
* <!-- String literal equality check -->
* <module name="DescendantToken">
* <property name="tokens" value="EQUAL,NOT_EQUAL"/>
* <property name="limitedTokens" value="STRING_LITERAL"/>
* <property name="maximumNumber" value="0"/>
* <property name="maximumDepth" value="1"/>
* </module>
*
* <!-- Switch with no default -->
* <module name="DescendantToken">
* <property name="tokens" value="LITERAL_SWITCH"/>
* <property name="maximumDepth" value="2"/>
* <property name="limitedTokens" value="LITERAL_DEFAULT"/>
* <property name="minimumNumber" value="1"/>
* </module>
*
* <!-- Assert statement may have side effects -->
* <module name="DescendantToken">
* <property name="tokens" value="LITERAL_ASSERT"/>
* <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"/>
* <property name="maximumNumber" value="0"/>
* </module>
*
* <!-- Initialiser in for performs no setup - use while instead? -->
* <module name="DescendantToken">
* <property name="tokens" value="FOR_INIT"/>
* <property name="limitedTokens" value="EXPR"/>
* <property name="minimumNumber" value="1"/>
* </module>
*
* <!-- Condition in for performs no check -->
* <module name="DescendantToken">
* <property name="tokens" value="FOR_CONDITION"/>
* <property name="limitedTokens" value="EXPR"/>
* <property name="minimumNumber" value="1"/>
* </module>
*
* <!-- Switch within switch -->
* <module name="DescendantToken">
* <property name="tokens" value="LITERAL_SWITCH"/>
* <property name="limitedTokens" value="LITERAL_SWITCH"/>
* <property name="maximumNumber" value="0"/>
* <property name="minimumDepth" value="1"/>
* </module>
*
* <!-- Return from within a catch or finally block -->
* <module name="DescendantToken">
* <property name="tokens" value="LITERAL_FINALLY,LITERAL_CATCH"/>
* <property name="limitedTokens" value="LITERAL_RETURN"/>
* <property name="maximumNumber" value="0"/>
* </module>
*
* <!-- Try within catch or finally block -->
* <module name="DescendantToken">
* <property name="tokens" value="LITERAL_CATCH,LITERAL_FINALLY"/>
* <property name="limitedTokens" value="LITERAL_TRY"/>
* <property name="maximumNumber" value="0"/>
* </module>
*
* <!-- Too many cases within a switch -->
* <module name="DescendantToken">
* <property name="tokens" value="LITERAL_SWITCH"/>
* <property name="limitedTokens" value="LITERAL_CASE"/>
* <property name="maximumDepth" value="2"/>
* <property name="maximumNumber" value="10"/>
* </module>
*
* <!-- Too many local variables within a method -->
* <module name="DescendantToken">
* <property name="tokens" value="METHOD_DEF"/>
* <property name="limitedTokens" value="VARIABLE_DEF"/>
* <property name="maximumDepth" value="2"/>
* <property name="maximumNumber" value="10"/>
* </module>
*
* <!-- Too many returns from within a method -->
* <module name="DescendantToken">
* <property name="tokens" value="METHOD_DEF"/>
* <property name="limitedTokens" value="LITERAL_RETURN"/>
* <property name="maximumNumber" value="3"/>
* </module>
*
* <!-- Too many fields within an interface -->
* <module name="DescendantToken">
* <property name="tokens" value="INTERFACE_DEF"/>
* <property name="limitedTokens" value="VARIABLE_DEF"/>
* <property name="maximumDepth" value="2"/>
* <property name="maximumNumber" value="0"/>
* </module>
*
* <!-- Limit the number of exceptions a method can throw -->
* <module name="DescendantToken">
* <property name="tokens" value="LITERAL_THROWS"/>
* <property name="limitedTokens" value="IDENT"/>
* <property name="maximumNumber" value="1"/>
* </module>
*
* <!-- Limit the number of expressions in a method -->
* <module name="DescendantToken">
* <property name="tokens" value="METHOD_DEF"/>
* <property name="limitedTokens" value="EXPR"/>
* <property name="maximumNumber" value="200"/>
* </module>
*
* <!-- Disallow empty statements -->
* <module name="DescendantToken">
* <property name="tokens" value="EMPTY_STAT"/>
* <property name="limitedTokens" value="EMPTY_STAT"/>
* <property name="maximumNumber" value="0"/>
* <property name="maximumDepth" value="0"/>
* <property name="maximumMessage"
* value="Empty statement is not allowed."/>
* </module>
*
* <!-- Too many fields within a class -->
* <module name="DescendantToken">
* <property name="tokens" value="CLASS_DEF"/>
* <property name="limitedTokens" value="VARIABLE_DEF"/>
* <property name="maximumDepth" value="2"/>
* <property name="maximumNumber" value="10"/>
* </module>
*
*
* @author Tim Tyler <tim@tt1.org>
* @author Rick Giles
*/
public class DescendantTokenCheck extends Check
{
/** minimum depth */
private int mMinimumDepth;
/** maximum depth */
private int mMaximumDepth = Integer.MAX_VALUE;
/** minimum number */
private int mMinimumNumber;
/** maximum number */
private int mMaximumNumber = Integer.MAX_VALUE;
/** Whether to sum the number of tokens found. */
private boolean mSumTokenCounts;
/** limited tokens */
private int[] mLimitedTokens = new int[0];
/** error message when minimum count not reached */
private String mMinimumMessage;
/** error message when maximum count exceeded */
private String mMaximumMessage;
/**
* Counts of descendant tokens.
* Indexed by (token ID - 1) for performance.
*/
private int[] mCounts = new int[0];
@Override
public int[] getDefaultTokens()
{
return new int[0];
}
@Override
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());
if (mSumTokenCounts) {
int total = 0;
for (int element : mLimitedTokens) {
total += mCounts[element - 1];
}
if (total < mMinimumNumber) {
log(aAST.getLineNo(), aAST.getColumnNo(),
(null == mMinimumMessage) ? "descendant.token.sum.min"
: mMinimumMessage,
String.valueOf(total),
String.valueOf(mMinimumNumber), name);
}
if (total > mMaximumNumber) {
log(aAST.getLineNo(), aAST.getColumnNo(),
(null == mMaximumMessage) ? "descendant.token.sum.max"
: mMaximumMessage,
String.valueOf(total),
String.valueOf(mMaximumNumber),
name);
}
}
else {
for (int element : mLimitedTokens) {
final int tokenCount = mCounts[element - 1];
if (tokenCount < mMinimumNumber) {
final String descendantName = TokenTypes
.getTokenName(element);
log(aAST.getLineNo(), aAST.getColumnNo(),
(null == mMinimumMessage) ? "descendant.token.min"
: mMinimumMessage,
String.valueOf(tokenCount),
String.valueOf(mMinimumNumber),
name,
descendantName);
}
if (tokenCount > mMaximumNumber) {
final String descendantName = TokenTypes
.getTokenName(element);
log(aAST.getLineNo(), aAST.getColumnNo(),
(null == mMaximumMessage) ? "descendant.token.max"
: mMaximumMessage,
String.valueOf(tokenCount),
String.valueOf(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();
}
}
}
@Override
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;
for (String name : tokenNames) {
result[i++] = TokenTypes.getTokenId(name);
}
return result;
}
/**
* Sets the tokens which occurance as descendant is limited.
* @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 MessageFormat pattern with arguments
*
*
{0} - token count
*
{1} - minimum number
*
{2} - name of token
*
{3} - name of limited token
*
*/
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 MessageFormat pattern with arguments
*
*
{0} - token count
*
{1} - maximum number
*
{2} - name of token
*
{3} - name of limited token
*
*/
public void setMaximumMessage(String aMessage)
{
mMaximumMessage = aMessage;
}
/**
* Sets whether to use the sum of the tokens found, rather than the
* individual counts.
* @param aSum whether to use the sum.
*/
public void setSumTokenCounts(boolean aSum)
{
mSumTokenCounts = aSum;
}
}
././@LongLink 100644 0 0 151 12026055133 10245 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/DesignForExtensionCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/DesignForExtensionCheck.100644 0 0 13153 12026051042 31320 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.design;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.Scope;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Checks that classes are designed for inheritance.
*
*
* More specifically, it enforces a programming style
* where superclasses provide empty "hooks" that can be
* implemented by subclasses.
*
*
*
* The exact rule is that nonprivate, nonstatic methods in
* nonfinal classes (or classes that do not
* only have private constructors) must either be
*
*
abstract or
*
final or
*
have an empty implementation
*
*
*
*
* This protects superclasses against beeing broken by
* subclasses. The downside is that subclasses are limited
* in their flexibility, in particular they cannot prevent
* execution of code in the superclass, but that also
* means that subclasses can't forget to call their super
* method.
*
*
* @author lkuehne
*/
public class DesignForExtensionCheck extends Check
{
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.METHOD_DEF};
}
@Override
public void visitToken(DetailAST aAST)
{
// nothing to do for Interfaces
if (ScopeUtils.inInterfaceOrAnnotationBlock(aAST)) {
return;
}
// method is ok if it is private or abstract or final
final DetailAST modifiers = aAST.findFirstToken(TokenTypes.MODIFIERS);
if (modifiers.branchContains(TokenTypes.LITERAL_PRIVATE)
|| modifiers.branchContains(TokenTypes.ABSTRACT)
|| modifiers.branchContains(TokenTypes.FINAL)
|| modifiers.branchContains(TokenTypes.LITERAL_STATIC))
{
return;
}
// method is ok if containing class is not visible in API and
// cannot be extended by 3rd parties (bug #884035)
if (!ScopeUtils.getSurroundingScope(aAST).isIn(Scope.PROTECTED)) {
return;
}
// method is ok if it is implementation can verified to be empty
// Note: native methods don't have impl in java code, so
// implementation can be null even if method not abstract
final DetailAST implementation = aAST.findFirstToken(TokenTypes.SLIST);
if ((implementation != null)
&& (implementation.getFirstChild().getType() == TokenTypes.RCURLY))
{
return;
}
// check if the containing class can be subclassed
final DetailAST classDef = findContainingClass(aAST);
final DetailAST classMods =
classDef.findFirstToken(TokenTypes.MODIFIERS);
if ((classDef.getType() == TokenTypes.ENUM_DEF)
|| classMods.branchContains(TokenTypes.FINAL))
{
return;
}
// check if subclassing is prevented by having only private ctors
final DetailAST objBlock = classDef.findFirstToken(TokenTypes.OBJBLOCK);
boolean hasDefaultConstructor = true;
boolean hasExplNonPrivateCtor = false;
DetailAST candidate = objBlock.getFirstChild();
while (candidate != null) {
if (candidate.getType() == TokenTypes.CTOR_DEF) {
hasDefaultConstructor = false;
final DetailAST ctorMods =
candidate.findFirstToken(TokenTypes.MODIFIERS);
if (!ctorMods.branchContains(TokenTypes.LITERAL_PRIVATE)) {
hasExplNonPrivateCtor = true;
break;
}
}
candidate = candidate.getNextSibling();
}
if (hasDefaultConstructor || hasExplNonPrivateCtor) {
final String name = aAST.findFirstToken(TokenTypes.IDENT).getText();
log(aAST.getLineNo(), aAST.getColumnNo(),
"design.forExtension", name);
}
}
/**
* Searches the tree towards the root until it finds a CLASS_DEF node.
* @param aAST the start node for searching
* @return the CLASS_DEF node.
*/
private DetailAST findContainingClass(DetailAST aAST)
{
DetailAST searchAST = aAST;
while ((searchAST.getType() != TokenTypes.CLASS_DEF)
&& (searchAST.getType() != TokenTypes.ENUM_DEF))
{
searchAST = searchAST.getParent();
}
return searchAST;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/FinalClassCheck.java 100644 0 0 13535 12026051042 30430 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.design;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks that class which has only private ctors
* is declared as final.
*
*
* An example of how to configure the check is:
*
*
* <module name="FinalClass"/>
*
* @author o_sukhodolsky
*/
public class FinalClassCheck
extends Check
{
/** Keeps ClassDesc objects for stack of declared classes. */
private final FastStack mClasses = FastStack.newInstance();
@Override
public int[] getDefaultTokens()
{
return new int[]{TokenTypes.CLASS_DEF, TokenTypes.CTOR_DEF};
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST modifiers = aAST.findFirstToken(TokenTypes.MODIFIERS);
if (aAST.getType() == TokenTypes.CLASS_DEF) {
final boolean isFinal = (modifiers != null)
&& modifiers.branchContains(TokenTypes.FINAL);
final boolean isAbstract = (modifiers != null)
&& modifiers.branchContains(TokenTypes.ABSTRACT);
mClasses.push(new ClassDesc(isFinal, isAbstract));
}
else if (!ScopeUtils.inEnumBlock(aAST)) { //ctors in enums don't matter
final ClassDesc desc = mClasses.peek();
if ((modifiers != null)
&& modifiers.branchContains(TokenTypes.LITERAL_PRIVATE))
{
desc.reportPrivateCtor();
}
else {
desc.reportNonPrivateCtor();
}
}
}
@Override
public void leaveToken(DetailAST aAST)
{
if (aAST.getType() != TokenTypes.CLASS_DEF) {
return;
}
final ClassDesc desc = mClasses.pop();
if (!desc.isDeclaredAsFinal()
&& !desc.isDeclaredAsAbstract()
&& desc.hasPrivateCtor()
&& !desc.hasNonPrivateCtor())
{
final String className =
aAST.findFirstToken(TokenTypes.IDENT).getText();
log(aAST.getLineNo(), "final.class", className);
}
}
/** maintains information about class' ctors */
private static final class ClassDesc
{
/** is class declared as final */
private final boolean mDeclaredAsFinal;
/** is class declared as abstract */
private final boolean mDeclaredAsAbstract;
/** does class have non-provate ctors */
private boolean mHasNonPrivateCtor;
/** does class have private ctors */
private boolean mHasPrivateCtor;
/**
* create a new ClassDesc instance.
* @param aDeclaredAsFinal indicates if the
* class declared as final
* @param aDeclaredAsAbstract indicates if the
* class declared as abstract
*/
ClassDesc(boolean aDeclaredAsFinal, boolean aDeclaredAsAbstract)
{
mDeclaredAsFinal = aDeclaredAsFinal;
mDeclaredAsAbstract = aDeclaredAsAbstract;
}
/** adds private ctor. */
void reportPrivateCtor()
{
mHasPrivateCtor = true;
}
/** adds non-private ctor. */
void reportNonPrivateCtor()
{
mHasNonPrivateCtor = true;
}
/**
* does class have private ctors.
* @return true if class has private ctors
*/
boolean hasPrivateCtor()
{
return mHasPrivateCtor;
}
/**
* does class have non-private ctors.
* @return true if class has non-private ctors
*/
boolean hasNonPrivateCtor()
{
return mHasNonPrivateCtor;
}
/**
* is class declared as final.
* @return true if class is declared as final
*/
boolean isDeclaredAsFinal()
{
return mDeclaredAsFinal;
}
/**
* is class declared as abstract.
* @return true if class is declared as final
*/
boolean isDeclaredAsAbstract()
{
return mDeclaredAsAbstract;
}
@Override
public String toString()
{
return this.getClass().getName()
+ "["
+ "final=" + mDeclaredAsFinal
+ " abstract=" + mDeclaredAsAbstract
+ " pctor=" + mHasPrivateCtor
+ " ctor=" + mHasNonPrivateCtor
+ "]";
}
}
}
././@LongLink 100644 0 0 162 12026055133 10247 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstructorCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/HideUtilityClassConstruc100644 0 0 12162 12026051042 31472 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.design;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
* Make sure that utility classes (classes that contain only static methods)
* do not have a public constructor.
*
* Rationale: Instantiating utility classes does not make sense.
* A common mistake is forgetting to hide the default constructor.
*
*
* @author lkuehne
*/
public class HideUtilityClassConstructorCheck extends Check
{
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.CLASS_DEF};
}
@Override
public void visitToken(DetailAST aAST)
{
if (isAbstract(aAST)) {
// abstract class could not have private constructor
return;
}
final DetailAST objBlock = aAST.findFirstToken(TokenTypes.OBJBLOCK);
DetailAST child = objBlock.getFirstChild();
final boolean hasStaticModifier = isStatic(aAST);
boolean hasMethodOrField = false;
boolean hasNonStaticMethodOrField = false;
boolean hasNonPrivateStaticMethodOrField = false;
boolean hasDefaultCtor = true;
boolean hasPublicCtor = false;
while (child != null) {
final int type = child.getType();
if (type == TokenTypes.METHOD_DEF
|| type == TokenTypes.VARIABLE_DEF)
{
hasMethodOrField = true;
final DetailAST modifiers =
child.findFirstToken(TokenTypes.MODIFIERS);
final boolean isStatic =
modifiers.branchContains(TokenTypes.LITERAL_STATIC);
final boolean isPrivate =
modifiers.branchContains(TokenTypes.LITERAL_PRIVATE);
if (!isStatic && !isPrivate) {
hasNonStaticMethodOrField = true;
}
if (isStatic && !isPrivate) {
hasNonPrivateStaticMethodOrField = true;
}
}
if (type == TokenTypes.CTOR_DEF) {
hasDefaultCtor = false;
final DetailAST modifiers =
child.findFirstToken(TokenTypes.MODIFIERS);
if (!modifiers.branchContains(TokenTypes.LITERAL_PRIVATE)
&& !modifiers.branchContains(TokenTypes.LITERAL_PROTECTED))
{
// treat package visible as public
// for the purpose of this Check
hasPublicCtor = true;
}
}
child = child.getNextSibling();
}
final boolean hasAccessibleCtor = (hasDefaultCtor || hasPublicCtor);
// figure out if class extends java.lang.object directly
// keep it simple for now and get a 99% solution
// TODO: check for "extends java.lang.Object" and "extends Object"
// consider "import org.omg.CORBA.*"
final boolean extendsJLO = // J.Lo even made it into in our sources :-)
aAST.findFirstToken(TokenTypes.EXTENDS_CLAUSE) == null;
final boolean isUtilClass = extendsJLO && hasMethodOrField
&& !hasNonStaticMethodOrField && hasNonPrivateStaticMethodOrField;
if (isUtilClass && (hasAccessibleCtor && !hasStaticModifier)) {
log(aAST.getLineNo(), aAST.getColumnNo(), "hide.utility.class");
}
}
/**
* @param aAST class definition for check.
* @return true if a given class declared as abstract.
*/
private boolean isAbstract(DetailAST aAST)
{
return aAST.findFirstToken(TokenTypes.MODIFIERS)
.branchContains(TokenTypes.ABSTRACT);
}
/**
* @param aAST class definition for check.
* @return true if a given class declared as static.
*/
private boolean isStatic(DetailAST aAST)
{
return aAST.findFirstToken(TokenTypes.MODIFIERS)
.branchContains(TokenTypes.LITERAL_STATIC);
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/InnerTypeLastCheck.java 100644 0 0 5372 12026051041 31131 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.design;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Check nested (internal) classes/interfaces are declared at the bottom of the
* class after all method and field declarations.
*
*
* @author Ruslan Dyachenko
*/
public class InnerTypeLastCheck extends Check
{
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF};
}
/** Meet a root class. */
private boolean mRootClass = true;
@Override
public void visitToken(DetailAST aAST)
{
/** First root class */
if (mRootClass) {
mRootClass = false;
}
else {
DetailAST nextSibling = aAST.getNextSibling();
while (null != nextSibling
&& ((nextSibling.getType() != TokenTypes.CLASS_DEF)
|| (nextSibling.getType() != TokenTypes.INTERFACE_DEF)))
{
if (nextSibling.getType() == TokenTypes.VARIABLE_DEF
|| nextSibling.getType() == TokenTypes.METHOD_DEF)
{
log(nextSibling.getLineNo(), nextSibling.getColumnNo(),
"arrangement.members.before.inner");
}
nextSibling = nextSibling.getNextSibling();
}
}
}
@Override
public void leaveToken(DetailAST aAST)
{
/** Is this a root class */
if (null == aAST.getParent()) {
mRootClass = true;
}
}
}
././@LongLink 100644 0 0 146 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/InterfaceIsTypeCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/InterfaceIsTypeCheck.jav100644 0 0 5740 12026051041 31264 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.design;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
* Implements Bloch, Effective Java, Item 17 -
* Use Interfaces only to define types.
*
*
* An interface should describe a type, it is therefore
* inappropriate to define an interface that does not contain any methods
* but only constants.
*
*
*
* The check can be configured to also disallow marker interfaces like
* java.io.Serializable, that do not contain methods or
* constants at all.
*
*
* @author lkuehne
*/
public final class InterfaceIsTypeCheck
extends Check
{
/** flag to control whether marker interfaces are allowed. */
private boolean mAllowMarkerInterfaces = true;
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.INTERFACE_DEF};
}
@Override
public int[] getRequiredTokens()
{
return getDefaultTokens();
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST objBlock =
aAST.findFirstToken(TokenTypes.OBJBLOCK);
final DetailAST methodDef =
objBlock.findFirstToken(TokenTypes.METHOD_DEF);
final DetailAST variableDef =
objBlock.findFirstToken(TokenTypes.VARIABLE_DEF);
final boolean methodRequired =
!mAllowMarkerInterfaces || (variableDef != null);
if ((methodDef == null) && methodRequired) {
log(aAST.getLineNo(), "interface.type");
}
}
/**
* Controls whether marker interfaces like Serializable are allowed.
* @param aFlag whether to allow marker interfaces or not
*/
public void setAllowMarkerInterfaces(boolean aFlag)
{
mAllowMarkerInterfaces = aFlag;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/messages.properties 100644 0 0 1166 11451071613 30521 0 ustar 0 0 arrangement.members.before.inner=Fields and methods should be before inner classes.
design.forExtension=Method ''{0}'' is not designed for extension - needs to be abstract, final or empty.
final.class=Class {0} should be declared as final.
interface.type=interfaces should describe a type and hence have methods.
variable.notPrivate=Variable ''{0}'' must be private and have accessor methods.
mutable.exception=The field ''{0}'' must be declared final.
throws.count=Throws count is {0,number,integer} (max allowed is {1,number,integer}).
hide.utility.class=Utility classes should not have a public or default constructor.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/messages_de.properties 100644 0 0 1022 11451071613 31160 0 ustar 0 0 design.forExtension=Die Methode ''{0}'' ist nicht für Vererbung entworfen - muss abstract, final oder leer sein.
final.class=Die Klasse {0} sollte als final deklariert sein, da alle ihre Konstruktoren private sind.
interface.type=Interfaces sollten einen Typ beschreiben und darum Methoden beinhalten.
variable.notPrivate=Variable ''{0}'' muss private sein.
mutable.exception=Das Feld ''{0}'' muss final deklariert sein.
throws.count=Anzahl der throws-Anweisungen ist {0,number,integer} (Obergrenze ist {1,number,integer}).
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/messages_es.properties 100644 0 0 755 11451071613 31173 0 ustar 0 0 design.forExtension=El método ''{0}'' no está diseñado para ser extendido - necesita ser abstracto, final o vacío.
final.class=La clase {0} debería declararse final.
interface.type=Los interfaces deberían describir tipos y por tanto tener métodos.
variable.notPrivate=La variable ''{0}'' debe ser privada y tener métodos de acceso.
mutable.exception=El campo ''{0}'' debe declararse final.
throws.count=El número de throws es {0,number,integer} (máximo permitido es {1,number,integer}).
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/messages_fi.properties 100644 0 0 717 11451071613 31160 0 ustar 0 0 design.forExtension=Metodia ''{0}'' ei ole suunniteltu laajennettavaksi - pit¤isi olla abstrakti, final tai tyhj¤.
final.class=Luokan {0} pit¤isi olla final.
interface.type=Rajapintojen pit¤isi kuvata tyyppi¤ ja siten sis¤lt¤¤ metodeja.
variable.notPrivate=Muuttujan ''{0}'' pit¤¤ olla private ja sill¤ pit¤¤ olla accessorimetodit.
throws.count=Heitettyjen poikkeusten lukum¤¤r¤ on {0,number,integer} (suurin sallittu on {1,number,integer}).
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/messages_fr.properties 100644 0 0 1442 11451071613 31205 0 ustar 0 0 design.forExtension=La méthode ''{0}'' n''est pas conçue pour être dérivée - il faut la déclarer abstraite, finale ou la laisser vide.
final.class=La classe {0} devrait être déclarée finale.
interface.type=Les interfaces devraient décrire des types et, à ce titre, comporter des méthodes.
variable.notPrivate=La variable ''{0}'' devrait être privée et avoir des accesseurs.
mutable.exception=L''attribut ''{0}'' devrait être déclarée final.
throws.count=Le nombre de clause \"throws\" {0,number,integer}, alors que le maximum autorisé est de {1,number,integer}.
throws.count=Le nombre de clause \"throws\" est de {0,number,integer}, alors que le maximum autorisé est de {1,number,integer}.
hide.utility.class=Les classes utilitaires ne doivent pas avoir de constructeur par défaut ou public.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/messages_ja.properties 100644 0 0 2031 11451071613 31163 0 ustar 0 0 design.forExtension=\u30e1\u30bd\u30c3\u30c9 ''{0}'' \u306f\u62e1\u5f35\u3059\u308b\u3088\u3046\u306b\u8a2d\u8a08\u3055\u308c\u3066\u3044\u307e\u305b\u3093 - abstract \u304b final \u304b\u7a7a\u3067\u3042\u308b\u5fc5\u8981\u304c\u3042\u308a\u307e\u3059\u3002
final.class=\u30af\u30e9\u30b9 {0} \u306f final \u3068\u3057\u3066\u5ba3\u8a00\u3059\u3079\u304d\u3067\u3059\u3002
interface.type=\u30a4\u30f3\u30bf\u30d5\u30a7\u30fc\u30b9\u306f\u578b\u3092\u8a18\u8ff0\u3059\u308b\u3082\u306e\u3067\u3042\u308a\u3001\u30e1\u30bd\u30c3\u30c9\u3092\u6301\u3064\u3079\u304d\u3067\u3059\u3002
variable.notPrivate=\u5909\u6570 ''{0}'' \u306f private \u3068\u3057\u3001\u30a2\u30af\u30bb\u30c3\u30b5\u30e1\u30bd\u30c3\u30c9\u3092\u6301\u3064\u3079\u304d\u3067\u3059\u3002
mutable.exception=\u30d5\u30a3\u30fc\u30eb\u30c9 ''{0}'' \u306f final \u5ba3\u8a00\u3057\u306a\u3051\u308c\u3070\u306a\u308a\u307e\u305b\u3093\u3002
throws.count=throws \u306e\u6570\u304c {0,number,integer} \uff08\u6700\u5927 {1,number,integer} \u307e\u3067\uff09\u3067\u3059\u3002
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/messages_pt.properties 100644 0 0 755 11451071613 31207 0 ustar 0 0 design.forExtension=O método ''{0}'' no foi concebido para extenso - precisa de ser abstracto, final ou vazio.
final.class=A classe {0} deve ser declarada como final.
interface.type=As interfaces devem descrever um tipo e portanto devem ter métodos.
mutable.exception=O campo ''{0}'' deve ser declarado final.
throws.count=O número de \"throws\" é {0,number,integer} (máx. permitido é {1,number,integer}).
variable.notPrivate=Variável ''{0}'' deve ser privada e ter métodos acessores.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/messages_tr.properties 100644 0 0 2206 11744664014 31232 0 ustar 0 0 #Generated by ResourceBundle Editor (http://eclipse-rbe.sourceforge.net)
arrangement.members.before.inner = Alanlar ve metotlar i\u00E7 s\u0131n\u0131flardan \u00F6nce olmal\u0131.
design.forExtension = ''{0}'' metodu kendinden t\u00FCretmek i\u00E7in tasarlanmad\u0131 - ''abstract'' ya da ''final'' olarak tan\u0131mlanmal\u0131, veya i\u00E7i bo\u015F olmal\u0131.
final.class = {0} s\u0131n\u0131f\u0131 ''final'' olarak tan\u0131mlanmal\u0131.
hide.utility.class = Utility s\u0131n\u0131flar\u0131 (sadece ''static'' metotlar i\u00E7eren s\u0131n\u0131flar) ''public'' ya da varsay\u0131lan bir ''constructor'' i\u00E7ermemelidir.
interface.type = Aray\u00FCzler bir t\u00FCr olarak tan\u0131mlanmal\u0131, dolay\u0131s\u0131yla metotlar\u0131 olmal\u0131.
mutable.exception = ''{0}'' alan\u0131 ''final'' olarak tan\u0131mlanmal\u0131.
throws.count = Kullan\u0131lan ''throws'' say\u0131s\u0131 {0,number,integer} (maksimum izin verilen say\u0131 {1,number,integer}).
variable.notPrivate = ''{0}'' de\u011Fi\u015Fkeni ''private'' olarak tan\u0131mlanmal\u0131 ve eri\u015Fim metotlar\u0131na(getter/setter) sahip olmal\u0131.
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/MutableExceptionCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/MutableExceptionCheck.ja100644 0 0 11266 12026051041 31330 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.design;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck;
/**
*
Ensures that exceptions (defined as any class name conforming
* to some regular expression) are immutable. That is, have only final
* fields.
*
Rationale: Exception instances should represent an error
* condition. Having non final fields not only allows the state to be
* modified by accident and therefore mask the original condition but
* also allows developers to accidentally forget to initialise state
* thereby leading to code catching the exception to draw incorrect
* conclusions based on the state.
*
* @author Simon Harris
*/
public final class MutableExceptionCheck extends AbstractFormatCheck
{
/** Default value for format property. */
private static final String DEFAULT_FORMAT = "^.*Exception$|^.*Error$";
/** Stack of checking information for classes. */
private final FastStack mCheckingStack = FastStack.newInstance();
/** Should we check current class or not. */
private boolean mChecking;
/** Creates new instance of the check. */
public MutableExceptionCheck()
{
super(DEFAULT_FORMAT);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.CLASS_DEF, TokenTypes.VARIABLE_DEF};
}
@Override
public int[] getRequiredTokens()
{
return getDefaultTokens();
}
@Override
public void visitToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.CLASS_DEF:
visitClassDef(aAST);
break;
case TokenTypes.VARIABLE_DEF:
visitVariableDef(aAST);
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
@Override
public void leaveToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.CLASS_DEF:
leaveClassDef();
break;
default:
// Do nothing
}
}
/**
* Called when we start processing class definition.
* @param aAST class definition node
*/
private void visitClassDef(DetailAST aAST)
{
mCheckingStack.push(mChecking ? Boolean.TRUE : Boolean.FALSE);
mChecking =
isExceptionClass(aAST.findFirstToken(TokenTypes.IDENT).getText());
}
/** Called when we leave class definition. */
private void leaveClassDef()
{
mChecking = (mCheckingStack.pop()).booleanValue();
}
/**
* Checks variable definition.
* @param aAST variable def node for check.
*/
private void visitVariableDef(DetailAST aAST)
{
if (mChecking && (aAST.getParent().getType() == TokenTypes.OBJBLOCK)) {
final DetailAST modifiersAST =
aAST.findFirstToken(TokenTypes.MODIFIERS);
if (!(modifiersAST.findFirstToken(TokenTypes.FINAL) != null)) {
log(aAST.getLineNo(), aAST.getColumnNo(), "mutable.exception",
aAST.findFirstToken(TokenTypes.IDENT).getText());
}
}
}
/**
* @param aClassName class name to check
* @return true if a given class name confirms specified format
*/
private boolean isExceptionClass(String aClassName)
{
return getRegexp().matcher(aClassName).find();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/package-info.java 100644 0 0 2305 12026051041 27747 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* Contains the Class Design checks that
* are bundled with the main distribution.
*/
package com.puppycrawl.tools.checkstyle.checks.design;
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/ThrowsCountCheck.java 100644 0 0 6776 12026051041 30700 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.design;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Restricts throws statements to a specified count (default = 1).
*
*
* Rationale:
* Exceptions form part of a methods interface. Declaring
* a method to throw too many differently rooted
* exceptions makes exception handling onerous and leads
* to poor programming practices such as catch
* (Exception). This check forces developers to put
* exceptions into a heirachy such that in the simplest
* case, only one type of exception need be checked for by
* a caller but allows any sub-classes to be caught
* specifically if necessary.
*
* @author Simon Harris
*/
public final class ThrowsCountCheck extends Check
{
/** default value of max property */
private static final int DEFAULT_MAX = 1;
/** maximum allowed throws statments */
private int mMax;
/** Creates new instance of the check. */
public ThrowsCountCheck()
{
setMax(DEFAULT_MAX);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.LITERAL_THROWS,
};
}
@Override
public int[] getRequiredTokens()
{
return getDefaultTokens();
}
/**
* Getter for max property.
* @return maximum allowed throws statements.
*/
public int getMax()
{
return mMax;
}
/**
* Setter for max property.
* @param aMax maximum allowed throws statements.
*/
public void setMax(int aMax)
{
mMax = aMax;
}
@Override
public void visitToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.LITERAL_THROWS:
visitLiteralThrows(aAST);
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
/**
* Checks number of throws statments.
* @param aAST throws for check.
*/
private void visitLiteralThrows(DetailAST aAST)
{
// Account for all the commas!
final int count = (aAST.getChildCount() + 1) / 2;
if (count > getMax()) {
log(aAST.getLineNo(), aAST.getColumnNo(), "throws.count",
count, getMax());
}
}
}
././@LongLink 100644 0 0 151 12026055133 10245 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/VisibilityModifierCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/design/VisibilityModifierCheck.100644 0 0 17122 12026051041 31350 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.design;
import antlr.collections.AST;
import com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
import java.util.Set;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.apache.commons.beanutils.ConversionException;
/**
* Checks visibility of class members. Only static final members may be public,
* other class members must be private unless allowProtected/Package is set.
*
* Public members are not flagged if the name matches the public
* member regular expression (contains "^serialVersionUID$" by
* default).
*
* Rationale: Enforce encapsulation.
*
* @author lkuehne
*/
public class VisibilityModifierCheck
extends Check
{
/** whether protected members are allowed */
private boolean mProtectedAllowed;
/** whether package visible members are allowed */
private boolean mPackageAllowed;
/**
* pattern for public members that should be ignored. Note:
* Earlier versions of checkstyle used ^f[A-Z][a-zA-Z0-9]*$ as the
* default to allow CMP for EJB 1.1 with the default settings.
* With EJB 2.0 it is not longer necessary to have public access
* for persistent fields.
*/
private String mPublicMemberFormat = "^serialVersionUID$";
/** regexp for public members that should be ignored */
private Pattern mPublicMemberPattern;
/** Create an instance. */
public VisibilityModifierCheck()
{
setPublicMemberPattern(mPublicMemberFormat);
}
/** @return whether protected members are allowed */
public boolean isProtectedAllowed()
{
return mProtectedAllowed;
}
/**
* Set whether protected members are allowed.
* @param aProtectedAllowed whether protected members are allowed
*/
public void setProtectedAllowed(boolean aProtectedAllowed)
{
mProtectedAllowed = aProtectedAllowed;
}
/** @return whether package visible members are allowed */
public boolean isPackageAllowed()
{
return mPackageAllowed;
}
/**
* Set whether package visible members are allowed.
* @param aPackageAllowed whether package visible members are allowed
*/
public void setPackageAllowed(boolean aPackageAllowed)
{
mPackageAllowed = aPackageAllowed;
}
/**
* Set the pattern for public members to ignore.
* @param aPattern pattern for public members to ignore.
*/
public void setPublicMemberPattern(String aPattern)
{
try {
mPublicMemberPattern = Utils.getPattern(aPattern);
mPublicMemberFormat = aPattern;
}
catch (final PatternSyntaxException e) {
throw new ConversionException("unable to parse " + aPattern, e);
}
}
/**
* @return the regexp for public members to ignore.
*/
private Pattern getPublicMemberRegexp()
{
return mPublicMemberPattern;
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.VARIABLE_DEF};
}
@Override
public void visitToken(DetailAST aAST)
{
if ((aAST.getType() != TokenTypes.VARIABLE_DEF)
|| (aAST.getParent().getType() != TokenTypes.OBJBLOCK))
{
return;
}
final DetailAST varNameAST = getVarNameAST(aAST);
final String varName = varNameAST.getText();
final boolean inInterfaceOrAnnotationBlock =
ScopeUtils.inInterfaceOrAnnotationBlock(aAST);
final Set mods = getModifiers(aAST);
final String declaredScope = getVisibilityScope(mods);
final String variableScope =
inInterfaceOrAnnotationBlock ? "public" : declaredScope;
if (!("private".equals(variableScope)
|| inInterfaceOrAnnotationBlock // implicitly static and final
|| (mods.contains("static") && mods.contains("final"))
|| ("package".equals(variableScope) && isPackageAllowed())
|| ("protected".equals(variableScope) && isProtectedAllowed())
|| ("public".equals(variableScope)
&& getPublicMemberRegexp().matcher(varName).find())))
{
log(varNameAST.getLineNo(), varNameAST.getColumnNo(),
"variable.notPrivate", varName);
}
}
/**
* Returns the variable name in a VARIABLE_DEF AST.
* @param aVariableDefAST an AST where type == VARIABLE_DEF AST.
* @return the variable name in aVariableDefAST
*/
private DetailAST getVarNameAST(DetailAST aVariableDefAST)
{
DetailAST ast = aVariableDefAST.getFirstChild();
while (ast != null) {
final DetailAST nextSibling = ast.getNextSibling();
if (ast.getType() == TokenTypes.TYPE) {
return nextSibling;
}
ast = nextSibling;
}
return null;
}
/**
* Returns the set of modifier Strings for a VARIABLE_DEF AST.
* @param aVariableDefAST AST for a vraiable definition
* @return the set of modifier Strings for variableDefAST
*/
private Set getModifiers(DetailAST aVariableDefAST)
{
final AST modifiersAST = aVariableDefAST.getFirstChild();
if (modifiersAST.getType() != TokenTypes.MODIFIERS) {
throw new IllegalStateException("Strange parse tree");
}
final Set retVal = Sets.newHashSet();
AST modifier = modifiersAST.getFirstChild();
while (modifier != null) {
retVal.add(modifier.getText());
modifier = modifier.getNextSibling();
}
return retVal;
}
/**
* Returns the visibility scope specified with a set of modifiers.
* @param aModifiers the set of modifier Strings
* @return one of "public", "private", "protected", "package"
*/
private String getVisibilityScope(Set aModifiers)
{
final String[] explicitModifiers = {"public", "private", "protected"};
for (final String candidate : explicitModifiers) {
if (aModifiers.contains(candidate)) {
return candidate;
}
}
return "package";
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/duplicates/ChecksumInfo.java 100644 0 0 14034 12026051040 30706 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.duplicates;
import java.util.Arrays;
/**
* Helper class for {@link StrictDuplicateCodeCheck},
* provides block checksum information for a single file.
*
* @author lkuehne
*/
final class ChecksumInfo
{
/**
* Helper value to avoid object allocations in
* {@link #hasChecksumOverlapsWith(ChecksumInfo)}.
*/
private static final int[] NO_LINES = new int[0];
/**
* Holds the checksums from the constructor call,
* except {@link StrictDuplicateCodeCheck#IGNORE}, sorted.
*/
private int[] mSortedChecksums;
/**
* Reverse mapping from {@link #mSortedChecksums} to the checksums
* from the constructor call.
*
* mSortedRelevantChecksums[i] == checksums[mOrigIdx[i]]
*/
private int[] mOrigIdx;
/**
* Creates a new ChecksumInfo.
*
* @param aBlockChecksums the block checksums as caculated by
* the {@link StrictDuplicateCodeCheck}.ChecksumGenerator
*/
ChecksumInfo(int[] aBlockChecksums)
{
final int csLen = aBlockChecksums.length;
final int[] relevant = new int[csLen];
final int[] reverse = new int[csLen];
int count = 0;
for (int j = 0; j < csLen; j++) {
final int checksum = aBlockChecksums[j];
if (checksum != StrictDuplicateCodeCheck.IGNORE) {
reverse[count] = j;
relevant[count++] = checksum;
}
}
mSortedChecksums = new int[count];
mOrigIdx = new int[count];
System.arraycopy(relevant, 0, mSortedChecksums, 0, count);
System.arraycopy(reverse, 0, mOrigIdx, 0, count);
sort();
}
/**
* Sorts the {@link #mSortedChecksums} field and simultaneously
* maintains the {@link mOrigIdx} mapping. The maintainance of the
* reverse mapping is the reason why we don't simply use Arrays.sort() here.
*/
private void sort()
{
// abbreviation for longish field name
final int[] arr = mSortedChecksums;
final int len = arr.length;
// bubblesort will do for now. It's important that the algorithm
// is stable, i.e. it doesn't swap equal values
for (int i = 0; i < len; i++) {
for (int j = i; j > 0 && arr[j] < arr[j - 1]; j--) {
final int k = j - 1;
// swap j and k and maintain mOrigIdx
final int v = arr[j];
arr[j] = arr[k];
arr[k] = v;
final int z = mOrigIdx[j];
mOrigIdx[j] = mOrigIdx[k];
mOrigIdx[k] = z;
}
}
}
/**
* Returns whether the same checksum occurs both in this ChecksumInfo and
* another one,
*
* @param aChecksumInfo the other ChecksumInfo
* @return true iff the same checksum occurs in both ChecksumInfos
*/
boolean hasChecksumOverlapsWith(final ChecksumInfo aChecksumInfo)
{
final int[] jSortedrelevantChecksums =
aChecksumInfo.mSortedChecksums;
final int iLen = mSortedChecksums.length;
final int jLen = jSortedrelevantChecksums.length;
// Both arrays are sorted, so we walk them in parallel,
// increasing the index that points to the smaller value.
// If the values ever become the same we have found an overlap.
int jdx = 0;
int idx = 0;
while (jdx < jLen && idx < iLen) {
final long iSum = mSortedChecksums[idx];
final long jSum = jSortedrelevantChecksums[jdx];
if (iSum < jSum) {
idx += 1;
}
else if (iSum > jSum) {
jdx += 1;
}
else {
// files i and j contain a block with the same checksum
return true;
}
}
return false;
}
/**
* Returns the lines that start a block with a given checksum.
*
* @param aSum the checksum
* @return sorted line indices
*/
int[] findLinesWithChecksum(final int aSum)
{
int idx = Arrays.binarySearch(mSortedChecksums, aSum);
if (idx < 0) {
return NO_LINES;
}
// binary search might have left us in the
// middle of a sequence of identical checksums
// rewind
while (idx > 0 && mSortedChecksums[idx - 1] == aSum) {
idx -= 1;
}
final int start = idx;
// forward
int end = start + 1;
while (end < mSortedChecksums.length
&& mSortedChecksums[end] == mSortedChecksums[end - 1])
{
end += 1;
}
// find original lines through reverse mapping
final int[] ret = new int[end - start];
for (int i = 0; i < ret.length; i++) {
ret[i] = mOrigIdx[start + i];
}
Arrays.sort(ret);
return ret;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/duplicates/messages.properties 100644 0 0 116 11451071613 31357 0 ustar 0 0 duplicates.lines=Found duplicate of {0} lines in {1}, starting from line {2}
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/duplicates/messages_de.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/duplicates/messages_de.properti100644 0 0 105 11451071613 31475 0 ustar 0 0 duplicates.lines={0} gleiche Zeilen in {1}, beginnend bei Zeile {2}
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/duplicates/messages_es.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/duplicates/messages_es.properti100644 0 0 132 11451071613 31514 0 ustar 0 0 duplicates.lines=Se encontraron {0} líneas duplicadas en {1}, comenzando en la línea {2}
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/duplicates/messages_fr.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/duplicates/messages_fr.properti100644 0 0 121 11451071613 31512 0 ustar 0 0 duplicates.lines=Copier-coller de {0} lignes dans {1}, à partir de la ligne {2}
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/duplicates/messages_tr.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/duplicates/messages_tr.properti100644 0 0 326 11744664317 31555 0 ustar 0 0 #Generated by ResourceBundle Editor (http://eclipse-rbe.sourceforge.net)
duplicates.lines = ''{1}'' dosyas\u0131nda {2} numaral\u0131 sat\u0131rdan itibaren {0} sat\u0131r tekrarlanm\u0131\u015F ifade bulundu.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/duplicates/package-info.java 100644 0 0 2165 12026051040 30636 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* Duplicate code detection tools.
*/
package com.puppycrawl.tools.checkstyle.checks.duplicates;
././@LongLink 100644 0 0 156 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/duplicates/StrictDuplicateCodeCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/duplicates/StrictDuplicateCodeC100644 0 0 46355 12026051040 31424 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.duplicates;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.Lists;
import com.google.common.collect.MapMaker;
import com.google.common.collect.Multimap;
import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import com.puppycrawl.tools.checkstyle.api.FileText;
import com.puppycrawl.tools.checkstyle.api.MessageDispatcher;
import com.puppycrawl.tools.checkstyle.api.Utils;
import java.io.File;
import java.io.IOException;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Performs a line-by-line comparison of all code lines and reports
* duplicate code if a sequence of lines differs only in
* indentation. All import statements in Java code are ignored, any
* other line - including javadoc, whitespace lines between methods,
* etc. - is considered (which is why the check is called
* strict).
*
* @author Lars Kühne
*/
public final class StrictDuplicateCodeCheck extends AbstractFileSetCheck
{
/**
* A prime that is used o calculate checksums of lines and blocks of lines.
* Important that it's larger than the length of most lines to avoid hash
* collisions.
*
* For a list of primes see
* http://www.utm.edu/research/primes/lists/small/1000.txt
*/
private static final int BIG_PRIME = 317;
/**
* Converts each consecutive block of {@link #mMin} lines of the
* original source lines to a checksum that is checked against
* to find duplicates.
*/
private interface ChecksumGenerator
{
/**
* Convert each block of the original source lines
* to a checksum that is checked against to find duplicates
*
* @param aOriginalLines the original lines as they appear
* in the source file
*
* @return an array of (aOriginalLines.length - mMin + 1) checksums
*/
int[] convertLines(String[] aOriginalLines);
}
/**
* Calculates checksums for text files.
*/
private class TextfileChecksumGenerator implements ChecksumGenerator
{
/** {@inheritDoc} */
public int[] convertLines(String[] aOriginalLines)
{
final int lineCount = aOriginalLines.length;
final long[] checkSums = new long[lineCount];
for (int i = 0; i < lineCount; i++) {
final String line = aOriginalLines[i];
checkSums[i] = calcChecksum(line);
}
final int retLen = Math.max(0, lineCount - mMin + 1);
final int[] ret = new int[retLen];
for (int i = 0; i < retLen; i++) {
int blockChecksum = 0;
boolean onlyEmptyLines = true;
for (int j = 0; j < mMin; j++) {
if (aOriginalLines[i + j].length() > 0) {
onlyEmptyLines = false;
}
final long checksum = checkSums[i + j];
if (checksum == IGNORE) {
blockChecksum = IGNORE;
break;
}
blockChecksum += (j + 1) * BIG_PRIME * checksum;
}
ret[i] = onlyEmptyLines ? IGNORE : blockChecksum;
}
return ret;
}
/**
* Computes a checksum for a a single line of text.
* @param aLine the aLine
* @return checksum
*/
protected int calcChecksum(String aLine)
{
final int hashCode = aLine.hashCode();
if (hashCode == IGNORE) {
return Integer.MAX_VALUE / 2;
}
return hashCode;
}
}
/**
* A TextfileChecksumGenerator that also ignores imports.
*/
private class JavaChecksumGenerator extends TextfileChecksumGenerator
{
// TODO: return IGNORE for lines in the header comment?
// That would require some simple parsing...
// we could also parse the java code using the TreeWalker
// and then ignore everything before the CLASS_DEF...
@Override
protected int calcChecksum(String aLine)
{
// to avoid false alarms it is important that different lines
// result in different checksums.
if (aLine.startsWith("import ")) {
return IGNORE;
}
return super.calcChecksum(aLine);
}
}
/** a jakarta commons log */
private static final Log LOG =
LogFactory.getLog(StrictDuplicateCodeCheck.class);
/** the checksum value to use for lines that should be ignored */
static final int IGNORE = Integer.MIN_VALUE;
/** default value for mMin */
private static final int DEFAULT_MIN_DUPLICATE_LINES = 12;
/** number of lines that have to be idential for reporting duplicates */
private int mMin = DEFAULT_MIN_DUPLICATE_LINES;
/** the basedir to strip off in filenames */
private String mBasedir;
/**
* The checksums of all files that are currently checked.
* Dimension one: file index
* Dimension two: block start line
*/
private int[][] mLineBlockChecksums;
/**
* helper to speed up searching algorithm, holds the checksums from
* {@link #mLineBlockChecksums} except {@link #IGNORE}, sorted.
*/
private ChecksumInfo[] mChecksumInfo;
/** files that are currently checked */
private final List mFiles = Lists.newArrayList();
/**
* A SoftReference cache for the trimmed lines of a file path.
*/
private final Map mTrimmedLineCache =
new MapMaker().softValues().makeMap();
// fields required only for statistics
/** total number of duplicates found */
private int mDuplicates;
/** the charset used to load files. */
private String mCharset;
/** Creates a new instance of this class. */
public StrictDuplicateCodeCheck()
{
}
/**
* Sets the minimum number of lines that must be equivalent
* before the check complains.
*
* @param aMin the number of lines that must be equal before
* triggering a 'duplicate code' message.
*/
public void setMin(int aMin)
{
if (aMin < 1) {
throw new IllegalArgumentException("min must be 1 or higher");
}
mMin = aMin;
}
/** @param aBasedir the base directory to strip off in filenames */
public void setBasedir(String aBasedir)
{
mBasedir = aBasedir;
}
@Override
public void beginProcessing(String aCharset)
{
super.beginProcessing(aCharset);
mCharset = aCharset;
mFiles.clear();
}
@Override
protected void processFiltered(File aFile, List aLines)
{
mFiles.add(aFile);
}
@Override
public void finishProcessing()
{
super.finishProcessing();
final long start = System.currentTimeMillis();
mDuplicates = 0;
mLineBlockChecksums = new int[mFiles.size()][];
mChecksumInfo = new ChecksumInfo[mFiles.size()];
if (LOG.isDebugEnabled()) {
LOG.debug("Reading " + mFiles.size() + " input files");
}
for (int i = 0; i < mFiles.size(); i++) {
final File file = mFiles.get(i);
try {
final String[] lines = getTrimmedLines(file);
final ChecksumGenerator transformer =
findChecksumGenerator(file);
mLineBlockChecksums[i] = transformer.convertLines(lines);
}
catch (final IOException ex) {
LOG.error("Cannot access " + file + " ("
+ ex.getMessage() + "), ignoring", ex);
// TODO: better to throw an exception here?
// it would be best to throw IOException from process(),
// but interface definition doesn't allow that...
mLineBlockChecksums = new int[0][0];
}
}
fillSortedRelevantChecksums();
final long endReading = System.currentTimeMillis();
findDuplicates();
final long endSearching = System.currentTimeMillis();
dumpStats(start, endReading, endSearching);
mLineBlockChecksums = null;
mChecksumInfo = null;
}
/**
* Finds the Checksum generator for a given file.
*
* @param aFile the file to check for duplicates
* @return a generator to use for aFile
*/
private ChecksumGenerator findChecksumGenerator(File aFile)
{
if (aFile.getName().endsWith(".java")) {
return new JavaChecksumGenerator();
}
// TODO: Not sure what to do with binary files such as gifs
return new TextfileChecksumGenerator();
}
/**
* Dump out statistics data on stderr.
* @param aStart start time
* @param aEndReading end time of reading phsical files
* @param aEndSearching end time duplicate analysis
*/
private void dumpStats(long aStart, long aEndReading, long aEndSearching)
{
if (LOG.isDebugEnabled()) {
final long initTime = aEndReading - aStart;
final long workTime = aEndSearching - aEndReading;
LOG.debug("files = " + mFiles.size());
LOG.debug("duplicates = " + mDuplicates);
LOG.debug("Runtime = " + initTime + " + " + workTime);
}
}
/**
* filters and sorts the relevant lines and stores the result
* in sortedRelevantChecksums during the setup phase.
* That data is later used in a binary search to find out
* if it is worth investigating a file for duplicates of a block.
* If the block's checksum does not occur in the other file
* at all, we can skip that file quickly.
*/
private void fillSortedRelevantChecksums()
{
for (int i = 0; i < mLineBlockChecksums.length; i++) {
final int[] checksums = mLineBlockChecksums[i];
mChecksumInfo[i] = new ChecksumInfo(checksums);
}
}
/**
* finds duplicate lines in mFiles,
* using a textsearch algorithm to find reoccuring
* patters in the lineChecksums.
*/
private void findDuplicates()
{
if (LOG.isDebugEnabled()) {
LOG.debug("Analysis phase");
}
// It's been a while since my CS degree, but I think this is
// somewhere near O(LOC^2).
// It may be possible to do this *much* smarter,
// but I don't have the Knuth bible at hand right now :-)
final int len = mFiles.size();
for (int i = 0; i < len; i++) {
final String path = mFiles.get(i).getPath();
getMessageCollector().reset();
final MessageDispatcher dispatcher = getMessageDispatcher();
dispatcher.fireFileStarted(path);
for (int j = 0; j <= i; j++) {
findDuplicatesInFiles(i, j);
}
fireErrors(path);
dispatcher.fireFileFinished(path);
}
}
/**
* Compare two files and search for duplicates.
* @param aI mLineChecksums index of the first file to compare
* @param aJ mLineChecksums index of the seconds file to compare
*/
private void findDuplicatesInFiles(int aI, int aJ)
{
final ChecksumInfo iChecksumInfo = mChecksumInfo[aI];
final ChecksumInfo jChecksumInfo = mChecksumInfo[aJ];
if (!iChecksumInfo.hasChecksumOverlapsWith(jChecksumInfo)) {
return;
}
final int[] iLineBlockChecksums = mLineBlockChecksums[aI];
final int iBlockCount = iLineBlockChecksums.length;
// blocks of duplicate code might be longer than 'min'. We need to
// remember the line combinations where we must ignore identical blocks
// because we have already reported them for an earlier blockIdx.
final Multimap ignorePairs =
ArrayListMultimap.create();
// go through all the blocks in iFile and
// check if the following mMin lines occur in jFile
for (int iLine = 0; iLine < iBlockCount; iLine++) {
final int iSum = iLineBlockChecksums[iLine];
final int[] jLines = jChecksumInfo.findLinesWithChecksum(iSum);
// detailed analysis only if the iLine block occurs in jFile at all
if (jLines.length > 0) {
findDuplicateFromLine(aI, aJ, iLine, jLines, ignorePairs);
}
}
}
/**
* Find and report a duplicate of the code starting from line aILine
* in file aI in the file aJ. The caller has already ensured that
* there are at least mMax duplicate lines, this method mainly analyzes
* how far the block of duplicates extends.
*
* @param aI index of file that contains the candidate code
* @param aJ index of file that is searched for a dup of the candidate
* @param aILine starting line of the candidate in aI
* @param aJLines lines in file aJ that have the same checksum as aILine
* @param aIgnore Bag from iLine to jLines, an entry indicates that
* this line i/j-combination has already been reported as part of another
* viloation
*/
private void findDuplicateFromLine(
final int aI, final int aJ, final int aILine,
final int[] aJLines, final Multimap aIgnore)
{
// Using something more advanced like Boyer-Moore might be a
// good idea...
final int[] iCheckSums = mLineBlockChecksums[aI];
final int[] jCheckSums = mLineBlockChecksums[aJ];
final long checkSum = iCheckSums[aILine];
for (int jLine : aJLines) {
if (aI == aJ && aILine >= jLine) {
continue;
}
if (jCheckSums[jLine] != checkSum) {
continue;
}
final Collection ignoreEntries = aIgnore.get(aILine);
// avoid Integer constructor whenever we can
if (ignoreEntries != null) {
if (ignoreEntries.contains(jLine)) {
continue;
}
}
final int duplicateLines =
verifiyDuplicateLines(aI, aJ, aILine, jLine);
if (duplicateLines >= mMin) {
reportDuplicate(duplicateLines, aILine, mFiles.get(aJ), jLine);
final int extend = duplicateLines - mMin;
for (int i = 0; i < extend; i++) {
final int offset = (i + 1);
aIgnore.put(aILine + offset, jLine + offset);
}
}
}
}
/**
* Verifies the number of lines that are equal.
* Note that block checksums might be equal for blocks that in fact
* are different, so we must check the actual file content again.
*
* @param aI file index i
* @param aJ file index j
* @param aIStartLine start line of potential duplicate code in file i
* @param aJStartLine start line of potential duplicate code in file j
* @return the number of verified equal lines
*/
private int verifiyDuplicateLines(
int aI, int aJ, int aIStartLine, int aJStartLine)
{
final File iFile = mFiles.get(aI);
final File jFile = mFiles.get(aJ);
try {
final String[] iLines = getTrimmedLines(iFile);
final String[] jLines = getTrimmedLines(jFile);
int verified = 0;
int i = aIStartLine;
int j = aJStartLine;
while (i < iLines.length && j < jLines.length
&& iLines[i++].equals(jLines[j++]))
{
verified += 1;
}
return verified;
}
catch (IOException ex) {
LOG.error("Unable to verify potential duplicate for "
+ iFile + " and " + jFile, ex);
return 0;
}
}
/**
* Returns the trimmed lines of a given file.
* Caches the results, so when memory is available
* we try to avoid reading the file repeatedly.
*
* @param aFile the file
* @return the lines in aFile after applying {@link String#trim()}
* @throws IOException if the file content cannot be read
*/
private String[] getTrimmedLines(File aFile) throws IOException
{
final String path = aFile.getPath();
final String[] cachedLines = mTrimmedLineCache.get(path);
if (cachedLines != null) {
return cachedLines;
}
final String charset = mCharset;
final FileText text = new FileText(aFile, charset);
final String[] lines = getTrimmed(text.toLinesArray());
mTrimmedLineCache.put(path, lines);
return lines;
}
/**
* Applies {@link String#trim()} on each String in a given array.
* @param aLines the original Strings
* @return the converted Strings after applying {@link String#trim()}
*/
private String[] getTrimmed(String[] aLines)
{
final String[] ret = new String[aLines.length];
for (int i = 0; i < ret.length; i++) {
ret[i] = aLines[i].trim();
}
return ret;
}
/**
* Dumps out a duplicate report.
* @param aEquivalent number of equivalent lines
* @param aILine location of duplicate code
* within file that is currently checked
* @param aJFile the other file that contains the duplicate
* @param aJLine location of duplicate code within aJFile
*/
private void reportDuplicate(
int aEquivalent, int aILine, File aJFile, int aJLine)
{
final String fileName =
Utils.getStrippedFileName(mBasedir, aJFile.getPath());
log(aILine + 1, "duplicates.lines", aEquivalent, fileName, aJLine + 1);
mDuplicates += 1;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/FileContentsHolder.java 100644 0 0 4507 12026051063 27717 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FileContents;
/**
* Holds the current file contents for global access when configured
* as a TreeWalker sub-module. For example,
* a filter can access the current file contents through this module.
* @author Mike McMahon
* @author Rick Giles
*/
public class FileContentsHolder
extends Check
{
/** The current file contents. */
private static final ThreadLocal FILE_CONTENTS =
new ThreadLocal();
/** @return the current file contents. */
public static FileContents getContents()
{
return FILE_CONTENTS.get();
}
@Override
public int[] getDefaultTokens()
{
return new int[0];
}
@Override
public void beginTree(DetailAST aRootAST)
{
FILE_CONTENTS.set(getFileContents());
}
@Override
public void destroy()
{
// This needs to be called in destroy, rather than finishTree()
// as finishTree() is called before the messages are passed to the
// filters. Without calling remove, there is a memory leak.
FILE_CONTENTS.remove();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/FinalParametersCheck.java 100644 0 0 11273 12026051062 30214 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Check that method/constructor/catch/foreach parameters are final.
* The user can set the token set to METHOD_DEF, CONSTRUCTOR_DEF,
* LITERAL_CATCH, FOR_EACH_CLAUSE or any combination of these token
* types, to control the scope of this check.
* Default scope is both METHOD_DEF and CONSTRUCTOR_DEF.
*
* @author lkuehne
* @author o_sukhodolsky
* @author Michael Studman
*/
public class FinalParametersCheck extends Check
{
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.METHOD_DEF,
TokenTypes.CTOR_DEF,
};
}
@Override
public int[] getAcceptableTokens()
{
return new int[] {
TokenTypes.METHOD_DEF,
TokenTypes.CTOR_DEF,
TokenTypes.LITERAL_CATCH,
TokenTypes.FOR_EACH_CLAUSE,
};
}
@Override
public void visitToken(DetailAST aAST)
{
// don't flag interfaces
final DetailAST container = aAST.getParent().getParent();
if (container.getType() == TokenTypes.INTERFACE_DEF) {
return;
}
if (aAST.getType() == TokenTypes.LITERAL_CATCH) {
visitCatch(aAST);
}
else if (aAST.getType() == TokenTypes.FOR_EACH_CLAUSE) {
visitForEachClause(aAST);
}
else {
visitMethod(aAST);
}
}
/**
* Checks parameters of the method or ctor.
* @param aMethod method or ctor to check.
*/
private void visitMethod(final DetailAST aMethod)
{
// exit on fast lane if there is nothing to check here
if (!aMethod.branchContains(TokenTypes.PARAMETER_DEF)) {
return;
}
// ignore abstract method
final DetailAST modifiers =
aMethod.findFirstToken(TokenTypes.MODIFIERS);
if (modifiers.branchContains(TokenTypes.ABSTRACT)) {
return;
}
// we can now be sure that there is at least one parameter
final DetailAST parameters =
aMethod.findFirstToken(TokenTypes.PARAMETERS);
DetailAST child = parameters.getFirstChild();
while (child != null) {
// childs are PARAMETER_DEF and COMMA
if (child.getType() == TokenTypes.PARAMETER_DEF) {
checkParam(child);
}
child = child.getNextSibling();
}
}
/**
* Checks parameter of the catch block.
* @param aCatch catch block to check.
*/
private void visitCatch(final DetailAST aCatch)
{
checkParam(aCatch.findFirstToken(TokenTypes.PARAMETER_DEF));
}
/**
* Checks parameter of the for each clause.
* @param aForEachClause for each clause to check.
*/
private void visitForEachClause(final DetailAST aForEachClause)
{
checkParam(aForEachClause.findFirstToken(TokenTypes.VARIABLE_DEF));
}
/**
* Checks if the given parameter is final.
* @param aParam parameter to check.
*/
private void checkParam(final DetailAST aParam)
{
if (!aParam.branchContains(TokenTypes.FINAL)) {
final DetailAST paramName = aParam.findFirstToken(TokenTypes.IDENT);
final DetailAST firstNode = CheckUtils.getFirstNode(aParam);
log(firstNode.getLineNo(), firstNode.getColumnNo(),
"final.parameter", paramName.getText());
}
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/header/AbstractHeaderCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/header/AbstractHeaderCheck.java100644 0 0 15074 12026051040 31242 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.header;
import com.google.common.collect.ImmutableList;
import java.io.BufferedInputStream;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.LineNumberReader;
import java.io.Reader;
import java.io.StringReader;
import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;
import java.util.List;
import com.google.common.collect.Lists;
import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.Utils;
import org.apache.commons.beanutils.ConversionException;
/**
* Abstract super class for header checks.
* Provides support for header and headerFile properties.
* @author o_sukhosolsky
*/
public abstract class AbstractHeaderCheck extends AbstractFileSetCheck
{
/** The file that contains the header to check against. */
private String mFilename;
/** Name of a charset to use for loading the header from a file. */
private String mCharset = System.getProperty("file.encoding", "UTF-8");
/** the lines of the header file. */
private final List mHeaderLines = Lists.newArrayList();
/**
* Return the header lines to check against.
* @return the header lines to check against.
*/
protected ImmutableList getHeaderLines()
{
return ImmutableList.copyOf(mHeaderLines);
}
/**
* Set the charset to use for loading the header from a file.
* @param aCharset the charset to use for loading the header from a file
* @throws UnsupportedEncodingException if aCharset is unsupported
*/
public void setCharset(String aCharset) throws UnsupportedEncodingException
{
if (!Charset.isSupported(aCharset)) {
final String message = "unsupported charset: '" + aCharset + "'";
throw new UnsupportedEncodingException(message);
}
mCharset = aCharset;
}
/**
* Set the header file to check against.
* @param aFileName the file that contains the header to check against.
*/
public void setHeaderFile(String aFileName)
{
// Handle empty param
if ((aFileName == null) || (aFileName.trim().length() == 0)) {
return;
}
mFilename = aFileName;
}
/**
* Load the header from a file.
* @throws CheckstyleException if the file cannot be loaded
*/
private void loadHeaderFile() throws CheckstyleException
{
checkHeaderNotInitialized();
Reader headerReader = null;
try {
headerReader = new InputStreamReader(new BufferedInputStream(
new FileInputStream(mFilename)), mCharset);
loadHeader(headerReader);
}
catch (final IOException ex) {
throw new CheckstyleException(
"unable to load header file " + mFilename, ex);
}
finally {
Utils.closeQuietly(headerReader);
}
}
/**
* Called before initializing the header.
* @throws ConversionException if header has already been set
*/
private void checkHeaderNotInitialized()
{
if (!mHeaderLines.isEmpty()) {
throw new ConversionException(
"header has already been set - "
+ "set either header or headerFile, not both");
}
}
/**
* Set the header to check against. Individual lines in the header
* must be separated by '\n' characters.
* @param aHeader header content to check against.
* @throws ConversionException if the header cannot be interpreted
*/
public void setHeader(String aHeader)
{
if ((aHeader == null) || (aHeader.trim().length() == 0)) {
return;
}
checkHeaderNotInitialized();
final String headerExpandedNewLines = aHeader.replaceAll("\\\\n", "\n");
final Reader headerReader = new StringReader(headerExpandedNewLines);
try {
loadHeader(headerReader);
}
catch (final IOException ex) {
throw new ConversionException("unable to load header", ex);
}
finally {
Utils.closeQuietly(headerReader);
}
}
/**
* Load header to check against from a Reader into mHeaderLines.
* @param aHeaderReader delivers the header to check against
* @throws IOException if
*/
private void loadHeader(final Reader aHeaderReader) throws IOException
{
final LineNumberReader lnr = new LineNumberReader(aHeaderReader);
mHeaderLines.clear();
while (true) {
final String l = lnr.readLine();
if (l == null) {
break;
}
mHeaderLines.add(l);
}
postprocessHeaderLines();
}
/**
* Hook method for post processing header lines.
* This implementation does nothing.
*/
protected void postprocessHeaderLines()
{
}
@Override
protected final void finishLocalSetup() throws CheckstyleException
{
if (mFilename != null) {
loadHeaderFile();
}
if (mHeaderLines.isEmpty()) {
throw new CheckstyleException(
"property 'headerFile' is missing or invalid in module "
+ getConfiguration().getName());
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/header/HeaderCheck.java 100644 0 0 6375 12026051037 27550 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.header;
import java.io.File;
import java.util.Arrays;
import java.util.List;
/**
* Checks the header of the source against a fixed header file.
*
* @author Lars Kühne
*/
public class HeaderCheck extends AbstractHeaderCheck
{
/** empty array to avoid instantiations. */
private static final int[] EMPTY_INT_ARRAY = new int[0];
/** the header lines to ignore in the check, sorted. */
private int[] mIgnoreLines = EMPTY_INT_ARRAY;
/**
* @param aLineNo a line number
* @return if aLineNo is one of the ignored header lines.
*/
private boolean isIgnoreLine(int aLineNo)
{
return (Arrays.binarySearch(mIgnoreLines, aLineNo) >= 0);
}
/**
* Checks if a code line matches the required header line.
* @param aLineNumber the line number to check against the header
* @param aLine the line contents
* @return true if and only if the line matches the required header line
*/
protected boolean isMatch(int aLineNumber, String aLine)
{
// skip lines we are meant to ignore
return isIgnoreLine(aLineNumber + 1)
|| getHeaderLines().get(aLineNumber).equals(aLine);
}
/**
* Set the lines numbers to ignore in the header check.
* @param aList comma separated list of line numbers to ignore in header.
*/
public void setIgnoreLines(int[] aList)
{
if ((aList == null) || (aList.length == 0)) {
mIgnoreLines = EMPTY_INT_ARRAY;
return;
}
mIgnoreLines = new int[aList.length];
System.arraycopy(aList, 0, mIgnoreLines, 0, aList.length);
Arrays.sort(mIgnoreLines);
}
@Override
protected void processFiltered(File aFile, List aLines)
{
if (getHeaderLines().size() > aLines.size()) {
log(1, "header.missing");
}
else {
for (int i = 0; i < getHeaderLines().size(); i++) {
if (!isMatch(i, aLines.get(i))) {
log(i + 1, "header.mismatch", getHeaderLines().get(i));
break; // stop checking
}
}
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/header/messages.properties 100644 0 0 203 11451071613 30447 0 ustar 0 0 header.missing=Missing a header - not enough lines in file.
header.mismatch=Line does not match expected header line of ''{0}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/header/messages_de.properties 100644 0 0 212 11451071613 31117 0 ustar 0 0 header.missing=Header fehlt - Datei hat nicht genug Zeilen.
header.mismatch=Zeile entspricht nicht der erwarteten Header-Zeile ''{0}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/header/messages_es.properties 100644 0 0 237 11451071613 31145 0 ustar 0 0 header.missing=Falta una cabecera - no hay líneas suficientes en el fichero.
header.mismatch=La línea no coincide con la línea de cabecera esperada ''{0}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/header/messages_fi.properties 100644 0 0 206 11451071613 31130 0 ustar 0 0 header.missing=Headeri puuttuu - ei riittävästi rivejä tiedostossa.
header.mismatch=Rivi ei ole odotetun ''{0}'' headerin mukainen.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/header/messages_fr.properties 100644 0 0 244 11451071613 31143 0 ustar 0 0 header.missing=En-tête manquante - Le fichier ne contient pas assez de lignes.
header.mismatch=La ligne ne correspond pas à la ligne d''en-tête attendue ''{0}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/header/messages_ja.properties 100644 0 0 467 11451071613 31135 0 ustar 0 0 header.missing=\u30d8\u30c3\u30c0\u304c\u3042\u308a\u307e\u305b\u3093 - \u30d5\u30a1\u30a4\u30eb\u306e\u884c\u6570\u304c\u4e0d\u8db3\u3057\u3066\u3044\u307e\u3059\u3002
header.mismatch=\u884c\u304c\u671f\u5f85\u3055\u308c\u308b\u30d8\u30c3\u30c0\u884c ''{0}'' \u3068\u5408\u81f4\u3057\u307e\u305b\u3093\u3002
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/header/messages_pt.properties 100644 0 0 232 11451071613 31154 0 ustar 0 0 header.mismatch=A linha no condiz com a linha de cabeçalho esperada ''{0}''.
header.missing=Falta o cabeçalho - o ficheiro no tem linhas suficientes.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/header/messages_tr.properties 100644 0 0 411 11744664014 31165 0 ustar 0 0 #Generated by ResourceBundle Editor (http://eclipse-rbe.sourceforge.net)
header.mismatch = Sat\u0131r, beklenen ba\u015Fl\u0131k sat\u0131r\u0131 olan ''{0}'' ile e\u015Fle\u015Fmiyor.
header.missing = Ba\u015Fl\u0131k eksik - dosyada yeterli sat\u0131r yok.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/header/package-info.java 100644 0 0 2143 12026051037 27733 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* File Header checks.
*/
package com.puppycrawl.tools.checkstyle.checks.header;
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/header/RegexpHeaderCheck.java 100644 0 0 12562 12026051037 30736 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.header;
import java.util.Arrays;
import java.io.File;
import java.util.List;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.apache.commons.beanutils.ConversionException;
import com.google.common.collect.Lists;
import com.puppycrawl.tools.checkstyle.api.Utils;
/**
* Checks the header of the source against a header file that contains a
* {@link java.util.regex.Pattern regular expression}
* for each line of the source header.
*
* @author Lars Kühne
* @author o_sukhodolsky
*/
public class RegexpHeaderCheck extends AbstractHeaderCheck
{
/** empty array to avoid instantiations. */
private static final int[] EMPTY_INT_ARRAY = new int[0];
/** the compiled regular expressions */
private final List mHeaderRegexps = Lists.newArrayList();
/** the header lines to repeat (0 or more) in the check, sorted. */
private int[] mMultiLines = EMPTY_INT_ARRAY;
/**
* Set the lines numbers to repeat in the header check.
* @param aList comma separated list of line numbers to repeat in header.
*/
public void setMultiLines(int[] aList)
{
if ((aList == null) || (aList.length == 0)) {
mMultiLines = EMPTY_INT_ARRAY;
return;
}
mMultiLines = new int[aList.length];
System.arraycopy(aList, 0, mMultiLines, 0, aList.length);
Arrays.sort(mMultiLines);
}
@Override
protected void processFiltered(File aFile, List aLines)
{
final int headerSize = getHeaderLines().size();
final int fileSize = aLines.size();
if (headerSize - mMultiLines.length > fileSize) {
log(1, "header.missing");
}
else {
int headerLineNo = 0;
int i;
for (i = 0; (headerLineNo < headerSize) && (i < fileSize); i++) {
final String line = aLines.get(i);
boolean isMatch = isMatch(line, headerLineNo);
while (!isMatch && isMultiLine(headerLineNo)) {
headerLineNo++;
isMatch = (headerLineNo == headerSize)
|| isMatch(line, headerLineNo);
}
if (!isMatch) {
log(i + 1, "header.mismatch", getHeaderLines().get(
headerLineNo));
break; // stop checking
}
if (!isMultiLine(headerLineNo)) {
headerLineNo++;
}
}
if (i == fileSize) {
// if file finished, but we have at least one non-multi-line
// header isn't completed
for (; headerLineNo < headerSize; headerLineNo++) {
if (!isMultiLine(headerLineNo)) {
log(1, "header.missing");
break;
}
}
}
}
}
/**
* Checks if a code line matches the required header line.
* @param aLine the code line
* @param aHeaderLineNo the header line number.
* @return true if and only if the line matches the required header line.
*/
private boolean isMatch(String aLine, int aHeaderLineNo)
{
return mHeaderRegexps.get(aHeaderLineNo).matcher(aLine).find();
}
/**
* @param aLineNo a line number
* @return if aLineNo is one of the repeat header lines.
*/
private boolean isMultiLine(int aLineNo)
{
return (Arrays.binarySearch(mMultiLines, aLineNo + 1) >= 0);
}
@Override
protected void postprocessHeaderLines()
{
final List headerLines = getHeaderLines();
mHeaderRegexps.clear();
for (String line : headerLines) {
try {
// TODO: Not sure if cache in Utils is still necessary
mHeaderRegexps.add(Utils.getPattern(line));
}
catch (final PatternSyntaxException ex) {
throw new ConversionException("line "
+ (mHeaderRegexps.size() + 1)
+ " in header specification"
+ " is not a regular expression");
}
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/AccessResult.java 100644 0 0 2552 12026051037 30260 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.imports;
/**
* Represents the result of an access check.
*
* @author Oliver Burn
*/
enum AccessResult {
/** Represents that access is allowed. */
ALLOWED,
/** Represents that access is disallowed. */
DISALLOWED,
/** Represents that access is unknown. */
UNKNOWN
}
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/AvoidStarImportCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/AvoidStarImportCheck.ja100644 0 0 13202 12026051036 31367 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.imports;
import java.util.List;
import com.google.common.collect.Lists;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Check that finds import statements that use the * notation.
*
*
* Rationale: Importing all classes from a package or static
* members from a class leads to tight coupling between packages
* or classes and might lead to problems when a new version of a
* library introduces name clashes.
*
*
* The optional "excludes" property allows for certain packages like
* java.io or java.net to be exempted from the rule. It also is used to
* allow certain classes like java.lang.Math or java.io.File to be
* excluded in order to support static member imports.
*
* The optional "allowClassImports" when set to true, will allow starred
* class imports but will not affect static member imports.
*
* The optional "allowStaticMemberImports" when set to true will allow
* starred static member imports but will not affect class imports.
*
* @author Oliver Burn
* @author Bill Schneider
* @author Travis Schneeberger
* @version 2.0
*/
public class AvoidStarImportCheck
extends Check
{
/** the packages/classes to exempt from this check. */
private final List mExcludes = Lists.newArrayList();
/** whether to allow all class imports */
private boolean mAllowClassImports;
/** whether to allow all static member imports */
private boolean mAllowStaticMemberImports;
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.IMPORT, TokenTypes.STATIC_IMPORT};
}
/**
* Sets the list of packages or classes to be exempt from the check.
* The excludes can contain a .* or not.
* @param aExcludes a list of package names/fully-qualifies class names
* where star imports are ok
*/
public void setExcludes(String[] aExcludes)
{
mExcludes.clear();
for (final String exclude : aExcludes) {
mExcludes.add(exclude.endsWith(".*") ? exclude : exclude + ".*");
}
}
/**
* Sets whether or not to allow all non-static class imports.
* @param aAllow true to allow false to disallow
*/
public void setAllowClassImports(boolean aAllow)
{
mAllowClassImports = aAllow;
}
/**
* Sets whether or not to allow all static member imports.
* @param aAllow true to allow false to disallow
*/
public void setAllowStaticMemberImports(boolean aAllow)
{
mAllowStaticMemberImports = aAllow;
}
@Override
public void visitToken(final DetailAST aAST)
{
if (!mAllowClassImports && (TokenTypes.IMPORT == aAST.getType())) {
final DetailAST startingDot = aAST.getFirstChild();
logsStarredImportViolation(startingDot);
}
else if (!mAllowStaticMemberImports
&& (TokenTypes.STATIC_IMPORT == aAST.getType()))
{
// must navigate past the static keyword
final DetailAST startingDot = aAST.getFirstChild().getNextSibling();
logsStarredImportViolation(startingDot);
}
}
/**
* Gets the full import identifier. If the import is a starred import and
* it's not excluded then a violation is logged.
* @param aStartingDot the starting dot for the import statement
*/
private void logsStarredImportViolation(DetailAST aStartingDot)
{
final FullIdent name = FullIdent.createFullIdent(aStartingDot);
if (isStaredImport(name) && !mExcludes.contains(name.getText())) {
log(aStartingDot.getLineNo(), "import.avoidStar", name.getText());
}
}
/**
* Checks is an import is a stared import.
* @param aImportIdent the full import identifier
* @return true if a start import false if not
*/
private boolean isStaredImport(FullIdent aImportIdent)
{
return (null != aImportIdent) && aImportIdent.getText().endsWith(".*");
}
}
././@LongLink 100644 0 0 151 12026055133 10245 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/AvoidStaticImportCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/AvoidStaticImportCheck.100644 0 0 11261 12026051036 31375 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.imports;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Check that finds static imports.
*
*
* Rationale: Importing static members can lead to naming conflicts
* between class' members. It may lead to poor code readability since it
* may no longer be clear what class a member resides (without looking
* at the import statement).
*
*
* The optional "excludes" property allows for certain classes via a star
* notation to be excluded such as java.lang.Math.* or specific
* static members to be excluded like java.lang.System.out for a variable
* or java.lang.Math.random for a method.
*
*
* If you exclude a starred import on a class this automatically
* excludes each member individually.
*
*
*
* For example:
* Excluding java.lang.Math.* will allow the import of
* each static member in the Math class individually like
* java.lang.Math.PI
*
* @author Travis Schneeberger
* @version 1.0
*/
public class AvoidStaticImportCheck
extends Check
{
/** the classes/static members to exempt from this check. */
private String[] mExcludes = new String[0];
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.STATIC_IMPORT};
}
/**
* Sets the list of classes or static members to be exempt from the check.
* @param aExcludes a list of fully-qualified class names/specific
* static members where static imports are ok
*/
public void setExcludes(String[] aExcludes)
{
mExcludes = aExcludes.clone();
}
@Override
public void visitToken(final DetailAST aAST)
{
final DetailAST startingDot =
aAST.getFirstChild().getNextSibling();
final FullIdent name = FullIdent.createFullIdent(startingDot);
if ((null != name) && !isExempt(name.getText())) {
log(startingDot.getLineNo(), "import.avoidStatic", name.getText());
}
}
/**
* Checks if a class or static member is exempt from known excludes.
*
* @param aClassOrStaticMember
* the class or static member
* @return true if except false if not
*/
private boolean isExempt(String aClassOrStaticMember)
{
for (String exclude : mExcludes) {
if (aClassOrStaticMember.equals(exclude)) {
return true;
}
else if (exclude.endsWith(".*")) {
//this section allows explicit imports
//to be exempt when configured using
//a starred import
final String excludeMinusDotStar =
exclude.substring(0, exclude.length() - 2);
if (aClassOrStaticMember.startsWith(excludeMinusDotStar)) {
final String member =
aClassOrStaticMember.substring(
excludeMinusDotStar.length() + 1);
//if it contains a dot then it is not a member but a package
if (member.indexOf('.') == -1) {
return true;
}
}
}
}
return false;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/Guard.java 100644 0 0 12335 12026051036 26741 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.imports;
/**
* Represents whether a package is allowed to be used or not.
* @author Oliver Burn
*/
class Guard
{
/** Indicates if allow access or not. */
private final boolean mAllowed;
/** Package to control access to. */
private final String mPkgName;
/** Package to control access to. */
private final String mClassName;
/**
* Indicates if must be an exact match. Only valid if guard using a
* package.
*/
private final boolean mExactMatch;
/** Indicates if the guard only applies to this package. */
private final boolean mLocalOnly;
/**
* Indicates if the package and the class names are to be interpreted
* as regular expressions.
*/
private final boolean mRegExp;
/**
* Constructs an instance.
* @param aAllow whether to allow access.
* @param aLocalOnly whether guard is to be applied locally only
* @param aPkgName the package to apply guard on.
* @param aExactMatch whether the package must match exactly.
* @param aRegExp whether the package is to be interpreted as regular
* expression.
*/
Guard(final boolean aAllow, final boolean aLocalOnly,
final String aPkgName, final boolean aExactMatch, final boolean aRegExp)
{
mAllowed = aAllow;
mLocalOnly = aLocalOnly;
mPkgName = aPkgName;
mRegExp = aRegExp;
mClassName = null;
mExactMatch = aExactMatch;
}
/**
* Constructs an instance.
* @param aAllow whether to allow access.
* @param aLocalOnly whether guard is to be applied locally only
* @param aClassName the class to apply guard on.
* @param aRegExp whether the class is to be interpreted as regular
* expression.
*/
Guard(final boolean aAllow, final boolean aLocalOnly,
final String aClassName, final boolean aRegExp)
{
mAllowed = aAllow;
mLocalOnly = aLocalOnly;
mRegExp = aRegExp;
mPkgName = null;
mClassName = aClassName;
mExactMatch = true; // not used.
}
/**
* Verifies whether a package name be used.
* @param aForImport the package to check.
* @return a result {@link AccessResult} indicating whether it can be used.
*/
AccessResult verifyImport(final String aForImport)
{
assert aForImport != null;
if (mClassName != null) {
final boolean classMatch = mRegExp
? aForImport.matches(mClassName)
: aForImport.equals(mClassName);
return calculateResult(classMatch);
}
// Must be checking a package. First check that we actually match
// the package. Then check if matched and we must be an exact match.
// In this case, the text after the first "." must not contain
// another "." as this indicates that it is not an exact match.
assert mPkgName != null;
boolean pkgMatch;
if (mRegExp) {
pkgMatch = aForImport.matches(mPkgName + "\\..*");
if (pkgMatch && mExactMatch) {
pkgMatch = !aForImport.matches(mPkgName + "\\..*\\..*");
}
}
else {
pkgMatch = aForImport.startsWith(mPkgName + ".");
if (pkgMatch && mExactMatch) {
pkgMatch = (aForImport.indexOf('.',
(mPkgName.length() + 1)) == -1);
}
}
return calculateResult(pkgMatch);
}
/**
* @return returns whether the guard is to only be applied locally.
*/
boolean isLocalOnly()
{
return mLocalOnly;
}
/**
* Returns the appropriate {@link AccessResult} based on whether there
* was a match and if the guard is to allow access.
* @param aMatched indicates whether there was a match.
* @return An appropriate {@link AccessResult}.
*/
private AccessResult calculateResult(final boolean aMatched)
{
if (aMatched) {
return mAllowed ? AccessResult.ALLOWED : AccessResult.DISALLOWED;
}
return AccessResult.UNKNOWN;
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/IllegalImportCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/IllegalImportCheck.java100644 0 0 7646 12026051036 31372 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.imports;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks for imports from a set of illegal packages.
* By default, the check rejects all sun.* packages
* since programs that contain direct calls to the sun.* packages
* are
* not 100% Pure Java.
*
*
* To reject other packages, set property illegalPkgs to a comma-separated
* list of the illegal packages.
*
*
* An example of how to configure the check is:
*
*
* <module name="IllegalImport"/>
*
*
* An example of how to configure the check so that it rejects packages
* java.io.* and java.sql.* is
*
* @author Oliver Burn
* @author Lars Kühne
* @version 1.0
*/
public class IllegalImportCheck
extends Check
{
/** list of illegal packages */
private String[] mIllegalPkgs;
/**
* Creates a new IllegalImportCheck instance.
*/
public IllegalImportCheck()
{
setIllegalPkgs(new String[] {"sun"});
}
/**
* Set the list of illegal packages.
* @param aFrom array of illegal packages
*/
public void setIllegalPkgs(String[] aFrom)
{
mIllegalPkgs = aFrom.clone();
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.IMPORT, TokenTypes.STATIC_IMPORT};
}
@Override
public void visitToken(DetailAST aAST)
{
final FullIdent imp;
if (aAST.getType() == TokenTypes.IMPORT) {
imp = FullIdent.createFullIdentBelow(aAST);
}
else {
imp = FullIdent.createFullIdent(
aAST.getFirstChild().getNextSibling());
}
if (isIllegalImport(imp.getText())) {
log(aAST.getLineNo(),
aAST.getColumnNo(),
"import.illegal",
imp.getText());
}
}
/**
* Checks if an import is from a package that must not be used.
* @param aImportText the argument of the import keyword
* @return if aImportText contains an illegal package prefix
*/
private boolean isIllegalImport(String aImportText)
{
for (String element : mIllegalPkgs) {
if (aImportText.startsWith(element + ".")) {
return true;
}
}
return false;
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/ImportControlCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/ImportControlCheck.java100644 0 0 12530 12026051036 31445 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.imports;
import java.io.File;
import java.net.URI;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import org.apache.commons.beanutils.ConversionException;
/**
* Check that controls what packages can be imported in each package. Useful
* for ensuring that application layering is not violated. Ideas on how the
* check can be improved include support for:
*
*
Change the default policy that if a package being checked does not
* match any guards, then it is allowed. Currently defaults to disallowed.
*
*
* @author Oliver Burn
*/
public class ImportControlCheck extends Check
{
/** The root package controller. */
private PkgControl mRoot;
/** The package doing the import. */
private String mInPkg;
/**
* The package controller for the current file. Used for performance
* optimisation.
*/
private PkgControl mCurrentLeaf;
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.PACKAGE_DEF, TokenTypes.IMPORT,
TokenTypes.STATIC_IMPORT, };
}
@Override
public void beginTree(final DetailAST aRootAST)
{
mCurrentLeaf = null;
}
@Override
public void visitToken(final DetailAST aAST)
{
if (aAST.getType() == TokenTypes.PACKAGE_DEF) {
final DetailAST nameAST = aAST.getLastChild().getPreviousSibling();
final FullIdent full = FullIdent.createFullIdent(nameAST);
if (mRoot == null) {
log(nameAST, "import.control.missing.file");
}
else {
mInPkg = full.getText();
mCurrentLeaf = mRoot.locateFinest(mInPkg);
if (mCurrentLeaf == null) {
log(nameAST, "import.control.unknown.pkg");
}
}
}
else if (mCurrentLeaf != null) {
final FullIdent imp;
if (aAST.getType() == TokenTypes.IMPORT) {
imp = FullIdent.createFullIdentBelow(aAST);
}
else {
// know it is a static import
imp = FullIdent.createFullIdent(aAST
.getFirstChild().getNextSibling());
}
final AccessResult access = mCurrentLeaf.checkAccess(imp.getText(),
mInPkg);
if (!AccessResult.ALLOWED.equals(access)) {
log(aAST, "import.control.disallowed", imp.getText());
}
}
}
/**
* Set the parameter for the url containing the import control
* configuration. It will cause the url to be loaded.
* @param aUrl the url of the file to load.
* @throws ConversionException on error loading the file.
*/
public void setUrl(final String aUrl)
{
// Handle empty param
if ((aUrl == null) || (aUrl.trim().length() == 0)) {
return;
}
final URI uri;
try {
uri = URI.create(aUrl);
}
catch (final IllegalArgumentException ex) {
throw new ConversionException("syntax error in url " + aUrl, ex);
}
try {
mRoot = ImportControlLoader.load(uri);
}
catch (final CheckstyleException ex) {
throw new ConversionException("Unable to load " + aUrl, ex);
}
}
/**
* Set the parameter for the file containing the import control
* configuration. It will cause the file to be loaded.
* @param aName the name of the file to load.
* @throws ConversionException on error loading the file.
*/
public void setFile(final String aName)
{
// Handle empty param
if ((aName == null) || (aName.trim().length() == 0)) {
return;
}
try {
mRoot = ImportControlLoader.load(new File(aName).toURI());
}
catch (final CheckstyleException ex) {
throw new ConversionException("Unable to load " + aName, ex);
}
}
}
././@LongLink 100644 0 0 146 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/ImportControlLoader.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/ImportControlLoader.jav100644 0 0 17521 12026051035 31501 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.imports;
import com.puppycrawl.tools.checkstyle.api.AbstractLoader;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URI;
import java.util.HashMap;
import java.util.Map;
import javax.xml.parsers.ParserConfigurationException;
import org.xml.sax.Attributes;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
/**
* Responsible for loading the contents of an import control configuration file.
* @author Oliver Burn
*/
final class ImportControlLoader extends AbstractLoader
{
/** the public ID for the configuration dtd */
private static final String DTD_PUBLIC_ID_1_0 =
"-//Puppy Crawl//DTD Import Control 1.0//EN";
/** the public ID for the configuration dtd */
private static final String DTD_PUBLIC_ID_1_1 =
"-//Puppy Crawl//DTD Import Control 1.1//EN";
/** the resource for the configuration dtd */
private static final String DTD_RESOURCE_NAME_1_0 =
"com/puppycrawl/tools/checkstyle/checks/imports/import_control_1_0.dtd";
/** the resource for the configuration dtd */
private static final String DTD_RESOURCE_NAME_1_1 =
"com/puppycrawl/tools/checkstyle/checks/imports/import_control_1_1.dtd";
/** Used to hold the {@link PkgControl} objects. */
private final FastStack mStack = FastStack.newInstance();
/** the map to lookup the resource name by the id */
private static final Map DTD_RESOURCE_BY_ID =
new HashMap();
/** Initialise the map */
static {
DTD_RESOURCE_BY_ID.put(DTD_PUBLIC_ID_1_0, DTD_RESOURCE_NAME_1_0);
DTD_RESOURCE_BY_ID.put(DTD_PUBLIC_ID_1_1, DTD_RESOURCE_NAME_1_1);
}
/**
* Constructs an instance.
* @throws ParserConfigurationException if an error occurs.
* @throws SAXException if an error occurs.
*/
private ImportControlLoader() throws ParserConfigurationException,
SAXException
{
super(DTD_RESOURCE_BY_ID);
}
@Override
public void startElement(final String aNamespaceURI,
final String aLocalName,
final String aQName,
final Attributes aAtts)
throws SAXException
{
if ("import-control".equals(aQName)) {
final String pkg = safeGet(aAtts, "pkg");
mStack.push(new PkgControl(pkg));
}
else if ("subpackage".equals(aQName)) {
assert mStack.size() > 0;
final String name = safeGet(aAtts, "name");
mStack.push(new PkgControl(mStack.peek(), name));
}
else if ("allow".equals(aQName) || "disallow".equals(aQName)) {
assert mStack.size() > 0;
// Need to handle either "pkg" or "class" attribute.
// May have "exact-match" for "pkg"
// May have "local-only"
final boolean isAllow = "allow".equals(aQName);
final boolean isLocalOnly = (aAtts.getValue("local-only") != null);
final String pkg = aAtts.getValue("pkg");
final boolean regex = (aAtts.getValue("regex") != null);
final Guard g;
if (pkg != null) {
final boolean exactMatch =
(aAtts.getValue("exact-match") != null);
g = new Guard(isAllow, isLocalOnly, pkg, exactMatch, regex);
}
else {
// handle class names which can be normal class names or regular
// expressions
final String clazz = safeGet(aAtts, "class");
g = new Guard(isAllow, isLocalOnly, clazz, regex);
}
final PkgControl pc = mStack.peek();
pc.addGuard(g);
}
}
@Override
public void endElement(final String aNamespaceURI, final String aLocalName,
final String aQName)
{
if ("subpackage".equals(aQName)) {
assert mStack.size() > 1;
mStack.pop();
}
}
/**
* Loads the import control file from a file.
* @param aUri the uri of the file to load.
* @return the root {@link PkgControl} object.
* @throws CheckstyleException if an error occurs.
*/
static PkgControl load(final URI aUri) throws CheckstyleException
{
InputStream is = null;
try {
is = aUri.toURL().openStream();
}
catch (final MalformedURLException e) {
throw new CheckstyleException("syntax error in url " + aUri, e);
}
catch (final IOException e) {
throw new CheckstyleException("unable to find " + aUri, e);
}
final InputSource source = new InputSource(is);
return load(source, aUri);
}
/**
* Loads the import control file from a {@link InputSource}.
* @param aSource the source to load from.
* @param aUri uri of the source being loaded.
* @return the root {@link PkgControl} object.
* @throws CheckstyleException if an error occurs.
*/
private static PkgControl load(final InputSource aSource,
final URI aUri) throws CheckstyleException
{
try {
final ImportControlLoader loader = new ImportControlLoader();
loader.parseInputSource(aSource);
return loader.getRoot();
}
catch (final ParserConfigurationException e) {
throw new CheckstyleException("unable to parse " + aUri, e);
}
catch (final SAXException e) {
throw new CheckstyleException("unable to parse " + aUri
+ " - " + e.getMessage(), e);
}
catch (final IOException e) {
throw new CheckstyleException("unable to read " + aUri, e);
}
}
/**
* @return the root {@link PkgControl} object loaded.
*/
private PkgControl getRoot()
{
assert mStack.size() == 1;
return mStack.peek();
}
/**
* Utility to safely get an attribute. If it does not exist an exception
* is thrown.
* @param aAtts collect to get attribute from.
* @param aName name of the attribute to get.
* @return the value of the attribute.
* @throws SAXException if the attribute does not exist.
*/
private String safeGet(final Attributes aAtts, final String aName)
throws SAXException
{
final String retVal = aAtts.getValue(aName);
if (retVal == null) {
throw new SAXException("missing attibute " + aName);
}
return retVal;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/ImportOrderCheck.java 100644 0 0 32637 12026051035 31111 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.imports;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
*
*
groups imports: ensures that groups of imports come in a specific order
* (e.g., java. comes first, javax. comes second, then everything else)
*
adds a separation between groups : ensures that a blank line sit between
* each group
*
sorts imports inside each group: ensures that imports within each group
* are in lexicographic order
*
sorts according to case: ensures that the comparison between import is
* case sensitive
*
groups static imports: ensures that static imports are at the top (or the
* bottom) of all the imports, or above (or under) each group, or are treated
* like non static imports (@see {@link ImportOrderOption}
* Group descriptions enclosed in slashes are interpreted as regular
* expressions. If multiple groups match, the one matching a longer
* substring of the imported name will take precedence, with ties
* broken first in favor of earlier matches and finally in favor of
* the first matching group.
*
*
*
* There is always a wildcard group to which everything not in a named group
* belongs. If an import does not match a named group, the group belongs to
* this wildcard group. The wildcard group position can be specified using the
* {@code *} character.
*
*
*
* Defaults:
*
*
*
import groups: none
*
separation: false
*
ordered: true
*
case sensitive: true
*
static import: under
*
*
*
* Compatible with Java 1.5 source.
*
*
* @author Bill Schneider
* @author o_sukhodolsky
* @author David DIDIER
* @author Steve McKay
*/
public class ImportOrderCheck
extends AbstractOptionCheck
{
/** the special wildcard that catches all remaining groups. */
private static final String WILDCARD_GROUP_NAME = "*";
/** List of import groups specified by the user. */
private Pattern[] mGroups = new Pattern[0];
/** Require imports in group be separated. */
private boolean mSeparated;
/** Require imports in group. */
private boolean mOrdered = true;
/** Should comparison be case sensitive. */
private boolean mCaseSensitive = true;
/** Last imported group. */
private int mLastGroup;
/** Line number of last import. */
private int mLastImportLine;
/** Name of last import. */
private String mLastImport;
/** If last import was static. */
private boolean mLastImportStatic;
/** Whether there was any imports. */
private boolean mBeforeFirstImport;
/**
* Groups static imports under each group.
*/
public ImportOrderCheck()
{
super(ImportOrderOption.UNDER, ImportOrderOption.class);
}
/**
* Sets the list of package groups and the order they should occur in the
* file.
*
* @param aGroups a comma-separated list of package names/prefixes.
*/
public void setGroups(String[] aGroups)
{
mGroups = new Pattern[aGroups.length];
for (int i = 0; i < aGroups.length; i++) {
String pkg = aGroups[i];
Pattern grp;
// if the pkg name is the wildcard, make it match zero chars
// from any name, so it will always be used as last resort.
if (WILDCARD_GROUP_NAME.equals(pkg)) {
grp = Pattern.compile(""); // matches any package
}
else if (pkg.startsWith("/")) {
if (!pkg.endsWith("/")) {
throw new IllegalArgumentException("Invalid group");
}
pkg = pkg.substring(1, pkg.length() - 1);
grp = Pattern.compile(pkg);
}
else {
if (!pkg.endsWith(".")) {
pkg = pkg + ".";
}
grp = Pattern.compile("^" + Pattern.quote(pkg));
}
mGroups[i] = grp;
}
}
/**
* Sets whether or not imports should be ordered within any one group of
* imports.
*
* @param aOrdered
* whether lexicographic ordering of imports within a group
* required or not.
*/
public void setOrdered(boolean aOrdered)
{
mOrdered = aOrdered;
}
/**
* Sets whether or not groups of imports must be separated from one another
* by at least one blank line.
*
* @param aSeparated
* whether groups should be separated by oen blank line.
*/
public void setSeparated(boolean aSeparated)
{
mSeparated = aSeparated;
}
/**
* Sets whether string comparison should be case sensitive or not.
*
* @param aCaseSensitive
* whether string comparison should be case sensitive.
*/
public void setCaseSensitive(boolean aCaseSensitive)
{
mCaseSensitive = aCaseSensitive;
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.IMPORT, TokenTypes.STATIC_IMPORT};
}
@Override
public void beginTree(DetailAST aRootAST)
{
mLastGroup = Integer.MIN_VALUE;
mLastImportLine = Integer.MIN_VALUE;
mLastImport = "";
mLastImportStatic = false;
mBeforeFirstImport = true;
}
@Override
public void visitToken(DetailAST aAST)
{
final FullIdent ident;
final boolean isStatic;
if (aAST.getType() == TokenTypes.IMPORT) {
ident = FullIdent.createFullIdentBelow(aAST);
isStatic = false;
}
else {
ident = FullIdent.createFullIdent(aAST.getFirstChild()
.getNextSibling());
isStatic = true;
}
switch (getAbstractOption()) {
case TOP:
if (!isStatic && mLastImportStatic) {
mLastGroup = Integer.MIN_VALUE;
mLastImport = "";
}
// no break;
case ABOVE:
// previous non-static but current is static
doVisitToken(ident, isStatic, (!mLastImportStatic && isStatic));
break;
case INFLOW:
// previous argument is useless here
doVisitToken(ident, isStatic, true);
break;
case BOTTOM:
if (isStatic && !mLastImportStatic) {
mLastGroup = Integer.MIN_VALUE;
mLastImport = "";
}
// no break;
case UNDER:
// previous static but current is non-static
doVisitToken(ident, isStatic, (mLastImportStatic && !isStatic));
break;
default:
break;
}
mLastImportLine = aAST.findFirstToken(TokenTypes.SEMI).getLineNo();
mLastImportStatic = isStatic;
mBeforeFirstImport = false;
}
/**
* Shares processing...
*
* @param aIdent the import to process.
* @param aIsStatic whether the token is static or not.
* @param aPrevious previous non-static but current is static (above), or
* previous static but current is non-static (under).
*/
private void doVisitToken(FullIdent aIdent, boolean aIsStatic,
boolean aPrevious)
{
if (aIdent != null) {
final String name = aIdent.getText();
final int groupIdx = getGroupNumber(name);
final int line = aIdent.getLineNo();
if (groupIdx > mLastGroup) {
if (!mBeforeFirstImport && mSeparated) {
// This check should be made more robust to handle
// comments and imports that span more than one line.
if ((line - mLastImportLine) < 2) {
log(line, "import.separation", name);
}
}
}
else if (groupIdx == mLastGroup) {
doVisitTokenInSameGroup(aIdent, aIsStatic, aPrevious, name,
line);
}
else {
log(line, "import.ordering", name);
}
mLastGroup = groupIdx;
mLastImport = name;
}
}
/**
* Shares processing...
*
* @param aIdent the import to process.
* @param aIsStatic whether the token is static or not.
* @param aPrevious previous non-static but current is static (above), or
* previous static but current is non-static (under).
* @param aName the name of the current import.
* @param aLine the line of the current import.
*/
private void doVisitTokenInSameGroup(FullIdent aIdent, boolean aIsStatic,
boolean aPrevious, String aName, int aLine)
{
if (!mOrdered) {
return;
}
if (getAbstractOption().equals(ImportOrderOption.INFLOW)) {
// out of lexicographic order
if (compare(mLastImport, aName, mCaseSensitive) > 0) {
log(aLine, "import.ordering", aName);
}
}
else {
final boolean shouldFireError =
// current and previous static or current and
// previous non-static
(!(mLastImportStatic ^ aIsStatic)
&&
// and out of lexicographic order
(compare(mLastImport, aName, mCaseSensitive) > 0))
||
// previous non-static but current is static (above)
// or
// previous static but current is non-static (under)
aPrevious;
if (shouldFireError) {
log(aLine, "import.ordering", aName);
}
}
}
/**
* Finds out what group the specified import belongs to.
*
* @param aName the import name to find.
* @return group number for given import name.
*/
private int getGroupNumber(String aName)
{
int bestIndex = mGroups.length;
int bestLength = -1;
int bestPos = 0;
// find out what group this belongs in
// loop over mGroups and get index
for (int i = 0; i < mGroups.length; i++) {
final Matcher matcher = mGroups[i].matcher(aName);
while (matcher.find()) {
final int length = matcher.end() - matcher.start();
if ((length > bestLength)
|| ((length == bestLength) && (matcher.start() < bestPos)))
{
bestIndex = i;
bestLength = length;
bestPos = matcher.start();
}
}
}
return bestIndex;
}
/**
* Compares two strings.
*
* @param aString1
* the first string.
* @param aString2
* the second string.
* @param aCaseSensitive
* whether the comparison is case sensitive.
* @return the value 0 if string1 is equal to string2; a value
* less than 0 if string1 is lexicographically less
* than the string2; and a value greater than 0 if
* string1 is lexicographically greater than string2.
*/
private int compare(String aString1, String aString2,
boolean aCaseSensitive)
{
if (aCaseSensitive) {
return aString1.compareTo(aString2);
}
return aString1.compareToIgnoreCase(aString2);
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/ImportOrderOption.java 100644 0 0 6503 12026051035 31315 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.imports;
/**
* Represents the policy for checking import order statements.
* @see com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
* @author David DIDIER
*/
public enum ImportOrderOption
{
/**
* Represents the policy that static imports are all at the top.
* For example:
*
*
*/
BOTTOM;
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/import_control_1_0.dtd 100644 0 0 3720 11451071613 31224 0 ustar 0 0
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/import_control_1_1.dtd 100644 0 0 4111 11451071613 31220 0 ustar 0 0
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/messages.properties 100644 0 0 1342 11451071613 30741 0 ustar 0 0 import.avoidStar=Using the ''.*'' form of import should be avoided - {0}.
import.avoidStatic=Using a static member import should be avoided - {0}.
import.duplicate=Duplicate import to line {0,number,integer} - {1}.
import.illegal=Import from illegal package - {0}.
import.lang=Redundant import from the java.lang package - {0}.
import.same=Redundant import from the same package - {0}.
import.unused=Unused import - {0}.
import.ordering=Wrong order for ''{0}'' import.
import.separation=''{0}'' should be separated from previous imports.
import.control.missing.file=Missing an import control file.
import.control.disallowed=Disallowed import - {0}.
import.control.unknown.pkg=Import control file does not handle this package.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/messages_de.properties 100644 0 0 1015 11451071613 31406 0 ustar 0 0 import.avoidStar=Die Form ''.*'' für import-Anweisungen sollte vermieden werden - {0}.
import.duplicate=Gleiches import wie Zeile line {0,number,integer} - {1}.
import.illegal=Import aus verbotenem Package - {0}.
import.lang=Überflüssiges import aus dem Package java.lang - {0}.
import.same=Überflüssiges import aus demselben Package - {0}.
import.ordering=Falsche Reihenfolge für import von ''{0}''.
import.unused=Nicht benutztes import - {0}.
import.separation=''{0}'' sollte von vorherigen imports abgesetzt sein.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/messages_es.properties 100644 0 0 754 11451071613 31416 0 ustar 0 0 import.avoidStar=Usar la importación con ''.*'' debería evitarse - {0}.
import.duplicate=import duplicado en la línea {0,number,integer} - {1}.
import.illegal=Importación de un paquete ilegal - {0}.
import.lang=Importación redundante del paquete java.lang - {0}.
import.same=Importación redundante del mismo paquete - {0}.
import.unused=import no usado - {0}.
import.ordering=Orden incorrecto para el import ''{0}''.
import.separation=''{0}'' debería separarse de los import previos.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/messages_fi.properties 100644 0 0 545 11451071613 31403 0 ustar 0 0 import.avoidStar=l¤ k¤yt¤ import-muotoa ''.*'' - {0}.
import.duplicate=Duplikaatti-import rivin {0,number,integer} kanssa - {1}.
import.illegal=Import s¤¤ntĥjenvastaisesta paketista - {0}.
import.lang=Tarpeeton import java.lang-paketista - {0}.
import.same=Tarpeeton import samasta paketista - {0}.
import.unused=K¤ytt¤m¤tĥn import - {0}.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/messages_fr.properties 100644 0 0 1052 11451071613 31426 0 ustar 0 0 import.avoidStar=L''utilisation des import.* est prohibé - {0}.
import.duplicate=Import dupliqué à la ligne {0,number,integer} - {1}.
import.illegal=Import d''un package illégal - {0}.
import.lang=Import redondant car la classe importée est située dans le package java.lang - {0}.
import.same=Import redondant car la classe importée est située dans le même package - {0}.
import.unused=Import inutilisé - {0}.
import.ordering=L''ordre d''import n''est pas respecté : ''{0}''.
import.separation=''{0}'' devrait être séparé des imports précédents.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/messages_ja.properties 100644 0 0 2115 11451071613 31412 0 ustar 0 0 import.avoidStar=''.*'' \u5f62\u5f0f\u306e\u30a4\u30f3\u30dd\u30fc\u30c8\u306e\u4f7f\u7528\u306f\u907f\u3051\u308b\u3079\u304d\u3067\u3059 - {0}\u3002
import.duplicate={0,number,integer} \u884c\u76ee\u3068\u91cd\u8907\u3059\u308b\u30a4\u30f3\u30dd\u30fc\u30c8\u3067\u3059 - {1}\u3002
import.illegal=\u4e0d\u6b63\u306a\u30d1\u30c3\u30b1\u30fc\u30b8\u304b\u3089\u306e\u30a4\u30f3\u30dd\u30fc\u30c8\u3067\u3059 - {0}\u3002
import.lang=java.lang \u30d1\u30c3\u30b1\u30fc\u30b8\u304b\u3089\u306e\u30a4\u30f3\u30dd\u30fc\u30c8\u306f\u5197\u9577\u3067\u3059 - {0}\u3002
import.same=\u540c\u4e00\u30d1\u30c3\u30b1\u30fc\u30b8\u304b\u3089\u306e\u30a4\u30f3\u30dd\u30fc\u30c8\u306f\u5197\u9577\u3067\u3059 - {0}\u3002
import.unused=\u4f7f\u7528\u3055\u308c\u306a\u3044\u30a4\u30f3\u30dd\u30fc\u30c8\u3067\u3059 - {0}\u3002
import.ordering=''{0}'' \u306e\u30a4\u30f3\u30dd\u30fc\u30c8\u9806\u5e8f\u304c\u9593\u9055\u3063\u3066\u3044\u307e\u3059\u3002
import.separation=''{0}'' \u306f\u4e0a\u306e\u30a4\u30f3\u30dd\u30fc\u30c8\u6587\u304b\u3089\uff11\u884c\u7a7a\u3051\u308b\u3079\u304d\u3067\u3059\u3002
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/messages_pt.properties 100644 0 0 771 11451071613 31431 0 ustar 0 0 import.avoidStar=A forma de importaço ''.*'' deve ser evitada - {0}.
import.duplicate=Importaço duplicada na linha {0,number,integer}. - {1}.
import.illegal=Importaço de um pacote ilegal - {0}.
import.lang=Importaço redundande do pacote java.lang - {0}.
import.same=Importaço redundante do mesmo pacote - {0}.
import.unused=Importaço no utilizada - {0}.
import.ordering=Ordenaço incorrecta para a importaço ''{0}''.
import.separation=''{0}'' deve ser separado das importaçġes anteriores.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/messages_tr.properties 100644 0 0 2314 11744664014 31456 0 ustar 0 0 #Generated by ResourceBundle Editor (http://eclipse-rbe.sourceforge.net)
import.avoidStar = Y\u0131ld\u0131zl\u0131 (''.*'' \u015Feklinde) import kullan\u0131lmamal\u0131d\u0131r - {0}.
import.avoidStatic = ''static'' bir ifade ''import'' edilmemeli - {0}.
import.control.disallowed = \u0130zin verilmeyen ''import'' kullan\u0131m\u0131 - {0}
import.control.missing.file = ''import'' kontrol dosyas\u0131 eksik.
import.control.unknown.pkg = ''import'' kontrol dosyas\u0131 bu paketi kapsam\u0131yor.
import.duplicate = ''import'' ifadesi {0,number,integer} sat\u0131r\u0131nda tekrarlanm\u0131\u015F - {1}.
import.illegal = Ge\u00E7ersiz paketten ''import'' yap\u0131lm\u0131\u015F - {0}.
import.lang = ''java.lang'' paketinden gereksiz ''import'' yap\u0131lm\u0131\u015F - {0}.
import.ordering = ''{0}'' ''import'' ifadesinin s\u0131ras\u0131 hatal\u0131.
import.same = Ayn\u0131 paketten gereksiz ''import'' yap\u0131lm\u0131\u015F - ''{0}''.
import.separation = ''{0}'' ifadesi kendinden \u00F6nceki ''import'' ifadelerinden ayr\u0131lmal\u0131.
import.unused = Kullan\u0131lmayan import - {0}.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/package-info.java 100644 0 0 2301 12026051034 30171 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* Contains the Imports checks that are
* bundled with the main distribution.
*/
package com.puppycrawl.tools.checkstyle.checks.imports;
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/PkgControl.java 100644 0 0 12551 12026051035 27760 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.imports;
import com.google.common.collect.Lists;
import java.util.LinkedList;
import java.util.List;
/**
* Represents the a tree of guards for controlling whether packages are allowed
* to be used. Each instance must have a single parent or be the root node.
* Each instance may have zero or more children.
*
* @author Oliver Burn
*/
class PkgControl
{
/** List of {@link Guard} objects to check. */
private final LinkedList mGuards = Lists.newLinkedList();
/** List of children {@link PkgControl} objects. */
private final List mChildren = Lists.newArrayList();
/** The parent. Null indicates we are the root node. */
private final PkgControl mParent;
/** The full package name for the node. */
private final String mFullPackage;
/**
* Construct a root node.
* @param aPkgName the name of the package.
*/
PkgControl(final String aPkgName)
{
assert aPkgName != null;
mParent = null;
mFullPackage = aPkgName;
}
/**
* Construct a child node.
* @param aParent the parent node.
* @param aSubPkg the sub package name.
*/
PkgControl(final PkgControl aParent, final String aSubPkg)
{
assert aParent != null;
assert aSubPkg != null;
mParent = aParent;
mFullPackage = aParent.getFullPackage() + "." + aSubPkg;
mParent.mChildren.add(this);
}
/**
* Adds a guard to the node.
* @param aThug the guard to be added.
*/
void addGuard(final Guard aThug)
{
mGuards.addFirst(aThug);
}
/**
* @return the full package name represented by the node.
*/
String getFullPackage()
{
return mFullPackage;
}
/**
* Search down the tree to locate the finest match for a supplied package.
* @param aForPkg the package to search for.
* @return the finest match, or null if no match at all.
*/
PkgControl locateFinest(final String aForPkg)
{
// Check if we are a match.
// This algormithm should be improved to check for a trailing "."
// or nothing following.
if (!aForPkg.startsWith(getFullPackage())) {
return null;
}
// Check if any of the children match.
for (PkgControl pc : mChildren) {
final PkgControl match = pc.locateFinest(aForPkg);
if (match != null) {
return match;
}
}
// No match so I am the best there is.
return this;
}
/**
* Returns whether a package is allowed to be used. The algorithm checks
* with the current node for a result, and if none is found then calls
* its parent looking for a match. This will recurse looking for match.
* If there is no clear result then {@link AccessResult#UNKNOWN} is
* returned.
* @param aForImport the package to check on.
* @param aInPkg the package doing the import.
* @return an {@link AccessResult}.
*/
AccessResult checkAccess(final String aForImport, final String aInPkg)
{
final AccessResult retVal = localCheckAccess(aForImport, aInPkg);
if (retVal != AccessResult.UNKNOWN) {
return retVal;
}
else if (mParent == null) {
// we are the top, so default to not allowed.
return AccessResult.DISALLOWED;
}
return mParent.checkAccess(aForImport, aInPkg);
}
/**
* Checks whether any of the guards for this node control access to
* a specified package.
* @param aForImport the package to check.
* @param aInPkg the package doing the import.
* @return an {@link AccessResult}.
*/
private AccessResult localCheckAccess(final String aForImport,
final String aInPkg)
{
for (Guard g : mGuards) {
// Check if a Guard is only meant to be applied locally.
if (g.isLocalOnly() && !mFullPackage.equals(aInPkg)) {
continue;
}
final AccessResult result = g.verifyImport(aForImport);
if (result != AccessResult.UNKNOWN) {
return result;
}
}
return AccessResult.UNKNOWN;
}
}
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/RedundantImportCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/RedundantImportCheck.ja100644 0 0 12226 12026051035 31423 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.imports;
import com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.util.Set;
/**
*
* Checks for imports that are redundant. An import statement is
* considered redundant if:
*
*
*
It is a duplicate of another import. This is, when a class is imported
* more than once.
*
The class non-statically imported is from the java.lang
* package. For example importing java.lang.String.
*
The class non-statically imported is from the same package as the
* current package.
*
*
* An example of how to configure the check is:
*
*
* <module name="RedundantImport"/>
*
*
* Compatible with Java 1.5 source.
*
* @author Oliver Burn
* @version 1.0
*/
public class RedundantImportCheck
extends Check
{
/** name of package in file */
private String mPkgName;
/** set of the imports */
private final Set mImports = Sets.newHashSet();
/** set of static imports */
private final Set mStaticImports = Sets.newHashSet();
@Override
public void beginTree(DetailAST aRootAST)
{
mPkgName = null;
mImports.clear();
mStaticImports.clear();
}
@Override
public int[] getDefaultTokens()
{
return new int[]
{TokenTypes.IMPORT,
TokenTypes.STATIC_IMPORT,
TokenTypes.PACKAGE_DEF, };
}
@Override
public void visitToken(DetailAST aAST)
{
if (aAST.getType() == TokenTypes.PACKAGE_DEF) {
mPkgName = FullIdent.createFullIdent(
aAST.getLastChild().getPreviousSibling()).getText();
}
else if (aAST.getType() == TokenTypes.IMPORT) {
final FullIdent imp = FullIdent.createFullIdentBelow(aAST);
if (fromPackage(imp.getText(), "java.lang")) {
log(aAST.getLineNo(), aAST.getColumnNo(), "import.lang",
imp.getText());
}
else if (fromPackage(imp.getText(), mPkgName)) {
log(aAST.getLineNo(), aAST.getColumnNo(), "import.same",
imp.getText());
}
// Check for a duplicate import
for (FullIdent full : mImports) {
if (imp.getText().equals(full.getText())) {
log(aAST.getLineNo(), aAST.getColumnNo(),
"import.duplicate", full.getLineNo(),
imp.getText());
}
}
mImports.add(imp);
}
else {
// Check for a duplicate static import
final FullIdent imp =
FullIdent.createFullIdent(
aAST.getLastChild().getPreviousSibling());
for (FullIdent full : mStaticImports) {
if (imp.getText().equals(full.getText())) {
log(aAST.getLineNo(), aAST.getColumnNo(),
"import.duplicate", full.getLineNo(), imp.getText());
}
}
mStaticImports.add(imp);
}
}
/**
* Determines if an import statement is for types from a specified package.
* @param aImport the import name
* @param aPkg the package name
* @return whether from the package
*/
private static boolean fromPackage(String aImport, String aPkg)
{
boolean retVal = false;
if (aPkg == null) {
// If not package, then check for no package in the import.
retVal = (aImport.indexOf('.') == -1);
}
else {
final int index = aImport.lastIndexOf('.');
if (index != -1) {
final String front = aImport.substring(0, index);
retVal = front.equals(aPkg);
}
}
return retVal;
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/UnusedImportsCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/imports/UnusedImportsCheck.java100644 0 0 15726 12026051034 31463 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.imports;
import com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTags;
import com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FileContents;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TextBlock;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
import com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag;
import com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocUtils;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
*
* Checks for unused import statements.
*
*
* An example of how to configure the check is:
*
*
* <module name="UnusedImports"/>
*
*
* Compatible with Java 1.5 source.
*
* @author Oliver Burn
*/
public class UnusedImportsCheck extends Check
{
/** flag to indicate when time to start collecting references */
private boolean mCollect;
/** flag whether to process Javadoc comments. */
private boolean mProcessJavadoc;
/** set of the imports */
private final Set mImports = Sets.newHashSet();
/** set of references - possibly to imports or other things */
private final Set mReferenced = Sets.newHashSet();
/** Default constructor. */
public UnusedImportsCheck()
{
}
public void setProcessJavadoc(boolean aValue)
{
mProcessJavadoc = aValue;
}
@Override
public void beginTree(DetailAST aRootAST)
{
mCollect = false;
mImports.clear();
mReferenced.clear();
}
@Override
public void finishTree(DetailAST aRootAST)
{
// loop over all the imports to see if referenced.
for (final FullIdent imp : mImports) {
if (!mReferenced.contains(Utils.baseClassname(imp.getText()))) {
log(imp.getLineNo(),
imp.getColumnNo(),
"import.unused", imp.getText());
}
}
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.IDENT,
TokenTypes.IMPORT,
TokenTypes.STATIC_IMPORT,
// Definitions that may contain Javadoc...
TokenTypes.PACKAGE_DEF,
TokenTypes.ANNOTATION_DEF,
TokenTypes.ANNOTATION_FIELD_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.ENUM_CONSTANT_DEF,
TokenTypes.CLASS_DEF,
TokenTypes.INTERFACE_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.CTOR_DEF,
TokenTypes.VARIABLE_DEF,
};
}
@Override
public int[] getRequiredTokens()
{
return getDefaultTokens();
}
@Override
public void visitToken(DetailAST aAST)
{
if (aAST.getType() == TokenTypes.IDENT) {
if (mCollect) {
processIdent(aAST);
}
}
else if (aAST.getType() == TokenTypes.IMPORT) {
processImport(aAST);
}
else if (aAST.getType() == TokenTypes.STATIC_IMPORT) {
processStaticImport(aAST);
}
else {
mCollect = true;
if (mProcessJavadoc) {
processJavadoc(aAST);
}
}
}
/**
* Collects references made by IDENT.
* @param aAST the IDENT node to process
*/
private void processIdent(DetailAST aAST)
{
final DetailAST parent = aAST.getParent();
final int parentType = parent.getType();
if (((parentType != TokenTypes.DOT)
&& (parentType != TokenTypes.METHOD_DEF))
|| ((parentType == TokenTypes.DOT)
&& (aAST.getNextSibling() != null)))
{
mReferenced.add(aAST.getText());
}
}
/**
* Collects the details of imports.
* @param aAST node containing the import details
*/
private void processImport(DetailAST aAST)
{
final FullIdent name = FullIdent.createFullIdentBelow(aAST);
if ((name != null) && !name.getText().endsWith(".*")) {
mImports.add(name);
}
}
/**
* Collects the details of static imports.
* @param aAST node containing the static import details
*/
private void processStaticImport(DetailAST aAST)
{
final FullIdent name =
FullIdent.createFullIdent(
aAST.getFirstChild().getNextSibling());
if ((name != null) && !name.getText().endsWith(".*")) {
mImports.add(name);
}
}
/**
* Collects references made in JavaDoc comments.
* @param aAST node to inspect for JavaDoc
*/
private void processJavadoc(DetailAST aAST)
{
final FileContents contents = getFileContents();
final int lineNo = aAST.getLineNo();
final TextBlock cmt = contents.getJavadocBefore(lineNo);
if (cmt != null) {
final JavadocTags tags = JavadocUtils.getJavadocTags(cmt,
JavadocUtils.JavadocTagType.ALL);
for (final JavadocTag tag : tags.getValidTags()) {
if (tag.canReferenceImports()) {
String identifier = tag.getArg1();
// Trim off method or link text
final Pattern pattern =
Utils.getPattern("(.+?)(?:\\s+|#|\\$).*");
final Matcher matcher = pattern.matcher(identifier);
if (matcher.find()) {
identifier = matcher.group(1);
}
mReferenced.add(identifier);
}
}
}
}
}
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/ArrayInitHandler.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/ArrayInitHandler.ja100644 0 0 11111 12026051034 31354 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for array initialization blocks.
*
* @author jrichard
*/
public class ArrayInitHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public ArrayInitHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "array initialization", aAst, aParent);
}
@Override
protected IndentLevel getLevelImpl()
{
final DetailAST parentAST = getMainAst().getParent();
final int type = parentAST.getType();
if ((type == TokenTypes.LITERAL_NEW) || (type == TokenTypes.ASSIGN)) {
// note: assumes new or assignment is line to align with
return new IndentLevel(getLineStart(parentAST));
}
else if (getParent() instanceof ArrayInitHandler) {
return ((ArrayInitHandler) getParent()).getChildrenExpectedLevel();
}
else {
return getParent().getLevel();
}
}
@Override
protected DetailAST getToplevelAST()
{
return null;
}
@Override
protected DetailAST getLCurly()
{
return getMainAst();
}
@Override
protected DetailAST getRCurly()
{
return getMainAst().findFirstToken(TokenTypes.RCURLY);
}
@Override
protected boolean rcurlyMustStart()
{
return false;
}
@Override
protected boolean childrenMayNest()
{
return true;
}
@Override
protected DetailAST getListChild()
{
return getMainAst();
}
@Override
protected IndentLevel getChildrenExpectedLevel()
{
// now we accept
// new int[] {1,
// 2};
// and
// new int[] {1, 2,
// 3};
final IndentLevel expectedIndent = super.getChildrenExpectedLevel();
final int firstLine = getFirstLine(Integer.MAX_VALUE, getListChild());
if (hasCurlys() && (firstLine == getLCurly().getLineNo())) {
final int lcurlyPos = expandedTabsColumnNo(getLCurly());
final int firstChildPos =
getNextFirstNonblankOnLineAfter(firstLine, lcurlyPos);
if (firstChildPos >= 0) {
expectedIndent.addAcceptedIndent(firstChildPos);
}
}
return expectedIndent;
}
/**
* @param aLineNo number of line on which we search
* @param aColumnNo number of column after which we search
*
* @return column number of first non-blank char after
* specified column on specified line or -1 if
* such char doesn't exist.
*/
private int getNextFirstNonblankOnLineAfter(int aLineNo, int aColumnNo)
{
int columnNo = aColumnNo + 1;
final String line = getIndentCheck().getLines()[aLineNo - 1];
final int lineLength = line.length();
while ((columnNo < lineLength)
&& Character.isWhitespace(line.charAt(columnNo)))
{
columnNo++;
}
return (columnNo == lineLength) ? -1 : columnNo;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/AssignHandler.java 100644 0 0 6761 12026051034 31224 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for assignements.
*
* @author o_sukhodolsky
*/
public class AssignHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public AssignHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "assign", aAst, aParent);
}
@Override
public void checkIndentation()
{
final IndentLevel expectedLevel = getChildrenExpectedLevel();
// check indentation of assign if it starts line
final DetailAST assign = getMainAst();
if (startsLine(assign)
&& !expectedLevel.accept(expandedTabsColumnNo(assign)))
{
logError(assign, "" , expandedTabsColumnNo(assign), expectedLevel);
}
// check indentation of rvalue
DetailAST child = assign.getFirstChild();
// if this is assign in expression then skip first child,
// because it's lvalue.
final DetailAST parent = assign.getParent();
if ((parent != null) && (parent.getType() == TokenTypes.EXPR)) {
child = child.getNextSibling();
}
if ((parent != null)
&& (parent.getType() == TokenTypes.ANNOTATION_MEMBER_VALUE_PAIR))
{
child = assign.getNextSibling();
}
checkExpressionSubtree(child, expectedLevel, false, true);
}
@Override
protected boolean shouldIncreaseIndent()
{
return false;
}
@Override
public IndentLevel suggestedChildLevel(ExpressionHandler aChild)
{
final DetailAST assign = getMainAst();
final DetailAST child = aChild.getMainAst();
if (child == assign.getFirstChild()) {
// left side of assignment should have the same
// indentation as "assignment"
return getLevel();
}
if (startsLine(assign)) {
return new IndentLevel(expandedTabsColumnNo(assign));
}
return super.suggestedChildLevel(aChild);
}
}
././@LongLink 100644 0 0 151 12026055133 10245 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/BlockParentHandler.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/BlockParentHandler.100644 0 0 24054 12026051033 31354 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for parents of blocks ('if', 'else', 'while', etc).
*
* The "block" handler classes use a common superclass BlockParentHandler,
* employing the Template Method pattern.
*
*
*
template method to get the lcurly
*
template method to get the rcurly
*
if curlys aren't present, then template method to get expressions
* is called
*
now all the repetitous code which checks for BOL, if curlys are on
* same line, etc. can be collapsed into the superclass
*
*
* @author jrichard
*/
public class BlockParentHandler extends ExpressionHandler
{
/**
* Children checked by parent handlers.
*/
private static final int[] CHECKED_CHILDREN = new int[] {
TokenTypes.VARIABLE_DEF,
TokenTypes.EXPR,
TokenTypes.OBJBLOCK,
TokenTypes.LITERAL_BREAK,
TokenTypes.LITERAL_RETURN,
TokenTypes.LITERAL_THROW,
TokenTypes.LITERAL_CONTINUE,
};
/**
* Returns array of token types which should be checked among childrens.
* @return array of token types to check.
*/
protected int[] getCheckedChildren()
{
return CHECKED_CHILDREN;
}
/**
* Construct an instance of this handler with the given indentation check,
* name, abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aName the name of the handler
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public BlockParentHandler(IndentationCheck aIndentCheck,
String aName, DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, aName, aAst, aParent);
}
/**
* Get the top level expression being managed by this handler.
*
* @return the top level expression
*/
protected DetailAST getToplevelAST()
{
return getMainAst();
}
/**
* Check the indent of the top level token.
*/
protected void checkToplevelToken()
{
final DetailAST toplevel = getToplevelAST();
if ((toplevel == null)
|| getLevel().accept(expandedTabsColumnNo(toplevel)))
{
return;
}
if (!toplevelMustStartLine() && !startsLine(toplevel)) {
return;
}
logError(toplevel, "", expandedTabsColumnNo(toplevel));
}
/**
* Determines if the top level token must start the line.
*
* @return true
*/
protected boolean toplevelMustStartLine()
{
return true;
}
/**
* Determines if this block expression has curly braces.
*
* @return true if curly braces are present, false otherwise
*/
protected boolean hasCurlys()
{
return (getLCurly() != null) && (getRCurly() != null);
}
/**
* Get the left curly brace portion of the expression we are handling.
*
* @return the left curly brace expression
*/
protected DetailAST getLCurly()
{
return getMainAst().findFirstToken(TokenTypes.SLIST);
}
/**
* Get the right curly brace portion of the expression we are handling.
*
* @return the right curly brace expression
*/
protected DetailAST getRCurly()
{
final DetailAST slist = getMainAst().findFirstToken(TokenTypes.SLIST);
if (slist == null) {
return null;
}
return slist.findFirstToken(TokenTypes.RCURLY);
}
/**
* Check the indentation of the left curly brace.
*/
protected void checkLCurly()
{
// the lcurly can either be at the correct indentation, or nested
// with a previous expression
final DetailAST lcurly = getLCurly();
final int lcurlyPos = expandedTabsColumnNo(lcurly);
if ((lcurly == null)
|| curlyLevel().accept(lcurlyPos)
|| !startsLine(lcurly))
{
return;
}
logError(lcurly, "lcurly", lcurlyPos);
}
/**
* Get the expected indentation level for the curly braces.
*
* @return the curly brace indentation level
*/
private IndentLevel curlyLevel()
{
return new IndentLevel(getLevel(), getBraceAdjustement());
}
/**
* Determines if the right curly brace must be at the start of the line.
*
* @return true
*/
protected boolean rcurlyMustStart()
{
return true;
}
/**
* Determines if child elements within the expression may be nested.
*
* @return false
*/
protected boolean childrenMayNest()
{
return false;
}
/**
* Check the indentation of the right curly brace.
*/
protected void checkRCurly()
{
// the rcurly can either be at the correct indentation, or
// on the same line as the lcurly
final DetailAST lcurly = getLCurly();
final DetailAST rcurly = getRCurly();
final int rcurlyPos = expandedTabsColumnNo(rcurly);
if ((rcurly == null)
|| curlyLevel().accept(rcurlyPos)
|| (!rcurlyMustStart() && !startsLine(rcurly))
|| areOnSameLine(rcurly, lcurly))
{
return;
}
logError(rcurly, "rcurly", rcurlyPos, curlyLevel());
}
/**
* Get the child element that is not a list of statements.
*
* @return the non-list child element
*/
protected DetailAST getNonlistChild()
{
return getMainAst().findFirstToken(
TokenTypes.RPAREN).getNextSibling();
}
/**
* Check the indentation level of a child that is not a list of statements.
*/
private void checkNonlistChild()
{
// TODO: look for SEMI and check for it here?
final DetailAST nonlist = getNonlistChild();
if (nonlist == null) {
return;
}
final IndentLevel expected =
new IndentLevel(getLevel(), getBasicOffset());
checkExpressionSubtree(nonlist, expected, false, false);
}
/**
* Get the child element representing the list of statements.
*
* @return the statement list child
*/
protected DetailAST getListChild()
{
return getMainAst().findFirstToken(TokenTypes.SLIST);
}
/**
* Get the right parenthesis portion of the expression we are handling.
*
* @return the right parenthis expression
*/
protected DetailAST getRParen()
{
return getMainAst().findFirstToken(TokenTypes.RPAREN);
}
/**
* Get the left parenthesis portion of the expression we are handling.
*
* @return the left parenthis expression
*/
protected DetailAST getLParen()
{
return getMainAst().findFirstToken(TokenTypes.LPAREN);
}
@Override
public void checkIndentation()
{
checkToplevelToken();
// seperate to allow for eventual configuration
checkLParen(getLParen());
checkRParen(getLParen(), getRParen());
if (hasCurlys()) {
checkLCurly();
checkRCurly();
}
final DetailAST listChild = getListChild();
if (listChild != null) {
// NOTE: switch statements usually don't have curlys
if (!hasCurlys() || !areOnSameLine(getLCurly(), getRCurly())) {
checkChildren(listChild,
getCheckedChildren(),
getChildrenExpectedLevel(),
true,
childrenMayNest());
}
}
else {
checkNonlistChild();
}
}
/**
* @return indentation level expected for children
*/
protected IndentLevel getChildrenExpectedLevel()
{
// if we have multileveled expected level then we should
// try to suggest single level to children using curlies'
// levels.
if (getLevel().isMultiLevel() && hasCurlys()
&& !areOnSameLine(getLCurly(), getRCurly()))
{
if (startsLine(getLCurly())) {
return new IndentLevel(expandedTabsColumnNo(getLCurly())
+ getBasicOffset());
}
else if (startsLine(getRCurly())) {
return new IndentLevel(expandedTabsColumnNo(getRCurly())
+ getBasicOffset());
}
}
return new IndentLevel(getLevel(), getBasicOffset());
}
@Override
public IndentLevel suggestedChildLevel(ExpressionHandler aChild)
{
return getChildrenExpectedLevel();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/CaseHandler.java 100644 0 0 5107 12026051033 30643 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for case statements.
*
* @author jrichard
*/
public class CaseHandler extends ExpressionHandler
{
/**
* The child elements of a case expression.
*/
private final int[] mCaseChildren = new int[] {
TokenTypes.LITERAL_CASE,
TokenTypes.LITERAL_DEFAULT,
};
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aExpr the abstract syntax tree
* @param aParent the parent handler
*/
public CaseHandler(IndentationCheck aIndentCheck,
DetailAST aExpr, ExpressionHandler aParent)
{
super(aIndentCheck, "case", aExpr, aParent);
}
@Override
protected IndentLevel getLevelImpl()
{
return new IndentLevel(getParent().getLevel(),
getIndentCheck().getCaseIndent());
}
/**
* Check the indentation of the case statement.
*/
private void checkCase()
{
checkChildren(getMainAst(), mCaseChildren, getLevel(), true, false);
}
@Override
public IndentLevel suggestedChildLevel(ExpressionHandler aChild)
{
return getLevel();
}
@Override
public void checkIndentation()
{
checkCase();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/CatchHandler.java 100644 0 0 4476 12026051033 31022 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for catch blocks.
*
* @author jrichard
*/
public class CatchHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public CatchHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "catch", aAst, aParent);
}
@Override
protected boolean toplevelMustStartLine()
{
return false;
}
/**
* Check the indentation level of the conditional expression.
*/
private void checkCondExpr()
{
final DetailAST condAst = getMainAst().findFirstToken(TokenTypes.LPAREN)
.getNextSibling();
checkExpressionSubtree(condAst, getLevel(), false, false);
}
@Override
public void checkIndentation()
{
super.checkIndentation();
checkCondExpr();
}
}
././@LongLink 100644 0 0 146 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/ClassDefHandler.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/ClassDefHandler.jav100644 0 0 10407 12026051033 31332 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for class definitions.
*
* @author jrichard
*/
public class ClassDefHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public ClassDefHandler(IndentationCheck aIndentCheck,
DetailAST aAst,
ExpressionHandler aParent)
{
super(aIndentCheck,
(aAst.getType() == TokenTypes.CLASS_DEF)
? "class def" : ((aAst.getType() == TokenTypes.ENUM_DEF)
? "enum def" : "interface def"),
aAst, aParent);
}
@Override
protected DetailAST getLCurly()
{
return getMainAst().findFirstToken(TokenTypes.OBJBLOCK)
.findFirstToken(TokenTypes.LCURLY);
}
@Override
protected DetailAST getRCurly()
{
return getMainAst().findFirstToken(TokenTypes.OBJBLOCK)
.findFirstToken(TokenTypes.RCURLY);
}
@Override
protected DetailAST getToplevelAST()
{
return null;
// note: ident checked by hand in check indentation;
}
@Override
protected DetailAST getListChild()
{
return getMainAst().findFirstToken(TokenTypes.OBJBLOCK);
}
@Override
public void checkIndentation()
{
// TODO: still need to better deal with the modifiers and "class"
checkModifiers();
final LineSet lines = new LineSet();
// checks that line with class name starts at correct indentation,
// and following lines (in implements and extends clauses) are
// indented at least one level
final DetailAST ident = getMainAst().findFirstToken(TokenTypes.IDENT);
final int lineStart = getLineStart(ident);
if (!getLevel().accept(lineStart)) {
logError(ident, "ident", lineStart);
}
lines.addLineAndCol(ident.getLineNo(), lineStart);
final DetailAST impl = getMainAst().findFirstToken(
TokenTypes.IMPLEMENTS_CLAUSE);
if ((impl != null) && (impl.getFirstChild() != null)) {
findSubtreeLines(lines, impl, false);
}
final DetailAST ext =
getMainAst().findFirstToken(TokenTypes.EXTENDS_CLAUSE);
if ((ext != null) && (ext.getFirstChild() != null)) {
findSubtreeLines(lines, ext, false);
}
checkLinesIndent(ident.getLineNo(), lines.lastLine(), getLevel());
super.checkIndentation();
}
@Override
protected int[] getCheckedChildren()
{
return new int[] {
TokenTypes.EXPR,
TokenTypes.OBJBLOCK,
TokenTypes.LITERAL_BREAK,
TokenTypes.LITERAL_RETURN,
TokenTypes.LITERAL_THROW,
TokenTypes.LITERAL_CONTINUE,
};
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/DoWhileHandler.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/DoWhileHandler.java100644 0 0 4464 12026051033 31330 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for do...while blocks.
*
* @author jrichard
*/
public class DoWhileHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public DoWhileHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "do..while", aAst, aParent);
}
/**
* Check the indentation level of the conditional expression.
*/
private void checkCondExpr()
{
final DetailAST condAst = getMainAst()
.findFirstToken(TokenTypes.LPAREN).getNextSibling();
checkExpressionSubtree(condAst, getLevel(), false, false);
}
@Override
public void checkIndentation()
{
super.checkIndentation();
// TODO: checkWhile(); // while is not in the grammar, why not?
checkCondExpr();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/ElseHandler.java 100644 0 0 5167 12026051032 30665 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for else blocks.
*
* @author jrichard
*/
public class ElseHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public ElseHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "else", aAst, aParent);
}
@Override
protected void checkToplevelToken()
{
// check if else is nested with rcurly of if:
//
// } else ...
final DetailAST ifAST = getMainAst().getParent();
if (ifAST != null) {
final DetailAST slist = ifAST.findFirstToken(TokenTypes.SLIST);
if (slist != null) {
final DetailAST lcurly = slist.getLastChild();
if ((lcurly != null)
&& (lcurly.getLineNo() == getMainAst().getLineNo()))
{
// indentation checked as part of LITERAL IF check
return;
}
}
}
super.checkToplevelToken();
}
@Override
protected DetailAST getNonlistChild()
{
return getMainAst().getFirstChild();
}
}
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/ExpressionHandler.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/ExpressionHandler.j100644 0 0 53401 12026051032 31456 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
import java.util.Arrays;
/**
* Abstract base class for all handlers.
*
* @author jrichard
*/
public abstract class ExpressionHandler
{
/**
* The instance of IndentationCheck using this handler.
*/
private final IndentationCheck mIndentCheck;
/** the AST which is handled by this handler */
private final DetailAST mMainAst;
/** name used during output to user */
private final String mTypeName;
/** containing AST handler */
private final ExpressionHandler mParent;
/** indentation amount for this handler */
private IndentLevel mLevel;
/**
* Construct an instance of this handler with the given indentation check,
* name, abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aTypeName the name of the handler
* @param aExpr the abstract syntax tree
* @param aParent the parent handler
*/
public ExpressionHandler(IndentationCheck aIndentCheck,
String aTypeName, DetailAST aExpr, ExpressionHandler aParent)
{
mIndentCheck = aIndentCheck;
mTypeName = aTypeName;
mMainAst = aExpr;
mParent = aParent;
}
/**
* Get the indentation amount for this handler. For performance reasons,
* this value is cached. The first time this method is called, the
* indentation amount is computed and stored. On further calls, the stored
* value is returned.
*
* @return the expected indentation amount
*/
public final IndentLevel getLevel()
{
if (mLevel == null) {
mLevel = getLevelImpl();
}
return mLevel;
}
/**
* Compute the indentation amount for this handler.
*
* @return the expected indentation amount
*/
protected IndentLevel getLevelImpl()
{
return mParent.suggestedChildLevel(this);
}
/**
* Indentation level suggested for a child element. Children don't have
* to respect this, but most do.
*
* @param aChild child AST (so suggestion level can differ based on child
* type)
*
* @return suggested indentation for child
*/
public IndentLevel suggestedChildLevel(ExpressionHandler aChild)
{
return new IndentLevel(getLevel(), getBasicOffset());
}
/**
* Log an indentation error.
*
* @param aAst the expression that caused the error
* @param aSubtypeName the type of the expression
* @param aActualLevel the actual indent level of the expression
*/
protected final void logError(DetailAST aAst, String aSubtypeName,
int aActualLevel)
{
logError(aAst, aSubtypeName, aActualLevel, getLevel());
}
/**
* Log an indentation error.
*
* @param aAst the expression that caused the error
* @param aSubtypeName the type of the expression
* @param aActualLevel the actual indent level of the expression
* @param aExpectedLevel the expected indent level of the expression
*/
protected final void logError(DetailAST aAst, String aSubtypeName,
int aActualLevel, IndentLevel aExpectedLevel)
{
final String typeStr =
("".equals(aSubtypeName) ? "" : (" " + aSubtypeName));
mIndentCheck.indentationLog(aAst.getLineNo(), "indentation.error",
mTypeName + typeStr, aActualLevel, aExpectedLevel);
}
/**
* Log child indentation error.
*
* @param aLine the expression that caused the error
* @param aActualLevel the actual indent level of the expression
* @param aExpectedLevel the expected indent level of the expression
*/
private void logChildError(int aLine,
int aActualLevel,
IndentLevel aExpectedLevel)
{
mIndentCheck.indentationLog(aLine, "indentation.child.error",
mTypeName, aActualLevel, aExpectedLevel);
}
/**
* Determines if the given expression is at the start of a line.
*
* @param aAst the expression to check
*
* @return true if it is, false otherwise
*/
protected final boolean startsLine(DetailAST aAst)
{
return getLineStart(aAst) == expandedTabsColumnNo(aAst);
}
/**
* Determines if two expressions are on the same line.
*
* @param aAst1 the first expression
* @param aAst2 the second expression
*
* @return true if they are, false otherwise
*/
static boolean areOnSameLine(DetailAST aAst1, DetailAST aAst2)
{
return (aAst1 != null) && (aAst2 != null)
&& (aAst1.getLineNo() == aAst2.getLineNo());
}
/**
* Searchs in given sub-tree (including given node) for the token
* which represents first symbol for this sub-tree in file.
* @param aAST a root of sub-tree in which the search shoul be performed.
* @return a token which occurs first in the file.
*/
static DetailAST getFirstToken(DetailAST aAST)
{
DetailAST first = aAST;
DetailAST child = aAST.getFirstChild();
while (child != null) {
final DetailAST toTest = getFirstToken(child);
if ((toTest.getLineNo() < first.getLineNo())
|| ((toTest.getLineNo() == first.getLineNo())
&& (toTest.getColumnNo() < first.getColumnNo())))
{
first = toTest;
}
child = child.getNextSibling();
}
return first;
}
/**
* Get the start of the line for the given expression.
*
* @param aAst the expression to find the start of the line for
*
* @return the start of the line for the given expression
*/
protected final int getLineStart(DetailAST aAst)
{
final String line = mIndentCheck.getLines()[aAst.getLineNo() - 1];
return getLineStart(line);
}
// TODO: this whole checking of consecuitive/expression line indents is
// smelling pretty bad... and is in serious need of pruning. But, I
// want to finish the invalid tests before I start messing around with
// it.
/**
* Check the indentation of consecutive lines for the expression we are
* handling.
*
* @param aStartLine the first line to check
* @param aEndLine the last line to check
* @param aIndentLevel the required indent level
*/
protected final void checkLinesIndent(int aStartLine, int aEndLine,
IndentLevel aIndentLevel)
{
// check first line
checkSingleLine(aStartLine, aIndentLevel);
// check following lines
final IndentLevel offsetLevel =
new IndentLevel(aIndentLevel, getBasicOffset());
for (int i = aStartLine + 1; i <= aEndLine; i++) {
checkSingleLine(i, offsetLevel);
}
}
/**
* @return true if indentation should be increased after
* fisrt line in checkLinesIndent()
* false otherwise
*/
protected boolean shouldIncreaseIndent()
{
return true;
}
/**
* Check the indentation for a set of lines.
*
* @param aLines the set of lines to check
* @param aIndentLevel the indentation level
* @param aFirstLineMatches whether or not the first line has to match
* @param aFirstLine firstline of whole expression
*/
private void checkLinesIndent(LineSet aLines,
IndentLevel aIndentLevel,
boolean aFirstLineMatches,
int aFirstLine)
{
if (aLines.isEmpty()) {
return;
}
// check first line
final int startLine = aLines.firstLine();
final int endLine = aLines.lastLine();
final int startCol = aLines.firstLineCol();
final int realStartCol =
getLineStart(mIndentCheck.getLines()[startLine - 1]);
if (realStartCol == startCol) {
checkSingleLine(startLine, startCol, aIndentLevel,
aFirstLineMatches);
}
// if first line starts the line, following lines are indented
// one level; but if the first line of this expression is
// nested with the previous expression (which is assumed if it
// doesn't start the line) then don't indent more, the first
// indentation is absorbed by the nesting
// TODO: shouldIncreaseIndent() is a hack, should be removed
// after complete rewriting of checkExpressionSubtree()
IndentLevel theLevel = aIndentLevel;
if (aFirstLineMatches
|| ((aFirstLine > mMainAst.getLineNo()) && shouldIncreaseIndent()))
{
theLevel = new IndentLevel(aIndentLevel, getBasicOffset());
}
// check following lines
for (int i = startLine + 1; i <= endLine; i++) {
final Integer col = aLines.getStartColumn(i);
// startCol could be null if this line didn't have an
// expression that was required to be checked (it could be
// checked by a child expression)
if (col != null) {
checkSingleLine(i, col.intValue(), theLevel, false);
}
}
}
/**
* Check the indent level for a single line.
*
* @param aLineNum the line number to check
* @param aIndentLevel the required indent level
*/
private void checkSingleLine(int aLineNum, IndentLevel aIndentLevel)
{
final String line = mIndentCheck.getLines()[aLineNum - 1];
final int start = getLineStart(line);
if (aIndentLevel.gt(start)) {
logChildError(aLineNum, start, aIndentLevel);
}
}
/**
* Check the indentation for a single line.
*
* @param aLineNum the number of the line to check
* @param aColNum the column number we are starting at
* @param aIndentLevel the indentation level
* @param aMustMatch whether or not the indentation level must match
*/
private void checkSingleLine(int aLineNum, int aColNum,
IndentLevel aIndentLevel, boolean aMustMatch)
{
final String line = mIndentCheck.getLines()[aLineNum - 1];
final int start = getLineStart(line);
// if must match is set, it is an error if the line start is not
// at the correct indention level; otherwise, it is an only an
// error if this statement starts the line and it is less than
// the correct indentation level
if (aMustMatch ? !aIndentLevel.accept(start)
: (aColNum == start) && aIndentLevel.gt(start))
{
logChildError(aLineNum, start, aIndentLevel);
}
}
/**
* Get the start of the specified line.
*
* @param aLine the specified line number
*
* @return the start of the specified line
*/
protected final int getLineStart(String aLine)
{
for (int start = 0; start < aLine.length(); start++) {
final char c = aLine.charAt(start);
if (!Character.isWhitespace(c)) {
return Utils.lengthExpandedTabs(
aLine, start, mIndentCheck.getIndentationTabWidth());
}
}
return 0;
}
// TODO: allowNesting either shouldn't be allowed with
// firstLineMatches, or I should change the firstLineMatches logic
// so it doesn't match if the first line is nested
/**
* Check the indent level of the children of the specified parent
* expression.
*
* @param aParent the parent whose children we are checking
* @param aTokenTypes the token types to check
* @param aStartLevel the starting indent level
* @param aFirstLineMatches whether or not the first line needs to match
* @param aAllowNesting whether or not nested children are allowed
*/
protected final void checkChildren(DetailAST aParent,
int[] aTokenTypes,
IndentLevel aStartLevel,
boolean aFirstLineMatches,
boolean aAllowNesting)
{
Arrays.sort(aTokenTypes);
for (DetailAST child = aParent.getFirstChild();
child != null;
child = child.getNextSibling())
{
if (Arrays.binarySearch(aTokenTypes, child.getType()) >= 0) {
checkExpressionSubtree(child, aStartLevel,
aFirstLineMatches, aAllowNesting);
}
}
}
/**
* Check the indentation level for an expression subtree.
*
* @param aTree the expression subtree to check
* @param aLevel the indentation level
* @param aFirstLineMatches whether or not the first line has to match
* @param aAllowNesting whether or not subtree nesting is allowed
*/
protected final void checkExpressionSubtree(
DetailAST aTree,
IndentLevel aLevel,
boolean aFirstLineMatches,
boolean aAllowNesting
)
{
final LineSet subtreeLines = new LineSet();
final int firstLine = getFirstLine(Integer.MAX_VALUE, aTree);
if (aFirstLineMatches && !aAllowNesting) {
subtreeLines.addLineAndCol(firstLine,
getLineStart(mIndentCheck.getLines()[firstLine - 1]));
}
findSubtreeLines(subtreeLines, aTree, aAllowNesting);
checkLinesIndent(subtreeLines, aLevel, aFirstLineMatches, firstLine);
}
/**
* Get the first line for a given expression.
*
* @param aStartLine the line we are starting from
* @param aTree the expression to find the first line for
*
* @return the first line of the expression
*/
protected final int getFirstLine(int aStartLine, DetailAST aTree)
{
// find line for this node
// TODO: getLineNo should probably not return < 0, but it is for
// the interface methods... I should ask about this
int realStart = aStartLine;
final int currLine = aTree.getLineNo();
if (currLine < realStart) {
realStart = currLine;
}
// check children
for (DetailAST node = aTree.getFirstChild();
node != null;
node = node.getNextSibling())
{
realStart = getFirstLine(realStart, node);
}
return realStart;
}
/**
* Get the column number for the start of a given expression, expanding
* tabs out into spaces in the process.
*
* @param aAST the expression to find the start of
*
* @return the column number for the start of the expression
*/
protected final int expandedTabsColumnNo(DetailAST aAST)
{
final String line =
mIndentCheck.getLines()[aAST.getLineNo() - 1];
return Utils.lengthExpandedTabs(line, aAST.getColumnNo(),
mIndentCheck.getIndentationTabWidth());
}
/**
* Find the set of lines for a given subtree.
*
* @param aLines the set of lines to add to
* @param aTree the subtree to examine
* @param aAllowNesting whether or not to allow nested subtrees
*/
protected final void findSubtreeLines(LineSet aLines, DetailAST aTree,
boolean aAllowNesting)
{
// find line for this node
// TODO: getLineNo should probably not return < 0, but it is for
// the interface methods... I should ask about this
if (getIndentCheck().getHandlerFactory().isHandledType(aTree.getType())
|| (aTree.getLineNo() < 0))
{
return;
}
// TODO: the problem with this is that not all tree tokens actually
// have the right column number -- I should get a list of these
// and verify that checking nesting this way won't cause problems
// if (aAllowNesting && aTree.getColumnNo() != getLineStart(aTree)) {
// return;
// }
final int lineNum = aTree.getLineNo();
final Integer colNum = aLines.getStartColumn(lineNum);
final int thisLineColumn = expandedTabsColumnNo(aTree);
if ((colNum == null) || (thisLineColumn < colNum.intValue())) {
aLines.addLineAndCol(lineNum, thisLineColumn);
}
// check children
for (DetailAST node = aTree.getFirstChild();
node != null;
node = node.getNextSibling())
{
findSubtreeLines(aLines, node, aAllowNesting);
}
}
/**
* Check the indentation level of modifiers.
*/
protected final void checkModifiers()
{
final DetailAST modifiers =
mMainAst.findFirstToken(TokenTypes.MODIFIERS);
for (DetailAST modifier = modifiers.getFirstChild();
modifier != null;
modifier = modifier.getNextSibling())
{
/*
if (!areOnSameLine(modifier, prevExpr)) {
continue;
}
*/
if (startsLine(modifier)
&& !getLevel().accept(expandedTabsColumnNo(modifier)))
{
logError(modifier, "modifier",
expandedTabsColumnNo(modifier));
}
}
}
/**
* Check the indentation of the expression we are handling.
*/
public abstract void checkIndentation();
/**
* Accessor for the IndentCheck attribute.
*
* @return the IndentCheck attribute
*/
protected final IndentationCheck getIndentCheck()
{
return mIndentCheck;
}
/**
* Accessor for the MainAst attribute.
*
* @return the MainAst attribute
*/
protected final DetailAST getMainAst()
{
return mMainAst;
}
/**
* Accessor for the Parent attribute.
*
* @return the Parent attribute
*/
protected final ExpressionHandler getParent()
{
return mParent;
}
/**
* A shortcut for IndentationCheck property.
* @return value of basicOffset property of IndentationCheck
*/
protected final int getBasicOffset()
{
return getIndentCheck().getBasicOffset();
}
/**
* A shortcut for IndentationCheck property.
* @return value of braceAdjustment property
* of IndentationCheck
*/
protected final int getBraceAdjustement()
{
return getIndentCheck().getBraceAdjustement();
}
/**
* Check the indentation of the right parenthesis.
* @param aRparen parenthesis to check
* @param aLparen left parenthesis associated with aRparen
*/
protected final void checkRParen(DetailAST aLparen, DetailAST aRparen)
{
// no paren - no check :)
if (aRparen == null) {
return;
}
// the rcurly can either be at the correct indentation,
// or not first on the line ...
final int rparenLevel = expandedTabsColumnNo(aRparen);
if (getLevel().accept(rparenLevel) || !startsLine(aRparen)) {
return;
}
// or has + 1 indentation
final int lparenLevel = expandedTabsColumnNo(aLparen);
if (rparenLevel == (lparenLevel + 1)) {
return;
}
logError(aRparen, "rparen", rparenLevel);
}
/**
* Check the indentation of the left parenthesis.
* @param aLparen parenthesis to check
*/
protected final void checkLParen(final DetailAST aLparen)
{
// the rcurly can either be at the correct indentation, or on the
// same line as the lcurly
if ((aLparen == null)
|| getLevel().accept(expandedTabsColumnNo(aLparen))
|| !startsLine(aLparen))
{
return;
}
logError(aLparen, "lparen", expandedTabsColumnNo(aLparen));
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/FinallyHandler.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/FinallyHandler.java100644 0 0 3521 12026051032 31363 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
* Handler for finally blocks.
*
* @author jrichard
*/
public class FinallyHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public FinallyHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "finally", aAst, aParent);
}
@Override
protected boolean toplevelMustStartLine()
{
return false;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/ForHandler.java 100644 0 0 6166 12026051032 30523 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for for loops.
*
* @author jrichard
*/
public class ForHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public ForHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "for", aAst, aParent);
}
/**
* Check the indentation of the parameters of the 'for' loop.
*/
private void checkForParams()
{
final IndentLevel expected =
new IndentLevel(getLevel(), getBasicOffset());
final DetailAST init = getMainAst().findFirstToken(TokenTypes.FOR_INIT);
if (init != null) {
checkExpressionSubtree(init, expected, false, false);
final DetailAST cond =
getMainAst().findFirstToken(TokenTypes.FOR_CONDITION);
checkExpressionSubtree(cond, expected, false, false);
final DetailAST iter =
getMainAst().findFirstToken(TokenTypes.FOR_ITERATOR);
checkExpressionSubtree(iter, expected, false, false);
}
// for each
else {
final DetailAST forEach =
getMainAst().findFirstToken(TokenTypes.FOR_EACH_CLAUSE);
checkExpressionSubtree(forEach, expected, false, false);
}
}
@Override
public void checkIndentation()
{
checkForParams();
super.checkIndentation();
}
@Override
public IndentLevel suggestedChildLevel(ExpressionHandler aChild)
{
if (aChild instanceof ElseHandler) {
return getLevel();
}
return super.suggestedChildLevel(aChild);
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/HandlerFactory.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/HandlerFactory.java100644 0 0 22600 12026051031 31412 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.google.common.collect.Maps;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.util.Map;
import java.util.Set;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Factory for handlers. Looks up constructor via reflection.
*
* @author jrichard
*/
public class HandlerFactory
{
/** Logger for indentation check */
private static final Log LOG =
LogFactory.getLog("com.puppycrawl.tools.checkstyle.checks.indentation");
/**
* Registered handlers.
*/
private final Map> mTypeHandlers =
Maps.newHashMap();
/**
* registers a handler
*
* @param aType
* type from TokenTypes
* @param aHandlerClass
* the handler to register
*/
private void register(int aType, Class aHandlerClass)
{
try {
final Constructor ctor = aHandlerClass
.getConstructor(new Class[] {IndentationCheck.class,
DetailAST.class, // current AST
ExpressionHandler.class, // parent
});
mTypeHandlers.put(aType, ctor);
}
///CLOVER:OFF
catch (final NoSuchMethodException e) {
throw new RuntimeException("couldn't find ctor for "
+ aHandlerClass);
}
catch (final SecurityException e) {
LOG.debug("couldn't find ctor for " + aHandlerClass, e);
throw new RuntimeException("couldn't find ctor for "
+ aHandlerClass);
}
///CLOVER:ON
}
/** Creates a HandlerFactory. */
public HandlerFactory()
{
register(TokenTypes.CASE_GROUP, CaseHandler.class);
register(TokenTypes.LITERAL_SWITCH, SwitchHandler.class);
register(TokenTypes.SLIST, SlistHandler.class);
register(TokenTypes.PACKAGE_DEF, PackageDefHandler.class);
register(TokenTypes.LITERAL_ELSE, ElseHandler.class);
register(TokenTypes.LITERAL_IF, IfHandler.class);
register(TokenTypes.LITERAL_TRY, TryHandler.class);
register(TokenTypes.LITERAL_CATCH, CatchHandler.class);
register(TokenTypes.LITERAL_FINALLY, FinallyHandler.class);
register(TokenTypes.LITERAL_DO, DoWhileHandler.class);
register(TokenTypes.LITERAL_WHILE, WhileHandler.class);
register(TokenTypes.LITERAL_FOR, ForHandler.class);
register(TokenTypes.METHOD_DEF, MethodDefHandler.class);
register(TokenTypes.CTOR_DEF, MethodDefHandler.class);
register(TokenTypes.CLASS_DEF, ClassDefHandler.class);
register(TokenTypes.ENUM_DEF, ClassDefHandler.class);
register(TokenTypes.OBJBLOCK, ObjectBlockHandler.class);
register(TokenTypes.INTERFACE_DEF, ClassDefHandler.class);
register(TokenTypes.IMPORT, ImportHandler.class);
register(TokenTypes.ARRAY_INIT, ArrayInitHandler.class);
register(TokenTypes.METHOD_CALL, MethodCallHandler.class);
register(TokenTypes.CTOR_CALL, MethodCallHandler.class);
register(TokenTypes.LABELED_STAT, LabelHandler.class);
register(TokenTypes.STATIC_INIT, StaticInitHandler.class);
register(TokenTypes.INSTANCE_INIT, SlistHandler.class);
register(TokenTypes.ASSIGN, AssignHandler.class);
register(TokenTypes.PLUS_ASSIGN, AssignHandler.class);
register(TokenTypes.MINUS_ASSIGN, AssignHandler.class);
register(TokenTypes.STAR_ASSIGN, AssignHandler.class);
register(TokenTypes.DIV_ASSIGN, AssignHandler.class);
register(TokenTypes.MOD_ASSIGN, AssignHandler.class);
register(TokenTypes.SR_ASSIGN, AssignHandler.class);
register(TokenTypes.BSR_ASSIGN, AssignHandler.class);
register(TokenTypes.SL_ASSIGN, AssignHandler.class);
register(TokenTypes.BAND_ASSIGN, AssignHandler.class);
register(TokenTypes.BXOR_ASSIGN, AssignHandler.class);
register(TokenTypes.BOR_ASSIGN, AssignHandler.class);
register(TokenTypes.VARIABLE_DEF, MemberDefHandler.class);
register(TokenTypes.LITERAL_NEW, NewHandler.class);
}
/**
* Returns true if this type (form TokenTypes) is handled.
*
* @param aType type from TokenTypes
* @return true if handler is registered, false otherwise
*/
public boolean isHandledType(int aType)
{
final Set typeSet = mTypeHandlers.keySet();
return typeSet.contains(aType);
}
/**
* Gets list of registered handler types.
*
* @return int[] of TokenType types
*/
public int[] getHandledTypes()
{
final Set typeSet = mTypeHandlers.keySet();
final int[] types = new int[typeSet.size()];
int index = 0;
for (final Integer val : typeSet) {
types[index++] = val;
}
return types;
}
/**
* Get the handler for an AST.
*
* @param aIndentCheck the indentation check
* @param aAst ast to handle
* @param aParent the handler parent of this AST
*
* @return the ExpressionHandler for aAst
*/
public ExpressionHandler getHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
final ExpressionHandler handler =
mCreatedHandlers.get(aAst);
if (handler != null) {
return handler;
}
if (aAst.getType() == TokenTypes.METHOD_CALL) {
return createMethodCallHandler(aIndentCheck, aAst, aParent);
}
ExpressionHandler expHandler = null;
try {
final Constructor handlerCtor =
mTypeHandlers.get(aAst.getType());
if (handlerCtor != null) {
expHandler = (ExpressionHandler) handlerCtor.newInstance(
aIndentCheck, aAst, aParent);
}
}
///CLOVER:OFF
catch (final InstantiationException e) {
LOG.debug("couldn't instantiate constructor for " + aAst, e);
throw new RuntimeException("couldn't instantiate constructor for "
+ aAst);
}
catch (final IllegalAccessException e) {
LOG.debug("couldn't access constructor for " + aAst, e);
throw new RuntimeException("couldn't access constructor for "
+ aAst);
}
catch (final InvocationTargetException e) {
LOG.debug("couldn't instantiate constructor for " + aAst, e);
throw new RuntimeException("couldn't instantiate constructor for "
+ aAst);
}
if (expHandler == null) {
throw new RuntimeException("no handler for type " + aAst.getType());
}
///CLOVER:ON
return expHandler;
}
/**
* Create new instance of handler for METHOD_CALL.
*
* @param aIndentCheck the indentation check
* @param aAst ast to handle
* @param aParent the handler parent of this AST
*
* @return new instance.
*/
ExpressionHandler createMethodCallHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
ExpressionHandler theParent = aParent;
DetailAST ast = aAst.getFirstChild();
while ((ast != null) && (ast.getType() == TokenTypes.DOT)) {
ast = ast.getFirstChild();
}
if ((ast != null) && isHandledType(ast.getType())) {
theParent = getHandler(aIndentCheck, ast, theParent);
mCreatedHandlers.put(ast, theParent);
}
return new MethodCallHandler(aIndentCheck, aAst, theParent);
}
/** Clears cache of created handlers. */
void clearCreatedHandlers()
{
mCreatedHandlers.clear();
}
/** cache for created method call handlers */
private final Map mCreatedHandlers =
Maps.newHashMap();
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/IfHandler.java 100644 0 0 6615 12026051031 30331 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for if statements.
*
* @author jrichard
*/
public class IfHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public IfHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "if", aAst, aParent);
}
@Override
public IndentLevel suggestedChildLevel(ExpressionHandler aChild)
{
if (aChild instanceof ElseHandler) {
return getLevel();
}
return super.suggestedChildLevel(aChild);
}
@Override
protected IndentLevel getLevelImpl()
{
if (isIfAfterElse()) {
return getParent().getLevel();
}
return super.getLevelImpl();
}
/**
* Determines if this 'if' statement is part of an 'else' clause
* and on the same line.
*
* @return true if this 'if' is part of an 'else', false otherwise
*/
private boolean isIfAfterElse()
{
// check if there is an 'else' and an 'if' on the same line
final DetailAST parent = getMainAst().getParent();
return (parent.getType() == TokenTypes.LITERAL_ELSE)
&& (parent.getLineNo() == getMainAst().getLineNo());
}
@Override
protected void checkToplevelToken()
{
if (isIfAfterElse()) {
return;
}
super.checkToplevelToken();
}
/**
* Check the indentation of the conditional expression.
*/
private void checkCondExpr()
{
final DetailAST condAst = getMainAst().findFirstToken(TokenTypes.LPAREN)
.getNextSibling();
final IndentLevel expected =
new IndentLevel(getLevel(), getBasicOffset());
checkExpressionSubtree(condAst, expected, false, false);
}
@Override
public void checkIndentation()
{
super.checkIndentation();
checkCondExpr();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/ImportHandler.java 100644 0 0 4234 12026051031 31240 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for import statements.
*
* @author jrichard
*/
public class ImportHandler extends ExpressionHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public ImportHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "import", aAst, aParent);
}
@Override
public void checkIndentation()
{
final int lineStart = getMainAst().getLineNo();
final DetailAST semi = getMainAst().findFirstToken(TokenTypes.SEMI);
final int lineEnd = semi.getLineNo();
if (getMainAst().getLineNo() != lineEnd) {
checkLinesIndent(lineStart, lineEnd, getLevel());
}
}
}
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/IndentationCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/IndentationCheck.ja100644 0 0 21012 12026051031 31364 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
// TODO: allow preset indentation styles (IE... GNU style, Sun style, etc...)?
// TODO: optionally make imports (and other?) statements required to start
// line? -- but maybe this should be a different check
// TODO: optionally allow array children, throws clause, etc...
// to be of any indentation > required, for emacs-style indentation
// TODO: this is not illegal, but probably should be:
// myfunc3(11, 11, Integer.
// getInteger("mytest").intValue(), // this should be in 4 more
// 11);
// TODO: any dot-based indentation doesn't work (at least not yet...) the
// problem is that we don't know which way an expression tree will be built
// and with dot trees, they are built backwards. This means code like
//
// org.blah.mystuff
// .myclass.getFactoryObject()
// .objFunc().otherMethod();
// and
// return ((MethodCallHandler) parent)
// .findContainingMethodCall(this);
// is all checked at the level of the first line. Simple dots are actually
// checked but the method call handler will have to be changed drastically
// to fix the above...
/**
* Checks correct indentation of Java Code.
*
*
* The basic idea behind this is that while
* pretty printers are sometimes convienent for bulk reformats of
* legacy code, they often either aren't configurable enough or
* just can't anticipate how format should be done. Sometimes this is
* personal preference, other times it is practical experience. In any
* case, this check should just ensure that a minimal set of indentation
* rules are followed.
*
*
*
* Implementation --
* Basically, this check requests visitation for all handled token
* types (those tokens registered in the HandlerFactory). When visitToken
* is called, a new ExpressionHandler is created for the AST and pushed
* onto the mHandlers stack. The new handler then checks the indentation
* for the currently visiting AST. When leaveToken is called, the
* ExpressionHandler is popped from the stack.
*
*
*
* While on the stack the ExpressionHandler can be queried for the
* indentation level it suggests for children as well as for other
* values.
*
*
*
* While an ExpressionHandler checks the indentation level of its own
* AST, it typically also checks surrounding ASTs. For instance, a
* while loop handler checks the while loop as well as the braces
* and immediate children.
*
*
* - handler class -to-> ID mapping kept in Map
* - parent passed in during construction
* - suggest child indent level
* - allows for some tokens to be on same line (ie inner classes OBJBLOCK)
* and not increase indentation level
* - looked at using double dispatch for suggestedChildLevel(), but it
* doesn't seem worthwhile, at least now
* - both tabs and spaces are considered whitespace in front of the line...
* tabs are converted to spaces
* - block parents with parens -- for, while, if, etc... -- are checked that
* they match the level of the parent
*
*
* @author jrichard
* @author o_sukhodolsky
*/
public class IndentationCheck extends Check
{
/** Default indentation amount - based on Sun */
private static final int DEFAULT_INDENTATION = 4;
/** how many tabs or spaces to use */
private int mBasicOffset = DEFAULT_INDENTATION;
/** how much to indent a case label */
private int mCaseIndentationAmount = DEFAULT_INDENTATION;
/** how far brace should be indented when on next line */
private int mBraceAdjustment;
/** handlers currently in use */
private final FastStack mHandlers =
FastStack.newInstance();
/** factory from which handlers are distributed */
private final HandlerFactory mHandlerFactory = new HandlerFactory();
/** Creates a new instance of IndentationCheck. */
public IndentationCheck()
{
}
/**
* Set the basic offset.
*
* @param aBasicOffset the number of tabs or spaces to indent
*/
public void setBasicOffset(int aBasicOffset)
{
mBasicOffset = aBasicOffset;
}
/**
* Get the basic offset.
*
* @return the number of tabs or spaces to indent
*/
public int getBasicOffset()
{
return mBasicOffset;
}
/**
* Adjusts brace indentation (positive offset).
*
* @param aAdjustmentAmount the brace offset
*/
public void setBraceAdjustment(int aAdjustmentAmount)
{
mBraceAdjustment = aAdjustmentAmount;
}
/**
* Get the brace adjustment amount.
*
* @return the positive offset to adjust braces
*/
public int getBraceAdjustement()
{
return mBraceAdjustment;
}
/**
* Set the case indentation level.
*
* @param aAmount the case indentation level
*/
public void setCaseIndent(int aAmount)
{
mCaseIndentationAmount = aAmount;
}
/**
* Get the case indentation level.
*
* @return the case indentation level
*/
public int getCaseIndent()
{
return mCaseIndentationAmount;
}
/**
* Log an error message.
*
* @param aLine the line number where the error was found
* @param aKey the message that describes the error
* @param aArgs the details of the message
*
* @see java.text.MessageFormat
*/
public void indentationLog(int aLine, String aKey, Object... aArgs)
{
super.log(aLine, aKey, aArgs);
}
/**
* Get the width of a tab.
*
* @return the width of a tab
*/
public int getIndentationTabWidth()
{
return getTabWidth();
}
@Override
public int[] getDefaultTokens()
{
return mHandlerFactory.getHandledTypes();
}
@Override
public void beginTree(DetailAST aAst)
{
mHandlerFactory.clearCreatedHandlers();
mHandlers.clear();
mHandlers.push(new PrimordialHandler(this));
}
@Override
public void visitToken(DetailAST aAST)
{
if ((aAST.getType() == TokenTypes.VARIABLE_DEF)
&& ScopeUtils.isLocalVariableDef(aAST))
{
// we have handler only for members
return;
}
final ExpressionHandler handler = mHandlerFactory.getHandler(this, aAST,
mHandlers.peek());
mHandlers.push(handler);
try {
handler.checkIndentation();
}
catch (final NullPointerException npe) {
npe.printStackTrace();
}
}
@Override
public void leaveToken(DetailAST aAST)
{
if ((aAST.getType() == TokenTypes.VARIABLE_DEF)
&& ScopeUtils.isLocalVariableDef(aAST))
{
// we have handler only for members
return;
}
mHandlers.pop();
}
/**
* Accessor for the handler factory.
*
* @return the handler factory
*/
final HandlerFactory getHandlerFactory()
{
return mHandlerFactory;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/IndentLevel.java 100644 0 0 6654 12026051031 30711 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.google.common.collect.Sets;
import java.util.SortedSet;
/**
* Encapsulates representation of notion of expected indentation levels.
* Provide a way to have multiple accaptable levels.
*
* @author o_sukhodolsky
*/
public class IndentLevel
{
/** set of acceptable indentation levels. */
private final SortedSet mLevels = Sets.newTreeSet();
/**
* Creates new instance with one accaptable indentation level.
* @param aIndent accaptable indentation level.
*/
public IndentLevel(int aIndent)
{
mLevels.add(aIndent);
}
/**
* Creates new instance for nested structure.
* @param aBase parent's level
* @param aOffset offset from parent's level.
*/
public IndentLevel(IndentLevel aBase, int aOffset)
{
for (Integer base : aBase.mLevels) {
mLevels.add(base + aOffset);
}
}
/**
* Checks wether we have more than one level.
* @return wether we have more than one level.
*/
public final boolean isMultiLevel()
{
return mLevels.size() > 1;
}
/**
* Checks if given indentation is accaptable.
* @param aIndent indentation to check.
* @return true if givent indentation is acceptable,
* false otherwise.
*/
public boolean accept(int aIndent)
{
return (mLevels.contains(aIndent));
}
/**
* @param aIndent indentation to check.
* @return true if aIndent less then minimal of
* accaptable indentation levels, false otherwise.
*/
public boolean gt(int aIndent)
{
return ((mLevels.first()).intValue() > aIndent);
}
/**
* Adds one more acceptable indentation level.
* @param aIndent new acceptable indentation.
*/
public void addAcceptedIndent(int aIndent)
{
mLevels.add(aIndent);
}
/**
* Adds one more acceptable indentation level.
* @param aIndent new acceptable indentation.
*/
public void addAcceptedIndent(IndentLevel aIndent)
{
mLevels.addAll(aIndent.mLevels);
}
@Override
public String toString()
{
if (mLevels.size() == 1) {
return mLevels.first().toString();
}
return mLevels.toString();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/LabelHandler.java 100644 0 0 5240 12026051030 31002 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for labels.
*
* @author jrichard
*/
public class LabelHandler extends ExpressionHandler
{
/**
* The types of expressions that are children of a label.
*/
private final int[] mLabelChildren = new int[] {
TokenTypes.IDENT,
};
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aExpr the abstract syntax tree
* @param aParent the parent handler
*/
public LabelHandler(IndentationCheck aIndentCheck,
DetailAST aExpr, ExpressionHandler aParent)
{
super(aIndentCheck, "label", aExpr, aParent);
}
@Override
protected IndentLevel getLevelImpl()
{
return new IndentLevel(super.getLevelImpl(), -getBasicOffset());
}
/**
* Check the indentation of the label.
*/
private void checkLabel()
{
checkChildren(getMainAst(), mLabelChildren, getLevel(), true, false);
}
@Override
public void checkIndentation()
{
checkLabel();
// need to check children (like 'block' parents do)
final DetailAST parent = getMainAst().getFirstChild().getNextSibling();
final IndentLevel expected =
new IndentLevel(getLevel(), getBasicOffset());
checkExpressionSubtree(parent, expected, true, false);
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/LineSet.java 100644 0 0 5764 12026051030 30043 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.google.common.collect.Maps;
import java.util.SortedMap;
/**
* Represents a set of lines.
*
* @author jrichard
*/
public class LineSet
{
/**
* Maps line numbers to their start column.
*/
private final SortedMap mLines = Maps.newTreeMap();
/**
* Get the starting column for a given line number.
*
* @param aLineNum the specified line number
*
* @return the starting column for the given line number
*/
public Integer getStartColumn(Integer aLineNum)
{
return mLines.get(aLineNum);
}
/**
* Get the starting column for the first line.
*
* @return the starting column for the first line.
*/
public int firstLineCol()
{
final Object firstLineKey = mLines.firstKey();
return (mLines.get(firstLineKey)).intValue();
}
/**
* Get the line number of the first line.
*
* @return the line number of the first line
*/
public int firstLine()
{
return (mLines.firstKey()).intValue();
}
/**
* Get the line number of the last line.
*
* @return the line number of the last line
*/
public int lastLine()
{
return (mLines.lastKey()).intValue();
}
/**
* Add a line to this set of lines.
*
* @param aLineNum the line to add
* @param aCol the starting column of the new line
*/
public void addLineAndCol(int aLineNum, int aCol)
{
mLines.put(aLineNum, aCol);
}
/**
* Determines if this set of lines is empty.
*
* @return true if it is empty, false otherwise
*/
public boolean isEmpty()
{
return mLines.isEmpty();
}
@Override
public String toString()
{
return "LineSet[ start=" + firstLine() + ", last=" + lastLine() + "]";
}
}
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/MemberDefHandler.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/MemberDefHandler.ja100644 0 0 5566 12026051030 31275 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for member definitions.
*
* @author o_sukhodolsky
*/
public class MemberDefHandler extends ExpressionHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAST the abstract syntax tree
* @param aParent the parent handler
*/
public MemberDefHandler(IndentationCheck aIndentCheck,
DetailAST aAST, ExpressionHandler aParent)
{
super(aIndentCheck, "member def", aAST, aParent);
}
/**
* Check the indentation of the method name.
*/
private void checkIdent()
{
final DetailAST ident = getMainAst().findFirstToken(TokenTypes.IDENT);
final int columnNo = expandedTabsColumnNo(ident);
if (startsLine(ident) && !getLevel().accept(columnNo)) {
logError(ident, "", columnNo);
}
}
/**
* Check the indentation of the method type.
*/
private void checkType()
{
final DetailAST type = getMainAst().findFirstToken(TokenTypes.TYPE);
final DetailAST ident = ExpressionHandler.getFirstToken(type);
final int columnNo = expandedTabsColumnNo(ident);
if (startsLine(ident) && !getLevel().accept(columnNo)) {
logError(ident, "type", columnNo);
}
}
@Override
public void checkIndentation()
{
checkModifiers();
checkType();
checkIdent();
}
@Override
public IndentLevel suggestedChildLevel(ExpressionHandler aChild)
{
return getLevel();
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages.properties100644 0 0 254 11451071613 31541 0 ustar 0 0 indentation.error={0} at indentation level {1} not at correct indentation, {2}
indentation.child.error={0} child at indentation level {1} not at correct indentation, {2}
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages_de.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages_de.propert100644 0 0 261 11451071613 31506 0 ustar 0 0 indentation.error={0} bei Einrücktiefe {1} nicht an korrekter Einrücktiefe {2}
indentation.child.error=Kind von {0} bei Einrücktiefe {1} nicht an korrekter Einrücktiefe {2}
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages_es.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages_es.propert100644 0 0 272 11451071613 31527 0 ustar 0 0 indentation.error={0} en el nivel de sangrado {1} no está al nivel correcto, {2}
indentation.child.error={0} el descendiente en el nivel de sangrado {1} no está al nivel correcto, {2}
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages_fi.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages_fi.propert100644 0 0 120 11451071613 31506 0 ustar 0 0 indentation.error={0} sisennyssyvyydell¤ {1} ei ole oikealla syvyydell¤ {2}.
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages_fr.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages_fr.propert100644 0 0 304 11451071613 31523 0 ustar 0 0 indentation.error={0} au niveau d''indentation {1} n''est pas indenté correctement ({2})
indentation.child.error=Le fils de {0} au niveau d''identation {1} n''est pas indenté correctement ({2})
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages_ja.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages_ja.propert100644 0 0 552 11451071613 31513 0 ustar 0 0 indentation.error=\u30a4\u30f3\u30c7\u30f3\u30c8\u968e\u5c64 {1} \u306e {0} \u304c\u6b63\u3057\u3044\u30a4\u30f3\u30c7\u30f3\u30c8 {2} \u306b\u3042\u308a\u307e\u305b\u3093
indentation.child.error=\u30a4\u30f3\u30c7\u30f3\u30c8\u968e\u5c64 {1} \u306e\u5b50 {0} \u304c\u6b63\u3057\u3044\u30a4\u30f3\u30c7\u30f3\u30c8 {2} \u306b\u3042\u308a\u307e\u305b\u3093
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages_pt.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages_pt.propert100644 0 0 275 11451071613 31546 0 ustar 0 0 indentation.error={0} no nível de indentaço {1} no está na indentaço correcta, {2}
indentation.child.error=Filho de {0} no nível de indentaço {1} no está na indentaço correcta, {2}
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages_tr.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/messages_tr.propert100644 0 0 546 11744664014 31561 0 ustar 0 0 #Generated by ResourceBundle Editor (http://eclipse-rbe.sourceforge.net)
indentation.child.error = {0} ifadesi do\u011Fru hizalanmam\u0131\u015F. Bulundu\u011Fu s\u00FCtun {1}, olmas\u0131 gereken s\u00FCtun {2}.
indentation.error = {0} ifadesi do\u011Fru hizalanmam\u0131\u015F. Bulundu\u011Fu s\u00FCtun {1}, olmas\u0131 gereken s\u00FCtun {2}.
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/MethodCallHandler.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/MethodCallHandler.j100644 0 0 15303 12026051030 31330 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for method calls.
*
* @author jrichard
*/
public class MethodCallHandler extends ExpressionHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAST the abstract syntax tree
* @param aParent the parent handler
*/
public MethodCallHandler(IndentationCheck aIndentCheck,
DetailAST aAST, ExpressionHandler aParent)
{
super(aIndentCheck,
aAST.getType() == TokenTypes.METHOD_CALL
? "method call" : "ctor call",
aAST,
aParent);
}
@Override
protected IndentLevel getLevelImpl()
{
// if inside a method call's params, this could be part of
// an expression, so get the previous line's start
if (getParent() instanceof MethodCallHandler) {
final MethodCallHandler container =
((MethodCallHandler) getParent());
if (container != null) {
if (areOnSameLine(container.getMainAst(), getMainAst())) {
return container.getLevel();
}
// we should increase indentation only if this is the first
// chained method call which was moved to the next line
final DetailAST main = getMainAst();
final DetailAST dot = main.getFirstChild();
final DetailAST target = dot.getFirstChild();
if ((dot.getType() == TokenTypes.DOT)
&& (target.getType() == TokenTypes.METHOD_CALL))
{
final DetailAST dot1 = target.getFirstChild();
final DetailAST target1 = dot1.getFirstChild();
if ((dot1.getType() == TokenTypes.DOT)
&& (target1.getType() == TokenTypes.METHOD_CALL))
{
return container.getLevel();
}
}
return new IndentLevel(container.getLevel(), getBasicOffset());
}
// if we get here, we are the child of the left hand side (name
// side) of a method call with no "containing" call, use
// the first non-method call parent
ExpressionHandler p = getParent();
while (p instanceof MethodCallHandler) {
p = p.getParent();
}
return p.suggestedChildLevel(this);
}
// if our expression isn't first on the line, just use the start
// of the line
final LineSet lines = new LineSet();
findSubtreeLines(lines, getMainAst().getFirstChild(), true);
final int firstCol = lines.firstLineCol();
final int lineStart = getLineStart(getFirstAst(getMainAst()));
if (lineStart != firstCol) {
return new IndentLevel(lineStart);
}
return super.getLevelImpl();
}
/**
* Get the first AST of the specified method call.
*
* @param aAst
* the method call
*
* @return the first AST of the specified method call
*/
private DetailAST getFirstAst(DetailAST aAst)
{
// walk down the first child part of the dots that make up a method
// call name
DetailAST ast = aAst.getFirstChild();
while ((ast != null) && (ast.getType() == TokenTypes.DOT)) {
ast = ast.getFirstChild();
}
if (ast == null) {
ast = aAst;
}
return ast;
}
@Override
public IndentLevel suggestedChildLevel(ExpressionHandler aChild)
{
// for whatever reason a method that crosses lines, like asList
// here:
// System.out.println("methods are: " + Arrays.asList(
// new String[] {"method"}).toString());
// will not have the right line num, so just get the child name
final DetailAST first = getMainAst().getFirstChild();
int indentLevel = getLineStart(first);
if (!areOnSameLine(aChild.getMainAst().getFirstChild(),
getMainAst().getFirstChild()))
{
indentLevel += getBasicOffset();
}
return new IndentLevel(indentLevel);
}
@Override
public void checkIndentation()
{
final DetailAST methodName = getMainAst().getFirstChild();
checkExpressionSubtree(methodName, getLevel(), false, false);
final DetailAST lparen = getMainAst();
final DetailAST rparen = getMainAst().findFirstToken(TokenTypes.RPAREN);
checkLParen(lparen);
if (rparen.getLineNo() == lparen.getLineNo()) {
return;
}
// if this method name is on the same line as a containing
// method, don't indent, this allows expressions like:
// method("my str" + method2(
// "my str2"));
// as well as
// method("my str" +
// method2(
// "my str2"));
//
checkExpressionSubtree(
getMainAst().findFirstToken(TokenTypes.ELIST),
new IndentLevel(getLevel(), getBasicOffset()),
false, true);
checkRParen(lparen, rparen);
}
@Override
protected boolean shouldIncreaseIndent()
{
return false;
}
}
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/MethodDefHandler.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/MethodDefHandler.ja100644 0 0 10214 12026051027 31316 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for method definitions.
*
* @author jrichard
*/
public class MethodDefHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public MethodDefHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, (aAst.getType() == TokenTypes.CTOR_DEF)
? "ctor def" : "method def", aAst, aParent);
}
@Override
protected DetailAST getToplevelAST()
{
// we check this stuff ourselves below
return null;
}
/**
* Check the indentation of the method name.
*/
private void checkIdent()
{
final DetailAST ident = getMainAst().findFirstToken(TokenTypes.IDENT);
final int columnNo = expandedTabsColumnNo(ident);
if (startsLine(ident) && !getLevel().accept(columnNo)) {
logError(ident, "", columnNo);
}
}
/**
* Check the indentation of the throws clause.
*/
private void checkThrows()
{
final DetailAST throwsAst =
getMainAst().findFirstToken(TokenTypes.LITERAL_THROWS);
if (throwsAst == null) {
return;
}
final int columnNo = expandedTabsColumnNo(throwsAst);
final IndentLevel expectedColumnNo =
new IndentLevel(getLevel(), getBasicOffset());
if (startsLine(throwsAst)
&& !expectedColumnNo.accept(columnNo))
{
logError(throwsAst, "throws", columnNo, expectedColumnNo);
}
}
/**
* Check the indentation of the method type.
*/
private void checkType()
{
final DetailAST type = getMainAst().findFirstToken(TokenTypes.TYPE);
final DetailAST ident = ExpressionHandler.getFirstToken(type);
final int columnNo = expandedTabsColumnNo(ident);
if (startsLine(ident) && !getLevel().accept(columnNo)) {
logError(ident, "return type", columnNo);
}
}
/**
* Check the indentation of the method parameters.
*/
private void checkParameters()
{
final DetailAST params =
getMainAst().findFirstToken(TokenTypes.PARAMETERS);
checkExpressionSubtree(params, getLevel(), false, false);
}
@Override
public void checkIndentation()
{
checkModifiers();
checkIdent();
checkThrows();
if (getMainAst().getType() != TokenTypes.CTOR_DEF) {
checkType();
}
checkParameters();
if (getLCurly() == null) {
// asbtract method def -- no body
return;
}
super.checkIndentation();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/NewHandler.java 100644 0 0 6545 12026051027 30533 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for operator new.
*
* @author o_sukhodolsky
*/
public class NewHandler extends ExpressionHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAST the abstract syntax tree
* @param aParent the parent handler
*/
public NewHandler(IndentationCheck aIndentCheck,
DetailAST aAST,
ExpressionHandler aParent)
{
super(aIndentCheck, "operator new", aAST, aParent);
}
@Override
public void checkIndentation()
{
final DetailAST type = getMainAst().getFirstChild();
checkExpressionSubtree(type, getLevel(), false, false);
final DetailAST lparen = getMainAst().findFirstToken(TokenTypes.LPAREN);
final DetailAST rparen = getMainAst().findFirstToken(TokenTypes.RPAREN);
checkLParen(lparen);
if ((rparen == null) || (lparen == null)
|| (rparen.getLineNo() == lparen.getLineNo()))
{
return;
}
// if this method name is on the same line as a containing
// method, don't indent, this allows expressions like:
// method("my str" + method2(
// "my str2"));
// as well as
// method("my str" +
// method2(
// "my str2"));
//
checkExpressionSubtree(
getMainAst().findFirstToken(TokenTypes.ELIST),
new IndentLevel(getLevel(), getBasicOffset()),
false, true);
checkRParen(lparen, rparen);
}
@Override
protected IndentLevel getLevelImpl()
{
// if our expression isn't first on the line, just use the start
// of the line
if (getLineStart(getMainAst()) != getMainAst().getColumnNo()) {
return new IndentLevel(getLineStart(getMainAst()));
}
return super.getLevelImpl();
}
@Override
protected boolean shouldIncreaseIndent()
{
return false;
}
}
././@LongLink 100644 0 0 151 12026055133 10245 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/ObjectBlockHandler.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/ObjectBlockHandler.100644 0 0 6262 12026051027 31315 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for inner classes.
*
* @author jrichard
*/
public class ObjectBlockHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public ObjectBlockHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "object def", aAst, aParent);
}
@Override
protected DetailAST getToplevelAST()
{
return null;
}
@Override
protected DetailAST getLCurly()
{
return getMainAst().findFirstToken(TokenTypes.LCURLY);
}
@Override
protected DetailAST getRCurly()
{
return getMainAst().findFirstToken(TokenTypes.RCURLY);
}
@Override
protected DetailAST getListChild()
{
return getMainAst();
}
@Override
protected IndentLevel getLevelImpl()
{
final DetailAST parentAST = getMainAst().getParent();
IndentLevel indent = getParent().getLevel();
if (parentAST.getType() == TokenTypes.LITERAL_NEW) {
indent.addAcceptedIndent(super.getLevelImpl());
}
else if (parentAST.getType() == TokenTypes.ENUM_CONSTANT_DEF) {
indent = super.getLevelImpl();
}
return indent;
}
@Override
public void checkIndentation()
{
// if we have a class or interface as a parent, don't do anything,
// as this is checked by class def; so
// only do this if we have a new for a parent (anonymous inner
// class)
final DetailAST parentAST = getMainAst().getParent();
if (parentAST.getType() != TokenTypes.LITERAL_NEW) {
return;
}
super.checkIndentation();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/package-info.java 100644 0 0 2265 12026051025 31021 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* Contains all classes required for the
* indentation check.
*/
package com.puppycrawl.tools.checkstyle.checks.indentation;
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/PackageDefHandler.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/PackageDefHandler.j100644 0 0 4275 12026051027 31262 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for package definitions.
*
* @author jrichard
*/
public class PackageDefHandler extends ExpressionHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public PackageDefHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "package def", aAst, aParent);
}
@Override
public void checkIndentation()
{
final int columnNo = expandedTabsColumnNo(getMainAst());
if (!getLevel().accept(columnNo)) {
logError(getMainAst(), "", columnNo);
}
checkLinesIndent(getMainAst().getLineNo(),
getMainAst().findFirstToken(TokenTypes.SEMI).getLineNo(),
getLevel());
}
}
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/PrimordialHandler.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/PrimordialHandler.j100644 0 0 3465 12026051027 31412 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
/**
* A default no-op handler.
*
* @author jrichard
*/
public class PrimordialHandler extends ExpressionHandler
{
/**
* Construct an instance of this handler with the given indentation check.
*
* @param aIndentCheck the indentation check
*/
public PrimordialHandler(IndentationCheck aIndentCheck)
{
super(aIndentCheck, null, null, null);
}
@Override
public void checkIndentation()
{
// nothing to check
}
@Override
public IndentLevel suggestedChildLevel(ExpressionHandler aChild)
{
return new IndentLevel(0);
}
@Override
protected IndentLevel getLevelImpl()
{
return new IndentLevel(0);
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/SlistHandler.java 100644 0 0 10663 12026051026 31113 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for a list of statements.
*
* @author jrichard
*/
public class SlistHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public SlistHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "block", aAst, aParent);
}
@Override
public IndentLevel suggestedChildLevel(ExpressionHandler aChild)
{
// this is:
// switch (var) {
// case 3: {
// break;
// }
// }
// ... the case SLIST is followed by a user-created SLIST and
// preceded by a switch
// if our parent is a block handler we want to be transparent
if (((getParent() instanceof BlockParentHandler)
&& !(getParent() instanceof SlistHandler))
|| ((getParent() instanceof CaseHandler)
&& (aChild instanceof SlistHandler)))
{
return getParent().suggestedChildLevel(aChild);
}
return super.suggestedChildLevel(aChild);
}
@Override
protected DetailAST getNonlistChild()
{
// blocks always have either block children or they are transparent
// and aren't checking children at all. In the later case, the
// superclass will want to check single children, so when it
// does tell it we have none.
return null;
}
@Override
protected DetailAST getListChild()
{
return getMainAst();
}
@Override
protected DetailAST getLCurly()
{
return getMainAst();
}
@Override
protected DetailAST getRCurly()
{
return getMainAst().findFirstToken(TokenTypes.RCURLY);
}
@Override
protected DetailAST getToplevelAST()
{
return null;
}
/**
* Determine if the expression we are handling has a block parent.
*
* @return true if it does, false otherwise
*/
private boolean hasBlockParent()
{
final int parentType = getMainAst().getParent().getType();
return (parentType == TokenTypes.LITERAL_IF)
|| (parentType == TokenTypes.LITERAL_FOR)
|| (parentType == TokenTypes.LITERAL_WHILE)
|| (parentType == TokenTypes.LITERAL_DO)
|| (parentType == TokenTypes.LITERAL_ELSE)
|| (parentType == TokenTypes.LITERAL_TRY)
|| (parentType == TokenTypes.LITERAL_CATCH)
|| (parentType == TokenTypes.LITERAL_FINALLY)
|| (parentType == TokenTypes.CTOR_DEF)
|| (parentType == TokenTypes.METHOD_DEF)
|| (parentType == TokenTypes.STATIC_INIT);
}
@Override
public void checkIndentation()
{
// only need to check this if parent is not
// an if, else, while, do, ctor, method
if (hasBlockParent()) {
return;
}
super.checkIndentation();
}
}
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/StaticInitHandler.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/StaticInitHandler.j100644 0 0 3566 12026051026 31364 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
* Handler for static initialization blocks.
*
* @author Jeff Weston
*/
public class StaticInitHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public StaticInitHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "static initialization", aAst, aParent);
}
@Override
protected boolean toplevelMustStartLine()
{
return false;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/SwitchHandler.java 100644 0 0 5671 12026051026 31241 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for switch statements.
*
* @author jrichard
*/
public class SwitchHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public SwitchHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "switch", aAst, aParent);
}
@Override
protected DetailAST getLCurly()
{
return getMainAst().findFirstToken(TokenTypes.LCURLY);
}
@Override
protected DetailAST getRCurly()
{
return getMainAst().findFirstToken(TokenTypes.RCURLY);
}
@Override
protected DetailAST getListChild()
{
// all children should be taken care of by case handler (plus
// there is no parent of just the cases, if checking is needed
// here in the future, an additional way beyond checkChildren()
// will have to be devised to get children)
return null;
}
@Override
protected DetailAST getNonlistChild()
{
return null;
}
/**
* Check the indentation of the switch expression.
*/
private void checkSwitchExpr()
{
checkExpressionSubtree(
getMainAst().findFirstToken(TokenTypes.LPAREN).
getNextSibling(),
getLevel(),
false,
false);
}
@Override
public void checkIndentation()
{
checkSwitchExpr();
super.checkIndentation();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/TryHandler.java 100644 0 0 4014 12026051026 30544 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
/**
* Handler for try blocks.
*
* @author jrichard
*/
public class TryHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public TryHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "try", aAst, aParent);
}
@Override
public IndentLevel suggestedChildLevel(ExpressionHandler aChild)
{
if ((aChild instanceof CatchHandler)
|| (aChild instanceof FinallyHandler))
{
return getLevel();
}
return super.suggestedChildLevel(aChild);
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/indentation/WhileHandler.java 100644 0 0 4421 12026051025 31037 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.indentation;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Handler for while loops.
*
* @author jrichard
*/
public class WhileHandler extends BlockParentHandler
{
/**
* Construct an instance of this handler with the given indentation check,
* abstract syntax tree, and parent handler.
*
* @param aIndentCheck the indentation check
* @param aAst the abstract syntax tree
* @param aParent the parent handler
*/
public WhileHandler(IndentationCheck aIndentCheck,
DetailAST aAst, ExpressionHandler aParent)
{
super(aIndentCheck, "while", aAst, aParent);
}
/**
* Check the indentation of the conditional expression.
*/
private void checkCondExpr()
{
final DetailAST condAst = getMainAst().findFirstToken(TokenTypes.EXPR);
final IndentLevel expected =
new IndentLevel(getLevel(), getBasicOffset());
checkExpressionSubtree(condAst, expected, false, false);
}
@Override
public void checkIndentation()
{
checkCondExpr();
super.checkIndentation();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/HtmlTag.java 100644 0 0 10345 12026051025 27146 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.javadoc;
/**
* Used to keep track of a tag and the text that follows it.
*
* @author Chris Stillwell
*/
class HtmlTag
{
/** The maximum length of text to display with this tag. */
private static final int MAX_TEXT_LEN = 60;
/** The HTML tag name. */
private final String mId;
/** The line number in the source file where this tag was found. */
private final int mLineNo;
/** The position within the line where this tag was found. */
private final int mPosition;
/** The comment line of text where this tag appears. */
private final String mText;
/** if this tag is self-closed. */
private final boolean mClosedTag;
/** if the tag is inomplete. */
private final boolean mIncomplete;
/**
* Construct the HtmlTag.
* @param aId the HTML tag name.
* @param aLineNo the source line number of this tag.
* @param aPosition the position within the text of this tag.
* @param aClosedTag if this tag is self-closed (XHTML style)
* @param aIncomplete is the tag is incomplete.
* @param aText the line of comment text for this tag.
*/
HtmlTag(String aId, int aLineNo, int aPosition, boolean aClosedTag,
boolean aIncomplete, String aText)
{
mId = (!"".equals(aId) && (aId.charAt(0) == '/'))
? aId.substring(1) : aId;
mLineNo = aLineNo;
mPosition = aPosition;
mText = aText;
mClosedTag = aClosedTag;
mIncomplete = aIncomplete;
}
/**
* Returns the id (name) of this tag.
* @return a String id.
*/
public String getId()
{
return mId;
}
/**
* Indicates if this tag is a close (end) tag.
* @return true is this is a close tag.
*/
public boolean isCloseTag()
{
if (mPosition == (mText.length() - 1)) {
return false;
}
return (mText.charAt(mPosition + 1) == '/');
}
/**
* Indicates if this tag is a self-closed XHTML style.
* @return true is this is a self-closed tag.
*/
public boolean isClosedTag()
{
return mClosedTag;
}
/**
* Indicates if this tag is incomplete (has no close >).
* @return true if the tag is incomplete.
*/
public boolean isIncompleteTag()
{
return mIncomplete;
}
/**
* Returns the source line number where this tag was found.
* Used for displaying a Checkstyle error.
* @return an int line number.
*/
public int getLineno()
{
return mLineNo;
}
/**
* Returns the position with in the comment line where this tag
* was found. Used for displaying a Checkstyle error.
* @return an int relative to zero.
*/
public int getPosition()
{
return mPosition;
}
@Override
public String toString()
{
final int startOfText = mPosition;
final int endOfText =
Math.min(startOfText + HtmlTag.MAX_TEXT_LEN, mText.length());
return mText.substring(startOfText, endOfText);
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/InvalidJavadocTag.java 100644 0 0 3727 12026051025 31106 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.javadoc;
/**
* Value object for storing data about an invalid Javadoc validTags.
* @author Oliver Burn
*/
public final class InvalidJavadocTag
{
/** The line in which the invalid tag occurs. */
private final int mLine;
/** The column in which the invalid tag occurs. */
private final int mCol;
/** The name of the invalid tag. */
private final String mName;
/**
* Creates an instance.
* @param aLine the line of the tag
* @param aCol the column of the tag
* @param aName the name of the invalid tag
*/
public InvalidJavadocTag(int aLine, int aCol, String aName)
{
mLine = aLine;
mCol = aCol;
mName = aName;
}
public int getLine()
{
return mLine;
}
public int getCol()
{
return mCol;
}
public String getName()
{
return mName;
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java100644 0 0 105164 12026051024 31277 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.javadoc;
import antlr.collections.AST;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FileContents;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.JavadocTagInfo;
import com.puppycrawl.tools.checkstyle.api.Scope;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TextBlock;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
import com.puppycrawl.tools.checkstyle.checks.AbstractTypeAwareCheck;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* Checks the Javadoc of a method or constructor.
*
* @author Oliver Burn
* @author Rick Giles
* @author o_sukhodoslky
*/
public class JavadocMethodCheck extends AbstractTypeAwareCheck
{
/** compiled regexp to match Javadoc tags that take an argument * */
private static final Pattern MATCH_JAVADOC_ARG =
Utils.createPattern("@(throws|exception|param)\\s+(\\S+)\\s+\\S*");
/** compiled regexp to match first part of multilineJavadoc tags * */
private static final Pattern MATCH_JAVADOC_ARG_MULTILINE_START =
Utils.createPattern("@(throws|exception|param)\\s+(\\S+)\\s*$");
/** compiled regexp to look for a continuation of the comment * */
private static final Pattern MATCH_JAVADOC_MULTILINE_CONT =
Utils.createPattern("(\\*/|@|[^\\s\\*])");
/** Multiline finished at end of comment * */
private static final String END_JAVADOC = "*/";
/** Multiline finished at next Javadoc * */
private static final String NEXT_TAG = "@";
/** compiled regexp to match Javadoc tags with no argument * */
private static final Pattern MATCH_JAVADOC_NOARG =
Utils.createPattern("@(return|see)\\s+\\S");
/** compiled regexp to match first part of multilineJavadoc tags * */
private static final Pattern MATCH_JAVADOC_NOARG_MULTILINE_START =
Utils.createPattern("@(return|see)\\s*$");
/** compiled regexp to match Javadoc tags with no argument and {} * */
private static final Pattern MATCH_JAVADOC_NOARG_CURLY =
Utils.createPattern("\\{\\s*@(inheritDoc)\\s*\\}");
/** Maximum children allowed * */
private static final int MAX_CHILDREN = 7;
/** Maximum children allowed * */
private static final int BODY_SIZE = 3;
/** the visibility scope where Javadoc comments are checked * */
private Scope mScope = Scope.PRIVATE;
/** the visibility scope where Javadoc comments shouldn't be checked * */
private Scope mExcludeScope;
/**
* controls whether to allow documented exceptions that are not declared if
* they are a subclass of java.lang.RuntimeException.
*/
private boolean mAllowUndeclaredRTE;
/**
* controls whether to allow documented exceptions that are subclass of one
* of declared exception. Defaults to false (backward compatibility).
*/
private boolean mAllowThrowsTagsForSubclasses;
/**
* controls whether to ignore errors when a method has parameters but does
* not have matching param tags in the javadoc. Defaults to false.
*/
private boolean mAllowMissingParamTags;
/**
* controls whether to ignore errors when a method declares that it throws
* exceptions but does not have matching throws tags in the javadoc.
* Defaults to false.
*/
private boolean mAllowMissingThrowsTags;
/**
* controls whether to ignore errors when a method returns non-void type
* but does not have a return tag in the javadoc. Defaults to false.
*/
private boolean mAllowMissingReturnTag;
/**
* Controls whether to ignore errors when there is no javadoc. Defaults to
* false.
*/
private boolean mAllowMissingJavadoc;
/**
* Controls whether to allow missing Javadoc on accessor methods for
* properties (setters and getters).
*/
private boolean mAllowMissingPropertyJavadoc;
/**
* Set the scope.
*
* @param aFrom a String value
*/
public void setScope(String aFrom)
{
mScope = Scope.getInstance(aFrom);
}
/**
* Set the excludeScope.
*
* @param aScope a String value
*/
public void setExcludeScope(String aScope)
{
mExcludeScope = Scope.getInstance(aScope);
}
/**
* controls whether to allow documented exceptions that are not declared if
* they are a subclass of java.lang.RuntimeException.
*
* @param aFlag a Boolean value
*/
public void setAllowUndeclaredRTE(boolean aFlag)
{
mAllowUndeclaredRTE = aFlag;
}
/**
* controls whether to allow documented exception that are subclass of one
* of declared exceptions.
*
* @param aFlag a Boolean value
*/
public void setAllowThrowsTagsForSubclasses(boolean aFlag)
{
mAllowThrowsTagsForSubclasses = aFlag;
}
/**
* controls whether to allow a method which has parameters to omit matching
* param tags in the javadoc. Defaults to false.
*
* @param aFlag a Boolean value
*/
public void setAllowMissingParamTags(boolean aFlag)
{
mAllowMissingParamTags = aFlag;
}
/**
* controls whether to allow a method which declares that it throws
* exceptions to omit matching throws tags in the javadoc. Defaults to
* false.
*
* @param aFlag a Boolean value
*/
public void setAllowMissingThrowsTags(boolean aFlag)
{
mAllowMissingThrowsTags = aFlag;
}
/**
* controls whether to allow a method which returns non-void type to omit
* the return tag in the javadoc. Defaults to false.
*
* @param aFlag a Boolean value
*/
public void setAllowMissingReturnTag(boolean aFlag)
{
mAllowMissingReturnTag = aFlag;
}
/**
* Controls whether to ignore errors when there is no javadoc. Defaults to
* false.
*
* @param aFlag a Boolean value
*/
public void setAllowMissingJavadoc(boolean aFlag)
{
mAllowMissingJavadoc = aFlag;
}
/**
* Controls whether to ignore errors when there is no javadoc for a
* property accessor (setter/getter methods). Defaults to false.
*
* @param aFlag a Boolean value
*/
public void setAllowMissingPropertyJavadoc(final boolean aFlag)
{
mAllowMissingPropertyJavadoc = aFlag;
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.PACKAGE_DEF, TokenTypes.IMPORT,
TokenTypes.CLASS_DEF, TokenTypes.ENUM_DEF,
TokenTypes.METHOD_DEF, TokenTypes.CTOR_DEF,
TokenTypes.ANNOTATION_FIELD_DEF,
};
}
@Override
public int[] getAcceptableTokens()
{
return new int[] {TokenTypes.METHOD_DEF, TokenTypes.CTOR_DEF,
TokenTypes.ANNOTATION_FIELD_DEF,
};
}
@Override
protected final void processAST(DetailAST aAST)
{
final Scope theScope = calculateScope(aAST);
if (shouldCheck(aAST, theScope)) {
final FileContents contents = getFileContents();
final TextBlock cmt = contents.getJavadocBefore(aAST.getLineNo());
if (cmt == null) {
if (!isMissingJavadocAllowed(aAST)) {
log(aAST, "javadoc.missing");
}
}
else {
checkComment(aAST, cmt, theScope);
}
}
}
@Override
protected final void logLoadError(Token aIdent)
{
logLoadErrorImpl(aIdent.getLineNo(), aIdent.getColumnNo(),
"javadoc.classInfo",
JavadocTagInfo.THROWS.getText(), aIdent.getText());
}
/**
* The JavadocMethodCheck is about to report a missing Javadoc.
* This hook can be used by derived classes to allow a missing javadoc
* in some situations. The default implementation checks
* allowMissingJavadoc and
* allowMissingPropertyJavadoc properties, do not forget
* to call super.isMissingJavadocAllowed(aAST) in case
* you want to keep this logic.
* @param aAST the tree node for the method or constructor.
* @return True if this method or constructor doesn't need Javadoc.
*/
protected boolean isMissingJavadocAllowed(final DetailAST aAST)
{
return mAllowMissingJavadoc || isOverrideMethod(aAST)
|| (mAllowMissingPropertyJavadoc
&& (isSetterMethod(aAST) || isGetterMethod(aAST)));
}
/**
* Whether we should check this node.
*
* @param aAST a given node.
* @param aScope the scope of the node.
* @return whether we should check a given node.
*/
private boolean shouldCheck(final DetailAST aAST, final Scope aScope)
{
final Scope surroundingScope = ScopeUtils.getSurroundingScope(aAST);
return aScope.isIn(mScope)
&& surroundingScope.isIn(mScope)
&& ((mExcludeScope == null) || !aScope.isIn(mExcludeScope)
|| !surroundingScope.isIn(mExcludeScope));
}
/**
* Checks the Javadoc for a method.
*
* @param aAST the token for the method
* @param aComment the Javadoc comment
* @param aScope the scope of the method.
*/
private void checkComment(DetailAST aAST, TextBlock aComment, Scope aScope)
{
final List tags = getMethodTags(aComment);
if (hasShortCircuitTag(aAST, tags, aScope)) {
return;
}
Iterator it = tags.iterator();
if (aAST.getType() != TokenTypes.ANNOTATION_FIELD_DEF) {
// Check for inheritDoc
boolean hasInheritDocTag = false;
while (it.hasNext() && !hasInheritDocTag) {
hasInheritDocTag |= (it.next()).isInheritDocTag();
}
checkParamTags(tags, aAST, !hasInheritDocTag);
checkThrowsTags(tags, getThrows(aAST), !hasInheritDocTag);
if (isFunction(aAST)) {
checkReturnTag(tags, aAST.getLineNo(), !hasInheritDocTag);
}
}
// Dump out all unused tags
it = tags.iterator();
while (it.hasNext()) {
final JavadocTag jt = it.next();
if (!jt.isSeeOrInheritDocTag()) {
log(jt.getLineNo(), "javadoc.unusedTagGeneral");
}
}
}
/**
* Validates whether the Javadoc has a short circuit tag. Currently this is
* the inheritTag. Any errors are logged.
*
* @param aAST the construct being checked
* @param aTags the list of Javadoc tags associated with the construct
* @param aScope the scope of the construct
* @return true if the construct has a short circuit tag.
*/
private boolean hasShortCircuitTag(final DetailAST aAST,
final List aTags, final Scope aScope)
{
// Check if it contains {@inheritDoc} tag
if ((aTags.size() != 1)
|| !(aTags.get(0)).isInheritDocTag())
{
return false;
}
// Invalid if private, a constructor, or a static method
if (!JavadocTagInfo.INHERIT_DOC.isValidOn(aAST)) {
log(aAST, "javadoc.invalidInheritDoc");
}
return true;
}
/**
* Returns the scope for the method/constructor at the specified AST. If
* the method is in an interface or annotation block, the scope is assumed
* to be public.
*
* @param aAST the token of the method/constructor
* @return the scope of the method/constructor
*/
private Scope calculateScope(final DetailAST aAST)
{
final DetailAST mods = aAST.findFirstToken(TokenTypes.MODIFIERS);
final Scope declaredScope = ScopeUtils.getScopeFromMods(mods);
return ScopeUtils.inInterfaceOrAnnotationBlock(aAST) ? Scope.PUBLIC
: declaredScope;
}
/**
* Returns the tags in a javadoc comment. Only finds throws, exception,
* param, return and see tags.
*
* @return the tags found
* @param aComment the Javadoc comment
*/
private List getMethodTags(TextBlock aComment)
{
final String[] lines = aComment.getText();
final List tags = Lists.newArrayList();
int currentLine = aComment.getStartLineNo() - 1;
for (int i = 0; i < lines.length; i++) {
currentLine++;
final Matcher javadocArgMatcher =
MATCH_JAVADOC_ARG.matcher(lines[i]);
final Matcher javadocNoargMatcher =
MATCH_JAVADOC_NOARG.matcher(lines[i]);
final Matcher noargCurlyMatcher =
MATCH_JAVADOC_NOARG_CURLY.matcher(lines[i]);
final Matcher argMultilineStart =
MATCH_JAVADOC_ARG_MULTILINE_START.matcher(lines[i]);
final Matcher noargMultilineStart =
MATCH_JAVADOC_NOARG_MULTILINE_START.matcher(lines[i]);
if (javadocArgMatcher.find()) {
int col = javadocArgMatcher.start(1) - 1;
if (i == 0) {
col += aComment.getStartColNo();
}
tags.add(new JavadocTag(currentLine, col, javadocArgMatcher
.group(1), javadocArgMatcher.group(2)));
}
else if (javadocNoargMatcher.find()) {
int col = javadocNoargMatcher.start(1) - 1;
if (i == 0) {
col += aComment.getStartColNo();
}
tags.add(new JavadocTag(currentLine, col, javadocNoargMatcher
.group(1)));
}
else if (noargCurlyMatcher.find()) {
int col = noargCurlyMatcher.start(1) - 1;
if (i == 0) {
col += aComment.getStartColNo();
}
tags.add(new JavadocTag(currentLine, col, noargCurlyMatcher
.group(1)));
}
else if (argMultilineStart.find()) {
final String p1 = argMultilineStart.group(1);
final String p2 = argMultilineStart.group(2);
int col = argMultilineStart.start(1) - 1;
if (i == 0) {
col += aComment.getStartColNo();
}
// Look for the rest of the comment if all we saw was
// the tag and the name. Stop when we see '*/' (end of
// Javadoc), '@' (start of next tag), or anything that's
// not whitespace or '*' characters.
int remIndex = i + 1;
while (remIndex < lines.length) {
final Matcher multilineCont = MATCH_JAVADOC_MULTILINE_CONT
.matcher(lines[remIndex]);
if (multilineCont.find()) {
remIndex = lines.length;
final String lFin = multilineCont.group(1);
if (!lFin.equals(NEXT_TAG)
&& !lFin.equals(END_JAVADOC))
{
tags.add(new JavadocTag(currentLine, col, p1, p2));
}
}
remIndex++;
}
}
else if (noargMultilineStart.find()) {
final String p1 = noargMultilineStart.group(1);
int col = noargMultilineStart.start(1) - 1;
if (i == 0) {
col += aComment.getStartColNo();
}
// Look for the rest of the comment if all we saw was
// the tag and the name. Stop when we see '*/' (end of
// Javadoc), '@' (start of next tag), or anything that's
// not whitespace or '*' characters.
int remIndex = i + 1;
while (remIndex < lines.length) {
final Matcher multilineCont = MATCH_JAVADOC_MULTILINE_CONT
.matcher(lines[remIndex]);
if (multilineCont.find()) {
remIndex = lines.length;
final String lFin = multilineCont.group(1);
if (!lFin.equals(NEXT_TAG)
&& !lFin.equals(END_JAVADOC))
{
tags.add(new JavadocTag(currentLine, col, p1));
}
}
remIndex++;
}
}
}
return tags;
}
/**
* Computes the parameter nodes for a method.
*
* @param aAST the method node.
* @return the list of parameter nodes for aAST.
*/
private List getParameters(DetailAST aAST)
{
final DetailAST params = aAST.findFirstToken(TokenTypes.PARAMETERS);
final List retVal = Lists.newArrayList();
DetailAST child = params.getFirstChild();
while (child != null) {
if (child.getType() == TokenTypes.PARAMETER_DEF) {
final DetailAST ident = child.findFirstToken(TokenTypes.IDENT);
retVal.add(ident);
}
child = child.getNextSibling();
}
return retVal;
}
/**
* Computes the exception nodes for a method.
*
* @param aAST the method node.
* @return the list of exception nodes for aAST.
*/
private List getThrows(DetailAST aAST)
{
final List retVal = Lists.newArrayList();
final DetailAST throwsAST = aAST
.findFirstToken(TokenTypes.LITERAL_THROWS);
if (throwsAST != null) {
DetailAST child = throwsAST.getFirstChild();
while (child != null) {
if ((child.getType() == TokenTypes.IDENT)
|| (child.getType() == TokenTypes.DOT))
{
final FullIdent fi = FullIdent.createFullIdent(child);
final ExceptionInfo ei = new ExceptionInfo(new Token(fi),
getCurrentClassName());
retVal.add(ei);
}
child = child.getNextSibling();
}
}
return retVal;
}
/**
* Checks a set of tags for matching parameters.
*
* @param aTags the tags to check
* @param aParent the node which takes the parameters
* @param aReportExpectedTags whether we should report if do not find
* expected tag
*/
private void checkParamTags(final List aTags,
final DetailAST aParent, boolean aReportExpectedTags)
{
final List params = getParameters(aParent);
final List typeParams = CheckUtils
.getTypeParameters(aParent);
// Loop over the tags, checking to see they exist in the params.
final ListIterator tagIt = aTags.listIterator();
while (tagIt.hasNext()) {
final JavadocTag tag = tagIt.next();
if (!tag.isParamTag()) {
continue;
}
tagIt.remove();
boolean found = false;
// Loop looking for matching param
final Iterator paramIt = params.iterator();
while (paramIt.hasNext()) {
final DetailAST param = paramIt.next();
if (param.getText().equals(tag.getArg1())) {
found = true;
paramIt.remove();
break;
}
}
if (tag.getArg1().startsWith("<") && tag.getArg1().endsWith(">")) {
// Loop looking for matching type param
final Iterator typeParamsIt = typeParams.iterator();
while (typeParamsIt.hasNext()) {
final DetailAST typeParam = typeParamsIt.next();
if (typeParam.findFirstToken(TokenTypes.IDENT).getText()
.equals(
tag.getArg1().substring(1,
tag.getArg1().length() - 1)))
{
found = true;
typeParamsIt.remove();
break;
}
}
}
// Handle extra JavadocTag
if (!found) {
log(tag.getLineNo(), tag.getColumnNo(), "javadoc.unusedTag",
"@param", tag.getArg1());
}
}
// Now dump out all type parameters/parameters without tags :- unless
// the user has chosen to suppress these problems
if (!mAllowMissingParamTags && aReportExpectedTags) {
for (DetailAST param : params) {
log(param, "javadoc.expectedTag",
JavadocTagInfo.PARAM.getText(), param.getText());
}
for (DetailAST typeParam : typeParams) {
log(typeParam, "javadoc.expectedTag",
JavadocTagInfo.PARAM.getText(),
"<" + typeParam.findFirstToken(TokenTypes.IDENT).getText()
+ ">");
}
}
}
/**
* Checks whether a method is a function.
*
* @param aAST the method node.
* @return whether the method is a function.
*/
private boolean isFunction(DetailAST aAST)
{
boolean retVal = false;
if (aAST.getType() == TokenTypes.METHOD_DEF) {
final DetailAST typeAST = aAST.findFirstToken(TokenTypes.TYPE);
if ((typeAST != null)
&& (typeAST.findFirstToken(TokenTypes.LITERAL_VOID) == null))
{
retVal = true;
}
}
return retVal;
}
/**
* Checks for only one return tag. All return tags will be removed from the
* supplied list.
*
* @param aTags the tags to check
* @param aLineNo the line number of the expected tag
* @param aReportExpectedTags whether we should report if do not find
* expected tag
*/
private void checkReturnTag(List aTags, int aLineNo,
boolean aReportExpectedTags)
{
// Loop over tags finding return tags. After the first one, report an
// error.
boolean found = false;
final ListIterator it = aTags.listIterator();
while (it.hasNext()) {
final JavadocTag jt = it.next();
if (jt.isReturnTag()) {
if (found) {
log(jt.getLineNo(), jt.getColumnNo(),
"javadoc.duplicateTag",
JavadocTagInfo.RETURN.getText());
}
found = true;
it.remove();
}
}
// Handle there being no @return tags :- unless
// the user has chosen to suppress these problems
if (!found && !mAllowMissingReturnTag && aReportExpectedTags) {
log(aLineNo, "javadoc.return.expected");
}
}
/**
* Checks a set of tags for matching throws.
*
* @param aTags the tags to check
* @param aThrows the throws to check
* @param aReportExpectedTags whether we should report if do not find
* expected tag
*/
private void checkThrowsTags(List aTags,
List aThrows, boolean aReportExpectedTags)
{
// Loop over the tags, checking to see they exist in the throws.
// The foundThrows used for performance only
final Set foundThrows = Sets.newHashSet();
final ListIterator tagIt = aTags.listIterator();
while (tagIt.hasNext()) {
final JavadocTag tag = tagIt.next();
if (!tag.isThrowsTag()) {
continue;
}
tagIt.remove();
// Loop looking for matching throw
final String documentedEx = tag.getArg1();
final Token token = new Token(tag.getArg1(), tag.getLineNo(), tag
.getColumnNo());
final ClassInfo documentedCI = createClassInfo(token,
getCurrentClassName());
boolean found = foundThrows.contains(documentedEx);
// First look for matches on the exception name
ListIterator throwIt = aThrows.listIterator();
while (!found && throwIt.hasNext()) {
final ExceptionInfo ei = throwIt.next();
if (ei.getName().getText().equals(
documentedCI.getName().getText()))
{
found = true;
ei.setFound();
foundThrows.add(documentedEx);
}
}
// Now match on the exception type
throwIt = aThrows.listIterator();
while (!found && throwIt.hasNext()) {
final ExceptionInfo ei = throwIt.next();
if (documentedCI.getClazz() == ei.getClazz()) {
found = true;
ei.setFound();
foundThrows.add(documentedEx);
}
else if (mAllowThrowsTagsForSubclasses) {
found = isSubclass(documentedCI.getClazz(), ei.getClazz());
}
}
// Handle extra JavadocTag.
if (!found) {
boolean reqd = true;
if (mAllowUndeclaredRTE) {
reqd = !isUnchecked(documentedCI.getClazz());
}
if (reqd) {
log(tag.getLineNo(), tag.getColumnNo(),
"javadoc.unusedTag",
JavadocTagInfo.THROWS.getText(), tag.getArg1());
}
}
}
// Now dump out all throws without tags :- unless
// the user has chosen to suppress these problems
if (!mAllowMissingThrowsTags && aReportExpectedTags) {
for (ExceptionInfo ei : aThrows) {
if (!ei.isFound()) {
final Token fi = ei.getName();
log(fi.getLineNo(), fi.getColumnNo(),
"javadoc.expectedTag",
JavadocTagInfo.THROWS.getText(), fi.getText());
}
}
}
}
/**
* Returns whether an AST represents a setter method.
* @param aAST the AST to check with
* @return whether the AST represents a setter method
*/
private boolean isSetterMethod(final DetailAST aAST)
{
// Check have a method with exactly 7 children which are all that
// is allowed in a proper setter method which does not throw any
// exceptions.
if ((aAST.getType() != TokenTypes.METHOD_DEF)
|| (aAST.getChildCount() != MAX_CHILDREN))
{
return false;
}
// Should I handle only being in a class????
// Check the name matches format setX...
final DetailAST type = aAST.findFirstToken(TokenTypes.TYPE);
final String name = type.getNextSibling().getText();
if (!name.matches("^set[A-Z].*")) { // Depends on JDK 1.4
return false;
}
// Check the return type is void
if (type.getChildCount(TokenTypes.LITERAL_VOID) == 0) {
return false;
}
// Check that is had only one parameter
final DetailAST params = aAST.findFirstToken(TokenTypes.PARAMETERS);
if ((params == null)
|| (params.getChildCount(TokenTypes.PARAMETER_DEF) != 1))
{
return false;
}
// Now verify that the body consists of:
// SLIST -> EXPR -> ASSIGN
// SEMI
// RCURLY
final DetailAST slist = aAST.findFirstToken(TokenTypes.SLIST);
if ((slist == null) || (slist.getChildCount() != BODY_SIZE)) {
return false;
}
final AST expr = slist.getFirstChild();
if ((expr.getType() != TokenTypes.EXPR)
|| (expr.getFirstChild().getType() != TokenTypes.ASSIGN))
{
return false;
}
return true;
}
/**
* Returns whether an AST represents a getter method.
* @param aAST the AST to check with
* @return whether the AST represents a getter method
*/
private boolean isGetterMethod(final DetailAST aAST)
{
// Check have a method with exactly 7 children which are all that
// is allowed in a proper getter method which does not throw any
// exceptions.
if ((aAST.getType() != TokenTypes.METHOD_DEF)
|| (aAST.getChildCount() != MAX_CHILDREN))
{
return false;
}
// Check the name matches format of getX or isX. Technically I should
// check that the format isX is only used with a boolean type.
final DetailAST type = aAST.findFirstToken(TokenTypes.TYPE);
final String name = type.getNextSibling().getText();
if (!name.matches("^(is|get)[A-Z].*")) { // Depends on JDK 1.4
return false;
}
// Check the return type is void
if (type.getChildCount(TokenTypes.LITERAL_VOID) > 0) {
return false;
}
// Check that is had only one parameter
final DetailAST params = aAST.findFirstToken(TokenTypes.PARAMETERS);
if ((params == null)
|| (params.getChildCount(TokenTypes.PARAMETER_DEF) > 0))
{
return false;
}
// Now verify that the body consists of:
// SLIST -> RETURN
// RCURLY
final DetailAST slist = aAST.findFirstToken(TokenTypes.SLIST);
if ((slist == null) || (slist.getChildCount() != 2)) {
return false;
}
final AST expr = slist.getFirstChild();
if ((expr.getType() != TokenTypes.LITERAL_RETURN)
|| (expr.getFirstChild().getType() != TokenTypes.EXPR))
{
return false;
}
return true;
}
/**
* Returns is a method has the "@Override" annotation.
* @param aAST the AST to check with
* @return whether the AST represents a method that has the annotation.
*/
private boolean isOverrideMethod(DetailAST aAST)
{
// Need it to be a method, cannot have an override on anything else.
// Must also have MODIFIERS token to hold the @Override
if ((TokenTypes.METHOD_DEF != aAST.getType())
|| (TokenTypes.MODIFIERS != aAST.getFirstChild().getType()))
{
return false;
}
// Now loop over all nodes while they are annotations looking for
// an "@Override".
DetailAST node = aAST.getFirstChild().getFirstChild();
while ((null != node) && (TokenTypes.ANNOTATION == node.getType())) {
if ((node.getFirstChild().getType() == TokenTypes.AT)
&& (node.getFirstChild().getNextSibling().getType()
== TokenTypes.IDENT)
&& ("Override".equals(
node.getFirstChild().getNextSibling().getText())))
{
return true;
}
node = node.getNextSibling();
}
return false;
}
/** Stores useful information about declared exception. */
private class ExceptionInfo
{
/** does the exception have throws tag associated with. */
private boolean mFound;
/** class information associated with this exception. */
private final ClassInfo mClassInfo;
/**
* Creates new instance for FullIdent.
*
* @param aIdent the exception
* @param aCurrentClass name of current class.
*/
ExceptionInfo(Token aIdent, String aCurrentClass)
{
mClassInfo = createClassInfo(aIdent, aCurrentClass);
}
/** Mark that the exception has associated throws tag */
final void setFound()
{
mFound = true;
}
/** @return whether the exception has throws tag associated with */
final boolean isFound()
{
return mFound;
}
/** @return exception's name */
final Token getName()
{
return mClassInfo.getName();
}
/** @return class for this exception */
final Class getClazz()
{
return mClassInfo.getClazz();
}
}
}
././@LongLink 100644 0 0 146 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocPackageCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocPackageCheck.jav100644 0 0 6115 12026051024 31205 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.javadoc;
import com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import java.io.File;
import java.util.List;
import java.util.Set;
/**
* Checks that all packages have a package documentation. See the documentation
* for more information.
* @author Oliver Burn
*/
public class JavadocPackageCheck extends AbstractFileSetCheck
{
/** Indicates if allow legacy "package.html" file to be used. */
private boolean mAllowLegacy;
/** The directories checked. */
private final Set mDirectoriesChecked = Sets.newHashSet();
/**
* Creates a new instance.
*/
public JavadocPackageCheck()
{
// java, not html!
// The rule is: Every JAVA file should have a package.html sibling
setFileExtensions(new String[]{"java"});
}
@Override
public void beginProcessing(String aCharset)
{
super.beginProcessing(aCharset);
mDirectoriesChecked.clear();
}
@Override
protected void processFiltered(File aFile, List aLines)
{
// Check if already processed directory
final File dir = aFile.getParentFile();
if (mDirectoriesChecked.contains(dir)) {
return;
}
mDirectoriesChecked.add(dir);
// Check for the preferred file.
final File packageInfo = new File(dir, "package-info.java");
final File packageHtml = new File(dir, "package.html");
if (packageInfo.exists()) {
if (packageHtml.exists()) {
log(0, "javadoc.legacyPackageHtml");
}
}
else if (!mAllowLegacy || !packageHtml.exists()) {
log(0, "javadoc.packageInfo");
}
}
/**
* Indicates whether to allow support for the legacy package.html
* file.
* @param aAllowLegacy whether to allow support.
*/
public void setAllowLegacy(boolean aAllowLegacy)
{
mAllowLegacy = aAllowLegacy;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java 100644 0 0 46317 12026051024 31143 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.javadoc;
import com.google.common.collect.ImmutableSortedSet;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.FileContents;
import com.puppycrawl.tools.checkstyle.api.JavadocTagInfo;
import com.puppycrawl.tools.checkstyle.api.Scope;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TextBlock;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
import java.util.List;
import java.util.Set;
import java.util.regex.Pattern;
/**
* Custom Checkstyle Check to validate Javadoc.
*
* @author Chris Stillwell
* @author Daniel Grenner
* @author Travis Schneeberger
* @version 1.2
*/
public class JavadocStyleCheck
extends Check
{
/** Message property key for the Unclosed HTML message. */
private static final String UNCLOSED_HTML = "javadoc.unclosedhtml";
/** Message property key for the Extra HTML message. */
private static final String EXTRA_HTML = "javadoc.extrahtml";
/** HTML tags that do not require a close tag. */
private static final Set SINGLE_TAGS = ImmutableSortedSet.of("p",
"br", "li", "dt", "dd", "td", "hr", "img", "tr", "th", "td");
/** HTML tags that are allowed in java docs.
* From http://www.w3schools.com/tags/default.asp
* The froms and structure tags are not allowed
*/
private static final Set ALLOWED_TAGS = ImmutableSortedSet.of(
"a", "abbr", "acronym", "address", "area", "b", "bdo", "big",
"blockquote", "br", "caption", "cite", "code", "colgroup", "del",
"div", "dfn", "dl", "em", "fieldset", "h1", "h2", "h3", "h4", "h5",
"h6", "hr", "i", "img", "ins", "kbd", "li", "ol", "p", "pre", "q",
"samp", "small", "span", "strong", "style", "sub", "sup", "table",
"tbody", "td", "tfoot", "th", "thead", "tr", "tt", "ul");
/** The scope to check. */
private Scope mScope = Scope.PRIVATE;
/** the visibility scope where Javadoc comments shouldn't be checked **/
private Scope mExcludeScope;
/** Format for matching the end of a sentence. */
private String mEndOfSentenceFormat = "([.?!][ \t\n\r\f<])|([.?!]$)";
/** Regular expression for matching the end of a sentence. */
private Pattern mEndOfSentencePattern;
/**
* Indicates if the first sentence should be checked for proper end of
* sentence punctuation.
*/
private boolean mCheckFirstSentence = true;
/**
* Indicates if the HTML within the comment should be checked.
*/
private boolean mCheckHtml = true;
/**
* Indicates if empty javadoc statements should be checked.
*/
private boolean mCheckEmptyJavadoc;
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.INTERFACE_DEF,
TokenTypes.CLASS_DEF,
TokenTypes.ANNOTATION_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.CTOR_DEF,
TokenTypes.VARIABLE_DEF,
TokenTypes.ENUM_CONSTANT_DEF,
TokenTypes.ANNOTATION_FIELD_DEF,
TokenTypes.PACKAGE_DEF,
};
}
@Override
public void visitToken(DetailAST aAST)
{
if (shouldCheck(aAST)) {
final FileContents contents = getFileContents();
// Need to start searching for the comment before the annotations
// that may exist. Even if annotations are not defined on the
// package, the ANNOTATIONS AST is defined.
final TextBlock cmt =
contents.getJavadocBefore(aAST.getFirstChild().getLineNo());
checkComment(aAST, cmt);
}
}
/**
* Whether we should check this node.
* @param aAST a given node.
* @return whether we should check a given node.
*/
private boolean shouldCheck(final DetailAST aAST)
{
if (aAST.getType() == TokenTypes.PACKAGE_DEF) {
return getFileContents().inPackageInfo();
}
if (ScopeUtils.inCodeBlock(aAST)) {
return false;
}
final Scope declaredScope;
if (aAST.getType() == TokenTypes.ENUM_CONSTANT_DEF) {
declaredScope = Scope.PUBLIC;
}
else {
declaredScope = ScopeUtils.getScopeFromMods(
aAST.findFirstToken(TokenTypes.MODIFIERS));
}
final Scope scope =
ScopeUtils.inInterfaceOrAnnotationBlock(aAST)
? Scope.PUBLIC : declaredScope;
final Scope surroundingScope = ScopeUtils.getSurroundingScope(aAST);
return scope.isIn(mScope)
&& ((surroundingScope == null) || surroundingScope.isIn(mScope))
&& ((mExcludeScope == null)
|| !scope.isIn(mExcludeScope)
|| ((surroundingScope != null)
&& !surroundingScope.isIn(mExcludeScope)));
}
/**
* Performs the various checks agains the Javadoc comment.
*
* @param aAST the AST of the element being documented
* @param aComment the source lines that make up the Javadoc comment.
*
* @see #checkFirstSentence(TextBlock)
* @see #checkHtml(DetailAST, TextBlock)
*/
private void checkComment(final DetailAST aAST, final TextBlock aComment)
{
if (aComment == null) {
/*checking for missing docs in JavadocStyleCheck is not consistent
with the rest of CheckStyle... Even though, I didn't think it
made sense to make another csheck just to ensure that the
package-info.java file actually contains package Javadocs.*/
if (getFileContents().inPackageInfo()) {
log(aAST.getLineNo(), "javadoc.missing");
}
return;
}
if (mCheckFirstSentence) {
checkFirstSentence(aAST, aComment);
}
if (mCheckHtml) {
checkHtml(aAST, aComment);
}
if (mCheckEmptyJavadoc) {
checkEmptyJavadoc(aComment);
}
}
/**
* Checks that the first sentence ends with proper punctuation. This method
* uses a regular expression that checks for the presence of a period,
* question mark, or exclamation mark followed either by whitespace, an
* HTML element, or the end of string. This method ignores {_AT_inheritDoc}
* comments for TokenTypes that are valid for {_AT_inheritDoc}.
*
* @param aAST the current node
* @param aComment the source lines that make up the Javadoc comment.
*/
private void checkFirstSentence(final DetailAST aAST, TextBlock aComment)
{
final String commentText = getCommentText(aComment.getText());
if ((commentText.length() != 0)
&& !getEndOfSentencePattern().matcher(commentText).find()
&& !("{@inheritDoc}".equals(commentText)
&& JavadocTagInfo.INHERIT_DOC.isValidOn(aAST)))
{
log(aComment.getStartLineNo(), "javadoc.noperiod");
}
}
/**
* Checks that the Javadoc is not empty.
*
* @param aComment the source lines that make up the Javadoc comment.
*/
private void checkEmptyJavadoc(TextBlock aComment)
{
final String commentText = getCommentText(aComment.getText());
if (commentText.length() == 0) {
log(aComment.getStartLineNo(), "javadoc.empty");
}
}
/**
* Returns the comment text from the Javadoc.
* @param aComments the lines of Javadoc.
* @return a comment text String.
*/
private String getCommentText(String[] aComments)
{
final StringBuffer buffer = new StringBuffer();
for (final String line : aComments) {
final int textStart = findTextStart(line);
if (textStart != -1) {
if (line.charAt(textStart) == '@') {
//we have found the tag section
break;
}
buffer.append(line.substring(textStart));
trimTail(buffer);
buffer.append('\n');
}
}
return buffer.toString().trim();
}
/**
* Finds the index of the first non-whitespace character ignoring the
* Javadoc comment start and end strings (/** and */) as well as any
* leading asterisk.
* @param aLine the Javadoc comment line of text to scan.
* @return the int index relative to 0 for the start of text
* or -1 if not found.
*/
private int findTextStart(String aLine)
{
int textStart = -1;
for (int i = 0; i < aLine.length(); i++) {
if (!Character.isWhitespace(aLine.charAt(i))) {
if (aLine.regionMatches(i, "/**", 0, "/**".length())) {
i += 2;
}
else if (aLine.regionMatches(i, "*/", 0, 2)) {
i++;
}
else if (aLine.charAt(i) != '*') {
textStart = i;
break;
}
}
}
return textStart;
}
/**
* Trims any trailing whitespace or the end of Javadoc comment string.
* @param aBuffer the StringBuffer to trim.
*/
private void trimTail(StringBuffer aBuffer)
{
for (int i = aBuffer.length() - 1; i >= 0; i--) {
if (Character.isWhitespace(aBuffer.charAt(i))) {
aBuffer.deleteCharAt(i);
}
else if ((i > 0)
&& (aBuffer.charAt(i - 1) == '*')
&& (aBuffer.charAt(i) == '/'))
{
aBuffer.deleteCharAt(i);
aBuffer.deleteCharAt(i - 1);
i--;
while (aBuffer.charAt(i - 1) == '*') {
aBuffer.deleteCharAt(i - 1);
i--;
}
}
else {
break;
}
}
}
/**
* Checks the comment for HTML tags that do not have a corresponding close
* tag or a close tag that has no previous open tag. This code was
* primarily copied from the DocCheck checkHtml method.
*
* @param aAST the node with the Javadoc
* @param aComment the TextBlock which represents
* the Javadoc comment.
*/
private void checkHtml(final DetailAST aAST, final TextBlock aComment)
{
final int lineno = aComment.getStartLineNo();
final FastStack htmlStack = FastStack.newInstance();
final String[] text = aComment.getText();
final List typeParameters =
CheckUtils.getTypeParameterNames(aAST);
TagParser parser = null;
parser = new TagParser(text, lineno);
while (parser.hasNextTag()) {
final HtmlTag tag = parser.nextTag();
if (tag.isIncompleteTag()) {
log(tag.getLineno(), "javadoc.incompleteTag",
text[tag.getLineno() - lineno]);
return;
}
if (tag.isClosedTag()) {
//do nothing
continue;
}
if (!tag.isCloseTag()) {
//We only push html tags that are allowed
if (isAllowedTag(tag)) {
htmlStack.push(tag);
}
}
else {
// We have found a close tag.
if (isExtraHtml(tag.getId(), htmlStack)) {
// No corresponding open tag was found on the stack.
log(tag.getLineno(),
tag.getPosition(),
EXTRA_HTML,
tag);
}
else {
// See if there are any unclosed tags that were opened
// after this one.
checkUnclosedTags(htmlStack, tag.getId());
}
}
}
// Identify any tags left on the stack.
String lastFound = ""; // Skip multiples, like ...
for (final HtmlTag htag : htmlStack) {
if (!isSingleTag(htag)
&& !htag.getId().equals(lastFound)
&& !typeParameters.contains(htag.getId()))
{
log(htag.getLineno(), htag.getPosition(), UNCLOSED_HTML, htag);
lastFound = htag.getId();
}
}
}
/**
* Checks to see if there are any unclosed tags on the stack. The token
* represents a html tag that has been closed and has a corresponding open
* tag on the stack. Any tags, except single tags, that were opened
* (pushed on the stack) after the token are missing a close.
*
* @param aHtmlStack the stack of opened HTML tags.
* @param aToken the current HTML tag name that has been closed.
*/
private void checkUnclosedTags(FastStack aHtmlStack, String aToken)
{
final FastStack unclosedTags = FastStack.newInstance();
HtmlTag lastOpenTag = aHtmlStack.pop();
while (!aToken.equalsIgnoreCase(lastOpenTag.getId())) {
// Find unclosed elements. Put them on a stack so the
// output order won't be back-to-front.
if (isSingleTag(lastOpenTag)) {
lastOpenTag = aHtmlStack.pop();
}
else {
unclosedTags.push(lastOpenTag);
lastOpenTag = aHtmlStack.pop();
}
}
// Output the unterminated tags, if any
String lastFound = ""; // Skip multiples, like ..
for (final HtmlTag htag : unclosedTags) {
lastOpenTag = htag;
if (lastOpenTag.getId().equals(lastFound)) {
continue;
}
lastFound = lastOpenTag.getId();
log(lastOpenTag.getLineno(),
lastOpenTag.getPosition(),
UNCLOSED_HTML,
lastOpenTag);
}
}
/**
* Determines if the HtmlTag is one which does not require a close tag.
*
* @param aTag the HtmlTag to check.
* @return true if the HtmlTag is a single tag.
*/
private boolean isSingleTag(HtmlTag aTag)
{
// If its a singleton tag (
, , etc.), ignore it
// Can't simply not put them on the stack, since singletons
// like
and
(unhappily) may either be terminated
// or not terminated. Both options are legal.
return SINGLE_TAGS.contains(aTag.getId().toLowerCase());
}
/**
* Determines if the HtmlTag is one which is allowed in a javadoc.
*
* @param aTag the HtmlTag to check.
* @return true if the HtmlTag is an allowed html tag.
*/
private boolean isAllowedTag(HtmlTag aTag)
{
return ALLOWED_TAGS.contains(aTag.getId().toLowerCase());
}
/**
* Determines if the given token is an extra HTML tag. This indicates that
* a close tag was found that does not have a corresponding open tag.
*
* @param aToken an HTML tag id for which a close was found.
* @param aHtmlStack a Stack of previous open HTML tags.
* @return false if a previous open tag was found
* for the token.
*/
private boolean isExtraHtml(String aToken, FastStack aHtmlStack)
{
boolean isExtra = true;
for (final HtmlTag td : aHtmlStack) {
// Loop, looking for tags that are closed.
// The loop is needed in case there are unclosed
// tags on the stack. In that case, the stack would
// not be empty, but this tag would still be extra.
if (aToken.equalsIgnoreCase(td.getId())) {
isExtra = false;
break;
}
}
return isExtra;
}
/**
* Sets the scope to check.
* @param aFrom string to get the scope from
*/
public void setScope(String aFrom)
{
mScope = Scope.getInstance(aFrom);
}
/**
* Set the excludeScope.
* @param aScope a String value
*/
public void setExcludeScope(String aScope)
{
mExcludeScope = Scope.getInstance(aScope);
}
/**
* Set the format for matching the end of a sentence.
* @param aFormat format for matching the end of a sentence.
*/
public void setEndOfSentenceFormat(String aFormat)
{
mEndOfSentenceFormat = aFormat;
}
/**
* Returns a regular expression for matching the end of a sentence.
*
* @return a regular expression for matching the end of a sentence.
*/
private Pattern getEndOfSentencePattern()
{
if (mEndOfSentencePattern == null) {
mEndOfSentencePattern = Pattern.compile(mEndOfSentenceFormat);
}
return mEndOfSentencePattern;
}
/**
* Sets the flag that determines if the first sentence is checked for
* proper end of sentence punctuation.
* @param aFlag true if the first sentence is to be checked
*/
public void setCheckFirstSentence(boolean aFlag)
{
mCheckFirstSentence = aFlag;
}
/**
* Sets the flag that determines if HTML checking is to be performed.
* @param aFlag true if HTML checking is to be performed.
*/
public void setCheckHtml(boolean aFlag)
{
mCheckHtml = aFlag;
}
/**
* Sets the flag that determines if empty JavaDoc checking should be done.
* @param aFlag true if empty JavaDoc checking should be done.
*/
public void setCheckEmptyJavadoc(boolean aFlag)
{
mCheckEmptyJavadoc = aFlag;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTag.java 100644 0 0 10764 12026051024 27615 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.javadoc;
import com.puppycrawl.tools.checkstyle.api.JavadocTagInfo;
/**
* Represents a Javadoc tag. Provides methods to query what type of tag it is.
* @author Oliver Burn
*/
public class JavadocTag
{
/** the line number of the tag **/
private final int mLineNo;
/** the column number of the tag **/
private int mColumnNo;
/** an optional first argument. For example the parameter name. **/
private final String mArg1;
/** the JavadocTagInfo representing this tag **/
private final JavadocTagInfo mTagInfo;
/**
* Constructs the object.
* @param aLine the line number of the tag
* @param aColumn the column number of the tag
* @param aTag the tag string
* @param aArg1 the tag argument
**/
public JavadocTag(int aLine, int aColumn, String aTag, String aArg1)
{
mLineNo = aLine;
mColumnNo = aColumn;
mArg1 = aArg1;
mTagInfo = JavadocTagInfo.fromName(aTag);
}
/**
* Constructs the object.
* @param aLine the line number of the tag
* @param aColumn the column number of the tag
* @param aTag the tag string
**/
public JavadocTag(int aLine, int aColumn, String aTag)
{
this(aLine, aColumn, aTag, null);
}
/** @return the tag string **/
public String getTagName()
{
return mTagInfo.getName();
}
/** @return the first argument. null if not set. **/
public String getArg1()
{
return mArg1;
}
/** @return the line number **/
public int getLineNo()
{
return mLineNo;
}
/** @return the column number */
public int getColumnNo()
{
return mColumnNo;
}
@Override
public String toString()
{
return "{Tag = '" + getTagName() + "', lineNo = " + getLineNo()
+ ", columnNo=" + mColumnNo + ", Arg1 = '" + getArg1() + "'}";
}
/** @return whether the tag is an 'author' tag **/
public boolean isAuthorTag()
{
return JavadocTagInfo.AUTHOR.equals(mTagInfo);
}
/** @return whether the tag is an 'return' tag **/
public boolean isReturnTag()
{
return JavadocTagInfo.RETURN.equals(mTagInfo);
}
/** @return whether the tag is an 'param' tag **/
public boolean isParamTag()
{
return JavadocTagInfo.PARAM.equals(mTagInfo);
}
/** @return whether the tag is an 'throws' or 'exception' tag **/
public boolean isThrowsTag()
{
return (JavadocTagInfo.THROWS.equals(mTagInfo)
|| JavadocTagInfo.EXCEPTION.equals(mTagInfo));
}
/** @return whether the tag is a 'see' or 'inheritDoc' tag **/
public boolean isSeeOrInheritDocTag()
{
return (JavadocTagInfo.SEE.equals(mTagInfo) || isInheritDocTag());
}
/** @return whether the tag is a 'inheritDoc' tag **/
public boolean isInheritDocTag()
{
return JavadocTagInfo.INHERIT_DOC.equals(mTagInfo);
}
/** @return whether the tag can contain references to imported classes **/
public boolean canReferenceImports()
{
return (JavadocTagInfo.SEE.equals(mTagInfo)
|| JavadocTagInfo.LINK.equals(mTagInfo)
|| JavadocTagInfo.LINKPLAIN.equals(mTagInfo)
|| JavadocTagInfo.THROWS.equals(mTagInfo)
|| JavadocTagInfo.EXCEPTION.equals(mTagInfo));
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTags.java 100644 0 0 3734 12026051023 27756 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.javadoc;
import java.util.List;
/**
* Value object for combining the list of valid validTags with information
* about invalid validTags encountered in a certain Javadoc comment.
* @author Oliver Burn
*/
public final class JavadocTags
{
/** Valid validTags. */
private final List mValidTags;
/** Invalid validTags. */
private final List mInvalidTags;
/**
* Creates an instance.
* @param aTags the list of valid tags
* @param aInvalidTags the list of invalid tags
*/
public JavadocTags(List aTags,
List aInvalidTags)
{
mValidTags = aTags;
mInvalidTags = aInvalidTags;
}
public List getValidTags()
{
return mValidTags;
}
public List getInvalidTags()
{
return mInvalidTags;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocTypeCheck.java 100644 0 0 27111 12026051023 30752 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.javadoc;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FileContents;
import com.puppycrawl.tools.checkstyle.api.JavadocTagInfo;
import com.puppycrawl.tools.checkstyle.api.Scope;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TextBlock;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.apache.commons.beanutils.ConversionException;
/**
* Checks the Javadoc of a type.
*
* @author Oliver Burn
* @author Michael Tamm
*/
public class JavadocTypeCheck
extends Check
{
/** the scope to check for */
private Scope mScope = Scope.PRIVATE;
/** the visibility scope where Javadoc comments shouldn't be checked **/
private Scope mExcludeScope;
/** compiled regexp to match author tag content **/
private Pattern mAuthorFormatPattern;
/** compiled regexp to match version tag content **/
private Pattern mVersionFormatPattern;
/** regexp to match author tag content */
private String mAuthorFormat;
/** regexp to match version tag content */
private String mVersionFormat;
/**
* controls whether to ignore errors when a method has type parameters but
* does not have matching param tags in the javadoc. Defaults to false.
*/
private boolean mAllowMissingParamTags;
/** controls whether to flag errors for unknown tags. Defaults to false. */
private boolean mAllowUnknownTags;
/**
* Sets the scope to check.
* @param aFrom string to set scope from
*/
public void setScope(String aFrom)
{
mScope = Scope.getInstance(aFrom);
}
/**
* Set the excludeScope.
* @param aScope a String value
*/
public void setExcludeScope(String aScope)
{
mExcludeScope = Scope.getInstance(aScope);
}
/**
* Set the author tag pattern.
* @param aFormat a String value
* @throws ConversionException unable to parse aFormat
*/
public void setAuthorFormat(String aFormat)
throws ConversionException
{
try {
mAuthorFormat = aFormat;
mAuthorFormatPattern = Utils.getPattern(aFormat);
}
catch (final PatternSyntaxException e) {
throw new ConversionException("unable to parse " + aFormat, e);
}
}
/**
* Set the version format pattern.
* @param aFormat a String value
* @throws ConversionException unable to parse aFormat
*/
public void setVersionFormat(String aFormat)
throws ConversionException
{
try {
mVersionFormat = aFormat;
mVersionFormatPattern = Utils.getPattern(aFormat);
}
catch (final PatternSyntaxException e) {
throw new ConversionException("unable to parse " + aFormat, e);
}
}
/**
* Controls whether to allow a type which has type parameters to
* omit matching param tags in the javadoc. Defaults to false.
*
* @param aFlag a Boolean value
*/
public void setAllowMissingParamTags(boolean aFlag)
{
mAllowMissingParamTags = aFlag;
}
/**
* Controls whether to flag errors for unknown tags. Defaults to false.
* @param aFlag a Boolean value
*/
public void setAllowUnknownTags(boolean aFlag)
{
mAllowUnknownTags = aFlag;
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.INTERFACE_DEF,
TokenTypes.CLASS_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.ANNOTATION_DEF,
};
}
@Override
public void visitToken(DetailAST aAST)
{
if (shouldCheck(aAST)) {
final FileContents contents = getFileContents();
final int lineNo = aAST.getLineNo();
final TextBlock cmt = contents.getJavadocBefore(lineNo);
if (cmt == null) {
log(lineNo, "javadoc.missing");
}
else if (ScopeUtils.isOuterMostType(aAST)) {
// don't check author/version for inner classes
final List tags = getJavadocTags(cmt);
checkTag(lineNo, tags, JavadocTagInfo.AUTHOR.getName(),
mAuthorFormatPattern, mAuthorFormat);
checkTag(lineNo, tags, JavadocTagInfo.VERSION.getName(),
mVersionFormatPattern, mVersionFormat);
final List typeParamNames =
CheckUtils.getTypeParameterNames(aAST);
if (!mAllowMissingParamTags) {
//Check type parameters that should exist, do
for (final String string : typeParamNames) {
checkTypeParamTag(
lineNo, tags, string);
}
}
checkUnusedTypeParamTags(tags, typeParamNames);
}
}
}
/**
* Whether we should check this node.
* @param aAST a given node.
* @return whether we should check a given node.
*/
private boolean shouldCheck(final DetailAST aAST)
{
final DetailAST mods = aAST.findFirstToken(TokenTypes.MODIFIERS);
final Scope declaredScope = ScopeUtils.getScopeFromMods(mods);
final Scope scope =
ScopeUtils.inInterfaceOrAnnotationBlock(aAST)
? Scope.PUBLIC : declaredScope;
final Scope surroundingScope = ScopeUtils.getSurroundingScope(aAST);
return scope.isIn(mScope)
&& ((surroundingScope == null) || surroundingScope.isIn(mScope))
&& ((mExcludeScope == null)
|| !scope.isIn(mExcludeScope)
|| ((surroundingScope != null)
&& !surroundingScope.isIn(mExcludeScope)));
}
/**
* Gets all standalone tags from a given javadoc.
* @param aCmt the Javadoc comment to process.
* @return all standalone tags from the given javadoc.
*/
private List getJavadocTags(TextBlock aCmt)
{
final JavadocTags tags = JavadocUtils.getJavadocTags(aCmt,
JavadocUtils.JavadocTagType.BLOCK);
if (!mAllowUnknownTags) {
for (final InvalidJavadocTag tag : tags.getInvalidTags()) {
log(tag.getLine(), tag.getCol(), "javadoc.unknownTag",
tag.getName());
}
}
return tags.getValidTags();
}
/**
* Verifies that a type definition has a required tag.
* @param aLineNo the line number for the type definition.
* @param aTags tags from the Javadoc comment for the type definition.
* @param aTag the required tag name.
* @param aFormatPattern regexp for the tag value.
* @param aFormat pattern for the tag value.
*/
private void checkTag(int aLineNo, List aTags, String aTag,
Pattern aFormatPattern, String aFormat)
{
if (aFormatPattern == null) {
return;
}
int tagCount = 0;
for (int i = aTags.size() - 1; i >= 0; i--) {
final JavadocTag tag = aTags.get(i);
if (tag.getTagName().equals(aTag)) {
tagCount++;
if (!aFormatPattern.matcher(tag.getArg1()).find()) {
log(aLineNo, "type.tagFormat", "@" + aTag, aFormat);
}
}
}
if (tagCount == 0) {
log(aLineNo, "type.missingTag", "@" + aTag);
}
}
/**
* Verifies that a type definition has the specified param tag for
* the specified type parameter name.
* @param aLineNo the line number for the type definition.
* @param aTags tags from the Javadoc comment for the type definition.
* @param aTypeParamName the name of the type parameter
*/
private void checkTypeParamTag(final int aLineNo,
final List aTags, final String aTypeParamName)
{
boolean found = false;
for (int i = aTags.size() - 1; i >= 0; i--) {
final JavadocTag tag = aTags.get(i);
if (tag.isParamTag()
&& (tag.getArg1() != null)
&& (tag.getArg1().indexOf("<" + aTypeParamName + ">") == 0))
{
found = true;
}
}
if (!found) {
log(aLineNo, "type.missingTag",
JavadocTagInfo.PARAM.getText() + " <" + aTypeParamName + ">");
}
}
/**
* Checks for unused param tags for type parameters.
* @param aTags tags from the Javadoc comment for the type definition.
* @param aTypeParamNames names of type parameters
*/
private void checkUnusedTypeParamTags(
final List aTags,
final List aTypeParamNames)
{
final Pattern pattern = Utils.getPattern("\\s*<([^>]+)>.*");
for (int i = aTags.size() - 1; i >= 0; i--) {
final JavadocTag tag = aTags.get(i);
if (tag.isParamTag()) {
if (tag.getArg1() != null) {
final Matcher matcher = pattern.matcher(tag.getArg1());
String typeParamName = null;
if (matcher.matches()) {
typeParamName = matcher.group(1).trim();
if (!aTypeParamNames.contains(typeParamName)) {
log(tag.getLineNo(), tag.getColumnNo(),
"javadoc.unusedTag",
JavadocTagInfo.PARAM.getText(),
"<" + typeParamName + ">");
}
}
else {
log(tag.getLineNo(), tag.getColumnNo(),
"javadoc.unusedTagGeneral");
}
}
else {
log(tag.getLineNo(), tag.getColumnNo(),
"javadoc.unusedTagGeneral");
}
}
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocUtils.java 100644 0 0 13725 12026051023 30201 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.javadoc;
import com.google.common.collect.Lists;
import com.puppycrawl.tools.checkstyle.api.JavadocTagInfo;
import com.puppycrawl.tools.checkstyle.api.TextBlock;
import com.puppycrawl.tools.checkstyle.api.Utils;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* Contains utility methods for working with Javadoc.
* @author Lyle Hanson
*/
public final class JavadocUtils
{
///CLOVER:OFF
/** prevent instantiation */
private JavadocUtils()
{
}
///CLOVER:ON
/**
* Gets validTags from a given piece of Javadoc.
* @param aCmt the Javadoc comment to process.
* @param aTagType the type of validTags we're interested in
* @return all standalone validTags from the given javadoc.
*/
public static JavadocTags getJavadocTags(TextBlock aCmt,
JavadocTagType aTagType)
{
final String[] text = aCmt.getText();
final List tags = Lists.newArrayList();
final List invalidTags = Lists.newArrayList();
Pattern blockTagPattern =
Utils.getPattern("/\\*{2,}\\s*@(\\p{Alpha}+)\\s");
for (int i = 0; i < text.length; i++) {
final String s = text[i];
final Matcher blockTagMatcher = blockTagPattern.matcher(s);
if ((aTagType.equals(JavadocTagType.ALL) || aTagType
.equals(JavadocTagType.BLOCK)) && blockTagMatcher.find())
{
final String tagName = blockTagMatcher.group(1);
String content = s.substring(blockTagMatcher.end(1));
if (content.endsWith("*/")) {
content = content.substring(0, content.length() - 2);
}
final int line = aCmt.getStartLineNo() + i;
int col = blockTagMatcher.start(1) - 1;
if (i == 0) {
col += aCmt.getStartColNo();
}
if (JavadocTagInfo.isValidName(tagName)) {
tags.add(
new JavadocTag(line, col, tagName, content.trim()));
}
else {
invalidTags.add(new InvalidJavadocTag(line, col, tagName));
}
}
// No block tag, so look for inline validTags
else if (aTagType.equals(JavadocTagType.ALL)
|| aTagType.equals(JavadocTagType.INLINE))
{
// Match JavaDoc text after comment characters
final Pattern commentPattern =
Utils.getPattern("^\\s*(?:/\\*{2,}|\\*+)\\s*(.*)");
final Matcher commentMatcher = commentPattern.matcher(s);
final String commentContents;
final int commentOffset; // offset including comment characters
if (!commentMatcher.find()) {
commentContents = s; // No leading asterisks, still valid
commentOffset = 0;
}
else {
commentContents = commentMatcher.group(1);
commentOffset = commentMatcher.start(1) - 1;
}
final Pattern tagPattern =
Utils.getPattern(".*?\\{@(\\p{Alpha}+)\\s+(.*?)\\}");
final Matcher tagMatcher = tagPattern.matcher(commentContents);
while (tagMatcher.find()) {
if (tagMatcher.groupCount() == 2) {
final String tagName = tagMatcher.group(1);
final String tagValue = tagMatcher.group(2).trim();
final int line = aCmt.getStartLineNo() + i;
int col = commentOffset + (tagMatcher.start(1) - 1);
if (i == 0) {
col += aCmt.getStartColNo();
}
if (JavadocTagInfo.isValidName(tagName)) {
tags.add(new JavadocTag(line, col, tagName,
tagValue));
}
else {
invalidTags.add(new InvalidJavadocTag(line, col,
tagName));
}
}
// else Error: Unexpected match count for inline JavaDoc
// tag!
}
}
blockTagPattern =
Utils.getPattern("^\\s*\\**\\s*@(\\p{Alpha}+)\\s");
}
return new JavadocTags(tags, invalidTags);
}
/**
* The type of Javadoc tag we want returned.
*/
public enum JavadocTagType
{
/** block type. */
BLOCK,
/** inline type. */
INLINE,
/** all validTags. */
ALL;
}
}
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocVariableCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocVariableCheck.ja100644 0 0 7433 12026051023 31214 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.javadoc;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FileContents;
import com.puppycrawl.tools.checkstyle.api.Scope;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TextBlock;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Checks that a variable has Javadoc comment.
*
* @author Oliver Burn
* @version 1.0
*/
public class JavadocVariableCheck
extends Check
{
/** the scope to check */
private Scope mScope = Scope.PRIVATE;
/** the visibility scope where Javadoc comments shouldn't be checked **/
private Scope mExcludeScope;
/**
* Sets the scope to check.
* @param aFrom string to get the scope from
*/
public void setScope(String aFrom)
{
mScope = Scope.getInstance(aFrom);
}
/**
* Set the excludeScope.
* @param aScope a String value
*/
public void setExcludeScope(String aScope)
{
mExcludeScope = Scope.getInstance(aScope);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.VARIABLE_DEF,
TokenTypes.ENUM_CONSTANT_DEF,
};
}
@Override
public void visitToken(DetailAST aAST)
{
if (shouldCheck(aAST)) {
final FileContents contents = getFileContents();
final TextBlock cmt =
contents.getJavadocBefore(aAST.getLineNo());
if (cmt == null) {
log(aAST, "javadoc.missing");
}
}
}
/**
* Whether we should check this node.
* @param aAST a given node.
* @return whether we should check a given node.
*/
private boolean shouldCheck(final DetailAST aAST)
{
if (ScopeUtils.inCodeBlock(aAST)) {
return false;
}
final Scope scope;
if (aAST.getType() == TokenTypes.ENUM_CONSTANT_DEF) {
scope = Scope.PUBLIC;
}
else {
final DetailAST mods = aAST.findFirstToken(TokenTypes.MODIFIERS);
final Scope declaredScope = ScopeUtils.getScopeFromMods(mods);
scope =
ScopeUtils.inInterfaceOrAnnotationBlock(aAST)
? Scope.PUBLIC : declaredScope;
}
final Scope surroundingScope = ScopeUtils.getSurroundingScope(aAST);
return scope.isIn(mScope) && surroundingScope.isIn(mScope)
&& ((mExcludeScope == null)
|| !scope.isIn(mExcludeScope)
|| !surroundingScope.isIn(mExcludeScope));
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/messages.properties 100644 0 0 2043 11451071613 30652 0 ustar 0 0 javadoc.classInfo=Unable to get class information for {0} tag ''{1}''.
javadoc.expectedTag=Expected {0} tag for ''{1}''.
javadoc.extrahtml=Extra HTML tag found: {0}
javadoc.incompleteTag=Incomplete HTML tag found: {0}
javadoc.missing=Missing a Javadoc comment.
javadoc.noperiod=First sentence should end with a period.
javadoc.packageHtml=Missing package documentation file.
javadoc.duplicateTag=Duplicate {0} tag.
javadoc.return.expected=Expected an @return tag.
javadoc.unclosedhtml=Unclosed HTML tag found: {0}
javadoc.unusedTag=Unused {0} tag for ''{1}''.
javadoc.unusedTagGeneral=Unused Javadoc tag.
javadoc.empty=Javadoc has empty description section.
javadoc.writeTag={0}={1}
javadoc.invalidInheritDoc=Invalid use of the '{'@inheritDoc'}' tag.
javadoc.legacyPackageHtml=Legacy package.html file should be removed.
javadoc.packageInfo=Missing package-info.java file.
javadoc.unknownTag=Unknown tag ''{0}''.
type.missingTag=Type Javadoc comment is missing an {0} tag.
type.tagFormat=Type Javadoc tag {0} must match pattern ''{1}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/messages_de.properties 100644 0 0 1531 11451071613 31323 0 ustar 0 0 javadoc.classInfo=Kann zum Tag ''{1}'' keine Klasseninformation zu {0} laden.
javadoc.expectedTag=Erwartete Tag {0} für ''{1}''.
javadoc.extrahtml=Unerwarteter schließender HTML-Tag: {0}
javadoc.incompleteTag=Unvollständiger HTML-Tag: {0}
javadoc.missing=Javadoc-Kommentar fehlt.
javadoc.noperiod=Der erste Satz sollte mit einem Punkt abschließen.
javadoc.packageHtml=Fehlende Package-Dokumentation.
javadoc.duplicateTag=Doppelter {0}-Tag.
javadoc.return.expected=Fehlender @return-Tag.
javadoc.unclosedhtml=HTML-Tag {0} wird nicht geschlossen.
javadoc.unusedTag=Nicht benutztes {0}-Tag für ''{1}''.
javadoc.unusedTagGeneral=Nicht benutzter Javadoc-Tag.
javadoc.empty=Javadoc enthält keine Beschreibung.
type.missingTag=In der Klassen-Dokumentation fehlt ein {0}-Tag.
type.tagFormat=Der Javadoc-Tag {0} entspricht nicht dem Muster ''{1}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/messages_es.properties 100644 0 0 1674 11451071613 31352 0 ustar 0 0 javadoc.classInfo=No se puede obtener la información de clase para {0} etiqueta ''{1}''.
javadoc.expectedTag=Se esperaba la etiqueta {0} para ''{1}''.
javadoc.extrahtml=Se encontró una etiqueta HTML extra: {0}
javadoc.incompleteTag=Se encontró una etiqueta HTML incompleta: {0}
javadoc.missing=Falta el comentario Javadoc.
javadoc.noperiod=La primera frase debería finalizar con un punto.
javadoc.packageHtml=Falta el fichero de documentación del paquete.
javadoc.duplicateTag=Etiqueta {0} duplicada.
javadoc.return.expected=Se esperaba la etiqueta @return.
javadoc.unclosedhtml=Se encontró una etiqueta HTML sin cerrar: {0}
javadoc.unusedTag=Etiqueta {0} no usada en ''{1}''.
javadoc.unusedTagGeneral=Etiqueta Javadoc no usada.
javadoc.empty=Hay una sección de descripción vacía en el Javadoc.
type.missingTag=Al comentario Javadoc le falta una etiqueta {0}.
type.tagFormat=El comentario Javadoc {0} debe coincidir con el patrón ''{1}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/messages_fi.properties 100644 0 0 1051 11451071613 31326 0 ustar 0 0 javadoc.missing=Javadoc-kommentti puuttuu.
javadoc.unusedTagGeneral=Tuntematon Javadoc-tagi.
javadoc.unusedTag=Tuntematon tagi ''{1}'':lle: {0}.
javadoc.expectedTag=Javadoc-tagi puuttuu: {0} tagi ''{1}''.
javadoc.duplicateTag=Duplikaatti {0}-tagi.
javadoc.return.expected=@return-tagi puuttuu.
javadoc.classInfo=Luokkatiedot ei saatavilla: {0} tagi ''{1}''.
javadoc.packageHtml=Pakettidokumentaatiotiedosto puuttuu.
type.missingTag=Javadoc-kommentista puuttuu {0}-tagi.
type.tagFormat=Javadoc-tagin {0} pit¤¤ olla mallin ''{1}'' mukainen.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/messages_fr.properties 100644 0 0 1705 11453016761 31352 0 ustar 0 0 javadoc.classInfo=Impossible d''obtenir les informations relatives à la classe {1} pour la balise ''{0}''.
javadoc.expectedTag=Balise javadoc {0} manquante pour ''{1}''.
javadoc.extrahtml=Balise HTML en trop : {0}
javadoc.incompleteTag=Balise HTML incomplète : {0}
javadoc.missing=Commentaire javadoc manquant.
javadoc.noperiod=La première ligne doit se terminer avec un point.
javadoc.packageHtml=Fichier de documentation de package manquant.
javadoc.duplicateTag=Balise javadoc {0} présente plus d''une fois.
javadoc.return.expected=Balise javadoc @return manquante.
javadoc.unclosedhtml=Balise HTML trouvée dans la javadoc : {0}
javadoc.unusedTag=Balise javadoc {0} inutilisé pour ''{1}''.
javadoc.unusedTagGeneral=Balise javadoc inutilisé.
javadoc.empty=Le commentaire javadoc est vide.
type.missingTag=Dans le commentaire javadoc de la classe, il manque une balise {0}.
type.tagFormat=La balise javadoc {0} doit correspondre au motif ''{1}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/messages_ja.properties 100644 0 0 3333 11451071613 31327 0 ustar 0 0 javadoc.classInfo={0} \u30bf\u30b0\u306e ''{1}'' \u306e\u30af\u30e9\u30b9\u60c5\u5831\u304c\u53d6\u5f97\u3067\u304d\u307e\u305b\u3093\u3002
javadoc.expectedTag=''{1}'' \u306b\u306f {0} \u30bf\u30b0\u304c\u5fc5\u8981\u3067\u3059\u3002
javadoc.extrahtml=\u4e0d\u8981\u306a\u7d42\u4e86\u30bf\u30b0\u304c\u898b\u3064\u304b\u308a\u307e\u3057\u305f: {0}
javadoc.incompleteTag=\u4e0d\u5b8c\u5168\u306aHTML\u30bf\u30b0\u304c\u898b\u3064\u304b\u308a\u307e\u3057\u305f: {0}
javadoc.missing=Javadoc \u30b3\u30e1\u30f3\u30c8\u304c\u3042\u308a\u307e\u305b\u3093\u3002
javadoc.noperiod=\u6700\u521d\u306e\u4e00\u6587\u306f\u30d4\u30ea\u30aa\u30c9\u3067\u7d42\u308f\u3089\u306a\u3051\u308c\u3070\u306a\u308a\u307e\u305b\u3093\u3002
javadoc.packageHtml=\u30d1\u30c3\u30b1\u30fc\u30b8\u30c9\u30ad\u30e5\u30e1\u30f3\u30c6\u30fc\u30b7\u30e7\u30f3\u304c\u898b\u3064\u304b\u308a\u307e\u305b\u3093\u3002
javadoc.duplicateTag={0} \u30bf\u30b0\u304c\u91cd\u8907\u3057\u3066\u3044\u307e\u3059\u3002
javadoc.return.expected=@return \u30bf\u30b0\u304c\u5fc5\u8981\u3067\u3059\u3002
javadoc.unclosedhtml=\u9589\u3058\u3066\u3044\u306a\u3044 HTML \u30bf\u30b0\u304c\u898b\u3064\u304b\u308a\u307e\u3057\u305f: {0}
javadoc.unusedTag=''{1}'' \u306b\u5bfe\u3059\u308b\u4f7f\u7528\u3055\u308c\u306a\u3044 {0} \u30bf\u30b0\u3067\u3059\u3002
javadoc.unusedTagGeneral=\u4f7f\u7528\u3055\u308c\u306a\u3044 Javadoc \u30bf\u30b0\u3067\u3059\u3002
type.missingTag=\u30af\u30e9\u30b9\u306e Javadoc \u30b3\u30e1\u30f3\u30c8\u306b {0} \u30bf\u30b0\u304c\u3042\u308a\u307e\u305b\u3093\u3002
type.tagFormat=\u30af\u30e9\u30b9\u306e Javadoc \u30bf\u30b0 {0} \u306f\u30d1\u30bf\u30fc\u30f3 ''{1}'' \u306b\u5408\u81f4\u3057\u306a\u3051\u308c\u3070\u306a\u308a\u307e\u305b\u3093\u3002
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/messages_pt.properties 100644 0 0 1521 11451071613 31355 0 ustar 0 0 javadoc.classInfo=No foi possível obter informaçġes de classe para {0} marca ''{1}''.
javadoc.expectedTag=Esperada a marca {0} para ''{1}''.
javadoc.extrahtml=Marca HTML extra encontrada: {0}
javadoc.incompleteTag=Marca HTML incompleta encontrada: {0}
javadoc.missing=Falta o comentário Javadoc.
javadoc.noperiod=A primeira frase deve acabar num ponto final.
javadoc.packageHtml=Falta o ficheiro de documentaço do pacote.
javadoc.duplicateTag=Marca {0} duplicada.
javadoc.return.expected=Esperava uma marca @return.
javadoc.unclosedhtml=Marca HTML no fechada entrada: {0}
javadoc.unusedTag=Marca {0} no utilizada por ''{1}''.
javadoc.unusedTagGeneral=Marca Javadoc no utilizada.
type.missingTag=Comentário Javadoc de tipo no está presente na marca {0}.
type.tagFormat=Marca Javadoc {0} do tipo deve condizer com o padro ''{1}''
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/messages_tr.properties 100644 0 0 3140 11744664014 31366 0 ustar 0 0 #Generated by ResourceBundle Editor (http://eclipse-rbe.sourceforge.net)
javadoc.classInfo = {0} etiketi ''{1}'' i\u00E7in s\u0131n\u0131f bilgisi al\u0131nam\u0131yor.
javadoc.duplicateTag = {0} etiketi tekrarlanm\u0131\u015F.
javadoc.empty = Javadoc tan\u0131m alan\u0131 bo\u015F b\u0131rak\u0131lm\u0131\u015F.
javadoc.expectedTag = ''{1}'' i\u00E7in {0} etiketi gerekli.
javadoc.extrahtml = Fazladan HTML etiketi bulundu: {0}
javadoc.incompleteTag = Tamamlanmam\u0131\u015F HTML etiketi bulundu: {0}
javadoc.invalidInheritDoc = '{'@inheritDoc'}' etiketi kullan\u0131m\u0131 ge\u00E7ersiz.
javadoc.legacyPackageHtml = Eskide kalan package.html dosyalar\u0131 kald\u0131r\u0131lmal\u0131.
javadoc.missing = Javadoc a\u00E7\u0131klamas\u0131 eksik.
javadoc.noperiod = \u0130lk c\u00FCmle nokta ile bitmeli.
javadoc.packageHtml = Paket dok\u00FCmantasyon dosyas\u0131 eksik.
javadoc.packageInfo = package-info.java dosyas\u0131 eksik.
javadoc.return.expected = @return etiketi eksik.
javadoc.unclosedhtml = Kapat\u0131lmam\u0131\u015F bir HTML etiketi bulundu: {0}
javadoc.unknownTag = Bilinmeyen etiket: ''{0}''.
javadoc.unusedTag = ''{1}'' i\u00E7in kullan\u0131lmayan {0} etiketi mevcut.
javadoc.unusedTagGeneral = Kullan\u0131lmayan Javadoc etiketi.
javadoc.writeTag = {0}={1}
type.missingTag = T\u00FCr i\u00E7in yaz\u0131lan Javadoc a\u00E7\u0131klamas\u0131nda {0} etiketi eksik.
type.tagFormat = T\u00FCr i\u00E7in yaz\u0131lan {0} Javadoc etiketi \u015Fu kal\u0131pta olmal\u0131: ''{1}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/package-info.java 100644 0 0 2231 12026051022 30102 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* Contains the Javadoc checks that are bundled with the main distribution.
*/
package com.puppycrawl.tools.checkstyle.checks.javadoc;
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/TagParser.java 100644 0 0 25402 12026051022 27473 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.javadoc;
import com.google.common.collect.Lists;
import java.util.List;
/**
*
* Helper class used to parse HTML tags or generic type identifiers
* from a single line of text. Just the beginning of the HTML tag
* is located. No attempt is made to parse out the complete tag,
* particularly since some of the tag parameters could be located
* on the following line of text. The hasNextTag and
* nextTag methods are used to iterate through the HTML
* tags or generic type identifiers that were found on the line of text.
*
*
*
* This class isn't really specific to HTML tags. Currently the only HTML
* tag that this class looks specifically for is the HTML comment tag.
* This class helps figure out if a tag exists and if it is well-formed.
* It does not know whether it is valid HTML. This class is also used for
* generics types which looks like opening HTML tags ex: , , ,
* , etc. According to this class they are valid tags.
*
* @author Chris Stillwell
*/
class TagParser
{
/** List of HtmlTags found on the input line of text. */
private final List mTags = Lists.newLinkedList();
/**
* Constructs a TagParser and finds the first tag if any.
* @param aText the line of text to parse.
* @param aLineNo the source line number.
*/
public TagParser(String[] aText, int aLineNo)
{
parseTags(aText, aLineNo);
}
/**
* Returns the next available HtmlTag.
* @return a HtmlTag or null if none available.
* @throws IndexOutOfBoundsException if there are no HtmlTags
* left to return.
*/
public HtmlTag nextTag()
{
return mTags.remove(0);
}
/**
* Indicates if there are any more HtmlTag to retrieve.
* @return true if there are more tags.
*/
public boolean hasNextTag()
{
return (mTags.size() > 0);
}
/**
* Performs lazy initialization on the internal tags List
* and adds the tag.
* @param aTag the HtmlTag to add.
*/
private void add(HtmlTag aTag)
{
mTags.add(aTag);
}
/**
* Parses the text line for any HTML tags and adds them to the internal
* List of tags.
* @param aText the source line to parse.
* @param aLineNo the source line number.
*/
private void parseTags(String[] aText, int aLineNo)
{
final int nLines = aText.length;
Point position = new Point(0, 0);
position = findChar(aText, '<', position);
while (position.getLineNo() < nLines) {
// if this is html comment then skip it
if (isCommentTag(aText, position)) {
position = skipHtmlComment(aText, position);
}
else if (!isTag(aText, position)) {
position = getNextCharPos(aText, position);
}
else {
// find end of tag
final Point endTag = findChar(aText, '>', position);
final boolean incompleteTag = (endTag.getLineNo() >= nLines);
// get tag id (one word)
final String tagId =
(incompleteTag ? "" : getTagId(aText, position));
// is this closed tag
final boolean closedTag =
((endTag.getLineNo() < nLines) && (endTag.getColumnNo() > 0)
&& (aText[endTag.getLineNo()]
.charAt(endTag.getColumnNo() - 1) == '/'));
// add new tag
add(new HtmlTag(tagId,
position.getLineNo() + aLineNo,
position.getColumnNo(),
closedTag,
incompleteTag,
aText[position.getLineNo()]));
position = endTag;
}
position = findChar(aText, '<', position);
}
}
/**
* Checks if the given position is start one for HTML tag.
* @param aText text of javadoc comments.
* @param aPos position to check.
* @return true some HTML tag starts from given position.
*/
private boolean isTag(String[] aText, Point aPos)
{
final int column = aPos.getColumnNo() + 1;
final String text = aText[aPos.getLineNo()];
//Character.isJavaIdentifier... may not be a valid HTML
//identifier but is valid for generics
return ((column < text.length())
&& (Character.isJavaIdentifierStart(text.charAt(column))
|| Character.isJavaIdentifierPart(text.charAt(column))
|| text.charAt(column) == '/')
|| (column >= text.length()));
}
/**
* Parse tag id.
* @param aText text of javadoc comments.
* @param aTagStart start position of the tag
* @return id for given tag
*/
private String getTagId(String[] aText, Point aTagStart)
{
int column = aTagStart.getColumnNo() + 1;
String text = aText[aTagStart.getLineNo()];
if (column >= text.length()) {
return "";
}
if (text.charAt(column) == '/') {
column++;
}
text = text.substring(column).trim();
column = 0;
//Character.isJavaIdentifier... may not be a valid HTML
//identifier but is valid for generics
while (column < text.length()
&& (Character.isJavaIdentifierStart(text.charAt(column))
|| Character.isJavaIdentifierPart(text.charAt(column))))
{
column++;
}
return text.substring(0, column);
}
/**
* If this is a HTML-comments.
* @param aText text of javadoc comments
* @param aPos position to check
* @return true if HTML-comments
* starts form given position.
*/
private boolean isCommentTag(String[] aText, Point aPos)
{
return aText[aPos.getLineNo()].startsWith(""))
{
to = findChar(aText, '>', getNextCharPos(aText, to));
}
return to;
}
/**
* Finds next occurrence of given character.
* @param aText text to search
* @param aChar character to search
* @param aFrom position to start search
* @return position of next occurrence of given character
*/
private Point findChar(String[] aText, char aChar, Point aFrom)
{
Point curr = new Point(aFrom.getLineNo(), aFrom.getColumnNo());
while ((curr.getLineNo() < aText.length)
&& (aText[curr.getLineNo()].charAt(curr.getColumnNo()) != aChar))
{
curr = getNextCharPos(aText, curr);
}
return curr;
}
/**
* Returns position of next comment character, skips
* whitespaces and asterisks.
* @param aText to search.
* @param aFrom location to search from
* @return location of the next character.
*/
private Point getNextCharPos(String[] aText, Point aFrom)
{
int line = aFrom.getLineNo();
int column = aFrom.getColumnNo() + 1;
while ((line < aText.length) && (column >= aText[line].length())) {
// go to the next line
line++;
column = 0;
if (line < aText.length) {
//skip beginning spaces and stars
final String currentLine = aText[line];
while ((column < currentLine.length())
&& (Character.isWhitespace(currentLine.charAt(column))
|| (currentLine.charAt(column) == '*')))
{
column++;
if ((column < currentLine.length())
&& (currentLine.charAt(column - 1) == '*')
&& (currentLine.charAt(column) == '/'))
{
// this is end of comment
column = currentLine.length();
}
}
}
}
return new Point(line, column);
}
/**
* Represents current position in the text.
* @author o_sukholsky
*/
private static final class Point
{
/** line number. */
private final int mLine;
/** column number.*/
private final int mColumn;
/**
* Creates new Point instance.
* @param aLineNo line number
* @param aColumnNo column number
*/
public Point(int aLineNo, int aColumnNo)
{
mLine = aLineNo;
mColumn = aColumnNo;
}
/**
* Getter for line number.
* @return line number of the position.
*/
public int getLineNo()
{
return mLine;
}
/**
* Getter for column number.
* @return column number of the position.
*/
public int getColumnNo()
{
return mColumn;
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/javadoc/WriteTagCheck.java 100644 0 0 17633 12026051022 30276 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.javadoc;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FileContents;
import com.puppycrawl.tools.checkstyle.api.SeverityLevel;
import com.puppycrawl.tools.checkstyle.api.TextBlock;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Utils;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.apache.commons.beanutils.ConversionException;
/**
*
* Outputs a JavaDoc tag as information. Can be used e.g. with the stylesheets
* that sort the report by author name.
* To define the format for a tag, set property tagFormat to a
* regular expression.
* This check uses two different severity levels. The normal one is used for
* reporting when the tag is missing. The additional one (tagSeverity) is used
* for the level of reporting when the tag exists. The default value for
* tagSeverity is info.
*
*
An example of how to configure the check for printing author name is:
*
*
* @author Daniel Grenner
* @version 1.0
*/
public class WriteTagCheck
extends Check
{
/** compiled regexp to match tag **/
private Pattern mTagRE;
/** compiled regexp to match tag content **/
private Pattern mTagFormatRE;
/** regexp to match tag */
private String mTag;
/** regexp to match tag content */
private String mTagFormat;
/** the severity level of found tag reports */
private SeverityLevel mTagSeverityLevel = SeverityLevel.INFO;
/**
* Sets the tag to check.
* @param aTag tag to check
* @throws ConversionException If the tag is not a valid regular exception.
*/
public void setTag(String aTag)
throws ConversionException
{
try {
mTag = aTag;
mTagRE = Utils.getPattern(aTag + "\\s*(.*$)");
}
catch (final PatternSyntaxException e) {
throw new ConversionException("unable to parse " + aTag, e);
}
}
/**
* Set the tag format.
* @param aFormat a String value
* @throws ConversionException unable to parse aFormat
*/
public void setTagFormat(String aFormat)
throws ConversionException
{
try {
mTagFormat = aFormat;
mTagFormatRE = Utils.getPattern(aFormat);
}
catch (final PatternSyntaxException e) {
throw new ConversionException("unable to parse " + aFormat, e);
}
}
/**
* Sets the tag severity level. The string should be one of the names
* defined in the SeverityLevel class.
*
* @param aSeverity The new severity level
* @see SeverityLevel
*/
public final void setTagSeverity(String aSeverity)
{
mTagSeverityLevel = SeverityLevel.getInstance(aSeverity);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.INTERFACE_DEF,
TokenTypes.CLASS_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.ANNOTATION_DEF,
};
}
@Override
public int[] getAcceptableTokens()
{
return new int[] {TokenTypes.INTERFACE_DEF,
TokenTypes.CLASS_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.ANNOTATION_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.CTOR_DEF,
TokenTypes.ENUM_CONSTANT_DEF,
TokenTypes.ANNOTATION_FIELD_DEF,
};
}
@Override
public void visitToken(DetailAST aAST)
{
final FileContents contents = getFileContents();
final int lineNo = aAST.getLineNo();
final TextBlock cmt =
contents.getJavadocBefore(lineNo);
if (cmt == null) {
log(lineNo, "type.missingTag", mTag);
}
else {
checkTag(lineNo, cmt.getText(), mTag, mTagRE, mTagFormatRE,
mTagFormat);
}
}
/**
* Verifies that a type definition has a required tag.
* @param aLineNo the line number for the type definition.
* @param aComment the Javadoc comment for the type definition.
* @param aTag the required tag name.
* @param aTagRE regexp for the full tag.
* @param aFormatRE regexp for the tag value.
* @param aFormat pattern for the tag value.
*/
private void checkTag(
int aLineNo,
String[] aComment,
String aTag,
Pattern aTagRE,
Pattern aFormatRE,
String aFormat)
{
if (aTagRE == null) {
return;
}
int tagCount = 0;
for (int i = 0; i < aComment.length; i++) {
final String s = aComment[i];
final Matcher matcher = aTagRE.matcher(s);
if (matcher.find()) {
tagCount += 1;
final int contentStart = matcher.start(1);
final String content = s.substring(contentStart);
if ((aFormatRE != null) && !aFormatRE.matcher(content).find()) {
log(aLineNo + i - aComment.length, "type.tagFormat", aTag,
aFormat);
}
else {
logTag(aLineNo + i - aComment.length, aTag, content);
}
}
}
if (tagCount == 0) {
log(aLineNo, "type.missingTag", aTag);
}
}
/**
* Log a message.
*
* @param aLine the line number where the error was found
* @param aTag the javdoc tag to be logged
* @param aTagValue the contents of the tag
*
* @see java.text.MessageFormat
*/
protected final void logTag(int aLine, String aTag, String aTagValue)
{
final String originalSeverity = getSeverity();
setSeverity(mTagSeverityLevel.getName());
log(aLine, "javadoc.writeTag", aTag, aTagValue);
setSeverity(originalSeverity);
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/LineSeparatorOption.java 100644 0 0 4433 12026051062 30122 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
/**
* Represents the options for line separator settings.
*
* @author lkuehne
* @see NewlineAtEndOfFileCheck
*/
public enum LineSeparatorOption
{
/** Windows-style line separators. **/
CRLF("\r\n"),
/** Mac-style line separators. **/
CR("\r"),
/** Unix-style line separators. **/
LF("\n"),
/** System default line separators. **/
SYSTEM(System.getProperty("line.separator"));
/** the line separator representation */
private final String mLineSeparator;
/**
* Creates a new LineSeparatorOption instance.
* @param aSep the line separator, e.g. "\r\n"
*/
private LineSeparatorOption(String aSep)
{
mLineSeparator = aSep;
}
/**
* @param aBytes a bytes array to check
* @return if aBytes is equal to the byte representation
* of this line separator
*/
public boolean matches(byte[] aBytes)
{
final String s = new String(aBytes);
return s.equals(mLineSeparator);
}
/**
* @return the length of the file separator,
* e.g. 1 for CR, 2 for CRLF, ...
*/
public int length()
{
return mLineSeparator.length();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/messages.properties 100644 0 0 2127 11451071613 27246 0 ustar 0 0 noNewlineAtEOF=File does not end with a newline.
unable.open=Unable to open ''{0}''.
todo.match=Comment matches to-do format ''{0}''.
upperEll=Should use uppercase ''L''.
illegal.regexp=Line matches the illegal pattern ''{0}''.
required.regexp=Required pattern ''{0}'' missing in file.
duplicate.regexp=Found duplicate pattern ''{0}''.
translation.missingKey=Key ''{0}'' missing.
missing.switch.default=switch without \"default\" clause.
uncommented.main=Uncommented main method found.
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}.
descendant.token.sum.min=Total count of {0} is less than minimum count {1} under ''{2}''.
descendant.token.sum.max=Total count of {0} exceeds maximum count {1} under ''{2}''.
final.parameter=Parameter {0} should be final.
trailing.comments=Don''t use trailing comments.
array.type.style=Array brackets at illegal position.
type.file.mismatch=The name of the outer type and the file do not match.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/messages_de.properties 100644 0 0 1504 11451071613 27714 0 ustar 0 0 noNewlineAtEOF=Datei endet nicht mit einem Zeilenumbruch.
todo.match=Kommentar entspricht to-do-Format ''{0}''.
upperEll=Zur besseren Lesbarkeit sollte ein großes ''L'' verwendet werden.
illegal.regexp=Die Zeile entspricht dem verbotenen Muster ''{0}''.
required.regexp=Keine Zeile entspricht dem Muster ''{0}''.
translation.missingKey=Übersetzung für Schlüssel ''{0}'' fehlt.
missing.switch.default=switch ohne \"default\".
uncommented.main=Unkommentierte main Methode.
descendant.token.min=Anzahl von {2}-Unterknoten ''{3}'' ist {0}, muss mindestens {1} sein.
descendant.token.max=Anzahl von {2}-Unterknoten ''{3}'' ist {0}, darf maximal {1} sein.
final.parameter=Der Parameter {0} sollte als ''final'' deklariert sein.
trailing.comments=Kommentare und Code sollten nicht in einer Zeile gemischt werden.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/messages_es.properties 100644 0 0 1426 11451071613 27736 0 ustar 0 0 noNewlineAtEOF=El fichero no termina con un retorno de carro.
todo.match=El comentario coincide con el formato to-do ''{0}''.
upperEll=Debería usar ''L'' mayúscula.
illegal.regexp=La línea coincide con el patrón ilegal ''{0}''.
required.regexp=El patron requerido ''{0}'' falta en el fichero.
translation.missingKey=La clave ''{0}'' falta.
missing.switch.default=switch sin etiqueta \"default\".
uncommented.main=Se encotró un método main sin comentar.
descendant.token.min=El recuento {0} para ''{2}'' descendientes ''{3}'' es menor que el mínimo {1}.
descendant.token.max=El recuento {0} para ''{2}'' descendientes ''{3}'' excede el máximo {1}.
final.parameter=El parámetro {0} debería ser final.
trailing.comments=No usar comentarios de final de línea.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/messages_fi.properties 100644 0 0 436 11451071613 27705 0 ustar 0 0 noNewlineAtEOF=Tiedosto ei p¤¤ty rivinvaihtoon.
todo.match=Kommentti on to-do formaatin ''{0}'' mukainen.
upperEll=Pit¤¤ olla iso ''L''.
illegal.regexp=Rivi on s¤¤ntĥjenvaistaisen mallin mukainen: ''{0}''.
translation.missingKey=K¤¤nnĥsavain ''{0}'' puuttuu.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/messages_fr.properties 100644 0 0 1766 11451071613 27745 0 ustar 0 0 noNewlineAtEOF=Il manque un caractère NewLine à la fin du fichier
todo.match=Le commentaire correspond au format TODO ''{0}''.
upperEll=Utilisez un ''L'' majuscule pour une meilleure lisibilité.
illegal.regexp=La ligne correspond au motif illégal ''{0}''.
required.regexp=Le motif ''{0}'' attendu dans le fichier est manquant.
translation.missingKey=La traduction du message ''{0}'' est manquante.
missing.switch.default=Il manque le cas \"default\" dans le bloc \"switch\".
uncommented.main=La méthode principale n'est pas commentée.
descendant.token.min=Le nombre de lexèmes ''{3}'' descendant de ''{2}'' est {0}, il devrait être de {1} au minimum.
descendant.token.max=Le nombre de lexèmes ''{3}'' descendant de ''{2}'' est {0}, il devrait être de {1} au maximum.
final.parameter=Le paramètre {0} devrait être final.
trailing.comments=Ne mélangez pas instructions Java et commentaires sur la même ligne.
array.type.style=Les crochets du tableau ne sont pas placés au bon endroit.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/messages_ja.properties 100644 0 0 2154 11451071613 27720 0 ustar 0 0 noNewlineAtEOF=\u30d5\u30a1\u30a4\u30eb\u304c\u65b0\u3057\u3044\u884c\u3067\u7d42\u4e86\u3057\u3066\u3044\u307e\u305b\u3093\u3002
todo.match=\u30b3\u30e1\u30f3\u30c8\u304c to-do \u306e\u5f62\u5f0f ''{0}'' \u306b\u5408\u81f4\u3057\u3066\u3044\u307e\u3059\u3002
upperEll=\u5927\u6587\u5b57\u306e ''L'' \u3092\u4f7f\u7528\u3059\u3079\u304d\u3067\u3059\u3002
illegal.regexp=\u884c\u304c\u4e0d\u6b63\u306a\u30d1\u30bf\u30fc\u30f3 ''{0}'' \u306b\u5408\u81f4\u3057\u307e\u3059\u3002
translation.missingKey=\u30ad\u30fc ''{0}'' \u304c\u3042\u308a\u307e\u305b\u3093\u3002
missing.switch.default=\"default\" \u7bc0\u306e\u7121\u3044 switch \u6587\u3067\u3059\u3002
uncommented.main=\u30b3\u30e1\u30f3\u30c8\u3067\u306f\u306a\u3044 main \u30e1\u30bd\u30c3\u30c9\u304c\u898b\u3064\u304b\u308a\u307e\u3057\u305f\u3002
descendant.token.min=''{2}'' \u306e\u5b50\u5b6b ''{3}'' \u306e\u6570 {0} \u304c\u6700\u5c0f\u6570 {1} \u3092\u6e80\u305f\u3057\u307e\u305b\u3093\u3002
descendant.token.max=''{2}'' \u306e\u5b50\u5b6b ''{3}'' \u306e\u6570 {0} \u304c\u6700\u5927\u6570 {1} \u3092\u8d85\u3048\u3066\u3044\u307e\u3059\u3002
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/messages_pt.properties 100644 0 0 1130 11451071613 27742 0 ustar 0 0 descendant.token.max=Contagem de {0} para ''{2}'' descendente ''{3}'' é excede o número máximo {1}.
descendant.token.min=Contagem de {0} para ''{2}'' descendente ''{3}'' é menos do que o número mínimo {1}.
illegal.regexp=A linha condiz com o padro inválido ''{0}''.
missing.switch.default=switch sem o ramo \"default\".
noNewlineAtEOF=File does not end with a newline.
todo.match=O comentário condiz com o padro de tarefa pendente ''{0}''.
translation.missingKey=Falta a chave ''{0}''.
uncommented.main=Método main no comentado encontrado.
upperEll=Deve ser utilizado um ''L'' maiúsculo.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/messages_tr.properties 100644 0 0 3355 11744664021 27765 0 ustar 0 0 #Generated by ResourceBundle Editor (http://eclipse-rbe.sourceforge.net)
array.type.style = Dizi parantezleri ge\u00E7ersiz konumda bulunuyor.
descendant.token.max = ''{2}'' eleman\u0131ndan t\u00FCremi\u015F ''{3}'' i\u00E7in toplam {0} say\u0131s\u0131 maksimum {1} de\u011Ferinden daha y\u00FCksek.
descendant.token.min = ''{2}'' eleman\u0131ndan t\u00FCremi\u015F ''{3}'' i\u00E7in toplam {0} say\u0131s\u0131 minimum {1} de\u011Ferinden daha d\u00FC\u015F\u00FCk.
descendant.token.sum.max = ''{2}'' alt\u0131ndaki toplam {0} say\u0131s\u0131 maksimum {1} de\u011Ferinden daha y\u00FCksek.
descendant.token.sum.min = ''{2}'' alt\u0131ndaki toplam {0} say\u0131s\u0131 minimum {1} de\u011Ferinden daha d\u00FC\u015F\u00FCk.
duplicate.regexp = Tekrarlanm\u00FD\u00FEbir kal\u0131p bulundu: ''{0}''.
final.parameter = {0} parametresi ''final'' olarak tan\u0131mlanmal\u0131.
illegal.regexp = Sat\u0131rda ge\u00E7ersiz bir kal\u0131p var: ''{0}''.
missing.switch.default = ''default'' durumu olmayan bir ''switch'' mevcut.
noNewlineAtEOF = Dosyan\u0131n sonunda yeni sat\u0131r karakteri yok.
required.regexp = Dosyada olmas\u0131 gereken ''{0}'' kal\u0131b\u0131 yok.
todo.match = A\u00E7\u0131klamalar, ''to-do'' format\u0131 olan ''{0}'' ile \u00E7ak\u0131\u015F\u0131yor.
trailing.comments = \u0130zleyen (trailing) a\u00E7\u0131klamalar kullan\u0131lmamal\u0131d\u0131r.
translation.missingKey = ''{0}'' anahtar\u0131 eksik.
type.file.mismatch = En d\u0131\u015Ftaki t\u00FCr\u00FCn ad\u0131 dosya ad\u0131yla ayn\u0131 de\u011Fil.
unable.open = ''{0}'' a\u00E7\u0131lam\u0131yor.
uncommented.main = ''main'' metoduna a\u00E7\u0131klama girilmeli.
upperEll = B\u00FCy\u00FCk harf ''L'' kullan\u0131lmal\u0131.
././@LongLink 100644 0 0 155 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/AbstractClassCouplingCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/AbstractClassCouplingCh100644 0 0 24453 12026051022 31434 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.metrics;
import com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
import java.util.Set;
/**
* Base class for coupling calculation.
*
* @author Simon Harris
* @author o_sukhodolsky
*/
public abstract class AbstractClassCouplingCheck extends Check
{
/** Class names to ignore. */
private final Set mIgnoredClassNames = Sets.newHashSet();
/** Allowed complexity. */
private int mMax;
/** package of the file we check. */
private String mPackageName;
/** Stack of contexts. */
private final FastStack mContextStack = FastStack.newInstance();
/** Current context. */
private Context mContext;
/**
* Creates new instance of the check.
* @param aDefaultMax default value for allowed complexity.
*/
protected AbstractClassCouplingCheck(int aDefaultMax)
{
setMax(aDefaultMax);
mIgnoredClassNames.add("boolean");
mIgnoredClassNames.add("byte");
mIgnoredClassNames.add("char");
mIgnoredClassNames.add("double");
mIgnoredClassNames.add("float");
mIgnoredClassNames.add("int");
mIgnoredClassNames.add("long");
mIgnoredClassNames.add("short");
mIgnoredClassNames.add("void");
mIgnoredClassNames.add("Boolean");
mIgnoredClassNames.add("Byte");
mIgnoredClassNames.add("Character");
mIgnoredClassNames.add("Double");
mIgnoredClassNames.add("Float");
mIgnoredClassNames.add("Integer");
mIgnoredClassNames.add("Long");
mIgnoredClassNames.add("Object");
mIgnoredClassNames.add("Short");
mIgnoredClassNames.add("String");
mIgnoredClassNames.add("StringBuffer");
mIgnoredClassNames.add("Void");
mIgnoredClassNames.add("ArrayIndexOutOfBoundsException");
mIgnoredClassNames.add("Exception");
mIgnoredClassNames.add("RuntimeException");
mIgnoredClassNames.add("IllegalArgumentException");
mIgnoredClassNames.add("IllegalStateException");
mIgnoredClassNames.add("IndexOutOfBoundsException");
mIgnoredClassNames.add("NullPointerException");
mIgnoredClassNames.add("Throwable");
mIgnoredClassNames.add("SecurityException");
mIgnoredClassNames.add("UnsupportedOperationException");
}
@Override
public final int[] getDefaultTokens()
{
return getRequiredTokens();
}
/** @return allowed complexity. */
public final int getMax()
{
return mMax;
}
/**
* Sets maximul allowed complexity.
* @param aMax allowed complexity.
*/
public final void setMax(int aMax)
{
mMax = aMax;
}
@Override
public final void beginTree(DetailAST aAST)
{
mPackageName = "";
}
/** @return message key we use for log violations. */
protected abstract String getLogMessageId();
@Override
public void visitToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.PACKAGE_DEF:
visitPackageDef(aAST);
break;
case TokenTypes.CLASS_DEF:
case TokenTypes.INTERFACE_DEF:
case TokenTypes.ANNOTATION_DEF:
case TokenTypes.ENUM_DEF:
visitClassDef(aAST);
break;
case TokenTypes.TYPE:
mContext.visitType(aAST);
break;
case TokenTypes.LITERAL_NEW:
mContext.visitLiteralNew(aAST);
break;
case TokenTypes.LITERAL_THROWS:
mContext.visitLiteralThrows(aAST);
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
@Override
public void leaveToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.CLASS_DEF:
case TokenTypes.INTERFACE_DEF:
case TokenTypes.ANNOTATION_DEF:
case TokenTypes.ENUM_DEF:
leaveClassDef();
break;
default:
// Do nothing
}
}
/**
* Stores package of current class we check.
* @param aPkg package definition.
*/
private void visitPackageDef(DetailAST aPkg)
{
final FullIdent ident = FullIdent.createFullIdent(aPkg.getLastChild()
.getPreviousSibling());
mPackageName = ident.getText();
}
/**
* Creates new context for a given class.
* @param aClassDef class definition node.
*/
private void visitClassDef(DetailAST aClassDef)
{
mContextStack.push(mContext);
final String className =
aClassDef.findFirstToken(TokenTypes.IDENT).getText();
mContext = new Context(className,
aClassDef.getLineNo(),
aClassDef.getColumnNo());
}
/** Restores previous context. */
private void leaveClassDef()
{
mContext.checkCoupling();
mContext = mContextStack.pop();
}
/**
* Incapsulates information about class coupling.
*
* @author Simon Harris
* @author o_sukhodolsky
*/
private class Context
{
/**
* Set of referenced classes.
* Sorted by name for predictable error messages in unit tests.
*/
private final Set mReferencedClassNames = Sets.newTreeSet();
/** Own class name. */
private final String mClassName;
/* Location of own class. (Used to log violations) */
/** Line number of class definition. */
private final int mLineNo;
/** Column number of class definition. */
private final int mColumnNo;
/**
* Create new context associated with given class.
* @param aClassName name of the given class.
* @param aLineNo line of class definition.
* @param aColumnNo column of class definition.
*/
public Context(String aClassName, int aLineNo, int aColumnNo)
{
mClassName = aClassName;
mLineNo = aLineNo;
mColumnNo = aColumnNo;
}
/**
* Visits throws clause and collects all exceptions we throw.
* @param aThrows throws to process.
*/
public void visitLiteralThrows(DetailAST aThrows)
{
for (DetailAST childAST = aThrows.getFirstChild();
childAST != null;
childAST = childAST.getNextSibling())
{
if (childAST.getType() != TokenTypes.COMMA) {
addReferencedClassName(childAST);
}
}
}
/**
* Visits type.
* @param aAST type to process.
*/
public void visitType(DetailAST aAST)
{
final String className = CheckUtils.createFullType(aAST).getText();
mContext.addReferencedClassName(className);
}
/**
* Visits NEW.
* @param aAST NEW to process.
*/
public void visitLiteralNew(DetailAST aAST)
{
mContext.addReferencedClassName(aAST.getFirstChild());
}
/**
* Adds new referenced class.
* @param aAST a node which represents referenced class.
*/
private void addReferencedClassName(DetailAST aAST)
{
final String className = FullIdent.createFullIdent(aAST).getText();
addReferencedClassName(className);
}
/**
* Adds new referenced class.
* @param aClassName class name of the referenced class.
*/
private void addReferencedClassName(String aClassName)
{
if (isSignificant(aClassName)) {
mReferencedClassNames.add(aClassName);
}
}
/** Checks if coupling less than allowed or not. */
public void checkCoupling()
{
mReferencedClassNames.remove(mClassName);
mReferencedClassNames.remove(mPackageName + "." + mClassName);
if (mReferencedClassNames.size() > mMax) {
log(mLineNo, mColumnNo, getLogMessageId(),
mReferencedClassNames.size(), getMax(),
mReferencedClassNames.toString());
}
}
/**
* Checks if given class shouldn't be ignored and not from java.lang.
* @param aClassName class to check.
* @return true if we should count this class.
*/
private boolean isSignificant(String aClassName)
{
return (aClassName.length() > 0)
&& !mIgnoredClassNames.contains(aClassName)
&& !aClassName.startsWith("java.lang.");
}
}
}
././@LongLink 100644 0 0 152 12026055133 10246 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/AbstractComplexityCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/AbstractComplexityCheck100644 0 0 13026 12026051021 31477 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.metrics;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.math.BigInteger;
/**
* Base class for checks the calculate complexity based around methods.
*
* @author Simon Harris
* @author Oliver Burn
*/
public abstract class AbstractComplexityCheck
extends Check
{
/** the initial current value */
private static final BigInteger INITIAL_VALUE = BigInteger.ONE;
/** stack of values - all but the current value */
private final FastStack mValueStack = FastStack.newInstance();
/** the current value */
private BigInteger mCurrentValue = BigInteger.ZERO;
/** threshold to report error for */
private int mMax;
/**
* Creates an instance.
* @param aMax the threshold of when to report an error
*/
public AbstractComplexityCheck(int aMax)
{
mMax = aMax;
}
/**
* @return the message ID to log violations with
*/
protected abstract String getMessageID();
/**
* Hook called when visiting a token. Will not be called the method
* definition tokens.
*
* @param aAST the token being visited
*/
protected void visitTokenHook(DetailAST aAST)
{
}
/**
* Hook called when leaving a token. Will not be called the method
* definition tokens.
*
* @param aAST the token being left
*/
protected void leaveTokenHook(DetailAST aAST)
{
}
@Override
public final int[] getRequiredTokens()
{
return new int[] {
TokenTypes.CTOR_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.INSTANCE_INIT,
TokenTypes.STATIC_INIT,
};
}
/** @return the maximum threshold allowed */
public final int getMax()
{
return mMax;
}
/**
* Set the maximum threshold allowed.
*
* @param aMax the maximum threshold
*/
public final void setMax(int aMax)
{
mMax = aMax;
}
@Override
public void visitToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.CTOR_DEF:
case TokenTypes.METHOD_DEF:
case TokenTypes.INSTANCE_INIT:
case TokenTypes.STATIC_INIT:
visitMethodDef();
break;
default:
visitTokenHook(aAST);
}
}
@Override
public void leaveToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.CTOR_DEF:
case TokenTypes.METHOD_DEF:
case TokenTypes.INSTANCE_INIT:
case TokenTypes.STATIC_INIT:
leaveMethodDef(aAST);
break;
default:
leaveTokenHook(aAST);
}
}
/**
* @return the current value
*/
protected final BigInteger getCurrentValue()
{
return mCurrentValue;
}
/**
* Set the current value
* @param aValue the new value
*/
protected final void setCurrentValue(BigInteger aValue)
{
mCurrentValue = aValue;
}
/**
* Increments the current value by a specified amount.
*
* @param aBy the amount to increment by
*/
protected final void incrementCurrentValue(BigInteger aBy)
{
setCurrentValue(getCurrentValue().add(aBy));
}
/** Push the current value on the stack */
protected final void pushValue()
{
mValueStack.push(mCurrentValue);
mCurrentValue = INITIAL_VALUE;
}
/**
* @return pop a value off the stack and make it the current value
*/
protected final BigInteger popValue()
{
mCurrentValue = mValueStack.pop();
return mCurrentValue;
}
/** Process the start of the method definition */
private void visitMethodDef()
{
pushValue();
}
/**
* Process the end of a method definition.
*
* @param aAST the token representing the method definition
*/
private void leaveMethodDef(DetailAST aAST)
{
final BigInteger max = BigInteger.valueOf(mMax);
if (mCurrentValue.compareTo(max) > 0) {
log(aAST, getMessageID(), mCurrentValue, max);
}
popValue();
}
}
././@LongLink 100644 0 0 163 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/BooleanExpressionComplexityCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/BooleanExpressionComple100644 0 0 14577 12026051021 31533 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.metrics;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
/**
* Restricts nested boolean operators (&&, ||, &, | and ^) to
* a specified depth (default = 3).
*
* @author Simon Harris
* @author o_sukhodolsky
*/
public final class BooleanExpressionComplexityCheck extends Check
{
/** Default allowed complexity. */
private static final int DEFAULT_MAX = 3;
/** Stack of contexts. */
private final FastStack mContextStack = FastStack.newInstance();
/** Maximum allowed complexity. */
private int mMax;
/** Current context. */
private Context mContext;
/** Creates new instance of the check. */
public BooleanExpressionComplexityCheck()
{
setMax(DEFAULT_MAX);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.CTOR_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.EXPR,
TokenTypes.LAND,
TokenTypes.BAND,
TokenTypes.LOR,
TokenTypes.BOR,
TokenTypes.BXOR,
};
}
@Override
public int[] getRequiredTokens()
{
return new int[] {
TokenTypes.CTOR_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.EXPR,
};
}
/**
* Getter for maximum allowed complexity.
* @return value of maximum allowed complexity.
*/
public int getMax()
{
return mMax;
}
/**
* Setter for maximum allowed complexity.
* @param aMax new maximum allowed complexity.
*/
public void setMax(int aMax)
{
mMax = aMax;
}
@Override
public void visitToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.CTOR_DEF:
case TokenTypes.METHOD_DEF:
visitMethodDef(aAST);
break;
case TokenTypes.EXPR:
visitExpr();
break;
case TokenTypes.LAND:
case TokenTypes.BAND:
case TokenTypes.LOR:
case TokenTypes.BOR:
case TokenTypes.BXOR:
mContext.visitBooleanOperator();
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
@Override
public void leaveToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.CTOR_DEF:
case TokenTypes.METHOD_DEF:
leaveMethodDef();
break;
case TokenTypes.EXPR:
leaveExpr(aAST);
break;
default:
// Do nothing
}
}
/**
* Creates new context for a given method.
* @param aAST a method we start to check.
*/
private void visitMethodDef(DetailAST aAST)
{
mContextStack.push(mContext);
mContext = new Context(!CheckUtils.isEqualsMethod(aAST));
}
/** Removes old context. */
private void leaveMethodDef()
{
mContext = mContextStack.pop();
}
/** Creates and pushes new context. */
private void visitExpr()
{
mContextStack.push(mContext);
mContext = new Context((mContext == null) || mContext.isChecking());
}
/**
* Restores previous context.
* @param aAST expression we leave.
*/
private void leaveExpr(DetailAST aAST)
{
mContext.checkCount(aAST);
mContext = mContextStack.pop();
}
/**
* Represents context (method/expression) in which we check complexity.
*
* @author Simon Harris
* @author o_sukhodolsky
*/
private class Context
{
/**
* Should we perform check in current context or not.
* Usually false if we are inside equals() method.
*/
private final boolean mChecking;
/** Count of boolean operators. */
private int mCount;
/**
* Creates new instance.
* @param aChecking should we check in current context or not.
*/
public Context(boolean aChecking)
{
mChecking = aChecking;
mCount = 0;
}
/**
* Getter for checking property.
* @return should we check in current context or not.
*/
public boolean isChecking()
{
return mChecking;
}
/** Increases operator counter. */
public void visitBooleanOperator()
{
++mCount;
}
/**
* Checks if we violates maximum allowed complexity.
* @param aAST a node we check now.
*/
public void checkCount(DetailAST aAST)
{
if (mChecking && (mCount > getMax())) {
final DetailAST parentAST = aAST.getParent();
log(parentAST.getLineNo(), parentAST.getColumnNo(),
"booleanExpressionComplexity", mCount, getMax());
}
}
}
}
././@LongLink 100644 0 0 164 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/ClassDataAbstractionCouplingCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/ClassDataAbstractionCou100644 0 0 4147 12026051021 31404 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.metrics;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* This metric measures the number of instantiations of other classes
* within the given class.
*
* @author Simon Harris
* @author o_sukhodolsky
*/
public final class ClassDataAbstractionCouplingCheck
extends AbstractClassCouplingCheck
{
/** Default allowed complexity. */
private static final int DEFAULT_MAX = 7;
/** Creates bew instance of the check. */
public ClassDataAbstractionCouplingCheck()
{
super(DEFAULT_MAX);
setTokens(new String[] {"LITERAL_NEW"});
}
@Override
public int[] getRequiredTokens()
{
return new int[] {
TokenTypes.PACKAGE_DEF,
TokenTypes.CLASS_DEF,
TokenTypes.INTERFACE_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.LITERAL_NEW,
};
}
@Override
protected String getLogMessageId()
{
return "classDataAbstractionCoupling";
}
}
././@LongLink 100644 0 0 155 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/ClassFanOutComplexityCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/ClassFanOutComplexityCh100644 0 0 4362 12026051021 31416 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.metrics;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* The number of other classes a given class relies on. Also the square
* of this has been shown to indicate the amount of maintenence required
* in functional programs (on a file basis) at least.
*
* @author Simon Harris
* @author o_sukhodolsky
*/
public final class ClassFanOutComplexityCheck extends AbstractClassCouplingCheck
{
/** default value of max value. */
private static final int DEFAULT_MAX = 20;
/** Creates new instance of this check. */
public ClassFanOutComplexityCheck()
{
super(DEFAULT_MAX);
}
@Override
public int[] getRequiredTokens()
{
return new int[] {
TokenTypes.PACKAGE_DEF,
TokenTypes.CLASS_DEF,
TokenTypes.INTERFACE_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.TYPE,
TokenTypes.LITERAL_NEW,
TokenTypes.LITERAL_THROWS,
TokenTypes.ANNOTATION_DEF,
};
}
@Override
protected String getLogMessageId()
{
return "classFanOutComplexity";
}
}
././@LongLink 100644 0 0 154 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/CyclomaticComplexityCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/CyclomaticComplexityChe100644 0 0 5563 12026051020 31473 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.metrics;
import java.math.BigInteger;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Checks cyclomatic complexity against a specified limit. The complexity is
* measured by the number of "if", "while", "do", "for", "?:", "catch",
* "switch", "case", "&&" and "||" statements (plus one) in the body of
* the member. It is a measure of the minimum number of possible paths through
* the source and therefore the number of required tests. Generally 1-4 is
* considered good, 5-7 ok, 8-10 consider re-factoring, and 11+ re-factor now!
*
* @author Simon Harris
* @author Oliver Burn
*/
public class CyclomaticComplexityCheck
extends AbstractComplexityCheck
{
/** default allowed complexity */
private static final int DEFAULT_VALUE = 10;
/** Create an instance. */
public CyclomaticComplexityCheck()
{
super(DEFAULT_VALUE);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.CTOR_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.INSTANCE_INIT,
TokenTypes.STATIC_INIT,
TokenTypes.LITERAL_WHILE,
TokenTypes.LITERAL_DO,
TokenTypes.LITERAL_FOR,
TokenTypes.LITERAL_IF,
TokenTypes.LITERAL_CASE,
TokenTypes.LITERAL_CATCH,
TokenTypes.QUESTION,
TokenTypes.LAND,
TokenTypes.LOR,
};
}
@Override
protected final void visitTokenHook(DetailAST aAST)
{
incrementCurrentValue(BigInteger.ONE);
}
@Override
protected final String getMessageID()
{
return "cyclomaticComplexity";
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/JavaNCSSCheck.java 100644 0 0 26222 12026051020 30147 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.metrics;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* This check calculates the Non Commenting Source Statements (NCSS) metric for
* java source files and methods. The check adheres to the JavaNCSS specification
* and gives the same results as the JavaNCSS tool.
*
* The NCSS-metric tries to determine complexity of methods, classes and files
* by counting the non commenting lines. Roughly said this is (nearly)
* equivalent to counting the semicolons and opening curly braces.
*
* @author Lars Ködderitzsch
*/
public class JavaNCSSCheck extends Check
{
/** default constant for max file ncss */
private static final int FILE_MAX_NCSS = 2000;
/** default constant for max file ncss */
private static final int CLASS_MAX_NCSS = 1500;
/** default constant for max method ncss */
private static final int METHOD_MAX_NCSS = 50;
/** maximum ncss for a complete source file */
private int mFileMax = FILE_MAX_NCSS;
/** maximum ncss for a class */
private int mClassMax = CLASS_MAX_NCSS;
/** maximum ncss for a method */
private int mMethodMax = METHOD_MAX_NCSS;
/** list containing the stacked counters */
private FastStack mCounters;
@Override
public int[] getDefaultTokens()
{
return new int[]{
TokenTypes.CLASS_DEF,
TokenTypes.INTERFACE_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.CTOR_DEF,
TokenTypes.INSTANCE_INIT,
TokenTypes.STATIC_INIT,
TokenTypes.PACKAGE_DEF,
TokenTypes.IMPORT,
TokenTypes.VARIABLE_DEF,
TokenTypes.CTOR_CALL,
TokenTypes.SUPER_CTOR_CALL,
TokenTypes.LITERAL_IF,
TokenTypes.LITERAL_ELSE,
TokenTypes.LITERAL_WHILE,
TokenTypes.LITERAL_DO,
TokenTypes.LITERAL_FOR,
TokenTypes.LITERAL_SWITCH,
TokenTypes.LITERAL_BREAK,
TokenTypes.LITERAL_CONTINUE,
TokenTypes.LITERAL_RETURN,
TokenTypes.LITERAL_THROW,
TokenTypes.LITERAL_SYNCHRONIZED,
TokenTypes.LITERAL_CATCH,
TokenTypes.LITERAL_FINALLY,
TokenTypes.EXPR,
TokenTypes.LABELED_STAT,
TokenTypes.LITERAL_CASE,
TokenTypes.LITERAL_DEFAULT,
};
}
@Override
public int[] getRequiredTokens()
{
return new int[]{
TokenTypes.CLASS_DEF,
TokenTypes.INTERFACE_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.CTOR_DEF,
TokenTypes.INSTANCE_INIT,
TokenTypes.STATIC_INIT,
TokenTypes.PACKAGE_DEF,
TokenTypes.IMPORT,
TokenTypes.VARIABLE_DEF,
TokenTypes.CTOR_CALL,
TokenTypes.SUPER_CTOR_CALL,
TokenTypes.LITERAL_IF,
TokenTypes.LITERAL_ELSE,
TokenTypes.LITERAL_WHILE,
TokenTypes.LITERAL_DO,
TokenTypes.LITERAL_FOR,
TokenTypes.LITERAL_SWITCH,
TokenTypes.LITERAL_BREAK,
TokenTypes.LITERAL_CONTINUE,
TokenTypes.LITERAL_RETURN,
TokenTypes.LITERAL_THROW,
TokenTypes.LITERAL_SYNCHRONIZED,
TokenTypes.LITERAL_CATCH,
TokenTypes.LITERAL_FINALLY,
TokenTypes.EXPR,
TokenTypes.LABELED_STAT,
TokenTypes.LITERAL_CASE,
TokenTypes.LITERAL_DEFAULT,
};
}
@Override
public void beginTree(DetailAST aRootAST)
{
mCounters = new FastStack();
//add a counter for the file
mCounters.push(new Counter());
}
@Override
public void visitToken(DetailAST aAST)
{
final int tokenType = aAST.getType();
if ((TokenTypes.CLASS_DEF == tokenType)
|| (TokenTypes.METHOD_DEF == tokenType)
|| (TokenTypes.CTOR_DEF == tokenType)
|| (TokenTypes.STATIC_INIT == tokenType)
|| (TokenTypes.INSTANCE_INIT == tokenType))
{
//add a counter for this class/method
mCounters.push(new Counter());
}
//check if token is countable
if (isCountable(aAST)) {
//increment the stacked counters
for (final Counter c : mCounters) {
c.increment();
}
}
}
@Override
public void leaveToken(DetailAST aAST)
{
final int tokenType = aAST.getType();
if ((TokenTypes.METHOD_DEF == tokenType)
|| (TokenTypes.CTOR_DEF == tokenType)
|| (TokenTypes.STATIC_INIT == tokenType)
|| (TokenTypes.INSTANCE_INIT == tokenType))
{
//pop counter from the stack
final Counter counter = mCounters.pop();
final int count = counter.getCount();
if (count > mMethodMax) {
log(aAST.getLineNo(), aAST.getColumnNo(), "ncss.method",
count, mMethodMax);
}
}
else if (TokenTypes.CLASS_DEF == tokenType) {
//pop counter from the stack
final Counter counter = mCounters.pop();
final int count = counter.getCount();
if (count > mClassMax) {
log(aAST.getLineNo(), aAST.getColumnNo(), "ncss.class",
count, mClassMax);
}
}
}
@Override
public void finishTree(DetailAST aRootAST)
{
//pop counter from the stack
final Counter counter = mCounters.pop();
final int count = counter.getCount();
if (count > mFileMax) {
log(aRootAST.getLineNo(), aRootAST.getColumnNo(), "ncss.file",
count, mFileMax);
}
}
/**
* Sets the maximum ncss for a file.
*
* @param aFileMax
* the maximum ncss
*/
public void setFileMaximum(int aFileMax)
{
mFileMax = aFileMax;
}
/**
* Sets the maximum ncss for a class.
*
* @param aClassMax
* the maximum ncss
*/
public void setClassMaximum(int aClassMax)
{
mClassMax = aClassMax;
}
/**
* Sets the maximum ncss for a method.
*
* @param aMethodMax
* the maximum ncss
*/
public void setMethodMaximum(int aMethodMax)
{
mMethodMax = aMethodMax;
}
/**
* Checks if a token is countable for the ncss metric
*
* @param aAST
* the AST
* @return true if the token is countable
*/
private boolean isCountable(DetailAST aAST)
{
boolean countable = true;
final int tokenType = aAST.getType();
//check if an expression is countable
if (TokenTypes.EXPR == tokenType) {
countable = isExpressionCountable(aAST);
}
//check if an variable definition is countable
else if (TokenTypes.VARIABLE_DEF == tokenType) {
countable = isVariableDefCountable(aAST);
}
return countable;
}
/**
* Checks if a variable definition is countable.
*
* @param aAST the AST
* @return true if the variable definition is countable, false otherwise
*/
private boolean isVariableDefCountable(DetailAST aAST)
{
boolean countable = false;
//count variable defs only if they are direct child to a slist or
// object block
final int parentType = aAST.getParent().getType();
if ((TokenTypes.SLIST == parentType)
|| (TokenTypes.OBJBLOCK == parentType))
{
final DetailAST prevSibling = aAST.getPreviousSibling();
//is countable if no previous sibling is found or
//the sibling is no COMMA.
//This is done because multiple assignment on one line are countes
// as 1
countable = (prevSibling == null)
|| (TokenTypes.COMMA != prevSibling.getType());
}
return countable;
}
/**
* Checks if an expression is countable for the ncss metric.
*
* @param aAST the AST
* @return true if the expression is countable, false otherwise
*/
private boolean isExpressionCountable(DetailAST aAST)
{
boolean countable = true;
//count expressions only if they are direct child to a slist (method
// body, for loop...)
//or direct child of label,if,else,do,while,for
final int parentType = aAST.getParent().getType();
switch (parentType) {
case TokenTypes.SLIST :
case TokenTypes.LABELED_STAT :
case TokenTypes.LITERAL_FOR :
case TokenTypes.LITERAL_DO :
case TokenTypes.LITERAL_WHILE :
case TokenTypes.LITERAL_IF :
case TokenTypes.LITERAL_ELSE :
//don't count if or loop conditions
final DetailAST prevSibling = aAST.getPreviousSibling();
countable = (prevSibling == null)
|| (TokenTypes.LPAREN != prevSibling.getType());
break;
default :
countable = false;
break;
}
return countable;
}
/**
* @author Lars Ködderitzsch
*
* Class representing a counter,
*/
private static class Counter
{
/** the counters internal integer */
private int mIvCount;
/**
* Increments the counter.
*/
public void increment()
{
mIvCount++;
}
/**
* Gets the counters value
*
* @return the counter
*/
public int getCount()
{
return mIvCount;
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/messages.properties 100644 0 0 4430 11451330227 30712 0 ustar 0 0 booleanExpressionComplexity=Boolean expression complexity is {0,number,integer} (max allowed is {1,number,integer}).
classDataAbstractionCoupling=Class Data Abstraction Coupling is {0,number,integer} (max allowed is {1,number,integer}) classes {2}.
classFanOutComplexity=Class Fan-Out Complexity is {0,number,integer} (max allowed is {1,number,integer}).
cyclomaticComplexity=Cyclomatic Complexity is {0,number,integer} (max allowed is {1,number,integer}).
duplicateLiteral=Duplicate instances of literal ''{0}'' are not allowed.
finalField=The field ''{0}'' should be declared final.
illegalAbstractClassName=Name ''{0}'' must match pattern ''{1}''.
illegalCatch=Catching ''{0}'' is not allowed.
illegalThrows=Throwing ''{0}'' is not allowed.
illegalToken=Using ''{0}'' is not allowed.
illegalType=Declaring variables, return values or parameters of type ''{0}'' is not allowed.
junit.methodName=The method ''{0}'' should be named ''{1}''
junit.methodParameters=The method ''{0}'' must be declared with no parameters.
junit.methodPublicAndStatic=The method ''{0}'' must be declared static.
junit.methodPublicOrProtected=The method {0} must be declared public or protected
junit.methodReturnType=The method ''{0}'' must de declared with a void return type.
mutableException=The field ''{0}'' must be declared final.
nestedIfDepth=Nested if-else depth is {0,number,integer} (max allowed is {1,number,integer}).
nestedTryDepth=Nested try depth is {0,number,integer} (max allowed is {1,number,integer}).
npathComplexity=NPath Complexity is {0,number,integer} (max allowed is {1,number,integer}).
packageDeclaration=Missing package declaration.
parameterAssignment=Assignment of parameter ''{0}'' is not allowed.
returnCount=Return count is {0,number,integer} (max allowed is {1,number,integer}).
returnFromCatch=Return from catch is not allowed.
returnFromFinally=Return from finally is not allowed.
throwsCount=Throws count is {0,number,integer} (max allowed is {1,number,integer}).
unusedVariable=Variable ''{0}'' is never used.
ncss.method=NCSS for this method is {0,number,integer} (max allowed is {1,number,integer}).
ncss.class=NCSS for this class is {0,number,integer} (max allowed is {1,number,integer}).
ncss.file=NCSS for this file is {0,number,integer} (max allowed is {1,number,integer}).
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/messages_es.properties 100644 0 0 5017 11451071613 31404 0 ustar 0 0 booleanExpressionComplexity=La complejidad de la expresión lógica es {0,number,integer} (máxima permitida es {1,number,integer}).
classDataAbstractionCoupling=El acoplamiento abstracto de datos entre clases es {0,number,integer} (máximo permitida es {1,number,integer}) clases {2}.
classFanOutComplexity=La complejidad Fan-Out de clase es {0,number,integer} (máxima permitida es {1,number,integer}).
cyclomaticComplexity=La complejidad ciclomática es {0,number,integer} (máxima permitida es {1,number,integer}).
duplicateLiteral=No estan permitidas instancias duplicadas del literal ''{0}''.
finalField=El campo ''{0}'' debería declararse final.
illegalAbstractClassName=El nombre ''{0}'' debe coincidir con el patrón ''{1}''.
illegalCatch=No está permitido capturar la excepción ''{0}''.
illegalThrows=No está permitido lanzar la excepción ''{0}''.
illegalToken=No está permitido usar ''{0}''.
illegalType=No está permitido declarar variables, valores de retorno o parámetros de tipo ''{0}''.
junit.methodName=El método ''{0}'' debería llamarse ''{1}''
junit.methodParameters=El método ''{0}'' debería declararse sin parámetros.
junit.methodPublicAndStatic=El método ''{0}'' debería declararse static.
junit.methodPublicOrProtected=El método {0} debería declararse public o protected
junit.methodReturnType=El método ''{0}'' debería declararse con tipo de retorno void.
mutableException=El campo ''{0}'' debe declararse final.
nestedIfDepth=La profundidad de if-else anidados es {0,number,integer} (máxima permitida es {1,number,integer}).
nestedTryDepth=La profundidad de try anidados es {0,number,integer} (máxima permitida es {1,number,integer}).
npathComplexity=La complejidad NPath es {0,number,integer} (máxima permitida es {1,number,integer}).
packageDeclaration=Falta la declaración de paquete.
parameterAssignment=No está permitido asignar al parámetro ''{0}''.
returnCount=El número de sentencias return es {0,number,integer} (máximo permitido es {1,number,integer}).
returnFromCatch=No esta permitido return desde un catch.
returnFromFinally=No esta permitido return desde un finally.
throwsCount=El número de throw es {0,number,integer} (máximo permitido es {1,number,integer}).
unusedVariable=La variable ''{0}'' no se usa nunca.
ncss.method=El NCSS para este método es {0,number,integer} (máximo permitido es {1,number,integer}).
ncss.class=El NCSS para esta clase es {0,number,integer} (máximo permitido es {1,number,integer}).
ncss.file=El NCSS para este fichero es {0,number,integer} (máximo permitido es {1,number,integer}).
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/messages_fr.properties 100644 0 0 5614 11451071613 31407 0 ustar 0 0 booleanExpressionComplexity=La complexité de l''expression booléenne est de {0,number,integer}, alors que le maximum autorisé est de {1,number,integer}.
classDataAbstractionCoupling=Le DAC (Data Abstraction Coupling) de la classe est de {0,number,integer} alors que le maximum autorisé est de {1,number,integer}.
classFanOutComplexity=Le Fan-Out Complexity de la classe est de {0,number,integer} alors que le maximum autorisé est de {1,number,integer}.
cyclomaticComplexity=La complexité cyclomatique de la classe est de {0,number,integer} alors que le maximum autorisé est de {1,number,integer}.
duplicateLiteral=Utiliser plusieurs fois la même chaîne littérale ''{0}'' est interdit.
finalField=L''attribut ''{0}'' devrait être déclaré final.
illegalAbstractClassName=Le nom ''{0}'' devrait respecter l''expression ''{1}''.
illegalCatch=Il est interdit de catcher l''exception ''{0}''.
illegalThrows=Il est interdit de déclarer l''exception ''{0}''.
illegalToken=Il est interdit d''utiliser ''{0}''.
illegalType=Il est interdit de déclarer des variables, valeurs de retour ou paramètres de type ''{0}''.
junit.methodName=La méthode ''{0}'' devrait être renommée ''{1}''
junit.methodParameters=La méthode ''{0}'' ne devrait pas comporter de paramètres.
junit.methodPublicAndStatic=La méthode ''{0}'' devrait être statique.
junit.methodPublicOrProtected=La méthode {0} devrait être protégée ou publique.
junit.methodReturnType=La méthode ''{0}'' devrait avoir un type de retour \"void\".
mutableException=L''attribut ''{0}'' devrait être déclaré final.
nestedIfDepth=Le nombre de if imbriqués est de {0,number,integer} alors que le maximum autorisé est de {1,number,integer}.
nestedTryDepth=Le nombre de try imbriqués est de {0,number,integer} alors que le maximum autorisé est de {1,number,integer}.
npathComplexity=La complexité NPath est de {0,number,integer} alors que le maximum autorisé est de {1,number,integer}.
packageDeclaration=Déclaration de package manquante.
parameterAssignment=L''affectation du paramètre ''{0}'' est interdit.
returnCount=Le nombre d''instructions return est de {0,number,integer} alors que le maximum autorisé est de {1,number,integer}.
returnFromCatch=Il est interdit de placer une instruction \"return\" dans un bloc \"catch\".
returnFromFinally=Il est interdit de placer une instruction \"return\" dans un bloc \"finally\".
throwsCount=Le nombre d''exceptions déclaré est de {0,number,integer} alors que le maximum autorisé est de {1,number,integer}.
unusedVariable=La variable ''{0}'' n''est jamais utilisée.
ncss.method=La métrique NCSS pour cette méthode vaut {0,number,integer} alors que le maximum autorisé est de {1,number,integer}.
ncss.class=La métrique NCSS pour cette classe vaut {0,number,integer} alors que le maximum autorisé est de {1,number,integer}.
ncss.file=La métrique NCSS pour ce fichier vaut {0,number,integer} alors que le maximum autorisé est de {1,number,integer}.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/messages_tr.properties 100644 0 0 10222 11744664265 31454 0 ustar 0 0 #Generated by ResourceBundle Editor (http://eclipse-rbe.sourceforge.net)
booleanExpressionComplexity = Mant\u0131ksal ifadenin karma\u015F\u0131kl\u0131\u011F\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
classDataAbstractionCoupling = Class Data Abstraction Coupling (CDAC) de\u011Feri {0,number,integer} {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}). Nesnesi olu\u015Fturulan s\u0131n\u0131flar {2}. (CDAC: Bir s\u0131n\u0131f\u0131n, kendinden farkl\u0131 ka\u00E7 s\u0131n\u0131f\u0131n nesnesini olu\u015Fturdu\u011Fu.)
classFanOutComplexity = Class Fan-Out Complexity (CFOC) de\u011Feri {0,number,integer} {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}). (CFOC: Bir s\u0131n\u0131f\u0131n, kendinden ba\u015Fka ka\u00E7 farkl\u0131 s\u0131n\u0131f\u0131 kulland\u0131\u011F\u0131)
cyclomaticComplexity = Cyclomatic Complexity de\u011Feri {0,number,integer} {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}). (Cyclomatic Complexity: Bir metodun, constructorun ya da statik blo\u011Fun m\u00FCmk\u00FCn olan minimum ger\u00E7eklenme yolu say\u0131s\u0131)
duplicateLiteral = ''{0}'' s\u00F6zc\u00FC\u011F\u00FC kod i\u00E7erisinde tekrarlanmamal\u0131, tan\u0131mlan\u0131p \u00F6yle kullan\u0131lmal\u0131.
finalField = ''{0}'' alan\u0131 ''final'' olarak tan\u0131mlanmal\u0131.
illegalAbstractClassName = ''{0}'' s\u0131n\u0131f\u0131n\u0131n ad\u0131 \u015Fu kal\u0131pta olmal\u0131: ''{1}''.
illegalCatch = ''{0}'' istisnas\u0131n\u0131/hatas\u0131n\u0131 yakalamaya izin verilmiyor.
illegalThrows = ''{0}'' istisnas\u0131n\u0131/hatas\u0131n\u0131 f\u0131rlatmaya izin verilmiyor.
illegalToken = ''{0}'' kullanmaya izin verilmiyor.
illegalType = ''{0}'' tipinde de\u011Fi\u015Fkenler, parametreler ya da geri d\u00F6n\u00FC\u015F de\u011Ferleri tan\u0131mlamaya, izin verilmiyor.
junit.methodName = ''{0}'' metodunun ad\u0131 ''{1}'' olmal\u0131.
junit.methodParameters = ''{0}'' metodu parametresiz olarak tan\u0131mlanmal\u0131.
junit.methodPublicAndStatic = ''{0}'' metodu ''static'' olarak tan\u0131mlanmal\u0131.
junit.methodPublicOrProtected = {0} metodu ''public'' ya da ''protected'' olarak tan\u0131mlanmal\u0131.
junit.methodReturnType = ''{0}'' metodunun geri d\u00F6n\u00FC\u015F tipi ''void'' olmal\u0131.
mutableException = ''{0}'' alan\u0131 ''final'' olarak tan\u0131mlanmal\u0131.
ncss.class = Bu s\u0131n\u0131f\u0131n a\u00E7\u0131klama olmayan kaynak kod sat\u0131r\u0131 (NCSS) say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
ncss.file = Bu dosyan\u0131n a\u00E7\u0131klama olmayan kaynak kod sat\u0131r\u0131 (NCSS) say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
ncss.method = Bu metodun a\u00E7\u0131klama olmayan kaynak kod sat\u0131r\u0131 (NCSS) say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
nestedIfDepth = \u0130\u00E7 i\u00E7e kullan\u0131lan ''if-else'' say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
nestedTryDepth = \u0130\u00E7 i\u00E7e kullan\u0131lan ''try'' say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
npathComplexity = NPath Complexity de\u011Feri {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}). (NPath Complexity: Bir metodun m\u00FCmk\u00FCn olan t\u00FCm ger\u00E7eklenme yollar\u0131n\u0131n say\u0131s\u0131)
packageDeclaration = Paket tan\u0131m\u0131 eksik.
parameterAssignment = ''{0}'' parametresine de\u011Fer atanamaz.
returnCount = ''return'' say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
returnFromCatch = ''catch'' ifadesi i\u00E7inde ''return'' kullan\u0131lamaz.
returnFromFinally = ''finally'' ifadesi i\u00E7inde ''return'' kullan\u0131lamaz.
throwsCount = Kullan\u0131lan ''throws'' say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
unusedVariable = ''{0}'' de\u011Fi\u015Fkeni hi\u00E7 kullan\u0131lmam\u0131\u015F.
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/NPathComplexityCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/NPathComplexityCheck.ja100644 0 0 11400 12026051020 31330 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.metrics;
import java.math.BigInteger;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Checks the npath complexity against a specified limit (default = 200).
* The npath metric computes the number of possible execution paths
* through a function. Similar to the cyclomatic complexity but also
* takes into account the nesting of conditional statements and
* multi-part boolean expressions.
*
* @author Simon Harris
* @author o_sukhodolsky
* TODO: For every or: _value += (_orCount * (nestedValue - 1));
* TODO: For every and: ???
*/
public final class NPathComplexityCheck extends AbstractComplexityCheck
{
/** Default allowed complexity. */
private static final int DEFAULT_MAX = 200;
/** Creates new instance of the check. */
public NPathComplexityCheck()
{
super(DEFAULT_MAX);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.CTOR_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.STATIC_INIT,
TokenTypes.INSTANCE_INIT,
TokenTypes.LITERAL_WHILE,
TokenTypes.LITERAL_DO,
TokenTypes.LITERAL_FOR,
TokenTypes.LITERAL_IF,
TokenTypes.LITERAL_ELSE,
TokenTypes.LITERAL_SWITCH,
TokenTypes.LITERAL_CASE,
TokenTypes.LITERAL_TRY,
TokenTypes.LITERAL_CATCH,
TokenTypes.QUESTION,
};
}
@Override
public void visitToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.LITERAL_WHILE:
case TokenTypes.LITERAL_DO:
case TokenTypes.LITERAL_FOR:
case TokenTypes.LITERAL_IF:
case TokenTypes.QUESTION:
case TokenTypes.LITERAL_TRY:
case TokenTypes.LITERAL_SWITCH:
visitMultiplyingConditional();
break;
case TokenTypes.LITERAL_ELSE:
case TokenTypes.LITERAL_CATCH:
case TokenTypes.LITERAL_CASE:
visitAddingConditional();
break;
default:
super.visitToken(aAST);
}
}
@Override
public void leaveToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.LITERAL_WHILE:
case TokenTypes.LITERAL_DO:
case TokenTypes.LITERAL_FOR:
case TokenTypes.LITERAL_IF:
case TokenTypes.QUESTION:
case TokenTypes.LITERAL_TRY:
case TokenTypes.LITERAL_SWITCH:
leaveMultiplyingConditional();
break;
case TokenTypes.LITERAL_ELSE:
case TokenTypes.LITERAL_CATCH:
case TokenTypes.LITERAL_CASE:
leaveAddingConditional();
break;
default:
super.leaveToken(aAST);
}
}
@Override
protected String getMessageID()
{
return "npathComplexity";
}
/** Visits else, catch or case. */
private void visitAddingConditional()
{
pushValue();
}
/** Leaves else, catch or case. */
private void leaveAddingConditional()
{
setCurrentValue(
getCurrentValue().subtract(BigInteger.ONE).add(popValue()));
}
/** Visits while, do, for, if, try, ? (in ?::) or switch. */
private void visitMultiplyingConditional()
{
pushValue();
}
/** Leaves while, do, for, if, try, ? (in ?::) or switch. */
private void leaveMultiplyingConditional()
{
setCurrentValue(
getCurrentValue().add(BigInteger.ONE).multiply(popValue()));
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/package-info.java 100644 0 0 2301 12026051020 30135 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* Contains the Metrics checks that are
* bundled with the main distribution.
*/
package com.puppycrawl.tools.checkstyle.checks.metrics;
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/messages.properties 100644 0 0 315 11451071613 31021 0 ustar 0 0 redundantModifier=Redundant ''{0}'' modifier.
annotation.order=''{0}'' annotation modifier does not preceed non-annotation modifiers.
mod.order=''{0}'' modifier out of order with the JLS suggestions.
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/messages_de.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/messages_de.properties100644 0 0 370 11451071613 31472 0 ustar 0 0 redundantModifier=Überflüssiger Modifier ''{0}''.
annotation.order=''{0}'' Annotation-Modifier sollte vor den anderen Modifiern stehen.
mod.order=Modifier ''{0}'' weicht von der empfohlenen Modifier-Reihenfolge aus der Java-Sprachdefinition ab.
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/messages_es.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/messages_es.properties100644 0 0 340 11451071613 31506 0 ustar 0 0 redundantModifier=Modificador ''{0}'' redundante.
annotation.order=El modificador de anotación ''{0}'' no precede a los modificadores normales.
mod.order=Modificador ''{0}'' desordenado según las sugerencias de la JLS.
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/messages_fi.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/messages_fi.properties100644 0 0 200 11451071613 31470 0 ustar 0 0 redundantModifier=Tarpeeton m¤¤rite: ''{0}''
mod.order=''{0}'' m¤¤rite rikkoo JLS:n suositusten mukaisesen j¤rjestyksen.
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/messages_fr.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/messages_fr.properties100644 0 0 350 11451071613 31507 0 ustar 0 0 redundantModifier=Mot-clef ''{0}'' redondant.
annotation.order=Le modificateur d''annotation ''{0}'' ne précède pas les autres modificateurs.
mod.order=Le mot-clef ''{0}'' n''apparaît pas dans l''ordre préconisé par les JLS.
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/messages_ja.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/messages_ja.properties100644 0 0 320 11451071613 31467 0 ustar 0 0
redundantModifier=\u5197\u9577\u306a ''{0}'' \u4fee\u98fe\u5b50\u3067\u3059\u3002
mod.order=''{0}'' \u4fee\u98fe\u5b50\u304c JLS \u63d0\u6848\u306e\u9806\u5e8f\u306b\u6cbf\u3044\u307e\u305b\u3093\u3002
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/messages_pt.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/messages_pt.properties100644 0 0 172 11451071613 31525 0 ustar 0 0
redundantModifier=Modificador ''{0}'' é redundante.
mod.order=Modificador ''{0}'' fora da orderm sugerida pela JLS.
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/messages_tr.properties checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/messages_tr.properties100644 0 0 533 11744664014 31540 0 ustar 0 0 #Generated by ResourceBundle Editor (http://eclipse-rbe.sourceforge.net)
annotation.order = ''{0}'' anotasyon niteleyicisi, anotasyon olmayan niteleyicilerden \u00F6nce kullan\u0131lmal\u0131.
mod.order = ''{0}'' niteleyicisi, Java taraf\u0131ndan \u00F6nerilen s\u0131rada de\u011Fil.
redundantModifier = Gereksiz ''{0}'' niteleyicisi.
././@LongLink 100644 0 0 146 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/ModifierOrderCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/ModifierOrderCheck.jav100644 0 0 13211 12026051017 31320 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.modifier;
import com.google.common.collect.Lists;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.util.Iterator;
import java.util.List;
/**
*
* In additional, modifiers are checked to ensure all annotations
* are declared before all other modifiers.
*
* Rationale: Code is easier to read if everybody follows
* a standard.
*
*
* An example of how to configure the check is:
*
*
* <module name="ModifierOrder"/>
*
* @author Lars Kühne
*/
public class ModifierOrderCheck
extends Check
{
/**
* The order of modifiers as suggested in sections 8.1.1,
* 8.3.1 and 8.4.3 of the JLS.
*/
private static final String[] JLS_ORDER =
{
"public", "protected", "private", "abstract", "static", "final",
"transient", "volatile", "synchronized", "native", "strictfp",
};
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.MODIFIERS};
}
@Override
public void visitToken(DetailAST aAST)
{
final List mods = Lists.newArrayList();
DetailAST modifier = aAST.getFirstChild();
while (modifier != null) {
mods.add(modifier);
modifier = modifier.getNextSibling();
}
if (!mods.isEmpty()) {
final DetailAST error = checkOrderSuggestedByJLS(mods);
if (error != null) {
if (error.getType() == TokenTypes.ANNOTATION) {
log(error.getLineNo(), error.getColumnNo(),
"annotation.order",
error.getFirstChild().getText()
+ error.getFirstChild().getNextSibling()
.getText());
}
else {
log(error.getLineNo(), error.getColumnNo(),
"mod.order", error.getText());
}
}
}
}
/**
* Checks if the modifiers were added in the order suggested
* in the Java language specification.
*
* @param aModifiers list of modifier AST tokens
* @return null if the order is correct, otherwise returns the offending
* * modifier AST.
*/
DetailAST checkOrderSuggestedByJLS(List aModifiers)
{
int i = 0;
DetailAST modifier;
final Iterator it = aModifiers.iterator();
//No modifiers, no problems
if (!it.hasNext()) {
return null;
}
//Speed past all initial annotations
do {
modifier = it.next();
}
while (it.hasNext() && (modifier.getType() == TokenTypes.ANNOTATION));
//All modifiers are annotations, no problem
if (modifier.getType() == TokenTypes.ANNOTATION) {
return null;
}
while (i < JLS_ORDER.length) {
if (modifier.getType() == TokenTypes.ANNOTATION) {
//Annotation not at start of modifiers, bad
return modifier;
}
while ((i < JLS_ORDER.length)
&& !JLS_ORDER[i].equals(modifier.getText()))
{
i++;
}
if (i == JLS_ORDER.length) {
//Current modifier is out of JLS order
return modifier;
}
else if (!it.hasNext()) {
//Reached end of modifiers without problem
return null;
}
else {
modifier = it.next();
}
}
return modifier;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/package-info.java 100644 0 0 2233 12026051017 30277 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* Contains the modifier checks that are bundled with the main distribution.
*/
package com.puppycrawl.tools.checkstyle.checks.modifier;
././@LongLink 100644 0 0 152 12026055133 10246 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/RedundantModifierCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/modifier/RedundantModifierCheck100644 0 0 11607 12026051017 31421 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.modifier;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Checks for redundant modifiers in interface and annotation definitions.
* Also checks for redundant final modifiers on methods of final classes.
*
* @author lkuehne
*/
public class RedundantModifierCheck
extends Check
{
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.METHOD_DEF,
TokenTypes.VARIABLE_DEF,
TokenTypes.ANNOTATION_FIELD_DEF,
TokenTypes.INTERFACE_DEF,
};
}
@Override
public int[] getRequiredTokens()
{
return new int[] {};
}
@Override
public void visitToken(DetailAST aAST)
{
if (TokenTypes.INTERFACE_DEF == aAST.getType()) {
final DetailAST modifiers =
aAST.findFirstToken(TokenTypes.MODIFIERS);
if (null != modifiers) {
final DetailAST modifier =
modifiers.findFirstToken(TokenTypes.LITERAL_STATIC);
if (null != modifier) {
log(modifier.getLineNo(), modifier.getColumnNo(),
"redundantModifier", modifier.getText());
}
}
}
else if (ScopeUtils.inInterfaceOrAnnotationBlock(aAST)) {
final DetailAST modifiers =
aAST.findFirstToken(TokenTypes.MODIFIERS);
DetailAST modifier = modifiers.getFirstChild();
while (modifier != null) {
// javac does not allow final or static in interface methods
// order annotation fields hence no need to check that this
// is not a method or annotation field
final int type = modifier.getType();
if ((type == TokenTypes.LITERAL_PUBLIC)
|| (type == TokenTypes.ABSTRACT)
|| (type == TokenTypes.LITERAL_STATIC)
|| (type == TokenTypes.FINAL))
{
log(modifier.getLineNo(), modifier.getColumnNo(),
"redundantModifier", modifier.getText());
break;
}
modifier = modifier.getNextSibling();
}
}
else if (aAST.getType() == TokenTypes.METHOD_DEF) {
final DetailAST modifiers =
aAST.findFirstToken(TokenTypes.MODIFIERS);
// private method?
boolean checkFinal =
modifiers.branchContains(TokenTypes.LITERAL_PRIVATE);
// declared in a final class?
DetailAST parent = aAST.getParent();
while (parent != null) {
if (parent.getType() == TokenTypes.CLASS_DEF) {
final DetailAST classModifiers =
parent.findFirstToken(TokenTypes.MODIFIERS);
checkFinal |=
classModifiers.branchContains(TokenTypes.FINAL);
break;
}
parent = parent.getParent();
}
if (checkFinal) {
DetailAST modifier = modifiers.getFirstChild();
while (modifier != null) {
final int type = modifier.getType();
if (type == TokenTypes.FINAL) {
log(modifier.getLineNo(), modifier.getColumnNo(),
"redundantModifier", modifier.getText());
break;
}
modifier = modifier.getNextSibling();
}
}
}
}
}
././@LongLink 100644 0 0 160 12026055133 10245 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/AbstractAccessControlNameCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/AbstractAccessControlNam100644 0 0 12667 12026051017 31424 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.naming;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Abstract class for checking a class member (field/method)'s name conforms to
* a format specified by the format property.
*
*
This class extends {@link AbstractNameCheck} with support for access level
* restrictions. This allows the check to be configured to be applied to one of
* the four Java access levels: {@code public}, {@code protected},
* {@code "package"}, and {@code private}.
*
*
Level is configured using the following properties:
*
*
applyToPublic, default true;
*
applyToProtected, default true;
*
applyToPackage, default true;
*
applyToPrivate, default true;
*
*
*
* @author Rick Giles
* @version 1.0
*/
public abstract class AbstractAccessControlNameCheck
extends AbstractNameCheck
{
/** If true, applies the check be public members. */
private boolean mApplyToPublic = true;
/** If true, applies the check be protected members. */
private boolean mApplyToProtected = true;
/** If true, applies the check be "package" members. */
private boolean mApplyToPackage = true;
/** If true, applies the check be private members. */
private boolean mApplyToPrivate = true;
/**
* Creates a new {@code AbstractAccessControlNameCheck} instance.
*
* @param aFormat
* format to check with
*/
public AbstractAccessControlNameCheck(String aFormat)
{
super(aFormat);
}
@Override
protected boolean mustCheckName(DetailAST aAST)
{
return shouldCheckInScope(aAST);
}
/**
* Should we check member with given modifiers.
*
* @param aModifiers
* modifiers of member to check.
* @return true if we should check such member.
*/
protected boolean shouldCheckInScope(DetailAST aModifiers)
{
if (aModifiers == null) {
// if there are no modifiers it is a package-private
return mApplyToPackage;
}
final boolean isPublic = aModifiers
.branchContains(TokenTypes.LITERAL_PUBLIC);
final boolean isProtected = aModifiers
.branchContains(TokenTypes.LITERAL_PROTECTED);
final boolean isPrivate = aModifiers
.branchContains(TokenTypes.LITERAL_PRIVATE);
final boolean isPackage = !(isPublic || isProtected || isPrivate);
return (mApplyToPublic && isPublic)
|| (mApplyToProtected && isProtected)
|| (mApplyToPackage && isPackage)
|| (mApplyToPrivate && isPrivate);
}
/**
* Sets whether we should apply the check to public members.
*
* @param aApplyTo new value of the property.
*/
public void setApplyToPublic(boolean aApplyTo)
{
mApplyToPublic = aApplyTo;
}
/** @return true if the check should be applied to public members. */
public boolean getApplyToPublic()
{
return mApplyToPublic;
}
/**
* Sets whether we should apply the check to protected members.
*
* @param aApplyTo new value of the property.
*/
public void setApplyToProtected(boolean aApplyTo)
{
mApplyToProtected = aApplyTo;
}
/** @return true if the check should be applied to protected members. */
public boolean getApplyToProtected()
{
return mApplyToProtected;
}
/**
* Sets whether we should apply the check to package-private members.
*
* @param aApplyTo new value of the property.
*/
public void setApplyToPackage(boolean aApplyTo)
{
mApplyToPackage = aApplyTo;
}
/**
* @return true if the check should be applied to package-private members.
*/
public boolean getApplyToPackage()
{
return mApplyToPackage;
}
/**
* Sets whether we should apply the check to private members.
*
* @param aApplyTo new value of the property.
*/
public void setApplyToPrivate(boolean aApplyTo)
{
mApplyToPrivate = aApplyTo;
}
/** @return true if the check should be applied to private members. */
public boolean getApplyToPrivate()
{
return mApplyToPrivate;
}
}
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/AbstractClassNameCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/AbstractClassNameCheck.j100644 0 0 11010 12026051016 31236 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.naming;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck;
/**
*
* Ensures that the names of abstract classes conforming to some
* regular expression and check that abstract modifier exists.
*
*
* Rationale: Abstract classes are convenience base class
* implementations of interfaces, not types as such. As such
* they should be named to indicate this. Also if names of classes
* starts with 'Abstract' it's very convenient that they will
* have abstract modifier.
*
*
* @author Simon Harris
* @author Danil Lopatin
*/
public final class AbstractClassNameCheck extends AbstractFormatCheck
{
/** Default format for abstract class names */
private static final String DEFAULT_FORMAT = "^Abstract.*$|^.*Factory$";
/** whether to ignore checking the modifier */
private boolean mIgnoreModifier;
/** whether to ignore checking the name */
private boolean mIgnoreName;
/** Creates new instance of the check. */
public AbstractClassNameCheck()
{
super(DEFAULT_FORMAT);
}
/**
* Whether to ignore checking for the abstract modifier.
* @param aValue new value
*/
public void setIgnoreModifier(boolean aValue)
{
mIgnoreModifier = aValue;
}
/**
* Whether to ignore checking the name.
* @param aValue new value.
*/
public void setIgnoreName(boolean aValue)
{
mIgnoreName = aValue;
}
@Override
public int[] getDefaultTokens()
{
return new int[]{TokenTypes.CLASS_DEF};
}
@Override
public int[] getRequiredTokens()
{
return getDefaultTokens();
}
@Override
public void visitToken(DetailAST aAST)
{
if (TokenTypes.CLASS_DEF == aAST.getType()) {
visitClassDef(aAST);
}
}
/**
* Checks class definition.
* @param aAST class definition for check.
*/
private void visitClassDef(DetailAST aAST)
{
final String className =
aAST.findFirstToken(TokenTypes.IDENT).getText();
if (isAbstract(aAST)) {
// if class has abstract modifier
if (!mIgnoreName && !isMatchingClassName(className)) {
log(aAST.getLineNo(), aAST.getColumnNo(),
"illegal.abstract.class.name", className, getFormat());
}
}
else if (!mIgnoreModifier && isMatchingClassName(className)) {
log(aAST.getLineNo(), aAST.getColumnNo(),
"no.abstract.class.modifier", className);
}
}
/**
* @param aAST class definition for check.
* @return true if a given class declared as abstract.
*/
private boolean isAbstract(DetailAST aAST)
{
final DetailAST abstractAST = aAST.findFirstToken(TokenTypes.MODIFIERS)
.findFirstToken(TokenTypes.ABSTRACT);
return abstractAST != null;
}
/**
* @param aClassName class name for check.
* @return true if class name matches format of abstract class names.
*/
private boolean isMatchingClassName(String aClassName)
{
return getRegexp().matcher(aClassName).find();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/AbstractNameCheck.java 100644 0 0 4733 12026051016 30736 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.naming;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck;
/**
* Abstract class for checking that names conform to a specified format.
*
* @author Rick Giles
* @version 1.0
*/
public abstract class AbstractNameCheck
extends AbstractFormatCheck
{
/**
* Creates a new AbstractNameCheck instance.
* @param aFormat format to check with
*/
public AbstractNameCheck(String aFormat)
{
super(aFormat);
}
/**
* Decides whether the name of an AST should be checked against
* the format regexp.
* @param aAST the AST to check.
* @return true if the IDENT subnode of aAST should be checked against
* the format regexp.
*/
protected boolean mustCheckName(DetailAST aAST)
{
return true;
}
@Override
public void visitToken(DetailAST aAST)
{
if (mustCheckName(aAST)) {
final DetailAST nameAST = aAST.findFirstToken(TokenTypes.IDENT);
if (!getRegexp().matcher(nameAST.getText()).find()) {
log(nameAST.getLineNo(),
nameAST.getColumnNo(),
"name.invalidPattern",
nameAST.getText(),
getFormat());
}
}
}
}
././@LongLink 100644 0 0 160 12026055133 10245 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/AbstractTypeParameterNameCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/AbstractTypeParameterNam100644 0 0 5456 12026051016 31421 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.naming;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Abstract class for checking if a class/method type parameter's name
* conforms to a format specified by the format property.
*
*
*
This class extends {@link AbstractNameCheck}
*
* @author Travis Schneeberger
* @version 1.0
*/
public abstract class AbstractTypeParameterNameCheck
extends AbstractNameCheck
{
/** the location of the type parameter **/
private int mLocation;
/**
* Creates a new AbstractTypeParameterNameCheck instance.
* @param aFormat format to check with
*/
public AbstractTypeParameterNameCheck(String aFormat)
{
super(aFormat);
}
@Override
public final int[] getDefaultTokens()
{
return new int[] {
TokenTypes.TYPE_PARAMETER,
};
}
@Override
public final void init()
{
this.mLocation = getLocation();
assert (this.mLocation == TokenTypes.CLASS_DEF)
|| (this.mLocation == TokenTypes.METHOD_DEF);
}
@Override
protected final boolean mustCheckName(DetailAST aAST)
{
DetailAST location =
aAST.getParent().getParent();
if (location.getType() == TokenTypes.MODIFIERS) {
location = location.getParent();
}
return location.getType() == this.mLocation;
}
/**
* This method must be overriden to specify the
* location of the type parameter to check.
*
* @return TokenTypes.CLASS_DEF
* or TokenTypes.METHOD_DEF
*/
protected abstract int getLocation();
}
././@LongLink 100644 0 0 155 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/ClassTypeParameterNameCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/ClassTypeParameterNameCh100644 0 0 4230 12026051016 31330 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.naming;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks that class type parameter names conform to a format specified
* by the format property. The format is a
* {@link java.util.regex.Pattern regular expression} and defaults to
* ^[A-Z]$.
*
*
* An example of how to configure the check is:
*
*
* <module name="ClassTypeParameterName"/>
*
*
* An example of how to configure the check for names that are only a single
* letter is
*
*
* @author Travis Schneeberger
* @version 1.0
*/
public class ClassTypeParameterNameCheck
extends AbstractTypeParameterNameCheck
{
/** Creates a new ClassTypeParameterNameCheck instance. */
public ClassTypeParameterNameCheck()
{
super("^[A-Z]$");
}
@Override
protected final int getLocation()
{
return TokenTypes.CLASS_DEF;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/ConstantNameCheck.java 100644 0 0 7077 12026051015 30767 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.naming;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks that constant names conform to a format specified
* by the format property.
* A constant is a static and final
* field or an interface/annotation field, except
* serialVersionUID and serialPersistentFields
* . The format is a regular expression
* and defaults to ^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$.
*
*
* An example of how to configure the check is:
*
*
* <module name="ConstantName"/>
*
*
*
* An example of how to configure the check for names that are only upper case
* letters and digits is:
*
*
*
* @author Rick Giles
* @version 1.0
*/
public class ConstantNameCheck
extends AbstractAccessControlNameCheck
{
/** Creates a new ConstantNameCheck instance. */
public ConstantNameCheck()
{
super("^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$");
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.VARIABLE_DEF};
}
@Override
protected final boolean mustCheckName(DetailAST aAST)
{
boolean retVal = false;
final DetailAST modifiersAST =
aAST.findFirstToken(TokenTypes.MODIFIERS);
final boolean isStatic = (modifiersAST != null)
&& modifiersAST.branchContains(TokenTypes.LITERAL_STATIC);
final boolean isFinal = (modifiersAST != null)
&& modifiersAST.branchContains(TokenTypes.FINAL);
if ((isStatic && isFinal && shouldCheckInScope(modifiersAST))
|| ScopeUtils.inInterfaceOrAnnotationBlock(aAST))
{
// Handle the serialVersionUID and serialPersistentFields constants
// which are used for Serialization. Cannot enforce rules on it. :-)
final DetailAST nameAST = aAST.findFirstToken(TokenTypes.IDENT);
if ((nameAST != null)
&& !("serialVersionUID".equals(nameAST.getText()))
&& !("serialPersistentFields".equals(nameAST.getText())))
{
retVal = true;
}
}
return retVal;
}
}
././@LongLink 100644 0 0 155 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/LocalFinalVariableNameCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/LocalFinalVariableNameCh100644 0 0 5430 12026051015 31234 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.naming;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks that local final variable names conform to a format specified
* by the format property. A catch parameter is considered to be
* a local variable.The format is a
* {@link java.util.regex.Pattern regular expression} and defaults to
* ^[a-z][a-zA-Z0-9]*$.
*
*
* An example of how to configure the check is:
*
*
* <module name="LocalFinalVariableName"/>
*
*
* An example of how to configure the check for names that are only upper case
* letters and digits is:
*
*
* @author Rick Giles
* @version 1.0
*/
public class LocalFinalVariableNameCheck
extends AbstractNameCheck
{
/** Creates a new LocalFinalVariableNameCheck instance. */
public LocalFinalVariableNameCheck()
{
super("^[a-z][a-zA-Z0-9]*$");
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.VARIABLE_DEF,
TokenTypes.PARAMETER_DEF,
};
}
@Override
protected final boolean mustCheckName(DetailAST aAST)
{
final DetailAST modifiersAST =
aAST.findFirstToken(TokenTypes.MODIFIERS);
final boolean isFinal = (modifiersAST != null)
&& modifiersAST.branchContains(TokenTypes.FINAL);
return (isFinal && ScopeUtils.isLocalVariableDef(aAST));
}
}
././@LongLink 100644 0 0 150 12026055133 10244 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/LocalVariableNameCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/LocalVariableNameCheck.j100644 0 0 5464 12026051015 31204 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.naming;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks that local, non-final variable names conform to a format specified
* by the format property. A catch parameter is considered to be
* a local variable. The format is a
* {@link java.util.regex.Pattern regular expression}
* and defaults to
* ^[a-z][a-zA-Z0-9]*$.
*
*
* An example of how to configure the check is:
*
*
* <module name="LocalVariableName"/>
*
*
* An example of how to configure the check for names that begin with a lower
* case letter, followed by letters, digits, and underscores is:
*
* @author Rick Giles
* @version 1.0
*/
public class LocalVariableNameCheck
extends AbstractNameCheck
{
/** Creates a new LocalVariableNameCheck instance. */
public LocalVariableNameCheck()
{
super("^[a-z][a-zA-Z0-9]*$");
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.VARIABLE_DEF,
TokenTypes.PARAMETER_DEF,
};
}
@Override
protected final boolean mustCheckName(DetailAST aAST)
{
final DetailAST modifiersAST =
aAST.findFirstToken(TokenTypes.MODIFIERS);
final boolean isFinal = (modifiersAST != null)
&& modifiersAST.branchContains(TokenTypes.FINAL);
return (!isFinal && ScopeUtils.isLocalVariableDef(aAST));
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/MemberNameCheck.java 100644 0 0 5445 12026051015 30402 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.naming;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks that instance variable names conform to a format specified
* by the format property. The format is a
* {@link java.util.regex.Pattern regular expression}
* and defaults to
* ^[a-z][a-zA-Z0-9]*$.
*
*
* An example of how to configure the check is:
*
*
* <module name="MemberName"/>
*
*
* An example of how to configure the check for names that begin with
* "m", followed by an upper case letter, and then letters and
* digits is:
*
* @author Rick Giles
* @version 1.0
*/
public class MemberNameCheck
extends AbstractAccessControlNameCheck
{
/** Creates a new MemberNameCheck instance. */
public MemberNameCheck()
{
super("^[a-z][a-zA-Z0-9]*$");
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.VARIABLE_DEF};
}
@Override
protected final boolean mustCheckName(DetailAST aAST)
{
final DetailAST modifiersAST =
aAST.findFirstToken(TokenTypes.MODIFIERS);
final boolean isStatic = (modifiersAST != null)
&& modifiersAST.branchContains(TokenTypes.LITERAL_STATIC);
return (!isStatic && !ScopeUtils.inInterfaceOrAnnotationBlock(aAST)
&& !ScopeUtils.isLocalVariableDef(aAST))
&& shouldCheckInScope(modifiersAST);
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/messages.properties 100644 0 0 454 11452563037 30507 0 ustar 0 0 name.invalidPattern=Name ''{0}'' must match pattern ''{1}''.
illegal.abstract.class.name=Name ''{0}'' must match pattern ''{1}''.
method.name.equals.class.name=Method Name ''{0}'' must not equal the enclosing class name.
no.abstract.class.modifier=Class ''{0}'' must be declared as ''abstract''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/messages_de.properties 100644 0 0 230 11451071613 31140 0 ustar 0 0 illegal.abstract.class.name=Klassenname ''{0}'' entspricht nicht dem Muster ''{1}''.
name.invalidPattern=''{0}'' entspricht nicht dem Muster ''{1}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/messages_es.properties 100644 0 0 242 11451071613 31162 0 ustar 0 0 name.invalidPattern=El nombre ''{0}'' debe coincidir con el patrón ''{1}''.
illegal.abstract.class.name=El nombre ''{0}'' debe coincidir con el patrón ''{1}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/messages_fi.properties 100644 0 0 232 11451071613 31150 0 ustar 0 0 name.invalidPattern=Nimen ''{0}'' pit¤¤ olla mallin ''{1}'' mukainen.
illegal.abstract.class.name=Nimen ''{0}'' pit¤¤ olla mallin ''{1}'' mukainen.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/messages_fr.properties 100644 0 0 301 11451071613 31156 0 ustar 0 0 name.invalidPattern=Le nom ''{0}'' n''est pas conforme à l''expression ''{1}''.
illegal.abstract.class.name=Le nom de la classe abstraite ''{0}'' n''est pas conforme à l''expression ''{1}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/messages_ja.properties 100644 0 0 524 11451071613 31150 0 ustar 0 0 name.invalidPattern=\u540d\u524d ''{0}'' \u306f\u30d1\u30bf\u30fc\u30f3 ''{1}'' \u306b\u4e00\u81f4\u3057\u306a\u3051\u308c\u3070\u306a\u308a\u307e\u305b\u3093\u3002
illegal.abstract.class.name=\u540d\u524d ''{0}'' \u306f\u30d1\u30bf\u30fc\u30f3 ''{1}'' \u306b\u4e00\u81f4\u3057\u306a\u3051\u308c\u3070\u306a\u308a\u307e\u305b\u3093\u3002
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/messages_pt.properties 100644 0 0 224 11451071613 31176 0 ustar 0 0 illegal.abstract.class.name=Nome ''{0}'' deve condizer com o padro ''{1}''.
name.invalidPattern=Nome ''{0}'' deve condizer com o padro ''{1}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/messages_tr.properties 100644 0 0 725 11744664014 31216 0 ustar 0 0 #Generated by ResourceBundle Editor (http://eclipse-rbe.sourceforge.net)
illegal.abstract.class.name = ''{0}'' ismi, \u015Fu kal\u0131pta olmal\u0131: ''{1}''.
method.name.equals.class.name = ''{0}'' metodunun ad\u0131 kendini kapsayan t\u00FCr ile ayn\u0131 olmamal\u0131.
name.invalidPattern = ''{0}'' ismi, \u015Fu kal\u0131pta olmal\u0131: ''{1}''.
no.abstract.class.modifier = ''{0}'' s\u0131n\u0131f\u0131 ''abstract'' olarak tan\u0131mlanmal\u0131.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/MethodNameCheck.java 100644 0 0 10776 12026051015 30436 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.naming;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks that method names conform to a format specified
* by the format property. The format is a
* {@link java.util.regex.Pattern regular expression}
* and defaults to
* ^[a-z][a-zA-Z0-9]*$.
*
*
*
* Also, checks if a method name has the same name as the residing class.
* The default is false (it is not allowed). It is legal in Java to have
* method with the same name as a class. As long as a return type is specified
* it is a method and not a constructor which it could be easily confused as.
*
*
*
* An example of how to configure the check is:
*
*
* <module name="MethodName"/>
*
*
* An example of how to configure the check for names that begin with
* a lower case letter, followed by letters, digits, and underscores is:
*
* @author Oliver Burn
* @author Travis Schneeberger
* @version 1.1
*/
public class MethodNameCheck
extends AbstractAccessControlNameCheck
{
/**
* for allowing method name to be the same as the class name.
*/
private boolean mAllowClassName;
/** Creates a new MethodNameCheck instance. */
public MethodNameCheck()
{
super("^[a-z][a-zA-Z0-9]*$");
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.METHOD_DEF, };
}
@Override
public void visitToken(DetailAST aAst)
{
super.visitToken(aAst); // Will check the name against the format.
if (!mAllowClassName) {
final DetailAST method =
aAst.findFirstToken(TokenTypes.IDENT);
//in all cases this will be the classDef type except anon inner
//with anon inner classes this will be the Literal_New keyword
final DetailAST classDefOrNew = aAst.getParent().getParent();
final DetailAST classIdent =
classDefOrNew.findFirstToken(TokenTypes.IDENT);
// Following logic is to handle when a classIdent can not be
// found. This is when you have a Literal_New keyword followed
// a DOT, which is when you have:
// new Outclass.InnerInterface(x) { ... }
// Such a rare case, will not have the logic to handle parsing
// down the tree looking for the first ident.
if ((null != classIdent)
&& method.getText().equals(classIdent.getText()))
{
log(method.getLineNo(), method.getColumnNo(),
"method.name.equals.class.name", method.getText());
}
}
}
/**
* Sets the property for allowing a method to be the same name as a class.
* @param aAllowClassName true to allow false to disallow
*/
public void setAllowClassName(boolean aAllowClassName)
{
mAllowClassName = aAllowClassName;
}
}
././@LongLink 100644 0 0 156 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/MethodTypeParameterNameCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/MethodTypeParameterNameC100644 0 0 4236 12026051014 31337 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.naming;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks that class type parameter names conform to a format specified
* by the format property. The format is a
* {@link java.util.regex.Pattern regular expression} and defaults to
* ^[A-Z]$.
*
*
* An example of how to configure the check is:
*
*
* <module name="MethodTypeParameterName"/>
*
*
* An example of how to configure the check for names that are only a single
* letter is
*
*
* @author Travis Schneeberger
* @version 1.0
*/
public class MethodTypeParameterNameCheck
extends AbstractTypeParameterNameCheck
{
/** Creates a new MethodTypeParameterNameCheck instance. */
public MethodTypeParameterNameCheck()
{
super("^[A-Z]$");
}
@Override
protected final int getLocation()
{
return TokenTypes.METHOD_DEF;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/package-info.java 100644 0 0 2313 12026051013 27745 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* Contains the Naming conventions checks
* that are bundled with the main distribution.
*/
package com.puppycrawl.tools.checkstyle.checks.naming;
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/PackageNameCheck.java 100644 0 0 6742 12026051014 30526 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.naming;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck;
/**
*
* Checks that package names conform to a format specified
* by the format property. The format is a
* {@link java.util.regex.Pattern regular expression}
* and defaults to
* ^[a-z]+(\.[a-zA-Z_][a-zA-Z_0-9]*)*$.
*
*
* The default format has been chosen to match the requirements in the
*
* Java Language specification and the Sun coding conventions.
* However both underscores and uppercase letters are rather uncommon,
* so most projects should probably use
* ^[a-z]+(\.[a-z][a-z0-9]*)*$.
*
*
* An example of how to configure the check is:
*
*
* <module name="PackageName"/>
*
*
* An example of how to configure the check for package names that begin with
* com.puppycrawl.tools.checkstyle is:
*
*
* @author Oliver Burn
* @version 1.0
*/
public class PackageNameCheck
extends AbstractFormatCheck
{
/**
* Creates a new PackageNameCheck instance.
*/
public PackageNameCheck()
{
// Uppercase letters seem rather uncommon, but they're allowed in
// http://java.sun.com/docs/books/jls/
// second_edition/html/packages.doc.html#40169
super("^[a-z]+(\\.[a-zA-Z_][a-zA-Z0-9_]*)*$");
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.PACKAGE_DEF};
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST nameAST = aAST.getLastChild().getPreviousSibling();
final FullIdent full = FullIdent.createFullIdent(nameAST);
if (!getRegexp().matcher(full.getText()).find()) {
log(full.getLineNo(),
full.getColumnNo(),
"name.invalidPattern",
full.getText(),
getFormat());
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/ParameterNameCheck.java 100644 0 0 4712 12026051014 31106 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.naming;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks that parameter names conform to a format specified
* by the format property. The format is a
* {@link java.util.regex.Pattern regular expression}
* and defaults to
* ^[a-z][a-zA-Z0-9]*$.
*
*
* An example of how to configure the check is:
*
*
* <module name="ParameterName"/>
*
*
* An example of how to configure the check for names that begin with
* a lower case letter, followed by letters, digits, and underscores is:
*
*
* @author Oliver Burn
*/
public class ParameterNameCheck
extends AbstractNameCheck
{
/**
* Creates a new ParameterNameCheck instance.
*/
public ParameterNameCheck()
{
super("^[a-z][a-zA-Z0-9]*$");
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.PARAMETER_DEF};
}
@Override
protected boolean mustCheckName(DetailAST aAST)
{
return !(
(aAST.getParent() != null)
&& (aAST.getParent().getType() == TokenTypes.LITERAL_CATCH));
}
}
././@LongLink 100644 0 0 151 12026055133 10245 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/StaticVariableNameCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/StaticVariableNameCheck.100644 0 0 5670 12026051014 31225 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.naming;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks that static, non-final variable names conform to a format specified
* by the format property. The format is a
* {@link java.util.regex.Pattern regular expression} and defaults to
* ^[a-z][a-zA-Z0-9]*$.
*
*
* An example of how to configure the check is:
*
*
* <module name="StaticVariableName"/>
*
*
* An example of how to configure the check for names that begin with
* a lower case letter, followed by letters, digits, and underscores is:
*
* @author Rick Giles
* @version 1.0
*/
public class StaticVariableNameCheck
extends AbstractAccessControlNameCheck
{
/** Creates a new StaticVariableNameCheck instance. */
public StaticVariableNameCheck()
{
super("^[a-z][a-zA-Z0-9]*$");
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.VARIABLE_DEF};
}
@Override
protected final boolean mustCheckName(DetailAST aAST)
{
final DetailAST modifiersAST =
aAST.findFirstToken(TokenTypes.MODIFIERS);
final boolean isStatic = (modifiersAST != null)
&& modifiersAST.branchContains(TokenTypes.LITERAL_STATIC);
final boolean isFinal = (modifiersAST != null)
&& modifiersAST.branchContains(TokenTypes.FINAL);
return (isStatic
&& !isFinal
&& shouldCheckInScope(modifiersAST)
&& !ScopeUtils.inInterfaceOrAnnotationBlock(aAST));
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/naming/TypeNameCheck.java 100644 0 0 4352 12026051014 30107 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.naming;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks that type names conform to a format specified
* by the format property. The format is a
* {@link java.util.regex.Pattern regular expression} and defaults to
* ^[A-Z][a-zA-Z0-9]*$.
*
*
* An example of how to configure the check is:
*
*
* <module name="TypeName"/>
*
*
* An example of how to configure the check for names that begin with
* a lower case letter, followed by letters, digits, and underscores is:
*
* @author Oliver Burn
*/
public class TypeNameCheck
extends AbstractAccessControlNameCheck
{
/**
* Creates a new TypeNameCheck instance.
*/
public TypeNameCheck()
{
super("^[A-Z][a-zA-Z0-9]*$");
}
/** {@inheritDoc} */
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.CLASS_DEF,
TokenTypes.INTERFACE_DEF, };
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/NewlineAtEndOfFileCheck.java 100644 0 0 11146 12026051062 30540 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import com.puppycrawl.tools.checkstyle.api.Utils;
import java.io.File;
import java.io.IOException;
import java.io.RandomAccessFile;
import java.util.List;
import org.apache.commons.beanutils.ConversionException;
/**
*
* Checks that there is a newline at the end of each file.
*
*
* An example of how to configure the check is:
*
*
* <module name="NewlineAtEndOfFile"/>
*
* This will check against the platform-specific default line separator.
*
*
* It is also possible to enforce the use of a specific line-separator across
* platforms, with the 'lineSeparator' property:
*
* Valid values for the 'lineSeparator' property are 'system' (system default),
* 'crlf' (windows), 'cr' (mac) and 'lf' (unix).
*
*
* @author Christopher Lenz
* @author lkuehne
* @version 1.0
*/
public class NewlineAtEndOfFileCheck
extends AbstractFileSetCheck
{
/** the line separator to check against. */
private LineSeparatorOption mLineSeparator = LineSeparatorOption.SYSTEM;
@Override
protected void processFiltered(File aFile, List aLines)
{
// Cannot use aLines as the line separators have been removed!
RandomAccessFile randomAccessFile = null;
try {
randomAccessFile = new RandomAccessFile(aFile, "r");
if (!endsWithNewline(randomAccessFile)) {
log(0, "noNewlineAtEOF", aFile.getPath());
}
}
catch (final IOException e) {
log(0, "unable.open", aFile.getPath());
}
finally {
Utils.closeQuietly(randomAccessFile);
}
}
/**
* Sets the line separator to one of 'crlf', 'lf' or 'cr'.
*
* @param aLineSeparator The line separator to set
* @throws IllegalArgumentException If the specified line separator is not
* one of 'crlf', 'lf' or 'cr'
*/
public void setLineSeparator(String aLineSeparator)
{
try {
mLineSeparator =
Enum.valueOf(LineSeparatorOption.class, aLineSeparator.trim()
.toUpperCase());
}
catch (IllegalArgumentException iae) {
throw new ConversionException("unable to parse " + aLineSeparator,
iae);
}
}
/**
* Checks whether the content provided by the Reader ends with the platform
* specific line separator.
* @param aRandomAccessFile The reader for the content to check
* @return boolean Whether the content ends with a line separator
* @throws IOException When an IO error occurred while reading from the
* provided reader
*/
private boolean endsWithNewline(RandomAccessFile aRandomAccessFile)
throws IOException
{
final int len = mLineSeparator.length();
if (aRandomAccessFile.length() < len) {
return false;
}
aRandomAccessFile.seek(aRandomAccessFile.length() - len);
final byte lastBytes[] = new byte[len];
final int readBytes = aRandomAccessFile.read(lastBytes);
if (readBytes != len) {
throw new IOException("Unable to read " + len + " bytes, got "
+ readBytes);
}
return mLineSeparator.matches(lastBytes);
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/OuterTypeFilenameCheck.java 100644 0 0 5160 12026051062 30516 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.io.File;
/**
* Checks that the outer type name and the file name match.
* @author Oliver Burn
*/
public class OuterTypeFilenameCheck extends Check
{
/** indicates whether the first token has been seen in the file. */
private boolean mSeenFirstToken;
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF,
TokenTypes.ENUM_DEF, TokenTypes.ANNOTATION_DEF,
};
}
@Override
public void beginTree(DetailAST aAST)
{
mSeenFirstToken = false;
}
@Override
public void visitToken(DetailAST aAST)
{
// Only check first declaration
if (mSeenFirstToken) {
return;
}
mSeenFirstToken = true;
final String outerTypeName =
aAST.findFirstToken(TokenTypes.IDENT).getText();
// Calculate the file name without the leading path or
// the trailing .java suffix. Will be lax and just remove whatever
// is after the '.' character.
String fname = getFileContents().getFilename();
fname = fname.substring(fname.lastIndexOf(File.separatorChar) + 1);
fname = fname.replaceAll("\\.[^\\.]*$", "");
if (!(fname.equals(outerTypeName))) {
log(aAST.getLineNo(), "type.file.mismatch");
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/package-info.java 100644 0 0 2211 12026051013 26471 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* Contains the checks that are bundled with the main distribution.
*/
package com.puppycrawl.tools.checkstyle.checks;
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/regexp/CommentSuppressor.java 100644 0 0 3730 12026051013 31156 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.regexp;
import com.puppycrawl.tools.checkstyle.api.FileContents;
/**
* Implementation of a {@link MatchSuppressor} that suppresses based on
* whether in a comment.
* @author Oliver Burn
*/
class CommentSuppressor implements MatchSuppressor
{
/** File contents to check for comments. */
private FileContents mCurrentContents;
/** {@inheritDoc} */
public boolean shouldSuppress(int aStartLineNo, int aStartColNo,
int aEndLineNo, int aEndColNo)
{
return (null != mCurrentContents)
&& mCurrentContents.hasIntersectionWithComment(aStartLineNo,
aStartColNo, aEndLineNo, aEndColNo);
}
/**
* Set the current file contents.
* @param aCurrentContents the new contents.
*/
public void setCurrentContents(FileContents aCurrentContents)
{
mCurrentContents = aCurrentContents;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/regexp/DetectorOptions.java 100644 0 0 13470 12026051013 30615 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.regexp;
import com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter;
import com.puppycrawl.tools.checkstyle.api.Utils;
import java.util.regex.Pattern;
/**
* Options for a detector.
* @author Oliver Burn
*/
class DetectorOptions
{
/**
* Flags to compile a regular expression with.
* See {@link Pattern#flags()}.
*/
private final int mCompileFlags;
/** Used for reporting violations. */
private final AbstractViolationReporter mReporter;
/** Format of the regular expression to check for. */
private String mFormat;
/** The message to report on detection. If blank, then use the format. */
private String mMessage = "";
/** Minimum number of times regular expression should occur in a file. */
private int mMinimum;
/** Maximum number of times regular expression should occur in a file. */
private int mMaximum;
/** Whether to ignore case when matching. */
private boolean mIgnoreCase;
/** Used to determine whether to suppress a detected match. */
private MatchSuppressor mSuppressor = NeverSuppress.INSTANCE;
/**
* Creates an instance.
* @param aCompileFlags the flags to create the regular expression with.
* @param aReporter used to report violations.
*/
public DetectorOptions(int aCompileFlags,
AbstractViolationReporter aReporter)
{
mCompileFlags = aCompileFlags;
mReporter = aReporter;
}
/**
* The format to use when matching lines.
* @param aFormat the format to use when matching lines.
* @return current instance
*/
public DetectorOptions setFormat(String aFormat)
{
mFormat = aFormat;
return this;
}
/**
* Message to use when reporting a match.
* @param aMessage message to use when reporting a match.
* @return current instance.
*/
public DetectorOptions setMessage(String aMessage)
{
mMessage = aMessage;
return this;
}
/**
* Set the minimum allowed number of detections.
* @param aMinimum the minimum allowed number of detections.
* @return current instance
*/
public DetectorOptions setMinimum(int aMinimum)
{
mMinimum = aMinimum;
return this;
}
/**
* Set the maximum allowed number of detections.
* @param aMaximum the maximum allowed number of detections.
* @return current instance
*/
public DetectorOptions setMaximum(int aMaximum)
{
mMaximum = aMaximum;
return this;
}
/**
* Set the suppressor to use.
* @param aSup the suppressor to use.
* @return current instance
*/
public DetectorOptions setSuppressor(MatchSuppressor aSup)
{
mSuppressor = aSup;
return this;
}
/**
* Set whether to ignore case when matching.
* @param aIgnore whether to ignore case when matching.
* @return current instance
*/
public DetectorOptions setIgnoreCase(boolean aIgnore)
{
mIgnoreCase = aIgnore;
return this;
}
/**
* Format of the regular expression.
* @return format of the regular expression.
*/
public String getFormat()
{
return mFormat;
}
/**
* The violation reporter to use.
* @return the violation reporter to use.
*/
public AbstractViolationReporter getReporter()
{
return mReporter;
}
/**
* The message to report errors with.
* @return the message to report errors with.
*/
public String getMessage()
{
return mMessage;
}
/**
* The minimum number of allowed detections.
* @return the minimum number of allowed detections.
*/
public int getMinimum()
{
return mMinimum;
}
/**
* The maximum number of allowed detections.
* @return the maximum number of allowed detections.
*/
public int getMaximum()
{
return mMaximum;
}
/**
* The suppressor to use.
* @return the suppressor to use.
*/
public MatchSuppressor getSuppressor()
{
return mSuppressor;
}
/**
* Whether to ignore case when matching.
* @return whether to ignore case when matching.
*/
public boolean isIgnoreCase()
{
return mIgnoreCase;
}
/**
* The pattern to use when matching.
* @return the pattern to use when matching.
*/
public Pattern getPattern()
{
final int options = (mIgnoreCase) ? mCompileFlags
| Pattern.CASE_INSENSITIVE : mCompileFlags;
return Utils.getPattern(mFormat, options);
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/regexp/MatchSuppressor.java 100644 0 0 3166 12026051012 30612 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.regexp;
/**
* Represents a suppressor for matches.
* @author oliver
*/
interface MatchSuppressor
{
/**
* Checks if the specified selection should be suppressed.
* @param aStartLineNo the starting line number
* @param aStartColNo the starting column number
* @param aEndLineNo the ending line number
* @param aEndColNo the ending column number
* @return true if the positions intersects with a comment.
**/
boolean shouldSuppress(int aStartLineNo, int aStartColNo, int aEndLineNo,
int aEndColNo);
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/regexp/messages.properties 100644 0 0 213 11451071613 30512 0 ustar 0 0 regexp.exceeded=Line matches the illegal pattern ''{0}''.
regexp.minimum=File does not contain at least {0} matches for pattern ''{1}''.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/regexp/messages_tr.properties 100644 0 0 423 11744664014 31232 0 ustar 0 0 #Generated by ResourceBundle Editor (http://eclipse-rbe.sourceforge.net)
regexp.exceeded = Sat\u0131r, ge\u00E7ersiz ''{0}'' kal\u0131b\u0131yla e\u015Fle\u015Fiyor.
regexp.minimum = Dosya, ''{1}'' kal\u0131b\u0131 i\u00E7in en az {0} e\u015Fle\u015Fme i\u00E7ermiyor.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/regexp/MultilineDetector.java 100644 0 0 7331 12026051012 31102 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.regexp;
import java.util.regex.Matcher;
import com.puppycrawl.tools.checkstyle.api.FileText;
import com.puppycrawl.tools.checkstyle.api.LineColumn;
/**
* A detector that matches across multiple lines.
* @author oliver
*/
class MultilineDetector
{
/** The detection options to use. */
private final DetectorOptions mOptions;
/** Tracks the number of matches. */
private int mCurrentMatches;
/** The mMatcher */
private Matcher mMatcher;
/** The file text content */
private FileText mText;
/**
* Creates an instance.
* @param aOptions the options to use.
*/
public MultilineDetector(DetectorOptions aOptions)
{
mOptions = aOptions;
}
/**
* Processes an entire text file looking for matches.
* @param aText the text to process
*/
public void processLines(FileText aText)
{
mText = aText;
resetState();
mMatcher = mOptions.getPattern().matcher(mText.getFullText());
findMatch();
finish();
}
/** recursive method that finds the matches. */
private void findMatch()
{
final boolean foundMatch = mMatcher.find();
if (!foundMatch) {
return;
}
final LineColumn start = mText.lineColumn(mMatcher.start());
final LineColumn end = mText.lineColumn(mMatcher.end());
if (!mOptions.getSuppressor().shouldSuppress(start.getLine(),
start.getColumn(), end.getLine(), end.getColumn()))
{
mCurrentMatches++;
if (mCurrentMatches > mOptions.getMaximum()) {
if ("".equals(mOptions.getMessage())) {
mOptions.getReporter().log(start.getLine(),
"regexp.exceeded", mMatcher.pattern().toString());
}
else {
mOptions.getReporter()
.log(start.getLine(), mOptions.getMessage());
}
}
}
findMatch();
}
/** Perform processing at the end of a set of lines. */
private void finish()
{
if (mCurrentMatches < mOptions.getMinimum()) {
if ("".equals(mOptions.getMessage())) {
mOptions.getReporter().log(0, "regexp.minimum",
mOptions.getMinimum(), mOptions.getFormat());
}
else {
mOptions.getReporter().log(0, mOptions.getMessage());
}
}
}
/**
* Reset the state of the detector.
*/
private void resetState()
{
mCurrentMatches = 0;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/regexp/NeverSuppress.java 100644 0 0 3147 12026051012 30273 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.regexp;
/**
* An implementation of {@link MatchSuppressor} that never suppresses a
* match.
* @author oliver
*/
public final class NeverSuppress implements MatchSuppressor
{
/** The shared instance. */
public static final MatchSuppressor INSTANCE = new NeverSuppress();
/** Stop creation of instances. */
private NeverSuppress()
{
}
/** {@inheritDoc} */
public boolean shouldSuppress(int aStartLineNo, int aStartColNo,
int aEndLineNo, int aEndColNo)
{
return false;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/regexp/package-info.java 100644 0 0 2247 12026051011 27772 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* Contains the regular expression checks that are bundled with the main
* distribution.
*/
package com.puppycrawl.tools.checkstyle.checks.regexp;
././@LongLink 100644 0 0 146 12026055133 10251 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpMultilineCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpMultilineCheck.jav100644 0 0 6273 12026051012 31364 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.regexp;
import java.util.regex.Pattern;
import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import com.puppycrawl.tools.checkstyle.api.FileText;
import java.io.File;
import java.util.List;
/**
* Implementation of a check that looks that matches across multiple lines in
* any file type.
* @author Oliver Burn
*/
public class RegexpMultilineCheck extends AbstractFileSetCheck
{
/** The detection options to use. */
private DetectorOptions mOptions = new DetectorOptions(Pattern.MULTILINE,
this);
/** The detector to use. */
private MultilineDetector mDetector;
@Override
public void beginProcessing(String aCharset)
{
super.beginProcessing(aCharset);
mDetector = new MultilineDetector(mOptions);
}
@Override
protected void processFiltered(File aFile, List aLines)
{
mDetector.processLines(FileText.fromLines(aFile, aLines));
}
/**
* Set the format of the regular expression to match.
* @param aFormat the format of the regular expression to match.
*/
public void setFormat(String aFormat)
{
mOptions.setFormat(aFormat);
}
/**
* Set the message to report for a match.
* @param aMessage the message to report for a match.
*/
public void setMessage(String aMessage)
{
mOptions.setMessage(aMessage);
}
/**
* Set the minimum number of matches required per file.
* @param aMinimum the minimum number of matches required per file.
*/
public void setMinimum(int aMinimum)
{
mOptions.setMinimum(aMinimum);
}
/**
* Set the maximum number of matches required per file.
* @param aMaximum the maximum number of matches required per file.
*/
public void setMaximum(int aMaximum)
{
mOptions.setMaximum(aMaximum);
}
/**
* Set whether to ignore case when matching.
* @param aIgnore whether to ignore case when matching.
*/
public void setIgnoreCase(boolean aIgnore)
{
mOptions.setIgnoreCase(aIgnore);
}
}
././@LongLink 100644 0 0 147 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpSinglelineCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpSinglelineCheck.ja100644 0 0 6030 12026051012 31314 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.regexp;
import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import java.io.File;
import java.util.List;
/**
* Implementation of a check that looks for a single line in any file type.
* @author Oliver Burn
*/
public class RegexpSinglelineCheck extends AbstractFileSetCheck
{
/** The detection options to use. */
private DetectorOptions mOptions = new DetectorOptions(0, this);
/** The detector to use. */
private SinglelineDetector mDetector;
@Override
public void beginProcessing(String aCharset)
{
super.beginProcessing(aCharset);
mDetector = new SinglelineDetector(mOptions);
}
@Override
protected void processFiltered(File aFile, List aLines)
{
mDetector.processLines(aLines);
}
/**
* Set the format of the regular expression to match.
* @param aFormat the format of the regular expression to match.
*/
public void setFormat(String aFormat)
{
mOptions.setFormat(aFormat);
}
/**
* Set the message to report for a match.
* @param aMessage the message to report for a match.
*/
public void setMessage(String aMessage)
{
mOptions.setMessage(aMessage);
}
/**
* Set the minimum number of matches required per file.
* @param aMinimum the minimum number of matches required per file.
*/
public void setMinimum(int aMinimum)
{
mOptions.setMinimum(aMinimum);
}
/**
* Set the maximum number of matches required per file.
* @param aMaximum the maximum number of matches required per file.
*/
public void setMaximum(int aMaximum)
{
mOptions.setMaximum(aMaximum);
}
/**
* Set whether to ignore case when matching.
* @param aIgnore whether to ignore case when matching.
*/
public void setIgnoreCase(boolean aIgnore)
{
mOptions.setIgnoreCase(aIgnore);
}
}
././@LongLink 100644 0 0 153 12026055133 10247 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpSinglelineJavaCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpSinglelineJavaChec100644 0 0 7237 12026051012 31364 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.regexp;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import java.util.Arrays;
/**
* Implementation of a check that looks for a single line in Java files.
* Supports ignoring comments for matches.
* @author Oliver Burn
*/
public class RegexpSinglelineJavaCheck extends Check
{
/** The detection options to use. */
private DetectorOptions mOptions = new DetectorOptions(0, this);
/** The detector to use. */
private SinglelineDetector mDetector;
/** The suppressor to use. */
private final CommentSuppressor mSuppressor = new CommentSuppressor();
@Override
public int[] getDefaultTokens()
{
return new int[0];
}
@Override
public void init()
{
super.init();
mDetector = new SinglelineDetector(mOptions);
}
@Override
public void beginTree(DetailAST aRootAST)
{
mSuppressor.setCurrentContents(getFileContents());
mDetector.processLines(Arrays.asList(getLines()));
}
/**
* Set the format of the regular expression to match.
* @param aFormat the format of the regular expression to match.
*/
public void setFormat(String aFormat)
{
mOptions.setFormat(aFormat);
}
/**
* Set the message to report for a match.
* @param aMessage the message to report for a match.
*/
public void setMessage(String aMessage)
{
mOptions.setMessage(aMessage);
}
/**
* Set the minimum number of matches required per file.
* @param aMinimum the minimum number of matches required per file.
*/
public void setMinimum(int aMinimum)
{
mOptions.setMinimum(aMinimum);
}
/**
* Set the maximum number of matches required per file.
* @param aMaximum the maximum number of matches required per file.
*/
public void setMaximum(int aMaximum)
{
mOptions.setMaximum(aMaximum);
}
/**
* Set whether to ignore case when matching.
* @param aIgnore whether to ignore case when matching.
*/
public void setIgnoreCase(boolean aIgnore)
{
mOptions.setIgnoreCase(aIgnore);
}
/**
* Set whether to ignore comments when matching.
* @param aIgnore whether to ignore comments when matching.
*/
public void setIgnoreComments(boolean aIgnore)
{
if (aIgnore) {
mOptions.setSuppressor(mSuppressor);
}
else {
mOptions.setSuppressor(NeverSuppress.INSTANCE);
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/regexp/SinglelineDetector.java 100644 0 0 10321 12026051011 31241 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.regexp;
import java.util.List;
import java.util.regex.Matcher;
/**
* A detector that matches individual lines.
* @author oliver
*/
class SinglelineDetector
{
/** The detection options to use. */
private final DetectorOptions mOptions;
/** Tracks the number of matches. */
private int mCurrentMatches;
/**
* Creates an instance.
* @param aOptions the options to use.
*/
public SinglelineDetector(DetectorOptions aOptions)
{
mOptions = aOptions;
}
/**
* Processes a set of lines looking for matches.
* @param aLines the lines to process.
*/
public void processLines(List aLines)
{
resetState();
int lineno = 0;
for (String line : aLines) {
lineno++;
checkLine(lineno, line, mOptions.getPattern().matcher(line), 0);
}
finish();
}
/** Perform processing at the end of a set of lines. */
private void finish()
{
if (mCurrentMatches < mOptions.getMinimum()) {
if ("".equals(mOptions.getMessage())) {
mOptions.getReporter().log(0, "regexp.minimum",
mOptions.getMinimum(), mOptions.getFormat());
}
else {
mOptions.getReporter().log(0, mOptions.getMessage());
}
}
}
/**
* Reset the state of the detector.
*/
private void resetState()
{
mCurrentMatches = 0;
}
/**
* Check a line for matches.
* @param aLineno the line number of the line to check
* @param aLine the line to check
* @param aMatcher the matcher to use
* @param aStartPosition the position to start searching from.
*/
private void checkLine(int aLineno, String aLine, Matcher aMatcher,
int aStartPosition)
{
final boolean foundMatch = aMatcher.find(aStartPosition);
if (!foundMatch) {
return;
}
// match is found, check for intersection with comment
final int startCol = aMatcher.start(0);
final int endCol = aMatcher.end(0);
// Note that Matcher.end(int) returns the offset AFTER the
// last matched character, but shouldSuppress()
// needs column number of the last character.
// So we need to use (endCol - 1) here.
if (mOptions.getSuppressor()
.shouldSuppress(aLineno, startCol, aLineno, endCol - 1))
{
if (endCol < aLine.length()) {
// check if the expression is on the rest of the line
checkLine(aLineno, aLine, aMatcher, endCol);
}
return; // end processing here
}
mCurrentMatches++;
if (mCurrentMatches > mOptions.getMaximum()) {
if ("".equals(mOptions.getMessage())) {
mOptions.getReporter().log(aLineno, "regexp.exceeded",
aMatcher.pattern().toString());
}
else {
mOptions.getReporter().log(aLineno, mOptions.getMessage());
}
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/RegexpCheck.java 100644 0 0 20313 12026051061 26363 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import com.google.common.collect.Lists;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FileContents;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
*
* A check that makes sure that a specified pattern exists (or not) in the file.
*
*
* An example of how to configure the check to make sure a copyright statement
* is included in the file (but without requirements on where in the file
* it should be):
*
* @author Stan Quinn
*/
public class RegexpCheck extends AbstractFormatCheck
{
/** Default duplicate limit */
private static final int DEFAULT_DUPLICATE_LIMIT = -1;
/** Default error report limit */
private static final int DEFAULT_ERROR_LIMIT = 100;
/** Error count exceeded message */
private static final String ERROR_LIMIT_EXCEEDED_MESSAGE =
"The error limit has been exceeded, "
+ "the check is aborting, there may be more unreported errors.";
/** Custom message for report. */
private String mMessage = "";
/** Ignore matches within comments? **/
private boolean mIgnoreComments;
/** Pattern illegal? */
private boolean mIllegalPattern;
/** Error report limit */
private int mErrorLimit = DEFAULT_ERROR_LIMIT;
/** Disallow more than x duplicates? */
private int mDuplicateLimit;
/** Boolean to say if we should check for duplicates. */
private boolean mCheckForDuplicates;
/** Tracks number of matches made */
private int mMatchCount;
/** Tracks number of errors */
private int mErrorCount;
/** Relates StringBuffer positions to line # and column */
private final List mCharacters = Lists.newArrayList();
/** The mMatcher */
private Matcher mMatcher;
/**
* Instantiates an new RegexpCheck.
*/
public RegexpCheck()
{
super("$^", Pattern.MULTILINE); // the empty language
}
/**
* Setter for message property.
* @param aMessage custom message which should be used in report.
*/
public void setMessage(String aMessage)
{
mMessage = (aMessage == null) ? "" : aMessage;
}
/**
* Getter for message property.
* I'm not sure if this gets used by anything outside,
* I just included it because GenericIllegalRegexp had it,
* it's being used in logMessage() so it's covered in EMMA.
* @return custom message to be used in report.
*/
public String getMessage()
{
return mMessage;
}
/**
* Sets if matches within comments should be ignored.
* @param aIgnoreComments True if comments should be ignored.
*/
public void setIgnoreComments(boolean aIgnoreComments)
{
mIgnoreComments = aIgnoreComments;
}
/**
* Sets if pattern is illegal, otherwise pattern is required.
* @param aIllegalPattern True if pattern is not allowed.
*/
public void setIllegalPattern(boolean aIllegalPattern)
{
mIllegalPattern = aIllegalPattern;
}
/**
* Sets the limit on the number of errors to report.
* @param aErrorLimit the number of errors to report.
*/
public void setErrorLimit(int aErrorLimit)
{
mErrorLimit = aErrorLimit;
}
/**
* Sets the maximum number of instances of required pattern allowed.
* @param aDuplicateLimit negative values mean no duplicate checking,
* any positive value is used as the limit.
*/
public void setDuplicateLimit(int aDuplicateLimit)
{
mDuplicateLimit = aDuplicateLimit;
mCheckForDuplicates = (mDuplicateLimit > DEFAULT_DUPLICATE_LIMIT);
}
@Override
public int[] getDefaultTokens()
{
return new int[0];
}
@Override
public void beginTree(DetailAST aRootAST)
{
mCharacters.clear();
final Pattern pattern = getRegexp();
final String[] lines = getLines();
final StringBuffer sb = new StringBuffer();
for (int i = 0; i < lines.length; i++) {
sb.append(lines[i]);
sb.append('\n');
for (int j = 0; j < (lines[i].length() + 1); j++) {
mCharacters.add(new Integer[] {i + 1, j});
}
}
mMatcher = pattern.matcher(sb.toString());
mMatchCount = 0;
mErrorCount = 0;
findMatch();
}
/** recursive method that finds the matches. */
private void findMatch()
{
int startLine;
int startColumn;
int endLine;
int endColumn;
boolean foundMatch;
boolean ignore = false;
foundMatch = mMatcher.find();
if (!foundMatch && !mIllegalPattern && (mMatchCount == 0)) {
logMessage(0);
}
else if (foundMatch) {
startLine = (mCharacters.get(mMatcher.start()))[0].
intValue();
startColumn = (mCharacters.get(mMatcher.start()))[1].
intValue();
endLine = (mCharacters.get(mMatcher.end() - 1))[0].
intValue();
endColumn = (mCharacters.get(mMatcher.end() - 1))[1].
intValue();
if (mIgnoreComments) {
final FileContents theFileContents = getFileContents();
ignore = theFileContents.hasIntersectionWithComment(startLine,
startColumn, endLine, endColumn);
}
if (!ignore) {
mMatchCount++;
if (mIllegalPattern || (mCheckForDuplicates
&& ((mMatchCount - 1) > mDuplicateLimit)))
{
mErrorCount++;
logMessage(startLine);
}
}
if ((mErrorCount < mErrorLimit)
&& (ignore || mIllegalPattern || mCheckForDuplicates))
{
findMatch();
}
}
}
/**
* Displays the right message.
* @param aLineNumber the line number the message relates to.
*/
private void logMessage(int aLineNumber)
{
String message = "".equals(getMessage()) ? getFormat() : mMessage;
if (mErrorCount >= mErrorLimit) {
message = ERROR_LIMIT_EXCEEDED_MESSAGE + message;
}
if (mIllegalPattern) {
log(aLineNumber, "illegal.regexp", message);
}
else {
if (aLineNumber > 0) {
log(aLineNumber, "duplicate.regexp", message);
}
else {
log(aLineNumber, "required.regexp", message);
}
}
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/AnonInnerLengthCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/AnonInnerLengthCheck.java100644 0 0 6344 12026051011 31302 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.sizes;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks for long anonymous inner classes.
*
*
* Rationale: If an anonymous inner class becomes very long
* it is hard to understand and to see the flow of the method
* where the class is defined. Therefore long anonymous inner
* classes should usually be refactored into a named inner class.
* See also Bloch, Effective Java, p. 93.
*
*
* The default maximum anonymous inner class length is 20 lines.
* To change the maximum number of lines, set property max.
*
*
* An example of how to configure the check is:
*
*
* <module name="AnonInnerLength"/>
*
*
* An example of how to configure the check so that it accepts anonymous
* inner classes with up to 60 lines is:
*
*
* @author Rob Worth
*/
public class AnonInnerLengthCheck extends Check
{
/** default maximum number of lines */
private static final int DEFAULT_MAX = 20;
/** maximum number of lines */
private int mMax = DEFAULT_MAX;
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.LITERAL_NEW};
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST openingBrace = aAST.findFirstToken(TokenTypes.OBJBLOCK);
if (openingBrace != null) {
final DetailAST closingBrace =
openingBrace.findFirstToken(TokenTypes.RCURLY);
final int length =
closingBrace.getLineNo() - openingBrace.getLineNo() + 1;
if (length > mMax) {
log(aAST.getLineNo(), aAST.getColumnNo(), "maxLen.anonInner",
length, mMax);
}
}
}
/**
* @param aLength the maximum length of an anonymous inner class.
*/
public void setMax(int aLength)
{
mMax = aLength;
}
}
././@LongLink 100644 0 0 156 12026055133 10252 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/ExecutableStatementCountCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/ExecutableStatementCountC100644 0 0 15000 12026051011 31462 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.sizes;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
* Restricts the number of executable statements to a specified limit
* (default = 30).
* @author Simon Harris
*/
public final class ExecutableStatementCountCheck
extends Check
{
/** default threshold */
private static final int DEFAULT_MAX = 30;
/** threshold to report error for */
private int mMax;
/** Stack of method contexts. */
private final FastStack mContextStack = FastStack.newInstance();
/** Current method context. */
private Context mContext;
/** Constructs a ExecutableStatementCountCheck. */
public ExecutableStatementCountCheck()
{
setMax(DEFAULT_MAX);
}
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.CTOR_DEF,
TokenTypes.METHOD_DEF,
TokenTypes.INSTANCE_INIT,
TokenTypes.STATIC_INIT,
TokenTypes.SLIST,
};
}
@Override
public int[] getRequiredTokens()
{
return new int[] {TokenTypes.SLIST};
}
/**
* Gets the maximum threshold.
* @return the maximum threshold.
*/
public int getMax()
{
return mMax;
}
/**
* Sets the maximum threshold.
* @param aMax the maximum threshold.
*/
public void setMax(int aMax)
{
mMax = aMax;
}
@Override
public void beginTree(DetailAST aRootAST)
{
mContext = null;
mContextStack.clear();
}
@Override
public void visitToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.CTOR_DEF:
case TokenTypes.METHOD_DEF:
case TokenTypes.INSTANCE_INIT:
case TokenTypes.STATIC_INIT:
visitMemberDef(aAST);
break;
case TokenTypes.SLIST:
visitSlist(aAST);
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
@Override
public void leaveToken(DetailAST aAST)
{
switch (aAST.getType()) {
case TokenTypes.CTOR_DEF:
case TokenTypes.METHOD_DEF:
case TokenTypes.INSTANCE_INIT:
case TokenTypes.STATIC_INIT:
leaveMemberDef(aAST);
break;
case TokenTypes.SLIST:
// Do nothing
break;
default:
throw new IllegalStateException(aAST.toString());
}
}
/**
* Process the start of the member definition.
* @param aAST the token representing the member definition.
*/
private void visitMemberDef(DetailAST aAST)
{
mContextStack.push(mContext);
mContext = new Context(aAST);
}
/**
* Process the end of a member definition.
*
* @param aAST the token representing the member definition.
*/
private void leaveMemberDef(DetailAST aAST)
{
final int count = mContext.getCount();
if (count > getMax()) {
log(aAST.getLineNo(), aAST.getColumnNo(),
"executableStatementCount", count, getMax());
}
mContext = mContextStack.pop();
}
/**
* Process the end of a statement list.
*
* @param aAST the token representing the statement list.
*/
private void visitSlist(DetailAST aAST)
{
if (mContext != null) {
// find member AST for the statement list
final DetailAST contextAST = mContext.getAST();
DetailAST parent = aAST.getParent();
while (parent != null) {
final int type = parent.getType();
if ((type == TokenTypes.CTOR_DEF)
|| (type == TokenTypes.METHOD_DEF)
|| (type == TokenTypes.INSTANCE_INIT)
|| (type == TokenTypes.STATIC_INIT))
{
if (parent == contextAST) {
mContext.addCount(aAST.getChildCount() / 2);
}
break;
}
parent = parent.getParent();
}
}
}
/**
* Class to encapsulate counting information about one member.
* @author Simon Harris
*/
private static class Context
{
/** Member AST node. */
private final DetailAST mAST;
/** Counter for context elements. */
private int mCount;
/**
* Creates new member context.
* @param aAST member AST node.
*/
public Context(DetailAST aAST)
{
mAST = aAST;
mCount = 0;
}
/**
* Increase count.
* @param aCount the count increment.
*/
public void addCount(int aCount)
{
mCount += aCount;
}
/**
* Gets the member AST node.
* @return the member AST node.
*/
public DetailAST getAST()
{
return mAST;
}
/**
* Gets the count.
* @return the count.
*/
public int getCount()
{
return mCount;
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/FileLengthCheck.java 100644 0 0 5143 12026051011 30266 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.sizes;
import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import java.io.File;
import java.util.List;
/**
*
* Checks for long source files.
*
*
* Rationale: If a source file becomes very long it is hard to understand.
* Therefore long classes should usually be refactored into several
* individual classes that focus on a specific task.
*
*
* The default maximum file length is 2000 lines. To change the maximum
* number of lines, set property max.
*
*
* An example of how to configure the check is:
*
*
* <module name="FileLength"/>
*
*
* An example of how to configure the check so that it accepts files with at
* most 1500 lines is:
*
* @author Lars Kühne
*/
public class FileLengthCheck extends AbstractFileSetCheck
{
/** default maximum number of lines */
private static final int DEFAULT_MAX_LINES = 2000;
/** the maximum number of lines */
private int mMaxFileLength = DEFAULT_MAX_LINES;
@Override
protected void processFiltered(File aFile, List aLines)
{
if (aLines.size() > mMaxFileLength) {
log(1, "maxLen.file", aLines.size(), mMaxFileLength);
}
}
/**
* @param aLength the maximum length of a Java source file
*/
public void setMax(int aLength)
{
mMaxFileLength = aLength;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/LineLengthCheck.java 100644 0 0 11036 12026051010 30313 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.sizes;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.Utils;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.apache.commons.beanutils.ConversionException;
/**
* Checks for long lines.
*
*
* Rationale: Long lines are hard to read in printouts or if developers
* have limited screen space for the source code, e.g. if the IDE displays
* additional information like project tree, class hierarchy, etc.
*
*
*
* Note: Support for the special handling of imports in CheckStyle Version 2
* has been dropped as it is a special case of regexp: The user can set
* the ignorePattern to "^import" and achieve the same effect.
*
*
* The default maximum allowable line length is 80 characters. To change the
* maximum, set property max.
*
*
* To ignore lines in the check, set property ignorePattern to a regular
* expression for the lines to ignore.
*
*
* An example of how to configure the check is:
*
*
* <module name="LineLength"/>
*
*
An example of how to configure the check to accept lines up to 120
* characters long is:
*
*
* @author Lars Kühne
*/
public class LineLengthCheck extends Check
{
/** default maximum number of columns in a line */
private static final int DEFAULT_MAX_COLUMNS = 80;
/** the maximum number of columns in a line */
private int mMax = DEFAULT_MAX_COLUMNS;
/** the regexp when long lines are ignored */
private Pattern mIgnorePattern;
/**
* Creates a new LineLengthCheck instance.
*/
public LineLengthCheck()
{
setIgnorePattern("^$");
}
@Override
public int[] getDefaultTokens()
{
return new int[0];
}
@Override
public void beginTree(DetailAST aRootAST)
{
final String[] lines = getLines();
for (int i = 0; i < lines.length; i++) {
final String line = lines[i];
final int realLength = Utils.lengthExpandedTabs(
line, line.length(), getTabWidth());
if ((realLength > mMax)
&& !mIgnorePattern.matcher(line).find())
{
log(i + 1, "maxLineLen", mMax, realLength);
}
}
}
/**
* @param aLength the maximum length of a line
*/
public void setMax(int aLength)
{
mMax = aLength;
}
/**
* Set the ignore pattern.
* @param aFormat a String value
* @throws ConversionException unable to parse aFormat
*/
public void setIgnorePattern(String aFormat)
throws ConversionException
{
try {
mIgnorePattern = Utils.getPattern(aFormat);
}
catch (final PatternSyntaxException e) {
throw new ConversionException("unable to parse " + aFormat, e);
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/messages.properties 100644 0 0 2275 11744232233 30411 0 ustar 0 0 executableStatementCount=Executable statement count is {0,number,integer} (max allowed is {1,number,integer}).
maxLen.file=File length is {0,number,integer} lines (max allowed is {1,number,integer}).
maxLen.method=Method length is {0,number,integer} lines (max allowed is {1,number,integer}).
maxLen.anonInner=Anonymous inner class length is {0,number,integer} lines (max allowed is {1,number,integer}).
maxLineLen=Line is longer than {0,number,integer} characters (found {1,number,integer}).
maxOuterTypes=Outer types defined is {0,number,integer} (max allowed is {1,number,integer}).
maxParam=More than {0,number,integer} parameters (found {1,number,integer}).
too.many.privateMethods=Number of private methods is {0,number,integer} (max allowed is {1,number,integer}).
too.many.packageMethods=Number of package methods is {0,number,integer} (max allowed is {1,number,integer}).
too.many.protectedMethods=Number of protected methods is {0,number,integer} (max allowed is {1,number,integer}).
too.many.publicMethods=Number of public methods is {0,number,integer} (max allowed is {1,number,integer}).
too.many.methods=Total number of methods is {0,number,integer} (max allowed is {1,number,integer}).
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/messages_de.properties 100644 0 0 1036 11451071613 31051 0 ustar 0 0 executableStatementCount=Anzahl ausführbarer Statements ist {0,number,integer} (Obergrenze ist {1,number,integer}).
maxLen.file=Datei ist {0,number,integer} Zeilen lang, erlaubt sind höchstens {1,number,integer}.
maxLen.method=Methode ist {0,number,integer} Zeilen lang, erlaubt sind höchstens {1,number,integer}.
maxLen.anonInner=Anonyme innere Klasse ist {0,number,integer} Zeilen lang, erlaubt sind höchstens ({1,number,integer}.
maxLineLen=Zeile länger als {0,number,integer} Zeichen
maxParam=Mehr als {0,number,integer} Parameter.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/messages_es.properties 100644 0 0 1101 11451071613 31061 0 ustar 0 0 executableStatementCount=El número de sentencias ejecutables es {0,number,integer} (máximo permitido es {1,number,integer}).
maxLen.file=El tamaño del fichero es {0,number,integer} líneas (máximas permitidas {1,number,integer}).
maxLen.method=El tamaño del método es {0,number,integer} líneas (máximas permitidas {1,number,integer}).
maxLen.anonInner=El tamaño de la clase interna anónima es {0,number,integer} líneas (máximas permitidas {1,number,integer}).
maxLineLen=La línea es mayor de {0,number,integer} caracteres.
maxParam=Más de {0,number,integer} parámetros.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/messages_fi.properties 100644 0 0 476 11451071613 31046 0 ustar 0 0 maxLen.file=Tiedoston pituus on {0,number,integer} rivi¤ (suurin sallittu on {1,number,integer}).
maxLen.method=Metodin pituus on {0,number,integer} rivi¤ (suurin sallittu on {1,number,integer}).
maxLineLen=Rivi on pidempi kuin {0,number,integer} merkki¤.
maxParam=Enemm¤n kuin {0,number,integer} parametri¤.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/messages_fr.properties 100644 0 0 1207 11451071613 31070 0 ustar 0 0 executableStatementCount=Le nombre d''instructions est de {0,number,integer} alors que le maximum autorisé est de {1,number,integer}.
maxLen.file=Le fichier contient {0,number,integer} lignes alors que le maximum autorisé est de {1,number,integer}.
maxLen.method=La méthode contient {0,number,integer} lignes alors que le maximum autorisé est de {1,number,integer}.
maxLen.anonInner=La classe interne anonyme contient {0,number,integer} lignes alors que le maximum autorisé est de {1,number,integer}.
maxLineLen=La ligne excède {0,number,integer} caractères.
maxParam=La méthode ou le constructeur a plus de {0,number,integer} paramètres.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/messages_ja.properties 100644 0 0 1640 11451071613 31054 0 ustar 0 0 executableStatementCount=\u5b9f\u884c\u6587\u304c {0,number,integer} \u3042\u308a\u307e\u3059\uff08\u6700\u5927 {1,number,integer} \u307e\u3067\uff09\u3002
maxLen.file=\u30d5\u30a1\u30a4\u30eb\u304c {0,number,integer} \u884c\u3042\u308a\u307e\u3059\uff08\u6700\u5927 {1,number,integer} \u884c\u307e\u3067\uff09\u3002
maxLen.method=\u30e1\u30bd\u30c3\u30c9\u304c {0,number,integer} \u884c\u3042\u308a\u307e\u3059\uff08\u6700\u5927 {1,number,integer} \u884c\u307e\u3067\uff09\u3002
maxLen.anonInner=\u7121\u540d\u30a4\u30f3\u30ca\u30fc\u30af\u30e9\u30b9\u306e\u9577\u3055\u304c {0,number,integer} \u884c\u3042\u308a\u307e\u3059\uff08\u6700\u5927 {1,number,integer} \u884c\u307e\u3067\uff09\u3002
maxLineLen=\u884c\u304c {0,number,integer} \u6587\u5b57\u3092\u8d85\u3048\u3066\u3044\u307e\u3059\u3002
maxParam=\u30d1\u30e9\u30e1\u30fc\u30bf\u6570\u304c {0,number,integer} \u3092\u8d85\u3048\u3066\u3044\u307e\u3059\u3002
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/messages_pt.properties 100644 0 0 1034 11451071613 31102 0 ustar 0 0 executableStatementCount=Número de declaraçġes executáveis é {0,number,integer} (máx. permitido so {1,number,integer}).
maxLen.anonInner=Classe interna anóima tem {0,number,integer} linhas (máx. permitido so {1,number,integer}).
maxLen.file=Ficheiro tem {0,number,integer} linhas (máx. permitido so {1,number,integer}).
maxLen.method=Método tem {0,number,integer} linhas (máx. permitido so {1,number,integer}).
maxLineLen=Linha contém mais do que {0,number,integer} caracteres.
maxParam=Mais do que {0,number,integer} parâmetros.
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/messages_tr.properties 100644 0 0 3206 11744664014 31117 0 ustar 0 0 #Generated by ResourceBundle Editor (http://eclipse-rbe.sourceforge.net)
executableStatementCount = Y\u00FCr\u00FCt\u00FClebilir ifade say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
maxLen.anonInner = \u0130simsiz i\u00E7 s\u0131n\u0131f uzunlu\u011Fu {0,number,integer} sat\u0131r (maksimum izin verilen de\u011Fer {1,number,integer}).
maxLen.file = Dosya uzunlu\u011Fu {0,number,integer} sat\u0131r (maksimum izin verilen de\u011Fer {1,number,integer}).
maxLen.method = Metot uzunlu\u011Fu {0,number,integer} sat\u0131r (maksimum izin verilen de\u011Fer {1,number,integer}).
maxLineLen = Sat\u0131r {0,number,integer} de\u011Ferinden daha uzun.
maxOuterTypes = Tan\u0131mlanan d\u0131\u015F t\u00FCr say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
maxParam = {0,number,integer} de\u011Ferinden daha fazla parametre mevcut.
too.many.methods = Toplam metot say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
too.many.packageMethods = Toplam ''package'' eri\u015Fimli metot say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
too.many.privateMethods = Toplam ''private'' metot say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
too.many.protectedMethods = Toplam ''protected'' metot say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
too.many.publicMethods = Toplam ''public'' metot say\u0131s\u0131 {0,number,integer} (maksimum izin verilen de\u011Fer {1,number,integer}).
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/MethodCountCheck.java 100644 0 0 20222 12026051010 30510 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.sizes;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.Scope;
import com.puppycrawl.tools.checkstyle.api.ScopeUtils;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import java.util.EnumMap;
/**
* Counts the methods of the type-definition and checks whether this
* count is higher than the configured limit.
* @author Alexander Jesse
* @author Oliver Burn
*/
public final class MethodCountCheck extends Check
{
/**
* Marker class used to collect data about the number of methods per
* class. Objects of this class are used on the Stack to count the
* methods for each class and layer.
*/
private static class MethodCounter
{
/** Maintains the counts. */
private final EnumMap mCounts =
new EnumMap(Scope.class);
/** indicated is an interface, in which case all methods are public */
private final boolean mInInterface;
/** tracks the total. */
private int mTotal;
/**
* Creates an interface.
* @param aInInterface indicated if counter for an interface. In which
* case, add all counts as public methods.
*/
MethodCounter(boolean aInInterface)
{
mInInterface = aInInterface;
}
/**
* Increments to counter by one for the supplied scope.
* @param aScope the scope counter to increment.
*/
void increment(Scope aScope)
{
mTotal++;
if (mInInterface) {
mCounts.put(Scope.PUBLIC, 1 + value(Scope.PUBLIC));
}
else {
mCounts.put(aScope, 1 + value(aScope));
}
}
/**
* @return the value of a scope counter
* @param aScope the scope counter to get the value of
*/
int value(Scope aScope)
{
final Integer value = mCounts.get(aScope);
return (null == value) ? 0 : value;
}
/** @return the total number of methods. */
int getTotal()
{
return mTotal;
}
};
/** default maximum number of methods */
private static final int DEFAULT_MAX_METHODS = 100;
/** Maximum private methods. */
private int mMaxPrivate = DEFAULT_MAX_METHODS;
/** Maximum package methods. */
private int mMaxPackage = DEFAULT_MAX_METHODS;
/** Maximum protected methods. */
private int mMaxProtected = DEFAULT_MAX_METHODS;
/** Maximum public methods. */
private int mMaxPublic = DEFAULT_MAX_METHODS;
/** Maximum total number of methods. */
private int mMaxTotal = DEFAULT_MAX_METHODS;
/** Maintains stack of counters, to support inner types. */
private final FastStack mCounters =
new FastStack();
@Override
public int[] getDefaultTokens()
{
return new int[] {
TokenTypes.CLASS_DEF,
TokenTypes.ENUM_CONSTANT_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.INTERFACE_DEF,
TokenTypes.METHOD_DEF,
};
}
@Override
public void visitToken(DetailAST aAST)
{
if ((TokenTypes.CLASS_DEF == aAST.getType())
|| (TokenTypes.INTERFACE_DEF == aAST.getType())
|| (TokenTypes.ENUM_CONSTANT_DEF == aAST.getType())
|| (TokenTypes.ENUM_DEF == aAST.getType()))
{
mCounters.push(new MethodCounter(
TokenTypes.INTERFACE_DEF == aAST.getType()));
}
else if (TokenTypes.METHOD_DEF == aAST.getType()) {
raiseCounter(aAST);
}
}
@Override
public void leaveToken(DetailAST aAST)
{
if ((TokenTypes.CLASS_DEF == aAST.getType())
|| (TokenTypes.INTERFACE_DEF == aAST.getType())
|| (TokenTypes.ENUM_CONSTANT_DEF == aAST.getType())
|| (TokenTypes.ENUM_DEF == aAST.getType()))
{
final MethodCounter counter = mCounters.pop();
checkCounters(counter, aAST);
}
}
/**
* Determine the visibility modifier and raise the corresponding counter.
* @param aMethod
* The method-subtree from the AbstractSyntaxTree.
*/
private void raiseCounter(DetailAST aMethod)
{
final MethodCounter actualCounter = mCounters.peek();
final DetailAST temp = aMethod.findFirstToken(TokenTypes.MODIFIERS);
final Scope scope = ScopeUtils.getScopeFromMods(temp);
actualCounter.increment(scope);
}
/**
* Check the counters and report violations.
* @param aCounter the method counters to check
* @param aAst to report errors against.
*/
private void checkCounters(MethodCounter aCounter, DetailAST aAst)
{
checkMax(mMaxPrivate, aCounter.value(Scope.PRIVATE),
"too.many.privateMethods", aAst);
checkMax(mMaxPackage, aCounter.value(Scope.PACKAGE),
"too.many.packageMethods", aAst);
checkMax(mMaxProtected, aCounter.value(Scope.PROTECTED),
"too.many.protectedMethods", aAst);
checkMax(mMaxPublic, aCounter.value(Scope.PUBLIC),
"too.many.publicMethods", aAst);
checkMax(mMaxTotal, aCounter.getTotal(), "too.many.methods", aAst);
}
/**
* Utility for reporting if a maximum has been exceeded.
* @param aMax the maximum allowed value
* @param aValue the actual value
* @param aMsg the message to log. Takes two arguments of value and maximum.
* @param aAst the AST to associate with the message.
*/
private void checkMax(int aMax, int aValue, String aMsg, DetailAST aAst)
{
if (aMax < aValue) {
log(aAst.getLineNo(), aMsg, aValue, aMax);
}
}
/**
* Sets the maximum allowed private methods per type.
* @param aValue the maximum allowed.
*/
public void setMaxPrivate(int aValue)
{
mMaxPrivate = aValue;
}
/**
* Sets the maximum allowed package methods per type.
* @param aValue the maximum allowed.
*/
public void setMaxPackage(int aValue)
{
mMaxPackage = aValue;
}
/**
* Sets the maximum allowed protected methods per type.
* @param aValue the maximum allowed.
*/
public void setMaxProtected(int aValue)
{
mMaxProtected = aValue;
}
/**
* Sets the maximum allowed public methods per type.
* @param aValue the maximum allowed.
*/
public void setMaxPublic(int aValue)
{
mMaxPublic = aValue;
}
/**
* Sets the maximum total methods per type.
* @param aValue the maximum allowed.
*/
public void setMaxTotal(int aValue)
{
mMaxTotal = aValue;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/MethodLengthCheck.java 100644 0 0 7563 12026051010 30636 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.sizes;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FileContents;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks for long methods.
*
*
* Rationale: If a method becomes very long it is hard to understand.
* Therefore long methods should usually be refactored into several
* individual methods that focus on a specific task.
*
*
* The default maximum method length is 150 lines. To change the maximum
* number of lines, set property max.
*
*
* An example of how to configure the check is:
*
*
* <module name="MethodLength"/>
*
*
* An example of how to configure the check so that it accepts methods with at
* most 60 lines is:
*
* @author Lars Kühne
*/
public class MethodLengthCheck extends Check
{
/** whether to ignore empty lines and single line comments */
private boolean mCountEmpty = true;
/** default maximum number of lines */
private static final int DEFAULT_MAX_LINES = 150;
/** the maximum number of lines */
private int mMax = DEFAULT_MAX_LINES;
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.METHOD_DEF, TokenTypes.CTOR_DEF};
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST openingBrace = aAST.findFirstToken(TokenTypes.SLIST);
if (openingBrace != null) {
final DetailAST closingBrace =
openingBrace.findFirstToken(TokenTypes.RCURLY);
int length =
closingBrace.getLineNo() - openingBrace.getLineNo() + 1;
if (!mCountEmpty) {
final FileContents contents = getFileContents();
final int lastLine = closingBrace.getLineNo();
for (int i = openingBrace.getLineNo() - 1; i < lastLine; i++) {
if (contents.lineIsBlank(i) || contents.lineIsComment(i)) {
length--;
}
}
}
if (length > mMax) {
log(aAST.getLineNo(), aAST.getColumnNo(), "maxLen.method",
length, mMax);
}
}
}
/**
* @param aLength the maximum length of a method.
*/
public void setMax(int aLength)
{
mMax = aLength;
}
/**
* @param aCountEmpty whether to count empty and single line comments
* of the form //.
*/
public void setCountEmpty(boolean aCountEmpty)
{
mCountEmpty = aCountEmpty;
}
}
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/OuterTypeNumberCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/OuterTypeNumberCheck.java100644 0 0 5056 12026051010 31360 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.sizes;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.api.Check;
/**
* Checks for the number of defined types at the "outer" level.
* @author oliverb
*/
public class OuterTypeNumberCheck extends Check
{
/** The maximum allowed number of outer types. */
private int mMax = 1;
/** Tracks the current depth in types. */
private int mCurrentDepth;
/** Tracks the number of outer types found. */
private int mOuterNum;
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF,
TokenTypes.ENUM_DEF, TokenTypes.ANNOTATION_DEF, };
}
@Override
public void beginTree(DetailAST aAst)
{
mCurrentDepth = 0;
mOuterNum = 0;
}
@Override
public void finishTree(DetailAST aAst)
{
if (mMax < mOuterNum) {
log(aAst, "maxOuterTypes", mOuterNum, mMax);
}
}
@Override
public void visitToken(DetailAST aAst)
{
if (0 == mCurrentDepth) {
mOuterNum++;
}
mCurrentDepth++;
}
@Override
public void leaveToken(DetailAST aAst)
{
mCurrentDepth--;
}
/**
* Sets the maximum allowed number of outer types.
* @param aTo the new number.
*/
public void setMax(int aTo)
{
mMax = aTo;
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/package-info.java 100644 0 0 2307 12026051007 27637 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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
////////////////////////////////////////////////////////////////////////////////
/**
* Contains the Size Violations checks
* that are bundled with the main distribution.
*/
package com.puppycrawl.tools.checkstyle.checks.sizes;
././@LongLink 100644 0 0 145 12026055133 10250 L ustar 0 0 checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/ParameterNumberCheck.java checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/sizes/ParameterNumberCheck.java100644 0 0 5522 12026051010 31336 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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.sizes;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
/**
*
* Checks the number of parameters that a method or constructor has.
* The default allowable number of parameters is 7.
* To change the number of allowable parameters, set property max.
*
*
* An example of how to configure the check is:
*
*
* <module name="ParameterNumber"/>
*
*
* An example of how to configure the check to allow 10 parameters is:
*
* @author Oliver Burn
* @version 1.0
*/
public class ParameterNumberCheck
extends Check
{
/** default maximum number of allowed parameters */
private static final int DEFAULT_MAX_PARAMETERS = 7;
/** the maximum number of allowed parameters */
private int mMax = DEFAULT_MAX_PARAMETERS;
/**
* Sets the maximum number of allowed parameters.
* @param aMax the max allowed parameters
*/
public void setMax(int aMax)
{
mMax = aMax;
}
@Override
public int[] getDefaultTokens()
{
return new int[] {TokenTypes.METHOD_DEF, TokenTypes.CTOR_DEF};
}
@Override
public void visitToken(DetailAST aAST)
{
final DetailAST params = aAST.findFirstToken(TokenTypes.PARAMETERS);
final int count = params.getChildCount(TokenTypes.PARAMETER_DEF);
if (count > mMax) {
final DetailAST name = aAST.findFirstToken(TokenTypes.IDENT);
log(name.getLineNo(), name.getColumnNo(), "maxParam", mMax, count);
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/TodoCommentCheck.java 100644 0 0 7467 12026051061 27360 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.FileContents;
import com.puppycrawl.tools.checkstyle.api.TextBlock;
import java.util.List;
import java.util.Map;
/**
*
* A check for TODO comments.
* Actually it is a generic {@link java.util.regex.Pattern regular expression}
* matcher on Java comments.
* To check for other patterns in Java comments, set property format.
*
*
* An example of how to configure the check is:
*
*
* <module name="TodoComment"/>
*
*
* An example of how to configure the check for comments that contain
* WARNING is:
*
* @author Oliver Burn
* @version 1.0
*/
public class TodoCommentCheck
extends AbstractFormatCheck
{
/**
* Creates a new TodoCommentCheck instance.
*/
public TodoCommentCheck()
{
super("TODO:"); // the empty language
}
@Override
public int[] getDefaultTokens()
{
return new int[0];
}
@Override
public void beginTree(DetailAST aRootAST)
{
final FileContents contents = getFileContents();
checkCppComments(contents);
checkBadComments(contents);
}
/**
* Checks the C++ comments for todo expressions.
* @param aContents the FileContents
*/
private void checkCppComments(FileContents aContents)
{
final Map comments = aContents.getCppComments();
for (Map.Entry entry : comments.entrySet()) {
final String cmt = entry.getValue().getText()[0];
if (getRegexp().matcher(cmt).find()) {
log(entry.getKey().intValue(), "todo.match", getFormat());
}
}
}
/**
* Checks the C-style comments for todo expressions.
* @param aContents the FileContents
*/
private void checkBadComments(FileContents aContents)
{
final Map> allComments = aContents
.getCComments();
for (Map.Entry> entry : allComments.entrySet())
{
for (TextBlock line : entry.getValue()) {
final String[] cmt = line.getText();
for (int i = 0; i < cmt.length; i++) {
if (getRegexp().matcher(cmt[i]).find()) {
log(entry.getKey().intValue() + i, "todo.match",
getFormat());
}
}
}
}
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/TrailingCommentCheck.java 100644 0 0 20025 12026051061 30225 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TextBlock;
import com.puppycrawl.tools.checkstyle.api.Utils;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.apache.commons.beanutils.ConversionException;
/**
*
* The check to ensure that requires that comments be the only thing on a line.
* For the case of // comments that means that the only thing that should
* precede it is whitespace.
* It doesn't check comments if they do not end line, i.e. it accept
* the following:
* Thread.sleep( 10 <some comment here> );
* Format property is intended to deal with the "} // while" example.
*
*
* Rationale: Steve McConnel in "Code Complete" suggests that endline
* comments are a bad practice. An end line comment would
* be one that is on the same line as actual code. For example:
*
* a = b + c; // Some insightful comment
* d = e / f; // Another comment for this line
*
* Quoting "Code Complete" for the justfication:
*
*
* "The comments have to be aligned so that they do not
* interfere with the visual structure of the code. If you don't
* align them neatly, they'll make your listing look like it's been
* through a washing machine."
*
*
* "Endline comments tend to be hard to format...It takes time
* to align them. Such time is not spent learning more about
* the code; it's dedicated solely to the tedious task of
* pressing the spacebar or tab key."
*
*
* "Endline comments are also hard to maintain. If the code on
* any line containing an endline comment grows, it bumps the
* comment farther out, and all the other endline comments will
* have to bumped out to match. Styles that are hard to
* maintain aren't maintained...."
*
*
* "Endline comments also tend to be cryptic. The right side of
* the line doesn't offer much room and the desire to keep the
* comment on one line means the comment must be short.
* Work then goes into making the line as short as possible
* instead of as clear as possible. The comment usually ends
* up as cryptic as possible...."
*
*
* "A systemic problem with endline comments is that it's hard
* to write a meaningful comment for one line of code. Most
* endline comments just repeat the line of code, which hurts
* more than it helps."
*
*
* His comments on being hard to maintain when the size of
* the line changes are even more important in the age of
* automated refactorings.
*
*
* To configure the check so it enforces only comment on a line:
*
*
* @author o_sukhodolsky
*/
public class TrailingCommentCheck extends AbstractFormatCheck
{
/** default format for allowed blank line. */
private static final String DEFAULT_FORMAT = "^[\\s\\}\\);]*$";
/** pattern for legal trailing comment. */
private Pattern mLegalComment;
/**
* Sets patter for legal trailing comments.
* @param aFormat format to set.
* @throws ConversionException unable to parse a given format.
*/
public void setLegalComment(final String aFormat)
throws ConversionException
{
try {
mLegalComment = Utils.getPattern(aFormat);
}
catch (final PatternSyntaxException e) {
throw new ConversionException("unable to parse " + aFormat, e);
}
}
/**
* Creates new instance of the check.
* @throws ConversionException unable to parse DEFAULT_FORMAT.
*/
public TrailingCommentCheck() throws ConversionException
{
super(DEFAULT_FORMAT);
}
@Override
public int[] getDefaultTokens()
{
return new int[0];
}
@Override
public void visitToken(DetailAST aAST)
{
throw new IllegalStateException("visitToken() shouldn't be called.");
}
@Override
public void beginTree(DetailAST aRootAST)
{
final Pattern blankLinePattern = getRegexp();
final Map cppComments = getFileContents()
.getCppComments();
final Map> cComments = getFileContents()
.getCComments();
final Set lines = Sets.newHashSet();
lines.addAll(cppComments.keySet());
lines.addAll(cComments.keySet());
for (Integer lineNo : lines) {
final String line = getLines()[lineNo.intValue() - 1];
String lineBefore = "";
TextBlock comment = null;
if (cppComments.containsKey(lineNo)) {
comment = cppComments.get(lineNo);
lineBefore = line.substring(0, comment.getStartColNo());
}
else if (cComments.containsKey(lineNo)) {
final List commentList = cComments.get(lineNo);
comment = commentList.get(commentList.size() - 1);
lineBefore = line.substring(0, comment.getStartColNo());
if (comment.getText().length == 1) {
final String lineAfter =
line.substring(comment.getEndColNo() + 1).trim();
if (!"".equals(lineAfter)) {
// do not check comment which doesn't end line
continue;
}
}
}
if ((comment != null)
&& !blankLinePattern.matcher(lineBefore).find()
&& !isLegalComment(comment))
{
log(lineNo.intValue(), "trailing.comments");
}
}
}
/**
* Checks if given comment is legal (single-line and matches to the
* pattern).
* @param aComment comment to check.
* @return true if the comment if legal.
*/
private boolean isLegalComment(final TextBlock aComment)
{
if (mLegalComment == null) {
return false;
}
// multi-line comment can not be legal
if (aComment.getStartLineNo() != aComment.getEndLineNo()) {
return false;
}
String commentText = aComment.getText()[0];
// remove chars which start comment
commentText = commentText.substring(2);
// if this is a C-style comment we need to remove its end
if (commentText.endsWith("*/")) {
commentText = commentText.substring(0, commentText.length() - 2);
}
commentText = commentText.trim();
return mLegalComment.matcher(commentText).find();
}
}
checkstyle-5.6/src/checkstyle/com/puppycrawl/tools/checkstyle/checks/TranslationCheck.java 100644 0 0 22430 12026051061 27431 0 ustar 0 0 ////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2012 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;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.Defn;
import com.puppycrawl.tools.checkstyle.api.AbstractFileSetCheck;
import com.puppycrawl.tools.checkstyle.api.LocalizedMessage;
import com.puppycrawl.tools.checkstyle.api.MessageDispatcher;
import com.puppycrawl.tools.checkstyle.api.Utils;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.util.Enumeration;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.TreeSet;
import java.util.Map.Entry;
/**
*
* The TranslationCheck class helps to ensure the correct translation of code by
* checking property files for consistency regarding their keys.
* Two property files describing one and the same context are consistent if they
* contain the same keys.
*
*
* An example of how to configure the check is:
*
*
* <module name="Translation"/>
*
* @author Alexandra Bunge
* @author lkuehne
*/
public class TranslationCheck
extends AbstractFileSetCheck
{
/** The property files to process. */
private final List mPropertyFiles = Lists.newArrayList();
/**
* Creates a new TranslationCheck instance.
*/
public TranslationCheck()
{
setFileExtensions(new String[]{"properties"});
}
@Override
public void beginProcessing(String aCharset)
{
super.beginProcessing(aCharset);
mPropertyFiles.clear();
}
@Override
protected void processFiltered(File aFile, List aLines)
{
mPropertyFiles.add(aFile);
}
@Override
public void finishProcessing()
{
super.finishProcessing();
final Map> propFilesMap =
arrangePropertyFiles(mPropertyFiles);
checkPropertyFileSets(propFilesMap);
}
/**
* Gets the basename (the unique prefix) of a property file. For example
* "xyz/messages" is the basename of "xyz/messages.properties",
* "xyz/messages_de_AT.properties", "xyz/messages_en.properties", etc.
*
* @param aFile the file
* @return the extracted basename
*/
private static String extractPropertyIdentifier(final File aFile)
{
final String filePath = aFile.getPath();
final int dirNameEnd = filePath.lastIndexOf(File.separatorChar);
final int baseNameStart = dirNameEnd + 1;
final int underscoreIdx = filePath.indexOf('_', baseNameStart);
final int dotIdx = filePath.indexOf('.', baseNameStart);
final int cutoffIdx = (underscoreIdx != -1) ? underscoreIdx : dotIdx;
return filePath.substring(0, cutoffIdx);
}
/**
* Arranges a set of property files by their prefix.
* The method returns a Map object. The filename prefixes
* work as keys each mapped to a set of files.
* @param aPropFiles the set of property files
* @return a Map object which holds the arranged property file sets
*/
private static Map> arrangePropertyFiles(
List aPropFiles)
{
final Map> propFileMap = Maps.newHashMap();
for (final File f : aPropFiles) {
final String identifier = extractPropertyIdentifier(f);
Set fileSet = propFileMap.get(identifier);
if (fileSet == null) {
fileSet = Sets.newHashSet();
propFileMap.put(identifier, fileSet);
}
fileSet.add(f);
}
return propFileMap;
}
/**
* Loads the keys of the specified property file into a set.
* @param aFile the property file
* @return a Set object which holds the loaded keys
*/
private Set