diff options
Diffstat (limited to 'shell/inc/xml_parser.hxx')
-rw-r--r-- | shell/inc/xml_parser.hxx | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/shell/inc/xml_parser.hxx b/shell/inc/xml_parser.hxx new file mode 100644 index 0000000000..e07c860dd6 --- /dev/null +++ b/shell/inc/xml_parser.hxx @@ -0,0 +1,104 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef INCLUDED_SHELL_INC_INTERNAL_XML_PARSER_HXX +#define INCLUDED_SHELL_INC_INTERNAL_XML_PARSER_HXX + +#include <expat.h> +#include <stdexcept> + +class xml_parser_exception final : public std::runtime_error +{ +public: + xml_parser_exception(const std::string& error_msg) + : std::runtime_error(error_msg) + { + } +}; + +// Simple wrapper around expat, the xml parser library +// created by James Clark + +class i_xml_parser_event_handler; + +class xml_parser +{ +public: + xml_parser(); + + ~xml_parser(); + + /** Parse a XML data stream + + @param pXmlData + Pointer to a buffer containing the xml data + + @param Length + Length of the buffer containing the xml data + + @param IsFinal + Indicates whether these are the last xml data + of an xml document to parse. For very large + xml documents it may be useful to read and + parse the document partially. + + @precond XmlData must not be null + + @throws SaxException + If the used Sax parser returns an error. The SaxException + contains detailed information about the error. */ + void parse(const char* XmlData, size_t Length, bool IsFinal); + + /** Set a document handler + + @descr A document handler implements the interface i_xml_parser_event_handler. + The document handler receive notifications of various events + from the sax parser for instance "start_document". + + The client is responsible for the life time management of + the given document handler, that means the document handler + instance must exist until a new one was set or until the parser + no longer exist. + + @param SaxDocumentHandler + The new document handler, may be null if not interested in + sax parser events. + + @postcond currently used document handler == pSaxDocumentHandler */ + void set_document_handler(i_xml_parser_event_handler* event_handler); + + /** Returns the currently used document handler or null if + no document handler was set before. */ + i_xml_parser_event_handler* get_document_handler() const { return document_handler_; } + +private: + void init(); + +private: + i_xml_parser_event_handler* document_handler_; + XML_Parser xml_parser_; + +private: + xml_parser(const xml_parser&) = delete; + xml_parser& operator=(const xml_parser&) = delete; +}; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |