Hidden ranges

Hidden ranges - address ranges which can be replaced by their descriptions. More...

Topics
	Hidden range info
	Copy-based hidden range descriptor.

Classes
class	hidden_range_info_t
	Describes a hidden range. More...
struct	hidden_range_t
	Hidden ranges - address ranges which can be replaced by their descriptions. More...

Functions
idaman bool ida_export	get_hidden_range_info (hidden_range_info_t *hri, ea_t ea)
	Get hidden range information by address.
idaman bool ida_export	get_hidden_range_info_by_num (hidden_range_info_t *hri, int n)
	Get hidden range information by number.
idaman bool ida_export	update_hidden_range_info (const hidden_range_info_t *hri)
	Update hidden range information in the database.
idaman ea_t ida_export	get_first_hidden_range_ea (void)
	Get start address of the first hidden range.
idaman ea_t ida_export	get_last_hidden_range_ea (void)
	Get start address of the last hidden range.
idaman ea_t ida_export	get_next_hidden_range_ea (ea_t ea)
	Get start address of the next hidden range.
idaman ea_t ida_export	get_prev_hidden_range_ea (ea_t ea)
	Get start address of the previous hidden range.
idaman bool ida_export	add_hidden_range (ea_t ea1, ea_t ea2, const char *description, const char *header, const char *footer, bgcolor_t color=DEFCOLOR)
	Mark a range of addresses as hidden.
idaman int ida_export	get_hidden_range_qty (void)
	Get number of hidden ranges.
idaman int ida_export	get_hidden_range_num (ea_t ea)
	Get number of a hidden range.
idaman bool ida_export	del_hidden_range (ea_t ea)
	Delete hidden range.
idaman DEPRECATED bool ida_export	update_hidden_range (const hidden_range_t *ha)
idaman DEPRECATED hidden_range_t *ida_export	get_hidden_range (ea_t ea)
idaman DEPRECATED hidden_range_t *ida_export	getn_hidden_range (int n)
idaman DEPRECATED hidden_range_t *ida_export	get_prev_hidden_range (ea_t ea)
idaman DEPRECATED hidden_range_t *ida_export	get_next_hidden_range (ea_t ea)
idaman DEPRECATED hidden_range_t *ida_export	get_first_hidden_range (void)
idaman DEPRECATED hidden_range_t *ida_export	get_last_hidden_range (void)

Detailed Description

Hidden ranges - address ranges which can be replaced by their descriptions.

There is also a possibility to hide individual items completely (nalt.hpp, hide_item).

Function Documentation

get_hidden_range_info()

idaman bool ida_export get_hidden_range_info	(	hidden_range_info_t *	hri,
		ea_t	ea )

Get hidden range information by address.

Parameters

hri	pointer to output buffer, may be nullptr
ea	any address in the hidden range

Returns

true if a hidden range was found at the given address

get_hidden_range_info_by_num()

idaman bool ida_export get_hidden_range_info_by_num	(	hidden_range_info_t *	hri,
		int	n )

Get hidden range information by number.

Parameters

hri	pointer to output buffer, may be nullptr
n	number of hidden range, is in range 0..get_hidden_range_qty()-1

Returns

true if a hidden range with the given number exists

update_hidden_range_info()

idaman bool ida_export update_hidden_range_info

(

const hidden_range_info_t *

hri

)

Update hidden range information in the database.

You cannot use this function to change the range boundaries. Uses start_ea to identify the range, applies only modified fields.

Parameters

hri	range info to update

Returns

success

get_first_hidden_range_ea()

idaman ea_t ida_export get_first_hidden_range_ea

(

void

)

Get start address of the first hidden range.

Returns

start_ea of the first hidden range, or BADADDR

get_last_hidden_range_ea()

idaman ea_t ida_export get_last_hidden_range_ea

(

void

)

Get start address of the last hidden range.

Returns

start_ea of the last hidden range, or BADADDR

get_next_hidden_range_ea()

idaman ea_t ida_export get_next_hidden_range_ea

(

ea_t

ea

)

Get start address of the next hidden range.

Parameters

ea	any address in the program

Returns

start_ea of the next hidden range, or BADADDR

get_prev_hidden_range_ea()

idaman ea_t ida_export get_prev_hidden_range_ea

(

ea_t

ea

)

Get start address of the previous hidden range.

Parameters

ea	any address in the program

Returns

start_ea of the previous hidden range, or BADADDR

add_hidden_range()

idaman bool ida_export add_hidden_range	(	ea_t	ea1,
		ea_t	ea2,
		const char *	description,
		const char *	header,
		const char *	footer,
		bgcolor_t	color = DEFCOLOR )

Mark a range of addresses as hidden.

The range will be created in the invisible state with the default color

Parameters

ea1	linear address of start of the address range
ea2	linear address of end of the address range
description,header,footer	range parameters
color	the range color

Returns

success

get_hidden_range_qty()

idaman int ida_export get_hidden_range_qty

(

void

)

Get number of hidden ranges.

get_hidden_range_num()

idaman int ida_export get_hidden_range_num

(

ea_t

ea

)

Get number of a hidden range.

Parameters

ea	any address in the hidden range

Returns

number of hidden range (0..get_hidden_range_qty()-1)

del_hidden_range()

idaman bool ida_export del_hidden_range

(

ea_t

ea

)

Delete hidden range.

Parameters

ea	any address in the hidden range

Returns

success

update_hidden_range()

idaman DEPRECATED bool ida_export update_hidden_range

(

const hidden_range_t *

ha

)

Deprecated

Use update_hidden_range_info() instead.

get_hidden_range()

idaman DEPRECATED hidden_range_t *ida_export get_hidden_range

(

ea_t

ea

)

Deprecated

Use get_hidden_range_info() instead.

getn_hidden_range()

idaman DEPRECATED hidden_range_t *ida_export getn_hidden_range

(

int

n

)

Deprecated

Use get_hidden_range_info_by_num() instead.

get_prev_hidden_range()

idaman DEPRECATED hidden_range_t *ida_export get_prev_hidden_range

(

ea_t

ea

)

Deprecated

Use get_prev_hidden_range_ea() instead.

get_next_hidden_range()

idaman DEPRECATED hidden_range_t *ida_export get_next_hidden_range

(

ea_t

ea

)

Deprecated

Use get_next_hidden_range_ea() instead.

get_first_hidden_range()

idaman DEPRECATED hidden_range_t *ida_export get_first_hidden_range

(

void

)

Deprecated

Use get_first_hidden_range_ea() instead.

get_last_hidden_range()

idaman DEPRECATED hidden_range_t *ida_export get_last_hidden_range

(

void

)

Deprecated

Use get_last_hidden_range_ea() instead.