(top-level): Revert previous change: require cl when compiling.
[emacs.git] / lisp / progmodes / gdb-ui.el
blob163194a19c5122d67150298e9560c93803ec94b2
1 ;;; gdb-ui.el --- User Interface for running GDB
3 ;; Author: Nick Roberts <nickrob@gnu.org>
4 ;; Maintainer: FSF
5 ;; Keywords: unix, tools
7 ;; Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008
8 ;; Free Software Foundation, Inc.
10 ;; This file is part of GNU Emacs.
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 3 of the License, or
15 ;; (at your option) any later version.
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; This mode acts as a graphical user interface to GDB. You can interact with
28 ;; GDB through the GUD buffer in the usual way, but there are also further
29 ;; buffers which control the execution and describe the state of your program.
30 ;; It separates the input/output of your program from that of GDB, if
31 ;; required, and watches expressions in the speedbar. It also uses features of
32 ;; Emacs 21 such as the fringe/display margin for breakpoints, and the toolbar
33 ;; (see the GDB Graphical Interface section in the Emacs info manual).
35 ;; By default, M-x gdb will start the debugger.
37 ;; This file has evolved from gdba.el that was included with GDB 5.0 and
38 ;; written by Tom Lord and Jim Kingdon. It uses GDB's annotation interface.
39 ;; You don't need to know about annotations to use this mode as a debugger,
40 ;; but if you are interested developing the mode itself, see the Annotations
41 ;; section in the GDB info manual.
43 ;; GDB developers plan to make the annotation interface obsolete. A new
44 ;; interface called GDB/MI (machine interface) has been designed to replace it.
45 ;; Some GDB/MI commands are used in this file through the CLI command
46 ;; 'interpreter mi <mi-command>'. To help with the process of fully migrating
47 ;; Emacs from annotations to GDB/MI, there is an experimental package called
48 ;; gdb-mi in the Emacs Lisp Package Archive ("http://tromey.com/elpa/"). It
49 ;; comprises of modified gud.el and a file called gdb-mi.el which replaces
50 ;; gdb-ui.el. When installed, this overrides the current files and invoking
51 ;; M-x gdb will use GDB/MI directly (starts with "gdb -i=mi"). When deleted
52 ;; ('d' followed by 'x' in Package Menu mode), the files are deleted and old
53 ;; functionality restored. This provides a convenient way to review the
54 ;; current status/contribute to its improvement. For someone who just wants to
55 ;; use GDB, however, the current mode in Emacs 22 is a much better option.
56 ;; There is also a file, also called gdb-mi.el, a version of which is included
57 ;; the GDB distribution. This will probably only work with versions
58 ;; distributed with GDB 6.5 or later. Unlike the version in ELPA it works on
59 ;; top of gdb-ui.el and you can only start it with M-x gdbmi.
61 ;; This mode SHOULD WORK WITH GDB 5.0 or later but you will NEED AT LEAST
62 ;; GDB 6.0 to use watch expressions. It works best with GDB 6.4 or later
63 ;; where watch expressions will update more quickly.
65 ;;; Windows Platforms:
67 ;; If you are using Emacs and GDB on Windows you will need to flush the buffer
68 ;; explicitly in your program if you want timely display of I/O in Emacs.
69 ;; Alternatively you can make the output stream unbuffered, for example, by
70 ;; using a macro:
72 ;; #ifdef UNBUFFERED
73 ;; setvbuf (stdout, (char *) NULL, _IONBF, 0);
74 ;; #endif
76 ;; and compiling with -DUNBUFFERED while debugging.
78 ;; If you are using Cygwin GDB and find that the source is not being displayed
79 ;; in Emacs when you step through it, possible solutions are to:
81 ;; 1) Use Cygwin X Windows and Cygwin Emacs.
82 ;; (Since 22.1 Emacs builds under Cygwin.)
83 ;; 2) Use MinGW GDB instead.
84 ;; 3) Use cygwin-mount.el
86 ;;; Known Bugs:
88 ;; 1) Cannot handle multiple debug sessions.
89 ;; 2) If you wish to call procedures from your program in GDB
90 ;; e.g "call myproc ()", "p mysquare (5)" then use level 2 annotations
91 ;; "gdb --annotate=2 myprog" to keep source buffer/selected frame fixed.
92 ;; 3) After detaching from a process, clicking on the "GO" icon on toolbar
93 ;; (gud-go) sends "continue" to GDB (should be "run").
95 ;;; TODO:
97 ;; 1) Use MI command -data-read-memory for memory window.
98 ;; 2) Use tree-buffer.el (from ECB) instead of the speedbar for
99 ;; watch-expressions? Handling of watch-expressions needs to be
100 ;; overhauled to work for large arrays/structures by creating variable
101 ;; objects for visible watch-expressions only.
102 ;; 3) Mark breakpoint locations on scroll-bar of source buffer?
104 ;;; Code:
106 (require 'gud)
108 (defvar tool-bar-map)
109 (defvar speedbar-initial-expansion-list-name)
111 (defvar gdb-pc-address nil "Initialization for Assembler buffer.
112 Set to \"main\" at start if `gdb-show-main' is t.")
113 (defvar gdb-frame-address nil "Identity of frame for watch expression.")
114 (defvar gdb-previous-frame-pc-address nil)
115 (defvar gdb-memory-address "main")
116 (defvar gdb-previous-frame nil)
117 (defvar gdb-selected-frame nil)
118 (defvar gdb-frame-number nil)
119 (defvar gdb-current-language nil)
120 (defvar gdb-var-list nil
121 "List of variables in watch window.
122 Each element has the form (VARNUM EXPRESSION NUMCHILD TYPE VALUE STATUS FP)
123 where STATUS is nil (`unchanged'), `changed' or `out-of-scope', FP the frame
124 address for root variables.")
125 (defvar gdb-main-file nil "Source file from which program execution begins.")
126 (defvar gud-old-arrow nil)
127 (defvar gdb-thread-indicator nil)
128 (defvar gdb-overlay-arrow-position nil)
129 (defvar gdb-stack-position nil)
130 (defvar gdb-server-prefix nil)
131 (defvar gdb-flush-pending-output nil)
132 (defvar gdb-location-alist nil
133 "Alist of breakpoint numbers and full filenames. Only used for files that
134 Emacs can't find.")
135 (defvar gdb-active-process nil
136 "GUD tooltips display variable values when t, and macro definitions otherwise.")
137 (defvar gdb-error "Non-nil when GDB is reporting an error.")
138 (defvar gdb-macro-info nil
139 "Non-nil if GDB knows that the inferior includes preprocessor macro info.")
140 (defvar gdb-buffer-fringe-width nil)
141 (defvar gdb-signalled nil)
142 (defvar gdb-source-window nil)
143 (defvar gdb-inferior-status nil)
144 (defvar gdb-continuation nil)
145 (defvar gdb-look-up-stack nil)
146 (defvar gdb-frame-begin nil
147 "Non-nil when GDB generates frame-begin annotation.")
148 (defvar gdb-printing t)
149 (defvar gdb-parent-bptno-enabled nil)
150 (defvar gdb-ready nil)
151 (defvar gdb-stack-update nil)
152 (defvar gdb-early-user-input nil)
154 (defvar gdb-buffer-type nil
155 "One of the symbols bound in `gdb-buffer-rules'.")
156 (make-variable-buffer-local 'gdb-buffer-type)
158 (defvar gdb-input-queue ()
159 "A list of gdb command objects.")
161 (defvar gdb-prompting nil
162 "True when gdb is idle with no pending input.")
164 (defvar gdb-output-sink nil
165 "The disposition of the output of the current gdb command.
166 Possible values are these symbols:
168 `user' -- gdb output should be copied to the GUD buffer
169 for the user to see.
171 `inferior' -- gdb output should be copied to the inferior-io buffer.
173 `pre-emacs' -- output should be ignored util the post-prompt
174 annotation is received. Then the output-sink
175 becomes:...
176 `emacs' -- output should be collected in the partial-output-buffer
177 for subsequent processing by a command. This is the
178 disposition of output generated by commands that
179 gdb mode sends to gdb on its own behalf.
180 `post-emacs' -- ignore output until the prompt annotation is
181 received, then go to USER disposition.
183 gdba (gdb-ui.el) uses all five values, gdbmi (gdb-mi.el) only two
184 \(`user' and `emacs').")
186 (defvar gdb-current-item nil
187 "The most recent command item sent to gdb.")
189 (defvar gdb-pending-triggers '()
190 "A list of trigger functions that have run later than their output handlers.")
192 (defvar gdb-first-post-prompt nil)
193 (defvar gdb-version nil)
194 (defvar gdb-locals-font-lock-keywords nil)
195 (defvar gdb-source-file-list nil
196 "List of source files for the current executable.")
197 (defconst gdb-error-regexp "\\^error,msg=\"\\(.+\\)\"")
199 (defvar gdb-locals-font-lock-keywords-1
200 '(;; var = (struct struct_tag) value
201 ( "\\(^\\(\\sw\\|[_.]\\)+\\) += +(\\(struct\\) \\(\\(\\sw\\|[_.]\\)+\\)"
202 (1 font-lock-variable-name-face)
203 (3 font-lock-keyword-face)
204 (4 font-lock-type-face))
205 ;; var = (type) value
206 ( "\\(^\\(\\sw\\|[_.]\\)+\\) += +(\\(\\(\\sw\\|[_.]\\)+\\)"
207 (1 font-lock-variable-name-face)
208 (3 font-lock-type-face))
209 ;; var = val
210 ( "\\(^\\(\\sw\\|[_.]\\)+\\) += +[^(]"
211 (1 font-lock-variable-name-face)))
212 "Font lock keywords used in `gdb-local-mode'.")
214 (defvar gdb-locals-font-lock-keywords-2
215 '(;; var = type value
216 ( "\\(^\\(\\sw\\|[_.]\\)+\\)\t+\\(\\(\\sw\\|[_.]\\)+\\)"
217 (1 font-lock-variable-name-face)
218 (3 font-lock-type-face)))
219 "Font lock keywords used in `gdb-local-mode'.")
221 ;; Variables for GDB 6.4+
222 (defvar gdb-register-names nil "List of register names.")
223 (defvar gdb-changed-registers nil
224 "List of changed register numbers (strings).")
226 ;;;###autoload
227 (defun gdb (command-line)
228 "Run gdb on program FILE in buffer *gud-FILE*.
229 The directory containing FILE becomes the initial working
230 directory and source-file directory for your debugger.
232 If `gdb-many-windows' is nil (the default value) then gdb just
233 pops up the GUD buffer unless `gdb-show-main' is t. In this case
234 it starts with two windows: one displaying the GUD buffer and the
235 other with the source file with the main routine of the inferior.
237 If `gdb-many-windows' is t, regardless of the value of
238 `gdb-show-main', the layout below will appear unless
239 `gdb-use-separate-io-buffer' is nil when the source buffer
240 occupies the full width of the frame. Keybindings are shown in
241 some of the buffers.
243 Watch expressions appear in the speedbar/slowbar.
245 The following commands help control operation :
247 `gdb-many-windows' - Toggle the number of windows gdb uses.
248 `gdb-restore-windows' - To restore the window layout.
250 See Info node `(emacs)GDB Graphical Interface' for a more
251 detailed description of this mode.
253 +----------------------------------------------------------------------+
254 | GDB Toolbar |
255 +-----------------------------------+----------------------------------+
256 | GUD buffer (I/O of GDB) | Locals buffer |
257 |-----------------------------------+----------------------------------+
258 | | |
259 | Source buffer | I/O buffer for debugged program |
260 | | |
261 |-----------------------------------+----------------------------------+
262 | Stack buffer | Breakpoints/threads buffer |
263 +-----------------------------------+----------------------------------+
265 To run GDB in text command mode, replace the GDB \"--annotate=3\"
266 option with \"--fullname\" either in the minibuffer for the
267 current Emacs session, or the custom variable
268 `gud-gdb-command-name' for all future sessions. You need to use
269 text command mode to debug multiple programs within one Emacs
270 session."
271 (interactive (list (gud-query-cmdline 'gdb)))
273 (when (and gud-comint-buffer
274 (buffer-name gud-comint-buffer)
275 (get-buffer-process gud-comint-buffer)
276 (with-current-buffer gud-comint-buffer (eq gud-minor-mode 'gdba)))
277 (gdb-restore-windows)
278 (error
279 "Multiple debugging requires restarting in text command mode"))
281 (gud-common-init command-line nil 'gud-gdba-marker-filter)
282 (set (make-local-variable 'gud-minor-mode) 'gdba)
283 (setq comint-input-sender 'gdb-send)
285 (gud-def gud-break "break %f:%l" "\C-b" "Set breakpoint at current line.")
286 (gud-def gud-tbreak "tbreak %f:%l" "\C-t"
287 "Set temporary breakpoint at current line.")
288 (gud-def gud-remove "clear %f:%l" "\C-d" "Remove breakpoint at current line.")
289 (gud-def gud-step "step %p" "\C-s" "Step one source line with display.")
290 (gud-def gud-stepi "stepi %p" "\C-i" "Step one instruction with display.")
291 (gud-def gud-next "next %p" "\C-n" "Step one line (skip functions).")
292 (gud-def gud-nexti "nexti %p" nil "Step one instruction (skip functions).")
293 (gud-def gud-cont "cont" "\C-r" "Continue with display.")
294 (gud-def gud-finish "finish" "\C-f" "Finish executing current function.")
295 (gud-def gud-jump
296 (progn (gud-call "tbreak %f:%l") (gud-call "jump %f:%l"))
297 "\C-j" "Set execution address to current line.")
299 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
300 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
301 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
302 (gud-def gud-pstar "print* %e" nil
303 "Evaluate C dereferenced pointer expression at point.")
305 ;; For debugging Emacs only.
306 (gud-def gud-pv "pv1 %e" "\C-v" "Print the value of the lisp variable.")
308 (gud-def gud-until "until %l" "\C-u" "Continue to current line.")
309 (gud-def gud-run "run" nil "Run the program.")
311 (local-set-key "\C-i" 'gud-gdb-complete-command)
312 (setq comint-prompt-regexp "^(.*gdb[+]?) *")
313 (setq paragraph-start comint-prompt-regexp)
314 (setq gdb-output-sink 'user)
315 (setq gdb-first-prompt t)
316 (setq gud-running nil)
317 (setq gdb-ready nil)
318 (setq gdb-stack-update nil)
319 (setq gdb-flush-pending-output nil)
320 (setq gdb-early-user-input nil)
321 (setq gud-filter-pending-text nil)
322 (gdb-thread-identification)
323 (run-hooks 'gdb-mode-hook))
325 ;; Keep as an alias for compatibility with Emacs 22.1.
326 ;;;###autoload
327 (defalias 'gdba 'gdb)
329 (defgroup gdb nil
330 "Gdb Graphical Mode options specifically for running Gdb in Emacs."
331 :group 'processes
332 :group 'tools)
334 (defcustom gdb-debug-log-max 128
335 "Maximum size of `gdb-debug-log'. If nil, size is unlimited."
336 :group 'gdb
337 :type '(choice (integer :tag "Number of elements")
338 (const :tag "Unlimited" nil))
339 :version "22.1")
341 (defvar gdb-debug-log nil
342 "List of commands sent to and replies received from GDB.
343 Most recent commands are listed first. This list stores only the last
344 `gdb-debug-log-max' values. This variable is used to debug GDB-UI.")
346 ;;;###autoload
347 (defcustom gdb-enable-debug nil
348 "Non-nil means record the process input and output in `gdb-debug-log'."
349 :type 'boolean
350 :group 'gdb
351 :version "22.1")
353 (defcustom gdb-cpp-define-alist-program "gcc -E -dM -"
354 "Shell command for generating a list of defined macros in a source file.
355 This list is used to display the #define directive associated
356 with an identifier as a tooltip. It works in a debug session with
357 GDB, when `gud-tooltip-mode' is t.
359 Set `gdb-cpp-define-alist-flags' for any include paths or
360 predefined macros."
361 :type 'string
362 :group 'gdb
363 :version "22.1")
365 (defcustom gdb-cpp-define-alist-flags ""
366 "Preprocessor flags for `gdb-cpp-define-alist-program'."
367 :type 'string
368 :group 'gdb
369 :version "22.1")
371 (defcustom gdb-show-main nil
372 "Non-nil means display source file containing the main routine at startup.
373 Also display the main routine in the disassembly buffer if present."
374 :type 'boolean
375 :group 'gdb
376 :version "22.1")
378 (defcustom gdb-many-windows nil
379 "If nil, just pop up the GUD buffer unless `gdb-show-main' is t.
380 In this case start with two windows: one displaying the GUD
381 buffer and the other with the source file with the main routine
382 of the debugged program. Non-nil means display the layout shown
383 for `gdba'."
384 :type 'boolean
385 :group 'gdb
386 :version "22.1")
388 (defcustom gdb-use-separate-io-buffer nil
389 "Non-nil means display output from the debugged program in a separate buffer."
390 :type 'boolean
391 :group 'gdb
392 :version "22.1")
394 (defun gdb-force-mode-line-update (status)
395 (let ((buffer gud-comint-buffer))
396 (if (and buffer (buffer-name buffer))
397 (with-current-buffer buffer
398 (setq mode-line-process
399 (format ":%s [%s]"
400 (process-status (get-buffer-process buffer)) status))
401 ;; Force mode line redisplay soon.
402 (force-mode-line-update)))))
404 (defun gdb-many-windows (arg)
405 "Toggle the number of windows in the basic arrangement.
406 With prefix argument ARG, display additional buffers if ARG is positive,
407 otherwise use a single window."
408 (interactive "P")
409 (setq gdb-many-windows
410 (if (null arg)
411 (not gdb-many-windows)
412 (> (prefix-numeric-value arg) 0)))
413 (message (format "Display of other windows %sabled"
414 (if gdb-many-windows "en" "dis")))
415 (if (and gud-comint-buffer
416 (buffer-name gud-comint-buffer))
417 (condition-case nil
418 (gdb-restore-windows)
419 (error nil))))
421 (defun gdb-use-separate-io-buffer (arg)
422 "Toggle separate IO for debugged program.
423 With prefix argument ARG, use separate IO if ARG is positive,
424 otherwise do not."
425 (interactive "P")
426 (setq gdb-use-separate-io-buffer
427 (if (null arg)
428 (not gdb-use-separate-io-buffer)
429 (> (prefix-numeric-value arg) 0)))
430 (message (format "Separate IO %sabled"
431 (if gdb-use-separate-io-buffer "en" "dis")))
432 (if (and gud-comint-buffer
433 (buffer-name gud-comint-buffer))
434 (condition-case nil
435 (if gdb-use-separate-io-buffer
436 (if gdb-many-windows (gdb-restore-windows))
437 (kill-buffer (gdb-inferior-io-name)))
438 (error nil))))
440 (defvar gdb-define-alist nil "Alist of #define directives for GUD tooltips.")
442 (defun gdb-create-define-alist ()
443 "Create an alist of #define directives for GUD tooltips."
444 (let* ((file (buffer-file-name))
445 (output
446 (with-output-to-string
447 (with-current-buffer standard-output
448 (and file (file-exists-p file)
449 (call-process shell-file-name file
450 (list t nil) nil "-c"
451 (concat gdb-cpp-define-alist-program " "
452 gdb-cpp-define-alist-flags))))))
453 (define-list (split-string output "\n" t)) (name))
454 (setq gdb-define-alist nil)
455 (dolist (define define-list)
456 (setq name (nth 1 (split-string define "[( ]")))
457 (push (cons name define) gdb-define-alist))))
459 (defun gdb-tooltip-print (expr)
460 (tooltip-show
461 (with-current-buffer (gdb-get-buffer 'gdb-partial-output-buffer)
462 (goto-char (point-min))
463 (let ((string
464 (if (search-forward "=" nil t)
465 (concat expr (buffer-substring (- (point) 2) (point-max)))
466 (buffer-string))))
467 ;; remove newline for gud-tooltip-echo-area
468 (substring string 0 (- (length string) 1))))
469 (or gud-tooltip-echo-area tooltip-use-echo-area)))
471 ;; If expr is a macro for a function don't print because of possible dangerous
472 ;; side-effects. Also printing a function within a tooltip generates an
473 ;; unexpected starting annotation (phase error).
474 (defun gdb-tooltip-print-1 (expr)
475 (with-current-buffer (gdb-get-buffer 'gdb-partial-output-buffer)
476 (goto-char (point-min))
477 (if (search-forward "expands to: " nil t)
478 (unless (looking-at "\\S-+.*(.*).*")
479 (gdb-enqueue-input
480 (list (concat gdb-server-prefix "print " expr "\n")
481 `(lambda () (gdb-tooltip-print ,expr))))))))
483 (defconst gdb-source-file-regexp "\\(.+?\\), \\|\\([^, \n].*$\\)")
485 (defun gdb-init-buffer ()
486 (set (make-local-variable 'gud-minor-mode)
487 (buffer-local-value 'gud-minor-mode gud-comint-buffer))
488 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
489 (when gud-tooltip-mode
490 (make-local-variable 'gdb-define-alist)
491 (gdb-create-define-alist)
492 (add-hook 'after-save-hook 'gdb-create-define-alist nil t)))
494 (defun gdb-set-gud-minor-mode-existing-buffers ()
495 "Create list of source files for current GDB session."
496 (goto-char (point-min))
497 (when (search-forward "read in on demand:" nil t)
498 (while (re-search-forward gdb-source-file-regexp nil t)
499 (push (file-name-nondirectory (or (match-string 1) (match-string 2)))
500 gdb-source-file-list))
501 (dolist (buffer (buffer-list))
502 (with-current-buffer buffer
503 (when (and buffer-file-name
504 (member (file-name-nondirectory buffer-file-name)
505 gdb-source-file-list))
506 (gdb-init-buffer)))))
507 (gdb-force-mode-line-update
508 (propertize "ready" 'face font-lock-variable-name-face)))
510 (defun gdb-find-watch-expression ()
511 (let* ((var (nth (- (line-number-at-pos (point)) 2) gdb-var-list))
512 (varnum (car var)) expr array)
513 (string-match "\\(var[0-9]+\\)\\.\\(.*\\)" varnum)
514 (let ((var1 (assoc (match-string 1 varnum) gdb-var-list)) var2 varnumlet
515 (component-list (split-string (match-string 2 varnum) "\\." t)))
516 (setq expr (nth 1 var1))
517 (setq varnumlet (car var1))
518 (dolist (component component-list)
519 (setq var2 (assoc varnumlet gdb-var-list))
520 (setq expr (concat expr
521 (if (string-match ".*\\[[0-9]+\\]$" (nth 3 var2))
522 (concat "[" component "]")
523 (concat "." component))))
524 (setq varnumlet (concat varnumlet "." component)))
525 expr)))
527 (defun gdb-init-1 ()
528 (gud-def gud-break (if (not (string-match "Machine" mode-name))
529 (gud-call "break %f:%l" arg)
530 (save-excursion
531 (beginning-of-line)
532 (forward-char 2)
533 (gud-call "break *%a" arg)))
534 "\C-b" "Set breakpoint at current line or address.")
536 (gud-def gud-remove (if (not (string-match "Machine" mode-name))
537 (gud-call "clear %f:%l" arg)
538 (save-excursion
539 (beginning-of-line)
540 (forward-char 2)
541 (gud-call "clear *%a" arg)))
542 "\C-d" "Remove breakpoint at current line or address.")
544 (gud-def gud-until (if (not (string-match "Machine" mode-name))
545 (gud-call "until %f:%l" arg)
546 (save-excursion
547 (beginning-of-line)
548 (forward-char 2)
549 (gud-call "until *%a" arg)))
550 "\C-u" "Continue to current line or address.")
552 (gud-def gud-go (gud-call (if gdb-active-process "continue" "run") arg)
553 nil "Start or continue execution.")
555 ;; For debugging Emacs only.
556 (gud-def gud-pp
557 (gud-call
558 (concat
559 "pp1 " (if (eq (buffer-local-value
560 'major-mode (window-buffer)) 'speedbar-mode)
561 (gdb-find-watch-expression) "%e")) arg)
562 nil "Print the Emacs s-expression.")
564 (define-key gud-minor-mode-map [left-margin mouse-1]
565 'gdb-mouse-set-clear-breakpoint)
566 (define-key gud-minor-mode-map [left-fringe mouse-1]
567 'gdb-mouse-set-clear-breakpoint)
568 (define-key gud-minor-mode-map [left-margin C-mouse-1]
569 'gdb-mouse-toggle-breakpoint-margin)
570 (define-key gud-minor-mode-map [left-fringe C-mouse-1]
571 'gdb-mouse-toggle-breakpoint-fringe)
573 (define-key gud-minor-mode-map [left-margin drag-mouse-1]
574 'gdb-mouse-until)
575 (define-key gud-minor-mode-map [left-fringe drag-mouse-1]
576 'gdb-mouse-until)
577 (define-key gud-minor-mode-map [left-margin mouse-3]
578 'gdb-mouse-until)
579 (define-key gud-minor-mode-map [left-fringe mouse-3]
580 'gdb-mouse-until)
582 (define-key gud-minor-mode-map [left-margin C-drag-mouse-1]
583 'gdb-mouse-jump)
584 (define-key gud-minor-mode-map [left-fringe C-drag-mouse-1]
585 'gdb-mouse-jump)
586 (define-key gud-minor-mode-map [left-fringe C-mouse-3]
587 'gdb-mouse-jump)
588 (define-key gud-minor-mode-map [left-margin C-mouse-3]
589 'gdb-mouse-jump)
591 ;; (re-)initialize
592 (setq gdb-pc-address (if gdb-show-main "main" nil))
593 (setq gdb-previous-frame-pc-address nil
594 gdb-memory-address "main"
595 gdb-previous-frame nil
596 gdb-selected-frame nil
597 gdb-current-language nil
598 gdb-frame-number nil
599 gdb-var-list nil
600 gdb-main-file nil
601 gdb-first-post-prompt t
602 gdb-prompting nil
603 gdb-input-queue nil
604 gdb-current-item nil
605 gdb-pending-triggers nil
606 gdb-output-sink 'user
607 gdb-server-prefix "server "
608 gdb-location-alist nil
609 gdb-source-file-list nil
610 gdb-error nil
611 gdb-macro-info nil
612 gdb-buffer-fringe-width (car (window-fringes))
613 gdb-debug-log nil
614 gdb-signalled nil
615 gdb-source-window nil
616 gdb-inferior-status nil
617 gdb-continuation nil
618 gdb-look-up-stack nil
619 gdb-frame-begin nil
620 gdb-printing t
621 gud-old-arrow nil
622 gdb-thread-indicator nil)
624 (setq gdb-buffer-type 'gdba)
626 (if gdb-use-separate-io-buffer (gdb-clear-inferior-io))
628 ;; Hack to see test for GDB 6.4+ (-stack-info-frame was implemented in 6.4)
629 (gdb-enqueue-input (list "server interpreter mi -stack-info-frame\n"
630 'gdb-get-version)))
632 (defun gdb-init-2 ()
633 (if (eq window-system 'w32)
634 (gdb-enqueue-input (list "set new-console off\n" 'ignore)))
635 (gdb-enqueue-input (list "set height 0\n" 'ignore))
636 (gdb-enqueue-input (list "set width 0\n" 'ignore))
638 (if (string-equal gdb-version "pre-6.4")
639 (progn
640 (gdb-enqueue-input (list (concat gdb-server-prefix "info sources\n")
641 'gdb-set-gud-minor-mode-existing-buffers))
642 (setq gdb-locals-font-lock-keywords gdb-locals-font-lock-keywords-1))
643 (gdb-enqueue-input
644 (list "server interpreter mi -data-list-register-names\n"
645 'gdb-get-register-names))
646 ; Needs GDB 6.2 onwards.
647 (gdb-enqueue-input
648 (list "server interpreter mi \"-file-list-exec-source-files\"\n"
649 'gdb-set-gud-minor-mode-existing-buffers-1))
650 (setq gdb-locals-font-lock-keywords gdb-locals-font-lock-keywords-2))
652 ;; Find source file and compilation directory here.
653 ;; Works for C, C++, Fortran and Ada but not Java (GDB 6.4)
654 (gdb-enqueue-input (list "server list\n" 'ignore))
655 (gdb-enqueue-input (list "server info source\n" 'gdb-source-info))
657 (run-hooks 'gdb-mode-hook))
659 (defun gdb-get-version ()
660 (goto-char (point-min))
661 (if (re-search-forward "Undefined\\( mi\\)* command:" nil t)
662 (setq gdb-version "pre-6.4")
663 (setq gdb-version "6.4+"))
664 (gdb-init-2))
666 (defmacro gdb-if-arrow (arrow-position &rest body)
667 `(if ,arrow-position
668 (let ((buffer (marker-buffer ,arrow-position)) (line))
669 (if (equal buffer (window-buffer (posn-window end)))
670 (with-current-buffer buffer
671 (when (or (equal start end)
672 (equal (posn-point start)
673 (marker-position ,arrow-position)))
674 ,@body))))))
676 (defun gdb-mouse-until (event)
677 "Continue running until a source line past the current line.
678 The destination source line can be selected either by clicking
679 with mouse-3 on the fringe/margin or dragging the arrow
680 with mouse-1 (default bindings)."
681 (interactive "e")
682 (let ((start (event-start event))
683 (end (event-end event)))
684 (gdb-if-arrow gud-overlay-arrow-position
685 (setq line (line-number-at-pos (posn-point end)))
686 (gud-call (concat "until " (number-to-string line))))
687 (gdb-if-arrow gdb-overlay-arrow-position
688 (save-excursion
689 (goto-line (line-number-at-pos (posn-point end)))
690 (forward-char 2)
691 (gud-call (concat "until *%a"))))))
693 (defun gdb-mouse-jump (event)
694 "Set execution address/line.
695 The destination source line can be selected either by clicking with C-mouse-3
696 on the fringe/margin or dragging the arrow with C-mouse-1 (default bindings).
697 Unlike `gdb-mouse-until' the destination address can be before the current
698 line, and no execution takes place."
699 (interactive "e")
700 (let ((start (event-start event))
701 (end (event-end event)))
702 (gdb-if-arrow gud-overlay-arrow-position
703 (setq line (line-number-at-pos (posn-point end)))
704 (progn
705 (gud-call (concat "tbreak " (number-to-string line)))
706 (gud-call (concat "jump " (number-to-string line)))))
707 (gdb-if-arrow gdb-overlay-arrow-position
708 (save-excursion
709 (goto-line (line-number-at-pos (posn-point end)))
710 (forward-char 2)
711 (progn
712 (gud-call (concat "tbreak *%a"))
713 (gud-call (concat "jump *%a")))))))
715 (defcustom gdb-speedbar-auto-raise nil
716 "If non-nil raise speedbar every time display of watch expressions is\
717 updated."
718 :type 'boolean
719 :group 'gdb
720 :version "22.1")
722 (defun gdb-speedbar-auto-raise (arg)
723 "Toggle automatic raising of the speedbar for watch expressions.
724 With prefix argument ARG, automatically raise speedbar if ARG is
725 positive, otherwise don't automatically raise it."
726 (interactive "P")
727 (setq gdb-speedbar-auto-raise
728 (if (null arg)
729 (not gdb-speedbar-auto-raise)
730 (> (prefix-numeric-value arg) 0)))
731 (message (format "Auto raising %sabled"
732 (if gdb-speedbar-auto-raise "en" "dis"))))
734 (defcustom gdb-use-colon-colon-notation nil
735 "If non-nil use FUN::VAR format to display variables in the speedbar."
736 :type 'boolean
737 :group 'gdb
738 :version "22.1")
740 (define-key gud-minor-mode-map "\C-c\C-w" 'gud-watch)
741 (define-key global-map (concat gud-key-prefix "\C-w") 'gud-watch)
743 (defun gud-watch (&optional arg event)
744 "Watch expression at point.
745 With arg, enter name of variable to be watched in the minibuffer."
746 (interactive (list current-prefix-arg last-input-event))
747 (let ((minor-mode (buffer-local-value 'gud-minor-mode gud-comint-buffer)))
748 (if (memq minor-mode '(gdbmi gdba))
749 (progn
750 (if event (posn-set-point (event-end event)))
751 (require 'tooltip)
752 (save-selected-window
753 (let ((expr
754 (if arg
755 (completing-read "Name of variable: "
756 'gud-gdb-complete-command)
757 (if (and transient-mark-mode mark-active)
758 (buffer-substring (region-beginning) (region-end))
759 (concat (if (eq major-mode 'gdb-registers-mode) "$")
760 (tooltip-identifier-from-point (point)))))))
761 (set-text-properties 0 (length expr) nil expr)
762 (gdb-enqueue-input
763 (list
764 (if (eq minor-mode 'gdba)
765 (concat
766 "server interpreter mi \"-var-create - * " expr "\"\n")
767 (concat"-var-create - * " expr "\n"))
768 `(lambda () (gdb-var-create-handler ,expr)))))))
769 (message "gud-watch is a no-op in this mode."))))
771 (defconst gdb-var-create-regexp
772 "name=\"\\(.*?\\)\",.*numchild=\"\\(.*?\\)\",\\(?:.*value=\\(\".*\"\\),\\)?.*type=\"\\(.*?\\)\"")
774 (defun gdb-var-create-handler (expr)
775 (goto-char (point-min))
776 (if (re-search-forward gdb-var-create-regexp nil t)
777 (let ((var (list
778 (match-string 1)
779 (if (and (string-equal gdb-current-language "c")
780 gdb-use-colon-colon-notation gdb-selected-frame)
781 (setq expr (concat gdb-selected-frame "::" expr))
782 expr)
783 (match-string 2)
784 (match-string 4)
785 (if (match-string 3) (read (match-string 3)))
786 nil gdb-frame-address)))
787 (push var gdb-var-list)
788 (speedbar 1)
789 (unless (string-equal
790 speedbar-initial-expansion-list-name "GUD")
791 (speedbar-change-initial-expansion-list "GUD"))
792 (unless (nth 4 var)
793 (gdb-enqueue-input
794 (list
795 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
796 'gdba)
797 (concat "server interpreter mi \"0-var-evaluate-expression "
798 (car var) "\"\n")
799 (concat "0-var-evaluate-expression " (car var) "\n"))
800 `(lambda () (gdb-var-evaluate-expression-handler
801 ,(car var) nil))))))
802 (if (search-forward "Undefined command" nil t)
803 (message-box "Watching expressions requires GDB 6.0 onwards")
804 (message-box "No symbol \"%s\" in current context." expr))))
806 (defun gdb-speedbar-update ()
807 (when (and (boundp 'speedbar-frame) (frame-live-p speedbar-frame)
808 (not (member 'gdb-speedbar-timer gdb-pending-triggers)))
809 ;; Dummy command to update speedbar even when idle.
810 (gdb-enqueue-input (list "server pwd\n" 'gdb-speedbar-timer-fn))
811 ;; Keep gdb-pending-triggers non-nil till end.
812 (push 'gdb-speedbar-timer gdb-pending-triggers)))
814 (defun gdb-speedbar-timer-fn ()
815 (if gdb-speedbar-auto-raise
816 (raise-frame speedbar-frame))
817 (setq gdb-pending-triggers
818 (delq 'gdb-speedbar-timer gdb-pending-triggers))
819 (speedbar-timer-fn))
821 (defun gdb-var-evaluate-expression-handler (varnum changed)
822 (goto-char (point-min))
823 (re-search-forward "\\(.+\\)\\^done,value=\\(\".*\"\\)" nil t)
824 (setq gdb-pending-triggers
825 (delq (string-to-number (match-string 1)) gdb-pending-triggers))
826 (let ((var (assoc varnum gdb-var-list)))
827 (when var
828 (if changed (setcar (nthcdr 5 var) 'changed))
829 (setcar (nthcdr 4 var) (read (match-string 2)))))
830 (gdb-speedbar-update))
832 (defun gdb-var-list-children (varnum)
833 (gdb-enqueue-input
834 (list (concat "server interpreter mi \"-var-list-children " varnum "\"\n")
835 `(lambda () (gdb-var-list-children-handler ,varnum)))))
837 (defconst gdb-var-list-children-regexp
838 "child={.*?name=\"\\(.*?\\)\",.*?exp=\"\\(.*?\\)\",.*?\
839 numchild=\"\\(.*?\\)\"\\(}\\|,.*?\\(type=\"\\(.*?\\)\"\\)?.*?}\\)")
841 (defun gdb-var-list-children-handler (varnum)
842 (goto-char (point-min))
843 (let ((var-list nil))
844 (catch 'child-already-watched
845 (dolist (var gdb-var-list)
846 (if (string-equal varnum (car var))
847 (progn
848 (push var var-list)
849 (while (re-search-forward gdb-var-list-children-regexp nil t)
850 (let ((varchild (list (match-string 1)
851 (match-string 2)
852 (match-string 3)
853 (match-string 6)
854 nil nil)))
855 (if (assoc (car varchild) gdb-var-list)
856 (throw 'child-already-watched nil))
857 (push varchild var-list)
858 (gdb-enqueue-input
859 (list
860 (concat
861 "server interpreter mi \"0-var-evaluate-expression "
862 (car varchild) "\"\n")
863 `(lambda () (gdb-var-evaluate-expression-handler
864 ,(car varchild) nil)))))))
865 (push var var-list)))
866 (setq gdb-var-list (nreverse var-list)))))
868 (defun gdb-var-update ()
869 (when (not (member 'gdb-var-update gdb-pending-triggers))
870 (gdb-enqueue-input
871 (list "server interpreter mi \"-var-update *\"\n"
872 'gdb-var-update-handler))
873 (push 'gdb-var-update gdb-pending-triggers)))
875 (defconst gdb-var-update-regexp
876 "{.*?name=\"\\(.*?\\)\",.*?in_scope=\"\\(.*?\\)\",.*?\
877 type_changed=\".*?\".*?}")
879 (defun gdb-var-update-handler ()
880 (dolist (var gdb-var-list)
881 (setcar (nthcdr 5 var) nil))
882 (goto-char (point-min))
883 (let ((n 0))
884 (while (re-search-forward gdb-var-update-regexp nil t)
885 (let ((varnum (match-string 1)))
886 (if (string-equal (match-string 2) "false")
887 (let ((var (assoc varnum gdb-var-list)))
888 (if var (setcar (nthcdr 5 var) 'out-of-scope)))
889 (setq n (1+ n))
890 (push n gdb-pending-triggers)
891 (gdb-enqueue-input
892 (list
893 (concat "server interpreter mi \"" (number-to-string n)
894 "-var-evaluate-expression " varnum "\"\n")
895 `(lambda () (gdb-var-evaluate-expression-handler ,varnum t))))))))
896 (setq gdb-pending-triggers
897 (delq 'gdb-var-update gdb-pending-triggers)))
899 (defun gdb-var-set-format (format)
900 "Set the output format for a variable displayed in the speedbar."
901 (let* ((var (nth (- (count-lines (point-min) (point)) 2) gdb-var-list))
902 (varnum (car var)))
903 (gdb-enqueue-input
904 (list
905 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer) 'gdba)
906 (concat "server interpreter mi \"-var-set-format "
907 varnum " " format "\"\n")
908 (concat "-var-set-format " varnum " " format "\n"))
909 `(lambda () (gdb-var-set-format-handler ,varnum))))))
911 (defconst gdb-var-set-format-regexp
912 "format=\"\\(.*?\\)\",.*value=\"\\(.*?\\)\"")
914 (defun gdb-var-set-format-handler (varnum)
915 (goto-char (point-min))
916 (if (re-search-forward gdb-var-set-format-regexp nil t)
917 (let ((var (assoc varnum gdb-var-list)))
918 (setcar (nthcdr 4 var) (match-string 2))
919 (gdb-var-update-1))))
921 (defun gdb-var-delete-1 (varnum)
922 (gdb-enqueue-input
923 (list
924 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer) 'gdba)
925 (concat "server interpreter mi \"-var-delete " varnum "\"\n")
926 (concat "-var-delete " varnum "\n"))
927 'ignore))
928 (setq gdb-var-list (delq var gdb-var-list))
929 (dolist (varchild gdb-var-list)
930 (if (string-match (concat (car var) "\\.") (car varchild))
931 (setq gdb-var-list (delq varchild gdb-var-list)))))
933 (defun gdb-var-delete ()
934 "Delete watch expression at point from the speedbar."
935 (interactive)
936 (if (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
937 '(gdbmi gdba))
938 (let* ((var (nth (- (count-lines (point-min) (point)) 2) gdb-var-list))
939 (varnum (car var)))
940 (if (string-match "\\." (car var))
941 (message-box "Can only delete a root expression")
942 (gdb-var-delete-1 varnum)))))
944 (defun gdb-var-delete-children (varnum)
945 "Delete children of variable object at point from the speedbar."
946 (gdb-enqueue-input
947 (list
948 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer) 'gdba)
949 (concat "server interpreter mi \"-var-delete -c " varnum "\"\n")
950 (concat "-var-delete -c " varnum "\n")) 'ignore)))
952 (defun gdb-edit-value (text token indent)
953 "Assign a value to a variable displayed in the speedbar."
954 (let* ((var (nth (- (count-lines (point-min) (point)) 2) gdb-var-list))
955 (varnum (car var)) (value))
956 (setq value (read-string "New value: "))
957 (gdb-enqueue-input
958 (list
959 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer) 'gdba)
960 (concat "server interpreter mi \"-var-assign "
961 varnum " " value "\"\n")
962 (concat "-var-assign " varnum " " value "\n"))
963 `(lambda () (gdb-edit-value-handler ,value))))))
965 (defun gdb-edit-value-handler (value)
966 (goto-char (point-min))
967 (if (re-search-forward gdb-error-regexp nil t)
968 (message-box "Invalid number or expression (%s)" value)))
970 (defcustom gdb-show-changed-values t
971 "If non-nil change the face of out of scope variables and changed values.
972 Out of scope variables are suppressed with `shadow' face.
973 Changed values are highlighted with the face `font-lock-warning-face'."
974 :type 'boolean
975 :group 'gdb
976 :version "22.1")
978 (defcustom gdb-max-children 40
979 "Maximum number of children before expansion requires confirmation."
980 :type 'integer
981 :group 'gdb
982 :version "22.1")
984 (defcustom gdb-delete-out-of-scope t
985 "If non-nil delete watch expressions automatically when they go out of scope."
986 :type 'boolean
987 :group 'gdb
988 :version "22.2")
990 (defun gdb-speedbar-expand-node (text token indent)
991 "Expand the node the user clicked on.
992 TEXT is the text of the button we clicked on, a + or - item.
993 TOKEN is data related to this node.
994 INDENT is the current indentation depth."
995 (if (and gud-comint-buffer (buffer-name gud-comint-buffer))
996 (progn
997 (cond ((string-match "+" text) ;expand this node
998 (let* ((var (assoc token gdb-var-list))
999 (expr (nth 1 var)) (children (nth 2 var)))
1000 (if (or (<= (string-to-number children) gdb-max-children)
1001 (y-or-n-p
1002 (format
1003 "%s has %s children. Continue? " expr children)))
1004 (if (and (eq (buffer-local-value
1005 'gud-minor-mode gud-comint-buffer) 'gdba)
1006 (string-equal gdb-version "pre-6.4"))
1007 (gdb-var-list-children token)
1008 (gdb-var-list-children-1 token)))))
1009 ((string-match "-" text) ;contract this node
1010 (dolist (var gdb-var-list)
1011 (if (string-match (concat token "\\.") (car var))
1012 (setq gdb-var-list (delq var gdb-var-list))))
1013 (gdb-var-delete-children token)
1014 (speedbar-change-expand-button-char ?+)
1015 (speedbar-delete-subblock indent))
1016 (t (error "Ooops... not sure what to do")))
1017 (speedbar-center-buffer-smartly))
1018 (message-box "GUD session has been killed")))
1020 (defun gdb-get-target-string ()
1021 (with-current-buffer gud-comint-buffer
1022 gud-target-name))
1026 ;; gdb buffers.
1028 ;; Each buffer has a TYPE -- a symbol that identifies the function
1029 ;; of that particular buffer.
1031 ;; The usual gdb interaction buffer is given the type `gdba' and
1032 ;; is constructed specially.
1034 ;; Others are constructed by gdb-get-buffer-create and
1035 ;; named according to the rules set forth in the gdb-buffer-rules-assoc
1037 (defvar gdb-buffer-rules-assoc '())
1039 (defun gdb-get-buffer (key)
1040 "Return the gdb buffer tagged with type KEY.
1041 The key should be one of the cars in `gdb-buffer-rules-assoc'."
1042 (save-excursion
1043 (gdb-look-for-tagged-buffer key (buffer-list))))
1045 (defun gdb-get-buffer-create (key)
1046 "Create a new gdb buffer of the type specified by KEY.
1047 The key should be one of the cars in `gdb-buffer-rules-assoc'."
1048 (or (gdb-get-buffer key)
1049 (let* ((rules (assoc key gdb-buffer-rules-assoc))
1050 (name (funcall (gdb-rules-name-maker rules)))
1051 (new (get-buffer-create name)))
1052 (with-current-buffer new
1053 (let ((trigger))
1054 (if (cdr (cdr rules))
1055 (setq trigger (funcall (car (cdr (cdr rules))))))
1056 (setq gdb-buffer-type key)
1057 (set (make-local-variable 'gud-minor-mode)
1058 (buffer-local-value 'gud-minor-mode gud-comint-buffer))
1059 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
1060 (if trigger (funcall trigger)))
1061 new))))
1063 (defun gdb-rules-name-maker (rules) (car (cdr rules)))
1065 (defun gdb-look-for-tagged-buffer (key bufs)
1066 (let ((retval nil))
1067 (while (and (not retval) bufs)
1068 (set-buffer (car bufs))
1069 (if (eq gdb-buffer-type key)
1070 (setq retval (car bufs)))
1071 (setq bufs (cdr bufs)))
1072 retval))
1075 ;; This assoc maps buffer type symbols to rules. Each rule is a list of
1076 ;; at least one and possible more functions. The functions have these
1077 ;; roles in defining a buffer type:
1079 ;; NAME - Return a name for this buffer type.
1081 ;; The remaining function(s) are optional:
1083 ;; MODE - called in a new buffer with no arguments, should establish
1084 ;; the proper mode for the buffer.
1087 (defun gdb-set-buffer-rules (buffer-type &rest rules)
1088 (let ((binding (assoc buffer-type gdb-buffer-rules-assoc)))
1089 (if binding
1090 (setcdr binding rules)
1091 (push (cons buffer-type rules)
1092 gdb-buffer-rules-assoc))))
1094 ;; GUD buffers are an exception to the rules
1095 (gdb-set-buffer-rules 'gdba 'error)
1097 ;; Partial-output buffer : This accumulates output from a command executed on
1098 ;; behalf of emacs (rather than the user).
1100 (gdb-set-buffer-rules 'gdb-partial-output-buffer
1101 'gdb-partial-output-name)
1103 (defun gdb-partial-output-name ()
1104 (concat " *partial-output-"
1105 (gdb-get-target-string)
1106 "*"))
1109 (gdb-set-buffer-rules 'gdb-inferior-io
1110 'gdb-inferior-io-name
1111 'gdb-inferior-io-mode)
1113 (defun gdb-inferior-io-name ()
1114 (concat "*input/output of "
1115 (gdb-get-target-string)
1116 "*"))
1118 (defun gdb-display-separate-io-buffer ()
1119 "Display IO of debugged program in a separate window."
1120 (interactive)
1121 (if gdb-use-separate-io-buffer
1122 (gdb-display-buffer
1123 (gdb-get-buffer-create 'gdb-inferior-io) t)))
1125 (defconst gdb-frame-parameters
1126 '((height . 14) (width . 80)
1127 (unsplittable . t)
1128 (tool-bar-lines . nil)
1129 (menu-bar-lines . nil)
1130 (minibuffer . nil)))
1132 (defun gdb-frame-separate-io-buffer ()
1133 "Display IO of debugged program in a new frame."
1134 (interactive)
1135 (if gdb-use-separate-io-buffer
1136 (let ((special-display-regexps (append special-display-regexps '(".*")))
1137 (special-display-frame-alist gdb-frame-parameters))
1138 (display-buffer (gdb-get-buffer-create 'gdb-inferior-io)))))
1140 (defvar gdb-inferior-io-mode-map
1141 (let ((map (make-sparse-keymap)))
1142 (define-key map "\C-c\C-c" 'gdb-separate-io-interrupt)
1143 (define-key map "\C-c\C-z" 'gdb-separate-io-stop)
1144 (define-key map "\C-c\C-\\" 'gdb-separate-io-quit)
1145 (define-key map "\C-c\C-d" 'gdb-separate-io-eof)
1146 (define-key map "\C-d" 'gdb-separate-io-eof)
1147 map))
1149 (define-derived-mode gdb-inferior-io-mode comint-mode "Inferior I/O"
1150 "Major mode for gdb inferior-io."
1151 :syntax-table nil :abbrev-table nil
1152 ;; We want to use comint because it has various nifty and familiar
1153 ;; features. We don't need a process, but comint wants one, so create
1154 ;; a dummy one.
1155 (make-comint-in-buffer
1156 (substring (buffer-name) 1 (- (length (buffer-name)) 1))
1157 (current-buffer) "hexl")
1158 (setq comint-input-sender 'gdb-inferior-io-sender))
1160 (defun gdb-inferior-io-sender (proc string)
1161 ;; PROC is the pseudo-process created to satisfy comint.
1162 (with-current-buffer (process-buffer proc)
1163 (setq proc (get-buffer-process gud-comint-buffer))
1164 (process-send-string proc string)
1165 (process-send-string proc "\n")))
1167 (defun gdb-separate-io-interrupt ()
1168 "Interrupt the program being debugged."
1169 (interactive)
1170 (interrupt-process
1171 (get-buffer-process gud-comint-buffer) comint-ptyp))
1173 (defun gdb-separate-io-quit ()
1174 "Send quit signal to the program being debugged."
1175 (interactive)
1176 (quit-process
1177 (get-buffer-process gud-comint-buffer) comint-ptyp))
1179 (defun gdb-separate-io-stop ()
1180 "Stop the program being debugged."
1181 (interactive)
1182 (stop-process
1183 (get-buffer-process gud-comint-buffer) comint-ptyp))
1185 (defun gdb-separate-io-eof ()
1186 "Send end-of-file to the program being debugged."
1187 (interactive)
1188 (process-send-eof
1189 (get-buffer-process gud-comint-buffer)))
1192 ;; gdb communications
1195 ;; INPUT: things sent to gdb
1197 ;; The queues are lists. Each element is either a string (indicating user or
1198 ;; user-like input) or a list of the form:
1200 ;; (INPUT-STRING HANDLER-FN)
1202 ;; The handler function will be called from the partial-output buffer when the
1203 ;; command completes. This is the way to write commands which invoke gdb
1204 ;; commands autonomously.
1206 ;; These lists are consumed tail first.
1209 (defun gdb-send (proc string)
1210 "A comint send filter for gdb.
1211 This filter may simply queue input for a later time."
1212 (if gdb-ready
1213 (progn
1214 (with-current-buffer gud-comint-buffer
1215 (let ((inhibit-read-only t))
1216 (remove-text-properties (point-min) (point-max) '(face))))
1217 (if gud-running
1218 (progn
1219 (let ((item (concat string "\n")))
1220 (if gdb-enable-debug (push (cons 'send item) gdb-debug-log))
1221 (process-send-string proc item)))
1222 (if (string-match "\\\\\\'" string)
1223 (setq gdb-continuation (concat gdb-continuation string "\n"))
1224 (let ((item (concat
1225 gdb-continuation string
1226 (if (not comint-input-sender-no-newline) "\n"))))
1227 (gdb-enqueue-input item)
1228 (setq gdb-continuation nil)))))
1229 (push (concat string "\n") gdb-early-user-input)))
1231 ;; Note: Stuff enqueued here will be sent to the next prompt, even if it
1232 ;; is a query, or other non-top-level prompt.
1234 (defun gdb-enqueue-input (item)
1235 (if (not gud-running)
1236 (if gdb-prompting
1237 (progn
1238 (gdb-send-item item)
1239 (setq gdb-prompting nil))
1240 (push item gdb-input-queue))))
1242 (defun gdb-dequeue-input ()
1243 (let ((queue gdb-input-queue))
1244 (if queue
1245 (let ((last (car (last queue))))
1246 (unless (nbutlast queue) (setq gdb-input-queue '()))
1247 last)
1248 ;; This should be nil here anyway but set it just to make sure.
1249 (setq gdb-pending-triggers nil))))
1251 (defun gdb-send-item (item)
1252 (setq gdb-flush-pending-output nil)
1253 (if gdb-enable-debug (push (cons 'send-item item) gdb-debug-log))
1254 (setq gdb-current-item item)
1255 (let ((process (get-buffer-process gud-comint-buffer)))
1256 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer) 'gdba)
1257 (if (stringp item)
1258 (progn
1259 (setq gdb-output-sink 'user)
1260 (process-send-string process item))
1261 (progn
1262 (gdb-clear-partial-output)
1263 (setq gdb-output-sink 'pre-emacs)
1264 (process-send-string process
1265 (car item))))
1266 ;; case: eq gud-minor-mode 'gdbmi
1267 (gdb-clear-partial-output)
1268 (setq gdb-output-sink 'emacs)
1269 (process-send-string process (car item)))))
1272 ;; output -- things gdb prints to emacs
1274 ;; GDB output is a stream interrupted by annotations.
1275 ;; Annotations can be recognized by their beginning
1276 ;; with \C-j\C-z\C-z<tag><opt>\C-j
1278 ;; The tag is a string obeying symbol syntax.
1280 ;; The optional part `<opt>' can be either the empty string
1281 ;; or a space followed by more data relating to the annotation.
1282 ;; For example, the SOURCE annotation is followed by a filename,
1283 ;; line number and various useless goo. This data must not include
1284 ;; any newlines.
1287 (defcustom gud-gdb-command-name "gdb --annotate=3"
1288 "Default command to execute an executable under the GDB debugger.
1289 The option \"--annotate=3\" must be included in this value if you
1290 want the GDB Graphical Interface."
1291 :type 'string
1292 :group 'gud
1293 :version "22.1")
1295 (defvar gdb-annotation-rules
1296 '(("pre-prompt" gdb-pre-prompt)
1297 ("prompt" gdb-prompt)
1298 ("commands" gdb-subprompt)
1299 ("overload-choice" gdb-subprompt)
1300 ("query" gdb-subprompt)
1301 ;; Need this prompt for GDB 6.1
1302 ("nquery" gdb-subprompt)
1303 ("prompt-for-continue" gdb-subprompt)
1304 ("post-prompt" gdb-post-prompt)
1305 ("source" gdb-source)
1306 ("starting" gdb-starting)
1307 ("exited" gdb-exited)
1308 ("signalled" gdb-signalled)
1309 ("signal" gdb-signal)
1310 ("breakpoint" gdb-stopping)
1311 ("watchpoint" gdb-stopping)
1312 ("frame-begin" gdb-frame-begin)
1313 ("stopped" gdb-stopped)
1314 ("error-begin" gdb-error)
1315 ("error" gdb-error)
1316 ("new-thread" (lambda (ignored) (gdb-get-buffer-create 'gdb-threads-buffer))))
1317 "An assoc mapping annotation tags to functions which process them.")
1319 (defun gdb-resync()
1320 (setq gdb-flush-pending-output t)
1321 (setq gud-running nil)
1322 (gdb-force-mode-line-update
1323 (propertize "stopped" 'face font-lock-warning-face))
1324 (setq gdb-output-sink 'user)
1325 (setq gdb-input-queue nil)
1326 (setq gdb-pending-triggers nil)
1327 (setq gdb-prompting t))
1329 (defconst gdb-source-spec-regexp
1330 "\\(.*\\):\\([0-9]*\\):[0-9]*:[a-z]*:0x0*\\([a-f0-9]*\\)")
1332 ;; Do not use this except as an annotation handler.
1333 (defun gdb-source (args)
1334 (string-match gdb-source-spec-regexp args)
1335 ;; Extract the frame position from the marker.
1336 (setq gud-last-frame
1337 (cons
1338 (match-string 1 args)
1339 (string-to-number (match-string 2 args))))
1340 (setq gdb-pc-address (match-string 3 args))
1341 ;; cover for auto-display output which comes *before*
1342 ;; stopped annotation
1343 (if (eq gdb-output-sink 'inferior) (setq gdb-output-sink 'user)))
1345 (defun gdb-pre-prompt (ignored)
1346 "An annotation handler for `pre-prompt'.
1347 This terminates the collection of output from a previous command if that
1348 happens to be in effect."
1349 (setq gdb-error nil)
1350 (let ((sink gdb-output-sink))
1351 (cond
1352 ((eq sink 'user) t)
1353 ((eq sink 'emacs)
1354 (setq gdb-output-sink 'post-emacs))
1356 (gdb-resync)
1357 (error "Phase error in gdb-pre-prompt (got %s)" sink)))))
1359 (defun gdb-prompt (ignored)
1360 "An annotation handler for `prompt'.
1361 This sends the next command (if any) to gdb."
1362 (when gdb-first-prompt
1363 (gdb-force-mode-line-update
1364 (propertize "initializing..." 'face font-lock-variable-name-face))
1365 (gdb-init-1)
1366 (setq gdb-first-prompt nil))
1367 (let ((sink gdb-output-sink))
1368 (cond
1369 ((eq sink 'user) t)
1370 ((eq sink 'post-emacs)
1371 (setq gdb-output-sink 'user)
1372 (let ((handler
1373 (car (cdr gdb-current-item))))
1374 (with-current-buffer (gdb-get-buffer-create 'gdb-partial-output-buffer)
1375 (funcall handler))))
1377 (gdb-resync)
1378 (error "Phase error in gdb-prompt (got %s)" sink))))
1379 (let ((input (gdb-dequeue-input)))
1380 (if input
1381 (gdb-send-item input)
1382 (progn
1383 (setq gdb-prompting t)
1384 (gud-display-frame)
1385 (setq gdb-early-user-input (nreverse gdb-early-user-input))
1386 (while gdb-early-user-input
1387 (gdb-enqueue-input (car gdb-early-user-input))
1388 (setq gdb-early-user-input (cdr gdb-early-user-input)))))))
1390 (defun gdb-subprompt (ignored)
1391 "An annotation handler for non-top-level prompts."
1392 (setq gdb-prompting t))
1394 (defun gdb-starting (ignored)
1395 "An annotation handler for `starting'.
1396 This says that I/O for the subprocess is now the program being debugged,
1397 not GDB."
1398 (setq gdb-active-process t)
1399 (setq gdb-printing t)
1400 (let ((sink gdb-output-sink))
1401 (cond
1402 ((eq sink 'user)
1403 (progn
1404 (setq gud-running t)
1405 (setq gdb-stack-update t)
1406 ;; Temporarily set gud-running to nil to force "info stack" onto queue.
1407 (let ((gud-running nil))
1408 (gdb-invalidate-frames))
1409 (setq gdb-inferior-status "running")
1410 (setq gdb-signalled nil)
1411 (gdb-force-mode-line-update
1412 (propertize gdb-inferior-status 'face font-lock-type-face))
1413 (gdb-remove-text-properties)
1414 (setq gud-old-arrow gud-overlay-arrow-position)
1415 (setq gud-overlay-arrow-position nil)
1416 (setq gdb-overlay-arrow-position nil)
1417 (setq gdb-stack-position nil)
1418 (if gdb-use-separate-io-buffer
1419 (setq gdb-output-sink 'inferior))))
1421 (gdb-resync)
1422 (error "Unexpected `starting' annotation")))))
1424 (defun gdb-signal (ignored)
1425 (setq gdb-inferior-status "signal")
1426 (gdb-force-mode-line-update
1427 (propertize gdb-inferior-status 'face font-lock-warning-face))
1428 (gdb-stopping ignored))
1430 (defun gdb-stopping (ignored)
1431 "An annotation handler for `breakpoint' and other annotations.
1432 They say that I/O for the subprocess is now GDB, not the program
1433 being debugged."
1434 (if gdb-use-separate-io-buffer
1435 (let ((sink gdb-output-sink))
1436 (cond
1437 ((eq sink 'inferior)
1438 (setq gdb-output-sink 'user))
1440 (gdb-resync)
1441 (error "Unexpected stopping annotation"))))))
1443 (defun gdb-exited (ignored)
1444 "An annotation handler for `exited' and `signalled'.
1445 They say that I/O for the subprocess is now GDB, not the program
1446 being debugged and that the program is no longer running. This
1447 function is used to change the focus of GUD tooltips to #define
1448 directives."
1449 (setq gdb-active-process nil)
1450 (setq gud-overlay-arrow-position nil)
1451 (setq gdb-overlay-arrow-position nil)
1452 (setq gdb-stack-position nil)
1453 (setq gud-old-arrow nil)
1454 (setq gdb-inferior-status "exited")
1455 (gdb-force-mode-line-update
1456 (propertize gdb-inferior-status 'face font-lock-warning-face))
1457 (gdb-stopping ignored))
1459 (defun gdb-signalled (ignored)
1460 (setq gdb-signalled t))
1462 (defun gdb-frame-begin (ignored)
1463 (setq gdb-frame-begin t)
1464 (setq gdb-printing nil)
1465 (let ((sink gdb-output-sink))
1466 (cond
1467 ((eq sink 'inferior)
1468 (setq gdb-output-sink 'user))
1469 ((eq sink 'user) t)
1470 ((eq sink 'emacs) t)
1472 (gdb-resync)
1473 (error "Unexpected frame-begin annotation (%S)" sink)))))
1475 (defcustom gdb-same-frame (not focus-follows-mouse)
1476 "Non-nil means pop up GUD buffer in same frame."
1477 :group 'gdb
1478 :type 'boolean
1479 :version "22.1")
1481 (defcustom gdb-find-source-frame nil
1482 "Non-nil means try to find a source frame further up stack e.g after signal."
1483 :group 'gdb
1484 :type 'boolean
1485 :version "22.1")
1487 (defun gdb-find-source-frame (arg)
1488 "Toggle looking for a source frame further up call stack.
1489 The code associated with current (innermost) frame may not have
1490 been compiled with debug information, e.g., C library routine.
1491 With prefix argument ARG, look for a source frame further up
1492 stack to display in the source buffer if ARG is positive,
1493 otherwise don't look further up."
1494 (interactive "P")
1495 (setq gdb-find-source-frame
1496 (if (null arg)
1497 (not gdb-find-source-frame)
1498 (> (prefix-numeric-value arg) 0)))
1499 (message (format "Looking for source frame %sabled"
1500 (if gdb-find-source-frame "en" "dis"))))
1502 (defun gdb-stopped (ignored)
1503 "An annotation handler for `stopped'.
1504 It is just like `gdb-stopping', except that if we already set the output
1505 sink to `user' in `gdb-stopping', that is fine."
1506 (setq gud-running nil)
1507 (unless (or gud-overlay-arrow-position gud-last-frame)
1508 (if (and gdb-frame-begin gdb-printing)
1509 (setq gud-overlay-arrow-position gud-old-arrow)
1510 ;;Pop up GUD buffer to display current frame when it doesn't have source
1511 ;;information i.e if not compiled with -g as with libc routines generally.
1512 (if gdb-same-frame
1513 (gdb-display-gdb-buffer)
1514 (gdb-frame-gdb-buffer))
1515 (if gdb-find-source-frame
1516 ;;Try to find source further up stack e.g after signal.
1517 (setq gdb-look-up-stack
1518 (if (gdb-get-buffer 'gdb-stack-buffer)
1519 'keep
1520 (progn
1521 (gdb-get-buffer-create 'gdb-stack-buffer)
1522 (gdb-invalidate-frames)
1523 'delete))))))
1524 (unless (member gdb-inferior-status '("exited" "signal"))
1525 (setq gdb-active-process t) ;Just for attaching case.
1526 (setq gdb-inferior-status "stopped")
1527 (gdb-force-mode-line-update
1528 (propertize gdb-inferior-status 'face font-lock-warning-face)))
1529 (let ((sink gdb-output-sink))
1530 (cond
1531 ((eq sink 'inferior)
1532 (setq gdb-output-sink 'user))
1533 ((eq sink 'user) t)
1535 (gdb-resync)
1536 (error "Unexpected stopped annotation"))))
1537 (if gdb-signalled (gdb-exited ignored)))
1539 (defun gdb-error (ignored)
1540 (setq gdb-error (not gdb-error)))
1542 (defun gdb-post-prompt (ignored)
1543 "An annotation handler for `post-prompt'.
1544 This begins the collection of output from the current command if that
1545 happens to be appropriate."
1546 ;; Don't add to queue if there outstanding items or gdb-version is not known
1547 ;; yet.
1548 (unless (or gdb-pending-triggers gdb-first-post-prompt)
1549 (gdb-get-selected-frame)
1550 (gdb-invalidate-frames)
1551 ;; Regenerate breakpoints buffer in case it has been inadvertantly deleted.
1552 (gdb-get-buffer-create 'gdb-breakpoints-buffer)
1553 (gdb-invalidate-breakpoints)
1554 ;; Do this through gdb-get-selected-frame -> gdb-frame-handler
1555 ;; so gdb-pc-address is updated.
1556 ;; (gdb-invalidate-assembler)
1558 (if (string-equal gdb-version "pre-6.4")
1559 (gdb-invalidate-registers)
1560 (gdb-get-changed-registers)
1561 (gdb-invalidate-registers-1))
1563 (gdb-invalidate-memory)
1564 (if (string-equal gdb-version "pre-6.4")
1565 (gdb-invalidate-locals)
1566 (gdb-invalidate-locals-1))
1568 (gdb-invalidate-threads)
1569 (unless (or (null gdb-var-list)
1570 (eq system-type 'darwin)) ;Breaks on Darwin's GDB-5.3.
1571 ;; FIXME: with GDB-6 on Darwin, this might very well work.
1572 ;; Only needed/used with speedbar/watch expressions.
1573 (when (and (boundp 'speedbar-frame) (frame-live-p speedbar-frame))
1574 (if (string-equal gdb-version "pre-6.4")
1575 (gdb-var-update)
1576 (gdb-var-update-1)))))
1577 (setq gdb-first-post-prompt nil)
1578 (let ((sink gdb-output-sink))
1579 (cond
1580 ((eq sink 'user) t)
1581 ((eq sink 'pre-emacs)
1582 (setq gdb-output-sink 'emacs))
1584 (gdb-resync)
1585 (error "Phase error in gdb-post-prompt (got %s)" sink)))))
1587 (defconst gdb-buffer-list
1588 '(gdb-stack-buffer gdb-locals-buffer gdb-registers-buffer gdb-threads-buffer))
1590 (defun gdb-remove-text-properties ()
1591 (dolist (buffertype gdb-buffer-list)
1592 (let ((buffer (gdb-get-buffer buffertype)))
1593 (if buffer
1594 (with-current-buffer buffer
1595 (let ((inhibit-read-only t))
1596 (remove-text-properties
1597 (point-min) (point-max) '(mouse-face nil help-echo nil))))))))
1599 ;; GUD displays the selected GDB frame. This might might not be the current
1600 ;; GDB frame (after up, down etc). If no GDB frame is visible but the last
1601 ;; visited breakpoint is, use that window.
1602 (defun gdb-display-source-buffer (buffer)
1603 (let* ((last-window (if gud-last-last-frame
1604 (get-buffer-window
1605 (gud-find-file (car gud-last-last-frame)))))
1606 (source-window (or last-window
1607 (if (and gdb-source-window
1608 (window-live-p gdb-source-window))
1609 gdb-source-window))))
1610 (when source-window
1611 (setq gdb-source-window source-window)
1612 (set-window-buffer source-window buffer))
1613 source-window))
1615 ;; Derived from gud-gdb-marker-regexp
1616 (defvar gdb-fullname-regexp
1617 (concat "\\(.:?[^" ":" "\n]*\\)" ":" "\\([0-9]*\\)" ":" ".*"))
1619 (defun gud-gdba-marker-filter (string)
1620 "A gud marker filter for gdb. Handle a burst of output from GDB."
1621 (if gdb-flush-pending-output
1623 (when gdb-enable-debug
1624 (push (cons 'recv string) gdb-debug-log)
1625 (if (and gdb-debug-log-max
1626 (> (length gdb-debug-log) gdb-debug-log-max))
1627 (setcdr (nthcdr (1- gdb-debug-log-max) gdb-debug-log) nil)))
1628 ;; Recall the left over gud-marker-acc from last time.
1629 (setq gud-marker-acc (concat gud-marker-acc string))
1630 ;; Start accumulating output for the GUD buffer.
1631 (let ((output ""))
1633 ;; Process all the complete markers in this chunk.
1634 (while (string-match "\n\032\032\\(.*\\)\n" gud-marker-acc)
1635 (let ((annotation (match-string 1 gud-marker-acc))
1636 (before (substring gud-marker-acc 0 (match-beginning 0)))
1637 (after (substring gud-marker-acc (match-end 0))))
1639 ;; Parse the tag from the annotation, and maybe its arguments.
1640 (string-match "\\(\\S-*\\) ?\\(.*\\)" annotation)
1641 (let* ((annotation-type (match-string 1 annotation))
1642 (annotation-arguments (match-string 2 annotation))
1643 (annotation-rule (assoc annotation-type
1644 gdb-annotation-rules))
1645 (fullname (string-match gdb-fullname-regexp annotation-type)))
1647 ;; Stuff prior to the match is just ordinary output.
1648 ;; It is either concatenated to OUTPUT or directed
1649 ;; elsewhere.
1650 (setq output
1651 (gdb-concat-output output
1652 (concat before (if fullname "\n"))))
1654 ;; Take that stuff off the gud-marker-acc.
1655 (setq gud-marker-acc after)
1657 ;; Call the handler for this annotation.
1658 (if annotation-rule
1659 (funcall (car (cdr annotation-rule))
1660 annotation-arguments)
1662 ;; Switch to gud-gdb-marker-filter if appropriate.
1663 (when fullname
1665 ;; Extract the frame position from the marker.
1666 (setq gud-last-frame (cons (match-string 1 annotation)
1667 (string-to-number
1668 (match-string 2 annotation))))
1670 (set (make-local-variable 'gud-minor-mode) 'gdb)
1671 (set (make-local-variable 'gud-marker-filter)
1672 'gud-gdb-marker-filter)))
1674 ;; Else the annotation is not recognized. Ignore it silently,
1675 ;; so that GDB can add new annotations without causing
1676 ;; us to blow up.
1679 ;; Does the remaining text end in a partial line?
1680 ;; If it does, then keep part of the gud-marker-acc until we get more.
1681 (if (string-match "\n\\'\\|\n\032\\'\\|\n\032\032.*\\'"
1682 gud-marker-acc)
1683 (progn
1684 ;; Everything before the potential marker start can be output.
1685 (setq output
1686 (gdb-concat-output output
1687 (substring gud-marker-acc 0
1688 (match-beginning 0))))
1690 ;; Everything after, we save, to combine with later input.
1691 (setq gud-marker-acc (substring gud-marker-acc
1692 (match-beginning 0))))
1694 ;; In case we know the gud-marker-acc contains no partial annotations:
1695 (progn
1696 (setq output (gdb-concat-output output gud-marker-acc))
1697 (setq gud-marker-acc "")))
1698 output)))
1700 (defun gdb-concat-output (so-far new)
1701 (if gdb-error
1702 (put-text-property 0 (length new) 'face font-lock-warning-face new))
1703 (let ((sink gdb-output-sink))
1704 (cond
1705 ((eq sink 'user) (concat so-far new))
1706 ((or (eq sink 'pre-emacs) (eq sink 'post-emacs)) so-far)
1707 ((eq sink 'emacs)
1708 (gdb-append-to-partial-output new)
1709 so-far)
1710 ((eq sink 'inferior)
1711 (gdb-append-to-inferior-io new)
1712 so-far)
1714 (gdb-resync)
1715 (error "Bogon output sink %S" sink)))))
1717 (defun gdb-append-to-partial-output (string)
1718 (with-current-buffer (gdb-get-buffer-create 'gdb-partial-output-buffer)
1719 (goto-char (point-max))
1720 (insert string)))
1722 (defun gdb-clear-partial-output ()
1723 (with-current-buffer (gdb-get-buffer-create 'gdb-partial-output-buffer)
1724 (erase-buffer)))
1726 (defun gdb-append-to-inferior-io (string)
1727 (with-current-buffer (gdb-get-buffer-create 'gdb-inferior-io)
1728 (goto-char (point-max))
1729 (insert-before-markers string))
1730 (if (not (string-equal string ""))
1731 (gdb-display-buffer (gdb-get-buffer-create 'gdb-inferior-io) t)))
1733 (defun gdb-clear-inferior-io ()
1734 (with-current-buffer (gdb-get-buffer-create 'gdb-inferior-io)
1735 (erase-buffer)))
1738 ;; One trick is to have a command who's output is always available in a buffer
1739 ;; of it's own, and is always up to date. We build several buffers of this
1740 ;; type.
1742 ;; There are two aspects to this: gdb has to tell us when the output for that
1743 ;; command might have changed, and we have to be able to run the command
1744 ;; behind the user's back.
1746 ;; The output phasing associated with the variable gdb-output-sink
1747 ;; help us to run commands behind the user's back.
1749 ;; Below is the code for specificly managing buffers of output from one
1750 ;; command.
1753 ;; The trigger function is suitable for use in the assoc GDB-ANNOTATION-RULES
1754 ;; It adds an input for the command we are tracking. It should be the
1755 ;; annotation rule binding of whatever gdb sends to tell us this command
1756 ;; might have changed it's output.
1758 ;; NAME is the function name. DEMAND-PREDICATE tests if output is really needed.
1759 ;; GDB-COMMAND is a string of such. OUTPUT-HANDLER is the function bound to the
1760 ;; input in the input queue (see comment about ``gdb communications'' above).
1762 (defmacro def-gdb-auto-update-trigger (name demand-predicate gdb-command
1763 output-handler)
1764 `(defun ,name (&optional ignored)
1765 (if (and ,demand-predicate
1766 (not (member ',name
1767 gdb-pending-triggers)))
1768 (progn
1769 (gdb-enqueue-input
1770 (list ,gdb-command ',output-handler))
1771 (push ',name gdb-pending-triggers)))))
1773 (defmacro def-gdb-auto-update-handler (name trigger buf-key custom-defun)
1774 `(defun ,name ()
1775 (setq gdb-pending-triggers
1776 (delq ',trigger
1777 gdb-pending-triggers))
1778 (let ((buf (gdb-get-buffer ',buf-key)))
1779 (and buf
1780 (with-current-buffer buf
1781 (let* ((window (get-buffer-window buf 0))
1782 (start (window-start window))
1783 (p (window-point window))
1784 (buffer-read-only nil))
1785 (erase-buffer)
1786 (insert-buffer-substring (gdb-get-buffer-create
1787 'gdb-partial-output-buffer))
1788 (set-window-start window start)
1789 (set-window-point window p)))))
1790 ;; put customisation here
1791 (,custom-defun)))
1793 (defmacro def-gdb-auto-updated-buffer (buffer-key
1794 trigger-name gdb-command
1795 output-handler-name custom-defun)
1796 `(progn
1797 (def-gdb-auto-update-trigger ,trigger-name
1798 ;; The demand predicate:
1799 (gdb-get-buffer ',buffer-key)
1800 ,gdb-command
1801 ,output-handler-name)
1802 (def-gdb-auto-update-handler ,output-handler-name
1803 ,trigger-name ,buffer-key ,custom-defun)))
1807 ;; Breakpoint buffer : This displays the output of `info breakpoints'.
1809 (gdb-set-buffer-rules 'gdb-breakpoints-buffer
1810 'gdb-breakpoints-buffer-name
1811 'gdb-breakpoints-mode)
1813 (def-gdb-auto-updated-buffer gdb-breakpoints-buffer
1814 ;; This defines the auto update rule for buffers of type
1815 ;; `gdb-breakpoints-buffer'.
1817 ;; It defines a function to serve as the annotation handler that
1818 ;; handles the `foo-invalidated' message. That function is called:
1819 gdb-invalidate-breakpoints
1821 ;; To update the buffer, this command is sent to gdb.
1822 "server info breakpoints\n"
1824 ;; This also defines a function to be the handler for the output
1825 ;; from the command above. That function will copy the output into
1826 ;; the appropriately typed buffer. That function will be called:
1827 gdb-info-breakpoints-handler
1828 ;; buffer specific functions
1829 gdb-info-breakpoints-custom)
1831 (defconst breakpoint-xpm-data
1832 "/* XPM */
1833 static char *magick[] = {
1834 /* columns rows colors chars-per-pixel */
1835 \"10 10 2 1\",
1836 \" c red\",
1837 \"+ c None\",
1838 /* pixels */
1839 \"+++ +++\",
1840 \"++ ++\",
1841 \"+ +\",
1842 \" \",
1843 \" \",
1844 \" \",
1845 \" \",
1846 \"+ +\",
1847 \"++ ++\",
1848 \"+++ +++\",
1850 "XPM data used for breakpoint icon.")
1852 (defconst breakpoint-enabled-pbm-data
1854 10 10\",
1855 0 0 0 0 1 1 1 1 0 0 0 0
1856 0 0 0 1 1 1 1 1 1 0 0 0
1857 0 0 1 1 1 1 1 1 1 1 0 0
1858 0 1 1 1 1 1 1 1 1 1 1 0
1859 0 1 1 1 1 1 1 1 1 1 1 0
1860 0 1 1 1 1 1 1 1 1 1 1 0
1861 0 1 1 1 1 1 1 1 1 1 1 0
1862 0 0 1 1 1 1 1 1 1 1 0 0
1863 0 0 0 1 1 1 1 1 1 0 0 0
1864 0 0 0 0 1 1 1 1 0 0 0 0"
1865 "PBM data used for enabled breakpoint icon.")
1867 (defconst breakpoint-disabled-pbm-data
1869 10 10\",
1870 0 0 1 0 1 0 1 0 0 0
1871 0 1 0 1 0 1 0 1 0 0
1872 1 0 1 0 1 0 1 0 1 0
1873 0 1 0 1 0 1 0 1 0 1
1874 1 0 1 0 1 0 1 0 1 0
1875 0 1 0 1 0 1 0 1 0 1
1876 1 0 1 0 1 0 1 0 1 0
1877 0 1 0 1 0 1 0 1 0 1
1878 0 0 1 0 1 0 1 0 1 0
1879 0 0 0 1 0 1 0 1 0 0"
1880 "PBM data used for disabled breakpoint icon.")
1882 (defvar breakpoint-enabled-icon nil
1883 "Icon for enabled breakpoint in display margin.")
1885 (defvar breakpoint-disabled-icon nil
1886 "Icon for disabled breakpoint in display margin.")
1888 (and (display-images-p)
1889 ;; Bitmap for breakpoint in fringe
1890 (define-fringe-bitmap 'breakpoint
1891 "\x3c\x7e\xff\xff\xff\xff\x7e\x3c")
1892 ;; Bitmap for gud-overlay-arrow in fringe
1893 (define-fringe-bitmap 'hollow-right-triangle
1894 "\xe0\x90\x88\x84\x84\x88\x90\xe0"))
1896 (defface breakpoint-enabled
1897 '((t
1898 :foreground "red1"
1899 :weight bold))
1900 "Face for enabled breakpoint icon in fringe."
1901 :group 'gdb)
1903 (defface breakpoint-disabled
1904 '((((class color) (min-colors 88)) :foreground "grey70")
1905 ;; Ensure that on low-color displays that we end up something visible.
1906 (((class color) (min-colors 8) (background light))
1907 :foreground "black")
1908 (((class color) (min-colors 8) (background dark))
1909 :foreground "white")
1910 (((type tty) (class mono))
1911 :inverse-video t)
1912 (t :background "gray"))
1913 "Face for disabled breakpoint icon in fringe."
1914 :group 'gdb)
1916 (defconst gdb-breakpoint-regexp
1917 "\\(?:\\([0-9]+\\).*?\\(?:point\\|catch\\s-+\\S-+\\)\\s-+\\S-+\\|\\([0-9]+\\.[0-9]+\\)\\)\\s-+\\(.\\)\\s-+")
1919 ;; Put breakpoint icons in relevant margins (even those set in the GUD buffer).
1920 (defun gdb-info-breakpoints-custom ()
1921 (let ((flag) (bptno))
1922 ;; Remove all breakpoint-icons in source buffers but not assembler buffer.
1923 (dolist (buffer (buffer-list))
1924 (with-current-buffer buffer
1925 (if (and (memq gud-minor-mode '(gdba gdbmi))
1926 (not (string-match "\\` ?\\*.+\\*\\'" (buffer-name))))
1927 (gdb-remove-breakpoint-icons (point-min) (point-max)))))
1928 (with-current-buffer (gdb-get-buffer 'gdb-breakpoints-buffer)
1929 (save-excursion
1930 (let ((buffer-read-only nil))
1931 (goto-char (point-min))
1932 (while (< (point) (- (point-max) 1))
1933 (forward-line 1)
1934 (if (looking-at gdb-breakpoint-regexp)
1935 (progn
1936 (setq bptno (or (match-string 1) (match-string 2)))
1937 (setq flag (char-after (match-beginning 3)))
1938 (if (match-string 1)
1939 (setq gdb-parent-bptno-enabled (eq flag ?y)))
1940 (add-text-properties
1941 (match-beginning 3) (match-end 3)
1942 (if (eq flag ?y)
1943 '(face font-lock-warning-face)
1944 '(face font-lock-type-face)))
1945 (let ((bl (point))
1946 (el (line-end-position)))
1947 (when (re-search-forward " in \\(.*\\) at" el t)
1948 (add-text-properties
1949 (match-beginning 1) (match-end 1)
1950 '(face font-lock-function-name-face)))
1951 (if (re-search-forward
1952 ".*\\s-+\\(\\S-+\\):\\([0-9]+\\)$" nil t)
1953 (let ((line (match-string 2))
1954 (file (match-string 1)))
1955 (add-text-properties bl el
1956 '(mouse-face highlight
1957 help-echo "mouse-2, RET: visit breakpoint"))
1958 (unless (file-exists-p file)
1959 (setq file (cdr (assoc bptno gdb-location-alist))))
1960 (if (and file
1961 (not (string-equal file "File not found")))
1962 (with-current-buffer
1963 (find-file-noselect file 'nowarn)
1964 (gdb-init-buffer)
1965 ;; Only want one breakpoint icon at each
1966 ;; location.
1967 (save-excursion
1968 (goto-line (string-to-number line))
1969 (gdb-put-breakpoint-icon (eq flag ?y) bptno)))
1970 (gdb-enqueue-input
1971 (list
1972 (concat gdb-server-prefix "list "
1973 (match-string-no-properties 1) ":1\n")
1974 'ignore))
1975 (gdb-enqueue-input
1976 (list (concat gdb-server-prefix "info source\n")
1977 `(lambda () (gdb-get-location
1978 ,bptno ,line ,flag))))))
1979 (if (re-search-forward
1980 "<\\(\\(\\sw\\|[_.]\\)+\\)\\(\\+[0-9]+\\)?>"
1981 el t)
1982 (add-text-properties
1983 (match-beginning 1) (match-end 1)
1984 '(face font-lock-function-name-face))
1985 (end-of-line)
1986 (re-search-backward "\\s-\\(\\S-*\\)"
1987 bl t)
1988 (add-text-properties
1989 (match-beginning 1) (match-end 1)
1990 '(face font-lock-variable-name-face)))))))
1991 (end-of-line))))))
1992 (if (gdb-get-buffer 'gdb-assembler-buffer) (gdb-assembler-custom))
1994 ;; Breakpoints buffer is always present. Hack to just update
1995 ;; current frame if there's been no execution.
1996 (if gdb-stack-update
1997 (setq gdb-stack-update nil)
1998 (if (gdb-get-buffer 'gdb-stack-buffer) (gdb-info-stack-custom))))
2000 (declare-function gud-remove "gdb-ui" t t) ; gud-def
2001 (declare-function gud-break "gdb-ui" t t) ; gud-def
2003 (defun gdb-mouse-set-clear-breakpoint (event)
2004 "Set/clear breakpoint in left fringe/margin at mouse click.
2005 If not in a source or disassembly buffer just set point."
2006 (interactive "e")
2007 (mouse-minibuffer-check event)
2008 (let ((posn (event-end event)))
2009 (with-selected-window (posn-window posn)
2010 (if (or (buffer-file-name) (eq major-mode 'gdb-assembler-mode))
2011 (if (numberp (posn-point posn))
2012 (save-excursion
2013 (goto-char (posn-point posn))
2014 (if (or (posn-object posn)
2015 (eq (car (fringe-bitmaps-at-pos (posn-point posn)))
2016 'breakpoint))
2017 (gud-remove nil)
2018 (gud-break nil)))))
2019 (posn-set-point posn))))
2021 (defun gdb-mouse-toggle-breakpoint-margin (event)
2022 "Enable/disable breakpoint in left margin with mouse click."
2023 (interactive "e")
2024 (mouse-minibuffer-check event)
2025 (let ((posn (event-end event)))
2026 (if (numberp (posn-point posn))
2027 (with-selected-window (posn-window posn)
2028 (save-excursion
2029 (goto-char (posn-point posn))
2030 (if (posn-object posn)
2031 (let* ((bptno (get-text-property
2032 0 'gdb-bptno (car (posn-string posn)))))
2033 (string-match "\\([0-9+]\\)*" bptno)
2034 (gdb-enqueue-input
2035 (list
2036 (concat gdb-server-prefix
2037 (if (get-text-property
2038 0 'gdb-enabled (car (posn-string posn)))
2039 "disable "
2040 "enable ")
2041 (match-string 1 bptno) "\n")
2042 'ignore)))))))))
2044 (defun gdb-mouse-toggle-breakpoint-fringe (event)
2045 "Enable/disable breakpoint in left fringe with mouse click."
2046 (interactive "e")
2047 (mouse-minibuffer-check event)
2048 (let* ((posn (event-end event))
2049 (pos (posn-point posn))
2050 obj)
2051 (when (numberp pos)
2052 (with-selected-window (posn-window posn)
2053 (save-excursion
2054 (set-buffer (window-buffer (selected-window)))
2055 (goto-char pos)
2056 (dolist (overlay (overlays-in pos pos))
2057 (when (overlay-get overlay 'put-break)
2058 (setq obj (overlay-get overlay 'before-string))))
2059 (when (stringp obj)
2060 (let* ((bptno (get-text-property 0 'gdb-bptno obj)))
2061 (string-match "\\([0-9+]\\)*" bptno)
2062 (gdb-enqueue-input
2063 (list
2064 (concat gdb-server-prefix
2065 (if (get-text-property 0 'gdb-enabled obj)
2066 "disable "
2067 "enable ")
2068 (match-string 1 bptno) "\n")
2069 'ignore)))))))))
2071 (defun gdb-breakpoints-buffer-name ()
2072 (with-current-buffer gud-comint-buffer
2073 (concat "*breakpoints of " (gdb-get-target-string) "*")))
2075 (defun gdb-display-breakpoints-buffer ()
2076 "Display status of user-settable breakpoints."
2077 (interactive)
2078 (gdb-display-buffer
2079 (gdb-get-buffer-create 'gdb-breakpoints-buffer) t))
2081 (defun gdb-frame-breakpoints-buffer ()
2082 "Display status of user-settable breakpoints in a new frame."
2083 (interactive)
2084 (let ((special-display-regexps (append special-display-regexps '(".*")))
2085 (special-display-frame-alist gdb-frame-parameters))
2086 (display-buffer (gdb-get-buffer-create 'gdb-breakpoints-buffer))))
2088 (defvar gdb-breakpoints-mode-map
2089 (let ((map (make-sparse-keymap))
2090 (menu (make-sparse-keymap "Breakpoints")))
2091 (define-key menu [quit] '("Quit" . gdb-delete-frame-or-window))
2092 (define-key menu [goto] '("Goto" . gdb-goto-breakpoint))
2093 (define-key menu [delete] '("Delete" . gdb-delete-breakpoint))
2094 (define-key menu [toggle] '("Toggle" . gdb-toggle-breakpoint))
2095 (suppress-keymap map)
2096 (define-key map [menu-bar breakpoints] (cons "Breakpoints" menu))
2097 (define-key map " " 'gdb-toggle-breakpoint)
2098 (define-key map "D" 'gdb-delete-breakpoint)
2099 ;; Don't bind "q" to kill-this-buffer as we need it for breakpoint icons.
2100 (define-key map "q" 'gdb-delete-frame-or-window)
2101 (define-key map "\r" 'gdb-goto-breakpoint)
2102 (define-key map [mouse-2] 'gdb-goto-breakpoint)
2103 (define-key map [follow-link] 'mouse-face)
2104 map))
2106 (defun gdb-delete-frame-or-window ()
2107 "Delete frame if there is only one window. Otherwise delete the window."
2108 (interactive)
2109 (if (one-window-p) (delete-frame)
2110 (delete-window)))
2112 ;;from make-mode-line-mouse-map
2113 (defun gdb-make-header-line-mouse-map (mouse function) "\
2114 Return a keymap with single entry for mouse key MOUSE on the header line.
2115 MOUSE is defined to run function FUNCTION with no args in the buffer
2116 corresponding to the mode line clicked."
2117 (let ((map (make-sparse-keymap)))
2118 (define-key map (vector 'header-line mouse) function)
2119 (define-key map (vector 'header-line 'down-mouse-1) 'ignore)
2120 map))
2122 (defvar gdb-breakpoints-header
2123 `(,(propertize "Breakpoints"
2124 'help-echo "mouse-1: select"
2125 'mouse-face 'mode-line-highlight
2126 'face 'mode-line
2127 'local-map
2128 (gdb-make-header-line-mouse-map
2129 'mouse-1
2130 (lambda (event) (interactive "e")
2131 (save-selected-window
2132 (select-window (posn-window (event-start event)))
2133 (set-window-dedicated-p (selected-window) nil)
2134 (switch-to-buffer
2135 (gdb-get-buffer-create 'gdb-breakpoints-buffer))
2136 (set-window-dedicated-p (selected-window) t)))))
2138 ,(propertize "Threads"
2139 'help-echo "mouse-1: select"
2140 'mouse-face 'mode-line-highlight
2141 'face 'mode-line
2142 'local-map
2143 (gdb-make-header-line-mouse-map
2144 'mouse-1
2145 (lambda (event) (interactive "e")
2146 (save-selected-window
2147 (select-window (posn-window (event-start event)))
2148 (set-window-dedicated-p (selected-window) nil)
2149 (switch-to-buffer
2150 (gdb-get-buffer-create 'gdb-threads-buffer))
2151 (set-window-dedicated-p (selected-window) t)))))))
2153 (defun gdb-breakpoints-mode ()
2154 "Major mode for gdb breakpoints.
2156 \\{gdb-breakpoints-mode-map}"
2157 (kill-all-local-variables)
2158 (setq major-mode 'gdb-breakpoints-mode)
2159 (setq mode-name "Breakpoints")
2160 (use-local-map gdb-breakpoints-mode-map)
2161 (setq buffer-read-only t)
2162 (buffer-disable-undo)
2163 (setq header-line-format gdb-breakpoints-header)
2164 (run-mode-hooks 'gdb-breakpoints-mode-hook)
2165 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer) 'gdba)
2166 'gdb-invalidate-breakpoints
2167 'gdbmi-invalidate-breakpoints))
2169 (defun gdb-toggle-breakpoint ()
2170 "Enable/disable breakpoint at current line."
2171 (interactive)
2172 (save-excursion
2173 (beginning-of-line 1)
2174 (if (looking-at gdb-breakpoint-regexp)
2175 (gdb-enqueue-input
2176 (list
2177 (concat gdb-server-prefix
2178 (if (eq ?y (char-after (match-beginning 3)))
2179 "disable "
2180 "enable ")
2181 (or (match-string 1) (match-string 2)) "\n") 'ignore))
2182 (error "Not recognized as break/watchpoint line"))))
2184 (defun gdb-delete-breakpoint ()
2185 "Delete the breakpoint at current line."
2186 (interactive)
2187 (save-excursion
2188 (beginning-of-line 1)
2189 (if (looking-at gdb-breakpoint-regexp)
2190 (if (match-string 1)
2191 (gdb-enqueue-input
2192 (list
2193 (concat gdb-server-prefix "delete " (match-string 1) "\n")
2194 'ignore))
2195 (message-box "This breakpoint cannot be deleted on its own."))
2196 (error "Not recognized as break/watchpoint line"))))
2198 (defun gdb-goto-breakpoint (&optional event)
2199 "Display the breakpoint location specified at current line."
2200 (interactive (list last-input-event))
2201 (if event (posn-set-point (event-end event)))
2202 (save-excursion
2203 (beginning-of-line 1)
2204 (if (looking-at "\\([0-9]+\\.?[0-9]*\\) .*\\s-+\\(\\S-+\\):\\([0-9]+\\)$")
2205 (let ((bptno (match-string 1))
2206 (file (match-string 2))
2207 (line (match-string 3)))
2208 (save-selected-window
2209 (let* ((buffer (find-file-noselect
2210 (if (file-exists-p file) file
2211 (cdr (assoc bptno gdb-location-alist)))))
2212 (window (or (gdb-display-source-buffer buffer)
2213 (display-buffer buffer))))
2214 (setq gdb-source-window window)
2215 (with-current-buffer buffer
2216 (goto-line (string-to-number line))
2217 (set-window-point window (point))))))
2218 (error "No location specified."))))
2221 ;; Frames buffer. This displays a perpetually correct backtrace
2222 ;; (from the command `where').
2224 ;; Alas, if your stack is deep, it is costly.
2226 (defcustom gdb-max-frames 40
2227 "Maximum number of frames displayed in call stack."
2228 :type 'integer
2229 :group 'gdb
2230 :version "22.1")
2232 (gdb-set-buffer-rules 'gdb-stack-buffer
2233 'gdb-stack-buffer-name
2234 'gdb-frames-mode)
2236 (def-gdb-auto-updated-buffer gdb-stack-buffer
2237 gdb-invalidate-frames
2238 (concat "server info stack " (number-to-string gdb-max-frames) "\n")
2239 gdb-info-stack-handler
2240 gdb-info-stack-custom)
2242 ;; This may be more important for embedded targets where unwinding the
2243 ;; stack may take a long time.
2244 (defadvice gdb-invalidate-frames (around gdb-invalidate-frames-advice
2245 (&optional ignored) activate compile)
2246 "Only queue \"info stack\" if execution has occurred."
2247 (if gdb-stack-update ad-do-it))
2249 (defun gdb-info-stack-custom ()
2250 (with-current-buffer (gdb-get-buffer 'gdb-stack-buffer)
2251 (let (move-to)
2252 (save-excursion
2253 (unless (eq gdb-look-up-stack 'delete)
2254 (let ((buffer-read-only nil)
2255 bl el)
2256 (goto-char (point-min))
2257 (while (< (point) (point-max))
2258 (setq bl (line-beginning-position)
2259 el (line-end-position))
2260 (when (looking-at "#")
2261 (add-text-properties bl el
2262 '(mouse-face highlight
2263 help-echo "mouse-2, RET: Select frame")))
2264 (goto-char bl)
2265 (when (looking-at "^#\\([0-9]+\\)")
2266 (when (string-equal (match-string 1) gdb-frame-number)
2267 (if (gud-tool-bar-item-visible-no-fringe)
2268 (progn
2269 (put-text-property bl (+ bl 4)
2270 'face '(:inverse-video t))
2271 (setq move-to bl))
2272 (or gdb-stack-position
2273 (setq gdb-stack-position (make-marker)))
2274 (set-marker gdb-stack-position (point))
2275 (setq move-to gdb-stack-position)))
2276 (when (re-search-forward "\\([^ ]+\\) (" el t)
2277 (put-text-property (match-beginning 1) (match-end 1)
2278 'face font-lock-function-name-face)
2279 (setq bl (match-end 0))
2280 (while (re-search-forward "<\\([^>]+\\)>" el t)
2281 (put-text-property (match-beginning 1) (match-end 1)
2282 'face font-lock-function-name-face))
2283 (goto-char bl)
2284 (while (re-search-forward "\\(\\(\\sw\\|[_.]\\)+\\)=" el t)
2285 (put-text-property (match-beginning 1) (match-end 1)
2286 'face font-lock-variable-name-face))))
2287 (forward-line 1))
2288 (forward-line -1)
2289 (when (looking-at "(More stack frames follow...)")
2290 (add-text-properties
2291 (match-beginning 0) (match-end 0)
2292 '(mouse-face highlight
2293 gdb-max-frames t
2294 help-echo
2295 "mouse-2, RET: customize gdb-max-frames to see more frames"
2296 )))))
2297 (when gdb-look-up-stack
2298 (goto-char (point-min))
2299 (when (re-search-forward "\\(\\S-+?\\):\\([0-9]+\\)" nil t)
2300 (let ((start (line-beginning-position))
2301 (file (match-string 1))
2302 (line (match-string 2)))
2303 (re-search-backward "^#*\\([0-9]+\\)" start t)
2304 (gdb-enqueue-input
2305 (list (concat gdb-server-prefix "frame "
2306 (match-string 1) "\n") 'gdb-set-hollow))
2307 (gdb-enqueue-input
2308 (list (concat gdb-server-prefix "frame 0\n") 'ignore))))))
2309 (when move-to
2310 (let ((window (get-buffer-window (current-buffer) 0)))
2311 (when window
2312 (with-selected-window window
2313 (goto-char move-to)
2314 (unless (pos-visible-in-window-p)
2315 (recenter '(center)))))))))
2316 (if (eq gdb-look-up-stack 'delete)
2317 (kill-buffer (gdb-get-buffer 'gdb-stack-buffer)))
2318 (setq gdb-look-up-stack nil))
2320 (defun gdb-set-hollow ()
2321 (if gud-last-last-frame
2322 (with-current-buffer (gud-find-file (car gud-last-last-frame))
2323 (setq fringe-indicator-alist
2324 '((overlay-arrow . hollow-right-triangle))))))
2326 (defun gdb-stack-buffer-name ()
2327 (with-current-buffer gud-comint-buffer
2328 (concat "*stack frames of " (gdb-get-target-string) "*")))
2330 (defun gdb-display-stack-buffer ()
2331 "Display backtrace of current stack."
2332 (interactive)
2333 (gdb-display-buffer
2334 (gdb-get-buffer-create 'gdb-stack-buffer) t))
2336 (defun gdb-frame-stack-buffer ()
2337 "Display backtrace of current stack in a new frame."
2338 (interactive)
2339 (let ((special-display-regexps (append special-display-regexps '(".*")))
2340 (special-display-frame-alist gdb-frame-parameters))
2341 (display-buffer (gdb-get-buffer-create 'gdb-stack-buffer))))
2343 (defvar gdb-frames-mode-map
2344 (let ((map (make-sparse-keymap)))
2345 (suppress-keymap map)
2346 (define-key map "q" 'kill-this-buffer)
2347 (define-key map "\r" 'gdb-frames-select)
2348 (define-key map "F" 'gdb-frames-force-update)
2349 (define-key map [mouse-2] 'gdb-frames-select)
2350 (define-key map [follow-link] 'mouse-face)
2351 map))
2353 (declare-function gdbmi-invalidate-frames "ext:gdb-mi" nil t)
2355 (defun gdb-frames-force-update ()
2356 "Force update of call stack.
2357 Use when the displayed call stack gets out of sync with the
2358 actual one, e.g after using the Gdb command \"return\" or setting
2359 $pc directly from the GUD buffer. This command isn't normally needed."
2360 (interactive)
2361 (setq gdb-stack-update t)
2362 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer) 'gdba)
2363 (gdb-invalidate-frames)
2364 (gdbmi-invalidate-frames)))
2366 (defun gdb-frames-mode ()
2367 "Major mode for gdb call stack.
2369 \\{gdb-frames-mode-map}"
2370 (kill-all-local-variables)
2371 (setq major-mode 'gdb-frames-mode)
2372 (setq mode-name "Frames")
2373 (setq gdb-stack-position nil)
2374 (add-to-list 'overlay-arrow-variable-list 'gdb-stack-position)
2375 (setq truncate-lines t) ;; Make it easier to see overlay arrow.
2376 (setq buffer-read-only t)
2377 (buffer-disable-undo)
2378 (gdb-thread-identification)
2379 (use-local-map gdb-frames-mode-map)
2380 (run-mode-hooks 'gdb-frames-mode-hook)
2381 (setq gdb-stack-update t)
2382 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer) 'gdba)
2383 'gdb-invalidate-frames
2384 'gdbmi-invalidate-frames))
2386 (defun gdb-get-frame-number ()
2387 (save-excursion
2388 (end-of-line)
2389 (let* ((start (line-beginning-position))
2390 (pos (re-search-backward "^#*\\([0-9]+\\)" start t))
2391 (n (or (and pos (match-string 1)) "0")))
2392 n)))
2394 (defun gdb-frames-select (&optional event)
2395 "Select the frame and display the relevant source."
2396 (interactive (list last-input-event))
2397 (if event (posn-set-point (event-end event)))
2398 (if (get-text-property (point) 'gdb-max-frames)
2399 (progn
2400 (message-box "After setting gdb-max-frames, you need to enter\n\
2401 another GDB command e.g pwd, to see new frames")
2402 (customize-variable-other-window 'gdb-max-frames))
2403 (gdb-enqueue-input
2404 (list (concat gdb-server-prefix "frame "
2405 (gdb-get-frame-number) "\n") 'ignore))))
2408 ;; Threads buffer. This displays a selectable thread list.
2410 (gdb-set-buffer-rules 'gdb-threads-buffer
2411 'gdb-threads-buffer-name
2412 'gdb-threads-mode)
2414 (def-gdb-auto-updated-buffer gdb-threads-buffer
2415 gdb-invalidate-threads
2416 (concat gdb-server-prefix "info threads\n")
2417 gdb-info-threads-handler
2418 gdb-info-threads-custom)
2420 (defun gdb-info-threads-custom ()
2421 (with-current-buffer (gdb-get-buffer 'gdb-threads-buffer)
2422 (let ((buffer-read-only nil))
2423 (save-excursion
2424 (goto-char (point-min))
2425 (if (re-search-forward "\\* \\([0-9]+\\)" nil t)
2426 (setq gdb-thread-indicator
2427 (propertize (concat " [" (match-string 1) "]")
2428 ; FIXME: this help-echo doesn't work
2429 'help-echo "thread id")))
2430 (goto-char (point-min))
2431 (while (< (point) (point-max))
2432 (unless (looking-at "No ")
2433 (add-text-properties (line-beginning-position) (line-end-position)
2434 '(mouse-face highlight
2435 help-echo "mouse-2, RET: select thread")))
2436 (forward-line 1))))))
2438 (defun gdb-threads-buffer-name ()
2439 (with-current-buffer gud-comint-buffer
2440 (concat "*threads of " (gdb-get-target-string) "*")))
2442 (defun gdb-display-threads-buffer ()
2443 "Display IDs of currently known threads."
2444 (interactive)
2445 (gdb-display-buffer
2446 (gdb-get-buffer-create 'gdb-threads-buffer) t))
2448 (defun gdb-frame-threads-buffer ()
2449 "Display IDs of currently known threads in a new frame."
2450 (interactive)
2451 (let ((special-display-regexps (append special-display-regexps '(".*")))
2452 (special-display-frame-alist gdb-frame-parameters))
2453 (display-buffer (gdb-get-buffer-create 'gdb-threads-buffer))))
2455 (defvar gdb-threads-mode-map
2456 (let ((map (make-sparse-keymap)))
2457 (suppress-keymap map)
2458 (define-key map "q" 'kill-this-buffer)
2459 (define-key map "\r" 'gdb-threads-select)
2460 (define-key map [mouse-2] 'gdb-threads-select)
2461 (define-key map [follow-link] 'mouse-face)
2462 map))
2464 (defvar gdb-threads-font-lock-keywords
2465 '((") +\\([^ ]+\\) (" (1 font-lock-function-name-face))
2466 ("in \\([^ ]+\\) (" (1 font-lock-function-name-face))
2467 ("\\(\\(\\sw\\|[_.]\\)+\\)=" (1 font-lock-variable-name-face)))
2468 "Font lock keywords used in `gdb-threads-mode'.")
2470 (defun gdb-threads-mode ()
2471 "Major mode for gdb threads.
2473 \\{gdb-threads-mode-map}"
2474 (kill-all-local-variables)
2475 (setq major-mode 'gdb-threads-mode)
2476 (setq mode-name "Threads")
2477 (setq buffer-read-only t)
2478 (buffer-disable-undo)
2479 (setq header-line-format gdb-breakpoints-header)
2480 (use-local-map gdb-threads-mode-map)
2481 (set (make-local-variable 'font-lock-defaults)
2482 '(gdb-threads-font-lock-keywords))
2483 (run-mode-hooks 'gdb-threads-mode-hook)
2484 ;; Force "info threads" onto queue.
2485 (lambda () (let ((gud-running nil)) (gdb-invalidate-threads))))
2487 (defun gdb-get-thread-number ()
2488 (save-excursion
2489 (re-search-backward "^\\s-*\\([0-9]*\\)" nil t)
2490 (match-string-no-properties 1)))
2492 (defun gdb-threads-select (&optional event)
2493 "Select the thread and display the relevant source."
2494 (interactive (list last-input-event))
2495 (if event (posn-set-point (event-end event)))
2496 (gdb-enqueue-input
2497 (list (concat gdb-server-prefix "thread "
2498 (gdb-get-thread-number) "\n") 'ignore))
2499 (gud-display-frame))
2501 (defun gdb-thread-identification ()
2502 (setq mode-line-buffer-identification
2503 (list (car mode-line-buffer-identification)
2504 '(gdb-thread-indicator gdb-thread-indicator))))
2506 ;; Registers buffer.
2508 (defcustom gdb-all-registers nil
2509 "Non-nil means include floating-point registers."
2510 :type 'boolean
2511 :group 'gdb
2512 :version "22.1")
2514 (gdb-set-buffer-rules 'gdb-registers-buffer
2515 'gdb-registers-buffer-name
2516 'gdb-registers-mode)
2518 (def-gdb-auto-updated-buffer gdb-registers-buffer
2519 gdb-invalidate-registers
2520 (concat
2521 gdb-server-prefix "info " (if gdb-all-registers "all-") "registers\n")
2522 gdb-info-registers-handler
2523 gdb-info-registers-custom)
2525 (defun gdb-info-registers-custom ()
2526 (with-current-buffer (gdb-get-buffer 'gdb-registers-buffer)
2527 (save-excursion
2528 (let ((buffer-read-only nil)
2529 start end)
2530 (goto-char (point-min))
2531 (while (< (point) (point-max))
2532 (setq start (line-beginning-position))
2533 (setq end (line-end-position))
2534 (when (looking-at "^[^ ]+")
2535 (unless (string-equal (match-string 0) "The")
2536 (put-text-property start (match-end 0)
2537 'face font-lock-variable-name-face)
2538 (add-text-properties start end
2539 '(help-echo "mouse-2: edit value"
2540 mouse-face highlight))))
2541 (forward-line 1))))))
2543 (defun gdb-edit-register-value (&optional event)
2544 (interactive (list last-input-event))
2545 (save-excursion
2546 (if event (posn-set-point (event-end event)))
2547 (beginning-of-line)
2548 (let* ((register (current-word))
2549 (value (read-string (format "New value (%s): " register))))
2550 (gdb-enqueue-input
2551 (list (concat gdb-server-prefix "set $" register "=" value "\n")
2552 'ignore)))))
2554 (defvar gdb-registers-mode-map
2555 (let ((map (make-sparse-keymap)))
2556 (suppress-keymap map)
2557 (define-key map "\r" 'gdb-edit-register-value)
2558 (define-key map [mouse-2] 'gdb-edit-register-value)
2559 (define-key map " " 'gdb-all-registers)
2560 (define-key map "q" 'kill-this-buffer)
2561 map))
2563 (defvar gdb-locals-header
2564 `(,(propertize "Locals"
2565 'help-echo "mouse-1: select"
2566 'mouse-face 'mode-line-highlight
2567 'face 'mode-line
2568 'local-map
2569 (gdb-make-header-line-mouse-map
2570 'mouse-1
2571 (lambda (event) (interactive "e")
2572 (save-selected-window
2573 (select-window (posn-window (event-start event)))
2574 (set-window-dedicated-p (selected-window) nil)
2575 (switch-to-buffer
2576 (gdb-get-buffer-create 'gdb-locals-buffer))
2577 (set-window-dedicated-p (selected-window) t)))))
2579 ,(propertize "Registers"
2580 'help-echo "mouse-1: select"
2581 'mouse-face 'mode-line-highlight
2582 'face 'mode-line
2583 'local-map
2584 (gdb-make-header-line-mouse-map
2585 'mouse-1
2586 (lambda (event) (interactive "e")
2587 (save-selected-window
2588 (select-window (posn-window (event-start event)))
2589 (set-window-dedicated-p (selected-window) nil)
2590 (switch-to-buffer
2591 (gdb-get-buffer-create 'gdb-registers-buffer))
2592 (set-window-dedicated-p (selected-window) t)))))))
2594 (defun gdb-registers-mode ()
2595 "Major mode for gdb registers.
2597 \\{gdb-registers-mode-map}"
2598 (kill-all-local-variables)
2599 (setq major-mode 'gdb-registers-mode)
2600 (setq mode-name "Registers")
2601 (setq header-line-format gdb-locals-header)
2602 (setq buffer-read-only t)
2603 (buffer-disable-undo)
2604 (gdb-thread-identification)
2605 (use-local-map gdb-registers-mode-map)
2606 (run-mode-hooks 'gdb-registers-mode-hook)
2607 (if (string-equal gdb-version "pre-6.4")
2608 (progn
2609 (if gdb-all-registers (setq mode-name "Registers:All"))
2610 'gdb-invalidate-registers)
2611 'gdb-invalidate-registers-1))
2613 (defun gdb-registers-buffer-name ()
2614 (with-current-buffer gud-comint-buffer
2615 (concat "*registers of " (gdb-get-target-string) "*")))
2617 (defun gdb-display-registers-buffer ()
2618 "Display integer register contents."
2619 (interactive)
2620 (gdb-display-buffer
2621 (gdb-get-buffer-create 'gdb-registers-buffer) t))
2623 (defun gdb-frame-registers-buffer ()
2624 "Display integer register contents in a new frame."
2625 (interactive)
2626 (let ((special-display-regexps (append special-display-regexps '(".*")))
2627 (special-display-frame-alist gdb-frame-parameters))
2628 (display-buffer (gdb-get-buffer-create 'gdb-registers-buffer))))
2630 (defun gdb-all-registers ()
2631 "Toggle the display of floating-point registers (pre GDB 6.4 only)."
2632 (interactive)
2633 (when (string-equal gdb-version "pre-6.4")
2634 (if gdb-all-registers
2635 (progn
2636 (setq gdb-all-registers nil)
2637 (with-current-buffer (gdb-get-buffer-create 'gdb-registers-buffer)
2638 (setq mode-name "Registers")))
2639 (setq gdb-all-registers t)
2640 (with-current-buffer (gdb-get-buffer-create 'gdb-registers-buffer)
2641 (setq mode-name "Registers:All")))
2642 (message (format "Display of floating-point registers %sabled"
2643 (if gdb-all-registers "en" "dis")))
2644 (gdb-invalidate-registers)))
2647 ;; Memory buffer.
2649 (defcustom gdb-memory-repeat-count 32
2650 "Number of data items in memory window."
2651 :type 'integer
2652 :group 'gdb
2653 :version "22.1")
2655 (defcustom gdb-memory-format "x"
2656 "Display format of data items in memory window."
2657 :type '(choice (const :tag "Hexadecimal" "x")
2658 (const :tag "Signed decimal" "d")
2659 (const :tag "Unsigned decimal" "u")
2660 (const :tag "Octal" "o")
2661 (const :tag "Binary" "t"))
2662 :group 'gdb
2663 :version "22.1")
2665 (defcustom gdb-memory-unit "w"
2666 "Unit size of data items in memory window."
2667 :type '(choice (const :tag "Byte" "b")
2668 (const :tag "Halfword" "h")
2669 (const :tag "Word" "w")
2670 (const :tag "Giant word" "g"))
2671 :group 'gdb
2672 :version "22.1")
2674 (gdb-set-buffer-rules 'gdb-memory-buffer
2675 'gdb-memory-buffer-name
2676 'gdb-memory-mode)
2678 (def-gdb-auto-updated-buffer gdb-memory-buffer
2679 gdb-invalidate-memory
2680 (concat gdb-server-prefix "x/" (number-to-string gdb-memory-repeat-count)
2681 gdb-memory-format gdb-memory-unit " " gdb-memory-address "\n")
2682 gdb-read-memory-handler
2683 gdb-read-memory-custom)
2685 (defun gdb-read-memory-custom ()
2686 (save-excursion
2687 (goto-char (point-min))
2688 (if (looking-at "0x[[:xdigit:]]+")
2689 (setq gdb-memory-address (match-string 0)))))
2691 (defvar gdb-memory-mode-map
2692 (let ((map (make-sparse-keymap)))
2693 (suppress-keymap map)
2694 (define-key map "q" 'kill-this-buffer)
2695 map))
2697 (defun gdb-memory-set-address (event)
2698 "Set the start memory address."
2699 (interactive "e")
2700 (save-selected-window
2701 (select-window (posn-window (event-start event)))
2702 (let ((arg (read-from-minibuffer "Memory address: ")))
2703 (setq gdb-memory-address arg))
2704 (gdb-invalidate-memory)))
2706 (defun gdb-memory-set-repeat-count (event)
2707 "Set the number of data items in memory window."
2708 (interactive "e")
2709 (save-selected-window
2710 (select-window (posn-window (event-start event)))
2711 (let* ((arg (read-from-minibuffer "Repeat count: "))
2712 (count (string-to-number arg)))
2713 (if (<= count 0)
2714 (error "Positive numbers only")
2715 (customize-set-variable 'gdb-memory-repeat-count count)
2716 (gdb-invalidate-memory)))))
2718 (defun gdb-memory-format-binary ()
2719 "Set the display format to binary."
2720 (interactive)
2721 (customize-set-variable 'gdb-memory-format "t")
2722 (gdb-invalidate-memory))
2724 (defun gdb-memory-format-octal ()
2725 "Set the display format to octal."
2726 (interactive)
2727 (customize-set-variable 'gdb-memory-format "o")
2728 (gdb-invalidate-memory))
2730 (defun gdb-memory-format-unsigned ()
2731 "Set the display format to unsigned decimal."
2732 (interactive)
2733 (customize-set-variable 'gdb-memory-format "u")
2734 (gdb-invalidate-memory))
2736 (defun gdb-memory-format-signed ()
2737 "Set the display format to decimal."
2738 (interactive)
2739 (customize-set-variable 'gdb-memory-format "d")
2740 (gdb-invalidate-memory))
2742 (defun gdb-memory-format-hexadecimal ()
2743 "Set the display format to hexadecimal."
2744 (interactive)
2745 (customize-set-variable 'gdb-memory-format "x")
2746 (gdb-invalidate-memory))
2748 (defvar gdb-memory-format-map
2749 (let ((map (make-sparse-keymap)))
2750 (define-key map [header-line down-mouse-3] 'gdb-memory-format-menu-1)
2751 map)
2752 "Keymap to select format in the header line.")
2754 (defvar gdb-memory-format-menu (make-sparse-keymap "Format")
2755 "Menu of display formats in the header line.")
2757 (define-key gdb-memory-format-menu [binary]
2758 '(menu-item "Binary" gdb-memory-format-binary
2759 :button (:radio . (equal gdb-memory-format "t"))))
2760 (define-key gdb-memory-format-menu [octal]
2761 '(menu-item "Octal" gdb-memory-format-octal
2762 :button (:radio . (equal gdb-memory-format "o"))))
2763 (define-key gdb-memory-format-menu [unsigned]
2764 '(menu-item "Unsigned Decimal" gdb-memory-format-unsigned
2765 :button (:radio . (equal gdb-memory-format "u"))))
2766 (define-key gdb-memory-format-menu [signed]
2767 '(menu-item "Signed Decimal" gdb-memory-format-signed
2768 :button (:radio . (equal gdb-memory-format "d"))))
2769 (define-key gdb-memory-format-menu [hexadecimal]
2770 '(menu-item "Hexadecimal" gdb-memory-format-hexadecimal
2771 :button (:radio . (equal gdb-memory-format "x"))))
2773 (defun gdb-memory-format-menu (event)
2774 (interactive "@e")
2775 (x-popup-menu event gdb-memory-format-menu))
2777 (defun gdb-memory-format-menu-1 (event)
2778 (interactive "e")
2779 (save-selected-window
2780 (select-window (posn-window (event-start event)))
2781 (let* ((selection (gdb-memory-format-menu event))
2782 (binding (and selection (lookup-key gdb-memory-format-menu
2783 (vector (car selection))))))
2784 (if binding (call-interactively binding)))))
2786 (defun gdb-memory-unit-giant ()
2787 "Set the unit size to giant words (eight bytes)."
2788 (interactive)
2789 (customize-set-variable 'gdb-memory-unit "g")
2790 (gdb-invalidate-memory))
2792 (defun gdb-memory-unit-word ()
2793 "Set the unit size to words (four bytes)."
2794 (interactive)
2795 (customize-set-variable 'gdb-memory-unit "w")
2796 (gdb-invalidate-memory))
2798 (defun gdb-memory-unit-halfword ()
2799 "Set the unit size to halfwords (two bytes)."
2800 (interactive)
2801 (customize-set-variable 'gdb-memory-unit "h")
2802 (gdb-invalidate-memory))
2804 (defun gdb-memory-unit-byte ()
2805 "Set the unit size to bytes."
2806 (interactive)
2807 (customize-set-variable 'gdb-memory-unit "b")
2808 (gdb-invalidate-memory))
2810 (defvar gdb-memory-unit-map
2811 (let ((map (make-sparse-keymap)))
2812 (define-key map [header-line down-mouse-3] 'gdb-memory-unit-menu-1)
2813 map)
2814 "Keymap to select units in the header line.")
2816 (defvar gdb-memory-unit-menu (make-sparse-keymap "Unit")
2817 "Menu of units in the header line.")
2819 (define-key gdb-memory-unit-menu [giantwords]
2820 '(menu-item "Giant words" gdb-memory-unit-giant
2821 :button (:radio . (equal gdb-memory-unit "g"))))
2822 (define-key gdb-memory-unit-menu [words]
2823 '(menu-item "Words" gdb-memory-unit-word
2824 :button (:radio . (equal gdb-memory-unit "w"))))
2825 (define-key gdb-memory-unit-menu [halfwords]
2826 '(menu-item "Halfwords" gdb-memory-unit-halfword
2827 :button (:radio . (equal gdb-memory-unit "h"))))
2828 (define-key gdb-memory-unit-menu [bytes]
2829 '(menu-item "Bytes" gdb-memory-unit-byte
2830 :button (:radio . (equal gdb-memory-unit "b"))))
2832 (defun gdb-memory-unit-menu (event)
2833 (interactive "@e")
2834 (x-popup-menu event gdb-memory-unit-menu))
2836 (defun gdb-memory-unit-menu-1 (event)
2837 (interactive "e")
2838 (save-selected-window
2839 (select-window (posn-window (event-start event)))
2840 (let* ((selection (gdb-memory-unit-menu event))
2841 (binding (and selection (lookup-key gdb-memory-unit-menu
2842 (vector (car selection))))))
2843 (if binding (call-interactively binding)))))
2845 (defvar gdb-memory-font-lock-keywords
2846 '(;; <__function.name+n>
2847 ("<\\(\\(\\sw\\|[_.]\\)+\\)\\(\\+[0-9]+\\)?>" (1 font-lock-function-name-face))
2849 "Font lock keywords used in `gdb-memory-mode'.")
2851 (defun gdb-memory-mode ()
2852 "Major mode for examining memory.
2854 \\{gdb-memory-mode-map}"
2855 (kill-all-local-variables)
2856 (setq major-mode 'gdb-memory-mode)
2857 (setq mode-name "Memory")
2858 (setq buffer-read-only t)
2859 (buffer-disable-undo)
2860 (use-local-map gdb-memory-mode-map)
2861 (setq header-line-format
2862 '(:eval
2863 (concat
2864 "Read address["
2865 (propertize
2867 'face font-lock-warning-face
2868 'help-echo "mouse-1: decrement address"
2869 'mouse-face 'mode-line-highlight
2870 'local-map
2871 (gdb-make-header-line-mouse-map
2872 'mouse-1
2873 (lambda () (interactive)
2874 (let ((gdb-memory-address
2875 ;; Let GDB do the arithmetic.
2876 (concat
2877 gdb-memory-address " - "
2878 (number-to-string
2879 (* gdb-memory-repeat-count
2880 (cond ((string= gdb-memory-unit "b") 1)
2881 ((string= gdb-memory-unit "h") 2)
2882 ((string= gdb-memory-unit "w") 4)
2883 ((string= gdb-memory-unit "g") 8)))))))
2884 (gdb-invalidate-memory)))))
2886 (propertize "+"
2887 'face font-lock-warning-face
2888 'help-echo "mouse-1: increment address"
2889 'mouse-face 'mode-line-highlight
2890 'local-map (gdb-make-header-line-mouse-map
2891 'mouse-1
2892 (lambda () (interactive)
2893 (let ((gdb-memory-address nil))
2894 (gdb-invalidate-memory)))))
2895 "]: "
2896 (propertize gdb-memory-address
2897 'face font-lock-warning-face
2898 'help-echo "mouse-1: set memory address"
2899 'mouse-face 'mode-line-highlight
2900 'local-map (gdb-make-header-line-mouse-map
2901 'mouse-1
2902 #'gdb-memory-set-address))
2903 " Repeat Count: "
2904 (propertize (number-to-string gdb-memory-repeat-count)
2905 'face font-lock-warning-face
2906 'help-echo "mouse-1: set repeat count"
2907 'mouse-face 'mode-line-highlight
2908 'local-map (gdb-make-header-line-mouse-map
2909 'mouse-1
2910 #'gdb-memory-set-repeat-count))
2911 " Display Format: "
2912 (propertize gdb-memory-format
2913 'face font-lock-warning-face
2914 'help-echo "mouse-3: select display format"
2915 'mouse-face 'mode-line-highlight
2916 'local-map gdb-memory-format-map)
2917 " Unit Size: "
2918 (propertize gdb-memory-unit
2919 'face font-lock-warning-face
2920 'help-echo "mouse-3: select unit size"
2921 'mouse-face 'mode-line-highlight
2922 'local-map gdb-memory-unit-map))))
2923 (set (make-local-variable 'font-lock-defaults)
2924 '(gdb-memory-font-lock-keywords))
2925 (run-mode-hooks 'gdb-memory-mode-hook)
2926 'gdb-invalidate-memory)
2928 (defun gdb-memory-buffer-name ()
2929 (with-current-buffer gud-comint-buffer
2930 (concat "*memory of " (gdb-get-target-string) "*")))
2932 (defun gdb-display-memory-buffer ()
2933 "Display memory contents."
2934 (interactive)
2935 (gdb-display-buffer
2936 (gdb-get-buffer-create 'gdb-memory-buffer) t))
2938 (defun gdb-frame-memory-buffer ()
2939 "Display memory contents in a new frame."
2940 (interactive)
2941 (let* ((special-display-regexps (append special-display-regexps '(".*")))
2942 (special-display-frame-alist
2943 (cons '(left-fringe . 0)
2944 (cons '(right-fringe . 0)
2945 (cons '(width . 83) gdb-frame-parameters)))))
2946 (display-buffer (gdb-get-buffer-create 'gdb-memory-buffer))))
2949 ;; Locals buffer.
2951 (gdb-set-buffer-rules 'gdb-locals-buffer
2952 'gdb-locals-buffer-name
2953 'gdb-locals-mode)
2955 (def-gdb-auto-update-trigger gdb-invalidate-locals
2956 (gdb-get-buffer 'gdb-locals-buffer)
2957 "server info locals\n"
2958 gdb-info-locals-handler)
2960 (defvar gdb-locals-watch-map
2961 (let ((map (make-sparse-keymap)))
2962 (suppress-keymap map)
2963 (define-key map "\r" (lambda () (interactive)
2964 (beginning-of-line)
2965 (gud-watch)))
2966 (define-key map [mouse-2] (lambda (event) (interactive "e")
2967 (mouse-set-point event)
2968 (beginning-of-line)
2969 (gud-watch)))
2970 map)
2971 "Keymap to create watch expression of a complex data type local variable.")
2973 (defconst gdb-struct-string
2974 (concat (propertize "[struct/union]"
2975 'mouse-face 'highlight
2976 'help-echo "mouse-2: create watch expression"
2977 'local-map gdb-locals-watch-map) "\n"))
2979 (defconst gdb-array-string
2980 (concat " " (propertize "[array]"
2981 'mouse-face 'highlight
2982 'help-echo "mouse-2: create watch expression"
2983 'local-map gdb-locals-watch-map) "\n"))
2985 ;; Abbreviate for arrays and structures.
2986 ;; These can be expanded using gud-display.
2987 (defun gdb-info-locals-handler ()
2988 (setq gdb-pending-triggers (delq 'gdb-invalidate-locals
2989 gdb-pending-triggers))
2990 (let ((buf (gdb-get-buffer 'gdb-partial-output-buffer)))
2991 (with-current-buffer buf
2992 (goto-char (point-min))
2993 ;; Need this in case "set print pretty" is on.
2994 (while (re-search-forward "^[ }].*\n" nil t)
2995 (replace-match "" nil nil))
2996 (goto-char (point-min))
2997 (while (re-search-forward "{\\(.*=.*\n\\|\n\\)" nil t)
2998 (replace-match gdb-struct-string nil nil))
2999 (goto-char (point-min))
3000 (while (re-search-forward "\\s-*{[^.].*\n" nil t)
3001 (replace-match gdb-array-string nil nil))))
3002 (let ((buf (gdb-get-buffer 'gdb-locals-buffer)))
3003 (and buf
3004 (with-current-buffer buf
3005 (let* ((window (get-buffer-window buf 0))
3006 (start (window-start window))
3007 (p (window-point window))
3008 (buffer-read-only nil))
3009 (erase-buffer)
3010 (insert-buffer-substring (gdb-get-buffer-create
3011 'gdb-partial-output-buffer))
3012 (set-window-start window start)
3013 (set-window-point window p)))))
3014 (run-hooks 'gdb-info-locals-hook))
3016 (defvar gdb-locals-mode-map
3017 (let ((map (make-sparse-keymap)))
3018 (suppress-keymap map)
3019 (define-key map "q" 'kill-this-buffer)
3020 map))
3022 (defun gdb-locals-mode ()
3023 "Major mode for gdb locals.
3025 \\{gdb-locals-mode-map}"
3026 (kill-all-local-variables)
3027 (setq major-mode 'gdb-locals-mode)
3028 (setq mode-name (concat "Locals:" gdb-selected-frame))
3029 (use-local-map gdb-locals-mode-map)
3030 (setq buffer-read-only t)
3031 (buffer-disable-undo)
3032 (setq header-line-format gdb-locals-header)
3033 (gdb-thread-identification)
3034 (set (make-local-variable 'font-lock-defaults)
3035 '(gdb-locals-font-lock-keywords))
3036 (run-mode-hooks 'gdb-locals-mode-hook)
3037 (if (and (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer) 'gdba)
3038 (string-equal gdb-version "pre-6.4"))
3039 'gdb-invalidate-locals
3040 'gdb-invalidate-locals-1))
3042 (defun gdb-locals-buffer-name ()
3043 (with-current-buffer gud-comint-buffer
3044 (concat "*locals of " (gdb-get-target-string) "*")))
3046 (defun gdb-display-locals-buffer ()
3047 "Display local variables of current stack and their values."
3048 (interactive)
3049 (gdb-display-buffer
3050 (gdb-get-buffer-create 'gdb-locals-buffer) t))
3052 (defun gdb-frame-locals-buffer ()
3053 "Display local variables of current stack and their values in a new frame."
3054 (interactive)
3055 (let ((special-display-regexps (append special-display-regexps '(".*")))
3056 (special-display-frame-alist gdb-frame-parameters))
3057 (display-buffer (gdb-get-buffer-create 'gdb-locals-buffer))))
3060 ;;;; Window management
3061 (defun gdb-display-buffer (buf dedicated &optional frame)
3062 (let ((answer (get-buffer-window buf (or frame 0))))
3063 (if answer
3064 (display-buffer buf nil (or frame 0)) ;Deiconify the frame if necessary.
3065 (let ((window (get-lru-window)))
3066 (let* ((largest (get-largest-window))
3067 (cur-size (window-height largest)))
3068 (setq answer (split-window largest))
3069 (set-window-buffer answer buf)
3070 (set-window-dedicated-p answer dedicated)))
3071 answer)))
3074 ;;; Shared keymap initialization:
3076 (let ((menu (make-sparse-keymap "GDB-Windows")))
3077 (define-key gud-menu-map [displays]
3078 `(menu-item "GDB-Windows" ,menu
3079 :help "Open a GDB-UI buffer in a new window."
3080 :visible (memq gud-minor-mode '(gdbmi gdba))))
3081 (define-key menu [gdb] '("Gdb" . gdb-display-gdb-buffer))
3082 (define-key menu [threads] '("Threads" . gdb-display-threads-buffer))
3083 (define-key menu [inferior]
3084 '(menu-item "Separate IO" gdb-display-separate-io-buffer
3085 :enable gdb-use-separate-io-buffer))
3086 (define-key menu [memory] '("Memory" . gdb-display-memory-buffer))
3087 (define-key menu [registers] '("Registers" . gdb-display-registers-buffer))
3088 (define-key menu [disassembly]
3089 '("Disassembly" . gdb-display-assembler-buffer))
3090 (define-key menu [breakpoints]
3091 '("Breakpoints" . gdb-display-breakpoints-buffer))
3092 (define-key menu [locals] '("Locals" . gdb-display-locals-buffer))
3093 (define-key menu [frames] '("Stack" . gdb-display-stack-buffer)))
3095 (let ((menu (make-sparse-keymap "GDB-Frames")))
3096 (define-key gud-menu-map [frames]
3097 `(menu-item "GDB-Frames" ,menu
3098 :help "Open a GDB-UI buffer in a new frame."
3099 :visible (memq gud-minor-mode '(gdbmi gdba))))
3100 (define-key menu [gdb] '("Gdb" . gdb-frame-gdb-buffer))
3101 (define-key menu [threads] '("Threads" . gdb-frame-threads-buffer))
3102 (define-key menu [memory] '("Memory" . gdb-frame-memory-buffer))
3103 (define-key menu [inferior]
3104 '(menu-item "Separate IO" gdb-frame-separate-io-buffer
3105 :enable gdb-use-separate-io-buffer))
3106 (define-key menu [registers] '("Registers" . gdb-frame-registers-buffer))
3107 (define-key menu [disassembly] '("Disassembly" . gdb-frame-assembler-buffer))
3108 (define-key menu [breakpoints]
3109 '("Breakpoints" . gdb-frame-breakpoints-buffer))
3110 (define-key menu [locals] '("Locals" . gdb-frame-locals-buffer))
3111 (define-key menu [frames] '("Stack" . gdb-frame-stack-buffer)))
3113 (let ((menu (make-sparse-keymap "GDB-UI/MI")))
3114 (define-key gud-menu-map [ui]
3115 `(menu-item (if (eq gud-minor-mode 'gdba) "GDB-UI" "GDB-MI")
3116 ,menu :visible (memq gud-minor-mode '(gdbmi gdba))))
3117 (define-key menu [gdb-customize]
3118 '(menu-item "Customize" (lambda () (interactive) (customize-group 'gdb))
3119 :help "Customize Gdb Graphical Mode options."))
3120 (define-key menu [gdb-find-source-frame]
3121 '(menu-item "Look For Source Frame" gdb-find-source-frame
3122 :visible (eq gud-minor-mode 'gdba)
3123 :help "Toggle looking for source frame further up call stack."
3124 :button (:toggle . gdb-find-source-frame)))
3125 (define-key menu [gdb-use-separate-io]
3126 '(menu-item "Separate IO" gdb-use-separate-io-buffer
3127 :visible (eq gud-minor-mode 'gdba)
3128 :help "Toggle separate IO for debugged program."
3129 :button (:toggle . gdb-use-separate-io-buffer)))
3130 (define-key menu [gdb-many-windows]
3131 '(menu-item "Display Other Windows" gdb-many-windows
3132 :help "Toggle display of locals, stack and breakpoint information"
3133 :button (:toggle . gdb-many-windows)))
3134 (define-key menu [gdb-restore-windows]
3135 '(menu-item "Restore Window Layout" gdb-restore-windows
3136 :help "Restore standard layout for debug session.")))
3138 (defun gdb-frame-gdb-buffer ()
3139 "Display GUD buffer in a new frame."
3140 (interactive)
3141 (let ((special-display-regexps (append special-display-regexps '(".*")))
3142 (special-display-frame-alist
3143 (remove '(menu-bar-lines) (remove '(tool-bar-lines)
3144 gdb-frame-parameters)))
3145 (same-window-regexps nil))
3146 (display-buffer gud-comint-buffer)))
3148 (defun gdb-display-gdb-buffer ()
3149 "Display GUD buffer."
3150 (interactive)
3151 (let ((same-window-regexps nil))
3152 (select-window (display-buffer gud-comint-buffer nil 0))))
3154 (defun gdb-set-window-buffer (name)
3155 (set-window-buffer (selected-window) (get-buffer name))
3156 (set-window-dedicated-p (selected-window) t))
3158 (defun gdb-setup-windows ()
3159 "Layout the window pattern for `gdb-many-windows'."
3160 (gdb-display-locals-buffer)
3161 (gdb-display-stack-buffer)
3162 (delete-other-windows)
3163 (gdb-display-breakpoints-buffer)
3164 (delete-other-windows)
3165 ; Don't dedicate.
3166 (pop-to-buffer gud-comint-buffer)
3167 (split-window nil ( / ( * (window-height) 3) 4))
3168 (split-window nil ( / (window-height) 3))
3169 (split-window-horizontally)
3170 (other-window 1)
3171 (gdb-set-window-buffer (gdb-locals-buffer-name))
3172 (other-window 1)
3173 (switch-to-buffer
3174 (if gud-last-last-frame
3175 (gud-find-file (car gud-last-last-frame))
3176 (if gdb-main-file
3177 (gud-find-file gdb-main-file)
3178 ;; Put buffer list in window if we
3179 ;; can't find a source file.
3180 (list-buffers-noselect))))
3181 (setq gdb-source-window (selected-window))
3182 (when gdb-use-separate-io-buffer
3183 (split-window-horizontally)
3184 (other-window 1)
3185 (gdb-set-window-buffer
3186 (gdb-get-buffer-create 'gdb-inferior-io)))
3187 (other-window 1)
3188 (gdb-set-window-buffer (gdb-stack-buffer-name))
3189 (split-window-horizontally)
3190 (other-window 1)
3191 (gdb-set-window-buffer (gdb-breakpoints-buffer-name))
3192 (other-window 1))
3194 (defun gdb-restore-windows ()
3195 "Restore the basic arrangement of windows used by gdba.
3196 This arrangement depends on the value of `gdb-many-windows'."
3197 (interactive)
3198 (pop-to-buffer gud-comint-buffer) ;Select the right window and frame.
3199 (delete-other-windows)
3200 (if gdb-many-windows
3201 (gdb-setup-windows)
3202 (when (or gud-last-last-frame gdb-show-main)
3203 (split-window)
3204 (other-window 1)
3205 (switch-to-buffer
3206 (if gud-last-last-frame
3207 (gud-find-file (car gud-last-last-frame))
3208 (gud-find-file gdb-main-file)))
3209 (setq gdb-source-window (selected-window))
3210 (other-window 1))))
3212 (defun gdb-reset ()
3213 "Exit a debugging session cleanly.
3214 Kills the gdb buffers, and resets variables and the source buffers."
3215 (dolist (buffer (buffer-list))
3216 (unless (eq buffer gud-comint-buffer)
3217 (with-current-buffer buffer
3218 (if (memq gud-minor-mode '(gdbmi gdba))
3219 (if (string-match "\\` ?\\*.+\\*\\'" (buffer-name))
3220 (kill-buffer nil)
3221 (gdb-remove-breakpoint-icons (point-min) (point-max) t)
3222 (setq gud-minor-mode nil)
3223 (kill-local-variable 'tool-bar-map)
3224 (kill-local-variable 'gdb-define-alist))))))
3225 (setq gdb-overlay-arrow-position nil)
3226 (setq overlay-arrow-variable-list
3227 (delq 'gdb-overlay-arrow-position overlay-arrow-variable-list))
3228 (setq fringe-indicator-alist '((overlay-arrow . right-triangle)))
3229 (setq gdb-stack-position nil)
3230 (setq overlay-arrow-variable-list
3231 (delq 'gdb-stack-position overlay-arrow-variable-list))
3232 (if (boundp 'speedbar-frame) (speedbar-timer-fn))
3233 (setq gud-running nil)
3234 (setq gdb-active-process nil)
3235 (setq gdb-var-list nil)
3236 (remove-hook 'after-save-hook 'gdb-create-define-alist t))
3238 (defun gdb-source-info ()
3239 "Find the source file where the program starts and displays it with related
3240 buffers."
3241 (goto-char (point-min))
3242 (if (and (search-forward "Located in " nil t)
3243 (looking-at "\\S-+"))
3244 (setq gdb-main-file (match-string 0)))
3245 (goto-char (point-min))
3246 (if (search-forward "Includes preprocessor macro info." nil t)
3247 (setq gdb-macro-info t))
3248 (if gdb-many-windows
3249 (gdb-setup-windows)
3250 (gdb-get-buffer-create 'gdb-breakpoints-buffer)
3251 (if gdb-show-main
3252 (let ((pop-up-windows t))
3253 (display-buffer (gud-find-file gdb-main-file)))))
3254 (setq gdb-ready t))
3256 (defun gdb-get-location (bptno line flag)
3257 "Find the directory containing the relevant source file.
3258 Put in buffer and place breakpoint icon."
3259 (goto-char (point-min))
3260 (catch 'file-not-found
3261 (if (search-forward "Located in " nil t)
3262 (when (looking-at "\\S-+")
3263 (delete (cons bptno "File not found") gdb-location-alist)
3264 (push (cons bptno (match-string 0)) gdb-location-alist))
3265 (gdb-resync)
3266 (unless (assoc bptno gdb-location-alist)
3267 (push (cons bptno "File not found") gdb-location-alist)
3268 (message-box "Cannot find source file for breakpoint location.\n\
3269 Add directory to search path for source files using the GDB command, dir."))
3270 (throw 'file-not-found nil))
3271 (with-current-buffer
3272 (find-file-noselect (match-string 0))
3273 (gdb-init-buffer)
3274 ;; only want one breakpoint icon at each location
3275 (save-excursion
3276 (goto-line (string-to-number line))
3277 (gdb-put-breakpoint-icon (eq flag ?y) bptno)))))
3279 (add-hook 'find-file-hook 'gdb-find-file-hook)
3281 (defun gdb-find-file-hook ()
3282 "Set up buffer for debugging if file is part of the source code
3283 of the current session."
3284 (if (and (buffer-name gud-comint-buffer)
3285 ;; in case gud or gdb-ui is just loaded
3286 gud-comint-buffer
3287 (memq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
3288 '(gdba gdbmi)))
3289 ;;Pre GDB 6.3 "info sources" doesn't give absolute file name.
3290 (if (member (if (string-equal gdb-version "pre-6.4")
3291 (file-name-nondirectory buffer-file-name)
3292 buffer-file-name)
3293 gdb-source-file-list)
3294 (with-current-buffer (find-buffer-visiting buffer-file-name)
3295 (gdb-init-buffer)))))
3297 ;;from put-image
3298 (defun gdb-put-string (putstring pos &optional dprop &rest sprops)
3299 "Put string PUTSTRING in front of POS in the current buffer.
3300 PUTSTRING is displayed by putting an overlay into the current buffer with a
3301 `before-string' string that has a `display' property whose value is
3302 PUTSTRING."
3303 (let ((string (make-string 1 ?x))
3304 (buffer (current-buffer)))
3305 (setq putstring (copy-sequence putstring))
3306 (let ((overlay (make-overlay pos pos buffer))
3307 (prop (or dprop
3308 (list (list 'margin 'left-margin) putstring))))
3309 (put-text-property 0 1 'display prop string)
3310 (if sprops
3311 (add-text-properties 0 1 sprops string))
3312 (overlay-put overlay 'put-break t)
3313 (overlay-put overlay 'before-string string))))
3315 ;;from remove-images
3316 (defun gdb-remove-strings (start end &optional buffer)
3317 "Remove strings between START and END in BUFFER.
3318 Remove only strings that were put in BUFFER with calls to `gdb-put-string'.
3319 BUFFER nil or omitted means use the current buffer."
3320 (unless buffer
3321 (setq buffer (current-buffer)))
3322 (dolist (overlay (overlays-in start end))
3323 (when (overlay-get overlay 'put-break)
3324 (delete-overlay overlay))))
3326 (defun gdb-put-breakpoint-icon (enabled bptno)
3327 (if (string-match "[0-9+]+\\." bptno)
3328 (setq enabled gdb-parent-bptno-enabled))
3329 (let ((start (- (line-beginning-position) 1))
3330 (end (+ (line-end-position) 1))
3331 (putstring (if enabled "B" "b"))
3332 (source-window (get-buffer-window (current-buffer) 0)))
3333 (add-text-properties
3334 0 1 '(help-echo "mouse-1: clear bkpt, mouse-3: enable/disable bkpt")
3335 putstring)
3336 (if enabled
3337 (add-text-properties
3338 0 1 `(gdb-bptno ,bptno gdb-enabled t) putstring)
3339 (add-text-properties
3340 0 1 `(gdb-bptno ,bptno gdb-enabled nil) putstring))
3341 (gdb-remove-breakpoint-icons start end)
3342 (if (display-images-p)
3343 (if (>= (or left-fringe-width
3344 (if source-window (car (window-fringes source-window)))
3345 gdb-buffer-fringe-width) 8)
3346 (gdb-put-string
3347 nil (1+ start)
3348 `(left-fringe breakpoint
3349 ,(if enabled
3350 'breakpoint-enabled
3351 'breakpoint-disabled))
3352 'gdb-bptno bptno
3353 'gdb-enabled enabled)
3354 (when (< left-margin-width 2)
3355 (save-current-buffer
3356 (setq left-margin-width 2)
3357 (if source-window
3358 (set-window-margins
3359 source-window
3360 left-margin-width right-margin-width))))
3361 (put-image
3362 (if enabled
3363 (or breakpoint-enabled-icon
3364 (setq breakpoint-enabled-icon
3365 (find-image `((:type xpm :data
3366 ,breakpoint-xpm-data
3367 :ascent 100 :pointer hand)
3368 (:type pbm :data
3369 ,breakpoint-enabled-pbm-data
3370 :ascent 100 :pointer hand)))))
3371 (or breakpoint-disabled-icon
3372 (setq breakpoint-disabled-icon
3373 (find-image `((:type xpm :data
3374 ,breakpoint-xpm-data
3375 :conversion disabled
3376 :ascent 100 :pointer hand)
3377 (:type pbm :data
3378 ,breakpoint-disabled-pbm-data
3379 :ascent 100 :pointer hand))))))
3380 (+ start 1)
3381 putstring
3382 'left-margin))
3383 (when (< left-margin-width 2)
3384 (save-current-buffer
3385 (setq left-margin-width 2)
3386 (let ((window (get-buffer-window (current-buffer) 0)))
3387 (if window
3388 (set-window-margins
3389 window left-margin-width right-margin-width)))))
3390 (gdb-put-string
3391 (propertize putstring
3392 'face (if enabled 'breakpoint-enabled 'breakpoint-disabled))
3393 (1+ start)))))
3395 (defun gdb-remove-breakpoint-icons (start end &optional remove-margin)
3396 (gdb-remove-strings start end)
3397 (if (display-images-p)
3398 (remove-images start end))
3399 (when remove-margin
3400 (setq left-margin-width 0)
3401 (let ((window (get-buffer-window (current-buffer) 0)))
3402 (if window
3403 (set-window-margins
3404 window left-margin-width right-margin-width)))))
3408 ;; Assembler buffer.
3410 (gdb-set-buffer-rules 'gdb-assembler-buffer
3411 'gdb-assembler-buffer-name
3412 'gdb-assembler-mode)
3414 ;; We can't use def-gdb-auto-update-handler because we don't want to use
3415 ;; window-start but keep the overlay arrow/current line visible.
3416 (defun gdb-assembler-handler ()
3417 (setq gdb-pending-triggers
3418 (delq 'gdb-invalidate-assembler
3419 gdb-pending-triggers))
3420 (let ((buf (gdb-get-buffer 'gdb-assembler-buffer)))
3421 (and buf
3422 (with-current-buffer buf
3423 (let* ((window (get-buffer-window buf 0))
3424 (p (window-point window))
3425 (buffer-read-only nil))
3426 (erase-buffer)
3427 (insert-buffer-substring (gdb-get-buffer-create
3428 'gdb-partial-output-buffer))
3429 (set-window-point window p)))))
3430 ;; put customisation here
3431 (gdb-assembler-custom))
3433 (defun gdb-assembler-custom ()
3434 (let ((buffer (gdb-get-buffer 'gdb-assembler-buffer))
3435 (pos 1) (address) (flag) (bptno))
3436 (with-current-buffer buffer
3437 (save-excursion
3438 (if (not (equal gdb-pc-address "main"))
3439 (progn
3440 (goto-char (point-min))
3441 (if (and gdb-pc-address
3442 (search-forward gdb-pc-address nil t))
3443 (progn
3444 (setq pos (point))
3445 (beginning-of-line)
3446 (setq fringe-indicator-alist
3447 (if (string-equal gdb-frame-number "0")
3449 '((overlay-arrow . hollow-right-triangle))))
3450 (or gdb-overlay-arrow-position
3451 (setq gdb-overlay-arrow-position (make-marker)))
3452 (set-marker gdb-overlay-arrow-position (point))))))
3453 ;; remove all breakpoint-icons in assembler buffer before updating.
3454 (gdb-remove-breakpoint-icons (point-min) (point-max))))
3455 (with-current-buffer (gdb-get-buffer 'gdb-breakpoints-buffer)
3456 (goto-char (point-min))
3457 (while (< (point) (- (point-max) 1))
3458 (forward-line 1)
3459 (when (looking-at
3460 "\\([0-9]+\\.?[0-9]*\\).*?\\s-+\\(.\\)\\s-+0x0*\\(\\S-+\\)")
3461 (setq bptno (match-string 1))
3462 (setq flag (char-after (match-beginning 2)))
3463 (setq address (match-string 3))
3464 (with-current-buffer buffer
3465 (save-excursion
3466 (goto-char (point-min))
3467 (if (re-search-forward (concat "^0x0*" address) nil t)
3468 (gdb-put-breakpoint-icon (eq flag ?y) bptno)))))))
3469 (if (not (equal gdb-pc-address "main"))
3470 (with-current-buffer buffer
3471 (set-window-point (get-buffer-window buffer 0) pos)))))
3473 (defvar gdb-assembler-mode-map
3474 (let ((map (make-sparse-keymap)))
3475 (suppress-keymap map)
3476 (define-key map "q" 'kill-this-buffer)
3477 map))
3479 (defvar gdb-assembler-font-lock-keywords
3480 '(;; <__function.name+n>
3481 ("<\\(\\(\\sw\\|[_.]\\)+\\)\\(\\+[0-9]+\\)?>"
3482 (1 font-lock-function-name-face))
3483 ;; 0xNNNNNNNN <__function.name+n>: opcode
3484 ("^0x[0-9a-f]+ \\(<\\(\\(\\sw\\|[_.]\\)+\\)\\+[0-9]+>\\)?:[ \t]+\\(\\sw+\\)"
3485 (4 font-lock-keyword-face))
3486 ;; %register(at least i386)
3487 ("%\\sw+" . font-lock-variable-name-face)
3488 ("^\\(Dump of assembler code for function\\) \\(.+\\):"
3489 (1 font-lock-comment-face)
3490 (2 font-lock-function-name-face))
3491 ("^\\(End of assembler dump\\.\\)" . font-lock-comment-face))
3492 "Font lock keywords used in `gdb-assembler-mode'.")
3494 (defun gdb-assembler-mode ()
3495 "Major mode for viewing code assembler.
3497 \\{gdb-assembler-mode-map}"
3498 (kill-all-local-variables)
3499 (setq major-mode 'gdb-assembler-mode)
3500 (setq mode-name (concat "Machine:" gdb-selected-frame))
3501 (setq gdb-overlay-arrow-position nil)
3502 (add-to-list 'overlay-arrow-variable-list 'gdb-overlay-arrow-position)
3503 (setq fringes-outside-margins t)
3504 (setq buffer-read-only t)
3505 (buffer-disable-undo)
3506 (gdb-thread-identification)
3507 (use-local-map gdb-assembler-mode-map)
3508 (gdb-invalidate-assembler)
3509 (set (make-local-variable 'font-lock-defaults)
3510 '(gdb-assembler-font-lock-keywords))
3511 (run-mode-hooks 'gdb-assembler-mode-hook)
3512 'gdb-invalidate-assembler)
3514 (defun gdb-assembler-buffer-name ()
3515 (with-current-buffer gud-comint-buffer
3516 (concat "*disassembly of " (gdb-get-target-string) "*")))
3518 (defun gdb-display-assembler-buffer ()
3519 "Display disassembly view."
3520 (interactive)
3521 (setq gdb-previous-frame nil)
3522 (gdb-display-buffer
3523 (gdb-get-buffer-create 'gdb-assembler-buffer) t))
3525 (defun gdb-frame-assembler-buffer ()
3526 "Display disassembly view in a new frame."
3527 (interactive)
3528 (setq gdb-previous-frame nil)
3529 (let ((special-display-regexps (append special-display-regexps '(".*")))
3530 (special-display-frame-alist gdb-frame-parameters))
3531 (display-buffer (gdb-get-buffer-create 'gdb-assembler-buffer))))
3533 ;; modified because if gdb-pc-address has changed value a new command
3534 ;; must be enqueued to update the buffer with the new output
3535 (defun gdb-invalidate-assembler (&optional ignored)
3536 (if (gdb-get-buffer 'gdb-assembler-buffer)
3537 (progn
3538 (unless (and gdb-selected-frame
3539 (string-equal gdb-selected-frame gdb-previous-frame))
3540 (if (or (not (member 'gdb-invalidate-assembler
3541 gdb-pending-triggers))
3542 (not (equal (string-to-number gdb-pc-address)
3543 (string-to-number
3544 gdb-previous-frame-pc-address))))
3545 (progn
3546 ;; take previous disassemble command, if any, off the queue
3547 (with-current-buffer gud-comint-buffer
3548 (let ((queue gdb-input-queue))
3549 (dolist (item queue)
3550 (if (equal (cdr item) '(gdb-assembler-handler))
3551 (setq gdb-input-queue
3552 (delete item gdb-input-queue))))))
3553 (gdb-enqueue-input
3554 (list
3555 (concat gdb-server-prefix "disassemble " gdb-pc-address "\n")
3556 'gdb-assembler-handler))
3557 (push 'gdb-invalidate-assembler gdb-pending-triggers)
3558 (setq gdb-previous-frame-pc-address gdb-pc-address)
3559 (setq gdb-previous-frame gdb-selected-frame)))))))
3561 (defun gdb-get-selected-frame ()
3562 (if (not (member 'gdb-get-selected-frame gdb-pending-triggers))
3563 (progn
3564 (if (string-equal gdb-version "pre-6.4")
3565 (gdb-enqueue-input
3566 (list (concat gdb-server-prefix "info frame\n")
3567 'gdb-frame-handler))
3568 (gdb-enqueue-input
3569 (list "server interpreter mi -stack-info-frame\n"
3570 'gdb-frame-handler-1)))
3571 (push 'gdb-get-selected-frame gdb-pending-triggers))))
3573 (defun gdb-frame-handler ()
3574 (setq gdb-pending-triggers
3575 (delq 'gdb-get-selected-frame gdb-pending-triggers))
3576 (goto-char (point-min))
3577 (when (re-search-forward
3578 "Stack level \\([0-9]+\\), frame at \\(0x[[:xdigit:]]+\\)" nil t)
3579 (setq gdb-frame-number (match-string 1))
3580 (setq gdb-frame-address (match-string 2)))
3581 (goto-char (point-min))
3582 (when (re-search-forward ".*=\\s-+\\(\\S-*\\)\\s-+in\\s-+\\(.*?\\)\
3583 \\(?: (\\(\\S-+?\\):[0-9]+?)\\)*; "
3584 nil t)
3585 (setq gdb-selected-frame (match-string 2))
3586 (if (gdb-get-buffer 'gdb-locals-buffer)
3587 (with-current-buffer (gdb-get-buffer 'gdb-locals-buffer)
3588 (setq mode-name (concat "Locals:" gdb-selected-frame))))
3589 (if (gdb-get-buffer 'gdb-assembler-buffer)
3590 (with-current-buffer (gdb-get-buffer 'gdb-assembler-buffer)
3591 (setq mode-name (concat "Machine:" gdb-selected-frame))))
3592 (setq gdb-pc-address (match-string 1))
3593 (if (and (match-string 3) gud-overlay-arrow-position)
3594 (let ((buffer (marker-buffer gud-overlay-arrow-position))
3595 (position (marker-position gud-overlay-arrow-position)))
3596 (when (and buffer
3597 (string-equal (file-name-nondirectory
3598 (buffer-file-name buffer))
3599 (file-name-nondirectory (match-string 3))))
3600 (with-current-buffer buffer
3601 (setq fringe-indicator-alist
3602 (if (string-equal gdb-frame-number "0")
3604 '((overlay-arrow . hollow-right-triangle))))
3605 (set-marker gud-overlay-arrow-position position))))))
3606 (goto-char (point-min))
3607 (if (re-search-forward " source language \\(\\S-+\\)\." nil t)
3608 (setq gdb-current-language (match-string 1)))
3609 (gdb-invalidate-assembler))
3612 ;; Code specific to GDB 6.4
3613 (defconst gdb-source-file-regexp-1 "fullname=\"\\(.*?\\)\"")
3615 (defun gdb-set-gud-minor-mode-existing-buffers-1 ()
3616 "Create list of source files for current GDB session.
3617 If buffers already exist for any of these files, `gud-minor-mode'
3618 is set in them."
3619 (goto-char (point-min))
3620 (while (re-search-forward gdb-source-file-regexp-1 nil t)
3621 (push (match-string 1) gdb-source-file-list))
3622 (dolist (buffer (buffer-list))
3623 (with-current-buffer buffer
3624 (when (member buffer-file-name gdb-source-file-list)
3625 (gdb-init-buffer))))
3626 (gdb-force-mode-line-update
3627 (propertize "ready" 'face font-lock-variable-name-face)))
3629 ;; Used for -stack-info-frame but could be used for -stack-list-frames too.
3630 (defconst gdb-stack-list-frames-regexp
3631 ".*?level=\"\\(.*?\\)\",.*?addr=\"\\(.*?\\)\",.*?func=\"\\(.*?\\)\",\
3632 \\(?:.*?file=\".*?\",.*?fullname=\"\\(.*?\\)\",.*?line=\"\\(.*?\\)\".*?}\\|\
3633 from=\"\\(.*?\\)\"\\)")
3635 (defun gdb-frame-handler-1 ()
3636 (setq gdb-pending-triggers
3637 (delq 'gdb-get-selected-frame gdb-pending-triggers))
3638 (goto-char (point-min))
3639 (when (re-search-forward gdb-stack-list-frames-regexp nil t)
3640 (setq gdb-frame-number (match-string 1))
3641 (setq gdb-pc-address (match-string 2))
3642 (setq gdb-selected-frame (match-string 3))
3643 (if (gdb-get-buffer 'gdb-locals-buffer)
3644 (with-current-buffer (gdb-get-buffer 'gdb-locals-buffer)
3645 (setq mode-name (concat "Locals:" gdb-selected-frame))))
3646 (if (gdb-get-buffer 'gdb-assembler-buffer)
3647 (with-current-buffer (gdb-get-buffer 'gdb-assembler-buffer)
3648 (setq mode-name (concat "Machine:" gdb-selected-frame)))))
3649 (if (and (match-string 4) (match-string 5) gud-overlay-arrow-position)
3650 (let ((buffer (marker-buffer gud-overlay-arrow-position))
3651 (position (marker-position gud-overlay-arrow-position)))
3652 (when (and buffer
3653 (string-equal (file-name-nondirectory
3654 (buffer-file-name buffer))
3655 (file-name-nondirectory (match-string 4))))
3656 (with-current-buffer buffer
3657 (setq fringe-indicator-alist
3658 (if (string-equal gdb-frame-number "0")
3660 '((overlay-arrow . hollow-right-triangle))))
3661 (set-marker gud-overlay-arrow-position position)))))
3662 (gdb-invalidate-assembler))
3664 ; Uses "-var-list-children --all-values". Needs GDB 6.4 onwards.
3665 (defun gdb-var-list-children-1 (varnum)
3666 (gdb-enqueue-input
3667 (list
3668 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer) 'gdba)
3669 (concat "server interpreter mi \"-var-list-children --all-values \\\""
3670 varnum "\\\"\"\n")
3671 (concat "-var-list-children --all-values \"" varnum "\"\n"))
3672 `(lambda () (gdb-var-list-children-handler-1 ,varnum)))))
3674 (defconst gdb-var-list-children-regexp-1
3675 "child={.*?name=\"\\(.+?\\)\",.*?exp=\"\\(.+?\\)\",.*?\
3676 numchild=\"\\(.+?\\)\",.*?value=\\(\".*?\"\\)\
3677 \\(}\\|,.*?\\(type=\"\\(.+?\\)\"\\)?.*?}\\)")
3679 (defun gdb-var-list-children-handler-1 (varnum)
3680 (goto-char (point-min))
3681 (let ((var-list nil))
3682 (catch 'child-already-watched
3683 (dolist (var gdb-var-list)
3684 (if (string-equal varnum (car var))
3685 (progn
3686 (push var var-list)
3687 (while (re-search-forward gdb-var-list-children-regexp-1 nil t)
3688 (let ((varchild (list (match-string 1)
3689 (match-string 2)
3690 (match-string 3)
3691 (match-string 7)
3692 (read (match-string 4))
3693 nil)))
3694 (if (assoc (car varchild) gdb-var-list)
3695 (throw 'child-already-watched nil))
3696 (push varchild var-list))))
3697 (push var var-list)))
3698 (setq gdb-var-list (nreverse var-list))))
3699 (gdb-speedbar-update))
3701 ; Uses "-var-update --all-values". Needs GDB 6.4 onwards.
3702 (defun gdb-var-update-1 ()
3703 (if (not (member 'gdb-var-update gdb-pending-triggers))
3704 (progn
3705 (gdb-enqueue-input
3706 (list
3707 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer) 'gdba)
3708 "server interpreter mi \"-var-update --all-values *\"\n"
3709 "-var-update --all-values *\n")
3710 'gdb-var-update-handler-1))
3711 (push 'gdb-var-update gdb-pending-triggers))))
3713 (defconst gdb-var-update-regexp-1
3714 "{.*?name=\"\\(.*?\\)\",.*?\\(?:value=\\(\".*?\"\\),\\)?.*?\
3715 in_scope=\"\\(.*?\\)\".*?}")
3717 (defun gdb-var-update-handler-1 ()
3718 (dolist (var gdb-var-list)
3719 (setcar (nthcdr 5 var) nil))
3720 (goto-char (point-min))
3721 (while (re-search-forward gdb-var-update-regexp-1 nil t)
3722 (let* ((varnum (match-string 1))
3723 (var (assoc varnum gdb-var-list)))
3724 (when var
3725 (let ((match (match-string 3)))
3726 (cond ((string-equal match "false")
3727 (if gdb-delete-out-of-scope
3728 (gdb-var-delete-1 varnum)
3729 (setcar (nthcdr 5 var) 'out-of-scope)))
3730 ((string-equal match "true")
3731 (setcar (nthcdr 5 var) 'changed)
3732 (setcar (nthcdr 4 var)
3733 (read (match-string 2))))
3734 ((string-equal match "invalid")
3735 (gdb-var-delete-1 varnum)))))))
3736 (setq gdb-pending-triggers
3737 (delq 'gdb-var-update gdb-pending-triggers))
3738 (gdb-speedbar-update))
3740 ;; Registers buffer.
3742 (gdb-set-buffer-rules 'gdb-registers-buffer
3743 'gdb-registers-buffer-name
3744 'gdb-registers-mode)
3746 (def-gdb-auto-update-trigger gdb-invalidate-registers-1
3747 (gdb-get-buffer 'gdb-registers-buffer)
3748 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer) 'gdba)
3749 "server interpreter mi \"-data-list-register-values x\"\n"
3750 "-data-list-register-values x\n")
3751 gdb-data-list-register-values-handler)
3753 (defconst gdb-data-list-register-values-regexp
3754 "{.*?number=\"\\(.*?\\)\",.*?value=\"\\(.*?\\)\".*?}")
3756 (defun gdb-data-list-register-values-handler ()
3757 (setq gdb-pending-triggers (delq 'gdb-invalidate-registers-1
3758 gdb-pending-triggers))
3759 (goto-char (point-min))
3760 (if (re-search-forward gdb-error-regexp nil t)
3761 (let ((err (match-string 1)))
3762 (with-current-buffer (gdb-get-buffer 'gdb-registers-buffer)
3763 (let ((buffer-read-only nil))
3764 (erase-buffer)
3765 (put-text-property 0 (length err) 'face font-lock-warning-face err)
3766 (insert err)
3767 (goto-char (point-min)))))
3768 (let ((register-list (reverse gdb-register-names))
3769 (register nil) (register-string nil) (register-values nil))
3770 (goto-char (point-min))
3771 (while (re-search-forward gdb-data-list-register-values-regexp nil t)
3772 (setq register (pop register-list))
3773 (setq register-string (concat register "\t" (match-string 2) "\n"))
3774 (if (member (match-string 1) gdb-changed-registers)
3775 (put-text-property 0 (length register-string)
3776 'face 'font-lock-warning-face
3777 register-string))
3778 (setq register-values
3779 (concat register-values register-string)))
3780 (let ((buf (gdb-get-buffer 'gdb-registers-buffer)))
3781 (with-current-buffer buf
3782 (let* ((window (get-buffer-window buf 0))
3783 (start (window-start window))
3784 (p (window-point window))
3785 (buffer-read-only nil))
3786 (erase-buffer)
3787 (insert register-values)
3788 (set-window-start window start)
3789 (set-window-point window p))))))
3790 (gdb-data-list-register-values-custom))
3792 (defun gdb-data-list-register-values-custom ()
3793 (with-current-buffer (gdb-get-buffer 'gdb-registers-buffer)
3794 (save-excursion
3795 (let ((buffer-read-only nil)
3796 start end)
3797 (goto-char (point-min))
3798 (while (< (point) (point-max))
3799 (setq start (line-beginning-position))
3800 (setq end (line-end-position))
3801 (when (looking-at "^[^\t]+")
3802 (unless (string-equal (match-string 0) "No registers.")
3803 (put-text-property start (match-end 0)
3804 'face font-lock-variable-name-face)
3805 (add-text-properties start end
3806 '(help-echo "mouse-2: edit value"
3807 mouse-face highlight))))
3808 (forward-line 1))))))
3810 ;; Needs GDB 6.4 onwards (used to fail with no stack).
3811 (defun gdb-get-changed-registers ()
3812 (if (and (gdb-get-buffer 'gdb-registers-buffer)
3813 (not (member 'gdb-get-changed-registers gdb-pending-triggers)))
3814 (progn
3815 (gdb-enqueue-input
3816 (list
3817 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer) 'gdba)
3818 "server interpreter mi -data-list-changed-registers\n"
3819 "-data-list-changed-registers\n")
3820 'gdb-get-changed-registers-handler))
3821 (push 'gdb-get-changed-registers gdb-pending-triggers))))
3823 (defconst gdb-data-list-register-names-regexp "\"\\(.*?\\)\"")
3825 (defun gdb-get-changed-registers-handler ()
3826 (setq gdb-pending-triggers
3827 (delq 'gdb-get-changed-registers gdb-pending-triggers))
3828 (setq gdb-changed-registers nil)
3829 (goto-char (point-min))
3830 (while (re-search-forward gdb-data-list-register-names-regexp nil t)
3831 (push (match-string 1) gdb-changed-registers)))
3834 ;; Locals buffer.
3836 ;; uses "-stack-list-locals --simple-values". Needs GDB 6.1 onwards.
3837 (gdb-set-buffer-rules 'gdb-locals-buffer
3838 'gdb-locals-buffer-name
3839 'gdb-locals-mode)
3841 (def-gdb-auto-update-trigger gdb-invalidate-locals-1
3842 (gdb-get-buffer 'gdb-locals-buffer)
3843 (if (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer) 'gdba)
3844 "server interpreter mi -\"stack-list-locals --simple-values\"\n"
3845 "-stack-list-locals --simple-values\n")
3846 gdb-stack-list-locals-handler)
3848 (defconst gdb-stack-list-locals-regexp
3849 "{.*?name=\"\\(.*?\\)\",.*?type=\"\\(.*?\\)\"")
3851 (defvar gdb-locals-watch-map-1
3852 (let ((map (make-sparse-keymap)))
3853 (suppress-keymap map)
3854 (define-key map "\r" 'gud-watch)
3855 (define-key map [mouse-2] 'gud-watch)
3856 map)
3857 "Keymap to create watch expression of a complex data type local variable.")
3859 (defvar gdb-edit-locals-map-1
3860 (let ((map (make-sparse-keymap)))
3861 (suppress-keymap map)
3862 (define-key map "\r" 'gdb-edit-locals-value)
3863 (define-key map [mouse-2] 'gdb-edit-locals-value)
3864 map)
3865 "Keymap to edit value of a simple data type local variable.")
3867 (defun gdb-edit-locals-value (&optional event)
3868 "Assign a value to a variable displayed in the locals buffer."
3869 (interactive (list last-input-event))
3870 (save-excursion
3871 (if event (posn-set-point (event-end event)))
3872 (beginning-of-line)
3873 (let* ((var (current-word))
3874 (value (read-string (format "New value (%s): " var))))
3875 (gdb-enqueue-input
3876 (list (concat gdb-server-prefix"set variable " var " = " value "\n")
3877 'ignore)))))
3879 ;; Dont display values of arrays or structures.
3880 ;; These can be expanded using gud-watch.
3881 (defun gdb-stack-list-locals-handler ()
3882 (setq gdb-pending-triggers (delq 'gdb-invalidate-locals-1
3883 gdb-pending-triggers))
3884 (goto-char (point-min))
3885 (if (re-search-forward gdb-error-regexp nil t)
3886 (let ((err (match-string 1)))
3887 (with-current-buffer (gdb-get-buffer 'gdb-locals-buffer)
3888 (let ((buffer-read-only nil))
3889 (erase-buffer)
3890 (insert err)
3891 (goto-char (point-min)))))
3892 (let (local locals-list)
3893 (goto-char (point-min))
3894 (while (re-search-forward gdb-stack-list-locals-regexp nil t)
3895 (let ((local (list (match-string 1)
3896 (match-string 2)
3897 nil)))
3898 (if (looking-at ",value=\\(\".*\"\\).*?}")
3899 (setcar (nthcdr 2 local) (read (match-string 1))))
3900 (push local locals-list)))
3901 (let ((buf (gdb-get-buffer 'gdb-locals-buffer)))
3902 (and buf (with-current-buffer buf
3903 (let* ((window (get-buffer-window buf 0))
3904 (start (window-start window))
3905 (p (window-point window))
3906 (buffer-read-only nil) (name) (value))
3907 (erase-buffer)
3908 (dolist (local locals-list)
3909 (setq name (car local))
3910 (setq value (nth 2 local))
3911 (if (or (not value)
3912 (string-match "^\\0x" value))
3913 (add-text-properties 0 (length name)
3914 `(mouse-face highlight
3915 help-echo "mouse-2: create watch expression"
3916 local-map ,gdb-locals-watch-map-1)
3917 name)
3918 (add-text-properties 0 (length value)
3919 `(mouse-face highlight
3920 help-echo "mouse-2: edit value"
3921 local-map ,gdb-edit-locals-map-1)
3922 value))
3923 (insert
3924 (concat name "\t" (nth 1 local)
3925 "\t" value "\n")))
3926 (set-window-start window start)
3927 (set-window-point window p))))))))
3929 (defun gdb-get-register-names ()
3930 "Create a list of register names."
3931 (goto-char (point-min))
3932 (setq gdb-register-names nil)
3933 (while (re-search-forward gdb-data-list-register-names-regexp nil t)
3934 (push (match-string 1) gdb-register-names)))
3936 (provide 'gdb-ui)
3938 ;; arch-tag: e9fb00c5-74ef-469f-a088-37384caae352
3939 ;;; gdb-ui.el ends here