mdqy 0.1.4

jq for markdown: query and transform Markdown with a hybrid selector and jq DSL
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

use std::sync::Arc;

/// `==`, `!=`, `<`, `<=`, `>`, `>=`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CmpOp {
    Eq,
    Ne,
    Lt,
    Le,
    Gt,
    Ge,
}

/// Arithmetic, boolean, and jq's `//` default.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum BinOp {
    Add,
    Sub,
    Mul,
    Div,
    Mod,
    And,
    Or,
    Alt,
}

/// `=` and `|=`. Parser accepts both; the mutator only implements
/// `|=` today and errors on `=`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum AssignOp {
    Set,
    Update,
}

#[derive(Debug, Clone)]
pub enum Literal {
    Null,
    Bool(bool),
    Number(f64),
    String(Arc<str>),
}

/// Compiled expression.
///
/// Boxed children keep the enum a small fixed size. Every runtime
/// walker matches this shape, so the variant set is the authoritative
/// grammar.
#[derive(Debug, Clone)]
pub enum Expr {
    Identity,
    RecurseAll,
    Field(Arc<str>),
    Index(Box<Expr>),
    Slice(Option<Box<Expr>>, Option<Box<Expr>>),
    Iterate,
    Pipe(Box<Expr>, Box<Expr>),
    Comma(Box<Expr>, Box<Expr>),
    Lit(Literal),
    ArrayCtor(Box<Expr>),
    ObjectCtor(Vec<(ObjKey, Expr)>),
    Cmp(Box<Expr>, CmpOp, Box<Expr>),
    Bin(Box<Expr>, BinOp, Box<Expr>),
    Neg(Box<Expr>),
    Not(Box<Expr>),
    If {
        branches: Vec<(Expr, Expr)>,
        else_branch: Option<Box<Expr>>,
    },
    Var(Arc<str>),
    Call {
        name: Arc<str>,
        args: Vec<Expr>,
    },
    Try(Box<Expr>),
    Assign(Box<Expr>, AssignOp, Box<Expr>),
    /// `expr as $x | rest`. Binds each output of `expr` to `$x`
    /// inside `rest`.
    As {
        bind: Box<Expr>,
        name: Arc<str>,
        body: Box<Expr>,
    },
    /// `reduce SRC as $x (INIT; UPDATE)`. Folds `SRC` into one value,
    /// starting at `INIT` and replacing the accumulator with each
    /// `UPDATE` output.
    Reduce {
        source: Box<Expr>,
        var: Arc<str>,
        init: Box<Expr>,
        update: Box<Expr>,
    },
    /// `foreach SRC as $x (INIT; UPDATE; EXTRACT)`. Same fold as
    /// `Reduce`, but yields `EXTRACT(acc)` at every step instead of
    /// only the final accumulator.
    Foreach {
        source: Box<Expr>,
        var: Arc<str>,
        init: Box<Expr>,
        update: Box<Expr>,
        extract: Box<Expr>,
    },
    /// `def name(params): body;`. User-defined function. Each `param`
    /// is available inside `body` as a filter bound to the
    /// corresponding call-site argument.
    Def {
        name: Arc<str>,
        params: Vec<Arc<str>>,
        body: Box<Expr>,
        rest: Box<Expr>,
    },
}

/// Key of an object-ctor entry.
#[derive(Debug, Clone)]
pub enum ObjKey {
    Ident(Arc<str>),
    Str(Arc<str>),
    Expr(Expr),
}