balxml::Utf8ReaderWrapper Class Reference

#include <balxml_utf8readerwrapper.h>

Inheritance diagram for balxml::Utf8ReaderWrapper:

Public Member Functions
	BSLMF_NESTED_TRAIT_DECLARATION (Utf8ReaderWrapper, bslma::UsesBslmaAllocator)
	Utf8ReaderWrapper (Reader *reader, bslma::Allocator *basicAllocator=0)
	~Utf8ReaderWrapper () BSLS_KEYWORD_OVERRIDE
	Close the held reader and destroy this object.
void	setOptions (unsigned int flags) BSLS_KEYWORD_OVERRIDE
void	setPrefixStack (PrefixStack *prefixes) BSLS_KEYWORD_OVERRIDE
void	setResolver (XmlResolverFunctor resolver) BSLS_KEYWORD_OVERRIDE
int	open (const char *filename, const char *encoding=0) BSLS_KEYWORD_OVERRIDE
int	open (const char *buffer, bsl::size_t size, const char *url=0, const char *encoding=0) BSLS_KEYWORD_OVERRIDE
int	open (bsl::streambuf *stream, const char *url=0, const char *encoding=0) BSLS_KEYWORD_OVERRIDE
void	close () BSLS_KEYWORD_OVERRIDE
int	advanceToNextNode () BSLS_KEYWORD_OVERRIDE
bslma::Allocator *	allocator () const
	Return the allocator used by this object to allocate memory.
const char *	documentEncoding () const BSLS_KEYWORD_OVERRIDE
const ErrorInfo &	errorInfo () const BSLS_KEYWORD_OVERRIDE
int	getColumnNumber () const BSLS_KEYWORD_OVERRIDE
int	getLineNumber () const BSLS_KEYWORD_OVERRIDE
bool	isEmptyElement () const BSLS_KEYWORD_OVERRIDE
bool	isOpen () const BSLS_KEYWORD_OVERRIDE
int	lookupAttribute (ElementAttribute *attribute, int index) const BSLS_KEYWORD_OVERRIDE
int	lookupAttribute (ElementAttribute *attribute, const char *qname) const BSLS_KEYWORD_OVERRIDE
int	lookupAttribute (ElementAttribute *attribute, const char *localName, const char *namespaceUri) const BSLS_KEYWORD_OVERRIDE
int	lookupAttribute (ElementAttribute *attribute, const char *localName, int namespaceId) const BSLS_KEYWORD_OVERRIDE
const char *	nodeBaseUri () const BSLS_KEYWORD_OVERRIDE
int	nodeDepth () const BSLS_KEYWORD_OVERRIDE
const char *	nodeLocalName () const BSLS_KEYWORD_OVERRIDE
bool	nodeHasValue () const BSLS_KEYWORD_OVERRIDE
	Return true if the current node has a value and false otherwise.
const char *	nodeName () const BSLS_KEYWORD_OVERRIDE
int	nodeNamespaceId () const BSLS_KEYWORD_OVERRIDE
const char *	nodeNamespaceUri () const BSLS_KEYWORD_OVERRIDE
const char *	nodePrefix () const BSLS_KEYWORD_OVERRIDE
NodeType	nodeType () const BSLS_KEYWORD_OVERRIDE
const char *	nodeValue () const BSLS_KEYWORD_OVERRIDE
int	numAttributes () const BSLS_KEYWORD_OVERRIDE
unsigned int	options () const BSLS_KEYWORD_OVERRIDE
	Return the option flags.
PrefixStack *	prefixStack () const BSLS_KEYWORD_OVERRIDE
XmlResolverFunctor	resolver () const BSLS_KEYWORD_OVERRIDE
	Return the external XML resource resolver.
Public Member Functions inherited from balxml::Reader
virtual	~Reader (void)
void	dumpNode (bsl::ostream &os) const
bool	isFatalError () const
bool	isError () const
bool	isWarning () const

