asntypes.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: asntypes.hpp,v $
 * PRODUCTION Revision 1000.3  2004/06/01 19:38:22  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.42
 * PRODUCTION
 * ===========================================================================
 */

#ifndef ASNTYPES__HPP
#define ASNTYPES__HPP

/*  $Id: asntypes.hpp,v 1000.3 2004/06/01 19:38:22 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>

#if HAVE_NCBI_C

#include <serial/typeinfo.hpp>
#include <serial/serialutil.hpp>
#include <serial/continfo.hpp>
#include <serial/stdtypes.hpp>
#include <serial/typeref.hpp>
#include <serial/serialasndef.hpp>


/** @addtogroup TypeInfoC
 *
 * @{
 */


struct valnode;
struct bytestore;
struct asnio;
struct asntype;

BEGIN_NCBI_SCOPE

class NCBI_XSERIAL_EXPORT CSequenceOfTypeInfo : public CContainerTypeInfo {
    typedef CContainerTypeInfo CParent;
public:
    typedef TObjectPtr TObjectType;

    CSequenceOfTypeInfo(TTypeInfo type, bool randomOrder = false);
    CSequenceOfTypeInfo(const char* name,
                        TTypeInfo type, bool randomOrder = false);
    CSequenceOfTypeInfo(const string& name,
                        TTypeInfo type, bool randomOrder = false);

    size_t GetNextOffset(void) const
        {
            return m_NextOffset;
        }
    size_t GetDataOffset(void) const
        {
            return m_DataOffset;
        }
    
    static TObjectPtr& FirstNode(TObjectPtr object)
        {
            return CTypeConverter<TObjectPtr>::Get(object);
        }
    static TObjectPtr FirstNode(TConstObjectPtr object)
        {
            return CTypeConverter<TObjectPtr>::Get(object);
        }
    TObjectPtr& NextNode(TObjectPtr object) const
        {
            return CTypeConverter<TObjectPtr>::Get
                (CRawPointer::Add(object, m_NextOffset));
        }
    TObjectPtr NextNode(TConstObjectPtr object) const
        {
            return CTypeConverter<TObjectPtr>::Get
                (CRawPointer::Add(object, m_NextOffset));
        }
    TObjectPtr Data(TObjectPtr object) const
        {
            return CRawPointer::Add(object, m_DataOffset);
        }
    TConstObjectPtr Data(TConstObjectPtr object) const
        {
            return CRawPointer::Add(object, m_DataOffset);
        }

    static TTypeInfo GetTypeInfo(TTypeInfo base);
    static CTypeInfo* CreateTypeInfo(TTypeInfo base);

    virtual bool IsDefault(TConstObjectPtr object) const;
    virtual void SetDefault(TObjectPtr dst) const;
    virtual void Assign(TObjectPtr dst, TConstObjectPtr src,
                        ESerialRecursionMode how = eRecursive) const;

    TObjectPtr CreateNode(void) const;
    void DeleteNode(TObjectPtr node) const;

private:
    void InitSequenceOfTypeInfo(void);

    // set this sequence to have ValNode as data holder
    // (used for SET OF (INTEGER, STRING, SET OF etc.)
    void SetValNodeNext(void);
    // SET OF CHOICE (use choice's valnode->next field as link)
    void SetChoiceNext(void);

private:
    size_t m_NextOffset;  // offset in struct of pointer to next object (def 0)
    size_t m_DataOffset;  // offset in struct of data struct (def 0)
};

class NCBI_XSERIAL_EXPORT CSetOfTypeInfo : public CSequenceOfTypeInfo {
    typedef CSequenceOfTypeInfo CParent;
public:
    CSetOfTypeInfo(TTypeInfo type);
    CSetOfTypeInfo(const char* name, TTypeInfo type);
    CSetOfTypeInfo(const string& name, TTypeInfo type);

    static TTypeInfo GetTypeInfo(TTypeInfo base);
    static CTypeInfo* CreateTypeInfo(TTypeInfo base);
};

class NCBI_XSERIAL_EXPORT COctetStringTypeInfo : public CPrimitiveTypeInfo {
    typedef CPrimitiveTypeInfo CParent;
public:
    typedef bytestore* TObjectType;

    COctetStringTypeInfo(void);

    static TObjectType& Get(TObjectPtr object)
        {
            return CTypeConverter<TObjectType>::Get(object);
        }
    static const TObjectType& Get(TConstObjectPtr object)
        {
            return CTypeConverter<TObjectType>::Get(object);
        }

    static TTypeInfo GetTypeInfo(void);

    virtual bool IsDefault(TConstObjectPtr object) const;
    virtual bool Equals(TConstObjectPtr obj1, TConstObjectPtr obj2,
                        ESerialRecursionMode how = eRecursive) const;
    virtual void SetDefault(TObjectPtr dst) const;
    virtual void Assign(TObjectPtr dst, TConstObjectPtr src,
                        ESerialRecursionMode how = eRecursive) const;

