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