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

Applied patch 906531 (WhitespaceAround allows empty method/ctor bodies.) Thanks to Eric Roe

This commit is contained in:
Oleg Sukhodolsky 2005-11-01 15:38:32 +00:00
parent 1aee9d55cc
commit 89ee699fae
5 changed files with 166 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

110
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAroundCheck.java
View File

@ -95,13 +95,37 @@ import com.puppycrawl.tools.checkstyle.api.DetailAST;
* value="ASSIGN,DIV_ASSIGN,PLUS_ASSIGN,MINUS_ASSIGN,STAR_ASSIGN,MOD_ASSIGN,SR_ASSIGN,BSR_ASSIGN,SL_ASSIGN,BXOR_ASSIGN,BOR_ASSIGN,BAND_ASSIGN"/>
* </module>
* </pre>
* <p>
* In addition, this check can be configured to allow empty method and/or
* constructor bodies. For example, a method with an empty body might look
* like:
* </p>
* <p>
* <pre> public void doSomething(int val) {}</pre>
* </p>
* <p>
* To configure the check to allow empty method blocks use
* </p>
* <p>
* <pre> &lt;property name="allowEmptyMethods" value="true" /&gt;</pre>
* </p>
* <p>
* To configure the check to allow empty constructor blocks use
* </p>
* <p>
* <pre> &lt;property name="allowEmptyConstructors" value="true" /&gt;</pre>
* </p>
*
* @author Oliver Burn
* @version 1.0
*/
public class WhitespaceAroundCheck
extends Check
public class WhitespaceAroundCheck extends Check
{
/** Whether or not empty constructor bodies are allowed. */
private boolean mAllowEmptyCtors;
/** Whether or not empty method bodies are allowed. */
private boolean mAllowEmptyMethods;
/** {@inheritDoc} */
public int[] getDefaultTokens()
{
@ -160,6 +184,24 @@ public class WhitespaceAroundCheck
};
}
/**
* Sets whether or now empty method bodies are allowed.
* @param aAllow <code>true</code> to allow empty method bodies.
*/
public void setAllowEmptyMethods(boolean aAllow)
{
mAllowEmptyMethods = aAllow;
}
/**
* Sets whether or now empty constructor bodies are allowed.
* @param aAllow <code>true</code> to allow empty constructor bodies.
*/
public void setAllowEmptyConstructors(boolean aAllow)
{
mAllowEmptyCtors = aAllow;
}
/** {@inheritDoc} */
public void visitToken(DetailAST aAST)
{
@ -195,6 +237,13 @@ public class WhitespaceAroundCheck
return;
}
// Check for allowed empty method or ctor blocks.
if (emptyMethodBlockCheck(aAST, parentType)
|| emptyCtorBlockCheck(aAST, parentType))
{
return;
}
final String[] lines = getLines();
final String line = lines[aAST.getLineNo() - 1];
final int before = aAST.getColumnNo() - 1;
@ -227,4 +276,61 @@ public class WhitespaceAroundCheck
new Object[] {aAST.getText()});
}
}
/**
* Test if the given <code>DetailAST</code> is part of an allowed empty
* method block.
* @param aAST the <code>DetailAST</code> to test.
* @param aParentType the token type of <code>aAST</code>'s parent.
* @return <code>true</code> if <code>aAST</code> makes up part of an
* allowed empty method block.
*/
private boolean emptyMethodBlockCheck(DetailAST aAST, int aParentType)
{
return mAllowEmptyMethods
&& emptyBlockCheck(aAST, aParentType, TokenTypes.METHOD_DEF);
}
/**
* Test if the given <code>DetailAST</code> is part of an allowed empty
* constructor (ctor) block.
* @param aAST the <code>DetailAST</code> to test.
* @param aParentType the token type of <code>aAST</code>'s parent.
* @return <code>true</code> if <code>aAST</code> makes up part of an
* allowed empty constructor block.
*/
private boolean emptyCtorBlockCheck(DetailAST aAST, int aParentType)
{
return mAllowEmptyCtors
&& emptyBlockCheck(aAST, aParentType, TokenTypes.CTOR_DEF);
}
/**
* Test if the given <code>DetailAST</code> is part of an empty block.
* An example empty block might look like the following
* <p>
* <pre> public void myMethod(int val) {}</pre>
* <p>
* In the above, the method body is an empty block ("{}").
*
* @param aAST the <code>DetailAST</code> to test.
* @param aParentType the token type of <code>aAST</code>'s parent.
* @param aMatch the parent token type we're looking to match.
* @return <code>true</code> if <code>aAST</code> makes up part of an
* empty block contained under a <code>aMatch</code> token type
* node.
*/
private boolean emptyBlockCheck(DetailAST aAST, int aParentType, int aMatch)
{
final int type = aAST.getType();
if (type == TokenTypes.RCURLY) {
DetailAST grandParent = aAST.getParent().getParent();
return aParentType == TokenTypes.SLIST
&& grandParent.getType() == aMatch;
}
return type == TokenTypes.SLIST
&& aParentType == aMatch
&& aAST.getFirstChild().getType() == TokenTypes.RCURLY;
}
}

