1bd0d5354e652656b891d0178cdf5030bf4992ec
1 /*
2 * SysDB - src/include/core/data.h
3 * Copyright (C) 2012-2014 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 #define SDB_TYPE_TO_STRING(t) \
49 (((t) == SDB_TYPE_INTEGER) \
50 ? "INTEGER" \
51 : ((t) == SDB_TYPE_DECIMAL) \
52 ? "DECIMAL" \
53 : ((t) == SDB_TYPE_STRING) \
54 ? "STRING" \
55 : ((t) == SDB_TYPE_DATETIME) \
56 ? "DATETIME" \
57 : ((t) == SDB_TYPE_BINARY) \
58 ? "BINARY" \
59 : "UNKNOWN")
61 /*
62 * sdb_data_t:
63 * A datum retrieved from an arbitrary data source.
64 */
65 typedef struct {
66 int type;
67 union {
68 int64_t integer; /* SDB_TYPE_INTEGER */
69 double decimal; /* SDB_TYPE_DECIMAL */
70 char *string; /* SDB_TYPE_STRING */
71 sdb_time_t datetime; /* SDB_TYPE_DATETIME */
72 struct {
73 size_t length;
74 unsigned char *datum;
75 } binary; /* SDB_TYPE_BINARY */
76 } data;
77 } sdb_data_t;
78 #define SDB_DATA_INIT { 0, { .integer = 0 } }
80 /*
81 * sdb_data_copy:
82 * Copy the datum stored in 'src' to the memory location pointed to by 'dst'.
83 * Any dynamic data (strings, binary data) is copied to newly allocated
84 * memory. Use, for example, sdb_data_free_datum() to free any dynamic memory
85 * stored in a datum. On error, 'dst' is unchanged. Else, any dynamic memory
86 * in 'dst' will be freed.
87 *
88 * Returns:
89 * - 0 on success
90 * - a negative value else
91 */
92 int
93 sdb_data_copy(sdb_data_t *dst, const sdb_data_t *src);
95 /*
96 * sdb_data_free_datum:
97 * Free any dynamic memory referenced by the specified datum. Does not free
98 * the memory allocated by the sdb_data_t object itself. This function must
99 * not be used if any static or stack memory is referenced from the data
100 * object.
101 */
102 void
103 sdb_data_free_datum(sdb_data_t *datum);
105 /*
106 * sdb_data_cmp:
107 * Compare two data points. A NULL datum is considered less than any non-NULL
108 * datum. On data-type mismatch, the function always returns a non-zero value.
109 *
110 * Returns:
111 * - a value less than zero if d1 compares less than d2
112 * - zero if d1 compares equal to d2
113 * - a value greater than zero if d1 compares greater than d2
114 */
115 int
116 sdb_data_cmp(const sdb_data_t *d1, const sdb_data_t *d2);
118 /*
119 * sdb_data_strcmp:
120 * Compare the string values of two data points. A NULL datum is considered
121 * less than any non-NULL. This function works for arbitrary combination of
122 * data-types.
123 *
124 * Returns:
125 * - a value less than zero if d1 compares less than d2
126 * - zero if d1 compares equal to d2
127 * - a value greater than zero if d1 compares greater than d2
128 */
129 int
130 sdb_data_strcmp(const sdb_data_t *d1, const sdb_data_t *d2);
132 /*
133 * sdb_data_isnull:
134 * Determine whether a datum is NULL. A datum is considered to be NULL if
135 * either datum is NULL or if the string or binary datum is NULL.
136 */
137 _Bool
138 sdb_data_isnull(const sdb_data_t *datum);
140 /*
141 * Operators supported by sdb_data_eval_expr.
142 */
143 enum {
144 SDB_DATA_ADD = 1, /* addition */
145 SDB_DATA_SUB, /* substraction */
146 SDB_DATA_MUL, /* multiplication */
147 SDB_DATA_DIV, /* division */
148 SDB_DATA_MOD, /* modulo */
149 SDB_DATA_CONCAT, /* string / binary data concatenation */
150 };
152 #define SDB_DATA_OP_TO_STRING(op) \
153 (((op) == SDB_DATA_ADD) \
154 ? "+" \
155 : ((op) == SDB_DATA_SUB) \
156 ? "-" \
157 : ((op) == SDB_DATA_MUL) \
158 ? "*" \
159 : ((op) == SDB_DATA_DIV) \
160 ? "/" \
161 : ((op) == SDB_DATA_MOD) \
162 ? "%" \
163 : ((op) == SDB_DATA_CONCAT) \
164 ? "||" : "UNKNOWN")
166 /*
167 * sdb_data_expr_eval:
168 * Evaluate a simple arithmetic expression on two data points. String and
169 * binary data only support concatenation and all other data types only
170 * support the other operators. The result may be allocated dynamically and
171 * has to be freed by the caller (using sdb_data_free_datum).
172 *
173 * The data-types of d1 and d2 have to be the same, except for the following
174 * cases:
175 * - <integer> or <decimal> <mul> <datetime>
176 * - <datetime> <mul> or <div> or <mod> <integer> or <decimal>
177 *
178 * Returns:
179 * - 0 on success
180 * - a negative value else
181 */
182 int
183 sdb_data_expr_eval(int op, const sdb_data_t *d1, const sdb_data_t *d2,
184 sdb_data_t *res);
186 /*
187 * sdb_data_strlen:
188 * Returns a (worst-case) estimate for the number of bytes required to format
189 * the datum as a string. Does not take the terminating null byte into
190 * account.
191 */
192 size_t
193 sdb_data_strlen(const sdb_data_t *datum);
195 enum {
196 SDB_UNQUOTED = 0,
197 SDB_SINGLE_QUOTED,
198 SDB_DOUBLE_QUOTED,
199 };
201 /*
202 * sdb_data_format:
203 * Output the specified datum to the specified string using a default format.
204 * The value of 'quoted' determines whether and how non-integer and
205 * non-decimal values are quoted. If the buffer size is less than the return
206 * value of sdb_data_strlen, the datum may be truncated. The buffer will
207 * always be nul-terminated after calling this function.
208 *
209 * Returns:
210 * - the number of characters written to the buffer (excluding the terminated
211 * null byte) or the number of characters which would have been written in
212 * case the output was truncated
213 * - a negative value else
214 */
215 int
216 sdb_data_format(const sdb_data_t *datum, char *buf, size_t buflen, int quoted);
218 /*
219 * sdb_data_parse:
220 * Parse the specified string into a datum using the specified type. The
221 * string value is expected to be a raw value of the specified type. Integer
222 * and decimal numbers may be signed or unsigned octal (base 8, if the first
223 * character of the string is "0"), sedecimal (base 16, if the string includes
224 * the "0x" prefix), or decimal. Decimal numbers may also be "infinity" or
225 * "NaN" or may use a decimal exponent. Date-time values are expected to be
226 * specified as (floating point) number of seconds since the epoch. For string
227 * and binary data, the input string is passed to the datum. The function does
228 * not allocate new memory for that purpose. Use sdb_data_copy() if you want
229 * to do that.
230 *
231 * Returns:
232 * - 0 on success
233 * - a negative value else
234 */
235 int
236 sdb_data_parse(char *str, int type, sdb_data_t *data);
238 #ifdef __cplusplus
239 } /* extern "C" */
240 #endif
242 #endif /* ! SDB_CORE_DATA_H */
244 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */