ObjectBase.hpp

Go to the documentation of this file.

/*
 *  Copyright 2019-2021 Diligent Graphics LLC
 *  Copyright 2015-2019 Egor Yusov
 *  
 *  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.
 *
 *  In no event and under no legal theory, whether in tort (including negligence), 
 *  contract, or otherwise, unless required by applicable law (such as deliberate 
 *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
 *  liable for any damages, including any direct, indirect, special, incidental, 
 *  or consequential damages of any character arising as a result of this License or 
 *  out of the use or inability to use the software (including but not limited to damages 
 *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
 *  all other commercial damages or losses), even if such Contributor has been advised 
 *  of the possibility of such damages.
 */
 
#pragma once
 
 
#include "../../Primitives/interface/Object.h"
#include "RefCountedObjectImpl.hpp"
 
namespace Diligent
{
 
 
#define IMPLEMENT_QUERY_INTERFACE_BODY(InterfaceID, ParentClassName) \
    {                                                                \
        if (ppInterface == nullptr)                                  \
            return;                                                  \
        if (IID == InterfaceID)                                      \
        {                                                            \
            *ppInterface = this;                                     \
            (*ppInterface)->AddRef();                                \
        }                                                            \
        else                                                         \
        {                                                            \
            ParentClassName::QueryInterface(IID, ppInterface);       \
        }                                                            \
    }
 
#define IMPLEMENT_QUERY_INTERFACE(ClassName, InterfaceID, ParentClassName)         \
    void ClassName::QueryInterface(const INTERFACE_ID& IID, IObject** ppInterface) \
        IMPLEMENT_QUERY_INTERFACE_BODY(InterfaceID, ParentClassName)
 
#define IMPLEMENT_QUERY_INTERFACE_IN_PLACE(InterfaceID, ParentClassName)                                    \
    virtual void DILIGENT_CALL_TYPE QueryInterface(const INTERFACE_ID& IID, IObject** ppInterface) override \
        IMPLEMENT_QUERY_INTERFACE_BODY(InterfaceID, ParentClassName)
 
 
template <typename BaseInterface>
class ObjectBase : public RefCountedObject<BaseInterface>
{
public:
    ObjectBase(IReferenceCounters* pRefCounters) :
        RefCountedObject<BaseInterface>{pRefCounters}
    {}
 
    virtual void DILIGENT_CALL_TYPE QueryInterface(const INTERFACE_ID& IID, IObject** ppInterface)
    {
        if (ppInterface == nullptr)
            return;
 
        *ppInterface = nullptr;
        if (IID == IID_Unknown)
        {
            *ppInterface = this;
            (*ppInterface)->AddRef();
        }
    }
};
 
} // namespace Diligent