cvc5-rs 0.3.1

High-level Rust bindings for the cvc5 SMT solver
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

use cvc5_sys::*;
use std::fmt;

use crate::Term;

/// A cvc5 grammar for syntax-guided synthesis (SyGuS).
///
/// Grammars constrain the space of candidate solutions in synthesis queries.
pub struct Grammar {
    pub(crate) inner: Cvc5Grammar,
}

impl Clone for Grammar {
    fn clone(&self) -> Self {
        Self {
            inner: unsafe { cvc5_grammar_copy(self.inner) },
        }
    }
}

impl Drop for Grammar {
    fn drop(&mut self) {
        unsafe { cvc5_grammar_release(self.inner) }
    }
}

impl Grammar {
    pub(crate) fn from_raw(raw: Cvc5Grammar) -> Self {
        Self { inner: raw }
    }

    /// Create a copy of this grammar (increments the internal reference count).
    pub fn copy(&self) -> Grammar {
        Grammar::from_raw(unsafe { cvc5_grammar_copy(self.inner) })
    }

    /// Check disequality with another grammar.
    pub fn is_disequal(&self, other: &Grammar) -> bool {
        unsafe { cvc5_grammar_is_disequal(self.inner, other.inner) }
    }

    /// Add a rule to the given non-terminal symbol.
    pub fn add_rule(&mut self, symbol: Term, rule: Term) {
        unsafe { cvc5_grammar_add_rule(self.inner, symbol.inner, rule.inner) }
    }

    /// Add rules to the given non-terminal symbol.
    pub fn add_rules(&mut self, symbol: Term, rules: &[Term]) {
        let raw: Vec<Cvc5Term> = rules.iter().map(|t| t.inner).collect();
        unsafe { cvc5_grammar_add_rules(self.inner, symbol.inner, raw.len(), raw.as_ptr()) }
    }

    /// Allow the symbol to be an arbitrary constant.
    pub fn add_any_constant(&mut self, symbol: Term) {
        unsafe { cvc5_grammar_add_any_constant(self.inner, symbol.inner) }
    }

    /// Allow the symbol to be any input variable.
    pub fn add_any_variable(&mut self, symbol: Term) {
        unsafe { cvc5_grammar_add_any_variable(self.inner, symbol.inner) }
    }
}

impl fmt::Display for Grammar {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let s = unsafe { cvc5_grammar_to_string(self.inner) };
        let cs = unsafe { std::ffi::CStr::from_ptr(s) };
        write!(f, "{}", cs.to_string_lossy())
    }
}

impl PartialEq for Grammar {
    fn eq(&self, other: &Self) -> bool {
        unsafe { cvc5_grammar_is_equal(self.inner, other.inner) }
    }
}

impl Eq for Grammar {}

impl std::hash::Hash for Grammar {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        unsafe { cvc5_grammar_hash(self.inner) }.hash(state);
    }
}

impl fmt::Debug for Grammar {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Grammar({self})")
    }
}