summaryrefslogtreecommitdiff
path: root/support/dktools/dk4dbitw.h
blob: 2429a6202e2ef50c8af89e70566b5e7d44114644 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/*
Copyright (C) 2015-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	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: dk4dbitw.ctr
*/

#ifndef DK4DBITW_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4DBITW_H_INCLUDED 1


#line 10 "dk4dbitw.ctr"

/**	@file	dk4dbitw.h	Text (wchar_t) in database.
*/

#ifndef	DK4CONF_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.h>
#endif
#endif

#ifndef DK4DBI_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4dbi.h"
#else
#include <dktools-4/dk4dbi.h>
#endif
#endif

#if DK4_HAVE_WCHAR_H
#ifndef WCHAR_H_INCLUDED
#include <wchar.h>
#define	WCHAR_H_INCLUDED 1
#endif
#endif

/**	Function used when traversing a simple database.
	@param	obj	Object to modify during traversal.
	@param	k	Current key.
	@param	v	Current value.
*/
typedef
int
dk4dbi_wc_traverse_fct_t(
  void		*obj,
  const wchar_t	*k,
  const wchar_t	*v
);

#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_wc_set(
  dk4_dbi_t	*db,
  const wchar_t	*k,
  const wchar_t	*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 wchar_t.
	@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_wc_get(
  dk4_dbi_t	*db,
  const wchar_t	*k,
  wchar_t	*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_wc_del(
  dk4_dbi_t	*db,
  const wchar_t	*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_wc_traverse(
  dk4_dbi_t			*db,
  void				*obj,
  dk4dbi_wc_traverse_fct_t	*fct
);

#ifdef __cplusplus
}
#endif


#endif