File: ShaderExpression.cpp

package info (click to toggle)
darkradiant 3.9.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 41,080 kB
  • sloc: cpp: 264,743; ansic: 10,659; python: 1,852; xml: 1,650; sh: 92; makefile: 21
file content (458 lines) | stat: -rw-r--r-- 11,358 bytes parent folder | download | duplicates (3)
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
#include "ShaderExpression.h"

#include "itextstream.h"

#include "string/convert.h"
#include "MaterialManager.h"

#include <stack>
#include <list>
#include "string/predicate.h"

namespace shaders
{

namespace expressions
{

namespace
{
	const int MAX_SHADERPARM_INDEX = 11;
	const int MAX_GLOBAL_SHADERPARM_INDEX = 7;
}

class ShaderExpressionTokeniser :
	public parser::DefTokeniser
{
private:
	parser::DefTokeniser& _tokeniser;

	// buffer containing tokens pulled from the wrapped tokeniser
	std::list<std::string> _buffer;

	const char* _delims;

public:
	ShaderExpressionTokeniser(parser::DefTokeniser& tokeniser) :
		_tokeniser(tokeniser),
		_delims("[]+-%*/")
	{}

	
    bool hasMoreTokens() const 
	{
		return !_buffer.empty() || _tokeniser.hasMoreTokens();
	}

    std::string nextToken() 
	{
		if (_buffer.empty())
		{
			// Pull a new token from the underlying stream and split it up
			fillBuffer(_tokeniser.nextToken());
		}

		std::string result = _buffer.front();
		_buffer.pop_front();

		return result;
	}

    std::string peek() const 
	{
		if (!_buffer.empty())
		{
			// We have items in the buffer, return that one
			return _buffer.front();
		}
		
		// No items in the buffer, take a peek in the underlying stream
		std::string rawToken = _tokeniser.peek();

		// Split up the token by using a sub-tokeniser, keeping all delimiters
		parser::BasicDefTokeniser<std::string> subtokeniser(rawToken, "", _delims);
		
		// Return the first of these tokens, then exit
		return subtokeniser.nextToken();
	}

private:
	void fillBuffer(const std::string& token)
	{
		// Use a separate tokeniser and keep all delimiters
		parser::BasicDefTokeniser<std::string> subtokeniser(token, "", _delims);

		while (subtokeniser.hasMoreTokens())
		{
			_buffer.push_back(subtokeniser.nextToken());
		}
	}
};

class ShaderExpressionParser
{
private:
	ShaderExpressionTokeniser& _tokeniser;

	using OperandStack = std::stack<std::shared_ptr<ShaderExpression>>;
	using OperatorStack = std::stack<BinaryExpressionPtr>;

public:
	ShaderExpressionParser(ShaderExpressionTokeniser& tokeniser) :
		_tokeniser(tokeniser)
	{}

