inkwell 0.9.0

Inkwell aims to help you pen your own programming languages by safely wrapping llvm-sys.
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

#[llvm_versions(..=16)]
use llvm_sys::core::LLVMConstSelect;
#[allow(deprecated)]
use llvm_sys::core::LLVMGetElementAsConstant;
use llvm_sys::core::{LLVMConstExtractElement, LLVMConstInsertElement, LLVMConstShuffleVector};
use llvm_sys::prelude::LLVMValueRef;

use std::ffi::CStr;
use std::fmt::{self, Display};

use crate::types::ScalableVectorType;
use crate::values::traits::AsValueRef;
use crate::values::{BasicValue, BasicValueEnum, InstructionValue, IntValue, Value};

use super::AnyValue;

#[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
pub struct ScalableVectorValue<'ctx> {
    scalable_vec_value: Value<'ctx>,
}

impl<'ctx> ScalableVectorValue<'ctx> {
    /// Get a value from an [LLVMValueRef].
    ///
    /// # Safety
    ///
    /// The ref must be valid and of type scalable vector.
    pub unsafe fn new(scalable_vector_value: LLVMValueRef) -> Self {
        unsafe {
            assert!(!scalable_vector_value.is_null());

            ScalableVectorValue {
                scalable_vec_value: Value::new(scalable_vector_value),
            }
        }
    }

    /// Determines whether or not a `ScalableVectorValue` is a constant.
    ///
    /// # Example
    ///
    /// ```ignore
    /// use inkwell::context::Context;
    ///
    /// let context = Context::create();
    /// let i8_type = context.i8_type();
    /// let i8_scalable_vec_type = i8_type.scalable_vec_type(3);
    /// let i8_scalable_vec_zero = i8_scalable_vec_type.const_zero();
    ///
    /// assert!(i8_scalable_vec_zero.is_const());
    /// ```
    pub fn is_const(self) -> bool {
        self.scalable_vec_value.is_const()
    }

    pub fn print_to_stderr(self) {
        self.scalable_vec_value.print_to_stderr()
    }

    /// Gets the name of a `ScalableVectorValue`. If the value is a constant, this will
    /// return an empty string.
    pub fn get_name(&self) -> &CStr {
        self.scalable_vec_value.get_name()
    }

    /// Set name of the `ScalableVectorValue`.
    pub fn set_name(&self, name: &str) {
        self.scalable_vec_value.set_name(name)
    }

    pub fn get_type(self) -> ScalableVectorType<'ctx> {
        unsafe { ScalableVectorType::new(self.scalable_vec_value.get_type()) }
    }

    pub fn is_null(self) -> bool {
        self.scalable_vec_value.is_null()
    }

    pub fn is_undef(self) -> bool {
        self.scalable_vec_value.is_undef()
    }

    pub fn as_instruction(self) -> Option<InstructionValue<'ctx>> {
        self.scalable_vec_value.as_instruction()
    }

    pub fn const_extract_element(self, index: IntValue<'ctx>) -> BasicValueEnum<'ctx> {
        unsafe { BasicValueEnum::new(LLVMConstExtractElement(self.as_value_ref(), index.as_value_ref())) }
    }

    // SubTypes: value should really be T in self: ScalableVectorValue<T> I think
    pub fn const_insert_element<BV: BasicValue<'ctx>>(self, index: IntValue<'ctx>, value: BV) -> BasicValueEnum<'ctx> {
        unsafe {
            BasicValueEnum::new(LLVMConstInsertElement(
                self.as_value_ref(),
                value.as_value_ref(),
                index.as_value_ref(),
            ))
        }
    }

    pub fn replace_all_uses_with(self, other: ScalableVectorValue<'ctx>) {
        self.scalable_vec_value.replace_all_uses_with(other.as_value_ref())
    }

    // TODOC: Value seems to be zero initialized if index out of bounds
    // SubType: ScalableVectorValue<BV> -> BV
    #[allow(deprecated)]
    pub fn get_element_as_constant(self, index: u32) -> BasicValueEnum<'ctx> {
        unsafe { BasicValueEnum::new(LLVMGetElementAsConstant(self.as_value_ref(), index)) }
    }

    // SubTypes: self can only be ScalableVectoValue<IntValue<bool>>
    #[llvm_versions(..=16)]
    pub fn const_select<BV: BasicValue<'ctx>>(self, then: BV, else_: BV) -> BasicValueEnum<'ctx> {
        unsafe {
            BasicValueEnum::new(LLVMConstSelect(
                self.as_value_ref(),
                then.as_value_ref(),
                else_.as_value_ref(),
            ))
        }
    }

    // SubTypes: <V: ScalableVectorValue<T, Const>> self: V, right: V, mask: V -> V
    pub fn const_shuffle_vector(
        self,
        right: ScalableVectorValue<'ctx>,
        mask: ScalableVectorValue<'ctx>,
    ) -> ScalableVectorValue<'ctx> {
        unsafe {
            ScalableVectorValue::new(LLVMConstShuffleVector(
                self.as_value_ref(),
                right.as_value_ref(),
                mask.as_value_ref(),
            ))
        }
    }
}

unsafe impl AsValueRef for ScalableVectorValue<'_> {
    fn as_value_ref(&self) -> LLVMValueRef {
        self.scalable_vec_value.value
    }
}

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