seq-compiler 5.6.3

Compiler for the Seq programming language
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
use super::*;
use crate::ast::{Span, Statement, WordDef};
use std::path::Path;

fn make_word_call(name: &str) -> Statement {
    Statement::WordCall {
        name: name.to_string(),
        span: Some(Span::new(0, 0, name.len())),
    }
}

#[test]
fn test_immediate_weave_drop() {
    // : bad ( -- ) [ gen ] strand.weave drop ;
    let word = WordDef {
        name: "bad".to_string(),
        effect: None,
        body: vec![
            Statement::Quotation {
                span: None,
                id: 0,
                body: vec![make_word_call("gen")],
            },
            make_word_call("strand.weave"),
            make_word_call("drop"),
        ],
        source: None,
        allowed_lints: vec![],
    };

    let mut analyzer = ResourceAnalyzer::new(Path::new("test.seq"));
    let diagnostics = analyzer.analyze_word(&word);

    assert_eq!(diagnostics.len(), 1);
    assert!(diagnostics[0].id.contains("weavehandle"));
    assert!(diagnostics[0].message.contains("dropped without cleanup"));
}

#[test]
fn test_weave_properly_cancelled() {
    // : good ( -- ) [ gen ] strand.weave strand.weave-cancel ;
    let word = WordDef {
        name: "good".to_string(),
        effect: None,
        body: vec![
            Statement::Quotation {
                span: None,
                id: 0,
                body: vec![make_word_call("gen")],
            },
            make_word_call("strand.weave"),
            make_word_call("strand.weave-cancel"),
        ],
        source: None,
        allowed_lints: vec![],
    };

    let mut analyzer = ResourceAnalyzer::new(Path::new("test.seq"));
    let diagnostics = analyzer.analyze_word(&word);

    assert!(
        diagnostics.is_empty(),
        "Expected no warnings for properly cancelled weave"
    );
}

#[test]
fn test_branch_inconsistent_handling() {
    // : bad ( -- )
    //   [ gen ] strand.weave
    //   true if strand.weave-cancel else drop then ;
    let word = WordDef {
        name: "bad".to_string(),
        effect: None,
        body: vec![
            Statement::Quotation {
                span: None,
                id: 0,
                body: vec![make_word_call("gen")],
            },
            make_word_call("strand.weave"),
            Statement::BoolLiteral(true),
            Statement::If {
                then_branch: vec![make_word_call("strand.weave-cancel")],
                else_branch: Some(vec![make_word_call("drop")]),
                span: None,
            },
        ],
        source: None,
        allowed_lints: vec![],
    };

    let mut analyzer = ResourceAnalyzer::new(Path::new("test.seq"));
    let diagnostics = analyzer.analyze_word(&word);

    // Should warn about drop in else branch
    assert!(!diagnostics.is_empty());
}

#[test]
fn test_both_branches_cancel() {
    // : good ( -- )
    //   [ gen ] strand.weave
    //   true if strand.weave-cancel else strand.weave-cancel then ;
    let word = WordDef {
        name: "good".to_string(),
        effect: None,
        body: vec![
            Statement::Quotation {
                span: None,
                id: 0,
                body: vec![make_word_call("gen")],
            },
            make_word_call("strand.weave"),
            Statement::BoolLiteral(true),
            Statement::If {
                then_branch: vec![make_word_call("strand.weave-cancel")],
                else_branch: Some(vec![make_word_call("strand.weave-cancel")]),
                span: None,
            },
        ],
        source: None,
        allowed_lints: vec![],
    };

    let mut analyzer = ResourceAnalyzer::new(Path::new("test.seq"));
    let diagnostics = analyzer.analyze_word(&word);

    assert!(
        diagnostics.is_empty(),
        "Expected no warnings when both branches cancel"
    );
}

#[test]
fn test_channel_leak() {
    // : bad ( -- ) chan.make drop ;
    let word = WordDef {
        name: "bad".to_string(),
        effect: None,
        body: vec![make_word_call("chan.make"), make_word_call("drop")],
        source: None,
        allowed_lints: vec![],
    };

    let mut analyzer = ResourceAnalyzer::new(Path::new("test.seq"));
    let diagnostics = analyzer.analyze_word(&word);

    assert_eq!(diagnostics.len(), 1);
    assert!(diagnostics[0].id.contains("channel"));
}

#[test]
fn test_channel_properly_closed() {
    // : good ( -- ) chan.make chan.close ;
    let word = WordDef {
        name: "good".to_string(),
        effect: None,
        body: vec![make_word_call("chan.make"), make_word_call("chan.close")],
        source: None,
        allowed_lints: vec![],
    };

    let mut analyzer = ResourceAnalyzer::new(Path::new("test.seq"));
    let diagnostics = analyzer.analyze_word(&word);

    assert!(
        diagnostics.is_empty(),
        "Expected no warnings for properly closed channel"
    );
}

