ProteoWizard
Namespaces | Classes | Typedefs | Functions
pwiz::minimxml Namespace Reference

Namespaces

 SAXParser
 An extended SAX interface for custom XML stream parsing.
 

Classes

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

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. More...
 
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. More...
 
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. More...
 
PWIZ_API_DECL std::string & decode_xml_id (std::string &str)
 Decodes any characters encoded with their hexadecimal value, e.g. More...
 
PWIZ_API_DECL std::string decode_xml_id_copy (const std::string &str)
 Decodes any characters encoded with their hexadecimal value, e.g. More...
 
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. More...
 
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. More...
 

Typedef Documentation

§ charcounter

Definition at line 200 of file XMLWriter.hpp.

§ wcharcounter

Definition at line 201 of file XMLWriter.hpp.

Function Documentation

§ xml_root_element() [1/2]

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 pwiz::minimxml::SAXParser::Handler::getAttribute(), and testRootElement().

§ xml_root_element() [2/2]

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.

§ xml_root_element_from_file()

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 pwiz::minimxml::SAXParser::Handler::getAttribute(), and testRootElement().

§ decode_xml_id()

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 pwiz::minimxml::SAXParser::Handler::getAttribute(), and testDecoding().

§ decode_xml_id_copy()

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 pwiz::minimxml::SAXParser::Handler::getAttribute(), and testDecoding().

§ encode_xml_id()

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().

§ encode_xml_id_copy()

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().