Merge pull request #1146 from KhronosGroup/strong-types

Introduce stronger types for the SPIR-V ID in C++ API

Author: HansKristian-Work

CMakeLists.txt

@@ -465,6 +465,10 @@ if (SPIRV_CROSS_CLI)
 				target_link_libraries(spirv-cross-msl-ycbcr-conversion-test spirv-cross-c)
 				set_target_properties(spirv-cross-msl-ycbcr-conversion-test PROPERTIES LINK_FLAGS "${spirv-cross-link-flags}")
 
+				add_executable(spirv-cross-typed-id-test tests-other/typed_id_test.cpp)
+				target_link_libraries(spirv-cross-typed-id-test spirv-cross-core)
+				set_target_properties(spirv-cross-typed-id-test PROPERTIES LINK_FLAGS "${spirv-cross-link-flags}")
+
 				if (CMAKE_COMPILER_IS_GNUCXX OR (${CMAKE_CXX_COMPILER_ID} MATCHES "Clang"))
 					target_compile_options(spirv-cross-c-api-test PRIVATE -std=c89 -Wall -Wextra)
 				endif()
@@ -483,6 +487,8 @@ if (SPIRV_CROSS_CLI)
 						COMMAND $<TARGET_FILE:spirv-cross-msl-ycbcr-conversion-test> ${CMAKE_CURRENT_SOURCE_DIR}/tests-other/msl_ycbcr_conversion_test.spv)
 				add_test(NAME spirv-cross-msl-ycbcr-conversion-test-2
 						COMMAND $<TARGET_FILE:spirv-cross-msl-ycbcr-conversion-test> ${CMAKE_CURRENT_SOURCE_DIR}/tests-other/msl_ycbcr_conversion_test_2.spv)
+				add_test(NAME spirv-cross-typed-id-test
+						COMMAND $<TARGET_FILE:spirv-cross-typed-id-test>)
 				add_test(NAME spirv-cross-test
 						COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/test_shaders.py --parallel
 						${spirv-cross-externals}

main.cpp

@@ -246,7 +246,7 @@ static void print_resources(const Compiler &compiler, const char *tag, const Sma
 		                compiler.get_decoration_bitset(type.self).get(DecorationBufferBlock);
 		bool is_sized_block = is_block && (compiler.get_storage_class(res.id) == StorageClassUniform ||
 		                                   compiler.get_storage_class(res.id) == StorageClassUniformConstant);
-		uint32_t fallback_id = !is_push_constant && is_block ? res.base_type_id : res.id;
+		ID fallback_id = !is_push_constant && is_block ? ID(res.base_type_id) : ID(res.id);
 
 		uint32_t block_size = 0;
 		uint32_t runtime_array_stride = 0;
@@ -268,7 +268,7 @@ static void print_resources(const Compiler &compiler, const char *tag, const Sma
 		for (auto arr : type.array)
 			array = join("[", arr ? convert_to_string(arr) : "", "]") + array;
 
-		fprintf(stderr, " ID %03u : %s%s", res.id,
+		fprintf(stderr, " ID %03u : %s%s", uint32_t(res.id),
 		        !res.name.empty() ? res.name.c_str() : compiler.get_fallback_name(fallback_id).c_str(), array.c_str());
 
 		if (mask.get(DecorationLocation))
@@ -442,7 +442,7 @@ static void print_spec_constants(const Compiler &compiler)
 	fprintf(stderr, "Specialization constants\n");
 	fprintf(stderr, "==================\n\n");
 	for (auto &c : spec_constants)
-		fprintf(stderr, "ID: %u, Spec ID: %u\n", c.id, c.constant_id);
+		fprintf(stderr, "ID: %u, Spec ID: %u\n", uint32_t(c.id), c.constant_id);
 	fprintf(stderr, "==================\n\n");
 }
 

spirv_cfg.cpp

@@ -237,13 +237,13 @@ uint32_t CFG::find_loop_dominator(uint32_t block_id) const
 		for (auto &pred : itr->second)
 		{
 			auto &pred_block = compiler.get<SPIRBlock>(pred);
-			if (pred_block.merge == SPIRBlock::MergeLoop && pred_block.merge_block == block_id)
+			if (pred_block.merge == SPIRBlock::MergeLoop && pred_block.merge_block == ID(block_id))
 			{
 				pred_block_id = pred;
 				ignore_loop_header = true;
 				break;
 			}
-			else if (pred_block.merge == SPIRBlock::MergeSelection && pred_block.next_block == block_id)
+			else if (pred_block.merge == SPIRBlock::MergeSelection && pred_block.next_block == ID(block_id))
 			{
 				pred_block_id = pred;
 				break;
@@ -268,14 +268,14 @@ uint32_t CFG::find_loop_dominator(uint32_t block_id) const
 	return block_id;
 }
 
-bool CFG::node_terminates_control_flow_in_sub_graph(uint32_t from, uint32_t to) const
+bool CFG::node_terminates_control_flow_in_sub_graph(BlockID from, BlockID to) const
 {
 	// Walk backwards, starting from "to" block.
 	// Only follow pred edges if they have a 1:1 relationship, or a merge relationship.
 	// If we cannot find a path to "from", we must assume that to is inside control flow in some way.
 
 	auto &from_block = compiler.get<SPIRBlock>(from);
-	uint32_t ignore_block_id = 0;
+	BlockID ignore_block_id = 0;
 	if (from_block.merge == SPIRBlock::MergeLoop)
 		ignore_block_id = from_block.merge_block;
 

spirv_cfg.hpp

@@ -97,7 +97,7 @@ class CFG
 
 	uint32_t find_loop_dominator(uint32_t block) const;
 
-	bool node_terminates_control_flow_in_sub_graph(uint32_t from, uint32_t to) const;
+	bool node_terminates_control_flow_in_sub_graph(BlockID from, BlockID to) const;
 
 private:
 	struct VisitOrder