;;; gdb-ui.el --- User Interface for running GDB
-;; Author: Nick Roberts <nick@nick.uklinux.net>
+;; Author: Nick Roberts <nickrob@gnu.org>
;; Maintainer: FSF
;; Keywords: unix, tools
it starts with two windows: one displaying the GUD buffer and the
other with the source file with the main routine of the debugee.
-If `gdb-many-windows' is t the layout below will appear
-regardless of the value of `gdb-show-main'. Keybindings are given
-in relevant buffer.
+If `gdb-many-windows' is t, regardless of the value of
+`gdb-show-main', the layout below will appear unless
+`gdb-use-inferior-io-buffer' is nil when the source buffer
+occupies the full width of the frame. Keybindings are given in
+relevant buffer.
+
+Watch expressions appear in the speedbar/slowbar.
+
+The following interactive lisp functions help control operation :
+
+`gdb-many-windows' - Toggle the number of windows gdb uses.
+`gdb-restore-windows' - To restore the window layout.
+
+See Info node `(emacs)GDB Graphical Interface' for a more
+detailed description of this mode.
+
---------------------------------------------------------------------
GDB Toolbar
---------------------------------------------------------------------
-GUD buffer (I/O of GDB) | Locals buffer
+ GUD buffer (I/O of GDB) | Locals buffer
|
|
|
---------------------------------------------------------------------
-Source buffer | Input/Output (of debugee) buffer
+ Source buffer | Input/Output (of debugee) buffer
| (comint-mode)
|
|
|
|
---------------------------------------------------------------------
-Stack buffer | Breakpoints buffer
+ Stack buffer | Breakpoints buffer
RET gdb-frames-select | SPC gdb-toggle-breakpoint
| RET gdb-goto-breakpoint
| d gdb-delete-breakpoint
---------------------------------------------------------------------
-
-All the buffers share the toolbar and source should always display in the same
-window e.g after typing g on a breakpoint in the breakpoints buffer. Breakpoint
-icons are displayed both by setting a break with gud-break and by typing break
-in the GUD buffer.
-
-This works best (depending on the size of your monitor) using most of the
-screen.
-
-Displayed expressions appear in separate frames. Arrays may be displayed
-as slices and visualised using the graph program from plotutils if installed.
-Pointers in structures may be followed in a tree-like fashion.
-
-The following interactive lisp functions help control operation :
-
-`gdb-many-windows' - Toggle the number of windows gdb uses.
-`gdb-restore-windows' - To restore the window layout."
+"
;;
(interactive (list (gud-query-cmdline 'gdba)))
;;
(gdb-enqueue-input
(list (concat "server interpreter mi \"-var-create - * " expr "\"\n")
`(lambda () (gdb-var-create-handler ,expr))))))
- (select-window (get-buffer-window gud-comint-buffer)))
+ (select-window (get-buffer-window gud-comint-buffer 'visible)))
+
+(defun gdb-goto-info ()
+ "Go to Emacs info node: GDB Graphical Interface."
+ (interactive)
+ (select-frame (make-frame))
+ (require 'info)
+ (Info-goto-node "(emacs)GDB Graphical Interface"))
(defconst gdb-var-create-regexp
"name=\"\\(.*?\\)\",numchild=\"\\(.*?\\)\",type=\"\\(.*?\\)\"")
(string-to-int (match-string 2 args))))
(setq gdb-current-address (match-string 3 args))
(setq gdb-view-source t)
-;; cover for auto-display output which comes *before*
-;; stopped annotation
- (if (eq (gdb-get-output-sink) 'inferior) (gdb-set-output-sink 'user)))
+ ;; cover for auto-display output which comes *before*
+ ;; stopped annotation
+ (if (eq (gdb-get-output-sink) 'inferior) (gdb-set-output-sink 'user)))
(defun gdb-send-item (item)
(if gdb-enable-debug-log (push (cons 'send item) gdb-debug-log))
(if (gdb-get-buffer 'gdb-assembler-buffer) (gdb-assembler-custom)))
(defun gdb-mouse-toggle-breakpoint (event)
- "Toggle breakpoint with mouse click in left margin."
+ "Toggle breakpoint in left fringe/margin with mouse click"
(interactive "e")
(mouse-minibuffer-check event)
(let ((posn (event-end event)))
(concat "*breakpoints of " (gdb-get-target-string) "*")))
(defun gdb-display-breakpoints-buffer ()
+ "Display status of user-settable breakpoints."
(interactive)
(gdb-display-buffer
(gdb-get-create-buffer 'gdb-breakpoints-buffer)))
+(defconst gdb-frame-parameters
+ '((height . 12) (width . 60)
+ (unsplittable . t)
+ (tool-bar-lines . nil)
+ (menu-bar-lines . nil)
+ (minibuffer . nil)))
+
(defun gdb-frame-breakpoints-buffer ()
+ "Display status of user-settable breakpoints in a new frame."
(interactive)
- (switch-to-buffer-other-frame
- (gdb-get-create-buffer 'gdb-breakpoints-buffer)))
+ (select-frame (make-frame gdb-frame-parameters))
+ (switch-to-buffer (gdb-get-create-buffer 'gdb-breakpoints-buffer))
+ (set-window-dedicated-p (selected-window) t))
(defvar gdb-breakpoints-mode-map
(let ((map (make-sparse-keymap))
(gdb-enqueue-input
(list (concat "server delete " (match-string 1) "\n") 'ignore))))
-(defvar gdb-source-window nil)
-
(defun gdb-goto-breakpoint ()
- "Display the file in the source buffer at the breakpoint specified on the
-current line."
+ "Display the breakpoint location specified at current line."
(interactive)
(save-excursion
(beginning-of-line 1)
(let ((line (match-string 2))
(file (match-string 1)))
(save-selected-window
- (select-window gdb-source-window)
- (switch-to-buffer (find-file-noselect
- (if (file-exists-p file)
- file
- (expand-file-name file gdb-cdir))))
- (goto-line (string-to-number line))))))
+ (let* ((buf (find-file-noselect (if (file-exists-p file)
+ file
+ (expand-file-name file gdb-cdir))))
+ (window (gdb-display-buffer buf)))
+ (with-current-buffer buf
+ (goto-line (string-to-number line))
+ (set-window-point window (point))))))))
(defun gdb-mouse-goto-breakpoint (event)
- "Display the file in the source buffer at the selected breakpoint."
+ "Display the breakpoint location that you click on."
(interactive "e")
(mouse-set-point event)
(gdb-goto-breakpoint))
(concat "*stack frames of " (gdb-get-target-string) "*")))
(defun gdb-display-stack-buffer ()
+ "Display backtrace of current stack."
(interactive)
(gdb-display-buffer
(gdb-get-create-buffer 'gdb-stack-buffer)))
(defun gdb-frame-stack-buffer ()
+ "Display backtrace of current stack in a new frame."
(interactive)
- (switch-to-buffer-other-frame
- (gdb-get-create-buffer 'gdb-stack-buffer)))
+ (select-frame (make-frame gdb-frame-parameters))
+ (switch-to-buffer (gdb-get-create-buffer 'gdb-stack-buffer))
+ (set-window-dedicated-p (selected-window) t))
(defvar gdb-frames-mode-map
(let ((map (make-sparse-keymap)))
n)))
(defun gdb-frames-select ()
- "Make the frame on the current line become the current frame and display the
-source in the source buffer."
+ "Select the frame and display the relevant source."
(interactive)
(gdb-enqueue-input
(list (concat "server frame " (gdb-get-frame-number) "\n") 'ignore))
(gud-display-frame))
(defun gdb-frames-mouse-select (event)
- "Make the selected frame become the current frame and display the source in
-the source buffer."
+ "Select the frame you click on and display the relevant source."
(interactive "e")
(mouse-set-point event)
(gdb-frames-select))
(concat "*threads of " (gdb-get-target-string) "*")))
(defun gdb-display-threads-buffer ()
+ "Display IDs of currently known threads."
(interactive)
(gdb-display-buffer
(gdb-get-create-buffer 'gdb-threads-buffer)))
(defun gdb-frame-threads-buffer ()
+ "Display IDs of currently known threads in a new frame."
(interactive)
- (switch-to-buffer-other-frame
- (gdb-get-create-buffer 'gdb-threads-buffer)))
+ (select-frame (make-frame gdb-frame-parameters))
+ (switch-to-buffer (gdb-get-create-buffer 'gdb-threads-buffer))
+ (set-window-dedicated-p (selected-window) t))
(defvar gdb-threads-mode-map
(let ((map (make-sparse-keymap)))
(match-string-no-properties 1)))
(defun gdb-threads-select ()
- "Make the thread on the current line become the current thread and display the
-source in the source buffer."
+ "Select the thread and display the relevant source."
(interactive)
(gdb-enqueue-input
(list (concat "thread " (gdb-get-thread-number) "\n") 'ignore))
(gud-display-frame))
(defun gdb-threads-mouse-select (event)
- "Make the selected frame become the current frame and display the source in
-the source buffer."
+ "Select the thread you click on and display the relevant source."
(interactive "e")
(mouse-set-point event)
(gdb-threads-select))
(concat "*registers of " (gdb-get-target-string) "*")))
(defun gdb-display-registers-buffer ()
+ "Display integer register contents."
(interactive)
(gdb-display-buffer
(gdb-get-create-buffer 'gdb-registers-buffer)))
(defun gdb-frame-registers-buffer ()
+ "Display integer register contents in a new frame."
(interactive)
- (switch-to-buffer-other-frame
- (gdb-get-create-buffer 'gdb-registers-buffer)))
+ (select-frame (make-frame gdb-frame-parameters))
+ (switch-to-buffer (gdb-get-create-buffer 'gdb-registers-buffer))
+ (set-window-dedicated-p (selected-window) t))
\f
;;
;; Locals buffer.
(concat "*locals of " (gdb-get-target-string) "*")))
(defun gdb-display-locals-buffer ()
+ "Display local variables of current stack and their values."
(interactive)
(gdb-display-buffer
(gdb-get-create-buffer 'gdb-locals-buffer)))
(defun gdb-frame-locals-buffer ()
+ "Display local variables of current stack and their values in a new frame."
(interactive)
- (switch-to-buffer-other-frame
- (gdb-get-create-buffer 'gdb-locals-buffer)))
+ (select-frame (make-frame gdb-frame-parameters))
+ (switch-to-buffer (gdb-get-create-buffer 'gdb-locals-buffer))
+ (set-window-dedicated-p (selected-window) t))
\f
;;;; Window management
(progn
(walk-windows
#'(lambda (win)
- (if (or (eq gud-comint-buffer (window-buffer win))
- (eq gdb-source-window win))
+ (if (eq gud-comint-buffer (window-buffer win))
(set-window-dedicated-p win t))))
- (setq answer (get-buffer-window buf))
+ (setq answer (get-buffer-window buf 'visible))
(if (not answer)
- (let ((window (get-lru-window)))
+ (let ((window (get-lru-window 'visible)))
(if window
(progn
(set-window-buffer window buf)
(setq must-split t)))))
(walk-windows
#'(lambda (win)
- (if (or (eq gud-comint-buffer (window-buffer win))
- (eq gdb-source-window win))
+ (if (eq gud-comint-buffer (window-buffer win))
(set-window-dedicated-p win nil)))))
(if must-split
- (let* ((largest (get-largest-window))
+ (let* ((largest (get-largest-window 'visible))
(cur-size (window-height largest))
(new-size (and size (< size cur-size) (- cur-size size))))
(setq answer (split-window largest new-size))
(defun gdb-display-source-buffer (buffer)
(if (eq gdb-selected-view 'source)
- (progn
- (if (window-live-p gdb-source-window)
- (set-window-buffer gdb-source-window buffer)
- (gdb-display-buffer buffer)
- (setq gdb-source-window (get-buffer-window buffer)))
- gdb-source-window)
- (if (window-live-p gdb-source-window)
- (set-window-buffer gdb-source-window
- (gdb-get-buffer 'gdb-assembler-buffer))
- (let ((buf (gdb-get-buffer 'gdb-assembler-buffer)))
- (gdb-display-buffer buf)
- (setq gdb-source-window (get-buffer-window buf))))
- nil))
+ (gdb-display-buffer buffer)
+ (gdb-display-buffer (gdb-get-buffer 'gdb-assembler-buffer)))
+ (get-buffer-window buffer 'visible))
\f
;;; Shared keymap initialization:
(define-key gud-menu-map [frames]
`(menu-item "GDB-Frames" ,menu :visible (eq gud-minor-mode 'gdba)))
(define-key menu [gdb] '("Gdb" . gdb-frame-gdb-buffer))
- (define-key menu [locals] '("Locals" . gdb-frame-locals-buffer))
+ (define-key menu [threads] '("Threads" . gdb-frame-threads-buffer))
(define-key menu [registers] '("Registers" . gdb-frame-registers-buffer))
+ (define-key menu [locals] '("Locals" . gdb-frame-locals-buffer))
(define-key menu [frames] '("Stack" . gdb-frame-stack-buffer))
(define-key menu [breakpoints] '("Breakpoints" . gdb-frame-breakpoints-buffer))
- (define-key menu [threads] '("Threads" . gdb-frame-threads-buffer))
; (define-key menu [assembler] '("Machine" . gdb-frame-assembler-buffer))
)
(define-key gud-menu-map [displays]
`(menu-item "GDB-Windows" ,menu :visible (eq gud-minor-mode 'gdba)))
(define-key menu [gdb] '("Gdb" . gdb-display-gdb-buffer))
- (define-key menu [locals] '("Locals" . gdb-display-locals-buffer))
+ (define-key menu [threads] '("Threads" . gdb-display-threads-buffer))
(define-key menu [registers] '("Registers" . gdb-display-registers-buffer))
+ (define-key menu [locals] '("Locals" . gdb-display-locals-buffer))
(define-key menu [frames] '("Stack" . gdb-display-stack-buffer))
(define-key menu [breakpoints] '("Breakpoints" . gdb-display-breakpoints-buffer))
- (define-key menu [threads] '("Threads" . gdb-display-threads-buffer))
; (define-key menu [assembler] '("Machine" . gdb-display-assembler-buffer))
)
"Display locals, stack and breakpoint information")))
(defun gdb-frame-gdb-buffer ()
+ "Display GUD buffer in a new frame."
(interactive)
- (switch-to-buffer-other-frame
- (gdb-get-create-buffer 'gdba)))
+ (select-frame (make-frame gdb-frame-parameters))
+ (switch-to-buffer (gdb-get-create-buffer 'gdba))
+ (set-window-dedicated-p (selected-window) t))
(defun gdb-display-gdb-buffer ()
+ "Display GUD buffer."
(interactive)
(gdb-display-buffer
(gdb-get-create-buffer 'gdba)))
(defvar gdb-main-file nil "Source file from which program execution begins.")
(defun gdb-view-source-function ()
+ "Select source view."
(interactive)
(if gdb-view-source
- (if (window-live-p gdb-source-window)
- (set-window-buffer gdb-source-window
- (if gud-last-last-frame
- (gud-find-file (car gud-last-last-frame))
- (gud-find-file gdb-main-file)))
- (setq gdb-source-window
- (display-buffer
- (if gud-last-last-frame
- (gud-find-file (car gud-last-last-frame))
- (gud-find-file gdb-main-file))))))
+ (gdb-display-buffer
+ (if gud-last-last-frame
+ (gud-find-file (car gud-last-last-frame))
+ (gud-find-file gdb-main-file))))
(setq gdb-selected-view 'source))
(defun gdb-view-assembler()
+ "Select disassembly view."
(interactive)
- (if (window-live-p gdb-source-window)
- (set-window-buffer gdb-source-window
- (gdb-get-create-buffer 'gdb-assembler-buffer))
- (setq gdb-source-window
- (display-buffer (gdb-get-create-buffer 'gdb-assembler-buffer))))
+ (gdb-display-buffer (gdb-get-create-buffer 'gdb-assembler-buffer))
+ (gdb-invalidate-assembler)
(setq gdb-selected-view 'assembler))
;(defun gdb-view-both()
(gud-find-file (car gud-last-last-frame))
(gud-find-file gdb-main-file))
(gdb-get-create-buffer 'gdb-assembler-buffer)))
- (setq gdb-source-window (get-buffer-window (current-buffer)))
(when gdb-use-inferior-io-buffer
(split-window-horizontally)
(other-window 1)
(other-window 1))
(defcustom gdb-many-windows nil
- "Nil means that gdb starts with just two windows : the GUD and
-the source buffer."
+ "Nil (the default value) means just pop up the GUD buffer
+unless `gdb-show-main' is t. In this case it starts with two
+windows: one displaying the GUD buffer and the other with the
+source file with the main routine of the debugee. Non-nil means
+display the layout shown for `gdba'."
:type 'boolean
:group 'gud)
(if (null arg)
(not gdb-many-windows)
(> (prefix-numeric-value arg) 0)))
- (gdb-restore-windows))
+ (condition-case nil
+ (gdb-restore-windows)
+ (error nil)))
(defun gdb-restore-windows ()
"Restore the basic arrangement of windows used by gdba.
(gud-find-file (car gud-last-last-frame))
(gud-find-file gdb-main-file))
(gdb-get-create-buffer 'gdb-assembler-buffer)))
- (setq gdb-source-window (get-buffer-window (current-buffer)))
(other-window 1)))
(defun gdb-reset ()
(if gdb-view-source
(gud-find-file gdb-main-file)
(gdb-get-create-buffer 'gdb-assembler-buffer)))
- (setq gdb-source-window (get-buffer-window (current-buffer)))
(other-window 1))))
;;from put-image
(when (< left-margin-width 2)
(save-current-buffer
(setq left-margin-width 2)
- (if (get-buffer-window (current-buffer))
- (set-window-margins (get-buffer-window
- (current-buffer))
- left-margin-width
- right-margin-width))))
+ (if (get-buffer-window (current-buffer) 'visible)
+ (set-window-margins
+ (get-buffer-window (current-buffer) 'visible)
+ left-margin-width right-margin-width))))
(put-image
(if enabled
(or breakpoint-enabled-icon
(when (< left-margin-width 2)
(save-current-buffer
(setq left-margin-width 2)
- (if (get-buffer-window (current-buffer))
- (set-window-margins (get-buffer-window
- (current-buffer))
- left-margin-width
- right-margin-width))))
+ (if (get-buffer-window (current-buffer) 'visible)
+ (set-window-margins
+ (get-buffer-window (current-buffer) 'visible)
+ left-margin-width right-margin-width))))
(gdb-put-string (if enabled "B" "b") (1+ start)))))
(defun gdb-remove-breakpoint-icons (start end &optional remove-margin)
(remove-images start end))
(when remove-margin
(setq left-margin-width 0)
- (if (get-buffer-window (current-buffer))
- (set-window-margins (get-buffer-window
- (current-buffer))
- left-margin-width
- right-margin-width))))
+ (if (get-buffer-window (current-buffer) 'visible)
+ (set-window-margins
+ (get-buffer-window (current-buffer) 'visible)
+ left-margin-width right-margin-width))))
\f
;;
(if (re-search-forward address nil t)
(gdb-put-breakpoint-icon (eq flag ?y))))))))
(if (not (equal gdb-current-address "main"))
- (set-window-point (get-buffer-window buffer) pos))))
+ (set-window-point (get-buffer-window buffer 'visible) pos))))
(defvar gdb-assembler-mode-map
(let ((map (make-sparse-keymap)))
(concat "*Machine Code " (gdb-get-target-string) "*")))
(defun gdb-display-assembler-buffer ()
+ "Display disassembly view."
(interactive)
(gdb-display-buffer
(gdb-get-create-buffer 'gdb-assembler-buffer)))
(defun gdb-frame-assembler-buffer ()
+ "Display disassembly view in a new frame."
(interactive)
- (switch-to-buffer-other-frame
- (gdb-get-create-buffer 'gdb-assembler-buffer)))
+ (select-frame (make-frame gdb-frame-parameters))
+ (switch-to-buffer (gdb-get-create-buffer 'gdb-assembler-buffer))
+ (set-window-dedicated-p (selected-window) t))
;; modified because if gdb-current-address has changed value a new command
;; must be enqueued to update the buffer with the new output
(with-current-buffer (gdb-get-create-buffer 'gdb-partial-output-buffer)
(goto-char (point-min))
(forward-line)
- (if (looking-at ".*=\\s-+0x\\(\\S-*\\)\\s-+in\\s-+\\(\\S-*\\)")
+ (if (looking-at ".*=\\s-+0x\\(\\S-*\\)\\s-+in\\s-+\\(\\S-*?\\);? ")
(progn
(setq gdb-current-frame (match-string 2))
(let ((address (match-string 1)))
(progn (setq gdb-view-source nil) t))
(eq gdb-selected-view 'assembler))
(progn
- (set-window-buffer
- gdb-source-window
+ (gdb-display-buffer
(gdb-get-create-buffer 'gdb-assembler-buffer))
;;update with new frame for machine code if necessary
(gdb-invalidate-assembler))))))