src/include/core/data.h

   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  */
  27
  28 #ifndef SDB_CORE_DATA_H
  29 #define SDB_CORE_DATA_H 1
  30
  31 #include "core/time.h"
  32 #include "utils/strbuf.h"
  33
  34 #include <inttypes.h>
  35 #include <stddef.h>
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 enum {
  42         SDB_TYPE_INTEGER = 1,
  43         SDB_TYPE_DECIMAL,
  44         SDB_TYPE_STRING,
  45         SDB_TYPE_DATETIME,
  46         SDB_TYPE_BINARY,
  47 };
  48
  49 #define SDB_TYPE_TO_STRING(t) \
  50         (((t) == SDB_TYPE_INTEGER) \
  51                 ? "INTEGER" \
  52                 : ((t) == SDB_TYPE_DECIMAL) \
  53                         ? "DECIMAL" \
  54                         : ((t) == SDB_TYPE_STRING) \
  55                                 ? "STRING" \
  56                                 : ((t) == SDB_TYPE_DATETIME) \
  57                                         ? "DATETIME" \
  58                                         : ((t) == SDB_TYPE_BINARY) \
  59                                                 ? "BINARY" \
  60                                                 : "UNKNOWN")
  61
  62 /*
  63  * sdb_data_t:
  64  * A datum retrieved from an arbitrary data source.
  65  */
  66 typedef struct {
  67         int type;
  68         union {
  69                 int64_t     integer;  /* SDB_TYPE_INTEGER */
  70                 double      decimal;  /* SDB_TYPE_DECIMAL */
  71                 char       *string;   /* SDB_TYPE_STRING  */
  72                 sdb_time_t  datetime; /* SDB_TYPE_DATETIME */
  73                 struct {
  74                         size_t length;
  75                         unsigned char *datum;
  76                 } binary;             /* SDB_TYPE_BINARY */
  77         } data;
  78 } sdb_data_t;
  79
  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.
  86  *
  87  * Returns:
  88  *  - 0 on success
  89  *  - a negative value else
  90  */
  91 int
  92 sdb_data_copy(sdb_data_t *dst, const sdb_data_t *src);
  93
  94 /*
  95  * sdb_data_free_datum:
  96  * Free any dynamic memory referenced by the specified datum. Does not free
  97  * the memory allocated for the sdb_data_t object itself. This function must
  98  * not be used if any static or stack memory is referenced from the data
  99  * object.
 100  */
 101 void
 102 sdb_data_free_datum(sdb_data_t *datum);
 103
 104 /*
 105  * sdb_data_strlen:
 106  * Returns a (worst-case) estimate for the number of bytes required to format
 107  * the datum as a string. Does not take the terminating null byte into
 108  * account.
 109  */
 110 size_t
 111 sdb_data_strlen(sdb_data_t *datum);
 112
 113 /*
 114  * sdb_data_format:
 115  * Append the specified datum to the specified string buffer using a default
 116  * format.
 117  *
 118  * Returns:
 119  *  - 0 on success
 120  *  - a negative value else
 121  */
 122 int
 123 sdb_data_format(sdb_data_t *datum, sdb_strbuf_t *buf);
 124
 125 #ifdef __cplusplus
 126 } /* extern "C" */
 127 #endif
 128
 129 #endif /* ! SDB_CORE_DATA_H */
 130
 131 /* vim: set tw=78 sw=4 ts=4 noexpandtab : */
 132