1
use conjure_cp::{
2
    ast::Metadata,
3
    ast::{
4
        Atom, DeclarationKind, Expression, Literal, Moo, Name, ReturnType, SymbolTable, Typeable,
5
    },
6
    into_matrix_expr, matrix_expr,
7
    rule_engine::{
8
        ApplicationError::{self, RuleNotApplicable},
9
        ApplicationResult, Reduction, register_rule, register_rule_set,
10
    },
11
};
12
use uniplate::{Biplate, Uniplate};
13

            
14
use super::utils::is_all_constant;
15

            
16
register_rule_set!("Bubble", ("Base"));
17

            
18
// Bubble reduction rules
19

            
20
/*
21
    Reduce bubbles with a boolean expression to a conjunction with their condition.
22

            
23
    e.g. (a / b = c) @ (b != 0) => (a / b = c) & (b != 0)
24
*/
25
#[register_rule(("Bubble", 8900))]
26
fn expand_bubble(expr: &Expression, _: &SymbolTable) -> ApplicationResult {
27
    match expr {
28
        Expression::Bubble(_, a, b) if a.return_type() == ReturnType::Bool => {
29
            let a = Moo::unwrap_or_clone(Moo::clone(a));
30
            let b = Moo::unwrap_or_clone(Moo::clone(b));
31
            Ok(Reduction::pure(Expression::And(
32
                Metadata::new(),
33
                Moo::new(matrix_expr![a, b]),
34
            )))
35
        }
36
        _ => Err(ApplicationError::RuleNotApplicable),
37
    }
38
}
39

            
40
/*
41
    Bring bubbles with a non-boolean expression higher up the tree.
42

            
43
    E.g. ((a / b) @ (b != 0)) = c => (a / b = c) @ (b != 0)
44
*/
45
#[register_rule(("Bubble", 8800))]
46
fn bubble_up(expr: &Expression, syms: &SymbolTable) -> ApplicationResult {
47
    // do not put root inside a bubble
48
    //
49
    // also do not bubble bubbles inside bubbles, as this does nothing productive it just shuffles
50
    // the conditions around, shuffles them back, then gets stuck in a loop doing this ad infinitum
51
    if matches!(expr, Expression::Root(_, _) | Expression::Bubble(_, _, _)) {
52
        return Err(RuleNotApplicable);
53
    }
54

            
55
    // do not bubble things containing lettings
56
    if expr.universe_bi().iter().any(|x: &Name| {
57
        syms.lookup(x).is_some_and(|x| {
58
            matches!(
59
                &x.kind() as &DeclarationKind,
60
                DeclarationKind::ValueLetting(_)
61
            )
62
        })
63
    }) {
64
        return Err(RuleNotApplicable);
65
    };
66

            
67
    let mut sub = expr.children();
68
    let mut bubbled_conditions = vec![];
69
    for e in sub.iter_mut() {
70
        if let Expression::Bubble(_, a, b) = e
71
            && a.return_type() != ReturnType::Bool
72
        {
73
            let a = Moo::unwrap_or_clone(Moo::clone(a));
74
            let b = Moo::unwrap_or_clone(Moo::clone(b));
75
            bubbled_conditions.push(b);
76
            *e = a;
77
        }
78
    }
79
    if bubbled_conditions.is_empty() {
80
        Err(ApplicationError::RuleNotApplicable)
81
    } else if bubbled_conditions.len() == 1 {
82
        let new_expr = Expression::Bubble(
83
            Metadata::new(),
84
            Moo::new(expr.with_children(sub)),
85
            Moo::new(bubbled_conditions[0].clone()),
86
        );
87

            
88
        Ok(Reduction::pure(new_expr))
89
    } else {
90
        Ok(Reduction::pure(Expression::Bubble(
91
            Metadata::new(),
92
            Moo::new(expr.with_children(sub)),
93
            Moo::new(Expression::And(
94
                Metadata::new(),
95
                Moo::new(into_matrix_expr![bubbled_conditions]),
96
            )),
97
        )))
98
    }
99
}
100

            
101
// Bubble applications
102

            
103
/// Converts an unsafe division to a safe division with a bubble condition.
104
///
105
/// ```text
106
///     a / b => (a / b) @ (b != 0)
107
/// ```
108
///
109
/// Division by zero is undefined and therefore not allowed, so we add a condition to check for it.
110
/// This condition is brought up the tree and expanded into a conjunction with the first
111
/// boolean-type expression it is paired with.
112

            
113
#[register_rule(("Bubble", 6000))]
114
fn div_to_bubble(expr: &Expression, _: &SymbolTable) -> ApplicationResult {
115
    if is_all_constant(expr) {
116
        return Err(RuleNotApplicable);
117
    }
118
    if let Expression::UnsafeDiv(_, a, b) = expr {
119
        // bubble bottom up
120
        if !a.is_safe() || !b.is_safe() {
121
            return Err(RuleNotApplicable);
122
        }
123

            
124
        return Ok(Reduction::pure(Expression::Bubble(
125
            Metadata::new(),
126
            Moo::new(Expression::SafeDiv(Metadata::new(), a.clone(), b.clone())),
127
            Moo::new(Expression::Neq(
128
                Metadata::new(),
129
                b.clone(),
130
                Moo::new(Expression::from(0)),
131
            )),
132
        )));
133
    }
134
    Err(ApplicationError::RuleNotApplicable)
135
}
136

            
137
/// Converts an unsafe mod to a safe mod with a bubble condition.
138
///
139
/// ```text
140
/// a % b => (a % b) @ (b != 0)
141
/// ```
142
///
143
/// Mod zero is undefined and therefore not allowed, so we add a condition to check for it.
144
/// This condition is brought up the tree and expanded into a conjunction with the first
145
/// boolean-type expression it is paired with.
146
///
147
#[register_rule(("Bubble", 6000))]
148
fn mod_to_bubble(expr: &Expression, _: &SymbolTable) -> ApplicationResult {
149
    if is_all_constant(expr) {
150
        return Err(RuleNotApplicable);
151
    }
152
    if let Expression::UnsafeMod(_, a, b) = expr {
153
        // bubble bottom up
154
        if !a.is_safe() || !b.is_safe() {
155
            return Err(RuleNotApplicable);
156
        }
157

            
158
        return Ok(Reduction::pure(Expression::Bubble(
159
            Metadata::new(),
160
            Moo::new(Expression::SafeMod(Metadata::new(), a.clone(), b.clone())),
161
            Moo::new(Expression::Neq(
162
                Metadata::new(),
163
                b.clone(),
164
                Moo::new(Expression::from(0)),
165
            )),
166
        )));
167
    }
168
    Err(ApplicationError::RuleNotApplicable)
169
}
170

            
171
/// Converts an unsafe pow to a safe pow with a bubble condition.
172
///
173
/// ```text
174
/// a**b => (a ** b) @ ((a!=0 \/ b!=0) /\ b>=0
175
/// ```
176
///
177
/// Pow is only defined when `(a!=0 \/ b!=0) /\ b>=0`, so we add a condition to check for it.
178
/// This condition is brought up the tree and expanded into a conjunction with the first
179
/// boolean-type expression it is paired with.
180
///
181
#[register_rule(("Bubble", 6000))]
182
fn pow_to_bubble(expr: &Expression, _: &SymbolTable) -> ApplicationResult {
183
    if is_all_constant(expr) {
184
        return Err(RuleNotApplicable);
185
    }
186
    if let Expression::UnsafePow(_, a, b) = expr.clone() {
187
        // bubble bottom up
188
        if !a.is_safe() || !b.is_safe() {
189
            return Err(RuleNotApplicable);
190
        }
191

            
192
        return Ok(Reduction::pure(Expression::Bubble(
193
            Metadata::new(),
194
            Moo::new(Expression::SafePow(Metadata::new(), a.clone(), b.clone())),
195
            Moo::new(Expression::And(
196
                Metadata::new(),
197
                Moo::new(matrix_expr![
198
                    Expression::Or(
199
                        Metadata::new(),
200
                        Moo::new(matrix_expr![
201
                            Expression::Neq(
202
                                Metadata::new(),
203
                                a,
204
                                Moo::new(Atom::Literal(Literal::Int(0)).into()),
205
                            ),
206
                            Expression::Neq(
207
                                Metadata::new(),
208
                                b.clone(),
209
                                Moo::new(Atom::Literal(Literal::Int(0)).into()),
210
                            ),
211
                        ]),
212
                    ),
213
                    Expression::Geq(
214
                        Metadata::new(),
215
                        b,
216
                        Moo::new(Atom::Literal(Literal::Int(0)).into()),
217
                    ),
218
                ]),
219
            )),
220
        )));
221
    }
222
    Err(ApplicationError::RuleNotApplicable)
223
}