Class: LLVM::Type

Inherits:
Object
  • Object
show all
Includes:
PointerIdentity
Defined in:
lib/llvm/core/type.rb

Direct Known Subclasses

FunctionType, IntType, StructType

Class Method Summary collapse

Instance Method Summary collapse

Methods included from PointerIdentity

#==, #eql?, #hash, #to_ptr

Class Method Details

.array(ty, sz = 0) ⇒ Object

Creates an array type of Type with the given size. arrays can be size >= 0, llvm.org/docs/LangRef.html#array-type

Raises:

  • (ArgumentError) 


100
101
102
103
104
105
 
# File 'lib/llvm/core/type.rb', line 100

def self.array(ty, sz = 0)
  sz = sz.to_i
  raise ArgumentError, "LLVM Array size must be >= 0" if sz.negative?

  from_ptr(C.array_type(LLVM::Type(ty), sz), :array)
end

.from_ptr(ptr, kind = nil) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/llvm/core/type.rb', line 8

def self.from_ptr(ptr, kind = nil)
  return if ptr.null?
  kind ||= C.get_type_kind(ptr)
  ty = case kind
  when :integer
    IntType.allocate
  when :function
    FunctionType.allocate
  when :struct
    StructType.allocate
  else
    allocate
  end
  ty.instance_variable_set(:@ptr, ptr)
  ty.instance_variable_set(:@kind, kind)
  ty
end

.function(arg_types, result_type, options = {}) ⇒ Object

Creates a function type. Takes an array of argument Types and the result Type. The only option is :varargs, which when set to true makes the function type take a variable number of args.



132
133
134
135
136
137
 
# File 'lib/llvm/core/type.rb', line 132

def self.function(arg_types, result_type, options = {})
  arg_types.map! { |ty| LLVM::Type(ty) }
  arg_types_ptr = FFI::MemoryPointer.new(FFI.type_size(:pointer) * arg_types.size)
  arg_types_ptr.write_array_of_pointer(arg_types)
  from_ptr(C.function_type(LLVM::Type(result_type), arg_types_ptr, arg_types.size, options[:varargs] ? 1 : 0), :function)
end

.label ⇒ Object 



166
167
168
 
# File 'lib/llvm/core/type.rb', line 166

def self.label
  from_ptr(C.label_type, :label)
end

.named(name) ⇒ Object 



157
158
159
 
# File 'lib/llvm/core/type.rb', line 157

def self.named(name)
  from_ptr(C.get_type_by_name2(Context.global, name.to_s), nil)
end

.opaque_struct(name) ⇒ Object 



153
154
155
 
# File 'lib/llvm/core/type.rb', line 153

def self.opaque_struct(name)
  from_ptr(C.struct_create_named(Context.global, name.to_s), :struct)
end

.pointer(ty = nil, address_space = 0) ⇒ Object

Creates the pointer type of Type with the given address space.



108
109
110
111
112
113
114
 
# File 'lib/llvm/core/type.rb', line 108

def self.pointer(ty = nil, address_space = 0)
  if ty
    from_ptr(C.pointer_type(LLVM::Type(ty), address_space), :pointer)
  else
    ptr(address_space)
  end
end

.ptr(address_space = 0) ⇒ Object

opaque pointer



117
118
119
 
# File 'lib/llvm/core/type.rb', line 117

def self.ptr(address_space = 0)
  from_ptr(C.pointer_type(void, address_space), :pointer)
end

.rec ⇒ Object

def self.opaque_pointer

from_ptr(C.opaque_type, :pointer)

end



181
182
183
184
185
186
 
# File 'lib/llvm/core/type.rb', line 181

def self.rec
  h = opaque
  ty = yield h
  h.refine(ty)
  ty
end

.struct(elt_types, is_packed, name = nil) ⇒ Object

Creates a struct type with the given array of element types.



140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/llvm/core/type.rb', line 140

def self.struct(elt_types, is_packed, name = nil)
  elt_types.map! { |ty| LLVM::Type(ty) }
  elt_types_ptr = FFI::MemoryPointer.new(FFI.type_size(:pointer) * elt_types.size)
  elt_types_ptr.write_array_of_pointer(elt_types)
  if name
    struct = from_ptr(C.struct_create_named(Context.global, name), :struct)
    C.struct_set_body(struct, elt_types_ptr, elt_types.size, is_packed ? 1 : 0) unless elt_types.empty?
    struct
  else
    from_ptr(C.struct_type(elt_types_ptr, elt_types.size, is_packed ? 1 : 0), :struct)
  end
end

.vector(ty, element_count) ⇒ Object

Creates a vector type of Type with the given element count. vectors can be size > 0, llvm.org/docs/LangRef.html#vector-type

Raises:

  • (ArgumentError) 


123
124
125
126
127
128
 
# File 'lib/llvm/core/type.rb', line 123

def self.vector(ty, element_count)
  element_count = element_count.to_i
  raise ArgumentError, "LLVM Vector size must be > 0" unless element_count.positive?

  from_ptr(C.vector_type(LLVM::Type(ty), element_count), :vector)
end

.void ⇒ Object

Creates a void type.



162
163
164
 
# File 'lib/llvm/core/type.rb', line 162

def self.void
  from_ptr(C.void_type, :void)
end

.x86_amx ⇒ Object 



174
175
176
 
# File 'lib/llvm/core/type.rb', line 174

def self.x86_amx
  from_ptr(C.x86amx_type, :x86amx)
end

.x86_mmx ⇒ Object 



170
171
172
 
# File 'lib/llvm/core/type.rb', line 170

def self.x86_mmx
  from_ptr(C.x86mmx_type, :x86mmx)
end

Instance Method Details

#aggregate? ⇒ Boolean

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/llvm/core/type.rb', line 82

def aggregate?
  [:struct, :array].include?(kind)
end

#align ⇒ Object 



36
37
38
 
# File 'lib/llvm/core/type.rb', line 36

def align
  LLVM::Int64.from_ptr(C.align_of(self))
end

#dump ⇒ Object

Print the type’s representation to stdout.



73
74
75
 
# File 'lib/llvm/core/type.rb', line 73

def dump
  C.dump_type(self)
end

#element_type ⇒ Object

Returns the type of this types elements (works only for Pointer, Vector, and Array types.)



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/llvm/core/type.rb', line 41

def element_type
  case kind
  when :vector, :array
    element_type = C.get_element_type(self)
    Type.from_ptr(element_type)
  when :pointer
    LLVM.Void
  else
    raise "element_type not supported for kind: #{kind}"
  end
end

#kind ⇒ Object

Returns a symbol representation of the types kind (ex. :pointer, :vector, :array.)



27
28
29
 
# File 'lib/llvm/core/type.rb', line 27

def kind
  @kind
end

#literal_struct? ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/llvm/core/type.rb', line 94

def literal_struct?
  C.is_literal_struct(self)
end

#null ⇒ Object

Returns a null ConstantExpr of this type.



59
60
61
 
# File 'lib/llvm/core/type.rb', line 59

def null
  ConstantExpr.from_ptr(C.const_null(self))
end

#null_pointer ⇒ Object

Returns a null pointer ConstantExpr of this type.



54
55
56
 
# File 'lib/llvm/core/type.rb', line 54

def null_pointer
  ConstantExpr.from_ptr(C.const_pointer_null(self))
end

#opaque_struct? ⇒ Boolean

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/llvm/core/type.rb', line 86

def opaque_struct?
  C.is_opaque_struct(self)
end

#packed_struct? ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/llvm/core/type.rb', line 90

def packed_struct?
  C.is_packed_struct(self)
end

#pointer(address_space = 0) ⇒ Object

Creates a pointer type with this type and the given address space.



68
69
70
 
# File 'lib/llvm/core/type.rb', line 68

def pointer(address_space = 0)
  Type.pointer(self, address_space)
end

#poison ⇒ Object 



63
64
65
 
# File 'lib/llvm/core/type.rb', line 63

def poison
  ConstantExpr.from_ptr(C.get_poison(self))
end

#size ⇒ Object

Returns the size of the type.



32
33
34
 
# File 'lib/llvm/core/type.rb', line 32

def size
  LLVM::Int64.from_ptr(C.size_of(self))
end

#to_s ⇒ Object

Build string of LLVM type representation.



78
79
80
 
# File 'lib/llvm/core/type.rb', line 78

def to_s
  C.print_type_to_string(self)
end