func_entry_info_t Class Reference

Describes a function entry chunk. More...

#include <funcs.hpp>

Inheritance diagram for func_entry_info_t:

Public Member Functions
	func_entry_info_t (ea_t start=0, ea_t end=0)
bool	has (int gfi_flags) const
	Check if a string field was populated by get_func_entry_info().
void	set_flags (uint64 v)
	Function flags Function flags.
void	set_flag (uint64 v, bool cnd=true)
	Set or clear function flag Function flags.
uval_t	get_frame_id () const
	Netnode id of frame structure.
asize_t	get_frsize () const
	Size of local variables part of frame in bytes.
void	set_frsize (asize_t v)
ushort	get_frregs () const
	Size of saved registers in frame.
void	set_frregs (ushort v)
asize_t	get_argsize () const
	Number of bytes purged from the stack upon returning.
void	set_argsize (asize_t v)
asize_t	get_fpd () const
	Frame pointer delta.
void	set_fpd (asize_t v)
bgcolor_t	get_color () const
	User defined function color.
void	set_color (bgcolor_t v)
const char *	get_name () const
	Function name (requires GFI_NAME flag)
const char *	get_cmt () const
	Function comment (requires GFI_CMT flag)
const char *	get_cmt_rpt () const
	Repeatable function comment (requires GFI_CMT_RPT flag)
Public Member Functions inherited from fchunk_info_t
	fchunk_info_t (ea_t start=0, ea_t end=0)
bool	is_valid () const
	Is the function chunk info valid?
bool	is_tail () const
	Is this a tail chunk?
bool	is_entry () const
	Is this an entry chunk?
uint64	get_flags () const
	Function chunk flags Function flags.
void	set_flags (uint64 v)
bool	is_far () const
	Is a far function?
bool	does_return () const
	Does function return?
bool	analyzed_sp () const
	Has SP-analysis been performed?
bool	need_prolog_analysis () const
	Needs prolog analysis?
Public Member Functions inherited from range_t
	range_t (ea_t ea1=0, ea_t ea2=0)
	DECLARE_COMPARISONS (range_t)
	Compare two range_t instances, based on the start_ea.
bool	contains (ea_t ea) const
	Is 'ea' in the address range?
bool	contains (const range_t &r) const
	Is every ea in 'r' also in this range_t?
bool	overlaps (const range_t &r) const
	Is there an ea in 'r' that is also in this range_t?
void	clear ()
	Set start_ea, end_ea to 0.
bool	empty () const
	Is the size of the range_t <= 0?
asize_t	size () const
	Get end_ea - start_ea.
void	intersect (const range_t &r)
	Assign the range_t to the intersection between the range_t and 'r'.
void	extend (ea_t ea)
	Ensure that the range_t includes 'ea'.
size_t	print (char *buf, size_t bufsize) const
	Print the range_t.

Friends
struct	kdata_t

Additional Inherited Members
Public Attributes inherited from range_t
ea_t	start_ea
	start_ea included
ea_t	end_ea
	end_ea excluded
Protected Attributes inherited from fchunk_info_t
uint64	flags_ = 0

Detailed Description

Describes a function entry chunk.

Call set_func_entry_info() to apply modifications to the database.

Constructor & Destructor Documentation

func_entry_info_t()

func_entry_info_t::func_entry_info_t ( ea_t start = 0, ea_t end = 0 )

inline

Member Function Documentation

has()

bool func_entry_info_t::has ( int gfi_flags ) const

inline

Check if a string field was populated by get_func_entry_info().

Parameters

gfi_flags

combination of Flags for get_func_entry_info() flags to check

Returns

true if all specified fields are available

set_flags()

void func_entry_info_t::set_flags ( uint64 v )

inline

Function flags Function flags.

set_flag()

void func_entry_info_t::set_flag ( uint64 v, bool cnd = true )

inline

Set or clear function flag Function flags.

get_frame_id()

uval_t func_entry_info_t::get_frame_id ( ) const

inline

Netnode id of frame structure.

get_frsize()

asize_t func_entry_info_t::get_frsize ( ) const

inline

Size of local variables part of frame in bytes.

set_frsize()

void func_entry_info_t::set_frsize ( asize_t v )

inline

get_frregs()

ushort func_entry_info_t::get_frregs ( ) const

inline

Size of saved registers in frame.

set_frregs()

void func_entry_info_t::set_frregs ( ushort v )

inline

get_argsize()

asize_t func_entry_info_t::get_argsize ( ) const

inline

Number of bytes purged from the stack upon returning.

set_argsize()

void func_entry_info_t::set_argsize ( asize_t v )

inline

get_fpd()

asize_t func_entry_info_t::get_fpd ( ) const

inline

Frame pointer delta.

set_fpd()

void func_entry_info_t::set_fpd ( asize_t v )

inline

get_color()

bgcolor_t func_entry_info_t::get_color ( ) const

inline

User defined function color.

set_color()

void func_entry_info_t::set_color ( bgcolor_t v )

inline

get_name()

const char * func_entry_info_t::get_name ( ) const

inline

Function name (requires GFI_NAME flag)

get_cmt()

const char * func_entry_info_t::get_cmt ( ) const

inline

Function comment (requires GFI_CMT flag)

get_cmt_rpt()

const char * func_entry_info_t::get_cmt_rpt ( ) const

inline

Repeatable function comment (requires GFI_CMT_RPT flag)

Friends And Related Symbol Documentation

kdata_t

friend struct kdata_t

friend

---

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

• /Users/geoffrey/ida-sdk/src/include/funcs.hpp