summaryrefslogtreecommitdiff
path: root/support/dktools/dk4dbit8.ctr
blob: 2b51c1a52f863593e7f9ffb65ec9e198bd6228f3 (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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
%%	options

copyright owner	=	Dirk Krause
copyright year	=	2015-xxxx
license		=	bsd



%%	header

/**	@file	dk4dbit8.h	Text in database.
*/

#ifndef DK4DBI_H_INCLUDED
#include <dk4dbi.h>
#endif

/**	Traverse simple database containing text.
	@param	obj	Object to modify during traversal.
	@param	k	Key text.
	@param	v	Value text.
	@return	1 on success, 0 on error (continue traversal),
		-1 on error (abort).
*/
typedef
int
dk4dbi_c8_traverse_fct_t(
  void		*obj,
  const char	*k,
  const char	*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_c8_set(
  dk4_dbi_t	*db,
  const char	*k,
  const char	*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).
	@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_c8_get(
  dk4_dbi_t	*db,
  const char	*k,
  char		*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_c8_del(
  dk4_dbi_t	*db,
  const char	*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_c8_traverse(
  dk4_dbi_t			*db,
  void				*obj,
  dk4dbi_c8_traverse_fct_t	*fct
);

#ifdef __cplusplus
}
#endif

%%	module

#include "dk4conf.h"

#include "dk4str8.h"
#include "dk4dbit8.h"
#include "dk4maasz.h"



$!trace-include



/**	Object for database traversal.
*/
typedef struct {
  void				*obj;	/**< Object for string traversal. */
  dk4dbi_c8_traverse_fct_t	*fct;	/**< String traversal function. */
} dk4dbi_c8_traversal_object_t;



int
dk4dbi_c8_del(
  dk4_dbi_t	*db,
  const char	*k,
  dk4_er_t	*erp
)
{
  dk4_er_t	 er;		/* Internal error report for size calc */
  size_t	 ks	= 0;	/* Key size */
  int		 back	= 0;
  $? "+ dk4dbi_c8_del \"%!8s\"", TR_8STR(k)
  if ((NULL != db) && (NULL != k)) {
    dk4error_init(&er);
    ks = dk4ma_size_t_add(1, dk4str8_len(k), &er);
    if (DK4_E_NONE == er.ec) {
      back = dk4dbi_delete(db, k, ks, erp);
    } else {
      dk4error_copy(erp, &er);
    }
  } else {
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  } $? "- dk4dbi_c8_del %d", back
  return back;
}



int
dk4dbi_c8_set(
  dk4_dbi_t	*db,
  const char	*k,
  const char	*v,
  dk4_er_t	*erp
)
{
  dk4_er_t	 er;		/* Internal error report for size calc */
  size_t	 ks	= 0;	/* Key size */
  size_t	 vs	= 0;	/* Value size */
  int		 back	= 0;
  $? "+ dk4dbi_c8_set \"%!8s\"=\"%!8s\"", TR_8STR(k), TR_8STR(v)
  if ((NULL != db) && (NULL != k)) {		$? ". args ok"
    if (NULL != v) {				$? ". new value"
      dk4error_init(&er);
      ks = dk4ma_size_t_add(1, dk4str8_len(k), &er);
      vs = dk4ma_size_t_add(1, dk4str8_len(v), &er);
      if (DK4_E_NONE == er.ec) {		$? ". lengths ok"
        back = dk4dbi_set(db, k, ks, v, vs, erp);
      } else {					$? "! key or value too long"
        dk4error_copy(erp, &er);
      }
    } else {					$? ". delete"
      back = dk4dbi_c8_del(db, k, erp);
    }
  } else {					$? "! args"
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  } $? "- dk4dbi_c8_set %d", back
  return back;
}



int
dk4dbi_c8_get(
  dk4_dbi_t	*db,
  const char	*k,
  char		*vbuf,
  size_t	 vsz,
  dk4_er_t	*erp
)
{
  dk4_er_t	 er;		/* Internal error report for size calc */
  size_t	 ks	= 0;	/* Key size */
  size_t	 ressz	= 0;	/* Result size */
  int		 back	= 0;

  $? "+ dk4dbi_c8_get \"%!8s\"", TR_8STR(k)
  if ((NULL != vbuf) && (0 < vsz)) { *vbuf = '\0'; }
  if ((NULL != db) && (NULL != k) && (NULL != vbuf) && (0 < vsz)) {
    dk4error_init(&er);			$? ". args ok"
    ressz = vsz;
    ks = dk4ma_size_t_add(1, dk4str8_len(k), &er);
    if (DK4_E_NONE == er.ec) {	$? ". name length ok"
      if (0 != dk4dbi_get(db, k, ks, vbuf, &ressz, erp)) {	$? ". found"
        if (0 < ressz) {	$? ". length ok"
	  if ('\0' == vbuf[ressz - 1]) {
	    back = 1;	$? ". result=\"%!8s\"", vbuf
	  } else {
	    if (ressz < vsz) {
	      vbuf[ressz] = '\0';
	      back = 1;	$? ". result=\"%!8s\"", vbuf
	    } else {		$? "! not terminated, too long"
	      *vbuf = '\0';
	      dk4error_set_simple_error_code(erp, DK4_E_BUFFER_TOO_SMALL);
	    }
	  }
	} else {		$? "! zero length"
	  *vbuf = '\0';
	  dk4error_set_simple_error_code(erp, DK4_E_NOT_FOUND);
	}
      }
#if TRACE_DEBUG
      else {			$? "! not found"
      }
#endif
    } else {			$? "! name too long"
      dk4error_copy(erp, &er);
    }
  } else {			$? "! args"
    dk4error_set_simple_error_code(erp, DK4_E_INVALID_ARGUMENTS);
  } $? "- dk4dbi_c8_get %d", back
  return back;
}



/**	Function to traverse a simple database.
	The function must check the kb, ks, vb and vs arguments
	for validity, they are passed as found by the backend
	functions (this means pointers may be NULL, sizes may be 0).
	@param	Object modified during traversal, may be NULL.
	@param	kb	Key data.
	@param	ks	Key size.
	@param	vb	Value data.
	@param	vs	Value size.
	@return	1 on success, 0 on error (can continue), -1 on error (abort).
*/
static
int
dk4dbi_c8_internal_traverse(
  void		*obj,
  const void	*kb,
  size_t	 ks,
  const void	*vb,
  size_t	 vs
)
{
  dk4dbi_c8_traversal_object_t	*myobj;	/* Passed from dk4dbi_traverse() */
  const char			*pk;	/* Key pointer */
  const char			*pv;	/* Value pointer */
  int				 back	= 0;
  $? "+ dk4dbi_c8_internal_traverse"
  if ((NULL != obj) && (NULL != kb) && (NULL != vb) && (0 < ks) && (0 < vs)) {
    pk = (const char *)kb;
    pv = (const char *)vb;
    if (('\0' == pk[ks - 1]) && ('\0' == pv[vs - 1])) {
      myobj = (dk4dbi_c8_traversal_object_t *)obj;
      back = (*(myobj->fct))(myobj->obj, pk, pv);
    }
  } $? "- dk4dbi_c8_internal_traverse %d", back
  return back;
}



int
dk4dbi_c8_traverse(
  dk4_dbi_t			*db,
  void				*obj,
  dk4dbi_c8_traverse_fct_t	*fct
)
{
  dk4dbi_c8_traversal_object_t	myobj;		/* Passed to dk4dbi_traverse */
  int				back	= -1;

  $? "+ dk4dbi_c8_traverse db=%d obj=%d", TR_IPTR(db), TR_IPTR(obj)
  if ((NULL != db) && (NULL != fct)) {
    myobj.obj = obj;
    myobj.fct = fct;
    back = dk4dbi_traverse(db, &myobj, dk4dbi_c8_internal_traverse);
  } $? "- dk4dbi_c8_traverse %d", back
  return back;
}