X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/947b27432d908de7be6fc7a260b1b53931b1167d..a03b3ce13b064a5f775525d8208e747b87a169cf:/lisp/add-log.el diff --git a/lisp/add-log.el b/lisp/add-log.el index 0791fe1fe3..287ff094ae 100644 --- a/lisp/add-log.el +++ b/lisp/add-log.el @@ -1,8 +1,8 @@ ;;; add-log.el --- change log maintenance commands for Emacs -;; Copyright (C) 1985, 1986, 1988, 1993, 1994 Free Software Foundation, Inc. +;; Copyright (C) 1985, 86, 88, 93, 94, 97, 1998 Free Software Foundation, Inc. -;; Keywords: maint +;; Keywords: tools ;; This file is part of GNU Emacs. @@ -27,43 +27,164 @@ ;;; Code: -(defvar change-log-default-name nil - "*Name of a change log file for \\[add-change-log-entry].") +(eval-when-compile (require 'fortran)) -(defvar add-log-current-defun-function nil +(defgroup change-log nil + "Change log maintenance" + :group 'tools + :link '(custom-manual "(emacs)Change Log") + :prefix "change-log-" + :prefix "add-log-") + + +(defcustom change-log-default-name nil + "*Name of a change log file for \\[add-change-log-entry]." + :type '(choice (const :tag "default" nil) + string) + :group 'change-log) + +(defcustom 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.") +instead) with no arguments. It returns a string or nil if it cannot guess." + :type 'function + :group 'change-log) -(defvar add-log-full-name nil +;;;###autoload +(defcustom 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.") +This defaults to the value returned by the `user-full-name' function." + :type '(choice (const :tag "Default" nil) + string) + :group 'change-log) -(defvar add-log-mailing-address nil +;;;###autoload +(defcustom 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'.") +This defaults to the value of `user-mail-address'." + :type '(choice (const :tag "Default" nil) + string) + :group 'change-log) + +(defcustom add-log-time-format 'add-log-iso8601-time-string + "*Function that defines the time format. +For example, `add-log-iso8601-time-string', which gives the +date in international ISO 8601 format, +and `current-time-string' are two valid values." + :type '(radio (const :tag "International ISO 8601 format" + add-log-iso8601-time-string) + (const :tag "Old format, as returned by `current-time-string'" + current-time-string) + (function :tag "Other")) + :group 'change-log) + +(defcustom add-log-keep-changes-together nil + "*If non-nil, normally keep day's log entries for one file together. + +Log entries for a given file made with \\[add-change-log-entry] or +\\[add-change-log-entry-other-window] will only be added to others \ +for that file made +today if this variable is non-nil or that file comes first in today's +entries. Otherwise another entry for that file will be started. An +original log: + + * foo (...): ... + * bar (...): change 1 + +in the latter case, \\[add-change-log-entry-other-window] in a \ +buffer visiting `bar', yields: + + * bar (...): -!- + * foo (...): ... + * bar (...): change 1 + +and in the former: + + * foo (...): ... + * bar (...): change 1 + (...): -!- + +The NEW-ENTRY arg to `add-change-log-entry' can override the effect of +this variable." + :version "20.3" + :type 'boolean + :group 'change-log) (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. + '(;; + ;; Date lines, new and old styles. + ("^\\sw.........[0-9:+ ]*" + (0 font-lock-string-face) + ("\\([^<]+\\)<\\([A-Za-z0-9_.-]+@[A-Za-z0-9_.-]+\\)>" nil nil + (1 font-lock-constant-face) + (2 font-lock-variable-name-face))) + ;; + ;; File names. + ("^\t\\* \\([^ ,:([\n]+\\)" + (1 font-lock-function-name-face) + ("\\=, \\([^ ,:([\n]+\\)" nil nil (1 font-lock-function-name-face))) + ;; + ;; Function or variable names. + ("(\\([^) ,:\n]+\\)" + (1 font-lock-keyword-face) + ("\\=, *\\([^) ,:\n]+\\)" nil nil (1 font-lock-keyword-face))) + ;; + ;; Conditionals. + ("\\[!?\\([^]\n]+\\)\\]\\(:\\| (\\)" (1 font-lock-variable-name-face)) + ;; + ;; Acknowledgements. + ("^\t\\(From\\|Patch\\(es\\)? by\\|Report\\(ed by\\| from\\)\\|Suggest\\(ed by\\|ion from\\)\\)" + 1 font-lock-comment-face) + (" \\(From\\|Patch\\(es\\)? by\\|Report\\(ed by\\| from\\)\\|Suggest\\(ed by\\|ion from\\)\\)" + 1 font-lock-comment-face)) "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)) + (setq change-log-mode-map (make-sparse-keymap))) + +(defvar change-log-time-zone-rule nil + "Time zone used for calculating change log time stamps. +It takes the same format as the TZ argument of `set-time-zone-rule'. +If nil, use local time.") + +(defvar add-log-debugging) + +(defun add-log-iso8601-time-zone (time) + (let* ((utc-offset (or (car (current-time-zone time)) 0)) + (sign (if (< utc-offset 0) ?- ?+)) + (sec (abs utc-offset)) + (ss (% sec 60)) + (min (/ sec 60)) + (mm (% min 60)) + (hh (/ min 60))) + (format (cond ((not (zerop ss)) "%c%02d:%02d:%02d") + ((not (zerop mm)) "%c%02d:%02d") + (t "%c%02d")) + sign hh mm ss))) + +(defun add-log-iso8601-time-string () + (if change-log-time-zone-rule + (let ((tz (getenv "TZ")) + (now (current-time))) + (unwind-protect + (progn + (set-time-zone-rule + change-log-time-zone-rule) + (concat + (format-time-string "%Y-%m-%d " now) + (add-log-iso8601-time-zone now))) + (set-time-zone-rule tz))) + (format-time-string "%Y-%m-%d"))) (defun change-log-name () (or change-log-default-name - (if (eq system-type 'vax-vms) - "$CHANGE_LOG$.TXT" - (if (or (eq system-type 'ms-dos) (eq system-type 'windows-nt)) - "changelo" - "ChangeLog")))) + (if (eq system-type 'vax-vms) + "$CHANGE_LOG$.TXT" + "ChangeLog"))) ;;;###autoload (defun prompt-for-change-log-name () @@ -93,7 +214,7 @@ If 'change-log-default-name' is nil, behave as though it were 'ChangeLog' \(or whatever we use on this operating system). If 'change-log-default-name' contains a leading directory component, then -simply find it in the current directory. Otherwise, search in the current +simply find it in the current directory. Otherwise, search in the current directory and its successive parents for a file so named. Once a file is found, `change-log-default-name' is set locally in the @@ -130,7 +251,7 @@ current buffer to the complete file name." (not (string= (file-name-directory file1) parent-dir)))) ;; Move up to the parent dir and try again. - (setq file1 (expand-file-name + (setq file1 (expand-file-name (file-name-nondirectory (change-log-name)) parent-dir))) ;; If we found a change log in a parent, use that. @@ -143,11 +264,17 @@ current buffer to the complete file name." ;;;###autoload (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'. +Optional arg WHOAMI (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. Fourth arg NEW-ENTRY non-nil means always create a new entry at the front; -never append to an existing entry." +never append to an existing entry. Option `add-log-keep-changes-together' +otherwise affects whether a new entry is created. + +Today's date is calculated according to `change-log-time-zone-rule' if +non-nil, otherwise in local time." (interactive (list current-prefix-arg (prompt-for-change-log-name))) (or add-log-full-name @@ -165,7 +292,7 @@ never append to an existing entry." (read-input "Mailing address: " add-log-mailing-address)))) (let ((defun (funcall (or add-log-current-defun-function 'add-log-current-defun))) - paragraph-end entry) + bound entry) (setq file-name (expand-file-name (find-change-log file-name))) @@ -180,6 +307,8 @@ never append to an existing entry." (substring buffer-file-name (match-end 0)) (file-name-nondirectory buffer-file-name)))) + (let ((buffer (find-buffer-visiting file-name))) + (setq add-log-debugging (list (gap-position) (gap-size)))) (if (and other-window (not (equal file-name buffer-file-name))) (find-file-other-window file-name) (find-file file-name)) @@ -187,24 +316,24 @@ never append to an existing entry." (change-log-mode)) (undo-boundary) (goto-char (point-min)) - (if (looking-at (concat (regexp-quote (substring (current-time-string) - 0 10)) - ".* " (regexp-quote add-log-full-name) - " <" (regexp-quote add-log-mailing-address))) - (forward-line 1) - (insert (current-time-string) - " " add-log-full-name - " <" add-log-mailing-address ">\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)) + (let ((new-entry (concat (funcall add-log-time-format) + " " add-log-full-name + " <" add-log-mailing-address ">"))) + (if (looking-at (regexp-quote new-entry)) + (forward-line 1) + (insert new-entry "\n\n"))) + + (setq bound + (progn + (if (looking-at "\n*[^\n* \t]") + (skip-chars-forward "\n") + (if add-log-keep-changes-together + (forward-page) ; page delimits entries for date + (forward-paragraph))) ; paragraph delimits entries for file + (point))) (goto-char (point-min)) - ;; Now insert the new line for this entry. - (cond ((re-search-forward "^\\s *\\*\\s *$" paragraph-end t) + (cond ((re-search-forward "^\\s *\\*\\s *$" bound t) ;; Put this file name into the existing empty entry. (if entry (insert entry))) @@ -215,7 +344,7 @@ never append to an existing entry." ;; Don't accept `foo.bar' when ;; looking for `foo': "\\(\\s \\|[(),:]\\)") - paragraph-end t))) + bound t))) ;; Add to the existing entry for the same file. (re-search-forward "^\\s *$\\|^\\s \\*") (goto-char (match-beginning 0)) @@ -245,7 +374,7 @@ never append to an existing entry." (undo-boundary) (insert (if (save-excursion (beginning-of-line 1) - (looking-at "\\s *$")) + (looking-at "\\s *$")) "" " ") "(" defun "): ")) @@ -258,9 +387,12 @@ never append to an existing entry." ;;;###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. -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'." +Optional arg WHOAMI (interactive prefix) non-nil means prompt for user +name and site. +Second optional arg FILE-NAME is file name of change log. +If nil, use `change-log-default-name'. + +Affected by the same options as `add-change-log-entry'." (interactive (if current-prefix-arg (list current-prefix-arg (prompt-for-change-log-name)))) @@ -281,15 +413,17 @@ Runs `change-log-mode-hook'." mode-name "Change Log" left-margin 8 fill-column 74 - indent-tabs-mode t - tab-width 8) + indent-tabs-mode t + tab-width 8) (use-local-map change-log-mode-map) - ;; Let each entry behave as one paragraph: - ;; We really do want "^" in paragraph-start below: it is only the lines that - ;; begin at column 0 (despite the left-margin of 8) that we are looking for. - (set (make-local-variable 'paragraph-start) "\\s *$\\|\f\\|^\\sw") - (set (make-local-variable 'paragraph-separate) "\\s *$\\|\f\\|^\\sw") - ;; Let all entries for one day behave as one page. + (set (make-local-variable 'fill-paragraph-function) + 'change-log-fill-paragraph) + ;; We really do want "^" in paragraph-start below: it is only the + ;; lines that begin at column 0 (despite the left-margin of 8) that + ;; we are looking for. Adding `* ' allows eliding the blank line + ;; between entries for different files. + (set (make-local-variable 'paragraph-start) "\\s *$\\|\f\\|^\\<") + (set (make-local-variable 'paragraph-separate) paragraph-start) ;; Match null string on the date-line so that the date-line ;; is grouped with what follows. (set (make-local-variable 'page-delimiter) "^\\<\\|^\f") @@ -307,14 +441,32 @@ Runs `change-log-mode-hook'." "Fill the paragraph, but preserve open parentheses at beginning of lines. Prefix arg means justify as well." (interactive "P") - (let ((end (save-excursion (forward-paragraph) (point))) - (beg (save-excursion (backward-paragraph)(point))) + (let ((end (progn (forward-paragraph) (point))) + (beg (progn (backward-paragraph) (point))) (paragraph-start (concat paragraph-start "\\|\\s *\\s("))) - (fill-region beg end justify))) + (fill-region beg end justify) + t)) -(defvar add-log-current-defun-header-regexp +(defcustom add-log-current-defun-header-regexp "^\\([A-Z][A-Z_ ]*[A-Z_]\\|[-_a-zA-Z]+\\)[ \t]*[:=]" - "*Heuristic regexp used by `add-log-current-defun' for unknown major modes.") + "*Heuristic regexp used by `add-log-current-defun' for unknown major modes." + :type 'regexp + :group 'change-log) + +;;;###autoload +(defvar add-log-lisp-like-modes + '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode) + "*Modes that look like Lisp to `add-log-current-defun'.") + +;;;###autoload +(defvar add-log-c-like-modes + '(c-mode c++-mode c++-c-mode objc-mode) + "*Modes that look like C to `add-log-current-defun'.") + +;;;###autoload +(defvar add-log-tex-like-modes + '(TeX-mode plain-TeX-mode LaTeX-mode plain-tex-mode latex-mode) + "*Modes that look like TeX to `add-log-current-defun'.") ;;;###autoload (defun add-log-current-defun () @@ -332,34 +484,38 @@ 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 - lisp-interaction-mode)) + (cond ((memq major-mode add-log-lisp-like-modes) ;; If we are now precisely at 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 (looking-at "\\s(") - (progn (end-of-defun) - (< location (point))) - (progn (forward-sexp -1) - (>= location (point)))) - (progn - (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 c++-c-mode objc-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]"))) + (when (and (looking-at "\\s(") + (progn (end-of-defun) + (< location (point))) + (progn (forward-sexp -1) + (>= location (point)))) + (if (looking-at "\\s(") + (forward-char 1)) + ;; Skip the defining construct name, typically "defun" + ;; or "defvar". + (forward-sexp 1) + ;; The second element is usually a symbol being defined. + ;; If it is not, use the first symbol in it. + (skip-chars-forward " \t\n'(") + (buffer-substring (point) + (progn (forward-sexp 1) + (point))))) + ((and (memq major-mode add-log-c-like-modes) + (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 @@ -368,7 +524,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 c++-c-mode objc-mode)) + ((memq major-mode add-log-c-like-modes) (beginning-of-line) ;; See if we are in the beginning part of a function, ;; before the open brace. If so, advance forward. @@ -411,7 +567,7 @@ Has a preference of looking backwards." (buffer-substring (point) (progn (forward-sexp 1) (point)))) (if (looking-at "^[+-]") - (get-method-definition) + (change-log-get-method-definition) ;; Ordinary C function syntax. (setq beg (point)) (if (and (condition-case nil @@ -463,10 +619,7 @@ Has a preference of looking backwards." (looking-at "struct \\|union \\|class ") (setq middle (point))) (buffer-substring middle end))))))))) - ((memq major-mode - '(TeX-mode plain-TeX-mode LaTeX-mode;; tex-mode.el - plain-tex-mode latex-mode;; cmutex.el - )) + ((memq major-mode add-log-tex-like-modes) (if (re-search-backward "\\\\\\(sub\\)*\\(section\\|paragraph\\|chapter\\)" nil t) (progn @@ -483,25 +636,31 @@ Has a preference of looking backwards." (if (re-search-backward "^sub[ \t]+\\([^ \t\n]+\\)" nil t) (buffer-substring (match-beginning 1) (match-end 1)))) - ((eq major-mode 'fortran-mode) + ((or (eq major-mode 'fortran-mode) + ;; Needs work for f90, but better than nothing. + (eq major-mode 'f90-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]*\\(program\\|subroutine\\|function\ +\\|[ \ta-z0-9*()]*[ \t]+function\\|\\(block[ \t]*data\\)\\)" + (save-excursion (end-of-fortran-subprogram) + (point)) + t) + (or (match-string 2) + (progn + ;; move to EOL or before first left paren + (if (re-search-forward "[(\n]" nil t) + (progn (backward-char) + (skip-chars-backward " \t")) + (end-of-line)) + ;; Use the name preceding that. + (buffer-substring (point) + (progn (backward-sexp) + (point))))) + "main"))) (t ;; If all else fails, try heuristics (let (case-fold-search) @@ -513,33 +672,33 @@ Has a preference of looking backwards." (match-end 1)))))))) (error nil))) -(defvar get-method-definition-md) +(defvar change-log-get-method-definition-md) -;; Subroutine used within get-method-definition. +;; Subroutine used within change-log-get-method-definition. ;; Add the last match in the buffer to the end of `md', ;; followed by the string END; move to the end of that match. -(defun get-method-definition-1 (end) - (setq get-method-definition-md - (concat get-method-definition-md +(defun change-log-get-method-definition-1 (end) + (setq change-log-get-method-definition-md + (concat change-log-get-method-definition-md (buffer-substring (match-beginning 1) (match-end 1)) end)) (goto-char (match-end 0))) ;; For objective C, return the method name if we are in a method. -(defun get-method-definition () - (let ((get-method-definition-md "[")) +(defun change-log-get-method-definition () + (let ((change-log-get-method-definition-md "[")) (save-excursion (if (re-search-backward "^@implementation\\s-*\\([A-Za-z_]*\\)" nil t) - (get-method-definition-1 " "))) + (change-log-get-method-definition-1 " "))) (save-excursion (cond ((re-search-forward "^\\([-+]\\)[ \t\n\f\r]*\\(([^)]*)\\)?\\s-*" nil t) - (get-method-definition-1 "") + (change-log-get-method-definition-1 "") (while (not (looking-at "[{;]")) (looking-at "\\([A-Za-z_]*:?\\)\\s-*\\(([^)]*)\\)?[A-Za-z_]*[ \t\n\f\r]*") - (get-method-definition-1 "")) - (concat get-method-definition-md "]")))))) + (change-log-get-method-definition-1 "")) + (concat change-log-get-method-definition-md "]")))))) (provide 'add-log)