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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: comments.hpp,v $
  4.  * PRODUCTION Revision 1000.0  2003/10/29 17:34:53  gouriano
  5.  * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.2
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef COMMENTS__HPP
  10. #define COMMENTS__HPP
  11. /*  $Id: comments.hpp,v 1000.0 2003/10/29 17:34:53 gouriano Exp $
  12. * ===========================================================================
  13. *
  14. *                            PUBLIC DOMAIN NOTICE
  15. *               National Center for Biotechnology Information
  16. *
  17. *  This software/database is a "United States Government Work" under the
  18. *  terms of the United States Copyright Act.  It was written as part of
  19. *  the author's official duties as a United States Government employee and
  20. *  thus cannot be copyrighted.  This software/database is freely available
  21. *  to the public for use. The National Library of Medicine and the U.S.
  22. *  Government have not placed any restriction on its use or reproduction.
  23. *
  24. *  Although all reasonable efforts have been taken to ensure the accuracy
  25. *  and reliability of the software and data, the NLM and the U.S.
  26. *  Government do not and cannot warrant the performance or results that
  27. *  may be obtained by using this software or data. The NLM and the U.S.
  28. *  Government disclaim all warranties, express or implied, including
  29. *  warranties of performance, merchantability or fitness for any particular
  30. *  purpose.
  31. *
  32. *  Please cite the author in any work or product based on this material.
  33. *
  34. * ===========================================================================
  35. *
  36. * Author: Eugene Vasilchenko
  37. *
  38. * File Description:
  39. *   !!! PUT YOUR DESCRIPTION HERE !!!
  40. *
  41. * ---------------------------------------------------------------------------
  42. * $Log: comments.hpp,v $
  43. * Revision 1000.0  2003/10/29 17:34:53  gouriano
  44. * PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.2
  45. *
  46. * Revision 1.2  2001/05/17 15:00:42  lavr
  47. * Typos corrected
  48. *
  49. * Revision 1.1  2000/11/29 17:42:29  vasilche
  50. * Added CComment class for storing/printing ASN.1/XML module comments.
  51. * Added srcutil.hpp file to reduce file dependency.
  52. *
  53. * ===========================================================================
  54. */
  55. #include <corelib/ncbistd.hpp>
  56. #include <list>
  57. BEGIN_NCBI_SCOPE
  58. class CComments
  59. {
  60. public:
  61.     CComments(void);
  62.     ~CComments(void);
  63.     void Add(const string& s);
  64.     enum {
  65.         eAlwaysMultiline = 1,
  66.         eDoNotWriteBlankLine = 2,
  67.         eNoEOL = 4,
  68.         eOneLine = eDoNotWriteBlankLine | eNoEOL,
  69.         eMultiline = eDoNotWriteBlankLine | eAlwaysMultiline
  70.     };
  71.     bool Empty(void) const;
  72.     bool OneLine(void) const;
  73.     
  74.     CNcbiOstream& Print(CNcbiOstream& out, const string& before,
  75.                         const string& between, const string& after) const;
  76.     CNcbiOstream& PrintDTD(CNcbiOstream& out, int flags = 0) const;
  77.     CNcbiOstream& PrintASN(CNcbiOstream& out, int indent, int flags = 0) const;
  78. private:
  79.     typedef list<string> TComments;
  80.     TComments m_Comments;
  81. };
  82. template<class Container>
  83. inline
  84. bool SizeIsOne(const Container& cont)
  85. {
  86.     typename Container::const_iterator it = cont.begin(), end = cont.end();
  87.     return it != end && ++it == end;
  88. }
  89. inline
  90. bool CComments::Empty(void) const
  91. {
  92.     return m_Comments.empty();
  93. }
  94. inline
  95. bool CComments::OneLine(void) const
  96. {
  97.     return SizeIsOne(m_Comments);
  98. }
  99. //#include <serial/datatool/comments.inl>
  100. END_NCBI_SCOPE
  101. #endif  /* COMMENTS__HPP */