idaapi.py

The sources of IDAPython, a plugin for IDA for using python for scripting in IDA, instead of IDC.

  return _idaapi.toEA(*args)

def idb2scr(*args):
  """idb2scr(char name) -> char"""
  return _idaapi.idb2scr(*args)

def scr2idb(*args):
  """scr2idb(char name) -> char"""
  return _idaapi.scr2idb(*args)

def ansi2idb(*args):
  """ansi2idb(char name) -> char"""
  return _idaapi.ansi2idb(*args)
IDB_EXT32 = _idaapi.IDB_EXT32
IDB_EXT64 = _idaapi.IDB_EXT64
IDB_EXT = _idaapi.IDB_EXT

def dto_copy_to_inf(*args):
  """dto_copy_to_inf( ?, idainfo inf)"""
  return _idaapi.dto_copy_to_inf(*args)

def dto_copy_from_inf(*args):
  """dto_copy_from_inf( ?, idainfo inf)"""
  return _idaapi.dto_copy_from_inf(*args)

def dto_init(*args):
  """dto_init( dt, bool for_graph)"""
  return _idaapi.dto_init(*args)
IDD_INTERFACE_VERSION = _idaapi.IDD_INTERFACE_VERSION
NO_PROCESS = _idaapi.NO_PROCESS
PROCESS_NO_THREAD = _idaapi.PROCESS_NO_THREAD
class process_info_t(object):
    """Proxy of C++ process_info_t class"""
    thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
    __repr__ = _swig_repr
    pid = _swig_property(_idaapi.process_info_t_pid_get, _idaapi.process_info_t_pid_set)
    name = _swig_property(_idaapi.process_info_t_name_get, _idaapi.process_info_t_name_set)
    def __init__(self, *args): 
        """__init__(self) -> process_info_t"""
        this = _idaapi.new_process_info_t(*args)
        try: self.this.append(this)
        except: self.this = this
    __swig_destroy__ = _idaapi.delete_process_info_t
    __del__ = lambda self : None;
process_info_t_swigregister = _idaapi.process_info_t_swigregister
process_info_t_swigregister(process_info_t)

IDP_INTERFACE_VERSION = _idaapi.IDP_INTERFACE_VERSION

def InstrIsSet(*args):
  """InstrIsSet(int icode, int bit) -> bool"""
  return _idaapi.InstrIsSet(*args)

def is_call_insn(*args):
  """is_call_insn(ea_t ea) -> bool"""
  return _idaapi.is_call_insn(*args)

def is_indirect_jump_insn(*args):
  """is_indirect_jump_insn(ea_t ea) -> bool"""
  return _idaapi.is_indirect_jump_insn(*args)

def is_basic_block_end(*args):
  """is_basic_block_end(bool call_insn_stops_block) -> bool"""
  return _idaapi.is_basic_block_end(*args)
