[comp.emacs] Dbx mode

lupton@uhccux.uhcc.hawaii.edu (Robert Lupton) (02/08/89)

I have had a little trouble getting dbx mode to run (The problem being
that the process was named tex-prog, and dbx-stop-at didn't realise.
I'll put the patch at the end). I had various other problems with it
not quite working -- is there a version later than the one that came
with emacs 18.51.3?

(I tried to reach the author at "umerin@flab.fujitsu.junet", but to no avail)

			Robert Lupton (lupton@uhccux.uhcc.hawaii.edu)


*** dbx.el	Thu Feb 11 21:14:30 1988
--- /uh3h/ifa/lupton/lisp/dbx.el	Sat Feb  4 11:41:23 1989
***************
*** 24,29
  (defvar dbx-trace-flag nil
    "Dbx trace switch.")
  
  (defvar dbx-break-point
    "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
    "Regexp of pattern that dbx writes at break point.")

--- 24,32 -----
  (defvar dbx-trace-flag nil
    "Dbx trace switch.")
  
+ (defvar dbx-process nil
+   "Dbx process name.")
+ 
  (defvar dbx-break-point
    "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
    "Regexp of pattern that dbx writes at break point.")
***************
*** 93,99
    (let ((file (file-name-nondirectory path)))
      (switch-to-buffer (concat "*dbx-" file "*"))
      (setq default-directory (file-name-directory path))
!     (switch-to-buffer (make-shell (concat "dbx-" file) "dbx" nil file)))
    (set-process-filter (get-buffer-process (current-buffer)) 'dbx-filter)
    (inferior-dbx-mode))
  

--- 96,103 -----
    (let ((file (file-name-nondirectory path)))
      (switch-to-buffer (concat "*dbx-" file "*"))
      (setq default-directory (file-name-directory path))
!     (switch-to-buffer
!      (make-shell (setq dbx-process (concat "dbx-" file)) "dbx" nil file)))
    (set-process-filter (get-buffer-process (current-buffer)) 'dbx-filter)
    (inferior-dbx-mode))
  
***************
*** 157,161
  	(line (save-restriction
  		(widen)
  		(1+ (count-lines 1 (point))))))
!     (send-string "dbx"
  		 (concat "stop at \"" file-name "\":" line "\n"))))

--- 161,165 -----
  	(line (save-restriction
  		(widen)
  		(1+ (count-lines 1 (point))))))
!     (send-string dbx-process
  		 (concat "stop at \"" file-name "\":" line "\n"))))

lupton@uhccux.uhcc.hawaii.edu (Robert Lupton) (03/05/89)

Dbx.el in 18.52 doesn't understand the use command, so if your source
is spread over several directories the trace feature doesn't work. Here
is a function dbx-use that can either be called instead of using `use',
or can be called to tell dbx-mode about a use command (e.g. if you have
an alias to do the work).

The diffs were longer than the file, so here it all is. It includes
a version of the simple fix to do with process names that I posted a few
weeks ago, and superseded it.

			Robert Lupton

-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
;; Run dbx under Emacs
;; Copyright (C) 1988 Free Software Foundation, Inc.
;; Main author Masanobu UMEDA (umerin@flab.fujitsu.junet)

;; This file is part of GNU Emacs.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY.  No author or distributor
;; accepts responsibility to anyone for the consequences of using it
;; or for whether it serves any particular purpose or works at all,
;; unless he says so in writing.  Refer to the GNU Emacs General Public
;; License for full details.

;; Everyone is granted permission to copy, modify and redistribute
;; GNU Emacs, but only under the conditions described in the
;; GNU Emacs General Public License.   A copy of this license is
;; supposed to have been given to you along with GNU Emacs so you
;; can know your rights and responsibilities.  It should be in a
;; file named COPYING.  Among other things, the copyright notice
;; and this notice must be preserved on all copies.
;
; Added dbx-use to follow `use' commands. RHL March 1989

