1 #include <msp/core/raii.h>
2 #include <msp/strings/format.h>
3 #include <msp/strings/regex.h>
4 #include <msp/strings/utils.h>
5 #include "glsl_error.h"
17 preprocessor(tokenizer),
20 tokenizer.signal_preprocess.connect(sigc::mem_fun(&preprocessor, &Preprocessor::preprocess));
21 preprocessor.signal_version.connect(sigc::mem_fun(this, &Parser::set_required_version));
22 preprocessor.signal_source.connect(sigc::mem_fun(this, &Parser::source_reference));
23 preprocessor.signal_stage_change.connect(sigc::mem_fun(this, &Parser::stage_change));
24 preprocessor.signal_line.connect(sigc::mem_fun(this, &Parser::line_change));
32 Module &Parser::parse(const string &s, const string &n, int i)
39 Module &Parser::parse(IO::Base &io, const string &n, int i)
45 unsigned len = io.read(buffer, sizeof(buffer));
46 source.append(buffer, len);
52 void Parser::parse_source(const string &name, int index)
56 cur_stage = &module->shared;
60 source_reference(1, name);
61 tokenizer.begin(source, name);
62 allow_stage_change = true;
63 while(!tokenizer.peek_token().empty())
64 if(RefPtr<Statement> statement = parse_with_recovery(&Parser::parse_global_declaration))
65 cur_stage->content.body.push_back(statement);
68 throw invalid_shader_source(join(errors.begin(), errors.end(), "\n"));
71 void Parser::set_required_version(const Version &ver)
73 cur_stage->required_features.glsl_version = ver;
76 void Parser::source_reference(unsigned index, const string &name)
78 if(index<1 || base_index<0)
79 throw invalid_shader_source(tokenizer.get_location(), "Invalid source reference");
81 module->source_map.set_name(base_index+index-1, name);
84 void Parser::stage_change(Stage::Type stage)
86 if(!allow_stage_change)
87 throw invalid_shader_source(tokenizer.get_location(), "Changing stage not allowed here");
88 else if(stage<=cur_stage->type)
89 throw invalid_shader_source(tokenizer.get_location(), "Stage '%s' not allowed here", Stage::get_stage_name(stage));
91 module->stages.push_back(stage);
93 if(cur_stage->type!=Stage::SHARED)
94 module->stages.back().previous = cur_stage;
95 cur_stage = &module->stages.back();
98 void Parser::line_change(int index, unsigned line)
101 source_index = base_index+index-1;
105 index = source_index;
107 string name = module->source_map.get_name(index);
109 name = format("<%d>", index);
110 tokenizer.set_location(Location(name, line));
113 string Parser::expect_type()
115 string token = tokenizer.parse_token();
117 throw parse_error(tokenizer.get_location(), token, "a type");
121 string Parser::expect_identifier()
123 string token = tokenizer.parse_token();
124 if(!is_identifier(token))
125 throw parse_error(tokenizer.get_location(), token, "an identifier");
129 int Parser::expect_integer()
131 string token = tokenizer.parse_token();
133 throw parse_error(tokenizer.get_location(), token, "an integer literal");
134 return lexical_cast<int>(token);
137 bool Parser::check(const string &token)
139 bool result = (tokenizer.peek_token()==token);
141 tokenizer.parse_token();
145 bool Parser::is_interface_qualifier(const string &token)
147 return (token=="uniform" || token=="in" || token=="out");
150 bool Parser::is_sampling_qualifier(const string &token)
152 return (token=="centroid" || token=="sample");
155 bool Parser::is_interpolation_qualifier(const string &token)
157 return (token=="smooth" || token=="flat" || token=="noperspective");
160 bool Parser::is_precision_qualifier(const string &token)
162 return (token=="highp" || token=="mediump" || token=="lowp");
165 bool Parser::is_qualifier(const string &token)
167 return (token=="const" ||
168 is_interface_qualifier(token) ||
169 is_sampling_qualifier(token) ||
170 is_interpolation_qualifier(token) ||
171 is_precision_qualifier(token));
174 bool Parser::is_builtin_type(const string &token)
176 static Regex re("^(void|float|int|bool|[ib]?vec[234]|mat[234](x[234])?|sampler((1D|2D|Cube)(Array)?(Shadow)?|3D))$");
177 return re.match(token);
180 bool Parser::is_type(const string &token)
182 return is_builtin_type(token) || declared_types.count(token);
185 bool Parser::is_identifier(const string &token)
187 static Regex re("^[a-zA-Z_][a-zA-Z0-9_]*$");
188 return re.match(token);
192 RefPtr<T> Parser::create_node()
194 RefPtr<T> node = new T;
195 node->source = source_index;
196 node->line = tokenizer.get_location().line;
201 RefPtr<T> Parser::parse_with_recovery(RefPtr<T> (Parser::*parse_func)())
203 tokenizer.clear_progress_mark();
206 return (this->*parse_func)();
208 catch(const invalid_shader_source &exc)
210 errors.push_back(exc.what());
213 if(tokenizer.get_last_token()!=";" || !tokenizer.get_progress_mark())
215 unsigned scope_level = 0;
218 if(tokenizer.peek_token()=="}" && scope_level==0)
220 if(!tokenizer.get_progress_mark())
221 tokenizer.parse_token();
225 string token = tokenizer.parse_token();
234 else if(token==";" && scope_level==0)
236 else if(token.empty())
244 RefPtr<Statement> Parser::parse_global_declaration()
246 string token = tokenizer.peek_token();
247 SetFlag disallow(allow_stage_change, false);
250 return parse_import();
251 else if(token=="precision")
252 return parse_precision();
253 else if(token=="layout")
255 RefPtr<Layout> layout = parse_layout();
256 token = tokenizer.peek_token();
257 if(is_interface_qualifier(token) && tokenizer.peek_token(1)==";")
259 RefPtr<InterfaceLayout> iface_lo = create_node<InterfaceLayout>();
260 iface_lo->layout.qualifiers = layout->qualifiers;
261 iface_lo->interface = tokenizer.parse_token();
262 tokenizer.expect(";");
267 RefPtr<VariableDeclaration> var = parse_variable_declaration();
268 var->layout = layout;
272 else if(token=="struct")
273 return parse_struct_declaration();
274 else if(is_interface_qualifier(token))
276 string next = tokenizer.peek_token(1);
277 if(is_type(next) || is_qualifier(next))
278 return parse_variable_declaration();
280 return parse_interface_block();
282 else if(is_qualifier(token))
283 return parse_variable_declaration();
284 else if(is_type(token))
286 if(tokenizer.peek_token(2)=="(")
287 return parse_function_declaration();
289 return parse_variable_declaration();
291 else if(token.empty())
294 throw parse_error(tokenizer.get_location(), token, "a global declaration");
297 RefPtr<Statement> Parser::parse_statement()
299 string token = tokenizer.peek_token();
301 return parse_conditional();
302 else if(token=="for")
304 else if(token=="while")
305 return parse_while();
306 else if(token=="passthrough")
307 return parse_passthrough();
308 else if(token=="return")
309 return parse_return();
310 else if(token=="break" || token=="continue" || token=="discard")
312 RefPtr<Jump> jump = create_node<Jump>();
313 jump->keyword = tokenizer.parse_token();
314 tokenizer.expect(";");
318 else if(is_qualifier(token) || is_type(token))
319 return parse_variable_declaration();
322 tokenizer.parse_token();
323 throw invalid_shader_source(tokenizer.get_location(), "Empty statement not allowed");
325 else if(!token.empty())
327 RefPtr<ExpressionStatement> expr = create_node<ExpressionStatement>();
328 expr->expression = parse_expression();
329 tokenizer.expect(";");
334 throw parse_error(tokenizer.get_location(), token, "a statement");
337 RefPtr<Import> Parser::parse_import()
339 if(cur_stage->type!=Stage::SHARED)
340 throw invalid_shader_source(tokenizer.get_location(), "Imports are only allowed in the shared section");
342 tokenizer.expect("import");
343 RefPtr<Import> import = create_node<Import>();
344 import->module = expect_identifier();
345 tokenizer.expect(";");
349 RefPtr<Precision> Parser::parse_precision()
351 tokenizer.expect("precision");
352 RefPtr<Precision> precision = create_node<Precision>();
354 precision->precision = tokenizer.parse_token();
355 if(!is_precision_qualifier(precision->precision))
356 throw parse_error(tokenizer.get_location(), precision->precision, "a precision qualifier");
358 precision->type = tokenizer.parse_token();
359 // Not entirely accurate; only float, int and sampler types are allowed
360 if(!is_builtin_type(precision->type))
361 throw parse_error(tokenizer.get_location(), precision->type, "a builtin type");
363 tokenizer.expect(";");
368 RefPtr<Layout> Parser::parse_layout()
370 tokenizer.expect("layout");
371 tokenizer.expect("(");
372 RefPtr<Layout> layout = create_node<Layout>();
375 string token = tokenizer.parse_token();
377 throw parse_error(tokenizer.get_location(), token, "a layout qualifier name");
379 layout->qualifiers.push_back(Layout::Qualifier());
380 Layout::Qualifier &qual = layout->qualifiers.back();
383 if((qual.has_value = check("=")))
385 if(qual.name=="constant_id" && tokenizer.peek_token()=="auto")
388 tokenizer.parse_token();
391 qual.value = expect_integer();
394 if(tokenizer.peek_token()==")")
397 tokenizer.expect(",");
399 tokenizer.expect(")");
405 void Parser::parse_block(Block &block, bool require_braces, RefPtr<T> (Parser::*parse_content)())
407 bool have_braces = (require_braces || tokenizer.peek_token()=="{");
409 tokenizer.expect("{");
413 while(tokenizer.peek_token()!="}")
414 if(RefPtr<Statement> node = parse_with_recovery(parse_content))
415 block.body.push_back(node);
418 block.body.push_back((this->*parse_content)());
420 block.use_braces = (require_braces || block.body.size()!=1);
423 tokenizer.expect("}");
426 RefPtr<Expression> Parser::parse_expression(unsigned precedence)
428 RefPtr<Expression> left;
429 VariableReference *left_var = 0;
432 string token = tokenizer.peek_token();
434 const Operator *oper = 0;
435 for(const Operator *i=Operator::operators; (!oper && i->type); ++i)
436 if(token==i->token && (!left || i->type!=Operator::PREFIX) && (left || i->type!=Operator::POSTFIX))
439 if(token==";" || token==")" || token=="]" || token=="," || (oper && precedence && oper->precedence>=precedence))
444 throw parse_error(tokenizer.get_location(), token, "an expression");
451 throw invalid_shader_source(tokenizer.get_location(), "Syntax error before '(': function name must be an identifier");
452 left = parse_function_call(*left_var);
456 RefPtr<MemberAccess> memacc = create_node<MemberAccess>();
459 tokenizer.parse_token();
460 memacc->member = expect_identifier();
463 else if(oper && oper->type==Operator::POSTFIX)
465 RefPtr<UnaryExpression> unary = create_node<UnaryExpression>();
467 tokenizer.parse_token();
468 unary->expression = left;
471 else if(oper && oper->type==Operator::BINARY)
472 left = parse_binary(left, *oper);
474 throw parse_error(tokenizer.get_location(), token, "an operator");
481 tokenizer.parse_token();
482 RefPtr<ParenthesizedExpression> parexpr = create_node<ParenthesizedExpression>();
483 parexpr->expression = parse_expression();
484 tokenizer.expect(")");
487 else if(isdigit(token[0]) || token=="true" || token=="false")
489 RefPtr<Literal> literal = new Literal;
490 literal->token = tokenizer.parse_token();
493 else if(is_identifier(token))
495 RefPtr<VariableReference> var = create_node<VariableReference>();
496 var->name = expect_identifier();
498 left_var = var.get();
500 else if(oper && oper->type==Operator::PREFIX)
502 RefPtr<UnaryExpression> unary = create_node<UnaryExpression>();
504 tokenizer.parse_token();
505 unary->expression = parse_expression(oper->precedence);
509 throw parse_error(tokenizer.get_location(), token, "an expression");
514 RefPtr<BinaryExpression> Parser::parse_binary(const RefPtr<Expression> &left, const Operator &oper)
516 RefPtr<BinaryExpression> binary = (oper.precedence==16 ?
517 static_cast<RefPtr<BinaryExpression> >(create_node<Assignment>()) : create_node<BinaryExpression>());
519 binary->oper = &oper;
520 tokenizer.expect(oper.token);
521 if(oper.token[0]=='[')
523 binary->right = parse_expression();
524 tokenizer.expect("]");
527 binary->right = parse_expression(oper.precedence+(oper.assoc==Operator::RIGHT_TO_LEFT));
531 RefPtr<FunctionCall> Parser::parse_function_call(const VariableReference &var)
533 RefPtr<FunctionCall> call = create_node<FunctionCall>();
534 call->name = var.name;
535 call->constructor = is_type(call->name);
536 call->oper = &Operator::get_operator("(", Operator::POSTFIX);
537 tokenizer.expect("(");
538 while(tokenizer.peek_token()!=")")
540 if(!call->arguments.empty())
541 tokenizer.expect(",");
542 call->arguments.push_back(parse_expression());
544 tokenizer.expect(")");
548 RefPtr<StructDeclaration> Parser::parse_struct_declaration()
550 tokenizer.expect("struct");
551 RefPtr<StructDeclaration> strct = create_node<StructDeclaration>();
553 strct->name = expect_identifier();
554 parse_block(strct->members, true, &Parser::parse_variable_declaration);
555 tokenizer.expect(";");
557 declared_types.insert(strct->name);
561 RefPtr<VariableDeclaration> Parser::parse_variable_declaration()
563 RefPtr<VariableDeclaration> var = create_node<VariableDeclaration>();
565 string token = tokenizer.peek_token();
566 while(is_qualifier(token))
568 tokenizer.parse_token();
569 if(is_interface_qualifier(token))
570 var->interface = token;
571 else if(is_sampling_qualifier(token))
572 var->sampling = token;
573 else if(is_interpolation_qualifier(token))
574 var->interpolation = token;
575 else if(is_precision_qualifier(token))
576 var->precision = token;
577 else if(token=="const")
578 var->constant = true;
579 token = tokenizer.peek_token();
582 var->type = expect_type();
583 var->name = expect_identifier();
590 var->array_size = parse_expression();
591 tokenizer.expect("]");
596 var->init_expression = parse_expression();
598 tokenizer.expect(";");
602 RefPtr<VariableDeclaration> Parser::parse_variable_declaration_with_layout()
604 RefPtr<Layout> layout;
605 if(tokenizer.peek_token()=="layout")
606 layout = parse_layout();
608 RefPtr<VariableDeclaration> var = parse_variable_declaration();
609 var->layout = layout;
614 RefPtr<FunctionDeclaration> Parser::parse_function_declaration()
616 RefPtr<FunctionDeclaration> func = create_node<FunctionDeclaration>();
618 func->return_type = expect_type();
619 func->name = expect_identifier();
620 tokenizer.expect("(");
621 while(tokenizer.peek_token()!=")")
623 if(!func->parameters.empty())
624 tokenizer.expect(",");
626 RefPtr<VariableDeclaration> var = create_node<VariableDeclaration>();
627 string token = tokenizer.peek_token();
628 if(token=="in" || token=="out" || token=="inout")
629 var->interface = tokenizer.parse_token();
630 var->type = expect_type();
631 var->name = expect_identifier();
632 func->parameters.push_back(var);
634 tokenizer.expect(")");
636 string token = tokenizer.peek_token();
639 func->definition = func.get();
640 parse_block(func->body, true, &Parser::parse_statement);
643 tokenizer.parse_token();
645 throw parse_error(tokenizer.get_location(), token, "'{' or ';'");
650 RefPtr<InterfaceBlock> Parser::parse_interface_block()
652 RefPtr<InterfaceBlock> iface = create_node<InterfaceBlock>();
654 iface->interface = tokenizer.parse_token();
655 if(!is_interface_qualifier(iface->interface))
656 throw parse_error(tokenizer.get_location(), iface->interface, "an interface qualifier");
658 iface->name = expect_identifier();
659 parse_block(iface->members, true, &Parser::parse_variable_declaration_with_layout);
662 iface->instance_name = expect_identifier();
666 tokenizer.expect("]");
668 tokenizer.expect(";");
674 RefPtr<Conditional> Parser::parse_conditional()
676 tokenizer.expect("if");
677 RefPtr<Conditional> cond = create_node<Conditional>();
678 tokenizer.expect("(");
679 cond->condition = parse_expression();
680 tokenizer.expect(")");
682 parse_block(cond->body, false, &Parser::parse_statement);
684 string token = tokenizer.peek_token();
687 tokenizer.parse_token();
688 parse_block(cond->else_body, false, &Parser::parse_statement);
694 RefPtr<Iteration> Parser::parse_for()
696 tokenizer.expect("for");
697 RefPtr<Iteration> loop = create_node<Iteration>();
698 tokenizer.expect("(");
699 string token = tokenizer.peek_token();
701 loop->init_statement = parse_statement();
706 RefPtr<ExpressionStatement> expr = create_node<ExpressionStatement>();
707 expr->expression = parse_expression();
708 loop->init_statement = expr;
710 tokenizer.expect(";");
712 if(tokenizer.peek_token()!=";")
713 loop->condition = parse_expression();
714 tokenizer.expect(";");
715 if(tokenizer.peek_token()!=")")
716 loop->loop_expression = parse_expression();
717 tokenizer.expect(")");
719 parse_block(loop->body, false, &Parser::parse_statement);
724 RefPtr<Iteration> Parser::parse_while()
726 tokenizer.expect("while");
727 RefPtr<Iteration> loop = create_node<Iteration>();
728 tokenizer.expect("(");
729 loop->condition = parse_expression();
730 tokenizer.expect(")");
732 parse_block(loop->body, false, &Parser::parse_statement);
737 RefPtr<Passthrough> Parser::parse_passthrough()
739 tokenizer.expect("passthrough");
740 RefPtr<Passthrough> pass = create_node<Passthrough>();
741 if(cur_stage->type==Stage::GEOMETRY)
743 tokenizer.expect("[");
744 pass->subscript = parse_expression();
745 tokenizer.expect("]");
747 tokenizer.expect(";");
751 RefPtr<Return> Parser::parse_return()
753 tokenizer.expect("return");
754 RefPtr<Return> ret = create_node<Return>();
755 if(tokenizer.peek_token()!=";")
756 ret->expression = parse_expression();
757 tokenizer.expect(";");