oaCommonPlugInMgr.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaCommonPlugInMgr.h
//
// This file contains the definition of the oaPlugInMgr class. This class is 
// used to obtain component and factory objects.  Only a single plugin manager
// should exist, so the constructor is private; users should get the plugin
// manager using the static method getPlugInManager(), and call release() on
// that manager when finished with it.
//
// *****************************************************************************
// 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(oaCommonPlugInMgr_P)
#define oaCommonPlugInMgr_P



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



#if defined(OA_WINDOWS)
#define oacPlugInPathSeparator ";"
#else
#define oacPlugInPathSeparator ":"
#endif



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



// *****************************************************************************
// Forward declarations
// *****************************************************************************
class PlugInTable;
class IFactory;
class IBase;
class PlugInLib;

// *****************************************************************************
// oaPlugInMgr
// *****************************************************************************
class OA_COMMON_DLL_PVT oaPlugInMgr {
public:
                            ~oaPlugInMgr();

    static oaPlugInMgr      *getPlugInMgr();
    static void             registerFactory(const char  *classID,
                                            IFactory    *factory);
    static void             revokeFactory(const char *classID);


    void                    createInstance(const char   *classID,
                                           IBase        *reserved,
                                           const Guid   &interfaceID,
                                           void         **ptr);
    void                    getClassFactory(const char  *classID,
                                            const Guid  &interfaceID,
                                            void        **ptr);

    const char              *getPlugInSearchPath() const;

    static const char       *getPlugInDir();
    static const char       *getPlugInExt();

private:
                            oaPlugInMgr();

    void                    checkCompatibility(IBase        *plugIn,
                                               const char   *classID) const;

    PlugInTable             *table;

    static std::string      plugInDir;

    static const char*const plugInExt;
};



END_OA_COMMON_NAMESPACE

#endif

Return to top of page

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