hxxml.h
上传用户:zhongxx05
上传日期:2007-06-06
资源大小:33641k
文件大小:15k
源码类别:

Symbian

开发平台:

C/C++

  1. /* ***** BEGIN LICENSE BLOCK ***** 
  2.  * Version: RCSL 1.0/RPSL 1.0 
  3.  *  
  4.  * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
  5.  *      
  6.  * The contents of this file, and the files included with this file, are 
  7.  * subject to the current version of the RealNetworks Public Source License 
  8.  * Version 1.0 (the "RPSL") available at 
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed 
  10.  * the file under the RealNetworks Community Source License Version 1.0 
  11.  * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
  12.  * in which case the RCSL will apply. You may also obtain the license terms 
  13.  * directly from RealNetworks.  You may not use this file except in 
  14.  * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
  15.  * applicable to this file, the RCSL.  Please see the applicable RPSL or 
  16.  * RCSL for the rights, obligations and limitations governing use of the 
  17.  * contents of the file.  
  18.  *  
  19.  * This file is part of the Helix DNA Technology. RealNetworks is the 
  20.  * developer of the Original Code and owns the copyrights in the portions 
  21.  * it created. 
  22.  *  
  23.  * This file, and the files included with this file, is distributed and made 
  24.  * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
  25.  * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
  26.  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
  27.  * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
  28.  * 
  29.  * Technology Compatibility Kit Test Suite(s) Location: 
  30.  *    http://www.helixcommunity.org/content/tck 
  31.  * 
  32.  * Contributor(s): 
  33.  *  
  34.  * ***** END LICENSE BLOCK ***** */ 
  35. #ifndef _HXXML_H_
  36. #define _HXXML_H_
  37. /*
  38.  * Forward declarations of some interfaces defined here-in.
  39.  */
  40. typedef _INTERFACE IHXXMLParserResponse IHXXMLParserResponse;
  41. //$ Private:
  42. typedef _INTERFACE IHXXMLNamespaceParser IHXXMLNamespaceParser;
  43. typedef _INTERFACE IHXXMLNamespaceResponse IHXXMLNamespaceResponse;
  44. //$ EndPrivate.
  45. typedef _INTERFACE IHXBuffer IHXBuffer;
  46. typedef _INTERFACE IHXValues IHXValues;
  47. /****************************************************************************
  48.  * 
  49.  *  Interface:
  50.  * 
  51.  * IHXXMLParser
  52.  * 
  53.  *  Purpose:
  54.  * 
  55.  * XML Parsing object
  56.  * 
  57.  *  IID_IHXXMLParser:
  58.  * 
  59.  * {00002D00-0901-11d1-8B06-00A024406D59}
  60.  * 
  61.  */
  62. DEFINE_GUID(IID_IHXXMLParser, 0x1a39e773, 0xfe28, 0x4ca9, 0x93, 0x18,
  63.             0x9d, 0x21, 0xee, 0x85, 0xe4, 0x7a);
  64. #define CLSID_IHXXMLParser IID_IHXXMLParser
  65. #undef  INTERFACE
  66. #define INTERFACE   IHXXMLParser
  67. DECLARE_INTERFACE_(IHXXMLParser, IUnknown)
  68. {
  69.     /*
  70.      * IUnknown methods
  71.      */
  72.     STDMETHOD(QueryInterface) (THIS_
  73. REFIID riid,
  74. void** ppvObj) PURE;
  75.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  76.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  77.     /*
  78.      * IHXXMLParser methods
  79.      */
  80.     /************************************************************************
  81.      * Method:
  82.      *     IHXXMLParser::Init
  83.      * Purpose:
  84.      *     Initilizes an XML parser with a response object, an encoding (normally
  85.      *     NULL, but can be any supported character encoding string such as 
  86.      *     "Shift_JIS" or "Big5"). The boolean bStrict is set to FALSE if a 'loose'
  87.      *     interpretation of the XML spec is allowed by the client; this includes
  88.      *     tag/attribute case insensitivity
  89.      *
  90.      *  commonly supported encodings:
  91.      *     "Default"   (assumes DBCS; any non-ASCII char is a lead byte)
  92.      *     "US-ASCII"
  93.      *     "Shift-JIS"
  94.      *     "Big5"
  95.      *     "GB2312"
  96.      *     "EUC-KR"
  97.      *     "ISO-2022-KR"
  98.      *     "ISO-8859-1"
  99.      *
  100.      * NOTE: it's usually pretty safe to report NULL for the encoding, unless
  101.      *     you have a specific character encoding to use.
  102.      */
  103.     STDMETHOD(Init) (THIS_
  104. IHXXMLParserResponse* /*IN*/  pResponse,
  105. const char*     /*IN*/ pEncoding,
  106. BOOL     /*IN*/ bStrict) PURE;
  107.     /************************************************************************
  108.      * Method:
  109.      *     IHXXMLParser::Close
  110.      * Purpose:
  111.      *     Releases all resources associated with the object.
  112.      *
  113.      */
  114.     STDMETHOD(Close) (THIS) PURE;
  115.     /************************************************************************
  116.      * Method:
  117.      *     IHXXMLParser::Parse
  118.      * Purpose:
  119.      *     Parse the buffer calling any IHXXMLParserResponse methods as various
  120.      *     XML entities are parsed. The boolean bIsFinal should be set to TRUE
  121.      *     when the last buffer to parse is passed to this method.
  122.      *
  123.      */
  124.     STDMETHOD(Parse) (THIS_
  125. IHXBuffer* /*IN*/     pBuffer,
  126. BOOL /*IN*/     bIsFinal) PURE;
  127.     /************************************************************************
  128.      * Method:
  129.      *     IHXXMLParser::GetCurrentLineNumber
  130.      * Purpose:
  131.      *     Returns the line number at which the parser's internal cursor is 
  132.      *     positioned.
  133.      *
  134.      */
  135.     STDMETHOD(GetCurrentLineNumber) (THIS_
  136. REF(ULONG32) /*OUT*/ ulLineNumber) PURE;
  137.     /************************************************************************
  138.      * Method:
  139.      *     IHXXMLParser::GetCurrentColumnNumber
  140.      * Purpose:
  141.      *     Returns the column number at which the parser's internal cursor is
  142.      *
  143.      */
  144.     STDMETHOD(GetCurrentColumnNumber) (THIS_
  145. REF(ULONG32) /*OUT*/ ulColumnNumber) PURE;
  146.     /************************************************************************
  147.      * Method:
  148.      *     IHXXMLParser::GetCurrentByteIndex
  149.      * Purpose:
  150.      *     Returns the byte index at which the parser's internal cursor is
  151.      *
  152.      */
  153.     STDMETHOD(GetCurrentByteIndex) (THIS_
  154. REF(ULONG32) /*OUT*/ ulByteIndex) PURE;
  155.     /************************************************************************
  156.      * Method:
  157.      *     IHXXMLParser::GetCurrentErrorText
  158.      * Purpose:
  159.      *     Returns the text of the last error 
  160.      *
  161.      */
  162.     STDMETHOD(GetCurrentErrorText) (THIS_
  163. REF(IHXBuffer*) /*OUT*/ pBuffer) PURE;
  164. };
  165. /****************************************************************************
  166.  * 
  167.  *  Interface:
  168.  * 
  169.  * IHXXMLParserResponse
  170.  * 
  171.  *  Purpose:
  172.  * 
  173.  * XML Parsing response object
  174.  * 
  175.  *  IID_IHXXMLParserResponse:
  176.  * 
  177.  * {00002D01-0901-11d1-8B06-00A024406D59}
  178.  * 
  179.  */
  180. DEFINE_GUID(IID_IHXXMLParserResponse, 0x00002D01, 0x901, 0x11d1, 
  181.     0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  182. #undef  INTERFACE
  183. #define INTERFACE   IHXXMLParserResponse
  184. DECLARE_INTERFACE_(IHXXMLParserResponse, IUnknown)
  185. {
  186.     /*
  187.      * IUnknown methods
  188.      */
  189.     STDMETHOD(QueryInterface) (THIS_
  190. REFIID riid,
  191. void** ppvObj) PURE;
  192.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  193.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  194.     /*
  195.      * IHXXMLParserResponse methods
  196.      */
  197.     /************************************************************************
  198.      * Method:
  199.      *     IHXXMLParser::HandleStartElement
  200.      * Purpose:
  201.      *     Called with a start tag (<tag a="foo" b="bar">)
  202.      *     Line/column numbers are for the start of the entity
  203.      */
  204.     STDMETHOD(HandleStartElement) (THIS_
  205. const char* /*IN*/ pName,
  206. IHXValues* /*IN*/ pAttributes,
  207. UINT32 /*IN*/ ulLineNumber,
  208. UINT32 /*IN*/ ulColumnNumber) PURE;
  209.     /************************************************************************
  210.      * Method:
  211.      *     IHXXMLParser::HandleEndElement
  212.      * Purpose:
  213.      *     Called with an end tag (</tag>)
  214.      *     Line/column numbers are for the start of the entity
  215.      */
  216.     STDMETHOD(HandleEndElement) (THIS_
  217. const char* /*IN*/ pName,
  218. UINT32 /*IN*/ ulLineNumber,
  219. UINT32 /*IN*/ ulColumnNumber) PURE;
  220.     /************************************************************************
  221.      * Method:
  222.      *     IHXXMLParser::HandleCharacterData
  223.      * Purpose:
  224.      *     Called with stuff outside of tags
  225.      *     Line/column numbers are for the start of the entity
  226.      */
  227.     STDMETHOD(HandleCharacterData) (THIS_
  228. IHXBuffer* /*IN*/ pBuffer,
  229. UINT32 /*IN*/ ulLineNumber,
  230. UINT32 /*IN*/ ulColumnNumber) PURE;
  231.     /************************************************************************
  232.      * Method:
  233.      *     IHXXMLParser::HandleProcessingInstruction
  234.      * Purpose:
  235.      *     Called with processing instruction (<?foobar flotz="fred" glootz="mary"?>)
  236.      *     Line/column numbers are for the start of the entity
  237.      */
  238.     STDMETHOD(HandleProcessingInstruction)  (THIS_
  239.     const char* /*IN*/  pTarget,
  240.     IHXValues* /*IN*/  pAttributes,
  241.     UINT32 /*IN*/ ulLineNumber,
  242.     UINT32 /*IN*/ ulColumnNumber) PURE;
  243.     /************************************************************************
  244.      * Method:
  245.      *     IHXXMLParser::HandleUnparsedEntityDecl
  246.      * Purpose:
  247.      *     Called with entity info (<!ENTITY hatch-pic SYSTEM "../grafix/OpenHatch.gif" 
  248.      * NDATA gif>)
  249.      *     Line/column numbers are for the start of the entity
  250.      */
  251.     STDMETHOD(HandleUnparsedEntityDecl)     (THIS_
  252.     const char* /*IN*/  pEntityName,
  253.     const char* /*IN*/  pSystemID,
  254.     const char* /*IN*/  pPublicID,
  255.     const char* /*IN*/  pNotationName,
  256.     UINT32 /*IN*/ ulLineNumber,
  257.     UINT32 /*IN*/ ulColumnNumber) PURE;
  258.     /************************************************************************
  259.      * Method:
  260.      *     IHXXMLParser::HandleNotationDecl
  261.      * Purpose:
  262.      *     Called with notation info (<!NOTATION gif PUBLIC "http://www.gif.com/gif.not">)
  263.      *     Line/column numbers are for the start of the entity
  264.      *
  265.      */
  266.     STDMETHOD(HandleNotationDecl)     (THIS_
  267.     const char* /*IN*/  pNotationName,
  268.     const char* /*IN*/  pSystemID,
  269.     const char* /*IN*/  pPublicID,
  270.     UINT32 /*IN*/ ulLineNumber,
  271.     UINT32 /*IN*/ ulColumNumber) PURE;
  272.     /************************************************************************
  273.      * Method:
  274.      *     IHXXMLParser::HandleComment
  275.      * Purpose:
  276.      *     Called with comment info (<!-- this is a comment -->)
  277.      *     Line/column numbers are for the start of the entity
  278.      *
  279.      */
  280.     STDMETHOD(HandleComment)     (THIS_
  281.     const char* /*IN*/  pComment,
  282.     UINT32 /*IN*/ ulLineNumber,
  283.     UINT32 /*IN*/ ulColumnNumber) PURE;
  284.     /************************************************************************
  285.      * Method:
  286.      *     IHXXMLParser::HandleUnparsedDoctypeDecl
  287.      * Purpose:
  288.      *     Called with declaration info (<!DOCTYPE foo SYSTEM "foo.dtd">)
  289.      *     Line/column numbers are for the start of the entity
  290.      *
  291.      */
  292.     STDMETHOD(HandleUnparsedDoctypeDecl)   (THIS_
  293.     const char* /*IN*/  pDoctype,
  294.     const char* /*IN*/  pSystemID,
  295.     const char* /*IN*/  pPublicID,
  296.     UINT32 /*IN*/ ulLineNumber,
  297.     UINT32 /*IN*/ ulColumnNumber) PURE;
  298.     /************************************************************************
  299.      * Method:
  300.      *     IHXXMLParser::HandleDefault
  301.      * Purpose:
  302.      *     Called with unhandled entitiy data
  303.      *     Line/column numbers are for the start of the entity
  304.      *
  305.      */
  306.     STDMETHOD(HandleDefault)     (THIS_
  307.     IHXBuffer* /*IN*/ pBuffer,
  308.     UINT32 /*IN*/ ulLineNumber,
  309.     UINT32 /*IN*/ ulColumnNumber) PURE;
  310. };
  311. //$ Private:
  312. /****************************************************************************
  313.  * 
  314.  *  Interface:
  315.  * 
  316.  * IHXXMLNamespaceParser
  317.  * 
  318.  *  Purpose:
  319.  * 
  320.  * Extended XML Parsing to support Namespaces
  321.  * 
  322.  *  IID_IHXXMLNamespaceParser:
  323.  * 
  324.  * {00002D02-0901-11d1-8B06-00A024406D59}
  325.  * 
  326.  */
  327. DEFINE_GUID(IID_IHXXMLNamespaceParser, 0x00002D02, 0x901, 0x11d1, 
  328.     0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  329. #undef  INTERFACE
  330. #define INTERFACE   IHXXMLNamespaceParser
  331. DECLARE_INTERFACE_(IHXXMLNamespaceParser, IUnknown)
  332. {
  333.     /*
  334.      * IUnknown methods
  335.      */
  336.     STDMETHOD(QueryInterface) (THIS_
  337. REFIID riid,
  338. void** ppvObj) PURE;
  339.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  340.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  341.     /*
  342.      * IHXXMLNamespaceParser methods
  343.      */
  344.     
  345.     /************************************************************************
  346.      * Method:
  347.      *     IHXXMLParser::Init
  348.      * Purpose:
  349.      *     Initilizes an XML parser with a response object, an encoding (normally
  350.      *     NULL, but can be any supported character encoding string such as 
  351.      *     "Shift_JIS" or "Big5"). The boolean bStrict is set to FALSE if a 'loose'
  352.      *     interpretation of the XML spec is allowed by the client; this includes
  353.      *     tag/attribute case insensitivity
  354.      */
  355.     STDMETHOD(InitNamespaceParser) (THIS_
  356. IHXXMLParserResponse* /*IN*/  pResponse,
  357. IHXXMLNamespaceResponse* /*IN*/pNSResp,
  358. const char*     /*IN*/ pEncoding,
  359. const char     /*IN*/ cSepChar) PURE;
  360.     STDMETHOD_(char, GetSepChar) (THIS) PURE;
  361. };
  362. /****************************************************************************
  363.  * 
  364.  *  Interface:
  365.  * 
  366.  * IHXXMLNamespaceResponse
  367.  * 
  368.  *  Purpose:
  369.  * 
  370.  * Namespace response object
  371.  * 
  372.  *  IID_IHXXMLNamespaceResponse:
  373.  * 
  374.  * {00002D03-0901-11d1-8B06-00A024406D59}
  375.  *
  376.  */ 
  377. DEFINE_GUID(IID_IHXXMLNamespaceResponse, 0x00002D03, 0x901, 0x11d1, 
  378.     0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  379. #undef  INTERFACE
  380. #define INTERFACE   IHXXMLNamespaceResponse
  381. DECLARE_INTERFACE_(IHXXMLNamespaceResponse, IUnknown)
  382. {
  383.     /*
  384.      * IUnknown methods
  385.      */
  386.     STDMETHOD(QueryInterface) (THIS_
  387. REFIID riid,
  388. void** ppvObj) PURE;
  389.     STDMETHOD_(ULONG32,AddRef) (THIS) PURE;
  390.     STDMETHOD_(ULONG32,Release) (THIS) PURE;
  391.     /*
  392.      * IHXXMLNamespaceResponse methods
  393.      */
  394.     /************************************************************************
  395.      * Method:
  396.      *     IHXXMLNamespaceResponse::HandleStartNamespaceDecl
  397.      * Purpose:
  398.      *     Called with xmlns:prefix="uri" or xmlns="uri" when it enters
  399.      *     scope before the tag in which it was declared
  400.      */
  401.     STDMETHOD(HandleStartNamespaceDecl) (THIS_
  402. const char* /*IN*/ pPrefix,
  403. const char* /*IN*/ pURI) PURE;
  404.     /************************************************************************
  405.      * Method:
  406.      *     IHXXMLParser::HandleEndElement
  407.      * Purpose:
  408.      *     Called when the namespace leaves scope.
  409.      */
  410.     STDMETHOD(HandleEndNamespaceDecl) (THIS_
  411.       const char* pPrefix) PURE;
  412. };
  413. //$ EndPrivate.
  414. #endif /* _HXXML_H_ */