index a5438a2c8e76d4821b29e1b6ae40aa638aea0bb8..0b4b2e7419312e10d68f9725d7db061dea9d0d14 100644 (file)
--- a/src/include/core/data.h
+++ b/src/include/core/data.h
SDB_TYPE_BINARY,
};
+#define SDB_TYPE_TO_STRING(t) \
+ (((t) == SDB_TYPE_INTEGER) \
+ ? "INTEGER" \
+ : ((t) == SDB_TYPE_DECIMAL) \
+ ? "DECIMAL" \
+ : ((t) == SDB_TYPE_STRING) \
+ ? "STRING" \
+ : ((t) == SDB_TYPE_DATETIME) \
+ ? "DATETIME" \
+ : ((t) == SDB_TYPE_BINARY) \
+ ? "BINARY" \
+ : "UNKNOWN")
+
/*
* sdb_data_t:
* A datum retrieved from an arbitrary data source.
- *
- * The string and binary objects are managed by whoever creates the data
- * object, thus, they must not be freed or modified. If you want to keep them,
- * make sure to make a copy.
*/
typedef struct {
int type;
/*
* sdb_data_free_datum:
* Free any dynamic memory referenced by the specified datum. Does not free
- * the memory allocated for the sdb_data_t object itself. This function must
+ * the memory allocated by the sdb_data_t object itself. This function must
* not be used if any static or stack memory is referenced from the data
* object.
*/
void
sdb_data_free_datum(sdb_data_t *datum);
+/*
+ * sdb_data_strlen:
+ * Returns a (worst-case) estimate for the number of bytes required to format
+ * the datum as a string. Does not take the terminating null byte into
+ * account.
+ */
+size_t
+sdb_data_strlen(sdb_data_t *datum);
+
+enum {
+ SDB_UNQUOTED = 0,
+ SDB_SINGLE_QUOTED,
+ SDB_DOUBLE_QUOTED,
+};
+
+/*
+ * sdb_data_format:
+ * Output the specified datum to the specified string using a default format.
+ * The value of 'quoted' determines whether and how non-integer and
+ * non-decimal values are quoted. If the buffer size is less than the return
+ * value of sdb_data_strlen, the datum may be truncated. The buffer will
+ * always be nul-terminated after calling this function.
+ *
+ * Returns:
+ * - the number of characters written to the buffer (excluding the terminated
+ * null byte) or the number of characters which would have been written in
+ * case the output was truncated
+ * - a negative value else
+ */
+int
+sdb_data_format(sdb_data_t *datum, char *buf, size_t buflen, int quoted);
+
#ifdef __cplusplus
} /* extern "C" */
#endif