bitrange_t Class Reference

Proxy of C++ bitrange_t class.

Inheritance diagram for bitrange_t:

Public Member Functions
	__init__ (self, "uint16" bit_ofs=0, "uint16" size_in_bits=0)
	init(self, bit_ofs=0, size_in_bits=0) -> bitrange_t
"void"	init (self, "uint16" bit_ofs, "uint16" size_in_bits)
	init(self, bit_ofs, size_in_bits) Initialize offset and size to given values.
"void"	reset (self)
	reset(self) Make the bitrange empty.
"bool"	empty (self)
	empty(self) -> bool Is the bitrange empty?
"uint"	bitoff (self)
	bitoff(self) -> uint Get offset of 1st bit.
"uint"	bitsize (self)
	bitsize(self) -> uint Get size of the value in bits.
"uint"	bytesize (self)
	bytesize(self) -> uint Size of the value in bytes.
"uint64"	mask64 (self)
	mask64(self) -> uint64 Convert to mask of 64 bits.
"bool"	has_common (self, "bitrange_t" r)
	has_common(self, r) -> bool Does have common bits with another bitrange?
"bool"	apply_mask (self, "bitrange_t" subrange)
	apply_mask(self, subrange) -> bool Apply mask to a bitrange
"void"	intersect (self, "bitrange_t" r)
	intersect(self, r) Intersect two ranges.
"void"	create_union (self, "bitrange_t" r)
	create_union(self, r) Create union of 2 ranges including the hole between them.
"bool"	sub (self, "bitrange_t" r)
	sub(self, r) -> bool Subtract a bitrange.
"void"	shift_down (self, "uint" cnt)
	shift_down(self, cnt) Shift range down (left)
"void"	shift_up (self, "uint" cnt)
	shift_up(self, cnt) Shift range up (right)
"bool"	extract (self, "void const *" src, "bool" is_mf)
	extract(self, src, is_mf) -> bool
"bool"	inject (self, "void *" dst, "bytevec_t const &" src, "bool" is_mf)
	inject(self, dst, src, is_mf) -> bool
"bool"	__eq__ (self, "bitrange_t" r)
	eq(self, r) -> bool
"bool"	__ne__ (self, "bitrange_t" r)
	ne(self, r) -> bool
"bool"	__lt__ (self, "bitrange_t" r)
	lt(self, r) -> bool
"bool"	__gt__ (self, "bitrange_t" r)
	gt(self, r) -> bool
"bool"	__le__ (self, "bitrange_t" r)
	le(self, r) -> bool
"bool"	__ge__ (self, "bitrange_t" r)
	ge(self, r) -> bool
"int"	compare (self, "bitrange_t" r)
	compare(self, r) -> int
"qstring"	__str__ (self)
	str(self) -> qstring

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

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		"uint16"	bit_ofs = 0,
		"uint16"	size_in_bits = 0 )

Parameters

bit_ofs	uint16
size_in_bits	uint16

Member Function Documentation

__eq__()

"bool" __eq__	(		self,
		"bitrange_t"	r )

Parameters

r	bitrange_t const &

__ge__()

"bool" __ge__	(		self,
		"bitrange_t"	r )

Parameters

r	bitrange_t const &

__gt__()

"bool" __gt__	(		self,
		"bitrange_t"	r )

Parameters

r	bitrange_t const &

__le__()

"bool" __le__	(		self,
		"bitrange_t"	r )

Parameters

r	bitrange_t const &

__lt__()

"bool" __lt__	(		self,
		"bitrange_t"	r )

Parameters

r	bitrange_t const &

__ne__()

"bool" __ne__	(		self,
		"bitrange_t"	r )

Parameters

r	bitrange_t const &

__str__()

"qstring" __str__

(

self

)

apply_mask()

"bool" apply_mask	(		self,
		"bitrange_t"	subrange )

Parameters

subrange

(C++: const bitrange_t &) range inside the main bitrange to keep After this operation the main bitrange will be truncated to have only the bits that are specified by subrange. Example: [off=8,nbits=4], subrange[off=1,nbits=2] => [off=9,nbits=2]

Returns

: success

bitoff()

"uint" bitoff

(

self

)

bitsize()

"uint" bitsize

(

self

)

bytesize()

"uint" bytesize

(

self

)

compare()

"int" compare	(		self,
		"bitrange_t"	r )

Parameters

r	bitrange_t const &

create_union()

"void" create_union	(		self,
		"bitrange_t"	r )

Parameters

r	(C++: const bitrange_t &) bitrange_t const &

empty()

"bool" empty

(

self

)

extract()

"bool" extract	(		self,
		"void const *"	src,
		"bool"	is_mf )

Parameters

src	void const *
is_mf	bool

has_common()

"bool" has_common	(		self,
		"bitrange_t"	r )

Parameters

r	(C++: const bitrange_t &) bitrange_t const &

init()

"void" init	(		self,
		"uint16"	bit_ofs,
		"uint16"	size_in_bits )

Parameters

bit_ofs	(C++: uint16)
size_in_bits	(C++: uint16)

inject()

"bool" inject	(		self,
		"void *"	dst,
		"bytevec_t const &"	src,
		"bool"	is_mf )

Parameters

dst	void *
src	bytevec_t const &
is_mf	bool

intersect()

"void" intersect	(		self,
		"bitrange_t"	r )

Parameters

r	(C++: const bitrange_t &) bitrange_t const &

mask64()

"uint64" mask64

(

self

)

reset()

"void" reset

(

self

)

shift_down()

"void" shift_down	(		self,
		"uint"	cnt )

Parameters

cnt	(C++: uint)

shift_up()

"void" shift_up	(		self,
		"uint"	cnt )

Parameters

cnt	(C++: uint)

sub()

"bool" sub	(		self,
		"bitrange_t"	r )

Parameters

r	(C++: const bitrange_t &) bitrange_t const &

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:

• ida_bitrange.py