lisp/view.el

   1 ;;; view.el --- peruse file or buffer without editing
   2
   3 ;; Copyright (C) 1985, 1989, 1994, 1995, 1997, 2000, 2001
   4 ;;   Free Software Foundation, Inc.
   5
   6 ;; Author: K. Shane Hartman
   7 ;; Maintainer: Inge Frick <inge@nada.kth.se>
   8 ;; Keywords: files
   9
  10 ;; This file is part of GNU Emacs.
  11
  12 ;; GNU Emacs is free software; you can redistribute it and/or modify
  13 ;; it under the terms of the GNU General Public License as published by
  14 ;; the Free Software Foundation; either version 2, or (at your option)
  15 ;; any later version.
  16
  17 ;; GNU Emacs is distributed in the hope that it will be useful,
  18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 ;; GNU General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  25 ;; Boston, MA 02111-1307, USA.
  26
  27 ;;; Commentary:
  28
  29 ;; This package provides the `view' minor mode documented in the Emacs
  30 ;; user's manual.
  31 ;; View mode entry and exit is done through the functions view-mode-enter
  32 ;; and view-mode-exit.  Use these functions to enter or exit view-mode from
  33 ;; emacs lisp programs.
  34 ;; We use both view- and View- as prefix for symbols.  View- is used as
  35 ;; prefix for commands that have a key binding.  view- is used for commands
  36 ;; without key binding.  The purpose of this is to make it easier for a
  37 ;; user to use command name completion.
  38
  39 ;;; Suggested key bindings:
  40 ;;
  41 ;; (define-key ctl-x-4-map "v" 'view-file-other-window)  ; ^x4v
  42 ;; (define-key ctl-x-5-map "v" 'view-file-other-frame)  ; ^x5v
  43 ;;
  44 ;; You could also bind view-file, view-buffer, view-buffer-other-window and
  45 ;; view-buffer-other-frame to keys.
  46
  47 ;;; Code:
  48
  49 (defgroup view nil
  50   "Peruse file or buffer without editing."
  51   :link '(function-link view-mode)
  52   :link '(custom-manual "(emacs)Misc File Ops")
  53   :group 'wp
  54   :group 'editing)
  55
  56 (defcustom view-read-only nil
  57   "*Non-nil means buffers visiting files read-only, do it in view mode."
  58   :type 'boolean
  59   :group 'view)
  60
  61 (defcustom view-highlight-face 'highlight
  62    "*The face used for highlighting the match found by View mode search."
  63    :type 'face
  64    :group 'view)
  65
  66 ;; `view-mode-auto-exit' is replaced by the following option variable which
  67 ;; only says if scrolling past buffer end should leave view mode or not, it
  68 ;; doesn't say if leaving view mode should restore windows or not.  The latter
  69 ;; is now controlled by the presence of a value in `view-return-to-alist'.
  70 (defcustom view-scroll-auto-exit nil
  71   "*Non-nil means scrolling past the end of buffer exits View mode.
  72 nil means attempting to scroll past the end of the buffer,
  73 only rings the bell and gives a message on how to leave."
  74   :type 'boolean
  75   :group 'view)
  76
  77 (defcustom view-try-extend-at-buffer-end nil
  78  "*Non-nil means try load more of file when reaching end of buffer.
  79 This variable is mainly intended to be temporarily set to non-nil by
  80 the F command in view-mode, but you can set it to t if you want the action
  81 for all scroll commands in view mode."
  82   :type 'boolean
  83   :group 'view)
  84
  85 (defcustom view-remove-frame-by-deleting nil
  86   "*Determine how View mode removes a frame no longer needed.
  87 If nil, make an icon of the frame.  If non-nil, delete the frame."
  88   :type 'boolean
  89   :group 'view)
  90
  91 (defcustom view-exits-all-viewing-windows nil
  92   "*Non-nil means restore all windows used to view buffer.
  93 Commands that restore windows when finished viewing a buffer, apply to all
  94 windows that display the buffer and have restore information in
  95 `view-return-to-alist'.
  96 If `view-exits-all-viewing-windows' is nil, only the selected window is
  97 considered for restoring."
  98   :type 'boolean
  99   :group 'view)
 100
 101 ;;;###autoload
 102 (defvar view-mode nil
 103   "Non-nil if View mode is enabled.
 104 Don't change this variable directly, you must change it by one of the
 105 functions that enable or disable view mode.")
 106 ;;;###autoload
 107 (make-variable-buffer-local 'view-mode)
 108
 109 (defcustom view-mode-hook nil
 110   "Normal hook run when starting to view a buffer or file."
 111   :type 'hook
 112   :group 'view)
 113
 114 (defvar view-old-buffer-read-only nil)
 115 (make-variable-buffer-local 'view-old-buffer-read-only)
 116
 117 (defvar view-old-Helper-return-blurb)
 118 (make-variable-buffer-local 'view-old-Helper-return-blurb)
 119
 120 (defvar view-page-size nil
 121   "Default number of lines to scroll by View page commands.
 122 If nil then the local value of this is initially set to window size.")
 123 (make-variable-buffer-local 'view-page-size)
 124
 125 (defvar view-half-page-size nil
 126   "Default number of lines to scroll by View half page commands.
 127 If nil then the local value of this is initially set to half window size.")
 128 (make-variable-buffer-local 'view-half-page-size)
 129
 130 (defvar view-last-regexp nil)
 131 (make-variable-buffer-local 'view-last-regexp) ; Global is better???
 132
 133 (defvar view-return-to-alist nil
 134   "What to do with used windows and where to go when finished viewing buffer.
 135 This is local in each buffer being viewed.
 136 It is added to by `view-mode-enter' when starting to view a buffer and
 137 subtracted from by `view-mode-exit' when finished viewing the buffer.
 138
 139 See RETURN-TO-ALIST argument of function `view-mode-exit' for the format of
 140 `view-return-to-alist'.")
 141 (make-variable-buffer-local 'view-return-to-alist)
 142
 143 (defvar view-exit-action nil
 144   "nil or a function with one argument (a buffer) called when finished viewing.
 145 This is local in each buffer being viewed.
 146 The \\[view-file] and \\[view-file-other-window] commands may set this to
 147 `kill-buffer'.")
 148 (make-variable-buffer-local 'view-exit-action)
 149
 150 (defvar view-no-disable-on-exit nil
 151   "If non-nil, View mode \"exit\" commands don't actually disable View mode.
 152 Instead, these commands just switch buffers or windows.
 153 This is set in certain buffers by specialized features such as help commands
 154 that use View mode automatically.")
 155
 156 (defvar view-overlay nil
 157   "Overlay used to display where a search operation found its match.
 158 This is local in each buffer, once it is used.")
 159 (make-variable-buffer-local 'view-overlay)
 160
 161 (unless (assq 'view-mode minor-mode-alist)
 162   (setq minor-mode-alist
 163         (cons (list 'view-mode
 164                     (propertize " View"
 165                                 'local-map mode-line-minor-mode-keymap
 166                                 'help-echo "mouse-3: minor mode menu"))
 167               minor-mode-alist)))
 168
 169 ;; Define keymap inside defvar to make it easier to load changes.
 170 ;; Some redundant "less"-like key bindings below have been commented out.
 171 (defvar view-mode-map
 172   (let ((map (make-sparse-keymap)))
 173     (define-key map "C" 'View-kill-and-leave)
 174     (define-key map "c" 'View-leave)
 175     (define-key map "Q" 'View-quit-all)
 176     (define-key map "E" 'View-exit-and-edit)
 177 ;    (define-key map "v" 'View-exit)
 178     (define-key map "e" 'View-exit)
 179     (define-key map "q" 'View-quit)
 180 ;    (define-key map "N" 'View-search-last-regexp-backward)
 181     (define-key map "p" 'View-search-last-regexp-backward)
 182     (define-key map "n" 'View-search-last-regexp-forward)
 183 ;    (define-key map "?" 'View-search-regexp-backward) ; Less does this.
 184     (define-key map "\\" 'View-search-regexp-backward)
 185     (define-key map "/" 'View-search-regexp-forward)
 186     (define-key map "r" 'isearch-backward)
 187     (define-key map "s" 'isearch-forward)
 188     (define-key map "m" 'point-to-register)
 189     (define-key map "'" 'register-to-point)
 190     (define-key map "x" 'exchange-point-and-mark)
 191     (define-key map "@" 'View-back-to-mark)
 192     (define-key map "." 'set-mark-command)
 193     (define-key map "%" 'View-goto-percent)
 194 ;    (define-key map "G" 'View-goto-line-last)
 195     (define-key map "g" 'View-goto-line)
 196     (define-key map "=" 'what-line)
 197     (define-key map "F" 'View-revert-buffer-scroll-page-forward)
 198 ;    (define-key map "k" 'View-scroll-line-backward)
 199     (define-key map "y" 'View-scroll-line-backward)
 200 ;    (define-key map "j" 'View-scroll-line-forward)
 201     (define-key map "\n" 'View-scroll-line-forward)
 202     (define-key map "\r" 'View-scroll-line-forward)
 203     (define-key map "u" 'View-scroll-half-page-backward)
 204     (define-key map "d" 'View-scroll-half-page-forward)
 205     (define-key map "z" 'View-scroll-page-forward-set-page-size)
 206     (define-key map "w" 'View-scroll-page-backward-set-page-size)
 207 ;    (define-key map "b" 'View-scroll-page-backward)
 208     (define-key map "\C-?" 'View-scroll-page-backward)
 209 ;    (define-key map "f" 'View-scroll-page-forward)
 210     (define-key map " " 'View-scroll-page-forward)
 211     (define-key map "o" 'View-scroll-to-buffer-end)
 212     (define-key map ">" 'end-of-buffer)
 213     (define-key map "<" 'beginning-of-buffer)
 214     (define-key map "-" 'negative-argument)
 215     (define-key map "9" 'digit-argument)
 216     (define-key map "8" 'digit-argument)
 217     (define-key map "7" 'digit-argument)
 218     (define-key map "6" 'digit-argument)
 219     (define-key map "5" 'digit-argument)
 220     (define-key map "4" 'digit-argument)
 221     (define-key map "3" 'digit-argument)
 222     (define-key map "2" 'digit-argument)
 223     (define-key map "1" 'digit-argument)
 224     (define-key map "0" 'digit-argument)
 225     (define-key map "H" 'describe-mode)
 226     (define-key map "?" 'describe-mode) ; Maybe do as less instead? See above.
 227     (define-key map "h" 'describe-mode)
 228     map))
 229
 230 (or (assq 'view-mode minor-mode-map-alist)
 231     (setq minor-mode-map-alist
 232           (cons (cons 'view-mode view-mode-map) minor-mode-map-alist)))
 233
 234 ;;; Commands that enter or exit view mode.
 235
 236 ;;;###autoload
 237 (defun view-file (file)
 238   "View FILE in View mode, returning to previous buffer when done.
 239 Emacs commands editing the buffer contents are not available; instead,
 240 a special set of commands (mostly letters and punctuation)
 241 are defined for moving around in the buffer.
 242 Space scrolls forward, Delete scrolls backward.
 243 For list of all View commands, type H or h while viewing.
 244
 245 This command runs the normal hook `view-mode-hook'."
 246   (interactive "fView file: ")
 247   (let ((had-a-buf (get-file-buffer file)))
 248     (view-buffer (find-file-noselect file)
 249                  (and (not had-a-buf) 'kill-buffer))))
 250
 251 ;;;###autoload
 252 (defun view-file-other-window (file)
 253   "View FILE in View mode in another window.
 254 Return that window to its previous buffer when done.
 255 Emacs commands editing the buffer contents are not available; instead,
 256 a special set of commands (mostly letters and punctuation)
 257 are defined for moving around in the buffer.
 258 Space scrolls forward, Delete scrolls backward.
 259 For list of all View commands, type H or h while viewing.
 260
 261 This command runs the normal hook `view-mode-hook'."
 262   (interactive "fIn other window view file: ")
 263   (let ((had-a-buf (get-file-buffer file)))
 264     (view-buffer-other-window (find-file-noselect file) nil
 265                               (and (not had-a-buf) 'kill-buffer))))
 266
 267 ;;;###autoload
 268 (defun view-file-other-frame (file)
 269   "View FILE in View mode in another frame.
 270 Maybe delete other frame and/or return to previous buffer when done.
 271 Emacs commands editing the buffer contents are not available; instead,
 272 a special set of commands (mostly letters and punctuation)
 273 are defined for moving around in the buffer.
 274 Space scrolls forward, Delete scrolls backward.
 275 For list of all View commands, type H or h while viewing.
 276
 277 This command runs the normal hook `view-mode-hook'."
 278   (interactive "fIn other frame view file: ")
 279   (let ((had-a-buf (get-file-buffer file)))
 280     (view-buffer-other-frame (find-file-noselect file) nil
 281                              (and (not had-a-buf) 'kill-buffer))))
 282
 283
 284 ;;;###autoload
 285 (defun view-buffer (buffer &optional exit-action)
 286   "View BUFFER in View mode, returning to previous buffer when done.
 287 Emacs commands editing the buffer contents are not available; instead,
 288 a special set of commands (mostly letters and punctuation)
 289 are defined for moving around in the buffer.
 290 Space scrolls forward, Delete scrolls backward.
 291 For list of all View commands, type H or h while viewing.
 292
 293 This command runs the normal hook `view-mode-hook'.
 294
 295 Optional argument EXIT-ACTION is either nil or a function with buffer as
 296 argument.  This function is called when finished viewing buffer.
 297 Use this argument instead of explicitly setting `view-exit-action'."
 298
 299   (interactive "bView buffer: ")
 300   (let ((undo-window (list (window-buffer) (window-start) (window-point))))
 301     (switch-to-buffer buffer)
 302     (view-mode-enter (cons (selected-window) (cons nil undo-window))
 303                      exit-action)))
 304
 305 ;;;###autoload
 306 (defun view-buffer-other-window (buffer &optional not-return exit-action)
 307   "View BUFFER in View mode in another window.
 308 Return to previous buffer when done, unless optional NOT-RETURN is non-nil.
 309 Emacs commands editing the buffer contents are not available; instead,
 310 a special set of commands (mostly letters and punctuation)
 311 are defined for moving around in the buffer.
 312 Space scrolls forward, Delete scrolls backward.
 313 For list of all View commands, type H or h while viewing.
 314
 315 This command runs the normal hook `view-mode-hook'.
 316
 317 Optional argument EXIT-ACTION is either nil or a function with buffer as
 318 argument.  This function is called when finished viewing buffer.
 319 Use this argument instead of explicitly setting `view-exit-action'."
 320   (interactive "bIn other window view buffer:\nP")
 321   (let* ((win                           ; This window will be selected by
 322           (get-lru-window))             ; switch-to-buffer-other-window below.
 323          (return-to
 324           (and (not not-return)
 325                (cons (selected-window)
 326                      (if (eq win (selected-window))
 327                          t                      ; Has to make new window.
 328                        (list
 329                         (window-buffer win)     ; Other windows old buffer.
 330                         (window-start win)
 331                         (window-point win)))))))
 332     (switch-to-buffer-other-window buffer)
 333     (view-mode-enter (and return-to (cons (selected-window) return-to))
 334                      exit-action)))
 335
 336 ;;;###autoload
 337 (defun view-buffer-other-frame (buffer &optional not-return exit-action)
 338   "View BUFFER in View mode in another frame.
 339 Return to previous buffer when done, unless optional NOT-RETURN is non-nil.
 340 Emacs commands editing the buffer contents are not available; instead,
 341 a special set of commands (mostly letters and punctuation)
 342 are defined for moving around in the buffer.
 343 Space scrolls forward, Delete scrolls backward.
 344 For list of all View commands, type H or h while viewing.
 345
 346 This command runs the normal hook `view-mode-hook'.
 347
 348 Optional argument EXIT-ACTION is either nil or a function with buffer as
 349 argument.  This function is called when finished viewing buffer.
 350 Use this argument instead of explicitly setting `view-exit-action'."
 351   (interactive "bView buffer in other frame: \nP")
 352   (let ((return-to
 353          (and (not not-return) (cons (selected-window) t)))) ; Old window.
 354     (switch-to-buffer-other-frame buffer)
 355     (view-mode-enter (and return-to (cons (selected-window) return-to))
 356                      exit-action)))
 357
 358 ;;;###autoload
 359 (defun view-mode (&optional arg)
 360   ;; In the following documentation string we have to use some explicit key
 361   ;; bindings instead of using the \\[] construction.  The reason for this
 362   ;; is that most commands have more than one key binding.
 363   "Toggle View mode, a minor mode for viewing text but not editing it.
 364 With ARG, turn View mode on iff ARG is positive.
 365
 366 Emacs commands that do not change the buffer contents are available as usual.
 367 Kill commands insert text in kill buffers but do not delete.  Other commands
 368 \(among them most letters and punctuation) beep and tell that the buffer is
 369 read-only.
 370 \\<view-mode-map>
 371 The following additional commands are provided.  Most commands take prefix
 372 arguments.  Page commands default to \"page size\" lines which is almost a whole
 373 window full, or number of lines set by \\[View-scroll-page-forward-set-page-size] or \\[View-scroll-page-backward-set-page-size].  Half page commands default to
 374 and set \"half page size\" lines which initially is half a window full.  Search
 375 commands default to a repeat count of one.
 376
 377 H, h, ?  This message.
 378 Digits  provide prefix arguments.
 379 \\[negative-argument]   negative prefix argument.
 380 \\[beginning-of-buffer] move to the beginning of buffer.
 381 >       move to the end of buffer.
 382 \\[View-scroll-to-buffer-end]   scroll so that buffer end is at last line of window.
 383 SPC     scroll forward \"page size\" lines.
 384           With prefix scroll forward prefix lines.
 385 DEL     scroll backward \"page size\" lines.
 386           With prefix scroll backward prefix lines.
 387 \\[View-scroll-page-forward-set-page-size]      like  \\[View-scroll-page-forward]  but with prefix sets \"page size\" to prefix.
 388 \\[View-scroll-page-backward-set-page-size]     like  \\[View-scroll-page-backward]  but with prefix sets \"page size\" to prefix.
 389 \\[View-scroll-half-page-forward]       scroll forward \"half page size\" lines.  With prefix, sets
 390           \"half page size\" to prefix lines and scrolls forward that much.
 391 \\[View-scroll-half-page-backward]      scroll backward \"half page size\" lines.  With prefix, sets
 392           \"half page size\" to prefix lines and scrolls backward that much.
 393 RET, LFD  scroll forward one line.  With prefix scroll forward prefix line(s).
 394 y       scroll backward one line.  With prefix scroll backward prefix line(s).
 395 \\[View-revert-buffer-scroll-page-forward]      revert-buffer if necessary and scroll forward.
 396           Use this to view a changing file.
 397 \\[what-line]   prints the current line number.
 398 \\[View-goto-percent]   goes prefix argument (default 100) percent into buffer.
 399 \\[View-goto-line]      goes to line given by prefix argument (default first line).
 400 .       set the mark.
 401 x       exchanges point and mark.
 402 \\[View-back-to-mark]   return to mark and pops mark ring.
 403           Mark ring is pushed at start of every successful search and when
 404           jump to line occurs.  The mark is set on jump to buffer start or end.
 405 \\[point-to-register]   save current position in character register.
 406 '       go to position saved in character register.
 407 s       do forward incremental search.
 408 r       do reverse incremental search.
 409 \\[View-search-regexp-forward]  searches forward for regular expression, starting after current page.
 410           ! and @ have a special meaning at the beginning of the regexp.
 411           ! means search for a line with no match for regexp.  @ means start
 412           search at beginning (end for backward search) of buffer.
 413 \\      searches backward for regular expression, starting before current page.
 414 \\[View-search-last-regexp-forward]     searches forward for last regular expression.
 415 p       searches backward for last regular expression.
 416 \\[View-quit]   quit View mode, restoring this window and buffer to previous state.
 417           \\[View-quit] is the normal way to leave view mode.
 418 \\[View-exit]   exit View mode but stay in current buffer.  Use this if you started
 419           viewing a buffer (file) and find out you want to edit it.
 420           This command restores the previous read-only status of the buffer.
 421 \\[View-exit-and-edit]  exit View mode, and make the current buffer editable
 422           even if it was not editable before entry to View mode.
 423 \\[View-quit-all]       quit View mode, restoring all windows to previous state.
 424 \\[View-leave]  quit View mode and maybe switch buffers, but don't kill this buffer.
 425 \\[View-kill-and-leave] quit View mode, kill current buffer and go back to other buffer.
 426
 427 The effect of \\[View-leave] , \\[View-quit] and \\[View-kill-and-leave] depends on how view-mode was entered.  If it was
 428 entered by view-file, view-file-other-window or view-file-other-frame
 429 \(\\[view-file], \\[view-file-other-window], \\[view-file-other-frame] or the dired mode v command), then \\[View-quit] will
 430 try to kill the current buffer.  If view-mode was entered from another buffer
 431 as is done by View-buffer, View-buffer-other-window, View-buffer-other frame,
 432 View-file, View-file-other-window or View-file-other-frame then \\[View-leave] , \\[View-quit] and \\[View-kill-and-leave]
 433 will return to that buffer.
 434
 435 Entry to view-mode runs the normal hook `view-mode-hook'."
 436   (interactive "P")
 437   (unless (and arg                      ; Do nothing if already OK.
 438                (if (> (prefix-numeric-value arg) 0) view-mode (not view-mode)))
 439     (if view-mode (view-mode-disable)
 440       (view-mode-enable))))
 441
 442 (defun view-mode-enable ()
 443   "Turn on View mode."
 444   ;; Always leave view mode before changing major mode.
 445   ;; This is to guarantee that the buffer-read-only variable is restored.
 446   (add-hook 'change-major-mode-hook 'view-mode-disable nil t)
 447   (setq view-mode t
 448         view-page-size (view-page-size-default view-page-size)
 449         view-half-page-size (or view-half-page-size (/ (view-window-size) 2))
 450         view-old-buffer-read-only buffer-read-only
 451         buffer-read-only t
 452         view-old-Helper-return-blurb (and (boundp 'Helper-return-blurb)
 453                                           Helper-return-blurb)
 454         Helper-return-blurb
 455         (format "continue viewing %s"
 456                 (if (buffer-file-name)
 457                     (file-name-nondirectory (buffer-file-name))
 458                   (buffer-name))))
 459   (force-mode-line-update)
 460   (run-hooks 'view-mode-hook))
 461
 462 (defun view-mode-disable ()
 463   "Turn off View mode."
 464   (remove-hook 'change-major-mode-hook 'view-mode-disable t)
 465   (and view-overlay (delete-overlay view-overlay))
 466   (force-mode-line-update)
 467   ;; Calling toggle-read-only while View mode is enabled
 468   ;; sets view-read-only to t as a buffer-local variable
 469   ;; after exiting View mode.  That arranges that the next toggle-read-only
 470   ;; will reenable View mode.
 471   ;; Cancelling View mode in any other way should cancel that, too,
 472   ;; so that View mode stays off if toggle-read-only is called.
 473   (if (local-variable-p 'view-read-only)
 474       (kill-local-variable 'view-read-only))
 475   (setq view-mode nil
 476         Helper-return-blurb view-old-Helper-return-blurb)
 477   (if buffer-read-only
 478       (setq buffer-read-only view-old-buffer-read-only)))
 479
 480 ;;;###autoload
 481 (defun view-mode-enter (&optional return-to exit-action) "\
 482 Enter View mode and set up exit from view mode depending on optional arguments.
 483 If RETURN-TO is non-nil it is added as an element to the buffer local alist
 484 `view-return-to-alist'.
 485 Save EXIT-ACTION in buffer local variable `view-exit-action'.
 486 It should be either nil or a function that takes a buffer as argument.
 487 This function will be called by `view-mode-exit'.
 488
 489 RETURN-TO is either nil, meaning do nothing when exiting view mode, or
 490 it has the format (WINDOW OLD-WINDOW . OLD-BUF-INFO).
 491 WINDOW is a window used for viewing.
 492 OLD-WINDOW is nil or the window to select after viewing.
 493 OLD-BUF-INFO tells what to do with WINDOW when exiting.  It is one of:
 494 1) nil       Do nothing.
 495 2) t         Delete WINDOW or, if it is the only window, its frame.
 496 3) (OLD-BUFF START POINT)  Display buffer OLD-BUFF with displayed text
 497                            starting at START and point at POINT in WINDOW.
 498 4) quit-window   Do `quit-window' in WINDOW.
 499
 500 For list of all View commands, type H or h while viewing.
 501
 502 This function runs the normal hook `view-mode-hook'."
 503   (if return-to
 504       (let ((entry (assq (car return-to) view-return-to-alist)))
 505         (if entry (setcdr entry (cdr return-to))
 506           (setq view-return-to-alist (cons return-to view-return-to-alist)))))
 507   (if exit-action (setq view-exit-action exit-action))
 508   (unless view-mode                     ; Do nothing if already in view mode.
 509     (view-mode-enable)
 510     (force-mode-line-update)
 511     (message "%s"
 512              (substitute-command-keys "\
 513 View mode: type \\[help-command] for help, \\[describe-mode] for commands, \\[View-quit] to quit."))))
 514
 515 (defun view-mode-exit (&optional return-to-alist exit-action all-win)
 516   "Exit View mode in various ways, depending on optional arguments.
 517 RETURN-TO-ALIST, EXIT-ACTION and ALL-WIN determine what to do after exit.
 518 EXIT-ACTION is nil or a function that is called with current buffer as
 519 argument.
 520 RETURN-TO-ALIST is an alist that for some of the windows displaying the
 521 current buffer, associate information on what to do with those windows.
 522 If ALL-WIN or the variable `view-exits-all-viewing-windows' is non-nil,
 523 then all windows on RETURN-TO-ALIST are restored to their old state.
 524 Otherwise only the selected window is affected (if it is on RETURN-TO-ALIST).
 525
 526 Elements of RETURN-TO-ALIST have the format (WINDOW OLD-WINDOW . OLD-BUF-INFO).
 527 WINDOW is a window displaying the current buffer.
 528 OLD-WINDOW is nil or a window to select after viewing.
 529 OLD-BUF-INFO is information on what to do with WINDOW and is one of:
 530 1) nil       Do nothing.
 531 2) t         Delete WINDOW and, if it is the only window, its frame.
 532 3) (OLD-BUF START POINT)  Display buffer OLD-BUF with displayed text
 533                           starting at START and point at POINT in WINDOW.
 534 4) quit-window   Do `quit-window' in WINDOW.
 535
 536 If one of the WINDOW in RETURN-TO-ALIST is the selected window and the
 537 corresponding OLD-WINDOW is a live window, then select OLD-WINDOW."
 538   (setq all-win
 539         (and return-to-alist (or all-win view-exits-all-viewing-windows)))
 540   (if view-mode         ; Only do something if in view mode.
 541       (let* ((buffer (current-buffer))
 542              window notlost
 543              (sel-old (assq (selected-window) return-to-alist))
 544              (alist (cond
 545                      (all-win           ; Try to restore all windows.
 546                       (append return-to-alist nil)) ; Copy.
 547                      (sel-old           ; Only selected window.
 548                       (list sel-old))))
 549              (old-window (if sel-old (car (cdr sel-old)))))
 550         (if all-win                     ; Follow chains of old-windows.
 551             (let ((c (length alist)) a)
 552               (while (and (> c 0)       ; Safety if mutually refering windows.
 553                           (or (not (window-live-p old-window))
 554                               (eq buffer (window-buffer old-window)))
 555                           (setq a (assq old-window alist)))
 556                 (setq c (1- c))
 557                 (setq old-window (car (cdr a))))
 558               (if (or (zerop c) (not (window-live-p old-window)))
 559                   (setq old-window (selected-window)))))
 560         (or view-no-disable-on-exit
 561             (view-mode-disable))
 562         (while alist                    ; Restore windows with info.
 563           (setq notlost nil)
 564           (if (and (window-live-p (setq window (car (car alist))))
 565                    (eq buffer (window-buffer window)))
 566               (let ((frame (window-frame window))
 567                     (old-buf-info (cdr (cdr (car alist)))))
 568                 (if all-win (select-window window))
 569                 (cond
 570                  ((and (consp old-buf-info) ; Case 3.
 571                        (buffer-live-p (car old-buf-info)))
 572                   (set-window-buffer window (car old-buf-info)) ; old-buf
 573                   (set-window-start window (car (cdr old-buf-info)))
 574                   (set-window-point window (car (cdr (cdr old-buf-info)))))
 575                  ((eq old-buf-info 'quit-window)
 576                   (quit-window))        ; Case 4.
 577                  ((not (eq old-buf-info t)) nil) ; Not case 2, do nothing.
 578                  ((not (one-window-p t)) (delete-window))
 579                  ((not (eq frame (next-frame)))
 580                   ;; Not the only frame, so can safely be removed.
 581                   (if view-remove-frame-by-deleting
 582                       (delete-frame frame)
 583                     (setq notlost t)    ; Keep the window. See below.
 584                     (iconify-frame frame))))))
 585           ;; If a frame is removed by iconifying it, then the window is not
 586           ;; really lost.  In this case we keep the entry in
 587           ;; view-return-to-alist so that if the user deiconifies the frame
 588           ;; and then press q, then the frame is iconified again.
 589           (unless notlost
 590             (setq view-return-to-alist
 591                   (delete (car alist) view-return-to-alist)))
 592           (setq alist (cdr alist)))
 593         (if (window-live-p old-window)  ; still existing window
 594             (select-window old-window))
 595         (when exit-action
 596           (setq view-exit-action nil)
 597           (funcall exit-action buffer))
 598         (force-mode-line-update))))
 599
 600 (defun View-exit ()
 601   "Exit View mode but stay in current buffer."
 602   (interactive)
 603   (view-mode-exit))
 604
 605 ;;;###autoload
 606 (defun View-exit-and-edit ()
 607   "Exit View mode and make the current buffer editable."
 608   (interactive)
 609   (let ((view-old-buffer-read-only nil)
 610         (view-no-disable-on-exit nil))
 611     (view-mode-exit)))
 612
 613 (defun View-leave ()
 614   "Quit View mode and maybe switch buffers, but don't kill this buffer."
 615   (interactive)
 616   (view-mode-exit view-return-to-alist))
 617
 618 (defun View-quit ()
 619   "Quit View mode, trying to restore window and buffer to previous state.
 620 Maybe kill this buffer.  Try to restore selected window to previous state
 621 and go to previous buffer or window."
 622   (interactive)
 623   (view-mode-exit view-return-to-alist view-exit-action))
 624
 625 (defun View-quit-all ()
 626   "Quit View mode, trying to restore windows and buffers to previous state.
 627 Maybe kill current buffer.  Try to restore all windows viewing buffer to
 628 previous state and go to previous buffer or window."
 629   (interactive)
 630   (view-mode-exit view-return-to-alist view-exit-action t))
 631
 632 (defun View-kill-and-leave ()
 633   "Quit View mode, kill current buffer and return to previous buffer."
 634   (interactive)
 635   (view-mode-exit view-return-to-alist (or view-exit-action 'kill-buffer) t))
 636
 637
 638 ;;; Some help routines.
 639
 640 (defun view-window-size ()
 641   ;; Window height excluding mode line.
 642   (1- (window-height)))
 643
 644 ;(defun view-last-command (&optional who what)
 645 ;  (setq view-last-command-entry this-command)
 646 ;  (setq view-last-command who)
 647 ;  (setq view-last-command-argument what))
 648
 649 ;(defun View-repeat-last-command ()
 650 ;  "Repeat last command issued in View mode."
 651 ;  (interactive)
 652 ;  (if (and view-last-command
 653 ;          (eq view-last-command-entry last-command))
 654 ;      (funcall view-last-command view-last-command-argument))
 655 ;  (setq this-command view-last-command-entry))
 656
 657 (defun view-recenter ()
 658   ;; Center point in window.
 659   (recenter (/ (view-window-size) 2)))
 660
 661 (defun view-page-size-default (lines)
 662   ;; Get page size.
 663   (let ((default (- (view-window-size) next-screen-context-lines)))
 664     (if (or (null lines) (zerop (setq lines (prefix-numeric-value lines))))
 665         default
 666       (min (abs lines) default))))
 667
 668 (defun view-set-half-page-size-default (lines)
 669   ;; Get and maybe set half page size.
 670   (if (not lines) view-half-page-size
 671     (setq view-half-page-size
 672           (if (zerop (setq lines (prefix-numeric-value lines)))
 673               (/ (view-window-size) 2)
 674             (view-page-size-default lines)))))
 675
 676
 677 ;;; Commands for moving around in the buffer.
 678
 679 (defun View-goto-percent (&optional percent)
 680   "Move to end (or prefix PERCENT) of buffer in View mode.
 681 Display is centered at point.
 682 Also set the mark at the position where point was."
 683   (interactive "P")
 684   (push-mark)
 685   (goto-char
 686    (if percent
 687        (+ (point-min)
 688           (floor (* (- (point-max) (point-min)) 0.01
 689                     (max 0 (min 100 (prefix-numeric-value percent))))))
 690      (point-max)))
 691   (view-recenter))
 692
 693 ;(defun View-goto-line-last (&optional line)
 694 ;"Move to last (or prefix LINE) line in View mode.
 695 ;Display is centered at LINE.
 696 ;Sets mark at starting position and pushes mark ring."
 697 ;  (interactive "P")
 698 ;  (push-mark)
 699 ;  (if line (goto-line (prefix-numeric-value line))
 700 ;    (goto-char (point-max))
 701 ;    (beginning-of-line))
 702 ;  (view-recenter))
 703
 704 (defun View-goto-line (&optional line)
 705   "Move to first (or prefix LINE) line in View mode.
 706 Display is centered at LINE.
 707 Also set the mark at the position where point was."
 708   (interactive "p")
 709   (push-mark)
 710   (goto-line line)
 711   (view-recenter))
 712
 713 (defun View-scroll-to-buffer-end ()
 714   "Scroll backward or forward so that buffer end is at last line of window."
 715   (interactive)
 716   (let ((p (if (pos-visible-in-window-p (point-max)) (point))))
 717     (goto-char (point-max))
 718     (recenter -1)
 719     (and p (goto-char p))))
 720
 721 (defun view-scroll-lines (lines backward default maxdefault)
 722   ;; This function does the job for all the scrolling commands.
 723   ;; Scroll forward LINES lines.  If BACKWARD is true scroll backwards.
 724   ;; If LINES is negative scroll in the other direction.  If LINES is 0 or nil,
 725   ;; scroll DEFAULT lines.  If MAXDEFAULT is true then scroll no more than a
 726   ;; window full.
 727   (if (or (null lines) (zerop (setq lines (prefix-numeric-value lines))))
 728       (setq lines default))
 729   (when (< lines 0)
 730     (setq backward (not backward)) (setq lines (- lines)))
 731   (setq default (view-page-size-default nil)) ; Max scrolled at a time.
 732   (if maxdefault (setq lines (min lines default)))
 733   (cond
 734    (backward (scroll-down lines))
 735    ((view-really-at-end)
 736     (if view-scroll-auto-exit (View-quit)
 737       (ding)
 738       (view-end-message)))
 739    (t (while (> lines default)
 740         (scroll-up default)
 741         (setq lines (- lines default))
 742         (if (view-really-at-end) (setq lines 0)))
 743       (scroll-up lines)
 744       (if (view-really-at-end) (view-end-message))
 745       (move-to-window-line -1)
 746       (beginning-of-line))))
 747
 748 (defun view-really-at-end ()
 749   ;; Return true if buffer end visible.  Maybe revert buffer and test.
 750   (and (pos-visible-in-window-p (point-max))
 751        (let ((buf (current-buffer))
 752              (bufname (buffer-name))
 753              (file (buffer-file-name)))
 754          (or (not view-try-extend-at-buffer-end)
 755              (null file)
 756              (verify-visited-file-modtime buf)
 757              (not (file-exists-p file))
 758              (when (buffer-modified-p buf)
 759                (setq file (file-name-nondirectory file))
 760                (not (yes-or-no-p
 761                      (format
 762                       "File %s changed on disk.  Discard your edits%s? "
 763                       file
 764                       (if (string= bufname file) ""
 765                         (concat " in " bufname))))))
 766              (progn
 767                (revert-buffer t t t)
 768                (pos-visible-in-window-p (point-max)))))))
 769
 770 (defun view-end-message ()
 771   ;; Tell that we are at end of buffer.
 772   (goto-char (point-max))
 773   (if view-return-to-alist
 774       (message "End of buffer.  Type %s to quit viewing."
 775                (substitute-command-keys
 776                 (if view-scroll-auto-exit "\\[View-scroll-page-forward]"
 777                   "\\[View-quit]")))
 778     (message "End of buffer")))
 779
 780 (defun View-scroll-page-forward (&optional lines)
 781   "Scroll \"page size\" or prefix LINES lines forward in View mode.
 782 Exit if end of text is visible and `view-scroll-auto-exit' is non-nil.
 783 \"page size\" is whole window full, or number of lines set by
 784 \\[View-scroll-page-forward-set-page-size] or
 785 \\[View-scroll-page-backward-set-page-size].
 786 If LINES is more than a window-full, only the last window-full is shown."
 787   (interactive "P")
 788   (view-scroll-lines lines nil view-page-size nil))
 789
 790 (defun View-scroll-page-backward (&optional lines)
 791   "Scroll \"page size\" or prefix LINES lines backward in View mode.
 792 See also `View-scroll-page-forward'."
 793   (interactive "P")
 794   (view-scroll-lines lines t view-page-size nil))
 795
 796 (defun View-scroll-page-forward-set-page-size (&optional lines)
 797   "Scroll forward LINES lines in View mode, setting the \"page size\".
 798 This is the number of lines which \\[View-scroll-page-forward] and
 799 \\[View-scroll-page-backward] scroll by default.
 800 If LINES is omitted or = 0, sets \"page size\" to window height and
 801 scrolls forward that much, otherwise scrolls forward LINES lines and sets
 802 \"page size\" to the minimum of window height and the absolute value of LINES.
 803 See also `View-scroll-page-forward'."
 804   (interactive "P")
 805   (view-scroll-lines lines nil
 806                      (setq view-page-size (view-page-size-default lines))
 807                      nil))
 808
 809 (defun View-scroll-page-backward-set-page-size (&optional lines)
 810   "Scroll backward prefix LINES lines in View mode, setting the \"page size\".
 811 See also `View-scroll-page-forward-set-page-size'."
 812   (interactive "P")
 813   (view-scroll-lines lines t
 814                      (setq view-page-size (view-page-size-default lines))
 815                      nil))
 816
 817 (defun View-scroll-line-forward (&optional lines)
 818   "Scroll forward one line (or prefix LINES lines) in View mode.
 819 See also `View-scroll-page-forward,' but note that scrolling is limited
 820 to minimum of LINES and one window-full."
 821   (interactive "P")
 822   (view-scroll-lines lines nil 1 t))
 823
 824 (defun View-scroll-line-backward (&optional lines)
 825   "Scroll backward one line (or prefix LINES lines) in View mode.
 826 See also `View-scroll-line-forward'."
 827   (interactive "P")
 828   (view-scroll-lines lines t 1 t))
 829
 830 (defun View-scroll-half-page-forward (&optional lines)
 831   "Scroll forward a \"half page\" (or prefix LINES) lines in View mode.
 832 If LINES is not omitted, the \"half page size\" is set to the minimum of
 833 window height and the absolute value of LINES.
 834 LINES=0 resets \"half page size\" to half window height."
 835   (interactive "P")
 836   (view-scroll-lines lines nil (view-set-half-page-size-default lines) t))
 837
 838 (defun View-scroll-half-page-backward (&optional lines)
 839   "Scroll backward a \"half page\" (or prefix LINES) lines in View mode.
 840 See also `View-scroll-half-page-forward'."
 841   (interactive "P")
 842   (view-scroll-lines lines t (view-set-half-page-size-default lines) t))
 843
 844 (defun View-revert-buffer-scroll-page-forward (&optional lines)
 845   "Scroll forward, reverting buffer if needed, in View mode.
 846 If buffer has not been changed and the corresponding file is newer, first
 847 revert the buffer, then scroll.
 848 This command is useful if you are viewing a changing file.
 849
 850 The prefix argument LINES says how many lines to scroll.
 851 If you don't specify a prefix argument, it uses the number of lines set by
 852 \\[View-scroll-page-forward-set-page-size] or
 853 \\[View-scroll-page-backward-set-page-size].
 854 If LINES is more than a window-full, only the last window-full is shown."
 855   (interactive "P")
 856   (let ((view-scroll-auto-exit nil)
 857         (view-try-extend-at-buffer-end t))
 858     (view-scroll-lines lines nil view-page-size nil)))
 859
 860 (defun View-back-to-mark (&optional ignore)
 861   "Return to last mark set in View mode, else beginning of file.
 862 Display that line at the center of the window.
 863 This command pops the mark ring, so that successive
 864 invocations return to earlier marks."
 865   (interactive)
 866   (goto-char (or (mark t) (point-min)))
 867   (pop-mark)
 868   (view-recenter))
 869
 870 (defun View-search-regexp-forward (n regexp)
 871   "Search forward for first (or prefix Nth) occurrence of REGEXP in View mode.
 872
 873 Displays line found at center of window.  Sets mark at starting position and
 874 pushes mark ring.
 875
 876 Characters @ and ! are special at the beginning of REGEXP.  They modify
 877 the search rather than become part of the pattern searched for.
 878 @ means search all the buffer i.e. start search at the beginning of buffer.
 879 ! means search for a line that contains no match for the pattern.
 880 If REGEXP is empty or only consist of these control characters, then
 881 an earlier remembered REGEXP is used, otherwise REGEXP is remembered
 882 for use by later search commands.
 883
 884 The variable `view-highlight-face' controls the face that is used
 885 for highlighting the match that is found."
 886   (interactive "p\nsSearch forward (regexp): ")
 887   (view-search n regexp))
 888
 889 (defun View-search-regexp-backward (n regexp)
 890   "Search backward for first (or prefix Nth) occurrence of REGEXP in View mode.
 891
 892 Displays line found at center of window.  Sets mark at starting position and
 893 pushes mark ring.
 894
 895 Characters @ and ! are special at the beginning of REGEXP.  They modify
 896 the search rather than become part of the pattern searched for.
 897 @ means search all the buffer i.e. start search at the end of buffer.
 898 ! means search for a line that contains no match for the pattern.
 899 If REGEXP is empty or only consist of these control characters, then
 900 an earlier remembered REGEXP is used, otherwise REGEXP is remembered
 901 for use by later search commands.
 902
 903 The variable `view-highlight-face' controls the face that is used
 904 for highlighting the match that is found."
 905   (interactive "p\nsSearch backward (regexp): ")
 906   (view-search (- n) regexp))
 907
 908 (defun View-search-last-regexp-forward (n) "\
 909 Search forward for first (or prefix Nth) instance of last regexp in View mode.
 910 Displays line found at center of window.  Sets mark at starting position and
 911 pushes mark ring.
 912
 913 The variable `view-highlight-face' controls the face that is used
 914 for highlighting the match that is found."
 915   (interactive "p")
 916   (view-search n nil))
 917
 918 (defun View-search-last-regexp-backward (n) "\
 919 Search backward for first (or prefix Nth) instance of last regexp in View mode.
 920 Displays line found at center of window.  Sets mark at starting position and
 921 pushes mark ring.
 922
 923 The variable `view-highlight-face' controls the face that is used
 924 for highlighting the match that is found."
 925   (interactive "p")
 926   (view-search (- n) nil))
 927
 928 (defun view-search (times regexp)
 929   ;; This function does the job for all the View-search- commands.
 930   ;; Search for the TIMESt match for REGEXP. If TIMES is negative
 931   ;; search backwards. If REGEXP is nil use `view-last-regexp'.
 932   ;; Charcters "!" and "@" have a special meaning at the beginning of
 933   ;; REGEXP and are removed from REGEXP before the search "!" means
 934   ;; search for lines with no match for REGEXP.  "@" means search in
 935   ;; the whole buffer, don't start searching from the present point.
 936   (let (where no end ln)
 937     (cond
 938      ((and regexp (> (length regexp) 0)
 939            (or (not (memq (string-to-char regexp) '(?! ?@)))
 940                (progn
 941                  (if (member (substring regexp 0 2) '("!@" "@!"))
 942                      (setq end t no t ln 2)
 943                    (setq no (not (setq end (eq ?@ (string-to-char regexp))))
 944                          ln 1))
 945                  (> (length (setq regexp (substring regexp ln))) 0))))
 946       (setq view-last-regexp (if no (list regexp) regexp)))
 947      ((consp view-last-regexp)
 948       (setq regexp (car view-last-regexp))
 949       (unless (setq no (not no)) (setq view-last-regexp regexp)))
 950      (view-last-regexp (setq regexp view-last-regexp)
 951                        (if no (setq view-last-regexp (list regexp))))
 952      (t (error "No previous View-mode search")))
 953     (save-excursion
 954       (if end (goto-char (if (< times 0) (point-max) (point-min)))
 955         (move-to-window-line (if (< times 0) 0 -1)))
 956       (if (if no (view-search-no-match-lines times regexp)
 957             (re-search-forward regexp nil t times))
 958           (setq where (point))))
 959     (if where
 960         (progn
 961           (push-mark)
 962           (goto-char where)
 963           (if view-overlay
 964               (move-overlay view-overlay (match-beginning 0) (match-end 0))
 965             (setq view-overlay
 966                   (make-overlay (match-beginning 0) (match-end 0))))
 967           (overlay-put view-overlay 'face view-highlight-face)
 968           (beginning-of-line)
 969           (view-recenter))
 970       (message "Can't find occurrence %d of %s%s"
 971                times (if no "no " "") regexp)
 972       (sit-for 4))))
 973
 974 (defun view-search-no-match-lines (times regexp)
 975   ;; Search for the TIMESt occurrence of line with no match for REGEXP.
 976   (let ((back (and (< times 0) (setq times (- times)) -1))
 977         n)
 978     (while (> times 0)
 979       (save-excursion (beginning-of-line (if back (- times) (1+ times)))
 980                       (setq n (point)))
 981       (setq times
 982             (cond
 983              ((< (count-lines (point) n) times) -1) ; Not enough lines.
 984              ((or (null (re-search-forward regexp nil t back))
 985                   (if back (and (< (match-end 0) n)
 986                                 (> (count-lines (match-end 0) n) 1))
 987                     (and (< n (match-beginning 0))
 988                          (> (count-lines n (match-beginning 0)) 1))))
 989               0)                        ; No match within lines.
 990              (back (count-lines (max n (match-beginning 0)) (match-end 0)))
 991              (t (count-lines (match-beginning 0) (min n (match-end 0))))))
 992       (goto-char n))
 993     (and (zerop times) (looking-at "^.*$"))))
 994
 995
 996 (provide 'view)
 997
 998 ;;; view.el ends here