1 #include <msp/core/algorithm.h>
2 #include <msp/strings/format.h>
3 #include <msp/strings/utils.h>
10 #include "glsl_error.h"
14 #include "resources.h"
26 features(Features::from_context()),
32 Compiler::Compiler(const Features &f):
44 void Compiler::clear()
47 module = new Module();
48 imported_names.clear();
49 module->source_map.set_name(0, "<generated>");
52 void Compiler::set_source(const string &source, const string &src_name)
56 imported_names.push_back(src_name);
57 append_module(parser.parse(source, src_name, 1), 0);
60 void Compiler::load_source(IO::Base &io, DataFile::Collection *res, const string &src_name)
64 imported_names.push_back(src_name);
65 append_module(parser.parse(io, src_name, 1), res);
68 void Compiler::load_source(IO::Base &io, const string &src_name)
70 load_source(io, 0, src_name);
73 void Compiler::specialize(const map<string, int> &sv)
79 void Compiler::compile(Mode mode)
81 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
85 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
89 throw invalid_shader_source(get_diagnostics());
92 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++n)
94 OptimizeResult result = optimize(*i);
95 if(result==REDO_PREVIOUS)
96 i = module->stages.begin();
97 else if(result!=REDO_STAGE)
100 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
106 string Compiler::get_combined_glsl() const
109 throw invalid_operation("Compiler::get_combined_glsl");
113 unsigned source_count = module->source_map.get_count();
114 for(unsigned i=1; i<source_count; ++i)
115 glsl += format("#pragma MSP source(%d, \"%s\")\n", i, module->source_map.get_name(i));
116 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
118 glsl += format("#pragma MSP stage(%s)\n", Stage::get_stage_name(i->type));
119 glsl += Formatter().apply(*i);
126 vector<Stage::Type> Compiler::get_stages() const
128 vector<Stage::Type> stage_types;
129 stage_types.reserve(module->stages.size());
130 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
131 stage_types.push_back(i->type);
135 string Compiler::get_stage_glsl(Stage::Type stage_type) const
138 throw invalid_operation("Compiler::get_stage_glsl");
139 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
140 if(i->type==stage_type)
141 return Formatter().apply(*i);
142 throw key_error(Stage::get_stage_name(stage_type));
145 const map<string, unsigned> &Compiler::get_vertex_attributes() const
148 throw invalid_operation("Compiler::get_vertex_attributes");
149 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
150 if(i->type==Stage::VERTEX)
152 throw invalid_operation("Compiler::get_vertex_attributes");
155 const map<string, unsigned> &Compiler::get_fragment_outputs() const
158 throw invalid_operation("Compiler::get_fragment_outputs");
159 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
160 if(i->type==Stage::FRAGMENT)
162 throw invalid_operation("Compiler::get_fragment_outputs");
165 const SourceMap &Compiler::get_source_map() const
167 return module->source_map;
170 string Compiler::get_stage_debug(Stage::Type stage_type) const
172 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
173 if(i->type==stage_type)
174 return DumpTree().apply(*i);
175 throw key_error(Stage::get_stage_name(stage_type));
178 string Compiler::get_diagnostics() const
181 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
182 for(vector<Diagnostic>::const_iterator j=i->diagnostics.begin(); j!=i->diagnostics.end(); ++j)
183 if(j->source!=INTERNAL_SOURCE)
184 append(combined, "\n", format("%s:%d: %s", module->source_map.get_name(j->source), j->line, j->message));
188 void Compiler::append_module(Module &mod, DataFile::Collection *res)
190 module->source_map.merge_from(mod.source_map);
192 vector<Import *> imports;
193 for(NodeList<Statement>::const_iterator i=mod.shared.content.body.begin(); i!=mod.shared.content.body.end(); ++i)
194 if(Import *imp = dynamic_cast<Import *>(i->get()))
195 imports.push_back(imp);
196 for(vector<Import *>::iterator i=imports.begin(); i!=imports.end(); ++i)
197 import(res, (*i)->module);
198 NodeRemover().apply(mod.shared, set<Node *>(imports.begin(), imports.end()));
200 append_stage(mod.shared);
201 for(list<Stage>::iterator i=mod.stages.begin(); i!=mod.stages.end(); ++i)
205 void Compiler::append_stage(Stage &stage)
208 if(stage.type==Stage::SHARED)
209 target = &module->shared;
212 list<Stage>::iterator i;
213 for(i=module->stages.begin(); (i!=module->stages.end() && i->type<stage.type); ++i) ;
214 if(i==module->stages.end() || i->type>stage.type)
216 list<Stage>::iterator j = module->stages.insert(i, stage.type);
217 if(i!=module->stages.end())
220 if(i!=module->stages.begin())
227 if(stage.required_features.glsl_version>target->required_features.glsl_version)
228 target->required_features.glsl_version = stage.required_features.glsl_version;
229 for(NodeList<Statement>::iterator i=stage.content.body.begin(); i!=stage.content.body.end(); ++i)
230 target->content.body.push_back(*i);
233 void Compiler::import(DataFile::Collection *resources, const string &name)
235 string fn = name+".glsl";
236 if(find(imported_names, fn)!=imported_names.end())
238 imported_names.push_back(fn);
240 RefPtr<IO::Seekable> io = (resources ? resources->open_raw(fn) : Resources::get_builtins().open(fn));
242 throw runtime_error(format("module %s not found", name));
243 Parser import_parser;
244 append_module(import_parser.parse(*io, fn, module->source_map.get_count()), resources);
247 void Compiler::generate(Stage &stage, Mode mode)
249 stage.required_features.gl_api = features.gl_api;
250 if(module->shared.required_features.glsl_version>stage.required_features.glsl_version)
251 stage.required_features.glsl_version = module->shared.required_features.glsl_version;
253 inject_block(stage.content, module->shared.content);
254 if(const Stage *builtins = get_builtins(stage.type))
255 inject_block(stage.content, builtins->content);
256 if(const Stage *builtins = get_builtins(Stage::SHARED))
257 inject_block(stage.content, builtins->content);
259 // Initial resolving pass
262 /* All variables local to a stage have been resolved. Resolve non-local
263 variables through interfaces. */
264 InterfaceGenerator().apply(stage);
265 resolve(stage, RESOLVE_BLOCKS|RESOLVE_TYPES|RESOLVE_VARIABLES);
267 ConstantSpecializer().apply(stage, (mode==PROGRAM && specialized ? &spec_values : 0));
271 bool Compiler::resolve(Stage &stage, unsigned &flags, unsigned bit)
277 return T().apply(stage);
280 void Compiler::resolve(Stage &stage, unsigned flags)
284 if(resolve<BlockHierarchyResolver>(stage, flags, RESOLVE_BLOCKS))
286 else if(resolve<TypeResolver>(stage, flags, RESOLVE_TYPES))
287 flags |= RESOLVE_BLOCKS|RESOLVE_VARIABLES|RESOLVE_EXPRESSIONS;
288 else if(resolve<VariableResolver>(stage, flags, RESOLVE_VARIABLES))
289 flags |= RESOLVE_EXPRESSIONS;
290 else if(resolve<FunctionResolver>(stage, flags, RESOLVE_FUNCTIONS))
291 flags |= RESOLVE_EXPRESSIONS;
292 else if(resolve<ExpressionResolver>(stage, flags, RESOLVE_EXPRESSIONS))
293 flags |= RESOLVE_VARIABLES|RESOLVE_FUNCTIONS;
297 bool Compiler::validate(Stage &stage)
299 DeclarationValidator().apply(stage);
300 IdentifierValidator().apply(stage);
301 ReferenceValidator().apply(stage);
302 ExpressionValidator().apply(stage);
304 stable_sort(stage.diagnostics, &diagnostic_line_order);
306 for(vector<Diagnostic>::const_iterator i=stage.diagnostics.begin(); i!=stage.diagnostics.end(); ++i)
307 if(i->severity==Diagnostic::ERR)
313 bool Compiler::diagnostic_line_order(const Diagnostic &diag1, const Diagnostic &diag2)
315 if(diag1.provoking_source!=diag2.provoking_source)
317 // Sort builtins first and imported modules according to import order.
318 if(diag1.provoking_source<=BUILTIN_SOURCE)
319 return diag1.provoking_source<diag2.provoking_source;
320 else if(diag2.provoking_source<=BUILTIN_SOURCE)
323 return diag1.provoking_source>diag2.provoking_source;
325 return diag1.provoking_line<diag2.provoking_line;
328 Compiler::OptimizeResult Compiler::optimize(Stage &stage)
330 if(ConstantFolder().apply(stage))
331 resolve(stage, RESOLVE_EXPRESSIONS);
332 ConstantConditionEliminator().apply(stage);
334 bool any_inlined = false;
335 if(FunctionInliner().apply(stage))
337 resolve(stage, RESOLVE_TYPES|RESOLVE_VARIABLES|RESOLVE_FUNCTIONS|RESOLVE_EXPRESSIONS);
340 if(ExpressionInliner().apply(stage))
342 resolve(stage, RESOLVE_VARIABLES|RESOLVE_FUNCTIONS|RESOLVE_EXPRESSIONS);
346 /* Removing variables or functions may cause things from the previous stage
348 bool any_removed = UnusedVariableRemover().apply(stage);
349 any_removed |= UnusedFunctionRemover().apply(stage);
350 any_removed |= UnusedTypeRemover().apply(stage);
352 return any_removed ? REDO_PREVIOUS : any_inlined ? REDO_STAGE : NEXT_STAGE;
355 void Compiler::finalize(Stage &stage, Mode mode)
359 LegacyConverter().apply(stage, features);
360 resolve(stage, RESOLVE_VARIABLES|RESOLVE_FUNCTIONS);
361 PrecisionConverter().apply(stage);
365 void Compiler::inject_block(Block &target, const Block &source)
367 NodeList<Statement>::iterator insert_point = target.body.begin();
368 for(NodeList<Statement>::const_iterator i=source.body.begin(); i!=source.body.end(); ++i)
369 target.body.insert(insert_point, (*i)->clone());