1 #ifndef MSP_GL_SL_COMPILER_H_
2 #define MSP_GL_SL_COMPILER_H_
5 #include <msp/datafile/collection.h>
6 #include <msp/io/base.h>
35 RESOLVE_VARIABLES = 4,
36 RESOLVE_EXPRESSIONS = 8,
37 RESOLVE_FUNCTIONS = 16,
43 std::vector<std::string> imported_names;
45 std::map<std::string, int> spec_values;
48 /** Creates a compiler using features from the current OpenGL context. */
51 /** Creates a compiler targeting a specific set of features. */
52 Compiler(const Features &);
60 /** Sets the source code to be compiled. Only builtin imports are
62 void set_source(const std::string &, const std::string & = "<string>");
64 /** Loads source code from an I/O object. If a collection is used, imports
65 can be fetched from it. */
66 void load_source(IO::Base &, DataFile::Collection * = 0, const std::string & = "<file>");
68 /** Loads source code from an I/O object. Only builtin imports are
70 void load_source(IO::Base &, const std::string &);
72 /** Specializes the shader. All specialization constants are considered
73 specialized, even if they do not appear in the map. */
74 void specialize(const std::map<std::string, int> &);
76 /** Compiles the shader. */
79 /** Returns combined GLSL source for all shader stages. The result is
80 suitable for feeding back to the compiler. */
81 std::string get_combined_glsl() const;
83 /** Returns a list of compiled stage types. */
84 std::vector<Stage::Type> get_stages() const;
86 /** Returns GLSL source for a single shader stage. The result is standard
87 GLSL suitable for OpenGL or an external GLSL compiler. */
88 std::string get_stage_glsl(Stage::Type) const;
90 /** Returns a map of vertex attribute locations. If the target GLSL version
91 supports interface layouts, the map is empty (locations are included in the
93 const std::map<std::string, unsigned> &get_vertex_attributes() const;
95 /** Returns a map of fragment output locations. If the target GLSL version
96 supports interface layouts, the map is empty (locations are included in the
98 const std::map<std::string, unsigned> &get_fragment_outputs() const;
100 /** Returns the mapping of source indices to filenames. Can be used to
101 translate error messages. */
102 const SourceMap &get_source_map() const;
104 /** Returns a textual representation of the syntax tree for a shader stage.
105 Intended for debugging purposes. */
106 std::string get_stage_debug(Stage::Type) const;
108 /** Returns diagnostics from compilation. The output is intended to be
110 std::string get_diagnostics() const;
113 /** Appends a module to the target, processing any imports found in it. */
114 void append_module(Module &, DataFile::Collection *);
116 /** Appends a single stage to the matching stage of the target. */
117 void append_stage(Stage &);
119 /// Imports a module by name and appends it to the target. */
120 void import(DataFile::Collection *, const std::string &);
122 /** Generates any implicitly defines syntactic structures and resolves
124 void generate(Stage &, Mode);
127 bool resolve(Stage &, unsigned &, unsigned);
129 /** Resolves various references between nodes. Flags can be specified to
130 request resolving particular aspects. Resolving may ripple into other
131 aspects as necessary. */
132 void resolve(Stage &, unsigned = RESOLVE_ALL);
134 bool validate(Stage &);
136 static bool diagnostic_line_order(const Diagnostic &, const Diagnostic &);
138 /** Applies optimizations to a stage. The return value indicates which
139 stage should be optimized next. */
140 OptimizeResult optimize(Stage &);
142 /** Performs final adjustments on a stage after compilation. */
143 void finalize(Stage &, Mode);
145 static void inject_block(Block &, const Block &);