sdl92.g 33.7 KB
Newer Older
dbarbera's avatar
dbarbera committed
1
/*
Maxime Perrotin's avatar
Maxime Perrotin committed
2
3
    OpenGEODE
    ANTLR 3.1.3 grammar for the SDL92 langage
4
5
6
    Includes the following features from SDL2000+:
    - FOR loops in TASKs
    - Composite states
Maxime Perrotin's avatar
Maxime Perrotin committed
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

    author: Maxime Perrotin
*/

grammar sdl92;

options {
    language=Python;
    output=AST;
    ASTLabelType=CommonTree;
    backtrack=true;
}

tokens {
        ACTION;
dbarbera's avatar
dbarbera committed
22
        ALL;
Maxime Perrotin's avatar
Maxime Perrotin committed
23
24
        ALTERNATIVE;
        ANSWER;
dbarbera's avatar
dbarbera committed
25
26
27
28
29
30
31
32
        ARRAY;
        ASN1;
        ASSIGN;
        BITSTR;
        BLOCK;
        CHANNEL;
        CHOICE;
        CIF;
Maxime Perrotin's avatar
Maxime Perrotin committed
33
        CLOSED_RANGE;
dbarbera's avatar
dbarbera committed
34
35
36
37
        COMMENT;
        COMPOSITE_STATE;
        CONNECT;
        CONNECTION;
Maxime Perrotin's avatar
Maxime Perrotin committed
38
        CONSTANT;
dbarbera's avatar
dbarbera committed
39
40
41
42
        CONSTANTS;
        DCL;
        DECISION;
        DIGITS;
Maxime Perrotin's avatar
Maxime Perrotin committed
43
        ELSE;
dbarbera's avatar
dbarbera committed
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
        EMPTYSTR;
        ENDNEWTYPE;
        ENDSYNTYPE;
        ENDTEXT;
        EXPORT;
        EXPRESSION;
        EXTERNAL;
        FI;
        FIELD;
        FIELD_NAME;
        FIELDS;
        FLOAT2;
        FLOAT;
        FLOATING_LABEL;
        FOR;
        FPAR;
        GROUND;
        HYPERLINK;
        IF;
        IFTHENELSE;
        IN;
        INFORMAL_TEXT;
        INOUT;
        INPUT;
        INPUT_NONE;
        INPUTLIST;
        JOIN;
        LABEL;
        NEG;
        NEWTYPE;
        NEXTSTATE;
        NUMBER_OF_INSTANCES;
        OCTSTR;
        OPEN_RANGE;
Maxime Perrotin's avatar
Maxime Perrotin committed
78
79
        OUTPUT;
        OUTPUT_BODY;
dbarbera's avatar
dbarbera committed
80
81
        PARAM;
        PARAMNAMES;
Maxime Perrotin's avatar
Maxime Perrotin committed
82
        PARAMS;
83
        PAREN;
Maxime Perrotin's avatar
Maxime Perrotin committed
84
85
        PRIMARY;
        PRIMARY_ID;
dbarbera's avatar
dbarbera committed
86
87
88
89
90
        PROCEDURE;
        PROCEDURE_CALL;
        PROCEDURE_NAME;
        PROCESS;
        PROVIDED;
Maxime Perrotin's avatar
Maxime Perrotin committed
91
        QUESTION;
dbarbera's avatar
dbarbera committed
92
93
94
        RANGE;
        RESET;
        RETURN;
Maxime Perrotin's avatar
Maxime Perrotin committed
95
        ROUTE;
dbarbera's avatar
dbarbera committed
96
97
98
99
100
101
102
103
104
105
106
107
        SAVE;
        SEQOF;
        SEQUENCE;
        SET;
        SIGNAL;
        SIGNAL_LIST;
        SORT;
        STATE;
        STATELIST;
        STIMULUS;
        STOP;
        STRING;
108
        STRUCT;
109
110
        SYNONYM;
        SYNONYM_LIST;
dbarbera's avatar
dbarbera committed
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
        SYNTYPE;
        SYSTEM;
        TASK;
        TASK_BODY;
        TERMINATOR;
        TEXT;
        TEXTAREA;
        TEXTAREA_CONTENT;
        THEN;
        TIMER;
        TO;
        TRANSITION;
        USE;
        VALUE;
        VARIABLE;
        VARIABLES;
        VIA;
        VIAPATH;
Maxime Perrotin's avatar
Maxime Perrotin committed
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
}


/*
    Top level: any .pr file
*/

pr_file
        :       (use_clause
                | system_definition
                | process_definition)+;


system_definition
        :       SYSTEM system_name end
                entity_in_system*
                ENDSYSTEM system_name? end
        ->      ^(SYSTEM system_name entity_in_system*);


use_clause
        :       use_asn1?
                USE package_name end
        ->      ^(USE use_asn1? package_name);


/* Entity in system:
   Declare signals, external procedures, connections and blocks
*/
entity_in_system
        :       signal_declaration
                | procedure
                | channel
                | block_definition;

/* signal_declaration:
   e.g. SIGNAL open_door(typeA, typeB);
*/
signal_declaration
        :       paramnames?
                SIGNAL signal_id input_params? end
        ->      ^(SIGNAL paramnames? signal_id input_params?);


channel
        :       CHANNEL channel_id
                route+
                ENDCHANNEL end
        ->      ^(CHANNEL channel_id route+);


route
        :       FROM source_id TO dest_id WITH signal_id (',' signal_id)* end
        ->      ^(ROUTE source_id dest_id signal_id+);


block_definition
        :       BLOCK block_id end
dbarbera's avatar
dbarbera committed
187
                entity_in_block*
Maxime Perrotin's avatar
Maxime Perrotin committed
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
                ENDBLOCK end
        ->      ^(BLOCK block_id entity_in_block*);


/* Inside a SDL block:
   there can be nested blocks, processes, signalroutes and connections
   to above channels
*/
entity_in_block
        :       signal_declaration
                | signalroute
                | connection
                | block_definition
                | process_definition;


signalroute
        :       SIGNALROUTE route_id
                route+
        ->      ^(SIGNALROUTE route_id route+);


connection
        :       CONNECT channel_id AND route_id end
        ->      ^(CONNECTION channel_id route_id);


process_definition
        :       PROCESS process_id number_of_instances? REFERENCED end
        ->      ^(PROCESS process_id number_of_instances? REFERENCED)
218
                | cif? PROCESS process_id number_of_instances? end
219
                (text_area | procedure | composite_state)*
Maxime Perrotin's avatar
Maxime Perrotin committed
220
221
                processBody? ENDPROCESS process_id?
                end
222
        ->      ^(PROCESS cif? process_id number_of_instances?
223
                text_area* procedure* composite_state* processBody?);
Maxime Perrotin's avatar
Maxime Perrotin committed
224
225


226
227
// procedure: missing the RETURNS statement
// (TODO - but check new SDL2000 syntax that has no RETURNS token)
Maxime Perrotin's avatar
Maxime Perrotin committed
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
procedure
        :       cif?
                PROCEDURE procedure_id end
                fpar?
                (text_area | procedure)*
                ((processBody? ENDPROCEDURE procedure_id?) | EXTERNAL)
                end
        ->      ^(PROCEDURE cif? procedure_id end? fpar?
                text_area* procedure* processBody? EXTERNAL?);


// Procedure formal parameters
fpar
        :       FPAR formal_variable_param
                (',' formal_variable_param)*
                end
        ->      ^(FPAR formal_variable_param+);


formal_variable_param
        :       (INOUT | IN)?
                variable_id (',' variable_id)* sort
        ->      ^(PARAM INOUT? IN? variable_id+ sort);


// text_area: TODO add operator description in content
text_area
        :       cif
                content?
                cif_end_text
        ->      ^(TEXTAREA cif content? cif_end_text);


// Text areas can contain textual procedures, FPAR declarations,
// and variable or timer declarations
content
        :        (procedure
                 | fpar
                 | timer_declaration
267
268
                 | syntype_definition
                 | newtype_definition
269
270
                 | variable_definition
                 | synonym_definition)*
Maxime Perrotin's avatar
Maxime Perrotin committed
271
272
273
        ->       ^(TEXTAREA_CONTENT fpar* procedure* variable_definition*
                   syntype_definition* newtype_definition* timer_declaration*
                   synonym_definition*);
Maxime Perrotin's avatar
Maxime Perrotin committed
274
275
276
277
278
279
280
281


timer_declaration
        :       TIMER timer_id
                (',' timer_id)*
                end
        ->      ^(TIMER timer_id+);

282
syntype_definition
Maxime Perrotin's avatar
Maxime Perrotin committed
283
284
285
286
287
288
289
        :       SYNTYPE syntype_name '=' parent_sort
                (CONSTANTS (range_condition (',' range_condition)* ))?
                ENDSYNTYPE syntype_name? end
        ->      ^(SYNTYPE syntype_name parent_sort range_condition*);

syntype_name
        :       sort;
290
291

parent_sort
Maxime Perrotin's avatar
Maxime Perrotin committed
292
        :       sort;
293
294

newtype_definition
Maxime Perrotin's avatar
Maxime Perrotin committed
295
296
297
        :       NEWTYPE type_name (array_definition|structure_definition)?
                ENDNEWTYPE type_name? end
        ->      ^(NEWTYPE type_name array_definition* structure_definition*);
298
299
300


type_name
Maxime Perrotin's avatar
Maxime Perrotin committed
301
302
        :       sort;

303
array_definition
Maxime Perrotin's avatar
Maxime Perrotin committed
304
305
        :       ARRAY '(' sort ',' sort ')'
        ->      ^(ARRAY sort sort);
306
307

structure_definition
Maxime Perrotin's avatar
Maxime Perrotin committed
308
309
        :       STRUCT field_list end
        ->      ^(STRUCT field_list);
310
311

field_list
Maxime Perrotin's avatar
Maxime Perrotin committed
312
313
        :       field_definition (end field_definition)*
        ->      ^(FIELDS field_definition+);
314
315

field_definition
Maxime Perrotin's avatar
Maxime Perrotin committed
316
317
        :       field_name (',' field_name)* sort
        ->      ^(FIELD field_name+ sort);
318

Maxime Perrotin's avatar
Maxime Perrotin committed
319
320
321
322
323
324
variable_definition
        :       DCL variables_of_sort
                (',' variables_of_sort)*
                end
        ->      ^(DCL variables_of_sort+);

Maxime Perrotin's avatar
Maxime Perrotin committed
325
326
327
synonym_definition
        :       internal_synonym_definition;

328
internal_synonym_definition
Maxime Perrotin's avatar
Maxime Perrotin committed
329
330
331
332
        :       SYNONYM synonym_definition_item (',' synonym_definition_item)*
                end
        ->      ^(SYNONYM_LIST synonym_definition_item+);

333
synonym_definition_item
Maxime Perrotin's avatar
Maxime Perrotin committed
334
335
        :       sort sort '=' ground_expression
        ->      ^(SYNONYM sort sort ground_expression);
Maxime Perrotin's avatar
Maxime Perrotin committed
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358

variables_of_sort
        :       variable_id (',' variable_id)* sort (':=' ground_expression)?
        ->      ^(VARIABLES variable_id+ sort ground_expression?);


ground_expression
        :       expression
        ->      ^(GROUND expression);


number_of_instances
        :       '(' initial_number=INT ',' maximum_number=INT ')'
        ->      ^(NUMBER_OF_INSTANCES $initial_number $maximum_number);


processBody
        :       start? (state | floating_label)*;


start
        :       cif?
                hyperlink?
359
                START name=state_entry_point_name? end
Maxime Perrotin's avatar
Maxime Perrotin committed
360
                transition?
361
        ->      ^(START cif? hyperlink? $name? end? transition?);
Maxime Perrotin's avatar
Maxime Perrotin committed
362
363
364
365
366
367
368
369
370
371
372
373
374


floating_label
        :       cif?
                hyperlink?
                CONNECTION connector_name ':'
                transition?
                cif_end_label?
                ENDCONNECTION SEMI
        ->      ^(FLOATING_LABEL cif? hyperlink? connector_name transition?);


state
375
        :       cif?
Maxime Perrotin's avatar
Maxime Perrotin committed
376
377
378
379
380
381
382
383
384
                hyperlink?
                STATE statelist e=end
                (state_part)*
                ENDSTATE statename? f=end
        ->      ^(STATE cif? hyperlink? $e? statelist state_part*);


statelist
        :       ((statename)(',' statename)*)
385
        ->      ^(STATELIST statename+)
Maxime Perrotin's avatar
Maxime Perrotin committed
386
387
388
389
390
                | ASTERISK exception_state?
        ->      ^(ASTERISK exception_state?);


exception_state
391
        :       '(' statename (',' statename)* ')'
Maxime Perrotin's avatar
Maxime Perrotin committed
392
393
394
        ->      statename+;


395
396
397
composite_state
        :       STATE statename e=end
                SUBSTRUCTURE
398
                connection_points*
399
400
                body=composite_state_body
                ENDSUBSTRUCTURE statename? f=end
401
        ->      ^(COMPOSITE_STATE statename connection_points* $body $e?);
402
403
404


connection_points
405
406
407
408
        :       IN state_entry_exit_points end
        ->      ^(IN state_entry_exit_points end?)
                | OUT state_entry_exit_points end
        ->      ^(OUT state_entry_exit_points end?);
409
410
411
412
413
414
415
416
417


state_entry_exit_points
        :       '(' statename (',' statename)* ')'
        ->      statename+;


composite_state_body
        :       (text_area | procedure | composite_state)*
Maxime Perrotin's avatar
Maxime Perrotin committed
418
                start* (state | floating_label)*;
419
420


Maxime Perrotin's avatar
Maxime Perrotin committed
421
422
423
424
425
state_part
        :       input_part
                //| priority_input        // Not supported
                | save_part               // Not supported in openGEODE
                | spontaneous_transition
426
427
428
429
430
431
                | continuous_signal       // Not supoorted in openGEODE
                | connect_part;


// connect part is used to connect nested state exit points to a transition
connect_part
Maxime Perrotin's avatar
Maxime Perrotin committed
432
433
434
435
436
        :       cif?
                hyperlink?
                CONNECT connect_list? end
                transition?
        ->      ^(CONNECT cif? hyperlink? connect_list? end? transition?);
437
438
439
440
441
442


connect_list
        :       state_exit_point_name (',' state_exit_point_name)*
                -> state_exit_point_name+
                | ASTERISK;
Maxime Perrotin's avatar
Maxime Perrotin committed
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459


spontaneous_transition
        :       cif?
                hyperlink?
                INPUT NONE end
                enabling_condition?
                transition
        ->      ^(INPUT_NONE cif? hyperlink? transition);


enabling_condition
        :       PROVIDED expression end
        ->      ^(PROVIDED expression);


continuous_signal
dbarbera's avatar
dbarbera committed
460
        :       PROVIDED expression end
461
                (PRIORITY integer_literal_name=INT end)?
Maxime Perrotin's avatar
Maxime Perrotin committed
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
                transition
        ->      ^(PROVIDED expression $integer_literal_name? transition);


save_part
        :       SAVE save_list
                end
        ->      ^(SAVE save_list);


save_list
        :       signal_list
                | asterisk_save_list;


asterisk_save_list
        :       ASTERISK;


signal_list
        :       signal_item (',' signal_item)*
        ->      ^(SIGNAL_LIST signal_item+);



// Signal_item alternatives are all of the same ID type.
// Should be resolved at semantic analysis.
signal_item
        :       signal_id; /* |
                priority_signal_id |
                signal_list_id |
                timer_id;*/

dbarbera's avatar
dbarbera committed
495
/*   Not considered for the moment
Maxime Perrotin's avatar
Maxime Perrotin committed
496
497
     (irrelevant in the scope of the generation of code for a single process)
priority_input
dbarbera's avatar
dbarbera committed
498
        :       PRIORITY INPUT priority_input_list end transition;
Maxime Perrotin's avatar
Maxime Perrotin committed
499
500
501
502
503
504
505
506
507
508
509
510
511
512


priority_input_list
        :       priority_stimulus (',' priority_stimulus)*;

priority_stimulus
        :       priority_signal_id ( '(' variable_id (',' variable_id)* ')');
*/


