aboutsummaryrefslogtreecommitdiffstats
path: root/src/window.c
diff options
context:
space:
mode:
authorPavel Janík2001-10-20 20:56:10 +0000
committerPavel Janík2001-10-20 20:56:10 +0000
commitfdb82f93376a6b495c573a6c788b807acffdbfa9 (patch)
tree107b731b733908446a3902f6ce0e4f2d23dcd8f9 /src/window.c
parentc0a53abba1d89bb487e3a38a0e7336bdce46fd1d (diff)
downloademacs-fdb82f93376a6b495c573a6c788b807acffdbfa9.tar.gz
emacs-fdb82f93376a6b495c573a6c788b807acffdbfa9.zip
Change doc-string comments to `new style' [w/`doc:' keyword].
Diffstat (limited to 'src/window.c')
-rw-r--r--src/window.c1019
1 files changed, 501 insertions, 518 deletions
diff --git a/src/window.c b/src/window.c
index 4c629113d9d..c8a348bf626 100644
--- a/src/window.c
+++ b/src/window.c
@@ -227,15 +227,15 @@ extern int scroll_margin;
227extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions; 227extern Lisp_Object Qwindow_scroll_functions, Vwindow_scroll_functions;
228 228
229DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0, 229DEFUN ("windowp", Fwindowp, Swindowp, 1, 1, 0,
230 "Returns t if OBJECT is a window.") 230 doc: /* Returns t if OBJECT is a window. */)
231 (object) 231 (object)
232 Lisp_Object object; 232 Lisp_Object object;
233{ 233{
234 return WINDOWP (object) ? Qt : Qnil; 234 return WINDOWP (object) ? Qt : Qnil;
235} 235}
236 236
237DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0, 237DEFUN ("window-live-p", Fwindow_live_p, Swindow_live_p, 1, 1, 0,
238 "Returns t if OBJECT is a window which is currently visible.") 238 doc: /* Returns t if OBJECT is a window which is currently visible. */)
239 (object) 239 (object)
240 Lisp_Object object; 240 Lisp_Object object;
241{ 241{
@@ -283,17 +283,17 @@ make_window ()
283} 283}
284 284
285DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0, 285DEFUN ("selected-window", Fselected_window, Sselected_window, 0, 0, 0,
286 "Return the window that the cursor now appears in and commands apply to.") 286 doc: /* Return the window that the cursor now appears in and commands apply to. */)
287 () 287 ()
288{ 288{
289 return selected_window; 289 return selected_window;
290} 290}
291 291
292DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0, 292DEFUN ("minibuffer-window", Fminibuffer_window, Sminibuffer_window, 0, 1, 0,
293 "Return the window used now for minibuffers.\n\ 293 doc: /* Return the window used now for minibuffers.
294If the optional argument FRAME is specified, return the minibuffer window\n\ 294If the optional argument FRAME is specified, return the minibuffer window
295used by that frame.") 295used by that frame. */)
296 (frame) 296 (frame)
297 Lisp_Object frame; 297 Lisp_Object frame;
298{ 298{
299 if (NILP (frame)) 299 if (NILP (frame))
@@ -303,8 +303,8 @@ used by that frame.")
303} 303}
304 304
305DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0, 305DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1, 0,
306 "Returns non-nil if WINDOW is a minibuffer window.") 306 doc: /* Returns non-nil if WINDOW is a minibuffer window. */)
307 (window) 307 (window)
308 Lisp_Object window; 308 Lisp_Object window;
309{ 309{
310 struct window *w = decode_window (window); 310 struct window *w = decode_window (window);
@@ -313,13 +313,13 @@ DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, Swindow_minibuffer_p, 0, 1,
313 313
314 314
315DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p, 315DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p,
316 Spos_visible_in_window_p, 0, 3, 0, 316 Spos_visible_in_window_p, 0, 3, 0,
317 "Return t if position POS is currently on the frame in WINDOW.\n\ 317 doc: /* Return t if position POS is currently on the frame in WINDOW.
318Return nil if that position is scrolled vertically out of view.\n\ 318Return nil if that position is scrolled vertically out of view.
319If a character is only partially visible, nil is returned, unless the\n\ 319If a character is only partially visible, nil is returned, unless the
320optional argument PARTIALLY is non-nil.\n\ 320optional argument PARTIALLY is non-nil.
321POS defaults to point in WINDOW; WINDOW defaults to the selected window.") 321POS defaults to point in WINDOW; WINDOW defaults to the selected window. */)
322 (pos, window, partially) 322 (pos, window, partially)
323 Lisp_Object pos, window, partially; 323 Lisp_Object pos, window, partially;
324{ 324{
325 register struct window *w; 325 register struct window *w;
@@ -391,44 +391,44 @@ decode_window (window)
391} 391}
392 392
393DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0, 393DEFUN ("window-buffer", Fwindow_buffer, Swindow_buffer, 0, 1, 0,
394 "Return the buffer that WINDOW is displaying.") 394 doc: /* Return the buffer that WINDOW is displaying. */)
395 (window) 395 (window)
396 Lisp_Object window; 396 Lisp_Object window;
397{ 397{
398 return decode_window (window)->buffer; 398 return decode_window (window)->buffer;
399} 399}
400 400
401DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0, 401DEFUN ("window-height", Fwindow_height, Swindow_height, 0, 1, 0,
402 "Return the number of lines in WINDOW (including its mode line).") 402 doc: /* Return the number of lines in WINDOW (including its mode line). */)
403 (window) 403 (window)
404 Lisp_Object window; 404 Lisp_Object window;
405{ 405{
406 return decode_window (window)->height; 406 return decode_window (window)->height;
407} 407}
408 408
409DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0, 409DEFUN ("window-width", Fwindow_width, Swindow_width, 0, 1, 0,
410 "Return the number of display columns in WINDOW.\n\ 410 doc: /* Return the number of display columns in WINDOW.
411This is the width that is usable columns available for text in WINDOW.\n\ 411This is the width that is usable columns available for text in WINDOW.
412If you want to find out how many columns WINDOW takes up,\n\ 412If you want to find out how many columns WINDOW takes up,
413use (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))).") 413use (let ((edges (window-edges))) (- (nth 2 edges) (nth 0 edges))). */)
414 (window) 414 (window)
415 Lisp_Object window; 415 Lisp_Object window;
416{ 416{
417 return make_number (window_internal_width (decode_window (window))); 417 return make_number (window_internal_width (decode_window (window)));
418} 418}
419 419
420DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0, 420DEFUN ("window-hscroll", Fwindow_hscroll, Swindow_hscroll, 0, 1, 0,
421 "Return the number of columns by which WINDOW is scrolled from left margin.") 421 doc: /* Return the number of columns by which WINDOW is scrolled from left margin. */)
422 (window) 422 (window)
423 Lisp_Object window; 423 Lisp_Object window;
424{ 424{
425 return decode_window (window)->hscroll; 425 return decode_window (window)->hscroll;
426} 426}
427 427
428DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0, 428DEFUN ("set-window-hscroll", Fset_window_hscroll, Sset_window_hscroll, 2, 2, 0,
429 "Set number of columns WINDOW is scrolled from left margin to NCOL.\n\ 429 doc: /* Set number of columns WINDOW is scrolled from left margin to NCOL.
430NCOL should be zero or positive.") 430NCOL should be zero or positive. */)
431 (window, ncol) 431 (window, ncol)
432 Lisp_Object window, ncol; 432 Lisp_Object window, ncol;
433{ 433{
434 struct window *w = decode_window (window); 434 struct window *w = decode_window (window);
@@ -447,9 +447,9 @@ NCOL should be zero or positive.")
447 447
448DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger, 448DEFUN ("window-redisplay-end-trigger", Fwindow_redisplay_end_trigger,
449 Swindow_redisplay_end_trigger, 0, 1, 0, 449 Swindow_redisplay_end_trigger, 0, 1, 0,
450 "Return WINDOW's redisplay end trigger value.\n\ 450 doc: /* Return WINDOW's redisplay end trigger value.
451See `set-window-redisplay-end-trigger' for more information.") 451See `set-window-redisplay-end-trigger' for more information. */)
452 (window) 452 (window)
453 Lisp_Object window; 453 Lisp_Object window;
454{ 454{
455 return decode_window (window)->redisplay_end_trigger; 455 return decode_window (window)->redisplay_end_trigger;
@@ -457,13 +457,13 @@ See `set-window-redisplay-end-trigger' for more information.")
457 457
458DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger, 458DEFUN ("set-window-redisplay-end-trigger", Fset_window_redisplay_end_trigger,
459 Sset_window_redisplay_end_trigger, 2, 2, 0, 459 Sset_window_redisplay_end_trigger, 2, 2, 0,
460 "Set WINDOW's redisplay end trigger value to VALUE.\n\ 460 doc: /* Set WINDOW's redisplay end trigger value to VALUE.
461VALUE should be a buffer position (typically a marker) or nil.\n\ 461VALUE should be a buffer position (typically a marker) or nil.
462If it is a buffer position, then if redisplay in WINDOW reaches a position\n\ 462If it is a buffer position, then if redisplay in WINDOW reaches a position
463beyond VALUE, the functions in `redisplay-end-trigger-functions' are called\n\ 463beyond VALUE, the functions in `redisplay-end-trigger-functions' are called
464with two arguments: WINDOW, and the end trigger value.\n\ 464with two arguments: WINDOW, and the end trigger value.
465Afterwards the end-trigger value is reset to nil.") 465Afterwards the end-trigger value is reset to nil. */)
466 (window, value) 466 (window, value)
467 register Lisp_Object window, value; 467 register Lisp_Object window, value;
468{ 468{
469 register struct window *w; 469 register struct window *w;
@@ -474,12 +474,12 @@ Afterwards the end-trigger value is reset to nil.")
474} 474}
475 475
476DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0, 476DEFUN ("window-edges", Fwindow_edges, Swindow_edges, 0, 1, 0,
477 "Return a list of the edge coordinates of WINDOW.\n\ 477 doc: /* Return a list of the edge coordinates of WINDOW.
478\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.\n\ 478\(LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at top left corner of frame.
479RIGHT is one more than the rightmost column used by WINDOW,\n\ 479RIGHT is one more than the rightmost column used by WINDOW,
480and BOTTOM is one more than the bottommost row used by WINDOW\n\ 480and BOTTOM is one more than the bottommost row used by WINDOW
481 and its mode-line.") 481 and its mode-line. */)
482 (window) 482 (window)
483 Lisp_Object window; 483 Lisp_Object window;
484{ 484{
485 register struct window *w = decode_window (window); 485 register struct window *w = decode_window (window);
@@ -659,22 +659,22 @@ coordinates_in_window (w, x, y)
659 659
660 660
661DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p, 661DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
662 Scoordinates_in_window_p, 2, 2, 0, 662 Scoordinates_in_window_p, 2, 2, 0,
663 "Return non-nil if COORDINATES are in WINDOW.\n\ 663 doc: /* Return non-nil if COORDINATES are in WINDOW.
664COORDINATES is a cons of the form (X . Y), X and Y being distances\n\ 664COORDINATES is a cons of the form (X . Y), X and Y being distances
665measured in characters from the upper-left corner of the frame.\n\ 665measured in characters from the upper-left corner of the frame.
666\(0 . 0) denotes the character in the upper left corner of the\n\ 666\(0 . 0) denotes the character in the upper left corner of the
667frame.\n\ 667frame.
668If COORDINATES are in the text portion of WINDOW,\n\ 668If COORDINATES are in the text portion of WINDOW,
669 the coordinates relative to the window are returned.\n\ 669 the coordinates relative to the window are returned.
670If they are in the mode line of WINDOW, `mode-line' is returned.\n\ 670If they are in the mode line of WINDOW, `mode-line' is returned.
671If they are in the top mode line of WINDOW, `header-line' is returned.\n\ 671If they are in the top mode line of WINDOW, `header-line' is returned.
672If they are in the fringe to the left of the window,\n\ 672If they are in the fringe to the left of the window,
673 `left-fringe' is returned, if they are in the area on the right of\n\ 673 `left-fringe' is returned, if they are in the area on the right of
674 the window, `right-fringe' is returned.\n\ 674 the window, `right-fringe' is returned.
675If they are on the border between WINDOW and its right sibling,\n\ 675If they are on the border between WINDOW and its right sibling,
676 `vertical-line' is returned.") 676 `vertical-line' is returned. */)
677 (coordinates, window) 677 (coordinates, window)
678 register Lisp_Object coordinates, window; 678 register Lisp_Object coordinates, window;
679{ 679{
680 struct window *w; 680 struct window *w;
@@ -808,12 +808,12 @@ window_from_coordinates (f, x, y, part, tool_bar_p)
808} 808}
809 809
810DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0, 810DEFUN ("window-at", Fwindow_at, Swindow_at, 2, 3, 0,
811 "Return window containing coordinates X and Y on FRAME.\n\ 811 doc: /* Return window containing coordinates X and Y on FRAME.
812If omitted, FRAME defaults to the currently selected frame.\n\ 812If omitted, FRAME defaults to the currently selected frame.
813The top left corner of the frame is considered to be row 0,\n\ 813The top left corner of the frame is considered to be row 0,
814column 0.") 814column 0. */)
815 (x, y, frame) 815 (x, y, frame)
816 Lisp_Object x, y, frame; 816 Lisp_Object x, y, frame;
817{ 817{
818 int part; 818 int part;
819 struct frame *f; 819 struct frame *f;
@@ -834,16 +834,16 @@ column 0.")
834} 834}
835 835
836DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0, 836DEFUN ("window-point", Fwindow_point, Swindow_point, 0, 1, 0,
837 "Return current value of point in WINDOW.\n\ 837 doc: /* Return current value of point in WINDOW.
838For a nonselected window, this is the value point would have\n\ 838For a nonselected window, this is the value point would have
839if that window were selected.\n\ 839if that window were selected.
840\n\ 840
841Note that, when WINDOW is the selected window and its buffer\n\ 841Note that, when WINDOW is the selected window and its buffer
842is also currently selected, the value returned is the same as (point).\n\ 842is also currently selected, the value returned is the same as (point).
843It would be more strictly correct to return the `top-level' value\n\ 843It would be more strictly correct to return the `top-level' value
844of point, outside of any save-excursion forms.\n\ 844of point, outside of any save-excursion forms.
845But that is hard to define.") 845But that is hard to define. */)
846 (window) 846 (window)
847 Lisp_Object window; 847 Lisp_Object window;
848{ 848{
849 register struct window *w = decode_window (window); 849 register struct window *w = decode_window (window);
@@ -855,9 +855,9 @@ But that is hard to define.")
855} 855}
856 856
857DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0, 857DEFUN ("window-start", Fwindow_start, Swindow_start, 0, 1, 0,
858 "Return position at which display currently starts in WINDOW.\n\ 858 doc: /* Return position at which display currently starts in WINDOW.
859This is updated by redisplay or by calling `set-window-start'.") 859This is updated by redisplay or by calling `set-window-start'. */)
860 (window) 860 (window)
861 Lisp_Object window; 861 Lisp_Object window;
862{ 862{
863 return Fmarker_position (decode_window (window)->start); 863 return Fmarker_position (decode_window (window)->start);
@@ -865,23 +865,23 @@ This is updated by redisplay or by calling `set-window-start'.")
865 865
866/* This is text temporarily removed from the doc string below. 866/* This is text temporarily removed from the doc string below.
867 867
868This function returns nil if the position is not currently known.\n\ 868This function returns nil if the position is not currently known.
869That happens when redisplay is preempted and doesn't finish.\n\ 869That happens when redisplay is preempted and doesn't finish.
870If in that case you want to compute where the end of the window would\n\ 870If in that case you want to compute where the end of the window would
871have been if redisplay had finished, do this:\n\ 871have been if redisplay had finished, do this:
872 (save-excursion\n\ 872 (save-excursion
873 (goto-char (window-start window))\n\ 873 (goto-char (window-start window))
874 (vertical-motion (1- (window-height window)) window)\n\ 874 (vertical-motion (1- (window-height window)) window)
875 (point))") */ 875 (point))") */
876 876
877DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0, 877DEFUN ("window-end", Fwindow_end, Swindow_end, 0, 2, 0,
878 "Return position at which display currently ends in WINDOW.\n\ 878 doc: /* Return position at which display currently ends in WINDOW.
879This is updated by redisplay, when it runs to completion.\n\ 879This is updated by redisplay, when it runs to completion.
880Simply changing the buffer text or setting `window-start'\n\ 880Simply changing the buffer text or setting `window-start'
881does not update this value.\n\ 881does not update this value.
882If UPDATE is non-nil, compute the up-to-date position\n\ 882If UPDATE is non-nil, compute the up-to-date position
883if it isn't already recorded.") 883if it isn't already recorded. */)
884 (window, update) 884 (window, update)
885 Lisp_Object window, update; 885 Lisp_Object window, update;
886{ 886{
887 Lisp_Object value; 887 Lisp_Object value;
@@ -944,8 +944,8 @@ if it isn't already recorded.")
944} 944}
945 945
946DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0, 946DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
947 "Make point value in WINDOW be at position POS in WINDOW's buffer.") 947 doc: /* Make point value in WINDOW be at position POS in WINDOW's buffer. */)
948 (window, pos) 948 (window, pos)
949 Lisp_Object window, pos; 949 Lisp_Object window, pos;
950{ 950{
951 register struct window *w = decode_window (window); 951 register struct window *w = decode_window (window);
@@ -966,10 +966,10 @@ DEFUN ("set-window-point", Fset_window_point, Sset_window_point, 2, 2, 0,
966} 966}
967 967
968DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0, 968DEFUN ("set-window-start", Fset_window_start, Sset_window_start, 2, 3, 0,
969 "Make display in WINDOW start at position POS in WINDOW's buffer.\n\ 969 doc: /* Make display in WINDOW start at position POS in WINDOW's buffer.
970Optional third arg NOFORCE non-nil inhibits next redisplay\n\ 970Optional third arg NOFORCE non-nil inhibits next redisplay
971from overriding motion of point in order to display at this exact start.") 971from overriding motion of point in order to display at this exact start. */)
972 (window, pos, noforce) 972 (window, pos, noforce)
973 Lisp_Object window, pos, noforce; 973 Lisp_Object window, pos, noforce;
974{ 974{
975 register struct window *w = decode_window (window); 975 register struct window *w = decode_window (window);
@@ -991,9 +991,9 @@ from overriding motion of point in order to display at this exact start.")
991 991
992DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p, 992DEFUN ("window-dedicated-p", Fwindow_dedicated_p, Swindow_dedicated_p,
993 1, 1, 0, 993 1, 1, 0,
994 "Return WINDOW's dedicated object, usually t or nil.\n\ 994 doc: /* Return WINDOW's dedicated object, usually t or nil.
995See also `set-window-dedicated-p'.") 995See also `set-window-dedicated-p'. */)
996 (window) 996 (window)
997 Lisp_Object window; 997 Lisp_Object window;
998{ 998{
999 return decode_window (window)->dedicated; 999 return decode_window (window)->dedicated;
@@ -1001,13 +1001,13 @@ See also `set-window-dedicated-p'.")
1001 1001
1002DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p, 1002DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p,
1003 Sset_window_dedicated_p, 2, 2, 0, 1003 Sset_window_dedicated_p, 2, 2, 0,
1004 "Control whether WINDOW is dedicated to the buffer it displays.\n\ 1004 doc: /* Control whether WINDOW is dedicated to the buffer it displays.
1005If it is dedicated, Emacs will not automatically change\n\ 1005If it is dedicated, Emacs will not automatically change
1006which buffer appears in it.\n\ 1006which buffer appears in it.
1007The second argument is the new value for the dedication flag;\n\ 1007The second argument is the new value for the dedication flag;
1008non-nil means yes.") 1008non-nil means yes. */)
1009 (window, arg) 1009 (window, arg)
1010 Lisp_Object window, arg; 1010 Lisp_Object window, arg;
1011{ 1011{
1012 register struct window *w = decode_window (window); 1012 register struct window *w = decode_window (window);
1013 1013
@@ -1021,8 +1021,8 @@ non-nil means yes.")
1021 1021
1022DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table, 1022DEFUN ("window-display-table", Fwindow_display_table, Swindow_display_table,
1023 0, 1, 0, 1023 0, 1, 0,
1024 "Return the display-table that WINDOW is using.") 1024 doc: /* Return the display-table that WINDOW is using. */)
1025 (window) 1025 (window)
1026 Lisp_Object window; 1026 Lisp_Object window;
1027{ 1027{
1028 return decode_window (window)->display_table; 1028 return decode_window (window)->display_table;
@@ -1055,8 +1055,8 @@ window_display_table (w)
1055} 1055}
1056 1056
1057DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0, 1057DEFUN ("set-window-display-table", Fset_window_display_table, Sset_window_display_table, 2, 2, 0,
1058 "Set WINDOW's display-table to TABLE.") 1058 doc: /* Set WINDOW's display-table to TABLE. */)
1059 (window, table) 1059 (window, table)
1060 register Lisp_Object window, table; 1060 register Lisp_Object window, table;
1061{ 1061{
1062 register struct window *w; 1062 register struct window *w;
@@ -1171,8 +1171,8 @@ children be children of that parent instead. ***/
1171} 1171}
1172 1172
1173DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "", 1173DEFUN ("delete-window", Fdelete_window, Sdelete_window, 0, 1, "",
1174 "Remove WINDOW from the display. Default is selected window.") 1174 doc: /* Remove WINDOW from the display. Default is selected window. */)
1175 (window) 1175 (window)
1176 register Lisp_Object window; 1176 register Lisp_Object window;
1177{ 1177{
1178 delete_window (window); 1178 delete_window (window);
@@ -1558,83 +1558,66 @@ next_window (window, minibuf, all_frames, next_p)
1558} 1558}
1559 1559
1560 1560
1561/* This comment supplies the doc string for `next-window',
1562 for make-docfile to see. We cannot put this in the real DEFUN
1563 due to limits in the Unix cpp.
1564
1565DEFUN ("next-window", Ffoo, Sfoo, 0, 3, 0,
1566 "Return next window after WINDOW in canonical ordering of windows.\n\
1567If omitted, WINDOW defaults to the selected window.\n\
1568\n\
1569Optional second arg MINIBUF t means count the minibuffer window even\n\
1570if not active. MINIBUF nil or omitted means count the minibuffer iff\n\
1571it is active. MINIBUF neither t nor nil means not to count the\n\
1572minibuffer even if it is active.\n\
1573\n\
1574Several frames may share a single minibuffer; if the minibuffer\n\
1575counts, all windows on all frames that share that minibuffer count\n\
1576too. Therefore, `next-window' can be used to iterate through the\n\
1577set of windows even when the minibuffer is on another frame. If the\n\
1578minibuffer does not count, only windows from WINDOW's frame count.\n\
1579\n\
1580Optional third arg ALL-FRAMES t means include windows on all frames.\n\
1581ALL-FRAMES nil or omitted means cycle within the frames as specified\n\
1582above. ALL-FRAMES = `visible' means include windows on all visible frames.\n\
1583ALL-FRAMES = 0 means include windows on all visible and iconified frames.\n\
1584If ALL-FRAMES is a frame, restrict search to windows on that frame.\n\
1585Anything else means restrict to WINDOW's frame.\n\
1586\n\
1587If you use consistent values for MINIBUF and ALL-FRAMES, you can use\n\
1588`next-window' to iterate through the entire cycle of acceptable\n\
1589windows, eventually ending up back at the window you started with.\n\
1590`previous-window' traverses the same cycle, in the reverse order.")
1591 (window, minibuf, all_frames) */
1592
1593DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0, 1561DEFUN ("next-window", Fnext_window, Snext_window, 0, 3, 0,
1594 0) 1562 doc: /* Return next window after WINDOW in canonical ordering of windows.
1595 (window, minibuf, all_frames) 1563If omitted, WINDOW defaults to the selected window.
1564
1565Optional second arg MINIBUF t means count the minibuffer window even
1566if not active. MINIBUF nil or omitted means count the minibuffer iff
1567it is active. MINIBUF neither t nor nil means not to count the
1568minibuffer even if it is active.
1569
1570Several frames may share a single minibuffer; if the minibuffer
1571counts, all windows on all frames that share that minibuffer count
1572too. Therefore, `next-window' can be used to iterate through the
1573set of windows even when the minibuffer is on another frame. If the
1574minibuffer does not count, only windows from WINDOW's frame count.
1575
1576Optional third arg ALL-FRAMES t means include windows on all frames.
1577ALL-FRAMES nil or omitted means cycle within the frames as specified
1578above. ALL-FRAMES = `visible' means include windows on all visible frames.
1579ALL-FRAMES = 0 means include windows on all visible and iconified frames.
1580If ALL-FRAMES is a frame, restrict search to windows on that frame.
1581Anything else means restrict to WINDOW's frame.
1582
1583If you use consistent values for MINIBUF and ALL-FRAMES, you can use
1584`next-window' to iterate through the entire cycle of acceptable
1585windows, eventually ending up back at the window you started with.
1586`previous-window' traverses the same cycle, in the reverse order. */)
1587 (window, minibuf, all_frames)
1596 Lisp_Object window, minibuf, all_frames; 1588 Lisp_Object window, minibuf, all_frames;
1597{ 1589{
1598 return next_window (window, minibuf, all_frames, 1); 1590 return next_window (window, minibuf, all_frames, 1);
1599} 1591}
1600 1592
1601 1593
1602/* This comment supplies the doc string for `previous-window',
1603 for make-docfile to see. We cannot put this in the real DEFUN
1604 due to limits in the Unix cpp.
1605
1606DEFUN ("previous-window", Ffoo, Sfoo, 0, 3, 0,
1607 "Return the window preceding WINDOW in canonical ordering of windows.\n\
1608If omitted, WINDOW defaults to the selected window.\n\
1609\n\
1610Optional second arg MINIBUF t means count the minibuffer window even\n\
1611if not active. MINIBUF nil or omitted means count the minibuffer iff\n\
1612it is active. MINIBUF neither t nor nil means not to count the\n\
1613minibuffer even if it is active.\n\
1614\n\
1615Several frames may share a single minibuffer; if the minibuffer\n\
1616counts, all windows on all frames that share that minibuffer count\n\
1617too. Therefore, `previous-window' can be used to iterate through\n\
1618the set of windows even when the minibuffer is on another frame. If\n\
1619the minibuffer does not count, only windows from WINDOW's frame count\n\
1620\n\
1621Optional third arg ALL-FRAMES t means include windows on all frames.\n\
1622ALL-FRAMES nil or omitted means cycle within the frames as specified\n\
1623above. ALL-FRAMES = `visible' means include windows on all visible frames.\n\
1624ALL-FRAMES = 0 means include windows on all visible and iconified frames.\n\
1625If ALL-FRAMES is a frame, restrict search to windows on that frame.\n\
1626Anything else means restrict to WINDOW's frame.\n\
1627\n\
1628If you use consistent values for MINIBUF and ALL-FRAMES, you can use\n\
1629`previous-window' to iterate through the entire cycle of acceptable\n\
1630windows, eventually ending up back at the window you started with.\n\
1631`next-window' traverses the same cycle, in the reverse order.")
1632 (window, minibuf, all_frames) */
1633
1634
1635DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0, 1594DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
1636 0) 1595 doc: /* Return the window preceding WINDOW in canonical ordering of windows.
1637 (window, minibuf, all_frames) 1596If omitted, WINDOW defaults to the selected window.
1597
1598Optional second arg MINIBUF t means count the minibuffer window even
1599if not active. MINIBUF nil or omitted means count the minibuffer iff
1600it is active. MINIBUF neither t nor nil means not to count the
1601minibuffer even if it is active.
1602
1603Several frames may share a single minibuffer; if the minibuffer
1604counts, all windows on all frames that share that minibuffer count
1605too. Therefore, `previous-window' can be used to iterate through
1606the set of windows even when the minibuffer is on another frame. If
1607the minibuffer does not count, only windows from WINDOW's frame count
1608
1609Optional third arg ALL-FRAMES t means include windows on all frames.
1610ALL-FRAMES nil or omitted means cycle within the frames as specified
1611above. ALL-FRAMES = `visible' means include windows on all visible frames.
1612ALL-FRAMES = 0 means include windows on all visible and iconified frames.
1613If ALL-FRAMES is a frame, restrict search to windows on that frame.
1614Anything else means restrict to WINDOW's frame.
1615
1616If you use consistent values for MINIBUF and ALL-FRAMES, you can use
1617`previous-window' to iterate through the entire cycle of acceptable
1618windows, eventually ending up back at the window you started with.
1619`next-window' traverses the same cycle, in the reverse order. */)
1620 (window, minibuf, all_frames)
1638 Lisp_Object window, minibuf, all_frames; 1621 Lisp_Object window, minibuf, all_frames;
1639{ 1622{
1640 return next_window (window, minibuf, all_frames, 0); 1623 return next_window (window, minibuf, all_frames, 0);
@@ -1642,12 +1625,12 @@ DEFUN ("previous-window", Fprevious_window, Sprevious_window, 0, 3, 0,
1642 1625
1643 1626
1644DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p", 1627DEFUN ("other-window", Fother_window, Sother_window, 1, 2, "p",
1645 "Select the ARG'th different window on this frame.\n\ 1628 doc: /* Select the ARG'th different window on this frame.
1646All windows on current frame are arranged in a cyclic order.\n\ 1629All windows on current frame are arranged in a cyclic order.
1647This command selects the window ARG steps away in that order.\n\ 1630This command selects the window ARG steps away in that order.
1648A negative ARG moves in the opposite order. If the optional second\n\ 1631A negative ARG moves in the opposite order. If the optional second
1649argument ALL_FRAMES is non-nil, cycle through all frames.") 1632argument ALL_FRAMES is non-nil, cycle through all frames. */)
1650 (arg, all_frames) 1633 (arg, all_frames)
1651 Lisp_Object arg, all_frames; 1634 Lisp_Object arg, all_frames;
1652{ 1635{
1653 Lisp_Object window; 1636 Lisp_Object window;
@@ -1667,14 +1650,14 @@ argument ALL_FRAMES is non-nil, cycle through all frames.")
1667 1650
1668 1651
1669DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0, 1652DEFUN ("window-list", Fwindow_list, Swindow_list, 0, 3, 0,
1670 "Return a list of windows on FRAME, starting with WINDOW.\n\ 1653 doc: /* Return a list of windows on FRAME, starting with WINDOW.
1671FRAME nil or omitted means use the selected frame.\n\ 1654FRAME nil or omitted means use the selected frame.
1672WINDOW nil or omitted means use the selected window.\n\ 1655WINDOW nil or omitted means use the selected window.
1673MINIBUF t means include the minibuffer window, even if it isn't active.\n\ 1656MINIBUF t means include the minibuffer window, even if it isn't active.
1674MINIBUF nil or omitted means include the minibuffer window only\n\ 1657MINIBUF nil or omitted means include the minibuffer window only
1675if it's active.\n\ 1658if it's active.
1676MINIBUF neither nil nor t means never include the minibuffer window.") 1659MINIBUF neither nil nor t means never include the minibuffer window. */)
1677 (frame, minibuf, window) 1660 (frame, minibuf, window)
1678 Lisp_Object frame, minibuf, window; 1661 Lisp_Object frame, minibuf, window;
1679{ 1662{
1680 if (NILP (window)) 1663 if (NILP (window))
@@ -1942,14 +1925,14 @@ check_all_windows ()
1942} 1925}
1943 1926
1944DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 1, 0, 1927DEFUN ("get-lru-window", Fget_lru_window, Sget_lru_window, 0, 1, 0,
1945 "Return the window least recently selected or used for display.\n\ 1928 doc: /* Return the window least recently selected or used for display.
1946If optional argument FRAME is `visible', search all visible frames.\n\ 1929If optional argument FRAME is `visible', search all visible frames.
1947If FRAME is 0, search all visible and iconified frames.\n\ 1930If FRAME is 0, search all visible and iconified frames.
1948If FRAME is t, search all frames.\n\ 1931If FRAME is t, search all frames.
1949If FRAME is nil, search only the selected frame.\n\ 1932If FRAME is nil, search only the selected frame.
1950If FRAME is a frame, search only that frame.") 1933If FRAME is a frame, search only that frame. */)
1951 (frame) 1934 (frame)
1952 Lisp_Object frame; 1935 Lisp_Object frame;
1953{ 1936{
1954 register Lisp_Object w; 1937 register Lisp_Object w;
1955 /* First try for a window that is full-width */ 1938 /* First try for a window that is full-width */
@@ -1961,28 +1944,28 @@ If FRAME is a frame, search only that frame.")
1961} 1944}
1962 1945
1963DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 1, 0, 1946DEFUN ("get-largest-window", Fget_largest_window, Sget_largest_window, 0, 1, 0,
1964 "Return the largest window in area.\n\ 1947 doc: /* Return the largest window in area.
1965If optional argument FRAME is `visible', search all visible frames.\n\ 1948If optional argument FRAME is `visible', search all visible frames.
1966If FRAME is 0, search all visible and iconified frames.\n\ 1949If FRAME is 0, search all visible and iconified frames.
1967If FRAME is t, search all frames.\n\ 1950If FRAME is t, search all frames.
1968If FRAME is nil, search only the selected frame.\n\ 1951If FRAME is nil, search only the selected frame.
1969If FRAME is a frame, search only that frame.") 1952If FRAME is a frame, search only that frame. */)
1970 (frame) 1953 (frame)
1971 Lisp_Object frame; 1954 Lisp_Object frame;
1972{ 1955{
1973 return window_loop (GET_LARGEST_WINDOW, Qnil, 0, 1956 return window_loop (GET_LARGEST_WINDOW, Qnil, 0,
1974 frame); 1957 frame);
1975} 1958}
1976 1959
1977DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 1, 2, 0, 1960DEFUN ("get-buffer-window", Fget_buffer_window, Sget_buffer_window, 1, 2, 0,
1978 "Return a window currently displaying BUFFER, or nil if none.\n\ 1961 doc: /* Return a window currently displaying BUFFER, or nil if none.
1979If optional argument FRAME is `visible', search all visible frames.\n\ 1962If optional argument FRAME is `visible', search all visible frames.
1980If optional argument FRAME is 0, search all visible and iconified frames.\n\ 1963If optional argument FRAME is 0, search all visible and iconified frames.
1981If FRAME is t, search all frames.\n\ 1964If FRAME is t, search all frames.
1982If FRAME is nil, search only the selected frame.\n\ 1965If FRAME is nil, search only the selected frame.
1983If FRAME is a frame, search only that frame.") 1966If FRAME is a frame, search only that frame. */)
1984 (buffer, frame) 1967 (buffer, frame)
1985 Lisp_Object buffer, frame; 1968 Lisp_Object buffer, frame;
1986{ 1969{
1987 buffer = Fget_buffer (buffer); 1970 buffer = Fget_buffer (buffer);
1988 if (BUFFERP (buffer)) 1971 if (BUFFERP (buffer))
@@ -1992,16 +1975,16 @@ If FRAME is a frame, search only that frame.")
1992} 1975}
1993 1976
1994DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows, 1977DEFUN ("delete-other-windows", Fdelete_other_windows, Sdelete_other_windows,
1995 0, 1, "", 1978 0, 1, "",
1996 "Make WINDOW (or the selected window) fill its frame.\n\ 1979 doc: /* Make WINDOW (or the selected window) fill its frame.
1997Only the frame WINDOW is on is affected.\n\ 1980Only the frame WINDOW is on is affected.
1998This function tries to reduce display jumps\n\ 1981This function tries to reduce display jumps
1999by keeping the text previously visible in WINDOW\n\ 1982by keeping the text previously visible in WINDOW
2000in the same place on the frame. Doing this depends on\n\ 1983in the same place on the frame. Doing this depends on
2001the value of (window-start WINDOW), so if calling this function\n\ 1984the value of (window-start WINDOW), so if calling this function
2002in a program gives strange scrolling, make sure the window-start\n\ 1985in a program gives strange scrolling, make sure the window-start
2003value is reasonable when this function is called.") 1986value is reasonable when this function is called. */)
2004 (window) 1987 (window)
2005 Lisp_Object window; 1988 Lisp_Object window;
2006{ 1989{
2007 struct window *w; 1990 struct window *w;
@@ -2056,15 +2039,15 @@ value is reasonable when this function is called.")
2056} 2039}
2057 2040
2058DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on, 2041DEFUN ("delete-windows-on", Fdelete_windows_on, Sdelete_windows_on,
2059 1, 2, "bDelete windows on (buffer): ", 2042 1, 2, "bDelete windows on (buffer): ",
2060 "Delete all windows showing BUFFER.\n\ 2043 doc: /* Delete all windows showing BUFFER.
2061Optional second argument FRAME controls which frames are affected.\n\ 2044Optional second argument FRAME controls which frames are affected.
2062If optional argument FRAME is `visible', search all visible frames.\n\ 2045If optional argument FRAME is `visible', search all visible frames.
2063If FRAME is 0, search all visible and iconified frames.\n\ 2046If FRAME is 0, search all visible and iconified frames.
2064If FRAME is nil, search all frames.\n\ 2047If FRAME is nil, search all frames.
2065If FRAME is t, search only the selected frame.\n\ 2048If FRAME is t, search only the selected frame.
2066If FRAME is a frame, search only that frame.") 2049If FRAME is a frame, search only that frame. */)
2067 (buffer, frame) 2050 (buffer, frame)
2068 Lisp_Object buffer, frame; 2051 Lisp_Object buffer, frame;
2069{ 2052{
2070 /* FRAME uses t and nil to mean the opposite of what window_loop 2053 /* FRAME uses t and nil to mean the opposite of what window_loop
@@ -2085,10 +2068,10 @@ If FRAME is a frame, search only that frame.")
2085} 2068}
2086 2069
2087DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows, 2070DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows,
2088 Sreplace_buffer_in_windows, 2071 Sreplace_buffer_in_windows,
2089 1, 1, "bReplace buffer in windows: ", 2072 1, 1, "bReplace buffer in windows: ",
2090 "Replace BUFFER with some other buffer in all windows showing it.") 2073 doc: /* Replace BUFFER with some other buffer in all windows showing it. */)
2091 (buffer) 2074 (buffer)
2092 Lisp_Object buffer; 2075 Lisp_Object buffer;
2093{ 2076{
2094 if (!NILP (buffer)) 2077 if (!NILP (buffer))
@@ -2671,9 +2654,9 @@ set_window_buffer (window, buffer, run_hooks_p)
2671 2654
2672 2655
2673DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 2, 0, 2656DEFUN ("set-window-buffer", Fset_window_buffer, Sset_window_buffer, 2, 2, 0,
2674 "Make WINDOW display BUFFER as its contents.\n\ 2657 doc: /* Make WINDOW display BUFFER as its contents.
2675BUFFER can be a buffer or buffer name.") 2658BUFFER can be a buffer or buffer name. */)
2676 (window, buffer) 2659 (window, buffer)
2677 register Lisp_Object window, buffer; 2660 register Lisp_Object window, buffer;
2678{ 2661{
2679 register Lisp_Object tem; 2662 register Lisp_Object tem;
@@ -2704,11 +2687,11 @@ BUFFER can be a buffer or buffer name.")
2704} 2687}
2705 2688
2706DEFUN ("select-window", Fselect_window, Sselect_window, 1, 1, 0, 2689DEFUN ("select-window", Fselect_window, Sselect_window, 1, 1, 0,
2707 "Select WINDOW. Most editing will apply to WINDOW's buffer.\n\ 2690 doc: /* Select WINDOW. Most editing will apply to WINDOW's buffer.
2708If WINDOW is not already selected, also make WINDOW's buffer current.\n\ 2691If WINDOW is not already selected, also make WINDOW's buffer current.
2709Note that the main editor command loop\n\ 2692Note that the main editor command loop
2710selects the buffer of the selected window before each command.") 2693selects the buffer of the selected window before each command. */)
2711 (window) 2694 (window)
2712 register Lisp_Object window; 2695 register Lisp_Object window;
2713{ 2696{
2714 return select_window_1 (window, 1); 2697 return select_window_1 (window, 1);
@@ -2814,11 +2797,11 @@ display_buffer_1 (window)
2814} 2797}
2815 2798
2816DEFUN ("special-display-p", Fspecial_display_p, Sspecial_display_p, 1, 1, 0, 2799DEFUN ("special-display-p", Fspecial_display_p, Sspecial_display_p, 1, 1, 0,
2817 "Returns non-nil if a buffer named BUFFER-NAME would be created specially.\n\ 2800 doc: /* Returns non-nil if a buffer named BUFFER-NAME would be created specially.
2818The value is actually t if the frame should be called with default frame\n\ 2801The value is actually t if the frame should be called with default frame
2819parameters, and a list of frame parameters if they were specified.\n\ 2802parameters, and a list of frame parameters if they were specified.
2820See `special-display-buffer-names', and `special-display-regexps'.") 2803See `special-display-buffer-names', and `special-display-regexps'. */)
2821 (buffer_name) 2804 (buffer_name)
2822 Lisp_Object buffer_name; 2805 Lisp_Object buffer_name;
2823{ 2806{
2824 Lisp_Object tem; 2807 Lisp_Object tem;
@@ -2848,9 +2831,9 @@ See `special-display-buffer-names', and `special-display-regexps'.")
2848} 2831}
2849 2832
2850DEFUN ("same-window-p", Fsame_window_p, Ssame_window_p, 1, 1, 0, 2833DEFUN ("same-window-p", Fsame_window_p, Ssame_window_p, 1, 1, 0,
2851 "Returns non-nil if a new buffer named BUFFER-NAME would use the same window.\n\ 2834 doc: /* Returns non-nil if a new buffer named BUFFER-NAME would use the same window.
2852See `same-window-buffer-names' and `same-window-regexps'.") 2835See `same-window-buffer-names' and `same-window-regexps'. */)
2853 (buffer_name) 2836 (buffer_name)
2854 Lisp_Object buffer_name; 2837 Lisp_Object buffer_name;
2855{ 2838{
2856 Lisp_Object tem; 2839 Lisp_Object tem;
@@ -2879,36 +2862,36 @@ See `same-window-buffer-names' and `same-window-regexps'.")
2879 return Qnil; 2862 return Qnil;
2880} 2863}
2881 2864
2882 /* Use B so the default is (other-buffer). */ 2865/* Use B so the default is (other-buffer). */
2883DEFUN ("display-buffer", Fdisplay_buffer, Sdisplay_buffer, 1, 3, 2866DEFUN ("display-buffer", Fdisplay_buffer, Sdisplay_buffer, 1, 3,
2884 "BDisplay buffer: \nP", 2867 "BDisplay buffer: \nP",
2885 "Make BUFFER appear in some window but don't select it.\n\ 2868 doc: /* Make BUFFER appear in some window but don't select it.
2886BUFFER can be a buffer or a buffer name.\n\ 2869BUFFER can be a buffer or a buffer name.
2887If BUFFER is shown already in some window, just use that one,\n\ 2870If BUFFER is shown already in some window, just use that one,
2888unless the window is the selected window and the optional second\n\ 2871unless the window is the selected window and the optional second
2889argument NOT-THIS-WINDOW is non-nil (interactively, with prefix arg).\n\ 2872argument NOT-THIS-WINDOW is non-nil (interactively, with prefix arg).
2890If `pop-up-frames' is non-nil, make a new frame if no window shows BUFFER.\n\ 2873If `pop-up-frames' is non-nil, make a new frame if no window shows BUFFER.
2891Returns the window displaying BUFFER.\n\ 2874Returns the window displaying BUFFER.
2892If `display-reuse-frames' is non-nil, and another frame is currently\n\ 2875If `display-reuse-frames' is non-nil, and another frame is currently
2893displaying BUFFER, then simply raise that frame.\n\ 2876displaying BUFFER, then simply raise that frame.
2894\n\ 2877
2895The variables `special-display-buffer-names', `special-display-regexps',\n\ 2878The variables `special-display-buffer-names', `special-display-regexps',
2896`same-window-buffer-names', and `same-window-regexps' customize how certain\n\ 2879`same-window-buffer-names', and `same-window-regexps' customize how certain
2897buffer names are handled.\n\ 2880buffer names are handled.
2898\n\ 2881
2899If optional argument FRAME is `visible', search all visible frames.\n\ 2882If optional argument FRAME is `visible', search all visible frames.
2900If FRAME is 0, search all visible and iconified frames.\n\ 2883If FRAME is 0, search all visible and iconified frames.
2901If FRAME is t, search all frames.\n\ 2884If FRAME is t, search all frames.
2902If FRAME is a frame, search only that frame.\n\ 2885If FRAME is a frame, search only that frame.
2903If FRAME is nil, search only the selected frame\n\ 2886If FRAME is nil, search only the selected frame
2904 (actually the last nonminibuffer frame),\n\ 2887 (actually the last nonminibuffer frame),
2905 unless `pop-up-frames' or `display-buffer-reuse-frames' is non-nil,\n\ 2888 unless `pop-up-frames' or `display-buffer-reuse-frames' is non-nil,
2906 which means search visible and iconified frames.\n\ 2889 which means search visible and iconified frames.
2907\n\ 2890
2908If `even-window-heights' is non-nil, window heights will be evened out\n\ 2891If `even-window-heights' is non-nil, window heights will be evened out
2909if displaying the buffer causes two vertically adjacent windows to be\n\ 2892if displaying the buffer causes two vertically adjacent windows to be
2910displayed.") 2893displayed. */)
2911 (buffer, not_this_window, frame) 2894 (buffer, not_this_window, frame)
2912 register Lisp_Object buffer, not_this_window, frame; 2895 register Lisp_Object buffer, not_this_window, frame;
2913{ 2896{
2914 register Lisp_Object window, tem, swp; 2897 register Lisp_Object window, tem, swp;
@@ -3170,12 +3153,12 @@ make_dummy_parent (window)
3170} 3153}
3171 3154
3172DEFUN ("split-window", Fsplit_window, Ssplit_window, 0, 3, "", 3155DEFUN ("split-window", Fsplit_window, Ssplit_window, 0, 3, "",
3173 "Split WINDOW, putting SIZE lines in the first of the pair.\n\ 3156 doc: /* Split WINDOW, putting SIZE lines in the first of the pair.
3174WINDOW defaults to selected one and SIZE to half its size.\n\ 3157WINDOW defaults to selected one and SIZE to half its size.
3175If optional third arg HORFLAG is non-nil, split side by side\n\ 3158If optional third arg HORFLAG is non-nil, split side by side
3176and put SIZE columns in the first of the pair. In that case,\n\ 3159and put SIZE columns in the first of the pair. In that case,
3177SIZE includes that window's scroll bar, or the divider column to its right.") 3160SIZE includes that window's scroll bar, or the divider column to its right. */)
3178 (window, size, horflag) 3161 (window, size, horflag)
3179 Lisp_Object window, size, horflag; 3162 Lisp_Object window, size, horflag;
3180{ 3163{
3181 register Lisp_Object new; 3164 register Lisp_Object new;
@@ -3293,10 +3276,10 @@ SIZE includes that window's scroll bar, or the divider column to its right.")
3293} 3276}
3294 3277
3295DEFUN ("enlarge-window", Fenlarge_window, Senlarge_window, 1, 2, "p", 3278DEFUN ("enlarge-window", Fenlarge_window, Senlarge_window, 1, 2, "p",
3296 "Make current window ARG lines bigger.\n\ 3279 doc: /* Make current window ARG lines bigger.
3297From program, optional second arg non-nil means grow sideways ARG columns.\n\ 3280From program, optional second arg non-nil means grow sideways ARG columns.
3298Interactively, if an argument is not given, make the window one line bigger.") 3281Interactively, if an argument is not given, make the window one line bigger. */)
3299 (arg, side) 3282 (arg, side)
3300 register Lisp_Object arg, side; 3283 register Lisp_Object arg, side;
3301{ 3284{
3302 CHECK_NUMBER (arg, 0); 3285 CHECK_NUMBER (arg, 0);
@@ -3309,10 +3292,10 @@ Interactively, if an argument is not given, make the window one line bigger.")
3309} 3292}
3310 3293
3311DEFUN ("shrink-window", Fshrink_window, Sshrink_window, 1, 2, "p", 3294DEFUN ("shrink-window", Fshrink_window, Sshrink_window, 1, 2, "p",
3312 "Make current window ARG lines smaller.\n\ 3295 doc: /* Make current window ARG lines smaller.
3313From program, optional second arg non-nil means shrink sideways arg columns.\n\ 3296From program, optional second arg non-nil means shrink sideways arg columns.
3314Interactively, if an argument is not given, make the window one line smaller.") 3297Interactively, if an argument is not given, make the window one line smaller. */)
3315 (arg, side) 3298 (arg, side)
3316 register Lisp_Object arg, side; 3299 register Lisp_Object arg, side;
3317{ 3300{
3318 CHECK_NUMBER (arg, 0); 3301 CHECK_NUMBER (arg, 0);
@@ -4308,12 +4291,12 @@ scroll_command (n, direction)
4308} 4291}
4309 4292
4310DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "P", 4293DEFUN ("scroll-up", Fscroll_up, Sscroll_up, 0, 1, "P",
4311 "Scroll text of current window upward ARG lines; or near full screen if no ARG.\n\ 4294 doc: /* Scroll text of current window upward ARG lines; or near full screen if no ARG.
4312A near full screen is `next-screen-context-lines' less than a full screen.\n\ 4295A near full screen is `next-screen-context-lines' less than a full screen.
4313Negative ARG means scroll downward.\n\ 4296Negative ARG means scroll downward.
4314If ARG is the atom `-', scroll downward by nearly full screen.\n\ 4297If ARG is the atom `-', scroll downward by nearly full screen.
4315When calling from a program, supply as argument a number, nil, or `-'.") 4298When calling from a program, supply as argument a number, nil, or `-'. */)
4316 (arg) 4299 (arg)
4317 Lisp_Object arg; 4300 Lisp_Object arg;
4318{ 4301{
4319 scroll_command (arg, 1); 4302 scroll_command (arg, 1);
@@ -4321,12 +4304,12 @@ When calling from a program, supply as argument a number, nil, or `-'.")
4321} 4304}
4322 4305
4323DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "P", 4306DEFUN ("scroll-down", Fscroll_down, Sscroll_down, 0, 1, "P",
4324 "Scroll text of current window down ARG lines; or near full screen if no ARG.\n\ 4307 doc: /* Scroll text of current window down ARG lines; or near full screen if no ARG.
4325A near full screen is `next-screen-context-lines' less than a full screen.\n\ 4308A near full screen is `next-screen-context-lines' less than a full screen.
4326Negative ARG means scroll upward.\n\ 4309Negative ARG means scroll upward.
4327If ARG is the atom `-', scroll upward by nearly full screen.\n\ 4310If ARG is the atom `-', scroll upward by nearly full screen.
4328When calling from a program, supply as argument a number, nil, or `-'.") 4311When calling from a program, supply as argument a number, nil, or `-'. */)
4329 (arg) 4312 (arg)
4330 Lisp_Object arg; 4313 Lisp_Object arg;
4331{ 4314{
4332 scroll_command (arg, -1); 4315 scroll_command (arg, -1);
@@ -4334,12 +4317,12 @@ When calling from a program, supply as argument a number, nil, or `-'.")
4334} 4317}
4335 4318
4336DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0, 4319DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, Sother_window_for_scrolling, 0, 0, 0,
4337 "Return the other window for \"other window scroll\" commands.\n\ 4320 doc: /* Return the other window for \"other window scroll\" commands.
4338If in the minibuffer, `minibuffer-scroll-window' if non-nil\n\ 4321If in the minibuffer, `minibuffer-scroll-window' if non-nil
4339specifies the window.\n\ 4322specifies the window.
4340If `other-window-scroll-buffer' is non-nil, a window\n\ 4323If `other-window-scroll-buffer' is non-nil, a window
4341showing that buffer is used.") 4324showing that buffer is used. */)
4342 () 4325 ()
4343{ 4326{
4344 Lisp_Object window; 4327 Lisp_Object window;
4345 4328
@@ -4377,18 +4360,18 @@ showing that buffer is used.")
4377} 4360}
4378 4361
4379DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P", 4362DEFUN ("scroll-other-window", Fscroll_other_window, Sscroll_other_window, 0, 1, "P",
4380 "Scroll next window upward ARG lines; or near full screen if no ARG.\n\ 4363 doc: /* Scroll next window upward ARG lines; or near full screen if no ARG.
4381A near full screen is `next-screen-context-lines' less than a full screen.\n\ 4364A near full screen is `next-screen-context-lines' less than a full screen.
4382The next window is the one below the current one; or the one at the top\n\ 4365The next window is the one below the current one; or the one at the top
4383if the current one is at the bottom. Negative ARG means scroll downward.\n\ 4366if the current one is at the bottom. Negative ARG means scroll downward.
4384If ARG is the atom `-', scroll downward by nearly full screen.\n\ 4367If ARG is the atom `-', scroll downward by nearly full screen.
4385When calling from a program, supply as argument a number, nil, or `-'.\n\ 4368When calling from a program, supply as argument a number, nil, or `-'.
4386\n\ 4369
4387If in the minibuffer, `minibuffer-scroll-window' if non-nil\n\ 4370If in the minibuffer, `minibuffer-scroll-window' if non-nil
4388specifies the window to scroll.\n\ 4371specifies the window to scroll.
4389If `other-window-scroll-buffer' is non-nil, scroll the window\n\ 4372If `other-window-scroll-buffer' is non-nil, scroll the window
4390showing that buffer, popping the buffer up if necessary.") 4373showing that buffer, popping the buffer up if necessary. */)
4391 (arg) 4374 (arg)
4392 Lisp_Object arg; 4375 Lisp_Object arg;
4393{ 4376{
4394 Lisp_Object window; 4377 Lisp_Object window;
@@ -4424,9 +4407,9 @@ showing that buffer, popping the buffer up if necessary.")
4424} 4407}
4425 4408
4426DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 1, "P", 4409DEFUN ("scroll-left", Fscroll_left, Sscroll_left, 0, 1, "P",
4427 "Scroll selected window display ARG columns left.\n\ 4410 doc: /* Scroll selected window display ARG columns left.
4428Default for ARG is window width minus 2.") 4411Default for ARG is window width minus 2. */)
4429 (arg) 4412 (arg)
4430 register Lisp_Object arg; 4413 register Lisp_Object arg;
4431{ 4414{
4432 Lisp_Object result; 4415 Lisp_Object result;
@@ -4448,9 +4431,9 @@ Default for ARG is window width minus 2.")
4448} 4431}
4449 4432
4450DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 1, "P", 4433DEFUN ("scroll-right", Fscroll_right, Sscroll_right, 0, 1, "P",
4451 "Scroll selected window display ARG columns right.\n\ 4434 doc: /* Scroll selected window display ARG columns right.
4452Default for ARG is window width minus 2.") 4435Default for ARG is window width minus 2. */)
4453 (arg) 4436 (arg)
4454 register Lisp_Object arg; 4437 register Lisp_Object arg;
4455{ 4438{
4456 Lisp_Object result; 4439 Lisp_Object result;
@@ -4521,16 +4504,16 @@ displayed_window_lines (w)
4521 4504
4522 4505
4523DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P", 4506DEFUN ("recenter", Frecenter, Srecenter, 0, 1, "P",
4524 "Center point in window and redisplay frame.\n\ 4507 doc: /* Center point in window and redisplay frame.
4525With prefix argument ARG, recenter putting point on screen line ARG\n\ 4508With prefix argument ARG, recenter putting point on screen line ARG
4526relative to the current window. If ARG is negative, it counts up from the\n\ 4509relative to the current window. If ARG is negative, it counts up from the
4527bottom of the window. (ARG should be less than the height of the window.)\n\ 4510bottom of the window. (ARG should be less than the height of the window.)
4528\n\ 4511
4529If ARG is omitted or nil, erase the entire frame and then\n\ 4512If ARG is omitted or nil, erase the entire frame and then
4530redraw with point in the center of the current window.\n\ 4513redraw with point in the center of the current window.
4531Just C-u as prefix means put point in the center of the window\n\ 4514Just C-u as prefix means put point in the center of the window
4532and redisplay normally--don't erase and redraw the frame.") 4515and redisplay normally--don't erase and redraw the frame. */)
4533 (arg) 4516 (arg)
4534 register Lisp_Object arg; 4517 register Lisp_Object arg;
4535{ 4518{
4536 struct window *w = XWINDOW (selected_window); 4519 struct window *w = XWINDOW (selected_window);
@@ -4646,11 +4629,11 @@ and redisplay normally--don't erase and redraw the frame.")
4646 4629
4647 4630
4648DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height, 4631DEFUN ("window-text-height", Fwindow_text_height, Swindow_text_height,
4649 0, 1, 0, 4632 0, 1, 0,
4650 "Return the height in lines of the text display area of WINDOW.\n\ 4633 doc: /* Return the height in lines of the text display area of WINDOW.
4651This doesn't include the mode-line (or header-line if any) or any\n\ 4634This doesn't include the mode-line (or header-line if any) or any
4652partial-height lines in the text display area.") 4635partial-height lines in the text display area. */)
4653 (window) 4636 (window)
4654 Lisp_Object window; 4637 Lisp_Object window;
4655{ 4638{
4656 struct window *w = decode_window (window); 4639 struct window *w = decode_window (window);
@@ -4662,12 +4645,12 @@ partial-height lines in the text display area.")
4662 4645
4663 4646
4664DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line, 4647DEFUN ("move-to-window-line", Fmove_to_window_line, Smove_to_window_line,
4665 1, 1, "P", 4648 1, 1, "P",
4666 "Position point relative to window.\n\ 4649 doc: /* Position point relative to window.
4667With no argument, position point at center of window.\n\ 4650With no argument, position point at center of window.
4668An argument specifies vertical position within the window;\n\ 4651An argument specifies vertical position within the window;
4669zero means top of window, negative means relative to bottom of window.") 4652zero means top of window, negative means relative to bottom of window. */)
4670 (arg) 4653 (arg)
4671 Lisp_Object arg; 4654 Lisp_Object arg;
4672{ 4655{
4673 struct window *w = XWINDOW (selected_window); 4656 struct window *w = XWINDOW (selected_window);
@@ -4752,8 +4735,8 @@ struct saved_window
4752 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)]))) 4735 ((struct saved_window *) (XVECTOR ((swv)->contents[(n)])))
4753 4736
4754DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0, 4737DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_p, 1, 1, 0,
4755 "Return t if OBJECT is a window-configuration object.") 4738 doc: /* Return t if OBJECT is a window-configuration object. */)
4756 (object) 4739 (object)
4757 Lisp_Object object; 4740 Lisp_Object object;
4758{ 4741{
4759 if (WINDOW_CONFIGURATIONP (object)) 4742 if (WINDOW_CONFIGURATIONP (object))
@@ -4762,8 +4745,8 @@ DEFUN ("window-configuration-p", Fwindow_configuration_p, Swindow_configuration_
4762} 4745}
4763 4746
4764DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0, 4747DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_configuration_frame, 1, 1, 0,
4765 "Return the frame that CONFIG, a window-configuration object, is about.") 4748 doc: /* Return the frame that CONFIG, a window-configuration object, is about. */)
4766 (config) 4749 (config)
4767 Lisp_Object config; 4750 Lisp_Object config;
4768{ 4751{
4769 register struct save_window_data *data; 4752 register struct save_window_data *data;
@@ -4778,14 +4761,14 @@ DEFUN ("window-configuration-frame", Fwindow_configuration_frame, Swindow_config
4778} 4761}
4779 4762
4780DEFUN ("set-window-configuration", Fset_window_configuration, 4763DEFUN ("set-window-configuration", Fset_window_configuration,
4781 Sset_window_configuration, 1, 1, 0, 4764 Sset_window_configuration, 1, 1, 0,
4782 "Set the configuration of windows and buffers as specified by CONFIGURATION.\n\ 4765 doc: /* Set the configuration of windows and buffers as specified by CONFIGURATION.
4783CONFIGURATION must be a value previously returned\n\ 4766CONFIGURATION must be a value previously returned
4784by `current-window-configuration' (which see).\n\ 4767by `current-window-configuration' (which see).
4785If CONFIGURATION was made from a frame that is now deleted,\n\ 4768If CONFIGURATION was made from a frame that is now deleted,
4786only frame-independent values can be restored. In this case,\n\ 4769only frame-independent values can be restored. In this case,
4787the return value is nil. Otherwise the value is t.") 4770the return value is nil. Otherwise the value is t. */)
4788 (configuration) 4771 (configuration)
4789 Lisp_Object configuration; 4772 Lisp_Object configuration;
4790{ 4773{
4791 register struct save_window_data *data; 4774 register struct save_window_data *data;
@@ -5257,16 +5240,16 @@ save_window_save (window, vector, i)
5257} 5240}
5258 5241
5259DEFUN ("current-window-configuration", Fcurrent_window_configuration, 5242DEFUN ("current-window-configuration", Fcurrent_window_configuration,
5260 Scurrent_window_configuration, 0, 1, 0, 5243 Scurrent_window_configuration, 0, 1, 0,
5261 "Return an object representing the current window configuration of FRAME.\n\ 5244 doc: /* Return an object representing the current window configuration of FRAME.
5262If FRAME is nil or omitted, use the selected frame.\n\ 5245If FRAME is nil or omitted, use the selected frame.
5263This describes the number of windows, their sizes and current buffers,\n\ 5246This describes the number of windows, their sizes and current buffers,
5264and for each displayed buffer, where display starts, and the positions of\n\ 5247and for each displayed buffer, where display starts, and the positions of
5265point and mark. An exception is made for point in the current buffer:\n\ 5248point and mark. An exception is made for point in the current buffer:
5266its value is -not- saved.\n\ 5249its value is -not- saved.
5267This also records the currently selected frame, and FRAME's focus\n\ 5250This also records the currently selected frame, and FRAME's focus
5268redirection (see `redirect-frame-focus').") 5251redirection (see `redirect-frame-focus'). */)
5269 (frame) 5252 (frame)
5270 Lisp_Object frame; 5253 Lisp_Object frame;
5271{ 5254{
5272 register Lisp_Object tem; 5255 register Lisp_Object tem;
@@ -5308,14 +5291,14 @@ redirection (see `redirect-frame-focus').")
5308} 5291}
5309 5292
5310DEFUN ("save-window-excursion", Fsave_window_excursion, Ssave_window_excursion, 5293DEFUN ("save-window-excursion", Fsave_window_excursion, Ssave_window_excursion,
5311 0, UNEVALLED, 0, 5294 0, UNEVALLED, 0,
5312 "Execute body, preserving window sizes and contents.\n\ 5295 doc: /* Execute body, preserving window sizes and contents.
5313Restore which buffer appears in which window, where display starts,\n\ 5296Restore which buffer appears in which window, where display starts,
5314and the value of point and mark for each window.\n\ 5297and the value of point and mark for each window.
5315Also restore the choice of selected window.\n\ 5298Also restore the choice of selected window.
5316Also restore which buffer is current.\n\ 5299Also restore which buffer is current.
5317Does not restore the value of point in current buffer.") 5300Does not restore the value of point in current buffer. */)
5318 (args) 5301 (args)
5319 Lisp_Object args; 5302 Lisp_Object args;
5320{ 5303{
5321 register Lisp_Object val; 5304 register Lisp_Object val;
@@ -5334,13 +5317,13 @@ Does not restore the value of point in current buffer.")
5334 5317
5335DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins, 5318DEFUN ("set-window-margins", Fset_window_margins, Sset_window_margins,
5336 2, 3, 0, 5319 2, 3, 0,
5337 "Set width of marginal areas of window WINDOW.\n\ 5320 doc: /* Set width of marginal areas of window WINDOW.
5338If window is nil, set margins of the currently selected window.\n\ 5321If window is nil, set margins of the currently selected window.
5339First parameter LEFT-WIDTH specifies the number of character\n\ 5322First parameter LEFT-WIDTH specifies the number of character
5340cells to reserve for the left marginal area. Second parameter\n\ 5323cells to reserve for the left marginal area. Second parameter
5341RIGHT-WIDTH does the same for the right marginal area.\n\ 5324RIGHT-WIDTH does the same for the right marginal area.
5342A nil width parameter means no margin.") 5325A nil width parameter means no margin. */)
5343 (window, left, right) 5326 (window, left, right)
5344 Lisp_Object window, left, right; 5327 Lisp_Object window, left, right;
5345{ 5328{
5346 struct window *w = decode_window (window); 5329 struct window *w = decode_window (window);
@@ -5375,12 +5358,12 @@ A nil width parameter means no margin.")
5375 5358
5376DEFUN ("window-margins", Fwindow_margins, Swindow_margins, 5359DEFUN ("window-margins", Fwindow_margins, Swindow_margins,
5377 0, 1, 0, 5360 0, 1, 0,
5378 "Get width of marginal areas of window WINDOW.\n\ 5361 doc: /* Get width of marginal areas of window WINDOW.
5379If WINDOW is omitted or nil, use the currently selected window.\n\ 5362If WINDOW is omitted or nil, use the currently selected window.
5380Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).\n\ 5363Value is a cons of the form (LEFT-WIDTH . RIGHT-WIDTH).
5381If a marginal area does not exist, its width will be returned\n\ 5364If a marginal area does not exist, its width will be returned
5382as nil.") 5365as nil. */)
5383 (window) 5366 (window)
5384 Lisp_Object window; 5367 Lisp_Object window;
5385{ 5368{
5386 struct window *w = decode_window (window); 5369 struct window *w = decode_window (window);
@@ -5394,10 +5377,10 @@ as nil.")
5394 ***********************************************************************/ 5377 ***********************************************************************/
5395 5378
5396DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 1, 0, 5379DEFUN ("window-vscroll", Fwindow_vscroll, Swindow_vscroll, 0, 1, 0,
5397 "Return the amount by which WINDOW is scrolled vertically.\n\ 5380 doc: /* Return the amount by which WINDOW is scrolled vertically.
5398Use the selected window if WINDOW is nil or omitted.\n\ 5381Use the selected window if WINDOW is nil or omitted.
5399Value is a multiple of the canonical character height of WINDOW.") 5382Value is a multiple of the canonical character height of WINDOW. */)
5400 (window) 5383 (window)
5401 Lisp_Object window; 5384 Lisp_Object window;
5402{ 5385{
5403 Lisp_Object result; 5386 Lisp_Object result;
@@ -5421,10 +5404,10 @@ Value is a multiple of the canonical character height of WINDOW.")
5421 5404
5422DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll, 5405DEFUN ("set-window-vscroll", Fset_window_vscroll, Sset_window_vscroll,
5423 2, 2, 0, 5406 2, 2, 0,
5424 "Set amount by which WINDOW should be scrolled vertically to VSCROLL.\n\ 5407 doc: /* Set amount by which WINDOW should be scrolled vertically to VSCROLL.
5425WINDOW nil or omitted means use the selected window. VSCROLL is a\n\ 5408WINDOW nil or omitted means use the selected window. VSCROLL is a
5426non-negative multiple of the canonical character height of WINDOW.") 5409non-negative multiple of the canonical character height of WINDOW. */)
5427 (window, vscroll) 5410 (window, vscroll)
5428 Lisp_Object window, vscroll; 5411 Lisp_Object window, vscroll;
5429{ 5412{
5430 struct window *w; 5413 struct window *w;
@@ -5648,10 +5631,10 @@ compare_window_configurations (c1, c2, ignore_positions)
5648 5631
5649DEFUN ("compare-window-configurations", Fcompare_window_configurations, 5632DEFUN ("compare-window-configurations", Fcompare_window_configurations,
5650 Scompare_window_configurations, 2, 2, 0, 5633 Scompare_window_configurations, 2, 2, 0,
5651 "Compare two window configurations as regards the structure of windows.\n\ 5634 doc: /* Compare two window configurations as regards the structure of windows.
5652This function ignores details such as the values of point and mark\n\ 5635This function ignores details such as the values of point and mark
5653and scrolling positions.") 5636and scrolling positions. */)
5654 (x, y) 5637 (x, y)
5655 Lisp_Object x, y; 5638 Lisp_Object x, y;
5656{ 5639{
5657 if (compare_window_configurations (x, y, 1)) 5640 if (compare_window_configurations (x, y, 1))
@@ -5708,166 +5691,166 @@ syms_of_window ()
5708 staticpro (&Vwindow_list); 5691 staticpro (&Vwindow_list);
5709 5692
5710 DEFVAR_LISP ("temp-buffer-show-function", &Vtemp_buffer_show_function, 5693 DEFVAR_LISP ("temp-buffer-show-function", &Vtemp_buffer_show_function,
5711 "Non-nil means call as function to display a help buffer.\n\ 5694 doc: /* Non-nil means call as function to display a help buffer.
5712The function is called with one argument, the buffer to be displayed.\n\ 5695The function is called with one argument, the buffer to be displayed.
5713Used by `with-output-to-temp-buffer'.\n\ 5696Used by `with-output-to-temp-buffer'.
5714If this function is used, then it must do the entire job of showing\n\ 5697If this function is used, then it must do the entire job of showing
5715the buffer; `temp-buffer-show-hook' is not run unless this function runs it."); 5698the buffer; `temp-buffer-show-hook' is not run unless this function runs it. */);
5716 Vtemp_buffer_show_function = Qnil; 5699 Vtemp_buffer_show_function = Qnil;
5717 5700
5718 DEFVAR_LISP ("display-buffer-function", &Vdisplay_buffer_function, 5701 DEFVAR_LISP ("display-buffer-function", &Vdisplay_buffer_function,
5719 "If non-nil, function to call to handle `display-buffer'.\n\ 5702 doc: /* If non-nil, function to call to handle `display-buffer'.
5720It will receive two args, the buffer and a flag which if non-nil means\n\ 5703It will receive two args, the buffer and a flag which if non-nil means
5721 that the currently selected window is not acceptable.\n\ 5704 that the currently selected window is not acceptable.
5722Commands such as `switch-to-buffer-other-window' and `find-file-other-window'\n\ 5705Commands such as `switch-to-buffer-other-window' and `find-file-other-window'
5723work using this function."); 5706work using this function. */);
5724 Vdisplay_buffer_function = Qnil; 5707 Vdisplay_buffer_function = Qnil;
5725 5708
5726 DEFVAR_LISP ("even-window-heights", &Veven_window_heights, 5709 DEFVAR_LISP ("even-window-heights", &Veven_window_heights,
5727 "*If non-nil, `display-buffer' should even the window heights.\n\ 5710 doc: /* *If non-nil, `display-buffer' should even the window heights.
5728If nil, `display-buffer' will leave the window configuration alone."); 5711If nil, `display-buffer' will leave the window configuration alone. */);
5729 Veven_window_heights = Qt; 5712 Veven_window_heights = Qt;
5730 5713
5731 DEFVAR_LISP ("minibuffer-scroll-window", &Vminibuf_scroll_window, 5714 DEFVAR_LISP ("minibuffer-scroll-window", &Vminibuf_scroll_window,
5732 "Non-nil means it is the window that C-M-v in minibuffer should scroll."); 5715 doc: /* Non-nil means it is the window that C-M-v in minibuffer should scroll. */);
5733 Vminibuf_scroll_window = Qnil; 5716 Vminibuf_scroll_window = Qnil;
5734 5717
5735 DEFVAR_LISP ("other-window-scroll-buffer", &Vother_window_scroll_buffer, 5718 DEFVAR_LISP ("other-window-scroll-buffer", &Vother_window_scroll_buffer,
5736 "If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window."); 5719 doc: /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */);
5737 Vother_window_scroll_buffer = Qnil; 5720 Vother_window_scroll_buffer = Qnil;
5738 5721
5739 DEFVAR_BOOL ("pop-up-frames", &pop_up_frames, 5722 DEFVAR_BOOL ("pop-up-frames", &pop_up_frames,
5740 "*Non-nil means `display-buffer' should make a separate frame."); 5723 doc: /* *Non-nil means `display-buffer' should make a separate frame. */);
5741 pop_up_frames = 0; 5724 pop_up_frames = 0;
5742 5725
5743 DEFVAR_BOOL ("display-buffer-reuse-frames", &display_buffer_reuse_frames, 5726 DEFVAR_BOOL ("display-buffer-reuse-frames", &display_buffer_reuse_frames,
5744 "*Non-nil means `display-buffer' should reuse frames.\n\ 5727 doc: /* *Non-nil means `display-buffer' should reuse frames.
5745If the buffer in question is already displayed in a frame, raise that frame."); 5728If the buffer in question is already displayed in a frame, raise that frame. */);
5746 display_buffer_reuse_frames = 0; 5729 display_buffer_reuse_frames = 0;
5747 5730
5748 DEFVAR_LISP ("pop-up-frame-function", &Vpop_up_frame_function, 5731 DEFVAR_LISP ("pop-up-frame-function", &Vpop_up_frame_function,
5749 "Function to call to handle automatic new frame creation.\n\ 5732 doc: /* Function to call to handle automatic new frame creation.
5750It is called with no arguments and should return a newly created frame.\n\ 5733It is called with no arguments and should return a newly created frame.
5751\n\ 5734
5752A typical value might be `(lambda () (new-frame pop-up-frame-alist))'\n\ 5735A typical value might be `(lambda () (new-frame pop-up-frame-alist))'
5753where `pop-up-frame-alist' would hold the default frame parameters."); 5736where `pop-up-frame-alist' would hold the default frame parameters. */);
5754 Vpop_up_frame_function = Qnil; 5737 Vpop_up_frame_function = Qnil;
5755 5738
5756 DEFVAR_LISP ("special-display-buffer-names", &Vspecial_display_buffer_names, 5739 DEFVAR_LISP ("special-display-buffer-names", &Vspecial_display_buffer_names,
5757 "*List of buffer names that should have their own special frames.\n\ 5740 doc: /* *List of buffer names that should have their own special frames.
5758Displaying a buffer whose name is in this list makes a special frame for it\n\ 5741Displaying a buffer whose name is in this list makes a special frame for it
5759using `special-display-function'. See also `special-display-regexps'.\n\ 5742using `special-display-function'. See also `special-display-regexps'.
5760\n\ 5743
5761An element of the list can be a list instead of just a string.\n\ 5744An element of the list can be a list instead of just a string.
5762There are two ways to use a list as an element:\n\ 5745There are two ways to use a list as an element:
5763 (BUFFER FRAME-PARAMETERS...) (BUFFER FUNCTION OTHER-ARGS...)\n\ 5746 (BUFFER FRAME-PARAMETERS...) (BUFFER FUNCTION OTHER-ARGS...)
5764In the first case, FRAME-PARAMETERS are used to create the frame.\n\ 5747In the first case, FRAME-PARAMETERS are used to create the frame.
5765In the latter case, FUNCTION is called with BUFFER as the first argument,\n\ 5748In the latter case, FUNCTION is called with BUFFER as the first argument,
5766followed by OTHER-ARGS--it can display BUFFER in any way it likes.\n\ 5749followed by OTHER-ARGS--it can display BUFFER in any way it likes.
5767All this is done by the function found in `special-display-function'.\n\ 5750All this is done by the function found in `special-display-function'.
5768\n\ 5751
5769If this variable appears \"not to work\", because you add a name to it\n\ 5752If this variable appears \"not to work\", because you add a name to it
5770but that buffer still appears in the selected window, look at the\n\ 5753but that buffer still appears in the selected window, look at the
5771values of `same-window-buffer-names' and `same-window-regexps'.\n\ 5754values of `same-window-buffer-names' and `same-window-regexps'.
5772Those variables take precedence over this one."); 5755Those variables take precedence over this one. */);
5773 Vspecial_display_buffer_names = Qnil; 5756 Vspecial_display_buffer_names = Qnil;
5774 5757
5775 DEFVAR_LISP ("special-display-regexps", &Vspecial_display_regexps, 5758 DEFVAR_LISP ("special-display-regexps", &Vspecial_display_regexps,
5776 "*List of regexps saying which buffers should have their own special frames.\n\ 5759 doc: /* *List of regexps saying which buffers should have their own special frames.
5777If a buffer name matches one of these regexps, it gets its own frame.\n\ 5760If a buffer name matches one of these regexps, it gets its own frame.
5778Displaying a buffer whose name is in this list makes a special frame for it\n\ 5761Displaying a buffer whose name is in this list makes a special frame for it
5779using `special-display-function'.\n\ 5762using `special-display-function'.
5780\n\ 5763
5781An element of the list can be a list instead of just a string.\n\ 5764An element of the list can be a list instead of just a string.
5782There are two ways to use a list as an element:\n\ 5765There are two ways to use a list as an element:
5783 (REGEXP FRAME-PARAMETERS...) (REGEXP FUNCTION OTHER-ARGS...)\n\ 5766 (REGEXP FRAME-PARAMETERS...) (REGEXP FUNCTION OTHER-ARGS...)
5784In the first case, FRAME-PARAMETERS are used to create the frame.\n\ 5767In the first case, FRAME-PARAMETERS are used to create the frame.
5785In the latter case, FUNCTION is called with the buffer as first argument,\n\ 5768In the latter case, FUNCTION is called with the buffer as first argument,
5786followed by OTHER-ARGS--it can display the buffer in any way it likes.\n\ 5769followed by OTHER-ARGS--it can display the buffer in any way it likes.
5787All this is done by the function found in `special-display-function'.\n\ 5770All this is done by the function found in `special-display-function'.
5788\n\ 5771
5789If this variable appears \"not to work\", because you add a regexp to it\n\ 5772If this variable appears \"not to work\", because you add a regexp to it
5790but the matching buffers still appear in the selected window, look at the\n\ 5773but the matching buffers still appear in the selected window, look at the
5791values of `same-window-buffer-names' and `same-window-regexps'.\n\ 5774values of `same-window-buffer-names' and `same-window-regexps'.
5792Those variables take precedence over this one."); 5775Those variables take precedence over this one. */);
5793 Vspecial_display_regexps = Qnil; 5776 Vspecial_display_regexps = Qnil;
5794 5777
5795 DEFVAR_LISP ("special-display-function", &Vspecial_display_function, 5778 DEFVAR_LISP ("special-display-function", &Vspecial_display_function,
5796 "Function to call to make a new frame for a special buffer.\n\ 5779 doc: /* Function to call to make a new frame for a special buffer.
5797It is called with two arguments, the buffer and optional buffer specific\n\ 5780It is called with two arguments, the buffer and optional buffer specific
5798data, and should return a window displaying that buffer.\n\ 5781data, and should return a window displaying that buffer.
5799The default value makes a separate frame for the buffer,\n\ 5782The default value makes a separate frame for the buffer,
5800using `special-display-frame-alist' to specify the frame parameters.\n\ 5783using `special-display-frame-alist' to specify the frame parameters.
5801\n\ 5784
5802A buffer is special if its is listed in `special-display-buffer-names'\n\ 5785A buffer is special if its is listed in `special-display-buffer-names'
5803or matches a regexp in `special-display-regexps'."); 5786or matches a regexp in `special-display-regexps'. */);
5804 Vspecial_display_function = Qnil; 5787 Vspecial_display_function = Qnil;
5805 5788
5806 DEFVAR_LISP ("same-window-buffer-names", &Vsame_window_buffer_names, 5789 DEFVAR_LISP ("same-window-buffer-names", &Vsame_window_buffer_names,
5807 "*List of buffer names that should appear in the selected window.\n\ 5790 doc: /* *List of buffer names that should appear in the selected window.
5808Displaying one of these buffers using `display-buffer' or `pop-to-buffer'\n\ 5791Displaying one of these buffers using `display-buffer' or `pop-to-buffer'
5809switches to it in the selected window, rather than making it appear\n\ 5792switches to it in the selected window, rather than making it appear
5810in some other window.\n\ 5793in some other window.
5811\n\ 5794
5812An element of the list can be a cons cell instead of just a string.\n\ 5795An element of the list can be a cons cell instead of just a string.
5813Then the car must be a string, which specifies the buffer name.\n\ 5796Then the car must be a string, which specifies the buffer name.
5814This is for compatibility with `special-display-buffer-names';\n\ 5797This is for compatibility with `special-display-buffer-names';
5815the cdr of the cons cell is ignored.\n\ 5798the cdr of the cons cell is ignored.
5816\n\ 5799
5817See also `same-window-regexps'."); 5800See also `same-window-regexps'. */);
5818 Vsame_window_buffer_names = Qnil; 5801 Vsame_window_buffer_names = Qnil;
5819 5802
5820 DEFVAR_LISP ("same-window-regexps", &Vsame_window_regexps, 5803 DEFVAR_LISP ("same-window-regexps", &Vsame_window_regexps,
5821 "*List of regexps saying which buffers should appear in the selected window.\n\ 5804 doc: /* *List of regexps saying which buffers should appear in the selected window.
5822If a buffer name matches one of these regexps, then displaying it\n\ 5805If a buffer name matches one of these regexps, then displaying it
5823using `display-buffer' or `pop-to-buffer' switches to it\n\ 5806using `display-buffer' or `pop-to-buffer' switches to it
5824in the selected window, rather than making it appear in some other window.\n\ 5807in the selected window, rather than making it appear in some other window.
5825\n\ 5808
5826An element of the list can be a cons cell instead of just a string.\n\ 5809An element of the list can be a cons cell instead of just a string.
5827Then the car must be a string, which specifies the buffer name.\n\ 5810Then the car must be a string, which specifies the buffer name.
5828This is for compatibility with `special-display-buffer-names';\n\ 5811This is for compatibility with `special-display-buffer-names';
5829the cdr of the cons cell is ignored.\n\ 5812the cdr of the cons cell is ignored.
5830\n\ 5813
5831See also `same-window-buffer-names'."); 5814See also `same-window-buffer-names'. */);
5832 Vsame_window_regexps = Qnil; 5815 Vsame_window_regexps = Qnil;
5833 5816
5834 DEFVAR_BOOL ("pop-up-windows", &pop_up_windows, 5817 DEFVAR_BOOL ("pop-up-windows", &pop_up_windows,
5835 "*Non-nil means display-buffer should make new windows."); 5818 doc: /* *Non-nil means display-buffer should make new windows. */);
5836 pop_up_windows = 1; 5819 pop_up_windows = 1;
5837 5820
5838 DEFVAR_INT ("next-screen-context-lines", &next_screen_context_lines, 5821 DEFVAR_INT ("next-screen-context-lines", &next_screen_context_lines,
5839 "*Number of lines of continuity when scrolling by screenfuls."); 5822 doc: /* *Number of lines of continuity when scrolling by screenfuls. */);
5840 next_screen_context_lines = 2; 5823 next_screen_context_lines = 2;
5841 5824
5842 DEFVAR_INT ("split-height-threshold", &split_height_threshold, 5825 DEFVAR_INT ("split-height-threshold", &split_height_threshold,
5843 "*display-buffer would prefer to split the largest window if this large.\n\ 5826 doc: /* *display-buffer would prefer to split the largest window if this large.
5844If there is only one window, it is split regardless of this value."); 5827If there is only one window, it is split regardless of this value. */);
5845 split_height_threshold = 500; 5828 split_height_threshold = 500;
5846 5829
5847 DEFVAR_INT ("window-min-height", &window_min_height, 5830 DEFVAR_INT ("window-min-height", &window_min_height,
5848 "*Delete any window less than this tall (including its mode line)."); 5831 doc: /* *Delete any window less than this tall (including its mode line). */);
5849 window_min_height = 4; 5832 window_min_height = 4;
5850 5833
5851 DEFVAR_INT ("window-min-width", &window_min_width, 5834 DEFVAR_INT ("window-min-width", &window_min_width,
5852 "*Delete any window less than this wide."); 5835 doc: /* *Delete any window less than this wide. */);
5853 window_min_width = 10; 5836 window_min_width = 10;
5854 5837
5855 DEFVAR_LISP ("scroll-preserve-screen-position", 5838 DEFVAR_LISP ("scroll-preserve-screen-position",
5856 &Vscroll_preserve_screen_position, 5839 &Vscroll_preserve_screen_position,
5857 "*Non-nil means scroll commands move point to keep its screen line unchanged."); 5840 doc: /* *Non-nil means scroll commands move point to keep its screen line unchanged. */);
5858 Vscroll_preserve_screen_position = Qnil; 5841 Vscroll_preserve_screen_position = Qnil;
5859 5842
5860 DEFVAR_LISP ("window-configuration-change-hook", 5843 DEFVAR_LISP ("window-configuration-change-hook",
5861 &Vwindow_configuration_change_hook, 5844 &Vwindow_configuration_change_hook,
5862 "Functions to call when window configuration changes.\n\ 5845 doc: /* Functions to call when window configuration changes.
5863The selected frame is the one whose configuration has changed."); 5846The selected frame is the one whose configuration has changed. */);
5864 Vwindow_configuration_change_hook = Qnil; 5847 Vwindow_configuration_change_hook = Qnil;
5865 5848
5866 DEFVAR_BOOL ("window-size-fixed", &window_size_fixed, 5849 DEFVAR_BOOL ("window-size-fixed", &window_size_fixed,
5867 "Non-nil in a buffer means windows displaying the buffer are fixed-size.\n\ 5850 doc: /* Non-nil in a buffer means windows displaying the buffer are fixed-size.
5868Emacs won't change the size of any window displaying that buffer,\n\ 5851Emacs won't change the size of any window displaying that buffer,
5869unless you explicitly change the size, or Emacs has no other choice.\n\ 5852unless you explicitly change the size, or Emacs has no other choice.
5870This variable automatically becomes buffer-local when set."); 5853This variable automatically becomes buffer-local when set. */);
5871 Fmake_variable_buffer_local (Qwindow_size_fixed); 5854 Fmake_variable_buffer_local (Qwindow_size_fixed);
5872 window_size_fixed = 0; 5855 window_size_fixed = 0;
5873 5856