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