libxml++ 2.42.2
|
XML parser. More...
#include <libxml++/parsers/parser.h>
Public Types | |
typedef unsigned int | size_type |
Public Member Functions | |
LIBXMLPP_API | Parser () |
LIBXMLPP_API | ~Parser () override |
LIBXMLPP_API bool | get_include_default_attributes () |
See set_include_default_attributes(). | |
LIBXMLPP_API void | get_parser_options (int & set_options, int & clear_options) |
See set_parser_options(). | |
virtual LIBXMLPP_API bool | get_substitute_entities () const |
See set_substitute_entities(). | |
LIBXMLPP_API bool | get_throw_messages () const |
See set_throw_messages(). | |
virtual LIBXMLPP_API bool | get_validate () const |
See set_validate(). | |
virtual LIBXMLPP_API void | parse_file (const Glib::ustring & filename)=0 |
Parse an XML document from a file. | |
virtual LIBXMLPP_API void | parse_memory (const Glib::ustring & contents)=0 |
Parse an XML document from a string. | |
virtual LIBXMLPP_API void | parse_stream (std::istream & in)=0 |
Parse an XML document from a stream. | |
LIBXMLPP_API void | set_include_default_attributes (bool val=true) |
Set whether default attribute values from the DTD shall be included in the node tree. | |
LIBXMLPP_API void | set_parser_options (int set_options=0, int clear_options=0) |
Set and/or clear parser option flags. | |
virtual LIBXMLPP_API void | set_substitute_entities (bool val=true) |
Set whether the parser will automatically substitute entity references with the text of the entities' definitions. | |
LIBXMLPP_API void | set_throw_messages (bool val=true) |
Set whether the parser will collect and throw error and warning messages. | |
virtual LIBXMLPP_API void | set_validate (bool val=true) |
By default, the parser will not validate the XML file. | |
Protected Types | |
enum | MsgType { MsgParserError , MsgParserWarning , MsgValidityError , MsgValidityWarning } |
Protected Member Functions | |
virtual LIBXMLPP_API void | check_for_exception () |
virtual LIBXMLPP_API void | check_for_validity_messages () |
LIBXMLPP_API int | get_xinclude_options_internal () const noexcept |
virtual LIBXMLPP_API void | handleException (const exception & e) |
virtual LIBXMLPP_API void | initialize_context () |
virtual LIBXMLPP_API void | on_validity_error (const Glib::ustring & message) |
virtual LIBXMLPP_API void | on_validity_warning (const Glib::ustring & message) |
virtual LIBXMLPP_API void | release_underlying () |
LIBXMLPP_API void | set_xinclude_options_internal (int xinclude_options) noexcept |
Static Protected Member Functions | |
static LIBXMLPP_API void | callback_error_or_warning (MsgType msg_type, void * ctx, const char * msg, va_list var_args) |
static LIBXMLPP_API void | callback_parser_error (void * ctx, const char * msg,...) |
static LIBXMLPP_API void | callback_parser_warning (void * ctx, const char * msg,...) |
static LIBXMLPP_API void | callback_validity_error (void * ctx, const char * msg,...) |
static LIBXMLPP_API void | callback_validity_warning (void * ctx, const char * msg,...) |
Protected Attributes | |
_xmlParserCtxt * | context_ |
exception * | exception_ |
bool | substitute_entities_ |
bool | validate_ |
Glib::ustring | validate_error_ |
Glib::ustring | validate_warning_ |
XML parser.
unsigned int xmlpp::Parser::size_type |
|
protected |
LIBXMLPP_API xmlpp::Parser::Parser | ( | ) |
|
override |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
protectedvirtual |
|
protectedvirtual |
LIBXMLPP_API bool xmlpp::Parser::get_include_default_attributes | ( | ) |
See set_include_default_attributes().
LIBXMLPP_API void xmlpp::Parser::get_parser_options | ( | int & | set_options, |
int & | clear_options ) |
See set_parser_options().
[out] | set_options | Set bits correspond to flags that shall be set during parsing. |
[out] | clear_options | Set bits correspond to flags that shall be cleared during parsing. Bits that are set in neither set_options nor clear_options are not affected. |
|
virtual |
See set_substitute_entities().
LIBXMLPP_API bool xmlpp::Parser::get_throw_messages | ( | ) | const |
See set_throw_messages().
|
virtual |
See set_validate().
|
protectednoexcept |
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
|
pure virtual |
Parse an XML document from a file.
exception |
filename | The path to the file. |
Implemented in xmlpp::DomParser, and xmlpp::SaxParser.
|
pure virtual |
Parse an XML document from a string.
exception |
contents | The XML document as a string. |
Implemented in xmlpp::DomParser, and xmlpp::SaxParser.
|
pure virtual |
Parse an XML document from a stream.
exception |
in | The stream. |
Implemented in xmlpp::DomParser, and xmlpp::SaxParser.
|
protectedvirtual |
Reimplemented in xmlpp::DomParser, and xmlpp::SaxParser.
LIBXMLPP_API void xmlpp::Parser::set_include_default_attributes | ( | bool | val = true | ) |
Set whether default attribute values from the DTD shall be included in the node tree.
If set, attributes not assigned a value in the XML file, but with a default value in the DTD file, will be included in the node tree that the parser creates. These attributes will be represented by AttributeNode instances (not AttributeDeclaration instances), just like attributes which are assigned a value in the XML file.
val | Whether attributes with default values will be included in the node tree. |
LIBXMLPP_API void xmlpp::Parser::set_parser_options | ( | int | set_options = 0, |
int | clear_options = 0 ) |
Set and/or clear parser option flags.
See the libxml2 documentation, enum xmlParserOption, for a list of parser options. This method overrides other methods that set parser options, such as set_validate(), set_substitute_entities() and set_include_default_attributes(). Use set_parser_options() only if no other method can set the parser options you want.
set_options | Set bits correspond to flags that shall be set during parsing. |
clear_options | Set bits correspond to flags that shall be cleared during parsing. Bits that are set in neither set_options nor clear_options are not affected. |
|
virtual |
Set whether the parser will automatically substitute entity references with the text of the entities' definitions.
For instance, this affects the text returned by ContentNode::get_content(). By default, the parser will not substitute entities, so that you do not lose the entity reference information.
val | Whether entities will be substitued. |
LIBXMLPP_API void xmlpp::Parser::set_throw_messages | ( | bool | val = true | ) |
Set whether the parser will collect and throw error and warning messages.
If messages are collected, they are included in an exception thrown at the end of parsing. If the messages are not collected, they are written on stderr. The messages written on stderr are slightly different, and may be preferred in a program started from the command-line.
The default, if set_throw_messages() is not called, is to collect and throw only messages from validation. Other messages are written to stderr. This is for backward compatibility, and may change in the future.
val | Whether messages will be collected and thrown in an exception. |
|
virtual |
By default, the parser will not validate the XML file.
val | Whether the document should be validated. |
|
protectednoexcept |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |