Inheritance diagram for capstone.Cs:

Public Member Functions
def	__init__ (self, arch, mode)

def	__del__ (self)

def	diet (self)

def	x86_reduce (self)

def	syntax (self)

def	syntax (self, style)

def	skipdata (self)

def	skipdata (self, opt)

def	skipdata_setup (self)

def	skipdata_setup (self, opt)

def	skipdata_mnem (self)

def	skipdata_mnem (self, mnem)

def	skipdata_callback (self)

def	skipdata_callback (self, val)

def	mnemonic_setup (self, id, mnem)

def	support (self, query)

def	detail (self)

def	detail (self, opt)

def	imm_unsigned (self)

def	imm_unsigned (self, opt)

def	mode (self)

def	mode (self, opt)

def	errno (self)

def	reg_name (self, reg_id, default=None)

def	insn_name (self, insn_id, default=None)

def	group_name (self, group_id, default=None)

def	disasm (self, code, offset, count=0)

def	disasm_lite (self, code, offset, count=0)

Public Attributes
	csh

	disasm

	skipdata_setup

Private Attributes
	_mode

	_syntax

	_detail

	_imm_unsigned

	_diet

	_x86reduce

	_skipdata_mnem

	_skipdata_cb

	_skipdata_opt

	_skipdata

Detailed Description

Definition at line 798 of file __init__.py.

Constructor & Destructor Documentation

◆ init()

def capstone.Cs.__init__	(	self,
		arch,
		mode
	)

Definition at line 799 of file __init__.py.

     def __init__(self, arch, mode):
         # verify version compatibility with the core before doing anything
         (major, minor, _combined) = cs_version()
         if major != CS_API_MAJOR or minor != CS_API_MINOR:
             self.csh = None
             # our binding version is different from the core's API version
             raise CsError(CS_ERR_VERSION)
  
         self.arch, self._mode = arch, mode
         self.csh = ctypes.c_size_t()
         status = _cs.cs_open(arch, mode, ctypes.byref(self.csh))
         if status != CS_ERR_OK:
             self.csh = None
             raise CsError(status)
  
         try:
             import ccapstone
             # rewire disasm to use the faster version
             self.disasm = ccapstone.Cs(self).disasm
         except:
             pass
  
         if arch == CS_ARCH_X86:
             # Intel syntax is default for X86
             self._syntax = CS_OPT_SYNTAX_INTEL
         else:
             self._syntax = None
  
         self._detail = False  # by default, do not produce instruction details
         self._imm_unsigned = False  # by default, print immediate operands as signed numbers
         self._diet = cs_support(CS_SUPPORT_DIET)
         self._x86reduce = cs_support(CS_SUPPORT_X86_REDUCE)
  
         # default mnemonic for SKIPDATA
         self._skipdata_mnem = ".byte"
         self._skipdata_cb = (None, None)
         # store reference to option object to avoid it being freed
         # because C code uses it by reference
         self._skipdata_opt = _cs_opt_skipdata()
         self._skipdata = False
  
  
  

References capstone.cs_version().

◆ del()

def capstone.Cs.__del__ ( self )

Definition at line 843 of file __init__.py.

     def __del__(self):
         if self.csh:
             try:
                 status = _cs.cs_close(ctypes.byref(self.csh))
                 if status != CS_ERR_OK:
                     raise CsError(status)
             except: # _cs might be pulled from under our feet
                 pass
  
  

References capstone._dummy_cs.csh, capstone.Cs.csh, and MCInst.csh.

Member Function Documentation

◆ detail() [1/2]

def capstone.Cs.detail ( self )

Definition at line 968 of file __init__.py.

     def detail(self):
         return self._detail

References capstone._dummy_cs._detail, and capstone.Cs._detail.

Referenced by capstone.Cs.detail().

◆ detail() [2/2]

def capstone.Cs.detail	(	self,
		opt
	)

Definition at line 974 of file __init__.py.

     def detail(self, opt):  # opt is boolean type, so must be either 'True' or 'False'
         if opt == False:
             status = _cs.cs_option(self.csh, CS_OPT_DETAIL, CS_OPT_OFF)
         else:
             status = _cs.cs_option(self.csh, CS_OPT_DETAIL, CS_OPT_ON)
         if status != CS_ERR_OK:
             raise CsError(status)
         # save detail
         self._detail = opt
  
  

References capstone._dummy_cs._detail, capstone.Cs._detail, capstone._dummy_cs.csh, capstone.Cs.csh, MCInst.csh, and capstone.Cs.detail().

◆ diet()

def capstone.Cs.diet ( self )

Definition at line 859 of file __init__.py.

     def diet(self):
         return self._diet

References capstone.Cs._diet.

◆ disasm()

def capstone.Cs.disasm	(	self,
		code,
		offset,
		count = `0`
	)

Definition at line 1048 of file __init__.py.

     def disasm(self, code, offset, count=0):
         all_insn = ctypes.POINTER(_cs_insn)()
         '''if not _python2:
             print(code)
             code = code.encode()
             print(code)'''
         # Pass a bytearray by reference
         size = len(code)
         if isinstance(code, bytearray):
             code = ctypes.byref(ctypes.c_char.from_buffer(code))
         res = _cs.cs_disasm(self.csh, code, size, offset, count, ctypes.byref(all_insn))
         if res > 0:
             try:
                 for i in range(res):
                     yield CsInsn(self, all_insn[i])
             finally:
                 _cs.cs_free(all_insn, res)
         else:
             status = _cs.cs_errno(self.csh)
             if status != CS_ERR_OK:
                 raise CsError(status)
             return
             yield
  
  

References capstone._dummy_cs.csh, capstone.Cs.csh, MCInst.csh, capstone.Cs.disasm, len, and capstone.range.

◆ disasm_lite()

def capstone.Cs.disasm_lite	(	self,
		code,
		offset,
		count = `0`
	)

Definition at line 1076 of file __init__.py.

     def disasm_lite(self, code, offset, count=0):
         if self._diet:
             # Diet engine cannot provide @mnemonic & @op_str
             raise CsError(CS_ERR_DIET)
  
         all_insn = ctypes.POINTER(_cs_insn)()
         size = len(code)
         # Pass a bytearray by reference
         if isinstance(code, bytearray):
             code = ctypes.byref(ctypes.c_char.from_buffer(code))
         res = _cs.cs_disasm(self.csh, code, size, offset, count, ctypes.byref(all_insn))
         if res > 0:
             try:
                 for i in range(res):
                     insn = all_insn[i]
                     yield (insn.address, insn.size, insn.mnemonic.decode('ascii'), insn.op_str.decode('ascii'))
             finally:
                 _cs.cs_free(all_insn, res)
         else:
             status = _cs.cs_errno(self.csh)
             if status != CS_ERR_OK:
                 raise CsError(status)
             return
             yield
  
  
 # print out debugging info

References capstone.Cs._diet, capstone._dummy_cs.csh, capstone.Cs.csh, MCInst.csh, len, and capstone.range.

◆ errno()

def capstone.Cs.errno ( self )

Definition at line 1020 of file __init__.py.

     def errno(self):
         return _cs.cs_errno(self.csh)
  

References capstone._dummy_cs.csh, capstone.Cs.csh, and MCInst.csh.

Referenced by capstone.CsError.__str__().

◆ group_name()

def capstone.Cs.group_name	(	self,
		group_id,
		default = `None`
	)

Definition at line 1040 of file __init__.py.

     def group_name(self, group_id, default=None):
         if self._diet:
             # Diet engine cannot provide group name
             raise CsError(CS_ERR_DIET)
  
         return _ascii_name_or_default(_cs.cs_group_name(self.csh, group_id), default)
  

References capstone._ascii_name_or_default(), capstone.Cs._diet, capstone._dummy_cs.csh, capstone.Cs.csh, and MCInst.csh.

◆ imm_unsigned() [1/2]

def capstone.Cs.imm_unsigned ( self )

Definition at line 987 of file __init__.py.

     def imm_unsigned(self):
         return self._imm_unsigned

References capstone.Cs._imm_unsigned.

Referenced by capstone.Cs.imm_unsigned().

◆ imm_unsigned() [2/2]

def capstone.Cs.imm_unsigned	(	self,
		opt
	)

