Base class for document handling (see XML Spec [1]).

Inheritance:

Public Fields

XMLIO_string	characters Buffer to store all incoming characters.
XMLIO_Element*	current_element Current element, which gets all characters and start tag events for further processing.
XMLIO_stack<XMLIO_Element*>	element_stack Stack with all elements.
char*	indent Blanks ('current_indent' many).

Public Methods

	XMLIO_Document () Constructor.
virtual	~XMLIO_Document () Destructor.
virtual const char*	toString () const Returns name of class.
void	changeIndent (int change) Changes current indentation by given value.
void	setIndent (int new_indent) Sets current indentation to given value.
int	close () Closes file and clears stack.
int	flush () const Flushes file stream.
int	open (const XMLIO_string& filename, const XMLIO_string& access_mode) Opens XML file with given filename.
int	open (FILE* file, const XMLIO_string& my_access_mode) Uses given C stream for input or output of document.
int	readDocument () Reads opened file and passes events to appropriate XML_Element objects.
int	write (const XMLIO_strstream& char_data) const Writes character data (XML Spec [14]) from a strstream to file.
int	write (const XMLIO_string& char_data) const Writes character data (XML Spec [14]) from a string to file.
int	write (const char* text) const Writes character data (XML Spec [14]) to file.
int	writef (const char* templ, ...) const Writes character data (XML Spec [14]) to file and behaves like fprintf.
int	writeEndl () const Writes \n character and flushes buffer.
int	writeEndlIndent () const Writes \n character, flushes buffer and writes indentation of the following line.
int	writeElement (XMLIO_Element* element) Writes an element (XML Spec [39]).
int	writeComment (const char* templ, ... ) const Writes a comment to file.
int	writeCDSect (const XMLIO_string& CDSect) const Writes a character data section to file.
int	writeIndent () const Writes indentation.
int	writeEndTag (const XMLIO_string& tag) const Writes '</tagName>' to file (XML Spec [42]).
int	writeStartTag (const XMLIO_string& tag) const Writes '<tagName>' to file (XML Spec [40]).
int	writeStartTag (const XMLIO_string& tag, const XMLIO_Attributes& attributes) const Writes '<tagName attr1="key1" attr2="key2" .

Protected Fields

XMLIO_string

xml_filename Name of opened file.

Protected Methods

virtual int	XMLIO_writeProlog () Writes the XML prolog (XML spec [22]).
virtual int	XMLIO_writeXMLDeclaration () Writes the XML declaration (first line in file) (XML specs [23]).
virtual int	XMLIO_writeDocTypeDeclaration () Writes the Document Type Declaration (XML specs [28]).
virtual int	XMLIO_writeTrailer () Is called when a document is closed and writes an optional trailer, which must be of Misc-type (XML specs [27]) after the main element (XML specs [1]).

Private Fields

FILE*	xml_file XML file stream.
XMLIO_AccessMode	access_mode Access mode.
XMLIO_FileType	xml_file_type Type of opened file.
mutable int	current_indent Current number of blanks for indentation.
char*	indent_block Memory chunk with blanks and trailing \0.

Private Methods

int	writeAttribute (const XMLIO_string& key, const XMLIO_string& value) const Writes 'attr="key"' to file (XML Spec [41]).
int	writeAttributes (const XMLIO_Attributes& attributes) const Writes 'attr1="key1" attr2="key2" .
int	writeEmptyElement (const XMLIO_string& tag) const Writes '<tagName/>' to file (XML Spec [44]).
int	writeEmptyElement (const XMLIO_string& tag, const XMLIO_Attributes& attributes) const Writes '<tagName attr1="key1" attr2="key2" .

Private Members

enum	XMLIO_AccessMode READ: File opened for reading.
enum	XMLIO_FileType File types which can be processed by xmlio.

Inherited from XMLIO_Element:

Public Fields

XMLIO_string tag

