outctx_t Class Reference

Inheritance diagram for outctx_t:

Public Member Functions
	__init__ (self, *args, **kwargs)
None	setup_outctx (self, str prefix, int flags)
int	term_outctx (self, str prefix=None)
'ssize_t'	retrieve_cmt (self)
'ssize_t'	retrieve_name (self, str arg2, 'color_t *' arg3)
bool	gen_xref_lines (self)
None	out_btoa (self, int Word, 'char' radix=0)
None	set_bin_state (self, int value)
None	out_mnem (self, int width=8, str postfix=None)
None	out_custom_mnem (self, str mnem, int width=8, str postfix=None)
None	out_mnemonic (self)
bool	out_one_operand (self, int n)
None	out_immchar_cmts (self)
None	gen_func_header (self, 'func_t *' pfn)
None	gen_func_footer (self, 'func_t const *' pfn)
None	out_data (self, bool analyze_only)
bool	out_specea (self, 'uchar' segtype)
None	gen_header_extra (self)
None	gen_header (self, *args)
None	out_fcref_names (self)
Public Member Functions inherited from outctx_base_t
bool	only_main_line (self)
bool	multiline (self)
bool	force_code (self)
bool	stack_view (self)
bool	display_voids (self)
None	set_gen_xrefs (self, bool on=True)
None	set_gen_cmt (self, bool on=True)
None	clr_gen_label (self)
None	set_gen_label (self)
None	set_gen_demangled_label (self)
None	set_comment_addr (self, ida_idaapi.ea_t ea)
None	set_dlbind_opnd (self)
bool	print_label_now (self)
int	forbid_annotations (self)
None	restore_ctxflags (self, int saved_flags)
'size_t'	out_printf (self, str format)
'flags64_t'	out_value (self, 'op_t' x, int outf=0)
None	out_symbol (self, 'char' c)
None	out_chars (self, 'char' c, int n)
None	out_spaces (self, 'ssize_t' len)
None	out_line (self, str str, 'color_t' color=0)
None	out_keyword (self, str str)
None	out_register (self, str str)
None	out_lvar (self, str name, int width=-1)
None	out_tagon (self, 'color_t' tag)
None	out_tagoff (self, 'color_t' tag)
None	out_addr_tag (self, ida_idaapi.ea_t ea)
None	out_colored_register_line (self, str str)
None	out_char (self, 'char' c)
None	out_long (self, int v, 'char' radix)
bool	out_name_expr (self, *args)
None	close_comment (self)
bool	flush_outbuf (self, int indent=-1)
bool	flush_buf (self, str buf, int indent=-1)
bool	gen_printf (self, int indent, str format)
bool	gen_empty_line (self)
bool	gen_border_line (self, bool solid=False)
bool	gen_cmt_line (self, str format)
bool	gen_collapsed_line (self, str format)
bool	gen_block_cmt (self, str cmt, 'color_t' color)
None	init_lines_array (self, 'qstrvec_t *' answers, int maxsize)
'ssize_t'	get_stkvar (self, 'op_t' x, int v, 'sval_t *' vv, 'int *' is_sp_based, 'tinfo_t' _frame)
None	gen_empty_line_without_annotations (self)
'flags64_t'	getF (self)

Static Public Attributes
str	bin_ea
str	bin_state
str	gl_bpsize
str	bin_width
str	insn
str	curlabel
str	wif
str	procmod
str	ph
str	ash
str	saved_immvals
str	prefix_ea
str	next_line_ea
Static Public Attributes inherited from outctx_base_t
str	insn_ea
str	outbuf
str	F32
str	default_lnnum

Properties
	thisown
Properties inherited from outctx_base_t
	thisown

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		*	args,
		**	kwargs )

Reimplemented from outctx_base_t.

Member Function Documentation

gen_func_footer()

None gen_func_footer	(		self,
		'func_t const *'	pfn )

gen_func_header()

None gen_func_header	(		self,
		'func_t *'	pfn )

gen_header()

None gen_header	(		self,
		*	args )

gen_header_extra()

None gen_header_extra

(

self

)

gen_xref_lines()

bool gen_xref_lines

(

self

)

Reimplemented from outctx_base_t.

out_btoa()

None out_btoa	(		self,
		int	Word,
		'char'	radix = 0 )

Output a number with the specified base (binary, octal, decimal, hex) The number is output without color codes. see also out_long() 

Reimplemented from outctx_base_t.

out_custom_mnem()

