Source-highlight Library
srchilite::StateStartLangElem Class Referenceabstract

A language element that may start a new state/environment. More...

#include <statestartlangelem.h>

Inheritance diagram for srchilite::StateStartLangElem:
Collaboration diagram for srchilite::StateStartLangElem:

Public Member Functions

 StateStartLangElem (const std::string &n, unsigned int exit=0, bool all=false)
 
virtual const std::string toString () const
 return the string representation (with preprocessing) More...
 
void setExit (unsigned int level=1)
 Sets the "exit" property of this element (i.e., if the element is match then exit one state) More...
 
void setExitAll ()
 Sets the "exit all" property of this element (i.e., if the element is match then exit all states and get back to the main initial state)
 
bool exitAll () const
 
unsigned int getExit () const
 
StateLangElemgetStateLangElem () const
 
void setStateLangElem (StateLangElem *s)
 Sets the state for which this element represents the start. More...
 
const std::string getName () const
 
virtual const std::string toStringOriginal () const =0
 return the original representation (without any preprocessing); this is useful for printing errors More...
 
bool isRedef () const
 
void setRedef ()
 
bool isSubst () const
 
void setSubst ()
 
const std::string toStringParserInfo () const
 
virtual void dispatch_build (HighlightStateBuilder *, HighlightState *state)
 
virtual void dispatch_collect_const (LangElemsPrinter *)
 
void setParserInfo (const std::string &name, unsigned int l)
 
void setParserInfo (const ParserInfo *p)
 

Public Attributes

std::string filename
 
unsigned int line
 

Private Attributes

unsigned int exit
 the exit level
 
bool exit_all
 whether to exit all states
 
StateLangElemstatelangelem
 the possible State of which we represent the start.
 

Detailed Description

A language element that may start a new state/environment.

Constructor & Destructor Documentation

srchilite::StateStartLangElem::StateStartLangElem ( const std::string &  n,
unsigned int  exit = 0,
bool  all = false 
)
Parameters
namesthe element names (one for each subexpression)
exitwhether to exit a number of states (default 0)
allwhether to exit all states

Member Function Documentation

bool srchilite::StateStartLangElem::exitAll ( ) const
inline
Returns
whether the "exit" property is set
unsigned int srchilite::StateStartLangElem::getExit ( ) const
inline
Returns
whether the "exit all" property is set
StateLangElem* srchilite::StateStartLangElem::getStateLangElem ( ) const
inline
Returns
the state for which this element represents the start
void srchilite::StateStartLangElem::setExit ( unsigned int  level = 1)
inline

Sets the "exit" property of this element (i.e., if the element is match then exit one state)

Parameters
levelthe exit level (default to 1)
void srchilite::StateStartLangElem::setStateLangElem ( StateLangElem s)
inline

Sets the state for which this element represents the start.

Parameters
sthe state for which this element represents the start
virtual const std::string srchilite::StateStartLangElem::toString ( ) const
virtual

return the string representation (with preprocessing)

Returns
the string representation

Reimplemented from srchilite::srchilite::LangElem.

virtual const std::string srchilite::srchilite::LangElem::toStringOriginal ( ) const
pure virtualinherited
const std::string srchilite::LangElem::toStringParserInfo ( ) const
inherited
Returns
a string representation of the ParserInfo struct

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