vexil-lang 0.5.0

Compiler library for the Vexil schema definition language — lexer, parser, IR, and type checker
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

/// Compiled meta-schemas for the `vexil.*` namespace.
///
/// The meta-schema describes Vexil's own IR types and is used by `vexil-store`
/// to encode/decode compiled schemas as first-class Vexil values.
/// Compilation is done once at first use and cached for the process lifetime.
use std::sync::OnceLock;

use crate::diagnostic::Severity;
use crate::ir::CompiledSchema;

static META_SCHEMA: OnceLock<CompiledSchema> = OnceLock::new();
static PACK_SCHEMA: OnceLock<CompiledSchema> = OnceLock::new();

/// The compiled `vexil.schema` meta-schema.
///
/// Describes Vexil's own IR types (`MessageDef`, `EnumDef`, `CompiledSchema`, …).
/// Panics at first call if the embedded source fails to compile — that would
/// be a build-time bug in the language implementation, not a runtime error.
pub fn meta_schema() -> &'static CompiledSchema {
    META_SCHEMA.get_or_init(|| {
        let source = include_str!("../schemas/schema.vexil");
        let result = super::compile_impl(source, true);
        let has_errors = result
            .diagnostics
            .iter()
            .any(|d| d.severity == Severity::Error);
        assert!(
            !has_errors,
            "BUG: embedded vexil.schema failed to compile: {:?}",
            result.diagnostics
        );
        result
            .compiled
            .expect("BUG: vexil.schema produced no compiled output")
    })
}

/// The compiled `vexil.pack` meta-schema.
///
/// Describes the `DataEntry`/`DataPack` types used for multi-value binary packs.
/// Panics at first call if the embedded source fails to compile.
pub fn pack_schema() -> &'static CompiledSchema {
    PACK_SCHEMA.get_or_init(|| {
        let source = include_str!("../schemas/pack.vexil");
        let result = super::compile_impl(source, true);
        let has_errors = result
            .diagnostics
            .iter()
            .any(|d| d.severity == Severity::Error);
        assert!(
            !has_errors,
            "BUG: embedded vexil.pack failed to compile: {:?}",
            result.diagnostics
        );
        result
            .compiled
            .expect("BUG: vexil.pack produced no compiled output")
    })
}