class documentation

class Category(object):

View In Hierarchy

Category of a register.

Not meant to be instantiated directly. Use Register.category or helpers.all_categories instead.

Method __eq__ Compares the instance for equality with an object.
Method __init__ Initializes a new Category instance. Not meant to be used directly. Use Register.category or helpers.all_categories instead.
Method __ne__ Compares the instance for equality with an object.
Method __repr__ Undocumented
Method __str__ Undocumented
Method registers Returns an generator over all registers that belong to this category
Property name Property: The name of the category as a string
Instance Variable _rvn_category Undocumented
def __eq__(self, r):

Compares the instance for equality with an object.

  • if the object is not a Category, the behavior is unspecified.
def __init__(self, _rvn_category):

Initializes a new Category instance. Not meant to be used directly. Use Register.category or helpers.all_categories instead.

Parameters
_rvn_category:_rvn_api.RegisterCategoryUndocumented
def __ne__(self, r):

Compares the instance for equality with an object.

  • if the object is not a Category, the behavior is unspecified.
Parameters
r:objectUndocumented
Returns
boolUndocumented
def __repr__(self):

Undocumented

def __str__(self):

Undocumented

def registers(self):

Returns an generator over all registers that belong to this category

Examples

>>> list(arch.x64.cf.category.registers())
[Register(x64.iopl), Register(x64.tf), Register(x64.df), Register(x64.zf),
Register(x64.rf), Register(x64.of), Register(x64.vif), Register(x64.cf),
Register(x64.vip), Register(x64.pf), Register(x64.vm), Register(x64.ac),
Register(x64.af), Register(x64.id), Register(x64.if), Register(x64.nt),
Register(x64.sf)]

Information

Returns
_Iterator[Register]A generator of Register.
@property
name: str =

Property: The name of the category as a string

Examples

Filtering on the registers of the flags category:

>>> [r for r in arch.helpers.x64_registers() if r.category_name == "flags"]
[Register(x64.iopl), Register(x64.tf), Register(x64.df), Register(x64.zf),
Register(x64.rf), Register(x64.of), Register(x64.vif), Register(x64.cf),
Register(x64.vip), Register(x64.pf), Register(x64.vm), Register(x64.ac),
Register(x64.af), Register(x64.id), Register(x64.if), Register(x64.nt),
Register(x64.sf)]

Information

Returns
A string.
_rvn_category =

Undocumented