summaryrefslogtreecommitdiff
path: root/src/plugins/xml/XmlParser.hpp
blob: b19af1e49da02d4df0801ca32fe7b3db619d48f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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_ */