Mercurial > emacs
annotate lisp/format.el @ 19161:248ec4d8a5e6
(mail-mode): Fix previous change.
Treat a supercite prefix not followed by text
as a paragraph separator.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 05 Aug 1997 06:41:51 +0000 |
parents | 20fda18753c2 |
children | 759e45894579 |
rev | line source |
---|---|
13352 | 1 ;;; format.el --- read and save files in multiple formats |
14169 | 2 |
18140
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
3 ;; Copyright (c) 1994, 1995, 1997 Free Software Foundation |
11054 | 4 |
12082
257af4819582
Change email address for Boris.
Boris Goldowsky <boris@gnu.org>
parents:
11234
diff
changeset
|
5 ;; Author: Boris Goldowsky <boris@gnu.ai.mit.edu> |
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 |
29 ;; files that match certain conditions. | |
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' | |
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 | |
16686
c5f50169bfbe
(format-alist): Change defconst to defvar.
Richard M. Stallman <rms@gnu.org>
parents:
16020
diff
changeset
|
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) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
74 (ibm "IBM Code Page 850 (DOS)" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
75 "1\\(^\\)" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
76 "recode ibm-ps:latin1" "recode latin1:ibm-pc" t nil) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
77 (mac "Apple Macintosh" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
78 "1\\(^\\)" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
79 "recode mac:latin1" "recode latin1:mac" t nil) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
80 (hp "HP Roman8" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
81 "1\\(^\\)" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
82 "recode roman8:latin1" "recode latin1:roman8" t nil) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
83 (TeX "TeX (encoding)" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
84 "1\\(^\\)" |
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) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
86 (gtex "German TeX (encoding)" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
87 "1\\(^\\)" |
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) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
89 (html "HTML (encoding)" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
90 "1\\(^\\)" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
91 "recode html:latin1" "recode latin1:html" t nil) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
92 (rot13 "rot13" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
93 "1\\(^\\)" |
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) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
95 (duden "Duden Ersatzdarstellung" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
96 "1\\(^\\)" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
97 "diac" iso-iso2duden t nil) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
98 (de646 "German ASCII (ISO 646)" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
99 "1\\(^\\)" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
100 "recode iso646-ge:latin1" "recode latin1:iso646-ge" t nil) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
101 (denet "net German" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
102 "1\\(^\\)" |
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) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
104 (esnet "net Spanish" |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
105 "1\\(^\\)" |
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). | |
109 NAME is a symbol, which is stored in `buffer-file-format'. | |
110 DOC-STR should be a single line providing more information about the | |
111 format. It is currently unused, but in the future will be shown to | |
112 the user if they ask for more information. | |
113 REGEXP is a regular expression to match against the beginning of the file; | |
114 it should match only files in that format. | |
115 FROM-FN is called to decode files in that format; it gets two args, BEGIN | |
116 and END, and can make any modifications it likes, returning the new | |
117 end. It must make sure that the beginning of the file no longer | |
118 matches REGEXP, or else it will get called again. | |
16020
0f704de0600f
(format-alist): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14452
diff
changeset
|
119 TO-FN is called to encode a region into that format; it is passed three |
0f704de0600f
(format-alist): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14452
diff
changeset
|
120 arguments: BEGIN, END, and BUFFER. BUFFER is the original buffer that |
0f704de0600f
(format-alist): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14452
diff
changeset
|
121 the data being written came from, which the function could use, for |
0f704de0600f
(format-alist): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14452
diff
changeset
|
122 example, to find the values of local variables. TO-FN should either |
0f704de0600f
(format-alist): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14452
diff
changeset
|
123 return a list of annotations like `write-region-annotate-functions', |
0f704de0600f
(format-alist): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14452
diff
changeset
|
124 or modify the region and return the new end. |
0f704de0600f
(format-alist): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14452
diff
changeset
|
125 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
|
126 TO-FN will not make any changes but will instead return a list of |
0f704de0600f
(format-alist): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14452
diff
changeset
|
127 annotations. |
11054 | 128 MODE-FN, if specified, is called when visiting a file with that format.") |
129 | |
130 ;;; Basic Functions (called from Lisp) | |
131 | |
18140
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
132 (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
|
133 "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
|
134 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
|
135 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
|
136 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
|
137 (if (stringp method) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
138 (save-current-buffer |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
139 (set-buffer buffer) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
140 (shell-command-on-region from to method t) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
141 (point)) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
142 (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
|
143 |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
144 (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
|
145 "Decode 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
|
146 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
|
147 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
|
148 (if (stringp method) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
149 (progn |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
150 (shell-command-on-region from to method t) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
151 (point)) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
152 (funcall method from to))) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
153 |
16020
0f704de0600f
(format-alist): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14452
diff
changeset
|
154 (defun format-annotate-function (format from to orig-buf) |
11054 | 155 "Returns annotations for writing region as FORMAT. |
156 FORMAT is a symbol naming one of the formats defined in `format-alist', | |
157 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
|
158 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
|
159 ORIG-BUF is the original buffer that the data came from. |
11054 | 160 This function works like a function on `write-region-annotate-functions': |
161 it either returns a list of annotations, or returns with a different buffer | |
162 current, which contains the modified text to write. | |
163 | |
164 For most purposes, consider using `format-encode-region' instead." | |
165 ;; This function is called by write-region (actually build-annotations) | |
166 ;; for each element of buffer-file-format. | |
167 (let* ((info (assq format format-alist)) | |
168 (to-fn (nth 4 info)) | |
169 (modify (nth 5 info))) | |
170 (if to-fn | |
171 (if modify | |
172 ;; To-function wants to modify region. Copy to safe place. | |
173 (let ((copy-buf (get-buffer-create " *Format Temp*"))) | |
174 (copy-to-buffer copy-buf from to) | |
175 (set-buffer copy-buf) | |
176 (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
|
177 (format-encode-run-method to-fn (point-min) (point-max) orig-buf) |
11054 | 178 nil) |
179 ;; Otherwise just call function, it will return annotations. | |
16020
0f704de0600f
(format-alist): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14452
diff
changeset
|
180 (funcall to-fn from to orig-buf))))) |
11054 | 181 |
182 (defun format-decode (format length &optional visit-flag) | |
183 ;; This function is called by insert-file-contents whenever a file is read. | |
184 "Decode text from any known FORMAT. | |
185 FORMAT is a symbol appearing in `format-alist' or a list of such symbols, | |
186 or nil, in which case this function tries to guess the format of the data by | |
187 matching against the regular expressions in `format-alist'. After a match is | |
188 found and the region decoded, the alist is searched again from the beginning | |
189 for another match. | |
190 | |
191 Second arg LENGTH is the number of characters following point to operate on. | |
192 If optional third arg VISIT-FLAG is true, set `buffer-file-format' | |
193 to the list of formats used, and call any mode functions defined for those | |
194 formats. | |
195 | |
196 Returns the new length of the decoded region. | |
197 | |
198 For most purposes, consider using `format-decode-region' instead." | |
199 (let ((mod (buffer-modified-p)) | |
200 (begin (point)) | |
201 (end (+ (point) length))) | |
202 (if (null format) | |
203 ;; Figure out which format it is in, remember list in `format'. | |
204 (let ((try format-alist)) | |
205 (while try | |
206 (let* ((f (car try)) | |
207 (regexp (nth 2 f)) | |
208 (p (point))) | |
209 (if (and regexp (looking-at regexp) | |
210 (< (match-end 0) (+ begin length))) | |
211 (progn | |
212 (setq format (cons (car f) format)) | |
213 ;; Decode it | |
18140
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
214 (if (nth 3 f) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
215 (setq end (format-decode-run-method (nth 3 f) begin end))) |
11054 | 216 ;; Call visit function if required |
217 (if (and visit-flag (nth 6 f)) (funcall (nth 6 f) 1)) | |
218 ;; Safeguard against either of the functions changing pt. | |
219 (goto-char p) | |
220 ;; Rewind list to look for another format | |
221 (setq try format-alist)) | |
222 (setq try (cdr try)))))) | |
223 ;; Deal with given format(s) | |
224 (or (listp format) (setq format (list format))) | |
225 (let ((do format) f) | |
226 (while do | |
227 (or (setq f (assq (car do) format-alist)) | |
228 (error "Unknown format" (car do))) | |
229 ;; Decode: | |
18140
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
230 (if (nth 3 f) |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
231 (setq end (format-decode-run-method (nth 3 f) begin end))) |
11054 | 232 ;; Call visit function if required |
233 (if (and visit-flag (nth 6 f)) (funcall (nth 6 f) 1)) | |
234 (setq do (cdr do))))) | |
235 (if visit-flag | |
236 (setq buffer-file-format format)) | |
237 (set-buffer-modified-p mod) | |
238 ;; Return new length of region | |
239 (- end begin))) | |
240 | |
241 ;;; | |
242 ;;; Interactive functions & entry points | |
243 ;;; | |
244 | |
245 (defun format-decode-buffer (&optional format) | |
246 "Translate the buffer from some FORMAT. | |
247 If the format is not specified, this function attempts to guess. | |
248 `buffer-file-format' is set to the format used, and any mode-functions | |
249 for the format are called." | |
250 (interactive | |
251 (list (format-read "Translate buffer from format (default: guess): "))) | |
252 (save-excursion | |
253 (goto-char (point-min)) | |
254 (format-decode format (buffer-size) t))) | |
255 | |
256 (defun format-decode-region (from to &optional format) | |
257 "Decode the region from some format. | |
258 Arg FORMAT is optional; if omitted the format will be determined by looking | |
259 for identifying regular expressions at the beginning of the region." | |
260 (interactive | |
261 (list (region-beginning) (region-end) | |
262 (format-read "Translate region from format (default: guess): "))) | |
263 (save-excursion | |
264 (goto-char from) | |
265 (format-decode format (- to from) nil))) | |
266 | |
267 (defun format-encode-buffer (&optional format) | |
268 "Translate the buffer into FORMAT. | |
269 FORMAT defaults to `buffer-file-format'. It is a symbol naming one of the | |
270 formats defined in `format-alist', or a list of such symbols." | |
271 (interactive | |
272 (list (format-read (format "Translate buffer to format (default %s): " | |
273 buffer-file-format)))) | |
274 (format-encode-region (point-min) (point-max) format)) | |
275 | |
276 (defun format-encode-region (beg end &optional format) | |
277 "Translate the region into some FORMAT. | |
278 FORMAT defaults to `buffer-file-format', it is a symbol naming | |
279 one of the formats defined in `format-alist', or a list of such symbols." | |
280 (interactive | |
281 (list (region-beginning) (region-end) | |
282 (format-read (format "Translate region to format (default %s): " | |
283 buffer-file-format)))) | |
284 (if (null format) (setq format buffer-file-format)) | |
285 (if (symbolp format) (setq format (list format))) | |
286 (save-excursion | |
287 (goto-char end) | |
288 (let ((cur-buf (current-buffer)) | |
289 (end (point-marker))) | |
290 (while format | |
291 (let* ((info (assq (car format) format-alist)) | |
292 (to-fn (nth 4 info)) | |
293 (modify (nth 5 info)) | |
294 result) | |
295 (if to-fn | |
296 (if modify | |
18140
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
297 (setq end (format-encode-run-method to-fn beg end |
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
298 (current-buffer))) |
16020
0f704de0600f
(format-alist): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14452
diff
changeset
|
299 (format-insert-annotations |
0f704de0600f
(format-alist): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14452
diff
changeset
|
300 (funcall to-fn beg end (current-buffer))))) |
11054 | 301 (setq format (cdr format))))))) |
302 | |
303 (defun format-write-file (filename format) | |
304 "Write current buffer into a FILE using some FORMAT. | |
305 Makes buffer visit that file and sets the format as the default for future | |
306 saves. If the buffer is already visiting a file, you can specify a directory | |
307 name as FILE, to write a file of the same old name in that directory." | |
308 (interactive | |
309 ;; Same interactive spec as write-file, plus format question. | |
310 (let* ((file (if buffer-file-name | |
311 (read-file-name "Write file: " | |
312 nil nil nil nil) | |
313 (read-file-name "Write file: " | |
314 (cdr (assq 'default-directory | |
315 (buffer-local-variables))) | |
316 nil nil (buffer-name)))) | |
317 (fmt (format-read (format "Write file `%s' in format: " | |
318 (file-name-nondirectory file))))) | |
319 (list file fmt))) | |
320 (setq buffer-file-format format) | |
321 (write-file filename)) | |
322 | |
12154
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
323 (defun format-find-file (filename format) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
324 "Find the file FILE using data format FORMAT. |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
325 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
|
326 (interactive |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
327 ;; 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
|
328 (let* ((file (read-file-name "Find file: ")) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
329 (fmt (format-read (format "Read file `%s' in format: " |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
330 (file-name-nondirectory file))))) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
331 (list file fmt))) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
332 (let ((format-alist nil)) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
333 (find-file filename)) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
334 (if format |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
335 (format-decode-buffer format))) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
336 |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
337 (defun format-insert-file (filename format &optional beg end) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
338 "Insert the contents of file FILE using data format FORMAT. |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
339 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
|
340 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
|
341 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
|
342 |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
343 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
|
344 a list (ABSOLUTE-FILE-NAME . SIZE)." |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
345 (interactive |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
346 ;; 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
|
347 (let* ((file (read-file-name "Find file: ")) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
348 (fmt (format-read (format "Read file `%s' in format: " |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
349 (file-name-nondirectory file))))) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
350 (list file fmt))) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
351 (let (value size) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
352 (let ((format-alist nil)) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
353 (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
|
354 (setq size (nth 1 value))) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
355 (if format |
18140
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
356 (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
|
357 value (cons (car value) size))) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
358 value)) |
38a933f88c87
(format-find-file, format-insert-file): New functions.
Karl Heuer <kwzh@gnu.org>
parents:
12082
diff
changeset
|
359 |
11054 | 360 (defun format-read (&optional prompt) |
361 "Read and return the name of a format. | |
362 Return value is a list, like `buffer-file-format'; it may be nil. | |
363 Formats are defined in `format-alist'. Optional arg is the PROMPT to use." | |
364 (let* ((table (mapcar (lambda (x) (list (symbol-name (car x)))) | |
365 format-alist)) | |
366 (ans (completing-read (or prompt "Format: ") table nil t))) | |
367 (if (not (equal "" ans)) (list (intern ans))))) | |
368 | |
369 | |
370 ;;; | |
371 ;;; Below are some functions that may be useful in writing encoding and | |
372 ;;; decoding functions for use in format-alist. | |
373 ;;; | |
374 | |
375 (defun format-replace-strings (alist &optional reverse beg end) | |
376 "Do multiple replacements on the buffer. | |
377 ALIST is a list of (from . to) pairs, which should be proper arguments to | |
378 `search-forward' and `replace-match' respectively. | |
379 Optional 2nd arg REVERSE, if non-nil, means the pairs are (to . from), so that | |
380 you can use the same list in both directions if it contains only literal | |
381 strings. | |
382 Optional args BEGIN and END specify a region of the buffer to operate on." | |
383 (save-excursion | |
384 (save-restriction | |
385 (or beg (setq beg (point-min))) | |
386 (if end (narrow-to-region (point-min) end)) | |
387 (while alist | |
388 (let ((from (if reverse (cdr (car alist)) (car (car alist)))) | |
389 (to (if reverse (car (cdr alist)) (cdr (car alist))))) | |
390 (goto-char beg) | |
391 (while (search-forward from nil t) | |
392 (goto-char (match-beginning 0)) | |
393 (insert to) | |
394 (set-text-properties (- (point) (length to)) (point) | |
395 (text-properties-at (point))) | |
396 (delete-region (point) (+ (point) (- (match-end 0) | |
397 (match-beginning 0))))) | |
398 (setq alist (cdr alist))))))) | |
399 | |
400 ;;; Some list-manipulation functions that we need. | |
401 | |
402 (defun format-delq-cons (cons list) | |
403 "Remove the given CONS from LIST by side effect, | |
404 and return the new LIST. Since CONS could be the first element | |
405 of LIST, write `\(setq foo \(format-delq-cons element foo))' to be sure of | |
406 changing the value of `foo'." | |
407 (if (eq cons list) | |
408 (cdr list) | |
409 (let ((p list)) | |
410 (while (not (eq (cdr p) cons)) | |
411 (if (null p) (error "format-delq-cons: not an element.")) | |
412 (setq p (cdr p))) | |
413 ;; Now (cdr p) is the cons to delete | |
414 (setcdr p (cdr cons)) | |
415 list))) | |
416 | |
417 (defun format-make-relatively-unique (a b) | |
418 "Delete common elements of lists A and B, return as pair. | |
419 Compares using `equal'." | |
420 (let* ((acopy (copy-sequence a)) | |
421 (bcopy (copy-sequence b)) | |
422 (tail acopy)) | |
423 (while tail | |
424 (let ((dup (member (car tail) bcopy)) | |
425 (next (cdr tail))) | |
426 (if dup (setq acopy (format-delq-cons tail acopy) | |
427 bcopy (format-delq-cons dup bcopy))) | |
428 (setq tail next))) | |
429 (cons acopy bcopy))) | |
430 | |
431 (defun format-common-tail (a b) | |
432 "Given two lists that have a common tail, return it. | |
433 Compares with `equal', and returns the part of A that is equal to the | |
434 equivalent part of B. If even the last items of the two are not equal, | |
435 returns nil." | |
436 (let ((la (length a)) | |
437 (lb (length b))) | |
438 ;; Make sure they are the same length | |
439 (if (> la lb) | |
440 (setq a (nthcdr (- la lb) a)) | |
441 (setq b (nthcdr (- lb la) b)))) | |
442 (while (not (equal a b)) | |
443 (setq a (cdr a) | |
444 b (cdr b))) | |
445 a) | |
446 | |
447 (defun format-reorder (items order) | |
448 "Arrange ITEMS to following partial ORDER. | |
449 Elements of ITEMS equal to elements of ORDER will be rearranged to follow the | |
450 ORDER. Unmatched items will go last." | |
451 (if order | |
452 (let ((item (member (car order) items))) | |
453 (if item | |
454 (cons (car item) | |
455 (format-reorder (format-delq-cons item items) | |
456 (cdr order))) | |
457 (format-reorder items (cdr order)))) | |
458 items)) | |
459 | |
460 (put 'face 'format-list-valued t) ; These text-properties take values | |
461 (put 'unknown 'format-list-valued t) ; that are lists, the elements of which | |
462 ; should be considered separately. | |
463 ; See format-deannotate-region and | |
464 ; format-annotate-region. | |
465 | |
466 ;;; | |
467 ;;; Decoding | |
468 ;;; | |
469 | |
470 (defun format-deannotate-region (from to translations next-fn) | |
471 "Translate annotations in the region into text properties. | |
472 This sets text properties between FROM to TO as directed by the | |
473 TRANSLATIONS and NEXT-FN arguments. | |
474 | |
475 NEXT-FN is a function that searches forward from point for an annotation. | |
476 It should return a list of 4 elements: \(BEGIN END NAME POSITIVE). BEGIN and | |
477 END are buffer positions bounding the annotation, NAME is the name searched | |
478 for in TRANSLATIONS, and POSITIVE should be non-nil if this annotation marks | |
479 the beginning of a region with some property, or nil if it ends the region. | |
480 NEXT-FN should return nil if there are no annotations after point. | |
481 | |
482 The basic format of the TRANSLATIONS argument is described in the | |
483 documentation for the `format-annotate-region' function. There are some | |
484 additional things to keep in mind for decoding, though: | |
485 | |
486 When an annotation is found, the TRANSLATIONS list is searched for a | |
487 text-property name and value that corresponds to that annotation. If the | |
488 text-property has several annotations associated with it, it will be used only | |
489 if the other annotations are also in effect at that point. The first match | |
490 found whose annotations are all present is used. | |
491 | |
492 The text property thus determined is set to the value over the region between | |
493 the opening and closing annotations. However, if the text-property name has a | |
494 non-nil `format-list-valued' property, then the value will be consed onto the | |
495 surrounding value of the property, rather than replacing that value. | |
496 | |
497 There are some special symbols that can be used in the \"property\" slot of | |
498 the TRANSLATIONS list: PARAMETER and FUNCTION \(spelled in uppercase). | |
499 Annotations listed under the pseudo-property PARAMETER are considered to be | |
500 arguments of the immediately surrounding annotation; the text between the | |
501 opening and closing parameter annotations is deleted from the buffer but saved | |
502 as a string. The surrounding annotation should be listed under the | |
503 pseudo-property FUNCTION. Instead of inserting a text-property for this | |
504 annotation, the function listed in the VALUE slot is called to make whatever | |
505 changes are appropriate. The function's first two arguments are the START and | |
506 END locations, and the rest of the arguments are any PARAMETERs found in that | |
507 region. | |
508 | |
509 Any annotations that are found by NEXT-FN but not defined by TRANSLATIONS | |
510 are saved as values of the `unknown' text-property \(which is list-valued). | |
511 The TRANSLATIONS list should usually contain an entry of the form | |
512 \(unknown \(nil format-annotate-value)) | |
513 to write these unknown annotations back into the file." | |
514 (save-excursion | |
515 (save-restriction | |
516 (narrow-to-region (point-min) to) | |
517 (goto-char from) | |
518 (let (next open-ans todo loc unknown-ans) | |
519 (while (setq next (funcall next-fn)) | |
520 (let* ((loc (nth 0 next)) | |
521 (end (nth 1 next)) | |
522 (name (nth 2 next)) | |
523 (positive (nth 3 next)) | |
524 (found nil)) | |
525 | |
526 ;; Delete the annotation | |
527 (delete-region loc end) | |
528 (if positive | |
529 ;; Positive annotations are stacked, remembering location | |
530 (setq open-ans (cons (list name loc) open-ans)) | |
531 ;; It is a negative annotation: | |
532 ;; Close the top annotation & add its text property. | |
533 ;; If the file's nesting is messed up, the close might not match | |
534 ;; the top thing on the open-annotations stack. | |
535 ;; If no matching annotation is open, just ignore the close. | |
536 (if (not (assoc name open-ans)) | |
537 (message "Extra closing annotation (%s) in file" name) | |
538 ;; If one is open, but not on the top of the stack, close | |
539 ;; the things in between as well. Set `found' when the real | |
13983
292411768ad9
(format-annotate-atomic-property-change): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
13352
diff
changeset
|
540 ;; one is closed. |
11054 | 541 (while (not found) |
542 (let* ((top (car open-ans)) ; first on stack: should match. | |
543 (top-name (car top)) | |
544 (start (car (cdr top))) ; location of start | |
545 (params (cdr (cdr top))) ; parameters | |
546 (aalist translations) | |
547 (matched nil)) | |
548 (if (equal name top-name) | |
549 (setq found t) | |
550 (message "Improper nesting in file.")) | |
551 ;; Look through property names in TRANSLATIONS | |
552 (while aalist | |
553 (let ((prop (car (car aalist))) | |
554 (alist (cdr (car aalist)))) | |
555 ;; And look through values for each property | |
556 (while alist | |
557 (let ((value (car (car alist))) | |
558 (ans (cdr (car alist)))) | |
559 (if (member top-name ans) | |
560 ;; This annotation is listed, but still have to | |
561 ;; check if multiple annotations are satisfied | |
562 (if (member 'nil (mapcar | |
563 (lambda (r) | |
564 (assoc r open-ans)) | |
565 ans)) | |
566 nil ; multiple ans not satisfied | |
14452
7074747f9a8c
(format-deannotate-region): Fixed bug that created
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
567 ;; Yes, all set. |
7074747f9a8c
(format-deannotate-region): Fixed bug that created
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
568 ;; If there are multiple annotations going |
7074747f9a8c
(format-deannotate-region): Fixed bug that created
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
569 ;; into one text property, adjust the |
7074747f9a8c
(format-deannotate-region): Fixed bug that created
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
570 ;; begin points of the other annotations |
7074747f9a8c
(format-deannotate-region): Fixed bug that created
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
571 ;; so that we don't get double marking. |
7074747f9a8c
(format-deannotate-region): Fixed bug that created
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
572 (let ((to-reset ans) |
7074747f9a8c
(format-deannotate-region): Fixed bug that created
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
573 this-one) |
7074747f9a8c
(format-deannotate-region): Fixed bug that created
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
574 (while to-reset |
7074747f9a8c
(format-deannotate-region): Fixed bug that created
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
575 (setq this-one |
7074747f9a8c
(format-deannotate-region): Fixed bug that created
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
576 (assoc (car to-reset) |
7074747f9a8c
(format-deannotate-region): Fixed bug that created
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
577 (cdr open-ans))) |
7074747f9a8c
(format-deannotate-region): Fixed bug that created
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
578 (if this-one |
16954
380e33f3a5c6
Fix bug that caused crash on certain tags with parameters
Boris Goldowsky <boris@gnu.org>
parents:
16686
diff
changeset
|
579 (setcar (cdr this-one) loc)) |
14452
7074747f9a8c
(format-deannotate-region): Fixed bug that created
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
580 (setq to-reset (cdr to-reset)))) |
7074747f9a8c
(format-deannotate-region): Fixed bug that created
Richard M. Stallman <rms@gnu.org>
parents:
14169
diff
changeset
|
581 ;; Set loop variables to nil so loop |
11054 | 582 ;; will exit. |
583 (setq alist nil aalist nil matched t | |
584 ;; pop annotation off stack. | |
585 open-ans (cdr open-ans)) | |
586 (cond | |
587 ;; Check for pseudo-properties | |
588 ((eq prop 'PARAMETER) | |
589 ;; This is a parameter of the top open ann: | |
590 ;; delete text and use as arg. | |
591 (if open-ans | |
592 ;; (If nothing open, discard). | |
593 (setq open-ans | |
594 (cons (append (car open-ans) | |
595 (list | |
596 (buffer-substring | |
597 start loc))) | |
598 (cdr open-ans)))) | |
599 (delete-region start loc)) | |
600 ((eq prop 'FUNCTION) | |
601 ;; Not a property, but a function to call. | |
602 (let ((rtn (apply value start loc params))) | |
603 (if rtn (setq todo (cons rtn todo))))) | |
604 (t | |
605 ;; Normal property/value pair | |
606 (setq todo | |
607 (cons (list start loc prop value) | |
608 todo))))))) | |
609 (setq alist (cdr alist)))) | |
610 (setq aalist (cdr aalist))) | |
611 (if matched | |
612 nil | |
613 ;; Didn't find any match for the annotation: | |
614 ;; Store as value of text-property `unknown'. | |
615 (setq open-ans (cdr open-ans)) | |
616 (setq todo (cons (list start loc 'unknown top-name) | |
617 todo)) | |
618 (setq unknown-ans (cons name unknown-ans))))))))) | |
619 | |
620 ;; Once entire file has been scanned, add the properties. | |
621 (while todo | |
622 (let* ((item (car todo)) | |
623 (from (nth 0 item)) | |
624 (to (nth 1 item)) | |
625 (prop (nth 2 item)) | |
626 (val (nth 3 item))) | |
627 | |
628 (put-text-property | |
629 from to prop | |
630 (cond ((numberp val) ; add to ambient value if numeric | |
631 (+ val (or (get-text-property from prop) 0))) | |
632 ((get prop 'format-list-valued) ; value gets consed onto | |
633 ; list-valued properties | |
634 (let ((prev (get-text-property from prop))) | |
635 (cons val (if (listp prev) prev (list prev))))) | |
636 (t val)))) ; normally, just set to val. | |
637 (setq todo (cdr todo))) | |
638 | |
639 (if unknown-ans | |
640 (message "Unknown annotations: %s" unknown-ans)))))) | |
641 | |
642 ;;; | |
643 ;;; Encoding | |
644 ;;; | |
645 | |
646 (defun format-insert-annotations (list &optional offset) | |
647 "Apply list of annotations to buffer as `write-region' would. | |
648 Inserts each element of the given LIST of buffer annotations at its | |
649 appropriate place. Use second arg OFFSET if the annotations' locations are | |
650 not relative to the beginning of the buffer: annotations will be inserted | |
651 at their location-OFFSET+1 \(ie, the offset is treated as the character number | |
652 of the first character in the buffer)." | |
653 (if (not offset) | |
654 (setq offset 0) | |
655 (setq offset (1- offset))) | |
656 (let ((l (reverse list))) | |
657 (while l | |
658 (goto-char (- (car (car l)) offset)) | |
659 (insert (cdr (car l))) | |
660 (setq l (cdr l))))) | |
661 | |
662 (defun format-annotate-value (old new) | |
663 "Return OLD and NEW as a \(close . open) annotation pair. | |
664 Useful as a default function for TRANSLATIONS alist when the value of the text | |
665 property is the name of the annotation that you want to use, as it is for the | |
666 `unknown' text property." | |
667 (cons (if old (list old)) | |
668 (if new (list new)))) | |
669 | |
670 (defun format-annotate-region (from to trans format-fn ignore) | |
671 "Generate annotations for text properties in the region. | |
672 Searches for changes between FROM and TO, and describes them with a list of | |
673 annotations as defined by alist TRANSLATIONS and FORMAT-FN. IGNORE lists text | |
674 properties not to consider; any text properties that are neither ignored nor | |
675 listed in TRANSLATIONS are warned about. | |
676 If you actually want to modify the region, give the return value of this | |
677 function to `format-insert-annotations'. | |
678 | |
679 Format of the TRANSLATIONS argument: | |
680 | |
681 Each element is a list whose car is a PROPERTY, and the following | |
682 elements are VALUES of that property followed by the names of zero or more | |
683 ANNOTATIONS. Whenever the property takes on that value, the annotations | |
684 \(as formatted by FORMAT-FN) are inserted into the file. | |
685 When the property stops having that value, the matching negated annotation | |
686 will be inserted \(it may actually be closed earlier and reopened, if | |
687 necessary, to keep proper nesting). | |
688 | |
689 If the property's value is a list, then each element of the list is dealt with | |
690 separately. | |
691 | |
692 If a VALUE is numeric, then it is assumed that there is a single annotation | |
693 and each occurrence of it increments the value of the property by that number. | |
694 Thus, given the entry \(left-margin \(4 \"indent\")), if the left margin | |
695 changes from 4 to 12, two <indent> annotations will be generated. | |
696 | |
697 If the VALUE is nil, then instead of annotations, a function should be | |
698 specified. This function is used as a default: it is called for all | |
699 transitions not explicitly listed in the table. The function is called with | |
700 two arguments, the OLD and NEW values of the property. It should return | |
701 lists of annotations like `format-annotate-location' does. | |
702 | |
703 The same structure can be used in reverse for reading files." | |
704 (let ((all-ans nil) ; All annotations - becomes return value | |
705 (open-ans nil) ; Annotations not yet closed | |
706 (loc nil) ; Current location | |
707 (not-found nil)) ; Properties that couldn't be saved | |
708 (while (or (null loc) | |
709 (and (setq loc (next-property-change loc nil to)) | |
710 (< loc to))) | |
711 (or loc (setq loc from)) | |
712 (let* ((ans (format-annotate-location loc (= loc from) ignore trans)) | |
713 (neg-ans (format-reorder (aref ans 0) open-ans)) | |
714 (pos-ans (aref ans 1)) | |
715 (ignored (aref ans 2))) | |
716 (setq not-found (append ignored not-found) | |
717 ignore (append ignored ignore)) | |
718 ;; First do the negative (closing) annotations | |
719 (while neg-ans | |
720 ;; Check if it's missing. This can happen (eg, a numeric property | |
721 ;; going negative can generate closing annotations before there are | |
722 ;; any open). Warn user & ignore. | |
723 (if (not (member (car neg-ans) open-ans)) | |
724 (message "Can't close %s: not open." (car neg-ans)) | |
725 (while (not (equal (car neg-ans) (car open-ans))) | |
726 ;; To close anno. N, need to first close ans 1 to N-1, | |
727 ;; remembering to re-open them later. | |
728 (setq pos-ans (cons (car open-ans) pos-ans)) | |
729 (setq all-ans | |
730 (cons (cons loc (funcall format-fn (car open-ans) nil)) | |
731 all-ans)) | |
732 (setq open-ans (cdr open-ans))) | |
733 ;; Now remove the one we're really interested in from open list. | |
734 (setq open-ans (cdr open-ans)) | |
735 ;; And put the closing annotation here. | |
736 (setq all-ans | |
737 (cons (cons loc (funcall format-fn (car neg-ans) nil)) | |
738 all-ans))) | |
739 (setq neg-ans (cdr neg-ans))) | |
740 ;; Now deal with positive (opening) annotations | |
741 (let ((p pos-ans)) | |
742 (while pos-ans | |
743 (setq open-ans (cons (car pos-ans) open-ans)) | |
744 (setq all-ans | |
745 (cons (cons loc (funcall format-fn (car pos-ans) t)) | |
746 all-ans)) | |
747 (setq pos-ans (cdr pos-ans)))))) | |
748 | |
749 ;; Close any annotations still open | |
750 (while open-ans | |
751 (setq all-ans | |
752 (cons (cons to (funcall format-fn (car open-ans) nil)) | |
753 all-ans)) | |
754 (setq open-ans (cdr open-ans))) | |
755 (if not-found | |
756 (message "These text properties could not be saved:\n %s" | |
757 not-found)) | |
758 (nreverse all-ans))) | |
759 | |
760 ;;; Internal functions for format-annotate-region. | |
761 | |
762 (defun format-annotate-location (loc all ignore trans) | |
763 "Return annotation(s) needed at LOCATION. | |
764 This includes any properties that change between LOC-1 and LOC. | |
765 If ALL is true, don't look at previous location, but generate annotations for | |
766 all non-nil properties. | |
767 Third argument IGNORE is a list of text-properties not to consider. | |
768 | |
769 Return value is a vector of 3 elements: | |
770 1. List of names of the annotations to close | |
771 2. List of the names of annotations to open. | |
772 3. List of properties that were ignored or couldn't be annotated." | |
773 (let* ((prev-loc (1- loc)) | |
774 (before-plist (if all nil (text-properties-at prev-loc))) | |
775 (after-plist (text-properties-at loc)) | |
776 p negatives positives prop props not-found) | |
777 ;; make list of all property names involved | |
778 (setq p before-plist) | |
779 (while p | |
780 (if (not (memq (car p) props)) | |
781 (setq props (cons (car p) props))) | |
782 (setq p (cdr (cdr p)))) | |
783 (setq p after-plist) | |
784 (while p | |
785 (if (not (memq (car p) props)) | |
786 (setq props (cons (car p) props))) | |
787 (setq p (cdr (cdr p)))) | |
788 | |
789 (while props | |
790 (setq prop (car props) | |
791 props (cdr props)) | |
792 (if (memq prop ignore) | |
793 nil ; If it's been ignored before, ignore it now. | |
794 (let ((before (if all nil (car (cdr (memq prop before-plist))))) | |
795 (after (car (cdr (memq prop after-plist))))) | |
796 (if (equal before after) | |
797 nil ; no change; ignore | |
798 (let ((result (format-annotate-single-property-change | |
799 prop before after trans))) | |
800 (if (not result) | |
801 (setq not-found (cons prop not-found)) | |
802 (setq negatives (nconc negatives (car result)) | |
803 positives (nconc positives (cdr result))))))))) | |
804 (vector negatives positives not-found))) | |
805 | |
806 (defun format-annotate-single-property-change (prop old new trans) | |
807 "Return annotations for PROPERTY changing from OLD to NEW. | |
808 These are searched for in the TRANSLATIONS alist. | |
809 If NEW does not appear in the list, but there is a default function, then that | |
810 function is called. | |
811 Annotations to open and to close are returned as a dotted pair." | |
812 (let ((prop-alist (cdr (assoc prop trans))) | |
813 default) | |
814 (if (not prop-alist) | |
815 nil | |
816 ;; If property is numeric, nil means 0 | |
817 (cond ((and (numberp old) (null new)) | |
818 (setq new 0)) | |
819 ((and (numberp new) (null old)) | |
820 (setq old 0))) | |
821 ;; If either old or new is a list, have to treat both that way. | |
822 (if (or (consp old) (consp new)) | |
823 (let* ((old (if (listp old) old (list old))) | |
824 (new (if (listp new) new (list new))) | |
825 (tail (format-common-tail old new)) | |
826 close open) | |
827 (while old | |
828 (setq close | |
829 (append (car (format-annotate-atomic-property-change | |
830 prop-alist (car old) nil)) | |
831 close) | |
832 old (cdr old))) | |
833 (while new | |
834 (setq open | |
835 (append (cdr (format-annotate-atomic-property-change | |
836 prop-alist nil (car new))) | |
837 open) | |
838 new (cdr new))) | |
839 (format-make-relatively-unique close open)) | |
840 (format-annotate-atomic-property-change prop-alist old new))))) | |
841 | |
842 (defun format-annotate-atomic-property-change (prop-alist old new) | |
843 "Internal function annotate a single property change. | |
13983
292411768ad9
(format-annotate-atomic-property-change): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents:
13352
diff
changeset
|
844 PROP-ALIST is the relevant segment of a TRANSLATIONS list. |
11054 | 845 OLD and NEW are the values." |
19155
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
846 (let (num-ann) |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
847 ;; If old and new values are numbers, |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
848 ;; look for a number in PROP-ALIST. |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
849 (if (and (numberp old) (numberp new)) |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
850 (progn |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
851 (setq num-ann prop-alist) |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
852 (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
|
853 (setq num-ann (cdr num-ann))))) |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
854 (if num-ann |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
855 ;; Numerical annotation - use difference |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
856 (let* ((entry (car num-ann)) |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
857 (increment (car entry)) |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
858 (n (ceiling (/ (float (- new old)) (float increment)))) |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
859 (anno (car (cdr entry)))) |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
860 (if (> n 0) |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
861 (cons nil (make-list n anno)) |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
862 (cons (make-list (- n) anno) nil))) |
11054 | 863 |
19155
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
864 ;; Standard annotation |
20fda18753c2
(format-annotate-atomic-property-change):
Richard M. Stallman <rms@gnu.org>
parents:
18690
diff
changeset
|
865 (let ((close (and old (cdr (assoc old prop-alist)))) |
11054 | 866 (open (and new (cdr (assoc new prop-alist))))) |
867 (if (or close open) | |
868 (format-make-relatively-unique close open) | |
869 ;; Call "Default" function, if any | |
870 (let ((default (assq nil prop-alist))) | |
871 (if default | |
872 (funcall (car (cdr default)) old new)))))))) | |
873 | |
18140
f16cf00a2f42
(format-insert-file): Fix arg order to format-decode.
Richard M. Stallman <rms@gnu.org>
parents:
16954
diff
changeset
|
874 (provide 'format) |
11054 | 875 ;; format.el ends here |