globals		API documentation		The XML C parser and toolkit of Gnome	list

This module implements the hash table support used in various places in the library.

Table of Contents

#define XML_CAST_FPTR

Structure xmlHashTable
struct _xmlHashTable
The content of this structure is not made public by the API.

Typedef xmlHashTable * xmlHashTablePtr

int	xmlHashAddEntry			(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 void * userdata)

int	xmlHashAddEntry2		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 void * userdata)

int	xmlHashAddEntry3		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 const xmlChar * name3, 
					 void * userdata)

Function type: xmlHashCopier
void *	xmlHashCopier			(void * payload, 
					 xmlChar * name)

xmlHashTablePtr	xmlHashCopy		(xmlHashTablePtr table, 
					 xmlHashCopier f)

xmlHashTablePtr	xmlHashCreate		(int size)

xmlHashTablePtr	xmlHashCreateDict	(int size, 
					 xmlDictPtr dict)

Function type: xmlHashDeallocator
void	xmlHashDeallocator		(void * payload, 
					 xmlChar * name)

void	xmlHashFree			(xmlHashTablePtr table, 
					 xmlHashDeallocator f)

void *	xmlHashLookup			(xmlHashTablePtr table, 
					 const xmlChar * name)

void *	xmlHashLookup2			(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2)

void *	xmlHashLookup3			(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 const xmlChar * name3)

void *	xmlHashQLookup			(xmlHashTablePtr table, 
					 const xmlChar * prefix, 
					 const xmlChar * name)

void *	xmlHashQLookup2			(xmlHashTablePtr table, 
					 const xmlChar * prefix, 
					 const xmlChar * name, 
					 const xmlChar * prefix2, 
					 const xmlChar * name2)

void *	xmlHashQLookup3			(xmlHashTablePtr table, 
					 const xmlChar * prefix, 
					 const xmlChar * name, 
					 const xmlChar * prefix2, 
					 const xmlChar * name2, 
					 const xmlChar * prefix3, 
					 const xmlChar * name3)

int	xmlHashRemoveEntry		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 xmlHashDeallocator f)

int	xmlHashRemoveEntry2		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 xmlHashDeallocator f)

int	xmlHashRemoveEntry3		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 const xmlChar * name3, 
					 xmlHashDeallocator f)

void	xmlHashScan			(xmlHashTablePtr table, 
					 xmlHashScanner f, 
					 void * data)

void	xmlHashScan3			(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 const xmlChar * name3, 
					 xmlHashScanner f, 
					 void * data)

void	xmlHashScanFull			(xmlHashTablePtr table, 
					 xmlHashScannerFull f, 
					 void * data)

void	xmlHashScanFull3		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 const xmlChar * name3, 
					 xmlHashScannerFull f, 
					 void * data)

Function type: xmlHashScanner
void	xmlHashScanner			(void * payload, 
					 void * data, 
					 xmlChar * name)

Function type: xmlHashScannerFull
void	xmlHashScannerFull		(void * payload, 
					 void * data, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 const xmlChar * name3)

int	xmlHashSize			(xmlHashTablePtr table)

int	xmlHashUpdateEntry		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 void * userdata, 
					 xmlHashDeallocator f)

int	xmlHashUpdateEntry2		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 void * userdata, 
					 xmlHashDeallocator f)

int	xmlHashUpdateEntry3		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 const xmlChar * name3, 
					 void * userdata, 
					 xmlHashDeallocator f)

Description

Macro: XML_CAST_FPTR

#define XML_CAST_FPTR

Macro to do a casting from an object pointer to a function pointer without encountering a warning from gcc #define XML_CAST_FPTR(fptr) (*(void **)(&fptr)) This macro violated ISO C aliasing rules (gcc4 on s390 broke) so it is disabled now

Structure xmlHashTable

Structure xmlHashTable
struct _xmlHashTable {
The content of this structure is not made public by the API.
}

Function: xmlHashAddEntry

int	xmlHashAddEntry			(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 void * userdata)

Add the @userdata to the hash @table. This can later be retrieved by using the @name. Duplicate names generate errors.

Function: xmlHashAddEntry2

int	xmlHashAddEntry2		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 void * userdata)

Add the @userdata to the hash @table. This can later be retrieved by using the (@name, @name2) tuple. Duplicate tuples generate errors.

Function: xmlHashAddEntry3

int	xmlHashAddEntry3		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 const xmlChar * name3, 
					 void * userdata)

Add the @userdata to the hash @table. This can later be retrieved by using the tuple (@name, @name2, @name3). Duplicate entries generate errors.

Function type: xmlHashCopier

Function type: xmlHashCopier
void *	xmlHashCopier			(void * payload, 
					 xmlChar * name)

Callback to copy data from a hash.

Function: xmlHashCopy

xmlHashTablePtr	xmlHashCopy		(xmlHashTablePtr table, 
					 xmlHashCopier f)

Scan the hash @table and applied @f to each value.

Function: xmlHashCreate

xmlHashTablePtr	xmlHashCreate		(int size)

Create a new xmlHashTablePtr.

Function: xmlHashCreateDict

xmlHashTablePtr	xmlHashCreateDict	(int size, 
					 xmlDictPtr dict)

