Mercurial > emacs
annotate lisp/reposition.el @ 7906:1d64f77001be
declare init_system_name (replaces get_system_name).
| author | Karl Heuer <kwzh@gnu.org> |
|---|---|
| date | Wed, 15 Jun 1994 05:27:38 +0000 (1994-06-15) |
| parents | cc7cd83ccf3f |
| children | 83f275dcd93a |
| rev | line source |
|---|---|
|
658
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
269
diff
changeset
|
1 ;;; reposition.el --- center a Lisp function or comment on the screen |
|
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
269
diff
changeset
|
2 |
| 7300 | 3 ;; Copyright (C) 1991, 1994 Free Software Foundation, Inc. |
|
846
20674ae6bf52
*** 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:
658
diff
changeset
|
5 ;; Author: Michael D. Ernst <mernst@theory.lcs.mit.edu> |
|
2315
9e7ec92a4fdf
Added or corrected Commentary headers
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
906
diff
changeset
|
6 ;; Created: Jan 1991 |
|
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
658
diff
changeset
|
7 ;; Maintainer: FSF |
| 196 | 8 |
| 9 ;; This file is part of GNU Emacs. | |
| 10 | |
| 11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
| 12 ;; 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:
658
diff
changeset
|
13 ;; the Free Software Foundation; either version 2, or (at your option) |
| 196 | 14 ;; any later version. |
| 15 | |
| 16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
| 17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 19 ;; GNU General Public License for more details. | |
| 20 | |
| 21 ;; You should have received a copy of the GNU General Public License | |
| 22 ;; along with GNU Emacs; see the file COPYING. If not, write to | |
| 23 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
| 24 | |
|
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
658
diff
changeset
|
25 ;;; Commentary: |
|
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
658
diff
changeset
|
26 |
| 196 | 27 ;;; Reposition-window makes an entire function definition or comment visible, |
| 28 ;;; or, if it is already visible, places it at the top of the window; | |
| 29 ;;; additional invocations toggle the visibility of comments preceding the | |
| 30 ;;; code. For the gory details, see the documentation for reposition-window; | |
| 31 ;;; rather than reading that, you may just want to play with it. | |
| 32 | |
| 33 ;;; This tries pretty hard to do the recentering correctly; the precise | |
| 34 ;;; action depends on what the buffer looks like. If you find a situation | |
| 35 ;;; where it doesn't behave well, let me know. This function is modeled | |
| 36 ;;; after one of the same name in ZMACS, but the code is all-new and the | |
| 37 ;;; behavior in some situations differs. | |
| 38 | |
|
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
658
diff
changeset
|
39 ;;; Code: |
|
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
658
diff
changeset
|
40 |
| 262 | 41 ;;;###autoload |
| 196 | 42 (defun reposition-window (&optional arg) |
| 43 "Make the current definition and/or comment visible. | |
| 44 Further invocations move it to the top of the window or toggle the | |
| 45 visibility of comments that precede it. | |
| 46 Point is left unchanged unless prefix ARG is supplied. | |
| 47 If the definition is fully onscreen, it is moved to the top of the | |
| 48 window. If it is partly offscreen, the window is scrolled to get the | |
| 49 definition (or as much as will fit) onscreen, unless point is in a comment | |
| 50 which is also partly offscreen, in which case the scrolling attempts to get | |
| 51 as much of the comment onscreen as possible. | |
| 52 Initially `reposition-window' attempts to make both the definition and | |
| 53 preceding comments visible. Further invocations toggle the visibility of | |
| 54 the comment lines. | |
| 55 If ARG is non-nil, point may move in order to make the whole defun | |
| 56 visible (if only part could otherwise be made so), to make the defun line | |
| 57 visible (if point is in code and it could not be made so, or if only | |
| 58 comments, including the first comment line, are visible), or to make the | |
| 59 first comment line visible (if point is in a comment)." | |
| 60 (interactive "P") | |
| 61 (let* (;; (here (save-excursion (beginning-of-line) (point))) | |
| 62 (here (point)) | |
| 63 ;; change this name once I've gotten rid of references to ht. | |
| 64 ;; this is actually the number of the last screen line | |
| 65 (ht (- (window-height (selected-window)) 2)) | |
| 66 (line (repos-count-screen-lines (window-start) (point))) | |
| 67 (comment-height | |
| 68 ;; The call to max deals with the case of cursor between defuns. | |
| 69 (max 0 | |
| 70 (repos-count-screen-lines-signed | |
| 71 ;; the beginning of the preceding comment | |
| 72 (save-excursion | |
|
4182
b85c00ac4ae3
(reposition-window): Don't forward-char if eobp.
Richard M. Stallman <rms@gnu.org>
parents:
2315
diff
changeset
|
73 (if (not (eobp)) (forward-char 1)) |
|
5290
fee2ab7de353
(reposition-window): Fix whitespace-skipping regexp.
Richard M. Stallman <rms@gnu.org>
parents:
4182
diff
changeset
|
74 (end-of-defun -1) |
| 196 | 75 ;; Skip whitespace, newlines, and form feeds. |
|
5290
fee2ab7de353
(reposition-window): Fix whitespace-skipping regexp.
Richard M. Stallman <rms@gnu.org>
parents:
4182
diff
changeset
|
76 (if (re-search-forward "[^ \t\n\f]" nil t) |
|
fee2ab7de353
(reposition-window): Fix whitespace-skipping regexp.
Richard M. Stallman <rms@gnu.org>
parents:
4182
diff
changeset
|
77 (backward-char 1)) |
| 196 | 78 (point)) |
| 79 here))) | |
|
5290
fee2ab7de353
(reposition-window): Fix whitespace-skipping regexp.
Richard M. Stallman <rms@gnu.org>
parents:
4182
diff
changeset
|
80 (defun-height |
| 196 | 81 (repos-count-screen-lines-signed |
| 82 (save-excursion | |
| 83 (end-of-defun 1) ; so comments associate with following defuns | |
| 84 (beginning-of-defun 1) | |
| 85 (point)) | |
| 86 here)) | |
| 87 ;; This must be positive, so don't use the signed version. | |
| 88 (defun-depth (repos-count-screen-lines here | |
| 89 (save-excursion | |
| 90 (end-of-defun 1) | |
| 91 (point)))) | |
| 92 (defun-line-onscreen-p | |
| 93 (and (<= defun-height line) | |
| 94 (<= (- line defun-height) ht)))) | |
| 95 (cond ((or (= comment-height line) | |
| 96 (and (= line ht) | |
| 97 (> comment-height line) | |
| 98 ;; if defun line offscreen, we should be in case 4 | |
| 99 defun-line-onscreen-p)) | |
| 100 ;; Either first comment line is at top of screen or (point at | |
| 101 ;; bottom of screen, defun line onscreen, and first comment line | |
| 102 ;; off top of screen). That is, it looks like we just did | |
| 103 ;; recenter-definition, trying to fit as much of the comment | |
| 104 ;; onscreen as possible. Put defun line at top of screen; that | |
| 105 ;; is, show as much code, and as few comments, as possible. | |
| 106 | |
| 107 (if (and arg (> defun-depth (1+ ht))) | |
| 108 ;; Can't fit whole defun onscreen without moving point. | |
| 109 (progn (end-of-defun) (beginning-of-defun) (recenter 0)) | |
| 110 (recenter (max defun-height 0))) | |
| 111 ;;(repos-debug-macro "1") | |
| 112 ) | |
| 113 | |
| 114 ((or (= defun-height line) | |
| 115 (= line 0) | |
| 116 (and (< line comment-height) | |
| 117 (< defun-height 0))) | |
| 118 ;; Defun line or cursor at top of screen, OR cursor in comment | |
| 119 ;; whose first line is offscreen. | |
| 120 ;; Avoid moving definition up even if defun runs offscreen; | |
| 121 ;; we care more about getting the comment onscreen. | |
|
5290
fee2ab7de353
(reposition-window): Fix whitespace-skipping regexp.
Richard M. Stallman <rms@gnu.org>
parents:
4182
diff
changeset
|
122 |
| 196 | 123 (cond ((= line ht) |
| 124 ;; cursor on last screen line (and so in a comment) | |
| 125 (if arg (progn (end-of-defun) (beginning-of-defun))) | |
| 126 (recenter 0) | |
| 127 ;;(repos-debug-macro "2a") | |
| 128 ) | |
|
5290
fee2ab7de353
(reposition-window): Fix whitespace-skipping regexp.
Richard M. Stallman <rms@gnu.org>
parents:
4182
diff
changeset
|
129 |
| 196 | 130 ;; This condition, copied from case 4, may not be quite right |
|
5290
fee2ab7de353
(reposition-window): Fix whitespace-skipping regexp.
Richard M. Stallman <rms@gnu.org>
parents:
4182
diff
changeset
|
131 |
| 196 | 132 ((and arg (< ht comment-height)) |
| 133 ;; Can't get first comment line onscreen. | |
| 134 ;; Go there and try again. | |
| 135 (forward-line (- comment-height)) | |
| 136 (beginning-of-line) | |
| 137 ;; was (reposition-window) | |
| 138 (recenter 0) | |
| 139 ;;(repos-debug-macro "2b") | |
| 140 ) | |
| 141 (t | |
| 142 (recenter (min ht comment-height)) | |
| 143 ;;(repos-debug-macro "2c") | |
| 144 )) | |
| 145 ;; (recenter (min ht comment-height)) | |
| 146 ) | |
| 147 | |
| 148 ((and (> (+ line defun-depth -1) ht) | |
| 149 defun-line-onscreen-p) | |
| 150 ;; Defun runs off the bottom of the screen and the defun line | |
| 151 ;; is onscreen. | |
| 152 ;; Move the defun up. | |
| 153 (recenter (max 0 (1+ (- ht defun-depth)) defun-height)) | |
| 154 ;;(repos-debug-macro "3") | |
| 155 ) | |
| 156 | |
| 157 (t | |
| 158 ;; If on the bottom line and comment start is offscreen | |
| 159 ;; then just move all comments offscreen, or at least as | |
| 160 ;; far as they'll go. | |
| 161 | |
| 162 ;; Try to get as much of the comments onscreen as possible. | |
| 163 (if (and arg (< ht comment-height)) | |
| 164 ;; Can't get defun line onscreen; go there and try again. | |
| 165 (progn (forward-line (- defun-height)) | |
| 166 (beginning-of-line) | |
| 167 (reposition-window)) | |
| 168 (recenter (min ht comment-height))) | |
| 169 ;;(repos-debug-macro "4") | |
| 170 )))) | |
| 171 | |
|
5290
fee2ab7de353
(reposition-window): Fix whitespace-skipping regexp.
Richard M. Stallman <rms@gnu.org>
parents:
4182
diff
changeset
|
172 ;;;###autoload (define-key esc-map "\C-l" 'reposition-window) |
| 264 | 173 |
| 196 | 174 ;;; Auxiliary functions |
| 175 | |
| 176 ;; Return number of screen lines between START and END. | |
| 177 (defun repos-count-screen-lines (start end) | |
| 178 (save-excursion | |
| 179 (save-restriction | |
| 180 (narrow-to-region start end) | |
| 181 (goto-char (point-min)) | |
| 182 (vertical-motion (- (point-max) (point-min)))))) | |
| 183 | |
| 184 ;; Return number of screen lines between START and END; returns a negative | |
| 185 ;; number if END precedes START. | |
| 186 (defun repos-count-screen-lines-signed (start end) | |
| 187 (let ((lines (repos-count-screen-lines start end))) | |
| 188 (if (< start end) | |
| 189 lines | |
| 190 (- lines)))) | |
| 191 | |
| 192 ; (defmacro repos-debug-macro (case-no) | |
| 193 ; (` (message | |
| 194 ; (concat "Case " (, case-no) ": %s %s %s %s %s") | |
| 195 ; ht line comment-height defun-height defun-depth))) | |
| 196 | |
|
658
7cbd4fcd8b0f
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
269
diff
changeset
|
197 ;;; reposition.el ends here |