#[test]
fn test_swap_resource_tracking() {
    // : test ( -- ) chan.make 1 swap drop drop ;
    // After swap: chan is on top, 1 is second
    // First drop removes chan (should warn), second drop removes 1
    let word = WordDef {
        name: "test".to_string(),
        effect: None,
        body: vec![
            make_word_call("chan.make"),
            Statement::IntLiteral(1),
            make_word_call("swap"),
            make_word_call("drop"), // drops chan - should warn
            make_word_call("drop"), // drops 1
        ],
        source: None,
        allowed_lints: vec![],
    };

    let mut analyzer = ResourceAnalyzer::new(Path::new("test.seq"));
    let diagnostics = analyzer.analyze_word(&word);

    assert_eq!(
        diagnostics.len(),
        1,
        "Expected warning for dropped channel: {:?}",
        diagnostics
    );
    assert!(diagnostics[0].id.contains("channel"));
}

#[test]
fn test_over_resource_tracking() {
    // : test ( -- ) chan.make 1 over drop drop drop ;
    // Stack after chan.make: (chan)
    // Stack after 1: (chan 1)
    // Stack after over: (chan 1 chan) - chan copied to top
    // Both chan references are dropped without cleanup - both warn
    let word = WordDef {
        name: "test".to_string(),
        effect: None,
        body: vec![
            make_word_call("chan.make"),
            Statement::IntLiteral(1),
            make_word_call("over"),
            make_word_call("drop"), // drops copied chan - warns
            make_word_call("drop"), // drops 1
            make_word_call("drop"), // drops original chan - also warns
        ],
        source: None,
        allowed_lints: vec![],
    };

    let mut analyzer = ResourceAnalyzer::new(Path::new("test.seq"));
    let diagnostics = analyzer.analyze_word(&word);

    // Both channel drops warn (they share ID but neither was properly consumed)
    assert_eq!(
        diagnostics.len(),
        2,
        "Expected 2 warnings for dropped channels: {:?}",
        diagnostics
    );
}

#[test]
fn test_channel_transferred_via_spawn() {
    // Pattern from shopping-cart: channel transferred to spawned worker
    // : accept-loop ( -- )
    //   chan.make                  # create channel
    //   dup [ worker ] strand.spawn  # transfer to worker
    //   drop drop                  # drop strand-id and dup'd chan
    //   chan.send                  # use remaining chan
    // ;
    let word = WordDef {
        name: "accept-loop".to_string(),
        effect: None,
        body: vec![
            make_word_call("chan.make"),
            make_word_call("dup"),
            Statement::Quotation {
                span: None,
                id: 0,
                body: vec![make_word_call("worker")],
            },
            make_word_call("strand.spawn"),
            make_word_call("drop"),
            make_word_call("drop"),
            make_word_call("chan.send"),
        ],
        source: None,
        allowed_lints: vec![],
    };

    let mut analyzer = ResourceAnalyzer::new(Path::new("test.seq"));
    let diagnostics = analyzer.analyze_word(&word);

    assert!(
        diagnostics.is_empty(),
        "Expected no warnings when channel is transferred via strand.spawn: {:?}",
        diagnostics
    );
}

#[test]
fn test_else_branch_only_leak() {
    // : test ( -- )
    //   chan.make
    //   true if chan.close else drop then ;
    // The else branch drops without cleanup - should warn about inconsistency
    // AND the join should track that the resource might not be consumed
    let word = WordDef {
        name: "test".to_string(),
        effect: None,
        body: vec![
            make_word_call("chan.make"),
            Statement::BoolLiteral(true),
            Statement::If {
                then_branch: vec![make_word_call("chan.close")],
                else_branch: Some(vec![make_word_call("drop")]),
                span: None,
            },
        ],
        source: None,
        allowed_lints: vec![],
    };

    let mut analyzer = ResourceAnalyzer::new(Path::new("test.seq"));
    let diagnostics = analyzer.analyze_word(&word);

    // Should have warnings: branch inconsistency + drop without cleanup
    assert!(
        !diagnostics.is_empty(),
        "Expected warnings for else-branch leak: {:?}",
        diagnostics
    );
}

#[test]
fn test_branch_join_both_consume() {
    // : test ( -- )
    //   chan.make
    //   true if chan.close else chan.close then ;
    // Both branches properly consume - no warnings
    let word = WordDef {
        name: "test".to_string(),
        effect: None,
        body: vec![
            make_word_call("chan.make"),
            Statement::BoolLiteral(true),
            Statement::If {
                then_branch: vec![make_word_call("chan.close")],
                else_branch: Some(vec![make_word_call("chan.close")]),
                span: None,
            },
        ],
        source: None,
        allowed_lints: vec![],
    };

    let mut analyzer = ResourceAnalyzer::new(Path::new("test.seq"));
    let diagnostics = analyzer.analyze_word(&word);

    assert!(
        diagnostics.is_empty(),
        "Expected no warnings when both branches consume: {:?}",
        diagnostics
    );
}