Definition at line 993 of file __init__.py.

     def imm_unsigned(self, opt):  # opt is boolean type, so must be either 'True' or 'False'
         if opt == False:
             status = _cs.cs_option(self.csh, CS_OPT_UNSIGNED, CS_OPT_OFF)
         else:
             status = _cs.cs_option(self.csh, CS_OPT_UNSIGNED, CS_OPT_ON)
         if status != CS_ERR_OK:
             raise CsError(status)
         # save detail
         self._imm_unsigned = opt
  
  

References capstone.Cs._imm_unsigned, capstone._dummy_cs.csh, capstone.Cs.csh, MCInst.csh, and capstone.Cs.imm_unsigned().

◆ insn_name()

def capstone.Cs.insn_name	(	self,
		insn_id,
		default = `None`
	)

Definition at line 1032 of file __init__.py.

     def insn_name(self, insn_id, default=None):
         if self._diet:
             # Diet engine cannot provide instruction name
             raise CsError(CS_ERR_DIET)
  
         return _ascii_name_or_default(_cs.cs_insn_name(self.csh, insn_id), default)
  

References capstone._ascii_name_or_default(), capstone.Cs._diet, capstone._dummy_cs.csh, capstone.Cs.csh, and MCInst.csh.

◆ mnemonic_setup()

def capstone.Cs.mnemonic_setup	(	self,
		id,
		mnem
	)

Definition at line 948 of file __init__.py.

     def mnemonic_setup(self, id, mnem):
         _mnem_opt = _cs_opt_mnem()
         _mnem_opt.id = id
         if mnem:
             _mnem_opt.mnemonic = mnem.encode()
         else:
             _mnem_opt.mnemonic = mnem
         status = _cs.cs_option(self.csh, CS_OPT_MNEMONIC, ctypes.cast(ctypes.byref(_mnem_opt), ctypes.c_void_p))
         if status != CS_ERR_OK:
             raise CsError(status)
  
  

References capstone._dummy_cs.csh, capstone.Cs.csh, and MCInst.csh.

◆ mode() [1/2]

def capstone.Cs.mode ( self )

Definition at line 1006 of file __init__.py.

     def mode(self):
         return self._mode

References rz_debug_t._mode, and capstone.Cs._mode.

Referenced by capstone.Cs.mode(), and test_group_name.GroupTest.run().

◆ mode() [2/2]

def capstone.Cs.mode	(	self,
		opt
	)

Definition at line 1012 of file __init__.py.

     def mode(self, opt):  # opt is new disasm mode, of int type
         status = _cs.cs_option(self.csh, CS_OPT_MODE, opt)
         if status != CS_ERR_OK:
             raise CsError(status)
         # save mode
         self._mode = opt
  

References rz_debug_t._mode, capstone.Cs._mode, capstone._dummy_cs.csh, capstone.Cs.csh, MCInst.csh, and capstone.Cs.mode().

Referenced by test_group_name.GroupTest.run().

◆ reg_name()

def capstone.Cs.reg_name	(	self,
		reg_id,
		default = `None`
	)

Definition at line 1024 of file __init__.py.

     def reg_name(self, reg_id, default=None):
         if self._diet:
             # Diet engine cannot provide register name
             raise CsError(CS_ERR_DIET)
  
         return _ascii_name_or_default(_cs.cs_reg_name(self.csh, reg_id), default)
  

References capstone._ascii_name_or_default(), capstone.Cs._diet, capstone._dummy_cs.csh, capstone.Cs.csh, and MCInst.csh.

◆ skipdata() [1/2]

def capstone.Cs.skipdata ( self )

Definition at line 887 of file __init__.py.

     def skipdata(self):
         return self._skipdata

References capstone.Cs._skipdata.

Referenced by capstone.Cs.skipdata().

◆ skipdata() [2/2]

def capstone.Cs.skipdata	(	self,
		opt
	)

Definition at line 893 of file __init__.py.

     def skipdata(self, opt):
         if opt == False:
             status = _cs.cs_option(self.csh, CS_OPT_SKIPDATA, CS_OPT_OFF)
         else:
             status = _cs.cs_option(self.csh, CS_OPT_SKIPDATA, CS_OPT_ON)
         if status != CS_ERR_OK:
             raise CsError(status)
  
         # save this option
         self._skipdata = opt
  
  

