Class: LLVM::Function
- Inherits:
-
GlobalValue
- Object
- Value
- User
- Constant
- GlobalValue
- LLVM::Function
- Defined in:
- lib/llvm/analysis.rb,
lib/llvm/core/value.rb
Defined Under Namespace
Classes: AttributeCollection, BasicBlockCollection, ParameterCollection
Instance Method Summary collapse
-
#add_attribute(attr, index = -1)) ⇒ Object
Adds attr to this value’s attributes.
- #attribute_count ⇒ Object
- #attributes ⇒ Object
-
#basic_blocks ⇒ Object
Returns an Enumerable of the BasicBlocks in this function.
-
#call_conv ⇒ Object
gets the calling convention of the function.
-
#call_conv=(conv) ⇒ Object
Sets the function’s calling convention and returns it.
- #function_attributes ⇒ Object
- #function_type ⇒ Object
- #gc ⇒ Object
- #gc=(name) ⇒ Object
- #inspect ⇒ Object
- #param_attributes(index) ⇒ Object
-
#params ⇒ Object
Returns an Enumerable of the parameters in the function.
-
#personality_function ⇒ Object
Get personality function of function.
-
#personality_function=(personality_function) ⇒ Object
Set personality function of function.
- #readnone? ⇒ Boolean
- #readonly? ⇒ Boolean
-
#remove_attribute(attr, index = -1)) ⇒ Object
Removes the given attribute from the function.
- #return_attributes ⇒ Object
- #return_type ⇒ Object
-
#type ⇒ Object
In LLVM 15, not overriding this yields a pointer type instead of a function type.
- #valid? ⇒ Boolean
-
#verify ⇒ true, false
Verify that a function is valid.
-
#verify! ⇒ true, false
Verify that a function is valid, and abort the process if not.
- #writeonly? ⇒ Boolean
Methods inherited from GlobalValue
#alignment, #alignment=, #declaration?, #dll_storage_class, #dll_storage_class=, #linkage, #linkage=, #section, #section=, #unnamed_addr=, #unnamed_addr?, #visibility, #visibility=
Methods inherited from Constant
#bitcast_to, #gep, null, null_ptr, poison, #ptr_to_int, undef
Methods inherited from User
Methods inherited from Value
#allocated_type, #allocated_type?, #constant?, #dump, from_ptr, from_ptr_kind, #gep_source_element_type, #gep_source_element_type?, #global_parent, #kind, #name, #name=, #null?, #poison?, to_ptr, #to_s, type, #undef?
Methods included from PointerIdentity
Instance Method Details
#add_attribute(attr, index = -1)) ⇒ Object
Adds attr to this value’s attributes.
901 902 903 |
# File 'lib/llvm/core/value.rb', line 901 def add_attribute(attr, index = -1) AttributeCollection.new(self, index).add(attr) end |
#attribute_count ⇒ Object
910 911 912 |
# File 'lib/llvm/core/value.rb', line 910 def attribute_count function_attributes.count end |
#attributes ⇒ Object
914 915 916 |
# File 'lib/llvm/core/value.rb', line 914 def attributes function_attributes.to_a end |
#basic_blocks ⇒ Object
Returns an Enumerable of the BasicBlocks in this function.
883 884 885 |
# File 'lib/llvm/core/value.rb', line 883 def basic_blocks @basic_block_collection ||= BasicBlockCollection.new(self) end |
#call_conv ⇒ Object
gets the calling convention of the function
863 864 865 |
# File 'lib/llvm/core/value.rb', line 863 def call_conv C.get_function_call_conv(self) end |
#call_conv=(conv) ⇒ Object
Sets the function’s calling convention and returns it.
858 859 860 |
# File 'lib/llvm/core/value.rb', line 858 def call_conv=(conv) C.set_function_call_conv(self, conv) end |
#function_attributes ⇒ Object
930 931 932 |
# File 'lib/llvm/core/value.rb', line 930 def function_attributes AttributeCollection.new(self, -1) end |
#function_type ⇒ Object
887 888 889 |
# File 'lib/llvm/core/value.rb', line 887 def function_type Type.from_ptr(C.get_element_type(self), :function) end |
#gc=(name) ⇒ Object
1108 1109 1110 |
# File 'lib/llvm/core/value.rb', line 1108 def gc=(name) C.set_gc(self, name) end |
#inspect ⇒ Object
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 |
# File 'lib/llvm/core/value.rb', line 1116 def inspect { signature: to_s.lines[attribute_count == 0 ? 0 : 1], type: type.to_s, attributes: attribute_count, valid: valid?, blocks: basic_blocks.size, lines: to_s.lines.size, }.to_s end |
#param_attributes(index) ⇒ Object
938 939 940 |
# File 'lib/llvm/core/value.rb', line 938 def param_attributes(index) AttributeCollection.new(self, index) end |
#params ⇒ Object
Returns an Enumerable of the parameters in the function.
1075 1076 1077 |
# File 'lib/llvm/core/value.rb', line 1075 def params @parameter_collection ||= ParameterCollection.new(self) end |
#personality_function ⇒ Object
Experimental and unsupported
Get personality function of function
870 871 872 873 |
# File 'lib/llvm/core/value.rb', line 870 def personality_function ptr = C.get_personality_fn(self) LLVM::Function.from_ptr(ptr) end |
#personality_function=(personality_function) ⇒ Object
Experimental and unsupported
Set personality function of function
878 879 880 |
# File 'lib/llvm/core/value.rb', line 878 def personality_function=(personality_function) C.set_personality_fn(self, personality_function) end |
#readnone? ⇒ Boolean
918 919 920 |
# File 'lib/llvm/core/value.rb', line 918 def readnone? attributes.detect(&:readnone?) end |
#readonly? ⇒ Boolean
922 923 924 |
# File 'lib/llvm/core/value.rb', line 922 def readonly? attributes.detect(&:readonly?) end |
#remove_attribute(attr, index = -1)) ⇒ Object
Removes the given attribute from the function.
906 907 908 |
# File 'lib/llvm/core/value.rb', line 906 def remove_attribute(attr, index = -1) AttributeCollection.new(self, index).remove(attr) end |
#return_attributes ⇒ Object
934 935 936 |
# File 'lib/llvm/core/value.rb', line 934 def return_attributes AttributeCollection.new(self, 0) end |
#return_type ⇒ Object
896 897 898 |
# File 'lib/llvm/core/value.rb', line 896 def return_type type.return_type end |
#type ⇒ Object
In LLVM 15, not overriding this yields a pointer type instead of a function type
892 893 894 |
# File 'lib/llvm/core/value.rb', line 892 def type function_type end |
#valid? ⇒ Boolean
49 50 51 |
# File 'lib/llvm/analysis.rb', line 49 def valid? verify end |
#verify ⇒ true, false
Verify that a function is valid.
39 40 41 |
# File 'lib/llvm/analysis.rb', line 39 def verify do_verification(:return_status) end |
#verify! ⇒ true, false
Verify that a function is valid, and abort the process if not.
45 46 47 |
# File 'lib/llvm/analysis.rb', line 45 def verify! do_verification(:abort_process) end |
#writeonly? ⇒ Boolean
926 927 928 |
# File 'lib/llvm/core/value.rb', line 926 def writeonly? attributes.detect(&:writeonly?) end |