rumoca 0.7.28

Modelica compiler written in RUST
Documentation
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
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
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
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
//! MLS §11: High Priority Statement and Algorithm Tests
//!
//! This module tests high priority normative requirements:
//! - §11.2.1: Assignment statement restrictions
//! - §11.2.4: For-statement restrictions
//! - §11.2.5: While-statement restrictions
//! - §11.2.6: Break and return statement restrictions
//! - §11.2.7: When-statement restrictions (algorithm section)
//!
//! Reference: https://specification.modelica.org/master/statements-and-algorithm-sections.html

use crate::spec::{expect_failure, expect_success};

// ============================================================================
// §11.2.1 ASSIGNMENT STATEMENT RESTRICTIONS
// ============================================================================

/// MLS §11.2.1: Assignment statement restrictions
mod assignment_restrictions {
    use super::*;

    /// MLS: "Input components cannot be assigned in algorithm"
    #[test]
    fn mls_11_2_1_input_assignment_forbidden() {
        expect_failure(
            r#"
            function Test
                input Real x;
                output Real y;
            algorithm
                x := 1.0;
                y := x;
            end Test;
            "#,
            "Test",
        );
    }

    /// MLS: "Parameter cannot be assigned in algorithm"
    #[test]
    fn mls_11_2_1_parameter_assignment_forbidden() {
        expect_failure(
            r#"
            model Test
                parameter Real k = 1;
            algorithm
                k := 2;
            end Test;
            "#,
            "Test",
        );
    }

    /// MLS: "Constant cannot be assigned in algorithm"
    #[test]
    fn mls_11_2_1_constant_assignment_forbidden() {
        expect_failure(
            r#"
            model Test
                constant Real c = 1;
            algorithm
                c := 2;
            end Test;
            "#,
            "Test",
        );
    }

    /// Valid: Regular variable assignment
    #[test]
    fn mls_11_2_1_variable_assignment_allowed() {
        expect_success(
            r#"
            model Test
                Real x(start = 0);
            algorithm
                x := 1.0;
            end Test;
            "#,
            "Test",
        );
    }

    /// Valid: Output assignment in function
    #[test]
    fn mls_11_2_1_output_assignment_allowed() {
        expect_success(
            r#"
            function Test
                input Real x;
                output Real y;
            algorithm
                y := x * 2;
            end Test;
            "#,
            "Test",
        );
    }

    /// Valid: Array element assignment
    #[test]
    fn mls_11_2_1_array_element_assignment_allowed() {
        expect_success(
            r#"
            model Test
                Real x[3];
            algorithm
                x[1] := 1;
                x[2] := 2;
                x[3] := 3;
            end Test;
            "#,
            "Test",
        );
    }
}

// ============================================================================
// §11.2.4 FOR-STATEMENT RESTRICTIONS
// ============================================================================

/// MLS §11.2.4: For-statement restrictions
mod for_statement_restrictions {
    use super::*;

    /// MLS: "Loop variable is implicitly declared and read-only"
    #[test]
    #[ignore = "Loop variable assignment detection not yet implemented"]
    fn mls_11_2_4_loop_variable_assignment_forbidden() {
        expect_failure(
            r#"
            model Test
                Real sum;
            algorithm
                sum := 0;
                for i in 1:10 loop
                    i := i + 1;
                    sum := sum + i;
                end for;
            end Test;
            "#,
            "Test",
        );
    }

    /// MLS: "Loop variable scope is the for-statement body"
    #[test]
    fn mls_11_2_4_loop_variable_outside_scope() {
        expect_failure(
            r#"
            model Test
                Real x;
            algorithm
                for i in 1:10 loop
                    x := i;
                end for;
                x := i;
            end Test;
            "#,
            "Test",
        );
    }

    /// Valid: Basic for loop
    #[test]
    fn mls_11_2_4_basic_for_loop() {
        expect_success(
            r#"
            model Test
                Real sum;
            algorithm
                sum := 0;
                for i in 1:10 loop
                    sum := sum + i;
                end for;
            end Test;
            "#,
            "Test",
        );
    }

    /// Valid: Nested for loops
    #[test]
    fn mls_11_2_4_nested_for_loops() {
        expect_success(
            r#"
            model Test
                Real A[3,3];
            algorithm
                for i in 1:3 loop
                    for j in 1:3 loop
                        A[i, j] := i * j;
                    end for;
                end for;
            end Test;
            "#,
            "Test",
        );
    }

    /// Valid: For loop with step
    #[test]
    fn mls_11_2_4_for_loop_with_step() {
        expect_success(
            r#"
            model Test
                Real sum;
            algorithm
                sum := 0;
                for i in 1:2:10 loop
                    sum := sum + i;
                end for;
            end Test;
            "#,
            "Test",
        );
    }
}

// ============================================================================
// §11.2.5 WHILE-STATEMENT RESTRICTIONS
// ============================================================================

/// MLS §11.2.5: While-statement restrictions
mod while_statement_restrictions {
    use super::*;

    /// MLS: "While condition must be Boolean expression"
    #[test]
    #[ignore = "While condition type check not yet implemented"]
    fn mls_11_2_5_while_condition_integer() {
        expect_failure(
            r#"
            model Test
                Integer n;
            algorithm
                n := 10;
                while n loop
                    n := n - 1;
                end while;
            end Test;
            "#,
            "Test",
        );
    }

    /// MLS: "While condition must be Boolean expression"
    #[test]
    #[ignore = "While condition type check not yet implemented"]
    fn mls_11_2_5_while_condition_real() {
        expect_failure(
            r#"
            model Test
                Real x;
            algorithm
                x := 10.0;
                while x loop
                    x := x - 1;
                end while;
            end Test;
            "#,
            "Test",
        );
    }

    /// Valid: While with Boolean condition
    #[test]
    fn mls_11_2_5_while_boolean_condition() {
        expect_success(
            r#"
            model Test
                Real x;
            algorithm
                x := 10;
                while x > 0 loop
                    x := x - 1;
                end while;
            end Test;
            "#,
            "Test",
        );
    }

    /// Valid: While with Boolean variable
    #[test]
    fn mls_11_2_5_while_boolean_variable() {
        expect_success(
            r#"
            model Test
                Real x;
                Boolean running;
            algorithm
                x := 10;
                running := true;
                while running loop
                    x := x - 1;
                    running := x > 0;
                end while;
            end Test;
            "#,
            "Test",
        );
    }
}

// ============================================================================
// §11.2.6 BREAK AND RETURN RESTRICTIONS
// ============================================================================

/// MLS §11.2.6: Break and return statement restrictions
mod break_return_restrictions {
    use super::*;

    /// MLS: "break can only be used in for or while"
    #[test]
    fn mls_11_2_6_break_outside_loop() {
        expect_failure(
            r#"
            model Test
                Real x;
            algorithm
                x := 1;
                break;
            end Test;
            "#,
            "Test",
        );
    }

    /// MLS: "return can only be used in functions"
    #[test]
    #[ignore = "Return context restriction not yet implemented"]
    fn mls_11_2_6_return_in_model() {
        expect_failure(
            r#"
            model Test
                Real x;
            algorithm
                x := 1;
                return;
            end Test;
            "#,
            "Test",
        );
    }

    /// Valid: Break in for loop
    #[test]
    fn mls_11_2_6_break_in_for() {
        expect_success(
            r#"
            model Test
                Real x;
            algorithm
                x := 0;
                for i in 1:100 loop
                    x := x + i;
                    if x > 50 then
                        break;
                    end if;
                end for;
            end Test;
            "#,
            "Test",
        );
    }

    /// Valid: Break in while loop
    #[test]
    fn mls_11_2_6_break_in_while() {
        expect_success(
            r#"
            model Test
                Real x;
            algorithm
                x := 0;
                while true loop
                    x := x + 1;
                    if x > 10 then
                        break;
                    end if;
                end while;
            end Test;
            "#,
            "Test",
        );
    }

    /// Valid: Return in function
    #[test]
    fn mls_11_2_6_return_in_function() {
        expect_success(
            r#"
            function Test
                input Real x;
                output Real y;
            algorithm
                if x < 0 then
                    y := 0;
                    return;
                end if;
                y := x;
            end Test;
            "#,
            "Test",
        );
    }
}

