X-Git-Url: http://git.hcoop.net/bpt/emacs.git/blobdiff_plain/5e18d6323651d57719001b2b54e8209a6d8f0044..cbee283dd7dd655124e81a6bd555506476180b5d:/lisp/emacs-lisp/lisp-mnt.el diff --git a/lisp/emacs-lisp/lisp-mnt.el b/lisp/emacs-lisp/lisp-mnt.el index 03d85f5c2d..f1df695fa5 100644 --- a/lisp/emacs-lisp/lisp-mnt.el +++ b/lisp/emacs-lisp/lisp-mnt.el @@ -1,6 +1,7 @@ -;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers +;;; lisp-mnt.el --- utility functions for Emacs Lisp maintainers -;; Copyright (C) 1992, 1994, 1997, 2000, 2001 Free Software Foundation, Inc. +;; Copyright (C) 1992, 1994, 1997, 2000, 2001, 2002, 2003, 2004, +;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc. ;; Author: Eric S. Raymond ;; Maintainer: FSF @@ -12,7 +13,7 @@ ;; GNU Emacs is free software; you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by -;; the Free Software Foundation; either version 2, or (at your option) +;; the Free Software Foundation; either version 3, or (at your option) ;; any later version. ;; GNU Emacs is distributed in the hope that it will be useful, @@ -22,29 +23,30 @@ ;; 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, Inc., 59 Temple Place - Suite 330, -;; Boston, MA 02111-1307, USA. +;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, +;; Boston, MA 02110-1301, USA. ;;; Commentary: -;; This minor mode adds some services to Emacs-Lisp editing mode. +;; This library adds some services to Emacs-Lisp editing mode. ;; ;; First, it knows about the header conventions for library packages. ;; One entry point supports generating synopses from a library directory. ;; Another can be used to check for missing headers in library files. -;; +;; ;; Another entry point automatically addresses bug mail to a package's ;; maintainer or author. -;; This file can be loaded by your lisp-mode-hook. Have it (require 'lisp-mnt) +;; This file can be loaded by your emacs-lisp-mode-hook. Have it +;; (require 'lisp-mnt) ;; This file is an example of the header conventions. Note the following ;; features: -;; +;; ;; * Header line --- makes it possible to extract a one-line summary of ;; the package's uses automatically for use in library synopses, KWIC ;; indexes and the like. -;; +;; ;; Format is three semicolons, followed by the filename, followed by ;; three dashes, followed by the summary. All fields space-separated. ;; @@ -55,13 +57,13 @@ ;; ;; Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc. ;; ;; * A blank line -;; +;; ;; * Author line --- contains the name and net address of at least ;; the principal author. -;; +;; ;; If there are multiple authors, they should be listed on continuation ;; lines led by ;;, like this: -;; +;; ;; ;; Author: Ashwin Ram ;; ;; Dave Sill ;; ;; David Lawrence @@ -69,31 +71,31 @@ ;; ;; Joe Wells ;; ;; Dave Brennan ;; ;; Eric Raymond -;; +;; ;; This field may have some special values; notably "FSF", meaning ;; "Free Software Foundation". -;; +;; ;; * Maintainer line --- should be a single name/address as in the Author ;; line, or an address only, or the string "FSF". If there is no maintainer ;; line, the person(s) in the Author field are presumed to be it. The example ;; in this file is mildly bogus because the maintainer line is redundant. ;; The idea behind these two fields is to be able to write a Lisp function ;; that does "send mail to the author" without having to mine the name out by -;; hand. Please be careful about surrounding the network address with <> if +;; hand. Please be careful about surrounding the network address with <> if ;; there's also a name in the field. -;; +;; ;; * Created line --- optional, gives the original creation date of the ;; file. For historical interest, basically. -;; +;; ;; * Version line --- intended to give the reader a clue if they're looking ;; at a different version of the file than the one they're accustomed to. This ;; may be an RCS or SCCS header. -;; +;; ;; * Adapted-By line --- this is for FSF's internal use. The person named ;; in this field was the one responsible for installing and adapting the ;; package for the distribution. (This file doesn't have one because the ;; author *is* one of the maintainers.) -;; +;; ;; * Keywords line --- used by the finder code (now under construction) ;; for finding Emacs Lisp code related to a topic. ;; @@ -104,13 +106,13 @@ ;; ;; * Commentary line --- enables Lisp code to find the developer's and ;; maintainers' explanations of the package internals. -;; +;; ;; * Change log line --- optional, exists to terminate the commentary ;; section and start a change-log part, if one exists. -;; +;; ;; * Code line --- exists so Lisp can know where commentary and/or ;; change-log sections end. -;; +;; ;; * Footer line --- marks end-of-file so it can be distinguished from ;; an expanded formfeed or the results of truncation. @@ -124,10 +126,13 @@ ;;; Variables: (defgroup lisp-mnt nil - "Minor mode for Emacs Lisp maintainers." + "Utility functions for Emacs Lisp maintainers." :prefix "lm-" :group 'maint) +;; At least some of these defcustoms should probably be defconsts, +;; since they define, or are defined by, the header format. -- fx + (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 @@ -142,8 +147,9 @@ then $identifier: doc string $ is used by GNU ident(1)" :type 'regexp :group 'lisp-mnt) -(defcustom lm-copyright-prefix "^;+[ \t]+Copyright (C) " - "Prefix that is ignored before the dates in a copyright." +(defcustom lm-copyright-prefix "^\\(;+[ \t]\\)+Copyright (C) " + "Prefix that is ignored before the dates in a copyright. +Leading comment characters and whitespace should be in regexp group 1." :type 'regexp :group 'lisp-mnt) @@ -152,6 +158,11 @@ then $identifier: doc string $ is used by GNU ident(1)" :type 'integer :group 'lisp-mnt) +(defcustom lm-any-header ".*" + "Regexp which matches start of any section." + :type 'regexp + :group 'lisp-mnt) + (defcustom lm-commentary-header "Commentary\\|Documentation" "Regexp which matches start of documentation section." :type 'regexp @@ -171,8 +182,8 @@ then $identifier: doc string $ is used by GNU ident(1)" If called with optional MODE and with value `section', return section regexp instead." (if (eq mode 'section) - (concat "^;;;;* " header ":[ \t]*$") - (concat lm-header-prefix header "[ \t]*:[ \t]*"))) + (concat "^;;;;* \\(" header "\\):[ \t]*$") + (concat lm-header-prefix "\\(" header "\\)[ \t]*:[ \t]*"))) (defun lm-get-package-name () "Return package name by looking at the first line." @@ -184,30 +195,66 @@ return section regexp instead." (match-end 1))) (match-string-no-properties 1)))) -(defun lm-section-mark (header &optional after) +(defun lm-section-start (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." +If AFTER is non-nil, return the location of the next line. +If the given section does not exist, return nil." (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)))))) - -(defsubst lm-code-mark () + (line-beginning-position (if after 2)))))) +(defalias 'lm-section-mark 'lm-section-start) + +(defun lm-section-end (header) + "Return the buffer location of the end of a given section. +The HEADER is the section string marking the beginning of the +section. If the given section does not exist, return nil. + +The end of the section is defined as the beginning of the next +section of the same level or lower. The function +`lisp-outline-level' is used to compute the level of a section. +If no such section exists, return the end of the buffer." + (require 'outline) ;; for outline-regexp. + (let ((start (lm-section-start header))) + (when start + (save-excursion + (goto-char start) + (let ((level (lisp-outline-level)) + (case-fold-search t) + next-section-found) + (beginning-of-line 2) + (while (and (setq next-section-found + (re-search-forward + (lm-get-header-re lm-any-header 'section) + nil t)) + (> (save-excursion + (beginning-of-line) + (lisp-outline-level)) + level))) + (if next-section-found + (line-beginning-position) + (point-max))))))) + +(defsubst lm-code-start () "Return the buffer location of the `Code' start marker." - (lm-section-mark "Code")) + (lm-section-start "Code")) +(defalias 'lm-code-mark 'lm-code-start) -(defsubst lm-commentary-mark () +(defsubst lm-commentary-start () "Return the buffer location of the `Commentary' start marker." - (lm-section-mark lm-commentary-header)) + (lm-section-start lm-commentary-header)) +(defalias 'lm-commentary-mark 'lm-commentary-start) -(defsubst lm-history-mark () +(defsubst lm-commentary-end () + "Return the buffer location of the `Commentary' section end." + (lm-section-end lm-commentary-header)) + +(defsubst lm-history-start () "Return the buffer location of the `History' start marker." - (lm-section-mark lm-history-header)) + (lm-section-start lm-history-header)) +(defalias 'lm-history-mark 'lm-history-start) (defsubst lm-copyright-mark () "Return the buffer location of the `Copyright' line." @@ -215,8 +262,7 @@ If AFTER is non-nil, return the location of the next line." (let ((case-fold-search t)) (goto-char (point-min)) (if (re-search-forward lm-copyright-prefix nil t) - (point)))) - ) + (point))))) (defun lm-header (header) "Return the contents of the header named HEADER." @@ -253,18 +299,27 @@ The returned value is a list of strings, one per line." ;; These give us smart access to the header fields and commentary (defmacro lm-with-file (file &rest body) - "Make a buffer with FILE current, and execute BODY. -If FILE isn't in a buffer, load it in, and kill it after BODY is executed." + "Execute BODY in a buffer containing the contents of FILE. +If FILE is nil, execute BODY in the current buffer." (let ((filesym (make-symbol "file"))) - `(save-excursion - (let ((,filesym ,file)) - (if ,filesym (set-buffer (find-file-noselect ,filesym))) - (prog1 (progn ,@body) - (if (and ,filesym (not (get-buffer-window (current-buffer) t))) - (kill-buffer (current-buffer)))))))) + `(let ((,filesym ,file)) + (if ,filesym + (with-temp-buffer + (insert-file-contents ,filesym) + (emacs-lisp-mode) + ,@body) + (save-excursion + ;; Switching major modes is too drastic, so just switch + ;; temporarily to the Emacs Lisp mode syntax table. + (with-syntax-table emacs-lisp-mode-syntax-table + ,@body)))))) + (put 'lm-with-file 'lisp-indent-function 1) (put 'lm-with-file 'edebug-form-spec t) +;; Fixme: Probably this should be amalgamated with copyright.el; also +;; we need a check for ranges in copyright years. + (defun lm-crack-copyright (&optional file) "Return the copyright holder, and a list of copyright years. Use the current buffer if FILE is nil. @@ -273,13 +328,33 @@ Return argument is of the form (\"HOLDER\" \"YEAR1\" ... \"YEARN\")" (goto-char (lm-copyright-mark)) (let ((holder nil) (years nil) + (start (point)) (end (line-end-position))) - (while (re-search-forward "\\([0-9]+\\),? +" end t) - (setq years (cons (match-string-no-properties 1) years))) - (if (looking-at ".*$") - (setq holder (match-string-no-properties 0))) - (cons holder (nreverse years)) - ))) + ;; Cope with multi-line copyright `lines'. Assume the second + ;; line is indented (with the same commenting style). + (save-excursion + (beginning-of-line 2) + (let ((str (concat (match-string-no-properties 1) "[ \t]+"))) + (beginning-of-line) + (while (looking-at str) + (setq end (line-end-position)) + (beginning-of-line 2)))) + ;; Make a single line and parse that. + (let ((buff (current-buffer))) + (with-temp-buffer + (insert-buffer-substring buff start end) + (goto-char (point-min)) + (while (re-search-forward "^;+[ \t]+" nil t) + (replace-match "")) + (goto-char (point-min)) + (while (re-search-forward " *\n" nil t) + (replace-match " ")) + (goto-char (point-min)) + (while (re-search-forward "\\([0-9]+\\),? +" nil t) + (setq years (cons (match-string-no-properties 1) years))) + (if (looking-at ".*$") + (setq holder (match-string-no-properties 0))))) + (cons holder (nreverse years))))) (defun lm-summary (&optional file) "Return the one-line summary of file FILE, or current buffer if FILE is nil." @@ -345,7 +420,7 @@ ISO-DATE non-nil means return the date in ISO 8601 format." (format "%s-%s-%s" yyyy mm dd) (format "%s %s %s" dd - (nth (string-to-int mm) + (nth (string-to-number mm) '("" "Jan" "Feb" "Mar" "Apr" "May" "Jun" "Jul" "Aug" "Sep" "Oct" "Nov" "Dec")) yyyy)))))) @@ -384,6 +459,7 @@ This can be found in an RCS or SCCS header." (if keywords (split-string keywords ",?[ \t]")))) +(defvar finder-known-keywords) (defun lm-keywords-finder-p (&optional file) "Return non-nil if any keywords in FILE are known to finder." (require 'finder) @@ -404,18 +480,14 @@ distribution." (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'." +Return the value as a string. In the file, the commentary +section starts with the tag `Commentary' or `Documentation' and +ends just before the next section. If the commentary section is +absent, return nil." (lm-with-file file - (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)))))) + (let ((start (lm-commentary-start))) + (when start + (buffer-substring-no-properties start (lm-commentary-end)))))) ;;; Verification and synopses @@ -440,24 +512,23 @@ copyright notice is allowed." (if (and file (file-directory-p file)) (setq ret (with-temp-buffer - (mapcar - (lambda (f) - (if (string-match ".*\\.el\\'" f) - (let ((status (lm-verify f))) - (insert f ":") - (if status - (lm-insert-at-column lm-comment-column status - "\n") - (if showok - (lm-insert-at-column lm-comment-column - "OK\n")))))) - (directory-files file)))) + (dolist (f (directory-files file nil "\\.el\\'") + (buffer-string)) + (when (file-regular-p f) + (let ((status (lm-verify f))) + (insert f ":") + (if status + (lm-insert-at-column lm-comment-column status + "\n") + (if showok + (lm-insert-at-column lm-comment-column + "OK\n")))))))) (lm-with-file file (setq name (lm-get-package-name)) (setq ret (cond ((null name) - (format "Package %s does not exist")) + "Can't find package name") ((not (lm-authors)) "`Author:' tag missing") ((not (lm-maintainer)) @@ -481,7 +552,7 @@ copyright notice is allowed." (concat "^;;;[ \t]+" name "[ \t]+ends here[ \t]*$" "\\|^;;;[ \t]+ End of file[ \t]+" name) nil t))) - (format "Can't find the footer line")) + "Can't find the footer line") ((not (and (lm-copyright-mark) (lm-crack-copyright))) "Can't find a valid copyright notice") ((not (or non-fsf-ok @@ -491,7 +562,7 @@ copyright notice is allowed." (t ret))))) (if verbose - (message ret)) + (message "%s" ret)) ret)) (defun lm-synopsis (&optional file showall) @@ -504,26 +575,21 @@ which do not include a recognizable synopsis." (read-file-name "Synopsis for (file or dir): "))) (if (and file (file-directory-p file)) - (with-temp-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")) - (when showall - (insert f ":") - (lm-insert-at-column lm-comment-column "NA\n")))))) - (directory-files file))) + (with-output-to-temp-buffer "*Synopsis*" + (set-buffer standard-output) + (dolist (f (directory-files file nil ".*\\.el\\'")) + (let ((syn (lm-synopsis (expand-file-name f file)))) + (when (or syn showall) + (insert f ":") + (lm-insert-at-column lm-comment-column (or syn "NA") "\n"))))) (save-excursion - (if file - (find-file file)) - (prog1 - (lm-summary) - (if file - (kill-buffer (current-buffer))))))) + (let ((must-kill (and file (not (get-file-buffer file))))) + (when file (find-file file)) + (prog1 + (if (interactive-p) + (message "%s" (lm-summary)) + (lm-summary)) + (when must-kill (kill-buffer (current-buffer)))))))) (eval-when-compile (defvar report-emacs-bug-address)) @@ -544,9 +610,10 @@ Prompts for bug subject TOPIC. Leaves you in a mail buffer." (if version (insert " version " version)) (newline 2) - (message + (message "%s" (substitute-command-keys "Type \\[mail-send] to send bug report.")))) (provide 'lisp-mnt) +;; arch-tag: fa3c5ab4-a37b-4e46-b7cf-b6d78b90e69e ;;; lisp-mnt.el ends here