1 #include <msp/core/raii.h>
2 #include <msp/strings/format.h>
3 #include <msp/strings/regex.h>
4 #include <msp/strings/utils.h>
6 #include "glsl_error.h"
18 preprocessor(tokenizer),
21 tokenizer.signal_preprocess.connect(sigc::mem_fun(&preprocessor, &Preprocessor::preprocess));
22 preprocessor.signal_version.connect(sigc::mem_fun(this, &Parser::set_required_version));
23 preprocessor.signal_source.connect(sigc::mem_fun(this, &Parser::source_reference));
24 preprocessor.signal_stage_change.connect(sigc::mem_fun(this, &Parser::stage_change));
25 preprocessor.signal_line.connect(sigc::mem_fun(this, &Parser::line_change));
33 Module &Parser::parse(const string &s, const string &n, int i)
40 Module &Parser::parse(IO::Base &io, const string &n, int i)
46 unsigned len = io.read(buffer, sizeof(buffer));
47 source.append(buffer, len);
53 void Parser::parse_source(const string &name, int index)
58 cur_stage = &module->shared;
62 source_reference(1, name);
64 // TODO Need to somehow get type names from imports
65 if(const Stage *builtin = get_builtins(Stage::SHARED))
67 for(map<string, TypeDeclaration *>::const_iterator i=builtin->types.begin(); i!=builtin->types.end(); ++i)
68 declared_types.insert(i->first);
72 declared_types.insert("void");
73 declared_types.insert("bool");
74 declared_types.insert("int");
75 declared_types.insert("float");
78 tokenizer.begin(source, name);
79 allow_stage_change = true;
80 while(!tokenizer.peek_token().empty())
81 if(RefPtr<Statement> statement = parse_with_recovery(&Parser::parse_global_declaration))
82 cur_stage->content.body.push_back(statement);
85 throw invalid_shader_source(join(errors.begin(), errors.end(), "\n"));
88 void Parser::set_required_version(const Version &ver)
90 cur_stage->required_features.glsl_version = ver;
93 void Parser::source_reference(unsigned index, const string &name)
95 if(index<1 || base_index<0)
96 throw invalid_shader_source(tokenizer.get_location(), "Invalid source reference");
98 module->source_map.set_name(base_index+index-1, name);
101 void Parser::stage_change(Stage::Type stage)
103 if(!allow_stage_change)
104 throw invalid_shader_source(tokenizer.get_location(), "Changing stage not allowed here");
105 else if(stage<=cur_stage->type)
106 throw invalid_shader_source(tokenizer.get_location(), "Stage '%s' not allowed here", Stage::get_stage_name(stage));
108 module->stages.push_back(stage);
110 if(cur_stage->type!=Stage::SHARED)
111 module->stages.back().previous = cur_stage;
112 cur_stage = &module->stages.back();
115 void Parser::line_change(int index, unsigned line)
118 source_index = base_index+index-1;
122 index = source_index;
124 string name = module->source_map.get_name(index);
126 name = format("<%d>", index);
127 tokenizer.set_location(Location(name, line));
130 string Parser::expect_type()
132 string token = tokenizer.parse_token();
134 throw parse_error(tokenizer.get_location(), token, "a type");
138 string Parser::expect_identifier()
140 string token = tokenizer.parse_token();
141 if(!is_identifier(token))
142 throw parse_error(tokenizer.get_location(), token, "an identifier");
146 int Parser::expect_integer()
148 string token = tokenizer.parse_token();
150 throw parse_error(tokenizer.get_location(), token, "an integer literal");
151 return lexical_cast<int>(token);
154 bool Parser::check(const string &token)
156 bool result = (tokenizer.peek_token()==token);
158 tokenizer.parse_token();
162 bool Parser::is_interface_qualifier(const string &token)
164 return (token=="uniform" || token=="in" || token=="out");
167 bool Parser::is_sampling_qualifier(const string &token)
169 return (token=="centroid" || token=="sample");
172 bool Parser::is_interpolation_qualifier(const string &token)
174 return (token=="smooth" || token=="flat" || token=="noperspective");
177 bool Parser::is_precision_qualifier(const string &token)
179 return (token=="highp" || token=="mediump" || token=="lowp");
182 bool Parser::is_qualifier(const string &token)
184 return (token=="const" ||
185 is_interface_qualifier(token) ||
186 is_sampling_qualifier(token) ||
187 is_interpolation_qualifier(token) ||
188 is_precision_qualifier(token));
191 bool Parser::is_type(const string &token)
193 return declared_types.count(token);
196 bool Parser::is_identifier(const string &token)
198 static Regex re("^[a-zA-Z_][a-zA-Z0-9_]*$");
199 return re.match(token);
203 RefPtr<T> Parser::create_node()
205 RefPtr<T> node = new T;
206 node->source = source_index;
207 node->line = tokenizer.get_location().line;
212 RefPtr<T> Parser::parse_with_recovery(RefPtr<T> (Parser::*parse_func)())
214 tokenizer.clear_progress_mark();
217 return (this->*parse_func)();
219 catch(const invalid_shader_source &exc)
221 errors.push_back(exc.what());
224 if(tokenizer.get_last_token()!=";" || !tokenizer.get_progress_mark())
226 unsigned scope_level = 0;
229 if(tokenizer.peek_token()=="}" && scope_level==0)
231 if(!tokenizer.get_progress_mark())
232 tokenizer.parse_token();
236 string token = tokenizer.parse_token();
245 else if(token==";" && scope_level==0)
247 else if(token.empty())
255 RefPtr<Statement> Parser::parse_global_declaration()
257 string token = tokenizer.peek_token();
258 SetFlag disallow(allow_stage_change, false);
261 return parse_import();
262 else if(token=="precision")
263 return parse_precision();
264 else if(token=="layout")
266 RefPtr<Layout> layout = parse_layout();
267 token = tokenizer.peek_token();
268 if(is_interface_qualifier(token) && tokenizer.peek_token(1)==";")
270 RefPtr<InterfaceLayout> iface_lo = create_node<InterfaceLayout>();
271 iface_lo->layout.source = layout->source;
272 iface_lo->layout.line = layout->line;
273 iface_lo->layout.qualifiers = layout->qualifiers;
274 iface_lo->interface = tokenizer.parse_token();
275 tokenizer.expect(";");
278 else if(is_interface_qualifier(token) && tokenizer.peek_token(2)=="{")
280 RefPtr<InterfaceBlock> iface = parse_interface_block();
281 iface->layout = layout;
286 RefPtr<VariableDeclaration> var = parse_variable_declaration();
287 var->layout = layout;
291 else if(token=="typedef")
292 return parse_type_declaration();
293 else if(token=="struct")
294 return parse_struct_declaration();
295 else if(is_interface_qualifier(token))
297 string next = tokenizer.peek_token(1);
298 if(is_type(next) || is_qualifier(next))
299 return parse_variable_declaration();
301 return parse_interface_block();
303 else if(is_qualifier(token))
304 return parse_variable_declaration();
305 else if(token=="virtual")
306 return parse_function_declaration();
307 else if(is_type(token))
309 if(tokenizer.peek_token(2)=="(")
310 return parse_function_declaration();
312 return parse_variable_declaration();
314 else if(token.empty())
317 throw parse_error(tokenizer.get_location(), token, "a global declaration");
320 RefPtr<Statement> Parser::parse_statement()
322 string token = tokenizer.peek_token();
324 return parse_conditional();
325 else if(token=="for")
327 else if(token=="while")
328 return parse_while();
329 else if(token=="passthrough")
330 return parse_passthrough();
331 else if(token=="return")
332 return parse_return();
333 else if(token=="break" || token=="continue" || token=="discard")
335 RefPtr<Jump> jump = create_node<Jump>();
336 jump->keyword = tokenizer.parse_token();
337 tokenizer.expect(";");
341 else if(is_qualifier(token) || is_type(token))
342 return parse_variable_declaration();
345 tokenizer.parse_token();
346 throw invalid_shader_source(tokenizer.get_location(), "Empty statement not allowed");
348 else if(!token.empty())
350 RefPtr<ExpressionStatement> expr = create_node<ExpressionStatement>();
351 expr->expression = parse_expression();
352 tokenizer.expect(";");
357 throw parse_error(tokenizer.get_location(), token, "a statement");
360 RefPtr<Import> Parser::parse_import()
362 if(cur_stage->type!=Stage::SHARED)
363 throw invalid_shader_source(tokenizer.get_location(), "Imports are only allowed in the shared section");
365 tokenizer.expect("import");
366 RefPtr<Import> import = create_node<Import>();
367 import->module = expect_identifier();
368 tokenizer.expect(";");
372 RefPtr<Precision> Parser::parse_precision()
374 tokenizer.expect("precision");
375 RefPtr<Precision> precision = create_node<Precision>();
377 precision->precision = tokenizer.parse_token();
378 if(!is_precision_qualifier(precision->precision))
379 throw parse_error(tokenizer.get_location(), precision->precision, "a precision qualifier");
381 // TODO Add validation for this
382 precision->type = expect_type();
384 tokenizer.expect(";");
389 RefPtr<Layout> Parser::parse_layout()
391 tokenizer.expect("layout");
392 tokenizer.expect("(");
393 RefPtr<Layout> layout = create_node<Layout>();
396 string token = tokenizer.parse_token();
398 throw parse_error(tokenizer.get_location(), token, "a layout qualifier name");
400 layout->qualifiers.push_back(Layout::Qualifier());
401 Layout::Qualifier &qual = layout->qualifiers.back();
404 if((qual.has_value = check("=")))
406 if(qual.name=="constant_id" && tokenizer.peek_token()=="auto")
409 tokenizer.parse_token();
412 qual.value = expect_integer();
415 if(tokenizer.peek_token()==")")
418 tokenizer.expect(",");
420 tokenizer.expect(")");
426 void Parser::parse_block(Block &block, bool require_braces, RefPtr<T> (Parser::*parse_content)())
428 bool have_braces = (require_braces || tokenizer.peek_token()=="{");
430 tokenizer.expect("{");
434 while(tokenizer.peek_token()!="}")
435 if(RefPtr<Statement> node = parse_with_recovery(parse_content))
436 block.body.push_back(node);
439 block.body.push_back((this->*parse_content)());
441 block.use_braces = (require_braces || block.body.size()!=1);
444 tokenizer.expect("}");
447 RefPtr<Expression> Parser::parse_expression(const Operator *outer_oper)
449 unsigned outer_precedence = (outer_oper ? outer_oper->precedence+(outer_oper->assoc==Operator::RIGHT_TO_LEFT) : 20);
450 RefPtr<Expression> left;
451 VariableReference *left_var = 0;
454 string token = tokenizer.peek_token();
456 const Operator *oper = 0;
457 for(const Operator *i=Operator::operators; (!oper && i->type); ++i)
458 if(token==i->token && (!left || i->type!=Operator::PREFIX) && (left || i->type!=Operator::POSTFIX))
461 bool lower_precedence = (oper && oper->type!=Operator::PREFIX && oper->precedence>=outer_precedence);
462 if(token==";" || token==")" || token=="]" || token=="," || token==":" || lower_precedence)
467 throw parse_error(tokenizer.get_location(), token, "an expression");
474 throw invalid_shader_source(tokenizer.get_location(), "Syntax error before '(': function name must be an identifier");
475 left = parse_function_call(*left_var);
479 RefPtr<MemberAccess> memacc = create_node<MemberAccess>();
482 tokenizer.parse_token();
483 memacc->member = expect_identifier();
486 else if(oper && oper->type==Operator::POSTFIX)
488 RefPtr<UnaryExpression> unary = create_node<UnaryExpression>();
490 tokenizer.parse_token();
491 unary->expression = left;
494 else if(oper && oper->type==Operator::BINARY)
495 left = parse_binary(left, *oper);
496 else if(oper && oper->type==Operator::TERNARY)
497 left = parse_ternary(left, *oper);
499 throw parse_error(tokenizer.get_location(), token, "an operator");
506 tokenizer.parse_token();
507 left = parse_expression();
508 tokenizer.expect(")");
510 else if(isdigit(token[0]) || token=="true" || token=="false")
511 left = parse_literal();
512 else if(is_identifier(token))
514 RefPtr<VariableReference> var = create_node<VariableReference>();
515 var->name = expect_identifier();
517 left_var = var.get();
519 else if(oper && oper->type==Operator::PREFIX)
521 RefPtr<UnaryExpression> unary = create_node<UnaryExpression>();
523 tokenizer.parse_token();
524 unary->expression = parse_expression(oper);
528 throw parse_error(tokenizer.get_location(), token, "an expression");
533 RefPtr<Literal> Parser::parse_literal()
535 RefPtr<Literal> literal = create_node<Literal>();
536 literal->token = tokenizer.parse_token();
537 if(isdigit(literal->token[0]))
539 // TODO have the tokenizer return the type of the token
540 if(isnumrc(literal->token))
541 literal->value = lexical_cast<int>(literal->token);
543 literal->value = lexical_cast<float>(literal->token);
545 else if(literal->token=="true" || literal->token=="false")
546 literal->value = (literal->token=="true");
548 throw parse_error(tokenizer.get_location(), literal->token, "a literal");
553 RefPtr<BinaryExpression> Parser::parse_binary(const RefPtr<Expression> &left, const Operator &oper)
555 RefPtr<BinaryExpression> binary = (oper.precedence==16 ?
556 static_cast<RefPtr<BinaryExpression> >(create_node<Assignment>()) : create_node<BinaryExpression>());
558 binary->oper = &oper;
559 tokenizer.expect(oper.token);
562 binary->right = parse_expression();
563 tokenizer.expect(oper.token2);
566 binary->right = parse_expression(&oper);
570 RefPtr<TernaryExpression> Parser::parse_ternary(const RefPtr<Expression> &cond, const Operator &oper)
572 RefPtr<TernaryExpression> ternary = create_node<TernaryExpression>();
573 ternary->condition = cond;
574 ternary->oper = &oper;
575 tokenizer.expect("?");
576 ternary->true_expr = parse_expression(&oper);
577 tokenizer.expect(":");
578 ternary->false_expr = parse_expression(&oper);
582 RefPtr<FunctionCall> Parser::parse_function_call(const VariableReference &var)
584 RefPtr<FunctionCall> call = create_node<FunctionCall>();
585 call->name = var.name;
586 call->oper = &Operator::get_operator("(", Operator::POSTFIX);
587 tokenizer.expect("(");
588 while(tokenizer.peek_token()!=")")
590 if(!call->arguments.empty())
591 tokenizer.expect(",");
592 call->arguments.push_back(parse_expression());
594 tokenizer.expect(")");
598 RefPtr<TypeDeclaration> Parser::parse_type_declaration()
600 tokenizer.expect("typedef");
602 RefPtr<TypeDeclaration> type;
603 if(tokenizer.peek_token()=="image")
604 type = parse_image_type_declaration();
606 type = parse_basic_type_declaration();
608 tokenizer.expect(";");
609 declared_types.insert(type->name);
613 RefPtr<BasicTypeDeclaration> Parser::parse_basic_type_declaration()
615 RefPtr<BasicTypeDeclaration> type = create_node<BasicTypeDeclaration>();
617 if(tokenizer.peek_token()=="vector")
619 type->kind = BasicTypeDeclaration::VECTOR;
621 tokenizer.parse_token();
622 tokenizer.expect("(");
623 type->size = expect_integer();
624 tokenizer.expect(")");
627 type->base = expect_type();
628 type->name = expect_identifier();
630 if(type->kind==BasicTypeDeclaration::ALIAS && check("["))
632 type->kind = BasicTypeDeclaration::ARRAY;
633 tokenizer.expect("]");
639 RefPtr<ImageTypeDeclaration> Parser::parse_image_type_declaration()
641 tokenizer.expect("image");
642 tokenizer.expect("(");
644 RefPtr<ImageTypeDeclaration> type = create_node<ImageTypeDeclaration>();
647 string token = tokenizer.parse_token();
648 if(token=="dimensions")
650 tokenizer.expect("=");
651 token = tokenizer.parse_token();
653 type->dimensions = ImageTypeDeclaration::ONE;
655 type->dimensions = ImageTypeDeclaration::TWO;
657 type->dimensions = ImageTypeDeclaration::THREE;
658 else if(token=="cube")
659 type->dimensions = ImageTypeDeclaration::CUBE;
661 throw parse_error(tokenizer.get_location(), token, "dimensions");
666 tokenizer.expect("]");
669 else if(token=="sampled")
670 type->sampled = true;
671 else if(token=="shadow")
674 throw parse_error(tokenizer.get_location(), token, "image type attribute");
676 token = tokenizer.peek_token();
680 tokenizer.expect(",");
682 tokenizer.expect(")");
684 type->base = expect_type();
685 type->name = expect_identifier();
690 RefPtr<StructDeclaration> Parser::parse_struct_declaration()
692 tokenizer.expect("struct");
693 RefPtr<StructDeclaration> strct = create_node<StructDeclaration>();
695 strct->name = expect_identifier();
696 parse_block(strct->members, true, &Parser::parse_variable_declaration);
697 tokenizer.expect(";");
699 declared_types.insert(strct->name);
703 RefPtr<VariableDeclaration> Parser::parse_variable_declaration()
705 RefPtr<VariableDeclaration> var = create_node<VariableDeclaration>();
707 string token = tokenizer.peek_token();
708 while(is_qualifier(token))
710 tokenizer.parse_token();
711 if(is_interface_qualifier(token))
712 var->interface = token;
713 else if(is_sampling_qualifier(token))
714 var->sampling = token;
715 else if(is_interpolation_qualifier(token))
716 var->interpolation = token;
717 else if(is_precision_qualifier(token))
718 var->precision = token;
719 else if(token=="const")
720 var->constant = true;
721 token = tokenizer.peek_token();
724 var->type = expect_type();
725 var->name = expect_identifier();
732 var->array_size = parse_expression();
733 tokenizer.expect("]");
738 var->init_expression = parse_expression();
740 tokenizer.expect(";");
744 RefPtr<VariableDeclaration> Parser::parse_variable_declaration_with_layout()
746 RefPtr<Layout> layout;
747 if(tokenizer.peek_token()=="layout")
748 layout = parse_layout();
750 RefPtr<VariableDeclaration> var = parse_variable_declaration();
751 var->layout = layout;
756 RefPtr<FunctionDeclaration> Parser::parse_function_declaration()
758 RefPtr<FunctionDeclaration> func = create_node<FunctionDeclaration>();
760 func->virtua = check("virtual");
761 func->return_type = expect_type();
762 func->name = expect_identifier();
763 tokenizer.expect("(");
764 while(tokenizer.peek_token()!=")")
766 if(!func->parameters.empty())
767 tokenizer.expect(",");
769 RefPtr<VariableDeclaration> var = create_node<VariableDeclaration>();
770 string token = tokenizer.peek_token();
771 if(token=="in" || token=="out" || token=="inout")
772 var->interface = tokenizer.parse_token();
773 var->type = expect_type();
774 var->name = expect_identifier();
775 func->parameters.push_back(var);
777 tokenizer.expect(")");
779 func->overrd = check("override");
781 string token = tokenizer.peek_token();
784 func->definition = func.get();
785 parse_block(func->body, true, &Parser::parse_statement);
788 tokenizer.parse_token();
790 throw parse_error(tokenizer.get_location(), token, "'{' or ';'");
795 RefPtr<InterfaceBlock> Parser::parse_interface_block()
797 RefPtr<InterfaceBlock> iface = create_node<InterfaceBlock>();
799 iface->interface = tokenizer.parse_token();
800 if(!is_interface_qualifier(iface->interface))
801 throw parse_error(tokenizer.get_location(), iface->interface, "an interface qualifier");
803 iface->block_name = expect_identifier();
804 iface->members = new Block;
805 parse_block(*iface->members, true, &Parser::parse_variable_declaration_with_layout);
808 iface->instance_name = expect_identifier();
812 tokenizer.expect("]");
814 tokenizer.expect(";");
820 RefPtr<Conditional> Parser::parse_conditional()
822 tokenizer.expect("if");
823 RefPtr<Conditional> cond = create_node<Conditional>();
824 tokenizer.expect("(");
825 cond->condition = parse_expression();
826 tokenizer.expect(")");
828 parse_block(cond->body, false, &Parser::parse_statement);
830 string token = tokenizer.peek_token();
833 tokenizer.parse_token();
834 parse_block(cond->else_body, false, &Parser::parse_statement);
840 RefPtr<Iteration> Parser::parse_for()
842 tokenizer.expect("for");
843 RefPtr<Iteration> loop = create_node<Iteration>();
844 tokenizer.expect("(");
845 string token = tokenizer.peek_token();
847 loop->init_statement = parse_statement();
852 RefPtr<ExpressionStatement> expr = create_node<ExpressionStatement>();
853 expr->expression = parse_expression();
854 loop->init_statement = expr;
856 tokenizer.expect(";");
858 if(tokenizer.peek_token()!=";")
859 loop->condition = parse_expression();
860 tokenizer.expect(";");
861 if(tokenizer.peek_token()!=")")
862 loop->loop_expression = parse_expression();
863 tokenizer.expect(")");
865 parse_block(loop->body, false, &Parser::parse_statement);
870 RefPtr<Iteration> Parser::parse_while()
872 tokenizer.expect("while");
873 RefPtr<Iteration> loop = create_node<Iteration>();
874 tokenizer.expect("(");
875 loop->condition = parse_expression();
876 tokenizer.expect(")");
878 parse_block(loop->body, false, &Parser::parse_statement);
883 RefPtr<Passthrough> Parser::parse_passthrough()
885 tokenizer.expect("passthrough");
886 RefPtr<Passthrough> pass = create_node<Passthrough>();
887 if(cur_stage->type==Stage::GEOMETRY)
889 tokenizer.expect("[");
890 pass->subscript = parse_expression();
891 tokenizer.expect("]");
893 tokenizer.expect(";");
897 RefPtr<Return> Parser::parse_return()
899 tokenizer.expect("return");
900 RefPtr<Return> ret = create_node<Return>();
901 if(tokenizer.peek_token()!=";")
902 ret->expression = parse_expression();
903 tokenizer.expect(";");