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

Introduce member function clear() for raii-classes.

Browse Source
This commit is contained in:
asuessenbach 2022-02-15 10:50:52 +01:00
parent e367563e7c
commit b8522e483c
3 changed files with 800 additions and 635 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
VulkanHppGenerator.cpp
View File

@ -6873,16 +6873,13 @@ std::string VulkanHppGenerator::generateRAIIHandle( std::pair<std::string, Handl
std::string handleName = generateRAIIHandleConstructorParamName( handle.first, handle.second.destructorIt ); std::string handleName = generateRAIIHandleConstructorParamName( handle.first, handle.second.destructorIt );
auto [singularConstructors, arrayConstructors] = generateRAIIHandleConstructors( handle ); auto [singularConstructors, arrayConstructors] = generateRAIIHandleConstructors( handle );
auto [destructor, destructorCall] =
( handle.second.destructorIt == m_commands.end() )
? std::make_pair( "", "" )
: generateRAIIHandleDestructor( handle.first, handle.second.destructorIt, enter );
auto [getConstructorSuccessCode, auto [clearMembers,
getConstructorSuccessCode,
memberVariables, memberVariables,
moveConstructorInitializerList, moveConstructorInitializerList,
moveAssignmentInstructions, moveAssignmentInstructions,
swapMembers] = generateRAIIHandleDetails( handle, destructorCall ); swapMembers] = generateRAIIHandleDetails( handle );
std::string declarations = generateRAIIHandleCommandDeclarations( handle, specialFunctions ); std::string declarations = generateRAIIHandleCommandDeclarations( handle, specialFunctions );
@ -6937,7 +6934,11 @@ ${enter} class ${handleType}
public: public:
${singularConstructors} ${singularConstructors}
${handleType}( std::nullptr_t ) {} ${handleType}( std::nullptr_t ) {}
${destructor}
~${handleType}()
{
clear();
}
${handleType}() = delete; ${handleType}() = delete;
${handleType}( ${handleType} const & ) = delete; ${handleType}( ${handleType} const & ) = delete;
@ -6959,6 +6960,11 @@ ${moveAssignmentInstructions}
return m_${handleName}; return m_${handleName};
} }
void clear() VULKAN_HPP_NOEXCEPT
{
${clearMembers}
}
${getConstructorSuccessCode} ${getConstructorSuccessCode}
${getParent} ${getParent}
${dispatcherType} const * getDispatcher() const ${dispatcherType} const * getDispatcher() const
@ -6967,7 +6973,7 @@ ${getParent}
return ${getDispatcherReturn}m_dispatcher; return ${getDispatcherReturn}m_dispatcher;
} }
void swap( VULKAN_HPP_NAMESPACE::VULKAN_HPP_RAII_NAMESPACE::${handleType} & rhs ) void swap( VULKAN_HPP_NAMESPACE::VULKAN_HPP_RAII_NAMESPACE::${handleType} & rhs ) VULKAN_HPP_NOEXCEPT
{ {
${swapMembers} ${swapMembers}
} }
@ -6981,8 +6987,8 @@ ${leave})";
str += replaceWithMap( str += replaceWithMap(
handleTemplate, handleTemplate,
{ { "debugReportObjectType", debugReportObjectType }, { { "clearMembers", clearMembers },
{ "destructor", destructor }, { "debugReportObjectType", debugReportObjectType },
{ "dispatcherType", dispatcherType }, { "dispatcherType", dispatcherType },
{ "enter", enter }, { "enter", enter },
{ "getConstructorSuccessCode", getConstructorSuccessCode }, { "getConstructorSuccessCode", getConstructorSuccessCode },
@ -10561,41 +10567,6 @@ ${memberFunctionDeclarations}
{ { "memberFunctionDeclarations", generateRAIIHandleCommandDeclarations( handle, specialFunctions ) } } ); { { "memberFunctionDeclarations", generateRAIIHandleCommandDeclarations( handle, specialFunctions ) } } );
} }
std::pair<std::string, std::string>
VulkanHppGenerator::generateRAIIHandleDestructor( std::string const & handleType,
std::map<std::string, CommandData>::const_iterator destructorIt,
std::string const & enter ) const
{
auto [destructorEnter, destructorLeave] = generateProtection( destructorIt->second.referencedIn, std::string() );
bool doProtect = !destructorEnter.empty() && ( destructorEnter != enter );
if ( !doProtect )
{
destructorEnter.clear();
destructorLeave.clear();
}
std::string destructorCall =
destructorIt->first + "( " + generateRAIIHandleDestructorCallArguments( handleType, destructorIt ) + " )";
const std::string destructorTemplate = R"(
${enter}~${handleType}()
{
if ( m_${handleName} )
{
getDispatcher()->${destructorCall};
}
}
${leave})";
std::string destructor =
replaceWithMap( destructorTemplate,
{ { "destructorCall", destructorCall },
{ "enter", destructorEnter },
{ "handleName", generateRAIIHandleConstructorParamName( handleType, destructorIt ) },
{ "handleType", stripPrefix( handleType, "Vk" ) },
{ "leave", destructorLeave } } );
return std::make_pair( destructor, destructorCall );
}
std::string VulkanHppGenerator::generateRAIIHandleDestructorCallArguments( std::string VulkanHppGenerator::generateRAIIHandleDestructorCallArguments(
std::string const & handleType, std::map<std::string, CommandData>::const_iterator destructorIt ) const std::string const & handleType, std::map<std::string, CommandData>::const_iterator destructorIt ) const
{ {
@ -10659,9 +10630,8 @@ std::string VulkanHppGenerator::generateRAIIHandleDestructorCallArguments(
return arguments; return arguments;
} }
std::tuple<std::string, std::string, std::string, std::string, std::string> std::tuple<std::string, std::string, std::string, std::string, std::string, std::string>
VulkanHppGenerator::generateRAIIHandleDetails( std::pair<std::string, HandleData> const & handle, VulkanHppGenerator::generateRAIIHandleDetails( std::pair<std::string, HandleData> const & handle ) const
std::string const & destructorCall ) const
{ {
std::string getConstructorSuccessCode; std::string getConstructorSuccessCode;
bool multiSuccessCodeContructor = isMultiSuccessCodeConstructor( handle.second.constructorIts ); bool multiSuccessCodeContructor = isMultiSuccessCodeConstructor( handle.second.constructorIts );
@ -10680,13 +10650,17 @@ std::tuple<std::string, std::string, std::string, std::string, std::string>
std::string handleType = stripPrefix( handle.first, "Vk" ); std::string handleType = stripPrefix( handle.first, "Vk" );
std::string handleName = generateRAIIHandleConstructorParamName( handle.first, handle.second.destructorIt ); std::string handleName = generateRAIIHandleConstructorParamName( handle.first, handle.second.destructorIt );
std::string moveConstructorInitializerList, moveAssignmentInstructions, memberVariables, swapMembers; std::string clearMembers, moveConstructorInitializerList, moveAssignmentInstructions, memberVariables, swapMembers;
if ( handle.second.destructorIt != m_commands.end() ) if ( handle.second.destructorIt != m_commands.end() )
{ {
moveAssignmentInstructions = " if ( m_" + handleName + " )\n"; moveAssignmentInstructions = " clear();";
moveAssignmentInstructions += " {\n";
moveAssignmentInstructions += " getDispatcher()->" + destructorCall + ";\n"; clearMembers = " if ( m_" + handleName + " )\n";
moveAssignmentInstructions += " }"; clearMembers += " {\n";
clearMembers += " getDispatcher()->" + handle.second.destructorIt->first + "( " +
generateRAIIHandleDestructorCallArguments( handle.first, handle.second.destructorIt ) + " );\n";
clearMembers += " }";
for ( auto const & destructorParam : handle.second.destructorIt->second.params ) for ( auto const & destructorParam : handle.second.destructorIt->second.params )
{ {
std::string memberName, memberType; std::string memberName, memberType;
@ -10715,6 +10689,7 @@ std::tuple<std::string, std::string, std::string, std::string, std::string>
} }
if ( !memberName.empty() ) if ( !memberName.empty() )
{ {
clearMembers += "\n m_" + memberName + " = nullptr;";
moveConstructorInitializerList += "m_" + memberName + moveConstructorInitializerList += "m_" + memberName +
"( VULKAN_HPP_NAMESPACE::VULKAN_HPP_RAII_NAMESPACE::exchange( rhs.m_" + "( VULKAN_HPP_NAMESPACE::VULKAN_HPP_RAII_NAMESPACE::exchange( rhs.m_" +
memberName + ", {} ) ), "; memberName + ", {} ) ), ";
@ -10739,6 +10714,7 @@ std::tuple<std::string, std::string, std::string, std::string, std::string>
assert( handleIt->second.parent == frontType ); assert( handleIt->second.parent == frontType );
std::string frontName = handle.second.constructorIts.front()->second.params.front().name; std::string frontName = handle.second.constructorIts.front()->second.params.front().name;
clearMembers += "\n m_" + frontName + " = nullptr;";
moveConstructorInitializerList = "m_" + frontName + moveConstructorInitializerList = "m_" + frontName +
"( VULKAN_HPP_NAMESPACE::VULKAN_HPP_RAII_NAMESPACE::exchange( rhs.m_" + "( VULKAN_HPP_NAMESPACE::VULKAN_HPP_RAII_NAMESPACE::exchange( rhs.m_" +
frontName + ", {} ) ), "; frontName + ", {} ) ), ";
@ -10748,6 +10724,7 @@ std::tuple<std::string, std::string, std::string, std::string, std::string>
memberVariables = "\n VULKAN_HPP_NAMESPACE::" + stripPrefix( frontType, "Vk" ) + " m_" + frontName + " = {};"; memberVariables = "\n VULKAN_HPP_NAMESPACE::" + stripPrefix( frontType, "Vk" ) + " m_" + frontName + " = {};";
swapMembers = "\n std::swap( m_" + frontName + ", rhs.m_" + frontName + " );"; swapMembers = "\n std::swap( m_" + frontName + ", rhs.m_" + frontName + " );";
} }
clearMembers += "\n m_" + handleName + " = nullptr;";
moveConstructorInitializerList += "m_" + handleName + moveConstructorInitializerList += "m_" + handleName +
"( VULKAN_HPP_NAMESPACE::VULKAN_HPP_RAII_NAMESPACE::exchange( rhs.m_" + "( VULKAN_HPP_NAMESPACE::VULKAN_HPP_RAII_NAMESPACE::exchange( rhs.m_" +
handleName + ", {} ) ), "; handleName + ", {} ) ), ";
@ -10760,7 +10737,8 @@ std::tuple<std::string, std::string, std::string, std::string, std::string>
if ( multiSuccessCodeContructor ) if ( multiSuccessCodeContructor )
{ {
memberVariables += "\n VULKAN_HPP_NAMESPACE::Result m_constructorSuccessCode;"; clearMembers += "\n m_constructorSuccessCode = VULKAN_HPP_NAMESPACE::Result::eErrorUnknown;";
memberVariables += "\n VULKAN_HPP_NAMESPACE::Result m_constructorSuccessCode = VULKAN_HPP_NAMESPACE::Result::eErrorUnknown;";
swapMembers += "\n std::swap( m_constructorSuccessCode, rhs.m_constructorSuccessCode );"; swapMembers += "\n std::swap( m_constructorSuccessCode, rhs.m_constructorSuccessCode );";
} }
@ -10784,6 +10762,7 @@ std::tuple<std::string, std::string, std::string, std::string, std::string>
memberVariables += memberVariables +=
"\n VULKAN_HPP_NAMESPACE::VULKAN_HPP_RAII_NAMESPACE::InstanceDispatcher const * m_dispatcher = nullptr;"; "\n VULKAN_HPP_NAMESPACE::VULKAN_HPP_RAII_NAMESPACE::InstanceDispatcher const * m_dispatcher = nullptr;";
} }
clearMembers += "\n m_dispatcher = nullptr;";
swapMembers += "\n std::swap( m_dispatcher, rhs.m_dispatcher );"; swapMembers += "\n std::swap( m_dispatcher, rhs.m_dispatcher );";
if ( ( handle.first == "VkInstance" ) || ( handle.first == "VkDevice" ) ) if ( ( handle.first == "VkInstance" ) || ( handle.first == "VkDevice" ) )
@ -10799,7 +10778,8 @@ std::tuple<std::string, std::string, std::string, std::string, std::string>
"\n m_dispatcher = VULKAN_HPP_NAMESPACE::VULKAN_HPP_RAII_NAMESPACE::exchange( rhs.m_dispatcher, nullptr );"; "\n m_dispatcher = VULKAN_HPP_NAMESPACE::VULKAN_HPP_RAII_NAMESPACE::exchange( rhs.m_dispatcher, nullptr );";
} }
return std::make_tuple( getConstructorSuccessCode, return std::make_tuple( clearMembers,
getConstructorSuccessCode,
memberVariables, memberVariables,
moveConstructorInitializerList, moveConstructorInitializerList,
moveAssignmentInstructions, moveAssignmentInstructions,

9
VulkanHppGenerator.hpp
View File

@ -1116,16 +1116,11 @@ private:
std::string const & leave ) const; std::string const & leave ) const;
std::string generateRAIIHandleContext( std::pair<std::string, HandleData> const & handle, std::string generateRAIIHandleContext( std::pair<std::string, HandleData> const & handle,
std::set<std::string> const & specialFunctions ) const; std::set<std::string> const & specialFunctions ) const;
std::pair<std::string, std::string>
generateRAIIHandleDestructor( std::string const & handleType,
std::map<std::string, CommandData>::const_iterator destructorIt,
std::string const & enter ) const;
std::string std::string
generateRAIIHandleDestructorCallArguments( std::string const & handleType, generateRAIIHandleDestructorCallArguments( std::string const & handleType,
std::map<std::string, CommandData>::const_iterator destructorIt ) const; std::map<std::string, CommandData>::const_iterator destructorIt ) const;
std::tuple<std::string, std::string, std::string, std::string, std::string> std::tuple<std::string, std::string, std::string, std::string, std::string, std::string>
generateRAIIHandleDetails( std::pair<std::string, HandleData> const & handle, generateRAIIHandleDetails( std::pair<std::string, HandleData> const & handle ) const;
std::string const & destructorCall ) const;
std::string generateRAIIHandleForwardDeclarations( std::vector<RequireData> const & requireData, std::string generateRAIIHandleForwardDeclarations( std::vector<RequireData> const & requireData,
std::string const & title ) const; std::string const & title ) const;
std::string generateRAIIHandleSingularConstructorArguments( std::string generateRAIIHandleSingularConstructorArguments(

1330
vulkan/vulkan_raii.hpp
View File

File diff suppressed because it is too large Load Diff