function_tail_iterator_t Class Reference

Class to enumerate all function tails sorted by addresses. More...

#include <funcs.hpp>

Public Member Functions
	function_tail_iterator_t ()
	function_tail_iterator_t (ea_t func_ea, ea_t ea=BADADDR)
	~function_tail_iterator_t ()
bool	set (ea_t func_ea, ea_t ea=BADADDR)
bool	set_ea (ea_t ea)
bool	set_range (ea_t ea1, ea_t ea2)
void	chunk (range_t *out) const
bool	first ()
bool	last ()
bool	next ()
bool	prev ()
bool	main ()

Friends
struct	kdata_t

Detailed Description

Class to enumerate all function tails sorted by addresses.

Enumeration is started with main(), first(), or last(). If first() is used, the function entry chunk will be excluded from the enumeration. Otherwise it will be included in the enumeration (for main() and last()). The loop may continue until the next() or prev() function returns false. These functions return false when the enumeration is over. The tail chunks are always sorted by their addresses.

Sample code:

function_tail_iterator_t fti(func_ea);
range_t a;
for ( bool ok=fti.first(); ok; ok=fti.next() )
{
  fti.chunk(&a);
  ....

If the 'ea' parameter is used in the constructor, then the iterator is positioned at the chunk containing the specified 'ea'. Otherwise it is positioned at the function entry chunk. If 'func_ea' is specified as BADADDR then the set() function will fail, but it is still possible to use the class. In this case the iteration will be limited by the segment boundaries. The function main chunk is locked during the iteration. It is also possible to enumerate one single arbitrary range using set_range() This function is mainly designed to be used from function_item_iterator_t. Iterator for function tail chunks using ea_t-based API.

Constructor & Destructor Documentation

function_tail_iterator_t() [1/2]

function_tail_iterator_t::function_tail_iterator_t ( )

inline

function_tail_iterator_t() [2/2]

function_tail_iterator_t::function_tail_iterator_t ( ea_t func_ea, ea_t ea = BADADDR )

inline

~function_tail_iterator_t()

function_tail_iterator_t::~function_tail_iterator_t ( )

inline

Member Function Documentation

set()

bool function_tail_iterator_t::set ( ea_t func_ea, ea_t ea = BADADDR )

inline

set_ea()

bool function_tail_iterator_t::set_ea ( ea_t ea )

inline

set_range()

bool function_tail_iterator_t::set_range ( ea_t ea1, ea_t ea2 )

inline

chunk()

void function_tail_iterator_t::chunk ( range_t * out ) const

inline

first()

bool function_tail_iterator_t::first ( )

inline

last()

bool function_tail_iterator_t::last ( )

inline

next()

bool function_tail_iterator_t::next ( )

inline

prev()

bool function_tail_iterator_t::prev ( )

inline

main()

bool function_tail_iterator_t::main ( )

inline

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