clipasm 0.5.0

A strict, typed language for compiling and rendering Video and Audio graphs
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
use std::collections::{BTreeMap, BTreeSet};
use std::ffi::OsStr;
use std::fs;
use std::path::{Path, PathBuf};

use crate::diagnostic::{BuiltinDiagnostic, Diagnostic, Result};
use crate::source::{
    ResolvedImport, SourceFile, SourcePackage, SourceProgramImplementation, SourceSpan, SourceUnit,
    SourceUnitId,
};

use super::lower::{CallableShape, builtin_shapes, lower_source};
use super::syntax::Declaration;
use super::{parser, sugar};

const MAX_IMPORT_DEPTH: usize = 128;

/// Parse, load, and link a native `.clipasm` package rooted at `path`.
///
/// Relative imports resolve from the file that declares them. Repeated
/// canonical paths are loaded once.
///
/// # Errors
///
/// Returns a source-located diagnostic for I/O, syntax, import, or
/// lowering failures.
pub fn parse_file(path: &Path) -> Result<SourcePackage> {
    let mut loader = Loader {
        builtins: builtin_shapes(),
        units: Vec::new(),
        loaded: BTreeMap::new(),
        visiting: Vec::new(),
        visiting_positions: BTreeMap::new(),
    };
    let root = loader.load(path, true, None, 0)?;
    Ok(SourcePackage {
        root,
        units: loader.units,
    })
}

struct Loader {
    builtins: BTreeMap<String, CallableShape>,
    units: Vec<SourceUnit>,
    loaded: BTreeMap<PathBuf, SourceUnitId>,
    visiting: Vec<PathBuf>,
    visiting_positions: BTreeMap<PathBuf, usize>,
}

