开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 数值算法/人工智能 > 生物技术 > 查看源码
plugin_handle.cpp
资源名称：ncbi_cxx_win--Jul_08_2004.zip　[点击查看]
上传用户：yhdzpy8989
上传日期：2007-06-13
资源大小：13604k
文件大小：11k
源码类别：

生物技术

开发平台：

C/C++

plugin_handle.cpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: plugin_handle.cpp,v $
  4.  * PRODUCTION Revision 1000.5  2004/06/01 20:44:23  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.22
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. /*  $Id: plugin_handle.cpp,v 1000.5 2004/06/01 20:44:23 gouriano Exp $
  11.  * ===========================================================================
  12.  *
  13.  *                            PUBLIC DOMAIN NOTICE
  14.  *               National Center for Biotechnology Information
  15.  *
  16.  *  This software/database is a "United States Government Work" under the
  17.  *  terms of the United States Copyright Act.  It was written as part of
  18.  *  the author's official duties as a United States Government employee and
  19.  *  thus cannot be copyrighted.  This software/database is freely available
  20.  *  to the public for use. The National Library of Medicine and the U.S.
  21.  *  Government have not placed any restriction on its use or reproduction.
  22.  *
  23.  *  Although all reasonable efforts have been taken to ensure the accuracy
  24.  *  and reliability of the software and data, the NLM and the U.S.
  25.  *  Government do not and cannot warrant the performance or results that
  26.  *  may be obtained by using this software or data. The NLM and the U.S.
  27.  *  Government disclaim all warranties, express or implied, including
  28.  *  warranties of performance, merchantability or fitness for any particular
  29.  *  purpose.
  30.  *
  31.  *  Please cite the author in any work or product based on this material.
  32.  *
  33.  * ===========================================================================
  34.  *
  35.  * Authors:  Mike DiCuccio
  36.  *
  37.  * File Description:
  38.  *
  39.  */
  41. #include <ncbi_pch.hpp>
  42. #include <gui/core/plugin_exception.hpp>
  43. #include <gui/core/plugin_factory.hpp>
  44. #include <gui/core/plugin_handle.hpp>
  45. #include <gui/core/plugin_registry.hpp>
  47. #include <gui/core/idocument.hpp>
  49. #include <gui/plugin/PluginArgSet.hpp>
  50. #include <gui/plugin/PluginInfo.hpp>
  51. #include <gui/plugin/PluginLibInfo.hpp>
  54. #include <gui/plugin/PluginMessage.hpp>
  56. #include "plugin_handle_impl.hpp"
  59. BEGIN_NCBI_SCOPE
  60. USING_SCOPE(objects);
  64. // comparison operators for plugin handles
  65. bool operator< (const CPluginHandle& h1, const CPluginHandle& h2)
  66. {
  67.     return (h1.LessThan(h2));
  68. }
  71. bool operator== (const CPluginHandle& h1, const CPluginHandle& h2)
  72. {
  73.     return ( !(h1 < h2)  && !(h2 < h1) );
  74. }
  77. bool operator!= (const CPluginHandle& h1, const CPluginHandle& h2)
  78. {
  79.     return !(h1 == h2);
  80. }
  83. CPluginHandle::CPluginHandle()
  84. {
  85. }
  88. CPluginHandle::CPluginHandle(CPluginHandle_Impl& impl)
  89.     : m_Impl(&impl)
  90. {
  91. }
  94. CPluginHandle::CPluginHandle(const CPluginHandle& handle)
  95.     : m_Impl(const_cast<CPluginHandle_Impl*>(handle.m_Impl.GetPointer()))
  96. {
  97. }
  100. CPluginHandle& CPluginHandle::operator=(const CPluginHandle& handle)
  101. {
  102.     if (this != &handle) {
  103.         m_Impl.Reset
  104.             (const_cast<CPluginHandle_Impl*>(handle.m_Impl.GetPointer()));
  105.     }
  106.     return *this;
  107. }
  110. CPluginHandle::~CPluginHandle()
  111. {
  112. }
  115. //
  116. // all requests are forwarded to our implementation
  117. //
  118. const CPluginInfo& CPluginHandle::GetInfo(void) const
  119. {
  120.     if ( !m_Impl ) {
  121.         x_ThrowInvalidHandle();
  122.     }
  123.     return m_Impl->GetInfo();
  124. }
  127. //
  128. // all requests are forwarded to our implementation
  129. //
  130. const CPluginLibInfo& CPluginHandle::GetLibInfo(void) const
  131. {
  132.     if ( !m_Impl ) {
  133.         x_ThrowInvalidHandle();
  134.     }
  135.     return m_Impl->GetLibInfo();
  136. }
  139. CPluginCommandSet::E_Choice CPluginHandle::GetCommand(void) const
  140. {
  141.     if ( !m_Impl ) {
  142.         x_ThrowInvalidHandle();
  143.     }
  144.     return m_Impl->GetCommand();
  145. }
  148. bool CPluginHandle::IsLoaded(void) const
  149. {
  150.     if ( !m_Impl ) {
  151.         x_ThrowInvalidHandle();
  152.     }
  153.     return m_Impl->IsLoaded();
  154. }
  157. bool CPluginHandle::IsEnabled(void) const
  158. {
  159.     if ( !m_Impl ) {
  160.         x_ThrowInvalidHandle();
  161.     }
  162.     return m_Impl->IsEnabled();
  163. }
  166. const string& CPluginHandle::GetClassName(void) const
  167. {
  168.     if ( !m_Impl ) {
  169.         x_ThrowInvalidHandle();
  170.     }
  171.     return m_Impl->GetClassName();
  172. }
  175. const string CPluginHandle::GetHelpFile(void) const
  176. {
  177.     if ( !m_Impl ) {
  178.         x_ThrowInvalidHandle();
  179.     }
  180.     return m_Impl->GetHelpFile();
  181. }
  184. const string& CPluginHandle::GetLibrary(void) const
  185. {
  186.     if ( !m_Impl ) {
  187.         x_ThrowInvalidHandle();
  188.     }
  189.     return m_Impl->GetLibrary();
  190. }
  193. const string& CPluginHandle::GetMenuItem(void) const
  194. {
  195.     if ( !m_Impl ) {
  196.         x_ThrowInvalidHandle();
  197.     }
  198.     return m_Impl->GetMenuItem();
  199. }
  202. const string& CPluginHandle::GetToolTip(void) const
  203. {
  204.     if ( !m_Impl ) {
  205.         x_ThrowInvalidHandle();
  206.     }
  207.     return m_Impl->GetToolTip();
  208. }
  211. int CPluginHandle::GetVerMajor(void) const
  212. {
  213.     if ( !m_Impl ) {
  214.         x_ThrowInvalidHandle();
  215.     }
  216.     return m_Impl->GetVerMajor();
  217. }
  220. int CPluginHandle::GetVerMinor(void) const
  221. {
  222.     if ( !m_Impl ) {
  223.         x_ThrowInvalidHandle();
  224.     }
  225.     return m_Impl->GetVerMinor();
  226. }
  229. int CPluginHandle::GetVerRevision(void) const
  230. {
  231.     if ( !m_Impl ) {
  232.         x_ThrowInvalidHandle();
  233.     }
  234.     return m_Impl->GetVerRevision();
  235. }
  238. const string& CPluginHandle::GetVerBuildDate(void) const
  239. {
  240.     if ( !m_Impl ) {
  241.         x_ThrowInvalidHandle();
  242.     }
  243.     return m_Impl->GetVerBuildDate();
  244. }
  247. //
  248. // determine if a given command subtype is supported
  249. //
  250. bool CPluginHandle::HasCommandSubtype(EAlgoCommand cmd) const
  251. {
  252.     if ( !m_Impl ) {
  253.         x_ThrowInvalidHandle();
  254.     }
  255.     return m_Impl->HasCommandSubtype(cmd);
  256. }
  259. bool CPluginHandle::HasCommandSubtype(EDataCommand cmd) const
  260. {
  261.     if ( !m_Impl ) {
  262.         x_ThrowInvalidHandle();
  263.     }
  264.     return m_Impl->HasCommandSubtype(cmd);
  265. }
  268. bool CPluginHandle::HasCommandSubtype(EViewCommand cmd) const
  269. {
  270.     if ( !m_Impl ) {
  271.         x_ThrowInvalidHandle();
  272.     }
  273.     return m_Impl->HasCommandSubtype(cmd);
  274. }
  277. // return a properly formatted CPluginMessage object to invoke this
  278. // plugin
  279. CRef<CPluginMessage> CPluginHandle::CreateMessage(EAlgoCommand cmd)
  280. {
  281.     if ( !m_Impl ) {
  282.         x_ThrowInvalidHandle();
  283.     }
  284.     return m_Impl->CreateMessage(cmd);
  285. }
  288. CRef<CPluginMessage> CPluginHandle::CreateMessage(EDataCommand cmd)
  289. {
  290.     if ( !m_Impl ) {
  291.         x_ThrowInvalidHandle();
  292.     }
  293.     return m_Impl->CreateMessage(cmd);
  294. }
  297. CRef<CPluginMessage> CPluginHandle::CreateMessage(EViewCommand cmd)
  298. {
  299.     if ( !m_Impl ) {
  300.         x_ThrowInvalidHandle();
  301.     }
  302.     return m_Impl->CreateMessage(cmd);
  303. }
  306. //
  307. // fill in the default set of arguments for a given command
  308. //
  309. bool CPluginHandle::FillDefaults(EAlgoCommand cmd, CPluginCommand& args) const
  310. {
  311.     if ( !m_Impl ) {
  312.         x_ThrowInvalidHandle();
  313.     }
  314.     return m_Impl->FillDefaults(cmd, args);
  315. }
  318. bool CPluginHandle::FillDefaults(EDataCommand cmd, CPluginCommand& args) const
  319. {
  320.     if ( !m_Impl ) {
  321.         x_ThrowInvalidHandle();
  322.     }
  323.     return m_Impl->FillDefaults(cmd, args);
  324. }
  327. bool CPluginHandle::FillDefaults(EViewCommand cmd, CPluginCommand& args) const
  328. {
  329.     if ( !m_Impl ) {
  330.         x_ThrowInvalidHandle();
  331.     }
  332.     return m_Impl->FillDefaults(cmd, args);
  333. }
  336. void CPluginHandle::Execute(CPluginMessage& msg)
  337. {
  338.     if ( !m_Impl ) {
  339.         x_ThrowInvalidHandle();
  340.     }
  341.     m_Impl->Execute(msg);
  342. }
  345. void CPluginHandle::FinalizeArgs(CPluginMessage& msg)
  346. {
  347.     if ( !m_Impl ) {
  348.         x_ThrowInvalidHandle();
  349.     }
  350.     m_Impl->FinalizeArgs(msg);
  351. }
  354. bool CPluginHandle::LessThan(const CPluginHandle& handle) const
  355. {
  356.     if (m_Impl.GetPointer()  &&  handle.m_Impl.GetPointer()) {
  357.         return (*m_Impl < *handle.m_Impl);
  358.     }
  360.     if ( !m_Impl ) {
  361.         return false;
  362.     }
  364.     return true;
  365. }
  368. void CPluginHandle::x_ThrowInvalidHandle() const
  369. {
  370.     NCBI_THROW(CPluginException, eInvalidHandle,
  371.                "Attempt to access invalid plugin handle");
  372. }
  375. END_NCBI_SCOPE
  378. /*
  379.  * ===========================================================================
  380.  * $Log: plugin_handle.cpp,v $
  381.  * Revision 1000.5  2004/06/01 20:44:23  gouriano
  382.  * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.22
  383.  *
  384.  * Revision 1.22  2004/05/25 17:08:50  dicuccio
  385.  * Added CreateMessage() API to generate a new plugin message for a given plugin
  386.  * call
  387.  *
  388.  * Revision 1.21  2004/05/21 22:27:40  gorelenk
  389.  * Added PCH ncbi_pch.hpp
  390.  *
  391.  * Revision 1.20  2004/02/12 23:03:02  mjohnson
  392.  * Added documentation lookup.
  393.  *
  394.  * Revision 1.19  2004/01/15 22:50:17  jcherry
  395.  * Added FinalizeArgs() for plugins
  396.  *
  397.  * Revision 1.18  2003/12/04 18:10:11  dicuccio
  398.  * Refactored expcetion throwing to make it easier to track errors
  399.  *
  400.  * Revision 1.17  2003/11/26 17:06:32  dicuccio
  401.  * Modified to use standard exception throwing function
  402.  *
  403.  * Revision 1.16  2003/11/06 20:06:29  dicuccio
  404.  * Moved USING_SCOPE(objects) to implementation files
  405.  *
  406.  * Revision 1.15  2003/11/04 17:18:41  dicuccio
  407.  * Changed calling API for plugins - take CPluginMessage directly instead of
  408.  * paired command/reply
  409.  *
  410.  * Revision 1.14  2003/10/23 16:16:12  dicuccio
  411.  * Exposed CPluginLibInfo object
  412.  *
  413.  * Revision 1.13  2003/09/04 14:01:51  dicuccio
  414.  * Introduce IDocument and IView as abstract base classes for CDocument and CView
  415.  *
  416.  * Revision 1.12  2003/08/05 17:07:15  dicuccio
  417.  * Changed calling semantics for the message queue - pass by reference, not
  418.  * CConstRef<>
  419.  *
  420.  * Revision 1.11  2003/07/14 11:00:54  shomrat
  421.  * Plugin messageing system related changes
  422.  *
  423.  * Revision 1.10  2003/06/27 14:37:24  shomrat
  424.  * Added comparison operators == and !=
  425.  *
  426.  * Revision 1.9  2003/06/25 19:54:14  dicuccio
  427.  * Fixed compilation error for Windows - ambiguous op&&
  428.  *
  429.  * Revision 1.8  2003/06/25 17:02:54  dicuccio
  430.  * Split CPluginHandle into a handle (pointer-to-implementation) and
  431.  * implementation file.  Lots of #include file clean-ups.
  432.  *
  433.  * Revision 1.7  2003/06/20 14:47:41  dicuccio
  434.  * Revised handling of plugin registration (moved GetInfo() out of plugin
  435.  * factory and into each handler as a static function)
  436.  *
  437.  * Revision 1.6  2003/05/19 13:35:59  dicuccio
  438.  * Moved gui/core/plugin/ -> gui/plugin/.  Merged gui/core/algo, gui/core/doc/,
  439.  * and gui/core/view/ into one library (gui/core/)
  440.  *
  441.  * Revision 1.5  2003/03/10 22:58:51  kuznets
  442.  * iterate -> ITERATE
  443.  *
  444.  * Revision 1.4  2003/02/28 15:06:39  dicuccio
  445.  * Added enabled flag.  Made help file an optional component
  446.  *
  447.  * Revision 1.3  2003/02/26 14:20:13  dicuccio
  448.  * Removed some unnecessary _TRACE() statements
  449.  *
  450.  * Revision 1.2  2003/02/24 13:03:15  dicuccio
  451.  * Renamed classes in plugin spec:
  452.  *     CArgSeg --> CPluginArgSet
  453.  *     CArgument --> CPluginArg
  454.  *     CPluginArgs --> CPluginCommand
  455.  *     CPluginCommands --> CPluginCommandSet
  456.  *
  457.  * Revision 1.1  2003/02/20 19:49:56  dicuccio
  458.  * Created new plugin architecture, based on ASN.1 spec.  Moved GBENCH frameowrk
  459.  * over to use new plugin architecture.
  460.  *
  461.  * ===========================================================================
  462.  */