References capstone.Cs._skipdata, capstone._dummy_cs.csh, capstone.Cs.csh, MCInst.csh, and capstone.Cs.skipdata().

◆ skipdata_callback() [1/2]

def capstone.Cs.skipdata_callback ( self )

Definition at line 935 of file __init__.py.

     def skipdata_callback(self):
         return self._skipdata_cb

References capstone.Cs._skipdata_cb.

Referenced by capstone.Cs.skipdata_callback().

◆ skipdata_callback() [2/2]

def capstone.Cs.skipdata_callback	(	self,
		val
	)

Definition at line 940 of file __init__.py.

     def skipdata_callback(self, val):
         if not isinstance(val, tuple):
             val = (val, None)
         func, data = val
         self.skipdata_setup = (self._skipdata_mnem, func, data)
  
  

References capstone.Cs._skipdata_mnem, capstone.Cs.skipdata_callback(), capstone.Cs.skipdata_setup, and cs_struct.skipdata_setup.

◆ skipdata_mnem() [1/2]

def capstone.Cs.skipdata_mnem ( self )

Definition at line 925 of file __init__.py.

     def skipdata_mnem(self):
         return self._skipdata_mnem

References capstone.Cs._skipdata_mnem.

Referenced by capstone.Cs.skipdata_mnem().

◆ skipdata_mnem() [2/2]

def capstone.Cs.skipdata_mnem	(	self,
		mnem
	)

Definition at line 930 of file __init__.py.

     def skipdata_mnem(self, mnem):
         self.skipdata_setup = (mnem,) + self._skipdata_cb

References capstone.Cs.skipdata_mnem().

◆ skipdata_setup() [1/2]

def capstone.Cs.skipdata_setup ( self )

Definition at line 906 of file __init__.py.

     def skipdata_setup(self):
         return (self._skipdata_mnem,) + self._skipdata_cb

References capstone.Cs._skipdata_cb, capstone.Cs._skipdata_mnem, and capstone.Cs.skipdata_setup.

Referenced by capstone.Cs.skipdata_callback().

◆ skipdata_setup() [2/2]

def capstone.Cs.skipdata_setup	(	self,
		opt
	)

Definition at line 911 of file __init__.py.

     def skipdata_setup(self, opt):
         _mnem, _cb, _ud = opt
         self._skipdata_opt.mnemonic = _mnem.encode()
         self._skipdata_opt.callback = CS_SKIPDATA_CALLBACK(_cb or 0)
         self._skipdata_opt.user_data = ctypes.cast(_ud, ctypes.c_void_p)
         status = _cs.cs_option(self.csh, CS_OPT_SKIPDATA_SETUP, ctypes.cast(ctypes.byref(self._skipdata_opt), ctypes.c_void_p))
         if status != CS_ERR_OK:
             raise CsError(status)
  
         self._skipdata_mnem = _mnem
         self._skipdata_cb = (_cb, _ud)
  
  

References capstone.Cs._skipdata_cb, capstone.Cs._skipdata_mnem, capstone.Cs._skipdata_opt, capstone.CS_SKIPDATA_CALLBACK, capstone._dummy_cs.csh, capstone.Cs.csh, MCInst.csh, and capstone.Cs.skipdata_setup.

Referenced by capstone.Cs.skipdata_callback().

◆ support()

def capstone.Cs.support	(	self,
		query
	)

Definition at line 962 of file __init__.py.

     def support(self, query):
         return cs_support(query)

References capstone.cs_support().

◆ syntax() [1/2]

def capstone.Cs.syntax ( self )

Definition at line 871 of file __init__.py.

     def syntax(self):
         return self._syntax

References capstone.Cs._syntax.

Referenced by capstone.Cs.syntax().

◆ syntax() [2/2]

def capstone.Cs.syntax	(	self,
		style
	)

Definition at line 877 of file __init__.py.

     def syntax(self, style):
         status = _cs.cs_option(self.csh, CS_OPT_SYNTAX, style)
         if status != CS_ERR_OK:
             raise CsError(status)
         # save syntax
         self._syntax = style
  
  

References capstone.Cs._syntax, capstone._dummy_cs.csh, capstone.Cs.csh, MCInst.csh, and capstone.Cs.syntax().

◆ x86_reduce()

def capstone.Cs.x86_reduce ( self )

