mirror of
https://gitlab.gnome.org/GNOME/libxml2.git
synced 2026-01-18 14:21:02 +03:00
9d06d300a5
* doc/libxml2-api.xml doc/parsedecl.py: Build a new version hopefully near complete and fully documented of the API in XML * HTMLtree.c SAX.c debugXML.c error.c globals.c parser.c tree.c xmlIO.c xmlmemory.c include/libxml/catalog.h include/libxml/hash.h include/libxml/list.h include/libxml/parser.h include/libxml/tree.h include/libxml/parserInternals.h include/libxml/valid.hi include/libxml/xmlIO.h include/libxml/xmlerror.hi include/libxml/xmlmemory.h include/libxml/xmlversion.h.ini include/libxml/xpath.h include/libxml/xpathInternals.h: Cleaned up the doc comments a lot in the process, the interface coverage is now 100% Daniel
167 lines
4.9 KiB
C
167 lines
4.9 KiB
C
/*
|
|
* hash.h: chained hash tables
|
|
*
|
|
* Copyright (C) 2000 Bjorn Reese and Daniel Veillard.
|
|
*
|
|
* Permission to use, copy, modify, and distribute this software for any
|
|
* purpose with or without fee is hereby granted, provided that the above
|
|
* copyright notice and this permission notice appear in all copies.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
|
|
* WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
|
|
* MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE AUTHORS AND
|
|
* CONTRIBUTORS ACCEPT NO RESPONSIBILITY IN ANY CONCEIVABLE MANNER.
|
|
*
|
|
* Author: bjorn.reese@systematic.dk
|
|
*/
|
|
|
|
#ifndef __XML_HASH_H__
|
|
#define __XML_HASH_H__
|
|
|
|
#include <libxml/parser.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*
|
|
* The hash table
|
|
*/
|
|
typedef struct _xmlHashTable xmlHashTable;
|
|
typedef xmlHashTable *xmlHashTablePtr;
|
|
|
|
/*
|
|
* function types:
|
|
*/
|
|
/**
|
|
* xmlHashDeallocator:
|
|
* @payload: the data in the hash
|
|
* @name: the name associated
|
|
*
|
|
* Callback to free data from a hash
|
|
*/
|
|
typedef void (*xmlHashDeallocator)(void *payload, xmlChar *name);
|
|
/**
|
|
* xmlHashCopier:
|
|
* @payload: the data in the hash
|
|
* @name: the name associated
|
|
*
|
|
* Callback to copy data from a hash
|
|
*
|
|
* Returns a copy of the data or NULL in case of error
|
|
*/
|
|
typedef void *(*xmlHashCopier)(void *payload, xmlChar *name);
|
|
/**
|
|
* xmlHashScanner:
|
|
* @payload: the data in the hash
|
|
* @data: extra scannner data
|
|
* @name: the name associated
|
|
*
|
|
* Callback when scanning data in a hash with the simple scanner
|
|
*/
|
|
typedef void (*xmlHashScanner)(void *payload, void *data, xmlChar *name);
|
|
/**
|
|
* xmlHashScannerFull:
|
|
* @payload: the data in the hash
|
|
* @data: extra scannner data
|
|
* @name: the name associated
|
|
* @name2: the second name associated
|
|
* @name3: the third name associated
|
|
*
|
|
* Callback when scanning data in a hash with the full scanner
|
|
*/
|
|
typedef void (*xmlHashScannerFull)(void *payload, void *data,
|
|
const xmlChar *name, const xmlChar *name2,
|
|
const xmlChar *name3);
|
|
|
|
/*
|
|
* Constructor and destructor
|
|
*/
|
|
xmlHashTablePtr xmlHashCreate (int size);
|
|
void xmlHashFree (xmlHashTablePtr table,
|
|
xmlHashDeallocator f);
|
|
|
|
/*
|
|
* Add a new entry to the hash table
|
|
*/
|
|
int xmlHashAddEntry (xmlHashTablePtr table,
|
|
const xmlChar *name,
|
|
void *userdata);
|
|
int xmlHashUpdateEntry(xmlHashTablePtr table,
|
|
const xmlChar *name,
|
|
void *userdata,
|
|
xmlHashDeallocator f);
|
|
int xmlHashAddEntry2(xmlHashTablePtr table,
|
|
const xmlChar *name,
|
|
const xmlChar *name2,
|
|
void *userdata);
|
|
int xmlHashUpdateEntry2(xmlHashTablePtr table,
|
|
const xmlChar *name,
|
|
const xmlChar *name2,
|
|
void *userdata,
|
|
xmlHashDeallocator f);
|
|
int xmlHashAddEntry3(xmlHashTablePtr table,
|
|
const xmlChar *name,
|
|
const xmlChar *name2,
|
|
const xmlChar *name3,
|
|
void *userdata);
|
|
int xmlHashUpdateEntry3(xmlHashTablePtr table,
|
|
const xmlChar *name,
|
|
const xmlChar *name2,
|
|
const xmlChar *name3,
|
|
void *userdata,
|
|
xmlHashDeallocator f);
|
|
|
|
/*
|
|
* Remove an entry from the hash table
|
|
*/
|
|
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);
|
|
|
|
/*
|
|
* Retrieve the userdata
|
|
*/
|
|
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);
|
|
|
|
/*
|
|
* Helpers
|
|
*/
|
|
xmlHashTablePtr xmlHashCopy (xmlHashTablePtr table,
|
|
xmlHashCopier f);
|
|
int xmlHashSize (xmlHashTablePtr table);
|
|
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);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif /* ! __XML_HASH_H__ */
|