BlockToken Class Reference

BlockToken token class. More...

Inherited Class(es)

• public gsp::Symbol [ virtual ]
• public BlockTokenComposite
• public universal::String

• BlockToken ( ) 
• virtual ~BlockToken ( ) 
• universal::String getSymbolName ( ) const 
• virtual bool parseSymbol ( gsp::LLParser & parser , gsp::Symbol * & rpReturnSymbol , gsp::Symbol * pParent = NULL ) 
• bool parseSymbol ( ini::Parser & parser , BlockToken * & rpReturnSymbol , gsp::Symbol * pParent = NULL ) 
• bool parseRoot ( ini::Parser & parser , BlockToken * & pReturnSymbol , gsp::Symbol * pParent = NULL , bool bBreakOff = true ) 
• virtual bool parse ( std::istream & is , std::ostream & os , gsp::Symbol * pParent = NULL , bool bExpectEOF = false , bool bDeactivatePreprocessing = false ) 
• virtual bool parse ( std::istream & is , gsp::Symbol * pParent = NULL , bool bExpectEOF = false , bool bDeactivatePreprocessing = false ) 
• virtual bool expand ( std::ostream & os , bool bRestoreWS = true ) 
• virtual bool backtrace ( std::ostream & os ) 
• virtual bool test ( std::ostream & os , bool bVerbose = false ) 
• universal::String expand ( bool bTrimFirstWhitespaces = true , bool bRestoreWS = true ) 
• virtual bool isToken ( ) const 
• virtual bool isNonTerminal ( ) const 
• virtual void reset ( ) 

• bool readBlock ( const char * pszStartDelimiter , const char * pszEndDelimiter , std::istream & is , bool bIgnoreCase = false ) 

• static int maxOccurrences ( ) 
• static int minOccurrences ( ) 
• static void maxOccurrences ( int iMaxOcc ) 
• static void minOccurrences ( int iMinOcc ) 
• static bool is_a ( gsp::Symbol * pSymbol ) 
• static BlockTokenFactory & factory ( ) 
• static void setFactory ( BlockTokenFactory * pNewFactory ) 

• unsigned char m_cWsFlag [ 1 ] [ 20 ] 
• unsigned short m_uNbWs [ 1 ] 

• BlockTokenFactory * ms_factory 
• int m_iMaxOccurrences 
• int m_iMinOccurrences 

• class BlockTokenFactory 

Detailed Description

BlockToken token class.

This class provides the parse and expand code for a BlockToken token. It includes the code written for this token in the gsp file.

Functions Documentation

Returns the maximum allowed number of occurrences of this symbol or -1 if there is no limit.

See also:

Returns the minimum required number of occurrences of this symbol or -1 if there is no limit.

See also:

Sets the maximum allowed number of occurrences of this symbol. -1 if there is no limit.

See also:

Sets the minimum required number of occurrences of this symbol. -1 if there is no limit.

See also:

Token symbol class constructor.

See also:

Token class destructor.

See also:

Tells whether the symbol is token.

See also:

Tells whether the symbol is a non-terminal.

See also:

Please refer to the matching overriden method description in base class.

See also:

Used internally by the generated code to carry out the parsing of the token. Basically executes the parse code written for this token in the gsp file.

See also:

This function attempts to carry out a raw parsing of this symbol using parser, without pre-processing the input stream before.

The symbol is parsed as the root symbol would be, i.e. the line numbering in stream starts counting from zero and it is checked that the end of the stream is encountered if a stream break-off was expected.

pReturnSymbol is the symbol pointer returned by the parsing.

pParent gives the initial parent for the symbol parent to parse. By default it is null, i.e. the symbol is the root and has no parent.

bBreakOff tells whether a stream break-off is expected at the end of the parsing (true by default).

Returns true when the symbol could be successfully parsed, regardless of whether user errors were raised from reduction code. For that purpose, the return value of fail() should also always be checked in parallel to handle these errors.

See also:

This function attempts to parse this symbol in a input stream is and error messages are re-directed to output stream os.

pParent gives the initial parent for the symbol parent to parse. By default it is null, i.e. the symbol is the root and has no parent.

bDeactivatePreprocessing tells whether preprocessing should be deactivated before the actual parsing takes place. This argument is optional and is set to false by default.

The symbol is parsed as the root symbol would be, i.e. the line numbering in stream starts counting from zero.

bExpectEOF tells whether to expect an end-of-stream at the end of parsing. This parameter is optional and set to false by default.

This function is useful when the users don't want to parse a stream starting from the root symbol of the grammar, but from whatever else symbol, without having to create by himself the parser object and output possible error messages.

With this function there is no way to get the symbol returned by the reduction code.

Basically, calling this method is equivalent to:

Example:

  ...Parser parser(is);
  ...parser.deactivatePreprocessing(bDeactivatePreprocessing);
  ...parser.preprocess();
  ...parseRoot();

See also:

This overloaded function is provided for convenience and behaves like the above function, except that error messages are forced to be output on the standard error output cerr.

Therefore, it is strictly equivalent to calling:

parse(is, cerr, pParent, bDeactivatePreprocessing)

See also:

Expands the token. See documentation of overriden method referred to below.

This method ensures the following:

- If the default/normal expanding was ok and it is the root, the original trailing whitespaces are restored.

- If the token is a composite, the expanding will result of the expanding of all components.

- Return true on success only.

NO end-of-stream char ('\0') is appended to the result string.

See also:

This function is provided for convenience and behaves like the other expand() function, except that :

on failure an empty string is returned;

the first leading whitespaces are removed by default. This can be switched off by setting bTrimFirstWhitespaces to false.

bRestoreWS is also optional and tells whether to restore all whitespaces. This is the case by default. If not so, the value of bTrimFirstWhitespaces is actually overriden and ignored.

See also:

Backtraces the non-terminal.

See also:

Tests the symbol according to the test cases specified along with with the symbol definition.

For further information please see the test() function of the base symbol class.

See also:

Returns the factory object for such token.

See also:

Sets pNewFactory as the new factory object for such token.

The previous factory is not destroyed.

See also:

Tells whether the passed symbol pointer narrows to a symbol pointer of this type.

See also:

Returns the name of this token class.

See also:

Please refer to the matching overriden method description in base class.

If the token inherits from universal::String, the string is emptied.

See also:

See also: