libxml++  2.91.2
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
xmlpp::Parser Class Referenceabstract

XML parser. More...

#include <libxml++/parsers/parser.h>

Inheritance diagram for xmlpp::Parser:
Inheritance graph
[legend]

Public Types

typedef unsigned int size_type
 

Public Member Functions

 Parser ()
 
 ~Parser () override
 
bool get_include_default_attributes ()
 See set_include_default_attributes(). More...
 
void get_parser_options (int& set_options, int& clear_options)
 See set_parser_options(). More...
 
bool get_substitute_entities () const
 See set_substitute_entities(). More...
 
bool get_throw_messages () const
 See set_throw_messages(). More...
 
bool get_validate () const
 See set_validate(). More...
 
virtual void parse_file (const std::string& filename)=0
 Parse an XML document from a file. More...
 
virtual void parse_memory (const Glib::ustring& contents)=0
 Parse an XML document from a string. More...
 
virtual void parse_memory_raw (const unsigned char* contents, size_type bytes_count)=0
 Parse an XML document from raw memory. More...
 
virtual void parse_stream (std::istream& in)=0
 Parse an XML document from a stream. More...
 
void set_include_default_attributes (bool val=true)
 Set whether default attribute values from the DTD shall be included in the node tree. More...
 
void set_parser_options (int set_options=0, int clear_options=0)
 Set and/or clear parser option flags. More...
 
void set_substitute_entities (bool val=true)
 Set whether the parser will automatically substitute entity references with the text of the entities' definitions. More...
 
void set_throw_messages (bool val=true)
 Set whether the parser will collect and throw error and warning messages. More...
 
void set_validate (bool val=true)
 By default, the parser will not validate the XML file. More...
 

Protected Types

enum  MsgType {
  MsgParserError,
  MsgParserWarning,
  MsgValidityError,
  MsgValidityWarning
}
 

Protected Member Functions

virtual void check_for_error_and_warning_messages ()
 
virtual void check_for_exception ()
 
virtual void handle_exception ()
 To be called in an exception handler. More...
 
virtual void initialize_context ()
 
virtual void on_parser_error (const Glib::ustring& message)
 
virtual void on_parser_warning (const Glib::ustring& message)
 
virtual void on_validity_error (const Glib::ustring& message)
 
virtual void on_validity_warning (const Glib::ustring& message)
 
virtual void release_underlying ()
 
- Protected Member Functions inherited from xmlpp::NonCopyable
 NonCopyable ()
 
 NonCopyable (const NonCopyable&)=delete
 
virtual ~NonCopyable ()
 
NonCopyableoperator= (const NonCopyable&)=delete
 

Static Protected Member Functions

static void callback_error_or_warning (MsgType msg_type, void* ctx, const char* msg, va_list var_args)
 
static void callback_parser_error (void* ctx, const char* msg,...)
 
static void callback_parser_warning (void* ctx, const char* msg,...)
 
static void callback_validity_error (void* ctx, const char* msg,...)
 
static void callback_validity_warning (void* ctx, const char* msg,...)
 

Protected Attributes

_xmlParserCtxt* context_
 
std::unique_ptr< exceptionexception_
 

Detailed Description

XML parser.

Abstract base class for DOM parser and SAX parser.

Member Typedef Documentation

typedef unsigned int xmlpp::Parser::size_type

Member Enumeration Documentation

enum xmlpp::Parser::MsgType
protected
Enumerator
MsgParserError 
MsgParserWarning 
MsgValidityError 
MsgValidityWarning 

Constructor & Destructor Documentation

xmlpp::Parser::Parser ( )
xmlpp::Parser::~Parser ( )
override

Member Function Documentation

static void xmlpp::Parser::callback_error_or_warning ( MsgType  msg_type,
void *  ctx,
const char *  msg,
va_list  var_args 
)
staticprotected
static void xmlpp::Parser::callback_parser_error ( void *  ctx,
const char *  msg,
  ... 
)
staticprotected
static void xmlpp::Parser::callback_parser_warning ( void *  ctx,
const char *  msg,
  ... 
)
staticprotected
static void xmlpp::Parser::callback_validity_error ( void *  ctx,
const char *  msg,
  ... 
)
staticprotected
static void xmlpp::Parser::callback_validity_warning ( void *  ctx,
const char *  msg,
  ... 
)
staticprotected
virtual void xmlpp::Parser::check_for_error_and_warning_messages ( )
protectedvirtual
virtual void xmlpp::Parser::check_for_exception ( )
protectedvirtual
bool xmlpp::Parser::get_include_default_attributes ( )

