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

Roland McGrath's avatar
Roland McGrath committed
3 4
;; Copyright (C) 1985, 86, 87, 88, 89, 90, 91, 1992
;;	Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5 6 7 8 9

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

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

Eric S. Raymond's avatar
Eric S. Raymond committed
22
;;; Code:
Eric S. Raymond's avatar
Eric S. Raymond committed
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

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

(defun change-log-name ()
  (or change-log-default-name
      (if (eq system-type 'vax-vms) "$CHANGE_LOG$.TXT" "ChangeLog")))

(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))))

;;;###autoload
(defun add-change-log-entry (&optional whoami file-name other-window)
  "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'.
Third arg OTHER-WINDOW non-nil means visit in other window."
  (interactive (list current-prefix-arg
		     (prompt-for-change-log-name)))
Roland McGrath's avatar
Roland McGrath committed
47
  (let* ((full-name (if whoami
Eric S. Raymond's avatar
Eric S. Raymond committed
48 49 50 51 52 53 54 55 56 57 58
			(read-input "Full name: " (user-full-name))
		      (user-full-name)))
	 ;; Note that some sites have room and phone number fields in
	 ;; full name which look silly when inserted.  Rather than do
	 ;; anything about that here, let user give prefix argument so that
	 ;; s/he can edit the full name field in prompter if s/he wants.
	 (login-name (if whoami
			 (read-input "Login name: " (user-login-name))
		       (user-login-name)))
	 (site-name (if whoami
			(read-input "Site name: " (system-name))
Eric S. Raymond's avatar
Eric S. Raymond committed
59 60
		      (system-name)))
	 (defun (add-log-current-defun))
Roland McGrath's avatar
Roland McGrath committed
61
	 entry entry-position empty-entry)
Eric S. Raymond's avatar
Eric S. Raymond committed
62 63 64
    (or file-name
	(setq file-name (or change-log-default-name
			    default-directory)))
Roland McGrath's avatar
Roland McGrath committed
65 66 67
    (setq file-name (if (file-directory-p file-name)
			(expand-file-name (change-log-name) file-name)
		      (expand-file-name file-name)))
68 69 70 71
    ;; Chase links before visiting the file.
    ;; This makes it easier to use a single change log file
    ;; for several related directories.
    (setq file-name (or (file-symlink-p file-name) file-name))
Eric S. Raymond's avatar
Eric S. Raymond committed
72
    (set (make-local-variable 'change-log-default-name) file-name)
Roland McGrath's avatar
Roland McGrath committed
73 74 75 76 77 78 79
    (if buffer-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))))
80 81
    ;; Never want to add a change log entry for the ChangeLog file itself.
    (if (equal entry "ChangeLog")
Roland McGrath's avatar
Roland McGrath committed
82 83
	(setq entry nil
	      defun nil))
Eric S. Raymond's avatar
Eric S. Raymond committed
84 85 86 87 88
    (if (and other-window (not (equal file-name buffer-file-name)))
	(find-file-other-window file-name)
      (find-file file-name))
    (undo-boundary)
    (goto-char (point-min))
Roland McGrath's avatar
Roland McGrath committed
89 90 91 92 93 94
    (or (looking-at (concat (substring (current-time-string) 0 10)
				 ".* " full-name "  (" login-name "@"))
	(insert (current-time-string)
		"  " full-name
		"  (" login-name
		"@" site-name ")\n\n"))
Eric S. Raymond's avatar
Eric S. Raymond committed
95
    (goto-char (point-min))
Eric S. Raymond's avatar
Eric S. Raymond committed
96 97 98 99 100
    (setq empty-entry
	  (and (search-forward "\n\t* \n" nil t)
	       (1- (point))))
    (if (and entry
	     (not empty-entry))
Roland McGrath's avatar
Roland McGrath committed
101
	;; Look for today's entry for the same file.
Eric S. Raymond's avatar
Eric S. Raymond committed
102 103 104 105 106
	;; If there is an empty entry (just a `*'), take the hint and
	;; use it.  This is so that C-x a from the ChangeLog buffer
	;; itself can be used to force the next entry to be added at
	;; the beginning, even if there are today's entries for the
	;; same file (but perhaps different revisions).
Roland McGrath's avatar
Roland McGrath committed
107 108 109 110 111 112 113 114 115 116 117 118 119
	(let ((entry-boundary (save-excursion
				(and (re-search-forward "\n[A-Z]" nil t)
				     (point)))))
	  (setq entry-position (save-excursion
				 (and (re-search-forward
				       (concat
					(regexp-quote (concat "* " entry))
					;; don't accept `foo.bar' when
					;; looking for `foo':
					"[ \n\t,:]")
				       entry-boundary
				       t)
				      (1- (match-end 0)))))))
120
    ;; Now insert the new line for this entry.
Eric S. Raymond's avatar
Eric S. Raymond committed
121
    (cond (entry-position
Roland McGrath's avatar
Roland McGrath committed
122 123 124
	   ;; Move to the existing entry for the same file.
	   (goto-char entry-position)
	   (re-search-forward "^\\s *$")
125
	   (beginning-of-line)
126
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
127 128 129
	     (delete-region (point) (save-excursion (forward-line 1) (point))))
	   (insert "\n\n")
	   (forward-line -2)
Roland McGrath's avatar
Roland McGrath committed
130
	   (indent-relative-maybe))
Eric S. Raymond's avatar
Eric S. Raymond committed
131
	  (empty-entry
Roland McGrath's avatar
Roland McGrath committed
132 133 134 135
	   ;; Put this file name into the existing empty entry.
	   (goto-char empty-entry)
	   (if entry
	       (insert entry)))
Eric S. Raymond's avatar
Eric S. Raymond committed
136
	  (t
Roland McGrath's avatar
Roland McGrath committed
137 138 139 140
	   ;; Make a new entry.
	   (forward-line 1)
	   (while (looking-at "\\sW")
	     (forward-line 1))
141
	   (while (and (not (eobp)) (looking-at "^\\s *$"))
142 143 144
	     (delete-region (point) (save-excursion (forward-line 1) (point))))
	   (insert "\n\n\n")
	   (forward-line -2)
Roland McGrath's avatar
Roland McGrath committed
145 146
	   (indent-to left-margin)
	   (insert "* " (or entry ""))))
147
    ;; Now insert the function name, if we have one.
Eric S. Raymond's avatar
Eric S. Raymond committed
148 149 150 151
    ;; 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
152
	  ;; Make it easy to get rid of the function name.
Eric S. Raymond's avatar
Eric S. Raymond committed
153
	  (undo-boundary)
Roland McGrath's avatar
Roland McGrath committed
154 155 156 157 158 159
	  (insert (if (save-excursion
			(beginning-of-line 1)
			(looking-at "\\s *$")) 
		      ""
		    " ")
		  "(" defun "): "))
160
      ;; No function name, so put in a colon unless we have just a star.
Roland McGrath's avatar
Roland McGrath committed
161 162 163
      (if (not (save-excursion
		 (beginning-of-line 1)
		 (looking-at "\\s *\\(\\*\\s *\\)?$")))
164
	  (insert ": ")))))
Eric S. Raymond's avatar
Eric S. Raymond committed
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179

;;;###autoload
(define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)

;;;###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.
First arg (interactive prefix) non-nil means prompt for user name and site.
Second arg is file name of change log.
Interactively, with a prefix argument, the file name is prompted for."
  (interactive (if current-prefix-arg
		   (list current-prefix-arg
			 (prompt-for-change-log-name))))
  (add-change-log-entry whoami file-name t))

180
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
181
(defun change-log-mode ()
Roland McGrath's avatar
Roland McGrath committed
182
  "Major mode for editting change logs; like Indented Text Mode.
183
Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
Roland McGrath's avatar
Roland McGrath committed
184 185 186
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
187 188 189 190 191
  (interactive)
  (kill-all-local-variables)
  (indented-text-mode)
  (setq major-mode 'change-log-mode)
  (setq mode-name "Change Log")
Eric S. Raymond's avatar
Eric S. Raymond committed
192 193
  (setq left-margin 8)
  (setq fill-column 74)
Eric S. Raymond's avatar
Eric S. Raymond committed
194
  ;; Let each entry behave as one paragraph:
Roland McGrath's avatar
Roland McGrath committed
195 196
  (set (make-local-variable 'paragraph-start) "^\\s *$\\|^^L")
  (set (make-local-variable 'paragraph-separate) "^\\s *$\\|^^L\\|^\\sw")
Eric S. Raymond's avatar
Eric S. Raymond committed
197 198 199 200 201 202 203
  ;; Let all entries for one day behave as one page.
  ;; Note that a page boundary is also a paragraph boundary.
  ;; Unfortunately the date line of a page actually belongs to
  ;; the next day, but I don't see how to avoid that since
  ;; page moving cmds go to the end of the match, and Emacs
  ;; regexps don't have a context feature.
  (set (make-local-variable 'page-delimiter) "^[A-Z][a-z][a-z] .*\n\\|^")
Roland McGrath's avatar
Roland McGrath committed
204 205
  (set (make-local-variable 'version-control) 'never)
  (set (make-local-variable 'adaptive-fill-regexp) "\\s *")
Eric S. Raymond's avatar
Eric S. Raymond committed
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
  (run-hooks 'change-log-mode-hook))

(defvar add-log-current-defun-header-regexp
  "^\\([A-Z][A-Z_ ]+\\|[a-z_---A-Z]+\\)[ \t]*[:=]"
  "*Heuristic regexp used by `add-log-current-defun' for unknown major modes.")

(defun add-log-current-defun ()
  "Return name of function definition point is in, or nil.

Understands Lisp, LaTeX (\"functions\" are chapters, sections, ...),
Texinfo (@node titles), and C.

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."
  (save-excursion
225 226 227 228 229
    (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.
230
	     (or (eobp) (forward-char 1))
231 232
	     (beginning-of-defun)
	     ;; Make sure we are really inside the defun found, not after it.
233 234 235 236
	     (if (and (progn (end-of-defun)
			     (< location (point)))
		      (progn (forward-sexp -1)
			     (>= location (point))))
237 238 239 240 241
		 (progn
		   (forward-word 1)
		   (skip-chars-forward " ")
		   (buffer-substring (point)
				     (progn (forward-sexp 1) (point))))))
Roland McGrath's avatar
Roland McGrath committed
242
	    ((and (memq major-mode '(c-mode 'c++-mode))
243
		  (save-excursion (beginning-of-line)
Roland McGrath's avatar
Roland McGrath committed
244 245 246 247
				  ;; Use eq instead of = here to avoid
				  ;; error when at bob and char-after
				  ;; returns nil.
				  (while (eq (char-after (- (point) 2)) ?\\)
248 249 250 251 252 253 254 255 256 257
				    (forward-line -1))
				  (looking-at "[ \t]*#[ \t]*define[ \t]")))
	     ;; Handle a C macro definition.
	     (beginning-of-line)
	     (while (= (char-after (- (point) 2)) ?\\)
	       (forward-line -1))
	     (search-forward "define")
	     (skip-chars-forward " \t")
	     (buffer-substring (point)
			       (progn (forward-sexp 1) (point))))
Roland McGrath's avatar
Roland McGrath committed
258
	    ((memq major-mode '(c-mode 'c++-mode))
259 260
	     ;; See if we are in the beginning part of a function,
	     ;; before the open brace.  If so, advance forward.
Roland McGrath's avatar
Roland McGrath committed
261
	     (while (not (looking-at "{\\|\\(\\s *$\\)"))
262
	       (forward-line 1))
Roland McGrath's avatar
Roland McGrath committed
263 264
	     (or (eobp)
		 (forward-char 1))
265
	     (beginning-of-defun)
266 267
	     (if (progn (end-of-defun)
			(< location (point)))
268
		 (progn
269 270 271 272 273 274 275 276
		   (backward-sexp 1)
		   (let (beg tem)
		   
		     (forward-line -1)
		     ;; Skip back over typedefs of arglist.
		     (while (and (not (bobp))
				 (looking-at "[ \t\n]"))
		       (forward-line -1))
Roland McGrath's avatar
Roland McGrath committed
277 278
		     ;; See if this is using the DEFUN macro used in Emacs,
		     ;; or the DEFUN macro used by the C library.
279 280 281 282 283 284
		     (if (and (save-excursion
				(forward-line 1)
				(backward-sexp 1)
				(beginning-of-line)
				(setq tem (point))
				(looking-at "DEFUN\\b"))
285
			      (>= location tem))
286
			 (progn
287
			   (goto-char tem)
288
			   (down-list 1)
Roland McGrath's avatar
Roland McGrath committed
289 290 291 292
			   (if (= (char-after (point)) ?\")
			       (progn
				 (forward-sexp 1)
				 (skip-chars-forward " ,")))
293 294 295 296
			   (buffer-substring (point)
					     (progn (forward-sexp 1) (point))))
		       ;; Ordinary C function syntax.
		       (setq beg (point))
Roland McGrath's avatar
Roland McGrath committed
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
		       (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))))))))))
325 326 327 328 329 330 331 332 333 334 335 336 337 338
	    ((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)
Eric S. Raymond's avatar
Eric S. Raymond committed
339
		 (buffer-substring (match-beginning 1)
340 341 342 343 344 345 346 347 348
				   (match-end 1))))
	    (t
	     ;; If all else fails, try heuristics
	     (let (case-fold-search)
	       (if (re-search-backward add-log-current-defun-header-regexp
				       (- (point) 10000)
				       t)
		   (buffer-substring (match-beginning 1)
				     (match-end 1)))))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
349

Jim Blandy's avatar
Jim Blandy committed
350 351


352 353
(provide 'add-log)

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