lumen-engine 0.2.1

Core composition model and rendering orchestration for Lumen.
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
use std::sync::{Mutex, OnceLock};

use crate::{
    error::{ExpressionError, LumenError},
    expr::{
        ExpressionContext,
        ast::{BuiltinFn, ExprNode, ExpressionValue},
        eval::evaluate_expr,
    },
    node::{NodeId, NodeKind, PropertyValue},
};

pub fn evaluate_builtin(
    builtin: BuiltinFn,
    args: &[ExpressionValue],
    ctx: &ExpressionContext<'_>,
) -> crate::Result<ExpressionValue> {
    let error = |details: String| {
        LumenError::Expression(ExpressionError::Evaluate {
            path: ctx.path.clone(),
            details,
        })
    };
    let expect_len = |expected: usize| {
        if args.len() == expected {
            Ok(())
        } else {
            Err(error(format!(
                "builtin expects {expected} arguments, got {}",
                args.len()
            )))
        }
    };
    let expect_min_len = |minimum: usize| {
        if args.len() >= minimum {
            Ok(())
        } else {
            Err(error(format!(
                "builtin expects at least {minimum} arguments, got {}",
                args.len()
            )))
        }
    };

    match builtin {
        BuiltinFn::Min => {
            expect_min_len(2)?;
            let mut value =
                to_number(&args[0], error("min expects numeric arguments".to_string()))?;
            for arg in &args[1..] {
                value = value.min(to_number(
                    arg,
                    error("min expects numeric arguments".to_string()),
                )?);
            }
            Ok(ExpressionValue::Number(value))
        }
        BuiltinFn::Max => {
            expect_min_len(2)?;
            let mut value =
                to_number(&args[0], error("max expects numeric arguments".to_string()))?;
            for arg in &args[1..] {
                value = value.max(to_number(
                    arg,
                    error("max expects numeric arguments".to_string()),
                )?);
            }
            Ok(ExpressionValue::Number(value))
        }
        BuiltinFn::Abs => unary_numeric(args, &expect_len, |value| value.abs()),
        BuiltinFn::Floor => unary_numeric(args, &expect_len, |value| value.floor()),
        BuiltinFn::Ceil => unary_numeric(args, &expect_len, |value| value.ceil()),
        BuiltinFn::Round => unary_numeric(args, &expect_len, |value| value.round()),
        BuiltinFn::Sin => unary_numeric(args, &expect_len, |value| value.sin()),
        BuiltinFn::Cos => unary_numeric(args, &expect_len, |value| value.cos()),
        BuiltinFn::Fract => unary_numeric(args, &expect_len, |value| value.fract()),
        BuiltinFn::Clamp => {
            expect_len(3)?;
            let value = to_number(
                &args[0],
                error("clamp expects numeric arguments".to_string()),
            )?;
            let min = to_number(
                &args[1],
                error("clamp expects numeric arguments".to_string()),
            )?;
            let max = to_number(
                &args[2],
                error("clamp expects numeric arguments".to_string()),
            )?;
            if min > max {
                return Err(error("clamp requires min <= max".to_string()));
            }
            Ok(ExpressionValue::Number(value.clamp(min, max)))
        }
        BuiltinFn::Lerp => interpolate_linear(args, &expect_len, &error, "lerp"),
        BuiltinFn::Pow => {
            expect_len(2)?;
            let lhs = to_number(&args[0], error("pow expects numeric arguments".to_string()))?;
            let rhs = to_number(&args[1], error("pow expects numeric arguments".to_string()))?;
            Ok(ExpressionValue::Number(lhs.powf(rhs)))
        }
        BuiltinFn::Mod => {
            expect_len(2)?;
            let lhs = to_number(&args[0], error("mod expects numeric arguments".to_string()))?;
            let rhs = to_number(&args[1], error("mod expects numeric arguments".to_string()))?;
            if rhs.abs() <= f64::EPSILON {
                return Err(error("mod divisor must be non-zero".to_string()));
            }
            Ok(ExpressionValue::Number(lhs % rhs))
        }
        BuiltinFn::Smoothstep => {
            expect_len(3)?;
            let edge0 = to_number(
                &args[0],
                error("smoothstep expects numeric arguments".to_string()),
            )?;
            let edge1 = to_number(
                &args[1],
                error("smoothstep expects numeric arguments".to_string()),
            )?;
            let x = to_number(
                &args[2],
                error("smoothstep expects numeric arguments".to_string()),
            )?;
            if (edge1 - edge0).abs() <= f64::EPSILON {
                return Ok(ExpressionValue::Number(0.0));
            }
            let t = ((x - edge0) / (edge1 - edge0)).clamp(0.0, 1.0);
            Ok(ExpressionValue::Number(t * t * (3.0 - 2.0 * t)))
        }
        BuiltinFn::Linear => interpolate_linear(args, &expect_len, &error, "linear"),
        BuiltinFn::Step => {
            expect_len(3)?;
            let start = to_number(
                &args[0],
                error("step expects numeric arguments".to_string()),
            )?;
            let end = to_number(
                &args[1],
                error("step expects numeric arguments".to_string()),
            )?;
            let t = to_number(
                &args[2],
                error("step expects numeric arguments".to_string()),
            )?;
            Ok(ExpressionValue::Number(if t >= 1.0 { end } else { start }))
        }
        BuiltinFn::TextHeight => Err(error(
            "text_height node references should be evaluated before calling this helper"
                .to_string(),
        )),
        BuiltinFn::TextWidth => Err(error(
            "text_width node references should be evaluated before calling this helper".to_string(),
        )),
        BuiltinFn::Uppercase => {
            expect_len(1)?;
            let input = to_string(
                &args[0],
                error("uppercase expects a string argument".to_string()),
            )?;
            Ok(ExpressionValue::String(input.to_uppercase()))
        }
        BuiltinFn::Lowercase => {
            expect_len(1)?;
            let input = to_string(
                &args[0],
                error("lowercase expects a string argument".to_string()),
            )?;
            Ok(ExpressionValue::String(input.to_lowercase()))
        }
    }
}

fn interpolate_linear(
    args: &[ExpressionValue],
    expect_len: &dyn Fn(usize) -> crate::Result<()>,
    error: &dyn Fn(String) -> LumenError,
    builtin_name: &'static str,
) -> crate::Result<ExpressionValue> {
    expect_len(3)?;
    let start = to_number(
        &args[0],
        error(format!("{builtin_name} expects numeric arguments")),
    )?;
    let end = to_number(
        &args[1],
        error(format!("{builtin_name} expects numeric arguments")),
    )?;
    let t = to_number(
        &args[2],
        error(format!("{builtin_name} expects numeric arguments")),
    )?;
    Ok(ExpressionValue::Number(start + (end - start) * t))
}

fn unary_numeric(
    args: &[ExpressionValue],
    expect_len: &dyn Fn(usize) -> crate::Result<()>,
    f: impl Fn(f64) -> f64,
) -> crate::Result<ExpressionValue> {
    expect_len(1)?;
    let value = to_number(
        &args[0],
        LumenError::Expression(ExpressionError::Evaluate {
            path: None,
            details: "builtin expects numeric argument".to_string(),
        }),
    )?;
    Ok(ExpressionValue::Number(f(value)))
}

fn to_number(value: &ExpressionValue, error: LumenError) -> crate::Result<f64> {
    match value {
        ExpressionValue::Number(number) => Ok(*number),
        ExpressionValue::Boolean(boolean) => Ok(if *boolean { 1.0 } else { 0.0 }),
        ExpressionValue::String(text) => text.parse::<f64>().map_err(|_| error),
    }
}

fn to_string(value: &ExpressionValue, _error: LumenError) -> crate::Result<String> {
    match value {
        ExpressionValue::String(text) => Ok(text.clone()),
        ExpressionValue::Number(number) => Ok(number.to_string()),
        ExpressionValue::Boolean(boolean) => Ok(boolean.to_string()),
    }
}