Additional Inherited Members
Public Types inherited from balxml::Reader
enum	NodeType {   e_NODE_TYPE_NONE = 0 , e_NODE_TYPE_ELEMENT = 1 , e_NODE_TYPE_TEXT = 2 , e_NODE_TYPE_CDATA = 3 ,   e_NODE_TYPE_ENTITY_REFERENCE = 4 , e_NODE_TYPE_ENTITY = 5 , e_NODE_TYPE_PROCESSING_INSTRUCTION = 6 , e_NODE_TYPE_COMMENT = 7 ,   e_NODE_TYPE_DOCUMENT = 8 , e_NODE_TYPE_DOCUMENT_TYPE = 9 , e_NODE_TYPE_DOCUMENT_FRAGMENT = 10 , e_NODE_TYPE_NOTATION = 11 ,   e_NODE_TYPE_WHITESPACE = 12 , e_NODE_TYPE_SIGNIFICANT_WHITESPACE = 13 , e_NODE_TYPE_END_ELEMENT = 14 , e_NODE_TYPE_END_ENTITY = 15 ,   e_NODE_TYPE_XML_DECLARATION = 16 , BAEXML_NODE_TYPE_NONE = e_NODE_TYPE_NONE , BAEXML_NODE_TYPE_ELEMENT = e_NODE_TYPE_ELEMENT , BAEXML_NODE_TYPE_TEXT = e_NODE_TYPE_TEXT ,   BAEXML_NODE_TYPE_CDATA = e_NODE_TYPE_CDATA , BAEXML_NODE_TYPE_ENTITY_REFERENCE = e_NODE_TYPE_ENTITY_REFERENCE , BAEXML_NODE_TYPE_ENTITY = e_NODE_TYPE_ENTITY , BAEXML_NODE_TYPE_PROCESSING_INSTRUCTION ,   BAEXML_NODE_TYPE_COMMENT = e_NODE_TYPE_COMMENT , BAEXML_NODE_TYPE_DOCUMENT = e_NODE_TYPE_DOCUMENT , BAEXML_NODE_TYPE_DOCUMENT_TYPE = e_NODE_TYPE_DOCUMENT_TYPE , BAEXML_NODE_TYPE_DOCUMENT_FRAGMENT = e_NODE_TYPE_DOCUMENT_FRAGMENT ,   BAEXML_NODE_TYPE_NOTATION = e_NODE_TYPE_NOTATION , BAEXML_NODE_TYPE_WHITESPACE = e_NODE_TYPE_WHITESPACE , BAEXML_NODE_TYPE_SIGNIFICANT_WHITESPACE , BAEXML_NODE_TYPE_END_ELEMENT = e_NODE_TYPE_END_ELEMENT ,   BAEXML_NODE_TYPE_END_ENTITY = e_NODE_TYPE_END_ENTITY , BAEXML_NODE_TYPE_XML_DECLARATION = e_NODE_TYPE_XML_DECLARATION , NODE_TYPE_NONE = e_NODE_TYPE_NONE , NODE_TYPE_ELEMENT = e_NODE_TYPE_ELEMENT ,   NODE_TYPE_TEXT = e_NODE_TYPE_TEXT , NODE_TYPE_CDATA = e_NODE_TYPE_CDATA , NODE_TYPE_ENTITY_REFERENCE = e_NODE_TYPE_ENTITY_REFERENCE , NODE_TYPE_ENTITY = e_NODE_TYPE_ENTITY ,   NODE_TYPE_PROCESSING_INSTRUCTION , NODE_TYPE_COMMENT = e_NODE_TYPE_COMMENT , NODE_TYPE_DOCUMENT = e_NODE_TYPE_DOCUMENT , NODE_TYPE_DOCUMENT_TYPE = e_NODE_TYPE_DOCUMENT_TYPE ,   NODE_TYPE_DOCUMENT_FRAGMENT = e_NODE_TYPE_DOCUMENT_FRAGMENT , NODE_TYPE_NOTATION = e_NODE_TYPE_NOTATION , NODE_TYPE_WHITESPACE = e_NODE_TYPE_WHITESPACE , NODE_TYPE_SIGNIFICANT_WHITESPACE ,   NODE_TYPE_END_ELEMENT = e_NODE_TYPE_END_ELEMENT , NODE_TYPE_END_ENTITY = e_NODE_TYPE_END_ENTITY , NODE_TYPE_XML_DECLARATION = e_NODE_TYPE_XML_DECLARATION }
typedef bslma::ManagedPtr< bsl::streambuf >	StreamBufPtr
typedef bsl::function< StreamBufPtr(const char *location, const char *namespaceUri)>	XmlResolverFunctor
Static Public Member Functions inherited from balxml::Reader
static const char *	nodeTypeAsString (NodeType nodeType)

Detailed Description

This class "has a" pointer to a held and wrapped Reader object, and operations on this object are passed to the held reader. The held reader is passed a Utf8CheckingInStreamBufWrapper, which holds and wraps a normal streambuf. The Utf8CheckingInStreamBufWrapper checks input for invalid UTF-8, and if it detects any, makes the diagnosis of the problem available through the errorInfo accessor.

See balxml_utf8readerwrapper

Constructor & Destructor Documentation

Utf8ReaderWrapper()

balxml::Utf8ReaderWrapper::Utf8ReaderWrapper ( Reader *  reader, bslma::Allocator *  basicAllocator = 0  )

explicit

Create a Utf8ReaderWrapper that holds the specified reader. Optionally specify a basicAllocator used to supply memory. If basicAllocator is 0, the currently installed default allocator is used. The behavior is undefined unless reader has never been opened or closed.

~Utf8ReaderWrapper()

balxml::Utf8ReaderWrapper::~Utf8ReaderWrapper

(

)

Member Function Documentation

advanceToNextNode()

int balxml::Utf8ReaderWrapper::advanceToNextNode ( )

virtual

Move to the next node in the data steam created by open thus allowing the node's properties to be queried via the Reader accessors. Return 0 on successful read, 1 if there are no more nodes to read, and a negative number otherwise. Note that each call to advanceToNextNode invalidates strings and data structures returned when Reader accessors where call for the "prior node". E.g., the pointer returned from nodeName for this node will not be valid once advanceToNextNode is called. Note that the reader will not be on a valid node until the first call to advanceToNextNode after the reader is opened.

Implements balxml::Reader.

allocator()

bslma::Allocator * balxml::Utf8ReaderWrapper::allocator

(

)

const

BSLMF_NESTED_TRAIT_DECLARATION()

balxml::Utf8ReaderWrapper::BSLMF_NESTED_TRAIT_DECLARATION	(	Utf8ReaderWrapper	,
		bslma::UsesBslmaAllocator
	)

close()

void balxml::Utf8ReaderWrapper::close ( )

virtual

Close the reader. Most, but not all state is reset. Specifically, the XML resource resolver and the prefix stack remain. The prefix stack shall be returned to the stack depth it had when setPrefixStack was called. Call the method open to reuse the reader. Note that close invalidates all strings and data structures obtained via Reader accessors. E.g., the pointer returned from nodeName for this node will not be valid once close is called.

Implements balxml::Reader.

documentEncoding()

const char * balxml::Utf8ReaderWrapper::documentEncoding ( ) const

virtual

Return the document encoding or NULL on error. The returned poiner is owned by this object and must not be modified or deallocated by the caller. The returned pointer becomes invalid when close is called or the reader is destroyed.

Implements balxml::Reader.

errorInfo()

const ErrorInfo & balxml::Utf8ReaderWrapper::errorInfo ( ) const

virtual

Return a reference to the non-modifiable error information for this reader. The returned value becomes invalid when close is called or the reader is destroyed.

Implements balxml::Reader.

getColumnNumber()

int balxml::Utf8ReaderWrapper::getColumnNumber ( ) const

virtual

Return the current column number within the input stream. The current column number is the number of characters since the last newline was read by the reader plus one, i.e., the first column of each line is column number one. Return 0 if not available. Note that a derived-class implementation is not required to count columns and may just return 0.

Implements balxml::Reader.

getLineNumber()

int balxml::Utf8ReaderWrapper::getLineNumber ( ) const

virtual

Return the current line number within the input stream. The current line is the last line for which the reader has not yet seen a newline. Lines are counted starting at one from the time a stream is provided to open. Return 0 if not available. Note that a derived-class implementation is not required to count lines and may just return 0.

Implements balxml::Reader.

isEmptyElement()

bool balxml::Utf8ReaderWrapper::isEmptyElement ( ) const

virtual

Return true if the current node is an element (i.e., node type is BAEXML_NODE_TYPE_ELEMENT) that ends with />; and false otherwise. Note that <a/> will be considered empty but <a></a> will not.

Implements balxml::Reader.

isOpen()

bool balxml::Utf8ReaderWrapper::isOpen ( ) const

virtual

Return true if open was called successfully and close has not yet been called and false otherwise.

Implements balxml::Reader.

lookupAttribute() [1/4]

int balxml::Utf8ReaderWrapper::lookupAttribute ( ElementAttribute *  attribute, const char *  localName, const char *  namespaceUri  ) const

virtual

Find the attribute with the specified localName and specified namespaceUri in the current node, and fill in the specified attribute structure. Return 0 on success, 1 if there is no attribute found with localName and namespaceUri, and a negative value otherwise. If namespaceUri == 0 or a blank string is passed, then the document's default namespace will be used. The strings that were filled into the attribute structure are invalid upon the next advanceToNextNode or close is called.

Implements balxml::Reader.

lookupAttribute() [2/4]

int balxml::Utf8ReaderWrapper::lookupAttribute ( ElementAttribute *  attribute, const char *  localName, int  namespaceId  ) const

virtual

Find the attribute with the specified localName and specified namespaceId in the current node, and fill in the specified attribute structure. Return 0 on success, 1 if there is no attribute found with localName and namespaceId, and a negative value otherwise. If namespaceId == -1, then the document's default namespace will be used. The strings that were filled into the attribute structure are invalid upon the next advanceToNextNode or close is called.

Implements balxml::Reader.

lookupAttribute() [3/4]

int balxml::Utf8ReaderWrapper::lookupAttribute ( ElementAttribute *  attribute, const char *  qname  ) const

virtual

Find the attribute with the specified qname (qualified name) in the current node, and fill in the specified attribute structure. Return 0 on success, 1 if there is no attribute found with qname, and a negative value otherwise. The strings that were filled into the attribute structure are invalid upon the next advanceToNextNode or close is called.

Implements balxml::Reader.

lookupAttribute() [4/4]

int balxml::Utf8ReaderWrapper::lookupAttribute ( ElementAttribute *  attribute, int  index  ) const

virtual

Find the attribute at the specified index in the current node, and fill in the specified attribute structure. Return 0 on success, 1 if no attribute is found at the index, and an a negative value otherwise. The strings that were filled into the attribute structure are invalid upon the next advanceToNextNode or close is called.

Implements balxml::Reader.

nodeBaseUri()

const char * balxml::Utf8ReaderWrapper::nodeBaseUri ( ) const

virtual

Return the base URI name of the current node if the current node has a base URI and NULL otherwise. The returned pointer is owned by this object and must not be modified or deallocated by the caller. The returned pointer becomes invalid upon the next advanceToNextNode, when close is called or the reader is destroyed.

Implements balxml::Reader.

nodeDepth()

int balxml::Utf8ReaderWrapper::nodeDepth ( ) const

virtual

Return the nesting depth of the current node in the XML document. The root node has depth 0.

Implements balxml::Reader.

nodeHasValue()

bool balxml::Utf8ReaderWrapper::nodeHasValue ( ) const

virtual

Implements balxml::Reader.

nodeLocalName()

const char * balxml::Utf8ReaderWrapper::nodeLocalName ( ) const

virtual

Return the local name of the current node if the current node has a local name and NULL otherwise. The returned pointer is owned by this object and must not be modified or deallocated by the caller. The returned pointer becomes invalid upon the next advanceToNextNode, when close is called or the reader is destroyed.

Implements balxml::Reader.

nodeName()

const char * balxml::Utf8ReaderWrapper::nodeName ( ) const

virtual

Return the qualified name of the current node if the current node has a name and NULL otherwise. The returned pointer is owned by this object and must not be modified or deallocated by the caller. The returned pointer becomes invalid upon the next advanceToNextNode, when close is called or the reader is destroyed.

Implements balxml::Reader.

nodeNamespaceId()

int balxml::Utf8ReaderWrapper::nodeNamespaceId ( ) const

virtual

Return the namespace ID of the current node if the current node has a namespace id and a negative number otherwise.

Implements balxml::Reader.

nodeNamespaceUri()

const char * balxml::Utf8ReaderWrapper::nodeNamespaceUri ( ) const

virtual

Return the namespace URI name of the current node if the current node has a namespace URI and NULL otherwise. The returned pointer is owned by this object and must not be modified or deallocated by the caller. The returned pointer becomes invalid upon the next advanceToNextNode, when close is called or the reader is destroyed.

Implements balxml::Reader.

nodePrefix()

const char * balxml::Utf8ReaderWrapper::nodePrefix ( ) const

virtual

Return the prefix name of the current node if the correct node has a prefix name and NULL otherwise. The returned pointer is owned by this object and must not be modified or deallocated by the caller. The returned pointer becomes invalid upon the next advanceToNextNode, when close is called or the reader is destroyed.

Implements balxml::Reader.

nodeType()

NodeType balxml::Utf8ReaderWrapper::nodeType ( ) const

virtual

Return the node type of the current node if the reader isOpen and has not encounter an error and Reader::NONE otherwise.

Implements balxml::Reader.

nodeValue()

const char * balxml::Utf8ReaderWrapper::nodeValue ( ) const

virtual

Return the value of the current node if the current node has a value and NULL otherwise. The returned pointer is owned by this object and must not be modified or deallocated by the caller. The returned pointer becomes invalid upon the next advanceToNextNode, when close is called or the reader is destroyed.

Implements balxml::Reader.

numAttributes()

int balxml::Utf8ReaderWrapper::numAttributes ( ) const

virtual

Return the number of attributes for the current node if that node has attributes and 0 otherwise.

Implements balxml::Reader.

open() [1/3]

