1 /*
2 * SysDB - src/include/core/data.h
3 * Copyright (C) 2012 Sebastian 'tokkee' Harl <sh@tokkee.org>
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
28 #ifndef SDB_CORE_DATA_H
29 #define SDB_CORE_DATA_H 1
31 #include "core/time.h"
33 #include <inttypes.h>
34 #include <stddef.h>
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
40 enum {
41 SDB_TYPE_INTEGER = 1,
42 SDB_TYPE_DECIMAL,
43 SDB_TYPE_STRING,
44 SDB_TYPE_DATETIME,
45 SDB_TYPE_BINARY,
46 };
48 /*
49 * sdb_data_t:
50 * A datum retrieved from an arbitrary data source.
51 */
52 typedef struct {
53 int type;
54 union {
55 int64_t integer; /* SDB_TYPE_INTEGER */
56 double decimal; /* SDB_TYPE_DECIMAL */
57 char *string; /* SDB_TYPE_STRING */
58 sdb_time_t datetime; /* SDB_TYPE_DATETIME */
59 struct {
60 size_t length;
61 unsigned char *datum;
62 } binary; /* SDB_TYPE_BINARY */
63 } data;
64 } sdb_data_t;
66 /*
67 * sdb_data_copy:
68 * Copy the datum stored in 'src' to the memory location pointed to by 'dst'.
69 * Any dynamic data (strings, binary data) is copied to newly allocated
70 * memory. Use, for example, sdb_data_free_datum() to free any dynamic memory
71 * stored in a datum.
72 *
73 * Returns:
74 * - 0 on success
75 * - a negative value else
76 */
77 int
78 sdb_data_copy(sdb_data_t *dst, const sdb_data_t *src);
80 /*
81 * sdb_data_free_datum:
82 * Free any dynamic memory referenced by the specified datum. Does not free
83 * the memory allocated for the sdb_data_t object itself. This function must
84 * not be used if any static or stack memory is referenced from the data
85 * object.
86 */
87 void
88 sdb_data_free_datum(sdb_data_t *datum);
90 #ifdef __cplusplus
91 } /* extern "C" */
92 #endif
94 #endif /* ! SDB_CORE_DATA_H */
96 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */