IDAPython 9.0
Loading...
Searching...
No Matches
func_t Class Reference

Proxy of C++ func_t class.

Inheritance diagram for func_t:
range_t

Public Member Functions

"bool" is_far (self)
 is_far(self) -> bool Is a far function?
 
"bool" does_return (self)
 does_return(self) -> bool Does function return?
 
"bool" analyzed_sp (self)
 analyzed_sp(self) -> bool Has SP-analysis been performed?
 
"bool" need_prolog_analysis (self)
 need_prolog_analysis(self) -> bool Needs prolog analysis?
 
 __init__ (self, "ea_t" start=0, "ea_t" end=0, "flags64_t" f=0)
 init(self, start=0, end=0, f=0) -> func_t
 
"dynamic_wrapped_array_t< stkpnt_t >" __get_points__ (self)
 get_points(self) -> dyn_stkpnt_array
 
"dynamic_wrapped_array_t< regvar_t >" __get_regvars__ (self)
 get_regvars(self) -> dyn_regvar_array
 
"dynamic_wrapped_array_t< range_t >" __get_tails__ (self)
 get_tails(self) -> dyn_range_array
 
"dynamic_wrapped_array_t< ea_t >" __get_referers__ (self)
 get_referers(self) -> dyn_ea_array
 
"dynamic_wrapped_array_t< regarg_t >" __get_regargs__ (self)
 get_regargs(self) -> dyn_regarg_array
 
 addresses (self)
 Alias for func_item_iterator_t(self).addresses()
 
 code_items (self)
 Alias for func_item_iterator_t(self).code_items()
 
 data_items (self)
 Alias for func_item_iterator_t(self).data_items()
 
 head_items (self)
 Alias for func_item_iterator_t(self).head_items()
 
 not_tails (self)
 Alias for func_item_iterator_t(self).not_tails()
 
"tinfo_t" get_frame_object (self)
 Retrieve the function frame, in the form of a structure where frame offsets that are accessed by the program, as well as areas for "saved registers" and "return address", are represented by structure members.
 
"ssize_t" get_name (self)
 Get the function name.
 
"tinfo_t" get_prototype (self)
 Retrieve the function prototype.
 
 __iter__ (self)
 Alias for func_item_iterator_t(self).__iter__()
 
- Public Member Functions inherited from range_t
"bool" __eq__ (self, "range_t" r)
 eq(self, r) -> bool
 
"bool" __ne__ (self, "range_t" r)
 ne(self, r) -> bool
 
"bool" __lt__ (self, "range_t" r)
 lt(self, r) -> bool
 
"bool" __gt__ (self, "range_t" r)
 gt(self, r) -> bool
 
"bool" __le__ (self, "range_t" r)
 le(self, r) -> bool
 
"bool" __ge__ (self, "range_t" r)
 ge(self, r) -> bool
 
"int" compare (self, "range_t" r)
 compare(self, r) -> int
 
"bool" contains (self, *args)
 contains(self, ea) -> bool Is every ea in 'r' also in this range_t?
 
"bool" overlaps (self, "range_t" r)
 overlaps(self, r) -> bool Is there an ea in 'r' that is also in this range_t?
 
"void" clear (self)
 clear(self) Set start_ea, end_ea to 0.
 
"bool" empty (self)
 empty(self) -> bool Is the size of the range_t <= 0?
 
"asize_t" size (self)
 size(self) -> asize_t Get end_ea - start_ea.
 
"void" intersect (self, "range_t" r)
 intersect(self, r) Assign the range_t to the intersection between the range_t and 'r'.
 
"void" extend (self, "ea_t" ea)
 extend(self, ea) Ensure that the range_t includes 'ea'.
 

Static Public Attributes

str flags = property(_ida_funcs.func_t_flags_get, _ida_funcs.func_t_flags_set, doc=)
 
str frame = property(_ida_funcs.func_t_frame_get, _ida_funcs.func_t_frame_set, doc=)
 
str frsize = property(_ida_funcs.func_t_frsize_get, _ida_funcs.func_t_frsize_set, doc=)
 
str frregs = property(_ida_funcs.func_t_frregs_get, _ida_funcs.func_t_frregs_set, doc=)
 
str argsize = property(_ida_funcs.func_t_argsize_get, _ida_funcs.func_t_argsize_set, doc=)
 
str fpd = property(_ida_funcs.func_t_fpd_get, _ida_funcs.func_t_fpd_set, doc=)
 
str color = property(_ida_funcs.func_t_color_get, _ida_funcs.func_t_color_set, doc=!)
 
str pntqty = property(_ida_funcs.func_t_pntqty_get, _ida_funcs.func_t_pntqty_set, doc=)
 
str points = property(_ida_funcs.func_t_points_get, _ida_funcs.func_t_points_set, doc=)
 
str regvarqty = property(_ida_funcs.func_t_regvarqty_get, _ida_funcs.func_t_regvarqty_set, doc=)
 
str regvars = property(_ida_funcs.func_t_regvars_get, _ida_funcs.func_t_regvars_set, doc=)
 
str regargqty = property(_ida_funcs.func_t_regargqty_get, _ida_funcs.func_t_regargqty_set, doc=)
 
str regargs = property(_ida_funcs.func_t_regargs_get, _ida_funcs.func_t_regargs_set, doc=)
 
str tailqty = property(_ida_funcs.func_t_tailqty_get, _ida_funcs.func_t_tailqty_set, doc=)
 
str tails = property(_ida_funcs.func_t_tails_get, _ida_funcs.func_t_tails_set, doc=)
 