int balxml::Utf8ReaderWrapper::open ( bsl::streambuf *  stream, const char *  url = 0, const char *  encoding = 0  )

virtual

Set up the reader for parsing using the data contained in the specified (XML) stream, set the base URL to the optionally specified url and set the encoding value to the optionally specified encoding ("ASCII", "UTF-8", etc). Return 0 on success and non-zero otherwise. If url is null or a blank string is passed, then base URL will be empty. The encoding passed to Reader::open will take effect only when there is no encoding information in the original document, i.e., the encoding information obtained from the (XML) stream trumps all. If there is no encoding provided within the document and encoding is null or a blank string is passed, then set the encoding to the default "UTF-8". It is an error to open a reader that is already open. Note that the reader will not be on a valid node until advanceToNextNode is called.

Implements balxml::Reader.

open() [2/3]

int balxml::Utf8ReaderWrapper::open ( const char *  buffer, bsl::size_t  size, const char *  url = 0, const char *  encoding = 0  )

virtual

Set up the reader for parsing using the data contained in the specified (XML) buffer of the specified size, set the base URL to the optionally specified url and set the encoding value to the optionally specified encoding ("ASCII", "UTF-8", etc). Return 0 on success and non-zero otherwise. If url is null or a blank string is passed, then base URL will be empty. The encoding passed to Reader::open will take effect only when there is no encoding information in the original document, i.e., the encoding information obtained from the (XML) buffer trumps all. If there is no encoding provided within the document and encoding is null or a blank string is passed, then set the encoding to the default "UTF-8". It is an error to open a reader that is already open. Note that the reader will not be on a valid node until advanceToNextNode is called.

Implements balxml::Reader.

open() [3/3]

int balxml::Utf8ReaderWrapper::open ( const char *  filename, const char *  encoding = 0  )

virtual

Set up the reader for parsing using the data contained in the XML file described by the specified filename, and set the encoding value to the optionally specified encoding ("ASCII", "UTF-8", etc). Returns 0 on success and non-zero otherwise. The encoding passed to Reader::open will take effect only when there is no encoding information in the original document, i.e., the encoding information obtained from the XML file described by the filename trumps all. If there is no encoding provided within the document and encoding is null or a blank string is passed, then set the encoding to the default "UTF-8". It is an error to open a reader that is already open. Note that the reader will not be on a valid node until advanceToNextNode is called.

Implements balxml::Reader.

options()

unsigned int balxml::Utf8ReaderWrapper::options ( ) const

virtual

Implements balxml::Reader.

prefixStack()

PrefixStack * balxml::Utf8ReaderWrapper::prefixStack ( ) const

virtual

Return a pointer to the modifiable prefix stack that is used by this reader to manage namespace prefixes or 0 if namespace support is disabled. The behavior is undefined if the returned prefix stack is augmented in any way after calling open and before calling close.

Implements balxml::Reader.

resolver()

XmlResolverFunctor balxml::Utf8ReaderWrapper::resolver ( ) const

virtual

Implements balxml::Reader.

setOptions()

void balxml::Utf8ReaderWrapper::setOptions ( unsigned int  flags )

virtual

Set the options of the held reader to the flags in the specified flags. The options for the reader are persistent, i.e., the options are not reset by close. The behavior is undefined if this method is called after calling open and before calling close; except that derived classes are permitted to specify valid behavior for calling this function for specific arguments while the reader is open.

Implements balxml::Reader.

setPrefixStack()

void balxml::Utf8ReaderWrapper::setPrefixStack ( PrefixStack *  prefixes )

virtual

Set the prefix stack to the stack at the optionally specified prefixes address or disable prefix stack support if prefixes is null. This stack is used to push and pop namespace prefixes as the parse progresses, so that, at any point, the stack will reflect the set of active prefixes for the current node. It is legitimate to pass a stack that already contains prefixes, these prefixes shall be preserved when close is called, i.e., the prefix stack shall be returned to the stack depth it had when setPrefixStack was called. The behavior is undefined if this method is called after calling open and before calling close.

Implements balxml::Reader.

setResolver()

void balxml::Utf8ReaderWrapper::setResolver ( XmlResolverFunctor  resolver )

virtual

Set the external XML resource resolver to the specified resolver. The XML resource resolver is used by the balxml_reader to find and open an external resources (See the XmlResolverFunctor typedef for more details). The XML resource resolver remains valid; it is not affected by a call to close and should be available until the reader is destroyed. The behavior is undefined if this method is called after calling open and before calling close.

Implements balxml::Reader.

---

The documentation for this class was generated from the following file:

• balxml_utf8readerwrapper.h