Commit | Line | Data |
---|---|---|
5abdc915 | 1 | ;;; add-log.el --- change log maintenance commands for Emacs |
84fc2cfa | 2 | |
5960adc7 | 3 | ;; Copyright (C) 1985, 86, 88, 93, 94, 97, 98, 2000 Free Software Foundation, Inc. |
84fc2cfa | 4 | |
df63ae66 | 5 | ;; Keywords: tools |
e9571d2a | 6 | |
84fc2cfa ER |
7 | ;; This file is part of GNU Emacs. |
8 | ||
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 | |
fd7fa35a | 11 | ;; the Free Software Foundation; either version 2, or (at your option) |
84fc2cfa ER |
12 | ;; any later version. |
13 | ||
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. | |
18 | ||
19 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
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. | |
84fc2cfa | 23 | |
e41b2db1 ER |
24 | ;;; Commentary: |
25 | ||
26 | ;; This facility is documented in the Emacs Manual. | |
27 | ||
fd7fa35a | 28 | ;;; Code: |
84fc2cfa | 29 | |
776d8e16 | 30 | (eval-when-compile |
5960adc7 | 31 | (require 'timezone)) |
3697b807 | 32 | |
fcad5199 RS |
33 | (defgroup change-log nil |
34 | "Change log maintenance" | |
35 | :group 'tools | |
3697b807 | 36 | :link '(custom-manual "(emacs)Change Log") |
fcad5199 RS |
37 | :prefix "change-log-" |
38 | :prefix "add-log-") | |
84fc2cfa | 39 | |
fcad5199 RS |
40 | |
41 | (defcustom change-log-default-name nil | |
42 | "*Name of a change log file for \\[add-change-log-entry]." | |
43 | :type '(choice (const :tag "default" nil) | |
44 | string) | |
45 | :group 'change-log) | |
46 | ||
c3979f12 DL |
47 | (defcustom change-log-mode-hook nil |
48 | "Normal hook run by `change-log-mode'." | |
49 | :type 'hook | |
50 | :group 'change-log) | |
51 | ||
fcad5199 | 52 | (defcustom add-log-current-defun-function nil |
5960adc7 DL |
53 | "*If non-nil, function to guess name of surrounding function. |
54 | It is used by `add-log-current-defun' in preference to built-in rules. | |
55 | Returns function's name as a string, or nil if outside a function." | |
5cb58f82 | 56 | :type 'function |
fcad5199 | 57 | :group 'change-log) |
6258d3af | 58 | |
29db528b | 59 | ;;;###autoload |
fcad5199 | 60 | (defcustom add-log-full-name nil |
02ec1592 | 61 | "*Full name of user, for inclusion in ChangeLog daily headers. |
075a6629 | 62 | This defaults to the value returned by the function `user-full-name'." |
fcad5199 RS |
63 | :type '(choice (const :tag "Default" nil) |
64 | string) | |
65 | :group 'change-log) | |
02ec1592 | 66 | |
29db528b | 67 | ;;;###autoload |
fcad5199 | 68 | (defcustom add-log-mailing-address nil |
02ec1592 | 69 | "*Electronic mail address of user, for inclusion in ChangeLog daily headers. |
fcad5199 RS |
70 | This defaults to the value of `user-mail-address'." |
71 | :type '(choice (const :tag "Default" nil) | |
72 | string) | |
73 | :group 'change-log) | |
74 | ||
df63ae66 RS |
75 | (defcustom add-log-time-format 'add-log-iso8601-time-string |
76 | "*Function that defines the time format. | |
77 | For example, `add-log-iso8601-time-string', which gives the | |
78 | date in international ISO 8601 format, | |
79 | and `current-time-string' are two valid values." | |
80 | :type '(radio (const :tag "International ISO 8601 format" | |
81 | add-log-iso8601-time-string) | |
82 | (const :tag "Old format, as returned by `current-time-string'" | |
83 | current-time-string) | |
84 | (function :tag "Other")) | |
85 | :group 'change-log) | |
02ec1592 | 86 | |
83afd62c | 87 | (defcustom add-log-keep-changes-together nil |
3697b807 DL |
88 | "*If non-nil, normally keep day's log entries for one file together. |
89 | ||
90 | Log entries for a given file made with \\[add-change-log-entry] or | |
91 | \\[add-change-log-entry-other-window] will only be added to others \ | |
92 | for that file made | |
93 | today if this variable is non-nil or that file comes first in today's | |
94 | entries. Otherwise another entry for that file will be started. An | |
95 | original log: | |
96 | ||
97 | * foo (...): ... | |
98 | * bar (...): change 1 | |
83afd62c | 99 | |
3697b807 DL |
100 | in the latter case, \\[add-change-log-entry-other-window] in a \ |
101 | buffer visiting `bar', yields: | |
83afd62c | 102 | |
3697b807 DL |
103 | * bar (...): -!- |
104 | * foo (...): ... | |
105 | * bar (...): change 1 | |
83afd62c | 106 | |
3697b807 | 107 | and in the former: |
83afd62c | 108 | |
3697b807 DL |
109 | * foo (...): ... |
110 | * bar (...): change 1 | |
111 | (...): -!- | |
83afd62c | 112 | |
3697b807 DL |
113 | The NEW-ENTRY arg to `add-change-log-entry' can override the effect of |
114 | this variable." | |
115 | :version "20.3" | |
83afd62c KH |
116 | :type 'boolean |
117 | :group 'change-log) | |
118 | ||
666f4056 RS |
119 | (defcustom add-log-file-name-function nil |
120 | "*If non-nil, function to call to identify the filename for a ChangeLog entry. | |
075a6629 DL |
121 | This function is called with one argument, the value of variable |
122 | `buffer-file-name' in that buffer. If this is nil, the default is to | |
123 | use the file's name relative to the directory of the change log file." | |
666f4056 RS |
124 | :type 'function |
125 | :group 'change-log) | |
126 | ||
776d8e16 GM |
127 | |
128 | (defcustom change-log-version-info-enabled nil | |
129 | "*If non-nil, enable recording version numbers with the changes." | |
130 | :version "21.1" | |
131 | :type 'boolean | |
132 | :group 'change-log) | |
133 | ||
134 | (defcustom change-log-version-number-regexp-list | |
135 | (let ((re "\\([0-9]+\.[0-9.]+\\)")) | |
136 | (list | |
137 | ;; (defconst ad-version "2.15" | |
138 | (concat "^(def[^ \t\n]+[ \t]+[^ \t\n][ \t]\"" re) | |
139 | ;; Revision: pcl-cvs.el,v 1.72 1999/09/05 20:21:54 monnier Exp | |
5960adc7 | 140 | (concat "^;+ *Revision: +[^ \t\n]+[ \t]+" re))) |
776d8e16 | 141 | "*List of regexps to search for version number. |
5960adc7 | 142 | The version number must be in group 1. |
776d8e16 GM |
143 | Note: The search is conducted only within 10%, at the beginning of the file." |
144 | :version "21.1" | |
145 | :type '(repeat regexp) | |
146 | :group 'change-log) | |
147 | ||
148 | ||
5f562719 | 149 | (defvar change-log-font-lock-keywords |
5572c1d1 SM |
150 | '(;; |
151 | ;; Date lines, new and old styles. | |
3307b0ca | 152 | ("^\\sw.........[0-9:+ ]*" |
5572c1d1 | 153 | (0 font-lock-string-face) |
97a3278b DL |
154 | ;; Name and e-mail; some people put e-mail in parens, not angles. |
155 | ("\\([^<(]+\\)[(<]\\([A-Za-z0-9_.-]+@[A-Za-z0-9_.-]+\\)[>)]" nil nil | |
883212ce | 156 | (1 font-lock-constant-face) |
6f6a2641 | 157 | (2 font-lock-variable-name-face))) |
5572c1d1 SM |
158 | ;; |
159 | ;; File names. | |
160 | ("^\t\\* \\([^ ,:([\n]+\\)" | |
161 | (1 font-lock-function-name-face) | |
97a3278b DL |
162 | ;; Possibly further names in a list: |
163 | ("\\=, \\([^ ,:([\n]+\\)" nil nil (1 font-lock-function-name-face)) | |
164 | ;; Possibly a parenthesized list of names: | |
165 | ("\\= (\\([^) ,:\n]+\\)" nil nil (1 font-lock-keyword-face)) | |
166 | ("\\=, *\\([^) ,:\n]+\\)" nil nil (1 font-lock-keyword-face))) | |
5572c1d1 SM |
167 | ;; |
168 | ;; Function or variable names. | |
97a3278b | 169 | ("^\t(\\([^) ,:\n]+\\)" |
5572c1d1 | 170 | (1 font-lock-keyword-face) |
6f187d8d | 171 | ("\\=, *\\([^) ,:\n]+\\)" nil nil (1 font-lock-keyword-face))) |
5572c1d1 SM |
172 | ;; |
173 | ;; Conditionals. | |
174 | ("\\[!?\\([^]\n]+\\)\\]\\(:\\| (\\)" (1 font-lock-variable-name-face)) | |
175 | ;; | |
a3cab9f0 | 176 | ;; Acknowledgements. |
095fb03e | 177 | ("^\t\\(From\\|Patch\\(es\\)? by\\|Report\\(ed by\\| from\\)\\|Suggest\\(ed by\\|ion from\\)\\)" |
b438e1cb | 178 | 1 font-lock-comment-face) |
095fb03e | 179 | (" \\(From\\|Patch\\(es\\)? by\\|Report\\(ed by\\| from\\)\\|Suggest\\(ed by\\|ion from\\)\\)" |
b438e1cb | 180 | 1 font-lock-comment-face)) |
5f562719 RS |
181 | "Additional expressions to highlight in Change Log mode.") |
182 | ||
5960adc7 | 183 | (defvar change-log-mode-map (make-sparse-keymap) |
45c50c5d | 184 | "Keymap for Change Log major mode.") |
45c50c5d | 185 | |
51bd1843 EN |
186 | (defvar change-log-time-zone-rule nil |
187 | "Time zone used for calculating change log time stamps. | |
188 | It takes the same format as the TZ argument of `set-time-zone-rule'. | |
189 | If nil, use local time.") | |
190 | ||
df63ae66 | 191 | (defun add-log-iso8601-time-zone (time) |
51bd1843 EN |
192 | (let* ((utc-offset (or (car (current-time-zone time)) 0)) |
193 | (sign (if (< utc-offset 0) ?- ?+)) | |
194 | (sec (abs utc-offset)) | |
195 | (ss (% sec 60)) | |
196 | (min (/ sec 60)) | |
197 | (mm (% min 60)) | |
198 | (hh (/ min 60))) | |
199 | (format (cond ((not (zerop ss)) "%c%02d:%02d:%02d") | |
200 | ((not (zerop mm)) "%c%02d:%02d") | |
201 | (t "%c%02d")) | |
202 | sign hh mm ss))) | |
203 | ||
df63ae66 RS |
204 | (defun add-log-iso8601-time-string () |
205 | (if change-log-time-zone-rule | |
206 | (let ((tz (getenv "TZ")) | |
207 | (now (current-time))) | |
208 | (unwind-protect | |
209 | (progn | |
210 | (set-time-zone-rule | |
211 | change-log-time-zone-rule) | |
212 | (concat | |
213 | (format-time-string "%Y-%m-%d " now) | |
214 | (add-log-iso8601-time-zone now))) | |
215 | (set-time-zone-rule tz))) | |
216 | (format-time-string "%Y-%m-%d"))) | |
217 | ||
84fc2cfa | 218 | (defun change-log-name () |
075a6629 | 219 | "Return (system-dependent) default name for a change log file." |
84fc2cfa | 220 | (or change-log-default-name |
513063cf | 221 | (if (eq system-type 'vax-vms) |
4a047d23 RS |
222 | "$CHANGE_LOG$.TXT" |
223 | "ChangeLog"))) | |
84fc2cfa | 224 | |
287d149f | 225 | ;;;###autoload |
84fc2cfa ER |
226 | (defun prompt-for-change-log-name () |
227 | "Prompt for a change log name." | |
117aaf60 KH |
228 | (let* ((default (change-log-name)) |
229 | (name (expand-file-name | |
230 | (read-file-name (format "Log file (default %s): " default) | |
231 | nil default)))) | |
232 | ;; Handle something that is syntactically a directory name. | |
233 | ;; Look for ChangeLog or whatever in that directory. | |
234 | (if (string= (file-name-nondirectory name) "") | |
235 | (expand-file-name (file-name-nondirectory default) | |
236 | name) | |
237 | ;; Handle specifying a file that is a directory. | |
238 | (if (file-directory-p name) | |
239 | (expand-file-name (file-name-nondirectory default) | |
240 | (file-name-as-directory name)) | |
241 | name)))) | |
84fc2cfa | 242 | |
776d8e16 | 243 | (defun change-log-version-number-search () |
5960adc7 DL |
244 | "Return version number of current buffer's file. |
245 | This is the value returned by `vc-workfile-version' or, if that is | |
246 | nil, by matching `change-log-version-number-regexp-list'." | |
776d8e16 GM |
247 | (let* ((size (buffer-size)) |
248 | (end | |
5960adc7 DL |
249 | ;; The version number can be anywhere in the file, but |
250 | ;; restrict search to the file beginning: 10% should be | |
251 | ;; enough to prevent some mishits. | |
776d8e16 | 252 | ;; |
5960adc7 DL |
253 | ;; Apply percentage only if buffer size is bigger than |
254 | ;; approx 100 lines. | |
776d8e16 | 255 | (if (> size (* 100 80)) |
5960adc7 | 256 | (/ size 10) |
776d8e16 GM |
257 | size)) |
258 | version) | |
5960adc7 DL |
259 | (or (and buffer-file-name |
260 | (vc-workfile-version buffer-file-name)) | |
261 | (save-restriction | |
262 | (widen) | |
263 | (let ((regexps change-log-version-number-regexp-list)) | |
264 | (while regexps | |
265 | (save-excursion | |
266 | (goto-char (point-min)) | |
267 | (when (re-search-forward (pop regexps) end t) | |
268 | (setq version (match-string 1) | |
269 | regexps nil))))))))) | |
776d8e16 GM |
270 | |
271 | ||
45a13f0d RM |
272 | ;;;###autoload |
273 | (defun find-change-log (&optional file-name) | |
274 | "Find a change log file for \\[add-change-log-entry] and return the name. | |
a82e2ed5 RS |
275 | |
276 | Optional arg FILE-NAME specifies the file to use. | |
de98fcaf RS |
277 | If FILE-NAME is nil, use the value of `change-log-default-name'. |
278 | If 'change-log-default-name' is nil, behave as though it were 'ChangeLog' | |
279 | \(or whatever we use on this operating system). | |
280 | ||
281 | If 'change-log-default-name' contains a leading directory component, then | |
513063cf | 282 | simply find it in the current directory. Otherwise, search in the current |
de98fcaf | 283 | directory and its successive parents for a file so named. |
45a13f0d RM |
284 | |
285 | Once a file is found, `change-log-default-name' is set locally in the | |
286 | current buffer to the complete file name." | |
a82e2ed5 RS |
287 | ;; If user specified a file name or if this buffer knows which one to use, |
288 | ;; just use that. | |
45a13f0d | 289 | (or file-name |
de98fcaf RS |
290 | (setq file-name (and change-log-default-name |
291 | (file-name-directory change-log-default-name) | |
292 | change-log-default-name)) | |
a82e2ed5 RS |
293 | (progn |
294 | ;; Chase links in the source file | |
295 | ;; and use the change log in the dir where it points. | |
296 | (setq file-name (or (and buffer-file-name | |
297 | (file-name-directory | |
298 | (file-chase-links buffer-file-name))) | |
299 | default-directory)) | |
300 | (if (file-directory-p file-name) | |
301 | (setq file-name (expand-file-name (change-log-name) file-name))) | |
302 | ;; Chase links before visiting the file. | |
303 | ;; This makes it easier to use a single change log file | |
304 | ;; for several related directories. | |
305 | (setq file-name (file-chase-links file-name)) | |
306 | (setq file-name (expand-file-name file-name)) | |
307 | ;; Move up in the dir hierarchy till we find a change log file. | |
308 | (let ((file1 file-name) | |
309 | parent-dir) | |
310 | (while (and (not (or (get-file-buffer file1) (file-exists-p file1))) | |
311 | (progn (setq parent-dir | |
312 | (file-name-directory | |
313 | (directory-file-name | |
314 | (file-name-directory file1)))) | |
315 | ;; Give up if we are already at the root dir. | |
316 | (not (string= (file-name-directory file1) | |
317 | parent-dir)))) | |
318 | ;; Move up to the parent dir and try again. | |
513063cf | 319 | (setq file1 (expand-file-name |
a82e2ed5 RS |
320 | (file-name-nondirectory (change-log-name)) |
321 | parent-dir))) | |
322 | ;; If we found a change log in a parent, use that. | |
323 | (if (or (get-file-buffer file1) (file-exists-p file1)) | |
324 | (setq file-name file1))))) | |
325 | ;; Make a local variable in this buffer so we needn't search again. | |
326 | (set (make-local-variable 'change-log-default-name) file-name) | |
327 | file-name) | |
45a13f0d | 328 | |
84fc2cfa | 329 | ;;;###autoload |
287d149f | 330 | (defun add-change-log-entry (&optional whoami file-name other-window new-entry) |
84fc2cfa | 331 | "Find change log file and add an entry for today. |
83afd62c KH |
332 | Optional arg WHOAMI (interactive prefix) non-nil means prompt for user |
333 | name and site. | |
334 | ||
335 | Second arg is FILE-NAME of change log. If nil, uses `change-log-default-name'. | |
287d149f RM |
336 | Third arg OTHER-WINDOW non-nil means visit in other window. |
337 | Fourth arg NEW-ENTRY non-nil means always create a new entry at the front; | |
3697b807 DL |
338 | never append to an existing entry. Option `add-log-keep-changes-together' |
339 | otherwise affects whether a new entry is created. | |
340 | ||
341 | Today's date is calculated according to `change-log-time-zone-rule' if | |
342 | non-nil, otherwise in local time." | |
84fc2cfa ER |
343 | (interactive (list current-prefix-arg |
344 | (prompt-for-change-log-name))) | |
550d8777 RS |
345 | (or add-log-full-name |
346 | (setq add-log-full-name (user-full-name))) | |
347 | (or add-log-mailing-address | |
348 | (setq add-log-mailing-address user-mail-address)) | |
02ec1592 BF |
349 | (if whoami |
350 | (progn | |
351 | (setq add-log-full-name (read-input "Full name: " add-log-full-name)) | |
84fc2cfa ER |
352 | ;; Note that some sites have room and phone number fields in |
353 | ;; full name which look silly when inserted. Rather than do | |
354 | ;; anything about that here, let user give prefix argument so that | |
355 | ;; s/he can edit the full name field in prompter if s/he wants. | |
02ec1592 BF |
356 | (setq add-log-mailing-address |
357 | (read-input "Mailing address: " add-log-mailing-address)))) | |
5960adc7 | 358 | (let ((defun (add-log-current-defun)) |
776d8e16 GM |
359 | (version (and change-log-version-info-enabled |
360 | (change-log-version-number-search))) | |
5960adc7 | 361 | bound entry) |
45a13f0d | 362 | |
3e1c918b | 363 | (setq file-name (expand-file-name (find-change-log file-name))) |
82f4acaf RM |
364 | |
365 | ;; Set ENTRY to the file name to use in the new entry. | |
366 | (and buffer-file-name | |
367 | ;; Never want to add a change log entry for the ChangeLog file itself. | |
368 | (not (string= buffer-file-name file-name)) | |
075a6629 DL |
369 | (if add-log-file-name-function |
370 | (setq entry | |
371 | (funcall add-log-file-name-function buffer-file-name)) | |
372 | (setq entry | |
666f4056 RS |
373 | (if (string-match |
374 | (concat "^" (regexp-quote (file-name-directory | |
375 | file-name))) | |
376 | buffer-file-name) | |
377 | (substring buffer-file-name (match-end 0)) | |
075a6629 DL |
378 | (file-name-nondirectory buffer-file-name))) |
379 | ;; If we have a backup file, it's presumably because we're | |
380 | ;; comparing old and new versions (e.g. for deleted | |
381 | ;; functions) and we'll want to use the original name. | |
382 | (if (backup-file-name-p entry) | |
383 | (setq entry (file-name-sans-versions entry))))) | |
82f4acaf | 384 | |
84fc2cfa ER |
385 | (if (and other-window (not (equal file-name buffer-file-name))) |
386 | (find-file-other-window file-name) | |
387 | (find-file file-name)) | |
675a998f RS |
388 | (or (eq major-mode 'change-log-mode) |
389 | (change-log-mode)) | |
84fc2cfa ER |
390 | (undo-boundary) |
391 | (goto-char (point-min)) | |
df63ae66 | 392 | (let ((new-entry (concat (funcall add-log-time-format) |
51bd1843 EN |
393 | " " add-log-full-name |
394 | " <" add-log-mailing-address ">"))) | |
395 | (if (looking-at (regexp-quote new-entry)) | |
396 | (forward-line 1) | |
397 | (insert new-entry "\n\n"))) | |
82f4acaf | 398 | |
3697b807 DL |
399 | (setq bound |
400 | (progn | |
401 | (if (looking-at "\n*[^\n* \t]") | |
402 | (skip-chars-forward "\n") | |
403 | (if add-log-keep-changes-together | |
404 | (forward-page) ; page delimits entries for date | |
405 | (forward-paragraph))) ; paragraph delimits entries for file | |
406 | (point))) | |
84fc2cfa | 407 | (goto-char (point-min)) |
1832dbd1 | 408 | ;; Now insert the new line for this entry. |
3697b807 | 409 | (cond ((re-search-forward "^\\s *\\*\\s *$" bound t) |
82f4acaf RM |
410 | ;; Put this file name into the existing empty entry. |
411 | (if entry | |
3697b807 | 412 | (insert entry))) |
287d149f | 413 | ((and (not new-entry) |
e172f546 KH |
414 | (let (case-fold-search) |
415 | (re-search-forward | |
416 | (concat (regexp-quote (concat "* " entry)) | |
417 | ;; Don't accept `foo.bar' when | |
418 | ;; looking for `foo': | |
419 | "\\(\\s \\|[(),:]\\)") | |
3697b807 | 420 | bound t))) |
82f4acaf RM |
421 | ;; Add to the existing entry for the same file. |
422 | (re-search-forward "^\\s *$\\|^\\s \\*") | |
e172f546 | 423 | (goto-char (match-beginning 0)) |
3697b807 DL |
424 | ;; Delete excess empty lines; make just 2. |
425 | (while (and (not (eobp)) (looking-at "^\\s *$")) | |
5960adc7 | 426 | (delete-region (point) (line-beginning-position 2))) |
3697b807 DL |
427 | (insert "\n\n") |
428 | (forward-line -2) | |
429 | (indent-relative-maybe)) | |
21d7e080 | 430 | (t |
dd309224 RM |
431 | ;; Make a new entry. |
432 | (forward-line 1) | |
433 | (while (looking-at "\\sW") | |
434 | (forward-line 1)) | |
09b389d0 | 435 | (while (and (not (eobp)) (looking-at "^\\s *$")) |
5960adc7 | 436 | (delete-region (point) (line-beginning-position 2))) |
1832dbd1 RS |
437 | (insert "\n\n\n") |
438 | (forward-line -2) | |
dd309224 | 439 | (indent-to left-margin) |
5960adc7 | 440 | (insert "* " (or entry "")))) |
1832dbd1 | 441 | ;; Now insert the function name, if we have one. |
21d7e080 ER |
442 | ;; Point is at the entry for this file, |
443 | ;; either at the end of the line or at the first blank line. | |
444 | (if defun | |
445 | (progn | |
dd309224 | 446 | ;; Make it easy to get rid of the function name. |
21d7e080 | 447 | (undo-boundary) |
5960adc7 DL |
448 | (unless (save-excursion |
449 | (beginning-of-line 1) | |
450 | (looking-at "\\s *$")) | |
451 | (insert ?\ )) | |
dc29aa6c SM |
452 | ;; See if the prev function name has a message yet or not |
453 | ;; If not, merge the two entries. | |
454 | (let ((pos (point-marker))) | |
455 | (if (and (skip-syntax-backward " ") | |
456 | (skip-chars-backward "):") | |
457 | (looking-at "):") | |
458 | (progn (delete-region (+ 1 (point)) (+ 2 (point))) t) | |
459 | (> fill-column (+ (current-column) (length defun) 3))) | |
460 | (progn (delete-region (point) pos) | |
461 | (insert ", ")) | |
462 | (goto-char pos) | |
463 | (insert "(")) | |
464 | (set-marker pos nil)) | |
465 | (insert defun "): ") | |
5960adc7 DL |
466 | (if version |
467 | (insert version ?\ ))) | |
1832dbd1 | 468 | ;; No function name, so put in a colon unless we have just a star. |
5960adc7 DL |
469 | (unless (save-excursion |
470 | (beginning-of-line 1) | |
471 | (looking-at "\\s *\\(\\*\\s *\\)?$")) | |
472 | (insert ": ") | |
473 | (if version (insert version ?\ )))))) | |
84fc2cfa | 474 | |
84fc2cfa ER |
475 | ;;;###autoload |
476 | (defun add-change-log-entry-other-window (&optional whoami file-name) | |
477 | "Find change log file in other window and add an entry for today. | |
83afd62c KH |
478 | Optional arg WHOAMI (interactive prefix) non-nil means prompt for user |
479 | name and site. | |
3697b807 DL |
480 | Second optional arg FILE-NAME is file name of change log. |
481 | If nil, use `change-log-default-name'. | |
482 | ||
483 | Affected by the same options as `add-change-log-entry'." | |
84fc2cfa ER |
484 | (interactive (if current-prefix-arg |
485 | (list current-prefix-arg | |
486 | (prompt-for-change-log-name)))) | |
487 | (add-change-log-entry whoami file-name t)) | |
82f4acaf | 488 | ;;;###autoload (define-key ctl-x-4-map "a" 'add-change-log-entry-other-window) |
84fc2cfa | 489 | |
1da56800 | 490 | ;;;###autoload |
21d7e080 | 491 | (defun change-log-mode () |
eb8c3be9 | 492 | "Major mode for editing change logs; like Indented Text Mode. |
09b389d0 | 493 | Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74. |
3697b807 | 494 | New log entries are usually made with \\[add-change-log-entry] or \\[add-change-log-entry-other-window]. |
5516387c RM |
495 | Each entry behaves as a paragraph, and the entries for one day as a page. |
496 | Runs `change-log-mode-hook'." | |
21d7e080 ER |
497 | (interactive) |
498 | (kill-all-local-variables) | |
499 | (indented-text-mode) | |
82f4acaf RM |
500 | (setq major-mode 'change-log-mode |
501 | mode-name "Change Log" | |
502 | left-margin 8 | |
4f675a8c | 503 | fill-column 74 |
60f10a06 KH |
504 | indent-tabs-mode t |
505 | tab-width 8) | |
45c50c5d | 506 | (use-local-map change-log-mode-map) |
60f10a06 KH |
507 | (set (make-local-variable 'fill-paragraph-function) |
508 | 'change-log-fill-paragraph) | |
4b7d4d0d DL |
509 | ;; We really do want "^" in paragraph-start below: it is only the |
510 | ;; lines that begin at column 0 (despite the left-margin of 8) that | |
511 | ;; we are looking for. Adding `* ' allows eliding the blank line | |
512 | ;; between entries for different files. | |
c9cfb0f2 | 513 | (set (make-local-variable 'paragraph-start) "\\s *$\\|\f\\|^\\<") |
4b7d4d0d | 514 | (set (make-local-variable 'paragraph-separate) paragraph-start) |
2c91c85c RS |
515 | ;; Match null string on the date-line so that the date-line |
516 | ;; is grouped with what follows. | |
964141f2 | 517 | (set (make-local-variable 'page-delimiter) "^\\<\\|^\f") |
dd309224 RM |
518 | (set (make-local-variable 'version-control) 'never) |
519 | (set (make-local-variable 'adaptive-fill-regexp) "\\s *") | |
4b286eca SM |
520 | (set (make-local-variable 'font-lock-defaults) |
521 | '(change-log-font-lock-keywords t)) | |
21d7e080 ER |
522 | (run-hooks 'change-log-mode-hook)) |
523 | ||
287d149f RM |
524 | ;; It might be nice to have a general feature to replace this. The idea I |
525 | ;; have is a variable giving a regexp matching text which should not be | |
526 | ;; moved from bol by filling. change-log-mode would set this to "^\\s *\\s(". | |
527 | ;; But I don't feel up to implementing that today. | |
528 | (defun change-log-fill-paragraph (&optional justify) | |
529 | "Fill the paragraph, but preserve open parentheses at beginning of lines. | |
530 | Prefix arg means justify as well." | |
531 | (interactive "P") | |
8d6467a4 RS |
532 | (let ((end (progn (forward-paragraph) (point))) |
533 | (beg (progn (backward-paragraph) (point))) | |
14ee1953 | 534 | (paragraph-start (concat paragraph-start "\\|\\s *\\s("))) |
8d6467a4 RS |
535 | (fill-region beg end justify) |
536 | t)) | |
287d149f | 537 | \f |
fcad5199 | 538 | (defcustom add-log-current-defun-header-regexp |
26add1bf | 539 | "^\\([A-Z][A-Z_ ]*[A-Z_]\\|[-_a-zA-Z]+\\)[ \t]*[:=]" |
fcad5199 RS |
540 | "*Heuristic regexp used by `add-log-current-defun' for unknown major modes." |
541 | :type 'regexp | |
542 | :group 'change-log) | |
21d7e080 | 543 | |
fb644f48 EN |
544 | ;;;###autoload |
545 | (defvar add-log-lisp-like-modes | |
3697b807 | 546 | '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode) |
fb644f48 EN |
547 | "*Modes that look like Lisp to `add-log-current-defun'.") |
548 | ||
549 | ;;;###autoload | |
550 | (defvar add-log-c-like-modes | |
551 | '(c-mode c++-mode c++-c-mode objc-mode) | |
552 | "*Modes that look like C to `add-log-current-defun'.") | |
553 | ||
554 | ;;;###autoload | |
555 | (defvar add-log-tex-like-modes | |
556 | '(TeX-mode plain-TeX-mode LaTeX-mode plain-tex-mode latex-mode) | |
557 | "*Modes that look like TeX to `add-log-current-defun'.") | |
558 | ||
e332f80b | 559 | ;;;###autoload |
21d7e080 ER |
560 | (defun add-log-current-defun () |
561 | "Return name of function definition point is in, or nil. | |
562 | ||
63314951 | 563 | Understands C, Lisp, LaTeX (\"functions\" are chapters, sections, ...), |
5960adc7 | 564 | Texinfo (@node titles) and Perl. |
21d7e080 ER |
565 | |
566 | Other modes are handled by a heuristic that looks in the 10K before | |
567 | point for uppercase headings starting in the first column or | |
5960adc7 | 568 | identifiers followed by `:' or `='. See variables |
c1356086 GM |
569 | `add-log-current-defun-header-regexp' and |
570 | `add-log-current-defun-function' | |
21d7e080 ER |
571 | |
572 | Has a preference of looking backwards." | |
2cc0b765 RS |
573 | (condition-case nil |
574 | (save-excursion | |
575 | (let ((location (point))) | |
5960adc7 DL |
576 | (cond (add-log-current-defun-function |
577 | (funcall add-log-current-defun-function)) | |
c1356086 | 578 | ((memq major-mode add-log-lisp-like-modes) |
a0151877 | 579 | ;; If we are now precisely at the beginning of a defun, |
2cc0b765 RS |
580 | ;; make sure beginning-of-defun finds that one |
581 | ;; rather than the previous one. | |
582 | (or (eobp) (forward-char 1)) | |
583 | (beginning-of-defun) | |
5960adc7 DL |
584 | ;; Make sure we are really inside the defun found, |
585 | ;; not after it. | |
42b1fc29 RS |
586 | (when (and (looking-at "\\s(") |
587 | (progn (end-of-defun) | |
588 | (< location (point))) | |
589 | (progn (forward-sexp -1) | |
590 | (>= location (point)))) | |
591 | (if (looking-at "\\s(") | |
592 | (forward-char 1)) | |
593 | ;; Skip the defining construct name, typically "defun" | |
594 | ;; or "defvar". | |
595 | (forward-sexp 1) | |
596 | ;; The second element is usually a symbol being defined. | |
597 | ;; If it is not, use the first symbol in it. | |
63c7727f | 598 | (skip-chars-forward " \t\n'(") |
5960adc7 DL |
599 | (buffer-substring-no-properties (point) |
600 | (progn (forward-sexp 1) | |
601 | (point))))) | |
fb644f48 EN |
602 | ((and (memq major-mode add-log-c-like-modes) |
603 | (save-excursion | |
604 | (beginning-of-line) | |
605 | ;; Use eq instead of = here to avoid | |
606 | ;; error when at bob and char-after | |
607 | ;; returns nil. | |
608 | (while (eq (char-after (- (point) 2)) ?\\) | |
609 | (forward-line -1)) | |
610 | (looking-at "[ \t]*#[ \t]*define[ \t]"))) | |
2cc0b765 RS |
611 | ;; Handle a C macro definition. |
612 | (beginning-of-line) | |
613 | (while (eq (char-after (- (point) 2)) ?\\) ;not =; note above | |
614 | (forward-line -1)) | |
615 | (search-forward "define") | |
616 | (skip-chars-forward " \t") | |
5960adc7 DL |
617 | (buffer-substring-no-properties (point) |
618 | (progn (forward-sexp 1) | |
619 | (point)))) | |
fb644f48 | 620 | ((memq major-mode add-log-c-like-modes) |
2cc0b765 RS |
621 | (beginning-of-line) |
622 | ;; See if we are in the beginning part of a function, | |
623 | ;; before the open brace. If so, advance forward. | |
624 | (while (not (looking-at "{\\|\\(\\s *$\\)")) | |
625 | (forward-line 1)) | |
626 | (or (eobp) | |
627 | (forward-char 1)) | |
628 | (beginning-of-defun) | |
5960adc7 DL |
629 | (when (progn (end-of-defun) |
630 | (< location (point))) | |
631 | (backward-sexp 1) | |
632 | (let (beg tem) | |
633 | ||
634 | (forward-line -1) | |
635 | ;; Skip back over typedefs of arglist. | |
636 | (while (and (not (bobp)) | |
637 | (looking-at "[ \t\n]")) | |
638 | (forward-line -1)) | |
639 | ;; See if this is using the DEFUN macro used in Emacs, | |
640 | ;; or the DEFUN macro used by the C library. | |
641 | (if (condition-case nil | |
642 | (and (save-excursion | |
643 | (end-of-line) | |
644 | (while (= (preceding-char) ?\\) | |
645 | (end-of-line 2)) | |
646 | (backward-sexp 1) | |
647 | (beginning-of-line) | |
648 | (setq tem (point)) | |
649 | (looking-at "DEFUN\\b")) | |
650 | (>= location tem)) | |
651 | (error nil)) | |
652 | (progn | |
653 | (goto-char tem) | |
654 | (down-list 1) | |
655 | (if (= (char-after (point)) ?\") | |
656 | (progn | |
657 | (forward-sexp 1) | |
658 | (skip-chars-forward " ,"))) | |
659 | (buffer-substring-no-properties | |
660 | (point) | |
661 | (progn (forward-sexp 1) | |
662 | (point)))) | |
663 | (if (looking-at "^[+-]") | |
664 | (change-log-get-method-definition) | |
665 | ;; Ordinary C function syntax. | |
666 | (setq beg (point)) | |
667 | (if (and | |
668 | ;; Protect against "Unbalanced parens" error. | |
669 | (condition-case nil | |
670 | (progn | |
671 | (down-list 1) ; into arglist | |
672 | (backward-up-list 1) | |
673 | (skip-chars-backward " \t") | |
674 | t) | |
675 | (error nil)) | |
676 | ;; Verify initial pos was after | |
677 | ;; real start of function. | |
678 | (save-excursion | |
679 | (goto-char beg) | |
680 | ;; For this purpose, include the line | |
681 | ;; that has the decl keywords. This | |
682 | ;; may also include some of the | |
683 | ;; comments before the function. | |
684 | (while (and (not (bobp)) | |
685 | (save-excursion | |
686 | (forward-line -1) | |
687 | (looking-at "[^\n\f]"))) | |
688 | (forward-line -1)) | |
689 | (>= location (point))) | |
690 | ;; Consistency check: going down and up | |
691 | ;; shouldn't take us back before BEG. | |
692 | (> (point) beg)) | |
693 | (let (end middle) | |
694 | ;; Don't include any final whitespace | |
695 | ;; in the name we use. | |
696 | (skip-chars-backward " \t\n") | |
697 | (setq end (point)) | |
698 | (backward-sexp 1) | |
699 | ;; Now find the right beginning of the name. | |
700 | ;; Include certain keywords if they | |
701 | ;; precede the name. | |
702 | (setq middle (point)) | |
703 | (forward-word -1) | |
704 | ;; Ignore these subparts of a class decl | |
705 | ;; and move back to the class name itself. | |
706 | (while (looking-at "public \\|private ") | |
707 | (skip-chars-backward " \t:") | |
708 | (setq end (point)) | |
709 | (backward-sexp 1) | |
710 | (setq middle (point)) | |
711 | (forward-word -1)) | |
712 | (and (bolp) | |
713 | (looking-at | |
714 | "enum \\|struct \\|union \\|class ") | |
715 | (setq middle (point))) | |
716 | (goto-char end) | |
717 | (when (eq (preceding-char) ?=) | |
718 | (forward-char -1) | |
719 | (skip-chars-backward " \t") | |
720 | (setq end (point))) | |
721 | (buffer-substring-no-properties | |
722 | middle end)))))))) | |
fb644f48 | 723 | ((memq major-mode add-log-tex-like-modes) |
2cc0b765 | 724 | (if (re-search-backward |
5960adc7 DL |
725 | "\\\\\\(sub\\)*\\(section\\|paragraph\\|chapter\\)" |
726 | nil t) | |
2cc0b765 RS |
727 | (progn |
728 | (goto-char (match-beginning 0)) | |
5960adc7 DL |
729 | (buffer-substring-no-properties |
730 | (1+ (point)) ; without initial backslash | |
731 | (line-end-position))))) | |
2cc0b765 | 732 | ((eq major-mode 'texinfo-mode) |
3071ee28 | 733 | (if (re-search-backward "^@node[ \t]+\\([^,\n]+\\)" nil t) |
5960adc7 | 734 | (match-string-no-properties 1))) |
64bd2d51 RS |
735 | ((eq major-mode 'perl-mode) |
736 | (if (re-search-backward "^sub[ \t]+\\([^ \t\n]+\\)" nil t) | |
5960adc7 DL |
737 | (match-string-no-properties 1))) |
738 | ;; Emacs's autoconf-mode installs its own | |
739 | ;; `add-log-current-defun-function'. This applies to | |
740 | ;; a different mode apparently for editing .m4 | |
741 | ;; autoconf source. | |
f654865f | 742 | ((eq major-mode 'autoconf-mode) |
5960adc7 DL |
743 | (if (re-search-backward |
744 | "^\\(\\(m4_\\)?define\\|A._DEFUN\\)(\\[?\\([A-Za-z0-9_]+\\)" nil t) | |
745 | (match-string-no-properties 3))) | |
2cc0b765 RS |
746 | (t |
747 | ;; If all else fails, try heuristics | |
c1356086 GM |
748 | (let (case-fold-search |
749 | result) | |
2cc0b765 | 750 | (end-of-line) |
c1356086 GM |
751 | (when (re-search-backward |
752 | add-log-current-defun-header-regexp | |
753 | (- (point) 10000) | |
754 | t) | |
5960adc7 DL |
755 | (setq result (or (match-string-no-properties 1) |
756 | (match-string-no-properties 0))) | |
c1356086 GM |
757 | ;; Strip whitespace away |
758 | (when (string-match "\\([^ \t\n\r\f].*[^ \t\n\r\f]\\)" | |
759 | result) | |
5960adc7 | 760 | (setq result (match-string-no-properties 1 result))) |
c1356086 | 761 | result)))))) |
2cc0b765 | 762 | (error nil))) |
ef15f270 | 763 | |
83afd62c | 764 | (defvar change-log-get-method-definition-md) |
15319a8f | 765 | |
83afd62c | 766 | ;; Subroutine used within change-log-get-method-definition. |
59c1a7de RS |
767 | ;; Add the last match in the buffer to the end of `md', |
768 | ;; followed by the string END; move to the end of that match. | |
83afd62c KH |
769 | (defun change-log-get-method-definition-1 (end) |
770 | (setq change-log-get-method-definition-md | |
771 | (concat change-log-get-method-definition-md | |
5960adc7 | 772 | (match-string 1) |
15319a8f | 773 | end)) |
59c1a7de RS |
774 | (goto-char (match-end 0))) |
775 | ||
83afd62c | 776 | (defun change-log-get-method-definition () |
075a6629 | 777 | "For objective C, return the method name if we are in a method." |
83afd62c | 778 | (let ((change-log-get-method-definition-md "[")) |
59c1a7de | 779 | (save-excursion |
f27f16ed | 780 | (if (re-search-backward "^@implementation\\s-*\\([A-Za-z_]*\\)" nil t) |
83afd62c | 781 | (change-log-get-method-definition-1 " "))) |
59c1a7de RS |
782 | (save-excursion |
783 | (cond | |
f27f16ed | 784 | ((re-search-forward "^\\([-+]\\)[ \t\n\f\r]*\\(([^)]*)\\)?\\s-*" nil t) |
83afd62c | 785 | (change-log-get-method-definition-1 "") |
59c1a7de RS |
786 | (while (not (looking-at "[{;]")) |
787 | (looking-at | |
f27f16ed | 788 | "\\([A-Za-z_]*:?\\)\\s-*\\(([^)]*)\\)?[A-Za-z_]*[ \t\n\f\r]*") |
83afd62c KH |
789 | (change-log-get-method-definition-1 "")) |
790 | (concat change-log-get-method-definition-md "]")))))) | |
075a6629 DL |
791 | \f |
792 | (defun change-log-sortable-date-at () | |
793 | "Return date of log entry in a consistent form for sorting. | |
794 | Point is assumed to be at the start of the entry." | |
795 | (require 'timezone) | |
796 | (if (looking-at "^\\sw.........[0-9:+ ]*") | |
797 | (let ((date (match-string-no-properties 0))) | |
798 | (if date | |
799 | (if (string-match "\\(....\\)-\\(..\\)-\\(..\\)\\s-+" date) | |
800 | (concat (match-string 1 date) (match-string 2 date) | |
801 | (match-string 3 date)) | |
802 | (condition-case nil | |
803 | (timezone-make-date-sortable date) | |
804 | (error nil))))) | |
805 | (error "Bad date"))) | |
59c1a7de | 806 | |
075a6629 DL |
807 | ;;;###autoload |
808 | (defun change-log-merge (other-log) | |
809 | "Merge the contents of ChangeLog file OTHER-LOG with this buffer. | |
810 | Both must be found in Change Log mode (since the merging depends on | |
811 | the appropriate motion commands). | |
812 | ||
813 | Entries are inserted in chronological order. | |
814 | ||
815 | Both the current and old-style time formats for entries are supported, | |
816 | so this command could be used to convert old-style logs by merging | |
817 | with an empty log." | |
818 | (interactive "*fLog file name to merge: ") | |
819 | (if (not (eq major-mode 'change-log-mode)) | |
820 | (error "Not in Change Log mode")) | |
821 | (let ((other-buf (find-file-noselect other-log)) | |
822 | (buf (current-buffer)) | |
823 | date1 start end) | |
824 | (save-excursion | |
825 | (goto-char (point-min)) | |
826 | (set-buffer other-buf) | |
827 | (goto-char (point-min)) | |
828 | (if (not (eq major-mode 'change-log-mode)) | |
829 | (error "%s not found in Change Log mode" other-log)) | |
830 | ;; Loop through all the entries in OTHER-LOG. | |
831 | (while (not (eobp)) | |
832 | (setq date1 (change-log-sortable-date-at)) | |
833 | (setq start (point) | |
834 | end (progn (forward-page) (point))) | |
835 | ;; Look for an entry in original buffer that isn't later. | |
836 | (with-current-buffer buf | |
837 | (while (and (not (eobp)) | |
838 | (string< date1 (change-log-sortable-date-at))) | |
839 | (forward-page)) | |
840 | (if (not (eobp)) | |
841 | (insert-buffer-substring other-buf start end) | |
842 | ;; At the end of the original buffer, insert a newline to | |
843 | ;; separate entries and then the rest of the file being | |
844 | ;; merged. Move to the end of it to terminate outer loop. | |
845 | (insert "\n") | |
846 | (insert-buffer-substring other-buf start | |
847 | (with-current-buffer other-buf | |
848 | (goto-char (point-max)) | |
849 | (point))))))))) | |
ef15f270 | 850 | |
1da56800 RS |
851 | (provide 'add-log) |
852 | ||
fd7fa35a | 853 | ;;; add-log.el ends here |