tessellate-core 0.3.0

Compiler and deterministic runtime for the Tess rule language
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
use crate::source::{SourceFile, Span, Spanned};
use serde::{Deserialize, Serialize};

pub type Name = String;

#[derive(Clone, Debug)]
pub struct Program {
    pub source: SourceFile,
    pub module: Spanned<Name>,
    /// Other partial-module files referenced by this program's `use` declarations.
    ///
    /// Used files are resolved by project-aware hosts such as the Tess CLI. The
    /// compiler itself receives the declarations from every reachable file as
    /// one program, so name resolution remains intentionally module-wide.
    pub imports: Vec<ImportDecl>,
    /// Set only by a project-aware loader after every `use` target is included.
    pub imports_resolved: bool,
    pub declarations: Vec<Declaration>,
}

#[derive(Clone, Debug)]
pub struct ImportDecl {
    pub path: Spanned<String>,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub enum Declaration {
    Enum(EnumDecl),
    Entity(EntityDecl),
    State(StateDecl),
    Derive(DeriveDecl),
    Decision(DecisionDecl),
    Action(ActionDecl),
    Transition(TransitionDecl),
    Fragment(FragmentDecl),
    Rule(RuleDecl),
    Case(CaseDecl),
    Invariant(InvariantDecl),
    Trace(TraceDecl),
}

impl Declaration {
    #[must_use]
    pub fn name(&self) -> &Spanned<Name> {
        match self {
            Self::Enum(value) => &value.name,
            Self::Entity(value) => &value.name,
            Self::State(value) => &value.name,
            Self::Derive(value) => &value.name,
            Self::Decision(value) => &value.name,
            Self::Action(value) => &value.name,
            Self::Transition(value) => &value.name,
            Self::Fragment(value) => &value.id,
            Self::Rule(value) => &value.name,
            Self::Case(value) => &value.name,
            Self::Invariant(value) => &value.name,
            Self::Trace(value) => &value.name,
        }
    }

