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"
32 #include "utils/strbuf.h"
34 #include <inttypes.h>
35 #include <stddef.h>
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
41 enum {
42 SDB_TYPE_INTEGER = 1,
43 SDB_TYPE_DECIMAL,
44 SDB_TYPE_STRING,
45 SDB_TYPE_DATETIME,
46 SDB_TYPE_BINARY,
47 };
49 /*
50 * sdb_data_t:
51 * A datum retrieved from an arbitrary data source.
52 */
53 typedef struct {
54 int type;
55 union {
56 int64_t integer; /* SDB_TYPE_INTEGER */
57 double decimal; /* SDB_TYPE_DECIMAL */
58 char *string; /* SDB_TYPE_STRING */
59 sdb_time_t datetime; /* SDB_TYPE_DATETIME */
60 struct {
61 size_t length;
62 unsigned char *datum;
63 } binary; /* SDB_TYPE_BINARY */
64 } data;
65 } sdb_data_t;
67 /*
68 * sdb_data_copy:
69 * Copy the datum stored in 'src' to the memory location pointed to by 'dst'.
70 * Any dynamic data (strings, binary data) is copied to newly allocated
71 * memory. Use, for example, sdb_data_free_datum() to free any dynamic memory
72 * stored in a datum.
73 *
74 * Returns:
75 * - 0 on success
76 * - a negative value else
77 */
78 int
79 sdb_data_copy(sdb_data_t *dst, const sdb_data_t *src);
81 /*
82 * sdb_data_free_datum:
83 * Free any dynamic memory referenced by the specified datum. Does not free
84 * the memory allocated for the sdb_data_t object itself. This function must
85 * not be used if any static or stack memory is referenced from the data
86 * object.
87 */
88 void
89 sdb_data_free_datum(sdb_data_t *datum);
91 /*
92 * sdb_data_format:
93 * Append the specified datum to the specified string buffer using a default
94 * format.
95 *
96 * Returns:
97 * - 0 on success
98 * - a negative value else
99 */
100 int
101 sdb_data_format(sdb_data_t *datum, sdb_strbuf_t *buf);
103 #ifdef __cplusplus
104 } /* extern "C" */
105 #endif
107 #endif /* ! SDB_CORE_DATA_H */
109 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */