Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend enum value alias handling. #2004

Merged
merged 1 commit into from
Dec 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 59 additions & 40 deletions VulkanHppGenerator.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1048,7 +1048,7 @@ void VulkanHppGenerator::checkCommandCorrectness() const
resultCodes.insert( rc.name );
for ( auto ac : rc.aliases )
{
resultCodes.insert( ac.first );
resultCodes.insert( ac.name );
}
}
// some special handling needed for vulkansc!!
Expand Down Expand Up @@ -1450,9 +1450,9 @@ void VulkanHppGenerator::checkStructCorrectness() const
}
else
{
checkForError( !enumValue.supported || ( sTypeValues.erase( enumValue.name ) == 1 ),
enumValue.xmlLine,
"VkStructureType enum value <" + enumValue.name + "> never used" );
checkForWarning( !enumValue.supported || ( sTypeValues.erase( enumValue.name ) == 1 ),
enumValue.xmlLine,
"VkStructureType enum value <" + enumValue.name + "> never used" );
}
}
assert( sTypeValues.empty() );
Expand Down Expand Up @@ -1665,8 +1665,12 @@ std::string VulkanHppGenerator::combineDataTypes( std::map<size_t, VectorParamDa

bool VulkanHppGenerator::contains( std::vector<EnumValueData> const & enumValues, std::string const & name ) const
{
return std::any_of(
enumValues.begin(), enumValues.end(), [&name]( EnumValueData const & ev ) { return ( ev.name == name ) || ev.aliases.contains( name ); } );
return std::any_of( enumValues.begin(),
enumValues.end(),
[&name]( EnumValueData const & ev ) {
return ( ev.name == name ) ||
std::any_of( ev.aliases.begin(), ev.aliases.end(), [&name]( auto const & eav ) { return eav.name == name; } );
} );
}

bool VulkanHppGenerator::containsArray( std::string const & type ) const
Expand Down Expand Up @@ -2185,15 +2189,12 @@ void VulkanHppGenerator::distributeEnumValueAliases()
valueIt = findByName( e.second.values, aliasIt->alias );
}
checkForError( valueIt != e.second.values.end(), a.xmlLine, "enum value alias <" + a.name + "> aliases non-existent enum value <" + a.alias + ">" );
if ( a.supported && valueIt->supported )
{
// only supported enum values need to be kept!
checkForError(
a.protect == valueIt->protect, a.xmlLine, "enum value alias <" + a.name + "> aliases enum value <" + a.alias + "> with different properties" );
checkForError( valueIt->aliases.insert( { a.name, a.xmlLine } ).second,
a.xmlLine,
"enum value alias <" + a.name + "> already contained as alias for enum value <" + a.alias + ">" );
}
checkForError(
a.protect == valueIt->protect, a.xmlLine, "enum value alias <" + a.name + "> aliases enum value <" + a.alias + "> with different properties" );
checkForError( std::none_of( valueIt->aliases.begin(), valueIt->aliases.end(), [&a]( auto const & eav ) { return a.name == eav.name; } ),
a.xmlLine,
"enum value alias <" + a.name + "> already contained as alias for enum value <" + a.alias + ">" );
valueIt->aliases.push_back( a );
}
e.second.valueAliases.clear();
}
Expand Down Expand Up @@ -6988,33 +6989,40 @@ std::string VulkanHppGenerator::generateEnum( std::pair<std::string, EnumData> c

for ( auto const & valueAlias : value.aliases )
{
std::string enumName = enumData.first;
for ( auto aliasIt = enumData.second.aliases.begin(); ( aliasIt != enumData.second.aliases.end() ) && ( enumName == enumData.first ); ++aliasIt )
// only generate supported aliases
if ( valueAlias.supported )
{
auto enumAliasIt = enumData.second.aliases.begin();
std::string enumTag = findTag( enumData.first );
std::string aliasTag = findTag( enumAliasIt->first );
std::string valueTag = findTag( valueAlias.first );
if ( ( stripPostfix( enumData.first, enumTag ) == stripPostfix( enumAliasIt->first, aliasTag ) ) && ( aliasTag == valueTag ) )
std::string enumName = enumData.first;
for ( auto aliasIt = enumData.second.aliases.begin(); ( aliasIt != enumData.second.aliases.end() ) && ( enumName == enumData.first ); ++aliasIt )
{
enumName = enumAliasIt->first;
auto enumAliasIt = enumData.second.aliases.begin();
std::string enumTag = findTag( enumData.first );
std::string aliasTag = findTag( enumAliasIt->first );
std::string valueTag = findTag( valueAlias.name );
if ( ( stripPostfix( enumData.first, enumTag ) == stripPostfix( enumAliasIt->first, aliasTag ) ) && ( aliasTag == valueTag ) )
{
enumName = enumAliasIt->first;
}
}
}

std::string aliasName = generateEnumValueName( enumName, valueAlias.first, enumData.second.isBitmask );
auto [mapIt, inserted] = valueToNameMap.insert( { aliasName, valueAlias.first } );
if ( inserted )
{
enumValues += " " + aliasName + " = " + valueAlias.first + ",\n";
}
else
{
// some aliases are so close to the original, that no new entry can be generated!
assert( mapIt->second != valueAlias.first );
checkForError( ( mapIt->second == value.name ) || value.aliases.contains( mapIt->second ),
valueAlias.second,
"generated enum alias value name <" + aliasName + ">, generated from <" + valueAlias.first +
"> is already generated from different enum value <" + mapIt->second + ">" );
std::string aliasName = generateEnumValueName( enumName, valueAlias.name, enumData.second.isBitmask );
std::map<std::string, std::string>::const_iterator mapIt;
bool inserted;
std::tie( mapIt, inserted ) = valueToNameMap.insert( { aliasName, valueAlias.name } );
if ( inserted )
{
enumValues += " " + aliasName + " = " + valueAlias.name + ",\n";
}
else
{
// some aliases are so close to the original, that no new entry can be generated!
assert( mapIt->second != valueAlias.name );
checkForError( ( mapIt->second == value.name ) ||
std::any_of( value.aliases.begin(), value.aliases.end(), [mapIt]( auto const & eav ) { return eav.name == mapIt->second; } ),
valueAlias.xmlLine,
"generated enum alias value name <" + aliasName + ">, generated from <" + valueAlias.name +
"> is already generated from different enum value <" + mapIt->second + ">" );
}
}
}

Expand Down Expand Up @@ -16615,9 +16623,15 @@ void VulkanHppGenerator::EnumData::addEnumValue(
}
else if ( supported ) // only for supported enum values, we need to check for consistency!
{
checkForError( ( bitpos == valueIt->bitpos ) && ( protect == valueIt->protect ) && ( supported == valueIt->supported ) && ( value == valueIt->value ),
checkForError( ( bitpos == valueIt->bitpos ) && ( protect == valueIt->protect ) && ( value == valueIt->value ),
line,
"enum value <" + name + "> already listed with different properties" );
// if a previous version was not supported, make it supported now
if ( !valueIt->supported )
{
valueIt->supported = true;
valueIt->xmlLine = line;
}
}
}

Expand Down Expand Up @@ -16674,7 +16688,12 @@ namespace
template <typename T>
typename std::vector<T>::const_iterator findByNameOrAlias( std::vector<T> const & values, std::string const & name )
{
return std::find_if( values.begin(), values.end(), [&name]( T const & value ) { return ( value.name == name ) || value.aliases.contains( name ); } );
return std::find_if( values.begin(),
values.end(),
[&name]( T const & value ) {
return ( value.name == name ) ||
std::any_of( value.aliases.begin(), value.aliases.end(), [&name]( auto const & eav ) { return eav.name == name; } );
} );
}

template <typename T>
Expand Down
16 changes: 8 additions & 8 deletions VulkanHppGenerator.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -145,14 +145,14 @@ class VulkanHppGenerator

struct EnumValueData
{
std::map<std::string, int> aliases = {};
std::string bitpos = {};
bool deprecated = {};
std::string name = {};
std::string protect = {};
bool supported = {};
std::string value = {};
int xmlLine = {};
std::vector<EnumValueAlias> aliases = {};
std::string bitpos = {};
bool deprecated = {};
std::string name = {};
std::string protect = {};
bool supported = {};
std::string value = {};
int xmlLine = {};
};

struct EnumData
Expand Down
10 changes: 5 additions & 5 deletions vulkan/vulkan_enums.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -256,8 +256,8 @@ namespace VULKAN_HPP_NAMESPACE
eErrorInvalidDeviceAddressEXT = VK_ERROR_INVALID_DEVICE_ADDRESS_EXT,
eErrorInvalidOpaqueCaptureAddressKHR = VK_ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS_KHR,
ePipelineCompileRequired = VK_PIPELINE_COMPILE_REQUIRED,
eErrorPipelineCompileRequiredEXT = VK_ERROR_PIPELINE_COMPILE_REQUIRED_EXT,
ePipelineCompileRequiredEXT = VK_PIPELINE_COMPILE_REQUIRED_EXT,
eErrorPipelineCompileRequiredEXT = VK_ERROR_PIPELINE_COMPILE_REQUIRED_EXT,
eErrorSurfaceLostKHR = VK_ERROR_SURFACE_LOST_KHR,
eErrorNativeWindowInUseKHR = VK_ERROR_NATIVE_WINDOW_IN_USE_KHR,
eSuboptimalKHR = VK_SUBOPTIMAL_KHR,
Expand Down Expand Up @@ -412,8 +412,8 @@ namespace VULKAN_HPP_NAMESPACE
ePhysicalDeviceMultiviewProperties = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_PROPERTIES,
ePhysicalDeviceMultiviewPropertiesKHR = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_PROPERTIES_KHR,
ePhysicalDeviceVariablePointersFeatures = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VARIABLE_POINTERS_FEATURES,
ePhysicalDeviceVariablePointersFeaturesKHR = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VARIABLE_POINTERS_FEATURES_KHR,
ePhysicalDeviceVariablePointerFeatures = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VARIABLE_POINTER_FEATURES,
ePhysicalDeviceVariablePointersFeaturesKHR = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VARIABLE_POINTERS_FEATURES_KHR,
ePhysicalDeviceVariablePointerFeaturesKHR = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VARIABLE_POINTER_FEATURES_KHR,
eProtectedSubmitInfo = VK_STRUCTURE_TYPE_PROTECTED_SUBMIT_INFO,
ePhysicalDeviceProtectedMemoryFeatures = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PROTECTED_MEMORY_FEATURES,
Expand Down Expand Up @@ -494,8 +494,8 @@ namespace VULKAN_HPP_NAMESPACE
ePhysicalDeviceShaderAtomicInt64Features = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ATOMIC_INT64_FEATURES,
ePhysicalDeviceShaderAtomicInt64FeaturesKHR = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_ATOMIC_INT64_FEATURES_KHR,
ePhysicalDeviceShaderFloat16Int8Features = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_FLOAT16_INT8_FEATURES,
ePhysicalDeviceFloat16Int8FeaturesKHR = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FLOAT16_INT8_FEATURES_KHR,
ePhysicalDeviceShaderFloat16Int8FeaturesKHR = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_FLOAT16_INT8_FEATURES_KHR,
ePhysicalDeviceFloat16Int8FeaturesKHR = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FLOAT16_INT8_FEATURES_KHR,
ePhysicalDeviceFloatControlsProperties = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FLOAT_CONTROLS_PROPERTIES,
ePhysicalDeviceFloatControlsPropertiesKHR = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FLOAT_CONTROLS_PROPERTIES_KHR,
eDescriptorSetLayoutBindingFlagsCreateInfo = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_BINDING_FLAGS_CREATE_INFO,
Expand Down Expand Up @@ -3443,9 +3443,9 @@ namespace VULKAN_HPP_NAMESPACE
eStore = VK_ATTACHMENT_STORE_OP_STORE,
eDontCare = VK_ATTACHMENT_STORE_OP_DONT_CARE,
eNone = VK_ATTACHMENT_STORE_OP_NONE,
eNoneEXT = VK_ATTACHMENT_STORE_OP_NONE_EXT,
eNoneKHR = VK_ATTACHMENT_STORE_OP_NONE_KHR,
eNoneQCOM = VK_ATTACHMENT_STORE_OP_NONE_QCOM
eNoneQCOM = VK_ATTACHMENT_STORE_OP_NONE_QCOM,
eNoneEXT = VK_ATTACHMENT_STORE_OP_NONE_EXT
};

enum class DependencyFlagBits : VkDependencyFlags
Expand Down