diff options
Diffstat (limited to 'support/dktools/dk4dbit.h')
| -rw-r--r-- | support/dktools/dk4dbit.h | 184 |
1 files changed, 184 insertions, 0 deletions
diff --git a/support/dktools/dk4dbit.h b/support/dktools/dk4dbit.h new file mode 100644 index 0000000000..dd2f44d808 --- /dev/null +++ b/support/dktools/dk4dbit.h @@ -0,0 +1,184 @@ +/* + WARNING: This file was generated by dkct. + Changes you make here will be lost if dkct is run again! + You should modify the original source and run dkct on it. + Original source: dk4dbit.ctr +*/ + +/* +Copyright (C) 2015-2017, Dirk Krause + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. +* Redistributions in binary form must reproduce the above opyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. +* Neither the name of the author nor the names of contributors may be used + to endorse or promote products derived from this software without specific + prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 COPYRIGHT OWNER OR 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. +*/ + +#ifndef DK4DBIT_H_INCLUDED +/** Avoid multiple inclusions. */ +#define DK4DBIT_H_INCLUDED 1 + + +#line 10 "dk4dbit.ctr" + +/** @file dk4dbit.h Text (dkChar) in database. +*/ + +#ifndef DK4DBI_H_INCLUDED +#include <dk4dbi.h> +#endif + +#ifndef DK4DBIT8_H_INCLUDED +#include <dk4dbit8.h> +#endif + +#ifndef DK4DBITW_H_INCLUDED +#include <dk4dbitw.h> +#endif + +#if DK4_CHAR_SIZE > 1 +/** Function to traverse text database. +*/ +typedef dk4dbi_wc_traverse_fct_t dk4dbi_text_traverse_fct; +#else +/** Function to traverse text database. +*/ +typedef dk4dbi_c8_traverse_fct_t dk4dbi_text_traverse_fct; +#endif + + +#ifdef __cplusplus +extern "C" { +#endif + +/** Set text entry. + @param db Database to modify. + @param k Key text. + @param v Value text. + @param erp Error report, may be NULL. + @return 1 on success, 0 on error. + + Error codes: + - DK4_E_INVALID_ARGUMENTS<br> + if db, k or vis NULL, + - DK4_E_SYNTAX<br> + if the database was opened read-only or k or v + is too long. + - DK4_E_MATH_OVERFLOW<br> + on numeric overflow in size calculation, + - DK4_E_NOT_SUPPORTED<br> + if db indicates an unsupported backend, + - DK4_E_NOT_FOUND<br> + if no record to delete was found, + - DK4_E_MEMORY_ALLOCATION_FAILED<br> + with mem.elsize and mem.nelem + set if there is not enough memory available, + - DK4_E_WRITE_FAILED<br> + if modification of the database failed. +*/ +int +dk4dbi_text_set( + dk4_dbi_t *db, + const dkChar *k, + const dkChar *v, + dk4_er_t *erp +); + +/** Retrieve text entry. + @param db Database to query. + @param k Key text. + @param vbuf Result buffer address. + @param vsz Pointer to size variable (in: size, out: used), + number of dkChar. + @param erp Error report, may be NULL. + @return 1 on success, 0 on error. + + Error codes: + - DK4_E_INVALID_ARGUMENTS<br> + if db, k or vbufis NULL or vsz is 0, + or the length of k exceeds the key size limit, + - DK4_E_MATH_OVERFLOW<br> + on numeric overflow in size calculation, + - DK4_E_NOT_SUPPORTED<br> + if db indicates an unsupported backend, + - DK4_E_NOT_FOUND<br> + if no record was found for the key, + - DK4_E_BUFFER_TOO_SMALL<br> + if the destination buffer is too small. +*/ +int +dk4dbi_text_get( + dk4_dbi_t *db, + const dkChar *k, + dkChar *vbuf, + size_t vsz, + dk4_er_t *erp +); + +/** Delete text entry. + @param db Database to modify. + @param k Key text. + @param erp Error report, may be NULL. + @return 1 on success, 0 on error. + + Error codes: + - DK4_E_INVALID_ARGUMENTS<br> + if db or k is NULL, + - DK4_E_SYNTAX<br> + if the database is opened read-only or the length of + k exceeds the key size limit, + - DK4_E_MATH_OVERFLOW<br> + on numeric overflow in size calculation, + - DK4_E_NOT_SUPPORTED<br> + if db indicates an unsupported backend, + - DK4_E_WRITE_FAILED<br> + if modification of the database failed, + - DK4_E_NOT_FOUND<br> + if no record for the specified key is in the database. +*/ +int +dk4dbi_text_del( + dk4_dbi_t *db, + const dkChar *k, + dk4_er_t *erp +); + +/** Traverse database, apply function to all text entries. + @param db Database to traverse. + @param obj Object to modify during traversal. + @param fct Function to apply to all text entries. + @return 1 on success, 0 on error (database traversed), + -1 on error (traversal aborted). +*/ +int +dk4dbi_text_traverse( + dk4_dbi_t *db, + void *obj, + dk4dbi_text_traverse_fct *fct +); + +#ifdef __cplusplus +} +#endif + + +#endif |