com.github.sbaudoin.sonar.plugins.shellcheck.lexer

Class BashLexer

java.lang.Object

com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer

com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase

com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexer

All Implemented Interfaces:

ShellLexer

public class BashLexer
extends BashLexerBase
implements ShellLexer

Main Bash lexer class

Field Summary

Fields inherited from class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase

S_ARITH, S_ARITH_ARRAY_MODE, S_ARITH_SQUARE_MODE, S_ARRAY, S_ASSIGNMENT_LIST, S_BACKQUOTE, S_CASE, S_CASE_PATTERN, S_DOLLAR_PREFIXED, S_PARAM_EXPANSION, S_PARAM_EXPANSION_DELIMITER, S_PARAM_EXPANSION_PATTERN, S_PARAM_EXPANSION_REPLACEMENT, S_SUBSHELL, S_TEST, S_TEST_COMMAND, X_HERE_STRING, X_HEREDOC, X_HEREDOC_MARKER, X_HEREDOC_MARKER_IGNORE_TABS, X_STRINGMODE, YYEOF, YYINITIAL

Constructor Summary

Constructors

Constructor and Description
BashLexer(boolean isBash4, Reader in) Constructs a new Bash lexer for the passed Shell script
BashLexer(Reader in) Constructs a new Bash lexer for the passed Shell script supposed to be a Bash 4 script

Method Summary

Modifier and Type	Method and Description
Token	getToken() Returns the token just read with ShellLexer.next() or null if no token read yet, ShellLexer.scan() was called or the last token was reached (i.e.
Token	next() Contrary to the ShellLexer.scan() method, the tokens are returned one by one by this method: it resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O error occurs
List<Token>	scan() Returns all non-overlapping found tokens for each recognized token in the stream set by the constructor.

Methods inherited from class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase

closeHereStringIfAvailable, yybegin, yychar, yycharat, yyclose, yycolumn, yylength, yylex, yyline, yypushback, yyreset, yystate, yytext

Methods inherited from class com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer

backToPreviousState, decOpenParenthesisCount, enterHereStringContent, goToState, heredocState, incOpenParenthesisCount, isBash4, isEmptyConditionalCommand, isInCaseBody, isInHereStringContent, isInState, isParamExpansionHash, isParamExpansionOther, isParamExpansionWord, leaveHereStringContent, openParenthesisCount, popStates, setEmptyConditionalCommand, setInCaseBody, setParamExpansionHash, setParamExpansionOther, setParamExpansionWord, stringParsingState, token, token

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BashLexer

public BashLexer(Reader in)

Constructs a new Bash lexer for the passed Shell script supposed to be a Bash 4 script

Parameters:

in - a reader to the Bash script to be scanned

BashLexer

public BashLexer(boolean isBash4,
                 Reader in)

Constructs a new Bash lexer for the passed Shell script

Parameters:

isBash4 - true if in is a Bash 4 script

in - a reader to the Bash script to be scanned

Method Detail

scan

public List<Token> scan()
                 throws IOException

Description copied from interface: ShellLexer

Returns all non-overlapping found tokens for each recognized token in the stream set by the constructor.

Specified by:

scan in interface ShellLexer

Returns:

the list of Tokens found in the script

Throws:

IOException - if an error occurred reading the input script

next

public Token next()
           throws IOException

Description copied from interface: ShellLexer

Contrary to the ShellLexer.scan() method, the tokens are returned one by one by this method: it resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O error occurs

Specified by:

next in interface ShellLexer

Returns:

the next token

Throws:

IOException - if any I/O error occurs

getToken

public Token getToken()

Description copied from interface: ShellLexer

Returns the token just read with ShellLexer.next() or null if no token read yet, ShellLexer.scan() was called or the last token was reached (i.e. no more token left)

Specified by:

getToken in interface ShellLexer

Returns:

the token just read with ShellLexer.next() or null if no token read yet, ShellLexer.scan() was called or the last token was reached (i.e. no more token left)