1 /* Generic frame functions.
2 Copyright (C) 1989, 1992, 1993 Free Software Foundation.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
30 #include "termhooks.h"
32 /* These help us bind and responding to switch-frame events. */
36 Lisp_Object Vemacs_iconified
;
37 Lisp_Object Vframe_list
;
38 Lisp_Object Vterminal_frame
;
39 Lisp_Object Vdefault_minibuffer_frame
;
40 Lisp_Object Vdefault_frame_alist
;
42 /* Evaluate this expression to rebuild the section of syms_of_frame
43 that initializes and staticpros the symbols declared below. Note
44 that Emacs 18 has a bug that keeps C-x C-e from being able to
45 evaluate this expression.
48 ;; Accumulate a list of the symbols we want to initialize from the
49 ;; declarations at the top of the file.
50 (goto-char (point-min))
51 (search-forward "/\*&&& symbols declared here &&&*\/\n")
53 (while (looking-at "Lisp_Object \\(Q[a-z_]+\\)")
55 (cons (buffer-substring (match-beginning 1) (match-end 1))
58 (setq symbol-list (nreverse symbol-list))
59 ;; Delete the section of syms_of_... where we initialize the symbols.
60 (search-forward "\n /\*&&& init symbols here &&&*\/\n")
61 (let ((start (point)))
62 (while (looking-at "^ Q")
64 (kill-region start (point)))
65 ;; Write a new symbol initialization section.
67 (insert (format " %s = intern (\"" (car symbol-list)))
68 (let ((start (point)))
69 (insert (substring (car symbol-list) 1))
70 (subst-char-in-region start (point) ?_ ?-))
71 (insert (format "\");\n staticpro (&%s);\n" (car symbol-list)))
72 (setq symbol-list (cdr symbol-list)))))
75 /*&&& symbols declared here &&&*/
77 Lisp_Object Qframe_live_p
;
80 Lisp_Object Qminibuffer
;
81 Lisp_Object Qmodeline
;
84 Lisp_Object Qunsplittable
;
88 extern Lisp_Object Vminibuffer_list
;
89 extern Lisp_Object
get_minibuffer ();
91 DEFUN ("framep", Fframep
, Sframep
, 1, 1, 0,
92 "Return non-nil if OBJECT is a frame.\n\
93 Value is t for a termcap frame (a character-only terminal),\n\
94 `x' for an Emacs frame that is really an X window.\n\
95 Also see `live-frame-p'.")
99 if (XTYPE (object
) != Lisp_Frame
)
101 switch (XFRAME (object
)->output_method
)
105 case output_x_window
:
112 DEFUN ("frame-live-p", Fframe_live_p
, Sframe_live_p
, 1, 1, 0,
113 "Return non-nil if OBJECT is a frame which has not been deleted.\n\
114 Value is nil if OBJECT is not a live frame. If object is a live\n\
115 frame, the return value indicates what sort of output device it is\n\
116 displayed on. Value is t for a termcap frame (a character-only\n\
117 terminal), `x' for an Emacs frame being displayed in an X window.")
121 return ((FRAMEP (object
)
122 && FRAME_LIVE_P (XFRAME (object
)))
132 register struct frame
*f
;
133 register Lisp_Object root_window
;
134 register Lisp_Object mini_window
;
136 frame
= Fmake_vector (((sizeof (struct frame
) - (sizeof (Lisp_Vector
)
137 - sizeof (Lisp_Object
)))
138 / sizeof (Lisp_Object
)),
140 XSETTYPE (frame
, Lisp_Frame
);
145 f
->current_glyphs
= 0;
146 f
->desired_glyphs
= 0;
148 f
->async_visible
= 0;
149 f
->display
.nothing
= 0;
151 f
->async_iconified
= 0;
152 f
->wants_modeline
= 1;
157 f
->has_minibuffer
= mini_p
;
158 f
->focus_frame
= Qnil
;
159 f
->explicit_name
= 0;
160 f
->can_have_scrollbars
= 0;
161 f
->has_vertical_scrollbars
= 0;
162 f
->param_alist
= Qnil
;
163 f
->scrollbars
= Qnil
;
164 f
->condemned_scrollbars
= Qnil
;
166 root_window
= make_window ();
169 mini_window
= make_window ();
170 XWINDOW (root_window
)->next
= mini_window
;
171 XWINDOW (mini_window
)->prev
= root_window
;
172 XWINDOW (mini_window
)->mini_p
= Qt
;
173 XWINDOW (mini_window
)->frame
= frame
;
174 f
->minibuffer_window
= mini_window
;
179 XWINDOW (root_window
)->next
= Qnil
;
180 f
->minibuffer_window
= Qnil
;
183 XWINDOW (root_window
)->frame
= frame
;
186 just so that there is "something there."
187 Correct size will be set up later with change_frame_size. */
192 XFASTINT (XWINDOW (root_window
)->width
) = 10;
193 XFASTINT (XWINDOW (root_window
)->height
) = (mini_p
? 9 : 10);
197 XFASTINT (XWINDOW (mini_window
)->width
) = 10;
198 XFASTINT (XWINDOW (mini_window
)->top
) = 9;
199 XFASTINT (XWINDOW (mini_window
)->height
) = 1;
202 /* Choose a buffer for the frame's root window. */
206 XWINDOW (root_window
)->buffer
= Qt
;
207 buf
= Fcurrent_buffer ();
208 /* If buf is a 'hidden' buffer (i.e. one whose name starts with
209 a space), try to find another one. */
210 if (XSTRING (Fbuffer_name (buf
))->data
[0] == ' ')
211 buf
= Fother_buffer (buf
, Qnil
);
212 Fset_window_buffer (root_window
, buf
);
217 XWINDOW (mini_window
)->buffer
= Qt
;
218 Fset_window_buffer (mini_window
,
219 (NILP (Vminibuffer_list
)
221 : Fcar (Vminibuffer_list
)));
224 f
->root_window
= root_window
;
225 f
->selected_window
= root_window
;
226 /* Make sure this window seems more recently used than
227 a newly-created, never-selected window. */
228 XFASTINT (XWINDOW (f
->selected_window
)->use_time
) = ++window_select_count
;
230 Vframe_list
= Fcons (frame
, Vframe_list
);
235 /* Make a frame using a separate minibuffer window on another frame.
236 MINI_WINDOW is the minibuffer window to use. nil means use the
237 default (the global minibuffer). */
240 make_frame_without_minibuffer (mini_window
)
241 register Lisp_Object mini_window
;
243 register struct frame
*f
;
245 /* Choose the minibuffer window to use. */
246 if (NILP (mini_window
))
248 if (XTYPE (Vdefault_minibuffer_frame
) != Lisp_Frame
)
249 error ("default-minibuffer-frame must be set when creating minibufferless frames");
250 if (! FRAME_LIVE_P (XFRAME (Vdefault_minibuffer_frame
)))
251 error ("default-minibuffer-frame must be a live frame");
252 mini_window
= XFRAME (Vdefault_minibuffer_frame
)->minibuffer_window
;
256 CHECK_LIVE_WINDOW (mini_window
, 0);
259 /* Make a frame containing just a root window. */
262 /* Install the chosen minibuffer window, with proper buffer. */
263 f
->minibuffer_window
= mini_window
;
264 Fset_window_buffer (mini_window
,
265 (NILP (Vminibuffer_list
)
267 : Fcar (Vminibuffer_list
)));
271 /* Make a frame containing only a minibuffer window. */
274 make_minibuffer_frame ()
276 /* First make a frame containing just a root window, no minibuffer. */
278 register struct frame
*f
= make_frame (0);
279 register Lisp_Object mini_window
;
280 register Lisp_Object frame
;
282 XSET (frame
, Lisp_Frame
, f
);
287 f
->wants_modeline
= 0;
288 f
->has_minibuffer
= 1;
290 /* Now label the root window as also being the minibuffer.
291 Avoid infinite looping on the window chain by marking next pointer
294 mini_window
= f
->minibuffer_window
= f
->root_window
;
295 XWINDOW (mini_window
)->mini_p
= Qt
;
296 XWINDOW (mini_window
)->next
= Qnil
;
297 XWINDOW (mini_window
)->prev
= Qnil
;
298 XWINDOW (mini_window
)->frame
= frame
;
300 /* Put the proper buffer in that window. */
302 Fset_window_buffer (mini_window
,
303 (NILP (Vminibuffer_list
)
305 : Fcar (Vminibuffer_list
)));
309 /* Construct a frame that refers to the terminal (stdin and stdout). */
312 make_terminal_frame ()
314 register struct frame
*f
;
318 f
->name
= build_string ("terminal");
319 FRAME_SET_VISIBLE (f
, 1);
320 f
->display
.nothing
= 1; /* Nonzero means frame isn't deleted. */
321 XSET (Vterminal_frame
, Lisp_Frame
, f
);
325 DEFUN ("select-frame", Fselect_frame
, Sselect_frame
, 1, 2, "e",
326 "Select the frame FRAME. FRAME's selected window becomes \"the\"\n\
327 selected window. If the optional parameter NO-ENTER is non-nil, don't\n\
328 focus on that frame.\n\
330 This function is interactive, and may be bound to the ``switch-frame''\n\
331 event; when invoked this way, it switches to the frame named in the\n\
332 event. When called from lisp, FRAME may be a ``switch-frame'' event;\n\
333 if it is, select the frame named in the event.\n\
335 Changing the selected frame can change focus redirections. See\n\
336 `redirect-frame-focus' for details.")
338 Lisp_Object frame
, no_enter
;
340 /* If FRAME is a switch-frame event, extract the frame we should
343 && EQ (XCONS (frame
)->car
, Qswitch_frame
)
344 && CONSP (XCONS (frame
)->cdr
))
345 frame
= XCONS (XCONS (frame
)->cdr
)->car
;
347 CHECK_LIVE_FRAME (frame
, 0);
349 if (selected_frame
== XFRAME (frame
))
352 /* If a frame's focus has been redirected toward the currently
353 selected frame, we should change the redirection to point to the
354 newly selected frame. This means that if the focus is redirected
355 from a minibufferless frame to a surrogate minibuffer frame, we
356 can use `other-window' to switch between all the frames using
357 that minibuffer frame, and the focus redirection will follow us
362 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
366 if (XTYPE (XCONS (tail
)->car
) != Lisp_Frame
)
369 focus
= FRAME_FOCUS_FRAME (XFRAME (XCONS (tail
)->car
));
371 if (XTYPE (focus
) == Lisp_Frame
372 && XFRAME (focus
) == selected_frame
)
373 Fredirect_frame_focus (XCONS (tail
)->car
, frame
);
377 selected_frame
= XFRAME (frame
);
378 if (! FRAME_MINIBUF_ONLY_P (selected_frame
))
379 last_nonminibuf_frame
= selected_frame
;
381 Fselect_window (XFRAME (frame
)->selected_window
);
383 /* I think this should be done with a hook. */
384 #ifdef HAVE_X_WINDOWS
385 if (FRAME_X_P (XFRAME (frame
))
388 Ffocus_frame (frame
);
391 choose_minibuf_frame ();
396 DEFUN ("selected-frame", Fselected_frame
, Sselected_frame
, 0, 0, 0,
397 "Return the frame that is now selected.")
401 XSET (tem
, Lisp_Frame
, selected_frame
);
405 DEFUN ("window-frame", Fwindow_frame
, Swindow_frame
, 1, 1, 0,
406 "Return the frame object that window WINDOW is on.")
410 CHECK_LIVE_WINDOW (window
, 0);
411 return XWINDOW (window
)->frame
;
414 DEFUN ("frame-root-window", Fframe_root_window
, Sframe_root_window
, 0, 1, 0,
415 "Returns the root-window of FRAME.\n\
416 If omitted, FRAME defaults to the currently selected frame.")
421 XSET (frame
, Lisp_Frame
, selected_frame
);
423 CHECK_LIVE_FRAME (frame
, 0);
425 return XFRAME (frame
)->root_window
;
428 DEFUN ("frame-selected-window", Fframe_selected_window
,
429 Sframe_selected_window
, 0, 1, 0,
430 "Return the selected window of frame object FRAME.\n\
431 If omitted, FRAME defaults to the currently selected frame.")
436 XSET (frame
, Lisp_Frame
, selected_frame
);
438 CHECK_LIVE_FRAME (frame
, 0);
440 return XFRAME (frame
)->selected_window
;
443 DEFUN ("frame-list", Fframe_list
, Sframe_list
,
445 "Return a list of all frames.")
448 return Fcopy_sequence (Vframe_list
);
451 /* Return the next frame in the frame list after FRAME.
452 If MINIBUF is nil, exclude minibuffer-only frames.
453 If MINIBUF is a window, include only frames using that window for
455 If MINIBUF is non-nil, and not a window, include all frames. */
457 next_frame (frame
, minibuf
)
464 /* There must always be at least one frame in Vframe_list. */
465 if (! CONSP (Vframe_list
))
468 /* If this frame is dead, it won't be in Vframe_list, and we'll loop
469 forever. Forestall that. */
470 CHECK_LIVE_FRAME (frame
, 0);
473 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
475 Lisp_Object f
= XCONS (tail
)->car
;
479 /* Decide whether this frame is eligible to be returned. */
481 /* If we've looped all the way around without finding any
482 eligible frames, return the original frame. */
486 /* Let minibuf decide if this frame is acceptable. */
489 if (! FRAME_MINIBUF_ONLY_P (XFRAME (f
)))
492 else if (XTYPE (minibuf
) == Lisp_Window
)
494 if (EQ (FRAME_MINIBUF_WINDOW (XFRAME (f
)), minibuf
))
506 /* Return the previous frame in the frame list before FRAME.
507 If MINIBUF is nil, exclude minibuffer-only frames.
508 If MINIBUF is a window, include only frames using that window for
510 If MINIBUF is non-nil and not a window, include all frames. */
512 prev_frame (frame
, minibuf
)
519 /* There must always be at least one frame in Vframe_list. */
520 if (! CONSP (Vframe_list
))
524 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
526 Lisp_Object f
= XCONS (tail
)->car
;
528 if (XTYPE (f
) != Lisp_Frame
)
531 if (EQ (frame
, f
) && !NILP (prev
))
534 /* Decide whether this frame is eligible to be returned,
535 according to minibuf. */
538 if (! FRAME_MINIBUF_ONLY_P (XFRAME (f
)))
541 else if (XTYPE (minibuf
) == Lisp_Window
)
543 if (EQ (FRAME_MINIBUF_WINDOW (XFRAME (f
)), minibuf
))
550 /* We've scanned the entire list. */
552 /* We went through the whole frame list without finding a single
553 acceptable frame. Return the original frame. */
556 /* There were no acceptable frames in the list before FRAME; otherwise,
557 we would have returned directly from the loop. Since PREV is the last
558 acceptable frame in the list, return it. */
562 DEFUN ("next-frame", Fnext_frame
, Snext_frame
, 0, 2, 0,
563 "Return the next frame in the frame list after FRAME.\n\
564 By default, skip minibuffer-only frames.\n\
565 If omitted, FRAME defaults to the selected frame.\n\
566 If optional argument MINIFRAME is non-nil, include minibuffer-only frames.\n\
567 If MINIFRAME is a window, include only frames using that window for their\n\
569 If MINIFRAME is non-nil and not a window, include all frames.")
571 Lisp_Object frame
, miniframe
;
576 XSET (frame
, Lisp_Frame
, selected_frame
);
578 CHECK_LIVE_FRAME (frame
, 0);
580 return next_frame (frame
, miniframe
);
584 DEFUN ("delete-frame", Fdelete_frame
, Sdelete_frame
, 0, 1, "",
585 "Delete FRAME, permanently eliminating it from use.\n\
586 If omitted, FRAME defaults to the selected frame.\n\
587 A frame may not be deleted if its minibuffer is used by other frames.")
593 if (EQ (frame
, Qnil
))
596 XSET (frame
, Lisp_Frame
, f
);
600 CHECK_FRAME (frame
, 0);
604 if (! FRAME_LIVE_P (f
))
607 /* Are there any other frames besides this one? */
608 if (f
== selected_frame
&& EQ (next_frame (frame
, Qt
), frame
))
609 error ("Attempt to delete the only frame");
611 /* Does this frame have a minibuffer, and is it the surrogate
612 minibuffer for any other frame? */
613 if (FRAME_HAS_MINIBUF_P (XFRAME (frame
)))
617 for (frames
= Vframe_list
;
619 frames
= XCONS (frames
)->cdr
)
621 Lisp_Object
this = XCONS (frames
)->car
;
623 if (! EQ (this, frame
)
627 (FRAME_MINIBUF_WINDOW
629 error ("Attempt to delete a surrogate minibuffer frame");
633 /* Don't let the frame remain selected. */
634 if (f
== selected_frame
)
635 Fselect_frame (next_frame (frame
, Qt
), Qnil
);
637 /* Don't allow minibuf_window to remain on a deleted frame. */
638 if (EQ (f
->minibuffer_window
, minibuf_window
))
640 Fset_window_buffer (selected_frame
->minibuffer_window
,
641 XWINDOW (minibuf_window
)->buffer
);
642 minibuf_window
= selected_frame
->minibuffer_window
;
645 /* Mark all the windows that used to be on FRAME as deleted, and then
646 remove the reference to them. */
647 delete_all_subwindows (XWINDOW (f
->root_window
));
648 f
->root_window
= Qnil
;
650 Vframe_list
= Fdelq (frame
, Vframe_list
);
651 FRAME_SET_VISIBLE (f
, 0);
653 /* Since some events are handled at the interrupt level, we may get
654 an event for f at any time; if we zero out the frame's display
655 now, then we may trip up the event-handling code. Instead, we'll
656 promise that the display of the frame must be valid until we have
657 called the window-system-dependent frame destruction routine. */
659 /* I think this should be done with a hook. */
660 #ifdef HAVE_X_WINDOWS
662 x_destroy_window (f
);
665 f
->display
.nothing
= 0;
667 /* If we've deleted the last_nonminibuf_frame, then try to find
669 if (f
== last_nonminibuf_frame
)
673 last_nonminibuf_frame
= 0;
675 for (frames
= Vframe_list
;
677 frames
= XCONS (frames
)->cdr
)
679 f
= XFRAME (XCONS (frames
)->car
);
680 if (!FRAME_MINIBUF_ONLY_P (f
))
682 last_nonminibuf_frame
= f
;
688 /* If we've deleted Vdefault_minibuffer_frame, try to find another
689 one. Prefer minibuffer-only frames, but also notice frames
690 with other windows. */
691 if (EQ (frame
, Vdefault_minibuffer_frame
))
695 /* The last frame we saw with a minibuffer, minibuffer-only or not. */
696 Lisp_Object frame_with_minibuf
= Qnil
;
698 for (frames
= Vframe_list
;
700 frames
= XCONS (frames
)->cdr
)
702 Lisp_Object
this = XCONS (frames
)->car
;
704 if (XTYPE (this) != Lisp_Frame
)
708 if (FRAME_HAS_MINIBUF_P (f
))
710 frame_with_minibuf
= this;
711 if (FRAME_MINIBUF_ONLY_P (f
))
716 /* We know that there must be some frame with a minibuffer out
717 there. If this were not true, all of the frames present
718 would have to be minibufferless, which implies that at some
719 point their minibuffer frames must have been deleted, but
720 that is prohibited at the top; you can't delete surrogate
721 minibuffer frames. */
722 if (NILP (frame_with_minibuf
))
725 Vdefault_minibuffer_frame
= frame_with_minibuf
;
731 /* Return mouse position in character cell units. */
733 DEFUN ("mouse-position", Fmouse_position
, Smouse_position
, 0, 0, 0,
734 "Return a list (FRAME X . Y) giving the current mouse frame and position.\n\
735 If Emacs is running on a mouseless terminal or hasn't been programmed\n\
736 to read the mouse position, it returns the selected frame for FRAME\n\
737 and nil for X and Y.")
741 Lisp_Object lispy_dummy
;
742 enum scrollbar_part party_dummy
;
744 unsigned long long_dummy
;
746 if (mouse_position_hook
)
747 (*mouse_position_hook
) (&f
,
748 &lispy_dummy
, &party_dummy
,
757 XSET (lispy_dummy
, Lisp_Frame
, f
);
758 return Fcons (lispy_dummy
, Fcons (make_number (x
), make_number (y
)));
761 DEFUN ("set-mouse-position", Fset_mouse_position
, Sset_mouse_position
, 3, 3, 0,
762 "Move the mouse pointer to the center of cell (X,Y) in FRAME.\n\
763 WARNING: If you use this under X, you should do `unfocus-frame' afterwards.")
765 Lisp_Object frame
, x
, y
;
767 CHECK_LIVE_FRAME (frame
, 0);
771 /* I think this should be done with a hook. */
772 #ifdef HAVE_X_WINDOWS
773 if (FRAME_X_P (XFRAME (frame
)))
774 /* Warping the mouse will cause enternotify and focus events. */
775 x_set_mouse_position (XFRAME (frame
), x
, y
);
782 /* ??? Can this be replaced with a Lisp function?
783 It is used in minibuf.c. Can we get rid of that?
784 Yes. All uses in minibuf.c are gone, and parallels to these
785 functions have been defined in frame.el. */
787 DEFUN ("frame-configuration", Fframe_configuration
, Sframe_configuration
,
789 "Return object describing current frame configuration.\n\
790 The frame configuration is the current mouse position and selected frame.\n\
791 This object can be given to `restore-frame-configuration'\n\
792 to restore this frame configuration.")
797 c
= Fmake_vector (make_number(4), Qnil
);
798 XVECTOR (c
)->contents
[0] = Fselected_frame();
799 if (mouse_position_hook
)
800 (*mouse_position_hook
) (&XVECTOR (c
)->contents
[1]
801 &XVECTOR (c
)->contents
[2],
802 &XVECTOR (c
)->contents
[3],
807 DEFUN ("restore-frame-configuration", Frestore_frame_configuration
,
808 Srestore_frame_configuration
,
810 "Restores frame configuration CONFIGURATION.")
814 Lisp_Object x_pos
, y_pos
, frame
;
816 CHECK_VECTOR (config
, 0);
817 if (XVECTOR (config
)->size
!= 3)
819 error ("Wrong size vector passed to restore-frame-configuration");
821 frame
= XVECTOR (config
)->contents
[0];
822 CHECK_LIVE_FRAME (frame
, 0);
824 Fselect_frame (frame
, Qnil
);
827 /* This seems to interfere with the frame selection mechanism. jla */
828 x_pos
= XVECTOR (config
)->contents
[2];
829 y_pos
= XVECTOR (config
)->contents
[3];
830 set_mouse_position (frame
, XINT (x_pos
), XINT (y_pos
));
837 DEFUN ("make-frame-visible", Fmake_frame_visible
, Smake_frame_visible
,
839 "Make the frame FRAME visible (assuming it is an X-window).\n\
840 Also raises the frame so that nothing obscures it.\n\
841 If omitted, FRAME defaults to the currently selected frame.")
846 XSET (frame
, Lisp_Frame
, selected_frame
);
848 CHECK_LIVE_FRAME (frame
, 0);
850 /* I think this should be done with a hook. */
851 #ifdef HAVE_X_WINDOWS
852 if (FRAME_X_P (XFRAME (frame
)))
853 x_make_frame_visible (XFRAME (frame
));
859 DEFUN ("make-frame-invisible", Fmake_frame_invisible
, Smake_frame_invisible
,
861 "Make the frame FRAME invisible (assuming it is an X-window).\n\
862 If omitted, FRAME defaults to the currently selected frame.")
867 XSET (frame
, Lisp_Frame
, selected_frame
);
869 CHECK_LIVE_FRAME (frame
, 0);
871 /* I think this should be done with a hook. */
872 #ifdef HAVE_X_WINDOWS
873 if (FRAME_X_P (XFRAME (frame
)))
874 x_make_frame_invisible (XFRAME (frame
));
880 DEFUN ("iconify-frame", Ficonify_frame
, Siconify_frame
,
882 "Make the frame FRAME into an icon.\n\
883 If omitted, FRAME defaults to the currently selected frame.")
888 XSET (frame
, Lisp_Frame
, selected_frame
);
890 CHECK_LIVE_FRAME (frame
, 0);
892 /* I think this should be done with a hook. */
893 #ifdef HAVE_X_WINDOWS
894 if (FRAME_X_P (XFRAME (frame
)))
895 x_iconify_frame (XFRAME (frame
));
901 DEFUN ("frame-visible-p", Fframe_visible_p
, Sframe_visible_p
,
903 "Return t if FRAME is now \"visible\" (actually in use for display).\n\
904 A frame that is not \"visible\" is not updated and, if it works through\n\
905 a window system, it may not show at all.\n\
906 Return the symbol `icon' if frame is visible only as an icon.")
910 CHECK_LIVE_FRAME (frame
, 0);
912 if (FRAME_VISIBLE_P (XFRAME (frame
)))
914 if (FRAME_ICONIFIED_P (XFRAME (frame
)))
919 DEFUN ("visible-frame-list", Fvisible_frame_list
, Svisible_frame_list
,
921 "Return a list of all frames now \"visible\" (being updated).")
924 Lisp_Object tail
, frame
;
929 for (tail
= Vframe_list
; CONSP (tail
); tail
= XCONS (tail
)->cdr
)
931 frame
= XCONS (tail
)->car
;
932 if (XTYPE (frame
) != Lisp_Frame
)
935 if (FRAME_VISIBLE_P (f
))
936 value
= Fcons (frame
, value
);
942 DEFUN ("frame-to-front", Fframe_to_front
, Sframe_to_front
, 1, 1, 0,
943 "Bring FRAME to the front, so it occludes any frames it overlaps.\n\
944 If FRAME is invisible, make it visible.\n\
945 If Emacs is displaying on an ordinary terminal or some other device which\n\
946 doesn't support multiple overlapping frames, this function does nothing.")
950 CHECK_LIVE_FRAME (frame
, 0);
952 if (frame_raise_lower_hook
)
953 (*frame_raise_lower_hook
) (XFRAME (frame
), 1);
958 DEFUN ("frame-to-back", Fframe_to_back
, Sframe_to_back
, 1, 1, 0,
959 "Send FRAME to the back, so it is occluded by any frames that overlap it.\n\
960 If Emacs is displaying on an ordinary terminal or some other device which\n\
961 doesn't support multiple overlapping frames, this function does nothing.")
965 CHECK_LIVE_FRAME (frame
, 0);
967 if (frame_raise_lower_hook
)
968 (*frame_raise_lower_hook
) (XFRAME (frame
), 0);
974 DEFUN ("redirect-frame-focus", Fredirect_frame_focus
, Sredirect_frame_focus
,
976 "Arrange for keystrokes typed at FRAME to be sent to FOCUS-FRAME.\n\
977 In other words, switch-frame events caused by events in FRAME will\n\
978 request a switch to FOCUS-FRAME, and `last-event-frame' will be\n\
979 FOCUS-FRAME after reading an event typed at FRAME.\n\
981 If FOCUS-FRAME is omitted or nil, any existing redirection is\n\
982 cancelled, and the frame again receives its own keystrokes.\n\
984 Focus redirection is useful for temporarily redirecting keystrokes to\n\
985 a surrogate minibuffer frame when a frame doesn't have its own\n\
986 minibuffer window.\n\
988 A frame's focus redirection can be changed by select-frame. If frame\n\
989 FOO is selected, and then a different frame BAR is selected, any\n\
990 frames redirecting their focus to FOO are shifted to redirect their\n\
991 focus to BAR. This allows focus redirection to work properly when the\n\
992 user switches from one frame to another using `select-window'.\n\
994 This means that a frame whose focus is redirected to itself is treated\n\
995 differently from a frame whose focus is redirected to nil; the former\n\
996 is affected by select-frame, while the latter is not.\n\
998 The redirection lasts until `redirect-frame-focus' is called to change it.")
1000 Lisp_Object frame
, focus_frame
;
1002 CHECK_LIVE_FRAME (frame
, 0);
1004 if (! NILP (focus_frame
))
1005 CHECK_LIVE_FRAME (focus_frame
, 1);
1007 XFRAME (frame
)->focus_frame
= focus_frame
;
1009 if (frame_rehighlight_hook
)
1010 (*frame_rehighlight_hook
) ();
1016 DEFUN ("frame-focus", Fframe_focus
, Sframe_focus
, 1, 1, 0,
1017 "Return the frame to which FRAME's keystrokes are currently being sent.\n\
1018 This returns nil if FRAME's focus is not redirected.\n\
1019 See `redirect-frame-focus'.")
1023 CHECK_LIVE_FRAME (frame
, 0);
1025 return FRAME_FOCUS_FRAME (XFRAME (frame
));
1031 get_frame_param (frame
, prop
)
1032 register struct frame
*frame
;
1035 register Lisp_Object tem
;
1037 tem
= Fassq (prop
, frame
->param_alist
);
1044 store_in_alist (alistptr
, prop
, val
)
1045 Lisp_Object
*alistptr
, val
;
1048 register Lisp_Object tem
;
1050 tem
= Fassq (prop
, *alistptr
);
1052 *alistptr
= Fcons (Fcons (prop
, val
), *alistptr
);
1058 store_frame_param (f
, prop
, val
)
1060 Lisp_Object prop
, val
;
1062 register Lisp_Object tem
;
1064 tem
= Fassq (prop
, f
->param_alist
);
1066 f
->param_alist
= Fcons (Fcons (prop
, val
), f
->param_alist
);
1070 if (EQ (prop
, Qminibuffer
)
1071 && XTYPE (val
) == Lisp_Window
)
1073 if (! MINI_WINDOW_P (XWINDOW (val
)))
1074 error ("Surrogate minibuffer windows must be minibuffer windows.");
1076 if (FRAME_HAS_MINIBUF_P (f
) || FRAME_MINIBUF_ONLY_P (f
))
1077 error ("Can't change the surrogate minibuffer of a frame with its own minibuffer.");
1079 /* Install the chosen minibuffer window, with proper buffer. */
1080 f
->minibuffer_window
= val
;
1084 DEFUN ("frame-parameters", Fframe_parameters
, Sframe_parameters
, 0, 1, 0,
1085 "Return the parameters-alist of frame FRAME.\n\
1086 It is a list of elements of the form (PARM . VALUE), where PARM is a symbol.\n\
1087 The meaningful PARMs depend on the kind of frame.\n\
1088 If FRAME is omitted, return information on the currently selected frame.")
1095 if (EQ (frame
, Qnil
))
1099 CHECK_FRAME (frame
, 0);
1103 if (f
->display
.nothing
== 0)
1106 alist
= Fcopy_alist (f
->param_alist
);
1107 store_in_alist (&alist
, Qname
, f
->name
);
1108 store_in_alist (&alist
, Qheight
, make_number (f
->height
));
1109 store_in_alist (&alist
, Qwidth
, make_number (f
->width
));
1110 store_in_alist (&alist
, Qmodeline
, (f
->wants_modeline
? Qt
: Qnil
));
1111 store_in_alist (&alist
, Qminibuffer
,
1112 (! FRAME_HAS_MINIBUF_P (f
) ? Qnil
1113 : (FRAME_MINIBUF_ONLY_P (f
) ? Qonly
1114 : FRAME_MINIBUF_WINDOW (f
))));
1115 store_in_alist (&alist
, Qunsplittable
, (f
->no_split
? Qt
: Qnil
));
1117 /* I think this should be done with a hook. */
1118 #ifdef HAVE_X_WINDOWS
1120 x_report_frame_params (f
, &alist
);
1125 DEFUN ("modify-frame-parameters", Fmodify_frame_parameters
,
1126 Smodify_frame_parameters
, 2, 2, 0,
1127 "Modify the parameters of frame FRAME according to ALIST.\n\
1128 ALIST is an alist of parameters to change and their new values.\n\
1129 Each element of ALIST has the form (PARM . VALUE), where PARM is a symbol.\n\
1130 The meaningful PARMs depend on the kind of frame; undefined PARMs are ignored.")
1132 Lisp_Object frame
, alist
;
1135 register Lisp_Object tail
, elt
, prop
, val
;
1137 if (EQ (frame
, Qnil
))
1141 CHECK_LIVE_FRAME (frame
, 0);
1145 /* I think this should be done with a hook. */
1146 #ifdef HAVE_X_WINDOWS
1149 x_set_frame_parameters (f
, alist
);
1151 for (tail
= alist
; !EQ (tail
, Qnil
); tail
= Fcdr (tail
))
1156 x_set_frame_param (f
, prop
, val
, get_frame_param (f
, prop
));
1157 store_frame_param (f
, prop
, val
);
1167 /* This function isn't useful enough by itself to include; we need to
1168 add functions to allow the user to find the size of a font before
1169 this is actually useful. */
1171 DEFUN ("frame-pixel-size", Fframe_pixel_size
,
1172 Sframe_pixel_size
, 1, 1, 0,
1173 "Return a cons (width . height) of FRAME's size in pixels.")
1177 register struct frame
*f
;
1180 CHECK_LIVE_FRAME (frame
, 0);
1183 return Fcons (make_number (x_pixel_width (f
)),
1184 make_number (x_pixel_height (f
)));
1189 /* These functions have no C callers, and can be written nicely in lisp. */
1191 DEFUN ("frame-height", Fframe_height
, Sframe_height
, 0, 0, 0,
1192 "Return number of lines available for display on selected frame.")
1195 return make_number (FRAME_HEIGHT (selected_frame
));
1198 DEFUN ("frame-width", Fframe_width
, Sframe_width
, 0, 0, 0,
1199 "Return number of columns available for display on selected frame.")
1202 return make_number (FRAME_WIDTH (selected_frame
));
1206 DEFUN ("set-frame-height", Fset_frame_height
, Sset_frame_height
, 2, 3, 0,
1207 "Specify that the frame FRAME has LINES lines.\n\
1208 Optional third arg non-nil means that redisplay should use LINES lines\n\
1209 but that the idea of the actual height of the frame should not be changed.")
1210 (frame
, rows
, pretend
)
1211 Lisp_Object frame
, rows
, pretend
;
1213 register struct frame
*f
;
1215 CHECK_NUMBER (rows
, 0);
1220 CHECK_LIVE_FRAME (frame
, 0);
1224 /* I think this should be done with a hook. */
1225 #ifdef HAVE_X_WINDOWS
1228 if (XINT (rows
) != f
->width
)
1229 x_set_window_size (f
, f
->width
, XINT (rows
));
1233 change_frame_size (f
, XINT (rows
), 0, !NILP (pretend
), 0);
1237 DEFUN ("set-frame-width", Fset_frame_width
, Sset_frame_width
, 2, 3, 0,
1238 "Specify that the frame FRAME has COLS columns.\n\
1239 Optional third arg non-nil means that redisplay should use COLS columns\n\
1240 but that the idea of the actual width of the frame should not be changed.")
1241 (frame
, cols
, pretend
)
1242 Lisp_Object frame
, cols
, pretend
;
1244 register struct frame
*f
;
1245 CHECK_NUMBER (cols
, 0);
1250 CHECK_LIVE_FRAME (frame
, 0);
1254 /* I think this should be done with a hook. */
1255 #ifdef HAVE_X_WINDOWS
1258 if (XINT (cols
) != f
->width
)
1259 x_set_window_size (f
, XINT (cols
), f
->height
);
1263 change_frame_size (f
, 0, XINT (cols
), !NILP (pretend
), 0);
1267 DEFUN ("set-frame-size", Fset_frame_size
, Sset_frame_size
, 3, 3, 0,
1268 "Sets size of FRAME to COLS by ROWS, measured in characters.")
1270 Lisp_Object frame
, cols
, rows
;
1272 register struct frame
*f
;
1275 CHECK_LIVE_FRAME (frame
, 0);
1276 CHECK_NUMBER (cols
, 2);
1277 CHECK_NUMBER (rows
, 1);
1280 /* I think this should be done with a hook. */
1281 #ifdef HAVE_X_WINDOWS
1284 if (XINT (rows
) != f
->height
|| XINT (cols
) != f
->width
)
1285 x_set_window_size (f
, XINT (cols
), XINT (rows
));
1289 change_frame_size (f
, XINT (rows
), XINT (cols
), 0, 0);
1294 DEFUN ("set-frame-position", Fset_frame_position
,
1295 Sset_frame_position
, 3, 3, 0,
1296 "Sets position of FRAME in pixels to XOFFSET by YOFFSET.\n\
1297 If XOFFSET or YOFFSET are negative, they are interpreted relative to\n\
1298 the leftmost or bottommost position FRAME could occupy without going\n\
1300 (frame
, xoffset
, yoffset
)
1301 Lisp_Object frame
, xoffset
, yoffset
;
1303 register struct frame
*f
;
1306 CHECK_LIVE_FRAME (frame
, 0);
1307 CHECK_NUMBER (xoffset
, 1);
1308 CHECK_NUMBER (yoffset
, 2);
1311 /* I think this should be done with a hook. */
1312 #ifdef HAVE_X_WINDOWS
1314 x_set_offset (f
, XINT (xoffset
), XINT (yoffset
));
1322 DEFUN ("rubber-band-rectangle", Frubber_band_rectangle
, Srubber_band_rectangle
,
1324 "Ask user to specify a window position and size on FRAME with the mouse.\n\
1325 Arguments are FRAME, NAME and GEO. NAME is a name to be displayed as\n\
1326 the purpose of this rectangle. GEO is an X-windows size spec that can\n\
1327 specify defaults for some sizes/positions. If GEO specifies everything,\n\
1328 the mouse is not used.\n\
1329 Returns a list of five values: (FRAME LEFT TOP WIDTH HEIGHT).")
1336 Lisp_Object nums
[4];
1339 CHECK_FRAME (frame
, 0);
1340 CHECK_STRING (name
, 1);
1341 CHECK_STRING (geo
, 2);
1343 switch (XFRAME (frame
)->output_method
)
1345 case output_x_window
:
1346 x_rubber_band (XFRAME (frame
), &vals
[0], &vals
[1], &vals
[2], &vals
[3],
1347 XSTRING (geo
)->data
, XSTRING (name
)->data
);
1354 for (i
= 0; i
< 4; i
++)
1355 XFASTINT (nums
[i
]) = vals
[i
];
1356 return Fcons (frame
, Flist (4, nums
));
1359 #endif /* not HAVE_X11 */
1361 choose_minibuf_frame ()
1363 /* For lowest-level minibuf, put it on currently selected frame
1364 if frame has a minibuffer. */
1366 if (minibuf_level
== 0
1367 && selected_frame
!= 0
1368 && !EQ (minibuf_window
, selected_frame
->minibuffer_window
))
1370 /* I don't think that any frames may validly have a null minibuffer
1372 if (NILP (selected_frame
->minibuffer_window
))
1375 Fset_window_buffer (selected_frame
->minibuffer_window
,
1376 XWINDOW (minibuf_window
)->buffer
);
1377 minibuf_window
= selected_frame
->minibuffer_window
;
1383 /*&&& init symbols here &&&*/
1384 Qframep
= intern ("framep");
1385 staticpro (&Qframep
);
1386 Qframe_live_p
= intern ("frame-live-p");
1387 staticpro (&Qframe_live_p
);
1388 Qheight
= intern ("height");
1389 staticpro (&Qheight
);
1390 Qicon
= intern ("icon");
1392 Qminibuffer
= intern ("minibuffer");
1393 staticpro (&Qminibuffer
);
1394 Qmodeline
= intern ("modeline");
1395 staticpro (&Qmodeline
);
1396 Qname
= intern ("name");
1398 Qonly
= intern ("only");
1400 Qunsplittable
= intern ("unsplittable");
1401 staticpro (&Qunsplittable
);
1402 Qwidth
= intern ("width");
1403 staticpro (&Qwidth
);
1407 staticpro (&Vframe_list
);
1409 DEFVAR_LISP ("terminal-frame", &Vterminal_frame
,
1410 "The initial frame-object, which represents Emacs's stdout.");
1412 DEFVAR_LISP ("emacs-iconified", &Vemacs_iconified
,
1413 "Non-nil if all of emacs is iconified and frame updates are not needed.");
1414 Vemacs_iconified
= Qnil
;
1416 DEFVAR_LISP ("default-minibuffer-frame", &Vdefault_minibuffer_frame
,
1417 "Minibufferless frames use this frame's minibuffer.\n\
1419 Emacs cannot create minibufferless frames unless this is set to an\n\
1420 appropriate surrogate.\n\
1422 Emacs consults this variable only when creating minibufferless\n\
1423 frames; once the frame is created, it sticks with its assigned\n\
1424 minibuffer, no matter what this variable is set to. This means that\n\
1425 this variable doesn't necessarily say anything meaningful about the\n\
1426 current set of frames, or where the minibuffer is currently being\n\
1428 Vdefault_minibuffer_frame
= Qnil
;
1430 DEFVAR_LISP ("default-frame-alist", &Vdefault_frame_alist
,
1431 "Alist of default values for frame creation.\n\
1432 These may be set in your init file, like this:\n\
1433 (setq default-frame-alist '((width . 80) (height . 55)))\n\
1434 These override values given in window system configuration data, like\n\
1435 X Windows' defaults database.\n\
1436 For values specific to the first Emacs frame, see `initial-frame-alist'.\n\
1437 For values specific to the separate minibuffer frame, see\n\
1438 `minibuffer-frame-alist'.");
1439 Vdefault_frame_alist
= Qnil
;
1442 defsubr (&Sframe_live_p
);
1443 defsubr (&Sselect_frame
);
1444 defsubr (&Sselected_frame
);
1445 defsubr (&Swindow_frame
);
1446 defsubr (&Sframe_root_window
);
1447 defsubr (&Sframe_selected_window
);
1448 defsubr (&Sframe_list
);
1449 defsubr (&Snext_frame
);
1450 defsubr (&Sdelete_frame
);
1451 defsubr (&Smouse_position
);
1452 defsubr (&Sset_mouse_position
);
1454 defsubr (&Sframe_configuration
);
1455 defsubr (&Srestore_frame_configuration
);
1457 defsubr (&Smake_frame_visible
);
1458 defsubr (&Smake_frame_invisible
);
1459 defsubr (&Siconify_frame
);
1460 defsubr (&Sframe_visible_p
);
1461 defsubr (&Svisible_frame_list
);
1462 defsubr (&Sframe_to_front
);
1463 defsubr (&Sframe_to_back
);
1464 defsubr (&Sredirect_frame_focus
);
1465 defsubr (&Sframe_focus
);
1466 defsubr (&Sframe_parameters
);
1467 defsubr (&Smodify_frame_parameters
);
1469 defsubr (&Sframe_pixel_size
);
1470 defsubr (&Sframe_height
);
1471 defsubr (&Sframe_width
);
1473 defsubr (&Sset_frame_height
);
1474 defsubr (&Sset_frame_width
);
1475 defsubr (&Sset_frame_size
);
1476 defsubr (&Sset_frame_position
);
1478 defsubr (&Srubber_band_rectangle
);
1479 #endif /* HAVE_X11 */
1484 initial_define_lispy_key (global_map
, "switch-frame", "select-frame");
1487 #else /* not MULTI_FRAME */
1489 /* If we're not using multi-frame stuff, we still need to provide some
1490 support functions. */
1492 /* Unless this function is defined, providing set-frame-height and
1493 set-frame-width doesn't help compatibility any, since they both
1494 want this as their first argument. */
1495 DEFUN ("selected-frame", Fselected_frame
, Sselected_frame
, 0, 0, 0,
1496 "Return the frame that is now selected.")
1504 DEFUN ("set-frame-height", Fset_frame_height
, Sset_frame_height
, 2, 3, 0,
1505 "Specify that the frame FRAME has LINES lines.\n\
1506 Optional third arg non-nil means that redisplay should use LINES lines\n\
1507 but that the idea of the actual height of the frame should not be changed.")
1508 (frame
, rows
, pretend
)
1509 Lisp_Object frame
, rows
, pretend
;
1511 CHECK_NUMBER (rows
, 0);
1513 change_frame_size (0, XINT (rows
), 0, !NILP (pretend
), 0);
1517 DEFUN ("set-frame-width", Fset_frame_width
, Sset_frame_width
, 2, 3, 0,
1518 "Specify that the frame FRAME has COLS columns.\n\
1519 Optional third arg non-nil means that redisplay should use COLS columns\n\
1520 but that the idea of the actual width of the frame should not be changed.")
1521 (frame
, cols
, pretend
)
1522 Lisp_Object frame
, cols
, pretend
;
1524 CHECK_NUMBER (cols
, 0);
1526 change_frame_size (0, 0, XINT (cols
), !NILP (pretend
), 0);
1530 DEFUN ("set-frame-size", Fset_frame_size
, Sset_frame_size
, 3, 3, 0,
1531 "Sets size of FRAME to COLS by ROWS, measured in characters.")
1533 Lisp_Object frame
, cols
, rows
;
1535 CHECK_NUMBER (cols
, 2);
1536 CHECK_NUMBER (rows
, 1);
1538 change_frame_size (0, XINT (rows
), XINT (cols
), 0, 0);
1543 DEFUN ("frame-height", Fframe_height
, Sframe_height
, 0, 0, 0,
1544 "Return number of lines available for display on selected frame.")
1547 return make_number (FRAME_HEIGHT (selected_frame
));
1550 DEFUN ("frame-width", Fframe_width
, Sframe_width
, 0, 0, 0,
1551 "Return number of columns available for display on selected frame.")
1554 return make_number (FRAME_WIDTH (selected_frame
));
1557 /* These are for backward compatibility with Emacs 18. */
1559 DEFUN ("set-screen-height", Fset_screen_height
, Sset_screen_height
, 1, 2, 0,
1560 "Tell redisplay that the screen has LINES lines.\n\
1561 Optional second arg non-nil means that redisplay should use LINES lines\n\
1562 but that the idea of the actual height of the screen should not be changed.")
1564 Lisp_Object lines
, pretend
;
1566 CHECK_NUMBER (lines
, 0);
1568 change_frame_size (0, XINT (lines
), 0, !NILP (pretend
), 0);
1572 DEFUN ("set-screen-width", Fset_screen_width
, Sset_screen_width
, 1, 2, 0,
1573 "Tell redisplay that the screen has COLS columns.\n\
1574 Optional second arg non-nil means that redisplay should use COLS columns\n\
1575 but that the idea of the actual width of the screen should not be changed.")
1577 Lisp_Object cols
, pretend
;
1579 CHECK_NUMBER (cols
, 0);
1581 change_frame_size (0, 0, XINT (cols
), !NILP (pretend
), 0);
1587 defsubr (&Sset_frame_height
);
1588 defsubr (&Sset_frame_width
);
1589 defsubr (&Sset_frame_size
);
1590 defsubr (&Sset_screen_height
);
1591 defsubr (&Sset_screen_width
);
1592 defsubr (&Sframe_height
);
1593 Ffset (intern ("screen-height"), intern ("frame-height"));
1594 defsubr (&Sframe_width
);
1595 Ffset (intern ("screen-width"), intern ("frame-width"));
1602 #endif /* not MULTI_FRAME */