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