binaryninja.flowgraph.FlowGraph

class FlowGraph(handle=None)[source]

class FlowGraph implements a directed flow graph to be shown in the UI. This class allows plugins to create custom flow graphs and render them in the UI using the flow graph report API.

An example of creating a flow graph and presenting it in the UI:

>>> graph = FlowGraph()
>>> node_a = FlowGraphNode(graph)
>>> node_a.lines = ["Node A"]
>>> node_b = FlowGraphNode(graph)
>>> node_b.lines = ["Node B"]
>>> node_c = FlowGraphNode(graph)
>>> node_c.lines = ["Node C"]
>>> graph.append(node_a)
0
>>> graph.append(node_b)
1
>>> graph.append(node_c)
2
>>> node_a.add_outgoing_edge(BranchType.UnconditionalBranch, node_b)
>>> node_a.add_outgoing_edge(BranchType.UnconditionalBranch, node_c)
>>> show_graph_report("Custom Graph", graph)

Note

In the current implementation, only graphs that have a single start node where all other nodes are reachable from outgoing edges can be rendered correctly. This describes the natural limitations of a control flow graph, which is what the rendering logic was designed for. Graphs that have nodes that are only reachable from incoming edges, or graphs that have disjoint subgraphs will not render correctly. This will be fixed in a future version.

__init__(handle=None)[source]

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__([handle])

Initialize self.

append(node)

append adds a node to a flow graph.

complete_layout()

complete_layout can be overridden by subclasses and is called when a graph layout is completed.

finish_prepare_for_layout()

finish_prepare_for_layout signals that preparations for rendering a graph are complete.

get_nodes_in_region(left, top, right, bottom)

is_option_set(option)

layout([callback])

layout starts rendering a graph for display.

layout_and_wait()

layout_and_wait starts rendering a graph for display, and waits for the graph to be ready to display.

populate_nodes()

prepare_for_layout can be overridden by subclasses to create nodes in a graph when a flow graph needs to be rendered.

prepare_for_layout()

prepare_for_layout can be overridden by subclasses to handling preparations that must take place before a flow graph is rendered, such as waiting for a function to finish analysis.

set_option(option[, value])

show(title)

show displays the graph in a new tab in the UI.

update()

update can be overridden by subclasses to allow a graph to be updated after it has been presented in the UI.

Attributes

allows_inline_instruction_editing

Set if flow graph should allow inline instruction editing (assembly only)

allows_patching

Set if flow graph should allow modification of code from within the graph view

complete

Whether flow graph layout is complete (read-only)

function

Function for a flow graph

has_nodes

Whether the flow graph has at least one node (read-only)

height

Flow graph height (read-only)

horizontal_block_margin

il_function

includes_user_comments

Set if flow graph includes comments made by the user

is_il

is_low_level_il

is_medium_level_il

nodes

List of nodes in graph (read-only)

shows_secondary_reg_highlighting

Set if flow graph should highlight associated registers in the UI

uses_block_highlights

Set if flow graph uses the standard basic block highlighting settings

uses_instruction_highlights

Set if flow graph uses the standard instruction highlighting settings

vertical_block_margin

view

Binary view for a flow graph

width

Flow graph width (read-only)