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

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1985, 1986, 1988, 1993, 1994, 1997, 1998, 2000, 2001,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2002, 2003, 2004, 2005, 2006, 2007 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
(put 'change-log-default-name 'safe-local-variable 'string-or-null-p)
49

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

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

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

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

84
(defcustom add-log-time-format 'add-log-iso8601-time-string
85
  "Function that defines the time format.
86 87 88 89 90 91 92 93 94
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)
95

96
(defcustom add-log-keep-changes-together nil
97
  "If non-nil, normally keep day's log entries for one file together.
98 99 100 101 102 103 104 105 106 107

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
108

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

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

116
and in the former:
117

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

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

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

134
(defcustom add-log-buffer-file-name-function nil
135
  "If non-nil, function to call to identify the full filename of a buffer.
136 137
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
138
  :type '(choice (const nil) function)
139 140
  :group 'change-log)

141
(defcustom add-log-file-name-function nil
142
  "If non-nil, function to call to identify the filename for a ChangeLog entry.
Dave Love's avatar
Dave Love committed
143 144 145
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
146
  :type '(choice (const nil) function)
147 148
  :group 'change-log)

149 150

(defcustom change-log-version-info-enabled nil
151
  "If non-nil, enable recording version numbers with the changes."
152 153 154 155 156 157 158 159 160 161
  :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
162
     (concat "^;+ *Revision: +[^ \t\n]+[ \t]+" re)))
163
  "List of regexps to search for version number.
Dave Love's avatar
Dave Love committed
164
The version number must be in group 1.
165 166 167 168 169
Note: The search is conducted only within 10%, at the beginning of the file."
  :version "21.1"
  :type '(repeat regexp)
  :group 'change-log)

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

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

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

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

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

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

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

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

234
(defvar change-log-font-lock-keywords
235
  '(;;
236 237 238 239 240 241 242
    ;; 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)
243
     ;; Name and e-mail; some people put e-mail in parens, not angles.
Juri Linkov's avatar
Juri Linkov committed
244
     ("\\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)[>)]" nil nil
245 246
      (1 'change-log-name)
      (2 'change-log-email)))
247 248
    ;;
    ;; File names.
249
    ("^\\( +\\|\t\\)\\* \\([^ ,:([\n]+\\)"
250
     (2 'change-log-file)
251
     ;; Possibly further names in a list:
252
     ("\\=, \\([^ ,:([\n]+\\)" nil nil (1 'change-log-file))
253
     ;; Possibly a parenthesized list of names:
254
     ("\\= (\\([^(),\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)"
255
      nil nil (1 'change-log-list))
256
     ("\\=, *\\([^(),\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)"
257
      nil nil (1 'change-log-list)))
258 259
    ;;
    ;; Function or variable names.
260
    ("^\\( +\\|\t\\)(\\([^(),\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)"
261
     (2 'change-log-list)
262
     ("\\=, *\\([^(),\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)" nil nil
263
      (1 'change-log-list)))
264 265
    ;;
    ;; Conditionals.
266
    ("\\[!?\\([^]\n]+\\)\\]\\(:\\| (\\)" (1 'change-log-conditionals))
267
    ;;
268
    ;; Function of change.
269
    ("<\\([^>\n]+\\)>\\(:\\| (\\)" (1 'change-log-function))
270
    ;;
Richard M. Stallman's avatar
Richard M. Stallman committed
271
    ;; Acknowledgements.
272 273
    ;; 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
274 275 276
    ;; 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.
277
    ("\\(^\\( +\\|\t\\)\\|  \\)\\(Patch\\(es\\)? by\\|Report\\(ed by\\| from\\)\\|Suggest\\(ed by\\|ion from\\)\\)"
278
     3 'change-log-acknowledgement))
279 280
  "Additional expressions to highlight in Change Log mode.")

281 282 283 284 285
(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
286 287
  "Keymap for Change Log major mode.")

288 289 290 291
;; It used to be called change-log-time-zone-rule but really should be
;; called add-log-time-zone-rule since it's only used from add-log-* code.
(defvaralias 'change-log-time-zone-rule 'add-log-time-zone-rule)
(defvar add-log-time-zone-rule nil
292 293
  "Time zone used for calculating change log time stamps.
It takes the same format as the TZ argument of `set-time-zone-rule'.
294 295
If nil, use local time.
If t, use universal time.")
296 297
(put 'add-log-time-zone-rule 'safe-local-variable
     '(lambda (x) (or (booleanp x) (stringp x))))
298

299
(defun add-log-iso8601-time-zone (&optional time)
300 301 302 303 304 305 306 307 308 309 310 311
  (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)))

312 313
(defvar add-log-iso8601-with-time-zone nil)

314
(defun add-log-iso8601-time-string ()
315 316
  (let ((time (format-time-string "%Y-%m-%d"
                                  nil (eq t add-log-time-zone-rule))))
317 318 319
    (if add-log-iso8601-with-time-zone
        (concat time " " (add-log-iso8601-time-zone))
      time)))
320

Eric S. Raymond's avatar
Eric S. Raymond committed
321
(defun change-log-name ()
Dave Love's avatar
Dave Love committed
322
  "Return (system-dependent) default name for a change log file."
Eric S. Raymond's avatar
Eric S. Raymond committed
323
  (or change-log-default-name
324
      (if (eq system-type 'vax-vms)
325 326
	  "$CHANGE_LOG$.TXT"
	"ChangeLog")))
Eric S. Raymond's avatar
Eric S. Raymond committed
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 352
(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)))

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

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


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

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

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

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

457 458 459
(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))
460 461 462
    (if add-log-file-name-function
	(funcall add-log-file-name-function buffer-file)
      (setq buffer-file
463
            (file-relative-name buffer-file (file-name-directory log-file)))
464 465 466 467 468 469
      ;; 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))))
470

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

477 478 479
Second arg FILE-NAME is file name of the change log.
If nil, use the value of `change-log-default-name'.

480
Third arg OTHER-WINDOW non-nil means visit in other window.
481

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

486 487 488 489
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.

490 491 492 493
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.

494
Today's date is calculated according to `add-log-time-zone-rule' if
495
non-nil, otherwise in local time."
Eric S. Raymond's avatar
Eric S. Raymond committed
496 497
  (interactive (list current-prefix-arg
		     (prompt-for-change-log-name)))
498 499 500
  (let* ((defun (add-log-current-defun))
	 (version (and change-log-version-info-enabled
		       (change-log-version-number-search)))
501 502 503 504
	 (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)))
505
	 (file-name (expand-file-name (find-change-log file-name buffer-file)))
506
	 ;; Set ITEM to the file name to use in the new item.
507
	 (item (add-log-file-name buffer-file file-name)))
508

509 510 511 512
    (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)))
513
    (or (derived-mode-p 'change-log-mode)
514
	(change-log-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
515 516
    (undo-boundary)
    (goto-char (point-min))
517

518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
    (let ((full-name (or add-log-full-name (user-full-name)))
          (mailing-address (or add-log-mailing-address user-mail-address)))

      (when whoami
        (setq full-name (read-string "Full name: "
                                     (or add-log-full-name (user-full-name))))
        ;; 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
              (read-string "Mailing address: "
                           (or add-log-mailing-address user-mail-address))))

      ;; 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.
      (let ((new-entries
             (mapcar (lambda (addr)
                       (concat
                        (if (stringp add-log-time-zone-rule)
                            (let ((tz (getenv "TZ")))
                              (unwind-protect
                                  (progn
                                    (set-time-zone-rule add-log-time-zone-rule)
                                    (funcall add-log-time-format))
                                (set-time-zone-rule tz)))
                          (funcall add-log-time-format))
                        "  " full-name
                        "  <" addr ">"))
                     (if (consp mailing-address)
                         mailing-address
                       (list mailing-address)))))
        (if (and (not add-log-always-start-new-record)
                 (let ((hit nil))
                   (dolist (entry new-entries hit)
                     (when (looking-at (regexp-quote entry))
                       (setq hit t)))))
            (forward-line 1)
          (insert (nth (random (length new-entries))
                       new-entries)
                  (if use-hard-newlines hard-newline "\n")
                  (if use-hard-newlines hard-newline "\n"))
          (forward-line -1))))
566

567 568
    ;; Determine where we should stop searching for a usable
    ;; item to add to, within this entry.
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
    (let ((bound
           (save-excursion
             (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))))

      ;; Now insert the new line for this item.
      (cond ((re-search-forward "^\\s *\\*\\s *$" bound t)
             ;; Put this file name into the existing empty item.
             (if item
                 (insert item)))
            ((and (not new-entry)
                  (let (case-fold-search)
                    (re-search-forward
                     (concat (regexp-quote (concat "* " item))
                             ;; Don't accept `foo.bar' when
                             ;; looking for `foo':
                             "\\(\\s \\|[(),:]\\)")
                     bound t)))
             ;; Add to the existing item for the same file.
             (re-search-forward "^\\s *$\\|^\\s \\*")
             (goto-char (match-beginning 0))
             ;; Delete excess empty lines; make just 2.
             (while (and (not (eobp)) (looking-at "^\\s *$"))
               (delete-region (point) (line-beginning-position 2)))
             (insert (if use-hard-newlines hard-newline "\n")
                     (if use-hard-newlines hard-newline "\n"))
             (forward-line -2)
             (indent-relative-maybe))
            (t
             ;; Make a new item.
             (while (looking-at "\\sW")
               (forward-line 1))
             (while (and (not (eobp)) (looking-at "^\\s *$"))
               (delete-region (point) (line-beginning-position 2)))
             (insert (if use-hard-newlines hard-newline "\n")
                     (if use-hard-newlines hard-newline "\n")
                     (if use-hard-newlines hard-newline "\n"))
             (forward-line -2)
             (indent-to left-margin)
             (insert "* ")
             (if item (insert item)))))
614
    ;; Now insert the function name, if we have one.
615
    ;; Point is at the item for this file,
Eric S. Raymond's avatar
Eric S. Raymond committed
616
    ;; either at the end of the line or at the first blank line.
617 618 619 620 621 622
    (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 ": ")
623
	  (if version (insert version ?\s)))
624 625
      ;; Make it easy to get rid of the function name.
      (undo-boundary)
Dave Love's avatar
Dave Love committed
626 627
      (unless (save-excursion
		(beginning-of-line 1)
628
		(looking-at "\\s *$"))
629
	(insert ?\s))
630 631 632 633 634 635
      ;; 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 "):")
636 637 638 639 640 641 642
		 (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 ", ")))
643 644 645 646 647 648
	  (if (looking-at "):")
	      (delete-region (+ 1 (point)) (line-end-position)))
	  (goto-char pos)
	  (insert "("))
	(set-marker pos nil))
      (insert defun "): ")
649
      (if version (insert version ?\s)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
650 651 652

;;;###autoload
(defun add-change-log-entry-other-window (&optional whoami file-name)
653 654 655
  "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
656 657 658 659
  (interactive (if current-prefix-arg
		   (list current-prefix-arg
			 (prompt-for-change-log-name))))
  (add-change-log-entry whoami file-name t))
660
;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
Eric S. Raymond's avatar
Eric S. Raymond committed
661

662
(defvar change-log-indent-text 0)
663

664
(defun change-log-indent ()
665 666 667 668 669
  (let* ((indent
	  (save-excursion
	    (beginning-of-line)
	    (skip-chars-forward " \t")
	    (cond
670
	     ((and (looking-at "\\(.*\\)  [^ \n].*[^ \n]  <.*>\\(?: +(.*)\\)? *$")
671 672 673 674 675
		   ;; 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 "[^*(]")
676
	      (+ (current-left-margin) change-log-indent-text))
677 678 679 680 681
	     (t (current-left-margin)))))
	 (pos (save-excursion (indent-line-to indent) (point))))
    (if (> pos (point)) (goto-char pos))))


682 683
(defvar smerge-resolve-function)

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

722 723 724 725 726 727 728 729
;; 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")
730 731
  (let ((end (progn (forward-paragraph) (point)))
	(beg (progn (backward-paragraph) (point)))
732
	(paragraph-start (concat paragraph-start "\\|\\s *\\s(")))
733 734
    (fill-region beg end justify)
    t))
735

736
(defcustom add-log-current-defun-header-regexp
737
  "^\\([[:upper:]][[:upper:]_ ]*[[:upper:]_]\\|[-_[:alpha:]]+\\)[ \t]*[:=]"
738
  "Heuristic regexp used by `add-log-current-defun' for unknown major modes."
739 740
  :type 'regexp
  :group 'change-log)
Eric S. Raymond's avatar
Eric S. Raymond committed
741

742 743
;;;###autoload
(defvar add-log-lisp-like-modes
744
  '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode)
745 746 747 748
  "*Modes that look like Lisp to `add-log-current-defun'.")

;;;###autoload
(defvar add-log-c-like-modes
749
  '(c-mode c++-mode c++-c-mode objc-mode)
750 751 752 753
  "*Modes that look like C to `add-log-current-defun'.")

;;;###autoload
(defvar add-log-tex-like-modes
754
  '(TeX-mode plain-TeX-mode LaTeX-mode tex-mode)
755 756
  "*Modes that look like TeX to `add-log-current-defun'.")

757
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
758 759 760
(defun add-log-current-defun ()
  "Return name of function definition point is in, or nil.

761
Understands C, Lisp, LaTeX (\"functions\" are chapters, sections, ...),
Dave Love's avatar
Dave Love committed
762
Texinfo (@node titles) and Perl.
Eric S. Raymond's avatar
Eric S. Raymond committed
763 764 765

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
766
identifiers followed by `:' or `='.  See variables
Gerd Moellmann's avatar
Gerd Moellmann committed
767
`add-log-current-defun-header-regexp' and
768
`add-log-current-defun-function'.
Eric S. Raymond's avatar
Eric S. Raymond committed
769 770

Has a preference of looking backwards."
771 772 773
  (condition-case nil
      (save-excursion
	(let ((location (point)))
Dave Love's avatar
Dave Love committed
774 775
	  (cond (add-log-current-defun-function
		 (funcall add-log-current-defun-function))
776
		((apply 'derived-mode-p add-log-lisp-like-modes)
777
		 ;; If we are now precisely at the beginning of a defun,
778 779 780 781
		 ;; 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
782 783
		 ;; Make sure we are really inside the defun found,
		 ;; not after it.
784 785 786 787 788 789 790 791 792 793 794 795
		 (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
796
		   (skip-chars-forward " \t\n'(")
Dave Love's avatar
Dave Love committed
797 798 799
		   (buffer-substring-no-properties (point)
						   (progn (forward-sexp 1)
							  (point)))))
800
		((and (apply 'derived-mode-p add-log-c-like-modes)
801 802 803 804 805 806 807 808
		      (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]")))
809 810 811 812 813 814
		 ;; 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
815 816 817
		 (buffer-substring-no-properties (point)
						 (progn (forward-sexp 1)
							(point))))
818
		((apply 'derived-mode-p add-log-c-like-modes)
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
		 ;; See whether the point is inside a defun.
		 (let (having-previous-defun
		       having-next-defun
		       previous-defun-end
		       next-defun-beginning)
		     
		   (save-excursion
		     (setq having-previous-defun
			   (c-beginning-of-defun))
		     (c-end-of-defun)
		     ;; `c-end-of-defun' moves point to the line after
		     ;; the function close, but the position we prefer
		     ;; here is the position after the final }.
		     (backward-sexp 1)
		     (forward-sexp 1)
834 835 836 837
                     ;; Skip the semicolon ``;'' for
		     ;; enum/union/struct/class definition.
		     (if (= (char-after (point)) ?\;)
			 (forward-char 1))
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
		     (setq previous-defun-end (point)))

		   (save-excursion
		     (setq having-next-defun
			   (c-end-of-defun))
		     (c-beginning-of-defun)
		     (setq next-defun-beginning (point)))

		   (if (and having-next-defun
			    (< location next-defun-beginning))
		       (skip-syntax-forward " "))
		   (if (and having-previous-defun
			    (> location previous-defun-end))
		       (skip-syntax-backward " "))
		   (unless (or
			    ;; When there is no previous defun, the
			    ;; point is not in a defun if it is not at
			    ;; the beginning of the next defun.
			    (and (not having-previous-defun)
				 (not (= (point)
					 next-defun-beginning)))
			    ;; When there is no next defun, the point
			    ;; is not in a defun if it is not at the
			    ;; end of the previous defun.
			    (and (not having-next-defun)
				 (not (= (point)
					 previous-defun-end)))
			    ;; If the point is between two defuns, it
			    ;; is not in a defun.
			    (and (> (point) previous-defun-end)
				 (< (point) next-defun-beginning)))
		     ;; If the point is already at the beginning of a
		     ;; defun, there is no need to move point again.
		     (if (not (= (point) next-defun-beginning))
			 (c-beginning-of-defun))
873 874 875
		     ;; Is this a DEFUN construct?  And is LOCATION in it?
		     (if (and (looking-at "DEFUN\\b")
			      (>= location (point)))
876 877
                         ;; 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
878 879
			 (progn
			   (down-list 1)
880 881 882 883
			   (when (= (char-after (point)) ?\")
                             (forward-sexp 1)
                             (search-forward ","))
                           (skip-syntax-forward " ")
Dave Love's avatar
Dave Love committed
884 885
			   (buffer-substring-no-properties
			    (point)
886 887 888
			    (progn (search-forward ",")
                                   (forward-char -1)
                                   (skip-syntax-backward " ")
Dave Love's avatar
Dave Love committed
889 890
				   (point))))
		       (if (looking-at "^[+-]")
891
			   ;; Objective-C
Dave Love's avatar
Dave Love committed
892 893
			   (change-log-get-method-definition)
			 ;; Ordinary C function syntax.
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
			 (let ((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")
Dave Love's avatar
Dave Love committed
925 926
				 (setq end (point))
				 (backward-sexp 1)
927 928 929
				 ;; Now find the right beginning of the name.
				 ;; Include certain keywords if they
				 ;; precede the name.
Dave Love's avatar
Dave Love committed
930
				 (setq middle (point))
931 932 933
				 ;; We tried calling `forward-sexp' in a loop
				 ;; but it causes inconsistency for C names.
				 (forward-sexp -1)
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
				 ;; Is this C++ method?
				 (when (and (< 2 middle)
					    (string= (buffer-substring (- middle 2)
								       middle)
						     "::"))
				   ;; Include "classname::".
				   (setq middle (point)))
				 ;; 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)))))))))
Stefan Monnier's avatar