cmnClassServices.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*

  Author(s):  Anton Deguet
  Created on: 2004-08-18

  (C) Copyright 2004-2014 Johns Hopkins University (JHU), All Rights Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---

*/


#pragma once

#ifndef _cmnClassServices_h
#define _cmnClassServices_h

#include <cisstCommon/cmnPortability.h>
#include <cisstCommon/cmnForwardDeclarations.h>
#include <cisstCommon/cmnClassServicesBase.h>
#include <cisstCommon/cmnGenericObject.h>
#include <cisstCommon/cmnLogger.h>
#include <cisstCommon/cmnClassRegisterMacros.h>

//************************ Factory with Default Constructor ***********************

template<bool _enabled, typename _class>
class cmnConditionalObjectFactoryDefault
{
public:
    inline static cmnGenericObject * Create(void) {
        return 0;
    }

    inline static cmnGenericObject * CreateArray(size_t CMN_UNUSED(size)) {
        return 0;
    }

    inline static bool DefaultConstructorAvailable(void) { return false; }
};


template <typename _class>
class cmnConditionalObjectFactoryDefault<true, _class>
{
    typedef _class value_type;
public:

    inline static cmnGenericObject * Create(void) {
        return new value_type;
    }

    inline static cmnGenericObject * CreateArray(size_t size) {
        return new value_type[size];
    }

    inline static bool DefaultConstructorAvailable(void) { return true; }
};

//************************ Factory with Copy Constructor ***********************

template<bool _enabled, typename _class>
class cmnConditionalObjectFactoryCopy
{
public:

    inline static cmnGenericObject * Create(const cmnGenericObject & CMN_UNUSED(other)) {
         return 0;
    }

    inline static bool Create(cmnGenericObject * CMN_UNUSED(existing), const cmnGenericObject & CMN_UNUSED(other)) {
        return false;
    }

    inline static cmnGenericObject * CreateArray(size_t CMN_UNUSED(size), const cmnGenericObject & CMN_UNUSED(other)) {
        return 0;
    }

    inline static bool CopyConstructorAvailable(void) { return false; }
};


template <typename _class>
class cmnConditionalObjectFactoryCopy<true, _class>
{
public:
    typedef _class value_type;
    typedef _class * pointer;

    inline static cmnGenericObject * Create(const cmnGenericObject & other) {
        const value_type * otherPointer = dynamic_cast<const value_type *>(&other);
        if (otherPointer)
            return new value_type(*otherPointer);
        else
            return 0;
    }

    inline static bool Create(cmnGenericObject * existing, const cmnGenericObject & other) {
        if (existing->Services() != other.Services()) {
            CMN_LOG_RUN_WARNING << "cmnClassServices::Create with in-place new called for different classes, existing = "
                                << existing->Services()->GetName()
                                << ", other = " << other.Services()->GetName() << std::endl;
            return false;
        }
        // If they already point to the same memory, just return
        if (existing == &other)
            return true;
        const value_type * otherPointer = dynamic_cast<const value_type *>(&other);
        if (otherPointer) {
            existing->Services()->Delete(existing);
            new(existing) value_type(*otherPointer);
            return true;
        } else {
            return false;
        }
    }

    inline static cmnGenericObject * CreateArray(size_t size, const cmnGenericObject & other) {
        const value_type * otherPointer = dynamic_cast<const value_type *>(&other);
        if (otherPointer) {
            pointer data = static_cast<pointer>(::operator new(sizeof(value_type) * size));
            size_t index;
            for (index = 0; index < size; index++) {
                new(&(data[index])) value_type(*otherPointer); // placement new with copy constructor
            }
            return data;
        }
        return 0;
    }

    inline static bool CopyConstructorAvailable(void) { return true; }
};

//************************ Factory with One Arg Constructor ***********************

template<int _dynamicCreation, typename _class, typename _argType>
class cmnConditionalObjectFactoryOneArg
{
public:

    inline static cmnGenericObject * Create(const cmnGenericObject & CMN_UNUSED(arg)) {
         return 0;
    }

    inline static bool OneArgConstructorAvailable(void) { return false; }

    inline static const cmnClassServicesBase *GetConstructorArgServices(void) {
        return 0;
    }
};

template<typename _class, typename _argType>
class cmnConditionalObjectFactoryOneArg<CMN_DYNAMIC_CREATION_ONEARG, _class, _argType>
{
public:
    typedef _class value_type;

    inline static _class * Create(const cmnGenericObject & arg) {
        const _argType *argTyped = dynamic_cast<const _argType *>(&arg);
        if (argTyped)
            return new value_type(*argTyped);
        else {
            CMN_LOG_INIT_WARNING << "cmnConditionalObjectFactoryOneArg: failed to dynamic cast from "
                                 << arg.Services()->GetName() << " to "
                                 << _argType::ClassServices()->GetName() << std::endl;
            return 0;
        }
    }

