include/foundation/PxBroadcast.h

File members: include/foundation/PxBroadcast.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-2023 NVIDIA Corporation. All rights reserved.
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.

#ifndef PX_BROADCAST_H
#define PX_BROADCAST_H

#include "foundation/PxInlineArray.h"
#include "foundation/PxSimpleTypes.h"
#include "foundation/PxErrorCallback.h"

#if !PX_DOXYGEN
namespace physx
{
#endif

class PxAllocationListener
{
  public:
    virtual void onAllocation(size_t size, const char* typeName, const char* filename, int line,
                              void* allocatedMemory) = 0;

    virtual void onDeallocation(void* allocatedMemory) = 0;

  protected:
    virtual ~PxAllocationListener()
    {
    }
};

template <class Listener, class Base>
class PxBroadcast : public Base
{
  public:
    static const uint32_t MAX_NB_LISTENERS = 16;

    PxBroadcast()
    {
    }

    void registerListener(Listener& listener)
    {
        if(mListeners.size() < MAX_NB_LISTENERS)
            mListeners.pushBack(&listener);
    }

    void deregisterListener(Listener& listener)
    {
        mListeners.findAndReplaceWithLast(&listener);
    }

    uint32_t getNbListeners() const
    {
        return mListeners.size();
    }

    Listener& getListener(uint32_t index)
    {
        PX_ASSERT(index <= mListeners.size());
        return *mListeners[index];
    }

  protected:
    virtual ~PxBroadcast()
    {
    }

    physx::PxInlineArray<Listener*, MAX_NB_LISTENERS, physx::PxAllocator> mListeners;
};

class PxBroadcastingAllocator : public PxBroadcast<PxAllocationListener, PxAllocatorCallback>
{
    PX_NOCOPY(PxBroadcastingAllocator)

  public:
    PxBroadcastingAllocator(PxAllocatorCallback& allocator, PxErrorCallback& error) : mAllocator(allocator), mError(error)
    {
        mListeners.clear();
    }

    virtual ~PxBroadcastingAllocator()
    {
        mListeners.clear();
    }

    void* allocate(size_t size, const char* typeName, const char* filename, int line)
    {
        void* mem = mAllocator.allocate(size, typeName, filename, line);

        if(!mem)
        {
            mError.reportError(PxErrorCode::eABORT, "User allocator returned NULL.", PX_FL);
            return NULL;
        }

        if((size_t(mem) & 15))
        {
            mError.reportError(PxErrorCode::eABORT, "Allocations must be 16-byte aligned.", PX_FL);
            return NULL;
        }

        for(uint32_t i = 0; i < mListeners.size(); i++)
            mListeners[i]->onAllocation(size, typeName, filename, line, mem);

        return mem;
    }

    void deallocate(void* ptr)
    {
        for(uint32_t i = 0; i < mListeners.size(); i++)
        {
            mListeners[i]->onDeallocation(ptr);
        }
        mAllocator.deallocate(ptr);
    }

  private:
    PxAllocatorCallback& mAllocator;
    PxErrorCallback& mError;
};

class PxBroadcastingErrorCallback : public PxBroadcast<PxErrorCallback, PxErrorCallback>
{
    PX_NOCOPY(PxBroadcastingErrorCallback)
  public:
    PxBroadcastingErrorCallback(PxErrorCallback& errorCallback)
    {
        registerListener(errorCallback);
    }

    virtual ~PxBroadcastingErrorCallback()
    {
        mListeners.clear();
    }

    void reportError(PxErrorCode::Enum code, const char* message, const char* file, int line)
    {
        for(uint32_t i = 0; i < mListeners.size(); i++)
            mListeners[i]->reportError(code, message, file, line);
    }
};
#if !PX_DOXYGEN
} // namespace physx
#endif

#endif