None out_custom_mnem	(		self,
		str	mnem,
		int	width = 8,
		str	postfix = None )

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

@param mnem: custom mnemonic
@param width: width of field with mnemonic. if < 0, then 'postfix' will be output before the mnemonic, i.e. as a prefix
@param postfix: optional postfix added to 'mnem'

out_data()

None out_data	(		self,
		bool	analyze_only )

out_fcref_names()

None out_fcref_names

(

self

)

Print addresses referenced *from* the specified address as commented symbolic names. This function is used to show, for example, multiple callees of an indirect call. This function outputs colored text. 

out_immchar_cmts()

None out_immchar_cmts

(

self

)

Print all operand values as commented character constants. This function is used to comment void operands with their representation in the form of character constants. This function outputs colored text. 

out_mnem()

None out_mnem	(		self,
		int	width = 8,
		str	postfix = None )

Output instruction mnemonic for 'insn' using information in 'ph.instruc' array. 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. 

@param width: width of field with mnemonic. if < 0, then 'postfix' will be output before the mnemonic, i.e. as a prefix
@param postfix: optional postfix added to the instruction mnemonic

out_mnemonic()

None out_mnemonic

(

self

)

Output instruction mnemonic using information in 'insn'. 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 )

Use this function to output an operand of an instruction. 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. 

@param n: 0..UA_MAXOP-1 operand number
@retval 1: operand is displayed
@retval 0: operand is hidden

out_specea()

bool out_specea	(		self,
		'uchar'	segtype )

retrieve_cmt()

'ssize_t' retrieve_cmt

(

self

)

Reimplemented from outctx_base_t.

retrieve_name()

'ssize_t' retrieve_name	(		self,
		str	arg2,
		'color_t *'	arg3 )

Reimplemented from outctx_base_t.

set_bin_state()

None set_bin_state	(		self,
		int	value )

setup_outctx()

None setup_outctx	(		self,
		str	prefix,
		int	flags )

Initialization; normally used only by the kernel.

Reimplemented from outctx_base_t.

term_outctx()

int term_outctx	(		self,
		str	prefix = None )

Finalize the output context. 

@returns the number of generated lines.

Reimplemented from outctx_base_t.

Member Data Documentation

ash

str ash

static

Initial value:

=  property(_ida_ua.outctx_t_ash_get, _ida_ua.
        outctx_t_ash_set)

bin_ea

str bin_ea

static

Initial value:

=  property(_ida_ua.outctx_t_bin_ea_get, _ida_ua.
        outctx_t_bin_ea_set)

bin_state

str bin_state

static

Initial value:

=  property(_ida_ua.outctx_t_bin_state_get, _ida_ua.
        outctx_t_bin_state_set)

bin_width

str bin_width

static

Initial value:

=  property(_ida_ua.outctx_t_bin_width_get, _ida_ua.
        outctx_t_bin_width_set)

curlabel

str curlabel

static

Initial value:

=  property(_ida_ua.outctx_t_curlabel_get, _ida_ua.
        outctx_t_curlabel_set)

gl_bpsize

str gl_bpsize

static

Initial value:

=  property(_ida_ua.outctx_t_gl_bpsize_get, _ida_ua.
        outctx_t_gl_bpsize_set)

insn

str insn

static

Initial value:

=  property(_ida_ua.outctx_t_insn_get, _ida_ua.
        outctx_t_insn_set)

next_line_ea

str next_line_ea

static

Initial value:

=  property(_ida_ua.outctx_t_next_line_ea_get,
        _ida_ua.outctx_t_next_line_ea_set)

ph

str ph

static

Initial value:

=  property(_ida_ua.outctx_t_ph_get, _ida_ua.
        outctx_t_ph_set)

prefix_ea

str prefix_ea

static

Initial value:

=  property(_ida_ua.outctx_t_prefix_ea_get, _ida_ua.
        outctx_t_prefix_ea_set)

procmod

str procmod

static

Initial value:

=  property(_ida_ua.outctx_t_procmod_get, _ida_ua
        .outctx_t_procmod_set)

saved_immvals

str saved_immvals

static

Initial value:

=  property(_ida_ua.
        outctx_t_saved_immvals_get, _ida_ua.outctx_t_saved_immvals_set)

wif

str wif

static

Initial value:

=  property(_ida_ua.outctx_t_wif_get, _ida_ua.
        outctx_t_wif_set)

Property Documentation

thisown

thisown

static

Initial value:

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

---

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

• ida_ua.py