class asm_t(object):
    """Proxy of C++ asm_t class"""
    thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
    __repr__ = _swig_repr
    flag = _swig_property(_idaapi.asm_t_flag_get, _idaapi.asm_t_flag_set)
    uflag = _swig_property(_idaapi.asm_t_uflag_get, _idaapi.asm_t_uflag_set)
    name = _swig_property(_idaapi.asm_t_name_get, _idaapi.asm_t_name_set)
    help = _swig_property(_idaapi.asm_t_help_get, _idaapi.asm_t_help_set)
    header = _swig_property(_idaapi.asm_t_header_get, _idaapi.asm_t_header_set)
    badworks = _swig_property(_idaapi.asm_t_badworks_get, _idaapi.asm_t_badworks_set)
    origin = _swig_property(_idaapi.asm_t_origin_get, _idaapi.asm_t_origin_set)
    end = _swig_property(_idaapi.asm_t_end_get, _idaapi.asm_t_end_set)
    cmnt = _swig_property(_idaapi.asm_t_cmnt_get, _idaapi.asm_t_cmnt_set)
    ascsep = _swig_property(_idaapi.asm_t_ascsep_get, _idaapi.asm_t_ascsep_set)
    accsep = _swig_property(_idaapi.asm_t_accsep_get, _idaapi.asm_t_accsep_set)
    esccodes = _swig_property(_idaapi.asm_t_esccodes_get, _idaapi.asm_t_esccodes_set)
    a_ascii = _swig_property(_idaapi.asm_t_a_ascii_get, _idaapi.asm_t_a_ascii_set)
    a_byte = _swig_property(_idaapi.asm_t_a_byte_get, _idaapi.asm_t_a_byte_set)
    a_word = _swig_property(_idaapi.asm_t_a_word_get, _idaapi.asm_t_a_word_set)
    a_dword = _swig_property(_idaapi.asm_t_a_dword_get, _idaapi.asm_t_a_dword_set)
    a_qword = _swig_property(_idaapi.asm_t_a_qword_get, _idaapi.asm_t_a_qword_set)
    a_oword = _swig_property(_idaapi.asm_t_a_oword_get, _idaapi.asm_t_a_oword_set)
    a_float = _swig_property(_idaapi.asm_t_a_float_get, _idaapi.asm_t_a_float_set)
    a_double = _swig_property(_idaapi.asm_t_a_double_get, _idaapi.asm_t_a_double_set)
    a_tbyte = _swig_property(_idaapi.asm_t_a_tbyte_get, _idaapi.asm_t_a_tbyte_set)
    a_packreal = _swig_property(_idaapi.asm_t_a_packreal_get, _idaapi.asm_t_a_packreal_set)
    a_dups = _swig_property(_idaapi.asm_t_a_dups_get, _idaapi.asm_t_a_dups_set)
    a_bss = _swig_property(_idaapi.asm_t_a_bss_get, _idaapi.asm_t_a_bss_set)
    a_equ = _swig_property(_idaapi.asm_t_a_equ_get, _idaapi.asm_t_a_equ_set)
    a_seg = _swig_property(_idaapi.asm_t_a_seg_get, _idaapi.asm_t_a_seg_set)
    _UNUSED1_was_atomprefix = _swig_property(_idaapi.asm_t__UNUSED1_was_atomprefix_get, _idaapi.asm_t__UNUSED1_was_atomprefix_set)
    _UNUSED2_was_checkarg_operations = _swig_property(_idaapi.asm_t__UNUSED2_was_checkarg_operations_get, _idaapi.asm_t__UNUSED2_was_checkarg_operations_set)
    XlatAsciiOutput = _swig_property(_idaapi.asm_t_XlatAsciiOutput_get, _idaapi.asm_t_XlatAsciiOutput_set)
    a_curip = _swig_property(_idaapi.asm_t_a_curip_get, _idaapi.asm_t_a_curip_set)
    a_public = _swig_property(_idaapi.asm_t_a_public_get, _idaapi.asm_t_a_public_set)
    a_weak = _swig_property(_idaapi.asm_t_a_weak_get, _idaapi.asm_t_a_weak_set)
    a_extrn = _swig_property(_idaapi.asm_t_a_extrn_get, _idaapi.asm_t_a_extrn_set)
    a_comdef = _swig_property(_idaapi.asm_t_a_comdef_get, _idaapi.asm_t_a_comdef_set)
    a_align = _swig_property(_idaapi.asm_t_a_align_get, _idaapi.asm_t_a_align_set)
    lbrace = _swig_property(_idaapi.asm_t_lbrace_get, _idaapi.asm_t_lbrace_set)
    rbrace = _swig_property(_idaapi.asm_t_rbrace_get, _idaapi.asm_t_rbrace_set)
    a_mod = _swig_property(_idaapi.asm_t_a_mod_get, _idaapi.asm_t_a_mod_set)
    a_band = _swig_property(_idaapi.asm_t_a_band_get, _idaapi.asm_t_a_band_set)
    a_bor = _swig_property(_idaapi.asm_t_a_bor_get, _idaapi.asm_t_a_bor_set)
    a_xor = _swig_property(_idaapi.asm_t_a_xor_get, _idaapi.asm_t_a_xor_set)
    a_bnot = _swig_property(_idaapi.asm_t_a_bnot_get, _idaapi.asm_t_a_bnot_set)
    a_shl = _swig_property(_idaapi.asm_t_a_shl_get, _idaapi.asm_t_a_shl_set)
    a_shr = _swig_property(_idaapi.asm_t_a_shr_get, _idaapi.asm_t_a_shr_set)
    a_sizeof_fmt = _swig_property(_idaapi.asm_t_a_sizeof_fmt_get, _idaapi.asm_t_a_sizeof_fmt_set)
    flag2 = _swig_property(_idaapi.asm_t_flag2_get, _idaapi.asm_t_flag2_set)
    cmnt2 = _swig_property(_idaapi.asm_t_cmnt2_get, _idaapi.asm_t_cmnt2_set)
    low8 = _swig_property(_idaapi.asm_t_low8_get, _idaapi.asm_t_low8_set)
    high8 = _swig_property(_idaapi.asm_t_high8_get, _idaapi.asm_t_high8_set)
    low16 = _swig_property(_idaapi.asm_t_low16_get, _idaapi.asm_t_low16_set)
    high16 = _swig_property(_idaapi.asm_t_high16_get, _idaapi.asm_t_high16_set)
    a_include_fmt = _swig_property(_idaapi.asm_t_a_include_fmt_get, _idaapi.asm_t_a_include_fmt_set)
    a_vstruc_fmt = _swig_property(_idaapi.asm_t_a_vstruc_fmt_get, _idaapi.asm_t_a_vstruc_fmt_set)
    a_3byte = _swig_property(_idaapi.asm_t_a_3byte_get, _idaapi.asm_t_a_3byte_set)
    a_rva = _swig_property(_idaapi.asm_t_a_rva_get, _idaapi.asm_t_a_rva_set)
    def __init__(self, *args): 
        """__init__(self) -> asm_t"""
        this = _idaapi.new_asm_t(*args)
        try: self.this.append(this)
        except: self.this = this
    __swig_destroy__ = _idaapi.delete_asm_t
    __del__ = lambda self : None;
asm_t_swigregister = _idaapi.asm_t_swigregister
asm_t_swigregister(asm_t)
BPT_EXEC = cvar.BPT_EXEC
BPT_WRITE = cvar.BPT_WRITE
BPT_RDWR = cvar.BPT_RDWR
BPT_SOFT = cvar.BPT_SOFT

def is_ret_insn(*args):
  """
    is_ret_insn(ea_t ea, bool strict=True) -> bool
    is_ret_insn(ea_t ea) -> bool
    """
  return _idaapi.is_ret_insn(*args)
AS_OFFST = _idaapi.AS_OFFST
AS_COLON = _idaapi.AS_COLON
AS_UDATA = _idaapi.AS_UDATA
AS_2CHRE = _idaapi.AS_2CHRE
AS_NCHRE = _idaapi.AS_NCHRE
AS_N2CHR = _idaapi.AS_N2CHR
AS_1TEXT = _idaapi.AS_1TEXT
AS_NHIAS = _idaapi.AS_NHIAS
AS_NCMAS = _idaapi.AS_NCMAS
AS_HEXFM = _idaapi.AS_HEXFM
ASH_HEXF0 = _idaapi.ASH_HEXF0
ASH_HEXF1 = _idaapi.ASH_HEXF1
ASH_HEXF2 = _idaapi.ASH_HEXF2
ASH_HEXF3 = _idaapi.ASH_HEXF3
ASH_HEXF4 = _idaapi.ASH_HEXF4
ASH_HEXF5 = _idaapi.ASH_HEXF5
AS_DECFM = _idaapi.AS_DECFM
ASD_DECF0 = _idaapi.ASD_DECF0
ASD_DECF1 = _idaapi.ASD_DECF1
ASD_DECF2 = _idaapi.ASD_DECF2
ASD_DECF3 = _idaapi.ASD_DECF3
AS_OCTFM = _idaapi.AS_OCTFM
ASO_OCTF0 = _idaapi.ASO_OCTF0
ASO_OCTF1 = _idaapi.ASO_OCTF1
ASO_OCTF2 = _idaapi.ASO_OCTF2
ASO_OCTF3 = _idaapi.ASO_OCTF3
ASO_OCTF4 = _idaapi.ASO_OCTF4
ASO_OCTF5 = _idaapi.ASO_OCTF5
ASO_OCTF6 = _idaapi.ASO_OCTF6
AS_BINFM = _idaapi.AS_BINFM
ASB_BINF0 = _idaapi.ASB_BINF0
ASB_BINF1 = _idaapi.ASB_BINF1
ASB_BINF2 = _idaapi.ASB_BINF2
ASB_BINF3 = _idaapi.ASB_BINF3
ASB_BINF4 = _idaapi.ASB_BINF4
ASB_BINF5 = _idaapi.ASB_BINF5
AS_UNEQU = _idaapi.AS_UNEQU
AS_ONEDUP = _idaapi.AS_ONEDUP
AS_NOXRF = _idaapi.AS_NOXRF
AS_XTRNTYPE = _idaapi.AS_XTRNTYPE
AS_RELSUP = _idaapi.AS_RELSUP
AS_LALIGN = _idaapi.AS_LALIGN
AS_NOCODECLN = _idaapi.AS_NOCODECLN
AS_NOTAB = _idaapi.AS_NOTAB
AS_NOSPACE = _idaapi.AS_NOSPACE
AS_ALIGN2 = _idaapi.AS_ALIGN2
AS_ASCIIC = _idaapi.AS_ASCIIC
AS_ASCIIZ = _idaapi.AS_ASCIIZ
AS2_BRACE = _idaapi.AS2_BRACE
AS2_STRINV = _idaapi.AS2_STRINV
AS2_BYTE1CHAR = _idaapi.AS2_BYTE1CHAR
AS2_IDEALDSCR = _idaapi.AS2_IDEALDSCR
AS2_TERSESTR = _idaapi.AS2_TERSESTR
AS2_COLONSUF = _idaapi.AS2_COLONSUF

