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

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

生物技术

开发平台：

C/C++

ncbiargs_p.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: ncbiargs_p.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2003/10/29 15:08:48  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.5
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. /*  $Id: ncbiargs_p.hpp,v 1000.0 2003/10/29 15:08:48 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:  Denis Vakatov
  36.  *
  37.  * File Description:
  38.  *   PRIVATE header -- for inclusion by "ncbiargs.cpp" only!
  39.  *   Command-line arguments' processing:
  40.  *      descriptions  -- CArgDescriptions,  CArgDesc
  41.  *      constraints   -- CArgAllow;  CArgAllow_{Strings,Integers,Doubles}
  42.  *      parsed values -- CArgs,             CArgValue
  43.  *      exceptions    -- CArgException, ARG_THROW()
  44.  *
  45.  */
  48. #if !defined(NCBIARGS__CPP)
  49. #  error "PRIVATE header -- for inclusion by ncbiargs.cpp only!"
  50. #endif
  53. /////////////////////////////////////////////////////////////////////////////
  54. /////////////////////////////////////////////////////////////////////////////
  55. //  CArg_***::   classes representing various types of argument value
  56. //
  57. //    CArg_NoValue     : CArgValue
  58. //    CArg_String      : CArgValue
  59. //
  60. //    CArg_Alnum       : CArg_String
  61. //    CArg_Integer     : CArg_String
  62. //    CArg_Double      : CArg_String
  63. //    CArg_Boolean     : CArg_String
  64. //    CArg_InputFile   : CArg_String
  65. //    CArg_OutputFile  : CArg_String
  66. //    
  69. class CArg_NoValue : public CArgValue
  70. {
  71. public:
  72.     CArg_NoValue(const string& name);
  73.     virtual bool HasValue(void) const;
  75.     virtual const string&  AsString (void) const;
  76.     virtual int            AsInteger(void) const;
  77.     virtual double         AsDouble (void) const;
  78.     virtual bool           AsBoolean(void) const;
  80.     virtual CNcbiIstream&  AsInputFile (void) const;
  81.     virtual CNcbiOstream&  AsOutputFile(void) const;
  82.     virtual void           CloseFile   (void) const;
  83. };
  87. class CArg_String : public CArgValue
  88. {
  89. public:
  90.     CArg_String(const string& name, const string& value);
  91.     virtual bool HasValue(void) const;
  93.     virtual const string&  AsString (void) const;
  94.     virtual int            AsInteger(void) const;
  95.     virtual double         AsDouble (void) const;
  96.     virtual bool           AsBoolean(void) const;
  98.     virtual CNcbiIstream&  AsInputFile (void) const;
  99.     virtual CNcbiOstream&  AsOutputFile(void) const;
  100.     virtual void           CloseFile   (void) const;
  101. private:
  102.     // Value of the argument as passed to the constructor ("value")
  103.     string m_String;
  104. };
  108. class CArg_Integer : public CArg_String
  109. {
  110. public:
  111.     CArg_Integer(const string& name, const string& value);
  112.     virtual int AsInteger(void) const;
  113. private:
  114.     int m_Integer;
  115. };
  119. class CArg_Double : public CArg_String
  120. {
  121. public:
  122.     CArg_Double(const string& name, const string& value);
  123.     virtual double AsDouble(void) const;
  124. private:
  125.     double m_Double;
  126. };
  130. class CArg_Boolean : public CArg_String
  131. {
  132. public:
  133.     CArg_Boolean(const string& name, bool value);
  134.     CArg_Boolean(const string& name, const string& value);
  135.     virtual bool AsBoolean(void) const;
  136. private:
  137.     bool m_Boolean;
  138. };
  142. class CArg_InputFile : public CArg_String
  143. {
  144. public:
  145.     CArg_InputFile(const string& name, const string& value,
  146.                    IOS_BASE::openmode  openmode,
  147.                    bool                delay_open);
  148.     virtual ~CArg_InputFile(void);
  150.     virtual CNcbiIstream& AsInputFile(void) const;
  151.     virtual void CloseFile(void) const;
  152. private:
  153.     void x_Open(void) const;
  154.     mutable IOS_BASE::openmode m_OpenMode;
  155.     mutable CNcbiIstream*      m_InputFile;
  156.     mutable bool               m_DeleteFlag;
  157. };
  161. class CArg_OutputFile : public CArg_String
  162. {
  163. public:
  164.     CArg_OutputFile(const string& name, const string& value,
  165.                     IOS_BASE::openmode openmode,
  166.                     bool               delay_open);
  167.     virtual ~CArg_OutputFile(void);
  169.     virtual CNcbiOstream& AsOutputFile(void) const;
  170.     virtual void CloseFile(void) const;
  171. private:
  172.     void x_Open(void) const;
  173.     mutable IOS_BASE::openmode m_OpenMode;
  174.     mutable CNcbiOstream*      m_OutputFile;
  175.     mutable bool               m_DeleteFlag;
  176. };
  181. /////////////////////////////////////////////////////////////////////////////
  182. /////////////////////////////////////////////////////////////////////////////
  183. //  CArgDesc***::   abstract base classes for argument descriptions
  184. //
  185. //    CArgDesc
  186. //
  187. //    CArgDescMandatory  : CArgDesc
  188. //    CArgDescOptional   : virtual CArgDescMandatory
  189. //    CArgDescDefault    : virtual CArgDescOptional
  190. //
  191. //    CArgDescSynopsis
  192. //
  196. class CArgDescMandatory : public CArgDesc
  197. {
  198. public:
  199.     CArgDescMandatory(const string& name, const string& comment,
  200.                       CArgDescriptions::EType  type,
  201.                       CArgDescriptions::TFlags flags);
  202.     virtual ~CArgDescMandatory(void);
  204.     CArgDescriptions::EType  GetType (void) const { return m_Type; }
  205.     CArgDescriptions::TFlags GetFlags(void) const { return m_Flags; }
  207.     virtual string GetUsageSynopsis(bool name_only = false) const = 0;
  208.     virtual string GetUsageCommentAttr(void) const;
  210.     virtual CArgValue* ProcessArgument(const string& value) const;
  211.     virtual CArgValue* ProcessDefault(void) const;
  213.     virtual void SetConstraint(CArgAllow* constraint);
  214.     virtual const CArgAllow* GetConstraint(void) const;
  216. private:
  217.     CArgDescriptions::EType  m_Type;
  218.     CArgDescriptions::TFlags m_Flags;
  219.     CConstRef<CArgAllow>     m_Constraint;
  220. };
  224. class CArgDescOptional : virtual public CArgDescMandatory
  225. {
  226. public:
  227.     CArgDescOptional(const string& name, const string& comment,
  228.                      CArgDescriptions::EType  type,
  229.                      CArgDescriptions::TFlags flags);
  230.     virtual ~CArgDescOptional(void);
  231.     virtual CArgValue* ProcessDefault(void) const;
  232. };
  236. class CArgDescDefault : virtual public CArgDescOptional
  237. {
  238. public:
  239.     CArgDescDefault(const string& name, const string& comment,
  240.                     CArgDescriptions::EType  type,
  241.                     CArgDescriptions::TFlags flags,
  242.                     const string&            default_value);
  243.     virtual ~CArgDescDefault(void);
  245.     const string& GetDefaultValue(void) const { return m_DefaultValue; }
  247.     virtual CArgValue* ProcessDefault(void) const;
  248.     virtual void       VerifyDefault (void) const;
  250. private:
  251.     string m_DefaultValue;
  252. };
  256. class CArgDescSynopsis
  257. {
  258. public:
  259.     CArgDescSynopsis(const string& synopsis);
  260.     const string& GetSynopsis(void) const { return m_Synopsis; }
  261. private:
  262.     string m_Synopsis;
  263. };
  268. /////////////////////////////////////////////////////////////////////////////
  269. /////////////////////////////////////////////////////////////////////////////
  270. //  CArgDesc_***::   classes for argument descriptions
  271. //
  272. //    CArgDesc_Flag    : CArgDesc
  273. //
  274. //    CArgDesc_Pos     : virtual CArgDescMandatory
  275. //    CArgDesc_PosOpt  : virtual CArgDescOptional, CArgDesc_Pos
  276. //    CArgDesc_PosDef  :         CArgDescDefault,  CArgDesc_PosOpt
  277. //
  278. //    CArgDescSynopsis
  279. //
  280. //    CArgDesc_Key     : CArgDesc_Pos,    CArgDescSynopsis
  281. //    CArgDesc_KeyOpt  : CArgDesc_PosOpt, CArgDescSynopsis
  282. //    CArgDesc_KeyDef  : CArgDesc_PosDef, CArgDescSynopsis
  283. //
  286. class CArgDesc_Flag : public CArgDesc
  287. {
  288. public:
  289.     CArgDesc_Flag(const string& name, const string& comment,
  290.                   bool set_value = true);
  291.     virtual ~CArgDesc_Flag(void);
  293.     virtual string GetUsageSynopsis(bool name_only = false) const;
  294.     virtual string GetUsageCommentAttr(void) const;
  296.     virtual CArgValue* ProcessArgument(const string& value) const;
  297.     virtual CArgValue* ProcessDefault(void) const;
  299. private:
  300.     bool m_SetValue;  // value to set if the arg is provided  
  301. };
  305. class CArgDesc_Pos : virtual public CArgDescMandatory
  306. {
  307. public:
  308.     CArgDesc_Pos(const string&            name,
  309.                  const string&            comment,
  310.                  CArgDescriptions::EType  type,
  311.                  CArgDescriptions::TFlags flags);
  312.     virtual ~CArgDesc_Pos(void);
  313.     virtual string GetUsageSynopsis(bool name_only = false) const;
  314. };
  318. class CArgDesc_PosOpt : virtual public CArgDescOptional,
  319.                         public CArgDesc_Pos
  320. {
  321. public:
  322.     CArgDesc_PosOpt(const string&            name,
  323.                     const string&            comment,
  324.                     CArgDescriptions::EType  type,
  325.                     CArgDescriptions::TFlags flags);
  326.     virtual ~CArgDesc_PosOpt(void);
  327. };
  331. class CArgDesc_PosDef : public CArgDescDefault,
  332.                         public CArgDesc_PosOpt
  333. {
  334. public:
  335.     CArgDesc_PosDef(const string&            name,
  336.                     const string&            comment,
  337.                     CArgDescriptions::EType  type,
  338.                     CArgDescriptions::TFlags flags,
  339.                     const string&            default_value);
  340.     virtual ~CArgDesc_PosDef(void);
  341. };
  345. class CArgDesc_Key : public CArgDesc_Pos, public CArgDescSynopsis
  346. {
  347. public:
  348.     CArgDesc_Key(const string&            name,
  349.                  const string&            comment,
  350.                  CArgDescriptions::EType  type,
  351.                  CArgDescriptions::TFlags flags,
  352.                  const string&            synopsis);
  353.     virtual ~CArgDesc_Key(void);
  354.     virtual string GetUsageSynopsis(bool name_only = false) const;
  355. };
  359. class CArgDesc_KeyOpt : public CArgDesc_PosOpt, public CArgDescSynopsis
  360. {
  361. public:
  362.     CArgDesc_KeyOpt(const string&            name,
  363.                     const string&            comment,
  364.                     CArgDescriptions::EType  type,
  365.                     CArgDescriptions::TFlags flags,
  366.                     const string&            synopsis);
  367.     virtual ~CArgDesc_KeyOpt(void);
  368.     virtual string GetUsageSynopsis(bool name_only = false) const;
  369. };
  373. class CArgDesc_KeyDef : public CArgDesc_PosDef, public CArgDescSynopsis
  374. {
  375. public:
  376.     CArgDesc_KeyDef(const string&            name,
  377.                     const string&            comment,
  378.                     CArgDescriptions::EType  type,
  379.                     CArgDescriptions::TFlags flags,
  380.                     const string&            synopsis,
  381.                     const string&            default_value);
  382.     virtual ~CArgDesc_KeyDef(void);
  383.     virtual string GetUsageSynopsis(bool name_only = false) const;
  384. };
  387. /*
  388.  * ===========================================================================
  389.  * $Log: ncbiargs_p.hpp,v $
  390.  * Revision 1000.0  2003/10/29 15:08:48  gouriano
  391.  * PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.5
  392.  *
  393.  * Revision 1.5  2002/12/18 22:54:48  dicuccio
  394.  * Shuffled some headers to avoid a potentially serious compiler warning
  395.  * (deletion of incomplete type in Windows).
  396.  *
  397.  * Revision 1.4  2002/07/11 14:18:26  gouriano
  398.  * exceptions replaced by CNcbiException-type ones
  399.  *
  400.  * Revision 1.3  2002/04/11 21:08:01  ivanov
  401.  * CVS log moved to end of the file
  402.  *
  403.  * Revision 1.2  2001/01/22 23:07:15  vakatov
  404.  * CArgValue::AsInteger() to return "int" (rather than "long")
  405.  *
  406.  * Revision 1.1  2000/12/24 00:05:46  vakatov
  407.  * Initial revision
  408.  *
  409.  * ===========================================================================
  410.  */