xref: /unit/src/nxt_conf.h (revision 773:ff0e7d712ef3)
1 
2 /*
3  * Copyright (C) Igor Sysoev
4  * Copyright (C) Valentin V. Bartenev
5  * Copyright (C) NGINX, Inc.
6  */
7 
8 #ifndef _NXT_CONF_INCLUDED_
9 #define _NXT_CONF_INCLUDED_
10 
11 
12 typedef enum {
13     NXT_CONF_NULL = 0,
14     NXT_CONF_BOOLEAN,
15     NXT_CONF_INTEGER,
16     NXT_CONF_NUMBER,
17     NXT_CONF_STRING,
18     NXT_CONF_ARRAY,
19     NXT_CONF_OBJECT,
20 } nxt_conf_type_t;
21 
22 
23 typedef struct nxt_conf_value_s  nxt_conf_value_t;
24 typedef struct nxt_conf_op_s     nxt_conf_op_t;
25 
26 
27 typedef struct {
28     u_char               *pos;
29     u_char               *detail;
30 } nxt_conf_json_error_t;
31 
32 
33 typedef enum {
34     NXT_CONF_MAP_INT8,
35     NXT_CONF_MAP_INT32,
36     NXT_CONF_MAP_INT64,
37     NXT_CONF_MAP_INT,
38     NXT_CONF_MAP_SIZE,
39     NXT_CONF_MAP_OFF,
40     NXT_CONF_MAP_MSEC,
41     NXT_CONF_MAP_DOUBLE,
42     NXT_CONF_MAP_STR,
43     NXT_CONF_MAP_STR_COPY,
44     NXT_CONF_MAP_CSTRZ,
45     NXT_CONF_MAP_PTR,
46 } nxt_conf_map_type_t;
47 
48 
49 typedef struct {
50     nxt_str_t            name;
51     nxt_conf_map_type_t  type;
52     size_t               offset;
53 } nxt_conf_map_t;
54 
55 
56 typedef struct {
57     uint32_t             level;
58     uint8_t              more_space;  /* 1 bit. */
59 } nxt_conf_json_pretty_t;
60 
61 
62 typedef struct {
63     nxt_conf_value_t     *conf;
64     nxt_mp_t             *pool;
65     nxt_str_t            error;
66 } nxt_conf_validation_t;
67 
68 
69 NXT_EXPORT nxt_uint_t nxt_conf_type(nxt_conf_value_t *value);
70 
71 NXT_EXPORT nxt_conf_value_t *nxt_conf_get_path(nxt_conf_value_t *value,
72     nxt_str_t *path);
73 NXT_EXPORT nxt_conf_value_t *nxt_conf_get_object_member(nxt_conf_value_t *value,
74     nxt_str_t *name, uint32_t *index);
75 NXT_EXPORT nxt_conf_value_t *nxt_conf_next_object_member(
76     nxt_conf_value_t *value, nxt_str_t *name, uint32_t *next);
77 NXT_EXPORT nxt_conf_value_t *nxt_conf_get_array_element(nxt_conf_value_t *value,
78     uint32_t index);
79 
80 NXT_EXPORT nxt_int_t nxt_conf_map_object(nxt_mp_t *mp, nxt_conf_value_t *value,
81     nxt_conf_map_t *map, nxt_uint_t n, void *data);
82 
83 nxt_int_t nxt_conf_op_compile(nxt_mp_t *mp, nxt_conf_op_t **ops,
84     nxt_conf_value_t *root, nxt_str_t *path, nxt_conf_value_t *value);
85 nxt_conf_value_t *nxt_conf_clone(nxt_mp_t *mp, nxt_conf_op_t *op,
86     nxt_conf_value_t *value);
87 
88 nxt_conf_value_t *nxt_conf_json_parse(nxt_mp_t *mp, u_char *start, u_char *end,
89     nxt_conf_json_error_t *error);
90 
91 #define nxt_conf_json_parse_str(mp, str)                                      \
92     nxt_conf_json_parse(mp, (str)->start, (str)->start + (str)->length, NULL)
93 
94 size_t nxt_conf_json_length(nxt_conf_value_t *value,
95     nxt_conf_json_pretty_t *pretty);
96 u_char *nxt_conf_json_print(u_char *p, nxt_conf_value_t *value,
97     nxt_conf_json_pretty_t *pretty);
98 void nxt_conf_json_position(u_char *start, u_char *pos, nxt_uint_t *line,
99     nxt_uint_t *column);
100 
101 nxt_int_t nxt_conf_validate(nxt_conf_validation_t *vldt);
102 
103 NXT_EXPORT void nxt_conf_get_string(nxt_conf_value_t *value, nxt_str_t *str);
104 NXT_EXPORT void nxt_conf_set_string(nxt_conf_value_t *value, nxt_str_t *str);
105 NXT_EXPORT int64_t nxt_conf_get_integer(nxt_conf_value_t *value);
106 
107 // FIXME reimplement and reorder functions below
108 nxt_uint_t nxt_conf_object_members_count(nxt_conf_value_t *value);
109 nxt_conf_value_t *nxt_conf_create_object(nxt_mp_t *mp, nxt_uint_t count);
110 void nxt_conf_set_member(nxt_conf_value_t *object, nxt_str_t *name,
111     nxt_conf_value_t *value, uint32_t index);
112 void nxt_conf_set_member_string(nxt_conf_value_t *object, nxt_str_t *name,
113     nxt_str_t *value, uint32_t index);
114 void nxt_conf_set_member_integer(nxt_conf_value_t *object, nxt_str_t *name,
115     int64_t value, uint32_t index);
116 
117 
118 #endif /* _NXT_CONF_INCLUDED_ */
119