Lexer (sigma-component 2.10 API)

java.lang.Object
- com.articulate.sigma.semRewrite.Lexer

```
public class Lexer
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static ArrayList<String>`	`andOr`
`static ArrayList<String>`	`binaryRel`
`static String`	`Clause`
`static String`	`CloseBracket`
`static String`	`ClosePar`
`static String`	`Comma`
`static String`	`Directive`
`static String`	`EOFToken`
`String`	`filename`
`static String`	`FullStop`
`static String`	`Ident`
`static String`	`Implies`
`LineNumberReader`	`input`
`String`	`line`
`String`	`literal`
`static String`	`Negation`
`static String`	`Newline`
`static String`	`NoToken`
`static String`	`Number`
`static String`	`OpenBracket`
`static String`	`OpenPar`
`static String`	`OptImplies`
`static String`	`Or`
`static String`	`Plus`
`int`	`pos`
`static ArrayList<String>`	`quant`
`static String`	`QuotedString`
`static String`	`SemiComment`
`static String`	`Stop`
`String`	`SZS`
`static LinkedHashMap<String,Pattern>`	`tokenDefs` This array contains all of the compiled Pattern objects that will be used by methods in this file.
`ArrayDeque<String>`	`tokenStack`
`String`	`type`
`static String`	`Var`
`static String`	`WhiteSpace`
`static String`	`Zero`

Constructor Summary

Constructors
Constructor and Description

Lexer()

Lexer(File f)
Read a text file into the "input" String variables.

Lexer(String s)

Constructors
Constructor and Description
`Lexer()`
`Lexer(File f)` Read a text file into the "input" String variables.
`Lexer(String s)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`acceptLit(ArrayList<String> litvals)` Take a list of expected literal strings.
`String`	`acceptLit(String litval)` Take a list of expected literal strings.
`String`	`acceptTok(ArrayList<String> tokens)` Take a list of expected token types.
`String`	`acceptTok(String token)` Take an expected token type.
`void`	`checkTok(ArrayList<String> tokens)` Take a list of expected token types.
`void`	`checkTok(String tok)` Take a list of expected token types.
`String`	`file2string(File f)` Read the contents of a text file into a String.
`ArrayList<String>`	`lex()` Return a list of all tokens in the source.
`ArrayList<String>`	`lexTypes()` Return a list of all tokens in the source.
`int`	`linepos()`
`String`	`look()`
`String`	`lookLit()`
`String`	`lookType()`
`static void`	`main(String[] args)`
`String`	`next()`
`String`	`nextUnfiltered()`
`boolean`	`testLit(ArrayList<String> litvals)`
`boolean`	`testLit(String litval)`
`boolean`	`testTok(ArrayList<String> tokens)` Take a list of expected token types.
`boolean`	`testTok(String tok)` Convenience method

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NoToken
```
public static final String NoToken
```
    See Also:
    
    Constant Field Values
  - WhiteSpace
```
public static final String WhiteSpace
```
    See Also:
    
    Constant Field Values
  - Newline
```
public static final String Newline
```
    See Also:
    
    Constant Field Values
  - SemiComment
```
public static final String SemiComment
```
    See Also:
    
    Constant Field Values
  - Directive
```
public static final String Directive
```
    See Also:
    
    Constant Field Values
  - Ident
```
public static final String Ident
```
    See Also:
    
    Constant Field Values
  - Number
```
public static final String Number
```
    See Also:
    
    Constant Field Values
  - QuotedString
```
public static final String QuotedString
```
    See Also:
    
    Constant Field Values
  - FullStop
```
public static final String FullStop
```
    See Also:
    
    Constant Field Values
  - OpenPar
```
public static final String OpenPar
```
    See Also:
    
    Constant Field Values
  - ClosePar
```
public static final String ClosePar
```
    See Also:
    
    Constant Field Values
  - OpenBracket
```
public static final String OpenBracket
```
    See Also:
    
    Constant Field Values
  - CloseBracket
```
public static final String CloseBracket
```
    See Also:
    
    Constant Field Values
  - Or
```
public static final String Or
```
    See Also:
    
    Constant Field Values
  - Plus
```
public static final String Plus
```
    See Also:
    
    Constant Field Values
  - Comma
```
public static final String Comma
```
    See Also:
    
    Constant Field Values
  - Implies
```
public static final String Implies
```
    See Also:
    
    Constant Field Values
  - OptImplies
```
public static final String OptImplies
```
    See Also:
    
    Constant Field Values
  - Clause
```
public static final String Clause
```
    See Also:
    
    Constant Field Values
  - Var
```
public static final String Var
```
    See Also:
    
    Constant Field Values
  - Negation
```
public static final String Negation
```
    See Also:
    
    Constant Field Values
  - Stop
```
public static final String Stop
```
    See Also:
    
    Constant Field Values
  - Zero
```
public static final String Zero
```
    See Also:
    
    Constant Field Values
  - EOFToken
```
public static final String EOFToken
```
    See Also:
    
    Constant Field Values
  - filename
```
public String filename
```
  - type
```
public String type
```
  - literal
```
public String literal
```
  - line
```
public String line
```
  - SZS
```
public String SZS
```
  - pos
```
public int pos
```
  - input
```
public LineNumberReader input
```
  - tokenStack
```
public ArrayDeque<String> tokenStack
```
  - tokenDefs
```
public static LinkedHashMap<String,Pattern> tokenDefs
```
    This array contains all of the compiled Pattern objects that will be used by methods in this file.
  - andOr
```
public static ArrayList<String> andOr
```
  - binaryRel
```
public static ArrayList<String> binaryRel
```
  - quant
```
public static ArrayList<String> quant
```
- Constructor Detail
  - Lexer
```
public Lexer()
```
  - Lexer
```
public Lexer(String s)
```
  - Lexer
```
public Lexer(File f)
```
    Read a text file into the "input" String variables. Throws an error on file not found.
- Method Detail
  - file2string
```
public String file2string(File f)
```
    Read the contents of a text file into a String. Throws IOException
  - linepos
```
public int linepos()
```
    Returns:
    
    the line number of the token by counting all the newlines in the position up to the current token.
  - lookType
```
public String lookType()
                throws ParseException
```
    Returns:
    
    the next token type without consuming it.
    
    Throws:
    
    ParseException
  - look
```
public String look()
            throws ParseException
```
    Returns:
    
    the next token without consuming it.
    
    Throws:
    
    ParseException
  - lookLit
```
public String lookLit()
               throws ParseException
```
    Returns:
    
    the literal value of the next token, i.e. the string generating the token.
    
    Throws:
    
    ParseException
  - testTok
```
public boolean testTok(ArrayList<String> tokens)
                throws ParseException
```
    Take a list of expected token types.
    
    Returns:
    
    True if the next token is expected, False otherwise.
    
    Throws:
    
    ParseException
  - testTok
```
public boolean testTok(String tok)
                throws ParseException
```
    Convenience method
    
    Throws:
    
    ParseException
  - checkTok
```
public void checkTok(String tok)
              throws ParseException
```
    Take a list of expected token types. If the next token is not among the expected ones, exit with an error. Otherwise do nothing.
    
    Throws:
    
    ParseException
  - checkTok
```
public void checkTok(ArrayList<String> tokens)
              throws ParseException
```
    Take a list of expected token types. If the next token is not among the expected ones, exit with an error. Otherwise do nothing.
    
    Throws:
    
    ParseException
  - acceptTok
```
public String acceptTok(String token)
                 throws ParseException
```
    Take an expected token type. If the next token is the same as the expected one, consume and return it. Otherwise, exit with an error.
    
    Returns:
    
    the token matching the type of the input
    
    Throws:
    
    ParseException
  - acceptTok
```
public String acceptTok(ArrayList<String> tokens)
                 throws ParseException
```
    Take a list of expected token types. If the next token is among the expected ones, consume and return it. Otherwise, exit with an error.
    
    Returns:
    
    the token matching one of the types in the inputs
    
    Throws:
    
    ParseException
  - testLit
```
public boolean testLit(String litval)
                throws ParseException
```
    Parameters:
    
    litval - an expected literal string.
    
    Returns:
    
    True if the next token's string value the same as the input, False otherwise.
    
    Throws:
    
    ParseException
  - testLit
```
public boolean testLit(ArrayList<String> litvals)
                throws ParseException
```
    Parameters:
    
    litvals - a list of expected literal strings
    
    Returns:
    
    True if the next token's string value is among the input string and false otherwise.
    
    Throws:
    
    ParseException
  - acceptLit
```
public String acceptLit(ArrayList<String> litvals)
                 throws ParseException
```
    Take a list of expected literal strings. If the next token's literal is among the expected ones, consume and return the literal. Otherwise, exit with an error.
    
    Throws:
    
    ParseException
  - acceptLit
```
public String acceptLit(String litval)
                 throws ParseException
```
    Take a list of expected literal strings. If the next token's literal is among the expected ones, consume and return the literal. Otherwise, exit with an error.
    
    Throws:
    
    ParseException
  - next
```
public String next()
            throws ParseException
```
    Returns:
    
    next semantically relevant token (not whitespace, comments etc)
    
    Throws:
    
    ParseException
  - nextUnfiltered
```
public String nextUnfiltered()
                      throws ParseException
```
    Returns:
    
    next token, including tokens, such as whitespace and comments, that are ignored by most languages.
    
    Throws:
    
    ParseException
  - lex
```
public ArrayList<String> lex()
                      throws ParseException
```
    Return a list of all tokens in the source.
    
    Throws:
    
    ParseException
  - lexTypes
```
public ArrayList<String> lexTypes()
                           throws ParseException
```
    Return a list of all tokens in the source.
    
    Throws:
    
    ParseException
  - main
```
public static void main(String[] args)
```

Class Lexer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NoToken

WhiteSpace

Newline

SemiComment

Directive

Ident

Number

QuotedString

FullStop

OpenPar

ClosePar

OpenBracket

CloseBracket

Or

Plus

Comma

Implies

OptImplies

Clause

Var

Negation

Stop

Zero

EOFToken

filename

type

literal

line

SZS

pos

input

tokenStack

tokenDefs

andOr

binaryRel

quant

Constructor Detail

Lexer

Lexer

Lexer

Method Detail

file2string

linepos

lookType

look

lookLit

testTok

testTok

checkTok

checkTok

acceptTok

acceptTok

testLit

testLit

acceptLit

acceptLit

next

nextUnfiltered

lex

lexTypes

main