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);
86 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
90 throw invalid_shader_source(get_diagnostics());
92 if(mode==PROGRAM && specialized)
94 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
95 ConstantSpecializer().apply(*i, spec_values);
97 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); )
99 OptimizeResult result = optimize(*i);
100 if(result==REDO_PREVIOUS)
101 i = module->stages.begin();
102 else if(result!=REDO_STAGE)
105 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
111 string Compiler::get_combined_glsl() const
114 throw invalid_operation("Compiler::get_combined_glsl");
118 unsigned source_count = module->source_map.get_count();
119 for(unsigned i=1; i<source_count; ++i)
120 glsl += format("#pragma MSP source(%d, \"%s\")\n", i, module->source_map.get_name(i));
121 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
123 glsl += format("#pragma MSP stage(%s)\n", Stage::get_stage_name(i->type));
124 glsl += Formatter().apply(*i);
131 vector<Stage::Type> Compiler::get_stages() const
133 vector<Stage::Type> stage_types;
134 stage_types.reserve(module->stages.size());
135 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
136 stage_types.push_back(i->type);
140 string Compiler::get_stage_glsl(Stage::Type stage_type) const
143 throw invalid_operation("Compiler::get_stage_glsl");
144 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
145 if(i->type==stage_type)
146 return Formatter().apply(*i);
147 throw key_error(Stage::get_stage_name(stage_type));
150 const map<string, unsigned> &Compiler::get_vertex_attributes() const
153 throw invalid_operation("Compiler::get_vertex_attributes");
154 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
155 if(i->type==Stage::VERTEX)
157 throw invalid_operation("Compiler::get_vertex_attributes");
160 const map<string, unsigned> &Compiler::get_fragment_outputs() const
163 throw invalid_operation("Compiler::get_fragment_outputs");
164 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
165 if(i->type==Stage::FRAGMENT)
167 throw invalid_operation("Compiler::get_fragment_outputs");
170 const SourceMap &Compiler::get_source_map() const
172 return module->source_map;
175 string Compiler::get_stage_debug(Stage::Type stage_type) const
177 for(list<Stage>::iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
178 if(i->type==stage_type)
179 return DumpTree().apply(*i);
180 throw key_error(Stage::get_stage_name(stage_type));
183 string Compiler::get_diagnostics() const
186 for(list<Stage>::const_iterator i=module->stages.begin(); i!=module->stages.end(); ++i)
187 for(vector<Diagnostic>::const_iterator j=i->diagnostics.begin(); j!=i->diagnostics.end(); ++j)
188 if(j->source!=INTERNAL_SOURCE)
189 append(combined, "\n", format("%s:%d: %s", module->source_map.get_name(j->source), j->line, j->message));
193 void Compiler::append_module(Module &mod, DataFile::Collection *res)
195 module->source_map.merge_from(mod.source_map);
197 vector<Import *> imports;
198 for(NodeList<Statement>::const_iterator i=mod.shared.content.body.begin(); i!=mod.shared.content.body.end(); ++i)
199 if(Import *imp = dynamic_cast<Import *>(i->get()))
200 imports.push_back(imp);
201 for(vector<Import *>::iterator i=imports.begin(); i!=imports.end(); ++i)
202 import(res, (*i)->module);
203 NodeRemover().apply(mod.shared, set<Node *>(imports.begin(), imports.end()));
205 append_stage(mod.shared);
206 for(list<Stage>::iterator i=mod.stages.begin(); i!=mod.stages.end(); ++i)
210 void Compiler::append_stage(Stage &stage)
213 if(stage.type==Stage::SHARED)
214 target = &module->shared;
217 list<Stage>::iterator i;
218 for(i=module->stages.begin(); (i!=module->stages.end() && i->type<stage.type); ++i) ;
219 if(i==module->stages.end() || i->type>stage.type)
221 list<Stage>::iterator j = module->stages.insert(i, stage.type);
222 if(i!=module->stages.end())
225 if(i!=module->stages.begin())
232 if(stage.required_features.glsl_version>target->required_features.glsl_version)
233 target->required_features.glsl_version = stage.required_features.glsl_version;
234 for(NodeList<Statement>::iterator i=stage.content.body.begin(); i!=stage.content.body.end(); ++i)
235 target->content.body.push_back(*i);
238 void Compiler::import(DataFile::Collection *resources, const string &name)
240 string fn = name+".glsl";
241 if(find(imported_names, fn)!=imported_names.end())
243 imported_names.push_back(fn);
245 RefPtr<IO::Seekable> io = (resources ? resources->open_raw(fn) : Resources::get_builtins().open(fn));
247 throw runtime_error(format("module %s not found", name));
248 Parser import_parser;
249 append_module(import_parser.parse(*io, fn, module->source_map.get_count()), resources);
252 void Compiler::generate(Stage &stage)
254 stage.required_features.gl_api = features.gl_api;
255 if(module->shared.required_features.glsl_version>stage.required_features.glsl_version)
256 stage.required_features.glsl_version = module->shared.required_features.glsl_version;
258 inject_block(stage.content, module->shared.content);
259 if(const Stage *builtins = get_builtins(stage.type))
260 inject_block(stage.content, builtins->content);
261 if(const Stage *builtins = get_builtins(Stage::SHARED))
262 inject_block(stage.content, builtins->content);
264 // Initial resolving pass
267 /* All variables local to a stage have been resolved. Resolve non-local
268 variables through interfaces. */
269 InterfaceGenerator().apply(stage);
270 resolve(stage, RESOLVE_BLOCKS|RESOLVE_TYPES|RESOLVE_VARIABLES);
274 bool Compiler::resolve(Stage &stage, unsigned &flags, unsigned bit)
280 return T().apply(stage);
283 void Compiler::resolve(Stage &stage, unsigned flags)
287 if(resolve<BlockHierarchyResolver>(stage, flags, RESOLVE_BLOCKS))
289 else if(resolve<TypeResolver>(stage, flags, RESOLVE_TYPES))
290 flags |= RESOLVE_BLOCKS|RESOLVE_VARIABLES|RESOLVE_EXPRESSIONS;
291 else if(resolve<VariableResolver>(stage, flags, RESOLVE_VARIABLES))
292 flags |= RESOLVE_EXPRESSIONS;
293 else if(resolve<FunctionResolver>(stage, flags, RESOLVE_FUNCTIONS))
294 flags |= RESOLVE_EXPRESSIONS;
295 else if(resolve<ExpressionResolver>(stage, flags, RESOLVE_EXPRESSIONS))
296 flags |= RESOLVE_VARIABLES|RESOLVE_FUNCTIONS;
300 bool Compiler::validate(Stage &stage)
302 DeclarationValidator().apply(stage);
303 IdentifierValidator().apply(stage);
304 ReferenceValidator().apply(stage);
305 ExpressionValidator().apply(stage);
307 stable_sort(stage.diagnostics, &diagnostic_line_order);
309 for(vector<Diagnostic>::const_iterator i=stage.diagnostics.begin(); i!=stage.diagnostics.end(); ++i)
310 if(i->severity==Diagnostic::ERR)
316 bool Compiler::diagnostic_line_order(const Diagnostic &diag1, const Diagnostic &diag2)
318 if(diag1.provoking_source!=diag2.provoking_source)
320 // Sort builtins first and imported modules according to import order.
321 if(diag1.provoking_source<=BUILTIN_SOURCE)
322 return diag1.provoking_source<diag2.provoking_source;
323 else if(diag2.provoking_source<=BUILTIN_SOURCE)
326 return diag1.provoking_source>diag2.provoking_source;
328 return diag1.provoking_line<diag2.provoking_line;
331 Compiler::OptimizeResult Compiler::optimize(Stage &stage)
333 if(ConstantFolder().apply(stage))
334 resolve(stage, RESOLVE_EXPRESSIONS);
335 ConstantConditionEliminator().apply(stage);
337 bool any_inlined = false;
338 if(FunctionInliner().apply(stage))
340 resolve(stage, RESOLVE_TYPES|RESOLVE_VARIABLES|RESOLVE_FUNCTIONS|RESOLVE_EXPRESSIONS);
343 if(ExpressionInliner().apply(stage))
345 resolve(stage, RESOLVE_VARIABLES|RESOLVE_FUNCTIONS|RESOLVE_EXPRESSIONS);
349 /* Removing variables or functions may cause things from the previous stage
351 bool any_removed = UnusedVariableRemover().apply(stage);
352 any_removed |= UnusedFunctionRemover().apply(stage);
353 any_removed |= UnusedTypeRemover().apply(stage);
355 return any_removed ? REDO_PREVIOUS : any_inlined ? REDO_STAGE : NEXT_STAGE;
358 void Compiler::finalize(Stage &stage, Mode mode)
362 LegacyConverter().apply(stage, features);
363 resolve(stage, RESOLVE_VARIABLES|RESOLVE_FUNCTIONS);
364 PrecisionConverter().apply(stage);
368 void Compiler::inject_block(Block &target, const Block &source)
370 NodeList<Statement>::iterator insert_point = target.body.begin();
371 for(NodeList<Statement>::const_iterator i=source.body.begin(); i!=source.body.end(); ++i)
372 target.body.insert(insert_point, (*i)->clone());