Public Member Functions | Public Attributes | Properties | Private Attributes
rve_interface_gen.antlr3.tokens.CommonToken Class Reference
Inheritance diagram for rve_interface_gen.antlr3.tokens.CommonToken:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def __init__
def __str__
def getChannel
def getCharPositionInLine
def getInputStream
def getLine
def getText
def getTokenIndex
def getType
def setChannel
def setCharPositionInLine
def setInputStream
def setLine
def setText
def setTokenIndex
def setType

Public Attributes

 channel
 charPositionInLine
 index
 input
 line
 start
 stop
 type

Properties

 text = property(getText, setText)

Private Attributes

 _text

Detailed Description

@brief Basic token implementation.

This implementation does not copy the text from the input stream upon
creation, but keeps start/stop pointers into the stream to avoid
unnecessary copy operations.

Definition at line 168 of file tokens.py.


Constructor & Destructor Documentation

def rve_interface_gen.antlr3.tokens.CommonToken.__init__ (   self,
  type = None,
  channel = DEFAULT_CHANNEL,
  text = None,
  input = None,
  start = None,
  stop = None,
  oldToken = None 
)

Definition at line 177 of file tokens.py.


Member Function Documentation

Definition at line 280 of file tokens.py.

@brief Get the channel of the token

Using setter/getter methods is deprecated. Use o.channel instead.

Reimplemented from rve_interface_gen.antlr3.tokens.Token.

Definition at line 259 of file tokens.py.

@brief Get the column of the tokens first character,

Columns are numbered 0..n-1

Using setter/getter methods is deprecated. Use o.charPositionInLine instead.

Reimplemented from rve_interface_gen.antlr3.tokens.Token.

Definition at line 252 of file tokens.py.

@brief From what character stream was this token created.

You don't have to implement but it's nice to know where a Token
comes from if you have include files etc... on the input.

Reimplemented from rve_interface_gen.antlr3.tokens.Token.

Definition at line 273 of file tokens.py.

@brief Get the line number on which this token was matched

Lines are numbered 1..n

Using setter/getter methods is deprecated. Use o.line instead.

Reimplemented from rve_interface_gen.antlr3.tokens.Token.

Definition at line 245 of file tokens.py.

@brief Get the text of the token.

Using setter/getter methods is deprecated. Use o.text instead.

Reimplemented from rve_interface_gen.antlr3.tokens.Token.

Definition at line 216 of file tokens.py.

@brief Get the index in the input stream.

An index from 0..n-1 of the token object in the input stream.
This must be valid in order to use the ANTLRWorks debugger.

Using setter/getter methods is deprecated. Use o.index instead.

Reimplemented from rve_interface_gen.antlr3.tokens.Token.

Definition at line 266 of file tokens.py.

@brief Get the type of the token.

Using setter/getter methods is deprecated. Use o.type instead.

Reimplemented from rve_interface_gen.antlr3.tokens.Token.

Definition at line 238 of file tokens.py.

@brief Set the channel of the token

Using setter/getter methods is deprecated. Use o.channel instead.

Reimplemented from rve_interface_gen.antlr3.tokens.Token.

Definition at line 262 of file tokens.py.

@brief Set the column of the tokens first character,

Using setter/getter methods is deprecated. Use o.charPositionInLine instead.

Reimplemented from rve_interface_gen.antlr3.tokens.Token.

Definition at line 255 of file tokens.py.

@brief From what character stream was this token created.

You don't have to implement but it's nice to know where a Token
comes from if you have include files etc... on the input.

Reimplemented from rve_interface_gen.antlr3.tokens.Token.

Definition at line 276 of file tokens.py.

@brief Set the line number on which this token was matched

Using setter/getter methods is deprecated. Use o.line instead.

Reimplemented from rve_interface_gen.antlr3.tokens.Token.

Definition at line 248 of file tokens.py.

Override the text for this token.  getText() will return this text
rather than pulling from the buffer.  Note that this does not mean
that start/stop indexes are not valid.  It means that that input
was converted to a new string in the token object.

Reimplemented from rve_interface_gen.antlr3.tokens.Token.

Definition at line 226 of file tokens.py.

@brief Set the index in the input stream.

Using setter/getter methods is deprecated. Use o.index instead.

Reimplemented from rve_interface_gen.antlr3.tokens.Token.

Definition at line 269 of file tokens.py.

@brief Get the type of the token.

Using setter/getter methods is deprecated. Use o.type instead.

Reimplemented from rve_interface_gen.antlr3.tokens.Token.

Definition at line 241 of file tokens.py.


Member Data Documentation

Definition at line 177 of file tokens.py.

Definition at line 177 of file tokens.py.

Definition at line 177 of file tokens.py.

Definition at line 177 of file tokens.py.

Definition at line 177 of file tokens.py.

Definition at line 177 of file tokens.py.

Definition at line 177 of file tokens.py.

Definition at line 177 of file tokens.py.

Definition at line 177 of file tokens.py.


Property Documentation

Definition at line 235 of file tokens.py.


The documentation for this class was generated from the following file:


rve_interface_gen
Author(s): Josh Faust
autogenerated on Wed Dec 11 2013 14:31:00