BashLexerBase (ShellCheck Analyzer 2.0.0 API)

java.lang.Object
- com.github.sbaudoin.sonar.plugins.shellcheck.lexer.AbstractBashLexer
- - com.github.sbaudoin.sonar.plugins.shellcheck.lexer.BashLexerBase

Direct Known Subclasses:

BashLexer
```
public abstract class BashLexerBase
extends AbstractBashLexer
```
This class is a scanner generated by JFlex 1.7.0 from the specification file src/main/jflex/bash.jflex

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`S_ARITH`
`static int`	`S_ARITH_ARRAY_MODE`
`static int`	`S_ARITH_SQUARE_MODE`
`static int`	`S_ARRAY`
`static int`	`S_ASSIGNMENT_LIST`
`static int`	`S_BACKQUOTE`
`static int`	`S_CASE`
`static int`	`S_CASE_PATTERN`
`static int`	`S_DOLLAR_PREFIXED`
`static int`	`S_PARAM_EXPANSION`
`static int`	`S_PARAM_EXPANSION_DELIMITER`
`static int`	`S_PARAM_EXPANSION_PATTERN`
`static int`	`S_PARAM_EXPANSION_REPLACEMENT`
`static int`	`S_SUBSHELL`
`static int`	`S_TEST`
`static int`	`S_TEST_COMMAND`
`static int`	`X_HERE_STRING`
`static int`	`X_HEREDOC`
`static int`	`X_HEREDOC_MARKER`
`static int`	`X_HEREDOC_MARKER_IGNORE_TABS`
`static int`	`X_STRINGMODE`
`static int`	`YYEOF` This character denotes the end of file
`static int`	`YYINITIAL` lexical states

Constructor Summary

Constructors
Constructor and Description

BashLexerBase(Reader in)
Creates a new scanner

Constructors
Constructor and Description
`BashLexerBase(Reader in)` Creates a new scanner

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`closeHereStringIfAvailable()` Closes a `here_string` content token if the lexer is currently reading a here string
`protected void`	`yybegin(int newState)` Enters a new lexical state
`protected int`	`yychar()` Returns the char number from beginning of input stream.
`protected char`	`yycharat(int pos)` Returns the character at position `pos` from the matched text.
`protected void`	`yyclose()` Closes the input stream
`protected int`	`yycolumn()` Returns the column number from beginning of the line (starting from 0).
`protected int`	`yylength()` Returns the length of the matched text region.
`protected Token`	`yylex()` Resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O-Error occurs.
`protected int`	`yyline()` Returns the start line number from beginning of input stream (starting from 0).
`protected void`	`yypushback(int number)` Pushes the specified amount of characters back into the input stream.
`protected void`	`yyreset(Reader reader)` Resets the scanner to read from a new input stream.
`protected int`	`yystate()` Returns the current lexical state.
`protected String`	`yytext()` Returns the text matched by the current regular expression.

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

- Field Detail
  - YYEOF
```
public static final int YYEOF
```
    This character denotes the end of file
    
    See Also:
    
    Constant Field Values
  - YYINITIAL
```
public static final int YYINITIAL
```
    lexical states
    
    See Also:
    
    Constant Field Values
  - S_TEST
```
public static final int S_TEST
```
    See Also:
    
    Constant Field Values
  - S_TEST_COMMAND
```
public static final int S_TEST_COMMAND
```
    See Also:
    
    Constant Field Values
  - S_ARITH
```
public static final int S_ARITH
```
    See Also:
    
    Constant Field Values
  - S_ARITH_SQUARE_MODE
```
public static final int S_ARITH_SQUARE_MODE
```
    See Also:
    
    Constant Field Values
  - S_ARITH_ARRAY_MODE
```
public static final int S_ARITH_ARRAY_MODE
```
    See Also:
    
    Constant Field Values
  - S_CASE
```
public static final int S_CASE
```
    See Also:
    
    Constant Field Values
  - S_CASE_PATTERN
```
public static final int S_CASE_PATTERN
```
    See Also:
    
    Constant Field Values
  - S_SUBSHELL
```
public static final int S_SUBSHELL
```
    See Also:
    
    Constant Field Values
  - S_DOLLAR_PREFIXED
```
public static final int S_DOLLAR_PREFIXED
```
    See Also:
    
    Constant Field Values
  - S_ARRAY
```
public static final int S_ARRAY
```
    See Also:
    
    Constant Field Values
  - S_ASSIGNMENT_LIST
```
public static final int S_ASSIGNMENT_LIST
```
    See Also:
    
    Constant Field Values
  - X_STRINGMODE
```
public static final int X_STRINGMODE
```
    See Also:
    
    Constant Field Values
  - S_PARAM_EXPANSION
```
public static final int S_PARAM_EXPANSION
```
    See Also:
    
    Constant Field Values
  - S_PARAM_EXPANSION_PATTERN
```
public static final int S_PARAM_EXPANSION_PATTERN
```
    See Also:
    
    Constant Field Values
  - S_PARAM_EXPANSION_DELIMITER
```
public static final int S_PARAM_EXPANSION_DELIMITER
```
    See Also:
    
    Constant Field Values
  - S_PARAM_EXPANSION_REPLACEMENT
```
public static final int S_PARAM_EXPANSION_REPLACEMENT
```
    See Also:
    
    Constant Field Values
  - S_BACKQUOTE
