cctools
jx.h
Go to the documentation of this file.
1 /*
2 Copyright (C) 2015- The University of Notre Dame
3 This software is distributed under the GNU General Public License.
4 See 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 
43 typedef enum {
44  JX_NULL = 0,
54 } jx_type_t;
55 
56 typedef 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 
69 struct jx_item {
70  unsigned line;
71  struct jx *value;
72  struct jx_comprehension *comp;
73  struct jx_item *next;
74 };
75 
78 struct 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 
86 typedef 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 
108 struct jx_operator {
109  jx_operator_t type;
110  unsigned line;
111  struct jx *left;
112  struct jx *right;
113 };
114 
117 struct jx {
119  unsigned line;
120  union {
122  jx_int_t integer_value;
123  double double_value;
124  char * string_value;
125  char * symbol_name;
126  struct jx_item *items;
127  struct jx_pair *pairs;
128  struct jx_operator oper;
129  struct jx *err;
130  } u;
131 };
132 
134 struct jx * jx_null();
135 
137 struct jx * jx_boolean( int boolean_value );
138 
140 struct jx * jx_integer( jx_int_t integer_value );
141 
143 struct jx * jx_double( double double_value );
144 
146 struct jx * jx_string( const char *string_value );
147 
149 struct jx * jx_string_nocopy( char *string_value );
150 
152 struct jx * jx_format( const char *fmt, ... );
153 
156 struct jx * jx_symbol( const char *symbol_name );
157 
159 struct jx * jx_error( struct jx *err );
160 
162 struct jx * jx_array( struct jx_item *items );
163 
165 struct jx * jx_arrayv( struct jx *value, ... );
166 
168 struct jx * jx_object( struct jx_pair *pairs );
169 
180 struct jx * jx_objectv( const char *key, struct jx *value, ... );
181 
183 struct jx * jx_operator( jx_operator_t oper, struct jx *left, struct jx *right );
184 
186 struct jx_pair * jx_pair( struct jx *key, struct jx *value, struct jx_pair *next );
187 
189 struct jx_item * jx_item( struct jx *value, struct jx_item *next );
190 
198 struct jx_comprehension *jx_comprehension(const char *variable, struct jx *elements, struct jx *condition, struct jx_comprehension *next);
199 
201 int jx_istype( struct jx *j, jx_type_t type );
202 
204 int jx_isatomic( struct jx *j );
205 
207 int jx_istrue( struct jx *j );
208 
209 int jx_comprehension_equals(struct jx_comprehension *j, struct jx_comprehension *k);
210 int jx_item_equals(struct jx_item *j, struct jx_item *k);
211 int jx_pair_equals(struct jx_pair *j, struct jx_pair *k);
212 
215 int jx_equals( struct jx *j, struct jx *k );
216 
218 int jx_array_length( struct jx *array );
219 
220 struct jx_comprehension *jx_comprehension_copy(struct jx_comprehension *c);
221 struct jx_item *jx_item_copy(struct jx_item *i);
222 struct jx_pair *jx_pair_copy(struct jx_pair *p);
223 
226 struct jx * jx_copy( struct jx *j );
227 
229 void jx_delete( struct jx *j );
230 
232 void jx_pair_delete( struct jx_pair *p );
233 
235 void jx_item_delete( struct jx_item *i );
236 
238 void jx_comprehension_delete(struct jx_comprehension *comp);
239 
241 struct jx * jx_remove( struct jx *object, struct jx *key );
242 
244 int jx_insert( struct jx *object, struct jx *key, struct jx *value );
245 
247 int jx_insert_unless_empty( struct jx *object, struct jx *key, struct jx *value );
248 
250 void jx_insert_boolean( struct jx *object, const char *key, int value );
251 
253 void jx_insert_integer( struct jx *object, const char *key, jx_int_t value );
254 
256 void jx_insert_double( struct jx *object, const char *key, double value );
257 
259 void jx_insert_string( struct jx *object, const char *key, const char *value );
260 
262 struct jx * jx_lookup( struct jx *object, const char *key );
263 
264 /* Like @ref jx_lookup, but found is set to 1 when the key is found. Useful for when value is false. */
265 struct jx * jx_lookup_guard( struct jx *j, const char *key, int *found );
266 
268 const char * jx_lookup_string( struct jx *object, const char *key );
269 
271 char * jx_lookup_string_dup( struct jx *object, const char *key );
272 
274 jx_int_t jx_lookup_integer( struct jx *object, const char *key );
275 
277 int jx_lookup_boolean( struct jx *object, const char *key );
278 
280 double jx_lookup_double( struct jx *object, const char *key );
281 
283 void jx_array_insert( struct jx *array, struct jx *value );
284 
286 void jx_array_append( struct jx *array, struct jx *value );
287 
289 struct jx * jx_array_index( struct jx *array, int nth );
290 
292 struct jx *jx_array_concat( struct jx *array, ...);
293 
297 struct jx *jx_array_shift(struct jx *array);
298 
300 int jx_is_constant( struct jx *j );
301 
303 void jx_export( struct jx *j );
304 
322 struct jx * jx_iterate_array(struct jx *j, void **i);
323 
342 struct jx * jx_iterate_values(struct jx *j, void **i);
343 
362 const char *jx_iterate_keys(struct jx *j, void **i);
363 
364 /* Get the current key while iterating over an object.
365  * The iteration variable must have been passed to jx_iterate_keys
366  * or jx_iterate_values. This directly fetches the current key rather than
367  * doing a lookup from the beginning, so it takes constant time and
368  * can handle repeated keys.
369  */
370 const char *jx_get_key(void **i);
371 
372 /* Get the current value while iterating over an object.
373  * The iteration variable must have been passed to jx_iterate_keys
374  * or jx_iterate_values. This directly fetches the current value rather than
375  * doing a lookup from the beginning, so it takes constant time and
376  * can handle repeated keys.
377  */
378 struct jx *jx_get_value(void **i);
379 
380 
382 struct jx *jx_merge(struct jx *j, ...);
383 
384 #endif
385 
386 /*vim: set noexpandtab tabstop=4: */
int jx_insert(struct jx *object, struct jx *key, struct jx *value)
Insert a key-value pair into an object.
null value
Definition: jx.h:44
struct jx * jx_remove(struct jx *object, struct jx *key)
Remove a key-value pair from an object.
unsigned line
line where this value was defined
Definition: jx.h:119
struct jx * jx_object(struct jx_pair *pairs)
Create a JX object.
indicates failed evaluation
Definition: jx.h:53
struct jx_item * jx_item(struct jx *value, struct jx_item *next)
Create a JX array item.
struct jx_item * next
pointer to next item
Definition: jx.h:73
int jx_istrue(struct jx *j)
Test an expression for the boolean value TRUE.
true or false
Definition: jx.h:45
int jx_istype(struct jx *j, jx_type_t type)
Test an expression&#39;s type.
char * string_value
value of JX_STRING
Definition: jx.h:124
void jx_insert_double(struct jx *object, const char *key, double value)
Insert a double value into 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_objectv(const char *key, struct jx *value,...)
Create a JX object.
struct jx * jx_format(const char *fmt,...)
Create a JX string value using prinf style formatting.
floating point value
Definition: jx.h:47
object containing key-value pairs
Definition: jx.h:51
JX item linked-list used by JX_ARRAY and jx::items.
Definition: jx.h:69
struct jx * key
key of this pair
Definition: jx.h:80
char * symbol_name
value of JX_SYMBOL
Definition: jx.h:125
void jx_pair_delete(struct jx_pair *p)
Delete a key-value pair.
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_boolean(int boolean_value)
Create a JX boolean value.
double jx_lookup_double(struct jx *object, const char *key)
Search for a double item in an object.
struct jx * jx_merge(struct jx *j,...)
Merge an arbitrary number of JX_OBJECTs into a single new one.
struct jx_pair * next
pointer to next pair
Definition: jx.h:83
struct jx * jx_error(struct jx *err)
Create a JX_ERROR.
int boolean_value
value of JX_BOOLEAN
Definition: jx.h:121
struct jx * jx_iterate_array(struct jx *j, void **i)
Iterate over the values in an array.
int jx_array_length(struct jx *array)
Get the length of an array.
double double_value
value of JX_DOUBLE
Definition: jx.h:123
void jx_insert_boolean(struct jx *object, const char *key, int value)
Insert a boolean value into an object.
struct jx * jx_string_nocopy(char *string_value)
Create a JX string value without copying (uncommon).
struct jx * elements
items for list comprehension
Definition: jx.h:62
Definition: jx.h:108
int jx_is_constant(struct jx *j)
Determine if an expression is constant.
struct jx * value
value of this pair
Definition: jx.h:81
array containing values
Definition: jx.h:50
struct jx * jx_array_index(struct jx *array, int nth)
Get the nth item in an array.
struct jx * jx_integer(jx_int_t integer_value)
Create a JX integer value.
struct jx * jx_copy(struct jx *j)
Duplicate an expression.
struct jx * value
value of this item
Definition: jx.h:71
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_operator(jx_operator_t oper, struct jx *left, struct jx *right)
Create a JX binary expression,.
struct jx * err
error value of JX_ERROR
Definition: jx.h:129
struct jx * jx_string(const char *string_value)
Create a JX string value.
operator on multiple values.
Definition: jx.h:52
struct jx * jx_array(struct jx_item *items)
Create a JX array.
int jx_isatomic(struct jx *j)
Test for an atomic value.
integer value
Definition: jx.h:46
const char * jx_lookup_string(struct jx *object, const char *key)
Search for a string item in an object.
void jx_export(struct jx *j)
Export a jx object as a set of environment variables.
Definition: jx.h:59
variable identifier
Definition: jx.h:49
struct jx * jx_iterate_values(struct jx *j, void **i)
Iterate over the values in an object.
struct jx_pair * pairs
value of JX_OBJECT
Definition: jx.h:127
struct jx * condition
condition for filtering list comprehension
Definition: jx.h:63
jx_int_t integer_value
value of JX_INTEGER
Definition: jx.h:122
char * variable
variable for comprehension
Definition: jx.h:61
struct jx * jx_symbol(const char *symbol_name)
Create a JX symbol.
void jx_insert_integer(struct jx *object, const char *key, jx_int_t value)
Insert an integer value into an object.
void jx_item_delete(struct jx_item *i)
Delete an array item.
JX value representing any expression type.
Definition: jx.h:117
const char * jx_iterate_keys(struct jx *j, void **i)
Iterate over the keys in an object.
jx_type_t type
type of this value
Definition: jx.h:118
struct jx_operator oper
value of JX_OPERATOR
Definition: jx.h:128
struct jx * jx_array_shift(struct jx *array)
Remove and return the first element in the array.
struct jx * jx_lookup(struct jx *object, const char *key)
Search for a arbitrary item in an object.
struct jx * jx_array_concat(struct jx *array,...)
Concatenate the given arrays into a single array.
struct jx_comprehension * jx_comprehension(const char *variable, struct jx *elements, struct jx *condition, struct jx_comprehension *next)
Create a JX comprehension.
struct jx_pair * jx_pair(struct jx *key, struct jx *value, struct jx_pair *next)
Create a JX key-value pair.
struct jx * jx_double(double double_value)
Create a JX floating point value.
struct jx * jx_arrayv(struct jx *value,...)
Create a JX array with inline items.
JX key-value pairs used by JX_OBJECT and jx::pairs.
Definition: jx.h:78
jx_int_t jx_lookup_integer(struct jx *object, const char *key)
Search for an integer item in an object.
jx_type_t
JX atomic type.
Definition: jx.h:43
void jx_comprehension_delete(struct jx_comprehension *comp)
Delete a comprehension.
string value
Definition: jx.h:48
void jx_array_append(struct jx *array, struct jx *value)
Append an item at the end of an array.
struct jx_item * items
value of JX_ARRAY
Definition: jx.h:126
struct jx * jx_null()
Create a JX null value.
char * jx_lookup_string_dup(struct jx *object, const char *key)
Search for a string item in an object.
int jx_equals(struct jx *j, struct jx *k)
Test two expressions for equality.