interactive_graph_t Class Reference

Proxy of C++ interactive_graph_t class.

Inheritance diagram for interactive_graph_t:

Public Member Functions
	__init__ (self, *args, **kwargs)
	init(self) -> drawable_graph_t
"int"	size (self)
	size(self) -> int Get the total number of nodes (including group nodes, and including hidden nodes.)
"int"	node_qty (self)
	node_qty(self) -> int Get the number of visible nodes (the list can be retrieved using gdl.hpp's node_iterator)
"bool"	empty (self)
	empty(self) -> bool Is the graph (visually) empty?
"bool"	exists (self, "int" node)
	exists(self, node) -> bool Is the node visible?
"int"	get_node_representative (self, "int" node)
	get_node_representative(self, node) -> int Get the node that currently visually represents 'node'.
"int"	get_node_group (self, "int" node)
	get_node_group(self, node) -> int
"void"	set_node_group (self, "int" node, "int" group)
	set_node_group(self, node, group)
"bool"	is_deleted_node (self, "int" node)
	is_deleted_node(self, node) -> bool
"void"	set_deleted_node (self, "int" node)
	set_deleted_node(self, node)
"bool"	is_subgraph_node (self, "int" node)
	is_subgraph_node(self, node) -> bool
"bool"	is_dot_node (self, "int" node)
	is_dot_node(self, node) -> bool
"bool"	is_group_node (self, "int" node)
	is_group_node(self, node) -> bool
"bool"	is_displayable_node (self, "int" node)
	is_displayable_node(self, node) -> bool
"bool"	is_simple_node (self, "int" node)
	is_simple_node(self, node) -> bool
"bool"	is_collapsed_node (self, "int" node)
	is_collapsed_node(self, node) -> bool
"bool"	is_uncollapsed_node (self, "int" node)
	is_uncollapsed_node(self, node) -> bool
"bool"	is_visible_node (self, "int" node)
	is_visible_node(self, node) -> bool Is the node currently visible?
"int"	get_first_subgraph_node (self, "int" group)
	get_first_subgraph_node(self, group) -> int
"int"	get_next_subgraph_node (self, "int" group, "int" current)
	get_next_subgraph_node(self, group, current) -> int
"int"	create_group (self, "intvec_t const &" nodes)
	create_group(self, nodes) -> int Create a new group node, that will contain all the nodes in 'nodes'.
"bool"	delete_group (self, "int" group)
	delete_group(self, group) -> bool Delete a group node.
"bool"	change_group_visibility (self, "int" group, "bool" expand)
	change_group_visibility(self, group, expand) -> bool Expand/collapse a group node
"int"	nsucc (self, "int" b)
	nsucc(self, b) -> int
"int"	npred (self, "int" b)
	npred(self, b) -> int
"int"	succ (self, "int" b, "int" i)
	succ(self, b, i) -> int
"int"	pred (self, "int" b, "int" i)
	pred(self, b, i) -> int
"intvec_t const &"	succset (self, "int" b)
	succset(self, b) -> intvec_t const &
"intvec_t const &"	predset (self, "int" b)
	predset(self, b) -> intvec_t const &
"void"	reset (self)
	reset(self)
"bool"	redo_layout (self)
	redo_layout(self) -> bool Recompute the layout, according to the value of 'current_layout'.
"void"	resize (self, "int" n)
	resize(self, n) Resize the graph to 'n' nodes
"int"	add_node (self, "rect_t" r)
	add_node(self, r) -> int Add a node, possibly with a specific geometry
"ssize_t"	del_node (self, "int" n)
	del_node(self, n) -> ssize_t Delete a node
"bool"	add_edge (self, "int" i, "int" j, "edge_info_t" ei)
	add_edge(self, i, j, ei) -> bool
"bool"	del_edge (self, "int" i, "int" j)
	del_edge(self, i, j) -> bool
"bool"	replace_edge (self, "int" i, "int" j, "int" x, "int" y)
	replace_edge(self, i, j, x, y) -> bool
"bool"	refresh (self)
	refresh(self) -> bool Refresh the graph
"bool"	set_nrect (self, "int" n, "rect_t" r)
	set_nrect(self, n, r) -> bool
"bool"	set_edge (self, "edge_t" e, "edge_info_t" ei)
	set_edge(self, e, ei) -> bool
"bool"	create_digraph_layout (self)
	create_digraph_layout(self) -> bool
"void"	del_custom_layout (self)
	del_custom_layout(self)
"bool"	get_custom_layout (self)
	get_custom_layout(self) -> bool
"void"	set_custom_layout (self)
	set_custom_layout(self)
"bool"	get_graph_groups (self)
	get_graph_groups(self) -> bool
"void"	set_graph_groups (self)
	set_graph_groups(self)
"ea_t"	calc_group_ea (self, "intvec_t const &" arg2)
	calc_group_ea(self, arg2) -> ea_t
"bool"	is_user_graph (self)
	is_user_graph(self) -> bool
Public Member Functions inherited from drawable_graph_t
"bool"	create_tree_layout (self)
	create_tree_layout(self) -> bool
"bool"	create_circle_layout (self, "point_t" p, "int" radius)
	create_circle_layout(self, p, radius) -> bool
"void"	set_callback (self, "hook_cb_t *" _callback, "void *" _ud)
	set_callback(self, _callback, _ud)
"ssize_t"	grcall (self, "int" code)
	grcall(self, code) -> ssize_t
"edge_info_t *"	get_edge (self, "edge_t" e)
	get_edge(self, e) -> edge_info_t
"rect_t"	nrect (self, "int" n)
	nrect(self, n) -> rect_t
	__disown__ (self)
Public Member Functions inherited from gdl_graph_t
"char *"	get_node_label (self, "int" n)
	get_node_label(self, n) -> char *
"void"	print_graph_attributes (self, "FILE *" fp)
	print_graph_attributes(self, fp)
"bool"	print_node (self, "FILE *" fp, "int" n)
	print_node(self, fp, n) -> bool
"bool"	print_edge (self, "FILE *" fp, "int" i, "int" j)
	print_edge(self, fp, i, j) -> bool
"void"	print_node_attributes (self, "FILE *" fp, "int" n)
	print_node_attributes(self, fp, n)
"int"	entry (self)
	entry(self) -> int
"int"	exit (self)
	exit(self) -> int
"bgcolor_t"	get_node_color (self, "int" n)
	get_node_color(self, n) -> bgcolor_t
"bgcolor_t"	get_edge_color (self, "int" i, "int" j)
	get_edge_color(self, i, j) -> bgcolor_t
"size_t"	nedge (self, "int" node, "bool" ispred)
	nedge(self, node, ispred) -> size_t
"int"	edge (self, "int" node, "int" i, "bool" ispred)
	edge(self, node, i, ispred) -> int
"int"	front (self)
	front(self) -> int
"node_iterator"	begin (self)
	begin(self) -> node_iterator
"node_iterator"	end (self)
	end(self) -> node_iterator

Static Public Attributes
str	gid = property(_ida_graph.interactive_graph_t_gid_get, _ida_graph.interactive_graph_t_gid_set, doc=)
str	belongs = property(_ida_graph.interactive_graph_t_belongs_get, _ida_graph.interactive_graph_t_belongs_set, doc=)
str	node_flags = property(_ida_graph.interactive_graph_t_node_flags_get, _ida_graph.interactive_graph_t_node_flags_set, doc=)
str	org_succs = property(_ida_graph.interactive_graph_t_org_succs_get, _ida_graph.interactive_graph_t_org_succs_set, doc=)
str	org_preds = property(_ida_graph.interactive_graph_t_org_preds_get, _ida_graph.interactive_graph_t_org_preds_set, doc=)
str	succs = property(_ida_graph.interactive_graph_t_succs_get, _ida_graph.interactive_graph_t_succs_set, doc=)
str	preds = property(_ida_graph.interactive_graph_t_preds_get, _ida_graph.interactive_graph_t_preds_set, doc=)
str	nodes = property(_ida_graph.interactive_graph_t_nodes_get, _ida_graph.interactive_graph_t_nodes_set, doc=)
str	edges = property(_ida_graph.interactive_graph_t_edges_get, _ida_graph.interactive_graph_t_edges_set, doc=)
Static Public Attributes inherited from drawable_graph_t
str	title = property(_ida_graph.drawable_graph_t_title_get, _ida_graph.drawable_graph_t_title_set, doc=)
str	rect_edges_made = property(_ida_graph.drawable_graph_t_rect_edges_made_get, _ida_graph.drawable_graph_t_rect_edges_made_set, doc=)
str	current_layout = property(_ida_graph.drawable_graph_t_current_layout_get, _ida_graph.drawable_graph_t_current_layout_set, doc=)
str	circle_center = property(_ida_graph.drawable_graph_t_circle_center_get, _ida_graph.drawable_graph_t_circle_center_set, doc=!)
str	circle_radius = property(_ida_graph.drawable_graph_t_circle_radius_get, _ida_graph.drawable_graph_t_circle_radius_set, doc=)
str	callback_ud = property(_ida_graph.drawable_graph_t_callback_ud_get, _ida_graph.drawable_graph_t_callback_ud_set, doc=)

Properties
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
Properties inherited from drawable_graph_t
	thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
Properties inherited from gdl_graph_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 )

Parameters

self	PyObject *

Reimplemented from drawable_graph_t.

Member Function Documentation

add_edge()

"bool" add_edge	(		self,
		"int"	i,
		"int"	j,
		"edge_info_t"	ei )

Parameters

i	int
j	int
ei	edge_info_t const *

add_node()

"int" add_node	(		self,
		"rect_t"	r )

Parameters

r	(C++: const rect_t *) the node geometry (can be nullptr)

Returns

: the new node

calc_group_ea()

"ea_t" calc_group_ea	(		self,
		"intvec_t const &"	arg2 )

Parameters

arg2	intvec_t const &

change_group_visibility()

"bool" change_group_visibility	(		self,
		"int"	group,
		"bool"	expand )

Parameters

group	(C++: int) the group node
expand	(C++: bool) whether to expand or collapse

Returns

: success

create_digraph_layout()

"bool" create_digraph_layout

(

self

)

create_group()

"int" create_group	(		self,
		"intvec_t const &"	nodes )

Parameters

nodes

(C++: const intvec_t &) the nodes that will be part of the group

Returns

: the group node, or -1 in case of error

del_custom_layout()

"void" del_custom_layout

(

self

)

del_edge()

"bool" del_edge	(		self,
		"int"	i,
		"int"	j )

Parameters

