Library: XML
Package: XML
Header: Poco/XML/ParserEngine.h
This class provides an object-oriented, stream-based, low-level interface to the XML Parser Toolkit (expat). It is strongly recommended, that you use the SAX parser classes (which are based on this class) instead of this class, since they provide a standardized, higher-level interface to the parser.
Direct Base Classes: Locator
All Base Classes: Locator
Member Functions: addEncoding, convert, getColumnNumber, getContentHandler, getDTDHandler, getDeclHandler, getEnablePartialReads, getEncoding, getEntityResolver, getErrorHandler, getExpandInternalEntities, getExternalGeneralEntities, getExternalParameterEntities, getLexicalHandler, getLineNumber, getNamespaceStrategy, getPublicId, getSystemId, handleCharacterData, handleComment, handleDefault, handleEndCdataSection, handleEndDoctypeDecl, handleEndElement, handleEndNamespaceDecl, handleEntityDecl, handleError, handleExternalEntityRef, handleExternalParsedEntityDecl, handleInternalParsedEntityDecl, handleNotationDecl, handleProcessingInstruction, handleSkippedEntity, handleStartCdataSection, handleStartDoctypeDecl, handleStartElement, handleStartNamespaceDecl, handleUnknownEncoding, handleUnparsedEntityDecl, init, locator, parse, parseByteInputStream, parseCharInputStream, parseExternal, parseExternalByteInputStream, parseExternalCharInputStream, popContext, pushContext, readBytes, readChars, resetContext, setContentHandler, setDTDHandler, setDeclHandler, setEnablePartialReads, setEncoding, setEntityResolver, setErrorHandler, setExpandInternalEntities, setExternalGeneralEntities, setExternalParameterEntities, setLexicalHandler, setNamespaceStrategy
Inherited Functions: getColumnNumber, getLineNumber, getPublicId, getSystemId
ParserEngine();
Creates the parser engine.
ParserEngine(
const XMLString & encoding
);
Creates the parser engine and passes the encoding to the underlying parser.
~ParserEngine();
Destroys the parser.
void addEncoding(
const XMLString & name,
Poco::TextEncoding * pEncoding
);
Adds an encoding to the parser.
int getColumnNumber() const;
Return the column number where the current document event ends.
See also: Poco::XML::Locator::getColumnNumber()
ContentHandler * getContentHandler() const;
Return the current content handler.
DTDHandler * getDTDHandler() const;
Return the current DTD handler.
DeclHandler * getDeclHandler() const;
Return the current DTD declarations handler.
bool getEnablePartialReads() const;
Returns true if partial reads are enabled (see setEnablePartialReads()), false otherwise.
const XMLString & getEncoding() const;
Returns the encoding used by expat.
EntityResolver * getEntityResolver() const;
Return the current entity resolver.
ErrorHandler * getErrorHandler() const;
Return the current error handler.
bool getExpandInternalEntities() const;
Returns true if internal entities will be expanded automatically, which is the default.
bool getExternalGeneralEntities() const;
Returns true if external general entities will be processed; false otherwise.
bool getExternalParameterEntities() const;
Returns true if external parameter entities will be processed; false otherwise.
LexicalHandler * getLexicalHandler() const;
Return the current lexical handler.
int getLineNumber() const;
Return the line number where the current document event ends.
See also: Poco::XML::Locator::getLineNumber()
NamespaceStrategy * getNamespaceStrategy() const;
Returns the NamespaceStrategy currently in use.
XMLString getPublicId() const;
Return the public identifier for the current document event.
See also: Poco::XML::Locator::getPublicId()
XMLString getSystemId() const;
Return the system identifier for the current document event.
See also: Poco::XML::Locator::getSystemId()
void parse(
InputSource * pInputSource
);
Parse an XML document from the given InputSource.
void parse(
const char * pBuffer,
std::size_t size
);
Parses an XML document from the given buffer.
void setContentHandler(
ContentHandler * pContentHandler
);
Allow an application to register a content event handler.
void setDTDHandler(
DTDHandler * pDTDHandler
);
Allow an application to register a DTD event handler.
void setDeclHandler(
DeclHandler * pDeclHandler
);
Allow an application to register a DTD declarations event handler.
void setEnablePartialReads(
bool flag = true
);
Enable or disable partial reads from the input source.
This is useful for parsing XML from a socket stream for a protocol like XMPP, where basically single elements are read one at a time from the input source's stream, and following elements depend upon responses sent back to the peer.
Normally, the parser always reads blocks of PARSE_BUFFER_SIZE at a time, and blocks until a complete block has been read (or the end of the stream has been reached). This allows for efficient parsing of "complete" XML documents, but fails in a case such as XMPP, where only XML fragments are sent at a time.
void setEncoding(
const XMLString & encoding
);
Sets the encoding used by expat. The encoding must be set before parsing begins, otherwise it will be ignored.
void setEntityResolver(
EntityResolver * pResolver
);
Allow an application to register an entity resolver.
void setErrorHandler(
ErrorHandler * pErrorHandler
);
Allow an application to register an error event handler.
void setExpandInternalEntities(
bool flag = true
);
Enables/disables expansion of internal entities (enabled by default). If entity expansion is disabled, internal entities are reported via the default handler. Must be set before parsing begins, otherwise it will be ignored.
void setExternalGeneralEntities(
bool flag = true
);
Enable or disable processing of external general entities.
void setExternalParameterEntities(
bool flag = true
);
Enable or disable processing of external parameter entities.
void setLexicalHandler(
LexicalHandler * pLexicalHandler
);
Allow an application to register a lexical event handler.
void setNamespaceStrategy(
NamespaceStrategy * pStrategy
);
Sets the NamespaceStrategy used by the parser. The parser takes ownership of the strategy object and deletes it when it's no longer needed. The default is NoNamespacesStrategy.
static int convert(
void * data,
const char * s
);
static void handleCharacterData(
void * userData,
const XML_Char * s,
int len
);
static void handleComment(
void * userData,
const XML_Char * data
);
static void handleDefault(
void * userData,
const XML_Char * s,
int len
);
static void handleEndCdataSection(
void * userData
);
static void handleEndDoctypeDecl(
void * userData
);
static void handleEndElement(
void * userData,
const XML_Char * name
);
static void handleEndNamespaceDecl(
void * userData,
const XML_Char * prefix
);
static void handleEntityDecl(
void * userData,
const XML_Char * entityName,
int isParamEntity,
const XML_Char * value,
int valueLength,
const XML_Char * base,
const XML_Char * systemId,
const XML_Char * publicId,
const XML_Char * notationName
);
void handleError(
int errorNo
);
Throws an XMLException with a message corresponding to the given Expat error code.
static int handleExternalEntityRef(
XML_Parser parser,
const XML_Char * openEntityNames,
const XML_Char * base,
const XML_Char * systemId,
const XML_Char * publicId
);
static void handleExternalParsedEntityDecl(
void * userData,
const XML_Char * entityName,
const XML_Char * base,
const XML_Char * systemId,
const XML_Char * publicId
);
static void handleInternalParsedEntityDecl(
void * userData,
const XML_Char * entityName,
const XML_Char * replacementText,
int replacementTextLength
);
static void handleNotationDecl(
void * userData,
const XML_Char * notationName,
const XML_Char * base,
const XML_Char * systemId,
const XML_Char * publicId
);
static void handleProcessingInstruction(
void * userData,
const XML_Char * target,
const XML_Char * data
);
static void handleSkippedEntity(
void * userData,
const XML_Char * entityName,
int isParameterEntity
);
static void handleStartCdataSection(
void * userData
);
static void handleStartDoctypeDecl(
void * userData,
const XML_Char * doctypeName,
const XML_Char * systemId,
const XML_Char * publicId,
int hasInternalSubset
);
static void handleStartElement(
void * userData,
const XML_Char * name,
const XML_Char * * atts
);
static void handleStartNamespaceDecl(
void * userData,
const XML_Char * prefix,
const XML_Char * uri
);
static int handleUnknownEncoding(
void * encodingHandlerData,
const XML_Char * name,
XML_Encoding * info
);
static void handleUnparsedEntityDecl(
void * userData,
const XML_Char * entityName,
const XML_Char * base,
const XML_Char * systemId,
const XML_Char * publicId,
const XML_Char * notationName
);
void init();
initializes expat
const Locator & locator() const;
Returns a locator denoting the current parse location.
void parseByteInputStream(
XMLByteInputStream & istr
);
Parses an entity from the given stream.
void parseCharInputStream(
XMLCharInputStream & istr
);
Parses an entity from the given stream.
void parseExternal(
XML_Parser extParser,
InputSource * pInputSource
);
Parse an XML document from the given InputSource.
void parseExternalByteInputStream(
XML_Parser extParser,
XMLByteInputStream & istr
);
Parses an external entity from the given stream, with a separate parser.
void parseExternalCharInputStream(
XML_Parser extParser,
XMLCharInputStream & istr
);
Parses an external entity from the given stream, with a separate parser.
void popContext();
Pops the top-most entry from the context stack.
void pushContext(
XML_Parser parser,
InputSource * pInputSource
);
Pushes a new entry to the context stack.
std::streamsize readBytes(
XMLByteInputStream & istr,
char * pBuffer,
std::streamsize bufferSize
);
Reads at most bufferSize bytes from the given stream into the given buffer.
std::streamsize readChars(
XMLCharInputStream & istr,
XMLChar * pBuffer,
std::streamsize bufferSize
);
Reads at most bufferSize chars from the given stream into the given buffer.
void resetContext();
Resets and clears the context stack.