1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
/** @file
A general structure for extracting hierarchical data from the devices;
typically key-value pairs, but allows for more rich data as well.
Copyright (C) 2015 by Erkki Seppälä <flux@modeemi.fi>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef INCLUDE_DATA_H_
#define INCLUDE_DATA_H_
#if defined _WIN32 || defined __CYGWIN__
#if defined data_EXPORTS
#define R_API __stdcall __declspec(dllexport) // Note: actually gcc seems to also supports this syntax.
#elif defined data_IMPORTS
#define R_API __stdcall __declspec(dllimport) // Note: actually gcc seems to also supports this syntax.
#else
#define R_API // for static linking
#endif
#define R_API_CALLCONV __stdcall
#else
#if __GNUC__ >= 4
#define R_API __attribute__((visibility ("default")))
#else
#define R_API
#endif
#define R_API_CALLCONV
#endif
#include <stddef.h>
#include <stdint.h>
typedef enum {
DATA_DATA, /**< pointer to data is stored */
DATA_INT, /**< pointer to integer is stored */
DATA_DOUBLE, /**< pointer to a double is stored */
DATA_STRING, /**< pointer to a string is stored */
DATA_ARRAY, /**< pointer to an array of values is stored */
DATA_COUNT, /**< invalid */
DATA_FORMAT, /**< indicates the following value is formatted */
DATA_COND, /**< add data only if condition is true, skip otherwise */
} data_type_t;
typedef struct data_array {
int num_values;
data_type_t type;
void *values;
} data_array_t;
// Note: Do not unwrap a packed array to data_value_t,
// on 32-bit the union has different size/alignment than a pointer.
typedef union data_value {
int v_int; /**< A data value of type int, 4 bytes size/alignment */
double v_dbl; /**< A data value of type double, 8 bytes size/alignment */
void *v_ptr; /**< A data value pointer, 4/8 bytes size/alignment */
} data_value_t;
typedef struct data {
struct data *next; /**< chaining to the next element in the linked list; NULL indicates end-of-list */
char *key;
char *pretty_key; /**< the name used for displaying data to user in with a nicer name */
char *format; /**< if not null, contains special formatting string */
data_value_t value;
data_type_t type;
unsigned retain; /**< incremented on data_retain, data_free only frees if this is zero */
} data_t;
/** Constructs a structured data object.
Example:
data_make(
"key", "Pretty key", DATA_INT, 42,
"others", "More data", DATA_DATA, data_make("foo", DATA_DOUBLE, 42.0, NULL),
"zoom", NULL, data_array(2, DATA_STRING, (char*[]){"hello", "World"}),
"double", "Double", DATA_DOUBLE, 10.0/3,
NULL);
Most of the time the function copies perhaps what you expect it to. Things
it copies:
- string contents for keys and values
- numerical arrays
- string arrays (copied deeply)
Things it moves:
- recursive data_t* and data_array_t* values
The rule is: if an object is boxed (look at the dmt structure in the data.c)
and it has a array_elementwise_import in the same structure, then it is
copied deeply. Otherwise, it is copied shallowly.
@param key Name of the first value to put in.
@param pretty_key Pretty name for the key. Use "" if to omit pretty label for this field completely,
or NULL if to use key name for it.
@param ... Type and then value of the item to put in, followed by the rest of the
key-type-values. The list is terminated with a NULL.
@return A constructed data_t* object or NULL if there was a memory allocation error.
*/
R_API data_t *data_make(const char *key, const char *pretty_key, ...);
/** Adds to a structured data object, by prepending data.
@see data_make()
*/
R_API data_t *data_prepend(data_t *tail, data_t *head);
/** Adds to a structured data object, by appending `int` data.
Type-safe alternative to `data_make()` and `data_append()`.
*/
R_API data_t *data_int(data_t *first, char const *key, char const *pretty_key, char const *format, int val);
/** Adds to a structured data object, by appending `double` data.
Type-safe alternative to `data_make()` and `data_append()`.
*/
R_API data_t *data_dbl(data_t *first, char const *key, char const *pretty_key, char const *format, double val);
/** Adds to a structured data object, by appending string data.
Type-safe alternative to `data_make()` and `data_append()`.
*/
R_API data_t *data_str(data_t *first, char const *key, char const *pretty_key, char const *format, char const *val);
/** Adds to a structured data object, by appending `data_array_t` data.
Type-safe alternative to `data_make()` and `data_append()`.
*/
R_API data_t *data_ary(data_t *first, char const *key, char const *pretty_key, char const *format, data_array_t *val);
/** Adds to a structured data object, by appending `data_t` data.
Type-safe alternative to `data_make()` and `data_append()`.
*/
R_API data_t *data_dat(data_t *first, char const *key, char const *pretty_key, char const *format, data_t *val);
/** Adds to a structured data object, by appending hex string data.
Type-safe alternative to `data_make()` and `data_append()`.
If `format` is NULL or empty then a default of "%02x" is used.
Caller needs to provide a sufficiently sized buffer.
*/
R_API data_t *data_hex(data_t *first, char const *key, char const *pretty_key, char const *format, uint8_t const *val, unsigned len, char *buf);
/** Constructs an array from given data of the given uniform type.
@param num_values The number of values to be copied.
@param type The type of values to be copied.
@param ptr The contents pointed by the argument are copied in.
@return The constructed data array object, typically placed inside a data_t or NULL
if there was a memory allocation error.
*/
R_API data_array_t *data_array(int num_values, data_type_t type, void const *ptr);
/** Releases a data array. */
R_API void data_array_free(data_array_t *array);
/** Retain a structure object, returns the structure object passed in. */
R_API data_t *data_retain(data_t *data);
/** Releases a structure object if retain is zero, decrement retain otherwise. */
R_API void data_free(data_t *data);
struct data_output;
typedef struct data_output {
void (R_API_CALLCONV *print_data)(struct data_output *output, data_t *data, char const *format);
void (R_API_CALLCONV *print_array)(struct data_output *output, data_array_t *data, char const *format);
void (R_API_CALLCONV *print_string)(struct data_output *output, const char *data, char const *format);
void (R_API_CALLCONV *print_double)(struct data_output *output, double data, char const *format);
void (R_API_CALLCONV *print_int)(struct data_output *output, int data, char const *format);
void (R_API_CALLCONV *output_start)(struct data_output *output, char const *const *fields, int num_fields);
void (R_API_CALLCONV *output_print)(struct data_output *output, data_t *data);
void (R_API_CALLCONV *output_free)(struct data_output *output);
int log_level; ///< the maximum log level (verbosity) allowed, more verbose messages must be ignored.
} data_output_t;
/** Setup known field keys and start output, used by CSV only.
@param output the data_output handle from data_output_x_create
@param fields the list of fields to accept and expect. Array is copied, but the actual
strings not. The list may contain duplicates and they are eliminated.
@param num_fields number of fields
*/
R_API void data_output_start(struct data_output *output, char const *const *fields, int num_fields);
/** Prints a structured data object, flushes the output if applicable. */
R_API void data_output_print(struct data_output *output, data_t *data);
R_API void data_output_free(struct data_output *output);
/* data output helpers */
R_API void print_value(data_output_t *output, data_type_t type, data_value_t value, char const *format);
R_API void print_array_value(data_output_t *output, data_array_t *array, char const *format, int idx);
R_API size_t data_print_jsons(data_t *data, char *dst, size_t len);
#endif // INCLUDE_DATA_H_
|