	std::shared_ptr<ShaderExpression> getExpression()
	{
		// The local variable and operator stack
		OperandStack operands;
		OperatorStack operators;

		bool lastTokenWasOperator = false; // to detect signs

		while (_tokeniser.hasMoreTokens())
		{
			// Don't actually pull the token from the tokeniser, we might want to 
			// return the tokeniser to the caller if the token is not part of the expression
			// The token will be exhausted from the stream once it is recognised as keyword
			std::string token = _tokeniser.peek();

			// Get a new term, push it on the stack
			std::shared_ptr<ShaderExpression> term;

			if (token == "(")
			{
				_tokeniser.nextToken(); // valid token, exhaust

				// New scope, treat this as new expression
				term = getExpression();

                // Remember that this term had parentheses around it
                term->setIsSurroundedByParentheses(true);
			}
			else if (token == ")" || token == "]")
			{
				_tokeniser.nextToken(); // valid token, exhaust

				// End of scope reached, break the loop and roll up the expression
				break;
			}
			else
			{
				// No parantheses, get a new term, push it on the stack
				term = getTerm(token);
			}

			if (term)
			{
				// The token has already been pulled from the tokeniser
				operands.push(term);

				lastTokenWasOperator = false;
				continue;
			}
			
			// Not a term, do we have an operator at hand?

			// Get an operator
			BinaryExpressionPtr op = getOperatorForToken(token);

			if (op)
			{
				_tokeniser.nextToken(); // valid token, exhaust

				if (operands.empty() || lastTokenWasOperator)
				{
					lastTokenWasOperator = false; // clear the flag again

					// If this is a + or -, take it as a sign operator
					if (token == "+")
					{
						// A leading +, just ignore it
						continue;
					}
					else if (token == "-")
					{
						// A leading -, interpret it as -1 *
						operands.push(std::make_shared<ConstantExpression>(-1.0f));
						operators.push(std::make_shared<MultiplyExpression>());

						// Discard the - operator
						continue;
					}
					else
					{
						throw parser::ParseException("Missing operand for operator: " + token);
					}
				}

				// We have operands, so this is a regular operator
				lastTokenWasOperator = true;

				// Check precedence if we have previous operators
				while (!operators.empty())
				{
					if (operators.top()->getPrecedence() <= op->getPrecedence())
					{
						finaliseOperator(operands, operators);
					}
					else
					{
						break;
					}
				}

				// Push this one on the operator stack
				operators.push(op);
				continue;
			}
			
			// Not an operand, not an operator, we seem to be done here
			break;
		}

		// Roll up the operations
		while (!operators.empty())
		{
			finaliseOperator(operands, operators);
		}

		if (operands.empty())
		{
			throw parser::ParseException("Missing expression");
		}
		
		auto rv = operands.top();
		operands.pop();

		return rv;
	}

private:
	void finaliseOperator(OperandStack& operands, OperatorStack& operators)
	{
		// Need two operands for an operator
		if (operands.size() < 2)
		{
			throw parser::ParseException("Too few operands for operator.");
		}

		const BinaryExpressionPtr& op = operators.top();

		// Set operand B first, we're dealing with a LIFO stack
		op->setB(operands.top());
		operands.pop();

		op->setA(operands.top());
		operands.pop();

		// Push the result back on the stack, as operand
		operands.push(op);

		// Remove the operator, after we've copied it to the operand stack
		operators.pop();
	}

	// Try to get a valid expression from the token. If the token was found to be valid
	// The token is actually pulled from the tokeniser using nextToken()
	std::shared_ptr<ShaderExpression> getTerm(const std::string& token)
	{
		if (string::istarts_with(token, "parm"))
		{
			_tokeniser.nextToken(); // valid token, exhaust

			// This is a shaderparm, get the number
			int shaderParmNum = string::convert<int>(token.substr(4));
		
			if (shaderParmNum >= 0 && shaderParmNum <= MAX_SHADERPARM_INDEX)
			{
				return std::make_shared<ShaderParmExpression>(shaderParmNum);
			}
			else
			{
				throw new parser::ParseException("Shaderparm index out of bounds");
			}
		}
		else if (string::istarts_with(token, "global"))
		{
			_tokeniser.nextToken(); // valid token, exhaust

			// This is a shaderparm, get the number
			int shaderParmNum = string::convert<int>(token.substr(6));
		
			if (shaderParmNum >= 0 && shaderParmNum <= MAX_GLOBAL_SHADERPARM_INDEX)
			{
				return std::make_shared<GlobalShaderParmExpression>(shaderParmNum);
			}
			else
			{
				throw new parser::ParseException("Shaderparm index out of bounds");
			}
		}
		else if (token == "time")
		{
			_tokeniser.nextToken(); // valid token, exhaust

			return std::make_shared<TimeExpression>();
		}
		else if (token == "sound")
		{
			_tokeniser.nextToken(); // valid token, exhaust

			// No sound support so far
			return std::make_shared<ConstantExpression>(0.0f);
		}
		else if (string::iequals("fragmentprograms", token))
		{
			_tokeniser.nextToken(); // valid token, exhaust

			// There's no fragmentPrograms option in DR, let's assume true
			return std::make_shared<ConstantExpression>(1.0f);
		}
		else 
		{
			// Check if this keyword is a material lookup table
			auto table = GetShaderSystem()->getTable(token);

			if (table)
			{
				// Got it, this is a table name
				_tokeniser.nextToken(); // valid token, exhaust, this hasn't been done by the caller yet
				
				// We need an opening '[' to have valid syntax
				_tokeniser.assertNextToken("[");

				// The lookup expression itself has to be parsed afresh, enter recursion
				auto lookupValue = getExpression();

				if (!lookupValue)
				{
					throw new parser::ParseException("Missing or invalid expression in table lookup operator[]");
				}

				// Construct a new table lookup expression and link them together
				return std::make_shared<TableLookupExpression>(table, lookupValue);
			}
			else
			{
				// Attempt to convert the token into a floating point value
                float value;
                if (string::tryConvertToFloat(token, value))
                {
                    _tokeniser.nextToken(); // valid token, exhaust

                    return std::make_shared<ConstantExpression>(value);
                }
			}
		}

		return std::shared_ptr<ShaderExpression>();
	}

