X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/af95e0d149d7c4c9ae5674db2bb55d749b371639..0cb9b63a7b9a35168c20862a7c67a1d1e12b0be3:/lisp/emacs-lisp/lisp-mnt.el diff --git a/lisp/emacs-lisp/lisp-mnt.el b/lisp/emacs-lisp/lisp-mnt.el index bda307198f..18967677b3 100644 --- a/lisp/emacs-lisp/lisp-mnt.el +++ b/lisp/emacs-lisp/lisp-mnt.el @@ -1,6 +1,6 @@ -;;; 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, 2003 Free Software Foundation, Inc. ;; Author: Eric S. Raymond ;; Maintainer: FSF @@ -27,12 +27,12 @@ ;;; 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. @@ -40,11 +40,11 @@ ;; 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 +55,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 +69,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 +104,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,7 +124,7 @@ ;;; Variables: (defgroup lisp-mnt nil - "Minor mode for Emacs Lisp maintainers." + "Utility functions for Emacs Lisp maintainers." :prefix "lm-" :group 'maint) @@ -156,6 +156,11 @@ Leading comment characters and whitespace should be in regexp group 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 @@ -188,30 +193,65 @@ 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." + (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-commentary-end () + "Return the buffer location of the `Commentary' section end." + (lm-section-end lm-commentary-header)) -(defsubst lm-history-mark () +(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." @@ -219,8 +259,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." @@ -417,7 +456,8 @@ This can be found in an RCS or SCCS header." (let ((keys (lm-keywords-list file))) (catch 'keyword-found (while keys - (if (assoc (intern (car keys)) finder-known-keywords) + (if (assoc (intern (car keys)) + (with-no-warnings finder-known-keywords)) (throw 'keyword-found t)) (setq keys (cdr keys))) nil))) @@ -431,18 +471,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 @@ -531,26 +567,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))