;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; 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, or (at your option)
-;; any later version.
+;; 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
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(require 'image)
+(eval-when-compile (require 'cl))
;;;###autoload (push '("\\.jpe?g\\'" . image-mode) auto-mode-alist)
;;;###autoload (push '("\\.png\\'" . image-mode) auto-mode-alist)
;;;###autoload (push '("\\.svgz?\\'" . xml-mode) auto-mode-alist)
;;;###autoload (push '("\\.svgz?\\'" . image-mode-maybe) auto-mode-alist)
-;;; Image scrolling functions
+;;; Image mode window-info management.
+
+(defvar image-mode-winprops-alist t)
+(make-variable-buffer-local 'image-mode-winprops-alist)
+
+(defvar image-mode-new-window-functions nil
+ "Special hook run when image data is requested in a new window.
+It is called with one argument, the initial WINPROPS.")
+
+(defun image-mode-winprops (&optional window cleanup)
+ "Return winprops of WINDOW.
+A winprops object has the shape (WINDOW . ALIST)."
+ (cond ((null window)
+ (setq window (selected-window)))
+ ((not (windowp window))
+ (error "Not a window: %s" window)))
+ (when cleanup
+ (setq image-mode-winprops-alist
+ (delq nil (mapcar (lambda (winprop)
+ (if (window-live-p (car-safe winprop))
+ winprop))
+ image-mode-winprops-alist))))
+ (let ((winprops (assq window image-mode-winprops-alist)))
+ ;; For new windows, set defaults from the latest.
+ (unless winprops
+ (setq winprops (cons window
+ (copy-alist (cdar image-mode-winprops-alist))))
+ (run-hook-with-args 'image-mode-new-window-functions winprops))
+ ;; Move window to front.
+ (setq image-mode-winprops-alist
+ (cons winprops (delq winprops image-mode-winprops-alist)))
+ winprops))
+
+(defun image-mode-window-get (prop &optional winprops)
+ (unless (consp winprops) (setq winprops (image-mode-winprops winprops)))
+ (cdr (assq prop (cdr winprops))))
+
+(defsetf image-mode-window-get (prop &optional winprops) (val)
+ `(image-mode-window-put ,prop ,val ,winprops))
+
+(defun image-mode-window-put (prop val &optional winprops)
+ (unless (consp winprops) (setq winprops (image-mode-winprops winprops)))
+ (setcdr winprops (cons (cons prop val)
+ (delq (assq prop (cdr winprops)) (cdr winprops)))))
+
+(defun image-set-window-vscroll (vscroll)
+ (setf (image-mode-window-get 'vscroll) vscroll)
+ (set-window-vscroll (selected-window) vscroll))
+
+(defun image-set-window-hscroll (ncol)
+ (setf (image-mode-window-get 'hscroll) ncol)
+ (set-window-hscroll (selected-window) ncol))
+
+(defun image-mode-reapply-winprops ()
+ ;; When set-window-buffer, set hscroll and vscroll to what they were
+ ;; last time the image was displayed in this window.
+ (when (and (image-get-display-property)
+ (listp image-mode-winprops-alist))
+ (let* ((winprops (image-mode-winprops nil t))
+ (hscroll (image-mode-window-get 'hscroll winprops))
+ (vscroll (image-mode-window-get 'vscroll winprops)))
+ (if hscroll (set-window-hscroll (selected-window) hscroll))
+ (if vscroll (set-window-vscroll (selected-window) vscroll)))))
+
+(defun image-mode-setup-winprops ()
+ ;; Record current scroll settings.
+ (unless (listp image-mode-winprops-alist)
+ (setq image-mode-winprops-alist nil))
+ (add-hook 'window-configuration-change-hook
+ 'image-mode-reapply-winprops nil t))
-(defvar image-mode-current-vscroll nil
- "An alist with elements (WINDOW . VSCROLL).")
-(make-variable-buffer-local 'image-mode-current-vscroll)
-
-(defvar image-mode-current-hscroll nil
- "An alist with elements (WINDOW . HSCROLL).")
-(make-variable-buffer-local 'image-mode-current-hscroll)
-
-(defun image-set-window-vscroll (window vscroll &optional pixels-p)
- (setq image-mode-current-vscroll
- (cons (cons window vscroll)
- (delq (assq window image-mode-current-vscroll)
- image-mode-current-vscroll)))
- (set-window-vscroll window vscroll pixels-p))
-
-(defun image-set-window-hscroll (window ncol)
- (setq image-mode-current-hscroll
- (cons (cons window ncol)
- (delq (assq window image-mode-current-hscroll)
- image-mode-current-hscroll)))
- (set-window-hscroll window ncol))
-
-(defun image-reset-current-vhscroll ()
- (walk-windows
- (lambda (win)
- (with-current-buffer (window-buffer win)
- ;; When set-window-buffer, set hscroll and vscroll to what they were
- ;; last time the image was displayed in this window. If it's the first
- ;; time it's displayed in this window, use the most recent setting.
- (when image-mode-current-hscroll
- (set-window-hscroll win (cdr (or (assoc win image-mode-current-hscroll)
- (car image-mode-current-hscroll)))))
- (when image-mode-current-vscroll
- (set-window-vscroll win (cdr (or (assoc win image-mode-current-vscroll)
- (car image-mode-current-vscroll)))))))
- 'nomini
- (selected-frame)))
+;;; Image scrolling functions
(defun image-get-display-property ()
(get-char-property (point-min) 'display
(if (eq (window-buffer) (current-buffer))
(selected-window))))
+(declare-function image-size "image.c" (spec &optional pixels frame))
+
(defun image-forward-hscroll (&optional n)
"Scroll image in current window to the left by N character widths.
Stop if the right edge of the image is reached."
(interactive "p")
(cond ((= n 0) nil)
((< n 0)
- (image-set-window-hscroll (selected-window)
- (max 0 (+ (window-hscroll) n))))
+ (image-set-window-hscroll (max 0 (+ (window-hscroll) n))))
(t
(let* ((image (image-get-display-property))
(edges (window-inside-edges))
(win-width (- (nth 2 edges) (nth 0 edges)))
(img-width (ceiling (car (image-size image)))))
- (image-set-window-hscroll (selected-window)
- (min (max 0 (- img-width win-width))
+ (image-set-window-hscroll (min (max 0 (- img-width win-width))
(+ n (window-hscroll))))))))
(defun image-backward-hscroll (&optional n)
(interactive "p")
(cond ((= n 0) nil)
((< n 0)
- (image-set-window-vscroll (selected-window)
- (max 0 (+ (window-vscroll) n))))
+ (image-set-window-vscroll (max 0 (+ (window-vscroll) n))))
(t
(let* ((image (image-get-display-property))
(edges (window-inside-edges))
(win-height (- (nth 3 edges) (nth 1 edges)))
(img-height (ceiling (cdr (image-size image)))))
- (image-set-window-vscroll (selected-window)
- (min (max 0 (- img-height win-height))
+ (image-set-window-vscroll (min (max 0 (- img-height win-height))
(+ n (window-vscroll))))))))
(defun image-previous-line (&optional n)
(and arg
(/= (setq arg (prefix-numeric-value arg)) 1)
(image-next-line (- arg 1)))
- (image-set-window-hscroll (selected-window) 0))
+ (image-set-window-hscroll 0))
(defun image-eol (arg)
"Scroll horizontally to the right edge of the image in the current window.
(edges (window-inside-edges))
(win-width (- (nth 2 edges) (nth 0 edges)))
(img-width (ceiling (car (image-size image)))))
- (image-set-window-hscroll (selected-window)
- (max 0 (- img-width win-width)))))
+ (image-set-window-hscroll (max 0 (- img-width win-width)))))
(defun image-bob ()
"Scroll to the top-left corner of the image in the current window."
(interactive)
- (image-set-window-hscroll (selected-window) 0)
- (image-set-window-vscroll (selected-window) 0))
+ (image-set-window-hscroll 0)
+ (image-set-window-vscroll 0))
(defun image-eob ()
"Scroll to the bottom-right corner of the image in the current window."
(img-width (ceiling (car (image-size image))))
(win-height (- (nth 3 edges) (nth 1 edges)))
(img-height (ceiling (cdr (image-size image)))))
- (image-set-window-hscroll (selected-window) (max 0 (- img-width win-width)))
- (image-set-window-vscroll (selected-window) (max 0 (- img-height win-height)))))
+ (image-set-window-hscroll (max 0 (- img-width win-width)))
+ (image-set-window-vscroll (max 0 (- img-height win-height)))))
+
+;; Adjust frame and image size.
+
+(defun image-mode-fit-frame ()
+ "Fit the frame to the current image.
+This function assumes the current frame has only one window."
+ ;; FIXME: This does not take into account decorations like mode-line,
+ ;; minibuffer, header-line, ...
+ (interactive)
+ (let* ((saved (frame-parameter nil 'image-mode-saved-size))
+ (display (image-get-display-property))
+ (size (image-size display)))
+ (if (and saved
+ (eq (caar saved) (frame-width))
+ (eq (cdar saved) (frame-height)))
+ (progn ;; Toggle back to previous non-fitted size.
+ (set-frame-parameter nil 'image-mode-saved-size nil)
+ (setq size (cdr saved)))
+ ;; Round up size, and save current size so we can toggle back to it.
+ (setcar size (ceiling (car size)))
+ (setcdr size (ceiling (cdr size)))
+ (set-frame-parameter nil 'image-mode-saved-size
+ (cons size (cons (frame-width) (frame-height)))))
+ (set-frame-width (selected-frame) (car size))
+ (set-frame-height (selected-frame) (cdr size))))
;;; Image Mode setup
(defvar image-mode-map
(let ((map (make-sparse-keymap)))
+ (suppress-keymap map)
+ (define-key map "q" 'quit-window)
(define-key map "\C-c\C-c" 'image-toggle-display)
+ (define-key map (kbd "SPC") 'image-scroll-up)
+ (define-key map (kbd "DEL") 'image-scroll-down)
(define-key map [remap forward-char] 'image-forward-hscroll)
(define-key map [remap backward-char] 'image-backward-hscroll)
(define-key map [remap previous-line] 'image-previous-line)
map)
"Major mode keymap for viewing images as text in Image mode.")
-(defvar bookmark-make-cell-function)
+(defvar bookmark-make-record-function)
;;;###autoload
(defun image-mode ()
(setq mode-name "Image[text]")
(setq major-mode 'image-mode)
;; Use our own bookmarking function for images.
- (set (make-local-variable 'bookmark-make-cell-function)
- 'image-bookmark-make-cell)
+ (set (make-local-variable 'bookmark-make-record-function)
+ 'image-bookmark-make-record)
;; Keep track of [vh]scroll when switching buffers
- (image-set-window-hscroll (selected-window) (window-hscroll))
- (image-set-window-vscroll (selected-window) (window-vscroll))
- (add-hook 'window-configuration-change-hook
- 'image-reset-current-vhscroll nil t)
+ (image-mode-setup-winprops)
(add-hook 'change-major-mode-hook 'image-toggle-display-text nil t)
- (if (and (display-images-p)
- (not (image-get-display-property)))
- (image-toggle-display)
- ;; Set next vars when image is already displayed but local
- ;; variables were cleared by kill-all-local-variables
- (use-local-map image-mode-map)
- (setq cursor-type nil truncate-lines t))
+ (if (display-images-p)
+ (if (not (get-text-property (point-min) 'display))
+ (image-toggle-display)
+ ;; Set next vars when image is already displayed but local
+ ;; variables were cleared by kill-all-local-variables
+ (use-local-map image-mode-map)
+ (setq cursor-type nil truncate-lines t))
+ (use-local-map image-mode-text-map))
(run-mode-hooks 'image-mode-hook)
(if (display-images-p)
(message "%s" (concat
(if (image-get-display-property)
(setq cursor-type nil truncate-lines t)
(setq image-type "text"))
+ (image-mode-setup-winprops)
(add-hook 'change-major-mode-hook (lambda () (image-minor-mode -1)) nil t)
(message "%s" (concat (substitute-command-keys
"Type \\[image-toggle-display] to view the image as ")
(defvar archive-superior-buffer)
(defvar tar-superior-buffer)
+(declare-function image-refresh "image.c" (spec &optional frame))
(defun image-toggle-display ()
"Start or stop displaying an image file as the actual image.
(message "Repeat this command to go back to displaying the file as text")))))
;;; Support for bookmark.el
+(declare-function bookmark-make-record-default "bookmark"
+ (&optional point-only))
+(declare-function bookmark-prop-get "bookmark" (bookmark prop))
+(declare-function bookmark-default-handler "bookmark" (bmk))
-(defun image-bookmark-make-cell (annotation &rest args)
- (let ((the-record
- `((filename . ,(buffer-file-name))
- (image-type . ,image-type)
- (position . ,(point))
- (handler . image-bookmark-jump))))
-
- ;; Take no chances with text properties
- (set-text-properties 0 (length annotation) nil annotation)
-
- (when annotation
- (nconc the-record (list (cons 'annotation annotation))))
+(defun image-bookmark-make-record ()
+ (nconc (bookmark-make-record-default)
+ `((image-type . ,image-type)
+ (handler . image-bookmark-jump))))
- ;; Finally, return the completed record.
- the-record))
-(declare-function bookmark-get-filename "bookmark" (bookmark))
-(declare-function bookmark-get-bookmark-record "bookmark" (bookmark))
-(declare-function bookmark-get-position "bookmark" (bookmark))
;;;###autoload
(defun image-bookmark-jump (bmk)
;; This implements the `handler' function interface for record type
- ;; returned by `bookmark-make-cell-function', which see.
- (save-window-excursion
- (let ((filename (bookmark-get-filename bmk))
- (type (cdr (assq 'image-type (bookmark-get-bookmark-record bmk))))
- (pos (bookmark-get-position bmk)))
- (find-file filename)
- (when (not (string= image-type type))
- (image-toggle-display))
- (when (string= image-type "text")
- (goto-char pos))
- `((buffer ,(current-buffer)) (position ,(point))))))
+ ;; returned by `bookmark-make-record-function', which see.
+ (prog1 (bookmark-default-handler bmk)
+ (when (not (string= image-type (bookmark-prop-get bmk 'image-type)))
+ (image-toggle-display))))
(provide 'image-mode)
HCoop / bpt / emacs.git / blobdiff