shell/inc/internal/xml_parser.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: xml_parser.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _XML_PARSER_HXX_
  32 #define _XML_PARSER_HXX_
  33
  34 #ifdef SYSTEM_EXPAT
  35 #include <expat.h>
  36 #else
  37 #include <external/expat/xmlparse.h>
  38 #endif
  39 #include <stdexcept>
  40
  41 //-----------------------------------------------------
  42 class xml_parser_exception : public std::runtime_error
  43 {
  44 public:
  45
  46     xml_parser_exception(
  47         const std::string& error_msg,
  48         int error_code,
  49         int line_number,
  50         int column_number,
  51         long byte_index) :
  52         std::runtime_error(error_msg),
  53         error_code_(error_code),
  54         line_number_(line_number),
  55         column_number_(column_number),
  56         byte_index_(byte_index)
  57     {}
  58
  59     int  error_code_;
  60     int  line_number_;
  61     int  column_number_;
  62     long byte_index_;
  63 };
  64
  65
  66 //-----------------------------------------------------
  67 //      Simple wrapper around expat, the xml parser library
  68 //      created by James Clark
  69 //-----------------------------------------------------
  70 class i_xml_parser_event_handler;
  71
  72 class xml_parser
  73 {
  74 public:
  75     //########################################################
  76     xml_parser(const XML_Char* EncodingName = 0);
  77
  78     //########################################################
  79     xml_parser(const XML_Char* EncodingName, XML_Char NamespaceSeparator);
  80
  81     //########################################################
  82     ~xml_parser();
  83
  84     //########################################################
  85     /** Parse a XML data stream
  86
  87         @param          pXmlData
  88                     Pointer to a buffer containing the xml data
  89
  90         @param          Length
  91                     Length of the buffer containing the xml data
  92
  93         @param          IsFinal
  94                     Indicates whether these are the last xml data
  95                     of an xml document to parse. For very large
  96                     xml documents it may be usefull to read and
  97                     parse the document partially.
  98
  99         @precond        XmlData must not be null
 100
 101         @throws         SaxException
 102                     If the used Sax parser returns an error. The SaxException
 103                     contains detailed information about the error.      */
 104     void parse(const char* XmlData, size_t Length, bool IsFinal = true);
 105
 106     //########################################################
 107     /** Set a document handler
 108
 109         @descr          A document handler implements the interface i_xml_parser_event_handler.
 110                     The document handler receive notifications of various events
 111                     from the sax parser for instance "start_document".
 112
 113                     The client is responsible for the life time management of
 114                     the given document handler, that means the document handler
 115                     instance must exist until a new one was set or until the parser
 116                     no longer exist.
 117
 118         @param          SaxDocumentHandler
 119                     The new document handler, may be null if not interessted in
 120                     sax parser events.
 121
 122         @postcond       currently used document handler == pSaxDocumentHandler  */
 123     void set_document_handler(i_xml_parser_event_handler* event_handler);
 124
 125     //########################################################
 126     /** Returns the currently used document handler or null if
 127         no document handler was set before.     */
 128     i_xml_parser_event_handler* get_document_handler() const;
 129
 130     //############################################
 131     void set_encoding(const XML_Char* Encoding);
 132
 133 private:
 134
 135     void init();
 136
 137 private:
 138     i_xml_parser_event_handler* document_handler_;
 139     XML_Parser xml_parser_;
 140
 141 // prevent copy and assignment
 142 private:
 143     xml_parser(const xml_parser&);
 144     xml_parser& operator=(const xml_parser&);
 145 };
 146
 147 #endif
 148