// ============================================================================
// §11.2.7 WHEN-STATEMENT RESTRICTIONS (ALGORITHM)
// ============================================================================

/// MLS §11.2.7: When-statement restrictions in algorithms
mod when_statement_restrictions {
    use super::*;

    /// MLS: "When-statements cannot be nested"
    #[test]
    #[ignore = "Nested when-statement detection not yet implemented"]
    fn mls_11_2_7_when_nested_forbidden() {
        expect_failure(
            r#"
            model Test
                Real x(start = 0);
                discrete Integer n(start = 0);
                discrete Integer m(start = 0);
            algorithm
                when x > 1 then
                    n := pre(n) + 1;
                    when x > 2 then
                        m := pre(m) + 1;
                    end when;
                end when;
            equation
                der(x) = 1;
            end Test;
            "#,
            "Test",
        );
    }

    /// MLS: "When-statements cannot appear in functions"
    #[test]
    #[ignore = "When in function detection not yet implemented"]
    fn mls_11_2_7_when_in_function_forbidden() {
        expect_failure(
            r#"
            function Test
                input Real x;
                output Integer n;
            algorithm
                n := 0;
                when x > 1 then
                    n := 1;
                end when;
            end Test;
            "#,
            "Test",
        );
    }

    /// MLS: "When-statements cannot be inside if-statements in algorithms"
    #[test]
    #[ignore = "When inside if detection not yet implemented"]
    fn mls_11_2_7_when_inside_if_forbidden() {
        expect_failure(
            r#"
            model Test
                Boolean cond = true;
                Real x(start = 0);
                discrete Integer n(start = 0);
            algorithm
                if cond then
                    when x > 1 then
                        n := pre(n) + 1;
                    end when;
                end if;
            equation
                der(x) = 1;
            end Test;
            "#,
            "Test",
        );
    }

    /// Valid: When-statement at top level of algorithm
    #[test]
    fn mls_11_2_7_when_top_level_allowed() {
        expect_success(
            r#"
            model Test
                Real x(start = 0);
                discrete Integer n(start = 0);
            algorithm
                when x > 1 then
                    n := pre(n) + 1;
                end when;
            equation
                der(x) = 1;
            end Test;
            "#,
            "Test",
        );
    }

    /// Valid: Multiple sequential when-statements
    #[test]
    fn mls_11_2_7_when_sequential_allowed() {
        expect_success(
            r#"
            model Test
                Real x(start = 0);
                discrete Integer n(start = 0);
                discrete Integer m(start = 0);
            algorithm
                when x > 1 then
                    n := pre(n) + 1;
                end when;
                when x > 2 then
                    m := pre(m) + 1;
                end when;
            equation
                der(x) = 1;
            end Test;
            "#,
            "Test",
        );
    }
}

// ============================================================================
// §11.1 ALGORITHM SECTION RESTRICTIONS
// ============================================================================

/// MLS §11.1: Algorithm section restrictions
mod algorithm_section_restrictions {
    use super::*;

    /// MLS: "Variables assigned in algorithm get start value at initialization"
    #[test]
    fn mls_11_1_algorithm_start_value() {
        expect_success(
            r#"
            model Test
                Real x(start = 5);
            algorithm
                x := x + 1;
            end Test;
            "#,
            "Test",
        );
    }

    /// MLS: "Multiple algorithm sections are executed in order"
    #[test]
    fn mls_11_1_multiple_algorithm_sections() {
        expect_success(
            r#"
            model Test
                Real x;
                Real y;
            algorithm
                x := 1;
            algorithm
                y := x + 1;
            end Test;
            "#,
            "Test",
        );
    }

    /// MLS: "Algorithm and equation sections can be mixed"
    #[test]
    fn mls_11_1_mixed_sections() {
        expect_success(
            r#"
            model Test
                Real x(start = 0);
                Real y;
                Real z;
            equation
                der(x) = 1;
            algorithm
                y := x * 2;
            equation
                z = y + 1;
            end Test;
            "#,
            "Test",
        );
    }
}