lisp/gud.el

   1 ;;; gud.el --- Grand Unified Debugger mode for gdb, sdb, dbx, or xdb under Emacs
   2
   3 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
   4 ;; Maintainer: FSF
   5 ;; Keywords: unix, tools
   6
   7 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996 Free Software Foundation, Inc.
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;; The ancestral gdb.el was by W. Schelter <wfs@rascal.ics.utexas.edu>
  29 ;; It was later rewritten by rms.  Some ideas were due to Masanobu.
  30 ;; Grand Unification (sdb/dbx support) by Eric S. Raymond <esr@thyrsus.com>
  31 ;; The overloading code was then rewritten by Barry Warsaw <bwarsaw@cen.com>,
  32 ;; who also hacked the mode to use comint.el.  Shane Hartman <shane@spr.com>
  33 ;; added support for xdb (HPUX debugger).  Rick Sladkey <jrs@world.std.com>
  34 ;; wrote the GDB command completion code.  Dave Love <d.love@dl.ac.uk>
  35 ;; added the IRIX kluge, re-implemented the Mips-ish variant and added
  36 ;; a menu. Brian D. Carlstrom <bdc@ai.mit.edu> combined the IRIX kluge with
  37 ;; the gud-xdb-directories hack producing gud-dbx-directories.
  38
  39 ;;; Code:
  40
  41 (require 'comint)
  42 (require 'etags)
  43
  44 ;; ======================================================================
  45 ;; GUD commands must be visible in C buffers visited by GUD
  46
  47 (defvar gud-key-prefix "\C-x\C-a"
  48   "Prefix of all GUD commands valid in C buffers.")
  49
  50 (global-set-key (concat gud-key-prefix "\C-l") 'gud-refresh)
  51 (define-key ctl-x-map " " 'gud-break)   ;; backward compatibility hack
  52
  53 (defvar gud-marker-filter nil)
  54 (put 'gud-marker-filter 'permanent-local t)
  55 (defvar gud-find-file nil)
  56 (put 'gud-find-file 'permanent-local t)
  57
  58 (defun gud-marker-filter (&rest args)
  59   (apply gud-marker-filter args))
  60
  61 (defun gud-find-file (file)
  62   ;; Don't get confused by double slashes in the name that comes from GDB.
  63   (while (string-match "//+" file)
  64     (setq file (replace-match "/" t t file)))
  65   (funcall gud-find-file file))
  66
  67 ;; Keymap definitions for menu bar entries common to all debuggers and
  68 ;; slots for debugger-dependent ones in sensible places.  (Defined here
  69 ;; before use.)
  70 (defvar gud-menu-map (make-sparse-keymap "Gud") nil)
  71 (define-key gud-menu-map [refresh] '("Refresh" . gud-refresh))
  72 (define-key gud-menu-map [remove] '("Remove Breakpoint" . gud-remove))
  73 (define-key gud-menu-map [tbreak] nil)  ; gdb, sdb and xdb
  74 (define-key gud-menu-map [break] '("Set Breakpoint" . gud-break))
  75 (define-key gud-menu-map [up] nil)      ; gdb, dbx, and xdb
  76 (define-key gud-menu-map [down] nil)    ; gdb, dbx, and xdb
  77 (define-key gud-menu-map [print] '("Print Expression" . gud-print))
  78 (define-key gud-menu-map [finish] nil)  ; gdb or xdb
  79 (define-key gud-menu-map [stepi] '("Step Instruction" . gud-stepi))
  80 (define-key gud-menu-map [step] '("Step Line" . gud-step))
  81 (define-key gud-menu-map [next] '("Next Line" . gud-next))
  82 (define-key gud-menu-map [cont] '("Continue" . gud-cont))
  83 \f
  84 ;; ======================================================================
  85 ;; command definition
  86
  87 ;; This macro is used below to define some basic debugger interface commands.
  88 ;; Of course you may use `gud-def' with any other debugger command, including
  89 ;; user defined ones.
  90
  91 ;; A macro call like (gud-def FUNC NAME KEY DOC) expands to a form
  92 ;; which defines FUNC to send the command NAME to the debugger, gives
  93 ;; it the docstring DOC, and binds that function to KEY in the GUD
  94 ;; major mode.  The function is also bound in the global keymap with the
  95 ;; GUD prefix.
  96
  97 (defmacro gud-def (func cmd key &optional doc)
  98   "Define FUNC to be a command sending STR and bound to KEY, with
  99 optional doc string DOC.  Certain %-escapes in the string arguments
 100 are interpreted specially if present.  These are:
 101
 102   %f    name (without directory) of current source file.
 103   %d    directory of current source file.
 104   %l    number of current source line
 105   %e    text of the C lvalue or function-call expression surrounding point.
 106   %a    text of the hexadecimal address surrounding point
 107   %p    prefix argument to the command (if any) as a number
 108
 109   The `current' source file is the file of the current buffer (if
 110 we're in a C file) or the source file current at the last break or
 111 step (if we're in the GUD buffer).
 112   The `current' line is that of the current buffer (if we're in a
 113 source file) or the source line number at the last break or step (if
 114 we're in the GUD buffer)."
 115   (list 'progn
 116         (list 'defun func '(arg)
 117               (or doc "")
 118               '(interactive "p")
 119               (list 'gud-call cmd 'arg))
 120         (if key
 121             (list 'define-key
 122                   '(current-local-map)
 123                   (concat "\C-c" key)
 124                   (list 'quote func)))
 125         (if key
 126             (list 'global-set-key
 127                   (list 'concat 'gud-key-prefix key)
 128                   (list 'quote func)))))
 129
 130 ;; Where gud-display-frame should put the debugging arrow.  This is
 131 ;; set by the marker-filter, which scans the debugger's output for
 132 ;; indications of the current program counter.
 133 (defvar gud-last-frame nil)
 134
 135 ;; Used by gud-refresh, which should cause gud-display-frame to redisplay
 136 ;; the last frame, even if it's been called before and gud-last-frame has
 137 ;; been set to nil.
 138 (defvar gud-last-last-frame nil)
 139
 140 ;; All debugger-specific information is collected here.
 141 ;; Here's how it works, in case you ever need to add a debugger to the mode.
 142 ;;
 143 ;; Each entry must define the following at startup:
 144 ;;
 145 ;;<name>
 146 ;; comint-prompt-regexp
 147 ;; gud-<name>-massage-args
 148 ;; gud-<name>-marker-filter
 149 ;; gud-<name>-find-file
 150 ;;
 151 ;; The job of the massage-args method is to modify the given list of
 152 ;; debugger arguments before running the debugger.
 153 ;;
 154 ;; The job of the marker-filter method is to detect file/line markers in
 155 ;; strings and set the global gud-last-frame to indicate what display
 156 ;; action (if any) should be triggered by the marker.  Note that only
 157 ;; whatever the method *returns* is displayed in the buffer; thus, you
 158 ;; can filter the debugger's output, interpreting some and passing on
 159 ;; the rest.
 160 ;;
 161 ;; The job of the find-file method is to visit and return the buffer indicated
 162 ;; by the car of gud-tag-frame.  This may be a file name, a tag name, or
 163 ;; something else.  It would be good if it also copied the Gud menubar entry.
 164 \f
 165 ;; ======================================================================
 166 ;; gdb functions
 167
 168 ;;; History of argument lists passed to gdb.
 169 (defvar gud-gdb-history nil)
 170
 171 (defun gud-gdb-massage-args (file args)
 172   (cons "-fullname" args))
 173
 174 (defvar gud-gdb-marker-regexp
 175   (concat "\032\032\\([^" path-separator "\n]*\\)" path-separator
 176           "\\([0-9]*\\)" path-separator ".*\n"))
 177
 178 ;; There's no guarantee that Emacs will hand the filter the entire
 179 ;; marker at once; it could be broken up across several strings.  We
 180 ;; might even receive a big chunk with several markers in it.  If we
 181 ;; receive a chunk of text which looks like it might contain the
 182 ;; beginning of a marker, we save it here between calls to the
 183 ;; filter.
 184 (defvar gud-marker-acc "")
 185 (make-variable-buffer-local 'gud-marker-acc)
 186
 187 (defun gud-gdb-marker-filter (string)
 188   (setq gud-marker-acc (concat gud-marker-acc string))
 189   (let ((output ""))
 190
 191     ;; Process all the complete markers in this chunk.
 192     (while (string-match gud-gdb-marker-regexp gud-marker-acc)
 193       (setq
 194
 195        ;; Extract the frame position from the marker.
 196        gud-last-frame
 197        (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
 198              (string-to-int (substring gud-marker-acc
 199                                        (match-beginning 2)
 200                                        (match-end 2))))
 201
 202        ;; Append any text before the marker to the output we're going
 203        ;; to return - we don't include the marker in this text.
 204        output (concat output
 205                       (substring gud-marker-acc 0 (match-beginning 0)))
 206
 207        ;; Set the accumulator to the remaining text.
 208        gud-marker-acc (substring gud-marker-acc (match-end 0))))
 209
 210     ;; Does the remaining text look like it might end with the
 211     ;; beginning of another marker?  If it does, then keep it in
 212     ;; gud-marker-acc until we receive the rest of it.  Since we
 213     ;; know the full marker regexp above failed, it's pretty simple to
 214     ;; test for marker starts.
 215     (if (string-match "\032.*\\'" gud-marker-acc)
 216         (progn
 217           ;; Everything before the potential marker start can be output.
 218           (setq output (concat output (substring gud-marker-acc
 219                                                  0 (match-beginning 0))))
 220
 221           ;; Everything after, we save, to combine with later input.
 222           (setq gud-marker-acc
 223                 (substring gud-marker-acc (match-beginning 0))))
 224
 225       (setq output (concat output gud-marker-acc)
 226             gud-marker-acc ""))
 227
 228     output))
 229
 230 (defun gud-new-keymap (map)
 231   "Return a new keymap which inherits from MAP and has name `Gud'."
 232   (nconc (make-sparse-keymap "Gud") map))
 233
 234 (defun gud-make-debug-menu ()
 235   "Make sure the current local map has a [menu-bar debug] submap.
 236 If it doesn't, replace it with a new map that inherits it,
 237 and create such a submap in that new map."
 238   (if (and (current-local-map)
 239            (lookup-key (current-local-map) [menu-bar debug]))
 240       nil
 241     (use-local-map (gud-new-keymap (current-local-map)))
 242     (define-key (current-local-map) [menu-bar debug]
 243       (cons "Gud" (gud-new-keymap gud-menu-map)))))
 244
 245 (defun gud-gdb-find-file (f)
 246   (save-excursion
 247     (let ((buf (find-file-noselect f)))
 248       (set-buffer buf)
 249       (gud-make-debug-menu)
 250       (local-set-key [menu-bar debug tbreak]
 251                      '("Temporary Breakpoint" . gud-tbreak))
 252       (local-set-key [menu-bar debug finish] '("Finish Function" . gud-finish))
 253       (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
 254       (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
 255       buf)))
 256
 257 (defvar gdb-minibuffer-local-map nil
 258   "Keymap for minibuffer prompting of gdb startup command.")
 259 (if gdb-minibuffer-local-map
 260     ()
 261   (setq gdb-minibuffer-local-map (copy-keymap minibuffer-local-map))
 262   (define-key
 263     gdb-minibuffer-local-map "\C-i" 'comint-dynamic-complete-filename))
 264
 265 ;;;###autoload
 266 (defun gdb (command-line)
 267   "Run gdb on program FILE in buffer *gud-FILE*.
 268 The directory containing FILE becomes the initial working directory
 269 and source-file directory for your debugger."
 270   (interactive
 271    (list (read-from-minibuffer "Run gdb (like this): "
 272                                (if (consp gud-gdb-history)
 273                                    (car gud-gdb-history)
 274                                  "gdb ")
 275                                gdb-minibuffer-local-map nil
 276                                '(gud-gdb-history . 1))))
 277
 278   (gud-common-init command-line 'gud-gdb-massage-args
 279                    'gud-gdb-marker-filter 'gud-gdb-find-file)
 280
 281   (gud-def gud-break  "break %f:%l"  "\C-b" "Set breakpoint at current line.")
 282   (gud-def gud-tbreak "tbreak %f:%l" "\C-t" "Set temporary breakpoint at current line.")
 283   (gud-def gud-remove "clear %f:%l"  "\C-d" "Remove breakpoint at current line")
 284   (gud-def gud-step   "step %p"      "\C-s" "Step one source line with display.")
 285   (gud-def gud-stepi  "stepi %p"     "\C-i" "Step one instruction with display.")
 286   (gud-def gud-next   "next %p"      "\C-n" "Step one line (skip functions).")
 287   (gud-def gud-cont   "cont"         "\C-r" "Continue with display.")
 288   (gud-def gud-finish "finish"       "\C-f" "Finish executing current function.")
 289   (gud-def gud-up     "up %p"        "<" "Up N stack frames (numeric arg).")
 290   (gud-def gud-down   "down %p"      ">" "Down N stack frames (numeric arg).")
 291   (gud-def gud-print  "print %e"     "\C-p" "Evaluate C expression at point.")
 292
 293   (local-set-key "\C-i" 'gud-gdb-complete-command)
 294   (local-set-key [menu-bar debug tbreak] '("Temporary Breakpoint" . gud-tbreak))
 295   (local-set-key [menu-bar debug finish] '("Finish Function" . gud-finish))
 296   (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
 297   (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
 298   (setq comint-prompt-regexp "^(.*gdb[+]?) *")
 299   (setq paragraph-start comint-prompt-regexp)
 300   (run-hooks 'gdb-mode-hook)
 301   )
 302
 303 ;; One of the nice features of GDB is its impressive support for
 304 ;; context-sensitive command completion.  We preserve that feature
 305 ;; in the GUD buffer by using a GDB command designed just for Emacs.
 306
 307 ;; The completion process filter indicates when it is finished.
 308 (defvar gud-gdb-complete-in-progress)
 309
 310 ;; Since output may arrive in fragments we accumulate partials strings here.
 311 (defvar gud-gdb-complete-string)
 312
 313 ;; We need to know how much of the completion to chop off.
 314 (defvar gud-gdb-complete-break)
 315
 316 ;; The completion list is constructed by the process filter.
 317 (defvar gud-gdb-complete-list)
 318
 319 (defvar gud-comint-buffer nil)
 320
 321 (defun gud-gdb-complete-command ()
 322   "Perform completion on the GDB command preceding point.
 323 This is implemented using the GDB `complete' command which isn't
 324 available with older versions of GDB."
 325   (interactive)
 326   (let* ((end (point))
 327          (command (save-excursion
 328                     (beginning-of-line)
 329                     (and (looking-at comint-prompt-regexp)
 330                          (goto-char (match-end 0)))
 331                     (buffer-substring (point) end)))
 332          command-word)
 333     ;; Find the word break.  This match will always succeed.
 334     (string-match "\\(\\`\\| \\)\\([^ ]*\\)\\'" command)
 335     (setq gud-gdb-complete-break (match-beginning 2)
 336           command-word (substring command gud-gdb-complete-break))
 337     ;; Temporarily install our filter function.
 338     (let ((gud-marker-filter 'gud-gdb-complete-filter))
 339       ;; Issue the command to GDB.
 340       (gud-basic-call (concat "complete " command))
 341       (setq gud-gdb-complete-in-progress t
 342             gud-gdb-complete-string nil
 343             gud-gdb-complete-list nil)
 344       ;; Slurp the output.
 345       (while gud-gdb-complete-in-progress
 346         (accept-process-output (get-buffer-process gud-comint-buffer))))
 347     ;; Protect against old versions of GDB.
 348     (and gud-gdb-complete-list
 349          (string-match "^Undefined command: \"complete\""
 350                        (car gud-gdb-complete-list))
 351          (error "This version of GDB doesn't support the `complete' command."))
 352     ;; Sort the list like readline.
 353     (setq gud-gdb-complete-list
 354           (sort gud-gdb-complete-list (function string-lessp)))
 355     ;; Remove duplicates.
 356     (let ((first gud-gdb-complete-list)
 357           (second (cdr gud-gdb-complete-list)))
 358       (while second
 359         (if (string-equal (car first) (car second))
 360             (setcdr first (setq second (cdr second)))
 361           (setq first second
 362                 second (cdr second)))))
 363     ;; Add a trailing single quote if there is a unique completion
 364     ;; and it contains an odd number of unquoted single quotes.
 365     (and (= (length gud-gdb-complete-list) 1)
 366          (let ((str (car gud-gdb-complete-list))
 367                (pos 0)
 368                (count 0))
 369            (while (string-match "\\([^'\\]\\|\\\\'\\)*'" str pos)
 370              (setq count (1+ count)
 371                    pos (match-end 0)))
 372            (and (= (mod count 2) 1)
 373                 (setq gud-gdb-complete-list (list (concat str "'"))))))
 374     ;; Let comint handle the rest.
 375     (comint-dynamic-simple-complete command-word gud-gdb-complete-list)))
 376
 377 ;; The completion process filter is installed temporarily to slurp the
 378 ;; output of GDB up to the next prompt and build the completion list.
 379 (defun gud-gdb-complete-filter (string)
 380   (setq string (concat gud-gdb-complete-string string))
 381   (while (string-match "\n" string)
 382     (setq gud-gdb-complete-list
 383           (cons (substring string gud-gdb-complete-break (match-beginning 0))
 384                 gud-gdb-complete-list))
 385     (setq string (substring string (match-end 0))))
 386   (if (string-match comint-prompt-regexp string)
 387       (progn
 388         (setq gud-gdb-complete-in-progress nil)
 389         string)
 390     (progn
 391       (setq gud-gdb-complete-string string)
 392       "")))
 393
 394 \f
 395 ;; ======================================================================
 396 ;; sdb functions
 397
 398 ;;; History of argument lists passed to sdb.
 399 (defvar gud-sdb-history nil)
 400
 401 (defvar gud-sdb-needs-tags (not (file-exists-p "/var"))
 402   "If nil, we're on a System V Release 4 and don't need the tags hack.")
 403
 404 (defvar gud-sdb-lastfile nil)
 405
 406 (defun gud-sdb-massage-args (file args) args)
 407
 408 (defun gud-sdb-marker-filter (string)
 409   (setq gud-marker-acc
 410         (if gud-marker-acc (concat gud-marker-acc string) string))
 411   (let (start)
 412     ;; Process all complete markers in this chunk
 413     (while
 414         (cond
 415          ;; System V Release 3.2 uses this format
 416          ((string-match "\\(^\\|\n\\)\\*?\\(0x\\w* in \\)?\\([^:\n]*\\):\\([0-9]*\\):.*\n"
 417                         gud-marker-acc start)
 418           (setq gud-last-frame
 419                 (cons
 420                  (substring gud-marker-acc (match-beginning 3) (match-end 3))
 421                  (string-to-int
 422                   (substring gud-marker-acc (match-beginning 4) (match-end 4))))))
 423          ;; System V Release 4.0 quite often clumps two lines together
 424          ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n\\([0-9]+\\):"
 425                         gud-marker-acc start)
 426           (setq gud-sdb-lastfile
 427                 (substring gud-marker-acc (match-beginning 2) (match-end 2)))
 428           (setq gud-last-frame
 429                 (cons
 430                  gud-sdb-lastfile
 431                  (string-to-int
 432                   (substring gud-marker-acc (match-beginning 3) (match-end 3))))))
 433          ;; System V Release 4.0
 434          ((string-match "^\\(BREAKPOINT\\|STEPPED\\) process [0-9]+ function [^ ]+ in \\(.+\\)\n"
 435                         gud-marker-acc start)
 436           (setq gud-sdb-lastfile
 437                 (substring gud-marker-acc (match-beginning 2) (match-end 2))))
 438          ((and gud-sdb-lastfile (string-match "^\\([0-9]+\\):"
 439                                               gud-marker-acc start))
 440                (setq gud-last-frame
 441                      (cons
 442                       gud-sdb-lastfile
 443                       (string-to-int
 444                        (substring gud-marker-acc (match-beginning 1) (match-end 1))))))
 445          (t
 446           (setq gud-sdb-lastfile nil)))
 447       (setq start (match-end 0)))
 448
 449     ;; Search for the last incomplete line in this chunk
 450     (while (string-match "\n" gud-marker-acc start)
 451       (setq start (match-end 0)))
 452
 453     ;; If we have an incomplete line, store it in gud-marker-acc.
 454     (setq gud-marker-acc (substring gud-marker-acc (or start 0))))
 455   string)
 456
 457 (defun gud-sdb-find-file (f)
 458   (save-excursion
 459     (let ((buf (if gud-sdb-needs-tags
 460                    (find-tag-noselect f)
 461                  (find-file-noselect f))))
 462       (set-buffer buf)
 463       (gud-make-debug-menu)
 464       (local-set-key [menu-bar debug tbreak] '("Temporary Breakpoint" . gud-tbreak))
 465       buf)))
 466
 467 ;;;###autoload
 468 (defun sdb (command-line)
 469   "Run sdb on program FILE in buffer *gud-FILE*.
 470 The directory containing FILE becomes the initial working directory
 471 and source-file directory for your debugger."
 472   (interactive
 473    (list (read-from-minibuffer "Run sdb (like this): "
 474                                (if (consp gud-sdb-history)
 475                                    (car gud-sdb-history)
 476                                  "sdb ")
 477                                nil nil
 478                                '(gud-sdb-history . 1))))
 479   (if (and gud-sdb-needs-tags
 480            (not (and (boundp 'tags-file-name)
 481                      (stringp tags-file-name)
 482                      (file-exists-p tags-file-name))))
 483       (error "The sdb support requires a valid tags table to work."))
 484
 485   (gud-common-init command-line 'gud-sdb-massage-args
 486                    'gud-sdb-marker-filter 'gud-sdb-find-file)
 487
 488   (gud-def gud-break  "%l b" "\C-b"   "Set breakpoint at current line.")
 489   (gud-def gud-tbreak "%l c" "\C-t"   "Set temporary breakpoint at current line.")
 490   (gud-def gud-remove "%l d" "\C-d"   "Remove breakpoint at current line")
 491   (gud-def gud-step   "s %p" "\C-s"   "Step one source line with display.")
 492   (gud-def gud-stepi  "i %p" "\C-i"   "Step one instruction with display.")
 493   (gud-def gud-next   "S %p" "\C-n"   "Step one line (skip functions).")
 494   (gud-def gud-cont   "c"    "\C-r"   "Continue with display.")
 495   (gud-def gud-print  "%e/"  "\C-p"   "Evaluate C expression at point.")
 496
 497   (setq comint-prompt-regexp  "\\(^\\|\n\\)\\*")
 498   (setq paragraph-start comint-prompt-regexp)
 499   (local-set-key [menu-bar debug tbreak]
 500     '("Temporary Breakpoint" . gud-tbreak))
 501   (run-hooks 'sdb-mode-hook)
 502   )
 503 \f
 504 ;; ======================================================================
 505 ;; dbx functions
 506
 507 ;;; History of argument lists passed to dbx.
 508 (defvar gud-dbx-history nil)
 509
 510 (defvar gud-dbx-directories nil
 511   "*A list of directories that dbx should search for source code.
 512 If nil, only source files in the program directory
 513 will be known to dbx.
 514
 515 The file names should be absolute, or relative to the directory
 516 containing the executable being debugged.")
 517
 518 (defun gud-dbx-massage-args (file args)
 519   (nconc (let ((directories gud-dbx-directories)
 520                (result nil))
 521            (while directories
 522              (setq result (cons (car directories) (cons "-I" result)))
 523              (setq directories (cdr directories)))
 524            (nreverse result))
 525          args))
 526
 527 (defun gud-dbx-file-name (f)
 528   "Transform a relative file name to an absolute file name, for dbx."
 529   (let ((result nil))
 530     (if (file-exists-p f)
 531         (setq result (expand-file-name f))
 532       (let ((directories gud-dbx-directories))
 533         (while directories
 534           (let ((path (concat (car directories) "/" f)))
 535             (if (file-exists-p path)
 536                 (setq result (expand-file-name path)
 537                       directories nil)))
 538           (setq directories (cdr directories)))))
 539     result))
 540
 541 (defun gud-dbx-marker-filter (string)
 542   (setq gud-marker-acc (if gud-marker-acc (concat gud-marker-acc string) string))
 543
 544   (let (start)
 545     ;; Process all complete markers in this chunk.
 546     (while (or (string-match
 547                 "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
 548                 gud-marker-acc start)
 549                (string-match
 550                 "signal .* in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
 551                 gud-marker-acc start))
 552       (setq gud-last-frame
 553             (cons
 554              (substring gud-marker-acc (match-beginning 2) (match-end 2))
 555              (string-to-int
 556               (substring gud-marker-acc (match-beginning 1) (match-end 1))))
 557             start (match-end 0)))
 558
 559     ;; Search for the last incomplete line in this chunk
 560     (while (string-match "\n" gud-marker-acc start)
 561       (setq start (match-end 0)))
 562
 563     ;; If the incomplete line APPEARS to begin with another marker, keep it
 564     ;; in the accumulator.  Otherwise, clear the accumulator to avoid an
 565     ;; unnecessary concat during the next call.
 566     (setq gud-marker-acc
 567           (if (string-match "\\(stopped\\|signal\\)" gud-marker-acc start)
 568               (substring gud-marker-acc (match-beginning 0))
 569             nil)))
 570   string)
 571
 572 ;; Functions for Mips-style dbx.  Given the option `-emacs', documented in
 573 ;; OSF1, not necessarily elsewhere, it produces markers similar to gdb's.
 574 (defvar gud-mips-p
 575   (or (string-match "^mips-[^-]*-ultrix" system-configuration)
 576       ;; We haven't tested gud on this system:
 577       (string-match "^mips-[^-]*-riscos" system-configuration)
 578       ;; It's documented on OSF/1.3
 579       (string-match "^mips-[^-]*-osf1" system-configuration)
 580       (string-match "^alpha-[^-]*-osf" system-configuration))
 581   "Non-nil to assume the MIPS/OSF dbx conventions (argument `-emacs').")
 582
 583 (defun gud-mipsdbx-massage-args (file args)
 584   (cons "-emacs" args))
 585
 586 ;; This is just like the gdb one except for the regexps since we need to cope
 587 ;; with an optional breakpoint number in [] before the ^Z^Z
 588 (defun gud-mipsdbx-marker-filter (string)
 589   (setq gud-marker-acc (concat gud-marker-acc string))
 590   (let ((output ""))
 591
 592     ;; Process all the complete markers in this chunk.
 593     (while (string-match
 594             ;; This is like th gdb marker but with an optional
 595             ;; leading break point number like `[1] '
 596             "[][ 0-9]*\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
 597             gud-marker-acc)
 598       (setq
 599
 600        ;; Extract the frame position from the marker.
 601        gud-last-frame
 602        (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
 603              (string-to-int (substring gud-marker-acc
 604                                        (match-beginning 2)
 605                                        (match-end 2))))
 606
 607        ;; Append any text before the marker to the output we're going
 608        ;; to return - we don't include the marker in this text.
 609        output (concat output
 610                       (substring gud-marker-acc 0 (match-beginning 0)))
 611
 612        ;; Set the accumulator to the remaining text.
 613        gud-marker-acc (substring gud-marker-acc (match-end 0))))
 614
 615     ;; Does the remaining text look like it might end with the
 616     ;; beginning of another marker?  If it does, then keep it in
 617     ;; gud-marker-acc until we receive the rest of it.  Since we
 618     ;; know the full marker regexp above failed, it's pretty simple to
 619     ;; test for marker starts.
 620     (if (string-match "[][ 0-9]*\032.*\\'" gud-marker-acc)
 621         (progn
 622           ;; Everything before the potential marker start can be output.
 623           (setq output (concat output (substring gud-marker-acc
 624                                                  0 (match-beginning 0))))
 625
 626           ;; Everything after, we save, to combine with later input.
 627           (setq gud-marker-acc
 628                 (substring gud-marker-acc (match-beginning 0))))
 629
 630       (setq output (concat output gud-marker-acc)
 631             gud-marker-acc ""))
 632
 633     output))
 634
 635 ;; The dbx in IRIX is a pain.  It doesn't print the file name when
 636 ;; stopping at a breakpoint (but you do get it from the `up' and
 637 ;; `down' commands...).  The only way to extract the information seems
 638 ;; to be with a `file' command, although the current line number is
 639 ;; available in $curline.  Thus we have to look for output which
 640 ;; appears to indicate a breakpoint.  Then we prod the dbx sub-process
 641 ;; to output the information we want with a combination of the
 642 ;; `printf' and `file' commands as a pseudo marker which we can
 643 ;; recognise next time through the marker-filter.  This would be like
 644 ;; the gdb marker but you can't get the file name without a newline...
 645 ;; Note that gud-remove won't work since Irix dbx expects a breakpoint
 646 ;; number rather than a line number etc.  Maybe this could be made to
 647 ;; work by listing all the breakpoints and picking the one(s) with the
 648 ;; correct line number, but life's too short.
 649 ;;   d.love@dl.ac.uk (Dave Love) can be blamed for this
 650
 651 (defvar gud-irix-p
 652   (and (string-match "^mips-[^-]*-irix" system-configuration)
 653        (not (string-match "irix[6-9]\\.[1-9]" system-configuration)))
 654   "Non-nil to assume the interface appropriate for IRIX dbx.
 655 This works in IRIX 4, 5 and 6, but `gud-dbx-use-stopformat-p' provides
 656 a better solution in 6.1 upwards.")
 657 (defvar gud-dbx-use-stopformat-p
 658   (string-match "irix[6-9]\\.[1-9]" system-configuration)
 659   "Non-nil to use the dbx feature present at least from Irix 6.1
 660   whereby $stopformat=1 produces an output format compatiable with
 661   `gud-dbx-marker-filter'.")
 662 ;; [Irix dbx seems to be a moving target.  The dbx output changed
 663 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
 664 ;; the output from `up' is no longer spotted by gud (and it's probably
 665 ;; not distinctive enough to try to match it -- use C-<, C->
 666 ;; exclusively) .  For 5.3 and 6.0, the $curline variable changed to
 667 ;; `long long'(why?!), so the printf stuff needed changing.  The line
 668 ;; number was cast to `long' as a compromise between the new `long
 669 ;; long' and the original `int'.  This is reported not to work in 6.2,
 670 ;; so it's changed back to int -- don't make your sources too long.
 671 ;; From Irix6.1 (but not 6.0?) dbx supports an undocumented feature
 672 ;; whereby `set $stopformat=1' reportedly produces output compatible
 673 ;; with `gud-dbx-marker-filter', which we prefer.
 674
 675 ;; The process filter is also somewhat
 676 ;; unreliable, sometimes not spotting the markers; I don't know
 677 ;; whether there's anything that can be done about that.  It would be
 678 ;; much better if SGI could be persuaded to (re?)instate the MIPS
 679 ;; -emacs flag for gdb-like output (which ought to be possible as most
 680 ;; of the communication I've had over it has been from sgi.com).]
 681
 682 ;; this filter is influenced by the xdb one rather than the gdb one
 683 (defun gud-irixdbx-marker-filter (string)
 684   (let (result (case-fold-search nil))
 685     (if (or (string-match comint-prompt-regexp string)
 686             (string-match ".*\012" string))
 687         (setq result (concat gud-marker-acc string)
 688               gud-marker-acc "")
 689       (setq gud-marker-acc (concat gud-marker-acc string)))
 690     (if result
 691         (cond
 692          ;; look for breakpoint or signal indication e.g.:
 693          ;; [2] Process  1267 (pplot) stopped at [params:338 ,0x400ec0]
 694          ;; Process  1281 (pplot) stopped at [params:339 ,0x400ec8]
 695          ;; Process  1270 (pplot) Floating point exception [._read._read:16 ,0x452188]
 696          ((string-match
 697            "^\\(\\[[0-9]+] \\)?Process +[0-9]+ ([^)]*) [^[]+\\[[^]\n]*]\n"
 698            result)
 699           ;; prod dbx into printing out the line number and file
 700           ;; name in a form we can grok as below
 701           (process-send-string (get-buffer-process gud-comint-buffer)
 702                                "printf \"\032\032%1d:\",(int)$curline;file\n"))
 703          ;; look for result of, say, "up" e.g.:
 704          ;; .pplot.pplot(0x800) ["src/pplot.f":261, 0x400c7c]
 705          ;; (this will also catch one of the lines printed by "where")
 706          ((string-match
 707            "^[^ ][^[]*\\[\"\\([^\"]+\\)\":\\([0-9]+\\), [^]]+]\n"
 708            result)
 709           (let ((file (substring result (match-beginning 1)
 710                                  (match-end 1))))
 711             (if (file-exists-p file)
 712                 (setq gud-last-frame
 713                       (cons
 714                        (substring
 715                         result (match-beginning 1) (match-end 1))
 716                        (string-to-int
 717                         (substring
 718                          result (match-beginning 2) (match-end 2)))))))
 719           result)
 720          ((string-match                 ; kluged-up marker as above
 721            "\032\032\\([0-9]*\\):\\(.*\\)\n" result)
 722           (let ((file (gud-dbx-file-name
 723                        (substring result (match-beginning 2) (match-end 2)))))
 724             (if (and file (file-exists-p file))
 725                 (setq gud-last-frame
 726                       (cons
 727                        file
 728                        (string-to-int
 729                         (substring
 730                          result (match-beginning 1) (match-end 1)))))))
 731           (setq result (substring result 0 (match-beginning 0))))))
 732     (or result "")))
 733
 734 (defun gud-dbx-find-file (f)
 735   (save-excursion
 736     (let ((realf (gud-dbx-file-name f)))
 737       (if realf
 738           (let ((buf (find-file-noselect realf)))
 739             (set-buffer buf)
 740             (gud-make-debug-menu)
 741             (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
 742             (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
 743             buf)
 744         nil))))
 745
 746 ;;;###autoload
 747 (defun dbx (command-line)
 748   "Run dbx on program FILE in buffer *gud-FILE*.
 749 The directory containing FILE becomes the initial working directory
 750 and source-file directory for your debugger."
 751   (interactive
 752    (list (read-from-minibuffer "Run dbx (like this): "
 753                                (if (consp gud-dbx-history)
 754                                    (car gud-dbx-history)
 755                                  "dbx ")
 756                                nil nil
 757                                '(gud-dbx-history . 1))))
 758
 759   (cond
 760    (gud-mips-p
 761     (gud-common-init command-line 'gud-mipsdbx-massage-args
 762                      'gud-mipsdbx-marker-filter 'gud-dbx-find-file))
 763    (gud-irix-p
 764     (gud-common-init command-line 'gud-dbx-massage-args
 765                      'gud-irixdbx-marker-filter 'gud-dbx-find-file))
 766    (t
 767     (gud-common-init command-line 'gud-dbx-massage-args
 768                      'gud-dbx-marker-filter 'gud-dbx-find-file)))
 769
 770   (cond
 771    (gud-mips-p
 772     (gud-def gud-up     "up %p"         "<" "Up (numeric arg) stack frames.")
 773     (gud-def gud-down   "down %p" ">" "Down (numeric arg) stack frames.")
 774     (gud-def gud-break "stop at \"%f\":%l"
 775                                   "\C-b" "Set breakpoint at current line.")
 776     (gud-def gud-finish "return"  "\C-f" "Finish executing current function."))
 777    (gud-irix-p
 778     (gud-def gud-break "stop at \"%d%f\":%l"
 779                                   "\C-b" "Set breakpoint at current line.")
 780     (gud-def gud-finish "return"  "\C-f" "Finish executing current function.")
 781     (gud-def gud-up     "up %p; printf \"\032\032%1d:\",(int)$curline;file\n"
 782              "<" "Up (numeric arg) stack frames.")
 783     (gud-def gud-down "down %p; printf \"\032\032%1d:\",(int)$curline;file\n"
 784              ">" "Down (numeric arg) stack frames.")
 785     ;; Make dbx give out the source location info that we need.
 786     (process-send-string (get-buffer-process gud-comint-buffer)
 787                          "printf \"\032\032%1d:\",(int)$curline;file\n"))
 788    (gud-dbx-use-stopformat-p
 789     (process-send-string (get-buffer-process gud-comint-buffer)
 790                          "set $stopformat=1\n"))
 791    (t
 792     (gud-def gud-up     "up %p"         "<" "Up (numeric arg) stack frames.")
 793     (gud-def gud-down   "down %p" ">" "Down (numeric arg) stack frames.")
 794     (gud-def gud-break "file \"%d%f\"\nstop at %l"
 795                                   "\C-b" "Set breakpoint at current line.")))
 796
 797   (gud-def gud-remove "clear %l"  "\C-d" "Remove breakpoint at current line")
 798   (gud-def gud-step   "step %p"   "\C-s" "Step one line with display.")
 799   (gud-def gud-stepi  "stepi %p"  "\C-i" "Step one instruction with display.")
 800   (gud-def gud-next   "next %p"   "\C-n" "Step one line (skip functions).")
 801   (gud-def gud-cont   "cont"      "\C-r" "Continue with display.")
 802   (gud-def gud-print  "print %e"  "\C-p" "Evaluate C expression at point.")
 803
 804   (setq comint-prompt-regexp  "^[^)\n]*dbx) *")
 805   (setq paragraph-start comint-prompt-regexp)
 806   (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
 807   (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
 808   (run-hooks 'dbx-mode-hook)
 809   )
 810 \f
 811 ;; ======================================================================
 812 ;; xdb (HP PARISC debugger) functions
 813
 814 ;;; History of argument lists passed to xdb.
 815 (defvar gud-xdb-history nil)
 816
 817 (defvar gud-xdb-directories nil
 818   "*A list of directories that xdb should search for source code.
 819 If nil, only source files in the program directory
 820 will be known to xdb.
 821
 822 The file names should be absolute, or relative to the directory
 823 containing the executable being debugged.")
 824
 825 (defun gud-xdb-massage-args (file args)
 826   (nconc (let ((directories gud-xdb-directories)
 827                (result nil))
 828            (while directories
 829              (setq result (cons (car directories) (cons "-d" result)))
 830              (setq directories (cdr directories)))
 831            (nreverse result))
 832          args))
 833
 834 (defun gud-xdb-file-name (f)
 835   "Transform a relative pathname to a full pathname in xdb mode"
 836   (let ((result nil))
 837     (if (file-exists-p f)
 838         (setq result (expand-file-name f))
 839       (let ((directories gud-xdb-directories))
 840         (while directories
 841           (let ((path (concat (car directories) "/" f)))
 842             (if (file-exists-p path)
 843                 (setq result (expand-file-name path)
 844                       directories nil)))
 845           (setq directories (cdr directories)))))
 846     result))
 847
 848 ;; xdb does not print the lines all at once, so we have to accumulate them
 849 (defun gud-xdb-marker-filter (string)
 850   (let (result)
 851     (if (or (string-match comint-prompt-regexp string)
 852             (string-match ".*\012" string))
 853         (setq result (concat gud-marker-acc string)
 854               gud-marker-acc "")
 855       (setq gud-marker-acc (concat gud-marker-acc string)))
 856     (if result
 857         (if (or (string-match "\\([^\n \t:]+\\): [^:]+: \\([0-9]+\\)[: ]"
 858                               result)
 859                 (string-match "[^: \t]+:[ \t]+\\([^:]+\\): [^:]+: \\([0-9]+\\):"
 860                               result))
 861             (let ((line (string-to-int
 862                          (substring result (match-beginning 2) (match-end 2))))
 863                   (file (gud-xdb-file-name
 864                          (substring result (match-beginning 1) (match-end 1)))))
 865               (if file
 866                   (setq gud-last-frame (cons file line))))))
 867     (or result "")))
 868
 869 (defun gud-xdb-find-file (f)
 870   (save-excursion
 871     (let ((realf (gud-xdb-file-name f)))
 872       (if realf
 873           (let ((buf (find-file-noselect realf)))
 874             (set-buffer buf)
 875             (gud-make-debug-menu)
 876             (local-set-key [menu-bar debug tbreak]
 877                            '("Temporary Breakpoint" . gud-tbreak))
 878             (local-set-key [menu-bar debug finish]
 879                            '("Finish Function" . gud-finish))
 880             (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
 881             (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
 882             buf)
 883         nil))))
 884
 885 ;;;###autoload
 886 (defun xdb (command-line)
 887   "Run xdb on program FILE in buffer *gud-FILE*.
 888 The directory containing FILE becomes the initial working directory
 889 and source-file directory for your debugger.
 890
 891 You can set the variable 'gud-xdb-directories' to a list of program source
 892 directories if your program contains sources from more than one directory."
 893   (interactive
 894    (list (read-from-minibuffer "Run xdb (like this): "
 895                                (if (consp gud-xdb-history)
 896                                    (car gud-xdb-history)
 897                                  "xdb ")
 898                                nil nil
 899                                '(gud-xdb-history . 1))))
 900
 901   (gud-common-init command-line 'gud-xdb-massage-args
 902                    'gud-xdb-marker-filter 'gud-xdb-find-file)
 903
 904   (gud-def gud-break  "b %f:%l"    "\C-b" "Set breakpoint at current line.")
 905   (gud-def gud-tbreak "b %f:%l\\t" "\C-t"
 906            "Set temporary breakpoint at current line.")
 907   (gud-def gud-remove "db"         "\C-d" "Remove breakpoint at current line")
 908   (gud-def gud-step   "s %p"       "\C-s" "Step one line with display.")
 909   (gud-def gud-next   "S %p"       "\C-n" "Step one line (skip functions).")
 910   (gud-def gud-cont   "c"          "\C-r" "Continue with display.")
 911   (gud-def gud-up     "up %p"      "<"    "Up (numeric arg) stack frames.")
 912   (gud-def gud-down   "down %p"    ">"    "Down (numeric arg) stack frames.")
 913   (gud-def gud-finish "bu\\t"      "\C-f" "Finish executing current function.")
 914   (gud-def gud-print  "p %e"       "\C-p" "Evaluate C expression at point.")
 915
 916   (setq comint-prompt-regexp  "^>")
 917   (setq paragraph-start comint-prompt-regexp)
 918   (local-set-key [menu-bar debug tbreak] '("Temporary Breakpoint" . gud-tbreak))
 919   (local-set-key [menu-bar debug finish] '("Finish Function" . gud-finish))
 920   (local-set-key [menu-bar debug up] '("Up Stack" . gud-up))
 921   (local-set-key [menu-bar debug down] '("Down Stack" . gud-down))
 922   (run-hooks 'xdb-mode-hook))
 923 \f
 924 ;; ======================================================================
 925 ;; perldb functions
 926
 927 ;;; History of argument lists passed to perldb.
 928 (defvar gud-perldb-history nil)
 929
 930 (defun gud-perldb-massage-args (file args)
 931   (cons "-d" (cons (car args) (cons "-emacs" (cdr args)))))
 932
 933 ;; There's no guarantee that Emacs will hand the filter the entire
 934 ;; marker at once; it could be broken up across several strings.  We
 935 ;; might even receive a big chunk with several markers in it.  If we
 936 ;; receive a chunk of text which looks like it might contain the
 937 ;; beginning of a marker, we save it here between calls to the
 938 ;; filter.
 939 (defvar gud-perldb-marker-acc "")
 940
 941 (defun gud-perldb-marker-filter (string)
 942   (setq gud-marker-acc (concat gud-marker-acc string))
 943   (let ((output ""))
 944
 945     ;; Process all the complete markers in this chunk.
 946     (while (string-match "\032\032\\([^:\n]*\\):\\([0-9]*\\):.*\n"
 947                          gud-marker-acc)
 948       (setq
 949
 950        ;; Extract the frame position from the marker.
 951        gud-last-frame
 952        (cons (substring gud-marker-acc (match-beginning 1) (match-end 1))
 953              (string-to-int (substring gud-marker-acc
 954                                        (match-beginning 2)
 955                                        (match-end 2))))
 956
 957        ;; Append any text before the marker to the output we're going
 958        ;; to return - we don't include the marker in this text.
 959        output (concat output
 960                       (substring gud-marker-acc 0 (match-beginning 0)))
 961
 962        ;; Set the accumulator to the remaining text.
 963        gud-marker-acc (substring gud-marker-acc (match-end 0))))
 964
 965     ;; Does the remaining text look like it might end with the
 966     ;; beginning of another marker?  If it does, then keep it in
 967     ;; gud-marker-acc until we receive the rest of it.  Since we
 968     ;; know the full marker regexp above failed, it's pretty simple to
 969     ;; test for marker starts.
 970     (if (string-match "\032.*\\'" gud-marker-acc)
 971         (progn
 972           ;; Everything before the potential marker start can be output.
 973           (setq output (concat output (substring gud-marker-acc
 974                                                  0 (match-beginning 0))))
 975
 976           ;; Everything after, we save, to combine with later input.
 977           (setq gud-marker-acc
 978                 (substring gud-marker-acc (match-beginning 0))))
 979
 980       (setq output (concat output gud-marker-acc)
 981             gud-marker-acc ""))
 982
 983     output))
 984
 985 (defun gud-perldb-find-file (f)
 986   (save-excursion
 987     (let ((buf (find-file-noselect f)))
 988       (set-buffer buf)
 989       (gud-make-debug-menu)
 990       buf)))
 991
 992 (defvar perldb-command-name "perl"
 993   "File name for executing Perl.")
 994
 995 ;;;###autoload
 996 (defun perldb (command-line)
 997   "Run perldb on program FILE in buffer *gud-FILE*.
 998 The directory containing FILE becomes the initial working directory
 999 and source-file directory for your debugger."
1000   (interactive
1001    (list (read-from-minibuffer "Run perldb (like this): "
1002                                (if (consp gud-perldb-history)
1003                                    (car gud-perldb-history)
1004                                  (concat perldb-command-name " "))
1005                                nil nil
1006                                '(gud-perldb-history . 1))))
1007
1008   (gud-common-init command-line 'gud-perldb-massage-args
1009                    'gud-perldb-marker-filter 'gud-perldb-find-file)
1010
1011   (gud-def gud-break  "b %l"         "\C-b" "Set breakpoint at current line.")
1012   (gud-def gud-remove "d %l"         "\C-d" "Remove breakpoint at current line")
1013   (gud-def gud-step   "s"            "\C-s" "Step one source line with display.")
1014   (gud-def gud-next   "n"            "\C-n" "Step one line (skip functions).")
1015   (gud-def gud-cont   "c"            "\C-r" "Continue with display.")
1016 ;  (gud-def gud-finish "finish"       "\C-f" "Finish executing current function.")
1017 ;  (gud-def gud-up     "up %p"        "<" "Up N stack frames (numeric arg).")
1018 ;  (gud-def gud-down   "down %p"      ">" "Down N stack frames (numeric arg).")
1019   (gud-def gud-print  "%e"           "\C-p" "Evaluate perl expression at point.")
1020
1021   (setq comint-prompt-regexp "^  DB<[0-9]+> ")
1022   (setq paragraph-start comint-prompt-regexp)
1023   (run-hooks 'perldb-mode-hook)
1024   )
1025
1026 ;;
1027 ;; End of debugger-specific information
1028 ;;
1029
1030 \f
1031 ;;; When we send a command to the debugger via gud-call, it's annoying
1032 ;;; to see the command and the new prompt inserted into the debugger's
1033 ;;; buffer; we have other ways of knowing the command has completed.
1034 ;;;
1035 ;;; If the buffer looks like this:
1036 ;;; --------------------
1037 ;;; (gdb) set args foo bar
1038 ;;; (gdb) -!-
1039 ;;; --------------------
1040 ;;; (the -!- marks the location of point), and we type `C-x SPC' in a
1041 ;;; source file to set a breakpoint, we want the buffer to end up like
1042 ;;; this:
1043 ;;; --------------------
1044 ;;; (gdb) set args foo bar
1045 ;;; Breakpoint 1 at 0x92: file make-docfile.c, line 49.
1046 ;;; (gdb) -!-
1047 ;;; --------------------
1048 ;;; Essentially, the old prompt is deleted, and the command's output
1049 ;;; and the new prompt take its place.
1050 ;;;
1051 ;;; Not echoing the command is easy enough; you send it directly using
1052 ;;; process-send-string, and it never enters the buffer.  However,
1053 ;;; getting rid of the old prompt is trickier; you don't want to do it
1054 ;;; when you send the command, since that will result in an annoying
1055 ;;; flicker as the prompt is deleted, redisplay occurs while Emacs
1056 ;;; waits for a response from the debugger, and the new prompt is
1057 ;;; inserted.  Instead, we'll wait until we actually get some output
1058 ;;; from the subprocess before we delete the prompt.  If the command
1059 ;;; produced no output other than a new prompt, that prompt will most
1060 ;;; likely be in the first chunk of output received, so we will delete
1061 ;;; the prompt and then replace it with an identical one.  If the
1062 ;;; command produces output, the prompt is moving anyway, so the
1063 ;;; flicker won't be annoying.
1064 ;;;
1065 ;;; So - when we want to delete the prompt upon receipt of the next
1066 ;;; chunk of debugger output, we position gud-delete-prompt-marker at
1067 ;;; the start of the prompt; the process filter will notice this, and
1068 ;;; delete all text between it and the process output marker.  If
1069 ;;; gud-delete-prompt-marker points nowhere, we leave the current
1070 ;;; prompt alone.
1071 (defvar gud-delete-prompt-marker nil)
1072
1073 \f
1074 (defun gud-mode ()
1075   "Major mode for interacting with an inferior debugger process.
1076
1077    You start it up with one of the commands M-x gdb, M-x sdb, M-x dbx,
1078 M-x perldb, or M-x xdb.  Each entry point finishes by executing a
1079 hook; `gdb-mode-hook', `sdb-mode-hook', `dbx-mode-hook',
1080 `perldb-mode-hook', or `xdb-mode-hook' respectively.
1081
1082 After startup, the following commands are available in both the GUD
1083 interaction buffer and any source buffer GUD visits due to a breakpoint stop
1084 or step operation:
1085
1086 \\[gud-break] sets a breakpoint at the current file and line.  In the
1087 GUD buffer, the current file and line are those of the last breakpoint or
1088 step.  In a source buffer, they are the buffer's file and current line.
1089
1090 \\[gud-remove] removes breakpoints on the current file and line.
1091
1092 \\[gud-refresh] displays in the source window the last line referred to
1093 in the gud buffer.
1094
1095 \\[gud-step], \\[gud-next], and \\[gud-stepi] do a step-one-line,
1096 step-one-line (not entering function calls), and step-one-instruction
1097 and then update the source window with the current file and position.
1098 \\[gud-cont] continues execution.
1099
1100 \\[gud-print] tries to find the largest C lvalue or function-call expression
1101 around point, and sends it to the debugger for value display.
1102
1103 The above commands are common to all supported debuggers except xdb which
1104 does not support stepping instructions.
1105
1106 Under gdb, sdb and xdb, \\[gud-tbreak] behaves exactly like \\[gud-break],
1107 except that the breakpoint is temporary; that is, it is removed when
1108 execution stops on it.
1109
1110 Under gdb, dbx, and xdb, \\[gud-up] pops up through an enclosing stack
1111 frame.  \\[gud-down] drops back down through one.
1112
1113 If you are using gdb or xdb, \\[gud-finish] runs execution to the return from
1114 the current function and stops.
1115
1116 All the keystrokes above are accessible in the GUD buffer
1117 with the prefix C-c, and in all buffers through the prefix C-x C-a.
1118
1119 All pre-defined functions for which the concept make sense repeat
1120 themselves the appropriate number of times if you give a prefix
1121 argument.
1122
1123 You may use the `gud-def' macro in the initialization hook to define other
1124 commands.
1125
1126 Other commands for interacting with the debugger process are inherited from
1127 comint mode, which see."
1128   (interactive)
1129   (comint-mode)
1130   (setq major-mode 'gud-mode)
1131   (setq mode-name "Debugger")
1132   (setq mode-line-process '(":%s"))
1133   (use-local-map comint-mode-map)
1134   (gud-make-debug-menu)
1135   (define-key (current-local-map) "\C-c\C-l" 'gud-refresh)
1136   (make-local-variable 'gud-last-frame)
1137   (setq gud-last-frame nil)
1138   (make-local-variable 'comint-prompt-regexp)
1139   (make-local-variable 'paragraph-start)
1140   (make-local-variable 'gud-delete-prompt-marker)
1141   (setq gud-delete-prompt-marker (make-marker))
1142   (run-hooks 'gud-mode-hook))
1143
1144 ;; Chop STRING into words separated by SPC or TAB and return a list of them.
1145 (defun gud-chop-words (string)
1146   (let ((i 0) (beg 0)
1147         (len (length string))
1148         (words nil))
1149     (while (< i len)
1150       (if (memq (aref string i) '(?\t ? ))
1151           (progn
1152             (setq words (cons (substring string beg i) words)
1153                   beg (1+ i))
1154             (while (and (< beg len) (memq (aref string beg) '(?\t ? )))
1155               (setq beg (1+ beg)))
1156             (setq i (1+ beg)))
1157         (setq i (1+ i))))
1158     (if (< beg len)
1159         (setq words (cons (substring string beg) words)))
1160     (nreverse words)))
1161
1162 ;; Perform initializations common to all debuggers.
1163 ;; The first arg is the specified command line,
1164 ;; which starts with the program to debug.
1165 ;; The other three args specify the values to use
1166 ;; for local variables in the debugger buffer.
1167 (defun gud-common-init (command-line massage-args marker-filter find-file)
1168   (let* ((words (gud-chop-words command-line))
1169          (program (car words))
1170          ;; Extract the file name from WORDS
1171          ;; and put t in its place.
1172          ;; Later on we will put the modified file name arg back there.
1173          (file-word (let ((w (cdr words)))
1174                       (while (and w (= ?- (aref (car w) 0)))
1175                         (setq w (cdr w)))
1176                       (and w
1177                            (prog1 (car w)
1178                              (setcar w t)))))
1179          (file-subst
1180           (and file-word (substitute-in-file-name file-word)))
1181          (args (cdr words))
1182          ;; If a directory was specified, expand the file name.
1183          ;; Otherwise, don't expand it, so GDB can use the PATH.
1184          ;; A file name without directory is literally valid
1185          ;; only if the file exists in ., and in that case,
1186          ;; omitting the expansion here has no visible effect.
1187          (file (and file-word
1188                     (if (file-name-directory file-subst)
1189                         (expand-file-name file-subst)
1190                       file-subst)))
1191          (filepart (and file-word (concat "-" (file-name-nondirectory file)))))
1192     (switch-to-buffer (concat "*gud" filepart "*"))
1193     ;; Set default-directory to the file's directory.
1194     (and file-word
1195          ;; Don't set default-directory if no directory was specified.
1196          ;; In that case, either the file is found in the current directory,
1197          ;; in which case this setq is a no-op,
1198          ;; or it is found by searching PATH,
1199          ;; in which case we don't know what directory it was found in.
1200          (file-name-directory file)
1201          (setq default-directory (file-name-directory file)))
1202     (or (bolp) (newline))
1203     (insert "Current directory is " default-directory "\n")
1204     ;; Put the substituted and expanded file name back in its place.
1205     (let ((w args))
1206       (while (and w (not (eq (car w) t)))
1207         (setq w (cdr w)))
1208       (if w
1209           (setcar w file)))
1210     (apply 'make-comint (concat "gud" filepart) program nil
1211            (funcall massage-args file args)))
1212   ;; Since comint clobbered the mode, we don't set it until now.
1213   (gud-mode)
1214   (make-local-variable 'gud-marker-filter)
1215   (setq gud-marker-filter marker-filter)
1216   (make-local-variable 'gud-find-file)
1217   (setq gud-find-file find-file)
1218
1219   (set-process-filter (get-buffer-process (current-buffer)) 'gud-filter)
1220   (set-process-sentinel (get-buffer-process (current-buffer)) 'gud-sentinel)
1221   (gud-set-buffer)
1222   )
1223
1224 (defun gud-set-buffer ()
1225   (cond ((eq major-mode 'gud-mode)
1226         (setq gud-comint-buffer (current-buffer)))))
1227
1228 (defvar gud-filter-defer-flag nil
1229   "Non-nil means don't process anything from the debugger right now.
1230 It is saved for when this flag is not set.")
1231
1232 (defvar gud-filter-pending-text nil
1233   "Non-nil means this is text that has been saved for later in `gud-filter'.")
1234
1235 ;; These functions are responsible for inserting output from your debugger
1236 ;; into the buffer.  The hard work is done by the method that is
1237 ;; the value of gud-marker-filter.
1238
1239 (defun gud-filter (proc string)
1240   ;; Here's where the actual buffer insertion is done
1241   (let (output process-window)
1242     (if (buffer-name (process-buffer proc))
1243         (if gud-filter-defer-flag
1244             ;; If we can't process any text now,
1245             ;; save it for later.
1246             (setq gud-filter-pending-text
1247                   (concat (or gud-filter-pending-text "") string))
1248
1249           ;; If we have to ask a question during the processing,
1250           ;; defer any additional text that comes from the debugger
1251           ;; during that time.
1252           (let ((gud-filter-defer-flag t))
1253             ;; Process now any text we previously saved up.
1254             (if gud-filter-pending-text
1255                 (setq string (concat gud-filter-pending-text string)
1256                       gud-filter-pending-text nil))
1257             (save-excursion
1258               (set-buffer (process-buffer proc))
1259               ;; If we have been so requested, delete the debugger prompt.
1260               (if (marker-buffer gud-delete-prompt-marker)
1261                   (progn
1262                     (delete-region (process-mark proc) gud-delete-prompt-marker)
1263                     (set-marker gud-delete-prompt-marker nil)))
1264               ;; Save the process output, checking for source file markers.
1265               (setq output (gud-marker-filter string))
1266               ;; Check for a filename-and-line number.
1267               ;; Don't display the specified file
1268               ;; unless (1) point is at or after the position where output appears
1269               ;; and (2) this buffer is on the screen.
1270               (setq process-window
1271                     (and gud-last-frame
1272                          (>= (point) (process-mark proc))
1273                          (get-buffer-window (current-buffer))))
1274
1275               ;; Let the comint filter do the actual insertion.
1276               ;; That lets us inherit various comint features.
1277               (comint-output-filter proc output)))
1278
1279           ;; Put the arrow on the source line.
1280           ;; This must be outside of the save-excursion
1281           ;; in case the source file is our current buffer.
1282           (if process-window
1283               (save-selected-window
1284                 (select-window process-window)
1285                 (gud-display-frame))
1286             ;; We have to be in the proper buffer, (process-buffer proc),
1287             ;; but not in a save-excursion, because that would restore point.
1288             (let ((old-buf (current-buffer)))
1289               (set-buffer (process-buffer proc))
1290               (unwind-protect
1291                   (gud-display-frame)
1292                 (set-buffer old-buf))))
1293
1294           ;; If we deferred text that arrived during this processing,
1295           ;; handle it now.
1296           (if gud-filter-pending-text
1297               (gud-filter proc ""))))))
1298
1299 (defun gud-sentinel (proc msg)
1300   (cond ((null (buffer-name (process-buffer proc)))
1301          ;; buffer killed
1302          ;; Stop displaying an arrow in a source file.
1303          (setq overlay-arrow-position nil)
1304          (set-process-buffer proc nil))
1305         ((memq (process-status proc) '(signal exit))
1306          ;; Stop displaying an arrow in a source file.
1307          (setq overlay-arrow-position nil)
1308          ;; Fix the mode line.
1309          (setq mode-line-process
1310                (concat ":"
1311                        (symbol-name (process-status proc))))
1312          (let* ((obuf (current-buffer)))
1313            ;; save-excursion isn't the right thing if
1314            ;;  process-buffer is current-buffer
1315            (unwind-protect
1316                (progn
1317                  ;; Write something in *compilation* and hack its mode line,
1318                  (set-buffer (process-buffer proc))
1319                  (force-mode-line-update)
1320                  (if (eobp)
1321                      (insert ?\n mode-name " " msg)
1322                    (save-excursion
1323                      (goto-char (point-max))
1324                      (insert ?\n mode-name " " msg)))
1325                  ;; If buffer and mode line will show that the process
1326                  ;; is dead, we can delete it now.  Otherwise it
1327                  ;; will stay around until M-x list-processes.
1328                  (delete-process proc))
1329              ;; Restore old buffer, but don't restore old point
1330              ;; if obuf is the gud buffer.
1331              (set-buffer obuf))))))
1332
1333 (defun gud-display-frame ()
1334   "Find and obey the last filename-and-line marker from the debugger.
1335 Obeying it means displaying in another window the specified file and line."
1336   (interactive)
1337   (if gud-last-frame
1338    (progn
1339      (gud-set-buffer)
1340      (gud-display-line (car gud-last-frame) (cdr gud-last-frame))
1341      (setq gud-last-last-frame gud-last-frame
1342            gud-last-frame nil))))
1343
1344 ;; Make sure the file named TRUE-FILE is in a buffer that appears on the screen
1345 ;; and that its line LINE is visible.
1346 ;; Put the overlay-arrow on the line LINE in that buffer.
1347 ;; Most of the trickiness in here comes from wanting to preserve the current
1348 ;; region-restriction if that's possible.  We use an explicit display-buffer
1349 ;; to get around the fact that this is called inside a save-excursion.
1350
1351 (defun gud-display-line (true-file line)
1352   (let* ((last-nonmenu-event t)  ; Prevent use of dialog box for questions.
1353          (buffer
1354           (save-excursion
1355             (or (eq (current-buffer) gud-comint-buffer)
1356                 (set-buffer gud-comint-buffer))
1357             (gud-find-file true-file)))
1358          (window (and buffer (display-buffer buffer)))
1359          (pos))
1360     (if buffer
1361         (progn
1362           (save-excursion
1363             (set-buffer buffer)
1364             (save-restriction
1365               (widen)
1366               (goto-line line)
1367               (setq pos (point))
1368               (setq overlay-arrow-string "=>")
1369               (or overlay-arrow-position
1370                   (setq overlay-arrow-position (make-marker)))
1371               (set-marker overlay-arrow-position (point) (current-buffer)))
1372             (cond ((or (< pos (point-min)) (> pos (point-max)))
1373                    (widen)
1374                    (goto-char pos))))
1375           (set-window-point window overlay-arrow-position)))))
1376
1377 ;;; The gud-call function must do the right thing whether its invoking
1378 ;;; keystroke is from the GUD buffer itself (via major-mode binding)
1379 ;;; or a C buffer.  In the former case, we want to supply data from
1380 ;;; gud-last-frame.  Here's how we do it:
1381
1382 (defun gud-format-command (str arg)
1383   (let ((insource (not (eq (current-buffer) gud-comint-buffer)))
1384         (frame (or gud-last-frame gud-last-last-frame))
1385         result)
1386     (while (and str (string-match "\\([^%]*\\)%\\([adeflp]\\)" str))
1387       (let ((key (string-to-char (substring str (match-beginning 2))))
1388             subst)
1389         (cond
1390          ((eq key ?f)
1391           (setq subst (file-name-nondirectory (if insource
1392                                                   (buffer-file-name)
1393                                                 (car frame)))))
1394          ((eq key ?d)
1395           (setq subst (file-name-directory (if insource
1396                                                (buffer-file-name)
1397                                              (car frame)))))
1398          ((eq key ?l)
1399           (setq subst (if insource
1400                           (save-excursion
1401                             (beginning-of-line)
1402                             (save-restriction (widen)
1403                                               (1+ (count-lines 1 (point)))))
1404                         (cdr frame))))
1405          ((eq key ?e)
1406           (setq subst (find-c-expr)))
1407          ((eq key ?a)
1408           (setq subst (gud-read-address)))
1409          ((eq key ?p)
1410           (setq subst (if arg (int-to-string arg) ""))))
1411         (setq result (concat result
1412                              (substring str (match-beginning 1) (match-end 1))
1413                              subst)))
1414       (setq str (substring str (match-end 2))))
1415     ;; There might be text left in STR when the loop ends.
1416     (concat result str)))
1417
1418 (defun gud-read-address ()
1419   "Return a string containing the core-address found in the buffer at point."
1420   (save-excursion
1421     (let ((pt (point)) found begin)
1422       (setq found (if (search-backward "0x" (- pt 7) t) (point)))
1423       (cond
1424        (found (forward-char 2)
1425               (buffer-substring found
1426                                 (progn (re-search-forward "[^0-9a-f]")
1427                                        (forward-char -1)
1428                                        (point))))
1429        (t (setq begin (progn (re-search-backward "[^0-9]")
1430                              (forward-char 1)
1431                              (point)))
1432           (forward-char 1)
1433           (re-search-forward "[^0-9]")
1434           (forward-char -1)
1435           (buffer-substring begin (point)))))))
1436
1437 (defun gud-call (fmt &optional arg)
1438   (let ((msg (gud-format-command fmt arg)))
1439     (message "Command: %s" msg)
1440     (sit-for 0)
1441     (gud-basic-call msg)))
1442
1443 (defun gud-basic-call (command)
1444   "Invoke the debugger COMMAND displaying source in other window."
1445   (interactive)
1446   (gud-set-buffer)
1447   (let ((command (concat command "\n"))
1448         (proc (get-buffer-process gud-comint-buffer)))
1449     (or proc (error "Current buffer has no process"))
1450     ;; Arrange for the current prompt to get deleted.
1451     (save-excursion
1452       (set-buffer gud-comint-buffer)
1453       (goto-char (process-mark proc))
1454       (beginning-of-line)
1455       (if (looking-at comint-prompt-regexp)
1456           (set-marker gud-delete-prompt-marker (point))))
1457     (process-send-string proc command)))
1458
1459 (defun gud-refresh (&optional arg)
1460   "Fix up a possibly garbled display, and redraw the arrow."
1461   (interactive "P")
1462   (recenter arg)
1463   (or gud-last-frame (setq gud-last-frame gud-last-last-frame))
1464   (gud-display-frame))
1465 \f
1466 ;;; Code for parsing expressions out of C code.  The single entry point is
1467 ;;; find-c-expr, which tries to return an lvalue expression from around point.
1468 ;;;
1469 ;;; The rest of this file is a hacked version of gdbsrc.el by
1470 ;;; Debby Ayers <ayers@asc.slb.com>,
1471 ;;; Rich Schaefer <schaefer@asc.slb.com> Schlumberger, Austin, Tx.
1472
1473 (defun find-c-expr ()
1474   "Returns the C expr that surrounds point."
1475   (interactive)
1476   (save-excursion
1477     (let ((p) (expr) (test-expr))
1478       (setq p (point))
1479       (setq expr (expr-cur))
1480       (setq test-expr (expr-prev))
1481       (while (expr-compound test-expr expr)
1482         (setq expr (cons (car test-expr) (cdr expr)))
1483         (goto-char (car expr))
1484         (setq test-expr (expr-prev)))
1485       (goto-char p)
1486       (setq test-expr (expr-next))
1487       (while (expr-compound expr test-expr)
1488         (setq expr (cons (car expr) (cdr test-expr)))
1489         (setq test-expr (expr-next))
1490         )
1491       (buffer-substring (car expr) (cdr expr)))))
1492
1493 (defun expr-cur ()
1494   "Returns the expr that point is in; point is set to beginning of expr.
1495 The expr is represented as a cons cell, where the car specifies the point in
1496 the current buffer that marks the beginning of the expr and the cdr specifies
1497 the character after the end of the expr."
1498   (let ((p (point)) (begin) (end))
1499     (expr-backward-sexp)
1500     (setq begin (point))
1501     (expr-forward-sexp)
1502     (setq end (point))
1503     (if (>= p end)
1504         (progn
1505          (setq begin p)
1506          (goto-char p)
1507          (expr-forward-sexp)
1508          (setq end (point))
1509          )
1510       )
1511     (goto-char begin)
1512     (cons begin end)))
1513
1514 (defun expr-backward-sexp ()
1515   "Version of `backward-sexp' that catches errors."
1516   (condition-case nil
1517       (backward-sexp)
1518     (error t)))
1519
1520 (defun expr-forward-sexp ()
1521   "Version of `forward-sexp' that catches errors."
1522   (condition-case nil
1523      (forward-sexp)
1524     (error t)))
1525
1526 (defun expr-prev ()
1527   "Returns the previous expr, point is set to beginning of that expr.
1528 The expr is represented as a cons cell, where the car specifies the point in
1529 the current buffer that marks the beginning of the expr and the cdr specifies
1530 the character after the end of the expr"
1531   (let ((begin) (end))
1532     (expr-backward-sexp)
1533     (setq begin (point))
1534     (expr-forward-sexp)
1535     (setq end (point))
1536     (goto-char begin)
1537     (cons begin end)))
1538
1539 (defun expr-next ()
1540   "Returns the following expr, point is set to beginning of that expr.
1541 The expr is represented as a cons cell, where the car specifies the point in
1542 the current buffer that marks the beginning of the expr and the cdr specifies
1543 the character after the end of the expr."
1544   (let ((begin) (end))
1545     (expr-forward-sexp)
1546     (expr-forward-sexp)
1547     (setq end (point))
1548     (expr-backward-sexp)
1549     (setq begin (point))
1550     (cons begin end)))
1551
1552 (defun expr-compound-sep (span-start span-end)
1553   "Returns '.' for '->' & '.', returns ' ' for white space,
1554 returns '?' for other punctuation."
1555   (let ((result ? )
1556         (syntax))
1557     (while (< span-start span-end)
1558       (setq syntax (char-syntax (char-after span-start)))
1559       (cond
1560        ((= syntax ? ) t)
1561        ((= syntax ?.) (setq syntax (char-after span-start))
1562         (cond
1563          ((= syntax ?.) (setq result ?.))
1564          ((and (= syntax ?-) (= (char-after (+ span-start 1)) ?>))
1565           (setq result ?.)
1566           (setq span-start (+ span-start 1)))
1567          (t (setq span-start span-end)
1568             (setq result ??)))))
1569       (setq span-start (+ span-start 1)))
1570     result))
1571
1572 (defun expr-compound (first second)
1573   "Non-nil if concatenating FIRST and SECOND makes a single C token.
1574 The two exprs are represented as a cons cells, where the car
1575 specifies the point in the current buffer that marks the beginning of the
1576 expr and the cdr specifies the character after the end of the expr.
1577 Link exprs of the form:
1578       Expr -> Expr
1579       Expr . Expr
1580       Expr (Expr)
1581       Expr [Expr]
1582       (Expr) Expr
1583       [Expr] Expr"
1584   (let ((span-start (cdr first))
1585         (span-end (car second))
1586         (syntax))
1587     (setq syntax (expr-compound-sep span-start span-end))
1588     (cond
1589      ((= (car first) (car second)) nil)
1590      ((= (cdr first) (cdr second)) nil)
1591      ((= syntax ?.) t)
1592      ((= syntax ? )
1593          (setq span-start (char-after (- span-start 1)))
1594          (setq span-end (char-after span-end))
1595          (cond
1596           ((= span-start ?) ) t )
1597           ((= span-start ?] ) t )
1598           ((= span-end ?( ) t )
1599           ((= span-end ?[ ) t )
1600           (t nil))
1601          )
1602      (t nil))))
1603
1604 (provide 'gud)
1605
1606 ;;; gud.el ends here