-
Notifications
You must be signed in to change notification settings - Fork 36
/
Copy pathpiqi.piqi
406 lines (309 loc) · 7.42 KB
/
piqi.piqi
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
% Copyright 2009, 2010, 2011, 2012, 2013, 2014, 2017 Anton Lavrik
%
% Licensed under the Apache License, Version 2.0 (the "License");
% you may not use this file except in compliance with the License.
% You may obtain a copy of the License at
%
% http://www.apache.org/licenses/LICENSE-2.0
%
% Unless required by applicable law or agreed to in writing, software
% distributed under the License is distributed on an "AS IS" BASIS,
% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
% See the License for the specific language governing permissions and
% limitations under the License.
% The current Piqi self-specification
%
% This file contains definition of the Piqi self-specification
% aliases for built-in types; these definitions are automatically included in
% each Piqi module except modules named "piqi"
.alias [ .name bool .piqi-type.bool ]
.alias [ .name string .piqi-type.string ]
.alias [ .name binary .piqi-type.binary ]
.alias [ .name piqi-any .piqi-type.any ]
.alias [ .name int .piqi-type.int ]
.alias [ .name uint .piqi-type.int ]
.alias [ .name int32 .piqi-type.int ]
.alias [ .name uint32 .piqi-type.int ]
.alias [ .name int64 .piqi-type.int ]
.alias [ .name uint64 .piqi-type.int ]
.alias [ .name float64 .piqi-type.float ]
.alias [ .name float32 .piqi-type.float ]
% Fixed versions of int32/64 and uint32/64. "Fixed" here means that they are
% represented on the wire using exactly 4 and 8 bytes respectively.
.alias [
.name int32-fixed
.type int32
.piqi-type.int
]
.alias [
.name uint32-fixed
.type uint32
.piqi-type.int
]
.alias [
.name int64-fixed
.type int64
.piqi-type.int
]
.alias [
.name uint64-fixed
.type uint64
.piqi-type.int
]
.alias [
.name float
.type float64
.piqi-type.float
]
%
% end of built-in types
%
.alias [
.name word
.type string
.piq-format.word % print it as word instead of a quoted string literal
]
.alias [
.name name
.type word
]
.variant [
% user-defined types
.name typedef
.option [ .type record ]
.option [ .type variant ]
.option [ .type enum ]
.option [ .type alias ]
.option [
.type list
]
.protobuf-name "piqi_typedef"
]
.enum [
% built-in Piqi types
.name piqi-type
% prefix all options in order to prevent clash with keywords of the Protobuf
% target languages
.protobuf-prefix "piqi_type_"
.option [ .name int ]
.option [ .name float ]
.option [ .name bool ]
.option [ .name string ]
.option [ .name binary ]
.option [ .name any ]
]
.alias [
.name type
.type name
]
.record [
.name record
.field [ .type name ]
.field [
.type field
.repeated
]
]
.record [
.name field
.field [
.type name
.optional
]
.field [
.type type
.optional
]
.field [
.name mode
.type field-mode
.optional
.default.required
]
.field [
.name default
.type piqi-any
.optional
]
.field [
% experimental: indication that the field has been deprecated; which
% means that it may not be supported any more and use of such field is
% discouraged
.name deprecated
.optional
]
]
.enum [
.name field-mode
.option [ .name required ]
.option [ .name optional ]
.option [ .name repeated ]
]
.record [
.name variant
.field [ .type name ]
.field [
.type option
.repeated % > 1
]
]
.record [
.name option
% NOTE: either name or type have to be present
.field [
.type name
.optional
]
.field [
.type type
.optional
]
.field [
% experimental: indication that the option has been deprecated; which
% means that it may not be supported any more and use of such field is
% discouraged
.name deprecated
.optional
]
]
.record [
.name enum
.field [ .type name ]
% note that enum options shouldn't specify type and must specify name
.field [
.type option
.repeated % > 1
]
.protobuf-name "piqi_enum"
]
.record [
.name alias
.field [ .type name ]
% either type or piqi-type fields must be present; we don't use variant here
% in order to simplify external representation which is going to be flat in
% such case, as opposed to nested if we used variant
.field [
.type type
.optional
]
.field [
.type piqi-type
.optional
]
]
.record [
.name list
.field [ .type name ]
.field [ .type type ]
]
.record [
.name piqi
.field [
.name module
.type word
.optional
]
.field [ .type typedef .repeated ]
.field [ .type import .repeated ]
.field [ .type function .repeated ]
.field [
.name custom-field
.type word
.repeated
]
]
.record [
% import <module> as <name>
.name import
.field [
.name module
.type word
]
.field [
.type name
.optional
]
]
% representation of the built-in "piqi-any" type
.record [
.name any
.field [
% type could be optional or not fully resolved at all times
.name type
.type string
.optional
]
.field [
% arbitrary values corresponding to the type serialized in Protocol
% Buffers format; when one of "type" or "protobuf" field is present, the
% other must be present as well
.name protobuf
.type binary
.optional
]
.field [
% arbitrary JSON value serialized in as utf-8 string; when "type" field
% is present, the JSON value must correspond to this type
.name json
.type string
.optional
]
.field [
% arbitrary XML value serialized in as utf-8 string; when "type" field
% is present, the JSON value must correspond to this type
.name xml
.type string
.optional
]
.field [
% arbitrary Piq value serialized in as utf-8 string; when "type" field
% is present, the Piq value must correspond to this type
.name piq
.type string
.optional
]
]
.record [
.name function
.field [ .type name ]
.field [
.name input
.type type
.optional
]
.field [
.name output
.type type
.optional
]
.field [
.name error
.type type
.optional
]
]
.record [
% Standard portable representation of several piqi modules bundeled
% together. This data structure is used by "piqi compile", "piqi server" and
% other parts.
%
% The fact it is called piqi-list while being a record could be somewhat
% confusing. However, doing it this way allows to get nicer JSON and XML
% "visual" representation. It is still Protobuf-binary-compatible with
% .list [ .type piqi ] definition.
.name piqi-list
.field [
% imported modules come before the module they were imported from
.type piqi
.repeated
.code 1
]
]
%
% standard extensions natively supported by Piqi
%
.include [ .module piqi.piq ]
.include [ .module piqi.protobuf ]
.include [ .module piqi.json ]
.include [ .module piqi.getopt ]
.include [ .module piqi.piqic ]