lisp/gud.el

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