Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

referenceTables.h File Reference

#include "xmlcpg.h"

Go to the source code of this file.

Functions

xmlcpgMapxmlcpgnewStaticDTDTable ()
 Generates a new Static DTD Table.

void xmlcpgputStaticDTDTable (xmlcpgObject *n, xmlcpgObject *v, xmlcpgObject *vs, xmlcpgObject *gert, xmlcpgObject *uet)
 Inserts an element into the Static DTD Table with its reference tables.

xmlcpgObjectxmlcpggetStaticDTD (xmlcpgObject *n)
 Gets the Static DTD map between version and the reference tables.

void xmlcpgsetReferenceTables (xmlcpgObject *rfs)
 Sets the reference tables.

ReferenceTablexmlcpgnewGEReferenceTable ()
 Generates a new General Entity Reference Table.

ReferenceTablexmlcpgnewPEReferenceTable ()
 Generates a new Parameter Entity Reference Table.

char xmlcpggetCharacterReferenceTable (int val)
 Gets the ascii character associated with the integer.

const char * xmlcpggetGEntity (const char *str)
 Gets the expansion for the string str from the General Entity Reference table.

void xmlcpgputGEntity (const char *key, const char *value)
 Puts an entry in the General Entity Reference table.

const char * xmlcpggetPEntity (const char *str)
 Gets the expansion for the string str from the Parameter Entity Reference table.

void xmlcpgputPEntity (const char *key, const char *value)
 Puts an entry in the Parameter Entity Reference table.

ReferenceTablexmlcpgnewEAIDTable ()
 Generates a new Element Attribute ID Table.

void xmlcpgclearEAIDTable ()
 Clears the Element Attribute ID Table.

void xmlcpgputEAIDTable (xmlcpgElement *e, const char *id)
 Inserts an element into the Element Attribute ID Table if it contains an ID.

xmlcpgMapxmlcpggetValidatorStructure (const char *n, const char *v)
 Gets the validator structure for the specified arguments.


Variables

xmlcpgMapstaticDTDTable
 The Static DTD Table.

xmlcpgMapvalidatorStructure
 The structure used to xmlcpgvalidate the document element after general xml validation procedure.

ReferenceTablePERTable
 The Parameter Entity Reference table.

ReferenceTableGERTable
 The General Entity Reference table.

ReferenceTableEAITable
 The Element Attribute ID Table.

xmlcpgMapUETable
 The map between unparsed entity name and it's value.


Function Documentation

void xmlcpgclearEAIDTable  
 

Clears the Element Attribute ID Table.

char xmlcpggetCharacterReferenceTable int    val
 

Gets the ascii character associated with the integer.

Parameters:
val  the integer value to convert.
Returns:
the ascii character corresponding.

const char* xmlcpggetGEntity const char *    str
 

Gets the expansion for the string str from the General Entity Reference table.

Parameters:
str  the reference representation.
Returns:
the replacement string.

const char* xmlcpggetPEntity const char *    str
 

Gets the expansion for the string str from the Parameter Entity Reference table.

Parameters:
str  the reference representation.
Returns:
the expansion string.

xmlcpgObject* xmlcpggetStaticDTD xmlcpgObject   n
 

Gets the Static DTD map between version and the reference tables.

Parameters:
n  the name of the root element of the DTD.
Returns:
the version and reference tables's map.

xmlcpgMap* xmlcpggetValidatorStructure const char *    n,
const char *    v
 

Gets the validator structure for the specified arguments.

If the validator structure is not found NULL is returned.

Parameters:
n  the name of the static DTD.
v  the version number of the static DTD
Returns:
the validator structure or NULL if it is not in the StaticDTD Table.

ReferenceTable* xmlcpgnewEAIDTable  
 

Generates a new Element Attribute ID Table.

Returns:
the new generated reference table.

ReferenceTable* xmlcpgnewGEReferenceTable  
 

Generates a new General Entity Reference Table.

Returns:
the new generated reference table.

ReferenceTable* xmlcpgnewPEReferenceTable  
 

Generates a new Parameter Entity Reference Table.

Returns:
the new generated reference table.

xmlcpgMap* xmlcpgnewStaticDTDTable  
 

Generates a new Static DTD Table.

Returns:
the new generated reference table.

void xmlcpgputEAIDTable xmlcpgElement   e,
const char *    id
 

Inserts an element into the Element Attribute ID Table if it contains an ID.

The function checks the Validity Constraint: ID before inserting it.

Parameters:
e  the element object.
id  the ID value of the element.

void xmlcpgputGEntity const char *    key,
const char *    value
 

Puts an entry in the General Entity Reference table.

Parameters:
key  the GE literal entity value.
value  the GE replacement text.

void xmlcpgputPEntity const char *    key,
const char *    value
 

Puts an entry in the Parameter Entity Reference table.

Parameters:
key  the PE literal entity value.
value  the PE replacement text.

void xmlcpgputStaticDTDTable xmlcpgObject   n,
xmlcpgObject   v,
xmlcpgObject   vs,
xmlcpgObject   gert,
xmlcpgObject   uet
 

Inserts an element into the Static DTD Table with its reference tables.

Parameters:
n  the name of the root element of the DTD.
v  the version string of the DTD.
vs  the validator structure.
gert  the general entity reference table.
uet  the unparsed element table.

void xmlcpgsetReferenceTables xmlcpgObject   rfs
 

Sets the reference tables.

Parameters:
rfs  the list of reference tables as shown above.


Variable Documentation

ReferenceTable* EAITable
 

The Element Attribute ID Table.

ReferenceTable* GERTable
 

The General Entity Reference table.

ReferenceTable* PERTable
 

The Parameter Entity Reference table.

xmlcpgMap* staticDTDTable
 

The Static DTD Table.

This table is modeled like this:

((<root name> (<version string> (<validator structure> <general entity reference table> <unparsed entity table>)) (<version string> (...))) (<root name> (...)))

xmlcpgMap* UETable
 

The map between unparsed entity name and it's value.

xmlcpgMap* validatorStructure
 

The structure used to xmlcpgvalidate the document element after general xml validation procedure.

The map is defined like this: the keys are element name and contains the content specification and a map of the attribute definitions. The attribute definition map key is the attribute definition name and it's data is pair containing the attribute type and the default declaration. <par> Element Map ((<element name> (<content specification> . ;;;; Attribute Definition Map ((<attribute definition name> . (<attribute type> . <default declaration>)) ...))) ...) </par>


Generated on Tue Nov 11 14:59:52 2003 for xmlcpg by doxygen1.2.18