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)
83 ConstantIdAssigner().apply(*module, features);
85 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
87 GlobalInterfaceValidator().apply(*module);
90 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
94 throw invalid_shader_source(get_diagnostics());
96 if(mode==PROGRAM && specialized)
98 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
99 ConstantSpecializer().apply(*i, spec_values);
101 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); )
103 OptimizeResult result = optimize(*i);
104 if(result==REDO_PREVIOUS)
105 i = module->stages.begin();
106 else if(result!=REDO_STAGE)
109 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
115 string Compiler::get_combined_glsl() const
118 throw invalid_operation("Compiler::get_combined_glsl");
122 unsigned source_count = module->source_map.get_count();
123 for(unsigned i=1; i<source_count; ++i)
124 glsl += format("#pragma MSP source(%d, \"%s\")\n", i, module->source_map.get_name(i));
125 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
127 glsl += format("#pragma MSP stage(%s)\n", Stage::get_stage_name(i->type));
128 glsl += Formatter().apply(*i);
135 vector<Stage::Type> Compiler::get_stages() const
137 vector<Stage::Type> stage_types;
138 stage_types.reserve(module->stages.size());
139 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
140 stage_types.push_back(i->type);
144 string Compiler::get_stage_glsl(Stage::Type stage_type) const
147 throw invalid_operation("Compiler::get_stage_glsl");
148 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
149 if(i->type==stage_type)
150 return Formatter().apply(*i);
151 throw key_error(Stage::get_stage_name(stage_type));
154 const map<string, unsigned> &Compiler::get_vertex_attributes() const
157 throw invalid_operation("Compiler::get_vertex_attributes");
158 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
159 if(i->type==Stage::VERTEX)
161 throw invalid_operation("Compiler::get_vertex_attributes");
164 const map<string, unsigned> &Compiler::get_fragment_outputs() const
167 throw invalid_operation("Compiler::get_fragment_outputs");
168 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
169 if(i->type==Stage::FRAGMENT)
171 throw invalid_operation("Compiler::get_fragment_outputs");
174 const SourceMap &Compiler::get_source_map() const
176 return module->source_map;
179 string Compiler::get_stage_debug(Stage::Type stage_type) const
181 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
182 if(i->type==stage_type)
183 return DumpTree().apply(*i);
184 throw key_error(Stage::get_stage_name(stage_type));
187 string Compiler::get_diagnostics() const
190 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
191 for(vector<Diagnostic>::const_iterator j=i->diagnostics.begin(); j!=i->diagnostics.end(); ++j)
192 if(j->source!=INTERNAL_SOURCE)
193 append(combined, "\n", format("%s:%d: %s", module->source_map.get_name(j->source), j->line, j->message));
197 void Compiler::append_module(Module &mod, DataFile::Collection *res)
199 module->source_map.merge_from(mod.source_map);
201 vector<Import *> imports;
202 for(NodeList<Statement>::const_iterator i=mod.shared.content.body.begin(); i!=mod.shared.content.body.end(); ++i)
203 if(Import *imp = dynamic_cast<Import *>(i->get()))
204 imports.push_back(imp);
205 for(vector<Import *>::iterator i=imports.begin(); i!=imports.end(); ++i)
206 import(res, (*i)->module);
207 NodeRemover().apply(mod.shared, set<Node *>(imports.begin(), imports.end()));
209 append_stage(mod.shared);
210 for(list<Stage>::iterator i=mod.stages.begin(); i!=mod.stages.end(); ++i)
214 void Compiler::append_stage(Stage &stage)
217 if(stage.type==Stage::SHARED)
218 target = &module->shared;
221 list<Stage>::iterator i;
222 for(i=module->stages.begin(); (i!=module->stages.end() && i->type<stage.type); ++i) ;
223 if(i==module->stages.end() || i->type>stage.type)
225 list<Stage>::iterator j = module->stages.insert(i, stage.type);
226 if(i!=module->stages.end())
229 if(i!=module->stages.begin())
236 if(stage.required_features.glsl_version>target->required_features.glsl_version)
237 target->required_features.glsl_version = stage.required_features.glsl_version;
238 for(NodeList<Statement>::iterator i=stage.content.body.begin(); i!=stage.content.body.end(); ++i)
239 target->content.body.push_back(*i);
242 void Compiler::import(DataFile::Collection *resources, const string &name)
244 string fn = name+".glsl";
245 if(find(imported_names, fn)!=imported_names.end())
247 imported_names.push_back(fn);
249 RefPtr<IO::Seekable> io = (resources ? resources->open_raw(fn) : Resources::get_builtins().open(fn));
251 throw runtime_error(format("module %s not found", name));
252 Parser import_parser;
253 append_module(import_parser.parse(*io, fn, module->source_map.get_count()), resources);
256 void Compiler::generate(Stage &stage)
258 stage.required_features.gl_api = features.gl_api;
259 if(module->shared.required_features.glsl_version>stage.required_features.glsl_version)
260 stage.required_features.glsl_version = module->shared.required_features.glsl_version;
262 inject_block(stage.content, module->shared.content);
263 if(const Stage *builtins = get_builtins(stage.type))
264 inject_block(stage.content, builtins->content);
265 if(const Stage *builtins = get_builtins(Stage::SHARED))
266 inject_block(stage.content, builtins->content);
268 // Initial resolving pass
271 /* All variables local to a stage have been resolved. Resolve non-local
272 variables through interfaces. */
273 InterfaceGenerator().apply(stage);
274 resolve(stage, RESOLVE_BLOCKS|RESOLVE_TYPES|RESOLVE_VARIABLES);
278 bool Compiler::resolve(Stage &stage, unsigned &flags, unsigned bit)
284 return T().apply(stage);
287 void Compiler::resolve(Stage &stage, unsigned flags)
291 if(resolve<BlockHierarchyResolver>(stage, flags, RESOLVE_BLOCKS))
293 else if(resolve<TypeResolver>(stage, flags, RESOLVE_TYPES))
294 flags |= RESOLVE_BLOCKS|RESOLVE_VARIABLES|RESOLVE_EXPRESSIONS;
295 else if(resolve<VariableResolver>(stage, flags, RESOLVE_VARIABLES))
296 flags |= RESOLVE_EXPRESSIONS;
297 else if(resolve<FunctionResolver>(stage, flags, RESOLVE_FUNCTIONS))
298 flags |= RESOLVE_EXPRESSIONS;
299 else if(resolve<ExpressionResolver>(stage, flags, RESOLVE_EXPRESSIONS))
300 flags |= RESOLVE_VARIABLES|RESOLVE_FUNCTIONS;
304 void Compiler::validate(Stage &stage)
306 DeclarationValidator().apply(stage);
307 IdentifierValidator().apply(stage);
308 ReferenceValidator().apply(stage);
309 ExpressionValidator().apply(stage);
310 StageInterfaceValidator().apply(stage);
313 bool Compiler::check_errors(Stage &stage)
315 stable_sort(stage.diagnostics, &diagnostic_line_order);
317 for(vector<Diagnostic>::const_iterator i=stage.diagnostics.begin(); i!=stage.diagnostics.end(); ++i)
318 if(i->severity==Diagnostic::ERR)
324 bool Compiler::diagnostic_line_order(const Diagnostic &diag1, const Diagnostic &diag2)
326 if(diag1.provoking_source!=diag2.provoking_source)
328 // Sort builtins first and imported modules according to import order.
329 if(diag1.provoking_source<=BUILTIN_SOURCE)
330 return diag1.provoking_source<diag2.provoking_source;
331 else if(diag2.provoking_source<=BUILTIN_SOURCE)
334 return diag1.provoking_source>diag2.provoking_source;
336 return diag1.provoking_line<diag2.provoking_line;
339 Compiler::OptimizeResult Compiler::optimize(Stage &stage)
341 if(ConstantFolder().apply(stage))
342 resolve(stage, RESOLVE_EXPRESSIONS);
343 ConstantConditionEliminator().apply(stage);
345 bool any_inlined = false;
346 if(FunctionInliner().apply(stage))
348 resolve(stage, RESOLVE_TYPES|RESOLVE_VARIABLES|RESOLVE_FUNCTIONS|RESOLVE_EXPRESSIONS);
351 if(ExpressionInliner().apply(stage))
353 resolve(stage, RESOLVE_VARIABLES|RESOLVE_FUNCTIONS|RESOLVE_EXPRESSIONS);
357 /* Removing variables or functions may cause things from the previous stage
359 bool any_removed = UnusedVariableRemover().apply(stage);
360 any_removed |= UnusedFunctionRemover().apply(stage);
361 any_removed |= UnusedTypeRemover().apply(stage);
363 return any_removed ? REDO_PREVIOUS : any_inlined ? REDO_STAGE : NEXT_STAGE;
366 void Compiler::finalize(Stage &stage, Mode mode)
370 LegacyConverter().apply(stage, features);
371 resolve(stage, RESOLVE_VARIABLES|RESOLVE_FUNCTIONS);
372 PrecisionConverter().apply(stage);
376 void Compiler::inject_block(Block &target, const Block &source)
378 NodeList<Statement>::iterator insert_point = target.body.begin();
379 for(NodeList<Statement>::const_iterator i=source.body.begin(); i!=source.body.end(); ++i)
380 target.body.insert(insert_point, (*i)->clone());