i	int
j	int

del_node()

"ssize_t" del_node	(		self,
		"int"	n )

Parameters

n	(C++: int) the node to delete

Returns

: the number of deleted edges

delete_group()

"bool" delete_group	(		self,
		"int"	group )

This deletes the group node only; it does not delete nodes that are part of the group.

Parameters

group

(C++: int) the group node

Returns

: success

empty()

"bool" empty

(

self

)

Returns

: true if there are no visible nodes

Reimplemented from gdl_graph_t.

exists()

"bool" exists	(		self,
		"int"	node )

Parameters

node	(C++: int) the node number

Returns

: success

Reimplemented from gdl_graph_t.

get_custom_layout()

"bool" get_custom_layout

(

self

)

get_first_subgraph_node()

"int" get_first_subgraph_node	(		self,
		"int"	group )

Parameters

group

int

get_graph_groups()

"bool" get_graph_groups

(

self

)

get_next_subgraph_node()

"int" get_next_subgraph_node	(		self,
		"int"	group,
		"int"	current )

Parameters

group	int
current	int

get_node_group()

"int" get_node_group	(		self,
		"int"	node )

Parameters

node

int

get_node_representative()

"int" get_node_representative	(		self,
		"int"	node )

This will find the "closest" parent group node that's visible, by attempting to walk up the group nodes that contain 'node', and will stop when it finds a node that is currently visible.

See also get_group_node()

Parameters

node	(C++: int) the node

Returns

: the node that represents 'node', or 'node' if it's not part of any group

is_collapsed_node()

"bool" is_collapsed_node	(		self,
		"int"	node )

Parameters

node

int

is_deleted_node()

"bool" is_deleted_node	(		self,
		"int"	node )

Parameters

node

int

is_displayable_node()

"bool" is_displayable_node	(		self,
		"int"	node )

Parameters

node

int

is_dot_node()

"bool" is_dot_node	(		self,
		"int"	node )

Parameters

node

int

is_group_node()

"bool" is_group_node	(		self,
		"int"	node )

Parameters

node

int

is_simple_node()

"bool" is_simple_node	(		self,
		"int"	node )

Parameters

node

int

is_subgraph_node()

"bool" is_subgraph_node	(		self,
		"int"	node )

Parameters

node

int

is_uncollapsed_node()

"bool" is_uncollapsed_node	(		self,
		"int"	node )

Parameters

node

int

is_user_graph()

"bool" is_user_graph

