pwiz::minimxml::SAXParser Namespace Reference

An extended SAX interface for custom XML stream parsing. More...

Classes
class	saxstring
class	Handler
	SAX event handler interface. More...

Functions
PWIZ_API_DECL size_t	count_trail_ws (const char *data, size_t len)
PWIZ_API_DECL void	unescapeXML (char *str)
PWIZ_API_DECL void	unescapeXML (std::string &str)
std::ostream &	operator<< (std::ostream &os, const saxstring &s)
template<typename Target >
Target	textToValue (const char *txt)
template<>
float	textToValue (const char *txt)
bool	istrue (const char *t)
PWIZ_API_DECL void	parse (std::istream &is, Handler &handler)
	Extract a single XML element from the istream, sending SAX events to the handler.

---

Detailed Description

An extended SAX interface for custom XML stream parsing.

Use cases:

• read a single element
• read a single element, aborting on a specified tag
• delegate handling of a sub-element to another handler

---

Function Documentation

PWIZ_API_DECL size_t pwiz::minimxml::SAXParser::count_trail_ws	(	const char *	data,
		size_t	len
	)

Referenced by pwiz::minimxml::SAXParser::saxstring::trim_trail_ws().

PWIZ_API_DECL void pwiz::minimxml::SAXParser::unescapeXML

(

char *

str

)

Referenced by pwiz::minimxml::SAXParser::Handler::Attributes::attribute::getValuePtr().

PWIZ_API_DECL void pwiz::minimxml::SAXParser::unescapeXML

(

std::string &

str

)

std::ostream& pwiz::minimxml::SAXParser::operator<< ( std::ostream &  os, const saxstring &  s  )

inline

Definition at line 218 of file SAXParser.hpp.

References pwiz::minimxml::SAXParser::saxstring::c_str().

{
    os << s.c_str();
    return os;
}

template<typename Target >

Target pwiz::minimxml::SAXParser::textToValue ( const char *  txt )

inline

Definition at line 229 of file SAXParser.hpp.

References ATOF.

{
    return (float) ATOF( txt ) ;
}

template<>

std::string pwiz::minimxml::SAXParser::textToValue ( const char *  txt )

inline

Definition at line 229 of file SAXParser.hpp.

References ATOF.

{
    return (float) ATOF( txt ) ;
}

bool pwiz::minimxml::SAXParser::istrue ( const char *  t )

inline

Definition at line 286 of file SAXParser.hpp.

{
    return strcmp(t, "0") && strcmp(t,"false"); // as in optimized_lexical_cast.h
}

PWIZ_API_DECL void pwiz::minimxml::SAXParser::parse	(	std::istream &	is,
		Handler &	handler
	)

Extract a single XML element from the istream, sending SAX events to the handler.

Behavior:

• Parser returns when it completes reading of the first element it encounters.

• Parser returns immediately if the Handler returns Status::Done when handling an event.

• On startElement(), Handler may delegate handling to a sub-Handler, which will receive the same startElement() event. The sub-Handler pointer will remain on the parser's Handler stack until it handles the corresponding endElement(). Caution: The sub-Handler pointer must remain valid while it is on the Handler stack, so it cannot point to a local object that goes out of scope when Handler:startElement() returns.

Notes:

• Start tags with end marker '/' generate two events, e.g.
  will generate events startElement("br", ...) and endElement("br").