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

Add handling of attribute "deprecated", extend handling of attribute "api" (#1506)

Browse Source
This commit is contained in:
Andreas Süßenbach 2023-02-16 13:12:55 +01:00 committed by GitHub
parent 1e95278b04
commit a3cd63a4e2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 119 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

142
VulkanHppGenerator.cpp
View File

@ -1131,14 +1131,16 @@ void VulkanHppGenerator::checkStructCorrectness() const
{ {
for ( auto const & structAlias : m_structureAliases ) for ( auto const & structAlias : m_structureAliases )
{ {
auto structIt = m_structures.find( structAlias.second.alias ); checkForError( ( m_structures.find( structAlias.second.alias ) != m_structures.end() ) ||
checkForError( structIt != m_structures.end(), structAlias.second.xmlLine, "unknown struct alias <" + structAlias.second.alias + ">" ); ( m_removedStructs.find( structAlias.second.alias ) != m_removedStructs.end() ),
structAlias.second.xmlLine,
"unknown struct alias <" + structAlias.second.alias + ">" );
} }
for ( auto const & structAliasInverse : m_structureAliasesInverse ) for ( auto const & structAliasInverse : m_structureAliasesInverse )
{ {
auto structIt = m_structures.find( structAliasInverse.first ); if ( ( m_structures.find( structAliasInverse.first ) == m_structures.end() ) &&
if ( structIt == m_structures.end() ) ( m_removedStructs.find( structAliasInverse.first ) == m_removedStructs.end() ) )
{ {
assert( !structAliasInverse.second.empty() ); assert( !structAliasInverse.second.empty() );
auto aliasIt = m_structureAliases.find( *structAliasInverse.second.begin() ); auto aliasIt = m_structureAliases.find( *structAliasInverse.second.begin() );
@ -9834,8 +9836,7 @@ std::string VulkanHppGenerator::generateUniqueHandle( std::pair<std::string, Han
std::string aliasHandle; std::string aliasHandle;
if ( !handleData.second.alias.empty() ) if ( !handleData.second.alias.empty() )
{ {
static const std::string aliasHandleTemplate = static const std::string aliasHandleTemplate = R"( using Unique${aliasType} = UniqueHandle<${type}, VULKAN_HPP_DEFAULT_DISPATCHER_TYPE>;)";
R"( using Unique${aliasType} = UniqueHandle<${type}, VULKAN_HPP_DEFAULT_DISPATCHER_TYPE>;)";
aliasHandle += replaceWithMap( aliasHandleTemplate, { { "aliasType", stripPrefix( handleData.second.alias, "Vk" ) }, { "type", type } } ); aliasHandle += replaceWithMap( aliasHandleTemplate, { { "aliasType", stripPrefix( handleData.second.alias, "Vk" ) }, { "type", type } } );
} }
@ -9852,7 +9853,7 @@ ${aliasHandle})";
return replaceWithMap( uniqueHandleTemplate, return replaceWithMap( uniqueHandleTemplate,
{ { "aliasHandle", aliasHandle }, { { "aliasHandle", aliasHandle },
{ "deleterAction", ( handleData.second.deleteCommand.substr( 2, 4 ) == "Free" ) ? "Free" : "Destroy" }, { "deleterAction", ( handleData.second.deleteCommand.substr( 2, 4 ) == "Free" ) ? "Free" : "Destroy" },
{ "deleterParent", handleData.second.deleteParent.empty() ? "NoParent" : stripPrefix(handleData.second.deleteParent, "Vk" ) }, { "deleterParent", handleData.second.deleteParent.empty() ? "NoParent" : stripPrefix( handleData.second.deleteParent, "Vk" ) },
{ "deleterPool", handleData.second.deletePool.empty() ? "" : ", " + stripPrefix( handleData.second.deletePool, "Vk" ) }, { "deleterPool", handleData.second.deletePool.empty() ? "" : ", " + stripPrefix( handleData.second.deletePool, "Vk" ) },
{ "deleterType", handleData.second.deletePool.empty() ? "Object" : "Pool" }, { "deleterType", handleData.second.deletePool.empty() ? "Object" : "Pool" },
{ "type", type } } ); { "type", type } } );
@ -9898,7 +9899,7 @@ ${uniqueHandles}
{ {
uniqueHandles += generateUniqueHandle( extIt.second->second.requireData, extIt.second->first ); uniqueHandles += generateUniqueHandle( extIt.second->second.requireData, extIt.second->first );
} }
assert( uniqueHandles.back() == '\n'); assert( uniqueHandles.back() == '\n' );
uniqueHandles.pop_back(); uniqueHandles.pop_back();
return replaceWithMap( uniqueHandlesTemplate, { { "uniqueHandles", uniqueHandles } } ); return replaceWithMap( uniqueHandlesTemplate, { { "uniqueHandles", uniqueHandles } } );
} }
@ -10350,7 +10351,8 @@ void VulkanHppGenerator::readCommandsCommand( tinyxml2::XMLElement const * eleme
checkAttributes( line, checkAttributes( line,
attributes, attributes,
{}, {},
{ { "cmdbufferlevel", { "primary", "secondary" } }, { { "api", { "vulkan", "vulkansc" } },
{ "cmdbufferlevel", { "primary", "secondary" } },
{ "comment", {} }, { "comment", {} },
{ "errorcodes", {} }, { "errorcodes", {} },
{ "queues", { "compute", "decode", "encode", "graphics", "opticalflow", "sparse_binding", "transfer" } }, { "queues", { "compute", "decode", "encode", "graphics", "opticalflow", "sparse_binding", "transfer" } },
@ -10365,7 +10367,15 @@ void VulkanHppGenerator::readCommandsCommand( tinyxml2::XMLElement const * eleme
CommandData commandData( line ); CommandData commandData( line );
for ( auto const & attribute : attributes ) for ( auto const & attribute : attributes )
{ {
if ( attribute.first == "errorcodes" ) if ( attribute.first == "api" )
{
if ( attribute.second == "vulkansc" )
{
return; // skip stuff marked as "vulkansc" !
}
assert( attribute.second == "vulkan" );
}
else if ( attribute.first == "errorcodes" )
{ {
commandData.errorCodes = tokenize( attribute.second, "," ); commandData.errorCodes = tokenize( attribute.second, "," );
// errorCodes are checked in checkCorrectness after complete reading // errorCodes are checked in checkCorrectness after complete reading
@ -10622,7 +10632,8 @@ void VulkanHppGenerator::readEnumsEnum( tinyxml2::XMLElement const * element, st
std::map<std::string, std::string> attributes = getAttributes( element ); std::map<std::string, std::string> attributes = getAttributes( element );
if ( attributes.find( "alias" ) != attributes.end() ) if ( attributes.find( "alias" ) != attributes.end() )
{ {
checkAttributes( line, attributes, { { "alias", {} }, { "name", {} } }, { { "api", { "vulkan", "vulkansc" } }, { "comment", {} } } ); checkAttributes(
line, attributes, { { "alias", {} }, { "name", {} } }, { { "api", { "vulkan", "vulkansc" } }, { "comment", {} }, { "deprecated", { "aliased" } } } );
checkElements( line, getChildElements( element ), {} ); checkElements( line, getChildElements( element ), {} );
std::string alias, bitpos, name, value; std::string alias, bitpos, name, value;
@ -10640,6 +10651,10 @@ void VulkanHppGenerator::readEnumsEnum( tinyxml2::XMLElement const * element, st
} }
assert( attribute.second == "vulkan" ); assert( attribute.second == "vulkan" );
} }
else if ( attribute.first == "deprecated" )
{
// the enum value is marked as deprecated/aliased but still exisits -> no modifications needed here
}
else if ( attribute.first == "name" ) else if ( attribute.first == "name" )
{ {
name = attribute.second; name = attribute.second;
@ -10828,14 +10843,24 @@ void VulkanHppGenerator::readExtensionsExtensionRequire( tinyxml2::XMLElement co
{ {
int line = element->GetLineNum(); int line = element->GetLineNum();
std::map<std::string, std::string> attributes = getAttributes( element ); std::map<std::string, std::string> attributes = getAttributes( element );
checkAttributes( line, attributes, {}, { { "comment", {}}, { "depends", {} }, { "extension", {} }, { "feature", {} } } ); checkAttributes( line, attributes, {}, { { "api", { "vulkansc" } }, { "comment", {} }, { "depends", {} }, { "extension", {} }, { "feature", {} } } );
std::vector<tinyxml2::XMLElement const *> children = getChildElements( element ); std::vector<tinyxml2::XMLElement const *> children = getChildElements( element );
checkElements( line, children, {}, { "command", "comment", "enum", "type" } ); checkElements( line, children, {}, { "command", "comment", "enum", "type" } );
std::vector<std::string> depends; std::vector<std::string> depends;
for ( auto const & attribute : attributes ) for ( auto const & attribute : attributes )
{ {
if ( ( attribute.first == "depends" ) || ( attribute.first == "extension" ) ) if ( attribute.first == "api" )
{
if ( attribute.second == "vulkansc" )
{
// remove stuff marked as "vulkansc"
readExtensionsExtensionRequireRemove( element );
return;
}
assert( attribute.second == "vulkan" );
}
else if ( ( attribute.first == "depends" ) || ( attribute.first == "extension" ) )
{ {
assert( depends.empty() ); assert( depends.empty() );
depends = tokenizeAny( attribute.second, ",+" ); depends = tokenizeAny( attribute.second, ",+" );
@ -10938,13 +10963,17 @@ void VulkanHppGenerator::readExtensionsExtensionRequireRemove( tinyxml2::XMLElem
{ {
int line = element->GetLineNum(); int line = element->GetLineNum();
std::map<std::string, std::string> attributes = getAttributes( element ); std::map<std::string, std::string> attributes = getAttributes( element );
checkAttributes( line, attributes, {}, { { "comment", {} }, { "depends", {} }, { "extension", {} }, { "feature", {} } } ); checkAttributes( line, attributes, {}, { { "api", { "vulkansc" } }, { "comment", {} }, { "depends", {} }, { "extension", {} }, { "feature", {} } } );
std::vector<tinyxml2::XMLElement const *> children = getChildElements( element ); std::vector<tinyxml2::XMLElement const *> children = getChildElements( element );
checkElements( line, children, {}, { "command", "comment", "enum", "type" } ); checkElements( line, children, {}, { "command", "comment", "enum", "type" } );
for ( auto child : children ) for ( auto child : children )
{ {
std::string value = child->Value(); std::string value = child->Value();
if ( value == "api" )
{
// we're already in the remove part, so it doesn't matter that this is marked as "vulkansc" again!
}
if ( value == "command" ) if ( value == "command" )
{ {
readRequireCommandRemove( child ); readRequireCommandRemove( child );
@ -11576,7 +11605,10 @@ void VulkanHppGenerator::readRequireEnum( tinyxml2::XMLElement const * element,
std::map<std::string, std::string> attributes = getAttributes( element ); std::map<std::string, std::string> attributes = getAttributes( element );
if ( attributes.find( "alias" ) != attributes.end() ) if ( attributes.find( "alias" ) != attributes.end() )
{ {
checkAttributes( line, attributes, { { "alias", {} }, { "name", {} } }, { { "api", { "vulkan", "vulkansc" } }, { "comment", {} }, { "extends", {} } } ); checkAttributes( line,
attributes,
{ { "alias", {} }, { "name", {} } },
{ { "api", { "vulkan", "vulkansc" } }, { "comment", {} }, { "deprecated", { "aliased" } }, { "extends", {} } } );
checkElements( line, getChildElements( element ), {} ); checkElements( line, getChildElements( element ), {} );
std::string alias, bitpos, name, extends, extnumber, offset, value; std::string alias, bitpos, name, extends, extnumber, offset, value;
@ -11594,6 +11626,10 @@ void VulkanHppGenerator::readRequireEnum( tinyxml2::XMLElement const * element,
} }
assert( attribute.second == "vulkan" ); assert( attribute.second == "vulkan" );
} }
else if ( attribute.first == "deprecated" )
{
// the enum value is marked as deprecated, but still exisits -> no modifications needed here
}
else if ( attribute.first == "extends" ) else if ( attribute.first == "extends" )
{ {
extends = attribute.second; extends = attribute.second;
@ -11606,11 +11642,38 @@ void VulkanHppGenerator::readRequireEnum( tinyxml2::XMLElement const * element,
if ( !extends.empty() ) if ( !extends.empty() )
{ {
auto enumIt = m_enums.find( extends ); auto typeIt = m_types.find( extends );
checkForError( enumIt != m_enums.end(), line, "feature extends unknown enum <" + extends + ">" ); if ( typeIt == m_types.end() )
{
// add this enum name to the list of aliases auto removedTypeIt = m_removedTypes.find( extends );
enumIt->second.addEnumAlias( line, name, alias ); checkForError( removedTypeIt != m_removedTypes.end(), line, "feature extends unknown type <" + extends + ">" );
typeIt = m_types.insert( *removedTypeIt ).first;
switch ( typeIt->second.category )
{
case TypeCategory::Enum:
{
auto removedEnumIt = m_removedEnums.find( extends );
assert( removedEnumIt != m_removedEnums.end() );
m_enums.insert( *removedEnumIt );
}
break;
default: checkForError( false, line, "feature extends unhandled type <" + extends + ">" );
}
}
assert( typeIt != m_types.end() );
switch ( typeIt->second.category )
{
case TypeCategory::Bitmask: break;
case TypeCategory::Enum:
{
auto enumIt = m_enums.find( extends );
checkForError( enumIt != m_enums.end(), line, "feature extends unknown enum <" + extends + ">" );
// add this enum name to the list of aliases
enumIt->second.addEnumAlias( line, name, alias );
}
break;
default: checkForError( false, line, "feature extends unhandled type <" + extends + ">" ); break;
}
} }
} }
else else
@ -11792,8 +11855,27 @@ void VulkanHppGenerator::readRequireTypeRemove( tinyxml2::XMLElement const * ele
m_handles.erase( name ); m_handles.erase( name );
break; break;
case TypeCategory::Struct: case TypeCategory::Struct:
assert( m_structures.find( name ) != m_structures.end() ); {
m_structures.erase( name ); auto structIt = m_structures.find( name );
if ( structIt == m_structures.end() )
{
auto aliasIt = m_structureAliases.find( name );
if ( aliasIt != m_structureAliases.end() )
{
name = aliasIt->second.alias;
structIt = m_structures.find( name );
}
}
if ( structIt != m_structures.end() )
{
m_removedStructs.insert( name );
m_structures.erase( structIt );
}
else
{
checkForError( m_removedStructs.find( name ) != m_removedStructs.end(), line, "tried to remove unknown struct <" + name + ">" );
}
}
break; break;
default: assert( false ); break; default: assert( false ); break;
} }
@ -12273,7 +12355,10 @@ void VulkanHppGenerator::readTypesTypeBitmask( tinyxml2::XMLElement const * elem
void VulkanHppGenerator::readTypesTypeDefine( tinyxml2::XMLElement const * element, std::map<std::string, std::string> const & attributes ) void VulkanHppGenerator::readTypesTypeDefine( tinyxml2::XMLElement const * element, std::map<std::string, std::string> const & attributes )
{ {
int line = element->GetLineNum(); int line = element->GetLineNum();
checkAttributes( line, attributes, { { "category", { "define" } } }, { { "api", { "vulkan", "vulkansc" } }, { "name", {} }, { "requires", {} } } ); checkAttributes( line,
attributes,
{ { "category", { "define" } } },
{ { "api", { "vulkan", "vulkansc" } }, { "deprecated", { "true" } }, { "name", {} }, { "requires", {} } } );
std::string name, require; std::string name, require;
for ( auto const & attribute : attributes ) for ( auto const & attribute : attributes )
@ -12286,6 +12371,10 @@ void VulkanHppGenerator::readTypesTypeDefine( tinyxml2::XMLElement const * eleme
} }
assert( attribute.second == "vulkan" ); assert( attribute.second == "vulkan" );
} }
else if ( attribute.first == "deprecated" )
{
// the define is marked as deprecated, but still exisits -> no modifications needed here
}
else if ( attribute.first == "name" ) else if ( attribute.first == "name" )
{ {
name = attribute.second; name = attribute.second;
@ -12683,6 +12772,7 @@ void VulkanHppGenerator::readTypesTypeStructMember( tinyxml2::XMLElement const *
{}, {},
{ { "altlen", {} }, { { "altlen", {} },
{ "api", { "vulkan", "vulkansc" } }, { "api", { "vulkan", "vulkansc" } },
{ "deprecated", { "ignored" } },
{ "externsync", { "true" } }, { "externsync", { "true" } },
{ "len", {} }, { "len", {} },
{ "limittype", { "bitmask", "bits", "exact", "max", "min", "mul", "noauto", "pot", "range", "struct" } }, { "limittype", { "bitmask", "bits", "exact", "max", "min", "mul", "noauto", "pot", "range", "struct" } },
@ -12714,6 +12804,10 @@ void VulkanHppGenerator::readTypesTypeStructMember( tinyxml2::XMLElement const *
checkForError( memberData.len.size() == 1, line, "member attribute <altlen> holds unknown number of data: " + std::to_string( memberData.len.size() ) ); checkForError( memberData.len.size() == 1, line, "member attribute <altlen> holds unknown number of data: " + std::to_string( memberData.len.size() ) );
checkForError( altLens.find( memberData.len[0] ) != altLens.end(), line, "member attribute <altlen> holds unknown value <" + memberData.len[0] + ">" ); checkForError( altLens.find( memberData.len[0] ) != altLens.end(), line, "member attribute <altlen> holds unknown value <" + memberData.len[0] + ">" );
} }
else if ( attribute.second == "deprecated" )
{
// the struct member is marked as deprecated/ignored, but still exisits -> no modifications needed here
}
else if ( attribute.first == "len" ) else if ( attribute.first == "len" )
{ {
if ( memberData.len.empty() ) if ( memberData.len.empty() )
@ -12881,7 +12975,7 @@ void VulkanHppGenerator::registerDeleter( std::string const & name, std::pair<st
auto handleIt = m_handles.find( commandData.second.params[valueIndex].type.type ); auto handleIt = m_handles.find( commandData.second.params[valueIndex].type.type );
assert( handleIt != m_handles.end() ); assert( handleIt != m_handles.end() );
handleIt->second.deleteCommand = name; handleIt->second.deleteCommand = name;
handleIt->second.deleteParent = key; handleIt->second.deleteParent = key;
} }
} }

1
VulkanHppGenerator.hpp
View File

@ -1012,6 +1012,7 @@ private:
std::set<std::string> m_removedCommands; std::set<std::string> m_removedCommands;
std::map<std::string, EnumData> m_removedEnums; std::map<std::string, EnumData> m_removedEnums;
std::set<std::string> m_removedFeatures; std::set<std::string> m_removedFeatures;
std::set<std::string> m_removedStructs;
std::map<std::string, TypeData> m_removedTypes; std::map<std::string, TypeData> m_removedTypes;
std::map<std::string, StructureData> m_structures; std::map<std::string, StructureData> m_structures;
std::map<std::string, StructureAliasData> m_structureAliases; std::map<std::string, StructureAliasData> m_structureAliases;