i

Debugger/Interpreter Interface

The module i provides short forms for some of
the functions used by the graphical Debugger and some of
the functions in the int module, the Erlang interpreter.

This module also provides facilities for displaying status
information about interpreted processes and break points.

It is possible to attach to interpreted processes by giving
the corresponding process identity only. By default, an attachment
window pops up. Processes at other Erlang nodes can be
attached manually or automatically.

By preference, these functions can be included in the module
shell_default. By default, they are.

im() -> pid()

Starts a new graphical monitor. This is the Monitor window,
the main window of the Debugger. All of the Debugger and
interpreter functionality is accessed from the Monitor window.
The Monitor window displays the status of all processes that
have been/are executing interpreted modules.

ii(AbsModules) -> ok

ii(AbsModule) -> {module, Module} | error

ini(AbsModules) -> ok

ini(AbsModule) -> {module, Module} | error

AbsModules = [AbsModule]

AbsModule = Module | File

Module = atom()

File = string()

Interprets the specified module(s). ii/1 interprets
the module(s) only at the current node, see
int:i/1. ini/1
interprets the module(s) at all known nodes, see
int:ni/1.

iq(AbsModule) -> ok

inq(AbsModule) -> ok

AbsModule = Module | File

Module = atom()

File = string()

Stops interpreting the specified module. iq/1 stops
interpreting the module only at the current node. inq/1
stops interpreting the module at all known nodes.

il() -> ok

Makes a printout of all interpreted modules.
Modules are printed together with the full path name of the
corresponding source code file.

ia(Pid, Function) -> ok | no_proc

ia(X,Y,Z, Function) -> ok | no_proc

X = Y = Z = int()

Function = {Module,Name}

Module = Name = atom()

Same as ia(Pid, Function), where Pid is
the result of calling the shell function pid(X,Y,Z).
An attached process is expected to call the unofficial
int:attached(Pid) function and to be able to handle
messages from the interpreter, see dbg_ui_trace.erl for
an example.

ib(Module, Line) -> ok | {error, break_exists}

Module = atom()

Line = int()

Creates a breakpoint at Line in Module.

ib(Module, Name, Arity) -> ok | {error, function_not_found}

Module = Name = atom()

Arity = int()

Creates breakpoints at the first line of every clause of
the Module:Name/Arity function.

ir() -> ok

Deletes all breakpoints.

ir(Module) -> ok

Module = atom()

Deletes all breakpoints in Module.

ir(Module, Line) -> ok

Module = atom()

Line = int()

Deletes the breakpoint located at Line in
Module.

ir(Module, Name, Arity) -> ok | {error, function_not_found}

Module = Name = atom()

Arity = int()

Deletes the breakpoints at the first line of every clause of
the Module:Name/Arity function.

ibd(Module, Line) -> ok

Module = atom()

Line = int()

Makes the breakpoint at Line in Module
inactive.

ibe(Module, Line) -> ok

Module = atom()

Line = int()

Makes the breakpoint at Line in Module active.

iba(Module, Line, Action) -> ok

Module = atom()

Line = int()

Action = enable | disable | delete

Sets the trigger action of the breakpoint at Line in
Module to Action.

ibc(Module, Line, Function) -> ok

Module = atom()

Line = int()

Function = {Module,Name}

Name = atom()

Sets the conditional test of the breakpoint at Line in
Module to Function.

The conditional test is performed by calling
Module:Name(Bindings), where Bindings is
the current variable bindings. The function must return
true (break) or false (do not break). Use
int:get_binding(Var, Bindings) to retrieve the value
of a variable Var.

ipb() -> ok

Makes a printout of all existing breakpoints.

ipb(Module) -> ok

Module = atom()

Makes a printout of all existing breakpoints in
Module.

iv() -> atom()

Returns the current version number of the interpreter.
The same as the version number of the Debugger application.

help() -> ok

Prints help text.

Usage

Refer to the Debugger User's Guide for information about
the Debugger.