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 | 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 | chooser_item_attrs_t |
| Chooser item attributes. More... | |
| struct | chooser_base_t |
| Chooser object. 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 | 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_t |
| Maintain information about the current state of the UI. More... | |
| struct | 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... | |
| struct | 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... | |
| 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 | 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 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... | |
| idaman void ida_export | register_loc_converter (const char *p1, const char *p2, lochist_entry_cvt_t *cvt) |
| Register a converter, that will be used for the following reasons: More... | |
| idaman lochist_entry_cvt_t *ida_export | lookup_loc_converter (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 void ida_export | request_refresh (unsigned int mask, bool cnd=true) |
| Request a refresh of a builtin window. More... | |
| void | clear_refresh_request (unsigned int mask) |
| idaman bool ida_export | is_refresh_requested (unsigned int 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 | ida_debug_time (const char *file, int line) |
| See debug_time() | |
| idaman void ida_export | ida_checkmem (const char *file, int line) |
| Checking heap is not available anymore. 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. | |
| 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... | |
| nav_colorizer_t * | set_nav_colorizer (nav_colorizer_t *func) |
| Install new navigation band colorizer (ui_set_nav_colorizer). More... | |
| 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... | |
| 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=NULL) |
| 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=NULL, 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 *before=NULL) |
| Create a menu with the given name, label and optional position. 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) |
| 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, const plugin_t *owner) |
| Helper. More... | |
| void | display_widget (TWidget *widget, int options) |
| Display a widget. 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=NULL) |
| 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) |
| 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 | is_idaq () |
| Are we running inside IDA Qt? | |
| bool | attach_action_to_popup (TWidget *widget, TPopupMenu *popup_handle, const char *name, const char *popuppath=NULL, 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=NULL, int flags=0, qstring *buf=NULL) |
| 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 NULL. | |
| 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... | |
| 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... | |
| 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=NULL) |
| 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=NULL, 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 | del_idc_hotkey (const char *hotkey) |
| Delete IDC function hotkey (ui_del_idckey). More... | |
| void | get_user_strlist_options (strwinsetup_t *out) |
| bool | get_highlight (qstring *out_str, TWidget *viewer, uint32 *out_flags) |
| Get the highlighted identifier in the viewer (ui_get_highlight). 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 trace 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=NULL) |
| 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... | |
| 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, uval_t 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[email protected]ex-rays.com. More... | |
| bool | ask_addr (ea_t *addr, const char *format,...) |
| Display a dialog box and wait for the user to input an address (ui_ask_addr). 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, int flags, va_list va) |
| Create and/or activate dockable modeless form (ui_open_form). More... | |
| TWidget * | open_form (const char *form, int 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()) | |
| THREAD_SAFE uchar *idaapi | pack_db (uchar *ptr, uchar *end, uchar x) |
| Pack a byte into a character string. More... | |
| THREAD_SAFE uchar idaapi | unpack_db (const uchar **pptr, const uchar *end) |
| Unpack a byte from a character string, pack_db() | |
| idaman THREAD_SAFE uchar *ida_export | pack_dw (uchar *ptr, uchar *end, uint16 x) |
| pack a word, see pack_db() | |
| idaman THREAD_SAFE uchar *ida_export | pack_dd (uchar *ptr, uchar *end, uint32 x) |
| pack a double word, see pack_db() | |
| idaman THREAD_SAFE uchar *ida_export | pack_dq (uchar *ptr, uchar *end, uint64 x) |
| pack a quadword, see pack_db() | |
| idaman THREAD_SAFE ushort ida_export | unpack_dw (const uchar **pptr, const uchar *end) |
| unpack a word, see unpack_db() | |
| idaman THREAD_SAFE uint32 ida_export | unpack_dd (const uchar **pptr, const uchar *end) |
| unpack a double word, see unpack_db() | |
| idaman THREAD_SAFE uint64 ida_export | unpack_dq (const uchar **pptr, const uchar *end) |
| unpack a quadword, see unpack_db() | |
| THREAD_SAFE uchar * | pack_ea (uchar *ptr, uchar *end, ea_t ea) |
| Pack an ea value into a character string, see pack_dd()/pack_dq() | |
| THREAD_SAFE ea_t | unpack_ea (const uchar **ptr, const uchar *end) |
| Unpack an ea value, see unpack_dd()/unpack_dq() | |
| THREAD_SAFE void *idaapi | unpack_obj (const uchar **pptr, const uchar *end, void *destbuf, size_t destsize) |
| Unpack an object of a known size. More... | |
| THREAD_SAFE void *idaapi | unpack_buf (const uchar **pptr, const uchar *end, size_t *sz) |
| Unpack an object of an unknown size (packed with append_buf()). More... | |
| THREAD_SAFE const void *idaapi | unpack_obj_inplace (const uchar **pptr, const uchar *end, size_t objsize) |
| In-place version of unpack_obj(). More... | |
| THREAD_SAFE const void *idaapi | unpack_buf_inplace (const uchar **pptr, const uchar *end, size_t *sz) |
| In-place version of unpack_buf(). More... | |
| idaman THREAD_SAFE uchar *ida_export | pack_ds (uchar *ptr, uchar *end, const char *x, size_t len=0) |
| Pack a string. More... | |
| idaman THREAD_SAFE char *ida_export | unpack_ds (const uchar **pptr, const uchar *end, bool empty_null) |
| Unpack a string. More... | |
| THREAD_SAFE bool | unpack_ds_to_buf (char *dst, size_t dstsize, const uchar **pptr, const uchar *end) |
| Unpack a string. More... | |
| THREAD_SAFE void | unpack_eavec (ea_t ea, eavec_t &insns, const uchar **ptr, const uchar *end) |
| Unpack a vector of ea values. More... | |
| idaman THREAD_SAFE bool ida_export | unpack_xleb128 (void *res, int nbits, bool is_signed, const uchar **pptr, const uchar *end) |
| Unpack an LEB128 encoded (DWARF-3 style) signed/unsigned value. More... | |
| template<class T > | |
| bool | unpack_uleb128 (T *res, const uchar **pptr, const uchar *end) |
| template<class T > | |
| bool | unpack_sleb128 (T *res, const uchar **pptr, const uchar *end) |
| int | ds_packed_size (const char *s) |
| THREAD_SAFE void | append_db (bytevec_t &v, uchar x) |
| Append a byte to a bytevec. | |
| THREAD_SAFE void | append_obj (bytevec_t &v, const void *obj, size_t size) |
| Append 'size' bytes from 'obj' to the bytevec;. | |
| THREAD_SAFE void | append_dw (bytevec_t &v, uint16 x) |
| Pack a word and append the result to the bytevec. | |
| THREAD_SAFE void | append_dd (bytevec_t &v, uint32 x) |
| Pack a double word and append the result to the bytevec. | |
| THREAD_SAFE void | append_dq (bytevec_t &v, uint64 x) |
| Pack a quadword and append the result to the bytevec. | |
| THREAD_SAFE void | append_ea (bytevec_t &v, ea_t x) |
| Pack an ea value and append the result to the bytevec. | |
| THREAD_SAFE void | append_ds (bytevec_t &v, const char *x) |
| Pack a string and append the result to the bytevec. | |
| THREAD_SAFE void | append_buf (bytevec_t &v, const void *buf, size_t len) |
| Pack an object of size 'len' and append the result to the bytevec. | |
| THREAD_SAFE void | append_eavec (bytevec_t &v, ea_t ea, const eavec_t &insns) |
| Pack an eavec and append the result to the bytevec. More... | |
| THREAD_SAFE char * | unpack_str (const uchar **ptr, const uchar *end) |
| Unpack a string in place. More... | |
| int | dw_size (uchar first_byte) |
| int | dd_size (uchar first_byte) |
| template<class T > | |
| uchar | extract_db (T &v) |
| template<class T > | |
| void * | extract_obj (T &v, void *destbuf, size_t destsize) |
| template<class T > | |
| uint16 | extract_dw (T &v) |
| template<class T > | |
| uint32 | extract_dd (T &v) |
| template<class T > | |
| uint64 | extract_dq (T &v) |
| template<class T > | |
| ea_t | extract_ea (T &v) |
| template<class T > | |
| void * | extract_buf (T &v, size_t size) |
| template<class T > | |
| void * | extract_array (T &v, size_t *sz, size_t maxsize) |
| 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 | 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 | 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 | WOPN_MDI 0x01 |
| start by default as MDI | |
| #define | WOPN_TAB 0x02 |
| attached by default to a tab | |
| #define | WOPN_RESTORE 0x04 |
| restore state from desktop config | |
| #define | WOPN_ONTOP 0x08 |
| form should be "ontop" | |
| #define | WOPN_MENU 0x10 |
| form must be listed in the windows menu More... | |
| #define | WOPN_CENTERED 0x20 |
| form will be centered on the screen More... | |
| #define | WOPN_PERSIST 0x40 |
| form will persist until explicitly closed with close_widget() More... | |
| #define | WOPN_CLOSED_BY_ESC 0x80 |
| override idagui.cfg:CLOSED_BY_ESC: esc will close | |
| #define | WOPN_NOT_CLOSED_BY_ESC 0x100 |
| override idagui.cfg:CLOSED_BY_ESC: esc will not close | |
| #define | WOPN_SZHINT 0x200 |
| when floating (i.e., not tabbed), use the widget's size hint to More... | |
| #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_CLOSE_LATER 0x8 |
| assign the deletion of the form to the UI loop ///< More... | |
| #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,. More... | |
| #define | DP_BEFORE 0x0020 |
| place src_form before dst_form in the tab bar instead of after More... | |
| #define | DP_FLOATING 0x0080 |
| Make src_form floating. | |
| #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 More... | |
| #define | CVNF_JUMP (1 << 1) |
| push the current position in this viewer's More... | |
| #define | CVNF_ACT (1 << 2) |
| activate (i.e., switch to) the viewer. 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 |
| #define | DECLARE_LINEARRAY_HELPERS(decl) |
| Helper for declaring member functions of the linearray_t class. More... | |
| #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 |
| trace 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_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 (1u << BWN_EXPORTS) |
| exports (0) | |
| #define | IWID_IMPORTS (1u << BWN_IMPORTS) |
| imports (1) | |
| #define | IWID_NAMES (1u << BWN_NAMES ) |
| names (2) | |
| #define | IWID_FUNCS (1u << BWN_FUNCS ) |
| functions (3) | |
| #define | IWID_STRINGS (1u << BWN_STRINGS) |
| strings (4) | |
| #define | IWID_SEGS (1u << BWN_SEGS ) |
| segments (5) | |
| #define | IWID_SEGREGS (1u << BWN_SEGREGS) |
| segment registers (6) | |
| #define | IWID_SELS (1u << BWN_SELS ) |
| selectors (7) | |
| #define | IWID_SIGNS (1u << BWN_SIGNS ) |
| signatures (8) | |
| #define | IWID_TILS (1u << BWN_TILS ) |
| type libraries (9) | |
| #define | IWID_LOCTYPS (1u << BWN_LOCTYPS) |
| local types (10) | |
| #define | IWID_CALLS (1u << BWN_CALLS ) |
| function calls (11) | |
| #define | IWID_PROBS (1u << BWN_PROBS ) |
| problems (12) | |
| #define | IWID_BPTS (1u << BWN_BPTS ) |
| breakpoints (13) | |
| #define | IWID_THREADS (1u << BWN_THREADS) |
| threads (14) | |
| #define | IWID_MODULES (1u << BWN_MODULES) |
| modules (15) | |
| #define | IWID_TRACE (1u << BWN_TRACE ) |
| trace view (16) | |
| #define | IWID_STACK (1u << BWN_STACK ) |
| call stack (17) | |
| #define | IWID_XREFS (1u << BWN_XREFS ) |
| xrefs (18) | |
| #define | IWID_SEARCHS (1u << BWN_SEARCH ) |
| search results (19) | |
| #define | IWID_FRAME (1u << BWN_FRAME ) |
| function frame (25) | |
| #define | IWID_NAVBAND (1u << BWN_NAVBAND) |
| navigation band (26) | |
| #define | IWID_ENUMS (1u << BWN_ENUMS ) |
| enumerations (27) | |
| #define | IWID_STRUCTS (1u << BWN_STRUCTS) |
| structures (28) | |
| #define | IWID_DISASMS (1u << BWN_DISASM ) |
| disassembly views (29) | |
| #define | IWID_DUMPS (1u << BWN_DUMP ) |
| hex dumps (30) | |
| #define | IWID_NOTEPAD (1u << BWN_NOTEPAD) |
| notepad (31) | |
| #define | IWID_IDAMEMOS (IWID_DISASMS|IWID_DUMPS) |
| disassembly + hex dump views | |
| #define | IWID_ALL 0xFFFFFFFF |
| mask | |
| #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_INTERNET 0x00100000 |
| internet connection | |
| #define | IDA_DEBUG_SIMPLEX 0x00200000 |
| full stack analysis | |
| #define | IDA_DEBUG_ALWAYS 0xFFFFFFFF |
| everything | |
| #define | deb(ida_debug_bits, ...) |
| #define | debug_time() ida_debug_time(__FILE__, __LINE__) |
| Print the tick count from the last call to debug_time(). More... | |
| #define | checkmem() do {} while (0) |
| Checking heap is not available anymore. | |
| #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 |
| #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_BUILTIN_SHIFT 19 |
| #define | CH_BUILTIN(id) ((id+1) << CH_BUILTIN_SHIFT) |
| #define | CH_BUILTIN_MASK (0x1F << CH_BUILTIN_SHIFT) |
| Mask for builtin chooser numbers. Plugins should not use them. | |
| #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_FORMAT 0x00070000 |
| column format mask | |
| #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 | CHOOSER_NO_SELECTION 0x01 |
| Flags. More... | |
| #define | CHOOSER_MULTI_SELECTION 0x02 |
| enable for multiple selections. More... | |
| #define | CHOOSER_POPUP_MENU 0x04 |
| Add command to the popup menu. | |
| #define | CHOOSER_MENU_EDIT 0 |
| Values of the `menu_index` parameter. More... | |
| #define | CHOOSER_MENU_JUMP 1 |
| Obsolete. Please don't use. | |
| #define | CHOOSER_MENU_SEARCH 2 |
| Obsolete. Please don't use. | |
| #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 | CLIF_QT_AWARE 1 |
| keydown event will use Qt key codes | |
| #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. More... | |
| #define | MFF_WRITE 0x0002 |
| Execute code only when ida is idle and it is safe. 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 More... | |
| #define | UIJMP_IDAVIEW 0x0004 |
| jump in idaview (by default any eaview is good) | |
| #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 | AHF_VERSION 1 |
| action handler version (used by action_handler_t::flags) | |
| #define | AHF_VERSION_MASK 0xFF |
| mask for action_handler_t::flags | |
| #define | ADF_OWN_HANDLER 0x1 |
| handler is owned by the action; it'll be More... | |
| #define | ACTION_DESC_LITERAL(name, label, handler, shortcut, tooltip, icon) { sizeof(action_desc_t), name, label, handler, &PLUGIN, shortcut, tooltip, icon, 0 } |
| Get an action_desc_t instance with your plugin as the owner. | |
| #define | ACTION_DESC_LITERAL_OWNER(name, label, handler, owner, shortcut, tooltip, icon) { sizeof(action_desc_t), name, label, handler, owner, shortcut, tooltip, icon, 0 } |
| Get an action_desc_t instance with a given owner. | |
| #define | DYNACTION_DESC_LITERAL(label, handler, shortcut, tooltip, icon) { sizeof(action_desc_t), NULL, label, handler, NULL, shortcut, tooltip, icon, ADF_OWN_HANDLER } |
| For attach_dynamic_action_to_popup() only. | |
| #define | CURPROC_ACTION_OWNER ((const plugin_t *) 1) |
| Specify that an action belongs to the current processor module. More... | |
| #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... | |
| #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 |
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 | |
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 bool idaapi | lochist_entry_cvt_t(lochist_entry_t *dst, const lochist_entry_t &src, TWidget *view) |
| Converts from an entry with a given place type, to another entry, with another place type, to be used with the view 'view'. More... | |
| typedef qvector< twinline_t > | text_t |
| A group of lines in a text window. | |
| typedef qvector< text_t > | texts_t |
| A collection of subdivisions of a text window. | |
| typedef int | twidget_type_t |
| Window types | |
| typedef chooser_t::cbret_t idaapi | chooser_cb_t(chooser_t *chobj, ssize_t n) |
| single selection chooser callback | |
| typedef chooser_base_t::cbres_t idaapi | chooser_multi_cb_t(chooser_multi_t *chobj, sizevec_t *sel) |
| multi selection chooser callback | |
| typedef uint32 idaapi | nav_colorizer_t(ea_t ea, asize_t nbytes) |
| Navigation band colorizer function. More... | |
| typedef int | 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) |
| Cursor position has been changed. | |
| 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. 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 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... | |
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_term, 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_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_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_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_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_set_nav_colorizer, ui_get_chooser_data, ui_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_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_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_end } |
| Events marked as 'ui:' should be used as a parameter to callui(). More... | |
| 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_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 | 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 } |
| Enumeration of form callback special values. | |
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. | |
| 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 bool ida_export_data | errorexit |
| Exiting because of a a fatal error? Is true if we are exiting with from the error() function. More... | |
Macro Definition Documentation
| #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
| #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.
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.)
| #define define_place_exported_functions | ( | classname | ) |
| #define DECLARE_LINEARRAY_HELPERS | ( | decl | ) |
Value:
The group of lines corresponding to a single place within a view.
Definition: kernwin.hpp:1841
#define ida_export
functions marked with this keyword are available as part of the IDA SDK
Definition: pro.h:240
Helper for declaring member functions of the linearray_t class.
| #define deb | ( | ida_debug_bits, | |
| ... | |||
| ) |
| #define debug_time | ( | ) | ida_debug_time(__FILE__, __LINE__) |
Print the tick count from the last call to debug_time().
The first time prints -1.
| #define CURPROC_ACTION_OWNER ((const plugin_t *) 1) |
Specify that an action belongs to the current processor module.
| #define DEF_SET_METHOD | ( | NAME, | |
| TYPE | |||
| ) |
Value:
{ \
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.
| #define DEF_FIELD_METHOD | ( | NAME, | |
| TYPE | |||
| ) |
Value:
{ \
return _get_field_value(field_id, val); \
} \
DEF_SET_METHOD(NAME, TYPE)
#define DEF_SET_METHOD(NAME, TYPE)
Helper to define functions in form_actions_t that get/set field values of different types...
Definition: kernwin.hpp:6135
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.
| #define DEF_STR_FIELD_METHOD | ( | NAME | ) |
Value:
{ \
return _get_str_field_value(field_id, buf, bufsize); \
} \
DEF_SET_METHOD(NAME, char)
#define DEF_SET_METHOD(NAME, TYPE)
Helper to define functions in form_actions_t that get/set field values of different types...
Definition: kernwin.hpp:6135
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
| typedef bool idaapi lochist_entry_cvt_t(lochist_entry_t *dst, const lochist_entry_t &src, TWidget *view) |
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 NULL.
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
- Returns
- color of the specified address in RGB
| 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.
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 place_t's internal state 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 that this callback shouldn't touch the 'renderer_info_t' part of 'loc': doing so will result in undefined behavior.
| 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
| 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
| 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.
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.
| 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
| 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
| enum mbox_kind_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 | |
| 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 | |
| chtype_idatil |
see choose_til() |
| chtype_enum_by_value_and_size | |
| chtype_srcp |
see choose_srcp() |
| enum tcc_renderer_type_t |
| enum tcc_place_type_t |
TWidget place_t type.
| Enumerator | |
|---|---|
| TCCPT_INVALID |
invalid |
| TCCPT_PLACE | |
| TCCPT_SIMPLELINE_PLACE | |
| TCCPT_IDAPLACE | |
| TCCPT_ENUMPLACE | |
| TCCPT_STRUCTPLACE | |
| 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 |
| 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
| ||||||||||||||||
| ui_refresh_choosers |
cb: The list (chooser) window contents have been changed (names, signatures, etc). UI should redraw them. Please consider request_refresh() instead
| ||||||||||||||||
| ui_idcstart |
cb: Start of IDC engine work.
| ||||||||||||||||
| ui_idcstop |
cb: Stop of IDC engine work.
| ||||||||||||||||
| ui_suspend |
cb: Suspend graphical interface. Only the text version. Interface should respond to it.
| ||||||||||||||||
| ui_resume |
cb: Resume the suspended graphical interface. Only the text version. Interface should respond to it
| ||||||||||||||||
| ui_broadcast |
broadcast call
| ||||||||||||||||
| 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.
| ||||||||||||||||
| 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.
| ||||||||||||||||
| ui_close_chooser |
ui: see close_chooser() | ||||||||||||||||
| ui_banner |
ui: see banner() | ||||||||||||||||
| ui_setidle |
ui: Set a function to call at idle times.
| ||||||||||||||||
| ui_term |
cb: IDA is terminated (the database is already closed). The UI may close its windows in this callback.
| ||||||||||||||||
| ui_beep |
ui: see beep() | ||||||||||||||||
| ui_is_msg_inited |
ui: see is_msg_inited() | ||||||||||||||||
| ui_msg |
ui: Show a message in the message window.
| ||||||||||||||||
| ui_mbox |
ui: Show a message box.
| ||||||||||||||||
| 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_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.
| ||||||||||||||||
| 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.
| ||||||||||||||||
| ui_unlock_range_refresh |
ui: Unlock the ui_range refreshes. If the number of locks is back to zero, then refresh the ranges.
| ||||||||||||||||
| ui_genfile_callback |
cb: handle html generation.
| ||||||||||||||||
| ui_open_url |
ui: see open_url() | ||||||||||||||||
| ui_hexdumpea |
ui: Return the current address in a hex view.
| ||||||||||||||||
| ui_get_key_code |
ui: see get_key_code() | ||||||||||||||||
| ui_setup_plugins_menu |
ui: setup plugins submenu
| ||||||||||||||||
| 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
| ||||||||||||||||
| ui_get_curplace |
ui: see get_custom_viewer_place() | ||||||||||||||||
| ui_display_widget |
ui: see display_widget() | ||||||||||||||||
| 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
| ||||||||||||||||
| 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
| ||||||||||||||||
| ui_widget_invisible |
TWidget is being closed. Use this event to destroy the window controls
| ||||||||||||||||
| 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
| ||||||||||||||||
| ui_get_item_hint |
cb: ui wants to display multiline hint for an item. See also more generic ui_get_custom_viewer_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).
| ||||||||||||||||
| ui_set_custom_viewer_range | |||||||||||||||||
| ui_database_inited |
cb: database initialization has completed. the kernel is about to run idc scripts
| ||||||||||||||||
| ui_ready_to_run |
cb: all UI elements have been initialized. Automatic plugins may hook to this event to perform their tasks.
| ||||||||||||||||
| 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.
| ||||||||||||||||
| ui_postprocess_action |
cb: an ida ui action has been handled | ||||||||||||||||
| ui_set_custom_viewer_mode |
ui: switch between graph/text modes.
| ||||||||||||||||
| 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.
| ||||||||||||||||
| 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()
| ||||||||||||||||
| 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.
| ||||||||||||||||
| ui_install_custom_optype_menu |
ui: install/remove custom operand type menu item.
| ||||||||||||||||
| 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
| ||||||||||||||||
| 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_refresh_custom_code_viewer |
ui: Refresh custom code viewer.
| ||||||||||||||||
| ui_create_source_viewer |
ui: Create new source viewer.
| ||||||||||||||||
| 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.
| ||||||||||||||||
| 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'.
| ||||||||||||||||
| 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_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.
| ||||||||||||||||
| ui_updated_actions |
cb: IDA is done updating actions.
| ||||||||||||||||
| 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.)
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().
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.
| ||||||||||||||||
| ui_plugin_unloading |
cb: The plugin is about to be unloaded
| ||||||||||||||||
| ui_get_widget_type |
ui: see get_widget_type() | ||||||||||||||||
| ui_current_widget_changed |
cb: The currently-active TWidget changed.
| ||||||||||||||||
| ui_get_widget_title |
ui: see get_widget_title() | ||||||||||||||||
| ui_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
| ||||||||||||||||
| 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_set_nav_colorizer |
ui: see set_nav_colorizer() | ||||||||||||||||
| ui_get_chooser_data |
ui: see get_chooser_data() | ||||||||||||||||
| ui_get_highlight |
ui: see get_highlight() | ||||||||||||||||
| 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
| ||||||||||||||||
| ui_screen_ea_changed |
cb: The "current address" changed
| ||||||||||||||||
| ui_last |
the last notification code | ||||||||||||||||
| ui_dbg_begin |
debugger callgates. should not be used directly, see dbg.hpp for details | ||||||||||||||||
Custom viewer & code viewer handler types.
| enum msg_notification_t |
Notification codes for events in the message window.
| 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.
| ||||||
| view_deactivated |
A view is deactivated.
| ||||||
| view_keydown |
Key down event.
| ||||||
| view_click |
Click event.
| ||||||
| view_dblclick |
Double click event.
| ||||||
| view_curpos |
Cursor position changed.
| ||||||
| view_created |
A view is being created.
| ||||||
| view_close |
View closed.
| ||||||
| view_switched |
A view's renderer has changed.
| ||||||
| 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.
| ||||||
| view_loc_changed |
The location for the view has changed (can be either the place_t, the renderer_info_t, or both.)
| ||||||
| view_mouse_moved |
The mouse moved on the view.
| ||||||
| 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 |
| enum action_attr_t |
Function Documentation
| 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
| idaman void ida_export term_database | ( | void | ) |
The database termination function.
This function should be called to close the database.
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 owner the owner plugin of the place_t type. Cannot be NULL.
- Returns
- the place_t ID, or -1 if an error occurred.
| 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 NULL) out_sdk_version sdk version the place was created with (can be NULL) id place class ID
- Returns
- the place_t template, or NULL if not found
| 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
| idaman void ida_export register_loc_converter | ( | const char * | p1, |
| const char * | p2, | ||
| lochist_entry_cvt_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.
| idaman lochist_entry_cvt_t* ida_export lookup_loc_converter | ( | const char * | p1, |
| const char * | p2 | ||
| ) |
| idaman void ida_export request_refresh | ( | unsigned int | mask, |
| bool | cnd = true |
||
| ) |
Request a refresh of a builtin window.
- Parameters
-
mask Window refresh flags cnd set if true or clear flag otherwise
| idaman bool ida_export is_refresh_requested | ( | unsigned int | mask | ) |
|
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
| idaman void ida_export ida_checkmem | ( | const char * | file, |
| int | line | ||
| ) |
Checking heap is not available anymore.
|
inline |
Install new navigation band colorizer (ui_set_nav_colorizer).
- Returns
- the previous colorizer function
|
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
|
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 NULL to terminate the var arg request list
- Returns
- a request id: a unique number that can be used to cancel the request
|
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.
|
inline |
Jump to the specified address (ui_jumpto).
- Parameters
-
ea destination opnum -1: don't change x coord uijmp_flags Jump flags
- Returns
- success
|
inline |
Show a banner dialog box (ui_banner).
- Parameters
-
wait time to wait before closing
- Return values
-
1 ok 0 esc was pressed
|
inline |
Refresh all disassembly views (ui_refresh), forces an immediate refresh.
Please consider request_refresh() instead
|
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
|
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
|
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)
|
inline |
Get the current address in a hex view.
- Parameters
-
hexdump_num number of hexview window
|
inline |
Get shortcut code previously created by ui_get_key_code.
- Parameters
-
key key constant shift modifiers is_qt are we using gui version?
|
inline |
Refresh navigation band if changed (ui_refresh_navband).
- Parameters
-
force refresh regardless
|
inline |
Mark a non-modal custom chooser for a refresh (ui_refresh_chooser).
- Parameters
-
title title of chooser
- Returns
- success
|
inline |
Close a non-modal chooser (ui_close_chooser).
- Parameters
-
title window title of chooser to close
- Returns
- success
Generate disassembly text for a range.
- Parameters
-
[out] text result ea1 start address ea2 end address truncate_lines (on idainfo::margin)
|
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().
|
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 NULL 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
|
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
|
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
|
inline |
Processes a UI action by name.
- Parameters
-
name action name flags reserved/not used param reserved/not used
|
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
|
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 NULL 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.
|
inline |
Register a timer (