6
src/testinputs/com/puppycrawl/tools/checkstyle/InputBraces.java
View File

@ -110,4 +110,10 @@ class InputBraces
for (;;) {
}
}
/** Empty constructor block. **/
public InputBraces() {}
/** Empty method block. **/
public void emptyImplementation() {}
}

33
src/tests/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAroundTest.java
View File

@ -6,11 +6,16 @@ import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
public class WhitespaceAroundTest
extends BaseCheckTestCase
{
DefaultConfiguration checkConfig;
public void setUp()
{
checkConfig = createCheckConfig(WhitespaceAroundCheck.class);
}
public void testIt()
throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(WhitespaceAroundCheck.class);
final String[] expected = {
"16:22: '=' is not preceded with whitespace.",
"16:23: '=' is not followed by whitespace.",
@ -54,8 +59,6 @@ public class WhitespaceAroundTest
public void testIt2()
throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(WhitespaceAroundCheck.class);
final String[] expected = {
"153:27: '=' is not followed by whitespace.",
"154:27: '=' is not followed by whitespace.",
@ -70,13 +73,27 @@ public class WhitespaceAroundTest
public void testIt3()
throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(WhitespaceAroundCheck.class);
final String[] expected = {
"41:14: 'while' is not followed by whitespace.",
"58:12: 'for' is not followed by whitespace.",
// + ":58:23: ';' is not followed by whitespace.",
// + ":58:29: ';' is not followed by whitespace.",
"115:27: '{' is not followed by whitespace.",
"115:27: '}' is not preceded with whitespace.",
"118:40: '{' is not followed by whitespace.",
"118:40: '}' is not preceded with whitespace.",
};
verify(checkConfig, getPath("InputBraces.java"), expected);
}
public void testIt4()
throws Exception
{
checkConfig.addAttribute("allowEmptyMethods", "true");
checkConfig.addAttribute("allowEmptyConstructors", "true");
final String[] expected = {
"41:14: 'while' is not followed by whitespace.",
"58:12: 'for' is not followed by whitespace.",
};
verify(checkConfig, getPath("InputBraces.java"), expected);
}
@ -84,8 +101,6 @@ public class WhitespaceAroundTest
public void testGenericsTokensAreFlagged()
throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(WhitespaceAroundCheck.class);
final String[] expected = {
"6:27: '<' is not preceded with whitespace.",
"6:28: '<' is not followed by whitespace.",
@ -104,8 +119,6 @@ public class WhitespaceAroundTest
public void test1322879() throws Exception
{
final DefaultConfiguration checkConfig =
createCheckConfig(WhitespaceAroundCheck.class);
final String[] expected = {
};
verify(checkConfig, getPath("whitespace/InputWhitespaceAround.java"),

24
src/xdocs/config_whitespace.xml
View File

@ -899,7 +899,17 @@ for (Iterator foo = very.long.line.iterator();
<section name="WhitespaceAround">
<subsection name="Description">
<p>
Checks that a token is surrounded by whitespace.
Checks that a token is surrounded by whitespace. Empty constructor and
method bodies (blocks) of the form
</p>
<p>
<pre>public MyClass() {} // empty constructor
public void func() {} // empty method</pre>
</p>
<p>
may optionally be exempted from the policy using the <span class="code">
allowEmptyMethods</span> and <span class="code">allowEmptyConstructors
</span> properties.
</p>
</subsection>
@ -1021,6 +1031,18 @@ for (Iterator foo = very.long.line.iterator();
</td>
<td>all tokens</td>
</tr>
<tr>
<td>allowEmptyConstructors</td>
<td>allow empty constructor bodies</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><span class="default">false</span></td>
</tr>
<tr>
<td>allowEmptyMethods</td>
<td>allow empty method bodies</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td><span class="default">false</span></td>
</tr>
</table>
</subsection>

6
src/xdocs/releasenotes.xml
View File

@ -40,6 +40,12 @@
FallThrough check now can check last case group (property
checkLastCaseGroup, bug 1245942).
</li>
<li>
Applied patch 906531 (WhitespaceAround allows empty
method/ctor bodies.) Thanks to Eric Roe (module
WhitespaceAround, properties allowEmptyCtors and
allowEmptyMethods).
</li>
</ul>
<p>Fixed Bugs:</p>