XMLIO_Attributes attributes

XMLIO_IndentationType xmlio_indent_type

Public Methods

virtual XMLIO_Element* XMLIO_startTag(const XMLIO_string& tag, XMLIO_Attributes &attrs)

virtual void XMLIO_endTag(const XMLIO_string& tag)

virtual void XMLIO_getCharacters(const XMLIO_string& characters)

virtual void XMLIO_getComment(const XMLIO_string& comment)

virtual void XMLIO_getProcessingInstruction(const XMLIO_string& target, const XMLIO_string& instructions)

virtual void XMLIO_finishedReading()

virtual bool XMLIO_remove() const

virtual const int XMLIO_writeContent(XMLIO_Document& doc)

virtual const XMLIO_string& XMLIO_getName() const

virtual XMLIO_Attributes& XMLIO_getAttributes()

virtual bool XMLIO_isEmpty() const

virtual void print() const

Documentation

Base class for document handling (see XML Spec [1]). This is not the root element, the root element should be instatiated in XMLIO_startTag The prolog is not yet fully supported.

enum XMLIO_AccessMode

READ: File opened for reading. WRITE: File opened for writing. NONE: No file opened.

enum XMLIO_FileType

File types which can be processed by xmlio. XMLIO_FT_FILE: Usual file. XMLIO_FT_CSTREAM: C stream (no need to open and close).

XMLIO_Document()

Constructor.

virtual ~XMLIO_Document()

Destructor.

virtual const char* toString() const

Returns name of class. @depreciated

void changeIndent(int change)

Changes current indentation by given value.

void setIndent(int new_indent)

Sets current indentation to given value.

int close()

Closes file and clears stack. Will be called automatically when destructor is called or a new file is opened. Returns fclose error code if 0 if no error occured.

int flush() const

Flushes file stream. Returns error code of fflush or 0 if no error occured.

int open(const XMLIO_string& filename, const XMLIO_string& access_mode)

Opens XML file with given filename. Access mode can either be "r" for reading or "w" for writing.

Returns:

Returns 0 on success or 1 otherwise.

int open(FILE* file, const XMLIO_string& my_access_mode)

Uses given C stream for input or output of document. Access mode can either be "r" for reading or "w" for writing.

Returns:

Returns 0 on success or 1 otherwise.

int readDocument()

Reads opened file and passes events to appropriate XML_Element objects. Initially all data will be passed to the XMLIO_Document which itself is a XMLIO_Element.

Returns:

Returns 0 on success or an error code otherwise.

int write(const XMLIO_strstream& char_data) const

Writes character data (XML Spec [14]) from a strstream to file. Returns number of bytes written or fprintf error code.

int write(const XMLIO_string& char_data) const

Writes character data (XML Spec [14]) from a string to file. Returns number of bytes written or fprintf error code.

int write(const char* text) const

Writes character data (XML Spec [14]) to file.

Returns:

Returns number of bytes written or fprintf error code.

int writef(const char* templ, ...) const

Writes character data (XML Spec [14]) to file and behaves like fprintf.

Returns:

Returns number of bytes written or fprintf error code.

int writeEndl() const

Writes \n character and flushes buffer. Returns nr of bytes written or an negative error code.

int writeEndlIndent() const

Writes \n character, flushes buffer and writes indentation of the following line. Returns nr of bytes written or an negative error code.

int writeElement(XMLIO_Element* element)

Writes an element (XML Spec [39]). XMLIO_isEmpty() decides, whether an EmptyElement (XML Spec [44]) or StartTag, content and EndTag (XML Spec [40]-[43]) are used. If XMLIO_isEmpty() is true, element.XMLIO_writeContent(*this) is called. The correct way is the use of an iterator to access the elements content, but this is easier.

Returns:

Returns number of bytes written or an error code.

int writeComment(const char* templ, ... ) const

Writes a comment to file. (XML Spec [15]) Returns number of bytes written or an error code.

int writeCDSect(const XMLIO_string& CDSect) const

Writes a character data section to file. (XML Spec [18]-[21]) Returns number of bytes written or an error code.

int writeIndent() const

Writes indentation. Returns number of bytes written or an error code.

int writeEndTag(const XMLIO_string& tag) const

Writes '</tagName>' to file (XML Spec [42]).

Returns:

Returns the negative value of fprintf on error, otherwise the number of bytes written (>=0).

int writeStartTag(const XMLIO_string& tag) const

Writes '<tagName>' to file (XML Spec [40]).

Returns:

Returns the negative value of fprintf on error, otherwise the number of bytes written (>=0).

int writeStartTag(const XMLIO_string& tag, const XMLIO_Attributes& attributes) const

Writes '<tagName attr1="key1" attr2="key2" . >' to file (XML Spec [40]).

Returns:

Returns the negative value of fprintf on error, otherwise the number of bytes written (>=0).

XMLIO_string characters

Buffer to store all incoming characters. This data will be send to current element at a) start tags, b) end tags, c) end of document.

XMLIO_Element* current_element

Current element, which gets all characters and start tag events for further processing.

XMLIO_stack<XMLIO_Element*> element_stack

Stack with all elements. In case of an end tag the top element of the stack will become active. The previous 'current element' will not get any futher anymore. Just the endTag() function is called to tell the previous 'current element' that it won't get any more data.

char* indent

Blanks ('current_indent' many).

virtual int XMLIO_writeProlog()

Writes the XML prolog (XML spec [22]). Only XMLDecl (XML specs [23]-[26]) is supported by calling XMLIO_writeXMLDeclaration()

Returns:

Returns nr of bytes written or an negative error code.

virtual int XMLIO_writeXMLDeclaration()

Writes the XML declaration (first line in file) (XML specs [23]). This is constant now: '<?xml version="1.0" encoding="ISO-8859-1"?>'.

Returns:

Returns number of bytes written or error code of fprintf.

virtual int XMLIO_writeDocTypeDeclaration()

Writes the Document Type Declaration (XML specs [28]). Returns number of bytes written or error code. By default does nothing and returns NULL.

virtual int XMLIO_writeTrailer()

Is called when a document is closed and writes an optional trailer, which must be of Misc-type (XML specs [27]) after the main element (XML specs [1]). By default this writes a newline character.

Returns:

Returns nr of bytes written or an negative error code.

XMLIO_string xml_filename

Name of opened file.

int writeAttribute(const XMLIO_string& key, const XMLIO_string& value) const

Writes 'attr="key"' to file (XML Spec [41]).

Returns:

Returns the negative value of fprintf on error, otherwise the number of bytes written (>=0).

int writeAttributes(const XMLIO_Attributes& attributes) const

Writes 'attr1="key1" attr2="key2" . ' to file (XML Spec [40]).

Returns:

Returns the negative value of fprintf on error, otherwise the number of bytes written (>=0).

int writeEmptyElement(const XMLIO_string& tag) const

Writes '<tagName/>' to file (XML Spec [44]).

Returns:

Returns the negative value of fprintf on error, otherwise the number of written bytes (>=0).

int writeEmptyElement(const XMLIO_string& tag, const XMLIO_Attributes& attributes) const

Writes '<tagName attr1="key1" attr2="key2" . />' to file (XML Spec [44]).

Returns:

Returns the negative error code of fprintf on error, otherwise the number of bytes written (>=0).

FILE* xml_file

XML file stream.

XMLIO_AccessMode access_mode

Access mode.

XMLIO_FileType xml_file_type

Type of opened file.

mutable int current_indent

Current number of blanks for indentation.

char* indent_block

Memory chunk with blanks and trailing \0.

Direct child classes:

ClusteringReader
XMLIO_ElementReader

Alphabetic index HTML hierarchy of classes or Java