fix CHLSLCompiler - move RequiredArguments into private section and expose public getter. Update sources accordingly, explain in the comment why you cannot keep such data symbols in public section. Add missing L"-HV", L"202x" arguments to RequiredArguments

Author: AnastaZIuk

include/nbl/asset/utils/CHLSLCompiler.h

@@ -54,18 +54,11 @@ class NBL_API2 CHLSLCompiler final : public IShaderCompiler
 		std::string preprocessShader(std::string&& code, IShader::E_SHADER_STAGE& stage, const SPreprocessorOptions& preprocessOptions, std::vector<std::string>& dxc_compile_flags_override, std::vector<CCache::SEntry::SPreprocessingDependency>* dependencies = nullptr) const;
 
 		void insertIntoStart(std::string& code, std::ostringstream&& ins) const override;
-		constexpr static inline const wchar_t* RequiredArguments[] = { // TODO: and if dxcOptions is span of std::string then why w_chars there? https://en.cppreference.com/w/cpp/string/basic_string
-			L"-spirv",
-			L"-Zpr",
-			L"-enable-16bit-types",
-			L"-fvk-use-scalar-layout",
-			L"-Wno-c++11-extensions",
-			L"-Wno-c++1z-extensions",
-			L"-Wno-c++14-extensions",
-			L"-Wno-gnu-static-float-init",
-			L"-fspv-target-env=vulkan1.3"
-		};
-		constexpr static inline uint32_t RequiredArgumentCount = sizeof(RequiredArguments) / sizeof(RequiredArguments[0]);
+		
+		static constexpr auto getRequiredArguments() //! returns required arguments for the compiler's backend
+		{
+			return std::span(RequiredArguments);
+		}
 
 	protected:
 		// This can't be a unique_ptr due to it being an undefined type 
@@ -81,6 +74,23 @@ class NBL_API2 CHLSLCompiler final : public IShaderCompiler
 				ret.setCommonData(options);
 			return ret;
 		}
+
+	private:
+		// we cannot have PUBLIC data symbol in header we do export - endpoint application will fail on linker with delayed DLL loading mechanism (thats why we trick it with private member hidden from the export + provide exported getter)
+		// https://learn.microsoft.com/en-us/previous-versions/w59k653y(v=vs.100)?redirectedfrom=MSDN
+		constexpr static inline auto RequiredArguments = std::to_array<const wchar_t*> // TODO: and if dxcOptions is span of std::string then why w_chars there? https://en.cppreference.com/w/cpp/string/basic_string
+		({ 
+			L"-spirv",
+			L"-Zpr",
+			L"-enable-16bit-types",
+			L"-fvk-use-scalar-layout",
+			L"-Wno-c++11-extensions",
+			L"-Wno-c++1z-extensions",
+			L"-Wno-c++14-extensions",
+			L"-Wno-gnu-static-float-init",
+			L"-fspv-target-env=vulkan1.3",
+			L"-HV", L"202x"
+		});
 };
 
 }

src/nbl/asset/utils/CHLSLCompiler.cpp

@@ -211,12 +211,15 @@ static void add_required_arguments_if_not_present(std::vector<std::wstring>& arg
     auto set = std::unordered_set<std::wstring>();
     for (int i = 0; i < arguments.size(); i++)
         set.insert(arguments[i]);
-    for (int j = 0; j < CHLSLCompiler::RequiredArgumentCount; j++)
+
+    const auto required = CHLSLCompiler::getRequiredArguments();
+
+    for (int j = 0; j < required.size(); j++)
     {
-        bool missing = set.find(CHLSLCompiler::RequiredArguments[j]) == set.end();
+        bool missing = set.find(required[j]) == set.end();
         if (missing) {
-            logger.log("Compile flag error: Required compile flag not found %ls. This flag will be force enabled, as it is required by Nabla.", system::ILogger::ELL_WARNING, CHLSLCompiler::RequiredArguments[j]);
-            arguments.push_back(CHLSLCompiler::RequiredArguments[j]);
+            logger.log("Compile flag error: Required compile flag not found %ls. This flag will be force enabled, as it is required by Nabla.", system::ILogger::ELL_WARNING, required[j]);
+            arguments.push_back(required[j]);
         }
     }
 }
