annotate lisp/iimage.el @ 55731:856dacc3ac48

Maintained by FSF.
author Richard M. Stallman <rms@gnu.org>
date Sat, 22 May 2004 21:52:34 +0000
parents c9cc17f13ff4
children 401149ed59c0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
55525
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
1 ;;; iimage.el --- Inline image minor mode.
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
2
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
3 ;; Copyright (C) 2004 Free Software Foundation
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
4
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
5 ;; Author: KOSEKI Yoshinori <kose@meadowy.org>
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
6 ;; Maintainer: KOSEKI Yoshinori <kose@meadowy.org>
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
7 ;; Keywords: multimedia
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
8
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
9 ;; This file is part of GNU Emacs.
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
10
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
12 ;; it under the terms of the GNU General Public License as published by
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
13 ;; the Free Software Foundation; either version 2, or (at your option)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
14 ;; any later version.
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
15
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
16 ;; GNU Emacs is distributed in the hope that it will be useful,
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
19 ;; GNU General Public License for more details.
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
20
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
21 ;; You should have received a copy of the GNU General Public License
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
24 ;; Boston, MA 02111-1307, USA.
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
25
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
26 ;;; Commentary:
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
27
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
28 ;; Iimage is a minor mode that display a images, when image-filename
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
29 ;; exists in buffer.
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
30 ;; http://www.netlaputa.ne.jp/~kose/Emacs/iimage.html
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
31 ;;
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
32 ;; Add to your `~/.emacs':
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
33 ;; (autoload 'iimage-mode "iimage" "SUpport Inline image minor mode." t)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
34 ;;
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
35 ;; ** Display images in *Info* buffer.
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
36 ;;
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
37 ;; (add-hook 'info-mode-hook 'turn-on-iimage-mode)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
38 ;;
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
39 ;; .texinfo: @file{file://foo.png}
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
40 ;; .info: `file://foo.png'
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
41 ;;
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
42 ;; ** Display images in Wiki buffer.
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
43 ;;
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
44 ;; (add-hook 'wiki-mode-hook 'turn-on-iimage-mode)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
45 ;;
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
46 ;; wiki-file: [[foo.png]]
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
47
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
48 ;;; Code:
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
49
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
50 (eval-when-compile
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
51 (require 'image-file))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
52
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
53 (defconst iimage-version "1.0")
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
54 (defvar iimage-mode nil)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
55 (defvar iimage-mode-map nil)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
56
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
57 ;; Set up key map.
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
58 (unless iimage-mode-map
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
59 (setq iimage-mode-map (make-sparse-keymap))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
60 (define-key iimage-mode-map "\C-l" 'iimage-recenter))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
61
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
62 (defun iimage-recenter (&optional arg)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
63 "Re-draw images and recenter."
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
64 (interactive "P")
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
65 (iimage-mode-buffer 0)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
66 (iimage-mode-buffer 1)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
67 (recenter arg))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
68
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
69 (defvar iimage-mode-image-filename-regex
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
70 (concat "[-+./_0-9a-zA-Z]+\\."
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
71 (regexp-opt (nconc (mapcar #'upcase
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
72 image-file-name-extensions)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
73 image-file-name-extensions)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
74 t)))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
75
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
76 (defvar iimage-mode-image-regex-alist
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
77 `((,(concat "\\(`?file://\\|\\[\\[\\|<\\|`\\)?"
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
78 "\\(" iimage-mode-image-filename-regex "\\)"
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
79 "\\(\\]\\]\\|>\\|'\\)?") . 2))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
80 "*Alist of filename REGEXP vs NUM.
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
81 Each element looks like (REGEXP . NUM).
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
82 NUM specifies which parenthesized expression in the regexp.
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
83
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
84 image filename regex exsamples:
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
85 file://foo.png
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
86 `file://foo.png'
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
87 \\[\\[foo.gif]]
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
88 <foo.png>
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
89 foo.JPG
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
90 ")
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
91
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
92 (defun turn-on-iimage-mode ()
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
93 "Unconditionally turn on iimage mode."
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
94 (interactive)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
95 (iimage-mode 1))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
96
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
97 (defun turn-off-iimage-mode ()
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
98 "Unconditionally turn off iimage mode."
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
99 (interactive)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
100 (iimage-mode 0))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
101
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
102 (defun iimage-mode-buffer (arg)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
103 "Display/Undisplay Images.
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
104 With numeric ARG, display the images if and only if ARG is positive."
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
105 (interactive)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
106 (let ((ing (if (numberp arg)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
107 (> arg 0)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
108 iimage-mode))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
109 (modp (buffer-modified-p (current-buffer)))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
110 file buffer-read-only)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
111 (save-excursion
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
112 (goto-char (point-min))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
113 (dolist (pair iimage-mode-image-regex-alist)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
114 (while (re-search-forward (car pair) nil t)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
115 (if (and (setq file (match-string (cdr pair)))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
116 (setq file (expand-file-name file default-directory))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
117 (file-exists-p file))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
118 (if ing
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
119 (add-text-properties (match-beginning 0) (match-end 0)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
120 (list 'display (create-image file)))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
121 (remove-text-properties (match-beginning 0) (match-end 0)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
122 '(display)))))))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
123 (set-buffer-modified-p modp)))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
124
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
125 (define-minor-mode iimage-mode
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
126 "Toggle inline image minor mode."
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
127 nil " iImg" iimage-mode-map
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
128 (run-hooks 'iimage-mode-hook)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
129 (iimage-mode-buffer iimage-mode))
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
130
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
131 (provide 'iimage)
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
132
55532
c9cc17f13ff4 Changes from arch/CVS synchronization
Miles Bader <miles@gnu.org>
parents: 55525
diff changeset
133 ;;; arch-tag: f6f8e29a-08f6-4a12-9496-51e67441ce65
55525
fd93f77c8cc4 New file.
Eli Zaretskii <eliz@gnu.org>
parents:
diff changeset
134 ;;; iimage.el ends here