#[test]
fn test_branch_join_neither_consume() {
    // : test ( -- )
    //   chan.make
    //   true if else then drop ;
    // Neither branch consumes, then drop after - should warn
    let word = WordDef {
        name: "test".to_string(),
        effect: None,
        body: vec![
            make_word_call("chan.make"),
            Statement::BoolLiteral(true),
            Statement::If {
                then_branch: vec![],
                else_branch: Some(vec![]),
                span: None,
            },
            make_word_call("drop"), // drops the channel
        ],
        source: None,
        allowed_lints: vec![],
    };

    let mut analyzer = ResourceAnalyzer::new(Path::new("test.seq"));
    let diagnostics = analyzer.analyze_word(&word);

    assert_eq!(
        diagnostics.len(),
        1,
        "Expected warning for dropped channel: {:?}",
        diagnostics
    );
    assert!(diagnostics[0].id.contains("channel"));
}

// ========================================================================
// Cross-word analysis tests (ProgramResourceAnalyzer)
// ========================================================================

#[test]
fn test_cross_word_resource_tracking() {
    // Test that resources returned from user-defined words are tracked
    //
    // : make-chan ( -- chan ) chan.make ;
    // : leak-it ( -- ) make-chan drop ;
    //
    // The drop in leak-it should warn because make-chan returns a channel
    use crate::ast::Program;

    let make_chan = WordDef {
        name: "make-chan".to_string(),
        effect: None,
        body: vec![make_word_call("chan.make")],
        source: None,
        allowed_lints: vec![],
    };

    let leak_it = WordDef {
        name: "leak-it".to_string(),
        effect: None,
        body: vec![make_word_call("make-chan"), make_word_call("drop")],
        source: None,
        allowed_lints: vec![],
    };

    let program = Program {
        words: vec![make_chan, leak_it],
        includes: vec![],
        unions: vec![],
    };

    let mut analyzer = ProgramResourceAnalyzer::new(Path::new("test.seq"));
    let diagnostics = analyzer.analyze_program(&program);

    assert_eq!(
        diagnostics.len(),
        1,
        "Expected warning for dropped channel from make-chan: {:?}",
        diagnostics
    );
    assert!(diagnostics[0].id.contains("channel"));
    assert!(diagnostics[0].message.contains("make-chan"));
}

#[test]
fn test_cross_word_proper_cleanup() {
    // Test that properly cleaned up cross-word resources don't warn
    //
    // : make-chan ( -- chan ) chan.make ;
    // : use-it ( -- ) make-chan chan.close ;
    use crate::ast::Program;

    let make_chan = WordDef {
        name: "make-chan".to_string(),
        effect: None,
        body: vec![make_word_call("chan.make")],
        source: None,
        allowed_lints: vec![],
    };

    let use_it = WordDef {
        name: "use-it".to_string(),
        effect: None,
        body: vec![make_word_call("make-chan"), make_word_call("chan.close")],
        source: None,
        allowed_lints: vec![],
    };

    let program = Program {
        words: vec![make_chan, use_it],
        includes: vec![],
        unions: vec![],
    };

    let mut analyzer = ProgramResourceAnalyzer::new(Path::new("test.seq"));
    let diagnostics = analyzer.analyze_program(&program);

    assert!(
        diagnostics.is_empty(),
        "Expected no warnings for properly closed channel: {:?}",
        diagnostics
    );
}

#[test]
fn test_cross_word_chain() {
    // Test multi-level cross-word tracking
    //
    // : make-chan ( -- chan ) chan.make ;
    // : wrap-chan ( -- chan ) make-chan ;
    // : leak-chain ( -- ) wrap-chan drop ;
    use crate::ast::Program;

    let make_chan = WordDef {
        name: "make-chan".to_string(),
        effect: None,
        body: vec![make_word_call("chan.make")],
        source: None,
        allowed_lints: vec![],
    };

    let wrap_chan = WordDef {
        name: "wrap-chan".to_string(),
        effect: None,
        body: vec![make_word_call("make-chan")],
        source: None,
        allowed_lints: vec![],
    };

    let leak_chain = WordDef {
        name: "leak-chain".to_string(),
        effect: None,
        body: vec![make_word_call("wrap-chan"), make_word_call("drop")],
        source: None,
        allowed_lints: vec![],
    };

    let program = Program {
        words: vec![make_chan, wrap_chan, leak_chain],
        includes: vec![],
        unions: vec![],
    };

    let mut analyzer = ProgramResourceAnalyzer::new(Path::new("test.seq"));
    let diagnostics = analyzer.analyze_program(&program);

    // Should detect the leak through the chain
    assert_eq!(
        diagnostics.len(),
        1,
        "Expected warning for dropped channel through chain: {:?}",
        diagnostics
    );
}