registry.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: registry.hpp,v $
 * PRODUCTION Revision 1000.0  2003/10/31 20:22:56  gouriano
 * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.8
 * PRODUCTION
 * ===========================================================================
 */

#ifndef GUI_CORE___REGISTRY__HPP
#define GUI_CORE___REGISTRY__HPP

/*  $Id: registry.hpp,v 1000.0 2003/10/31 20:22:56 gouriano Exp $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Authors:  Mike DiCuccio
 *
 * File Description:
 *    Base class for GBENCH plug-in registries
 */

#include <gui/scope.hpp>
#include <gui/core/plugin.hpp>
#include <corelib/ncbiobj.hpp>

BEGIN_NCBI_SCOPE

//
// Base class for the plugin registry
//

class NCBI_GUICORE_EXPORT CPluginRegistry : public CObject
{
public:
    // Typedef for the version function common to all plug-ins
    typedef void (*FVersionFunc)(int&, int&, int&);

    // Typedef for lists of generic plugin info objects
    typedef list< CRef<CPlugin> > TPlugins;

    // virtual dtor to get a real virtual table
    virtual ~CPluginRegistry() { }

protected:
    // protected ctor
    CPluginRegistry() { }

    // Extract a list of plugin info objects from the given path.
    // This accepts a colon-separated path listing that tracks the directories
    // that should be searched.  The 'type' designator refers to the type of
    // plug-in that will be extracted (i.e., view or algo).
    static TPlugins x_GetPlugins(const string& path, const string& type);

private:
    // copying prohibited
    CPluginRegistry(const CPluginRegistry&);
    CPluginRegistry& operator= (const CPluginRegistry&);
};


END_NCBI_SCOPE

#endif  // GUI_CORE___REGISTRY__HPP


/*
 * ===========================================================================
 * $Log: registry.hpp,v $
 * Revision 1000.0  2003/10/31 20:22:56  gouriano
 * PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.8
 *
 * Revision 1.8  2003/01/13 13:11:42  dicuccio
 * Namespace clean-up.  Retired namespace gui -> converted to namespace ncbi.
 * Moved all FLUID-generated code into namespace ncbi.
 *
 * Revision 1.7  2003/01/10 17:40:48  dicuccio
 * Added accessor to determine if a plugin has been loaded yet.  Changed
 * TPluginList --> TPlugins.  Added accessors for all available plugins.
 *
 * Revision 1.6  2002/12/19 18:13:02  dicuccio
 * Added export specifiers for Win32.
 *
 * Revision 1.5  2002/12/11 18:54:42  dicuccio
 * Minor tweak to avoid a compiler warning about private constructors.
 *
 * Revision 1.4  2002/12/05 16:30:04  dicuccio
 * Changed 'EXPORT_PLUGIN' to 'NCBI_GUICORE_EXPORT' to match planned API for remainder
 * of toolkit.  Added __declspec() macros for gui toolkit (windows dll
 * compatibility).
 *
 * Revision 1.3  2002/11/07 18:22:43  dicuccio
 * Clean-up of plug-in architecture.  Provided macros for handling plug-in
 * registration functions.
 *
 * Revision 1.2  2002/11/05 19:47:06  dicuccio
 * Some of CPluginRegistry::x_GetPlugins() functionality moved to the
 * GBENCH application
 *
 * Revision 1.1  2002/11/04 21:09:06  dicuccio
 * Initial revision
 *
 * ===========================================================================
 */