inkwell/values/array_value.rs
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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
#[llvm_versions(..17)]
use llvm_sys::core::LLVMConstArray;
#[llvm_versions(17..)]
use llvm_sys::core::LLVMConstArray2 as LLVMConstArray;
use llvm_sys::core::{LLVMGetAsString, LLVMIsAConstantArray, LLVMIsAConstantDataArray, LLVMIsConstantString};
use llvm_sys::prelude::LLVMTypeRef;
use llvm_sys::prelude::LLVMValueRef;
use std::ffi::CStr;
use std::fmt::{self, Display};
use crate::types::{ArrayType, AsTypeRef};
use crate::values::traits::{AnyValue, AsValueRef};
use crate::values::{InstructionValue, Value};
/// An `ArrayValue` is a block of contiguous constants or variables.
#[derive(PartialEq, Eq, Clone, Copy, Hash)]
pub struct ArrayValue<'ctx> {
array_value: Value<'ctx>,
}
impl<'ctx> ArrayValue<'ctx> {
/// Get a value from an [LLVMValueRef].
///
/// # Safety
///
/// The ref must be valid and of type array.
pub unsafe fn new(value: LLVMValueRef) -> Self {
assert!(!value.is_null());
ArrayValue {
array_value: Value::new(value),
}
}
/// Creates a new constant `ArrayValue` with the given type and values.
///
/// # Safety
///
/// `values` must be of the same type as `ty`.
pub unsafe fn new_const_array<T: AsTypeRef, V: AsValueRef>(ty: &T, values: &[V]) -> Self {
let values = values.iter().map(V::as_value_ref).collect::<Vec<_>>();
Self::new_raw_const_array(ty.as_type_ref(), &values)
}
/// Creates a new constant `ArrayValue` with the given type and values.
///
/// # Safety
///
/// `values` must be of the same type as `ty`.
pub unsafe fn new_raw_const_array(ty: LLVMTypeRef, values: &[LLVMValueRef]) -> Self {
unsafe { Self::new(LLVMConstArray(ty, values.as_ptr().cast_mut(), values.len() as _)) }
}
/// Get name of the `ArrayValue`. If the value is a constant, this will
/// return an empty string.
pub fn get_name(&self) -> &CStr {
self.array_value.get_name()
}
/// Set name of the `ArrayValue`.
pub fn set_name(&self, name: &str) {
self.array_value.set_name(name)
}
/// Gets the type of this `ArrayValue`.
pub fn get_type(self) -> ArrayType<'ctx> {
unsafe { ArrayType::new(self.array_value.get_type()) }
}
/// Determines whether or not this value is null.
pub fn is_null(self) -> bool {
self.array_value.is_null()
}
/// Determines whether or not this value is undefined.
pub fn is_undef(self) -> bool {
self.array_value.is_undef()
}
/// Prints this `ArrayValue` to standard error.
pub fn print_to_stderr(self) {
self.array_value.print_to_stderr()
}
/// Attempt to convert this `ArrayValue` to an `InstructionValue`, if possible.
pub fn as_instruction(self) -> Option<InstructionValue<'ctx>> {
self.array_value.as_instruction()
}
/// Replaces all uses of this value with another value of the same type.
/// If used incorrectly this may result in invalid IR.
pub fn replace_all_uses_with(self, other: ArrayValue<'ctx>) {
self.array_value.replace_all_uses_with(other.as_value_ref())
}
/// Determines whether or not an `ArrayValue` is a constant.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
///
/// let context = Context::create();
/// let i64_type = context.i64_type();
/// let i64_val = i64_type.const_int(23, false);
/// let array_val = i64_type.const_array(&[i64_val]);
///
/// assert!(array_val.is_const());
/// ```
pub fn is_const(self) -> bool {
self.array_value.is_const()
}
/// Determines whether or not an `ArrayValue` represents a constant array of `i8`s.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
///
/// let context = Context::create();
/// let string = context.const_string(b"my_string", false);
///
/// assert!(string.is_const_string());
/// ```
// SubTypes: Impl only for ArrayValue<IntValue<i8>>
pub fn is_const_string(self) -> bool {
unsafe { LLVMIsConstantString(self.as_value_ref()) == 1 }
}
/// Obtain the string from the ArrayValue
/// if the value points to a constant string.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
/// use std::ffi::CStr;
///
/// let context = Context::create();
/// let string = context.const_string(b"hello!", true);
///
/// let result = CStr::from_bytes_with_nul(b"hello!\0").unwrap();
/// assert_eq!(string.get_string_constant(), Some(result));
/// ```
// SubTypes: Impl only for ArrayValue<IntValue<i8>>
pub fn get_string_constant(&self) -> Option<&CStr> {
let mut len = 0;
let ptr = unsafe { LLVMGetAsString(self.as_value_ref(), &mut len) };
if ptr.is_null() {
None
} else {
unsafe { Some(CStr::from_ptr(ptr)) }
}
}
}
unsafe impl AsValueRef for ArrayValue<'_> {
fn as_value_ref(&self) -> LLVMValueRef {
self.array_value.value
}
}
impl Display for ArrayValue<'_> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.print_to_string())
}
}
impl fmt::Debug for ArrayValue<'_> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let llvm_value = self.print_to_string();
let llvm_type = self.get_type();
let name = self.get_name();
let is_const = self.is_const();
let is_null = self.is_null();
let is_const_array = unsafe { !LLVMIsAConstantArray(self.as_value_ref()).is_null() };
let is_const_data_array = unsafe { !LLVMIsAConstantDataArray(self.as_value_ref()).is_null() };
f.debug_struct("ArrayValue")
.field("name", &name)
.field("address", &self.as_value_ref())
.field("is_const", &is_const)
.field("is_const_array", &is_const_array)
.field("is_const_data_array", &is_const_data_array)
.field("is_null", &is_null)
.field("llvm_value", &llvm_value)
.field("llvm_type", &llvm_type)
.finish()
}
}