pub fn evaluate_text_measure_builtin(
    builtin: BuiltinFn,
    args: &[ExprNode],
    ctx: &ExpressionContext<'_>,
) -> crate::Result<ExpressionValue> {
    let builtin_name = match builtin {
        BuiltinFn::TextHeight => "text_height",
        BuiltinFn::TextWidth => "text_width",
        _ => unreachable!(),
    };
    if args.is_empty() || args.len() > 4 {
        return Err(text_measure_error(
            ctx,
            format!("{builtin_name} expects 1 to 4 arguments"),
        ));
    }

    if let Some(ExprNode::Node(node_id)) = args.first() {
        if args.len() != 1 {
            return Err(text_measure_error(
                ctx,
                format!("{builtin_name}(node(id)) does not accept override arguments"),
            ));
        }
        let measurement = measure_text_node(*node_id, ctx)?;
        return Ok(ExpressionValue::Number(match builtin {
            BuiltinFn::TextHeight => f64::from(measurement.height),
            BuiltinFn::TextWidth => f64::from(measurement.width),
            _ => unreachable!(),
        }));
    }

    let text = args
        .first()
        .map(|arg| {
            to_string(
                &evaluate_expr(arg, ctx)?,
                text_measure_error(ctx, format!("{builtin_name} expects a string argument")),
            )
        })
        .transpose()?
        .unwrap_or_default();
    let font_size = args
        .get(1)
        .map(|arg| {
            to_number(
                &evaluate_expr(arg, ctx)?,
                text_measure_error(
                    ctx,
                    format!("{builtin_name} optional second arg must be numeric font size"),
                ),
            )
        })
        .transpose()?
        .unwrap_or(16.0);
    let max_width = args
        .get(2)
        .map(|arg| {
            to_number(
                &evaluate_expr(arg, ctx)?,
                text_measure_error(
                    ctx,
                    format!("{builtin_name} optional third arg must be numeric max width"),
                ),
            )
        })
        .transpose()?
        .unwrap_or(0.0);
    let font_family = args
        .get(3)
        .map(|arg| {
            to_string(
                &evaluate_expr(arg, ctx)?,
                text_measure_error(
                    ctx,
                    format!("{builtin_name} optional fourth arg must be a font family string"),
                ),
            )
        })
        .transpose()?
        .unwrap_or_else(|| "sans-serif".to_string());
    let measurement = measure_text_value(&text, &font_family, font_size as f32, max_width as f32)?;
    Ok(ExpressionValue::Number(match builtin {
        BuiltinFn::TextHeight => f64::from(measurement.height),
        BuiltinFn::TextWidth => f64::from(measurement.width),
        _ => unreachable!(),
    }))
}

fn measure_text_node(
    node_id: NodeId,
    ctx: &ExpressionContext<'_>,
) -> crate::Result<lumen_text::TextMeasurement> {
    let graph = ctx.graph.ok_or_else(|| {
        text_measure_error(
            ctx,
            format!("no graph available to resolve text node `{}`", node_id.0),
        )
    })?;
    let node = graph
        .nodes
        .get(&node_id)
        .ok_or_else(|| text_measure_error(ctx, format!("text node `{}` not found", node_id.0)))?;
    let NodeKind::Text(text) = node else {
        return Err(text_measure_error(
            ctx,
            format!("node `{}` is not a text node", node_id.0),
        ));
    };

    let content = resolve_string(
        node_id,
        "content",
        &text.params.content.to_property_value(),
        ctx,
    )?;
    let font_family = resolve_string(
        node_id,
        "font_family",
        &text.params.font_family.to_property_value(),
        ctx,
    )?;
    let font_size = resolve_number(
        node_id,
        "font_size",
        &text.params.font_size.to_property_value(),
        ctx,
    )? as f32;
    let max_width = resolve_number(
        node_id,
        "max_width",
        &text.params.max_width.to_property_value(),
        ctx,
    )? as f32;
    measure_text_value(&content, &font_family, font_size, max_width)
}

fn measure_text_value(
    content: &str,
    font_family: &str,
    font_size: f32,
    max_width: f32,
) -> crate::Result<lumen_text::TextMeasurement> {
    static TEXT_SYSTEM: OnceLock<Mutex<lumen_text::TextSystem>> = OnceLock::new();
    let mut text_system = TEXT_SYSTEM
        .get_or_init(|| Mutex::new(lumen_text::TextSystem::new()))
        .lock()
        .map_err(|_| {
            LumenError::Expression(ExpressionError::Evaluate {
                path: None,
                details: "text system lock was poisoned".to_string(),
            })
        })?;
    let mut request = lumen_text::TextLayoutRequest::new(content);
    request.font_family = font_family.to_string();
    request.font_size = font_size;
    request.max_width = (max_width > 0.0).then_some(max_width);
    Ok(text_system.measure(&request))
}

fn resolve_string(
    node_id: NodeId,
    property: &str,
    value: &PropertyValue,
    ctx: &ExpressionContext<'_>,
) -> crate::Result<String> {
    match value {
        PropertyValue::String(text) => Ok(text.clone()),
        _ => Err(text_measure_error(
            ctx,
            format!(
                "text node `{}` property `{property}` must be a string",
                node_id.0
            ),
        )),
    }
}

fn resolve_number(
    node_id: NodeId,
    property: &str,
    value: &PropertyValue,
    ctx: &ExpressionContext<'_>,
) -> crate::Result<f64> {
    match value {
        PropertyValue::Float(number) => Ok(*number),
        PropertyValue::Int(number) => Ok(*number as f64),
        _ => Err(text_measure_error(
            ctx,
            format!(
                "text node `{}` property `{property}` must be numeric",
                node_id.0
            ),
        )),
    }
}

fn text_measure_error(ctx: &ExpressionContext<'_>, details: String) -> LumenError {
    LumenError::Expression(ExpressionError::Evaluate {
        path: ctx.path.clone(),
        details,
    })
}