impl Loader {
    #[expect(
        clippy::too_many_lines,
        reason = "one recursive load transaction owns path validation, deduplication, and cycle diagnostics"
    )]
    fn load(
        &mut self,
        path: &Path,
        is_root: bool,
        import_span: Option<&SourceSpan>,
        depth: usize,
    ) -> Result<SourceUnitId> {
        if depth > MAX_IMPORT_DEPTH {
            return Err(Diagnostic::builtin(
                BuiltinDiagnostic::ProgramImportDepth,
                format!("program import nesting exceeds the supported depth of {MAX_IMPORT_DEPTH}"),
                import_span
                    .cloned()
                    .unwrap_or_else(|| SourceSpan::file_start(path)),
            ));
        }
        require_clipasm_extension(path, import_span)?;
        let canonical = fs::canonicalize(path)
            .map_err(|error| Diagnostic::builtin_io(BuiltinDiagnostic::SourceIo, path, &error))?;
        if let Some(id) = self.loaded.get(&canonical).copied() {
            return Ok(id);
        }
        if let Some(start) = self.visiting_positions.get(&canonical).copied() {
            let mut cycle = self.visiting[start..]
                .iter()
                .map(|path| path.display().to_string())
                .collect::<Vec<_>>();
            cycle.push(canonical.display().to_string());
            return Err(Diagnostic::builtin(
                BuiltinDiagnostic::ProgramImportCycle,
                format!("program import cycle: {}", cycle.join(" -> ")),
                import_span
                    .cloned()
                    .unwrap_or_else(|| SourceSpan::file_start(&canonical)),
            ));
        }

        let text = fs::read_to_string(&canonical).map_err(|error| {
            Diagnostic::builtin_io(BuiltinDiagnostic::SourceIo, &canonical, &error)
        })?;
        let source = SourceFile::new(canonical.clone(), text);
        let syntax = parser::parse(source.clone())?;

        self.visiting_positions
            .insert(canonical.clone(), self.visiting.len());
        self.visiting.push(canonical.clone());

        let mut aliases = BTreeSet::new();
        let mut callables = self.builtins.clone();
        let mut import_targets = Vec::new();

        for declaration in &syntax.declarations {
            match declaration {
                Declaration::Import(import) => {
                    self.reserve_alias(&mut aliases, &import.alias.value, &import.alias.span)?;
                    let imported_path = resolve_from(&canonical, Path::new(&import.path.value));
                    let target =
                        self.load(&imported_path, false, Some(&import.path.span), depth + 1)?;
                    let shape = CallableShape::from_source(self.units[target.index()].program());
                    let replaced = callables.insert(import.alias.value.clone(), shape);
                    debug_assert!(replaced.is_none());
                    import_targets.push(target);
                }
                Declaration::Config(_)
                | Declaration::External(_)
                | Declaration::Input(_)
                | Declaration::Parameter(_) => {}
            }
        }

        let unit = lower_source(source, syntax, &callables)?;
        if matches!(
            unit.program.implementation(),
            SourceProgramImplementation::External(_)
        ) && let Some(import) = unit.imports.first()
        {
            return Err(Diagnostic::builtin(
                BuiltinDiagnostic::ExternalWithImports,
                "an external program cannot import other programs; use a separate ClipAsm wrapper program for composition",
                import.alias.span.clone(),
            ));
        }
        if !is_root {
            if let Some(project) = &unit.project {
                return Err(Diagnostic::builtin(
                    BuiltinDiagnostic::ImportedProjectSettings,
                    "imported programs cannot declare project settings",
                    project.span.clone(),
                ));
            }
            if let Some(output) = &unit.output {
                return Err(Diagnostic::builtin(
                    BuiltinDiagnostic::ImportedOutput,
                    "imported programs cannot declare `config.output`; publication belongs to the root entrypoint",
                    output.span.clone(),
                ));
            }
        }

        debug_assert_eq!(unit.imports.len(), import_targets.len());
        let imports = unit
            .imports
            .into_iter()
            .zip(import_targets)
            .map(|(import, target)| ResolvedImport {
                alias: import.alias,
                target,
            })
            .collect();
        let popped = self.visiting.pop().expect("active source loading frame");
        debug_assert_eq!(popped, canonical);
        self.visiting_positions.remove(&canonical);

        let id = SourceUnitId(self.units.len());
        self.units.push(SourceUnit {
            source: unit.source,
            imports,
            project: unit.project,
            program: unit.program,
            output: unit.output,
        });
        self.loaded.insert(canonical, id);
        Ok(id)
    }

    fn reserve_alias(
        &self,
        aliases: &mut BTreeSet<String>,
        alias: &str,
        span: &SourceSpan,
    ) -> Result<()> {
        if !aliases.insert(alias.to_owned()) {
            return Err(Diagnostic::builtin(
                BuiltinDiagnostic::DuplicateProgramImport,
                format!("duplicate program import alias `{alias}`"),
                span.clone(),
            ));
        }
        if self.builtins.contains_key(alias) {
            return Err(Diagnostic::builtin(
                BuiltinDiagnostic::ProgramImportCollision,
                format!("program import alias `{alias}` collides with a built-in program"),
                span.clone(),
            ));
        }
        if sugar::resolve(alias).is_some() {
            return Err(Diagnostic::builtin(
                BuiltinDiagnostic::ProgramImportCollision,
                format!("program import alias `{alias}` collides with language sugar"),
                span.clone(),
            ));
        }
        if !super::parser::accepts_invocation_name(alias) {
            return Err(Diagnostic::builtin(
                BuiltinDiagnostic::ProgramImportCollision,
                format!("program import alias `{alias}` is reserved by the language"),
                span.clone(),
            ));
        }
        Ok(())
    }
}

fn resolve_from(source: &Path, authored: &Path) -> PathBuf {
    if authored.is_absolute() {
        authored.to_path_buf()
    } else {
        source
            .parent()
            .unwrap_or_else(|| Path::new("."))
            .join(authored)
    }
}

fn require_clipasm_extension(path: &Path, span: Option<&SourceSpan>) -> Result<()> {
    if path.extension() == Some(OsStr::new("clipasm")) {
        return Ok(());
    }
    Err(Diagnostic::builtin(
        BuiltinDiagnostic::SourceExtension,
        "ClipAsm source files must use the `.clipasm` extension",
        span.cloned()
            .unwrap_or_else(|| SourceSpan::file_start(path)),
    ))
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::compiler;

    fn write(directory: &Path, name: &str, source: &str) -> PathBuf {
        let path = directory.join(name);
        fs::write(&path, source).expect("write source fixture");
        path
    }

    #[test]
    fn loads_and_compiles_transitive_native_imports() {
        let directory = tempfile::tempdir().expect("temporary directory");
        write(
            directory.path(),
            "leaf.clipasm",
            "clipasm 1\ninput video: Video\nparam count: Integer\nrepeat($video, $count)\n",
        );
        write(
            directory.path(),
            "middle.clipasm",
            "clipasm 1\nimport \"leaf.clipasm\" as leaf\ninput video: Video\nparam count: Integer\nleaf($video, $count)\n",
        );
        let root = write(
            directory.path(),
            "root.clipasm",
            "clipasm 1\nconfig {\n  video {\n    width = 64\n    height = 64\n    fps = 10\n  }\n}\nimport \"middle.clipasm\" as middle\nimage(\"card.png\", 1s)\nmiddle(2)\n",
        );

        let package = parse_file(&root).expect("native package");
        assert_eq!(package.units().len(), 3);
        let compiled = compiler::compile(&package).expect("compiled package");
        assert_eq!(
            compiled.result_domain().expect("known domain").frames().0,
            20
        );
    }

    #[test]
    fn deduplicates_repeated_clipasm_import_paths() {
        let directory = tempfile::tempdir().expect("temporary directory");
        write(
            directory.path(),
            "effect.clipasm",
            "clipasm 1\ninput video: Video\nrepeat($video, 1)\n",
        );
        write(
            directory.path(),
            "external.clipasm",
            "clipasm 1\ninput video: Video\nparam amount: Integer\nexternal {\n  executable = \"./missing-script\"\n  semantic_version = 1\n  preserve = video\n}\n",
        );
        let root = write(
            directory.path(),
            "root.clipasm",
            "clipasm 1\nimport \"effect.clipasm\" as first\nimport \"./effect.clipasm\" as second\nimport \"external.clipasm\" as external_one\nimport \"./external.clipasm\" as external_two\nimage(\"card.png\", 1s)\nfirst\nsecond\nexternal_one(1)\nexternal_two(2)\n",
        );

        let package = parse_file(&root).expect("deduplicated package");
        assert_eq!(package.units().len(), 3);
        compiler::compile(&package).expect("compiled package");
    }

    #[test]
    fn reports_native_import_cycles_with_the_full_path() {
        let directory = tempfile::tempdir().expect("temporary directory");
        let first = write(
            directory.path(),
            "first.clipasm",
            "clipasm 1\nimport \"second.clipasm\" as second\nsecond\n",
        );
        write(
            directory.path(),
            "second.clipasm",
            "clipasm 1\nimport \"first.clipasm\" as first\nfirst\n",
        );

        let error = parse_file(&first).expect_err("import cycle");
        assert_eq!(error.code, "E_PROGRAM_IMPORT_CYCLE");
        assert!(error.message.contains("first.clipasm"));
        assert!(error.message.contains("second.clipasm"));
    }

    #[test]
    fn rejects_duplicate_and_reserved_import_aliases() {
        let directory = tempfile::tempdir().expect("temporary directory");
        write(directory.path(), "empty.clipasm", "clipasm 1\n");
        let duplicate = write(
            directory.path(),
            "duplicate.clipasm",
            "clipasm 1\nimport \"empty.clipasm\" as effect\nimport \"empty.clipasm\" as effect\n",
        );
        let error = parse_file(&duplicate).expect_err("duplicate alias");
        assert_eq!(error.code, "E_DUPLICATE_PROGRAM_IMPORT");

        let builtin = write(
            directory.path(),
            "builtin.clipasm",
            "clipasm 1\nimport \"empty.clipasm\" as image\n",
        );
        let error = parse_file(&builtin).expect_err("built-in collision");
        assert_eq!(error.code, "E_PROGRAM_IMPORT_COLLISION");

        let sugar = write(
            directory.path(),
            "sugar.clipasm",
            "clipasm 1\nimport \"empty.clipasm\" as clip\n",
        );
        let error = parse_file(&sugar).expect_err("sugar collision");
        assert_eq!(error.code, "E_PROGRAM_IMPORT_COLLISION");

        let declaration = write(
            directory.path(),
            "declaration.clipasm",
            "clipasm 1\nimport \"empty.clipasm\" as input\n",
        );
        let error = parse_file(&declaration).expect_err("language reservation");
        assert_eq!(error.code, "E_PROGRAM_IMPORT_COLLISION");
        assert!(error.message.contains("reserved by the language"));
    }

    #[test]
    fn rejects_root_only_settings_in_imported_programs() {
        let directory = tempfile::tempdir().expect("temporary directory");
        write(
            directory.path(),
            "project.clipasm",
            "clipasm 1\nconfig {\n  video {\n    width = 64\n  }\n}\n",
        );
        let root = write(
            directory.path(),
            "root.clipasm",
            "clipasm 1\nimport \"project.clipasm\" as project\n",
        );
        let error = parse_file(&root).expect_err("imported project settings");
        assert_eq!(error.code, "E_IMPORTED_PROJECT_SETTINGS");

        write(
            directory.path(),
            "output.clipasm",
            "clipasm 1\nconfig {\n  output = \"result.mp4\"\n}\n",
        );
        let root = write(
            directory.path(),
            "output-root.clipasm",
            "clipasm 1\nimport \"output.clipasm\" as output\n",
        );
        let error = parse_file(&root).expect_err("imported output");
        assert_eq!(error.code, "E_IMPORTED_OUTPUT");
    }

    #[test]
    fn loads_external_clipasm_programs_for_native_calls() {
        let directory = tempfile::tempdir().expect("temporary directory");
        write(
            directory.path(),
            "effect.clipasm",
            "clipasm 1\ninput video: Video\nparam amount: Integer\nexternal {\n  executable = \"./missing-script\"\n  semantic_version = 1\n  preserve = video\n}\n",
        );
        let root = write(
            directory.path(),
            "root.clipasm",
            "clipasm 1\nimport \"effect.clipasm\" as effect\nimage(\"card.png\", 1s)\neffect(12)\n",
        );

        let package = parse_file(&root).expect("external package");
        let compiled = compiler::compile(&package).expect("compiled external package");
        let document: serde_json::Value =
            serde_json::from_str(&compiled.compiled_json().expect("compiled JSON"))
                .expect("JSON document");
        assert_eq!(document["nodes"][1]["kind"]["operation"], "external_video");
        assert_eq!(document["nodes"][1]["kind"]["parameters"]["amount"], 12);
    }

    #[test]
    fn requires_clipasm_extensions_for_root_and_imported_sources() {
        let directory = tempfile::tempdir().expect("temporary directory");
        let root = write(directory.path(), "root.txt", "clipasm 1\n");
        let error = parse_file(&root).expect_err("root extension");
        assert_eq!(error.code, "E_SOURCE_EXTENSION");

        write(directory.path(), "child.txt", "clipasm 1\n");
        let root = write(
            directory.path(),
            "root.clipasm",
            "clipasm 1\nimport \"child.txt\" as child\n",
        );
        let error = parse_file(&root).expect_err("import extension");
        assert_eq!(error.code, "E_SOURCE_EXTENSION");
        assert!(error.span.file().ends_with("root.clipasm"));
    }
}