lisp/gud.el

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