// this is only the "basic input part" from SDL92
input_part
        :       cif?
                hyperlink?
Maxime Perrotin's avatar
Maxime Perrotin committed
513
514
                INPUT inputlist end
                enabling_condition?
Maxime Perrotin's avatar
Maxime Perrotin committed
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
                transition?
        ->      ^(INPUT cif? hyperlink? end?
                inputlist enabling_condition? transition?);


// asterisk means: all signals not excplicitely specified
// (semantic is different from asterisk state)
inputlist
        :       ASTERISK
                | (stimulus (',' stimulus)*)
        ->      ^(INPUTLIST stimulus+);


stimulus
        :       stimulus_id input_params?;


input_params
        :       L_PAREN variable_id (',' variable_id)* R_PAREN
        ->      ^(PARAMS variable_id+);


transition
        :       action+ label? terminator_statement?
        ->      ^(TRANSITION action+ label? terminator_statement?)
                | terminator_statement
        ->      ^(TRANSITION terminator_statement);


action
        :       label?
                (task
                | task_body
                | output
                | create_request
                | decision
                | transition_option
                | set_timer
                | reset_timer
                | export     // Not supported in OpenGEODE
                | procedure_call);

export
        :       EXPORT
                L_PAREN variable_id (COMMA variable_id)* R_PAREN
                end
        ->      ^(EXPORT variable_id+);

/*
remote_procedure_call
dbarbera's avatar
dbarbera committed
565
        :       CALL remote_procedure_call_body;
Maxime Perrotin's avatar
Maxime Perrotin committed
566
567

remote_procedure_call_body
dbarbera's avatar
dbarbera committed
568
        :       remote_procedure_id actual_parameters? (TO destination)?;
Maxime Perrotin's avatar
Maxime Perrotin committed
569
570
571
572
573
574
575
576
577
578
579
*/


procedure_call
        :       cif?
                hyperlink?
                CALL procedure_call_body end
        ->      ^(PROCEDURE_CALL cif? hyperlink? end? procedure_call_body);


procedure_call_body
dbarbera's avatar
dbarbera committed
580
        :       procedure_id actual_parameters?
Maxime Perrotin's avatar
Maxime Perrotin committed
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
        ->      ^(OUTPUT_BODY procedure_id actual_parameters?);


set_timer
        :       SET set_statement (COMMA set_statement)*
                end
        ->      set_statement+;


set_statement
        :       L_PAREN (expression COMMA)? timer_id R_PAREN
        ->      ^(SET expression? timer_id);
        // ('('expression_list')')? ')'; (removed because of non-LL(*) problem)


reset_timer
        :       RESET reset_statement (',' reset_statement)*
                end
        ->      reset_statement+;


reset_statement
        :       timer_id ('(' expression_list ')')?
        ->      ^(RESET timer_id expression_list?);


transition_option
        :       ALTERNATIVE alternative_question e=end
                answer_part
                alternative_part
                ENDALTERNATIVE f=end
        ->      ^(ALTERNATIVE answer_part alternative_part);


alternative_part
        :       (answer_part+ else_part?)
        ->      answer_part+ else_part?
                | else_part
        ->      else_part;


alternative_question
        :       expression
                | informal_text;


decision
        :       cif?
                hyperlink?
                DECISION question e=end
                answer_part?
                alternative_part?
                ENDDECISION f=end
        ->      ^(DECISION cif? hyperlink? $e? question
                answer_part? alternative_part?);


answer_part
        :       cif?
                hyperlink?
                L_PAREN answer R_PAREN ':' transition?
        ->      ^(ANSWER cif? hyperlink? answer transition?);


answer
        :       range_condition
                | informal_text;


else_part
        :       cif?
                hyperlink?
                ELSE ':' transition?
        ->      ^(ELSE cif? hyperlink? transition?);


question
        :       expression
        ->      ^(QUESTION expression)
                | informal_text
        ->      informal_text
                | ANY
        ->      ^(ANY);


range_condition
        :       (closed_range | open_range);
                //(',' (closed_range|open_range))*;


closed_range
        :       a=INT ':' b=INT
        ->      ^(CLOSED_RANGE $a $b);


open_range
        :       constant
        ->      constant
                | ( (EQ|NEQ|GT|LT|LE|GE) constant)
        ->      ^(OPEN_RANGE EQ? NEQ? GT? LT? LE? GE? constant);


constant
        :       expression
        ->      ^(CONSTANT expression);


create_request
dbarbera's avatar
dbarbera committed
689
        :       CREATE
Maxime Perrotin's avatar
Maxime Perrotin committed
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
                createbody
                actual_parameters?
                end
        ->      ^(CREATE createbody actual_parameters?);


createbody
        :       process_id
                | THIS;


output
        :       cif?
                hyperlink?
                OUTPUT outputbody end
        ->      ^(OUTPUT cif? hyperlink? end? outputbody);


outputbody
709
710
711
712
        :       outputstmt (',' outputstmt)* to_part?
        ->      ^(OUTPUT_BODY outputstmt+ to_part?);
 //               via_part?
 //     -> (signal_id actual_parameters?)+ to_part? via_part?;
Maxime Perrotin's avatar
Maxime Perrotin committed
713
714
715


outputstmt
dbarbera's avatar
dbarbera committed
716
        :       signal_id
Maxime Perrotin's avatar
Maxime Perrotin committed
717
718
                actual_parameters?;