    inline static bool OneArgConstructorAvailable(void) { return true; }

    inline static const cmnClassServicesBase *GetConstructorArgServices(void) {
        return _argType::ClassServices();
    }
};

//************************ Destructors ***********************

template<int _hasDynamicCreation, typename _class>
class cmnConditionalObjectDestructor
{
    typedef _class value_type;
    typedef _class * pointer;
    typedef cmnGenericObject * generic_pointer;
public:
    inline static bool DeleteArray(generic_pointer & data, size_t & size) {
        pointer typedData = dynamic_cast<pointer>(data);
        if (typedData) {
            size_t index;
            for (index = 0; index < size; index++) {
                typedData[index].~value_type();
            }
            delete typedData;
            data = 0;
            size = 0;
            return true;
        }
        return false;
    }


    inline static bool Delete(cmnGenericObject * existing) {
        value_type * existingPointer = dynamic_cast<value_type *>(existing);
        if (existingPointer) {
            existingPointer->~value_type();
            return true;
        } else {
            return false;
        }
    }
};

template<typename _class>
class cmnConditionalObjectDestructor<CMN_NO_DYNAMIC_CREATION, _class>
{
    typedef cmnGenericObject * generic_pointer;
public:
    inline static bool DeleteArray(generic_pointer & CMN_UNUSED(data), size_t & CMN_UNUSED(size)) {
        return false;
    }

    inline static bool Delete(cmnGenericObject * CMN_UNUSED(existing)) {
        return false;
    }
};


//************************************ Class Services ****************************
template <int _dynamicCreation, class _class, class _argType = _class>
class cmnClassServices: public cmnClassServicesBase {

    typedef cmnConditionalObjectFactoryDefault<
        ((_dynamicCreation&CMN_DYNAMIC_CREATION_DEFAULT) == CMN_DYNAMIC_CREATION_DEFAULT), _class> FactoryDefaultType;
    typedef cmnConditionalObjectFactoryCopy<
        ((_dynamicCreation&CMN_DYNAMIC_CREATION_COPY) == CMN_DYNAMIC_CREATION_COPY), _class> FactoryCopyType;
    typedef cmnConditionalObjectFactoryOneArg<_dynamicCreation, _class, _argType> FactoryOneArgType;
    typedef cmnConditionalObjectDestructor<_dynamicCreation, _class> DestructorType;

 public:

    typedef cmnClassServicesBase BaseType;

    /* documented in base class */
    typedef cmnGenericObject * generic_pointer;

    cmnClassServices(const std::string & className, const std::type_info * typeInfo,
                     const cmnClassServicesBase * parentServices,
                     const std::string & libraryName,
                     cmnLogMask mask = CMN_LOG_ALLOW_DEFAULT):
        BaseType(className, typeInfo, parentServices, libraryName, mask)
    {}

    /* documented in base class */
    virtual cmnGenericObject * Create(void) const {
        return FactoryDefaultType::Create();
    }

    /* documented in base class */
    virtual cmnGenericObject * Create(const cmnGenericObject & other) const {
        return FactoryCopyType::Create(other);
    }

    /* documented in base class */
    virtual cmnGenericObject * CreateWithArg(const cmnGenericObject & arg) const {
        return FactoryOneArgType::Create(arg);
    }

    /* documented in base class */
    virtual bool Create(cmnGenericObject * existing, const cmnGenericObject & other) const {
        return FactoryCopyType::Create(existing, other);
    }

    /* documented in base class */
    virtual cmnGenericObject * CreateArray(size_t size) const {
        return FactoryDefaultType::CreateArray(size);
    }

    /* documented in base class */
    virtual cmnGenericObject * CreateArray(size_t size, const cmnGenericObject & other) const {
        return FactoryCopyType::CreateArray(size, other);
    }

    /* documented in base class */
    virtual bool DeleteArray(generic_pointer & data, size_t & size) const {
        return DestructorType::DeleteArray(data, size);
    }

    /* documented in base class */
    virtual bool Delete(cmnGenericObject * existing) const {
        return DestructorType::Delete(existing);
    }

    /* documented in base class */
    virtual size_t GetSize(void) const {
        return sizeof(_class);
    }

    /* documented in base class */
    bool HasDynamicCreation(void) const { return (_dynamicCreation != CMN_NO_DYNAMIC_CREATION); }
    bool DefaultConstructorAvailable(void) const { return FactoryDefaultType::DefaultConstructorAvailable(); }
    bool CopyConstructorAvailable(void) const { return FactoryCopyType::CopyConstructorAvailable(); }
    bool OneArgConstructorAvailable(void) const { return FactoryOneArgType::OneArgConstructorAvailable(); }

    const cmnClassServicesBase *GetConstructorArgServices(void) const {
        return FactoryOneArgType::GetConstructorArgServices();
    }
};

#endif // _cmnClassServices_h