Function Entry: CLAL-DEFINE-DEBUGGER-COMMAND

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

Function Entry: CLAL-DEFINE-DEBUGGER-COMMAND

Name

clal-define-debugger-command

Class

clautolisp Extension Function

Syntax

(clal-define-debugger-command names function [doc])

Arguments and Values

  • names — a list (key word …) of strings; the key must be the word initials (debugger command reference §0).
  • function — a function designator; the command body, applied to the command's parsed string arguments at dispatch.
  • doc — optional help string.

Description

Register an AutoLISP debugger command (command reference §8). It funcalls the runtime's define-command hook with the unwrapped name strings, the resolved function, and the doc string. A no-op (returns nil) unless the debugger UI is loaded.

DEPRECATED: the equivalent of (clal-define-command "ALDO" names function [doc]) — new code names the interactor with clal-define-command.

Return Values

Always nil.

Side Effects

When the debugger UI is loaded, adds a command to the debugger's command table; otherwise none.

Affected By

  • Whether the aldo debugger UI is loaded.

Exceptional Situations

Argument-type errors propagate from unwrapping names and resolving function; otherwise none.

Examples

(clal-define-debugger-command
  '("wa" "watch")
  (lambda (arg) (princ arg))
  "watch VAR — print VAR at each stop")
=> nil

Availability

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

Source Notes

  • clautolisp-only extension; the command protocol is specified by the aldo debugger command reference. See this chapter's Overview.