oaCommonPlugInBase.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaCommonPlugInBase.h
//
// This file contains implementations for the plug-in base interface classes.
// This implementation may be used by the interface user or implementation.
// These objects are used to pass information through the interface.
//
// The following classes are supported:
//
//  NString
//      This class is a string that implement the IString interface, but
//      contains no reference count. It's intended to be used as a class member
//      to allow an inernal string to be passed back as an IString, without
//      worrying about a "release" call causing a crash in the "delete" code.
//
//  StringImp
//      This is a class that can be used by plug-ins to implement the IString
//      interface - which is used to pass strings through interfaces when the
//      lifetime of the string needs to be managed past the lifetime of the
//      function call.
//
// *****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaCommonPlugInBase_P)
#define oaCommonPlugInBase_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaCommonIBase.h"
#include <string>



// *****************************************************************************
// Declare and define types in the oaCommon namespace
// *****************************************************************************
BEGIN_OA_COMMON_NAMESPACE



// *****************************************************************************
// PlugInBase
// *****************************************************************************
template<class I = IBase>
class PlugInBase : public I {
public:
    typedef I               Type;

                            PlugInBase(unsigned long refIn = 0);
    virtual inline          ~PlugInBase();

    virtual long            queryInterface(const Guid   &id,
                                           void         **iPtr);
    virtual unsigned long   addRef();
    virtual unsigned long   release();

protected:
    unsigned long           ref;
};



// *****************************************************************************
// NString
// *****************************************************************************
class OA_COMMON_DLL_API NString {
public:
                            NString(const char *in = NULL);
                            NString(const NString &str);
                            ~NString();

                            operator                const char*() const;
    NString                 &operator=(const char *str);
    NString                 &operator=(const NString &str);

    oa::oaUInt4             length() const;

protected:
    struct StrBuff {
        oa::oaUInt2         refCount;
        oa::oaUInt2         length;
        char                buffer[1];
    };

    StrBuff                 *value;

private:
    void                    clear();

    static StrBuff          *dup(const char *str);
    static StrBuff          *dup(StrBuff *str);
};



// *****************************************************************************
// StringImp
// *****************************************************************************
class OA_COMMON_DLL_API StringImp : public IString, public NString {
public:
                                StringImp(const char *in);
                                StringImp(const NString &str);

    virtual unsigned long       addRef();
    virtual unsigned long       release();
    virtual long                queryInterface(const Guid   &id,
                                               void         **iPtr);
    virtual inline const char   *str();

private:
    unsigned long               refCount;
};



// *****************************************************************************
// StaticString
// *****************************************************************************
class OA_COMMON_DLL_API StaticString : public PlugInBase<IString> {
public:
                                StaticString(const char *in);

    virtual inline const char   *str();

private:
    const char                  *val;
};



// *****************************************************************************
// StlIString
// *****************************************************************************
class StlIString : public PlugInBase<IString> {
public:
                                StlIString(const std::string &str);

    virtual inline const char   *str();

private:
    std::string                 val;
};



// *****************************************************************************
// ExceptionBase
// *****************************************************************************
class ExceptionBase : public IException {
public:
                                ExceptionBase(oa::oaUInt4   idIn,
                                              const char    *msgIn);

    virtual inline oa::oaUInt4  getMsgId() const;
    virtual inline const char   *getMsg() const;

private:
    oa::oaUInt4                 id;
    NString                     msg;
};



// *****************************************************************************
// ArrayIter
// *****************************************************************************
template<class I, class T>
class ArrayIter : public PlugInBase<I> {
public:
                            ArrayIter(oa::oaInt4 initialCap = 0);
    virtual                 ~ArrayIter();

    virtual bool            next(typename I::Type &objOut);
    virtual void            reset();

    void                    add(const T &elem);

private:
    void                    addReference(IBase *obj);
    void                    addReference(...);

    T                       *array;
    oa::oaInt4              size;
    oa::oaInt4              capacity;
    oa::oaInt4              current;
};



// *****************************************************************************
// IDTester
// *****************************************************************************
template<class I>
class IDTester {
public:
    static bool             test(const Guid &id);
};

template<>
class IDTester<IBase> {
public:
    static bool             test(const Guid &id);
};



END_OA_COMMON_NAMESPACE

#endif

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.