annotate lisp/view.el @ 19486:31fbf3a289c1

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