str owner = property(_ida_funcs.func_t_owner_get, _ida_funcs.func_t_owner_set, doc=!)
 
str refqty = property(_ida_funcs.func_t_refqty_get, _ida_funcs.func_t_refqty_set, doc=)
 
str referers = property(_ida_funcs.func_t_referers_get, _ida_funcs.func_t_referers_set, doc=)
 
- Static Public Attributes inherited from range_t
str start_ea = property(_ida_range.range_t_start_ea_get, _ida_range.range_t_start_ea_set, doc=)
 
str end_ea = property(_ida_range.range_t_end_ea_get, _ida_range.range_t_end_ea_set, doc=)
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
 frame_object = property(get_frame_object)
 
 name = property(get_name)
 
 prototype = property(get_prototype)
 
- Properties inherited from range_t
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Additional Inherited Members

- Protected Member Functions inherited from range_t
"size_t" _print (self, *args)
 _print(self) -> size_t
 

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
"ea_t" start = 0,
"ea_t" end = 0,
"flags64_t" f = 0 )
Parameters
startea_t
endea_t
fflags64_t

Reimplemented from range_t.

Member Function Documentation

◆ __get_points__()

"dynamic_wrapped_array_t< stkpnt_t >" __get_points__ ( self)

◆ __get_referers__()

"dynamic_wrapped_array_t< ea_t >" __get_referers__ ( self)

◆ __get_regargs__()

"dynamic_wrapped_array_t< regarg_t >" __get_regargs__ ( self)

◆ __get_regvars__()

"dynamic_wrapped_array_t< regvar_t >" __get_regvars__ ( self)

◆ __get_tails__()

"dynamic_wrapped_array_t< range_t >" __get_tails__ ( self)

◆ __iter__()

__iter__ ( self)

◆ addresses()

addresses ( self)

◆ analyzed_sp()

"bool" analyzed_sp ( self)

◆ code_items()

code_items ( self)

◆ data_items()

data_items ( self)

◆ does_return()

"bool" does_return ( self)

◆ get_frame_object()

"tinfo_t" get_frame_object ( self)

If the function has no associated frame, return None

Returns
: a ida_typeinf.tinfo_t object representing the frame, or None

◆ get_name()

"ssize_t" get_name ( self)
Returns
: the function name

◆ get_prototype()

"tinfo_t" get_prototype ( self)

Once you have obtained the prototype, you can:

If the function has no associated prototype, return None

Returns
: a ida_typeinf.tinfo_t object representing the prototype, or None

◆ head_items()

head_items ( self)

◆ is_far()

"bool" is_far ( self)

◆ need_prolog_analysis()

"bool" need_prolog_analysis ( self)

◆ not_tails()

not_tails ( self)

Member Data Documentation

◆ argsize

str argsize = property(_ida_funcs.func_t_argsize_get, _ida_funcs.func_t_argsize_set, doc=)
static

◆ color

str color = property(_ida_funcs.func_t_color_get, _ida_funcs.func_t_color_set, doc=!)
static

◆ flags

str flags = property(_ida_funcs.func_t_flags_get, _ida_funcs.func_t_flags_set, doc=)
static

◆ fpd

str fpd = property(_ida_funcs.func_t_fpd_get, _ida_funcs.func_t_fpd_set, doc=)
static

◆ frame

str frame = property(_ida_funcs.func_t_frame_get, _ida_funcs.func_t_frame_set, doc=)
static

◆ frregs

str frregs = property(_ida_funcs.func_t_frregs_get, _ida_funcs.func_t_frregs_set, doc=)
static

◆ frsize

str frsize = property(_ida_funcs.func_t_frsize_get, _ida_funcs.func_t_frsize_set, doc=)
static

◆ owner

str owner = property(_ida_funcs.func_t_owner_get, _ida_funcs.func_t_owner_set, doc=!)
static

◆ pntqty

str pntqty = property(_ida_funcs.func_t_pntqty_get, _ida_funcs.func_t_pntqty_set, doc=)
static

◆ points

points = property(_ida_funcs.func_t_points_get, _ida_funcs.func_t_points_set, doc=)
static

◆ referers

referers = property(_ida_funcs.func_t_referers_get, _ida_funcs.func_t_referers_set, doc=)
static

◆ refqty

str refqty = property(_ida_funcs.func_t_refqty_get, _ida_funcs.func_t_refqty_set, doc=)
static

◆ regargqty

str regargqty = property(_ida_funcs.func_t_regargqty_get, _ida_funcs.func_t_regargqty_set, doc=)
static

◆ regargs

regargs = property(_ida_funcs.func_t_regargs_get, _ida_funcs.func_t_regargs_set, doc=)
static

◆ regvarqty

str regvarqty = property(_ida_funcs.func_t_regvarqty_get, _ida_funcs.func_t_regvarqty_set, doc=)
static

◆ regvars

regvars = property(_ida_funcs.func_t_regvars_get, _ida_funcs.func_t_regvars_set, doc=)
static

◆ tailqty

str tailqty = property(_ida_funcs.func_t_tailqty_get, _ida_funcs.func_t_tailqty_set, doc=)
static

◆ tails

tails = property(_ida_funcs.func_t_tails_get, _ida_funcs.func_t_tails_set, doc=)
static

Property Documentation

◆ frame_object

frame_object = property(get_frame_object)
static

◆ name

name = property(get_name)
static

◆ prototype

prototype = property(get_prototype)
static

◆ thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

The documentation for this class was generated from the following file: