Describes the input token stream. More...
#include <vhdlparser/Token.h>
Collaboration diagram for vhdl::parser::Token:Public Member Functions | |
| void * | getValue () |
| An optional attribute value of the Token. | |
| Token () | |
| No-argument constructor. | |
| Token (int kind) | |
| Constructs a new token for the specified Image. | |
| Token (int kind, const JJString &image) | |
| Constructs a new token for the specified Image and Kind. | |
| virtual | ~Token () |
| const JJString & | toString () |
| Returns the image. | |
Static Public Member Functions | |
| static Token * | newToken (int ofKind, const JJString &image) |
| Returns a new Token void *, by default. | |
| static Token * | newToken (int ofKind) |
Public Attributes | |
| int | kind = 0 |
| An integer that describes the kind of this token. | |
| int | beginLine = 0 |
| The line number of the first character of this Token. | |
| int | beginColumn = 0 |
| The column number of the first character of this Token. | |
| int | endLine = 0 |
| The line number of the last character of this Token. | |
| int | endColumn = 0 |
| The column number of the last character of this Token. | |
| JJString | image |
| The string image of the token. | |
| Token * | next = 0 |
| A reference to the next regular (non-special) token from the input stream. | |
| Token * | specialToken = 0 |
| This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token. | |
Detailed Description
Constructor & Destructor Documentation
◆ Token() [1/3]
| vhdl::parser::Token::Token | ( | ) |
No-argument constructor.
Referenced by newToken(), and newToken().
◆ Token() [2/3]
| vhdl::parser::Token::Token | ( | int | kind | ) |
◆ Token() [3/3]
| vhdl::parser::Token::Token | ( | int | kind, |
| const JJString & | image ) |
◆ ~Token()
|
virtual |
Member Function Documentation
◆ getValue()
| void * vhdl::parser::Token::getValue | ( | ) |
An optional attribute value of the Token.
Tokens which are not used as syntactic sugar will often contain meaningful values that will be used later on by the compiler or interpreter. This attribute value is often different from the image. Any subclass of Token that actually wants to return a non-NULL value can override this method as appropriate.
◆ newToken() [1/2]
◆ newToken() [2/2]
Returns a new Token void *, by default.
However, if you want, you can create and return subclass objects based on the value of ofKind. Simply add the cases to the switch for all those special cases. For example, if you have a subclass of Token called IDToken that you want to create if ofKind is ID, simply add something like :
case MyParserConstants.ID : return new IDToken(ofKind, image);
to the following switch statement. Then you can cast matchedToken variable to the appropriate type and use sit in your lexical actions.
◆ toString()
| const JJString & vhdl::parser::Token::toString | ( | ) |
Returns the image.
Member Data Documentation
◆ beginColumn
| int vhdl::parser::Token::beginColumn = 0 |
The column number of the first character of this Token.
Definition at line 30 of file Token.h.
Referenced by vhdl::parser::ErrorHandler::handleParseError(), and vhdl::parser::ErrorHandler::handleUnexpectedToken().
◆ beginLine
| int vhdl::parser::Token::beginLine = 0 |
The line number of the first character of this Token.
Definition at line 28 of file Token.h.
Referenced by vhdl::parser::ErrorHandler::handleParseError(), vhdl::parser::VhdlErrorHandler::handleParseError(), vhdl::parser::ErrorHandler::handleUnexpectedToken(), and vhdl::parser::VhdlErrorHandler::handleUnexpectedToken().
◆ endColumn
| int vhdl::parser::Token::endColumn = 0 |
◆ endLine
| int vhdl::parser::Token::endLine = 0 |
◆ image
| JJString vhdl::parser::Token::image |
The string image of the token.
Definition at line 39 of file Token.h.
Referenced by vhdl::parser::ErrorHandler::handleParseError(), vhdl::parser::VhdlErrorHandler::handleParseError(), vhdl::parser::ErrorHandler::handleUnexpectedToken(), vhdl::parser::VhdlErrorHandler::handleUnexpectedToken(), newToken(), and Token().
◆ kind
| int vhdl::parser::Token::kind = 0 |
An integer that describes the kind of this token.
This numbering system is determined by JavaCCParser, and a table of these numbers is stored in the file ...Constants.java.
Definition at line 25 of file Token.h.
Referenced by vhdl::parser::VhdlParser::checkListTok(), vhdl::parser::VhdlParser::checkNextTok(), VHDLOutlineParser::error_skipto(), Token(), and Token().
◆ next
| Token* vhdl::parser::Token::next = 0 |
A reference to the next regular (non-special) token from the input stream.
If this is the last token from the input stream, or if the token manager has not read tokens beyond this one, this field is set to NULL. This is true only if this token is also a regular token. Otherwise, see below for a description of the contents of this field.
◆ specialToken
| Token* vhdl::parser::Token::specialToken = 0 |
This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token.
If there are no such special tokens, this field is set to NULL. When there are more than one such special token, this field refers to the last of these special tokens, which in turn refers to the next previous special token through its specialToken field, and so on until the first special token (whose specialToke_ field is NULL). The next fields of special tokens refer to other special tokens that immediately follow it (without an intervening regular token). If there is no such token, this field is NULL.
The documentation for this class was generated from the following file:
- vhdlparser/Token.h
