add-log.el 36.7 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, 86, 88, 93, 94, 97, 98, 2000, 03, 2004
4
;;           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 23 24
;; 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
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 36 37
(defgroup change-log nil
  "Change log maintenance"
  :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 48

(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
49 50 51 52 53
(defcustom change-log-mode-hook nil
  "Normal hook run by `change-log-mode'."
  :type 'hook
  :group 'change-log)

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

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

71
;;;###autoload
72
(defcustom add-log-mailing-address nil
73 74 75 76 77
  "*Electronic mail addresses of user, for inclusion in ChangeLog headers.
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."
78
  :type '(choice (const :tag "Default" nil)
79 80
		 (string :tag "String")
		 (repeat :tag "List of Strings" string))
81 82
  :group 'change-log)

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

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

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

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

115
and in the former:
116

117 118 119
	* foo (...): ...
	* bar (...): change 1
	(...): -!-
120

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

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

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

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

148 149 150 151 152 153 154 155 156 157 158 159 160

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

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

199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
(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)
216

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

252 253 254 255 256
(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
257 258
  "Keymap for Change Log major mode.")

259 260 261 262 263
(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.")

264
(defun add-log-iso8601-time-zone (time)
265 266 267 268 269 270 271 272 273 274 275 276
  (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)))

277 278 279 280 281 282
(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
283
	      (set-time-zone-rule change-log-time-zone-rule)
284 285 286 287 288 289
	      (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
290
(defun change-log-name ()
Dave Love's avatar
Dave Love committed
291
  "Return (system-dependent) default name for a change log file."
Eric S. Raymond's avatar
Eric S. Raymond committed
292
  (or change-log-default-name
293
      (if (eq system-type 'vax-vms)
294 295
	  "$CHANGE_LOG$.TXT"
	"ChangeLog")))
Eric S. Raymond's avatar
Eric S. Raymond committed
296

297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
(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)))

322
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
323 324
(defun prompt-for-change-log-name ()
  "Prompt for a change log name."
325 326 327 328 329 330 331 332 333 334 335 336 337 338
  (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
339

340
(defun change-log-version-number-search ()
Dave Love's avatar
Dave Love committed
341 342 343
  "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'."
344
  (let* ((size (buffer-size))
345
	 (limit
Dave Love's avatar
Dave Love committed
346 347 348
	  ;; The version number can be anywhere in the file, but
	  ;; restrict search to the file beginning: 10% should be
	  ;; enough to prevent some mishits.
349
	  ;;
Dave Love's avatar
Dave Love committed
350 351
	  ;; Apply percentage only if buffer size is bigger than
	  ;; approx 100 lines.
352
	  (if (> size (* 100 80)) (+ (point) (/ size 10)))))
353
    (or (and buffer-file-name (vc-workfile-version buffer-file-name))
Dave Love's avatar
Dave Love committed
354 355
	(save-restriction
	  (widen)
356 357
	  (let ((regexps change-log-version-number-regexp-list)
		version)
Dave Love's avatar
Dave Love committed
358 359 360
	    (while regexps
	      (save-excursion
		(goto-char (point-min))
361
		(when (re-search-forward (pop regexps) limit t)
Dave Love's avatar
Dave Love committed
362
		  (setq version (match-string 1)
363 364
			regexps nil))))
	    version)))))
365 366


367
;;;###autoload
368
(defun find-change-log (&optional file-name buffer-file)
369
  "Find a change log file for \\[add-change-log-entry] and return the name.
370 371

Optional arg FILE-NAME specifies the file to use.
372 373 374 375 376
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
377
simply find it in the current directory.  Otherwise, search in the current
378
directory and its successive parents for a file so named.
379 380

Once a file is found, `change-log-default-name' is set locally in the
381 382
current buffer to the complete file name.
Optional arg BUFFER-FILE overrides `buffer-file-name'."
383 384
  ;; If user specified a file name or if this buffer knows which one to use,
  ;; just use that.
385
  (or file-name
386 387 388
      (setq file-name (and change-log-default-name
			   (file-name-directory change-log-default-name)
			   change-log-default-name))
389 390 391
      (progn
	;; Chase links in the source file
	;; and use the change log in the dir where it points.
392
	(setq file-name (or (and (or buffer-file buffer-file-name)
393
				 (file-name-directory
394 395
				  (file-chase-links
				   (or buffer-file buffer-file-name))))
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
			    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.
416
	    (setq file1 (expand-file-name
417 418 419 420 421 422 423 424
			 (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)
425

426 427 428
(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))
429 430 431 432 433 434 435 436 437 438 439 440 441 442
    (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))))
443

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

450 451 452
Second arg FILE-NAME is file name of the change log.
If nil, use the value of `change-log-default-name'.

453
Third arg OTHER-WINDOW non-nil means visit in other window.
454

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

459 460 461 462
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.

463 464 465 466
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.

467 468
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
469 470
  (interactive (list current-prefix-arg
		     (prompt-for-change-log-name)))
471 472 473 474
  (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))
475 476 477
  (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
478 479 480 481
	 ;; 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.
482 483
	(setq add-log-mailing-address
	      (read-input "Mailing address: " add-log-mailing-address))))
484

485 486 487
  (let* ((defun (add-log-current-defun))
	 (version (and change-log-version-info-enabled
		       (change-log-version-number-search)))
488 489 490 491
	 (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)))
492
	 (file-name (expand-file-name (find-change-log file-name buffer-file)))
493 494
	 ;; Set ITEM to the file name to use in the new item.
	 (item (add-log-file-name buffer-file file-name))
495
	 bound)
496

497 498 499 500
    (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)))
501 502
    (or (eq major-mode 'change-log-mode)
	(change-log-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
503 504
    (undo-boundary)
    (goto-char (point-min))
505 506 507 508 509 510 511 512

    ;; 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.
513 514 515 516 517 518 519
    (let ((new-entries (mapcar (lambda (addr)
				 (concat (funcall add-log-time-format)
					 "  " add-log-full-name
					 "  <" addr ">"))
			       (if (consp add-log-mailing-address)
				   add-log-mailing-address
				 (list add-log-mailing-address)))))
520
      (if (and (not add-log-always-start-new-record)
521 522 523 524
               (let ((hit nil))
		 (dolist (entry new-entries hit)
		   (when (looking-at (regexp-quote entry))
		     (setq hit t)))))
525
	  (forward-line 1)
526 527 528
	(insert (nth (random (length new-entries))
		     new-entries)
		"\n\n")
529
	(forward-line -1)))
530

531 532
    ;; Determine where we should stop searching for a usable
    ;; item to add to, within this entry.
533
    (setq bound
534
	  (save-excursion
535 536 537 538 539 540
            (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)))
541 542

    ;; Now insert the new line for this item.
543
    (cond ((re-search-forward "^\\s *\\*\\s *$" bound t)
544 545 546
	   ;; Put this file name into the existing empty item.
	   (if item
	       (insert item)))
547
	  ((and (not new-entry)
548 549
		(let (case-fold-search)
		  (re-search-forward
550
		   (concat (regexp-quote (concat "* " item))
551 552 553
			   ;; Don't accept `foo.bar' when
			   ;; looking for `foo':
			   "\\(\\s \\|[(),:]\\)")
554
		   bound t)))
555
	   ;; Add to the existing item for the same file.
556
	   (re-search-forward "^\\s *$\\|^\\s \\*")
557
	   (goto-char (match-beginning 0))
558 559
	   ;; Delete excess empty lines; make just 2.
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
Dave Love's avatar
Dave Love committed
560
	     (delete-region (point) (line-beginning-position 2)))
Dave Love's avatar
Dave Love committed
561
	   (insert-char ?\n 2)
562 563
	   (forward-line -2)
	   (indent-relative-maybe))
Eric S. Raymond's avatar
Eric S. Raymond committed
564
	  (t
565
	   ;; Make a new item.
Roland McGrath's avatar
Roland McGrath committed
566 567
	   (while (looking-at "\\sW")
	     (forward-line 1))
568
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
Dave Love's avatar
Dave Love committed
569
	     (delete-region (point) (line-beginning-position 2)))
Dave Love's avatar
Dave Love committed
570
	   (insert-char ?\n 3)
571
	   (forward-line -2)
Roland McGrath's avatar
Roland McGrath committed
572
	   (indent-to left-margin)
Dave Love's avatar
Dave Love committed
573
	   (insert "* ")
574
	   (if item (insert item))))
575
    ;; Now insert the function name, if we have one.
576
    ;; Point is at the item for this file,
Eric S. Raymond's avatar
Eric S. Raymond committed
577
    ;; either at the end of the line or at the first blank line.
578 579 580 581 582 583 584 585 586
    (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 ": ")
	  (if version (insert version ?\ )))
      ;; Make it easy to get rid of the function name.
      (undo-boundary)
Dave Love's avatar
Dave Love committed
587 588
      (unless (save-excursion
		(beginning-of-line 1)
589 590 591 592 593 594 595 596
		(looking-at "\\s *$"))
	(insert ?\ ))
      ;; 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 "):")
597 598 599 600 601 602 603
		 (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 ", ")))
604 605 606 607 608 609 610
	  (if (looking-at "):")
	      (delete-region (+ 1 (point)) (line-end-position)))
	  (goto-char pos)
	  (insert "("))
	(set-marker pos nil))
      (insert defun "): ")
      (if version (insert version ?\ )))))
Eric S. Raymond's avatar
Eric S. Raymond committed
611 612 613

;;;###autoload
(defun add-change-log-entry-other-window (&optional whoami file-name)
614 615 616
  "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
617 618 619 620
  (interactive (if current-prefix-arg
		   (list current-prefix-arg
			 (prompt-for-change-log-name))))
  (add-change-log-entry whoami file-name t))
621
;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
Eric S. Raymond's avatar
Eric S. Raymond committed
622

623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
(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))))


643 644
(defvar smerge-resolve-function)

645
;;;###autoload
646
(define-derived-mode change-log-mode text-mode "Change Log"
647
  "Major mode for editing change logs; like Indented Text Mode.
648
Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
649
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
650
Each entry behaves as a paragraph, and the entries for one day as a page.
651 652
Runs `change-log-mode-hook'.
\\{change-log-mode-map}"
653
  (setq left-margin 8
654
	fill-column 74
655 656 657 658
	indent-tabs-mode t
	tab-width 8)
  (set (make-local-variable 'fill-paragraph-function)
       'change-log-fill-paragraph)
659 660
  (set (make-local-variable 'indent-line-function) 'add-log-indent)
  (set (make-local-variable 'tab-always-indent) nil)
661 662 663 664
  ;; 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.
665
  (set (make-local-variable 'paragraph-start) "\\s *$\\|\f\\|^\\<")
666
  (set (make-local-variable 'paragraph-separate) paragraph-start)
667 668
  ;; Match null string on the date-line so that the date-line
  ;; is grouped with what follows.
669
  (set (make-local-variable 'page-delimiter) "^\\<\\|^\f")
Roland McGrath's avatar
Roland McGrath committed
670
  (set (make-local-variable 'version-control) 'never)
671 672
  (set (make-local-variable 'smerge-resolve-function)
       'change-log-resolve-conflict)
Roland McGrath's avatar
Roland McGrath committed
673
  (set (make-local-variable 'adaptive-fill-regexp) "\\s *")
674
  (set (make-local-variable 'font-lock-defaults)
675
       '(change-log-font-lock-keywords t nil nil backward-paragraph)))
Eric S. Raymond's avatar
Eric S. Raymond committed
676

677 678 679 680 681 682 683 684
;; 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")
685 686
  (let ((end (progn (forward-paragraph) (point)))
	(beg (progn (backward-paragraph) (point)))
687
	(paragraph-start (concat paragraph-start "\\|\\s *\\s(")))
688 689
    (fill-region beg end justify)
    t))
690

691
(defcustom add-log-current-defun-header-regexp
692
  "^\\([[:upper:]][[:upper:]_ ]*[[:upper:]_]\\|[-_[:alpha:]]+\\)[ \t]*[:=]"
693 694 695
  "*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
696

697 698
;;;###autoload
(defvar add-log-lisp-like-modes
699
    '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode)
700 701 702 703 704 705 706 707 708 709 710 711
  "*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'.")

712
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
713 714 715
(defun add-log-current-defun ()
  "Return name of function definition point is in, or nil.

716
Understands C, Lisp, LaTeX (\"functions\" are chapters, sections, ...),
Dave Love's avatar
Dave Love committed
717
Texinfo (@node titles) and Perl.
Eric S. Raymond's avatar
Eric S. Raymond committed
718 719 720

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
721
identifiers followed by `:' or `='.  See variables
Gerd Moellmann's avatar
Gerd Moellmann committed
722
`add-log-current-defun-header-regexp' and
723
`add-log-current-defun-function'.
Eric S. Raymond's avatar
Eric S. Raymond committed
724 725

Has a preference of looking backwards."
726 727 728
  (condition-case nil
      (save-excursion
	(let ((location (point)))
Dave Love's avatar
Dave Love committed
729 730
	  (cond (add-log-current-defun-function
		 (funcall add-log-current-defun-function))
Gerd Moellmann's avatar
Gerd Moellmann committed
731
		((memq major-mode add-log-lisp-like-modes)
732
		 ;; If we are now precisely at the beginning of a defun,
733 734 735 736
		 ;; 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
737 738
		 ;; Make sure we are really inside the defun found,
		 ;; not after it.
739 740 741 742 743 744 745 746 747 748 749 750
		 (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
751
		   (skip-chars-forward " \t\n'(")
Dave Love's avatar
Dave Love committed
752 753 754
		   (buffer-substring-no-properties (point)
						   (progn (forward-sexp 1)
							  (point)))))
755 756 757 758 759 760 761 762 763
		((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]")))
764 765 766 767 768 769
		 ;; 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
770 771 772
		 (buffer-substring-no-properties (point)
						 (progn (forward-sexp 1)
							(point))))
773
		((memq major-mode add-log-c-like-modes)
774 775 776 777 778 779 780 781
		 (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
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875
		 (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))))))))
876
		((memq major-mode add-log-tex-like-modes)
877
		 (if (re-search-backward
Dave Love's avatar
Dave Love committed
878 879
		      "\\\\\\(sub\\)*\\(section\\|paragraph\\|chapter\\)"
		      nil t)
880 881
		     (progn
		       (goto-char (match-beginning 0))
Dave Love's avatar
Dave Love committed
882 883 884
		       (buffer-substring-no-properties
			(1+ (point))	; without initial backslash
			(line-end-position)))))
885
		((eq major-mode 'texinfo-mode)
886
		 (if (re-search-backward "^@node[ \t]+\\([^,\n]+\\)" nil t)
Dave Love's avatar
Dave Love committed
887
		     (match-string-no-properties 1)))
888
		((memq major-mode '(perl-mode cperl-mode))
889
		 (if (re-search-backward "^sub[ \t]+\\([^({ \t\n]+\\)" nil t)
Dave Love's avatar
Dave Love committed
890 891 892 893 894
		     (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.
895
                ((eq major-mode 'autoconf-mode)
Dave Love's avatar
Dave Love committed
896 897 898
                 (if (re-search-backward
		      "^\\(\\(m4_\\)?define\\|A._DEFUN\\)(\\[?\\([A-Za-z0-9_]+\\)" nil t)
                     (match-string-no-properties 3)))
899 900
		(t
		 ;; If all else fails, try heuristics
Gerd Moellmann's avatar
Gerd Moellmann committed
901 902
		 (let (case-fold-search
		       result)
903
		   (end-of-line)
Gerd Moellmann's avatar
Gerd Moellmann committed
904 905 906 907
		   (when (re-search-backward
			  add-log-current-defun-header-regexp
			  (- (point) 10000)
			  t)
Dave Love's avatar
Dave Love committed
908 909
		     (setq result (or (match-string-no-properties 1)
				      (match-string-no-properties 0)))
Gerd Moellmann's avatar
Gerd Moellmann committed
910 911 912
		     ;; Strip whitespace away
		     (when (string-match "\\([^ \t\n\r\f].*[^ \t\n\r\f]\\)"
					 result)
Dave Love's avatar
Dave Love committed
913
		       (setq result (match-string-no-properties 1 result)))
Gerd Moellmann's avatar
Gerd Moellmann committed
914
		     result))))))
915
    (error nil)))
Jim Blandy's avatar
Jim Blandy committed
916

917
(defvar change-log-get-method-definition-md)
918

919
;; Subroutine used within change-log-get-method-definition.
920 921
;; Add the last match in the buffer to the end of `md',
;; followed by the string END; move to the end of that match.
922 923 924
(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
925
		(match-string 1)
926
		end))
927 928
  (goto-char (match-end 0)))

929
(defun change-log-get-method-definition ()
Dave Love's avatar
Dave Love committed
930
"For objective C, return the method name if we are in a method."
931
  (let ((change-log-get-method-definition-md "["))
932
    (save-excursion
933
      (if (re-search-backward "^@implementation\\s-*\\([A-Za-z_]*\\)" nil t)
934
	  (change-log-get-method-definition-1 " ")))
935 936
    (save-excursion
      (cond
937
       ((re-search-forward "^\\([-+]\\)[ \t\n\f\r]*\\(([^)]*)\\)?\\s-*" nil t)
938
	(change-log-get-method-definition-1 "")
939 940
	(while (not (looking-at "[{;]"))
	  (looking-at
941
	   "\\([A-Za-z_]*:?\\)\\s-*\\(([^)]*)\\)?[A-Za-z_]*[ \t\n\f\r]*")
942 943
	  (change-log-get-method-definition-1 ""))
	(concat change-log-get-method-definition-md "]"))))))
Dave Love's avatar
Dave Love committed
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958

(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")))
959

960 961 962 963 964 965 966 967 968 969 970 971 972 973
(defun change-log-resolve-conflict ()
  "Function to be used in `smerge-resolve-function'."
  (let ((buf (current-buffer)))
    (with-temp-buffer
      (insert-buffer-substring buf (match-beginning 1) (match-end 1))
      (save-match-data (change-log-mode))
      (let ((other-buf (current-buffer)))
	(with-current-buffer buf
	  (save-excursion
	    (save-restriction
	      (narrow-to-region (match-beginning 0) (match-end 0))
	      (replace-match (match-string 3) t t)
	      (change-log-merge other-buf))))))))

Dave Love's avatar
Dave Love committed
974 975 976 977
;;;###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
978 979
the appropriate motion commands).  OTHER-LOG can be either a file name
or a buffer.
Dave Love's avatar
Dave Love committed
980

Dave Love's avatar
Dave Love committed
981 982
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
983 984 985
  (interactive "*fLog file name to merge: ")
  (if (not (eq major-mode 'change-log-mode))
      (error "Not in Change Log mode"))
986 987
  (let ((other-buf (if (bufferp other-log) other-log
		     (find-file-noselect other-log)))
Dave Love's avatar
Dave Love committed
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
	(buf (current-buffer))
	date1 start end)
    (save-excursion
      (goto-char (point-min))
      (set-buffer other-buf)