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 unsigned scope_level;
173 DeclarationKind kind;
174 std::set<ProgramSyntax::Node *> ordered_funcs;
175 std::set<ProgramSyntax::Node *> needed_funcs;
177 DeclarationReorderer();
179 using Visitor::visit;
180 virtual void visit(ProgramSyntax::Block &);
181 virtual void visit(ProgramSyntax::FunctionCall &);
182 virtual void visit(ProgramSyntax::InterfaceLayout &) { kind = LAYOUT; }
183 virtual void visit(ProgramSyntax::StructDeclaration &) { kind = STRUCT; }
184 virtual void visit(ProgramSyntax::VariableDeclaration &);
185 virtual void visit(ProgramSyntax::InterfaceBlock &) { kind = VARIABLE; }
186 virtual void visit(ProgramSyntax::FunctionDeclaration &);
189 struct InlineableFunctionLocator: Visitor
191 typedef std::set<ProgramSyntax::FunctionDeclaration *> ResultType;
193 std::map<ProgramSyntax::FunctionDeclaration *, unsigned> refcounts;
194 std::set<ProgramSyntax::FunctionDeclaration *> inlineable;
195 ProgramSyntax::FunctionDeclaration *in_function;
197 InlineableFunctionLocator();
199 const ResultType &get_result() const { return inlineable; }
200 using Visitor::visit;
201 virtual void visit(ProgramSyntax::FunctionCall &);
202 virtual void visit(ProgramSyntax::FunctionDeclaration &);
205 struct FunctionInliner: Visitor
207 std::set<ProgramSyntax::FunctionDeclaration *> inlineable;
208 unsigned extract_result;
209 RefPtr<ProgramSyntax::Expression> inline_result;
212 FunctionInliner(const std::set<ProgramSyntax::FunctionDeclaration *> &);
214 void visit_and_inline(RefPtr<ProgramSyntax::Expression> &);
215 using Visitor::visit;
216 virtual void visit(ProgramSyntax::Block &);
217 virtual void visit(ProgramSyntax::UnaryExpression &);
218 virtual void visit(ProgramSyntax::BinaryExpression &);
219 virtual void visit(ProgramSyntax::FunctionCall &);
220 virtual void visit(ProgramSyntax::Return &);
223 struct ExpressionEvaluator: ProgramSyntax::NodeVisitor
225 typedef std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Expression *> ValueMap;
227 const ValueMap *variable_values;
231 ExpressionEvaluator();
232 ExpressionEvaluator(const ValueMap &);
234 using ProgramSyntax::NodeVisitor::visit;
235 virtual void visit(ProgramSyntax::Literal &);
236 virtual void visit(ProgramSyntax::ParenthesizedExpression &);
237 virtual void visit(ProgramSyntax::VariableReference &);
238 virtual void visit(ProgramSyntax::UnaryExpression &);
239 virtual void visit(ProgramSyntax::BinaryExpression &);
242 struct ConstantConditionEliminator: BlockModifier
244 unsigned scope_level;
245 ExpressionEvaluator::ValueMap variable_values;
247 ConstantConditionEliminator();
249 using Visitor::visit;
250 virtual void visit(ProgramSyntax::Block &);
251 virtual void visit(ProgramSyntax::Assignment &);
252 virtual void visit(ProgramSyntax::VariableDeclaration &);
253 virtual void visit(ProgramSyntax::Conditional &);
254 virtual void visit(ProgramSyntax::Iteration &);
257 struct UnusedVariableLocator: Visitor
262 std::vector<ProgramSyntax::Node *> assignments;
263 bool conditionally_assigned;
269 typedef std::set<ProgramSyntax::Node *> ResultType;
270 typedef std::map<ProgramSyntax::VariableDeclaration *, VariableInfo> BlockVariableMap;
272 std::set<ProgramSyntax::Node *> unused_nodes;
273 std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Node *> aggregates;
274 ProgramSyntax::Node *aggregate;
275 std::vector<BlockVariableMap> variables;
276 ProgramSyntax::Assignment *assignment;
277 bool assignment_target;
280 UnusedVariableLocator();
282 virtual void apply(ProgramSyntax::Stage &);
283 const ResultType &get_result() const { return unused_nodes; }
284 using Visitor::visit;
285 virtual void visit(ProgramSyntax::VariableReference &);
286 virtual void visit(ProgramSyntax::MemberAccess &);
287 virtual void visit(ProgramSyntax::BinaryExpression &);
288 virtual void visit(ProgramSyntax::Assignment &);
289 void record_assignment(ProgramSyntax::VariableDeclaration &, ProgramSyntax::Node &, bool);
290 void clear_assignments(VariableInfo &, bool);
291 virtual void visit(ProgramSyntax::ExpressionStatement &);
292 virtual void visit(ProgramSyntax::StructDeclaration &);
293 virtual void visit(ProgramSyntax::VariableDeclaration &);
294 virtual void visit(ProgramSyntax::InterfaceBlock &);
295 virtual void visit(ProgramSyntax::FunctionDeclaration &);
296 void merge_down_variables();
297 virtual void visit(ProgramSyntax::Conditional &);
298 virtual void visit(ProgramSyntax::Iteration &);
301 struct UnusedFunctionLocator: Visitor
303 typedef std::set<ProgramSyntax::Node *> ResultType;
305 std::set<ProgramSyntax::Node *> unused_nodes;
306 std::set<ProgramSyntax::FunctionDeclaration *> used_definitions;
308 const ResultType &get_result() const { return unused_nodes; }
309 using Visitor::visit;
310 virtual void visit(ProgramSyntax::FunctionCall &);
311 virtual void visit(ProgramSyntax::FunctionDeclaration &);
314 struct NodeRemover: Visitor
316 std::set<ProgramSyntax::Node *> to_remove;
319 NodeRemover(const std::set<ProgramSyntax::Node *> &);
321 using Visitor::visit;
322 virtual void visit(ProgramSyntax::Block &);
323 virtual void visit(ProgramSyntax::VariableDeclaration &);
326 struct PrecisionRemover: BlockModifier
328 using Visitor::visit;
329 virtual void visit(ProgramSyntax::Precision &);
330 virtual void visit(ProgramSyntax::VariableDeclaration &);
333 struct DefaultPrecisionGenerator: BlockModifier
336 std::set<std::string> have_default;
338 DefaultPrecisionGenerator();
340 using Visitor::visit;
341 virtual void visit(ProgramSyntax::Block &);
342 virtual void visit(ProgramSyntax::Precision &);
343 virtual void visit(ProgramSyntax::VariableDeclaration &);
346 struct LegacyConverter: BlockModifier
349 Version target_version;
351 ProgramSyntax::VariableDeclaration *frag_out;
354 LegacyConverter(const Version &);
356 bool check_version(const Version &) const;
357 using Visitor::visit;
358 bool supports_unified_interface_syntax() const;
359 virtual void visit(ProgramSyntax::VariableReference &);
360 virtual void visit(ProgramSyntax::Assignment &);
361 bool supports_unified_sampling_functions() const;
362 virtual void visit(ProgramSyntax::FunctionCall &);
363 bool supports_interface_layouts() const;
364 virtual void visit(ProgramSyntax::VariableDeclaration &);
365 bool supports_interface_blocks(const std::string &) const;
366 virtual void visit(ProgramSyntax::InterfaceBlock &);
369 Resources *resources;
370 ProgramSyntax::Module *module;
371 std::set<std::string> imported_names;
377 void compile(const std::string &, const std::string & = "<string>");
378 void compile(IO::Base &, Resources * = 0, const std::string & = "<file>");
379 void compile(IO::Base &, const std::string &);
380 void add_shaders(Program &);
383 static ProgramSyntax::Module *create_builtins_module();
384 static ProgramSyntax::Module &get_builtins_module();
385 static ProgramSyntax::Stage *get_builtins(ProgramSyntax::StageType);
386 void append_module(ProgramSyntax::Module &);
387 void append_stage(ProgramSyntax::Stage &);
389 void import(const std::string &);
390 void generate(ProgramSyntax::Stage &);
391 bool optimize(ProgramSyntax::Stage &);
392 void finalize(ProgramSyntax::Stage &);
393 static void inject_block(ProgramSyntax::Block &, const ProgramSyntax::Block &);
395 static typename T::ResultType apply(ProgramSyntax::Stage &);
396 template<typename T, typename A>
397 static typename T::ResultType apply(ProgramSyntax::Stage &, const A &);