outctx_t Class Reference

Proxy of C++ outctx_t class.

Inheritance diagram for outctx_t:

Public Member Functions
	__init__ (self, *args, **kwargs)
"void"	setup_outctx (self, "char const *" prefix, "int" flags)
	setup_outctx(self, prefix, flags) Initialization; normally used only by the kernel.
"int"	term_outctx (self, "char const *" prefix=None)
	term_outctx(self, prefix=None) -> int Finalize the output context.
"ssize_t"	retrieve_cmt (self)
	retrieve_cmt(self) -> ssize_t
"ssize_t"	retrieve_name (self, "qstring *" arg2, "color_t *" arg3)
	retrieve_name(self, arg2, arg3) -> ssize_t
"bool"	gen_xref_lines (self)
	gen_xref_lines(self) -> bool
"void"	out_btoa (self, "uval_t" Word, "char" radix=0)
	out_btoa(self, Word, radix=0) Output a number with the specified base (binary, octal, decimal, hex) The number is output without color codes.
"void"	set_bin_state (self, "int" value)
	set_bin_state(self, value)
"void"	out_mnem (self, "int" width=8, "char const *" postfix=None)
	out_mnem(self, width=8, postfix=None) Output instruction mnemonic for 'insn' using information in 'ph.instruc' array.
"void"	out_custom_mnem (self, "char const *" mnem, "int" width=8, "char const *" postfix=None)
	out_custom_mnem(self, mnem, width=8, postfix=None) Output custom mnemonic for 'insn'.
"void"	out_mnemonic (self)
	out_mnemonic(self) Output instruction mnemonic using information in 'insn'.
"bool"	out_one_operand (self, "int" n)
	out_one_operand(self, n) -> bool Use this function to output an operand of an instruction.
"void"	out_immchar_cmts (self)
	out_immchar_cmts(self) Print all operand values as commented character constants.
"void"	gen_func_header (self, "func_t *" pfn)
	gen_func_header(self, pfn)
"void"	gen_func_footer (self, "func_t const *" pfn)
	gen_func_footer(self, pfn)
"void"	out_data (self, "bool" analyze_only)
	out_data(self, analyze_only)
"bool"	out_specea (self, "uchar" segtype)
	out_specea(self, segtype) -> bool
"void"	gen_header_extra (self)
	gen_header_extra(self)
"void"	gen_header (self, *args)
	gen_header(self, flags=((1 << 0)|(1 << 1)), proc_name=None, proc_flavour=None)
"void"	out_fcref_names (self)
	out_fcref_names(self) Print addresses referenced from the specified address as commented symbolic names.
Public Member Functions inherited from outctx_base_t
"bool"	only_main_line (self)
	only_main_line(self) -> bool
"bool"	multiline (self)
	multiline(self) -> bool
"bool"	force_code (self)
	force_code(self) -> bool
"bool"	stack_view (self)
	stack_view(self) -> bool
"bool"	display_voids (self)
	display_voids(self) -> bool
"void"	set_gen_xrefs (self, "bool" on=True)
	set_gen_xrefs(self, on=True)
"void"	set_gen_cmt (self, "bool" on=True)
	set_gen_cmt(self, on=True)
"void"	clr_gen_label (self)
	clr_gen_label(self)
"void"	set_gen_label (self)
	set_gen_label(self)
"void"	set_gen_demangled_label (self)
	set_gen_demangled_label(self)
"void"	set_comment_addr (self, "ea_t" ea)
	set_comment_addr(self, ea)
"void"	set_dlbind_opnd (self)
	set_dlbind_opnd(self)
"bool"	print_label_now (self)
	print_label_now(self) -> bool
"int"	forbid_annotations (self)
	forbid_annotations(self) -> int
"void"	restore_ctxflags (self, "int" saved_flags)
	restore_ctxflags(self, saved_flags)
"size_t"	out_printf (self, "char const *" format)
	out_printf(self, format) -> size_t Functions to append text to the current output buffer (outbuf) Append a formatted string to the output string.
