diff options
Diffstat (limited to 'src/plugins/xml/XmlParser.hpp')
-rw-r--r-- | src/plugins/xml/XmlParser.hpp | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/src/plugins/xml/XmlParser.hpp b/src/plugins/xml/XmlParser.hpp new file mode 100644 index 0000000..b19af1e --- /dev/null +++ b/src/plugins/xml/XmlParser.hpp @@ -0,0 +1,69 @@ +/* + Ousía + Copyright (C) 2014, 2015 Benjamin Paaßen, Andreas Stöckel + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. +*/ + +/** + * @file XmlParser.hpp + * + * Contains the parser responsible for reading Ousía XML Documents (extension + * oxd) and Ousía XML Modules (extension oxm). + * + * @author Andreas Stöckel (astoecke@techfak.uni-bielefeld.de) + */ + +#ifndef _OUSIA_XML_PARSER_HPP_ +#define _OUSIA_XML_PARSER_HPP_ + +#include <core/parser/Parser.hpp> + +namespace ousia { +namespace parser { +namespace xml { + +/** + * The XmlParser class implements parsing the various types of Ousía XML + * documents using the expat stream XML parser. + */ +class XmlParser : public Parser { +public: + /** + * Returns the mimetype supported by the XmlParser which is + * "text/vnd.ousia.oxm" and "text/vnd.ousia.oxd". + * + * @return a list containing the mimetype supported by Ousía. + */ + std::set<std::string> mimetypes() override; + + /** + * Parses the given input stream as XML file and returns the parsed + * top-level node. + * + * @param is is the input stream that will be parsed. + * @param ctx is a reference to the ParserContext instance that should be + * used. + */ + Rooted<Node> parse(std::istream &is, ParserContext &ctx) override; + + using Parser::parse; +}; + +} +} +} + +#endif /* _OUSIA_XML_PARSER_HPP_ */ + |