kernwin.hpp File Reference

Detailed Description

Defines the interface between the kernel and the UI.

It contains:

• the UI dispatcher notification codes (ui_notification_t)
• convenience functions for UI services
• structures which hold information about the lines (disassembly, structures, enums) generated by the kernel
• functions to interact with the user (dialog boxes)
• some string and conversion functions.

Classes
union	callui_t
	Callui return codes. More...
class	place_t
	Denotes a displayed line. More...
struct	simpleline_t
	Maintain basic information for a line in a custom view. More...
class	simpleline_place_t
	A location in a view populated by a strvec_t. More...
class	idaplace_t
	A location in a disassembly view. More...
class	enumplace_t
	A location in an enum view. More...
class	structplace_t
	A location in a struct view. More...
struct	hexplace_gen_t
class	hexplace_t
class	sync_source_t
struct	synced_group_t
class	twinpos_t
	A position in a text window. More...
class	twinline_t
	A line in a text window. More...
class	linearray_t
	The group of lines corresponding to a single place within a view. More...
struct	lines_rendering_input_t
	Contains information necessary for plugins to compute extra information needed for rendering. More...
struct	line_rendering_output_entry_t
struct	lines_rendering_output_t
struct	chooser_item_attrs_t
	Chooser item attributes. More...
struct	chooser_base_t
	Chooser object. #chooser. More...
struct	chooser_t
	The chooser object without multi-selection. More...
struct	chooser_t::cbret_t
	Return value of ins(), del(), edit(), enter(), refresh() callbacks. More...
struct	chooser_multi_t
	The chooser object with multi-selection. More...
struct	textctrl_info_t
	Multi line text control, used to embed a text control in a form. More...
struct	renderer_pos_info_t
	Information about a position relative to the renderer. More...
union	view_mouse_event_location_t
	Abstraction of location in flat view/graph views (out of 'view_mouse_event_t' to make it easy for SWiG to wrap) More...
struct	view_mouse_event_t
	Information about a mouse action within a view. More...
class	locchange_md_t
struct	input_event_t
	A representation of a user input. More...
struct	input_event_t::input_event_shortcut_data_t
struct	input_event_t::input_event_keyboard_data_t
struct	input_event_t::input_event_mouse_data_t
struct	cli_t
	Command line interpreter. More...
struct	exec_request_t
	Execute code in the main thread - to be used with execute_sync(). More...
class	ui_request_t
	Base class for defining UI requests. More...
class	ui_requests_t
	List of UI requests. More...
struct	action_ctx_base_cur_sel_t
union	action_ctx_base_source_t
struct	action_ctx_base_t
	Maintain information about the current state of the UI. More...
struct	action_handler_t
	Manages the behavior of a registered action. More...
struct	action_desc_t
	Describe an action to be registered (see register_action()) More...
class	custom_viewer_handlers_t
struct	__qtimer_t
	Timer opaque handle. More...
struct	range_marker_suspender_t
	Ignores range_marker during the lifetime of the object. More...
struct	form_actions_t
	Functions available from formchgcb_t. More...
struct	addon_info_t
	Information about an installed add-on (e.g. a plugin) More...
struct	strarray_t
	Map strings to integer values - see strarray() More...

Functions
idaman int ida_export	init_database (int argc, const char *const *argv, int *newfile)
	After calling init_kernel() the ui must call this function. More...
idaman void ida_export	term_database (void)
	The database termination function. More...
idaman NORETURN void ida_export	verror (const char *format, va_list va)
	See error()
idaman void ida_export	vshow_hex (const void *dataptr, size_t len, const char *format, va_list va)
	See show_hex()
idaman void ida_export	vshow_hex_file (linput_t *li, int64 pos, size_t count, const char *format, va_list va)
	See show_hex_file()
ssize_t	get_kernel_version (char *buf, size_t bufsize)
	Get IDA kernel version (in a string like "5.1").
idaman int ida_export	l_compare (const place_t *t1, const place_t *t2)
	compare places and their lnnums
idaman int ida_export	l_compare2 (const place_t *t1, const place_t *t2, void *ud)
idaman void ida_export	hexplace_t__out_one_item (const hexplace_t *_this, outctx_base_t &ctx, const hexplace_gen_t *hg, int itemno, color_t *color, color_t patch_or_edit)
idaman size_t ida_export	hexplace_t__ea2str (char *buf, size_t bufsize, const hexplace_gen_t *hg, ea_t ea)
idaman int ida_export	internal_register_place_class (const place_t *tmplate, int flags, const plugin_t *owner, int sdk_version)
int	register_place_class (const place_t *tmplate, int flags, const plugin_t *owner)
	Register information about a place_t class. More...
idaman const place_t *ida_export	get_place_class (int *out_flags, int *out_sdk_version, int id)
	Get information about a previously-registered place_t class. More...
const place_t *	get_place_class_template (int id)
	See get_place_class()
bool	is_place_class_ea_capable (int id)
	See get_place_class()
idaman int ida_export	get_place_class_id (const char *name)
	Get the place class ID for the place that has been registered as 'name'. More...
	CASSERT (sizeof(sync_source_t)==16)
idaman void ida_export	register_loc_converter2 (const char *p1, const char *p2, lochist_entry_cvt2_t *cvt)
	Register a converter, that will be used for the following reasons: More...
idaman lochist_entry_cvt2_t *ida_export	lookup_loc_converter2 (const char *p1, const char *p2)
	Search for a place converter from lochist_entry_t's with places of type 'p1' to lochist_entry_t's with places of type 'p2'. More...
idaman uint64 ida_export	get_dirty_infos (void)
	Bitmask of builtin window types to be refreshed:
idaman void ida_export	request_refresh (uint64 mask, bool cnd=true)
	Request a refresh of a builtin window. More...
void	clear_refresh_request (uint64 mask)
idaman bool ida_export	is_refresh_requested (uint64 mask)
	Get a refresh request state. More...
bool	is_chooser_widget (twidget_type_t t)
	Does the given widget type specify a chooser widget?
int	ida_deb (const char *format,...)
	Display debug message. More...
void	show_hex (const void *dataptr, size_t len, const char *format,...)
	Display hex dump in the messages window.
void	show_hex_file (linput_t *li, int64 pos, size_t count, const char *format,...)
	Display hex dump of a file in the messages window.

Chooser title
prefixes to be used in the chooser title
#define	CHOOSER_NOMAINMENU   "NOMAINMENU\n"
	do not display main menu
#define	CHOOSER_NOSTATUSBAR   "NOSTATUSBAR\n"
	do not display status bar (obsolete. Use CH_NO_STATUS_BAR instead)
#define	VES_SHIFT   (1 << 0)
	state & 1 => Shift is pressed state & 2 => Alt is pressed state & 4 => Ctrl is pressed state & 8 => Mouse left button is pressed state & 16 => Mouse right button is pressed state & 32 => Mouse middle button is pressed state & 128 => Meta is pressed (OSX only)
#define	VES_ALT   (1 << 1)
#define	VES_CTRL   (1 << 2)
#define	VES_MOUSE_LEFT   (1 << 3)
#define	VES_MOUSE_RIGHT   (1 << 4)
#define	VES_MOUSE_MIDDLE   (1 << 5)
#define	VES_META   (1 << 7)
#define	LCMD_SYNC   (1 << 0)
#define	MFF_FAST   0x0000
	Execute code as soon as possible. More...
#define	MFF_READ   0x0001
	Execute code only when ida is idle and it is safe to query the database. More...
#define	MFF_WRITE   0x0002
	Execute code only when ida is idle and it is safe to modify the database. More...
#define	MFF_NOWAIT   0x0004
	Do not wait for the request to be executed. More...
#define	UIJMP_ACTIVATE   0x0001
	activate the new window
#define	UIJMP_DONTPUSH   0x0002
	do not remember the current address in the navigation history
#define	UIJMP_VIEWMASK   0x000C
#define	UIJMP_ANYVIEW   0x0000
	jump in any ea_t-capable view
#define	UIJMP_IDAVIEW   0x0004
	jump in idaview
#define	UIJMP_IDAVIEW_NEW   0x0008
	jump in new idaview
#define	AHF_VERSION   1
	action handler version (used by action_handler_t::flags)
#define	AHF_VERSION_MASK   0xFF
	mask for action_handler_t::flags
#define	ACTION_DESC_LITERAL_PLUGMOD(name, label, handler, plgmod, shortcut, tooltip, icon)    { sizeof(action_desc_t), name, label, handler, plgmod, shortcut, tooltip, icon, ADF_OT_PLUGMOD }
	Get an action_desc_t instance with the provided plugmod_t as the owner This is meant for plugins.
#define	ACTION_DESC_LITERAL_PROCMOD(name, label, handler, prcmod, shortcut, tooltip, icon)    { sizeof(action_desc_t), name, label, handler, prcmod, shortcut, tooltip, icon, ADF_OT_PROCMOD }
	Get an action_desc_t instance with the provided procmod_t as the owner This is meant for processor modules implementing processor_t::ev_get_procmod.
#define	ACTION_DESC_LITERAL_OWNER(name, label, handler, owner, shortcut, tooltip, icon, flags)    { sizeof(action_desc_t), name, label, handler, owner, shortcut, tooltip, icon, flags }
	Get an action_desc_t instance with a given owner and flags.
#define	DYNACTION_DESC_LITERAL(label, handler, shortcut, tooltip, icon)    { sizeof(action_desc_t), nullptr, label, handler, nullptr, shortcut, tooltip, icon, ADF_OWN_HANDLER }
	For attach_dynamic_action_to_popup() only.
#define	ASKBTN_YES   1
	Yes button.
#define	ASKBTN_NO   0
	No button.
#define	ASKBTN_CANCEL   -1
	Cancel button.
#define	ASKBTN_BTN1   1
	First (Yes) button.
#define	ASKBTN_BTN2   0
	Second (No) button.
#define	ASKBTN_BTN3   -1
	Third (Cancel) button.
#define	HIST_SEG   1
	segment names
#define	HIST_CMT   2
	comments
#define	HIST_SRCH   3
	search substrings
#define	HIST_IDENT   4
	names
#define	HIST_FILE   5
	file names
#define	HIST_TYPE   6
	type declarations
#define	HIST_CMD   7
	commands
#define	HIST_DIR   8
	directory names (text version only)
#define	CLNL_RTRIM   (1 << 0)
	Remove trailing space characters.
#define	CLNL_LTRIM   (1 << 1)
	Remove leading space characters.
#define	CLNL_FINDCMT   (1 << 2)
	Search for the comment symbol everywhere in the line, not only at the beginning.
#define	CLNL_TRIM   (CLNL_RTRIM|CLNL_LTRIM)
#define	S2EAOPT_NOCALC   0x00000001
	don't try to interpret string as IDC (or current extlang) expression
#define	MAX_NUMBUF   (128+8)
	16-byte value in binary base (0b00101010...)
#define	b2a   b2a32
	shortcut for number->string conversion, see b2a32()
#define	btoa   btoa32
	shortcut for number->string conversion, see btoa32()
#define	atob   atob32
	shortcut for string->number conversion, see atob32()
#define	IK_CANCEL   0x03
#define	IK_BACK   0x08
#define	IK_TAB   0x09
#define	IK_CLEAR   0x0C
#define	IK_RETURN   0x0D
#define	IK_SHIFT   0x10
#define	IK_CONTROL   0x11
#define	IK_MENU   0x12
#define	IK_PAUSE   0x13
#define	IK_CAPITAL   0x14
#define	IK_KANA   0x15
#define	IK_ESCAPE   0x1B
#define	IK_MODECHANGE   0x1F
#define	IK_SPACE   0x20
#define	IK_PRIOR   0x21
#define	IK_NEXT   0x22
#define	IK_END   0x23
#define	IK_HOME   0x24
#define	IK_LEFT   0x25
#define	IK_UP   0x26
#define	IK_RIGHT   0x27
#define	IK_DOWN   0x28
#define	IK_SELECT   0x29
#define	IK_PRINT   0x2A
#define	IK_EXECUTE   0x2B
#define	IK_SNAPSHOT   0x2C
#define	IK_INSERT   0x2D
#define	IK_DELETE   0x2E
#define	IK_HELP   0x2F
#define	IK_LWIN   0x5B
#define	IK_RWIN   0x5C
#define	IK_APPS   0x5D
#define	IK_SLEEP   0x5F
#define	IK_NUMPAD0   0x60
#define	IK_NUMPAD1   0x61
#define	IK_NUMPAD2   0x62
#define	IK_NUMPAD3   0x63
#define	IK_NUMPAD4   0x64
#define	IK_NUMPAD5   0x65
#define	IK_NUMPAD6   0x66
#define	IK_NUMPAD7   0x67
#define	IK_NUMPAD8   0x68
#define	IK_NUMPAD9   0x69
#define	IK_MULTIPLY   0x6A
#define	IK_ADD   0x6B
#define	IK_SEPARATOR   0x6C
#define	IK_SUBTRACT   0x6D
#define	IK_DECIMAL   0x6E
#define	IK_DIVIDE   0x6F
#define	IK_F1   0x70
#define	IK_F2   0x71
#define	IK_F3   0x72
#define	IK_F4   0x73
#define	IK_F5   0x74
#define	IK_F6   0x75
#define	IK_F7   0x76
#define	IK_F8   0x77
#define	IK_F9   0x78
#define	IK_F10   0x79
#define	IK_F11   0x7A
#define	IK_F12   0x7B
#define	IK_F13   0x7C
#define	IK_F14   0x7D
#define	IK_F15   0x7E
#define	IK_F16   0x7F
#define	IK_F17   0x80
#define	IK_F18   0x81
#define	IK_F19   0x82
#define	IK_F20   0x83
#define	IK_F21   0x84
#define	IK_F22   0x85
#define	IK_F23   0x86
#define	IK_F24   0x87
#define	IK_NUMLOCK   0x90
#define	IK_SCROLL   0x91
#define	IK_OEM_FJ_MASSHOU   0x93
#define	IK_OEM_FJ_TOUROKU   0x94
#define	IK_LSHIFT   0xA0
#define	IK_RSHIFT   0xA1
#define	IK_LCONTROL   0xA2
#define	IK_RCONTROL   0xA3
#define	IK_LMENU   0xA4
#define	IK_RMENU   0xA5
#define	IK_BROWSER_BACK   0xA6
#define	IK_BROWSER_FORWARD   0xA7
#define	IK_BROWSER_REFRESH   0xA8
#define	IK_BROWSER_STOP   0xA9
#define	IK_BROWSER_SEARCH   0xAA
#define	IK_BROWSER_FAVORITES   0xAB
#define	IK_BROWSER_HOME   0xAC
#define	IK_VOLUME_MUTE   0xAD
#define	IK_VOLUME_DOWN   0xAE
#define	IK_VOLUME_UP   0xAF
#define	IK_MEDIA_NEXT_TRACK   0xB0
#define	IK_MEDIA_PREV_TRACK   0xB1
#define	IK_MEDIA_STOP   0xB2
#define	IK_MEDIA_PLAY_PAUSE   0xB3
#define	IK_LAUNCH_MAIL   0xB4
#define	IK_LAUNCH_MEDIA_SELECT   0xB5
#define	IK_LAUNCH_APP1   0xB6
#define	IK_LAUNCH_APP2   0xB7
#define	IK_OEM_1   0xBA
#define	IK_OEM_PLUS   0xBB
#define	IK_OEM_COMMA   0xBC
#define	IK_OEM_MINUS   0xBD
#define	IK_OEM_PERIOD   0xBE
#define	IK_OEM_2   0xBF
#define	IK_OEM_3   0xC0
#define	IK_OEM_4   0xDB
#define	IK_OEM_5   0xDC
#define	IK_OEM_6   0xDD
#define	IK_OEM_7   0xDE
#define	IK_OEM_102   0xE2
#define	IK_PLAY   0xFA
#define	IK_ZOOM   0xFB
#define	IK_OEM_CLEAR   0xFE
enum	navaddr_type_t {   nat_lib = 0 , nat_fun , nat_cod , nat_dat ,   nat_und , nat_ext , nat_err , nat_gap ,   nat_cur , nat_auto , nat_lum , nat_hlo ,   nat_last }
enum	custom_viewer_handler_id_t {   CVH_USERDATA , CVH_KEYDOWN , CVH_POPUP , CVH_DBLCLICK ,   CVH_CURPOS , CVH_CLOSE , CVH_CLICK , CVH_QT_AWARE ,   CVH_HELP , CVH_MOUSEMOVE , CDVH_USERDATA = 1000 , CDVH_SRCVIEW ,   CDVH_LINES_CLICK , CDVH_LINES_DBLCLICK , CDVH_LINES_POPUP , CDVH_LINES_DRAWICON ,   CDVH_LINES_LINENUM , CDVH_LINES_ICONMARGIN , CDVH_LINES_RADIX , CDVH_LINES_ALIGNMENT }
	Custom viewer & code viewer handler types. More...
enum	msg_notification_t {   msg_activated , msg_deactivated , msg_click , msg_dblclick ,   msg_closed , msg_keydown }
	Notification codes for events in the message window. More...
enum	view_notification_t {   view_activated , view_deactivated , view_keydown , view_click ,   view_dblclick , view_curpos , view_created , view_close ,   view_switched , view_mouse_over , view_loc_changed , view_mouse_moved }
	Notification codes sent by the UI for IDAView or custom viewer events. More...
enum	locchange_reason_t {   lcr_unknown , lcr_goto , lcr_user_switch , lcr_auto_switch ,   lcr_jump , lcr_navigate , lcr_scroll , lcr_internal }
enum	input_event_kind_t {   iek_unknown = 0 , iek_shortcut , iek_key_press , iek_key_release ,   iek_mouse_button_press , iek_mouse_button_release , iek_mouse_wheel }
enum	action_state_t {   AST_ENABLE_ALWAYS , AST_ENABLE_FOR_IDB , AST_ENABLE_FOR_WIDGET , AST_ENABLE ,   AST_DISABLE_ALWAYS , AST_DISABLE_FOR_IDB , AST_DISABLE_FOR_WIDGET , AST_DISABLE }
	Action states - returned by action_handler_t::update() More...
enum	action_attr_t {   AA_NONE , AA_LABEL , AA_SHORTCUT , AA_TOOLTIP ,   AA_ICON , AA_STATE , AA_CHECKABLE , AA_CHECKED ,   AA_VISIBILITY }
	Codes for getting/setting action attributes. More...
enum	cb_id {   CB_INIT = -1 , CB_YES = -2 , CB_CLOSE = -3 , CB_INVISIBLE = -4 ,   CB_DESTROYING = -5 }
	Enumeration of form callback special values.
typedef uint32 idaapi	nav_colorizer_t(ea_t ea, asize_t nbytes, void *ud)
	Navigation band colorizer function. More...
typedef int	input_event_modifiers_t
typedef input_event_modifiers_t	view_event_state_t
typedef bool idaapi	custom_viewer_keydown_t(TWidget *cv, int vk_key, int shift, void *ud)
	The user has pressed a key.
typedef void idaapi	custom_viewer_popup_t(TWidget *cv, void *ud)
	The user right clicked. See ui_populating_widget_popup, too.
typedef void idaapi	custom_viewer_mouse_moved_t(TWidget *cv, int shift, view_mouse_event_t *e, void *ud)
	The user moved the mouse.
typedef bool idaapi	custom_viewer_click_t(TWidget *cv, int shift, void *ud)
	The user clicked.
typedef bool idaapi	custom_viewer_dblclick_t(TWidget *cv, int shift, void *ud)
	The user double clicked.
typedef void idaapi	custom_viewer_curpos_t(TWidget *cv, void *ud)
	Deprecated. More...
typedef void idaapi	custom_viewer_close_t(TWidget *cv, void *ud)
	Custom viewer is being destroyed.
typedef int idaapi	custom_viewer_help_t(TWidget *cv, void *ud)
	Custom viewer: the user pressed F1 If the return value != -1, it is treated as a help context to display (from ida.hlp)
typedef void idaapi	custom_viewer_adjust_place_t(TWidget *v, lochist_entry_t *loc, void *ud)
	Fine-tune 'loc->place()' according to the X position (i.e., 'loc->renderer_info().pos.cx') More...
typedef int idaapi	custom_viewer_get_place_xcoord_t(TWidget *v, const place_t *pline, const place_t *pitem, void *ud)
	Does the line pointed to by pline include pitem, and if so at what X coordinate? More...
typedef int idaapi	custom_viewer_can_navigate_t(TWidget *v, const lochist_entry_t *now, const locchange_md_t &md, void *ud)
	The user asked to navigate to the given location. More...
typedef void idaapi	custom_viewer_location_changed_t(TWidget *v, const lochist_entry_t *was, const lochist_entry_t *now, const locchange_md_t &md, void *ud)
	The viewer's location (i.e., place, or cursor) changed.
typedef void idaapi	code_viewer_lines_click_t(TWidget *c, const place_t *p, int pos, int shift, void *ud)
	The user clicked, right clicked or double clicked. More...
typedef int idaapi	code_viewer_lines_icon_t(TWidget *cv, const place_t *p, int *pos, void *ud)
	Icon drawing. More...
typedef bool idaapi	code_viewer_lines_linenum_t(TWidget *cv, const place_t *p, uval_t *num, void *ud)
	Calculate the line number. Return false to not print any number.
typedef void idaapi	ss_restore_cb_t(const char *errmsg, void *ud)
	Snapshot restoration completion callback. see restore_database_snapshot()
typedef uval_t	const_t
typedef action_ctx_base_t	action_activation_ctx_t
	Instances of this class will be filled with information that is commonly used by actions when they need to be activated. More...
typedef action_ctx_base_t	action_update_ctx_t
	Instances of this class will be filled with information that is commonly used by actions when they need to update. More...
typedef struct __qtimer_t *	qtimer_t
	Timer opaque handle.
typedef int idaapi	formchgcb_t(int field_id, form_actions_t &fa)
	Callback. More...
typedef int idaapi	buttoncb_t(int button_code, form_actions_t &fa)
	Callback. More...
void(idaapi *	range_marker )(ea_t ea, asize_t size)
	Pointer to range marker function (for idaviews and hexviews) This pointer is initialized by setup_range_marker()
idaman bool ida_export_data	batch
	If this variable is set, then dialog boxes will not appear on the screen. More...
idaman int ida_export_data	errorexit
	Exiting because of a a fatal error? Is non-zero if we are exiting with from the error() function. More...
ssize_t	choose (chooser_base_t *ch, const void *def_item)
	Display a generic list chooser (n-column) and allow the user to select an item. More...
void	set_nav_colorizer (nav_colorizer_t **out_was_func, void **out_was_ud, nav_colorizer_t *func, void *ud)
	Install new navigation band colorizer (ui_set_nav_colorizer).
	CASSERT (sizeof(locchange_md_t)==sizeof(uint32))
bool	is_action_enabled (action_state_t s)
	Check if the given action state is one of AST_ENABLE*.
THREAD_SAFE int	execute_ui_requests (ui_requests_t *reqs)
	Execute a list of UI requests (ui_execute_ui_requests_list). More...
THREAD_SAFE int	execute_ui_requests (ui_request_t *req,...)
	Execute a variable number of UI requests (ui_execute_ui_requests). More...
THREAD_SAFE bool	cancel_exec_request (int req_id)
	Try to cancel an asynchronous exec request (ui_cancel_exec_request). More...
THREAD_SAFE int	cancel_thread_exec_requests (qthread_t tid)
	Try to cancel asynchronous exec requests created by the specified thread. More...
const synced_group_t *	get_synced_group (const TWidget *w)
	Get the group of widgets/registers this view is synchronized with. More...
bool	jumpto (ea_t ea, int opnum=-1, int uijmp_flags=UIJMP_ACTIVATE)
	Jump to the specified address (ui_jumpto). More...
bool	banner (int wait)
	Show a banner dialog box (ui_banner). More...
THREAD_SAFE bool	is_msg_inited (void)
	Can we use msg() functions?
void	refresh_idaview (void)
	Refresh marked windows (ui_refreshmarked)
void	refresh_idaview_anyway (void)
	Refresh all disassembly views (ui_refresh), forces an immediate refresh. More...
void	analyzer_options (void)
	Allow the user to set analyzer options. (show a dialog box) (ui_analyzer_options)
ea_t	get_screen_ea (void)
	Get the address at the screen cursor (ui_screenea)
int	get_opnum (void)
	Get current operand number, -1 means no operand (ui_get_opnum)
bool	get_cursor (int *x, int *y)
	Get the cursor position on the screen (ui_get_cursor). More...
bool	get_output_cursor (int *x, int *y)
	Get coordinates of the output window's cursor (ui_get_output_cursor). More...
const char *	get_curline (void)
	Get current line from the disassemble window (ui_get_curline). More...
void	open_url (const char *url)
	Open the given url (ui_open_url)
ea_t	get_hexdump_ea (int hexdump_num)
	Get the current address in a hex view. More...
ushort	get_key_code (const char *keyname)
	Get keyboard key code by its name (ui_get_key_code)
ushort	lookup_key_code (int key, int shift, bool is_qt)
	Get shortcut code previously created by ui_get_key_code. More...
void	refresh_navband (bool force)
	Refresh navigation band if changed (ui_refresh_navband). More...
bool	refresh_chooser (const char *title)
	Mark a non-modal custom chooser for a refresh (ui_refresh_chooser). More...
bool	close_chooser (const char *title)
	Close a non-modal chooser (ui_close_chooser). More...
void	install_command_interpreter (const cli_t *cp)
	Install command line interpreter (ui_install_cli)
void	remove_command_interpreter (const cli_t *cp)
	Remove command line interpreter (ui_install_cli)
void	gen_disasm_text (text_t &text, ea_t ea1, ea_t ea2, bool truncate_lines)
	Generate disassembly text for a range. More...
THREAD_SAFE int	execute_sync (exec_request_t &req, int reqf)
	Execute code in the main thread. More...
bool	set_dock_pos (const char *src_ctrl, const char *dest_ctrl, int orient, int left=0, int top=0, int right=0, int bottom=0)
	Set the docking position of a widget (ui_set_dock_pos). More...
int	load_custom_icon (const char *file_name)
	Load an icon from a file (ui_load_custom_icon_file). More...
int	load_custom_icon (const void *ptr, unsigned int len, const char *format)
	Load an icon and return its id (ui_load_custom_icon). More...
void	free_custom_icon (int icon_id)
	Free an icon loaded with load_custom_icon() (ui_free_custom_icon).
bool	process_ui_action (const char *name, int flags=0, void *param=nullptr)
	Processes a UI action by name. More...
bool	take_database_snapshot (snapshot_t *ss, qstring *err_msg)
	Take a database snapshot (ui_take_database_snapshot). More...
bool	restore_database_snapshot (const snapshot_t *ss, ss_restore_cb_t *cb, void *ud)
	Restore a database snapshot. More...
THREAD_SAFE qtimer_t	register_timer (int interval_ms, int(idaapi *callback)(void *ud), void *ud)
	Register a timer (ui_register_timer). More...
THREAD_SAFE bool	unregister_timer (qtimer_t t)
	Unregister a timer (ui_unregister_timer). More...
bool	register_action (const action_desc_t &desc)
	Create a new action (ui_register_action). More...
bool	unregister_action (const char *name)
	Delete a previously-registered action (ui_unregister_action). More...
void	get_registered_actions (qstrvec_t *out)
	Get a list of all currently-registered actions. More...
bool	create_toolbar (const char *name, const char *label, const char *before=nullptr, int flags=0)
	Create a toolbar with the given name, label and optional position. More...
bool	delete_toolbar (const char *name)
	Delete an existing toolbar. More...
bool	create_menu (const char *name, const char *label, const char *menupath=nullptr)
	Create a menu with the given name, label and optional position, either in the menubar, or as a submenu. More...
bool	delete_menu (const char *name)
	Delete an existing menu. More...
bool	attach_action_to_menu (const char *menupath, const char *name, int flags=0)
	Attach a previously-registered action to the menu (ui_attach_action_to_menu). More...
bool	detach_action_from_menu (const char *menupath, const char *name)
	Detach an action from the menu (ui_detach_action_from_menu). More...
bool	attach_action_to_toolbar (const char *toolbar_name, const char *name)
	Attach an action to an existing toolbar (ui_attach_action_to_toolbar). More...
bool	detach_action_from_toolbar (const char *toolbar_name, const char *name)
	Detach an action from the toolbar (ui_detach_action_from_toolbar). More...
bool	register_and_attach_to_menu (const char *menupath, const char *name, const char *label, const char *shortcut, int flags, action_handler_t *handler, void *owner, int action_desc_t_flags)
	Helper. More...
void	display_widget (TWidget *widget, uint32 options, const char *dest_ctrl=nullptr)
	Display a widget, dock it if not done before. More...
void	close_widget (TWidget *widget, int options)
	Close widget (ui_close_widget, only gui version). More...
void	activate_widget (TWidget *widget, bool take_focus)
	Activate widget (only gui version) (ui_activate_widget). More...
TWidget *	find_widget (const char *caption)
	Find widget with the specified caption (only gui version) (ui_find_widget). More...
TWidget *	get_current_widget (void)
	Get a pointer to the current widget (ui_get_current_widget).
twidget_type_t	get_widget_type (TWidget *widget)
	Get the type of the TWidget * (ui_get_widget_type).
bool	get_widget_title (qstring *buf, TWidget *widget)
	Get the TWidget's title (ui_get_widget_title).
TWidget *	create_custom_viewer (const char *title, const place_t *minplace, const place_t *maxplace, const place_t *curplace, const renderer_info_t *rinfo, void *ud, const custom_viewer_handlers_t *cvhandlers, void *cvhandlers_ud, TWidget *parent=nullptr)
	Create new ida viewer based on place_t (ui_create_custom_viewer). More...
bool	custom_viewer_jump (TWidget *v, const lochist_entry_t &loc, uint32 flags=0)
	Append 'loc' to the viewer's history, and cause the viewer to display it. More...
bool	ea_viewer_history_push_and_jump (TWidget *v, ea_t ea, int x, int y, int lnnum)
	Push current location in the history and jump to the given location (ui_ea_viewer_history_push_and_jump). More...
bool	get_ea_viewer_history_info (int *nback, int *nfwd, TWidget *v)
	Get information about what's in the history (ui_ea_viewer_history_info). More...
void	refresh_custom_viewer (TWidget *custom_viewer)
	Refresh custom ida viewer (ui_refresh_custom_viewer)
void	repaint_custom_viewer (TWidget *custom_viewer)
	Repaint the given widget immediately (ui_repaint_qwidget)
void	destroy_custom_viewer (TWidget *custom_viewer)
	Destroy custom ida viewer.
bool	jumpto (TWidget *custom_viewer, place_t *place, int x, int y)
	Set cursor position in custom ida viewer. More...
place_t *	get_custom_viewer_place (TWidget *custom_viewer, bool mouse, int *x, int *y)
	Get current place in a custom viewer (ui_get_curplace). More...
bool	get_custom_viewer_location (lochist_entry_t *out, TWidget *custom_viewer, bool mouse=false)
	Get the current location in a custom viewer (ui_get_custom_viewer_location).
bool	is_idaq ()
	Are we running inside IDA Qt?
bool	attach_action_to_popup (TWidget *widget, TPopupMenu *popup_handle, const char *name, const char *popuppath=nullptr, int flags=0)
	Insert a previously-registered action into the widget's popup menu (ui_attach_action_to_popup). More...
bool	detach_action_from_popup (TWidget *widget, const char *name)
	Remove a previously-registered action, from the list of 'permanent' context menu actions for this widget (ui_detach_action_from_popup). More...
bool	attach_dynamic_action_to_popup (TWidget *widget, TPopupMenu *popup_handle, const action_desc_t &desc, const char *popuppath=nullptr, int flags=0, qstring *buf=nullptr)
	Create & insert an action into the widget's popup menu (ui_attach_dynamic_action_to_popup). More...
bool	update_action_label (const char *name, const char *label)
	Update an action's label (ui_update_action_attr). More...
bool	update_action_shortcut (const char *name, const char *shortcut)
	Update an action's shortcut (ui_update_action_attr). More...
bool	update_action_tooltip (const char *name, const char *tooltip)
	Update an action's tooltip (ui_update_action_attr). More...
bool	update_action_icon (const char *name, int icon)
	Update an action's icon (ui_update_action_attr). More...
bool	update_action_state (const char *name, action_state_t state)
	Update an action's state (ui_update_action_attr). More...
bool	update_action_checkable (const char *name, bool checkable)
	Update an action's checkability (ui_update_action_attr). More...
bool	update_action_checked (const char *name, bool checked)
	Update an action's checked state (ui_update_action_attr). More...
bool	update_action_visibility (const char *name, bool visible)
	Update an action's visibility (ui_update_action_attr). More...
bool	get_action_label (qstring *label, const char *name)
	Get an action's label (ui_get_action_attr). More...
bool	get_action_shortcut (qstring *shortcut, const char *name)
	Get an action's shortcut (ui_get_action_attr). More...
bool	get_action_tooltip (qstring *tooltip, const char *name)
	Get an action's tooltip (ui_get_action_attr). More...
bool	get_action_icon (const char *name, int *icon)
	Get an action's icon (ui_get_action_attr). More...
bool	get_action_state (const char *name, action_state_t *state)
	Get an action's state (ui_get_action_attr). More...
bool	get_action_checkable (const char *name, bool *checkable)
	Get an action's checkability (ui_get_action_attr). More...
bool	get_action_checked (const char *name, bool *checked)
	Get an action's checked state (ui_get_action_attr). More...
bool	get_action_visibility (const char *name, bool *visibility)
	Get an action's visibility (ui_get_action_attr). More...
void	set_custom_viewer_handlers (TWidget *custom_viewer, const custom_viewer_handlers_t *cvh, void *cvh_ud)
	Set handlers for custom viewer events Any of these handlers may be nullptr.
void *	set_custom_viewer_handler (TWidget *custom_viewer, custom_viewer_handler_id_t handler_id, void *handler_or_data)
	Set a handler for a custom viewer event (ui_set_custom_viewer_handler). More...
bool	set_custom_viewer_qt_aware (TWidget *custom_viewer)
	Allow the given viewer to interpret Qt events (ui_set_custom_viewer_handler)
const char *	get_custom_viewer_curline (TWidget *custom_viewer, bool mouse)
	Get current line of custom viewer (ui_get_custom_viewer_curline). More...
int	get_custom_viewer_place_xcoord (TWidget *custom_viewer, const place_t *pline, const place_t *pitem)
	Get the X position of the item, in the line. More...
bool	get_user_input_event (input_event_t *out)
	Get the current user input event (mouse button press, key press, ...) It is sometimes desirable to be able to tell when a certain situation happens (e.g., 'view_curpos' gets triggered); this function exists to provide that context (GUI version only) More...
bool	get_output_curline (qstring *buf, bool mouse)
	Get current line of output window (ui_get_output_curline). More...
bool	get_output_selected_text (qstring *buf)
	Returns selected text from output window (ui_get_output_selected_text). More...
TWidget *	get_current_viewer (void)
	Get current ida viewer (idaview or custom viewer) (ui_get_current_viewer)
tcc_renderer_type_t	get_view_renderer_type (TWidget *v)
	Get the type of renderer currently in use in the given view (ui_get_renderer_type)
void	set_view_renderer_type (TWidget *v, tcc_renderer_type_t rt)
	Set the type of renderer to use in a view (ui_set_renderer_type)
void	set_custom_viewer_range (TWidget *custom_viewer, const place_t *minplace, const place_t *maxplace)
	Set position range for custom viewer (ui_set_custom_viewer_range)
TWidget *	create_empty_widget (const char *title, int icon=-1)
	Create an empty widget, serving as a container for custom user widgets.
void	msg_clear ()
	Clear the "Output" window.
bool	msg_save (qstring &path)
	Save the "Output" window contents into a file. More...
void	msg_get_lines (qstrvec_t *out, int count=-1)
	Retrieve the last 'count' lines from the output window, in reverse order (from most recent, to least recent) More...
TWidget *	get_active_modal_widget (void)
	Get the current, active modal TWidget instance. More...
int	get_navband_pixel (bool *out_is_vertical, ea_t ea)
	Translate the provided ea_t, into its pixel position (plus pixel ranges) on the navigation band. More...
ea_t	get_navband_ea (int pixel)
	Translate the pixel position on the navigation band, into an address.
void *	get_window_id (const char *name=nullptr)
	Get the system-specific window ID (GUI version only) More...
bool	is_idaview (TWidget *v)
	Is the given custom view an idaview? (ui_is_idaview)
bool	read_selection (TWidget *v, twinpos_t *p1, twinpos_t *p2)
	Get the selected range boundaries (ui_read_selection). More...
bool	read_range_selection (TWidget *v, ea_t *ea1, ea_t *ea2)
	Get the address range for the selected range boundaries, this is the convenient function for read_selection() More...
void	unmark_selection (void)
	Unmark selection (ui_unmarksel)
TWidget *	create_code_viewer (TWidget *custview, int flags=0, TWidget *parent=nullptr)
	Create a code viewer (ui_create_code_viewer). More...
void *	set_code_viewer_handler (TWidget *code_viewer, custom_viewer_handler_id_t handler_id, void *handler_or_data)
	Set a handler for a code viewer event (ui_set_custom_viewer_handler). More...
bool	set_code_viewer_user_data (TWidget *code_viewer, void *ud)
	Set the user data on a code viewer (ui_set_custom_viewer_handler).
void *	get_viewer_user_data (TWidget *viewer)
	Get the user data from a custom viewer (ui_get_viewer_user_data)
tcc_place_type_t	get_viewer_place_type (TWidget *viewer)
	Get the type of place_t instances a viewer uses & creates (ui_get_viewer_place_type).
void	set_code_viewer_line_handlers (TWidget *code_viewer, code_viewer_lines_click_t *click_handler, code_viewer_lines_click_t *popup_handler, code_viewer_lines_click_t *dblclick_handler, code_viewer_lines_icon_t *drawicon_handler, code_viewer_lines_linenum_t *linenum_handler)
	Set handlers for code viewer line events. More...
bool	set_code_viewer_lines_icon_margin (TWidget *code_viewer, int margin)
	Set space allowed for icons in the margin of a code viewer (ui_set_custom_viewer_handler).
bool	set_code_viewer_lines_alignment (TWidget *code_viewer, int align)
	Set alignment for lines in a code viewer (ui_set_custom_viewer_handler).
bool	set_code_viewer_lines_radix (TWidget *code_viewer, int radix)
	Set radix for values displayed in a code viewer (ui_set_custom_viewer_handler).
bool	set_code_viewer_is_source (TWidget *code_viewer)
	Specify that the given code viewer is used to display source code (ui_set_custom_viewer_handler).
int	get_tab_size (const char *path)
	Get the size of a tab in spaces (ui_get_tab_size). More...
THREAD_SAFE void	clr_cancelled (void)
	Clear "Cancelled" flag (ui_clr_cancelled)
THREAD_SAFE void	set_cancelled (void)
	Set "Cancelled" flag (ui_set_cancelled)
THREAD_SAFE bool	user_cancelled (void)
	Test the ctrl-break flag (ui_test_cancelled). More...
bool	ui_load_new_file (qstring *temp_file, qstring *filename, linput_t **pli, ushort neflags, load_info_t **ploaders)
	Display a load file dialog and load file (ui_load_file). More...
bool	ui_run_debugger (const char *dbgopts, const char *exename, int argc, const char *const *argv)
	Load a debugger plugin and run the specified program (ui_run_dbg). More...
bool	load_dbg_dbginfo (const char *path, linput_t *li=nullptr, ea_t base=BADADDR, bool verbose=false)
	Load debugging information from a file. More...
int	add_idc_hotkey (const char *hotkey, const char *idcfunc)
	Add hotkey for IDC function (ui_add_idckey). More...
bool	get_highlight (qstring *out_str, TWidget *viewer, uint32 *out_flags, uint32 flags=0)
	Get the highlighted identifier in the viewer (ui_get_highlight_2). More...
bool	set_highlight (TWidget *viewer, const char *str, int flags)
	Set the highlighted identifier in the viewer (ui_set_highlight). More...
void	setup_range_marker (void)
	Initialize pointer to idaview marker.
void	mark_range_for_refresh (ea_t ea, asize_t size)
	Inform the UI about any modifications of [ea, ea+size)
void	mark_all_eaviews_for_refresh (void)
	Tell UI to refresh all idaviews and hexviews.
TWidget *	open_exports_window (ea_t ea)
	Open the exports window (ui_open_builtin). More...
TWidget *	open_imports_window (ea_t ea)
	Open the exports window (ui_open_builtin). More...
TWidget *	open_names_window (ea_t ea)
	Open the names window (ui_open_builtin). More...
TWidget *	open_funcs_window (ea_t ea)
	Open the 'Functions' window (ui_open_builtin). More...
TWidget *	open_strings_window (ea_t ea, ea_t selstart=BADADDR, ea_t selend=BADADDR)
	Open the 'Strings' window (ui_open_builtin). More...
TWidget *	open_segments_window (ea_t ea)
	Open the segments window (ui_open_builtin). More...
TWidget *	open_segregs_window (ea_t ea)
	Open the segment registers window (ui_open_builtin). More...
TWidget *	open_selectors_window (void)
	Open the selectors window (ui_open_builtin). More...
TWidget *	open_signatures_window (void)
	Open the signatures window (ui_open_builtin). More...
TWidget *	open_tils_window (void)
	Open the type libraries window (ui_open_builtin). More...
TWidget *	open_loctypes_window (int ordinal)
	Open the local types window (ui_open_builtin). More...
TWidget *	open_calls_window (ea_t ea)
	Open the function calls window (ui_open_builtin). More...
TWidget *	open_problems_window (ea_t ea)
	Open the problems window (ui_open_builtin). More...
TWidget *	open_bpts_window (ea_t ea)
	Open the breakpoints window (ui_open_builtin). More...
TWidget *	open_threads_window (void)
	Open the threads window (ui_open_builtin). More...
TWidget *	open_modules_window (void)
	Open the modules window (ui_open_builtin). More...
TWidget *	open_trace_window (void)
	Open the tracing window (ui_open_builtin). More...
TWidget *	open_stack_window (void)
	Open the call stack window (ui_open_builtin). More...
TWidget *	open_xrefs_window (ea_t ea)
	Open the cross references window (ui_open_builtin). More...
TWidget *	open_frame_window (func_t *pfn, uval_t offset)
	Open the frame window for the given function (ui_open_builtin). More...
TWidget *	open_navband_window (ea_t ea, int zoom)
	Open the navigation band window (ui_open_builtin). More...
TWidget *	open_enums_window (tid_t const_id=BADADDR)
	Open the enums window (ui_open_builtin). More...
TWidget *	open_structs_window (tid_t id=BADADDR, uval_t offset=0)
	Open the structs window (ui_open_builtin). More...
TWidget *	open_disasm_window (const char *window_title, const rangevec_t *ranges=nullptr)
	Open a disassembly view (ui_open_builtin). More...
TWidget *	open_hexdump_window (const char *window_title)
	Open a hexdump view (ui_open_builtin). More...
TWidget *	open_notepad_window (void)
	Open the notepad window (ui_open_builtin). More...
TWidget *	open_bookmarks_window (TWidget *w)
	Open the bookmarks window (ui_open_builtin). More...
bool	sync_sources (const sync_source_t &what, const sync_source_t &with, bool sync)
	[Un]synchronize sources More...
char *	choose_idasgn (void)
	Choose a signature (ui_choose, chtype_idasgn). More...
bool	choose_til (qstring *buf)
	Choose a type library (ui_choose, chtype_idatil). More...
ea_t	choose_entry (const char *title)
	Choose an entry point (ui_choose, chtype_entry). More...
ea_t	choose_name (const char *title)
	Choose a name (ui_choose, chtype_name). More...
ea_t	choose_stkvar_xref (func_t *pfn, member_t *mptr)
	Choose an xref to a stack variable (ui_choose, chtype_name). More...
ea_t	choose_xref (ea_t to)
	Choose an xref to an address (ui_choose, chtype_xref). More...
enum_t	choose_enum (const char *title, enum_t default_id)
	Choose an enum (ui_choose, chtype_enum). More...
enum_t	choose_enum_by_value (const char *title, enum_t default_id, uint64 value, int nbytes, uchar *serial)
	Choose an enum, restricted by value & size (ui_choose, chtype_enum_by_value_and_size). More...
func_t *	choose_func (const char *title, ea_t default_ea)
	Choose a function (ui_choose, chtype_func). More...
segment_t *	choose_segm (const char *title, ea_t default_ea)
	Choose a segment (ui_choose, chtype_segm). More...
struc_t *	choose_struc (const char *title)
	Choose a structure (ui_choose, chtype_segm). More...
sreg_range_t *	choose_srcp (const char *title)
	Choose a segment register change point (ui_choose, chtype_srcp). More...
int	choose_struc_path (const char *title, tid_t strid, uval_t offset, adiff_t delta, bool appzero, tid_t *path)
	Get path to a structure offset (for nested structures/enums) (ui_choose, chtype_strpath).
void *	get_chooser_obj (const char *chooser_caption)
	Get the underlying object of the specified chooser (ui_get_chooser_obj). More...
bool	get_chooser_data (qstrvec_t *out, const char *chooser_caption, int n)
	Get the text corresponding to the index N in the chooser data. More...
bool idaapi	enable_chooser_item_attrs (const char *chooser_caption, bool enable)
	Enable item-specific attributes for chooser items (ui_enable_chooser_item_attrs). More...
THREAD_SAFE void	show_wait_box_v (const char *format, va_list va)
	See show_wait_box()
THREAD_SAFE void	show_wait_box (const char *format,...)
	Display a dialog box with "Please wait...". More...
THREAD_SAFE void	hide_wait_box (void)
	Hide the "Please wait dialog box".
THREAD_SAFE void	replace_wait_box (const char *format,...)
	Replace the label of "Please wait dialog box".
void	beep (beep_t beep_type=beep_default)
	Issue a beeping sound (ui_beep). More...
bool	display_copyright_warning (void)
	Display copyright warning (ui_copywarn). More...
THREAD_SAFE void	ask_for_feedback (const char *format,...)
	Show a message box asking to send the input file to suppo.nosp@m.rt@h.nosp@m.ex-ra.nosp@m.ys.c.nosp@m.om. More...
bool	ask_addr (ea_t *addr, const char *format,...)
	Output a formatted string to the output window (msg) preprended with "**DATABASE IS CORRUPTED: ". More...
bool	ask_seg (sel_t *sel, const char *format,...)
	Display a dialog box and wait for the user to input an segment name (ui_ask_seg). More...
bool	ask_long (sval_t *value, const char *format,...)
	Display a dialog box and wait for the user to input an number (ui_ask_long). More...
THREAD_SAFE NORETURN void	error (const char *format,...)
	Display error dialog box and exit. More...
THREAD_SAFE void	vwarning (const char *format, va_list va)
	Display warning dialog box and wait for the user to press Enter or Esc. More...
THREAD_SAFE void	warning (const char *format,...)
THREAD_SAFE void	vinfo (const char *format, va_list va)
	Display info dialog box and wait for the user to press Enter or Esc. More...
THREAD_SAFE void	info (const char *format,...)
THREAD_SAFE NORETURN void	vnomem (const char *format, va_list va)
	Display "no memory for module ..." dialog box and exit. More...
THREAD_SAFE NORETURN void	nomem (const char *format,...)
THREAD_SAFE int	vmsg (const char *format, va_list va)
	Output a formatted string to the output window [analog of printf()]. More...
THREAD_SAFE int	msg (const char *format,...)
int	vask_form (const char *format, va_list va)
	See ask_form()
int	ask_form (const char *form,...)
	Display a dialog box and wait for the user. More...
TWidget *	vopen_form (const char *format, uint32 flags, va_list va)
	Create and/or activate dockable modeless form (ui_open_form). More...
TWidget *	open_form (const char *form, uint32 flags,...)
	Display a dockable modeless dialog box and return a handle to it. More...
THREAD_SAFE int	vask_buttons (const char *Yes, const char *No, const char *Cancel, int deflt, const char *format, va_list va)
int	vask_yn (int deflt, const char *format, va_list va)
int	ask_yn (int deflt, const char *format,...)
	Display a dialog box and get choice from "Yes", "No", "Cancel". More...
int	ask_buttons (const char *Yes, const char *No, const char *Cancel, int deflt, const char *format,...)
	Display a dialog box and get choice from maximum three possibilities (ui_ask_buttons). More...
bool	vask_str (qstring *str, int hist, const char *format, va_list va)
	Display a dialog box and wait for the user to input a text string (ui_ask_str). More...
bool	ask_str (qstring *str, int hist, const char *format,...)
bool	ask_ident (qstring *str, const char *format,...)
	Display a dialog box and wait for the user to input an identifier. More...
bool	vask_text (qstring *answer, size_t max_size, const char *defval, const char *format, va_list va)
	Display a dialog box and wait for the user to input multiline text (ui_ask_text). More...
bool	ask_text (qstring *answer, size_t max_size, const char *defval, const char *format,...)
char *	vask_file (bool for_saving, const char *defval, const char *format, va_list va)
	Display a dialog box and wait for the user to input a file name (ui_ask_file). More...
char *	ask_file (bool for_saving, const char *defval, const char *format,...)
int	register_addon (const addon_info_t *info)
	Register an add-on. More...
int	addon_count ()
	Get number of installed addons.
bool	get_addon_info (const char *id, addon_info_t *info)
	Get info about a registered addon with a given product code. More...
bool	get_addon_info_idx (int index, addon_info_t *info)
	Get info about a registered addon with specific index. More...
idaman THREAD_SAFE char *ida_export	add_spaces (char *str, size_t bufsize, ssize_t len)
	Add space characters to the colored string so that its length will be at least 'len' characters. More...
idaman THREAD_SAFE char *ida_export	trim (char *str)
	Remove trailing space characters from a string. More...
idaman THREAD_SAFE const char *ida_export	skip_spaces (const char *ptr)
	Skip whitespaces in the string. More...
char *	skip_spaces (char *ptr)
idaman THREAD_SAFE ssize_t ida_export	qcleanline (qstring *buf, char cmt_char='\0', uint32 flags=CLNL_TRIM|CLNL_FINDCMT)
	Performs some cleanup operations to a line. More...
idaman THREAD_SAFE const char *ida_export	strarray (const strarray_t *array, size_t array_size, int code)
	Find a line with the specified code in the strarray_t array. More...
idaman size_t ida_export	ea2str (char *buf, size_t bufsize, ea_t ea)
	Convert linear address to UTF-8 string.
bool	ea2str (qstring *out, ea_t ea)
	Convert linear address to UTF-8 string.
idaman bool ida_export	str2ea (ea_t *ea_ptr, const char *str, ea_t screen_ea)
	Convert string to linear address. More...
idaman bool ida_export	str2ea_ex (ea_t *ea_ptr, const char *str, ea_t screen_ea, int flags)
	Same as str2ea() but possibly with some steps skipped. More...
idaman bool ida_export	atoea (ea_t *pea, const char *str)
	Convert a number in C notation to an address. More...
idaman size_t ida_export	stoa (qstring *buf, ea_t from, sel_t seg)
	Convert segment selector to UTF-8 string.
idaman int ida_export	atos (sel_t *seg, const char *str)
	Convert UTF-8 string to segment selector. More...
idaman size_t ida_export	b2a_width (int nbytes, int radix)
	Get the number of UTF-8 characters required to represent a number with the specified number of bytes and radix. More...
idaman size_t ida_export	b2a32 (char *buf, size_t bufsize, uint32 x, int nbytes, int radix)
	Convert number to UTF-8 string (includes leading zeroes). More...
idaman size_t ida_export	b2a64 (char *buf, size_t bufsize, uint64 x, int nbytes, int radix)
	Same as b2a32(), but can handle 'nbytes' = 8.
idaman size_t ida_export	btoa_width (int nbytes, flags_t flag, int n)
	Get max number of UTF-8 characters required to represent a given type of value, with a given size (without leading zeroes). More...
idaman size_t ida_export	btoa32 (char *buf, size_t bufsize, uint32 x, int radix=0)
	Same as b2a32(), but will generate a string without any leading zeroes. More...
idaman size_t ida_export	btoa64 (char *buf, size_t bufsize, uint64 x, int radix=0)
	64-bit equivalent of btoa32()
idaman size_t ida_export	btoa128 (char *buf, size_t bufsize, uint128 x, int radix=0)
	128-bit equivalent of btoa32()
idaman size_t ida_export	numop2str (char *buf, size_t bufsize, ea_t ea, int n, uint64 x, int nbytes, int radix=0)
	Convert instruction operand immediate number to UTF-8. More...
idaman bool ida_export	atob32 (uint32 *x, const char *str)
	Convert UTF-8 to a number using the current assembler formats. More...
idaman bool ida_export	atob64 (uint64 *x, const char *str)
	64-bit equivalent of atob32()
idaman void ida_export	append_disp (qstring *buf, adiff_t disp, bool tag=true)
	Auxiliary function. More...
idaman THREAD_SAFE int ida_export	r50_to_asc (char *p, const ushort *r, int k)
	Convert RADIX50 -> UTF-8. More...
int THREAD_SAFE	asc_to_r50 (ushort *r, const char *p, int k)
	Convert UTF-8 -> RADIX50 (see r50_to_asc())
idaman THREAD_SAFE uint32 ida_export	calc_crc32 (uint32 crc, const void *buf, size_t len)
	Calculate CRC32 (polynom 0xEDB88320, zlib compatible). More...
idaman THREAD_SAFE uint32 ida_export	calc_file_crc32 (linput_t *fp)
	Calculate an input source CRC32.
idaman int ida_export	regex_match (const char *str, const char *pattern, bool sense_case)
	Match a string with a regular expression. More...
void	place_t__serialize (const place_t *_this, bytevec_t *out)
bool	place_t__deserialize (place_t *_this, const uchar **pptr, const uchar *end)

Macros
#define	SETMENU_POSMASK   0x3
#define	SETMENU_INS   0x0
	add menu item before the specified path (default)
#define	SETMENU_APP   0x1
	add menu item after the specified path
#define	SETMENU_FIRST   0x2
	add item to the beginning of menu
#define	SETMENU_IF_ENABLED   0x4
	add item only if it is enabled (prevents unusable, greyed-out items)
#define	CREATETB_ADV   0x1
	toolbar is for 'advanced mode' only
#define	HIF_IDENTIFIER   0x1
	text is an identifier (i.e., when searching for the current highlight, SEARCH_IDENT will be used)
#define	HIF_REGISTER   0x2
	text represents a register (aliases/subregisters will be highlit as well)
#define	HIF_LOCKED   0x4
	locked; clicking/moving the cursor around doesn't change the highlight
#define	HIF_NOCASE   0x8
	case insensitive
#define	HIF_USE_SLOT   (1 << 27)
	use the given number, or just use the "floating" highlight
#define	HIF_SLOT_SHIFT   28
	position of the 3 top bits specifying which highlight to use
#define	HIF_GET_SLOT(flags)   (((flags) >> HIF_SLOT_SHIFT) & 0x7)
	retrieve the highlight number to use (if HIF_USE_SLOT)
#define	HIF_SLOT_0   (HIF_USE_SLOT | (0 << HIF_SLOT_SHIFT))
	operate on slot 0
#define	HIF_SLOT_1   (HIF_USE_SLOT | (1 << HIF_SLOT_SHIFT))
	operate on slot 1
#define	HIF_SLOT_2   (HIF_USE_SLOT | (2 << HIF_SLOT_SHIFT))
	operate on slot 2
#define	HIF_SLOT_3   (HIF_USE_SLOT | (3 << HIF_SLOT_SHIFT))
	operate on slot 3
#define	HIF_SLOT_4   (HIF_USE_SLOT | (4 << HIF_SLOT_SHIFT))
	operate on slot 4
#define	HIF_SLOT_5   (HIF_USE_SLOT | (5 << HIF_SLOT_SHIFT))
	operate on slot 5
#define	HIF_SLOT_6   (HIF_USE_SLOT | (6 << HIF_SLOT_SHIFT))
	operate on slot 6
#define	HIF_SLOT_7   (HIF_USE_SLOT | (7 << HIF_SLOT_SHIFT))
	operate on slot 7
#define	REG_HINTS_MARKER   SCOLOR_ON "\x7F"
#define	REG_HINTS_MARKER_LEN   2
#define	SRCDBG_HINTS_MARKER   SCOLOR_ON "\x7E"
#define	SRCDBG_HINTS_MARKER_LEN   2
#define	CDVF_NOLINES   0x0001
	don't show line numbers
#define	CDVF_LINEICONS   0x0002
	icons can be drawn over the line control
#define	CDVF_STATUSBAR   0x0004
	keep the status bar in the custom viewer
#define	IDCHK_OK   0
	ok
#define	IDCHK_ARG   -1
	bad argument(s)
#define	IDCHK_KEY   -2
	bad hotkey name
#define	IDCHK_MAX   -3
	too many IDC hotkeys
#define	WCLS_SAVE   0x1
	save state in desktop config
#define	WCLS_NO_CONTEXT   0x2
	don't change the current context (useful for toolbars)
#define	WCLS_DONT_SAVE_SIZE   0x4
	don't save size of the window
#define	WCLS_DELETE_LATER   0x8
	assign the deletion of the widget to the UI loop ///< More...
#define	WCLS_CLOSE_LATER   WCLS_DELETE_LATER
#define	DP_LEFT   0x0001
	Dock src_form to the left of dest_form.
#define	DP_TOP   0x0002
	Dock src_form above dest_form.
#define	DP_RIGHT   0x0004
	Dock src_form to the right of dest_form.
#define	DP_BOTTOM   0x0008
	Dock src_form below dest_form.
#define	DP_INSIDE   0x0010
	Create a new tab bar with both src_form and dest_form.
#define	DP_TAB   0x0040
	Place src_form into a tab next to dest_form, if dest_form is in a tab bar (otherwise the same as DP_INSIDE)
#define	DP_BEFORE   0x0020
	Place src_form before dst_form in the tab bar instead of after; used with DP_INSIDE or DP_TAB. More...
#define	DP_FLOATING   0x0080
	Make src_form floating.
#define	DP_SZHINT   0x0100
	When floating or in a splitter (i.e., not tabbed), use the widget's size hint to determine the best geometry (Qt only)
#define	CDVF_NOLINES   0x0001
	don't show line numbers
#define	CDVF_LINEICONS   0x0002
	icons can be drawn over the line control
#define	CDVF_STATUSBAR   0x0004
	keep the status bar in the custom viewer
#define	SVF_COPY_LINES   0x0000
	keep a local copy of '*lines'
#define	SVF_LINES_BYPTR   0x0001
	remember the 'lines' ptr. do not make a copy of '*lines'
#define	CVNF_LAZY   (1 << 0)
	try and move the cursor to a line displaying the place_t if possible. More...
#define	CVNF_JUMP   (1 << 1)
	push the current position in this viewer's lochist_t before going to the new location
#define	CVNF_ACT   (1 << 2)
	activate (i.e., switch to) the viewer. More...
#define	WOPN_RESTORE   0x00000004u
	if the widget was the only widget in a floating area the last time it was closed, it will be restored as floating, with the same position+size as before
#define	WOPN_PERSIST   0x00000040u
	widget will remain available when starting or stopping debugger sessions
#define	WOPN_CLOSED_BY_ESC   0x00000080u
	override idagui.cfg:CLOSED_BY_ESC: esc will close
#define	WOPN_NOT_CLOSED_BY_ESC   0x00000100u
	override idagui.cfg:CLOSED_BY_ESC: esc will not close
#define	WOPN_DP_MASK   0x0FFF0000u
#define	WOPN_DP_SHIFT   16
#define	WOPN_DP_LEFT   (DP_LEFT << WOPN_DP_SHIFT)
	Dock widget to the left of dest_ctrl.
#define	WOPN_DP_TOP   (DP_TOP << WOPN_DP_SHIFT)
	Dock widget above dest_ctrl.
#define	WOPN_DP_RIGHT   (DP_RIGHT << WOPN_DP_SHIFT)
	Dock widget to the right of dest_ctrl.
#define	WOPN_DP_BOTTOM   (DP_BOTTOM << WOPN_DP_SHIFT)
	Dock widget below dest_ctrl.
#define	WOPN_DP_INSIDE   (DP_INSIDE << WOPN_DP_SHIFT)
	Create a new tab bar with both widget and dest_ctrl.
#define	WOPN_DP_TAB   (DP_TAB << WOPN_DP_SHIFT)
	Place widget into a tab next to dest_ctrl, if dest_ctrl is in a tab bar (otherwise the same as WOPN_DP_INSIDE)
#define	WOPN_DP_BEFORE   (DP_BEFORE << WOPN_DP_SHIFT)
	Place widget before dst_form in the tab bar instead of after; used with WOPN_DP_INSIDE and WOPN_DP_TAB.
#define	WOPN_DP_FLOATING   (DP_FLOATING << WOPN_DP_SHIFT)
	Make widget floating.
#define	WOPN_DP_SZHINT   (DP_SZHINT << WOPN_DP_SHIFT)
	when floating or in a splitter (i.e., not tabbed), use the widget's size hint to determine the best geometry (Qt only)
#define	WOPN_DP_INSIDE_BEFORE   (WOPN_DP_INSIDE | WOPN_DP_BEFORE)
#define	WOPN_DP_TAB_BEFORE   (WOPN_DP_TAB | WOPN_DP_BEFORE)
#define	WOPN_GET_DP(v)   (((v) & WOPN_DP_MASK) >> WOPN_DP_SHIFT)
#define	RENADDR_IDA   0
	dialog for "IDA View"
#define	RENADDR_HR   1
	dialog for "Pseudocode"; additional flags: More...
#define	DEFAULT_PLACE_LNNUM   -1
#define	define_place_exported_functions(classname)
	Helper to define exported functions for place_t implementations. More...
#define	define_place_virtual_functions(class)
	Helper to define virtual functions in place_t implementations.
#define	HEXPLACE_COLOR_EDITED   COLOR_SYMBOL
#define	HEXPLACE_COLOR_PATCHED   COLOR_VOIDOP
#define	HEXPLACE_COLOR_SHOWSPACES   COLOR_RESERVED1
#define	PCF_EA_CAPABLE   0x00000001
	toea() implementation returns meaningful data
#define	PCF_MAKEPLACE_ALLOCATES   0x00000002
	makeplace() returns a freshly allocated (i.e., non-static) instance. More...
#define	LECVT_WITHIN_LISTING   0x1
#define	DECLARE_LINEARRAY_HELPERS(decl)
	Helper for declaring member functions of the linearray_t class. More...
#define	CK_TRACE   80
	traced address
#define	CK_TRACE_OVL   81
	overlay trace address
#define	CK_EXTRA1   82
	extra background overlay #1
#define	CK_EXTRA2   83
	extra background overlay #2
#define	CK_EXTRA3   84
	extra background overlay #3
#define	CK_EXTRA4   85
	extra background overlay #4
#define	CK_EXTRA5   86
	extra background overlay #5
#define	CK_EXTRA6   87
	extra background overlay #6
#define	CK_EXTRA7   88
	extra background overlay #7
#define	CK_EXTRA8   89
	extra background overlay #8
#define	CK_EXTRA9   90
	extra background overlay #9
#define	CK_EXTRA10   91
	extra background overlay #10
#define	CK_EXTRA11   92
	extra background overlay #11
#define	CK_EXTRA12   93
	extra background overlay #12
#define	CK_EXTRA13   94
	extra background overlay #13
#define	CK_EXTRA14   95
	extra background overlay #14
#define	CK_EXTRA15   96
	extra background overlay #15
#define	CK_EXTRA16   97
	extra background overlay #16
#define	LROEF_MASK   0x00FFFFFF
#define	LROEF_FULL_LINE   0x00000000
	full line background
#define	LROEF_CPS_RANGE   0x00000001
	background for range of chars
#define	BWN_UNKNOWN   -1
	unknown window
#define	BWN_EXPORTS   0
	exports
#define	BWN_IMPORTS   1
	imports
#define	BWN_NAMES   2
	names
#define	BWN_FUNCS   3
	functions
#define	BWN_STRINGS   4
	strings
#define	BWN_SEGS   5
	segments
#define	BWN_SEGREGS   6
	segment registers
#define	BWN_SELS   7
	selectors
#define	BWN_SIGNS   8
	signatures
#define	BWN_TILS   9
	type libraries
#define	BWN_LOCTYPS   10
	local types
#define	BWN_CALLS   11
	function calls
#define	BWN_PROBS   12
	problems
#define	BWN_BPTS   13
	breakpoints
#define	BWN_THREADS   14
	threads
#define	BWN_MODULES   15
	modules
#define	BWN_TRACE   16
	tracing view
#define	BWN_CALL_STACK   17
	call stack
#define	BWN_XREFS   18
	xrefs
#define	BWN_SEARCH   19
	search results
#define	BWN_FRAME   25
	function frame
#define	BWN_NAVBAND   26
	navigation band
#define	BWN_ENUMS   27
	enumerations
#define	BWN_STRUCTS   28
	structures
#define	BWN_DISASM   29
	disassembly views
#define	BWN_DUMP   30
	hex dumps
#define	BWN_NOTEPAD   31
	notepad
#define	BWN_OUTPUT   32
	the text area, in the output window
#define	BWN_CLI   33
	the command-line, in the output window
#define	BWN_WATCH   34
	the 'watches' debugger window
#define	BWN_LOCALS   35
	the 'locals' debugger window
#define	BWN_STKVIEW   36
	the 'Stack view' debugger window
#define	BWN_CHOOSER   37
	a non-builtin chooser
#define	BWN_SHORTCUTCSR   38
	the shortcuts chooser (Qt version only)
#define	BWN_SHORTCUTWIN   39
	the shortcuts window (Qt version only)
#define	BWN_CPUREGS   40
	one of the 'General registers', 'FPU register', ... debugger windows
#define	BWN_SO_STRUCTS   41
	the 'Structure offsets' dialog's 'Structures and Unions' panel
#define	BWN_SO_OFFSETS   42
	the 'Structure offsets' dialog's offset panel
#define	BWN_CMDPALCSR   43
	the command palette chooser (Qt version only)
#define	BWN_CMDPALWIN   44
	the command palette window (Qt version only)
#define	BWN_SNIPPETS   45
	the 'Execute script' window
#define	BWN_CUSTVIEW   46
	custom viewers
#define	BWN_ADDRWATCH   47
	the 'Watch List' window
#define	BWN_PSEUDOCODE   48
	hexrays decompiler views
#define	BWN_CALLS_CALLERS   49
	function calls, callers
#define	BWN_CALLS_CALLEES   50
	function calls, callees
#define	BWN_MDVIEWCSR   51
	lumina metadata view chooser
#define	BWN_DISASM_ARROWS   52
	disassembly arrows widget
#define	BWN_CV_LINE_INFOS   53
	custom viewers' lineinfo widget
#define	BWN_SRCPTHMAP_CSR   54
	"Source paths..."'s path mappings chooser
#define	BWN_SRCPTHUND_CSR   55
	"Source paths..."'s undesired paths chooser
#define	BWN_UNDOHIST   56
	Undo history.
#define	BWN_SNIPPETS_CSR   57
	the list of snippets in the 'Execute script' window
#define	BWN_SCRIPTS_CSR   58
	the "Recent scripts" chooser
