Next: , Up: Guile API


23.3.3.1 Basic Guile

At startup, gdb overrides Guile's current-output-port and current-error-port to print using gdb's output-paging streams. A Guile program which outputs to one of these streams may have its output interrupted by the user (see Screen Size). In this situation, a Guile signal exception is thrown with value SIGINT.

Guile's history mechanism uses the same naming as gdb's, namely the user of dollar-variables (e.g., $1, $2, etc.). The results of evaluations in Guile and in GDB are counted separately, $1 in Guile is not the same value as $1 in gdb.

gdb is not thread-safe. If your Guile program uses multiple threads, you must be careful to only call gdb-specific functions in the gdb thread.

Some care must be taken when writing Guile code to run in gdb. Two things are worth noting in particular:

gdb introduces a new Guile module, named gdb. All methods and classes added by gdb are placed in this module. gdb does not automatically import the gdb module, scripts must do this themselves. There are various options for how to import a module, so gdb leaves the choice of how the gdb module is imported to the user. To simplify interactive use, it is recommended to add one of the following to your ~/.gdbinit.

     guile (use-modules (gdb))
     guile (use-modules ((gdb) #:renamer (symbol-prefix-proc 'gdb:)))

Which one to choose depends on your preference. The second one adds gdb: as a prefix to all module functions and variables.

The rest of this manual assumes the gdb module has been imported without any prefix. See the Guile documentation for use-modules for more information (see Using Guile Modules).

Example:

     (gdb) guile (value-type (make-value 1))
     ERROR: Unbound variable: value-type
     Error while executing Scheme code.
     (gdb) guile (use-modules (gdb))
     (gdb) guile (value-type (make-value 1))
     int
     (gdb)

The (gdb) module provides these basic Guile functions.

— Scheme Procedure: execute command [#:from-tty boolean][#:to-string boolean]

Evaluate command, a string, as a gdb CLI command. If a gdb exception happens while command runs, it is translated as described in Guile Exception Handling.

from-tty specifies whether gdb ought to consider this command as having originated from the user invoking it interactively. It must be a boolean value. If omitted, it defaults to #f.

By default, any output produced by command is sent to gdb's standard output (and to the log output if logging is turned on). If the to-string parameter is #t, then output will be collected by gdb.execute and returned as a string. The default is #f, in which case the return value is unspecified. If to-string is #t, the gdb virtual terminal will be temporarily set to unlimited width and height, and its pagination will be disabled; see Screen Size.

— Scheme Procedure: history-ref number

Return a value from gdb's value history (see Value History). number indicates which history element to return. If number is negative, then gdb will take its absolute value and count backward from the last element (i.e., the most recent element) to find the value to return. If number is zero, then gdb will return the most recent element. If the element specified by number doesn't exist in the value history, a gdb:error exception will be raised.

If no exception is raised, the return value is always an instance of <gdb:value> (see Values From Inferior In Guile).

Note: gdb's value history is independent of Guile's. $1 in gdb's value history contains the result of evaluating an expression from gdb's command line and $1 from Guile's history contains the result of evaluating an expression from Guile's command line.

— Scheme Procedure: history-append! value

Append value, an instance of <gdb:value>, to gdb's value history. Return its index in the history.

Putting into history values returned by Guile extensions will allow the user convenient access to those values via CLI history facilities.

— Scheme Procedure: parse-and-eval expression

Parse expression as an expression in the current language, evaluate it, and return the result as a <gdb:value>. expression must be a string.

This function is useful when computing values. For example, it is the only way to get the value of a convenience variable (see Convenience Vars) as a <gdb:value>.

— Scheme Procedure: string->argv string

Convert a string to a list of strings split up according to gdb's argv parsing rules.