    virtual void GetValueOctetString(TConstObjectPtr objectPtr,
                                     vector<char>& value) const;
    virtual void SetValueOctetString(TObjectPtr objectPtr,
                                     const vector<char>& value) const;
protected:
    
    static void ReadOctetString(CObjectIStream& in,
                                TTypeInfo objectType,
                                TObjectPtr objectPtr);
    static void WriteOctetString(CObjectOStream& out,
                                 TTypeInfo objectType,
                                 TConstObjectPtr objectPtr);
    static void SkipOctetString(CObjectIStream& in,
                                TTypeInfo objectType);
    static void CopyOctetString(CObjectStreamCopier& copier,
                                TTypeInfo objectType);
};

class NCBI_XSERIAL_EXPORT COldAsnTypeInfo : public CPrimitiveTypeInfo
{
    typedef CPrimitiveTypeInfo CParent;
public:
    typedef void* TObjectType;

    COldAsnTypeInfo(const char* name,
                    TAsnNewProc newProc, TAsnFreeProc freeProc,
                    TAsnReadProc readProc, TAsnWriteProc writeProc);
    COldAsnTypeInfo(const string& name,
                    TAsnNewProc newProc, TAsnFreeProc freeProc,
                    TAsnReadProc readProc, TAsnWriteProc writeProc);

    static TObjectType& Get(TObjectPtr object)
        {
            return CTypeConverter<TObjectType>::Get(object);
        }
    static const TObjectType& Get(TConstObjectPtr object)
        {
            return CTypeConverter<TObjectType>::Get(object);
        }

    virtual bool IsDefault(TConstObjectPtr object) const;
    virtual bool Equals(TConstObjectPtr object1, TConstObjectPtr object2,
                        ESerialRecursionMode how = eRecursive) const;
    virtual void SetDefault(TObjectPtr dst) const;
    virtual void Assign(TObjectPtr dst, TConstObjectPtr src,
                 ESerialRecursionMode how = eRecursive) const;

protected:
    
    static void ReadOldAsnStruct(CObjectIStream& in,
                                 TTypeInfo objectType,
                                 TObjectPtr objectPtr);
    static void WriteOldAsnStruct(CObjectOStream& out,
                                  TTypeInfo objectType,
                                  TConstObjectPtr objectPtr);

private:
    TAsnNewProc m_NewProc;
    TAsnFreeProc m_FreeProc;
    TAsnReadProc m_ReadProc;
    TAsnWriteProc m_WriteProc;
};

//#include <serial/asntypes.inl>

END_NCBI_SCOPE

#endif  /* HAVE_NCBI_C */

#endif  /* ASNTYPES__HPP */


/* @} */


