hxxml.h
上传用户:dangjiwu
上传日期:2013-07-19
资源大小:42019k
文件大小:15k
源码类别:

Symbian

开发平台:

Visual C++

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