(

self

)

is_visible_node()

"bool" is_visible_node	(		self,
		"int"	node )

An invisible node is a node that's part of a group that's currently collapsed.

Parameters

node	(C++: int) the node

Returns

: success

node_qty()

"int" node_qty

(

self

)

See also size()

Returns

: the number of visible nodes

Reimplemented from gdl_graph_t.

npred()

"int" npred	(		self,
		"int"	b )

Parameters

b

int

Reimplemented from gdl_graph_t.

nsucc()

"int" nsucc	(		self,
		"int"	b )

Parameters

b

int

Reimplemented from gdl_graph_t.

pred()

"int" pred	(		self,
		"int"	b,
		"int"	i )

Parameters

b	int
i	int

Reimplemented from gdl_graph_t.

predset()

"intvec_t const &" predset	(		self,
		"int"	b )

Parameters

b

int

redo_layout()

"bool" redo_layout

(

self

)

Returns

: success

refresh()

"bool" refresh

(

self

)

A graph needs refreshing when it's "backing data". E.g., if the number (or contents) of the objects in the above example, change.

Let's say the user's plugin ends up finding a 5th piece of scattered data. It should then add it to its internal list of known objects, and tell IDA that the graph needs to be refreshed, using refresh_viewer(). This will cause IDA to:

• discard all its internal rendering information,
• call interactive_graph_t.refresh() on the graph so that the user's plugin has a chance to "sync" the number of nodes & edges that this graph contains, to the information that the plugin has collected so far
• re-create internal rendering information, and
• repaint the view

Returns

: success

replace_edge()

"bool" replace_edge	(		self,
		"int"	i,
		"int"	j,
		"int"	x,
		"int"	y )

Parameters

i	int
j	int
x	int
y	int

reset()

"void" reset

(

self

)

resize()

"void" resize	(		self,
		"int"	n )

Parameters

n	(C++: int) the new size

set_custom_layout()

"void" set_custom_layout

(

self

)

set_deleted_node()

"void" set_deleted_node	(		self,
		"int"	node )

Parameters

node

int

set_edge()

"bool" set_edge	(		self,
		"edge_t"	e,
		"edge_info_t"	ei )

Parameters

e	edge_t
ei	edge_info_t const *

set_graph_groups()

"void" set_graph_groups

(

self

)

set_node_group()

"void" set_node_group	(		self,
		"int"	node,
		"int"	group )

Parameters

node	int
group	int

set_nrect()

"bool" set_nrect	(		self,
		"int"	n,
		"rect_t"	r )

Parameters

n	int
r	rect_t const &

size()

"int" size

(

self

)

See also node_qty()

Returns

: the total number of nodes in the graph

Reimplemented from gdl_graph_t.

succ()

"int" succ	(		self,
		"int"	b,
		"int"	i )

Parameters

b	int
i	int

Reimplemented from gdl_graph_t.

succset()

"intvec_t const &" succset	(		self,
		"int"	b )

Parameters

b

int

Member Data Documentation

belongs

str belongs = property(_ida_graph.interactive_graph_t_belongs_get, _ida_graph.interactive_graph_t_belongs_set, doc=)

static

edges

str edges = property(_ida_graph.interactive_graph_t_edges_get, _ida_graph.interactive_graph_t_edges_set, doc=)

static

gid

str gid = property(_ida_graph.interactive_graph_t_gid_get, _ida_graph.interactive_graph_t_gid_set, doc=)

static

node_flags

str node_flags = property(_ida_graph.interactive_graph_t_node_flags_get, _ida_graph.interactive_graph_t_node_flags_set, doc=)

static

nodes

str nodes = property(_ida_graph.interactive_graph_t_nodes_get, _ida_graph.interactive_graph_t_nodes_set, doc=)

static

org_preds

str org_preds = property(_ida_graph.interactive_graph_t_org_preds_get, _ida_graph.interactive_graph_t_org_preds_set, doc=)

static

org_succs

str org_succs = property(_ida_graph.interactive_graph_t_org_succs_get, _ida_graph.interactive_graph_t_org_succs_set, doc=)

static

preds

str preds = property(_ida_graph.interactive_graph_t_preds_get, _ida_graph.interactive_graph_t_preds_set, doc=)

static

succs

str succs = property(_ida_graph.interactive_graph_t_succs_get, _ida_graph.interactive_graph_t_succs_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_graph.py