1 ;; add-log.el --- change log maintenance commands for Emacs
3 ;; Copyright (C) 1985, 86, 88, 93, 94, 97, 1998 Free Software Foundation, Inc.
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
26 ;; This facility is documented in the Emacs Manual.
30 (eval-when-compile (require 'fortran
))
32 (defgroup change-log nil
33 "Change log maintenance"
35 :link
'(custom-manual "(emacs)Change Log")
40 (defcustom change-log-default-name nil
41 "*Name of a change log file for \\[add-change-log-entry]."
42 :type
'(choice (const :tag
"default" nil
)
46 (defcustom add-log-current-defun-function nil
48 *If non-nil, function to guess name of current function from surrounding text.
49 \\[add-change-log-entry] calls this function (if nil, `add-log-current-defun'
50 instead) with no arguments. It returns a string or nil if it cannot guess."
55 (defcustom add-log-full-name nil
56 "*Full name of user, for inclusion in ChangeLog daily headers.
57 This defaults to the value returned by the `user-full-name' function."
58 :type
'(choice (const :tag
"Default" nil
)
63 (defcustom add-log-mailing-address nil
64 "*Electronic mail address of user, for inclusion in ChangeLog daily headers.
65 This defaults to the value of `user-mail-address'."
66 :type
'(choice (const :tag
"Default" nil
)
70 (defcustom add-log-time-format
'add-log-iso8601-time-string
71 "*Function that defines the time format.
72 For example, `add-log-iso8601-time-string', which gives the
73 date in international ISO 8601 format,
74 and `current-time-string' are two valid values."
75 :type
'(radio (const :tag
"International ISO 8601 format"
76 add-log-iso8601-time-string
)
77 (const :tag
"Old format, as returned by `current-time-string'"
79 (function :tag
"Other"))
82 (defcustom add-log-keep-changes-together nil
83 "*If non-nil, normally keep day's log entries for one file together.
85 Log entries for a given file made with \\[add-change-log-entry] or
86 \\[add-change-log-entry-other-window] will only be added to others \
88 today if this variable is non-nil or that file comes first in today's
89 entries. Otherwise another entry for that file will be started. An
95 in the latter case, \\[add-change-log-entry-other-window] in a \
96 buffer visiting `bar', yields:
100 * bar (...): change 1
105 * bar (...): change 1
108 The NEW-ENTRY arg to `add-change-log-entry' can override the effect of
114 (defvar change-log-font-lock-keywords
116 ;; Date lines, new and old styles.
117 ("^\\sw.........[0-9:+ ]*"
118 (0 font-lock-string-face
)
119 ("\\([^<]+\\)<\\([A-Za-z0-9_.-]+@[A-Za-z0-9_.-]+\\)>" nil nil
120 (1 font-lock-constant-face
)
121 (2 font-lock-variable-name-face
)))
124 ("^\t\\* \\([^ ,:([\n]+\\)"
125 (1 font-lock-function-name-face
)
126 ("\\=, \\([^ ,:([\n]+\\)" nil nil
(1 font-lock-function-name-face
)))
128 ;; Function or variable names.
130 (1 font-lock-keyword-face
)
131 ("\\=, *\\([^) ,:\n]+\\)" nil nil
(1 font-lock-keyword-face
)))
134 ("\\[!?\\([^]\n]+\\)\\]\\(:\\| (\\)" (1 font-lock-variable-name-face
))
137 ("^\t\\(From\\|Patch\\(es\\)? by\\|Report\\(ed by\\| from\\)\\|Suggest\\(ed by\\|ion from\\)\\)"
138 1 font-lock-comment-face
)
139 (" \\(From\\|Patch\\(es\\)? by\\|Report\\(ed by\\| from\\)\\|Suggest\\(ed by\\|ion from\\)\\)"
140 1 font-lock-comment-face
))
141 "Additional expressions to highlight in Change Log mode.")
143 (defvar change-log-mode-map nil
144 "Keymap for Change Log major mode.")
145 (if change-log-mode-map
147 (setq change-log-mode-map
(make-sparse-keymap)))
149 (defvar change-log-time-zone-rule nil
150 "Time zone used for calculating change log time stamps.
151 It takes the same format as the TZ argument of `set-time-zone-rule'.
152 If nil, use local time.")
154 (defvar add-log-debugging
)
156 (defun add-log-iso8601-time-zone (time)
157 (let* ((utc-offset (or (car (current-time-zone time
)) 0))
158 (sign (if (< utc-offset
0) ?- ?
+))
159 (sec (abs utc-offset
))
164 (format (cond ((not (zerop ss
)) "%c%02d:%02d:%02d")
165 ((not (zerop mm
)) "%c%02d:%02d")
169 (defun add-log-iso8601-time-string ()
170 (if change-log-time-zone-rule
171 (let ((tz (getenv "TZ"))
172 (now (current-time)))
176 change-log-time-zone-rule
)
178 (format-time-string "%Y-%m-%d " now
)
179 (add-log-iso8601-time-zone now
)))
180 (set-time-zone-rule tz
)))
181 (format-time-string "%Y-%m-%d")))
183 (defun change-log-name ()
184 (or change-log-default-name
185 (if (eq system-type
'vax-vms
)
190 (defun prompt-for-change-log-name ()
191 "Prompt for a change log name."
192 (let* ((default (change-log-name))
193 (name (expand-file-name
194 (read-file-name (format "Log file (default %s): " default
)
196 ;; Handle something that is syntactically a directory name.
197 ;; Look for ChangeLog or whatever in that directory.
198 (if (string= (file-name-nondirectory name
) "")
199 (expand-file-name (file-name-nondirectory default
)
201 ;; Handle specifying a file that is a directory.
202 (if (file-directory-p name
)
203 (expand-file-name (file-name-nondirectory default
)
204 (file-name-as-directory name
))
208 (defun find-change-log (&optional file-name
)
209 "Find a change log file for \\[add-change-log-entry] and return the name.
211 Optional arg FILE-NAME specifies the file to use.
212 If FILE-NAME is nil, use the value of `change-log-default-name'.
213 If 'change-log-default-name' is nil, behave as though it were 'ChangeLog'
214 \(or whatever we use on this operating system).
216 If 'change-log-default-name' contains a leading directory component, then
217 simply find it in the current directory. Otherwise, search in the current
218 directory and its successive parents for a file so named.
220 Once a file is found, `change-log-default-name' is set locally in the
221 current buffer to the complete file name."
222 ;; If user specified a file name or if this buffer knows which one to use,
225 (setq file-name
(and change-log-default-name
226 (file-name-directory change-log-default-name
)
227 change-log-default-name
))
229 ;; Chase links in the source file
230 ;; and use the change log in the dir where it points.
231 (setq file-name
(or (and buffer-file-name
233 (file-chase-links buffer-file-name
)))
235 (if (file-directory-p file-name
)
236 (setq file-name
(expand-file-name (change-log-name) file-name
)))
237 ;; Chase links before visiting the file.
238 ;; This makes it easier to use a single change log file
239 ;; for several related directories.
240 (setq file-name
(file-chase-links file-name
))
241 (setq file-name
(expand-file-name file-name
))
242 ;; Move up in the dir hierarchy till we find a change log file.
243 (let ((file1 file-name
)
245 (while (and (not (or (get-file-buffer file1
) (file-exists-p file1
)))
246 (progn (setq parent-dir
249 (file-name-directory file1
))))
250 ;; Give up if we are already at the root dir.
251 (not (string= (file-name-directory file1
)
253 ;; Move up to the parent dir and try again.
254 (setq file1
(expand-file-name
255 (file-name-nondirectory (change-log-name))
257 ;; If we found a change log in a parent, use that.
258 (if (or (get-file-buffer file1
) (file-exists-p file1
))
259 (setq file-name file1
)))))
260 ;; Make a local variable in this buffer so we needn't search again.
261 (set (make-local-variable 'change-log-default-name
) file-name
)
265 (defun add-change-log-entry (&optional whoami file-name other-window new-entry
)
266 "Find change log file and add an entry for today.
267 Optional arg WHOAMI (interactive prefix) non-nil means prompt for user
270 Second arg is FILE-NAME of change log. If nil, uses `change-log-default-name'.
271 Third arg OTHER-WINDOW non-nil means visit in other window.
272 Fourth arg NEW-ENTRY non-nil means always create a new entry at the front;
273 never append to an existing entry. Option `add-log-keep-changes-together'
274 otherwise affects whether a new entry is created.
276 Today's date is calculated according to `change-log-time-zone-rule' if
277 non-nil, otherwise in local time."
278 (interactive (list current-prefix-arg
279 (prompt-for-change-log-name)))
280 (or add-log-full-name
281 (setq add-log-full-name
(user-full-name)))
282 (or add-log-mailing-address
283 (setq add-log-mailing-address user-mail-address
))
286 (setq add-log-full-name
(read-input "Full name: " add-log-full-name
))
287 ;; Note that some sites have room and phone number fields in
288 ;; full name which look silly when inserted. Rather than do
289 ;; anything about that here, let user give prefix argument so that
290 ;; s/he can edit the full name field in prompter if s/he wants.
291 (setq add-log-mailing-address
292 (read-input "Mailing address: " add-log-mailing-address
))))
293 (let ((defun (funcall (or add-log-current-defun-function
294 'add-log-current-defun
)))
297 (setq file-name
(expand-file-name (find-change-log file-name
)))
299 ;; Set ENTRY to the file name to use in the new entry.
300 (and buffer-file-name
301 ;; Never want to add a change log entry for the ChangeLog file itself.
302 (not (string= buffer-file-name file-name
))
303 (setq entry
(if (string-match
304 (concat "^" (regexp-quote (file-name-directory
307 (substring buffer-file-name
(match-end 0))
308 (file-name-nondirectory buffer-file-name
))))
310 (let ((buffer (find-buffer-visiting file-name
)))
311 (setq add-log-debugging
(list (gap-position) (gap-size))))
312 (if (and other-window
(not (equal file-name buffer-file-name
)))
313 (find-file-other-window file-name
)
314 (find-file file-name
))
315 (or (eq major-mode
'change-log-mode
)
318 (goto-char (point-min))
319 (let ((new-entry (concat (funcall add-log-time-format
)
320 " " add-log-full-name
321 " <" add-log-mailing-address
">")))
322 (if (looking-at (regexp-quote new-entry
))
324 (insert new-entry
"\n\n")))
328 (if (looking-at "\n*[^\n* \t]")
329 (skip-chars-forward "\n")
330 (if add-log-keep-changes-together
331 (forward-page) ; page delimits entries for date
332 (forward-paragraph))) ; paragraph delimits entries for file
334 (goto-char (point-min))
335 ;; Now insert the new line for this entry.
336 (cond ((re-search-forward "^\\s *\\*\\s *$" bound t
)
337 ;; Put this file name into the existing empty entry.
340 ((and (not new-entry
)
341 (let (case-fold-search)
343 (concat (regexp-quote (concat "* " entry
))
344 ;; Don't accept `foo.bar' when
345 ;; looking for `foo':
346 "\\(\\s \\|[(),:]\\)")
348 ;; Add to the existing entry for the same file.
349 (re-search-forward "^\\s *$\\|^\\s \\*")
350 (goto-char (match-beginning 0))
351 ;; Delete excess empty lines; make just 2.
352 (while (and (not (eobp)) (looking-at "^\\s *$"))
353 (delete-region (point) (save-excursion (forward-line 1) (point))))
356 (indent-relative-maybe))
360 (while (looking-at "\\sW")
362 (while (and (not (eobp)) (looking-at "^\\s *$"))
363 (delete-region (point) (save-excursion (forward-line 1) (point))))
366 (indent-to left-margin
)
367 (insert "* " (or entry
""))))
368 ;; Now insert the function name, if we have one.
369 ;; Point is at the entry for this file,
370 ;; either at the end of the line or at the first blank line.
373 ;; Make it easy to get rid of the function name.
375 (insert (if (save-excursion
376 (beginning-of-line 1)
377 (looking-at "\\s *$"))
381 ;; No function name, so put in a colon unless we have just a star.
382 (if (not (save-excursion
383 (beginning-of-line 1)
384 (looking-at "\\s *\\(\\*\\s *\\)?$")))
388 (defun add-change-log-entry-other-window (&optional whoami file-name
)
389 "Find change log file in other window and add an entry for today.
390 Optional arg WHOAMI (interactive prefix) non-nil means prompt for user
392 Second optional arg FILE-NAME is file name of change log.
393 If nil, use `change-log-default-name'.
395 Affected by the same options as `add-change-log-entry'."
396 (interactive (if current-prefix-arg
397 (list current-prefix-arg
398 (prompt-for-change-log-name))))
399 (add-change-log-entry whoami file-name t
))
400 ;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
403 (defun change-log-mode ()
404 "Major mode for editing change logs; like Indented Text Mode.
405 Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
406 New log entries are usually made with \\[add-change-log-entry] or \\[add-change-log-entry-other-window].
407 Each entry behaves as a paragraph, and the entries for one day as a page.
408 Runs `change-log-mode-hook'."
410 (kill-all-local-variables)
412 (setq major-mode
'change-log-mode
413 mode-name
"Change Log"
418 (use-local-map change-log-mode-map
)
419 (set (make-local-variable 'fill-paragraph-function
)
420 'change-log-fill-paragraph
)
421 ;; We really do want "^" in paragraph-start below: it is only the
422 ;; lines that begin at column 0 (despite the left-margin of 8) that
423 ;; we are looking for. Adding `* ' allows eliding the blank line
424 ;; between entries for different files.
425 (set (make-local-variable 'paragraph-start
) "\\s *$\\|\f\\|^\\<")
426 (set (make-local-variable 'paragraph-separate
) paragraph-start
)
427 ;; Match null string on the date-line so that the date-line
428 ;; is grouped with what follows.
429 (set (make-local-variable 'page-delimiter
) "^\\<\\|^\f")
430 (set (make-local-variable 'version-control
) 'never
)
431 (set (make-local-variable 'adaptive-fill-regexp
) "\\s *")
432 (set (make-local-variable 'font-lock-defaults
)
433 '(change-log-font-lock-keywords t
))
434 (run-hooks 'change-log-mode-hook
))
436 ;; It might be nice to have a general feature to replace this. The idea I
437 ;; have is a variable giving a regexp matching text which should not be
438 ;; moved from bol by filling. change-log-mode would set this to "^\\s *\\s(".
439 ;; But I don't feel up to implementing that today.
440 (defun change-log-fill-paragraph (&optional justify
)
441 "Fill the paragraph, but preserve open parentheses at beginning of lines.
442 Prefix arg means justify as well."
444 (let ((end (progn (forward-paragraph) (point)))
445 (beg (progn (backward-paragraph) (point)))
446 (paragraph-start (concat paragraph-start
"\\|\\s *\\s(")))
447 (fill-region beg end justify
)
450 (defcustom add-log-current-defun-header-regexp
451 "^\\([A-Z][A-Z_ ]*[A-Z_]\\|[-_a-zA-Z]+\\)[ \t]*[:=]"
452 "*Heuristic regexp used by `add-log-current-defun' for unknown major modes."
457 (defvar add-log-lisp-like-modes
458 '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode
)
459 "*Modes that look like Lisp to `add-log-current-defun'.")
462 (defvar add-log-c-like-modes
463 '(c-mode c
++-mode c
++-c-mode objc-mode
)
464 "*Modes that look like C to `add-log-current-defun'.")
467 (defvar add-log-tex-like-modes
468 '(TeX-mode plain-TeX-mode LaTeX-mode plain-tex-mode latex-mode
)
469 "*Modes that look like TeX to `add-log-current-defun'.")
472 (defun add-log-current-defun ()
473 "Return name of function definition point is in, or nil.
475 Understands C, Lisp, LaTeX (\"functions\" are chapters, sections, ...),
476 Texinfo (@node titles), Perl, and Fortran.
478 Other modes are handled by a heuristic that looks in the 10K before
479 point for uppercase headings starting in the first column or
480 identifiers followed by `:' or `=', see variable
481 `add-log-current-defun-header-regexp'.
483 Has a preference of looking backwards."
486 (let ((location (point)))
487 (cond ((memq major-mode add-log-lisp-like-modes
)
488 ;; If we are now precisely at the beginning of a defun,
489 ;; make sure beginning-of-defun finds that one
490 ;; rather than the previous one.
491 (or (eobp) (forward-char 1))
493 ;; Make sure we are really inside the defun found, not after it.
494 (when (and (looking-at "\\s(")
495 (progn (end-of-defun)
496 (< location
(point)))
497 (progn (forward-sexp -
1)
498 (>= location
(point))))
499 (if (looking-at "\\s(")
501 ;; Skip the defining construct name, typically "defun"
504 ;; The second element is usually a symbol being defined.
505 ;; If it is not, use the first symbol in it.
506 (skip-chars-forward " '(")
507 (buffer-substring (point)
508 (progn (forward-sexp 1)
510 ((and (memq major-mode add-log-c-like-modes
)
513 ;; Use eq instead of = here to avoid
514 ;; error when at bob and char-after
516 (while (eq (char-after (- (point) 2)) ?
\\)
518 (looking-at "[ \t]*#[ \t]*define[ \t]")))
519 ;; Handle a C macro definition.
521 (while (eq (char-after (- (point) 2)) ?
\\) ;not =; note above
523 (search-forward "define")
524 (skip-chars-forward " \t")
525 (buffer-substring (point)
526 (progn (forward-sexp 1) (point))))
527 ((memq major-mode add-log-c-like-modes
)
529 ;; See if we are in the beginning part of a function,
530 ;; before the open brace. If so, advance forward.
531 (while (not (looking-at "{\\|\\(\\s *$\\)"))
536 (if (progn (end-of-defun)
537 (< location
(point)))
543 ;; Skip back over typedefs of arglist.
544 (while (and (not (bobp))
545 (looking-at "[ \t\n]"))
547 ;; See if this is using the DEFUN macro used in Emacs,
548 ;; or the DEFUN macro used by the C library.
549 (if (condition-case nil
552 (while (= (preceding-char) ?
\\)
557 (looking-at "DEFUN\\b"))
563 (if (= (char-after (point)) ?
\")
566 (skip-chars-forward " ,")))
567 (buffer-substring (point)
568 (progn (forward-sexp 1) (point))))
569 (if (looking-at "^[+-]")
570 (change-log-get-method-definition)
571 ;; Ordinary C function syntax.
573 (if (and (condition-case nil
574 ;; Protect against "Unbalanced parens" error.
576 (down-list 1) ; into arglist
578 (skip-chars-backward " \t")
581 ;; Verify initial pos was after
582 ;; real start of function.
585 ;; For this purpose, include the line
586 ;; that has the decl keywords. This
587 ;; may also include some of the
588 ;; comments before the function.
589 (while (and (not (bobp))
592 (looking-at "[^\n\f]")))
594 (>= location
(point)))
595 ;; Consistency check: going down and up
596 ;; shouldn't take us back before BEG.
599 ;; Don't include any final newline
600 ;; in the name we use.
601 (if (= (preceding-char) ?
\n)
605 ;; Now find the right beginning of the name.
606 ;; Include certain keywords if they
608 (setq middle
(point))
610 ;; Ignore these subparts of a class decl
611 ;; and move back to the class name itself.
612 (while (looking-at "public \\|private ")
613 (skip-chars-backward " \t:")
616 (setq middle
(point))
619 (looking-at "struct \\|union \\|class ")
620 (setq middle
(point)))
621 (buffer-substring middle end
)))))))))
622 ((memq major-mode add-log-tex-like-modes
)
623 (if (re-search-backward
624 "\\\\\\(sub\\)*\\(section\\|paragraph\\|chapter\\)" nil t
)
626 (goto-char (match-beginning 0))
627 (buffer-substring (1+ (point));; without initial backslash
631 ((eq major-mode
'texinfo-mode
)
632 (if (re-search-backward "^@node[ \t]+\\([^,\n]+\\)" nil t
)
633 (buffer-substring (match-beginning 1)
635 ((eq major-mode
'perl-mode
)
636 (if (re-search-backward "^sub[ \t]+\\([^ \t\n]+\\)" nil t
)
637 (buffer-substring (match-beginning 1)
639 ((or (eq major-mode
'fortran-mode
)
640 ;; Needs work for f90, but better than nothing.
641 (eq major-mode
'f90-mode
))
642 ;; must be inside function body for this to work
643 (beginning-of-fortran-subprogram)
644 (let ((case-fold-search t
)) ; case-insensitive
645 ;; search for fortran subprogram start
646 (if (re-search-forward
647 "^[ \t]*\\(program\\|subroutine\\|function\
648 \\|[ \ta-z0-9*()]*[ \t]+function\\|\\(block[ \t]*data\\)\\)"
649 (save-excursion (end-of-fortran-subprogram)
654 ;; move to EOL or before first left paren
655 (if (re-search-forward "[(\n]" nil t
)
656 (progn (backward-char)
657 (skip-chars-backward " \t"))
659 ;; Use the name preceding that.
660 (buffer-substring (point)
661 (progn (backward-sexp)
665 ;; If all else fails, try heuristics
666 (let (case-fold-search)
668 (if (re-search-backward add-log-current-defun-header-regexp
671 (buffer-substring (match-beginning 1)
675 (defvar change-log-get-method-definition-md
)
677 ;; Subroutine used within change-log-get-method-definition.
678 ;; Add the last match in the buffer to the end of `md',
679 ;; followed by the string END; move to the end of that match.
680 (defun change-log-get-method-definition-1 (end)
681 (setq change-log-get-method-definition-md
682 (concat change-log-get-method-definition-md
683 (buffer-substring (match-beginning 1) (match-end 1))
685 (goto-char (match-end 0)))
687 ;; For objective C, return the method name if we are in a method.
688 (defun change-log-get-method-definition ()
689 (let ((change-log-get-method-definition-md "["))
691 (if (re-search-backward "^@implementation\\s-*\\([A-Za-z_]*\\)" nil t
)
692 (change-log-get-method-definition-1 " ")))
695 ((re-search-forward "^\\([-+]\\)[ \t\n\f\r]*\\(([^)]*)\\)?\\s-*" nil t
)
696 (change-log-get-method-definition-1 "")
697 (while (not (looking-at "[{;]"))
699 "\\([A-Za-z_]*:?\\)\\s-*\\(([^)]*)\\)?[A-Za-z_]*[ \t\n\f\r]*")
700 (change-log-get-method-definition-1 ""))
701 (concat change-log-get-method-definition-md
"]"))))))
706 ;;; add-log.el ends here