add-log.el 35.4 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 71 72 73 74
  "*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."
75
  :type '(choice (const :tag "Default" nil)
76 77
		 (string :tag "String")
		 (repeat :tag "List of Strings" string))
78 79
  :group 'change-log)

80 81 82 83 84 85 86 87 88 89 90
(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)
91

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

105 106
in the latter case, \\[add-change-log-entry-other-window] in a \
buffer visiting `bar', yields:
107

108 109 110
	* bar (...): -!-
	* foo (...): ...
	* bar (...): change 1
111

112
and in the former:
113

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

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

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

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

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

145 146 147 148 149 150 151 152 153 154 155 156 157

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

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

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

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

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

252 253 254 255 256
(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.")

257
(defun add-log-iso8601-time-zone (time)
258 259 260 261 262 263 264 265 266 267 268 269
  (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)))

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

290
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
291 292
(defun prompt-for-change-log-name ()
  "Prompt for a change log name."
293 294 295 296 297 298 299 300 301 302 303 304 305 306
  (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
307

308
(defun change-log-version-number-search ()
Dave Love's avatar
Dave Love committed
309 310 311
  "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'."
312
  (let* ((size (buffer-size))
313
	 (limit
Dave Love's avatar
Dave Love committed
314 315 316
	  ;; The version number can be anywhere in the file, but
	  ;; restrict search to the file beginning: 10% should be
	  ;; enough to prevent some mishits.
317
	  ;;
Dave Love's avatar
Dave Love committed
318 319
	  ;; Apply percentage only if buffer size is bigger than
	  ;; approx 100 lines.
320
	  (if (> size (* 100 80)) (+ (point) (/ size 10)))))
321
    (or (and buffer-file-name (vc-workfile-version buffer-file-name))
Dave Love's avatar
Dave Love committed
322 323
	(save-restriction
	  (widen)
324 325
	  (let ((regexps change-log-version-number-regexp-list)
		version)
Dave Love's avatar
Dave Love committed
326 327 328
	    (while regexps
	      (save-excursion
		(goto-char (point-min))
329
		(when (re-search-forward (pop regexps) limit t)
Dave Love's avatar
Dave Love committed
330
		  (setq version (match-string 1)
331 332
			regexps nil))))
	    version)))))
333 334


335
;;;###autoload
336
(defun find-change-log (&optional file-name buffer-file)
337
  "Find a change log file for \\[add-change-log-entry] and return the name.
338 339

Optional arg FILE-NAME specifies the file to use.
340 341 342 343 344
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
345
simply find it in the current directory.  Otherwise, search in the current
346
directory and its successive parents for a file so named.
347 348

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

394 395 396
(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))
397 398 399 400 401 402 403 404 405 406 407 408 409 410
    (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))))
411

Eric S. Raymond's avatar
Eric S. Raymond committed
412
;;;###autoload
413
(defun add-change-log-entry (&optional whoami file-name other-window new-entry)
414
  "Find change log file, and add an entry for today and an item for this file.
415 416 417
Optional arg WHOAMI (interactive prefix) non-nil means prompt for user
name and site.

418 419 420
Second arg FILE-NAME is file name of the change log.
If nil, use the value of `change-log-default-name'.

421
Third arg OTHER-WINDOW non-nil means visit in other window.
422

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

427 428 429 430
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.

431 432 433 434
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.

435 436
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
437 438
  (interactive (list current-prefix-arg
		     (prompt-for-change-log-name)))
439 440 441 442
  (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))
443 444 445
  (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
446 447 448 449
	 ;; 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.
450 451
	(setq add-log-mailing-address
	      (read-input "Mailing address: " add-log-mailing-address))))
452

453 454 455
  (let* ((defun (add-log-current-defun))
	 (version (and change-log-version-info-enabled
		       (change-log-version-number-search)))
456 457 458 459
	 (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)))
460 461
	 (file-name (expand-file-name
		     (or file-name (find-change-log file-name buffer-file))))
462 463
	 ;; Set ITEM to the file name to use in the new item.
	 (item (add-log-file-name buffer-file file-name))
464
	 bound)
465

466 467 468 469
    (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)))
470 471
    (or (eq major-mode 'change-log-mode)
	(change-log-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
472 473
    (undo-boundary)
    (goto-char (point-min))
474 475 476 477 478 479 480 481

    ;; 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.
482 483 484 485 486 487 488
    (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)))))
489
      (if (and (not add-log-always-start-new-record)
490 491 492 493
               (let ((hit nil))
		 (dolist (entry new-entries hit)
		   (when (looking-at (regexp-quote entry))
		     (setq hit t)))))
494
	  (forward-line 1)
495 496 497
	(insert (nth (random (length new-entries))
		     new-entries)
		"\n\n")
498
	(forward-line -1)))
499

500 501
    ;; Determine where we should stop searching for a usable
    ;; item to add to, within this entry.
502
    (setq bound
503
	  (save-excursion
504 505 506 507 508 509
            (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)))
510 511

    ;; Now insert the new line for this item.
512
    (cond ((re-search-forward "^\\s *\\*\\s *$" bound t)
513 514 515
	   ;; Put this file name into the existing empty item.
	   (if item
	       (insert item)))
516
	  ((and (not new-entry)
517 518
		(let (case-fold-search)
		  (re-search-forward
519
		   (concat (regexp-quote (concat "* " item))
520 521 522
			   ;; Don't accept `foo.bar' when
			   ;; looking for `foo':
			   "\\(\\s \\|[(),:]\\)")
523
		   bound t)))
524
	   ;; Add to the existing item for the same file.
525
	   (re-search-forward "^\\s *$\\|^\\s \\*")
526
	   (goto-char (match-beginning 0))
527 528
	   ;; Delete excess empty lines; make just 2.
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
Dave Love's avatar
Dave Love committed
529
	     (delete-region (point) (line-beginning-position 2)))
Dave Love's avatar
Dave Love committed
530
	   (insert-char ?\n 2)
531 532
	   (forward-line -2)
	   (indent-relative-maybe))
Eric S. Raymond's avatar
Eric S. Raymond committed
533
	  (t
534
	   ;; Make a new item.
Roland McGrath's avatar
Roland McGrath committed
535 536
	   (while (looking-at "\\sW")
	     (forward-line 1))
537
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
Dave Love's avatar
Dave Love committed
538
	     (delete-region (point) (line-beginning-position 2)))
Dave Love's avatar
Dave Love committed
539
	   (insert-char ?\n 3)
540
	   (forward-line -2)
Roland McGrath's avatar
Roland McGrath committed
541
	   (indent-to left-margin)
Dave Love's avatar
Dave Love committed
542
	   (insert "* ")
543
	   (if item (insert item))))
544
    ;; Now insert the function name, if we have one.
545
    ;; Point is at the item for this file,
Eric S. Raymond's avatar
Eric S. Raymond committed
546
    ;; either at the end of the line or at the first blank line.
547 548 549 550 551 552 553 554 555
    (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
556 557
      (unless (save-excursion
		(beginning-of-line 1)
558 559 560 561 562 563 564 565
		(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 "):")
566 567 568 569 570 571 572
		 (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 ", ")))
573 574 575 576 577 578 579
	  (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
580 581 582

;;;###autoload
(defun add-change-log-entry-other-window (&optional whoami file-name)
583 584 585
  "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
586 587 588 589
  (interactive (if current-prefix-arg
		   (list current-prefix-arg
			 (prompt-for-change-log-name))))
  (add-change-log-entry whoami file-name t))
590
;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
Eric S. Raymond's avatar
Eric S. Raymond committed
591

592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
(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))))


612
;;;###autoload
613
(define-derived-mode change-log-mode text-mode "Change Log"
614
  "Major mode for editing change logs; like Indented Text Mode.
615
Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
616
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
617 618
Each entry behaves as a paragraph, and the entries for one day as a page.
Runs `change-log-mode-hook'."
619
  (setq left-margin 8
620
	fill-column 74
621 622 623 624
	indent-tabs-mode t
	tab-width 8)
  (set (make-local-variable 'fill-paragraph-function)
       'change-log-fill-paragraph)
625 626
  (set (make-local-variable 'indent-line-function) 'add-log-indent)
  (set (make-local-variable 'tab-always-indent) nil)
627 628 629 630
  ;; 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.
631
  (set (make-local-variable 'paragraph-start) "\\s *$\\|\f\\|^\\<")
632
  (set (make-local-variable 'paragraph-separate) paragraph-start)
633 634
  ;; Match null string on the date-line so that the date-line
  ;; is grouped with what follows.
635
  (set (make-local-variable 'page-delimiter) "^\\<\\|^\f")
Roland McGrath's avatar
Roland McGrath committed
636
  (set (make-local-variable 'version-control) 'never)
637 638
  (set (make-local-variable 'smerge-resolve-function)
       'change-log-resolve-conflict)
Roland McGrath's avatar
Roland McGrath committed
639
  (set (make-local-variable 'adaptive-fill-regexp) "\\s *")
640
  (set (make-local-variable 'font-lock-defaults)
641
       '(change-log-font-lock-keywords t nil nil backward-paragraph)))
Eric S. Raymond's avatar
Eric S. Raymond committed
642

643 644 645 646 647 648 649 650
;; 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")
651 652
  (let ((end (progn (forward-paragraph) (point)))
	(beg (progn (backward-paragraph) (point)))
653
	(paragraph-start (concat paragraph-start "\\|\\s *\\s(")))
654 655
    (fill-region beg end justify)
    t))
656

657
(defcustom add-log-current-defun-header-regexp
658
  "^\\([[:upper:]][[:upper:]_ ]*[[:upper:]_]\\|[-_[:alpha:]]+\\)[ \t]*[:=]"
659 660 661
  "*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
662

663 664
;;;###autoload
(defvar add-log-lisp-like-modes
665
    '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode)
666 667 668 669 670 671 672 673 674 675 676 677
  "*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'.")

678
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
679 680 681
(defun add-log-current-defun ()
  "Return name of function definition point is in, or nil.

682
Understands C, Lisp, LaTeX (\"functions\" are chapters, sections, ...),
Dave Love's avatar
Dave Love committed
683
Texinfo (@node titles) and Perl.
Eric S. Raymond's avatar
Eric S. Raymond committed
684 685 686

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
687
identifiers followed by `:' or `='.  See variables
Gerd Moellmann's avatar
Gerd Moellmann committed
688
`add-log-current-defun-header-regexp' and
689
`add-log-current-defun-function'.
Eric S. Raymond's avatar
Eric S. Raymond committed
690 691

Has a preference of looking backwards."
692 693 694
  (condition-case nil
      (save-excursion
	(let ((location (point)))
Dave Love's avatar
Dave Love committed
695 696
	  (cond (add-log-current-defun-function
		 (funcall add-log-current-defun-function))
Gerd Moellmann's avatar
Gerd Moellmann committed
697
		((memq major-mode add-log-lisp-like-modes)
698
		 ;; If we are now precisely at the beginning of a defun,
699 700 701 702
		 ;; 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
703 704
		 ;; Make sure we are really inside the defun found,
		 ;; not after it.
705 706 707 708 709 710 711 712 713 714 715 716
		 (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
717
		   (skip-chars-forward " \t\n'(")
Dave Love's avatar
Dave Love committed
718 719 720
		   (buffer-substring-no-properties (point)
						   (progn (forward-sexp 1)
							  (point)))))
721 722 723 724 725 726 727 728 729
		((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]")))
730 731 732 733 734 735
		 ;; 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
736 737 738
		 (buffer-substring-no-properties (point)
						 (progn (forward-sexp 1)
							(point))))
739
		((memq major-mode add-log-c-like-modes)
740 741 742 743 744 745 746 747
		 (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
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 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
		 (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))))))))
842
		((memq major-mode add-log-tex-like-modes)
843
		 (if (re-search-backward
Dave Love's avatar
Dave Love committed
844 845
		      "\\\\\\(sub\\)*\\(section\\|paragraph\\|chapter\\)"
		      nil t)
846 847
		     (progn
		       (goto-char (match-beginning 0))
Dave Love's avatar
Dave Love committed
848 849 850
		       (buffer-substring-no-properties
			(1+ (point))	; without initial backslash
			(line-end-position)))))
851
		((eq major-mode 'texinfo-mode)
852
		 (if (re-search-backward "^@node[ \t]+\\([^,\n]+\\)" nil t)
Dave Love's avatar
Dave Love committed
853
		     (match-string-no-properties 1)))
854
		((memq major-mode '(perl-mode cperl-mode))
855
		 (if (re-search-backward "^sub[ \t]+\\([^({ \t\n]+\\)" nil t)
Dave Love's avatar
Dave Love committed
856 857 858 859 860
		     (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.
861
                ((eq major-mode 'autoconf-mode)
Dave Love's avatar
Dave Love committed
862 863 864
                 (if (re-search-backward
		      "^\\(\\(m4_\\)?define\\|A._DEFUN\\)(\\[?\\([A-Za-z0-9_]+\\)" nil t)
                     (match-string-no-properties 3)))
865 866
		(t
		 ;; If all else fails, try heuristics
Gerd Moellmann's avatar
Gerd Moellmann committed
867 868
		 (let (case-fold-search
		       result)
869
		   (end-of-line)
Gerd Moellmann's avatar
Gerd Moellmann committed
870 871 872 873
		   (when (re-search-backward
			  add-log-current-defun-header-regexp
			  (- (point) 10000)
			  t)
Dave Love's avatar
Dave Love committed
874 875
		     (setq result (or (match-string-no-properties 1)
				      (match-string-no-properties 0)))
Gerd Moellmann's avatar
Gerd Moellmann committed
876 877 878
		     ;; Strip whitespace away
		     (when (string-match "\\([^ \t\n\r\f].*[^ \t\n\r\f]\\)"
					 result)
Dave Love's avatar
Dave Love committed
879
		       (setq result (match-string-no-properties 1 result)))
Gerd Moellmann's avatar
Gerd Moellmann committed
880
		     result))))))
881
    (error nil)))
Jim Blandy's avatar
Jim Blandy committed
882

883
(defvar change-log-get-method-definition-md)
884

885
;; Subroutine used within change-log-get-method-definition.
886 887
;; Add the last match in the buffer to the end of `md',
;; followed by the string END; move to the end of that match.
888 889 890
(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
891
		(match-string 1)
892
		end))
893 894
  (goto-char (match-end 0)))

895
(defun change-log-get-method-definition ()
Dave Love's avatar
Dave Love committed
896
"For objective C, return the method name if we are in a method."
897
  (let ((change-log-get-method-definition-md "["))
898
    (save-excursion
899
      (if (re-search-backward "^@implementation\\s-*\\([A-Za-z_]*\\)" nil t)
900
	  (change-log-get-method-definition-1 " ")))
901 902
    (save-excursion
      (cond
903
       ((re-search-forward "^\\([-+]\\)[ \t\n\f\r]*\\(([^)]*)\\)?\\s-*" nil t)
904
	(change-log-get-method-definition-1 "")
905 906
	(while (not (looking-at "[{;]"))
	  (looking-at
907
	   "\\([A-Za-z_]*:?\\)\\s-*\\(([^)]*)\\)?[A-Za-z_]*[ \t\n\f\r]*")
908 909
	  (change-log-get-method-definition-1 ""))
	(concat change-log-get-method-definition-md "]"))))))
Dave Love's avatar
Dave Love committed
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924

(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")))
925

926 927 928 929 930 931 932 933 934 935 936 937 938 939
(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
940 941 942 943
;;;###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
944 945
the appropriate motion commands).  OTHER-LOG can be either a file name
or a buffer.
Dave Love's avatar
Dave Love committed
946

Dave Love's avatar
Dave Love committed
947 948
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
949 950 951
  (interactive "*fLog file name to merge: ")
  (if (not (eq major-mode 'change-log-mode))
      (error "Not in Change Log mode"))
952 953
  (let ((other-buf (if (bufferp other-log) other-log
		     (find-file-noselect other-log)))
Dave Love's avatar
Dave Love committed
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
	(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
976 977 978 979 980 981 982 983 984 985
	    ;; merged.
	    (unless (or (bobp)
			(and (= ?\n (char-before))
			     (or (<= (1- (point)) (point-min))
				 (= ?\n (char-before (1- (point)))))))
	      (insert "\n"))
	    ;; Move to the end of it to terminate outer loop.
	    (with-current-buffer other-buf
	      (goto-char (point-max)))
	    (insert-buffer-substring other-buf start)))))))
Jim Blandy's avatar
Jim Blandy committed
986

Dave Love's avatar
Dave Love committed
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
;;;###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))))))))

1010 1011
(provide 'add-log)

Eric S. Raymond's avatar
Eric S. Raymond committed