#define	BWN_BOOKMARKS   59
	a persistent 'Bookmarks' widget
#define	BWN_STACK   BWN_CALL_STACK
	Alias. More...
#define	BWN_DISASMS   BWN_DISASM
	Alias. More...
#define	BWN_DUMPS   BWN_DUMP
	Alias. More...
#define	BWN_SEARCHS   BWN_SEARCH
	Alias. More...
#define	IWID_EXPORTS   (1ULL << BWN_EXPORTS )
	exports (0)
#define	IWID_IMPORTS   (1ULL << BWN_IMPORTS )
	imports (1)
#define	IWID_NAMES   (1ULL << BWN_NAMES )
	names (2)
#define	IWID_FUNCS   (1ULL << BWN_FUNCS )
	functions (3)
#define	IWID_STRINGS   (1ULL << BWN_STRINGS )
	strings (4)
#define	IWID_SEGS   (1ULL << BWN_SEGS )
	segments (5)
#define	IWID_SEGREGS   (1ULL << BWN_SEGREGS )
	segment registers (6)
#define	IWID_SELS   (1ULL << BWN_SELS )
	selectors (7)
#define	IWID_SIGNS   (1ULL << BWN_SIGNS )
	signatures (8)
#define	IWID_TILS   (1ULL << BWN_TILS )
	type libraries (9)
#define	IWID_LOCTYPS   (1ULL << BWN_LOCTYPS )
	local types (10)
#define	IWID_CALLS   (1ULL << BWN_CALLS )
	function calls (11)
#define	IWID_PROBS   (1ULL << BWN_PROBS )
	problems (12)
#define	IWID_BPTS   (1ULL << BWN_BPTS )
	breakpoints (13)
#define	IWID_THREADS   (1ULL << BWN_THREADS )
	threads (14)
#define	IWID_MODULES   (1ULL << BWN_MODULES )
	modules (15)
#define	IWID_TRACE   (1ULL << BWN_TRACE )
	tracing view (16)
#define	IWID_CALL_STACK   (1ULL << BWN_CALL_STACK )
	call stack (17)
#define	IWID_XREFS   (1ULL << BWN_XREFS )
	xrefs (18)
#define	IWID_SEARCH   (1ULL << BWN_SEARCH )
	search results (19)
#define	IWID_FRAME   (1ULL << BWN_FRAME )
	function frame (25)
#define	IWID_NAVBAND   (1ULL << BWN_NAVBAND )
	navigation band (26)
#define	IWID_ENUMS   (1ULL << BWN_ENUMS )
	enumerations (27)
#define	IWID_STRUCTS   (1ULL << BWN_STRUCTS )
	structures (28)
#define	IWID_DISASM   (1ULL << BWN_DISASM )
	disassembly views (29)
#define	IWID_DUMP   (1ULL << BWN_DUMP )
	hex dumps (30)
#define	IWID_NOTEPAD   (1ULL << BWN_NOTEPAD )
	notepad (31)
#define	IWID_OUTPUT   (1ULL << BWN_OUTPUT )
	output (32)
#define	IWID_CLI   (1ULL << BWN_CLI )
	input line (33)
#define	IWID_WATCH   (1ULL << BWN_WATCH )
	watches (34)
#define	IWID_LOCALS   (1ULL << BWN_LOCALS )
	locals (35)
#define	IWID_STKVIEW   (1ULL << BWN_STKVIEW )
	stack view (36)
#define	IWID_CHOOSER   (1ULL << BWN_CHOOSER )
	chooser (37)
#define	IWID_SHORTCUTCSR   (1ULL << BWN_SHORTCUTCSR )
	shortcuts chooser (38)
#define	IWID_SHORTCUTWIN   (1ULL << BWN_SHORTCUTWIN )
	shortcuts window (39)
#define	IWID_CPUREGS   (1ULL << BWN_CPUREGS )
	registers (40)
#define	IWID_SO_STRUCTS   (1ULL << BWN_SO_STRUCTS )
	stroff (41)
#define	IWID_SO_OFFSETS   (1ULL << BWN_SO_OFFSETS )
	stroff (42)
#define	IWID_CMDPALCSR   (1ULL << BWN_CMDPALCSR )
	command palette (43)
#define	IWID_CMDPALWIN   (1ULL << BWN_CMDPALWIN )
	command palette (44)
#define	IWID_SNIPPETS   (1ULL << BWN_SNIPPETS )
	snippets (45)
#define	IWID_CUSTVIEW   (1ULL << BWN_CUSTVIEW )
	custom viewers (46)
#define	IWID_ADDRWATCH   (1ULL << BWN_ADDRWATCH )
	address watches (47)
#define	IWID_PSEUDOCODE   (1ULL << BWN_PSEUDOCODE )
	decompiler (48)
#define	IWID_CALLS_CALLERS   (1ULL << BWN_CALLS_CALLERS)
	funcalls, callers (49)
#define	IWID_CALLS_CALLEES   (1ULL << BWN_CALLS_CALLEES)
	funcalls, callees (50)
#define	IWID_MDVIEWCSR   (1ULL << BWN_MDVIEWCSR )
	lumina md view (51)
#define	IWID_DISASM_ARROWS   (1ULL << BWN_DISASM_ARROWS)
	arrows widget (52)
#define	IWID_CV_LINE_INFOS   (1ULL << BWN_CV_LINE_INFOS)
	lineinfo widget (53)
#define	IWID_SRCPTHMAP_CSR   (1ULL << BWN_SRCPTHMAP_CSR)
	mappings chooser (54)
#define	IWID_SRCPTHUND_CSR   (1ULL << BWN_SRCPTHUND_CSR)
	undesired chooser (55)
#define	IWID_UNDOHIST   (1ULL << BWN_UNDOHIST )
	Undo history (56)
#define	IWID_SNIPPETS_CSR   (1ULL << BWN_SNIPPETS_CSR )
	snippets chooser (57)
#define	IWID_SCRIPTS_CSR   (1ULL << BWN_SCRIPTS_CSR )
	recent scripts (58)
#define	IWID_BOOKMARKS   (1ULL << BWN_BOOKMARKS)
	bookmarks list (59)
#define	IWID_IDAMEMOS   (IWID_DISASMS|IWID_DUMPS )
	disassembly + hex dump views
#define	IWID_ALL   0xFFFFFFFFFFFFFFFFULL
	mask
#define	IWID_STACK   IWID_CALL_STACK
	Alias. More...
#define	IWID_DISASMS   IWID_DISASM
#define	IWID_DUMPS   IWID_DUMP
#define	IWID_SEARCHS   IWID_SEARCH
#define	IDA_DEBUG_DREFS   0x00000001
	drefs
#define	IDA_DEBUG_OFFSET   0x00000002
	offsets
#define	IDA_DEBUG_FLIRT   0x00000004
	flirt
#define	IDA_DEBUG_IDP   0x00000008
	idp module
#define	IDA_DEBUG_LDR   0x00000010
	ldr module
#define	IDA_DEBUG_PLUGIN   0x00000020
	plugin module
#define	IDA_DEBUG_IDS   0x00000040
	ids files
#define	IDA_DEBUG_CONFIG   0x00000080
	config file
#define	IDA_DEBUG_CHECKMEM   0x00000100
	check heap consistency
#define	IDA_DEBUG_CHECKARG   0x00000200
	checkarg
#define	IDA_DEBUG_DEMANGLE   0x00000400
	demangler
#define	IDA_DEBUG_QUEUE   0x00000800
	queue
#define	IDA_DEBUG_ROLLBACK   0x00001000
	rollback
#define	IDA_DEBUG_ALREADY   0x00002000
	already data or code
#define	IDA_DEBUG_TIL   0x00004000
	type system
#define	IDA_DEBUG_NOTIFY   0x00008000
	show all notifications
#define	IDA_DEBUG_DEBUGGER   0x00010000
	debugger
#define	IDA_DEBUG_APPCALL   0x00020000
	appcall
#define	IDA_DEBUG_SRCDBG   0x00040000
	source debugging
#define	IDA_DEBUG_ACCESSIBILITY   0x00080000
	accessibility
#define	IDA_DEBUG_NETWORK   0x00100000
	network
#define	IDA_DEBUG_INTERNET   IDA_DEBUG_NETWORK
	internet connection (for API backward compatibility)
#define	IDA_DEBUG_SIMPLEX   0x00200000
	full stack analysis
#define	IDA_DEBUG_DBGINFO   0x00400000
	handling of debug info (e.g. pdb, dwarf)
#define	IDA_DEBUG_LUMINA   0x00800000
	lumina related
#define	IDA_DEBUG_THEMES   0x01000000
	themes
#define	IDA_DEBUG_REGEX   0x02000000
	regular expression
#define	IDA_DEBUG_ALWAYS   0xFFFFFFFF
	everything
#define	deb(ida_debug_bits, ...)
#define	CH_MODAL   0x00000001
	Modal chooser.
#define	CH_KEEP   0x00000002
	The chooser instance's lifecycle is not tied to the lifecycle of the widget showing its contents. More...
#define	CH_MULTI   0x00000004
	The chooser will allow multi-selection (only for GUI choosers). More...
#define	CH_MULTI_EDIT   0x00000008
	Obsolete.
#define	CH_NOBTNS   0x00000010
	do not display ok/cancel/help/search buttons. More...
#define	CH_ATTRS   0x00000020
	generate ui_get_chooser_item_attrs (gui only)
#define	CH_NOIDB   0x00000040
	use the chooser before opening the database
#define	CH_FORCE_DEFAULT   0x00000080
	if a non-modal chooser was already open, change selection to the default one
#define	CH_CAN_INS   0x00000100
	allow to insert new items
#define	CH_CAN_DEL   0x00000200
	allow to delete existing item(s)
#define	CH_CAN_EDIT   0x00000400
	allow to edit existing item(s)
#define	CH_CAN_REFRESH   0x00000800
	allow to refresh chooser
#define	CH_QFLT   0x00001000
	open with quick filter enabled and focused
#define	CH_QFTYP_SHIFT   13
#define	CH_QFTYP_DEFAULT   0
	set quick filtering type to the possible existing default for this chooser
#define	CH_QFTYP_NORMAL   (1 << CH_QFTYP_SHIFT)
	normal (i.e., lexicographical) quick filter type
#define	CH_QFTYP_WHOLE_WORDS   (2 << CH_QFTYP_SHIFT)
	whole words quick filter type
#define	CH_QFTYP_REGEX   (3 << CH_QFTYP_SHIFT)
	regex quick filter type
#define	CH_QFTYP_FUZZY   (4 << CH_QFTYP_SHIFT)
	fuzzy search quick filter type
#define	CH_QFTYP_MASK   (0x7 << CH_QFTYP_SHIFT)
#define	CH_NO_STATUS_BAR   0x00010000
	don't show a status bar
#define	CH_RESTORE   0x00020000
	restore floating position if present (equivalent of WOPN_RESTORE) (GUI version only)
#define	CH_RENAME_IS_EDIT   0x00040000
	triggering a 'edit/rename' (i.e., F2 shortcut) on a cell, should call the edit() callback for the corresponding row. More...
#define	CH_BUILTIN_SHIFT   19
#define	CH_BUILTIN(id)   ((id+1) << CH_BUILTIN_SHIFT)
#define	CH_BUILTIN_MASK   (0x3F << CH_BUILTIN_SHIFT)
	Mask for builtin chooser numbers. Plugins should not use them.
#define	CH_HAS_DIRTREE   0x02000000
	The chooser can provide a dirtree_t, meaning a tree-like structure can be provided to the user (instead of a flat table)
#define	CH_TM_NO_TREE   0x00000000
	chooser will show up in no-tree mode
#define	CH_TM_FOLDERS_ONLY   0x04000000
	chooser will show in folders-only mode
#define	CH_TM_FULL_TREE   0x08000000
	chooser will show in no-tree mode
#define	CH_TM_SHIFT   26
#define	CH_TM_MASK   (0x3 << CH_TM_SHIFT)
#define	CH_HAS_DIFF   0x10000000
	The chooser can be used in a diffing/merging workflow.
#define	CH_NO_SORT   0x20000000
	The chooser will not have sorting abilities.
#define	CH_NO_FILTER   0x40000000
	The chooser will not have filtering abilities.
#define	CH_NON_PERSISTED_TREE   0x80000000
	the chooser tree is not persisted (it is not loaded on startup and is not saved on exit)
#define	CHCOL_PLAIN   0x00000000
	plain string
#define	CHCOL_PATH   0x00010000
	file path
#define	CHCOL_HEX   0x00020000
	hexadecimal number
#define	CHCOL_DEC   0x00030000
	decimal number
#define	CHCOL_EA   0x00040000
	address
#define	CHCOL_FNAME   0x00050000
	function name
#define	CHCOL_FORMAT   0x00070000
	column format mask
#define	CHCOL_DEFHIDDEN   0x00100000
	column should be hidden by default
#define	CHCOL_DRAGHINT   0x00200000
	the column number that will be used to build hints for the dragging undo label. More...
#define	CHCOL_INODENAME   0x00400000
	if CH_HAS_DIRTREE has been specified, this instructs the chooser that this column shows the inode name. More...
#define	CHITEM_BOLD   0x0001
	display the item in bold
#define	CHITEM_ITALIC   0x0002
	display the item in italic
#define	CHITEM_UNDER   0x0004
	underline the item
#define	CHITEM_STRIKE   0x0008
	strikeout the item
#define	CHITEM_GRAY   0x0010
	gray out the item
#define	TXTF_AUTOINDENT   0x0001
	auto-indent on new line
#define	TXTF_ACCEPTTABS   0x0002
	Tab key inserts 'tabsize' spaces.
#define	TXTF_READONLY   0x0004
	text cannot be edited (but can be selected and copied)
#define	TXTF_SELECTED   0x0008
	shows the field with its text selected
#define	TXTF_MODIFIED   0x0010
	gets/sets the modified status
#define	TXTF_FIXEDFONT   0x0020
	the control uses IDA's fixed font
#define	TXTF_LINENUMBERS   0x0040
	the text editor widget should display line numbers
#define	CLIF_QT_AWARE   1
	keydown event will use Qt key codes
#define	ACF_HAS_SELECTION   (1 << 0)
	there is currently a valid selection
#define	ACF_XTRN_EA   (1 << 1)
	cur_ea is in 'externs' segment
#define	ACF_HAS_FIELD_DIRTREE_SELECTION   (1 << 2)
	'cur_enum_member' and 'dirtree_selection' fields are present
#define	ACF_HAS_SOURCE   (1 << 3)
	'source' field is present
#define	ADF_OWN_HANDLER   0x01
	handler is owned by the action; it'll be destroyed when the action is unregistered. More...
#define	ADF_NO_UNDO   0x02
	the action does not create an undo point. More...
#define	ADF_OT_MASK   0x0C
	Owner type mask.
#define	ADF_OT_PLUGIN   0x00
	Owner is a plugin_t.
#define	ADF_OT_PLUGMOD   0x04
	Owner is a plugmod_t.
#define	ADF_OT_PROCMOD   0x08
	Owner is a procmod_t.
#define	ADF_GLOBAL   0x10
	Register the action globally, so that it's available even if no IDB is present.
#define	ADF_NO_HIGHLIGHT   0x20
	After activating, do not update the highlight according to what's under the cursor (listings only.)
#define	DEF_SET_METHOD(NAME, TYPE)
	Helper to define functions in form_actions_t that get/set field values of different types. More...
#define	DEF_FIELD_METHOD(NAME, TYPE)
	Helper to define functions in form_actions_t that get/set field values of different types. More...
#define	DEF_STR_FIELD_METHOD(NAME)
	Helper to define functions in form_actions_t that get/set field values of different types. More...

Typedefs
typedef uchar	color_t
	see <lines.hpp>
typedef uval_t	bmask_t
	see <enum.hpp>
typedef tid_t	enum_t
	see <enum.hpp>
typedef qvector< simpleline_t >	strvec_t
	A collection of simple lines to populate a custom view. More...
typedef qvector< sync_source_t >	sync_source_vec_t
typedef lecvt_code_t idaapi	lochist_entry_cvt2_t(lochist_entry_t *dst, const lochist_entry_t &src, TWidget *view, uint32 flags)
typedef qvector< twinline_t >	text_t
	A group of lines in a text window.
typedef qvector< const twinline_t * >	section_lines_refs_t
typedef qvector< section_lines_refs_t >	sections_lines_refs_t
typedef qvector< line_rendering_output_entry_t * >	line_rendering_output_entries_refs_t
typedef int	twidget_type_t
	Window types

Enumerations
enum	mbox_kind_t {   mbox_internal , mbox_info , mbox_warning , mbox_error ,   mbox_nomem , mbox_feedback , mbox_readerror , mbox_writeerror ,   mbox_filestruct , mbox_wait , mbox_hide , mbox_replace }
	see <loader.hpp> More...
enum	choose_type_t {   chtype_generic , chtype_idasgn , chtype_entry , chtype_name ,   chtype_stkvar_xref , chtype_xref , chtype_enum , chtype_enum_by_value ,   chtype_func , chtype_segm , chtype_struc , chtype_strpath ,   chtype_idatil , chtype_enum_by_value_and_size , chtype_srcp }
	List chooser types. More...
enum	beep_t { beep_default = 0 }
	< Beep types
enum	tcc_renderer_type_t { TCCRT_INVALID = 0 , TCCRT_FLAT , TCCRT_GRAPH , TCCRT_PROXIMITY }
	TWidget renderer type. More...
enum	tcc_place_type_t {   TCCPT_INVALID = 0 , TCCPT_PLACE , TCCPT_SIMPLELINE_PLACE , TCCPT_IDAPLACE ,   TCCPT_ENUMPLACE , TCCPT_STRUCTPLACE }
	TWidget place_t type. More...
enum	vme_button_t { VME_UNKNOWN , VME_LEFT_BUTTON , VME_RIGHT_BUTTON , VME_MID_BUTTON }
	Represents mouse button for view_mouse_event_t objects. More...