class processor_t(object):
    """Proxy of C++ processor_t class"""
    thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
    __repr__ = _swig_repr
    version = _swig_property(_idaapi.processor_t_version_get, _idaapi.processor_t_version_set)
    id = _swig_property(_idaapi.processor_t_id_get, _idaapi.processor_t_id_set)
    flag = _swig_property(_idaapi.processor_t_flag_get, _idaapi.processor_t_flag_set)
    def has_segregs(*args):
        """has_segregs(self) -> bool"""
        return _idaapi.processor_t_has_segregs(*args)

    def use32(*args):
        """use32(self) -> bool"""
        return _idaapi.processor_t_use32(*args)

    def use64(*args):
        """use64(self) -> bool"""
        return _idaapi.processor_t_use64(*args)

    def ti(*args):
        """ti(self) -> bool"""
        return _idaapi.processor_t_ti(*args)

    def stkup(*args):
        """stkup(self) -> bool"""
        return _idaapi.processor_t_stkup(*args)

    def get_segm_bitness(*args):
        """get_segm_bitness(self) -> int"""
        return _idaapi.processor_t_get_segm_bitness(*args)

    cnbits = _swig_property(_idaapi.processor_t_cnbits_get, _idaapi.processor_t_cnbits_set)
    dnbits = _swig_property(_idaapi.processor_t_dnbits_get, _idaapi.processor_t_dnbits_set)
    def cbsize(*args):
        """cbsize(self) -> int"""
        return _idaapi.processor_t_cbsize(*args)

    def dbsize(*args):
        """dbsize(self) -> int"""
        return _idaapi.processor_t_dbsize(*args)

    psnames = _swig_property(_idaapi.processor_t_psnames_get, _idaapi.processor_t_psnames_set)
    plnames = _swig_property(_idaapi.processor_t_plnames_get, _idaapi.processor_t_plnames_set)
    assemblers = _swig_property(_idaapi.processor_t_assemblers_get, _idaapi.processor_t_assemblers_set)
    def get_stkvar_scale(*args):
        """get_stkvar_scale(self) -> int"""
        return _idaapi.processor_t_get_stkvar_scale(*args)

    regsNum = _swig_property(_idaapi.processor_t_regsNum_get, _idaapi.processor_t_regsNum_set)
    regNames = _swig_property(_idaapi.processor_t_regNames_get, _idaapi.processor_t_regNames_set)
    rFiles = _swig_property(_idaapi.processor_t_rFiles_get, _idaapi.processor_t_rFiles_set)
    rFnames = _swig_property(_idaapi.processor_t_rFnames_get, _idaapi.processor_t_rFnames_set)
    rFdescs = _swig_property(_idaapi.processor_t_rFdescs_get, _idaapi.processor_t_rFdescs_set)
    CPUregs = _swig_property(_idaapi.processor_t_CPUregs_get, _idaapi.processor_t_CPUregs_set)
    regFirstSreg = _swig_property(_idaapi.processor_t_regFirstSreg_get, _idaapi.processor_t_regFirstSreg_set)
    regLastSreg = _swig_property(_idaapi.processor_t_regLastSreg_get, _idaapi.processor_t_regLastSreg_set)
    segreg_size = _swig_property(_idaapi.processor_t_segreg_size_get, _idaapi.processor_t_segreg_size_set)
    regCodeSreg = _swig_property(_idaapi.processor_t_regCodeSreg_get, _idaapi.processor_t_regCodeSreg_set)
    regDataSreg = _swig_property(_idaapi.processor_t_regDataSreg_get, _idaapi.processor_t_regDataSreg_set)
    codestart = _swig_property(_idaapi.processor_t_codestart_get, _idaapi.processor_t_codestart_set)
    retcodes = _swig_property(_idaapi.processor_t_retcodes_get, _idaapi.processor_t_retcodes_set)
    instruc_start = _swig_property(_idaapi.processor_t_instruc_start_get, _idaapi.processor_t_instruc_start_set)
    instruc_end = _swig_property(_idaapi.processor_t_instruc_end_get, _idaapi.processor_t_instruc_end_set)
    def is_canon_insn(*args):
        """is_canon_insn(self, ushort itype) -> bool"""
        return _idaapi.processor_t_is_canon_insn(*args)

    instruc = _swig_property(_idaapi.processor_t_instruc_get, _idaapi.processor_t_instruc_set)
    tbyte_size = _swig_property(_idaapi.processor_t_tbyte_size_get, _idaapi.processor_t_tbyte_size_set)
    real_width = _swig_property(_idaapi.processor_t_real_width_get, _idaapi.processor_t_real_width_set)
    icode_return = _swig_property(_idaapi.processor_t_icode_return_get, _idaapi.processor_t_icode_return_set)
    mvm = _swig_property(_idaapi.processor_t_mvm_get, _idaapi.processor_t_mvm_set)
    high_fixup_bits = _swig_property(_idaapi.processor_t_high_fixup_bits_get, _idaapi.processor_t_high_fixup_bits_set)
    def __init__(self, *args): 
        """__init__(self) -> processor_t"""
        this = _idaapi.new_processor_t(*args)
        try: self.this.append(this)
        except: self.this = this
    __swig_destroy__ = _idaapi.delete_processor_t
    __del__ = lambda self : None;
