Commit | Line | Data |
---|---|---|
a8581027 | 1 | ;;; format.el --- read and save files in multiple formats |
b578f267 | 2 | |
95df8112 GM |
3 | ;; Copyright (C) 1994-1995, 1997, 1999, 2001-2011 |
4 | ;; Free Software Foundation, Inc. | |
029894b9 | 5 | |
823139fb | 6 | ;; Author: Boris Goldowsky <boris@gnu.org> |
bd78fa1d | 7 | ;; Package: emacs |
029894b9 BG |
8 | |
9 | ;; This file is part of GNU Emacs. | |
10 | ||
eb3fa2cf | 11 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
029894b9 | 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. | |
b578f267 | 15 | |
029894b9 BG |
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. | |
b578f267 | 20 | |
029894b9 | 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/>. |
029894b9 BG |
23 | |
24 | ;;; Commentary: | |
b578f267 EN |
25 | |
26 | ;; This file defines a unified mechanism for saving & loading files stored | |
27 | ;; in different formats. `format-alist' contains information that directs | |
029894b9 | 28 | ;; Emacs to call an encoding or decoding function when reading or writing |
823139fb | 29 | ;; files that match certain conditions. |
029894b9 | 30 | ;; |
b578f267 EN |
31 | ;; When a file is visited, its format is determined by matching the |
32 | ;; beginning of the file against regular expressions stored in | |
33 | ;; `format-alist'. If this fails, you can manually translate the buffer | |
34 | ;; using `format-decode-buffer'. In either case, the formats used are | |
35 | ;; listed in the variable `buffer-file-format', and become the default | |
36 | ;; format for saving the buffer. To save a buffer in a different format, | |
37 | ;; change this variable, or use `format-write-file'. | |
029894b9 BG |
38 | ;; |
39 | ;; Auto-save files are normally created in the same format as the visited | |
4a2255ad | 40 | ;; file, but the variable `buffer-auto-save-file-format' can be set to a |
b578f267 EN |
41 | ;; particularly fast or otherwise preferred format to be used for |
42 | ;; auto-saving (or nil to do no encoding on auto-save files, but then you | |
43 | ;; risk losing any text-properties in the buffer). | |
029894b9 | 44 | ;; |
b578f267 EN |
45 | ;; You can manually translate a buffer into or out of a particular format |
46 | ;; with the functions `format-encode-buffer' and `format-decode-buffer'. | |
47 | ;; To translate just the region use the functions `format-encode-region' | |
823139fb | 48 | ;; and `format-decode-region'. |
029894b9 | 49 | ;; |
b578f267 EN |
50 | ;; You can define a new format by writing the encoding and decoding |
51 | ;; functions, and adding an entry to `format-alist'. See enriched.el for | |
52 | ;; an example of how to implement a file format. There are various | |
53 | ;; functions defined in this file that may be useful for writing the | |
54 | ;; encoding and decoding functions: | |
55 | ;; * `format-annotate-region' and `format-deannotate-region' allow a | |
56 | ;; single alist of information to be used for encoding and decoding. | |
57 | ;; The alist defines a correspondence between strings in the file | |
58 | ;; ("annotations") and text-properties in the buffer. | |
029894b9 BG |
59 | ;; * `format-replace-strings' is similarly useful for doing simple |
60 | ;; string->string translations in a reversible manner. | |
61 | ||
b578f267 EN |
62 | ;;; Code: |
63 | ||
029894b9 | 64 | (put 'buffer-file-format 'permanent-local t) |
4a2255ad | 65 | (put 'buffer-auto-save-file-format 'permanent-local t) |
029894b9 | 66 | |
823139fb | 67 | (defvar format-alist |
6bdad9ae DN |
68 | ;; FIXME: maybe each item can be purecopied instead of just the strings. |
69 | `((text/enriched ,(purecopy "Extended MIME text/enriched format.") | |
70 | ,(purecopy "Content-[Tt]ype:[ \t]*text/enriched") | |
029894b9 | 71 | enriched-decode enriched-encode t enriched-mode) |
6bdad9ae | 72 | (plain ,(purecopy "ISO 8859-1 standard format, no text properties.") |
029894b9 BG |
73 | ;; Plain only exists so that there is an obvious neutral choice in |
74 | ;; the completion list. | |
c84cf2bf | 75 | nil nil nil nil nil) |
6bdad9ae | 76 | (TeX ,(purecopy "TeX (encoding)") |
823139fb | 77 | nil |
c84cf2bf | 78 | iso-tex2iso iso-iso2tex t nil) |
6bdad9ae | 79 | (gtex ,(purecopy "German TeX (encoding)") |
823139fb | 80 | nil |
c84cf2bf | 81 | iso-gtex2iso iso-iso2gtex t nil) |
6bdad9ae | 82 | (html ,(purecopy "HTML/SGML \"ISO 8879:1986//ENTITIES Added Latin 1//EN\" (encoding)") |
823139fb | 83 | nil |
f1d6fe69 | 84 | iso-sgml2iso iso-iso2sgml t nil) |
6bdad9ae | 85 | (rot13 ,(purecopy "rot13") |
823139fb | 86 | nil |
6bdad9ae DN |
87 | ,(purecopy "tr a-mn-z n-za-m") ,(purecopy "tr a-mn-z n-za-m") t nil) |
88 | (duden ,(purecopy "Duden Ersatzdarstellung") | |
823139fb | 89 | nil |
6bdad9ae DN |
90 | ,(purecopy "diac") iso-iso2duden t nil) |
91 | (de646 ,(purecopy "German ASCII (ISO 646)") | |
823139fb | 92 | nil |
6bdad9ae DN |
93 | ,(purecopy "recode -f iso646-ge:latin1") |
94 | ,(purecopy "recode -f latin1:iso646-ge") t nil) | |
95 | (denet ,(purecopy "net German") | |
823139fb | 96 | nil |
c84cf2bf | 97 | iso-german iso-cvt-read-only t nil) |
6bdad9ae | 98 | (esnet ,(purecopy "net Spanish") |
823139fb | 99 | nil |
8d0dd9d2 | 100 | iso-spanish iso-cvt-read-only t nil)) |
029894b9 | 101 | "List of information about understood file formats. |
ce44e932 GM |
102 | Elements are of the form |
103 | \(NAME DOC-STR REGEXP FROM-FN TO-FN MODIFY MODE-FN PRESERVE). | |
d1ae737b | 104 | |
029894b9 | 105 | NAME is a symbol, which is stored in `buffer-file-format'. |
d1ae737b | 106 | |
029894b9 BG |
107 | DOC-STR should be a single line providing more information about the |
108 | format. It is currently unused, but in the future will be shown to | |
109 | the user if they ask for more information. | |
d1ae737b | 110 | |
029894b9 | 111 | REGEXP is a regular expression to match against the beginning of the file; |
7bfd055d GM |
112 | it should match only files in that format. REGEXP may be nil, in |
113 | which case the format will never be applied automatically to a file. | |
114 | Use this for formats that you only ever want to apply manually. | |
d1ae737b | 115 | |
12008438 | 116 | FROM-FN is called to decode files in that format; it takes two args, BEGIN |
029894b9 BG |
117 | and END, and can make any modifications it likes, returning the new |
118 | end. It must make sure that the beginning of the file no longer | |
119 | matches REGEXP, or else it will get called again. | |
d1ae737b RS |
120 | Alternatively, FROM-FN can be a string, which specifies a shell command |
121 | (including options) to be used as a filter to perform the conversion. | |
122 | ||
12008438 | 123 | TO-FN is called to encode a region into that format; it takes three |
d1abb42f RS |
124 | arguments: BEGIN, END, and BUFFER. BUFFER is the original buffer that |
125 | the data being written came from, which the function could use, for | |
126 | example, to find the values of local variables. TO-FN should either | |
127 | return a list of annotations like `write-region-annotate-functions', | |
128 | or modify the region and return the new end. | |
d1ae737b RS |
129 | Alternatively, TO-FN can be a string, which specifies a shell command |
130 | (including options) to be used as a filter to perform the conversion. | |
131 | ||
d1abb42f RS |
132 | MODIFY, if non-nil, means the TO-FN wants to modify the region. If nil, |
133 | TO-FN will not make any changes but will instead return a list of | |
823139fb | 134 | annotations. |
d1ae737b | 135 | |
3e224645 EZ |
136 | MODE-FN, if specified, is called when visiting a file with that format. |
137 | It is called with a single positive argument, on the assumption | |
12008438 | 138 | that this would turn on some minor mode. |
34f30f79 RS |
139 | |
140 | PRESERVE, if non-nil, means that `format-write-file' should not remove | |
ec8dda2f | 141 | this format from `buffer-file-format'.") |
ac549fa5 | 142 | ;;;###autoload |
6dc3311d | 143 | (put 'format-alist 'risky-local-variable t) |
029894b9 BG |
144 | |
145 | ;;; Basic Functions (called from Lisp) | |
146 | ||
c84cf2bf | 147 | (defun format-encode-run-method (method from to &optional buffer) |
12008438 TTN |
148 | "Translate using METHOD the text from FROM to TO. |
149 | If METHOD is a string, it is a shell command (including options); | |
c84cf2bf RS |
150 | otherwise, it should be a Lisp function. |
151 | BUFFER should be the buffer that the output originally came from." | |
152 | (if (stringp method) | |
823139fb | 153 | (let ((error-buff (get-buffer-create "*Format Errors*")) |
7cc45a35 | 154 | (coding-system-for-read 'no-conversion) |
823139fb DL |
155 | format-alist) |
156 | (with-current-buffer error-buff | |
157 | (widen) | |
158 | (erase-buffer)) | |
10fa0073 GM |
159 | (if (and (zerop (save-window-excursion |
160 | (shell-command-on-region from to method t t | |
161 | error-buff))) | |
823139fb DL |
162 | ;; gzip gives zero exit status with bad args, for instance. |
163 | (zerop (with-current-buffer error-buff | |
164 | (buffer-size)))) | |
165 | (bury-buffer error-buff) | |
166 | (switch-to-buffer-other-window error-buff) | |
10fa0073 | 167 | (error "Format encoding failed"))) |
c84cf2bf RS |
168 | (funcall method from to buffer))) |
169 | ||
170 | (defun format-decode-run-method (method from to &optional buffer) | |
12008438 TTN |
171 | "Decode using METHOD the text from FROM to TO. |
172 | If METHOD is a string, it is a shell command (including options); otherwise, | |
173 | it should be a Lisp function. Decoding is done for the given BUFFER." | |
c84cf2bf | 174 | (if (stringp method) |
823139fb | 175 | (let ((error-buff (get-buffer-create "*Format Errors*")) |
7cc45a35 | 176 | (coding-system-for-write 'no-conversion) |
823139fb DL |
177 | format-alist) |
178 | (with-current-buffer error-buff | |
179 | (widen) | |
180 | (erase-buffer)) | |
181 | ;; We should perhaps go via a temporary buffer and copy it | |
182 | ;; back, in case of errors. | |
183 | (if (and (zerop (save-window-excursion | |
3ecba049 | 184 | (shell-command-on-region from to method t t |
823139fb DL |
185 | error-buff))) |
186 | ;; gzip gives zero exit status with bad args, for instance. | |
187 | (zerop (with-current-buffer error-buff | |
188 | (buffer-size)))) | |
189 | (bury-buffer error-buff) | |
190 | (switch-to-buffer-other-window error-buff) | |
191 | (error "Format decoding failed")) | |
c84cf2bf RS |
192 | (point)) |
193 | (funcall method from to))) | |
194 | ||
10fa0073 | 195 | (defun format-annotate-function (format from to orig-buf format-count) |
823139fb | 196 | "Return annotations for writing region as FORMAT. |
12008438 TTN |
197 | FORMAT is a symbol naming one of the formats defined in `format-alist'. |
198 | It must be a single symbol, not a list like `buffer-file-format'. | |
d1abb42f RS |
199 | FROM and TO delimit the region to be operated on in the current buffer. |
200 | ORIG-BUF is the original buffer that the data came from. | |
10fa0073 GM |
201 | |
202 | FORMAT-COUNT is an integer specifying how many times this function has | |
203 | been called in the process of decoding ORIG-BUF. | |
204 | ||
12008438 | 205 | This function works like a function in `write-region-annotate-functions': |
029894b9 | 206 | it either returns a list of annotations, or returns with a different buffer |
10fa0073 GM |
207 | current, which contains the modified text to write. In the latter case, |
208 | this function's value is nil. | |
029894b9 BG |
209 | |
210 | For most purposes, consider using `format-encode-region' instead." | |
10fa0073 GM |
211 | ;; This function is called by write-region (actually |
212 | ;; build_annotations) for each element of buffer-file-format. | |
029894b9 BG |
213 | (let* ((info (assq format format-alist)) |
214 | (to-fn (nth 4 info)) | |
215 | (modify (nth 5 info))) | |
216 | (if to-fn | |
217 | (if modify | |
218 | ;; To-function wants to modify region. Copy to safe place. | |
10fa0073 | 219 | (let ((copy-buf (get-buffer-create (format " *Format Temp %d*" |
8a2f1176 RS |
220 | format-count))) |
221 | (sel-disp selective-display) | |
5258c763 JB |
222 | (multibyte enable-multibyte-characters) |
223 | (coding-system buffer-file-coding-system)) | |
8a2f1176 RS |
224 | (with-current-buffer copy-buf |
225 | (setq selective-display sel-disp) | |
5258c763 JB |
226 | (set-buffer-multibyte multibyte) |
227 | (setq buffer-file-coding-system coding-system)) | |
029894b9 BG |
228 | (copy-to-buffer copy-buf from to) |
229 | (set-buffer copy-buf) | |
230 | (format-insert-annotations write-region-annotations-so-far from) | |
c84cf2bf | 231 | (format-encode-run-method to-fn (point-min) (point-max) orig-buf) |
4e5617ee SM |
232 | (when (buffer-live-p copy-buf) |
233 | (with-current-buffer copy-buf | |
234 | ;; Set write-region-post-annotation-function to | |
235 | ;; delete the buffer once the write is done, but do | |
236 | ;; it after running to-fn so it doesn't affect | |
237 | ;; write-region calls in to-fn. | |
238 | (set (make-local-variable | |
239 | 'write-region-post-annotation-function) | |
240 | 'kill-buffer))) | |
029894b9 BG |
241 | nil) |
242 | ;; Otherwise just call function, it will return annotations. | |
d1abb42f | 243 | (funcall to-fn from to orig-buf))))) |
029894b9 BG |
244 | |
245 | (defun format-decode (format length &optional visit-flag) | |
246 | ;; This function is called by insert-file-contents whenever a file is read. | |
247 | "Decode text from any known FORMAT. | |
823139fb | 248 | FORMAT is a symbol appearing in `format-alist' or a list of such symbols, |
029894b9 BG |
249 | or nil, in which case this function tries to guess the format of the data by |
250 | matching against the regular expressions in `format-alist'. After a match is | |
251 | found and the region decoded, the alist is searched again from the beginning | |
252 | for another match. | |
253 | ||
254 | Second arg LENGTH is the number of characters following point to operate on. | |
255 | If optional third arg VISIT-FLAG is true, set `buffer-file-format' | |
be227f22 SM |
256 | to the reverted list of formats used, and call any mode functions defined |
257 | for those formats. | |
029894b9 | 258 | |
12008438 | 259 | Return the new length of the decoded region. |
029894b9 BG |
260 | |
261 | For most purposes, consider using `format-decode-region' instead." | |
262 | (let ((mod (buffer-modified-p)) | |
10fa0073 | 263 | (begin (point)) |
029894b9 | 264 | (end (+ (point) length))) |
10fa0073 GM |
265 | (unwind-protect |
266 | (progn | |
267 | ;; Don't record undo information for the decoding. | |
71296446 | 268 | |
10fa0073 GM |
269 | (if (null format) |
270 | ;; Figure out which format it is in, remember list in `format'. | |
271 | (let ((try format-alist)) | |
272 | (while try | |
273 | (let* ((f (car try)) | |
274 | (regexp (nth 2 f)) | |
275 | (p (point))) | |
276 | (if (and regexp (looking-at regexp) | |
277 | (< (match-end 0) (+ begin length))) | |
278 | (progn | |
be227f22 | 279 | (push (car f) format) |
10fa0073 GM |
280 | ;; Decode it |
281 | (if (nth 3 f) | |
282 | (setq end (format-decode-run-method (nth 3 f) begin end))) | |
283 | ;; Call visit function if required | |
284 | (if (and visit-flag (nth 6 f)) (funcall (nth 6 f) 1)) | |
285 | ;; Safeguard against either of the functions changing pt. | |
286 | (goto-char p) | |
287 | ;; Rewind list to look for another format | |
288 | (setq try format-alist)) | |
289 | (setq try (cdr try)))))) | |
290 | ;; Deal with given format(s) | |
291 | (or (listp format) (setq format (list format))) | |
292 | (let ((do format) f) | |
293 | (while do | |
294 | (or (setq f (assq (car do) format-alist)) | |
6b61353c | 295 | (error "Unknown format %s" (car do))) |
10fa0073 GM |
296 | ;; Decode: |
297 | (if (nth 3 f) | |
298 | (setq end (format-decode-run-method (nth 3 f) begin end))) | |
299 | ;; Call visit function if required | |
300 | (if (and visit-flag (nth 6 f)) (funcall (nth 6 f) 1)) | |
be227f22 SM |
301 | (setq do (cdr do)))) |
302 | ;; Encode in the opposite order. | |
303 | (setq format (reverse format))) | |
10fa0073 GM |
304 | (if visit-flag |
305 | (setq buffer-file-format format))) | |
71296446 | 306 | |
021cfbea GM |
307 | (set-buffer-modified-p mod)) |
308 | ||
10fa0073 | 309 | ;; Return new length of region |
029894b9 BG |
310 | (- end begin))) |
311 | ||
312 | ;;; | |
313 | ;;; Interactive functions & entry points | |
314 | ;;; | |
315 | ||
316 | (defun format-decode-buffer (&optional format) | |
317 | "Translate the buffer from some FORMAT. | |
12008438 TTN |
318 | If the format is not specified, attempt a regexp-based guess. |
319 | Set `buffer-file-format' to the format used, and call any | |
320 | format-specific mode functions." | |
029894b9 | 321 | (interactive |
5b76833f | 322 | (list (format-read "Translate buffer from format (default guess): "))) |
029894b9 BG |
323 | (save-excursion |
324 | (goto-char (point-min)) | |
325 | (format-decode format (buffer-size) t))) | |
326 | ||
327 | (defun format-decode-region (from to &optional format) | |
328 | "Decode the region from some format. | |
329 | Arg FORMAT is optional; if omitted the format will be determined by looking | |
330 | for identifying regular expressions at the beginning of the region." | |
331 | (interactive | |
823139fb | 332 | (list (region-beginning) (region-end) |
5b76833f | 333 | (format-read "Translate region from format (default guess): "))) |
029894b9 BG |
334 | (save-excursion |
335 | (goto-char from) | |
336 | (format-decode format (- to from) nil))) | |
337 | ||
338 | (defun format-encode-buffer (&optional format) | |
339 | "Translate the buffer into FORMAT. | |
340 | FORMAT defaults to `buffer-file-format'. It is a symbol naming one of the | |
341 | formats defined in `format-alist', or a list of such symbols." | |
342 | (interactive | |
343 | (list (format-read (format "Translate buffer to format (default %s): " | |
344 | buffer-file-format)))) | |
345 | (format-encode-region (point-min) (point-max) format)) | |
346 | ||
347 | (defun format-encode-region (beg end &optional format) | |
823139fb | 348 | "Translate the region into some FORMAT. |
12008438 | 349 | FORMAT defaults to `buffer-file-format'. It is a symbol naming |
029894b9 | 350 | one of the formats defined in `format-alist', or a list of such symbols." |
823139fb DL |
351 | (interactive |
352 | (list (region-beginning) (region-end) | |
353 | (format-read (format "Translate region to format (default %s): " | |
354 | buffer-file-format)))) | |
355 | (if (null format) (setq format buffer-file-format)) | |
356 | (if (symbolp format) (setq format (list format))) | |
357 | (save-excursion | |
358 | (goto-char end) | |
359 | (let ((cur-buf (current-buffer)) | |
360 | (end (point-marker))) | |
361 | (while format | |
362 | (let* ((info (assq (car format) format-alist)) | |
363 | (to-fn (nth 4 info)) | |
364 | (modify (nth 5 info)) | |
365 | result) | |
366 | (if to-fn | |
367 | (if modify | |
368 | (setq end (format-encode-run-method to-fn beg end | |
369 | (current-buffer))) | |
370 | (format-insert-annotations | |
371 | (funcall to-fn beg end (current-buffer))))) | |
372 | (setq format (cdr format))))))) | |
029894b9 | 373 | |
6b61353c | 374 | (defun format-write-file (filename format &optional confirm) |
84da0f17 GM |
375 | "Write current buffer into FILENAME, using a format based on FORMAT. |
376 | Constructs the actual format starting from FORMAT, then appending | |
377 | any elements from the value of `buffer-file-format' with a non-nil | |
378 | `preserve' flag (see the documentation of `format-alist'), if they | |
379 | are not already present in FORMAT. It then updates `buffer-file-format' | |
380 | with this format, making it the default for future saves. | |
381 | ||
382 | If the buffer is already visiting a file, you can specify a | |
383 | directory name as FILENAME, to write a file of the same old name | |
08d55d13 | 384 | in that directory. |
6b61353c | 385 | |
84da0f17 GM |
386 | If optional third arg CONFIRM is non-nil, asks for confirmation before |
387 | overwriting an existing file. Interactively, requires confirmation | |
388 | unless you supply a prefix argument." | |
029894b9 BG |
389 | (interactive |
390 | ;; Same interactive spec as write-file, plus format question. | |
391 | (let* ((file (if buffer-file-name | |
392 | (read-file-name "Write file: " | |
393 | nil nil nil nil) | |
394 | (read-file-name "Write file: " | |
395 | (cdr (assq 'default-directory | |
396 | (buffer-local-variables))) | |
397 | nil nil (buffer-name)))) | |
823139fb | 398 | (fmt (format-read (format "Write file `%s' in format: " |
029894b9 | 399 | (file-name-nondirectory file))))) |
6b61353c | 400 | (list file fmt (not current-prefix-arg)))) |
34f30f79 RS |
401 | (let ((old-formats buffer-file-format) |
402 | preserve-formats) | |
403 | (dolist (fmt old-formats) | |
404 | (let ((aelt (assq fmt format-alist))) | |
405 | (if (nth 7 aelt) | |
406 | (push fmt preserve-formats)))) | |
407 | (setq buffer-file-format format) | |
408 | (dolist (fmt preserve-formats) | |
409 | (unless (memq fmt buffer-file-format) | |
410 | (setq buffer-file-format (append buffer-file-format (list fmt)))))) | |
6b61353c | 411 | (write-file filename confirm)) |
029894b9 | 412 | |
ce6af52b | 413 | (defun format-find-file (filename format) |
823139fb | 414 | "Find the file FILENAME using data format FORMAT. |
ce6af52b KH |
415 | If FORMAT is nil then do not do any format conversion." |
416 | (interactive | |
417 | ;; Same interactive spec as write-file, plus format question. | |
418 | (let* ((file (read-file-name "Find file: ")) | |
823139fb | 419 | (fmt (format-read (format "Read file `%s' in format: " |
ce6af52b KH |
420 | (file-name-nondirectory file))))) |
421 | (list file fmt))) | |
422 | (let ((format-alist nil)) | |
423 | (find-file filename)) | |
424 | (if format | |
425 | (format-decode-buffer format))) | |
426 | ||
427 | (defun format-insert-file (filename format &optional beg end) | |
823139fb | 428 | "Insert the contents of file FILENAME using data format FORMAT. |
ce6af52b KH |
429 | If FORMAT is nil then do not do any format conversion. |
430 | The optional third and fourth arguments BEG and END specify | |
12008438 | 431 | the part (in bytes) of the file to read. |
ce6af52b KH |
432 | |
433 | The return value is like the value of `insert-file-contents': | |
6b61353c | 434 | a list (ABSOLUTE-FILE-NAME SIZE)." |
ce6af52b KH |
435 | (interactive |
436 | ;; Same interactive spec as write-file, plus format question. | |
437 | (let* ((file (read-file-name "Find file: ")) | |
823139fb | 438 | (fmt (format-read (format "Read file `%s' in format: " |
ce6af52b KH |
439 | (file-name-nondirectory file))))) |
440 | (list file fmt))) | |
f70aa678 MR |
441 | (let (value size old-undo) |
442 | ;; Record only one undo entry for the insertion. Inhibit point-motion and | |
443 | ;; modification hooks as with `insert-file-contents'. | |
444 | (let ((inhibit-point-motion-hooks t) | |
445 | (inhibit-modification-hooks t)) | |
446 | ;; Don't bind `buffer-undo-list' to t here to assert that | |
447 | ;; `insert-file-contents' may record whether the buffer was unmodified | |
448 | ;; before. | |
449 | (let ((format-alist nil)) | |
450 | (setq value (insert-file-contents filename nil beg end)) | |
451 | (setq size (nth 1 value))) | |
452 | (when (consp buffer-undo-list) | |
453 | (let ((head (car buffer-undo-list))) | |
454 | (when (and (consp head) | |
455 | (equal (car head) (point)) | |
456 | (equal (cdr head) (+ (point) size))) | |
457 | ;; Remove first entry from `buffer-undo-list', we shall insert | |
458 | ;; another one below. | |
459 | (setq old-undo (cdr buffer-undo-list))))) | |
460 | (when format | |
461 | (let ((buffer-undo-list t)) | |
462 | (setq size (format-decode format size) | |
463 | value (list (car value) size))) | |
464 | (unless (eq buffer-undo-list t) | |
465 | (setq buffer-undo-list | |
466 | (cons (cons (point) (+ (point) size)) old-undo))))) | |
467 | (unless inhibit-modification-hooks | |
468 | (run-hook-with-args 'after-change-functions (point) (+ (point) size) 0)) | |
ce6af52b KH |
469 | value)) |
470 | ||
029894b9 BG |
471 | (defun format-read (&optional prompt) |
472 | "Read and return the name of a format. | |
473 | Return value is a list, like `buffer-file-format'; it may be nil. | |
474 | Formats are defined in `format-alist'. Optional arg is the PROMPT to use." | |
475 | (let* ((table (mapcar (lambda (x) (list (symbol-name (car x)))) | |
476 | format-alist)) | |
477 | (ans (completing-read (or prompt "Format: ") table nil t))) | |
478 | (if (not (equal "" ans)) (list (intern ans))))) | |
479 | ||
480 | ||
481 | ;;; | |
482 | ;;; Below are some functions that may be useful in writing encoding and | |
483 | ;;; decoding functions for use in format-alist. | |
484 | ;;; | |
485 | ||
486 | (defun format-replace-strings (alist &optional reverse beg end) | |
487 | "Do multiple replacements on the buffer. | |
d0fc7e3b | 488 | ALIST is a list of (FROM . TO) pairs, which should be proper arguments to |
12008438 TTN |
489 | `search-forward' and `replace-match', respectively. |
490 | Optional second arg REVERSE, if non-nil, means the pairs are (TO . FROM), | |
491 | so that you can use the same list in both directions if it contains only | |
492 | literal strings. | |
823139fb | 493 | Optional args BEG and END specify a region of the buffer on which to operate." |
029894b9 BG |
494 | (save-excursion |
495 | (save-restriction | |
496 | (or beg (setq beg (point-min))) | |
497 | (if end (narrow-to-region (point-min) end)) | |
498 | (while alist | |
499 | (let ((from (if reverse (cdr (car alist)) (car (car alist)))) | |
2c3ac81d | 500 | (to (if reverse (car (car alist)) (cdr (car alist))))) |
029894b9 BG |
501 | (goto-char beg) |
502 | (while (search-forward from nil t) | |
503 | (goto-char (match-beginning 0)) | |
504 | (insert to) | |
505 | (set-text-properties (- (point) (length to)) (point) | |
506 | (text-properties-at (point))) | |
507 | (delete-region (point) (+ (point) (- (match-end 0) | |
508 | (match-beginning 0))))) | |
509 | (setq alist (cdr alist))))))) | |
510 | ||
511 | ;;; Some list-manipulation functions that we need. | |
512 | ||
513 | (defun format-delq-cons (cons list) | |
823139fb DL |
514 | "Remove the given CONS from LIST by side effect and return the new LIST. |
515 | Since CONS could be the first element of LIST, write | |
516 | `\(setq foo \(format-delq-cons element foo))' to be sure of changing | |
517 | the value of `foo'." | |
029894b9 BG |
518 | (if (eq cons list) |
519 | (cdr list) | |
520 | (let ((p list)) | |
521 | (while (not (eq (cdr p) cons)) | |
e8af40ee | 522 | (if (null p) (error "format-delq-cons: not an element")) |
029894b9 BG |
523 | (setq p (cdr p))) |
524 | ;; Now (cdr p) is the cons to delete | |
525 | (setcdr p (cdr cons)) | |
526 | list))) | |
71296446 | 527 | |
029894b9 BG |
528 | (defun format-make-relatively-unique (a b) |
529 | "Delete common elements of lists A and B, return as pair. | |
12008438 | 530 | Compare using `equal'." |
029894b9 BG |
531 | (let* ((acopy (copy-sequence a)) |
532 | (bcopy (copy-sequence b)) | |
533 | (tail acopy)) | |
534 | (while tail | |
535 | (let ((dup (member (car tail) bcopy)) | |
536 | (next (cdr tail))) | |
537 | (if dup (setq acopy (format-delq-cons tail acopy) | |
538 | bcopy (format-delq-cons dup bcopy))) | |
539 | (setq tail next))) | |
540 | (cons acopy bcopy))) | |
541 | ||
542 | (defun format-common-tail (a b) | |
543 | "Given two lists that have a common tail, return it. | |
12008438 | 544 | Compare with `equal', and return the part of A that is equal to the |
029894b9 | 545 | equivalent part of B. If even the last items of the two are not equal, |
12008438 | 546 | return nil." |
029894b9 BG |
547 | (let ((la (length a)) |
548 | (lb (length b))) | |
549 | ;; Make sure they are the same length | |
823139fb | 550 | (if (> la lb) |
029894b9 BG |
551 | (setq a (nthcdr (- la lb) a)) |
552 | (setq b (nthcdr (- lb la) b)))) | |
553 | (while (not (equal a b)) | |
554 | (setq a (cdr a) | |
555 | b (cdr b))) | |
556 | a) | |
557 | ||
f0a6c717 GM |
558 | (defun format-proper-list-p (list) |
559 | "Return t if LIST is a proper list. | |
560 | A proper list is a list ending with a nil cdr, not with an atom " | |
561 | (when (listp list) | |
562 | (while (consp list) | |
563 | (setq list (cdr list))) | |
564 | (null list))) | |
565 | ||
029894b9 | 566 | (defun format-reorder (items order) |
12008438 TTN |
567 | "Arrange ITEMS to follow partial ORDER. |
568 | Elements of ITEMS equal to elements of ORDER will be rearranged | |
569 | to follow the ORDER. Unmatched items will go last." | |
029894b9 BG |
570 | (if order |
571 | (let ((item (member (car order) items))) | |
572 | (if item | |
823139fb | 573 | (cons (car item) |
029894b9 BG |
574 | (format-reorder (format-delq-cons item items) |
575 | (cdr order))) | |
576 | (format-reorder items (cdr order)))) | |
577 | items)) | |
578 | ||
579 | (put 'face 'format-list-valued t) ; These text-properties take values | |
580 | (put 'unknown 'format-list-valued t) ; that are lists, the elements of which | |
581 | ; should be considered separately. | |
582 | ; See format-deannotate-region and | |
583 | ; format-annotate-region. | |
584 | ||
f3bbef87 GM |
585 | ;; This text property has list values, but they are treated atomically. |
586 | ||
587 | (put 'display 'format-list-atomic-p t) | |
588 | ||
029894b9 BG |
589 | ;;; |
590 | ;;; Decoding | |
591 | ;;; | |
592 | ||
593 | (defun format-deannotate-region (from to translations next-fn) | |
594 | "Translate annotations in the region into text properties. | |
823139fb | 595 | This sets text properties between FROM to TO as directed by the |
029894b9 BG |
596 | TRANSLATIONS and NEXT-FN arguments. |
597 | ||
598 | NEXT-FN is a function that searches forward from point for an annotation. | |
599 | It should return a list of 4 elements: \(BEGIN END NAME POSITIVE). BEGIN and | |
600 | END are buffer positions bounding the annotation, NAME is the name searched | |
601 | for in TRANSLATIONS, and POSITIVE should be non-nil if this annotation marks | |
602 | the beginning of a region with some property, or nil if it ends the region. | |
603 | NEXT-FN should return nil if there are no annotations after point. | |
604 | ||
605 | The basic format of the TRANSLATIONS argument is described in the | |
606 | documentation for the `format-annotate-region' function. There are some | |
607 | additional things to keep in mind for decoding, though: | |
608 | ||
609 | When an annotation is found, the TRANSLATIONS list is searched for a | |
610 | text-property name and value that corresponds to that annotation. If the | |
611 | text-property has several annotations associated with it, it will be used only | |
612 | if the other annotations are also in effect at that point. The first match | |
613 | found whose annotations are all present is used. | |
614 | ||
615 | The text property thus determined is set to the value over the region between | |
616 | the opening and closing annotations. However, if the text-property name has a | |
617 | non-nil `format-list-valued' property, then the value will be consed onto the | |
618 | surrounding value of the property, rather than replacing that value. | |
619 | ||
620 | There are some special symbols that can be used in the \"property\" slot of | |
621 | the TRANSLATIONS list: PARAMETER and FUNCTION \(spelled in uppercase). | |
622 | Annotations listed under the pseudo-property PARAMETER are considered to be | |
623 | arguments of the immediately surrounding annotation; the text between the | |
624 | opening and closing parameter annotations is deleted from the buffer but saved | |
92308d3a RS |
625 | as a string. |
626 | ||
627 | The surrounding annotation should be listed under the pseudo-property | |
628 | FUNCTION. Instead of inserting a text-property for this annotation, | |
629 | the function listed in the VALUE slot is called to make whatever | |
630 | changes are appropriate. It can also return a list of the form | |
631 | \(START LOC PROP VALUE) which specifies a property to put on. The | |
632 | function's first two arguments are the START and END locations, and | |
633 | the rest of the arguments are any PARAMETERs found in that region. | |
029894b9 BG |
634 | |
635 | Any annotations that are found by NEXT-FN but not defined by TRANSLATIONS | |
636 | are saved as values of the `unknown' text-property \(which is list-valued). | |
637 | The TRANSLATIONS list should usually contain an entry of the form | |
638 | \(unknown \(nil format-annotate-value)) | |
639 | to write these unknown annotations back into the file." | |
640 | (save-excursion | |
641 | (save-restriction | |
642 | (narrow-to-region (point-min) to) | |
643 | (goto-char from) | |
644 | (let (next open-ans todo loc unknown-ans) | |
645 | (while (setq next (funcall next-fn)) | |
646 | (let* ((loc (nth 0 next)) | |
647 | (end (nth 1 next)) | |
648 | (name (nth 2 next)) | |
649 | (positive (nth 3 next)) | |
650 | (found nil)) | |
651 | ||
652 | ;; Delete the annotation | |
653 | (delete-region loc end) | |
22828206 RS |
654 | (cond |
655 | ;; Positive annotations are stacked, remembering location | |
be227f22 | 656 | (positive (push `(,name ((,loc . nil))) open-ans)) |
22828206 RS |
657 | ;; It is a negative annotation: |
658 | ;; Close the top annotation & add its text property. | |
659 | ;; If the file's nesting is messed up, the close might not match | |
660 | ;; the top thing on the open-annotations stack. | |
661 | ;; If no matching annotation is open, just ignore the close. | |
662 | ((not (assoc name open-ans)) | |
663 | (message "Extra closing annotation (%s) in file" name)) | |
664 | ;; If one is open, but not on the top of the stack, close | |
665 | ;; the things in between as well. Set `found' when the real | |
666 | ;; one is closed. | |
667 | (t | |
668 | (while (not found) | |
669 | (let* ((top (car open-ans)) ; first on stack: should match. | |
670 | (top-name (car top)) ; text property name | |
671 | (top-extents (nth 1 top)) ; property regions | |
672 | (params (cdr (cdr top))) ; parameters | |
673 | (aalist translations) | |
674 | (matched nil)) | |
675 | (if (equal name top-name) | |
676 | (setq found t) | |
677 | (message "Improper nesting in file.")) | |
678 | ;; Look through property names in TRANSLATIONS | |
679 | (while aalist | |
680 | (let ((prop (car (car aalist))) | |
681 | (alist (cdr (car aalist)))) | |
682 | ;; And look through values for each property | |
683 | (while alist | |
684 | (let ((value (car (car alist))) | |
685 | (ans (cdr (car alist)))) | |
686 | (if (member top-name ans) | |
687 | ;; This annotation is listed, but still have to | |
688 | ;; check if multiple annotations are satisfied | |
689 | (if (member nil (mapcar (lambda (r) | |
690 | (assoc r open-ans)) | |
691 | ans)) | |
692 | nil ; multiple ans not satisfied | |
693 | ;; If there are multiple annotations going | |
694 | ;; into one text property, split up the other | |
695 | ;; annotations so they apply individually to | |
696 | ;; the other regions. | |
697 | (setcdr (car top-extents) loc) | |
698 | (let ((to-split ans) this-one extents) | |
699 | (while to-split | |
700 | (setq this-one | |
701 | (assoc (car to-split) open-ans) | |
702 | extents (nth 1 this-one)) | |
703 | (if (not (eq this-one top)) | |
704 | (setcar (cdr this-one) | |
705 | (format-subtract-regions | |
706 | extents top-extents))) | |
707 | (setq to-split (cdr to-split)))) | |
708 | ;; Set loop variables to nil so loop | |
709 | ;; will exit. | |
710 | (setq alist nil aalist nil matched t | |
711 | ;; pop annotation off stack. | |
712 | open-ans (cdr open-ans)) | |
713 | (let ((extents top-extents) | |
714 | (start (car (car top-extents))) | |
715 | (loc (cdr (car top-extents)))) | |
716 | (while extents | |
717 | (cond | |
718 | ;; Check for pseudo-properties | |
719 | ((eq prop 'PARAMETER) | |
720 | ;; A parameter of the top open ann: | |
721 | ;; delete text and use as arg. | |
722 | (if open-ans | |
723 | ;; (If nothing open, discard). | |
724 | (setq open-ans | |
725 | (cons | |
726 | (append (car open-ans) | |
727 | (list | |
728 | (buffer-substring | |
729 | start loc))) | |
730 | (cdr open-ans)))) | |
731 | (delete-region start loc)) | |
732 | ((eq prop 'FUNCTION) | |
733 | ;; Not a property, but a function. | |
734 | (let ((rtn | |
735 | (apply value start loc params))) | |
be227f22 | 736 | (if rtn (push rtn todo)))) |
22828206 RS |
737 | (t |
738 | ;; Normal property/value pair | |
739 | (setq todo | |
740 | (cons (list start loc prop value) | |
741 | todo)))) | |
742 | (setq extents (cdr extents) | |
743 | start (car (car extents)) | |
744 | loc (cdr (car extents)))))))) | |
745 | (setq alist (cdr alist)))) | |
746 | (setq aalist (cdr aalist))) | |
747 | (if (not matched) | |
029894b9 BG |
748 | ;; Didn't find any match for the annotation: |
749 | ;; Store as value of text-property `unknown'. | |
22828206 RS |
750 | (let ((extents top-extents) |
751 | (start (car (car top-extents))) | |
0b140219 | 752 | (loc (or (cdr (car top-extents)) loc))) |
22828206 RS |
753 | (while extents |
754 | (setq open-ans (cdr open-ans) | |
755 | todo (cons (list start loc 'unknown top-name) | |
756 | todo) | |
757 | unknown-ans (cons name unknown-ans) | |
758 | extents (cdr extents) | |
759 | start (car (car extents)) | |
760 | loc (cdr (car extents)))))))))))) | |
029894b9 BG |
761 | |
762 | ;; Once entire file has been scanned, add the properties. | |
763 | (while todo | |
764 | (let* ((item (car todo)) | |
765 | (from (nth 0 item)) | |
766 | (to (nth 1 item)) | |
767 | (prop (nth 2 item)) | |
768 | (val (nth 3 item))) | |
22828206 RS |
769 | |
770 | (if (numberp val) ; add to ambient value if numeric | |
771 | (format-property-increment-region from to prop val 0) | |
772 | (put-text-property | |
029894b9 | 773 | from to prop |
22828206 | 774 | (cond ((get prop 'format-list-valued) ; value gets consed onto |
029894b9 BG |
775 | ; list-valued properties |
776 | (let ((prev (get-text-property from prop))) | |
777 | (cons val (if (listp prev) prev (list prev))))) | |
22828206 | 778 | (t val))))) ; normally, just set to val. |
029894b9 | 779 | (setq todo (cdr todo))) |
22828206 | 780 | |
029894b9 BG |
781 | (if unknown-ans |
782 | (message "Unknown annotations: %s" unknown-ans)))))) | |
783 | ||
22828206 | 784 | (defun format-subtract-regions (minu subtra) |
9c3054da | 785 | "Remove from the regions in MINUEND the regions in SUBTRAHEND. |
d0fc7e3b | 786 | A region is a dotted pair (FROM . TO). Both parameters are lists of |
823139fb DL |
787 | regions. Each list must contain nonoverlapping, noncontiguous |
788 | regions, in descending order. The result is also nonoverlapping, | |
789 | noncontiguous, and in descending order. The first element of MINUEND | |
790 | can have a cdr of nil, indicating that the end of that region is not | |
9c3054da JB |
791 | yet known. |
792 | ||
793 | \(fn MINUEND SUBTRAHEND)" | |
22828206 RS |
794 | (let* ((minuend (copy-alist minu)) |
795 | (subtrahend (copy-alist subtra)) | |
796 | (m (car minuend)) | |
797 | (s (car subtrahend)) | |
798 | results) | |
799 | (while (and minuend subtrahend) | |
823139fb | 800 | (cond |
22828206 RS |
801 | ;; The minuend starts after the subtrahend ends; keep it. |
802 | ((> (car m) (cdr s)) | |
be227f22 SM |
803 | (push m results) |
804 | (setq minuend (cdr minuend) | |
22828206 RS |
805 | m (car minuend))) |
806 | ;; The minuend extends beyond the end of the subtrahend. Chop it off. | |
807 | ((or (null (cdr m)) (> (cdr m) (cdr s))) | |
be227f22 | 808 | (push (cons (1+ (cdr s)) (cdr m)) results) |
22828206 RS |
809 | (setcdr m (cdr s))) |
810 | ;; The subtrahend starts after the minuend ends; throw it away. | |
811 | ((< (cdr m) (car s)) | |
812 | (setq subtrahend (cdr subtrahend) s (car subtrahend))) | |
813 | ;; The subtrahend extends beyond the end of the minuend. Chop it off. | |
814 | (t ;(<= (cdr m) (cdr s))) | |
815 | (if (>= (car m) (car s)) | |
816 | (setq minuend (cdr minuend) m (car minuend)) | |
817 | (setcdr m (1- (car s))) | |
818 | (setq subtrahend (cdr subtrahend) s (car subtrahend)))))) | |
819 | (nconc (nreverse results) minuend))) | |
820 | ||
821 | ;; This should probably go somewhere other than format.el. Then again, | |
822 | ;; indent.el has alter-text-property. NOTE: We can also use | |
823 | ;; next-single-property-change instead of text-property-not-all, but then | |
824 | ;; we have to see if we passed TO. | |
825 | (defun format-property-increment-region (from to prop delta default) | |
12008438 | 826 | "In the region from FROM to TO increment property PROP by amount DELTA. |
823139fb | 827 | DELTA may be negative. If property PROP is nil anywhere |
22828206 RS |
828 | in the region, it is treated as though it were DEFAULT." |
829 | (let ((cur from) val newval next) | |
830 | (while cur | |
831 | (setq val (get-text-property cur prop) | |
832 | newval (+ (or val default) delta) | |
833 | next (text-property-not-all cur to prop val)) | |
834 | (put-text-property cur (or next to) prop newval) | |
835 | (setq cur next)))) | |
836 | ||
029894b9 BG |
837 | ;;; |
838 | ;;; Encoding | |
839 | ;;; | |
840 | ||
841 | (defun format-insert-annotations (list &optional offset) | |
842 | "Apply list of annotations to buffer as `write-region' would. | |
12008438 | 843 | Insert each element of the given LIST of buffer annotations at its |
029894b9 BG |
844 | appropriate place. Use second arg OFFSET if the annotations' locations are |
845 | not relative to the beginning of the buffer: annotations will be inserted | |
9c3054da JB |
846 | at their location-OFFSET+1 \(ie, the offset is treated as the position of |
847 | the first character in the buffer)." | |
823139fb | 848 | (if (not offset) |
029894b9 BG |
849 | (setq offset 0) |
850 | (setq offset (1- offset))) | |
851 | (let ((l (reverse list))) | |
852 | (while l | |
853 | (goto-char (- (car (car l)) offset)) | |
854 | (insert (cdr (car l))) | |
855 | (setq l (cdr l))))) | |
856 | ||
857 | (defun format-annotate-value (old new) | |
0b1ce6ba | 858 | "Return OLD and NEW as a \(CLOSE . OPEN) annotation pair. |
029894b9 BG |
859 | Useful as a default function for TRANSLATIONS alist when the value of the text |
860 | property is the name of the annotation that you want to use, as it is for the | |
861 | `unknown' text property." | |
862 | (cons (if old (list old)) | |
863 | (if new (list new)))) | |
864 | ||
823139fb | 865 | (defun format-annotate-region (from to translations format-fn ignore) |
029894b9 | 866 | "Generate annotations for text properties in the region. |
12008438 | 867 | Search for changes between FROM and TO, and describe them with a list of |
029894b9 BG |
868 | annotations as defined by alist TRANSLATIONS and FORMAT-FN. IGNORE lists text |
869 | properties not to consider; any text properties that are neither ignored nor | |
870 | listed in TRANSLATIONS are warned about. | |
871 | If you actually want to modify the region, give the return value of this | |
872 | function to `format-insert-annotations'. | |
873 | ||
874 | Format of the TRANSLATIONS argument: | |
875 | ||
876 | Each element is a list whose car is a PROPERTY, and the following | |
d0fc7e3b RS |
877 | elements have the form (VALUE ANNOTATIONS...). |
878 | Whenever the property takes on the value VALUE, the annotations | |
029894b9 BG |
879 | \(as formatted by FORMAT-FN) are inserted into the file. |
880 | When the property stops having that value, the matching negated annotation | |
881 | will be inserted \(it may actually be closed earlier and reopened, if | |
823139fb | 882 | necessary, to keep proper nesting). |
029894b9 | 883 | |
d0fc7e3b | 884 | If VALUE is a list, then each element of the list is dealt with |
029894b9 BG |
885 | separately. |
886 | ||
887 | If a VALUE is numeric, then it is assumed that there is a single annotation | |
888 | and each occurrence of it increments the value of the property by that number. | |
889 | Thus, given the entry \(left-margin \(4 \"indent\")), if the left margin | |
890 | changes from 4 to 12, two <indent> annotations will be generated. | |
891 | ||
892 | If the VALUE is nil, then instead of annotations, a function should be | |
893 | specified. This function is used as a default: it is called for all | |
894 | transitions not explicitly listed in the table. The function is called with | |
895 | two arguments, the OLD and NEW values of the property. It should return | |
d0fc7e3b | 896 | a cons cell (CLOSE . OPEN) as `format-annotate-single-property-change' does. |
029894b9 | 897 | |
d0fc7e3b | 898 | The same TRANSLATIONS structure can be used in reverse for reading files." |
029894b9 BG |
899 | (let ((all-ans nil) ; All annotations - becomes return value |
900 | (open-ans nil) ; Annotations not yet closed | |
901 | (loc nil) ; Current location | |
902 | (not-found nil)) ; Properties that couldn't be saved | |
903 | (while (or (null loc) | |
904 | (and (setq loc (next-property-change loc nil to)) | |
905 | (< loc to))) | |
906 | (or loc (setq loc from)) | |
823139fb | 907 | (let* ((ans (format-annotate-location loc (= loc from) ignore translations)) |
029894b9 BG |
908 | (neg-ans (format-reorder (aref ans 0) open-ans)) |
909 | (pos-ans (aref ans 1)) | |
910 | (ignored (aref ans 2))) | |
911 | (setq not-found (append ignored not-found) | |
912 | ignore (append ignored ignore)) | |
913 | ;; First do the negative (closing) annotations | |
914 | (while neg-ans | |
915 | ;; Check if it's missing. This can happen (eg, a numeric property | |
916 | ;; going negative can generate closing annotations before there are | |
917 | ;; any open). Warn user & ignore. | |
918 | (if (not (member (car neg-ans) open-ans)) | |
919 | (message "Can't close %s: not open." (car neg-ans)) | |
920 | (while (not (equal (car neg-ans) (car open-ans))) | |
921 | ;; To close anno. N, need to first close ans 1 to N-1, | |
922 | ;; remembering to re-open them later. | |
be227f22 | 923 | (push (car open-ans) pos-ans) |
823139fb | 924 | (setq all-ans |
029894b9 BG |
925 | (cons (cons loc (funcall format-fn (car open-ans) nil)) |
926 | all-ans)) | |
927 | (setq open-ans (cdr open-ans))) | |
928 | ;; Now remove the one we're really interested in from open list. | |
929 | (setq open-ans (cdr open-ans)) | |
930 | ;; And put the closing annotation here. | |
be227f22 SM |
931 | (push (cons loc (funcall format-fn (car neg-ans) nil)) |
932 | all-ans)) | |
029894b9 BG |
933 | (setq neg-ans (cdr neg-ans))) |
934 | ;; Now deal with positive (opening) annotations | |
935 | (let ((p pos-ans)) | |
936 | (while pos-ans | |
be227f22 SM |
937 | (push (car pos-ans) open-ans) |
938 | (push (cons loc (funcall format-fn (car pos-ans) t)) | |
939 | all-ans) | |
029894b9 BG |
940 | (setq pos-ans (cdr pos-ans)))))) |
941 | ||
942 | ;; Close any annotations still open | |
943 | (while open-ans | |
823139fb | 944 | (setq all-ans |
029894b9 BG |
945 | (cons (cons to (funcall format-fn (car open-ans) nil)) |
946 | all-ans)) | |
947 | (setq open-ans (cdr open-ans))) | |
948 | (if not-found | |
949 | (message "These text properties could not be saved:\n %s" | |
950 | not-found)) | |
951 | (nreverse all-ans))) | |
952 | ||
953 | ;;; Internal functions for format-annotate-region. | |
954 | ||
823139fb DL |
955 | (defun format-annotate-location (loc all ignore translations) |
956 | "Return annotation(s) needed at location LOC. | |
9c3054da | 957 | This includes any properties that change between LOC - 1 and LOC. |
029894b9 BG |
958 | If ALL is true, don't look at previous location, but generate annotations for |
959 | all non-nil properties. | |
960 | Third argument IGNORE is a list of text-properties not to consider. | |
d0fc7e3b | 961 | Use the TRANSLATIONS alist (see `format-annotate-region' for doc). |
029894b9 BG |
962 | |
963 | Return value is a vector of 3 elements: | |
d0fc7e3b RS |
964 | 1. List of annotations to close |
965 | 2. List of annotations to open. | |
966 | 3. List of properties that were ignored or couldn't be annotated. | |
967 | ||
968 | The annotations in lists 1 and 2 need not be strings. | |
969 | They can be whatever the FORMAT-FN in `format-annotate-region' | |
970 | can handle. If that is `enriched-make-annotation', they can be | |
971 | either strings, or lists of the form (PARAMETER VALUE)." | |
029894b9 BG |
972 | (let* ((prev-loc (1- loc)) |
973 | (before-plist (if all nil (text-properties-at prev-loc))) | |
974 | (after-plist (text-properties-at loc)) | |
975 | p negatives positives prop props not-found) | |
976 | ;; make list of all property names involved | |
977 | (setq p before-plist) | |
978 | (while p | |
979 | (if (not (memq (car p) props)) | |
be227f22 | 980 | (push (car p) props)) |
029894b9 BG |
981 | (setq p (cdr (cdr p)))) |
982 | (setq p after-plist) | |
983 | (while p | |
984 | (if (not (memq (car p) props)) | |
be227f22 | 985 | (push (car p) props)) |
029894b9 BG |
986 | (setq p (cdr (cdr p)))) |
987 | ||
988 | (while props | |
be227f22 | 989 | (setq prop (pop props)) |
029894b9 BG |
990 | (if (memq prop ignore) |
991 | nil ; If it's been ignored before, ignore it now. | |
992 | (let ((before (if all nil (car (cdr (memq prop before-plist))))) | |
993 | (after (car (cdr (memq prop after-plist))))) | |
994 | (if (equal before after) | |
995 | nil ; no change; ignore | |
996 | (let ((result (format-annotate-single-property-change | |
823139fb | 997 | prop before after translations))) |
029894b9 | 998 | (if (not result) |
be227f22 | 999 | (push prop not-found) |
029894b9 BG |
1000 | (setq negatives (nconc negatives (car result)) |
1001 | positives (nconc positives (cdr result))))))))) | |
1002 | (vector negatives positives not-found))) | |
1003 | ||
d0fc7e3b | 1004 | (defun format-annotate-single-property-change (prop old new translations) |
823139fb | 1005 | "Return annotations for property PROP changing from OLD to NEW. |
d0fc7e3b RS |
1006 | These are searched for in the translations alist TRANSLATIONS |
1007 | (see `format-annotate-region' for the format). | |
12008438 TTN |
1008 | If NEW does not appear in the list, but there is a default function, |
1009 | then call that function. | |
1010 | Return a cons of the form (CLOSE . OPEN) | |
d0fc7e3b RS |
1011 | where CLOSE is a list of annotations to close |
1012 | and OPEN is a list of annotations to open. | |
1013 | ||
1014 | The annotations in CLOSE and OPEN need not be strings. | |
1015 | They can be whatever the FORMAT-FN in `format-annotate-region' | |
1016 | can handle. If that is `enriched-make-annotation', they can be | |
1017 | either strings, or lists of the form (PARAMETER VALUE)." | |
1018 | ||
1019 | (let ((prop-alist (cdr (assoc prop translations))) | |
029894b9 BG |
1020 | default) |
1021 | (if (not prop-alist) | |
1022 | nil | |
029894b9 | 1023 | ;; If either old or new is a list, have to treat both that way. |
f0a6c717 | 1024 | (if (and (or (listp old) (listp new)) |
f3bbef87 | 1025 | (not (get prop 'format-list-atomic-p))) |
f0a6c717 GM |
1026 | (if (or (not (format-proper-list-p old)) |
1027 | (not (format-proper-list-p new))) | |
1028 | (format-annotate-atomic-property-change prop-alist old new) | |
1029 | (let* ((old (if (listp old) old (list old))) | |
1030 | (new (if (listp new) new (list new))) | |
1031 | (tail (format-common-tail old new)) | |
1032 | close open) | |
1033 | (while old | |
1034 | (setq close | |
1035 | (append (car (format-annotate-atomic-property-change | |
1036 | prop-alist (car old) nil)) | |
1037 | close) | |
1038 | old (cdr old))) | |
1039 | (while new | |
1040 | (setq open | |
1041 | (append (cdr (format-annotate-atomic-property-change | |
1042 | prop-alist nil (car new))) | |
1043 | open) | |
1044 | new (cdr new))) | |
1045 | (format-make-relatively-unique close open))) | |
029894b9 BG |
1046 | (format-annotate-atomic-property-change prop-alist old new))))) |
1047 | ||
1048 | (defun format-annotate-atomic-property-change (prop-alist old new) | |
12008438 | 1049 | "Internal function to annotate a single property change. |
d0fc7e3b | 1050 | PROP-ALIST is the relevant element of a TRANSLATIONS list. |
029894b9 | 1051 | OLD and NEW are the values." |
e5a60108 RS |
1052 | (let (num-ann) |
1053 | ;; If old and new values are numbers, | |
1054 | ;; look for a number in PROP-ALIST. | |
5f525595 RS |
1055 | (if (and (or (null old) (numberp old)) |
1056 | (or (null new) (numberp new))) | |
e5a60108 RS |
1057 | (progn |
1058 | (setq num-ann prop-alist) | |
1059 | (while (and num-ann (not (numberp (car (car num-ann))))) | |
1060 | (setq num-ann (cdr num-ann))))) | |
1061 | (if num-ann | |
5f525595 | 1062 | ;; Numerical annotation - use difference |
34fbecde RS |
1063 | (progn |
1064 | ;; If property is numeric, nil means 0 | |
1065 | (cond ((and (numberp old) (null new)) | |
1066 | (setq new 0)) | |
1067 | ((and (numberp new) (null old)) | |
1068 | (setq old 0))) | |
1069 | ||
1070 | (let* ((entry (car num-ann)) | |
1071 | (increment (car entry)) | |
1072 | (n (ceiling (/ (float (- new old)) (float increment)))) | |
1073 | (anno (car (cdr entry)))) | |
1074 | (if (> n 0) | |
1075 | (cons nil (make-list n anno)) | |
1076 | (cons (make-list (- n) anno) nil)))) | |
e5a60108 RS |
1077 | |
1078 | ;; Standard annotation | |
1079 | (let ((close (and old (cdr (assoc old prop-alist)))) | |
029894b9 BG |
1080 | (open (and new (cdr (assoc new prop-alist))))) |
1081 | (if (or close open) | |
1082 | (format-make-relatively-unique close open) | |
1083 | ;; Call "Default" function, if any | |
1084 | (let ((default (assq nil prop-alist))) | |
1085 | (if default | |
1086 | (funcall (car (cdr default)) old new)))))))) | |
1087 | ||
c84cf2bf | 1088 | (provide 'format) |
823139fb DL |
1089 | |
1090 | ;;; format.el ends here |