File: parser.hpp

package info (click to toggle)
libzeep 5.1.8-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 3,596 kB
  • sloc: cpp: 27,393; xml: 7,798; javascript: 180; sh: 37; makefile: 8
file content (134 lines) | stat: -rw-r--r-- 4,673 bytes parent folder | download
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
// Copyright Maarten L. Hekkelman, Radboud University 2008-2013.
//        Copyright Maarten L. Hekkelman, 2014-2022
// Distributed under the Boost Software License, Version 1.0.
//    (See accompanying file LICENSE_1_0.txt or copy at
//          http://www.boost.org/LICENSE_1_0.txt)

#pragma once

/// \file
/// definition of the libzeep XML parser, a recursive descent parser

#include <zeep/config.hpp>

#include <functional>
#include <list>

#include <zeep/xml/node.hpp>
#include <zeep/exception.hpp>
#include <zeep/xml/character-classification.hpp>

namespace zeep::xml
{

namespace detail
{

struct attr
{
	std::string m_ns;
	std::string m_name;
	std::string m_value;
	bool m_id; // whether the attribute is defined as type ID in its ATTLIST decl
};

} // namespace detail

/// If an invalid_exception is thrown, it means the XML document is not valid: it does
/// not conform the DTD specified in the XML document.
/// This is only thrown when validation is enabled.
///
/// The what() member of the exception object will contain an explanation.

class invalid_exception : public zeep::exception
{
  public:
	invalid_exception(const std::string& msg) : exception(msg) {}
	~invalid_exception() throw() {}
};

/// If an not_wf_exception is thrown, it means the XML document is not well formed.
/// Often this means syntax errors, missing \< or \> characters, non matching open
/// and close tags, etc.
///
/// The what() member of the exception object will contain an explanation.

class not_wf_exception : public zeep::exception
{
  public:
	not_wf_exception(const std::string& msg) : exception(msg) {}
	~not_wf_exception() throw() {}
};

/// zeep::xml::parser is a SAX parser. After construction, you should assign
/// call back handlers for the SAX events and then call parse().

class parser
{
  public:

	using attr_type = detail::attr;
	using attr_list_type = std::list<detail::attr>;

	parser(std::istream& is);
	parser(const std::string& s);

	virtual ~parser();

	std::function<void(encoding_type encoding, bool standalone, float version)>								xml_decl_handler;
	std::function<void(const std::string& name, const std::string& uri, const attr_list_type& atts)>		start_element_handler;
	std::function<void(const std::string& name, const std::string& uri)>									end_element_handler;
	std::function<void(const std::string& data)>															character_data_handler;
	std::function<void(const std::string& target, const std::string& data)>									processing_instruction_handler;
	std::function<void(const std::string& data)>															comment_handler;
	std::function<void()>																					start_cdata_section_handler;
	std::function<void()>																					end_cdata_section_handler;
	std::function<void(const std::string& prefix, const std::string& uri)>									start_namespace_decl_handler;
	std::function<void(const std::string& prefix)>															end_namespace_decl_handler;
	std::function<void(const std::string& root, const std::string& publicId, const std::string& uri)>		doctype_decl_handler;
	std::function<void(const std::string& name, const std::string& systemId, const std::string& publicId)>	notation_decl_handler;
	std::function<std::istream *(const std::string& base, const std::string& pubid, const std::string& uri)>external_entity_ref_handler;
	std::function<void(const std::string& msg)>																report_invalidation_handler;

	void parse(bool validate, bool validate_ns);

  protected:
	friend struct parser_imp;

	virtual void xml_decl(encoding_type encoding, bool standalone, float version);

	virtual void doctype_decl(const std::string& root, const std::string& publicId, const std::string& uri);

	virtual void start_element(const std::string& name,
							   const std::string& uri, const attr_list_type& atts);

	virtual void end_element(const std::string& name, const std::string& uri);

	virtual void character_data(const std::string& data);

	virtual void processing_instruction(const std::string& target, const std::string& data);

	virtual void comment(const std::string& data);

	virtual void start_cdata_section();

	virtual void end_cdata_section();

	virtual void start_namespace_decl(const std::string& prefix, const std::string& uri);

	virtual void end_namespace_decl(const std::string& prefix);

	virtual void notation_decl(const std::string& name,
							   const std::string& systemId, const std::string& publicId);

	virtual void report_invalidation(const std::string& msg);

	virtual std::istream*
	external_entity_ref(const std::string& base,
						const std::string& pubid, const std::string& uri);

	struct parser_imp *m_impl;
	std::istream *m_istream;
};

} // namespace zeep::xml