719
to_part
Maxime Perrotin's avatar
Maxime Perrotin committed
720
721
        :       (TO destination)
        ->      ^(TO destination);
Maxime Perrotin's avatar
Maxime Perrotin committed
722

723
via_part
dbarbera's avatar
dbarbera committed
724
725
        :       VIA viabody
        ->      ^(VIA viabody);
Maxime Perrotin's avatar
Maxime Perrotin committed
726
727
728
729


// ambiguous in SDL92, added OR between ALL and via_path
viabody
dbarbera's avatar
dbarbera committed
730
        :       ALL
Maxime Perrotin's avatar
Maxime Perrotin committed
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
        ->      ^(ALL)
                | via_path
        ->      ^(VIAPATH via_path);


destination
        :       pid_expression
                | process_id
                | THIS;


via_path
        :       via_path_element (',' via_path_element)*
        ->      via_path_element+;


via_path_element
        :       ID; // signal_route_id | channel_id | gate_id;


actual_parameters
        :      '(' expression (',' expression)* ')'
        ->     ^(PARAMS expression+);


task
        :       cif?
                hyperlink?
759
760
                TASK task_body? end
        ->      ^(TASK cif? hyperlink? end? task_body?);
Maxime Perrotin's avatar
Maxime Perrotin committed
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798


task_body
        :       (assignement_statement (',' assignement_statement)*)
        ->      ^(TASK_BODY assignement_statement+)
                | (informal_text (',' informal_text)*)
        ->      ^(TASK_BODY informal_text+)
                | (forloop (',' forloop)*)
        ->      ^(TASK_BODY forloop+)
        ;

// SDL extension - FOR loop in TASKs
forloop
        :       FOR variable_id IN (variable | range) ':'
                transition?
                ENDFOR
        ->      ^(FOR variable_id variable? range? transition?);

range
        :       RANGE
                L_PAREN a=ground_expression
                (COMMA b=ground_expression)? (COMMA step=INT)?
                R_PAREN
        ->      ^(RANGE $a $b? $step?);

assignement_statement
        :       variable ':=' expression
        ->      ^(ASSIGN variable expression);


// Variable: covers eg. toto(5)(4)!titi(3)!tutu!yoyo
variable
        :       variable_id primary_params*
        ->      ^(VARIABLE variable_id primary_params*);

field_selection
        :       (('!'|'.') field_name);

dbarbera's avatar
dbarbera committed
799
800
801
802
803
804
805
806
807
808
809
expression
        :       operand0 ( IMPLIES^ operand0)* ;

operand0
        :       operand1 (( (OR^ ELSE?) | XOR^ ) operand1)*;

operand1
        :       operand2 ( AND^ THEN? operand2)*;

operand2
        :       operand3 (( EQ^ | NEQ^ | GT^ | GE^ | LT^ | LE^ | IN^ ) operand3)*;
Maxime Perrotin's avatar
Maxime Perrotin committed
810

dbarbera's avatar
dbarbera committed
811
812
operand3
        :       operand4 (( PLUS^ | DASH^ | APPEND^ ) operand4)*;
Maxime Perrotin's avatar
Maxime Perrotin committed
813

dbarbera's avatar
dbarbera committed
814
815
816
817
operand4
        :       operand5 (( ASTERISK^ | DIV^ | MOD^ | REM^ ) operand5)*;

operand5
818
        :       primary
dbarbera's avatar
dbarbera committed
819
820
821
        |       NOT^ operand5
        |       DASH operand5 -> ^(NEG operand5);

Maxime Perrotin's avatar
Maxime Perrotin committed
822
primary
823
824
825
826
        :       asn1Value primary_params*   -> ^(PRIMARY_ID asn1Value primary_params*)
        |       L_PAREN expression R_PAREN  -> ^(PAREN expression)
        |       conditional_ground_expression
        ;
Maxime Perrotin's avatar
Maxime Perrotin committed
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844

// ASN.1 Value Notation used for assignations and comparisons
asn1Value
        :       BitStringLiteral            -> ^(BITSTR BitStringLiteral)
        |       OctetStringLiteral          -> ^(OCTSTR OctetStringLiteral)
        |       TRUE^
        |       FALSE^
        |       StringLiteral               -> ^(STRING StringLiteral)
        |       NULL^
        |       PLUS_INFINITY^
        |       MINUS_INFINITY^
        |       ID
        |       INT
        |       FloatingPointLiteral        -> ^(FLOAT FloatingPointLiteral)
        |       L_BRACKET R_BRACKET         -> ^(EMPTYSTR)
        |       L_BRACKET
                MANTISSA mant=INT COMMA
                BASE bas=INT COMMA
dbarbera's avatar
dbarbera committed
845
                EXPONENT exp=INT
Maxime Perrotin's avatar
Maxime Perrotin committed
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
                R_BRACKET                   -> ^(FLOAT2 $mant $bas $exp)
        |       choiceValue
        |       L_BRACKET
                namedValue (COMMA namedValue)*
                R_BRACKET                   -> ^(SEQUENCE namedValue+)
        |       L_BRACKET
                asn1Value (COMMA asn1Value)*
                R_BRACKET                   -> ^(SEQOF asn1Value+)
        ;

BitStringLiteral
        :       '"' ('0'|'1'|' ' | '\t' | '\r' | '\n')* '"B';


OctetStringLiteral
        :       '"' ('0'..'9'|'a'..'f'|'A'..'F'|' ' | '\t' | '\r' | '\n')*
                '"H';