/*
 * ---------------------------------------------------------------------------
 * $Log: asntypes.hpp,v $
 * Revision 1000.3  2004/06/01 19:38:22  gouriano
 * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.42
 *
 * Revision 1.42  2004/04/27 21:44:56  jcherry
 * Made a couple of typedefs public
 *
 * Revision 1.41  2004/03/25 15:56:27  gouriano
 * Added possibility to copy and compare serial object non-recursively
 *
 * Revision 1.40  2003/12/01 19:04:21  grichenk
 * Moved Add and Sub from serialutil to ncbimisc, made them methods
 * of CRawPointer class.
 *
 * Revision 1.39  2003/04/15 14:14:51  siyan
 * Added doxygen support
 *
 * Revision 1.38  2003/03/26 16:13:32  vasilche
 * Removed TAB symbols. Some formatting.
 *
 * Revision 1.37  2002/12/23 18:38:50  dicuccio
 * Added WIn32 export specifier: NCBI_XSERIAL_EXPORT.
 * Moved all CVS logs to the end.
 *
 * Revision 1.36  2000/11/07 17:25:11  vasilche
 * Fixed encoding of XML:
 *     removed unnecessary apostrophes in OCTET STRING
 *     removed unnecessary content in NULL
 * Added module names to CTypeInfo and CEnumeratedTypeValues
 *
 * Revision 1.35  2000/10/13 16:28:28  vasilche
 * Reduced header dependency.
 * Avoid use of templates with virtual methods.
 * Reduced amount of different maps used.
 * All this lead to smaller compiled code size (libraries and programs).
 *
 * Revision 1.34  2000/09/19 20:16:52  vasilche
 * Fixed type in CStlClassInfo_auto_ptr.
 * Added missing include serialutil.hpp.
 *
 * Revision 1.33  2000/09/18 19:59:58  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.
 *
 * Revision 1.32  2000/09/01 13:15:57  vasilche
 * Implemented class/container/choice iterators.
 * Implemented CObjectStreamCopier for copying data without loading into memory.
 *
 * Revision 1.31  2000/08/15 19:44:37  vasilche
 * Added Read/Write hooks:
 * CReadObjectHook/CWriteObjectHook for objects of specified type.
 * CReadClassMemberHook/CWriteClassMemberHook for specified members.
 * CReadChoiceVariantHook/CWriteChoiceVariant for specified choice variants.
 * CReadContainerElementHook/CWriteContainerElementsHook for containers.
 *
 * Revision 1.30  2000/07/10 17:31:51  vasilche
 * Macro arguments made more clear.
 * All old ASN stuff moved to serialasn.hpp.
 * Changed prefix of enum info functions to GetTypeInfo_enum_.
 *
 * Revision 1.29  2000/07/03 18:42:32  vasilche
 * Added interface to typeinfo via CObjectInfo and CConstObjectInfo.
 * Reduced header dependency.
 *
 * Revision 1.28  2000/06/16 16:31:03  vasilche
 * Changed implementation of choices and classes info to allow use of the same classes in generated and user written classes.
 *
 * Revision 1.27  2000/06/07 19:45:41  vasilche
 * Some code cleaning.
 * Macros renaming in more clear way.
 * BEGIN_NAMED_*_INFO, ADD_*_MEMBER, ADD_NAMED_*_MEMBER.
 *
 * Revision 1.26  2000/03/31 21:38:17  vasilche
 * Renamed First() -> FirstNode(), Next() -> NextNode() to avoid name conflict.
 *
 * Revision 1.25  2000/03/07 14:05:27  vasilche
 * Added stream buffering to ASN.1 binary input.
 * Optimized class loading/storing.
 * Fixed bugs in processing OPTIONAL fields.
 *
 * Revision 1.24  2000/02/17 20:02:26  vasilche
 * Added some standard serialization exceptions.
 * Optimized text/binary ASN.1 reading.
 * Fixed wrong encoding of StringStore in ASN.1 binary format.
 * Optimized logic of object collection.
 *
 * Revision 1.23  2000/02/01 21:44:33  vasilche
 * Added CGeneratedChoiceTypeInfo for generated choice classes.
 * Added buffering to CObjectIStreamAsn.
 * Removed CMemberInfo subclasses.
 * Added support for DEFAULT/OPTIONAL members.
*
* Revision 1.22  1999/12/28 18:55:39  vasilche
* Reduced size of compiled object files:
* 1. avoid inline or implicit virtual methods (especially destructors).
* 2. avoid std::string's methods usage in inline methods.
* 3. avoid string literals ("xxx") in inline methods.
*
* Revision 1.21  1999/12/17 19:04:51  vasilche
* Simplified generation of GetTypeInfo methods.
*
* Revision 1.20  1999/11/22 21:04:32  vasilche
* Cleaned main interface headers. Now generated files should include serial/serialimpl.hpp and user code should include serial/serial.hpp which became might lighter.
*
* Revision 1.19  1999/10/04 19:39:45  vasilche
* Fixed bug in CObjectOStreamBinary.
* Start using of BSRead/BSWrite.
* Added ASNCALL macro for prototypes of old ASN.1 functions.
*
* Revision 1.18  1999/10/04 16:22:07  vasilche
* Fixed bug with old ASN.1 structures.
*
* Revision 1.17  1999/09/29 22:36:30  vakatov
* Dont forget to #include ncbistd.hpp before #ifdef HAVE_NCBI_C...
*
* Revision 1.16  1999/09/24 18:55:53  vasilche
* ASN.1 types will not be compiled is we don't have NCBI toolkit.
*
* Revision 1.15  1999/09/24 18:19:12  vasilche
* Removed dependency on NCBI toolkit.
*
* Revision 1.14  1999/09/23 18:56:51  vasilche
* Fixed bugs with overloaded methods in objistr*.hpp & objostr*.hpp
*
* Revision 1.13  1999/09/22 20:11:47  vasilche
* Modified for compilation on IRIX native c++ compiler.
*
* Revision 1.12  1999/09/14 18:54:01  vasilche
* Fixed bugs detected by gcc & egcs.
* Removed unneeded includes.
*
* Revision 1.11  1999/08/16 16:07:42  vasilche
* Added ENUMERATED type.
*
* Revision 1.10  1999/08/13 20:22:56  vasilche
* Fixed lot of bugs in datatool
*
* Revision 1.9  1999/08/13 15:53:42  vasilche
* C++ analog of asntool: datatool
*
* Revision 1.8  1999/07/19 15:50:14  vasilche
* Added interface to old ASN.1 routines.
* Added naming of key/value in STL map.
*
* Revision 1.7  1999/07/14 18:58:02  vasilche
* Fixed ASN.1 types/field naming.
*
* Revision 1.6  1999/07/13 20:18:04  vasilche
* Changed types naming.
*
* Revision 1.5  1999/07/09 16:32:53  vasilche
* Added OCTET STRING write/read.
*
* Revision 1.4  1999/07/07 19:58:43  vasilche
* Reduced amount of data allocated on heap
* Cleaned ASN.1 structures info
*
* Revision 1.3  1999/07/01 17:55:16  vasilche
* Implemented ASN.1 binary write.
*
* Revision 1.2  1999/06/30 18:54:53  vasilche
* Fixed some errors under MSVS
*
* Revision 1.1  1999/06/30 16:04:18  vasilche
* Added support for old ASN.1 structures.
*
* ===========================================================================
*/