pwiz::minimxml Namespace Reference

Namespaces
namespace	SAXParser
	An extended SAX interface for custom XML stream parsing.

Classes
class	XMLWriter
	The XMLWriter class provides simple, tag-level XML syntax writing. More...
class	basic_charcounter

Typedefs
typedef basic_charcounter< char >	charcounter
typedef basic_charcounter < wchar_t >	wcharcounter

Functions
PWIZ_API_DECL std::string	xml_root_element (const std::string &fileheader)
	Returns the root element from an XML buffer; throws runtime_error if no element is found.
PWIZ_API_DECL std::string	xml_root_element (std::istream &is)
	Returns the root element from an XML stream; throws runtime_error if no element is found.
PWIZ_API_DECL std::string	xml_root_element_from_file (const std::string &filepath)
	Returns the root element from an XML file; throws runtime_error if no element is found.
PWIZ_API_DECL std::string &	decode_xml_id (std::string &str)
	Decodes any characters encoded with their hexadecimal value, e.g.
PWIZ_API_DECL std::string	decode_xml_id_copy (const std::string &str)
	Decodes any characters encoded with their hexadecimal value, e.g.
PWIZ_API_DECL std::string &	encode_xml_id (std::string &str)
	Encodes any characters not suitable in an xml:ID or xml:IDREF with their hexadecimal value, e.g.
PWIZ_API_DECL std::string	encode_xml_id_copy (const std::string &str)
	Encodes any characters not suitable in an xml:ID or xml:IDREF with their hexadecimal value, e.g.

---

Typedef Documentation

typedef basic_charcounter<char> pwiz::minimxml::charcounter

Definition at line 200 of file XMLWriter.hpp.

typedef basic_charcounter<wchar_t> pwiz::minimxml::wcharcounter

Definition at line 201 of file XMLWriter.hpp.

---

Function Documentation

PWIZ_API_DECL std::string pwiz::minimxml::xml_root_element

(

const std::string &

fileheader

)

Returns the root element from an XML buffer; throws runtime_error if no element is found.

Referenced by testRootElement().

PWIZ_API_DECL std::string pwiz::minimxml::xml_root_element

(

std::istream &

is

)

Returns the root element from an XML stream; throws runtime_error if no element is found.

PWIZ_API_DECL std::string pwiz::minimxml::xml_root_element_from_file

(

const std::string &

filepath

)

Returns the root element from an XML file; throws runtime_error if no element is found.

Referenced by testRootElement().

PWIZ_API_DECL std::string& pwiz::minimxml::decode_xml_id

(

std::string &

str

)

Decodes any characters encoded with their hexadecimal value, e.g.

"_x0020_" decodes as " " This override modifies the input string in place and returns its reference.

Referenced by testDecoding().

PWIZ_API_DECL std::string pwiz::minimxml::decode_xml_id_copy

(

const std::string &

str

)

Decodes any characters encoded with their hexadecimal value, e.g.

"_x0020_" decodes as " " This override modifies and returns a copy of the input string.

Referenced by testDecoding().

PWIZ_API_DECL std::string& pwiz::minimxml::encode_xml_id

(

std::string &

str

)

Encodes any characters not suitable in an xml:ID or xml:IDREF with their hexadecimal value, e.g.

" " encodes as "_x0020_" This override modifies the input string in place and returns its reference.

Referenced by test().

PWIZ_API_DECL std::string pwiz::minimxml::encode_xml_id_copy

(

const std::string &

str

)

Encodes any characters not suitable in an xml:ID or xml:IDREF with their hexadecimal value, e.g.

" " encodes as "_x0020_" This override modifies and returns a copy of the input string.

Referenced by test().