mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-11-24 07:20:37 +00:00
19532d147b
Escape apostrophes and grave accents in docstrings if they are are supposed to stand for themselves and are not quotes. Remove apostrophes from docstring examples like ‘'(calendar-nth-named-day -1 0 10 year)’ that confuse source code with data. Do some other minor docstring fixups as well, e.g., insert a missing close quote.
146 lines
4.8 KiB
EmacsLisp
146 lines
4.8 KiB
EmacsLisp
;;; iimage.el --- Inline image minor mode.
|
|
|
|
;; Copyright (C) 2004-2015 Free Software Foundation, Inc.
|
|
|
|
;; Author: KOSEKI Yoshinori <kose@meadowy.org>
|
|
;; Maintainer: KOSEKI Yoshinori <kose@meadowy.org>
|
|
;; Keywords: multimedia
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published by
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
;; (at your option) any later version.
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
;; GNU General Public License for more details.
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;; Iimage is a minor mode that displays images, when image-filename
|
|
;; exists in the buffer.
|
|
;;
|
|
;; ** Display images in *Info* buffer.
|
|
;;
|
|
;; (add-hook 'info-mode-hook 'iimage-mode)
|
|
;;
|
|
;; .texinfo: @file{file://foo.png}
|
|
;; .info: `file://foo.png'
|
|
;;
|
|
;; ** Display images in Wiki buffer.
|
|
;;
|
|
;; (add-hook 'wiki-mode-hook 'iimage-mode)
|
|
;;
|
|
;; wiki-file: [[foo.png]]
|
|
|
|
;;; Code:
|
|
|
|
(eval-when-compile
|
|
(require 'image-file))
|
|
|
|
(defgroup iimage nil
|
|
"Support for inline images."
|
|
:version "22.1"
|
|
:group 'image)
|
|
|
|
(defcustom iimage-mode-image-search-path nil
|
|
"List of directories to search for image files for iimage-mode."
|
|
:type '(choice (const nil) (repeat directory))
|
|
:group 'iimage)
|
|
|
|
(defvar iimage-mode-image-filename-regex
|
|
(concat "[-+./_0-9a-zA-Z]+\\."
|
|
(regexp-opt (nconc (mapcar #'upcase
|
|
image-file-name-extensions)
|
|
image-file-name-extensions)
|
|
t)))
|
|
|
|
(defcustom iimage-mode-image-regex-alist
|
|
`((,(concat "\\(`?file://\\|\\[\\[\\|<\\|`\\)?"
|
|
"\\(" iimage-mode-image-filename-regex "\\)"
|
|
"\\(\\]\\]\\|>\\|'\\)?") . 2))
|
|
"Alist of filename REGEXP vs NUM.
|
|
Each element looks like (REGEXP . NUM).
|
|
NUM specifies which parenthesized expression in the regexp.
|
|
|
|
Examples of image filename patterns to match:
|
|
file://foo.png
|
|
\\=`file://foo.png\\='
|
|
\\[\\[foo.gif]]
|
|
<foo.png>
|
|
foo.JPG
|
|
"
|
|
:type '(alist :key-type regexp :value-type integer)
|
|
:group 'iimage)
|
|
|
|
(defvar iimage-mode-map
|
|
(let ((map (make-sparse-keymap)))
|
|
(define-key map "\C-l" 'iimage-recenter)
|
|
map)
|
|
"Keymap used in `iimage-mode'.")
|
|
|
|
(defun iimage-recenter (&optional arg)
|
|
"Re-draw images and recenter."
|
|
(interactive "P")
|
|
(iimage-mode-buffer nil)
|
|
(iimage-mode-buffer t)
|
|
(recenter arg))
|
|
|
|
;;;###autoload
|
|
(define-obsolete-function-alias 'turn-on-iimage-mode 'iimage-mode "24.1")
|
|
|
|
(defun turn-off-iimage-mode ()
|
|
"Unconditionally turn off iimage mode."
|
|
(interactive)
|
|
(iimage-mode 0))
|
|
|
|
(defun iimage-modification-hook (beg end)
|
|
"Remove display property if a display region is modified."
|
|
;;(debug-print "ii1 begin %d, end %d\n" beg end)
|
|
(let ((inhibit-modification-hooks t)
|
|
(beg (previous-single-property-change end 'display
|
|
nil (line-beginning-position)))
|
|
(end (next-single-property-change beg 'display
|
|
nil (line-end-position))))
|
|
(when (and beg end (plist-get (text-properties-at beg) 'display))
|
|
;;(debug-print "ii2 begin %d, end %d\n" beg end)
|
|
(remove-text-properties beg end
|
|
'(display nil modification-hooks nil)))))
|
|
|
|
(defun iimage-mode-buffer (arg)
|
|
"Display images if ARG is non-nil, undisplay them otherwise."
|
|
(let ((image-path (cons default-directory iimage-mode-image-search-path))
|
|
file)
|
|
(with-silent-modifications
|
|
(save-excursion
|
|
(goto-char (point-min))
|
|
(dolist (pair iimage-mode-image-regex-alist)
|
|
(while (re-search-forward (car pair) nil t)
|
|
(when (and (setq file (match-string (cdr pair)))
|
|
(setq file (locate-file file image-path)))
|
|
;; FIXME: we don't mark our images, so we can't reliably
|
|
;; remove them either (we may leave some of ours, and we
|
|
;; may remove other packages's display properties).
|
|
(if arg
|
|
(add-text-properties (match-beginning 0) (match-end 0)
|
|
`(display ,(create-image file)
|
|
modification-hooks
|
|
(iimage-modification-hook)))
|
|
(remove-text-properties (match-beginning 0) (match-end 0)
|
|
'(display modification-hooks))))))))))
|
|
|
|
;;;###autoload
|
|
(define-minor-mode iimage-mode nil
|
|
:group 'iimage :lighter " iImg" :keymap iimage-mode-map
|
|
(iimage-mode-buffer iimage-mode))
|
|
|
|
(provide 'iimage)
|
|
|
|
;;; iimage.el ends here
|