(require 'emacsbug)
(defgroup lisp-mnt nil
"Minor mode for Emacs Lisp maintainers."
:prefix "lm-"
:group 'maint)
(defcustom lm-header-prefix "^;;*[ \t]+\\(@\(#\)\\)?[ \t]*\\([\$]\\)?"
"Prefix that is ignored before the tag.
For example, you can write the 1st line synopsis string and headers like this
in your Lisp package:
;; @(#) package.el -- pacakge description
;;
;; @(#) $Maintainer: Person Foo Bar $
The @(#) construct is used by unix what(1) and
then $identifier: doc string $ is used by GNU ident(1)"
:type 'regexp
:group 'lisp-mnt)
(defcustom lm-comment-column 16
"Column used for placing formatted output."
:type 'integer
:group 'lisp-mnt)
(defcustom lm-commentary-header "Commentary\\|Documentation"
"Regexp which matches start of documentation section."
:type 'regexp
:group 'lisp-mnt)
(defcustom lm-history-header "Change Log\\|History"
"Regexp which matches the start of code log section."
:type 'regexp
:group 'lisp-mnt)
(defsubst lm-get-header-re (header &optional mode)
"Return regexp for matching HEADER.
If called with optional MODE and with value `section',
return section regexp instead."
(cond ((eq mode 'section)
(concat "^;;;;* " header ":[ \t]*$"))
(t
(concat lm-header-prefix header ":[ \t]*"))))
(defsubst lm-get-package-name ()
"Return package name by looking at the first line."
(save-excursion
(goto-char (point-min))
(if (and (looking-at (concat lm-header-prefix))
(progn (goto-char (match-end 0))
(looking-at "\\([^\t ]+\\)")
(match-end 1)))
(buffer-substring-no-properties (match-beginning 1) (match-end 1))
)))
(defun lm-section-mark (header &optional after)
"Return the buffer location of a given section start marker.
The HEADER is the section mark string to search for.
If AFTER is non-nil, return the location of the next line."
(save-excursion
(let ((case-fold-search t))
(goto-char (point-min))
(if (re-search-forward (lm-get-header-re header 'section) nil t)
(progn
(beginning-of-line)
(if after (forward-line 1))
(point))
nil))))
(defsubst lm-code-mark ()
"Return the buffer location of the `Code' start marker."
(lm-section-mark "Code"))
(defsubst lm-commentary-mark ()
"Return the buffer location of the `Commentary' start marker."
(lm-section-mark lm-commentary-header))
(defsubst lm-history-mark ()
"Return the buffer location of the `History' start marker."
(lm-section-mark lm-history-header))
(defun lm-header (header)
"Return the contents of the header named HEADER."
(goto-char (point-min))
(let ((case-fold-search t))
(if (and (re-search-forward (lm-get-header-re header) (lm-code-mark) t)
(looking-at "\\([^$\n]+\\)")
(match-end 1))
(buffer-substring-no-properties (match-beginning 1) (match-end 1))
nil)))
(defun lm-header-multiline (header)
"Return the contents of the header named HEADER, with continuation lines.
The returned value is a list of strings, one per line."
(save-excursion
(goto-char (point-min))
(let ((res (lm-header header)))
(cond
(res
(setq res (list res))
(forward-line 1)
(while (and (looking-at (concat lm-header-prefix "[\t ]+"))
(progn
(goto-char (match-end 0))
(looking-at "\\(.*\\)"))
(match-end 1))
(setq res (cons (buffer-substring-no-properties
(match-beginning 1)
(match-end 1))
res))
(forward-line 1))
))
res
)))
(defun lm-summary (&optional file)
"Return the one-line summary of file FILE, or current buffer if FILE is nil."
(save-excursion
(if file
(find-file file))
(goto-char (point-min))
(prog1
(if (and
(looking-at lm-header-prefix)
(progn (goto-char (match-end 0))
(looking-at "[^ ]+[ \t]+--+[ \t]+\\(.*\\)")))
(let ((summary (buffer-substring-no-properties (match-beginning 1)
(match-end 1))))
(if (string-match "[ \t]*-\\*-.*-\\*-" summary)
(substring summary 0 (match-beginning 0))
summary)))
(if file
(kill-buffer (current-buffer)))
)))
(defun lm-crack-address (x)
"Split up an email address X into full name and real email address.
The value is a cons of the form (FULLNAME . ADDRESS)."
(cond ((string-match "\\(.+\\) [(<]\\(\\S-+@\\S-+\\)[>)]" x)
(cons (substring x (match-beginning 1) (match-end 1))
(substring x (match-beginning 2) (match-end 2))))
((string-match "\\(\\S-+@\\S-+\\) [(<]\\(.*\\)[>)]" x)
(cons (substring x (match-beginning 2) (match-end 2))
(substring x (match-beginning 1) (match-end 1))))
((string-match "\\S-+@\\S-+" x)
(cons nil x))
(t
(cons x nil))))
(defun lm-authors (&optional file)
"Return the author list of file FILE, or current buffer if FILE is nil.
Each element of the list is a cons; the car is the full name,
the cdr is an email address."
(save-excursion
(if file
(find-file file))
(let ((authorlist (lm-header-multiline "author")))
(prog1
(mapcar 'lm-crack-address authorlist)
(if file
(kill-buffer (current-buffer)))
))))
(defun lm-maintainer (&optional file)
"Return the maintainer of file FILE, or current buffer if FILE is nil.
The return value has the form (NAME . ADDRESS)."
(save-excursion
(if file
(find-file file))
(prog1
(let ((maint (lm-header "maintainer")))
(if maint
(lm-crack-address maint)
(car (lm-authors))))
(if file
(kill-buffer (current-buffer)))
)))
(defun lm-creation-date (&optional file)
"Return the created date given in file FILE, or current buffer if FILE is nil."
(save-excursion
(if file
(find-file file))
(prog1
(lm-header "created")
(if file
(kill-buffer (current-buffer)))
)))
(defun lm-last-modified-date (&optional file)
"Return the modify-date given in file FILE, or current buffer if FILE is nil."
(save-excursion
(if file
(find-file file))
(prog1
(if (progn
(goto-char (point-min))
(re-search-forward
"\\$[I]d: [^ ]+ [^ ]+ \\([^/]+\\)/\\([^/]+\\)/\\([^ ]+\\) "
(lm-code-mark) t))
(format "%s %s %s"
(buffer-substring (match-beginning 3) (match-end 3))
(nth (string-to-int
(buffer-substring (match-beginning 2) (match-end 2)))
'("" "Jan" "Feb" "Mar" "Apr" "May" "Jun"
"Jul" "Aug" "Sep" "Oct" "Nov" "Dec"))
(buffer-substring (match-beginning 1) (match-end 1))
))
(if file
(kill-buffer (current-buffer)))
)))
(defun lm-version (&optional file)
"Return the version listed in file FILE, or current buffer if FILE is nil.
This can befound in an RCS or SCCS header to crack it out of."
(save-excursion
(if file
(find-file file))
(prog1
(or
(lm-header "version")
(let ((header-max (lm-code-mark)))
(goto-char (point-min))
(cond
((re-search-forward "\\$[I]d: [^ ]+ \\([^ ]+\\) " header-max t)
(buffer-substring-no-properties (match-beginning 1) (match-end 1)))
((re-search-forward
(concat
(regexp-quote "@(#)")
(regexp-quote (file-name-nondirectory (buffer-file-name)))
"\t\\([012345679.]*\\)")
header-max t)
(buffer-substring-no-properties (match-beginning 1) (match-end 1)))
(t nil))))
(if file
(kill-buffer (current-buffer)))
)))
(defun lm-keywords (&optional file)
"Return the keywords given in file FILE, or current buffer if FILE is nil."
(save-excursion
(if file
(find-file file))
(prog1
(let ((keywords (lm-header "keywords")))
(and keywords (downcase keywords)))
(if file
(kill-buffer (current-buffer)))
)))
(defun lm-adapted-by (&optional file)
"Return the adapted-by names in file FILE, or current buffer if FILE is nil.
This is the name of the person who cleaned up this package for
distribution."
(save-excursion
(if file
(find-file file))
(prog1
(lm-header "adapted-by")
(if file
(kill-buffer (current-buffer)))
)))
(defun lm-commentary (&optional file)
"Return the commentary in file FILE, or current buffer if FILE is nil.
The value is returned as a string. In the file, the commentary starts
with the tag `Commentary' or `Documentation' and ends with one of the
tags `Code', `Change Log' or `History'."
(save-excursion
(if file
(find-file file))
(prog1
(let ((commentary (lm-commentary-mark))
(change-log (lm-history-mark))
(code (lm-code-mark))
)
(cond
((and commentary change-log)
(buffer-substring-no-properties commentary change-log))
((and commentary code)
(buffer-substring-no-properties commentary code))
(t
nil)))
(if file
(kill-buffer (current-buffer)))
)))
(defun lm-insert-at-column (col &rest strings)
"Insert, at column COL, list of STRINGS."
(if (> (current-column) col) (insert "\n"))
(move-to-column col t)
(apply 'insert strings))
(defun lm-verify (&optional file showok verb)
"Check that the current buffer (or FILE if given) is in proper format.
If FILE is a directory, recurse on its files and generate a report in
a temporary buffer."
(interactive)
(let* ((verb (or verb (interactive-p)))
ret
name
)
(if verb
(setq ret "Ok."))
(if (and file (file-directory-p file))
(setq
ret
(progn
(switch-to-buffer (get-buffer-create "*lm-verify*"))
(erase-buffer)
(mapcar
'(lambda (f)
(if (string-match ".*\\.el$" f)
(let ((status (lm-verify f)))
(if status
(progn
(insert f ":")
(lm-insert-at-column lm-comment-column status "\n"))
(and showok
(progn
(insert f ":")
(lm-insert-at-column lm-comment-column "OK\n")))))))
(directory-files file))
))
(save-excursion
(if file
(find-file file))
(setq name (lm-get-package-name))
(setq
ret
(prog1
(cond
((null name)
"Can't find a package NAME")
((not (lm-authors))
"Author: tag missing.")
((not (lm-maintainer))
"Maintainer: tag missing.")
((not (lm-summary))
"Can't find a one-line 'Summary' description")
((not (lm-keywords))
"Keywords: tag missing.")
((not (lm-commentary-mark))
"Can't find a 'Commentary' section marker.")
((not (lm-history-mark))
"Can't find a 'History' section marker.")
((not (lm-code-mark))
"Can't find a 'Code' section marker")
((progn
(goto-char (point-max))
(not
(re-search-backward
(concat "^;;;[ \t]+" name "[ \t]+ends here[ \t]*$"
"\\|^;;;[ \t]+ End of file[ \t]+" name)
nil t
)))
(format "Can't find a footer line for [%s]" name))
(t
ret))
(if file
(kill-buffer (current-buffer)))
))))
(if verb
(message ret))
ret
))
(defun lm-synopsis (&optional file showall)
"Generate a synopsis listing for the buffer or the given FILE if given.
If FILE is a directory, recurse on its files and generate a report in
a temporary buffer. If SHOWALL is non-nil, also generate a line for files
which do not include a recognizable synopsis."
(interactive
(list
(read-file-name "Synopsis for (file or dir): ")))
(if (and file (file-directory-p file))
(progn
(switch-to-buffer (get-buffer-create "*lm-verify*"))
(erase-buffer)
(mapcar
'(lambda (f)
(if (string-match ".*\\.el$" f)
(let ((syn (lm-synopsis f)))
(if syn
(progn
(insert f ":")
(lm-insert-at-column lm-comment-column syn "\n"))
(and showall
(progn
(insert f ":")
(lm-insert-at-column lm-comment-column "NA\n")))))))
(directory-files file))
)
(save-excursion
(if file
(find-file file))
(prog1
(lm-summary)
(if file
(kill-buffer (current-buffer)))
))))
(defun lm-report-bug (topic)
"Report a bug in the package currently being visited to its maintainer.
Prompts for bug subject TOPIC. Leaves you in a mail buffer."
(interactive "sBug Subject: ")
(let ((package (lm-get-package-name))
(addr (lm-maintainer))
(version (lm-version)))
(mail nil
(if addr
(concat (car addr) " <" (cdr addr) ">")
report-emacs-bug-address)
topic)
(goto-char (point-max))
(insert "\nIn "
package
(if version (concat " version " version) "")
"\n\n")
(message
(substitute-command-keys "Type \\[mail-send] to send bug report."))))
(provide 'lisp-mnt)