OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
src/GLSL/include/OgreGLSLPreprocessor.h
Go to the documentation of this file.
1 
29 #ifndef __OGRE_CPREPROCESSOR_H__
30 #define __OGRE_CPREPROCESSOR_H__
31 
32 #include <string.h>
33 #include <stdlib.h>
34 
35 namespace Ogre {
36  namespace GLSL {
37 
63 {
77  class Token
78  {
79  public:
80  enum Kind
81  {
82  TK_EOS, // End of input stream
83  TK_ERROR, // An error has been encountered
84  TK_WHITESPACE, // A whitespace span (but not newline)
85  TK_NEWLINE, // A single newline (CR & LF)
86  TK_LINECONT, // Line continuation ('\' followed by LF)
87  TK_NUMBER, // A number
88  TK_KEYWORD, // A keyword
89  TK_PUNCTUATION, // A punctuation character
90  TK_DIRECTIVE, // A preprocessor directive
91  TK_STRING, // A string
92  TK_COMMENT, // A block comment
93  TK_LINECOMMENT, // A line comment
94  TK_TEXT // An unparsed text (cannot be returned from GetToken())
95  };
96 
100  mutable size_t Allocated;
101  union
102  {
104  const char *String;
106  char *Buffer;
107  };
109  size_t Length;
110 
111  Token () : Allocated (0), String (NULL)
112  { }
113 
114  Token (Kind iType) : Type (iType), Allocated (0), String (NULL)
115  { }
116 
117  Token (Kind iType, const char *iString, size_t iLength) :
118  Type (iType), Allocated (0), String (iString), Length (iLength)
119  { }
120 
121  Token (const Token &iOther)
122  {
123  Type = iOther.Type;
124  Allocated = iOther.Allocated;
125  iOther.Allocated = 0; // !!! not quite correct but effective
126  String = iOther.String;
127  Length = iOther.Length;
128  }
129 
131  { if (Allocated) free (Buffer); }
132 
134  Token &operator = (const Token &iOther)
135  {
136  if (Allocated) free (Buffer);
137  Type = iOther.Type;
138  Allocated = iOther.Allocated;
139  iOther.Allocated = 0; // !!! not quite correct but effective
140  String = iOther.String;
141  Length = iOther.Length;
142  return *this;
143  }
144 
146  void Append (const char *iString, size_t iLength);
147 
149  void Append (const Token &iOther);
150 
152  void AppendNL (int iCount);
153 
155  int CountNL ();
156 
158  bool GetValue (long &oValue) const;
159 
161  void SetValue (long iValue);
162 
164  bool operator == (const Token &iOther)
165  {
166  if (iOther.Length != Length)
167  return false;
168  return (memcmp (String, iOther.String, Length) == 0);
169  }
170  };
171 
173  class Macro
174  {
175  public:
179  int NumArgs;
189  Token (*ExpandFunc) (CPreprocessor *iParent, int iNumArgs, Token *iArgs);
191  bool Expanding;
192 
193  Macro (const Token &iName) :
194  Name (iName), NumArgs (0), Args (NULL), Next (NULL),
195  ExpandFunc (NULL), Expanding (false)
196  { }
197 
199  { delete [] Args; delete Next; }
200 
202  Token Expand (int iNumArgs, Token *iArgs, Macro *iMacros);
203  };
204 
205  friend class CPreprocessor::Macro;
206 
208  const char *Source;
210  const char *SourceEnd;
212  int Line;
214  bool BOL;
216  unsigned EnableOutput;
219 
223  CPreprocessor (const Token &iToken, int iLine);
224 
232  Token GetToken (bool iExpand);
233 
243  Token HandleDirective (Token &iToken, int iLine);
244 
255  bool HandleDefine (Token &iBody, int iLine);
256 
267  bool HandleUnDef (Token &iBody, int iLine);
268 
279  bool HandleIfDef (Token &iBody, int iLine);
280 
291  bool HandleIf (Token &iBody, int iLine);
292 
303  bool HandleElse (Token &iBody, int iLine);
304 
315  bool HandleEndIf (Token &iBody, int iLine);
316 
327  Token GetArgument (Token &oArg, bool iExpand);
328 
339  Token GetArguments (int &oNumArgs, Token *&oArgs, bool iExpand);
340 
354  Token GetExpression (Token &oResult, int iLine, int iOpPriority = 0);
355 
371  bool GetValue (const Token &iToken, long &oValue, int iLine);
372 
381  Token ExpandMacro (const Token &iToken);
382 
390  Macro *IsDefined (const Token &iToken);
391 
403  static Token ExpandDefined (CPreprocessor *iParent, int iNumArgs, Token *iArgs);
404 
412  Token Parse (const Token &iSource);
413 
423  void Error (int iLine, const char *iError, const Token *iToken = NULL);
424 
425 public:
428  { }
429 
431  virtual ~CPreprocessor ();
432 
444  void Define (const char *iMacroName, size_t iMacroNameLen,
445  const char *iMacroValue, size_t iMacroValueLen);
446 
456  void Define (const char *iMacroName, size_t iMacroNameLen, long iMacroValue);
457 
467  bool Undef (const char *iMacroName, size_t iMacroNameLen);
468 
491  char *Parse (const char *iSource, size_t iLength, size_t &oLength);
492 
508  typedef void (*ErrorHandlerFunc) (
509  void *iData, int iLine, const char *iError,
510  const char *iToken, size_t iTokenLen);
511 
518 
520  void *ErrorData;
521 };
522 
523 } // namespace GLSL
524 } // namespace Ogre
525 
526 #endif // __OGRE_CPREPROCESSOR_H__
void * ErrorData
User-specific storage, passed to Error()
size_t Allocated
True if string was allocated (and must be freed)
bool Undef(const char *iMacroName, size_t iMacroNameLen)
Undefine a macro.
Token Expand(int iNumArgs, Token *iArgs, Macro *iMacros)
Expand the macro value (will not work for functions)
const char * String
A pointer somewhere into the input buffer.
bool operator==(const Token &iOther)
Test two tokens for equality.
Token Parse(const Token &iSource)
Parse the input string and return a token containing the whole output.
bool HandleIfDef(Token &iBody, int iLine)
Handle an #ifdef directive.
bool BOL
True if we are at beginning of line.
Token GetExpression(Token &oResult, int iLine, int iOpPriority=0)
Parse an expression, compute it and return the result.
Token & operator=(const Token &iOther)
Assignment operator.
Token GetArgument(Token &oArg, bool iExpand)
Get a single function argument until next ',' or ')'.
void Append(const char *iString, size_t iLength)
Append a string to this token.
static Token ExpandDefined(CPreprocessor *iParent, int iNumArgs, Token *iArgs)
The implementation of the defined() preprocessor function.
bool HandleIf(Token &iBody, int iLine)
Handle an #if directive.
void SetValue(long iValue)
Set the numeric value of the token.
bool HandleEndIf(Token &iBody, int iLine)
Handle an #endif directive.
Token HandleDirective(Token &iToken, int iLine)
Handle a preprocessor directive.
This is a simplistic C/C++-like preprocessor.
const char * Source
The current source text input.
bool Expanding
true if macro expansion is in progress
Macro * MacroList
The list of macros defined so far.
virtual ~CPreprocessor()
Destroy the preprocessor object.
Token GetToken(bool iExpand)
Stateless tokenizer: Parse the input text and return the next token.
CPreprocessor()
Create an empty preprocessor object.
Macro * IsDefined(const Token &iToken)
Check if a macro is defined, and if so, return it.
bool GetValue(long &oValue) const
Get the numeric value of the token.
static ErrorHandlerFunc ErrorHandler
A pointer to the preprocessor's error handler.
Token Body
Unparsed macro body (keeps the whole raw unparsed macro body)
void Error(int iLine, const char *iError, const Token *iToken=NULL)
Call the error handler.
void(* ErrorHandlerFunc)(void *iData, int iLine, const char *iError, const char *iToken, size_t iTokenLen)
An error handler function type.
Token ExpandMacro(const Token &iToken)
Expand the given macro, if it exists.
bool HandleElse(Token &iBody, int iLine)
Handle an #else directive.
Token(Kind iType, const char *iString, size_t iLength)
const char * SourceEnd
The end of the source text.
bool HandleDefine(Token &iBody, int iLine)
Handle a #define directive.
_StringBase String
Definition: OgreCommon.h:53
void AppendNL(int iCount)
Append given number of newlines to this token.
unsigned EnableOutput
A stack of 32 booleans packed into one value :)
bool GetValue(const Token &iToken, long &oValue, int iLine)
Get the numeric value of a token.
int CountNL()
Count number of newlines in this token.
Token(* ExpandFunc)(CPreprocessor *iParent, int iNumArgs, Token *iArgs)
A pointer to function implementation (if macro is really a func)
Token GetArguments(int &oNumArgs, Token *&oArgs, bool iExpand)
Get all the arguments of a macro: '(' arg1 { ',' arg2 { ',' ...
bool HandleUnDef(Token &iBody, int iLine)
Undefine a previously defined macro.
void Define(const char *iMacroName, size_t iMacroNameLen, const char *iMacroValue, size_t iMacroValueLen)
Define a macro without parameters.