Mercurial > hg > xemacs-beta

comparison lisp/window-xemacs.el @ 428:3ecd8885ac67 r21-2-22

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-2-22
author cvs
date Mon, 13 Aug 2007 11:28:15 +0200
parents
children abe6d1db359e
comparison
equal deleted inserted replaced
427:0a0253eac470 428:3ecd8885ac67
1 ;;; window-xemacs.el --- XEmacs window commands aside from those written in C.
2
3 ;; Copyright (C) 1985, 1989, 1993-94, 1997 Free Software Foundation, Inc.
4 ;; Copyright (C) 1995, 1996 Ben Wing.
5
6 ;; Maintainer: XEmacs Development Team
7 ;; Keywords: frames, extensions, dumped
8
9 ;; This file is part of XEmacs.
10
11 ;; XEmacs is free software; you can redistribute it and/or modify it
12 ;; under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; XEmacs is distributed in the hope that it will be useful, but
17 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 ;; General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with XEmacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
25
26 ;;; Synched up with: Not synched.
27
28 ;;; Commentary:
29
30 ;; This file is dumped with XEmacs.
31
32 ;; slb - 5/29/97
33 ;; Split apart from window.el in order to keep that file better in synch
34 ;; with Emacs.
35
36 ;;; Code:
37
38 (defgroup windows nil
39 "Windows within a frame."
40 :group 'environment)
41
42 (defun recenter (&optional n window)
43 "Center point in WINDOW and redisplay frame. With N, put point on line N.
44 The desired position of point is always relative to the window.
45 Just C-u as prefix means put point in the center of the window.
46 No N (i.e., it is nil) erases the entire frame and then
47 redraws with point in the center of the window.
48 If WINDOW is nil, the selected window is used."
49 (interactive "_P")
50 (center-to-window-line (if (consp n) nil n) window)
51 (when (null n)
52 (redraw-frame (window-frame window) t)))
53
54 (defun backward-other-window (arg &optional all-frames device)
55 "Select the ARG'th different window on this frame, going backwards.
56 This is just like calling `other-window' with the arg negated."
57 (interactive "p")
58 (other-window (- arg) all-frames device))
59
60 (defalias 'windows-of-buffer 'get-buffer-window-list)
61
62 (defun buffer-in-multiple-windows-p (&optional buffer)
63 "Return t if BUFFER is in multiple windows.
64 If BUFFER is not specified, the current buffer will be used."
65 (setq buffer (or buffer
66 (get-buffer buffer)
67 (get-file-buffer buffer)
68 (current-buffer)))
69 (> (length (windows-of-buffer buffer)) 1))
70
71 (defun window-list (&optional frame minibuf window)
72 "Return a list of windows on FRAME, beginning with WINDOW.
73 FRAME and WINDOW default to the selected ones.
74 Optional second arg MINIBUF t means count the minibuffer window
75 even if not active. If MINIBUF is neither t nor nil it means
76 not to count the minibuffer even if it is active."
77 (setq window (or window (selected-window))
78 frame (or frame (selected-frame)))
79 (if (not (eq (window-frame window) frame))
80 (error "Window must be on frame."))
81 (let ((current-frame (selected-frame))
82 list)
83 (unwind-protect
84 (save-window-excursion
85 (select-frame frame)
86 (walk-windows
87 (function (lambda (cur-window)
88 (if (not (eq window cur-window))
89 (setq list (cons cur-window list)))))
90 minibuf)
91 (setq list (cons window list)))
92 (select-frame current-frame))))
93
94 ;; We used to have set-window-dedicated-p as an obsolete version
95 ;; of set-window-buffer-dedicated, but it really makes more sense
96 ;; this way.
97
98 (make-obsolete 'set-window-buffer-dedicated 'set-window-dedicated-p)
99 (defun set-window-buffer-dedicated (window buffer)
100 "Make WINDOW display BUFFER and be dedicated to that buffer.
101 Then Emacs will not automatically change which buffer appears in WINDOW.
102 If BUFFER is nil, make WINDOW not be dedicated (but don't change which
103 buffer appears in it currently)."
104 (if (bufferp buffer)
105 (set-window-buffer window (get-buffer-create buffer)))
106 (set-window-dedicated-p window (not (null buffer))))
107
108
109 ;; The window-config stack is stored as a list in frame property
110 ;; 'window-config-stack, with the most recent element at the front.
111 ;; When you pop off an element, the popped off element gets put at the
112 ;; front of frame property 'window-config-unpop-stack, so you can
113 ;; retrieve it using unpop-window-configuration.
114
115 (defcustom window-config-stack-max 16
116 "*Maximum size of window configuration stack.
117 Start discarding off end if it gets this big."
118 :type 'integer
119 :group 'windows)
120
121 (defun window-config-stack (&optional frame)
122 (or frame (setq frame (selected-frame)))
123 (let ((stack (frame-property frame 'window-config-stack)))
124 (if stack
125 (set-undoable-stack-max stack window-config-stack-max)
126 (progn
127 (setq stack (make-undoable-stack window-config-stack-max))
128 (set-frame-property frame 'window-config-stack stack)))
129 stack))
130
131 (defun push-window-configuration (&optional config)
132 "Push the current window configuration onto the window-config stack.
133 If CONFIG is specified, push it instead of the current window configuration.
134 Each frame has its own window-config stack."
135 (interactive)
136 (let ((wc (or config (current-window-configuration)))
137 (stack (window-config-stack)))
138 (if (or (= 0 (undoable-stack-a-length stack))
139 (not (equal (undoable-stack-a-top stack) wc)))
140 (undoable-stack-push stack wc))))
141
142 (defun pop-window-configuration ()
143 "Pop the top window configuration off the window-config stack and set it.
144 Before setting the new window configuration, the current window configuration
145 is pushed onto the \"unpop\" stack.
146 `unpop-window-configuration' undoes what this function does.
147 Each frame has its own window-config and \"unpop\" stack."
148 (interactive)
149 (let ((stack (window-config-stack))
150 (wc (current-window-configuration))
151 popped)
152 (condition-case nil
153 (progn
154 (setq popped (undoable-stack-pop stack))
155 (while (equal popped wc)
156 (setq popped (undoable-stack-pop stack)))
157 (undoable-stack-push stack wc)
158 (undoable-stack-undo stack)
159 (set-window-configuration popped)
160 popped)
161 (trunc-stack-bottom
162 (error "Bottom of window config stack")))))
163
164 (defun unpop-window-configuration ()
165 "Undo the effect of the most recent `pop-window-configuration'.
166 This does exactly the inverse of what `pop-window-configuration' does:
167 i.e. it pops a window configuration off of the \"unpop\" stack and
168 pushes the current window configuration onto the window-config stack.
169 Each frame has its own window-config and \"unpop\" stack."
170 (interactive)
171 (let ((stack (window-config-stack))
172 (wc (current-window-configuration))
173 popped)
174 (condition-case nil
175 (progn
176 (setq popped
177 (progn
178 (undoable-stack-redo stack)
179 (undoable-stack-pop stack)))
180 (while (equal popped wc)
181 (setq popped
182 (progn
183 (undoable-stack-redo stack)
184 (undoable-stack-pop stack))))
185 (undoable-stack-push stack wc)
186 (set-window-configuration popped)
187 popped)
188 (trunc-stack-bottom
189 (error "Top of window config stack")))))
190
191
192 ;;;;;;;;;;;;; display-buffer, moved here from C. Hallelujah.
193
194 (defvar display-buffer-function nil
195 "If non-nil, function to call to handle `display-buffer'.
196 It will receive three args: the same as those to `display-buffer'.")
197
198 (defvar pre-display-buffer-function nil
199 "If non-nil, function that will be called from `display-buffer'
200 as the first action. It will receive three args: the same as those
201 to `display-buffer'.
202 This function may be used to select an appropriate frame for the buffer,
203 for example. See also the variable `display-buffer-function', which may
204 be used to completely replace the `display-buffer' function.
205 If the return value of this function is non-nil, it should be a frame,
206 and that frame will be used to display the buffer.")
207
208 (defcustom pop-up-frames nil
209 "*Non-nil means `display-buffer' should make a separate frame."
210 :type 'boolean
211 :group 'frames)
212
213 (defvar pop-up-frame-function nil
214 "Function to call to handle automatic new frame creation.
215 It is called with no arguments and should return a newly created frame.
216
217 A typical value might be `(lambda () (new-frame pop-up-frame-alist))'
218 where `pop-up-frame-alist' would hold the default frame parameters.")
219
220 (defcustom special-display-buffer-names nil
221 "*List of buffer names that should have their own special frames.
222 Displaying a buffer whose name is in this list makes a special frame for it
223 using `special-display-function'.
224
225 An element of the list can be a cons cell instead of just a string.
226 Then the car should be a buffer name, and the cdr specifies frame
227 parameters for creating the frame for that buffer.
228 More precisely, the cdr is passed as the second argument to
229 the function found in `special-display-function', when making that frame.
230 See also `special-display-regexps'."
231 :type '(repeat (choice :value ""
232 (string :tag "Name")
233 (cons :menu-tag "Properties"
234 :value ("" . nil)
235 (string :tag "Name")
236 (repeat :tag "Properties"
237 (group :inline t
238 (symbol :tag "Property")
239 (sexp :tag "Value"))))))
240 :group 'frames)
241
242 (defcustom special-display-regexps nil
243 "*List of regexps saying which buffers should have their own special frames.
244 If a buffer name matches one of these regexps, it gets its own frame.
245 Displaying a buffer whose name is in this list makes a special frame for it
246 using `special-display-function'.
247
248 An element of the list can be a cons cell instead of just a string.
249 Then the car should be the regexp, and the cdr specifies frame
250 parameters for creating the frame for buffers that match.
251 More precisely, the cdr is passed as the second argument to
252 the function found in `special-display-function', when making that frame.
253 See also `special-display-buffer-names'."
254 :type '(repeat (choice :value ""
255 regexp
256 (cons :menu-tag "Properties"
257 :value ("" . nil)
258 regexp
259 (repeat :tag "Properties"
260 (group :inline t
261 (symbol :tag "Property")
262 (sexp :tag "Value"))))))
263 :group 'frames)
264
265 (defvar special-display-function nil
266 "Function to call to make a new frame for a special buffer.
267 It is called with two arguments, the buffer and optional buffer specific
268 data, and should return a window displaying that buffer.
269 The default value makes a separate frame for the buffer,
270 using `special-display-frame-alist' to specify the frame parameters.
271
272 A buffer is special if its is listed in `special-display-buffer-names'
273 or matches a regexp in `special-display-regexps'.")
274
275 (defcustom same-window-buffer-names nil
276 "*List of buffer names that should appear in the selected window.
277 Displaying one of these buffers using `display-buffer' or `pop-to-buffer'
278 switches to it in the selected window, rather than making it appear
279 in some other window.
280
281 An element of the list can be a cons cell instead of just a string.
282 Then the car must be a string, which specifies the buffer name.
283 This is for compatibility with `special-display-buffer-names';
284 the cdr of the cons cell is ignored.
285
286 See also `same-window-regexps'."
287 :type '(repeat (string :tag "Name"))
288 :group 'windows)
289
290 (defcustom same-window-regexps nil
291 "*List of regexps saying which buffers should appear in the selected window.
292 If a buffer name matches one of these regexps, then displaying it
293 using `display-buffer' or `pop-to-buffer' switches to it
294 in the selected window, rather than making it appear in some other window.
295
296 An element of the list can be a cons cell instead of just a string.
297 Then the car must be a string, which specifies the buffer name.
298 This is for compatibility with `special-display-buffer-names';
299 the cdr of the cons cell is ignored.
300
301 See also `same-window-buffer-names'."
302 :type '(repeat regexp)
303 :group 'windows)
304
305 (defcustom pop-up-windows t
306 "*Non-nil means display-buffer should make new windows."
307 :type 'boolean
308 :group 'windows)
309
310 (defcustom split-height-threshold 500
311 "*display-buffer would prefer to split the largest window if this large.
312 If there is only one window, it is split regardless of this value."
313 :type 'integer
314 :group 'windows)
315
316 (defcustom split-width-threshold 500
317 "*display-buffer would prefer to split the largest window if this large.
318 If there is only one window, it is split regardless of this value."
319 :type 'integer
320 :group 'windows)
321
322 ;; Deiconify the frame containing the window WINDOW, then return WINDOW.
323
324 (defun display-buffer-1 (window)
325 (if (frame-iconified-p (window-frame window))
326 (make-frame-visible (window-frame window)))
327 window)
328
329 ;; Can you believe that all of this crap was formerly in C?
330 ;; Praise Jesus that it's not there any more.
331
332 (defun display-buffer (buffer &optional not-this-window-p override-frame)
333 "Make BUFFER appear in some window on the current frame, but don't select it.
334 BUFFER can be a buffer or a buffer name.
335 If BUFFER is shown already in some window in the current frame,
336 just uses that one, unless the window is the selected window and
337 NOT-THIS-WINDOW-P is non-nil (interactively, with prefix arg).
338
339 If BUFFER has a dedicated frame, display on that frame instead of
340 the current frame, unless OVERRIDE-FRAME is non-nil.
341
342 If OVERRIDE-FRAME is non-nil, display on that frame instead of
343 the current frame (or the dedicated frame).
344
345 If `pop-up-windows' is non-nil, always use the
346 current frame and create a new window regardless of whether the
347 buffer has a dedicated frame, and regardless of whether
348 OVERRIDE-FRAME was specified.
349
350 If `pop-up-frames' is non-nil, make a new frame if no window shows BUFFER.
351
352 Returns the window displaying BUFFER."
353 (interactive "BDisplay buffer:\nP")
354
355 (let ((wconfig (current-window-configuration))
356 (result
357 ;; We just simulate a `return' in C. This function is way ugly
358 ;; and does `returns' all over the place and there's no sense
359 ;; in trying to rewrite it to be more Lispy.
360 (catch 'done
361 (let (window old-frame target-frame explicit-frame)
362 (setq old-frame (or (last-nonminibuf-frame) (selected-frame)))
363 (setq buffer (get-buffer buffer))
364 (check-argument-type 'bufferp buffer)
365
366 (setq explicit-frame
367 (if pre-display-buffer-function
368 (funcall pre-display-buffer-function buffer
369 not-this-window-p
370 override-frame)))
371
372 ;; Give the user the ability to completely reimplement
373 ;; this function via the `display-buffer-function'.
374 (if display-buffer-function
375 (throw 'done
376 (funcall display-buffer-function buffer
377 not-this-window-p
378 override-frame)))
379
380 ;; If the buffer has a dedicated frame, that takes
381 ;; precedence over the current frame, and over what the
382 ;; pre-display-buffer-function did.
383 (let ((dedi (buffer-dedicated-frame buffer)))
384 (if (frame-live-p dedi) (setq explicit-frame dedi)))
385
386 ;; if override-frame is supplied, that takes precedence over
387 ;; everything. This is gonna look bad if the
388 ;; pre-display-buffer-function raised some other frame
389 ;; already.
390 (if override-frame
391 (progn
392 (check-argument-type 'frame-live-p override-frame)
393 (setq explicit-frame override-frame)))
394
395 (setq target-frame
396 (or explicit-frame
397 (last-nonminibuf-frame)
398 (selected-frame)))
399
400 ;; If we have switched frames, then set not-this-window-p
401 ;; to false. Switching frames means that selected-window
402 ;; is no longer the same as it was on entry -- it's the
403 ;; selected-window of target_frame instead of old_frame,
404 ;; so it's a fine candidate for display.
405 (if (not (eq old-frame target-frame))
406 (setq not-this-window-p nil))
407
408 ;; if it's in the selected window, and that's ok, then we're done.
409 (if (and (not not-this-window-p)
410 (eq buffer (window-buffer (selected-window))))
411 (throw 'done (display-buffer-1 (selected-window))))
412
413 ;; See if the user has specified this buffer should appear
414 ;; in the selected window.
415
416 (if not-this-window-p
417 nil
418
419 (if (or (member (buffer-name buffer) same-window-buffer-names)
420 (assoc (buffer-name buffer) same-window-buffer-names))
421 (progn
422 (switch-to-buffer buffer)
423 (throw 'done (display-buffer-1 (selected-window)))))
424
425 (let ((tem same-window-regexps))
426 (while tem
427 (let ((car (car tem)))
428 (if (or
429 (and (stringp car)
430 (string-match car (buffer-name buffer)))
431 (and (consp car) (stringp (car car))
432 (string-match (car car) (buffer-name buffer))))
433 (progn
434 (switch-to-buffer buffer)
435 (throw 'done (display-buffer-1
436 (selected-window))))))
437 (setq tem (cdr tem)))))
438
439 ;; If pop-up-frames, look for a window showing BUFFER on
440 ;; any visible or iconified frame. Otherwise search only
441 ;; the current frame.
442 (if (and (not explicit-frame)
443 (or pop-up-frames (not (last-nonminibuf-frame))))
444 (setq target-frame 0))
445
446 ;; Otherwise, find some window that it's already in, and
447 ;; return that, unless that window is the selected window
448 ;; and that isn't ok. What a contorted mess!
449 (setq window (or (if (not explicit-frame)
450 ;; search the selected frame
451 ;; first if the user didn't
452 ;; specify an explicit frame.
453 (get-buffer-window buffer nil))
454 (get-buffer-window buffer target-frame)))
455 (if (and window
456 (or (not not-this-window-p)
457 (not (eq window (selected-window)))))
458 (throw 'done (display-buffer-1 window)))
459
460 ;; Certain buffer names get special handling.
461 (if special-display-function
462 (progn
463 (if (member (buffer-name buffer)
464 special-display-buffer-names)
465 (throw 'done (funcall special-display-function buffer)))
466
467 (let ((tem (assoc (buffer-name buffer)
468 special-display-buffer-names)))
469 (if tem
470 (throw 'done (funcall special-display-function
471 buffer (cdr tem)))))
472
473 (let ((tem special-display-regexps))
474 (while tem
475 (let ((car (car tem)))
476 (if (and (stringp car)
477 (string-match car (buffer-name buffer)))
478 (throw 'done
479 (funcall special-display-function buffer)))
480 (if (and (consp car)
481 (stringp (car car))
482 (string-match (car car)
483 (buffer-name buffer)))
484 (throw 'done (funcall
485 special-display-function buffer
486 (cdr car)))))
487 (setq tem (cdr tem))))))
488
489 ;; If there are no frames open that have more than a minibuffer,
490 ;; we need to create a new frame.
491 (if (or pop-up-frames
492 (null (last-nonminibuf-frame)))
493 (progn
494 (setq window (frame-selected-window
495 (funcall pop-up-frame-function)))
496 (set-window-buffer window buffer)
497 (throw 'done (display-buffer-1 window))))
498
499 ;; Otherwise, make it be in some window, splitting if
500 ;; appropriate/possible. Do not split a window if we are
501 ;; displaying the buffer in a different frame than that which
502 ;; was current when we were called. (It is already in a
503 ;; different window by virtue of being in another frame.)
504 (if (or (and pop-up-windows (eq target-frame old-frame))
505 (eq 'only (frame-property (selected-frame) 'minibuffer))
506 ;; If the current frame is a special display frame,
507 ;; don't try to reuse its windows.
508 (window-dedicated-p (frame-root-window (selected-frame))))
509 (progn
510 (if (eq 'only (frame-property (selected-frame) 'minibuffer))
511 (setq target-frame (last-nonminibuf-frame)))
512
513 ;; Don't try to create a window if would get an error with
514 ;; height.
515 (if (< split-height-threshold (* 2 window-min-height))
516 (setq split-height-threshold (* 2 window-min-height)))
517
518 ;; Same with width.
519 (if (< split-width-threshold (* 2 window-min-width))
520 (setq split-width-threshold (* 2 window-min-width)))
521
522 ;; If the frame we would try to split cannot be split,
523 ;; try other frames.
524 (if (frame-property (if (null target-frame)
525 (selected-frame)
526 (last-nonminibuf-frame))
527 'unsplittable)
528 (setq window
529 ;; Try visible frames first.
530 (or (get-largest-window 'visible)
531 ;; If that didn't work, try iconified frames.
532 (get-largest-window 0)
533 (get-largest-window t)))
534 (setq window (get-largest-window target-frame)))
535
536 ;; If we got a tall enough full-width window that
537 ;; can be split, split it.
538 (if (and window
539 (not (frame-property (window-frame window)
540 'unsplittable))
541 (>= (window-height window) split-height-threshold)
542 (or (>= (window-width window)
543 split-width-threshold)
544 (and (window-leftmost-p window)
545 (window-rightmost-p window))))
546 (setq window (split-window window))
547 (let (upper
548 ;; lower
549 other)
550 (setq window (get-lru-window target-frame))
551 ;; If the LRU window is selected, and big enough,
552 ;; and can be split, split it.
553 (if (and window
554 (not (frame-property (window-frame window)
555 'unsplittable))
556 (or (eq window (selected-window))
557 (not (window-parent window)))
558 (>= (window-height window)
559 (* 2 window-min-height)))
560 (setq window (split-window window)))
561 ;; If get-lru-window returned nil, try other approaches.
562 ;; Try visible frames first.
563 (or window
564 (setq window (or (get-largest-window 'visible)
565 ;; If that didn't work, try
566 ;; iconified frames.
567 (get-largest-window 0)
568 ;; Try invisible frames.
569 (get-largest-window t)
570 ;; As a last resort, make
571 ;; a new frame.
572 (frame-selected-window
573 (funcall
574 pop-up-frame-function)))))
575 ;; If window appears above or below another,
576 ;; even out their heights.
577 (if (window-previous-child window)
578 (setq other (window-previous-child window)
579 ;; lower window
580 upper other))
581 (if (window-next-child window)
582 (setq other (window-next-child window)
583 ;; lower other
584 upper window))
585 ;; Check that OTHER and WINDOW are vertically arrayed.
586 (if (and other
587 (not (= (nth 1 (window-pixel-edges other))
588 (nth 1 (window-pixel-edges window))))
589 (> (window-pixel-height other)
590 (window-pixel-height window)))
591 (enlarge-window (- (/ (+ (window-height other)
592 (window-height window))
593 2)
594 (window-height upper))
595 nil upper)))))
596
597 (setq window (get-lru-window target-frame)))
598
599 ;; Bring the window's previous buffer to the top of the MRU chain.
600 (if (window-buffer window)
601 (save-excursion
602 (save-selected-window
603 (select-window window)
604 (record-buffer (window-buffer window)))))
605
606 (set-window-buffer window buffer)
607
608 (display-buffer-1 window)))))
609 (or (equal wconfig (current-window-configuration))
610 (push-window-configuration wconfig))
611 result))
612
613 ;;; window-xemacs.el ends here