```
public static final int S_BACKQUOTE
```
    See Also:
    
    Constant Field Values
  - X_HEREDOC_MARKER
```
public static final int X_HEREDOC_MARKER
```
    See Also:
    
    Constant Field Values
  - X_HEREDOC_MARKER_IGNORE_TABS
```
public static final int X_HEREDOC_MARKER_IGNORE_TABS
```
    See Also:
    
    Constant Field Values
  - X_HEREDOC
```
public static final int X_HEREDOC
```
    See Also:
    
    Constant Field Values
  - X_HERE_STRING
```
public static final int X_HERE_STRING
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BashLexerBase
```
public BashLexerBase(Reader in)
```
    Creates a new scanner
    
    Parameters:
    
    in - the java.io.Reader to read input from.
- Method Detail
  - yychar
```
protected int yychar()
```
    Description copied from class: AbstractBashLexer
    
    Returns the char number from beginning of input stream. This is NOT implemented by JFlex, so the code must be added to create this and return the private yychar field.
    
    Specified by:
    
    yychar in class AbstractBashLexer
    
    Returns:
    
    the char number from beginning of input stream
  - yyline
```
protected int yyline()
```
    Description copied from class: AbstractBashLexer
    
    Returns the start line number from beginning of input stream (starting from 0). This is NOT implemented by JFlex, so the code must be added to create this and return the private yyline field.
    
    Specified by:
    
    yyline in class AbstractBashLexer
    
    Returns:
    
    the start line number from beginning of input stream (starting from 0)
  - yycolumn
```
protected int yycolumn()
```
    Description copied from class: AbstractBashLexer
    
    Returns the column number from beginning of the line (starting from 0). This is NOT implemented by JFlex, so the code must be added to create this and return the private yycolumn field
    
    Specified by:
    
    yycolumn in class AbstractBashLexer
    
    Returns:
    
    the column number from beginning of the line (starting from 0)
  - closeHereStringIfAvailable
```
protected void closeHereStringIfAvailable()
```
    Closes a here_string content token if the lexer is currently reading a here string
  - yyclose
```
protected final void yyclose()
                      throws IOException
```
    Closes the input stream
    
    Throws:
    
    IOException - if an error occurred while closing the reader
  - yyreset
```
protected final void yyreset(Reader reader)
```
    Resets the scanner to read from a new input stream. Does not close the old reader. All internal variables are reset, the old input stream cannot be reused (internal buffer is discarded and lost). Lexical state is set to ZZ_INITIAL. Internal scan buffer is resized down to its initial length, if it has grown.
    
    Specified by:
    
    yyreset in class AbstractBashLexer
    
    Parameters:
    
    reader - the new input stream
  - yystate
```
protected final int yystate()
```
    Returns the current lexical state.
    
    Specified by:
    
    yystate in class AbstractBashLexer
    
    Returns:
    
    the current lexical state
  - yybegin
```
protected final void yybegin(int newState)
```
    Enters a new lexical state
    
    Specified by:
    
    yybegin in class AbstractBashLexer
    
    Parameters:
    
    newState - the new lexical state
  - yytext
```
protected final String yytext()
```
    Returns the text matched by the current regular expression.
    
    Specified by:
    
    yytext in class AbstractBashLexer
    
    Returns:
    
    the text matched by the current regular expression
  - yycharat
```
protected final char yycharat(int pos)
```
    Returns the character at position pos from the matched text. It is equivalent to yytext().charAt(pos), but faster
    
    Specified by:
    
    yycharat in class AbstractBashLexer
    
    Parameters:
    
    pos - the position of the character to fetch. A value from 0 to yylength()-1.
    
    Returns:
    
    the character at position pos
  - yylength
```
protected final int yylength()
```
    Returns the length of the matched text region.
    
    Specified by:
    
    yylength in class AbstractBashLexer
    
    Returns:
    
    the length of the matched text region
  - yypushback
```
protected void yypushback(int number)
```
    Pushes the specified amount of characters back into the input stream. They will be read again by then next call of the scanning method
    
    Parameters:
    
    number - the number of characters to be read again. This number must not be greater than yylength()!
  - yylex
```
protected Token yylex()
               throws IOException
```
    Resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O-Error occurs.
    
    Specified by:
    
    yylex in class AbstractBashLexer
    
    Returns:
    
    the next token
    
    Throws:
    
    IOException - if any I/O-Error occurs

Class BashLexerBase

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

YYEOF

YYINITIAL

S_TEST

S_TEST_COMMAND

S_ARITH

S_ARITH_SQUARE_MODE

S_ARITH_ARRAY_MODE

S_CASE

S_CASE_PATTERN

S_SUBSHELL

S_DOLLAR_PREFIXED

S_ARRAY

S_ASSIGNMENT_LIST

X_STRINGMODE

S_PARAM_EXPANSION

S_PARAM_EXPANSION_PATTERN

S_PARAM_EXPANSION_DELIMITER

S_PARAM_EXPANSION_REPLACEMENT

S_BACKQUOTE

X_HEREDOC_MARKER

X_HEREDOC_MARKER_IGNORE_TABS

X_HEREDOC

X_HERE_STRING

Constructor Detail

BashLexerBase

Method Detail

yychar

yyline

yycolumn

closeHereStringIfAvailable

yyclose

yyreset

yystate

yybegin

yytext

yycharat

yylength

yypushback

yylex