    #[must_use]
    pub fn span(&self) -> Span {
        match self {
            Self::Enum(value) => value.span,
            Self::Entity(value) => value.span,
            Self::State(value) => value.span,
            Self::Derive(value) => value.span,
            Self::Decision(value) => value.span,
            Self::Action(value) => value.span,
            Self::Transition(value) => value.span,
            Self::Fragment(value) => value.span,
            Self::Rule(value) => value.span,
            Self::Case(value) => value.span,
            Self::Invariant(value) => value.span,
            Self::Trace(value) => value.span,
        }
    }
}

#[derive(Clone, Debug)]
pub struct EnumDecl {
    pub name: Spanned<Name>,
    pub variants: Vec<Spanned<Name>>,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub struct EntityDecl {
    pub name: Spanned<Name>,
    pub fields: Vec<FieldDecl>,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub struct StateDecl {
    pub name: Spanned<Name>,
    pub fields: Vec<FieldDecl>,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub struct FieldDecl {
    pub name: Spanned<Name>,
    pub ty: TypeRef,
    pub range: Option<RangeConstraint>,
    pub domain: Option<DomainConstraint>,
    pub optional: bool,
    pub span: Span,
}

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub enum TypeRef {
    Bool,
    Int,
    Decimal,
    String,
    Date,
    Duration,
    Named(Name),
    Unknown,
}

#[derive(Clone, Debug)]
pub struct RangeConstraint {
    pub start: NumericLiteral,
    pub end: NumericLiteral,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub struct DomainConstraint {
    pub values: Vec<Expr>,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub struct Parameter {
    pub ty: Spanned<Name>,
    pub name: Spanned<Name>,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub struct DeriveDecl {
    pub name: Spanned<Name>,
    pub parameters: Vec<Parameter>,
    pub return_type: Spanned<TypeRef>,
    pub expression: Expr,
    /// Native-document fragments that define or justify this function.
    ///
    /// A function nested in a fragment receives that fragment as its implicit
    /// first basis, just as a nested rule does.
    pub basis: Vec<FragmentRef>,
    pub span: Span,
}

#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum Cardinality {
    #[default]
    ExactlyOne,
    ZeroOrOne,
    Many,
}

#[derive(Clone, Debug)]
pub struct DecisionDecl {
    pub name: Spanned<Name>,
    pub parameters: Vec<Parameter>,
    pub return_type: Spanned<TypeRef>,
    pub cardinality: Cardinality,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub struct ActionDecl {
    pub name: Spanned<Name>,
    pub parameters: Vec<Parameter>,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub struct TransitionDecl {
    pub name: Spanned<Name>,
    pub parameters: Vec<Parameter>,
    pub action: Spanned<Name>,
    pub action_arguments: Vec<Expr>,
    pub condition: Expr,
    pub updates: Vec<StateUpdate>,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub struct StateUpdate {
    pub receiver: Spanned<Name>,
    pub field: Spanned<Name>,
    pub value: Expr,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub struct FragmentDecl {
    /// Stable Tess identity used for references, package qualification, and graphs.
    pub id: Spanned<Name>,
    /// Opaque native-document locator retained as display/provenance metadata.
    pub locator: Spanned<String>,
    pub text: Spanned<String>,
    pub refs: Vec<FragmentRef>,
    pub derives: Vec<DeriveDecl>,
    pub rules: Vec<RuleDecl>,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub struct FragmentRef {
    pub id: Spanned<Name>,
}

impl FragmentRef {
    #[must_use]
    pub const fn span(&self) -> Span {
        self.id.span
    }
}

#[derive(Clone, Debug)]
pub struct RuleDecl {
    pub name: Spanned<Name>,
    pub parameters: Vec<Parameter>,
    pub condition: Expr,
    pub effect: Effect,
    pub basis: Vec<FragmentRef>,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub enum Effect {
    Decide {
        decision: Spanned<Name>,
        arguments: Vec<Expr>,
        value: Expr,
        span: Span,
    },
    Override {
        rule: Spanned<Name>,
        span: Span,
    },
    /// Recovery placeholder for a rule whose effect line could not be parsed.
    Invalid {
        span: Span,
    },
}

#[derive(Clone, Debug)]
pub struct CaseDecl {
    pub name: Spanned<Name>,
    pub bindings: Vec<BindingDecl>,
    pub expectations: Vec<Expectation>,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub struct BindingDecl {
    pub name: Spanned<Name>,
    pub entity: Spanned<Name>,
    pub fields: Vec<FieldValue>,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub struct FieldValue {
    pub name: Spanned<Name>,
    pub value: Expr,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub struct Expectation {
    pub decision: Spanned<Name>,
    pub arguments: Vec<Expr>,
    pub operator: CompareOp,
    pub value: Expr,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub struct InvariantDecl {
    pub name: Spanned<Name>,
    pub quantifier: InvariantQuantifier,
    pub variables: Vec<Parameter>,
    pub assertion: InvariantAssertion,
    pub span: Span,
}

/// How an assertion ranges over its record bindings.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum InvariantQuantifier {
    /// Every binding must satisfy the assertion.
    #[default]
    All,
    /// At least one binding must satisfy the assertion.
    Some,
}

#[derive(Clone, Debug)]
pub struct TraceDecl {
    pub name: Spanned<Name>,
    pub variable: Parameter,
    pub initial: Expr,
    pub always: Vec<Expr>,
    pub terminal: Option<Expr>,
    pub no_dead_ends: bool,
    pub within: Spanned<usize>,
    pub span: Span,
}

#[derive(Clone, Debug)]
pub enum InvariantAssertion {
    Cardinality {
        cardinality: Cardinality,
        decision: Spanned<Name>,
        arguments: Vec<Expr>,
        span: Span,
    },
    Implication {
        condition: Expr,
        expectation: Expectation,
        span: Span,
    },
}

#[derive(Clone, Debug)]
pub struct Expr {
    pub kind: ExprKind,
    pub span: Span,
}

impl Expr {
    #[must_use]
    pub const fn new(kind: ExprKind, span: Span) -> Self {
        Self { kind, span }
    }
}

#[derive(Clone, Debug)]
pub enum ExprKind {
    Literal(Literal),
    Name(Name),
    Field {
        receiver: Box<Expr>,
        field: Spanned<Name>,
    },
    Call {
        callee: Spanned<Name>,
        arguments: Vec<Expr>,
    },
    Unary {
        operator: UnaryOp,
        operand: Box<Expr>,
    },
    Binary {
        left: Box<Expr>,
        operator: BinaryOp,
        right: Box<Expr>,
    },
}

#[derive(Clone, Debug)]
pub enum Literal {
    Bool(bool),
    Number(NumericLiteral),
    String(String),
    Unknown,
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub enum NumericLiteral {
    Int(i64),
    Decimal(String),
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum UnaryOp {
    Not,
    Negate,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum BinaryOp {
    Or,
    And,
    Equal,
    NotEqual,
    Greater,
    GreaterEqual,
    Less,
    LessEqual,
    Add,
    Subtract,
    Multiply,
    Divide,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum CompareOp {
    Equal,
    NotEqual,
}