SnConvX_MetaData.h

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2008-2022 NVIDIA Corporation. All rights reserved.
 
#ifndef SN_CONVX_METADATA_H
#define SN_CONVX_METADATA_H
 
#include "common/PxMetaDataFlags.h"
 
#include "SnConvX_Output.h"
#include "serialization/SnSerialUtils.h"
 
namespace physx { namespace Sn {
 
#if PX_VC
#pragma warning (push)
#pragma warning (disable : 4371) //layout of class may have changed from a previous version of the compiler due to better packing of member
#endif
 
 
    // PT: beware, must match corresponding structure in PxMetaData.h
    struct PxMetaDataEntry : public PxUserAllocated
    {
        PxMetaDataEntry()
        {
            memset(this, 0, sizeof(*this));
        }
        bool            isVTablePtr()   const;
 
        const char*     mType;          
        const char*     mName;          
        int             mOffset;        
        int             mSize;          
        int             mCount;         
        int             mOffsetSize;    
        int             mFlags;         
        int             mAlignment;     
    };
 
    struct MetaDataEntry32
    {
        PxI32           mType;          
        PxI32           mName;          
        int             mOffset;        
        int             mSize;          
        int             mCount;         
        int             mOffsetSize;    
        int             mFlags;         
        int             mAlignment;     
    };
 
    struct MetaDataEntry64
    {
        PxI64           mType;          
        PxI64           mName;          
        int             mOffset;        
        int             mSize;          
        int             mCount;         
        int             mOffsetSize;    
        int             mFlags;         
        int             mAlignment;     
    };
 
    struct ExtraDataEntry
    {
        PxMetaDataEntry entry;
        int             offset;
    };
 
    struct ExtraDataEntry2 : ExtraDataEntry
    {
        ConvertCallback cb;
    };
 
    class MetaData;
 
    struct MetaClass : public PxUserAllocated
    {
        bool                    getFieldByType(const char* type, PxMetaDataEntry& entry)    const;
        bool                    getFieldByName(const char* name, PxMetaDataEntry& entry)    const;
        bool                    check(const MetaData& owner);
 
        ConvertCallback         mCallback;
        MetaClass*              mMaster;
        const char*             mClassName;
        int                     mSize;
        int                     mDepth;
        PsArray<PxMetaDataEntry>    mBaseClasses;
        PsArray<PxMetaDataEntry>    mFields;
        bool                    mProcessed;
 
//      int                     mNbEntries;
//      ExtraDataEntry2         mEntries[256];
 
        private:
        void                    checkAndCompleteClass(const MetaData& owner, int& startOffset, int& nbBytes);
    };
 
    enum MetaDataType
    {
        META_DATA_NONE,
        META_DATA_SRC,
        META_DATA_DST
    };
 
    class ConvX;
    class MetaData : public PxUserAllocated
    {
        public:
                                        MetaData(Sn::ConvX&);
                                        ~MetaData();
        
                bool                    load(PxInputStream& inputStream, MetaDataType type);
 
        inline_ MetaDataType            getType()                           const   { return mType;                     }
        inline_ int                     getVersion()                        const   { return mVersion;                  }
        inline_ int                     getPtrSize()                        const   { return mSizeOfPtr;                }
        inline_ int                     getPlatformTag()                    const   { return mPlatformTag;              }
        inline_ int                     getGaussMapLimit()                  const   { return mGaussMapLimit;            }
        inline_ int                     getNbMetaClasses()                  const   { return int(mMetaClasses.size());  }
        inline_ MetaClass*              getMetaClass(unsigned int i)        const   { return mMetaClasses[i];           }
        inline_ bool                    getFlip()                           const   { return mFlip;                     }
 
                MetaClass*              getMetaClass(const char* name)  const;
                MetaClass*              getMetaClass(PxConcreteType::Enum concreteType) const;
                MetaClass*              addNewClass(const char* name, int size, MetaClass* master=NULL, ConvertCallback callback=NULL);
 
                bool                    compare(const MetaData& candidate) const;
        private:
                MetaData&               operator=(const MetaData&);
                Sn::ConvX&              mConvX;
                MetaDataType            mType;
                int                     mNbEntries;
                PxMetaDataEntry*        mEntries;
                char*                   mStringTable;
                PsArray<MetaClass*>     mMetaClasses;
                int                     mVersion;
                char                    mBinaryVersionGuid[SN_BINARY_VERSION_GUID_NUM_CHARS + 1];
                int                     mSizeOfPtr;
                int                     mPlatformTag;
                int                     mGaussMapLimit;
                bool                    mFlip;
 
                PsArray< PxPair<PxConcreteType::Enum, PxU32> > mConcreteTypeTable;
 
        inline_ const char*             offsetToText(const char* text)  const
                                        {
                                            const size_t offset = size_t(text);
                                            const PxU32 offset32 = PxU32(offset);
//                                          if(offset==-1)
                                            if(offset32==0xffffffff)
                                                return NULL;
                                            return mStringTable + offset32;
                                        }
        friend struct MetaClass;
    };
 
    PxU64   peek(int size, const char* buffer, int flags=0);
 
#if PX_VC
#pragma warning (pop)
#endif
} }
 
#endif