ida_lines.py File Reference

Classes
class	user_defined_prefix_t
	Proxy of C++ user_defined_prefix_t class. More...

Namespaces
namespace	ida_lines
	High level functions that deal with the generation of the disassembled text lines.

Functions
"ssize_t"	tag_strlen ("char const *" line)
	tag_strlen(line) -> ssize_t Calculate length of a colored string This function computes the length in unicode codepoints of a line
"color_t"	calc_prefix_color ("ea_t" ea)
	calc_prefix_color(ea) -> color_t Get prefix color for line at 'ea'
"bgcolor_t"	calc_bg_color ("ea_t" ea)
	calc_bg_color(ea) -> bgcolor_t Get background color for line at 'ea'
"bool"	add_sourcefile ("ea_t" ea1, "ea_t" ea2, "char const *" filename)
	add_sourcefile(ea1, ea2, filename) -> bool Mark a range of address as belonging to a source file.
"char const *"	get_sourcefile ("ea_t" ea, "range_t" bounds=None)
	get_sourcefile(ea, bounds=None) -> char const Get name of source file occupying the given address.
"bool"	del_sourcefile ("ea_t" ea)
	del_sourcefile(ea) -> bool Delete information about the source file.
"bool"	install_user_defined_prefix (*args)
	install_user_defined_prefix(prefix_len, udp, owner) -> bool User-defined line-prefixes are displayed just after the autogenerated line prefixes in the disassembly listing.
"bool"	add_extra_line (*args)
	add_extra_line(ea, isprev, format) -> bool Add anterior/posterior non-comment line(s).
"bool"	add_extra_cmt (*args)
	add_extra_cmt(ea, isprev, format) -> bool Add anterior/posterior comment line(s).
"bool"	add_pgm_cmt (*args)
	add_pgm_cmt(format) -> bool Add anterior comment line(s) at the start of program.
"qstring *"	generate_disasm_line ("ea_t" ea, "int" flags=0)
	generate_disasm_line(ea, flags=0) -> bool
"int"	get_first_free_extra_cmtidx ("ea_t" ea, "int" start)
	get_first_free_extra_cmtidx(ea, start) -> int
"bool"	update_extra_cmt ("ea_t" ea, "int" what, "char const *" str)
	update_extra_cmt(ea, what, str) -> bool
"bool"	del_extra_cmt ("ea_t" ea, "int" what)
	del_extra_cmt(ea, what) -> bool
"int"	get_extra_cmt ("ea_t" ea, "int" what)
	get_extra_cmt(ea, what) -> ssize_t
"void"	delete_extra_cmts ("ea_t" ea, "int" what)
	delete_extra_cmts(ea, what)
"encoder_t *"	create_encoding_helper (*args)
	create_encoding_helper(encidx=-1, nr=nr_once) -> encoder_t
"PyObject *"	tag_remove ("char const *" nonnul_instr)
	tag_remove(nonnul_instr) -> str
"PyObject *"	tag_addr ("ea_t" ea)
	tag_addr(ea) -> PyObject * Insert an address mark into a string.
"int"	tag_skipcode ("char const *" line)
	tag_skipcode(line) -> int Skip one color code.
"int"	tag_skipcodes ("char const *" line)
	tag_skipcodes(line) -> int Move the pointer past all color codes.
"int"	tag_advance ("char const *" line, "int" cnt)
	tag_advance(line, cnt) -> int Move pointer to a 'line' to 'cnt' positions right.
"PyObject *"	generate_disassembly ("ea_t" ea, "int" max_lines, "bool" as_stack, "bool" notags)
	requires_color_esc (c)
	Checks if the given character requires escaping Is the given char a color escape character?
	COLSTR (str, tag)
	Utility function to create a colored line.

Variables
	COLOR_ON = _ida_lines.COLOR_ON
	COLOR_OFF = _ida_lines.COLOR_OFF
	COLOR_ESC = _ida_lines.COLOR_ESC
	COLOR_INV = _ida_lines.COLOR_INV
	SCOLOR_ON = _ida_lines.SCOLOR_ON
	SCOLOR_OFF = _ida_lines.SCOLOR_OFF
	SCOLOR_ESC = _ida_lines.SCOLOR_ESC
	SCOLOR_INV = _ida_lines.SCOLOR_INV
	SCOLOR_DEFAULT = _ida_lines.SCOLOR_DEFAULT
	SCOLOR_REGCMT = _ida_lines.SCOLOR_REGCMT
	SCOLOR_RPTCMT = _ida_lines.SCOLOR_RPTCMT
	SCOLOR_AUTOCMT = _ida_lines.SCOLOR_AUTOCMT
	SCOLOR_INSN = _ida_lines.SCOLOR_INSN
	SCOLOR_DATNAME = _ida_lines.SCOLOR_DATNAME
	SCOLOR_DNAME = _ida_lines.SCOLOR_DNAME
	SCOLOR_DEMNAME = _ida_lines.SCOLOR_DEMNAME
	SCOLOR_SYMBOL = _ida_lines.SCOLOR_SYMBOL
	SCOLOR_CHAR = _ida_lines.SCOLOR_CHAR
	SCOLOR_STRING = _ida_lines.SCOLOR_STRING
	SCOLOR_NUMBER = _ida_lines.SCOLOR_NUMBER
	SCOLOR_VOIDOP = _ida_lines.SCOLOR_VOIDOP
	SCOLOR_CREF = _ida_lines.SCOLOR_CREF
	SCOLOR_DREF = _ida_lines.SCOLOR_DREF
	SCOLOR_CREFTAIL = _ida_lines.SCOLOR_CREFTAIL
	SCOLOR_DREFTAIL = _ida_lines.SCOLOR_DREFTAIL
	SCOLOR_ERROR = _ida_lines.SCOLOR_ERROR
	SCOLOR_PREFIX = _ida_lines.SCOLOR_PREFIX
	SCOLOR_BINPREF = _ida_lines.SCOLOR_BINPREF
	SCOLOR_EXTRA = _ida_lines.SCOLOR_EXTRA
	SCOLOR_ALTOP = _ida_lines.SCOLOR_ALTOP
	SCOLOR_HIDNAME = _ida_lines.SCOLOR_HIDNAME
	SCOLOR_LIBNAME = _ida_lines.SCOLOR_LIBNAME
	SCOLOR_LOCNAME = _ida_lines.SCOLOR_LOCNAME
	SCOLOR_CODNAME = _ida_lines.SCOLOR_CODNAME
	SCOLOR_ASMDIR = _ida_lines.SCOLOR_ASMDIR
	SCOLOR_MACRO = _ida_lines.SCOLOR_MACRO
	SCOLOR_DSTR = _ida_lines.SCOLOR_DSTR
	SCOLOR_DCHAR = _ida_lines.SCOLOR_DCHAR
	SCOLOR_DNUM = _ida_lines.SCOLOR_DNUM
	SCOLOR_KEYWORD = _ida_lines.SCOLOR_KEYWORD
	SCOLOR_REG = _ida_lines.SCOLOR_REG
	SCOLOR_IMPNAME = _ida_lines.SCOLOR_IMPNAME
	SCOLOR_SEGNAME = _ida_lines.SCOLOR_SEGNAME
	SCOLOR_UNKNAME = _ida_lines.SCOLOR_UNKNAME
	SCOLOR_CNAME = _ida_lines.SCOLOR_CNAME
	SCOLOR_UNAME = _ida_lines.SCOLOR_UNAME
	SCOLOR_COLLAPSED = _ida_lines.SCOLOR_COLLAPSED
	SCOLOR_ADDR = _ida_lines.SCOLOR_ADDR
	COLOR_SELECTED = _ida_lines.COLOR_SELECTED
	COLOR_LIBFUNC = _ida_lines.COLOR_LIBFUNC
	COLOR_REGFUNC = _ida_lines.COLOR_REGFUNC
	COLOR_CODE = _ida_lines.COLOR_CODE
	COLOR_DATA = _ida_lines.COLOR_DATA
	COLOR_UNKNOWN = _ida_lines.COLOR_UNKNOWN
	COLOR_EXTERN = _ida_lines.COLOR_EXTERN
	COLOR_CURITEM = _ida_lines.COLOR_CURITEM
	COLOR_CURLINE = _ida_lines.COLOR_CURLINE
	COLOR_HIDLINE = _ida_lines.COLOR_HIDLINE
	COLOR_LUMFUNC = _ida_lines.COLOR_LUMFUNC
	COLOR_BG_MAX = _ida_lines.COLOR_BG_MAX
	cvar = _ida_lines.cvar
	COLOR_DEFAULT = cvar.COLOR_DEFAULT
	COLOR_REGCMT = cvar.COLOR_REGCMT
	COLOR_RPTCMT = cvar.COLOR_RPTCMT
	COLOR_AUTOCMT = cvar.COLOR_AUTOCMT
	COLOR_INSN = cvar.COLOR_INSN
	COLOR_DATNAME = cvar.COLOR_DATNAME
	COLOR_DNAME = cvar.COLOR_DNAME
	COLOR_DEMNAME = cvar.COLOR_DEMNAME
	COLOR_SYMBOL = cvar.COLOR_SYMBOL
	COLOR_CHAR = cvar.COLOR_CHAR
	COLOR_STRING = cvar.COLOR_STRING
	COLOR_NUMBER = cvar.COLOR_NUMBER
	COLOR_VOIDOP = cvar.COLOR_VOIDOP
	COLOR_CREF = cvar.COLOR_CREF
	COLOR_DREF = cvar.COLOR_DREF
	COLOR_CREFTAIL = cvar.COLOR_CREFTAIL
	COLOR_DREFTAIL = cvar.COLOR_DREFTAIL
	COLOR_ERROR = cvar.COLOR_ERROR
	COLOR_PREFIX = cvar.COLOR_PREFIX
	COLOR_BINPREF = cvar.COLOR_BINPREF
	COLOR_EXTRA = cvar.COLOR_EXTRA
	COLOR_ALTOP = cvar.COLOR_ALTOP
	COLOR_HIDNAME = cvar.COLOR_HIDNAME
	COLOR_LIBNAME = cvar.COLOR_LIBNAME
	COLOR_LOCNAME = cvar.COLOR_LOCNAME
	COLOR_CODNAME = cvar.COLOR_CODNAME
	COLOR_ASMDIR = cvar.COLOR_ASMDIR
	COLOR_MACRO = cvar.COLOR_MACRO
	COLOR_DSTR = cvar.COLOR_DSTR
	COLOR_DCHAR = cvar.COLOR_DCHAR
	COLOR_DNUM = cvar.COLOR_DNUM
	COLOR_KEYWORD = cvar.COLOR_KEYWORD
	COLOR_REG = cvar.COLOR_REG
	COLOR_IMPNAME = cvar.COLOR_IMPNAME
	COLOR_SEGNAME = cvar.COLOR_SEGNAME
	COLOR_UNKNAME = cvar.COLOR_UNKNAME
	COLOR_CNAME = cvar.COLOR_CNAME
	COLOR_UNAME = cvar.COLOR_UNAME
	COLOR_COLLAPSED = cvar.COLOR_COLLAPSED
	COLOR_FG_MAX = cvar.COLOR_FG_MAX
	COLOR_ADDR = cvar.COLOR_ADDR
	COLOR_OPND1 = cvar.COLOR_OPND1
	COLOR_OPND2 = cvar.COLOR_OPND2
	COLOR_OPND3 = cvar.COLOR_OPND3
	COLOR_OPND4 = cvar.COLOR_OPND4
	COLOR_OPND5 = cvar.COLOR_OPND5
	COLOR_OPND6 = cvar.COLOR_OPND6
	COLOR_OPND7 = cvar.COLOR_OPND7
	COLOR_OPND8 = cvar.COLOR_OPND8
	COLOR_RESERVED1 = cvar.COLOR_RESERVED1
	COLOR_LUMINA = cvar.COLOR_LUMINA
	VEL_POST = _ida_lines.VEL_POST
	VEL_CMT = _ida_lines.VEL_CMT
	GDISMF_AS_STACK = _ida_lines.GDISMF_AS_STACK
	GDISMF_ADDR_TAG = _ida_lines.GDISMF_ADDR_TAG
	GENDSM_FORCE_CODE = _ida_lines.GENDSM_FORCE_CODE
	GENDSM_MULTI_LINE = _ida_lines.GENDSM_MULTI_LINE
	GENDSM_REMOVE_TAGS = _ida_lines.GENDSM_REMOVE_TAGS
int	COLOR_ADDR_SIZE = 0xFFFFFFFFFFFFFFFF else 8
str	SCOLOR_FG_MAX = '\x28'
	SCOLOR_OPND1 = chr(cvar.COLOR_ADDR+1)
	SCOLOR_OPND2 = chr(cvar.COLOR_ADDR+2)
	SCOLOR_OPND3 = chr(cvar.COLOR_ADDR+3)
	SCOLOR_OPND4 = chr(cvar.COLOR_ADDR+4)
	SCOLOR_OPND5 = chr(cvar.COLOR_ADDR+5)
	SCOLOR_OPND6 = chr(cvar.COLOR_ADDR+6)
	SCOLOR_UTF8 = chr(cvar.COLOR_ADDR+10)
tuple	PALETTE_SIZE = (cvar.COLOR_FG_MAX+_ida_lines.COLOR_BG_MAX)
	E_PREV = cvar.E_PREV
	E_NEXT = cvar.E_NEXT