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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: external.cpp,v $
  4.  * PRODUCTION Revision 1000.5  2004/06/01 20:56:05  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.25
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /*  $Id: external.cpp,v 1000.5 2004/06/01 20:56:05 gouriano Exp $
  10.  * ===========================================================================
  11.  *
  12.  *                            PUBLIC DOMAIN NOTICE
  13.  *               National Center for Biotechnology Information
  14.  *
  15.  *  This software/database is a "United States Government Work" under the
  16.  *  terms of the United States Copyright Act.  It was written as part of
  17.  *  the author's official duties as a United States Government employee and
  18.  *  thus cannot be copyrighted.  This software/database is freely available
  19.  *  to the public for use. The National Library of Medicine and the U.S.
  20.  *  Government have not placed any restriction on its use or reproduction.
  21.  *
  22.  *  Although all reasonable efforts have been taken to ensure the accuracy
  23.  *  and reliability of the software and data, the NLM and the U.S.
  24.  *  Government do not and cannot warrant the performance or results that
  25.  *  may be obtained by using this software or data. The NLM and the U.S.
  26.  *  Government disclaim all warranties, express or implied, including
  27.  *  warranties of performance, merchantability or fitness for any particular
  28.  *  purpose.
  29.  *
  30.  *  Please cite the author in any work or product based on this material.
  31.  *
  32.  * ===========================================================================
  33.  *
  34.  * Authors:  Josh Cherry
  35.  *
  36.  * File Description:
  37.  *
  38.  */
  39. #include <ncbi_pch.hpp>
  40. #include "external.hpp"
  41. #include <gui/utils/exec.hpp>
  42. #include "../basic/output_dlg.hpp"
  43. #include <gui/core/idocument.hpp>
  44. #include <gui/core/plugin_utils.hpp>
  45. #include <gui/plugin/PluginRequest.hpp>
  46. #include <gui/plugin/PluginInfo.hpp>
  47. #include <gui/plugin/PluginCommandSet.hpp>
  48. #include <gui/plugin/PluginValueConstraint.hpp>
  49. #include <gui/core/version.hpp>
  50. #include <objmgr/util/sequence.hpp>
  51. #include <objmgr/scope.hpp>
  52. #include <objmgr/seq_vector.hpp>
  53. #include <objects/seqloc/Seq_loc.hpp>
  54. #include <connect/ncbi_pipe.hpp>
  55. BEGIN_NCBI_SCOPE
  56. USING_SCOPE(objects);
  57. // stuff for running external apps
  58. void CExternal::GetInfo(CPluginInfo& info)
  59. {
  60.     info.Reset();
  61.     // version info macro
  62.     info.SetInfo(CPluginVersion::eMajor, CPluginVersion::eMinor, 0,
  63.                  string(__DATE__) + " " + string(__TIME__),
  64.                  "CExternal", "Run external executable",
  65.                  "A crude interface for running external executables",
  66.                  "");
  67.     // command info
  68.     CPluginCommandSet& cmds = info.SetCommands();
  69.     CPluginCommand&    args = cmds.AddAlgoCommand(eAlgoCommand_run);
  70.     args.AddArgument("locs", "Sequences to evaluate",
  71.                      CSeq_loc::GetTypeInfo(),
  72.                      CPluginArg::TData::e_Array);
  73.     args.SetConstraint("locs",
  74.                        *CPluginValueConstraint::CreateSeqSameMol());
  75.     args.AddArgument("path", "path name to executable",
  76.                      CPluginArg::eString);
  77. }
  78. void CExternal::RunCommand(CPluginMessage& msg)
  79. {
  80.     const CPluginCommand& args = msg.GetRequest().GetCommand();
  81.     CPluginReply& reply = msg.SetReply();
  82.     _TRACE("CExternal::Run()");
  83.     if ( !m_OutputDlg.get() ) {
  84.         m_OutputDlg.reset(new COutputDlg());
  85.     }
  86.     m_OutputDlg->SetTitle("Results of executing external app");
  87.     string str;
  88.     vector<string> seqs;
  89.     /****************************************/
  90.     CPluginArg::TValues seq_list;
  91.     args["path"];
  92.     args["locs"].AsList(seq_list);
  93.     CRef<CScope> new_scope;
  94.     vector<string> seq_labels;
  95.     vector<int>    seq_gis;
  96.     plugin_args::TLocList locs;
  97.     GetArgValue(args["seqs"], locs);
  98.     ITERATE (plugin_args::TLocList, iter, locs) {
  99.         const CSeq_loc&  loc = *iter->second;
  100.         const IDocument& doc = *iter->first;
  101.         CScope& scope = doc.GetScope();
  102.         if ( !new_scope ) {
  103.             new_scope.Reset(&scope);
  104.         }
  105.         if ( !sequence::IsOneBioseq(loc, &scope) ) {
  106.             string str = CPluginUtils::GetLabel(loc, &doc.GetScope());
  107.             LOG_POST(Info << "CExternal: "
  108.                      "location on multiple bioseqs ignored: " << str);
  109.             continue;
  110.         }
  111.         CBioseq_Handle handle =
  112.             scope.GetBioseqHandle(sequence::GetId(loc, &scope));
  113.         CSeqVector vec =
  114.             handle.GetSequenceView(loc,
  115.                                    CBioseq_Handle::eViewConstructed,
  116.                                    CBioseq_Handle::eCoding_Iupac);
  117.         // save our sequence
  118.         seqs.push_back(string());
  119.         vec.GetSeqData(0, vec.size(), seqs.back());
  120.         NStr::ToUpper(seqs.back());
  121.         // save a label for this sequence
  122.         seq_labels.push_back(CPluginUtils::GetLabel(loc, &doc.GetScope()));
  123.         // save the gi for this sequence
  124.         const CSeq_id& gi_id =
  125.             sequence::GetId(handle, sequence::eGetId_ForceGi);
  126.         _TRACE("gi = " << gi_id.GetGi());
  127.         seq_gis.push_back(gi_id.GetGi());
  128.     }
  129.     /***************************************/
  130.     // stdin will contain all sequences, separated by spaces
  131.     string std_in;
  132.     for(size_t i = 0;  i < seqs.size(); i++) {
  133.         std_in += seqs[i];
  134.         if (i != seqs.size() - 1) {
  135.             std_in += ' ';
  136.         } 
  137.     }
  138.     string std_out, std_err;
  139.     vector<string> arguments;
  140.     CExecute::Exec(args["path"].AsString().c_str(), arguments,
  141.                    std_in, std_out, std_err );
  142.     if ( !str.empty() ) {
  143.         str += "n";
  144.     }
  145.     str += "standard output:nn";
  146.     str += std_out + "nn";
  147.     str += "standard error:nn";
  148.     str += std_err + "nn";
  149.     //
  150.     // prepare our dialog box
  151.     //
  152.     if (str.empty()) {
  153.         str = "No output";
  154.     }
  155.     m_OutputDlg->SetText(str);
  156.     m_OutputDlg->Show();
  157.     reply.SetStatus(eMessageStatus_success);
  158. }
  159. END_NCBI_SCOPE
  160. /*
  161.  * ===========================================================================
  162.  * $Log: external.cpp,v $
  163.  * Revision 1000.5  2004/06/01 20:56:05  gouriano
  164.  * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.25
  165.  *
  166.  * Revision 1.25  2004/05/21 22:27:47  gorelenk
  167.  * Added PCH ncbi_pch.hpp
  168.  *
  169.  * Revision 1.24  2004/03/11 17:40:36  dicuccio
  170.  * Use sequence::GetId() instead of CSeq_id::GetStringDescr()
  171.  *
  172.  * Revision 1.23  2004/01/27 18:45:23  dicuccio
  173.  * Added missing header files
  174.  *
  175.  * Revision 1.22  2004/01/07 15:50:39  dicuccio
  176.  * Adjusted for API change in CPluginUtils::GetLabel().  Standardized exception
  177.  * reporting in algorithms.
  178.  *
  179.  * Revision 1.21  2003/11/24 15:45:29  dicuccio
  180.  * Renamed CVersion to CPluginVersion
  181.  *
  182.  * Revision 1.20  2003/11/06 21:17:19  ucko
  183.  * Adjust for scope fixes in public headers.
  184.  *
  185.  * Revision 1.19  2003/11/04 21:17:46  dicuccio
  186.  * Changed calling semantics to match new plugin API
  187.  *
  188.  * Revision 1.18  2003/10/07 15:31:17  ucko
  189.  * Fixed fallout from URL -> Value conversion
  190.  *
  191.  * Revision 1.17  2003/10/07 13:47:04  dicuccio
  192.  * Renamed CPluginURL* to CPluginValue*
  193.  *
  194.  * Revision 1.16  2003/09/25 19:10:30  jcherry
  195.  * Moved exec.?pp to gui/utils
  196.  *
  197.  * Revision 1.15  2003/09/25 17:36:27  jcherry
  198.  * Renamed CExec to CExecute to avoid name conflict.  Made Exec()
  199.  * really return the process's exit status.
  200.  *
  201.  * Revision 1.14  2003/09/04 17:34:04  ucko
  202.  * Really use IDocument instead of CDocument.
  203.  *
  204.  * Revision 1.13  2003/09/04 14:05:24  dicuccio
  205.  * Use IDocument instead of CDocument
  206.  *
  207.  * Revision 1.12  2003/09/03 14:46:53  rsmith
  208.  * change namespace name from args to plugin_args to avoid clashes with variable names.
  209.  *
  210.  * Revision 1.11  2003/09/02 23:12:02  jcherry
  211.  * Partial accommodation of changes to CPipe
  212.  *
  213.  * Revision 1.10  2003/08/21 12:03:08  dicuccio
  214.  * Make use of new typedef in plugin_utils.hpp for argument values.
  215.  *
  216.  * Revision 1.9  2003/07/28 18:17:04  jcherry
  217.  * Moved code for actually executing a program to a separate
  218.  * class (CExec).  Moved 'external' into a new project.
  219.  *
  220.  * Revision 1.8  2003/07/22 15:32:16  dicuccio
  221.  * Changed to make use of new API in plugin_utils.hpp - GetArgValue()
  222.  *
  223.  * Revision 1.7  2003/07/14 11:12:28  shomrat
  224.  * Plugin messageing system related changes
  225.  *
  226.  * Revision 1.6  2003/07/01 15:08:41  jcherry
  227.  * Moved a bunch of stuff into CNucProp and CProtProp
  228.  * Put these in c++/{src,include}/algo/sequence
  229.  *
  230.  * Revision 1.5  2003/06/26 15:33:40  dicuccio
  231.  * Moved GetURLValue() from PluginURL.hpp to plugin_utils.hpp.  Fixed compilation
  232.  * errors relating to missing #includes
  233.  *
  234.  * Revision 1.4  2003/06/25 17:02:57  dicuccio
  235.  * Split CPluginHandle into a handle (pointer-to-implementation) and
  236.  * implementation file.  Lots of #include file clean-ups.
  237.  *
  238.  * Revision 1.3  2003/06/20 14:52:36  dicuccio
  239.  * Revised plugin registration - moved GetInfo() into the plugin handler
  240.  *
  241.  * Revision 1.2  2003/06/19 20:20:25  jcherry
  242.  * Corrected minor error
  243.  *
  244.  * Revision 1.1  2003/06/19 19:12:42  jcherry
  245.  * Initial version of interface for running external executables
  246.  * from gbench.  For now this just passes sequences on stdin.
  247.  *
  248.  * ===========================================================================
  249.  */