@@ -397,9 +400,10 @@ core::smart_refctd_ptr<ICPUShader> CHLSLCompiler::compileToSPIRV_impl(const std:
         populate_arguments_with_type_conversion(arguments, hlslOptions.dxcOptions, logger);
     }
     else { // lastly default arguments
+        const auto required = CHLSLCompiler::getRequiredArguments();
         arguments = {};
-        for (size_t i = 0; i < RequiredArgumentCount; i++)
-            arguments.push_back(RequiredArguments[i]);
+        for (size_t i = 0; i < required.size(); i++)
+            arguments.push_back(required[i]);
         arguments.push_back(L"-HV");
         arguments.push_back(L"202x");
         // TODO: add this to `CHLSLCompiler::SOptions` and handle it properly in `dxc_compile_flags.empty()`
@@ -479,5 +483,4 @@ void CHLSLCompiler::insertIntoStart(std::string& code, std::ostringstream&& ins)
     code.insert(0u, ins.str());
 }
 
-
 #endif

src/nbl/ext/ImGui/ImGui.cpp

@@ -3,6 +3,8 @@
 #include <ranges>
 #include <vector>
 #include <utility>
+#include <locale>
+#include <codecvt>
 
 #include "nbl/system/CStdoutLogger.h"
 #include "nbl/ext/ImGui/ImGui.h"
@@ -181,19 +183,34 @@ namespace nbl::ext::imgui
 
 				auto compileToSPIRV = [&]() -> smart_refctd_ptr<ICPUShader>
 				{
-					#define NBL_DEFAULT_OPTIONS "-spirv", "-Zpr", "-enable-16bit-types", "-fvk-use-scalar-layout", "-Wno-c++11-extensions", "-Wno-c++1z-extensions", "-Wno-c++14-extensions", "-Wno-gnu-static-float-init", "-fspv-target-env=vulkan1.3", "-HV", "202x" /* default required params, just to not throw warnings */
+					auto toOptions = []<uint32_t N>(const std::array<std::string_view, N>& in) // options must be alive till compileToSPIRV ends
+					{
+						const auto required = CHLSLCompiler::getRequiredArguments();
+						std::array<std::string, required.size() + N> options;
+
+						std::wstring_convert<std::codecvt_utf8<wchar_t>> converter;
+						for (uint32_t i = 0; i < required.size(); ++i)
+							options[i] = converter.to_bytes(required[i]); // meh
+
+						uint32_t offset = required.size();
+						for (const auto& opt : in)
+							options[offset++] = std::string(opt);
+
+						return options;
+					};
+
 					const std::string_view code (reinterpret_cast<const char*>(shader->getContent()->getPointer()), shader->getContent()->getSize());
 
 					if constexpr (stage == IShader::E_SHADER_STAGE::ESS_VERTEX)
 					{
-						const auto VERTEX_COMPILE_OPTIONS = std::to_array<std::string>({NBL_DEFAULT_OPTIONS, "-T", "vs_6_7", "-E", "VSMain", "-O3"});
+						const auto VERTEX_COMPILE_OPTIONS = toOptions(std::to_array<std::string_view>({ "-T", "vs_6_7", "-E", "VSMain", "-O3" }));
 						options.dxcOptions = VERTEX_COMPILE_OPTIONS;
 
 						return compiler->compileToSPIRV(code.data(), options); // we good here - no code patching
 					}
 					else if (stage == IShader::E_SHADER_STAGE::ESS_FRAGMENT)
 					{
-						const auto FRAGMENT_COMPILE_OPTIONS = std::to_array<std::string>({NBL_DEFAULT_OPTIONS, "-T", "ps_6_7", "-E", "PSMain", "-O3"});
+						const auto FRAGMENT_COMPILE_OPTIONS = toOptions(std::to_array<std::string_view>({ "-T", "ps_6_7", "-E", "PSMain", "-O3" }));
 						options.dxcOptions = FRAGMENT_COMPILE_OPTIONS;
 
 						std::stringstream stream;