zhc_ir 0.1.8

Graph-based intermediate representation framework with dialect support
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

use std::hash::Hash;
use std::ops::Deref;

use zhc_utils::Dumpable;

use super::{Dialect, IR, State, ValId};
use crate::val_use::ValUse;
use crate::{Formatted, OpRef, ValOrigin, ValOriginRef, ValUseRef};
use zhc_utils::iter::Deduped;

/// Borrowed view of a value within an [`IR`].
///
/// Provides access to value metadata, type information, origin, and consumer
/// queries. The reference is tied to the lifetime of the [`IR`] it was
/// obtained from. Derefs to [`ValId`].
#[derive(Debug, Clone)]
pub struct ValRef<'ir, D: Dialect> {
    pub(super) id: ValId,
    pub(super) ir: &'ir IR<D>,
    pub(super) users: &'ir [ValUse],
    pub(super) origin: &'ir ValOrigin,
    pub(super) typ: &'ir D::TypeSystem,
    pub(super) state: &'ir State,
}

impl<'ir, D: Dialect> Hash for ValRef<'ir, D> {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.id.hash(state)
    }
}

impl<'ir, D: Dialect> PartialEq for ValRef<'ir, D> {
    fn eq(&self, other: &Self) -> bool {
        std::ptr::eq(self.ir, other.ir) && self.id == other.id
    }
}

impl<'ir, D: Dialect> Eq for ValRef<'ir, D> {}

impl<'ir, D: Dialect> Deref for ValRef<'ir, D> {
    type Target = ValId;

    fn deref(&self) -> &Self::Target {
        &self.id
    }
}

#[allow(unused)]
impl<'ir, D: Dialect> ValRef<'ir, D> {
    pub(super) fn raw_get_uses_iter(
        &self,
    ) -> impl Iterator<Item = ValUseRef<'ir, D>> + use<'ir, D> {
        self.users.iter().map(|uze| ValUseRef {
            opref: self.ir.raw_get_op(uze.opid),
            position: uze.position,
        })
    }

    pub(super) fn raw_get_origin(&self) -> ValOriginRef<'ir, D> {
        ValOriginRef {
            opref: self.ir.raw_get_op(self.origin.opid),
            position: self.origin.position,
        }
    }
}

impl<'ir, D: Dialect> ValRef<'ir, D> {
    /// Checks if the value is active.
    pub fn is_active(&self) -> bool {
        self.state.is_active()
    }

    /// Checks if the value is inactive.
    pub fn is_inactive(&self) -> bool {
        self.state.is_inactive()
    }

    /// Returns the unique identifier of the value.
    pub fn get_id(&self) -> ValId {
        self.id
    }

    /// Returns the type of the value according to the dialect's type system.
    pub fn get_type(&self) -> D::TypeSystem {
        self.typ.clone()
    }

    /// Returns the producing operation and return position for this value.
    ///
    /// # Panics
    ///
    /// Panics if the producing operation is inactive.
    pub fn get_origin(&self) -> ValOriginRef<'ir, D> {
        let output = self.raw_get_origin();
        assert!(output.opref.is_active());
        output
    }

    /// Returns an iterator over use-sites of this value with position information.
    ///
    /// Only use-sites from active operations are included.
    pub fn get_uses_iter(&self) -> impl Iterator<Item = ValUseRef<'ir, D>> + use<'ir, D> {
        self.raw_get_uses_iter().filter(|u| u.opref.is_active())
    }

    /// Returns an iterator over operations that use this value as an argument.
    ///
    /// Only active operations are included in the result, and operations are
    /// deduplicated even if they use this value multiple times.
    pub fn get_users_iter(&self) -> impl Iterator<Item = OpRef<'ir, D>> + use<'ir, D> {
        self.raw_get_uses_iter()
            .map(|uze| uze.opref)
            .filter(|u| u.is_active())
            .dedup()
    }

    /// Returns `true` if any active operations use this value as an argument.
    pub fn has_users(&self) -> bool {
        self.get_users_iter().next().is_some()
    }

    /// Creates a configurable formatter for this value.
    pub fn format(&self) -> Formatted<'_, Self> {
        Formatted::new(self)
    }
}

impl<D: Dialect> Dumpable for ValRef<'_, D> {
    fn dump_to_string(&self) -> String {
        self.format().dump_to_string()
    }
}