NvParameterizedTraits.h

Go to the documentation of this file.

// This code contains NVIDIA Confidential Information and is disclosed to you
// under a form of NVIDIA software license agreement provided separately to you.
//
// Notice
// NVIDIA Corporation and its licensors retain all intellectual property and
// proprietary rights in and to this software and related documentation and
// any modifications thereto. Any use, reproduction, disclosure, or
// distribution of this software and related documentation without an express
// license agreement from NVIDIA Corporation is strictly prohibited.
//
// ALL NVIDIA DESIGN SPECIFICATIONS, CODE ARE PROVIDED "AS IS.". NVIDIA MAKES
// NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.
//
// Information and code furnished is believed to be accurate and reliable.
// However, NVIDIA Corporation assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA Corporation. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA Corporation products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA Corporation.
//
// Copyright (c) 2008-2013 NVIDIA Corporation. All rights reserved.

#ifndef NV_PARAMETERIZED_TRAITS_H
#define NV_PARAMETERIZED_TRAITS_H

#include <string.h>
#include "foundation/PxAssert.h"

namespace NvParameterized
{

PX_PUSH_PACK_DEFAULT

class Traits;
class Interface;

class Factory
{
public:

    virtual ::NvParameterized::Interface *create( Traits *paramTraits ) = 0;

    virtual ::NvParameterized::Interface *finish( Traits *paramTraits, void *obj, void *buf, int32_t *refCount ) = 0;

    virtual const char * getClassName() = 0;

    virtual uint32_t getVersion() = 0;

    virtual uint32_t getAlignment() = 0;

    virtual const uint32_t * getChecksum( uint32_t &bits ) = 0;

    virtual ~Factory() {}

    virtual void freeParameterDefinitionTable(NvParameterized::Traits* traits) = 0;
};

class Conversion
{
public:
    virtual ~Conversion() {}

    virtual bool operator()(::NvParameterized::Interface &legacyObj, ::NvParameterized::Interface &obj) = 0;

    virtual void release() = 0;
};

class Traits
{
public:
    virtual ~Traits() {}

    virtual void registerFactory( ::NvParameterized::Factory & factory ) = 0;

    virtual ::NvParameterized::Factory *removeFactory( const char * className ) = 0;

    virtual ::NvParameterized::Factory *removeFactory( const char * className, uint32_t version ) = 0;

    virtual bool doesFactoryExist(const char* className) = 0;

    virtual bool doesFactoryExist(const char* className, uint32_t version) = 0;

    virtual ::NvParameterized::Interface * createNvParameterized( const char * name ) = 0;

    virtual ::NvParameterized::Interface * createNvParameterized( const char * name, uint32_t ver ) = 0;

    virtual ::NvParameterized::Interface * finishNvParameterized( const char * name, void *obj, void *buf, int32_t *refCount ) = 0;

    virtual ::NvParameterized::Interface * finishNvParameterized( const char * name, uint32_t ver, void *obj, void *buf, int32_t *refCount ) = 0;

    virtual uint32_t getCurrentVersion(const char *className) const = 0;

    virtual uint32_t getAlignment(const char *className, uint32_t classVersion) const = 0;

    virtual void registerConversion(const char * /*className*/, uint32_t /*from*/, uint32_t /*to*/, Conversion & /*conv*/) {}

    virtual ::NvParameterized::Conversion *removeConversion(const char * /*className*/, uint32_t /*from*/, uint32_t /*to*/) { return 0; }

    virtual bool updateLegacyNvParameterized(::NvParameterized::Interface &legacyObj, ::NvParameterized::Interface &obj)
    {
        PX_UNUSED(&legacyObj);
        PX_UNUSED(&obj);

        return false;
    }

    virtual bool getNvParameterizedNames( const char ** names, uint32_t &outCount, uint32_t inCount) const = 0;

    virtual bool getNvParameterizedVersions(const char* className, uint32_t* versions, uint32_t &outCount, uint32_t inCount) const = 0;

    virtual int32_t incRefCount(int32_t *refCount) = 0;

    virtual int32_t decRefCount(int32_t *refCount) = 0;

    virtual void onInplaceObjectDestroyed(void * /*buf*/, ::NvParameterized::Interface * /*obj*/) {}

    virtual void onAllInplaceObjectsDestroyed(void *buf) { free(buf); }

    virtual void *alloc(uint32_t nbytes) = 0;

    virtual void *alloc(uint32_t nbytes, uint32_t align) = 0;

    virtual void free(void *buf) = 0;

    virtual char *strdup(const char *str)
    {
        if( !str )
            return NULL;

        uint32_t strLen = (uint32_t)strlen(str) + 1;
        char *retStr = (char *)this->alloc(strLen, 1);
        
        PX_ASSERT( retStr );
        
        if( NULL != retStr )
#if PX_WINDOWS_FAMILY || PX_XBOXONE
            strcpy_s( retStr, strLen, str );
#else
            strncpy(retStr, str, strLen);
#endif
        return retStr;
    }

    virtual void strfree(char *str)
    {
        if( NULL != str )
            this->free( str );
    }

    virtual void traitsWarn(const char * /*msg*/) const {}

    virtual void release(void) = 0;

    class Allocator
    {
		::NvParameterized::Traits *mTraits;

    public:

        Allocator(Traits *traits): mTraits(traits) {}

        void *allocate(size_t size)
        {
            return allocate(size, __FILE__, __LINE__);
        }

        void *allocate(size_t size, const char * /*filename*/, int /*line*/)
        {
            PX_ASSERT( static_cast<uint32_t>(size) == size );
            return mTraits->alloc(static_cast<uint32_t>(size));
        }

        void deallocate(void *ptr)
        {
            return mTraits->free(ptr);
        }
    };
};


PX_POP_PACK

} // namespace NvParameterized

#endif // NV_PARAMETERIZED_TRAITS_H