summaryrefslogtreecommitdiffstats
path: root/doc/sphinx/grammar/grammar-d2-parser.rst
blob: 4f02ab069be6aa569d59ab437d92e1a4e668c03f (plain)
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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
This grammar is generated from ``d2_parser.yy``. See :ref:`dhcp-ddns-server` for more details.

.. code-block:: BNF
   :linenos:

     Grammar

     $accept ::= start EOF

     start ::= TOPLEVEL_JSON sub_json

     start ::= TOPLEVEL_DHCPDDNS syntax_map

     start ::= SUB_DHCPDDNS sub_dhcpddns

     start ::= SUB_TSIG_KEY sub_tsig_key

     start ::= SUB_TSIG_KEYS sub_tsig_keys

     start ::= SUB_DDNS_DOMAIN sub_ddns_domain

     start ::= SUB_DDNS_DOMAINS sub_ddns_domains

     start ::= SUB_DNS_SERVER sub_dns_server

     start ::= SUB_DNS_SERVERS sub_dns_servers

     start ::= SUB_HOOKS_LIBRARY sub_hooks_library

     value ::= INTEGER
          | FLOAT
          | BOOLEAN
          | STRING
          | NULL
          | map2
          | list_generic

     sub_json ::= value

     map2 ::= "{" map_content "}"

     map_value ::= map2

     map_content ::= 
                | not_empty_map

     not_empty_map ::= STRING ":" value
                  | not_empty_map "," STRING ":" value
                  | not_empty_map ","

     list_generic ::= "[" list_content "]"

     list_content ::= 
                 | not_empty_list

     not_empty_list ::= value
                   | not_empty_list "," value
                   | not_empty_list ","

     unknown_map_entry ::= STRING ":"

     syntax_map ::= "{" global_object "}"

     global_object ::= "DhcpDdns" ":" "{" dhcpddns_params "}"
                  | global_object_comma

     global_object_comma ::= global_object ","

     sub_dhcpddns ::= "{" dhcpddns_params "}"

     dhcpddns_params ::= dhcpddns_param
                    | dhcpddns_params "," dhcpddns_param
                    | dhcpddns_params ","

     dhcpddns_param ::= ip_address
                   | port
                   | dns_server_timeout
                   | ncr_protocol
                   | ncr_format
                   | forward_ddns
                   | reverse_ddns
                   | tsig_keys
                   | control_socket
                   | hooks_libraries
                   | loggers
                   | user_context
                   | comment
                   | unknown_map_entry

     ip_address ::= "ip-address" ":" STRING

     port ::= "port" ":" INTEGER

     dns_server_timeout ::= "dns-server-timeout" ":" INTEGER

     ncr_protocol ::= "ncr-protocol" ":" ncr_protocol_value

     ncr_protocol_value ::= "UDP"
                       | "TCP"

     ncr_format ::= "ncr-format" ":" "JSON"

     user_context ::= "user-context" ":" map_value

     comment ::= "comment" ":" STRING

     forward_ddns ::= "forward-ddns" ":" "{" ddns_mgr_params "}"

     reverse_ddns ::= "reverse-ddns" ":" "{" ddns_mgr_params "}"

     ddns_mgr_params ::= 
                    | not_empty_ddns_mgr_params

     not_empty_ddns_mgr_params ::= ddns_mgr_param
                              | ddns_mgr_params "," ddns_mgr_param
                              | ddns_mgr_params ","

     ddns_mgr_param ::= ddns_domains
                   | unknown_map_entry

     ddns_domains ::= "ddns-domains" ":" "[" ddns_domain_list "]"

     sub_ddns_domains ::= "[" ddns_domain_list "]"

     ddns_domain_list ::= 
                     | not_empty_ddns_domain_list

     not_empty_ddns_domain_list ::= ddns_domain
                               | not_empty_ddns_domain_list "," ddns_domain
                               | not_empty_ddns_domain_list ","

     ddns_domain ::= "{" ddns_domain_params "}"

     sub_ddns_domain ::= "{" ddns_domain_params "}"

     ddns_domain_params ::= ddns_domain_param
                       | ddns_domain_params "," ddns_domain_param
                       | ddns_domain_params ","

     ddns_domain_param ::= ddns_domain_name
                      | ddns_key_name
                      | dns_servers
                      | user_context
                      | comment
                      | unknown_map_entry

     ddns_domain_name ::= "name" ":" STRING

     ddns_key_name ::= "key-name" ":" STRING

     dns_servers ::= "dns-servers" ":" "[" dns_server_list "]"

     sub_dns_servers ::= "[" dns_server_list "]"

     dns_server_list ::= dns_server
                    | dns_server_list "," dns_server
                    | dns_server_list ","

     dns_server ::= "{" dns_server_params "}"

     sub_dns_server ::= "{" dns_server_params "}"

     dns_server_params ::= dns_server_param
                      | dns_server_params "," dns_server_param
                      | dns_server_params ","

     dns_server_param ::= dns_server_hostname
                     | dns_server_ip_address
                     | dns_server_port
                     | ddns_key_name
                     | user_context
                     | comment
                     | unknown_map_entry

     dns_server_hostname ::= "hostname" ":" STRING

     dns_server_ip_address ::= "ip-address" ":" STRING

     dns_server_port ::= "port" ":" INTEGER

     tsig_keys ::= "tsig-keys" ":" "[" tsig_keys_list "]"

     sub_tsig_keys ::= "[" tsig_keys_list "]"

     tsig_keys_list ::= 
                   | not_empty_tsig_keys_list

     not_empty_tsig_keys_list ::= tsig_key
                             | not_empty_tsig_keys_list "," tsig_key
                             | not_empty_tsig_keys_list ","

     tsig_key ::= "{" tsig_key_params "}"

     sub_tsig_key ::= "{" tsig_key_params "}"

     tsig_key_params ::= tsig_key_param
                    | tsig_key_params "," tsig_key_param
                    | tsig_key_params ","

     tsig_key_param ::= tsig_key_name
                   | tsig_key_algorithm
                   | tsig_key_digest_bits
                   | tsig_key_secret
                   | user_context
                   | comment
                   | unknown_map_entry

     tsig_key_name ::= "name" ":" STRING

     tsig_key_algorithm ::= "algorithm" ":" STRING

     tsig_key_digest_bits ::= "digest-bits" ":" INTEGER

     tsig_key_secret ::= "secret" ":" STRING

     control_socket ::= "control-socket" ":" "{" control_socket_params "}"

     control_socket_params ::= control_socket_param
                          | control_socket_params "," control_socket_param
                          | control_socket_params ","

     control_socket_param ::= control_socket_type
                         | control_socket_name
                         | user_context
                         | comment
                         | unknown_map_entry

     control_socket_type ::= "socket-type" ":" STRING

     control_socket_name ::= "socket-name" ":" STRING

     hooks_libraries ::= "hooks-libraries" ":" "[" hooks_libraries_list "]"

     hooks_libraries_list ::= 
                         | not_empty_hooks_libraries_list

     not_empty_hooks_libraries_list ::= hooks_library
                                   | not_empty_hooks_libraries_list "," hooks_library
                                   | not_empty_hooks_libraries_list ","

     hooks_library ::= "{" hooks_params "}"

     sub_hooks_library ::= "{" hooks_params "}"

     hooks_params ::= hooks_param
                 | hooks_params "," hooks_param
                 | hooks_params ","
                 | unknown_map_entry

     hooks_param ::= library
                | parameters

     library ::= "library" ":" STRING

     parameters ::= "parameters" ":" map_value

     loggers ::= "loggers" ":" "[" loggers_entries "]"

     loggers_entries ::= logger_entry
                    | loggers_entries "," logger_entry
                    | loggers_entries ","

     logger_entry ::= "{" logger_params "}"

     logger_params ::= logger_param
                  | logger_params "," logger_param
                  | logger_params ","

     logger_param ::= name
                 | output_options_list
                 | debuglevel
                 | severity
                 | user_context
                 | comment
                 | unknown_map_entry

     name ::= "name" ":" STRING

     debuglevel ::= "debuglevel" ":" INTEGER

     severity ::= "severity" ":" STRING

     output_options_list ::= "output_options" ":" "[" output_options_list_content "]"

     output_options_list_content ::= output_entry
                                | output_options_list_content "," output_entry
                                | output_options_list_content ","

     output_entry ::= "{" output_params_list "}"

     output_params_list ::= output_params
                       | output_params_list "," output_params
                       | output_params_list ","

     output_params ::= output
                  | flush
                  | maxsize
                  | maxver
                  | pattern

     output ::= "output" ":" STRING

     flush ::= "flush" ":" BOOLEAN

     maxsize ::= "maxsize" ":" INTEGER

     maxver ::= "maxver" ":" INTEGER

     pattern ::= "pattern" ":" STRING