shell/inc/internal/xml_parser.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SHELL_INC_INTERNAL_XML_PARSER_HXX
  21 #define INCLUDED_SHELL_INC_INTERNAL_XML_PARSER_HXX
  22
  23 #include <expat.h>
  24 #include <stdexcept>
  25
  26 #include <sal/types.h>
  27
  28 class xml_parser_exception : public std::runtime_error
  29 {
  30 public:
  31
  32     xml_parser_exception(
  33         const std::string& error_msg,
  34         int error_code,
  35         int line_number,
  36         int column_number,
  37         long byte_index) :
  38         std::runtime_error(error_msg),
  39         error_code_(error_code),
  40         line_number_(line_number),
  41         column_number_(column_number),
  42         byte_index_(byte_index)
  43     {}
  44
  45     int  error_code_;
  46     int  line_number_;
  47     int  column_number_;
  48     long byte_index_;
  49 };
  50
  51
  52
  53 //  Simple wrapper around expat, the xml parser library
  54 //  created by James Clark
  55
  56 class i_xml_parser_event_handler;
  57
  58 class xml_parser
  59 {
  60 public:
  61     xml_parser(const XML_Char* EncodingName = 0);
  62
  63     ~xml_parser();
  64
  65     /** Parse a XML data stream
  66
  67         @param      pXmlData
  68                     Pointer to a buffer containing the xml data
  69
  70         @param      Length
  71                     Length of the buffer containing the xml data
  72
  73         @param      IsFinal
  74                     Indicates whether these are the last xml data
  75                     of an xml document to parse. For very large
  76                     xml documents it may be useful to read and
  77                     parse the document partially.
  78
  79         @precond    XmlData must not be null
  80
  81         @throws     SaxException
  82                     If the used Sax parser returns an error. The SaxException
  83                     contains detailed information about the error.  */
  84     void parse(const char* XmlData, size_t Length, bool IsFinal = true);
  85
  86     /** Set a document handler
  87
  88         @descr      A document handler implements the interface i_xml_parser_event_handler.
  89                     The document handler receive notifications of various events
  90                     from the sax parser for instance "start_document".
  91
  92                     The client is responsible for the life time management of
  93                     the given document handler, that means the document handler
  94                     instance must exist until a new one was set or until the parser
  95                     no longer exist.
  96
  97         @param      SaxDocumentHandler
  98                     The new document handler, may be null if not interessted in
  99                     sax parser events.
 100
 101         @postcond   currently used document handler == pSaxDocumentHandler  */
 102     void set_document_handler(i_xml_parser_event_handler* event_handler);
 103
 104     /** Returns the currently used document handler or null if
 105         no document handler was set before. */
 106     i_xml_parser_event_handler* get_document_handler() const { return document_handler_;}
 107 private:
 108
 109     void init();
 110
 111 private:
 112     i_xml_parser_event_handler* document_handler_;
 113     XML_Parser xml_parser_;
 114
 115 private:
 116     xml_parser(const xml_parser&) SAL_DELETED_FUNCTION;
 117     xml_parser& operator=(const xml_parser&) SAL_DELETED_FUNCTION;
 118 };
 119
 120 #endif
 121
 122 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */