gccjit 6.1.0

Higher-level Rust bindings for libgccjit.
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

use std::fmt;
use std::marker::PhantomData;
use std::ptr::{self, NonNull};

use context::Context;
use field;
use field::Field;
use location;
use location::Location;
use object::{Object, ToObject};
use types;
use types::Type;

use crate::{
    expect_handle_without_context, with_lib, with_lib_handle, with_lib_without_error_check,
};

/// A Struct is gccjit's representation of a composite type. Despite the name,
/// Struct can represent either a struct, an union, or an opaque named type.
#[derive(Copy, Clone, Eq, Hash, PartialEq)]
pub struct Struct<'ctx> {
    marker: PhantomData<&'ctx Context<'ctx>>,
    ptr: NonNull<gccjit_sys::gcc_jit_struct>,
}

impl<'ctx> Struct<'ctx> {
    #[track_caller]
    pub fn as_type(&self) -> Type<'ctx> {
        let handle = with_lib_without_error_check(|lib| unsafe {
            let ptr = lib.gcc_jit_struct_as_type(get_ptr(self));
            types::from_ptr(ptr)
        });
        // `Struct`'s context is reached *through* `as_type`, so querying it here
        // would recurse; `gcc_jit_struct_as_type` cannot fail anyway.
        expect_handle_without_context(handle, "gcc_jit_struct_as_type")
    }

    pub fn set_fields(&self, location: Option<Location<'ctx>>, fields: &[Field<'ctx>]) {
        let loc_ptr = match location {
            Some(loc) => unsafe { location::get_ptr(&loc) },
            None => ptr::null_mut(),
        };
        let num_fields = fields.len() as i32;
        with_lib(self, |lib| {
            let mut fields_ptrs: Vec<_> = fields
                .iter()
                .map(|x| unsafe { field::get_ptr(x) })
                .collect();
            unsafe {
                lib.gcc_jit_struct_set_fields(
                    get_ptr(self),
                    loc_ptr,
                    num_fields,
                    fields_ptrs.as_mut_ptr(),
                );
            }
        });
    }

    #[track_caller]
    pub fn get_field(&self, index: i32) -> Field<'ctx> {
        with_lib_handle(self, |lib| unsafe {
            let ptr = lib.gcc_jit_struct_get_field(get_ptr(self), index);
            field::from_ptr(ptr)
        })
    }

    pub fn get_field_count(&self) -> usize {
        with_lib(self, |lib| unsafe {
            lib.gcc_jit_struct_get_field_count(get_ptr(self)) as usize
        })
    }
}

impl<'ctx> ToObject<'ctx> for Struct<'ctx> {
    fn to_object(&self) -> Object<'ctx> {
        let ty = self.as_type();
        ty.to_object()
    }
}

impl<'ctx> crate::ContextGetter<'ctx> for Struct<'ctx> {
    fn context(&self) -> crate::ContextRef<'ctx> {
        self.to_object().context()
    }
}

impl<'ctx> fmt::Debug for Struct<'ctx> {
    fn fmt<'a>(&self, fmt: &mut fmt::Formatter<'a>) -> Result<(), fmt::Error> {
        let obj = self.as_type();
        obj.fmt(fmt)
    }
}

pub unsafe fn from_ptr<'ctx>(ptr: *mut gccjit_sys::gcc_jit_struct) -> Option<Struct<'ctx>> {
    Some(Struct {
        marker: PhantomData,
        ptr: NonNull::new(ptr)?,
    })
}

pub unsafe fn get_ptr<'ctx>(s: &Struct<'ctx>) -> *mut gccjit_sys::gcc_jit_struct {
    s.ptr.as_ptr()
}