*** empty log message ***
[emacs.git] / src / frame.c
blob3e84a3d81cf210254b2b1daa4f85d6447bd6c0b0
1 /* Generic frame functions.
2 Copyright (C) 1993, 1994, 1995, 1997, 1999, 2000, 2001
3 Free Software Foundation.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #include <config.h>
24 #include <stdio.h>
25 #include "lisp.h"
26 #include "charset.h"
27 #ifdef HAVE_X_WINDOWS
28 #include "xterm.h"
29 #endif
30 #ifdef WINDOWSNT
31 #include "w32term.h"
32 #endif
33 #ifdef macintosh
34 #include "macterm.h"
35 #endif
36 #include "buffer.h"
37 /* These help us bind and responding to switch-frame events. */
38 #include "commands.h"
39 #include "keyboard.h"
40 #include "frame.h"
41 #ifdef HAVE_WINDOW_SYSTEM
42 #include "fontset.h"
43 #endif
44 #include "termhooks.h"
45 #include "dispextern.h"
46 #include "window.h"
47 #ifdef MSDOS
48 #include "msdos.h"
49 #include "dosfns.h"
50 #endif
52 Lisp_Object Qframep;
53 Lisp_Object Qframe_live_p;
54 Lisp_Object Qheight;
55 Lisp_Object Qicon;
56 Lisp_Object Qminibuffer;
57 Lisp_Object Qmodeline;
58 Lisp_Object Qname;
59 Lisp_Object Qonly;
60 Lisp_Object Qunsplittable;
61 Lisp_Object Qmenu_bar_lines;
62 Lisp_Object Qtool_bar_lines;
63 Lisp_Object Qwidth;
64 Lisp_Object Qx;
65 Lisp_Object Qw32;
66 Lisp_Object Qpc;
67 Lisp_Object Qmac;
68 Lisp_Object Qvisible;
69 Lisp_Object Qbuffer_predicate;
70 Lisp_Object Qbuffer_list;
71 Lisp_Object Qtitle;
72 Lisp_Object Qdisplay_type;
73 Lisp_Object Qbackground_mode;
74 Lisp_Object Qinhibit_default_face_x_resources;
76 Lisp_Object Vterminal_frame;
77 Lisp_Object Vdefault_frame_alist;
78 Lisp_Object Vmouse_position_function;
80 static void
81 set_menu_bar_lines_1 (window, n)
82 Lisp_Object window;
83 int n;
85 struct window *w = XWINDOW (window);
87 XSETFASTINT (w->last_modified, 0);
88 XSETFASTINT (w->top, XFASTINT (w->top) + n);
89 XSETFASTINT (w->height, XFASTINT (w->height) - n);
91 if (INTEGERP (w->orig_top))
92 XSETFASTINT (w->orig_top, XFASTINT (w->orig_top) + n);
93 if (INTEGERP (w->orig_height))
94 XSETFASTINT (w->orig_height, XFASTINT (w->orig_height) - n);
96 /* Handle just the top child in a vertical split. */
97 if (!NILP (w->vchild))
98 set_menu_bar_lines_1 (w->vchild, n);
100 /* Adjust all children in a horizontal split. */
101 for (window = w->hchild; !NILP (window); window = w->next)
103 w = XWINDOW (window);
104 set_menu_bar_lines_1 (window, n);
108 void
109 set_menu_bar_lines (f, value, oldval)
110 struct frame *f;
111 Lisp_Object value, oldval;
113 int nlines;
114 int olines = FRAME_MENU_BAR_LINES (f);
116 /* Right now, menu bars don't work properly in minibuf-only frames;
117 most of the commands try to apply themselves to the minibuffer
118 frame itself, and get an error because you can't switch buffers
119 in or split the minibuffer window. */
120 if (FRAME_MINIBUF_ONLY_P (f))
121 return;
123 if (INTEGERP (value))
124 nlines = XINT (value);
125 else
126 nlines = 0;
128 if (nlines != olines)
130 windows_or_buffers_changed++;
131 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
132 FRAME_MENU_BAR_LINES (f) = nlines;
133 set_menu_bar_lines_1 (f->root_window, nlines - olines);
134 adjust_glyphs (f);
138 Lisp_Object Vemacs_iconified;
139 Lisp_Object Vframe_list;
141 struct x_output tty_display;
143 extern Lisp_Object Vminibuffer_list;
144 extern Lisp_Object get_minibuffer ();
145 extern Lisp_Object Fhandle_switch_frame ();
146 extern Lisp_Object Fredirect_frame_focus ();
147 extern Lisp_Object x_get_focus_frame ();
149 DEFUN ("framep", Fframep, Sframep, 1, 1, 0,
150 "Return non-nil if OBJECT is a frame.\n\
151 Value is t for a termcap frame (a character-only terminal),\n\
152 `x' for an Emacs frame that is really an X window,\n\
153 `w32' for an Emacs frame that is a window on MS-Windows display,\n\
154 `mac' for an Emacs frame on a Macintosh display,\n\
155 `pc' for a direct-write MS-DOS frame.\n\
156 See also `frame-live-p'.")
157 (object)
158 Lisp_Object object;
160 if (!FRAMEP (object))
161 return Qnil;
162 switch (XFRAME (object)->output_method)
164 case output_termcap:
165 return Qt;
166 case output_x_window:
167 return Qx;
168 case output_w32:
169 return Qw32;
170 case output_msdos_raw:
171 return Qpc;
172 case output_mac:
173 return Qmac;
174 default:
175 abort ();
179 DEFUN ("frame-live-p", Fframe_live_p, Sframe_live_p, 1, 1, 0,
180 "Return non-nil if OBJECT is a frame which has not been deleted.\n\
181 Value is nil if OBJECT is not a live frame. If object is a live\n\
182 frame, the return value indicates what sort of output device it is\n\
183 displayed on. Value is t for a termcap frame (a character-only\n\
184 terminal), `x' for an Emacs frame being displayed in an X window.")
185 (object)
186 Lisp_Object object;
188 return ((FRAMEP (object)
189 && FRAME_LIVE_P (XFRAME (object)))
190 ? Fframep (object)
191 : Qnil);
194 struct frame *
195 make_frame (mini_p)
196 int mini_p;
198 Lisp_Object frame;
199 register struct frame *f;
200 register Lisp_Object root_window;
201 register Lisp_Object mini_window;
203 f = allocate_frame ();
204 XSETFRAME (frame, f);
206 f->desired_matrix = 0;
207 f->current_matrix = 0;
208 f->desired_pool = 0;
209 f->current_pool = 0;
210 f->glyphs_initialized_p = 0;
211 f->decode_mode_spec_buffer = 0;
212 f->visible = 0;
213 f->async_visible = 0;
214 f->output_data.nothing = 0;
215 f->iconified = 0;
216 f->async_iconified = 0;
217 f->wants_modeline = 1;
218 f->auto_raise = 0;
219 f->auto_lower = 0;
220 f->no_split = 0;
221 f->garbaged = 1;
222 f->has_minibuffer = mini_p;
223 f->focus_frame = Qnil;
224 f->explicit_name = 0;
225 f->can_have_scroll_bars = 0;
226 f->vertical_scroll_bar_type = vertical_scroll_bar_none;
227 f->param_alist = Qnil;
228 f->scroll_bars = Qnil;
229 f->condemned_scroll_bars = Qnil;
230 f->face_alist = Qnil;
231 f->face_cache = NULL;
232 f->menu_bar_items = Qnil;
233 f->menu_bar_vector = Qnil;
234 f->menu_bar_items_used = 0;
235 f->buffer_predicate = Qnil;
236 f->buffer_list = Qnil;
237 #ifdef MULTI_KBOARD
238 f->kboard = initial_kboard;
239 #endif
240 f->namebuf = 0;
241 f->title = Qnil;
242 f->menu_bar_window = Qnil;
243 f->tool_bar_window = Qnil;
244 f->tool_bar_items = Qnil;
245 f->desired_tool_bar_string = f->current_tool_bar_string = Qnil;
246 f->n_tool_bar_items = 0;
248 root_window = make_window ();
249 if (mini_p)
251 mini_window = make_window ();
252 XWINDOW (root_window)->next = mini_window;
253 XWINDOW (mini_window)->prev = root_window;
254 XWINDOW (mini_window)->mini_p = Qt;
255 XWINDOW (mini_window)->frame = frame;
256 f->minibuffer_window = mini_window;
258 else
260 mini_window = Qnil;
261 XWINDOW (root_window)->next = Qnil;
262 f->minibuffer_window = Qnil;
265 XWINDOW (root_window)->frame = frame;
267 /* 10 is arbitrary,
268 just so that there is "something there."
269 Correct size will be set up later with change_frame_size. */
271 SET_FRAME_WIDTH (f, 10);
272 f->height = 10;
274 XSETFASTINT (XWINDOW (root_window)->width, 10);
275 XSETFASTINT (XWINDOW (root_window)->height, (mini_p ? 9 : 10));
277 if (mini_p)
279 XSETFASTINT (XWINDOW (mini_window)->width, 10);
280 XSETFASTINT (XWINDOW (mini_window)->top, 9);
281 XSETFASTINT (XWINDOW (mini_window)->height, 1);
284 /* Choose a buffer for the frame's root window. */
286 Lisp_Object buf;
288 XWINDOW (root_window)->buffer = Qt;
289 buf = Fcurrent_buffer ();
290 /* If buf is a 'hidden' buffer (i.e. one whose name starts with
291 a space), try to find another one. */
292 if (XSTRING (Fbuffer_name (buf))->data[0] == ' ')
293 buf = Fother_buffer (buf, Qnil, Qnil);
295 /* Use set_window_buffer, not Fset_window_buffer, and don't let
296 hooks be run by it. The reason is that the whole frame/window
297 arrangement is not yet fully intialized at this point. Windows
298 don't have the right size, glyph matrices aren't initialized
299 etc. Running Lisp functions at this point surely ends in a
300 SEGV. */
301 set_window_buffer (root_window, buf, 0);
302 f->buffer_list = Fcons (buf, Qnil);
305 if (mini_p)
307 XWINDOW (mini_window)->buffer = Qt;
308 set_window_buffer (mini_window,
309 (NILP (Vminibuffer_list)
310 ? get_minibuffer (0)
311 : Fcar (Vminibuffer_list)),
315 f->root_window = root_window;
316 f->selected_window = root_window;
317 /* Make sure this window seems more recently used than
318 a newly-created, never-selected window. */
319 XSETFASTINT (XWINDOW (f->selected_window)->use_time, ++window_select_count);
321 return f;
324 #ifdef HAVE_WINDOW_SYSTEM
325 /* Make a frame using a separate minibuffer window on another frame.
326 MINI_WINDOW is the minibuffer window to use. nil means use the
327 default (the global minibuffer). */
329 struct frame *
330 make_frame_without_minibuffer (mini_window, kb, display)
331 register Lisp_Object mini_window;
332 KBOARD *kb;
333 Lisp_Object display;
335 register struct frame *f;
336 struct gcpro gcpro1;
338 if (!NILP (mini_window))
339 CHECK_LIVE_WINDOW (mini_window, 0);
341 #ifdef MULTI_KBOARD
342 if (!NILP (mini_window)
343 && XFRAME (XWINDOW (mini_window)->frame)->kboard != kb)
344 error ("frame and minibuffer must be on the same display");
345 #endif
347 /* Make a frame containing just a root window. */
348 f = make_frame (0);
350 if (NILP (mini_window))
352 /* Use default-minibuffer-frame if possible. */
353 if (!FRAMEP (kb->Vdefault_minibuffer_frame)
354 || ! FRAME_LIVE_P (XFRAME (kb->Vdefault_minibuffer_frame)))
356 Lisp_Object frame_dummy;
358 XSETFRAME (frame_dummy, f);
359 GCPRO1 (frame_dummy);
360 /* If there's no minibuffer frame to use, create one. */
361 kb->Vdefault_minibuffer_frame =
362 call1 (intern ("make-initial-minibuffer-frame"), display);
363 UNGCPRO;
366 mini_window = XFRAME (kb->Vdefault_minibuffer_frame)->minibuffer_window;
369 f->minibuffer_window = mini_window;
371 /* Make the chosen minibuffer window display the proper minibuffer,
372 unless it is already showing a minibuffer. */
373 if (NILP (Fmemq (XWINDOW (mini_window)->buffer, Vminibuffer_list)))
374 Fset_window_buffer (mini_window,
375 (NILP (Vminibuffer_list)
376 ? get_minibuffer (0)
377 : Fcar (Vminibuffer_list)));
378 return f;
381 /* Make a frame containing only a minibuffer window. */
383 struct frame *
384 make_minibuffer_frame ()
386 /* First make a frame containing just a root window, no minibuffer. */
388 register struct frame *f = make_frame (0);
389 register Lisp_Object mini_window;
390 register Lisp_Object frame;
392 XSETFRAME (frame, f);
394 f->auto_raise = 0;
395 f->auto_lower = 0;
396 f->no_split = 1;
397 f->wants_modeline = 0;
398 f->has_minibuffer = 1;
400 /* Now label the root window as also being the minibuffer.
401 Avoid infinite looping on the window chain by marking next pointer
402 as nil. */
404 mini_window = f->minibuffer_window = f->root_window;
405 XWINDOW (mini_window)->mini_p = Qt;
406 XWINDOW (mini_window)->next = Qnil;
407 XWINDOW (mini_window)->prev = Qnil;
408 XWINDOW (mini_window)->frame = frame;
410 /* Put the proper buffer in that window. */
412 Fset_window_buffer (mini_window,
413 (NILP (Vminibuffer_list)
414 ? get_minibuffer (0)
415 : Fcar (Vminibuffer_list)));
416 return f;
418 #endif /* HAVE_WINDOW_SYSTEM */
420 /* Construct a frame that refers to the terminal (stdin and stdout). */
422 static int terminal_frame_count;
424 struct frame *
425 make_terminal_frame ()
427 register struct frame *f;
428 Lisp_Object frame;
429 char name[20];
431 #ifdef MULTI_KBOARD
432 if (!initial_kboard)
434 initial_kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
435 init_kboard (initial_kboard);
436 initial_kboard->next_kboard = all_kboards;
437 all_kboards = initial_kboard;
439 #endif
441 /* The first call must initialize Vframe_list. */
442 if (! (NILP (Vframe_list) || CONSP (Vframe_list)))
443 Vframe_list = Qnil;
445 f = make_frame (1);
447 XSETFRAME (frame, f);
448 Vframe_list = Fcons (frame, Vframe_list);
450 terminal_frame_count++;
451 sprintf (name, "F%d", terminal_frame_count);
452 f->name = build_string (name);
454 f->visible = 1; /* FRAME_SET_VISIBLE wd set frame_garbaged. */
455 f->async_visible = 1; /* Don't let visible be cleared later. */
456 #ifdef MSDOS
457 f->output_data.x = &the_only_x_display;
458 if (!inhibit_window_system
459 && (!FRAMEP (selected_frame) || !FRAME_LIVE_P (XFRAME (selected_frame))
460 || XFRAME (selected_frame)->output_method == output_msdos_raw))
462 f->output_method = output_msdos_raw;
463 /* This initialization of foreground and background pixels is
464 only important for the initial frame created in temacs. If
465 we don't do that, we get black background and foreground in
466 the dumped Emacs because the_only_x_display is a static
467 variable, hence it is born all-zeroes, and zero is the code
468 for the black color. Other frames all inherit their pixels
469 from what's already in the_only_x_display. */
470 if ((!FRAMEP (selected_frame) || !FRAME_LIVE_P (XFRAME (selected_frame)))
471 && f->output_data.x->background_pixel == 0
472 && f->output_data.x->foreground_pixel == 0)
474 f->output_data.x->background_pixel = FACE_TTY_DEFAULT_BG_COLOR;
475 f->output_data.x->foreground_pixel = FACE_TTY_DEFAULT_FG_COLOR;
478 else
479 f->output_method = output_termcap;
480 #else
481 #ifdef WINDOWSNT
482 f->output_method = output_termcap;
483 f->output_data.x = &tty_display;
484 #else
485 #ifdef macintosh
486 make_mac_terminal_frame (f);
487 #else
488 f->output_data.x = &tty_display;
489 #endif /* macintosh */
490 #endif /* WINDOWSNT */
491 #endif /* MSDOS */
493 if (!noninteractive)
494 init_frame_faces (f);
496 return f;
499 DEFUN ("make-terminal-frame", Fmake_terminal_frame, Smake_terminal_frame,
500 1, 1, 0, "Create an additional terminal frame.\n\
501 You can create multiple frames on a text-only terminal in this way.\n\
502 Only the selected terminal frame is actually displayed.\n\
503 This function takes one argument, an alist specifying frame parameters.\n\
504 In practice, generally you don't need to specify any parameters.\n\
505 Note that changing the size of one terminal frame automatically affects all.")
506 (parms)
507 Lisp_Object parms;
509 struct frame *f;
510 Lisp_Object frame, tem;
511 struct frame *sf = SELECTED_FRAME ();
513 #ifdef MSDOS
514 if (sf->output_method != output_msdos_raw
515 && sf->output_method != output_termcap)
516 abort ();
517 #else /* not MSDOS */
519 #ifdef macintosh
520 if (sf->output_method != output_mac)
521 error ("Not running on a Macintosh screen; cannot make a new Macintosh frame");
522 #else
523 if (sf->output_method != output_termcap)
524 error ("Not using an ASCII terminal now; cannot make a new ASCII frame");
525 #endif
526 #endif /* not MSDOS */
528 f = make_terminal_frame ();
530 change_frame_size (f, FRAME_HEIGHT (sf),
531 FRAME_WIDTH (sf), 0, 0, 0);
532 adjust_glyphs (f);
533 calculate_costs (f);
534 XSETFRAME (frame, f);
535 Fmodify_frame_parameters (frame, Vdefault_frame_alist);
536 Fmodify_frame_parameters (frame, parms);
538 /* Make the frame face alist be frame-specific, so that each
539 frame could change its face definitions independently. */
540 f->face_alist = Fcopy_alist (sf->face_alist);
541 /* Simple Fcopy_alist isn't enough, because we need the contents of
542 the vectors which are the CDRs of associations in face_alist to
543 be copied as well. */
544 for (tem = f->face_alist; CONSP (tem); tem = XCDR (tem))
545 XCDR (XCAR (tem)) = Fcopy_sequence (XCDR (XCAR (tem)));
546 return frame;
550 /* Perform the switch to frame FRAME.
552 If FRAME is a switch-frame event `(switch-frame FRAME1)', use
553 FRAME1 as frame.
555 If TRACK is non-zero and the frame that currently has the focus
556 redirects its focus to the selected frame, redirect that focused
557 frame's focus to FRAME instead.
559 FOR_DELETION non-zero means that the selected frame is being
560 deleted, which includes the possibility that the frame's display
561 is dead. */
563 Lisp_Object
564 do_switch_frame (frame, track, for_deletion)
565 Lisp_Object frame;
566 int track, for_deletion;
568 struct frame *sf = SELECTED_FRAME ();
570 /* If FRAME is a switch-frame event, extract the frame we should
571 switch to. */
572 if (CONSP (frame)
573 && EQ (XCAR (frame), Qswitch_frame)
574 && CONSP (XCDR (frame)))
575 frame = XCAR (XCDR (frame));
577 /* This used to say CHECK_LIVE_FRAME, but apparently it's possible for
578 a switch-frame event to arrive after a frame is no longer live,
579 especially when deleting the initial frame during startup. */
580 CHECK_FRAME (frame, 0);
581 if (! FRAME_LIVE_P (XFRAME (frame)))
582 return Qnil;
584 if (sf == XFRAME (frame))
585 return frame;
587 /* This is too greedy; it causes inappropriate focus redirection
588 that's hard to get rid of. */
589 #if 0
590 /* If a frame's focus has been redirected toward the currently
591 selected frame, we should change the redirection to point to the
592 newly selected frame. This means that if the focus is redirected
593 from a minibufferless frame to a surrogate minibuffer frame, we
594 can use `other-window' to switch between all the frames using
595 that minibuffer frame, and the focus redirection will follow us
596 around. */
597 if (track)
599 Lisp_Object tail;
601 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
603 Lisp_Object focus;
605 if (!FRAMEP (XCAR (tail)))
606 abort ();
608 focus = FRAME_FOCUS_FRAME (XFRAME (XCAR (tail)));
610 if (FRAMEP (focus) && XFRAME (focus) == SELECTED_FRAME ())
611 Fredirect_frame_focus (XCAR (tail), frame);
614 #else /* ! 0 */
615 /* Instead, apply it only to the frame we're pointing to. */
616 #ifdef HAVE_WINDOW_SYSTEM
617 if (track && FRAME_WINDOW_P (XFRAME (frame)))
619 Lisp_Object focus, xfocus;
621 xfocus = x_get_focus_frame (XFRAME (frame));
622 if (FRAMEP (xfocus))
624 focus = FRAME_FOCUS_FRAME (XFRAME (xfocus));
625 if (FRAMEP (focus) && XFRAME (focus) == SELECTED_FRAME ())
626 Fredirect_frame_focus (xfocus, frame);
629 #endif /* HAVE_X_WINDOWS */
630 #endif /* ! 0 */
632 if (!for_deletion && FRAME_HAS_MINIBUF_P (sf))
633 resize_mini_window (XWINDOW (FRAME_MINIBUF_WINDOW (sf)), 1);
635 selected_frame = frame;
636 if (! FRAME_MINIBUF_ONLY_P (XFRAME (selected_frame)))
637 last_nonminibuf_frame = XFRAME (selected_frame);
639 Fselect_window (XFRAME (frame)->selected_window);
641 /* We want to make sure that the next event generates a frame-switch
642 event to the appropriate frame. This seems kludgy to me, but
643 before you take it out, make sure that evaluating something like
644 (select-window (frame-root-window (new-frame))) doesn't end up
645 with your typing being interpreted in the new frame instead of
646 the one you're actually typing in. */
647 internal_last_event_frame = Qnil;
649 return frame;
652 DEFUN ("select-frame", Fselect_frame, Sselect_frame, 1, 2, "e",
653 "Select the frame FRAME.\n\
654 Subsequent editing commands apply to its selected window.\n\
655 The selection of FRAME lasts until the next time the user does\n\
656 something to select a different frame, or until the next time this\n\
657 function is called.")
658 (frame, no_enter)
659 Lisp_Object frame, no_enter;
661 return do_switch_frame (frame, 1, 0);
665 DEFUN ("handle-switch-frame", Fhandle_switch_frame, Shandle_switch_frame, 1, 2, "e",
666 "Handle a switch-frame event EVENT.\n\
667 Switch-frame events are usually bound to this function.\n\
668 A switch-frame event tells Emacs that the window manager has requested\n\
669 that the user's events be directed to the frame mentioned in the event.\n\
670 This function selects the selected window of the frame of EVENT.\n\
672 If EVENT is frame object, handle it as if it were a switch-frame event\n\
673 to that frame.")
674 (event, no_enter)
675 Lisp_Object event, no_enter;
677 /* Preserve prefix arg that the command loop just cleared. */
678 current_kboard->Vprefix_arg = Vcurrent_prefix_arg;
679 call1 (Vrun_hooks, Qmouse_leave_buffer_hook);
680 return do_switch_frame (event, 0, 0);
683 DEFUN ("ignore-event", Fignore_event, Signore_event, 0, 0, "",
684 "Do nothing, but preserve any prefix argument already specified.\n\
685 This is a suitable binding for iconify-frame and make-frame-visible.")
688 current_kboard->Vprefix_arg = Vcurrent_prefix_arg;
689 return Qnil;
692 DEFUN ("selected-frame", Fselected_frame, Sselected_frame, 0, 0, 0,
693 "Return the frame that is now selected.")
696 return selected_frame;
699 DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 1, 1, 0,
700 "Return the frame object that window WINDOW is on.")
701 (window)
702 Lisp_Object window;
704 CHECK_LIVE_WINDOW (window, 0);
705 return XWINDOW (window)->frame;
708 DEFUN ("frame-first-window", Fframe_first_window, Sframe_first_window, 0, 1, 0,
709 "Returns the topmost, leftmost window of FRAME.\n\
710 If omitted, FRAME defaults to the currently selected frame.")
711 (frame)
712 Lisp_Object frame;
714 Lisp_Object w;
716 if (NILP (frame))
717 w = SELECTED_FRAME ()->root_window;
718 else
720 CHECK_LIVE_FRAME (frame, 0);
721 w = XFRAME (frame)->root_window;
723 while (NILP (XWINDOW (w)->buffer))
725 if (! NILP (XWINDOW (w)->hchild))
726 w = XWINDOW (w)->hchild;
727 else if (! NILP (XWINDOW (w)->vchild))
728 w = XWINDOW (w)->vchild;
729 else
730 abort ();
732 return w;
735 DEFUN ("active-minibuffer-window", Factive_minibuffer_window,
736 Sactive_minibuffer_window, 0, 0, 0,
737 "Return the currently active minibuffer window, or nil if none.")
740 return minibuf_level ? minibuf_window : Qnil;
743 DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
744 "Returns the root-window of FRAME.\n\
745 If omitted, FRAME defaults to the currently selected frame.")
746 (frame)
747 Lisp_Object frame;
749 Lisp_Object window;
751 if (NILP (frame))
752 window = SELECTED_FRAME ()->root_window;
753 else
755 CHECK_LIVE_FRAME (frame, 0);
756 window = XFRAME (frame)->root_window;
759 return window;
762 DEFUN ("frame-selected-window", Fframe_selected_window,
763 Sframe_selected_window, 0, 1, 0,
764 "Return the selected window of frame object FRAME.\n\
765 If omitted, FRAME defaults to the currently selected frame.")
766 (frame)
767 Lisp_Object frame;
769 Lisp_Object window;
771 if (NILP (frame))
772 window = SELECTED_FRAME ()->selected_window;
773 else
775 CHECK_LIVE_FRAME (frame, 0);
776 window = XFRAME (frame)->selected_window;
779 return window;
782 DEFUN ("set-frame-selected-window", Fset_frame_selected_window,
783 Sset_frame_selected_window, 2, 2, 0,
784 "Set the selected window of frame object FRAME to WINDOW.\n\
785 If FRAME is nil, the selected frame is used.\n\
786 If FRAME is the selected frame, this makes WINDOW the selected window.")
787 (frame, window)
788 Lisp_Object frame, window;
790 if (NILP (frame))
791 frame = selected_frame;
793 CHECK_LIVE_FRAME (frame, 0);
794 CHECK_LIVE_WINDOW (window, 1);
796 if (! EQ (frame, WINDOW_FRAME (XWINDOW (window))))
797 error ("In `set-frame-selected-window', WINDOW is not on FRAME");
799 if (EQ (frame, selected_frame))
800 return Fselect_window (window);
802 return XFRAME (frame)->selected_window = window;
805 DEFUN ("frame-list", Fframe_list, Sframe_list,
806 0, 0, 0,
807 "Return a list of all frames.")
810 Lisp_Object frames;
811 frames = Fcopy_sequence (Vframe_list);
812 #ifdef HAVE_WINDOW_SYSTEM
813 if (FRAMEP (tip_frame))
814 frames = Fdelq (tip_frame, frames);
815 #endif
816 return frames;
819 /* Return the next frame in the frame list after FRAME.
820 If MINIBUF is nil, exclude minibuffer-only frames.
821 If MINIBUF is a window, include only its own frame
822 and any frame now using that window as the minibuffer.
823 If MINIBUF is `visible', include all visible frames.
824 If MINIBUF is 0, include all visible and iconified frames.
825 Otherwise, include all frames. */
827 Lisp_Object
828 next_frame (frame, minibuf)
829 Lisp_Object frame;
830 Lisp_Object minibuf;
832 Lisp_Object tail;
833 int passed = 0;
835 /* There must always be at least one frame in Vframe_list. */
836 if (! CONSP (Vframe_list))
837 abort ();
839 /* If this frame is dead, it won't be in Vframe_list, and we'll loop
840 forever. Forestall that. */
841 CHECK_LIVE_FRAME (frame, 0);
843 while (1)
844 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
846 Lisp_Object f;
848 f = XCAR (tail);
850 if (passed
851 && FRAME_KBOARD (XFRAME (f)) == FRAME_KBOARD (XFRAME (frame)))
853 /* Decide whether this frame is eligible to be returned. */
855 /* If we've looped all the way around without finding any
856 eligible frames, return the original frame. */
857 if (EQ (f, frame))
858 return f;
860 /* Let minibuf decide if this frame is acceptable. */
861 if (NILP (minibuf))
863 if (! FRAME_MINIBUF_ONLY_P (XFRAME (f)))
864 return f;
866 else if (EQ (minibuf, Qvisible))
868 FRAME_SAMPLE_VISIBILITY (XFRAME (f));
869 if (FRAME_VISIBLE_P (XFRAME (f)))
870 return f;
872 else if (INTEGERP (minibuf) && XINT (minibuf) == 0)
874 FRAME_SAMPLE_VISIBILITY (XFRAME (f));
875 if (FRAME_VISIBLE_P (XFRAME (f))
876 || FRAME_ICONIFIED_P (XFRAME (f)))
877 return f;
879 else if (WINDOWP (minibuf))
881 if (EQ (FRAME_MINIBUF_WINDOW (XFRAME (f)), minibuf)
882 || EQ (WINDOW_FRAME (XWINDOW (minibuf)), f)
883 || EQ (WINDOW_FRAME (XWINDOW (minibuf)),
884 FRAME_FOCUS_FRAME (XFRAME (f))))
885 return f;
887 else
888 return f;
891 if (EQ (frame, f))
892 passed++;
896 /* Return the previous frame in the frame list before FRAME.
897 If MINIBUF is nil, exclude minibuffer-only frames.
898 If MINIBUF is a window, include only its own frame
899 and any frame now using that window as the minibuffer.
900 If MINIBUF is `visible', include all visible frames.
901 If MINIBUF is 0, include all visible and iconified frames.
902 Otherwise, include all frames. */
904 Lisp_Object
905 prev_frame (frame, minibuf)
906 Lisp_Object frame;
907 Lisp_Object minibuf;
909 Lisp_Object tail;
910 Lisp_Object prev;
912 /* There must always be at least one frame in Vframe_list. */
913 if (! CONSP (Vframe_list))
914 abort ();
916 prev = Qnil;
917 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
919 Lisp_Object f;
921 f = XCAR (tail);
922 if (!FRAMEP (f))
923 abort ();
925 if (EQ (frame, f) && !NILP (prev))
926 return prev;
928 if (FRAME_KBOARD (XFRAME (f)) == FRAME_KBOARD (XFRAME (frame)))
930 /* Decide whether this frame is eligible to be returned,
931 according to minibuf. */
932 if (NILP (minibuf))
934 if (! FRAME_MINIBUF_ONLY_P (XFRAME (f)))
935 prev = f;
937 else if (WINDOWP (minibuf))
939 if (EQ (FRAME_MINIBUF_WINDOW (XFRAME (f)), minibuf)
940 || EQ (WINDOW_FRAME (XWINDOW (minibuf)), f)
941 || EQ (WINDOW_FRAME (XWINDOW (minibuf)),
942 FRAME_FOCUS_FRAME (XFRAME (f))))
943 prev = f;
945 else if (EQ (minibuf, Qvisible))
947 FRAME_SAMPLE_VISIBILITY (XFRAME (f));
948 if (FRAME_VISIBLE_P (XFRAME (f)))
949 prev = f;
951 else if (XFASTINT (minibuf) == 0)
953 FRAME_SAMPLE_VISIBILITY (XFRAME (f));
954 if (FRAME_VISIBLE_P (XFRAME (f))
955 || FRAME_ICONIFIED_P (XFRAME (f)))
956 prev = f;
958 else
959 prev = f;
963 /* We've scanned the entire list. */
964 if (NILP (prev))
965 /* We went through the whole frame list without finding a single
966 acceptable frame. Return the original frame. */
967 return frame;
968 else
969 /* There were no acceptable frames in the list before FRAME; otherwise,
970 we would have returned directly from the loop. Since PREV is the last
971 acceptable frame in the list, return it. */
972 return prev;
976 DEFUN ("next-frame", Fnext_frame, Snext_frame, 0, 2, 0,
977 "Return the next frame in the frame list after FRAME.\n\
978 It considers only frames on the same terminal as FRAME.\n\
979 By default, skip minibuffer-only frames.\n\
980 If omitted, FRAME defaults to the selected frame.\n\
981 If optional argument MINIFRAME is nil, exclude minibuffer-only frames.\n\
982 If MINIFRAME is a window, include only its own frame\n\
983 and any frame now using that window as the minibuffer.\n\
984 If MINIFRAME is `visible', include all visible frames.\n\
985 If MINIFRAME is 0, include all visible and iconified frames.\n\
986 Otherwise, include all frames.")
987 (frame, miniframe)
988 Lisp_Object frame, miniframe;
990 if (NILP (frame))
991 frame = selected_frame;
993 CHECK_LIVE_FRAME (frame, 0);
994 return next_frame (frame, miniframe);
997 DEFUN ("previous-frame", Fprevious_frame, Sprevious_frame, 0, 2, 0,
998 "Return the previous frame in the frame list before FRAME.\n\
999 It considers only frames on the same terminal as FRAME.\n\
1000 By default, skip minibuffer-only frames.\n\
1001 If omitted, FRAME defaults to the selected frame.\n\
1002 If optional argument MINIFRAME is nil, exclude minibuffer-only frames.\n\
1003 If MINIFRAME is a window, include only its own frame\n\
1004 and any frame now using that window as the minibuffer.\n\
1005 If MINIFRAME is `visible', include all visible frames.\n\
1006 If MINIFRAME is 0, include all visible and iconified frames.\n\
1007 Otherwise, include all frames.")
1008 (frame, miniframe)
1009 Lisp_Object frame, miniframe;
1011 if (NILP (frame))
1012 frame = selected_frame;
1013 CHECK_LIVE_FRAME (frame, 0);
1014 return prev_frame (frame, miniframe);
1017 /* Return 1 if it is ok to delete frame F;
1018 0 if all frames aside from F are invisible.
1019 (Exception: if F is the terminal frame, and we are using X, return 1.) */
1022 other_visible_frames (f)
1023 FRAME_PTR f;
1025 /* We know the selected frame is visible,
1026 so if F is some other frame, it can't be the sole visible one. */
1027 if (f == SELECTED_FRAME ())
1029 Lisp_Object frames;
1030 int count = 0;
1032 for (frames = Vframe_list;
1033 CONSP (frames);
1034 frames = XCDR (frames))
1036 Lisp_Object this;
1038 this = XCAR (frames);
1039 /* Verify that the frame's window still exists
1040 and we can still talk to it. And note any recent change
1041 in visibility. */
1042 #ifdef HAVE_WINDOW_SYSTEM
1043 if (FRAME_WINDOW_P (XFRAME (this)))
1045 x_sync (XFRAME (this));
1046 FRAME_SAMPLE_VISIBILITY (XFRAME (this));
1048 #endif
1050 if (FRAME_VISIBLE_P (XFRAME (this))
1051 || FRAME_ICONIFIED_P (XFRAME (this))
1052 /* Allow deleting the terminal frame when at least
1053 one X frame exists! */
1054 || (FRAME_WINDOW_P (XFRAME (this)) && !FRAME_WINDOW_P (f)))
1055 count++;
1057 return count > 1;
1059 return 1;
1062 DEFUN ("delete-frame", Fdelete_frame, Sdelete_frame, 0, 2, "",
1063 "Delete FRAME, permanently eliminating it from use.\n\
1064 If omitted, FRAME defaults to the selected frame.\n\
1065 A frame may not be deleted if its minibuffer is used by other frames.\n\
1066 Normally, you may not delete a frame if all other frames are invisible,\n\
1067 but if the second optional argument FORCE is non-nil, you may do so.\n\
1069 This function runs `delete-frame-hook' before actually deleting the\n\
1070 frame. The hook is called with one argument FRAME.")
1071 (frame, force)
1072 Lisp_Object frame, force;
1074 struct frame *f;
1075 struct frame *sf = SELECTED_FRAME ();
1076 int minibuffer_selected;
1078 if (EQ (frame, Qnil))
1080 f = sf;
1081 XSETFRAME (frame, f);
1083 else
1085 CHECK_FRAME (frame, 0);
1086 f = XFRAME (frame);
1089 if (! FRAME_LIVE_P (f))
1090 return Qnil;
1092 if (NILP (force) && !other_visible_frames (f)
1093 #ifdef macintosh
1094 /* Terminal frame deleted before any other visible frames are
1095 created. */
1096 && strcmp (XSTRING (f->name)->data, "F1") != 0
1097 #endif
1099 error ("Attempt to delete the sole visible or iconified frame");
1101 #if 0
1102 /* This is a nice idea, but x_connection_closed needs to be able
1103 to delete the last frame, if it is gone. */
1104 if (NILP (XCDR (Vframe_list)))
1105 error ("Attempt to delete the only frame");
1106 #endif
1108 /* Does this frame have a minibuffer, and is it the surrogate
1109 minibuffer for any other frame? */
1110 if (FRAME_HAS_MINIBUF_P (XFRAME (frame)))
1112 Lisp_Object frames;
1114 for (frames = Vframe_list;
1115 CONSP (frames);
1116 frames = XCDR (frames))
1118 Lisp_Object this;
1119 this = XCAR (frames);
1121 if (! EQ (this, frame)
1122 && EQ (frame,
1123 WINDOW_FRAME (XWINDOW
1124 (FRAME_MINIBUF_WINDOW (XFRAME (this))))))
1125 error ("Attempt to delete a surrogate minibuffer frame");
1129 /* Run `delete-frame-hook'. */
1130 if (!NILP (Vrun_hooks))
1132 Lisp_Object args[2];
1133 args[0] = intern ("delete-frame-hook");
1134 args[1] = frame;
1135 Frun_hook_with_args (2, args);
1138 minibuffer_selected = EQ (minibuf_window, selected_window);
1140 /* Don't let the frame remain selected. */
1141 if (f == sf)
1143 Lisp_Object tail, frame1;
1145 /* Look for another visible frame on the same terminal. */
1146 frame1 = next_frame (frame, Qvisible);
1148 /* If there is none, find *some* other frame. */
1149 if (NILP (frame1) || EQ (frame1, frame))
1151 FOR_EACH_FRAME (tail, frame1)
1153 if (! EQ (frame, frame1))
1154 break;
1158 do_switch_frame (frame1, 0, 1);
1159 sf = SELECTED_FRAME ();
1162 /* Don't allow minibuf_window to remain on a deleted frame. */
1163 if (EQ (f->minibuffer_window, minibuf_window))
1165 Fset_window_buffer (sf->minibuffer_window,
1166 XWINDOW (minibuf_window)->buffer);
1167 minibuf_window = sf->minibuffer_window;
1169 /* If the dying minibuffer window was selected,
1170 select the new one. */
1171 if (minibuffer_selected)
1172 Fselect_window (minibuf_window);
1175 /* Don't let echo_area_window to remain on a deleted frame. */
1176 if (EQ (f->minibuffer_window, echo_area_window))
1177 echo_area_window = sf->minibuffer_window;
1179 /* Clear any X selections for this frame. */
1180 #ifdef HAVE_X_WINDOWS
1181 if (FRAME_X_P (f))
1182 x_clear_frame_selections (f);
1183 #endif
1185 /* Free glyphs.
1186 This function must be called before the window tree of the
1187 frame is deleted because windows contain dynamically allocated
1188 memory. */
1189 free_glyphs (f);
1191 /* Mark all the windows that used to be on FRAME as deleted, and then
1192 remove the reference to them. */
1193 delete_all_subwindows (XWINDOW (f->root_window));
1194 f->root_window = Qnil;
1196 Vframe_list = Fdelq (frame, Vframe_list);
1197 FRAME_SET_VISIBLE (f, 0);
1199 if (f->namebuf)
1200 xfree (f->namebuf);
1201 if (FRAME_INSERT_COST (f))
1202 xfree (FRAME_INSERT_COST (f));
1203 if (FRAME_DELETEN_COST (f))
1204 xfree (FRAME_DELETEN_COST (f));
1205 if (FRAME_INSERTN_COST (f))
1206 xfree (FRAME_INSERTN_COST (f));
1207 if (FRAME_DELETE_COST (f))
1208 xfree (FRAME_DELETE_COST (f));
1209 if (FRAME_MESSAGE_BUF (f))
1210 xfree (FRAME_MESSAGE_BUF (f));
1212 /* Since some events are handled at the interrupt level, we may get
1213 an event for f at any time; if we zero out the frame's display
1214 now, then we may trip up the event-handling code. Instead, we'll
1215 promise that the display of the frame must be valid until we have
1216 called the window-system-dependent frame destruction routine. */
1218 /* I think this should be done with a hook. */
1219 #ifdef HAVE_WINDOW_SYSTEM
1220 if (FRAME_WINDOW_P (f))
1221 x_destroy_window (f);
1222 #endif
1224 f->output_data.nothing = 0;
1226 /* If we've deleted the last_nonminibuf_frame, then try to find
1227 another one. */
1228 if (f == last_nonminibuf_frame)
1230 Lisp_Object frames;
1232 last_nonminibuf_frame = 0;
1234 for (frames = Vframe_list;
1235 CONSP (frames);
1236 frames = XCDR (frames))
1238 f = XFRAME (XCAR (frames));
1239 if (!FRAME_MINIBUF_ONLY_P (f))
1241 last_nonminibuf_frame = f;
1242 break;
1247 /* If we've deleted this keyboard's default_minibuffer_frame, try to
1248 find another one. Prefer minibuffer-only frames, but also notice
1249 frames with other windows. */
1250 if (EQ (frame, FRAME_KBOARD (f)->Vdefault_minibuffer_frame))
1252 Lisp_Object frames;
1254 /* The last frame we saw with a minibuffer, minibuffer-only or not. */
1255 Lisp_Object frame_with_minibuf;
1256 /* Some frame we found on the same kboard, or nil if there are none. */
1257 Lisp_Object frame_on_same_kboard;
1259 frame_on_same_kboard = Qnil;
1260 frame_with_minibuf = Qnil;
1262 for (frames = Vframe_list;
1263 CONSP (frames);
1264 frames = XCDR (frames))
1266 Lisp_Object this;
1267 struct frame *f1;
1269 this = XCAR (frames);
1270 if (!FRAMEP (this))
1271 abort ();
1272 f1 = XFRAME (this);
1274 /* Consider only frames on the same kboard
1275 and only those with minibuffers. */
1276 if (FRAME_KBOARD (f) == FRAME_KBOARD (f1)
1277 && FRAME_HAS_MINIBUF_P (f1))
1279 frame_with_minibuf = this;
1280 if (FRAME_MINIBUF_ONLY_P (f1))
1281 break;
1284 if (FRAME_KBOARD (f) == FRAME_KBOARD (f1))
1285 frame_on_same_kboard = this;
1288 if (!NILP (frame_on_same_kboard))
1290 /* We know that there must be some frame with a minibuffer out
1291 there. If this were not true, all of the frames present
1292 would have to be minibufferless, which implies that at some
1293 point their minibuffer frames must have been deleted, but
1294 that is prohibited at the top; you can't delete surrogate
1295 minibuffer frames. */
1296 if (NILP (frame_with_minibuf))
1297 abort ();
1299 FRAME_KBOARD (f)->Vdefault_minibuffer_frame = frame_with_minibuf;
1301 else
1302 /* No frames left on this kboard--say no minibuffer either. */
1303 FRAME_KBOARD (f)->Vdefault_minibuffer_frame = Qnil;
1306 /* Cause frame titles to update--necessary if we now have just one frame. */
1307 update_mode_lines = 1;
1309 return Qnil;
1312 /* Return mouse position in character cell units. */
1314 DEFUN ("mouse-position", Fmouse_position, Smouse_position, 0, 0, 0,
1315 "Return a list (FRAME X . Y) giving the current mouse frame and position.\n\
1316 The position is given in character cells, where (0, 0) is the\n\
1317 upper-left corner.\n\
1318 If Emacs is running on a mouseless terminal or hasn't been programmed\n\
1319 to read the mouse position, it returns the selected frame for FRAME\n\
1320 and nil for X and Y.\n\
1321 Runs the abnormal hook `mouse-position-function' with the normal return\n\
1322 value as argument.")
1325 FRAME_PTR f;
1326 Lisp_Object lispy_dummy;
1327 enum scroll_bar_part party_dummy;
1328 Lisp_Object x, y, retval;
1329 int col, row;
1330 unsigned long long_dummy;
1331 struct gcpro gcpro1;
1333 f = SELECTED_FRAME ();
1334 x = y = Qnil;
1336 #ifdef HAVE_MOUSE
1337 /* It's okay for the hook to refrain from storing anything. */
1338 if (mouse_position_hook)
1339 (*mouse_position_hook) (&f, -1,
1340 &lispy_dummy, &party_dummy,
1341 &x, &y,
1342 &long_dummy);
1343 if (! NILP (x))
1345 col = XINT (x);
1346 row = XINT (y);
1347 pixel_to_glyph_coords (f, col, row, &col, &row, NULL, 1);
1348 XSETINT (x, col);
1349 XSETINT (y, row);
1351 #endif
1352 XSETFRAME (lispy_dummy, f);
1353 retval = Fcons (lispy_dummy, Fcons (x, y));
1354 GCPRO1 (retval);
1355 if (!NILP (Vmouse_position_function))
1356 retval = call1 (Vmouse_position_function, retval);
1357 RETURN_UNGCPRO (retval);
1360 DEFUN ("mouse-pixel-position", Fmouse_pixel_position,
1361 Smouse_pixel_position, 0, 0, 0,
1362 "Return a list (FRAME X . Y) giving the current mouse frame and position.\n\
1363 The position is given in pixel units, where (0, 0) is the\n\
1364 upper-left corner.\n\
1365 If Emacs is running on a mouseless terminal or hasn't been programmed\n\
1366 to read the mouse position, it returns the selected frame for FRAME\n\
1367 and nil for X and Y.")
1370 FRAME_PTR f;
1371 Lisp_Object lispy_dummy;
1372 enum scroll_bar_part party_dummy;
1373 Lisp_Object x, y;
1374 unsigned long long_dummy;
1376 f = SELECTED_FRAME ();
1377 x = y = Qnil;
1379 #ifdef HAVE_MOUSE
1380 /* It's okay for the hook to refrain from storing anything. */
1381 if (mouse_position_hook)
1382 (*mouse_position_hook) (&f, -1,
1383 &lispy_dummy, &party_dummy,
1384 &x, &y,
1385 &long_dummy);
1386 #endif
1387 XSETFRAME (lispy_dummy, f);
1388 return Fcons (lispy_dummy, Fcons (x, y));
1391 DEFUN ("set-mouse-position", Fset_mouse_position, Sset_mouse_position, 3, 3, 0,
1392 "Move the mouse pointer to the center of character cell (X,Y) in FRAME.\n\
1393 Coordinates are relative to the frame, not a window,\n\
1394 so the coordinates of the top left character in the frame\n\
1395 may be nonzero due to left-hand scroll bars or the menu bar.\n\
1397 This function is a no-op for an X frame that is not visible.\n\
1398 If you have just created a frame, you must wait for it to become visible\n\
1399 before calling this function on it, like this.\n\
1400 (while (not (frame-visible-p frame)) (sleep-for .5))")
1401 (frame, x, y)
1402 Lisp_Object frame, x, y;
1404 CHECK_LIVE_FRAME (frame, 0);
1405 CHECK_NUMBER (x, 2);
1406 CHECK_NUMBER (y, 1);
1408 /* I think this should be done with a hook. */
1409 #ifdef HAVE_WINDOW_SYSTEM
1410 if (FRAME_WINDOW_P (XFRAME (frame)))
1411 /* Warping the mouse will cause enternotify and focus events. */
1412 x_set_mouse_position (XFRAME (frame), XINT (x), XINT (y));
1413 #else
1414 #if defined (MSDOS) && defined (HAVE_MOUSE)
1415 if (FRAME_MSDOS_P (XFRAME (frame)))
1417 Fselect_frame (frame, Qnil);
1418 mouse_moveto (XINT (x), XINT (y));
1420 #endif
1421 #endif
1423 return Qnil;
1426 DEFUN ("set-mouse-pixel-position", Fset_mouse_pixel_position,
1427 Sset_mouse_pixel_position, 3, 3, 0,
1428 "Move the mouse pointer to pixel position (X,Y) in FRAME.\n\
1429 Note, this is a no-op for an X frame that is not visible.\n\
1430 If you have just created a frame, you must wait for it to become visible\n\
1431 before calling this function on it, like this.\n\
1432 (while (not (frame-visible-p frame)) (sleep-for .5))")
1433 (frame, x, y)
1434 Lisp_Object frame, x, y;
1436 CHECK_LIVE_FRAME (frame, 0);
1437 CHECK_NUMBER (x, 2);
1438 CHECK_NUMBER (y, 1);
1440 /* I think this should be done with a hook. */
1441 #ifdef HAVE_WINDOW_SYSTEM
1442 if (FRAME_WINDOW_P (XFRAME (frame)))
1443 /* Warping the mouse will cause enternotify and focus events. */
1444 x_set_mouse_pixel_position (XFRAME (frame), XINT (x), XINT (y));
1445 #else
1446 #if defined (MSDOS) && defined (HAVE_MOUSE)
1447 if (FRAME_MSDOS_P (XFRAME (frame)))
1449 Fselect_frame (frame, Qnil);
1450 mouse_moveto (XINT (x), XINT (y));
1452 #endif
1453 #endif
1455 return Qnil;
1458 static void make_frame_visible_1 P_ ((Lisp_Object));
1460 DEFUN ("make-frame-visible", Fmake_frame_visible, Smake_frame_visible,
1461 0, 1, "",
1462 "Make the frame FRAME visible (assuming it is an X-window).\n\
1463 If omitted, FRAME defaults to the currently selected frame.")
1464 (frame)
1465 Lisp_Object frame;
1467 if (NILP (frame))
1468 frame = selected_frame;
1470 CHECK_LIVE_FRAME (frame, 0);
1472 /* I think this should be done with a hook. */
1473 #ifdef HAVE_WINDOW_SYSTEM
1474 if (FRAME_WINDOW_P (XFRAME (frame)))
1476 FRAME_SAMPLE_VISIBILITY (XFRAME (frame));
1477 x_make_frame_visible (XFRAME (frame));
1479 #endif
1481 make_frame_visible_1 (XFRAME (frame)->root_window);
1483 /* Make menu bar update for the Buffers and Frams menus. */
1484 windows_or_buffers_changed++;
1486 return frame;
1489 /* Update the display_time slot of the buffers shown in WINDOW
1490 and all its descendents. */
1492 static void
1493 make_frame_visible_1 (window)
1494 Lisp_Object window;
1496 struct window *w;
1498 for (;!NILP (window); window = w->next)
1500 w = XWINDOW (window);
1502 if (!NILP (w->buffer))
1503 XBUFFER (w->buffer)->display_time = Fcurrent_time ();
1505 if (!NILP (w->vchild))
1506 make_frame_visible_1 (w->vchild);
1507 if (!NILP (w->hchild))
1508 make_frame_visible_1 (w->hchild);
1512 DEFUN ("make-frame-invisible", Fmake_frame_invisible, Smake_frame_invisible,
1513 0, 2, "",
1514 "Make the frame FRAME invisible (assuming it is an X-window).\n\
1515 If omitted, FRAME defaults to the currently selected frame.\n\
1516 Normally you may not make FRAME invisible if all other frames are invisible,\n\
1517 but if the second optional argument FORCE is non-nil, you may do so.")
1518 (frame, force)
1519 Lisp_Object frame, force;
1521 if (NILP (frame))
1522 frame = selected_frame;
1524 CHECK_LIVE_FRAME (frame, 0);
1526 if (NILP (force) && !other_visible_frames (XFRAME (frame)))
1527 error ("Attempt to make invisible the sole visible or iconified frame");
1529 #if 0 /* This isn't logically necessary, and it can do GC. */
1530 /* Don't let the frame remain selected. */
1531 if (EQ (frame, selected_frame))
1532 do_switch_frame (next_frame (frame, Qt), 0, 0)
1533 #endif
1535 /* Don't allow minibuf_window to remain on a deleted frame. */
1536 if (EQ (XFRAME (frame)->minibuffer_window, minibuf_window))
1538 struct frame *sf = XFRAME (selected_frame);
1539 Fset_window_buffer (sf->minibuffer_window,
1540 XWINDOW (minibuf_window)->buffer);
1541 minibuf_window = sf->minibuffer_window;
1544 /* I think this should be done with a hook. */
1545 #ifdef HAVE_WINDOW_SYSTEM
1546 if (FRAME_WINDOW_P (XFRAME (frame)))
1547 x_make_frame_invisible (XFRAME (frame));
1548 #endif
1550 /* Make menu bar update for the Buffers and Frams menus. */
1551 windows_or_buffers_changed++;
1553 return Qnil;
1556 DEFUN ("iconify-frame", Ficonify_frame, Siconify_frame,
1557 0, 1, "",
1558 "Make the frame FRAME into an icon.\n\
1559 If omitted, FRAME defaults to the currently selected frame.")
1560 (frame)
1561 Lisp_Object frame;
1563 if (NILP (frame))
1564 frame = selected_frame;
1566 CHECK_LIVE_FRAME (frame, 0);
1568 #if 0 /* This isn't logically necessary, and it can do GC. */
1569 /* Don't let the frame remain selected. */
1570 if (EQ (frame, selected_frame))
1571 Fhandle_switch_frame (next_frame (frame, Qt), Qnil);
1572 #endif
1574 /* Don't allow minibuf_window to remain on a deleted frame. */
1575 if (EQ (XFRAME (frame)->minibuffer_window, minibuf_window))
1577 struct frame *sf = XFRAME (selected_frame);
1578 Fset_window_buffer (sf->minibuffer_window,
1579 XWINDOW (minibuf_window)->buffer);
1580 minibuf_window = sf->minibuffer_window;
1583 /* I think this should be done with a hook. */
1584 #ifdef HAVE_WINDOW_SYSTEM
1585 if (FRAME_WINDOW_P (XFRAME (frame)))
1586 x_iconify_frame (XFRAME (frame));
1587 #endif
1589 /* Make menu bar update for the Buffers and Frams menus. */
1590 windows_or_buffers_changed++;
1592 return Qnil;
1595 DEFUN ("frame-visible-p", Fframe_visible_p, Sframe_visible_p,
1596 1, 1, 0,
1597 "Return t if FRAME is now \"visible\" (actually in use for display).\n\
1598 A frame that is not \"visible\" is not updated and, if it works through\n\
1599 a window system, it may not show at all.\n\
1600 Return the symbol `icon' if frame is visible only as an icon.")
1601 (frame)
1602 Lisp_Object frame;
1604 CHECK_LIVE_FRAME (frame, 0);
1606 FRAME_SAMPLE_VISIBILITY (XFRAME (frame));
1608 if (FRAME_VISIBLE_P (XFRAME (frame)))
1609 return Qt;
1610 if (FRAME_ICONIFIED_P (XFRAME (frame)))
1611 return Qicon;
1612 return Qnil;
1615 DEFUN ("visible-frame-list", Fvisible_frame_list, Svisible_frame_list,
1616 0, 0, 0,
1617 "Return a list of all frames now \"visible\" (being updated).")
1620 Lisp_Object tail, frame;
1621 struct frame *f;
1622 Lisp_Object value;
1624 value = Qnil;
1625 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1627 frame = XCAR (tail);
1628 if (!FRAMEP (frame))
1629 continue;
1630 f = XFRAME (frame);
1631 if (FRAME_VISIBLE_P (f))
1632 value = Fcons (frame, value);
1634 return value;
1638 DEFUN ("raise-frame", Fraise_frame, Sraise_frame, 0, 1, "",
1639 "Bring FRAME to the front, so it occludes any frames it overlaps.\n\
1640 If FRAME is invisible, make it visible.\n\
1641 If you don't specify a frame, the selected frame is used.\n\
1642 If Emacs is displaying on an ordinary terminal or some other device which\n\
1643 doesn't support multiple overlapping frames, this function does nothing.")
1644 (frame)
1645 Lisp_Object frame;
1647 if (NILP (frame))
1648 frame = selected_frame;
1650 CHECK_LIVE_FRAME (frame, 0);
1652 /* Do like the documentation says. */
1653 Fmake_frame_visible (frame);
1655 if (frame_raise_lower_hook)
1656 (*frame_raise_lower_hook) (XFRAME (frame), 1);
1658 return Qnil;
1661 /* Should we have a corresponding function called Flower_Power? */
1662 DEFUN ("lower-frame", Flower_frame, Slower_frame, 0, 1, "",
1663 "Send FRAME to the back, so it is occluded by any frames that overlap it.\n\
1664 If you don't specify a frame, the selected frame is used.\n\
1665 If Emacs is displaying on an ordinary terminal or some other device which\n\
1666 doesn't support multiple overlapping frames, this function does nothing.")
1667 (frame)
1668 Lisp_Object frame;
1670 if (NILP (frame))
1671 frame = selected_frame;
1673 CHECK_LIVE_FRAME (frame, 0);
1675 if (frame_raise_lower_hook)
1676 (*frame_raise_lower_hook) (XFRAME (frame), 0);
1678 return Qnil;
1682 DEFUN ("redirect-frame-focus", Fredirect_frame_focus, Sredirect_frame_focus,
1683 1, 2, 0,
1684 "Arrange for keystrokes typed at FRAME to be sent to FOCUS-FRAME.\n\
1685 In other words, switch-frame events caused by events in FRAME will\n\
1686 request a switch to FOCUS-FRAME, and `last-event-frame' will be\n\
1687 FOCUS-FRAME after reading an event typed at FRAME.\n\
1689 If FOCUS-FRAME is omitted or nil, any existing redirection is\n\
1690 cancelled, and the frame again receives its own keystrokes.\n\
1692 Focus redirection is useful for temporarily redirecting keystrokes to\n\
1693 a surrogate minibuffer frame when a frame doesn't have its own\n\
1694 minibuffer window.\n\
1696 A frame's focus redirection can be changed by select-frame. If frame\n\
1697 FOO is selected, and then a different frame BAR is selected, any\n\
1698 frames redirecting their focus to FOO are shifted to redirect their\n\
1699 focus to BAR. This allows focus redirection to work properly when the\n\
1700 user switches from one frame to another using `select-window'.\n\
1702 This means that a frame whose focus is redirected to itself is treated\n\
1703 differently from a frame whose focus is redirected to nil; the former\n\
1704 is affected by select-frame, while the latter is not.\n\
1706 The redirection lasts until `redirect-frame-focus' is called to change it.")
1707 (frame, focus_frame)
1708 Lisp_Object frame, focus_frame;
1710 /* Note that we don't check for a live frame here. It's reasonable
1711 to redirect the focus of a frame you're about to delete, if you
1712 know what other frame should receive those keystrokes. */
1713 CHECK_FRAME (frame, 0);
1715 if (! NILP (focus_frame))
1716 CHECK_LIVE_FRAME (focus_frame, 1);
1718 XFRAME (frame)->focus_frame = focus_frame;
1720 if (frame_rehighlight_hook)
1721 (*frame_rehighlight_hook) (XFRAME (frame));
1723 return Qnil;
1727 DEFUN ("frame-focus", Fframe_focus, Sframe_focus, 1, 1, 0,
1728 "Return the frame to which FRAME's keystrokes are currently being sent.\n\
1729 This returns nil if FRAME's focus is not redirected.\n\
1730 See `redirect-frame-focus'.")
1731 (frame)
1732 Lisp_Object frame;
1734 CHECK_LIVE_FRAME (frame, 0);
1736 return FRAME_FOCUS_FRAME (XFRAME (frame));
1741 /* Return the value of frame parameter PROP in frame FRAME. */
1743 Lisp_Object
1744 get_frame_param (frame, prop)
1745 register struct frame *frame;
1746 Lisp_Object prop;
1748 register Lisp_Object tem;
1750 tem = Fassq (prop, frame->param_alist);
1751 if (EQ (tem, Qnil))
1752 return tem;
1753 return Fcdr (tem);
1756 /* Return the buffer-predicate of the selected frame. */
1758 Lisp_Object
1759 frame_buffer_predicate (frame)
1760 Lisp_Object frame;
1762 return XFRAME (frame)->buffer_predicate;
1765 /* Return the buffer-list of the selected frame. */
1767 Lisp_Object
1768 frame_buffer_list (frame)
1769 Lisp_Object frame;
1771 return XFRAME (frame)->buffer_list;
1774 /* Set the buffer-list of the selected frame. */
1776 void
1777 set_frame_buffer_list (frame, list)
1778 Lisp_Object frame, list;
1780 XFRAME (frame)->buffer_list = list;
1783 /* Discard BUFFER from the buffer-list of each frame. */
1785 void
1786 frames_discard_buffer (buffer)
1787 Lisp_Object buffer;
1789 Lisp_Object frame, tail;
1791 FOR_EACH_FRAME (tail, frame)
1793 XFRAME (frame)->buffer_list
1794 = Fdelq (buffer, XFRAME (frame)->buffer_list);
1798 /* Move BUFFER to the end of the buffer-list of each frame. */
1800 void
1801 frames_bury_buffer (buffer)
1802 Lisp_Object buffer;
1804 Lisp_Object frame, tail;
1806 FOR_EACH_FRAME (tail, frame)
1808 struct frame *f = XFRAME (frame);
1809 Lisp_Object found;
1811 found = Fmemq (buffer, f->buffer_list);
1812 if (!NILP (found))
1813 f->buffer_list = nconc2 (Fdelq (buffer, f->buffer_list),
1814 Fcons (buffer, Qnil));
1818 /* Modify the alist in *ALISTPTR to associate PROP with VAL.
1819 If the alist already has an element for PROP, we change it. */
1821 void
1822 store_in_alist (alistptr, prop, val)
1823 Lisp_Object *alistptr, val;
1824 Lisp_Object prop;
1826 register Lisp_Object tem;
1828 tem = Fassq (prop, *alistptr);
1829 if (EQ (tem, Qnil))
1830 *alistptr = Fcons (Fcons (prop, val), *alistptr);
1831 else
1832 Fsetcdr (tem, val);
1835 static int
1836 frame_name_fnn_p (str, len)
1837 char *str;
1838 int len;
1840 if (len > 1 && str[0] == 'F')
1842 char *end_ptr;
1844 strtol (str + 1, &end_ptr, 10);
1846 if (end_ptr == str + len)
1847 return 1;
1849 return 0;
1852 /* Set the name of the terminal frame. Also used by MSDOS frames.
1853 Modeled after x_set_name which is used for WINDOW frames. */
1855 void
1856 set_term_frame_name (f, name)
1857 struct frame *f;
1858 Lisp_Object name;
1860 f->explicit_name = ! NILP (name);
1862 /* If NAME is nil, set the name to F<num>. */
1863 if (NILP (name))
1865 char namebuf[20];
1867 /* Check for no change needed in this very common case
1868 before we do any consing. */
1869 if (frame_name_fnn_p (XSTRING (f->name)->data,
1870 STRING_BYTES (XSTRING (f->name))))
1871 return;
1873 terminal_frame_count++;
1874 sprintf (namebuf, "F%d", terminal_frame_count);
1875 name = build_string (namebuf);
1877 else
1879 CHECK_STRING (name, 0);
1881 /* Don't change the name if it's already NAME. */
1882 if (! NILP (Fstring_equal (name, f->name)))
1883 return;
1885 /* Don't allow the user to set the frame name to F<num>, so it
1886 doesn't clash with the names we generate for terminal frames. */
1887 if (frame_name_fnn_p (XSTRING (name)->data, STRING_BYTES (XSTRING (name))))
1888 error ("Frame names of the form F<num> are usurped by Emacs");
1891 f->name = name;
1892 update_mode_lines = 1;
1895 void
1896 store_frame_param (f, prop, val)
1897 struct frame *f;
1898 Lisp_Object prop, val;
1900 register Lisp_Object old_alist_elt;
1902 /* The buffer-alist parameter is stored in a special place and is
1903 not in the alist. */
1904 if (EQ (prop, Qbuffer_list))
1906 f->buffer_list = val;
1907 return;
1910 /* If PROP is a symbol which is supposed to have frame-local values,
1911 and it is set up based on this frame, switch to the global
1912 binding. That way, we can create or alter the frame-local binding
1913 without messing up the symbol's status. */
1914 if (SYMBOLP (prop))
1916 Lisp_Object valcontents;
1917 valcontents = XSYMBOL (prop)->value;
1918 if ((BUFFER_LOCAL_VALUEP (valcontents)
1919 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1920 && XBUFFER_LOCAL_VALUE (valcontents)->check_frame
1921 && XFRAME (XBUFFER_LOCAL_VALUE (valcontents)->frame) == f)
1922 swap_in_global_binding (prop);
1925 /* Update the frame parameter alist. */
1926 old_alist_elt = Fassq (prop, f->param_alist);
1927 if (EQ (old_alist_elt, Qnil))
1928 f->param_alist = Fcons (Fcons (prop, val), f->param_alist);
1929 else
1930 Fsetcdr (old_alist_elt, val);
1932 /* Update some other special parameters in their special places
1933 in addition to the alist. */
1935 if (EQ (prop, Qbuffer_predicate))
1936 f->buffer_predicate = val;
1938 if (! FRAME_WINDOW_P (f))
1940 if (EQ (prop, Qmenu_bar_lines))
1941 set_menu_bar_lines (f, val, make_number (FRAME_MENU_BAR_LINES (f)));
1942 else if (EQ (prop, Qname))
1943 set_term_frame_name (f, val);
1946 if (EQ (prop, Qminibuffer) && WINDOWP (val))
1948 if (! MINI_WINDOW_P (XWINDOW (val)))
1949 error ("Surrogate minibuffer windows must be minibuffer windows.");
1951 if ((FRAME_HAS_MINIBUF_P (f) || FRAME_MINIBUF_ONLY_P (f))
1952 && !EQ (val, f->minibuffer_window))
1953 error ("Can't change the surrogate minibuffer of a frame with its own minibuffer");
1955 /* Install the chosen minibuffer window, with proper buffer. */
1956 f->minibuffer_window = val;
1960 DEFUN ("frame-parameters", Fframe_parameters, Sframe_parameters, 0, 1, 0,
1961 "Return the parameters-alist of frame FRAME.\n\
1962 It is a list of elements of the form (PARM . VALUE), where PARM is a symbol.\n\
1963 The meaningful PARMs depend on the kind of frame.\n\
1964 If FRAME is omitted, return information on the currently selected frame.")
1965 (frame)
1966 Lisp_Object frame;
1968 Lisp_Object alist;
1969 FRAME_PTR f;
1970 int height, width;
1971 struct gcpro gcpro1;
1973 if (NILP (frame))
1974 frame = selected_frame;
1976 CHECK_FRAME (frame, 0);
1977 f = XFRAME (frame);
1979 if (!FRAME_LIVE_P (f))
1980 return Qnil;
1982 alist = Fcopy_alist (f->param_alist);
1983 GCPRO1 (alist);
1985 if (!FRAME_WINDOW_P (f))
1987 int fg = FRAME_FOREGROUND_PIXEL (f);
1988 int bg = FRAME_BACKGROUND_PIXEL (f);
1989 Lisp_Object elt;
1991 /* If the frame's parameter alist says the colors are
1992 unspecified and reversed, take the frame's background pixel
1993 for foreground and vice versa. */
1994 elt = Fassq (Qforeground_color, alist);
1995 if (!NILP (elt) && CONSP (elt) && STRINGP (XCDR (elt)))
1997 if (strncmp (XSTRING (XCDR (elt))->data,
1998 unspecified_bg,
1999 XSTRING (XCDR (elt))->size) == 0)
2000 store_in_alist (&alist, Qforeground_color, tty_color_name (f, bg));
2001 else if (strncmp (XSTRING (XCDR (elt))->data,
2002 unspecified_fg,
2003 XSTRING (XCDR (elt))->size) == 0)
2004 store_in_alist (&alist, Qforeground_color, tty_color_name (f, fg));
2006 else
2007 store_in_alist (&alist, Qforeground_color, tty_color_name (f, fg));
2008 elt = Fassq (Qbackground_color, alist);
2009 if (!NILP (elt) && CONSP (elt) && STRINGP (XCDR (elt)))
2011 if (strncmp (XSTRING (XCDR (elt))->data,
2012 unspecified_fg,
2013 XSTRING (XCDR (elt))->size) == 0)
2014 store_in_alist (&alist, Qbackground_color, tty_color_name (f, fg));
2015 else if (strncmp (XSTRING (XCDR (elt))->data,
2016 unspecified_bg,
2017 XSTRING (XCDR (elt))->size) == 0)
2018 store_in_alist (&alist, Qbackground_color, tty_color_name (f, bg));
2020 else
2021 store_in_alist (&alist, Qbackground_color, tty_color_name (f, bg));
2022 store_in_alist (&alist, intern ("font"),
2023 build_string (FRAME_MSDOS_P (f)
2024 ? "ms-dos"
2025 : FRAME_W32_P (f) ? "w32term"
2026 :"tty"));
2028 store_in_alist (&alist, Qname, f->name);
2029 height = (FRAME_NEW_HEIGHT (f) ? FRAME_NEW_HEIGHT (f) : FRAME_HEIGHT (f));
2030 store_in_alist (&alist, Qheight, make_number (height));
2031 width = (FRAME_NEW_WIDTH (f) ? FRAME_NEW_WIDTH (f) : FRAME_WIDTH (f));
2032 store_in_alist (&alist, Qwidth, make_number (width));
2033 store_in_alist (&alist, Qmodeline, (FRAME_WANTS_MODELINE_P (f) ? Qt : Qnil));
2034 store_in_alist (&alist, Qminibuffer,
2035 (! FRAME_HAS_MINIBUF_P (f) ? Qnil
2036 : FRAME_MINIBUF_ONLY_P (f) ? Qonly
2037 : FRAME_MINIBUF_WINDOW (f)));
2038 store_in_alist (&alist, Qunsplittable, (FRAME_NO_SPLIT_P (f) ? Qt : Qnil));
2039 store_in_alist (&alist, Qbuffer_list, frame_buffer_list (frame));
2041 /* I think this should be done with a hook. */
2042 #ifdef HAVE_WINDOW_SYSTEM
2043 if (FRAME_WINDOW_P (f))
2044 x_report_frame_params (f, &alist);
2045 else
2046 #endif
2048 /* This ought to be correct in f->param_alist for an X frame. */
2049 Lisp_Object lines;
2050 XSETFASTINT (lines, FRAME_MENU_BAR_LINES (f));
2051 store_in_alist (&alist, Qmenu_bar_lines, lines);
2054 UNGCPRO;
2055 return alist;
2059 DEFUN ("frame-parameter", Fframe_parameter, Sframe_parameter, 2, 2, 0,
2060 "Return FRAME's value for parameter PARAMETER.\n\
2061 If FRAME is nil, describe the currently selected frame.")
2062 (frame, parameter)
2063 Lisp_Object frame, parameter;
2065 struct frame *f;
2066 Lisp_Object value;
2068 if (NILP (frame))
2069 frame = selected_frame;
2070 else
2071 CHECK_FRAME (frame, 0);
2072 CHECK_SYMBOL (parameter, 1);
2074 f = XFRAME (frame);
2075 value = Qnil;
2077 if (FRAME_LIVE_P (f))
2079 if (EQ (parameter, Qname))
2080 value = f->name;
2081 #ifdef HAVE_X_WINDOWS
2082 else if (EQ (parameter, Qdisplay) && FRAME_X_P (f))
2083 value = XCAR (FRAME_X_DISPLAY_INFO (f)->name_list_element);
2084 #endif /* HAVE_X_WINDOWS */
2085 else
2087 value = Fassq (parameter, f->param_alist);
2088 if (CONSP (value))
2090 value = XCDR (value);
2091 /* Fframe_parameters puts the actual fg/bg color names,
2092 even if f->param_alist says otherwise. This is
2093 important when param_alist's notion of colors is
2094 "unspecified". We need to do the same here. */
2095 if (STRINGP (value) && !FRAME_WINDOW_P (f))
2097 char *color_name;
2098 EMACS_INT csz;
2100 if (EQ (parameter, Qbackground_color))
2102 color_name = XSTRING (value)->data;
2103 csz = XSTRING (value)->size;
2104 if (strncmp (color_name, unspecified_bg, csz) == 0)
2105 value = tty_color_name (f, FRAME_BACKGROUND_PIXEL (f));
2106 else if (strncmp (color_name, unspecified_fg, csz) == 0)
2107 value = tty_color_name (f, FRAME_FOREGROUND_PIXEL (f));
2109 else if (EQ (parameter, Qforeground_color))
2111 color_name = XSTRING (value)->data;
2112 csz = XSTRING (value)->size;
2113 if (strncmp (color_name, unspecified_fg, csz) == 0)
2114 value = tty_color_name (f, FRAME_FOREGROUND_PIXEL (f));
2115 else if (strncmp (color_name, unspecified_bg, csz) == 0)
2116 value = tty_color_name (f, FRAME_BACKGROUND_PIXEL (f));
2120 else if (EQ (parameter, Qdisplay_type)
2121 || EQ (parameter, Qbackground_mode))
2122 /* Avoid consing in frequent cases. */
2123 value = Qnil;
2124 else
2125 value = Fcdr (Fassq (parameter, Fframe_parameters (frame)));
2129 return value;
2133 DEFUN ("modify-frame-parameters", Fmodify_frame_parameters,
2134 Smodify_frame_parameters, 2, 2, 0,
2135 "Modify the parameters of frame FRAME according to ALIST.\n\
2136 If FRAME is nil, it defaults to the selected frame.\n\
2137 ALIST is an alist of parameters to change and their new values.\n\
2138 Each element of ALIST has the form (PARM . VALUE), where PARM is a symbol.\n\
2139 The meaningful PARMs depend on the kind of frame.\n\
2140 Undefined PARMs are ignored, but stored in the frame's parameter list\n\
2141 so that `frame-parameters' will return them.\n\
2143 The value of frame parameter FOO can also be accessed\n\
2144 as a frame-local binding for the variable FOO, if you have\n\
2145 enabled such bindings for that variable with `make-variable-frame-local'.")
2146 (frame, alist)
2147 Lisp_Object frame, alist;
2149 FRAME_PTR f;
2150 register Lisp_Object tail, prop, val;
2151 int count = BINDING_STACK_SIZE ();
2153 /* Bind this to t to inhibit initialization of the default face from
2154 X resources in face-set-after-frame-default. If we don't inhibit
2155 this, modifying the `font' frame parameter, for example, while
2156 there is a `default.attributeFont' X resource, won't work,
2157 because `default's font is reset to the value of the X resource
2158 and that resets the `font' frame parameter. */
2159 specbind (Qinhibit_default_face_x_resources, Qt);
2161 if (EQ (frame, Qnil))
2162 frame = selected_frame;
2163 CHECK_LIVE_FRAME (frame, 0);
2164 f = XFRAME (frame);
2166 /* I think this should be done with a hook. */
2167 #ifdef HAVE_WINDOW_SYSTEM
2168 if (FRAME_WINDOW_P (f))
2169 x_set_frame_parameters (f, alist);
2170 else
2171 #endif
2172 #ifdef MSDOS
2173 if (FRAME_MSDOS_P (f))
2174 IT_set_frame_parameters (f, alist);
2175 else
2176 #endif
2179 int length = XINT (Flength (alist));
2180 int i;
2181 Lisp_Object *parms
2182 = (Lisp_Object *) alloca (length * sizeof (Lisp_Object));
2183 Lisp_Object *values
2184 = (Lisp_Object *) alloca (length * sizeof (Lisp_Object));
2186 /* Extract parm names and values into those vectors. */
2188 i = 0;
2189 for (tail = alist; CONSP (tail); tail = Fcdr (tail))
2191 Lisp_Object elt;
2193 elt = Fcar (tail);
2194 parms[i] = Fcar (elt);
2195 values[i] = Fcdr (elt);
2196 i++;
2199 /* Now process them in reverse of specified order. */
2200 for (i--; i >= 0; i--)
2202 prop = parms[i];
2203 val = values[i];
2204 store_frame_param (f, prop, val);
2208 return unbind_to (count, Qnil);
2211 DEFUN ("frame-char-height", Fframe_char_height, Sframe_char_height,
2212 0, 1, 0,
2213 "Height in pixels of a line in the font in frame FRAME.\n\
2214 If FRAME is omitted, the selected frame is used.\n\
2215 For a terminal frame, the value is always 1.")
2216 (frame)
2217 Lisp_Object frame;
2219 struct frame *f;
2221 if (NILP (frame))
2222 frame = selected_frame;
2223 CHECK_FRAME (frame, 0);
2224 f = XFRAME (frame);
2226 #ifdef HAVE_WINDOW_SYSTEM
2227 if (FRAME_WINDOW_P (f))
2228 return make_number (x_char_height (f));
2229 else
2230 #endif
2231 return make_number (1);
2235 DEFUN ("frame-char-width", Fframe_char_width, Sframe_char_width,
2236 0, 1, 0,
2237 "Width in pixels of characters in the font in frame FRAME.\n\
2238 If FRAME is omitted, the selected frame is used.\n\
2239 The width is the same for all characters, because\n\
2240 currently Emacs supports only fixed-width fonts.\n\
2241 For a terminal screen, the value is always 1.")
2242 (frame)
2243 Lisp_Object frame;
2245 struct frame *f;
2247 if (NILP (frame))
2248 frame = selected_frame;
2249 CHECK_FRAME (frame, 0);
2250 f = XFRAME (frame);
2252 #ifdef HAVE_WINDOW_SYSTEM
2253 if (FRAME_WINDOW_P (f))
2254 return make_number (x_char_width (f));
2255 else
2256 #endif
2257 return make_number (1);
2260 DEFUN ("frame-pixel-height", Fframe_pixel_height,
2261 Sframe_pixel_height, 0, 1, 0,
2262 "Return a FRAME's height in pixels.\n\
2263 This counts only the height available for text lines,\n\
2264 not menu bars on window-system Emacs frames.\n\
2265 For a terminal frame, the result really gives the height in characters.\n\
2266 If FRAME is omitted, the selected frame is used.")
2267 (frame)
2268 Lisp_Object frame;
2270 struct frame *f;
2272 if (NILP (frame))
2273 frame = selected_frame;
2274 CHECK_FRAME (frame, 0);
2275 f = XFRAME (frame);
2277 #ifdef HAVE_WINDOW_SYSTEM
2278 if (FRAME_WINDOW_P (f))
2279 return make_number (x_pixel_height (f));
2280 else
2281 #endif
2282 return make_number (FRAME_HEIGHT (f));
2285 DEFUN ("frame-pixel-width", Fframe_pixel_width,
2286 Sframe_pixel_width, 0, 1, 0,
2287 "Return FRAME's width in pixels.\n\
2288 For a terminal frame, the result really gives the width in characters.\n\
2289 If FRAME is omitted, the selected frame is used.")
2290 (frame)
2291 Lisp_Object frame;
2293 struct frame *f;
2295 if (NILP (frame))
2296 frame = selected_frame;
2297 CHECK_FRAME (frame, 0);
2298 f = XFRAME (frame);
2300 #ifdef HAVE_WINDOW_SYSTEM
2301 if (FRAME_WINDOW_P (f))
2302 return make_number (x_pixel_width (f));
2303 else
2304 #endif
2305 return make_number (FRAME_WIDTH (f));
2308 DEFUN ("set-frame-height", Fset_frame_height, Sset_frame_height, 2, 3, 0,
2309 "Specify that the frame FRAME has LINES lines.\n\
2310 Optional third arg non-nil means that redisplay should use LINES lines\n\
2311 but that the idea of the actual height of the frame should not be changed.")
2312 (frame, lines, pretend)
2313 Lisp_Object frame, lines, pretend;
2315 register struct frame *f;
2317 CHECK_NUMBER (lines, 0);
2318 if (NILP (frame))
2319 frame = selected_frame;
2320 CHECK_LIVE_FRAME (frame, 0);
2321 f = XFRAME (frame);
2323 /* I think this should be done with a hook. */
2324 #ifdef HAVE_WINDOW_SYSTEM
2325 if (FRAME_WINDOW_P (f))
2327 if (XINT (lines) != f->height)
2328 x_set_window_size (f, 1, f->width, XINT (lines));
2329 do_pending_window_change (0);
2331 else
2332 #endif
2333 change_frame_size (f, XINT (lines), 0, !NILP (pretend), 0, 0);
2334 return Qnil;
2337 DEFUN ("set-frame-width", Fset_frame_width, Sset_frame_width, 2, 3, 0,
2338 "Specify that the frame FRAME has COLS columns.\n\
2339 Optional third arg non-nil means that redisplay should use COLS columns\n\
2340 but that the idea of the actual width of the frame should not be changed.")
2341 (frame, cols, pretend)
2342 Lisp_Object frame, cols, pretend;
2344 register struct frame *f;
2345 CHECK_NUMBER (cols, 0);
2346 if (NILP (frame))
2347 frame = selected_frame;
2348 CHECK_LIVE_FRAME (frame, 0);
2349 f = XFRAME (frame);
2351 /* I think this should be done with a hook. */
2352 #ifdef HAVE_WINDOW_SYSTEM
2353 if (FRAME_WINDOW_P (f))
2355 if (XINT (cols) != f->width)
2356 x_set_window_size (f, 1, XINT (cols), f->height);
2357 do_pending_window_change (0);
2359 else
2360 #endif
2361 change_frame_size (f, 0, XINT (cols), !NILP (pretend), 0, 0);
2362 return Qnil;
2365 DEFUN ("set-frame-size", Fset_frame_size, Sset_frame_size, 3, 3, 0,
2366 "Sets size of FRAME to COLS by ROWS, measured in characters.")
2367 (frame, cols, rows)
2368 Lisp_Object frame, cols, rows;
2370 register struct frame *f;
2372 CHECK_LIVE_FRAME (frame, 0);
2373 CHECK_NUMBER (cols, 2);
2374 CHECK_NUMBER (rows, 1);
2375 f = XFRAME (frame);
2377 /* I think this should be done with a hook. */
2378 #ifdef HAVE_WINDOW_SYSTEM
2379 if (FRAME_WINDOW_P (f))
2381 if (XINT (rows) != f->height || XINT (cols) != f->width
2382 || FRAME_NEW_HEIGHT (f) || FRAME_NEW_WIDTH (f))
2383 x_set_window_size (f, 1, XINT (cols), XINT (rows));
2384 do_pending_window_change (0);
2386 else
2387 #endif
2388 change_frame_size (f, XINT (rows), XINT (cols), 0, 0, 0);
2390 return Qnil;
2393 DEFUN ("set-frame-position", Fset_frame_position,
2394 Sset_frame_position, 3, 3, 0,
2395 "Sets position of FRAME in pixels to XOFFSET by YOFFSET.\n\
2396 This is actually the position of the upper left corner of the frame.\n\
2397 Negative values for XOFFSET or YOFFSET are interpreted relative to\n\
2398 the rightmost or bottommost possible position (that stays within the screen).")
2399 (frame, xoffset, yoffset)
2400 Lisp_Object frame, xoffset, yoffset;
2402 register struct frame *f;
2404 CHECK_LIVE_FRAME (frame, 0);
2405 CHECK_NUMBER (xoffset, 1);
2406 CHECK_NUMBER (yoffset, 2);
2407 f = XFRAME (frame);
2409 /* I think this should be done with a hook. */
2410 #ifdef HAVE_WINDOW_SYSTEM
2411 if (FRAME_WINDOW_P (f))
2412 x_set_offset (f, XINT (xoffset), XINT (yoffset), 1);
2413 #endif
2415 return Qt;
2419 void
2420 syms_of_frame ()
2422 Qframep = intern ("framep");
2423 staticpro (&Qframep);
2424 Qframe_live_p = intern ("frame-live-p");
2425 staticpro (&Qframe_live_p);
2426 Qheight = intern ("height");
2427 staticpro (&Qheight);
2428 Qicon = intern ("icon");
2429 staticpro (&Qicon);
2430 Qminibuffer = intern ("minibuffer");
2431 staticpro (&Qminibuffer);
2432 Qmodeline = intern ("modeline");
2433 staticpro (&Qmodeline);
2434 Qname = intern ("name");
2435 staticpro (&Qname);
2436 Qonly = intern ("only");
2437 staticpro (&Qonly);
2438 Qunsplittable = intern ("unsplittable");
2439 staticpro (&Qunsplittable);
2440 Qmenu_bar_lines = intern ("menu-bar-lines");
2441 staticpro (&Qmenu_bar_lines);
2442 Qtool_bar_lines = intern ("tool-bar-lines");
2443 staticpro (&Qtool_bar_lines);
2444 Qwidth = intern ("width");
2445 staticpro (&Qwidth);
2446 Qx = intern ("x");
2447 staticpro (&Qx);
2448 Qw32 = intern ("w32");
2449 staticpro (&Qw32);
2450 Qpc = intern ("pc");
2451 staticpro (&Qpc);
2452 Qmac = intern ("mac");
2453 staticpro (&Qmac);
2454 Qvisible = intern ("visible");
2455 staticpro (&Qvisible);
2456 Qbuffer_predicate = intern ("buffer-predicate");
2457 staticpro (&Qbuffer_predicate);
2458 Qbuffer_list = intern ("buffer-list");
2459 staticpro (&Qbuffer_list);
2460 Qtitle = intern ("title");
2461 staticpro (&Qtitle);
2462 Qdisplay_type = intern ("display-type");
2463 staticpro (&Qdisplay_type);
2464 Qbackground_mode = intern ("background-mode");
2465 staticpro (&Qbackground_mode);
2467 DEFVAR_LISP ("default-frame-alist", &Vdefault_frame_alist,
2468 "Alist of default values for frame creation.\n\
2469 These may be set in your init file, like this:\n\
2470 (setq default-frame-alist '((width . 80) (height . 55) (menu-bar-lines . 1))\n\
2471 These override values given in window system configuration data,\n\
2472 including X Windows' defaults database.\n\
2473 For values specific to the first Emacs frame, see `initial-frame-alist'.\n\
2474 For values specific to the separate minibuffer frame, see\n\
2475 `minibuffer-frame-alist'.\n\
2476 The `menu-bar-lines' element of the list controls whether new frames\n\
2477 have menu bars; `menu-bar-mode' works by altering this element.");
2478 Vdefault_frame_alist = Qnil;
2480 Qinhibit_default_face_x_resources
2481 = intern ("inhibit-default-face-x-resources");
2482 staticpro (&Qinhibit_default_face_x_resources);
2484 DEFVAR_LISP ("terminal-frame", &Vterminal_frame,
2485 "The initial frame-object, which represents Emacs's stdout.");
2487 DEFVAR_LISP ("emacs-iconified", &Vemacs_iconified,
2488 "Non-nil if all of emacs is iconified and frame updates are not needed.");
2489 Vemacs_iconified = Qnil;
2491 DEFVAR_LISP ("mouse-position-function", &Vmouse_position_function,
2492 "If non-nil, function applied to the normal result of `mouse-position'.\n\
2493 This abnormal hook exists for the benefit of packages like XTerm-mouse\n\
2494 which need to do mouse handling at the Lisp level.");
2495 Vmouse_position_function = Qnil;
2497 DEFVAR_KBOARD ("default-minibuffer-frame", Vdefault_minibuffer_frame,
2498 "Minibufferless frames use this frame's minibuffer.\n\
2500 Emacs cannot create minibufferless frames unless this is set to an\n\
2501 appropriate surrogate.\n\
2503 Emacs consults this variable only when creating minibufferless\n\
2504 frames; once the frame is created, it sticks with its assigned\n\
2505 minibuffer, no matter what this variable is set to. This means that\n\
2506 this variable doesn't necessarily say anything meaningful about the\n\
2507 current set of frames, or where the minibuffer is currently being\n\
2508 displayed.");
2510 staticpro (&Vframe_list);
2512 defsubr (&Sactive_minibuffer_window);
2513 defsubr (&Sframep);
2514 defsubr (&Sframe_live_p);
2515 defsubr (&Smake_terminal_frame);
2516 defsubr (&Shandle_switch_frame);
2517 defsubr (&Signore_event);
2518 defsubr (&Sselect_frame);
2519 defsubr (&Sselected_frame);
2520 defsubr (&Swindow_frame);
2521 defsubr (&Sframe_root_window);
2522 defsubr (&Sframe_first_window);
2523 defsubr (&Sframe_selected_window);
2524 defsubr (&Sset_frame_selected_window);
2525 defsubr (&Sframe_list);
2526 defsubr (&Snext_frame);
2527 defsubr (&Sprevious_frame);
2528 defsubr (&Sdelete_frame);
2529 defsubr (&Smouse_position);
2530 defsubr (&Smouse_pixel_position);
2531 defsubr (&Sset_mouse_position);
2532 defsubr (&Sset_mouse_pixel_position);
2533 #if 0
2534 defsubr (&Sframe_configuration);
2535 defsubr (&Srestore_frame_configuration);
2536 #endif
2537 defsubr (&Smake_frame_visible);
2538 defsubr (&Smake_frame_invisible);
2539 defsubr (&Siconify_frame);
2540 defsubr (&Sframe_visible_p);
2541 defsubr (&Svisible_frame_list);
2542 defsubr (&Sraise_frame);
2543 defsubr (&Slower_frame);
2544 defsubr (&Sredirect_frame_focus);
2545 defsubr (&Sframe_focus);
2546 defsubr (&Sframe_parameters);
2547 defsubr (&Sframe_parameter);
2548 defsubr (&Smodify_frame_parameters);
2549 defsubr (&Sframe_char_height);
2550 defsubr (&Sframe_char_width);
2551 defsubr (&Sframe_pixel_height);
2552 defsubr (&Sframe_pixel_width);
2553 defsubr (&Sset_frame_height);
2554 defsubr (&Sset_frame_width);
2555 defsubr (&Sset_frame_size);
2556 defsubr (&Sset_frame_position);
2559 void
2560 keys_of_frame ()
2562 initial_define_lispy_key (global_map, "switch-frame", "handle-switch-frame");
2563 initial_define_lispy_key (global_map, "delete-frame", "handle-delete-frame");
2564 initial_define_lispy_key (global_map, "iconify-frame", "ignore-event");
2565 initial_define_lispy_key (global_map, "make-frame-visible", "ignore-event");