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

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

生物技术

开发平台：

C/C++

serialbase.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: serialbase.hpp,v $
  4.  * PRODUCTION Revision 1000.3  2004/06/01 19:39:07  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.32
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef SERIALBASE__HPP
  11. #define SERIALBASE__HPP
  13. /*  $Id: serialbase.hpp,v 1000.3 2004/06/01 19:39:07 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. * Author: Eugene Vasilchenko
  39. *
  40. * File Description:
  41. *   File to be included in all headers generated by datatool
  42. */
  44. #include <corelib/ncbistd.hpp>
  45. #include <corelib/ncbiobj.hpp>
  46. #include <serial/exception.hpp>
  47. #include <serial/serialdef.hpp>
  48. #include <typeinfo>
  51. /** @addtogroup GenClassSupport
  52.  *
  53.  * @{
  54.  */
  57. BEGIN_NCBI_SCOPE
  59. class CTypeInfo;
  60. class CClassTypeInfo;
  61. class CChoiceTypeInfo;
  62. class CEnumeratedTypeValues;
  64. // enum for choice classes generated by datatool
  65. enum EResetVariant {
  66.     eDoResetVariant,
  67.     eDoNotResetVariant
  68. };
  70. typedef void (*TPostReadFunction)(const CTypeInfo* info, void* object);
  71. typedef void (*TPreWriteFunction)(const CTypeInfo* info, const void* object);
  73. NCBI_XSERIAL_EXPORT
  74. void SetPostRead(CClassTypeInfo*  info, TPostReadFunction function);
  76. NCBI_XSERIAL_EXPORT
  77. void SetPostRead(CChoiceTypeInfo* info, TPostReadFunction function);
  79. NCBI_XSERIAL_EXPORT
  80. void SetPreWrite(CClassTypeInfo*  info, TPreWriteFunction function);
  82. NCBI_XSERIAL_EXPORT
  83. void SetPreWrite(CChoiceTypeInfo* info, TPreWriteFunction function);
  85. template<class Class>
  86. class CClassPostReadPreWrite
  87. {
  88. public:
  89.     static void PostRead(const CTypeInfo* /*info*/, void* object)
  90.         {
  91.             static_cast<Class*>(object)->PostRead();
  92.         }
  93.     static void PreWrite(const CTypeInfo* /*info*/, const void* object)
  94.         {
  95.             static_cast<const Class*>(object)->PreWrite();
  96.         }
  97. };
  99. // Base class for all serializable objects
  100. class NCBI_XSERIAL_EXPORT CSerialObject : public CObject
  101. {
  102. public:
  103.     CSerialObject(void);
  104.     virtual ~CSerialObject(void);
  105.     virtual const CTypeInfo* GetThisTypeInfo(void) const = 0;
  106.     virtual void Assign(const CSerialObject& source,
  107.                         ESerialRecursionMode how = eRecursive);
  108.     virtual bool Equals(const CSerialObject& object,
  109.                         ESerialRecursionMode how = eRecursive) const;
  110.     virtual void DebugDump(CDebugDumpContext ddc, unsigned int depth) const;
  112.     void ThrowUnassigned(TMemberIndex index) const;
  113.     // for all GetX() methods called in the current thread
  114.     static  void SetVerifyDataThread(ESerialVerifyData verify);
  115.     // for all GetX() methods called in the current process
  116.     static  void SetVerifyDataGlobal(ESerialVerifyData verify);
  118.     static const char* ms_UnassignedStr;
  119.     static const char  ms_UnassignedByte;
  121.     bool HasNamespaceName(void) const;
  122.     const string& GetNamespaceName(void) const;
  123.     void SetNamespaceName(const string& ns_name);
  125.     bool HasNamespacePrefix(void) const;
  126.     const string& GetNamespacePrefix(void) const;
  127.     void SetNamespacePrefix(const string& ns_prefix);
  129. private:
  130.     static ESerialVerifyData x_GetVerifyData(void);
  131.     static ESerialVerifyData ms_VerifyDataDefault;
  132. };
  134. class NCBI_XSERIAL_EXPORT CSerialAttribInfoItem
  135. {
  136. public:
  137.     CSerialAttribInfoItem(const string& name,
  138.                           const string& ns_name, const string& value);
  139.     CSerialAttribInfoItem(const CSerialAttribInfoItem& other);
  140.     virtual ~CSerialAttribInfoItem(void);
  142.     const string& GetName(void) const;
  143.     const string& GetNamespaceName(void) const;
  144.     const string& GetValue(void) const;
  145. private:
  146.     string m_Name;
  147.     string m_NsName;
  148.     string m_Value;
  149. };
  151. class NCBI_XSERIAL_EXPORT CAnyContentObject : public CSerialObject
  152. {
  153. public:
  154.     CAnyContentObject(void);
  155.     CAnyContentObject(const CAnyContentObject& other);
  156.     virtual ~CAnyContentObject(void);
  158.     virtual const CTypeInfo* GetThisTypeInfo(void) const
  159.     { return GetTypeInfo(); }
  160.     static const CTypeInfo* GetTypeInfo(void);
  162.     void Reset(void);
  163.     CAnyContentObject& operator= (const CAnyContentObject& other);
  164.     bool operator== (const CAnyContentObject& other) const;
  166.     void SetName(const string& name);
  167.     const string& GetName(void) const;
  168.     void SetValue(const string& value);
  169.     const string& GetValue(void) const;
  171.     void SetNamespaceName(const string& ns_name);
  172.     const string& GetNamespaceName(void) const;
  173.     void SetNamespacePrefix(const string& ns_prefix);
  174.     const string& GetNamespacePrefix(void) const;
  176.     void AddAttribute(const string& name,
  177.                       const string& ns_name, const string& value);
  178.     const vector<CSerialAttribInfoItem>& GetAttributes(void) const;
  180. private:
  181.     void x_Copy(const CAnyContentObject& other);
  182.     void x_Decode(const string& value);
  183.     string m_Name;
  184.     string m_Value;
  185.     string m_NsName;
  186.     string m_NsPrefix;
  187.     vector<CSerialAttribInfoItem> m_Attlist;
  188. };
  190. // Base class for user-defined serializable classes
  191. // to allow for objects assignment and comparison.
  192. // EXAMPLE:
  193. //   class CSeq_entry : public CSeq_entry_Base, CSerialUserOp
  194. //
  195. class NCBI_XSERIAL_EXPORT CSerialUserOp
  196. {
  197.     friend class CClassTypeInfo;
  198.     friend class CChoiceTypeInfo;
  199. protected:
  200.     // will be called after copying the datatool-generated members
  201.     virtual void UserOp_Assign(const CSerialUserOp& source) = 0;
  202.     // will be called after comparing the datatool-generated members
  203.     virtual bool UserOp_Equals(const CSerialUserOp& object) const = 0;
  204. };
  207. /////////////////////////////////////////////////////////////////////
  208. //
  209. // Alias wrapper templates
  210. //
  212. template <class TPrim>
  213. class CAliasBase
  214. {
  215. public:
  216.     typedef CAliasBase<TPrim> TThis;
  218.     CAliasBase(void) {}
  219.     explicit CAliasBase(const TPrim& value)
  220.         : m_Data(value) {}
  222.     const TPrim& Get(void) const
  223.         {
  224.             return m_Data;
  225.         }
  226.     TPrim& Set(void)
  227.         {
  228.             return m_Data;
  229.         }
  230.     void Set(const TPrim& value)
  231.         {
  232.             m_Data = value;
  233.         }
  234.     operator TPrim(void) const
  235.         {
  236.             return m_Data;
  237.         }
  239.     TThis& operator*(void)
  240.         {
  241.             return *this;
  242.         }
  243.     TThis* operator->(void)
  244.         {
  245.             return this;
  246.         }
  248.     bool operator<(const TPrim& value) const
  249.         {
  250.             return m_Data < value;
  251.         }
  252.     bool operator>(const TPrim& value) const
  253.         {
  254.             return m_Data > value;
  255.         }
  256.     bool operator==(const TPrim& value) const
  257.         {
  258.             return m_Data == value;
  259.         }
  260.     bool operator!=(const TPrim& value) const
  261.         {
  262.             return m_Data != value;
  263.         }
  265.     static TPointerOffsetType GetDataPtr(const TThis* alias)
  266.         {
  267.             return TPointerOffsetType(&alias->m_Data);
  268.         }
  270. protected:
  271.     TPrim m_Data;
  272. };
  275. template <class TStd>
  276. class CStdAliasBase : public CAliasBase<TStd>
  277. {
  278.     typedef CAliasBase<TStd> TParent;
  279.     typedef CStdAliasBase<TStd> TThis;
  280. public:
  281.     CStdAliasBase(void)
  282.         {
  283.             this->m_Data = 0;
  284.         }
  285.     explicit CStdAliasBase(const TStd& value)
  286.         : TParent(value) {}
  287. };
  290. template <class TString>
  291. class CStringAliasBase : public CAliasBase<TString>
  292. {
  293.     typedef CAliasBase<TString> TParent;
  294.     typedef CStringAliasBase<TString> TThis;
  295. public:
  296.     CStringAliasBase(void)
  297.         {
  298.         }
  299.     explicit CStringAliasBase(const TString& value)
  300.         : TParent(value) {}
  301. };
  304. /////////////////////////////////////////////////////////////////////
  305. //
  306. //  Assignment and comparison for serializable objects
  307. //
  309. template <class C>
  310. C& SerialAssign(C& dest, const C& src, ESerialRecursionMode how = eRecursive)
  311. {
  312.     if ( typeid(src) != typeid(dest) ) {
  313.         ERR_POST(Fatal <<
  314.                  "SerialAssign() -- Assignment of incompatible types: " <<
  315.                  typeid(dest).name() << " = " << typeid(src).name());
  316.     }
  317.     C::GetTypeInfo()->Assign(&dest, &src, how);
  318.     return dest;
  319. }
  321. template <class C>
  322. bool SerialEquals(const C& object1, const C& object2,
  323.                   ESerialRecursionMode how = eRecursive)
  324. {
  325.     if ( typeid(object1) != typeid(object2) ) {
  326.         ERR_POST(Fatal <<
  327.                  "SerialAssign() -- Can not compare types: " <<
  328.                  typeid(object1).name() << " == " << typeid(object2).name());
  329.     }
  330.     return C::GetTypeInfo()->Equals(&object1, &object2, how);
  331. }
  333. // create on heap a clone of the source object
  334. template <typename C>
  335. C* SerialClone(const C& src)
  336. {
  337.     typename C::TTypeInfo type = C::GetTypeInfo();
  338.     TObjectPtr obj = type->Create();
  339.     type->Assign(obj, &src);
  340.     return static_cast<C*>(obj);
  341. }
  343. /////////////////////////////////////////////////////////////////////////////
  344. //
  345. //  I/O stream manipulators and helpers for serializable objects
  346. //
  348. // Formatting
  349. NCBI_XSERIAL_EXPORT CNcbiIos& MSerial_AsnText(CNcbiIos& io);
  350. NCBI_XSERIAL_EXPORT CNcbiIos& MSerial_AsnBinary(CNcbiIos& io);
  351. NCBI_XSERIAL_EXPORT CNcbiIos& MSerial_Xml(CNcbiIos& io);
  353. // Class member assignment verification
  354. NCBI_XSERIAL_EXPORT CNcbiIos& MSerial_VerifyDefault(CNcbiIos& io);
  355. NCBI_XSERIAL_EXPORT CNcbiIos& MSerial_VerifyNo(CNcbiIos& io);
  356. NCBI_XSERIAL_EXPORT CNcbiIos& MSerial_VerifyYes(CNcbiIos& io);
  357. NCBI_XSERIAL_EXPORT CNcbiIos& MSerial_VerifyDefValue(CNcbiIos& io);
  359. // Input/output
  360. NCBI_XSERIAL_EXPORT CNcbiOstream& operator<< (CNcbiOstream& str, const CSerialObject& obj);
  361. NCBI_XSERIAL_EXPORT CNcbiIstream& operator>> (CNcbiIstream& str, CSerialObject& obj);
  365. END_NCBI_SCOPE
  367. // these methods must be defined in root namespace so they have prefix NCBISER
  369. // default functions do nothing
  370. template<class CInfo>
  371. inline
  372. void NCBISERSetPostRead(const void* /*object*/, CInfo* /*info*/)
  373. {
  374. }
  376. template<class CInfo>
  377. inline
  378. void NCBISERSetPreWrite(const void* /*object*/, CInfo* /*info*/)
  379. {
  380. }
  382. // define for declaring specific function
  383. #define NCBISER_HAVE_POST_READ(Class) 
  384. template<class CInfo> 
  385. inline 
  386. void NCBISERSetPostRead(const Class* /*object*/, CInfo* info) 
  387. { 
  388.     NCBI_NS_NCBI::SetPostRead 
  389.         (info, &NCBI_NS_NCBI::CClassPostReadPreWrite<Class>::PostRead);
  390. }
  392. #define NCBISER_HAVE_PRE_WRITE(Class) 
  393. template<class CInfo> 
  394. inline 
  395. void NCBISERSetPreWrite(const Class* /*object*/, CInfo* info) 
  396. { 
  397.     NCBI_NS_NCBI::SetPreWrite 
  398.         (info, &NCBI_NS_NCBI::CClassPostReadPreWrite<Class>::PreWrite);
  399. }
  401. #define DECLARE_INTERNAL_TYPE_INFO() 
  402.     typedef const NCBI_NS_NCBI::CTypeInfo* TTypeInfo; 
  403.     virtual TTypeInfo GetThisTypeInfo(void) const { return GetTypeInfo(); } 
  404.     static  TTypeInfo GetTypeInfo(void)
  406. #define ENUM_METHOD_NAME(EnumName) 
  407.     NCBI_NAME2(GetTypeInfo_enum_,EnumName)
  408. #define DECLARE_ENUM_INFO(EnumName) 
  409.     const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EnumName)(void)
  410. #define DECLARE_INTERNAL_ENUM_INFO(EnumName) 
  411.     static DECLARE_ENUM_INFO(EnumName)
  413. #define DECLARE_STD_ALIAS_TYPE_INFO() 
  414.     static const NCBI_NS_NCBI::CTypeInfo* GetTypeInfo(void)
  416. #if HAVE_NCBI_C
  418. #define ASN_STRUCT_NAME(AsnStructName) NCBI_NAME2(struct_, AsnStructName)
  419. #define ASN_STRUCT_METHOD_NAME(AsnStructName) 
  420.     NCBI_NAME2(GetTypeInfo_struct_,AsnStructName)
  422. #define DECLARE_ASN_TYPE_INFO(AsnStructName) 
  423.     const NCBI_NS_NCBI::CTypeInfo* ASN_STRUCT_METHOD_NAME(AsnStructName)(void)
  424. #define DECLARE_ASN_STRUCT_INFO(AsnStructName) 
  425.     struct ASN_STRUCT_NAME(AsnStructName); 
  426.     DECLARE_ASN_TYPE_INFO(AsnStructName); 
  427.     inline 
  428.     const NCBI_NS_NCBI::CTypeInfo* 
  429.     GetAsnStructTypeInfo(const ASN_STRUCT_NAME(AsnStructName)* ) 
  430.     { 
  431.         return ASN_STRUCT_METHOD_NAME(AsnStructName)(); 
  432.     } 
  433.     struct ASN_STRUCT_NAME(AsnStructName)
  435. #define DECLARE_ASN_CHOICE_INFO(AsnChoiceName) 
  436.     DECLARE_ASN_TYPE_INFO(AsnChoiceName)
  438. #endif
  440. #endif  /* SERIALBASE__HPP */
  443. /* @} */
  446. /* ---------------------------------------------------------------------------
  447. * $Log: serialbase.hpp,v $
  448. * Revision 1000.3  2004/06/01 19:39:07  gouriano
  449. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.32
  450. *
  451. * Revision 1.32  2004/05/22 20:19:17  jcherry
  452. * Made CAliasBase::TThis typedef public
  453. *
  454. * Revision 1.31  2004/04/26 16:40:59  ucko
  455. * Tweak for GCC 3.4 compatibility.
  456. *
  457. * Revision 1.30  2004/03/25 15:56:28  gouriano
  458. * Added possibility to copy and compare serial object non-recursively
  459. *
  460. * Revision 1.29  2004/02/02 14:39:52  vasilche
  461. * Removed call to string::resize(0) in constructor - it's empty by default.
  462. *
  463. * Revision 1.28  2004/01/20 14:58:46  dicuccio
  464. * FIxed use of export specifiers - located before return type of function
  465. *
  466. * Revision 1.27  2004/01/16 21:50:41  gouriano
  467. * added export specifiers to i/o manipulators
  468. *
  469. * Revision 1.25  2003/11/13 14:06:44  gouriano
  470. * Elaborated data verification on read/write/get to enable skipping mandatory class data members
  471. *
  472. * Revision 1.24  2003/10/21 13:48:47  grichenk
  473. * Redesigned type aliases in serialization library.
  474. * Fixed the code (removed CRef-s, added explicit
  475. * initializers etc.)
  476. *
  477. * Revision 1.23  2003/09/22 20:57:07  gouriano
  478. * Changed base type of AnyContent object to CSerialObject
  479. *
  480. * Revision 1.22  2003/09/16 14:49:15  gouriano
  481. * Enhanced AnyContent objects to support XML namespaces and attribute info items.
  482. *
  483. * Revision 1.21  2003/08/25 15:58:32  gouriano
  484. * added possibility to use namespaces in XML i/o streams
  485. *
  486. * Revision 1.20  2003/08/13 15:47:02  gouriano
  487. * implemented serialization of AnyContent objects
  488. *
  489. * Revision 1.19  2003/04/29 18:29:06  gouriano
  490. * object data member initialization verification
  491. *
  492. * Revision 1.18  2003/04/15 16:18:48  siyan
  493. * Added doxygen support
  494. *
  495. * Revision 1.17  2003/03/28 18:52:04  dicuccio
  496. * Added Win32 exports for postread/postwrite set hooks
  497. *
  498. * Revision 1.16  2003/03/25 13:08:42  dicuccio
  499. * Added missing NCBI_NS_NCBI:: in PostRead()/PostWrite() macros
  500. *
  501. * Revision 1.15  2003/03/11 18:00:08  gouriano
  502. * reimplement CInvalidChoiceSelection exception
  503. *
  504. * Revision 1.14  2002/12/23 18:38:51  dicuccio
  505. * Added WIn32 export specifier: NCBI_XSERIAL_EXPORT.
  506. * Moved all CVS logs to the end.
  507. *
  508. * Revision 1.13  2002/05/29 21:18:43  gouriano
  509. * added debug dump
  510. *
  511. * Revision 1.12  2002/05/22 14:03:37  grichenk
  512. * CSerialUserOp -- added prefix UserOp_ to Assign() and Equals()
  513. *
  514. * Revision 1.11  2002/05/15 20:22:02  grichenk
  515. * Added CSerialObject -- base class for all generated ASN.1 classes
  516. *
  517. * Revision 1.10  2001/07/25 19:15:27  grichenk
  518. * Added comments. Added type checking before dynamic cast.
  519. *
  520. * Revision 1.9  2001/07/16 16:22:47  grichenk
  521. * Added CSerialUserOp class to create Assign() and Equals() methods for
  522. * user-defind classes.
  523. * Added SerialAssign<>() and SerialEquals<>() functions.
  524. *
  525. * Revision 1.8  2000/12/15 21:28:49  vasilche
  526. * Moved some typedefs/enums from corelib/ncbistd.hpp.
  527. * Added flags to CObjectIStream/CObjectOStream: eFlagAllowNonAsciiChars.
  528. * TByte typedef replaced by Uint1.
  529. *
  530. * Revision 1.7  2000/07/12 13:30:56  vasilche
  531. * Typo in function prototype.
  532. *
  533. * Revision 1.6  2000/07/11 20:34:51  vasilche
  534. * File included in all generated headers made lighter.
  535. * Nonnecessary code moved to serialimpl.hpp.
  536. *
  537. * Revision 1.5  2000/07/10 17:59:30  vasilche
  538. * Moved macros needed in headers to serialbase.hpp.
  539. * Use DECLARE_ENUM_INFO in generated code.
  540. *
  541. * Revision 1.4  2000/06/16 16:31:07  vasilche
  542. * Changed implementation of choices and classes info to allow use of the same classes in generated and user written classes.
  543. *
  544. * Revision 1.3  2000/05/04 16:21:36  vasilche
  545. * Fixed bug in choice reset.
  546. *
  547. * Revision 1.2  2000/04/28 16:58:03  vasilche
  548. * Added classes CByteSource and CByteSourceReader for generic reading.
  549. * Added delayed reading of choice variants.
  550. *
  551. * Revision 1.1  2000/04/03 18:47:09  vasilche
  552. * Added main include file for generated headers.
  553. * serialimpl.hpp is included in generated sources with GetTypeInfo methods
  554. *
  555. * ===========================================================================
  556. */