1 #include <msp/core/algorithm.h>
2 #include <msp/core/raii.h>
3 #include <msp/strings/format.h>
4 #include <msp/strings/regex.h>
5 #include <msp/strings/utils.h>
7 #include "glsl_error.h"
8 #include "modulecache.h"
19 Parser::Parser(ModuleCache *s):
21 preprocessor(tokenizer),
24 tokenizer.signal_preprocess.connect(sigc::mem_fun(&preprocessor, &Preprocessor::preprocess));
25 preprocessor.signal_version.connect(sigc::mem_fun(this, &Parser::set_required_version));
26 preprocessor.signal_source.connect(sigc::mem_fun(this, &Parser::source_reference));
27 preprocessor.signal_stage_change.connect(sigc::mem_fun(this, &Parser::stage_change));
28 preprocessor.signal_line.connect(sigc::mem_fun(this, &Parser::line_change));
31 void Parser::parse(Module &m, const string &s, const string &n, int i)
33 SetForScope<Module *> set_module(module, &m);
38 void Parser::parse(Module &m, IO::Base &io, const string &n, int i)
40 SetForScope<Module *> set_module(module, &m);
45 unsigned len = io.read(buffer, sizeof(buffer));
46 source.append(buffer, len);
51 void Parser::parse_source(const string &name, int index)
53 cur_stage = &module->shared;
57 source_reference(1, name);
59 if(const Stage *builtin = get_builtins(Stage::SHARED))
61 for(const auto &kvp: builtin->types)
62 global_types.insert(kvp.first);
65 tokenizer.begin(source, name);
66 allow_stage_change = true;
67 while(!tokenizer.peek_token().empty())
68 if(RefPtr<Statement> statement = parse_with_recovery(&Parser::parse_global_declaration))
69 cur_stage->content.body.push_back(statement);
72 throw invalid_shader_source(join(errors.begin(), errors.end(), "\n"));
75 void Parser::set_required_version(const Version &ver)
77 cur_stage->required_features.glsl_version = ver;
80 void Parser::source_reference(unsigned index, const string &name)
82 if(index<1 || base_index<0)
83 throw invalid_shader_source(tokenizer.get_location(), "Invalid source reference");
85 module->source_map.set_name(base_index+index-1, name);
88 void Parser::stage_change(Stage::Type stage)
90 if(!allow_stage_change)
91 throw invalid_shader_source(tokenizer.get_location(), "Changing stage not allowed here");
92 else if(stage<=cur_stage->type)
93 throw invalid_shader_source(tokenizer.get_location(), "Stage '%s' not allowed here", Stage::get_stage_name(stage));
95 module->stages.push_back(stage);
97 if(cur_stage->type!=Stage::SHARED)
98 module->stages.back().previous = cur_stage;
99 cur_stage = &module->stages.back();
102 for(const Module *m: imported_modules)
104 auto j = find_member(m->stages, stage, &Stage::type);
105 if(j!=m->stages.end())
107 for(const auto &kvp: j->types)
108 stage_types.insert(kvp.first);
113 void Parser::line_change(int index, unsigned line)
116 source_index = base_index+index-1;
120 index = source_index;
122 string name = module->source_map.get_name(index);
124 name = format("<%d>", index);
125 tokenizer.set_location(Location(name, line));
128 string Parser::expect_type()
130 string token = tokenizer.parse_token();
132 throw parse_error(tokenizer.get_location(), token, "a type");
136 string Parser::expect_identifier()
138 string token = tokenizer.parse_token();
139 if(!is_identifier(token))
140 throw parse_error(tokenizer.get_location(), token, "an identifier");
144 int Parser::expect_integer()
146 string token = tokenizer.parse_token();
148 throw parse_error(tokenizer.get_location(), token, "an integer literal");
149 return lexical_cast<int>(token);
152 bool Parser::check(const string &token)
154 bool result = (tokenizer.peek_token()==token);
156 tokenizer.parse_token();
160 bool Parser::is_interface_qualifier(const string &token)
162 return (token=="uniform" || token=="in" || token=="out");
165 bool Parser::is_sampling_qualifier(const string &token)
167 return (token=="centroid" || token=="sample");
170 bool Parser::is_interpolation_qualifier(const string &token)
172 return (token=="smooth" || token=="flat" || token=="noperspective");
175 bool Parser::is_precision_qualifier(const string &token)
177 return (token=="highp" || token=="mediump" || token=="lowp");
180 bool Parser::is_qualifier(const string &token)
182 return (token=="const" ||
183 is_interface_qualifier(token) ||
184 is_sampling_qualifier(token) ||
185 is_interpolation_qualifier(token) ||
186 is_precision_qualifier(token));
189 bool Parser::is_type(const string &token)
191 return global_types.count(token) || stage_types.count(token);
194 bool Parser::is_identifier(const string &token)
196 static Regex re("^[a-zA-Z_][a-zA-Z0-9_]*$");
197 return static_cast<bool>(re.match(token));
201 RefPtr<T> Parser::create_node()
203 RefPtr<T> node = new T;
204 node->source = source_index;
205 node->line = tokenizer.get_location().line;
210 RefPtr<T> Parser::parse_with_recovery(RefPtr<T> (Parser::*parse_func)())
212 tokenizer.clear_progress_mark();
215 return (this->*parse_func)();
217 catch(const invalid_shader_source &exc)
219 errors.push_back(exc.what());
222 if(tokenizer.get_last_token()!=";" || !tokenizer.get_progress_mark())
224 unsigned scope_level = 0;
227 if(tokenizer.peek_token()=="}" && scope_level==0)
229 if(!tokenizer.get_progress_mark())
230 tokenizer.parse_token();
234 string token = tokenizer.parse_token();
243 else if(token==";" && scope_level==0)
245 else if(token.empty())
253 RefPtr<Statement> Parser::parse_global_declaration()
255 string token = tokenizer.peek_token();
256 SetFlag disallow(allow_stage_change, false);
259 return parse_import();
260 else if(token=="precision")
261 return parse_precision();
262 else if(token=="layout")
264 RefPtr<Layout> layout = parse_layout();
265 token = tokenizer.peek_token();
266 if(is_interface_qualifier(token) && tokenizer.peek_token(1)==";")
268 RefPtr<InterfaceLayout> iface_lo = create_node<InterfaceLayout>();
269 iface_lo->layout.source = layout->source;
270 iface_lo->layout.line = layout->line;
271 iface_lo->layout.qualifiers = layout->qualifiers;
272 iface_lo->interface = tokenizer.parse_token();
273 tokenizer.expect(";");
276 else if(is_interface_qualifier(token) && tokenizer.peek_token(2)=="{")
278 RefPtr<InterfaceBlock> iface = parse_interface_block();
279 iface->layout = layout;
284 RefPtr<VariableDeclaration> var = parse_variable_declaration();
285 var->layout = layout;
289 else if(token=="typedef")
290 return parse_type_declaration();
291 else if(token=="struct")
292 return parse_struct_declaration();
293 else if(is_interface_qualifier(token))
295 string next = tokenizer.peek_token(1);
296 if(is_type(next) || is_qualifier(next))
297 return parse_variable_declaration();
299 return parse_interface_block();
301 else if(is_qualifier(token))
302 return parse_variable_declaration();
303 else if(token=="virtual")
304 return parse_function_declaration();
305 else if(is_type(token))
307 if(tokenizer.peek_token(2)=="(")
308 return parse_function_declaration();
310 return parse_variable_declaration();
312 else if(token.empty())
315 throw parse_error(tokenizer.get_location(), token, "a global declaration");
318 RefPtr<Statement> Parser::parse_statement()
320 string token = tokenizer.peek_token();
322 return parse_conditional();
323 else if(token=="for")
325 else if(token=="while")
326 return parse_while();
327 else if(token=="passthrough")
328 return parse_passthrough();
329 else if(token=="return")
330 return parse_return();
331 else if(token=="break" || token=="continue" || token=="discard")
333 RefPtr<Jump> jump = create_node<Jump>();
334 jump->keyword = tokenizer.parse_token();
335 tokenizer.expect(";");
339 else if(is_qualifier(token) || is_type(token))
340 return parse_variable_declaration();
343 tokenizer.parse_token();
344 throw invalid_shader_source(tokenizer.get_location(), "Empty statement not allowed");
346 else if(!token.empty())
348 RefPtr<ExpressionStatement> expr = create_node<ExpressionStatement>();
349 expr->expression = parse_expression();
350 tokenizer.expect(";");
355 throw parse_error(tokenizer.get_location(), token, "a statement");
358 RefPtr<Import> Parser::parse_import()
360 if(cur_stage->type!=Stage::SHARED)
361 throw invalid_shader_source(tokenizer.get_location(), "Imports are only allowed in the shared section");
363 tokenizer.expect("import");
364 RefPtr<Import> import = create_node<Import>();
365 import->module = expect_identifier();
366 tokenizer.expect(";");
370 const Module &imported_mod = mod_cache->get_module(import->module);
371 imported_modules.push_back(&imported_mod);
372 for(const auto &kvp: imported_mod.shared.types)
373 global_types.insert(kvp.first);
379 RefPtr<Precision> Parser::parse_precision()
381 tokenizer.expect("precision");
382 RefPtr<Precision> precision = create_node<Precision>();
384 precision->precision = tokenizer.parse_token();
385 if(!is_precision_qualifier(precision->precision))
386 throw parse_error(tokenizer.get_location(), precision->precision, "a precision qualifier");
388 // TODO Add validation for this
389 precision->type = expect_type();
391 tokenizer.expect(";");
396 RefPtr<Layout> Parser::parse_layout()
398 tokenizer.expect("layout");
399 tokenizer.expect("(");
400 RefPtr<Layout> layout = create_node<Layout>();
403 string token = tokenizer.parse_token();
405 throw parse_error(tokenizer.get_location(), token, "a layout qualifier name");
407 layout->qualifiers.push_back(token);
408 Layout::Qualifier &qual = layout->qualifiers.back();
410 if((qual.has_value = check("=")))
412 if(qual.name=="constant_id" && tokenizer.peek_token()=="auto")
415 tokenizer.parse_token();
418 qual.value = expect_integer();
421 if(tokenizer.peek_token()==")")
424 tokenizer.expect(",");
426 tokenizer.expect(")");
432 void Parser::parse_block(Block &block, bool require_braces, RefPtr<T> (Parser::*parse_content)())
434 bool have_braces = (require_braces || tokenizer.peek_token()=="{");
436 tokenizer.expect("{");
440 while(tokenizer.peek_token()!="}")
441 if(RefPtr<Statement> node = parse_with_recovery(parse_content))
442 block.body.push_back(node);
445 block.body.push_back((this->*parse_content)());
447 block.use_braces = (require_braces || block.body.size()!=1);
450 tokenizer.expect("}");
453 RefPtr<Expression> Parser::parse_expression(const Operator *outer_oper)
455 unsigned outer_precedence = (outer_oper ? outer_oper->precedence+(outer_oper->assoc==Operator::RIGHT_TO_LEFT) : 20);
456 RefPtr<Expression> left;
457 VariableReference *left_var = 0;
460 string token = tokenizer.peek_token();
462 const Operator *oper = 0;
463 for(const Operator *i=Operator::operators; (!oper && i->type); ++i)
464 if(token==i->token && (!left || i->type!=Operator::PREFIX) && (left || i->type!=Operator::POSTFIX))
467 bool lower_precedence = (oper && oper->type!=Operator::PREFIX && oper->precedence>=outer_precedence);
468 if(token==";" || token==")" || token=="]" || token=="," || token==":" || lower_precedence)
473 throw parse_error(tokenizer.get_location(), token, "an expression");
480 throw invalid_shader_source(tokenizer.get_location(), "Syntax error before '(': function name must be an identifier");
481 left = parse_function_call(*left_var);
485 RefPtr<MemberAccess> memacc = create_node<MemberAccess>();
488 tokenizer.parse_token();
489 memacc->member = expect_identifier();
492 else if(oper && oper->type==Operator::POSTFIX)
494 RefPtr<UnaryExpression> unary = create_node<UnaryExpression>();
496 tokenizer.parse_token();
497 unary->expression = left;
500 else if(oper && oper->type==Operator::BINARY)
501 left = parse_binary(left, *oper);
502 else if(oper && oper->type==Operator::TERNARY)
503 left = parse_ternary(left, *oper);
505 throw parse_error(tokenizer.get_location(), token, "an operator");
512 tokenizer.parse_token();
513 left = parse_expression();
514 tokenizer.expect(")");
516 else if(isdigit(token[0]) || token=="true" || token=="false")
517 left = parse_literal();
518 else if(is_identifier(token))
520 RefPtr<VariableReference> var = create_node<VariableReference>();
521 var->name = expect_identifier();
523 left_var = var.get();
525 else if(oper && oper->type==Operator::PREFIX)
527 RefPtr<UnaryExpression> unary = create_node<UnaryExpression>();
529 tokenizer.parse_token();
530 unary->expression = parse_expression(oper);
534 throw parse_error(tokenizer.get_location(), token, "an expression");
539 RefPtr<Literal> Parser::parse_literal()
541 RefPtr<Literal> literal = create_node<Literal>();
542 literal->token = tokenizer.parse_token();
543 if(isdigit(literal->token[0]))
545 // TODO have the tokenizer return the type of the token
546 if(literal->token.back()=='u')
547 literal->value = lexical_cast<unsigned>(literal->token.substr(0, literal->token.size()-1));
548 else if(literal->token.back()=='f')
549 literal->value = lexical_cast<float>(literal->token.substr(0, literal->token.size()-1));
550 else if(literal->token.find('.')!=string::npos)
551 literal->value = lexical_cast<float>(literal->token);
553 literal->value = lexical_cast<int>(literal->token);
555 else if(literal->token=="true" || literal->token=="false")
556 literal->value = (literal->token=="true");
558 throw parse_error(tokenizer.get_location(), literal->token, "a literal");
563 RefPtr<BinaryExpression> Parser::parse_binary(const RefPtr<Expression> &left, const Operator &oper)
565 RefPtr<BinaryExpression> binary = (oper.precedence==16 ?
566 static_cast<RefPtr<BinaryExpression> >(create_node<Assignment>()) : create_node<BinaryExpression>());
568 binary->oper = &oper;
569 tokenizer.expect(oper.token);
572 binary->right = parse_expression();
573 tokenizer.expect(oper.token2);
576 binary->right = parse_expression(&oper);
580 RefPtr<TernaryExpression> Parser::parse_ternary(const RefPtr<Expression> &cond, const Operator &oper)
582 RefPtr<TernaryExpression> ternary = create_node<TernaryExpression>();
583 ternary->condition = cond;
584 ternary->oper = &oper;
585 tokenizer.expect("?");
586 ternary->true_expr = parse_expression(&oper);
587 tokenizer.expect(":");
588 ternary->false_expr = parse_expression(&oper);
592 RefPtr<FunctionCall> Parser::parse_function_call(const VariableReference &var)
594 RefPtr<FunctionCall> call = create_node<FunctionCall>();
595 call->name = var.name;
596 call->oper = &Operator::get_operator("(", Operator::POSTFIX);
597 tokenizer.expect("(");
598 while(tokenizer.peek_token()!=")")
600 if(!call->arguments.empty())
601 tokenizer.expect(",");
602 call->arguments.push_back(parse_expression());
604 tokenizer.expect(")");
608 void Parser::add_type(TypeDeclaration &type)
610 cur_stage->types[type.name] = &type;
611 if(cur_stage->type==Stage::SHARED)
612 global_types.insert(type.name);
614 stage_types.insert(type.name);
617 RefPtr<TypeDeclaration> Parser::parse_type_declaration()
619 tokenizer.expect("typedef");
621 RefPtr<TypeDeclaration> type;
622 if(tokenizer.peek_token()=="image")
623 type = parse_image_type_declaration();
625 type = parse_basic_type_declaration();
627 tokenizer.expect(";");
632 RefPtr<BasicTypeDeclaration> Parser::parse_basic_type_declaration()
634 RefPtr<BasicTypeDeclaration> type = create_node<BasicTypeDeclaration>();
636 if(tokenizer.peek_token()=="vector")
638 type->kind = BasicTypeDeclaration::VECTOR;
640 tokenizer.parse_token();
641 tokenizer.expect("(");
642 type->size = expect_integer();
643 tokenizer.expect(")");
646 type->base = expect_type();
647 type->name = expect_identifier();
649 if(type->kind==BasicTypeDeclaration::ALIAS && check("["))
651 type->kind = BasicTypeDeclaration::ARRAY;
652 tokenizer.expect("]");
658 RefPtr<ImageTypeDeclaration> Parser::parse_image_type_declaration()
660 tokenizer.expect("image");
661 tokenizer.expect("(");
663 RefPtr<ImageTypeDeclaration> type = create_node<ImageTypeDeclaration>();
666 string token = tokenizer.parse_token();
667 if(token=="dimensions")
669 tokenizer.expect("=");
670 token = tokenizer.parse_token();
672 type->dimensions = ImageTypeDeclaration::ONE;
674 type->dimensions = ImageTypeDeclaration::TWO;
676 type->dimensions = ImageTypeDeclaration::THREE;
677 else if(token=="cube")
678 type->dimensions = ImageTypeDeclaration::CUBE;
680 throw parse_error(tokenizer.get_location(), token, "dimensions");
685 tokenizer.expect("]");
688 else if(token=="sampled")
689 type->sampled = true;
690 else if(token=="shadow")
693 throw parse_error(tokenizer.get_location(), token, "image type attribute");
695 token = tokenizer.peek_token();
699 tokenizer.expect(",");
701 tokenizer.expect(")");
703 type->base = expect_type();
704 type->name = expect_identifier();
709 RefPtr<StructDeclaration> Parser::parse_struct_declaration()
711 tokenizer.expect("struct");
712 RefPtr<StructDeclaration> strct = create_node<StructDeclaration>();
714 strct->name = expect_identifier();
715 parse_block(strct->members, true, &Parser::parse_variable_declaration);
716 tokenizer.expect(";");
722 RefPtr<VariableDeclaration> Parser::parse_variable_declaration()
724 RefPtr<VariableDeclaration> var = create_node<VariableDeclaration>();
726 string token = tokenizer.peek_token();
727 while(is_qualifier(token))
729 tokenizer.parse_token();
730 if(is_interface_qualifier(token))
731 var->interface = token;
732 else if(is_sampling_qualifier(token))
733 var->sampling = token;
734 else if(is_interpolation_qualifier(token))
735 var->interpolation = token;
736 else if(is_precision_qualifier(token))
737 var->precision = token;
738 else if(token=="const")
739 var->constant = true;
740 token = tokenizer.peek_token();
743 var->type = expect_type();
744 var->name = expect_identifier();
751 var->array_size = parse_expression();
752 tokenizer.expect("]");
757 var->init_expression = parse_expression();
759 tokenizer.expect(";");
763 RefPtr<VariableDeclaration> Parser::parse_variable_declaration_with_layout()
765 RefPtr<Layout> layout;
766 if(tokenizer.peek_token()=="layout")
767 layout = parse_layout();
769 RefPtr<VariableDeclaration> var = parse_variable_declaration();
770 var->layout = layout;
775 RefPtr<FunctionDeclaration> Parser::parse_function_declaration()
777 RefPtr<FunctionDeclaration> func = create_node<FunctionDeclaration>();
779 func->virtua = check("virtual");
780 func->return_type = expect_type();
781 func->name = expect_identifier();
782 tokenizer.expect("(");
783 while(tokenizer.peek_token()!=")")
785 if(!func->parameters.empty())
786 tokenizer.expect(",");
788 RefPtr<VariableDeclaration> var = create_node<VariableDeclaration>();
789 string token = tokenizer.peek_token();
790 if(token=="in" || token=="out" || token=="inout")
791 var->interface = tokenizer.parse_token();
792 var->type = expect_type();
793 var->name = expect_identifier();
794 func->parameters.push_back(var);
796 tokenizer.expect(")");
798 func->overrd = check("override");
800 string token = tokenizer.peek_token();
803 func->definition = func.get();
804 parse_block(func->body, true, &Parser::parse_statement);
807 tokenizer.parse_token();
809 throw parse_error(tokenizer.get_location(), token, "'{' or ';'");
814 RefPtr<InterfaceBlock> Parser::parse_interface_block()
816 RefPtr<InterfaceBlock> iface = create_node<InterfaceBlock>();
818 iface->interface = tokenizer.parse_token();
819 if(!is_interface_qualifier(iface->interface))
820 throw parse_error(tokenizer.get_location(), iface->interface, "an interface qualifier");
822 iface->block_name = expect_identifier();
823 iface->members = new Block;
824 parse_block(*iface->members, true, &Parser::parse_variable_declaration_with_layout);
827 iface->instance_name = expect_identifier();
831 tokenizer.expect("]");
833 tokenizer.expect(";");
839 RefPtr<Conditional> Parser::parse_conditional()
841 tokenizer.expect("if");
842 RefPtr<Conditional> cond = create_node<Conditional>();
843 tokenizer.expect("(");
844 cond->condition = parse_expression();
845 tokenizer.expect(")");
847 parse_block(cond->body, false, &Parser::parse_statement);
849 string token = tokenizer.peek_token();
852 tokenizer.parse_token();
853 parse_block(cond->else_body, false, &Parser::parse_statement);
859 RefPtr<Iteration> Parser::parse_for()
861 tokenizer.expect("for");
862 RefPtr<Iteration> loop = create_node<Iteration>();
863 tokenizer.expect("(");
864 string token = tokenizer.peek_token();
866 loop->init_statement = parse_statement();
871 RefPtr<ExpressionStatement> expr = create_node<ExpressionStatement>();
872 expr->expression = parse_expression();
873 loop->init_statement = expr;
875 tokenizer.expect(";");
877 if(tokenizer.peek_token()!=";")
878 loop->condition = parse_expression();
879 tokenizer.expect(";");
880 if(tokenizer.peek_token()!=")")
881 loop->loop_expression = parse_expression();
882 tokenizer.expect(")");
884 parse_block(loop->body, false, &Parser::parse_statement);
889 RefPtr<Iteration> Parser::parse_while()
891 tokenizer.expect("while");
892 RefPtr<Iteration> loop = create_node<Iteration>();
893 tokenizer.expect("(");
894 loop->condition = parse_expression();
895 tokenizer.expect(")");
897 parse_block(loop->body, false, &Parser::parse_statement);
902 RefPtr<Passthrough> Parser::parse_passthrough()
904 tokenizer.expect("passthrough");
905 RefPtr<Passthrough> pass = create_node<Passthrough>();
906 if(cur_stage->type==Stage::GEOMETRY)
908 tokenizer.expect("[");
909 pass->subscript = parse_expression();
910 tokenizer.expect("]");
912 tokenizer.expect(";");
916 RefPtr<Return> Parser::parse_return()
918 tokenizer.expect("return");
919 RefPtr<Return> ret = create_node<Return>();
920 if(tokenizer.peek_token()!=";")
921 ret->expression = parse_expression();
922 tokenizer.expect(";");