public class IndentationCheck extends Check
The basic idea behind this is that while pretty printers are sometimes convenient 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 handlers 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
Constructor and Description |
---|
IndentationCheck()
Creates a new instance of IndentationCheck.
|
Modifier and Type | Method and Description |
---|---|
void |
beginTree(DetailAST ast)
Called before the starting to process a tree.
|
int |
getArrayInitIndent()
Get the line-wrapping indentation level.
|
int |
getBasicOffset()
Get the basic offset.
|
int |
getBraceAdjustement()
Get the brace adjustment amount.
|
int |
getCaseIndent()
Get the case indentation level.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
boolean |
getForceStrictCondition()
Get forcing strict condition.
|
int |
getIndentationTabWidth()
Get the width of a tab.
|
int |
getLineWrappingIndentation()
Get the array line-wrapping indentation level.
|
int |
getThrowsIndent()
Get the throws indentation level.
|
void |
indentationLog(int line,
String key,
Object... args)
Log an error message.
|
void |
leaveToken(DetailAST ast)
Called after all the child nodes have been process.
|
void |
setArrayInitIndent(int arrayInitIndent)
Set the array initialisation indentation level.
|
void |
setBasicOffset(int basicOffset)
Set the basic offset.
|
void |
setBraceAdjustment(int adjustmentAmount)
Adjusts brace indentation (positive offset).
|
void |
setCaseIndent(int amount)
Set the case indentation level.
|
void |
setForceStrictCondition(boolean value)
Set forcing strict condition.
|
void |
setLineWrappingIndentation(int lineWrappingIndentation)
Set the line-wrapping indentation level.
|
void |
setThrowsIndent(int throwsIndent)
Set the throws indentation level.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public IndentationCheck()
public boolean getForceStrictCondition()
public void setForceStrictCondition(boolean value)
value
- user's value of forceStrictCondition.public void setBasicOffset(int basicOffset)
basicOffset
- the number of tabs or spaces to indentpublic int getBasicOffset()
public void setBraceAdjustment(int adjustmentAmount)
adjustmentAmount
- the brace offsetpublic int getBraceAdjustement()
public void setCaseIndent(int amount)
amount
- the case indentation levelpublic int getCaseIndent()
public void setThrowsIndent(int throwsIndent)
throwsIndent
- the throws indentation levelpublic int getThrowsIndent()
public void setArrayInitIndent(int arrayInitIndent)
arrayInitIndent
- the array initialisation indentation levelpublic int getArrayInitIndent()
public int getLineWrappingIndentation()
public void setLineWrappingIndentation(int lineWrappingIndentation)
lineWrappingIndentation
- the line-wrapping indentation levelpublic void indentationLog(int line, String key, Object... args)
line
- the line number where the error was foundkey
- the message that describes the errorargs
- the details of the messageMessageFormat
public int getIndentationTabWidth()
public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public void beginTree(DetailAST ast)
Check
public void visitToken(DetailAST ast)
Check
visitToken
in class Check
ast
- the token to processpublic void leaveToken(DetailAST ast)
Check
leaveToken
in class Check
ast
- the token leavingCopyright © 2001–2015. All rights reserved.