Class: LLVM::Function

Inherits:
GlobalValue show all
Defined in:
lib/llvm/analysis.rb,
lib/llvm/core/value.rb

Defined Under Namespace

Classes: BasicBlockCollection, ParameterCollection

Instance Method Summary collapse

Methods inherited from GlobalValue

#alignment, #alignment=, #declaration?, #dll_storage_class, #dll_storage_class=, #global_constant=, #global_constant?, #initializer, #initializer=, #linkage, #linkage=, #section, #section=, #unnamed_addr=, #unnamed_addr?, #visibility, #visibility=

Methods inherited from Constant

#bitcast_to, #gep, null, null_ptr, #ptr_to_int, undef

Methods inherited from User

#operands

Methods inherited from Value

#constant?, #dump, from_ptr, #name, #name=, #null?, to_ptr, type, #undefined?

Methods included from PointerIdentity

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

Instance Method Details

#add_attribute(attr) ⇒ Object

Adds the given attribute to the function.



679
680
681
 
# File 'lib/llvm/core/value.rb', line 679

def add_attribute(attr)
  C.add_function_attr(self, attr)
end

#basic_blocks ⇒ Object

Returns an Enumerable of the BasicBlocks in this function.



689
690
691
 
# File 'lib/llvm/core/value.rb', line 689

def basic_blocks
  @basic_block_collection ||= BasicBlockCollection.new(self)
end

#call_conv=(conv) ⇒ Object

Sets the function’s calling convention and returns it.



673
674
675
676
 
# File 'lib/llvm/core/value.rb', line 673

def call_conv=(conv)
  C.set_function_call_conv(self, conv)
  conv
end

#function_type ⇒ Object 



697
698
699
 
# File 'lib/llvm/core/value.rb', line 697

def function_type
  type.element_type
end

#gc ⇒ Object 



788
789
790
 
# File 'lib/llvm/core/value.rb', line 788

def gc
  C.get_gc(self)
end

#gc=(name) ⇒ Object 



785
786
787
 
# File 'lib/llvm/core/value.rb', line 785

def gc=(name)
  C.set_gc(self, name)
end

#params ⇒ Object

Returns an Enumerable of the parameters in the function.



752
753
754
 
# File 'lib/llvm/core/value.rb', line 752

def params
  @parameter_collection ||= ParameterCollection.new(self)
end

#remove_attribute(attr) ⇒ Object

Removes the given attribute from the function.



684
685
686
 
# File 'lib/llvm/core/value.rb', line 684

def remove_attribute(attr)
  C.remove_function_attr(self, attr)
end

#type ⇒ Object 



693
694
695
 
# File 'lib/llvm/core/value.rb', line 693

def type
  Type.from_ptr(C.type_of(self), :pointer)
end

#verify ⇒ true, false

Verify that a function is valid.

Returns:

  • (true, false) 


33
34
35
 
# File 'lib/llvm/analysis.rb', line 33

def verify
  do_verification(:return_status)
end

#verify! ⇒ true, false

Verify that a function is valid, and abort the process if not.

Returns:

  • (true, false) 


39
40
41
 
# File 'lib/llvm/analysis.rb', line 39

def verify!
  do_verification(:abort_process)
end