Class CMDXMLParser

class CMDXMLParser : public CActive;

Description

Creates a DOM structure from a given XML file.

The parsing operation is asynchronous and is initiated by a call to ParseFile(). On completion, the created DOM document can be retrieved through DetachXMLDoc().

Note the following ownership rules for the DOM document:

1. calling DetachXMLDoc() transfers ownership of the document to the client

2. if the parser is asked to parse a new file while it still owns an existing DOM document, it will delete the old document.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CActive - The core class of the active object abstraction

• CMDXMLParser - Creates a DOM structure from a given XML file

Members

Defined in CMDXMLParser:
CreateDocumentL(), DetachXMLDoc(), DoCancel(), EAscii, EUnicode, Error(), ErrorSeverity(), HandleTextL(), NewL(), NewL(), NewLC(), NewLC(), ParseFile(), ParseFile(), ParseSource(), ParseStartTagL(), RunError(), RunL(), SetEntityConverter(), SetSourceCharacterWidth(), SetStoreInvalid(), TMDXMLParserInputCharWidth, ~CMDXMLParser()

Inherited from CActive:
Cancel(), Deque(), EPriorityHigh, EPriorityIdle, EPriorityLow, EPriorityStandard, EPriorityUserInput, Extension_(), IsActive(), IsAdded(), Priority(), SetActive(), SetPriority(), TPriority, iStatus

Inherited from CBase:
Delete(), operator new()

static IMPORT_C CMDXMLParser *NewL(MMDXMLParserObserver *aParserObserver);

Description

Allocates and constructs a new XML parser, specifying a DTD.

Parameters

MMDXMLParserObserver *aParserObserver XML parser observer

Return value

CMDXMLParser * New XML parser

Leave codes

KErrNoMemory Out of memory

static IMPORT_C CMDXMLParser *NewL(MMDXMLParserObserver *aParserObserver, MXMLDtd *aDtdRepresentation);

Description

Allocates and constructs a new XML parser, specifying a DTD.

Parameters

MMDXMLParserObserver *aParserObserver XML parser observer MXMLDtd *aDtdRepresentation DTD validator

Return value

CMDXMLParser * New XML parser

Leave codes

KErrNoMemory Out of memory

static IMPORT_C CMDXMLParser *NewLC(MMDXMLParserObserver *aParserObserver);

Description

Allocates and constructs a new XML parser, leaving the object on the cleanup stack.

Parameters

MMDXMLParserObserver *aParserObserver XML parser observer

Return value

CMDXMLParser * New XML parser

Leave codes

KErrNoMemory Out of memory

static IMPORT_C CMDXMLParser *NewLC(MMDXMLParserObserver *aParserObserver, MXMLDtd *aDtdRepresentation);

Description

Allocates and constructs a new XML parser, leaving the object on the cleanup stack.

Parameters

MMDXMLParserObserver *aParserObserver XML parser observer MXMLDtd *aDtdRepresentation DTD validator

Return value

CMDXMLParser * New XML parser

Leave codes

KErrNoMemory Out of memory

IMPORT_C ~CMDXMLParser();

Description

Destructor.

IMPORT_C TInt Error() const;

Description

Gets the last error found by the parser.

Return value

TInt Error code

IMPORT_C TXMLErrorCodeSeverity ErrorSeverity() const;

Description

Get the severity of the most severe error found.

Return value

TXMLErrorCodeSeverity the maximum error severity

IMPORT_C CMDXMLDocument *DetachXMLDoc();

Description

Gets the created DOM.

This should be called after the conclusion of the parser process.

Note that the function sets the internal variable pointing to the document to NULL, so this function can only be called once per file parse. The caller takes ownership of the document, and must delete it when its use is complete.

Return value

CMDXMLDocument * The created DOM

IMPORT_C TInt ParseFile(RFs aRFs, const TDesC &aFileToParse);

Description

Parses a specified XML file into a DOM object tree.

Parameters

RFs aRFs File server session const TDesC &aFileToParse The file name to parse

Return value

TInt KErrNone if success or a file read error code

IMPORT_C TInt ParseFile(RFile &aFileHandleToParse);

Description

Parses a specified XML file into a DOM object tree.

Parses a specified XML file into a DOM object tree using an open file handle. The parser takes ownership of the open file handle and will close handle when completed.

Parameters

RFile &aFileHandleToParse An open file handle for the file to parse. Ownership of the file handle is passed.

Return value

TInt KErrNone if successful.

IMPORT_C void ParseSource(MMDXMLParserDataProvider *aSource);

Description

Parses a specified XML Data Source into a DOM object tree.

Parameters

MMDXMLParserDataProvider *aSource MMDXMLParserDataProvider pointer

IMPORT_C void SetSourceCharacterWidth(TMDXMLParserInputCharWidth aWidth);

Description

Sets the input stream character width.

Parameters

TMDXMLParserInputCharWidth aWidth Character width for incoming stream. Possible values are EAscii and EUnicode (representing Ascii/UTF8 and Unicode respectively).

IMPORT_C void SetEntityConverter(CMDXMLEntityConverter *aEntityConverter);

Description

Sets the entity converter to be used for parsing. and take ownership of the passed entity converter

Parameters

CMDXMLEntityConverter *aEntityConverter the entity converter to be used.

IMPORT_C void SetStoreInvalid(TBool aStoreInvalid);

Description

Controls whether invalid elements and attributes are added to the DOM.

Parameters

TBool aStoreInvalid ETrue if invalid content should be stored, EFalse otherwise.

private: virtual IMPORT_C void DoCancel();

Description

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel().

private: virtual void RunL();

Description

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's RunL() or RunError() functions.

private: virtual IMPORT_C TInt RunError(TInt aError);

Description

Parameters

TInt aError

Return value

TInt

private: virtual void HandleTextL(TDes &aChar);

Description

Parameters

TDes &aChar

private: virtual CMDXMLElement *ParseStartTagL();

Description

Return value

CMDXMLElement *

private: virtual void CreateDocumentL();

Description

TMDXMLParserInputCharWidth

Description

Defines input stream character widths.

EAscii ASCII. EUnicode Unicode.