forked from modelica/ModelicaSpecification
/
Modelica.g
496 lines (391 loc) · 9.06 KB
/
Modelica.g
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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
// Define a grammar called Hello
grammar Modelica;
options {
k=2;
}
// Whitespace and comments
BOM : '\u00EF' '\u00BB' '\u00BF' ;
WS : ( ' ' | '\t' | NL )+ { $channel=HIDDEN; }
;
LINE_COMMENT
: '//' ( ~('\r'|'\n')* ) (NL|EOF) { $channel=HIDDEN; }
;
ML_COMMENT
: '/*' (options {greedy=false;} : .)* '*/' { $channel=HIDDEN; }
;
fragment
NL: '\r\n' | '\n' | '\r';
// Lexical units except for keywords
IDENT : NONDIGIT ( DIGIT | NONDIGIT )* | Q_IDENT ;
fragment NONDIGIT : '_' | 'a' .. 'z' | 'A' .. 'Z' ;
STRING : '"' ( S_CHAR | S_ESCAPE )* '"' ;
fragment S_CHAR : NL | ~('\r' | '\n' | '\\' | '"'); // Unicode other than " and \
fragment DIGIT : '0' .. '9' ;
fragment Q_IDENT : '\'' ( Q_CHAR | S_ESCAPE ) ( Q_CHAR | S_ESCAPE | '"' )* '\'' ;
fragment Q_CHAR
: NONDIGIT | DIGIT | '!' | '#' | '$' | '%' | '&' | '(' | ')' | '*'
| '+' | ',' | '-' | '.' | '/' | ':' | ';' | '<' | '>' | '=' | '?'
| '@' | '[' | ']' | '^' | '{' | '}' | '|' | '~' | ' '
;
fragment S_ESCAPE : '\\'
('’' | '\'' | '"' | '?' | '\\' | 'a' | 'b' | 'f' | 'n' | 'r' | 't' | 'v')
;
fragment UNSIGNED_INTEGER : DIGIT+ ;
fragment EXPONENT : ( 'e' | 'E' ) ( '+' | '-' )? DIGIT+ ;
UNSIGNED_NUMBER : DIGIT+ ( '.' (DIGIT)* )? ( EXPONENT )? ;
// Stored Definition - Within
stored_definition :
'\uFEFF'? // BOM
( 'within' name? ';' )?
( 'final'? class_definition ';' )?
EOF
;
// Class Definition
class_definition :
'encapsulated'? class_prefixes
class_specifier
;
class_prefixes :
'partial'?
( 'class' | 'model' | 'operator'? 'record' | 'block' | 'expandable'? 'connector' |
'type' | 'package' | ( 'pure' | 'impure' )? 'operator'? 'function' | 'operator' )
;
class_specifier :
long_class_specifier | short_class_specifier // TODO: der_class_specifier merged to avoid k=3
;
long_class_specifier :
IDENT string_comment composition 'end' IDENT
| 'extends' IDENT class_modification? string_comment composition
'end' IDENT
;
short_class_specifier
: IDENT '='
( base_prefix type_specifier array_subscripts?
class_modification?
| 'enumeration' '(' ( enum_list? | ':' ) ')'
| 'der' '(' type_specifier ',' IDENT ( ',' IDENT )* ')')
comment
;
base_prefix
: ( 'input' | 'output' )?
;
enum_list :
enumeration_literal ( ',' enumeration_literal )*
;
enumeration_literal :
IDENT comment
;
composition :
element_list
( 'public' element_list |
'protected' element_list |
equation_section |
algorithm_section
)*
( 'external' language_specification
external_function_call? annotation_comment? ';' )?
( annotation_comment ';' )?
;
language_specification :
STRING
;
external_function_call :
( component_reference '=' )?
IDENT '(' expression_list? ')'
;
element_list :
( element ';' )*
;
element :
import_clause |
extends_clause |
'redeclare'?
'final'?
'inner'? 'outer'?
( ( class_definition | component_clause) |
'replaceable' ( class_definition | component_clause )
(constraining_clause comment)? )
;
import_clause :
'import' ( IDENT '=' name | name ('.' ( '*' | '{' import_list '}' ) | '.*')? ) comment
;
import_list :
IDENT ( ',' IDENT )*
;
// Extends
extends_clause :
'extends' type_specifier class_modification? annotation_comment? // TODO: No such rule annotation
;
constraining_clause :
'constrainedby' type_specifier class_modification?
;
// Component Clause
component_clause :
type_prefix type_specifier array_subscripts? component_list
;
type_prefix :
( 'flow' | 'stream' )?
( 'discrete' | 'parameter' | 'constant' )? ( 'input' | 'output' )?
;
component_list :
component_declaration ( ',' component_declaration )*
;
component_declaration :
declaration condition_attribute? comment
;
condition_attribute :
'if' expression
;
declaration :
IDENT array_subscripts? modification?
;
// Modification
modification :
class_modification ( '=' expression )?
| '=' expression
| ':=' expression
;
class_modification :
'(' argument_list? ')'
;
argument_list
: argument ( ',' argument )*
;
argument
: element_modification_or_replaceable
| element_redeclaration
;
element_modification_or_replaceable
: 'each'? 'final'? ( element_modification | element_replaceable )
;
element_modification
: name modification? string_comment
;
element_redeclaration :
'redeclare' 'each'? 'final'?
( ( short_class_definition | component_clause1 ) | element_replaceable )
;
element_replaceable :
'replaceable' ( short_class_definition | component_clause1 )
constraining_clause?
;
component_clause1 :
type_prefix type_specifier component_declaration1
;
component_declaration1
: declaration comment
;
short_class_definition
: class_prefixes short_class_specifier
;
// Equations
equation_section :
'initial'? 'equation' ( equation ';' )*
;
algorithm_section :
'initial'? 'algorithm' ( statement ';' )*
;
equation :
(
// TODO: Ambiguity
simple_expression ( '=' expression )?
| if_equation
| for_equation
| connect_clause
| when_equation
// TODO: Ambiguity
// | component_reference function_call_args
) comment
;
statement :
( component_reference ( ':=' expression | function_call_args )
| '(' output_expression_list ')' ':=' component_reference function_call_args
| 'break'
| 'return'
| if_statement
| for_statement
| while_statement
| when_statement )
comment
;
if_equation :
'if' expression 'then'
( equation ';' )*
( 'elseif' expression 'then'
( equation ';' )*
)*
( 'else'
( equation ';' )*
)?
'end' 'if'
;
if_statement :
'if' expression 'then'
( statement ';' )*
( 'elseif' expression 'then'
( statement ';' )*
)*
( 'else'
( statement ';' )*
)?
'end' 'if'
;
for_equation :
'for' for_indices 'loop'
( equation ';' )*
'end' 'for'
;
for_statement :
'for' for_indices 'loop'
( statement ';' )*
'end' 'for'
;
for_indices :
for_index ( ',' for_index )*
;
for_index :
IDENT ( 'in' expression )?
;
while_statement :
'while' expression 'loop'
( statement ';' )*
'end' 'while'
;
when_equation :
'when' expression 'then'
( equation ';' )*
( 'elsewhen' expression 'then'
( equation ';' )*
)*
'end' 'when'
;
when_statement :
'when' expression 'then'
( statement ';' )*
( 'elsewhen' expression 'then'
( statement ';' )*
)*
'end' 'when'
;
connect_clause :
'connect' '(' component_reference ',' component_reference ')'
;
// Expressions
expression :
simple_expression
| 'if' expression 'then' expression ( 'elseif' expression 'then' expression )*
'else' expression
;
simple_expression :
logical_expression ( ':' logical_expression ( ':' logical_expression )? )?
;
logical_expression :
logical_term ( 'or' logical_term )*
;
logical_term :
logical_factor ( 'and' logical_factor )*
;
logical_factor :
'not'? relation
;
relation :
arithmetic_expression ( relational_operator arithmetic_expression )?
;
relational_operator :
'<' | '<=' | '>' | '>=' | '==' | '<>'
;
arithmetic_expression :
add_operator? term ( add_operator term )*
;
add_operator :
'+' | '-' | '.+' | '.-'
;
term :
factor ( mul_operator factor )*
;
mul_operator :
'*' | '/' | '.*' | './'
;
factor :
primary ( ('^' | '.^') primary )?
;
primary :
UNSIGNED_NUMBER
| STRING
| 'false'
| 'true'
| ('der' | 'initial' | 'pure' ) function_call_args
| component_reference function_call_args?
| '(' output_expression_list ')'
| '[' expression_list ( ';' expression_list )* ']'
| '{' array_arguments '}'
| 'end'
;
type_specifier :
'.'? name
;
name :
IDENT ( '.' IDENT )*
;
component_reference :
'.'? IDENT array_subscripts? ( '.' IDENT array_subscripts? )*
;
// function_call_args have been rewritten due to #2250 and also resolves
// ambiguity with named arg or expression
// f(a, b=3) ANTLR4 said "f(a, b" parsed, expecting ")"
function_call_args :
'(' function_arguments? ')'
;
function_arguments
: expression ( function_arguments_non_first | 'for' for_indices )
| function_partial_application function_arguments_non_first
| named_arguments
;
function_arguments_non_first
: ( ','
( IDENT '=' function_argument named_arguments_non_first
| expression function_arguments_non_first
| function_partial_application function_arguments_non_first
)
)?
;
array_arguments :
expression ( ( ',' expression /* TODO: This changed the grammar */ )* | 'for' for_indices )
;
named_arguments :
named_argument named_arguments_non_first
;
named_arguments_non_first :
( ',' named_argument )*
;
named_argument :
IDENT '=' function_argument
;
function_argument
: function_partial_application
| expression
;
function_partial_application
: 'function' name '(' named_arguments? ')'
;
output_expression_list :
expression? ( ',' expression? )*
;
expression_list :
expression ( ',' expression? )*
;
array_subscripts :
'[' subscript ( ',' subscript )* ']'
;
subscript :
':' | expression
;
comment :
string_comment annotation_comment?
;
string_comment :
( STRING ( '+' STRING )* )?
;
annotation_comment :
'annotation' class_modification
;