add-log.el 39.9 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

3
;; Copyright (C) 1985, 1986, 1988, 1993, 1994, 1997, 1998, 2000, 2002,
4
;;   2003, 2004, 2005, 2006 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

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

Eric S. Raymond's avatar
Eric S. Raymond committed
9 10 11 12
;; 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
13
;; the Free Software Foundation; either version 2, or (at your option)
Eric S. Raymond's avatar
Eric S. Raymond committed
14 15 16 17 18 19 20 21
;; 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
22
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Eric S. Raymond's avatar
Eric S. Raymond committed
25

26 27 28 29
;;; Commentary:

;; This facility is documented in the Emacs Manual.

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

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

35
(defgroup change-log nil
36
  "Change log maintenance."
37
  :group 'tools
38
  :link '(custom-manual "(emacs)Change Log")
39 40
  :prefix "change-log-"
  :prefix "add-log-")
Eric S. Raymond's avatar
Eric S. Raymond committed
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)
48 49
(put 'change-log-default-name 'safe-local-variable
     (lambda (a) (or (stringp a) (null a))))
50

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

56 57
;; Many modes set this variable, so avoid warnings.
;;;###autoload
58
(defcustom add-log-current-defun-function nil
Dave Love's avatar
Dave Love committed
59 60 61
  "*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
62
  :type '(choice (const nil) function)
63
  :group 'change-log)
64

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

73
;;;###autoload
74
(defcustom add-log-mailing-address nil
75
  "*Email addresses of user, for inclusion in ChangeLog headers.
76 77 78 79
This defaults to the value of `user-mail-address'.  In addition to
being a simple string, this value can also be a list.  All elements
will be recognized as referring to the same user; when creating a new
ChangeLog entry, one element will be chosen at random."
80
  :type '(choice (const :tag "Default" nil)
81 82
		 (string :tag "String")
		 (repeat :tag "List of Strings" string))
83 84
  :group 'change-log)

85 86 87 88 89 90 91 92 93 94 95
(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)
96

97
(defcustom add-log-keep-changes-together nil
98 99 100 101 102 103 104 105 106 107 108
  "*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
109

110 111
in the latter case, \\[add-change-log-entry-other-window] in a \
buffer visiting `bar', yields:
112

113 114 115
	* bar (...): -!-
	* foo (...): ...
	* bar (...): change 1
116

117
and in the former:
118

119 120 121
	* foo (...): ...
	* bar (...): change 1
	(...): -!-
122

123 124 125
The NEW-ENTRY arg to `add-change-log-entry' can override the effect of
this variable."
  :version "20.3"
126 127 128
  :type 'boolean
  :group 'change-log)

129 130
(defcustom add-log-always-start-new-record nil
  "*If non-nil, `add-change-log-entry' will always start a new record."
131
  :version "22.1"
132 133 134
  :type 'boolean
  :group 'change-log)

135 136 137 138
(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
139
  :type '(choice (const nil) function)
140 141
  :group 'change-log)

142 143
(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
144 145 146
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
147
  :type '(choice (const nil) function)
148 149
  :group 'change-log)

150 151 152 153 154 155 156 157 158 159 160 161 162

(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
163
     (concat "^;+ *Revision: +[^ \t\n]+[ \t]+" re)))
164
  "*List of regexps to search for version number.
Dave Love's avatar
Dave Love committed
165
The version number must be in group 1.
166 167 168 169 170
Note: The search is conducted only within 10%, at the beginning of the file."
  :version "21.1"
  :type '(repeat regexp)
  :group 'change-log)

171
(defface change-log-date
172 173 174 175
  '((t (:inherit font-lock-string-face)))
  "Face used to highlight dates in date lines."
  :version "21.1"
  :group 'change-log)
176 177
;; backward-compatibility alias
(put 'change-log-date-face 'face-alias 'change-log-date)
178

179
(defface change-log-name
180 181 182 183
  '((t (:inherit font-lock-constant-face)))
  "Face for highlighting author names."
  :version "21.1"
  :group 'change-log)
184 185
;; backward-compatibility alias
(put 'change-log-name-face 'face-alias 'change-log-name)
186

187
(defface change-log-email
188 189 190 191
  '((t (:inherit font-lock-variable-name-face)))
  "Face for highlighting author email addresses."
  :version "21.1"
  :group 'change-log)
192 193
;; backward-compatibility alias
(put 'change-log-email-face 'face-alias 'change-log-email)
194

195
(defface change-log-file
196 197 198 199
  '((t (:inherit font-lock-function-name-face)))
  "Face for highlighting file names."
  :version "21.1"
  :group 'change-log)
200 201
;; backward-compatibility alias
(put 'change-log-file-face 'face-alias 'change-log-file)
202

203
(defface change-log-list
204 205 206 207
  '((t (:inherit font-lock-keyword-face)))
  "Face for highlighting parenthesized lists of functions or variables."
  :version "21.1"
  :group 'change-log)
208 209
;; backward-compatibility alias
(put 'change-log-list-face 'face-alias 'change-log-list)
210

211
(defface change-log-conditionals
212 213 214 215
  '((t (:inherit font-lock-variable-name-face)))
  "Face for highlighting conditionals of the form `[...]'."
  :version "21.1"
  :group 'change-log)
216 217
;; backward-compatibility alias
(put 'change-log-conditionals-face 'face-alias 'change-log-conditionals)
218

219
(defface change-log-function
220 221 222 223
  '((t (:inherit font-lock-variable-name-face)))
  "Face for highlighting items of the form `<....>'."
  :version "21.1"
  :group 'change-log)
224 225
;; backward-compatibility alias
(put 'change-log-function-face 'face-alias 'change-log-function)
226

227
(defface change-log-acknowledgement
228 229 230 231
  '((t (:inherit font-lock-comment-face)))
  "Face for highlighting acknowledgments."
  :version "21.1"
  :group 'change-log)
232 233
;; backward-compatibility alias
(put 'change-log-acknowledgement-face 'face-alias 'change-log-acknowledgement)
234

235
(defvar change-log-font-lock-keywords
236
  '(;;
237 238 239 240 241 242 243
    ;; Date lines, new (2000-01-01) and old (Sat Jan  1 00:00:00 2000) styles.
    ;; Fixme: this regepx is just an approximate one and may match
    ;; wrongly with a non-date line existing as a random note.  In
    ;; addition, using any kind of fixed setting like this doesn't
    ;; work if a user customizes add-log-time-format.
    ("^[0-9-]+ +\\|^\\(Sun\\|Mon\\|Tue\\|Wed\\|Thu\\|Fri\\|Sat\\) [A-z][a-z][a-z] [0-9:+ ]+"
     (0 'change-log-date-face)
244
     ;; Name and e-mail; some people put e-mail in parens, not angles.
Juri Linkov's avatar
Juri Linkov committed
245
     ("\\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)[>)]" nil nil
246 247
      (1 'change-log-name)
      (2 'change-log-email)))
248 249
    ;;
    ;; File names.
250
    ("^\\( +\\|\t\\)\\* \\([^ ,:([\n]+\\)"
251
     (2 'change-log-file)
252
     ;; Possibly further names in a list:
253
     ("\\=, \\([^ ,:([\n]+\\)" nil nil (1 'change-log-file))
254
     ;; Possibly a parenthesized list of names:
255
     ("\\= (\\([^(),\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)"
256
      nil nil (1 'change-log-list))
257
     ("\\=, *\\([^(),\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)"
258
      nil nil (1 'change-log-list)))
259 260
    ;;
    ;; Function or variable names.
261
    ("^\\( +\\|\t\\)(\\([^(),\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)"
262
     (2 'change-log-list)
263
     ("\\=, *\\([^(),\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)" nil nil
264
      (1 'change-log-list)))
265 266
    ;;
    ;; Conditionals.
267
    ("\\[!?\\([^]\n]+\\)\\]\\(:\\| (\\)" (1 'change-log-conditionals))
268
    ;;
269
    ;; Function of change.
270
    ("<\\([^>\n]+\\)>\\(:\\| (\\)" (1 'change-log-function))
271
    ;;
Richard M. Stallman's avatar
Richard M. Stallman committed
272
    ;; Acknowledgements.
273 274
    ;; Don't include plain "From" because that is vague;
    ;; we want to encourage people to say something more specific.
Richard M. Stallman's avatar
Richard M. Stallman committed
275 276 277
    ;; Note that the FSF does not use "Patches by"; our convention
    ;; is to put the name of the author of the changes at the top
    ;; of the change log entry.
278
    ("\\(^\\( +\\|\t\\)\\|  \\)\\(Patch\\(es\\)? by\\|Report\\(ed by\\| from\\)\\|Suggest\\(ed by\\|ion from\\)\\)"
279
     3 'change-log-acknowledgement))
280 281
  "Additional expressions to highlight in Change Log mode.")

282 283 284 285 286
(defvar change-log-mode-map
  (let ((map (make-sparse-keymap)))
    (define-key map [?\C-c ?\C-p] 'add-log-edit-prev-comment)
    (define-key map [?\C-c ?\C-n] 'add-log-edit-next-comment)
    map)
Karl Heuer's avatar
Karl Heuer committed
287 288
  "Keymap for Change Log major mode.")

289 290 291 292 293
(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.")

294
(defun add-log-iso8601-time-zone (time)
295 296 297 298 299 300 301 302 303 304 305 306
  (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)))

307 308 309 310 311 312
(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
313
	      (set-time-zone-rule change-log-time-zone-rule)
314 315 316 317 318 319
	      (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
320
(defun change-log-name ()
Dave Love's avatar
Dave Love committed
321
  "Return (system-dependent) default name for a change log file."
Eric S. Raymond's avatar
Eric S. Raymond committed
322
  (or change-log-default-name
323
      (if (eq system-type 'vax-vms)
324 325
	  "$CHANGE_LOG$.TXT"
	"ChangeLog")))
Eric S. Raymond's avatar
Eric S. Raymond committed
326

327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
(defun add-log-edit-prev-comment (arg)
  "Cycle backward through Log-Edit mode comment history.
With a numeric prefix ARG, go back ARG comments."
  (interactive "*p")
  (save-restriction
    (narrow-to-region (point)
		      (if (memq last-command '(add-log-edit-prev-comment
					       add-log-edit-next-comment))
			  (mark) (point)))
    (when (fboundp 'log-edit-previous-comment)
      (log-edit-previous-comment arg)
      (indent-region (point-min) (point-max))
      (goto-char (point-min))
      (unless (save-restriction (widen) (bolp))
	(delete-region (point) (progn (skip-chars-forward " \t\n") (point))))
      (set-mark (point-min))
      (goto-char (point-max))
      (delete-region (point) (progn (skip-chars-backward " \t\n") (point))))))

(defun add-log-edit-next-comment (arg)
  "Cycle forward through Log-Edit mode comment history.
With a numeric prefix ARG, go back ARG comments."
  (interactive "*p")
  (add-log-edit-prev-comment (- arg)))

352
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
353 354
(defun prompt-for-change-log-name ()
  "Prompt for a change log name."
355 356 357 358 359 360 361 362 363 364 365 366 367 368
  (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
369

370
(defun change-log-version-number-search ()
Dave Love's avatar
Dave Love committed
371 372 373
  "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'."
374
  (let* ((size (buffer-size))
375
	 (limit
Dave Love's avatar
Dave Love committed
376 377 378
	  ;; The version number can be anywhere in the file, but
	  ;; restrict search to the file beginning: 10% should be
	  ;; enough to prevent some mishits.
379
	  ;;
Dave Love's avatar
Dave Love committed
380 381
	  ;; Apply percentage only if buffer size is bigger than
	  ;; approx 100 lines.
382
	  (if (> size (* 100 80)) (+ (point) (/ size 10)))))
383
    (or (and buffer-file-name (vc-workfile-version buffer-file-name))
Dave Love's avatar
Dave Love committed
384 385
	(save-restriction
	  (widen)
386 387
	  (let ((regexps change-log-version-number-regexp-list)
		version)
Dave Love's avatar
Dave Love committed
388 389 390
	    (while regexps
	      (save-excursion
		(goto-char (point-min))
391
		(when (re-search-forward (pop regexps) limit t)
Dave Love's avatar
Dave Love committed
392
		  (setq version (match-string 1)
393 394
			regexps nil))))
	    version)))))
395 396


397
;;;###autoload
398
(defun find-change-log (&optional file-name buffer-file)
399
  "Find a change log file for \\[add-change-log-entry] and return the name.
400 401

Optional arg FILE-NAME specifies the file to use.
402
If FILE-NAME is nil, use the value of `change-log-default-name'.
403
If `change-log-default-name' is nil, behave as though it were 'ChangeLog'
404 405
\(or whatever we use on this operating system).

406
If `change-log-default-name' contains a leading directory component, then
407
simply find it in the current directory.  Otherwise, search in the current
408
directory and its successive parents for a file so named.
409 410

Once a file is found, `change-log-default-name' is set locally in the
411 412
current buffer to the complete file name.
Optional arg BUFFER-FILE overrides `buffer-file-name'."
413 414
  ;; If user specified a file name or if this buffer knows which one to use,
  ;; just use that.
415
  (or file-name
416 417 418
      (setq file-name (and change-log-default-name
			   (file-name-directory change-log-default-name)
			   change-log-default-name))
419 420 421
      (progn
	;; Chase links in the source file
	;; and use the change log in the dir where it points.
422
	(setq file-name (or (and (or buffer-file buffer-file-name)
423
				 (file-name-directory
424 425
				  (file-chase-links
				   (or buffer-file buffer-file-name))))
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
			    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.
446
	    (setq file1 (expand-file-name
447 448 449 450 451 452 453 454
			 (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)
455

456 457 458
(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))
459 460 461 462 463 464 465 466 467 468 469 470 471 472
    (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))))
473

Eric S. Raymond's avatar
Eric S. Raymond committed
474
;;;###autoload
475
(defun add-change-log-entry (&optional whoami file-name other-window new-entry)
476
  "Find change log file, and add an entry for today and an item for this file.
477
Optional arg WHOAMI (interactive prefix) non-nil means prompt for user
478
name and email (stored in `add-log-full-name' and `add-log-mailing-address').
479

480 481 482
Second arg FILE-NAME is file name of the change log.
If nil, use the value of `change-log-default-name'.

483
Third arg OTHER-WINDOW non-nil means visit in other window.
484

485
Fourth arg NEW-ENTRY non-nil means always create a new entry at the front;
486 487 488
never append to an existing entry.  Option `add-log-keep-changes-together'
otherwise affects whether a new entry is created.

489 490 491 492
Option `add-log-always-start-new-record' non-nil means always create a
new record, even when the last record was made on the same date and by
the same person.

493 494 495 496
The change log file can start with a copyright notice and a copying
permission notice.  The first blank line indicates the end of these
notices.

497 498
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
499 500
  (interactive (list current-prefix-arg
		     (prompt-for-change-log-name)))
501 502 503
  (let* ((defun (add-log-current-defun))
	 (version (and change-log-version-info-enabled
		       (change-log-version-number-search)))
504 505 506 507
	 (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)))
508
	 (file-name (expand-file-name (find-change-log file-name buffer-file)))
509 510
	 ;; Set ITEM to the file name to use in the new item.
	 (item (add-log-file-name buffer-file file-name))
511 512 513 514 515 516
	 bound
	 (full-name (or add-log-full-name (user-full-name)))
	 (mailing-address (or add-log-mailing-address user-mail-address)))

    (if whoami
	(progn
517
	  (setq full-name (read-string "Full name: " full-name))
518 519 520 521 522
	  ;; 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.
	  (setq mailing-address
523
		(read-string "Mailing address: " mailing-address))))
524

525 526 527 528
    (unless (equal file-name buffer-file-name)
      (if (or other-window (window-dedicated-p (selected-window)))
	  (find-file-other-window file-name)
	(find-file file-name)))
529 530
    (or (eq major-mode 'change-log-mode)
	(change-log-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
531 532
    (undo-boundary)
    (goto-char (point-min))
533 534 535 536 537 538 539 540

    ;; If file starts with a copyright and permission notice, skip them.
    ;; Assume they end at first blank line.
    (when (looking-at "Copyright")
      (search-forward "\n\n")
      (skip-chars-forward "\n"))

    ;; Advance into first entry if it is usable; else make new one.
541 542
    (let ((new-entries (mapcar (lambda (addr)
				 (concat (funcall add-log-time-format)
543
					 "  " full-name
544
					 "  <" addr ">"))
545 546 547
			       (if (consp mailing-address)
				   mailing-address
				 (list mailing-address)))))
548
      (if (and (not add-log-always-start-new-record)
549 550 551 552
               (let ((hit nil))
		 (dolist (entry new-entries hit)
		   (when (looking-at (regexp-quote entry))
		     (setq hit t)))))
553
	  (forward-line 1)
554 555
	(insert (nth (random (length new-entries))
		     new-entries)
556 557
		(if use-hard-newlines hard-newline "\n")
		(if use-hard-newlines hard-newline "\n"))
558
	(forward-line -1)))
559

560 561
    ;; Determine where we should stop searching for a usable
    ;; item to add to, within this entry.
562
    (setq bound
563
	  (save-excursion
564 565 566 567 568 569
            (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)))
570 571

    ;; Now insert the new line for this item.
572
    (cond ((re-search-forward "^\\s *\\*\\s *$" bound t)
573 574 575
	   ;; Put this file name into the existing empty item.
	   (if item
	       (insert item)))
576
	  ((and (not new-entry)
577 578
		(let (case-fold-search)
		  (re-search-forward
579
		   (concat (regexp-quote (concat "* " item))
580 581 582
			   ;; Don't accept `foo.bar' when
			   ;; looking for `foo':
			   "\\(\\s \\|[(),:]\\)")
583
		   bound t)))
584
	   ;; Add to the existing item for the same file.
585
	   (re-search-forward "^\\s *$\\|^\\s \\*")
586
	   (goto-char (match-beginning 0))
587 588
	   ;; Delete excess empty lines; make just 2.
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
Dave Love's avatar
Dave Love committed
589
	     (delete-region (point) (line-beginning-position 2)))
590 591
	   (insert (if use-hard-newlines hard-newline "\n")
		   (if use-hard-newlines hard-newline "\n"))
592 593
	   (forward-line -2)
	   (indent-relative-maybe))
Eric S. Raymond's avatar
Eric S. Raymond committed
594
	  (t
595
	   ;; Make a new item.
Roland McGrath's avatar
Roland McGrath committed
596 597
	   (while (looking-at "\\sW")
	     (forward-line 1))
598
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
Dave Love's avatar
Dave Love committed
599
	     (delete-region (point) (line-beginning-position 2)))
600 601 602
	   (insert (if use-hard-newlines hard-newline "\n")
		   (if use-hard-newlines hard-newline "\n")
		   (if use-hard-newlines hard-newline "\n"))
603
	   (forward-line -2)
Roland McGrath's avatar
Roland McGrath committed
604
	   (indent-to left-margin)
Dave Love's avatar
Dave Love committed
605
	   (insert "* ")
606
	   (if item (insert item))))
607
    ;; Now insert the function name, if we have one.
608
    ;; Point is at the item for this file,
Eric S. Raymond's avatar
Eric S. Raymond committed
609
    ;; either at the end of the line or at the first blank line.
610 611 612 613 614 615
    (if (not defun)
	;; No function name, so put in a colon unless we have just a star.
	(unless (save-excursion
		  (beginning-of-line 1)
		  (looking-at "\\s *\\(\\*\\s *\\)?$"))
	  (insert ": ")
616
	  (if version (insert version ?\s)))
617 618
      ;; Make it easy to get rid of the function name.
      (undo-boundary)
Dave Love's avatar
Dave Love committed
619 620
      (unless (save-excursion
		(beginning-of-line 1)
621
		(looking-at "\\s *$"))
622
	(insert ?\s))
623 624 625 626 627 628
      ;; See if the prev function name has a message yet or not.
      ;; If not, merge the two items.
      (let ((pos (point-marker)))
	(skip-syntax-backward " ")
	(skip-chars-backward "):")
	(if (and (looking-at "):")
629 630 631 632 633 634 635
		 (let ((pos (save-excursion (backward-sexp 1) (point))))
		   (when (equal (buffer-substring pos (point)) defun)
		     (delete-region pos (point)))
		   (> fill-column (+ (current-column) (length defun) 4))))
	    (progn (skip-chars-backward ", ")
		   (delete-region (point) pos)
		   (unless (memq (char-before) '(?\()) (insert ", ")))
636 637 638 639 640 641
	  (if (looking-at "):")
	      (delete-region (+ 1 (point)) (line-end-position)))
	  (goto-char pos)
	  (insert "("))
	(set-marker pos nil))
      (insert defun "): ")
642
      (if version (insert version ?\s)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
643 644 645

;;;###autoload
(defun add-change-log-entry-other-window (&optional whoami file-name)
646 647 648
  "Find change log file in other window and add entry and item.
This is just like `add-change-log-entry' except that it displays
the change log file in another window."
Eric S. Raymond's avatar
Eric S. Raymond committed
649 650 651 652
  (interactive (if current-prefix-arg
		   (list current-prefix-arg
			 (prompt-for-change-log-name))))
  (add-change-log-entry whoami file-name t))
653
;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
Eric S. Raymond's avatar
Eric S. Raymond committed
654

655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
(defvar add-log-indent-text 0)

(defun add-log-indent ()
  (let* ((indent
	  (save-excursion
	    (beginning-of-line)
	    (skip-chars-forward " \t")
	    (cond
	     ((and (looking-at "\\(.*\\)  [^ \n].*[^ \n]  <.*>$")
		   ;; Matching the output of add-log-time-format is difficult,
		   ;; but I'll get it has at least two adjacent digits.
		   (string-match "[[:digit:]][[:digit:]]" (match-string 1)))
	      0)
	     ((looking-at "[^*(]")
	      (+ (current-left-margin) add-log-indent-text))
	     (t (current-left-margin)))))
	 (pos (save-excursion (indent-line-to indent) (point))))
    (if (> pos (point)) (goto-char pos))))


675 676
(defvar smerge-resolve-function)

677
;;;###autoload
678
(define-derived-mode change-log-mode text-mode "Change Log"
679
  "Major mode for editing change logs; like Indented Text Mode.
680
Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
681
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
682
Each entry behaves as a paragraph, and the entries for one day as a page.
683 684
Runs `change-log-mode-hook'.
\\{change-log-mode-map}"
685
  (setq left-margin 8
686
	fill-column 74
687 688 689 690
	indent-tabs-mode t
	tab-width 8)
  (set (make-local-variable 'fill-paragraph-function)
       'change-log-fill-paragraph)
691 692
  (set (make-local-variable 'indent-line-function) 'add-log-indent)
  (set (make-local-variable 'tab-always-indent) nil)
693 694 695 696
  ;; 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.
697
  (set (make-local-variable 'paragraph-start) "\\s *$\\|\f\\|^\\<")
698
  (set (make-local-variable 'paragraph-separate) paragraph-start)
699 700
  ;; Match null string on the date-line so that the date-line
  ;; is grouped with what follows.
701
  (set (make-local-variable 'page-delimiter) "^\\<\\|^\f")
Roland McGrath's avatar
Roland McGrath committed
702
  (set (make-local-variable 'version-control) 'never)
703 704
  (set (make-local-variable 'smerge-resolve-function)
       'change-log-resolve-conflict)
Roland McGrath's avatar
Roland McGrath committed
705
  (set (make-local-variable 'adaptive-fill-regexp) "\\s *")
706
  (set (make-local-variable 'font-lock-defaults)
707
       '(change-log-font-lock-keywords t nil nil backward-paragraph)))
Eric S. Raymond's avatar
Eric S. Raymond committed
708

709 710 711 712 713 714 715 716
;; 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")
717 718
  (let ((end (progn (forward-paragraph) (point)))
	(beg (progn (backward-paragraph) (point)))
719
	(paragraph-start (concat paragraph-start "\\|\\s *\\s(")))
720 721
    (fill-region beg end justify)
    t))
722

723
(defcustom add-log-current-defun-header-regexp
724
  "^\\([[:upper:]][[:upper:]_ ]*[[:upper:]_]\\|[-_[:alpha:]]+\\)[ \t]*[:=]"
725 726 727
  "*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
728

729 730
;;;###autoload
(defvar add-log-lisp-like-modes
731
    '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode)
732 733 734 735 736 737 738 739 740 741 742 743
  "*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'.")

744
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
745 746 747
(defun add-log-current-defun ()
  "Return name of function definition point is in, or nil.

748
Understands C, Lisp, LaTeX (\"functions\" are chapters, sections, ...),
Dave Love's avatar
Dave Love committed
749
Texinfo (@node titles) and Perl.
Eric S. Raymond's avatar
Eric S. Raymond committed
750 751 752

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
753
identifiers followed by `:' or `='.  See variables
Gerd Moellmann's avatar
Gerd Moellmann committed
754
`add-log-current-defun-header-regexp' and
755
`add-log-current-defun-function'.
Eric S. Raymond's avatar
Eric S. Raymond committed
756 757

Has a preference of looking backwards."
758 759 760
  (condition-case nil
      (save-excursion
	(let ((location (point)))
Dave Love's avatar
Dave Love committed
761 762
	  (cond (add-log-current-defun-function
		 (funcall add-log-current-defun-function))
Gerd Moellmann's avatar
Gerd Moellmann committed
763
		((memq major-mode add-log-lisp-like-modes)
764
		 ;; If we are now precisely at the beginning of a defun,
765 766 767 768
		 ;; 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
769 770
		 ;; Make sure we are really inside the defun found,
		 ;; not after it.
771 772 773 774 775 776 777 778 779 780 781 782
		 (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
783
		   (skip-chars-forward " \t\n'(")
Dave Love's avatar
Dave Love committed
784 785 786
		   (buffer-substring-no-properties (point)
						   (progn (forward-sexp 1)
							  (point)))))
787 788 789 790 791 792 793 794 795
		((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]")))
796 797 798 799 800 801
		 ;; 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
802 803 804
		 (buffer-substring-no-properties (point)
						 (progn (forward-sexp 1)
							(point))))
805
		((memq major-mode add-log-c-like-modes)
806 807 808 809 810 811 812
		 (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))
813 814 815 816 817 818 819 820 821
		 (let (maybe-beg)
		   ;; Try to find the containing defun.
		   (beginning-of-defun)
		   (end-of-defun)
		   ;; If the defun we found ends before the desired position,
		   ;; see if there's a DEFUN construct
		   ;; between that end and the desired position.
		   (when (save-excursion
			   (and (> location (point))
822
				(re-search-forward "^DEFUN"
823 824 825 826 827 828 829 830 831 832 833 834
						   (save-excursion
						     (goto-char location)
						     (line-end-position))
						   t)
				(re-search-forward "^{" nil t)
				(setq maybe-beg (point))))
		     ;; If so, go to the end of that instead.
		     (goto-char maybe-beg)
		     (end-of-defun)))
		 ;; If the desired position is within the defun we found,
		 ;; find the function name.
		 (when (< location (point))
835
		   ;; Move back over function body.
Dave Love's avatar
Dave Love committed
836
		   (backward-sexp 1)
837 838 839 840
		   (let (beg)
		     ;; Skip back over typedefs and arglist.
		     ;; Stop at the function definition itself
		     ;; or at the line that follows end of function doc string.
Dave Love's avatar
Dave Love committed
841 842
		     (forward-line -1)
		     (while (and (not (bobp))
843 844
				 (looking-at "[ \t\n]")
				 (not (looking-back "[*]/)\n" (- (point) 4))))
Dave Love's avatar
Dave Love committed
845
		       (forward-line -1))
846 847 848 849 850 851 852 853
		     ;; If we found a doc string, this must be the DEFUN macro
		     ;; used in Emacs.  Move back to the DEFUN line.
		     (when (looking-back "[*]/)\n" (- (point) 4))
		       (backward-sexp 1)
		       (beginning-of-line))
		     ;; Is this a DEFUN construct?  And is LOCATION in it?
		     (if (and (looking-at "DEFUN\\b")
			      (>= location (point)))
854 855
                         ;; DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory, ...) ==> Ffile_name_directory
                         ;; DEFUN(POSIX::STREAM-LOCK, stream lockp &key BLOCK SHARED START LENGTH) ==> POSIX::STREAM-LOCK
Dave Love's avatar
Dave Love committed
856 857
			 (progn
			   (down-list 1)
858 859 860 861
			   (when (= (char-after (point)) ?\")
                             (forward-sexp 1)
                             (search-forward ","))
                           (skip-syntax-forward " ")
Dave Love's avatar
Dave Love committed
862 863
			   (buffer-substring-no-properties
			    (point)
864 865 866
			    (progn (search-forward ",")
                                   (forward-char -1)
                                   (skip-syntax-backward " ")
Dave Love's avatar
Dave Love committed
867 868
				   (point))))
		       (if (looking-at "^[+-]")
869
			   ;; Objective-C
Dave Love's avatar
Dave Love committed
870 871 872 873 874 875 876 877 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
			   (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)
910 911 912 913 914 915 916
			       ;; Is this C++ method?
			       (when (and (< 2 middle)
					  (string= (buffer-substring (- middle 2)
								     middle)
						   "::"))
				 ;; Include "classname::".
				 (setq middle (point)))
Dave Love's avatar
Dave Love committed
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
			       ;; 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))))))))
936
		((memq major-mode add-log-tex-like-modes)
937
		 (if (re-search-backward