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::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::vector<T *> ResultType;
86 std::vector<T *> nodes;
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 DeclarationReorderer: Visitor
172 DeclarationKind kind;
174 DeclarationReorderer();
176 using Visitor::visit;
177 virtual void visit(ProgramSyntax::Block &);
178 virtual void visit(ProgramSyntax::InterfaceLayout &) { kind = LAYOUT; }
179 virtual void visit(ProgramSyntax::StructDeclaration &) { kind = STRUCT; }
180 virtual void visit(ProgramSyntax::VariableDeclaration &) { kind = VARIABLE; }
181 virtual void visit(ProgramSyntax::InterfaceBlock &) { kind = VARIABLE; }
182 virtual void visit(ProgramSyntax::FunctionDeclaration &) { kind = FUNCTION; }
185 struct InlineableFunctionLocator: Visitor
187 typedef std::set<ProgramSyntax::FunctionDeclaration *> ResultType;
189 std::map<ProgramSyntax::FunctionDeclaration *, unsigned> refcounts;
190 std::set<ProgramSyntax::FunctionDeclaration *> inlineable;
191 ProgramSyntax::FunctionDeclaration *in_function;
193 InlineableFunctionLocator();
195 const ResultType &get_result() const { return inlineable; }
196 using Visitor::visit;
197 virtual void visit(ProgramSyntax::FunctionCall &);
198 virtual void visit(ProgramSyntax::FunctionDeclaration &);
201 struct FunctionInliner: Visitor
203 std::set<ProgramSyntax::FunctionDeclaration *> inlineable;
204 unsigned extract_result;
205 RefPtr<ProgramSyntax::Expression> inline_result;
208 FunctionInliner(const std::set<ProgramSyntax::FunctionDeclaration *> &);
210 void visit_and_inline(RefPtr<ProgramSyntax::Expression> &);
211 using Visitor::visit;
212 virtual void visit(ProgramSyntax::Block &);
213 virtual void visit(ProgramSyntax::UnaryExpression &);
214 virtual void visit(ProgramSyntax::BinaryExpression &);
215 virtual void visit(ProgramSyntax::FunctionCall &);
216 virtual void visit(ProgramSyntax::Return &);
219 struct ExpressionEvaluator: ProgramSyntax::NodeVisitor
221 typedef std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Expression *> ValueMap;
223 const ValueMap *variable_values;
227 ExpressionEvaluator();
228 ExpressionEvaluator(const ValueMap &);
230 using ProgramSyntax::NodeVisitor::visit;
231 virtual void visit(ProgramSyntax::Literal &);
232 virtual void visit(ProgramSyntax::ParenthesizedExpression &);
233 virtual void visit(ProgramSyntax::VariableReference &);
234 virtual void visit(ProgramSyntax::UnaryExpression &);
235 virtual void visit(ProgramSyntax::BinaryExpression &);
238 struct ConstantConditionEliminator: BlockModifier
240 unsigned scope_level;
241 ExpressionEvaluator::ValueMap variable_values;
243 ConstantConditionEliminator();
245 using Visitor::visit;
246 virtual void visit(ProgramSyntax::Block &);
247 virtual void visit(ProgramSyntax::Assignment &);
248 virtual void visit(ProgramSyntax::VariableDeclaration &);
249 virtual void visit(ProgramSyntax::Conditional &);
250 virtual void visit(ProgramSyntax::Iteration &);
253 struct UnusedVariableLocator: Visitor
258 std::vector<ProgramSyntax::Node *> assignments;
259 bool conditionally_assigned;
265 typedef std::set<ProgramSyntax::Node *> ResultType;
266 typedef std::map<ProgramSyntax::VariableDeclaration *, VariableInfo> BlockVariableMap;
268 std::set<ProgramSyntax::Node *> unused_nodes;
269 std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Node *> aggregates;
270 ProgramSyntax::Node *aggregate;
271 std::vector<BlockVariableMap> variables;
272 ProgramSyntax::Assignment *assignment;
273 bool assignment_target;
276 UnusedVariableLocator();
278 virtual void apply(ProgramSyntax::Stage &);
279 const ResultType &get_result() const { return unused_nodes; }
280 using Visitor::visit;
281 virtual void visit(ProgramSyntax::VariableReference &);
282 virtual void visit(ProgramSyntax::MemberAccess &);
283 virtual void visit(ProgramSyntax::BinaryExpression &);
284 virtual void visit(ProgramSyntax::Assignment &);
285 void record_assignment(ProgramSyntax::VariableDeclaration &, ProgramSyntax::Node &, bool);
286 void clear_assignments(VariableInfo &, bool);
287 virtual void visit(ProgramSyntax::ExpressionStatement &);
288 virtual void visit(ProgramSyntax::StructDeclaration &);
289 virtual void visit(ProgramSyntax::VariableDeclaration &);
290 virtual void visit(ProgramSyntax::InterfaceBlock &);
291 virtual void visit(ProgramSyntax::FunctionDeclaration &);
292 void merge_down_variables();
293 virtual void visit(ProgramSyntax::Conditional &);
294 virtual void visit(ProgramSyntax::Iteration &);
297 struct UnusedFunctionLocator: Visitor
299 typedef std::set<ProgramSyntax::Node *> ResultType;
301 std::set<ProgramSyntax::Node *> unused_nodes;
302 std::set<ProgramSyntax::FunctionDeclaration *> used_definitions;
304 const ResultType &get_result() const { return unused_nodes; }
305 using Visitor::visit;
306 virtual void visit(ProgramSyntax::FunctionCall &);
307 virtual void visit(ProgramSyntax::FunctionDeclaration &);
310 struct NodeRemover: Visitor
312 std::set<ProgramSyntax::Node *> to_remove;
315 NodeRemover(const std::set<ProgramSyntax::Node *> &);
317 using Visitor::visit;
318 virtual void visit(ProgramSyntax::Block &);
319 virtual void visit(ProgramSyntax::VariableDeclaration &);
322 struct PrecisionRemover: BlockModifier
324 using Visitor::visit;
325 virtual void visit(ProgramSyntax::Precision &);
326 virtual void visit(ProgramSyntax::VariableDeclaration &);
329 struct DefaultPrecisionGenerator: BlockModifier
332 std::set<std::string> have_default;
334 DefaultPrecisionGenerator();
336 using Visitor::visit;
337 virtual void visit(ProgramSyntax::Block &);
338 virtual void visit(ProgramSyntax::Precision &);
339 virtual void visit(ProgramSyntax::VariableDeclaration &);
342 struct LegacyConverter: BlockModifier
345 Version target_version;
347 ProgramSyntax::VariableDeclaration *frag_out;
350 LegacyConverter(const Version &);
352 bool check_version(const Version &) const;
353 using Visitor::visit;
354 bool supports_unified_interface_syntax() const;
355 virtual void visit(ProgramSyntax::VariableReference &);
356 virtual void visit(ProgramSyntax::Assignment &);
357 bool supports_unified_sampling_functions() const;
358 virtual void visit(ProgramSyntax::FunctionCall &);
359 bool supports_interface_layouts() const;
360 virtual void visit(ProgramSyntax::VariableDeclaration &);
361 bool supports_interface_blocks(const std::string &) const;
362 virtual void visit(ProgramSyntax::InterfaceBlock &);
365 Resources *resources;
366 ProgramSyntax::Module *module;
367 std::set<std::string> imported_names;
373 void compile(const std::string &, const std::string & = "<string>");
374 void compile(IO::Base &, Resources * = 0, const std::string & = "<file>");
375 void compile(IO::Base &, const std::string &);
376 void add_shaders(Program &);
379 static ProgramSyntax::Module *create_builtins_module();
380 static ProgramSyntax::Module &get_builtins_module();
381 static ProgramSyntax::Stage *get_builtins(ProgramSyntax::StageType);
382 void append_module(ProgramSyntax::Module &);
383 void append_stage(ProgramSyntax::Stage &);
385 void import(const std::string &);
386 void generate(ProgramSyntax::Stage &);
387 bool optimize(ProgramSyntax::Stage &);
388 void finalize(ProgramSyntax::Stage &);
389 static void inject_block(ProgramSyntax::Block &, const ProgramSyntax::Block &);
391 static typename T::ResultType apply(ProgramSyntax::Stage &);
392 template<typename T, typename A>
393 static typename T::ResultType apply(ProgramSyntax::Stage &, const A &);