libxml++ 5.0.1

- Main Page
- Related Pages
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Protected Member Functions | List of all members
xmlpp::SchemaValidatorBase Class Referenceabstract

Base class for schema validators. More...

`#include <libxml++/validators/schemavalidatorbase.h>`

Inheritance diagram for xmlpp::SchemaValidatorBase:
[legend]

## Public Member Functions
LIBXMLPP_API | SchemaValidatorBase () noexcept
LIBXMLPP_API | ~SchemaValidatorBase () override
virtual LIBXMLPP_API | operator bool () const noexcept override=0
| Test whether a schema has been parsed. More...
virtual LIBXMLPP_API void | parse_document (const Document* document)=0
| Parse a schema definition from a document. More...
LIBXMLPP_API void | parse_file (const std::string& filename) override=0
| Parse a schema definition file. More...
LIBXMLPP_API void | parse_memory (const ustring& contents) override=0
| Parse a schema definition from a string. More...
LIBXMLPP_API void | validate (const Document* document) override=0
| Validate a document, using a previously parsed schema. More...
virtual LIBXMLPP_API void | validate (const std::string& filename)=0
| Validate an XML file, using a previously parsed schema. More...
Public Member Functions inherited from xmlpp::Validator
LIBXMLPP_API | Validator () noexcept
LIBXMLPP_API | ~Validator () override

## Protected Member Functions
LIBXMLPP_API void | initialize_context () override
LIBXMLPP_API void | release_underlying () override
Protected Member Functions inherited from xmlpp::Validator
virtual LIBXMLPP_API void | check_for_exception ()
virtual LIBXMLPP_API void | check_for_validity_messages ()
virtual LIBXMLPP_API void | handle_exception ()
| To be called in an exception handler. More...
virtual LIBXMLPP_API void | on_validity_error (const ustring& message)
virtual LIBXMLPP_API void | on_validity_warning (const ustring& message)
Protected Member Functions inherited from xmlpp::NonCopyable
| NonCopyable () noexcept
| NonCopyable (const NonCopyable&)=delete
| NonCopyable (NonCopyable&&)=delete
virtual | ~NonCopyable ()
NonCopyable& | operator= (const NonCopyable&)=delete
NonCopyable& | operator= (NonCopyable&&)=delete

## Additional Inherited Members
Static Protected Member Functions inherited from xmlpp::Validator
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 inherited from xmlpp::Validator
std::unique_ptr< exception > | exception_
ustring | validate_error_
ustring | validate_warning_

## Detailed Description

Base class for schema validators.

Since libxml++ 2.38:

## Constructor & Destructor Documentation

LIBXMLPP_API xmlpp::SchemaValidatorBase::SchemaValidatorBase | ( |  | ) |
| noexcept

LIBXMLPP_API xmlpp::SchemaValidatorBase::~SchemaValidatorBase | ( |  | ) |
| override

## Member Function Documentation

LIBXMLPP_API void xmlpp::SchemaValidatorBase::initialize_context | ( |  | ) |
| override protected virtual

Reimplemented from xmlpp::Validator.

Reimplemented in xmlpp::XsdValidator.

virtual LIBXMLPP_API xmlpp::SchemaValidatorBase::operator bool | ( |  | ) | const
| explicit override pure virtual noexcept

Test whether a schema has been parsed.

For instance

if (validator)
do_something();

Implements xmlpp::Validator.

Implemented in xmlpp::RelaxNGValidator, and xmlpp::XsdValidator.

virtual LIBXMLPP_API void xmlpp::SchemaValidatorBase::parse_document | ( | const Document* | document | ) |
| pure virtual

Parse a schema definition from a document.

If the validator already contains a schema, that schema is released (deleted if the validator owns the schema).

Parameters

  document | A preparsed document tree, containing the schema definition.

Exceptions

  xmlpp::parse_error |

Implemented in xmlpp::RelaxNGValidator, and xmlpp::XsdValidator.

LIBXMLPP_API void xmlpp::SchemaValidatorBase::parse_file | ( | const std::string & | filename | ) |
| override pure virtual

Parse a schema definition file.

If the validator already contains a schema, that schema is released (deleted if the validator owns the schema).

Parameters

  filename | The URL of the schema.

Exceptions

  xmlpp::parse_error |

Implements xmlpp::Validator.

Implemented in xmlpp::RelaxNGValidator, and xmlpp::XsdValidator.

LIBXMLPP_API void xmlpp::SchemaValidatorBase::parse_memory | ( | const ustring& | contents | ) |
| override pure virtual

Parse a schema definition from a string.

If the validator already contains a schema, that schema is released (deleted if the validator owns the schema).

Parameters

  contents | The schema definition as a string.

Exceptions

  xmlpp::parse_error |

Implements xmlpp::Validator.

Implemented in xmlpp::RelaxNGValidator, and xmlpp::XsdValidator.

LIBXMLPP_API void xmlpp::SchemaValidatorBase::release_underlying | ( |  | ) |
| override protected virtual

Reimplemented from xmlpp::Validator.

Reimplemented in xmlpp::XsdValidator.

LIBXMLPP_API void xmlpp::SchemaValidatorBase::validate | ( | const Document* | document | ) |
| override pure virtual

Validate a document, using a previously parsed schema.

Parameters

  document | Pointer to the document.

Exceptions

  xmlpp::internal_error |
  xmlpp::validity_error |

Implements xmlpp::Validator.

Implemented in xmlpp::RelaxNGValidator, and xmlpp::XsdValidator.

virtual LIBXMLPP_API void xmlpp::SchemaValidatorBase::validate | ( | const std::string & | filename | ) |
| pure virtual

Validate an XML file, using a previously parsed schema.

Parameters

  filename | The URL of the XML file.

Exceptions

  xmlpp::internal_error |
  xmlpp::parse_error |
  xmlpp::validity_error |

Implemented in xmlpp::RelaxNGValidator, and xmlpp::XsdValidator.