feat: spirv can now optionally include path to original glsl file as well as debug information

Author: Silverlan

include/misc/glsl_to_spirv.h

@@ -32,6 +32,8 @@
 #include "misc/callbacks.h"
 #include "misc/debug.h"
 #include "misc/types.h"
+#include <string>
+#include <optional>
 #include <map>
 #include <memory>
 #include <sstream>
@@ -145,6 +147,9 @@ namespace Anvil
          /** Destructor. Releases all created Vulkan objects, as well as the SPIR-V blob data. */
          ~GLSLShaderToSPIRVGenerator();
 
+		 void set_glsl_file_path(const std::optional<std::string> &in_glsl_file_path) { m_glsl_file_path = in_glsl_file_path; }
+		 void set_with_debug_info(bool in_with_debug_info) { m_with_debug_info = in_with_debug_info; }
+
          /** Adds a "#define [definition_name] [value]" line after the first newline found in the
           *  source code.
           *
@@ -366,7 +371,7 @@ namespace Anvil
         bool bake_glsl_source_code() const;
 
         #ifdef ANVIL_LINK_WITH_GLSLANG
-            bool        bake_spirv_blob_by_calling_glslang(const char* in_body) const;
+            bool        bake_spirv_blob_by_calling_glslang(const char* in_body, const std::optional<std::string> &glslFilePath = {}, bool withDebugInfo = false) const;
             EShLanguage get_glslang_shader_stage          () const;
         #else
             bool bake_spirv_blob_by_spawning_glslang_process(const std::string& in_glsl_filename_with_path,
@@ -383,6 +388,8 @@ namespace Anvil
         #endif
 
         std::string m_data;
+		std::optional<std::string> m_glsl_file_path;
+		bool m_with_debug_info;
         Mode        m_mode;
 
         mutable std::string m_glsl_source_code;

src/misc/glsl_to_spirv.cpp

@@ -258,7 +258,9 @@ Anvil::GLSLShaderToSPIRVGenerator::GLSLShaderToSPIRVGenerator(const Anvil::BaseD
      m_glsl_source_code_dirty(true),
      m_mode                  (in_mode),
      m_shader_stage          (in_shader_stage),
-     m_spirv_version         (in_spirv_version)
+     m_spirv_version         (in_spirv_version),
+     m_glsl_file_path{},
+     m_with_debug_info{false}
 {
     #ifdef ANVIL_LINK_WITH_GLSLANG
     {
@@ -612,7 +614,7 @@ bool Anvil::GLSLShaderToSPIRVGenerator::bake_spirv_blob() const
         if (m_spirv_blob.size() == 0)
         {
             /* Need to bake a brand new SPIR-V blob */
-            result = bake_spirv_blob_by_calling_glslang(m_glsl_source_code.c_str() );
+            result = bake_spirv_blob_by_calling_glslang(m_glsl_source_code.c_str(), m_glsl_file_path, m_with_debug_info );
         }
     }
 
@@ -639,7 +641,7 @@ bool Anvil::GLSLShaderToSPIRVGenerator::bake_spirv_blob() const
      *
      *  @return true if successful, false otherwise.
      **/
-    bool Anvil::GLSLShaderToSPIRVGenerator::bake_spirv_blob_by_calling_glslang(const char* in_body) const
+    bool Anvil::GLSLShaderToSPIRVGenerator::bake_spirv_blob_by_calling_glslang(const char* in_body, const std::optional<std::string> &glslFilePath, bool withDebugInfo) const
     {
         const EShLanguage         glslang_shader_stage = get_glslang_shader_stage();
         glslang::TIntermediate*   intermediate_ptr     = nullptr;
@@ -669,8 +671,14 @@ bool Anvil::GLSLShaderToSPIRVGenerator::bake_spirv_blob() const
             glslang::EShTargetLanguageVersion spirv_version;
 
             /* Try to compile the shader */
-            new_shader_ptr->setStrings(&in_body,
-                                       1);
+			const char *path = nullptr;
+		    int numNames = 0;
+		    if(glslFilePath) {
+			    path = glslFilePath->c_str();
+			    numNames = 1;
+		    }
+		    int length = strlen(in_body);
+		    new_shader_ptr->setStringsWithLengthsAndNames(&in_body, &length, &path, numNames);
 
             switch (m_spirv_version)
             {
@@ -723,7 +731,7 @@ bool Anvil::GLSLShaderToSPIRVGenerator::bake_spirv_blob() const
             result = new_shader_ptr->parse(m_limits_ptr->get_resource_ptr(),
                                            110,   /* defaultVersion    */
                                            false, /* forwardCompatible */
-                                           (EShMessages) (EShMsgDefault | EShMsgSpvRules | EShMsgVulkanRules) );
+                                           (EShMessages) (EShMsgDefault | EShMsgSpvRules | EShMsgVulkanRules | EShMsgDebugInfo) );
 
             m_debug_info_log  = new_shader_ptr->getInfoDebugLog();
             m_shader_info_log = new_shader_ptr->getInfoLog();
@@ -765,8 +773,13 @@ bool Anvil::GLSLShaderToSPIRVGenerator::bake_spirv_blob() const
                 goto end;
             }
 
+			glslang::SpvOptions options {};
+		    if(withDebugInfo) {
+			    options.generateDebugInfo = true;
+			    options.stripDebugInfo = false;
+		    }
             glslang::GlslangToSpv(*intermediate_ptr,
-                                  spirv_blob);
+                                  spirv_blob, &options);
 
             if (spirv_blob.size() == 0)
             {