1 ;;; gdb-mi.el --- User Interface for running GDB
3 ;; Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
5 ;; Author: Nick Roberts <nickrob@gnu.org>
7 ;; Keywords: unix, tools
9 ;; This file is part of GNU Emacs.
11 ;; Homepage: http://www.emacswiki.org/emacs/GDB-MI
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; This file was written by by Nick Roberts following the general design
29 ;; used in gdb-ui.el for Emacs 22.1 - 23.1. It is currently being developed
30 ;; by Dmitry Dzhus <dima@sphinx.net.ru> as part of the Google Summer
31 ;; of Code 2009 Project "Emacs GDB/MI migration".
35 ;; This mode acts as a graphical user interface to GDB. You can interact with
36 ;; GDB through the GUD buffer in the usual way, but there are also further
37 ;; buffers which control the execution and describe the state of your program.
38 ;; It separates the input/output of your program from that of GDB and displays
39 ;; expressions and their current values in their own buffers. It also uses
40 ;; features of Emacs 21 such as the fringe/display margin for breakpoints, and
41 ;; the toolbar (see the GDB Graphical Interface section in the Emacs info
44 ;; M-x gdb will start the debugger.
46 ;; This file uses GDB/MI as the primary interface to GDB. It is still under
47 ;; development and is part of a process to migrate Emacs from annotations (as
48 ;; used in gdb-ui.el) to GDB/MI. It runs gdb with GDB/MI (-interp=mi) and
49 ;; access CLI using "-interpreter-exec console cli-command". This code works
50 ;; without gdb-ui.el and uses MI tokens instead of queues. Eventually MI
51 ;; should be asynchronous.
53 ;; This mode will PARTLY WORK WITH RECENT GDB RELEASES (status in modeline
54 ;; doesn't update properly when execution commands are issued from GUD buffer)
55 ;; and WORKS BEST when GDB runs asynchronously: maint set linux-async on.
57 ;; You need development version of GDB 7.0 for the thread buffer to work.
59 ;; This file replaces gdb-ui.el and is for development with GDB. Use the
60 ;; release branch of Emacs 22 for the latest version of gdb-ui.el.
64 ;; If you are using Emacs and GDB on Windows you will need to flush the buffer
65 ;; explicitly in your program if you want timely display of I/O in Emacs.
66 ;; Alternatively you can make the output stream unbuffered, for example, by
70 ;; setvbuf (stdout, (char *) NULL, _IONBF, 0);
73 ;; and compiling with -DUNBUFFERED while debugging.
75 ;; If you are using Cygwin GDB and find that the source is not being displayed
76 ;; in Emacs when you step through it, possible solutions are to:
78 ;; 1) Use Cygwin X Windows and Cygwin Emacs.
79 ;; (Since 22.1 Emacs builds under Cygwin.)
80 ;; 2) Use MinGW GDB instead.
81 ;; 3) Use cygwin-mount.el
85 ;; GDB in Emacs on Mac OSX works best with FSF GDB as Apple have made
86 ;; some changes to the version that they include as part of Mac OSX.
87 ;; This requires GDB version 7.0 or later (estimated release date Aug 2009)
88 ;; as earlier versions don not compile on Mac OSX.
92 ;; 1) Stack buffer doesn't parse MI output if you stop in a routine without
93 ;; line information, e.g., a routine in libc (just a TODO item).
96 ;; 2) Watch windows to work with threads.
97 ;; 3) Use treebuffer.el instead of the speedbar for watch-expressions?
98 ;; 4) Mark breakpoint locations on scroll-bar of source buffer?
109 (defvar tool-bar-map)
110 (defvar speedbar-initial-expansion-list-name)
111 (defvar speedbar-frame)
113 (defvar gdb-memory-address "main")
114 (defvar gdb-memory-last-address nil
115 "Last successfully accessed memory address.")
116 (defvar gdb-memory-next-page nil
117 "Address of next memory page for program memory buffer.")
118 (defvar gdb-memory-prev-page nil
119 "Address of previous memory page for program memory buffer.")
121 (defvar gdb-thread-number nil
122 "Main current thread.
124 Invalidation triggers use this variable to query GDB for
125 information on the specified thread by wrapping GDB/MI commands
126 in `gdb-current-context-command'.
128 This variable may be updated implicitly by GDB via `gdb-stopped'
129 or explicitly by `gdb-select-thread'.
131 Only `gdb-setq-thread-number' should be used to change this
134 (defvar gdb-frame-number nil
135 "Selected frame level for main current thread.
137 Updated according to the following rules:
139 When a thread is selected or current thread stops, set to \"0\".
141 When current thread goes running (and possibly exits eventually),
144 May be manually changed by user with `gdb-select-frame'.")
146 (defvar gdb-frame-address nil "Identity of frame for watch expression.")
148 ;; Used to show overlay arrow in source buffer. All set in
149 ;; gdb-get-main-selected-frame. Disassembly buffer should not use
150 ;; these but rely on buffer-local thread information instead.
151 (defvar gdb-selected-frame nil
152 "Name of selected function for main current thread.")
153 (defvar gdb-selected-file nil
154 "Name of selected file for main current thread.")
155 (defvar gdb-selected-line nil
156 "Number of selected line for main current thread.")
158 (defvar gdb-threads-list nil
159 "Associative list of threads provided by \"-thread-info\" MI command.
161 Keys are thread numbers (in strings) and values are structures as
162 returned from -thread-info by `gdb-json-partial-output'. Updated in
163 `gdb-thread-list-handler-custom'.")
165 (defvar gdb-running-threads-count nil
166 "Number of currently running threads.
168 Nil means that no information is available.
170 Updated in `gdb-thread-list-handler-custom'.")
172 (defvar gdb-stopped-threads-count nil
173 "Number of currently stopped threads.
175 See also `gdb-running-threads-count'.")
177 (defvar gdb-breakpoints-list nil
178 "Associative list of breakpoints provided by \"-break-list\" MI command.
180 Keys are breakpoint numbers (in string) and values are structures
181 as returned from \"-break-list\" by `gdb-json-partial-output'
182 \(\"body\" field is used). Updated in
183 `gdb-breakpoints-list-handler-custom'.")
185 (defvar gdb-current-language nil)
186 (defvar gdb-var-list nil
187 "List of variables in watch window.
188 Each element has the form (VARNUM EXPRESSION NUMCHILD TYPE VALUE STATUS HAS_MORE FP)
189 where STATUS is nil (`unchanged'), `changed' or `out-of-scope', FP the frame
190 address for root variables.")
191 (defvar gdb-main-file nil "Source file from which program execution begins.")
193 ;; Overlay arrow markers
194 (defvar gdb-stack-position nil)
195 (defvar gdb-thread-position nil)
196 (defvar gdb-disassembly-position nil)
198 (defvar gdb-location-alist nil
199 "Alist of breakpoint numbers and full filenames. Only used for files that
201 (defvar gdb-active-process nil
202 "GUD tooltips display variable values when t, and macro definitions otherwise.")
203 (defvar gdb-error "Non-nil when GDB is reporting an error.")
204 (defvar gdb-macro-info nil
205 "Non-nil if GDB knows that the inferior includes preprocessor macro info.")
206 (defvar gdb-register-names nil "List of register names.")
207 (defvar gdb-changed-registers nil
208 "List of changed register numbers (strings).")
209 (defvar gdb-buffer-fringe-width nil)
210 (defvar gdb-last-command nil)
211 (defvar gdb-prompt-name nil)
212 (defvar gdb-token-number 0)
213 (defvar gdb-handler-alist '())
214 (defvar gdb-handler-number nil)
215 (defvar gdb-source-file-list nil
216 "List of source files for the current executable.")
217 (defvar gdb-first-done-or-error t)
218 (defvar gdb-source-window nil)
219 (defvar gdb-inferior-status nil)
220 (defvar gdb-continuation nil)
221 (defvar gdb-filter-output nil
222 "Message to be shown in GUD console.
224 This variable is updated in `gdb-done-or-error' and returned by
225 `gud-gdbmi-marker-filter'.")
227 (defvar gdb-non-stop nil
228 "Indicates whether current GDB session is using non-stop mode.
230 It is initialized to `gdb-non-stop-setting' at the beginning of
233 (defvar gdb-buffer-type nil
234 "One of the symbols bound in `gdb-buffer-rules'.")
235 (make-variable-buffer-local 'gdb-buffer-type)
237 (defvar gdb-output-sink 'nil
238 "The disposition of the output of the current gdb command.
239 Possible values are these symbols:
241 `user' -- gdb output should be copied to the GUD buffer
244 `emacs' -- output should be collected in the partial-output-buffer
245 for subsequent processing by a command. This is the
246 disposition of output generated by commands that
247 gdb mode sends to gdb on its own behalf.")
249 ;; Pending triggers prevent congestion: Emacs won't send two similar
250 ;; consecutive requests.
252 (defvar gdb-pending-triggers '()
253 "A list of trigger functions which have not yet been handled.
255 Elements are either function names or pairs (buffer . function)")
257 (defmacro gdb-add-pending (item)
258 `(push ,item gdb-pending-triggers))
259 (defmacro gdb-pending-p (item)
260 `(member ,item gdb-pending-triggers))
261 (defmacro gdb-delete-pending (item)
262 `(setq gdb-pending-triggers
263 (delete ,item gdb-pending-triggers)))
265 (defmacro gdb-wait-for-pending (&rest body)
266 "Wait until `gdb-pending-triggers' is empty and evaluate FORM.
268 This function checks `gdb-pending-triggers' value every
269 `gdb-wait-for-pending' seconds."
273 (if (not gdb-pending-triggers)
275 (gdb-wait-for-pending ,@body)))))
279 (defmacro gdb-add-subscriber (publisher subscriber)
280 "Register new PUBLISHER's SUBSCRIBER.
282 SUBSCRIBER must be a pair, where cdr is a function of one
283 argument (see `gdb-emit-signal')."
284 `(add-to-list ',publisher ,subscriber t))
286 (defmacro gdb-delete-subscriber (publisher subscriber)
287 "Unregister SUBSCRIBER from PUBLISHER."
288 `(setq ,publisher (delete ,subscriber
291 (defun gdb-get-subscribers (publisher)
294 (defun gdb-emit-signal (publisher &optional signal)
295 "Call cdr for each subscriber of PUBLISHER with SIGNAL as argument."
296 (dolist (subscriber (gdb-get-subscribers publisher))
297 (funcall (cdr subscriber) signal)))
299 (defvar gdb-buf-publisher '()
300 "Used to invalidate GDB buffers by emitting a signal in
303 Must be a list of pairs with cars being buffers and cdr's being
304 valid signal handlers.")
307 "GDB graphical interface"
309 :link '(info-link "(emacs)GDB Graphical Interface")
312 (defgroup gdb-non-stop nil
313 "GDB non-stop debugging settings"
317 (defgroup gdb-buffers nil
322 (defcustom gdb-debug-log-max 128
323 "Maximum size of `gdb-debug-log'. If nil, size is unlimited."
325 :type '(choice (integer :tag "Number of elements")
326 (const :tag "Unlimited" nil))
329 (defcustom gdb-non-stop-setting t
330 "When in non-stop mode, stopped threads can be examined while
331 other threads continue to execute.
333 GDB session needs to be restarted for this setting to take
339 ;; TODO Some commands can't be called with --all (give a notice about
340 ;; it in setting doc)
341 (defcustom gdb-gud-control-all-threads t
342 "When enabled, GUD execution commands affect all threads when
343 in non-stop mode. Otherwise, only current thread is affected."
348 (defcustom gdb-switch-reasons t
349 "List of stop reasons which cause Emacs to switch to the thread
350 which caused the stop. When t, switch to stopped thread no matter
351 what the reason was. When nil, never switch to stopped thread
354 This setting is used in non-stop mode only. In all-stop mode,
355 Emacs always switches to the thread which caused the stop."
356 ;; exited, exited-normally and exited-signalled are not
357 ;; thread-specific stop reasons and therefore are not included in
360 (const :tag "All reasons" t)
361 (set :tag "Selection of reasons..."
362 (const :tag "A breakpoint was reached." "breakpoint-hit")
363 (const :tag "A watchpoint was triggered." "watchpoint-trigger")
364 (const :tag "A read watchpoint was triggered." "read-watchpoint-trigger")
365 (const :tag "An access watchpoint was triggered." "access-watchpoint-trigger")
366 (const :tag "Function finished execution." "function-finished")
367 (const :tag "Location reached." "location-reached")
368 (const :tag "Watchpoint has gone out of scope" "watchpoint-scope")
369 (const :tag "End of stepping range reached." "end-stepping-range")
370 (const :tag "Signal received (like interruption)." "signal-received"))
371 (const :tag "None" nil))
374 :link '(info-link "(gdb)GDB/MI Async Records"))
376 (defcustom gdb-stopped-hooks nil
377 "This variable holds a list of functions to be called whenever
380 Each function takes one argument, a parsed MI response, which
381 contains fields of corresponding MI *stopped async record:
383 ((stopped-threads . \"all\")
385 (frame (line . \"38\")
386 (fullname . \"/home/sphinx/projects/gsoc/server.c\")
387 (file . \"server.c\")
388 (args ((value . \"0x804b038\")
391 (addr . \"0x0804869e\"))
392 (reason . \"end-stepping-range\"))
394 Note that \"reason\" is only present in non-stop debugging mode.
396 `bindat-get-field' may be used to access the fields of response.
398 Each function is called after the new current thread was selected
399 and GDB buffers were updated in `gdb-stopped'."
400 :type '(repeat function)
403 :link '(info-link "(gdb)GDB/MI Async Records"))
405 (defcustom gdb-switch-when-another-stopped t
406 "When nil, Emacs won't switch to stopped thread if some other
407 stopped thread is already selected."
412 (defcustom gdb-stack-buffer-locations t
413 "Show file information or library names in stack buffers."
418 (defcustom gdb-stack-buffer-addresses nil
419 "Show frame addresses in stack buffers."
424 (defcustom gdb-thread-buffer-verbose-names t
425 "Show long thread names in threads buffer."
430 (defcustom gdb-thread-buffer-arguments t
431 "Show function arguments in threads buffer."
436 (defcustom gdb-thread-buffer-locations t
437 "Show file information or library names in threads buffer."
442 (defcustom gdb-thread-buffer-addresses nil
443 "Show addresses for thread frames in threads buffer."
448 (defcustom gdb-show-threads-by-default nil
449 "Show threads list buffer instead of breakpoints list by
455 (defvar gdb-debug-log nil
456 "List of commands sent to and replies received from GDB.
457 Most recent commands are listed first. This list stores only the last
458 `gdb-debug-log-max' values. This variable is used to debug GDB-MI.")
461 (defcustom gdb-enable-debug nil
462 "Non-nil means record the process input and output in `gdb-debug-log'."
467 (defcustom gdb-cpp-define-alist-program "gcc -E -dM -"
468 "Shell command for generating a list of defined macros in a source file.
469 This list is used to display the #define directive associated
470 with an identifier as a tooltip. It works in a debug session with
471 GDB, when `gud-tooltip-mode' is t.
473 Set `gdb-cpp-define-alist-flags' for any include paths or
479 (defcustom gdb-cpp-define-alist-flags ""
480 "Preprocessor flags for `gdb-cpp-define-alist-program'."
485 (defcustom gdb-create-source-file-list t
486 "Non-nil means create a list of files from which the executable was built.
487 Set this to nil if the GUD buffer displays \"initializing...\" in the mode
488 line for a long time when starting, possibly because your executable was
489 built from a large number of files. This allows quicker initialization
490 but means that these files are not automatically enabled for debugging,
491 e.g., you won't be able to click in the fringe to set a breakpoint until
492 execution has already stopped there."
497 (defcustom gdb-show-main nil
498 "Non-nil means display source file containing the main routine at startup.
499 Also display the main routine in the disassembly buffer if present."
504 (defun gdb-force-mode-line-update (status)
505 (let ((buffer gud-comint-buffer))
506 (if (and buffer (buffer-name buffer))
507 (with-current-buffer buffer
508 (setq mode-line-process
510 (process-status (get-buffer-process buffer)) status))
511 ;; Force mode line redisplay soon.
512 (force-mode-line-update)))))
514 (defun gdb-enable-debug (arg)
515 "Toggle logging of transaction between Emacs and Gdb.
516 The log is stored in `gdb-debug-log' as an alist with elements
517 whose cons is send, send-item or recv and whose cdr is the string
518 being transferred. This list may grow up to a size of
519 `gdb-debug-log-max' after which the oldest element (at the end of
520 the list) is deleted every time a new one is added (at the front)."
522 (setq gdb-enable-debug
524 (not gdb-enable-debug)
525 (> (prefix-numeric-value arg) 0)))
526 (message (format "Logging of transaction %sabled"
527 (if gdb-enable-debug "en" "dis"))))
529 ;; These two are used for menu and toolbar
530 (defun gdb-control-all-threads ()
531 "Switch to non-stop/A mode."
533 (setq gdb-gud-control-all-threads t)
534 ;; Actually forcing the tool-bar to update.
535 (force-mode-line-update)
536 (message "Now in non-stop/A mode."))
538 (defun gdb-control-current-thread ()
539 "Switch to non-stop/T mode."
541 (setq gdb-gud-control-all-threads nil)
542 ;; Actually forcing the tool-bar to update.
543 (force-mode-line-update)
544 (message "Now in non-stop/T mode."))
546 (defun gdb-find-watch-expression ()
547 (let* ((var (nth (- (line-number-at-pos (point)) 2) gdb-var-list))
548 (varnum (car var)) expr array)
549 (string-match "\\(var[0-9]+\\)\\.\\(.*\\)" varnum)
550 (let ((var1 (assoc (match-string 1 varnum) gdb-var-list)) var2 varnumlet
551 (component-list (split-string (match-string 2 varnum) "\\." t)))
552 (setq expr (nth 1 var1))
553 (setq varnumlet (car var1))
554 (dolist (component component-list)
555 (setq var2 (assoc varnumlet gdb-var-list))
556 (setq expr (concat expr
557 (if (string-match ".*\\[[0-9]+\\]$" (nth 3 var2))
558 (concat "[" component "]")
559 (concat "." component))))
560 (setq varnumlet (concat varnumlet "." component)))
563 ;; noall is used for commands which don't take --all, but only
565 (defun gdb-gud-context-command (command &optional noall)
566 "When `gdb-non-stop' is t, add --thread option to COMMAND if
567 `gdb-gud-control-all-threads' is nil and --all option otherwise.
568 If NOALL is t, always add --thread option no matter what
569 `gdb-gud-control-all-threads' value is.
571 When `gdb-non-stop' is nil, return COMMAND unchanged."
573 (if (and gdb-gud-control-all-threads
575 (concat command " --all ")
576 (gdb-current-context-command command t))
579 (defmacro gdb-gud-context-call (cmd1 &optional cmd2 noall noarg)
580 "`gud-call' wrapper which adds --thread/--all options between
581 CMD1 and CMD2. NOALL is the same as in `gdb-gud-context-command'.
583 NOARG must be t when this macro is used outside `gud-def'"
585 (concat (gdb-gud-context-command ,cmd1 ,noall) " " ,cmd2)
586 ,(when (not noarg) 'arg)))
589 (defun gdb (command-line)
590 "Run gdb on program FILE in buffer *gud-FILE*.
591 The directory containing FILE becomes the initial working directory
592 and source-file directory for your debugger.
594 If `gdb-many-windows' is nil (the default value) then gdb just
595 pops up the GUD buffer unless `gdb-show-main' is t. In this case
596 it starts with two windows: one displaying the GUD buffer and the
597 other with the source file with the main routine of the inferior.
599 If `gdb-many-windows' is t, regardless of the value of
600 `gdb-show-main', the layout below will appear. Keybindings are
601 shown in some of the buffers.
603 Watch expressions appear in the speedbar/slowbar.
605 The following commands help control operation :
607 `gdb-many-windows' - Toggle the number of windows gdb uses.
608 `gdb-restore-windows' - To restore the window layout.
610 See Info node `(emacs)GDB Graphical Interface' for a more
611 detailed description of this mode.
614 +----------------------------------------------------------------------+
616 +-----------------------------------+----------------------------------+
617 | GUD buffer (I/O of GDB) | Locals buffer |
621 +-----------------------------------+----------------------------------+
622 | Source buffer | I/O buffer (of debugged program) |
630 +-----------------------------------+----------------------------------+
631 | Stack buffer | Breakpoints buffer |
632 | RET gdb-select-frame | SPC gdb-toggle-breakpoint |
633 | | RET gdb-goto-breakpoint |
634 | | D gdb-delete-breakpoint |
635 +-----------------------------------+----------------------------------+"
637 (interactive (list (gud-query-cmdline 'gdb)))
639 (when (and gud-comint-buffer
640 (buffer-name gud-comint-buffer)
641 (get-buffer-process gud-comint-buffer)
642 (with-current-buffer gud-comint-buffer (eq gud-minor-mode 'gdba)))
643 (gdb-restore-windows)
645 "Multiple debugging requires restarting in text command mode"))
647 (gud-common-init command-line nil 'gud-gdbmi-marker-filter)
648 (set (make-local-variable 'gud-minor-mode) 'gdbmi)
649 (setq comint-input-sender 'gdb-send)
651 (gud-def gud-tbreak "tbreak %f:%l" "\C-t"
652 "Set temporary breakpoint at current line.")
654 (progn (gud-call "tbreak %f:%l") (gud-call "jump %f:%l"))
655 "\C-j" "Set execution address to current line.")
657 (gud-def gud-up "up %p" "<" "Up N stack frames (numeric arg).")
658 (gud-def gud-down "down %p" ">" "Down N stack frames (numeric arg).")
659 (gud-def gud-print "print %e" "\C-p" "Evaluate C expression at point.")
660 (gud-def gud-pstar "print* %e" nil
661 "Evaluate C dereferenced pointer expression at point.")
663 (gud-def gud-step (gdb-gud-context-call "-exec-step" "%p" t)
665 "Step one source line with display.")
666 (gud-def gud-stepi (gdb-gud-context-call "-exec-step-instruction" "%p" t)
668 "Step one instruction with display.")
669 (gud-def gud-next (gdb-gud-context-call "-exec-next" "%p" t)
671 "Step one line (skip functions).")
672 (gud-def gud-nexti (gdb-gud-context-call "-exec-next-instruction" "%p" t)
674 "Step one instruction (skip functions).")
675 (gud-def gud-cont (gdb-gud-context-call "-exec-continue")
677 "Continue with display.")
678 (gud-def gud-finish (gdb-gud-context-call "-exec-finish" nil t)
680 "Finish executing current function.")
681 (gud-def gud-run "-exec-run"
685 (gud-def gud-break (if (not (string-match "Disassembly" mode-name))
686 (gud-call "break %f:%l" arg)
690 (gud-call "break *%a" arg)))
691 "\C-b" "Set breakpoint at current line or address.")
693 (gud-def gud-remove (if (not (string-match "Disassembly" mode-name))
694 (gud-call "clear %f:%l" arg)
698 (gud-call "clear *%a" arg)))
699 "\C-d" "Remove breakpoint at current line or address.")
701 ;; -exec-until doesn't support --all yet
702 (gud-def gud-until (if (not (string-match "Disassembly" mode-name))
703 (gud-call "-exec-until %f:%l" arg)
707 (gud-call "-exec-until *%a" arg)))
708 "\C-u" "Continue to current line or address.")
709 ;; TODO Why arg here?
711 gud-go (gud-call (if gdb-active-process
712 (gdb-gud-context-command "-exec-continue")
714 nil "Start or continue execution.")
716 ;; For debugging Emacs only.
720 "pp1 " (if (eq (buffer-local-value
721 'major-mode (window-buffer)) 'speedbar-mode)
722 (gdb-find-watch-expression) "%e")) arg)
723 nil "Print the Emacs s-expression.")
725 (define-key gud-minor-mode-map [left-margin mouse-1]
726 'gdb-mouse-set-clear-breakpoint)
727 (define-key gud-minor-mode-map [left-fringe mouse-1]
728 'gdb-mouse-set-clear-breakpoint)
729 (define-key gud-minor-mode-map [left-margin C-mouse-1]
730 'gdb-mouse-toggle-breakpoint-margin)
731 (define-key gud-minor-mode-map [left-fringe C-mouse-1]
732 'gdb-mouse-toggle-breakpoint-fringe)
734 (define-key gud-minor-mode-map [left-margin drag-mouse-1]
736 (define-key gud-minor-mode-map [left-fringe drag-mouse-1]
738 (define-key gud-minor-mode-map [left-margin mouse-3]
740 (define-key gud-minor-mode-map [left-fringe mouse-3]
743 (define-key gud-minor-mode-map [left-margin C-drag-mouse-1]
745 (define-key gud-minor-mode-map [left-fringe C-drag-mouse-1]
747 (define-key gud-minor-mode-map [left-fringe C-mouse-3]
749 (define-key gud-minor-mode-map [left-margin C-mouse-3]
752 (local-set-key "\C-i" 'gud-gdb-complete-command)
753 (setq gdb-first-prompt t)
754 (setq gud-running nil)
758 (run-hooks 'gdb-mode-hook))
762 (setq gdb-selected-frame nil
764 gdb-thread-number nil
766 gdb-pending-triggers nil
767 gdb-output-sink 'user
768 gdb-location-alist nil
769 gdb-source-file-list nil
772 gdb-handler-alist '()
773 gdb-handler-number nil
775 gdb-first-done-or-error t
776 gdb-buffer-fringe-width (car (window-fringes))
778 gdb-source-window nil
779 gdb-inferior-status nil
781 gdb-buf-publisher '()
783 gdb-breakpoints-list '()
784 gdb-register-names '()
785 gdb-non-stop gdb-non-stop-setting)
787 (setq gdb-buffer-type 'gdbmi)
789 (gdb-force-mode-line-update
790 (propertize "initializing..." 'face font-lock-variable-name-face))
792 (gdb-get-buffer-create 'gdb-inferior-io)
793 (gdb-clear-inferior-io)
794 (set-process-filter (get-process "gdb-inferior") 'gdb-inferior-filter)
796 ;; Needs GDB 6.4 onwards
797 (list (concat "-inferior-tty-set "
798 (process-tty-name (get-process "gdb-inferior")))
800 (if (eq window-system 'w32)
801 (gdb-input (list "-gdb-set new-console off" 'ignore)))
802 (gdb-input (list "-gdb-set height 0" 'ignore))
805 (gdb-input (list "-gdb-set non-stop 1" 'gdb-non-stop-handler)))
807 ;; find source file and compilation directory here
809 ; Needs GDB 6.2 onwards.
810 (list "-file-list-exec-source-files" 'gdb-get-source-file-list))
811 (if gdb-create-source-file-list
813 ; Needs GDB 6.0 onwards.
814 (list "-file-list-exec-source-file" 'gdb-get-source-file)))
816 (list "-gdb-show prompt" 'gdb-get-prompt)))
818 (defun gdb-non-stop-handler ()
819 (goto-char (point-min))
820 (if (re-search-forward "No symbol" nil t)
822 (message "This version of GDB doesn't support non-stop mode. Turning it off.")
823 (setq gdb-non-stop nil))
824 (gdb-input (list "-gdb-set target-async 1" 'ignore))
825 (gdb-input (list "-enable-pretty-printing" 'ignore))))
827 (defvar gdb-define-alist nil "Alist of #define directives for GUD tooltips.")
829 (defun gdb-create-define-alist ()
830 "Create an alist of #define directives for GUD tooltips."
831 (let* ((file (buffer-file-name))
833 (with-output-to-string
834 (with-current-buffer standard-output
837 ;; call-process doesn't work with remote file names.
838 (not (file-remote-p default-directory))
839 (call-process shell-file-name file
840 (list t nil) nil "-c"
841 (concat gdb-cpp-define-alist-program " "
842 gdb-cpp-define-alist-flags))))))
843 (define-list (split-string output "\n" t))
845 (setq gdb-define-alist nil)
846 (dolist (define define-list)
847 (setq name (nth 1 (split-string define "[( ]")))
848 (push (cons name define) gdb-define-alist))))
850 (declare-function tooltip-show "tooltip" (text &optional use-echo-area))
851 (defvar tooltip-use-echo-area)
853 (defun gdb-tooltip-print (expr)
854 (with-current-buffer (gdb-get-buffer 'gdb-partial-output-buffer)
855 (goto-char (point-min))
856 (if (re-search-forward ".*value=\\(\".*\"\\)" nil t)
858 (concat expr " = " (read (match-string 1)))
859 (or gud-tooltip-echo-area tooltip-use-echo-area
860 (not (display-graphic-p)))))))
862 ;; If expr is a macro for a function don't print because of possible dangerous
863 ;; side-effects. Also printing a function within a tooltip generates an
864 ;; unexpected starting annotation (phase error).
865 (defun gdb-tooltip-print-1 (expr)
866 (with-current-buffer (gdb-get-buffer 'gdb-partial-output-buffer)
867 (goto-char (point-min))
868 (if (search-forward "expands to: " nil t)
869 (unless (looking-at "\\S-+.*(.*).*")
871 (list (concat "-data-evaluate-expression " expr)
872 `(lambda () (gdb-tooltip-print ,expr))))))))
874 (defun gdb-init-buffer ()
875 (set (make-local-variable 'gud-minor-mode) 'gdbmi)
876 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
877 (when gud-tooltip-mode
878 (make-local-variable 'gdb-define-alist)
879 (gdb-create-define-alist)
880 (add-hook 'after-save-hook 'gdb-create-define-alist nil t)))
882 (defmacro gdb-if-arrow (arrow-position &rest body)
884 (let ((buffer (marker-buffer ,arrow-position)) (line))
885 (if (equal buffer (window-buffer (posn-window end)))
886 (with-current-buffer buffer
887 (when (or (equal start end)
888 (equal (posn-point start)
889 (marker-position ,arrow-position)))
892 (defun gdb-mouse-until (event)
893 "Continue running until a source line past the current line.
894 The destination source line can be selected either by clicking
895 with mouse-3 on the fringe/margin or dragging the arrow
896 with mouse-1 (default bindings)."
898 (let ((start (event-start event))
899 (end (event-end event)))
900 (gdb-if-arrow gud-overlay-arrow-position
901 (setq line (line-number-at-pos (posn-point end)))
902 (gud-call (concat "until " (number-to-string line))))
903 (gdb-if-arrow gdb-disassembly-position
905 (goto-char (point-min))
906 (forward-line (1- (line-number-at-pos (posn-point end))))
908 (gud-call (concat "until *%a"))))))
910 (defun gdb-mouse-jump (event)
911 "Set execution address/line.
912 The destination source line can be selected either by clicking with C-mouse-3
913 on the fringe/margin or dragging the arrow with C-mouse-1 (default bindings).
914 Unlike `gdb-mouse-until' the destination address can be before the current
915 line, and no execution takes place."
917 (let ((start (event-start event))
918 (end (event-end event)))
919 (gdb-if-arrow gud-overlay-arrow-position
920 (setq line (line-number-at-pos (posn-point end)))
922 (gud-call (concat "tbreak " (number-to-string line)))
923 (gud-call (concat "jump " (number-to-string line)))))
924 (gdb-if-arrow gdb-disassembly-position
926 (goto-char (point-min))
927 (forward-line (1- (line-number-at-pos (posn-point end))))
930 (gud-call (concat "tbreak *%a"))
931 (gud-call (concat "jump *%a")))))))
933 (defcustom gdb-show-changed-values t
934 "If non-nil change the face of out of scope variables and changed values.
935 Out of scope variables are suppressed with `shadow' face.
936 Changed values are highlighted with the face `font-lock-warning-face'."
941 (defcustom gdb-max-children 40
942 "Maximum number of children before expansion requires confirmation."
947 (defcustom gdb-delete-out-of-scope t
948 "If non-nil delete watch expressions automatically when they go out of scope."
953 (defcustom gdb-speedbar-auto-raise nil
954 "If non-nil raise speedbar every time display of watch expressions is\
960 (defcustom gdb-use-colon-colon-notation nil
961 "If non-nil use FUN::VAR format to display variables in the speedbar."
966 (defun gdb-speedbar-auto-raise (arg)
967 "Toggle automatic raising of the speedbar for watch expressions.
968 With prefix argument ARG, automatically raise speedbar if ARG is
969 positive, otherwise don't automatically raise it."
971 (setq gdb-speedbar-auto-raise
973 (not gdb-speedbar-auto-raise)
974 (> (prefix-numeric-value arg) 0)))
975 (message (format "Auto raising %sabled"
976 (if gdb-speedbar-auto-raise "en" "dis"))))
978 (define-key gud-minor-mode-map "\C-c\C-w" 'gud-watch)
979 (define-key global-map (concat gud-key-prefix "\C-w") 'gud-watch)
981 (declare-function tooltip-identifier-from-point "tooltip" (point))
983 (defun gud-watch (&optional arg event)
984 "Watch expression at point.
985 With arg, enter name of variable to be watched in the minibuffer."
986 (interactive (list current-prefix-arg last-input-event))
987 (let ((minor-mode (buffer-local-value 'gud-minor-mode gud-comint-buffer)))
988 (if (eq minor-mode 'gdbmi)
990 (if event (posn-set-point (event-end event)))
992 (save-selected-window
995 (completing-read "Name of variable: "
996 'gud-gdb-complete-command)
997 (if (and transient-mark-mode mark-active)
998 (buffer-substring (region-beginning) (region-end))
999 (concat (if (eq major-mode 'gdb-registers-mode) "$")
1000 (tooltip-identifier-from-point (point)))))))
1001 (set-text-properties 0 (length expr) nil expr)
1003 (list (concat"-var-create - * " expr "")
1004 `(lambda () (gdb-var-create-handler ,expr)))))))
1005 (message "gud-watch is a no-op in this mode."))))
1007 (defun gdb-var-create-handler (expr)
1008 (let* ((result (gdb-json-partial-output)))
1009 (if (not (bindat-get-field result 'msg))
1011 (list (bindat-get-field result 'name)
1012 (if (and (string-equal gdb-current-language "c")
1013 gdb-use-colon-colon-notation gdb-selected-frame)
1014 (setq expr (concat gdb-selected-frame "::" expr))
1016 (bindat-get-field result 'numchild)
1017 (bindat-get-field result 'type)
1018 (bindat-get-field result 'value)
1020 (bindat-get-field result 'has_more)
1021 gdb-frame-address)))
1022 (push var gdb-var-list)
1024 (unless (string-equal
1025 speedbar-initial-expansion-list-name "GUD")
1026 (speedbar-change-initial-expansion-list "GUD")))
1027 (message-box "No symbol \"%s\" in current context." expr))))
1029 (defun gdb-speedbar-update ()
1030 (when (and (boundp 'speedbar-frame) (frame-live-p speedbar-frame)
1031 (not (gdb-pending-p 'gdb-speedbar-timer)))
1032 ;; Dummy command to update speedbar even when idle.
1033 (gdb-input (list "-environment-pwd" 'gdb-speedbar-timer-fn))
1034 ;; Keep gdb-pending-triggers non-nil till end.
1035 (gdb-add-pending 'gdb-speedbar-timer)))
1037 (defun gdb-speedbar-timer-fn ()
1038 (if gdb-speedbar-auto-raise
1039 (raise-frame speedbar-frame))
1040 (gdb-delete-pending 'gdb-speedbar-timer)
1041 (speedbar-timer-fn))
1043 (defun gdb-var-evaluate-expression-handler (varnum changed)
1044 (goto-char (point-min))
1045 (re-search-forward ".*value=\\(\".*\"\\)" nil t)
1046 (let ((var (assoc varnum gdb-var-list)))
1048 (if changed (setcar (nthcdr 5 var) 'changed))
1049 (setcar (nthcdr 4 var) (read (match-string 1)))))
1050 (gdb-speedbar-update))
1052 ; Uses "-var-list-children --all-values". Needs GDB 6.1 onwards.
1053 (defun gdb-var-list-children (varnum)
1055 (list (concat "-var-update " varnum) 'ignore))
1057 (list (concat "-var-list-children --all-values "
1059 `(lambda () (gdb-var-list-children-handler ,varnum)))))
1061 (defun gdb-var-list-children-handler (varnum)
1062 (let* ((var-list nil)
1063 (output (bindat-get-field (gdb-json-partial-output "child")))
1064 (children (bindat-get-field output 'children)))
1065 (catch 'child-already-watched
1066 (dolist (var gdb-var-list)
1067 (if (string-equal varnum (car var))
1069 ;; With dynamic varobjs numchild may have increased.
1070 (setcar (nthcdr 2 var) (bindat-get-field output 'numchild))
1072 (dolist (child children)
1073 (let ((varchild (list (bindat-get-field child 'name)
1074 (bindat-get-field child 'exp)
1075 (bindat-get-field child 'numchild)
1076 (bindat-get-field child 'type)
1077 (bindat-get-field child 'value)
1079 (bindat-get-field child 'has_more))))
1080 (if (assoc (car varchild) gdb-var-list)
1081 (throw 'child-already-watched nil))
1082 (push varchild var-list))))
1083 (push var var-list)))
1084 (setq gdb-var-list (nreverse var-list))))
1085 (gdb-speedbar-update))
1087 (defun gdb-var-set-format (format)
1088 "Set the output format for a variable displayed in the speedbar."
1089 (let* ((var (nth (- (count-lines (point-min) (point)) 2) gdb-var-list))
1092 (list (concat "-var-set-format " varnum " " format) 'ignore))
1095 (defun gdb-var-delete-1 (var varnum)
1097 (list (concat "-var-delete " varnum) 'ignore))
1098 (setq gdb-var-list (delq var gdb-var-list))
1099 (dolist (varchild gdb-var-list)
1100 (if (string-match (concat (car var) "\\.") (car varchild))
1101 (setq gdb-var-list (delq varchild gdb-var-list)))))
1103 (defun gdb-var-delete ()
1104 "Delete watch expression at point from the speedbar."
1106 (let ((text (speedbar-line-text)))
1107 (string-match "\\(\\S-+\\)" text)
1108 (let* ((var (nth (- (count-lines (point-min) (point)) 2) gdb-var-list))
1110 (if (string-match "\\." (car var))
1111 (message-box "Can only delete a root expression")
1112 (gdb-var-delete-1 var varnum)))))
1114 (defun gdb-var-delete-children (varnum)
1115 "Delete children of variable object at point from the speedbar."
1117 (list (concat "-var-delete -c " varnum) 'ignore)))
1119 (defun gdb-edit-value (text token indent)
1120 "Assign a value to a variable displayed in the speedbar."
1121 (let* ((var (nth (- (count-lines (point-min) (point)) 2) gdb-var-list))
1122 (varnum (car var)) (value))
1123 (setq value (read-string "New value: "))
1125 (list (concat "-var-assign " varnum " " value)
1126 `(lambda () (gdb-edit-value-handler ,value))))))
1128 (defconst gdb-error-regexp "\\^error,msg=\\(\".+\"\\)")
1130 (defun gdb-edit-value-handler (value)
1131 (goto-char (point-min))
1132 (if (re-search-forward gdb-error-regexp nil t)
1133 (message-box "Invalid number or expression (%s)" value)))
1135 ; Uses "-var-update --all-values". Needs GDB 6.4 onwards.
1136 (defun gdb-var-update ()
1137 (if (not (gdb-pending-p 'gdb-var-update))
1139 (list "-var-update --all-values *" 'gdb-var-update-handler)))
1140 (gdb-add-pending 'gdb-var-update))
1142 (defun gdb-var-update-handler ()
1143 (let ((changelist (bindat-get-field (gdb-json-partial-output) 'changelist)))
1144 (dolist (var gdb-var-list)
1145 (setcar (nthcdr 5 var) nil))
1146 (let ((temp-var-list gdb-var-list))
1147 (dolist (change changelist)
1148 (let* ((varnum (bindat-get-field change 'name))
1149 (var (assoc varnum gdb-var-list))
1150 (new-num (bindat-get-field change 'new_num_children)))
1152 (let ((scope (bindat-get-field change 'in_scope))
1153 (has-more (bindat-get-field change 'has_more)))
1154 (cond ((string-equal scope "false")
1155 (if gdb-delete-out-of-scope
1156 (gdb-var-delete-1 var varnum)
1157 (setcar (nthcdr 5 var) 'out-of-scope)))
1158 ((string-equal scope "true")
1159 (setcar (nthcdr 6 var) has-more)
1160 (when (and (or (not has-more)
1161 (string-equal has-more "0"))
1163 (string-equal (nth 2 var) "0"))
1164 (setcar (nthcdr 4 var)
1165 (bindat-get-field change 'value))
1166 (setcar (nthcdr 5 var) 'changed)))
1167 ((string-equal scope "invalid")
1168 (gdb-var-delete-1 var varnum)))))
1169 (let ((var-list nil) var1
1170 (children (bindat-get-field change 'new_children)))
1173 (setq var1 (pop temp-var-list))
1175 (if (string-equal varnum (car var1))
1176 (let ((new (string-to-number new-num))
1177 (previous (string-to-number (nth 2 var1))))
1178 (setcar (nthcdr 2 var1) new-num)
1179 (push var1 var-list)
1180 (cond ((> new previous)
1181 ;; Add new children to list.
1182 (dotimes (dummy previous)
1183 (push (pop temp-var-list) var-list))
1184 (dolist (child children)
1186 (list (bindat-get-field child 'name)
1187 (bindat-get-field child 'exp)
1188 (bindat-get-field child 'numchild)
1189 (bindat-get-field child 'type)
1190 (bindat-get-field child 'value)
1192 (bindat-get-field child 'has_more))))
1193 (push varchild var-list))))
1194 ;; Remove deleted children from list.
1196 (dotimes (dummy new)
1197 (push (pop temp-var-list) var-list))
1198 (dotimes (dummy (- previous new))
1199 (pop temp-var-list)))))
1200 (push var1 var-list))
1201 (setq var1 (pop temp-var-list)))
1202 (setq gdb-var-list (nreverse var-list)))))))))
1203 (setq gdb-pending-triggers
1204 (delq 'gdb-var-update gdb-pending-triggers))
1205 (gdb-speedbar-update))
1207 (defun gdb-speedbar-expand-node (text token indent)
1208 "Expand the node the user clicked on.
1209 TEXT is the text of the button we clicked on, a + or - item.
1210 TOKEN is data related to this node.
1211 INDENT is the current indentation depth."
1212 (cond ((string-match "+" text) ;expand this node
1213 (let* ((var (assoc token gdb-var-list))
1214 (expr (nth 1 var)) (children (nth 2 var)))
1215 (if (or (<= (string-to-number children) gdb-max-children)
1217 (format "%s has %s children. Continue? " expr children)))
1218 (gdb-var-list-children token))))
1219 ((string-match "-" text) ;contract this node
1220 (dolist (var gdb-var-list)
1221 (if (string-match (concat token "\\.") (car var))
1222 (setq gdb-var-list (delq var gdb-var-list))))
1223 (gdb-var-delete-children token)
1224 (speedbar-change-expand-button-char ?+)
1225 (speedbar-delete-subblock indent))
1226 (t (error "Ooops... not sure what to do")))
1227 (speedbar-center-buffer-smartly))
1229 (defun gdb-get-target-string ()
1230 (with-current-buffer gud-comint-buffer
1237 ;; Each buffer has a TYPE -- a symbol that identifies the function
1238 ;; of that particular buffer.
1240 ;; The usual gdb interaction buffer is given the type `gdbmi' and
1241 ;; is constructed specially.
1243 ;; Others are constructed by gdb-get-buffer-create and
1244 ;; named according to the rules set forth in the gdb-buffer-rules
1246 (defvar gdb-buffer-rules '())
1248 (defun gdb-rules-name-maker (rules-entry)
1250 (defun gdb-rules-buffer-mode (rules-entry)
1251 (nth 2 rules-entry))
1252 (defun gdb-rules-update-trigger (rules-entry)
1253 (nth 3 rules-entry))
1255 (defun gdb-update-buffer-name ()
1256 "Rename current buffer according to name-maker associated with
1257 it in `gdb-buffer-rules'."
1258 (let ((f (gdb-rules-name-maker (assoc gdb-buffer-type
1259 gdb-buffer-rules))))
1260 (when f (rename-buffer (funcall f)))))
1262 (defun gdb-current-buffer-rules ()
1263 "Get `gdb-buffer-rules' entry for current buffer type."
1264 (assoc gdb-buffer-type gdb-buffer-rules))
1266 (defun gdb-current-buffer-thread ()
1267 "Get thread object of current buffer from `gdb-threads-list'.
1269 When current buffer is not bound to any thread, return main
1271 (cdr (assoc gdb-thread-number gdb-threads-list)))
1273 (defun gdb-current-buffer-frame ()
1274 "Get current stack frame object for thread of current buffer."
1275 (bindat-get-field (gdb-current-buffer-thread) 'frame))
1277 (defun gdb-buffer-type (buffer)
1278 "Get value of `gdb-buffer-type' for BUFFER."
1279 (with-current-buffer buffer
1282 (defun gdb-buffer-shows-main-thread-p ()
1283 "Return t if current GDB buffer shows main selected thread and
1284 is not bound to it."
1286 (not (local-variable-p 'gdb-thread-number)))
1288 (defun gdb-get-buffer (buffer-type &optional thread)
1289 "Get a specific GDB buffer.
1291 In that buffer, `gdb-buffer-type' must be equal to BUFFER-TYPE
1292 and `gdb-thread-number' (if provided) must be equal to THREAD."
1294 (dolist (buffer (buffer-list) nil)
1295 (with-current-buffer buffer
1296 (when (and (eq gdb-buffer-type buffer-type)
1298 (equal gdb-thread-number thread)))
1299 (throw 'found buffer))))))
1301 (defun gdb-get-buffer-create (buffer-type &optional thread)
1302 "Create a new GDB buffer of the type specified by BUFFER-TYPE.
1303 The buffer-type should be one of the cars in `gdb-buffer-rules'.
1305 If THREAD is non-nil, it is assigned to `gdb-thread-number'
1306 buffer-local variable of the new buffer.
1308 Buffer mode and name are selected according to buffer type.
1310 If buffer has trigger associated with it in `gdb-buffer-rules',
1311 this trigger is subscribed to `gdb-buf-publisher' and called with
1313 (or (gdb-get-buffer buffer-type thread)
1314 (let ((rules (assoc buffer-type gdb-buffer-rules))
1315 (new (generate-new-buffer "limbo")))
1316 (with-current-buffer new
1317 (let ((mode (gdb-rules-buffer-mode rules))
1318 (trigger (gdb-rules-update-trigger rules)))
1319 (when mode (funcall mode))
1320 (setq gdb-buffer-type buffer-type)
1322 (set (make-local-variable 'gdb-thread-number) thread))
1323 (set (make-local-variable 'gud-minor-mode)
1324 (buffer-local-value 'gud-minor-mode gud-comint-buffer))
1325 (set (make-local-variable 'tool-bar-map) gud-tool-bar-map)
1326 (rename-buffer (funcall (gdb-rules-name-maker rules)))
1328 (gdb-add-subscriber gdb-buf-publisher
1329 (cons (current-buffer)
1330 (gdb-bind-function-to-buffer trigger (current-buffer))))
1331 (funcall trigger 'start))
1332 (current-buffer))))))
1334 (defun gdb-bind-function-to-buffer (expr buffer)
1335 "Return a function which will evaluate EXPR in BUFFER."
1336 `(lambda (&rest args)
1337 (with-current-buffer ,buffer
1338 (apply ',expr args))))
1340 ;; Used to define all gdb-frame-*-buffer functions except
1341 ;; `gdb-frame-io-buffer'
1342 (defmacro def-gdb-frame-for-buffer (name buffer &optional doc)
1343 "Define a function NAME which shows gdb BUFFER in a separate frame.
1345 DOC is an optional documentation string."
1346 `(defun ,name (&optional thread)
1349 (let ((special-display-regexps (append special-display-regexps '(".*")))
1350 (special-display-frame-alist gdb-frame-parameters))
1351 (display-buffer (gdb-get-buffer-create ,buffer thread)))))
1353 (defmacro def-gdb-display-buffer (name buffer &optional doc)
1354 "Define a function NAME which shows gdb BUFFER.
1356 DOC is an optional documentation string."
1357 `(defun ,name (&optional thread)
1361 (gdb-get-buffer-create ,buffer thread) t)))
1363 ;; Used to display windows with thread-bound buffers
1364 (defmacro def-gdb-preempt-display-buffer (name buffer &optional doc
1366 `(defun ,name (&optional thread)
1369 (gdb-preempt-existing-or-display-buffer
1370 (gdb-get-buffer-create ,buffer thread)
1371 ,split-horizontal)))
1373 ;; This assoc maps buffer type symbols to rules. Each rule is a list of
1374 ;; at least one and possible more functions. The functions have these
1375 ;; roles in defining a buffer type:
1377 ;; NAME - Return a name for this buffer type.
1379 ;; The remaining function(s) are optional:
1381 ;; MODE - called in a new buffer with no arguments, should establish
1382 ;; the proper mode for the buffer.
1385 (defun gdb-set-buffer-rules (buffer-type &rest rules)
1386 (let ((binding (assoc buffer-type gdb-buffer-rules)))
1388 (setcdr binding rules)
1389 (push (cons buffer-type rules)
1390 gdb-buffer-rules))))
1392 (defun gdb-parent-mode ()
1393 "Generic mode to derive all other GDB buffer modes from."
1394 (kill-all-local-variables)
1395 (setq buffer-read-only t)
1396 (buffer-disable-undo)
1397 ;; Delete buffer from gdb-buf-publisher when it's killed
1398 ;; (if it has an associated update trigger)
1403 (let ((trigger (gdb-rules-update-trigger
1404 (gdb-current-buffer-rules))))
1406 (gdb-delete-subscriber
1408 ;; This should match gdb-add-subscriber done in
1409 ;; gdb-get-buffer-create
1410 (cons (current-buffer)
1411 (gdb-bind-function-to-buffer trigger (current-buffer))))))))
1414 ;; Partial-output buffer : This accumulates output from a command executed on
1415 ;; behalf of emacs (rather than the user).
1417 (gdb-set-buffer-rules 'gdb-partial-output-buffer
1418 'gdb-partial-output-name)
1420 (defun gdb-partial-output-name ()
1421 (concat " *partial-output-"
1422 (gdb-get-target-string)
1426 (gdb-set-buffer-rules 'gdb-inferior-io
1427 'gdb-inferior-io-name
1428 'gdb-inferior-io-mode)
1430 (defun gdb-inferior-io-name ()
1431 (concat "*input/output of "
1432 (gdb-get-target-string)
1435 (defun gdb-display-io-buffer ()
1436 "Display IO of debugged program in a separate window."
1439 (gdb-get-buffer-create 'gdb-inferior-io) t))
1441 (defconst gdb-frame-parameters
1442 '((height . 14) (width . 80)
1444 (tool-bar-lines . nil)
1445 (menu-bar-lines . nil)
1446 (minibuffer . nil)))
1448 (defun gdb-frame-io-buffer ()
1449 "Display IO of debugged program in a new frame."
1451 (let ((special-display-regexps (append special-display-regexps '(".*")))
1452 (special-display-frame-alist gdb-frame-parameters))
1453 (display-buffer (gdb-get-buffer-create 'gdb-inferior-io))))
1455 (defvar gdb-inferior-io-mode-map
1456 (let ((map (make-sparse-keymap)))
1457 (define-key map "\C-c\C-c" 'gdb-io-interrupt)
1458 (define-key map "\C-c\C-z" 'gdb-io-stop)
1459 (define-key map "\C-c\C-\\" 'gdb-io-quit)
1460 (define-key map "\C-c\C-d" 'gdb-io-eof)
1461 (define-key map "\C-d" 'gdb-io-eof)
1464 ;; We want to use comint because it has various nifty and familiar features.
1465 (define-derived-mode gdb-inferior-io-mode comint-mode "Inferior I/O"
1466 "Major mode for gdb inferior-io.
1468 The following commands are available:
1469 \\{gdb-inferior-io-mode-map}"
1471 :syntax-table nil :abbrev-table nil
1473 (make-comint-in-buffer "gdb-inferior" (current-buffer) nil))
1475 (defun gdb-inferior-filter (proc string)
1476 (unless (string-equal string "")
1477 (gdb-display-buffer (gdb-get-buffer-create 'gdb-inferior-io) t))
1478 (with-current-buffer (gdb-get-buffer-create 'gdb-inferior-io)
1479 (comint-output-filter proc string)))
1481 (defun gdb-io-interrupt ()
1482 "Interrupt the program being debugged."
1485 (get-buffer-process gud-comint-buffer) comint-ptyp))
1487 (defun gdb-io-quit ()
1488 "Send quit signal to the program being debugged."
1491 (get-buffer-process gud-comint-buffer) comint-ptyp))
1493 (defun gdb-io-stop ()
1494 "Stop the program being debugged."
1497 (get-buffer-process gud-comint-buffer) comint-ptyp))
1499 (defun gdb-io-eof ()
1500 "Send end-of-file to the program being debugged."
1503 (get-buffer-process gud-comint-buffer)))
1505 (defun gdb-clear-inferior-io ()
1506 (with-current-buffer (gdb-get-buffer-create 'gdb-inferior-io)
1510 (defconst breakpoint-xpm-data
1512 static char *magick[] = {
1513 /* columns rows colors chars-per-pixel */
1529 "XPM data used for breakpoint icon.")
1531 (defconst breakpoint-enabled-pbm-data
1534 0 0 0 0 1 1 1 1 0 0 0 0
1535 0 0 0 1 1 1 1 1 1 0 0 0
1536 0 0 1 1 1 1 1 1 1 1 0 0
1537 0 1 1 1 1 1 1 1 1 1 1 0
1538 0 1 1 1 1 1 1 1 1 1 1 0
1539 0 1 1 1 1 1 1 1 1 1 1 0
1540 0 1 1 1 1 1 1 1 1 1 1 0
1541 0 0 1 1 1 1 1 1 1 1 0 0
1542 0 0 0 1 1 1 1 1 1 0 0 0
1543 0 0 0 0 1 1 1 1 0 0 0 0"
1544 "PBM data used for enabled breakpoint icon.")
1546 (defconst breakpoint-disabled-pbm-data
1558 0 0 0 1 0 1 0 1 0 0"
1559 "PBM data used for disabled breakpoint icon.")
1561 (defvar breakpoint-enabled-icon nil
1562 "Icon for enabled breakpoint in display margin.")
1564 (defvar breakpoint-disabled-icon nil
1565 "Icon for disabled breakpoint in display margin.")
1567 (declare-function define-fringe-bitmap "fringe.c"
1568 (bitmap bits &optional height width align))
1570 (and (display-images-p)
1571 ;; Bitmap for breakpoint in fringe
1572 (define-fringe-bitmap 'breakpoint
1573 "\x3c\x7e\xff\xff\xff\xff\x7e\x3c")
1574 ;; Bitmap for gud-overlay-arrow in fringe
1575 (define-fringe-bitmap 'hollow-right-triangle
1576 "\xe0\x90\x88\x84\x84\x88\x90\xe0"))
1578 (defface breakpoint-enabled
1582 "Face for enabled breakpoint icon in fringe."
1585 (defface breakpoint-disabled
1586 '((((class color) (min-colors 88)) :foreground "grey70")
1587 ;; Ensure that on low-color displays that we end up something visible.
1588 (((class color) (min-colors 8) (background light))
1589 :foreground "black")
1590 (((class color) (min-colors 8) (background dark))
1591 :foreground "white")
1592 (((type tty) (class mono))
1594 (t :background "gray"))
1595 "Face for disabled breakpoint icon in fringe."
1599 (defun gdb-send (proc string)
1600 "A comint send filter for gdb."
1601 (with-current-buffer gud-comint-buffer
1602 (let ((inhibit-read-only t))
1603 (remove-text-properties (point-min) (point-max) '(face))))
1604 ;; mimic <RET> key to repeat previous command in GDB
1605 (if (not (string= "" string))
1606 (setq gdb-last-command string)
1607 (if gdb-last-command (setq string gdb-last-command)))
1608 (if gdb-enable-debug
1609 (push (cons 'mi-send (concat string "\n")) gdb-debug-log))
1610 (if (string-match "^-" string)
1613 (setq gdb-first-done-or-error t)
1614 (process-send-string proc (concat string "\n")))
1616 (if (string-match "\\\\$" string)
1617 (setq gdb-continuation (concat gdb-continuation string "\n"))
1618 (setq gdb-first-done-or-error t)
1619 (process-send-string proc (concat "-interpreter-exec console \""
1620 gdb-continuation string "\"\n"))
1621 (setq gdb-continuation nil))))
1623 (defun gdb-input (item)
1624 (if gdb-enable-debug (push (cons 'send-item item) gdb-debug-log))
1625 (setq gdb-token-number (1+ gdb-token-number))
1626 (setcar item (concat (number-to-string gdb-token-number) (car item)))
1627 (push (cons gdb-token-number (car (cdr item))) gdb-handler-alist)
1628 (process-send-string (get-buffer-process gud-comint-buffer)
1629 (concat (car item) "\n")))
1631 ;; NOFRAME is used for gud execution control commands
1632 (defun gdb-current-context-command (command &optional noframe)
1633 "Add --thread and --frame options to gdb COMMAND.
1635 Option values are taken from `gdb-thread-number' and
1636 `gdb-frame-number'. If `gdb-thread-number' is nil, COMMAND is
1637 returned unchanged. If `gdb-frame-number' is nil of NOFRAME is t,
1638 then no --frame option is added."
1639 ;; gdb-frame-number may be nil while gdb-thread-number is non-nil
1640 ;; (when current thread is running)
1641 (if gdb-thread-number
1642 (concat command " --thread " gdb-thread-number)
1645 (defun gdb-current-context-buffer-name (name)
1646 "Add thread information and asterisks to string NAME.
1648 If `gdb-thread-number' is nil, just wrap NAME in asterisks."
1650 (if (local-variable-p 'gdb-thread-number)
1651 (format " (bound to thread %s)" gdb-thread-number)
1655 (defun gdb-current-context-mode-name (mode)
1656 "Add thread information to MODE which is to be used as
1659 (if gdb-thread-number
1660 (format " [thread %s]" gdb-thread-number)
1664 (defcustom gud-gdb-command-name "gdb -i=mi"
1665 "Default command to execute an executable under the GDB debugger."
1670 (setq gud-running nil)
1671 (setq gdb-output-sink 'user)
1672 (setq gdb-pending-triggers nil))
1674 (defun gdb-update ()
1675 "Update buffers showing status of debug session."
1676 (when gdb-first-prompt
1677 (gdb-force-mode-line-update
1678 (propertize "initializing..." 'face font-lock-variable-name-face))
1680 (setq gdb-first-prompt nil))
1682 (gdb-get-main-selected-frame)
1683 ;; We may need to update gdb-threads-list so we can use
1684 (gdb-get-buffer-create 'gdb-threads-buffer)
1685 ;; gdb-break-list is maintained in breakpoints handler
1686 (gdb-get-buffer-create 'gdb-breakpoints-buffer)
1688 (gdb-emit-signal gdb-buf-publisher 'update)
1690 (gdb-get-changed-registers)
1692 (when (and (boundp 'speedbar-frame) (frame-live-p speedbar-frame))
1693 (dolist (var gdb-var-list)
1694 (setcar (nthcdr 5 var) nil))
1697 ;; gdb-setq-thread-number and gdb-update-gud-running are decoupled
1698 ;; because we may need to update current gud-running value without
1699 ;; changing current thread (see gdb-running)
1700 (defun gdb-setq-thread-number (number)
1701 "Only this function must be used to change `gdb-thread-number'
1702 value to NUMBER, because `gud-running' and `gdb-frame-number'
1703 need to be updated appropriately when current thread changes."
1704 ;; GDB 6.8 and earlier always output thread-id="0" when stopping.
1705 (unless (string-equal number "0") (setq gdb-thread-number number))
1706 (setq gdb-frame-number "0")
1707 (gdb-update-gud-running))
1709 (defun gdb-update-gud-running ()
1710 "Set `gud-running' according to the state of current thread.
1712 `gdb-frame-number' is set to 0 if current thread is now stopped.
1714 Note that when `gdb-gud-control-all-threads' is t, `gud-running'
1715 cannot be reliably used to determine whether or not execution
1716 control buttons should be shown in menu or toolbar. Use
1717 `gdb-running-threads-count' and `gdb-stopped-threads-count'
1720 For all-stop mode, thread information is unavailable while target
1722 (let ((old-value gud-running))
1724 (string= (bindat-get-field (gdb-current-buffer-thread) 'state)
1726 ;; Set frame number to "0" when _current_ threads stops
1727 (when (and (gdb-current-buffer-thread)
1728 (not (eq gud-running old-value)))
1729 (setq gdb-frame-number "0"))))
1731 (defun gdb-show-run-p ()
1732 "Return t if \"Run/continue\" should be shown on the toolbar."
1733 (or (not gdb-active-process)
1735 (not gdb-gud-control-all-threads)
1738 (and gdb-gud-control-all-threads
1739 (> gdb-stopped-threads-count 0))))
1741 (defun gdb-show-stop-p ()
1742 "Return t if \"Stop\" should be shown on the toolbar."
1744 (not gdb-gud-control-all-threads)
1747 (and gdb-gud-control-all-threads
1748 (> gdb-running-threads-count 0))))
1750 ;; GUD displays the selected GDB frame. This might might not be the current
1751 ;; GDB frame (after up, down etc). If no GDB frame is visible but the last
1752 ;; visited breakpoint is, use that window.
1753 (defun gdb-display-source-buffer (buffer)
1754 (let* ((last-window (if gud-last-last-frame
1756 (gud-find-file (car gud-last-last-frame)))))
1757 (source-window (or last-window
1758 (if (and gdb-source-window
1759 (window-live-p gdb-source-window))
1760 gdb-source-window))))
1762 (setq gdb-source-window source-window)
1763 (set-window-buffer source-window buffer))
1766 (defun gdb-car< (a b)
1767 (< (car a) (car b)))
1769 (defvar gdbmi-record-list
1770 '((gdb-gdb . "(gdb) \n")
1771 (gdb-done . "\\([0-9]*\\)\\^done,?\\(.*?\\)\n")
1772 (gdb-starting . "\\([0-9]*\\)\\^running\n")
1773 (gdb-error . "\\([0-9]*\\)\\^error,\\(.*?\\)\n")
1774 (gdb-console . "~\\(\".*?\"\\)\n")
1775 (gdb-internals . "&\\(\".*?\"\\)\n")
1776 (gdb-stopped . "\\*stopped,?\\(.*?\\)\n")
1777 (gdb-running . "\\*running,\\(.*?\n\\)")
1778 (gdb-thread-created . "=thread-created,\\(.*?\n\\)")
1779 (gdb-thread-selected . "=thread-selected,\\(.*?\\)\n")
1780 (gdb-thread-exited . "=thread-exited,\\(.*?\n\\)")
1781 (gdb-ignored-notification . "=[-[:alpha:]]+,?\\(.*?\\)\n")
1782 (gdb-shell . "\\(\\(?:^.+\n\\)+\\)")))
1784 (defun gud-gdbmi-marker-filter (string)
1785 "Filter GDB/MI output."
1787 ;; Record transactions if logging is enabled.
1788 (when gdb-enable-debug
1789 (push (cons 'recv string) gdb-debug-log)
1790 (if (and gdb-debug-log-max
1791 (> (length gdb-debug-log) gdb-debug-log-max))
1792 (setcdr (nthcdr (1- gdb-debug-log-max) gdb-debug-log) nil)))
1794 ;; Recall the left over gud-marker-acc from last time
1795 (setq gud-marker-acc (concat gud-marker-acc string))
1797 ;; Start accumulating output for the GUD buffer
1798 (setq gdb-filter-output "")
1799 (let ((output-record) (output-record-list))
1801 ;; Process all the complete markers in this chunk.
1802 (dolist (gdbmi-record gdbmi-record-list)
1803 (while (string-match (cdr gdbmi-record) gud-marker-acc)
1804 (push (list (match-beginning 0)
1806 (match-string 1 gud-marker-acc)
1807 (match-string 2 gud-marker-acc)
1810 (setq gud-marker-acc
1811 (concat (substring gud-marker-acc 0 (match-beginning 0))
1812 ;; Pad with spaces to preserve position.
1813 (make-string (length (match-string 0 gud-marker-acc)) 32)
1814 (substring gud-marker-acc (match-end 0))))))
1816 (setq output-record-list (sort output-record-list 'gdb-car<))
1818 (dolist (output-record output-record-list)
1819 (let ((record-type (cadr output-record))
1820 (arg1 (nth 2 output-record))
1821 (arg2 (nth 3 output-record)))
1822 (if (eq record-type 'gdb-error)
1823 (gdb-done-or-error arg2 arg1 'error)
1824 (if (eq record-type 'gdb-done)
1825 (gdb-done-or-error arg2 arg1 'done)
1826 ;; Suppress "No registers." since GDB 6.8 and earlier duplicates MI
1827 ;; error message on internal stream. Don't print to GUD buffer.
1828 (unless (and (eq record-type 'gdb-internals)
1829 (string-equal (read arg1) "No registers.\n"))
1830 (funcall record-type arg1))))))
1832 (setq gdb-output-sink 'user)
1834 (string-match "^ *" gud-marker-acc)
1835 (setq gud-marker-acc (substring gud-marker-acc (match-end 0)))
1839 (defun gdb-gdb (output-field))
1841 (defun gdb-shell (output-field)
1842 (let ((gdb-output-sink gdb-output-sink))
1843 (setq gdb-filter-output
1844 (concat output-field gdb-filter-output))))
1846 (defun gdb-ignored-notification (output-field))
1848 ;; gdb-invalidate-threads is defined to accept 'update-threads signal
1849 (defun gdb-thread-created (output-field))
1850 (defun gdb-thread-exited (output-field)
1851 "Handle =thread-exited async record: unset `gdb-thread-number'
1852 if current thread exited and update threads list."
1853 (let* ((thread-id (bindat-get-field (gdb-json-string output-field) 'id)))
1854 (if (string= gdb-thread-number thread-id)
1855 (gdb-setq-thread-number nil))
1856 ;; When we continue current thread and it quickly exits,
1857 ;; gdb-pending-triggers left after gdb-running disallow us to
1858 ;; properly call -thread-info without --thread option. Thus we
1859 ;; need to use gdb-wait-for-pending.
1860 (gdb-wait-for-pending
1861 (gdb-emit-signal gdb-buf-publisher 'update-threads))))
1863 (defun gdb-thread-selected (output-field)
1864 "Handler for =thread-selected MI output record.
1866 Sets `gdb-thread-number' to new id."
1867 (let* ((result (gdb-json-string output-field))
1868 (thread-id (bindat-get-field result 'id)))
1869 (gdb-setq-thread-number thread-id)
1870 ;; Typing `thread N` in GUD buffer makes GDB emit `^done` followed
1871 ;; by `=thread-selected` notification. `^done` causes `gdb-update`
1872 ;; as usually. Things happen to fast and second call (from
1873 ;; gdb-thread-selected handler) gets cut off by our beloved
1874 ;; gdb-pending-triggers.
1875 ;; Solution is `gdb-wait-for-pending` macro: it guarantees that its
1876 ;; body will get executed when `gdb-pending-triggers` is empty.
1877 (gdb-wait-for-pending
1880 (defun gdb-running (output-field)
1881 (let* ((thread-id (bindat-get-field (gdb-json-string output-field) 'thread-id)))
1882 ;; We reset gdb-frame-number to nil if current thread has gone
1883 ;; running. This can't be done in gdb-thread-list-handler-custom
1884 ;; because we need correct gdb-frame-number by the time
1885 ;; -thread-info command is sent.
1886 (when (or (string-equal thread-id "all")
1887 (string-equal thread-id gdb-thread-number))
1888 (setq gdb-frame-number nil)))
1889 (setq gdb-inferior-status "running")
1890 (gdb-force-mode-line-update
1891 (propertize gdb-inferior-status 'face font-lock-type-face))
1892 (when (not gdb-non-stop)
1893 (setq gud-running t))
1894 (setq gdb-active-process t)
1895 (gdb-emit-signal gdb-buf-publisher 'update-threads))
1897 (defun gdb-starting (output-field)
1898 ;; CLI commands don't emit ^running at the moment so use gdb-running too.
1899 (setq gdb-inferior-status "running")
1900 (gdb-force-mode-line-update
1901 (propertize gdb-inferior-status 'face font-lock-type-face))
1902 (setq gdb-active-process t)
1903 (setq gud-running t)
1904 ;; GDB doesn't seem to respond to -thread-info before first stop or
1905 ;; thread exit (even in non-stop mode), so this is useless.
1906 ;; Behaviour may change in the future.
1907 (gdb-emit-signal gdb-buf-publisher 'update-threads))
1909 ;; -break-insert -t didn't give a reason before gdb 6.9
1911 (defun gdb-stopped (output-field)
1912 "Given the contents of *stopped MI async record, select new
1913 current thread and update GDB buffers."
1914 ;; Reason is available with target-async only
1915 (let* ((result (gdb-json-string output-field))
1916 (reason (bindat-get-field result 'reason))
1917 (thread-id (bindat-get-field result 'thread-id)))
1919 ;; -data-list-register-names needs to be issued for any stopped
1921 (when (not gdb-register-names)
1923 (list (concat "-data-list-register-names --thread " thread-id)
1924 'gdb-register-names-handler)))
1926 ;;; Don't set gud-last-frame here as it's currently done in gdb-frame-handler
1927 ;;; because synchronous GDB doesn't give these fields with CLI.
1930 ;;; ;; Extract the frame position from the marker.
1931 ;;; gud-last-frame (cons file
1932 ;;; (string-to-number
1933 ;;; (match-string 6 gud-marker-acc)))))
1935 (setq gdb-inferior-status (or reason "unknown"))
1936 (gdb-force-mode-line-update
1937 (propertize gdb-inferior-status 'face font-lock-warning-face))
1938 (if (string-equal reason "exited-normally")
1939 (setq gdb-active-process nil))
1941 ;; Select new current thread.
1943 ;; Don't switch if we have no reasons selected
1944 (when gdb-switch-reasons
1945 ;; Switch from another stopped thread only if we have
1946 ;; gdb-switch-when-another-stopped:
1947 (when (or gdb-switch-when-another-stopped
1948 (not (string= "stopped"
1949 (bindat-get-field (gdb-current-buffer-thread) 'state))))
1950 ;; Switch if current reason has been selected or we have no
1952 (if (or (eq gdb-switch-reasons t)
1953 (member reason gdb-switch-reasons))
1954 (when (not (string-equal gdb-thread-number thread-id))
1955 (message (concat "Switched to thread " thread-id))
1956 (gdb-setq-thread-number thread-id))
1957 (message (format "Thread %s stopped" thread-id)))))
1959 ;; Print "(gdb)" to GUD console
1960 (when gdb-first-done-or-error
1961 (setq gdb-filter-output (concat gdb-filter-output gdb-prompt-name)))
1963 ;; In non-stop, we update information as soon as another thread gets
1965 (when (or gdb-first-done-or-error
1967 ;; In all-stop this updates gud-running properly as well.
1969 (setq gdb-first-done-or-error nil))
1970 (run-hook-with-args 'gdb-stopped-hooks result)))
1972 ;; Remove the trimmings from log stream containing debugging messages
1973 ;; being produced by GDB's internals, use warning face and send to GUD
1975 (defun gdb-internals (output-field)
1976 (setq gdb-filter-output
1979 (let ((error-message
1980 (read output-field)))
1982 0 (length error-message)
1983 'face font-lock-warning-face
1987 ;; Remove the trimmings from the console stream and send to GUD buffer
1988 ;; (frontend MI commands should not print to this stream)
1989 (defun gdb-console (output-field)
1990 (setq gdb-filter-output
1993 (read output-field))))
1995 (defun gdb-done-or-error (output-field token-number type)
1996 (if (string-equal token-number "")
1997 ;; Output from command entered by user
1999 (setq gdb-output-sink 'user)
2000 (setq token-number nil)
2001 ;; MI error - send to minibuffer
2002 (when (eq type 'error)
2003 ;; Skip "msg=" from `output-field'
2004 (message (read (substring output-field 4)))
2005 ;; Don't send to the console twice. (If it is a console error
2006 ;; it is also in the console stream.)
2007 (setq output-field nil)))
2008 ;; Output from command from frontend.
2009 (setq gdb-output-sink 'emacs))
2011 (gdb-clear-partial-output)
2012 (when gdb-first-done-or-error
2013 (unless (or token-number gud-running)
2014 (setq gdb-filter-output (concat gdb-filter-output gdb-prompt-name)))
2016 (setq gdb-first-done-or-error nil))
2018 (setq gdb-filter-output
2019 (gdb-concat-output gdb-filter-output output-field))
2023 (with-current-buffer
2024 (gdb-get-buffer-create 'gdb-partial-output-buffer)
2026 (cdr (assoc (string-to-number token-number) gdb-handler-alist))))
2027 (setq gdb-handler-alist
2028 (assq-delete-all token-number gdb-handler-alist)))))
2030 (defun gdb-concat-output (so-far new)
2031 (let ((sink gdb-output-sink))
2033 ((eq sink 'user) (concat so-far new))
2035 (gdb-append-to-partial-output new)
2038 (defun gdb-append-to-partial-output (string)
2039 (with-current-buffer (gdb-get-buffer-create 'gdb-partial-output-buffer)
2040 (goto-char (point-max))
2043 (defun gdb-clear-partial-output ()
2044 (with-current-buffer (gdb-get-buffer-create 'gdb-partial-output-buffer)
2047 (defun gdb-jsonify-buffer (&optional fix-key fix-list)
2048 "Prepare GDB/MI output in current buffer for parsing with `json-read'.
2050 Field names are wrapped in double quotes and equal signs are
2051 replaced with semicolons.
2053 If FIX-KEY is non-nil, strip all \"FIX-KEY=\" occurences from
2054 partial output. This is used to get rid of useless keys in lists
2055 in MI messages, e.g.: [key=.., key=..]. -stack-list-frames and
2056 -break-info are examples of MI commands which issue such
2059 If FIX-LIST is non-nil, \"FIX-LIST={..}\" is replaced with
2060 \"FIX-LIST=[..]\" prior to parsing. This is used to fix broken
2061 -break-info output when it contains breakpoint script field
2062 incompatible with GDB/MI output syntax."
2064 (goto-char (point-min))
2067 (while (re-search-forward (concat "[\\[,]\\(" fix-key "=\\)") nil t)
2068 (replace-match "" nil nil nil 1))))
2072 ;; Find positions of braces which enclose broken list
2073 (while (re-search-forward (concat fix-list "={\"") nil t)
2074 (let ((p1 (goto-char (- (point) 2)))
2075 (p2 (progn (forward-sexp)
2077 ;; Replace braces with brackets
2085 (goto-char (point-min))
2087 ;; TODO: This breaks badly with foo= inside constants
2088 (while (re-search-forward "\\([[:alpha:]-_]+\\)=" nil t)
2089 (replace-match "\"\\1\":" nil nil))
2090 (goto-char (point-max))
2093 (defun gdb-json-read-buffer (&optional fix-key fix-list)
2094 "Prepare and parse GDB/MI output in current buffer with `json-read'.
2096 FIX-KEY and FIX-LIST work as in `gdb-jsonify-buffer'."
2097 (gdb-jsonify-buffer fix-key fix-list)
2099 (goto-char (point-min))
2100 (let ((json-array-type 'list))
2103 (defun gdb-json-string (string &optional fix-key fix-list)
2104 "Prepare and parse STRING containing GDB/MI output with `json-read'.
2106 FIX-KEY and FIX-LIST work as in `gdb-jsonify-buffer'."
2109 (gdb-json-read-buffer fix-key fix-list)))
2111 (defun gdb-json-partial-output (&optional fix-key fix-list)
2112 "Prepare and parse gdb-partial-output-buffer with `json-read'.
2114 FIX-KEY and FIX-KEY work as in `gdb-jsonify-buffer'."
2115 (with-current-buffer (gdb-get-buffer-create 'gdb-partial-output-buffer)
2116 (gdb-json-read-buffer fix-key fix-list)))
2118 (defun gdb-line-posns (line)
2119 "Return a pair of LINE beginning and end positions."
2120 (let ((offset (1+ (- line (line-number-at-pos)))))
2122 (line-beginning-position offset)
2123 (line-end-position offset))))
2125 (defmacro gdb-mark-line (line variable)
2126 "Set VARIABLE marker to point at beginning of LINE.
2128 If current window has no fringes, inverse colors on LINE.
2130 Return position where LINE begins."
2132 (let* ((posns (gdb-line-posns ,line))
2133 (start-posn (car posns))
2134 (end-posn (cdr posns)))
2135 (set-marker ,variable (copy-marker start-posn))
2136 (when (not (> (car (window-fringes)) 0))
2137 (put-text-property start-posn end-posn
2138 'font-lock-face '(:inverse-video t)))
2141 (defun gdb-pad-string (string padding)
2142 (format (concat "%" (number-to-string padding) "s") string))
2144 ;; gdb-table struct is a way to programmatically construct simple
2145 ;; tables. It help to reliably align columns of data in GDB buffers
2151 (row-properties nil)
2154 (defun gdb-mapcar* (function &rest seqs)
2155 "Apply FUNCTION to each element of SEQS, and make a list of the results.
2156 If there are several SEQS, FUNCTION is called with that many
2157 arugments, and mapping stops as sson as the shortest list runs
2159 (let ((shortest (apply #'min (mapcar #'length seqs))))
2166 (number-sequence 0 (1- shortest)))))
2168 (defun gdb-table-add-row (table row &optional properties)
2169 "Add ROW of string to TABLE and recalculate column sizes.
2171 When non-nil, PROPERTIES will be added to the whole row when
2172 calling `gdb-table-string'."
2173 (let ((rows (gdb-table-rows table))
2174 (row-properties (gdb-table-row-properties table))
2175 (column-sizes (gdb-table-column-sizes table))
2176 (right-align (gdb-table-right-align table)))
2177 (when (not column-sizes)
2178 (setf (gdb-table-column-sizes table)
2179 (make-list (length row) 0)))
2180 (setf (gdb-table-rows table)
2181 (append rows (list row)))
2182 (setf (gdb-table-row-properties table)
2183 (append row-properties (list properties)))
2184 (setf (gdb-table-column-sizes table)
2185 (gdb-mapcar* (lambda (x s)
2187 (max (abs x) (string-width (or s "")))))
2188 (if right-align new-x (- new-x))))
2189 (gdb-table-column-sizes table)
2191 ;; Avoid trailing whitespace at eol
2192 (if (not (gdb-table-right-align table))
2193 (setcar (last (gdb-table-column-sizes table)) 0))))
2195 (defun gdb-table-string (table &optional sep)
2196 "Return TABLE as a string with columns separated with SEP."
2197 (let ((column-sizes (gdb-table-column-sizes table))
2202 (lambda (row properties)
2204 (mapconcat 'identity
2205 (gdb-mapcar* (lambda (s x) (gdb-pad-string s x))
2209 (gdb-table-rows table)
2210 (gdb-table-row-properties table))
2213 ;; bindat-get-field goes deep, gdb-get-many-fields goes wide
2214 (defun gdb-get-many-fields (struct &rest fields)
2215 "Return a list of FIELDS values from STRUCT."
2217 (dolist (field fields values)
2218 (setq values (append values (list (bindat-get-field struct field)))))))
2220 (defmacro def-gdb-auto-update-trigger (trigger-name gdb-command
2222 &optional signal-list)
2223 "Define a trigger TRIGGER-NAME which sends GDB-COMMAND and sets
2224 HANDLER-NAME as its handler. HANDLER-NAME is bound to current
2225 buffer with `gdb-bind-function-to-buffer'.
2227 If SIGNAL-LIST is non-nil, GDB-COMMAND is sent only when the
2228 defined trigger is called with an argument from SIGNAL-LIST. It's
2229 not recommended to define triggers with empty SIGNAL-LIST.
2230 Normally triggers should respond at least to 'update signal.
2232 Normally the trigger defined by this command must be called from
2233 the buffer where HANDLER-NAME must work. This should be done so
2234 that buffer-local thread number may be used in GDB-COMMAND (by
2235 calling `gdb-current-context-command').
2236 `gdb-bind-function-to-buffer' is used to achieve this, see
2237 `gdb-get-buffer-create'.
2239 Triggers defined by this command are meant to be used as a
2240 trigger argument when describing buffer types with
2241 `gdb-set-buffer-rules'."
2242 `(defun ,trigger-name (&optional signal)
2244 (or (not ,signal-list)
2245 (memq signal ,signal-list))
2246 (when (not (gdb-pending-p
2247 (cons (current-buffer) ',trigger-name)))
2250 (gdb-bind-function-to-buffer ',handler-name (current-buffer))))
2251 (gdb-add-pending (cons (current-buffer) ',trigger-name))))))
2253 ;; Used by disassembly buffer only, the rest use
2254 ;; def-gdb-trigger-and-handler
2255 (defmacro def-gdb-auto-update-handler (handler-name trigger-name custom-defun
2256 &optional nopreserve)
2257 "Define a handler HANDLER-NAME for TRIGGER-NAME with CUSTOM-DEFUN.
2259 Handlers are normally called from the buffers they put output in.
2261 Delete ((current-buffer) . TRIGGER-NAME) from
2262 `gdb-pending-triggers', erase current buffer and evaluate
2263 CUSTOM-DEFUN. Then `gdb-update-buffer-name' is called.
2265 If NOPRESERVE is non-nil, window point is not restored after CUSTOM-DEFUN."
2266 `(defun ,handler-name ()
2267 (gdb-delete-pending (cons (current-buffer) ',trigger-name))
2268 (let* ((buffer-read-only nil)
2269 (window (get-buffer-window (current-buffer) 0))
2270 (start (window-start window))
2271 (p (window-point window)))
2274 (gdb-update-buffer-name)
2275 ,(when (not nopreserve)
2276 '(set-window-start window start)
2277 '(set-window-point window p)))))
2279 (defmacro def-gdb-trigger-and-handler (trigger-name gdb-command
2280 handler-name custom-defun
2281 &optional signal-list)
2282 "Define trigger and handler.
2284 TRIGGER-NAME trigger is defined to send GDB-COMMAND. See
2285 `def-gdb-auto-update-trigger'.
2287 HANDLER-NAME handler uses customization of CUSTOM-DEFUN. See
2288 `def-gdb-auto-update-handler'."
2290 (def-gdb-auto-update-trigger ,trigger-name
2292 ,handler-name ,signal-list)
2293 (def-gdb-auto-update-handler ,handler-name
2294 ,trigger-name ,custom-defun)))
2298 ;; Breakpoint buffer : This displays the output of `-break-list'.
2299 (def-gdb-trigger-and-handler
2300 gdb-invalidate-breakpoints "-break-list"
2301 gdb-breakpoints-list-handler gdb-breakpoints-list-handler-custom
2304 (gdb-set-buffer-rules
2305 'gdb-breakpoints-buffer
2306 'gdb-breakpoints-buffer-name
2307 'gdb-breakpoints-mode
2308 'gdb-invalidate-breakpoints)
2310 (defun gdb-breakpoints-list-handler-custom ()
2311 (let ((breakpoints-list (bindat-get-field
2312 (gdb-json-partial-output "bkpt" "script")
2313 'BreakpointTable 'body))
2314 (table (make-gdb-table)))
2315 (setq gdb-breakpoints-list nil)
2316 (gdb-table-add-row table '("Num" "Type" "Disp" "Enb" "Addr" "Hits" "What"))
2317 (dolist (breakpoint breakpoints-list)
2318 (add-to-list 'gdb-breakpoints-list
2319 (cons (bindat-get-field breakpoint 'number)
2321 (let ((at (bindat-get-field breakpoint 'at))
2322 (pending (bindat-get-field breakpoint 'pending))
2323 (func (bindat-get-field breakpoint 'func))
2324 (type (bindat-get-field breakpoint 'type)))
2325 (gdb-table-add-row table
2327 (bindat-get-field breakpoint 'number)
2329 (bindat-get-field breakpoint 'disp)
2330 (let ((flag (bindat-get-field breakpoint 'enabled)))
2331 (if (string-equal flag "y")
2332 (propertize "y" 'font-lock-face font-lock-warning-face)
2333 (propertize "n" 'font-lock-face font-lock-comment-face)))
2334 (bindat-get-field breakpoint 'addr)
2335 (bindat-get-field breakpoint 'times)
2336 (if (string-match ".*watchpoint" type)
2337 (bindat-get-field breakpoint 'what)
2340 (propertize func 'font-lock-face font-lock-function-name-face)
2341 (gdb-frame-location breakpoint)))))
2342 ;; Add clickable properties only for breakpoints with file:line
2344 (append (list 'gdb-breakpoint breakpoint)
2345 (when func '(help-echo "mouse-2, RET: visit breakpoint"
2346 mouse-face highlight))))))
2347 (insert (gdb-table-string table " "))
2348 (gdb-place-breakpoints)))
2350 ;; Put breakpoint icons in relevant margins (even those set in the GUD buffer).
2351 (defun gdb-place-breakpoints ()
2352 (let ((flag) (bptno))
2353 ;; Remove all breakpoint-icons in source buffers but not assembler buffer.
2354 (dolist (buffer (buffer-list))
2355 (with-current-buffer buffer
2356 (if (and (eq gud-minor-mode 'gdbmi)
2357 (not (string-match "\\` ?\\*.+\\*\\'" (buffer-name))))
2358 (gdb-remove-breakpoint-icons (point-min) (point-max)))))
2359 (dolist (breakpoint gdb-breakpoints-list)
2360 (let* ((breakpoint (cdr breakpoint)) ; gdb-breakpoints-list is
2361 ; an associative list
2362 (line (bindat-get-field breakpoint 'line)))
2364 (let ((file (bindat-get-field breakpoint 'fullname))
2365 (flag (bindat-get-field breakpoint 'enabled))
2366 (bptno (bindat-get-field breakpoint 'number)))
2367 (unless (file-exists-p file)
2368 (setq file (cdr (assoc bptno gdb-location-alist))))
2370 (not (string-equal file "File not found")))
2371 (with-current-buffer
2372 (find-file-noselect file 'nowarn)
2374 ;; Only want one breakpoint icon at each location.
2375 (gdb-put-breakpoint-icon (string-equal flag "y") bptno
2376 (string-to-number line)))
2378 (list (concat "list " file ":1")
2381 (list "-file-list-exec-source-file"
2382 `(lambda () (gdb-get-location
2383 ,bptno ,line ,flag)))))))))))
2385 (defvar gdb-source-file-regexp "fullname=\"\\(.*?\\)\"")
2387 (defun gdb-get-location (bptno line flag)
2388 "Find the directory containing the relevant source file.
2389 Put in buffer and place breakpoint icon."
2390 (goto-char (point-min))
2391 (catch 'file-not-found
2392 (if (re-search-forward gdb-source-file-regexp nil t)
2393 (delete (cons bptno "File not found") gdb-location-alist)
2394 (push (cons bptno (match-string 1)) gdb-location-alist)
2396 (unless (assoc bptno gdb-location-alist)
2397 (push (cons bptno "File not found") gdb-location-alist)
2398 (message-box "Cannot find source file for breakpoint location.
2399 Add directory to search path for source files using the GDB command, dir."))
2400 (throw 'file-not-found nil))
2401 (with-current-buffer (find-file-noselect (match-string 1))
2403 ;; only want one breakpoint icon at each location
2404 (gdb-put-breakpoint-icon (eq flag ?y) bptno (string-to-number line)))))
2406 (add-hook 'find-file-hook 'gdb-find-file-hook)
2408 (defun gdb-find-file-hook ()
2409 "Set up buffer for debugging if file is part of the source code
2410 of the current session."
2411 (if (and (buffer-name gud-comint-buffer)
2412 ;; in case gud or gdb-ui is just loaded
2414 (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer)
2416 (if (member buffer-file-name gdb-source-file-list)
2417 (with-current-buffer (find-buffer-visiting buffer-file-name)
2418 (gdb-init-buffer)))))
2420 (declare-function gud-remove "gdb-mi" t t) ; gud-def
2421 (declare-function gud-break "gdb-mi" t t) ; gud-def
2422 (declare-function fringe-bitmaps-at-pos "fringe.c" (&optional pos window))
2424 (defun gdb-mouse-set-clear-breakpoint (event)
2425 "Set/clear breakpoint in left fringe/margin at mouse click.
2426 If not in a source or disassembly buffer just set point."
2428 (mouse-minibuffer-check event)
2429 (let ((posn (event-end event)))
2430 (with-selected-window (posn-window posn)
2431 (if (or (buffer-file-name) (eq major-mode 'gdb-disassembly-mode))
2432 (if (numberp (posn-point posn))
2434 (goto-char (posn-point posn))
2435 (if (or (posn-object posn)
2436 (eq (car (fringe-bitmaps-at-pos (posn-point posn)))
2440 (posn-set-point posn))))
2442 (defun gdb-mouse-toggle-breakpoint-margin (event)
2443 "Enable/disable breakpoint in left margin with mouse click."
2445 (mouse-minibuffer-check event)
2446 (let ((posn (event-end event)))
2447 (if (numberp (posn-point posn))
2448 (with-selected-window (posn-window posn)
2450 (goto-char (posn-point posn))
2451 (if (posn-object posn)
2453 (let ((bptno (get-text-property
2454 0 'gdb-bptno (car (posn-string posn)))))
2456 (if (get-text-property
2457 0 'gdb-enabled (car (posn-string posn)))
2462 (defun gdb-mouse-toggle-breakpoint-fringe (event)
2463 "Enable/disable breakpoint in left fringe with mouse click."
2465 (mouse-minibuffer-check event)
2466 (let* ((posn (event-end event))
2467 (pos (posn-point posn))
2470 (with-selected-window (posn-window posn)
2472 (set-buffer (window-buffer (selected-window)))
2474 (dolist (overlay (overlays-in pos pos))
2475 (when (overlay-get overlay 'put-break)
2476 (setq obj (overlay-get overlay 'before-string))))
2480 (if (get-text-property 0 'gdb-enabled obj)
2483 (get-text-property 0 'gdb-bptno obj)))))))))
2485 (defun gdb-breakpoints-buffer-name ()
2486 (concat "*breakpoints of " (gdb-get-target-string) "*"))
2488 (def-gdb-display-buffer
2489 gdb-display-breakpoints-buffer
2490 'gdb-breakpoints-buffer
2491 "Display status of user-settable breakpoints.")
2493 (def-gdb-frame-for-buffer
2494 gdb-frame-breakpoints-buffer
2495 'gdb-breakpoints-buffer
2496 "Display status of user-settable breakpoints in a new frame.")
2498 (defvar gdb-breakpoints-mode-map
2499 (let ((map (make-sparse-keymap))
2500 (menu (make-sparse-keymap "Breakpoints")))
2501 (define-key menu [quit] '("Quit" . gdb-delete-frame-or-window))
2502 (define-key menu [goto] '("Goto" . gdb-goto-breakpoint))
2503 (define-key menu [delete] '("Delete" . gdb-delete-breakpoint))
2504 (define-key menu [toggle] '("Toggle" . gdb-toggle-breakpoint))
2505 (suppress-keymap map)
2506 (define-key map [menu-bar breakpoints] (cons "Breakpoints" menu))
2507 (define-key map " " 'gdb-toggle-breakpoint)
2508 (define-key map "D" 'gdb-delete-breakpoint)
2509 ;; Don't bind "q" to kill-this-buffer as we need it for breakpoint icons.
2510 (define-key map "q" 'gdb-delete-frame-or-window)
2511 (define-key map "\r" 'gdb-goto-breakpoint)
2512 (define-key map "\t" '(lambda ()
2514 (gdb-set-window-buffer
2515 (gdb-get-buffer-create 'gdb-threads-buffer) t)))
2516 (define-key map [mouse-2] 'gdb-goto-breakpoint)
2517 (define-key map [follow-link] 'mouse-face)
2520 (defun gdb-delete-frame-or-window ()
2521 "Delete frame if there is only one window. Otherwise delete the window."
2523 (if (one-window-p) (delete-frame)
2526 ;;from make-mode-line-mouse-map
2527 (defun gdb-make-header-line-mouse-map (mouse function) "\
2528 Return a keymap with single entry for mouse key MOUSE on the header line.
2529 MOUSE is defined to run function FUNCTION with no args in the buffer
2530 corresponding to the mode line clicked."
2531 (let ((map (make-sparse-keymap)))
2532 (define-key map (vector 'header-line mouse) function)
2533 (define-key map (vector 'header-line 'down-mouse-1) 'ignore)
2536 (defmacro gdb-propertize-header (name buffer help-echo mouse-face face)
2538 'help-echo ,help-echo
2539 'mouse-face ',mouse-face
2542 (gdb-make-header-line-mouse-map
2544 (lambda (event) (interactive "e")
2545 (save-selected-window
2546 (select-window (posn-window (event-start event)))
2547 (gdb-set-window-buffer
2548 (gdb-get-buffer-create ',buffer) t) )))))
2551 ;; uses "-thread-info". Needs GDB 7.0 onwards.
2554 (defun gdb-threads-buffer-name ()
2555 (concat "*threads of " (gdb-get-target-string) "*"))
2557 (def-gdb-display-buffer
2558 gdb-display-threads-buffer
2560 "Display GDB threads.")
2562 (def-gdb-frame-for-buffer
2563 gdb-frame-threads-buffer
2565 "Display GDB threads in a new frame.")
2567 (def-gdb-trigger-and-handler
2568 gdb-invalidate-threads (gdb-current-context-command "-thread-info" gud-running)
2569 gdb-thread-list-handler gdb-thread-list-handler-custom
2570 '(start update update-threads))
2572 (gdb-set-buffer-rules
2574 'gdb-threads-buffer-name
2576 'gdb-invalidate-threads)
2578 (defvar gdb-threads-font-lock-keywords
2579 '(("in \\([^ ]+\\)" (1 font-lock-function-name-face))
2580 (" \\(stopped\\)" (1 font-lock-warning-face))
2581 (" \\(running\\)" (1 font-lock-string-face))
2582 ("\\(\\(\\sw\\|[_.]\\)+\\)=" (1 font-lock-variable-name-face)))
2583 "Font lock keywords used in `gdb-threads-mode'.")
2585 (defvar gdb-threads-mode-map
2586 (let ((map (make-sparse-keymap)))
2587 (define-key map "\r" 'gdb-select-thread)
2588 (define-key map "f" 'gdb-display-stack-for-thread)
2589 (define-key map "F" 'gdb-frame-stack-for-thread)
2590 (define-key map "l" 'gdb-display-locals-for-thread)
2591 (define-key map "L" 'gdb-frame-locals-for-thread)
2592 (define-key map "r" 'gdb-display-registers-for-thread)
2593 (define-key map "R" 'gdb-frame-registers-for-thread)
2594 (define-key map "d" 'gdb-display-disassembly-for-thread)
2595 (define-key map "D" 'gdb-frame-disassembly-for-thread)
2596 (define-key map "i" 'gdb-interrupt-thread)
2597 (define-key map "c" 'gdb-continue-thread)
2598 (define-key map "s" 'gdb-step-thread)
2599 (define-key map "\t" '(lambda ()
2601 (gdb-set-window-buffer
2602 (gdb-get-buffer-create 'gdb-breakpoints-buffer) t)))
2603 (define-key map [mouse-2] 'gdb-select-thread)
2604 (define-key map [follow-link] 'mouse-face)
2607 (defvar gdb-threads-header
2609 (gdb-propertize-header "Breakpoints" gdb-breakpoints-buffer
2610 "mouse-1: select" mode-line-highlight mode-line-inactive)
2612 (gdb-propertize-header "Threads" gdb-threads-buffer
2613 nil nil mode-line)))
2615 (define-derived-mode gdb-threads-mode gdb-parent-mode "Threads"
2616 "Major mode for GDB threads.
2618 \\{gdb-threads-mode-map}"
2619 (setq gdb-thread-position (make-marker))
2620 (add-to-list 'overlay-arrow-variable-list 'gdb-thread-position)
2621 (setq header-line-format gdb-threads-header)
2622 (set (make-local-variable 'font-lock-defaults)
2623 '(gdb-threads-font-lock-keywords))
2624 (run-mode-hooks 'gdb-threads-mode-hook)
2625 'gdb-invalidate-threads)
2627 (defun gdb-thread-list-handler-custom ()
2628 (let ((threads-list (bindat-get-field (gdb-json-partial-output) 'threads))
2629 (table (make-gdb-table))
2631 (setq gdb-threads-list nil)
2632 (setq gdb-running-threads-count 0)
2633 (setq gdb-stopped-threads-count 0)
2634 (set-marker gdb-thread-position nil)
2636 (dolist (thread (reverse threads-list))
2637 (let ((running (string-equal (bindat-get-field thread 'state) "running")))
2638 (add-to-list 'gdb-threads-list
2639 (cons (bindat-get-field thread 'id)
2642 (incf gdb-running-threads-count)
2643 (incf gdb-stopped-threads-count))
2645 (gdb-table-add-row table
2647 (bindat-get-field thread 'id)
2649 (if gdb-thread-buffer-verbose-names
2650 (concat (bindat-get-field thread 'target-id) " ") "")
2651 (bindat-get-field thread 'state)
2652 ;; Include frame information for stopped threads
2655 " in " (bindat-get-field thread 'frame 'func)
2656 (if gdb-thread-buffer-arguments
2659 (let ((args (bindat-get-field thread 'frame 'args)))
2662 (apply 'format `("%s=%s" ,@(gdb-get-many-fields arg 'name 'value))))
2666 (if gdb-thread-buffer-locations
2667 (gdb-frame-location (bindat-get-field thread 'frame)) "")
2668 (if gdb-thread-buffer-addresses
2669 (concat " at " (bindat-get-field thread 'frame 'addr)) ""))
2673 'mouse-face 'highlight
2674 'help-echo "mouse-2, RET: select thread")))
2675 (when (string-equal gdb-thread-number
2676 (bindat-get-field thread 'id))
2677 (setq marked-line (length gdb-threads-list))))
2678 (insert (gdb-table-string table " "))
2680 (gdb-mark-line marked-line gdb-thread-position)))
2681 ;; We update gud-running here because we need to make sure that
2682 ;; gdb-threads-list is up-to-date
2683 (gdb-update-gud-running)
2684 (gdb-emit-signal gdb-buf-publisher 'update-disassembly))
2686 (defmacro def-gdb-thread-buffer-command (name custom-defun &optional doc)
2687 "Define a NAME command which will act upon thread on the current line.
2689 CUSTOM-DEFUN may use locally bound `thread' variable, which will
2690 be the value of 'gdb-thread property of the current line. If
2691 'gdb-thread is nil, error is signaled."
2692 `(defun ,name (&optional event)
2694 (interactive (list last-input-event))
2695 (if event (posn-set-point (event-end event)))
2698 (let ((thread (get-text-property (point) 'gdb-thread)))
2701 (error "Not recognized as thread line"))))))
2703 (defmacro def-gdb-thread-buffer-simple-command (name buffer-command &optional doc)
2704 "Define a NAME which will call BUFFER-COMMAND with id of thread
2705 on the current line."
2706 `(def-gdb-thread-buffer-command ,name
2707 (,buffer-command (bindat-get-field thread 'id))
2710 (def-gdb-thread-buffer-command gdb-select-thread
2711 (let ((new-id (bindat-get-field thread 'id)))
2712 (gdb-setq-thread-number new-id)
2713 (gdb-input (list (concat "-thread-select " new-id) 'ignore))
2715 "Select the thread at current line of threads buffer.")
2717 (def-gdb-thread-buffer-simple-command
2718 gdb-display-stack-for-thread
2719 gdb-preemptively-display-stack-buffer
2720 "Display stack buffer for the thread at current line.")
2722 (def-gdb-thread-buffer-simple-command
2723 gdb-display-locals-for-thread
2724 gdb-preemptively-display-locals-buffer
2725 "Display locals buffer for the thread at current line.")
2727 (def-gdb-thread-buffer-simple-command
2728 gdb-display-registers-for-thread
2729 gdb-preemptively-display-registers-buffer
2730 "Display registers buffer for the thread at current line.")
2732 (def-gdb-thread-buffer-simple-command
2733 gdb-display-disassembly-for-thread
2734 gdb-preemptively-display-disassembly-buffer
2735 "Display disassembly buffer for the thread at current line.")
2737 (def-gdb-thread-buffer-simple-command
2738 gdb-frame-stack-for-thread
2739 gdb-frame-stack-buffer
2740 "Display a new frame with stack buffer for the thread at
2743 (def-gdb-thread-buffer-simple-command
2744 gdb-frame-locals-for-thread
2745 gdb-frame-locals-buffer
2746 "Display a new frame with locals buffer for the thread at
2749 (def-gdb-thread-buffer-simple-command
2750 gdb-frame-registers-for-thread
2751 gdb-frame-registers-buffer
2752 "Display a new frame with registers buffer for the thread at
2755 (def-gdb-thread-buffer-simple-command
2756 gdb-frame-disassembly-for-thread
2757 gdb-frame-disassembly-buffer
2758 "Display a new frame with disassembly buffer for the thread at
2761 (defmacro def-gdb-thread-buffer-gud-command (name gud-command &optional doc)
2762 "Define a NAME which will execute GUD-COMMAND with
2763 `gdb-thread-number' locally bound to id of thread on the current
2765 `(def-gdb-thread-buffer-command ,name
2767 (let ((gdb-thread-number (bindat-get-field thread 'id))
2768 (gdb-gud-control-all-threads nil))
2769 (call-interactively #',gud-command))
2770 (error "Available in non-stop mode only, customize gdb-non-stop-setting."))
2773 (def-gdb-thread-buffer-gud-command
2774 gdb-interrupt-thread
2776 "Interrupt thread at current line.")
2778 (def-gdb-thread-buffer-gud-command
2781 "Continue thread at current line.")
2783 (def-gdb-thread-buffer-gud-command
2786 "Step thread at current line.")
2791 (defcustom gdb-memory-rows 8
2792 "Number of data rows in memory window."
2797 (defcustom gdb-memory-columns 4
2798 "Number of data columns in memory window."
2803 (defcustom gdb-memory-format "x"
2804 "Display format of data items in memory window."
2805 :type '(choice (const :tag "Hexadecimal" "x")
2806 (const :tag "Signed decimal" "d")
2807 (const :tag "Unsigned decimal" "u")
2808 (const :tag "Octal" "o")
2809 (const :tag "Binary" "t"))
2813 (defcustom gdb-memory-unit 4
2814 "Unit size of data items in memory window."
2815 :type '(choice (const :tag "Byte" 1)
2816 (const :tag "Halfword" 2)
2817 (const :tag "Word" 4)
2818 (const :tag "Giant word" 8))
2822 (def-gdb-trigger-and-handler
2823 gdb-invalidate-memory
2824 (format "-data-read-memory %s %s %d %d %d"
2830 gdb-read-memory-handler
2831 gdb-read-memory-custom
2834 (gdb-set-buffer-rules
2836 'gdb-memory-buffer-name
2838 'gdb-invalidate-memory)
2840 (defun gdb-memory-column-width (size format)
2841 "Return length of string with memory unit of SIZE in FORMAT.
2843 SIZE is in bytes, as in `gdb-memory-unit'. FORMAT is a string as
2844 in `gdb-memory-format'."
2845 (let ((format-base (cdr (assoc format
2847 ("d" . 10) ("u" . 10)
2851 (let ((res (ceiling (log (expt 2.0 (* size 8)) format-base))))
2852 (cond ((string-equal format "x")
2853 (+ 2 res)) ; hexadecimal numbers have 0x in front
2854 ((or (string-equal format "d")
2855 (string-equal format "o"))
2858 (error "Unknown format"))))
2860 (defun gdb-read-memory-custom ()
2861 (let* ((res (gdb-json-partial-output))
2862 (err-msg (bindat-get-field res 'msg)))
2864 (let ((memory (bindat-get-field res 'memory)))
2865 (setq gdb-memory-address (bindat-get-field res 'addr))
2866 (setq gdb-memory-next-page (bindat-get-field res 'next-page))
2867 (setq gdb-memory-prev-page (bindat-get-field res 'prev-page))
2868 (setq gdb-memory-last-address gdb-memory-address)
2869 (dolist (row memory)
2870 (insert (concat (bindat-get-field row 'addr) ":"))
2871 (dolist (column (bindat-get-field row 'data))
2872 (insert (gdb-pad-string column
2873 (+ 2 (gdb-memory-column-width
2875 gdb-memory-format)))))
2877 ;; Show last page instead of empty buffer when out of bounds
2879 (let ((gdb-memory-address gdb-memory-last-address))
2880 (gdb-invalidate-memory 'update)
2881 (error err-msg))))))
2883 (defvar gdb-memory-mode-map
2884 (let ((map (make-sparse-keymap)))
2885 (suppress-keymap map t)
2886 (define-key map "q" 'kill-this-buffer)
2887 (define-key map "n" 'gdb-memory-show-next-page)
2888 (define-key map "p" 'gdb-memory-show-previous-page)
2889 (define-key map "a" 'gdb-memory-set-address)
2890 (define-key map "t" 'gdb-memory-format-binary)
2891 (define-key map "o" 'gdb-memory-format-octal)
2892 (define-key map "u" 'gdb-memory-format-unsigned)
2893 (define-key map "d" 'gdb-memory-format-signed)
2894 (define-key map "x" 'gdb-memory-format-hexadecimal)
2895 (define-key map "b" 'gdb-memory-unit-byte)
2896 (define-key map "h" 'gdb-memory-unit-halfword)
2897 (define-key map "w" 'gdb-memory-unit-word)
2898 (define-key map "g" 'gdb-memory-unit-giant)
2899 (define-key map "R" 'gdb-memory-set-rows)
2900 (define-key map "C" 'gdb-memory-set-columns)
2903 (defun gdb-memory-set-address-event (event)
2904 "Handle a click on address field in memory buffer header."
2906 (save-selected-window
2907 (select-window (posn-window (event-start event)))
2908 (gdb-memory-set-address)))
2910 ;; Non-event version for use within keymap
2911 (defun gdb-memory-set-address ()
2912 "Set the start memory address."
2914 (let ((arg (read-from-minibuffer "Memory address: ")))
2915 (setq gdb-memory-address arg))
2916 (gdb-invalidate-memory 'update))
2918 (defmacro def-gdb-set-positive-number (name variable echo-string &optional doc)
2919 "Define a function NAME which reads new VAR value from minibuffer."
2920 `(defun ,name (event)
2923 (save-selected-window
2924 (select-window (posn-window (event-start event)))
2925 (let* ((arg (read-from-minibuffer ,echo-string))
2926 (count (string-to-number arg)))
2928 (error "Positive number only")
2929 (customize-set-variable ',variable count)
2930 (gdb-invalidate-memory 'update))))))
2932 (def-gdb-set-positive-number
2936 "Set the number of data rows in memory window.")
2938 (def-gdb-set-positive-number
2939 gdb-memory-set-columns
2942 "Set the number of data columns in memory window.")
2944 (defmacro def-gdb-memory-format (name format doc)
2945 "Define a function NAME to switch memory buffer to use FORMAT.
2947 DOC is an optional documentation string."
2948 `(defun ,name () ,(when doc doc)
2950 (customize-set-variable 'gdb-memory-format ,format)
2951 (gdb-invalidate-memory 'update)))
2953 (def-gdb-memory-format
2954 gdb-memory-format-binary "t"
2955 "Set the display format to binary.")
2957 (def-gdb-memory-format
2958 gdb-memory-format-octal "o"
2959 "Set the display format to octal.")
2961 (def-gdb-memory-format
2962 gdb-memory-format-unsigned "u"
2963 "Set the display format to unsigned decimal.")
2965 (def-gdb-memory-format
2966 gdb-memory-format-signed "d"
2967 "Set the display format to decimal.")
2969 (def-gdb-memory-format
2970 gdb-memory-format-hexadecimal "x"
2971 "Set the display format to hexadecimal.")
2973 (defvar gdb-memory-format-map
2974 (let ((map (make-sparse-keymap)))
2975 (define-key map [header-line down-mouse-3] 'gdb-memory-format-menu-1)
2977 "Keymap to select format in the header line.")
2979 (defvar gdb-memory-format-menu (make-sparse-keymap "Format")
2980 "Menu of display formats in the header line.")
2982 (define-key gdb-memory-format-menu [binary]
2983 '(menu-item "Binary" gdb-memory-format-binary
2984 :button (:radio . (equal gdb-memory-format "t"))))
2985 (define-key gdb-memory-format-menu [octal]
2986 '(menu-item "Octal" gdb-memory-format-octal
2987 :button (:radio . (equal gdb-memory-format "o"))))
2988 (define-key gdb-memory-format-menu [unsigned]
2989 '(menu-item "Unsigned Decimal" gdb-memory-format-unsigned
2990 :button (:radio . (equal gdb-memory-format "u"))))
2991 (define-key gdb-memory-format-menu [signed]
2992 '(menu-item "Signed Decimal" gdb-memory-format-signed
2993 :button (:radio . (equal gdb-memory-format "d"))))
2994 (define-key gdb-memory-format-menu [hexadecimal]
2995 '(menu-item "Hexadecimal" gdb-memory-format-hexadecimal
2996 :button (:radio . (equal gdb-memory-format "x"))))
2998 (defun gdb-memory-format-menu (event)
3000 (x-popup-menu event gdb-memory-format-menu))
3002 (defun gdb-memory-format-menu-1 (event)
3004 (save-selected-window
3005 (select-window (posn-window (event-start event)))
3006 (let* ((selection (gdb-memory-format-menu event))
3007 (binding (and selection (lookup-key gdb-memory-format-menu
3008 (vector (car selection))))))
3009 (if binding (call-interactively binding)))))
3011 (defmacro def-gdb-memory-unit (name unit-size doc)
3012 "Define a function NAME to switch memory unit size to UNIT-SIZE.
3014 DOC is an optional documentation string."
3015 `(defun ,name () ,(when doc doc)
3017 (customize-set-variable 'gdb-memory-unit ,unit-size)
3018 (gdb-invalidate-memory 'update)))
3020 (def-gdb-memory-unit gdb-memory-unit-giant 8
3021 "Set the unit size to giant words (eight bytes).")
3023 (def-gdb-memory-unit gdb-memory-unit-word 4
3024 "Set the unit size to words (four bytes).")
3026 (def-gdb-memory-unit gdb-memory-unit-halfword 2
3027 "Set the unit size to halfwords (two bytes).")
3029 (def-gdb-memory-unit gdb-memory-unit-byte 1
3030 "Set the unit size to bytes.")
3032 (defmacro def-gdb-memory-show-page (name address-var &optional doc)
3033 "Define a function NAME which show new address in memory buffer.
3035 The defined function switches Memory buffer to show address
3036 stored in ADDRESS-VAR variable.
3038 DOC is an optional documentation string."
3042 (let ((gdb-memory-address ,address-var))
3043 (gdb-invalidate-memory))))
3045 (def-gdb-memory-show-page gdb-memory-show-previous-page
3046 gdb-memory-prev-page)
3048 (def-gdb-memory-show-page gdb-memory-show-next-page
3049 gdb-memory-next-page)
3051 (defvar gdb-memory-unit-map
3052 (let ((map (make-sparse-keymap)))
3053 (define-key map [header-line down-mouse-3] 'gdb-memory-unit-menu-1)
3055 "Keymap to select units in the header line.")
3057 (defvar gdb-memory-unit-menu (make-sparse-keymap "Unit")
3058 "Menu of units in the header line.")
3060 (define-key gdb-memory-unit-menu [giantwords]
3061 '(menu-item "Giant words" gdb-memory-unit-giant
3062 :button (:radio . (equal gdb-memory-unit 8))))
3063 (define-key gdb-memory-unit-menu [words]
3064 '(menu-item "Words" gdb-memory-unit-word
3065 :button (:radio . (equal gdb-memory-unit 4))))
3066 (define-key gdb-memory-unit-menu [halfwords]
3067 '(menu-item "Halfwords" gdb-memory-unit-halfword
3068 :button (:radio . (equal gdb-memory-unit 2))))
3069 (define-key gdb-memory-unit-menu [bytes]
3070 '(menu-item "Bytes" gdb-memory-unit-byte
3071 :button (:radio . (equal gdb-memory-unit 1))))
3073 (defun gdb-memory-unit-menu (event)
3075 (x-popup-menu event gdb-memory-unit-menu))
3077 (defun gdb-memory-unit-menu-1 (event)
3079 (save-selected-window
3080 (select-window (posn-window (event-start event)))
3081 (let* ((selection (gdb-memory-unit-menu event))
3082 (binding (and selection (lookup-key gdb-memory-unit-menu
3083 (vector (car selection))))))
3084 (if binding (call-interactively binding)))))
3086 (defvar gdb-memory-font-lock-keywords
3087 '(;; <__function.name+n>
3088 ("<\\(\\(\\sw\\|[_.]\\)+\\)\\(\\+[0-9]+\\)?>" (1 font-lock-function-name-face))
3090 "Font lock keywords used in `gdb-memory-mode'.")
3092 (defvar gdb-memory-header
3097 'face font-lock-warning-face
3098 'help-echo "mouse-1: decrement address"
3099 'mouse-face 'mode-line-highlight
3100 'local-map (gdb-make-header-line-mouse-map
3102 #'gdb-memory-show-previous-page))
3105 'face font-lock-warning-face
3106 'help-echo "mouse-1: increment address"
3107 'mouse-face 'mode-line-highlight
3108 'local-map (gdb-make-header-line-mouse-map
3110 #'gdb-memory-show-next-page))
3112 (propertize gdb-memory-address
3113 'face font-lock-warning-face
3114 'help-echo "mouse-1: set start address"
3115 'mouse-face 'mode-line-highlight
3116 'local-map (gdb-make-header-line-mouse-map
3118 #'gdb-memory-set-address-event))
3120 (propertize (number-to-string gdb-memory-rows)
3121 'face font-lock-warning-face
3122 'help-echo "mouse-1: set number of columns"
3123 'mouse-face 'mode-line-highlight
3124 'local-map (gdb-make-header-line-mouse-map
3126 #'gdb-memory-set-rows))
3128 (propertize (number-to-string gdb-memory-columns)
3129 'face font-lock-warning-face
3130 'help-echo "mouse-1: set number of columns"
3131 'mouse-face 'mode-line-highlight
3132 'local-map (gdb-make-header-line-mouse-map
3134 #'gdb-memory-set-columns))
3136 (propertize gdb-memory-format
3137 'face font-lock-warning-face
3138 'help-echo "mouse-3: select display format"
3139 'mouse-face 'mode-line-highlight
3140 'local-map gdb-memory-format-map)
3142 (propertize (number-to-string gdb-memory-unit)
3143 'face font-lock-warning-face
3144 'help-echo "mouse-3: select unit size"
3145 'mouse-face 'mode-line-highlight
3146 'local-map gdb-memory-unit-map)))
3147 "Header line used in `gdb-memory-mode'.")
3149 (define-derived-mode gdb-memory-mode gdb-parent-mode "Memory"
3150 "Major mode for examining memory.
3152 \\{gdb-memory-mode-map}"
3153 (setq header-line-format gdb-memory-header)
3154 (set (make-local-variable 'font-lock-defaults)
3155 '(gdb-memory-font-lock-keywords))
3156 (run-mode-hooks 'gdb-memory-mode-hook)
3157 'gdb-invalidate-memory)
3159 (defun gdb-memory-buffer-name ()
3160 (concat "*memory of " (gdb-get-target-string) "*"))
3162 (def-gdb-display-buffer
3163 gdb-display-memory-buffer
3165 "Display memory contents.")
3167 (defun gdb-frame-memory-buffer ()
3168 "Display memory contents in a new frame."
3170 (let* ((special-display-regexps (append special-display-regexps '(".*")))
3171 (special-display-frame-alist
3175 ,@gdb-frame-parameters)))
3176 (display-buffer (gdb-get-buffer-create 'gdb-memory-buffer))))
3179 ;;; Disassembly view
3181 (defun gdb-disassembly-buffer-name ()
3182 (gdb-current-context-buffer-name
3183 (concat "disassembly of " (gdb-get-target-string))))
3185 (def-gdb-display-buffer
3186 gdb-display-disassembly-buffer
3187 'gdb-disassembly-buffer
3188 "Display disassembly for current stack frame.")
3190 (def-gdb-preempt-display-buffer
3191 gdb-preemptively-display-disassembly-buffer
3192 'gdb-disassembly-buffer)
3194 (def-gdb-frame-for-buffer
3195 gdb-frame-disassembly-buffer
3196 'gdb-disassembly-buffer
3197 "Display disassembly in a new frame.")
3199 (def-gdb-auto-update-trigger gdb-invalidate-disassembly
3200 (let* ((frame (gdb-current-buffer-frame))
3201 (file (bindat-get-field frame 'fullname))
3202 (line (bindat-get-field frame 'line)))
3204 (format "-data-disassemble -f %s -l %s -n -1 -- 0" file line)))
3205 gdb-disassembly-handler
3206 ;; We update disassembly only after we have actual frame information
3207 ;; about all threads, so no there's `update' signal in this list
3208 '(start update-disassembly))
3210 (def-gdb-auto-update-handler
3211 gdb-disassembly-handler
3212 gdb-invalidate-disassembly
3213 gdb-disassembly-handler-custom
3216 (gdb-set-buffer-rules
3217 'gdb-disassembly-buffer
3218 'gdb-disassembly-buffer-name
3219 'gdb-disassembly-mode
3220 'gdb-invalidate-disassembly)
3222 (defvar gdb-disassembly-font-lock-keywords
3223 '(;; <__function.name+n>
3224 ("<\\(\\(\\sw\\|[_.]\\)+\\)\\(\\+[0-9]+\\)?>"
3225 (1 font-lock-function-name-face))
3226 ;; 0xNNNNNNNN <__function.name+n>: opcode
3227 ("^0x[0-9a-f]+ \\(<\\(\\(\\sw\\|[_.]\\)+\\)\\+[0-9]+>\\)?:[ \t]+\\(\\sw+\\)"
3228 (4 font-lock-keyword-face))
3229 ;; %register(at least i386)
3230 ("%\\sw+" . font-lock-variable-name-face)
3231 ("^\\(Dump of assembler code for function\\) \\(.+\\):"
3232 (1 font-lock-comment-face)
3233 (2 font-lock-function-name-face))
3234 ("^\\(End of assembler dump\\.\\)" . font-lock-comment-face))
3235 "Font lock keywords used in `gdb-disassembly-mode'.")
3237 (defvar gdb-disassembly-mode-map
3239 (let ((map (make-sparse-keymap)))
3240 (suppress-keymap map)
3241 (define-key map "q" 'kill-this-buffer)
3244 (define-derived-mode gdb-disassembly-mode gdb-parent-mode "Disassembly"
3245 "Major mode for GDB disassembly information.
3247 \\{gdb-disassembly-mode-map}"
3248 ;; TODO Rename overlay variable for disassembly mode
3249 (add-to-list 'overlay-arrow-variable-list 'gdb-disassembly-position)
3250 (setq fringes-outside-margins t)
3251 (set (make-local-variable 'gdb-disassembly-position) (make-marker))
3252 (set (make-local-variable 'font-lock-defaults)
3253 '(gdb-disassembly-font-lock-keywords))
3254 (run-mode-hooks 'gdb-disassembly-mode-hook)
3255 'gdb-invalidate-disassembly)
3257 (defun gdb-disassembly-handler-custom ()
3258 (let* ((instructions (bindat-get-field (gdb-json-partial-output) 'asm_insns))
3259 (address (bindat-get-field (gdb-current-buffer-frame) 'addr))
3261 (table (make-gdb-table))
3263 (dolist (instr instructions)
3264 (gdb-table-add-row table
3266 (bindat-get-field instr 'address)
3267 (apply 'format `("<%s+%s>:" ,@(gdb-get-many-fields instr 'func-name 'offset)))
3268 (bindat-get-field instr 'inst)))
3269 (when (string-equal (bindat-get-field instr 'address)
3272 (setq marked-line (length (gdb-table-rows table)))
3273 (setq fringe-indicator-alist
3274 (if (string-equal gdb-frame-number "0")
3276 '((overlay-arrow . hollow-right-triangle)))))))
3277 (insert (gdb-table-string table " "))
3278 (gdb-disassembly-place-breakpoints)
3279 ;; Mark current position with overlay arrow and scroll window to
3282 (let ((window (get-buffer-window (current-buffer) 0)))
3283 (set-window-point window (gdb-mark-line marked-line gdb-disassembly-position))))
3285 (gdb-current-context-mode-name
3286 (concat "Disassembly: "
3287 (bindat-get-field (gdb-current-buffer-frame) 'func))))))
3289 (defun gdb-disassembly-place-breakpoints ()
3290 (gdb-remove-breakpoint-icons (point-min) (point-max))
3291 (dolist (breakpoint gdb-breakpoints-list)
3292 (let* ((breakpoint (cdr breakpoint))
3293 (bptno (bindat-get-field breakpoint 'number))
3294 (flag (bindat-get-field breakpoint 'enabled))
3295 (address (bindat-get-field breakpoint 'addr)))
3297 (goto-char (point-min))
3298 (if (re-search-forward (concat "^" address) nil t)
3299 (gdb-put-breakpoint-icon (string-equal flag "y") bptno))))))
3302 (defvar gdb-breakpoints-header
3304 (gdb-propertize-header "Breakpoints" gdb-breakpoints-buffer
3307 (gdb-propertize-header "Threads" gdb-threads-buffer
3308 "mouse-1: select" mode-line-highlight mode-line-inactive)))
3310 ;;; Breakpoints view
3311 (define-derived-mode gdb-breakpoints-mode gdb-parent-mode "Breakpoints"
3312 "Major mode for gdb breakpoints.
3314 \\{gdb-breakpoints-mode-map}"
3315 (setq header-line-format gdb-breakpoints-header)
3316 (run-mode-hooks 'gdb-breakpoints-mode-hook)
3317 'gdb-invalidate-breakpoints)
3319 (defun gdb-toggle-breakpoint ()
3320 "Enable/disable breakpoint at current line of breakpoints buffer."
3324 (let ((breakpoint (get-text-property (point) 'gdb-breakpoint)))
3327 (concat (if (string-equal "y" (bindat-get-field breakpoint 'enabled))
3330 (bindat-get-field breakpoint 'number)))
3331 (error "Not recognized as break/watchpoint line")))))
3333 (defun gdb-delete-breakpoint ()
3334 "Delete the breakpoint at current line of breakpoints buffer."
3338 (let ((breakpoint (get-text-property (point) 'gdb-breakpoint)))
3340 (gud-basic-call (concat "-break-delete " (bindat-get-field breakpoint 'number)))
3341 (error "Not recognized as break/watchpoint line")))))
3343 (defun gdb-goto-breakpoint (&optional event)
3344 "Go to the location of breakpoint at current line of
3345 breakpoints buffer."
3346 (interactive (list last-input-event))
3347 (if event (posn-set-point (event-end event)))
3348 ;; Hack to stop gdb-goto-breakpoint displaying in GUD buffer.
3349 (let ((window (get-buffer-window gud-comint-buffer)))
3350 (if window (save-selected-window (select-window window))))
3353 (let ((breakpoint (get-text-property (point) 'gdb-breakpoint)))
3355 (let ((bptno (bindat-get-field breakpoint 'number))
3356 (file (bindat-get-field breakpoint 'fullname))
3357 (line (bindat-get-field breakpoint 'line)))
3358 (save-selected-window
3359 (let* ((buffer (find-file-noselect
3360 (if (file-exists-p file) file
3361 (cdr (assoc bptno gdb-location-alist)))))
3362 (window (or (gdb-display-source-buffer buffer)
3363 (display-buffer buffer))))
3364 (setq gdb-source-window window)
3365 (with-current-buffer buffer
3366 (goto-char (point-min))
3367 (forward-line (1- (string-to-number line)))
3368 (set-window-point window (point))))))
3369 (error "Not recognized as break/watchpoint line")))))
3372 ;; Frames buffer. This displays a perpetually correct bactrack trace.
3374 (def-gdb-trigger-and-handler
3375 gdb-invalidate-frames (gdb-current-context-command "-stack-list-frames")
3376 gdb-stack-list-frames-handler gdb-stack-list-frames-custom
3379 (gdb-set-buffer-rules
3381 'gdb-stack-buffer-name
3383 'gdb-invalidate-frames)
3385 (defun gdb-frame-location (frame)
3386 "Return \" of file:line\" or \" of library\" for structure FRAME.
3388 FRAME must have either \"file\" and \"line\" members or \"from\"
3390 (let ((file (bindat-get-field frame 'file))
3391 (line (bindat-get-field frame 'line))
3392 (from (bindat-get-field frame 'from)))
3393 (let ((res (or (and file line (concat file ":" line))
3395 (if res (concat " of " res) ""))))
3397 (defun gdb-stack-list-frames-custom ()
3398 (let ((stack (bindat-get-field (gdb-json-partial-output "frame") 'stack))
3399 (table (make-gdb-table)))
3400 (set-marker gdb-stack-position nil)
3401 (dolist (frame stack)
3402 (gdb-table-add-row table
3404 (bindat-get-field frame 'level)
3407 (bindat-get-field frame 'func)
3408 (if gdb-stack-buffer-locations
3409 (gdb-frame-location frame) "")
3410 (if gdb-stack-buffer-addresses
3411 (concat " at " (bindat-get-field frame 'addr)) "")))
3412 `(mouse-face highlight
3413 help-echo "mouse-2, RET: Select frame"
3415 (insert (gdb-table-string table " ")))
3416 (when (and gdb-frame-number
3417 (gdb-buffer-shows-main-thread-p))
3418 (gdb-mark-line (1+ (string-to-number gdb-frame-number))
3419 gdb-stack-position))
3421 (gdb-current-context-mode-name "Frames")))
3423 (defun gdb-stack-buffer-name ()
3424 (gdb-current-context-buffer-name
3425 (concat "stack frames of " (gdb-get-target-string))))
3427 (def-gdb-display-buffer
3428 gdb-display-stack-buffer
3430 "Display backtrace of current stack.")
3432 (def-gdb-preempt-display-buffer
3433 gdb-preemptively-display-stack-buffer
3434 'gdb-stack-buffer nil t)
3436 (def-gdb-frame-for-buffer
3437 gdb-frame-stack-buffer
3439 "Display backtrace of current stack in a new frame.")
3441 (defvar gdb-frames-mode-map
3442 (let ((map (make-sparse-keymap)))
3443 (suppress-keymap map)
3444 (define-key map "q" 'kill-this-buffer)
3445 (define-key map "\r" 'gdb-select-frame)
3446 (define-key map [mouse-2] 'gdb-select-frame)
3447 (define-key map [follow-link] 'mouse-face)
3450 (defvar gdb-frames-font-lock-keywords
3451 '(("in \\([^ ]+\\)" (1 font-lock-function-name-face)))
3452 "Font lock keywords used in `gdb-frames-mode'.")
3454 (define-derived-mode gdb-frames-mode gdb-parent-mode "Frames"
3455 "Major mode for gdb call stack.
3457 \\{gdb-frames-mode-map}"
3458 (setq gdb-stack-position (make-marker))
3459 (add-to-list 'overlay-arrow-variable-list 'gdb-stack-position)
3460 (setq truncate-lines t) ;; Make it easier to see overlay arrow.
3461 (set (make-local-variable 'font-lock-defaults)
3462 '(gdb-frames-font-lock-keywords))
3463 (run-mode-hooks 'gdb-frames-mode-hook)
3464 'gdb-invalidate-frames)
3466 (defun gdb-select-frame (&optional event)
3467 "Select the frame and display the relevant source."
3468 (interactive (list last-input-event))
3469 (if event (posn-set-point (event-end event)))
3470 (let ((frame (get-text-property (point) 'gdb-frame)))
3472 (if (gdb-buffer-shows-main-thread-p)
3473 (let ((new-level (bindat-get-field frame 'level)))
3474 (setq gdb-frame-number new-level)
3475 (gdb-input (list (concat "-stack-select-frame " new-level) 'ignore))
3477 (error "Could not select frame for non-current thread."))
3478 (error "Not recognized as frame line"))))
3482 ;; uses "-stack-list-locals --simple-values". Needs GDB 6.1 onwards.
3483 (def-gdb-trigger-and-handler
3484 gdb-invalidate-locals
3485 (concat (gdb-current-context-command "-stack-list-locals") " --simple-values")
3486 gdb-locals-handler gdb-locals-handler-custom
3489 (gdb-set-buffer-rules
3491 'gdb-locals-buffer-name
3493 'gdb-invalidate-locals)
3495 (defvar gdb-locals-watch-map
3496 (let ((map (make-sparse-keymap)))
3497 (suppress-keymap map)
3498 (define-key map "\r" 'gud-watch)
3499 (define-key map [mouse-2] 'gud-watch)
3501 "Keymap to create watch expression of a complex data type local variable.")
3503 (defvar gdb-edit-locals-map-1
3504 (let ((map (make-sparse-keymap)))
3505 (suppress-keymap map)
3506 (define-key map "\r" 'gdb-edit-locals-value)
3507 (define-key map [mouse-2] 'gdb-edit-locals-value)
3509 "Keymap to edit value of a simple data type local variable.")
3511 (defun gdb-edit-locals-value (&optional event)
3512 "Assign a value to a variable displayed in the locals buffer."
3513 (interactive (list last-input-event))
3515 (if event (posn-set-point (event-end event)))
3517 (let* ((var (bindat-get-field
3518 (get-text-property (point) 'gdb-local-variable) 'name))
3519 (value (read-string (format "New value (%s): " var))))
3521 (concat "-gdb-set variable " var " = " value)))))
3523 ;; Dont display values of arrays or structures.
3524 ;; These can be expanded using gud-watch.
3525 (defun gdb-locals-handler-custom ()
3526 (let ((locals-list (bindat-get-field (gdb-json-partial-output) 'locals))
3527 (table (make-gdb-table)))
3528 (dolist (local locals-list)
3529 (let ((name (bindat-get-field local 'name))
3530 (value (bindat-get-field local 'value))
3531 (type (bindat-get-field local 'type)))
3533 (string-match "\\0x" value))
3534 (add-text-properties 0 (length name)
3535 `(mouse-face highlight
3536 help-echo "mouse-2: create watch expression"
3537 local-map ,gdb-locals-watch-map)
3539 (add-text-properties 0 (length value)
3540 `(mouse-face highlight
3541 help-echo "mouse-2: edit value"
3542 local-map ,gdb-edit-locals-map-1)
3547 (propertize type 'font-lock-face font-lock-type-face)
3548 (propertize name 'font-lock-face font-lock-variable-name-face)
3550 `(gdb-local-variable ,local))))
3551 (insert (gdb-table-string table " "))
3553 (gdb-current-context-mode-name
3554 (concat "Locals: " (bindat-get-field (gdb-current-buffer-frame) 'func))))))
3556 (defvar gdb-locals-header
3558 (gdb-propertize-header "Locals" gdb-locals-buffer
3561 (gdb-propertize-header "Registers" gdb-registers-buffer
3562 "mouse-1: select" mode-line-highlight mode-line-inactive)))
3564 (defvar gdb-locals-mode-map
3565 (let ((map (make-sparse-keymap)))
3566 (suppress-keymap map)
3567 (define-key map "q" 'kill-this-buffer)
3568 (define-key map "\t" '(lambda ()
3570 (gdb-set-window-buffer
3571 (gdb-get-buffer-create
3572 'gdb-registers-buffer
3573 gdb-thread-number) t)))
3576 (define-derived-mode gdb-locals-mode gdb-parent-mode "Locals"
3577 "Major mode for gdb locals.
3579 \\{gdb-locals-mode-map}"
3580 (setq header-line-format gdb-locals-header)
3581 (run-mode-hooks 'gdb-locals-mode-hook)
3582 'gdb-invalidate-locals)
3584 (defun gdb-locals-buffer-name ()
3585 (gdb-current-context-buffer-name
3586 (concat "locals of " (gdb-get-target-string))))
3588 (def-gdb-display-buffer
3589 gdb-display-locals-buffer
3591 "Display local variables of current stack and their values.")
3593 (def-gdb-preempt-display-buffer
3594 gdb-preemptively-display-locals-buffer
3595 'gdb-locals-buffer nil t)
3597 (def-gdb-frame-for-buffer
3598 gdb-frame-locals-buffer
3600 "Display local variables of current stack and their values in a new frame.")
3603 ;; Registers buffer.
3605 (def-gdb-trigger-and-handler
3606 gdb-invalidate-registers
3607 (concat (gdb-current-context-command "-data-list-register-values") " x")
3608 gdb-registers-handler
3609 gdb-registers-handler-custom
3612 (gdb-set-buffer-rules
3613 'gdb-registers-buffer
3614 'gdb-registers-buffer-name
3616 'gdb-invalidate-registers)
3618 (defun gdb-registers-handler-custom ()
3619 (when gdb-register-names
3620 (let ((register-values (bindat-get-field (gdb-json-partial-output) 'register-values))
3621 (table (make-gdb-table)))
3622 (dolist (register register-values)
3623 (let* ((register-number (bindat-get-field register 'number))
3624 (value (bindat-get-field register 'value))
3625 (register-name (nth (string-to-number register-number)
3626 gdb-register-names)))
3630 (propertize register-name 'font-lock-face font-lock-variable-name-face)
3631 (if (member register-number gdb-changed-registers)
3632 (propertize value 'font-lock-face font-lock-warning-face)
3634 `(mouse-face highlight
3635 help-echo "mouse-2: edit value"
3636 gdb-register-name ,register-name))))
3637 (insert (gdb-table-string table " ")))
3639 (gdb-current-context-mode-name "Registers"))))
3641 (defun gdb-edit-register-value (&optional event)
3642 "Assign a value to a register displayed in the registers buffer."
3643 (interactive (list last-input-event))
3645 (if event (posn-set-point (event-end event)))
3647 (let* ((var (bindat-get-field
3648 (get-text-property (point) 'gdb-register-name)))
3649 (value (read-string (format "New value (%s): " var))))
3651 (concat "-gdb-set variable $" var " = " value)))))
3653 (defvar gdb-registers-mode-map
3654 (let ((map (make-sparse-keymap)))
3655 (suppress-keymap map)
3656 (define-key map "\r" 'gdb-edit-register-value)
3657 (define-key map [mouse-2] 'gdb-edit-register-value)
3658 (define-key map "q" 'kill-this-buffer)
3659 (define-key map "\t" '(lambda ()
3661 (gdb-set-window-buffer
3662 (gdb-get-buffer-create
3664 gdb-thread-number) t)))
3667 (defvar gdb-registers-header
3669 (gdb-propertize-header "Locals" gdb-locals-buffer
3670 "mouse-1: select" mode-line-highlight mode-line-inactive)
3672 (gdb-propertize-header "Registers" gdb-registers-buffer
3673 nil nil mode-line)))
3675 (define-derived-mode gdb-registers-mode gdb-parent-mode "Registers"
3676 "Major mode for gdb registers.
3678 \\{gdb-registers-mode-map}"
3679 (setq header-line-format gdb-registers-header)
3680 (run-mode-hooks 'gdb-registers-mode-hook)
3681 'gdb-invalidate-registers)
3683 (defun gdb-registers-buffer-name ()
3684 (gdb-current-context-buffer-name
3685 (concat "registers of " (gdb-get-target-string))))
3687 (def-gdb-display-buffer
3688 gdb-display-registers-buffer
3689 'gdb-registers-buffer
3690 "Display integer register contents.")
3692 (def-gdb-preempt-display-buffer
3693 gdb-preemptively-display-registers-buffer
3694 'gdb-registers-buffer nil t)
3696 (def-gdb-frame-for-buffer
3697 gdb-frame-registers-buffer
3698 'gdb-registers-buffer
3699 "Display integer register contents in a new frame.")
3701 ;; Needs GDB 6.4 onwards (used to fail with no stack).
3702 (defun gdb-get-changed-registers ()
3703 (if (and (gdb-get-buffer 'gdb-registers-buffer)
3704 (not (gdb-pending-p 'gdb-get-changed-registers)))
3708 "-data-list-changed-registers"
3709 'gdb-changed-registers-handler))
3710 (gdb-add-pending 'gdb-get-changed-registers))))
3712 (defun gdb-changed-registers-handler ()
3713 (gdb-delete-pending 'gdb-get-changed-registers)
3714 (setq gdb-changed-registers nil)
3715 (dolist (register-number (bindat-get-field (gdb-json-partial-output) 'changed-registers))
3716 (push register-number gdb-changed-registers)))
3718 (defun gdb-register-names-handler ()
3719 ;; Don't use gdb-pending-triggers because this handler is called
3720 ;; only once (in gdb-init-1)
3721 (setq gdb-register-names nil)
3722 (dolist (register-name (bindat-get-field (gdb-json-partial-output) 'register-names))
3723 (push register-name gdb-register-names))
3724 (setq gdb-register-names (reverse gdb-register-names)))
3727 (defun gdb-get-source-file-list ()
3728 "Create list of source files for current GDB session.
3729 If buffers already exist for any of these files, gud-minor-mode
3731 (goto-char (point-min))
3732 (while (re-search-forward gdb-source-file-regexp nil t)
3733 (push (match-string 1) gdb-source-file-list))
3734 (dolist (buffer (buffer-list))
3735 (with-current-buffer buffer
3736 (when (member buffer-file-name gdb-source-file-list)
3737 (gdb-init-buffer))))
3738 (gdb-force-mode-line-update
3739 (propertize "ready" 'face font-lock-variable-name-face)))
3741 (defun gdb-get-main-selected-frame ()
3742 "Trigger for `gdb-frame-handler' which uses main current
3743 thread. Called from `gdb-update'."
3744 (if (not (gdb-pending-p 'gdb-get-main-selected-frame))
3747 (list (gdb-current-context-command "-stack-info-frame") 'gdb-frame-handler))
3748 (gdb-add-pending 'gdb-get-main-selected-frame))))
3750 (defun gdb-frame-handler ()
3751 "Sets `gdb-selected-frame' and `gdb-selected-file' to show
3752 overlay arrow in source buffer."
3753 (gdb-delete-pending 'gdb-get-main-selected-frame)
3754 (let ((frame (bindat-get-field (gdb-json-partial-output) 'frame)))
3756 (setq gdb-selected-frame (bindat-get-field frame 'func))
3757 (setq gdb-selected-file (bindat-get-field frame 'fullname))
3758 (setq gdb-frame-number (bindat-get-field frame 'level))
3759 (setq gdb-frame-address (bindat-get-field frame 'addr))
3760 (let ((line (bindat-get-field frame 'line)))
3761 (setq gdb-selected-line (or (and line (string-to-number line))
3762 nil)) ; don't fail if line is nil
3763 (when line ; obey the current file only if we have line info
3764 (setq gud-last-frame (cons gdb-selected-file gdb-selected-line))
3765 (gud-display-frame)))
3766 (if gud-overlay-arrow-position
3767 (let ((buffer (marker-buffer gud-overlay-arrow-position))
3768 (position (marker-position gud-overlay-arrow-position)))
3770 (with-current-buffer buffer
3771 (setq fringe-indicator-alist
3772 (if (string-equal gdb-frame-number "0")
3774 '((overlay-arrow . hollow-right-triangle))))
3775 (setq gud-overlay-arrow-position (make-marker))
3776 (set-marker gud-overlay-arrow-position position))))))))
3778 (defvar gdb-prompt-name-regexp "value=\"\\(.*?\\)\"")
3780 (defun gdb-get-prompt ()
3781 "Find prompt for GDB session."
3782 (goto-char (point-min))
3783 (setq gdb-prompt-name nil)
3784 (re-search-forward gdb-prompt-name-regexp nil t)
3785 (setq gdb-prompt-name (match-string 1))
3786 ;; Insert first prompt.
3787 (setq gdb-filter-output (concat gdb-filter-output gdb-prompt-name)))
3789 ;;;; Window management
3790 (defun gdb-display-buffer (buf dedicated &optional frame)
3793 If BUF is already displayed in some window, show it, deiconifying
3794 the frame if necessary. Otherwise, find least recently used
3795 window and show BUF there, if the window is not used for GDB
3796 already, in which case that window is splitted first."
3797 (let ((answer (get-buffer-window buf (or frame 0))))
3799 (display-buffer buf nil (or frame 0)) ;Deiconify the frame if necessary.
3800 (let ((window (get-lru-window)))
3801 (if (eq (buffer-local-value 'gud-minor-mode (window-buffer window))
3803 (let* ((largest (get-largest-window))
3804 (cur-size (window-height largest)))
3805 (setq answer (split-window largest))
3806 (set-window-buffer answer buf)
3807 (set-window-dedicated-p answer dedicated)
3809 (set-window-buffer window buf)
3812 (defun gdb-preempt-existing-or-display-buffer (buf &optional split-horizontal)
3813 "Find window displaying a buffer with the same
3814 `gdb-buffer-type' as BUF and show BUF there. If no such window
3815 exists, just call `gdb-display-buffer' for BUF. If the window
3816 found is already dedicated, split window according to
3817 SPLIT-HORIZONTAL and show BUF in the new window."
3819 (when (not (get-buffer-window buf))
3820 (let* ((buf-type (gdb-buffer-type buf))
3822 (get-window-with-predicate
3825 (gdb-buffer-type (window-buffer w)))
3826 (not (window-dedicated-p w)))))))
3828 (set-window-buffer existing-window buf)
3829 (let ((dedicated-window
3830 (get-window-with-predicate
3833 (gdb-buffer-type (window-buffer w)))))))
3834 (if dedicated-window
3836 (split-window dedicated-window nil split-horizontal) buf)
3837 (gdb-display-buffer buf t))))))
3838 (error "Null buffer")))
3840 ;;; Shared keymap initialization:
3842 (let ((menu (make-sparse-keymap "GDB-Windows")))
3843 (define-key gud-menu-map [displays]
3844 `(menu-item "GDB-Windows" ,menu
3845 :visible (eq gud-minor-mode 'gdbmi)))
3846 (define-key menu [gdb] '("Gdb" . gdb-display-gdb-buffer))
3847 (define-key menu [threads] '("Threads" . gdb-display-threads-buffer))
3848 (define-key menu [memory] '("Memory" . gdb-display-memory-buffer))
3849 (define-key menu [disassembly]
3850 '("Disassembly" . gdb-display-disassembly-buffer))
3851 (define-key menu [registers] '("Registers" . gdb-display-registers-buffer))
3852 (define-key menu [inferior]
3853 '("IO" . gdb-display-io-buffer))
3854 (define-key menu [locals] '("Locals" . gdb-display-locals-buffer))
3855 (define-key menu [frames] '("Stack" . gdb-display-stack-buffer))
3856 (define-key menu [breakpoints]
3857 '("Breakpoints" . gdb-display-breakpoints-buffer)))
3859 (let ((menu (make-sparse-keymap "GDB-Frames")))
3860 (define-key gud-menu-map [frames]
3861 `(menu-item "GDB-Frames" ,menu
3862 :visible (eq gud-minor-mode 'gdbmi)))
3863 (define-key menu [gdb] '("Gdb" . gdb-frame-gdb-buffer))
3864 (define-key menu [threads] '("Threads" . gdb-frame-threads-buffer))
3865 (define-key menu [memory] '("Memory" . gdb-frame-memory-buffer))
3866 (define-key menu [disassembly] '("Disassembly" . gdb-frame-disassembly-buffer))
3867 (define-key menu [registers] '("Registers" . gdb-frame-registers-buffer))
3868 (define-key menu [inferior]
3869 '("IO" . gdb-frame-io-buffer))
3870 (define-key menu [locals] '("Locals" . gdb-frame-locals-buffer))
3871 (define-key menu [frames] '("Stack" . gdb-frame-stack-buffer))
3872 (define-key menu [breakpoints]
3873 '("Breakpoints" . gdb-frame-breakpoints-buffer)))
3875 (let ((menu (make-sparse-keymap "GDB-MI")))
3876 (define-key menu [gdb-customize]
3877 '(menu-item "Customize" (lambda () (interactive) (customize-group 'gdb))
3878 :help "Customize Gdb Graphical Mode options."))
3879 (define-key menu [gdb-many-windows]
3880 '(menu-item "Display Other Windows" gdb-many-windows
3881 :help "Toggle display of locals, stack and breakpoint information"
3882 :button (:toggle . gdb-many-windows)))
3883 (define-key menu [gdb-restore-windows]
3884 '(menu-item "Restore Window Layout" gdb-restore-windows
3885 :help "Restore standard layout for debug session."))
3886 (define-key menu [sep1]
3888 (define-key menu [all-threads]
3889 '(menu-item "GUD controls all threads"
3892 (setq gdb-gud-control-all-threads t))
3893 :help "GUD start/stop commands apply to all threads"
3894 :button (:radio . gdb-gud-control-all-threads)))
3895 (define-key menu [current-thread]
3896 '(menu-item "GUD controls current thread"
3899 (setq gdb-gud-control-all-threads nil))
3900 :help "GUD start/stop commands apply to current thread only"
3901 :button (:radio . (not gdb-gud-control-all-threads))))
3902 (define-key menu [sep2]
3904 (define-key menu [gdb-customize-reasons]
3905 '(menu-item "Customize switching..."
3908 (customize-option 'gdb-switch-reasons))))
3909 (define-key menu [gdb-switch-when-another-stopped]
3910 (menu-bar-make-toggle gdb-toggle-switch-when-another-stopped gdb-switch-when-another-stopped
3911 "Automatically switch to stopped thread"
3912 "GDB thread switching %s"
3913 "Switch to stopped thread"))
3914 (define-key gud-menu-map [mi]
3915 `(menu-item "GDB-MI" ,menu :visible (eq gud-minor-mode 'gdbmi))))
3917 ;; TODO Fit these into tool-bar-local-item-from-menu call in gud.el.
3918 ;; GDB-MI menu will need to be moved to gud.el. We can't use
3919 ;; tool-bar-local-item-from-menu here because it appends new buttons
3920 ;; to toolbar from right to left while we want our A/T throttle to
3921 ;; show up right before Run button.
3922 (define-key-after gud-tool-bar-map [all-threads]
3923 '(menu-item "Switch to non-stop/A mode" gdb-control-all-threads
3924 :image (find-image '((:type xpm :file "gud/thread.xpm")))
3925 :visible (and (eq gud-minor-mode 'gdbmi)
3927 (not gdb-gud-control-all-threads)))
3930 (define-key-after gud-tool-bar-map [current-thread]
3931 '(menu-item "Switch to non-stop/T mode" gdb-control-current-thread
3932 :image (find-image '((:type xpm :file "gud/all.xpm")))
3933 :visible (and (eq gud-minor-mode 'gdbmi)
3935 gdb-gud-control-all-threads))
3938 (defun gdb-frame-gdb-buffer ()
3939 "Display GUD buffer in a new frame."
3941 (let ((special-display-regexps (append special-display-regexps '(".*")))
3942 (special-display-frame-alist
3943 (remove '(menu-bar-lines) (remove '(tool-bar-lines)
3944 gdb-frame-parameters)))
3945 (same-window-regexps nil))
3946 (display-buffer gud-comint-buffer)))
3948 (defun gdb-display-gdb-buffer ()
3949 "Display GUD buffer."
3951 (let ((same-window-regexps nil))
3952 (select-window (display-buffer gud-comint-buffer nil 0))))
3954 (defun gdb-set-window-buffer (name &optional ignore-dedicated)
3955 "Set buffer of selected window to NAME and dedicate window.
3957 When IGNORE-DEDICATED is non-nil, buffer is set even if selected
3958 window is dedicated."
3959 (when ignore-dedicated
3960 (set-window-dedicated-p (selected-window) nil))
3961 (set-window-buffer (selected-window) (get-buffer name))
3962 (set-window-dedicated-p (selected-window) t))
3964 (defun gdb-setup-windows ()
3965 "Layout the window pattern for `gdb-many-windows'."
3966 (gdb-display-locals-buffer)
3967 (gdb-display-stack-buffer)
3968 (delete-other-windows)
3969 (gdb-display-breakpoints-buffer)
3970 (delete-other-windows)
3972 (pop-to-buffer gud-comint-buffer)
3973 (split-window nil ( / ( * (window-height) 3) 4))
3974 (split-window nil ( / (window-height) 3))
3975 (split-window-horizontally)
3977 (gdb-set-window-buffer (gdb-locals-buffer-name))
3980 (if gud-last-last-frame
3981 (gud-find-file (car gud-last-last-frame))
3983 (gud-find-file gdb-main-file)
3984 ;; Put buffer list in window if we
3985 ;; can't find a source file.
3986 (list-buffers-noselect))))
3987 (setq gdb-source-window (selected-window))
3988 (split-window-horizontally)
3990 (gdb-set-window-buffer
3991 (gdb-get-buffer-create 'gdb-inferior-io))
3993 (gdb-set-window-buffer (gdb-stack-buffer-name))
3994 (split-window-horizontally)
3996 (gdb-set-window-buffer (if gdb-show-threads-by-default
3997 (gdb-threads-buffer-name)
3998 (gdb-breakpoints-buffer-name)))
4001 (defcustom gdb-many-windows nil
4002 "If nil just pop up the GUD buffer unless `gdb-show-main' is t.
4003 In this case it starts with two windows: one displaying the GUD
4004 buffer and the other with the source file with the main routine
4005 of the debugged program. Non-nil means display the layout shown for
4011 (defun gdb-many-windows (arg)
4012 "Toggle the number of windows in the basic arrangement.
4013 With arg, display additional buffers iff arg is positive."
4015 (setq gdb-many-windows
4017 (not gdb-many-windows)
4018 (> (prefix-numeric-value arg) 0)))
4019 (message (format "Display of other windows %sabled"
4020 (if gdb-many-windows "en" "dis")))
4021 (if (and gud-comint-buffer
4022 (buffer-name gud-comint-buffer))
4024 (gdb-restore-windows)
4027 (defun gdb-restore-windows ()
4028 "Restore the basic arrangement of windows used by gdb.
4029 This arrangement depends on the value of `gdb-many-windows'."
4031 (pop-to-buffer gud-comint-buffer) ;Select the right window and frame.
4032 (delete-other-windows)
4033 (if gdb-many-windows
4035 (when (or gud-last-last-frame gdb-show-main)
4039 (if gud-last-last-frame
4040 (gud-find-file (car gud-last-last-frame))
4041 (gud-find-file gdb-main-file)))
4042 (setq gdb-source-window (selected-window))
4046 "Exit a debugging session cleanly.
4047 Kills the gdb buffers, and resets variables and the source buffers."
4048 (dolist (buffer (buffer-list))
4049 (unless (eq buffer gud-comint-buffer)
4050 (with-current-buffer buffer
4051 (if (eq gud-minor-mode 'gdbmi)
4052 (if (string-match "\\` ?\\*.+\\*\\'" (buffer-name))
4054 (gdb-remove-breakpoint-icons (point-min) (point-max) t)
4055 (setq gud-minor-mode nil)
4056 (kill-local-variable 'tool-bar-map)
4057 (kill-local-variable 'gdb-define-alist))))))
4058 (setq gdb-disassembly-position nil)
4059 (setq overlay-arrow-variable-list
4060 (delq 'gdb-disassembly-position overlay-arrow-variable-list))
4061 (setq fringe-indicator-alist '((overlay-arrow . right-triangle)))
4062 (setq gdb-stack-position nil)
4063 (setq overlay-arrow-variable-list
4064 (delq 'gdb-stack-position overlay-arrow-variable-list))
4065 (setq gdb-thread-position nil)
4066 (setq overlay-arrow-variable-list
4067 (delq 'gdb-thread-position overlay-arrow-variable-list))
4068 (if (boundp 'speedbar-frame) (speedbar-timer-fn))
4069 (setq gud-running nil)
4070 (setq gdb-active-process nil)
4071 (remove-hook 'after-save-hook 'gdb-create-define-alist t))
4073 (defun gdb-get-source-file ()
4074 "Find the source file where the program starts and display it with related
4075 buffers, if required."
4076 (goto-char (point-min))
4077 (if (re-search-forward gdb-source-file-regexp nil t)
4078 (setq gdb-main-file (match-string 1)))
4079 (if gdb-many-windows
4081 (gdb-get-buffer-create 'gdb-breakpoints-buffer)
4083 (let ((pop-up-windows t))
4084 (display-buffer (gud-find-file gdb-main-file))))))
4087 (defun gdb-put-string (putstring pos &optional dprop &rest sprops)
4088 "Put string PUTSTRING in front of POS in the current buffer.
4089 PUTSTRING is displayed by putting an overlay into the current buffer with a
4090 `before-string' string that has a `display' property whose value is
4092 (let ((string (make-string 1 ?x))
4093 (buffer (current-buffer)))
4094 (setq putstring (copy-sequence putstring))
4095 (let ((overlay (make-overlay pos pos buffer))
4097 (list (list 'margin 'left-margin) putstring))))
4098 (put-text-property 0 1 'display prop string)
4100 (add-text-properties 0 1 sprops string))
4101 (overlay-put overlay 'put-break t)
4102 (overlay-put overlay 'before-string string))))
4104 ;;from remove-images
4105 (defun gdb-remove-strings (start end &optional buffer)
4106 "Remove strings between START and END in BUFFER.
4107 Remove only strings that were put in BUFFER with calls to `gdb-put-string'.
4108 BUFFER nil or omitted means use the current buffer."
4110 (setq buffer (current-buffer)))
4111 (dolist (overlay (overlays-in start end))
4112 (when (overlay-get overlay 'put-break)
4113 (delete-overlay overlay))))
4115 (defun gdb-put-breakpoint-icon (enabled bptno &optional line)
4116 (let* ((posns (gdb-line-posns (or line (line-number-at-pos))))
4117 (start (- (car posns) 1))
4118 (end (+ (cdr posns) 1))
4119 (putstring (if enabled "B" "b"))
4120 (source-window (get-buffer-window (current-buffer) 0)))
4121 (add-text-properties
4122 0 1 '(help-echo "mouse-1: clear bkpt, mouse-3: enable/disable bkpt")
4125 (add-text-properties
4126 0 1 `(gdb-bptno ,bptno gdb-enabled t) putstring)
4127 (add-text-properties
4128 0 1 `(gdb-bptno ,bptno gdb-enabled nil) putstring))
4129 (gdb-remove-breakpoint-icons start end)
4130 (if (display-images-p)
4131 (if (>= (or left-fringe-width
4132 (if source-window (car (window-fringes source-window)))
4133 gdb-buffer-fringe-width) 8)
4136 `(left-fringe breakpoint
4139 'breakpoint-disabled))
4141 'gdb-enabled enabled)
4142 (when (< left-margin-width 2)
4143 (save-current-buffer
4144 (setq left-margin-width 2)
4148 left-margin-width right-margin-width))))
4151 (or breakpoint-enabled-icon
4152 (setq breakpoint-enabled-icon
4153 (find-image `((:type xpm :data
4154 ,breakpoint-xpm-data
4155 :ascent 100 :pointer hand)
4157 ,breakpoint-enabled-pbm-data
4158 :ascent 100 :pointer hand)))))
4159 (or breakpoint-disabled-icon
4160 (setq breakpoint-disabled-icon
4161 (find-image `((:type xpm :data
4162 ,breakpoint-xpm-data
4163 :conversion disabled
4164 :ascent 100 :pointer hand)
4166 ,breakpoint-disabled-pbm-data
4167 :ascent 100 :pointer hand))))))
4171 (when (< left-margin-width 2)
4172 (save-current-buffer
4173 (setq left-margin-width 2)
4174 (let ((window (get-buffer-window (current-buffer) 0)))
4177 window left-margin-width right-margin-width)))))
4179 (propertize putstring
4180 'face (if enabled 'breakpoint-enabled 'breakpoint-disabled))
4183 (defun gdb-remove-breakpoint-icons (start end &optional remove-margin)
4184 (gdb-remove-strings start end)
4185 (if (display-images-p)
4186 (remove-images start end))
4188 (setq left-margin-width 0)
4189 (let ((window (get-buffer-window (current-buffer) 0)))
4192 window left-margin-width right-margin-width)))))
4196 ;; arch-tag: 1b41ea2b-f364-4cec-8f35-e02e4fe01912
4197 ;;; gdb-mi.el ends here