X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/afb89aea69a969185068fd5dba327b9808fa08c2..e175bda252b8395d6c915eb0c68bbb05a1462981:/lisp/add-log.el diff --git a/lisp/add-log.el b/lisp/add-log.el index 22feb7d225..b7557b0150 100644 --- a/lisp/add-log.el +++ b/lisp/add-log.el @@ -1,6 +1,6 @@ ;;; add-log.el --- change log maintenance commands for Emacs -;; Copyright (C) 1985, 1986, 1988, 1993 Free Software Foundation, Inc. +;; Copyright (C) 1985, 1986, 1988, 1993, 1994 Free Software Foundation, Inc. ;; Keywords: maint @@ -26,14 +26,45 @@ ;;; Code: -;;;###autoload (defvar change-log-default-name nil "*Name of a change log file for \\[add-change-log-entry].") +(defvar add-log-current-defun-function nil + "\ +*If non-nil, function to guess name of current function from surrounding text. +\\[add-change-log-entry] calls this function (if nil, `add-log-current-defun' +instead) with no arguments. It returns a string or nil if it cannot guess.") + +(defvar add-log-full-name nil + "*Full name of user, for inclusion in ChangeLog daily headers. +This defaults to the value returned by the `user-full-name' function.") + +(defvar add-log-mailing-address nil + "*Electronic mail address of user, for inclusion in ChangeLog daily headers. +This defaults to the value of `user-mail-address'.") + +(defvar change-log-font-lock-keywords + '(("^[SMTWF].+$" . font-lock-function-name-face) ; Date line. + ("^\t\\* \\([^ :\n]+\\)" 1 font-lock-comment-face) ; File name. + ("\(\\([^)\n]+\\)\)" 1 font-lock-keyword-face)) ; Function name. + "Additional expressions to highlight in Change Log mode.") + +(defvar change-log-mode-map nil + "Keymap for Change Log major mode.") +(if change-log-mode-map + nil + (setq change-log-mode-map (make-sparse-keymap)) + (define-key change-log-mode-map "\M-q" 'change-log-fill-paragraph)) + (defun change-log-name () (or change-log-default-name - (if (eq system-type 'vax-vms) "$CHANGE_LOG$.TXT" "ChangeLog"))) + (if (eq system-type 'vax-vms) + "$CHANGE_LOG$.TXT" + (if (eq system-type 'ms-dos) + "changelo" + "ChangeLog")))) +;;;###autoload (defun prompt-for-change-log-name () "Prompt for a change log name." (let ((default (change-log-name))) @@ -44,79 +75,82 @@ ;;;###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. + +Optional arg FILE-NAME specifies the file to use. 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. +Otherwise, search in the current directory and its successive parents +for a file named `ChangeLog' (or whatever we use on this operating system). Once a file is found, `change-log-default-name' is set locally in the current buffer to the complete file name." + ;; If user specified a file name or if this buffer knows which one to use, + ;; just use that. (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 (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 (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)) + (setq file-name change-log-default-name) + (progn + ;; Chase links in the source file + ;; and use the change log in the dir where it points. + (setq file-name (or (and buffer-file-name + (file-name-directory + (file-chase-links buffer-file-name))) + default-directory)) + (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 + (file-name-nondirectory (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) +(defun add-change-log-entry (&optional whoami file-name other-window new-entry) "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." +Third arg OTHER-WINDOW non-nil means visit in other window. +Fourth arg NEW-ENTRY non-nil means always create a new entry at the front; +never append to an existing entry." (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))) + (if whoami + (progn + (setq add-log-full-name (read-input "Full name: " add-log-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)) - paragraph-end entry) - - (setq file-name (find-change-log file-name)) + (setq add-log-mailing-address + (read-input "Mailing address: " add-log-mailing-address)))) + (or add-log-full-name + (setq add-log-full-name (user-full-name))) + (or add-log-mailing-address + (setq add-log-mailing-address user-mail-address)) + (let ((defun (funcall (or add-log-current-defun-function + 'add-log-current-defun))) + paragraph-end entry) + + (setq file-name (expand-file-name (find-change-log file-name))) ;; Set ENTRY to the file name to use in the new entry. (and buffer-file-name @@ -132,16 +166,18 @@ Third arg OTHER-WINDOW non-nil means visit in other window." (if (and other-window (not (equal file-name buffer-file-name))) (find-file-other-window file-name) (find-file file-name)) + (or (eq major-mode 'change-log-mode) + (change-log-mode)) (undo-boundary) (goto-char (point-min)) (if (looking-at (concat (regexp-quote (substring (current-time-string) 0 10)) - ".* " (regexp-quote full-name) - " (" (regexp-quote login-name) "@")) + ".* " (regexp-quote add-log-full-name) + " <" (regexp-quote add-log-mailing-address))) (forward-line 1) (insert (current-time-string) - " " full-name - " (" login-name "@" site-name ")\n\n")) + " " add-log-full-name + " <" add-log-mailing-address ">\n\n")) ;; Search only within the first paragraph. (if (looking-at "\n*[^\n* \t]") @@ -155,7 +191,8 @@ Third arg OTHER-WINDOW non-nil means visit in other window." ;; Put this file name into the existing empty entry. (if entry (insert entry))) - ((and (re-search-forward + ((and (not new-entry) + (re-search-forward (concat (regexp-quote (concat "* " entry)) ;; Don't accept `foo.bar' when ;; looking for `foo': @@ -202,9 +239,9 @@ Third arg OTHER-WINDOW non-nil means visit in 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." +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'." (interactive (if current-prefix-arg (list current-prefix-arg (prompt-for-change-log-name)))) @@ -213,7 +250,7 @@ Interactively, with a prefix argument, the file name is prompted for." ;;;###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. @@ -225,26 +262,42 @@ Runs `change-log-mode-hook'." mode-name "Change Log" left-margin 8 fill-column 74) + (use-local-map change-log-mode-map) ;; Let each entry behave as one paragraph: - (set (make-local-variable 'paragraph-start) "^\\s *$\\|^^L") - (set (make-local-variable 'paragraph-separate) "^\\s *$\\|^^L\\|^\\sw") + (set (make-local-variable 'paragraph-start) "^\\s *$\\|^\f") + (set (make-local-variable 'paragraph-separate) "^\\s *$\\|^\f\\|^\\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 'page-delimiter) "^\\<\\|^\f") (set (make-local-variable 'version-control) 'never) (set (make-local-variable 'adaptive-fill-regexp) "\\s *") + (set (make-local-variable 'font-lock-defaults) + '(change-log-font-lock-keywords t)) (run-hooks 'change-log-mode-hook)) +;; It might be nice to have a general feature to replace this. The idea I +;; have is a variable giving a regexp matching text which should not be +;; moved from bol by filling. change-log-mode would set this to "^\\s *\\s(". +;; But I don't feel up to implementing that today. +(defun change-log-fill-paragraph (&optional justify) + "Fill the paragraph, but preserve open parentheses at beginning of lines. +Prefix arg means justify as well." + (interactive "P") + (let ((paragraph-separate (concat paragraph-separate "\\|^\\s *\\s(")) + (paragraph-start (concat paragraph-start "\\|^\\s *\\s("))) + (fill-paragraph justify))) + (defvar add-log-current-defun-header-regexp - "^\\([A-Z][A-Z_ ]*[A-Z_]\\|[a-z_---A-Z]+\\)[ \t]*[:=]" + "^\\([A-Z][A-Z_ ]*[A-Z_]\\|[-_a-zA-Z]+\\)[ \t]*[:=]" "*Heuristic regexp used by `add-log-current-defun' for unknown major modes.") +;;;###autoload (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), Perl, 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 @@ -255,7 +308,8 @@ 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)) + (cond ((memq major-mode '(emacs-lisp-mode lisp-mode scheme-mode + lisp-interaction-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. @@ -267,11 +321,13 @@ Has a preference of looking backwards." (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)))))) - ((and (memq major-mode '(c-mode 'c++-mode)) + ((and (memq major-mode '(c-mode c++-mode c++-c-mode)) (save-excursion (beginning-of-line) ;; Use eq instead of = here to avoid ;; error when at bob and char-after @@ -287,7 +343,7 @@ Has a preference of looking backwards." (skip-chars-forward " \t") (buffer-substring (point) (progn (forward-sexp 1) (point)))) - ((memq major-mode '(c-mode 'c++-mode)) + ((memq major-mode '(c-mode c++-mode c++-c-mode)) (beginning-of-line) ;; See if we are in the beginning part of a function, ;; before the open brace. If so, advance forward. @@ -311,7 +367,9 @@ Has a preference of looking backwards." ;; or the DEFUN macro used by the C library. (if (condition-case nil (and (save-excursion - (forward-line 1) + (end-of-line) + (while (= (preceding-char) ?\\) + (end-of-line 2)) (backward-sexp 1) (beginning-of-line) (setq tem (point)) @@ -370,9 +428,32 @@ Has a preference of looking backwards." (end-of-line) (point)))))) ((eq major-mode 'texinfo-mode) - (if (re-search-backward "^@node[ \t]+\\([^,]+\\)," nil t) + (if (re-search-backward "^@node[ \t]+\\([^,\n]+\\)" nil t) + (buffer-substring (match-beginning 1) + (match-end 1)))) + ((eq major-mode 'perl-mode) + (if (re-search-backward "^sub[ \t]+\\([^ \t\n]+\\)" 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)