IDAPython 9.0
Loading...
Searching...
No Matches
enum_type_data_t Class Reference

Proxy of C++ enum_type_data_t class.

Inheritance diagram for enum_type_data_t:
edmvec_t

Public Member Functions

 __init__ (self, *args)
 init(self, _bte=BTE_ALWAYS|BTE_HEX) -> enum_type_data_t
 
"int" get_enum_radix (self)
 get_enum_radix(self) -> int Get enum constant radix
 
"bool" is_number_signed (self)
 is_number_signed(self) -> bool
 
"void" set_enum_radix (self, "int" radix, "bool" sign)
 set_enum_radix(self, radix, sign) Set radix to display constants
 
"bool" is_char (self)
 is_char(self) -> bool
 
"bool" is_dec (self)
 is_dec(self) -> bool
 
"bool" is_hex (self)
 is_hex(self) -> bool
 
"bool" is_oct (self)
 is_oct(self) -> bool
 
"bool" is_bin (self)
 is_bin(self) -> bool
 
"bool" is_udec (self)
 is_udec(self) -> bool
 
"bool" is_shex (self)
 is_shex(self) -> bool
 
"bool" is_soct (self)
 is_soct(self) -> bool
 
"bool" is_sbin (self)
 is_sbin(self) -> bool
 
"bool" has_lzero (self)
 has_lzero(self) -> bool
 
"void" set_lzero (self, "bool" on)
 set_lzero(self, on)
 
"uint64" calc_mask (self)
 calc_mask(self) -> uint64
 
"bool" store_64bit_values (self)
 store_64bit_values(self) -> bool
 
"bool" is_bf (self)
 is_bf(self) -> bool is bitmask or ordinary enum?
 
"int" calc_nbytes (self)
 calc_nbytes(self) -> int get the width of enum in bytes
 
"bool" set_nbytes (self, "int" nbytes)
 set_nbytes(self, nbytes) -> bool set enum width (nbytes)
 
"bool" is_group_mask_at (self, "size_t" idx)
 is_group_mask_at(self, idx) -> bool is the enum member at IDX a non-trivial group mask? a trivial group consist of one bit and has just one member, which can be considered as a mask or a bitfield constant
 
"bool" is_valid_group_sizes (self)
 is_valid_group_sizes(self) -> bool is valid group sizes
 
"ssize_t" find_member (self, *args)
 find_member(self, name, _from=0, to=size_t(-1)) -> ssize_t find member (constant or bmask) by value
 
"void" swap (self, "enum_type_data_t" r)
 swap(self, r) swap two instances
 
"void" add_constant (self, "char const *" name, "uint64" value, "char const *" cmt=None)
 add_constant(self, name, value, cmt=None) add constant for regular enum
 
"tinfo_code_t" get_value_repr (self, "value_repr_t" repr)
 get_value_repr(self, repr) -> tinfo_code_t get enum radix and other representation info
 
"tinfo_code_t" set_value_repr (self, "value_repr_t" repr)
 set_value_repr(self, repr) -> tinfo_code_t set enum radix and other representation info
 
"uchar" get_serial (self, "size_t" index)
 get_serial(self, index) -> uchar returns serial for the constant
 
"uchar" get_max_serial (self, "uint64" value)
 get_max_serial(self, value) -> uchar return the maximum serial for the value
 
"PyObject *" get_constant_group (self, *args)
 get_constant_group(self, group_start_index, group_size, idx) -> bool get group parameters for the constant, valid for bitmask enum
 
 all_groups (self, skip_trivial=False)
 Generate tuples for bitmask enum groups.
 
 all_constants (self)
 Generate tupples of all constants except of bitmasks.
 
- Public Member Functions inherited from edmvec_t
"edm_t &" push_back (self, *args)
 push_back(self, x)
 
"void" pop_back (self)
 pop_back(self)
 
"size_t" size (self)
 size(self) -> size_t
 
"bool" empty (self)
 empty(self) -> bool
 
"edm_t const &" at (self, "size_t" _idx)
 at(self, _idx) -> edm_t
 
"void" qclear (self)
 qclear(self)
 
"void" clear (self)
 clear(self)
 
"void" resize (self, *args)
 resize(self, _newsize, x)
 
"void" grow (self, *args)
 grow(self, x=edm_t())
 
"size_t" capacity (self)
 capacity(self) -> size_t
 
"void" reserve (self, "size_t" cnt)
 reserve(self, cnt)
 
"void" truncate (self)
 truncate(self)
 
"edm_t *" extract (self)
 extract(self) -> edm_t
 
"void" inject (self, "edm_t" s, "size_t" len)
 inject(self, s, len)
 
"bool" __eq__ (self, "edmvec_t" r)
 eq(self, r) -> bool
 
"bool" __ne__ (self, "edmvec_t" r)
 ne(self, r) -> bool
 
"qvector< edm_t >::const_iterator" begin (self, *args)
 begin(self) -> edm_t
 
"qvector< edm_t >::const_iterator" end (self, *args)
 end(self) -> edm_t
 
"qvector< edm_t >::iterator" insert (self, "edm_t" it, "edm_t" x)
 insert(self, it, x) -> edm_t
 
"qvector< edm_t >::iterator" erase (self, *args)
 erase(self, it) -> edm_t
 
"qvector< edm_t >::const_iterator" find (self, *args)
 find(self, x) -> edm_t
 
"bool" has (self, "edm_t" x)
 has(self, x) -> bool
 
"bool" add_unique (self, "edm_t" x)
 add_unique(self, x) -> bool
 
"size_t" __len__ (self)
 len(self) -> size_t
 
"edm_t const &" __getitem__ (self, "size_t" i)
 getitem(self, i) -> edm_t
 
