ida_name.py File Reference

Classes
class	ea_name_vec_t
	Proxy of C++ qvector< ea_name_t > class. More...
class	ea_name_t
	Proxy of C++ ea_name_t class. More...
class	NearestName
	Utility class to help find the nearest name in a given ea/name dictionary. More...

Namespaces
namespace	ida_name

Functions
"qstring"	get_name (*args)
	get_name(ea) -> qstring
"qstring"	get_colored_name (*args)
	get_colored_name(ea) -> qstring
"bool"	set_name (*args)
	set_name(ea, name, flags=0) -> bool Set or delete name of an item at the specified address.
"bool"	force_name (*args)
	force_name(ea, name, flags=0) -> bool
"bool"	del_global_name (*args)
	del_global_name(ea) -> bool
"bool"	del_local_name (*args)
	del_local_name(ea) -> bool
"bool"	set_dummy_name (*args)
	set_dummy_name(<em>from, ea) -> bool Give an autogenerated (dummy) name.
"bool"	make_name_auto (*args)
	make_name_auto(ea) -> bool
"bool"	make_name_user (*args)
	make_name_user(ea) -> bool
"bool"	is_valid_cp (*args)
	is_valid_cp(cp, kind, data=None) -> bool Is the given codepoint acceptable in the given context?
"void"	set_cp_validity (*args)
	set_cp_validity(kind, cp, endcp=wchar32_t(-1), valid=True) Mark the given codepoint (or range) as acceptable or unacceptable in the given context If 'endcp' is not BADCP, it is considered to be the end of the range: [cp, endcp), and is not included in the range
"bool"	get_cp_validity (*args)
	get_cp_validity(kind, cp, endcp=wchar32_t(-1)) -> bool Is the given codepoint (or range) acceptable in the given context? If 'endcp' is not BADCP, it is considered to be the end of the range: [cp, endcp), and is not included in the range
"bool"	is_ident_cp (*args)
	is_ident_cp(cp) -> bool Can a character appear in a name? (present in ::NameChars or ::MangleChars)
"bool"	is_strlit_cp (*args)
	is_strlit_cp(cp, specific_ranges=None) -> bool Can a character appear in a string literal (present in ::StrlitChars) If 'specific_ranges' are specified, those will be used instead of the ones corresponding to the current culture (only if ::StrlitChars is configured to use the current culture)
"bool"	is_visible_cp (*args)
	is_visible_cp(cp) -> bool Can a character be displayed in a name? (present in ::NameChars)
"bool"	is_ident (*args)
	is_ident(name) -> bool Is a valid name? (including ::MangleChars)
"bool"	is_valid_name (*args)
	is_valid_name(name, cpuregs_permitted) -> bool
"bool"	is_uname (*args)
	is_uname(name) -> bool Is valid user-specified name? (valid name & !dummy prefix).
"bool"	is_valid_typename (*args)
	is_valid_typename(name) -> bool Is valid type name?
"qstring *"	extract_name (*args)
	extract_name(line, x) -> str Extract a name or address from the specified string.
"void"	hide_name (*args)
	hide_name(ea) Remove name from the list of names
"void"	show_name (*args)
	show_name(ea) Insert name to the list of names.
"ea_t"	get_name_ea (*args)
	get_name_ea(_from, name) -> ea_t Get the address of a name.
"ea_t"	get_name_base_ea (*args)
	get_name_base_ea(_from, to) -> ea_t Get address of the name used in the expression for the address
"uval_t *"	get_name_value (*args)
	get_name_value(_from, name) -> int Get value of the name.
"qstring"	get_visible_name (*args)
	get_visible_name(ea, gtn_flags=0) -> qstring
"qstring"	get_short_name (*args)
	get_short_name(ea, gtn_flags=0) -> qstring
"qstring"	get_long_name (*args)
	get_long_name(ea, gtn_flags=0) -> qstring
"qstring"	get_colored_short_name (*args)
	get_colored_short_name(ea, gtn_flags=0) -> qstring
"qstring"	get_colored_long_name (*args)
	get_colored_long_name(ea, gtn_flags=0) -> qstring
"qstring"	get_demangled_name (*args)
	get_demangled_name(ea, inhibitor, demform, gtn_flags=0) -> qstring
"qstring"	get_colored_demangled_name (*args)
	get_colored_demangled_name(ea, inhibitor, demform, gtn_flags=0) -> qstring
"color_t"	get_name_color (*args)
	get_name_color(_from, ea) -> color_t Calculate flags for get_ea_name() function.
"qstring *"	get_name_expr (*args)
	get_name_expr(_from, n, ea, off, flags=0x0001) -> str Convert address to name expression (name with a displacement).
"qstring *"	get_nice_colored_name (*args)
	get_nice_colored_name(ea, flags=0) -> str Get a nice colored name at the specified address.
"qstring *, adiff_t *"	append_struct_fields (*args)
	append_struct_fields(disp, n, path, flags, delta, appzero) -> str Append names of struct fields to a name if the name is a struct name.
"bool"	is_public_name (*args)
	is_public_name(ea) -> bool
"void"	make_name_public (*args)
	make_name_public(ea)
"void"	make_name_non_public (*args)
	make_name_non_public(ea)
"bool"	is_weak_name (*args)
	is_weak_name(ea) -> bool
"void"	make_name_weak (*args)
	make_name_weak(ea)
"void"	make_name_non_weak (*args)
	make_name_non_weak(ea)
"size_t"	get_nlist_size (*args)
	get_nlist_size() -> size_t Get number of names in the list.
"size_t"	get_nlist_idx (*args)
	get_nlist_idx(ea) -> size_t Get index of the name in the list
"bool"	is_in_nlist (*args)
	is_in_nlist(ea) -> bool Is the name included into the name list?
"ea_t"	get_nlist_ea (*args)
	get_nlist_ea(idx) -> ea_t Get address from the list at 'idx'.
"char const *"	get_nlist_name (*args)
	get_nlist_name(idx) -> char const * Get name using idx.
"void"	rebuild_nlist (*args)
	rebuild_nlist() Rebuild the name list.
"void"	reorder_dummy_names (*args)
	reorder_dummy_names() Renumber dummy names.
"bool"	set_debug_name (*args)
	set_debug_name(ea, name) -> bool
"qstring *"	get_debug_name (*args)
	get_debug_name(ea_ptr, how) -> str
"void"	del_debug_names (*args)
	del_debug_names(ea1, ea2)
"ea_t"	get_debug_name_ea (*args)
	get_debug_name_ea(name) -> ea_t
"qstring *"	demangle_name (*args)
	demangle_name(name, disable_mask, demreq=DQT_FULL) -> str Demangle a name.
"bool"	is_name_defined_locally (*args)
	is_name_defined_locally(pfn, name, ignore_name_def, ea1=BADADDR, ea2=BADADDR) -> bool Is the name defined locally in the specified function?
"qstring *"	cleanup_name (*args)
	cleanup_name(ea, name, flags=0) -> str
"mangled_name_type_t"	get_mangled_name_type (*args)
	get_mangled_name_type(name) -> mangled_name_type_t
"PyObject *"	get_debug_names (*args)
	get_debug_names(names, ea1, ea2)
"qstring"	get_ea_name (*args)
	get_ea_name(ea, gtn_flags=0) -> qstring Get name at the specified address.
"PyObject *"	validate_name (*args)
	validate_name(name, type, flags=0) -> PyObject * Validate a name.
	calc_gtn_flags (fromaddr, ea)
	Calculate flags for get_ea_name() function.

