1 #ifndef MSP_GL_SL_VALIDATE_H_
2 #define MSP_GL_SL_VALIDATE_H_
6 #include "glsl_error.h"
13 /** Base class for validators. Contains some utilities for adding diagnostic
15 class Validator: protected TraversingVisitor
23 void diagnose(Node &, Node &, Diagnostic::Severity, const std::string &);
24 void diagnose(Node &n, Diagnostic::Severity s, const std::string &m) { diagnose(n, n, s, m); }
25 void error(Node &n, const std::string &m) { diagnose(n, Diagnostic::ERR, m); }
26 void add_info(Node &, const std::string &);
29 /** Verifies that declarations are valid in isolation. */
30 class DeclarationValidator: private Validator
43 InterfaceLayout *iface_layout;
44 InterfaceBlock *iface_block;
45 VariableDeclaration *variable;
48 DeclarationValidator();
50 void apply(Stage &s) { stage = &s; s.content.visit(*this); }
53 static const char *describe_variable(ScopeType);
55 virtual void visit(Layout &);
56 virtual void visit(InterfaceLayout &);
57 virtual void visit(BasicTypeDeclaration &);
58 virtual void visit(ImageTypeDeclaration &);
59 virtual void visit(StructDeclaration &);
60 virtual void visit(VariableDeclaration &);
61 virtual void visit(InterfaceBlock &);
62 virtual void visit(FunctionDeclaration &);
65 /** Verifies that identifiers are unique or, in the case of functions, are
66 overloaded only in valid ways. */
67 class IdentifierValidator: private Validator
70 typedef std::map<std::string, Statement *> BlockDeclarationMap;
72 std::map<Block *, BlockDeclarationMap> declarations;
73 std::map<std::string, InterfaceBlock *> interface_blocks;
74 std::map<std::string, FunctionDeclaration *> overloaded_functions;
78 IdentifierValidator();
80 void apply(Stage &s) { stage = &s; s.content.visit(*this); }
83 void multiple_definition(const std::string &, Statement &, Statement &);
84 Statement *find_definition(const std::string &);
85 void check_definition(const std::string &, Statement &);
86 void record_definition(const std::string &, Statement &);
88 virtual void visit(TypeDeclaration &);
89 virtual void visit(BasicTypeDeclaration &t) { visit(static_cast<TypeDeclaration &>(t)); }
90 virtual void visit(ImageTypeDeclaration &t) { visit(static_cast<TypeDeclaration &>(t)); }
91 virtual void visit(StructDeclaration &);
92 virtual void visit(VariableDeclaration &);
93 virtual void visit(InterfaceBlock &);
94 virtual void visit(FunctionDeclaration &);
97 /** Verifies that there are no unresolved references. */
98 class ReferenceValidator: private Validator
101 void apply(Stage &s) { stage = &s; s.content.visit(*this); }
104 virtual void visit(BasicTypeDeclaration &);
105 virtual void visit(ImageTypeDeclaration &);
106 virtual void visit(VariableReference &);
107 virtual void visit(MemberAccess &);
108 virtual void visit(InterfaceBlockReference &);
109 virtual void visit(FunctionCall &);
110 virtual void visit(VariableDeclaration &);
111 virtual void visit(InterfaceBlock &);
112 virtual void visit(FunctionDeclaration &);
115 /** Verifies that expressions are valid. In most cases an invalid expression
116 is indicated by a null result type. */
117 class ExpressionValidator: private Validator
120 FunctionDeclaration *current_function;
121 bool constant_expression;
124 ExpressionValidator();
126 void apply(Stage &s) { stage = &s; s.content.visit(*this); }
129 virtual void visit(VariableReference &);
130 virtual void visit(InterfaceBlockReference &);
131 virtual void visit(Swizzle &);
132 virtual void visit(UnaryExpression &);
133 virtual void visit(BinaryExpression &);
134 virtual void visit(Assignment &);
135 virtual void visit(TernaryExpression &);
136 virtual void visit(VariableDeclaration &);
137 virtual void visit(FunctionDeclaration &);
138 virtual void visit(Conditional &);
139 virtual void visit(Iteration &);
140 virtual void visit(Return &);
143 /** Verifies flow control constructs. Functions returning non-void must have
144 return statements. Warnings are given about dead code. */
145 class FlowControlValidator: private Validator
151 FlowControlValidator();
153 void apply(Stage &s) { stage = &s; s.content.visit(*this); }
156 virtual void visit(Block &);
157 virtual void visit(FunctionDeclaration &);
158 virtual void visit(Conditional &);
159 virtual void visit(Iteration &);
160 virtual void visit(Return &) { reachable = false; }
161 virtual void visit(Jump &) { reachable = false; }
164 /** Verifies that stage input and output interfaces are valid. Linked
165 variables must have matching types and locations and there must not be any
166 overlap in locations. */
167 class StageInterfaceValidator: private Validator
170 std::map<std::string, std::map<unsigned, VariableDeclaration *> > used_locations;
173 void apply(Stage &s) { stage = &s; s.content.visit(*this); }
176 int get_location(const Layout &);
178 virtual void visit(VariableDeclaration &);
179 virtual void visit(FunctionDeclaration &) { }
182 /** Verifies that uniform interfaces are valid across the entire module.
183 Variables declared with the same binding must have the same name and type. */
184 class GlobalInterfaceValidator: private Validator
190 TypeDeclaration *type;
197 Uniform(): node(0), type(0), location(-1), loc_count(1), desc_set(0), bind_point(-1) { }
200 std::list<Uniform> uniforms;
201 std::map<std::string, const Uniform *> used_names;
202 std::map<unsigned, const Uniform *> used_locations;
203 std::map<unsigned, std::map<unsigned, const Uniform *> > used_bindings;
206 void apply(Module &);
209 void check_uniform(const Uniform &);
211 virtual void visit(VariableDeclaration &);
212 virtual void visit(InterfaceBlock &);
213 virtual void visit(FunctionDeclaration &) { }