;;; reporter.el --- customizable bug reporting of lisp programs
-;; Author: 1993 Barry A. Warsaw, Century Computing Inc. <bwarsaw@cen.com>
-;; Maintainer: bwarsaw@cen.com
-;; Created: 19-Apr-1993
-;; Version: 1.23
-;; Last Modified: 1993/09/02 20:28:36
-;; Keywords: tools, mail, lisp, extensions
+;; Copyright (C) 1993 1994 Barry A. Warsaw
+;; Copyright (C) 1993 1994 Free Software Foundation, Inc.
-;; Copyright (C) 1993 Free Software Foundation, Inc.
+;; Author: 1993 Barry A. Warsaw <bwarsaw@cnri.reston.va.us>
+;; Maintainer: bwarsaw@cnri.reston.va.us
+;; Created: 19-Apr-1993
+;; Version: 2.21
+;; Last Modified: 1994/11/29 16:13:50
+;; Keywords: bug reports lisp
;; This file is part of GNU Emacs.
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING. If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
+
+;;; Commentary:
;; Introduction
;; ============
-;; This program is for lisp package authors and is used to ease
+;; This program is for lisp package authors and can be used to ease
;; reporting of bugs. When invoked, reporter-submit-bug-report will
;; set up a mail buffer with the appropriate bug report address,
-;; including a lisp expression the maintainer of the package can use
+;; including a lisp expression the maintainer of the package can eval
;; to completely reproduce the environment in which the bug was
-;; observed (e.g. by using eval-last-sexp). This package is especially
-;; useful for my development of c++-mode.el, which is highly dependent
-;; on its configuration variables.
+;; observed (e.g. by using eval-last-sexp). This package proved
+;; especially useful during my development of cc-mode.el, which is
+;; highly dependent on its configuration variables.
;;
;; Do a "C-h f reporter-submit-bug-report" for more information.
;; Here's an example usage:
;;
-;; (defconst mypkg-version "9.801")
-;; (defconst mypkg-maintainer-address "mypkg-help@foo.com")
-;; (defun mypkg-submit-bug-report ()
-;; "Submit via mail a bug report on mypkg"
-;; (interactive)
-;; (require 'reporter)
-;; (and (y-or-n-p "Do you really want to submit a report on mypkg? ")
-;; (reporter-submit-bug-report
-;; mypkg-maintainer-address
-;; (concat "mypkg.el " mypkg-version)
-;; (list 'mypkg-variable-1
-;; 'mypkg-variable-2
-;; ;; ...
-;; 'mypkg-variable-last))))
+;;(defconst mypkg-version "9.801")
+;;(defconst mypkg-maintainer-address "mypkg-help@foo.com")
+;;(defun mypkg-submit-bug-report ()
+;; "Submit via mail a bug report on mypkg"
+;; (interactive)
+;; (require 'reporter)
+;; (reporter-submit-bug-report
+;; mypkg-maintainer-address
+;; (concat "mypkg.el " mypkg-version)
+;; (list 'mypkg-variable-1
+;; 'mypkg-variable-2
+;; ;; ...
+;; 'mypkg-variable-last)))
;; Mailing List
;; ============
;; I've set up a mailing list to report bugs or suggest enhancements,
;; etc. This list's intended audience is elisp package authors who are
;; using reporter and want to stay current with releases. Here are the
-;; relevent addresses:
+;; relevant addresses:
;;
;; Administrivia: reporter-request@anthem.nlm.nih.gov
;; Submissions: reporter@anthem.nlm.nih.gov
+;; Packages that currently use reporter are: cc-mode, supercite, elp,
+;; tcl, ediff, crypt, vm, edebug, archie, and efs. If you know of
+;; others, please email me!
+
;; LCD Archive Entry:
-;; reporter|Barry A. Warsaw|bwarsaw@cen.com|
+;; reporter|Barry A. Warsaw|bwarsaw@cnri.reston.va.us|
;; Customizable bug reporting of lisp programs.|
-;; 1993/09/02 20:28:36|1.23|~/misc/reporter.el.Z|
+;; 1994/11/29 16:13:50|2.21|~/misc/reporter.el.Z|
;;; Code:
;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
;; user defined variables
-(defvar reporter-mailer '(vm-mail mail)
+(defvar reporter-mailer '(vm-mail reporter-mail)
"*Mail package to use to generate bug report buffer.
This can either be a function symbol or a list of function symbols.
If a list, it tries to use each specified mailer in order until an
-existing one is found.")
+existing one is found.
+
+MH-E users may want to use `mh-smail'.")
+
+(defvar reporter-prompt-for-summary-p nil
+ "Interface variable controlling prompting for problem summary.
+When non-nil, `reporter-submit-bug-report' prompts the user for a
+brief summary of the problem, and puts this summary on the Subject:
+line.
+
+Default behavior is to not prompt (i.e. nil). If you want reporter to
+prompt, you should `let' bind this variable to t before calling
+`reporter-submit-bug-report'. Note that this variable is not
+buffer-local so you should never just `setq' it.")
+(defvar reporter-dont-compact-list nil
+ "Interface variable controlling compacting of list values.
+When non-nil, this must be a list of variable symbols. When a
+variable containing a list value is formatted in the bug report mail
+buffer, it normally is compacted so that its value fits one the fewest
+number of lines. If the variable's symbol appears in this list, its
+value is printed in a more verbose style, specifically, one elemental
+sexp per line.
+
+Note that this variable is not buffer-local so you should never just
+`setq' it. If you want to changes its default value, you should `let'
+bind it.")
;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
;; end of user defined variables
variables. Current buffer will always be the mail buffer being
composed.")
+(defconst reporter-version "2.21"
+ "Reporter version number.")
+
+(defvar reporter-initial-text nil
+ "The automatically created initial text of a bug report.")
+(make-variable-buffer-local 'reporter-initial-text)
+
+\f
+(defvar reporter-status-message nil)
+(defvar reporter-status-count nil)
+
+(defun reporter-update-status ()
+ ;; periodically output a status message
+ (if (zerop (% reporter-status-count 10))
+ (progn
+ (message reporter-status-message)
+ (setq reporter-status-message (concat reporter-status-message "."))))
+ (setq reporter-status-count (1+ reporter-status-count)))
+
\f
-(defun reporter-dump-variable (varsym)
- "Pretty-print the value of the variable in symbol VARSYM."
- (let ((val (save-excursion
- (set-buffer reporter-eval-buffer)
- (eval varsym)))
- (sym (symbol-name varsym))
- (print-escape-newlines t))
- (insert " " sym " "
- (cond
- ((memq val '(t nil)) "")
- ((listp val) "'")
- ((symbolp val) "'")
- (t ""))
- (prin1-to-string val)
- "\n")))
+(defun reporter-beautify-list (maxwidth compact-p)
+ ;; pretty print a list
+ (reporter-update-status)
+ (let (linebreak indent-enclosing-p indent-p here)
+ (condition-case nil ;loop exit
+ (progn
+ (down-list 1)
+ (setq indent-enclosing-p t)
+ (while t
+ (setq here (point))
+ (forward-sexp 1)
+ (if (<= maxwidth (current-column))
+ (if linebreak
+ (progn
+ (goto-char linebreak)
+ (newline-and-indent)
+ (setq linebreak nil))
+ (goto-char here)
+ (setq indent-p (reporter-beautify-list maxwidth compact-p))
+ (goto-char here)
+ (forward-sexp 1)
+ (if indent-p
+ (newline-and-indent))
+ t)
+ (if compact-p
+ (setq linebreak (point))
+ (newline-and-indent))
+ ))
+ t)
+ (error indent-enclosing-p))))
+
+(defun reporter-lisp-indent (indent-point state)
+ ;; a better lisp indentation style for bug reporting
+ (save-excursion
+ (goto-char (1+ (nth 1 state)))
+ (current-column)))
+
+(defun reporter-dump-variable (varsym mailbuf)
+ ;; Pretty-print the value of the variable in symbol VARSYM. MAILBUF
+ ;; is the mail buffer being composed
+ (reporter-update-status)
+ (condition-case nil
+ (let ((val (save-excursion
+ (set-buffer reporter-eval-buffer)
+ (symbol-value varsym)))
+ (sym (symbol-name varsym))
+ (print-escape-newlines t)
+ (maxwidth (1- (window-width)))
+ (here (point)))
+ (insert " " sym " "
+ (cond
+ ((memq val '(t nil)) "")
+ ((listp val) "'")
+ ((symbolp val) "'")
+ (t ""))
+ (prin1-to-string val))
+ (lisp-indent-line)
+ ;; clean up lists, but only if the line as printed was long
+ ;; enough to wrap
+ (if (and val ;nil is a list, but short
+ (listp val)
+ (<= maxwidth (current-column)))
+ (save-excursion
+ (let ((compact-p (not (memq varsym reporter-dont-compact-list)))
+ (lisp-indent-function 'reporter-lisp-indent))
+ (goto-char here)
+ (reporter-beautify-list maxwidth compact-p))))
+ (insert "\n"))
+ (void-variable
+ (save-excursion
+ (set-buffer mailbuf)
+ (mail-position-on-field "X-Reporter-Void-Vars-Found")
+ (end-of-line)
+ (insert (symbol-name varsym) " ")))
+ (error (error))))
(defun reporter-dump-state (pkgname varlist pre-hooks post-hooks)
- "Dump the state of the mode specific variables.
-PKGNAME contains the name of the mode as it will appear in the bug
-report (you must explicitly concat any version numbers).
-
-VARLIST is the list of variables to dump. Each element in VARLIST can
-be a variable symbol, or a cons cell. If a symbol, this will be
-passed to `reporter-dump-variable' for insertion into the mail buffer.
-If a cons cell, the car must be a variable symbol and the cdr must be
-a function which will be `funcall'd with the symbol. Use this to write
-your own custom variable value printers for specific variables.
-
-Note that the global variable `reporter-eval-buffer' will be bound to
-the buffer in which `reporter-submit-bug-report' was invoked. If you
-want to print the value of a buffer local variable, you should wrap
-the `eval' call in your custom printer inside a `set-buffer' (and
-probably a `save-excursion'). `reporter-dump-variable' handles this
-properly.
-
-PRE-HOOKS is run after the emacs-version and PKGNAME are inserted, but
-before the VARLIST is dumped. POST-HOOKS is run after the VARLIST is
-dumped."
+ ;; Dump the state of the mode specific variables.
+ ;; PKGNAME contains the name of the mode as it will appear in the bug
+ ;; report (you must explicitly concat any version numbers).
+
+ ;; VARLIST is the list of variables to dump. Each element in
+ ;; VARLIST can be a variable symbol, or a cons cell. If a symbol,
+ ;; this will be passed to `reporter-dump-variable' for insertion
+ ;; into the mail buffer. If a cons cell, the car must be a variable
+ ;; symbol and the cdr must be a function which will be `funcall'd
+ ;; with arguments the symbol and the mail buffer being composed. Use
+ ;; this to write your own custom variable value printers for
+ ;; specific variables.
+
+ ;; Note that the global variable `reporter-eval-buffer' will be bound to
+ ;; the buffer in which `reporter-submit-bug-report' was invoked. If you
+ ;; want to print the value of a buffer local variable, you should wrap
+ ;; the `eval' call in your custom printer inside a `set-buffer' (and
+ ;; probably a `save-excursion'). `reporter-dump-variable' handles this
+ ;; properly.
+
+ ;; PRE-HOOKS is run after the emacs-version and PKGNAME are inserted, but
+ ;; before the VARLIST is dumped. POST-HOOKS is run after the VARLIST is
+ ;; dumped.
(let ((buffer (current-buffer)))
(set-buffer buffer)
- (insert "Emacs : " (emacs-version) "\nPackage: " pkgname "\n")
+ (insert "Emacs : " (emacs-version) "\n")
+ (and pkgname
+ (insert "Package: " pkgname "\n"))
(run-hooks 'pre-hooks)
- (insert "\ncurrent state:\n==============\n(setq\n")
- (mapcar
- (function
- (lambda (varsym-or-cons-cell)
- (let ((varsym (or (car-safe varsym-or-cons-cell)
- varsym-or-cons-cell))
- (printer (or (cdr-safe varsym-or-cons-cell)
- 'reporter-dump-variable)))
- (funcall printer varsym)
- )))
- varlist)
- (insert " )\n")
+ (if (not varlist)
+ nil
+ (insert "\ncurrent state:\n==============\n")
+ ;; create an emacs-lisp-mode buffer to contain the output, which
+ ;; we'll later insert into the mail buffer
+ (condition-case fault
+ (let ((mailbuf (current-buffer))
+ (elbuf (get-buffer-create " *tmp-reporter-buffer*")))
+ (save-excursion
+ (set-buffer elbuf)
+ (emacs-lisp-mode)
+ (erase-buffer)
+ (insert "(setq\n")
+ (lisp-indent-line)
+ (mapcar
+ (function
+ (lambda (varsym-or-cons-cell)
+ (let ((varsym (or (car-safe varsym-or-cons-cell)
+ varsym-or-cons-cell))
+ (printer (or (cdr-safe varsym-or-cons-cell)
+ 'reporter-dump-variable)))
+ (funcall printer varsym mailbuf)
+ )))
+ varlist)
+ (lisp-indent-line)
+ (insert ")\n"))
+ (insert-buffer elbuf))
+ (error
+ (insert "State could not be dumped due to the following error:\n\n"
+ (format "%s" fault)
+ "\n\nYou should still send this bug report."))))
(run-hooks 'post-hooks)
))
+\f
+(defun reporter-calculate-separator ()
+ ;; returns the string regexp matching the mail separator
+ (save-excursion
+ (re-search-forward
+ (concat
+ "^\\(" ;beginning of line
+ (mapconcat
+ 'identity
+ (list "[\t ]*" ;simple SMTP form
+ "-+" ;mh-e form
+ (regexp-quote
+ mail-header-separator)) ;sendmail.el form
+ "\\|") ;or them together
+ "\\)$") ;end of line
+ nil
+ 'move) ;search for and move
+ (buffer-substring (match-beginning 0) (match-end 0))))
+
+;; Serves as an interface to `mail',
+;; but when the user says "no" to discarding an unset message,
+;; it gives an error.
+(defun reporter-mail (&rest args)
+ (interactive "P")
+ (or (apply 'mail args)
+ (error "Bug report aborted")))
+
+;;;###autoload
(defun reporter-submit-bug-report
(address pkgname varlist &optional pre-hooks post-hooks salutation)
- "Submit a bug report via mail.
+ ;; Submit a bug report via mail.
+
+ ;; ADDRESS is the email address for the package's maintainer. PKGNAME is
+ ;; the name of the mode (you must explicitly concat any version numbers).
+ ;; VARLIST is the list of variables to dump (see `reporter-dump-state'
+ ;; for details). Optional PRE-HOOKS and POST-HOOKS are passed to
+ ;; `reporter-dump-state'. Optional SALUTATION is inserted at the top of the
+ ;; mail buffer, and point is left after the salutation.
-ADDRESS is the email address for the package's maintainer. PKGNAME is
-the name of the mode (you must explicitly concat any version numbers).
-VARLIST is the list of variables to dump (do a `\\[describe-function] reporter-dump-state'
-for details). Optional PRE-HOOKS and POST-HOOKS are passed to
-`reporter-dump-state'. Optional SALUTATION is inserted at the top of the
-mail buffer, and point is left after the saluation.
+ ;; This function will prompt for a summary if
+ ;; reporter-prompt-for-summary-p is non-nil.
-The mailer used is described in the variable `reporter-mailer'."
+ ;; The mailer used is described in the variable `reporter-mailer'.
(let ((reporter-eval-buffer (current-buffer))
+ final-resting-place
+ after-sep-pos
+ (reporter-status-message "Formatting bug report buffer...")
+ (reporter-status-count 0)
+ (problem (and reporter-prompt-for-summary-p
+ (read-string "(Very) brief summary of problem: ")))
(mailbuf
(progn
(call-interactively
(setq mlist (cdr mlist))))
(if (not mailer)
(error
- "variable `%s' does not contain a command for mailing."
+ "Variable `%s' does not contain a command for mailing"
"reporter-mailer"))
mailer)))
(current-buffer))))
(goto-char (point-min))
;; different mailers use different separators, some may not even
;; use m-h-s, but sendmail.el stuff must have m-h-s bound.
- (let ((mail-header-separator
- (save-excursion
- (re-search-forward
- (concat
- "^\\(" ;beginning of line
- (mapconcat
- 'identity
- (list "[\t ]*" ;simple SMTP form
- "-+" ;mh-e form
- (regexp-quote
- mail-header-separator)) ;sendmail.el form
- "\\|") ;or them together
- "\\)$") ;end of line
- nil
- 'move) ;search for and move
- (buffer-substring (match-beginning 0) (match-end 0)))))
+ (let ((mail-header-separator (reporter-calculate-separator)))
(mail-position-on-field "to")
(insert address)
- (mail-position-on-field "subject")
- (insert "Report on package " pkgname)
- (re-search-forward mail-header-separator (point-max) 'move)
+ ;; insert problem summary if available
+ (if (and reporter-prompt-for-summary-p problem pkgname)
+ (progn
+ (mail-position-on-field "subject")
+ (insert pkgname "; " problem)))
+ ;; move point to the body of the message
+ (mail-text)
(forward-line 1)
+ (setq after-sep-pos (point))
(and salutation (insert "\n" salutation "\n\n"))
- (set-mark (point)) ;user should see mark change
- (insert "\n\n")
- (reporter-dump-state pkgname varlist pre-hooks post-hooks)
- (exchange-point-and-mark))
- (let* ((sendkey "C-c C-c") ;can this be generalized like below?
+ (unwind-protect
+ (progn
+ (setq final-resting-place (point-marker))
+ (insert "\n\n")
+ (reporter-dump-state pkgname varlist pre-hooks post-hooks)
+ (goto-char final-resting-place))
+ (set-marker final-resting-place nil)))
+
+ ;; save initial text and set up the `no-empty-submission' hook.
+ ;; This only works for mailers that support mail-send-hook,
+ ;; e.g. sendmail.el
+ (if (fboundp 'add-hook)
+ (progn
+ (save-excursion
+ (goto-char (point-max))
+ (skip-chars-backward " \t\n")
+ (setq reporter-initial-text
+ (buffer-substring after-sep-pos (point))))
+ (make-variable-buffer-local 'mail-send-hook)
+ (add-hook 'mail-send-hook 'reporter-bug-hook)))
+
+ ;; minibuf message
+ ;; C-c C-c can't be generalized because they don't always run
+ ;; mail-send-and-exit. E.g. vm-mail-send-and-exit. I don't want
+ ;; to hard code these.
+ (let* ((sendkey "C-c C-c")
(killkey-whereis (where-is-internal 'kill-buffer nil t))
(killkey (if killkey-whereis
(key-description killkey-whereis)
sendkey killkey))
))
-;; this is useful
+(defun reporter-bug-hook ()
+ ;; prohibit sending mail if empty bug report
+ (let ((after-sep-pos
+ (save-excursion
+ (beginning-of-buffer)
+ (re-search-forward (reporter-calculate-separator) (point-max) 'move)
+ (forward-line 1)
+ (point))))
+ (save-excursion
+ (goto-char (point-max))
+ (skip-chars-backward " \t\n")
+ (if (and (= (- (point) after-sep-pos)
+ (length reporter-initial-text))
+ (string= (buffer-substring after-sep-pos (point))
+ reporter-initial-text))
+ (error "Empty bug report cannot be sent"))
+ )))
+
+\f
(provide 'reporter)
;;; reporter.el ends here
HCoop / bpt / emacs.git / blobdiff