enum	ui_notification_t {   ui_null = 0 , ui_range , ui_refresh_choosers , ui_idcstart ,   ui_idcstop , ui_suspend , ui_resume , ui_broadcast ,   ui_read_selection , ui_read_range_selection , ui_unmarksel , ui_screenea ,   ui_saving , ui_saved , ui_refreshmarked , ui_refresh ,   ui_choose , ui_close_chooser , ui_banner , ui_setidle ,   ui_database_closed , ui_beep , ui_is_msg_inited , ui_msg ,   ui_mbox , ui_clr_cancelled , ui_set_cancelled , ui_test_cancelled ,   ui_ask_buttons , ui_ask_file , ui_ask_form , ui_ask_text ,   ui_ask_str , ui_ask_addr , ui_ask_seg , ui_ask_long ,   ui_add_idckey , ui_obsolete_del_idckey , ui_analyzer_options , ui_load_file ,   ui_run_dbg , ui_get_cursor , ui_get_curline , ui_copywarn ,   ui_noabort , ui_lock_range_refresh , ui_unlock_range_refresh , ui_genfile_callback ,   ui_open_url , ui_hexdumpea , ui_get_key_code , ui_setup_plugins_menu ,   ui_get_kernel_version , ui_is_idaq , ui_refresh_navband , ui_debugger_menu_change ,   ui_get_curplace , ui_obsolete_display_widget , ui_close_widget , ui_activate_widget ,   ui_find_widget , ui_get_current_widget , ui_widget_visible , ui_widget_closing ,   ui_widget_invisible , ui_get_ea_hint , ui_get_item_hint , ui_refresh_custom_viewer ,   ui_destroy_custom_viewer , ui_jump_in_custom_viewer , ui_get_custom_viewer_curline , ui_get_current_viewer ,   ui_is_idaview , ui_get_custom_viewer_hint , ui_set_custom_viewer_range , ui_database_inited ,   ui_ready_to_run , ui_set_custom_viewer_handler , ui_refresh_chooser , ui_open_builtin ,   ui_preprocess_action , ui_postprocess_action , ui_set_custom_viewer_mode , ui_gen_disasm_text ,   ui_gen_idanode_text , ui_install_cli , ui_execute_sync , ui_get_chooser_obj ,   ui_enable_chooser_item_attrs , ui_get_chooser_item_attrs , ui_set_dock_pos , ui_get_opnum ,   ui_install_custom_datatype_menu , ui_install_custom_optype_menu , ui_get_range_marker , ui_lookup_key_code ,   ui_load_custom_icon_file , ui_load_custom_icon , ui_free_custom_icon , ui_process_action ,   ui_create_code_viewer , ui_addons , ui_execute_ui_requests , ui_execute_ui_requests_list ,   ui_register_timer , ui_unregister_timer , ui_take_database_snapshot , ui_restore_database_snapshot ,   ui_set_code_viewer_line_handlers , ui_obsolete_refresh_custom_code_viewer , ui_create_source_viewer , ui_get_tab_size ,   ui_repaint_qwidget , ui_custom_viewer_set_userdata , ui_jumpto , ui_cancel_exec_request ,   ui_open_form , ui_unrecognized_config_directive , ui_get_output_cursor , ui_get_output_curline ,   ui_get_output_selected_text , ui_get_renderer_type , ui_set_renderer_type , ui_get_viewer_user_data ,   ui_get_viewer_place_type , ui_ea_viewer_history_push_and_jump , ui_ea_viewer_history_info , ui_register_action ,   ui_unregister_action , ui_attach_action_to_menu , ui_detach_action_from_menu , ui_attach_action_to_popup ,   ui_detach_action_from_popup , ui_attach_dynamic_action_to_popup , ui_attach_action_to_toolbar , ui_detach_action_from_toolbar ,   ui_updating_actions , ui_updated_actions , ui_populating_widget_popup , ui_finish_populating_widget_popup ,   ui_update_action_attr , ui_get_action_attr , ui_plugin_loaded , ui_plugin_unloading ,   ui_get_widget_type , ui_current_widget_changed , ui_get_widget_title , ui_obsolete_get_user_strlist_options ,   ui_create_custom_viewer , ui_custom_viewer_jump , ui_set_custom_viewer_handlers , ui_get_registered_actions ,   ui_create_toolbar , ui_delete_toolbar , ui_create_menu , ui_delete_menu ,   ui_obsolete_set_nav_colorizer , ui_get_chooser_data , ui_obsolete_get_highlight , ui_set_highlight ,   ui_set_mappings , ui_create_empty_widget , ui_msg_clear , ui_msg_save ,   ui_msg_get_lines , ui_chooser_default_enter , ui_screen_ea_changed , ui_get_active_modal_widget ,   ui_navband_pixel , ui_navband_ea , ui_get_window_id , ui_create_desktop_widget ,   ui_strchoose , ui_set_nav_colorizer , ui_display_widget , ui_get_lines_rendering_info ,   ui_sync_sources , ui_get_widget_config , ui_set_widget_config , ui_get_custom_viewer_location ,   ui_initing_database , ui_destroying_procmod , ui_destroying_plugmod , ui_update_file_history ,   ui_cancel_thread_exec_requests , ui_get_synced_group , ui_show_rename_dialog , ui_desktop_applied ,   ui_choose_bookmark , ui_get_custom_viewer_place_xcoord , ui_get_user_input_event , ui_get_highlight_2 ,   ui_last , ui_dbg_begin = 1000 , ui_dbg_run_requests = ui_dbg_begin , ui_dbg_get_running_request ,   ui_dbg_get_running_notification , ui_dbg_clear_requests_queue , ui_dbg_get_process_state , ui_dbg_start_process ,   ui_dbg_request_start_process , ui_dbg_suspend_process , ui_dbg_request_suspend_process , ui_dbg_continue_process ,   ui_dbg_request_continue_process , ui_dbg_exit_process , ui_dbg_request_exit_process , ui_dbg_get_thread_qty ,   ui_dbg_getn_thread , ui_dbg_select_thread , ui_dbg_request_select_thread , ui_dbg_step_into ,   ui_dbg_request_step_into , ui_dbg_step_over , ui_dbg_request_step_over , ui_dbg_run_to ,   ui_dbg_request_run_to , ui_dbg_step_until_ret , ui_dbg_request_step_until_ret , ui_dbg_get_bpt_qty ,   ui_dbg_add_oldbpt , ui_dbg_request_add_oldbpt , ui_dbg_del_oldbpt , ui_dbg_request_del_oldbpt ,   ui_dbg_enable_oldbpt , ui_dbg_request_enable_oldbpt , ui_dbg_set_trace_size , ui_dbg_clear_trace ,   ui_dbg_request_clear_trace , ui_dbg_is_step_trace_enabled , ui_dbg_enable_step_trace , ui_dbg_request_enable_step_trace ,   ui_dbg_get_step_trace_options , ui_dbg_set_step_trace_options , ui_dbg_request_set_step_trace_options , ui_dbg_is_insn_trace_enabled ,   ui_dbg_enable_insn_trace , ui_dbg_request_enable_insn_trace , ui_dbg_get_insn_trace_options , ui_dbg_set_insn_trace_options ,   ui_dbg_request_set_insn_trace_options , ui_dbg_is_func_trace_enabled , ui_dbg_enable_func_trace , ui_dbg_request_enable_func_trace ,   ui_dbg_get_func_trace_options , ui_dbg_set_func_trace_options , ui_dbg_request_set_func_trace_options , ui_dbg_get_tev_qty ,   ui_dbg_get_tev_info , ui_dbg_get_call_tev_callee , ui_dbg_get_ret_tev_return , ui_dbg_get_bpt_tev_ea ,   ui_dbg_get_reg_value_type , ui_dbg_get_processes , ui_dbg_attach_process , ui_dbg_request_attach_process ,   ui_dbg_detach_process , ui_dbg_request_detach_process , ui_dbg_get_first_module , ui_dbg_get_next_module ,   ui_dbg_bring_to_front , ui_dbg_get_current_thread , ui_dbg_wait_for_next_event , ui_dbg_get_debug_event ,   ui_dbg_set_debugger_options , ui_dbg_set_remote_debugger , ui_dbg_load_debugger , ui_dbg_retrieve_exceptions ,   ui_dbg_store_exceptions , ui_dbg_define_exception , ui_dbg_suspend_thread , ui_dbg_request_suspend_thread ,   ui_dbg_resume_thread , ui_dbg_request_resume_thread , ui_dbg_get_process_options , ui_dbg_check_bpt ,   ui_dbg_set_process_state , ui_dbg_get_manual_regions , ui_dbg_set_manual_regions , ui_dbg_enable_manual_regions ,   ui_dbg_set_process_options , ui_dbg_is_busy , ui_dbg_hide_all_bpts , ui_dbg_edit_manual_regions ,   ui_dbg_get_sp_val , ui_dbg_get_ip_val , ui_dbg_get_reg_val , ui_dbg_set_reg_val ,   ui_dbg_request_set_reg_val , ui_dbg_get_insn_tev_reg_val , ui_dbg_get_insn_tev_reg_result , ui_dbg_register_provider ,   ui_dbg_unregister_provider , ui_dbg_handle_debug_event , ui_dbg_add_vmod , ui_dbg_del_vmod ,   ui_dbg_compare_bpt_locs , ui_obsolete_dbg_save_bpts , ui_dbg_set_bptloc_string , ui_dbg_get_bptloc_string ,   ui_dbg_internal_appcall , ui_dbg_internal_cleanup_appcall , ui_dbg_internal_get_sreg_base , ui_dbg_internal_ioctl ,   ui_dbg_read_memory , ui_dbg_write_memory , ui_dbg_read_registers , ui_dbg_write_register ,   ui_dbg_get_memory_info , ui_dbg_get_event_cond , ui_dbg_set_event_cond , ui_dbg_enable_bpt ,   ui_dbg_request_enable_bpt , ui_dbg_del_bpt , ui_dbg_request_del_bpt , ui_dbg_map_source_path ,   ui_dbg_map_source_file_path , ui_dbg_modify_source_paths , ui_dbg_is_bblk_trace_enabled , ui_dbg_enable_bblk_trace ,   ui_dbg_request_enable_bblk_trace , ui_dbg_get_bblk_trace_options , ui_dbg_set_bblk_trace_options , ui_dbg_request_set_bblk_trace_options ,   ui_dbg_load_trace_file , ui_dbg_save_trace_file , ui_dbg_is_valid_trace_file , ui_dbg_set_trace_file_desc ,   ui_dbg_get_trace_file_desc , ui_dbg_choose_trace_file , ui_dbg_diff_trace_file , ui_dbg_graph_trace ,   ui_dbg_get_tev_memory_info , ui_dbg_get_tev_event , ui_dbg_get_insn_tev_reg_mem , ui_dbg_getn_bpt ,   ui_dbg_get_bpt , ui_dbg_find_bpt , ui_dbg_add_bpt , ui_dbg_request_add_bpt ,   ui_dbg_update_bpt , ui_dbg_for_all_bpts , ui_dbg_get_tev_ea , ui_dbg_get_tev_type ,   ui_dbg_get_tev_tid , ui_dbg_get_trace_base_address , ui_dbg_set_trace_base_address , ui_dbg_add_tev ,   ui_dbg_add_insn_tev , ui_dbg_add_call_tev , ui_dbg_add_ret_tev , ui_dbg_add_bpt_tev ,   ui_dbg_add_debug_event , ui_dbg_add_thread , ui_dbg_del_thread , ui_dbg_add_many_tevs ,   ui_dbg_set_bpt_group , ui_dbg_set_highlight_trace_options , ui_dbg_set_trace_platform , ui_dbg_get_trace_platform ,   ui_dbg_internal_get_elang , ui_dbg_internal_set_elang , ui_dbg_load_dbg_dbginfo , ui_dbg_set_resume_mode ,   ui_dbg_request_set_resume_mode , ui_dbg_set_bptloc_group , ui_dbg_list_bptgrps , ui_dbg_rename_bptgrp ,   ui_dbg_del_bptgrp , ui_dbg_get_grp_bpts , ui_dbg_get_bpt_group , ui_dbg_change_bptlocs ,   ui_dbg_collect_stack_trace , ui_dbg_get_module_info , ui_dbg_get_srcinfo_provider , ui_dbg_get_global_var ,   ui_dbg_get_local_var , ui_dbg_get_local_vars , ui_dbg_add_path_mapping , ui_dbg_get_current_source_file ,   ui_dbg_get_current_source_line , ui_dbg_srcdbg_step_into , ui_dbg_srcdbg_request_step_into , ui_dbg_srcdbg_step_over ,   ui_dbg_srcdbg_request_step_over , ui_dbg_srcdbg_step_until_ret , ui_dbg_srcdbg_request_step_until_ret , ui_dbg_getn_thread_name ,   ui_dbg_bin_search , ui_dbg_get_insn_tev_reg_val_i , ui_dbg_get_insn_tev_reg_result_i , ui_dbg_get_reg_val_i ,   ui_dbg_set_reg_val_i , ui_dbg_get_reg_info , ui_dbg_set_trace_dynamic_register_set , ui_dbg_get_trace_dynamic_register_set ,   ui_dbg_enable_bptgrp , ui_dbg_end }
	Events marked as 'ui:' should be used as a parameter to callui(). More...
enum	lecvt_code_t { LECVT_CANCELED = -1 , LECVT_ERROR = 0 , LECVT_OK = 1 }
	Converts from an entry with a given place type, to another entry, with another place type, to be used with the view 'view'. More...

Variables
idaman callui_t ida_export_data(idaapi *	callui )(ui_notification_t what,...)
	Pointer to the user-interface dispatcher function. More...
idaman uint32 ida_export_data	debug
	Controls debug messages - combination of IDA debug bits.

Macro Definition Documentation

WCLS_DELETE_LATER

#define WCLS_DELETE_LATER   0x8

assign the deletion of the widget to the UI loop ///<

Returns

void

DP_BEFORE

#define DP_BEFORE   0x0020

Place src_form before dst_form in the tab bar instead of after; used with DP_INSIDE or DP_TAB.

CVNF_LAZY

#define CVNF_LAZY   (1 << 0)

try and move the cursor to a line displaying the place_t if possible.

This might disregard the Y position in case of success

CVNF_ACT

#define CVNF_ACT   (1 << 2)

activate (i.e., switch to) the viewer.

Activation is performed before the new lochist_entry_t instance is actually copied to the viewer's lochist_t (otherwise, if the viewer was invisible its on_location_changed() handler wouldn't be called.)

RENADDR_HR

#define RENADDR_HR   1

dialog for "Pseudocode"; additional flags:

• 0x01 Library function
• 0x02 Mark as decompiled

define_place_exported_functions

#define define_place_exported_functions

(

classname

)

Value:

class classname;                                                                                        \
idaman void        ida_export classname ## __print(const classname *, qstring *, void*);                \
idaman uval_t      ida_export classname ## __touval(const classname *,void*);                           \
idaman place_t *   ida_export classname ## __clone(const classname *);                                  \
idaman void        ida_export classname ## __copyfrom(classname *,const place_t*);                      \
idaman place_t *   ida_export classname ## __makeplace(const classname *,void*,uval_t,int);             \
idaman int         ida_export classname ## __compare(const classname *,const place_t*);                 \
idaman int         ida_export classname ## __compare2(const classname *,const place_t*, void*);        \
idaman void        ida_export classname ## __adjust(classname *,void*);                                 \
idaman bool        ida_export classname ## __prev(classname *,void*);                                   \
idaman bool        ida_export classname ## __next(classname *,void*);                                   \
idaman bool        ida_export classname ## __beginning(const classname *,void*);                        \
idaman bool        ida_export classname ## __ending(const classname *,void*);                           \
idaman int         ida_export classname ## __generate(                                                  \
        const classname *,                                                                              \
        qstrvec_t*,                                                                                     \
        int*,                                                                               \
        color_t*,                                                                                       \
        bgcolor_t*,                                                                                     \
        void*,                                                                                          \
        int);                                                                               \
idaman void        ida_export classname ## __serialize(const classname *, bytevec_t *out);              \
idaman bool        ida_export classname ## __deserialize(classname *, const uchar **, const uchar *);   \
idaman int         ida_export classname ## __id(const classname *);                                     \
idaman const char *ida_export classname ## __name(const classname *);                                   \
idaman ea_t        ida_export classname ## __toea(const classname *);                                   \
idaman place_t *   ida_export classname ## __enter(const classname *, uint32 *);                        \
idaman void        ida_export classname ## __leave(const classname *, uint32);                          \
idaman bool        ida_export classname ## __rebase(classname *, const segm_move_infos_t &);

Helper to define exported functions for place_t implementations.

PCF_MAKEPLACE_ALLOCATES

#define PCF_MAKEPLACE_ALLOCATES   0x00000002

makeplace() returns a freshly allocated (i.e., non-static) instance.

All new code should pass that flag to register_place_class(), and the corresponding makeplace() class implementation should return new instances.

DECLARE_LINEARRAY_HELPERS

#define DECLARE_LINEARRAY_HELPERS

(

decl

)

Value:

decl void  ida_export linearray_t_ctr(linearray_t *, void *ud); \
decl void  ida_export linearray_t_dtr(linearray_t *); \
decl int   ida_export linearray_t_set_place(linearray_t *, const place_t *new_at); \
decl bool  ida_export linearray_t_beginning(const linearray_t *); \
decl bool  ida_export linearray_t_ending(const linearray_t *); \
decl const qstring *ida_export linearray_t_down(linearray_t *); \
decl const qstring *ida_export linearray_t_up(linearray_t *);

Helper for declaring member functions of the linearray_t class.

BWN_STACK

#define BWN_STACK   BWN_CALL_STACK

Alias.

Some BWN_* were confusing, and thus have been renamed. This is to ensure bw-compat.

BWN_DISASMS

#define BWN_DISASMS   BWN_DISASM

Alias.

Some BWN_* were confusing, and thus have been renamed. This is to ensure bw-compat.

BWN_DUMPS

#define BWN_DUMPS   BWN_DUMP

Alias.

Some BWN_* were confusing, and thus have been renamed. This is to ensure bw-compat.

BWN_SEARCHS

#define BWN_SEARCHS   BWN_SEARCH

Alias.

Some BWN_* were confusing, and thus have been renamed. This is to ensure bw-compat.

IWID_STACK

#define IWID_STACK   IWID_CALL_STACK

Alias.

Some IWID_* were confusing, and thus have been renamed. This is to ensure bw-compat.

deb

#define deb	(		ida_debug_bits,
			...
	)

Value:

  do                                       \
  {                                        \
    if ( (debug & (ida_debug_bits)) != 0 ) \
      ida_deb(__VA_ARGS__);                \
  } while ( false )

CH_KEEP

#define CH_KEEP   0x00000002

The chooser instance's lifecycle is not tied to the lifecycle of the widget showing its contents.

Closing the widget will not destroy the chooser structure. This allows for, e.g., static global chooser instances that don't need to be allocated on the heap. Also stack-allocated chooser instances must set this bit.

CH_MULTI

#define CH_MULTI   0x00000004

The chooser will allow multi-selection (only for GUI choosers).

This bit is set when using the chooser_multi_t structure.

CH_NOBTNS

#define CH_NOBTNS   0x00000010

do not display ok/cancel/help/search buttons.

Meaningful only for gui modal windows because non-modal windows do not have any buttons anyway. Text mode does not have them neither.

CH_RENAME_IS_EDIT

#define CH_RENAME_IS_EDIT   0x00040000

triggering a 'edit/rename' (i.e., F2 shortcut) on a cell, should call the edit() callback for the corresponding row.

CHCOL_DRAGHINT

#define CHCOL_DRAGHINT   0x00200000

the column number that will be used to build hints for the dragging undo label.

This should be provided for at most one column for any given chooser.

CHCOL_INODENAME

#define CHCOL_INODENAME   0x00400000

if CH_HAS_DIRTREE has been specified, this instructs the chooser that this column shows the inode name.

This should be provided for at most one column for any given chooser.

MFF_FAST

#define MFF_FAST   0x0000

Execute code as soon as possible.

this mode is ok for calling ui related functions that do not query the database.

MFF_READ

#define MFF_READ   0x0001

Execute code only when ida is idle and it is safe to query the database.

This mode is recommended only for code that does not modify the database. (nb: ida may be in the middle of executing another user request, for example it may be waiting for him to enter values into a modal dialog box)

MFF_WRITE

#define MFF_WRITE   0x0002

Execute code only when ida is idle and it is safe to modify the database.

in particular, this flag will suspend execution if there is a modal dialog box on the screen. this mode can be used to call any ida api function. MFF_WRITE implies MFF_READ

MFF_NOWAIT

#define MFF_NOWAIT   0x0004

Do not wait for the request to be executed.

the caller should ensure that the request is not destroyed until the execution completes. if not, the request will be ignored. the request must be created using the 'new' operator to use it with this flag. it can be used in cancel_exec_request(). This flag can be used to delay the code execution until the next UI loop run even from the main thread.

ADF_OWN_HANDLER

#define ADF_OWN_HANDLER   0x01

handler is owned by the action; it'll be destroyed when the action is unregistered.

Use DYNACTION_DESC_LITERAL to set this bit.

ADF_NO_UNDO

#define ADF_NO_UNDO   0x02

the action does not create an undo point.

useful for actions that do not modify the database.

DEF_SET_METHOD

#define DEF_SET_METHOD	(		NAME,
			TYPE
	)

Value:

  inline bool idaapi set_ ## NAME ## _value(int field_id, const TYPE *val)  \
  {                                                                         \
    return _set_field_value(field_id, val);                                 \
  }

Helper to define functions in form_actions_t that get/set field values of different types.

Please see this file's source code for specific uses.

DEF_FIELD_METHOD

#define DEF_FIELD_METHOD	(		NAME,
			TYPE
	)

Value:

  inline bool idaapi get_ ## NAME ## _value(int field_id, TYPE *val)        \
  {                                                                         \
    return _get_field_value(field_id, val);                                 \
  }                                                                         \
  DEF_SET_METHOD(NAME, TYPE)

Helper to define functions in form_actions_t that get/set field values of different types.

Please see this file's source code for specific uses.

DEF_STR_FIELD_METHOD

#define DEF_STR_FIELD_METHOD

(

NAME

)

Value:

  inline bool idaapi get_ ## NAME ## _value(int field_id, char *buf, const size_t bufsize) \
  {                                                                         \
    return _get_str_field_value(field_id, buf, bufsize);                    \
  }                                                                         \
  DEF_SET_METHOD(NAME, char)

Helper to define functions in form_actions_t that get/set field values of different types.

Please see this file's source code for specific uses.

Typedef Documentation

strvec_t

typedef qvector<simpleline_t> strvec_t

A collection of simple lines to populate a custom view.

This is an example of what you would pass as the 'ud' argument to create_custom_viewer()

nav_colorizer_t

typedef uint32 idaapi nav_colorizer_t(ea_t ea, asize_t nbytes, void *ud)

Navigation band colorizer function.

If ea==BADADDR, then 'nbytes' is a navaddr_type_t, and the colorizer is in charge of returning the color associated to that type of address. This is used for maintaining the legend in-sync with the colors used to display the addresses in the navigation bar.

Parameters

ea	address to calculate the color of, or BADADDR (see above)
nbytes	number of bytes, this can be ignored for quick&dirty approach
ud	user data

Returns

color of the specified address in RGB

custom_viewer_curpos_t

typedef void idaapi custom_viewer_curpos_t(TWidget *cv, void *ud)

Deprecated.

See custom_viewer_location_changed_t for a more competent, and general solution.

custom_viewer_adjust_place_t

typedef void idaapi custom_viewer_adjust_place_t(TWidget *v, lochist_entry_t *loc, void *ud)

Fine-tune 'loc->place()' according to the X position (i.e., 'loc->renderer_info().pos.cx')

You can consider that the place_t object is a 'row cursor' in the list of lines that fill the screen. But, it is only a 'vertical' cursor: e.g., the simpleline_place_t has the 'n' mumber, which specifies what line the place_t corresponds to, in the backing strvec_t instance.

However, some views have a place that can be sensitive to the X coordinates of the view's cursor. Think of the "Hex View-1", or the "Pseudocode-A" views: when moving the cursor on the X axis, the 'row cursor' will not change (since we are moving on the same line), but the corresponding 'ea_t' might.

For such tricky situations, we provide the following callback, that will provide the ability to update the 'loc->place()'s internal state according to 'loc->renderer_info().pos.cx' so that it really reflects the current cursor position. Most custom viewers will not need to implement this, but if some data in your place_t instances is dependent upon the X coordinate of the cursor, you'll probably want to.

Called whenever the user moves the cursor around (mouse, keyboard)

Note: this callback should only ever read 'loc->renderer_info()', not modify it. Doing so will result in undefined behavior.

custom_viewer_get_place_xcoord_t

typedef int idaapi custom_viewer_get_place_xcoord_t(TWidget *v, const place_t *pline, const place_t *pitem, void *ud)

Does the line pointed to by pline include pitem, and if so at what X coordinate?

