1 ;;; add-log.el --- change log maintenance commands for Emacs
3 ;; Copyright (C) 1985, 86, 88, 93, 94, 97, 98, 2000, 2003
4 ;; Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
28 ;; This facility is documented in the Emacs Manual.
35 (defgroup change-log nil
36 "Change log maintenance"
38 :link
'(custom-manual "(emacs)Change Log")
43 (defcustom change-log-default-name nil
44 "*Name of a change log file for \\[add-change-log-entry]."
45 :type
'(choice (const :tag
"default" nil
)
49 (defcustom change-log-mode-hook nil
50 "Normal hook run by `change-log-mode'."
54 ;; Many modes set this variable, so avoid warnings.
56 (defcustom add-log-current-defun-function nil
57 "*If non-nil, function to guess name of surrounding function.
58 It is used by `add-log-current-defun' in preference to built-in rules.
59 Returns function's name as a string, or nil if outside a function."
60 :type
'(choice (const nil
) function
)
64 (defcustom add-log-full-name nil
65 "*Full name of user, for inclusion in ChangeLog daily headers.
66 This defaults to the value returned by the function `user-full-name'."
67 :type
'(choice (const :tag
"Default" nil
)
72 (defcustom add-log-mailing-address nil
73 "*Electronic mail addresses of user, for inclusion in ChangeLog headers.
74 This defaults to the value of `user-mail-address'. In addition to
75 being a simple string, this value can also be a list. All elements
76 will be recognized as referring to the same user; when creating a new
77 ChangeLog entry, one element will be chosen at random."
78 :type
'(choice (const :tag
"Default" nil
)
79 (string :tag
"String")
80 (repeat :tag
"List of Strings" string
))
83 (defcustom add-log-time-format
'add-log-iso8601-time-string
84 "*Function that defines the time format.
85 For example, `add-log-iso8601-time-string', which gives the
86 date in international ISO 8601 format,
87 and `current-time-string' are two valid values."
88 :type
'(radio (const :tag
"International ISO 8601 format"
89 add-log-iso8601-time-string
)
90 (const :tag
"Old format, as returned by `current-time-string'"
92 (function :tag
"Other"))
95 (defcustom add-log-keep-changes-together nil
96 "*If non-nil, normally keep day's log entries for one file together.
98 Log entries for a given file made with \\[add-change-log-entry] or
99 \\[add-change-log-entry-other-window] will only be added to others \
101 today if this variable is non-nil or that file comes first in today's
102 entries. Otherwise another entry for that file will be started. An
106 * bar (...): change 1
108 in the latter case, \\[add-change-log-entry-other-window] in a \
109 buffer visiting `bar', yields:
113 * bar (...): change 1
118 * bar (...): change 1
121 The NEW-ENTRY arg to `add-change-log-entry' can override the effect of
127 (defcustom add-log-always-start-new-record nil
128 "*If non-nil, `add-change-log-entry' will always start a new record."
133 (defcustom add-log-buffer-file-name-function nil
134 "*If non-nil, function to call to identify the full filename of a buffer.
135 This function is called with no argument. If this is nil, the default is to
136 use `buffer-file-name'."
137 :type
'(choice (const nil
) function
)
140 (defcustom add-log-file-name-function nil
141 "*If non-nil, function to call to identify the filename for a ChangeLog entry.
142 This function is called with one argument, the value of variable
143 `buffer-file-name' in that buffer. If this is nil, the default is to
144 use the file's name relative to the directory of the change log file."
145 :type
'(choice (const nil
) function
)
149 (defcustom change-log-version-info-enabled nil
150 "*If non-nil, enable recording version numbers with the changes."
155 (defcustom change-log-version-number-regexp-list
156 (let ((re "\\([0-9]+\.[0-9.]+\\)"))
158 ;; (defconst ad-version "2.15"
159 (concat "^(def[^ \t\n]+[ \t]+[^ \t\n][ \t]\"" re
)
160 ;; Revision: pcl-cvs.el,v 1.72 1999/09/05 20:21:54 monnier Exp
161 (concat "^;+ *Revision: +[^ \t\n]+[ \t]+" re
)))
162 "*List of regexps to search for version number.
163 The version number must be in group 1.
164 Note: The search is conducted only within 10%, at the beginning of the file."
166 :type
'(repeat regexp
)
169 (defface change-log-date-face
170 '((t (:inherit font-lock-string-face
)))
171 "Face used to highlight dates in date lines."
175 (defface change-log-name-face
176 '((t (:inherit font-lock-constant-face
)))
177 "Face for highlighting author names."
181 (defface change-log-email-face
182 '((t (:inherit font-lock-variable-name-face
)))
183 "Face for highlighting author email addresses."
187 (defface change-log-file-face
188 '((t (:inherit font-lock-function-name-face
)))
189 "Face for highlighting file names."
193 (defface change-log-list-face
194 '((t (:inherit font-lock-keyword-face
)))
195 "Face for highlighting parenthesized lists of functions or variables."
199 (defface change-log-conditionals-face
200 '((t (:inherit font-lock-variable-name-face
)))
201 "Face for highlighting conditionals of the form `[...]'."
205 (defface change-log-function-face
206 '((t (:inherit font-lock-variable-name-face
)))
207 "Face for highlighting items of the form `<....>'."
211 (defface change-log-acknowledgement-face
212 '((t (:inherit font-lock-comment-face
)))
213 "Face for highlighting acknowledgments."
217 (defvar change-log-font-lock-keywords
219 ;; Date lines, new and old styles.
220 ("^\\sw.........[0-9:+ ]*"
221 (0 'change-log-date-face
)
222 ;; Name and e-mail; some people put e-mail in parens, not angles.
223 ("\\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.-]+@[A-Za-z0-9_.-]+\\)[>)]" nil nil
224 (1 'change-log-name-face
)
225 (2 'change-log-email-face
)))
228 ("^\t\\* \\([^ ,:([\n]+\\)"
229 (1 'change-log-file-face
)
230 ;; Possibly further names in a list:
231 ("\\=, \\([^ ,:([\n]+\\)" nil nil
(1 'change-log-file-face
))
232 ;; Possibly a parenthesized list of names:
233 ("\\= (\\([^) ,:\n]+\\)" nil nil
(1 'change-log-list-face
))
234 ("\\=, *\\([^) ,:\n]+\\)" nil nil
(1 'change-log-list-face
)))
236 ;; Function or variable names.
237 ("^\t(\\([^) ,:\n]+\\)"
238 (1 'change-log-list-face
)
239 ("\\=, *\\([^) ,:\n]+\\)" nil nil
(1 'change-log-list-face
)))
242 ("\\[!?\\([^]\n]+\\)\\]\\(:\\| (\\)" (1 'change-log-conditionals-face
))
244 ;; Function of change.
245 ("<\\([^>\n]+\\)>\\(:\\| (\\)" (1 'change-log-function-face
))
248 ("\\(^\t\\| \\)\\(From\\|Patch\\(es\\)? by\\|Report\\(ed by\\| from\\)\\|Suggest\\(ed by\\|ion from\\)\\)"
249 2 'change-log-acknowledgement-face
))
250 "Additional expressions to highlight in Change Log mode.")
252 (defvar change-log-mode-map
253 (let ((map (make-sparse-keymap)))
254 (define-key map
[?\C-c ?\C-p
] 'add-log-edit-prev-comment
)
255 (define-key map
[?\C-c ?\C-n
] 'add-log-edit-next-comment
)
257 "Keymap for Change Log major mode.")
259 (defvar change-log-time-zone-rule nil
260 "Time zone used for calculating change log time stamps.
261 It takes the same format as the TZ argument of `set-time-zone-rule'.
262 If nil, use local time.")
264 (defun add-log-iso8601-time-zone (time)
265 (let* ((utc-offset (or (car (current-time-zone time
)) 0))
266 (sign (if (< utc-offset
0) ?- ?
+))
267 (sec (abs utc-offset
))
272 (format (cond ((not (zerop ss
)) "%c%02d:%02d:%02d")
273 ((not (zerop mm
)) "%c%02d:%02d")
277 (defun add-log-iso8601-time-string ()
278 (if change-log-time-zone-rule
279 (let ((tz (getenv "TZ"))
280 (now (current-time)))
283 (set-time-zone-rule change-log-time-zone-rule
)
285 (format-time-string "%Y-%m-%d " now
)
286 (add-log-iso8601-time-zone now
)))
287 (set-time-zone-rule tz
)))
288 (format-time-string "%Y-%m-%d")))
290 (defun change-log-name ()
291 "Return (system-dependent) default name for a change log file."
292 (or change-log-default-name
293 (if (eq system-type
'vax-vms
)
297 (defun add-log-edit-prev-comment (arg)
298 "Cycle backward through Log-Edit mode comment history.
299 With a numeric prefix ARG, go back ARG comments."
302 (narrow-to-region (point)
303 (if (memq last-command
'(add-log-edit-prev-comment
304 add-log-edit-next-comment
))
306 (when (fboundp 'log-edit-previous-comment
)
307 (log-edit-previous-comment arg
)
308 (indent-region (point-min) (point-max))
309 (goto-char (point-min))
310 (unless (save-restriction (widen) (bolp))
311 (delete-region (point) (progn (skip-chars-forward " \t\n") (point))))
312 (set-mark (point-min))
313 (goto-char (point-max))
314 (delete-region (point) (progn (skip-chars-backward " \t\n") (point))))))
316 (defun add-log-edit-next-comment (arg)
317 "Cycle forward through Log-Edit mode comment history.
318 With a numeric prefix ARG, go back ARG comments."
320 (add-log-edit-prev-comment (- arg
)))
323 (defun prompt-for-change-log-name ()
324 "Prompt for a change log name."
325 (let* ((default (change-log-name))
326 (name (expand-file-name
327 (read-file-name (format "Log file (default %s): " default
)
329 ;; Handle something that is syntactically a directory name.
330 ;; Look for ChangeLog or whatever in that directory.
331 (if (string= (file-name-nondirectory name
) "")
332 (expand-file-name (file-name-nondirectory default
)
334 ;; Handle specifying a file that is a directory.
335 (if (file-directory-p name
)
336 (expand-file-name (file-name-nondirectory default
)
337 (file-name-as-directory name
))
340 (defun change-log-version-number-search ()
341 "Return version number of current buffer's file.
342 This is the value returned by `vc-workfile-version' or, if that is
343 nil, by matching `change-log-version-number-regexp-list'."
344 (let* ((size (buffer-size))
346 ;; The version number can be anywhere in the file, but
347 ;; restrict search to the file beginning: 10% should be
348 ;; enough to prevent some mishits.
350 ;; Apply percentage only if buffer size is bigger than
352 (if (> size
(* 100 80)) (+ (point) (/ size
10)))))
353 (or (and buffer-file-name
(vc-workfile-version buffer-file-name
))
356 (let ((regexps change-log-version-number-regexp-list
)
360 (goto-char (point-min))
361 (when (re-search-forward (pop regexps
) limit t
)
362 (setq version
(match-string 1)
368 (defun find-change-log (&optional file-name buffer-file
)
369 "Find a change log file for \\[add-change-log-entry] and return the name.
371 Optional arg FILE-NAME specifies the file to use.
372 If FILE-NAME is nil, use the value of `change-log-default-name'.
373 If 'change-log-default-name' is nil, behave as though it were 'ChangeLog'
374 \(or whatever we use on this operating system).
376 If 'change-log-default-name' contains a leading directory component, then
377 simply find it in the current directory. Otherwise, search in the current
378 directory and its successive parents for a file so named.
380 Once a file is found, `change-log-default-name' is set locally in the
381 current buffer to the complete file name.
382 Optional arg BUFFER-FILE overrides `buffer-file-name'."
383 ;; If user specified a file name or if this buffer knows which one to use,
386 (setq file-name
(and change-log-default-name
387 (file-name-directory change-log-default-name
)
388 change-log-default-name
))
390 ;; Chase links in the source file
391 ;; and use the change log in the dir where it points.
392 (setq file-name
(or (and (or buffer-file buffer-file-name
)
395 (or buffer-file buffer-file-name
))))
397 (if (file-directory-p file-name
)
398 (setq file-name
(expand-file-name (change-log-name) file-name
)))
399 ;; Chase links before visiting the file.
400 ;; This makes it easier to use a single change log file
401 ;; for several related directories.
402 (setq file-name
(file-chase-links file-name
))
403 (setq file-name
(expand-file-name file-name
))
404 ;; Move up in the dir hierarchy till we find a change log file.
405 (let ((file1 file-name
)
407 (while (and (not (or (get-file-buffer file1
) (file-exists-p file1
)))
408 (progn (setq parent-dir
411 (file-name-directory file1
))))
412 ;; Give up if we are already at the root dir.
413 (not (string= (file-name-directory file1
)
415 ;; Move up to the parent dir and try again.
416 (setq file1
(expand-file-name
417 (file-name-nondirectory (change-log-name))
419 ;; If we found a change log in a parent, use that.
420 (if (or (get-file-buffer file1
) (file-exists-p file1
))
421 (setq file-name file1
)))))
422 ;; Make a local variable in this buffer so we needn't search again.
423 (set (make-local-variable 'change-log-default-name
) file-name
)
426 (defun add-log-file-name (buffer-file log-file
)
427 ;; Never want to add a change log entry for the ChangeLog file itself.
428 (unless (or (null buffer-file
) (string= buffer-file log-file
))
429 (if add-log-file-name-function
430 (funcall add-log-file-name-function buffer-file
)
433 (concat "^" (regexp-quote (file-name-directory log-file
)))
435 (substring buffer-file
(match-end 0))
436 (file-name-nondirectory buffer-file
)))
437 ;; If we have a backup file, it's presumably because we're
438 ;; comparing old and new versions (e.g. for deleted
439 ;; functions) and we'll want to use the original name.
440 (if (backup-file-name-p buffer-file
)
441 (file-name-sans-versions buffer-file
)
445 (defun add-change-log-entry (&optional whoami file-name other-window new-entry
)
446 "Find change log file, and add an entry for today and an item for this file.
447 Optional arg WHOAMI (interactive prefix) non-nil means prompt for user
450 Second arg FILE-NAME is file name of the change log.
451 If nil, use the value of `change-log-default-name'.
453 Third arg OTHER-WINDOW non-nil means visit in other window.
455 Fourth arg NEW-ENTRY non-nil means always create a new entry at the front;
456 never append to an existing entry. Option `add-log-keep-changes-together'
457 otherwise affects whether a new entry is created.
459 Option `add-log-always-start-new-record' non-nil means always create a
460 new record, even when the last record was made on the same date and by
463 The change log file can start with a copyright notice and a copying
464 permission notice. The first blank line indicates the end of these
467 Today's date is calculated according to `change-log-time-zone-rule' if
468 non-nil, otherwise in local time."
469 (interactive (list current-prefix-arg
470 (prompt-for-change-log-name)))
471 (or add-log-full-name
472 (setq add-log-full-name
(user-full-name)))
473 (or add-log-mailing-address
474 (setq add-log-mailing-address user-mail-address
))
477 (setq add-log-full-name
(read-input "Full name: " add-log-full-name
))
478 ;; Note that some sites have room and phone number fields in
479 ;; full name which look silly when inserted. Rather than do
480 ;; anything about that here, let user give prefix argument so that
481 ;; s/he can edit the full name field in prompter if s/he wants.
482 (setq add-log-mailing-address
483 (read-input "Mailing address: " add-log-mailing-address
))))
485 (let* ((defun (add-log-current-defun))
486 (version (and change-log-version-info-enabled
487 (change-log-version-number-search)))
488 (buf-file-name (if add-log-buffer-file-name-function
489 (funcall add-log-buffer-file-name-function
)
491 (buffer-file (if buf-file-name
(expand-file-name buf-file-name
)))
492 (file-name (expand-file-name
493 (or file-name
(find-change-log file-name buffer-file
))))
494 ;; Set ITEM to the file name to use in the new item.
495 (item (add-log-file-name buffer-file file-name
))
498 (unless (equal file-name buffer-file-name
)
499 (if (or other-window
(window-dedicated-p (selected-window)))
500 (find-file-other-window file-name
)
501 (find-file file-name
)))
502 (or (eq major-mode
'change-log-mode
)
505 (goto-char (point-min))
507 ;; If file starts with a copyright and permission notice, skip them.
508 ;; Assume they end at first blank line.
509 (when (looking-at "Copyright")
510 (search-forward "\n\n")
511 (skip-chars-forward "\n"))
513 ;; Advance into first entry if it is usable; else make new one.
514 (let ((new-entries (mapcar (lambda (addr)
515 (concat (funcall add-log-time-format
)
516 " " add-log-full-name
518 (if (consp add-log-mailing-address
)
519 add-log-mailing-address
520 (list add-log-mailing-address
)))))
521 (if (and (not add-log-always-start-new-record
)
523 (dolist (entry new-entries hit
)
524 (when (looking-at (regexp-quote entry
))
527 (insert (nth (random (length new-entries
))
532 ;; Determine where we should stop searching for a usable
533 ;; item to add to, within this entry.
536 (if (looking-at "\n*[^\n* \t]")
537 (skip-chars-forward "\n")
538 (if add-log-keep-changes-together
539 (forward-page) ; page delimits entries for date
540 (forward-paragraph))) ; paragraph delimits entries for file
543 ;; Now insert the new line for this item.
544 (cond ((re-search-forward "^\\s *\\*\\s *$" bound t
)
545 ;; Put this file name into the existing empty item.
548 ((and (not new-entry
)
549 (let (case-fold-search)
551 (concat (regexp-quote (concat "* " item
))
552 ;; Don't accept `foo.bar' when
553 ;; looking for `foo':
554 "\\(\\s \\|[(),:]\\)")
556 ;; Add to the existing item for the same file.
557 (re-search-forward "^\\s *$\\|^\\s \\*")
558 (goto-char (match-beginning 0))
559 ;; Delete excess empty lines; make just 2.
560 (while (and (not (eobp)) (looking-at "^\\s *$"))
561 (delete-region (point) (line-beginning-position 2)))
564 (indent-relative-maybe))
567 (while (looking-at "\\sW")
569 (while (and (not (eobp)) (looking-at "^\\s *$"))
570 (delete-region (point) (line-beginning-position 2)))
573 (indent-to left-margin
)
575 (if item
(insert item
))))
576 ;; Now insert the function name, if we have one.
577 ;; Point is at the item for this file,
578 ;; either at the end of the line or at the first blank line.
580 ;; No function name, so put in a colon unless we have just a star.
581 (unless (save-excursion
582 (beginning-of-line 1)
583 (looking-at "\\s *\\(\\*\\s *\\)?$"))
585 (if version
(insert version ?\
)))
586 ;; Make it easy to get rid of the function name.
588 (unless (save-excursion
589 (beginning-of-line 1)
590 (looking-at "\\s *$"))
592 ;; See if the prev function name has a message yet or not.
593 ;; If not, merge the two items.
594 (let ((pos (point-marker)))
595 (skip-syntax-backward " ")
596 (skip-chars-backward "):")
597 (if (and (looking-at "):")
598 (let ((pos (save-excursion (backward-sexp 1) (point))))
599 (when (equal (buffer-substring pos
(point)) defun
)
600 (delete-region pos
(point)))
601 (> fill-column
(+ (current-column) (length defun
) 4))))
602 (progn (skip-chars-backward ", ")
603 (delete-region (point) pos
)
604 (unless (memq (char-before) '(?\
()) (insert ", ")))
605 (if (looking-at "):")
606 (delete-region (+ 1 (point)) (line-end-position)))
609 (set-marker pos nil
))
611 (if version
(insert version ?\
)))))
614 (defun add-change-log-entry-other-window (&optional whoami file-name
)
615 "Find change log file in other window and add entry and item.
616 This is just like `add-change-log-entry' except that it displays
617 the change log file in another window."
618 (interactive (if current-prefix-arg
619 (list current-prefix-arg
620 (prompt-for-change-log-name))))
621 (add-change-log-entry whoami file-name t
))
622 ;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
624 (defvar add-log-indent-text
0)
626 (defun add-log-indent ()
630 (skip-chars-forward " \t")
632 ((and (looking-at "\\(.*\\) [^ \n].*[^ \n] <.*>$")
633 ;; Matching the output of add-log-time-format is difficult,
634 ;; but I'll get it has at least two adjacent digits.
635 (string-match "[[:digit:]][[:digit:]]" (match-string 1)))
637 ((looking-at "[^*(]")
638 (+ (current-left-margin) add-log-indent-text
))
639 (t (current-left-margin)))))
640 (pos (save-excursion (indent-line-to indent
) (point))))
641 (if (> pos
(point)) (goto-char pos
))))
644 (defvar smerge-resolve-function
)
647 (define-derived-mode change-log-mode text-mode
"Change Log"
648 "Major mode for editing change logs; like Indented Text Mode.
649 Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
650 New log entries are usually made with \\[add-change-log-entry] or \\[add-change-log-entry-other-window].
651 Each entry behaves as a paragraph, and the entries for one day as a page.
652 Runs `change-log-mode-hook'.
653 \\{change-log-mode-map}"
658 (set (make-local-variable 'fill-paragraph-function
)
659 'change-log-fill-paragraph
)
660 (set (make-local-variable 'indent-line-function
) 'add-log-indent
)
661 (set (make-local-variable 'tab-always-indent
) nil
)
662 ;; We really do want "^" in paragraph-start below: it is only the
663 ;; lines that begin at column 0 (despite the left-margin of 8) that
664 ;; we are looking for. Adding `* ' allows eliding the blank line
665 ;; between entries for different files.
666 (set (make-local-variable 'paragraph-start
) "\\s *$\\|\f\\|^\\<")
667 (set (make-local-variable 'paragraph-separate
) paragraph-start
)
668 ;; Match null string on the date-line so that the date-line
669 ;; is grouped with what follows.
670 (set (make-local-variable 'page-delimiter
) "^\\<\\|^\f")
671 (set (make-local-variable 'version-control
) 'never
)
672 (set (make-local-variable 'smerge-resolve-function
)
673 'change-log-resolve-conflict
)
674 (set (make-local-variable 'adaptive-fill-regexp
) "\\s *")
675 (set (make-local-variable 'font-lock-defaults
)
676 '(change-log-font-lock-keywords t nil nil backward-paragraph
)))
678 ;; It might be nice to have a general feature to replace this. The idea I
679 ;; have is a variable giving a regexp matching text which should not be
680 ;; moved from bol by filling. change-log-mode would set this to "^\\s *\\s(".
681 ;; But I don't feel up to implementing that today.
682 (defun change-log-fill-paragraph (&optional justify
)
683 "Fill the paragraph, but preserve open parentheses at beginning of lines.
684 Prefix arg means justify as well."
686 (let ((end (progn (forward-paragraph) (point)))
687 (beg (progn (backward-paragraph) (point)))
688 (paragraph-start (concat paragraph-start
"\\|\\s *\\s(")))
689 (fill-region beg end justify
)
692 (defcustom add-log-current-defun-header-regexp
693 "^\\([[:upper:]][[:upper:]_ ]*[[:upper:]_]\\|[-_[:alpha:]]+\\)[ \t]*[:=]"
694 "*Heuristic regexp used by `add-log-current-defun' for unknown major modes."
699 (defvar add-log-lisp-like-modes
700 '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode
)
701 "*Modes that look like Lisp to `add-log-current-defun'.")
704 (defvar add-log-c-like-modes
705 '(c-mode c
++-mode c
++-c-mode objc-mode
)
706 "*Modes that look like C to `add-log-current-defun'.")
709 (defvar add-log-tex-like-modes
710 '(TeX-mode plain-TeX-mode LaTeX-mode plain-tex-mode latex-mode
)
711 "*Modes that look like TeX to `add-log-current-defun'.")
714 (defun add-log-current-defun ()
715 "Return name of function definition point is in, or nil.
717 Understands C, Lisp, LaTeX (\"functions\" are chapters, sections, ...),
718 Texinfo (@node titles) and Perl.
720 Other modes are handled by a heuristic that looks in the 10K before
721 point for uppercase headings starting in the first column or
722 identifiers followed by `:' or `='. See variables
723 `add-log-current-defun-header-regexp' and
724 `add-log-current-defun-function'.
726 Has a preference of looking backwards."
729 (let ((location (point)))
730 (cond (add-log-current-defun-function
731 (funcall add-log-current-defun-function
))
732 ((memq major-mode add-log-lisp-like-modes
)
733 ;; If we are now precisely at the beginning of a defun,
734 ;; make sure beginning-of-defun finds that one
735 ;; rather than the previous one.
736 (or (eobp) (forward-char 1))
738 ;; Make sure we are really inside the defun found,
740 (when (and (looking-at "\\s(")
741 (progn (end-of-defun)
742 (< location
(point)))
743 (progn (forward-sexp -
1)
744 (>= location
(point))))
745 (if (looking-at "\\s(")
747 ;; Skip the defining construct name, typically "defun"
750 ;; The second element is usually a symbol being defined.
751 ;; If it is not, use the first symbol in it.
752 (skip-chars-forward " \t\n'(")
753 (buffer-substring-no-properties (point)
754 (progn (forward-sexp 1)
756 ((and (memq major-mode add-log-c-like-modes
)
759 ;; Use eq instead of = here to avoid
760 ;; error when at bob and char-after
762 (while (eq (char-after (- (point) 2)) ?
\\)
764 (looking-at "[ \t]*#[ \t]*define[ \t]")))
765 ;; Handle a C macro definition.
767 (while (eq (char-after (- (point) 2)) ?
\\) ;not =; note above
769 (search-forward "define")
770 (skip-chars-forward " \t")
771 (buffer-substring-no-properties (point)
772 (progn (forward-sexp 1)
774 ((memq major-mode add-log-c-like-modes
)
776 ;; See if we are in the beginning part of a function,
777 ;; before the open brace. If so, advance forward.
778 (while (not (looking-at "{\\|\\(\\s *$\\)"))
783 (when (progn (end-of-defun)
784 (< location
(point)))
789 ;; Skip back over typedefs of arglist.
790 (while (and (not (bobp))
791 (looking-at "[ \t\n]"))
793 ;; See if this is using the DEFUN macro used in Emacs,
794 ;; or the DEFUN macro used by the C library.
795 (if (condition-case nil
798 (while (= (preceding-char) ?
\\)
803 (looking-at "DEFUN\\b"))
809 (if (= (char-after (point)) ?
\")
812 (skip-chars-forward " ,")))
813 (buffer-substring-no-properties
815 (progn (forward-sexp 1)
817 (if (looking-at "^[+-]")
818 (change-log-get-method-definition)
819 ;; Ordinary C function syntax.
822 ;; Protect against "Unbalanced parens" error.
825 (down-list 1) ; into arglist
827 (skip-chars-backward " \t")
830 ;; Verify initial pos was after
831 ;; real start of function.
834 ;; For this purpose, include the line
835 ;; that has the decl keywords. This
836 ;; may also include some of the
837 ;; comments before the function.
838 (while (and (not (bobp))
841 (looking-at "[^\n\f]")))
843 (>= location
(point)))
844 ;; Consistency check: going down and up
845 ;; shouldn't take us back before BEG.
848 ;; Don't include any final whitespace
849 ;; in the name we use.
850 (skip-chars-backward " \t\n")
853 ;; Now find the right beginning of the name.
854 ;; Include certain keywords if they
856 (setq middle
(point))
858 ;; Ignore these subparts of a class decl
859 ;; and move back to the class name itself.
860 (while (looking-at "public \\|private ")
861 (skip-chars-backward " \t:")
864 (setq middle
(point))
868 "enum \\|struct \\|union \\|class ")
869 (setq middle
(point)))
871 (when (eq (preceding-char) ?
=)
873 (skip-chars-backward " \t")
875 (buffer-substring-no-properties
877 ((memq major-mode add-log-tex-like-modes
)
878 (if (re-search-backward
879 "\\\\\\(sub\\)*\\(section\\|paragraph\\|chapter\\)"
882 (goto-char (match-beginning 0))
883 (buffer-substring-no-properties
884 (1+ (point)) ; without initial backslash
885 (line-end-position)))))
886 ((eq major-mode
'texinfo-mode
)
887 (if (re-search-backward "^@node[ \t]+\\([^,\n]+\\)" nil t
)
888 (match-string-no-properties 1)))
889 ((memq major-mode
'(perl-mode cperl-mode
))
890 (if (re-search-backward "^sub[ \t]+\\([^({ \t\n]+\\)" nil t
)
891 (match-string-no-properties 1)))
892 ;; Emacs's autoconf-mode installs its own
893 ;; `add-log-current-defun-function'. This applies to
894 ;; a different mode apparently for editing .m4
896 ((eq major-mode
'autoconf-mode
)
897 (if (re-search-backward
898 "^\\(\\(m4_\\)?define\\|A._DEFUN\\)(\\[?\\([A-Za-z0-9_]+\\)" nil t
)
899 (match-string-no-properties 3)))
901 ;; If all else fails, try heuristics
902 (let (case-fold-search
905 (when (re-search-backward
906 add-log-current-defun-header-regexp
909 (setq result
(or (match-string-no-properties 1)
910 (match-string-no-properties 0)))
911 ;; Strip whitespace away
912 (when (string-match "\\([^ \t\n\r\f].*[^ \t\n\r\f]\\)"
914 (setq result
(match-string-no-properties 1 result
)))
918 (defvar change-log-get-method-definition-md
)
920 ;; Subroutine used within change-log-get-method-definition.
921 ;; Add the last match in the buffer to the end of `md',
922 ;; followed by the string END; move to the end of that match.
923 (defun change-log-get-method-definition-1 (end)
924 (setq change-log-get-method-definition-md
925 (concat change-log-get-method-definition-md
928 (goto-char (match-end 0)))
930 (defun change-log-get-method-definition ()
931 "For objective C, return the method name if we are in a method."
932 (let ((change-log-get-method-definition-md "["))
934 (if (re-search-backward "^@implementation\\s-*\\([A-Za-z_]*\\)" nil t
)
935 (change-log-get-method-definition-1 " ")))
938 ((re-search-forward "^\\([-+]\\)[ \t\n\f\r]*\\(([^)]*)\\)?\\s-*" nil t
)
939 (change-log-get-method-definition-1 "")
940 (while (not (looking-at "[{;]"))
942 "\\([A-Za-z_]*:?\\)\\s-*\\(([^)]*)\\)?[A-Za-z_]*[ \t\n\f\r]*")
943 (change-log-get-method-definition-1 ""))
944 (concat change-log-get-method-definition-md
"]"))))))
946 (defun change-log-sortable-date-at ()
947 "Return date of log entry in a consistent form for sorting.
948 Point is assumed to be at the start of the entry."
950 (if (looking-at "^\\sw.........[0-9:+ ]*")
951 (let ((date (match-string-no-properties 0)))
953 (if (string-match "\\(....\\)-\\(..\\)-\\(..\\)\\s-+" date
)
954 (concat (match-string 1 date
) (match-string 2 date
)
955 (match-string 3 date
))
957 (timezone-make-date-sortable date
)
961 (defun change-log-resolve-conflict ()
962 "Function to be used in `smerge-resolve-function'."
963 (let ((buf (current-buffer)))
965 (insert-buffer-substring buf
(match-beginning 1) (match-end 1))
966 (save-match-data (change-log-mode))
967 (let ((other-buf (current-buffer)))
968 (with-current-buffer buf
971 (narrow-to-region (match-beginning 0) (match-end 0))
972 (replace-match (match-string 3) t t
)
973 (change-log-merge other-buf
))))))))
976 (defun change-log-merge (other-log)
977 "Merge the contents of ChangeLog file OTHER-LOG with this buffer.
978 Both must be found in Change Log mode (since the merging depends on
979 the appropriate motion commands). OTHER-LOG can be either a file name
982 Entries are inserted in chronological order. Both the current and
983 old-style time formats for entries are supported."
984 (interactive "*fLog file name to merge: ")
985 (if (not (eq major-mode
'change-log-mode
))
986 (error "Not in Change Log mode"))
987 (let ((other-buf (if (bufferp other-log
) other-log
988 (find-file-noselect other-log
)))
989 (buf (current-buffer))
992 (goto-char (point-min))
993 (set-buffer other-buf
)
994 (goto-char (point-min))
995 (if (not (eq major-mode
'change-log-mode
))
996 (error "%s not found in Change Log mode" other-log
))
997 ;; Loop through all the entries in OTHER-LOG.
999 (setq date1
(change-log-sortable-date-at))
1001 end
(progn (forward-page) (point)))
1002 ;; Look for an entry in original buffer that isn't later.
1003 (with-current-buffer buf
1004 (while (and (not (eobp))
1005 (string< date1
(change-log-sortable-date-at)))
1008 (insert-buffer-substring other-buf start end
)
1009 ;; At the end of the original buffer, insert a newline to
1010 ;; separate entries and then the rest of the file being
1013 (and (= ?
\n (char-before))
1014 (or (<= (1- (point)) (point-min))
1015 (= ?
\n (char-before (1- (point)))))))
1017 ;; Move to the end of it to terminate outer loop.
1018 (with-current-buffer other-buf
1019 (goto-char (point-max)))
1020 (insert-buffer-substring other-buf start
)))))))
1023 (defun change-log-redate ()
1024 "Fix any old-style date entries in the current log file to default format."
1028 (goto-char (point-min))
1029 (while (re-search-forward "^\\sw.........[0-9:+ ]*" nil t
)
1030 (unless (= 12 (- (match-end 0) (match-beginning 0)))
1031 (let* ((date (save-match-data
1032 (timezone-fix-time (match-string 0) nil nil
)))
1033 (zone (if (consp (aref date
6))
1034 (nth 1 (aref date
6)))))
1035 (replace-match (format-time-string
1037 (encode-time (aref date
5)
1047 ;;; add-log.el ends here