-
-
Notifications
You must be signed in to change notification settings - Fork 957
/
OgreGLSLPreprocessor.h
510 lines (453 loc) · 19 KB
/
OgreGLSLPreprocessor.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
/**
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
Copyright (c) 2000-2014 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __OGRE_CPREPROCESSOR_H__
#define __OGRE_CPREPROCESSOR_H__
#include "OgrePlatform.h"
#include <string.h>
#include <stdlib.h>
#include <forward_list>
#include <vector>
namespace Ogre {
/**
* This is a simplistic C/C++-like preprocessor.
* It takes an non-zero-terminated string on input and outputs a
* non-zero-terminated string buffer.
*
* This preprocessor was designed specifically for GLSL shaders, so
* if you want to use it for other purposes you might want to check
* if the feature set it provides is enough for you.
*
* Here's a list of supported features:
* - Fast memory allocation-less operation (mostly).
* - Line continuation (backslash-newline) is swallowed.
* - Line numeration is fully preserved by inserting empty lines where
* required. This is crucial if, say, GLSL compiler reports you an error
* with a line number.
* - @c \#define: Parametrized and non-parametrized macros. Invoking a macro with
* less arguments than it takes assignes empty values to missing arguments.
* - @c \#undef: Forget defined macros
* - @c \#ifdef / @c \#ifndef / @c \#else / @c \#endif: Conditional suppression of parts of code.
* - @c \#if: Supports numeric expression of any complexity, also supports the
* defined() pseudo-function.
*/
class CPreprocessor
{
/**
* A input token.
*
* For performance reasons most tokens will point to portions of the
* input stream, so no unneeded memory allocation is done. However,
* in some cases we must allocate different memory for token storage,
* in this case this is signalled by setting the Allocated member
* to non-zero in which case the destructor will know that it must
* free memory on object destruction.
*
* Again for performance reasons we use malloc/realloc/free here because
* C++-style new[] lacks the realloc() counterpart.
*/
class Token
{
public:
enum Kind
{
TK_EOS, // End of input stream
TK_ERROR, // An error has been encountered
TK_WHITESPACE, // A whitespace span (but not newline)
TK_NEWLINE, // A single newline (CR & LF)
TK_LINECONT, // Line continuation ('\' followed by LF)
TK_NUMBER, // A number
TK_KEYWORD, // A keyword
TK_PUNCTUATION, // A punctuation character
TK_DIRECTIVE, // A preprocessor directive
TK_STRING, // A string
TK_COMMENT, // A block comment
TK_LINECOMMENT, // A line comment
TK_TEXT // An unparsed text (cannot be returned from GetToken())
};
/// Token type
Kind Type;
/// True if string was allocated (and must be freed)
mutable size_t Allocated;
union
{
/// A pointer somewhere into the input buffer
const char *String;
/// A memory-allocated string
char *Buffer;
};
/// Token length in bytes
size_t Length;
Token () : Allocated (0), String (NULL), Length(0)
{ }
Token (Kind iType) : Type (iType), Allocated (0), String (NULL), Length(0)
{ }
Token (Kind iType, const char *iString, size_t iLength) :
Type (iType), Allocated (0), String (iString), Length (iLength)
{ }
Token (const Token &iOther)
{
Type = iOther.Type;
Allocated = iOther.Allocated;
iOther.Allocated = 0; // !!! not quite correct but effective
String = iOther.String;
Length = iOther.Length;
}
~Token ()
{ if (Allocated) free (Buffer); }
/// Assignment operator
Token &operator = (const Token &iOther)
{
if (Allocated) free (Buffer);
Type = iOther.Type;
Allocated = iOther.Allocated;
iOther.Allocated = 0; // !!! not quite correct but effective
String = iOther.String;
Length = iOther.Length;
return *this;
}
/// Append a string to this token
void Append (const char *iString, size_t iLength);
/// Append a token to this token
void Append (const Token &iOther);
/// Append given number of newlines to this token
void AppendNL (int iCount);
/// Count number of newlines in this token
int CountNL ();
/// Get the numeric value of the token
bool GetValue (long &oValue) const;
/// Set the numeric value of the token
void SetValue (long iValue);
/// Test two tokens for equality
bool operator == (const Token &iOther) const
{
if (iOther.Length != Length)
return false;
return (memcmp (String, iOther.String, Length) == 0);
}
};
/// A macro definition
class Macro
{
public:
/// Macro name
Token Name;
/// The names of the arguments
std::vector<Token> Args;
/// The macro value
Token Value;
/// Unparsed macro body (keeps the whole raw unparsed macro body)
Token Body;
/// A pointer to function implementation (if macro is really a func)
Token (*ExpandFunc) (CPreprocessor *iParent, const std::vector<Token>& iArgs);
/// true if macro expansion is in progress
bool Expanding;
Macro(const Token& iName) : Name(iName), ExpandFunc(NULL), Expanding(false) {}
// Macro(Macro&&) = default; // TODO unsupported by VS2013
/// Expand the macro value (will not work for functions)
Token Expand (const std::vector<Token>& iArgs, std::forward_list<Macro>& iMacros);
};
friend class CPreprocessor::Macro;
/// The current source text input
const char *Source;
/// The end of the source text
const char *SourceEnd;
/// Current line number
int Line;
/// True if we are at beginning of line
bool BOL;
/// Are we expanding a macro?
bool SupplimentaryExpand;
/// A stack of 32 booleans packed into one value :)
unsigned EnableOutput;
unsigned EnableElif;
/// The list of macros defined so far
std::forward_list<Macro> MacroList;
/**
* Private constructor to re-parse a single token.
*/
CPreprocessor (const Token &iToken, int iLine);
/**
* Stateless tokenizer: Parse the input text and return the next token.
* @param iExpand
* If true, macros will be expanded to their values
* @return
* The next token from the input stream
*/
Token GetToken (bool iExpand);
/**
* Handle a preprocessor directive.
* @param iToken
* The whole preprocessor directive line (until EOL)
* @param iLine
* The line where the directive begins (for error reports)
* @return
* The last input token that was not proceeded.
*/
Token HandleDirective (Token &iToken, int iLine);
/**
* Handle a #define directive.
* @param iBody
* The body of the directive (everything after the directive
* until end of line).
* @param iLine
* The line where the directive begins (for error reports)
* @return
* true if everything went ok, false if not
*/
bool HandleDefine (Token &iBody, int iLine);
/**
* Undefine a previously defined macro
* @param iBody
* The body of the directive (everything after the directive
* until end of line).
* @param iLine
* The line where the directive begins (for error reports)
* @return
* true if everything went ok, false if not
*/
bool HandleUnDef (Token &iBody, int iLine);
/**
* Handle an #ifdef directive.
* @param iBody
* The body of the directive (everything after the directive
* until end of line).
* @param iLine
* The line where the directive begins (for error reports)
* @return
* true if everything went ok, false if not
*/
bool HandleIfDef (Token &iBody, int iLine);
/**
* Handle an #if directive.
* @param iBody
* The body of the directive (everything after the directive
* until end of line).
* @param iLine
* The line where the directive begins (for error reports)
* @return
* true if everything went ok, false if not
*/
bool HandleIf (Token &iBody, int iLine);
/// @overload
bool HandleIf(bool val, int iLine);
/**
* Handle an #elif directive.
* @param iBody
* The body of the directive (everything after the directive
* until end of line).
* @param iLine
* The line where the directive begins (for error reports)
* @return
* true if everything went ok, false if not
*/
bool HandleElif (Token &iBody, int iLine);
/**
* Handle an #else directive.
* @param iBody
* The body of the directive (everything after the directive
* until end of line).
* @param iLine
* The line where the directive begins (for error reports)
* @return
* true if everything went ok, false if not
*/
bool HandleElse (Token &iBody, int iLine);
/**
* Handle an #endif directive.
* @param iBody
* The body of the directive (everything after the directive
* until end of line).
* @param iLine
* The line where the directive begins (for error reports)
* @return
* true if everything went ok, false if not
*/
bool HandleEndIf (Token &iBody, int iLine);
/**
* Get a single function argument until next ',' or ')'.
* @param oArg
* The argument is returned in this variable.
* @param iExpand
* If false, parameters are not expanded and no expressions are
* allowed; only a single keyword is expected per argument.
* @param shouldAppendArg
* When true, the argument will be appended the word word __arg_
* e.g. #define myMacro(x) --> #define myMacro(x__arg_)
* This workaround a bug where calling myMacro( x ) would cause
* issues.
* @return
* The first unhandled token after argument.
*/
Token GetArgument (Token &oArg, bool iExpand, bool shouldAppendArg);
/**
* Get all the arguments of a macro: '(' arg1 { ',' arg2 { ',' ... }} ')'
* @param oArgs
* This is set to a pointer to an array of parsed arguments.
* @param shouldAppendArg
* See GetArgument.
* @param iExpand
* If false, parameters are not expanded and no expressions are
* allowed; only a single keyword is expected per argument.
*/
Token GetArguments (std::vector<Token>& oArgs, bool iExpand, bool shouldAppendArg);
/**
* Parse an expression, compute it and return the result.
* @param oResult
* A token containing the result of expression
* @param iLine
* The line at which the expression starts (for error reports)
* @param iOpPriority
* Operator priority (at which operator we will stop if
* proceeding recursively -- used internally. Parser stops
* when it encounters an operator with higher or equal priority).
* @return
* The last unhandled token after the expression
*/
Token GetExpression (Token &oResult, int iLine, int iOpPriority = 0);
/**
* Get the numeric value of a token.
* If the token was produced by expanding a macro, we will get
* an TEXT token which can contain a whole expression; in this
* case we will call GetExpression to parse it. Otherwise we
* just call the token's GetValue() method.
* @param iToken
* The token to get the numeric value of
* @param oValue
* The variable to put the value into
* @param iLine
* The line where the directive begins (for error reports)
* @return
* true if ok, false if not
*/
bool GetValue (const Token &iToken, long &oValue, int iLine);
/// @overload
/// same as above, but considers the defined() function
bool GetValueDef(const Token &iToken, long &oValue, int iLine);
/**
* Expand the given macro, if it exists.
* If macro has arguments, they are collected from source stream.
* @param iToken
* A KEYWORD token containing the (possible) macro name.
* @return
* The expanded token or iToken if it is not a macro
*/
Token ExpandMacro (const Token &iToken);
/**
* Check if a macro is defined, and if so, return it
* @param iToken
* Macro name
* @return
* The macro object or NULL if a macro with this name does not exist
*/
Macro *IsDefined (const Token &iToken);
/**
* The implementation of the defined() preprocessor function
* @param iParent
* The parent preprocessor object
* @param iArgs
* The arguments themselves
* @return
* The return value encapsulated in a token
*/
static Token ExpandDefined (CPreprocessor *iParent, const std::vector<Token>& iArgs);
/**
* Parse the input string and return a token containing the whole output.
* @param iSource
* The source text enclosed in a token
* @return
* The output text enclosed in a token
*/
Token Parse (const Token &iSource);
/**
* Call the error handler
* @param iLine
* The line at which the error happened.
* @param iError
* The error string.
* @param iToken
* If not NULL contains the erroneous token
*/
void Error (int iLine, const char *iError, const Token *iToken = NULL);
public:
/// Create an empty preprocessor object
CPreprocessor();
/// Destroy the preprocessor object
virtual ~CPreprocessor ();
/**
* Define a macro without parameters.
* @param iMacroName
* The name of the defined macro
* @param iMacroNameLen
* The length of the name of the defined macro
* @param iMacroValue
* The value of the defined macro
* @param iMacroValueLen
* The length of the value of the defined macro
*/
void Define (const char *iMacroName, size_t iMacroNameLen,
const char *iMacroValue, size_t iMacroValueLen);
/**
* Define a symbolical macro.
* @param iMacroName
* The name of the defined macro
* @param iMacroNameLen
* The length of the name of the defined macro
*/
void Define (const char *iMacroName, size_t iMacroNameLen);
/**
* Undefine a macro.
* @param iMacroName
* The name of the macro to undefine
* @param iMacroNameLen
* The length of the name of the macro to undefine
* @return
* true if the macro has been undefined, false if macro doesn't exist
*/
bool Undef (const char *iMacroName, size_t iMacroNameLen);
/**
* Parse the input string and return a newly-allocated output string.
* @note
* The returned preprocessed string is NOT zero-terminated
* (just like the input string).
* @param iSource
* The source text
* @param iLength
* The length of the source text in characters
* @param oLength
* The length of the output string.
* @return
* The output from preprocessor, allocated with malloc().
* The parser can actually allocate more than needed for performance
* reasons, but this should not be a problem unless you will want
* to store the returned pointer for long time in which case you
* might want to realloc() it.
* If an error has been encountered, the function returns NULL.
* In some cases the function may return an unallocated address
* that's *inside* the source buffer. You must free() the result
* string only if the returned address is not inside the source text.
*/
char *Parse (const char *iSource, size_t iLength, size_t &oLength);
};
} // namespace Ogre
#endif // __OGRE_CPREPROCESSOR_H__