diff options
Diffstat (limited to 'tools/adk/strmap.h')
| -rw-r--r-- | tools/adk/strmap.h | 350 |
1 files changed, 0 insertions, 350 deletions
diff --git a/tools/adk/strmap.h b/tools/adk/strmap.h deleted file mode 100644 index 99687b236..000000000 --- a/tools/adk/strmap.h +++ /dev/null @@ -1,350 +0,0 @@ -/*
- * strmap version 1.0.0
- *
- * ANSI C hash table for strings.
- *
- * strmap.h
- *
- * Copyright (c) 2009 Per Ola Kristensson.
- *
- * Per Ola Kristensson <pok21@cam.ac.uk>
- * Inference Group, Department of Physics
- * University of Cambridge
- * Cavendish Laboratory
- * JJ Thomson Avenue
- * CB3 0HE Cambridge
- * United Kingdom
- *
- * strmap is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * strmap is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with strmap. If not, see <http://www.gnu.org/licenses/>.
- */
-#ifndef _STRMAP_H_
-#define _STRMAP_H_
-
-#ifdef __cplusplus
-extern "C"
-{
-#endif
-
-#include <stdlib.h>
-#include <string.h>
-
-typedef struct StrMap StrMap;
-
-/*
- * This callback function is called once per key-value when enumerating
- * all keys associated to values.
- *
- * Parameters:
- *
- * key: A pointer to a null-terminated C string. The string must not
- * be modified by the client.
- *
- * value: A pointer to a null-terminated C string. The string must
- * not be modified by the client.
- *
- * obj: A pointer to a client-specific object. This parameter may be
- * null.
- *
- * Return value: None.
- */
-typedef void(*strmap_enum_func)(const char *key, const char *value, const void *obj);
-
-/*
- * Creates a string map.
- *
- * Parameters:
- *
- * capacity: The number of top-level slots this string map
- * should allocate. This parameter must be > 0.
- *
- * Return value: A pointer to a string map object,
- * or null if a new string map could not be allocated.
- */
-StrMap * strmap_new(unsigned int capacity);
-
-/*
- * Releases all memory held by a string map object.
- *
- * Parameters:
- *
- * map: A pointer to a string map. This parameter cannot be null.
- * If the supplied string map has been previously released, the
- * behaviour of this function is undefined.
- *
- * Return value: None.
- */
-void strmap_delete(StrMap *map);
-
-/*
- * Returns the value associated with the supplied key.
- *
- * Parameters:
- *
- * map: A pointer to a string map. This parameter cannot be null.
- *
- * key: A pointer to a null-terminated C string. This parameter cannot
- * be null.
- *
- * out_buf: A pointer to an output buffer which will contain the value,
- * if it exists and fits into the buffer.
- *
- * n_out_buf: The size of the output buffer in bytes.
- *
- * Return value: If out_buf is set to null and n_out_buf is set to 0 the return
- * value will be the number of bytes required to store the value (if it exists)
- * and its null-terminator. For all other parameter configurations the return value
- * is 1 if an associated value was found and completely copied into the output buffer,
- * 0 otherwise.
- */
-int strmap_get(const StrMap *map, const char *key, char *out_buf, unsigned int n_out_buf);
-
-/*
- * Queries the existence of a key.
- *
- * Parameters:
- *
- * map: A pointer to a string map. This parameter cannot be null.
- *
- * key: A pointer to a null-terminated C string. This parameter cannot
- * be null.
- *
- * Return value: 1 if the key exists, 0 otherwise.
- */
-int strmap_exists(const StrMap *map, const char *key);
-
-/*
- * Associates a value with the supplied key. If the key is already
- * associated with a value, the previous value is replaced.
- *
- * Parameters:
- *
- * map: A pointer to a string map. This parameter cannot be null.
- *
- * key: A pointer to a null-terminated C string. This parameter
- * cannot be null. The string must have a string length > 0. The
- * string will be copied.
- *
- * value: A pointer to a null-terminated C string. This parameter
- * cannot be null. The string must have a string length > 0. The
- * string will be copied.
- *
- * Return value: 1 if the association succeeded, 0 otherwise.
- */
-int strmap_put(StrMap *map, const char *key, const char *value);
-
-/*
- * Returns the number of associations between keys and values.
- *
- * Parameters:
- *
- * map: A pointer to a string map. This parameter cannot be null.
- *
- * Return value: The number of associations between keys and values.
- */
-int strmap_get_count(const StrMap *map);
-
-/*
- * Enumerates all associations between keys and values.
- *
- * Parameters:
- *
- * map: A pointer to a string map. This parameter cannot be null.
- *
- * enum_func: A pointer to a callback function that will be
- * called by this procedure once for every key associated
- * with a value. This parameter cannot be null.
- *
- * obj: A pointer to a client-specific object. This parameter will be
- * passed back to the client's callback function. This parameter can
- * be null.
- *
- * Return value: 1 if enumeration completed, 0 otherwise.
- */
-int strmap_enum(const StrMap *map, strmap_enum_func enum_func, const void *obj);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif
-
-/*
-
- GNU LESSER GENERAL PUBLIC LICENSE
- Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
- This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
-
- 0. Additional Definitions.
-
- As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
-
- "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
-
- An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
- A "Combined Work" is a work produced by combining or linking an
-Application with the Library. The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
- The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
- The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
- 1. Exception to Section 3 of the GNU GPL.
-
- You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
- 2. Conveying Modified Versions.
-
- If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
- a) under this License, provided that you make a good faith effort to
- ensure that, in the event an Application does not supply the
- function or data, the facility still operates, and performs
- whatever part of its purpose remains meaningful, or
-
- b) under the GNU GPL, with none of the additional permissions of
- this License applicable to that copy.
-
- 3. Object Code Incorporating Material from Library Header Files.
-
- The object code form of an Application may incorporate material from
-a header file that is part of the Library. You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
- a) Give prominent notice with each copy of the object code that the
- Library is used in it and that the Library and its use are
- covered by this License.
-
- b) Accompany the object code with a copy of the GNU GPL and this license
- document.
-
- 4. Combined Works.
-
- You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
-
- a) Give prominent notice with each copy of the Combined Work that
- the Library is used in it and that the Library and its use are
- covered by this License.
-
- b) Accompany the Combined Work with a copy of the GNU GPL and this license
- document.
-
- c) For a Combined Work that displays copyright notices during
- execution, include the copyright notice for the Library among
- these notices, as well as a reference directing the user to the
- copies of the GNU GPL and this license document.
-
- d) Do one of the following:
-
- 0) Convey the Minimal Corresponding Source under the terms of this
- License, and the Corresponding Application Code in a form
- suitable for, and under terms that permit, the user to
- recombine or relink the Application with a modified version of
- the Linked Version to produce a modified Combined Work, in the
- manner specified by section 6 of the GNU GPL for conveying
- Corresponding Source.
-
- 1) Use a suitable shared library mechanism for linking with the
- Library. A suitable mechanism is one that (a) uses at run time
- a copy of the Library already present on the user's computer
- system, and (b) will operate properly with a modified version
- of the Library that is interface-compatible with the Linked
- Version.
-
- e) Provide Installation Information, but only if you would otherwise
- be required to provide such information under section 6 of the
- GNU GPL, and only to the extent that such information is
- necessary to install and execute a modified version of the
- Combined Work produced by recombining or relinking the
- Application with a modified version of the Linked Version. (If
- you use option 4d0, the Installation Information must accompany
- the Minimal Corresponding Source and Corresponding Application
- Code. If you use option 4d1, you must provide the Installation
- Information in the manner specified by section 6 of the GNU GPL
- for conveying Corresponding Source.)
-
- 5. Combined Libraries.
-
- You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
- a) Accompany the combined library with a copy of the same work based
- on the Library, uncombined with any other library facilities,
- conveyed under the terms of this License.
-
- b) Give prominent notice with the combined library that part of it
- is a work based on the Library, and explaining where to find the
- accompanying uncombined form of the same work.
-
- 6. Revised Versions of the GNU Lesser General Public License.
-
- The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
- Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
- If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.
-
-*/
|