cctools
jx.h
Go to the documentation of this file.
1/*
2Copyright (C) 2022 The University of Notre Dame
3This software is distributed under the GNU General Public License.
4See the file COPYING for details.
5*/
6
7#ifndef JX_H
8#define JX_H
9
39#include <stdint.h>
40#include <inttypes.h>
41
55
56typedef int64_t jx_int_t;
57#define PRIiJX PRIi64
58
60 unsigned line;
61 char *variable;
62 struct jx *elements;
63 struct jx *condition;
64 struct jx_comprehension *next;
65};
66
69struct jx_item {
70 unsigned line;
71 struct jx *value;
72 struct jx_comprehension *comp;
73 struct jx_item *next;
74};
75
78struct jx_pair {
79 unsigned line;
80 struct jx *key;
81 struct jx *value;
82 struct jx_comprehension *comp;
83 struct jx_pair *next;
84};
85
86typedef enum {
87 JX_OP_EQ,
88 JX_OP_NE,
89 JX_OP_LE,
90 JX_OP_LT,
91 JX_OP_GE,
92 JX_OP_GT,
93 JX_OP_ADD,
94 JX_OP_SUB,
95 JX_OP_MUL,
96 JX_OP_DIV,
97 JX_OP_MOD,
98 JX_OP_AND,
99 JX_OP_OR,
100 JX_OP_NOT,
101 JX_OP_LOOKUP,
102 JX_OP_CALL,
103 JX_OP_SLICE,
104 JX_OP_DOT,
105 JX_OP_INVALID,
106} jx_operator_t;
107
109 jx_operator_t type;
110 unsigned line;
111 struct jx *left;
112 struct jx *right;
113};
114
117struct jx {
119 unsigned line;
120 union {
122 jx_int_t integer_value;
125 char * symbol_name;
126 struct jx_item *items;
127 struct jx_pair *pairs;
129 struct jx *err;
130 } u;
131};
132
134struct jx * jx_null();
135
138
140struct jx * jx_integer( jx_int_t integer_value );
141
143struct jx * jx_double( double double_value );
144
146struct jx * jx_string( const char *string_value );
147
150
152struct jx * jx_format( const char *fmt, ... );
153
159struct jx * jx_symbol( const char *symbol_name );
160
165struct jx * jx_error( struct jx *err );
166
168struct jx * jx_array( struct jx_item *items );
169
171struct jx * jx_arrayv( struct jx *value, ... );
172
174struct jx * jx_object( struct jx_pair *pairs );
175
186struct jx * jx_objectv( const char *key, struct jx *value, ... );
187
189struct jx * jx_operator( jx_operator_t oper, struct jx *left, struct jx *right );
190
192struct jx_pair * jx_pair( struct jx *key, struct jx *value, struct jx_pair *next );
193
195struct jx_item * jx_item( struct jx *value, struct jx_item *next );
196
204struct jx_comprehension *jx_comprehension(const char *variable, struct jx *elements, struct jx *condition, struct jx_comprehension *next);
205
207int jx_istype( struct jx *j, jx_type_t type );
208
210int jx_isatomic( struct jx *j );
211
213int jx_istrue( struct jx *j );
214
216int jx_isfalse( struct jx *j );
217
218int jx_comprehension_equals(struct jx_comprehension *j, struct jx_comprehension *k);
219int jx_item_equals(struct jx_item *j, struct jx_item *k);
220int jx_pair_equals(struct jx_pair *j, struct jx_pair *k);
221
224int jx_equals( struct jx *j, struct jx *k );
225
227int jx_array_length( struct jx *array );
228
229struct jx_comprehension *jx_comprehension_copy(struct jx_comprehension *c);
230struct jx_item *jx_item_copy(struct jx_item *i);
231struct jx_pair *jx_pair_copy(struct jx_pair *p);
232
235struct jx * jx_copy( struct jx *j );
236
238void jx_delete( struct jx *j );
239
241void jx_pair_delete( struct jx_pair *p );
242
244void jx_item_delete( struct jx_item *i );
245
248
250struct jx * jx_remove( struct jx *object, struct jx *key );
251
253int jx_insert( struct jx *object, struct jx *key, struct jx *value );
254
256int jx_insert_unless_empty( struct jx *object, struct jx *key, struct jx *value );
257
259void jx_insert_boolean( struct jx *object, const char *key, int value );
260
262void jx_insert_integer( struct jx *object, const char *key, jx_int_t value );
263
265void jx_insert_double( struct jx *object, const char *key, double value );
266
268void jx_insert_string( struct jx *object, const char *key, const char *value );
269
271struct jx * jx_lookup( struct jx *object, const char *key );
272
273/* Like @ref jx_lookup, but found is set to 1 when the key is found. Useful for when value is false. */
274struct jx * jx_lookup_guard( struct jx *j, const char *key, int *found );
275
277const char * jx_lookup_string( struct jx *object, const char *key );
278
280char * jx_lookup_string_dup( struct jx *object, const char *key );
281
283jx_int_t jx_lookup_integer( struct jx *object, const char *key );
284
286int jx_lookup_boolean( struct jx *object, const char *key );
287
289double jx_lookup_double( struct jx *object, const char *key );
290
292void jx_array_insert( struct jx *array, struct jx *value );
293
295void jx_array_append( struct jx *array, struct jx *value );
296
298struct jx * jx_array_index( struct jx *array, int nth );
299
301struct jx *jx_array_concat( struct jx *array, ...);
302
306struct jx *jx_array_shift(struct jx *array);
307
309int jx_is_constant( struct jx *j );
310
312void jx_export( struct jx *j );
313
331struct jx * jx_iterate_array(struct jx *j, void **i);
332
351struct jx * jx_iterate_values(struct jx *j, void **i);
352
371const char *jx_iterate_keys(struct jx *j, void **i);
372
373/* Get the current key while iterating over an object.
374 * The iteration variable must have been passed to jx_iterate_keys
375 * or jx_iterate_values. This directly fetches the current key rather than
376 * doing a lookup from the beginning, so it takes constant time and
377 * can handle repeated keys.
378 */
379const char *jx_get_key(void **i);
380
381/* Get the current value while iterating over an object.
382 * The iteration variable must have been passed to jx_iterate_keys
383 * or jx_iterate_values. This directly fetches the current value rather than
384 * doing a lookup from the beginning, so it takes constant time and
385 * can handle repeated keys.
386 */
387struct jx *jx_get_value(void **i);
388
389
391struct jx *jx_merge(struct jx *j, ...);
392
393#endif
394
395/*vim: set noexpandtab tabstop=8: */
struct jx * jx_objectv(const char *key, struct jx *value,...)
Create a JX object.
struct jx * jx_remove(struct jx *object, struct jx *key)
Remove a key-value pair from an object.
void jx_insert_boolean(struct jx *object, const char *key, int value)
Insert a boolean value into an object.
void jx_insert_integer(struct jx *object, const char *key, jx_int_t value)
Insert an integer value into an object.
struct jx * jx_error(struct jx *err)
Create a JX_ERROR.
void jx_item_delete(struct jx_item *i)
Delete an array item.
struct jx * jx_symbol(const char *symbol_name)
Create a JX symbol.
struct jx * jx_array_shift(struct jx *array)
Remove and return the first element in the array.
int jx_isfalse(struct jx *j)
Test an expression for the boolean value FALSE.
struct jx * jx_string(const char *string_value)
Create a JX string value.
void jx_export(struct jx *j)
Export a jx object into the current environment using setenv().
const char * jx_lookup_string(struct jx *object, const char *key)
Search for a string item in an object.
int jx_insert(struct jx *object, struct jx *key, struct jx *value)
Insert a key-value pair into an object.
char * jx_lookup_string_dup(struct jx *object, const char *key)
Search for a string item in an object.
double jx_lookup_double(struct jx *object, const char *key)
Search for a double item in an object.
struct jx * jx_double(double double_value)
Create a JX floating point value.
void jx_pair_delete(struct jx_pair *p)
Delete a key-value pair.
int jx_array_length(struct jx *array)
Get the length of an array.
int jx_istrue(struct jx *j)
Test an expression for the boolean value TRUE.
jx_int_t jx_lookup_integer(struct jx *object, const char *key)
Search for an integer item in an object.
void jx_comprehension_delete(struct jx_comprehension *comp)
Delete a comprehension.
struct jx * jx_arrayv(struct jx *value,...)
Create a JX array with inline items.
void jx_array_append(struct jx *array, struct jx *value)
Append an item at the end of an array.
struct jx * jx_null()
Create a JX null value.
int jx_istype(struct jx *j, jx_type_t type)
Test an expression's type.
struct jx * jx_array_concat(struct jx *array,...)
Concatenate the given arrays into a single array.
jx_type_t
JX atomic type.
Definition jx.h:43
@ JX_INTEGER
integer value
Definition jx.h:46
@ JX_ERROR
indicates failed evaluation
Definition jx.h:53
@ JX_OBJECT
object containing key-value pairs
Definition jx.h:51
@ JX_ARRAY
array containing values
Definition jx.h:50
@ JX_SYMBOL
variable identifier
Definition jx.h:49
@ JX_STRING
string value
Definition jx.h:48
@ JX_DOUBLE
floating point value
Definition jx.h:47
@ JX_BOOLEAN
true or false
Definition jx.h:45
@ JX_OPERATOR
operator on multiple values.
Definition jx.h:52
@ JX_NULL
null value
Definition jx.h:44
struct jx * jx_array(struct jx_item *items)
Create a JX array.
struct jx * jx_iterate_array(struct jx *j, void **i)
Iterate over the values in an array.
int jx_equals(struct jx *j, struct jx *k)
Test two expressions for equality.
struct jx * jx_integer(jx_int_t integer_value)
Create a JX integer value.
struct jx * jx_iterate_values(struct jx *j, void **i)
Iterate over the values in an object.
struct jx * jx_boolean(int boolean_value)
Create a JX boolean value.
const char * jx_iterate_keys(struct jx *j, void **i)
Iterate over the keys in an object.
int jx_isatomic(struct jx *j)
Test for an atomic value.
struct jx * jx_string_nocopy(char *string_value)
Create a JX string value without copying (uncommon).
struct jx * jx_array_index(struct jx *array, int nth)
Get the nth item in an array.
void jx_insert_double(struct jx *object, const char *key, double value)
Insert a double value into an object.
struct jx * jx_format(const char *fmt,...)
Create a JX string value using prinf style formatting.
struct jx * jx_object(struct jx_pair *pairs)
Create a JX object.
void jx_insert_string(struct jx *object, const char *key, const char *value)
Insert a string value into an object.
void jx_delete(struct jx *j)
Delete an expression recursively.
struct jx * jx_lookup(struct jx *object, const char *key)
Search for a arbitrary item in an object.
void jx_array_insert(struct jx *array, struct jx *value)
Insert an item at the beginning of an array.
int jx_lookup_boolean(struct jx *object, const char *key)
Search for a boolean item in an object.
struct jx * jx_copy(struct jx *j)
Duplicate an expression.
int jx_insert_unless_empty(struct jx *object, struct jx *key, struct jx *value)
Insert a key-value pair into an object, unless the value is an empty collection, in which case delete...
struct jx * jx_merge(struct jx *j,...)
Merge an arbitrary number of JX_OBJECTs into a single new one.
int jx_is_constant(struct jx *j)
Determine if an expression is constant.
Definition jx.h:59
struct jx * elements
items for list comprehension
Definition jx.h:62
char * variable
variable for comprehension
Definition jx.h:61
struct jx * condition
condition for filtering list comprehension
Definition jx.h:63
JX item linked-list used by JX_ARRAY and jx::items.
Definition jx.h:69
struct jx * value
value of this item
Definition jx.h:71
struct jx_item * next
pointer to next item
Definition jx.h:73
Definition jx.h:108
JX key-value pairs used by JX_OBJECT and jx::pairs.
Definition jx.h:78
struct jx * key
key of this pair
Definition jx.h:80
struct jx_pair * next
pointer to next pair
Definition jx.h:83
struct jx * value
value of this pair
Definition jx.h:81
JX value representing any expression type.
Definition jx.h:117
jx_int_t integer_value
value of JX_INTEGER
Definition jx.h:122
struct jx_item * items
value of JX_ARRAY
Definition jx.h:126
int boolean_value
value of JX_BOOLEAN
Definition jx.h:121
struct jx_pair * pairs
value of JX_OBJECT
Definition jx.h:127
struct jx_operator oper
value of JX_OPERATOR
Definition jx.h:128
struct jx * err
error value of JX_ERROR
Definition jx.h:129
double double_value
value of JX_DOUBLE
Definition jx.h:123
unsigned line
line where this value was defined
Definition jx.h:119
char * symbol_name
value of JX_SYMBOL
Definition jx.h:125
jx_type_t type
type of this value
Definition jx.h:118
char * string_value
value of JX_STRING
Definition jx.h:124