add-log.el 30.6 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
;; Keywords: tools
Eric S. Raymond's avatar
Eric S. Raymond committed
6

Eric S. Raymond's avatar
Eric S. Raymond committed
7 8 9 10
;; 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
11
;; the Free Software Foundation; either version 2, or (at your option)
Eric S. Raymond's avatar
Eric S. Raymond committed
12 13 14 15 16 17 18 19
;; 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
20 21 22
;; 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
23

24 25 26 27
;;; Commentary:

;; This facility is documented in the Emacs Manual.

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

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

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

40 41 42 43 44 45 46

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

52
(defcustom add-log-current-defun-function nil
Dave Love's avatar
Dave Love committed
53 54 55
  "*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."
56
  :type 'function
57
  :group 'change-log)
58

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

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

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

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

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

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

107
and in the former:
108

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

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

119 120
(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
121 122 123
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."
124 125 126
  :type 'function
  :group 'change-log)

127 128 129 130 131 132 133 134 135 136 137 138 139

(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
140
     (concat "^;+ *Revision: +[^ \t\n]+[ \t]+" re)))
141
  "*List of regexps to search for version number.
Dave Love's avatar
Dave Love committed
142
The version number must be in group 1.
143 144 145 146 147 148
Note: The search is conducted only within 10%, at the beginning of the file."
  :version "21.1"
  :type '(repeat regexp)
  :group 'change-log)


149
(defvar change-log-font-lock-keywords
150 151
  '(;;
    ;; Date lines, new and old styles.
152
    ("^\\sw.........[0-9:+ ]*"
153
     (0 font-lock-string-face)
154
     ;; Name and e-mail; some people put e-mail in parens, not angles.
155
     ("\\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.-]+@[A-Za-z0-9_.-]+\\)[>)]" nil nil
156
      (1 font-lock-constant-face)
157
      (2 font-lock-variable-name-face)))
158 159 160 161
    ;;
    ;; File names.
    ("^\t\\* \\([^ ,:([\n]+\\)"
     (1 font-lock-function-name-face)
162 163 164 165 166
     ;; Possibly further names in a list:
     ("\\=, \\([^ ,:([\n]+\\)" nil nil (1 font-lock-function-name-face))
     ;; Possibly a parenthesized list of names:
     ("\\= (\\([^) ,:\n]+\\)" nil nil (1 font-lock-keyword-face))
     ("\\=, *\\([^) ,:\n]+\\)" nil nil (1 font-lock-keyword-face)))
167 168
    ;;
    ;; Function or variable names.
169
    ("^\t(\\([^) ,:\n]+\\)"
170
     (1 font-lock-keyword-face)
171
     ("\\=, *\\([^) ,:\n]+\\)" nil nil (1 font-lock-keyword-face)))
172 173 174 175
    ;;
    ;; Conditionals.
    ("\\[!?\\([^]\n]+\\)\\]\\(:\\| (\\)" (1 font-lock-variable-name-face))
    ;;
176 177 178
    ;; Function of change.
    ("<\\([^>\n]+\\)>\\(:\\| (\\)" (1 font-lock-variable-name-face))
    ;;
Richard M. Stallman's avatar
Richard M. Stallman committed
179
    ;; Acknowledgements.
180 181
    ("\\(^\t\\|  \\)\\(From\\|Patch\\(es\\)? by\\|Report\\(ed by\\| from\\)\\|Suggest\\(ed by\\|ion from\\)\\)"
     2 font-lock-comment-face))
182 183
  "Additional expressions to highlight in Change Log mode.")

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

187 188 189 190 191
(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.")

192
(defun add-log-iso8601-time-zone (time)
193 194 195 196 197 198 199 200 201 202 203 204
  (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)))

205 206 207 208 209 210
(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
211
	      (set-time-zone-rule change-log-time-zone-rule)
212 213 214 215 216 217
	      (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
218
(defun change-log-name ()
Dave Love's avatar
Dave Love committed
219
  "Return (system-dependent) default name for a change log file."
Eric S. Raymond's avatar
Eric S. Raymond committed
220
  (or change-log-default-name
221
      (if (eq system-type 'vax-vms)
222 223
	  "$CHANGE_LOG$.TXT"
	"ChangeLog")))
Eric S. Raymond's avatar
Eric S. Raymond committed
224

225
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
226 227
(defun prompt-for-change-log-name ()
  "Prompt for a change log name."
228 229 230 231 232 233 234 235 236 237 238 239 240 241
  (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
242

243
(defun change-log-version-number-search ()
Dave Love's avatar
Dave Love committed
244 245 246
  "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'."
247 248
  (let* ((size (buffer-size))
	 (end
Dave Love's avatar
Dave Love committed
249 250 251
	  ;; The version number can be anywhere in the file, but
	  ;; restrict search to the file beginning: 10% should be
	  ;; enough to prevent some mishits.
252
	  ;;
Dave Love's avatar
Dave Love committed
253 254
	  ;; Apply percentage only if buffer size is bigger than
	  ;; approx 100 lines.
255
	  (if (> size (* 100 80))
Dave Love's avatar
Dave Love committed
256
	      (/ size 10)
257 258
	    size))
	 version)
Dave Love's avatar
Dave Love committed
259 260 261 262 263 264 265 266 267 268 269
    (or (and buffer-file-name
	     (vc-workfile-version buffer-file-name))
	(save-restriction
	  (widen)
	  (let ((regexps change-log-version-number-regexp-list))
	    (while regexps
	      (save-excursion
		(goto-char (point-min))
		(when (re-search-forward (pop regexps) end t)
		  (setq version (match-string 1)
			regexps nil)))))))))
270 271


272 273 274
;;;###autoload
(defun find-change-log (&optional file-name)
  "Find a change log file for \\[add-change-log-entry] and return the name.
275 276

Optional arg FILE-NAME specifies the file to use.
277 278 279 280 281
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
282
simply find it in the current directory.  Otherwise, search in the current
283
directory and its successive parents for a file so named.
284 285 286

Once a file is found, `change-log-default-name' is set locally in the
current buffer to the complete file name."
287 288
  ;; If user specified a file name or if this buffer knows which one to use,
  ;; just use that.
289
  (or file-name
290 291 292
      (setq file-name (and change-log-default-name
			   (file-name-directory change-log-default-name)
			   change-log-default-name))
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
      (progn
	;; Chase links in the source file
	;; and use the change log in the dir where it points.
	(setq file-name (or (and buffer-file-name
				 (file-name-directory
				  (file-chase-links buffer-file-name)))
			    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.
319
	    (setq file1 (expand-file-name
320 321 322 323 324 325 326 327
			 (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)
328

329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
(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))
    (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)))

Eric S. Raymond's avatar
Eric S. Raymond committed
345
;;;###autoload
346
(defun add-change-log-entry (&optional whoami file-name other-window new-entry)
Eric S. Raymond's avatar
Eric S. Raymond committed
347
  "Find change log file and add an entry for today.
348 349 350 351
Optional arg WHOAMI (interactive prefix) non-nil means prompt for user
name and site.

Second arg is FILE-NAME of change log.  If nil, uses `change-log-default-name'.
352 353
Third arg OTHER-WINDOW non-nil means visit in other window.
Fourth arg NEW-ENTRY non-nil means always create a new entry at the front;
354 355 356 357 358
never append to an existing entry.  Option `add-log-keep-changes-together'
otherwise affects whether a new entry is created.

Today's date is calculated according to `change-log-time-zone-rule' if
non-nil, otherwise in local time."
Eric S. Raymond's avatar
Eric S. Raymond committed
359 360
  (interactive (list current-prefix-arg
		     (prompt-for-change-log-name)))
361 362 363 364
  (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))
365 366 367
  (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
368 369 370 371
	 ;; 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.
372 373
	(setq add-log-mailing-address
	      (read-input "Mailing address: " add-log-mailing-address))))
374 375 376

  (setq file-name (expand-file-name (or file-name (find-change-log file-name))))
  
Dave Love's avatar
Dave Love committed
377
  (let ((defun (add-log-current-defun))
378 379
	(version (and change-log-version-info-enabled
		      (change-log-version-number-search)))
380 381 382 383 384 385 386 387 388
	;; Set ENTRY to the file name to use in the new entry.
	(entry (if buffer-file-name
		   (add-log-file-name buffer-file-name file-name)
		 (if add-log-file-name-function
		     (funcall add-log-file-name-function file-name))))
	bound)

    (if (or (and other-window (not (equal file-name buffer-file-name)))
	    (window-dedicated-p (selected-window)))
Eric S. Raymond's avatar
Eric S. Raymond committed
389 390
	(find-file-other-window file-name)
      (find-file file-name))
391 392
    (or (eq major-mode 'change-log-mode)
	(change-log-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
393 394
    (undo-boundary)
    (goto-char (point-min))
395
    (let ((new-entry (concat (funcall add-log-time-format)
396 397 398 399 400
			     "  " add-log-full-name
			     "  <" add-log-mailing-address ">")))
      (if (looking-at (regexp-quote new-entry))
	  (forward-line 1)
	(insert new-entry "\n\n")))
401

402 403 404 405 406 407 408 409
    (setq bound
	  (progn
            (if (looking-at "\n*[^\n* \t]")
                (skip-chars-forward "\n")
	      (if add-log-keep-changes-together
		  (forward-page)	; page delimits entries for date
		(forward-paragraph)))	; paragraph delimits entries for file
	    (point)))
Eric S. Raymond's avatar
Eric S. Raymond committed
410
    (goto-char (point-min))
411
    ;; Now insert the new line for this entry.
412
    (cond ((re-search-forward "^\\s *\\*\\s *$" bound t)
413 414
	   ;; Put this file name into the existing empty entry.
	   (if entry
415
	       (insert entry)))
416
	  ((and (not new-entry)
417 418 419 420 421 422
		(let (case-fold-search)
		  (re-search-forward
		   (concat (regexp-quote (concat "* " entry))
			   ;; Don't accept `foo.bar' when
			   ;; looking for `foo':
			   "\\(\\s \\|[(),:]\\)")
423
		   bound t)))
424 425
	   ;; Add to the existing entry for the same file.
	   (re-search-forward "^\\s *$\\|^\\s \\*")
426
	   (goto-char (match-beginning 0))
427 428
	   ;; Delete excess empty lines; make just 2.
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
Dave Love's avatar
Dave Love committed
429
	     (delete-region (point) (line-beginning-position 2)))
Dave Love's avatar
Dave Love committed
430
	   (insert-char ?\n 2)
431 432
	   (forward-line -2)
	   (indent-relative-maybe))
Eric S. Raymond's avatar
Eric S. Raymond committed
433
	  (t
Roland McGrath's avatar
Roland McGrath committed
434 435 436 437
	   ;; Make a new entry.
	   (forward-line 1)
	   (while (looking-at "\\sW")
	     (forward-line 1))
438
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
Dave Love's avatar
Dave Love committed
439
	     (delete-region (point) (line-beginning-position 2)))
Dave Love's avatar
Dave Love committed
440
	   (insert-char ?\n 3)
441
	   (forward-line -2)
Roland McGrath's avatar
Roland McGrath committed
442
	   (indent-to left-margin)
Dave Love's avatar
Dave Love committed
443 444
	   (insert "* ")
	   (if entry (insert entry))))
445
    ;; Now insert the function name, if we have one.
Eric S. Raymond's avatar
Eric S. Raymond committed
446 447 448 449
    ;; Point is at the entry for this file,
    ;; either at the end of the line or at the first blank line.
    (if defun
	(progn
Roland McGrath's avatar
Roland McGrath committed
450
	  ;; Make it easy to get rid of the function name.
Eric S. Raymond's avatar
Eric S. Raymond committed
451
	  (undo-boundary)
Dave Love's avatar
Dave Love committed
452 453 454 455
	  (unless (save-excursion
		    (beginning-of-line 1)
		    (looking-at "\\s *$"))
	    (insert ?\ ))
456 457 458 459 460 461 462 463 464 465 466 467 468 469
	  ;; See if the prev function name has a message yet or not
	  ;; If not, merge the two entries.
	  (let ((pos (point-marker)))
	    (if (and (skip-syntax-backward " ")
		     (skip-chars-backward "):")
		     (looking-at "):")
		     (progn (delete-region (+ 1 (point)) (+ 2 (point))) t)
		     (> fill-column (+ (current-column) (length defun) 3)))
		(progn (delete-region (point) pos)
		       (insert ", "))
	      (goto-char pos)
	      (insert "("))
	    (set-marker pos nil))
	  (insert defun "): ")
Dave Love's avatar
Dave Love committed
470 471
	  (if version
	      (insert version ?\ )))
472
      ;; No function name, so put in a colon unless we have just a star.
Dave Love's avatar
Dave Love committed
473 474 475 476 477
      (unless (save-excursion
		(beginning-of-line 1)
		(looking-at "\\s *\\(\\*\\s *\\)?$"))
	(insert ": ")
	(if version (insert version ?\ ))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
478 479 480 481

;;;###autoload
(defun add-change-log-entry-other-window (&optional whoami file-name)
  "Find change log file in other window and add an entry for today.
482 483
Optional arg WHOAMI (interactive prefix) non-nil means prompt for user
name and site.
484 485 486 487
Second optional arg FILE-NAME is file name of change log.
If nil, use `change-log-default-name'.

Affected by the same options as `add-change-log-entry'."
Eric S. Raymond's avatar
Eric S. Raymond committed
488 489 490 491
  (interactive (if current-prefix-arg
		   (list current-prefix-arg
			 (prompt-for-change-log-name))))
  (add-change-log-entry whoami file-name t))
492
;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
Eric S. Raymond's avatar
Eric S. Raymond committed
493

494
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
495
(defun change-log-mode ()
496
  "Major mode for editing change logs; like Indented Text Mode.
497
Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
498
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
499 500
Each entry behaves as a paragraph, and the entries for one day as a page.
Runs `change-log-mode-hook'."
Eric S. Raymond's avatar
Eric S. Raymond committed
501 502 503
  (interactive)
  (kill-all-local-variables)
  (indented-text-mode)
504 505 506
  (setq major-mode 'change-log-mode
	mode-name "Change Log"
	left-margin 8
507
	fill-column 74
508 509
	indent-tabs-mode t
	tab-width 8)
Karl Heuer's avatar
Karl Heuer committed
510
  (use-local-map change-log-mode-map)
511 512
  (set (make-local-variable 'fill-paragraph-function)
       'change-log-fill-paragraph)
513 514 515 516
  ;; 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.
517
  (set (make-local-variable 'paragraph-start) "\\s *$\\|\f\\|^\\<")
518
  (set (make-local-variable 'paragraph-separate) paragraph-start)
519 520
  ;; Match null string on the date-line so that the date-line
  ;; is grouped with what follows.
521
  (set (make-local-variable 'page-delimiter) "^\\<\\|^\f")
Roland McGrath's avatar
Roland McGrath committed
522 523
  (set (make-local-variable 'version-control) 'never)
  (set (make-local-variable 'adaptive-fill-regexp) "\\s *")
524 525
  (set (make-local-variable 'font-lock-defaults)
       '(change-log-font-lock-keywords t))
Eric S. Raymond's avatar
Eric S. Raymond committed
526 527
  (run-hooks 'change-log-mode-hook))

528 529 530 531 532 533 534 535
;; 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")
536 537
  (let ((end (progn (forward-paragraph) (point)))
	(beg (progn (backward-paragraph) (point)))
538
	(paragraph-start (concat paragraph-start "\\|\\s *\\s(")))
539 540
    (fill-region beg end justify)
    t))
541

542
(defcustom add-log-current-defun-header-regexp
543
  "^\\([[:upper:]][[:upper:]_ ]*[[:upper:]_]\\|[-_[:alpha:]]+\\)[ \t]*[:=]"
544 545 546
  "*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
547

548 549
;;;###autoload
(defvar add-log-lisp-like-modes
550
    '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode)
551 552 553 554 555 556 557 558 559 560 561 562
  "*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'.")

563
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
564 565 566
(defun add-log-current-defun ()
  "Return name of function definition point is in, or nil.

567
Understands C, Lisp, LaTeX (\"functions\" are chapters, sections, ...),
Dave Love's avatar
Dave Love committed
568
Texinfo (@node titles) and Perl.
Eric S. Raymond's avatar
Eric S. Raymond committed
569 570 571

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
572
identifiers followed by `:' or `='.  See variables
Gerd Moellmann's avatar
Gerd Moellmann committed
573 574
`add-log-current-defun-header-regexp' and
`add-log-current-defun-function'
Eric S. Raymond's avatar
Eric S. Raymond committed
575 576

Has a preference of looking backwards."
577 578 579
  (condition-case nil
      (save-excursion
	(let ((location (point)))
Dave Love's avatar
Dave Love committed
580 581
	  (cond (add-log-current-defun-function
		 (funcall add-log-current-defun-function))
Gerd Moellmann's avatar
Gerd Moellmann committed
582
		((memq major-mode add-log-lisp-like-modes)
583
		 ;; If we are now precisely at the beginning of a defun,
584 585 586 587
		 ;; 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
588 589
		 ;; Make sure we are really inside the defun found,
		 ;; not after it.
590 591 592 593 594 595 596 597 598 599 600 601
		 (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
602
		   (skip-chars-forward " \t\n'(")
Dave Love's avatar
Dave Love committed
603 604 605
		   (buffer-substring-no-properties (point)
						   (progn (forward-sexp 1)
							  (point)))))
606 607 608 609 610 611 612 613 614
		((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]")))
615 616 617 618 619 620
		 ;; 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
621 622 623
		 (buffer-substring-no-properties (point)
						 (progn (forward-sexp 1)
							(point))))
624
		((memq major-mode add-log-c-like-modes)
625 626 627 628 629 630 631 632
		 (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
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
		 (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))))))))
727
		((memq major-mode add-log-tex-like-modes)
728
		 (if (re-search-backward
Dave Love's avatar
Dave Love committed
729 730
		      "\\\\\\(sub\\)*\\(section\\|paragraph\\|chapter\\)"
		      nil t)
731 732
		     (progn
		       (goto-char (match-beginning 0))
Dave Love's avatar
Dave Love committed
733 734 735
		       (buffer-substring-no-properties
			(1+ (point))	; without initial backslash
			(line-end-position)))))
736
		((eq major-mode 'texinfo-mode)
737
		 (if (re-search-backward "^@node[ \t]+\\([^,\n]+\\)" nil t)
Dave Love's avatar
Dave Love committed
738
		     (match-string-no-properties 1)))
739 740
		((eq major-mode 'perl-mode)
		 (if (re-search-backward "^sub[ \t]+\\([^ \t\n]+\\)" nil t)
Dave Love's avatar
Dave Love committed
741 742 743 744 745
		     (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.
746
                ((eq major-mode 'autoconf-mode)
Dave Love's avatar
Dave Love committed
747 748 749
                 (if (re-search-backward
		      "^\\(\\(m4_\\)?define\\|A._DEFUN\\)(\\[?\\([A-Za-z0-9_]+\\)" nil t)
                     (match-string-no-properties 3)))
750 751
		(t
		 ;; If all else fails, try heuristics
Gerd Moellmann's avatar
Gerd Moellmann committed
752 753
		 (let (case-fold-search
		       result)
754
		   (end-of-line)
Gerd Moellmann's avatar
Gerd Moellmann committed
755 756 757 758
		   (when (re-search-backward
			  add-log-current-defun-header-regexp
			  (- (point) 10000)
			  t)
Dave Love's avatar
Dave Love committed
759 760
		     (setq result (or (match-string-no-properties 1)
				      (match-string-no-properties 0)))
Gerd Moellmann's avatar
Gerd Moellmann committed
761 762 763
		     ;; Strip whitespace away
		     (when (string-match "\\([^ \t\n\r\f].*[^ \t\n\r\f]\\)"
					 result)
Dave Love's avatar
Dave Love committed
764
		       (setq result (match-string-no-properties 1 result)))
Gerd Moellmann's avatar
Gerd Moellmann committed
765
		     result))))))
766
    (error nil)))
Jim Blandy's avatar
Jim Blandy committed
767

768
(defvar change-log-get-method-definition-md)
769

770
;; Subroutine used within change-log-get-method-definition.
771 772
;; Add the last match in the buffer to the end of `md',
;; followed by the string END; move to the end of that match.
773 774 775
(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
776
		(match-string 1)
777
		end))
778 779
  (goto-char (match-end 0)))

780
(defun change-log-get-method-definition ()
Dave Love's avatar
Dave Love committed
781
"For objective C, return the method name if we are in a method."
782
  (let ((change-log-get-method-definition-md "["))
783
    (save-excursion
784
      (if (re-search-backward "^@implementation\\s-*\\([A-Za-z_]*\\)" nil t)
785
	  (change-log-get-method-definition-1 " ")))
786 787
    (save-excursion
      (cond
788
       ((re-search-forward "^\\([-+]\\)[ \t\n\f\r]*\\(([^)]*)\\)?\\s-*" nil t)
789
	(change-log-get-method-definition-1 "")
790 791
	(while (not (looking-at "[{;]"))
	  (looking-at
792
	   "\\([A-Za-z_]*:?\\)\\s-*\\(([^)]*)\\)?[A-Za-z_]*[ \t\n\f\r]*")
793 794
	  (change-log-get-method-definition-1 ""))
	(concat change-log-get-method-definition-md "]"))))))
Dave Love's avatar
Dave Love committed
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809

(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")))
810

Dave Love's avatar
Dave Love committed
811 812 813 814 815 816
;;;###autoload
(defun change-log-merge (other-log)
  "Merge the contents of ChangeLog file OTHER-LOG with this buffer.
Both must be found in Change Log mode (since the merging depends on
the appropriate motion commands).

Dave Love's avatar
Dave Love committed
817 818
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
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
  (interactive "*fLog file name to merge: ")
  (if (not (eq major-mode 'change-log-mode))
      (error "Not in Change Log mode"))
  (let ((other-buf (find-file-noselect other-log))
	(buf (current-buffer))
	date1 start end)
    (save-excursion
      (goto-char (point-min))
      (set-buffer other-buf)
      (goto-char (point-min))
      (if (not (eq major-mode 'change-log-mode))
	  (error "%s not found in Change Log mode" other-log))
      ;; Loop through all the entries in OTHER-LOG.
      (while (not (eobp))
	(setq date1 (change-log-sortable-date-at))
	(setq start (point)
	      end (progn (forward-page) (point)))
	;; Look for an entry in original buffer that isn't later.
	(with-current-buffer buf
	  (while (and (not (eobp))
		      (string< date1 (change-log-sortable-date-at)))
	    (forward-page))
	  (if (not (eobp))
	      (insert-buffer-substring other-buf start end)
	    ;; At the end of the original buffer, insert a newline to
	    ;; separate entries and then the rest of the file being
	    ;; merged.  Move to the end of it to terminate outer loop.
	    (insert "\n")
	    (insert-buffer-substring other-buf start
				     (with-current-buffer other-buf
				       (goto-char (point-max))
				       (point)))))))))
Jim Blandy's avatar
Jim Blandy committed
851

Dave Love's avatar
Dave Love committed
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
;;;###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))))))))

875 876
(provide 'add-log)

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