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

生物技术

开发平台:

C/C++

  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: member.hpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/04/12 17:14:45  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.33
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  9. #ifndef MEMBER__HPP
  10. #define MEMBER__HPP
  11. /*  $Id: member.hpp,v 1000.1 2004/04/12 17:14:45 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. #include <corelib/ncbistd.hpp>
  42. #include <serial/serialutil.hpp>
  43. #include <serial/item.hpp>
  44. #include <serial/hookdata.hpp>
  45. #include <serial/hookfunc.hpp>
  46. #include <serial/typeinfo.hpp>
  47. /** @addtogroup FieldsComplex
  48.  *
  49.  * @{
  50.  */
  51. BEGIN_NCBI_SCOPE
  52. class CClassTypeInfoBase;
  53. class CObjectIStream;
  54. class CObjectOStream;
  55. class CObjectStreamCopier;
  56. class CReadClassMemberHook;
  57. class CWriteClassMemberHook;
  58. class CSkipClassMemberHook;
  59. class CCopyClassMemberHook;
  60. class CDelayBuffer;
  61. class CMemberInfoFunctions;
  62. class NCBI_XSERIAL_EXPORT CMemberInfo : public CItemInfo
  63. {
  64.     typedef CItemInfo CParent;
  65. public:
  66.     typedef TConstObjectPtr (*TMemberGetConst)(const CMemberInfo* memberInfo,
  67.                                                TConstObjectPtr classPtr);
  68.     typedef TObjectPtr (*TMemberGet)(const CMemberInfo* memberInfo,
  69.                                      TObjectPtr classPtr);
  70.     CMemberInfo(const CClassTypeInfoBase* classType, const CMemberId& id,
  71.                 TPointerOffsetType offset, const CTypeRef& type);
  72.     CMemberInfo(const CClassTypeInfoBase* classType, const CMemberId& id,
  73.                 TPointerOffsetType offset, TTypeInfo type);
  74.     CMemberInfo(const CClassTypeInfoBase* classType, const char* id,
  75.                 TPointerOffsetType offset, const CTypeRef& type);
  76.     CMemberInfo(const CClassTypeInfoBase* classType, const char* id,
  77.                 TPointerOffsetType offset, TTypeInfo type);
  78.     const CClassTypeInfoBase* GetClassType(void) const;
  79.     bool Optional(void) const;
  80.     CMemberInfo* SetOptional(void);
  81.     CMemberInfo* SetNoPrefix(void);
  82.     CMemberInfo* SetAttlist(void);
  83.     CMemberInfo* SetNotag(void);
  84.     CMemberInfo* SetAnyContent(void);
  85.     bool NonEmpty(void) const;
  86.     CMemberInfo* SetNonEmpty(void);
  87.     TConstObjectPtr GetDefault(void) const;
  88.     CMemberInfo* SetDefault(TConstObjectPtr def);
  89.     bool HaveSetFlag(void) const;
  90.     CMemberInfo* SetSetFlag(const bool* setFlag);
  91.     CMemberInfo* SetSetFlag(const Uint4* setFlag);
  92.     CMemberInfo* SetOptional(const bool* setFlag);
  93.     enum ESetFlag {
  94.         eSetNo    = 0,
  95.         eSetMaybe = 1,
  96.         eSetYes   = 3
  97.     };
  98.     /// return current value of 'setFlag'
  99.     ESetFlag GetSetFlag(TConstObjectPtr object) const;
  100.     /// true if 'setFlag' is not eSetNo
  101.     bool GetSetFlagYes(TConstObjectPtr object) const;
  102.     /// true if 'setFlag' is eSetNo
  103.     bool GetSetFlagNo(TConstObjectPtr object) const;
  104.     /// set value of 'setFlag'
  105.     void UpdateSetFlag(TObjectPtr object, ESetFlag value) const;
  106.     /// set 'setFlag' to eSetYes
  107.     void UpdateSetFlagYes(TObjectPtr object) const;
  108.     /// set 'setFlag' to eSetMaybe
  109.     void UpdateSetFlagMaybe(TObjectPtr object) const;
  110.     /// set 'setFlag' to eSetNo and return true if previous value wasn't eSetNo
  111.     bool UpdateSetFlagNo(TObjectPtr object) const;
  112.     bool CompareSetFlags(TConstObjectPtr object1,
  113.                          TConstObjectPtr object2) const;
  114.     bool CanBeDelayed(void) const;
  115.     CMemberInfo* SetDelayBuffer(CDelayBuffer* buffer);
  116.     CDelayBuffer& GetDelayBuffer(TObjectPtr object) const;
  117.     const CDelayBuffer& GetDelayBuffer(TConstObjectPtr object) const;
  118.     void SetParentClass(void);
  119.     // I/O
  120.     void ReadMember(CObjectIStream& in, TObjectPtr classPtr) const;
  121.     void ReadMissingMember(CObjectIStream& in, TObjectPtr classPtr) const;
  122.     void WriteMember(CObjectOStream& out, TConstObjectPtr classPtr) const;
  123.     void CopyMember(CObjectStreamCopier& copier) const;
  124.     void CopyMissingMember(CObjectStreamCopier& copier) const;
  125.     void SkipMember(CObjectIStream& in) const;
  126.     void SkipMissingMember(CObjectIStream& in) const;
  127.     TObjectPtr GetMemberPtr(TObjectPtr classPtr) const;
  128.     TConstObjectPtr GetMemberPtr(TConstObjectPtr classPtr) const;
  129.     // hooks
  130.     void SetGlobalReadHook(CReadClassMemberHook* hook);
  131.     void SetLocalReadHook(CObjectIStream& in, CReadClassMemberHook* hook);
  132.     void ResetGlobalReadHook(void);
  133.     void ResetLocalReadHook(CObjectIStream& in);
  134.     void SetPathReadHook(CObjectIStream* in, const string& path,
  135.                          CReadClassMemberHook* hook);
  136.     void SetGlobalWriteHook(CWriteClassMemberHook* hook);
  137.     void SetLocalWriteHook(CObjectOStream& out, CWriteClassMemberHook* hook);
  138.     void ResetGlobalWriteHook(void);
  139.     void ResetLocalWriteHook(CObjectOStream& out);
  140.     void SetPathWriteHook(CObjectOStream* out, const string& path,
  141.                           CWriteClassMemberHook* hook);
  142.     void SetGlobalSkipHook(CSkipClassMemberHook* hook);
  143.     void SetLocalSkipHook(CObjectIStream& in, CSkipClassMemberHook* hook);
  144.     void ResetGlobalSkipHook(void);
  145.     void ResetLocalSkipHook(CObjectIStream& in);
  146.     void SetPathSkipHook(CObjectIStream* in, const string& path,
  147.                          CSkipClassMemberHook* hook);
  148.     void SetGlobalCopyHook(CCopyClassMemberHook* hook);
  149.     void SetLocalCopyHook(CObjectStreamCopier& copier,
  150.                           CCopyClassMemberHook* hook);
  151.     void ResetGlobalCopyHook(void);
  152.     void ResetLocalCopyHook(CObjectStreamCopier& copier);
  153.     void SetPathCopyHook(CObjectStreamCopier* copier, const string& path,
  154.                          CCopyClassMemberHook* hook);
  155.     // default I/O (without hooks)
  156.     void DefaultReadMember(CObjectIStream& in,
  157.                            TObjectPtr classPtr) const;
  158.     void DefaultReadMissingMember(CObjectIStream& in,
  159.                                   TObjectPtr classPtr) const;
  160.     void DefaultWriteMember(CObjectOStream& out,
  161.                             TConstObjectPtr classPtr) const;
  162.     void DefaultCopyMember(CObjectStreamCopier& copier) const;
  163.     void DefaultCopyMissingMember(CObjectStreamCopier& copier) const;
  164.     void DefaultSkipMember(CObjectIStream& in) const;
  165.     void DefaultSkipMissingMember(CObjectIStream& in) const;
  166.     virtual void UpdateDelayedBuffer(CObjectIStream& in,
  167.                                      TObjectPtr classPtr) const;
  168. private:
  169.     // Create parent class object
  170.     TObjectPtr CreateClass(void) const;
  171.     // containing class type info
  172.     const CClassTypeInfoBase* m_ClassType;
  173.     // is optional
  174.     bool m_Optional;
  175.     bool m_NonEmpty;
  176.     // default value
  177.     TConstObjectPtr m_Default;
  178.     // offset of 'SET' flag inside object
  179.     TPointerOffsetType m_SetFlagOffset;
  180.     bool m_BitSetFlag;
  181.     // offset of delay buffer inside object
  182.     TPointerOffsetType m_DelayOffset;
  183.     TMemberGetConst m_GetConstFunction;
  184.     TMemberGet m_GetFunction;
  185.     CHookData<CReadClassMemberHook, SMemberReadFunctions> m_ReadHookData;
  186.     CHookData<CWriteClassMemberHook, TMemberWriteFunction> m_WriteHookData;
  187.     CHookData<CSkipClassMemberHook, SMemberSkipFunctions> m_SkipHookData;
  188.     CHookData<CCopyClassMemberHook, SMemberCopyFunctions> m_CopyHookData;
  189.     void SetReadFunction(TMemberReadFunction func);
  190.     void SetReadMissingFunction(TMemberReadFunction func);
  191.     void SetWriteFunction(TMemberWriteFunction func);
  192.     void SetCopyFunction(TMemberCopyFunction func);
  193.     void SetCopyMissingFunction(TMemberCopyFunction func);
  194.     void SetSkipFunction(TMemberSkipFunction func);
  195.     void SetSkipMissingFunction(TMemberSkipFunction func);
  196.     void UpdateFunctions(void);
  197.     friend class CMemberInfoFunctions;
  198. };
  199. /* @} */
  200. #include <serial/member.inl>
  201. END_NCBI_SCOPE
  202. #endif  /* MEMBER__HPP */
  203. /* ---------------------------------------------------------------------------
  204. * $Log: member.hpp,v $
  205. * Revision 1000.1  2004/04/12 17:14:45  gouriano
  206. * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.33
  207. *
  208. * Revision 1.33  2004/01/05 14:24:08  gouriano
  209. * Added possibility to set serialization hooks by stack path
  210. *
  211. * Revision 1.32  2003/10/01 14:40:12  vasilche
  212. * Fixed CanGet() for members wihout 'set' flag.
  213. *
  214. * Revision 1.31  2003/09/16 14:49:15  gouriano
  215. * Enhanced AnyContent objects to support XML namespaces and attribute info items.
  216. *
  217. * Revision 1.30  2003/08/14 20:03:57  vasilche
  218. * Avoid memory reallocation when reading over preallocated object.
  219. * Simplified CContainerTypeInfo iterators interface.
  220. *
  221. * Revision 1.29  2003/07/29 18:47:46  vasilche
  222. * Fixed thread safeness of object stream hooks.
  223. *
  224. * Revision 1.28  2003/06/24 20:54:13  gouriano
  225. * corrected code generation and serialization of non-empty unnamed containers (XML)
  226. *
  227. * Revision 1.27  2003/04/29 18:29:06  gouriano
  228. * object data member initialization verification
  229. *
  230. * Revision 1.26  2003/04/15 14:15:23  siyan
  231. * Added doxygen support
  232. *
  233. * Revision 1.25  2003/04/10 20:13:37  vakatov
  234. * Rollback the "uninitialized member" verification -- it still needs to
  235. * be worked upon...
  236. *
  237. * Revision 1.23  2002/12/23 18:38:51  dicuccio
  238. * Added WIn32 export specifier: NCBI_XSERIAL_EXPORT.
  239. * Moved all CVS logs to the end.
  240. *
  241. * Revision 1.22  2002/11/14 20:47:22  gouriano
  242. * modified constructor to use CClassTypeInfoBase,
  243. * added Attlist and Notag flags
  244. *
  245. * Revision 1.21  2002/09/25 19:38:25  gouriano
  246. * added the possibility of having no tag prefix in XML I/O streams
  247. *
  248. * Revision 1.20  2002/09/09 18:13:59  grichenk
  249. * Added CObjectHookGuard class.
  250. * Added methods to be used by hooks for data
  251. * reading and skipping.
  252. *
  253. * Revision 1.19  2000/10/13 20:22:45  vasilche
  254. * Fixed warnings on 64 bit compilers.
  255. * Fixed missing typename in templates.
  256. *
  257. * Revision 1.18  2000/10/03 17:22:32  vasilche
  258. * Reduced header dependency.
  259. * Reduced size of debug libraries on WorkShop by 3 times.
  260. * Fixed tag allocation for parent classes.
  261. * Fixed CObject allocation/deallocation in streams.
  262. * Moved instantiation of several templates in separate source file.
  263. *
  264. * Revision 1.17  2000/09/29 16:18:12  vasilche
  265. * Fixed binary format encoding/decoding on 64 bit compulers.
  266. * Implemented CWeakMap<> for automatic cleaning map entries.
  267. * Added cleaning local hooks via CWeakMap<>.
  268. * Renamed ReadTypeName -> ReadFileHeader, ENoTypeName -> ENoFileHeader.
  269. * Added some user interface methods to CObjectIStream, CObjectOStream and
  270. * CObjectStreamCopier.
  271. *
  272. * Revision 1.16  2000/09/26 17:38:07  vasilche
  273. * Fixed incomplete choiceptr implementation.
  274. * Removed temporary comments.
  275. *
  276. * Revision 1.15  2000/09/19 14:10:24  vasilche
  277. * Added files to MSVC project
  278. * Updated shell scripts to use new datattool path on MSVC
  279. * Fixed internal compiler error on MSVC
  280. *
  281. * Revision 1.14  2000/09/18 20:00:02  vasilche
  282. * Separated CVariantInfo and CMemberInfo.
  283. * Implemented copy hooks.
  284. * All hooks now are stored in CTypeInfo/CMemberInfo/CVariantInfo.
  285. * Most type specific functions now are implemented via function pointers instead of virtual functions.
  286. *
  287. * Revision 1.13  2000/08/15 19:44:38  vasilche
  288. * Added Read/Write hooks:
  289. * CReadObjectHook/CWriteObjectHook for objects of specified type.
  290. * CReadClassMemberHook/CWriteClassMemberHook for specified members.
  291. * CReadChoiceVariantHook/CWriteChoiceVariant for specified choice variants.
  292. * CReadContainerElementHook/CWriteContainerElementsHook for containers.
  293. *
  294. * Revision 1.12  2000/06/16 20:01:20  vasilche
  295. * Avoid use of unexpected_exception() which is unimplemented on Mac.
  296. *
  297. * Revision 1.11  2000/06/16 19:24:22  vasilche
  298. * Updated MSVC project.
  299. * Fixed error on MSVC with static const class member.
  300. *
  301. * Revision 1.10  2000/06/16 16:31:05  vasilche
  302. * Changed implementation of choices and classes info to allow use of the same classes in generated and user written classes.
  303. *
  304. * Revision 1.9  2000/06/15 19:26:33  vasilche
  305. * Fixed compilation error on Mac.
  306. *
  307. * Revision 1.8  2000/04/28 16:58:01  vasilche
  308. * Added classes CByteSource and CByteSourceReader for generic reading.
  309. * Added delayed reading of choice variants.
  310. *
  311. * Revision 1.7  2000/03/07 14:05:29  vasilche
  312. * Added stream buffering to ASN.1 binary input.
  313. * Optimized class loading/storing.
  314. * Fixed bugs in processing OPTIONAL fields.
  315. *
  316. * Revision 1.6  2000/02/01 21:44:35  vasilche
  317. * Added CGeneratedChoiceTypeInfo for generated choice classes.
  318. * Added buffering to CObjectIStreamAsn.
  319. * Removed CMemberInfo subclasses.
  320. * Added support for DEFAULT/OPTIONAL members.
  321. *
  322. * Revision 1.5  1999/09/01 17:38:00  vasilche
  323. * Fixed vector<char> implementation.
  324. * Added explicit naming of class info.
  325. * Moved IMPLICIT attribute from member info to class info.
  326. *
  327. * Revision 1.4  1999/08/31 17:50:03  vasilche
  328. * Implemented several macros for specific data types.
  329. * Added implicit members.
  330. * Added multimap and set.
  331. *
  332. * Revision 1.3  1999/08/13 15:53:42  vasilche
  333. * C++ analog of asntool: datatool
  334. *
  335. * Revision 1.2  1999/06/30 16:04:21  vasilche
  336. * Added support for old ASN.1 structures.
  337. *
  338. * Revision 1.1  1999/06/24 14:44:38  vasilche
  339. * Added binary ASN.1 output.
  340. *
  341. * ===========================================================================
  342. */