processor_t_swigregister = _idaapi.processor_t_swigregister
processor_t_swigregister(processor_t)
PLFM_386 = _idaapi.PLFM_386
PLFM_Z80 = _idaapi.PLFM_Z80
PLFM_I860 = _idaapi.PLFM_I860
PLFM_8051 = _idaapi.PLFM_8051
PLFM_TMS = _idaapi.PLFM_TMS
PLFM_6502 = _idaapi.PLFM_6502
PLFM_PDP = _idaapi.PLFM_PDP
PLFM_68K = _idaapi.PLFM_68K
PLFM_JAVA = _idaapi.PLFM_JAVA
PLFM_6800 = _idaapi.PLFM_6800
PLFM_ST7 = _idaapi.PLFM_ST7
PLFM_MC6812 = _idaapi.PLFM_MC6812
PLFM_MIPS = _idaapi.PLFM_MIPS
PLFM_ARM = _idaapi.PLFM_ARM
PLFM_TMSC6 = _idaapi.PLFM_TMSC6
PLFM_PPC = _idaapi.PLFM_PPC
PLFM_80196 = _idaapi.PLFM_80196
PLFM_Z8 = _idaapi.PLFM_Z8
PLFM_SH = _idaapi.PLFM_SH
PLFM_NET = _idaapi.PLFM_NET
PLFM_AVR = _idaapi.PLFM_AVR
PLFM_H8 = _idaapi.PLFM_H8
PLFM_PIC = _idaapi.PLFM_PIC
PLFM_SPARC = _idaapi.PLFM_SPARC
PLFM_ALPHA = _idaapi.PLFM_ALPHA
PLFM_HPPA = _idaapi.PLFM_HPPA
PLFM_H8500 = _idaapi.PLFM_H8500
PLFM_TRICORE = _idaapi.PLFM_TRICORE
PLFM_DSP56K = _idaapi.PLFM_DSP56K
PLFM_C166 = _idaapi.PLFM_C166
PLFM_ST20 = _idaapi.PLFM_ST20
PLFM_IA64 = _idaapi.PLFM_IA64
PLFM_I960 = _idaapi.PLFM_I960
PLFM_F2MC = _idaapi.PLFM_F2MC
PLFM_TMS320C54 = _idaapi.PLFM_TMS320C54
PLFM_TMS320C55 = _idaapi.PLFM_TMS320C55
PLFM_TRIMEDIA = _idaapi.PLFM_TRIMEDIA
PLFM_M32R = _idaapi.PLFM_M32R
PLFM_NEC_78K0 = _idaapi.PLFM_NEC_78K0
PLFM_NEC_78K0S = _idaapi.PLFM_NEC_78K0S
PLFM_M740 = _idaapi.PLFM_M740
PLFM_M7700 = _idaapi.PLFM_M7700
PLFM_ST9 = _idaapi.PLFM_ST9
PLFM_FR = _idaapi.PLFM_FR
PLFM_MC6816 = _idaapi.PLFM_MC6816
PLFM_M7900 = _idaapi.PLFM_M7900
PLFM_TMS320C3 = _idaapi.PLFM_TMS320C3
PLFM_KR1878 = _idaapi.PLFM_KR1878
PLFM_AD218X = _idaapi.PLFM_AD218X
PLFM_OAKDSP = _idaapi.PLFM_OAKDSP