1 ;;; add-log.el --- change log maintenance commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1988, 1993 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
21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25 ;; This facility is documented in the Emacs Manual.
30 (defvar change-log-default-name nil
31 "*Name of a change log file for \\[add-change-log-entry].")
33 (defun change-log-name ()
34 (or change-log-default-name
35 (if (eq system-type
'vax-vms
) "$CHANGE_LOG$.TXT" "ChangeLog")))
37 (defun prompt-for-change-log-name ()
38 "Prompt for a change log name."
39 (let ((default (change-log-name)))
41 (read-file-name (format "Log file (default %s): " default
)
45 (defun find-change-log (&optional file-name
)
46 "Find a change log file for \\[add-change-log-entry] and return the name.
47 Optional arg FILE-NAME is a name to try first.
48 If FILE-NAME is nil, use the value of `change-log-default-name' if non-nil.
49 Failing that, use \"ChangeLog\" in the current directory.
50 If the file does not exist in the named directory, successive parent
51 directories are tried.
53 Once a file is found, `change-log-default-name' is set locally in the
54 current buffer to the complete file name."
56 (setq file-name
(or change-log-default-name
58 (if (file-directory-p file-name
)
59 (setq file-name
(expand-file-name (change-log-name) file-name
)))
60 ;; Chase links before visiting the file.
61 ;; This makes it easier to use a single change log file
62 ;; for several related directories.
64 (expand-file-name (or (file-symlink-p file-name
) file-name
)))
65 ;; Move up in the dir hierarchy till we find a change log file.
66 (let ((file1 file-name
)
68 (while (and (not (file-exists-p file1
))
69 (progn (setq parent-dir
72 (file-name-directory file1
))))
73 ;; Give up if we are already at the root dir.
74 (not (string= (file-name-directory file1
) parent-dir
))))
75 ;; Move up to the parent dir and try again.
76 (setq file1
(expand-file-name (change-log-name) parent-dir
)))
77 ;; If we found a change log in a parent, use that.
78 (if (file-exists-p file1
)
79 (setq file-name file1
)))
80 ;; Make a local variable in this buffer so we needn't search again.
81 (set (make-local-variable 'change-log-default-name
) file-name
)
85 (defun add-change-log-entry (&optional whoami file-name other-window
)
86 "Find change log file and add an entry for today.
87 Optional arg (interactive prefix) non-nil means prompt for user name and site.
88 Second arg is file name of change log. If nil, uses `change-log-default-name'.
89 Third arg OTHER-WINDOW non-nil means visit in other window."
90 (interactive (list current-prefix-arg
91 (prompt-for-change-log-name)))
92 (let* ((full-name (if whoami
93 (read-input "Full name: " (user-full-name))
95 ;; Note that some sites have room and phone number fields in
96 ;; full name which look silly when inserted. Rather than do
97 ;; anything about that here, let user give prefix argument so that
98 ;; s/he can edit the full name field in prompter if s/he wants.
99 (login-name (if whoami
100 (read-input "Login name: " (user-login-name))
102 (site-name (if whoami
103 (read-input "Site name: " (system-name))
105 (defun (add-log-current-defun))
108 (setq file-name
(find-change-log file-name
))
110 ;; Set ENTRY to the file name to use in the new entry.
111 (and buffer-file-name
112 ;; Never want to add a change log entry for the ChangeLog file itself.
113 (not (string= buffer-file-name file-name
))
114 (setq entry
(if (string-match
115 (concat "^" (regexp-quote (file-name-directory
118 (substring buffer-file-name
(match-end 0))
119 (file-name-nondirectory buffer-file-name
))))
121 (if (and other-window
(not (equal file-name buffer-file-name
)))
122 (find-file-other-window file-name
)
123 (find-file file-name
))
125 (goto-char (point-min))
126 (if (looking-at (concat (regexp-quote (substring (current-time-string)
128 ".* " (regexp-quote full-name
)
129 " (" (regexp-quote login-name
) "@"))
131 (insert (current-time-string)
133 " (" login-name
"@" site-name
")\n\n"))
135 ;; Search only within the first paragraph.
136 (if (looking-at "\n*[^\n* \t]")
137 (skip-chars-forward "\n")
138 (forward-paragraph 1))
139 (setq paragraph-end
(point))
140 (goto-char (point-min))
142 ;; Now insert the new line for this entry.
143 (cond ((re-search-forward "^\\s *\\*\\s *$" paragraph-end t
)
144 ;; Put this file name into the existing empty entry.
147 ((and (re-search-forward
148 (concat (regexp-quote (concat "* " entry
))
149 ;; Don't accept `foo.bar' when
150 ;; looking for `foo':
151 "\\(\\s \\|[(),:]\\)")
153 ;; Add to the existing entry for the same file.
154 (re-search-forward "^\\s *$\\|^\\s \\*")
156 (while (and (not (eobp)) (looking-at "^\\s *$"))
157 (delete-region (point) (save-excursion (forward-line 1) (point))))
160 (indent-relative-maybe))
164 (while (looking-at "\\sW")
166 (while (and (not (eobp)) (looking-at "^\\s *$"))
167 (delete-region (point) (save-excursion (forward-line 1) (point))))
170 (indent-to left-margin
)
171 (insert "* " (or entry
""))))
172 ;; Now insert the function name, if we have one.
173 ;; Point is at the entry for this file,
174 ;; either at the end of the line or at the first blank line.
177 ;; Make it easy to get rid of the function name.
179 (insert (if (save-excursion
180 (beginning-of-line 1)
181 (looking-at "\\s *$"))
185 ;; No function name, so put in a colon unless we have just a star.
186 (if (not (save-excursion
187 (beginning-of-line 1)
188 (looking-at "\\s *\\(\\*\\s *\\)?$")))
192 (defun add-change-log-entry-other-window (&optional whoami file-name
)
193 "Find change log file in other window and add an entry for today.
194 First arg (interactive prefix) non-nil means prompt for user name and site.
195 Second arg is file name of change log.
196 Interactively, with a prefix argument, the file name is prompted for."
197 (interactive (if current-prefix-arg
198 (list current-prefix-arg
199 (prompt-for-change-log-name))))
200 (add-change-log-entry whoami file-name t
))
201 ;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window)
204 (defun change-log-mode ()
205 "Major mode for editting change logs; like Indented Text Mode.
206 Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74.
207 New log entries are usually made with \\[add-change-log-entry] or \\[add-change-log-entry-other-window].
208 Each entry behaves as a paragraph, and the entries for one day as a page.
209 Runs `change-log-mode-hook'."
211 (kill-all-local-variables)
213 (setq major-mode
'change-log-mode
214 mode-name
"Change Log"
217 ;; Let each entry behave as one paragraph:
218 (set (make-local-variable 'paragraph-start
) "^\\s *$\\|^^L")
219 (set (make-local-variable 'paragraph-separate
) "^\\s *$\\|^^L\\|^\\sw")
220 ;; Let all entries for one day behave as one page.
221 ;; Match null string on the date-line so that the date-line
222 ;; is grouped with what follows.
223 (set (make-local-variable 'page-delimiter
) "^\\<\\|^\f")
224 (set (make-local-variable 'version-control
) 'never
)
225 (set (make-local-variable 'adaptive-fill-regexp
) "\\s *")
226 (run-hooks 'change-log-mode-hook
))
228 (defvar add-log-current-defun-header-regexp
229 "^\\([A-Z][A-Z_ ]*[A-Z_]\\|[a-z_---A-Z]+\\)[ \t]*[:=]"
230 "*Heuristic regexp used by `add-log-current-defun' for unknown major modes.")
232 (defun add-log-current-defun ()
233 "Return name of function definition point is in, or nil.
235 Understands Lisp, LaTeX (\"functions\" are chapters, sections, ...),
236 Texinfo (@node titles), and C.
238 Other modes are handled by a heuristic that looks in the 10K before
239 point for uppercase headings starting in the first column or
240 identifiers followed by `:' or `=', see variable
241 `add-log-current-defun-header-regexp'.
243 Has a preference of looking backwards."
246 (let ((location (point)))
247 (cond ((memq major-mode
'(emacs-lisp-mode lisp-mode scheme-mode
))
248 ;; If we are now precisely a the beginning of a defun,
249 ;; make sure beginning-of-defun finds that one
250 ;; rather than the previous one.
251 (or (eobp) (forward-char 1))
253 ;; Make sure we are really inside the defun found, not after it.
254 (if (and (progn (end-of-defun)
255 (< location
(point)))
256 (progn (forward-sexp -
1)
257 (>= location
(point))))
260 (skip-chars-forward " ")
261 (buffer-substring (point)
262 (progn (forward-sexp 1) (point))))))
263 ((and (memq major-mode
'(c-mode 'c
++-mode
))
264 (save-excursion (beginning-of-line)
265 ;; Use eq instead of = here to avoid
266 ;; error when at bob and char-after
268 (while (eq (char-after (- (point) 2)) ?
\\)
270 (looking-at "[ \t]*#[ \t]*define[ \t]")))
271 ;; Handle a C macro definition.
273 (while (eq (char-after (- (point) 2)) ?
\\) ;not =; note above
275 (search-forward "define")
276 (skip-chars-forward " \t")
277 (buffer-substring (point)
278 (progn (forward-sexp 1) (point))))
279 ((memq major-mode
'(c-mode 'c
++-mode
))
281 ;; See if we are in the beginning part of a function,
282 ;; before the open brace. If so, advance forward.
283 (while (not (looking-at "{\\|\\(\\s *$\\)"))
288 (if (progn (end-of-defun)
289 (< location
(point)))
295 ;; Skip back over typedefs of arglist.
296 (while (and (not (bobp))
297 (looking-at "[ \t\n]"))
299 ;; See if this is using the DEFUN macro used in Emacs,
300 ;; or the DEFUN macro used by the C library.
301 (if (condition-case nil
307 (looking-at "DEFUN\\b"))
313 (if (= (char-after (point)) ?
\")
316 (skip-chars-forward " ,")))
317 (buffer-substring (point)
318 (progn (forward-sexp 1) (point))))
319 ;; Ordinary C function syntax.
321 (if (condition-case nil
322 ;; Protect against "Unbalanced parens" error.
324 (down-list 1) ; into arglist
326 (skip-chars-backward " \t")
329 ;; Verify initial pos was after
330 ;; real start of function.
331 (if (and (save-excursion
333 ;; For this purpose, include the line
334 ;; that has the decl keywords. This
335 ;; may also include some of the
336 ;; comments before the function.
337 (while (and (not (bobp))
340 (looking-at "[^\n\f]")))
342 (>= location
(point)))
343 ;; Consistency check: going down and up
344 ;; shouldn't take us back before BEG.
346 (buffer-substring (point)
347 (progn (backward-sexp 1)
350 '(TeX-mode plain-TeX-mode LaTeX-mode
;; tex-mode.el
351 plain-tex-mode latex-mode
;; cmutex.el
353 (if (re-search-backward
354 "\\\\\\(sub\\)*\\(section\\|paragraph\\|chapter\\)" nil t
)
356 (goto-char (match-beginning 0))
357 (buffer-substring (1+ (point));; without initial backslash
361 ((eq major-mode
'texinfo-mode
)
362 (if (re-search-backward "^@node[ \t]+\\([^,]+\\)," nil t
)
363 (buffer-substring (match-beginning 1)
366 ;; If all else fails, try heuristics
367 (let (case-fold-search)
369 (if (re-search-backward add-log-current-defun-header-regexp
372 (buffer-substring (match-beginning 1)
379 ;;; add-log.el ends here