add-log.el 32.5 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1
;;; add-log.el --- change log maintenance commands for Emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Dave Love's avatar
Dave Love committed
3
;; Copyright (C) 1985, 86, 88, 93, 94, 97, 98, 2000 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

5
;; Maintainer: FSF
6
;; Keywords: tools
Eric S. Raymond's avatar
Eric S. Raymond committed
7

Eric S. Raymond's avatar
Eric S. Raymond committed
8 9 10 11
;; 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
Eric S. Raymond's avatar
Eric S. Raymond committed
12
;; the Free Software Foundation; either version 2, or (at your option)
Eric S. Raymond's avatar
Eric S. Raymond committed
13 14 15 16 17 18 19 20
;; 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
Erik Naggum's avatar
Erik Naggum committed
21 22 23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Eric S. Raymond's avatar
Eric S. Raymond committed
24

25 26 27 28
;;; Commentary:

;; This facility is documented in the Emacs Manual.

Eric S. Raymond's avatar
Eric S. Raymond committed
29
;;; Code:
Eric S. Raymond's avatar
Eric S. Raymond committed
30

31
(eval-when-compile
Dave Love's avatar
Dave Love committed
32
  (require 'timezone))
33

34 35 36
(defgroup change-log nil
  "Change log maintenance"
  :group 'tools
37
  :link '(custom-manual "(emacs)Change Log")
38 39
  :prefix "change-log-"
  :prefix "add-log-")
Eric S. Raymond's avatar
Eric S. Raymond committed
40

41 42 43 44 45 46 47

(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)

Dave Love's avatar
Dave Love committed
48 49 50 51 52
(defcustom change-log-mode-hook nil
  "Normal hook run by `change-log-mode'."
  :type 'hook
  :group 'change-log)

53
(defcustom add-log-current-defun-function nil
Dave Love's avatar
Dave Love committed
54 55 56
  "*If non-nil, function to guess name of surrounding function.
It is used by `add-log-current-defun' in preference to built-in rules.
Returns function's name as a string, or nil if outside a function."
Dave Love's avatar
Dave Love committed
57
  :type '(choice (const nil) function)
58
  :group 'change-log)
59

60
;;;###autoload
61
(defcustom add-log-full-name nil
62
  "*Full name of user, for inclusion in ChangeLog daily headers.
Dave Love's avatar
Dave Love committed
63
This defaults to the value returned by the function `user-full-name'."
64 65 66
  :type '(choice (const :tag "Default" nil)
		 string)
  :group 'change-log)
67

68
;;;###autoload
69
(defcustom add-log-mailing-address nil
70
  "*Electronic mail address of user, for inclusion in ChangeLog daily headers.
71 72 73 74 75
This defaults to the value of `user-mail-address'."
  :type '(choice (const :tag "Default" nil)
		 string)
  :group 'change-log)

76 77 78 79 80 81 82 83 84 85 86
(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)
87

88
(defcustom add-log-keep-changes-together nil
89 90 91 92 93 94 95 96 97 98 99
  "*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
100

101 102
in the latter case, \\[add-change-log-entry-other-window] in a \
buffer visiting `bar', yields:
103

104 105 106
	* bar (...): -!-
	* foo (...): ...
	* bar (...): change 1
107

108
and in the former:
109

110 111 112
	* foo (...): ...
	* bar (...): change 1
	(...): -!-
113

114 115 116
The NEW-ENTRY arg to `add-change-log-entry' can override the effect of
this variable."
  :version "20.3"
117 118 119
  :type 'boolean
  :group 'change-log)

120 121 122 123
(defcustom add-log-buffer-file-name-function nil
  "*If non-nil, function to call to identify the full filename of a buffer.
This function is called with no argument.  If this is nil, the default is to
use `buffer-file-name'."
Dave Love's avatar
Dave Love committed
124
  :type '(choice (const nil) function)
125 126
  :group 'change-log)

127 128
(defcustom add-log-file-name-function nil
  "*If non-nil, function to call to identify the filename for a ChangeLog entry.
Dave Love's avatar
Dave Love committed
129 130 131
This function is called with one argument, the value of variable
`buffer-file-name' in that buffer.  If this is nil, the default is to
use the file's name relative to the directory of the change log file."
Dave Love's avatar
Dave Love committed
132
  :type '(choice (const nil) function)
133 134
  :group 'change-log)

135 136 137 138 139 140 141 142 143 144 145 146 147

(defcustom change-log-version-info-enabled nil
  "*If non-nil, enable recording version numbers with the changes."
  :version "21.1"
  :type 'boolean
  :group 'change-log)

(defcustom change-log-version-number-regexp-list
  (let ((re    "\\([0-9]+\.[0-9.]+\\)"))
    (list
     ;;  (defconst ad-version "2.15"
     (concat "^(def[^ \t\n]+[ \t]+[^ \t\n][ \t]\"" re)
     ;; Revision: pcl-cvs.el,v 1.72 1999/09/05 20:21:54 monnier Exp
Dave Love's avatar
Dave Love committed
148
     (concat "^;+ *Revision: +[^ \t\n]+[ \t]+" re)))
149
  "*List of regexps to search for version number.
Dave Love's avatar
Dave Love committed
150
The version number must be in group 1.
151 152 153 154 155
Note: The search is conducted only within 10%, at the beginning of the file."
  :version "21.1"
  :type '(repeat regexp)
  :group 'change-log)

156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
(defface change-log-date-face
  '((t (:inherit font-lock-string-face)))
  "Face used to highlight dates in date lines."
  :version "21.1"
  :group 'change-log)

(defface change-log-name-face
  '((t (:inherit font-lock-constant-face)))
  "Face for highlighting author names."
  :version "21.1"
  :group 'change-log)

(defface change-log-email-face
  '((t (:inherit font-lock-variable-name-face)))
  "Face for highlighting author email addresses."
  :version "21.1"
  :group 'change-log)

(defface change-log-file-face
  '((t (:inherit font-lock-function-name-face)))
  "Face for highlighting file names."
  :version "21.1"
  :group 'change-log)

(defface change-log-list-face
  '((t (:inherit font-lock-keyword-face)))
  "Face for highlighting parenthesized lists of functions or variables."
  :version "21.1"
  :group 'change-log)
  
(defface change-log-conditionals-face
  '((t (:inherit font-lock-variable-name-face)))
  "Face for highlighting conditionals of the form `[...]'."
  :version "21.1"
  :group 'change-log)

(defface change-log-function-face
  '((t (:inherit font-lock-variable-name-face)))
  "Face for highlighting items of the form `<....>'."
  :version "21.1"
  :group 'change-log)

(defface change-log-acknowledgement-face
  '((t (:inherit font-lock-comment-face)))
  "Face for highlighting acknowledgments."
  :version "21.1"
  :group 'change-log)
203

204
(defvar change-log-font-lock-keywords
205 206
  '(;;
    ;; Date lines, new and old styles.
207
    ("^\\sw.........[0-9:+ ]*"
208
     (0 'change-log-date-face)
209
     ;; Name and e-mail; some people put e-mail in parens, not angles.
210
     ("\\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.-]+@[A-Za-z0-9_.-]+\\)[>)]" nil nil
211 212
      (1 'change-log-name-face)
      (2 'change-log-email-face)))
213 214 215
    ;;
    ;; File names.
    ("^\t\\* \\([^ ,:([\n]+\\)"
216
     (1 'change-log-file-face)
217
     ;; Possibly further names in a list:
218
     ("\\=, \\([^ ,:([\n]+\\)" nil nil (1 'change-log-file-face))
219
     ;; Possibly a parenthesized list of names:
220 221
     ("\\= (\\([^) ,:\n]+\\)" nil nil (1 'change-log-list-face))
     ("\\=, *\\([^) ,:\n]+\\)" nil nil (1 'change-log-list-face)))
222 223
    ;;
    ;; Function or variable names.
224
    ("^\t(\\([^) ,:\n]+\\)"
225 226
     (1 'change-log-list-face)
     ("\\=, *\\([^) ,:\n]+\\)" nil nil (1 'change-log-list-face)))
227 228
    ;;
    ;; Conditionals.
229
    ("\\[!?\\([^]\n]+\\)\\]\\(:\\| (\\)" (1 'change-log-conditionals-face))
230
    ;;
231
    ;; Function of change.
232
    ("<\\([^>\n]+\\)>\\(:\\| (\\)" (1 'change-log-function-face))
233
    ;;
Richard M. Stallman's avatar
Richard M. Stallman committed
234
    ;; Acknowledgements.
235
    ("\\(^\t\\|  \\)\\(From\\|Patch\\(es\\)? by\\|Report\\(ed by\\| from\\)\\|Suggest\\(ed by\\|ion from\\)\\)"
236
     2 'change-log-acknowledgement-face))
237 238
  "Additional expressions to highlight in Change Log mode.")

Dave Love's avatar
Dave Love committed
239
(defvar change-log-mode-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
240 241
  "Keymap for Change Log major mode.")

242 243 244 245 246
(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.")

247
(defun add-log-iso8601-time-zone (time)
248 249 250 251 252 253 254 255 256 257 258 259
  (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)))

260 261 262 263 264 265
(defun add-log-iso8601-time-string ()
  (if change-log-time-zone-rule
      (let ((tz (getenv "TZ"))
	    (now (current-time)))
	(unwind-protect
	    (progn
Dave Love's avatar
Dave Love committed
266
	      (set-time-zone-rule change-log-time-zone-rule)
267 268 269 270 271 272
	      (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")))

Eric S. Raymond's avatar
Eric S. Raymond committed
273
(defun change-log-name ()
Dave Love's avatar
Dave Love committed
274
  "Return (system-dependent) default name for a change log file."
Eric S. Raymond's avatar
Eric S. Raymond committed
275
  (or change-log-default-name
276
      (if (eq system-type 'vax-vms)
277 278
	  "$CHANGE_LOG$.TXT"
	"ChangeLog")))
Eric S. Raymond's avatar
Eric S. Raymond committed
279

280
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
281 282
(defun prompt-for-change-log-name ()
  "Prompt for a change log name."
283 284 285 286 287 288 289 290 291 292 293 294 295 296
  (let* ((default (change-log-name))
	 (name (expand-file-name
		(read-file-name (format "Log file (default %s): " default)
				nil default))))
    ;; Handle something that is syntactically a directory name.
    ;; Look for ChangeLog or whatever in that directory.
    (if (string= (file-name-nondirectory name) "")
	(expand-file-name (file-name-nondirectory default)
			  name)
      ;; Handle specifying a file that is a directory.
      (if (file-directory-p name)
	  (expand-file-name (file-name-nondirectory default)
			    (file-name-as-directory name))
	name))))
Eric S. Raymond's avatar
Eric S. Raymond committed
297

298
(defun change-log-version-number-search ()
Dave Love's avatar
Dave Love committed
299 300 301
  "Return version number of current buffer's file.
This is the value returned by `vc-workfile-version' or, if that is
nil, by matching `change-log-version-number-regexp-list'."
302 303
  (let* ((size (buffer-size))
	 (end
Dave Love's avatar
Dave Love committed
304 305 306
	  ;; The version number can be anywhere in the file, but
	  ;; restrict search to the file beginning: 10% should be
	  ;; enough to prevent some mishits.
307
	  ;;
Dave Love's avatar
Dave Love committed
308 309
	  ;; Apply percentage only if buffer size is bigger than
	  ;; approx 100 lines.
310
	  (if (> size (* 100 80))
Dave Love's avatar
Dave Love committed
311
	      (/ size 10)
312 313
	    size))
	 version)
314
    (or (and buffer-file-name (vc-workfile-version buffer-file-name))
Dave Love's avatar
Dave Love committed
315 316 317 318 319 320 321 322 323
	(save-restriction
	  (widen)
	  (let ((regexps change-log-version-number-regexp-list))
	    (while regexps
	      (save-excursion
		(goto-char (point-min))
		(when (re-search-forward (pop regexps) end t)
		  (setq version (match-string 1)
			regexps nil)))))))))
324 325


326
;;;###autoload
327
(defun find-change-log (&optional file-name buffer-file)
328
  "Find a change log file for \\[add-change-log-entry] and return the name.
329 330

Optional arg FILE-NAME specifies the file to use.
331 332 333 334 335
If FILE-NAME is nil, use the value of `change-log-default-name'.
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
336
simply find it in the current directory.  Otherwise, search in the current
337
directory and its successive parents for a file so named.
338 339

Once a file is found, `change-log-default-name' is set locally in the
340 341
current buffer to the complete file name.
Optional arg BUFFER-FILE overrides `buffer-file-name'."
342 343
  ;; If user specified a file name or if this buffer knows which one to use,
  ;; just use that.
344
  (or file-name
345 346 347
      (setq file-name (and change-log-default-name
			   (file-name-directory change-log-default-name)
			   change-log-default-name))
348 349 350
      (progn
	;; Chase links in the source file
	;; and use the change log in the dir where it points.
351
	(setq file-name (or (and (or buffer-file buffer-file-name)
352
				 (file-name-directory
353 354
				  (file-chase-links
				   (or buffer-file buffer-file-name))))
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
			    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.
375
	    (setq file1 (expand-file-name
376 377 378 379 380 381 382 383
			 (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)
384

385 386 387
(defun add-log-file-name (buffer-file log-file)
  ;; Never want to add a change log entry for the ChangeLog file itself.
  (unless (or (null buffer-file) (string= buffer-file log-file))
388 389 390 391 392 393 394 395 396 397 398 399 400 401
    (if add-log-file-name-function
	(funcall add-log-file-name-function buffer-file)
      (setq buffer-file
	    (if (string-match
		 (concat "^" (regexp-quote (file-name-directory log-file)))
		 buffer-file)
		(substring buffer-file (match-end 0))
	      (file-name-nondirectory buffer-file)))
      ;; If we have a backup file, it's presumably because we're
      ;; comparing old and new versions (e.g. for deleted
      ;; functions) and we'll want to use the original name.
      (if (backup-file-name-p buffer-file)
	  (file-name-sans-versions buffer-file)
	buffer-file))))
402

Eric S. Raymond's avatar
Eric S. Raymond committed
403
;;;###autoload
404
(defun add-change-log-entry (&optional whoami file-name other-window new-entry)
Eric S. Raymond's avatar
Eric S. Raymond committed
405
  "Find change log file and add an entry for today.
406 407 408 409
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'.
410 411
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;
412 413 414 415 416
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."
Eric S. Raymond's avatar
Eric S. Raymond committed
417 418
  (interactive (list current-prefix-arg
		     (prompt-for-change-log-name)))
419 420 421 422
  (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))
423 424 425
  (if whoami
      (progn
	(setq add-log-full-name (read-input "Full name: " add-log-full-name))
Eric S. Raymond's avatar
Eric S. Raymond committed
426 427 428 429
	 ;; 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.
430 431
	(setq add-log-mailing-address
	      (read-input "Mailing address: " add-log-mailing-address))))
432

433 434 435
  (let* ((defun (add-log-current-defun))
	 (version (and change-log-version-info-enabled
		       (change-log-version-number-search)))
436 437 438 439
	 (buf-file-name (if add-log-buffer-file-name-function
			    (funcall add-log-buffer-file-name-function)
			  buffer-file-name))
	 (buffer-file (if buf-file-name (expand-file-name buf-file-name)))
440 441 442 443 444
	 (file-name (expand-file-name
		     (or file-name (find-change-log file-name buffer-file))))
	 ;; Set ENTRY to the file name to use in the new entry.
	 (entry (add-log-file-name buffer-file file-name))
	 bound)
445 446 447

    (if (or (and other-window (not (equal file-name buffer-file-name)))
	    (window-dedicated-p (selected-window)))
Eric S. Raymond's avatar
Eric S. Raymond committed
448 449
	(find-file-other-window file-name)
      (find-file file-name))
450 451
    (or (eq major-mode 'change-log-mode)
	(change-log-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
452 453
    (undo-boundary)
    (goto-char (point-min))
454
    (let ((new-entry (concat (funcall add-log-time-format)
455 456 457 458 459
			     "  " add-log-full-name
			     "  <" add-log-mailing-address ">")))
      (if (looking-at (regexp-quote new-entry))
	  (forward-line 1)
	(insert new-entry "\n\n")))
460

461 462 463 464 465 466 467 468
    (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)))
Eric S. Raymond's avatar
Eric S. Raymond committed
469
    (goto-char (point-min))
470
    ;; Now insert the new line for this entry.
471
    (cond ((re-search-forward "^\\s *\\*\\s *$" bound t)
472 473
	   ;; Put this file name into the existing empty entry.
	   (if entry
474
	       (insert entry)))
475
	  ((and (not new-entry)
476 477 478 479 480 481
		(let (case-fold-search)
		  (re-search-forward
		   (concat (regexp-quote (concat "* " entry))
			   ;; Don't accept `foo.bar' when
			   ;; looking for `foo':
			   "\\(\\s \\|[(),:]\\)")
482
		   bound t)))
483 484
	   ;; Add to the existing entry for the same file.
	   (re-search-forward "^\\s *$\\|^\\s \\*")
485
	   (goto-char (match-beginning 0))
486 487
	   ;; Delete excess empty lines; make just 2.
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
Dave Love's avatar
Dave Love committed
488
	     (delete-region (point) (line-beginning-position 2)))
Dave Love's avatar
Dave Love committed
489
	   (insert-char ?\n 2)
490 491
	   (forward-line -2)
	   (indent-relative-maybe))
Eric S. Raymond's avatar
Eric S. Raymond committed
492
	  (t
Roland McGrath's avatar
Roland McGrath committed
493 494 495 496
	   ;; Make a new entry.
	   (forward-line 1)
	   (while (looking-at "\\sW")
	     (forward-line 1))
497
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
Dave Love's avatar
Dave Love committed
498
	     (delete-region (point) (line-beginning-position 2)))
Dave Love's avatar
Dave Love committed
499
	   (insert-char ?\n 3)
500
	   (forward-line -2)
Roland McGrath's avatar
Roland McGrath committed
501
	   (indent-to left-margin)
Dave Love's avatar
Dave Love committed
502 503
	   (insert "* ")
	   (if entry (insert entry))))
504
    ;; Now insert the function name, if we have one.
Eric S. Raymond's avatar
Eric S. Raymond committed
505 506 507 508
    ;; Point is at the entry for this file,
    ;; either at the end of the line or at the first blank line.
    (if defun
	(progn
Roland McGrath's avatar
Roland McGrath committed
509
	  ;; Make it easy to get rid of the function name.
Eric S. Raymond's avatar
Eric S. Raymond committed
510
	  (undo-boundary)
Dave Love's avatar
Dave Love committed
511 512 513 514
	  (unless (save-excursion
		    (beginning-of-line 1)
		    (looking-at "\\s *$"))
	    (insert ?\ ))
515 516 517 518 519 520 521 522 523 524 525 526 527 528
	  ;; See if the prev function name has a message yet or not
	  ;; If not, merge the two entries.
	  (let ((pos (point-marker)))
	    (if (and (skip-syntax-backward " ")
		     (skip-chars-backward "):")
		     (looking-at "):")
		     (progn (delete-region (+ 1 (point)) (+ 2 (point))) t)
		     (> fill-column (+ (current-column) (length defun) 3)))
		(progn (delete-region (point) pos)
		       (insert ", "))
	      (goto-char pos)
	      (insert "("))
	    (set-marker pos nil))
	  (insert defun "): ")
Dave Love's avatar
Dave Love committed
529 530
	  (if version
	      (insert version ?\ )))
531
      ;; No function name, so put in a colon unless we have just a star.
Dave Love's avatar
Dave Love committed
532 533 534 535 536
      (unless (save-excursion
		(beginning-of-line 1)
		(looking-at "\\s *\\(\\*\\s *\\)?$"))
	(insert ": ")
	(if version (insert version ?\ ))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
537 538 539 540

;;;###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.
541 542
Optional arg WHOAMI (interactive prefix) non-nil means prompt for user
name and site.
543 544 545 546
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'."
Eric S. Raymond's avatar
Eric S. Raymond committed
547 548 549 550
  (interactive (if current-prefix-arg
		   (list current-prefix-arg
			 (prompt-for-change-log-name))))
  (add-change-log-entry whoami file-name t))
551
;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
Eric S. Raymond's avatar
Eric S. Raymond committed
552

553
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
554
(defun change-log-mode ()
555
  "Major mode for editing change logs; like Indented Text Mode.
556
Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
557
New log entries are usually made with \\[add-change-log-entry] or \\[add-change-log-entry-other-window].
Roland McGrath's avatar
Roland McGrath committed
558 559
Each entry behaves as a paragraph, and the entries for one day as a page.
Runs `change-log-mode-hook'."
Eric S. Raymond's avatar
Eric S. Raymond committed
560 561 562
  (interactive)
  (kill-all-local-variables)
  (indented-text-mode)
563 564 565
  (setq major-mode 'change-log-mode
	mode-name "Change Log"
	left-margin 8
566
	fill-column 74
567 568
	indent-tabs-mode t
	tab-width 8)
Karl Heuer's avatar
Karl Heuer committed
569
  (use-local-map change-log-mode-map)
570 571
  (set (make-local-variable 'fill-paragraph-function)
       'change-log-fill-paragraph)
572 573 574 575
  ;; 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.
576
  (set (make-local-variable 'paragraph-start) "\\s *$\\|\f\\|^\\<")
577
  (set (make-local-variable 'paragraph-separate) paragraph-start)
578 579
  ;; Match null string on the date-line so that the date-line
  ;; is grouped with what follows.
580
  (set (make-local-variable 'page-delimiter) "^\\<\\|^\f")
Roland McGrath's avatar
Roland McGrath committed
581 582
  (set (make-local-variable 'version-control) 'never)
  (set (make-local-variable 'adaptive-fill-regexp) "\\s *")
583
  (set (make-local-variable 'font-lock-defaults)
Dave Love's avatar
Dave Love committed
584
       '(change-log-font-lock-keywords t nil nil backward-paragraph))
Eric S. Raymond's avatar
Eric S. Raymond committed
585 586
  (run-hooks 'change-log-mode-hook))

587 588 589 590 591 592 593 594
;; 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")
595 596
  (let ((end (progn (forward-paragraph) (point)))
	(beg (progn (backward-paragraph) (point)))
597
	(paragraph-start (concat paragraph-start "\\|\\s *\\s(")))
598 599
    (fill-region beg end justify)
    t))
600

601
(defcustom add-log-current-defun-header-regexp
602
  "^\\([[:upper:]][[:upper:]_ ]*[[:upper:]_]\\|[-_[:alpha:]]+\\)[ \t]*[:=]"
603 604 605
  "*Heuristic regexp used by `add-log-current-defun' for unknown major modes."
  :type 'regexp
  :group 'change-log)
Eric S. Raymond's avatar
Eric S. Raymond committed
606

607 608
;;;###autoload
(defvar add-log-lisp-like-modes
609
    '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode)
610 611 612 613 614 615 616 617 618 619 620 621
  "*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'.")

622
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
623 624 625
(defun add-log-current-defun ()
  "Return name of function definition point is in, or nil.

626
Understands C, Lisp, LaTeX (\"functions\" are chapters, sections, ...),
Dave Love's avatar
Dave Love committed
627
Texinfo (@node titles) and Perl.
Eric S. Raymond's avatar
Eric S. Raymond committed
628 629 630

Other modes are handled by a heuristic that looks in the 10K before
point for uppercase headings starting in the first column or
Dave Love's avatar
Dave Love committed
631
identifiers followed by `:' or `='.  See variables
Gerd Moellmann's avatar
Gerd Moellmann committed
632 633
`add-log-current-defun-header-regexp' and
`add-log-current-defun-function'
Eric S. Raymond's avatar
Eric S. Raymond committed
634 635

Has a preference of looking backwards."
636 637 638
  (condition-case nil
      (save-excursion
	(let ((location (point)))
Dave Love's avatar
Dave Love committed
639 640
	  (cond (add-log-current-defun-function
		 (funcall add-log-current-defun-function))
Gerd Moellmann's avatar
Gerd Moellmann committed
641
		((memq major-mode add-log-lisp-like-modes)
642
		 ;; If we are now precisely at the beginning of a defun,
643 644 645 646
		 ;; make sure beginning-of-defun finds that one
		 ;; rather than the previous one.
		 (or (eobp) (forward-char 1))
		 (beginning-of-defun)
Dave Love's avatar
Dave Love committed
647 648
		 ;; Make sure we are really inside the defun found,
		 ;; not after it.
649 650 651 652 653 654 655 656 657 658 659 660
		 (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.
Richard M. Stallman's avatar
Richard M. Stallman committed
661
		   (skip-chars-forward " \t\n'(")
Dave Love's avatar
Dave Love committed
662 663 664
		   (buffer-substring-no-properties (point)
						   (progn (forward-sexp 1)
							  (point)))))
665 666 667 668 669 670 671 672 673
		((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]")))
674 675 676 677 678 679
		 ;; 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")
Dave Love's avatar
Dave Love committed
680 681 682
		 (buffer-substring-no-properties (point)
						 (progn (forward-sexp 1)
							(point))))
683
		((memq major-mode add-log-c-like-modes)
684 685 686 687 688 689 690 691
		 (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)
Dave Love's avatar
Dave Love committed
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
		 (when (progn (end-of-defun)
			      (< location (point)))
		   (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
				    (end-of-line)
				    (while (= (preceding-char) ?\\)
				      (end-of-line 2))
				    (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-no-properties
			    (point)
			    (progn (forward-sexp 1)
				   (point))))
		       (if (looking-at "^[+-]")
			   (change-log-get-method-definition)
			 ;; Ordinary C function syntax.
			 (setq beg (point))
			 (if (and
			      ;; Protect against "Unbalanced parens" error.
			      (condition-case nil
				  (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.
			      (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))
			     (let (end middle)
			       ;; Don't include any final whitespace
			       ;; in the name we use.
			       (skip-chars-backward " \t\n")
			       (setq end (point))
			       (backward-sexp 1)
			       ;; Now find the right beginning of the name.
			       ;; Include certain keywords if they
			       ;; precede the name.
			       (setq middle (point))
			       (forward-word -1)
			       ;; Ignore these subparts of a class decl
			       ;; and move back to the class name itself.
			       (while (looking-at "public \\|private ")
				 (skip-chars-backward " \t:")
				 (setq end (point))
				 (backward-sexp 1)
				 (setq middle (point))
				 (forward-word -1))
			       (and (bolp)
				    (looking-at
				     "enum \\|struct \\|union \\|class ")
				    (setq middle (point)))
			       (goto-char end)
			       (when (eq (preceding-char) ?=)
				 (forward-char -1)
				 (skip-chars-backward " \t")
				 (setq end (point)))
			       (buffer-substring-no-properties
				middle end))))))))
786
		((memq major-mode add-log-tex-like-modes)
787
		 (if (re-search-backward
Dave Love's avatar
Dave Love committed
788 789
		      "\\\\\\(sub\\)*\\(section\\|paragraph\\|chapter\\)"
		      nil t)
790 791
		     (progn
		       (goto-char (match-beginning 0))
Dave Love's avatar
Dave Love committed
792 793 794
		       (buffer-substring-no-properties
			(1+ (point))	; without initial backslash
			(line-end-position)))))
795
		((eq major-mode 'texinfo-mode)
796
		 (if (re-search-backward "^@node[ \t]+\\([^,\n]+\\)" nil t)
Dave Love's avatar
Dave Love committed
797
		     (match-string-no-properties 1)))
798
		((memq major-mode '(perl-mode cperl-mode))
799
		 (if (re-search-backward "^sub[ \t]+\\([^ \t\n]+\\)" nil t)
Dave Love's avatar
Dave Love committed
800 801 802 803 804
		     (match-string-no-properties 1)))
		;; Emacs's autoconf-mode installs its own
		;; `add-log-current-defun-function'.  This applies to
		;; a different mode apparently for editing .m4
		;; autoconf source.
805
                ((eq major-mode 'autoconf-mode)
Dave Love's avatar
Dave Love committed
806 807 808
                 (if (re-search-backward
		      "^\\(\\(m4_\\)?define\\|A._DEFUN\\)(\\[?\\([A-Za-z0-9_]+\\)" nil t)
                     (match-string-no-properties 3)))
809 810
		(t
		 ;; If all else fails, try heuristics
Gerd Moellmann's avatar
Gerd Moellmann committed
811 812
		 (let (case-fold-search
		       result)
813
		   (end-of-line)
Gerd Moellmann's avatar
Gerd Moellmann committed
814 815 816 817
		   (when (re-search-backward
			  add-log-current-defun-header-regexp
			  (- (point) 10000)
			  t)
Dave Love's avatar
Dave Love committed
818 819
		     (setq result (or (match-string-no-properties 1)
				      (match-string-no-properties 0)))
Gerd Moellmann's avatar
Gerd Moellmann committed
820 821 822
		     ;; Strip whitespace away
		     (when (string-match "\\([^ \t\n\r\f].*[^ \t\n\r\f]\\)"
					 result)
Dave Love's avatar
Dave Love committed
823
		       (setq result (match-string-no-properties 1 result)))
Gerd Moellmann's avatar
Gerd Moellmann committed
824
		     result))))))
825
    (error nil)))
Jim Blandy's avatar
Jim Blandy committed
826

827
(defvar change-log-get-method-definition-md)
828

829
;; Subroutine used within change-log-get-method-definition.
830 831
;; Add the last match in the buffer to the end of `md',
;; followed by the string END; move to the end of that match.
832 833 834
(defun change-log-get-method-definition-1 (end)
  (setq change-log-get-method-definition-md
	(concat change-log-get-method-definition-md
Dave Love's avatar
Dave Love committed
835
		(match-string 1)
836
		end))
837 838
  (goto-char (match-end 0)))

839
(defun change-log-get-method-definition ()
Dave Love's avatar
Dave Love committed
840
"For objective C, return the method name if we are in a method."
841
  (let ((change-log-get-method-definition-md "["))
842
    (save-excursion
843
      (if (re-search-backward "^@implementation\\s-*\\([A-Za-z_]*\\)" nil t)
844
	  (change-log-get-method-definition-1 " ")))
845 846
    (save-excursion
      (cond
847
       ((re-search-forward "^\\([-+]\\)[ \t\n\f\r]*\\(([^)]*)\\)?\\s-*" nil t)
848
	(change-log-get-method-definition-1 "")
849 850
	(while (not (looking-at "[{;]"))
	  (looking-at
851
	   "\\([A-Za-z_]*:?\\)\\s-*\\(([^)]*)\\)?[A-Za-z_]*[ \t\n\f\r]*")
852 853
	  (change-log-get-method-definition-1 ""))
	(concat change-log-get-method-definition-md "]"))))))
Dave Love's avatar
Dave Love committed
854 855 856 857 858 859 860 861 862 863 864 865 866 867 868

(defun change-log-sortable-date-at ()
  "Return date of log entry in a consistent form for sorting.
Point is assumed to be at the start of the entry."
  (require 'timezone)
  (if (looking-at "^\\sw.........[0-9:+ ]*")
      (let ((date (match-string-no-properties 0)))
	(if date
	    (if (string-match "\\(....\\)-\\(..\\)-\\(..\\)\\s-+" date)
		(concat (match-string 1 date) (match-string 2 date)
			(match-string 3 date))
	      (condition-case nil
		  (timezone-make-date-sortable date)
		(error nil)))))
    (error "Bad date")))
869

Dave Love's avatar
Dave Love committed
870 871 872 873 874 875
;;;###autoload
(defun change-log-merge (other-log)
  "Merge the contents of ChangeLog file OTHER-LOG with this buffer.
Both must be found in Change Log mode (since the merging depends on
the appropriate motion commands).

Dave Love's avatar
Dave Love committed
876 877
Entries are inserted in chronological order.  Both the current and
old-style time formats for entries are supported."
Dave Love's avatar
Dave Love committed
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909
  (interactive "*fLog file name to merge: ")
  (if (not (eq major-mode 'change-log-mode))
      (error "Not in Change Log mode"))
  (let ((other-buf (find-file-noselect other-log))
	(buf (current-buffer))
	date1 start end)
    (save-excursion
      (goto-char (point-min))
      (set-buffer other-buf)
      (goto-char (point-min))
      (if (not (eq major-mode 'change-log-mode))
	  (error "%s not found in Change Log mode" other-log))
      ;; Loop through all the entries in OTHER-LOG.
      (while (not (eobp))
	(setq date1 (change-log-sortable-date-at))
	(setq start (point)
	      end (progn (forward-page) (point)))
	;; Look for an entry in original buffer that isn't later.
	(with-current-buffer buf
	  (while (and (not (eobp))
		      (string< date1 (change-log-sortable-date-at)))
	    (forward-page))
	  (if (not (eobp))
	      (insert-buffer-substring other-buf start end)
	    ;; At the end of the original buffer, insert a newline to
	    ;; separate entries and then the rest of the file being
	    ;; merged.  Move to the end of it to terminate outer loop.
	    (insert "\n")
	    (insert-buffer-substring other-buf start
				     (with-current-buffer other-buf
				       (goto-char (point-max))
				       (point)))))))))
Jim Blandy's avatar
Jim Blandy committed
910

Dave Love's avatar
Dave Love committed
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
;;;###autoload
(defun change-log-redate ()
  "Fix any old-style date entries in the current log file to default format."
  (interactive)
  (require 'timezone)
  (save-excursion
    (goto-char (point-min))
    (while (re-search-forward "^\\sw.........[0-9:+ ]*" nil t)
      (unless (= 12 (- (match-end 0) (match-beginning 0)))
	(let* ((date (save-match-data
		       (timezone-fix-time (match-string 0) nil nil)))
	       (zone (if (consp (aref date 6))
			 (nth 1 (aref date 6)))))
	  (replace-match (format-time-string
			  "%Y-%m-%d  "
			  (encode-time (aref date 5)
				       (aref date 4)
				       (aref date 3)
				       (aref date 2)
				       (aref date 1)
				       (aref date 0)
				       zone))))))))

934 935
(provide 'add-log)

Eric S. Raymond's avatar
Eric S. Raymond committed
936
;;; add-log.el ends here