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 Formatter: Visitor
31 typedef std::string ResultType;
33 std::string formatted;
37 std::string block_interface;
41 virtual void apply(ProgramSyntax::Stage &);
42 const std::string &get_result() const { return formatted; }
43 virtual void visit(ProgramSyntax::Block &);
44 virtual void visit(ProgramSyntax::Literal &);
45 virtual void visit(ProgramSyntax::ParenthesizedExpression &);
46 virtual void visit(ProgramSyntax::VariableReference &);
47 virtual void visit(ProgramSyntax::MemberAccess &);
48 virtual void visit(ProgramSyntax::UnaryExpression &);
49 virtual void visit(ProgramSyntax::BinaryExpression &);
50 virtual void visit(ProgramSyntax::Assignment &);
51 virtual void visit(ProgramSyntax::FunctionCall &);
52 virtual void visit(ProgramSyntax::ExpressionStatement &);
53 virtual void visit(ProgramSyntax::Import &);
54 virtual void visit(ProgramSyntax::Layout &);
55 virtual void visit(ProgramSyntax::InterfaceLayout &);
56 virtual void visit(ProgramSyntax::StructDeclaration &);
57 virtual void visit(ProgramSyntax::VariableDeclaration &);
58 virtual void visit(ProgramSyntax::InterfaceBlock &);
59 virtual void visit(ProgramSyntax::FunctionDeclaration &);
60 virtual void visit(ProgramSyntax::Conditional &);
61 virtual void visit(ProgramSyntax::Iteration &);
62 virtual void visit(ProgramSyntax::Return &);
63 virtual void visit(ProgramSyntax::Jump &);
67 struct NodeGatherer: Visitor
69 typedef std::list<T *> ResultType;
73 const ResultType &get_result() const { return nodes; }
74 virtual void visit(T &n) { nodes.push_back(&n); }
77 struct DeclarationCombiner: Visitor
80 std::map<std::string, std::vector<ProgramSyntax::FunctionDeclaration *> > functions;
81 std::map<std::string, ProgramSyntax::VariableDeclaration *> variables;
84 DeclarationCombiner();
86 virtual void visit(ProgramSyntax::Block &);
87 virtual void visit(ProgramSyntax::FunctionDeclaration &);
88 virtual void visit(ProgramSyntax::VariableDeclaration &);
91 struct VariableResolver: Visitor
93 std::vector<ProgramSyntax::Block *> blocks;
94 ProgramSyntax::StructDeclaration *type;
96 std::string block_interface;
98 ProgramSyntax::VariableDeclaration *assignment_target;
99 bool self_referencing;
103 virtual void apply(ProgramSyntax::Stage &);
104 virtual void visit(ProgramSyntax::Block &);
105 virtual void visit(ProgramSyntax::VariableReference &);
106 virtual void visit(ProgramSyntax::MemberAccess &);
107 virtual void visit(ProgramSyntax::BinaryExpression &);
108 virtual void visit(ProgramSyntax::Assignment &);
109 virtual void visit(ProgramSyntax::StructDeclaration &);
110 virtual void visit(ProgramSyntax::VariableDeclaration &);
111 virtual void visit(ProgramSyntax::InterfaceBlock &);
114 struct FunctionResolver: Visitor
116 std::map<std::string, std::vector<ProgramSyntax::FunctionDeclaration *> > functions;
118 virtual void visit(ProgramSyntax::FunctionCall &);
119 virtual void visit(ProgramSyntax::FunctionDeclaration &);
122 struct BlockModifier: Visitor
125 std::list<RefPtr<ProgramSyntax::Node> > insert_nodes;
129 void flatten_block(ProgramSyntax::Block &);
130 void apply_and_increment(ProgramSyntax::Block &, std::list<RefPtr<ProgramSyntax::Node> >::iterator &);
131 virtual void visit(ProgramSyntax::Block &);
134 struct InterfaceGenerator: BlockModifier
136 std::string in_prefix;
137 std::string out_prefix;
138 unsigned scope_level;
139 std::map<std::string, RefPtr<ProgramSyntax::VariableDeclaration> > iface_declarations;
141 InterfaceGenerator();
143 static std::string get_out_prefix(ProgramSyntax::StageType);
144 virtual void apply(ProgramSyntax::Stage &);
145 virtual void visit(ProgramSyntax::Block &);
146 std::string change_prefix(const std::string &, const std::string &) const;
147 bool generate_interface(ProgramSyntax::VariableDeclaration &, const std::string &, const std::string &);
148 void insert_assignment(const std::string &, ProgramSyntax::Expression *);
149 virtual void visit(ProgramSyntax::VariableReference &);
150 virtual void visit(ProgramSyntax::VariableDeclaration &);
151 virtual void visit(ProgramSyntax::Passthrough &);
154 struct VariableRenamer: Visitor
156 virtual void visit(ProgramSyntax::VariableReference &);
157 virtual void visit(ProgramSyntax::VariableDeclaration &);
160 struct DeclarationReorderer: Visitor
171 DeclarationKind kind;
173 DeclarationReorderer();
175 virtual void visit(ProgramSyntax::Block &);
176 virtual void visit(ProgramSyntax::InterfaceLayout &) { kind = LAYOUT; }
177 virtual void visit(ProgramSyntax::StructDeclaration &) { kind = STRUCT; }
178 virtual void visit(ProgramSyntax::VariableDeclaration &) { kind = VARIABLE; }
179 virtual void visit(ProgramSyntax::InterfaceBlock &) { kind = VARIABLE; }
180 virtual void visit(ProgramSyntax::FunctionDeclaration &) { kind = FUNCTION; }
183 struct InlineableFunctionLocator: Visitor
185 typedef std::set<ProgramSyntax::FunctionDeclaration *> ResultType;
187 std::map<ProgramSyntax::FunctionDeclaration *, unsigned> refcounts;
188 std::set<ProgramSyntax::FunctionDeclaration *> inlineable;
189 ProgramSyntax::FunctionDeclaration *in_function;
191 InlineableFunctionLocator();
193 const ResultType &get_result() const { return inlineable; }
194 virtual void visit(ProgramSyntax::FunctionCall &);
195 virtual void visit(ProgramSyntax::FunctionDeclaration &);
198 struct FunctionInliner: Visitor
200 std::set<ProgramSyntax::FunctionDeclaration *> inlineable;
201 unsigned extract_result;
202 RefPtr<ProgramSyntax::Expression> inline_result;
205 FunctionInliner(const std::set<ProgramSyntax::FunctionDeclaration *> &);
207 void visit_and_inline(RefPtr<ProgramSyntax::Expression> &);
208 virtual void visit(ProgramSyntax::Block &);
209 virtual void visit(ProgramSyntax::UnaryExpression &);
210 virtual void visit(ProgramSyntax::BinaryExpression &);
211 virtual void visit(ProgramSyntax::FunctionCall &);
212 virtual void visit(ProgramSyntax::Return &);
215 struct ExpressionEvaluator: ProgramSyntax::NodeVisitor
217 typedef std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Expression *> ValueMap;
219 const ValueMap *variable_values;
223 ExpressionEvaluator();
224 ExpressionEvaluator(const ValueMap &);
226 virtual void visit(ProgramSyntax::Literal &);
227 virtual void visit(ProgramSyntax::ParenthesizedExpression &);
228 virtual void visit(ProgramSyntax::VariableReference &);
229 virtual void visit(ProgramSyntax::UnaryExpression &);
230 virtual void visit(ProgramSyntax::BinaryExpression &);
233 struct ConstantConditionEliminator: BlockModifier
235 unsigned scope_level;
236 ExpressionEvaluator::ValueMap variable_values;
238 ConstantConditionEliminator();
240 virtual void visit(ProgramSyntax::Block &);
241 virtual void visit(ProgramSyntax::Assignment &);
242 virtual void visit(ProgramSyntax::VariableDeclaration &);
243 virtual void visit(ProgramSyntax::Conditional &);
244 virtual void visit(ProgramSyntax::Iteration &);
247 struct UnusedVariableLocator: Visitor
252 std::vector<ProgramSyntax::Node *> assignments;
253 bool conditionally_assigned;
259 typedef std::set<ProgramSyntax::Node *> ResultType;
260 typedef std::map<ProgramSyntax::VariableDeclaration *, VariableInfo> BlockVariableMap;
262 std::set<ProgramSyntax::Node *> unused_nodes;
263 std::map<ProgramSyntax::VariableDeclaration *, ProgramSyntax::Node *> aggregates;
264 ProgramSyntax::Node *aggregate;
265 std::vector<BlockVariableMap> variables;
266 ProgramSyntax::Assignment *assignment;
267 bool assignment_target;
270 UnusedVariableLocator();
272 virtual void apply(ProgramSyntax::Stage &);
273 const ResultType &get_result() const { return unused_nodes; }
274 virtual void visit(ProgramSyntax::VariableReference &);
275 virtual void visit(ProgramSyntax::MemberAccess &);
276 virtual void visit(ProgramSyntax::BinaryExpression &);
277 virtual void visit(ProgramSyntax::Assignment &);
278 void record_assignment(ProgramSyntax::VariableDeclaration &, ProgramSyntax::Node &, bool);
279 void clear_assignments(VariableInfo &, bool);
280 virtual void visit(ProgramSyntax::ExpressionStatement &);
281 virtual void visit(ProgramSyntax::StructDeclaration &);
282 virtual void visit(ProgramSyntax::VariableDeclaration &);
283 virtual void visit(ProgramSyntax::InterfaceBlock &);
284 virtual void visit(ProgramSyntax::FunctionDeclaration &);
285 void merge_down_variables();
286 virtual void visit(ProgramSyntax::Conditional &);
287 virtual void visit(ProgramSyntax::Iteration &);
290 struct UnusedFunctionLocator: Visitor
292 typedef std::set<ProgramSyntax::Node *> ResultType;
294 std::set<ProgramSyntax::Node *> unused_nodes;
295 std::set<ProgramSyntax::FunctionDeclaration *> used_definitions;
297 const ResultType &get_result() const { return unused_nodes; }
298 virtual void visit(ProgramSyntax::FunctionCall &);
299 virtual void visit(ProgramSyntax::FunctionDeclaration &);
302 struct NodeRemover: Visitor
304 std::set<ProgramSyntax::Node *> to_remove;
307 NodeRemover(const std::set<ProgramSyntax::Node *> &);
309 virtual void visit(ProgramSyntax::Block &);
310 virtual void visit(ProgramSyntax::VariableDeclaration &);
313 struct LegacyConverter: BlockModifier
315 Version target_version;
317 std::string frag_out_name;
320 LegacyConverter(const Version &);
322 bool check_version(const Version &);
323 virtual void visit(ProgramSyntax::VariableReference &);
324 virtual void visit(ProgramSyntax::FunctionCall &);
325 virtual void visit(ProgramSyntax::VariableDeclaration &);
326 virtual void visit(ProgramSyntax::InterfaceBlock &);
329 Resources *resources;
330 ProgramParser parser;
331 ProgramSyntax::Module *module;
336 void compile(const std::string &);
337 void compile(IO::Base &, Resources * = 0);
338 void add_shaders(Program &);
341 static ProgramSyntax::Module *create_builtins_module();
342 static ProgramSyntax::Module &get_builtins_module();
343 static ProgramSyntax::Stage *get_builtins(ProgramSyntax::StageType);
345 void import(const std::string &);
346 void generate(ProgramSyntax::Stage &);
347 bool optimize(ProgramSyntax::Stage &);
348 static void inject_block(ProgramSyntax::Block &, const ProgramSyntax::Block &);
350 static typename T::ResultType apply(ProgramSyntax::Stage &);
351 template<typename T, typename A>
352 static typename T::ResultType apply(ProgramSyntax::Stage &, const A &);