lisp/progmodes/gud.el

1 ;;; gud.el --- Grand Unified Debugger mode for running GDB and other debuggers
20 ;; GNU General Public License for more details.
33 ;; <shane@spr.com> added support for xdb (HPUX debugger).  Rick Sladkey
38 ;; Derek L. Davies <ddavies@world.std.com> added support for jdb (Java
43 (eval-when-compile (require 'cl)) ; for case macro
60   "Grand Unified Debugger mode for gdb and other debuggers under Emacs.
90   "Return the symbol used for SYM in MINOR-MODE.
212   "Menu for `gud-mode'."
222 	. (,(propertize "down" 'face 'font-lock-doc-face) . gud-down))
224 	. (,(propertize "up" 'face 'font-lock-doc-face) . gud-up))
226 	. (,(propertize "finish" 'face 'font-lock-doc-face) . gud-finish))
228 	. (,(propertize "step" 'face 'font-lock-doc-face) . gud-step))
230 	. (,(propertize "next" 'face 'font-lock-doc-face) . gud-next))
232 	,(propertize "until" 'face 'font-lock-doc-face) gud-until
235 	,(propertize "cont" 'face 'font-lock-doc-face) gud-cont
238 	,(propertize "run" 'face 'font-lock-doc-face) gud-run
241 	,(propertize " go " 'face 'font-lock-doc-face) gud-go
245 	,(propertize "stop" 'face 'font-lock-doc-face) gud-stop-subjob
249 	. (,(propertize "print" 'face 'font-lock-doc-face) . gud-print))
374 ;; the debugger's output for indications of the current program counter.
470   "Wrapper for call to speedbar-add-expansion-list.   DIRECTORY and
499 	       0 (length expr) 'face font-lock-variable-name-face expr)
501 	       0 (length type) 'face font-lock-type-face type)
517 				    (changed 'font-lock-warning-face)
538 				      (changed 'font-lock-warning-face)
634     ;; Check for annotations and change gud-minor-mode to 'gdba if
660 			       'face font-lock-warning-face
667     ;; test for marker starts.
685   "Keymap for minibuffer prompting of gud startup command."
711   "Non-nil means this is text that has been saved for later in `gud-filter'.")
717 directory and source-file directory for your debugger.  By
719 `gdba' for more information.
722 option with \"--fullname\" either in the minibuffer for the
724 `gud-gdb-command-name' for all future sessions.  You need to use
773 ;; One of the nice features of GDB is its impressive support for
775 ;; in the GUD buffer by using a GDB command designed just for Emacs.
863    (sit-for 1)))
914 ;  "Learn GDB information for the currently selected stack frame in BUFFER."
990     ;; Search for the last incomplete line in this chunk
1005 and source-file directory for your debugger."
1040   "*A list of directories that dbx should search for source code.
1076     ;; Search for the last incomplete line in this chunk
1089 ;; Functions for Mips-style dbx.  Given the option `-emacs', documented in
1103 ;; This is just like the gdb one except for the regexps since we need to cope
1134     ;; test for marker starts.
1154 ;; available in $curline.  Thus we have to look for output which
1164 ;;   d.love@dl.ac.uk (Dave Love) can be blamed for this
1169   "Non-nil to assume the interface appropriate for IRIX dbx.
1178 ;; subtly sometime between OS v4.0.5 and v5.2 so that, for instance,
1194 ;; -emacs flag for gdb-like output (which ought to be possible as most
1207 	 ;; look for breakpoint or signal indication e.g.:
1218 	 ;; look for result of, say, "up" e.g.:
1241   "Non-nil means to assume the interface approriate for DG/UX dbx.
1276     ;; Search for the last incomplete line in this chunk
1293 and source-file directory for your debugger."
1360   "*A list of directories that xdb should search for source code.
1403 and source-file directory for your debugger.
1455 	    (error "No code specified for -e"))
1510     ;; test for marker starts.
1535 and source-file directory for your debugger."
1567 ;; Last group is for return value, e.g. "> test.py(2)foo()->None"
1616     ;; test for marker starts.
1633   "File name for executing the Python debugger.
1642 and source-file directory for your debugger."
1690 ;; for the name of the class to debug (e.g. "COM.the-kind.ddavies.CoolClass").
1691 ;; See the known problems section below for restrictions when specifying jdb
1692 ;; command line switches (search forward for '-classpath').
1726 ;; Does not grok UNICODE id's.  Only ASCII id's are supported.
1729 ;; search for java classes even though it is required when invoking jdb
1730 ;; from the command line.  See gud-jdb-massage-args for details.
1731 ;; The same applies for "-sourcepath".
1735 ;; `gud-jdb-classpath',`gud-jdb-sourcepath' variables for information
1736 ;; on using the classpath for locating java source files.
1763   "If non-nil, search for Java source files in classpath directories.
1771 and parsing all Java files for class information.
1773 Set to nil to use `gud-jdb-directories' to scan java sources for
1789 3) Send a \"classpath\" command to jdb and scan jdb output for
1801 list of directories searched for source files.")
1806 the most recent debugger output history while searching for
1815   "*A list of directories that gud jdb should search for source code.
1827 "List of the java source files for this debugging session.")
1842 PATH gives the directories in which to search for files with
1887 ;; Move point past things that are id-like.  The intent is to skip regular
1888 ;; id's, such as class or interface names as well as package and interface
1890 (defun gud-jdb-skip-id-ish-thing ()
1924     ;; characters and/or the delimiters for the constructs themselves.
1993 	      (gud-jdb-skip-id-ish-thing)
2003 	    (gud-jdb-skip-id-ish-thing)
2022 	      (gud-jdb-skip-id-ish-thing)
2038 (defun gud-jdb-build-class-source-alist-for-file (file)
2053 	'gud-jdb-build-class-source-alist-for-file
2067   ;; gud-common-init).  There are more switches like this (for
2093 	;; could fix things and re-invoke gud-common-init, but for now I think
2101 ;; Search for an association with P, a fully qualified class name, in
2140 "Alias for function used to locate source files.
2155 ;; See comentary for other debugger's marker filters - there you will find
2165   ;; Look for classpath information until gud-jdb-classpath-string is found
2195 	 ;; for instance, are called <init> in the symbol table.)
2209          ;; of Sun's total disrespect for backwards compatibility in
2273 See `gud-jdb-use-classpath' and `gud-jdb-classpath' documentation for
2275 `gud-jdb-use-classpath' is nil), see `gud-jdb-directories' for the
2291   (setq gud-jdb-classpath-string nil)	; prepare for next
2301   (setq gud-jdb-classpath-string nil)	; prepare for next
2371 ;; waits for a response from the debugger, and the new prompt is
2393   "Major mode for interacting with an inferior debugger process.
2419 around point, and sends it to the debugger for value display.
2437 All pre-defined functions for which the concept make sense repeat
2444 Other commands for interacting with the debugger process are inherited from
2473 ;; for local variables in the debugger buffer.
2546 It is saved for when this flag is not set.")
2548 ;; These functions are responsible for inserting output from your debugger
2558 	    ;; save it for later.
2581 		;; Save the process output, checking for source file markers.
2583 		;; Check for a filename-and-line number.
2693   (let* ((last-nonmenu-event t)	 ; Prevent use of dialog box for questions.
2817     (sit-for 0)
2826     ;; Arrange for the current prompt to get deleted.
2850 ;; Code for parsing expressions out of C or Fortran code.  The single entry
2894 		      '("if" "while" "for"))
2963   "Scan from SPAN-START to SPAN-END for punctuation characters.
3038           ;; Search through classpath list for an entry that is
3088               (message "gud-find-class: class for file %s not found!" f))
3094 	(message "gud-find-class: class for file %s not found in gud-jdb-class-source-alist!" f)
3110 (defvar gdb-script-font-lock-keywords
3111   '(("^define\\s-+\\(\\(\\w\\|\\s_\\)+\\)" (1 font-lock-function-name-face))
3112     ("\\$\\(\\w+\\)" (1 font-lock-variable-name-face))
3113     ("^\\s-*\\(\\w\\(\\w\\|\\s_\\)*\\)" (1 font-lock-keyword-face))))
3115 (defvar gdb-script-font-lock-syntactic-keywords
3132                              'font-lock-multiline t)
3135 (defun gdb-script-font-lock-syntactic-face (state)
3137    ((nth 3 state) font-lock-string-face)
3138    ((nth 7 state) font-lock-doc-face)
3139    (t font-lock-comment-face)))
3170   (if (and (eq (get-text-property (point) 'face) font-lock-doc-face)
3190   "`beginning-of-defun' function for Gdb script mode.
3201   "`end-of-defun' function for Gdb script mode.
3214   "Major mode for editing GDB scripts"
3225   (set (make-local-variable 'font-lock-defaults)
3226        '(gdb-script-font-lock-keywords nil nil ((?_ . "w")) nil
3227 	 (font-lock-syntactic-keywords
3228 	  . gdb-script-font-lock-syntactic-keywords)
3229 	 (font-lock-syntactic-face-function
3230 	  . gdb-script-font-lock-syntactic-face))))
3234 ;;; tooltips for GUD
3276   "List of modes for which to enable GUD tooltips."
3293   "Use the echo area instead of frames for GUD tooltips."
3310   "Reconsider for all buffers whether mouse motion events are desired."
3331   "Activate/deactivate mouse motion events for the current buffer.
3344   "Command handler for mouse movement events in `global-map'."
3351 ;;; Tips for `gud'
3399   "Show tip for identifier or selection under the mouse.
3401 region for the tip window to be shown.  If gud-tooltip-dereference is t,