informal_text
        :        StringLiteral
        ->       ^(INFORMAL_TEXT StringLiteral);


// hello:5  (CHOICE field value)
dbarbera's avatar
dbarbera committed
871
choiceValue
Maxime Perrotin's avatar
Maxime Perrotin committed
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
        :        choice=ID ':' expression
        ->       ^(CHOICE $choice expression);


// { a 5 } (SEQUENCE field value)
namedValue
        :       ID expression;


primary_params
        :      '(' expression_list ')'
        ->     ^(PARAMS expression_list)
               | '!' literal_id
        ->     ^(FIELD_NAME literal_id);


dbarbera's avatar
dbarbera committed
888
/* All cases are covered by the ground primary
Maxime Perrotin's avatar
Maxime Perrotin committed
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
   above (Except structure primary, but we favour ASN.1 notation)
extended_primary
        :       synonym         |
                indexed_primary |
                field_primary   |
                structure_primary;
*/


indexed_primary
        :       primary '(' expression_list ')';


field_primary
        :       primary field_selection;


structure_primary
        :       '(.' expression_list '.)';
// Removed "qualifier" from the standard
// (to be put later, but never used in practice)


active_expression
        :       active_primary;


active_primary
        :       variable_access
                | operator_application
                | conditional_expression
                | imperative_operator
                | '(' active_expression ')'
                | 'ERROR';
   // active_extended_primary removed because not defined in the standard


imperative_operator
        :       now_expression
                | import_expression
                | pid_expression
                | view_expression
                | timer_active_expression
                | anyvalue_expression;


timer_active_expression
dbarbera's avatar
dbarbera committed
936
        :       ACTIVE '(' timer_id ('(' expression_list ')')? ')';
Maxime Perrotin's avatar
Maxime Perrotin committed
937
938
939


anyvalue_expression
dbarbera's avatar
dbarbera committed
940
        :       ANY '(' sort ')';
Maxime Perrotin's avatar
Maxime Perrotin committed
941
942
943
944
945
946
947
948
949
950


sort    :       sort_id
        ->      ^(SORT sort_id);


syntype :       syntype_id;


import_expression
dbarbera's avatar
dbarbera committed
951
        :       IMPORT '(' remote_variable_id (',' destination)? ')';
Maxime Perrotin's avatar
Maxime Perrotin committed
952
953
954


view_expression
dbarbera's avatar
dbarbera committed
955
        :       VIEW '(' view_id (',' pid_expression)? ')';
Maxime Perrotin's avatar
Maxime Perrotin committed
956
957
958
959
960
961
962
963
964
965


variable_access
        :       variable_id;


operator_application
        :       operator_id '('active_expression_list ')';


dbarbera's avatar
dbarbera committed
966
active_expression_list
Maxime Perrotin's avatar
Maxime Perrotin committed
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
        :       active_expression (',' expression_list)?;/* |
                ground_expression ',' active_expression_list;*/   // Will not work (recursion)
/*
conditional_expression
        :       IF boolean_active_expression THEN consequence_expression ELSE alternative_expression FI |
                IF boolean_expression THEN active_consequence_expression ELSE alternative_expression FI |
                IF boolean_expression THEN consequence_expression ELSE active_alternative_expression FI;
*/


// Simpler version, the rest will is checked by semantic analysis
conditional_expression
        :       IF expression THEN expression ELSE expression FI;


982
//synonym :       ID; // synonym_id | external_synonym;
Maxime Perrotin's avatar
Maxime Perrotin committed
983
984
985
986
987
988
989
990
991
992
993
994
995


external_synonym
        :       external_synonym_id;


conditional_ground_expression
        :       IF ifexpr=expression
                THEN thenexpr=expression
                ELSE elseexpr=expression FI
        ->      ^(IFTHENELSE $ifexpr $thenexpr $elseexpr);


dbarbera's avatar
dbarbera committed
996
expression_list
Maxime Perrotin's avatar
Maxime Perrotin committed
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
        :       expression (',' expression)*
        ->      expression+;


terminator_statement
        :       label?
                cif?
                hyperlink?
                terminator
                end
        ->      ^(TERMINATOR label? cif? hyperlink? end? terminator);

label
        :       cif? connector_name ':'
        ->      ^(LABEL cif? connector_name);


terminator
1015
        :       nextstate | join | stop | return_stmt;
Maxime Perrotin's avatar
Maxime Perrotin committed
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036


join
        :        JOIN connector_name
        ->       ^(JOIN connector_name);


stop    :       STOP;


return_stmt
        :       RETURN expression?
        ->      ^(RETURN expression?);


nextstate
        :       NEXTSTATE nextstatebody
        ->      ^(NEXTSTATE nextstatebody);


nextstatebody
1037
        :       statename via?
Maxime Perrotin's avatar
Maxime Perrotin committed
1038
1039
1040
                | dash_nextstate;


1041
1042
1043
1044
via     :       VIA state_entry_point_name
        ->      ^(VIA state_entry_point_name);


Maxime Perrotin's avatar
Maxime Perrotin committed
1045
1046
1047
1048
1049
1050
1051
1052
1053
end
        :   (cif? hyperlink? COMMENT StringLiteral)? SEMI
        -> ^(COMMENT cif? hyperlink? StringLiteral)?;


cif
        :       cif_decl symbolname
                L_PAREN x=INT COMMA y=INT R_PAREN
                COMMA
dbarbera's avatar
dbarbera committed
1054
                L_PAREN width=INT COMMA height=INT R_PAREN
