Slightly improved docs and structure of *Value traits

Author: Grégoire Geis

src/values/enums.rs

@@ -2,7 +2,7 @@ use llvm_sys::core::{LLVMTypeOf, LLVMGetTypeKind};
 use llvm_sys::LLVMTypeKind;
 use llvm_sys::prelude::LLVMValueRef;
 
-use types::BasicTypeEnum;
+use types::{AnyTypeEnum, BasicTypeEnum};
 use values::traits::AsValueRef;
 use values::{IntValue, FunctionValue, PointerValue, VectorValue, ArrayValue, StructValue, FloatValue, PhiValue, InstructionValue, MetadataValue};
 
@@ -43,6 +43,40 @@ enum_value_set! {AnyValueEnum: ArrayValue, IntValue, FloatValue, PhiValue, Funct
 enum_value_set! {BasicValueEnum: ArrayValue, IntValue, FloatValue, PointerValue, StructValue, VectorValue}
 enum_value_set! {BasicMetadataValueEnum: ArrayValue, IntValue, FloatValue, PointerValue, StructValue, VectorValue, MetadataValue}
 
+impl AnyValueEnum {
+    pub(crate) fn new(value: LLVMValueRef) -> AnyValueEnum {
+        let type_kind = unsafe {
+            LLVMGetTypeKind(LLVMTypeOf(value))
+        };
+
+        match type_kind {
+            LLVMTypeKind::LLVMFloatTypeKind |
+            LLVMTypeKind::LLVMFP128TypeKind |
+            LLVMTypeKind::LLVMDoubleTypeKind |
+            LLVMTypeKind::LLVMHalfTypeKind |
+            LLVMTypeKind::LLVMX86_FP80TypeKind |
+            LLVMTypeKind::LLVMPPC_FP128TypeKind => AnyValueEnum::FloatValue(FloatValue::new(value)),
+            LLVMTypeKind::LLVMIntegerTypeKind => AnyValueEnum::IntValue(IntValue::new(value)),
+            LLVMTypeKind::LLVMStructTypeKind => AnyValueEnum::StructValue(StructValue::new(value)),
+            LLVMTypeKind::LLVMPointerTypeKind => AnyValueEnum::PointerValue(PointerValue::new(value)),
+            LLVMTypeKind::LLVMArrayTypeKind => AnyValueEnum::ArrayValue(ArrayValue::new(value)),
+            LLVMTypeKind::LLVMVectorTypeKind => AnyValueEnum::VectorValue(VectorValue::new(value)),
+            LLVMTypeKind::LLVMFunctionTypeKind => AnyValueEnum::FunctionValue(FunctionValue::new(value).unwrap()),
+            LLVMTypeKind::LLVMVoidTypeKind => panic!("Void values shouldn't exist."),
+            LLVMTypeKind::LLVMMetadataTypeKind => panic!("Metadata values are not supported as AnyValue's."),
+            _ => panic!("The given type is not supported.")
+        }
+    }
+
+    pub fn get_type(&self) -> AnyTypeEnum {
+        let type_ = unsafe {
+            LLVMTypeOf(self.as_value_ref())
+        };
+
+        AnyTypeEnum::new(type_)
+    }
+}
+
 impl BasicValueEnum {
     pub(crate) fn new(value: LLVMValueRef) -> BasicValueEnum {
         let type_kind = unsafe {
@@ -61,7 +95,7 @@ impl BasicValueEnum {
             LLVMTypeKind::LLVMPointerTypeKind => BasicValueEnum::PointerValue(PointerValue::new(value)),
             LLVMTypeKind::LLVMArrayTypeKind => BasicValueEnum::ArrayValue(ArrayValue::new(value)),
             LLVMTypeKind::LLVMVectorTypeKind => BasicValueEnum::VectorValue(VectorValue::new(value)),
-            _ => unreachable!("Unsupported type"),
+            _ => unreachable!("The given type is not a basic type."),
         }
     }
 
@@ -85,6 +119,20 @@ impl BasicValueEnum {
     }
 }
 
+impl AggregateValueEnum {
+    pub(crate) fn new(value: LLVMValueRef) -> AggregateValueEnum {
+        let type_kind = unsafe {
+            LLVMGetTypeKind(LLVMTypeOf(value))
+        };
+
+        match type_kind {
+            LLVMTypeKind::LLVMArrayTypeKind => AggregateValueEnum::ArrayValue(ArrayValue::new(value)),
+            LLVMTypeKind::LLVMStructTypeKind => AggregateValueEnum::StructValue(StructValue::new(value)),
+            _ => unreachable!("The given type is not an aggregate type."),
+        }
+    }
+}
+
 impl BasicMetadataValueEnum {
     pub(crate) fn new(value: LLVMValueRef) -> BasicMetadataValueEnum {
         let type_kind = unsafe {

src/values/traits.rs

@@ -1,5 +1,7 @@
 use llvm_sys::prelude::LLVMValueRef;
 
+use std::fmt::Debug;
+
 use values::{ArrayValue, AggregateValueEnum, StructValue, BasicValueEnum, AnyValueEnum, IntValue, FloatValue, PointerValue, PhiValue, VectorValue, FunctionValue, InstructionValue};
 
 // This is an ugly privacy hack so that Type can stay private to this module
@@ -11,8 +13,6 @@ pub trait AsValueRef {
 
 macro_rules! trait_value_set {
     ($trait_name:ident: $($args:ident),*) => (
-        pub trait $trait_name: AsValueRef {}
-
         $(
             impl $trait_name for $args {}
         )*
@@ -22,6 +22,30 @@ macro_rules! trait_value_set {
     );
 }
 
+/// Represents an aggregate value, built on top of other values.
+pub trait AggregateValue: AnyValue {
+    /// Returns an enum containing a typed version of the `AggregateValue`.
+    fn as_aggregate_value_enum(&self) -> AggregateValueEnum {
+        AggregateValueEnum::new(self.as_value_ref())
+    }
+}
+
+/// Represents a basic value, which can be used both by itself, or in an `AggregateValue`.
+pub trait BasicValue: AnyValue {
+    /// Returns an enum containing a typed version of the `BasicValue`.
+    fn as_basic_value_enum(&self) -> BasicValueEnum {
+        BasicValueEnum::new(self.as_value_ref())
+    }
+}
+
+/// Defines any struct wrapping an LLVM value.
+pub trait AnyValue: AsValueRef + Debug {
+    /// Returns an enum containing a typed version of `AnyValue`.
+    fn as_any_value_enum(&self) -> AnyValueEnum {
+        AnyValueEnum::new(self.as_value_ref())
+    }
+}
+
 trait_value_set! {AggregateValue: ArrayValue, AggregateValueEnum, StructValue}
 trait_value_set! {AnyValue: AnyValueEnum, BasicValueEnum, AggregateValueEnum, ArrayValue, IntValue, FloatValue, PhiValue, PointerValue, FunctionValue, StructValue, VectorValue, InstructionValue}
 trait_value_set! {BasicValue: ArrayValue, BasicValueEnum, AggregateValueEnum, IntValue, FloatValue, StructValue, PointerValue, VectorValue}