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