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