Create a new xmlHashTablePtr which will use @dict as the internal dictionary

Function type: xmlHashDeallocator

Function type: xmlHashDeallocator
void	xmlHashDeallocator		(void * payload, 
					 xmlChar * name)

Callback to free data from a hash.

Function: xmlHashFree

void	xmlHashFree			(xmlHashTablePtr table, 
					 xmlHashDeallocator f)

Free the hash @table and its contents. The userdata is deallocated with @f if provided.

Function: xmlHashLookup

void *	xmlHashLookup			(xmlHashTablePtr table, 
					 const xmlChar * name)

Find the userdata specified by the @name.

Function: xmlHashLookup2

void *	xmlHashLookup2			(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2)

Find the userdata specified by the (@name, @name2) tuple.

Function: xmlHashLookup3

void *	xmlHashLookup3			(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 const xmlChar * name3)

Find the userdata specified by the (@name, @name2, @name3) tuple.

Function: xmlHashQLookup

void *	xmlHashQLookup			(xmlHashTablePtr table, 
					 const xmlChar * prefix, 
					 const xmlChar * name)

Find the userdata specified by the QName @prefix:@name/@name.

Function: xmlHashQLookup2

void *	xmlHashQLookup2			(xmlHashTablePtr table, 
					 const xmlChar * prefix, 
					 const xmlChar * name, 
					 const xmlChar * prefix2, 
					 const xmlChar * name2)

Find the userdata specified by the QNames tuple

Function: xmlHashQLookup3

void *	xmlHashQLookup3			(xmlHashTablePtr table, 
					 const xmlChar * prefix, 
					 const xmlChar * name, 
					 const xmlChar * prefix2, 
					 const xmlChar * name2, 
					 const xmlChar * prefix3, 
					 const xmlChar * name3)

Find the userdata specified by the (@name, @name2, @name3) tuple.

Function: xmlHashRemoveEntry

int	xmlHashRemoveEntry		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 xmlHashDeallocator f)

Find the userdata specified by the @name and remove it from the hash @table. Existing userdata for this tuple will be removed and freed with @f.

Function: xmlHashRemoveEntry2

int	xmlHashRemoveEntry2		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 xmlHashDeallocator f)

Find the userdata specified by the (@name, @name2) tuple and remove it from the hash @table. Existing userdata for this tuple will be removed and freed with @f.

Function: xmlHashRemoveEntry3

int	xmlHashRemoveEntry3		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 const xmlChar * name3, 
					 xmlHashDeallocator f)

Find the userdata specified by the (@name, @name2, @name3) tuple and remove it from the hash @table. Existing userdata for this tuple will be removed and freed with @f.

Function: xmlHashScan

void	xmlHashScan			(xmlHashTablePtr table, 
					 xmlHashScanner f, 
					 void * data)

Scan the hash @table and applied @f to each value.

Function: xmlHashScan3

void	xmlHashScan3			(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 const xmlChar * name3, 
					 xmlHashScanner f, 
					 void * data)

Scan the hash @table and applied @f to each value matching (@name, @name2, @name3) tuple. If one of the names is null, the comparison is considered to match.

Function: xmlHashScanFull

void	xmlHashScanFull			(xmlHashTablePtr table, 
					 xmlHashScannerFull f, 
					 void * data)

Scan the hash @table and applied @f to each value.

Function: xmlHashScanFull3

void	xmlHashScanFull3		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 const xmlChar * name3, 
					 xmlHashScannerFull f, 
					 void * data)

Scan the hash @table and applied @f to each value matching (@name, @name2, @name3) tuple. If one of the names is null, the comparison is considered to match.

Function type: xmlHashScanner

Function type: xmlHashScanner
void	xmlHashScanner			(void * payload, 
					 void * data, 
					 xmlChar * name)

Callback when scanning data in a hash with the simple scanner.

Function type: xmlHashScannerFull

Function type: xmlHashScannerFull
void	xmlHashScannerFull		(void * payload, 
					 void * data, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 const xmlChar * name3)

Callback when scanning data in a hash with the full scanner.

Function: xmlHashSize

int	xmlHashSize			(xmlHashTablePtr table)

Query the number of elements installed in the hash @table.

Function: xmlHashUpdateEntry

int	xmlHashUpdateEntry		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 void * userdata, 
					 xmlHashDeallocator f)

Add the @userdata to the hash @table. This can later be retrieved by using the @name. Existing entry for this @name will be removed and freed with @f if found.

Function: xmlHashUpdateEntry2

int	xmlHashUpdateEntry2		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 void * userdata, 
					 xmlHashDeallocator f)

Add the @userdata to the hash @table. This can later be retrieved by using the (@name, @name2) tuple. Existing entry for this tuple will be removed and freed with @f if found.

Function: xmlHashUpdateEntry3

int	xmlHashUpdateEntry3		(xmlHashTablePtr table, 
					 const xmlChar * name, 
					 const xmlChar * name2, 
					 const xmlChar * name3, 
					 void * userdata, 
					 xmlHashDeallocator f)

Add the @userdata to the hash @table. This can later be retrieved by using the tuple (@name, @name2, @name3). Existing entry for this tuple will be removed and freed with @f if found.

Daniel Veillard