1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-05 08:53:45 +00:00
emacs/lisp/add-log.el
Richard M. Stallman 2cc0b7656d (add-log-current-defun): Add condition-case around
the body, so at worst we return nil.
1992-10-19 22:39:55 +00:00

357 lines
12 KiB
EmacsLisp
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

;;; add-log.el --- change log maintenance commands for Emacs
;; Copyright (C) 1985, 86, 87, 88, 89, 90, 91, 1992
;; Free Software Foundation, Inc.
;; This file is part of GNU Emacs.
;; 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)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; 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.
;;; Code:
;;;###autoload
(defvar change-log-default-name nil
"*Name of a change log file for \\[add-change-log-entry].")
(defun change-log-name ()
(or change-log-default-name
(if (eq system-type 'vax-vms) "$CHANGE_LOG$.TXT" "ChangeLog")))
(defun prompt-for-change-log-name ()
"Prompt for a change log name."
(let ((default (change-log-name)))
(expand-file-name
(read-file-name (format "Log file (default %s): " default)
nil default))))
;;;###autoload
(defun add-change-log-entry (&optional whoami file-name other-window)
"Find change log file and add an entry for today.
Optional arg (interactive prefix) non-nil means prompt for user name and site.
Second arg is file name of change log. If nil, uses `change-log-default-name'.
Third arg OTHER-WINDOW non-nil means visit in other window."
(interactive (list current-prefix-arg
(prompt-for-change-log-name)))
(let* ((full-name (if whoami
(read-input "Full name: " (user-full-name))
(user-full-name)))
;; Note that some sites have room and phone number fields in
;; full name which look silly when inserted. Rather than do
;; anything about that here, let user give prefix argument so that
;; s/he can edit the full name field in prompter if s/he wants.
(login-name (if whoami
(read-input "Login name: " (user-login-name))
(user-login-name)))
(site-name (if whoami
(read-input "Site name: " (system-name))
(system-name)))
(defun (add-log-current-defun))
entry entry-position empty-entry)
(or file-name
(setq file-name (or change-log-default-name
default-directory)))
(setq file-name (if (file-directory-p file-name)
(expand-file-name (change-log-name) file-name)
(expand-file-name file-name)))
;; Chase links before visiting the file.
;; This makes it easier to use a single change log file
;; for several related directories.
(setq file-name (or (file-symlink-p file-name) file-name))
(set (make-local-variable 'change-log-default-name) file-name)
(if buffer-file-name
(setq entry (if (string-match
(concat "^" (regexp-quote (file-name-directory
file-name)))
buffer-file-name)
(substring buffer-file-name (match-end 0))
(file-name-nondirectory buffer-file-name))))
;; Never want to add a change log entry for the ChangeLog file itself.
(if (equal entry "ChangeLog")
(setq entry nil
defun nil))
(if (and other-window (not (equal file-name buffer-file-name)))
(find-file-other-window file-name)
(find-file file-name))
(undo-boundary)
(goto-char (point-min))
(or (looking-at (concat (substring (current-time-string) 0 10)
".* " full-name " (" login-name "@"))
(insert (current-time-string)
" " full-name
" (" login-name
"@" site-name ")\n\n"))
(goto-char (point-min))
(setq empty-entry
(and (search-forward "\n\t* \n" nil t)
(1- (point))))
(if (and entry
(not empty-entry))
;; Look for today's entry for the same file.
;; If there is an empty entry (just a `*'), take the hint and
;; use it. This is so that C-x a from the ChangeLog buffer
;; itself can be used to force the next entry to be added at
;; the beginning, even if there are today's entries for the
;; same file (but perhaps different revisions).
(let ((entry-boundary (save-excursion
(and (re-search-forward "\n[A-Z]" nil t)
(point)))))
(setq entry-position (save-excursion
(and (re-search-forward
(concat
(regexp-quote (concat "* " entry))
;; don't accept `foo.bar' when
;; looking for `foo':
"[ \n\t,:]")
entry-boundary
t)
(1- (match-end 0)))))))
;; Now insert the new line for this entry.
(cond (entry-position
;; Move to the existing entry for the same file.
(goto-char entry-position)
(re-search-forward "^\\s *$")
(beginning-of-line)
(while (and (not (eobp)) (looking-at "^\\s *$"))
(delete-region (point) (save-excursion (forward-line 1) (point))))
(insert "\n\n")
(forward-line -2)
(indent-relative-maybe))
(empty-entry
;; Put this file name into the existing empty entry.
(goto-char empty-entry)
(if entry
(insert entry)))
(t
;; Make a new entry.
(forward-line 1)
(while (looking-at "\\sW")
(forward-line 1))
(while (and (not (eobp)) (looking-at "^\\s *$"))
(delete-region (point) (save-excursion (forward-line 1) (point))))
(insert "\n\n\n")
(forward-line -2)
(indent-to left-margin)
(insert "* " (or entry ""))))
;; Now insert the function name, if we have one.
;; Point is at the entry for this file,
;; either at the end of the line or at the first blank line.
(if defun
(progn
;; Make it easy to get rid of the function name.
(undo-boundary)
(insert (if (save-excursion
(beginning-of-line 1)
(looking-at "\\s *$"))
""
" ")
"(" defun "): "))
;; No function name, so put in a colon unless we have just a star.
(if (not (save-excursion
(beginning-of-line 1)
(looking-at "\\s *\\(\\*\\s *\\)?$")))
(insert ": ")))))
;;;###autoload
(define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
;;;###autoload
(defun add-change-log-entry-other-window (&optional whoami file-name)
"Find change log file in other window and add an entry for today.
First arg (interactive prefix) non-nil means prompt for user name and site.
Second arg is file name of change log.
Interactively, with a prefix argument, the file name is prompted for."
(interactive (if current-prefix-arg
(list current-prefix-arg
(prompt-for-change-log-name))))
(add-change-log-entry whoami file-name t))
;;;###autoload
(defun change-log-mode ()
"Major mode for editting change logs; like Indented Text Mode.
Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
New log entries are usually made with \\[add-change-log-entry] or \\[add-change-log-entry-other-window].
Each entry behaves as a paragraph, and the entries for one day as a page.
Runs `change-log-mode-hook'."
(interactive)
(kill-all-local-variables)
(indented-text-mode)
(setq major-mode 'change-log-mode)
(setq mode-name "Change Log")
(setq left-margin 8)
(setq fill-column 74)
;; Let each entry behave as one paragraph:
(set (make-local-variable 'paragraph-start) "^\\s *$\\|^^L")
(set (make-local-variable 'paragraph-separate) "^\\s *$\\|^^L\\|^\\sw")
;; Let all entries for one day behave as one page.
;; Match null string on the date-line so that the date-line
;; is grouped with what follows.
(set (make-local-variable 'page-delimiter) "^\\<\\|^ ")
(set (make-local-variable 'version-control) 'never)
(set (make-local-variable 'adaptive-fill-regexp) "\\s *")
(run-hooks 'change-log-mode-hook))
(defvar add-log-current-defun-header-regexp
"^\\([A-Z][A-Z_ ]*[A-Z_]\\|[a-z_---A-Z]+\\)[ \t]*[:=]"
"*Heuristic regexp used by `add-log-current-defun' for unknown major modes.")
(defun add-log-current-defun ()
"Return name of function definition point is in, or nil.
Understands Lisp, LaTeX (\"functions\" are chapters, sections, ...),
Texinfo (@node titles), and C.
Other modes are handled by a heuristic that looks in the 10K before
point for uppercase headings starting in the first column or
identifiers followed by `:' or `=', see variable
`add-log-current-defun-header-regexp'.
Has a preference of looking backwards."
(condition-case nil
(save-excursion
(let ((location (point)))
(cond ((memq major-mode '(emacs-lisp-mode lisp-mode scheme-mode))
;; If we are now precisely a the beginning of a defun,
;; make sure beginning-of-defun finds that one
;; rather than the previous one.
(or (eobp) (forward-char 1))
(beginning-of-defun)
;; Make sure we are really inside the defun found, not after it.
(if (and (progn (end-of-defun)
(< location (point)))
(progn (forward-sexp -1)
(>= location (point))))
(progn
(forward-word 1)
(skip-chars-forward " ")
(buffer-substring (point)
(progn (forward-sexp 1) (point))))))
((and (memq major-mode '(c-mode 'c++-mode))
(save-excursion (beginning-of-line)
;; Use eq instead of = here to avoid
;; error when at bob and char-after
;; returns nil.
(while (eq (char-after (- (point) 2)) ?\\)
(forward-line -1))
(looking-at "[ \t]*#[ \t]*define[ \t]")))
;; Handle a C macro definition.
(beginning-of-line)
(while (eq (char-after (- (point) 2)) ?\\) ;not =; note above
(forward-line -1))
(search-forward "define")
(skip-chars-forward " \t")
(buffer-substring (point)
(progn (forward-sexp 1) (point))))
((memq major-mode '(c-mode 'c++-mode))
(beginning-of-line)
;; See if we are in the beginning part of a function,
;; before the open brace. If so, advance forward.
(while (not (looking-at "{\\|\\(\\s *$\\)"))
(forward-line 1))
(or (eobp)
(forward-char 1))
(beginning-of-defun)
(if (progn (end-of-defun)
(< location (point)))
(progn
(backward-sexp 1)
(let (beg tem)
(forward-line -1)
;; Skip back over typedefs of arglist.
(while (and (not (bobp))
(looking-at "[ \t\n]"))
(forward-line -1))
;; See if this is using the DEFUN macro used in Emacs,
;; or the DEFUN macro used by the C library.
(if (condition-case nil
(and (save-excursion
(forward-line 1)
(backward-sexp 1)
(beginning-of-line)
(setq tem (point))
(looking-at "DEFUN\\b"))
(>= location tem))
(error nil))
(progn
(goto-char tem)
(down-list 1)
(if (= (char-after (point)) ?\")
(progn
(forward-sexp 1)
(skip-chars-forward " ,")))
(buffer-substring (point)
(progn (forward-sexp 1) (point))))
;; Ordinary C function syntax.
(setq beg (point))
(if (condition-case nil
;; Protect against "Unbalanced parens" error.
(progn
(down-list 1) ; into arglist
(backward-up-list 1)
(skip-chars-backward " \t")
t)
(error nil))
;; Verify initial pos was after
;; real start of function.
(if (and (save-excursion
(goto-char beg)
;; For this purpose, include the line
;; that has the decl keywords. This
;; may also include some of the
;; comments before the function.
(while (and (not (bobp))
(save-excursion
(forward-line -1)
(looking-at "[^\n\f]")))
(forward-line -1))
(>= location (point)))
;; Consistency check: going down and up
;; shouldn't take us back before BEG.
(> (point) beg))
(buffer-substring (point)
(progn (backward-sexp 1)
(point))))))))))
((memq major-mode
'(TeX-mode plain-TeX-mode LaTeX-mode;; tex-mode.el
plain-tex-mode latex-mode;; cmutex.el
))
(if (re-search-backward
"\\\\\\(sub\\)*\\(section\\|paragraph\\|chapter\\)" nil t)
(progn
(goto-char (match-beginning 0))
(buffer-substring (1+ (point));; without initial backslash
(progn
(end-of-line)
(point))))))
((eq major-mode 'texinfo-mode)
(if (re-search-backward "^@node[ \t]+\\([^,]+\\)," nil t)
(buffer-substring (match-beginning 1)
(match-end 1))))
(t
;; If all else fails, try heuristics
(let (case-fold-search)
(end-of-line)
(if (re-search-backward add-log-current-defun-header-regexp
(- (point) 10000)
t)
(buffer-substring (match-beginning 1)
(match-end 1))))))))
(error nil)))
(provide 'add-log)
;;; add-log.el ends here