Maxime Perrotin's avatar
Maxime Perrotin committed
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
                cif_end
        ->      ^(CIF $x $y $width $height);


hyperlink
        :       cif_decl KEEP SPECIFIC GEODE HYPERLINK StringLiteral
                cif_end
        ->      ^(HYPERLINK StringLiteral);

/* OpenGEODE specific: SDL does not allow specifying the name
   of signal parameters, but it is needed to generate function signatures
dbarbera's avatar
dbarbera committed
1066
   when generating code (in particular in Ada, where the name in the
Maxime Perrotin's avatar
Maxime Perrotin committed
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
   body must comply with the one of the source
   Extension is using CIF comment so it is invisible to other SDL parsers
   (This is valid SDL code - see ITU-T Z106)
*/
paramnames
        :       cif_decl KEEP SPECIFIC GEODE PARAMNAMES field_name+ cif_end
        ->      ^(PARAMNAMES field_name+);


/* OpenGEODE specific: Allow specifying the name of an ASN.1 file
   as a CIF extension linked to a USE clause.
   CIF Extensions are valid SDL constructs (ITU-T Z106)
*/
use_asn1
        :       cif_decl KEEP SPECIFIC GEODE ASNFILENAME StringLiteral cif_end
        ->      ^(ASN1 StringLiteral);


symbolname
        :       START
                | INPUT
                | OUTPUT
                | STATE
                | PROCEDURE
1091
                | PROCESS
Maxime Perrotin's avatar
Maxime Perrotin committed
1092
1093
                | PROCEDURE_CALL
                | STOP
1094
                | RETURN
Maxime Perrotin's avatar
Maxime Perrotin committed
1095
1096
1097
1098
1099
1100
1101
1102
                | DECISION
                | TEXT
                | TASK
                | NEXTSTATE
                | ANSWER
                | PROVIDED
                | COMMENT
                | LABEL
Maxime Perrotin's avatar
Maxime Perrotin committed
1103
1104
                | JOIN
                | CONNECT;
Maxime Perrotin's avatar
Maxime Perrotin committed
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126


cif_decl
        :       '/* CIF';


cif_end
        :       '*/';


cif_end_text
        :       cif_decl ENDTEXT cif_end
        ->      ^(ENDTEXT);

cif_end_label
        :       cif_decl END LABEL cif_end;


dash_nextstate  :       DASH;
connector_name  :       ID;
signal_id       :       ID;
statename       :       ID;
1127
1128
state_exit_point_name
                :       ID;
1129
1130
state_entry_point_name
                :       ID;
Maxime Perrotin's avatar
Maxime Perrotin committed
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
variable_id     :       ID;
literal_id      :       ID | INT;
process_id      :       ID;
system_name     :       ID;
package_name    :       ID;
priority_signal_id
                :       ID;
signal_list_id  :       ID;
timer_id        :       ID;
field_name      :       ID;
signal_route_id :       ID;
channel_id      :       ID;
route_id        :       ID;
block_id        :       ID;
source_id       :       ID;
dest_id         :       ID;
gate_id         :       ID;
procedure_id    :       ID;
remote_procedure_id
                :       ID;
operator_id     :       ID;
synonym_id      :       ID;
external_synonym_id
                :       ID;
remote_variable_id
                :       ID;
view_id         :       ID;
sort_id         :       ID;
syntype_id      :       ID;
stimulus_id     :       ID;
1161
ASSIG_OP        :       ':=';
Maxime Perrotin's avatar
Maxime Perrotin committed
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
L_BRACKET       :       '{';
R_BRACKET       :       '}';
L_PAREN         :       '(';
R_PAREN         :       ')';
COMMA           :       ',';
SEMI            :       ';';
DASH            :       '-';
ANY             :       A N Y;
ASTERISK        :       '*';
DCL             :       D C L;
END             :       E N D;
KEEP            :       K E E P;
PARAMNAMES      :       P A R A M N A M E S;
SPECIFIC        :       S P E C I F I C;
GEODE           :       G E O D E;
HYPERLINK       :       H Y P E R L I N K;
ENDTEXT         :       E N D T E X T;
RETURN          :       R E T U R N;
TIMER           :       T I M E R;
PROCESS         :       P R O C E S S;
ENDPROCESS      :       E N D P R O C E S S;
START           :       S T A R T;
STATE           :       S T A T E;
TEXT            :       T E X T;
PROCEDURE       :       P R O C E D U R E;
ENDPROCEDURE    :       E N D P R O C E D U R E;
PROCEDURE_CALL  :       P R O C E D U R E C A L L;
ENDSTATE        :       E N D S T A T E;
INPUT           :       I N P U T;
PROVIDED        :       P R O V I D E D;
PRIORITY        :       P R I O R I T Y;
SAVE            :       S A V E;
NONE            :       N O N E;
pid_expression
                :       S E L F
                |       P A R E N T
                |       O F F S P R I N G
                |       S E N D E R;