place_t instances can be considered as a 'cursor' in a set of lines (see custom_viewer_adjust_place_t), but they can be 'tuned' to correctly represent the current position (e.g., hexrays decompiler plugins tune its place_t instances so they contain the real, current 'ea_t', that corresponds to the C-like expression that's shown at the X coordinate within that line.)

But then, when the viewer has to determine whether a certain twinline_t in fact displays the current place, the sublcass's implementation of place_t::compare() might lead it to think that the current twinline_t's place_t is not correct (e.g., because the 'ea_t' has been fine-tuned according to the caret's X coordinates.)

Thus, if your plugin implements custom_viewer_adjust_place_t, you probably want to implement this as well, or refreshes might be unnecessarily frequent, leading to a worse user experience.

This is typically called when the user moves the cursor around. return -1 if pitem is not included in pline -2 pitem points to the entire line >= 0 for the X coordinate within the pline, where pitem points

custom_viewer_can_navigate_t

typedef int idaapi custom_viewer_can_navigate_t(TWidget *v, const lochist_entry_t *now, const locchange_md_t &md, void *ud)

The user asked to navigate to the given location.

This gives the view the possibility of declining the move. Reasons for this can be:

• the location cannot be displayed,
• going there requires a long-running operation, that can be canceled by the user (e.g., in case of the hexrays plugins: during decompilation of the target function.)
• ...

This is called before the new location is committed to the view's history.

return 0 if the move is accepted != 0 otherwise

code_viewer_lines_click_t

typedef void idaapi code_viewer_lines_click_t(TWidget *c, const place_t *p, int pos, int shift, void *ud)

The user clicked, right clicked or double clicked.

pos: the clicked icon number. -1 means the click occurred on space not reserved to icons.

code_viewer_lines_icon_t

typedef int idaapi code_viewer_lines_icon_t(TWidget *cv, const place_t *p, int *pos, void *ud)

Icon drawing.

Parameters

pos	the icon number, will be 0,1,2,3... can be modified to skip positions and draw at the specified one

Returns

the id of the icon to draw. If bitwise or'ed with 0x80000000, IDA calls this function once more with pos+1 to retrieve one more icon.

action_activation_ctx_t

typedef action_ctx_base_t action_activation_ctx_t

Instances of this class will be filled with information that is commonly used by actions when they need to be activated.

This is so they don't have to perform (possibly) costly operations more than once.

action_update_ctx_t

typedef action_ctx_base_t action_update_ctx_t

Instances of this class will be filled with information that is commonly used by actions when they need to update.

This is so they don't have to perform (possibly) costly operations more than once.

formchgcb_t

typedef int idaapi formchgcb_t(int field_id, form_actions_t &fa)

Callback.

Called when an input field is modified. The callback will be also called before displaying the form and as soon as the user presses OK.

Parameters

field_id

id of the modified field

Return values

-1	form is going to be displayed
-2	form is going to be closed with OK.
>0	form will be closed

buttoncb_t

typedef int idaapi buttoncb_t(int button_code, form_actions_t &fa)

Callback.

Called when a button is clicked.

Parameters

button_code

button code as specified in the form

Return values

0	currently ignored

Enumeration Type Documentation

mbox_kind_t

enum mbox_kind_t

see <loader.hpp>

Message box kinds

Enumerator
mbox_internal	internal error

choose_type_t

enum choose_type_t

List chooser types.

Enumerator
chtype_generic	the generic choose() function
chtype_idasgn	see choose_idasgn()
chtype_entry	see choose_entry()
chtype_name	see choose_name()
chtype_stkvar_xref	see choose_stkvar_xref()
chtype_xref	see choose_xref()
chtype_enum	see choose_enum()
chtype_enum_by_value	Deprecated. See chtype_enum_by_value_and_size.
chtype_func	see choose_func()
chtype_segm	see choose_segm()
chtype_struc	see choose_struc()
chtype_strpath	see choose_struc_path()
chtype_idatil	see choose_til()
chtype_enum_by_value_and_size	see choose_enum_by_value()
chtype_srcp	see choose_srcp()

tcc_renderer_type_t

enum tcc_renderer_type_t

TWidget renderer type.

Enumerator
TCCRT_INVALID	invalid
TCCRT_FLAT	flat view
TCCRT_GRAPH	graph view
TCCRT_PROXIMITY	proximity view

tcc_place_type_t

enum tcc_place_type_t

TWidget place_t type.

Enumerator
TCCPT_INVALID	invalid
TCCPT_PLACE	place_t
TCCPT_SIMPLELINE_PLACE	simpleline_place_t
TCCPT_IDAPLACE	idaplace_t
TCCPT_ENUMPLACE	enumplace_t
TCCPT_STRUCTPLACE	structplace_t

vme_button_t

enum vme_button_t

Represents mouse button for view_mouse_event_t objects.

Enumerator
VME_UNKNOWN	unknown mouse button
VME_LEFT_BUTTON	left mouse button
VME_RIGHT_BUTTON	right mouse button
VME_MID_BUTTON	middle mouse button

ui_notification_t

enum ui_notification_t

Events marked as 'ui:' should be used as a parameter to callui().

(See convenience functions like get_screen_ea()) Events marked as 'cb:' are designed to be callbacks and should not be used in callui(). The user may hook to HT_UI events to catch them

Enumerator
ui_range	cb: The disassembly range has been changed ( idainfo::min_ea ... idainfo::max_ea). UI should redraw the scrollbars. See also: ui_lock_range_refresh Parameters none Returns void
ui_refresh_choosers	cb: The list (chooser) window contents have been changed (names, signatures, etc). UI should redraw them. Please consider request_refresh() instead Parameters none Returns void
ui_idcstart	cb: Start of IDC engine work. Parameters none Returns void
ui_idcstop	cb: Stop of IDC engine work. Parameters none Returns void
ui_suspend	cb: Suspend graphical interface. Only the text version. Interface should respond to it. Parameters none Returns void
ui_resume	cb: Resume the suspended graphical interface. Only the text version. Interface should respond to it Parameters none Returns void
ui_broadcast	cb: broadcast call Parameters magic (int64) a magic number ... other parameters depend on the given magic modules may hook to this event and reply to the caller. for example, the decompiler uses it to communicate its entry point to other plugins
ui_read_selection	ui: see read_selection()
ui_read_range_selection	ui: see read_range_selection()
ui_unmarksel	ui: see unmark_selection()
ui_screenea	ui: see get_screen_ea()
ui_saving	cb: The kernel is flushing its buffers to the disk. The user interface should save its state. Parameters: none Returns: none
ui_saved	cb: The kernel has saved the database. This callback just informs the interface. Note that at the time this notification is sent, the internal paths are not updated yet, and calling get_path(PATH_TYPE_IDB) will return the previous path. Parameters path (const char *) the database path Returns void
ui_refreshmarked	ui: see refresh_idaview()
ui_refresh	ui: see refresh_idaview_anyway()
ui_choose	ui: Allow the user to choose an object. Always use the helper inline functions for this code. See Functions: built-in choosers for a list of such functions. Parameters type (choose_type_t) type of chooser to display ... other parameters depend on the given type Returns depends on the given type
ui_close_chooser	ui: see close_chooser()
ui_banner	ui: see banner()
ui_setidle	ui: Set a function to call at idle times. Parameters func (int (*)(void)) pointer to function that will be called Returns void
ui_database_closed	cb: The database has been closed. See also processor_t::closebase, it occurs earlier. See also ui_initing_database. This is not the same as IDA exiting. If you need to perform cleanup at the exiting time, use qatexit(). Parameters none Returns void
ui_beep	ui: see beep()
ui_is_msg_inited	ui: see is_msg_inited()
ui_msg	ui: Show a message in the message window. Parameters format (const char *) format of message body va (va_list) format args Returns number of bytes output
ui_mbox	ui: Show a message box. Parameters kind (mbox_kind_t) format (const char *) format of message body va (va_list]) format args Returns void
ui_clr_cancelled	ui: see clr_cancelled()
ui_set_cancelled	ui: see set_cancelled()
ui_test_cancelled	ui: see user_cancelled()
ui_ask_buttons	ui: see ask_yn() and ask_buttons()
ui_ask_file	ui: see ask_file()
ui_ask_form	ui: see ask_form()/open_form()
ui_ask_text	ui: see ask_text()
ui_ask_str	ui: see ask_str()
ui_ask_addr	ui: see ask_addr()
ui_ask_seg	ui: see ask_seg()
ui_ask_long	ui: see ask_long()
ui_add_idckey	ui: see add_idc_hotkey()
ui_obsolete_del_idckey	ui: see ui_del_idckey()
ui_analyzer_options	ui: see analyzer_options()
ui_load_file	ui: see ui_load_new_file()
ui_run_dbg	ui: see ui_run_debugger()
ui_get_cursor	ui: see get_cursor()
ui_get_curline	ui: see get_curline()
ui_copywarn	ui: see display_copyright_warning()
ui_noabort	ui: Disable 'abort' menu item - the database was not compressed. Parameters none Returns void
ui_lock_range_refresh	ui: Lock the ui_range refreshes. The ranges will not be refreshed until the corresponding ui_unlock_range_refresh is issued. Parameters none Returns void
ui_unlock_range_refresh	ui: Unlock the ui_range refreshes. If the number of locks is back to zero, then refresh the ranges. Parameters none Returns void
ui_genfile_callback	cb: handle html generation. Parameters html_header_cb_t ** html_footer_cb_t ** html_line_cb_t ** Returns void
ui_open_url	ui: see open_url()
ui_hexdumpea	ui: Return the current address in a hex view. Parameters result (::ea_t *) hexdump_num (int) Returns void
ui_get_key_code	ui: see get_key_code()
ui_setup_plugins_menu	ui: setup plugins submenu Parameters none Returns void
ui_get_kernel_version	ui: see get_kernel_version()
ui_is_idaq	ui: see is_idaq()
ui_refresh_navband	ui: see refresh_navband()
ui_debugger_menu_change	cb: debugger menu modification detected Parameters enable (bool) true: debugger menu has been added, or a different debugger has been selected false: debugger menu will be removed (user switched to "No debugger") Returns void
ui_get_curplace	ui: see get_custom_viewer_place(). See also ui_get_custom_viewer_location
ui_close_widget	ui: see close_widget()
ui_activate_widget	ui: see activate_widget()
ui_find_widget	ui: see find_widget()
ui_get_current_widget	ui: see get_current_widget()
ui_widget_visible	TWidget is displayed on the screen. Use this event to populate the window with controls Parameters widget (TWidget *) Returns void
ui_widget_closing	TWidget is about to close. This event precedes ui_widget_invisible. Use this to perform some possible actions relevant to the lifecycle of this widget Parameters widget (TWidget *) Returns void
ui_widget_invisible	TWidget is being closed. Use this event to destroy the window controls Parameters widget (TWidget *) Returns void
ui_get_ea_hint	cb: ui wants to display a simple hint for an address. Use this event to generate a custom hint See also more generic ui_get_item_hint Parameters buf (qstring *) ea (::ea_t) Returns true if generated a hint
ui_get_item_hint	cb: ui wants to display multiline hint for an item. See also more generic ui_get_custom_viewer_hint Parameters [out] hint (qstring *) the output string ea (ea_t) or item id like a structure or enum member max_lines (int) maximal number of lines [out] important_lines (int *) number of important lines. if zero, output is ignored Returns true if generated a hint
ui_refresh_custom_viewer	ui: see refresh_custom_viewer()
ui_destroy_custom_viewer	ui: see destroy_custom_viewer()
ui_jump_in_custom_viewer	ui: see jumpto()
ui_get_custom_viewer_curline	ui: see get_custom_viewer_curline()
ui_get_current_viewer	ui: see get_current_viewer()
ui_is_idaview	ui: see is_idaview()
ui_get_custom_viewer_hint	cb: ui wants to display a hint for a viewer (idaview or custom). Every subscriber is supposed to append the hint lines to HINT and increment IMPORTANT_LINES accordingly. Completely overwriting the existing lines in HINT is possible but not recommended. If the REG_HINTS_MARKER sequence is found in the returned hints string, it will be replaced with the contents of the "regular" hints. If the SRCDBG_HINTS_MARKER sequence is found in the returned hints string, it will be replaced with the contents of the source-level debugger-generated hints. The following keywords might appear at the beginning of the returned hints: HIGHLIGHT text where text will be highlighted CAPTION caption caption for the hint widget Parameters [out] hint (qstring *) the output string, on input contains hints from the previous subscribes viewer (TWidget*) viewer place (place_t *) current position in the viewer [out] important_lines (int *) number of important lines, should be incremented, if zero, the result is ignored Return values 0 continue collecting hints with other subscribers 1 stop collecting hints
ui_set_custom_viewer_range	ui: set_custom_viewer_range()
ui_database_inited	cb: database initialization has completed. the kernel is about to run idc scripts Parameters is_new_database (int) idc_script (const char *) - may be nullptr Returns void See also ui_initing_database. This event is called for both new and old databases.
ui_ready_to_run	cb: all UI elements have been initialized. Automatic plugins may hook to this event to perform their tasks. Parameters none Returns void
ui_set_custom_viewer_handler	ui: see set_custom_viewer_handler(). also see other examples in Functions: custom viewer handlers
ui_refresh_chooser	ui: see refresh_chooser()
ui_open_builtin	ui: open a window of a built-in type. see Functions: open built-in windows
ui_preprocess_action	cb: ida ui is about to handle a user action. Parameters name (const char *) ui action name. these names can be looked up in ida[tg]ui.cfg Return values 0 ok nonzero a plugin has handled the command
ui_postprocess_action	cb: an ida ui action has been handled
ui_set_custom_viewer_mode	ui: switch between graph/text modes. Parameters custom_viewer (TWidget *) graph_view (bool) silent (bool) Returns bool success
ui_gen_disasm_text	ui: see gen_disasm_text()
ui_gen_idanode_text	cb: generate disassembly text for a node. Plugins may intercept this event and provide custom text for an IDA graph node They may use gen_disasm_text() for that. Parameters text (text_t *) fc (qflow_chart_t *) node (int) Returns bool text_has_been_generated
ui_install_cli	ui: see: install_command_interpreter(), remove_command_interpreter()
ui_execute_sync	ui: see execute_sync()
ui_get_chooser_obj	ui: see get_chooser_obj()
ui_enable_chooser_item_attrs	ui: see enable_chooser_item_attrs()
ui_get_chooser_item_attrs	cb: get item-specific attributes for a chooser. This callback is generated only after enable_chooser_attrs() Parameters chooser (const chooser_base_t *) n (::size_t) attrs (chooser_item_attrs_t *) Returns void
ui_set_dock_pos	ui: see set_dock_pos()
ui_get_opnum	ui: see get_opnum()
ui_install_custom_datatype_menu	ui: install/remove custom data type menu item. Parameters dtid (int) data type id install (bool) Returns success
ui_install_custom_optype_menu	ui: install/remove custom operand type menu item. Parameters fid (int) format id install (bool) Returns success
ui_get_range_marker	ui: Get pointer to function. see mark_range_for_refresh(ea_t, asize_t). This function will be called by the kernel when the database is changed Parameters none Returns vptr: (idaapi*marker)(ea_t ea, asize_t) or nullptr
ui_lookup_key_code	ui: see lookup_key_code()
ui_load_custom_icon_file	ui: see load_custom_icon(const char *)
ui_load_custom_icon	ui: see load_custom_icon(const void *, unsigned int, const char *)
ui_free_custom_icon	ui: see free_custom_icon()
ui_process_action	ui: see process_ui_action()
ui_create_code_viewer	ui: see create_code_viewer()
ui_addons	ui: see Functions: add-ons
ui_execute_ui_requests	ui: see execute_ui_requests(ui_request_t, ...)
ui_execute_ui_requests_list	ui: see execute_ui_requests(ui_requests_t)
ui_register_timer	ui: see register_timer()
ui_unregister_timer	ui: see unregister_timer()
ui_take_database_snapshot	ui: see take_database_snapshot()
ui_restore_database_snapshot	ui: see restore_database_snapshot()
ui_set_code_viewer_line_handlers	ui: see set_code_viewer_line_handlers()
ui_create_source_viewer	ui: Create new source viewer. Parameters top_tl (TWidget **) toplevel widget of created source viewer (can be nullptr) parent (TWidget *) custview (TWidget *) path (const char *) lines (strvec_t *) lnnum (int) colnum (int) flags (int) (Source viewer creation flags) Returns source_view_t *
ui_get_tab_size	ui: see get_tab_size()
ui_repaint_qwidget	ui: see repaint_custom_viewer()
ui_custom_viewer_set_userdata	ui: Change place_t user data for a custom view. Parameters custom_viewer (TWidget *) user_data (void *) Returns old user_data
ui_jumpto	ui: see jumpto(ea_t, int, int)
ui_cancel_exec_request	ui: see cancel_exec_request()
ui_open_form	ui: see vopen_form()
ui_unrecognized_config_directive	ui: Possibly handle an extra config directive, passed through '-d' or '-D'. Parameters directive (const char *) The config directive Returns char * - one of IDPOPT_RET See also register_cfgopts, which is better
ui_get_output_cursor	ui: see get_output_cursor()
ui_get_output_curline	ui: see get_output_curline()
ui_get_output_selected_text	ui: see get_output_selected_text()
ui_get_renderer_type	ui: see get_view_renderer_type()
ui_set_renderer_type	ui: see set_view_renderer_type()
ui_get_viewer_user_data	ui: see get_viewer_user_data()
ui_get_viewer_place_type	ui: see get_viewer_place_type()
ui_ea_viewer_history_push_and_jump	ui: see ea_viewer_history_push_and_jump()
ui_ea_viewer_history_info	ui: see get_ea_viewer_history_info()
ui_register_action	ui: see register_action()
ui_unregister_action	ui: see unregister_action()
ui_attach_action_to_menu	ui: see attach_action_to_menu()
ui_detach_action_from_menu	ui: see detach_action_from_menu()
ui_attach_action_to_popup	ui: see attach_action_to_popup()
ui_detach_action_from_popup	ui: see detach_action_from_popup()
ui_attach_dynamic_action_to_popup	ui: see create attach_dynamic_action_to_popup()
ui_attach_action_to_toolbar	ui: see attach_action_to_toolbar()
ui_detach_action_from_toolbar	ui: see detach_action_from_toolbar()
ui_updating_actions	cb: IDA is about to update all actions. If your plugin needs to perform expensive operations more than once (e.g., once per action it registers), you should do them only once, right away. Parameters ctx (action_update_ctx_t *) Returns void
ui_updated_actions	cb: IDA is done updating actions. Parameters none Returns void
ui_populating_widget_popup	cb: IDA is populating the context menu for a widget. This is your chance to attach_action_to_popup(). Have a look at ui_finish_populating_widget_popup, if you want to augment the context menu with your own actions after the menu has had a chance to be properly populated by the owning component or plugin (which typically does it on ui_populating_widget_popup.) Parameters widget (TWidget *) popup_handle (TPopupMenu *) ctx (const action_activation_ctx_t *) Returns void ui: see ui_finish_populating_widget_popup
ui_finish_populating_widget_popup	cb: IDA is about to be done populating the context menu for a widget. This is your chance to attach_action_to_popup(). Parameters widget (TWidget *) popup_handle (TPopupMenu *) ctx (const action_activation_ctx_t *) Returns void ui: see ui_populating_widget_popup
ui_update_action_attr	ui: see Functions: update actions
ui_get_action_attr	ui: see Functions: get action attributes
ui_plugin_loaded	cb: The plugin was loaded in memory. Parameters plugin_info (const plugin_info_t *)
ui_plugin_unloading	cb: The plugin is about to be unloaded Parameters plugin_info (const plugin_info_t *)
ui_get_widget_type	ui: see get_widget_type()
ui_current_widget_changed	cb: The currently-active TWidget changed. Parameters widget (TWidget *) prev_widget (TWidget *) Returns void
ui_get_widget_title	ui: see get_widget_title()
ui_obsolete_get_user_strlist_options	ui: see get_user_strlist_options()
ui_create_custom_viewer	ui: see create_viewer()
ui_custom_viewer_jump	ui: set the current location, and have the viewer display it Parameters v (TWidget *) loc (const lochist_entry_t *) flags (uint32) or'ed combination of CVNF_* values Returns success
ui_set_custom_viewer_handlers	ui: see set_custom_viewer_handlers()
ui_get_registered_actions	ui: see get_registered_actions()
ui_create_toolbar	ui: see create_toolbar()
ui_delete_toolbar	ui: see delete_toolbar()
ui_create_menu	ui: see create_menu()
ui_delete_menu	ui: see delete_menu()
ui_get_chooser_data	ui: see get_chooser_data()
ui_obsolete_get_highlight	now ui_get_highlight_2
ui_set_highlight	ui: see set_highlight()
ui_set_mappings	ui: Show current memory mappings and allow the user to change them.
ui_create_empty_widget	ui: see create_empty_widget()
ui_msg_clear	ui: see msg_clear()
ui_msg_save	ui: see msg_save()
ui_msg_get_lines	ui: see msg_get_lines()
ui_chooser_default_enter	ui: jump to the address returned by get_ea() callback in the case of the non-modal choosers Parameters chooser (const chooser_base_t *) n/sel (::size_t *) for chooser_t (sizevec_t *) for chooser_multi_t Returns int chooser_t::cbres_t
ui_screen_ea_changed	cb: The "current address" changed Parameters ea (ea_t) prev_ea (ea_t) Returns void
ui_get_active_modal_widget	ui: see get_active_modal_widget()
ui_navband_pixel	ui: see get_navband_pixel
ui_navband_ea	ui: see get_navband_ea
ui_get_window_id	ui: set get_window_id (GUI only)
ui_create_desktop_widget	cb: create a widget, to be placed in the widget tree (at desktop-creation time.) Parameters title (const char *) cfg (const jobj_t *) Returns TWidget * the created widget, or null
ui_strchoose	ui: undocumented
ui_set_nav_colorizer	ui: see set_nav_colorizer()
ui_display_widget	ui: see display_widget()
ui_get_lines_rendering_info	cb: get lines rendering information Parameters out (lines_rendering_output_t *) widget (const TWidget *) info (const lines_rendering_input_t *) Returns void
ui_sync_sources	ui: [un]synchronize sources Parameters what (const sync_source_t *) with (const sync_source_t *) sync (bool) Returns success
ui_get_widget_config	cb: retrieve the widget configuration (it will be passed back at ui_create_desktop_widget-, and ui_set_widget_config-time) Parameters widget (const TWidget *) cfg (jobj_t *) Returns void
ui_set_widget_config	cb: set the widget configuration Parameters widget (const TWidget *) cfg (const jobj_t *) Returns void
ui_get_custom_viewer_location	ui: see get_custom_viewer_location() Parameters out (lochist_entry_t *) custom_viewer (TWidget *) mouse (bool)
ui_initing_database	cb: database initialization has started. Returns void See also ui_database_inited. This event is called for both new and old databases.
ui_destroying_procmod	cb: The processor module is about to be destroyed Parameters procmod (const procmod_t *)
ui_destroying_plugmod	cb: The plugin object is about to be destroyed Parameters plugmod (const plugmod_t *) entry (const plugin_t *)
ui_update_file_history	ui: manipulate the file history Parameters add_path (const char *) del_path (const char *)
ui_cancel_thread_exec_requests	ui: see cancel_thread_exec_requests()
ui_get_synced_group	ui: see get_synced_group()
ui_show_rename_dialog	ui: undocumented Rename address dialog -] Parameters ea (ea_t) ndialog (int) dialog number Dialogs for "Rename address" [in,out] hr_flags (ushort *) additional flags Returns success
ui_desktop_applied	cb: a desktop has been applied Parameters name (const char *) the desktop name from_idb (bool) the desktop was stored in the IDB (false if it comes from the registry) type (int) the desktop type (1-disassembly, 2-debugger, 3-merge)
ui_choose_bookmark	ui: modal chooser (legacy) Parameters n (uint32 *) input: default slot, output: chosen bookmark index entry (const lochist_entry_t *) entry with place type ud (void *) user data
ui_get_custom_viewer_place_xcoord	ui: see get_custom_viewer_place_xcoord()
ui_get_user_input_event	ui: see get_user_input_event()
ui_get_highlight_2	ui: see get_highlight()
ui_last	the last notification code
ui_dbg_begin	debugger callgates. should not be used directly, see dbg.hpp for details

lecvt_code_t

enum lecvt_code_t

Converts from an entry with a given place type, to another entry, with another place type, to be used with the view 'view'.

Typically used when views are synchronized. The 'renderer_info_t' part of 'dst' will be pre-filled with the current renderer_info_t of 'view', while the 'place_t' instance will always be nullptr.

custom_viewer_handler_id_t

enum custom_viewer_handler_id_t

Custom viewer & code viewer handler types.

