#include <OgreCompositorScriptCompiler.h>
Inheritance diagram for Ogre::CompositorScriptCompiler:
Public Member Functions | |
CompositorScriptCompiler (void) | |
~CompositorScriptCompiler (void) | |
virtual const String & | getClientBNFGrammer (void) const |
gets BNF Grammer for Compositor script. | |
virtual const String & | getClientGrammerName (void) const |
get the name of the Compositor script BNF grammer. | |
void | parseScript (DataStreamPtr &stream, const String &groupName) |
Compile a compositor script from a data stream using a specific resource group name. | |
bool | compile (const String &source, const String &sourceName) |
compile the source - performs 2 passes. | |
Protected Types | |
typedef void(CompositorScriptCompiler::* | CSC_Action )(void) |
typedef std::map< size_t, CSC_Action > | TokenActionMap |
typedef TokenActionMap::iterator | TokenActionIterator |
enum | TokenID { ID_UNKOWN = 0, ID_TARGET_WIDTH, ID_TARGET_HEIGHT, ID_PF_A8R8G8B8, ID_PF_R8G8B8A8, ID_PF_R8G8B8, ID_PF_FLOAT16_R, ID_PF_FLOAT16_RGB, ID_PF_FLOAT16_RGBA, ID_PF_FLOAT32_R, ID_PF_FLOAT32_RGB, ID_PF_FLOAT32_RGBA, ID_PF_FLOAT16_GR, ID_PF_FLOAT32_GR, ID_PREVIOUS, ID_NONE, ID_RENDER_QUAD, ID_CLEAR, ID_STENCIL, ID_RENDER_SCENE, ID_CLR_COLOUR, ID_CLR_DEPTH, ID_ST_ALWAYS_FAIL, ID_ST_ALWAYS_PASS, ID_ST_LESS, ID_ST_LESS_EQUAL, ID_ST_EQUAL, ID_ST_NOT_EQUAL, ID_ST_GREATER_EQUAL, ID_ST_GREATER, ID_ST_KEEP, ID_ST_ZERO, ID_ST_REPLACE, ID_ST_INCREMENT, ID_ST_DECREMENT, ID_ST_INCREMENT_WRAP, ID_ST_DECREMENT_WRAP, ID_ST_INVERT, ID_ON, ID_OFF, ID_TRUE, ID_FALSE, ID_AUTOTOKENSTART } |
enum | CompositorScriptSection { CSS_NONE, CSS_COMPOSITOR, CSS_TECHNIQUE, CSS_TARGET, CSS_PASS } |
Enum to identify compositor sections. More... | |
typedef std::vector< TokenRule > | TokenRuleContainer |
typedef TokenRuleContainer::iterator | TokenRuleIterator |
typedef std::vector< LexemeTokenDef > | LexemeTokenDefContainer |
typedef LexemeTokenDefContainer::iterator | LexemeTokenDefIterator |
typedef std::map< std::string, size_t > | LexemeTokenMap |
typedef LexemeTokenMap::iterator | TokenKeyIterator |
typedef std::vector< TokenInst > | TokenInstContainer |
typedef TokenInstContainer::iterator | TokenInstIterator |
typedef std::map< size_t, String > | LabelContainer |
storage container for string labels defined in source container uses Token index as a key associated with a label | |
enum | OperationType { otUNKNOWN, otRULE, otAND, otOR, otOPTIONAL, otREPEAT, otDATA, otNOT_TEST, otINSERT_TOKEN, otEND } |
enum | SystemRuleToken { _no_token_ = SystemTokenBase, _character_, _value_, _no_space_skip_ } |
enum | BNF_ID { BNF_UNKOWN = 0, BNF_SYNTAX, BNF_RULE, BNF_IDENTIFIER, BNF_IDENTIFIER_RIGHT, BNF_IDENTIFIER_CHARACTERS, BNF_ID_BEGIN, BNF_ID_END, BNF_CONSTANT_BEGIN, BNF_SET_RULE, BNF_EXPRESSION, BNF_AND_TERM, BNF_OR_TERM, BNF_TERM, BNF_TERM_ID, BNF_CONSTANT, BNF_OR, BNF_TERMINAL_SYMBOL, BNF_TERMINAL_START, BNF_REPEAT_EXPRESSION, BNF_REPEAT_BEGIN, BNF_REPEAT_END, BNF_SET, BNF_SET_BEGIN, BNF_SET_END, BNF_NOT_TEST, BNF_NOT_TEST_BEGIN, BNF_CONDITIONAL_TOKEN_INSERT, BNF_OPTIONAL_EXPRESSION, BNF_NOT_EXPRESSION, BNF_NOT_CHK, BNF_OPTIONAL_BEGIN, BNF_OPTIONAL_END, BNF_NO_TOKEN_START, BNF_SINGLEQUOTE, BNF_SINGLE_QUOTE_EXC, BNF_SET_END_EXC, BNF_ANY_CHARACTER, BNF_SPECIAL_CHARACTERS1, BNF_SPECIAL_CHARACTERS2, BNF_WHITE_SPACE_CHK, BNF_LETTER, BNF_LETTER_DIGIT, BNF_DIGIT, BNF_WHITE_SPACE, BNF_ALPHA_SET, BNF_NUMBER_SET, BNF_SPECIAL_CHARACTER_SET1, BNF_SPECIAL_CHARACTER_SET2, BNF_SPECIAL_CHARACTER_SET3, BNF_NOT_CHARS, BNF_AUTOTOKENSTART } |
Protected Member Functions | |
virtual void | executeTokenAction (const size_t tokenID) |
Execute an Action associated with a token. | |
virtual size_t | getAutoTokenIDStart () const |
Get the start position of auto generated token IDs. | |
virtual void | setupTokenDefinitions (void) |
Associate all the lexemes used in a material script with their corresponding tokens and actions. | |
void | addLexemeTokenAction (const String &lexeme, const size_t token, const CSC_Action action=0) |
void | addLexemeAction (const String &lexeme, const CSC_Action action) |
void | logParseError (const String &error) |
void | parseOpenBrace (void) |
void | parseCloseBrace (void) |
void | parseCompositor (void) |
void | parseTechnique (void) |
void | parseTexture (void) |
void | parseTarget (void) |
void | parseInput (void) |
void | parseTargetOutput (void) |
void | parseOnlyInitial (void) |
void | parseVisibilityMask (void) |
void | parseLodBias (void) |
void | parseMaterialScheme (void) |
void | parsePass (void) |
void | parseMaterial (void) |
void | parseFirstRenderQueue (void) |
void | parseLastRenderQueue (void) |
void | parseIdentifier (void) |
void | parseClearBuffers (void) |
void | parseClearColourValue (void) |
void | parseClearDepthValue (void) |
void | parseClearStencilValue (void) |
void | parseStencilCheck (void) |
void | parseStencilFunc (void) |
void | parseStencilRefVal (void) |
void | parseStencilMask (void) |
void | parseStencilFailOp (void) |
void | parseStencilDepthFailOp (void) |
void | parseStencilPassOp (void) |
void | parseStencilTwoSided (void) |
StencilOperation | extractStencilOp (void) |
CompareFunction | extractCompareFunc (void) |
bool | doPass1 () |
perform pass 1 of compile process scans source for lexemes that can be tokenized and then performs general semantic and context verification on each lexeme before it is tokenized. | |
bool | doPass2 () |
performs Pass 2 of compile process which is execution of the tokens | |
const TokenInst & | getNextToken (const size_t expectedTokenID=0) const |
Gets the next token from the instruction que. | |
const TokenInst & | getCurrentToken (const size_t expectedTokenID=0) const |
Gets the current token from the instruction que. | |
bool | testNextTokenID (const size_t expectedTokenID) const |
If a next token instruction exist then test if its token ID matches. | |
bool | testCurrentTokenID (const size_t expectedTokenID) const |
If a current token instruction exist then test if its token ID matches. | |
void | skipToken (void) const |
skip to the next token in the pass2 queue. | |
void | replaceToken (void) |
go back to the previous token in the pass2 queue. | |
float | getNextTokenValue (void) const |
Gets the next token's associated floating point value in the instruction que that was parsed from the text source. | |
float | getCurrentTokenValue (void) const |
Gets the current token's associated floating point value in the instruction que that was parsed from the text source. | |
const String & | getNextTokenLabel (void) const |
Gets the next token's associated text label in the instruction que that was parsed from the text source. | |
const String & | getCurrentTokenLabel (void) const |
Gets the next token's associated text label in the instruction que that was parsed from the text source. | |
size_t | getNextTokenID (void) const |
Get the next token's ID value. | |
size_t | getCurrentTokenID (void) const |
Get the current token's ID value. | |
const String & | getNextTokenLexeme (void) const |
Get the next token's lexeme string. | |
const String & | getCurrentTokenLexeme (void) const |
Get the current token's lexeme string. | |
size_t | getPass2TokenQueCount (void) const |
Gets the number of tokens waiting in the instruction que that need to be processed by an token action in pass 2. | |
size_t | getRemainingTokensForAction (void) const |
Get the number of tokens not processed by action token. | |
void | setPass2TokenQuePosition (size_t pos, const bool activateAction=false) |
Manualy set the Pass2 Token que position. | |
size_t | getPass2TokenQuePosition (void) const |
Get the current position in the Pass2 Token Que. | |
bool | setNextActionQuePosition (size_t pos, const bool search=false) |
Set the position of the next token action in the Pass2 Token Que. | |
size_t | addLexemeToken (const String &lexeme, const size_t token, const bool hasAction=false, const bool caseSensitive=false) |
Add a lexeme token association. | |
void | setClientBNFGrammer (void) |
Sets up the parser rules for the client based on the BNF Grammer text passed in. | |
void | findEOL () |
find the eol charater | |
bool | isFloatValue (float &fvalue, size_t &charsize) const |
check to see if the text at the present position in the source is a numerical constant | |
bool | isCharacterLabel (const size_t rulepathIDX) |
Check if source at current position is supposed to be a user defined character label. | |
bool | isLexemeMatch (const String &lexeme, const bool caseSensitive) const |
check to see if the text is in the lexeme text library | |
bool | isEndOfSource () const |
Check if pass 1 has parsed to the end of the source. | |
bool | positionToNextLexeme () |
position to the next possible valid sysmbol | |
bool | processRulePath (size_t rulepathIDX) |
process input source text using rulepath to determine allowed tokens | |
void | setActiveContexts (const uint contexts) |
setup ActiveContexts - should be called by subclass to setup initial language contexts | |
void | skipComments () |
comment specifiers are hard coded | |
void | skipEOL () |
find end of line marker and move past it | |
void | skipWhiteSpace () |
skip all the white space which includes spaces and tabs | |
bool | ValidateToken (const size_t rulepathIDX, const size_t activeRuleID) |
check if current position in source has the lexeme text equivalent to the TokenID | |
void | verifyTokenRuleLinks (const String &grammerName) |
scan through all the rules and initialize token definition with index to rules for non-terminal tokens. | |
void | checkTokenActionTrigger (void) |
Checks the last token instruction and if it has an action then it triggers the action of the previously found token having an action. | |
String | getBNFGrammerTextFromRulePath (size_t ruleID, const size_t level=0) |
Get the text representation of the rule path. | |
Protected Attributes | |
CompositorScriptContext | mScriptContext |
TokenState * | mClientTokenState |
TokenState * | mActiveTokenState |
Active token que, definitions, rules currntly being used by parser. | |
size_t | mPass2TokenQuePosition |
the location within the token instruction container where pass 2 is | |
size_t | mPreviousActionQuePosition |
the que position of the previous token that had an action. | |
size_t | mNextActionQuePosition |
the que position for the next token that has an action. | |
const String * | mSource |
pointer to the source to be compiled | |
String | mSourceName |
name of the source to be compiled | |
size_t | mEndOfSource |
size_t | mCurrentLine |
size_t | mCharPos |
current line number in source being tokenized | |
size_t | mErrorCharPos |
position in current line in source being tokenized | |
std::map< size_t, float > | mConstants |
storage container for constants defined in source container uses Token index as a key associated with a float constant | |
LabelContainer | mLabels |
bool | mLabelIsActive |
flag indicates when a label is being parsed. | |
size_t | mActiveLabelKey |
the key of the active label being built during pass 1. | |
String * | mActiveLabel |
The active label that is receiving characters during pass 1. | |
bool | mNoSpaceSkip |
flag being true indicates that spaces are not to be skipped automatically gets set to false when mLabelIsActive goes to false | |
bool | mNoTerminalToken |
if flag is true then next terminal token is not added to token que if found but does effect rule path flow | |
size_t | mInsertTokenID |
TokenID to insert if next rule finds a terminal token if zero then no token inserted. | |
uint | mActiveContexts |
Active Contexts pattern used in pass 1 to determine which tokens are valid for a certain context. | |
Static Protected Attributes | |
static TokenActionMap | mTokenActionMap |
Map of Token value as key to an Action. | |
static const size_t | SystemTokenBase = 1000 |
Classes | |
struct | CompositorScriptContext |
Struct for holding the script context while parsing. More... |
Definition at line 42 of file OgreCompositorScriptCompiler.h.
|
Definition at line 127 of file OgreCompositorScriptCompiler.h. |
|
storage container for string labels defined in source container uses Token index as a key associated with a label
Definition at line 287 of file OgreCompiler2Pass.h. |
|
Definition at line 228 of file OgreCompiler2Pass.h. |
|
Definition at line 229 of file OgreCompiler2Pass.h. |
|
Definition at line 231 of file OgreCompiler2Pass.h. |
|
Definition at line 129 of file OgreCompositorScriptCompiler.h. |
|
Definition at line 128 of file OgreCompositorScriptCompiler.h. |
|
Definition at line 246 of file OgreCompiler2Pass.h. |
|
Definition at line 247 of file OgreCompiler2Pass.h. |
|
Definition at line 232 of file OgreCompiler2Pass.h. |
|
Definition at line 174 of file OgreCompiler2Pass.h. |
|
Definition at line 175 of file OgreCompiler2Pass.h. |
|
Definition at line 185 of file OgreCompiler2Pass.h. |
|
Enum to identify compositor sections.
Definition at line 106 of file OgreCompositorScriptCompiler.h. |
|
Definition at line 158 of file OgreCompiler2Pass.h. |
|
Definition at line 178 of file OgreCompiler2Pass.h. |
|
Definition at line 72 of file OgreCompositorScriptCompiler.h. |
|
|
|
|
|
Definition at line 147 of file OgreCompositorScriptCompiler.h. |
|
Add a lexeme token association.
|
|
|
|
Checks the last token instruction and if it has an action then it triggers the action of the previously found token having an action.
|
|
compile the source - performs 2 passes. First pass is to tokinize, check semantics and context. The second pass is performed by using tokens to look up function implementors and executing them which convert tokens to application specific instructions.
|
|
perform pass 1 of compile process scans source for lexemes that can be tokenized and then performs general semantic and context verification on each lexeme before it is tokenized. A tokenized instruction list is built to be used by Pass 2. A rule path can trigger Pass 2 execution if enough tokens have been generated in Pass 1. Pass 1 will then pass control to pass 2 temporarily until the current tokens have been consumed. |
|
performs Pass 2 of compile process which is execution of the tokens
|
|
Execute an Action associated with a token. Gets called when the compiler finishes tokenizing a section of the source that has been parsed. Implements Ogre::Compiler2Pass. |
|
|
|
|
|
find the eol charater
|
|
Get the start position of auto generated token IDs.
Implements Ogre::Compiler2Pass. Definition at line 142 of file OgreCompositorScriptCompiler.h. |
|
Get the text representation of the rule path. This is a good way to way to visually verify that the BNF grammer did compile correctly.
|
|
gets BNF Grammer for Compositor script.
Implements Ogre::Compiler2Pass. |
|
get the name of the Compositor script BNF grammer.
Implements Ogre::Compiler2Pass. |
|
Gets the current token from the instruction que.
|
|
Get the current token's ID value.
Definition at line 431 of file OgreCompiler2Pass.h. |
|
Gets the next token's associated text label in the instruction que that was parsed from the text source. If an unkown token is found or no associated label was found then an exception is raised. The subclass should catch the exception, provide an error message, and attempt recovery. |
|
Get the current token's lexeme string. Handy when you don't want the ID but want the string representation. |
|
Gets the current token's associated floating point value in the instruction que that was parsed from the text source.
|
|
Gets the next token from the instruction que.
Definition at line 356 of file OgreCompiler2Pass.h. |
|
Get the next token's ID value.
Definition at line 428 of file OgreCompiler2Pass.h. |
|
Gets the next token's associated text label in the instruction que that was parsed from the text source.
Definition at line 416 of file OgreCompiler2Pass.h. |
|
Get the next token's lexeme string. Handy when you don't want the ID but want the string representation. Definition at line 435 of file OgreCompiler2Pass.h. |
|
Gets the next token's associated floating point value in the instruction que that was parsed from the text source. If an unkown token is found or no associated value was found then an exception is raised but the instruction pointer is still moved passed the unknown token. The subclass should catch the exception, provide an error message, and attempt recovery. Definition at line 397 of file OgreCompiler2Pass.h. |
|
Gets the number of tokens waiting in the instruction que that need to be processed by an token action in pass 2.
|
|
Get the current position in the Pass2 Token Que.
Definition at line 465 of file OgreCompiler2Pass.h. |
|
Get the number of tokens not processed by action token. Client Actions should use this method to retreive the number of parameters(tokens) remaining to be processed in the action. |
|
Check if source at current position is supposed to be a user defined character label. A new label is processed when previous operation was not _character_ otherwise the processed character (if match was found) is added to the current label. This allows _character_ operations to be chained together to form a crude regular expression to build a label.
|
|
Check if pass 1 has parsed to the end of the source.
Definition at line 533 of file OgreCompiler2Pass.h. |
|
check to see if the text at the present position in the source is a numerical constant
|
|
check to see if the text is in the lexeme text library
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Compile a compositor script from a data stream using a specific resource group name.
Definition at line 64 of file OgreCompositorScriptCompiler.h. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
position to the next possible valid sysmbol
|
|
process input source text using rulepath to determine allowed tokens
|
|
go back to the previous token in the pass2 queue.
|
|
setup ActiveContexts - should be called by subclass to setup initial language contexts
Definition at line 561 of file OgreCompiler2Pass.h. |
|
Sets up the parser rules for the client based on the BNF Grammer text passed in.
|
|
Set the position of the next token action in the Pass2 Token Que.
|
|
Manualy set the Pass2 Token que position.
|
|
Associate all the lexemes used in a material script with their corresponding tokens and actions.
Implements Ogre::Compiler2Pass. |
|
comment specifiers are hard coded
|
|
find end of line marker and move past it
|
|
skip to the next token in the pass2 queue.
|
|
skip all the white space which includes spaces and tabs
|
|
If a current token instruction exist then test if its token ID matches.
Definition at line 382 of file OgreCompiler2Pass.h. |
|
If a next token instruction exist then test if its token ID matches.
|
|
check if current position in source has the lexeme text equivalent to the TokenID
|
|
scan through all the rules and initialize token definition with index to rules for non-terminal tokens. Gets called when internal grammer is being verified or after client grammer has been parsed.
|
|
Active Contexts pattern used in pass 1 to determine which tokens are valid for a certain context.
Definition at line 308 of file OgreCompiler2Pass.h. |
|
The active label that is receiving characters during pass 1.
Definition at line 296 of file OgreCompiler2Pass.h. |
|
the key of the active label being built during pass 1. a new key is calculated when mLabelIsActive switches from false to true Definition at line 294 of file OgreCompiler2Pass.h. |
|
Active token que, definitions, rules currntly being used by parser.
Definition at line 261 of file OgreCompiler2Pass.h. |
|
current line number in source being tokenized
Definition at line 279 of file OgreCompiler2Pass.h. |
|
Definition at line 258 of file OgreCompiler2Pass.h. |
|
storage container for constants defined in source container uses Token index as a key associated with a float constant
Definition at line 284 of file OgreCompiler2Pass.h. |
|
Definition at line 278 of file OgreCompiler2Pass.h. |
|
Definition at line 276 of file OgreCompiler2Pass.h. |
|
position in current line in source being tokenized
Definition at line 280 of file OgreCompiler2Pass.h. |
|
TokenID to insert if next rule finds a terminal token if zero then no token inserted.
Definition at line 305 of file OgreCompiler2Pass.h. |
|
flag indicates when a label is being parsed. It gets set false when a terminal token not of _character_ is encountered Definition at line 291 of file OgreCompiler2Pass.h. |
|
Definition at line 288 of file OgreCompiler2Pass.h. |
|
the que position for the next token that has an action.
Definition at line 270 of file OgreCompiler2Pass.h. |
|
flag being true indicates that spaces are not to be skipped automatically gets set to false when mLabelIsActive goes to false
Definition at line 299 of file OgreCompiler2Pass.h. |
|
if flag is true then next terminal token is not added to token que if found but does effect rule path flow
Definition at line 302 of file OgreCompiler2Pass.h. |
|
the location within the token instruction container where pass 2 is
Definition at line 263 of file OgreCompiler2Pass.h. |
|
the que position of the previous token that had an action. A token's action is fired on the next token having an action. Definition at line 267 of file OgreCompiler2Pass.h. |
|
Definition at line 125 of file OgreCompositorScriptCompiler.h. |
|
pointer to the source to be compiled
Definition at line 273 of file OgreCompiler2Pass.h. |
|
name of the source to be compiled
Definition at line 275 of file OgreCompiler2Pass.h. |
|
Map of Token value as key to an Action. An Action converts tokens into the final format. All instances use the same Token Action Map. Definition at line 134 of file OgreCompositorScriptCompiler.h. |
|
Definition at line 177 of file OgreCompiler2Pass.h. |
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jul 8 15:20:34 2007