mirror of
git://git.sv.gnu.org/emacs.git
synced 2025-12-15 10:30:25 -08:00
Make the description of the library more
accurate. (lm-any-header): New user option. (lm-section-start): New function; rewrite of `lm-section-mark'. (lm-section-mark): Make alias of `lm-section-start'. (lm-section-end): New function. (lm-code-start): New function; rewrite of `lm-code-mark'. (lm-code-mark): Make alias of `lm-code-start'. (lm-commentary-start): New function; rewrite of `lm-commentary-mark'. (lm-commentary-mark): Make alias of `lm-commentary-start'. (lm-commentary-end): New function. (lm-history-start): New function; rewrite of `lm-history-mark'. (lm-history-mark): Make alias of `lm-history-start'. (lm-commentary): Use `lm-commentary-end' to find the end of the commentary section.
This commit is contained in:
parent
ac902a0103
commit
c7dff41d3f
1 changed files with 65 additions and 30 deletions
|
|
@ -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 <esr@snark.thyrsus.com>
|
;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
|
||||||
;; Maintainer: FSF
|
;; Maintainer: FSF
|
||||||
|
|
@ -27,7 +27,7 @@
|
||||||
|
|
||||||
;;; Commentary:
|
;;; 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.
|
;; First, it knows about the header conventions for library packages.
|
||||||
;; One entry point supports generating synopses from a library directory.
|
;; One entry point supports generating synopses from a library directory.
|
||||||
|
|
@ -79,7 +79,7 @@
|
||||||
;; in this file is mildly bogus because the maintainer line is redundant.
|
;; 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
|
;; 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
|
;; 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.
|
;; there's also a name in the field.
|
||||||
;;
|
;;
|
||||||
;; * Created line --- optional, gives the original creation date of the
|
;; * Created line --- optional, gives the original creation date of the
|
||||||
|
|
@ -124,7 +124,7 @@
|
||||||
;;; Variables:
|
;;; Variables:
|
||||||
|
|
||||||
(defgroup lisp-mnt nil
|
(defgroup lisp-mnt nil
|
||||||
"Minor mode for Emacs Lisp maintainers."
|
"Utility functions for Emacs Lisp maintainers."
|
||||||
:prefix "lm-"
|
:prefix "lm-"
|
||||||
:group 'maint)
|
:group 'maint)
|
||||||
|
|
||||||
|
|
@ -156,6 +156,11 @@ Leading comment characters and whitespace should be in regexp group 1."
|
||||||
:type 'integer
|
:type 'integer
|
||||||
:group 'lisp-mnt)
|
: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"
|
(defcustom lm-commentary-header "Commentary\\|Documentation"
|
||||||
"Regexp which matches start of documentation section."
|
"Regexp which matches start of documentation section."
|
||||||
:type 'regexp
|
:type 'regexp
|
||||||
|
|
@ -188,30 +193,65 @@ return section regexp instead."
|
||||||
(match-end 1)))
|
(match-end 1)))
|
||||||
(match-string-no-properties 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.
|
"Return the buffer location of a given section start marker.
|
||||||
The HEADER is the section mark string to search for.
|
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
|
(save-excursion
|
||||||
(let ((case-fold-search t))
|
(let ((case-fold-search t))
|
||||||
(goto-char (point-min))
|
(goto-char (point-min))
|
||||||
(if (re-search-forward (lm-get-header-re header 'section) nil t)
|
(if (re-search-forward (lm-get-header-re header 'section) nil t)
|
||||||
(progn
|
(line-beginning-position (if after 2))))))
|
||||||
(beginning-of-line)
|
(defalias 'lm-section-mark 'lm-section-start)
|
||||||
(if after (forward-line 1))
|
|
||||||
(point))))))
|
|
||||||
|
|
||||||
(defsubst lm-code-mark ()
|
(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."
|
"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."
|
"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."
|
"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 ()
|
(defsubst lm-copyright-mark ()
|
||||||
"Return the buffer location of the `Copyright' line."
|
"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))
|
(let ((case-fold-search t))
|
||||||
(goto-char (point-min))
|
(goto-char (point-min))
|
||||||
(if (re-search-forward lm-copyright-prefix nil t)
|
(if (re-search-forward lm-copyright-prefix nil t)
|
||||||
(point))))
|
(point)))))
|
||||||
)
|
|
||||||
|
|
||||||
(defun lm-header (header)
|
(defun lm-header (header)
|
||||||
"Return the contents of the header named HEADER."
|
"Return the contents of the header named HEADER."
|
||||||
|
|
@ -431,18 +470,14 @@ distribution."
|
||||||
|
|
||||||
(defun lm-commentary (&optional file)
|
(defun lm-commentary (&optional file)
|
||||||
"Return the commentary in file FILE, or current buffer if FILE is nil.
|
"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
|
Return the value as a string. In the file, the commentary
|
||||||
with the tag `Commentary' or `Documentation' and ends with one of the
|
section starts with the tag `Commentary' or `Documentation' and
|
||||||
tags `Code', `Change Log' or `History'."
|
ends just before the next section. If the commentary section is
|
||||||
|
absent, return nil."
|
||||||
(lm-with-file file
|
(lm-with-file file
|
||||||
(let ((commentary (lm-commentary-mark))
|
(let ((start (lm-commentary-start)))
|
||||||
(change-log (lm-history-mark))
|
(when start
|
||||||
(code (lm-code-mark)))
|
(buffer-substring-no-properties start (lm-commentary-end))))))
|
||||||
(cond
|
|
||||||
((and commentary change-log)
|
|
||||||
(buffer-substring-no-properties commentary change-log))
|
|
||||||
((and commentary code)
|
|
||||||
(buffer-substring-no-properties commentary code))))))
|
|
||||||
|
|
||||||
;;; Verification and synopses
|
;;; Verification and synopses
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue