context_factory.hpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:6k
源码类别:

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: context_factory.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2003/10/31 20:19:45  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.7
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef GUI_CORE___CONTEXT_FACTORY__HPP
  10. #define GUI_CORE___CONTEXT_FACTORY__HPP
  11. /*  $Id: context_factory.hpp,v 1000.0 2003/10/31 20:19:45 gouriano Exp $
  12.  * ===========================================================================
  13.  *
  14.  *                            PUBLIC DOMAIN NOTICE
  15.  *               National Center for Biotechnology Information
  16.  *
  17.  *  This software/database is a "United States Government Work" under the
  18.  *  terms of the United States Copyright Act.  It was written as part of
  19.  *  the author's official duties as a United States Government employee and
  20.  *  thus cannot be copyrighted.  This software/database is freely available
  21.  *  to the public for use. The National Library of Medicine and the U.S.
  22.  *  Government have not placed any restriction on its use or reproduction.
  23.  *
  24.  *  Although all reasonable efforts have been taken to ensure the accuracy
  25.  *  and reliability of the software and data, the NLM and the U.S.
  26.  *  Government do not and cannot warrant the performance or results that
  27.  *  may be obtained by using this software or data. The NLM and the U.S.
  28.  *  Government disclaim all warranties, express or implied, including
  29.  *  warranties of performance, merchantability or fitness for any particular
  30.  *  purpose.
  31.  *
  32.  *  Please cite the author in any work or product based on this material.
  33.  *
  34.  * ===========================================================================
  35.  *
  36.  * Authors:  Mike DiCuccio
  37.  *
  38.  * File Description:
  39.  *    CContextFactory -- provides standard mechanisms for creating and managing
  40.  *                       named plugin contexts
  41.  */
  42. #include <gui/core/plugin_exception.hpp>
  43. #include <gui/core/plugin_factory.hpp>
  44. BEGIN_NCBI_SCOPE
  45. //
  46. // class CContextFactory defines a standard templated interface for maintenance
  47. // of a context-aware plugin.
  48. //
  49. // This class stores a list of explicitly named and managed contexts.  The
  50. // framework will marshall contexts per a user's requests and requirements.
  51. // There is one specially named context - the "empty name" context (where name
  52. // is the empty string).  This is the default context used by a given plugin,
  53. // where a default context is supported (i.e., data loaders, algorithms -
  54. // default context doesn't necessarily match a view's notion of context).
  55. //
  56. template <class PluginType>
  57. class CContextFactory : public CPluginFactory<PluginType>
  58. {
  59. private:
  60.     // we maintain a map of name to context
  61.     typedef map<string, CRef<PluginType> > TContexts;
  62.     TContexts m_Contexts;
  63. protected:
  64.     // modes of operation for context creation
  65.     enum EContextCreateMode {
  66.         eImplicitCreate,
  67.         eNoImplicitCreate
  68.     };
  69.     // query to see if a given named context exists
  70.     bool x_HasContext(const string& name) const
  71.     {
  72.         typename TContexts::const_iterator iter = m_Contexts.find(name);
  73.         return (iter != m_Contexts.end());
  74.     }
  75.     // main context request interface
  76.     PluginType& x_GetContext(const string& name,
  77.                              const objects::CPluginArgSet& args,
  78.                              EContextCreateMode mode = eImplicitCreate)
  79.     {
  80.         typename TContexts::iterator iter = m_Contexts.find(name);
  81.         if (iter != m_Contexts.end()) {
  82.             return *(iter->second);
  83.         }
  84.         if (mode == eNoImplicitCreate) {
  85.             NCBI_THROW(CPluginException, eNotSupported,
  86.                        "Attempted to access non-existent context");
  87.         }
  88.         CRef<PluginType> context(new PluginType());
  89.         m_Contexts[name] = context;
  90.         return *context;
  91.     }
  92.     // overloaded context creation function
  93.     virtual void x_OnCreateContext(const string& name,
  94.                                    const objects::CPluginArgSet& args,
  95.                                    objects::CPluginReply& reply)
  96.     {
  97.         if (x_HasContext(name)) {
  98.             reply.SetStatus(objects::eMessageStatus_ignored);
  99.             return;
  100.         }
  101.         // we've requested a named context be created
  102.         x_GetContext(name, args);
  103.         reply.SetStatus(objects::eMessageStatus_success);
  104.     }
  105.     // overloaded context destruction function
  106.     virtual void x_OnDestroyContext(const string& name,
  107.                                     objects::CPluginReply& reply)
  108.     {
  109.         if ( !x_HasContext(name) ) {
  110.             reply.SetStatus(objects::eMessageStatus_ignored);
  111.             return;
  112.         }
  113.         m_Contexts.erase(m_Contexts.find(name));
  114.         reply.SetStatus(objects::eMessageStatus_success);
  115.     }
  116. };
  117. END_NCBI_SCOPE
  118. /*
  119.  * ===========================================================================
  120.  * $Log: context_factory.hpp,v $
  121.  * Revision 1000.0  2003/10/31 20:19:45  gouriano
  122.  * PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.7
  123.  *
  124.  * Revision 1.7  2003/08/22 15:54:48  dicuccio
  125.  * General clean-up:  Removed unneeded export specifiers from templates; removed
  126.  * 'USING_SCOPE(objects)'
  127.  *
  128.  * Revision 1.6  2003/07/14 10:56:57  shomrat
  129.  * Plugin messageing system related changes
  130.  *
  131.  * Revision 1.5  2003/06/25 16:59:41  dicuccio
  132.  * Changed CPluginHandle into a pointer-to-implementation (the previous
  133.  * implementation is now the pointer held).  Lots of #include file clean-ups.
  134.  *
  135.  * Revision 1.4  2003/06/20 14:44:36  dicuccio
  136.  * Revamped handling of plugin registration.  All plugin factories now derive
  137.  * from CPluginFactoryBase; CPluginFactory is a template.  There is a new
  138.  * requirement for derived plugin handlers of all types (each must implement a
  139.  * static function of the form 'static void GetInfo(CPluginInfo&)')
  140.  *
  141.  * Revision 1.3  2003/02/24 13:00:17  dicuccio
  142.  * Renamed classes in plugin spec:
  143.  *     CArgSeg --> CPluginArgSet
  144.  *     CArgument --> CPluginArg
  145.  *     CPluginArgs --> CPluginCommand
  146.  *     CPluginCommands --> CPluginCommandSet
  147.  *
  148.  * Revision 1.2  2003/02/21 16:44:13  dicuccio
  149.  * Added Win32 export specifiers for new plugin library.  Fixed compilation
  150.  * issues for Win32.
  151.  *
  152.  * Revision 1.1  2003/02/20 19:44:06  dicuccio
  153.  * Created new plugin architecture, mediated via an ASN.1 spec.  Moved GBENCH
  154.  * framework over to use new plugin architecture.
  155.  *
  156.  * ===========================================================================
  157.  */
  158. #endif  // GUI_CORE___CONTEXT_FACTORY__HPP