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

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

生物技术

开发平台：

C/C++

objostrxml.hpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: objostrxml.hpp,v $
  4.  * PRODUCTION Revision 1000.2  2004/04/12 17:15:24  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.38
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. #ifndef OBJOSTRXML__HPP
  11. #define OBJOSTRXML__HPP
  13. /*  $Id: objostrxml.hpp,v 1000.2 2004/04/12 17:15:24 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. *   XML objects output stream
  42. */
  44. #include <corelib/ncbistd.hpp>
  45. #include <serial/objostr.hpp>
  46. #include <stack>
  49. /** @addtogroup ObjStreamSupport
  50.  *
  51.  * @{
  52.  */
  55. BEGIN_NCBI_SCOPE
  57. class NCBI_XSERIAL_EXPORT CObjectOStreamXml : public CObjectOStream
  58. {
  59. public:
  60.     CObjectOStreamXml(CNcbiOstream& out, bool deleteOut);
  61.     virtual ~CObjectOStreamXml(void);
  63.     virtual string GetPosition(void) const;
  65.     enum EEncoding {
  66.         eEncoding_Unknown,
  67.         eEncoding_UTF8,
  68.         eEncoding_ISO8859_1,
  69.         eEncoding_Windows_1252
  70.     };
  71.     void SetEncoding(EEncoding enc);
  72.     EEncoding GetEncoding(void) const;
  74.     void SetReferenceSchema(bool use_schema = true);
  75.     bool GetReferenceSchema(void) const;
  76.     void SetReferenceDTD(bool use_dtd = true);
  77.     bool GetReferenceDTD(void) const;
  79.     void SetUseSchemaLocation(bool use_loc = true);
  80.     bool GetUseSchemaLocation(void) const;
  82.     static void   SetDefaultSchemaNamespace(const string& schema_ns);
  83.     static string GetDefaultSchemaNamespace(void);
  85.     virtual void WriteFileHeader(TTypeInfo type);
  87.     // DTD file name and prefix. The final module name is built as
  88.     // DTDFilePrefix + DTDFileName.
  90.     // If "DTDFilePrefix" has never been set for this stream, then
  91.     // the global "DefaultDTDFilePrefix" will be used.
  92.     // If it has been set to any value (including empty string), then
  93.     // that value will be used.
  94.     void   SetDTDFilePrefix(const string& prefix);
  95.     string GetDTDFilePrefix(void) const;
  97.     // Default (global) DTD file prefix.
  98.     static void   SetDefaultDTDFilePrefix(const string& prefix);
  99.     static string GetDefaultDTDFilePrefix(void);
  101.     // If "DTDFileName" is not set or set to empty string for this stream,
  102.     // then type name will be used as the file name.
  103.     void   SetDTDFileName(const string& filename);
  104.     string GetDTDFileName(void) const;
  106.     // Enable/disable DTD public identifier.
  107.     // If disabled (it is ENABLED by default), only system identifier
  108.     // will be written in the output XML stream
  109.     void EnableDTDPublicId(void);
  110.     void DisableDTDPublicId(void);
  111.     // DTD public identifier. If set to non-empty string, the stream will
  112.     // write this in the output XML file. Otherwise the "default" public id
  113.     // will be generated
  114.     void SetDTDPublicId(const string& publicId);
  115.     string GetDTDPublicId(void) const;
  117.     enum ERealValueFormat {
  118.         eRealFixedFormat,
  119.         eRealScientificFormat
  120.     };
  121.     ERealValueFormat GetRealValueFormat(void) const;
  122.     void SetRealValueFormat(ERealValueFormat fmt);
  123.     void SetEnforcedStdXml(bool set = true);
  124.     bool GetEnforcedStdXml(void)     {return m_EnforcedStdXml;}
  126. protected:
  127.     virtual void WriteBool(bool data);
  128.     virtual void WriteChar(char data);
  129.     virtual void WriteInt4(Int4 data);
  130.     virtual void WriteUint4(Uint4 data);
  131.     virtual void WriteInt8(Int8 data);
  132.     virtual void WriteUint8(Uint8 data);
  133.     virtual void WriteFloat(float data);
  134.     virtual void WriteDouble(double data);
  135.     void WriteDouble2(double data, size_t digits);
  136.     virtual void WriteCString(const char* str);
  137.     virtual void WriteString(const string& s,
  138.                              EStringType type = eStringTypeVisible);
  139.     virtual void WriteStringStore(const string& s);
  140.     virtual void CopyString(CObjectIStream& in);
  141.     virtual void CopyStringStore(CObjectIStream& in);
  143.     virtual void WriteNullPointer(void);
  144.     virtual void WriteObjectReference(TObjectIndex index);
  145.     virtual void WriteOtherBegin(TTypeInfo typeInfo);
  146.     virtual void WriteOtherEnd(TTypeInfo typeInfo);
  147.     virtual void WriteOther(TConstObjectPtr object, TTypeInfo typeInfo);
  148.     void WriteId(const string& str);
  150.     void WriteNull(void);
  151.     virtual void WriteAnyContentObject(const CAnyContentObject& obj);
  152.     virtual void CopyAnyContentObject(CObjectIStream& in);
  154.     void WriteEscapedChar(char c);
  156.     virtual void WriteEnum(const CEnumeratedTypeValues& values,
  157.                            TEnumValueType value);
  158.     virtual void CopyEnum(const CEnumeratedTypeValues& values,
  159.                           CObjectIStream& in);
  160.     void WriteEnum(const CEnumeratedTypeValues& values,
  161.                    TEnumValueType value, const string& valueName);
  163. #ifdef VIRTUAL_MID_LEVEL_IO
  164.     virtual void WriteNamedType(TTypeInfo namedTypeInfo,
  165.                                 TTypeInfo typeInfo, TConstObjectPtr object);
  166.     virtual void CopyNamedType(TTypeInfo namedTypeInfo,
  167.                                TTypeInfo typeInfo,
  168.                                CObjectStreamCopier& copier);
  170.     virtual void WriteContainer(const CContainerTypeInfo* containerType,
  171.                                 TConstObjectPtr containerPtr);
  172.     void WriteContainerContents(const CContainerTypeInfo* containerType,
  173.                                 TConstObjectPtr containerPtr);
  175.     virtual void WriteClass(const CClassTypeInfo* objectType,
  176.                             TConstObjectPtr objectPtr);
  177.     virtual void WriteClassMember(const CMemberId& memberId,
  178.                                   TTypeInfo memberType,
  179.                                   TConstObjectPtr memberPtr);
  180.     virtual bool WriteClassMember(const CMemberId& memberId,
  181.                                   const CDelayBuffer& buffer);
  183.     virtual void WriteChoice(const CChoiceTypeInfo* choiceType,
  184.                              TConstObjectPtr choicePtr);
  185.     void WriteChoiceContents(const CChoiceTypeInfo* choiceType,
  186.                              TConstObjectPtr choicePtr);
  187. /*
  188.     // COPY
  189.     virtual void CopyNamedType(TTypeInfo namedTypeInfo,
  190.                                TTypeInfo typeInfo,
  191.                                CObjectStreamCopier& copier);
  192.     virtual void CopyContainer(const CContainerTypeInfo* containerType,
  193.                                CObjectStreamCopier& copier);
  194.     virtual void CopyClassRandom(const CClassTypeInfo* objectType,
  195.                                  CObjectStreamCopier& copier);
  196.     virtual void CopyClassSequential(const CClassTypeInfo* objectType,
  197.                                      CObjectStreamCopier& copier);
  198.     virtual void CopyChoice(const CChoiceTypeInfo* choiceType,
  199.                             CObjectStreamCopier& copier);
  200. */
  201. #endif
  202.     // low level I/O
  203.     virtual void BeginNamedType(TTypeInfo namedTypeInfo);
  204.     virtual void EndNamedType(void);
  206.     virtual void BeginContainer(const CContainerTypeInfo* containerType);
  207.     virtual void EndContainer(void);
  208.     virtual void BeginContainerElement(TTypeInfo elementType);
  209.     virtual void EndContainerElement(void);
  210.     void BeginArrayElement(TTypeInfo elementType);
  211.     void EndArrayElement(void);
  213.     void CheckStdXml(const CClassTypeInfoBase* classType);
  214.     ETypeFamily GetRealTypeFamily(TTypeInfo typeInfo);
  215.     ETypeFamily GetContainerElementTypeFamily(TTypeInfo typeInfo);
  217.     virtual void BeginClass(const CClassTypeInfo* classInfo);
  218.     virtual void EndClass(void);
  219.     virtual void BeginClassMember(const CMemberId& id);
  220.     void BeginClassMember(TTypeInfo memberType,
  221.                           const CMemberId& id);
  222.     virtual void EndClassMember(void);
  224.     virtual void BeginChoice(const CChoiceTypeInfo* choiceType);
  225.     virtual void EndChoice(void);
  226.     virtual void BeginChoiceVariant(const CChoiceTypeInfo* choiceType,
  227.                                     const CMemberId& id);
  228.     virtual void EndChoiceVariant(void);
  230.     virtual void WriteBytes(const ByteBlock& block,
  231.                             const char* bytes, size_t length);
  232.     virtual void WriteChars(const CharBlock& block,
  233.                             const char* chars, size_t length);
  235.     // Write current separator to the stream
  236.     virtual void WriteSeparator(void);
  238. #if defined(NCBI_SERIAL_IO_TRACE)
  239.     void TraceTag(const string& name);
  240. #endif
  242. private:
  243.     void WriteString(const char* str, size_t length);
  245.     void OpenTagStart(void);
  246.     void OpenTagEnd(void);
  247.     void OpenTagEndBack(void);
  248.     void SelfCloseTagEnd(void);
  249.     void CloseTagStart(void);
  250.     void CloseTagEnd(void);
  252.     void WriteTag(const string& name);
  253.     void OpenTag(const string& name);
  254.     void EolIfEmptyTag(void);
  255.     void CloseTag(const string& name);
  256.     void OpenStackTag(size_t level);
  257.     void CloseStackTag(size_t level);
  258.     void OpenTag(TTypeInfo type);
  259.     void CloseTag(TTypeInfo type);
  260.     void OpenTagIfNamed(TTypeInfo type);
  261.     void CloseTagIfNamed(TTypeInfo type);
  262.     void PrintTagName(size_t level);
  263.     bool WillHaveName(TTypeInfo elementType);
  264.     string GetModuleName(TTypeInfo type);
  265.     bool x_IsStdXml(void) {return m_StdXml || m_EnforcedStdXml;}
  267.     void x_WriteClassNamespace(TTypeInfo type);
  268.     bool x_ProcessTypeNamespace(TTypeInfo type);
  269.     void x_EndTypeNamespace(void);
  270.     bool x_BeginNamespace(const string& ns_name, const string& ns_prefix);
  271.     void x_EndNamespace(const string& ns_name);
  273.     enum ETagAction {
  274.         eTagOpen,
  275.         eTagClose,
  276.         eTagSelfClosed,
  277.         eAttlistTag
  278.     };
  279.     ETagAction m_LastTagAction;
  280.     bool m_EndTag;
  282.     // DTD file name and prefix
  283.     bool   m_UseDefaultDTDFilePrefix;
  284.     string m_DTDFilePrefix;
  285.     string m_DTDFileName;
  286.     bool   m_UsePublicId;
  287.     string m_PublicId;
  288.     static string sm_DefaultDTDFilePrefix;
  289.     bool m_Attlist;
  290.     bool m_StdXml;
  291.     bool m_EnforcedStdXml;
  292.     ERealValueFormat m_RealFmt;
  293.     EEncoding m_Encoding;
  294.     bool m_UseSchemaRef;
  295.     bool m_UseSchemaLoc;
  296.     bool m_UseDTDRef;
  297.     static string sm_DefaultSchemaNamespace;
  298.     string m_CurrNsPrefix;
  299.     map<string,string> m_NsNameToPrefix;
  300.     map<string,string> m_NsPrefixToName;
  301.     stack<string> m_NsPrefixes;
  302. };
  305. /* @} */
  308. #include <serial/objostrxml.inl>
  310. END_NCBI_SCOPE
  312. #endif
  316. /* ---------------------------------------------------------------------------
  317. * $Log: objostrxml.hpp,v $
  318. * Revision 1000.2  2004/04/12 17:15:24  gouriano
  319. * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.38
  320. *
  321. * Revision 1.38  2004/01/08 17:42:34  gouriano
  322. * Added encoding Windows-1252.
  323. * Made it possible to omit document type declaration
  324. *
  325. * Revision 1.37  2003/11/26 19:59:39  vasilche
  326. * GetPosition() and GetDataFormat() methods now are implemented
  327. * in parent classes CObjectIStream and CObjectOStream to avoid
  328. * pure virtual method call in destructors.
  329. *
  330. * Revision 1.36  2003/09/16 14:49:15  gouriano
  331. * Enhanced AnyContent objects to support XML namespaces and attribute info items.
  332. *
  333. * Revision 1.35  2003/08/25 15:58:32  gouriano
  334. * added possibility to use namespaces in XML i/o streams
  335. *
  336. * Revision 1.34  2003/08/13 15:47:02  gouriano
  337. * implemented serialization of AnyContent objects
  338. *
  339. * Revision 1.33  2003/07/02 13:01:00  gouriano
  340. * added ability to read/write XML files with reference to schema
  341. *
  342. * Revision 1.32  2003/06/30 15:40:18  gouriano
  343. * added encoding (utf-8 or iso-8859-1)
  344. *
  345. * Revision 1.31  2003/05/22 20:08:42  gouriano
  346. * added UTF8 strings
  347. *
  348. * Revision 1.30  2003/04/15 16:18:32  siyan
  349. * Added doxygen support
  350. *
  351. * Revision 1.29  2003/03/26 16:13:33  vasilche
  352. * Removed TAB symbols. Some formatting.
  353. *
  354. * Revision 1.28  2003/02/05 17:08:51  gouriano
  355. * added possibility to read/write objects generated from an ASN.1 spec as "standard" XML - without scope prefixes
  356. *
  357. * Revision 1.27  2003/01/22 20:51:10  gouriano
  358. * more control on how a float value is to be written
  359. *
  360. * Revision 1.26  2003/01/10 16:53:36  gouriano
  361. * fixed a bug with optional class members
  362. *
  363. * Revision 1.25  2002/12/26 19:33:06  gouriano
  364. * changed XML I/O streams to properly handle object copying
  365. *
  366. * Revision 1.24  2002/12/23 18:38:51  dicuccio
  367. * Added WIn32 export specifier: NCBI_XSERIAL_EXPORT.
  368. * Moved all CVS logs to the end.
  369. *
  370. * Revision 1.23  2002/12/12 21:10:26  gouriano
  371. * implemented handling of complex XML containers
  372. *
  373. * Revision 1.22  2002/11/14 20:52:55  gouriano
  374. * added support of attribute lists
  375. *
  376. * Revision 1.21  2002/10/18 14:25:52  gouriano
  377. * added possibility to enable/disable/set public identifier
  378. *
  379. * Revision 1.20  2002/03/07 22:02:00  grichenk
  380. * Added "Separator" modifier for CObjectOStream
  381. *
  382. * Revision 1.19  2001/11/09 19:07:22  grichenk
  383. * Fixed DTDFilePrefix functions
  384. *
  385. * Revision 1.18  2001/10/17 20:41:20  grichenk
  386. * Added CObjectOStream::CharBlock class
  387. *
  388. * Revision 1.17  2001/10/17 18:18:28  grichenk
  389. * Added CObjectOStreamXml::xxxFilePrefix() and
  390. * CObjectOStreamXml::xxxFileName()
  391. *
  392. * Revision 1.16  2001/05/17 14:59:47  lavr
  393. * Typos corrected
  394. *
  395. * Revision 1.15  2001/04/13 14:57:21  kholodov
  396. * Added: SetDTDFileName function to set DTD module name in XML header
  397. *
  398. * Revision 1.14  2000/12/15 21:28:48  vasilche
  399. * Moved some typedefs/enums from corelib/ncbistd.hpp.
  400. * Added flags to CObjectIStream/CObjectOStream: eFlagAllowNonAsciiChars.
  401. * TByte typedef replaced by Uint1.
  402. *
  403. * Revision 1.13  2000/12/15 15:38:01  vasilche
  404. * Added support of Int8 and long double.
  405. * Enum values now have type Int4 instead of long.
  406. *
  407. * Revision 1.12  2000/11/07 17:25:12  vasilche
  408. * Fixed encoding of XML:
  409. *     removed unnecessary apostrophes in OCTET STRING
  410. *     removed unnecessary content in NULL
  411. * Added module names to CTypeInfo and CEnumeratedTypeValues
  412. *
  413. * Revision 1.11  2000/10/20 15:51:27  vasilche
  414. * Fixed data error processing.
  415. * Added interface for constructing container objects directly into output stream.
  416. * object.hpp, object.inl and object.cpp were split to
  417. * objectinfo.*, objecttype.*, objectiter.* and objectio.*.
  418. *
  419. * Revision 1.10  2000/10/04 19:18:54  vasilche
  420. * Fixed processing floating point data.
  421. *
  422. * Revision 1.9  2000/09/29 16:18:15  vasilche
  423. * Fixed binary format encoding/decoding on 64 bit compulers.
  424. * Implemented CWeakMap<> for automatic cleaning map entries.
  425. * Added cleaning local hooks via CWeakMap<>.
  426. * Renamed ReadTypeName -> ReadFileHeader, ENoTypeName -> ENoFileHeader.
  427. * Added some user interface methods to CObjectIStream, CObjectOStream and
  428. * CObjectStreamCopier.
  429. *
  430. * Revision 1.8  2000/09/18 20:00:07  vasilche
  431. * Separated CVariantInfo and CMemberInfo.
  432. * Implemented copy hooks.
  433. * All hooks now are stored in CTypeInfo/CMemberInfo/CVariantInfo.
  434. * Most type specific functions now are implemented via function pointers instead of virtual functions.
  435. *
  436. * Revision 1.7  2000/09/01 13:16:02  vasilche
  437. * Implemented class/container/choice iterators.
  438. * Implemented CObjectStreamCopier for copying data without loading into memory.
  439. *
  440. * Revision 1.6  2000/08/15 19:44:41  vasilche
  441. * Added Read/Write hooks:
  442. * CReadObjectHook/CWriteObjectHook for objects of specified type.
  443. * CReadClassMemberHook/CWriteClassMemberHook for specified members.
  444. * CReadChoiceVariantHook/CWriteChoiceVariant for specified choice variants.
  445. * CReadContainerElementHook/CWriteContainerElementsHook for containers.
  446. *
  447. * Revision 1.5  2000/07/03 18:42:36  vasilche
  448. * Added interface to typeinfo via CObjectInfo and CConstObjectInfo.
  449. * Reduced header dependency.
  450. *
  451. * Revision 1.4  2000/06/16 16:31:07  vasilche
  452. * Changed implementation of choices and classes info to allow use of the same classes in generated and user written classes.
  453. *
  454. * Revision 1.3  2000/06/07 19:45:44  vasilche
  455. * Some code cleaning.
  456. * Macros renaming in more clear way.
  457. * BEGIN_NAMED_*_INFO, ADD_*_MEMBER, ADD_NAMED_*_MEMBER.
  458. *
  459. * Revision 1.2  2000/06/01 19:06:58  vasilche
  460. * Added parsing of XML data.
  461. *
  462. * Revision 1.1  2000/05/24 20:08:14  vasilche
  463. * Implemented XML dump.
  464. *
  465. * ===========================================================================
  466. */