;;; add-log.el --- change log maintenance commands for Emacs
-;; Copyright (C) 1985, 86, 88, 93, 94, 97, 98, 2000 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 86, 88, 93, 94, 97, 98, 2000, 03, 2004
+;; Free Software Foundation, Inc.
;; Maintainer: FSF
;; Keywords: tools
:type 'hook
:group 'change-log)
+;; Many modes set this variable, so avoid warnings.
+;;;###autoload
(defcustom add-log-current-defun-function nil
"*If non-nil, function to guess name of surrounding function.
It is used by `add-log-current-defun' in preference to built-in rules.
;;;###autoload
(defcustom add-log-mailing-address nil
- "*Electronic mail address of user, for inclusion in ChangeLog daily headers.
-This defaults to the value of `user-mail-address'."
+ "*Electronic mail addresses of user, for inclusion in ChangeLog headers.
+This defaults to the value of `user-mail-address'. In addition to
+being a simple string, this value can also be a list. All elements
+will be recognized as referring to the same user; when creating a new
+ChangeLog entry, one element will be chosen at random."
:type '(choice (const :tag "Default" nil)
- string)
+ (string :tag "String")
+ (repeat :tag "List of Strings" string))
:group 'change-log)
(defcustom add-log-time-format 'add-log-iso8601-time-string
(defcustom add-log-always-start-new-record nil
"*If non-nil, `add-change-log-entry' will always start a new record."
- :version "21.2"
+ :version "21.4"
:type 'boolean
:group 'change-log)
;; Possibly further names in a list:
("\\=, \\([^ ,:([\n]+\\)" nil nil (1 'change-log-file-face))
;; Possibly a parenthesized list of names:
- ("\\= (\\([^) ,:\n]+\\)" nil nil (1 'change-log-list-face))
- ("\\=, *\\([^) ,:\n]+\\)" nil nil (1 'change-log-list-face)))
+ ("\\= (\\([^() ,\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)"
+ nil nil (1 'change-log-list-face))
+ ("\\=, *\\([^() ,\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)"
+ nil nil (1 'change-log-list-face)))
;;
;; Function or variable names.
- ("^\t(\\([^) ,:\n]+\\)"
+ ("^\t(\\([^() ,\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)"
(1 'change-log-list-face)
- ("\\=, *\\([^) ,:\n]+\\)" nil nil (1 'change-log-list-face)))
+ ("\\=, *\\([^() ,\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)" nil nil
+ (1 'change-log-list-face)))
;;
;; Conditionals.
("\\[!?\\([^]\n]+\\)\\]\\(:\\| (\\)" (1 'change-log-conditionals-face))
2 'change-log-acknowledgement-face))
"Additional expressions to highlight in Change Log mode.")
-(defvar change-log-mode-map (make-sparse-keymap)
+(defvar change-log-mode-map
+ (let ((map (make-sparse-keymap)))
+ (define-key map [?\C-c ?\C-p] 'add-log-edit-prev-comment)
+ (define-key map [?\C-c ?\C-n] 'add-log-edit-next-comment)
+ map)
"Keymap for Change Log major mode.")
(defvar change-log-time-zone-rule nil
"$CHANGE_LOG$.TXT"
"ChangeLog")))
+(defun add-log-edit-prev-comment (arg)
+ "Cycle backward through Log-Edit mode comment history.
+With a numeric prefix ARG, go back ARG comments."
+ (interactive "*p")
+ (save-restriction
+ (narrow-to-region (point)
+ (if (memq last-command '(add-log-edit-prev-comment
+ add-log-edit-next-comment))
+ (mark) (point)))
+ (when (fboundp 'log-edit-previous-comment)
+ (log-edit-previous-comment arg)
+ (indent-region (point-min) (point-max))
+ (goto-char (point-min))
+ (unless (save-restriction (widen) (bolp))
+ (delete-region (point) (progn (skip-chars-forward " \t\n") (point))))
+ (set-mark (point-min))
+ (goto-char (point-max))
+ (delete-region (point) (progn (skip-chars-backward " \t\n") (point))))))
+
+(defun add-log-edit-next-comment (arg)
+ "Cycle forward through Log-Edit mode comment history.
+With a numeric prefix ARG, go back ARG comments."
+ (interactive "*p")
+ (add-log-edit-prev-comment (- arg)))
+
;;;###autoload
(defun prompt-for-change-log-name ()
"Prompt for a change log name."
This is the value returned by `vc-workfile-version' or, if that is
nil, by matching `change-log-version-number-regexp-list'."
(let* ((size (buffer-size))
- (end
+ (limit
;; The version number can be anywhere in the file, but
;; restrict search to the file beginning: 10% should be
;; enough to prevent some mishits.
;;
;; Apply percentage only if buffer size is bigger than
;; approx 100 lines.
- (if (> size (* 100 80))
- (/ size 10)
- size))
- version)
+ (if (> size (* 100 80)) (+ (point) (/ size 10)))))
(or (and buffer-file-name (vc-workfile-version buffer-file-name))
(save-restriction
(widen)
- (let ((regexps change-log-version-number-regexp-list))
+ (let ((regexps change-log-version-number-regexp-list)
+ version)
(while regexps
(save-excursion
(goto-char (point-min))
- (when (re-search-forward (pop regexps) end t)
+ (when (re-search-forward (pop regexps) limit t)
(setq version (match-string 1)
- regexps nil)))))))))
+ regexps nil))))
+ version)))))
;;;###autoload
(defun add-change-log-entry (&optional whoami file-name other-window new-entry)
"Find change log file, and add an entry for today and an item for this file.
Optional arg WHOAMI (interactive prefix) non-nil means prompt for user
-name and site.
+name and email (stored in `add-log-full-name' and `add-log-mailing-address').
Second arg FILE-NAME is file name of the change log.
If nil, use the value of `change-log-default-name'.
(funcall add-log-buffer-file-name-function)
buffer-file-name))
(buffer-file (if buf-file-name (expand-file-name buf-file-name)))
- (file-name (expand-file-name
- (or file-name (find-change-log file-name buffer-file))))
+ (file-name (expand-file-name (find-change-log file-name buffer-file)))
;; Set ITEM to the file name to use in the new item.
(item (add-log-file-name buffer-file file-name))
bound)
- (if (or (and other-window (not (equal file-name buffer-file-name)))
- (window-dedicated-p (selected-window)))
- (find-file-other-window file-name)
- (find-file file-name))
+ (unless (equal file-name buffer-file-name)
+ (if (or other-window (window-dedicated-p (selected-window)))
+ (find-file-other-window file-name)
+ (find-file file-name)))
(or (eq major-mode 'change-log-mode)
(change-log-mode))
(undo-boundary)
(skip-chars-forward "\n"))
;; Advance into first entry if it is usable; else make new one.
- (let ((new-entry (concat (funcall add-log-time-format)
- " " add-log-full-name
- " <" add-log-mailing-address ">")))
+ (let ((new-entries (mapcar (lambda (addr)
+ (concat (funcall add-log-time-format)
+ " " add-log-full-name
+ " <" addr ">"))
+ (if (consp add-log-mailing-address)
+ add-log-mailing-address
+ (list add-log-mailing-address)))))
(if (and (not add-log-always-start-new-record)
- (looking-at (regexp-quote new-entry)))
+ (let ((hit nil))
+ (dolist (entry new-entries hit)
+ (when (looking-at (regexp-quote entry))
+ (setq hit t)))))
(forward-line 1)
- (insert new-entry "\n\n")
+ (insert (nth (random (length new-entries))
+ new-entries)
+ "\n\n")
(forward-line -1)))
;; Determine where we should stop searching for a usable
;; Now insert the function name, if we have one.
;; Point is at the item for this file,
;; either at the end of the line or at the first blank line.
- (if defun
- (progn
- ;; Make it easy to get rid of the function name.
- (undo-boundary)
- (unless (save-excursion
- (beginning-of-line 1)
- (looking-at "\\s *$"))
- (insert ?\ ))
- ;; See if the prev function name has a message yet or not.
- ;; If not, merge the two items.
- (let ((pos (point-marker)))
- (if (and (skip-syntax-backward " ")
- (skip-chars-backward "):")
- (looking-at "):")
- (progn (delete-region (+ 1 (point)) (+ 2 (point))) t)
- (> fill-column (+ (current-column) (length defun) 3)))
- (progn (delete-region (point) pos)
- (insert ", "))
- (goto-char pos)
- (insert "("))
- (set-marker pos nil))
- (insert defun "): ")
- (if version
- (insert version ?\ )))
- ;; No function name, so put in a colon unless we have just a star.
+ (if (not defun)
+ ;; No function name, so put in a colon unless we have just a star.
+ (unless (save-excursion
+ (beginning-of-line 1)
+ (looking-at "\\s *\\(\\*\\s *\\)?$"))
+ (insert ": ")
+ (if version (insert version ?\ )))
+ ;; Make it easy to get rid of the function name.
+ (undo-boundary)
(unless (save-excursion
(beginning-of-line 1)
- (looking-at "\\s *\\(\\*\\s *\\)?$"))
- (insert ": ")
- (if version (insert version ?\ ))))))
+ (looking-at "\\s *$"))
+ (insert ?\ ))
+ ;; See if the prev function name has a message yet or not.
+ ;; If not, merge the two items.
+ (let ((pos (point-marker)))
+ (skip-syntax-backward " ")
+ (skip-chars-backward "):")
+ (if (and (looking-at "):")
+ (let ((pos (save-excursion (backward-sexp 1) (point))))
+ (when (equal (buffer-substring pos (point)) defun)
+ (delete-region pos (point)))
+ (> fill-column (+ (current-column) (length defun) 4))))
+ (progn (skip-chars-backward ", ")
+ (delete-region (point) pos)
+ (unless (memq (char-before) '(?\()) (insert ", ")))
+ (if (looking-at "):")
+ (delete-region (+ 1 (point)) (line-end-position)))
+ (goto-char pos)
+ (insert "("))
+ (set-marker pos nil))
+ (insert defun "): ")
+ (if version (insert version ?\ )))))
;;;###autoload
(defun add-change-log-entry-other-window (&optional whoami file-name)
(add-change-log-entry whoami file-name t))
;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
+(defvar add-log-indent-text 0)
+
+(defun add-log-indent ()
+ (let* ((indent
+ (save-excursion
+ (beginning-of-line)
+ (skip-chars-forward " \t")
+ (cond
+ ((and (looking-at "\\(.*\\) [^ \n].*[^ \n] <.*>$")
+ ;; Matching the output of add-log-time-format is difficult,
+ ;; but I'll get it has at least two adjacent digits.
+ (string-match "[[:digit:]][[:digit:]]" (match-string 1)))
+ 0)
+ ((looking-at "[^*(]")
+ (+ (current-left-margin) add-log-indent-text))
+ (t (current-left-margin)))))
+ (pos (save-excursion (indent-line-to indent) (point))))
+ (if (> pos (point)) (goto-char pos))))
+
+
+(defvar smerge-resolve-function)
+
;;;###autoload
-(defun change-log-mode ()
+(define-derived-mode change-log-mode text-mode "Change Log"
"Major mode for editing change logs; like Indented Text Mode.
Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
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'."
- (interactive)
- (kill-all-local-variables)
- (indented-text-mode)
- (setq major-mode 'change-log-mode
- mode-name "Change Log"
- left-margin 8
+Runs `change-log-mode-hook'.
+\\{change-log-mode-map}"
+ (setq left-margin 8
fill-column 74
indent-tabs-mode t
tab-width 8)
- (use-local-map change-log-mode-map)
(set (make-local-variable 'fill-paragraph-function)
'change-log-fill-paragraph)
+ (set (make-local-variable 'indent-line-function) 'add-log-indent)
+ (set (make-local-variable 'tab-always-indent) nil)
;; We really do want "^" in paragraph-start below: it is only the
;; lines that begin at column 0 (despite the left-margin of 8) that
;; we are looking for. Adding `* ' allows eliding the blank line
;; is grouped with what follows.
(set (make-local-variable 'page-delimiter) "^\\<\\|^\f")
(set (make-local-variable 'version-control) 'never)
+ (set (make-local-variable 'smerge-resolve-function)
+ 'change-log-resolve-conflict)
(set (make-local-variable 'adaptive-fill-regexp) "\\s *")
(set (make-local-variable 'font-lock-defaults)
- '(change-log-font-lock-keywords t nil nil backward-paragraph))
- (run-hooks 'change-log-mode-hook))
+ '(change-log-font-lock-keywords t nil nil backward-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
point for uppercase headings starting in the first column or
identifiers followed by `:' or `='. See variables
`add-log-current-defun-header-regexp' and
-`add-log-current-defun-function'
+`add-log-current-defun-function'.
Has a preference of looking backwards."
(condition-case nil
(if (re-search-backward "^@node[ \t]+\\([^,\n]+\\)" nil t)
(match-string-no-properties 1)))
((memq major-mode '(perl-mode cperl-mode))
- (if (re-search-backward "^sub[ \t]+\\([^ \t\n]+\\)" nil t)
+ (if (re-search-backward "^sub[ \t]+\\([^({ \t\n]+\\)" nil t)
(match-string-no-properties 1)))
;; Emacs's autoconf-mode installs its own
;; `add-log-current-defun-function'. This applies to
(error nil)))))
(error "Bad date")))
+(defun change-log-resolve-conflict ()
+ "Function to be used in `smerge-resolve-function'."
+ (let ((buf (current-buffer)))
+ (with-temp-buffer
+ (insert-buffer-substring buf (match-beginning 1) (match-end 1))
+ (save-match-data (change-log-mode))
+ (let ((other-buf (current-buffer)))
+ (with-current-buffer buf
+ (save-excursion
+ (save-restriction
+ (narrow-to-region (match-beginning 0) (match-end 0))
+ (replace-match (match-string 3) t t)
+ (change-log-merge other-buf))))))))
+
;;;###autoload
(defun change-log-merge (other-log)
"Merge the contents of ChangeLog file OTHER-LOG with this buffer.
Both must be found in Change Log mode (since the merging depends on
-the appropriate motion commands).
+the appropriate motion commands). OTHER-LOG can be either a file name
+or a buffer.
Entries are inserted in chronological order. Both the current and
old-style time formats for entries are supported."
(interactive "*fLog file name to merge: ")
(if (not (eq major-mode 'change-log-mode))
(error "Not in Change Log mode"))
- (let ((other-buf (find-file-noselect other-log))
+ (let ((other-buf (if (bufferp other-log) other-log
+ (find-file-noselect other-log)))
(buf (current-buffer))
date1 start end)
(save-excursion
(insert-buffer-substring other-buf start end)
;; At the end of the original buffer, insert a newline to
;; separate entries and then the rest of the file being
- ;; merged. Move to the end of it to terminate outer loop.
- (insert "\n")
- (insert-buffer-substring other-buf start
- (with-current-buffer other-buf
- (goto-char (point-max))
- (point)))))))))
+ ;; merged.
+ (unless (or (bobp)
+ (and (= ?\n (char-before))
+ (or (<= (1- (point)) (point-min))
+ (= ?\n (char-before (1- (point)))))))
+ (insert "\n"))
+ ;; Move to the end of it to terminate outer loop.
+ (with-current-buffer other-buf
+ (goto-char (point-max)))
+ (insert-buffer-substring other-buf start)))))))
;;;###autoload
(defun change-log-redate ()
(provide 'add-log)
+;;; arch-tag: 81eee6fc-088f-4372-a37f-80ad9620e762
;;; add-log.el ends here
HCoop / bpt / emacs.git / blobdiff