Function Entry: CLAL-NAV-FUNCTION

← Prev | ↑ Chapter | Next → | Index | Symbols

Function Entry: CLAL-NAV-FUNCTION

Name

clal-nav-function

Class

clautolisp Extension Function

Syntax

(clal-nav-function name)

Arguments and Values

  • name — a symbol or a string naming a global function.

Description

Enter the aldo debugger navigating the source form of the global function name (pre-debug navigation). This lets you observe a function and set breakpoints before it is ever called; the function is instrumented on demand. A no-op unless a debug session is active (it funcalls the runtime's debug-nav hook with (:function name)).

Return Values

Always nil.

Side Effects

When a debug session is active, navigates the debugger to the function's source and instruments it; otherwise none.

Affected By

  • Whether a debug session (aldo) is currently active.

Exceptional Situations

Signals :bad-argument when name is neither a symbol nor a string.

Examples

(clal-nav-function 'my-command)
(clal-nav-function "MY-COMMAND")
=> nil

Availability

  • clautolisp: documented (this entry); implemented since clautolisp 1.4.x.
  • AutoCAD: NOT present.
  • BricsCAD: NOT present.

Source Notes

  • clautolisp-only extension; pre-debug navigation is specified by the aldo debugger. See this chapter's Overview.