"void" __setitem__ (self, "size_t" i, "edm_t" v)
 setitem(self, i, v)
 
"void" append (self, "edm_t" x)
 append(self, x)
 
"void" extend (self, "edmvec_t" x)
 extend(self, x)
 

Public Attributes

int group_sizes = 1:
 

Static Public Attributes

str group_sizes = property(_ida_typeinf.enum_type_data_t_group_sizes_get, _ida_typeinf.enum_type_data_t_group_sizes_set, doc=)
 
str taenum_bits = property(_ida_typeinf.enum_type_data_t_taenum_bits_get, _ida_typeinf.enum_type_data_t_taenum_bits_set, doc=)
 
str bte = property(_ida_typeinf.enum_type_data_t_bte_get, _ida_typeinf.enum_type_data_t_bte_set, doc=)
 
- Static Public Attributes inherited from edmvec_t
 front = ida_idaapi._qvector_front
 
 back = ida_idaapi._qvector_back
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 
- Properties inherited from edmvec_t
 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Additional Inherited Members

- Protected Member Functions inherited from edmvec_t
"bool" _del (self, "edm_t" x)
 _del(self, x) -> bool
 

Constructor & Destructor Documentation

◆ __init__()

__init__ ( self,
* args )
Parameters
_btebte_t

Reimplemented from edmvec_t.

Member Function Documentation

◆ add_constant()

"void" add_constant ( self,
"char const *" name,
"uint64" value,
"char const *" cmt = None )
Parameters
name(C++: const char *) char const *
value(C++: uint64)
cmt(C++: const char *) char const *

◆ all_constants()

all_constants ( self)

Each tupple is: [0] constant index [1] enum member index of group start [2] group size In case of regular enum the second element of tupple is 0 and the third element of tupple is the number of enum members.

◆ all_groups()

all_groups ( self,
skip_trivial = False )

Each tupple is: [0] enum member index of group start [1] group size Tupples may include or not the group with 1 element.

◆ calc_mask()

"uint64" calc_mask ( self)

◆ calc_nbytes()

"int" calc_nbytes ( self)

◆ find_member()

"ssize_t" find_member ( self,
* args )
Parameters
namechar const *
from(C++: size_t)
to(C++: size_t)

find_member(self, value, serial, _from=0, to=size_t(-1), vmask=uint64(-1)) -> ssize_t

Parameters
valueuint64
serialuchar
fromsize_t
tosize_t
vmaskuint64

◆ get_constant_group()

"PyObject *" get_constant_group ( self,
* args )
Parameters
group_start_index(C++: size_t *) index of the group mask
group_size(C++: size_t *) group size (>=1)
idx(C++: size_t) constant index
Returns
: success get_constant_group(self, idx) -> PyObject *
Parameters
idxsize_t

◆ get_enum_radix()

"int" get_enum_radix ( self)
Returns
: radix or 1 for BTE_CHAR

◆ get_max_serial()

"uchar" get_max_serial ( self,
"uint64" value )
Parameters
value(C++: uint64)

◆ get_serial()

"uchar" get_serial ( self,
"size_t" index )
Parameters
index(C++: size_t)

◆ get_value_repr()

"tinfo_code_t" get_value_repr ( self,
"value_repr_t" repr )
Parameters
repr(C++: value_repr_t *) value display info

◆ has_lzero()

"bool" has_lzero ( self)

◆ is_bf()

"bool" is_bf ( self)

◆ is_bin()

"bool" is_bin ( self)

◆ is_char()

"bool" is_char ( self)

◆ is_dec()

"bool" is_dec ( self)

◆ is_group_mask_at()

"bool" is_group_mask_at ( self,
"size_t" idx )
Parameters
idx(C++: size_t) index
Returns
: success

◆ is_hex()

"bool" is_hex ( self)

◆ is_number_signed()

"bool" is_number_signed ( self)

◆ is_oct()

"bool" is_oct ( self)

◆ is_sbin()

"bool" is_sbin ( self)

◆ is_shex()

"bool" is_shex ( self)

◆ is_soct()

"bool" is_soct ( self)

◆ is_udec()

"bool" is_udec ( self)

◆ is_valid_group_sizes()

"bool" is_valid_group_sizes ( self)

◆ set_enum_radix()

"void" set_enum_radix ( self,
"int" radix,
"bool" sign )
Parameters
radix(C++: int) radix with the special case 1 to display as character
sign(C++: bool)

◆ set_lzero()

"void" set_lzero ( self,
"bool" on )
Parameters
onbool

◆ set_nbytes()

"bool" set_nbytes ( self,
"int" nbytes )
Parameters
nbytes(C++: int)

◆ set_value_repr()

"tinfo_code_t" set_value_repr ( self,
"value_repr_t" repr )
Parameters
repr(C++: const value_repr_t &) value display info

◆ store_64bit_values()

"bool" store_64bit_values ( self)

◆ swap()

"void" swap ( self,
"enum_type_data_t" r )
Parameters
r(C++: enum_type_data_t &)

Reimplemented from edmvec_t.

Member Data Documentation

◆ bte

str bte = property(_ida_typeinf.enum_type_data_t_bte_get, _ida_typeinf.enum_type_data_t_bte_set, doc=)
static

◆ group_sizes [1/2]

group_sizes = property(_ida_typeinf.enum_type_data_t_group_sizes_get, _ida_typeinf.enum_type_data_t_group_sizes_set, doc=)
static

◆ group_sizes [2/2]

int group_sizes = 1:

◆ taenum_bits

str taenum_bits = property(_ida_typeinf.enum_type_data_t_taenum_bits_get, _ida_typeinf.enum_type_data_t_taenum_bits_set, doc=)
static

Property Documentation

◆ thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

The documentation for this class was generated from the following file: