hs-bindgen-traits 0.5.0

Utility traits behind hs-bindgen ergonomics
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

//! # `hs-bingen-traits`
//!
//! Utility traits behind [`hs-bindgen`](https://github.com/yvan-sraka/hs-bindgen)
//! ergonomics. It helps user to easily define wrapper function to derive a Rust
//! type from and into a C-FFI safe target type (that match the memory layout of
//! an Haskell type).

use proc_macro2::TokenStream;
use quote::quote;
use std::str::FromStr;

/// Enumeration of all Haskell F-FFI safe types as the string representation of
/// their token in Haskell.
pub enum HsType {
    CString,
    Empty,
    IO(Box<HsType>),
}

impl std::fmt::Display for HsType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{}",
            match self {
                HsType::CString => "CString".to_string(),
                HsType::Empty => "()".to_string(),
                HsType::IO(x) => format!("IO {}", x),
            }
        )
    }
}

impl FromStr for HsType {
    type Err = String; // FIXME: rather use thiserror

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.trim() {
            "CString" => Ok(HsType::CString),
            "()" => Ok(HsType::Empty),
            // FIXME: better parse HsType::IO ...
            "IO()" => Ok(HsType::IO(Box::new(HsType::Empty))),
            x => Err(format!(
                "type `{x}` isn't in the list of supported Haskell types
consider opening an issue https://github.com/yvan-sraka/hs-bindgen-traits"
            )),
        }
    }
}

impl HsType {
    /// Get the C-FFI Rust type that match the memory layout of a given HsType.
    ///
    /// This function return a `OUTPUT: proc_macro2::TokenStream` that should
    /// be valid (considered as FFI-safe by `rustc`) in the context of a block
    /// of form: `quote! { extern C fn _(_: #OUTPUT) {} }`
    pub fn quote(&self) -> TokenStream {
        match self {
            HsType::CString => quote! { *const std::os::raw::c_char },
            HsType::Empty => quote! { () },
            HsType::IO(x) => x.quote(),
        }
    }
}

/// Turn a given Rust type into his `HsType` target.
///
/// FIXME: derive this trait for most of `std` types!
pub trait ReprHs {
    fn into() -> HsType;
}

impl ReprHs for String {
    fn into() -> HsType {
        HsType::CString
    }
}

impl ReprHs for &str {
    fn into() -> HsType {
        HsType::CString
    }
}

impl ReprHs for () {
    fn into() -> HsType {
        HsType::Empty
    }
}

/// Generate C-FFI safe wrapper from a given Rust type.
pub trait ReprC<T> {
    fn from(_: T) -> Self;
}

impl ReprC<*const std::os::raw::c_char> for &str {
    #[allow(clippy::not_unsafe_ptr_arg_deref)]
    fn from(x: *const std::os::raw::c_char) -> Self {
        unsafe { std::ffi::CStr::from_ptr(x) }.to_str().unwrap()
    }
}

impl ReprC<*const std::os::raw::c_char> for String {
    fn from(x: *const std::os::raw::c_char) -> Self {
        let r: &str = ReprC::from(x);
        r.to_string()
    }
}