Enumerator
CVH_KEYDOWN	see custom_viewer_keydown_t
CVH_POPUP	see custom_viewer_popup_t
CVH_DBLCLICK	see custom_viewer_dblclick_t
CVH_CURPOS	see custom_viewer_curpos_t
CVH_CLOSE	see custom_viewer_close_t
CVH_CLICK	see custom_viewer_click_t
CVH_QT_AWARE	see set_custom_viewer_qt_aware()
CVH_HELP	see custom_viewer_help_t
CVH_MOUSEMOVE	see custom_viewer_mouse_moved_t
CDVH_USERDATA	see set_code_viewer_user_data()
CDVH_SRCVIEW	see set_code_viewer_is_source()
CDVH_LINES_CLICK	see code_viewer_lines_click_t
CDVH_LINES_DBLCLICK	see code_viewer_lines_click_t
CDVH_LINES_POPUP	see code_viewer_lines_click_t
CDVH_LINES_DRAWICON	see code_viewer_lines_icon_t
CDVH_LINES_LINENUM	see code_viewer_lines_linenum_t
CDVH_LINES_ICONMARGIN	see set_code_viewer_lines_icon_margin()
CDVH_LINES_RADIX	see set_code_viewer_lines_radix()
CDVH_LINES_ALIGNMENT	see set_code_viewer_lines_alignment()

msg_notification_t

enum msg_notification_t

Notification codes for events in the message window.

Enumerator
msg_activated	The message window is activated. Parameters none Returns void
msg_deactivated	The message window is deactivated. Parameters none Returns void
msg_click	Click event. Parameters x (int) x-coordinate y (int) y-coordinate state (::view_event_state_t) Return values 1 handled 0 not handled (invoke default handler)
msg_dblclick	Double click event. Parameters x (int) x-coordinate y (int) y-coordinate state (::view_event_state_t) Return values 1 handled 0 not handled (invoke default handler)
msg_closed	View closed. Parameters none Returns void
msg_keydown	Key down event. Parameters key (int) state (::view_event_state_t) Return values 1 handled 0 not handled (invoke default handler)

view_notification_t

enum view_notification_t

Notification codes sent by the UI for IDAView or custom viewer events.

These notification codes should be used together with HT_VIEW hook type.

Enumerator
view_activated	A view is activated. Parameters view (TWidget *)
view_deactivated	A view is deactivated. Parameters view (TWidget *)
view_keydown	Key down event. Parameters view (TWidget *) key (int) state (::view_event_state_t)
view_click	Click event. Parameters view (TWidget *) event (const view_mouse_event_t *)
view_dblclick	Double click event. Parameters view (TWidget *) event (const view_mouse_event_t *)
view_curpos	Cursor position changed. Parameters view (TWidget *)
view_created	A view is being created. Parameters view (TWidget *)
view_close	View closed. Parameters view (TWidget *)
view_switched	A view's renderer has changed. Parameters view (TWidget *) rt (tcc_renderer_type_t)
view_mouse_over	The user moved the mouse over (or out of) a node or an edge. This is only relevant in a graph view. Parameters view (TWidget *) event (const view_mouse_event_t *)
view_loc_changed	The location for the view has changed (can be either the place_t, the renderer_info_t, or both.) Parameters view (TWidget *) now (const lochist_entry_t *) was (const lochist_entry_t *)
view_mouse_moved	The mouse moved on the view. Parameters view (TWidget *) event (const view_mouse_event_t *)

action_state_t

enum action_state_t

Action states - returned by action_handler_t::update()

Enumerator
AST_ENABLE_ALWAYS	enable action and do not call action_handler_t::update() anymore
AST_ENABLE_FOR_IDB	enable action for the current idb. call action_handler_t::update() when a database is opened/closed
AST_ENABLE_FOR_WIDGET	enable action for the current widget. call action_handler_t::update() when a widget gets/loses focus
AST_ENABLE	enable action - call action_handler_t::update() when anything changes
AST_DISABLE_ALWAYS	disable action and do not call action_handler_t::action() anymore
AST_DISABLE_FOR_IDB	analog of AST_ENABLE_FOR_IDB
AST_DISABLE_FOR_WIDGET	analog of AST_ENABLE_FOR_WIDGET
AST_DISABLE	analog of AST_ENABLE

action_attr_t

enum action_attr_t

Codes for getting/setting action attributes.

Enumerator
AA_NONE	no effect
AA_LABEL	see update_action_label()
AA_SHORTCUT	see update_action_shortcut()
AA_TOOLTIP	see update_action_tooltip()
AA_ICON	see update_action_icon()
AA_STATE	see update_action_state()
AA_CHECKABLE	see update_action_checkable()
AA_CHECKED	see update_action_checked()
AA_VISIBILITY	see update_action_visibility()

Function Documentation

init_database()

idaman int ida_export init_database	(	int	argc,
		const char *const *	argv,
		int *	newfile
	)

After calling init_kernel() the ui must call this function.

It will open the database specified in the command line. If the database did not exist, a new database will be created and the input file will be loaded.

Returns

0-ok, otherwise an exit code

term_database()

idaman void ida_export term_database

(

void

)

The database termination function.

This function should be called to close the database.

register_place_class()

int register_place_class ( const place_t *  tmplate, int  flags, const plugin_t *  owner  )

inline

Register information about a place_t class.

The kernel will not take ownership, nor delete the 'tmplate' instance. Therefore, it's up to the plugin to handle it (the recommended way of doing it is to pass address of a const static instance.) In addition, the place_t will be automatically unregistered when the owner plugin is unloaded from memory.

Parameters

tmplate	the place_t template
flags	or'ed combination of PCF_* flags. You should always pass at least PCF_MAKEPLACE_ALLOCATES, and have the place_t::makeplace() implementation create new instances.
owner	the owner plugin of the place_t type. Cannot be nullptr.

Returns

the place_t ID, or -1 if an error occurred.

get_place_class()

idaman const place_t *ida_export get_place_class	(	int *	out_flags,
		int *	out_sdk_version,
		int	id
	)

Get information about a previously-registered place_t class.

See also register_place_class().

Parameters

out_flags	output flags (can be nullptr)
out_sdk_version	sdk version the place was created with (can be nullptr)
id	place class ID

Returns

the place_t template, or nullptr if not found

get_place_class_id()

idaman int ida_export get_place_class_id

(

const char *

name

)

Get the place class ID for the place that has been registered as 'name'.

Parameters

name	the class name

Returns

the place class ID, or -1 if not found

register_loc_converter2()

idaman void ida_export register_loc_converter2	(	const char *	p1,
		const char *	p2,
		lochist_entry_cvt2_t *	cvt
	)

Register a converter, that will be used for the following reasons:

• determine what view can be synchronized with what other view
• when views are synchronized, convert the location from one view, into an appropriate location in the other view
• if one of p1 or p2 is "idaplace_t", and the other is PCF_EA_CAPABLE, then the converter will also be called when the user wants to jump to an address (e.g., by pressing "g"). In that case, from's place_t's lnnum will be set to -1 (i.e., can be used to descriminate between proper synchronizations, and jump to's if needed.)

Note: the converter can be used to convert in both directions, and can be called with its 'from' being of the class of 'p1', or 'p2'. If you want your converter to work in only one direction (e.g., from 'my_dictionary_place_t' -> 'my_definition_place_t'), you can have it return false when it is called with a lochist_entry_t's whose place is of type 'my_definition_place_t'.

Note: Whenever one of the 'p1' or 'p2' places is unregistered, corresponding converters will be automatically unregistered as well.

Parameters

p1	the name of the first place_t class this converter can convert from/to
p2	the name of the second place_t class this converter can convert from/to
cvt	the converter

lookup_loc_converter2()

idaman lochist_entry_cvt2_t *ida_export lookup_loc_converter2	(	const char *	p1,
		const char *	p2
	)

Search for a place converter from lochist_entry_t's with places of type 'p1' to lochist_entry_t's with places of type 'p2'.

Parameters

p1	the name of the place_t class to convert from
p2	the name of the place_t class to convert to

Returns

a converter, or nullptr if none found

request_refresh()

idaman void ida_export request_refresh	(	uint64	mask,
		bool	cnd = true
	)

Request a refresh of a builtin window.

Parameters

mask	Window refresh flags
cnd	set if true or clear flag otherwise

is_refresh_requested()

idaman bool ida_export is_refresh_requested

(

uint64

mask

)

Get a refresh request state.

Parameters

mask	Window refresh flags

Returns

the state (set or cleared)

ida_deb()

int ida_deb ( const char *  format,   ...  )

inline

Display debug message.

Parameters

ida_debug_bits	IDA debug bits, also see debug
format	printf()-style format

Returns

number of bytes output Note: use deb() macro

choose()

ssize_t choose ( chooser_base_t *  ch, const void *  def_item  )

inline

Display a generic list chooser (n-column) and allow the user to select an item.

Invoke the chooser with a chooser object (ui_choose, chtype_generic).

The closed() callback will be called when the window is closed. In addition, after the window is closed, the chooser instance will be delete()d unless CH_KEEP is specified (useful for global, or stack-allocated chooser instances, that must not be deleted.)

Parameters

def_item

pointer to some data that identifies the default item For modal choosers:

Returns

the index of the selected item (0-based)

Return values

chooser_base_t::NO_SELECTION	the user refused to choose anything (pressed Esc).
chooser_base_t::EMPTY_CHOOSER	the chooser was not created because the init() callback has returned 'false' For non-modal choosers:
0	the chooser was created successfully
chooser_base_t::ALREADY_EXISTS	did not open a new chooser because a chooser with the same object is already open. If CH_FORCE_DEFAULT is set, the cursor of the chooser will be positioned to the new item.

see the choose() function above

execute_ui_requests() [1/2]

THREAD_SAFE int execute_ui_requests ( ui_requests_t *  reqs )

inline

Execute a list of UI requests (ui_execute_ui_requests_list).

Returns

a request id: a unique number that can be used to cancel the request

execute_ui_requests() [2/2]

THREAD_SAFE int execute_ui_requests ( ui_request_t *  req,   ...  )

inline

Execute a variable number of UI requests (ui_execute_ui_requests).

The UI requests will be dispatched in the context of the main thread.

Parameters

req	pointer to the first request ,use nullptr to terminate the var arg request list

Returns

a request id: a unique number that can be used to cancel the request

cancel_exec_request()

THREAD_SAFE bool cancel_exec_request ( int  req_id )

inline

Try to cancel an asynchronous exec request (ui_cancel_exec_request).

Parameters

req_id

request id

Return values

true	successfully canceled
false	request has already been processed.

cancel_thread_exec_requests()

THREAD_SAFE int cancel_thread_exec_requests ( qthread_t  tid )

inline

Try to cancel asynchronous exec requests created by the specified thread.

Parameters

tid

thread id

Returns

number of the canceled requests.

get_synced_group()

const synced_group_t * get_synced_group ( const TWidget *  w )

inline

Get the group of widgets/registers this view is synchronized with.

Parameters

w	the widget

Returns

the group of widgets/registers, or nullptr

jumpto() [1/2]

bool jumpto ( ea_t  ea, int  opnum = -1, int  uijmp_flags = UIJMP_ACTIVATE  )

inline

Jump to the specified address (ui_jumpto).

Parameters

ea	destination
opnum	-1: don't change x coord
uijmp_flags	Jump flags

Returns

success

banner()

bool banner ( int  wait )

inline

Show a banner dialog box (ui_banner).

Parameters

wait	time to wait before closing

Return values

1	ok
0	esc was pressed

refresh_idaview_anyway()

void refresh_idaview_anyway ( void  )

inline

Refresh all disassembly views (ui_refresh), forces an immediate refresh.

Please consider request_refresh() instead

get_cursor()

bool get_cursor ( int *  x, int *  y  )

inline

Get the cursor position on the screen (ui_get_cursor).

Note

coordinates are 0-based

Parameters

[out]	x	x-coordinate
[out]	y	y-coordinate

Return values

true	pointers are filled
false	no disassembly window open

get_output_cursor()

bool get_output_cursor ( int *  x, int *  y  )

inline

Get coordinates of the output window's cursor (ui_get_output_cursor).

Note

coordinates are 0-based

this function will succeed even if the output window is not visible

Parameters

[out]	x	column
[out]	y	line number (global, from the start of output)

Return values

false	the output window has been destroyed.
true	pointers are filled

get_curline()

const char * get_curline ( void  )

inline

Get current line from the disassemble window (ui_get_curline).

Returns

cptr current line with the color codes (use tag_remove() to remove the color codes)

get_hexdump_ea()

ea_t get_hexdump_ea ( int  hexdump_num )

inline

Get the current address in a hex view.

Parameters

hexdump_num

number of hexview window

lookup_key_code()

ushort lookup_key_code ( int  key, int  shift, bool  is_qt  )

inline

Get shortcut code previously created by ui_get_key_code.

Parameters

key	key constant
shift	modifiers
is_qt	are we using gui version?

refresh_navband()

void refresh_navband ( bool  force )

inline

Refresh navigation band if changed (ui_refresh_navband).

Parameters

force

refresh regardless

refresh_chooser()

bool refresh_chooser ( const char *  title )

inline

Mark a non-modal custom chooser for a refresh (ui_refresh_chooser).

Parameters

title

title of chooser

Returns

success

close_chooser()

bool close_chooser ( const char *  title )

inline

Close a non-modal chooser (ui_close_chooser).

Parameters

title

window title of chooser to close

Returns

success

gen_disasm_text()

void gen_disasm_text ( text_t &  text, ea_t  ea1, ea_t  ea2, bool  truncate_lines  )

inline

Generate disassembly text for a range.

Parameters

[out]	text	result
	ea1	start address
	ea2	end address
	truncate_lines	(on idainfo::margin)

execute_sync()

THREAD_SAFE int execute_sync ( exec_request_t &  req, int  reqf  )

inline

Execute code in the main thread.

Parameters

req	request specifying the code to execute
reqf	Exec request flags

Returns

if MFF_NOWAIT is specified, return the request id. otherwise return the value returned by exec_request_t::execute().

set_dock_pos()

bool set_dock_pos ( const char *  src_ctrl, const char *  dest_ctrl, int  orient, int  left = 0, int  top = 0, int  right = 0, int  bottom = 0  )

inline

Set the docking position of a widget (ui_set_dock_pos).

Parameters

src_ctrl	title of widget to dock
dest_ctrl	where to dock: if nullptr or invalid then create a new tab relative to current active tab
orient	Docking positions
left,top,right,bottom	dimensions of dock, if not specified or invalid then create the widget in the center of the screen with the default size

Returns

success

load_custom_icon() [1/2]

int load_custom_icon ( const char *  file_name )

inline

Load an icon from a file (ui_load_custom_icon_file).

Also see load_custom_icon(const void *, unsigned int, const char *)

Parameters

file_name

path to file

Returns

icon id

load_custom_icon() [2/2]

int load_custom_icon ( const void *  ptr, unsigned int  len, const char *  format  )

inline

Load an icon and return its id (ui_load_custom_icon).

Parameters

ptr	pointer to raw image data
len	image data length
format	image format

Returns

icon id

process_ui_action()

bool process_ui_action ( const char *  name, int  flags = 0, void *  param = nullptr  )

inline

Processes a UI action by name.

Parameters

name	action name
flags	reserved/not used
param	reserved/not used

take_database_snapshot()

bool take_database_snapshot ( snapshot_t *  ss, qstring *  err_msg  )

inline

Take a database snapshot (ui_take_database_snapshot).

Parameters

ss	in/out parameter. in: description, flags out: filename, id
err_msg	optional error msg buffer

Returns

success

restore_database_snapshot()

bool restore_database_snapshot ( const snapshot_t *  ss, ss_restore_cb_t *  cb, void *  ud  )

inline

Restore a database snapshot.

Note: This call is asynchronous. When it is completed, the callback will be triggered.

Parameters

ss	snapshot instance (see build_snapshot_tree())
cb	A callback that will be triggered with a nullptr string. on success and an actual error message on failure.
ud	user data passed to be passed to the callback

Returns

false if restoration could not be started (snapshot file was not found).
If the returned value is True then check if the operation succeeded from the callback.

register_timer()

THREAD_SAFE qtimer_t register_timer ( int  interval_ms, int(idaapi *)(void *ud)  callback, void *  ud  )

inline

Register a timer (ui_register_timer).

Timer functions are thread-safe and the callback is executed in the context of the main thread.

Parameters

interval_ms	interval in milliseconds
callback	the callback can return -1 to unregister the timer; any other value >= 0 defines the new interval for the timer
ud	callback params

Returns

handle to registered timer (use this handle to unregister it), or nullptr

unregister_timer()

THREAD_SAFE bool unregister_timer ( qtimer_t  t )

inline

Unregister a timer (ui_unregister_timer).

Parameters

t	handle to a registered timer

Returns

success

register_action()

bool register_action ( const action_desc_t &  desc )

inline

Create a new action (ui_register_action).

After an action has been created, it is possible to attach it to menu items (attach_action_to_menu()), or to popup menus (attach_action_to_popup()).

Because the actions will need to call the handler's activate() and update() methods at any time, you shouldn't build your action handler on the stack.

Please see the SDK's "ht_view" plugin for an example how to register actions.

Parameters

desc	action to register

Returns

success

unregister_action()

bool unregister_action ( const char *  name )

inline

Delete a previously-registered action (ui_unregister_action).

Parameters

name	name of action

Returns

success

get_registered_actions()

void get_registered_actions ( qstrvec_t *  out )

inline

Get a list of all currently-registered actions.

Parameters

out	the list of actions to be filled

create_toolbar()

bool create_toolbar ( const char *  name, const char *  label, const char *  before = nullptr, int  flags = 0  )

inline

Create a toolbar with the given name, label and optional position.

Parameters

name	name of toolbar (must be unique)
label	label of toolbar
before	if non-nullptr, the toolbar before which the new toolbar will be inserted
flags	a combination of create toolbar flags, to determine toolbar position

Returns

success

delete_toolbar()

bool delete_toolbar ( const char *  name )

inline

Delete an existing toolbar.

Parameters

name	name of toolbar

Returns

success

create_menu()

bool create_menu ( const char *  name, const char *  label, const char *  menupath = nullptr  )

inline

Create a menu with the given name, label and optional position, either in the menubar, or as a submenu.

If 'menupath' is non-nullptr, it provides information about where the menu should be positioned. First, IDA will try and resolve the corresponding menu by its name. If such an existing menu is found and is present in the menubar, then the new menu will be inserted in the menubar before it. Otherwise, IDA will try to resolve 'menupath' as it would for attach_action_to_menu() and, if found, add the new menu like so:

// The new 'My menu' submenu will appear in the 'Comments' submenu
// before the 'Enter comment..." command
create_menu("(...)", "My menu", "Edit/Comments/Enter comment...");

or

// The new 'My menu' submenu will appear at the end of the
// 'Comments' submenu.
create_menu("(...)", "My menu", "Edit/Comments/");

If the above fails, the new menu will be appended to the menubar.

Parameters

name	name of menu (must be unique)
label	label of menu
menupath	where should the menu be inserted

Returns

success

delete_menu()

bool delete_menu ( const char *  name )

inline

Delete an existing menu.

Parameters

name	name of menu

Returns

success

attach_action_to_menu()

bool attach_action_to_menu ( const char *  menupath, const char *  name, int  flags = 0  )

inline

Attach a previously-registered action to the menu (ui_attach_action_to_menu).

Note

You should not change top level menu, or the Edit,Plugins submenus If you want to modify the debugger menu, do it at the ui_debugger_menu_change event (ida might destroy your menu item if you do it elsewhere).

Parameters

menupath	path to the menu item after or before which the insertion will take place. Example: Debug/StartProcess Whitespace, punctuation are ignored. It is allowed to specify only the prefix of the menu item. Comparison is case insensitive. menupath may start with the following prefixes: [S] - modify the main menu of the structure window [E] - modify the main menu of the enum window
name	the action name
flags	a combination of Set menu flags, to determine menu item position

Returns

success

detach_action_from_menu()

bool detach_action_from_menu ( const char *  menupath, const char *  name  )

inline

Detach an action from the menu (ui_detach_action_from_menu).

Parameters

menupath	path to the menu item
name	the action name

Returns

success

attach_action_to_toolbar()

bool attach_action_to_toolbar ( const char *  toolbar_name, const char *  name  )

inline

Attach an action to an existing toolbar (ui_attach_action_to_toolbar).

Parameters

toolbar_name	the name of the toolbar
name	the action name

Returns

success

detach_action_from_toolbar()

bool detach_action_from_toolbar ( const char *  toolbar_name, const char *  name  )

inline

Detach an action from the toolbar (ui_detach_action_from_toolbar).

Parameters

toolbar_name	the name of the toolbar
name	the action name

Returns

success

register_and_attach_to_menu()

bool register_and_attach_to_menu ( const char *  menupath, const char *  name, const char *  label, const char *  shortcut, int  flags, action_handler_t *  handler, void *  owner, int  action_desc_t_flags  )

inline

Helper.

You are not encouraged to use this, as it mixes flags for both register_action(), and attach_action_to_menu().

The only reason for its existence is to make it simpler to port existing plugins to the new actions API.

display_widget()

void display_widget ( TWidget *  widget, uint32  options, const char *  dest_ctrl = nullptr  )

inline

Display a widget, dock it if not done before.

Parameters

widget	widget to display
options	Widget open flags
dest_ctrl	where to dock: if nullptr or invalid then use the active docker if there is not create a new tab relative to current active tab

close_widget()

void close_widget ( TWidget *  widget, int  options  )

inline

Close widget (ui_close_widget, only gui version).

Parameters

widget	pointer to the widget to close
options	Form close flags

activate_widget()

void activate_widget ( TWidget *  widget, bool  take_focus  )

inline

Activate widget (only gui version) (ui_activate_widget).

Parameters

widget	existing widget to display
take_focus	give focus to given widget

find_widget()

TWidget * find_widget ( const char *  caption )

inline

Find widget with the specified caption (only gui version) (ui_find_widget).

NB: this callback works only with the tabbed widgets!

Parameters

caption

title of tab, or window title if widget is not tabbed

Returns

pointer to the TWidget, nullptr if none is found

create_custom_viewer()

TWidget * create_custom_viewer ( const char *  title, const place_t *  minplace, const place_t *  maxplace, const place_t *  curplace, const renderer_info_t *  rinfo, void *  ud, const custom_viewer_handlers_t *  cvhandlers, void *  cvhandlers_ud, TWidget *  parent = nullptr  )

inline

Create new ida viewer based on place_t (ui_create_custom_viewer).

Parameters

title	name of viewer
minplace	first location of the viewer
maxplace	last location of the viewer
curplace	set current location
rinfo	renderer information (can be nullptr)
ud	contents of viewer
handlers	handlers for the viewer (can be nullptr)
parent	widget to hold viewer

Returns

pointer to resulting viewer

custom_viewer_jump()

bool custom_viewer_jump ( TWidget *  v, const lochist_entry_t &  loc, uint32  flags = 0  )

inline

Append 'loc' to the viewer's history, and cause the viewer to display it.

Parameters

v	(TWidget *)
loc	(const lochist_entry_t &)
flags	(uint32) or'ed combination of CVNF_* values

Returns

success

ea_viewer_history_push_and_jump()

bool ea_viewer_history_push_and_jump ( TWidget *  v, ea_t  ea, int  x, int  y, int  lnnum  )

inline

Push current location in the history and jump to the given location (ui_ea_viewer_history_push_and_jump).

This will jump in the given ea viewer and also in other synchronized views.

Parameters

v	ea viewer
ea	jump destination
x,y	coords on screen
lnnum	desired line number of given address

get_ea_viewer_history_info()

bool get_ea_viewer_history_info ( int *  nback, int *  nfwd, TWidget *  v  )

inline

Get information about what's in the history (ui_ea_viewer_history_info).

Parameters

[out]	nback	number of available back steps
[out]	nfwd	number of available forward steps
	v	ea viewer

Return values

false	if the given ea viewer does not exist
true	otherwise

jumpto() [2/2]

bool jumpto ( TWidget *  custom_viewer, place_t *  place, int  x, int  y  )

inline

Set cursor position in custom ida viewer.

Parameters

custom_viewer	view
place	target position
x	desired cursor position (column)
y	desired cursor position (line)

Returns

success

get_custom_viewer_place()

place_t * get_custom_viewer_place ( TWidget *  custom_viewer, bool  mouse, int *  x, int *  y  )

inline

Get current place in a custom viewer (ui_get_curplace).

See also the more complete get_custom_viewer_location()

Parameters

	custom_viewer	view
	mouse	mouse position (otherwise cursor position)
[out]	x	x coordinate
[out]	y	y coordinate

attach_action_to_popup()

bool attach_action_to_popup ( TWidget *  widget, TPopupMenu *  popup_handle, const char *  name, const char *  popuppath = nullptr, int  flags = 0  )

inline

Insert a previously-registered action into the widget's popup menu (ui_attach_action_to_popup).

This function has two "modes": 'single-shot', and 'permanent'.

Parameters

widget	target widget
popup_handle	target popup menu if non-nullptr, the action is added to this popup menu invocation (i.e., 'single-shot') if nullptr, the action is added to a list of actions that should always be present in context menus for this widget (i.e., 'permanent'.)
name	action name
popuppath	can be nullptr
flags	a combination of SETMENU_ flags (see Set menu flags)

Returns

success

detach_action_from_popup()

bool detach_action_from_popup ( TWidget *  widget, const char *  name  )

inline

Remove a previously-registered action, from the list of 'permanent' context menu actions for this widget (ui_detach_action_from_popup).

This only makes sense if the action has been added to 'widget's list of permanent popup actions by calling attach_action_to_popup in 'permanent' mode.

Parameters

widget	target widget
name	action name

attach_dynamic_action_to_popup()

bool attach_dynamic_action_to_popup ( TWidget *  widget, TPopupMenu *  popup_handle, const action_desc_t &  desc, const char *  popuppath = nullptr, int  flags = 0, qstring *  buf = nullptr  )

inline

Create & insert an action into the widget's popup menu (ui_attach_dynamic_action_to_popup).

Note

action_desc_t::handler for 'desc' must be instantiated using 'new', as it will be 'delete'd when the action is unregistered.

Parameters

widget	target widget
popup_handle	target popup
desc	created with DYNACTION_DESC_LITERAL
popuppath	can be nullptr
flags	a combination of SETMENU_ constants (see Set menu flags)
buf	a buffer, to retrieve the generated action name - can be nullptr

Returns

success

update_action_label()

bool update_action_label ( const char *  name, const char *  label  )

inline

Update an action's label (ui_update_action_attr).

Parameters

name	action name
label	new label

Returns

success

update_action_shortcut()

bool update_action_shortcut ( const char *  name, const char *  shortcut  )

inline

Update an action's shortcut (ui_update_action_attr).

Parameters

name	action name
shortcut	new shortcut

Returns

success

update_action_tooltip()

bool update_action_tooltip ( const char *  name, const char *  tooltip  )

inline

Update an action's tooltip (ui_update_action_attr).

Parameters

name	action name
tooltip	new tooltip

Returns

success

update_action_icon()

bool update_action_icon ( const char *  name, int  icon  )

inline

Update an action's icon (ui_update_action_attr).

Parameters

name	action name
icon	new icon id

Returns

success

update_action_state()

bool update_action_state ( const char *  name, action_state_t  state  )

inline

Update an action's state (ui_update_action_attr).

Parameters

name	action name
state	new state

Returns

success

update_action_checkable()

bool update_action_checkable ( const char *  name, bool  checkable  )

inline

Update an action's checkability (ui_update_action_attr).

Parameters

name	action name
checkable	new checkability

Returns

success

update_action_checked()

bool update_action_checked ( const char *  name, bool  checked  )

inline

Update an action's checked state (ui_update_action_attr).

Parameters

name	action name
checked	new checked state

Returns

success

update_action_visibility()

bool update_action_visibility ( const char *  name, bool  visible  )

inline

Update an action's visibility (ui_update_action_attr).

Parameters

name	action name
visible	new visibility

Returns

success

get_action_label()

bool get_action_label ( qstring *  label, const char *  name  )

inline

Get an action's label (ui_get_action_attr).

Parameters

[out]	label	the action label
	name	the action name

Returns

success

get_action_shortcut()

bool get_action_shortcut ( qstring *  shortcut, const char *  name  )

inline

Get an action's shortcut (ui_get_action_attr).

Parameters

[out]	shortcut	the action shortcut
	name	the action name

Returns

success

get_action_tooltip()

bool get_action_tooltip ( qstring *  tooltip, const char *  name  )

inline

Get an action's tooltip (ui_get_action_attr).

Parameters

[out]	tooltip	the action tooltip
	name	the action name

Returns

success

get_action_icon()

bool get_action_icon ( const char *  name, int *  icon  )

inline

Get an action's icon (ui_get_action_attr).

Parameters

	name	the action name
[out]	icon	the icon id

Returns

success

get_action_state()

bool get_action_state ( const char *  name, action_state_t *  state  )

inline

Get an action's state (ui_get_action_attr).

Parameters

	name	the action name
[out]	state	the action's state

Returns

success

get_action_checkable()

bool get_action_checkable ( const char *  name, bool *  checkable  )

inline

Get an action's checkability (ui_get_action_attr).

Parameters

	name	the action name
[out]	checkable	the action's checkability

Returns

success

get_action_checked()

bool get_action_checked ( const char *  name, bool *  checked  )

inline

Get an action's checked state (ui_get_action_attr).

Parameters

	name	the action name
[out]	checked	the action's checked state

Returns

success

get_action_visibility()

bool get_action_visibility ( const char *  name, bool *  visibility  )

inline

Get an action's visibility (ui_get_action_attr).

Parameters

	name	the action name
[out]	visibility	the action's visibility

Returns

success

set_custom_viewer_handler()

void * set_custom_viewer_handler ( TWidget *  custom_viewer, custom_viewer_handler_id_t  handler_id, void *  handler_or_data  )

inline

Set a handler for a custom viewer event (ui_set_custom_viewer_handler).

see also ui_set_custom_viewer_handlers

Parameters

custom_viewer	the custom viewer
handler_id	one of CVH_ in custom_viewer_handler_id_t
handler_or_data	can be a handler or data. see examples in Functions: custom viewer handlers

Returns

old value of the handler or data

get_custom_viewer_curline()

const char * get_custom_viewer_curline ( TWidget *  custom_viewer, bool  mouse  )

inline

Get current line of custom viewer (ui_get_custom_viewer_curline).

The returned line contains color codes

Parameters

custom_viewer	view
mouse	mouse position (otherwise cursor position)

Returns

pointer to contents of current line

get_custom_viewer_place_xcoord()

int get_custom_viewer_place_xcoord ( TWidget *  custom_viewer, const place_t *  pline, const place_t *  pitem  )

inline

Get the X position of the item, in the line.

Parameters

custom_viewer	the widget
pline	a place corresponding to the line
pitem	a place corresponding to the item

Returns

-1 if 'pitem' is not included in the line

-2 if 'pitem' points at the entire line

>= 0 for the X coordinate within the pline, where pitem points

get_user_input_event()

bool get_user_input_event ( input_event_t *  out )

inline

Get the current user input event (mouse button press, key press, ...) It is sometimes desirable to be able to tell when a certain situation happens (e.g., 'view_curpos' gets triggered); this function exists to provide that context (GUI version only)

Parameters

out	the input event data

Returns

false if we are not currently processing a user input event

get_output_curline()

bool get_output_curline ( qstring *  buf, bool  mouse  )

inline

Get current line of output window (ui_get_output_curline).

Parameters

buf	output buffer
mouse	current for mouse pointer?

Returns

false if output contains no text

get_output_selected_text()

bool get_output_selected_text ( qstring *  buf )

inline

Returns selected text from output window (ui_get_output_selected_text).

Parameters

buf	output buffer

Returns

true if there is a selection

msg_save()

bool msg_save ( qstring &  path )

inline

Save the "Output" window contents into a file.

Parameters

path	The path of the file to save the contents into. An empty path means that the user will be prompted for the destination and, if the file already exists, the user will be asked to confirm before overriding its contents. Upon return, 'path' will contain the path that the user chose.

Returns

success

msg_get_lines()

void msg_get_lines ( qstrvec_t *  out, int  count = -1  )

inline

Retrieve the last 'count' lines from the output window, in reverse order (from most recent, to least recent)

Parameters

out	Output storage
count	The number of lines to retrieve. -1 means: all

get_active_modal_widget()

TWidget * get_active_modal_widget ( void  )

inline

Get the current, active modal TWidget instance.

Note that in this context, the "wait dialog" is not considered: this function will return nullptr even if it is currently shown.

Returns

TWidget * the active modal widget, or nullptr

get_navband_pixel()

int get_navband_pixel ( bool *  out_is_vertical, ea_t  ea  )

inline

Translate the provided ea_t, into its pixel position (plus pixel ranges) on the navigation band.

get_window_id()

void * get_window_id ( const char *  name = nullptr )

inline

Get the system-specific window ID (GUI version only)

Parameters

the	name of the window (nullptr means the main IDA window)

Returns

the low-level window ID

read_selection()

bool read_selection ( TWidget *  v, twinpos_t *  p1, twinpos_t *  p2  )

inline

Get the selected range boundaries (ui_read_selection).

Parameters

	v	view
[out]	p1	start of selection
[out]	p2	end of selection

Return values

false	no range is selected
true	ok, start and end are filled

read_range_selection()

bool read_range_selection ( TWidget *  v, ea_t *  ea1, ea_t *  ea2  )

inline

Get the address range for the selected range boundaries, this is the convenient function for read_selection()

Parameters

	v	view, nullptr means the last active window containing addresses
[out]	ea1	start ea
[out]	ea2	end ea

Return values

0	no range is selected
1	ok, start ea and end ea are filled

create_code_viewer()

TWidget * create_code_viewer ( TWidget *  custview, int  flags = 0, TWidget *  parent = nullptr  )

inline

Create a code viewer (ui_create_code_viewer).

A code viewer contains on the left side a widget representing the line numbers, and on the right side, the child widget passed as parameter. It will inherit its title from the child widget.

Parameters

custview	the custom view to be added
flags	Code viewer flags
parent	widget to contain the new code viewer

set_code_viewer_line_handlers()

void set_code_viewer_line_handlers ( TWidget *  code_viewer, code_viewer_lines_click_t *  click_handler, code_viewer_lines_click_t *  popup_handler, code_viewer_lines_click_t *  dblclick_handler, code_viewer_lines_icon_t *  drawicon_handler, code_viewer_lines_linenum_t *  linenum_handler  )

inline

Set handlers for code viewer line events.

Any of these handlers may be nullptr

get_tab_size()

int get_tab_size ( const char *  path )

inline

Get the size of a tab in spaces (ui_get_tab_size).

Parameters

path	the path of the source view for which the tab size is requested. if nullptr, the default size is returned.

user_cancelled()

THREAD_SAFE bool user_cancelled ( void  )

inline

Test the ctrl-break flag (ui_test_cancelled).

Return values

1	Ctrl-Break is detected, a message is displayed
2	Ctrl-Break is detected again, a message is not displayed
0	Ctrl-Break is not detected

ui_load_new_file()

bool ui_load_new_file ( qstring *  temp_file, qstring *  filename, linput_t **  pli, ushort  neflags, load_info_t **  ploaders  )

inline

Display a load file dialog and load file (ui_load_file).

Parameters

[out]	temp_file	name of the file with the extracted archive member.
[in,out]	filename	the name of input file as is, library or archive name
[in,out]	pli	loader input source, may be changed to point to temp_file
	neflags	combination of NEF_... bits (see Load file flags)
[in,out]	ploaders	list of loaders which accept file, may be changed for loaders of temp_file

Return values

true	file was successfully loaded
false	otherwise

ui_run_debugger()

bool ui_run_debugger ( const char *  dbgopts, const char *  exename, int  argc, const char *const *  argv  )

inline

Load a debugger plugin and run the specified program (ui_run_dbg).

Parameters

dbgopts	value of the -r command line switch
exename	name of the file to run
argc	number of arguments for the executable
argv	argument vector

Returns

success

load_dbg_dbginfo()

bool load_dbg_dbginfo ( const char *  path, linput_t *  li = nullptr, ea_t  base = BADADDR, bool  verbose = false  )

inline

Load debugging information from a file.

Parameters

path	path to file
li	loader input. if nullptr, check DBG_NAME_KEY
base	loading address
verbose	dump status to message window

add_idc_hotkey()

int add_idc_hotkey ( const char *  hotkey, const char *  idcfunc  )

inline

Add hotkey for IDC function (ui_add_idckey).

Parameters

hotkey	hotkey name
idcfunc	IDC function name

Returns

IDC hotkey error codes

get_highlight()

bool get_highlight ( qstring *  out_str, TWidget *  viewer, uint32 *  out_flags, uint32  flags = 0  )

inline

Get the highlighted identifier in the viewer (ui_get_highlight_2).

Parameters

out_str	buffer to copy identifier to
viewer	the viewer
out_flags	storage for the flags (see set_highlight flags)
flags	input flags; optionally specify a highlight slot (0-7)

Returns

false if no identifier is highlighted

set_highlight()

bool set_highlight ( TWidget *  viewer, const char *  str, int  flags  )

inline

Set the highlighted identifier in the viewer (ui_set_highlight).

Parameters

viewer	the viewer
str	the text to match, or nullptr to remove current
flags	combination of HIF_... bits (see set_highlight flags)

Returns

false if an error occurred

open_exports_window()

TWidget * open_exports_window ( ea_t  ea )

inline

Open the exports window (ui_open_builtin).

Parameters

ea	index of entry to select by default

Returns

pointer to resulting window

open_imports_window()

TWidget * open_imports_window ( ea_t  ea )

inline

Open the exports window (ui_open_builtin).

Parameters

ea	index of entry to select by default

Returns

pointer to resulting window

open_names_window()

TWidget * open_names_window ( ea_t  ea )

inline

Open the names window (ui_open_builtin).

Parameters

ea	index of entry to select by default

Returns

pointer to resulting window

open_funcs_window()

TWidget * open_funcs_window ( ea_t  ea )

inline

Open the 'Functions' window (ui_open_builtin).

Parameters

ea	index of entry to select by default

Returns

pointer to resulting window

open_strings_window()

TWidget * open_strings_window ( ea_t  ea, ea_t  selstart = BADADDR, ea_t  selend = BADADDR  )

inline

Open the 'Strings' window (ui_open_builtin).

Parameters

ea	index of entry to select by default
selstart,selend	only display strings that occur within this range

Returns

pointer to resulting window

open_segments_window()

TWidget * open_segments_window ( ea_t  ea )

inline

Open the segments window (ui_open_builtin).

Parameters

ea	index of entry to select by default

Returns

pointer to resulting window

open_segregs_window()

TWidget * open_segregs_window ( ea_t  ea )

inline

Open the segment registers window (ui_open_builtin).

Parameters

ea	index of entry to select by default

Returns

pointer to resulting window

open_selectors_window()

TWidget * open_selectors_window ( void  )

inline

Open the selectors window (ui_open_builtin).

Returns

pointer to resulting window

open_signatures_window()

TWidget * open_signatures_window ( void  )

inline

Open the signatures window (ui_open_builtin).

Returns

pointer to resulting window

open_tils_window()

TWidget * open_tils_window ( void  )

inline

Open the type libraries window (ui_open_builtin).

Returns

pointer to resulting window

open_loctypes_window()

TWidget * open_loctypes_window ( int  ordinal )

inline

Open the local types window (ui_open_builtin).

Parameters

ordinal

ordinal of type to select by default

Returns

pointer to resulting window

open_calls_window()

TWidget * open_calls_window ( ea_t  ea )

inline

Open the function calls window (ui_open_builtin).

Returns

pointer to resulting window

open_problems_window()

TWidget * open_problems_window ( ea_t  ea )

inline

Open the problems window (ui_open_builtin).

Parameters

ea	index of entry to select by default

Returns

pointer to resulting window

open_bpts_window()

TWidget * open_bpts_window ( ea_t  ea )

inline

Open the breakpoints window (ui_open_builtin).

Parameters

ea	index of entry to select by default

Returns

pointer to resulting window

open_threads_window()

TWidget * open_threads_window ( void  )

inline

Open the threads window (ui_open_builtin).

Returns

pointer to resulting window

open_modules_window()

TWidget * open_modules_window ( void  )

inline

Open the modules window (ui_open_builtin).

Returns

pointer to resulting window

open_trace_window()

TWidget * open_trace_window ( void  )

inline

Open the tracing window (ui_open_builtin).

Returns

pointer to resulting window

open_stack_window()

TWidget * open_stack_window ( void  )

inline

Open the call stack window (ui_open_builtin).

Returns

pointer to resulting window

open_xrefs_window()

TWidget * open_xrefs_window ( ea_t  ea )

inline

Open the cross references window (ui_open_builtin).

Parameters

ea	index of entry to select by default

Returns

pointer to resulting window

open_frame_window()

TWidget * open_frame_window ( func_t *  pfn, uval_t  offset  )

inline

Open the frame window for the given function (ui_open_builtin).

Parameters

pfn	function to analyze
offset	offset where the cursor is placed

Returns

pointer to resulting window if 'pfn' is a valid function and the window was displayed,
nullptr otherwise

open_navband_window()

TWidget * open_navband_window ( ea_t  ea, int  zoom  )

inline

Open the navigation band window (ui_open_builtin).

Parameters

ea	sets the address of the navband arrow
zoom	sets the navband zoom level

Returns

pointer to resulting window

open_enums_window()

TWidget * open_enums_window ( tid_t  const_id = BADADDR )

inline

Open the enums window (ui_open_builtin).

Parameters

const_id

index of entry to select by default

Returns

pointer to resulting window

open_structs_window()

TWidget * open_structs_window ( tid_t  id = BADADDR, uval_t  offset = 0  )

inline

Open the structs window (ui_open_builtin).

Parameters

id	index of entry to select by default
offset	offset where the cursor is placed

Returns

pointer to resulting window

open_disasm_window()

TWidget * open_disasm_window ( const char *  window_title, const rangevec_t *  ranges = nullptr  )

inline

Open a disassembly view (ui_open_builtin).

Parameters

window_title	title of view to open
ranges	if != nullptr, then display a flow chart with the specified ranges

Returns

pointer to resulting window

open_hexdump_window()

TWidget * open_hexdump_window ( const char *  window_title )

inline

Open a hexdump view (ui_open_builtin).

Parameters

window_title

title of view to open

Returns

pointer to resulting window

open_notepad_window()

TWidget * open_notepad_window ( void  )

inline

Open the notepad window (ui_open_builtin).

Returns

pointer to resulting window

open_bookmarks_window()

TWidget * open_bookmarks_window ( TWidget *  w )

inline

Open the bookmarks window (ui_open_builtin).

Parameters

ea	index of entry to select by default

Returns

pointer to resulting window

sync_sources()

bool sync_sources ( const sync_source_t &  what, const sync_source_t &  with, bool  sync  )

inline

[Un]synchronize sources

Parameters

what
with
sync

Returns

success

choose_idasgn()

char * choose_idasgn ( void  )

inline

Choose a signature (ui_choose, chtype_idasgn).

Returns

name of selected signature, nullptr if none selected

choose_til()

bool choose_til ( qstring *  buf )

inline

Choose a type library (ui_choose, chtype_idatil).

Parameters

buf	output buffer to store the library name

Return values

true	'buf' was filled with the name of the selected til
false	otherwise

choose_entry()

ea_t choose_entry ( const char *  title )

inline

Choose an entry point (ui_choose, chtype_entry).

Parameters

title

chooser title

Returns

ea of selected entry point, BADADDR if none selected

choose_name()

ea_t choose_name ( const char *  title )

inline

Choose a name (ui_choose, chtype_name).

Parameters

title

chooser title

Returns

ea of selected name, BADADDR if none selected

choose_stkvar_xref()

ea_t choose_stkvar_xref ( func_t *  pfn, member_t *  mptr  )

inline

Choose an xref to a stack variable (ui_choose, chtype_name).

Parameters

pfn	function
mptr	variable

Returns

ea of the selected xref, BADADDR if none selected

choose_xref()

ea_t choose_xref ( ea_t  to )

inline

Choose an xref to an address (ui_choose, chtype_xref).

Parameters

to	referenced address

Returns

ea of selected xref, BADADDR if none selected

choose_enum()

enum_t choose_enum ( const char *  title, enum_t  default_id  )

inline

Choose an enum (ui_choose, chtype_enum).

Parameters

title	chooser title
default_id	id of enum to select by default

Returns

enum id of selected enum, BADNODE if none selected

choose_enum_by_value()

enum_t choose_enum_by_value ( const char *  title, enum_t  default_id, uint64  value, int  nbytes, uchar *  serial  )

inline

Choose an enum, restricted by value & size (ui_choose, chtype_enum_by_value_and_size).

If the given value cannot be found initially, this function will ask if the user would like to import a standard enum.

Parameters

	title	chooser title
	default_id	id of enum to select by default
	value	value to search for
	nbytes	size of value
[out]