i(3erl)

i(3erl) 🦋 — Debugger/Interpreter Interface 🎀

Manual-name drop: this page is from the Erlang Module Definition manual, bestie. And it's literally all about the i module being your debugger/interpreter shortcut bestie. ✨

🌸 NAME 🌸

i — Debugger/Interpreter Interface.

💖 DESCRIPTION 💖

Okay so the i module provides short forms for some of the functions used by the graphical Debugger and some of the functions in module int, the Erlang interpreter. It's giving convenience era, fr fr. 💅

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

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

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

✨ EXPORTS ✨

🌟 im() 🌟

im() -> pid()

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

🧚 ii/1 + ini/1 🧚

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

Types:

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. node-by-node tea ☕

🫧 iq/1 + inq/1 🫧

iq(AbsModule) -> ok
inq(AbsModule) -> ok

Types:

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. stop interpreting, but make it fashion 💅

🎀 il() 🎀

il() -> ok

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

🦋 ip() 🦋

ip() -> ok

Prints the current status of all interpreted processes. status check! ✅

🌸 ic() 🌸

ic() -> ok

Clears information about processes executing interpreted code by removing all information about terminated processes. cleanup era 🧹

💫 iaa(Flags) + iaa(Flags, Function) 💫

iaa(Flags) -> true
iaa(Flags, Function) -> true

Types:

Flags = [init | break | exit]
Function = {Module,Name,Args}
 Module = Name = atom()
 Args = [term()]

Sets when and how to attach to a debugged process automatically, see int:auto_attach/2. Function defaults to the standard function used by Debugger. auto-attach vibes ⚡

🧁 ist(Flag) 🧁

ist(Flag) -> true

Types:

Flag = all | no_tail | false

Sets how to save call frames in the stack, see int:stack_trace/1. stack frames, but make it intentional 🥞

🔥 ia(Pid) 🔥

ia(Pid) -> ok | no_proc

Types:

Pid = pid()

Attaches to the debugged process Pid. An Attach Process window is opened for the process. attach window moment 🪟

🌈 ia(X,Y,Z) 🌈

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

Types:

X = Y = Z = int()

Same as ia(Pid), where Pid is the result of calling the shell function pid(X,Y,Z). shell function shortcut slay 💅

🎀 ia(Pid, Function) 🎀

ia(Pid, Function) -> ok | no_proc

Types:

Pid = pid()
Function = {Module,Name}
 Module = Name = atom()

Attaches to the debugged process Pid. The interpreter calls spawn(Module, Name, [Pid]) (and ignores the result). spawn it and forget it 🚀

🦋 ia(X,Y,Z, Function) 🦋

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

Types:

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 function int:attached(Pid) and to be able to handle messages from the interpreter. For an example, see dbg_wx_trace.erl. unofficial function alert, iykyk 🚨

⭐ ib(Module, Line) ⭐

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

Types:

Module = atom()
Line = int()

Creates a breakpoint at Line in Module. breakpoint creation station 🛑✨

💜 ib(Module, Name, Arity) 💜

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

Types:

Module = Name = atom()
Arity = int()

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

🌟 ir() 🌟

ir() -> ok

Deletes all breakpoints. bye-bye breakpoints 💀

🫶 ir(Module) 🫶

ir(Module) -> ok

Types:

Module = atom()

Deletes all breakpoints in Module. module breakpoint cleanup 🧼

🎀 ir(Module, Line) 🎀

ir(Module, Line) -> ok

Types:

Module = atom()
Line = int()

Deletes the breakpoint at Line in Module. single breakpoint deletion realness 🗑️

🦋 ir(Module, Name, Arity) 🦋

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

Types:

Module = Name = atom()
Arity = int()

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

🌸 ibd(Module, Line) 🌸

ibd(Module, Line) -> ok

Types:

Module = atom()
Line = int()

Makes the breakpoint at Line in Module inactive. inactive breakpoint, not me 🙈

🧚 ibe(Module, Line) 🧚

ibe(Module, Line) -> ok

Types:

Module = atom()
Line = int()

Makes the breakpoint at Line in Module active. active again, periodt ✅

🔥 iba(Module, Line, Action) 🔥

iba(Module, Line, Action) -> ok

Types:

Module = atom()
Line = int()
Action = enable | disable | delete

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

💫 ibc(Module, Line, Function) 💫

ibc(Module, Line, Function) -> ok

Types:

Module = atom()
Line = int()
Function = {Module,Name}
 Name = atom()

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

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). To retrieve the value of a variable Var, use int:get_binding(Var, Bindings). bindings tea, no cap 🫖

🎀 ipb() 🎀

ipb() -> ok

Prints all existing breakpoints. breakpoint printout moment 🖨️

🦋 ipb(Module) 🦋

ipb(Module) -> ok

Types:

Module = atom()

Prints all existing breakpoints in Module. module-only breakpoint printout 🖨️✨

⭐ iv() ⭐

iv() -> atom()

Returns the current version number of the interpreter. Same as the version number of the Debugger application. version number check, slay 🔢

🫶 help() 🫶

help() -> ok

Prints help text. help text to the rescue 🆘

🔎 SEE ALSO 🔎

int(3erl) — that's the one, bestie. 🫶

---

🫶 Okay that's the whole manual, bestie! Source/version sign-off: Ericsson AB, debugger 5.3.1.2, i(3erl) — and the footer didn't print a date, so I'm not inventing one. 💖