Variables
	MAXNAMELEN = _ida_name.MAXNAMELEN
	FUNC_IMPORT_PREFIX = _ida_name.FUNC_IMPORT_PREFIX
	SN_CHECK = _ida_name.SN_CHECK
	SN_NOCHECK = _ida_name.SN_NOCHECK
	SN_PUBLIC = _ida_name.SN_PUBLIC
	SN_NON_PUBLIC = _ida_name.SN_NON_PUBLIC
	SN_WEAK = _ida_name.SN_WEAK
	SN_NON_WEAK = _ida_name.SN_NON_WEAK
	SN_AUTO = _ida_name.SN_AUTO
	SN_NON_AUTO = _ida_name.SN_NON_AUTO
	SN_NOLIST = _ida_name.SN_NOLIST
	SN_NOWARN = _ida_name.SN_NOWARN
	SN_LOCAL = _ida_name.SN_LOCAL
	SN_IDBENC = _ida_name.SN_IDBENC
	SN_FORCE = _ida_name.SN_FORCE
	SN_NODUMMY = _ida_name.SN_NODUMMY
	SN_DELTAIL = _ida_name.SN_DELTAIL
	UCDR_STRLIT = _ida_name.UCDR_STRLIT
	UCDR_NAME = _ida_name.UCDR_NAME
	UCDR_MANGLED = _ida_name.UCDR_MANGLED
	UCDR_TYPE = _ida_name.UCDR_TYPE
	VNT_IDENT = _ida_name.VNT_IDENT
	VNT_TYPE = _ida_name.VNT_TYPE
	VNT_UDTMEM = _ida_name.VNT_UDTMEM
	VNT_STRLIT = _ida_name.VNT_STRLIT
	VNT_VISIBLE = _ida_name.VNT_VISIBLE
	NT_NONE = _ida_name.NT_NONE
	NT_BYTE = _ida_name.NT_BYTE
	NT_LOCAL = _ida_name.NT_LOCAL
	NT_STKVAR = _ida_name.NT_STKVAR
	NT_ENUM = _ida_name.NT_ENUM
	NT_ABS = _ida_name.NT_ABS
	NT_SEG = _ida_name.NT_SEG
	NT_STROFF = _ida_name.NT_STROFF
	NT_BMASK = _ida_name.NT_BMASK
	NT_REGVAR = _ida_name.NT_REGVAR
	GN_VISIBLE = _ida_name.GN_VISIBLE
	GN_COLORED = _ida_name.GN_COLORED
	GN_DEMANGLED = _ida_name.GN_DEMANGLED
	GN_STRICT = _ida_name.GN_STRICT
	GN_SHORT = _ida_name.GN_SHORT
	GN_LONG = _ida_name.GN_LONG
	GN_LOCAL = _ida_name.GN_LOCAL
	GN_ISRET = _ida_name.GN_ISRET
	GN_NOT_ISRET = _ida_name.GN_NOT_ISRET
	GN_NOT_DUMMY = _ida_name.GN_NOT_DUMMY
	GETN_APPZERO = _ida_name.GETN_APPZERO
	GETN_NOFIXUP = _ida_name.GETN_NOFIXUP
	GETN_NODUMMY = _ida_name.GETN_NODUMMY
	GNCN_NOSEG = _ida_name.GNCN_NOSEG
	GNCN_NOCOLOR = _ida_name.GNCN_NOCOLOR
	GNCN_NOLABEL = _ida_name.GNCN_NOLABEL
	GNCN_NOFUNC = _ida_name.GNCN_NOFUNC
	GNCN_SEG_FUNC = _ida_name.GNCN_SEG_FUNC
	GNCN_SEGNUM = _ida_name.GNCN_SEGNUM
	GNCN_REQFUNC = _ida_name.GNCN_REQFUNC
	GNCN_REQNAME = _ida_name.GNCN_REQNAME
	GNCN_NODBGNM = _ida_name.GNCN_NODBGNM
	GNCN_PREFDBG = _ida_name.GNCN_PREFDBG
	DEBNAME_EXACT = _ida_name.DEBNAME_EXACT
	DEBNAME_LOWER = _ida_name.DEBNAME_LOWER
	DEBNAME_UPPER = _ida_name.DEBNAME_UPPER
	DEBNAME_NICE = _ida_name.DEBNAME_NICE
	DQT_NPURGED_8 = _ida_name.DQT_NPURGED_8
	DQT_NPURGED_4 = _ida_name.DQT_NPURGED_4
	DQT_NPURGED_2 = _ida_name.DQT_NPURGED_2
	DQT_COMPILER = _ida_name.DQT_COMPILER
	DQT_NAME_TYPE = _ida_name.DQT_NAME_TYPE
	DQT_FULL = _ida_name.DQT_FULL
	CN_KEEP_TRAILING__DIGITS = _ida_name.CN_KEEP_TRAILING__DIGITS
	ME_INTERR = _ida_name.ME_INTERR
	ME_PARAMERR = _ida_name.ME_PARAMERR
	ME_ILLSTR = _ida_name.ME_ILLSTR
	ME_SMALLANS = _ida_name.ME_SMALLANS
	ME_FRAME = _ida_name.ME_FRAME
	ME_NOCOMP = _ida_name.ME_NOCOMP
	ME_ERRAUTO = _ida_name.ME_ERRAUTO
	ME_NOHASHMEM = _ida_name.ME_NOHASHMEM
	ME_NOSTRMEM = _ida_name.ME_NOSTRMEM
	ME_NOERROR_LIMIT = _ida_name.ME_NOERROR_LIMIT
	M_PRCMSK = _ida_name.M_PRCMSK
	MT_DEFAULT = _ida_name.MT_DEFAULT
	MT_CDECL = _ida_name.MT_CDECL
	MT_PASCAL = _ida_name.MT_PASCAL
	MT_STDCALL = _ida_name.MT_STDCALL
	MT_FASTCALL = _ida_name.MT_FASTCALL
	MT_THISCALL = _ida_name.MT_THISCALL
	MT_FORTRAN = _ida_name.MT_FORTRAN
	MT_SYSCALL = _ida_name.MT_SYSCALL
	MT_INTERRUPT = _ida_name.MT_INTERRUPT
	MT_MSFASTCALL = _ida_name.MT_MSFASTCALL
	MT_CLRCALL = _ida_name.MT_CLRCALL
	MT_DMDCALL = _ida_name.MT_DMDCALL
	MT_VECTORCALL = _ida_name.MT_VECTORCALL
	MT_REGCALL = _ida_name.MT_REGCALL
	MT_LOCALNAME = _ida_name.MT_LOCALNAME
	M_SAVEREGS = _ida_name.M_SAVEREGS
	M_CLASS = _ida_name.M_CLASS
	MT_PUBLIC = _ida_name.MT_PUBLIC
	MT_PRIVATE = _ida_name.MT_PRIVATE
	MT_PROTECT = _ida_name.MT_PROTECT
	MT_MEMBER = _ida_name.MT_MEMBER
	MT_VTABLE = _ida_name.MT_VTABLE
	MT_RTTI = _ida_name.MT_RTTI
	M_PARMSK = _ida_name.M_PARMSK
	MT_PARSHF = _ida_name.MT_PARSHF
	MT_PARMAX = _ida_name.MT_PARMAX
	M_ELLIPSIS = _ida_name.M_ELLIPSIS
	MT_VOIDARG = _ida_name.MT_VOIDARG
	M_STATIC = _ida_name.M_STATIC
	M_VIRTUAL = _ida_name.M_VIRTUAL
	M_AUTOCRT = _ida_name.M_AUTOCRT
	M_TYPMASK = _ida_name.M_TYPMASK
	MT_OPERAT = _ida_name.MT_OPERAT
	MT_CONSTR = _ida_name.MT_CONSTR
	MT_DESTR = _ida_name.MT_DESTR
	MT_CASTING = _ida_name.MT_CASTING
	MT_CLRCDTOR = _ida_name.MT_CLRCDTOR
	M_TRUNCATE = _ida_name.M_TRUNCATE
	M_THUNK = _ida_name.M_THUNK
	M_ANONNSP = _ida_name.M_ANONNSP
	M_TMPLNAM = _ida_name.M_TMPLNAM
	M_DBGNAME = _ida_name.M_DBGNAME
	M_COMPILER = _ida_name.M_COMPILER
	MT_MSCOMP = _ida_name.MT_MSCOMP
	MT_BORLAN = _ida_name.MT_BORLAN
	MT_WATCOM = _ida_name.MT_WATCOM
	MT_OTHER = _ida_name.MT_OTHER
	MT_GNU = _ida_name.MT_GNU
	MT_GCC3 = _ida_name.MT_GCC3
	MT_VISAGE = _ida_name.MT_VISAGE
	MNG_PTRMSK = _ida_name.MNG_PTRMSK
	MNG_DEFNEAR = _ida_name.MNG_DEFNEAR
	MNG_DEFNEARANY = _ida_name.MNG_DEFNEARANY
	MNG_DEFFAR = _ida_name.MNG_DEFFAR
	MNG_NOPTRTYP16 = _ida_name.MNG_NOPTRTYP16
	MNG_DEFHUGE = _ida_name.MNG_DEFHUGE
	MNG_DEFPTR64 = _ida_name.MNG_DEFPTR64
	MNG_DEFNONE = _ida_name.MNG_DEFNONE
	MNG_NOPTRTYP = _ida_name.MNG_NOPTRTYP
	MNG_NODEFINIT = _ida_name.MNG_NODEFINIT
	MNG_NOUNDERSCORE = _ida_name.MNG_NOUNDERSCORE
	MNG_NOTYPE = _ida_name.MNG_NOTYPE
	MNG_NORETTYPE = _ida_name.MNG_NORETTYPE
	MNG_NOBASEDT = _ida_name.MNG_NOBASEDT
	MNG_NOCALLC = _ida_name.MNG_NOCALLC
	MNG_NOPOSTFC = _ida_name.MNG_NOPOSTFC
	MNG_NOSCTYP = _ida_name.MNG_NOSCTYP
	MNG_NOTHROW = _ida_name.MNG_NOTHROW
	MNG_NOSTVIR = _ida_name.MNG_NOSTVIR
	MNG_NOECSU = _ida_name.MNG_NOECSU
	MNG_NOCSVOL = _ida_name.MNG_NOCSVOL
	MNG_NOCLOSUR = _ida_name.MNG_NOCLOSUR
	MNG_NOUNALG = _ida_name.MNG_NOUNALG
	MNG_NOMANAGE = _ida_name.MNG_NOMANAGE
	MNG_NOMODULE = _ida_name.MNG_NOMODULE
	MNG_SHORT_S = _ida_name.MNG_SHORT_S
	MNG_SHORT_U = _ida_name.MNG_SHORT_U
	MNG_ZPT_SPACE = _ida_name.MNG_ZPT_SPACE
	MNG_DROP_IMP = _ida_name.MNG_DROP_IMP
	MNG_IGN_ANYWAY = _ida_name.MNG_IGN_ANYWAY
	MNG_IGN_JMP = _ida_name.MNG_IGN_JMP
	MNG_MOVE_JMP = _ida_name.MNG_MOVE_JMP
	MNG_COMPILER_MSK = _ida_name.MNG_COMPILER_MSK
	MNG_SHORT_FORM = _ida_name.MNG_SHORT_FORM
	MNG_LONG_FORM = _ida_name.MNG_LONG_FORM
	MNG_CALC_VALID = _ida_name.MNG_CALC_VALID
	cvar = _ida_name.cvar
	ignore_none = cvar.ignore_none
	ignore_regvar = cvar.ignore_regvar
	ignore_llabel = cvar.ignore_llabel
	ignore_stkvar = cvar.ignore_stkvar
	ignore_glabel = cvar.ignore_glabel
	MANGLED_CODE = cvar.MANGLED_CODE
	MANGLED_DATA = cvar.MANGLED_DATA
	MANGLED_UNKNOWN = cvar.MANGLED_UNKNOWN