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

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

生物技术

开发平台：

C/C++

plugin_utils.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: plugin_utils.hpp,v $
  4.  * PRODUCTION Revision 1000.4  2004/04/12 18:12:51  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.44
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef GUI_CORE___PLUGIN_UTILS__HPP
  11. #define GUI_CORE___PLUGIN_UTILS__HPP
  13. /*  $Id: plugin_utils.hpp,v 1000.4 2004/04/12 18:12:51 gouriano Exp $
  14.  * ===========================================================================
  15.  *
  16.  *                            PUBLIC DOMAIN NOTICE
  17.  *               National Center for Biotechnology Information
  18.  *
  19.  *  This software/database is a "United States Government Work" under the
  20.  *  terms of the United States Copyright Act.  It was written as part of
  21.  *  the author's official duties as a United States Government employee and
  22.  *  thus cannot be copyrighted.  This software/database is freely available
  23.  *  to the public for use. The National Library of Medicine and the U.S.
  24.  *  Government have not placed any restriction on its use or reproduction.
  25.  *
  26.  *  Although all reasonable efforts have been taken to ensure the accuracy
  27.  *  and reliability of the software and data, the NLM and the U.S.
  28.  *  Government do not and cannot warrant the performance or results that
  29.  *  may be obtained by using this software or data. The NLM and the U.S.
  30.  *  Government disclaim all warranties, express or implied, including
  31.  *  warranties of performance, merchantability or fitness for any particular
  32.  *  purpose.
  33.  *
  34.  *  Please cite the author in any work or product based on this material.
  35.  *
  36.  * ===========================================================================
  37.  *
  38.  * Authors:  Mike DiCuccio
  39.  *
  40.  * File Description:
  41.  *    CPluginUtils -- utilities for managing the interface between the plugin
  42.  *                    architecture and the GBENCH framework
  43.  */
  45. #include <gui/core/selection_buffer.hpp>
  46. #include <gui/core/obj_convert.hpp>
  47. #include <gui/utils/reporter.hpp>
  49. #include <gui/plugin/PluginValue.hpp>
  50. #include <gui/plugin/AlgoCommand.hpp>
  51. #include <gui/plugin/DataCommand.hpp>
  52. #include <gui/plugin/ViewCommand.hpp>
  54. #include <serial/iterator.hpp>
  56. BEGIN_NCBI_SCOPE
  58. BEGIN_SCOPE(objects)
  59.     class CPluginArg;
  60.     class CPluginArgSet;
  61.     class CPluginCommand;
  62.     class CPluginInfo;
  63.     class CPluginMessage;
  64.     class CPluginReply;
  65.     class CPluginRequest;
  66.     class CScope;
  67.     class CSeq_align;
  68.     class CSeq_annot;
  69.     class CSeq_entry;
  70.     class CSeq_feat;
  71.     class CSeq_loc;
  72. END_SCOPE(objects)
  74. class CPluginHandle;
  75. class CPluginRegistry;
  76. class CConvertCache;
  78. //
  79. // class CPluginUtils is a place-holder class for static functions that
  80. // facilitate using the plugin architecture.
  81. //
  82. class NCBI_GUICORE_EXPORT CPluginUtils
  83. {
  84. public:
  85.     // generic argument list typedef
  86.     typedef list< CRef<objects::CPluginArg> > TArgs;
  88.     // typedef for ordered pairs of selectied items.  These are explicitly
  89.     // pairs because we in general need a scoe (document) to travel with the
  90.     // data model object
  91.     typedef pair< CConstRef<CObject>, CConstRef<IDocument> > TSelection;
  94.     // Fit a set of objects into a set of plugin arguments.  This version
  95.     // takes as its input a set of selections from a selection buffer.
  96.     static int FillArgs(objects::CPluginArgSet&    args,
  97.                         const TConstScopedObjects& selections);
  99.     // Fit a set of objects into a set of plugin arguments.  This version
  100.     // takes as its input a set of CPluginValues.  Only the object
  101.     // values will be processed.
  102.     static int FillArgs(objects::CPluginArgSet&           args,
  103.                         const objects::CPluginArg::TData::TArray& objects);
  105.     // Fit a set of objects into a set of plugin arguments.  This version
  106.     // takes as its input a document.
  107.     static int FillArgs(objects::CPluginArgSet& args,
  108.                         const IDocument& doc);
  110.     // this function performs a similar task to FillArgs(); however, instead of
  111.     // actually filling the set of arguments automatically, it returns true if
  112.     // any of the selections indicated *can* fit.  The primary use of this is
  113.     // to determine if a set of plugins could accept some of the selections
  114.     static bool CanFitArgs(const objects::CPluginArgSet& args,
  115.                            const IDocument& doc,
  116.                            CConvertCache* cache = NULL);
  118.     static bool CanFitArgs(const objects::CPluginArgSet& args,
  119.                            const CSelectionBuffer& buf,
  120.                            CConvertCache* cache = NULL);
  122.     static bool CanFitArgs(const objects::CPluginArgSet& args,
  123.                            const TConstScopedObjects& selections,
  124.                            CConvertCache* cache = NULL);
  126.     //
  127.     // plugin dispatching
  128.     //
  130.     enum EDispatchWhen {
  131.         eDispatch_Now,
  132.         eDispatch_Deferred
  133.     };
  135.     // call a plugin by name, passing in a selection buffer.  This version
  136.     // responds to algorithm commands.
  137.     static void CallPlugin(const string& plugin_name,
  138.                            objects::EAlgoCommand cmd,
  139.                            const CSelectionBuffer& selections,
  140.                            IReporter*       reporter = NULL,
  141.                            const string&    ctx_name = "",
  142.                            EDispatchWhen    when = eDispatch_Deferred);
  144.     // call a plugin by name, passing in a selection buffer.  This version
  145.     // responds to view commands.
  146.     static void CallPlugin(const string& plugin_name,
  147.                            objects::EDataCommand cmd,
  148.                            const CSelectionBuffer& selections,
  149.                            IReporter*       reporter = NULL,
  150.                            const string&    ctx_name = "",
  151.                            EDispatchWhen    when = eDispatch_Deferred);
  153.     // call a plugin by name, passing in a selection buffer.  This version
  154.     // responds to data commands.
  155.     static void CallPlugin(const string& plugin_name,
  156.                            objects::EViewCommand cmd,
  157.                            const CSelectionBuffer& selections,
  158.                            IReporter*       reporter = NULL,
  159.                            const string&    ctx_name = "",
  160.                            EDispatchWhen    when = eDispatch_Deferred);
  162.     // call a plugin by name, passing in a document.  This version
  163.     // responds to algorithm commands.
  164.     static void CallPlugin(const string& plugin_name,
  165.                            objects::EAlgoCommand cmd,
  166.                            const IDocument* doc = NULL,
  167.                            IReporter*       reporter = NULL,
  168.                            const string&    ctx_name = "",
  169.                            EDispatchWhen    when = eDispatch_Deferred);
  171.     // call a plugin by name, passing in a document.  This version
  172.     // responds to view commands.
  173.     static void CallPlugin(const string& plugin_name,
  174.                            objects::EDataCommand cmd,
  175.                            const IDocument* doc = NULL,
  176.                            IReporter*       reporter = NULL,
  177.                            const string&    ctx_name = "",
  178.                            EDispatchWhen    when = eDispatch_Deferred);
  180.     // call a plugin by name, passing in a document.  This version
  181.     // responds to data commands.
  182.     static void CallPlugin(const string& plugin_name,
  183.                            objects::EViewCommand cmd,
  184.                            const IDocument* doc = NULL,
  185.                            IReporter*       reporter = NULL,
  186.                            const string&    ctx_name = "",
  187.                            EDispatchWhen    when = eDispatch_Deferred);
  189.     // command through which all the CallPlugin(...) commands filter
  190.     static void CallPlugin(objects::CPluginMessage& msg,
  191.                            const TConstScopedObjects& selections,
  192.                            EDispatchWhen when = eDispatch_Deferred);
  194.     // call a plugin by name, passing in a fully qualified message object.
  195.     // This is the final recipient of all CallPlugin() commands, and will
  196.     // process the request non-interactively
  197.     static void CallPlugin(objects::CPluginMessage& msg,
  198.                            EDispatchWhen when = eDispatch_Deferred);
  200.     //
  201.     // argument validation functions
  202.     //
  204.     // validate an entire set of arguments
  205.     static bool IsValid(const objects::CPluginArgSet& args);
  207.     // validate a given argument.  This insures that the argument contains
  208.     // a valid value, and that this value meets the argument's constraints.
  209.     static bool IsValid(const objects::CPluginArg& arg);
  211.     // validate a single plugin value
  212.     static bool IsValid(const objects::CPluginValue& value);
  214.     // check the constraints on a given argument
  215.     static bool CheckConstraints(const objects::CPluginArg& arg,
  216.                                  CConvertCache* cache = NULL);
  218.     // individual constraint checking function.  This is used by
  219.     // CheckConstraints() as well as by CanFitArgs(), and its API
  220.     // is a bit odd as a result.
  221.     static bool CheckConstraints(const objects::CPluginArg& arg,
  222.                                  objects::CScope& scope, const CObject& obj,
  223.                                  CConvertCache* cache = NULL);
  225.     //
  226.     // object conversion functions
  227.     //
  229.     // convert an argument to a named container of items
  230.     static vector<string> ArgToStringVec(const objects::CPluginArg& arg);
  232.     // retrieve the plugin info object for a named plugin.
  233.     // this will throw if the plugin isn't found.
  234.     static const objects::CPluginInfo& GetInfo(const string& plugin_name);
  236.     // return a string describing an arbitrary object.  This is a single
  237.     // entry-point function that will determine the best possible label to use.
  238.     static string GetLabel(const CObject& obj, objects::CScope* scope);
  240. private:
  242.     static objects::CPluginCommand*
  243.     x_GetCommand(objects::CPluginRequest& request);
  245. };
  248. //
  249. // typedefs to make standard plugin args easier to deal with
  250. //
  251. BEGIN_SCOPE(plugin_args)
  253.     typedef list< pair< CConstRef<IDocument>,
  254.                         CConstRef<objects::CSeq_id> > >      TIdList;
  255.     typedef list< pair< CConstRef<IDocument>,
  256.                         CConstRef<objects::CSeq_feat> > >    TFeatList;
  257.     typedef list< pair< CConstRef<IDocument>,
  258.                         CConstRef<objects::CSeq_loc> > >     TLocList;
  259.     typedef list< pair< CConstRef<IDocument>,
  260.                         CConstRef<objects::CSeq_entry> > >   TEntryList;
  261.     typedef list< pair< CConstRef<IDocument>,
  262.                         CConstRef<objects::CSeq_align> > >   TAlignList;
  263.     typedef list< pair< CConstRef<IDocument>,
  264.                         CConstRef<objects::CSeq_annot> > >   TAnnotList;
  265.     typedef list< pair< CConstRef<IDocument>,
  266.                         CConstRef<objects::CBioseq> > >      TBioseqList;
  268. END_SCOPE(plugin_args)
  273. //
  274. // GetArgValue() offers simple, one-step conversion to a given argument type.
  275. // The default template assumes that the converted type derives from
  276. // CSerialObject.
  277. //
  278. template <class T>
  279. inline
  280. void GetArgValue(const objects::CPluginArg& arg,
  281.                  list< pair< CConstRef<IDocument>,
  282.                              CConstRef<T> > >& objs)
  283. {
  284.     CTypeConstIterator<objects::CPluginValue> iter(arg);
  285.     for ( ;  iter;  ++iter) {
  286.         CConstRef<IDocument> doc(iter->GetDocument());
  287.         CConstRef<CObject>   obj(iter->GetObject());
  288.         if ( !doc  ||  !obj ) {
  289.             continue;
  290.         }
  292.         CObjectConverter::TObjList obj_list;
  293.         CObjectConverter::Convert(doc->GetScope(), *obj, T::GetTypeInfo(),
  294.                                   obj_list);
  295.         ITERATE (CObjectConverter::TObjList, obj_iter, obj_list) {
  296.             CConstRef<T> ref(dynamic_cast<const T*>
  297.                              (obj_iter->GetPointer()));
  298.             if (ref) {
  299.                 objs.push_back(make_pair(doc, ref));
  300.             }
  301.         }
  302.     }
  303. }
  306. //
  307. // Specialization of GetArgValue for document types
  308. //
  309. template <>
  310. inline
  311. void GetArgValue(const objects::CPluginArg& arg,
  312.                  list< pair< CConstRef<IDocument>,
  313.                              CConstRef<IDocument> > >& objs)
  314. {
  315.     CTypeConstIterator<objects::CPluginValue> iter(arg);
  316.     for ( ;  iter;  ++iter) {
  317.         CConstRef<IDocument> doc(iter->GetDocument());
  318.         CConstRef<CObject>   obj(iter->GetObject());
  319.         if ( !doc  ||  !obj ) {
  320.             continue;
  321.         }
  323.         CObjectConverter::TObjList obj_list;
  324.         CObjectConverter::Convert(doc->GetScope(), *obj, "IDocument", obj_list);
  325.         ITERATE (CObjectConverter::TObjList, obj_iter, obj_list) {
  326.             CConstRef<IDocument> ref(dynamic_cast<const IDocument*>
  327.                                      (obj_iter->GetPointer()));
  328.             if (ref) {
  329.                 objs.push_back(make_pair(doc, ref));
  330.             }
  331.         }
  332.     }
  333. }
  336. //
  337. // Specialization of GetArgValue for generic CObject types
  338. //
  339. template <>
  340. inline
  341. void GetArgValue(const objects::CPluginArg& arg,
  342.                  list< pair< CConstRef<IDocument>,
  343.                              CConstRef<CObject> > >& objs)
  344. {
  345.     CTypeConstIterator<objects::CPluginValue> iter(arg);
  346.     for ( ;  iter;  ++iter) {
  347.         CConstRef<IDocument> doc(iter->GetDocument());
  348.         CConstRef<CObject>   obj(iter->GetObject());
  349.         if ( !doc  ||  !obj ) {
  350.             continue;
  351.         }
  353.         objs.push_back(make_pair(doc, obj));
  354.     }
  355. }
  359. END_NCBI_SCOPE
  362. /*
  363.  * ===========================================================================
  364.  * $Log: plugin_utils.hpp,v $
  365.  * Revision 1000.4  2004/04/12 18:12:51  gouriano
  366.  * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.44
  367.  *
  368.  * Revision 1.44  2004/04/07 12:36:02  dicuccio
  369.  * Dropped CSelectionBuffer::TSelList in favor of TConstScopedObjects.  Altered
  370.  * CallPlugin API - added default IReporter*.  Removed unneeded #includes
  371.  *
  372.  * Revision 1.43  2004/01/27 18:27:59  dicuccio
  373.  * Code clean-up.  Removed unneeded headers.  Added new typedefs for alignment,
  374.  * annotation lists
  375.  *
  376.  * Revision 1.42  2004/01/21 12:38:17  dicuccio
  377.  * redesigned CObjectCOnverter API to eliminate temporary object creation
  378.  *
  379.  * Revision 1.41  2004/01/07 15:46:16  dicuccio
  380.  * Renamed GetObjectLabel() to GetLabel().  Changed calling semantics to more
  381.  * closely follow other label extraction functions
  382.  *
  383.  * Revision 1.40  2003/12/22 19:13:00  dicuccio
  384.  * Don't include the message queue - not needed
  385.  *
  386.  * Revision 1.39  2003/11/18 17:36:47  dicuccio
  387.  * Cleaned up some comments.  Added new FitArgs() API to take a set of
  388.  * CPluginValues
  389.  *
  390.  * Revision 1.38  2003/11/06 19:57:57  dicuccio
  391.  * Removed USING_SCOPE(objects).  Changed API for CallPlugin() - added optiona
  392.  * context parameter
  393.  *
  394.  * Revision 1.37  2003/11/04 17:13:14  dicuccio
  395.  * Added new default parameter to force calling of plugins immediately or use
  396.  * dispatch mechanism.  Removed templates from header - moved to private
  397.  * implementation
  398.  *
  399.  * Revision 1.36  2003/10/15 18:30:58  dicuccio
  400.  * Added optional conversion cache argument to CheckConstraints()
  401.  *
  402.  * Revision 1.35  2003/10/10 17:12:25  dicuccio
  403.  * Added optional arg to CanFitArgs() for object conversion cache
  404.  *
  405.  * Revision 1.34  2003/10/07 13:33:01  dicuccio
  406.  * Changed CPluginURL* to CPluginValue*.  Code clean-up; moved validation code out
  407.  * of xgbplugin and into plugin_utils.cpp
  408.  *
  409.  * Revision 1.33  2003/09/16 14:04:06  dicuccio
  410.  * Made private constraint checking function public
  411.  *
  412.  * Revision 1.32  2003/09/04 14:00:26  dicuccio
  413.  * Introduce IDocument and IView as abstract base classes.  Use IDocument instead
  414.  * of CDocument.
  415.  *
  416.  * Revision 1.31  2003/09/03 14:49:02  rsmith
  417.  * change namespace name from args to plugin_args to avoid clashes with variable names.
  418.  *
  419.  * Revision 1.30  2003/08/22 17:28:35  dicuccio
  420.  * Moved prototypes for conversion routines to .cpp file
  421.  *
  422.  * Revision 1.29  2003/08/21 12:14:01  dicuccio
  423.  * Added new typedefs for standard argument objects containers
  424.  *
  425.  * Revision 1.28  2003/08/19 18:51:44  friedman
  426.  * Added the follwing conversion functionclality to Convert:
  427.  *     doc -> seq-annot, bioseq -> seq-annot, seq-id -> seq-annot,
  428.  *     seq-loc -> seq-annot, seq-entry -> seq-annot, doc -> seq-align
  429.  *
  430.  * Revision 1.27  2003/08/05 16:58:39  dicuccio
  431.  * Changed calling conventions for plugin message queue - pass by reference, not
  432.  * CConstRef<>
  433.  *
  434.  * Revision 1.26  2003/07/31 16:42:29  dicuccio
  435.  * Changed calling semantics of CallPlugin() to permit calling a plugin with no
  436.  * selections
  437.  *
  438.  * Revision 1.25  2003/07/25 13:41:08  dicuccio
  439.  * Removed duplicated comment
  440.  *
  441.  * Revision 1.24  2003/07/24 13:11:00  dicuccio
  442.  * Added basic bioseq conversions
  443.  *
  444.  * Revision 1.23  2003/07/23 17:52:23  dicuccio
  445.  * Moved logic for validating arguments into CPluginUtils.
  446.  *
  447.  * Revision 1.22  2003/07/22 15:27:10  dicuccio
  448.  * Changed Convert() to perform one-to-many conversions.  Moved GetObjectLabel()
  449.  * from a static internal function of plugin_arg_dialog.cpp to a member of
  450.  * CPluginUtils
  451.  *
  452.  * Revision 1.21  2003/07/21 19:19:40  dicuccio
  453.  * Added an interface to check if a selection buffer can fit into a set of args
  454.  *
  455.  * Revision 1.20  2003/07/14 10:57:52  shomrat
  456.  * Plugin messageing system related changes
  457.  *
  458.  * Revision 1.19  2003/06/30 13:43:37  dicuccio
  459.  * Added API to call a plugin directly with a CPluginRequest object
  460.  *
  461.  * Revision 1.18  2003/06/26 15:32:01  dicuccio
  462.  * Moved GetURLValue() from PluginURL.hpp to plugin_utils.hpp - relieves one
  463.  * circular dependency betweein gui/gqplugin and gui/core/
  464.  *
  465.  * Revision 1.17  2003/06/25 16:59:41  dicuccio
  466.  * Changed CPluginHandle into a pointer-to-implementation (the previous
  467.  * implementation is now the pointer held).  Lots of #include file clean-ups.
  468.  *
  469.  * Revision 1.16  2003/06/20 14:44:36  dicuccio
  470.  * Revamped handling of plugin registration.  All plugin factories now derive
  471.  * from CPluginFactoryBase; CPluginFactory is a template.  There is a new
  472.  * requirement for derived plugin handlers of all types (each must implement a
  473.  * static function of the form 'static void GetInfo(CPluginInfo&)')
  474.  *
  475.  * Revision 1.15  2003/06/02 16:01:29  dicuccio
  476.  * Rearranged include/objects/ subtree.  This includes the following shifts:
  477.  *     - include/objects/alnmgr --> include/objtools/alnmgr
  478.  *     - include/objects/cddalignview --> include/objtools/cddalignview
  479.  *     - include/objects/flat --> include/objtools/flat
  480.  *     - include/objects/objmgr/ --> include/objmgr/
  481.  *     - include/objects/util/ --> include/objmgr/util/
  482.  *     - include/objects/validator --> include/objtools/validator
  483.  *
  484.  * Revision 1.14  2003/05/19 13:32:43  dicuccio
  485.  * Moved gui/core/plugin --> gui/plugin/
  486.  *
  487.  * Revision 1.13  2003/05/06 15:51:07  dicuccio
  488.  * Dropped identity object conversions in favor of a generic approach
  489.  *
  490.  * Revision 1.12  2003/05/05 12:39:59  dicuccio
  491.  * Added new interface function 9CanFitArgs()) for testing whether a group of
  492.  * selections or objects could possibly apply to a set of arguments
  493.  *
  494.  * Revision 1.11  2003/05/01 12:53:06  dicuccio
  495.  * Added conversion routines for {doc,seq-id,seq-loc,seq-feat} -> seq-entry
  496.  *
  497.  * Revision 1.10  2003/04/29 14:30:37  dicuccio
  498.  * Made main object conversion function public.  Changed SelectionsToArgs() ->
  499.  * FillArgs() and added a second interface that wraps filling arguments with
  500.  * just a document
  501.  *
  502.  * Revision 1.9  2003/04/24 16:13:13  dicuccio
  503.  * Large revision.  Added many new interface functions to handle object
  504.  * cats/conversion; simplified filling out of plugin arguments
  505.  *
  506.  * Revision 1.8  2003/04/16 20:11:29  dicuccio
  507.  * Added missing #include for CPluginException
  508.  *
  509.  * Revision 1.7  2003/04/16 18:16:17  dicuccio
  510.  * Added CallPlugin() methods to explicitly call plugins by name or plugin
  511.  * handle
  512.  *
  513.  * Revision 1.6  2003/03/25 14:20:47  dicuccio
  514.  * Changed export specifier from XGBPLUGIN to GUICORE
  515.  *
  516.  * Revision 1.5  2003/03/25 13:05:45  dicuccio
  517.  * Changed SelBufferToArgs() to return the number of unset arguments - used to
  518.  * determine if automated argument processing can continue.
  519.  *
  520.  * Revision 1.4  2003/02/26 14:33:21  dicuccio
  521.  * Major rewrite.  Most common cases of selection buffer-to-arguments should now
  522.  * work automatically, but there is still no manual fall-back.
  523.  *
  524.  * Revision 1.3  2003/02/24 13:00:17  dicuccio
  525.  * Renamed classes in plugin spec:
  526.  *     CArgSeg --> CPluginArgSet
  527.  *     CArgument --> CPluginArg
  528.  *     CPluginArgs --> CPluginCommand
  529.  *     CPluginCommands --> CPluginCommandSet
  530.  *
  531.  * Revision 1.2  2003/02/21 16:44:13  dicuccio
  532.  * Added Win32 export specifiers for new plugin library.  Fixed compilation
  533.  * issues for Win32.
  534.  *
  535.  * Revision 1.1  2003/02/20 19:44:06  dicuccio
  536.  * Created new plugin architecture, mediated via an ASN.1 spec.  Moved GBENCH
  537.  * framework over to use new plugin architecture.
  538.  *
  539.  * ===========================================================================
  540.  */
  542. #endif  // GUI_CORE___PLUGIN_UTILS__HPP