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::list<RefPtr<ProgramSyntax::Node> > insert_nodes;
36 void flatten_block(ProgramSyntax::Block &);
37 void apply_and_increment(ProgramSyntax::Block &, std::list<RefPtr<ProgramSyntax::Node> >::iterator &);
39 virtual void visit(ProgramSyntax::Block &);
42 struct Formatter: Visitor
44 typedef std::string ResultType;
46 std::string formatted;
50 std::string block_interface;
54 virtual void apply(ProgramSyntax::Stage &);
55 const std::string &get_result() const { return formatted; }
57 virtual void visit(ProgramSyntax::Block &);
58 virtual void visit(ProgramSyntax::Literal &);
59 virtual void visit(ProgramSyntax::ParenthesizedExpression &);
60 virtual void visit(ProgramSyntax::VariableReference &);
61 virtual void visit(ProgramSyntax::MemberAccess &);
62 virtual void visit(ProgramSyntax::UnaryExpression &);
63 virtual void visit(ProgramSyntax::BinaryExpression &);
64 virtual void visit(ProgramSyntax::Assignment &);
65 virtual void visit(ProgramSyntax::FunctionCall &);
66 virtual void visit(ProgramSyntax::ExpressionStatement &);
67 virtual void visit(ProgramSyntax::Import &);
68 virtual void visit(ProgramSyntax::Precision &);
69 virtual void visit(ProgramSyntax::Layout &);
70 virtual void visit(ProgramSyntax::InterfaceLayout &);
71 virtual void visit(ProgramSyntax::StructDeclaration &);
72 virtual void visit(ProgramSyntax::VariableDeclaration &);
73 virtual void visit(ProgramSyntax::InterfaceBlock &);
74 virtual void visit(ProgramSyntax::FunctionDeclaration &);
75 virtual void visit(ProgramSyntax::Conditional &);
76 virtual void visit(ProgramSyntax::Iteration &);
77 virtual void visit(ProgramSyntax::Return &);
78 virtual void visit(ProgramSyntax::Jump &);
82 struct NodeGatherer: Visitor
84 typedef std::list<T *> ResultType;
88 const ResultType &get_result() const { return nodes; }
90 virtual void visit(T &n) { nodes.push_back(&n); }
93 struct DeclarationCombiner: BlockModifier
96 std::map<std::string, std::vector<ProgramSyntax::FunctionDeclaration *> > functions;
97 std::map<std::string, ProgramSyntax::VariableDeclaration *> variables;
99 DeclarationCombiner();
101 using Visitor::visit;
102 virtual void visit(ProgramSyntax::Block &);
103 virtual void visit(ProgramSyntax::FunctionDeclaration &);
104 virtual void visit(ProgramSyntax::VariableDeclaration &);
107 struct VariableResolver: Visitor
109 std::vector<ProgramSyntax::Block *> blocks;
110 ProgramSyntax::StructDeclaration *type;
112 std::string block_interface;
114 ProgramSyntax::VariableDeclaration *assignment_target;
115 bool self_referencing;
119 virtual void apply(ProgramSyntax::Stage &);
120 using Visitor::visit;
121 virtual void visit(ProgramSyntax::Block &);
122 virtual void visit(ProgramSyntax::VariableReference &);
123 virtual void visit(ProgramSyntax::MemberAccess &);
124 virtual void visit(ProgramSyntax::BinaryExpression &);
125 virtual void visit(ProgramSyntax::Assignment &);
126 virtual void visit(ProgramSyntax::StructDeclaration &);
127 virtual void visit(ProgramSyntax::VariableDeclaration &);
128 virtual void visit(ProgramSyntax::InterfaceBlock &);
131 struct FunctionResolver: Visitor
133 std::map<std::string, std::vector<ProgramSyntax::FunctionDeclaration *> > functions;
135 using Visitor::visit;
136 virtual void visit(ProgramSyntax::FunctionCall &);
137 virtual void visit(ProgramSyntax::FunctionDeclaration &);
140 struct InterfaceGenerator: BlockModifier
142 std::string in_prefix;
143 std::string out_prefix;
144 unsigned scope_level;
145 std::map<std::string, RefPtr<ProgramSyntax::VariableDeclaration> > iface_declarations;
147 InterfaceGenerator();
149 static std::string get_out_prefix(ProgramSyntax::StageType);
150 virtual void apply(ProgramSyntax::Stage &);
151 using Visitor::visit;
152 virtual void visit(ProgramSyntax::Block &);
153 std::string change_prefix(const std::string &, const std::string &) const;
154 bool generate_interface(ProgramSyntax::VariableDeclaration &, const std::string &, const std::string &);
155 void insert_assignment(const std::string &, ProgramSyntax::Expression *);
156 virtual void visit(ProgramSyntax::VariableReference &);
157 virtual void visit(ProgramSyntax::VariableDeclaration &);
158 virtual void visit(ProgramSyntax::Passthrough &);
161 struct VariableRenamer: Visitor
163 using Visitor::visit;
164 virtual void visit(ProgramSyntax::VariableReference &);
165 virtual void visit(ProgramSyntax::VariableDeclaration &);
168 struct DeclarationReorderer: Visitor
179 DeclarationKind kind;
181 DeclarationReorderer();
183 using Visitor::visit;
184 virtual void visit(ProgramSyntax::Block &);
185 virtual void visit(ProgramSyntax::InterfaceLayout &) { kind = LAYOUT; }
186 virtual void visit(ProgramSyntax::StructDeclaration &) { kind = STRUCT; }
187 virtual void visit(ProgramSyntax::VariableDeclaration &) { kind = VARIABLE; }
188 virtual void visit(ProgramSyntax::InterfaceBlock &) { kind = VARIABLE; }
189 virtual void visit(ProgramSyntax::FunctionDeclaration &) { kind = FUNCTION; }
192 struct InlineableFunctionLocator: Visitor
194 typedef std::set<ProgramSyntax::FunctionDeclaration *> ResultType;
196 std::map<ProgramSyntax::FunctionDeclaration *, unsigned> refcounts;
197 std::set<ProgramSyntax::FunctionDeclaration *> inlineable;
198 ProgramSyntax::FunctionDeclaration *in_function;
200 InlineableFunctionLocator();
202 const ResultType &get_result() const { return inlineable; }
203 using Visitor::visit;
204 virtual void visit(ProgramSyntax::FunctionCall &);
205 virtual void visit(ProgramSyntax::FunctionDeclaration &);
208 struct FunctionInliner: Visitor
210 std::set<ProgramSyntax::FunctionDeclaration *> inlineable;
211 unsigned extract_result;
212 RefPtr<ProgramSyntax::Expression> inline_result;
215 FunctionInliner(const std::set<ProgramSyntax::FunctionDeclaration *> &);
217 void visit_and_inline(RefPtr<ProgramSyntax::Expression> &);
218 using Visitor::visit;
219 virtual void visit(ProgramSyntax::Block &);
220 virtual void visit(ProgramSyntax::UnaryExpression &);
221 virtual void visit(ProgramSyntax::BinaryExpression &);
222 virtual void visit(ProgramSyntax::FunctionCall &);
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;
248 ExpressionEvaluator::ValueMap variable_values;
250 ConstantConditionEliminator();
252 using Visitor::visit;
253 virtual void visit(ProgramSyntax::Block &);
254 virtual void visit(ProgramSyntax::Assignment &);
255 virtual void visit(ProgramSyntax::VariableDeclaration &);
256 virtual void visit(ProgramSyntax::Conditional &);
257 virtual void visit(ProgramSyntax::Iteration &);
260 struct UnusedVariableLocator: Visitor
265 std::vector<ProgramSyntax::Node *> assignments;
266 bool conditionally_assigned;
272 typedef std::set<ProgramSyntax::Node *> ResultType;
273 typedef std::map<ProgramSyntax::VariableDeclaration *, VariableInfo> BlockVariableMap;
275 std::set<ProgramSyntax::Node *> unused_nodes;
276 std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Node *> aggregates;
277 ProgramSyntax::Node *aggregate;
278 std::vector<BlockVariableMap> variables;
279 ProgramSyntax::Assignment *assignment;
280 bool assignment_target;
283 UnusedVariableLocator();
285 virtual void apply(ProgramSyntax::Stage &);
286 const ResultType &get_result() const { return unused_nodes; }
287 using Visitor::visit;
288 virtual void visit(ProgramSyntax::VariableReference &);
289 virtual void visit(ProgramSyntax::MemberAccess &);
290 virtual void visit(ProgramSyntax::BinaryExpression &);
291 virtual void visit(ProgramSyntax::Assignment &);
292 void record_assignment(ProgramSyntax::VariableDeclaration &, ProgramSyntax::Node &, bool);
293 void clear_assignments(VariableInfo &, bool);
294 virtual void visit(ProgramSyntax::ExpressionStatement &);
295 virtual void visit(ProgramSyntax::StructDeclaration &);
296 virtual void visit(ProgramSyntax::VariableDeclaration &);
297 virtual void visit(ProgramSyntax::InterfaceBlock &);
298 virtual void visit(ProgramSyntax::FunctionDeclaration &);
299 void merge_down_variables();
300 virtual void visit(ProgramSyntax::Conditional &);
301 virtual void visit(ProgramSyntax::Iteration &);
304 struct UnusedFunctionLocator: Visitor
306 typedef std::set<ProgramSyntax::Node *> ResultType;
308 std::set<ProgramSyntax::Node *> unused_nodes;
309 std::set<ProgramSyntax::FunctionDeclaration *> used_definitions;
311 const ResultType &get_result() const { return unused_nodes; }
312 using Visitor::visit;
313 virtual void visit(ProgramSyntax::FunctionCall &);
314 virtual void visit(ProgramSyntax::FunctionDeclaration &);
317 struct NodeRemover: Visitor
319 std::set<ProgramSyntax::Node *> to_remove;
322 NodeRemover(const std::set<ProgramSyntax::Node *> &);
324 using Visitor::visit;
325 virtual void visit(ProgramSyntax::Block &);
326 virtual void visit(ProgramSyntax::VariableDeclaration &);
329 struct PrecisionRemover: BlockModifier
331 using Visitor::visit;
332 virtual void visit(ProgramSyntax::Precision &);
333 virtual void visit(ProgramSyntax::VariableDeclaration &);
336 struct DefaultPrecisionGenerator: BlockModifier
339 std::set<std::string> have_default;
341 DefaultPrecisionGenerator();
343 using Visitor::visit;
344 virtual void visit(ProgramSyntax::Block &);
345 virtual void visit(ProgramSyntax::Precision &);
346 virtual void visit(ProgramSyntax::VariableDeclaration &);
349 struct LegacyConverter: BlockModifier
352 Version target_version;
354 ProgramSyntax::VariableDeclaration *frag_out;
357 LegacyConverter(const Version &);
359 bool check_version(const Version &) const;
360 using Visitor::visit;
361 bool supports_unified_interface_syntax() const;
362 virtual void visit(ProgramSyntax::VariableReference &);
363 virtual void visit(ProgramSyntax::Assignment &);
364 bool supports_unified_sampling_functions() const;
365 virtual void visit(ProgramSyntax::FunctionCall &);
366 bool supports_interface_layouts() const;
367 virtual void visit(ProgramSyntax::VariableDeclaration &);
368 bool supports_interface_blocks(const std::string &) const;
369 virtual void visit(ProgramSyntax::InterfaceBlock &);
372 Resources *resources;
373 ProgramSyntax::Module *module;
374 std::set<std::string> imported_names;
380 void compile(const std::string &, const std::string & = "<string>");
381 void compile(IO::Base &, Resources * = 0, const std::string & = "<file>");
382 void compile(IO::Base &, const std::string &);
383 void add_shaders(Program &);
386 static ProgramSyntax::Module *create_builtins_module();
387 static ProgramSyntax::Module &get_builtins_module();
388 static ProgramSyntax::Stage *get_builtins(ProgramSyntax::StageType);
389 void append_module(ProgramSyntax::Module &);
390 void append_stage(ProgramSyntax::Stage &);
392 void import(const std::string &);
393 void generate(ProgramSyntax::Stage &);
394 bool optimize(ProgramSyntax::Stage &);
395 void finalize(ProgramSyntax::Stage &);
396 static void inject_block(ProgramSyntax::Block &, const ProgramSyntax::Block &);
398 static typename T::ResultType apply(ProgramSyntax::Stage &);
399 template<typename T, typename A>
400 static typename T::ResultType apply(ProgramSyntax::Stage &, const A &);