X-Git-Url: http://git.tdb.fi/?p=libs%2Fgl.git;a=blobdiff_plain;f=source%2Fglsl%2Fcompiler.h;h=f9e0e3fe2aa554f623b1d9c85f8f284e5808f58f;hp=69ac7427d80fc97188fa2bcbb0c2c600ef6cf67a;hb=3a1b9cbe2441ae670a97541dc8ccb0a2860c8302;hpb=6288c42adde9ee7d39a47de51fa2856cf965dccc

diff --git a/source/glsl/compiler.h b/source/glsl/compiler.h
index 69ac7427..f9e0e3fe 100644
--- a/source/glsl/compiler.h
+++ b/source/glsl/compiler.h
@@ -17,46 +17,152 @@ public:
 	enum Mode
 	{
 		MODULE,
-		PROGRAM
+		PROGRAM,
+		SPIRV
 	};
 
 private:
+	enum OptimizeResult
+	{
+		NEXT_STAGE,
+		REDO_STAGE,
+		REDO_PREVIOUS
+	};
+
+	enum ResolveFlags
+	{
+		RESOLVE_BLOCKS = 1,
+		RESOLVE_TYPES = 2,
+		RESOLVE_VARIABLES = 4,
+		RESOLVE_EXPRESSIONS = 8,
+		RESOLVE_FUNCTIONS = 16,
+		RESOLVE_ALL = 31
+	};
+
 	Features features;
 	Module *module;
 	std::vector<std::string> imported_names;
+	bool compiled;
 	bool specialized;
 	std::map<std::string, int> spec_values;
 
 public:
+	/** Creates a compiler using features from the current OpenGL context. */
 	Compiler();
+
+	/** Creates a compiler targeting a specific set of features. */
 	Compiler(const Features &);
+
 	~Compiler();
 
 private:
 	void clear();
+
 public:
+	/** Sets the source code to be compiled.  Only builtin imports are
+	available. */
 	void set_source(const std::string &, const std::string & = "<string>");
+
+	/** Loads source code from an I/O object.  If a collection is used, imports
+	can be fetched from it. */
 	void load_source(IO::Base &, DataFile::Collection * = 0, const std::string & = "<file>");
+
+	/** Loads source code from an I/O object.  Only builtin imports are
+	available. */
 	void load_source(IO::Base &, const std::string &);
+
+	/** Specializes the shader.  All specialization constants are considered
+	specialized, even if they do not appear in the map. */
 	void specialize(const std::map<std::string, int> &);
+
+	/** Compiles the shader. */
 	void compile(Mode);
 
+	/** Returns combined GLSL source for all shader stages.  The result is
+	suitable for feeding back to the compiler. */
 	std::string get_combined_glsl() const;
+
+	/** Returns a list of compiled stage types. */
 	std::vector<Stage::Type> get_stages() const;
+
+	/** Returns GLSL source for a single shader stage.  The result is standard
+	GLSL suitable for OpenGL or an external GLSL compiler. */
 	std::string get_stage_glsl(Stage::Type) const;
+
+	/** Returns a combined SPIR-V binary for all shader stages.  The result is
+	suitable for use with OpenGL or Vulkan. */
+	std::vector<std::uint32_t> get_combined_spirv() const;
+
+	/** Returns a map of vertex attribute locations.  If the target GLSL version
+	supports interface layouts, the map is empty (locations are included in the
+	GLSL soucre). */
 	const std::map<std::string, unsigned> &get_vertex_attributes() const;
+
+	/** Returns a map of fragment output locations.  If the target GLSL version
+	supports interface layouts, the map is empty (locations are included in the
+	GLSL soucre). */
 	const std::map<std::string, unsigned> &get_fragment_outputs() const;
+
+	/** Returns a map of texture bindings.  If the target GLSL version supports
+	bindings, the map is empty (bindings are included in the GLSL source). */
+	const std::map<std::string, unsigned> &get_texture_bindings() const;
+
+	/** Returns a map of uniform block bindings.  If the target GLSL version
+	supports bindings, the map is empty (bindings are included in the GLSL
+	source). */
+	const std::map<std::string, unsigned> &get_uniform_block_bindings() const;
+
+	/** Returns the mapping of source indices to filenames.  Can be used to
+	translate error messages. */
 	const SourceMap &get_source_map() const;
 
+	/** Returns a textual representation of the syntax tree for a shader stage.
+	Intended for debugging purposes. */
 	std::string get_stage_debug(Stage::Type) const;
 
+	/** Returns diagnostics from compilation.  The output is intended to be
+	viewed by humans. */
+	std::string get_diagnostics() const;
+
 private:
-	void append_module(Module &, DataFile::Collection *);
-	void append_stage(Stage &);
-	void import(DataFile::Collection *, const std::string &);
-	void generate(Stage &, Mode);
-	bool optimize(Stage &);
+	/** Appends a module to the target, processing any imports found in it. */
+	void append_module(const Module &, ModuleCache &);
+
+	/** Appends a single stage to the matching stage of the target. */
+	void append_stage(const Stage &);
+
+	/// Imports a module by name and appends it to the target. */
+	void import(ModuleCache &, const std::string &);
+
+	/** Generates any implicitly defines syntactic structures and resolves
+	variables. */
+	void generate(Stage &);
+
+	template<typename T>
+	bool resolve(Stage &, unsigned &, unsigned);
+
+	/** Resolves various references between nodes.  Flags can be specified to
+	request resolving particular aspects.  Resolving may ripple into other
+	aspects as necessary. */
+	void resolve(Stage &, unsigned = RESOLVE_ALL);
+
+	/** Runs validators on a stage.  Diagnostic messages are recorded in the
+	stage for later inspection. */
+	void validate(Stage &);
+
+	/** Checks a stage's recorded diagnostics for errors.  If any are found,
+	returns true. */
+	bool check_errors(Stage &);
+
+	static bool diagnostic_line_order(const Diagnostic &, const Diagnostic &);
+
+	/** Applies optimizations to a stage.  The return value indicates which
+	stage should be optimized next. */
+	OptimizeResult optimize(Stage &);
+
+	/** Performs final adjustments on a stage after compilation. */
 	void finalize(Stage &, Mode);
+
 	static void inject_block(Block &, const Block &);
 };