IDAPython 8.4
Loading...
Searching...
No Matches
ida_enum.py File Reference

Classes

class  enum_member_visitor_t
 Proxy of C++ enum_member_visitor_t class. More...
 

Namespaces

namespace  ida_enum
 

Functions

"size_t" get_enum_qty (*args)
 get_enum_qty() -> size_t Get number of declared enum_t types.
 
"enum_t" getn_enum (*args)
 getn_enum(idx) -> enum_t Get enum by its index in the list of enums (0..get_enum_qty()-1).
 
"uval_t" get_enum_idx (*args)
 get_enum_idx(id) -> uval_t Get the index in the list of enums.
 
"enum_t" get_enum (*args)
 get_enum(name) -> enum_t Get enum by name.
 
"bool" is_bf (*args)
 is_bf(id) -> bool Is enum a bitfield? (otherwise - plain enum, no bitmasks except for DEFMASK are allowed)
 
"bool" is_enum_hidden (*args)
 is_enum_hidden(id) -> bool Is enum collapsed?
 
"bool" set_enum_hidden (*args)
 set_enum_hidden(id, hidden) -> bool Collapse enum.
 
"bool" is_enum_fromtil (*args)
 is_enum_fromtil(id) -> bool Does enum come from type library?
 
"bool" set_enum_fromtil (*args)
 set_enum_fromtil(id, fromtil) -> bool Specify that enum comes from a type library.
 
"bool" is_ghost_enum (*args)
 is_ghost_enum(id) -> bool Is a ghost copy of a local type?
 
"bool" set_enum_ghost (*args)
 set_enum_ghost(id, ghost) -> bool Specify that enum is a ghost copy of a local type.
 
"qstring *" get_enum_name (*args)
 get_enum_name(id) -> str
 
"qstring *" get_enum_name2 (*args)
 get_enum_name2(id, flags=0) -> str Get name of enum
 
"size_t" get_enum_width (*args)
 get_enum_width(id) -> size_t Get the width of a enum element allowed values: 0 (unspecified),1,2,4,8,16,32,64
 
"bool" set_enum_width (*args)
 set_enum_width(id, width) -> bool See comment for get_enum_width()
 
"qstring *" get_enum_cmt (*args)
 get_enum_cmt(id, repeatable) -> str Get enum comment.
 
"size_t" get_enum_size (*args)
 get_enum_size(id) -> size_t Get the number of the members of the enum.
 
"flags64_t" get_enum_flag (*args)
 get_enum_flag(id) -> flags64_t Get flags determining the representation of the enum.
 
"const_t" get_enum_member_by_name (*args)
 get_enum_member_by_name(name) -> const_t Get a reference to an enum member by its name.
 
"uval_t" get_enum_member_value (*args)
 get_enum_member_value(id) -> uval_t Get value of an enum member.
 
"enum_t" get_enum_member_enum (*args)
 get_enum_member_enum(id) -> enum_t Get the parent enum of an enum member.
 
"bmask_t" get_enum_member_bmask (*args)
 get_enum_member_bmask(id) -> bmask_t Get bitmask of an enum member.
 
"const_t" get_enum_member (*args)
 get_enum_member(id, value, serial, mask) -> const_t Find an enum member by enum, value and bitmask
 
"bmask_t" get_first_bmask (*args)
 get_first_bmask(enum_id) -> bmask_t Get first bitmask in the enum (bitfield)
 
"bmask_t" get_last_bmask (*args)
 get_last_bmask(enum_id) -> bmask_t Get last bitmask in the enum (bitfield)
 
"bmask_t" get_next_bmask (*args)
 get_next_bmask(enum_id, bmask) -> bmask_t Get next bitmask in the enum (bitfield)
 
"bmask_t" get_prev_bmask (*args)
 get_prev_bmask(enum_id, bmask) -> bmask_t Get prev bitmask in the enum (bitfield)
 
"uval_t" get_first_enum_member (*args)
 get_first_enum_member(id, bmask=(bmask_t(-1))) -> uval_t
 
"uval_t" get_last_enum_member (*args)
 get_last_enum_member(id, bmask=(bmask_t(-1))) -> uval_t
 
"uval_t" get_next_enum_member (*args)
 get_next_enum_member(id, value, bmask=(bmask_t(-1))) -> uval_t
 