Definition at line 865 of file __init__.py.

     def x86_reduce(self):
         return self._x86reduce

References capstone.Cs._x86reduce.

Member Data Documentation

◆ _detail

capstone.Cs._detail

private

Definition at line 827 of file __init__.py.

Referenced by capstone.Cs.detail().

◆ _diet

capstone.Cs._diet

private

Definition at line 829 of file __init__.py.

Referenced by capstone.Cs.diet(), capstone.Cs.disasm_lite(), capstone.Cs.group_name(), capstone.Cs.insn_name(), and capstone.Cs.reg_name().

◆ _imm_unsigned

capstone.Cs._imm_unsigned

private

Definition at line 828 of file __init__.py.

Referenced by capstone.Cs.imm_unsigned().

◆ _mode

capstone.Cs._mode

private

Definition at line 807 of file __init__.py.

Referenced by capstone.Cs.mode().

◆ _skipdata

capstone.Cs._skipdata

private

Definition at line 838 of file __init__.py.

Referenced by capstone.Cs.skipdata().

◆ _skipdata_cb

capstone.Cs._skipdata_cb

private

Definition at line 834 of file __init__.py.

Referenced by capstone.Cs.skipdata_callback(), and capstone.Cs.skipdata_setup().

◆ _skipdata_mnem

capstone.Cs._skipdata_mnem

private

Definition at line 833 of file __init__.py.

Referenced by capstone.Cs.skipdata_callback(), capstone.Cs.skipdata_mnem(), and capstone.Cs.skipdata_setup().

◆ _skipdata_opt

capstone.Cs._skipdata_opt

private

Definition at line 837 of file __init__.py.

Referenced by capstone.Cs.skipdata_setup().

◆ _syntax

capstone.Cs._syntax

private

Definition at line 823 of file __init__.py.

Referenced by capstone.Cs.syntax().

◆ _x86reduce

capstone.Cs._x86reduce

private

Definition at line 830 of file __init__.py.

Referenced by capstone.Cs.x86_reduce().

◆ csh

capstone.Cs.csh

Definition at line 803 of file __init__.py.

Referenced by capstone.Cs.__del__(), capstone.Cs.detail(), capstone.Cs.disasm(), capstone.Cs.disasm_lite(), capstone.Cs.errno(), capstone.Cs.group_name(), capstone.Cs.imm_unsigned(), capstone.Cs.insn_name(), capstone.Cs.mnemonic_setup(), capstone.Cs.mode(), capstone.Cs.reg_name(), capstone.Cs.skipdata(), capstone.Cs.skipdata_setup(), and capstone.Cs.syntax().

◆ disasm

capstone.Cs.disasm

Definition at line 817 of file __init__.py.

Referenced by capstone.Cs.disasm().

◆ skipdata_setup

capstone.Cs.skipdata_setup

Definition at line 931 of file __init__.py.

Referenced by capstone.Cs.skipdata_callback(), and capstone.Cs.skipdata_setup().

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

subprojects/capstone-bundled/bindings/python/capstone/__init__.py

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

◆ __del__()

Member Function Documentation

◆ detail() [1/2]

◆ detail() [2/2]

◆ diet()

◆ disasm()

◆ disasm_lite()

◆ errno()

◆ group_name()

◆ imm_unsigned() [1/2]

◆ imm_unsigned() [2/2]

◆ insn_name()

◆ mnemonic_setup()

◆ mode() [1/2]

◆ mode() [2/2]

◆ reg_name()

◆ skipdata() [1/2]

◆ skipdata() [2/2]

◆ skipdata_callback() [1/2]

◆ skipdata_callback() [2/2]

◆ skipdata_mnem() [1/2]

◆ skipdata_mnem() [2/2]

◆ skipdata_setup() [1/2]

◆ skipdata_setup() [2/2]

◆ support()

◆ syntax() [1/2]

◆ syntax() [2/2]

◆ x86_reduce()

Member Data Documentation

◆ _detail

◆ _diet

◆ _imm_unsigned

◆ _mode

◆ _skipdata

◆ _skipdata_cb

◆ _skipdata_mnem

◆ _skipdata_opt

◆ _syntax

◆ _x86reduce

◆ csh

◆ disasm

◆ skipdata_setup

◆ init()

◆ del()