Merge branch 'string_literal' into hlsl-compiler-impl

Author: Erfan-Ahmadi

cmake/common.cmake

@@ -32,7 +32,7 @@ macro(nbl_create_executable_project _EXTRA_SOURCES _EXTRA_OPTIONS _EXTRA_INCLUDE
 	string(REGEX REPLACE "^[0-9]+\." "" EXECUTABLE_NAME ${EXECUTABLE_NAME})
 	string(TOLOWER ${EXECUTABLE_NAME} EXECUTABLE_NAME)
 	string(MAKE_C_IDENTIFIER ${EXECUTABLE_NAME} EXECUTABLE_NAME)
-
+	
 	project(${EXECUTABLE_NAME})
 
 	if(ANDROID)
@@ -676,7 +676,7 @@ function(NBL_UPDATE_SUBMODULES)
 		execute_process(COMMAND ${CMAKE_COMMAND} -E echo "All submodules are about to get updated and initialized in repository because NBL_UPDATE_GIT_SUBMODULE is turned ON!")
 		set(_NBL_UPDATE_SUBMODULES_CMD_NAME_ "nbl-update-submodules")
 		set(_NBL_UPDATE_SUBMODULES_CMD_FILE_ "${NBL_ROOT_PATH_BINARY}/${_NBL_UPDATE_SUBMODULES_CMD_NAME_}.cmd")
-		message(STATUS "test")
+		
 		if(NBL_UPDATE_GIT_SUBMODULE_INCLUDE_PRIVATE)
 			NBL_WRAPPER_COMMAND("" "" TRUE)
 		else()

examples_tests

@@ -9,75 +9,29 @@
 
 #include "BuildConfigOptions.h"
 
-#include <cstring>
-
+#include <string>
 #include <string_view>
-namespace nbl::builtin
-{
-    constexpr std::string_view PathPrefix = "nbl/builtin/";
-    constexpr bool hasPathPrefix(std::string_view str) { return str.find(PathPrefix) == 0ull; }
-}
 
-namespace nbl
-{
-namespace builtin
-{
-
-// if you attempt to use this without `NBL_EMBED_BUILTIN_RESOURCES_` CMake option, you will get loads of undefined references
-template<typename StringUniqueLiteralType>
-const std::pair<const uint8_t*, size_t> get_resource();
+#include "nbl/core/string/StringLiteral.h"
 
+namespace nbl::builtin
+{
+	
+constexpr std::string_view PathPrefix = "nbl/builtin/";
+constexpr bool hasPathPrefix(std::string_view str) { return str.find(PathPrefix) == 0ull; }
+	
 // if you attempt to use this without `NBL_EMBED_BUILTIN_RESOURCES_` CMake option, this will always return `{nullptr,0ull}`
 std::pair<const uint8_t*,size_t> get_resource_runtime(const std::string&);
 
-}
-}
-
 #ifndef _NBL_EMBED_BUILTIN_RESOURCES_
-
 #define _NBL_BUILTIN_PATH_AVAILABLE
-namespace nbl
-{
-namespace builtin
+constexpr std::string_view getBuiltinResourcesDirectoryPath()
 {
-
-// TODO: move this compile time string stuff somewhere relevant
-namespace impl
-{
-    template<std::size_t Pos, std::size_t Len, std::size_t N>
-    constexpr std::size_t substrlen()
-    {
-        constexpr auto PossibleLen = Pos<N ? (N-Pos):0u;
-        return Len<PossibleLen ? Len:PossibleLen;
-    }
-
-    template <typename C, std::size_t N, std::size_t...Is>
-    constexpr std::array<C,sizeof...(Is)+1ull> truncate(const C* s, std::index_sequence<Is...>)
-    {
-	    return {(Is < N ? s[Is] : 0)..., 0};
-    }
-}
-
-template<typename C, std::size_t N>
-constexpr std::size_t strlen(const C(&s)[N])
-{
-    return N;
-}
-
-template<std::size_t Pos, std::size_t Len, typename C, std::size_t N>
-constexpr std::array<C,impl::substrlen<Pos,Len,N>()+1ull> substr(const C(&s)[N])
-{
-    constexpr auto len = impl::substrlen<Pos,Len,N>();
-    return impl::truncate<C,len>(s+Pos,std::make_index_sequence<len>{});
-}
-
-inline std::string getBuiltinResourcesDirectoryPath()
-{
-    return builtin::substr<0ull,builtin::strlen(__FILE__)-builtin::strlen("common.h")>(__FILE__).data();
+    std::string_view retval = __FILE__;
+    retval.remove_suffix(std::string_view("common.h").size());
+    return retval;
 }
+#endif
 
-}
 }
 #endif
-
-#endif

include/nbl/builtin/common.h

@@ -60,7 +60,7 @@
 #include "nbl/core/parallel/unlock_guard.h"
 // string
 #include "nbl/core/string/stringutil.h"
-#include "nbl/core/string/UniqueStringLiteralType.h"
+#include "nbl/core/string/StringLiteral.h"
 // other useful things
 #include "nbl/core/SingleEventHandler.h"
 #include "nbl/core/EventDeferredHandler.h"

include/nbl/core/declarations.h

@@ -0,0 +1,26 @@
+// Copyright (C) 2022 - DevSH Graphics Programming Sp. z O.O.
+// This file is part of the "Nabla Engine".
+// For conditions of distribution and use, see copyright notice in nabla.h
+#ifndef _NBL_CORE_STRING_LITERAL_H_INCLUDED_
+#define _NBL_CORE_STRING_LITERAL_H_INCLUDED_
+
+namespace nbl::core
+{
+
+template<size_t N>
+struct StringLiteral
+{
+    constexpr StringLiteral(const char (&str)[N])
+    {
+        std::copy_n(str, N, value);
+    }
+
+    char value[N];
+};
+
+}
+
+// for compatibility's sake
+#define NBL_CORE_UNIQUE_STRING_LITERAL_TYPE(STRING_LITERAL) nbl::core::StringLiteral(STRING_LITERAL)
+
+#endif // _NBL_CORE_STRING_LITERAL_H_INCLUDED_

include/nbl/core/string/StringLiteral.h

@@ -487,16 +487,16 @@ class NBL_API ICullingLoDSelectionSystem : public virtual core::IReferenceCounte
 				return nullptr;
 
 			using shader_source_and_path = std::pair<core::smart_refctd_ptr<asset::ICPUShader>,system::path>;
-			auto getShader = [device](auto uniqueString) -> shader_source_and_path
+			auto getShader = [device]<core::StringLiteral Path>() -> shader_source_and_path
 			{
 				auto system = device->getPhysicalDevice()->getSystem();
-				auto glslFile = system->loadBuiltinData<decltype(uniqueString)>(); 
+				auto glslFile = system->loadBuiltinData<Path>();
 				core::smart_refctd_ptr<asset::ICPUBuffer> glsl;
 				{
 					glsl = core::make_smart_refctd_ptr<asset::ICPUBuffer>(glslFile->getSize());
 					memcpy(glsl->getPointer(), glslFile->getMappedPointer(), glsl->getSize());
 				}
-				return {core::make_smart_refctd_ptr<asset::ICPUShader>(std::move(glsl), asset::IShader::ESS_COMPUTE, asset::IShader::E_CONTENT_TYPE::ECT_GLSL, decltype(uniqueString)::value), decltype(uniqueString)::value};
+				return {core::make_smart_refctd_ptr<asset::ICPUShader>(std::move(glsl), asset::IShader::ESS_COMPUTE, asset::IShader::E_CONTENT_TYPE::ECT_GLSL, Path.value), Path.value};
 			};
 			auto overrideShader = [device,&cwdForShaderCompilation,workgroupSize,_scanner](shader_source_and_path&& baseShader, std::string additionalCode)
 			{
@@ -515,7 +515,7 @@ class NBL_API ICullingLoDSelectionSystem : public virtual core::IReferenceCounte
 
 			const std::string workgroupSizeDef = "\n#define _NBL_GLSL_WORKGROUP_SIZE_ _NBL_GLSL_CULLING_LOD_SELECTION_CULL_WORKGROUP_SIZE_\n";
 
-			auto firstShader = getShader(NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("nbl/builtin/glsl/culling_lod_selection/instance_cull_and_lod_select.comp")());
+			auto firstShader = getShader.operator()<core::StringLiteral("nbl/builtin/glsl/culling_lod_selection/instance_cull_and_lod_select.comp")>();
 			auto instanceCullAndLoDSelect = device->createComputePipeline(
 				nullptr,core::smart_refctd_ptr(instanceCullAndLoDSelectLayout),
 				overrideShader(std::move(firstShader),workgroupSizeDef+perViewPerInstanceDefinition+cullAndLoDSelectFuncDefinitions)
@@ -533,7 +533,7 @@ class NBL_API ICullingLoDSelectionSystem : public virtual core::IReferenceCounte
 
 			auto instanceDrawCull = device->createComputePipeline(
 				nullptr,core::smart_refctd_ptr(instanceDrawCullLayout),
-				overrideShader(getShader(NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("nbl/builtin/glsl/culling_lod_selection/instance_draw_cull.comp")()),workgroupSizeDef+perViewPerInstanceDefinition)
+				overrideShader(getShader.operator()<core::StringLiteral("nbl/builtin/glsl/culling_lod_selection/instance_draw_cull.comp")>(),workgroupSizeDef+perViewPerInstanceDefinition)
 			);
 
 			auto drawInstanceCountPrefixSum = device->createComputePipeline(
@@ -548,7 +548,7 @@ class NBL_API ICullingLoDSelectionSystem : public virtual core::IReferenceCounte
 			);
 			auto instanceRefCountingSortScatter = device->createComputePipeline(
 				nullptr,core::smart_refctd_ptr(instanceRefCountingSortPipelineLayout),
-				overrideShader(getShader(NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("nbl/builtin/glsl/culling_lod_selection/instance_ref_counting_sort_scatter.comp")()),workgroupSizeDef)
+				overrideShader(getShader.operator()<core::StringLiteral("nbl/builtin/glsl/culling_lod_selection/instance_ref_counting_sort_scatter.comp")>(),workgroupSizeDef)
 			);
 
 			//auto drawCompact = ?;

include/nbl/core/string/UniqueStringLiteralType.h

@@ -106,9 +106,9 @@ class NBL_API ITransformTreeManager : public virtual core::IReferenceCounted
 		{
 			auto device = utils->getLogicalDevice();
 			auto system = device->getPhysicalDevice()->getSystem();
-			auto createShader = [&system,&device](auto uniqueString, asset::IShader::E_SHADER_STAGE type=asset::IShader::ESS_COMPUTE) -> core::smart_refctd_ptr<video::IGPUSpecializedShader>
+			auto createShader = [&system,&device]<core::StringLiteral Path>(asset::IShader::E_SHADER_STAGE type=asset::IShader::ESS_COMPUTE) -> core::smart_refctd_ptr<video::IGPUSpecializedShader>
 			{
-				auto glslFile = system->loadBuiltinData<decltype(uniqueString)>();
+				auto glslFile = system->loadBuiltinData<Path>();
 				core::smart_refctd_ptr<asset::ICPUBuffer> glsl;
 				{
 					glsl = core::make_smart_refctd_ptr<asset::ICPUBuffer>(glslFile->getSize());
@@ -118,11 +118,11 @@ class NBL_API ITransformTreeManager : public virtual core::IReferenceCounted
 				return device->createSpecializedShader(shader.get(),{nullptr,nullptr,"main"});
 			};
 
-			auto updateRelativeSpec = createShader(NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("nbl/builtin/glsl/transform_tree/relative_transform_update.comp")());
-			auto recomputeGlobalSpec = createShader(NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("nbl/builtin/glsl/transform_tree/global_transform_update.comp")());
-			auto recomputeGlobalAndNormalSpec = createShader(NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("nbl/builtin/glsl/transform_tree/global_transform_and_normal_matrix_update.comp")());
-			auto debugDrawVertexSpec = createShader(NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("nbl/builtin/glsl/transform_tree/debug.vert")(),asset::IShader::ESS_VERTEX);
-			auto debugDrawFragmentSpec = createShader(NBL_CORE_UNIQUE_STRING_LITERAL_TYPE("nbl/builtin/material/debug/vertex_normal/specialized_shader.frag")(),asset::IShader::ESS_FRAGMENT);
+			auto updateRelativeSpec = createShader.operator()<core::StringLiteral("nbl/builtin/glsl/transform_tree/relative_transform_update.comp")>();
+			auto recomputeGlobalSpec = createShader.operator()<core::StringLiteral("nbl/builtin/glsl/transform_tree/global_transform_update.comp")>();
+			auto recomputeGlobalAndNormalSpec = createShader.operator()<core::StringLiteral("nbl/builtin/glsl/transform_tree/global_transform_and_normal_matrix_update.comp")>();
+			auto debugDrawVertexSpec = createShader.operator()<core::StringLiteral("nbl/builtin/glsl/transform_tree/debug.vert")>(asset::IShader::ESS_VERTEX);
+			auto debugDrawFragmentSpec = createShader.operator()<core::StringLiteral("nbl/builtin/material/debug/vertex_normal/specialized_shader.frag")>(asset::IShader::ESS_FRAGMENT);
 			if (!updateRelativeSpec || !recomputeGlobalSpec || !recomputeGlobalAndNormalSpec || !debugDrawVertexSpec || !debugDrawFragmentSpec)
 				return nullptr;