// Copyright(c) 2015-2019, NVIDIA CORPORATION. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. #pragma once #include #include #include #include #include class VulkanHppGenerator { public: VulkanHppGenerator( tinyxml2::XMLDocument const & document ); void appendBaseTypes( std::string & str ) const; void appendBitmasks( std::string & str ) const; void appendDispatchLoaderDynamic( std::string & str ); // use vkGet*ProcAddress to get function pointers void appendDispatchLoaderStatic( std::string & str ); // use exported symbols from loader void appendDispatchLoaderDefault( std::string & str ); // typedef to DispatchLoaderStatic or undefined type, based on VK_NO_PROTOTYPES void appendEnums( std::string & str ) const; void appendForwardDeclarations( std::string & str ) const; void appendHandles( std::string & str ) const; void appendHandlesCommandDefintions( std::string & str ) const; void appendHashStructures( std::string & str ) const; void appendResultExceptions( std::string & str ) const; void appendStructs( std::string & str ) const; void appendStructureChainValidation( std::string & str ); void appendThrowExceptions( std::string & str ) const; void appendIndexTypeTraits( std::string & str ) const; std::string const & getTypesafeCheck() const; std::string const & getVersion() const; std::string const & getVulkanLicenseHeader() const; private: struct BaseTypeData { BaseTypeData( std::string const & type_, int line ) : type( type_ ), xmlLine( line ) {} std::string type; int xmlLine; }; struct BitmaskData { BitmaskData( std::string const & r, std::string const & t, int line ) : requirements( r ), type( t ), xmlLine( line ) {} std::string requirements; std::string type; std::string alias; int xmlLine; }; struct NameData { std::string name; std::vector arraySizes; std::string bitCount; }; struct TypeInfo { std::string compose() const; bool operator==( TypeInfo const & rhs ) const { return ( prefix == rhs.prefix ) && ( type == rhs.type ) && ( postfix == rhs.postfix ); } std::string prefix; std::string type; std::string postfix; }; struct ParamData { ParamData( int line ) : optional( false ), xmlLine( line ) {} TypeInfo type; std::string name; std::vector arraySizes; std::string len; bool optional; int xmlLine; }; struct CommandData { CommandData( int line ) : xmlLine( line ) {} std::string alias; std::vector errorCodes; std::set extensions; std::string feature; std::string handle; std::vector params; std::string returnType; std::vector successCodes; int xmlLine; }; struct EnumValueData { EnumValueData( std::string const & vulkan, std::string const & vk, bool singleBit_ ) : vulkanValue( vulkan ), vkValue( vk ), singleBit( singleBit_ ) {} std::string vulkanValue; std::string vkValue; bool singleBit; }; struct EnumData { void addEnumAlias( int line, std::string const & name, std::string const & alias, std::string const & vkName ); void addEnumValue( int line, std::string const & valueName, bool bitmask, bool bitpos, std::string const & prefix, std::string const & postfix, std::string const & tag ); std::string alias; // alias for this enum std::map> aliases; // map from name to alias and vk-name bool isBitmask = false; std::vector values; }; struct ExtensionData { ExtensionData( int line, std::string const & deprecatedBy_, std::string const & obsoletedBy_, std::string const & platform_, std::string const & promotedTo_ ) : xmlLine( line ) , deprecatedBy( deprecatedBy_ ) , obsoletedBy( obsoletedBy_ ) , platform( platform_ ) , promotedTo( promotedTo_ ) {} std::string deprecatedBy; std::string obsoletedBy; std::string platform; std::string promotedTo; std::map requirements; int xmlLine; }; struct FuncPointerData { FuncPointerData( std::string const & r, int line ) : requirements( r ), xmlLine( line ) {} std::string requirements; int xmlLine; }; struct HandleData { HandleData( std::vector const & p, int line ) : parents( p ), xmlLine( line ) {} std::string alias; std::set childrenHandles; std::set commands; std::string deleteCommand; std::string deletePool; std::vector parents; int xmlLine; }; struct MemberData { MemberData( int line ) : xmlLine( line ) {} TypeInfo type; std::string name; std::vector arraySizes; std::string bitCount; std::string values; std::string usedConstant; int xmlLine; }; struct PlatformData { PlatformData( std::string const & protect_ ) : protect( protect_ ) {} std::string protect; }; struct StructureData { StructureData( std::vector const & extends, int line ) : structExtends( extends ), xmlLine( line ) {} bool allowDuplicate = false; bool isUnion = false; bool returnedOnly = false; std::vector members; std::vector structExtends; std::set aliases; std::string subStruct; int xmlLine; }; enum class TypeCategory { Bitmask, BaseType, Define, Enum, FuncPointer, Handle, Requires, Struct, Union, Unknown }; struct TypeData { TypeData( TypeCategory category_ ) : category( category_ ) {} TypeCategory category; std::set extensions; std::string feature; }; private: void appendArgumentPlainType( std::string & str, ParamData const & paramData ) const; void appendArguments( std::string & str, CommandData const & commandData, size_t returnParamIndex, size_t templateParamIndex, std::map const & vectorParamIndices, bool twoStep, bool firstCall, bool singular, size_t from, size_t to ) const; void appendArgumentVector( std::string & str, size_t paramIndex, ParamData const & paramData, size_t returnParamIndex, size_t templateParamIndex, bool twoStep, bool firstCall, bool singular ) const; void appendArgumentVulkanType( std::string & str, ParamData const & paramData ) const; void appendBitmask( std::string & os, std::string const & bitmaskName, std::string const & bitmaskType, std::string const & bitmaskAlias, std::string const & enumName, std::vector const & enumValues ) const; void appendBitmaskToStringFunction( std::string & str, std::string const & flagsName, std::string const & enumName, std::vector const & enumValues ) const; void appendCall( std::string & str, std::string const & name, CommandData const & commandData, size_t returnParamIndex, size_t templateParamIndex, std::map const & vectorParamIndices, bool twoStep, bool firstCall, bool singular ) const; void appendCommand( std::string & str, std::string const & indentation, std::string const & name, CommandData const & commandData, bool definition ) const; void appendEnum( std::string & str, std::pair const & enumData ) const; void appendEnumInitializer( std::string & str, TypeInfo const & type, std::vector const & arraySizes, std::vector const & values ) const; void appendEnumToString( std::string & str, std::pair const & enumData ) const; void appendFunction( std::string & str, std::string const & indentation, std::string const & name, CommandData const & commandData, size_t returnParamIndex, size_t templateParamIndex, std::map const & vectorParamIndices, bool twoStep, std::string const & enhancedReturnType, bool definition, bool enhanced, bool singular, bool unique, bool isStructureChain, bool withAllocator ) const; void appendFunctionBodyEnhanced( std::string & str, std::string const & indentation, std::string const & name, CommandData const & commandData, size_t returnParamIndex, size_t templateParamIndex, std::map const & vectorParamIndices, bool twoStep, std::string const & enhancedReturnType, bool singular, bool unique, bool isStructureChain, bool withAllocator ) const; std::string appendFunctionBodyEnhancedLocalReturnVariable( std::string & str, std::string const & indentation, CommandData const & commandData, size_t returnParamIndex, std::map const & vectorParamIndices, bool twoStep, std::string const & enhancedReturnType, bool singular, bool isStructureChain, bool withAllocator ) const; void appendFunctionBodyEnhancedLocalReturnVariableVectorSize( std::string & str, std::vector const & params, std::pair const & vectorParamIndex, size_t returnParamIndex, std::map const & vectorParamIndices, bool withAllocator ) const; void appendFunctionBodyEnhancedMultiVectorSizeCheck( std::string & str, std::string const & indentation, std::string const & name, CommandData const & commandData, size_t returnParamIndex, std::map const & vectorParamIndices ) const; void appendFunctionBodyEnhancedReturnResultValue( std::string & str, std::string const & indentation, std::string const & returnName, std::string const & name, CommandData const & commandData, size_t returnParamIndex, bool twoStep, bool singular, bool unique ) const; void appendFunctionBodyEnhancedSingleStep( std::string & str, std::string const & indentation, std::string const & name, CommandData const & commandData, size_t returnParamIndex, size_t templateParamIndex, std::map const & vectorParamIndices, bool singular ) const; void appendFunctionBodyEnhancedTwoStep( std::string & str, std::string const & indentation, std::string const & name, CommandData const & commandData, size_t returnParamIndex, size_t templateParamIndex, std::map const & vectorParamIndices, bool singular, std::string const & returnName ) const; void appendFunctionBodyEnhancedVectorOfStructureChain( std::string & str, std::string const & indentation, std::string const & name, CommandData const & commandData, size_t returnParamIndex, std::map const & vectorParamIndices, bool withAllocator ) const; void appendFunctionBodyEnhancedVectorOfUniqueHandles( std::string & str, std::string const & indentation, std::string const & name, CommandData const & commandData, size_t returnParamIndex, size_t templateParamIndex, std::map const & vectorParamIndices, bool twoStep, bool singular, bool withAllocator ) const; void appendFunctionBodyStandard( std::string & str, std::string const & indentation, std::string const & commandName, CommandData const & commandData ) const; void appendFunctionBodyStandardArgument( std::string & str, TypeInfo const & typeData, std::string const & name, std::vector const & arraySizes ) const; bool appendFunctionHeaderArgumentEnhanced( std::string & str, ParamData const & param, size_t paramIndex, std::map const & vectorParamIndices, bool skip, bool argEncountered, bool isTemplateParam, bool isLastArgument, bool singular, bool withDefaults, bool withAllocator ) const; void appendFunctionHeaderArgumentEnhancedPointer( std::string & str, ParamData const & param, std::string const & strippedParameterName, bool withDefaults, bool withAllocator ) const; void appendFunctionHeaderArgumentEnhancedSimple( std::string & str, ParamData const & param, bool lastArgument, bool withDefaults, bool withAllocator ) const; void appendFunctionHeaderArgumentEnhancedVector( std::string & str, ParamData const & param, std::string const & strippedParameterName, bool hasSizeParam, bool isTemplateParam, bool singular, bool withDefaults, bool withAllocator ) const; void appendFunctionHeaderArguments( std::string & str, CommandData const & commandData, size_t returnParamIndex, size_t templateParamIndex, std::map const & vectorParamIndices, bool enhanced, bool singular, bool withDefaults, bool withAllocator ) const; void appendFunctionHeaderArgumentsEnhanced( std::string & str, CommandData const & commandData, size_t returnParamIndex, size_t templateParamIndex, std::map const & vectorParamIndices, bool singular, bool withDefaults, bool withAllocator ) const; void appendFunctionHeaderArgumentsStandard( std::string & str, CommandData const & commandData, bool withDefaults ) const; bool appendFunctionHeaderArgumentStandard( std::string & str, ParamData const & param, bool argEncountered, bool isLastArgument, bool withDefaults ) const; void appendFunctionHeaderReturnType( std::string & str, CommandData const & commandData, size_t returnParamIndex, std::map const & vectorParamIndices, std::string const & enhancedReturnType, bool enhanced, bool twoStep, bool singular, bool unique, bool isStructureChain ) const; void appendFunctionHeaderTemplate( std::string & str, std::string const & indentation, size_t returnParamIndex, size_t templateParamIndex, std::string const & enhancedReturnType, bool enhanced, bool singular, bool unique, bool withDefault, bool isStructureChain ) const; void appendHandle( std::string & str, std::pair const & handle, std::set & listedHandles ) const; void appendStruct( std::string & str, std::pair const & structure, std::set & listedStructures ) const; void appendStructAssignmentOperator( std::string & str, std::pair const & structure, std::string const & prefix ) const; void appendStructCompareOperators( std::string & str, std::pair const & structure ) const; void appendStructConstructor( std::string & str, std::pair const & structData, std::string const & prefix ) const; bool appendStructConstructorArgument( std::string & str, bool listedArgument, std::string const & indentation, MemberData const & memberData ) const; void appendStructCopyConstructors( std::string & str, std::string const & vkName ) const; std::string appendStructMembers( std::string & str, std::pair const & structData, std::string const & prefix ) const; void appendStructSetter( std::string & str, std::string const & structureName, bool isUnion, MemberData const & memberData ) const; void appendStructSubConstructor( std::string & str, std::pair const & structData, std::string const & prefix ) const; void appendStructure( std::string & str, std::pair const & structure ) const; void appendUnion( std::string & str, std::pair const & structure ) const; void appendUniqueTypes( std::string & str, std::string const & parentType, std::set const & childrenTypes ) const; std::string constructConstexprString( std::pair const & structData ) const; void checkCorrectness(); bool checkLenAttribute( std::string const & len, std::vector const & params ); bool containsArray( std::string const & type ) const; bool containsUnion( std::string const & type ) const; std::string determineEnhancedReturnType( CommandData const & commandData, size_t returnParamIndex, std::map const & vectorParamIndices, bool isStructureChain ) const; size_t determineReturnParamIndex( CommandData const & commandData, std::map const & vectorParamIndices, bool twoStep ) const; std::string determineSubStruct( std::pair const & structure ) const; size_t determineTemplateParamIndex( std::vector const & params, std::map const & vectorParamIndices ) const; std::map determineVectorParamIndices( std::vector const & params ) const; std::pair generateProtection( std::string const & feature, std::set const & extension ) const; std::pair generateProtection( std::string const & type, bool isAliased ) const; bool holdsSType( std::string const & type ) const; bool isTwoStepAlgorithm( std::vector const & params ) const; void readBaseType( tinyxml2::XMLElement const * element, std::map const & attributes ); void readBitmask( tinyxml2::XMLElement const * element, std::map const & attributes ); void readBitmaskAlias( tinyxml2::XMLElement const * element, std::map const & attributes ); void readCommand( tinyxml2::XMLElement const * element ); void readCommand( tinyxml2::XMLElement const * element, std::map const & attributess ); void readCommandAlias( tinyxml2::XMLElement const * element, std::map const & attributes ); ParamData readCommandParam( tinyxml2::XMLElement const * element, std::vector const & params ); std::pair readCommandProto( tinyxml2::XMLElement const * element ); void readCommands( tinyxml2::XMLElement const * element ); std::string readComment( tinyxml2::XMLElement const * element ); void readDefine( tinyxml2::XMLElement const * element, std::map const & attributes ); void readEnum( tinyxml2::XMLElement const * element, EnumData & enumData, bool bitmask, std::string const & prefix, std::string const & postfix ); void readEnum( tinyxml2::XMLElement const * element, std::map const & attributes, EnumData & enumData, bool bitmask, std::string const & prefix, std::string const & postfix ); void readEnumAlias( tinyxml2::XMLElement const * element, std::map const & attributes, EnumData & enumData, bool bitmask, std::string const & prefix, std::string const & postfix ); void readEnumConstant( tinyxml2::XMLElement const * element ); void readEnums( tinyxml2::XMLElement const * element ); void readExtension( tinyxml2::XMLElement const * element ); void readExtensionDisabledCommand( tinyxml2::XMLElement const * element ); void readExtensionDisabledEnum( std::string const & extensionName, tinyxml2::XMLElement const * element ); void readExtensionDisabledRequire( std::string const & extensionName, tinyxml2::XMLElement const * element ); void readExtensionDisabledType( tinyxml2::XMLElement const * element ); void readExtensionRequire( tinyxml2::XMLElement const * element, std::string const & extension, std::string const & tag, std::map & requirements ); void readExtensionRequireCommand( tinyxml2::XMLElement const * element, std::string const & extension ); void readExtensionRequireType( tinyxml2::XMLElement const * element, std::string const & extension ); void readExtensions( tinyxml2::XMLElement const * element ); void readFeature( tinyxml2::XMLElement const * element ); void readFeatureRequire( tinyxml2::XMLElement const * element, std::string const & feature ); void readFeatureRequireCommand( tinyxml2::XMLElement const * element, std::string const & feature ); void readFeatureRequireType( tinyxml2::XMLElement const * element, std::string const & feature ); void readFuncpointer( tinyxml2::XMLElement const * element, std::map const & attributes ); void readHandle( tinyxml2::XMLElement const * element, std::map const & attributes ); std::pair readNameAndType( tinyxml2::XMLElement const * elements ); void readPlatform( tinyxml2::XMLElement const * element ); void readPlatforms( tinyxml2::XMLElement const * element ); void readRegistry( tinyxml2::XMLElement const * element ); void readRequireEnum( tinyxml2::XMLElement const * element, std::string const & tag ); void readRequireEnum( tinyxml2::XMLElement const * element, std::map const & attributes, std::string const & tag ); void readRequireEnumAlias( tinyxml2::XMLElement const * element, std::map const & attributes, std::string const & tag ); void readRequires( tinyxml2::XMLElement const * element, std::map const & attributes ); void readStruct( tinyxml2::XMLElement const * element, bool isUnion, std::map const & attributes ); void readStructAlias( tinyxml2::XMLElement const * element, std::map const & attributes ); void readStructMember( tinyxml2::XMLElement const * element, std::vector & members ); void readStructMemberEnum( tinyxml2::XMLElement const * element, MemberData & memberData ); void readStructMemberName( tinyxml2::XMLElement const * element, MemberData & memberData, std::vector const & members ); void readStructMemberType( tinyxml2::XMLElement const * element, MemberData & memberData ); void readTag( tinyxml2::XMLElement const * element ); void readTags( tinyxml2::XMLElement const * element ); void readType( tinyxml2::XMLElement const * element ); void readTypeEnum( tinyxml2::XMLElement const * element, std::map const & attributes ); void readTypeInclude( tinyxml2::XMLElement const * element, std::map const & attributes ); void readTypes( tinyxml2::XMLElement const * element ); void registerDeleter( std::string const & name, std::pair const & commandData ); void setVulkanLicenseHeader( int line, std::string const & comment ); std::string toString( TypeCategory category ); private: std::map m_baseTypes; std::map m_bitmasks; std::map m_commands; std::set m_constants; std::set m_defines; std::map m_enums; std::set m_extendedStructs; // structs which are referenced by the structextends tag std::map m_extensions; std::map m_features; std::map m_funcPointers; std::map m_handles; std::set m_includes; std::map m_platforms; std::map m_structureAliases; std::map m_structures; std::set m_sTypeValues; std::set m_tags; std::map m_types; std::string m_typesafeCheck; std::string m_version; std::string m_vulkanLicenseHeader; }; const size_t INVALID_INDEX = (size_t)~0;