tiplace_t Class Reference

Proxy of C++ tiplace_t class.

Inheritance diagram for tiplace_t:

Public Member Functions
	__init__ (self, *args, **kwargs)
"bool"	valid_ord (self, *args)
	valid_ord(self) -> bool
"void"	reset (self, *args)
	reset(self)
"bool"	is_header (self, *args)
	is_header(self) -> bool
"bool"	is_footer (self, *args)
	is_footer(self) -> bool
"bool"	is_index (self, *args)
	is_index(self) -> bool
"void"	set_header (self, *args)
	set_header(self)
"void"	set_footer (self, *args)
	set_footer(self)
"uint64"	calc_udm_offset (self, *args)
	calc_udm_offset(self, ud, p_udmidx=None, p_bitoff=None) -> uint64 for structs: calculate the offset that corresponds to the tiplace.
"void"	set_index_by_offset (self, *args)
	set_index_by_offset(self, ud, offset) for structs: calculate the index that corresponds to the offset and set it.
"type_t"	get_kind (self, *args)
	get_kind(self, ud) -> type_t get the kind of type this place represents
"bool"	fill_type_ref (self, *args)
	fill_type_ref(self, out, ud) -> bool fill the type information for use in actions
Public Member Functions inherited from place_t
"uval_t"	touval (self, *args)
	touval(self, ud) -> uval_t Map the location to a number.
"place_t *"	clone (self, *args)
	clone(self) -> place_t Clone the location.
"void"	copyfrom (self, *args)
	copyfrom(self, _from) Copy the specified location object to the current object.
"place_t *"	makeplace (self, *args)
	makeplace(self, ud, x, lnnum) -> place_t Map a number to a location.
"int"	compare (self, *args)
	compare(self, t2) -> int Deprecated.
"void"	adjust (self, *args)
	adjust(self, ud) Adjust the current location to point to a displayable object.
"bool"	prev (self, *args)
	prev(self, ud) -> bool Move to the previous displayable location.
"bool"	next (self, *args)
	next(self, ud) -> bool Move to the next displayable location.
"bool"	beginning (self, *args)
	beginning(self, ud) -> bool Are we at the first displayable object?.
"bool"	ending (self, *args)
	ending(self, ud) -> bool Are we at the last displayable object?.
"void"	serialize (self, *args)
	serialize(self) Serialize this instance.
"int"	id (self, *args)
	id(self) -> int Get the place's ID (i.e., the value returned by register_place_class())
"char const *"	name (self, *args)
	name(self) -> char const * Get this place type name.
"ea_t"	toea (self, *args)
	toea(self) -> ea_t Map the location to an ea_t.
"bool"	rebase (self, *args)
	rebase(self, arg2) -> bool Rebase the place instance
"place_t *"	enter (self, *args)
	enter(self, arg2) -> place_t Visit this place, possibly 'unhiding' a section of text.
"void"	leave (self, *args)
	leave(self, arg2) Leave this place, possibly 'hiding' a section of text that was previously expanded (at enter()-time.)
"int"	compare2 (self, *args)
	compare2(self, t2, arg3) -> int Compare two locations except line numbers (lnnum).
"bool"	deserialize (self, *args)
	deserialize(self, _in) -> bool De-serialize into this instance.
"PyObject *"	generate (self, *args)
	generate(self, ud, maxsize) -> ([str, ...], int, int, int) Generate text lines for the current location.

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
	ordinal = property(_ida_kernwin.tiplace_t_ordinal_get, _ida_kernwin.tiplace_t_ordinal_set, doc=)
	cursor = property(_ida_kernwin.tiplace_t_cursor_get, _ida_kernwin.tiplace_t_cursor_set, doc=!)
Properties inherited from place_t
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
	lnnum = property(_ida_kernwin.place_t_lnnum_get, _ida_kernwin.place_t_lnnum_set, doc=)

Additional Inherited Members
Static Public Member Functions inherited from place_t
"idaplace_t *"	as_idaplace_t (*args)
	as_idaplace_t(p) -> idaplace_t
"enumplace_t *"	as_enumplace_t (*args)
	as_enumplace_t(p) -> enumplace_t
"structplace_t *"	as_structplace_t (*args)
	as_structplace_t(p) -> structplace_t
"simpleline_place_t *"	as_simpleline_place_t (*args)
	as_simpleline_place_t(p) -> simpleline_place_t
"tiplace_t *"	as_tiplace_t (*args)
	as_tiplace_t(p) -> tiplace_t
Protected Member Functions inherited from place_t
"void"	_print (self, *args)
	_print(self, ud)

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		*	args,
		**	kwargs )

Reimplemented from place_t.

Member Function Documentation

calc_udm_offset()

"uint64" calc_udm_offset	(		self,
		*	args )

Parameters

ud	(C++: const void *) pointer to user-defined context data. Is supplied by linearray_t
p_udmidx	(C++: ssize_t *) place to return the index of the current udt member, if any. if there is no member at the current offset, return -1
p_bitoff	(C++: int *) place to return the bit offset of the item from the beginning of the bit bucket if there no bitfields, return -1

Returns

: the current offset or uint64(-1)

fill_type_ref()

"bool" fill_type_ref	(		self,
		*	args )

Parameters

out	(C++: til_type_ref_t *) pointer to storage
ud	(C++: const void *) pointer to user-defined context data. Is supplied by linearray_t

Returns

: success

get_kind()

"type_t" get_kind	(		self,
		*	args )

Parameters

ud	(C++: const void *) pointer to user-defined context data. Is supplied by linearray_t

Returns

: one of BTF_TYPEDEF, BTF_STRUCT, BTF_UNION, BTF_ENUM or BT_UNK

is_footer()

"bool" is_footer	(		self,
		*	args )

is_header()

"bool" is_header	(		self,
		*	args )

is_index()

"bool" is_index	(		self,
		*	args )

reset()

"void" reset	(		self,
		*	args )

set_footer()

"void" set_footer	(		self,
		*	args )

set_header()

"void" set_header	(		self,
		*	args )

set_index_by_offset()

"void" set_index_by_offset	(		self,
		*	args )

Parameters

ud	(C++: void *) pointer to user-defined context data. Is supplied by linearray_t
offset	(C++: uint64) offset of udt member

valid_ord()

"bool" valid_ord	(		self,
		*	args )

Property Documentation

cursor

cursor = property(_ida_kernwin.tiplace_t_cursor_get, _ida_kernwin.tiplace_t_cursor_set, doc=!)

static

ordinal

ordinal = property(_ida_kernwin.tiplace_t_ordinal_get, _ida_kernwin.tiplace_t_ordinal_set, doc=)

static

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:

• ida_kernwin.py