Mercurial > hg > xemacs-beta
annotate lisp/format.el @ 5379:a32a108ae815
#'cl-non-fixnum-number-p: return t for integers > #x3fffffff and < -#x40000000
2011-03-21 Aidan Kehoe <kehoea@parhasard.net>
* cl-macs.el (cl-non-fixnum-number-p):
This should return t under 64-bit builds for fixnums that would
be bignums on a 32-bit machine; make it so.
author | Aidan Kehoe <kehoea@parhasard.net> |
---|---|
date | Mon, 21 Mar 2011 12:19:25 +0000 |
parents | dbae25a8949d |
children | ac37a5f7e5be |
rev | line source |
---|---|
428 | 1 ;;; format.el --- read and save files in multiple formats |
2 | |
3 ;; Copyright (c) 1994, 1995, 1997 Free Software Foundation | |
4 | |
5 ;; Author: Boris Goldowsky <boris@gnu.ai.mit.edu> | |
6 ;; Keywords: extensions, dumped | |
7 | |
8 ;; This file is part of XEmacs. | |
9 | |
10 ;; XEmacs is free software; you can redistribute it and/or modify it | |
11 ;; under the terms of the GNU General Public License as published by | |
12 ;; the Free Software Foundation; either version 2, or (at your option) | |
13 ;; any later version. | |
14 | |
15 ;; XEmacs is distributed in the hope that it will be useful, but | |
16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
18 ;; General Public License for more details. | |
19 | |
20 ;; You should have received a copy of the GNU General Public License | |
21 ;; along with XEmacs; see the file COPYING. If not, write to the Free | |
22 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA | |
23 ;; 02111-1307, USA. | |
24 | |
25 ;;; Synched up with: Emacs 20.2. | |
26 | |
27 ;;; Commentary: | |
28 | |
29 ;; This file is dumped with XEmacs. | |
30 | |
31 ;; This file defines a unified mechanism for saving & loading files stored | |
32 ;; in different formats. `format-alist' contains information that directs | |
33 ;; Emacs to call an encoding or decoding function when reading or writing | |
34 ;; files that match certain conditions. | |
35 ;; | |
36 ;; When a file is visited, its format is determined by matching the | |
37 ;; beginning of the file against regular expressions stored in | |
38 ;; `format-alist'. If this fails, you can manually translate the buffer | |
39 ;; using `format-decode-buffer'. In either case, the formats used are | |
40 ;; listed in the variable `buffer-file-format', and become the default | |
41 ;; format for saving the buffer. To save a buffer in a different format, | |
42 ;; change this variable, or use `format-write-file'. | |
43 ;; | |
44 ;; Auto-save files are normally created in the same format as the visited | |
45 ;; file, but the variable `auto-save-file-format' can be set to a | |
46 ;; particularly fast or otherwise preferred format to be used for | |
47 ;; auto-saving (or nil to do no encoding on auto-save files, but then you | |
48 ;; risk losing any text-properties in the buffer). | |
49 ;; | |
50 ;; You can manually translate a buffer into or out of a particular format | |
51 ;; with the functions `format-encode-buffer' and `format-decode-buffer'. | |
52 ;; To translate just the region use the functions `format-encode-region' | |
53 ;; and `format-decode-region'. | |
54 ;; | |
55 ;; You can define a new format by writing the encoding and decoding | |
56 ;; functions, and adding an entry to `format-alist'. See enriched.el for | |
57 ;; an example of how to implement a file format. There are various | |
58 ;; functions defined in this file that may be useful for writing the | |
59 ;; encoding and decoding functions: | |
60 ;; * `format-annotate-region' and `format-deannotate-region' allow a | |
61 ;; single alist of information to be used for encoding and decoding. | |
62 ;; The alist defines a correspondence between strings in the file | |
63 ;; ("annotations") and text-properties in the buffer. | |
64 ;; * `format-replace-strings' is similarly useful for doing simple | |
65 ;; string->string translations in a reversible manner. | |
66 | |
67 ;;; Code: | |
68 | |
69 (put 'buffer-file-format 'permanent-local t) | |
70 | |
71 (defvar format-alist | |
72 '( | |
73 ; (image/jpeg "JPEG image" "\377\330\377\340\000\020JFIF" | |
74 ; image-decode-jpeg nil t image-mode) | |
75 ; (image/gif "GIF image" "GIF8[79]" | |
76 ; image-decode-gif nil t image-mode) | |
77 ; (image/png "Portable Network Graphics" "\211PNG" | |
78 ; image-decode-png nil t image-mode) | |
79 ; (image/x-xpm "XPM image" "/\\* XPM \\*/" | |
80 ; image-decode-xpm nil t image-mode) | |
81 | |
82 ; ;; TIFF files have lousy magic | |
83 ; (image/tiff "TIFF image" "II\\*\000" | |
84 ; image-decode-tiff nil t image-mode) ;; TIFF 6.0 big-endian | |
85 ; (image/tiff "TIFF image" "MM\000\\*" | |
86 ; image-decode-tiff nil t image-mode) ;; TIFF 6.0 little-endian | |
87 | |
88 (text/enriched "Extended MIME text/enriched format." | |
89 "Content-[Tt]ype:[ \t]*text/enriched" | |
90 enriched-decode enriched-encode t enriched-mode) | |
91 (text/richtext "Extended MIME obsolete text/richtext format." | |
92 "Content-[Tt]ype:[ \t]*text/richtext" | |
93 richtext-decode richtext-encode t enriched-mode) | |
94 (plain "ISO 8859-1 standard format, no text properties." | |
95 ;; Plain only exists so that there is an obvious neutral choice in | |
96 ;; the completion list. | |
97 nil nil nil nil nil) | |
98 ;; (ibm "IBM Code Page 850 (DOS)" | |
99 ;; "1\\(^\\)" | |
100 ;; "recode ibm-pc:latin1" "recode latin1:ibm-pc" t nil) | |
101 ;; (mac "Apple Macintosh" | |
102 ;; "1\\(^\\)" | |
103 ;; "recode mac:latin1" "recode latin1:mac" t nil) | |
104 ;; (hp "HP Roman8" | |
105 ;; "1\\(^\\)" | |
106 ;; "recode roman8:latin1" "recode latin1:roman8" t nil) | |
107 ;; (TeX "TeX (encoding)" | |
108 ;; "1\\(^\\)" | |
109 ;; iso-tex2iso iso-iso2tex t nil) | |
110 ;; (gtex "German TeX (encoding)" | |
111 ;; "1\\(^\\)" | |
112 ;; iso-gtex2iso iso-iso2gtex t nil) | |
113 ;; (html "HTML (encoding)" | |
114 ;; "1\\(^\\)" | |
115 ;; "recode html:latin1" "recode latin1:html" t nil) | |
116 ;; (rot13 "rot13" | |
117 ;; "1\\(^\\)" | |
118 ;; "tr a-mn-z n-za-m" "tr a-mn-z n-za-m" t nil) | |
119 ;; (duden "Duden Ersatzdarstellung" | |
120 ;; "1\\(^\\)" | |
121 ;; "diac" iso-iso2duden t nil) | |
122 ;; (de646 "German ASCII (ISO 646)" | |
123 ;; "1\\(^\\)" | |
124 ;; "recode iso646-ge:latin1" "recode latin1:iso646-ge" t nil) | |
125 ;; (denet "net German" | |
126 ;; "1\\(^\\)" | |
127 ;; iso-german iso-cvt-read-only t nil) | |
128 ;; (esnet "net Spanish" | |
129 ;; "1\\(^\\)" | |
130 ;; iso-spanish iso-cvt-read-only t nil) | |
131 ) | |
132 "List of information about understood file formats. | |
133 Elements are of the form \(NAME DOC-STR REGEXP FROM-FN TO-FN MODIFY MODE-FN). | |
134 | |
135 NAME is a symbol, which is stored in `buffer-file-format'. | |
136 | |
137 DOC-STR should be a single line providing more information about the | |
138 format. It is currently unused, but in the future will be shown to | |
139 the user if they ask for more information. | |
140 | |
141 REGEXP is a regular expression to match against the beginning of the file; | |
142 it should match only files in that format. | |
143 | |
144 FROM-FN is called to decode files in that format; it gets two args, BEGIN | |
145 and END, and can make any modifications it likes, returning the new | |
146 end. It must make sure that the beginning of the file no longer | |
147 matches REGEXP, or else it will get called again. | |
148 Alternatively, FROM-FN can be a string, which specifies a shell command | |
149 (including options) to be used as a filter to perform the conversion. | |
150 | |
151 TO-FN is called to encode a region into that format; it is passed three | |
152 arguments: BEGIN, END, and BUFFER. BUFFER is the original buffer that | |
153 the data being written came from, which the function could use, for | |
154 example, to find the values of local variables. TO-FN should either | |
155 return a list of annotations like `write-region-annotate-functions', | |
156 or modify the region and return the new end. | |
157 Alternatively, TO-FN can be a string, which specifies a shell command | |
158 (including options) to be used as a filter to perform the conversion. | |
159 | |
160 MODIFY, if non-nil, means the TO-FN wants to modify the region. If nil, | |
161 TO-FN will not make any changes but will instead return a list of | |
162 annotations. | |
163 | |
164 MODE-FN, if specified, is called when visiting a file with that format.") | |
165 | |
166 ;;; Basic Functions (called from Lisp) | |
167 | |
168 (defun format-encode-run-method (method from to &optional buffer) | |
169 "Translate using function or shell script METHOD the text from FROM to TO. | |
170 If METHOD is a string, it is a shell command; | |
171 otherwise, it should be a Lisp function. | |
172 BUFFER should be the buffer that the output originally came from." | |
173 (if (stringp method) | |
174 (save-current-buffer | |
175 (set-buffer buffer) | |
176 (with-output-to-temp-buffer "*Format Errors*" | |
177 (shell-command-on-region from to method t nil)) | |
178 (point)) | |
179 (funcall method from to buffer))) | |
180 | |
181 (defun format-decode-run-method (method from to &optional buffer) | |
182 "Decode using function or shell script METHOD the text from FROM to TO. | |
183 If METHOD is a string, it is a shell command; | |
184 otherwise, it should be a Lisp function." | |
185 (if (stringp method) | |
186 (progn | |
187 (with-output-to-temp-buffer "*Format Errors*" | |
188 (shell-command-on-region from to method t nil)) | |
189 (point)) | |
190 (funcall method from to))) | |
191 | |
192 (defun format-annotate-function (format from to orig-buf) | |
193 "Return annotations for writing region as FORMAT. | |
194 FORMAT is a symbol naming one of the formats defined in `format-alist', | |
195 it must be a single symbol, not a list like `buffer-file-format'. | |
196 FROM and TO delimit the region to be operated on in the current buffer. | |
197 ORIG-BUF is the original buffer that the data came from. | |
198 This function works like a function on `write-region-annotate-functions': | |
199 it either returns a list of annotations, or returns with a different buffer | |
200 current, which contains the modified text to write. | |
201 | |
202 For most purposes, consider using `format-encode-region' instead." | |
203 ;; This function is called by write-region (actually build-annotations) | |
204 ;; for each element of buffer-file-format. | |
205 (let* ((info (assq format format-alist)) | |
206 (to-fn (nth 4 info)) | |
207 (modify (nth 5 info))) | |
208 (if to-fn | |
209 (if modify | |
210 ;; To-function wants to modify region. Copy to safe place. | |
211 (let ((copy-buf (get-buffer-create " *Format Temp*"))) | |
212 (copy-to-buffer copy-buf from to) | |
213 (set-buffer copy-buf) | |
214 (format-insert-annotations write-region-annotations-so-far from) | |
215 (format-encode-run-method to-fn (point-min) (point-max) orig-buf) | |
216 nil) | |
217 ;; Otherwise just call function, it will return annotations. | |
218 (funcall to-fn from to orig-buf))))) | |
219 | |
220 (defun format-decode (format length &optional visit-flag) | |
221 "Decode text from any known FORMAT. | |
222 FORMAT is a symbol appearing in `format-alist' or a list of such symbols, | |
223 or nil, in which case this function tries to guess the format of the data by | |
224 matching against the regular expressions in `format-alist'. After a match is | |
225 found and the region decoded, the alist is searched again from the beginning | |
226 for another match. | |
227 | |
228 Second arg LENGTH is the number of characters following point to operate on. | |
229 If optional third arg VISIT-FLAG is true, set `buffer-file-format' | |
230 to the list of formats used, and call any mode functions defined for those | |
231 formats. | |
232 | |
233 Returns the new length of the decoded region. | |
234 | |
235 For most purposes, consider using `format-decode-region' instead. | |
236 | |
237 This function is called by insert-file-contents whenever a file is read." | |
238 (let ((mod (buffer-modified-p)) | |
239 (begin (point)) | |
240 (end (+ (point) length))) | |
241 (if (null format) | |
242 ;; Figure out which format it is in, remember list in `format'. | |
243 (let ((try format-alist)) | |
244 (while try | |
245 (let* ((f (car try)) | |
246 (regexp (nth 2 f)) | |
247 (p (point))) | |
248 (if (and regexp (looking-at regexp) | |
249 (< (match-end 0) (+ begin length))) | |
250 (progn | |
251 (setq format (cons (car f) format)) | |
252 ;; Decode it | |
253 (if (nth 3 f) | |
254 (setq end (format-decode-run-method (nth 3 f) begin end))) | |
255 ;; Call visit function if required | |
256 (if (and visit-flag (nth 6 f)) (funcall (nth 6 f) 1)) | |
257 ;; Safeguard against either of the functions changing pt. | |
258 (goto-char p) | |
259 ;; Rewind list to look for another format | |
260 (setq try format-alist)) | |
261 (setq try (cdr try)))))) | |
262 ;; Deal with given format(s) | |
263 (or (listp format) (setq format (list format))) | |
264 (let ((do format) f) | |
265 (while do | |
266 (or (setq f (assq (car do) format-alist)) | |
267 (error "Unknown format" (car do))) | |
268 ;; Decode: | |
269 (if (nth 3 f) | |
270 (setq end (format-decode-run-method (nth 3 f) begin end))) | |
271 ;; Call visit function if required | |
272 (if (and visit-flag (nth 6 f)) (funcall (nth 6 f) 1)) | |
273 (setq do (cdr do))))) | |
274 (if visit-flag | |
275 (setq buffer-file-format format)) | |
276 (set-buffer-modified-p mod) | |
277 ;; Return new length of region | |
278 (- end begin))) | |
279 | |
280 ;;; | |
281 ;;; Interactive functions & entry points | |
282 ;;; | |
283 | |
284 (defun format-decode-buffer (&optional format) | |
285 "Translate the buffer from some FORMAT. | |
286 If the format is not specified, this function attempts to guess. | |
287 `buffer-file-format' is set to the format used, and any mode-functions | |
288 for the format are called." | |
289 (interactive | |
290 (list (format-read "Translate buffer from format (default: guess): "))) | |
291 (save-excursion | |
292 (goto-char (point-min)) | |
293 (format-decode format (buffer-size) t))) | |
294 | |
295 (defun format-decode-region (from to &optional format) | |
296 "Decode the region from some format. | |
297 Arg FORMAT is optional; if omitted the format will be determined by looking | |
298 for identifying regular expressions at the beginning of the region." | |
299 (interactive | |
300 (list (region-beginning) (region-end) | |
301 (format-read "Translate region from format (default: guess): "))) | |
302 (save-excursion | |
303 (goto-char from) | |
304 (format-decode format (- to from) nil))) | |
305 | |
306 (defun format-encode-buffer (&optional format) | |
307 "Translate the buffer into FORMAT. | |
308 FORMAT defaults to `buffer-file-format'. It is a symbol naming one of the | |
309 formats defined in `format-alist', or a list of such symbols." | |
310 (interactive | |
311 (list (format-read (format "Translate buffer to format (default %s): " | |
312 buffer-file-format)))) | |
313 (format-encode-region (point-min) (point-max) format)) | |
314 | |
444 | 315 (defun format-encode-region (start end &optional format) |
428 | 316 "Translate the region into some FORMAT. |
317 FORMAT defaults to `buffer-file-format', it is a symbol naming | |
318 one of the formats defined in `format-alist', or a list of such symbols." | |
319 (interactive | |
320 (list (region-beginning) (region-end) | |
321 (format-read (format "Translate region to format (default %s): " | |
322 buffer-file-format)))) | |
323 (if (null format) (setq format buffer-file-format)) | |
324 (if (symbolp format) (setq format (list format))) | |
325 (save-excursion | |
326 (goto-char end) | |
327 (let ( ; (cur-buf (current-buffer)) | |
328 (end (point-marker))) | |
329 (while format | |
330 (let* ((info (assq (car format) format-alist)) | |
331 (to-fn (nth 4 info)) | |
332 (modify (nth 5 info)) | |
333 ;; result | |
334 ) | |
335 (if to-fn | |
336 (if modify | |
444 | 337 (setq end (format-encode-run-method to-fn start end |
428 | 338 (current-buffer))) |
339 (format-insert-annotations | |
444 | 340 (funcall to-fn start end (current-buffer))))) |
428 | 341 (setq format (cdr format))))))) |
342 | |
343 (defun format-write-file (filename format) | |
344 "Write current buffer into a FILE using some FORMAT. | |
345 Makes buffer visit that file and sets the format as the default for future | |
346 saves. If the buffer is already visiting a file, you can specify a directory | |
347 name as FILE, to write a file of the same old name in that directory." | |
348 (interactive | |
349 ;; Same interactive spec as write-file, plus format question. | |
350 (let* ((file (if buffer-file-name | |
351 (read-file-name "Write file: " | |
352 nil nil nil nil) | |
353 (read-file-name "Write file: " | |
354 (cdr (assq 'default-directory | |
355 (buffer-local-variables))) | |
356 nil nil (buffer-name)))) | |
357 (fmt (format-read (format "Write file `%s' in format: " | |
358 (file-name-nondirectory file))))) | |
359 (list file fmt))) | |
360 (setq buffer-file-format format) | |
361 (write-file filename)) | |
362 | |
363 (defun format-find-file (filename format) | |
364 "Find the file FILE using data format FORMAT. | |
365 If FORMAT is nil then do not do any format conversion." | |
366 (interactive | |
367 ;; Same interactive spec as write-file, plus format question. | |
368 (let* ((file (read-file-name "Find file: ")) | |
369 (fmt (format-read (format "Read file `%s' in format: " | |
370 (file-name-nondirectory file))))) | |
371 (list file fmt))) | |
372 (let ((format-alist nil)) | |
373 (find-file filename)) | |
374 (if format | |
375 (format-decode-buffer format))) | |
376 | |
444 | 377 (defun format-insert-file (filename format &optional start end) |
428 | 378 "Insert the contents of file FILE using data format FORMAT. |
379 If FORMAT is nil then do not do any format conversion. | |
444 | 380 The optional third and fourth arguments START and END specify |
428 | 381 the part of the file to read. |
382 | |
383 The return value is like the value of `insert-file-contents': | |
384 a list (ABSOLUTE-FILE-NAME . SIZE)." | |
385 (interactive | |
386 ;; Same interactive spec as write-file, plus format question. | |
387 (let* ((file (read-file-name "Find file: ")) | |
388 (fmt (format-read (format "Read file `%s' in format: " | |
389 (file-name-nondirectory file))))) | |
390 (list file fmt))) | |
391 (let (value size) | |
392 (let ((format-alist nil)) | |
444 | 393 (setq value (insert-file-contents filename nil start end)) |
428 | 394 (setq size (nth 1 value))) |
395 (if format | |
396 (setq size (format-decode format size) | |
397 value (cons (car value) size))) | |
398 value)) | |
399 | |
400 (defun format-read (&optional prompt) | |
401 "Read and return the name of a format. | |
402 Return value is a list, like `buffer-file-format'; it may be nil. | |
403 Formats are defined in `format-alist'. Optional arg is the PROMPT to use." | |
404 (let* ((table (mapcar (lambda (x) (list (symbol-name (car x)))) | |
405 format-alist)) | |
406 (ans (completing-read (or prompt "Format: ") table nil t))) | |
407 (if (not (equal "" ans)) (list (intern ans))))) | |
408 | |
409 | |
410 ;;; | |
411 ;;; Below are some functions that may be useful in writing encoding and | |
412 ;;; decoding functions for use in format-alist. | |
413 ;;; | |
414 | |
444 | 415 (defun format-replace-strings (alist &optional reverse start end) |
428 | 416 "Do multiple replacements on the buffer. |
417 ALIST is a list of (from . to) pairs, which should be proper arguments to | |
418 `search-forward' and `replace-match' respectively. | |
419 Optional 2nd arg REVERSE, if non-nil, means the pairs are (to . from), so that | |
420 you can use the same list in both directions if it contains only literal | |
421 strings. | |
422 Optional args BEGIN and END specify a region of the buffer to operate on." | |
423 (save-excursion | |
424 (save-restriction | |
444 | 425 (or start (setq start (point-min))) |
428 | 426 (if end (narrow-to-region (point-min) end)) |
427 (while alist | |
428 (let ((from (if reverse (cdr (car alist)) (car (car alist)))) | |
429 (to (if reverse (car (cdr alist)) (cdr (car alist))))) | |
444 | 430 (goto-char start) |
428 | 431 (while (search-forward from nil t) |
432 (goto-char (match-beginning 0)) | |
433 (insert to) | |
434 (set-text-properties (- (point) (length to)) (point) | |
435 (text-properties-at (point))) | |
436 (delete-region (point) (+ (point) (- (match-end 0) | |
437 (match-beginning 0))))) | |
438 (setq alist (cdr alist))))))) | |
439 | |
440 (put 'face 'format-list-valued t) ; These text-properties take values | |
441 (put 'unknown 'format-list-valued t) ; that are lists, the elements of which | |
442 ; should be considered separately. | |
443 ; See format-deannotate-region and | |
444 ; format-annotate-region. | |
445 | |
446 ;;; | |
447 ;;; Decoding | |
448 ;;; | |
449 | |
450 (defun format-deannotate-region (from to translations next-fn) | |
451 "Translate annotations in the region into text properties. | |
452 This sets text properties between FROM to TO as directed by the | |
453 TRANSLATIONS and NEXT-FN arguments. | |
454 | |
455 NEXT-FN is a function that searches forward from point for an annotation. | |
456 It should return a list of 4 elements: \(BEGIN END NAME POSITIVE). BEGIN and | |
457 END are buffer positions bounding the annotation, NAME is the name searched | |
458 for in TRANSLATIONS, and POSITIVE should be non-nil if this annotation marks | |
459 the beginning of a region with some property, or nil if it ends the region. | |
460 NEXT-FN should return nil if there are no annotations after point. | |
461 | |
462 The basic format of the TRANSLATIONS argument is described in the | |
463 documentation for the `format-annotate-region' function. There are some | |
464 additional things to keep in mind for decoding, though: | |
465 | |
466 When an annotation is found, the TRANSLATIONS list is searched for a | |
467 text-property name and value that corresponds to that annotation. If the | |
468 text-property has several annotations associated with it, it will be used only | |
469 if the other annotations are also in effect at that point. The first match | |
470 found whose annotations are all present is used. | |
471 | |
472 The text property thus determined is set to the value over the region between | |
473 the opening and closing annotations. However, if the text-property name has a | |
474 non-nil `format-list-valued' property, then the value will be consed onto the | |
475 surrounding value of the property, rather than replacing that value. | |
476 | |
477 There are some special symbols that can be used in the \"property\" slot of | |
478 the TRANSLATIONS list: PARAMETER and FUNCTION \(spelled in uppercase). | |
479 Annotations listed under the pseudo-property PARAMETER are considered to be | |
480 arguments of the immediately surrounding annotation; the text between the | |
481 opening and closing parameter annotations is deleted from the buffer but saved | |
482 as a string. The surrounding annotation should be listed under the | |
483 pseudo-property FUNCTION. Instead of inserting a text-property for this | |
484 annotation, the function listed in the VALUE slot is called to make whatever | |
485 changes are appropriate. The function's first two arguments are the START and | |
486 END locations, and the rest of the arguments are any PARAMETERs found in that | |
487 region. | |
488 | |
489 Any annotations that are found by NEXT-FN but not defined by TRANSLATIONS | |
490 are saved as values of the `unknown' text-property \(which is list-valued). | |
491 The TRANSLATIONS list should usually contain an entry of the form | |
492 \(unknown \(nil format-annotate-value)) | |
493 to write these unknown annotations back into the file." | |
494 (save-excursion | |
495 (save-restriction | |
496 (narrow-to-region (point-min) to) | |
497 (goto-char from) | |
498 (let (next open-ans todo | |
499 ;; loc | |
500 unknown-ans) | |
501 (while (setq next (funcall next-fn)) | |
502 (let* ((loc (nth 0 next)) | |
503 (end (nth 1 next)) | |
504 (name (nth 2 next)) | |
505 (positive (nth 3 next)) | |
506 (found nil)) | |
507 | |
508 ;; Delete the annotation | |
509 (delete-region loc end) | |
510 (cond | |
511 ;; Positive annotations are stacked, remembering location | |
512 (positive (setq open-ans (cons `(,name ((,loc . nil))) open-ans))) | |
513 ;; It is a negative annotation: | |
514 ;; Close the top annotation & add its text property. | |
515 ;; If the file's nesting is messed up, the close might not match | |
516 ;; the top thing on the open-annotations stack. | |
517 ;; If no matching annotation is open, just ignore the close. | |
518 ((not (assoc name open-ans)) | |
519 (message "Extra closing annotation (%s) in file" name)) | |
520 ;; If one is open, but not on the top of the stack, close | |
521 ;; the things in between as well. Set `found' when the real | |
522 ;; one is closed. | |
523 (t | |
524 (while (not found) | |
525 (let* ((top (car open-ans)) ; first on stack: should match. | |
526 (top-name (car top)) ; text property name | |
527 (top-extents (nth 1 top)) ; property regions | |
528 (params (cdr (cdr top))) ; parameters | |
529 (aalist translations) | |
530 (matched nil)) | |
531 (if (equal name top-name) | |
532 (setq found t) | |
533 (message "Improper nesting in file.")) | |
534 ;; Look through property names in TRANSLATIONS | |
535 (while aalist | |
536 (let ((prop (car (car aalist))) | |
537 (alist (cdr (car aalist)))) | |
538 ;; And look through values for each property | |
539 (while alist | |
540 (let ((value (car (car alist))) | |
541 (ans (cdr (car alist)))) | |
542 (if (member top-name ans) | |
543 ;; This annotation is listed, but still have to | |
544 ;; check if multiple annotations are satisfied | |
5270
3acaa0fc09be
Use #'some, #'every, etc. for composing boolean operations on lists.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
545 (if (notevery (lambda (r) (assoc r open-ans)) |
3acaa0fc09be
Use #'some, #'every, etc. for composing boolean operations on lists.
Aidan Kehoe <kehoea@parhasard.net>
parents:
4607
diff
changeset
|
546 ans) |
428 | 547 nil ; multiple ans not satisfied |
548 ;; If there are multiple annotations going | |
549 ;; into one text property, split up the other | |
550 ;; annotations so they apply individually to | |
551 ;; the other regions. | |
552 (setcdr (car top-extents) loc) | |
553 (let ((to-split ans) this-one extents) | |
554 (while to-split | |
555 (setq this-one | |
556 (assoc (car to-split) open-ans) | |
557 extents (nth 1 this-one)) | |
558 (if (not (eq this-one top)) | |
559 (setcar (cdr this-one) | |
560 (format-subtract-regions | |
561 extents top-extents))) | |
562 (setq to-split (cdr to-split)))) | |
563 ;; Set loop variables to nil so loop | |
564 ;; will exit. | |
565 (setq alist nil aalist nil matched t | |
566 ;; pop annotation off stack. | |
567 open-ans (cdr open-ans)) | |
568 (let ((extents top-extents) | |
569 (start (car (car top-extents))) | |
570 (loc (cdr (car top-extents)))) | |
571 (while extents | |
572 (cond | |
573 ;; Check for pseudo-properties | |
574 ((eq prop 'PARAMETER) | |
575 ;; A parameter of the top open ann: | |
576 ;; delete text and use as arg. | |
577 (if open-ans | |
578 ;; (If nothing open, discard). | |
579 (setq open-ans | |
580 (cons | |
581 (append (car open-ans) | |
582 (list | |
583 (buffer-substring | |
584 start loc))) | |
585 (cdr open-ans)))) | |
586 (delete-region start loc)) | |
587 ((eq prop 'FUNCTION) | |
588 ;; Not a property, but a function. | |
589 (let ((rtn | |
590 (apply value start loc params))) | |
591 (if rtn (setq todo (cons rtn todo))))) | |
592 (t | |
593 ;; Normal property/value pair | |
594 (setq todo | |
595 (cons (list start loc prop value) | |
596 todo)))) | |
597 (setq extents (cdr extents) | |
598 start (car (car extents)) | |
599 loc (cdr (car extents)))))))) | |
600 (setq alist (cdr alist)))) | |
601 (setq aalist (cdr aalist))) | |
602 (unless matched | |
603 ;; Didn't find any match for the annotation: | |
604 ;; Store as value of text-property `unknown'. | |
605 (setcdr (car top-extents) loc) | |
606 (let ((extents top-extents) | |
607 (start (car (car top-extents))) | |
608 (loc (cdr (car top-extents)))) | |
609 (while extents | |
610 (setq open-ans (cdr open-ans) | |
611 todo (cons (list start loc 'unknown top-name) | |
612 todo) | |
613 unknown-ans (cons name unknown-ans) | |
614 extents (cdr extents) | |
615 start (car (car extents)) | |
616 loc (cdr (car extents)))))))))))) | |
617 | |
618 ;; Once entire file has been scanned, add the properties. | |
619 (while todo | |
620 (let* ((item (car todo)) | |
621 (from (nth 0 item)) | |
622 (to (nth 1 item)) | |
623 (prop (nth 2 item)) | |
624 (val (nth 3 item))) | |
625 | |
626 (if (numberp val) ; add to ambient value if numeric | |
627 (format-property-increment-region from to prop val 0) | |
628 (put-text-property | |
629 from to prop | |
630 (cond ((get prop 'format-list-valued) ; value gets consed onto | |
631 ; list-valued properties | |
632 (let ((prev (get-text-property from prop))) | |
633 (cons val (if (listp prev) prev (list prev))))) | |
634 (t val))))) ; normally, just set to val. | |
635 (setq todo (cdr todo))) | |
636 | |
637 (if unknown-ans | |
638 (message "Unknown annotations: %s" unknown-ans)))))) | |
639 | |
640 (defun format-subtract-regions (minu subtra) | |
641 "Remove the regions in SUBTRAHEND from the regions in MINUEND. A region | |
642 is a dotted pair (from . to). Both parameters are lists of regions. Each | |
643 list must contain nonoverlapping, noncontiguous regions, in descending | |
644 order. The result is also nonoverlapping, noncontiguous, and in descending | |
645 order. The first element of MINUEND can have a cdr of nil, indicating that | |
646 the end of that region is not yet known." | |
647 (let* ((minuend (copy-alist minu)) | |
648 (subtrahend (copy-alist subtra)) | |
649 (m (car minuend)) | |
650 (s (car subtrahend)) | |
651 results) | |
652 (while (and minuend subtrahend) | |
653 (cond | |
654 ;; The minuend starts after the subtrahend ends; keep it. | |
655 ((> (car m) (cdr s)) | |
656 (setq results (cons m results) | |
657 minuend (cdr minuend) | |
658 m (car minuend))) | |
659 ;; The minuend extends beyond the end of the subtrahend. Chop it off. | |
660 ((or (null (cdr m)) (> (cdr m) (cdr s))) | |
661 (setq results (cons (cons (1+ (cdr s)) (cdr m)) results)) | |
662 (setcdr m (cdr s))) | |
663 ;; The subtrahend starts after the minuend ends; throw it away. | |
664 ((< (cdr m) (car s)) | |
665 (setq subtrahend (cdr subtrahend) s (car subtrahend))) | |
666 ;; The subtrahend extends beyond the end of the minuend. Chop it off. | |
667 (t ;(<= (cdr m) (cdr s))) | |
668 (if (>= (car m) (car s)) | |
669 (setq minuend (cdr minuend) m (car minuend)) | |
670 (setcdr m (1- (car s))) | |
671 (setq subtrahend (cdr subtrahend) s (car subtrahend)))))) | |
672 (nconc (nreverse results) minuend))) | |
673 | |
674 ;; This should probably go somewhere other than format.el. Then again, | |
675 ;; indent.el has alter-text-property. NOTE: We can also use | |
676 ;; next-single-property-change instead of text-property-not-all, but then | |
677 ;; we have to see if we passed TO. | |
678 (defun format-property-increment-region (from to prop delta default) | |
679 "Increment property PROP over the region between FROM and TO by the | |
680 amount DELTA (which may be negative). If property PROP is nil anywhere | |
681 in the region, it is treated as though it were DEFAULT." | |
682 (let ((cur from) val newval next) | |
683 (while cur | |
684 (setq val (get-text-property cur prop) | |
685 newval (+ (or val default) delta) | |
686 next (text-property-not-all cur to prop val)) | |
687 (put-text-property cur (or next to) prop newval) | |
688 (setq cur next)))) | |
689 | |
690 ;;; | |
691 ;;; Encoding | |
692 ;;; | |
693 | |
694 (defun format-insert-annotations (list &optional offset) | |
695 "Apply list of annotations to buffer as `write-region' would. | |
696 Inserts each element of the given LIST of buffer annotations at its | |
697 appropriate place. Use second arg OFFSET if the annotations' locations are | |
698 not relative to the beginning of the buffer: annotations will be inserted | |
699 at their location-OFFSET+1 \(ie, the offset is treated as the character number | |
700 of the first character in the buffer)." | |
701 (if (not offset) | |
702 (setq offset 0) | |
703 (setq offset (1- offset))) | |
704 (let ((l (reverse list))) | |
705 (while l | |
706 (goto-char (- (car (car l)) offset)) | |
707 (insert (cdr (car l))) | |
708 (setq l (cdr l))))) | |
709 | |
710 (defun format-annotate-value (old new) | |
711 "Return OLD and NEW as a \(close . open) annotation pair. | |
712 Useful as a default function for TRANSLATIONS alist when the value of the text | |
713 property is the name of the annotation that you want to use, as it is for the | |
714 `unknown' text property." | |
715 (cons (if old (list old)) | |
716 (if new (list new)))) | |
717 | |
718 (defun format-annotate-region (from to trans format-fn ignore) | |
719 "Generate annotations for text properties in the region. | |
720 Searches for changes between FROM and TO, and describes them with a list of | |
721 annotations as defined by alist TRANSLATIONS and FORMAT-FN. IGNORE lists text | |
722 properties not to consider; any text properties that are neither ignored nor | |
723 listed in TRANSLATIONS are warned about. | |
724 If you actually want to modify the region, give the return value of this | |
725 function to `format-insert-annotations'. | |
726 | |
727 Format of the TRANSLATIONS argument: | |
728 | |
729 Each element is a list whose car is a PROPERTY, and the following | |
730 elements are VALUES of that property followed by the names of zero or more | |
731 ANNOTATIONS. Whenever the property takes on that value, the annotations | |
732 \(as formatted by FORMAT-FN) are inserted into the file. | |
733 When the property stops having that value, the matching negated annotation | |
734 will be inserted \(it may actually be closed earlier and reopened, if | |
735 necessary, to keep proper nesting). | |
736 | |
737 If the property's value is a list, then each element of the list is dealt with | |
738 separately. | |
739 | |
740 If a VALUE is numeric, then it is assumed that there is a single annotation | |
741 and each occurrence of it increments the value of the property by that number. | |
742 Thus, given the entry \(left-margin \(4 \"indent\")), if the left margin | |
743 changes from 4 to 12, two <indent> annotations will be generated. | |
744 | |
745 If the VALUE is nil, then instead of annotations, a function should be | |
746 specified. This function is used as a default: it is called for all | |
747 transitions not explicitly listed in the table. The function is called with | |
748 two arguments, the OLD and NEW values of the property. It should return | |
749 lists of annotations like `format-annotate-location' does. | |
750 | |
751 The same structure can be used in reverse for reading files." | |
752 (let ((all-ans nil) ; All annotations - becomes return value | |
753 (open-ans nil) ; Annotations not yet closed | |
754 (loc nil) ; Current location | |
755 (not-found nil)) ; Properties that couldn't be saved | |
756 (while (or (null loc) | |
757 (and (setq loc (next-property-change loc nil to)) | |
758 (< loc to))) | |
759 (or loc (setq loc from)) | |
760 (let* ((ans (format-annotate-location loc (= loc from) ignore trans)) | |
5365
dbae25a8949d
Remove redundant functions, format.el, use functions from cl*.el instead.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5270
diff
changeset
|
761 (neg-ans (sort* (aref ans 0) '< |
dbae25a8949d
Remove redundant functions, format.el, use functions from cl*.el instead.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5270
diff
changeset
|
762 :key #'(lambda (object) |
dbae25a8949d
Remove redundant functions, format.el, use functions from cl*.el instead.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5270
diff
changeset
|
763 (or |
dbae25a8949d
Remove redundant functions, format.el, use functions from cl*.el instead.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5270
diff
changeset
|
764 (position object open-ans :test 'equal) |
dbae25a8949d
Remove redundant functions, format.el, use functions from cl*.el instead.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5270
diff
changeset
|
765 most-positive-fixnum)))) |
428 | 766 (pos-ans (aref ans 1)) |
767 (ignored (aref ans 2))) | |
768 (setq not-found (append ignored not-found) | |
769 ignore (append ignored ignore)) | |
770 ;; First do the negative (closing) annotations | |
771 (while neg-ans | |
772 ;; Check if it's missing. This can happen (eg, a numeric property | |
773 ;; going negative can generate closing annotations before there are | |
774 ;; any open). Warn user & ignore. | |
775 (if (not (member (car neg-ans) open-ans)) | |
776 (message "Can't close %s: not open." (car neg-ans)) | |
777 (while (not (equal (car neg-ans) (car open-ans))) | |
778 ;; To close anno. N, need to first close ans 1 to N-1, | |
779 ;; remembering to re-open them later. | |
780 (setq pos-ans (cons (car open-ans) pos-ans)) | |
781 (setq all-ans | |
782 (cons (cons loc (funcall format-fn (car open-ans) nil)) | |
783 all-ans)) | |
784 (setq open-ans (cdr open-ans))) | |
785 ;; Now remove the one we're really interested in from open list. | |
786 (setq open-ans (cdr open-ans)) | |
787 ;; And put the closing annotation here. | |
788 (setq all-ans | |
789 (cons (cons loc (funcall format-fn (car neg-ans) nil)) | |
790 all-ans))) | |
791 (setq neg-ans (cdr neg-ans))) | |
792 ;; Now deal with positive (opening) annotations | |
793 (let ( ; (p pos-ans) | |
794 ) | |
795 (while pos-ans | |
796 (setq open-ans (cons (car pos-ans) open-ans)) | |
797 (setq all-ans | |
798 (cons (cons loc (funcall format-fn (car pos-ans) t)) | |
799 all-ans)) | |
800 (setq pos-ans (cdr pos-ans)))))) | |
801 | |
802 ;; Close any annotations still open | |
803 (while open-ans | |
804 (setq all-ans | |
805 (cons (cons to (funcall format-fn (car open-ans) nil)) | |
806 all-ans)) | |
807 (setq open-ans (cdr open-ans))) | |
808 (if not-found | |
809 (message "These text properties could not be saved:\n %s" | |
810 not-found)) | |
811 (nreverse all-ans))) | |
812 | |
813 ;;; Internal functions for format-annotate-region. | |
814 | |
815 (defun format-annotate-location (loc all ignore trans) | |
816 "Return annotation(s) needed at LOCATION. | |
817 This includes any properties that change between LOC-1 and LOC. | |
818 If ALL is true, don't look at previous location, but generate annotations for | |
819 all non-nil properties. | |
820 Third argument IGNORE is a list of text-properties not to consider. | |
821 | |
822 Return value is a vector of 3 elements: | |
823 1. List of names of the annotations to close | |
824 2. List of the names of annotations to open. | |
825 3. List of properties that were ignored or couldn't be annotated." | |
826 (let* ((prev-loc (1- loc)) | |
827 (before-plist (if all nil (text-properties-at prev-loc))) | |
828 (after-plist (text-properties-at loc)) | |
829 p negatives positives prop props not-found) | |
830 ;; make list of all property names involved | |
831 (setq p before-plist) | |
832 (while p | |
833 (if (not (memq (car p) props)) | |
834 (setq props (cons (car p) props))) | |
835 (setq p (cdr (cdr p)))) | |
836 (setq p after-plist) | |
837 (while p | |
838 (if (not (memq (car p) props)) | |
839 (setq props (cons (car p) props))) | |
840 (setq p (cdr (cdr p)))) | |
841 | |
842 (while props | |
843 (setq prop (car props) | |
844 props (cdr props)) | |
845 (if (memq prop ignore) | |
846 nil ; If it's been ignored before, ignore it now. | |
847 (let ((before (if all nil (car (cdr (memq prop before-plist))))) | |
848 (after (car (cdr (memq prop after-plist))))) | |
849 (if (equal before after) | |
850 nil ; no change; ignore | |
851 (let ((result (format-annotate-single-property-change | |
852 prop before after trans))) | |
853 (if (not result) | |
854 (setq not-found (cons prop not-found)) | |
855 (setq negatives (nconc negatives (car result)) | |
856 positives (nconc positives (cdr result))))))))) | |
857 (vector negatives positives not-found))) | |
858 | |
859 (defun format-annotate-single-property-change (prop old new trans) | |
860 "Return annotations for PROPERTY changing from OLD to NEW. | |
861 These are searched for in the TRANSLATIONS alist. | |
862 If NEW does not appear in the list, but there is a default function, then that | |
863 function is called. | |
864 Annotations to open and to close are returned as a dotted pair." | |
865 (let ((prop-alist (cdr (assoc prop trans))) | |
866 ;; default | |
867 ) | |
868 (if (not prop-alist) | |
869 nil | |
870 ;; If either old or new is a list, have to treat both that way. | |
871 (if (or (consp old) (consp new)) | |
872 (let* ((old (if (listp old) old (list old))) | |
873 (new (if (listp new) new (list new))) | |
874 close open) | |
875 (while old | |
876 (setq close | |
877 (append (car (format-annotate-atomic-property-change | |
878 prop-alist (car old) nil)) | |
879 close) | |
880 old (cdr old))) | |
881 (while new | |
882 (setq open | |
883 (append (cdr (format-annotate-atomic-property-change | |
884 prop-alist nil (car new))) | |
885 open) | |
886 new (cdr new))) | |
5365
dbae25a8949d
Remove redundant functions, format.el, use functions from cl*.el instead.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5270
diff
changeset
|
887 (cons |
dbae25a8949d
Remove redundant functions, format.el, use functions from cl*.el instead.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5270
diff
changeset
|
888 (set-difference close open :stable t) |
dbae25a8949d
Remove redundant functions, format.el, use functions from cl*.el instead.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5270
diff
changeset
|
889 (set-difference open close :stable t))) |
428 | 890 (format-annotate-atomic-property-change prop-alist old new))))) |
891 | |
892 (defun format-annotate-atomic-property-change (prop-alist old new) | |
893 "Internal function annotate a single property change. | |
894 PROP-ALIST is the relevant segment of a TRANSLATIONS list. | |
895 OLD and NEW are the values." | |
896 (let (num-ann) | |
897 ;; If old and new values are numbers, | |
898 ;; look for a number in PROP-ALIST. | |
899 (if (and (or (null old) (numberp old)) | |
900 (or (null new) (numberp new))) | |
901 (progn | |
902 (setq num-ann prop-alist) | |
903 (while (and num-ann (not (numberp (car (car num-ann))))) | |
904 (setq num-ann (cdr num-ann))))) | |
905 (if num-ann | |
906 ;; Numerical annotation - use difference | |
907 (progn | |
908 ;; If property is numeric, nil means 0 | |
909 (cond ((and (numberp old) (null new)) | |
910 (setq new 0)) | |
911 ((and (numberp new) (null old)) | |
912 (setq old 0))) | |
913 | |
914 (let* ((entry (car num-ann)) | |
915 (increment (car entry)) | |
916 (n (ceiling (/ (float (- new old)) (float increment)))) | |
917 (anno (car (cdr entry)))) | |
918 (if (> n 0) | |
919 (cons nil (make-list n anno)) | |
920 (cons (make-list (- n) anno) nil)))) | |
921 | |
922 ;; Standard annotation | |
923 (let ((close (and old (cdr (assoc old prop-alist)))) | |
924 (open (and new (cdr (assoc new prop-alist))))) | |
925 (if (or close open) | |
5365
dbae25a8949d
Remove redundant functions, format.el, use functions from cl*.el instead.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5270
diff
changeset
|
926 (cons |
dbae25a8949d
Remove redundant functions, format.el, use functions from cl*.el instead.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5270
diff
changeset
|
927 (set-difference close open :stable t) |
dbae25a8949d
Remove redundant functions, format.el, use functions from cl*.el instead.
Aidan Kehoe <kehoea@parhasard.net>
parents:
5270
diff
changeset
|
928 (set-difference open close :stable t)) |
428 | 929 ;; Call "Default" function, if any |
930 (let ((default (assq nil prop-alist))) | |
931 (if default | |
932 (funcall (car (cdr default)) old new)))))))) | |
933 | |
934 ;;; format.el ends here |