"flags64_t"	out_value (self, "op_t" x, "int" outf=0)
	out_value(self, x, outf=0) -> flags64_t Output immediate value.
"void"	out_symbol (self, "char" c)
	out_symbol(self, c) Output a character with COLOR_SYMBOL color.
"void"	out_chars (self, "char" c, "int" n)
	out_chars(self, c, n) Append a character multiple times.
"void"	out_spaces (self, "ssize_t" len)
	out_spaces(self, len) Appends spaces to outbuf until its tag_strlen becomes 'len'.
"void"	out_line (self, "char const *" str, "color_t" color=0)
	out_line(self, str, color=0) Output a string with the specified color.
"void"	out_keyword (self, "char const *" str)
	out_keyword(self, str) Output a string with COLOR_KEYWORD color.
"void"	out_register (self, "char const *" str)
	out_register(self, str) Output a character with COLOR_REG color.
"void"	out_tagon (self, "color_t" tag)
	out_tagon(self, tag) Output "turn color on" escape sequence.
"void"	out_tagoff (self, "color_t" tag)
	out_tagoff(self, tag) Output "turn color off" escape sequence.
"void"	out_addr_tag (self, "ea_t" ea)
	out_addr_tag(self, ea) Output "address" escape sequence.
"void"	out_colored_register_line (self, "char const *" str)
	out_colored_register_line(self, str) Output a colored line with register names in it.
"void"	out_char (self, "char" c)
	out_char(self, c) Output one character.
"void"	out_long (self, "sval_t" v, "char" radix)
	out_long(self, v, radix) Output a number with appropriate color.
"bool"	out_name_expr (self, *args)
	out_name_expr(self, x, ea, off=BADADDR) -> bool Output a name expression.
"void"	close_comment (self)
	close_comment(self)
"bool"	flush_outbuf (self, "int" indent=-1)
	flush_outbuf(self, indent=-1) -> bool Functions to populate the output line array (lnar) Move the contents of the output buffer to the line array (outbuf->lnar) The kernel augments the outbuf contents with additional text like the line prefix, user-defined comments, xrefs, etc at this call.
"bool"	flush_buf (self, "char const *" buf, "int" indent=-1)
	flush_buf(self, buf, indent=-1) -> bool Append contents of 'buf' to the line array.
"bool"	gen_printf (self, "int" indent, "char const *" format)
	gen_printf(self, indent, format) -> bool printf-like function to add lines to the line array.
"bool"	gen_empty_line (self)
	gen_empty_line(self) -> bool Generate empty line.
"bool"	gen_border_line (self, "bool" solid=False)
	gen_border_line(self, solid=False) -> bool Generate thin border line.
"bool"	gen_cmt_line (self, "char const *" format)
	gen_cmt_line(self, format) -> bool Generate one non-indented comment line, colored with COLOR_AUTOCMT.
"bool"	gen_collapsed_line (self, "char const *" format)
	gen_collapsed_line(self, format) -> bool Generate one non-indented comment line, colored with COLOR_COLLAPSED.
"bool"	gen_block_cmt (self, "char const *" cmt, "color_t" color)
	gen_block_cmt(self, cmt, color) -> bool Generate big non-indented comment lines.
"void"	init_lines_array (self, "qstrvec_t *" answers, "int" maxsize)
	init_lines_array(self, answers, maxsize)
"ssize_t"	get_stkvar (self, "op_t" x, "uval_t" v, "sval_t *" vv, "int *" is_sp_based, "tinfo_t" _frame)
	get_stkvar(self, x, v, vv, is_sp_based, _frame) -> ssize_t
"void"	gen_empty_line_without_annotations (self)
	gen_empty_line_without_annotations(self)
"flags64_t"	getF (self)
	getF(self) -> flags64_t