	// Helper routines
	BinaryExpressionPtr getOperatorForToken(const std::string& token)
	{
		if (token == "+")
		{
			return std::make_shared<AddExpression>();
		}
		else if (token == "-")
		{
			return std::make_shared<SubtractExpression>();
		}
		else if (token == "*")
		{
			return std::make_shared<MultiplyExpression>();
		}
		else if (token == "/")
		{
			return std::make_shared<DivideExpression>();
		}
		else if (token == "%")
		{
			return std::make_shared<ModuloExpression>();
		}
		else if (token == "<")
		{
			return std::make_shared<LessThanExpression>();
		}
		else if (token == "<=")
		{
			return std::make_shared<LessThanOrEqualExpression>();
		}
		else if (token == ">")
		{
			return std::make_shared<GreaterThanExpression>();
		}
		else if (token == ">=")
		{
			return std::make_shared<GreaterThanOrEqualExpression>();
		}
		else if (token == "==")
		{
			return std::make_shared<EqualityExpression>();
		}
		else if (token == "!=")
		{
			return std::make_shared<InequalityExpression>();
		}
		else if (token == "&&")
		{
			return std::make_shared<LogicalAndExpression>();
		}
		else if (token == "||")
		{
			return std::make_shared<LogicalOrExpression>();
		}

		return BinaryExpressionPtr();
	}
};

} // namespace expressions

IShaderExpression::Ptr ShaderExpression::createFromTokens(parser::DefTokeniser& tokeniser)
{
	// Create an adapter which takes care of splitting the tokens into finer grains
	// The incoming DefTokeniser is not splitting up expressions like "3*4" without any whitespace in them
	expressions::ShaderExpressionTokeniser adapter(tokeniser);

	try
	{
		expressions::ShaderExpressionParser parser(adapter);
		return parser.getExpression();
	}
	catch (parser::ParseException& ex)
	{
		rWarning() << "[shaders] " << ex.what() << std::endl;
		return IShaderExpression::Ptr();
	}
}

IShaderExpression::Ptr ShaderExpression::createFromString(const std::string& exprStr)
{
	parser::BasicDefTokeniser<std::string> tokeniser(exprStr, parser::WHITESPACE, "{}(),");
	return createFromTokens(tokeniser);
}

IShaderExpression::Ptr ShaderExpression::createConstant(float constantValue)
{
    return std::make_shared<expressions::ConstantExpression>(constantValue);
}

IShaderExpression::Ptr ShaderExpression::createAddition(const IShaderExpression::Ptr& a, const IShaderExpression::Ptr& b)
{
    return std::make_shared<expressions::AddExpression>(a, b);
}

IShaderExpression::Ptr ShaderExpression::createMultiplication(const IShaderExpression::Ptr& a, const IShaderExpression::Ptr& b)
{
    return std::make_shared<expressions::MultiplyExpression>(a, b);
}

IShaderExpression::Ptr ShaderExpression::createTableLookup(const ITableDefinition::Ptr& table, const IShaderExpression::Ptr& lookup)
{
    return std::make_shared<expressions::TableLookupExpression>(table, lookup);
}

} // namespace