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