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

//! Intern support for Tydi.

use std::{
    fmt::{self, Debug, Display, Formatter},
    hash::{Hash, Hasher},
    marker::PhantomData,
};

/// Intern Id
///
/// Used as wrapper when referencing interned values.
///
/// # Examples
///
/// ```rust
/// use tydi_intern::Id;
///
/// mod ast {
///     use tydi_intern::Id;
///
///     #[derive(Clone, Debug, PartialEq, Eq, Hash)]
///     pub struct Root {
///         // Instead of storing the full data for items we use the `Id`
///         // wrapper
///         pub items: Vec<Id<Item>>,
///     }
///
///     #[derive(Clone, Debug, PartialEq, Eq, Hash)]
///     pub struct Item {
///         pub identifier: String,
///     }
/// }
///
/// #[salsa::query_group(InternStorage)]
/// pub trait Intern {
///     #[salsa::interned]
///     fn intern_item(&self, item: ast::Item) -> Id<ast::Item>;
/// }
/// ```
pub struct Id<T> {
    // The Salsa intern id field.
    id: salsa::InternId,
    // `fn(T) -> T` makes Id invariant over `T` i.e. Id gets an auto trait
    // implementation for `Send` + `Sync` without a `Send` + `Sync` bound on
    // `T`.
    // Reference: https://doc.rust-lang.org/nomicon/phantom-data.html#table-of-phantomdata-patterns
    _ty: PhantomData<fn(T) -> T>,
}

impl<T> Clone for Id<T> {
    fn clone(&self) -> Id<T> {
        Id {
            id: self.id,
            _ty: PhantomData,
        }
    }
}

impl<T> Copy for Id<T> {}

impl<T> Debug for Id<T> {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        Debug::fmt(&self.id, f)
    }
}

impl<T> Display for Id<T> {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        Display::fmt(&self.id, f)
    }
}

impl<T> Hash for Id<T> {
    fn hash<H: Hasher>(&self, state: &mut H) {
        self.id.hash(state);
    }
}

impl<T> PartialEq for Id<T> {
    fn eq(&self, other: &Self) -> bool {
        self.id == other.id
    }
}

impl<T> Eq for Id<T> {}

impl<T> salsa::InternKey for Id<T> {
    fn from_intern_id(id: salsa::InternId) -> Self {
        Self {
            id,
            _ty: PhantomData,
        }
    }
    fn as_intern_id(&self) -> salsa::InternId {
        self.id
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::mem::size_of;

    #[test]
    fn id_size() {
        struct Foo {
            _x: String,
        }
        assert_eq!(size_of::<Id<Foo>>(), size_of::<salsa::InternId>());
    }
}