Symbol (Syntax Compiler-Compiler 4.2.0 API)

java.lang.Object
- me.jaimegarza.syntax.model.parser.Symbol

Direct Known Subclasses:: NonTerminal, Terminal

public abstract class Symbol
extends Object

~pojo class

Represents a symbol in the grammar. Symbols have the following hierarchy:

  -+ Symbol
   |
   +--+ Terminal     - Lexical Symbol (i.e. number, id '+')
   |  |
   |  +-- ErrorToken - Lexical Symbol declared with %error
   |
   +--NonTerminal    - Syntactical symbol (i.e. Expression, Statement)

This class is abstract.

Author:: jaimegarza@gmail.com

Field Summary

Fields
Modifier and Type	Field and Description
`protected Associativity`	`associativity` The associativity of a given symbol.
`protected int`	`count` Reference count of the symbol
`protected String`	`fullName` the full name.
`protected int`	`id` The numeric identifier for the symbol.
`protected String`	`name` the name of the symbol.
`protected int`	`precedence` The numeric precedence of the symbol.
`protected int`	`token` The lexical value returned from the lexical analyzer.
`protected Type`	`type` The type of the symbol.
`protected String`	`variable` A language-named representation of a terminal.

Constructor Summary

Constructors
Constructor and Description

Symbol(String name)

Constructors
Constructor and Description
`Symbol(String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`computeVariable()` Compute a language usable variable name
`boolean`	`equals(Object obj)`
`Associativity`	`getAssociativity()`
`int`	`getCount()`
`String`	`getFullName()`
`int`	`getId()`
`String`	`getName()`
`int`	`getPrecedence()`
`int`	`getToken()`
`Type`	`getType()`
`String`	`getVariable()`
`boolean`	`isIdentifier()` is the name of this non-terminal already a good variable name
`void`	`setAssociativity(Associativity associativity)`
`void`	`setCount(int count)`
`void`	`setFullName(String fullName)`
`void`	`setId(int id)`
`void`	`setName(String name)`
`void`	`setPrecedence(int precedence)`
`void`	`setToken(int token)`
`void`	`setType(Type type)`
`String`	`toString()` Minimal representation.

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

- Field Detail
  - id
```
protected int id
```
    The numeric identifier for the symbol. Sequence.
  - name
```
protected String name
```
    the name of the symbol.
  - fullName
```
protected String fullName
```
    the full name. by default it equals the name, but a full name can be declared in the grammar spec. Useful for error generation.
  - precedence
```
protected int precedence
```
    The numeric precedence of the symbol. Precedence is used, when provided to resolve ambiguities when giving LR grammars with conflicts.
    precedence is usually provided with %prec. Usually the associativity with higher precedence is picked for a Rule
    For conflict resolution:
```
   if shift-reduce conflict
      left associativity implies reduce
      right associativity implies shift
      non assoc implies error
```
  - associativity
```
protected Associativity associativity
```
    The associativity of a given symbol. Associativity is used, when provided, to resolve ambiguities when providing LR grammars with conflicts.
  - count
```
protected int count
```
    Reference count of the symbol
  - token
```
protected int token
```
    The lexical value returned from the lexical analyzer. Can be provided in %token
  - type
```
protected Type type
```
    The type of the symbol. A type is a string that is used on the generation phase to resolve $$, $1, $2, etc. They get properly replaced with stack references like:
    stack[stackTop-1].type
  - variable
```
protected String variable
```
    A language-named representation of a terminal. This code is computed
- Constructor Detail
  - Symbol
```
public Symbol(String name)
```
- Method Detail
  - computeVariable
```
public void computeVariable()
```
    Compute a language usable variable name
  - isIdentifier
```
public boolean isIdentifier()
```
    is the name of this non-terminal already a good variable name
    
    Returns:
    
    true if it is an identifier
  - getVariable
```
public String getVariable()
```
  - getId
```
public int getId()
```
    Returns:
    
    the id
  - setId
```
public void setId(int id)
```
    Parameters:
    
    id - the id to set
  - getName
```
public String getName()
```
    Returns:
    
    the name
  - setName
```
public void setName(String name)
```
    Parameters:
    
    name - the name to set
  - getFullName
```
public String getFullName()
```
    Returns:
    
    the fullName
  - setFullName
```
public void setFullName(String fullName)
```
    Parameters:
    
    fullName - the fullName to set
  - getPrecedence
```
public int getPrecedence()
```
    Returns:
    
    the precedence
  - setPrecedence
```
public void setPrecedence(int precedence)
```
    Parameters:
    
    precedence - the precedence to set
  - getAssociativity
```
public Associativity getAssociativity()
```
    Returns:
    
    the associativity
  - setAssociativity
```
public void setAssociativity(Associativity associativity)
```
    Parameters:
    
    associativity - the associativity to set
  - getCount
```
public int getCount()
```
    Returns:
    
    the count
  - setCount
```
public void setCount(int count)
```
    Parameters:
    
    count - the count to set
  - getToken
```
public int getToken()
```
    Returns:
    
    the token
  - setToken
```
public void setToken(int token)
```
    Parameters:
    
    token - the token to set
  - getType
```
public Type getType()
```
    Returns:
    
    the type
  - setType
```
public void setType(Type type)
```
    Parameters:
    
    type - the type to set
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - toString
```
public String toString()
```
    Minimal representation. Returns the name for simplicity of other objects' toString() implementations.
    
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()

Class Symbol

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

name

fullName

precedence

associativity

count

token

type

variable

Constructor Detail

Symbol

Method Detail

computeVariable

isIdentifier

getVariable

getId

setId

getName

setName

getFullName

setFullName

getPrecedence

setPrecedence

getAssociativity

setAssociativity

getCount

setCount

getToken

setToken

getType

setType

equals

toString