add-log.el 31.1 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, 1998, 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 31
(eval-when-compile
  (require 'fortran)
Dave Love's avatar
Dave Love committed
32
  (require 'timezone)
33
  (require 'cl))
34

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

42 43 44 45 46 47 48

(defcustom change-log-default-name nil
  "*Name of a change log file for \\[add-change-log-entry]."
  :type '(choice (const :tag "default" nil)
		 string)
  :group 'change-log)

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

54
(defcustom add-log-current-defun-function nil
55 56 57
  "\
*If non-nil, function to guess name of current function from surrounding text.
\\[add-change-log-entry] calls this function (if nil, `add-log-current-defun'
58
instead) with no arguments.  It returns a string or nil if it cannot guess."
59
  :type 'function
60
  :group 'change-log)
61

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

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

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

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

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

106 107 108
	* bar (...): -!-
	* foo (...): ...
	* bar (...): change 1
109

110
and in the former:
111

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

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

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

130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153

(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
     (concat "^;+ *Revision: +[^ \t\n]+[ \t]+" re)
     ;; SCCS @(#)igrep.el 2.83
     (concat "SCCS[ \t]+@(#).*[ \t]+" re)
     ))
  "*List of regexps to search for version number.
Note: The search is conducted only within 10%, at the beginning of the file."
  :version "21.1"
  :type '(repeat regexp)
  :group 'change-log)


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

Karl Heuer's avatar
Karl Heuer committed
188 189 190 191 192 193
(defvar change-log-mode-map nil
  "Keymap for Change Log major mode.")
(if change-log-mode-map
    nil
  (setq change-log-mode-map (make-sparse-keymap)))

194 195 196 197 198
(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.")

199
(defun add-log-iso8601-time-zone (time)
200 201 202 203 204 205 206 207 208 209 210 211
  (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)))

212 213 214 215 216 217 218 219 220 221 222 223 224 225
(defun add-log-iso8601-time-string ()
  (if change-log-time-zone-rule
      (let ((tz (getenv "TZ"))
	    (now (current-time)))
	(unwind-protect
	    (progn
	      (set-time-zone-rule
	       change-log-time-zone-rule)
	      (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
226
(defun change-log-name ()
Dave Love's avatar
Dave Love committed
227
  "Return (system-dependent) default name for a change log file."
Eric S. Raymond's avatar
Eric S. Raymond committed
228
  (or change-log-default-name
229
      (if (eq system-type 'vax-vms)
230 231
	  "$CHANGE_LOG$.TXT"
	"ChangeLog")))
Eric S. Raymond's avatar
Eric S. Raymond committed
232

233
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
234 235
(defun prompt-for-change-log-name ()
  "Prompt for a change log name."
236 237 238 239 240 241 242 243 244 245 246 247 248 249
  (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
250

251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
(defun change-log-version-rcs (rcs-string &optional end)
  "Search for plain RCS-STRING from whole buffer up till END.
The surrounding $ characters fro RCS-STRING are added in this function;
provide argument e.g. as \"Id\"."
  (let (str)
    (save-excursion
      (goto-char (point-min))
      (when (re-search-forward
	     (concat "[$]" rcs-string ":[^\n$]+[$]")
	     end t)
	(setq str (match-string 0))
	(when (string-match "[0-9]+\.[0-9.]+" str)
	  (match-string 0 str))))))

(defun change-log-version-number-search ()
  "Return version number for the file by searchin version control tags."
  (let* ((size (buffer-size))
	 (end
	  ;;  The version number can be anywhere in the file, but restrict
	  ;;  search to the file beginning: 10% should be enough to prevent
	  ;;  some mishits.
	  ;;
	  ;;  Apply percentage only if buffer size is bigger than approx 100 lines
	  (if (> size (* 100 80))
	      (/ (* (buffer-size) 10) 100)
	    size))
	 version)

    ;; Search RCS, CVS version strings

    (dolist (choice '("Revision" "Id"))
      (when (setq version (change-log-version-rcs choice end))
	(return)))

    (unless version
      (dolist (regexp change-log-version-number-regexp-list)
	(save-excursion
	  (goto-char (point-min))
	  (when (re-search-forward regexp end t)
	    (setq version (match-string 1))
	    (return)))))

      version
      ))


297 298 299
;;;###autoload
(defun find-change-log (&optional file-name)
  "Find a change log file for \\[add-change-log-entry] and return the name.
300 301

Optional arg FILE-NAME specifies the file to use.
302 303 304 305 306
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
307
simply find it in the current directory.  Otherwise, search in the current
308
directory and its successive parents for a file so named.
309 310 311

Once a file is found, `change-log-default-name' is set locally in the
current buffer to the complete file name."
312 313
  ;; If user specified a file name or if this buffer knows which one to use,
  ;; just use that.
314
  (or file-name
315 316 317
      (setq file-name (and change-log-default-name
			   (file-name-directory change-log-default-name)
			   change-log-default-name))
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
      (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.
344
	    (setq file1 (expand-file-name
345 346 347 348 349 350 351 352
			 (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)
353

Eric S. Raymond's avatar
Eric S. Raymond committed
354
;;;###autoload
355
(defun add-change-log-entry (&optional whoami file-name other-window new-entry)
Eric S. Raymond's avatar
Eric S. Raymond committed
356
  "Find change log file and add an entry for today.
357 358 359 360
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'.
361 362
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;
363 364 365 366 367
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
368 369
  (interactive (list current-prefix-arg
		     (prompt-for-change-log-name)))
370 371 372 373
  (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))
374 375 376
  (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
377 378 379 380
	 ;; 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.
381 382 383 384
	(setq add-log-mailing-address
	      (read-input "Mailing address: " add-log-mailing-address))))
  (let ((defun (funcall (or add-log-current-defun-function
			    'add-log-current-defun)))
385 386 387 388
	(version (and change-log-version-info-enabled
		      (change-log-version-number-search)))
	bound
	entry)
389

390
    (setq file-name (expand-file-name (find-change-log file-name)))
391 392 393 394 395

    ;; Set ENTRY to the file name to use in the new entry.
    (and buffer-file-name
	 ;; Never want to add a change log entry for the ChangeLog file itself.
	 (not (string= buffer-file-name file-name))
Dave Love's avatar
Dave Love committed
396 397 398 399
	 (if add-log-file-name-function
	     (setq entry
		   (funcall add-log-file-name-function buffer-file-name))
	   (setq entry
400 401 402 403 404
		 (if (string-match
		      (concat "^" (regexp-quote (file-name-directory
						 file-name)))
		      buffer-file-name)
		     (substring buffer-file-name (match-end 0))
Dave Love's avatar
Dave Love committed
405 406 407 408 409 410
		   (file-name-nondirectory buffer-file-name)))
	   ;; 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 entry)
	       (setq entry (file-name-sans-versions entry)))))
411

Eric S. Raymond's avatar
Eric S. Raymond committed
412 413 414
    (if (and other-window (not (equal file-name buffer-file-name)))
	(find-file-other-window file-name)
      (find-file file-name))
415 416
    (or (eq major-mode 'change-log-mode)
	(change-log-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
417 418
    (undo-boundary)
    (goto-char (point-min))
419
    (let ((new-entry (concat (funcall add-log-time-format)
420 421 422 423 424
			     "  " add-log-full-name
			     "  <" add-log-mailing-address ">")))
      (if (looking-at (regexp-quote new-entry))
	  (forward-line 1)
	(insert new-entry "\n\n")))
425

426 427 428 429 430 431 432 433
    (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
434
    (goto-char (point-min))
435
    ;; Now insert the new line for this entry.
436
    (cond ((re-search-forward "^\\s *\\*\\s *$" bound t)
437 438
	   ;; Put this file name into the existing empty entry.
	   (if entry
439
	       (insert entry)))
440
	  ((and (not new-entry)
441 442 443 444 445 446
		(let (case-fold-search)
		  (re-search-forward
		   (concat (regexp-quote (concat "* " entry))
			   ;; Don't accept `foo.bar' when
			   ;; looking for `foo':
			   "\\(\\s \\|[(),:]\\)")
447
		   bound t)))
448 449
	   ;; Add to the existing entry for the same file.
	   (re-search-forward "^\\s *$\\|^\\s \\*")
450
	   (goto-char (match-beginning 0))
451 452 453 454 455 456
	   ;; Delete excess empty lines; make just 2.
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
	     (delete-region (point) (save-excursion (forward-line 1) (point))))
	   (insert "\n\n")
	   (forward-line -2)
	   (indent-relative-maybe))
Eric S. Raymond's avatar
Eric S. Raymond committed
457
	  (t
Roland McGrath's avatar
Roland McGrath committed
458 459 460 461
	   ;; Make a new entry.
	   (forward-line 1)
	   (while (looking-at "\\sW")
	     (forward-line 1))
462
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
463 464 465
	     (delete-region (point) (save-excursion (forward-line 1) (point))))
	   (insert "\n\n\n")
	   (forward-line -2)
Roland McGrath's avatar
Roland McGrath committed
466
	   (indent-to left-margin)
467 468
	   (insert "* " (or entry ""))
	   ))
469
    ;; Now insert the function name, if we have one.
Eric S. Raymond's avatar
Eric S. Raymond committed
470 471 472 473
    ;; 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
474
	  ;; Make it easy to get rid of the function name.
Eric S. Raymond's avatar
Eric S. Raymond committed
475
	  (undo-boundary)
Roland McGrath's avatar
Roland McGrath committed
476 477
	  (insert (if (save-excursion
			(beginning-of-line 1)
478
			(looking-at "\\s *$"))
Roland McGrath's avatar
Roland McGrath committed
479 480
		      ""
		    " ")
481 482 483 484
		  "(" defun "): "
		  (if version
		      (concat version " ")
		    "")))
485
      ;; No function name, so put in a colon unless we have just a star.
Roland McGrath's avatar
Roland McGrath committed
486 487 488
      (if (not (save-excursion
		 (beginning-of-line 1)
		 (looking-at "\\s *\\(\\*\\s *\\)?$")))
489 490
	  (insert ": "
		  (if version
491
		      (concat version " ") ""))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
492 493 494 495

;;;###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.
496 497
Optional arg WHOAMI (interactive prefix) non-nil means prompt for user
name and site.
498 499 500 501
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
502 503 504 505
  (interactive (if current-prefix-arg
		   (list current-prefix-arg
			 (prompt-for-change-log-name))))
  (add-change-log-entry whoami file-name t))
506
;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
Eric S. Raymond's avatar
Eric S. Raymond committed
507

508
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
509
(defun change-log-mode ()
510
  "Major mode for editing change logs; like Indented Text Mode.
511
Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
512
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
513 514
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
515 516 517
  (interactive)
  (kill-all-local-variables)
  (indented-text-mode)
518 519 520
  (setq major-mode 'change-log-mode
	mode-name "Change Log"
	left-margin 8
521
	fill-column 74
522 523
	indent-tabs-mode t
	tab-width 8)
Karl Heuer's avatar
Karl Heuer committed
524
  (use-local-map change-log-mode-map)
525 526
  (set (make-local-variable 'fill-paragraph-function)
       'change-log-fill-paragraph)
527 528 529 530
  ;; 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.
531
  (set (make-local-variable 'paragraph-start) "\\s *$\\|\f\\|^\\<")
532
  (set (make-local-variable 'paragraph-separate) paragraph-start)
533 534
  ;; Match null string on the date-line so that the date-line
  ;; is grouped with what follows.
535
  (set (make-local-variable 'page-delimiter) "^\\<\\|^\f")
Roland McGrath's avatar
Roland McGrath committed
536 537
  (set (make-local-variable 'version-control) 'never)
  (set (make-local-variable 'adaptive-fill-regexp) "\\s *")
538 539
  (set (make-local-variable 'font-lock-defaults)
       '(change-log-font-lock-keywords t))
Eric S. Raymond's avatar
Eric S. Raymond committed
540 541
  (run-hooks 'change-log-mode-hook))

542 543 544 545 546 547 548 549
;; 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")
550 551
  (let ((end (progn (forward-paragraph) (point)))
	(beg (progn (backward-paragraph) (point)))
552
	(paragraph-start (concat paragraph-start "\\|\\s *\\s(")))
553 554
    (fill-region beg end justify)
    t))
555

556
(defcustom add-log-current-defun-header-regexp
557
  "^\\([A-Z][A-Z_ ]*[A-Z_]\\|[-_a-zA-Z]+\\)[ \t]*[:=]"
558 559 560
  "*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
561

562 563
;;;###autoload
(defvar add-log-lisp-like-modes
564
    '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode)
565 566 567 568 569 570 571 572 573 574 575 576
  "*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'.")

577
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
578 579 580
(defun add-log-current-defun ()
  "Return name of function definition point is in, or nil.

581
Understands C, Lisp, LaTeX (\"functions\" are chapters, sections, ...),
582
Texinfo (@node titles), Perl, and Fortran.
Eric S. Raymond's avatar
Eric S. Raymond committed
583 584 585

Other modes are handled by a heuristic that looks in the 10K before
point for uppercase headings starting in the first column or
Gerd Moellmann's avatar
Gerd Moellmann committed
586 587 588
identifiers followed by `:' or `=', see variables
`add-log-current-defun-header-regexp' and
`add-log-current-defun-function'
Eric S. Raymond's avatar
Eric S. Raymond committed
589 590

Has a preference of looking backwards."
591 592 593
  (condition-case nil
      (save-excursion
	(let ((location (point)))
594 595
	  (cond ((and (functionp add-log-current-defun-function)
		      (funcall add-log-current-defun-function)))
Gerd Moellmann's avatar
Gerd Moellmann committed
596
		((memq major-mode add-log-lisp-like-modes)
597
		 ;; If we are now precisely at the beginning of a defun,
598 599 600 601 602
		 ;; make sure beginning-of-defun finds that one
		 ;; rather than the previous one.
		 (or (eobp) (forward-char 1))
		 (beginning-of-defun)
		 ;; Make sure we are really inside the defun found, not after it.
603 604 605 606 607 608 609 610 611 612 613 614
		 (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
615
		   (skip-chars-forward " \t\n'(")
616 617 618
		   (buffer-substring (point)
				     (progn (forward-sexp 1)
					    (point)))))
619 620 621 622 623 624 625 626 627
		((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]")))
628 629 630 631 632 633 634 635
		 ;; 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")
		 (buffer-substring (point)
				   (progn (forward-sexp 1) (point))))
636
		((memq major-mode add-log-c-like-modes)
637 638 639 640 641 642 643 644 645 646 647 648 649
		 (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)
		 (if (progn (end-of-defun)
			    (< location (point)))
		     (progn
		       (backward-sexp 1)
		       (let (beg tem)
Eric S. Raymond's avatar
Eric S. Raymond committed
650

651 652 653 654 655 656 657 658 659
			 (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
660 661 662
					(end-of-line)
					(while (= (preceding-char) ?\\)
					  (end-of-line 2))
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
					(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 (point)
						 (progn (forward-sexp 1) (point))))
678
                           (if (looking-at "^[+-]")
679
                               (change-log-get-method-definition)
680 681
                             ;; Ordinary C function syntax.
                             (setq beg (point))
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
                             (if (and (condition-case nil
					  ;; Protect against "Unbalanced parens" error.
					  (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)))
704 705 706
                                          ;; Consistency check: going down and up
                                          ;; shouldn't take us back before BEG.
                                          (> (point) beg))
707
				 (let (end middle)
708
				   ;; Don't include any final whitespace
709
				   ;; in the name we use.
710
				   (skip-chars-backward " \t\n")
711 712 713 714 715 716 717
				   (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)
718 719 720 721 722 723 724 725
				   ;; 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))
726
				   (and (bolp)
727
					(looking-at "enum \\|struct \\|union \\|class ")
728
					(setq middle (point)))
729 730 731 732 733
				   (goto-char end)
				   (when (eq (preceding-char) ?=)
				     (forward-char -1)
				     (skip-chars-backward " \t")
				     (setq end (point)))
734
				   (buffer-substring middle end)))))))))
735
		((memq major-mode add-log-tex-like-modes)
736 737 738 739 740 741 742 743 744
		 (if (re-search-backward
		      "\\\\\\(sub\\)*\\(section\\|paragraph\\|chapter\\)" nil t)
		     (progn
		       (goto-char (match-beginning 0))
		       (buffer-substring (1+ (point));; without initial backslash
					 (progn
					   (end-of-line)
					   (point))))))
		((eq major-mode 'texinfo-mode)
745
		 (if (re-search-backward "^@node[ \t]+\\([^,\n]+\\)" nil t)
746 747
		     (buffer-substring (match-beginning 1)
				       (match-end 1))))
748 749 750 751
		((eq major-mode 'perl-mode)
		 (if (re-search-backward "^sub[ \t]+\\([^ \t\n]+\\)" nil t)
		     (buffer-substring (match-beginning 1)
				       (match-end 1))))
752 753 754
                ((or (eq major-mode 'fortran-mode)
		     ;; Needs work for f90, but better than nothing.
		     (eq major-mode 'f90-mode))
755
                 ;; must be inside function body for this to work
756
                 (fortran-beginning-of-subprogram)
757 758 759
                 (let ((case-fold-search t)) ; case-insensitive
                   ;; search for fortran subprogram start
                   (if (re-search-forward
760
                        "^[ \t]*\\(program\\|subroutine\\|function\
761
\\|[ \ta-z0-9*()]*[ \t]+function\\|\\(block[ \t]*data\\)\\)"
762
                        (save-excursion (fortran-end-of-subprogram)
763 764
                                        (point))
                        t)
765
                       (or (match-string 2)
766 767 768
                           (progn
                             ;; move to EOL or before first left paren
                             (if (re-search-forward "[(\n]" nil t)
769
				 (progn (backward-char)
770 771 772 773
                                        (skip-chars-backward " \t"))
                               (end-of-line))
                             ;; Use the name preceding that.
                             (buffer-substring (point)
774 775 776
					       (progn (backward-sexp)
						      (point)))))
		     "main")))
777 778
		(t
		 ;; If all else fails, try heuristics
Gerd Moellmann's avatar
Gerd Moellmann committed
779 780
		 (let (case-fold-search
		       result)
781
		   (end-of-line)
Gerd Moellmann's avatar
Gerd Moellmann committed
782 783 784 785 786 787 788 789 790 791 792 793 794
		   (when (re-search-backward
			  add-log-current-defun-header-regexp
			  (- (point) 10000)
			  t)
		     (setq result (or (buffer-substring (match-beginning 1)
							(match-end 1))
				      (buffer-substring (match-beginning 0)
							(match-end 0))))
		     ;; Strip whitespace away
		     (when (string-match "\\([^ \t\n\r\f].*[^ \t\n\r\f]\\)"
					 result)
		       (setq result (match-string 1 result)))
		     result))))))
795
    (error nil)))
Jim Blandy's avatar
Jim Blandy committed
796

797
(defvar change-log-get-method-definition-md)
798

799
;; Subroutine used within change-log-get-method-definition.
800 801
;; Add the last match in the buffer to the end of `md',
;; followed by the string END; move to the end of that match.
802 803 804
(defun change-log-get-method-definition-1 (end)
  (setq change-log-get-method-definition-md
	(concat change-log-get-method-definition-md
805 806
		(buffer-substring (match-beginning 1) (match-end 1))
		end))
807 808
  (goto-char (match-end 0)))

809
(defun change-log-get-method-definition ()
Dave Love's avatar
Dave Love committed
810
"For objective C, return the method name if we are in a method."
811
  (let ((change-log-get-method-definition-md "["))
812
    (save-excursion
813
      (if (re-search-backward "^@implementation\\s-*\\([A-Za-z_]*\\)" nil t)
814
	  (change-log-get-method-definition-1 " ")))
815 816
    (save-excursion
      (cond
817
       ((re-search-forward "^\\([-+]\\)[ \t\n\f\r]*\\(([^)]*)\\)?\\s-*" nil t)
818
	(change-log-get-method-definition-1 "")
819 820
	(while (not (looking-at "[{;]"))
	  (looking-at
821
	   "\\([A-Za-z_]*:?\\)\\s-*\\(([^)]*)\\)?[A-Za-z_]*[ \t\n\f\r]*")
822 823
	  (change-log-get-method-definition-1 ""))
	(concat change-log-get-method-definition-md "]"))))))
Dave Love's avatar
Dave Love committed
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838

(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")))
839

Dave Love's avatar
Dave Love committed
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
;;;###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).

Entries are inserted in chronological order.

Both the current and old-style time formats for entries are supported,
so this command could be used to convert old-style logs by merging
with an empty log."
  (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
883

884 885
(provide 'add-log)

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