NCBI C++ ToolKit
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
xml Namespace Reference

XML library namespace. More...

Namespaces

namespace  impl

Classes

class  attributes
 The xml::attributes class is used to access all the attributes of one xml::node. More...
class  document
 The xml::document class is used to hold the XML tree and various bits of information about it. More...
class  document_proxy
 The xml::document_proxy class to be a relay between XSLT results and the document. More...
class  dtd
 The xml::dtd class represents an XML dtd from a file. More...
class  error_message
 The xml::error_message class is used to store a single error message which may appear while parsing or validating an XML document. More...
class  error_messages
 The xml::error_messages class is used to store all the error message which are collected while parsing or validating an XML document. More...
class  parser_exception
 The xml::parser_exception class is used to store parsing and validating exception information. More...
class  event_parser
 The xml::event_parser is used to parse an XML document by calling member functions when certain things in the XML document are parsed. More...
class  exception
 This exception class is thrown by xmlwrapp for all runtime XML-related errors along with the xml::parser_exception. More...
class  libxml2_document
 Extension to the xml::document class which allows working with raw libxml2 documents. More...
class  ns
 The xml::ns class is used to access and handle namespaces of nodes and attributes. More...
class  node
 The xml::node class is used to hold information about one XML node. More...
class  node_set
 The xml::node_set class is used to store xpath query result set. More...
class  schema
 The xml::schema class represents an XML schema. More...
class  tree_parser
 The xml::tree_parser class is used to parse an XML document and generate a tree like structure of xml::node objects. More...
class  init
 The xml::init class is used to configure the XML parser. More...
class  xpath_expression
 The xml::xpath_expression class is used to store xpath query string and optional XML namespaces. More...

Typedefs

typedef std::vector< xml::nsns_list_type
 type for holding XML namespaces
typedef int save_option_flags
 Bitwise save options mask type and a compression level.

Enumerations

enum  warnings_as_errors_type { type_warnings_are_errors, type_warnings_not_errors }
 A type for different approaches to process warnings. More...
enum  ownership_type { type_own, type_not_own }
 Used to specify if xmlwrapp should grab the ownership of various objects. More...
enum  save_options {
  save_op_compress_level_1 = 1, save_op_compress_level_2 = 2, save_op_compress_level_3 = 3, save_op_compress_level_4 = 4,
  save_op_compress_level_5 = 5, save_op_compress_level_6 = 6, save_op_compress_level_7 = 7, save_op_compress_level_8 = 8,
  save_op_compress_level_9 = 9, save_op_no_format = 1 << 16, save_op_no_decl = 1 << 17, save_op_no_empty = 1 << 18,
  save_op_no_xhtml = 1 << 19, save_op_xhtml = 1 << 20, save_op_not_as_xml = 1 << 21, save_op_as_html = 1 << 22,
  save_op_with_non_significant_ws = 1 << 23, save_op_default = 0
}

Functions

std::ostream & operator<< (std::ostream &stream, const document &doc)
bool operator== (const attributes::iterator &lhs, const attributes::iterator &rhs)
bool operator!= (const attributes::iterator &lhs, const attributes::iterator &rhs)
bool operator== (const attributes::const_iterator &lhs, const attributes::const_iterator &rhs)
bool operator!= (const attributes::const_iterator &lhs, const attributes::const_iterator &rhs)
std::ostream & operator<< (std::ostream &stream, const xml::node &n)
int size_t_to_int_conversion (std::size_t value, const std::string &msg)

Variables

const char * kDerefError = "dereferencing non initialised or out of range iterator"
const char * kRefError = "referencing non initialised or out of range iterator"
const char * kAdvError = "advancing non initialised or out of range iterator"
const char * kEmptyExpression = "xpath expression can't be empty"
const char * kDefaultNamespace = "default namespace cannot be registered"

Detailed Description

XML library namespace.


Typedef Documentation

typedef std::vector<xml::ns> xml::ns_list_type

type for holding XML namespaces

Definition at line 204 of file namespace.hpp.

Bitwise save options mask type and a compression level.

Definition at line 78 of file xml_save.hpp.


Enumeration Type Documentation

Used to specify if xmlwrapp should grab the ownership of various objects.

Enumerator:
type_own 

Grab the ownership, i.e.

the object will be freed by xmlwrapp.

type_not_own 

Do not grab the ownership, i.e.

the object will not be freed by xmlwrapp.

Definition at line 43 of file ownership.hpp.

Enumerator:
save_op_compress_level_1 

better speed

save_op_compress_level_2 
save_op_compress_level_3 
save_op_compress_level_4 
save_op_compress_level_5 
save_op_compress_level_6 
save_op_compress_level_7 
save_op_compress_level_8 
save_op_compress_level_9 

smaller size

save_op_no_format 

Do not format save output.

save_op_no_decl 

Drop the xml declaration.

save_op_no_empty 

No empty tags.

save_op_no_xhtml 

Disable XHTML1 specific rules.

save_op_xhtml 

Force XHTML1 specific rules. Ignored if libxml2 version is < 2.7.2.

save_op_not_as_xml 

Do not force XML serialization on HTML doc. Ignored if libxml2 version is < 2.7.2.

save_op_as_html 

Force HTML serialization on XML doc. Ignored if libxml2 version is < 2.7.2.

save_op_with_non_significant_ws 

Format with non-significant whitespace.

Ignored if libxml2 version is < 2.7.8. This flag will automatically set the save_op_no_format as well due to libxml2 implementation.

save_op_default 

Default is:

  • no compression
  • to format save output and
  • to force XML serialization on HTML doc

Definition at line 42 of file xml_save.hpp.

A type for different approaches to process warnings.

Enumerator:
type_warnings_are_errors 

Treat warnings as errors.

type_warnings_not_errors 

Do not treat warnings as errors.

Definition at line 221 of file errors.hpp.


Function Documentation

bool xml::operator!= ( const attributes::iterator lhs,
const attributes::iterator rhs 
)

Definition at line 625 of file ait_impl.cpp.

bool xml::operator!= ( const attributes::const_iterator lhs,
const attributes::const_iterator rhs 
)

Definition at line 635 of file ait_impl.cpp.

std::ostream & xml::operator<< ( std::ostream &  stream,
const document doc 
)
Parameters:
streamThe stream to insert the XML into.
docThe document to insert.
Returns:
The stream from the first parameter.
Author:
Peter Jones

Definition at line 712 of file document.cpp.

References save_op_default, and xml::document::save_to_stream().

std::ostream& xml::operator<< ( std::ostream &  stream,
const xml::node n 
)
Parameters:
streamThe stream to write the node as XML.
nThe node to write to the stream.
Returns:
The stream.
Author:
Peter Jones

Definition at line 1093 of file node.cpp.

References xml::impl::convert_to_libxml2_save_options(), xml::node::pimpl_, save_op_default, xml::impl::save_to_stream_cb(), and xml::impl::node_impl::xmlnode_.

bool xml::operator== ( const attributes::iterator lhs,
const attributes::iterator rhs 
)

Definition at line 620 of file ait_impl.cpp.

References xml::attributes::iterator::pimpl_.

bool xml::operator== ( const attributes::const_iterator lhs,
const attributes::const_iterator rhs 
)

Definition at line 630 of file ait_impl.cpp.

References xml::attributes::const_iterator::pimpl_.

int xml::size_t_to_int_conversion ( std::size_t  value,
const std::string msg 
)

Variable Documentation

const char* xml::kAdvError = "advancing non initialised or out of range iterator"
const char* xml::kDefaultNamespace = "default namespace cannot be registered"

Definition at line 53 of file xpath_expression.cpp.

Referenced by xml::xpath_expression::xpath_expression().

const char* xml::kDerefError = "dereferencing non initialised or out of range iterator"
const char* xml::kEmptyExpression = "xpath expression can't be empty"

Definition at line 52 of file xpath_expression.cpp.

Referenced by xml::xpath_expression::xpath_expression().

const char* xml::kRefError = "referencing non initialised or out of range iterator"
Modified on Fri Sep 19 19:27:05 2014 by modify_doxy.py rev. 426318