now_expression  :       N O W;
FOR             :       F O R;
ENDFOR          :       E N D F O R;
RANGE           :       R A N G E;
NEXTSTATE       :       N E X T S T A T E;
ANSWER          :       A N S W E R;
COMMENT         :       C O M M E N T;
LABEL           :       L A B E L;
STOP            :       S T O P;
IF              :       I F;
THEN            :       T H E N;
ELSE            :       E L S E;
FI              :       F I;
CREATE          :       C R E A T E;
OUTPUT          :       O U T P U T;
CALL            :       C A L L;
THIS            :       T H I S;
SET             :       S E T;
RESET           :       R E S E T;
ENDALTERNATIVE  :       E N D A L T E R N A T I V E;
ALTERNATIVE     :       A L T E R N A T I V E;
DECISION        :       D E C I S I O N;
ENDDECISION     :       E N D D E C I S I O N;
EXPORT          :       E X P O R T;
EXTERNAL        :       E X T E R N A L;
REFERENCED      :       R E F E R E N C E D;
CONNECTION      :       C O N N E C T I O N;
ENDCONNECTION   :       E N D C O N N E C T I O N;
FROM            :       F R O M;
TO              :       T O;
WITH            :       W I T H;
VIA             :       V I A;
ALL             :       A L L;
TASK            :       T A S K;
JOIN            :       J O I N;
PLUS            :       '+';
DOT             :       '.';
APPEND          :       '//';
IN              :       I N;
1239
OUT             :       O U T;
Maxime Perrotin's avatar
Maxime Perrotin committed
1240
INOUT           :       I N '/' O U T;
1241
1242
SUBSTRUCTURE    :       S U B S T R U C T U R E;
ENDSUBSTRUCTURE :       E N D S U B S T R U C T U R E;
Maxime Perrotin's avatar
Maxime Perrotin committed
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
FPAR            :       F P A R;
PARAM           :       P A R A M;
EQ              :       '=';
NEQ             :       '/=';
GT              :       '>';
GE              :       '>=';
LT              :        '<';
LE              :       '<=';
NOT             :       N O T;
OR              :       O R;
XOR             :       X O R;
AND             :       A N D;
IMPLIES         :       '=>';
DIV             :       '/';
MOD             :       M O D;
REM             :       R E M;
TRUE            :       T R U E;
FALSE           :       F A L S E;
ASNFILENAME     :       A S N F I L E N A M E;
NULL            :       N U L L;
PLUS_INFINITY   :       P L U S '-' I N F I N I T Y;
MINUS_INFINITY  :       M I N U S '-' I N F I N I T Y;
MANTISSA        :       M A N T I S S A;
EXPONENT        :       E X P O N E N T;
BASE            :       B A S E;
SYSTEM          :       S Y S T E M;
ENDSYSTEM       :       E N D S Y S T E M;
CHANNEL         :       C H A N N E L;
ENDCHANNEL      :       E N D C H A N N E L;
USE             :       U S E;
SIGNAL          :       S I G N A L;
BLOCK           :       B L O C K;
ENDBLOCK        :       E N D B L O C K;
SIGNALROUTE     :       S I G N A L R O U T E;
CONNECT         :       C O N N E C T;
1278
SYNTYPE         :       S Y N T Y P E;
dbarbera's avatar
dbarbera committed
1279
ENDSYNTYPE      :       E N D S Y N T Y P E;
1280
1281
NEWTYPE         :       N E W T Y P E;
ENDNEWTYPE      :       E N D N E W T Y P E;
dbarbera's avatar
dbarbera committed
1282
ARRAY           :       A R R A Y;
1283
1284
CONSTANTS       :	    C O N S T A N T S;
STRUCT          :	    S T R U C T;
dbarbera's avatar
dbarbera committed
1285
SYNONYM        	:       S Y N O N Y M;
dbarbera's avatar
dbarbera committed
1286
1287
1288
IMPORT          :       I M P O R T;
VIEW            :       V I E W;
ACTIVE          :       A C T I V E;
Maxime Perrotin's avatar
Maxime Perrotin committed
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
StringLiteral   :       STR+ ;

fragment
STR
        :       '\'' ( options {greedy=false;} : .)* '\''
        ;

ID
        :       ALPHA (ALPHA | DIGITS | '_')*;

fragment
ALPHA   :       ('a'..'z')|('A'..'Z');

INT     :       DASH? ( '0' | ('1'..'9') ('0'..'9')*);


fragment
DIGITS
        :       ('0'..'9')+;

FloatingPointLiteral
        :       INT DOT (DIGITS)? (Exponent)?
        |       INT
        ;

WS  :   (' ' | '\t' | '\r' | '\n')+ {$channel=HIDDEN;}
    ;
/*
COMMENT
    :   '//' ( options {greedy=false;} : . )* '//' {$channel=HIDDEN;}
    ;
*/

fragment
Exponent : ('e'|'E') ('+'|'-')? ('0'..'9')+ ;


COMMENT2
        :        '--' ( options {greedy=false;} : . )* ('--'|'\r'?'\n')
                 {$channel=HIDDEN;};


// Following fragments allows to have case insensitive grammar
fragment A:('a'|'A');
fragment B:('b'|'B');
fragment C:('c'|'C');
fragment D:('d'|'D');
fragment E:('e'|'E');
fragment F:('f'|'F');
fragment G:('g'|'G');
fragment H:('h'|'H');
fragment I:('i'|'I');
fragment J:('j'|'J');
fragment K:('k'|'K');
fragment L:('l'|'L');
fragment M:('m'|'M');
fragment N:('n'|'N');
fragment O:('o'|'O');
fragment P:('p'|'P');
fragment Q:('q'|'Q');
fragment R:('r'|'R');
fragment S:('s'|'S');
fragment T:('t'|'T');
fragment U:('u'|'U');
fragment V:('v'|'V');
fragment W:('w'|'W');
fragment X:('x'|'X');
fragment Y:('y'|'Y');
fragment Z:('z'|'Z');