Commit | Line | Data |
---|---|---|
5abdc915 | 1 | ;;; add-log.el --- change log maintenance commands for Emacs |
84fc2cfa | 2 | |
e91081eb | 3 | ;; Copyright (C) 1985, 1986, 1988, 1993, 1994, 1997, 1998, 2000, 2001, |
409cc4a3 | 4 | ;; 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
84fc2cfa | 5 | |
6228c05b | 6 | ;; Maintainer: FSF |
df63ae66 | 7 | ;; Keywords: tools |
e9571d2a | 8 | |
84fc2cfa ER |
9 | ;; This file is part of GNU Emacs. |
10 | ||
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 | |
b4aa6026 | 13 | ;; the Free Software Foundation; either version 3, or (at your option) |
84fc2cfa ER |
14 | ;; any later version. |
15 | ||
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. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
b578f267 | 22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
086add15 LK |
23 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 | ;; Boston, MA 02110-1301, USA. | |
84fc2cfa | 25 | |
e41b2db1 ER |
26 | ;;; Commentary: |
27 | ||
28 | ;; This facility is documented in the Emacs Manual. | |
29 | ||
b0a96f7b SM |
30 | ;; Todo: |
31 | ||
32 | ;; - Find/use/create _MTN/log if there's a _MTN directory. | |
33 | ;; - Find/use/create ++log.* if there's an {arch} directory. | |
34 | ;; - Use an open *VC-Log* or *cvs-commit* buffer if it's related to the | |
35 | ;; source file. | |
36 | ;; - Don't add TAB indents (and username?) if inserting entries in those | |
37 | ;; special places. | |
38 | ||
fd7fa35a | 39 | ;;; Code: |
84fc2cfa | 40 | |
776d8e16 | 41 | (eval-when-compile |
5960adc7 | 42 | (require 'timezone)) |
3697b807 | 43 | |
fcad5199 | 44 | (defgroup change-log nil |
7b297602 | 45 | "Change log maintenance." |
fcad5199 | 46 | :group 'tools |
3697b807 | 47 | :link '(custom-manual "(emacs)Change Log") |
fcad5199 RS |
48 | :prefix "change-log-" |
49 | :prefix "add-log-") | |
84fc2cfa | 50 | |
fcad5199 RS |
51 | |
52 | (defcustom change-log-default-name nil | |
b0a96f7b | 53 | "Name of a change log file for \\[add-change-log-entry]." |
fcad5199 RS |
54 | :type '(choice (const :tag "default" nil) |
55 | string) | |
56 | :group 'change-log) | |
10b35c39 | 57 | (put 'change-log-default-name 'safe-local-variable 'string-or-null-p) |
fcad5199 | 58 | |
c3979f12 DL |
59 | (defcustom change-log-mode-hook nil |
60 | "Normal hook run by `change-log-mode'." | |
61 | :type 'hook | |
62 | :group 'change-log) | |
63 | ||
c882e115 RS |
64 | ;; Many modes set this variable, so avoid warnings. |
65 | ;;;###autoload | |
fcad5199 | 66 | (defcustom add-log-current-defun-function nil |
bb042dc6 | 67 | "If non-nil, function to guess name of surrounding function. |
5960adc7 DL |
68 | It is used by `add-log-current-defun' in preference to built-in rules. |
69 | Returns function's name as a string, or nil if outside a function." | |
cea3855a | 70 | :type '(choice (const nil) function) |
fcad5199 | 71 | :group 'change-log) |
6258d3af | 72 | |
29db528b | 73 | ;;;###autoload |
fcad5199 | 74 | (defcustom add-log-full-name nil |
bb042dc6 | 75 | "Full name of user, for inclusion in ChangeLog daily headers. |
075a6629 | 76 | This defaults to the value returned by the function `user-full-name'." |
fcad5199 RS |
77 | :type '(choice (const :tag "Default" nil) |
78 | string) | |
79 | :group 'change-log) | |
02ec1592 | 80 | |
29db528b | 81 | ;;;###autoload |
fcad5199 | 82 | (defcustom add-log-mailing-address nil |
d1921057 | 83 | "Email addresses of user, for inclusion in ChangeLog headers. |
c1b3ae42 CW |
84 | This defaults to the value of `user-mail-address'. In addition to |
85 | being a simple string, this value can also be a list. All elements | |
86 | will be recognized as referring to the same user; when creating a new | |
87 | ChangeLog entry, one element will be chosen at random." | |
fcad5199 | 88 | :type '(choice (const :tag "Default" nil) |
24f4201f MR |
89 | (string :tag "String") |
90 | (repeat :tag "List of Strings" string)) | |
fcad5199 RS |
91 | :group 'change-log) |
92 | ||
df63ae66 | 93 | (defcustom add-log-time-format 'add-log-iso8601-time-string |
d1921057 | 94 | "Function that defines the time format. |
df63ae66 RS |
95 | For example, `add-log-iso8601-time-string', which gives the |
96 | date in international ISO 8601 format, | |
97 | and `current-time-string' are two valid values." | |
98 | :type '(radio (const :tag "International ISO 8601 format" | |
99 | add-log-iso8601-time-string) | |
100 | (const :tag "Old format, as returned by `current-time-string'" | |
101 | current-time-string) | |
102 | (function :tag "Other")) | |
103 | :group 'change-log) | |
02ec1592 | 104 | |
83afd62c | 105 | (defcustom add-log-keep-changes-together nil |
d1921057 | 106 | "If non-nil, normally keep day's log entries for one file together. |
3697b807 DL |
107 | |
108 | Log entries for a given file made with \\[add-change-log-entry] or | |
109 | \\[add-change-log-entry-other-window] will only be added to others \ | |
110 | for that file made | |
111 | today if this variable is non-nil or that file comes first in today's | |
112 | entries. Otherwise another entry for that file will be started. An | |
113 | original log: | |
114 | ||
115 | * foo (...): ... | |
116 | * bar (...): change 1 | |
83afd62c | 117 | |
3697b807 DL |
118 | in the latter case, \\[add-change-log-entry-other-window] in a \ |
119 | buffer visiting `bar', yields: | |
83afd62c | 120 | |
3697b807 DL |
121 | * bar (...): -!- |
122 | * foo (...): ... | |
123 | * bar (...): change 1 | |
83afd62c | 124 | |
3697b807 | 125 | and in the former: |
83afd62c | 126 | |
3697b807 DL |
127 | * foo (...): ... |
128 | * bar (...): change 1 | |
129 | (...): -!- | |
83afd62c | 130 | |
3697b807 DL |
131 | The NEW-ENTRY arg to `add-change-log-entry' can override the effect of |
132 | this variable." | |
133 | :version "20.3" | |
83afd62c KH |
134 | :type 'boolean |
135 | :group 'change-log) | |
136 | ||
598f34fa | 137 | (defcustom add-log-always-start-new-record nil |
d1921057 | 138 | "If non-nil, `add-change-log-entry' will always start a new record." |
bf247b6e | 139 | :version "22.1" |
598f34fa SS |
140 | :type 'boolean |
141 | :group 'change-log) | |
142 | ||
d68f7f1b | 143 | (defcustom add-log-buffer-file-name-function nil |
d1921057 | 144 | "If non-nil, function to call to identify the full filename of a buffer. |
d68f7f1b SM |
145 | This function is called with no argument. If this is nil, the default is to |
146 | use `buffer-file-name'." | |
cea3855a | 147 | :type '(choice (const nil) function) |
d68f7f1b SM |
148 | :group 'change-log) |
149 | ||
666f4056 | 150 | (defcustom add-log-file-name-function nil |
d1921057 | 151 | "If non-nil, function to call to identify the filename for a ChangeLog entry. |
075a6629 DL |
152 | This function is called with one argument, the value of variable |
153 | `buffer-file-name' in that buffer. If this is nil, the default is to | |
154 | use the file's name relative to the directory of the change log file." | |
cea3855a | 155 | :type '(choice (const nil) function) |
666f4056 RS |
156 | :group 'change-log) |
157 | ||
776d8e16 GM |
158 | |
159 | (defcustom change-log-version-info-enabled nil | |
bb042dc6 | 160 | "If non-nil, enable recording version numbers with the changes." |
776d8e16 GM |
161 | :version "21.1" |
162 | :type 'boolean | |
163 | :group 'change-log) | |
164 | ||
165 | (defcustom change-log-version-number-regexp-list | |
166 | (let ((re "\\([0-9]+\.[0-9.]+\\)")) | |
167 | (list | |
168 | ;; (defconst ad-version "2.15" | |
169 | (concat "^(def[^ \t\n]+[ \t]+[^ \t\n][ \t]\"" re) | |
170 | ;; Revision: pcl-cvs.el,v 1.72 1999/09/05 20:21:54 monnier Exp | |
5960adc7 | 171 | (concat "^;+ *Revision: +[^ \t\n]+[ \t]+" re))) |
bb042dc6 | 172 | "List of regexps to search for version number. |
5960adc7 | 173 | The version number must be in group 1. |
776d8e16 GM |
174 | Note: The search is conducted only within 10%, at the beginning of the file." |
175 | :version "21.1" | |
176 | :type '(repeat regexp) | |
177 | :group 'change-log) | |
178 | ||
fe735a8d | 179 | (defface change-log-date |
163f7b71 GM |
180 | '((t (:inherit font-lock-string-face))) |
181 | "Face used to highlight dates in date lines." | |
182 | :version "21.1" | |
183 | :group 'change-log) | |
fe735a8d MB |
184 | ;; backward-compatibility alias |
185 | (put 'change-log-date-face 'face-alias 'change-log-date) | |
163f7b71 | 186 | |
fe735a8d | 187 | (defface change-log-name |
163f7b71 GM |
188 | '((t (:inherit font-lock-constant-face))) |
189 | "Face for highlighting author names." | |
190 | :version "21.1" | |
191 | :group 'change-log) | |
fe735a8d MB |
192 | ;; backward-compatibility alias |
193 | (put 'change-log-name-face 'face-alias 'change-log-name) | |
163f7b71 | 194 | |
fe735a8d | 195 | (defface change-log-email |
163f7b71 GM |
196 | '((t (:inherit font-lock-variable-name-face))) |
197 | "Face for highlighting author email addresses." | |
198 | :version "21.1" | |
199 | :group 'change-log) | |
fe735a8d MB |
200 | ;; backward-compatibility alias |
201 | (put 'change-log-email-face 'face-alias 'change-log-email) | |
163f7b71 | 202 | |
fe735a8d | 203 | (defface change-log-file |
163f7b71 GM |
204 | '((t (:inherit font-lock-function-name-face))) |
205 | "Face for highlighting file names." | |
206 | :version "21.1" | |
207 | :group 'change-log) | |
fe735a8d MB |
208 | ;; backward-compatibility alias |
209 | (put 'change-log-file-face 'face-alias 'change-log-file) | |
163f7b71 | 210 | |
fe735a8d | 211 | (defface change-log-list |
163f7b71 GM |
212 | '((t (:inherit font-lock-keyword-face))) |
213 | "Face for highlighting parenthesized lists of functions or variables." | |
214 | :version "21.1" | |
215 | :group 'change-log) | |
fe735a8d MB |
216 | ;; backward-compatibility alias |
217 | (put 'change-log-list-face 'face-alias 'change-log-list) | |
598f34fa | 218 | |
fe735a8d | 219 | (defface change-log-conditionals |
163f7b71 GM |
220 | '((t (:inherit font-lock-variable-name-face))) |
221 | "Face for highlighting conditionals of the form `[...]'." | |
222 | :version "21.1" | |
223 | :group 'change-log) | |
fe735a8d MB |
224 | ;; backward-compatibility alias |
225 | (put 'change-log-conditionals-face 'face-alias 'change-log-conditionals) | |
163f7b71 | 226 | |
fe735a8d | 227 | (defface change-log-function |
163f7b71 GM |
228 | '((t (:inherit font-lock-variable-name-face))) |
229 | "Face for highlighting items of the form `<....>'." | |
230 | :version "21.1" | |
231 | :group 'change-log) | |
fe735a8d MB |
232 | ;; backward-compatibility alias |
233 | (put 'change-log-function-face 'face-alias 'change-log-function) | |
163f7b71 | 234 | |
fe735a8d | 235 | (defface change-log-acknowledgement |
163f7b71 GM |
236 | '((t (:inherit font-lock-comment-face))) |
237 | "Face for highlighting acknowledgments." | |
238 | :version "21.1" | |
239 | :group 'change-log) | |
fe735a8d MB |
240 | ;; backward-compatibility alias |
241 | (put 'change-log-acknowledgement-face 'face-alias 'change-log-acknowledgement) | |
776d8e16 | 242 | |
a28ed9e5 | 243 | (defconst change-log-file-names-re "^\\( +\\|\t\\)\\* \\([^ ,:([\n]+\\)") |
000605b3 | 244 | (defconst change-log-start-entry-re "^\\sw.........[0-9:+ ]*") |
a28ed9e5 | 245 | |
5f562719 | 246 | (defvar change-log-font-lock-keywords |
a28ed9e5 | 247 | `(;; |
080525ae KH |
248 | ;; Date lines, new (2000-01-01) and old (Sat Jan 1 00:00:00 2000) styles. |
249 | ;; Fixme: this regepx is just an approximate one and may match | |
250 | ;; wrongly with a non-date line existing as a random note. In | |
251 | ;; addition, using any kind of fixed setting like this doesn't | |
252 | ;; work if a user customizes add-log-time-format. | |
253 | ("^[0-9-]+ +\\|^\\(Sun\\|Mon\\|Tue\\|Wed\\|Thu\\|Fri\\|Sat\\) [A-z][a-z][a-z] [0-9:+ ]+" | |
254 | (0 'change-log-date-face) | |
97a3278b | 255 | ;; Name and e-mail; some people put e-mail in parens, not angles. |
7397a79f | 256 | ("\\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)[>)]" nil nil |
fe735a8d MB |
257 | (1 'change-log-name) |
258 | (2 'change-log-email))) | |
5572c1d1 SM |
259 | ;; |
260 | ;; File names. | |
a28ed9e5 | 261 | (,change-log-file-names-re |
fe735a8d | 262 | (2 'change-log-file) |
97a3278b | 263 | ;; Possibly further names in a list: |
fe735a8d | 264 | ("\\=, \\([^ ,:([\n]+\\)" nil nil (1 'change-log-file)) |
97a3278b | 265 | ;; Possibly a parenthesized list of names: |
171c707b | 266 | ("\\= (\\([^(),\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)" |
fe735a8d | 267 | nil nil (1 'change-log-list)) |
171c707b | 268 | ("\\=, *\\([^(),\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)" |
fe735a8d | 269 | nil nil (1 'change-log-list))) |
5572c1d1 SM |
270 | ;; |
271 | ;; Function or variable names. | |
9e4b54a0 | 272 | ("^\\( +\\|\t\\)(\\([^(),\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)" |
fe735a8d | 273 | (2 'change-log-list) |
171c707b | 274 | ("\\=, *\\([^(),\n]+\\|(\\(setf\\|SETF\\) [^() ,\n]+)\\)" nil nil |
fe735a8d | 275 | (1 'change-log-list))) |
5572c1d1 SM |
276 | ;; |
277 | ;; Conditionals. | |
fe735a8d | 278 | ("\\[!?\\([^]\n]+\\)\\]\\(:\\| (\\)" (1 'change-log-conditionals)) |
5572c1d1 | 279 | ;; |
a8d693d8 | 280 | ;; Function of change. |
fe735a8d | 281 | ("<\\([^>\n]+\\)>\\(:\\| (\\)" (1 'change-log-function)) |
a8d693d8 | 282 | ;; |
a3cab9f0 | 283 | ;; Acknowledgements. |
a8e10524 RS |
284 | ;; Don't include plain "From" because that is vague; |
285 | ;; we want to encourage people to say something more specific. | |
c50089c9 RS |
286 | ;; Note that the FSF does not use "Patches by"; our convention |
287 | ;; is to put the name of the author of the changes at the top | |
288 | ;; of the change log entry. | |
9e4b54a0 | 289 | ("\\(^\\( +\\|\t\\)\\| \\)\\(Patch\\(es\\)? by\\|Report\\(ed by\\| from\\)\\|Suggest\\(ed by\\|ion from\\)\\)" |
fe735a8d | 290 | 3 'change-log-acknowledgement)) |
5f562719 RS |
291 | "Additional expressions to highlight in Change Log mode.") |
292 | ||
a28ed9e5 DN |
293 | (defun change-log-search-file-name (where) |
294 | "Return the file-name for the change under point." | |
295 | (save-excursion | |
296 | (goto-char where) | |
297 | (beginning-of-line 1) | |
000605b3 DN |
298 | (if (looking-at change-log-start-entry-re) |
299 | ;; We are at the start of an entry, search forward for a file | |
300 | ;; name. | |
301 | (progn | |
302 | (re-search-forward change-log-file-names-re nil t) | |
303 | (match-string 2)) | |
304 | (if (looking-at change-log-file-names-re) | |
305 | ;; We found a file name. | |
306 | (match-string 2) | |
307 | ;; Look backwards for either a file name or the log entry start. | |
308 | (if (re-search-backward | |
309 | (concat "\\(" change-log-start-entry-re | |
310 | "\\)\\|\\(" | |
311 | change-log-file-names-re "\\)") nil t) | |
312 | (if (match-beginning 1) | |
313 | ;; We got the start of the entry, look forward for a | |
314 | ;; file name. | |
315 | (progn | |
316 | (re-search-forward change-log-file-names-re nil t) | |
317 | (match-string 2)) | |
318 | (match-string 4)) | |
319 | ;; We must be before any file name, look forward. | |
320 | (re-search-forward change-log-file-names-re nil t) | |
321 | (match-string 2)))))) | |
a28ed9e5 DN |
322 | |
323 | (defun change-log-find-file () | |
324 | "Visit the file for the change under point." | |
325 | (interactive) | |
326 | (let ((file (change-log-search-file-name (point)))) | |
327 | (if (and file (file-exists-p file)) | |
328 | (find-file file) | |
000605b3 | 329 | (message "No such file or directory: %s" file)))) |
a28ed9e5 | 330 | |
3066d4ad SM |
331 | (defvar change-log-mode-map |
332 | (let ((map (make-sparse-keymap))) | |
333 | (define-key map [?\C-c ?\C-p] 'add-log-edit-prev-comment) | |
334 | (define-key map [?\C-c ?\C-n] 'add-log-edit-next-comment) | |
a28ed9e5 | 335 | (define-key map [?\C-c ?\C-f] 'change-log-find-file) |
3066d4ad | 336 | map) |
45c50c5d | 337 | "Keymap for Change Log major mode.") |
45c50c5d | 338 | |
d1921057 SM |
339 | ;; It used to be called change-log-time-zone-rule but really should be |
340 | ;; called add-log-time-zone-rule since it's only used from add-log-* code. | |
341 | (defvaralias 'change-log-time-zone-rule 'add-log-time-zone-rule) | |
342 | (defvar add-log-time-zone-rule nil | |
51bd1843 EN |
343 | "Time zone used for calculating change log time stamps. |
344 | It takes the same format as the TZ argument of `set-time-zone-rule'. | |
d1921057 SM |
345 | If nil, use local time. |
346 | If t, use universal time.") | |
d52c204b RS |
347 | (put 'add-log-time-zone-rule 'safe-local-variable |
348 | '(lambda (x) (or (booleanp x) (stringp x)))) | |
51bd1843 | 349 | |
0739a962 | 350 | (defun add-log-iso8601-time-zone (&optional time) |
51bd1843 EN |
351 | (let* ((utc-offset (or (car (current-time-zone time)) 0)) |
352 | (sign (if (< utc-offset 0) ?- ?+)) | |
353 | (sec (abs utc-offset)) | |
354 | (ss (% sec 60)) | |
355 | (min (/ sec 60)) | |
356 | (mm (% min 60)) | |
357 | (hh (/ min 60))) | |
358 | (format (cond ((not (zerop ss)) "%c%02d:%02d:%02d") | |
359 | ((not (zerop mm)) "%c%02d:%02d") | |
360 | (t "%c%02d")) | |
361 | sign hh mm ss))) | |
362 | ||
d1921057 SM |
363 | (defvar add-log-iso8601-with-time-zone nil) |
364 | ||
df63ae66 | 365 | (defun add-log-iso8601-time-string () |
0739a962 SM |
366 | (let ((time (format-time-string "%Y-%m-%d" |
367 | nil (eq t add-log-time-zone-rule)))) | |
d1921057 SM |
368 | (if add-log-iso8601-with-time-zone |
369 | (concat time " " (add-log-iso8601-time-zone)) | |
370 | time))) | |
df63ae66 | 371 | |
84fc2cfa | 372 | (defun change-log-name () |
075a6629 | 373 | "Return (system-dependent) default name for a change log file." |
84fc2cfa | 374 | (or change-log-default-name |
513063cf | 375 | (if (eq system-type 'vax-vms) |
4a047d23 RS |
376 | "$CHANGE_LOG$.TXT" |
377 | "ChangeLog"))) | |
84fc2cfa | 378 | |
3066d4ad SM |
379 | (defun add-log-edit-prev-comment (arg) |
380 | "Cycle backward through Log-Edit mode comment history. | |
381 | With a numeric prefix ARG, go back ARG comments." | |
382 | (interactive "*p") | |
383 | (save-restriction | |
384 | (narrow-to-region (point) | |
385 | (if (memq last-command '(add-log-edit-prev-comment | |
386 | add-log-edit-next-comment)) | |
387 | (mark) (point))) | |
388 | (when (fboundp 'log-edit-previous-comment) | |
389 | (log-edit-previous-comment arg) | |
390 | (indent-region (point-min) (point-max)) | |
391 | (goto-char (point-min)) | |
392 | (unless (save-restriction (widen) (bolp)) | |
393 | (delete-region (point) (progn (skip-chars-forward " \t\n") (point)))) | |
394 | (set-mark (point-min)) | |
395 | (goto-char (point-max)) | |
396 | (delete-region (point) (progn (skip-chars-backward " \t\n") (point)))))) | |
397 | ||
398 | (defun add-log-edit-next-comment (arg) | |
399 | "Cycle forward through Log-Edit mode comment history. | |
400 | With a numeric prefix ARG, go back ARG comments." | |
401 | (interactive "*p") | |
402 | (add-log-edit-prev-comment (- arg))) | |
403 | ||
287d149f | 404 | ;;;###autoload |
84fc2cfa ER |
405 | (defun prompt-for-change-log-name () |
406 | "Prompt for a change log name." | |
117aaf60 KH |
407 | (let* ((default (change-log-name)) |
408 | (name (expand-file-name | |
409 | (read-file-name (format "Log file (default %s): " default) | |
410 | nil default)))) | |
411 | ;; Handle something that is syntactically a directory name. | |
412 | ;; Look for ChangeLog or whatever in that directory. | |
413 | (if (string= (file-name-nondirectory name) "") | |
414 | (expand-file-name (file-name-nondirectory default) | |
415 | name) | |
416 | ;; Handle specifying a file that is a directory. | |
417 | (if (file-directory-p name) | |
418 | (expand-file-name (file-name-nondirectory default) | |
419 | (file-name-as-directory name)) | |
420 | name)))) | |
84fc2cfa | 421 | |
776d8e16 | 422 | (defun change-log-version-number-search () |
5960adc7 | 423 | "Return version number of current buffer's file. |
ac3f4c6f | 424 | This is the value returned by `vc-working-revision' or, if that is |
5960adc7 | 425 | nil, by matching `change-log-version-number-regexp-list'." |
776d8e16 | 426 | (let* ((size (buffer-size)) |
fc9b0554 | 427 | (limit |
5960adc7 DL |
428 | ;; The version number can be anywhere in the file, but |
429 | ;; restrict search to the file beginning: 10% should be | |
430 | ;; enough to prevent some mishits. | |
776d8e16 | 431 | ;; |
5960adc7 DL |
432 | ;; Apply percentage only if buffer size is bigger than |
433 | ;; approx 100 lines. | |
fc9b0554 | 434 | (if (> size (* 100 80)) (+ (point) (/ size 10))))) |
ac3f4c6f | 435 | (or (and buffer-file-name (vc-working-revision buffer-file-name)) |
5960adc7 DL |
436 | (save-restriction |
437 | (widen) | |
fc9b0554 SM |
438 | (let ((regexps change-log-version-number-regexp-list) |
439 | version) | |
5960adc7 DL |
440 | (while regexps |
441 | (save-excursion | |
442 | (goto-char (point-min)) | |
fc9b0554 | 443 | (when (re-search-forward (pop regexps) limit t) |
5960adc7 | 444 | (setq version (match-string 1) |
fc9b0554 SM |
445 | regexps nil)))) |
446 | version))))) | |
776d8e16 GM |
447 | |
448 | ||
45a13f0d | 449 | ;;;###autoload |
d68f7f1b | 450 | (defun find-change-log (&optional file-name buffer-file) |
45a13f0d | 451 | "Find a change log file for \\[add-change-log-entry] and return the name. |
a82e2ed5 RS |
452 | |
453 | Optional arg FILE-NAME specifies the file to use. | |
de98fcaf | 454 | If FILE-NAME is nil, use the value of `change-log-default-name'. |
218cf475 | 455 | If `change-log-default-name' is nil, behave as though it were 'ChangeLog' |
de98fcaf RS |
456 | \(or whatever we use on this operating system). |
457 | ||
218cf475 | 458 | If `change-log-default-name' contains a leading directory component, then |
513063cf | 459 | simply find it in the current directory. Otherwise, search in the current |
de98fcaf | 460 | directory and its successive parents for a file so named. |
45a13f0d RM |
461 | |
462 | Once a file is found, `change-log-default-name' is set locally in the | |
d68f7f1b SM |
463 | current buffer to the complete file name. |
464 | Optional arg BUFFER-FILE overrides `buffer-file-name'." | |
a82e2ed5 RS |
465 | ;; If user specified a file name or if this buffer knows which one to use, |
466 | ;; just use that. | |
45a13f0d | 467 | (or file-name |
de98fcaf RS |
468 | (setq file-name (and change-log-default-name |
469 | (file-name-directory change-log-default-name) | |
470 | change-log-default-name)) | |
a82e2ed5 RS |
471 | (progn |
472 | ;; Chase links in the source file | |
473 | ;; and use the change log in the dir where it points. | |
d68f7f1b | 474 | (setq file-name (or (and (or buffer-file buffer-file-name) |
a82e2ed5 | 475 | (file-name-directory |
d68f7f1b SM |
476 | (file-chase-links |
477 | (or buffer-file buffer-file-name)))) | |
a82e2ed5 RS |
478 | default-directory)) |
479 | (if (file-directory-p file-name) | |
480 | (setq file-name (expand-file-name (change-log-name) file-name))) | |
481 | ;; Chase links before visiting the file. | |
482 | ;; This makes it easier to use a single change log file | |
483 | ;; for several related directories. | |
484 | (setq file-name (file-chase-links file-name)) | |
485 | (setq file-name (expand-file-name file-name)) | |
486 | ;; Move up in the dir hierarchy till we find a change log file. | |
487 | (let ((file1 file-name) | |
488 | parent-dir) | |
489 | (while (and (not (or (get-file-buffer file1) (file-exists-p file1))) | |
490 | (progn (setq parent-dir | |
491 | (file-name-directory | |
492 | (directory-file-name | |
493 | (file-name-directory file1)))) | |
494 | ;; Give up if we are already at the root dir. | |
495 | (not (string= (file-name-directory file1) | |
496 | parent-dir)))) | |
497 | ;; Move up to the parent dir and try again. | |
513063cf | 498 | (setq file1 (expand-file-name |
a82e2ed5 RS |
499 | (file-name-nondirectory (change-log-name)) |
500 | parent-dir))) | |
501 | ;; If we found a change log in a parent, use that. | |
502 | (if (or (get-file-buffer file1) (file-exists-p file1)) | |
503 | (setq file-name file1))))) | |
504 | ;; Make a local variable in this buffer so we needn't search again. | |
505 | (set (make-local-variable 'change-log-default-name) file-name) | |
506 | file-name) | |
45a13f0d | 507 | |
2eb7ccf4 SM |
508 | (defun add-log-file-name (buffer-file log-file) |
509 | ;; Never want to add a change log entry for the ChangeLog file itself. | |
510 | (unless (or (null buffer-file) (string= buffer-file log-file)) | |
d68f7f1b SM |
511 | (if add-log-file-name-function |
512 | (funcall add-log-file-name-function buffer-file) | |
513 | (setq buffer-file | |
e1f5b0ed | 514 | (file-relative-name buffer-file (file-name-directory log-file))) |
d68f7f1b SM |
515 | ;; If we have a backup file, it's presumably because we're |
516 | ;; comparing old and new versions (e.g. for deleted | |
517 | ;; functions) and we'll want to use the original name. | |
518 | (if (backup-file-name-p buffer-file) | |
519 | (file-name-sans-versions buffer-file) | |
520 | buffer-file)))) | |
2eb7ccf4 | 521 | |
84fc2cfa | 522 | ;;;###autoload |
287d149f | 523 | (defun add-change-log-entry (&optional whoami file-name other-window new-entry) |
d882f144 | 524 | "Find change log file, and add an entry for today and an item for this file. |
83afd62c | 525 | Optional arg WHOAMI (interactive prefix) non-nil means prompt for user |
d9ee5172 | 526 | name and email (stored in `add-log-full-name' and `add-log-mailing-address'). |
83afd62c | 527 | |
d882f144 RS |
528 | Second arg FILE-NAME is file name of the change log. |
529 | If nil, use the value of `change-log-default-name'. | |
530 | ||
287d149f | 531 | Third arg OTHER-WINDOW non-nil means visit in other window. |
d882f144 | 532 | |
287d149f | 533 | Fourth arg NEW-ENTRY non-nil means always create a new entry at the front; |
3697b807 DL |
534 | never append to an existing entry. Option `add-log-keep-changes-together' |
535 | otherwise affects whether a new entry is created. | |
536 | ||
598f34fa SS |
537 | Option `add-log-always-start-new-record' non-nil means always create a |
538 | new record, even when the last record was made on the same date and by | |
539 | the same person. | |
540 | ||
d882f144 RS |
541 | The change log file can start with a copyright notice and a copying |
542 | permission notice. The first blank line indicates the end of these | |
543 | notices. | |
544 | ||
d1921057 | 545 | Today's date is calculated according to `add-log-time-zone-rule' if |
3697b807 | 546 | non-nil, otherwise in local time." |
84fc2cfa ER |
547 | (interactive (list current-prefix-arg |
548 | (prompt-for-change-log-name))) | |
d68f7f1b SM |
549 | (let* ((defun (add-log-current-defun)) |
550 | (version (and change-log-version-info-enabled | |
551 | (change-log-version-number-search))) | |
8f530b95 SM |
552 | (buf-file-name (if add-log-buffer-file-name-function |
553 | (funcall add-log-buffer-file-name-function) | |
554 | buffer-file-name)) | |
555 | (buffer-file (if buf-file-name (expand-file-name buf-file-name))) | |
dd816e0d | 556 | (file-name (expand-file-name (find-change-log file-name buffer-file))) |
d882f144 | 557 | ;; Set ITEM to the file name to use in the new item. |
ad4573c7 | 558 | (item (add-log-file-name buffer-file file-name))) |
2eb7ccf4 | 559 | |
7cd017ba SM |
560 | (unless (equal file-name buffer-file-name) |
561 | (if (or other-window (window-dedicated-p (selected-window))) | |
562 | (find-file-other-window file-name) | |
563 | (find-file file-name))) | |
bb042dc6 | 564 | (or (derived-mode-p 'change-log-mode) |
675a998f | 565 | (change-log-mode)) |
84fc2cfa ER |
566 | (undo-boundary) |
567 | (goto-char (point-min)) | |
d882f144 | 568 | |
ad4573c7 SM |
569 | (let ((full-name (or add-log-full-name (user-full-name))) |
570 | (mailing-address (or add-log-mailing-address user-mail-address))) | |
571 | ||
572 | (when whoami | |
1e899515 | 573 | (setq full-name (read-string "Full name: " full-name)) |
ad4573c7 SM |
574 | ;; Note that some sites have room and phone number fields in |
575 | ;; full name which look silly when inserted. Rather than do | |
576 | ;; anything about that here, let user give prefix argument so that | |
577 | ;; s/he can edit the full name field in prompter if s/he wants. | |
578 | (setq mailing-address | |
1e899515 | 579 | (read-string "Mailing address: " mailing-address))) |
ad4573c7 SM |
580 | |
581 | ;; If file starts with a copyright and permission notice, skip them. | |
582 | ;; Assume they end at first blank line. | |
583 | (when (looking-at "Copyright") | |
584 | (search-forward "\n\n") | |
585 | (skip-chars-forward "\n")) | |
586 | ||
587 | ;; Advance into first entry if it is usable; else make new one. | |
588 | (let ((new-entries | |
589 | (mapcar (lambda (addr) | |
590 | (concat | |
591 | (if (stringp add-log-time-zone-rule) | |
592 | (let ((tz (getenv "TZ"))) | |
593 | (unwind-protect | |
594 | (progn | |
595 | (set-time-zone-rule add-log-time-zone-rule) | |
596 | (funcall add-log-time-format)) | |
597 | (set-time-zone-rule tz))) | |
598 | (funcall add-log-time-format)) | |
599 | " " full-name | |
600 | " <" addr ">")) | |
601 | (if (consp mailing-address) | |
602 | mailing-address | |
603 | (list mailing-address))))) | |
604 | (if (and (not add-log-always-start-new-record) | |
605 | (let ((hit nil)) | |
606 | (dolist (entry new-entries hit) | |
607 | (when (looking-at (regexp-quote entry)) | |
608 | (setq hit t))))) | |
609 | (forward-line 1) | |
610 | (insert (nth (random (length new-entries)) | |
611 | new-entries) | |
612 | (if use-hard-newlines hard-newline "\n") | |
613 | (if use-hard-newlines hard-newline "\n")) | |
614 | (forward-line -1)))) | |
82f4acaf | 615 | |
d882f144 RS |
616 | ;; Determine where we should stop searching for a usable |
617 | ;; item to add to, within this entry. | |
ad4573c7 SM |
618 | (let ((bound |
619 | (save-excursion | |
620 | (if (looking-at "\n*[^\n* \t]") | |
621 | (skip-chars-forward "\n") | |
622 | (if add-log-keep-changes-together | |
623 | (forward-page) ; page delimits entries for date | |
624 | (forward-paragraph))) ; paragraph delimits entries for file | |
625 | (point)))) | |
626 | ||
627 | ;; Now insert the new line for this item. | |
628 | (cond ((re-search-forward "^\\s *\\*\\s *$" bound t) | |
629 | ;; Put this file name into the existing empty item. | |
630 | (if item | |
631 | (insert item))) | |
632 | ((and (not new-entry) | |
633 | (let (case-fold-search) | |
634 | (re-search-forward | |
635 | (concat (regexp-quote (concat "* " item)) | |
636 | ;; Don't accept `foo.bar' when | |
637 | ;; looking for `foo': | |
638 | "\\(\\s \\|[(),:]\\)") | |
639 | bound t))) | |
640 | ;; Add to the existing item for the same file. | |
641 | (re-search-forward "^\\s *$\\|^\\s \\*") | |
642 | (goto-char (match-beginning 0)) | |
643 | ;; Delete excess empty lines; make just 2. | |
644 | (while (and (not (eobp)) (looking-at "^\\s *$")) | |
645 | (delete-region (point) (line-beginning-position 2))) | |
646 | (insert (if use-hard-newlines hard-newline "\n") | |
647 | (if use-hard-newlines hard-newline "\n")) | |
648 | (forward-line -2) | |
649 | (indent-relative-maybe)) | |
650 | (t | |
651 | ;; Make a new item. | |
652 | (while (looking-at "\\sW") | |
653 | (forward-line 1)) | |
654 | (while (and (not (eobp)) (looking-at "^\\s *$")) | |
655 | (delete-region (point) (line-beginning-position 2))) | |
656 | (insert (if use-hard-newlines hard-newline "\n") | |
657 | (if use-hard-newlines hard-newline "\n") | |
658 | (if use-hard-newlines hard-newline "\n")) | |
659 | (forward-line -2) | |
660 | (indent-to left-margin) | |
661 | (insert "* ") | |
662 | (if item (insert item))))) | |
1832dbd1 | 663 | ;; Now insert the function name, if we have one. |
d882f144 | 664 | ;; Point is at the item for this file, |
21d7e080 | 665 | ;; either at the end of the line or at the first blank line. |
5a9ac14b SM |
666 | (if (not defun) |
667 | ;; No function name, so put in a colon unless we have just a star. | |
668 | (unless (save-excursion | |
669 | (beginning-of-line 1) | |
670 | (looking-at "\\s *\\(\\*\\s *\\)?$")) | |
671 | (insert ": ") | |
7b297602 | 672 | (if version (insert version ?\s))) |
5a9ac14b SM |
673 | ;; Make it easy to get rid of the function name. |
674 | (undo-boundary) | |
5960adc7 DL |
675 | (unless (save-excursion |
676 | (beginning-of-line 1) | |
5a9ac14b | 677 | (looking-at "\\s *$")) |
7b297602 | 678 | (insert ?\s)) |
5a9ac14b SM |
679 | ;; See if the prev function name has a message yet or not. |
680 | ;; If not, merge the two items. | |
681 | (let ((pos (point-marker))) | |
682 | (skip-syntax-backward " ") | |
683 | (skip-chars-backward "):") | |
684 | (if (and (looking-at "):") | |
fc9b0554 SM |
685 | (let ((pos (save-excursion (backward-sexp 1) (point)))) |
686 | (when (equal (buffer-substring pos (point)) defun) | |
687 | (delete-region pos (point))) | |
688 | (> fill-column (+ (current-column) (length defun) 4)))) | |
689 | (progn (skip-chars-backward ", ") | |
690 | (delete-region (point) pos) | |
691 | (unless (memq (char-before) '(?\()) (insert ", "))) | |
5a9ac14b SM |
692 | (if (looking-at "):") |
693 | (delete-region (+ 1 (point)) (line-end-position))) | |
694 | (goto-char pos) | |
695 | (insert "(")) | |
696 | (set-marker pos nil)) | |
697 | (insert defun "): ") | |
7b297602 | 698 | (if version (insert version ?\s))))) |
84fc2cfa | 699 | |
84fc2cfa ER |
700 | ;;;###autoload |
701 | (defun add-change-log-entry-other-window (&optional whoami file-name) | |
d882f144 RS |
702 | "Find change log file in other window and add entry and item. |
703 | This is just like `add-change-log-entry' except that it displays | |
704 | the change log file in another window." | |
84fc2cfa ER |
705 | (interactive (if current-prefix-arg |
706 | (list current-prefix-arg | |
707 | (prompt-for-change-log-name)))) | |
708 | (add-change-log-entry whoami file-name t)) | |
709 | ||
6dbf6147 | 710 | |
d1921057 | 711 | (defvar change-log-indent-text 0) |
fc9b0554 | 712 | |
6dbf6147 MR |
713 | (defun change-log-fill-parenthesized-list () |
714 | ;; Fill parenthesized lists of names according to GNU standards. | |
715 | ;; * file-name.ext (very-long-foo, very-long-bar, very-long-foobar): | |
716 | ;; should be filled as | |
717 | ;; * file-name.ext (very-long-foo, very-long-bar) | |
718 | ;; (very-long-foobar): | |
719 | (save-excursion | |
720 | (end-of-line 0) | |
721 | (skip-chars-backward " \t") | |
722 | (when (and (equal (char-before) ?\,) | |
723 | (> (point) (1+ (point-min)))) | |
724 | (condition-case nil | |
725 | (when (save-excursion | |
726 | (and (prog2 | |
727 | (up-list -1) | |
728 | (equal (char-after) ?\() | |
729 | (skip-chars-backward " \t")) | |
730 | (or (bolp) | |
731 | ;; Skip everything but a whitespace or asterisk. | |
732 | (and (not (zerop (skip-chars-backward "^ \t\n*"))) | |
733 | (skip-chars-backward " \t") | |
734 | ;; We want one asterisk here. | |
735 | (= (skip-chars-backward "*") -1) | |
736 | (skip-chars-backward " \t") | |
737 | (bolp))))) | |
738 | ;; Delete the comma. | |
739 | (delete-char -1) | |
740 | ;; Close list on previous line. | |
741 | (insert ")") | |
742 | (skip-chars-forward " \t\n") | |
743 | ;; Start list on new line. | |
744 | (insert-before-markers "(")) | |
745 | (error nil))))) | |
746 | ||
d1921057 | 747 | (defun change-log-indent () |
6dbf6147 | 748 | (change-log-fill-parenthesized-list) |
fc9b0554 SM |
749 | (let* ((indent |
750 | (save-excursion | |
751 | (beginning-of-line) | |
752 | (skip-chars-forward " \t") | |
753 | (cond | |
d1921057 | 754 | ((and (looking-at "\\(.*\\) [^ \n].*[^ \n] <.*>\\(?: +(.*)\\)? *$") |
fc9b0554 SM |
755 | ;; Matching the output of add-log-time-format is difficult, |
756 | ;; but I'll get it has at least two adjacent digits. | |
757 | (string-match "[[:digit:]][[:digit:]]" (match-string 1))) | |
758 | 0) | |
759 | ((looking-at "[^*(]") | |
d1921057 | 760 | (+ (current-left-margin) change-log-indent-text)) |
fc9b0554 SM |
761 | (t (current-left-margin))))) |
762 | (pos (save-excursion (indent-line-to indent) (point)))) | |
763 | (if (> pos (point)) (goto-char pos)))) | |
764 | ||
765 | ||
3066d4ad SM |
766 | (defvar smerge-resolve-function) |
767 | ||
1da56800 | 768 | ;;;###autoload |
7cd017ba | 769 | (define-derived-mode change-log-mode text-mode "Change Log" |
eb8c3be9 | 770 | "Major mode for editing change logs; like Indented Text Mode. |
09b389d0 | 771 | Prevents numeric backups and sets `left-margin' to 8 and `fill-column' to 74. |
3697b807 | 772 | New log entries are usually made with \\[add-change-log-entry] or \\[add-change-log-entry-other-window]. |
5516387c | 773 | Each entry behaves as a paragraph, and the entries for one day as a page. |
3066d4ad SM |
774 | Runs `change-log-mode-hook'. |
775 | \\{change-log-mode-map}" | |
7cd017ba | 776 | (setq left-margin 8 |
4f675a8c | 777 | fill-column 74 |
60f10a06 | 778 | indent-tabs-mode t |
ccf0d2ca JB |
779 | tab-width 8 |
780 | show-trailing-whitespace t) | |
60f10a06 KH |
781 | (set (make-local-variable 'fill-paragraph-function) |
782 | 'change-log-fill-paragraph) | |
3ee9a09c MR |
783 | ;; Avoid that filling leaves behind a single "*" on a line. |
784 | (add-hook 'fill-nobreak-predicate | |
785 | '(lambda () | |
786 | (looking-back "^\\s *\\*\\s *" (line-beginning-position))) | |
787 | nil t) | |
d1921057 | 788 | (set (make-local-variable 'indent-line-function) 'change-log-indent) |
fc9b0554 | 789 | (set (make-local-variable 'tab-always-indent) nil) |
4b7d4d0d DL |
790 | ;; We really do want "^" in paragraph-start below: it is only the |
791 | ;; lines that begin at column 0 (despite the left-margin of 8) that | |
792 | ;; we are looking for. Adding `* ' allows eliding the blank line | |
793 | ;; between entries for different files. | |
c9cfb0f2 | 794 | (set (make-local-variable 'paragraph-start) "\\s *$\\|\f\\|^\\<") |
4b7d4d0d | 795 | (set (make-local-variable 'paragraph-separate) paragraph-start) |
2c91c85c RS |
796 | ;; Match null string on the date-line so that the date-line |
797 | ;; is grouped with what follows. | |
964141f2 | 798 | (set (make-local-variable 'page-delimiter) "^\\<\\|^\f") |
dd309224 | 799 | (set (make-local-variable 'version-control) 'never) |
7cd017ba SM |
800 | (set (make-local-variable 'smerge-resolve-function) |
801 | 'change-log-resolve-conflict) | |
dd309224 | 802 | (set (make-local-variable 'adaptive-fill-regexp) "\\s *") |
4b286eca | 803 | (set (make-local-variable 'font-lock-defaults) |
73b27641 JL |
804 | '(change-log-font-lock-keywords t nil nil backward-paragraph)) |
805 | (set (make-local-variable 'isearch-buffers-next-buffer-function) | |
806 | 'change-log-next-buffer) | |
0bde6a03 DN |
807 | (set (make-local-variable 'beginning-of-defun-function) |
808 | 'change-log-beginning-of-defun) | |
809 | (set (make-local-variable 'end-of-defun-function) | |
810 | 'change-log-end-of-defun) | |
73b27641 JL |
811 | (isearch-buffers-minor-mode)) |
812 | ||
813 | (defun change-log-next-buffer (&optional buffer wrap) | |
814 | "Return the next buffer in the series of ChangeLog file buffers. | |
815 | This function is used for multiple buffers isearch. | |
816 | A sequence of buffers is formed by ChangeLog files with decreasing | |
817 | numeric file name suffixes in the directory of the initial ChangeLog | |
818 | file were isearch was started." | |
819 | (let* ((name (change-log-name)) | |
820 | (files (cons name (sort (file-expand-wildcards | |
821 | (concat name "[-.][0-9]*")) | |
822 | (lambda (a b) | |
bac2f6bc SM |
823 | ;; The file's extension may not have a valid |
824 | ;; version form (e.g. VC backup revisions). | |
825 | (ignore-errors | |
826 | (version< (substring b (length name)) | |
827 | (substring a (length name)))))))) | |
73b27641 JL |
828 | (files (if isearch-forward files (reverse files)))) |
829 | (find-file-noselect | |
830 | (if wrap | |
831 | (car files) | |
832 | (cadr (member (file-name-nondirectory (buffer-file-name buffer)) | |
833 | files)))))) | |
21d7e080 | 834 | |
287d149f RM |
835 | ;; It might be nice to have a general feature to replace this. The idea I |
836 | ;; have is a variable giving a regexp matching text which should not be | |
837 | ;; moved from bol by filling. change-log-mode would set this to "^\\s *\\s(". | |
838 | ;; But I don't feel up to implementing that today. | |
839 | (defun change-log-fill-paragraph (&optional justify) | |
840 | "Fill the paragraph, but preserve open parentheses at beginning of lines. | |
841 | Prefix arg means justify as well." | |
842 | (interactive "P") | |
8d6467a4 RS |
843 | (let ((end (progn (forward-paragraph) (point))) |
844 | (beg (progn (backward-paragraph) (point))) | |
6dbf6147 MR |
845 | ;; Add lines starting with whitespace followed by a left paren or an |
846 | ;; asterisk. | |
847 | (paragraph-start (concat paragraph-start "\\|\\s *\\(?:\\s(\\|\\*\\)")) | |
848 | ;; Make sure we call `change-log-indent'. | |
849 | (fill-indent-according-to-mode t)) | |
8d6467a4 RS |
850 | (fill-region beg end justify) |
851 | t)) | |
287d149f | 852 | \f |
fcad5199 | 853 | (defcustom add-log-current-defun-header-regexp |
a8d693d8 | 854 | "^\\([[:upper:]][[:upper:]_ ]*[[:upper:]_]\\|[-_[:alpha:]]+\\)[ \t]*[:=]" |
d1921057 | 855 | "Heuristic regexp used by `add-log-current-defun' for unknown major modes." |
fcad5199 RS |
856 | :type 'regexp |
857 | :group 'change-log) | |
21d7e080 | 858 | |
fb644f48 EN |
859 | ;;;###autoload |
860 | (defvar add-log-lisp-like-modes | |
d1921057 | 861 | '(emacs-lisp-mode lisp-mode scheme-mode dsssl-mode lisp-interaction-mode) |
fb644f48 EN |
862 | "*Modes that look like Lisp to `add-log-current-defun'.") |
863 | ||
864 | ;;;###autoload | |
865 | (defvar add-log-c-like-modes | |
d1921057 | 866 | '(c-mode c++-mode c++-c-mode objc-mode) |
fb644f48 EN |
867 | "*Modes that look like C to `add-log-current-defun'.") |
868 | ||
869 | ;;;###autoload | |
870 | (defvar add-log-tex-like-modes | |
bb042dc6 | 871 | '(TeX-mode plain-TeX-mode LaTeX-mode tex-mode) |
fb644f48 EN |
872 | "*Modes that look like TeX to `add-log-current-defun'.") |
873 | ||
ab319633 GM |
874 | (declare-function c-cpp-define-name "cc-cmds" ()) |
875 | (declare-function c-defun-name "cc-cmds" ()) | |
004a00f4 | 876 | |
e332f80b | 877 | ;;;###autoload |
21d7e080 ER |
878 | (defun add-log-current-defun () |
879 | "Return name of function definition point is in, or nil. | |
880 | ||
63314951 | 881 | Understands C, Lisp, LaTeX (\"functions\" are chapters, sections, ...), |
5960adc7 | 882 | Texinfo (@node titles) and Perl. |
21d7e080 ER |
883 | |
884 | Other modes are handled by a heuristic that looks in the 10K before | |
885 | point for uppercase headings starting in the first column or | |
5960adc7 | 886 | identifiers followed by `:' or `='. See variables |
c1356086 | 887 | `add-log-current-defun-header-regexp' and |
5ef08021 | 888 | `add-log-current-defun-function'. |
21d7e080 ER |
889 | |
890 | Has a preference of looking backwards." | |
2cc0b765 RS |
891 | (condition-case nil |
892 | (save-excursion | |
893 | (let ((location (point))) | |
5960adc7 DL |
894 | (cond (add-log-current-defun-function |
895 | (funcall add-log-current-defun-function)) | |
bb042dc6 | 896 | ((apply 'derived-mode-p add-log-lisp-like-modes) |
a0151877 | 897 | ;; If we are now precisely at the beginning of a defun, |
2cc0b765 RS |
898 | ;; make sure beginning-of-defun finds that one |
899 | ;; rather than the previous one. | |
900 | (or (eobp) (forward-char 1)) | |
901 | (beginning-of-defun) | |
5960adc7 DL |
902 | ;; Make sure we are really inside the defun found, |
903 | ;; not after it. | |
42b1fc29 RS |
904 | (when (and (looking-at "\\s(") |
905 | (progn (end-of-defun) | |
906 | (< location (point))) | |
907 | (progn (forward-sexp -1) | |
908 | (>= location (point)))) | |
909 | (if (looking-at "\\s(") | |
910 | (forward-char 1)) | |
911 | ;; Skip the defining construct name, typically "defun" | |
912 | ;; or "defvar". | |
913 | (forward-sexp 1) | |
914 | ;; The second element is usually a symbol being defined. | |
915 | ;; If it is not, use the first symbol in it. | |
63c7727f | 916 | (skip-chars-forward " \t\n'(") |
5960adc7 DL |
917 | (buffer-substring-no-properties (point) |
918 | (progn (forward-sexp 1) | |
919 | (point))))) | |
bb042dc6 | 920 | ((apply 'derived-mode-p add-log-c-like-modes) |
221fcdaa AM |
921 | (or (c-cpp-define-name) |
922 | (c-defun-name))) | |
923 | ((memq major-mode add-log-tex-like-modes) | |
2cc0b765 | 924 | (if (re-search-backward |
5960adc7 DL |
925 | "\\\\\\(sub\\)*\\(section\\|paragraph\\|chapter\\)" |
926 | nil t) | |
2cc0b765 RS |
927 | (progn |
928 | (goto-char (match-beginning 0)) | |
5960adc7 DL |
929 | (buffer-substring-no-properties |
930 | (1+ (point)) ; without initial backslash | |
931 | (line-end-position))))) | |
bb042dc6 | 932 | ((derived-mode-p 'texinfo-mode) |
3071ee28 | 933 | (if (re-search-backward "^@node[ \t]+\\([^,\n]+\\)" nil t) |
5960adc7 | 934 | (match-string-no-properties 1))) |
fb1b68a4 | 935 | ((derived-mode-p 'perl-mode 'cperl-mode) |
5a9ac14b | 936 | (if (re-search-backward "^sub[ \t]+\\([^({ \t\n]+\\)" nil t) |
5960adc7 DL |
937 | (match-string-no-properties 1))) |
938 | ;; Emacs's autoconf-mode installs its own | |
939 | ;; `add-log-current-defun-function'. This applies to | |
940 | ;; a different mode apparently for editing .m4 | |
941 | ;; autoconf source. | |
bb042dc6 | 942 | ((derived-mode-p 'autoconf-mode) |
5960adc7 DL |
943 | (if (re-search-backward |
944 | "^\\(\\(m4_\\)?define\\|A._DEFUN\\)(\\[?\\([A-Za-z0-9_]+\\)" nil t) | |
945 | (match-string-no-properties 3))) | |
2cc0b765 RS |
946 | (t |
947 | ;; If all else fails, try heuristics | |
c1356086 GM |
948 | (let (case-fold-search |
949 | result) | |
2cc0b765 | 950 | (end-of-line) |
c1356086 GM |
951 | (when (re-search-backward |
952 | add-log-current-defun-header-regexp | |
953 | (- (point) 10000) | |
954 | t) | |
5960adc7 DL |
955 | (setq result (or (match-string-no-properties 1) |
956 | (match-string-no-properties 0))) | |
c1356086 GM |
957 | ;; Strip whitespace away |
958 | (when (string-match "\\([^ \t\n\r\f].*[^ \t\n\r\f]\\)" | |
959 | result) | |
5960adc7 | 960 | (setq result (match-string-no-properties 1 result))) |
c1356086 | 961 | result)))))) |
2cc0b765 | 962 | (error nil))) |
ef15f270 | 963 | |
83afd62c | 964 | (defvar change-log-get-method-definition-md) |
15319a8f | 965 | |
83afd62c | 966 | ;; Subroutine used within change-log-get-method-definition. |
59c1a7de RS |
967 | ;; Add the last match in the buffer to the end of `md', |
968 | ;; followed by the string END; move to the end of that match. | |
83afd62c KH |
969 | (defun change-log-get-method-definition-1 (end) |
970 | (setq change-log-get-method-definition-md | |
971 | (concat change-log-get-method-definition-md | |
5960adc7 | 972 | (match-string 1) |
15319a8f | 973 | end)) |
59c1a7de RS |
974 | (goto-char (match-end 0))) |
975 | ||
83afd62c | 976 | (defun change-log-get-method-definition () |
eba72fc1 | 977 | "For Objective C, return the method name if we are in a method." |
83afd62c | 978 | (let ((change-log-get-method-definition-md "[")) |
59c1a7de | 979 | (save-excursion |
f27f16ed | 980 | (if (re-search-backward "^@implementation\\s-*\\([A-Za-z_]*\\)" nil t) |
83afd62c | 981 | (change-log-get-method-definition-1 " "))) |
59c1a7de RS |
982 | (save-excursion |
983 | (cond | |
f27f16ed | 984 | ((re-search-forward "^\\([-+]\\)[ \t\n\f\r]*\\(([^)]*)\\)?\\s-*" nil t) |
83afd62c | 985 | (change-log-get-method-definition-1 "") |
59c1a7de RS |
986 | (while (not (looking-at "[{;]")) |
987 | (looking-at | |
f27f16ed | 988 | "\\([A-Za-z_]*:?\\)\\s-*\\(([^)]*)\\)?[A-Za-z_]*[ \t\n\f\r]*") |
83afd62c KH |
989 | (change-log-get-method-definition-1 "")) |
990 | (concat change-log-get-method-definition-md "]")))))) | |
075a6629 DL |
991 | \f |
992 | (defun change-log-sortable-date-at () | |
993 | "Return date of log entry in a consistent form for sorting. | |
994 | Point is assumed to be at the start of the entry." | |
995 | (require 'timezone) | |
0bde6a03 | 996 | (if (looking-at change-log-start-entry-re) |
075a6629 DL |
997 | (let ((date (match-string-no-properties 0))) |
998 | (if date | |
999 | (if (string-match "\\(....\\)-\\(..\\)-\\(..\\)\\s-+" date) | |
1000 | (concat (match-string 1 date) (match-string 2 date) | |
1001 | (match-string 3 date)) | |
1002 | (condition-case nil | |
1003 | (timezone-make-date-sortable date) | |
1004 | (error nil))))) | |
1005 | (error "Bad date"))) | |
59c1a7de | 1006 | |
7cd017ba SM |
1007 | (defun change-log-resolve-conflict () |
1008 | "Function to be used in `smerge-resolve-function'." | |
74dea9e1 SM |
1009 | (save-excursion |
1010 | (save-restriction | |
1011 | (narrow-to-region (match-beginning 0) (match-end 0)) | |
1012 | (let ((mb1 (match-beginning 1)) | |
1013 | (me1 (match-end 1)) | |
1014 | (mb3 (match-beginning 3)) | |
1015 | (me3 (match-end 3)) | |
1016 | (tmp1 (generate-new-buffer " *changelog-resolve-1*")) | |
1017 | (tmp2 (generate-new-buffer " *changelog-resolve-2*"))) | |
1018 | (unwind-protect | |
1019 | (let ((buf (current-buffer))) | |
1020 | (with-current-buffer tmp1 | |
1021 | (change-log-mode) | |
1022 | (insert-buffer-substring buf mb1 me1)) | |
1023 | (with-current-buffer tmp2 | |
1024 | (change-log-mode) | |
1025 | (insert-buffer-substring buf mb3 me3) | |
1026 | ;; Do the merge here instead of inside `buf' so as to be | |
1027 | ;; more robust in case change-log-merge fails. | |
1028 | (change-log-merge tmp1)) | |
1029 | (goto-char (point-max)) | |
1030 | (delete-region (point-min) | |
1031 | (prog1 (point) | |
1032 | (insert-buffer-substring tmp2)))) | |
1033 | (kill-buffer tmp1) | |
1034 | (kill-buffer tmp2)))))) | |
7cd017ba | 1035 | |
075a6629 DL |
1036 | ;;;###autoload |
1037 | (defun change-log-merge (other-log) | |
eba72fc1 | 1038 | "Merge the contents of change log file OTHER-LOG with this buffer. |
075a6629 | 1039 | Both must be found in Change Log mode (since the merging depends on |
7cd017ba SM |
1040 | the appropriate motion commands). OTHER-LOG can be either a file name |
1041 | or a buffer. | |
075a6629 | 1042 | |
918f4ac3 DL |
1043 | Entries are inserted in chronological order. Both the current and |
1044 | old-style time formats for entries are supported." | |
075a6629 | 1045 | (interactive "*fLog file name to merge: ") |
bb042dc6 | 1046 | (if (not (derived-mode-p 'change-log-mode)) |
075a6629 | 1047 | (error "Not in Change Log mode")) |
7cd017ba SM |
1048 | (let ((other-buf (if (bufferp other-log) other-log |
1049 | (find-file-noselect other-log))) | |
075a6629 DL |
1050 | (buf (current-buffer)) |
1051 | date1 start end) | |
1052 | (save-excursion | |
1053 | (goto-char (point-min)) | |
1054 | (set-buffer other-buf) | |
1055 | (goto-char (point-min)) | |
bb042dc6 | 1056 | (if (not (derived-mode-p 'change-log-mode)) |
075a6629 DL |
1057 | (error "%s not found in Change Log mode" other-log)) |
1058 | ;; Loop through all the entries in OTHER-LOG. | |
1059 | (while (not (eobp)) | |
1060 | (setq date1 (change-log-sortable-date-at)) | |
1061 | (setq start (point) | |
1062 | end (progn (forward-page) (point))) | |
1063 | ;; Look for an entry in original buffer that isn't later. | |
1064 | (with-current-buffer buf | |
1065 | (while (and (not (eobp)) | |
1066 | (string< date1 (change-log-sortable-date-at))) | |
1067 | (forward-page)) | |
1068 | (if (not (eobp)) | |
1069 | (insert-buffer-substring other-buf start end) | |
1070 | ;; At the end of the original buffer, insert a newline to | |
1071 | ;; separate entries and then the rest of the file being | |
7cd017ba SM |
1072 | ;; merged. |
1073 | (unless (or (bobp) | |
1074 | (and (= ?\n (char-before)) | |
1075 | (or (<= (1- (point)) (point-min)) | |
1076 | (= ?\n (char-before (1- (point))))))) | |
97f4e87c | 1077 | (insert (if use-hard-newlines hard-newline "\n"))) |
7cd017ba SM |
1078 | ;; Move to the end of it to terminate outer loop. |
1079 | (with-current-buffer other-buf | |
1080 | (goto-char (point-max))) | |
1081 | (insert-buffer-substring other-buf start))))))) | |
ef15f270 | 1082 | |
0bde6a03 DN |
1083 | (defun change-log-beginning-of-defun () |
1084 | (re-search-backward change-log-start-entry-re nil 'move)) | |
1085 | ||
1086 | (defun change-log-end-of-defun () | |
1087 | ;; Look back and if there is no entry there it means we are before | |
1088 | ;; the first ChangeLog entry, so go forward until finding one. | |
1089 | (unless (save-excursion (re-search-backward change-log-start-entry-re nil t)) | |
1090 | (re-search-forward change-log-start-entry-re nil t)) | |
1091 | ||
1092 | ;; In case we are at the end of log entry going forward a line will | |
1093 | ;; make us find the next entry when searching. If we are inside of | |
1094 | ;; an entry going forward a line will still keep the point inside | |
1095 | ;; the same entry. | |
1096 | (forward-line 1) | |
1097 | ||
1098 | ;; In case we are at the beginning of an entry, move past it. | |
1099 | (when (looking-at change-log-start-entry-re) | |
1100 | (goto-char (match-end 0)) | |
1101 | (forward-line 1)) | |
1102 | ||
1103 | ;; Search for the start of the next log entry. Go to the end of the | |
1104 | ;; buffer if we could not find a next entry. | |
1105 | (when (re-search-forward change-log-start-entry-re nil 'move) | |
1106 | (goto-char (match-beginning 0)) | |
1107 | (forward-line -1))) | |
1108 | ||
1da56800 RS |
1109 | (provide 'add-log) |
1110 | ||
d1921057 | 1111 | ;; arch-tag: 81eee6fc-088f-4372-a37f-80ad9620e762 |
fd7fa35a | 1112 | ;;; add-log.el ends here |