mirror of https://github.com/yasm/yasm.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
94 lines
3.8 KiB
94 lines
3.8 KiB
/** |
|
* \file libyasm/hamt.h |
|
* \brief Hash Array Mapped Trie (HAMT) functions. |
|
* |
|
* \rcs |
|
* $Id$ |
|
* \endrcs |
|
* |
|
* \license |
|
* Copyright (C) 2001 Peter Johnson |
|
* |
|
* Redistribution and use in source and binary forms, with or without |
|
* modification, are permitted provided that the following conditions |
|
* are met: |
|
* 1. Redistributions of source code must retain the above copyright |
|
* notice, this list of conditions and the following disclaimer. |
|
* 2. Redistributions in binary form must reproduce the above copyright |
|
* notice, this list of conditions and the following disclaimer in the |
|
* documentation and/or other materials provided with the distribution. |
|
* |
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND OTHER CONTRIBUTORS ``AS IS'' |
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR OTHER CONTRIBUTORS BE |
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
|
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
|
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
|
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
|
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
|
* POSSIBILITY OF SUCH DAMAGE. |
|
* \endlicense |
|
*/ |
|
#ifndef YASM_HAMT_H |
|
#define YASM_HAMT_H |
|
|
|
/** Hash array mapped trie data structure (opaque type). */ |
|
typedef struct HAMT HAMT; |
|
|
|
/** Create new, empty, HAMT. error_func() is called when an internal error is |
|
* encountered--it should NOT return to the calling function. |
|
* \param error_func function called on internal error |
|
* \return New, empty, hash array mapped trie. |
|
*/ |
|
HAMT *HAMT_create(/*@exits@*/ void (*error_func) |
|
(const char *file, unsigned int line, const char *message)); |
|
|
|
/** Delete HAMT and all data associated with it. Uses deletefunc() to delete |
|
* each data item. |
|
* \param hamt Hash array mapped trie |
|
* \param deletefunc Data deletion function |
|
*/ |
|
void HAMT_destroy(/*@only@*/ HAMT *hamt, |
|
void (*deletefunc) (/*@only@*/ void *data)); |
|
|
|
/** Insert key into HAMT, associating it with data. |
|
* If the key is not present in the HAMT, inserts it, sets *replace to 1, and |
|
* returns the data passed in. |
|
* If the key is already present and *replace is 0, deletes the data passed |
|
* in using deletefunc() and returns the data currently associated with the |
|
* key. |
|
* If the key is already present and *replace is 1, deletes the data currently |
|
* associated with the key using deletefunc() and replaces it with the data |
|
* passed in. |
|
* \param hamt Hash array mapped trie |
|
* \param str Key |
|
* \param data Data to associate with key |
|
* \param replace See above description |
|
* \param deletefunc Data deletion function if data is replaced |
|
* \return Data now associated with key. |
|
*/ |
|
/*@dependent@*/ void *HAMT_insert(HAMT *hamt, /*@dependent@*/ const char *str, |
|
/*@only@*/ void *data, int *replace, |
|
void (*deletefunc) (/*@only@*/ void *data)); |
|
|
|
/** Search for the data associated with a key in the HAMT. |
|
* \param hamt Hash array mapped trie |
|
* \param str Key |
|
* \return NULL if key/data not present in HAMT, otherwise associated data. |
|
*/ |
|
/*@dependent@*/ /*@null@*/ void *HAMT_search(HAMT *hamt, const char *str); |
|
|
|
/** Traverse over all keys in HAMT, calling function on each data item. |
|
* Stops early if func returns 0. |
|
* \param hamt Hash array mapped trie |
|
* \param d Data to pass to each call to func. |
|
* \param func Function to call |
|
* \return 0 if stopped early, 1 if all data items were traversed. |
|
*/ |
|
int HAMT_traverse(HAMT *hamt, /*@null@*/ void *d, |
|
int (*func) (/*@dependent@*/ /*@null@*/ void *node, |
|
/*@null@*/ void *d)); |
|
|
|
#endif
|
|
|