;;; add-log.el --- change log maintenance commands for Emacs
-;; Copyright (C) 1985, 86, 87, 88, 89, 90, 91, 1992
-;; Free Software Foundation, Inc.
+;; Copyright (C) 1985, 1986, 1988, 1993 Free Software Foundation, Inc.
+
+;; Keywords: maint
;; This file is part of GNU Emacs.
;; along with GNU Emacs; see the file COPYING. If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;;; Commentary:
+
+;; This facility is documented in the Emacs Manual.
+
;;; Code:
;;;###autoload
(read-file-name (format "Log file (default %s): " default)
nil default))))
+;;;###autoload
+(defun find-change-log (&optional file-name)
+ "Find a change log file for \\[add-change-log-entry] and return the name.
+Optional arg FILE-NAME is a name to try first.
+If FILE-NAME is nil, use the value of `change-log-default-name' if non-nil.
+Failing that, use \"ChangeLog\" in the current directory.
+If the file does not exist in the named directory, successive parent
+directories are tried.
+
+Once a file is found, `change-log-default-name' is set locally in the
+current buffer to the complete file name."
+ (or file-name
+ (setq file-name (or change-log-default-name
+ ;; Chase links in the source file
+ ;; and use the change log in the dir where it points.
+ (and buffer-file-name
+ (file-name-directory
+ (file-chase-links buffer-file-name)))
+ default-directory)))
+ (if (and (eq file-name change-log-default-name)
+ (assq 'change-log-default-name (buffer-local-variables)))
+ ;; Don't do the searching if we already have a buffer-local value.
+ file-name
+
+ (if (file-directory-p file-name)
+ (setq file-name (expand-file-name (change-log-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 (file-chase-links file-name))
+ (setq file-name (expand-file-name file-name))
+ ;; Move up in the dir hierarchy till we find a change log file.
+ (let ((file1 file-name)
+ parent-dir)
+ (while (and (not (or (get-file-buffer file1) (file-exists-p file1)))
+ (progn (setq parent-dir
+ (file-name-directory
+ (directory-file-name
+ (file-name-directory file1))))
+ ;; Give up if we are already at the root dir.
+ (not (string= (file-name-directory file1)
+ parent-dir))))
+ ;; Move up to the parent dir and try again.
+ (setq file1 (expand-file-name (change-log-name) parent-dir)))
+ ;; If we found a change log in a parent, use that.
+ (if (or (get-file-buffer file1) (file-exists-p file1))
+ (setq file-name file1)))
+ ;; Make a local variable in this buffer so we needn't search again.
+ (set (make-local-variable 'change-log-default-name) file-name)
+ file-name))
+
;;;###autoload
(defun add-change-log-entry (&optional whoami file-name other-window)
"Find change log file and add an entry for today.
(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
- (expand-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))
+ paragraph-end entry)
+
+ (setq file-name (find-change-log file-name))
+
+ ;; Set ENTRY to the file name to use in the new entry.
+ (and buffer-file-name
+ ;; Never want to add a change log entry for the ChangeLog file itself.
+ (not (string= buffer-file-name 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))))
+
(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"))
+ (if (looking-at (concat (regexp-quote (substring (current-time-string)
+ 0 10))
+ ".* " (regexp-quote full-name)
+ " (" (regexp-quote login-name) "@"))
+ (forward-line 1)
+ (insert (current-time-string)
+ " " full-name
+ " (" login-name "@" site-name ")\n\n"))
+
+ ;; Search only within the first paragraph.
+ (if (looking-at "\n*[^\n* \t]")
+ (skip-chars-forward "\n")
+ (forward-paragraph 1))
+ (setq paragraph-end (point))
(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 *$")
+ (cond ((re-search-forward "^\\s *\\*\\s *$" paragraph-end t)
+ ;; Put this file name into the existing empty entry.
+ (if entry
+ (insert entry)))
+ ((and (re-search-forward
+ (concat (regexp-quote (concat "* " entry))
+ ;; Don't accept `foo.bar' when
+ ;; looking for `foo':
+ "\\(\\s \\|[(),:]\\)")
+ paragraph-end t))
+ ;; Add to the existing entry for the same file.
+ (re-search-forward "^\\s *$\\|^\\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)
(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.
(list current-prefix-arg
(prompt-for-change-log-name))))
(add-change-log-entry whoami file-name t))
+;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
;;;###autoload
(defun change-log-mode ()
- "Major mode for editting change logs; like Indented Text Mode.
+ "Major mode for editing 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.
(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)
+ (setq major-mode 'change-log-mode
+ mode-name "Change Log"
+ left-margin 8
+ 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")
(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.
+Understands C, Lisp, LaTeX (\"functions\" are chapters, sections, ...),
+Texinfo (@node titles), and Fortran.
Other modes are handled by a heuristic that looks in the 10K before
point for uppercase headings starting in the first column or
(progn (forward-sexp -1)
(>= location (point))))
(progn
- (forward-word 1)
+ (if (looking-at "\\s(")
+ (forward-char 1))
+ (forward-sexp 1)
(skip-chars-forward " ")
(buffer-substring (point)
(progn (forward-sexp 1) (point))))))
(if (re-search-backward "^@node[ \t]+\\([^,]+\\)," nil t)
(buffer-substring (match-beginning 1)
(match-end 1))))
+ ((eq major-mode 'fortran-mode)
+ ;; must be inside function body for this to work
+ (beginning-of-fortran-subprogram)
+ (let ((case-fold-search t)) ; case-insensitive
+ ;; search for fortran subprogram start
+ (if (re-search-forward
+ "^[ \t]*\\(program\\|subroutine\\|function\
+\\|[ \ta-z0-9*]*[ \t]+function\\)"
+ nil t)
+ (progn
+ ;; move to EOL or before first left paren
+ (if (re-search-forward "[(\n]" nil t)
+ (progn (forward-char -1)
+ (skip-chars-backward " \t"))
+ (end-of-line))
+ ;; Use the name preceding that.
+ (buffer-substring (point)
+ (progn (forward-sexp -1)
+ (point)))))))
(t
;; If all else fails, try heuristics
(let (case-fold-search)