variant.hpp
上传用户:yhdzpy8989
上传日期:2007-06-13
资源大小:13604k
文件大小:10k
- /*
- * ===========================================================================
- * PRODUCTION $Log: variant.hpp,v $
- * PRODUCTION Revision 1000.1 2004/04/12 17:16:08 gouriano
- * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.12
- * PRODUCTION
- * ===========================================================================
- */
- #ifndef VARIANT__HPP
- #define VARIANT__HPP
- /* $Id: variant.hpp,v 1000.1 2004/04/12 17:16:08 gouriano Exp $
- * ===========================================================================
- *
- * PUBLIC DOMAIN NOTICE
- * National Center for Biotechnology Information
- *
- * This software/database is a "United States Government Work" under the
- * terms of the United States Copyright Act. It was written as part of
- * the author's official duties as a United States Government employee and
- * thus cannot be copyrighted. This software/database is freely available
- * to the public for use. The National Library of Medicine and the U.S.
- * Government have not placed any restriction on its use or reproduction.
- *
- * Although all reasonable efforts have been taken to ensure the accuracy
- * and reliability of the software and data, the NLM and the U.S.
- * Government do not and cannot warrant the performance or results that
- * may be obtained by using this software or data. The NLM and the U.S.
- * Government disclaim all warranties, express or implied, including
- * warranties of performance, merchantability or fitness for any particular
- * purpose.
- *
- * Please cite the author in any work or product based on this material.
- *
- * ===========================================================================
- *
- * Author: Eugene Vasilchenko
- *
- * File Description:
- * !!! PUT YOUR DESCRIPTION HERE !!!
- */
- #include <corelib/ncbistd.hpp>
- #include <serial/serialutil.hpp>
- #include <serial/item.hpp>
- #include <serial/hookdata.hpp>
- #include <serial/hookfunc.hpp>
- #include <serial/typeinfo.hpp>
- /** @addtogroup FieldsComplex
- *
- * @{
- */
- BEGIN_NCBI_SCOPE
- class CChoiceTypeInfo;
- class CObjectIStream;
- class CObjectOStream;
- class CObjectStreamCopier;
- class CReadChoiceVariantHook;
- class CWriteChoiceVariantHook;
- class CSkipChoiceVariantHook;
- class CCopyChoiceVariantHook;
- class CDelayBuffer;
- class CVariantInfoFunctions;
- class NCBI_XSERIAL_EXPORT CVariantInfo : public CItemInfo
- {
- typedef CItemInfo CParent;
- public:
- typedef TConstObjectPtr (*TVariantGetConst)(const CVariantInfo*variantInfo,
- TConstObjectPtr choicePtr);
- typedef TObjectPtr (*TVariantGet)(const CVariantInfo* variantInfo,
- TObjectPtr choicePtr);
- enum EVariantType {
- ePointerFlag = 1 << 0,
- eObjectFlag = 1 << 1,
- eInlineVariant = 0,
- eNonObjectPointerVariant = ePointerFlag,
- eObjectPointerVariant = ePointerFlag | eObjectFlag,
- eSubClassVariant = eObjectFlag
- };
- CVariantInfo(const CChoiceTypeInfo* choiceType, const CMemberId& id,
- TPointerOffsetType offset, const CTypeRef& type);
- CVariantInfo(const CChoiceTypeInfo* choiceType, const CMemberId& id,
- TPointerOffsetType offset, TTypeInfo type);
- CVariantInfo(const CChoiceTypeInfo* choiceType, const char* id,
- TPointerOffsetType offset, const CTypeRef& type);
- CVariantInfo(const CChoiceTypeInfo* choiceType, const char* id,
- TPointerOffsetType offset, TTypeInfo type);
- const CChoiceTypeInfo* GetChoiceType(void) const;
- EVariantType GetVariantType(void) const;
- CVariantInfo* SetNoPrefix(void);
- CVariantInfo* SetNotag(void);
- bool IsInline(void) const;
- bool IsNonObjectPointer(void) const;
- bool IsObjectPointer(void) const;
- bool IsSubClass(void) const;
- bool IsPointer(void) const;
- bool IsNotPointer(void) const;
- bool IsObject(void) const;
- bool IsNotObject(void) const;
- CVariantInfo* SetPointer(void);
- CVariantInfo* SetObjectPointer(void);
- CVariantInfo* SetSubClass(void);
- bool CanBeDelayed(void) const;
- CVariantInfo* SetDelayBuffer(CDelayBuffer* buffer);
- CDelayBuffer& GetDelayBuffer(TObjectPtr object) const;
- const CDelayBuffer& GetDelayBuffer(TConstObjectPtr object) const;
- TConstObjectPtr GetVariantPtr(TConstObjectPtr choicePtr) const;
- TObjectPtr GetVariantPtr(TObjectPtr choicePtr) const;
- // I/O
- void ReadVariant(CObjectIStream& in, TObjectPtr choicePtr) const;
- void WriteVariant(CObjectOStream& out, TConstObjectPtr choicePtr) const;
- void CopyVariant(CObjectStreamCopier& copier) const;
- void SkipVariant(CObjectIStream& in) const;
- // hooks
- void SetGlobalReadHook(CReadChoiceVariantHook* hook);
- void SetLocalReadHook(CObjectIStream& in,
- CReadChoiceVariantHook* hook);
- void ResetGlobalReadHook(void);
- void ResetLocalReadHook(CObjectIStream& in);
- void SetPathReadHook(CObjectIStream* in, const string& path,
- CReadChoiceVariantHook* hook);
- void SetGlobalWriteHook(CWriteChoiceVariantHook* hook);
- void SetLocalWriteHook(CObjectOStream& out,
- CWriteChoiceVariantHook* hook);
- void ResetGlobalWriteHook(void);
- void ResetLocalWriteHook(CObjectOStream& out);
- void SetPathWriteHook(CObjectOStream* out, const string& path,
- CWriteChoiceVariantHook* hook);
- void SetGlobalSkipHook(CSkipChoiceVariantHook* hook);
- void SetLocalSkipHook(CObjectIStream& in, CSkipChoiceVariantHook* hook);
- void ResetGlobalSkipHook(void);
- void ResetLocalSkipHook(CObjectIStream& in);
- void SetPathSkipHook(CObjectIStream* in, const string& path,
- CSkipChoiceVariantHook* hook);
- void SetGlobalCopyHook(CCopyChoiceVariantHook* hook);
- void SetLocalCopyHook(CObjectStreamCopier& copier,
- CCopyChoiceVariantHook* hook);
- void ResetGlobalCopyHook(void);
- void ResetLocalCopyHook(CObjectStreamCopier& copier);
- void SetPathCopyHook(CObjectStreamCopier* copier, const string& path,
- CCopyChoiceVariantHook* hook);
- // default I/O (without hooks)
- void DefaultReadVariant(CObjectIStream& in,
- TObjectPtr choicePtr) const;
- void DefaultWriteVariant(CObjectOStream& out,
- TConstObjectPtr choicePtr) const;
- void DefaultCopyVariant(CObjectStreamCopier& copier) const;
- void DefaultSkipVariant(CObjectIStream& in) const;
-
- virtual void UpdateDelayedBuffer(CObjectIStream& in,
- TObjectPtr classPtr) const;
- private:
- // Create choice object
- TObjectPtr CreateChoice(void) const;
- // owning choice type info
- const CChoiceTypeInfo* m_ChoiceType;
- // type of variant implementation: inline, pointer etc.
- EVariantType m_VariantType;
- // offset of delay buffer inside object
- TPointerOffsetType m_DelayOffset;
- TVariantGetConst m_GetConstFunction;
- TVariantGet m_GetFunction;
- CHookData<CReadChoiceVariantHook, TVariantReadFunction> m_ReadHookData;
- CHookData<CWriteChoiceVariantHook, TVariantWriteFunction> m_WriteHookData;
- CHookData<CSkipChoiceVariantHook, TVariantSkipFunction> m_SkipHookData;
- CHookData<CCopyChoiceVariantHook, TVariantCopyFunction> m_CopyHookData;
- void SetReadFunction(TVariantReadFunction func);
- void SetWriteFunction(TVariantWriteFunction func);
- void SetCopyFunction(TVariantCopyFunction func);
- void SetSkipFunction(TVariantSkipFunction func);
- void UpdateFunctions(void);
- friend class CVariantInfoFunctions;
- };
- /* @} */
- #include <serial/variant.inl>
- END_NCBI_SCOPE
- #endif /* VARIANT__HPP */
- /* ---------------------------------------------------------------------------
- * $Log: variant.hpp,v $
- * Revision 1000.1 2004/04/12 17:16:08 gouriano
- * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.12
- *
- * Revision 1.12 2004/01/05 14:24:10 gouriano
- * Added possibility to set serialization hooks by stack path
- *
- * Revision 1.11 2003/07/29 18:47:47 vasilche
- * Fixed thread safeness of object stream hooks.
- *
- * Revision 1.10 2003/04/15 16:19:15 siyan
- * Added doxygen support
- *
- * Revision 1.9 2002/12/23 18:38:52 dicuccio
- * Added WIn32 export specifier: NCBI_XSERIAL_EXPORT.
- * Moved all CVS logs to the end.
- *
- * Revision 1.8 2002/11/19 19:45:55 gouriano
- * added SetNotag method
- *
- * Revision 1.7 2002/10/15 13:39:06 gouriano
- * added "noprefix" flag
- *
- * Revision 1.6 2002/09/09 18:14:00 grichenk
- * Added CObjectHookGuard class.
- * Added methods to be used by hooks for data
- * reading and skipping.
- *
- * Revision 1.5 2000/10/13 20:22:47 vasilche
- * Fixed warnings on 64 bit compilers.
- * Fixed missing typename in templates.
- *
- * Revision 1.4 2000/10/03 17:22:36 vasilche
- * Reduced header dependency.
- * Reduced size of debug libraries on WorkShop by 3 times.
- * Fixed tag allocation for parent classes.
- * Fixed CObject allocation/deallocation in streams.
- * Moved instantiation of several templates in separate source file.
- *
- * Revision 1.3 2000/09/29 16:18:15 vasilche
- * Fixed binary format encoding/decoding on 64 bit compulers.
- * Implemented CWeakMap<> for automatic cleaning map entries.
- * Added cleaning local hooks via CWeakMap<>.
- * Renamed ReadTypeName -> ReadFileHeader, ENoTypeName -> ENoFileHeader.
- * Added some user interface methods to CObjectIStream, CObjectOStream and
- * CObjectStreamCopier.
- *
- * Revision 1.2 2000/09/26 17:38:08 vasilche
- * Fixed incomplete choiceptr implementation.
- * Removed temporary comments.
- *
- * Revision 1.1 2000/09/18 20:00:12 vasilche
- * Separated CVariantInfo and CMemberInfo.
- * Implemented copy hooks.
- * All hooks now are stored in CTypeInfo/CMemberInfo/CVariantInfo.
- * Most type specific functions now are implemented via function pointers instead of virtual functions.
- *
- * ===========================================================================
- */