1 #include <msp/core/algorithm.h>
2 #include <msp/strings/format.h>
3 #include <msp/strings/utils.h>
5 #include "compatibility.h"
10 #include "glsl_error.h"
13 #include "resources.h"
25 features(Features::from_context()),
30 Compiler::Compiler(const Features &f):
41 void Compiler::clear()
44 module = new Module();
45 imported_names.clear();
46 module->source_map.set_name(0, "<generated>");
49 void Compiler::set_source(const string &source, const string &src_name)
53 imported_names.push_back(src_name);
54 append_module(parser.parse(source, src_name, 1), 0);
57 void Compiler::load_source(IO::Base &io, DataFile::Collection *res, const string &src_name)
61 imported_names.push_back(src_name);
62 append_module(parser.parse(io, src_name, 1), res);
65 void Compiler::load_source(IO::Base &io, const string &src_name)
67 load_source(io, 0, src_name);
70 void Compiler::specialize(const map<string, int> &sv)
76 void Compiler::compile(Mode mode)
78 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
82 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
86 throw invalid_shader_source(get_diagnostics());
89 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++n)
91 OptimizeResult result = optimize(*i);
92 if(result==REDO_PREVIOUS)
93 i = module->stages.begin();
94 else if(result!=REDO_STAGE)
97 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
101 string Compiler::get_combined_glsl() const
105 unsigned source_count = module->source_map.get_count();
106 for(unsigned i=1; i<source_count; ++i)
107 glsl += format("#pragma MSP source(%d, \"%s\")\n", i, module->source_map.get_name(i));
108 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
110 glsl += format("#pragma MSP stage(%s)\n", Stage::get_stage_name(i->type));
111 glsl += Formatter().apply(*i);
118 vector<Stage::Type> Compiler::get_stages() const
120 vector<Stage::Type> stage_types;
121 stage_types.reserve(module->stages.size());
122 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
123 stage_types.push_back(i->type);
127 string Compiler::get_stage_glsl(Stage::Type stage_type) const
129 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
130 if(i->type==stage_type)
131 return Formatter().apply(*i);
132 throw key_error(Stage::get_stage_name(stage_type));
135 const map<string, unsigned> &Compiler::get_vertex_attributes() const
137 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
138 if(i->type==Stage::VERTEX)
140 throw invalid_operation("Compiler::get_vertex_attributes");
143 const map<string, unsigned> &Compiler::get_fragment_outputs() const
145 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
146 if(i->type==Stage::FRAGMENT)
148 throw invalid_operation("Compiler::get_fragment_outputs");
151 const SourceMap &Compiler::get_source_map() const
153 return module->source_map;
156 string Compiler::get_stage_debug(Stage::Type stage_type) const
158 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
159 if(i->type==stage_type)
160 return DumpTree().apply(*i);
161 throw key_error(Stage::get_stage_name(stage_type));
164 string Compiler::get_diagnostics() const
167 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
168 for(vector<Diagnostic>::const_iterator j=i->diagnostics.begin(); j!=i->diagnostics.end(); ++j)
169 if(j->source!=INTERNAL_SOURCE)
170 append(combined, "\n", format("%s:%d: %s", module->source_map.get_name(j->source), j->line, j->message));
174 void Compiler::append_module(Module &mod, DataFile::Collection *res)
176 module->source_map.merge_from(mod.source_map);
178 vector<Import *> imports;
179 for(NodeList<Statement>::const_iterator i=mod.shared.content.body.begin(); i!=mod.shared.content.body.end(); ++i)
180 if(Import *imp = dynamic_cast<Import *>(i->get()))
181 imports.push_back(imp);
182 for(vector<Import *>::iterator i=imports.begin(); i!=imports.end(); ++i)
183 import(res, (*i)->module);
184 NodeRemover().apply(mod.shared, set<Node *>(imports.begin(), imports.end()));
186 append_stage(mod.shared);
187 for(list<Stage>::iterator i=mod.stages.begin(); i!=mod.stages.end(); ++i)
191 void Compiler::append_stage(Stage &stage)
194 if(stage.type==Stage::SHARED)
195 target = &module->shared;
198 list<Stage>::iterator i;
199 for(i=module->stages.begin(); (i!=module->stages.end() && i->type<stage.type); ++i) ;
200 if(i==module->stages.end() || i->type>stage.type)
202 list<Stage>::iterator j = module->stages.insert(i, stage.type);
203 if(i!=module->stages.end())
206 if(i!=module->stages.begin())
213 if(stage.required_features.glsl_version>target->required_features.glsl_version)
214 target->required_features.glsl_version = stage.required_features.glsl_version;
215 for(NodeList<Statement>::iterator i=stage.content.body.begin(); i!=stage.content.body.end(); ++i)
216 target->content.body.push_back(*i);
219 void Compiler::import(DataFile::Collection *resources, const string &name)
221 string fn = name+".glsl";
222 if(find(imported_names, fn)!=imported_names.end())
224 imported_names.push_back(fn);
226 RefPtr<IO::Seekable> io = (resources ? resources->open_raw(fn) : Resources::get_builtins().open(fn));
228 throw runtime_error(format("module %s not found", name));
229 Parser import_parser;
230 append_module(import_parser.parse(*io, fn, module->source_map.get_count()), resources);
233 void Compiler::generate(Stage &stage, Mode mode)
235 stage.required_features.gl_api = features.gl_api;
236 if(module->shared.required_features.glsl_version>stage.required_features.glsl_version)
237 stage.required_features.glsl_version = module->shared.required_features.glsl_version;
239 inject_block(stage.content, module->shared.content);
240 if(const Stage *builtins = get_builtins(stage.type))
241 inject_block(stage.content, builtins->content);
242 if(const Stage *builtins = get_builtins(Stage::SHARED))
243 inject_block(stage.content, builtins->content);
245 // Initial resolving pass
248 /* All variables local to a stage have been resolved. Resolve non-local
249 variables through interfaces. */
250 InterfaceGenerator().apply(stage);
251 resolve(stage, RESOLVE_BLOCKS|RESOLVE_TYPES|RESOLVE_VARIABLES);
253 ConstantSpecializer().apply(stage, (mode==PROGRAM && specialized ? &spec_values : 0));
256 LegacyConverter().apply(stage, features);
257 resolve(stage, RESOLVE_VARIABLES|RESOLVE_FUNCTIONS);
262 bool Compiler::resolve(Stage &stage, unsigned &flags, unsigned bit)
268 return T().apply(stage);
271 void Compiler::resolve(Stage &stage, unsigned flags)
275 if(resolve<BlockHierarchyResolver>(stage, flags, RESOLVE_BLOCKS))
277 else if(resolve<TypeResolver>(stage, flags, RESOLVE_TYPES))
278 flags |= RESOLVE_BLOCKS|RESOLVE_VARIABLES|RESOLVE_EXPRESSIONS;
279 else if(resolve<VariableResolver>(stage, flags, RESOLVE_VARIABLES))
280 flags |= RESOLVE_EXPRESSIONS;
281 else if(resolve<FunctionResolver>(stage, flags, RESOLVE_FUNCTIONS))
282 flags |= RESOLVE_EXPRESSIONS;
283 else if(resolve<ExpressionResolver>(stage, flags, RESOLVE_EXPRESSIONS))
284 flags |= RESOLVE_VARIABLES|RESOLVE_FUNCTIONS;
288 bool Compiler::validate(Stage &stage)
290 TypeValidator().apply(stage);
291 DeclarationValidator().apply(stage);
292 ReferenceValidator().apply(stage);
293 ExpressionValidator().apply(stage);
295 stable_sort(stage.diagnostics, &diagnostic_line_order);
297 for(vector<Diagnostic>::const_iterator i=stage.diagnostics.begin(); i!=stage.diagnostics.end(); ++i)
298 if(i->severity==Diagnostic::ERR)
304 bool Compiler::diagnostic_line_order(const Diagnostic &diag1, const Diagnostic &diag2)
306 if(diag1.provoking_source!=diag2.provoking_source)
308 // Sort builtins first and imported modules according to import order.
309 if(diag1.provoking_source<=BUILTIN_SOURCE)
310 return diag1.provoking_source<diag2.provoking_source;
311 else if(diag2.provoking_source<=BUILTIN_SOURCE)
314 return diag1.provoking_source>diag2.provoking_source;
316 return diag1.provoking_line<diag2.provoking_line;
319 Compiler::OptimizeResult Compiler::optimize(Stage &stage)
321 ConstantConditionEliminator().apply(stage);
323 bool any_inlined = false;
324 if(FunctionInliner().apply(stage))
326 resolve(stage, RESOLVE_TYPES|RESOLVE_VARIABLES|RESOLVE_FUNCTIONS|RESOLVE_EXPRESSIONS);
329 if(ExpressionInliner().apply(stage))
331 resolve(stage, RESOLVE_VARIABLES|RESOLVE_FUNCTIONS|RESOLVE_EXPRESSIONS);
335 /* Removing variables or functions may cause things from the previous stage
337 bool any_removed = UnusedVariableRemover().apply(stage);
338 any_removed |= UnusedFunctionRemover().apply(stage);
339 any_removed |= UnusedTypeRemover().apply(stage);
341 return any_removed ? REDO_PREVIOUS : any_inlined ? REDO_STAGE : NEXT_STAGE;
344 void Compiler::finalize(Stage &stage, Mode mode)
346 if(get_gl_api()==OPENGL_ES2 && mode==PROGRAM)
347 DefaultPrecisionGenerator().apply(stage);
348 else if(mode==MODULE)
349 PrecisionRemover().apply(stage);
352 void Compiler::inject_block(Block &target, const Block &source)
354 NodeList<Statement>::iterator insert_point = target.body.begin();
355 for(NodeList<Statement>::const_iterator i=source.body.begin(); i!=source.body.end(); ++i)
356 target.body.insert(insert_point, (*i)->clone());