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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: test_ncbiargs_sample.cpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 19:09:57  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R6.7
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. /*  $Id: test_ncbiargs_sample.cpp,v 1000.1 2004/06/01 19:09:57 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:  Denis Vakatov, Vladimir Ivanov
  35.  *
  36.  * File Description:
  37.  *   Sample for the command-line arguments' processing ("ncbiargs.[ch]pp"):
  38.  *
  39.  */
  40. #include <ncbi_pch.hpp>
  41. #include <corelib/ncbiapp.hpp>
  42. #include <corelib/ncbienv.hpp>
  43. #include <corelib/ncbiargs.hpp>
  44. #include <test/test_assert.h>  /* This header must go last */
  45. USING_NCBI_SCOPE;
  46. /////////////////////////////////////////////////////////////////////////////
  47. //  CArgTestApplication::
  48. class CArgTestApplication : public CNcbiApplication
  49. {
  50. private:
  51.     virtual void Init(void);
  52.     virtual int  Run(void);
  53.     virtual void Exit(void);
  54. };
  55. /////////////////////////////////////////////////////////////////////////////
  56. //  Init test for all different types of arguments
  57. void CArgTestApplication::Init(void)
  58. {
  59.     // Set error posting and tracing on maximum
  60.     SetDiagTrace(eDT_Enable);
  61.     SetDiagPostFlag(eDPF_All);
  62.     SetDiagPostLevel(eDiag_Info);
  63.     // Create command-line argument descriptions class
  64.     auto_ptr<CArgDescriptions> arg_desc(new CArgDescriptions);
  65.     // Specify USAGE context
  66.     arg_desc->SetUsageContext(GetArguments().GetProgramBasename(),
  67.                               "CArgDescriptions demo program");
  68.     // Describe the expected command-line arguments
  69.     arg_desc->AddOptionalPositional
  70.         ("logfile",
  71.          "This is an optional named positional argument without default value",
  72.          CArgDescriptions::eOutputFile,
  73.          CArgDescriptions::fPreOpen | CArgDescriptions::fBinary);
  74.     arg_desc->AddFlag
  75.         ("f1",
  76.          "This is a flag argument: TRUE if set, FALSE if not set");
  77.     arg_desc->AddPositional
  78.         ("barfooetc",
  79.          "This is a mandatory plain (named positional) argument",
  80.          CArgDescriptions::eString);
  81.     arg_desc->SetConstraint
  82.         ("barfooetc", &(*new CArgAllow_Strings, "foo", "bar", "etc"));
  83.     arg_desc->AddDefaultKey
  84.         ("kd", "DefaultKey",
  85.          "This is an optional integer key argument, with default value",
  86.          CArgDescriptions::eInteger, "123");
  87.     arg_desc->SetConstraint
  88.         ("kd", new CArgAllow_Integers(0, 200));
  89.     arg_desc->AddExtra
  90.         (0,  // no mandatory extra args
  91.          3,  // up to 3 optional extra args
  92.          "These are the optional extra (unnamed positional) arguments. "
  93.          "They will be printed out to the file specified by the "
  94.          "2nd positional argument,n"logfile"",
  95.          CArgDescriptions::eBoolean);
  96.     arg_desc->AddKey
  97.         ("k", "MandatoryKey",
  98.          "This is a mandatory alpha-num key argument",
  99.          CArgDescriptions::eString);
  100.     arg_desc->SetConstraint
  101.         ("k", new CArgAllow_String(CArgAllow_Symbols::eAlnum));
  102.     arg_desc->AddOptionalKey
  103.         ("ko", "OptionalKey",
  104.          "This is another optional key argument, without default value",
  105.          CArgDescriptions::eBoolean);
  106.     arg_desc->AddFlag
  107.         ("f2",
  108.          "This is another flag argument: FALSE if set, TRUE if not set",
  109.          false);
  110.     arg_desc->AddDefaultPositional
  111.         ("one_symbol",
  112.          "This is an optional named positional argument with default value",
  113.          CArgDescriptions::eString, "a");
  114.     arg_desc->SetConstraint
  115.         ("one_symbol", new CArgAllow_Symbols(" aBtCd"));
  116.     // Setup arg.descriptions for this application
  117.     SetupArgDescriptions(arg_desc.release());
  118. }
  119. /////////////////////////////////////////////////////////////////////////////
  120. //  Run test (printout arguments obtained from command-line)
  121. int CArgTestApplication::Run(void)
  122. {
  123.     // Get arguments
  124.     CArgs args = GetArgs();
  125.     // Do run
  126.     cout << string(72, '=') << endl;
  127.     // Self test
  128.     assert(args.Exist("f1"));
  129.     assert(args.Exist("logfile"));
  130.     assert(args["barfooetc"]);
  131.     // Stream to result output
  132.     // (NOTE: "x_lg" is just a workaround for bug in SUN WorkShop 5.1 compiler)
  133.     ostream* x_lg = args["logfile"] ? &args["logfile"].AsOutputFile() : &cout;
  134.     ostream& lg = *x_lg;
  135.     if ( args["logfile"] )
  136.         cout << "Printing arguments to file `"
  137.              << args["logfile"].AsString() << "'..." << endl;
  138.     // Printout argument values
  139.     lg << "k:         " << args["k"].AsString() << endl;
  140.     lg << "barfooetc: " << args["barfooetc"].AsString() << endl;
  141.     if ( args["logfile"] )
  142.         lg << "logfile:   " << args["logfile"].AsString() << endl;
  143.     if ( args["ko"] ) {
  144.         lg << "ko:        " << NStr::BoolToString(args["ko"].AsBoolean())
  145.            << endl;
  146.     } else {
  147.         lg << "ko:        not provided" << endl;
  148.         bool is_thrown = false;
  149.         try {
  150.             (void) args["ko"].AsString();
  151.         } catch (CArgException& e) {
  152.             NCBI_REPORT_EXCEPTION("CArgException is thrown:",e);
  153.             is_thrown = true;
  154.         }
  155.         assert(is_thrown);
  156.     }
  157.     if ( args["f1"] ) {
  158.         assert(args["f1"].AsBoolean());
  159.     }
  160.     if ( args["f2"] ) {
  161.         assert(args["f2"].AsBoolean());
  162.     }
  163.     // Extra (unnamed positional) arguments
  164.     if ( args.GetNExtra() ) {
  165.         for (size_t extra = 1;  extra <= args.GetNExtra();  extra++) {
  166.             lg << "#" << extra << ":        "
  167.                << NStr::BoolToString(args[extra].AsBoolean())
  168.                << "   (passed as `" << args[extra].AsString() << "')"
  169.                << endl;
  170.         }
  171.     } else {
  172.         lg << "(no unnamed positional arguments passed in the cmd-line)"
  173.            << endl;
  174.     }
  175.     // Separator
  176.     lg << string(44, '-') << endl;
  177.     // Printout obtained argument values
  178.     string str;
  179.     cout << args.Print(str) << endl;
  180.     return 0;
  181. }
  182. /////////////////////////////////////////////////////////////////////////////
  183. //  Cleanup
  184. void CArgTestApplication::Exit(void)
  185. {
  186.     SetDiagStream(0);
  187. }
  188. /////////////////////////////////////////////////////////////////////////////
  189. //  MAIN
  190. int main(int argc, const char* argv[])
  191. {
  192.     // Execute main application function
  193.     return CArgTestApplication().AppMain(argc, argv, 0, eDS_Default, 0);
  194. }
  195. /*
  196.  * ===========================================================================
  197.  * $Log: test_ncbiargs_sample.cpp,v $
  198.  * Revision 1000.1  2004/06/01 19:09:57  gouriano
  199.  * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R6.7
  200.  *
  201.  * Revision 6.7  2004/05/14 13:59:51  gorelenk
  202.  * Added include of ncbi_pch.hpp
  203.  *
  204.  * Revision 6.6  2002/07/15 18:17:26  gouriano
  205.  * renamed CNcbiException and its descendents
  206.  *
  207.  * Revision 6.5  2002/07/11 14:18:29  gouriano
  208.  * exceptions replaced by CNcbiException-type ones
  209.  *
  210.  * Revision 6.4  2002/04/16 18:49:07  ivanov
  211.  * Centralize threatment of assert() in tests.
  212.  * Added #include <test/test_assert.h>. CVS log moved to end of file.
  213.  *
  214.  * Revision 6.3  2001/06/01 15:36:21  vakatov
  215.  * Fixed for the case when "logfile" is not provided in the cmd.line
  216.  *
  217.  * Revision 6.2  2001/06/01 15:17:57  vakatov
  218.  * Workaround a bug in SUN WorkShop 5.1 compiler
  219.  *
  220.  * Revision 6.1  2001/05/31 16:32:51  ivanov
  221.  * Initialization
  222.  *
  223.  * ===========================================================================
  224.  */