shell/inc/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         std::runtime_error(error_msg)
  35     {}
  36
  37 };
  38
  39
  40 //  Simple wrapper around expat, the xml parser library
  41 //  created by James Clark
  42
  43 class i_xml_parser_event_handler;
  44
  45 class xml_parser
  46 {
  47 public:
  48     xml_parser();
  49
  50     ~xml_parser();
  51
  52     /** Parse a XML data stream
  53
  54         @param      pXmlData
  55                     Pointer to a buffer containing the xml data
  56
  57         @param      Length
  58                     Length of the buffer containing the xml data
  59
  60         @param      IsFinal
  61                     Indicates whether these are the last xml data
  62                     of an xml document to parse. For very large
  63                     xml documents it may be useful to read and
  64                     parse the document partially.
  65
  66         @precond    XmlData must not be null
  67
  68         @throws     SaxException
  69                     If the used Sax parser returns an error. The SaxException
  70                     contains detailed information about the error.  */
  71     void parse(const char* XmlData, size_t Length, bool IsFinal);
  72
  73     /** Set a document handler
  74
  75         @descr      A document handler implements the interface i_xml_parser_event_handler.
  76                     The document handler receive notifications of various events
  77                     from the sax parser for instance "start_document".
  78
  79                     The client is responsible for the life time management of
  80                     the given document handler, that means the document handler
  81                     instance must exist until a new one was set or until the parser
  82                     no longer exist.
  83
  84         @param      SaxDocumentHandler
  85                     The new document handler, may be null if not interested in
  86                     sax parser events.
  87
  88         @postcond   currently used document handler == pSaxDocumentHandler  */
  89     void set_document_handler(i_xml_parser_event_handler* event_handler);
  90
  91     /** Returns the currently used document handler or null if
  92         no document handler was set before. */
  93     i_xml_parser_event_handler* get_document_handler() const { return document_handler_;}
  94 private:
  95
  96     void init();
  97
  98 private:
  99     i_xml_parser_event_handler* document_handler_;
 100     XML_Parser const xml_parser_;
 101
 102 private:
 103     xml_parser(const xml_parser&) = delete;
 104     xml_parser& operator=(const xml_parser&) = delete;
 105 };
 106
 107 #endif
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */