log-edit.el 34.2 KB
Newer Older
Stefan Monnier's avatar
Stefan Monnier committed
1 2
;;; log-edit.el --- Major mode for editing CVS commit messages

3
;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
4
;;   2008, 2009, 2010, 2011  Free Software Foundation, Inc.
Stefan Monnier's avatar
Stefan Monnier committed
5

Stefan Monnier's avatar
Stefan Monnier committed
6
;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
7
;; Keywords: pcl-cvs cvs commit log vc
Stefan Monnier's avatar
Stefan Monnier committed
8 9 10

;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Stefan Monnier's avatar
Stefan Monnier committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Stefan Monnier's avatar
Stefan Monnier committed
15 16 17 18 19 20 21

;; 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
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Stefan Monnier's avatar
Stefan Monnier committed
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37

;;; Commentary:

;; Todo:

;; - Move in VC's code
;; - Add compatibility for VC's hook variables

;;; Code:

(eval-when-compile (require 'cl))
(require 'add-log)			; for all the ChangeLog goodies
(require 'pcvs-util)
(require 'ring)

38
;;;;
Stefan Monnier's avatar
Stefan Monnier committed
39
;;;; Global Variables
40
;;;;
Stefan Monnier's avatar
Stefan Monnier committed
41 42

(defgroup log-edit nil
43
  "Major mode for editing RCS and CVS commit messages."
Stefan Monnier's avatar
Stefan Monnier committed
44
  :group 'pcl-cvs
45 46
  :group 'vc				; It's used by VC.
  :version "21.1"
Stefan Monnier's avatar
Stefan Monnier committed
47 48 49 50 51
  :prefix "log-edit-")

;; compiler pacifiers
(defvar cvs-buffer)

52 53 54

;; The main keymap

Stefan Monnier's avatar
Stefan Monnier committed
55 56 57
(easy-mmode-defmap log-edit-mode-map
  `(("\C-c\C-c" . log-edit-done)
    ("\C-c\C-a" . log-edit-insert-changelog)
58
    ("\C-c\C-d" . log-edit-show-diff)
Stefan Monnier's avatar
Stefan Monnier committed
59
    ("\C-c\C-f" . log-edit-show-files)
60 61 62 63
    ("\M-n"	. log-edit-next-comment)
    ("\M-p"	. log-edit-previous-comment)
    ("\M-r"	. log-edit-comment-search-backward)
    ("\M-s"	. log-edit-comment-search-forward)
Stefan Monnier's avatar
Stefan Monnier committed
64
    ("\C-c?"	. log-edit-mode-help))
65
  "Keymap for the `log-edit-mode' (to edit version control log messages)."
Stefan Monnier's avatar
Stefan Monnier committed
66 67 68 69 70
  :group 'log-edit)

;; Compatibility with old names.  Should we bother ?
(defvar vc-log-mode-map log-edit-mode-map)
(defvar vc-log-entry-mode vc-log-mode-map)
Stefan Monnier's avatar
Stefan Monnier committed
71

Stefan Monnier's avatar
Stefan Monnier committed
72 73 74 75 76 77
(easy-menu-define log-edit-menu log-edit-mode-map
  "Menu used for `log-edit-mode'."
  '("Log-Edit"
    ["Done" log-edit-done
     :help "Exit log-edit and proceed with the actual action."]
    "--"
78 79 80 81
    ["Insert ChangeLog" log-edit-insert-changelog
     :help "Insert a log message by looking at the ChangeLog"]
    ["Add to ChangeLog" log-edit-add-to-changelog
     :help "Insert this log message into the appropriate ChangeLog file"]
Stefan Monnier's avatar
Stefan Monnier committed
82
    "--"
83 84
    ["Show diff" log-edit-show-diff
     :help "Show the diff for the files to be committed."]
Stefan Monnier's avatar
Stefan Monnier committed
85 86 87
    ["List files" log-edit-show-files
     :help "Show the list of relevant files."]
    "--"
88 89 90 91 92 93 94 95
    ["Previous comment"		log-edit-previous-comment
     :help "Cycle backwards through comment history"]
    ["Next comment"		log-edit-next-comment
     :help "Cycle forwards through comment history."]
    ["Search comment forward"	log-edit-comment-search-forward
     :help "Search forwards through comment history for a substring match of str"]
    ["Search comment backward"	log-edit-comment-search-backward
     :help "Search backwards through comment history for substring match of str"]))
Stefan Monnier's avatar
Stefan Monnier committed
96

97
(defcustom log-edit-confirm 'changed
Lute Kamstra's avatar
Lute Kamstra committed
98
  "If non-nil, `log-edit-done' will request confirmation.
Stefan Monnier's avatar
Stefan Monnier committed
99 100 101 102 103 104
If 'changed, only request confirmation if the list of files has
  changed since the beginning of the log-edit session."
  :group 'log-edit
  :type '(choice (const changed) (const t) (const nil)))

(defcustom log-edit-keep-buffer nil
Lute Kamstra's avatar
Lute Kamstra committed
105
  "If non-nil, don't hide the buffer after `log-edit-done'."
Stefan Monnier's avatar
Stefan Monnier committed
106 107 108
  :group 'log-edit
  :type 'boolean)

109 110
(defvar cvs-commit-buffer-require-final-newline t)
(make-obsolete-variable 'cvs-commit-buffer-require-final-newline
111 112
                        'log-edit-require-final-newline
			"21.1")
Stefan Monnier's avatar
Stefan Monnier committed
113 114 115

(defcustom log-edit-require-final-newline
  cvs-commit-buffer-require-final-newline
Lute Kamstra's avatar
Lute Kamstra committed
116
  "Enforce a newline at the end of commit log messages.
Stefan Monnier's avatar
Stefan Monnier committed
117 118 119 120 121
Enforce it silently if t, query if non-nil and don't do anything if nil."
  :group 'log-edit
  :type '(choice (const ask) (const t) (const nil)))

(defcustom log-edit-setup-invert nil
Lute Kamstra's avatar
Lute Kamstra committed
122
  "Non-nil means `log-edit' should invert the meaning of its SETUP arg.
Stefan Monnier's avatar
Stefan Monnier committed
123 124 125 126 127
If SETUP is 'force, this variable has no effect."
  :group 'log-edit
  :type 'boolean)

(defcustom log-edit-hook '(log-edit-insert-cvs-template
128
                           log-edit-show-files
Stefan Monnier's avatar
Stefan Monnier committed
129
			   log-edit-insert-changelog)
Lute Kamstra's avatar
Lute Kamstra committed
130
  "Hook run at the end of `log-edit'."
Stefan Monnier's avatar
Stefan Monnier committed
131
  :group 'log-edit
Stefan Monnier's avatar
Stefan Monnier committed
132 133 134 135
  :type '(hook :options (log-edit-insert-changelog
                         log-edit-insert-cvs-rcstemplate
                         log-edit-insert-cvs-template
			 log-edit-insert-filenames)))
Stefan Monnier's avatar
Stefan Monnier committed
136

137
(defcustom log-edit-mode-hook (if (boundp 'vc-log-mode-hook) vc-log-mode-hook)
Lute Kamstra's avatar
Lute Kamstra committed
138
  "Hook run when entering `log-edit-mode'."
Stefan Monnier's avatar
Stefan Monnier committed
139 140 141 142
  :group 'log-edit
  :type 'hook)

(defcustom log-edit-done-hook nil
Lute Kamstra's avatar
Lute Kamstra committed
143
  "Hook run before doing the actual commit.
Stefan Monnier's avatar
Stefan Monnier committed
144 145 146 147 148
This hook can be used to cleanup the message, enforce various
conventions, or to allow recording the message in some other database,
such as a bug-tracking system.  The list of files about to be committed
can be obtained from `log-edit-files'."
  :group 'log-edit
149
  :type '(hook :options (log-edit-set-common-indentation
Stefan Monnier's avatar
Stefan Monnier committed
150 151
			 log-edit-add-to-changelog)))

152
(defcustom log-edit-strip-single-file-name nil
153
  "If non-nil, remove file name from single-file log entries."
154 155 156
  :type 'boolean
  :safe 'booleanp
  :group 'log-edit
157
  :version "24.1")
158

159 160
(defvar cvs-changelog-full-paragraphs t)
(make-obsolete-variable 'cvs-changelog-full-paragraphs
161 162
                        'log-edit-changelog-full-paragraphs
			"21.1")
163 164 165

(defvar log-edit-changelog-full-paragraphs cvs-changelog-full-paragraphs
  "*If non-nil, include full ChangeLog paragraphs in the log.
Stefan Monnier's avatar
Stefan Monnier committed
166 167 168 169 170 171 172 173
This may be set in the ``local variables'' section of a ChangeLog, to
indicate the policy for that ChangeLog.

A ChangeLog paragraph is a bunch of log text containing no blank lines;
a paragraph usually describes a set of changes with a single purpose,
but perhaps spanning several functions in several files.  Changes in
different paragraphs are unrelated.

174
You could argue that the log entry for a file should contain the
Stefan Monnier's avatar
Stefan Monnier committed
175 176
full ChangeLog paragraph mentioning the change to the file, even though
it may mention other files, because that gives you the full context you
177
need to understand the change.  This is the behavior you get when this
Stefan Monnier's avatar
Stefan Monnier committed
178 179
variable is set to t.

180
On the other hand, you could argue that the log entry for a change
Stefan Monnier's avatar
Stefan Monnier committed
181
should contain only the text for the changes which occurred in that
182
file, because the log is per-file.  This is the behavior you get
Stefan Monnier's avatar
Stefan Monnier committed
183 184 185 186 187 188 189
when this variable is set to nil.")

;;;; Internal global or buffer-local vars

(defconst log-edit-files-buf "*log-edit-files*")
(defvar log-edit-initial-files nil)
(defvar log-edit-callback nil)
190
(defvar log-edit-diff-function nil)
Stefan Monnier's avatar
Stefan Monnier committed
191
(defvar log-edit-listfun nil)
192

193
(defvar log-edit-parent-buffer nil)
Stefan Monnier's avatar
Stefan Monnier committed
194

195
;;; Originally taken from VC-Log mode
196

197
(defconst log-edit-maximum-comment-ring-size 32
198
  "Maximum number of saved comments in the comment ring.")
199 200 201
(defvar log-edit-comment-ring (make-ring log-edit-maximum-comment-ring-size))
(defvar log-edit-comment-ring-index nil)
(defvar log-edit-last-comment-match "")
202

203
(defun log-edit-new-comment-index (stride len)
204
  "Return the comment index STRIDE elements from the current one.
205
LEN is the length of `log-edit-comment-ring'."
206
  (mod (cond
207
	(log-edit-comment-ring-index (+ log-edit-comment-ring-index stride))
208 209 210 211 212 213 214
	;; Initialize the index on the first use of this command
	;; so that the first M-p gets index 0, and the first M-n gets
	;; index -1.
	((> stride 0) (1- stride))
	(t stride))
       len))

215
(defun log-edit-previous-comment (arg)
216 217 218
  "Cycle backwards through comment history.
With a numeric prefix ARG, go back ARG comments."
  (interactive "*p")
219
  (let ((len (ring-length log-edit-comment-ring)))
220 221
    (if (<= len 0)
	(progn (message "Empty comment ring") (ding))
Stefan Monnier's avatar
Stefan Monnier committed
222 223
      ;; Don't use `erase-buffer' because we don't want to `widen'.
      (delete-region (point-min) (point-max))
224 225 226
      (setq log-edit-comment-ring-index (log-edit-new-comment-index arg len))
      (message "Comment %d" (1+ log-edit-comment-ring-index))
      (insert (ring-ref log-edit-comment-ring log-edit-comment-ring-index)))))
227

228
(defun log-edit-next-comment (arg)
229 230 231
  "Cycle forwards through comment history.
With a numeric prefix ARG, go forward ARG comments."
  (interactive "*p")
232
  (log-edit-previous-comment (- arg)))
233

234
(defun log-edit-comment-search-backward (str &optional stride)
235 236 237 238 239
  "Search backwards through comment history for substring match of STR.
If the optional argument STRIDE is present, that is a step-width to use
when going through the comment ring."
  ;; Why substring rather than regexp ?   -sm
  (interactive
240
   (list (read-string "Comment substring: " nil nil log-edit-last-comment-match)))
241 242
  (unless stride (setq stride 1))
  (if (string= str "")
243 244
      (setq str log-edit-last-comment-match)
    (setq log-edit-last-comment-match str))
245
  (let* ((str (regexp-quote str))
246 247
	 (len (ring-length log-edit-comment-ring))
	 (n (log-edit-new-comment-index stride len)))
248
    (while (progn (when (or (>= n len) (< n 0)) (error "Not found"))
249
		  (not (string-match str (ring-ref log-edit-comment-ring n))))
250
      (setq n (+ n stride)))
251 252
    (setq log-edit-comment-ring-index n)
    (log-edit-previous-comment 0)))
253

254
(defun log-edit-comment-search-forward (str)
255 256
  "Search forwards through comment history for a substring match of STR."
  (interactive
257 258
   (list (read-string "Comment substring: " nil nil log-edit-last-comment-match)))
  (log-edit-comment-search-backward str -1))
259

260
(defun log-edit-comment-to-change-log (&optional whoami file-name)
261 262 263 264 265
  "Enter last VC comment into the change log for the current file.
WHOAMI (interactive prefix) non-nil means prompt for user name
and site.  FILE-NAME is the name of the change log; if nil, use
`change-log-default-name'.

266
This may be useful as a `log-edit-checkin-hook' to update change logs
267 268 269 270 271
automatically."
  (interactive (if current-prefix-arg
		   (list current-prefix-arg
			 (prompt-for-change-log-name))))
  (let (;; Extract the comment first so we get any error before doing anything.
272
	(comment (ring-ref log-edit-comment-ring 0))
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
	;; Don't let add-change-log-entry insert a defun name.
	(add-log-current-defun-function 'ignore)
	end)
    ;; Call add-log to do half the work.
    (add-change-log-entry whoami file-name t t)
    ;; Insert the VC comment, leaving point before it.
    (setq end (save-excursion (insert comment) (point-marker)))
    (if (looking-at "\\s *\\s(")
	;; It starts with an open-paren, as in "(foo): Frobbed."
	;; So remove the ": " add-log inserted.
	(delete-char -2))
    ;; Canonicalize the white space between the file name and comment.
    (just-one-space)
    ;; Indent rest of the text the same way add-log indented the first line.
    (let ((indentation (current-indentation)))
      (save-excursion
	(while (< (point) end)
	  (forward-line 1)
	  (indent-to indentation))
	(setq end (point))))
    ;; Fill the inserted text, preserving open-parens at bol.
Stefan Monnier's avatar
Stefan Monnier committed
294
    (let ((paragraph-start (concat paragraph-start "\\|\\s *\\s(")))
295 296 297 298 299 300 301 302 303
      (beginning-of-line)
      (fill-region (point) end))
    ;; Canonicalize the white space at the end of the entry so it is
    ;; separated from the next entry by a single blank line.
    (skip-syntax-forward " " end)
    (delete-char (- (skip-syntax-backward " ")))
    (or (eobp) (looking-at "\n\n")
	(insert "\n"))))

304
;; Compatibility with old names.
Stefan Monnier's avatar
Stefan Monnier committed
305 306 307 308 309 310 311
(define-obsolete-variable-alias 'vc-comment-ring 'log-edit-comment-ring "22.1")
(define-obsolete-variable-alias 'vc-comment-ring-index 'log-edit-comment-ring-index "22.1")
(define-obsolete-function-alias 'vc-previous-comment 'log-edit-previous-comment "22.1")
(define-obsolete-function-alias 'vc-next-comment 'log-edit-next-comment "22.1")
(define-obsolete-function-alias 'vc-comment-search-reverse 'log-edit-comment-search-backward "22.1")
(define-obsolete-function-alias 'vc-comment-search-forward 'log-edit-comment-search-forward "22.1")
(define-obsolete-function-alias 'vc-comment-to-change-log 'log-edit-comment-to-change-log "22.1")
312

313 314 315
;;;
;;; Actual code
;;;
Stefan Monnier's avatar
Stefan Monnier committed
316

317 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 344 345 346 347 348 349
(defface log-edit-summary '((t :inherit font-lock-function-name-face))
  "Face for the summary in `log-edit-mode' buffers.")

(defface log-edit-header '((t :inherit font-lock-keyword-face))
  "Face for the headers in `log-edit-mode' buffers.")

(defface log-edit-unknown-header '((t :inherit font-lock-comment-face))
  "Face for unknown headers in `log-edit-mode' buffers.")

(defvar log-edit-headers-alist '(("Summary" . log-edit-summary)
                                 ("Fixes") ("Author"))
  "AList of known headers and the face to use to highlight them.")

(defconst log-edit-header-contents-regexp
  "[ \t]*\\(.*\\(\n[ \t].*\\)*\\)\n?")

(defun log-edit-match-to-eoh (limit)
  ;; FIXME: copied from message-match-to-eoh.
  (let ((start (point)))
    (rfc822-goto-eoh)
    ;; Typical situation: some temporary change causes the header to be
    ;; incorrect, so EOH comes earlier than intended: the last lines of the
    ;; intended headers are now not considered part of the header any more,
    ;; so they don't have the multiline property set.  When the change is
    ;; completed and the header has its correct shape again, the lack of the
    ;; multiline property means we won't rehighlight the last lines of
    ;; the header.
    (if (< (point) start)
        nil                             ;No header within start..limit.
      ;; Here we disregard LIMIT so that we may extend the area again.
      (set-match-data (list start (point)))
      (point))))

350
(defvar log-edit-font-lock-keywords
351 352
  ;; Copied/inspired by message-font-lock-keywords.
  `((log-edit-match-to-eoh
353
     (,(concat "^\\(\\([a-z]+\\):\\)" log-edit-header-contents-regexp)
354 355 356 357 358
      (progn (goto-char (match-beginning 0)) (match-end 0)) nil
      (1 (if (assoc (match-string 2) log-edit-headers-alist)
             'log-edit-header
           'log-edit-unknown-header)
         nil lax)
359
      ;; From `log-edit-header-contents-regexp':
360 361
      (3 (or (cdr (assoc (match-string 2) log-edit-headers-alist))
             'log-edit-header)
362
         nil lax)))))
363

Stefan Monnier's avatar
Stefan Monnier committed
364
;;;###autoload
365
(defun log-edit (callback &optional setup params buffer mode &rest ignore)
Stefan Monnier's avatar
Stefan Monnier committed
366
  "Setup a buffer to enter a log message.
367 368
\\<log-edit-mode-map>The buffer will be put in mode MODE or `log-edit-mode'
if MODE is nil.
Stefan Monnier's avatar
Stefan Monnier committed
369
If SETUP is non-nil, the buffer is then erased and `log-edit-hook' is run.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
370 371
Mark and point will be set around the entire contents of the buffer so
that it is easy to kill the contents of the buffer with \\[kill-region].
Stefan Monnier's avatar
Stefan Monnier committed
372
Once you're done editing the message, pressing \\[log-edit-done] will call
373
`log-edit-done' which will end up calling CALLBACK to do the actual commit.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
374 375 376 377 378 379 380

PARAMS if non-nil is an alist.  Possible keys and associated values:
 `log-edit-listfun' -- function taking no arguments that returns the list of
 files that are concerned by the current operation (using relative names);
 `log-edit-diff-function' -- function taking no arguments that
 displays a diff of the files concerned by the current operation.

381
If BUFFER is non-nil `log-edit' will jump to that buffer, use it to edit the
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
382 383
log message and go back to the current buffer when done.  Otherwise, it
uses the current buffer."
384 385 386 387
  (let ((parent (current-buffer)))
    (if buffer (pop-to-buffer buffer))
    (when (and log-edit-setup-invert (not (eq setup 'force)))
      (setq setup (not setup)))
388 389 390 391
    (when setup
      (erase-buffer)
      (insert "Summary: ")
      (save-excursion (insert "\n\n")))
392 393 394
    (if mode
	(funcall mode)
      (log-edit-mode))
395
    (set (make-local-variable 'log-edit-callback) callback)
396 397 398 399 400 401 402
    (if (listp params)
	(dolist (crt params)
	  (set (make-local-variable (car crt)) (cdr crt)))
      ;; For backward compatibility with log-edit up to version 22.2
      ;; accept non-list PARAMS to mean `log-edit-list'.
      (set (make-local-variable 'log-edit-listfun) params))

403
    (if buffer (set (make-local-variable 'log-edit-parent-buffer) parent))
404
    (set (make-local-variable 'log-edit-initial-files) (log-edit-files))
405 406
    (when setup (run-hooks 'log-edit-hook))
    (goto-char (point-min)) (push-mark (point-max))
Deepak Goel's avatar
Deepak Goel committed
407
    (message "%s" (substitute-command-keys
408
	      "Press \\[log-edit-done] when you are done editing."))))
Stefan Monnier's avatar
Stefan Monnier committed
409 410

(define-derived-mode log-edit-mode text-mode "Log-Edit"
411 412 413 414 415 416 417
  "Major mode for editing version-control log messages.
When done editing the log entry, just type \\[log-edit-done] which
will trigger the actual commit of the file(s).
Several other handy support commands are provided of course and
the package from which this is used might also provide additional
commands (under C-x v for VC, for example).

418
\\{log-edit-mode-map}"
419
  (set (make-local-variable 'font-lock-defaults)
420
       '(log-edit-font-lock-keywords t t))
421 422
  (make-local-variable 'log-edit-comment-ring-index)
  (hack-dir-local-variables-non-file-buffer))
Stefan Monnier's avatar
Stefan Monnier committed
423 424 425 426 427 428 429 430 431 432 433

(defun log-edit-hide-buf (&optional buf where)
  (when (setq buf (get-buffer (or buf log-edit-files-buf)))
    (let ((win (get-buffer-window buf where)))
      (if win (ignore-errors (delete-window win))))
    (bury-buffer buf)))

(defun log-edit-done ()
  "Finish editing the log message and commit the files.
If you want to abort the commit, simply delete the buffer."
  (interactive)
434 435 436 437 438 439 440 441 442 443 444
  ;; Clean up empty headers.
  (goto-char (point-min))
  (while (looking-at (concat "^[a-z]*:" log-edit-header-contents-regexp))
    (let ((beg (match-beginning 0)))
      (goto-char (match-end 0))
      (if (string-match "\\`[ \n\t]*\\'" (match-string 1))
          (delete-region beg (point)))))
  ;; Get rid of leading empty lines.
  (goto-char (point-min))
  (when (looking-at "\\([ \t]*\n\\)+")
    (delete-region (match-beginning 0) (match-end 0)))
445 446 447 448 449 450
  ;; Get rid of trailing empty lines
  (goto-char (point-max))
  (skip-syntax-backward " ")
  (when (equal (char-after) ?\n) (forward-char 1))
  (delete-region (point) (point-max))
  ;; Check for final newline
451 452
  (if (and (> (point-max) (point-min))
	   (/= (char-before (point-max)) ?\n)
Stefan Monnier's avatar
Stefan Monnier committed
453 454 455 456 457 458 459 460
	   (or (eq log-edit-require-final-newline t)
	       (and log-edit-require-final-newline
		    (y-or-n-p
		     (format "Buffer %s does not end in newline.  Add one? "
			     (buffer-name))))))
      (save-excursion
	(goto-char (point-max))
	(insert ?\n)))
461
  (let ((comment (buffer-string)))
462 463 464
    (when (or (ring-empty-p log-edit-comment-ring)
	      (not (equal comment (ring-ref log-edit-comment-ring 0))))
      (ring-insert log-edit-comment-ring comment)))
Stefan Monnier's avatar
Stefan Monnier committed
465 466 467 468 469 470
  (let ((win (get-buffer-window log-edit-files-buf)))
    (if (and log-edit-confirm
	     (not (and (eq log-edit-confirm 'changed)
		       (equal (log-edit-files) log-edit-initial-files)))
	     (progn
	       (log-edit-show-files)
471
	       (not (y-or-n-p "Really commit? "))))
Stefan Monnier's avatar
Stefan Monnier committed
472 473 474 475
	(progn (when (not win) (log-edit-hide-buf))
	       (message "Oh, well!  Later maybe?"))
      (run-hooks 'log-edit-done-hook)
      (log-edit-hide-buf)
476 477
      (unless (or log-edit-keep-buffer (not log-edit-parent-buffer))
	(cvs-bury-buffer (current-buffer) log-edit-parent-buffer))
Stefan Monnier's avatar
Stefan Monnier committed
478 479 480 481 482 483 484 485 486 487 488
      (call-interactively log-edit-callback))))

(defun log-edit-files ()
  "Return the list of files that are about to be committed."
  (ignore-errors (funcall log-edit-listfun)))

(defun log-edit-mode-help ()
  "Provide help for the `log-edit-mode-map'."
  (interactive)
  (if (eq last-command 'log-edit-mode-help)
      (describe-function major-mode)
Deepak Goel's avatar
Deepak Goel committed
489
    (message "%s"
Stefan Monnier's avatar
Stefan Monnier committed
490 491 492
     (substitute-command-keys
      "Type `\\[log-edit-done]' to finish commit.  Try `\\[describe-function] log-edit-done' for more help."))))

493 494 495 496 497 498 499
(defcustom log-edit-common-indent 0
  "Minimum indentation to use in `log-edit-set-common-indentation'."
  :group 'log-edit
  :type 'integer)

(defun log-edit-set-common-indentation ()
  "(Un)Indent the current buffer rigidly to `log-edit-common-indent'."
Stefan Monnier's avatar
Stefan Monnier committed
500 501
  (save-excursion
    (let ((common (point-max)))
502
      (rfc822-goto-eoh)
Stefan Monnier's avatar
Stefan Monnier committed
503 504 505 506
      (while (< (point) (point-max))
        (if (not (looking-at "^[ \t]*$"))
            (setq common (min common (current-indentation))))
        (forward-line 1))
507 508
      (rfc822-goto-eoh)
      (indent-rigidly (point) (point-max)
509
		      (- log-edit-common-indent common)))))
Stefan Monnier's avatar
Stefan Monnier committed
510

511 512 513
(defun log-edit-show-diff ()
  "Show the diff for the files to be committed."
  (interactive)
514 515 516
  (if (functionp log-edit-diff-function)
      (funcall log-edit-diff-function)
    (error "Diff functionality has not been setup")))
517

Stefan Monnier's avatar
Stefan Monnier committed
518 519 520 521
(defun log-edit-show-files ()
  "Show the list of files to be committed."
  (interactive)
  (let* ((files (log-edit-files))
522
	 (buf (get-buffer-create log-edit-files-buf)))
Stefan Monnier's avatar
Stefan Monnier committed
523 524 525 526
    (with-current-buffer buf
      (log-edit-hide-buf buf 'all)
      (setq buffer-read-only nil)
      (erase-buffer)
527
      (cvs-insert-strings files)
Stefan Monnier's avatar
Stefan Monnier committed
528 529 530 531 532 533 534 535
      (setq buffer-read-only t)
      (goto-char (point-min))
      (save-selected-window
	(cvs-pop-to-buffer-same-frame buf)
	(shrink-window-if-larger-than-buffer)
	(selected-window)))))

(defun log-edit-insert-cvs-template ()
Stefan Monnier's avatar
Stefan Monnier committed
536 537
  "Insert the template specified by the CVS administrator, if any.
This simply uses the local CVS/Template file."
Stefan Monnier's avatar
Stefan Monnier committed
538
  (interactive)
539 540
  (when (or (called-interactively-p 'interactive)
	    (= (point-min) (point-max)))
Stefan Monnier's avatar
Stefan Monnier committed
541 542 543 544 545 546 547 548
    (when (file-readable-p "CVS/Template")
      (insert-file-contents "CVS/Template"))))

(defun log-edit-insert-cvs-rcstemplate ()
  "Insert the rcstemplate from the CVS repository.
This contacts the repository to get the rcstemplate file and
can thus take some time."
  (interactive)
549 550
  (when (or (called-interactively-p 'interactive)
	    (= (point-min) (point-max)))
551 552 553 554
    (when (file-readable-p "CVS/Root")
      ;; Ignore the stderr stuff, even if it's an error.
      (call-process "cvs" nil '(t nil) nil
                    "checkout" "-p" "CVSROOT/rcstemplate"))))
555

Stefan Monnier's avatar
Stefan Monnier committed
556 557 558 559 560
(defun log-edit-insert-filenames ()
  "Insert the list of files that are to be committed."
  (interactive)
  (insert "Affected files:  \n"
          (mapconcat 'identity (log-edit-files) "  \n")))
Stefan Monnier's avatar
Stefan Monnier committed
561 562 563 564 565

(defun log-edit-add-to-changelog ()
  "Insert this log message into the appropriate ChangeLog file."
  (interactive)
  ;; Yuck!
566 567
  (unless (string= (buffer-string) (ring-ref log-edit-comment-ring 0))
    (ring-insert log-edit-comment-ring (buffer-string)))
Stefan Monnier's avatar
Stefan Monnier committed
568 569 570
  (dolist (f (log-edit-files))
    (let ((buffer-file-name (expand-file-name f)))
      (save-excursion
571
	(log-edit-comment-to-change-log)))))
Stefan Monnier's avatar
Stefan Monnier committed
572

Stefan Monnier's avatar
Stefan Monnier committed
573
(defvar log-edit-changelog-use-first nil)
574 575 576 577 578 579 580

(defvar log-edit-rewrite-fixes nil
  "Rule to rewrite bug numbers into Fixes: headers.
The value should be of the form (REGEXP . REPLACEMENT)
where REGEXP should match the expression referring to a bug number
in the text, and REPLACEMENT is an expression to pass to `replace-match'
to build the Fixes: header.")
581 582
(put 'log-edit-rewrite-fixes 'safe-local-variable
     (lambda (v) (and (stringp (car-safe v)) (stringp (cdr v)))))
583

Stefan Monnier's avatar
Stefan Monnier committed
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
(defun log-edit-insert-changelog (&optional use-first)
  "Insert a log message by looking at the ChangeLog.
The idea is to write your ChangeLog entries first, and then use this
command to commit your changes.

To select default log text, we:
- find the ChangeLog entries for the files to be checked in,
- verify that the top entry in the ChangeLog is on the current date
  and by the current user; if not, we don't provide any default text,
- search the ChangeLog entry for paragraphs containing the names of
  the files we're checking in, and finally
- use those paragraphs as the log text.

If the optional prefix arg USE-FIRST is given (via \\[universal-argument]),
or if the command is repeated a second time in a row, use the first log entry
regardless of user name or time."
  (interactive "P")
601 602 603 604
  (let ((eoh (save-excursion (rfc822-goto-eoh) (point))))
    (when (<= (point) eoh)
      (goto-char eoh)
      (if (looking-at "\n") (forward-char 1))))
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
  (let ((author
         (let ((log-edit-changelog-use-first
                (or use-first (eq last-command 'log-edit-insert-changelog))))
           (log-edit-insert-changelog-entries (log-edit-files)))))
    (log-edit-set-common-indentation)
    ;; Add an Author: field if appropriate.
    (when author
      (rfc822-goto-eoh)
      (insert "Author: " author "\n" (if (looking-at "\n") "" "\n")))
    ;; Add a Fixes: field if applicable.
    (when (consp log-edit-rewrite-fixes)
      (rfc822-goto-eoh)
      (when (re-search-forward (car log-edit-rewrite-fixes) nil t)
        (let ((start (match-beginning 0))
              (end (match-end 0))
              (fixes (match-substitute-replacement
                      (cdr log-edit-rewrite-fixes))))
          (delete-region start end)
          (rfc822-goto-eoh)
          (insert "Fixes: " fixes "\n" (if (looking-at "\n") "" "\n")))))
    (goto-char (point-min))
    (when (and log-edit-strip-single-file-name (looking-at "\\*\\s-+"))
      (forward-line 1)
      (when (not (re-search-forward "^\\*\\s-+" nil t))
        (goto-char (point-min))
        (skip-chars-forward "^():")
        (skip-chars-forward ": ")
        (delete-region (point-min) (point))))))
Stefan Monnier's avatar
Stefan Monnier committed
633

634
;;;;
Stefan Monnier's avatar
Stefan Monnier committed
635 636
;;;; functions for getting commit message from ChangeLog a file...
;;;; Courtesy Jim Blandy
637
;;;;
Stefan Monnier's avatar
Stefan Monnier committed
638

639
(defun log-edit-narrow-changelog ()
Stefan Monnier's avatar
Stefan Monnier committed
640 641 642 643
  "Narrow to the top page of the current buffer, a ChangeLog file.
Actually, the narrowed region doesn't include the date line.
A \"page\" in a ChangeLog file is the area between two dates."
  (or (eq major-mode 'change-log-mode)
644
      (error "log-edit-narrow-changelog: current buffer isn't a ChangeLog"))
Stefan Monnier's avatar
Stefan Monnier committed
645 646 647 648 649 650 651 652 653 654 655 656 657

  (goto-char (point-min))

  ;; Skip date line and subsequent blank lines.
  (forward-line 1)
  (if (looking-at "[ \t\n]*\n")
      (goto-char (match-end 0)))

  (let ((start (point)))
    (forward-page 1)
    (narrow-to-region start (point))
    (goto-char (point-min))))

658
(defun log-edit-changelog-paragraph ()
Stefan Monnier's avatar
Stefan Monnier committed
659 660
  "Return the bounds of the ChangeLog paragraph containing point.
If we are between paragraphs, return the previous paragraph."
661 662 663 664 665 666 667 668 669 670
  (beginning-of-line)
  (if (looking-at "^[ \t]*$")
      (skip-chars-backward " \t\n" (point-min)))
  (list (progn
          (if (re-search-backward "^[ \t]*\n" nil 'or-to-limit)
              (goto-char (match-end 0)))
          (point))
        (if (re-search-forward "^[ \t\n]*$" nil t)
            (match-beginning 0)
          (point-max))))
Stefan Monnier's avatar
Stefan Monnier committed
671

672
(defun log-edit-changelog-subparagraph ()
Stefan Monnier's avatar
Stefan Monnier committed
673 674 675 676 677 678
  "Return the bounds of the ChangeLog subparagraph containing point.
A subparagraph is a block of non-blank lines beginning with an asterisk.
If we are between sub-paragraphs, return the previous subparagraph."
    (end-of-line)
    (if (search-backward "*" nil t)
        (list (progn (beginning-of-line) (point))
679
              (progn
Stefan Monnier's avatar
Stefan Monnier committed
680 681 682 683
                (forward-line 1)
                (if (re-search-forward "^[ \t]*[\n*]" nil t)
                    (match-beginning 0)
                  (point-max))))
684
    (list (point) (point))))
Stefan Monnier's avatar
Stefan Monnier committed
685

686
(defun log-edit-changelog-entry ()
Stefan Monnier's avatar
Stefan Monnier committed
687
  "Return the bounds of the ChangeLog entry containing point.
688
The variable `log-edit-changelog-full-paragraphs' decides whether an
Stefan Monnier's avatar
Stefan Monnier committed
689 690
\"entry\" is a paragraph or a subparagraph; see its documentation string
for more details."
691 692 693 694
  (save-excursion
    (if log-edit-changelog-full-paragraphs
        (log-edit-changelog-paragraph)
      (log-edit-changelog-subparagraph))))
Stefan Monnier's avatar
Stefan Monnier committed
695 696 697

(defvar user-full-name)
(defvar user-mail-address)
698 699 700

(defvar log-edit-author)                ;Dynamically scoped.

701
(defun log-edit-changelog-ours-p ()
Stefan Monnier's avatar
Stefan Monnier committed
702
  "See if ChangeLog entry at point is for the current user, today.
703
Return non-nil if it is."
Stefan Monnier's avatar
Stefan Monnier committed
704 705 706 707 708 709 710 711 712 713 714
  ;; Code adapted from add-change-log-entry.
  (let ((name (or (and (boundp 'add-log-full-name) add-log-full-name)
		  (and (fboundp 'user-full-name) (user-full-name))
		  (and (boundp 'user-full-name) user-full-name)))
        (mail (or (and (boundp 'add-log-mailing-address) add-log-mailing-address)
		  ;;(and (fboundp 'user-mail-address) (user-mail-address))
		  (and (boundp 'user-mail-address) user-mail-address)))
	(time (or (and (boundp 'add-log-time-format)
		       (functionp add-log-time-format)
		       (funcall add-log-time-format))
		  (format-time-string "%Y-%m-%d"))))
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
    (if (null log-edit-changelog-use-first)
        (looking-at (regexp-quote (format "%s  %s  <%s>" time name mail)))
      ;; Check the author, to potentially add it as a "Author: " header.
      (when (looking-at "[^ \t]")
        (when (and (boundp 'log-edit-author)
                   (not (looking-at (format ".+  .+  <%s>"
                                            (regexp-quote mail))))
                   (looking-at ".+  \\(.+  <.+>\\)"))
          (let ((author (replace-regexp-in-string "  " " "
                                                  (match-string 1))))
            (unless (and log-edit-author
                         (string-match (regexp-quote author) log-edit-author))
              (setq log-edit-author
                    (if log-edit-author
                        (concat log-edit-author ", " author)
                      author)))))
        t))))
Stefan Monnier's avatar
Stefan Monnier committed
732

733
(defun log-edit-changelog-entries (file)
Stefan Monnier's avatar
Stefan Monnier committed
734 735
  "Return the ChangeLog entries for FILE, and the ChangeLog they came from.
The return value looks like this:
736
  (LOGBUFFER (ENTRYSTART ENTRYEND) ...)
Stefan Monnier's avatar
Stefan Monnier committed
737 738
where LOGBUFFER is the name of the ChangeLog buffer, and each
\(ENTRYSTART . ENTRYEND\) pair is a buffer region."
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
  (let ((changelog-file-name
         (let ((default-directory
                 (file-name-directory (expand-file-name file)))
               (visiting-buffer (find-buffer-visiting file)))
           ;; If there is a buffer visiting FILE, and it has a local
           ;; value for `change-log-default-name', use that.
           (if (and visiting-buffer
                    (local-variable-p 'change-log-default-name
                                      visiting-buffer))
               (with-current-buffer visiting-buffer
                 change-log-default-name)
             ;; `find-change-log' uses `change-log-default-name' if set
             ;; and sets it before exiting, so we need to work around
             ;; that memoizing which is undesired here
             (setq change-log-default-name nil)
             (find-change-log)))))
    (with-current-buffer (find-file-noselect changelog-file-name)
Stefan Monnier's avatar
Stefan Monnier committed
756 757 758
      (unless (eq major-mode 'change-log-mode) (change-log-mode))
      (goto-char (point-min))
      (if (looking-at "\\s-*\n") (goto-char (match-end 0)))
759
      (if (not (log-edit-changelog-ours-p))
Stefan Monnier's avatar
Stefan Monnier committed
760 761
	  (list (current-buffer))
	(save-restriction
762
	  (log-edit-narrow-changelog)
Stefan Monnier's avatar
Stefan Monnier committed
763
	  (goto-char (point-min))
764

Stefan Monnier's avatar
Stefan Monnier committed
765 766 767 768 769 770 771 772 773 774 775
	  ;; Search for the name of FILE relative to the ChangeLog.  If that
	  ;; doesn't occur anywhere, they're not using full relative
	  ;; filenames in the ChangeLog, so just look for FILE; we'll accept
	  ;; some false positives.
	  (let ((pattern (file-relative-name
			  file (file-name-directory changelog-file-name))))
	    (if (or (string= pattern "")
		    (not (save-excursion
			   (search-forward pattern nil t))))
		(setq pattern (file-name-nondirectory file)))

776
            (setq pattern (concat "\\(^\\|[^[:alnum:]]\\)"
777
                                  (regexp-quote pattern)
778 779
                                  "\\($\\|[^[:alnum:]]\\)"))

780 781 782
	    (let (texts
                  (pos (point)))
	      (while (and (not (eobp)) (re-search-forward pattern nil t))
783
		(let ((entry (log-edit-changelog-entry)))
784 785 786 787 788 789 790
                  (if (< (elt entry 1) (max (1+ pos) (point)))
                      ;; This is not relevant, actually.
                      nil
                    (push entry texts))
                  ;; Make sure we make progress.
                  (setq pos (max (1+ pos) (elt entry 1)))
		  (goto-char pos)))
Stefan Monnier's avatar
Stefan Monnier committed
791 792 793

	      (cons (current-buffer) texts))))))))

794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
(defun log-edit-changelog-insert-entries (buffer beg end &rest files)
  "Insert the text from BUFFER between BEG and END.
Rename relative filenames in the ChangeLog entry as FILES."
  (let ((opoint (point))
	(log-name (buffer-file-name buffer))
	(case-fold-search nil)
	bound)
    (insert-buffer-substring buffer beg end)
    (setq bound (point-marker))
    (when log-name
      (dolist (f files)
	(save-excursion
	  (goto-char opoint)
	  (when (re-search-forward
		 (concat "\\(^\\|[ \t]\\)\\("
			 (file-relative-name f (file-name-directory log-name))
			 "\\)[, :\n]")
		 bound t)
	    (replace-match f t t nil 2)))))
    ;; Eliminate tabs at the beginning of the line.
    (save-excursion
      (goto-char opoint)
      (while (re-search-forward "^\\(\t+\\)" bound t)
	(replace-match "")))))
Stefan Monnier's avatar
Stefan Monnier committed
818

819
(defun log-edit-insert-changelog-entries (files)
Stefan Monnier's avatar
Stefan Monnier committed
820
  "Given a list of files FILES, insert the ChangeLog entries for them."
821 822
  (let ((log-entries nil)
        (log-edit-author nil))
823 824 825
    ;; Note that any ChangeLog entry can apply to more than one file.
    ;; Here we construct a log-entries list with elements of the form
    ;;   ((LOGBUFFER ENTRYSTART ENTRYEND) FILE1 FILE2...)
Stefan Monnier's avatar
Stefan Monnier committed
826
    (dolist (file files)
827
      (let* ((entries (log-edit-changelog-entries file))
828 829 830 831 832 833 834 835 836 837 838
	     (buf (car entries))
	     key entry)
	(dolist (region (cdr entries))
	  (setq key (cons buf region))
	  (if (setq entry (assoc key log-entries))
	      (setcdr entry (append (cdr entry) (list file)))
	    (push (list key file) log-entries)))))
    ;; Now map over log-entries, and extract the strings.
    (dolist (log-entry (nreverse log-entries))
      (apply 'log-edit-changelog-insert-entries
	     (append (car log-entry) (cdr log-entry)))
839 840
      (insert "\n"))
    log-edit-author))
Stefan Monnier's avatar
Stefan Monnier committed
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
(defun log-edit-extract-headers (headers comment)
  "Extract headers from COMMENT to form command line arguments.
HEADERS should be an alist with elements of the form (HEADER . CMDARG)
associating header names to the corresponding cmdline option name and the
result is then a list of the form (MSG CMDARG1 HDRTEXT1 CMDARG2 HDRTEXT2...).
where MSG is the remaining text from STRING.
If \"Summary\" is not in HEADERS, then the \"Summary\" header is extracted
anyway and put back as the first line of MSG."
  (with-temp-buffer
    (insert comment)
    (rfc822-goto-eoh)
    (narrow-to-region (point-min) (point))
    (let ((case-fold-search t)
          (summary ())
          (res ()))
      (dolist (header (if (assoc "Summary" headers) headers
                        (cons '("Summary" . t) headers)))
        (goto-char (point-min))
        (while (re-search-forward (concat "^" (car header)
                                          ":" log-edit-header-contents-regexp)
                                  nil t)
          (if (eq t (cdr header))
              (setq summary (match-string 1))
            (push (match-string 1) res)
            (push (or (cdr header) (car header)) res))
          (replace-match "" t t)))
      ;; Remove header separator if the header is empty.
      (widen)
870
      (goto-char (point-min))
871 872 873 874
      (when (looking-at "\\([ \t]*\n\\)+")
        (delete-region (match-beginning 0) (match-end 0)))
      (if summary (insert summary "\n"))
      (cons (buffer-string) res))))
875

Stefan Monnier's avatar
Stefan Monnier committed
876
(provide 'log-edit)
877

Stefan Monnier's avatar
Stefan Monnier committed
878
;;; log-edit.el ends here