Trees       Indices       Help   
2017-2 Schrodinger Python API
Package schrodinger :: Package application :: Package desmond :: Package antlr3 :: Module tokens :: Class ClassicToken
[hide private]
[frames] | no frames]

Class ClassicToken

object --+    
         |    
     Token --+
             |
            ClassicToken

@brief Alternative token implementation.

A Token object like we'd use in ANTLR 2.x; has an actual string created and associated with this object. These objects are needed for imaginary tree nodes that have payload objects. We need to create a Token object that has a string; the tree node will point at this token. CommonToken has indexes into a char stream and hence cannot be used to introduce new strings.

Instance Methods [hide private]
 
__init__(self, type=None, text=None, channel=0, oldToken=None)
x.__init__(...) initializes x; see help(type(x)) for signature
 
getText(self)
@brief Get the text of the token.
 
setText(self, text)
@brief Set the text of the token.
 
getType(self)
@brief Get the type of the token.
 
setType(self, ttype)
@brief Get the type of the token.
 
getLine(self)
@brief Get the line number on which this token was matched
 
setLine(self, line)
@brief Set the line number on which this token was matched
 
getCharPositionInLine(self)
@brief Get the column of the tokens first character,
 
setCharPositionInLine(self, pos)
@brief Set the column of the tokens first character,
 
getChannel(self)
@brief Get the channel of the token
 
setChannel(self, channel)
@brief Set the channel of the token
 
getTokenIndex(self)
@brief Get the index in the input stream.
 
setTokenIndex(self, index)
@brief Set the index in the input stream.
 
getInputStream(self)
@brief From what character stream was this token created.
 
setInputStream(self, input)
@brief From what character stream was this token created.
 
toString(self)
str(x)
 
__str__(self)
str(x)
 
__repr__(self)
str(x)

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, type=None, text=None, channel=0, oldToken=None)
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

getText(self)

 

@brief Get the text of the token.

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

Overrides: Token.getText
(inherited documentation)

setText(self, text)

 

@brief Set the text of the token.

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

Overrides: Token.setText
(inherited documentation)

getType(self)

 

@brief Get the type of the token.

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

Overrides: Token.getType
(inherited documentation)

setType(self, ttype)

 

@brief Get the type of the token.

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

Overrides: Token.setType
(inherited documentation)

getLine(self)

 

@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.

Overrides: Token.getLine
(inherited documentation)

setLine(self, line)

 

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

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

Overrides: Token.setLine
(inherited documentation)

getCharPositionInLine(self)

 

@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.

Overrides: Token.getCharPositionInLine
(inherited documentation)

setCharPositionInLine(self, pos)

 

@brief Set the column of the tokens first character,

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

Overrides: Token.setCharPositionInLine
(inherited documentation)

getChannel(self)

 

@brief Get the channel of the token

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

Overrides: Token.getChannel
(inherited documentation)

setChannel(self, channel)

 

@brief Set the channel of the token

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

Overrides: Token.setChannel
(inherited documentation)

getTokenIndex(self)

 

@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.

Overrides: Token.getTokenIndex
(inherited documentation)

setTokenIndex(self, index)

 

@brief Set the index in the input stream.

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

Overrides: Token.setTokenIndex
(inherited documentation)

getInputStream(self)

 

@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.

Overrides: Token.getInputStream
(inherited documentation)

setInputStream(self, input)

 

@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.

Overrides: Token.setInputStream
(inherited documentation)

__str__(self)
(Informal representation operator)

 

str(x)

Overrides: object.__str__
(inherited documentation)

__repr__(self)
(Representation operator)

 

str(x)

Overrides: object.__repr__
(inherited documentation)

   Trees       Indices       Help   
2017-2 Schrodinger Python API
Generated by Epydoc 3.0.1 on Tue May 2 06:33:04 2017 http://epydoc.sourceforge.net