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

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

生物技术

开发平台：

C/C++

flat_file_config.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: flat_file_config.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2004/06/01 19:48:19  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.2
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef OBJTOOLS_FORMAT___FLAT_FILE_CONFIG__HPP
  11. #define OBJTOOLS_FORMAT___FLAT_FILE_CONFIG__HPP
  13. /*  $Id: flat_file_config.hpp,v 1000.0 2004/06/01 19:48:19 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:  Mati Shomrat, NCBI
  39.  *
  40.  * File Description:
  41.  *    Configuration class for flat-file generator
  42.  */
  43. #include <corelib/ncbistd.hpp>
  46. BEGIN_NCBI_SCOPE
  47. BEGIN_SCOPE(objects)
  50. // --- Flat File configuration class
  52. class NCBI_FORMAT_EXPORT CFlatFileConfig
  53. {
  54. public:
  55.     
  56.     enum EFormat {
  57.         // formatting styles    
  58.         eFormat_GenBank,
  59.         eFormat_EMBL,
  60.         eFormat_DDBJ,
  61.         eFormat_GBSeq,
  62.         eFormat_FTable,
  63.         eFormat_GFF
  64.     };
  66.     enum EMode {
  67.         // determines the tradeoff between strictness and completeness
  68.         eMode_Release = 0, // strict -- for official public releases
  69.         eMode_Entrez,      // somewhat laxer -- for CGIs
  70.         eMode_GBench,      // even laxer -- for editing submissions
  71.         eMode_Dump         // shows everything, regardless of validity
  72.     };
  75.     enum EStyle {
  76.         // determines handling of segmented records
  77.         eStyle_Normal,  // default -- show segments iff they're near
  78.         eStyle_Segment, // always show segments
  79.         eStyle_Master,  // merge segments into a single virtual record
  80.         eStyle_Contig   // just an index of segments -- no actual sequence
  81.     };
  83.     enum EFlags {
  84.         // customization flags
  85.         fDoHTML               = 0x1,
  86.         fShowContigFeatures   = 0x2, // not just source features
  87.         fShowContigSources    = 0x4, // not just focus
  88.         fShowFarTranslations  = 0x8,
  89.         fTranslateIfNoProduct = 0x10,
  90.         fAlwaysTranslateCDS   = 0x20,
  91.         fOnlyNearFeatures     = 0x40,
  92.         fFavorFarFeatures     = 0x80,  // ignore near feats on segs w/far feats
  93.         fCopyCDSFromCDNA      = 0x100, // for gen-prod sets
  94.         fCopyGeneToCDNA       = 0x200, // for gen-prod sets
  95.         fShowContigInMaster   = 0x400,
  96.         fHideImpFeats         = 0x800,
  97.         fHideRemoteImpFeats   = 0x1000,
  98.         fHideSNPFeatures      = 0x2000,
  99.         fHideExonFeatures     = 0x4000,
  100.         fHideIntronFeatures   = 0x8000,
  101.         fHideMiscFeatures     = 0x10000,
  102.         fHideCDSProdFeatures  = 0x20000,
  103.         fHideCDDFeats         = 0x40000,
  104.         fShowTranscript       = 0x80000,
  105.         fShowPeptides         = 0x100000,
  106.         fHideGeneRIFs         = 0x200000,
  107.         fOnlyGeneRIFs         = 0x400000,
  108.         fLatestGeneRIFs       = 0x800000,
  109.         fShowContigAndSeq     = 0x1000000,
  110.         fHideSourceFeats      = 0x2000000,
  111.         fShowFtableRefs       = 0x4000000,
  112.         fOldFeatsOrder        = 0x8000000
  113.     };
  115.     enum EView {
  116.         // determines which Bioseqs in an entry to view
  117.         fViewNucleotides  = 0x1,
  118.         fViewProteins     = 0x2,
  119.         fViewAll          = (fViewNucleotides | fViewNucleotides)
  120.     };
  122.     // types
  123.     typedef EFormat         TFormat;
  124.     typedef EMode           TMode;
  125.     typedef EStyle          TStyle;
  126.     typedef unsigned int    TFlags; // binary OR of "EFlatFileFlags"
  127.     typedef EView           TView;
  129.     // constructors
  130.     CFlatFileConfig(TFormat format = eFormat_GenBank,
  131.                     TMode   mode = eMode_GBench,
  132.                     TStyle  style = eStyle_Normal,
  133.                     TFlags  flags = 0,
  134.                     TView   view = fViewNucleotides);
  135.     // destructor
  136.     ~CFlatFileConfig(void);
  138.     // -- Format
  139.     // getters
  140.     const TFormat& GetFormat(void) const { return m_Format; }
  141.     bool IsFormatGenbank(void) const { return m_Format == eFormat_GenBank; }
  142.     bool IsFormatEMBL   (void) const { return m_Format == eFormat_EMBL;    }
  143.     bool IsFormatDDBJ   (void) const { return m_Format == eFormat_DDBJ;    }
  144.     bool IsFormatGBSeq  (void) const { return m_Format == eFormat_GBSeq;   }
  145.     bool IsFormatFTable (void) const { return m_Format == eFormat_FTable;  }
  146.     bool IsFormatGFF    (void) const { return m_Format == eFormat_GFF;     }
  147.     // setters
  148.     void SetFormat(const TFormat& format) { m_Format = format; }
  149.     void SetFormatGenbank(void) { m_Format = eFormat_GenBank; }
  150.     void SetFormatEMBL   (void) { m_Format = eFormat_EMBL;    }
  151.     void SetFormatDDBJ   (void) { m_Format = eFormat_DDBJ;    }
  152.     void SetFormatGBSeq  (void) { m_Format = eFormat_GBSeq;   }
  153.     void SetFormatFTable (void) { m_Format = eFormat_FTable;  }
  154.     void SetFormatGFF    (void) { m_Format = eFormat_GFF;     }
  156.     // -- Mode
  157.     // getters
  158.     const TMode& GetMode(void) const { return m_Mode; }
  159.     bool IsModeRelease(void) const { return m_Mode == eMode_Release; }
  160.     bool IsModeEntrez (void) const { return m_Mode == eMode_Entrez;  }
  161.     bool IsModeGBench (void) const { return m_Mode == eMode_GBench;  }
  162.     bool IsModeDump   (void) const { return m_Mode == eMode_Dump;    }
  163.     // setters
  164.     void SetMode(const TMode& mode) { m_Mode = mode; }
  165.     void SetModeRelease(void) { m_Mode = eMode_Release; }
  166.     void SetModeEntrez (void) { m_Mode = eMode_Entrez;  }
  167.     void SetModeGBench (void) { m_Mode = eMode_GBench;  }
  168.     void SetModeDump   (void) { m_Mode = eMode_Dump;    }
  170.     // -- Style
  171.     // getters
  172.     const TStyle& GetStyle(void) const { return m_Style; }
  173.     bool IsStyleNormal (void) const { return m_Style == eStyle_Normal;  }
  174.     bool IsStyleSegment(void) const { return m_Style == eStyle_Segment; }
  175.     bool IsStyleMaster (void) const { return m_Style == eStyle_Master;  }
  176.     bool IsStyleContig (void) const { return m_Style == eStyle_Contig;  }
  177.     // setters
  178.     void SetStyle(const TStyle& style) { m_Style = style;  }
  179.     void SetStyleNormal (void) { m_Style = eStyle_Normal;  }
  180.     void SetStyleSegment(void) { m_Style = eStyle_Segment; }
  181.     void SetStyleMaster (void) { m_Style = eStyle_Master;  }
  182.     void SetStyleContig (void) { m_Style = eStyle_Contig;  }
  184.     // -- View
  185.     // getters
  186.     const TView& GetView(void) const { return m_View; }
  187.     bool IsViewNuc (void) const { return (m_View & fViewNucleotides) != 0; }
  188.     bool IsViewProt(void) const { return (m_View & fViewProteins)    != 0; }
  189.     bool IsViewAll (void) const { return IsViewNuc()  &&  IsViewProt();    }
  190.     // setters
  191.     void SetView(const TView& view) { m_View = view; }
  192.     void SetViewNuc (void) { m_View = fViewNucleotides; }
  193.     void SetViewProt(void) { m_View = fViewProteins;    }
  194.     void SetViewAll (void) { m_View = fViewAll;         } 
  196.     // -- Flags
  197.     // getters
  198.     const TFlags& GetFlags(void) const { return m_Flags; }
  199.     // custumizable flags
  200.     bool DoHTML              (void) const;
  201.     bool HideImpFeats        (void) const;
  202.     bool HideSNPFeatures     (void) const;
  203.     bool HideExonFeatures    (void) const;
  204.     bool HideIntronFeatures  (void) const;
  205.     bool HideRemoteImpFeats  (void) const;
  206.     bool HideGeneRIFs        (void) const;
  207.     bool OnlyGeneRIFs        (void) const;
  208.     bool HideCDSProdFeatures (void) const;
  209.     bool HideCDDFeats        (void) const;
  210.     bool LatestGeneRIFs      (void) const;
  211.     bool ShowContigFeatures  (void) const;
  212.     bool ShowContigSources   (void) const;
  213.     bool ShowContigAndSeq    (void) const;
  214.     bool CopyGeneToCDNA      (void) const;
  215.     bool CopyCDSFromCDNA     (void) const;
  216.     bool HideSourceFeats     (void) const;
  217.     bool AlwaysTranslateCDS  (void) const;
  218.     bool ShowFarTranslations (void) const;
  219.     bool TranslateIfNoProduct(void) const;
  220.     bool ShowTranscript      (void) const;
  221.     bool ShowPeptides        (void) const;
  222.     bool ShowFtableRefs      (void) const;
  223.     bool OldFeatsOrder       (void) const;
  224.     // mode dependant flags
  225.     bool SuppressLocalId     (void) const;
  226.     bool ValidateFeats       (void) const;
  227.     bool IgnorePatPubs       (void) const;
  228.     bool DropShortAA         (void) const;
  229.     bool AvoidLocusColl      (void) const;
  230.     bool IupacaaOnly         (void) const;
  231.     bool DropBadCitGens      (void) const;
  232.     bool NoAffilOnUnpub      (void) const;
  233.     bool DropIllegalQuals    (void) const;
  234.     bool CheckQualSyntax     (void) const;
  235.     bool NeedRequiredQuals   (void) const;
  236.     bool NeedOrganismQual    (void) const;
  237.     bool NeedAtLeastOneRef   (void) const;
  238.     bool CitArtIsoJta        (void) const;
  239.     bool DropBadDbxref       (void) const;
  240.     bool UseEmblMolType      (void) const;
  241.     bool HideBankItComment   (void) const;
  242.     bool CheckCDSProductId   (void) const;
  243.     bool SuppressSegLoc      (void) const;
  244.     bool SrcQualsToNote      (void) const;
  245.     bool HideEmptySource     (void) const;
  246.     bool GoQualsToNote       (void) const;
  247.     bool GeneSynsToNote      (void) const;
  248.     bool SelenocysteineToNote(void) const;
  249.     bool ForGBRelease        (void) const;
  250.     bool HideUnclassPartial  (void) const;
  251.     
  252.     // setters
  253.     void SetFlags(const TFlags& flags) { m_Flags = flags; }
  254.     void SetDoHTML              (bool val);
  255.     void SetHideImpFeats        (bool val);
  256.     void SetHideSNPFeatures     (bool val);
  257.     void SetHideExonFeatures    (bool val);
  258.     void SetHideIntronFeatures  (bool val);
  259.     void SetHideRemoteImpFeats  (bool val);
  260.     void SetHideGeneRIFs        (bool val);
  261.     void SetOnlyGeneRIFs        (bool val);
  262.     void SetHideCDSProdFeatures (bool val);
  263.     void SetHideCDDFeats        (bool val);
  264.     void SetLatestGeneRIFs      (bool val);
  265.     void SetShowContigFeatures  (bool val);
  266.     void SetShowContigSources   (bool val);
  267.     void SetShowContigAndSeq    (bool val);
  268.     void SetCopyGeneToCDNA      (bool val);
  269.     void SetCopyCDSFromCDNA     (bool val);
  270.     void SetHideSourceFeats     (bool val);
  271.     void SetAlwaysTranslateCDS  (bool val);
  272.     void SetShowFarTranslations (bool val);
  273.     void SetTranslateIfNoProduct(bool val);
  274.     void SetShowTranscript      (bool val);
  275.     void SetShowPeptides        (bool val);
  276.     void SetShowFtableRefs      (bool val);
  277.     void SetOldFeatsOrder       (bool val);
  278.     void SetHtml                (bool val);
  280. private:
  281.     
  282.     static const bool sm_ModeFlags[4][26];
  284.     // data
  285.     TFormat     m_Format;
  286.     TMode       m_Mode;
  287.     TStyle      m_Style;
  288.     TView       m_View;
  289.     TFlags      m_Flags;
  290. };
  293. /////////////////////////////////////////////////////////////////////////////
  294. // inilne methods
  296. // custom flags
  297. #define CUSTOM_FLAG_GET(x) inline 
  298. bool CFlatFileConfig::x(void) const 
  299. { 
  300.     return (m_Flags & f##x) != 0; 
  301. }
  303. #define CUSTOM_FLAG_SET(x) inline 
  304. void CFlatFileConfig::Set##x(bool val) 
  305. { 
  306.     if ( val ) { 
  307.         m_Flags |= f##x; 
  308.     } else { 
  309.         m_Flags &= ~f##x; 
  310.     } 
  311. }
  313. #define CUSTOM_FLAG_IMP(x) 
  314. CUSTOM_FLAG_GET(x) 
  315. CUSTOM_FLAG_SET(x)
  317. CUSTOM_FLAG_IMP(DoHTML)
  318. CUSTOM_FLAG_IMP(HideImpFeats)
  319. CUSTOM_FLAG_IMP(HideSNPFeatures)
  320. CUSTOM_FLAG_IMP(HideExonFeatures)
  321. CUSTOM_FLAG_IMP(HideIntronFeatures)
  322. CUSTOM_FLAG_IMP(HideRemoteImpFeats)
  323. CUSTOM_FLAG_IMP(HideGeneRIFs)
  324. CUSTOM_FLAG_IMP(OnlyGeneRIFs)
  325. CUSTOM_FLAG_IMP(HideCDSProdFeatures)
  326. CUSTOM_FLAG_IMP(HideCDDFeats)
  327. CUSTOM_FLAG_IMP(LatestGeneRIFs)
  328. CUSTOM_FLAG_IMP(ShowContigFeatures)
  329. CUSTOM_FLAG_IMP(ShowContigSources)
  330. CUSTOM_FLAG_IMP(ShowContigAndSeq)
  331. CUSTOM_FLAG_IMP(CopyGeneToCDNA)
  332. CUSTOM_FLAG_IMP(CopyCDSFromCDNA)
  333. CUSTOM_FLAG_IMP(HideSourceFeats)
  334. CUSTOM_FLAG_IMP(AlwaysTranslateCDS)
  335. CUSTOM_FLAG_IMP(ShowFarTranslations)
  336. CUSTOM_FLAG_IMP(TranslateIfNoProduct)
  337. CUSTOM_FLAG_IMP(ShowTranscript)
  338. CUSTOM_FLAG_IMP(ShowPeptides)
  339. CUSTOM_FLAG_IMP(ShowFtableRefs)
  340. CUSTOM_FLAG_IMP(OldFeatsOrder)
  342. #undef CUSTOM_FLAG_IMP
  343. #undef CUSTOM_FLAG_GET
  344. #undef CUSTOM_FLAG_SET
  346. // end of inline methods
  347. /////////////////////////////////////////////////////////////////////////////
  349. END_SCOPE(objects)
  350. END_NCBI_SCOPE
  353. /*
  354. * ===========================================================================
  355. *
  356. * $Log: flat_file_config.hpp,v $
  357. * Revision 1000.0  2004/06/01 19:48:19  gouriano
  358. * PRODUCTION: IMPORTED [GCC34_MSVC7] Dev-tree R1.2
  359. *
  360. * Revision 1.2  2004/04/23 14:13:48  gorelenk
  361. * Added missed export prefix to declaration of class CFlatFileConfig.
  362. *
  363. * Revision 1.1  2004/04/22 15:48:36  shomrat
  364. * Initial Revision (adapted from context.hpp)
  365. *
  366. *
  367. * ===========================================================================
  368. */
  371. #endif  /* OBJTOOLS_FORMAT___FLAT_FILE_CONFIG__HPP */