Mercurial > emacs
annotate lisp/image-file.el @ 32053:0216f8dcf1d4
(vc-rcs-receive-file): Call comment-history unconditionally. Use the
comments as initial contents of the log entry buffer. Document the
trick to force branch creation with no changes.
author | André Spiegel <spiegel@gnu.org> |
---|---|
date | Sun, 01 Oct 2000 11:17:42 +0000 |
parents | ff2dfe1f1df9 |
children | f7460e78c02a |
rev | line source |
---|---|
31934 | 1 ;;; image-file.el --- Support for visiting image files |
2 ;; | |
3 ;; Copyright (C) 2000 Free Software Foundation, Inc. | |
4 ;; | |
5 ;; Author: Miles Bader <miles@gnu.org> | |
6 ;; Keywords: multimedia | |
7 | |
8 ;; This file is part of GNU Emacs. | |
9 | |
10 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 ;; it 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 ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 ;; GNU General Public License for more details. | |
19 | |
20 ;; You should have received a copy of the GNU General Public License | |
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 ;; Boston, MA 02111-1307, USA. | |
24 | |
25 ;;; Commentary: | |
26 | |
27 ;; Defines a file-name-handler hook that transforms visited (or | |
28 ;; inserted) image files so that they are by displayed as emacs as | |
29 ;; images. This is done by putting a `display' text-property on the | |
30 ;; image data, with the image-data still present underneath; if the | |
31 ;; resulting buffer file is saved to another name it will correctly save | |
32 ;; the image data to the new file. | |
33 | |
34 ;;; Code: | |
35 | |
36 (require 'image) | |
37 | |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
38 |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
39 (defcustom image-file-name-extensions |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
40 '("png" "jpeg" "jpg" "gif" "tiff" "xbm" "xpm") |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
41 "*A list of image-file filename extensions. |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
42 Filenames having one of these extensions are considered image files, |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
43 in addition to those matching `image-file-name-regexps'. |
31934 | 44 |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
45 See `auto-image-file-mode'; if `auto-image-file-mode' is enabled, |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
46 setting this variable directly does not take effect unless |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
47 `auto-image-file-mode' is re-enabled; this happens automatically the |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
48 variable is set using \\[customize]." |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
49 :type '(repeat string) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
50 :set (lambda (sym val) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
51 (set-default sym val) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
52 (when auto-image-file-mode |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
53 ;; Re-initialize the image-file handler |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
54 (auto-image-file-mode t))) |
31934 | 55 :initialize 'custom-initialize-default |
56 :group 'image) | |
57 | |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
58 (defcustom image-file-name-regexps nil |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
59 "*A list of regexps matching image-file filenames. |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
60 Filenames matching one of these regexps are considered image files, |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
61 in addition to those with an extension in `image-file-name-extensions'. |
31934 | 62 |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
63 See `auto-image-file-mode'; if `auto-image-file-mode' is enabled, |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
64 setting this variable directly does not take effect unless |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
65 `auto-image-file-mode' is re-enabled; this happens automatically the |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
66 variable is set using \\[customize]." |
31934 | 67 :type '(repeat regexp) |
68 :set (lambda (sym val) | |
69 (set-default sym val) | |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
70 (when auto-image-file-mode |
31934 | 71 ;; Re-initialize the image-file handler |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
72 (auto-image-file-mode t))) |
31934 | 73 :initialize 'custom-initialize-default |
74 :group 'image) | |
75 | |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
76 |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
77 ;;;###autoload |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
78 (defun image-file-name-regexp () |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
79 "Return a regular expression that matches image-file filenames." |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
80 (let ((exts-regexp |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
81 (and image-file-name-extensions |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
82 (concat "\\." |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
83 (regexp-opt image-file-name-extensions t) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
84 "\\'")))) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
85 (if image-file-name-regexps |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
86 (mapconcat 'identity |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
87 (if exts-regexp |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
88 (cons exts-regexp image-file-regexps) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
89 image-file-regexps) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
90 "\\|") |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
91 exts-regexp))) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
92 |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
93 |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
94 ;;;###autoload |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
95 (define-minor-mode auto-image-file-mode |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
96 "Toggle visiting of image files as images. |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
97 With prefix argument ARG, turn on if positive, otherwise off. |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
98 Returns non-nil if the new state is enabled. |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
99 |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
100 Image files are those whose name has an extension in |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
101 `image-file-name-extensions', or matches a regexp in |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
102 `image-file-name-regexps'." |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
103 nil |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
104 nil |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
105 nil |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
106 :global t |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
107 :group 'image |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
108 ;; Remove existing handler |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
109 (let ((existing-entry |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
110 (rassq 'image-file-handler file-name-handler-alist))) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
111 (when existing-entry |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
112 (setq file-name-handler-alist |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
113 (delq existing-entry file-name-handler-alist)))) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
114 ;; Add new handler, if enabled |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
115 (when auto-image-file-mode |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
116 (push (cons (image-file-name-regexp) 'image-file-handler) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
117 file-name-handler-alist))) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
118 |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
119 |
31934 | 120 ;;;###autoload |
121 (defun insert-image-file (file &optional visit beg end replace) | |
122 "Insert the image file FILE into the current buffer. | |
123 Optional arguments VISIT, BEG, END, and REPLACE are interpreted as for | |
124 the command `insert-file-contents'." | |
125 (let ((rval | |
126 (image-file-call-underlying #'insert-file-contents-literally | |
127 'insert-file-contents | |
128 file visit beg end replace))) | |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
129 ;; Turn the image data into a real image, but only if the whole file |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
130 ;; was inserted |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
131 (when (and (or (null beg) (zerop beg)) (null end)) |
31934 | 132 (let* ((ibeg (point)) |
133 (iend (+ (point) (cadr rval))) | |
134 (data | |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
135 (string-make-unibyte |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
136 (buffer-substring-no-properties ibeg iend))) |
31934 | 137 (image |
138 (create-image data nil t)) | |
139 (props | |
140 `(display ,image | |
141 intangible ,image | |
142 rear-nonsticky (display) | |
143 ;; This a cheap attempt to make the whole buffer | |
144 ;; read-only when we're visiting the file. | |
145 ,@(and visit | |
146 (= ibeg (point-min)) | |
147 (= iend (point-max)) | |
148 '(read-only t front-sticky (read-only)))))) | |
149 (add-text-properties ibeg iend props))) | |
150 rval)) | |
151 | |
152 (defun image-file-handler (operation &rest args) | |
153 "File name handler for inserting image files. | |
154 OPERATION is the operation to perform, on ARGS. | |
155 See `file-name-handler-alist' for details." | |
32003
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
156 (if (and (eq operation 'insert-file-contents) |
ff2dfe1f1df9
(image-file-name-extensions): New variable.
Miles Bader <miles@gnu.org>
parents:
31934
diff
changeset
|
157 auto-image-file-mode) |
31934 | 158 (apply #'insert-image-file args) |
159 ;; We don't handle OPERATION, use another handler or the default | |
160 (apply #'image-file-call-underlying operation operation args))) | |
161 | |
162 (defun image-file-call-underlying (function operation &rest args) | |
163 "Call FUNCTION with `image-file-handler' and OPERATION inhibited. | |
164 Optional argument ARGS are the arguments to call FUNCTION with." | |
165 (let ((inhibit-file-name-handlers | |
166 (cons 'image-file-handler | |
167 (and (eq inhibit-file-name-operation operation) | |
168 inhibit-file-name-handlers))) | |
169 (inhibit-file-name-operation operation)) | |
170 (apply function args))) | |
171 | |
172 | |
173 (provide 'image-file) | |
174 | |
175 ;;; image-file.el ends here |