1 #ifndef MSP_GL_PROGRAMCOMPILER_H_
2 #define MSP_GL_PROGRAMCOMPILER_H_
5 #include "programparser.h"
6 #include "programsyntax.h"
17 struct Visitor: ProgramSyntax::TraversingVisitor
19 typedef void ResultType;
21 ProgramSyntax::Stage *stage;
25 virtual void apply(ProgramSyntax::Stage &);
26 void get_result() const { }
29 struct BlockModifier: Visitor
32 std::vector<RefPtr<ProgramSyntax::Statement> > insert_nodes;
36 void flatten_block(ProgramSyntax::Block &);
37 void apply_and_increment(ProgramSyntax::Block &, ProgramSyntax::NodeList<ProgramSyntax::Statement>::iterator &);
39 virtual void visit(ProgramSyntax::Block &);
42 struct Formatter: Visitor
44 typedef std::string ResultType;
46 std::string formatted;
49 std::string block_interface;
53 virtual void apply(ProgramSyntax::Stage &);
54 const std::string &get_result() const { return formatted; }
56 void append(const std::string &);
58 virtual void visit(ProgramSyntax::Block &);
59 virtual void visit(ProgramSyntax::Literal &);
60 virtual void visit(ProgramSyntax::ParenthesizedExpression &);
61 virtual void visit(ProgramSyntax::VariableReference &);
62 virtual void visit(ProgramSyntax::MemberAccess &);
63 virtual void visit(ProgramSyntax::UnaryExpression &);
64 virtual void visit(ProgramSyntax::BinaryExpression &);
65 virtual void visit(ProgramSyntax::Assignment &);
66 virtual void visit(ProgramSyntax::FunctionCall &);
67 virtual void visit(ProgramSyntax::ExpressionStatement &);
68 virtual void visit(ProgramSyntax::Import &);
69 virtual void visit(ProgramSyntax::Precision &);
70 virtual void visit(ProgramSyntax::Layout &);
71 virtual void visit(ProgramSyntax::InterfaceLayout &);
72 virtual void visit(ProgramSyntax::StructDeclaration &);
73 virtual void visit(ProgramSyntax::VariableDeclaration &);
74 virtual void visit(ProgramSyntax::InterfaceBlock &);
75 virtual void visit(ProgramSyntax::FunctionDeclaration &);
76 virtual void visit(ProgramSyntax::Conditional &);
77 virtual void visit(ProgramSyntax::Iteration &);
78 virtual void visit(ProgramSyntax::Return &);
79 virtual void visit(ProgramSyntax::Jump &);
83 struct NodeGatherer: Visitor
85 typedef std::vector<T *> ResultType;
87 std::vector<T *> nodes;
89 const ResultType &get_result() const { return nodes; }
91 virtual void visit(T &n) { nodes.push_back(&n); }
94 struct DeclarationCombiner: BlockModifier
97 std::map<std::string, std::vector<ProgramSyntax::FunctionDeclaration *> > functions;
98 std::map<std::string, ProgramSyntax::VariableDeclaration *> variables;
100 DeclarationCombiner();
102 using Visitor::visit;
103 virtual void visit(ProgramSyntax::Block &);
104 virtual void visit(ProgramSyntax::FunctionDeclaration &);
105 virtual void visit(ProgramSyntax::VariableDeclaration &);
108 struct VariableResolver: Visitor
110 std::vector<ProgramSyntax::Block *> blocks;
111 ProgramSyntax::StructDeclaration *type;
113 std::string block_interface;
115 ProgramSyntax::VariableDeclaration *assignment_target;
116 bool self_referencing;
120 virtual void apply(ProgramSyntax::Stage &);
121 using Visitor::visit;
122 virtual void visit(ProgramSyntax::Block &);
123 virtual void visit(ProgramSyntax::VariableReference &);
124 virtual void visit(ProgramSyntax::MemberAccess &);
125 virtual void visit(ProgramSyntax::BinaryExpression &);
126 virtual void visit(ProgramSyntax::Assignment &);
127 virtual void visit(ProgramSyntax::StructDeclaration &);
128 virtual void visit(ProgramSyntax::VariableDeclaration &);
129 virtual void visit(ProgramSyntax::InterfaceBlock &);
132 struct FunctionResolver: Visitor
134 std::map<std::string, std::vector<ProgramSyntax::FunctionDeclaration *> > functions;
136 using Visitor::visit;
137 virtual void visit(ProgramSyntax::FunctionCall &);
138 virtual void visit(ProgramSyntax::FunctionDeclaration &);
141 struct InterfaceGenerator: BlockModifier
143 std::string in_prefix;
144 std::string out_prefix;
145 unsigned scope_level;
146 std::map<std::string, RefPtr<ProgramSyntax::VariableDeclaration> > iface_declarations;
148 InterfaceGenerator();
150 static std::string get_out_prefix(ProgramSyntax::StageType);
151 virtual void apply(ProgramSyntax::Stage &);
152 using Visitor::visit;
153 virtual void visit(ProgramSyntax::Block &);
154 std::string change_prefix(const std::string &, const std::string &) const;
155 bool generate_interface(ProgramSyntax::VariableDeclaration &, const std::string &, const std::string &);
156 void insert_assignment(const std::string &, ProgramSyntax::Expression *);
157 virtual void visit(ProgramSyntax::VariableReference &);
158 virtual void visit(ProgramSyntax::VariableDeclaration &);
159 virtual void visit(ProgramSyntax::Passthrough &);
162 struct DeclarationReorderer: Visitor
173 unsigned scope_level;
174 DeclarationKind kind;
175 std::set<ProgramSyntax::Node *> ordered_funcs;
176 std::set<ProgramSyntax::Node *> needed_funcs;
178 DeclarationReorderer();
180 using Visitor::visit;
181 virtual void visit(ProgramSyntax::Block &);
182 virtual void visit(ProgramSyntax::FunctionCall &);
183 virtual void visit(ProgramSyntax::InterfaceLayout &) { kind = LAYOUT; }
184 virtual void visit(ProgramSyntax::StructDeclaration &) { kind = STRUCT; }
185 virtual void visit(ProgramSyntax::VariableDeclaration &);
186 virtual void visit(ProgramSyntax::InterfaceBlock &) { kind = VARIABLE; }
187 virtual void visit(ProgramSyntax::FunctionDeclaration &);
190 struct InlineableFunctionLocator: Visitor
192 typedef std::set<ProgramSyntax::FunctionDeclaration *> ResultType;
194 std::map<ProgramSyntax::FunctionDeclaration *, unsigned> refcounts;
195 std::set<ProgramSyntax::FunctionDeclaration *> inlineable;
196 ProgramSyntax::FunctionDeclaration *in_function;
198 InlineableFunctionLocator();
200 const ResultType &get_result() const { return inlineable; }
201 using Visitor::visit;
202 virtual void visit(ProgramSyntax::FunctionCall &);
203 virtual void visit(ProgramSyntax::FunctionDeclaration &);
206 struct FunctionInliner: Visitor
208 std::set<ProgramSyntax::FunctionDeclaration *> inlineable;
209 unsigned extract_result;
210 RefPtr<ProgramSyntax::Expression> inline_result;
213 FunctionInliner(const std::set<ProgramSyntax::FunctionDeclaration *> &);
215 void visit_and_inline(RefPtr<ProgramSyntax::Expression> &);
216 using Visitor::visit;
217 virtual void visit(ProgramSyntax::Block &);
218 virtual void visit(ProgramSyntax::UnaryExpression &);
219 virtual void visit(ProgramSyntax::BinaryExpression &);
220 virtual void visit(ProgramSyntax::MemberAccess &);
221 virtual void visit(ProgramSyntax::FunctionCall &);
222 virtual void visit(ProgramSyntax::VariableDeclaration &);
223 virtual void visit(ProgramSyntax::Return &);
226 struct ExpressionEvaluator: ProgramSyntax::NodeVisitor
228 typedef std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Expression *> ValueMap;
230 const ValueMap *variable_values;
234 ExpressionEvaluator();
235 ExpressionEvaluator(const ValueMap &);
237 using ProgramSyntax::NodeVisitor::visit;
238 virtual void visit(ProgramSyntax::Literal &);
239 virtual void visit(ProgramSyntax::ParenthesizedExpression &);
240 virtual void visit(ProgramSyntax::VariableReference &);
241 virtual void visit(ProgramSyntax::UnaryExpression &);
242 virtual void visit(ProgramSyntax::BinaryExpression &);
245 struct ConstantConditionEliminator: BlockModifier
247 unsigned scope_level;
249 ExpressionEvaluator::ValueMap variable_values;
251 ConstantConditionEliminator();
253 using Visitor::visit;
254 virtual void visit(ProgramSyntax::Block &);
255 virtual void visit(ProgramSyntax::UnaryExpression &);
256 virtual void visit(ProgramSyntax::Assignment &);
257 virtual void visit(ProgramSyntax::VariableDeclaration &);
258 virtual void visit(ProgramSyntax::Conditional &);
259 virtual void visit(ProgramSyntax::Iteration &);
262 struct UnusedVariableLocator: Visitor
267 std::vector<ProgramSyntax::Node *> assignments;
268 bool conditionally_assigned;
274 typedef std::set<ProgramSyntax::Node *> ResultType;
275 typedef std::map<ProgramSyntax::VariableDeclaration *, VariableInfo> BlockVariableMap;
277 std::set<ProgramSyntax::Node *> unused_nodes;
278 std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Node *> aggregates;
279 ProgramSyntax::Node *aggregate;
280 std::vector<BlockVariableMap> variables;
281 ProgramSyntax::Assignment *assignment;
282 bool assignment_target;
283 bool assign_to_subscript;
286 UnusedVariableLocator();
288 virtual void apply(ProgramSyntax::Stage &);
289 const ResultType &get_result() const { return unused_nodes; }
290 using Visitor::visit;
291 virtual void visit(ProgramSyntax::VariableReference &);
292 virtual void visit(ProgramSyntax::MemberAccess &);
293 virtual void visit(ProgramSyntax::BinaryExpression &);
294 virtual void visit(ProgramSyntax::Assignment &);
295 void record_assignment(ProgramSyntax::VariableDeclaration &, ProgramSyntax::Node &, bool);
296 void clear_assignments(VariableInfo &, bool);
297 virtual void visit(ProgramSyntax::ExpressionStatement &);
298 virtual void visit(ProgramSyntax::StructDeclaration &);
299 virtual void visit(ProgramSyntax::VariableDeclaration &);
300 virtual void visit(ProgramSyntax::InterfaceBlock &);
301 virtual void visit(ProgramSyntax::FunctionDeclaration &);
302 void merge_down_variables();
303 virtual void visit(ProgramSyntax::Conditional &);
304 virtual void visit(ProgramSyntax::Iteration &);
307 struct UnusedFunctionLocator: Visitor
309 typedef std::set<ProgramSyntax::Node *> ResultType;
311 std::set<ProgramSyntax::Node *> unused_nodes;
312 std::set<ProgramSyntax::FunctionDeclaration *> used_definitions;
314 const ResultType &get_result() const { return unused_nodes; }
315 using Visitor::visit;
316 virtual void visit(ProgramSyntax::FunctionCall &);
317 virtual void visit(ProgramSyntax::FunctionDeclaration &);
320 struct NodeRemover: Visitor
322 std::set<ProgramSyntax::Node *> to_remove;
325 NodeRemover(const std::set<ProgramSyntax::Node *> &);
327 using Visitor::visit;
328 virtual void visit(ProgramSyntax::Block &);
329 virtual void visit(ProgramSyntax::VariableDeclaration &);
330 virtual void visit(ProgramSyntax::Iteration &);
333 struct PrecisionRemover: BlockModifier
335 using Visitor::visit;
336 virtual void visit(ProgramSyntax::Precision &);
337 virtual void visit(ProgramSyntax::VariableDeclaration &);
340 struct DefaultPrecisionGenerator: BlockModifier
343 std::set<std::string> have_default;
345 DefaultPrecisionGenerator();
347 using Visitor::visit;
348 virtual void visit(ProgramSyntax::Block &);
349 virtual void visit(ProgramSyntax::Precision &);
350 virtual void visit(ProgramSyntax::VariableDeclaration &);
353 struct LegacyConverter: BlockModifier
356 Version target_version;
358 ProgramSyntax::VariableDeclaration *frag_out;
361 LegacyConverter(const Version &);
363 bool check_version(const Version &) const;
364 bool check_extension(const Extension &) const;
365 using Visitor::visit;
366 bool supports_unified_interface_syntax() const;
367 virtual void visit(ProgramSyntax::VariableReference &);
368 virtual void visit(ProgramSyntax::Assignment &);
369 bool supports_unified_sampling_functions() const;
370 virtual void visit(ProgramSyntax::FunctionCall &);
371 bool supports_interface_layouts() const;
372 bool supports_centroid_sampling() const;
373 bool supports_sample_sampling() const;
374 virtual void visit(ProgramSyntax::VariableDeclaration &);
375 bool supports_interface_blocks(const std::string &) const;
376 virtual void visit(ProgramSyntax::InterfaceBlock &);
379 Resources *resources;
380 ProgramSyntax::Module *module;
381 std::set<std::string> imported_names;
387 void compile(const std::string &, const std::string & = "<string>");
388 void compile(IO::Base &, Resources * = 0, const std::string & = "<file>");
389 void compile(IO::Base &, const std::string &);
390 void add_shaders(Program &);
393 static ProgramSyntax::Module *create_builtins_module();
394 static ProgramSyntax::Module &get_builtins_module();
395 static ProgramSyntax::Stage *get_builtins(ProgramSyntax::StageType);
396 void append_module(ProgramSyntax::Module &);
397 void append_stage(ProgramSyntax::Stage &);
399 void import(const std::string &);
400 void generate(ProgramSyntax::Stage &);
401 bool optimize(ProgramSyntax::Stage &);
402 void finalize(ProgramSyntax::Stage &);
403 static void inject_block(ProgramSyntax::Block &, const ProgramSyntax::Block &);
405 static typename T::ResultType apply(ProgramSyntax::Stage &);
406 template<typename T, typename A>
407 static typename T::ResultType apply(ProgramSyntax::Stage &, const A &);