mirror/Vulkan-Hpp
1
0
Fork 0
mirror of https://github.com/KhronosGroup/Vulkan-Hpp.git synced 2024-10-14 16:32:17 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Simplified handling of struct aliases (#1858)

Browse Source
This commit is contained in:
Andreas Süßenbach 2024-05-02 09:28:44 +02:00 committed by GitHub
parent da28afe109
commit 48b5595082
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 39 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
VulkanHppGenerator.cpp
View File

@ -1450,11 +1450,6 @@ void VulkanHppGenerator::checkHandleCorrectness() const
void VulkanHppGenerator::checkStructCorrectness() const void VulkanHppGenerator::checkStructCorrectness() const
{ {
for ( auto const & structAlias : m_structAliases )
{
checkForError( m_structs.contains( structAlias.second.name ), structAlias.second.xmlLine, "unknown struct alias <" + structAlias.second.name + ">" );
}
std::set<std::string> sTypeValues; std::set<std::string> sTypeValues;
for ( auto const & structure : m_structs ) for ( auto const & structure : m_structs )
{ {
@ -1468,7 +1463,7 @@ void VulkanHppGenerator::checkStructCorrectness() const
// check for existence of all structs that are extended by this struct // check for existence of all structs that are extended by this struct
for ( auto const & extend : structure.second.structExtends ) for ( auto const & extend : structure.second.structExtends )
{ {
checkForError( m_structs.contains( extend ) || m_structAliases.contains( extend ), checkForError( findByNameOrAlias( m_structs, extend ) != m_structs.end(),
structure.second.xmlLine, structure.second.xmlLine,
"struct <" + structure.first + "> extends unknown <" + extend + ">" ); "struct <" + structure.first + "> extends unknown <" + extend + ">" );
} }
@ -2140,6 +2135,20 @@ void VulkanHppGenerator::distributeSecondLevelCommands( std::set<std::string> co
} }
} }
void VulkanHppGenerator::distributeStructAliases()
{
for ( auto const & alias : m_structsAliases )
{
auto structIt = m_structs.find( alias.second.name );
checkForError(
structIt != m_structs.end(), alias.second.xmlLine, "struct alias <" + alias.first + "> references an unknown struct <" + alias.second.name + ">" );
checkForError( structIt->second.aliases.insert( { alias.first, alias.second.xmlLine } ).second,
alias.second.xmlLine,
"struct alias <" + alias.first + "> already listed as an alias for struct <" + alias.second.name + ">" );
}
m_structsAliases.clear();
}
void VulkanHppGenerator::filterLenMembers() void VulkanHppGenerator::filterLenMembers()
{ {
for ( auto & sd : m_structs ) for ( auto & sd : m_structs )
@ -5251,15 +5260,9 @@ std::string VulkanHppGenerator::generateCppModuleStructUsings() const
auto const structureType = stripPrefix( structIt->first, "Vk" ); auto const structureType = stripPrefix( structIt->first, "Vk" );
localUsings += replaceWithMap( usingTemplate, { { "structName", structureType } } ); localUsings += replaceWithMap( usingTemplate, { { "structName", structureType } } );
// replace the findAlias call with the contents, because it includes an assert that breaks in Debug mode, which shouldn't break. There are multiple for ( auto const & alias : structIt->second.aliases )
// aliases for a given struct, and that's ok. Maybe we should refactor
for ( auto const & [alias, aliasData] : m_structAliases )
{ {
if ( aliasData.name == structIt->first ) localUsings += replaceWithMap( usingTemplate, { { "structName", stripPrefix( alias.first, "Vk" ) } } );
{
auto const aliasName = stripPrefix( alias, "Vk" );
localUsings += replaceWithMap( usingTemplate, { { "structName", aliasName } } );
}
} }
} }
} }
@ -10303,13 +10306,7 @@ std::string VulkanHppGenerator::generateStruct( std::pair<std::string, Structure
assert( typeIt != m_types.end() ); assert( typeIt != m_types.end() );
if ( ( typeIt->second.category == TypeCategory::Struct ) || ( typeIt->second.category == TypeCategory::Union ) ) if ( ( typeIt->second.category == TypeCategory::Struct ) || ( typeIt->second.category == TypeCategory::Union ) )
{ {
auto structIt = m_structs.find( member.type.type ); auto structIt = findByNameOrAlias( m_structs, member.type.type );
if ( structIt == m_structs.end() )
{
auto aliasIt = m_structAliases.find( member.type.type );
assert( aliasIt != m_structAliases.end() );
structIt = m_structs.find( aliasIt->second.name );
}
assert( structIt != m_structs.end() ); assert( structIt != m_structs.end() );
if ( ( structure.first != member.type.type ) && !listedStructs.contains( member.type.type ) ) if ( ( structure.first != member.type.type ) && !listedStructs.contains( member.type.type ) )
{ {
@ -11110,12 +11107,9 @@ ${members}
str += replaceWithMap( cppTypeTemplate, { { "sTypeValue", sTypeValue }, { "structureType", structureType } } ); str += replaceWithMap( cppTypeTemplate, { { "sTypeValue", sTypeValue }, { "structureType", structureType } } );
} }
for ( auto const & alias : m_structAliases ) for ( auto const & alias : structure.second.aliases )
{ {
if ( alias.second.name == structure.first ) str += " using " + stripPrefix( alias.first, "Vk" ) + " = " + structureType + ";\n";
{
str += " using " + stripPrefix( alias.first, "Vk" ) + " = " + structureType + ";\n";
}
} }
str += leave; str += leave;
@ -11162,19 +11156,8 @@ std::string VulkanHppGenerator::generateStructExtendsStructs( std::vector<Requir
// append all allowed structure chains // append all allowed structure chains
for ( auto extendName : structIt->second.structExtends ) for ( auto extendName : structIt->second.structExtends )
{ {
std::map<std::string, StructureData>::const_iterator itExtend = m_structs.find( extendName ); auto extendsIt = findByNameOrAlias( m_structs, extendName );
if ( itExtend == m_structs.end() ) const auto [subEnter, subLeave] = generateProtection( getProtectFromType( extendsIt->first ) );
{
// look if the extendName acutally is an alias of some other structure
auto aliasIt = m_structAliases.find( extendName );
if ( aliasIt != m_structAliases.end() )
{
itExtend = m_structs.find( aliasIt->second.name );
assert( itExtend != m_structs.end() );
}
}
const auto [subEnter, subLeave] = generateProtection( getProtectFromType( itExtend->first ) );
if ( enter != subEnter ) if ( enter != subEnter )
{ {
@ -11234,12 +11217,9 @@ std::string VulkanHppGenerator::generateStructForwardDeclarations( std::vector<R
std::string structureType = stripPrefix( structIt->first, "Vk" ); std::string structureType = stripPrefix( structIt->first, "Vk" );
str += ( structIt->second.isUnion ? " union " : " struct " ) + structureType + ";\n"; str += ( structIt->second.isUnion ? " union " : " struct " ) + structureType + ";\n";
for ( auto const & alias : m_structAliases ) for ( auto const & alias : structIt->second.aliases )
{ {
if ( alias.second.name == type ) str += " using " + stripPrefix( alias.first, "Vk" ) + " = " + structureType + ";\n";
{
str += " using " + stripPrefix( alias.first, "Vk" ) + " = " + structureType + ";\n";
}
} }
} }
} }
@ -12548,15 +12528,7 @@ bool VulkanHppGenerator::isStructureChainAnchor( std::string const & type ) cons
{ {
if ( type.starts_with( "Vk" ) ) if ( type.starts_with( "Vk" ) )
{ {
auto it = m_structs.find( type ); auto it = findByNameOrAlias( m_structs, type );
if ( it == m_structs.end() )
{
auto aliasIt = m_structAliases.find( type );
if ( aliasIt != m_structAliases.end() )
{
it = m_structs.find( aliasIt->second.name );
}
}
if ( it != m_structs.end() ) if ( it != m_structs.end() )
{ {
return m_extendedStructs.contains( it->first ); return m_extendedStructs.contains( it->first );
@ -13755,6 +13727,7 @@ void VulkanHppGenerator::readRegistry( tinyxml2::XMLElement const * element )
{ {
readExtensions( child ); readExtensions( child );
distributeEnumValueAliases(); // after extensions are read, there should be no more enums/aliases specified! distributeEnumValueAliases(); // after extensions are read, there should be no more enums/aliases specified!
distributeStructAliases(); // and there should be no more structs/aliases specified
} }
else if ( value == "feature" ) else if ( value == "feature" )
{ {
@ -14077,7 +14050,7 @@ void VulkanHppGenerator::readSPIRVCapabilityEnable( tinyxml2::XMLElement const *
} }
else if ( attribute.first == "struct" ) else if ( attribute.first == "struct" )
{ {
checkForError( m_structs.contains( attribute.second ) || m_structAliases.contains( attribute.second ), checkForError( findByNameOrAlias( m_structs, attribute.second ) != m_structs.end(),
line, line,
"unknown structure <" + attribute.second + "> specified for SPIR-V capability" ); "unknown structure <" + attribute.second + "> specified for SPIR-V capability" );
} }
@ -14979,8 +14952,7 @@ void VulkanHppGenerator::readTypeStruct( tinyxml2::XMLElement const * element, b
std::string name = attributes.find( "name" )->second; std::string name = attributes.find( "name" )->second;
checkForError( m_types.insert( { name, TypeData{ TypeCategory::Struct, {}, line } } ).second, line, "struct <" + name + "> already specified" ); checkForError( m_types.insert( { name, TypeData{ TypeCategory::Struct, {}, line } } ).second, line, "struct <" + name + "> already specified" );
assert( !m_structAliases.contains( name ) ); checkForError( m_structsAliases.insert( { name, { alias, line } } ).second, line, "struct alias <" + name + "> already listed" );
m_structAliases[name] = { alias, line };
} }
else else

20
VulkanHppGenerator.hpp
View File

@ -364,14 +364,15 @@ private:
struct StructureData struct StructureData
{ {
bool allowDuplicate = {}; std::map<std::string, int> aliases = {};
bool isUnion = {}; bool allowDuplicate = {};
bool returnedOnly = {}; bool isUnion = {};
bool mutualExclusiveLens = {}; bool returnedOnly = {};
std::vector<MemberData> members = {}; bool mutualExclusiveLens = {};
std::vector<std::string> structExtends = {}; std::vector<MemberData> members = {};
std::string subStruct = {}; std::vector<std::string> structExtends = {};
int xmlLine = {}; std::string subStruct = {};
int xmlLine = {};
}; };
struct TagData struct TagData
@ -472,6 +473,7 @@ private:
std::set<size_t> determineVoidPointerParams( std::vector<ParamData> const & params ) const; std::set<size_t> determineVoidPointerParams( std::vector<ParamData> const & params ) const;
void distributeEnumValueAliases(); void distributeEnumValueAliases();
void distributeSecondLevelCommands( std::set<std::string> const & specialFunctions ); void distributeSecondLevelCommands( std::set<std::string> const & specialFunctions );
void distributeStructAliases();
void filterLenMembers(); void filterLenMembers();
std::map<std::string, AliasData>::const_iterator findAlias( std::string const & name, std::map<std::string, AliasData> const & aliases ) const; std::map<std::string, AliasData>::const_iterator findAlias( std::string const & name, std::map<std::string, AliasData> const & aliases ) const;
std::string findBaseName( std::string aliasName, std::map<std::string, AliasData> const & aliases ) const; std::string findBaseName( std::string aliasName, std::map<std::string, AliasData> const & aliases ) const;
@ -1050,8 +1052,8 @@ private:
std::map<std::string, IncludeData> m_includes; std::map<std::string, IncludeData> m_includes;
std::map<std::string, PlatformData> m_platforms; std::map<std::string, PlatformData> m_platforms;
std::set<std::string> m_RAIISpecialFunctions; std::set<std::string> m_RAIISpecialFunctions;
std::map<std::string, AliasData> m_structAliases;
std::map<std::string, StructureData> m_structs; std::map<std::string, StructureData> m_structs;
std::map<std::string, AliasData> m_structsAliases; // temporary storage for aliases, as they might be listed before the actual struct is listed
std::map<std::string, TagData> m_tags; std::map<std::string, TagData> m_tags;
std::map<std::string, TypeData> m_types; std::map<std::string, TypeData> m_types;
std::set<std::string> m_unsupportedExtensions; std::set<std::string> m_unsupportedExtensions;