xref: /unit/src/nxt_conf.h (revision 2632:77c672f9ba45)
1 
2 /*
3  * Copyright (C) Igor Sysoev
4  * Copyright (C) Valentin V. Bartenev
5  * Copyright (C) NGINX, Inc.
6  * Copyright 2024, Alejandro Colomar <alx@kernel.org>
7  */
8 
9 #ifndef _NXT_CONF_INCLUDED_
10 #define _NXT_CONF_INCLUDED_
11 
12 
13 typedef enum {
14     NXT_CONF_NULL = 0,
15     NXT_CONF_BOOLEAN,
16     NXT_CONF_INTEGER,
17     NXT_CONF_NUMBER,
18     NXT_CONF_STRING,
19     NXT_CONF_ARRAY,
20     NXT_CONF_OBJECT,
21 } nxt_conf_type_t;
22 
23 
24 typedef enum {
25     NXT_CONF_OP_OK = 0,
26     NXT_CONF_OP_NOT_FOUND,
27     NXT_CONF_OP_NOT_ALLOWED,
28     NXT_CONF_OP_ERROR,
29 } nxt_conf_op_ret_t;
30 
31 
32 typedef struct nxt_conf_value_s  nxt_conf_value_t;
33 typedef struct nxt_conf_op_s     nxt_conf_op_t;
34 
35 
36 typedef struct {
37     u_char               *pos;
38     u_char               *detail;
39 } nxt_conf_json_error_t;
40 
41 
42 typedef enum {
43     NXT_CONF_MAP_INT8,
44     NXT_CONF_MAP_INT32,
45     NXT_CONF_MAP_INT64,
46     NXT_CONF_MAP_INT,
47     NXT_CONF_MAP_SIZE,
48     NXT_CONF_MAP_OFF,
49     NXT_CONF_MAP_MSEC,
50     NXT_CONF_MAP_DOUBLE,
51     NXT_CONF_MAP_STR,
52     NXT_CONF_MAP_STR_COPY,
53     NXT_CONF_MAP_CSTRZ,
54     NXT_CONF_MAP_PTR,
55 } nxt_conf_map_type_t;
56 
57 
58 typedef struct {
59     nxt_str_t            name;
60     nxt_conf_map_type_t  type;
61     size_t               offset;
62 } nxt_conf_map_t;
63 
64 
65 typedef struct {
66     uint32_t             level;
67     uint8_t              more_space;  /* 1 bit. */
68 } nxt_conf_json_pretty_t;
69 
70 
71 typedef struct {
72     nxt_conf_value_t     *conf;
73     nxt_mp_t             *pool;
74     nxt_str_t            error;
75     void                 *ctx;
76     nxt_tstr_state_t     *tstr_state;
77     nxt_mp_t             *conf_pool;
78     nxt_uint_t           ver;
79 } nxt_conf_validation_t;
80 
81 
82 NXT_EXPORT nxt_uint_t nxt_conf_type(nxt_conf_value_t *value);
83 
84 NXT_EXPORT nxt_conf_value_t *nxt_conf_get_path(nxt_conf_value_t *value,
85     nxt_str_t *path);
86 NXT_EXPORT nxt_conf_value_t *nxt_conf_get_object_member(nxt_conf_value_t *value,
87     nxt_str_t *name, uint32_t *index);
88 NXT_EXPORT nxt_conf_value_t *nxt_conf_next_object_member(
89     nxt_conf_value_t *value, nxt_str_t *name, uint32_t *next);
90 NXT_EXPORT nxt_conf_value_t *nxt_conf_get_array_element(nxt_conf_value_t *value,
91     uint32_t index);
92 NXT_EXPORT nxt_conf_value_t *nxt_conf_get_array_element_or_itself(
93     nxt_conf_value_t *value, uint32_t index);
94 
95 NXT_EXPORT nxt_int_t nxt_conf_map_object(nxt_mp_t *mp, nxt_conf_value_t *value,
96     nxt_conf_map_t *map, nxt_uint_t n, void *data);
97 
98 nxt_conf_op_ret_t nxt_conf_op_compile(nxt_mp_t *mp, nxt_conf_op_t **ops,
99     nxt_conf_value_t *root, nxt_str_t *path, nxt_conf_value_t *value,
100     nxt_bool_t add);
101 nxt_conf_value_t *nxt_conf_clone(nxt_mp_t *mp, nxt_conf_op_t *op,
102     nxt_conf_value_t *value);
103 
104 nxt_conf_value_t *nxt_conf_json_parse(nxt_mp_t *mp, u_char *start, u_char *end,
105     nxt_conf_json_error_t *error);
106 
107 #define nxt_conf_json_parse_str(mp, str)                                      \
108     nxt_conf_json_parse(mp, (str)->start, (str)->start + (str)->length, NULL)
109 
110 size_t nxt_conf_json_length(nxt_conf_value_t *value,
111     nxt_conf_json_pretty_t *pretty);
112 u_char *nxt_conf_json_print(u_char *p, nxt_conf_value_t *value,
113     nxt_conf_json_pretty_t *pretty);
114 void nxt_conf_json_position(u_char *start, const u_char *pos, nxt_uint_t *line,
115     nxt_uint_t *column);
116 
117 nxt_int_t nxt_conf_validate(nxt_conf_validation_t *vldt);
118 
119 NXT_EXPORT void nxt_conf_get_string(nxt_conf_value_t *value, nxt_str_t *str);
120 NXT_EXPORT nxt_str_t *nxt_conf_get_string_dup(nxt_conf_value_t *value,
121     nxt_mp_t *mp, nxt_str_t *str);
122 NXT_EXPORT void nxt_conf_set_string(nxt_conf_value_t *value, nxt_str_t *str);
123 NXT_EXPORT nxt_int_t nxt_conf_set_string_dup(nxt_conf_value_t *value,
124     nxt_mp_t *mp, const nxt_str_t *str);
125 NXT_EXPORT double nxt_conf_get_number(nxt_conf_value_t *value);
126 NXT_EXPORT uint8_t nxt_conf_get_boolean(nxt_conf_value_t *value);
127 
128 // FIXME reimplement and reorder functions below
129 NXT_EXPORT nxt_uint_t nxt_conf_object_members_count(nxt_conf_value_t *value);
130 nxt_conf_value_t *nxt_conf_create_object(nxt_mp_t *mp, nxt_uint_t count);
131 void nxt_conf_set_member(nxt_conf_value_t *object, nxt_str_t *name,
132     const nxt_conf_value_t *value, uint32_t index);
133 nxt_int_t nxt_conf_set_member_dup(nxt_conf_value_t *object, nxt_mp_t *mp,
134     nxt_str_t *name, nxt_conf_value_t *value, uint32_t index);
135 void nxt_conf_set_member_string(nxt_conf_value_t *object, nxt_str_t *name,
136     nxt_str_t *value, uint32_t index);
137 nxt_int_t nxt_conf_set_member_string_dup(nxt_conf_value_t *object, nxt_mp_t *mp,
138     nxt_str_t *name, nxt_str_t *value, uint32_t index);
139 void nxt_conf_set_member_integer(nxt_conf_value_t *object, nxt_str_t *name,
140     int64_t value, uint32_t index);
141 void nxt_conf_set_member_null(nxt_conf_value_t *object, nxt_str_t *name,
142     uint32_t index);
143 
144 nxt_conf_value_t *nxt_conf_create_array(nxt_mp_t *mp, nxt_uint_t count);
145 void nxt_conf_set_element(nxt_conf_value_t *array, nxt_uint_t index,
146     const nxt_conf_value_t *value);
147 nxt_int_t nxt_conf_set_element_string_dup(nxt_conf_value_t *array, nxt_mp_t *mp,
148     nxt_uint_t index, nxt_str_t *value);
149 NXT_EXPORT nxt_uint_t nxt_conf_array_elements_count(nxt_conf_value_t *value);
150 NXT_EXPORT nxt_uint_t nxt_conf_array_elements_count_or_1(
151     nxt_conf_value_t *value);
152 void nxt_conf_array_qsort(nxt_conf_value_t *value,
153     int (*compare)(const void *, const void *));
154 
155 
156 #endif /* _NXT_CONF_INCLUDED_ */
157