add-log.el 16.6 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; add-log.el --- change log maintenance commands for Emacs

3
;; Copyright (C) 1985, 1986, 1988, 1993, 1994 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

Eric S. Raymond's avatar
Eric S. Raymond committed
5 6
;; Keywords: maint

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 20 21 22
;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

23 24 25 26
;;; Commentary:

;; This facility is documented in the Emacs Manual.

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

(defvar change-log-default-name nil
  "*Name of a change log file for \\[add-change-log-entry].")

32 33 34 35 36 37
(defvar add-log-current-defun-function nil
  "\
*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'
instead) with no arguments.  It returns a string or nil if it cannot guess.")

38 39
;; This MUST not be autoloaded, since user-login-name
;; cannot be known at Emacs dump time.
40 41 42 43
(defvar add-log-full-name (user-full-name)
  "*Full name of user, for inclusion in ChangeLog daily headers.
This defaults to the value returned by the `user-full-name' function.")

44 45
;; This MUST not be autoloaded, since user-login-name
;; cannot be known at Emacs dump time.
46
(defvar add-log-mailing-address user-mail-address
47
  "*Electronic mail address of user, for inclusion in ChangeLog daily headers.
48
This defaults to the value of `user-mail-address'.")
49

Eric S. Raymond's avatar
Eric S. Raymond committed
50 51
(defun change-log-name ()
  (or change-log-default-name
52 53 54
      (if (eq system-type 'vax-vms) 
	  "$CHANGE_LOG$.TXT" 
	(if (eq system-type 'ms-dos)
55
	    "changelo"
56
	  "ChangeLog"))))
Eric S. Raymond's avatar
Eric S. Raymond committed
57

58
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
59 60 61 62 63 64 65
(defun prompt-for-change-log-name ()
  "Prompt for a change log name."
  (let ((default (change-log-name)))
    (expand-file-name
     (read-file-name (format "Log file (default %s): " default)
		     nil default))))

66 67 68
;;;###autoload
(defun find-change-log (&optional file-name)
  "Find a change log file for \\[add-change-log-entry] and return the name.
69 70

Optional arg FILE-NAME specifies the file to use.
71
If FILE-NAME is nil, use the value of `change-log-default-name' if non-nil.
72 73
Otherwise, search in the current directory and its successive parents
for a file named `ChangeLog' (or whatever we use on this operating system).
74 75 76

Once a file is found, `change-log-default-name' is set locally in the
current buffer to the complete file name."
77 78
  ;; If user specified a file name or if this buffer knows which one to use,
  ;; just use that.
79
  (or file-name
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
      (setq file-name change-log-default-name)
      (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.
	    (setq file1 (expand-file-name 
			 (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)
116

Eric S. Raymond's avatar
Eric S. Raymond committed
117
;;;###autoload
118
(defun add-change-log-entry (&optional whoami file-name other-window new-entry)
Eric S. Raymond's avatar
Eric S. Raymond committed
119 120 121
  "Find change log file and add an entry for today.
Optional arg (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'.
122 123 124
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;
never append to an existing entry."
Eric S. Raymond's avatar
Eric S. Raymond committed
125 126
  (interactive (list current-prefix-arg
		     (prompt-for-change-log-name)))
127 128 129
  (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
130 131 132 133
	 ;; 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.
134 135 136 137 138
	(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)))
	paragraph-end entry)
139 140

    (setq file-name (find-change-log file-name))
141 142 143 144 145 146 147 148 149 150 151 152

    ;; 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))
	 (setq entry (if (string-match
			  (concat "^" (regexp-quote (file-name-directory
						     file-name)))
			  buffer-file-name)
			 (substring buffer-file-name (match-end 0))
		       (file-name-nondirectory buffer-file-name))))

Eric S. Raymond's avatar
Eric S. Raymond committed
153 154 155
    (if (and other-window (not (equal file-name buffer-file-name)))
	(find-file-other-window file-name)
      (find-file file-name))
156 157
    (or (eq major-mode 'change-log-mode)
	(change-log-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
158 159
    (undo-boundary)
    (goto-char (point-min))
160
    (if (looking-at (concat (regexp-quote (substring (current-time-string)
161
						     0 10))
162 163
			    ".* " (regexp-quote add-log-full-name)
			    "  (" (regexp-quote add-log-mailing-address)))
164 165
	(forward-line 1)
      (insert (current-time-string)
166 167
	      "  " add-log-full-name
	      "  (" add-log-mailing-address ")\n\n"))
168

169
    ;; Search only within the first paragraph.
170 171 172
    (if (looking-at "\n*[^\n* \t]")
	(skip-chars-forward "\n")
      (forward-paragraph 1))
173
    (setq paragraph-end (point))
Eric S. Raymond's avatar
Eric S. Raymond committed
174
    (goto-char (point-min))
175

176
    ;; Now insert the new line for this entry.
177 178 179 180
    (cond ((re-search-forward "^\\s *\\*\\s *$" paragraph-end t)
	   ;; Put this file name into the existing empty entry.
	   (if entry
	       (insert entry)))
181 182
	  ((and (not new-entry)
		(re-search-forward
183 184 185 186 187 188 189
		 (concat (regexp-quote (concat "* " entry))
			 ;; Don't accept `foo.bar' when
			 ;; looking for `foo':
			 "\\(\\s \\|[(),:]\\)")
		 paragraph-end t))
	   ;; Add to the existing entry for the same file.
	   (re-search-forward "^\\s *$\\|^\\s \\*")
190
	   (beginning-of-line)
191
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
192 193 194
	     (delete-region (point) (save-excursion (forward-line 1) (point))))
	   (insert "\n\n")
	   (forward-line -2)
Roland McGrath's avatar
Roland McGrath committed
195
	   (indent-relative-maybe))
Eric S. Raymond's avatar
Eric S. Raymond committed
196
	  (t
Roland McGrath's avatar
Roland McGrath committed
197 198 199 200
	   ;; Make a new entry.
	   (forward-line 1)
	   (while (looking-at "\\sW")
	     (forward-line 1))
201
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
202 203 204
	     (delete-region (point) (save-excursion (forward-line 1) (point))))
	   (insert "\n\n\n")
	   (forward-line -2)
Roland McGrath's avatar
Roland McGrath committed
205 206
	   (indent-to left-margin)
	   (insert "* " (or entry ""))))
207
    ;; Now insert the function name, if we have one.
Eric S. Raymond's avatar
Eric S. Raymond committed
208 209 210 211
    ;; 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
212
	  ;; Make it easy to get rid of the function name.
Eric S. Raymond's avatar
Eric S. Raymond committed
213
	  (undo-boundary)
Roland McGrath's avatar
Roland McGrath committed
214 215 216 217 218 219
	  (insert (if (save-excursion
			(beginning-of-line 1)
			(looking-at "\\s *$")) 
		      ""
		    " ")
		  "(" defun "): "))
220
      ;; No function name, so put in a colon unless we have just a star.
Roland McGrath's avatar
Roland McGrath committed
221 222 223
      (if (not (save-excursion
		 (beginning-of-line 1)
		 (looking-at "\\s *\\(\\*\\s *\\)?$")))
224
	  (insert ": ")))))
Eric S. Raymond's avatar
Eric S. Raymond committed
225 226 227 228

;;;###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.
229 230 231
Optional arg (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'."
Eric S. Raymond's avatar
Eric S. Raymond committed
232 233 234 235
  (interactive (if current-prefix-arg
		   (list current-prefix-arg
			 (prompt-for-change-log-name))))
  (add-change-log-entry whoami file-name t))
236
;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
Eric S. Raymond's avatar
Eric S. Raymond committed
237

238
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
239
(defun change-log-mode ()
240
  "Major mode for editing change logs; like Indented Text Mode.
241
Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
Roland McGrath's avatar
Roland McGrath committed
242 243 244
New log entries are usually made with \\[add-change-log-entry] or \\[add-change-log-entry-other-window].
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
245 246 247
  (interactive)
  (kill-all-local-variables)
  (indented-text-mode)
248 249 250 251
  (setq major-mode 'change-log-mode
	mode-name "Change Log"
	left-margin 8
	fill-column 74)
252
  (use-local-map change-log-mode-map)
Eric S. Raymond's avatar
Eric S. Raymond committed
253
  ;; Let each entry behave as one paragraph:
254 255
  (set (make-local-variable 'paragraph-start) "^\\s *$\\|^\f")
  (set (make-local-variable 'paragraph-separate) "^\\s *$\\|^\f\\|^\\sw")
Eric S. Raymond's avatar
Eric S. Raymond committed
256
  ;; Let all entries for one day behave as one page.
257 258
  ;; Match null string on the date-line so that the date-line
  ;; is grouped with what follows.
259
  (set (make-local-variable 'page-delimiter) "^\\<\\|^\f")
Roland McGrath's avatar
Roland McGrath committed
260 261
  (set (make-local-variable 'version-control) 'never)
  (set (make-local-variable 'adaptive-fill-regexp) "\\s *")
Eric S. Raymond's avatar
Eric S. Raymond committed
262 263
  (run-hooks 'change-log-mode-hook))

264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
(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))
  (define-key change-log-mode-map "\M-q" 'change-log-fill-paragraph))

;; 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")
  (let ((paragraph-separate (concat paragraph-separate "\\|^\\s *\\s("))
	(paragraph-start (concat paragraph-start "\\|^\\s *\\s(")))
    (fill-paragraph justify)))

Eric S. Raymond's avatar
Eric S. Raymond committed
283
(defvar add-log-current-defun-header-regexp
284
  "^\\([A-Z][A-Z_ ]*[A-Z_]\\|[-_a-zA-Z]+\\)[ \t]*[:=]"
Eric S. Raymond's avatar
Eric S. Raymond committed
285 286
  "*Heuristic regexp used by `add-log-current-defun' for unknown major modes.")

287
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
288 289 290
(defun add-log-current-defun ()
  "Return name of function definition point is in, or nil.

291 292
Understands C, Lisp, LaTeX (\"functions\" are chapters, sections, ...),
Texinfo (@node titles), and Fortran.
Eric S. Raymond's avatar
Eric S. Raymond committed
293 294 295 296 297 298 299

Other modes are handled by a heuristic that looks in the 10K before
point for uppercase headings starting in the first column or
identifiers followed by `:' or `=', see variable
`add-log-current-defun-header-regexp'.

Has a preference of looking backwards."
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
  (condition-case nil
      (save-excursion
	(let ((location (point)))
	  (cond ((memq major-mode '(emacs-lisp-mode lisp-mode scheme-mode))
		 ;; If we are now precisely a the beginning of a defun,
		 ;; 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.
		 (if (and (progn (end-of-defun)
				 (< location (point)))
			  (progn (forward-sexp -1)
				 (>= location (point))))
		     (progn
315 316 317
		       (if (looking-at "\\s(")
			   (forward-char 1))
		       (forward-sexp 1)
318 319 320
		       (skip-chars-forward " ")
		       (buffer-substring (point)
					 (progn (forward-sexp 1) (point))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
321
		((and (memq major-mode '(c-mode c++-mode c++-c-mode))
322 323 324 325 326
		      (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)) ?\\)
Roland McGrath's avatar
Roland McGrath committed
327
					(forward-line -1))
328 329 330 331 332 333 334 335 336
				      (looking-at "[ \t]*#[ \t]*define[ \t]")))
		 ;; 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))))
Richard M. Stallman's avatar
Richard M. Stallman committed
337
		((memq major-mode '(c-mode c++-mode c++-c-mode))
338 339 340 341 342 343 344 345 346 347 348 349 350
		 (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
351

352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
			 (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
					(forward-line 1)
					(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))))
			   ;; Ordinary C function syntax.
			   (setq beg (point))
			   (if (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.
			       (if (and (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))
				   (buffer-substring (point)
						     (progn (backward-sexp 1)
							    (point))))))))))
		((memq major-mode
		       '(TeX-mode plain-TeX-mode LaTeX-mode;; tex-mode.el
				  plain-tex-mode latex-mode;; cmutex.el
				  ))
		 (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)
		 (if (re-search-backward "^@node[ \t]+\\([^,]+\\)," nil t)
		     (buffer-substring (match-beginning 1)
				       (match-end 1))))
423 424 425 426 427 428 429 430
                ((eq major-mode 'fortran-mode)
                 ;; must be inside function body for this to work
                 (beginning-of-fortran-subprogram)
                 (let ((case-fold-search t)) ; case-insensitive
                   ;; search for fortran subprogram start
                   (if (re-search-forward
			 "^[ \t]*\\(program\\|subroutine\\|function\
\\|[ \ta-z0-9*]*[ \t]+function\\)"
431
			 nil t)
432 433 434 435 436 437 438 439 440 441
                       (progn
                         ;; move to EOL or before first left paren
                         (if (re-search-forward "[(\n]" nil t)
			     (progn (forward-char -1)
				    (skip-chars-backward " \t"))
			   (end-of-line))
			 ;; Use the name preceding that.
                         (buffer-substring (point)
                                           (progn (forward-sexp -1)
                                                  (point)))))))
442 443 444 445 446 447 448 449 450 451
		(t
		 ;; If all else fails, try heuristics
		 (let (case-fold-search)
		   (end-of-line)
		   (if (re-search-backward add-log-current-defun-header-regexp
					   (- (point) 10000)
					   t)
		       (buffer-substring (match-beginning 1)
					 (match-end 1))))))))
    (error nil)))
Jim Blandy's avatar
Jim Blandy committed
452 453


454 455
(provide 'add-log)

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