Static Public Attributes
str	bin_ea = property(_ida_ua.outctx_t_bin_ea_get, _ida_ua.outctx_t_bin_ea_set, doc=)
str	bin_state = property(_ida_ua.outctx_t_bin_state_get, _ida_ua.outctx_t_bin_state_set, doc=)
str	gl_bpsize = property(_ida_ua.outctx_t_gl_bpsize_get, _ida_ua.outctx_t_gl_bpsize_set, doc=)
str	bin_width = property(_ida_ua.outctx_t_bin_width_get, _ida_ua.outctx_t_bin_width_set, doc=)
str	insn = property(_ida_ua.outctx_t_insn_get, _ida_ua.outctx_t_insn_set, doc=)
str	curlabel = property(_ida_ua.outctx_t_curlabel_get, _ida_ua.outctx_t_curlabel_set, doc=)
str	wif = property(_ida_ua.outctx_t_wif_get, _ida_ua.outctx_t_wif_set, doc=)
str	procmod = property(_ida_ua.outctx_t_procmod_get, _ida_ua.outctx_t_procmod_set, doc=)
str	ph = property(_ida_ua.outctx_t_ph_get, _ida_ua.outctx_t_ph_set, doc=)
str	ash = property(_ida_ua.outctx_t_ash_get, _ida_ua.outctx_t_ash_set, doc=)
str	saved_immvals = property(_ida_ua.outctx_t_saved_immvals_get, _ida_ua.outctx_t_saved_immvals_set, doc=)
str	prefix_ea = property(_ida_ua.outctx_t_prefix_ea_get, _ida_ua.outctx_t_prefix_ea_set, doc=)
str	next_line_ea = property(_ida_ua.outctx_t_next_line_ea_get, _ida_ua.outctx_t_next_line_ea_set, doc=)
Static Public Attributes inherited from outctx_base_t
str	insn_ea = property(_ida_ua.outctx_base_t_insn_ea_get, _ida_ua.outctx_base_t_insn_ea_set, doc=)
str	outbuf = property(_ida_ua.outctx_base_t_outbuf_get, _ida_ua.outctx_base_t_outbuf_set, doc=)
str	F32 = property(_ida_ua.outctx_base_t_F32_get, _ida_ua.outctx_base_t_F32_set, doc=)
str	default_lnnum = property(_ida_ua.outctx_base_t_default_lnnum_get, _ida_ua.outctx_base_t_default_lnnum_set, doc=)

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
Properties inherited from outctx_base_t
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		*	args,
		**	kwargs )

Reimplemented from outctx_base_t.

Member Function Documentation

gen_func_footer()

"void" gen_func_footer	(		self,
		"func_t const *"	pfn )

Parameters

pfn	func_t const *

gen_func_header()

"void" gen_func_header	(		self,
		"func_t *"	pfn )

Parameters

pfn

func_t *

gen_header()

"void" gen_header	(		self,
		*	args )

Parameters

flags	int
proc_name	char const *
proc_flavour	char const *

gen_header_extra()

"void" gen_header_extra

(

self

)

gen_xref_lines()

"bool" gen_xref_lines

(

self

)

Reimplemented from outctx_base_t.

out_btoa()

"void" out_btoa	(		self,
		"uval_t"	Word,
		"char"	radix = 0 )

see also out_long()

Parameters

Word	(C++: uval_t)
radix	(C++: char)

Reimplemented from outctx_base_t.

out_custom_mnem()

"void" out_custom_mnem	(		self,
		"char const *"	mnem,
		"int"	width = 8,
		"char const *"	postfix = None )

E.g. if it should differ from the one in 'ph.instruc'. This function outputs colored text. See out_mnem

Parameters

mnem	(C++: const char *) custom mnemonic
width	(C++: int) width of field with mnemonic. if < 0, then 'postfix' will be output before the mnemonic, i.e. as a prefix
postfix	(C++: const char *) optional postfix added to 'mnem'

out_data()

"void" out_data	(		self,
		"bool"	analyze_only )

Parameters

analyze_only

bool

out_fcref_names()

"void" out_fcref_names

(

self

)

This function is used to show, for example, multiple callees of an indirect call. This function outputs colored text.

out_immchar_cmts()

"void" out_immchar_cmts

(

self

)

This function is used to comment void operands with their representation in the form of character constants. This function outputs colored text.

out_mnem()

"void" out_mnem	(		self,
		"int"	width = 8,
		"char const *"	postfix = None )

This function outputs colored text. It should be called from processor_t::ev_out_insn() or processor_t::ev_out_mnem() handler. It will output at least one space after the instruction. mnemonic even if the specified 'width' is not enough.

Parameters

width	(C++: int) width of field with mnemonic. if < 0, then 'postfix' will be output before the mnemonic, i.e. as a prefix
postfix	(C++: const char *) optional postfix added to the instruction mnemonic

out_mnemonic()

"void" out_mnemonic

(

self

)

It should be called from processor_t::ev_out_insn() and it will call processor_t::ev_out_mnem() or out_mnem. This function outputs colored text.

out_one_operand()

"bool" out_one_operand	(		self,
		"int"	n )

This function checks for the existence of a manually defined operand and will output it if it exists. It should be called from processor_t::ev_out_insn() and it will call processor_t::ev_out_operand(). This function outputs colored text.

Parameters

n	(C++: int) 0..UA_MAXOP-1 operand number

Return values

1	operand is displayed
0	operand is hidden

out_specea()

"bool" out_specea	(		self,
		"uchar"	segtype )

Parameters

segtype

uchar

retrieve_cmt()

"ssize_t" retrieve_cmt

(

self

)

Reimplemented from outctx_base_t.

retrieve_name()

"ssize_t" retrieve_name	(		self,
		"qstring *"	arg2,
		"color_t *"	arg3 )

Parameters

arg2	qstring *
arg3	color_t *

Reimplemented from outctx_base_t.

set_bin_state()

"void" set_bin_state	(		self,
		"int"	value )

Parameters

value

int

setup_outctx()

"void" setup_outctx	(		self,
		"char const *"	prefix,
		"int"	flags )

Parameters

prefix	(C++: const char *) char const *
flags	int

Reimplemented from outctx_base_t.

term_outctx()

"int" term_outctx	(		self,
		"char const *"	prefix = None )

Parameters

prefix

(C++: const char *) char const *

Returns

: the number of generated lines.

Reimplemented from outctx_base_t.

Member Data Documentation

ash

str ash = property(_ida_ua.outctx_t_ash_get, _ida_ua.outctx_t_ash_set, doc=)

static

bin_ea

str bin_ea = property(_ida_ua.outctx_t_bin_ea_get, _ida_ua.outctx_t_bin_ea_set, doc=)

static

bin_state

str bin_state = property(_ida_ua.outctx_t_bin_state_get, _ida_ua.outctx_t_bin_state_set, doc=)

static

bin_width

str bin_width = property(_ida_ua.outctx_t_bin_width_get, _ida_ua.outctx_t_bin_width_set, doc=)

static

curlabel

str curlabel = property(_ida_ua.outctx_t_curlabel_get, _ida_ua.outctx_t_curlabel_set, doc=)

static

gl_bpsize

str gl_bpsize = property(_ida_ua.outctx_t_gl_bpsize_get, _ida_ua.outctx_t_gl_bpsize_set, doc=)

static

insn

str insn = property(_ida_ua.outctx_t_insn_get, _ida_ua.outctx_t_insn_set, doc=)

static

next_line_ea

str next_line_ea = property(_ida_ua.outctx_t_next_line_ea_get, _ida_ua.outctx_t_next_line_ea_set, doc=)

static

ph

str ph = property(_ida_ua.outctx_t_ph_get, _ida_ua.outctx_t_ph_set, doc=)

static

prefix_ea

str prefix_ea = property(_ida_ua.outctx_t_prefix_ea_get, _ida_ua.outctx_t_prefix_ea_set, doc=)

static

procmod

str procmod = property(_ida_ua.outctx_t_procmod_get, _ida_ua.outctx_t_procmod_set, doc=)

static

saved_immvals

str saved_immvals = property(_ida_ua.outctx_t_saved_immvals_get, _ida_ua.outctx_t_saved_immvals_set, doc=)

static

wif

str wif = property(_ida_ua.outctx_t_wif_get, _ida_ua.outctx_t_wif_set, doc=)

static

Property Documentation

thisown

thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")

static

---

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

• ida_ua.py