"uval_t" get_prev_enum_member (*args)
 get_prev_enum_member(id, value, bmask=(bmask_t(-1))) -> uval_t
 
"qstring *" get_enum_member_name (*args)
 get_enum_member_name(id) -> str Get name of an enum member by const_t.
 
"qstring *" get_enum_member_cmt (*args)
 get_enum_member_cmt(id, repeatable) -> str Get enum member's comment.
 
"uchar *" get_first_serial_enum_member (*args)
 get_first_serial_enum_member(id, value, bmask) -> const_t
 
"uchar *" get_last_serial_enum_member (*args)
 get_last_serial_enum_member(id, value, bmask) -> const_t
 
"uchar *" get_next_serial_enum_member (*args)
 get_next_serial_enum_member(in_out_serial, first_cid) -> const_t
 
"uchar *" get_prev_serial_enum_member (*args)
 get_prev_serial_enum_member(in_out_serial, first_cid) -> const_t
 
"int" for_all_enum_members (*args)
 for_all_enum_members(id, cv) -> int Visit all members of a given enum.
 
"uchar" get_enum_member_serial (*args)
 get_enum_member_serial(cid) -> uchar Get serial number of an enum member.
 
"int32" get_enum_type_ordinal (*args)
 get_enum_type_ordinal(id) -> int32 Get corresponding type ordinal number.
 
"void" set_enum_type_ordinal (*args)
 set_enum_type_ordinal(id, ord) Set corresponding type ordinal number.
 
"enum_t" add_enum (*args)
 add_enum(idx, name, flag) -> enum_t Add new enum type.
 
"void" del_enum (*args)
 del_enum(id) Delete an enum type.
 
"bool" set_enum_idx (*args)
 set_enum_idx(id, idx) -> bool Set serial number of enum.
 
"bool" set_enum_bf (*args)
 set_enum_bf(id, bf) -> bool Set 'bitfield' bit of enum (i.e.
 
"bool" set_enum_name (*args)
 set_enum_name(id, name) -> bool Set name of enum type.
 
"bool" set_enum_cmt (*args)
 set_enum_cmt(id, cmt, repeatable) -> bool Set comment for enum type.
 
"bool" set_enum_flag (*args)
 set_enum_flag(id, flag) -> bool Set data representation flags.
 
"int" add_enum_member (*args)
 add_enum_member(id, name, value, bmask=(bmask_t(-1))) -> int Add member to enum type.
 
"bool" del_enum_member (*args)
 del_enum_member(id, value, serial, bmask) -> bool Delete member of enum type.
 
"bool" set_enum_member_name (*args)
 set_enum_member_name(id, name) -> bool Set name of enum member.
 
"bool" set_enum_member_cmt (*args)
 set_enum_member_cmt(id, cmt, repeatable) -> bool Set comment for enum member.
 
"bool" is_one_bit_mask (*args)
 is_one_bit_mask(mask) -> bool Is bitmask one bit?
 
"bool" set_bmask_name (*args)
 set_bmask_name(id, bmask, name) -> bool
 
"qstring *" get_bmask_name (*args)
 get_bmask_name(id, bmask) -> str
 
"bool" set_bmask_cmt (*args)
 set_bmask_cmt(id, bmask, cmt, repeatable) -> bool
 
"qstring *" get_bmask_cmt (*args)
 get_bmask_cmt(id, bmask, repeatable) -> str
 

Variables

 DEFMASK = _ida_enum.DEFMASK
 
 ENFL_REGEX = _ida_enum.ENFL_REGEX
 
 cvar = _ida_enum.cvar
 
 MAX_ENUM_SERIAL = cvar.MAX_ENUM_SERIAL
 
 ENUM_MEMBER_ERROR_NAME = _ida_enum.ENUM_MEMBER_ERROR_NAME
 
 ENUM_MEMBER_ERROR_VALUE = _ida_enum.ENUM_MEMBER_ERROR_VALUE
 
 ENUM_MEMBER_ERROR_ENUM = _ida_enum.ENUM_MEMBER_ERROR_ENUM
 
 ENUM_MEMBER_ERROR_MASK = _ida_enum.ENUM_MEMBER_ERROR_MASK
 
 ENUM_MEMBER_ERROR_ILLV = _ida_enum.ENUM_MEMBER_ERROR_ILLV