See set_include_default_attributes().

Since libxml++ 2.38:
Returns
Whether attributes with default values will be included in the node tree.
void xmlpp::Parser::get_parser_options ( int &  set_options,
int &  clear_options 
)

See set_parser_options().

Since libxml++ 2.38:
Parameters
[out]set_optionsSet bits correspond to flags that shall be set during parsing.
[out]clear_optionsSet bits correspond to flags that shall be cleared during parsing. Bits that are set in neither set_options nor clear_options are not affected.
bool xmlpp::Parser::get_substitute_entities ( ) const

See set_substitute_entities().

Returns
Whether entities will be substituted during parsing.
bool xmlpp::Parser::get_throw_messages ( ) const

See set_throw_messages().

Since libxml++ 2.36:
Returns
Whether messages will be collected and thrown in an exception.
bool xmlpp::Parser::get_validate ( ) const

See set_validate().

Returns
Whether the parser will validate the XML file.
virtual void xmlpp::Parser::handle_exception ( )
protectedvirtual

To be called in an exception handler.

virtual void xmlpp::Parser::initialize_context ( )
protectedvirtual

Reimplemented in xmlpp::SaxParser.

virtual void xmlpp::Parser::on_parser_error ( const Glib::ustring message)
protectedvirtual
virtual void xmlpp::Parser::on_parser_warning ( const Glib::ustring message)
protectedvirtual
virtual void xmlpp::Parser::on_validity_error ( const Glib::ustring message)
protectedvirtual
virtual void xmlpp::Parser::on_validity_warning ( const Glib::ustring message)
protectedvirtual
virtual void xmlpp::Parser::parse_file ( const std::string filename)
pure virtual

Parse an XML document from a file.

Exceptions
exception
Parameters
filenameThe path to the file.

Implemented in xmlpp::SaxParser, and xmlpp::DomParser.

virtual void xmlpp::Parser::parse_memory ( const Glib::ustring contents)
pure virtual

Parse an XML document from a string.

Exceptions
exception
Parameters
contentsThe XML document as a string.

Implemented in xmlpp::SaxParser, and xmlpp::DomParser.

virtual void xmlpp::Parser::parse_memory_raw ( const unsigned char *  contents,
size_type  bytes_count 
)
pure virtual

Parse an XML document from raw memory.

Exceptions
exception
Parameters
contentsThe XML document as an array of bytes.
bytes_countThe number of bytes in the contents array.

Implemented in xmlpp::SaxParser, and xmlpp::DomParser.

virtual void xmlpp::Parser::parse_stream ( std::istream in)
pure virtual

Parse an XML document from a stream.

Exceptions
exception
Parameters
inThe stream.

Implemented in xmlpp::SaxParser, and xmlpp::DomParser.

virtual void xmlpp::Parser::release_underlying ( )
protectedvirtual

Reimplemented in xmlpp::SaxParser, and xmlpp::DomParser.

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.

Since libxml++ 2.38:
Parameters
valWhether attributes with default values will be included in the node tree.
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.

Since libxml++ 2.38:
Parameters
set_optionsSet bits correspond to flags that shall be set during parsing.
clear_optionsSet bits correspond to flags that shall be cleared during parsing. Bits that are set in neither set_options nor clear_options are not affected.
void xmlpp::Parser::set_substitute_entities ( bool  val = true)

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.

Parameters
valWhether entities will be substitued.
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.

  • DOM parser

    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 messages.

  • SAX parser

    If the messages are not collected, the error handling on_*() methods in the user's SAX parser subclass are called. This is the default, if set_throw_messages() is not called.

Since libxml++ 2.36:
Parameters
valWhether messages will be collected and thrown in an exception.
void xmlpp::Parser::set_validate ( bool  val = true)

By default, the parser will not validate the XML file.

Parameters
valWhether the document should be validated.

Member Data Documentation

_xmlParserCtxt* xmlpp::Parser::context_
protected
std::unique_ptr<exception> xmlpp::Parser::exception_
protected