(require 'shell)

(defvar dbx-trace-flag nil
  "Dbx trace switch.")

(defvar dbx-process nil
  "Dbx process name.")

(defvar dbx-dir-list nil
  "List of directories searched by dbx-where, set by dbx-use")

(defvar dbx-break-point
  "stopped in .* at line \\([0-9]*\\) in file \"\\([^\"]*\\)\""
  "Regexp of pattern that dbx writes at break point.")

(defvar inferior-dbx-mode-map nil)
(if inferior-dbx-mode-map
    nil
  (setq inferior-dbx-mode-map (copy-keymap shell-mode-map))
  (define-key inferior-dbx-mode-map "\C-cu" 'dbx-use)
  (define-key inferior-dbx-mode-map "\C-cw" 'dbx-where)
  (define-key inferior-dbx-mode-map "\C-c\C-t" 'dbx-trace-mode)
  (define-key ctl-x-map "\C-@" 'dbx-stop-at))

(defun inferior-dbx-mode ()
  "Major mode for interacting with an inferior Dbx process.

The following commands are available:
\\{inferior-dbx-mode-map}

Entry to this mode calls the value of dbx-mode-hook with no arguments,
if that value is non-nil.  Likewise with the value of shell-mode-hook.
dbx-mode-hook is called after shell-mode-hook.

You can display the debugging program in other window and point out
where you are looking at using the command \\[dbx-where].

\\[dbx-trace-mode] toggles dbx-trace mode. In dbx-trace mode,
debugging program is automatically traced using output from dbx.

The command \\[dbx-stop-at] sets break point at current line of the
program in the buffer. Major mode name of the buffer must be in
dbx-language-mode-list.

You should use the command `dbx-use' (in the mini-buffer, or \\[dbx-use])
rather than `use' so dbx-mode can find your source directories. (Using
use, then dbx-use with no directories specified also works).

Commands:

Return at end of buffer sends line as input.
Return not at end copies rest of line to end and sends it.
\\[shell-send-eof] sends end-of-file as input.
\\[kill-shell-input] and \\[backward-kill-word] are kill commands, imitating normal Unix input editing.
\\[interrupt-shell-subjob] interrupts the shell or its current subjob if any.
\\[stop-shell-subjob] stops, likewise. \\[quit-shell-subjob] sends quit signal, likewise.
\\[dbx-use] tells dbx mode about any use commands you have issued
\\[dbx-where] displays debugging program in other window and
 points out where you are looking at.
\\[dbx-trace-mode] toggles dbx-trace mode.
\\[dbx-stop-at] sets break point at current line."
  (interactive)
  (kill-all-local-variables)
  (setq major-mode 'inferior-dbx-mode)
  (setq mode-name "Inferior Dbx")
  (setq mode-line-process '(": %s"))
  (use-local-map inferior-dbx-mode-map)
  (make-local-variable 'last-input-start)
  (setq last-input-start (make-marker))
  (make-local-variable 'last-input-end)
  (setq last-input-end (make-marker))
  (make-local-variable 'dbx-trace-flag)
  (setq dbx-trace-flag nil)
  (make-variable-buffer-local 'shell-prompt-pattern)
  (setq shell-prompt-pattern "^[^)]*dbx) *") ;Set dbx prompt pattern
  (or (assq 'dbx-trace-flag minor-mode-alist)
      (setq minor-mode-alist
	    (cons '(dbx-trace-flag " Trace") minor-mode-alist)))
  (run-hooks 'shell-mode-hook 'dbx-mode-hook))

(defun run-dbx (path)
  "Run inferior Dbx process on PROGRAM, with I/O via buffer *dbx-PROGRAM*."
  (interactive "fProgram to debug: ")
  (setq path (expand-file-name path))
  (let ((file (file-name-nondirectory path)))
    (switch-to-buffer (concat "*dbx-" file "*"))
    (setq default-directory (file-name-directory path))
    (switch-to-buffer (make-shell (concat "dbx-" file) "dbx" nil file)))
  (setq dbx-process (get-buffer-process (current-buffer)))
  (setq dbx-dir-list (list "."))
  (set-process-filter dbx-process 'dbx-filter)
  (inferior-dbx-mode))

(defun dbx-trace-mode (arg)
  "Toggle dbx-trace mode.
With arg, turn dbx-trace mode on iff arg is positive.
In dbx-trace mode, user program is automatically traced."
  (interactive "P")
  (if (not (eql major-mode 'inferior-dbx-mode))
      (error "Dbx-trace mode is effective in inferior-dbx mode only."))
  (setq dbx-trace-flag
	(if (null arg)
	    (not dbx-trace-flag)
	  (> (prefix-numeric-value arg) 0)))
  ;; Force mode line redisplay
  (set-buffer-modified-p (buffer-modified-p)))

(defun dbx-filter (process string)
  "Trace debugging program automatically if dbx-trace-flag is not nil."
  (save-excursion
    (set-buffer (process-buffer process))
    (goto-char (point-max))
    (let ((beg (point)))
      (insert string)
      (if dbx-trace-flag		;Trace mode is on?
	  (dbx-where beg t)))
    (if (process-mark process)
	(set-marker (process-mark process) (point-max))))
  (if (eq (process-buffer process)
	  (current-buffer))
      (goto-char (point-max)))
  )

(defun dbx-where (&optional begin quiet)
  "Display dbx'ed program in other window and point out where you are looking at.
BEGIN bounds the search. If QUIET, just return nil (no error) if fail."
  (interactive)
  (let (file line)
    (save-excursion
      (if (re-search-backward dbx-break-point begin quiet)
	  (progn
	    (setq line (buffer-substring (match-beginning 1) (match-end 1)))
	    (setq file (buffer-substring (match-beginning 2) (match-end 2)))
	    )))
    (if (and file line)			;Find break point?
	(progn
; Look for the file in each of the dbx-dir-list directories
	  (let ((dir dbx-dir-list))
	    (while (and dir (not (file-readable-p
		    (expand-file-name (concat (car dir) "/" file) nil))))
	      (setq dir (cdr dir))
	      )
	    (if (not dir)
		(error (format "Can't find file %s" file)))
	    (setq file (expand-file-name (concat (car dir) "/" file) nil)))
	  (find-file-other-window file)
	  (goto-line (string-to-int line)) ;Jump to the line
	  (beginning-of-line)
	  (setq overlay-arrow-string "=>")
	  (or overlay-arrow-position 
	      (setq overlay-arrow-position (make-marker)))
	  (set-marker overlay-arrow-position (point) (current-buffer))
	  (other-window 1))		;Return to dbx
      )))

(defun dbx-stop-at ()
  "Set break point at current line."
  (interactive)
  (let ((file-name (file-name-nondirectory buffer-file-name))
	(line (save-restriction
		(widen)
		(1+ (count-lines 1 (point))))))
    (send-string dbx-process
		 (concat "stop at \"" file-name "\":" line "\n"))))

(defun dbx-use (dirs)
  "Run dbx's `use' command and parse the output to make a list of
directories for the use of dbx-where. If no directories are specified,
get the current list and parse that"
  (interactive "suse: ")
  (setq dbx-dir-list nil)
  (save-window-excursion
    (if (string-match "[^ \t]" dirs)
	(progn
	  (send-string dbx-process (concat "use " dirs "\n"))
	  (delete-region (save-excursion (beginning-of-line) (dot)) (dot))))
    (send-string dbx-process "use\n")
    (accept-process-output dbx-process)
    (switch-to-buffer (process-buffer dbx-process))
    (end-of-buffer)
    (previous-line 1)
    (beginning-of-line)
    (if (looking-at shell-prompt-pattern)
	(goto-char (match-end 0)))
    (while (looking-at "[ \t]*[^ \t\n]+")
      (progn 
      (setq dbx-dir-list
	    (append dbx-dir-list (list (buffer-substring
					(match-beginning 0) (match-end 0)))))
      (goto-char (match-end 0))
      (skip-chars-forward " \t"))))
      (end-of-buffer))