typst-eval 0.15.0

Typst's code interpreter.
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

use typst_library::diag::{At, SourceResult, warning};
use typst_library::foundations::{
    Element, Func, Recipe, Selector, ShowableSelector, StyleChain, Styles, Transformation,
};
use typst_library::layout::{BlockElem, PageElem};
use typst_library::model::ParElem;
use typst_syntax::ast::{self, AstNode};

use crate::{Eval, Vm, hint_if_shadowed_std};

impl Eval for ast::SetRule<'_> {
    type Output = Styles;

    fn eval(self, vm: &mut Vm) -> SourceResult<Self::Output> {
        if let Some(condition) = self.condition()
            && !condition.eval(vm)?.cast::<bool>().at(condition.span())?
        {
            return Ok(Styles::new());
        }

        let target_expr = self.target();
        let target = target_expr
            .eval(vm)?
            .cast::<Func>()
            .map_err(|err| hint_if_shadowed_std(vm, &target_expr, err))
            .and_then(|func| {
                func.to_element().ok_or_else(|| {
                    "only element functions can be used in set rules".into()
                })
            })
            .at(target_expr.span())?;
        let args = self.args().eval(vm)?.spanned(self.span());
        Ok(target.set(&mut vm.engine, args)?.spanned(self.span()).liftable())
    }
}

impl Eval for ast::ShowRule<'_> {
    type Output = Recipe;

    fn eval(self, vm: &mut Vm) -> SourceResult<Self::Output> {
        let selector = self
            .selector()
            .map(|sel| {
                sel.eval(vm)?
                    .cast::<ShowableSelector>()
                    .map_err(|err| hint_if_shadowed_std(vm, &sel, err))
                    .at(sel.span())
            })
            .transpose()?
            .map(|selector| selector.0);

        let transform = self.transform();
        let transform = match transform {
            ast::Expr::SetRule(set) => Transformation::Style(set.eval(vm)?),
            expr => expr.eval(vm)?.cast::<Transformation>().at(transform.span())?,
        };

        let recipe = Recipe::new(selector, transform, self.span());
        check_show_page_rule(vm, &recipe);
        check_show_par_set_block(vm, &recipe);

        Ok(recipe)
    }
}

/// Warns that `show page` rules currently have no effect.
fn check_show_page_rule(vm: &mut Vm, recipe: &Recipe) {
    if let Some(Selector::Elem(elem, _)) = recipe.selector()
        && *elem == Element::of::<PageElem>()
    {
        vm.engine.sink.warn(warning!(
            recipe.span(),
            "`show page` is not supported and has no effect";
            hint: "customize pages with `set page(..)` instead";
        ));
    }
}

/// Migration hint for `show par: set block(spacing: ..)`.
fn check_show_par_set_block(vm: &mut Vm, recipe: &Recipe) {
    if let Some(Selector::Elem(elem, _)) = recipe.selector()
        && *elem == Element::of::<ParElem>()
        && let Transformation::Style(styles) = recipe.transform()
        && let styles = StyleChain::new(styles)
        && (styles.has(BlockElem::above) || styles.has(BlockElem::below))
    {
        vm.engine.sink.warn(warning!(
            recipe.span(),
            "`show par: set block(spacing: ..)` has no effect anymore";
            hint: "write `set par(spacing: ..)` instead";
            hint: "this is specific to paragraphs as they are not considered blocks \
                   anymore";
        ))
    }
}