1 /* Generic frame functions.
2 Copyright (C) 1989, 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
3 Copyright (C) 1995, 1996 Ben Wing.
4 Copyright (C) 1995 Sun Microsystems, Inc.
6 This file is part of XEmacs.
8 XEmacs is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with XEmacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 /* Synched up with: FSF 19.30. */
25 /* This file has been Mule-ized. */
30 #include "buffer.h" /* for Vbuffer_alist */
39 #include "redisplay.h"
40 #include "scrollbar.h"
43 Lisp_Object Vselect_frame_hook, Qselect_frame_hook;
44 Lisp_Object Vdeselect_frame_hook, Qdeselect_frame_hook;
45 Lisp_Object Vcreate_frame_hook, Qcreate_frame_hook;
46 Lisp_Object Vdelete_frame_hook, Qdelete_frame_hook;
47 Lisp_Object Vmouse_enter_frame_hook, Qmouse_enter_frame_hook;
48 Lisp_Object Vmouse_leave_frame_hook, Qmouse_leave_frame_hook;
49 Lisp_Object Vmap_frame_hook, Qmap_frame_hook;
50 Lisp_Object Vunmap_frame_hook, Qunmap_frame_hook;
51 int allow_deletion_of_last_visible_frame;
52 Lisp_Object Vadjust_frame_function;
53 Lisp_Object Vmouse_motion_handler;
54 Lisp_Object Vsynchronize_minibuffers;
55 Lisp_Object Qsynchronize_minibuffers;
56 Lisp_Object Qbuffer_predicate;
57 Lisp_Object Qmake_initial_minibuffer_frame;
58 Lisp_Object Qcustom_initialize_frame;
60 /* We declare all these frame properties here even though many of them
61 are currently only used in frame-x.c, because we should generalize
64 Lisp_Object Qminibuffer;
65 Lisp_Object Qunsplittable;
66 Lisp_Object Qinternal_border_width;
67 Lisp_Object Qtop_toolbar_shadow_color;
68 Lisp_Object Qbottom_toolbar_shadow_color;
69 Lisp_Object Qbackground_toolbar_color;
70 Lisp_Object Qtop_toolbar_shadow_pixmap;
71 Lisp_Object Qbottom_toolbar_shadow_pixmap;
72 Lisp_Object Qtoolbar_shadow_thickness;
73 Lisp_Object Qscrollbar_placement;
74 Lisp_Object Qinter_line_space;
75 Lisp_Object Qvisual_bell;
76 Lisp_Object Qbell_volume;
77 Lisp_Object Qpointer_background;
78 Lisp_Object Qpointer_color;
79 Lisp_Object Qtext_pointer;
80 Lisp_Object Qspace_pointer;
81 Lisp_Object Qmodeline_pointer;
82 Lisp_Object Qgc_pointer;
83 Lisp_Object Qinitially_unmapped;
84 Lisp_Object Quse_backing_store;
85 Lisp_Object Qborder_color;
86 Lisp_Object Qborder_width;
88 Lisp_Object Qframep, Qframe_live_p;
89 Lisp_Object Qdelete_frame;
91 Lisp_Object Qframe_title_format, Vframe_title_format;
92 Lisp_Object Qframe_icon_title_format, Vframe_icon_title_format;
94 Lisp_Object Vdefault_frame_name;
95 Lisp_Object Vdefault_frame_plist;
97 Lisp_Object Vframe_icon_glyph;
101 Lisp_Object Qvisible, Qiconic, Qinvisible, Qvisible_iconic, Qinvisible_iconic;
102 Lisp_Object Qnomini, Qvisible_nomini, Qiconic_nomini, Qinvisible_nomini;
103 Lisp_Object Qvisible_iconic_nomini, Qinvisible_iconic_nomini;
105 Lisp_Object Qset_specifier, Qset_glyph_image, Qset_face_property;
106 Lisp_Object Qface_property_instance;
108 Lisp_Object Qframe_property_alias;
110 /* If this is non-nil, it is the frame that make-frame is currently
111 creating. We can't set the current frame to this in case the
112 debugger goes off because it would try and display to it. However,
113 there are some places which need to reference it which have no
114 other way of getting it if it isn't the selected frame. */
115 Lisp_Object Vframe_being_created;
116 Lisp_Object Qframe_being_created;
118 static void store_minibuf_frame_prop (struct frame *f, Lisp_Object val);
119 static struct display_line title_string_display_line;
120 /* Used by generate_title_string. Global because they get used so much that
121 the dynamic allocation time adds up. */
122 static Emchar_dynarr *title_string_emchar_dynarr;
124 EXFUN (Fset_frame_properties, 2);
128 mark_frame (Lisp_Object obj)
130 struct frame *f = XFRAME (obj);
132 #define MARKED_SLOT(x) mark_object (f->x)
133 #include "frameslots.h"
135 mark_subwindow_cachels (f->subwindow_cachels);
137 if (FRAME_LIVE_P (f)) /* device is nil for a dead frame */
138 MAYBE_FRAMEMETH (f, mark_frame, (f));
144 print_frame (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
146 struct frame *frm = XFRAME (obj);
150 error ("printing unreadable object #<frame %s 0x%x>",
151 XSTRING_DATA (frm->name), frm->header.uid);
153 sprintf (buf, "#<%s-frame ", !FRAME_LIVE_P (frm) ? "dead" :
154 FRAME_TYPE_NAME (frm));
155 write_c_string (buf, printcharfun);
156 print_internal (frm->name, printcharfun, 1);
157 sprintf (buf, " 0x%x>", frm->header.uid);
158 write_c_string (buf, printcharfun);
161 DEFINE_LRECORD_IMPLEMENTATION ("frame", frame,
162 mark_frame, print_frame, 0, 0, 0, 0,
166 nuke_all_frame_slots (struct frame *f)
168 #define MARKED_SLOT(x) f->x = Qnil
169 #include "frameslots.h"
172 /* Allocate a new frame object and set all its fields to reasonable
173 values. The root window is created but the minibuffer will be done
176 static struct frame *
177 allocate_frame_core (Lisp_Object device)
179 /* This function can GC */
181 Lisp_Object root_window;
182 struct frame *f = alloc_lcrecord_type (struct frame, &lrecord_frame);
185 nuke_all_frame_slots (f);
186 XSETFRAME (frame, f);
189 f->framemeths = XDEVICE (device)->devmeths;
190 f->buffer_alist = Fcopy_sequence (Vbuffer_alist);
192 root_window = allocate_window ();
193 XWINDOW (root_window)->frame = frame;
196 Just so that there is "something there."
197 Correct size will be set up later with change_frame_size. */
202 XWINDOW (root_window)->pixel_width = 10;
203 XWINDOW (root_window)->pixel_height = 9;
205 /* The size of the minibuffer window is now set in x_create_frame
208 f->root_window = root_window;
209 f->selected_window = root_window;
210 f->last_nonminibuf_window = root_window;
212 /* cache of subwindows visible on frame */
213 f->subwindow_cachels = Dynarr_new (subwindow_cachel);
215 /* associated exposure ignore list */
216 f->subwindow_exposures = 0;
217 f->subwindow_exposures_tail = 0;
219 /* Choose a buffer for the frame's root window. */
220 XWINDOW (root_window)->buffer = Qt;
224 buf = Fcurrent_buffer ();
225 /* If buf is a 'hidden' buffer (i.e. one whose name starts with
226 a space), try to find another one. */
227 if (string_char (XSTRING (Fbuffer_name (buf)), 0) == ' ')
228 buf = Fother_buffer (buf, Qnil, Qnil);
229 Fset_window_buffer (root_window, buf);
236 setup_normal_frame (struct frame *f)
238 Lisp_Object mini_window;
241 XSETFRAME (frame, f);
243 mini_window = allocate_window ();
244 XWINDOW (f->root_window)->next = mini_window;
245 XWINDOW (mini_window)->prev = f->root_window;
246 XWINDOW (mini_window)->mini_p = Qt;
247 XWINDOW (mini_window)->frame = frame;
248 f->minibuffer_window = mini_window;
249 f->has_minibuffer = 1;
251 XWINDOW (mini_window)->buffer = Qt;
252 Fset_window_buffer (mini_window, Vminibuffer_zero);
255 /* Make a frame using a separate minibuffer window on another frame.
256 MINI_WINDOW is the minibuffer window to use. nil means use the
257 default-minibuffer-frame. */
260 setup_frame_without_minibuffer (struct frame *f, Lisp_Object mini_window)
262 /* This function can GC */
263 Lisp_Object device = f->device;
265 if (!NILP (mini_window))
266 CHECK_LIVE_WINDOW (mini_window);
268 if (!NILP (mini_window)
269 && !EQ (DEVICE_CONSOLE (XDEVICE (device)),
270 FRAME_CONSOLE (XFRAME (XWINDOW (mini_window)->frame))))
271 error ("frame and minibuffer must be on the same console");
273 if (NILP (mini_window))
275 struct console *con = XCONSOLE (FRAME_CONSOLE (f));
276 /* Use default-minibuffer-frame if possible. */
277 if (!FRAMEP (con->default_minibuffer_frame)
278 || ! FRAME_LIVE_P (XFRAME (con->default_minibuffer_frame)))
280 /* If there's no minibuffer frame to use, create one. */
281 con->default_minibuffer_frame
282 = call1 (Qmake_initial_minibuffer_frame, device);
284 mini_window = XFRAME (con->default_minibuffer_frame)->minibuffer_window;
287 /* Install the chosen minibuffer window, with proper buffer. */
288 store_minibuf_frame_prop (f, mini_window);
289 Fset_window_buffer (mini_window, Vminibuffer_zero);
292 /* Make a frame containing only a minibuffer window. */
295 setup_minibuffer_frame (struct frame *f)
297 /* This function can GC */
298 /* First make a frame containing just a root window, no minibuffer. */
299 Lisp_Object mini_window;
302 XSETFRAME (frame, f);
305 f->has_minibuffer = 1;
307 /* Now label the root window as also being the minibuffer.
308 Avoid infinite looping on the window chain by marking next pointer
311 mini_window = f->minibuffer_window = f->root_window;
312 XWINDOW (mini_window)->mini_p = Qt;
313 XWINDOW (mini_window)->next = Qnil;
314 XWINDOW (mini_window)->prev = Qnil;
315 XWINDOW (mini_window)->frame = frame;
317 /* Put the proper buffer in that window. */
319 Fset_window_buffer (mini_window, Vminibuffer_zero);
323 make_sure_its_a_fresh_plist (Lisp_Object foolist)
325 if (CONSP (Fcar (foolist)))
327 /* looks like an alist to me. */
328 foolist = Fcopy_alist (foolist);
329 foolist = Fdestructive_alist_to_plist (foolist);
332 foolist = Fcopy_sequence (foolist);
337 DEFUN ("make-frame", Fmake_frame, 0, 2, "", /*
338 Create and return a new frame, displaying the current buffer.
339 Runs the functions listed in `create-frame-hook' after frame creation.
341 Optional argument PROPS is a property list (a list of alternating
342 keyword-value specifications) of properties for the new frame.
343 \(An alist is accepted for backward compatibility but should not
346 See `set-frame-properties', `default-x-frame-plist', and
347 `default-tty-frame-plist' for the specially-recognized properties.
353 Lisp_Object frame = Qnil, name = Qnil, minibuf;
354 struct gcpro gcpro1, gcpro2, gcpro3;
355 int speccount = specpdl_depth ();
356 int first_frame_on_device = 0;
357 int first_frame_on_console = 0;
359 d = decode_device (device);
360 XSETDEVICE (device, d);
362 /* PROPS and NAME may be freshly-created, so make sure to GCPRO. */
363 GCPRO3 (frame, props, name);
365 props = make_sure_its_a_fresh_plist (props);
366 if (DEVICE_SPECIFIC_FRAME_PROPS (d))
367 /* Put the device-specific props before the more general ones so
368 that they override them. */
369 props = nconc2 (props,
370 make_sure_its_a_fresh_plist
371 (*DEVICE_SPECIFIC_FRAME_PROPS (d)));
372 props = nconc2 (props, make_sure_its_a_fresh_plist (Vdefault_frame_plist));
373 Fcanonicalize_lax_plist (props, Qnil);
375 name = Flax_plist_get (props, Qname, Qnil);
378 else if (STRINGP (Vdefault_frame_name))
379 name = Vdefault_frame_name;
381 name = build_string ("emacs");
383 if (!NILP (Fstring_match (make_string ((CONST Bufbyte *) "\\.", 2), name,
385 signal_simple_error (". not allowed in frame names", name);
387 f = allocate_frame_core (device);
388 XSETFRAME (frame, f);
390 specbind (Qframe_being_created, name);
393 FRAMEMETH (f, init_frame_1, (f, props));
395 minibuf = Flax_plist_get (props, Qminibuffer, Qunbound);
396 if (UNBOUNDP (minibuf))
398 /* If minibuf is unspecified, then look for a minibuffer X resource. */
399 /* #### Not implemented any more. We need to fix things up so
400 that we search out all X resources and append them to the end of
401 props, above. This is the only way in general to assure
402 coherent behavior for all frame properties/resources/etc. */
405 props = Flax_plist_remprop (props, Qminibuffer);
407 if (EQ (minibuf, Qnone) || NILP (minibuf))
408 setup_frame_without_minibuffer (f, Qnil);
409 else if (EQ (minibuf, Qonly))
410 setup_minibuffer_frame (f);
411 else if (WINDOWP (minibuf))
412 setup_frame_without_minibuffer (f, minibuf);
413 else if (EQ (minibuf, Qt) || UNBOUNDP (minibuf))
414 setup_normal_frame (f);
416 signal_simple_error ("Invalid value for `minibuffer'", minibuf);
418 update_frame_window_mirror (f);
420 if (initialized && !DEVICE_STREAM_P (d))
422 if (!NILP (f->minibuffer_window))
423 reset_face_cachels (XWINDOW (f->minibuffer_window));
424 reset_face_cachels (XWINDOW (f->root_window));
427 /* If no frames on this device formerly existed, say this is the
428 first frame. It kind of assumes that frameless devices don't
429 exist, but it shouldn't be too harmful. */
430 if (NILP (DEVICE_FRAME_LIST (d)))
431 first_frame_on_device = 1;
433 /* This *must* go before the init_*() methods. Those functions
434 call Lisp code, and if any of them causes a warning to be displayed
435 and the *Warnings* buffer to be created, it won't get added to
436 the frame-specific version of the buffer-alist unless the frame
437 is accessible from the device. */
440 DEVICE_FRAME_LIST (d) = nconc2 (DEVICE_FRAME_LIST (d), Fcons (frame, Qnil));
442 DEVICE_FRAME_LIST (d) = Fcons (frame, DEVICE_FRAME_LIST (d));
443 RESET_CHANGED_SET_FLAGS;
445 /* Now make sure that the initial cached values are set correctly.
446 Do this after the init_frame method is called because that may
447 do things (e.g. create widgets) that are necessary for the
448 specifier value-changed methods to work OK. */
449 recompute_all_cached_specifiers_in_frame (f);
451 if (!DEVICE_STREAM_P (d))
453 init_frame_faces (f);
455 #ifdef HAVE_SCROLLBARS
456 /* Finish up resourcing the scrollbars. */
457 init_frame_scrollbars (f);
461 /* Create the initial toolbars. We have to do this after the frame
462 methods are called because it may potentially call some things itself
463 which depend on the normal frame methods having initialized
465 init_frame_toolbars (f);
467 reset_face_cachels (XWINDOW (FRAME_SELECTED_WINDOW (f)));
468 reset_glyph_cachels (XWINDOW (FRAME_SELECTED_WINDOW (f)));
469 reset_subwindow_cachels (f);
470 change_frame_size (f, f->height, f->width, 0);
474 MAYBE_FRAMEMETH (f, init_frame_2, (f, props));
475 Fset_frame_properties (frame, props);
476 MAYBE_FRAMEMETH (f, init_frame_3, (f));
478 /* now initialise the gutters, this won't change the frame size
480 if (!DEVICE_STREAM_P (d))
481 init_frame_gutters (f);
483 /* Hallelujah, praise the lord. */
484 f->init_finished = 1;
486 /* If this is the first frame on the device, make it the selected one. */
487 if (first_frame_on_device && NILP (DEVICE_SELECTED_FRAME (d)))
488 set_device_selected_frame (d, frame);
490 /* If at startup or if the current console is a stream console
491 (usually also at startup), make this console the selected one
492 so that messages show up on it. */
493 if (NILP (Fselected_console ()) ||
494 CONSOLE_STREAM_P (XCONSOLE (Fselected_console ())))
495 Fselect_console (DEVICE_CONSOLE (d));
497 first_frame_on_console =
498 (first_frame_on_device &&
499 XINT (Flength (CONSOLE_DEVICE_LIST (XCONSOLE (DEVICE_CONSOLE (d)))))
502 /* #### all this calling of frame methods at various odd times
503 is somewhat of a mess. It's necessary to do it this way due
504 to strange console-type-specific things that need to be done. */
505 MAYBE_FRAMEMETH (f, after_init_frame, (f, first_frame_on_device,
506 first_frame_on_console));
508 if (first_frame_on_device)
510 if (first_frame_on_console)
511 va_run_hook_with_args (Qcreate_console_hook, 1, DEVICE_CONSOLE (d));
512 va_run_hook_with_args (Qcreate_device_hook, 1, device);
514 va_run_hook_with_args (Qcreate_frame_hook, 1, frame);
516 /* Initialize custom-specific stuff. */
517 if (!UNBOUNDP (symbol_function (XSYMBOL (Qcustom_initialize_frame))))
518 call1 (Qcustom_initialize_frame, frame);
520 unbind_to (speccount, Qnil);
527 /* this function should be used in most cases when a Lisp function is passed
528 a FRAME argument. Use this unless you don't accept nil == current frame
529 (in which case, do a CHECK_LIVE_FRAME() and then an XFRAME()) or you
530 allow dead frames. Note that very few functions should accept dead
531 frames. It could be argued that functions should just do nothing when
532 given a dead frame, but the presence of a dead frame usually indicates
533 an oversight in the Lisp code that could potentially lead to strange
534 results and so it is better to catch the error early.
536 If you only accept X frames, use decode_x_frame(), which does what this
537 function does but also makes sure the frame is an X frame. */
540 decode_frame (Lisp_Object frame)
543 return selected_frame ();
545 CHECK_LIVE_FRAME (frame);
546 return XFRAME (frame);
550 decode_frame_or_selected (Lisp_Object cdf)
553 cdf = CONSOLE_SELECTED_DEVICE (decode_console (cdf));
555 cdf = DEVICE_SELECTED_FRAME (decode_device (cdf));
556 return decode_frame (cdf);
560 make_frame (struct frame *f)
563 XSETFRAME (frame, f);
569 * window size changes are held up during critical regions. Afterwards,
570 * we want to deal with any delayed changes.
573 hold_frame_size_changes (void)
579 unhold_one_frame_size_changes (struct frame *f)
583 if (f->size_change_pending)
584 change_frame_size (f, f->new_height, f->new_width, 0);
588 unhold_frame_size_changes (void)
590 Lisp_Object frmcons, devcons, concons;
592 FRAME_LOOP_NO_BREAK (frmcons, devcons, concons)
593 unhold_one_frame_size_changes (XFRAME (XCAR (frmcons)));
597 invalidate_vertical_divider_cache_in_frame (struct frame *f)
599 /* Invalidate cached value of needs_vertical_divider_p in
600 every and all windows */
601 map_windows (f, invalidate_vertical_divider_cache_in_window, 0);
605 * Frame size may change due to changes in scrollbars, toolbars,
606 * default font etc. These changes are applied early in redisplay
610 adjust_frame_size (struct frame *f)
612 int keep_char_size = 0;
614 XSETFRAME (frame, f);
616 if (!f->size_slipped)
619 /* Don't adjust tty frames. #### May break when TTY have menubars.
620 Then, write an Vadjust_frame_function which will return t for TTY
621 frames. Another solution is frame_size_fixed_p method for TTYs,
622 which always returned yes it's fixed.
624 if (!FRAME_WIN_P (f))
626 CLEAR_FRAME_SIZE_SLIPPED (f);
630 /* frame_size_fixed_p tells that frame size cannot currently
631 be changed change due to external conditions */
632 if (!FRAMEMETH_OR_GIVEN (f, frame_size_fixed_p, (f), 0))
634 if (NILP (Vadjust_frame_function))
636 else if (EQ (Vadjust_frame_function, Qt))
640 NILP (call1_trapping_errors ("Error in adjust-frame-function",
641 Vadjust_frame_function, frame));
644 Fset_frame_size (frame, make_int (FRAME_CHARWIDTH(f)),
645 make_int (FRAME_CHARHEIGHT(f)), Qnil);
651 pixel_to_char_size (f, FRAME_PIXWIDTH(f), FRAME_PIXHEIGHT(f),
653 change_frame_size (f, height, width, 0);
654 CLEAR_FRAME_SIZE_SLIPPED (f);
659 * This is a "specifier changed in frame" handler for various specifiers
660 * changing which causes frame size adjustment
663 frame_size_slipped (Lisp_Object specifier, struct frame *f,
666 MARK_FRAME_SIZE_SLIPPED(f);
669 DEFUN ("framep", Fframep, 1, 1, 0, /*
670 Return non-nil if OBJECT is a frame.
671 Also see `frame-live-p'.
672 Note that FSF Emacs kludgily returns a value indicating what type of
673 frame this is. Use the cleaner function `frame-type' for that.
677 return FRAMEP (object) ? Qt : Qnil;
680 DEFUN ("frame-live-p", Fframe_live_p, 1, 1, 0, /*
681 Return non-nil if OBJECT is a frame which has not been deleted.
685 return FRAMEP (object) && FRAME_LIVE_P (XFRAME (object)) ? Qt : Qnil;
689 DEFUN ("focus-frame", Ffocus_frame, 1, 1, 0, /*
690 Select FRAME and give it the window system focus.
691 This function is not affected by the value of `focus-follows-mouse'.
695 CHECK_LIVE_FRAME (frame);
697 MAYBE_DEVMETH (XDEVICE (FRAME_DEVICE (XFRAME (frame))), focus_on_frame,
699 /* FRAME will be selected by the time we receive the next event.
700 However, it is better to select it explicitly now, in case the
701 Lisp code depends on frame being selected. */
702 Fselect_frame (frame);
706 /* Called from Fselect_window() */
708 select_frame_1 (Lisp_Object frame)
710 struct frame *f = XFRAME (frame);
711 Lisp_Object old_selected_frame = Fselected_frame (Qnil);
713 if (EQ (frame, old_selected_frame))
716 /* now select the frame's device */
717 set_device_selected_frame (XDEVICE (FRAME_DEVICE (f)), frame);
718 select_device_1 (FRAME_DEVICE (f));
720 update_frame_window_mirror (f);
723 DEFUN ("select-frame", Fselect_frame, 1, 1, 0, /*
724 Select the frame FRAME.
725 Subsequent editing commands apply to its selected window.
726 The selection of FRAME lasts until the next time the user does
727 something to select a different frame, or until the next time this
730 Note that this does not actually cause the window-system focus to be
731 set to this frame, or the `select-frame-hook' or `deselect-frame-hook'
732 to be run, until the next time that XEmacs is waiting for an event.
734 Also note that when focus-follows-mouse is non-nil, the frame
735 selection is temporary and is reverted when the current command
736 terminates, much like the buffer selected by `set-buffer'. In order
737 to effect a permanent focus change, use `focus-frame'.
741 CHECK_LIVE_FRAME (frame);
743 /* select the frame's selected window. This will call
744 selected_frame_1(). */
745 Fselect_window (FRAME_SELECTED_WINDOW (XFRAME (frame)), Qnil);
747 /* Nothing should be depending on the return value of this function.
748 But, of course, there is stuff out there which is. */
752 /* use this to retrieve the currently selected frame. You should use
753 this in preference to Fselected_frame (Qnil) unless you are prepared
754 to handle the possibility of there being no selected frame (this
755 happens at some points during startup). */
758 selected_frame (void)
760 Lisp_Object device = Fselected_device (Qnil);
761 Lisp_Object frame = DEVICE_SELECTED_FRAME (XDEVICE (device));
763 signal_simple_error ("No frames exist on device", device);
764 return XFRAME (frame);
767 /* use this instead of XFRAME (DEVICE_SELECTED_FRAME (d)) to catch
768 the possibility of there being no frames on the device (just created).
769 There is no point doing this inside of redisplay because errors
770 cause an abort(), indicating a flaw in the logic, and error_check_frame()
771 will catch this just as well. */
774 device_selected_frame (struct device *d)
776 Lisp_Object frame = DEVICE_SELECTED_FRAME (d);
780 XSETDEVICE (device, d);
781 signal_simple_error ("No frames exist on device", device);
783 return XFRAME (frame);
788 xxDEFUN ("handle-switch-frame", Fhandle_switch_frame, 1, 2, "e", /*
789 Handle a switch-frame event EVENT.
790 Switch-frame events are usually bound to this function.
791 A switch-frame event tells Emacs that the window manager has requested
792 that the user's events be directed to the frame mentioned in the event.
793 This function selects the selected window of the frame of EVENT.
795 If EVENT is frame object, handle it as if it were a switch-frame event
800 /* Preserve prefix arg that the command loop just cleared. */
801 XCONSOLE (Vselected_console)->prefix_arg = Vcurrent_prefix_arg;
803 run_hook (Qmouse_leave_buffer_hook);
805 return do_switch_frame (frame, no_enter, 0);
808 /* A load of garbage. */
809 xxDEFUN ("ignore-event", Fignore_event, 0, 0, "", /*
810 Do nothing, but preserve any prefix argument already specified.
811 This is a suitable binding for iconify-frame and make-frame-visible.
815 struct console *c = XCONSOLE (Vselected_console);
817 c->prefix_arg = Vcurrent_prefix_arg;
823 DEFUN ("selected-frame", Fselected_frame, 0, 1, 0, /*
824 Return the frame that is now selected on device DEVICE.
825 If DEVICE is not specified, the selected device will be used.
826 If no frames exist on the device, nil is returned.
830 if (NILP (device) && NILP (Fselected_device (Qnil)))
831 return Qnil; /* happens early in temacs */
832 return DEVICE_SELECTED_FRAME (decode_device (device));
836 frame_first_window (struct frame *f)
838 Lisp_Object w = f->root_window;
842 if (! NILP (XWINDOW (w)->hchild))
843 w = XWINDOW (w)->hchild;
844 else if (! NILP (XWINDOW (w)->vchild))
845 w = XWINDOW (w)->vchild;
853 DEFUN ("active-minibuffer-window", Factive_minibuffer_window, 0, 0, 0, /*
854 Return the currently active minibuffer window, or nil if none.
858 return minibuf_level ? minibuf_window : Qnil;
861 DEFUN ("last-nonminibuf-frame", Flast_nonminibuf_frame, 0, 1, 0, /*
862 Return the most-recently-selected non-minibuffer-only frame on CONSOLE.
863 This will always be the same as (selected-frame device) unless the
864 selected frame is a minibuffer-only frame.
865 CONSOLE defaults to the selected console if omitted.
871 XSETCONSOLE (console, decode_console (console));
872 /* Just in case the machinations in delete_frame_internal() resulted
873 in the last-nonminibuf-frame getting out of sync, make sure and
874 return the selected frame if it's acceptable. */
875 result = Fselected_frame (CONSOLE_SELECTED_DEVICE (XCONSOLE (console)));
876 if (!NILP (result) && !FRAME_MINIBUF_ONLY_P (XFRAME (result)))
878 return CONSOLE_LAST_NONMINIBUF_FRAME (XCONSOLE (console));
881 DEFUN ("frame-root-window", Fframe_root_window, 0, 1, 0, /*
882 Return the root-window of FRAME.
883 If omitted, FRAME defaults to the currently selected frame.
887 struct frame *f = decode_frame (frame);
888 return FRAME_ROOT_WINDOW (f);
891 DEFUN ("frame-selected-window", Fframe_selected_window, 0, 1, 0, /*
892 Return the selected window of frame object FRAME.
893 If omitted, FRAME defaults to the currently selected frame.
897 struct frame *f = decode_frame (frame);
898 return FRAME_SELECTED_WINDOW (f);
902 set_frame_selected_window (struct frame *f, Lisp_Object window)
904 assert (XFRAME (WINDOW_FRAME (XWINDOW (window))) == f);
905 f->selected_window = window;
906 if (!MINI_WINDOW_P (XWINDOW (window)) || FRAME_MINIBUF_ONLY_P (f))
909 if (!EQ (f->last_nonminibuf_window, window))
911 MARK_TOOLBAR_CHANGED;
915 f->last_nonminibuf_window = window;
919 DEFUN ("set-frame-selected-window", Fset_frame_selected_window, 2, 2, 0, /*
920 Set the selected window of frame object FRAME to WINDOW.
921 If FRAME is nil, the selected frame is used.
922 If FRAME is the selected frame, this makes WINDOW the selected window.
926 XSETFRAME (frame, decode_frame (frame));
927 CHECK_LIVE_WINDOW (window);
929 if (! EQ (frame, WINDOW_FRAME (XWINDOW (window))))
930 error ("In `set-frame-selected-window', WINDOW is not on FRAME");
932 if (XFRAME (frame) == selected_frame ())
933 return Fselect_window (window, Qnil);
935 set_frame_selected_window (XFRAME (frame), window);
940 DEFUN ("frame-device", Fframe_device, 0, 1, 0, /*
941 Return the device that FRAME is on.
942 If omitted, FRAME defaults to the currently selected frame.
946 return FRAME_DEVICE (decode_frame (frame));
950 is_surrogate_for_selected_frame (struct frame *f)
952 struct device *d = XDEVICE (f->device);
953 struct frame *dsf = device_selected_frame (d);
955 /* Can't be a surrogate for ourselves. */
959 if (!FRAME_HAS_MINIBUF_P (dsf) &&
960 f == XFRAME (WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (dsf)))))
967 frame_matches_frametype (Lisp_Object frame, Lisp_Object type)
969 struct frame *f = XFRAME (frame);
973 CHECK_LIVE_WINDOW (type);
975 if (EQ (FRAME_MINIBUF_WINDOW (f), type)
976 /* Check that F either is, or has forwarded
977 its focus to, TYPE's frame. */
978 && (EQ (WINDOW_FRAME (XWINDOW (type)), frame)
979 || EQ (WINDOW_FRAME (XWINDOW (type)),
980 FRAME_FOCUS_FRAME (f))))
987 if (EQ (type, Qvisible) || EQ (type, Qiconic) || EQ (type, Qvisible_iconic)
988 || EQ (type, Qvisible_nomini) || EQ (type, Qiconic_nomini)
989 || EQ (type, Qvisible_iconic_nomini))
990 FRAME_SAMPLE_VISIBILITY (f);
996 type = Qvisible_iconic;
998 if (EQ (type, Qvisible))
999 return FRAME_VISIBLE_P (f);
1000 if (EQ (type, Qiconic))
1001 return FRAME_ICONIFIED_P (f);
1002 if (EQ (type, Qinvisible))
1003 return !FRAME_VISIBLE_P (f) && !FRAME_ICONIFIED_P (f);
1004 if (EQ (type, Qvisible_iconic))
1005 return FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f);
1006 if (EQ (type, Qinvisible_iconic))
1007 return !FRAME_VISIBLE_P (f);
1009 if (EQ (type, Qnomini))
1010 return !FRAME_MINIBUF_ONLY_P (f);
1011 if (EQ (type, Qvisible_nomini))
1012 return FRAME_VISIBLE_P (f) && !FRAME_MINIBUF_ONLY_P (f);
1013 if (EQ (type, Qiconic_nomini))
1014 return FRAME_ICONIFIED_P (f) && !FRAME_MINIBUF_ONLY_P (f);
1015 if (EQ (type, Qinvisible_nomini))
1016 return !FRAME_VISIBLE_P (f) && !FRAME_ICONIFIED_P (f) &&
1017 !FRAME_MINIBUF_ONLY_P (f);
1018 if (EQ (type, Qvisible_iconic_nomini))
1019 return ((FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
1020 && !FRAME_MINIBUF_ONLY_P (f));
1021 if (EQ (type, Qinvisible_iconic_nomini))
1022 return !FRAME_VISIBLE_P (f) && !FRAME_MINIBUF_ONLY_P (f);
1028 device_matches_console_spec (Lisp_Object frame, Lisp_Object device,
1029 Lisp_Object console)
1031 if (EQ (console, Qwindow_system))
1032 return DEVICE_WIN_P (XDEVICE (device));
1034 console = (DEVICE_CONSOLE (XDEVICE (FRAME_DEVICE (XFRAME (frame)))));
1035 if (DEVICEP (console))
1036 return EQ (device, console);
1037 if (CONSOLEP (console))
1038 return EQ (DEVICE_CONSOLE (XDEVICE (device)), console);
1039 if (valid_console_type_p (console))
1040 return EQ (DEVICE_TYPE (XDEVICE (device)), console);
1044 /* Return the next frame in the frame list after FRAME.
1045 FRAMETYPE and CONSOLE control which frames and devices
1046 are considered; see `next-frame'. */
1049 next_frame_internal (Lisp_Object frame, Lisp_Object frametype,
1050 Lisp_Object console, int called_from_delete_device)
1053 int started_over = 0;
1055 /* If this frame is dead, it won't be in frame_list, and we'll loop
1056 forever. Forestall that. */
1057 CHECK_LIVE_FRAME (frame);
1061 Lisp_Object devcons, concons;
1063 DEVICE_LOOP_NO_BREAK (devcons, concons)
1065 Lisp_Object device = XCAR (devcons);
1066 Lisp_Object frmcons;
1068 if (!device_matches_console_spec (frame, device, console))
1071 DEVICE_FRAME_LOOP (frmcons, XDEVICE (device))
1073 Lisp_Object f = XCAR (frmcons);
1076 /* #### Doing this here is bad and is now
1077 unnecessary. The real bug was that f->iconified
1078 was never, ever updated unless a user explicitly
1079 called frame-iconified-p. That has now been
1080 fixed. With this change removed all of the other
1081 changes made to support this routine having the
1082 called_from_delete_device arg could be removed.
1083 But it is too close to release to do that now. */
1085 /* Make sure the visibility and iconified flags are
1086 up-to-date unless we're being deleted. */
1087 if (!called_from_delete_device)
1089 Fframe_iconified_p (f);
1090 Fframe_visible_p (f);
1094 /* Decide whether this frame is eligible to be returned. */
1096 /* If we've looped all the way around without finding any
1097 eligible frames, return the original frame. */
1101 if (frame_matches_frametype (f, frametype))
1109 /* We hit the end of the list, and need to start over again. */
1117 next_frame (Lisp_Object frame, Lisp_Object frametype, Lisp_Object console)
1119 return next_frame_internal (frame, frametype, console, 0);
1122 /* Return the previous frame in the frame list before FRAME.
1123 FRAMETYPE and CONSOLE control which frames and devices
1124 are considered; see `next-frame'. */
1127 prev_frame (Lisp_Object frame, Lisp_Object frametype, Lisp_Object console)
1129 Lisp_Object devcons, concons;
1132 /* If this frame is dead, it won't be in frame_list, and we'll loop
1133 forever. Forestall that. */
1134 CHECK_LIVE_FRAME (frame);
1137 DEVICE_LOOP_NO_BREAK (devcons, concons)
1139 Lisp_Object device = XCAR (devcons);
1140 Lisp_Object frmcons;
1142 if (!device_matches_console_spec (frame, device, console))
1145 DEVICE_FRAME_LOOP (frmcons, XDEVICE (device))
1147 Lisp_Object f = XCAR (frmcons);
1149 if (EQ (frame, f) && !NILP (prev))
1152 /* Decide whether this frame is eligible to be returned,
1153 according to frametype. */
1155 if (frame_matches_frametype (f, frametype))
1161 /* We've scanned the entire list. */
1163 /* We went through the whole frame list without finding a single
1164 acceptable frame. Return the original frame. */
1167 /* There were no acceptable frames in the list before FRAME; otherwise,
1168 we would have returned directly from the loop. Since PREV is the last
1169 acceptable frame in the list, return it. */
1173 DEFUN ("next-frame", Fnext_frame, 0, 3, 0, /*
1174 Return the next frame of the right type in the frame list after FRAME.
1175 FRAMETYPE controls which frames are eligible to be returned; all
1176 others will be skipped. Note that if there is only one eligible
1177 frame, then `next-frame' called repeatedly will always return
1178 the same frame, and if there is no eligible frame, then FRAME is
1181 Possible values for FRAMETYPE are
1183 'visible Consider only frames that are visible.
1184 'iconic Consider only frames that are iconic.
1185 'invisible Consider only frames that are invisible
1186 (this is different from iconic).
1187 'visible-iconic Consider frames that are visible or iconic.
1188 'invisible-iconic Consider frames that are invisible or iconic.
1189 'nomini Consider all frames except minibuffer-only ones.
1190 'visible-nomini Like `visible' but omits minibuffer-only frames.
1191 'iconic-nomini Like `iconic' but omits minibuffer-only frames.
1192 'invisible-nomini Like `invisible' but omits minibuffer-only frames.
1193 'visible-iconic-nomini Like `visible-iconic' but omits minibuffer-only
1195 'invisible-iconic-nomini Like `invisible-iconic' but omits minibuffer-only
1197 any other value Consider all frames.
1199 If FRAMETYPE is omitted, 'nomini is used. A FRAMETYPE of 0 (a number)
1200 is treated like 'iconic, for backwards compatibility.
1202 If FRAMETYPE is a window, include only its own frame and any frame now
1203 using that window as the minibuffer.
1205 Optional third argument CONSOLE controls which consoles or devices the
1206 returned frame may be on. If CONSOLE is a console, return frames only
1207 on that console. If CONSOLE is a device, return frames only on that
1208 device. If CONSOLE is a console type, return frames only on consoles
1209 of that type. If CONSOLE is 'window-system, return any frames on any
1210 window-system consoles. If CONSOLE is nil or omitted, return frames only
1211 on the FRAME's console. Otherwise, all frames are considered.
1213 (frame, frametype, console))
1215 XSETFRAME (frame, decode_frame (frame));
1217 return next_frame (frame, frametype, console);
1220 DEFUN ("previous-frame", Fprevious_frame, 0, 3, 0, /*
1221 Return the next frame of the right type in the frame list after FRAME.
1222 FRAMETYPE controls which frames are eligible to be returned; all
1223 others will be skipped. Note that if there is only one eligible
1224 frame, then `previous-frame' called repeatedly will always return
1225 the same frame, and if there is no eligible frame, then FRAME is
1228 See `next-frame' for an explanation of the FRAMETYPE and CONSOLE
1231 (frame, frametype, console))
1233 XSETFRAME (frame, decode_frame (frame));
1235 return prev_frame (frame, frametype, console);
1238 /* Return any frame for which PREDICATE is non-zero, or return Qnil
1239 if there aren't any. */
1242 find_some_frame (int (*predicate) (Lisp_Object, void *),
1245 Lisp_Object framecons, devcons, concons;
1247 FRAME_LOOP_NO_BREAK (framecons, devcons, concons)
1249 Lisp_Object frame = XCAR (framecons);
1251 if ((predicate) (frame, closure))
1260 /* extern void free_line_insertion_deletion_costs (struct frame *f); */
1262 /* Return 1 if it is ok to delete frame F;
1263 0 if all frames aside from F are invisible.
1264 (Exception: if F is a stream frame, it's OK to delete if
1265 any other frames exist.) */
1268 other_visible_frames_internal (struct frame *f, int called_from_delete_device)
1272 XSETFRAME (frame, f);
1273 if (FRAME_STREAM_P (f))
1274 return !EQ (frame, next_frame_internal (frame, Qt, Qt,
1275 called_from_delete_device));
1276 return !EQ (frame, next_frame_internal (frame, Qvisible_iconic_nomini, Qt,
1277 called_from_delete_device));
1281 other_visible_frames (struct frame *f)
1283 return other_visible_frames_internal (f, 0);
1288 If FORCE is non-zero, allow deletion of the only frame.
1290 If CALLED_FROM_DELETE_DEVICE is non-zero, then, if
1291 deleting the last frame on a device, just delete it,
1292 instead of calling `delete-device'.
1294 If FROM_IO_ERROR is non-zero, then the frame is gone due
1295 to an I/O error. This affects what happens if we exit
1296 (we do an emergency exit instead of `save-buffers-kill-emacs'.)
1300 delete_frame_internal (struct frame *f, int force,
1301 int called_from_delete_device,
1304 /* This function can GC */
1305 int minibuffer_selected;
1307 struct console *con;
1310 Lisp_Object console;
1311 struct gcpro gcpro1;
1313 /* OK to delete an already deleted frame. */
1314 if (! FRAME_LIVE_P (f))
1317 XSETFRAME (frame, f);
1320 device = FRAME_DEVICE (f);
1321 d = XDEVICE (device);
1322 console = DEVICE_CONSOLE (d);
1323 con = XCONSOLE (console);
1325 if (!called_from_delete_device)
1327 /* If we're deleting the only non-minibuffer frame on the
1328 device, delete the device. */
1329 if (EQ (frame, next_frame (frame, Qnomini, FRAME_DEVICE (f))))
1331 delete_device_internal (d, force, 0, from_io_error);
1337 /* In FSF, delete-frame will not normally allow you to delete the
1338 last visible frame. This was too annoying, so we changed it to the
1339 only frame. However, this would let people shoot themselves by
1340 deleting all frames which were either visible or iconified and thus
1341 losing any way of communicating with the still running XEmacs process.
1342 So we put it back. */
1343 if (!force && !allow_deletion_of_last_visible_frame &&
1344 !other_visible_frames_internal (f, called_from_delete_device))
1345 error ("Attempt to delete the sole visible or iconified frame");
1347 /* Does this frame have a minibuffer, and is it the surrogate
1348 minibuffer for any other frame? */
1349 if (FRAME_HAS_MINIBUF_P (f))
1351 Lisp_Object frmcons, devcons, concons;
1353 FRAME_LOOP_NO_BREAK (frmcons, devcons, concons)
1355 Lisp_Object this = XCAR (frmcons);
1357 if (! EQ (this, frame)
1358 && EQ (frame, (WINDOW_FRAME
1360 (FRAME_MINIBUF_WINDOW (XFRAME (this)))))))
1362 /* We've found another frame whose minibuffer is on
1365 ("Attempt to delete a surrogate minibuffer frame", frame);
1370 /* Test for popup frames hanging around. */
1371 /* Deletion of a parent frame with popups is deadly. */
1373 Lisp_Object frmcons, devcons, concons;
1375 FRAME_LOOP_NO_BREAK (frmcons, devcons, concons)
1377 Lisp_Object this = XCAR (frmcons);
1380 if (! EQ (this, frame))
1382 struct device *devcons_d = XDEVICE (XCAR (devcons));
1383 if (EQ (frame, DEVMETH_OR_GIVEN (devcons_d, get_frame_parent,
1386 /* We've found a popup frame whose parent is this frame. */
1388 ("Attempt to delete a frame with live popups", frame);
1393 /* Before here, we haven't made any dangerous changes (just checked for
1394 error conditions). Now run the delete-frame-hook. Remember that
1395 user code there could do any number of dangerous things, including
1396 signalling an error. */
1398 va_run_hook_with_args (Qdelete_frame_hook, 1, frame);
1400 if (!FRAME_LIVE_P (f)) /* Make sure the delete-frame-hook didn't */
1401 { /* go ahead and delete anything. */
1406 /* Call the delete-device-hook and delete-console-hook now if
1407 appropriate, before we do any dangerous things -- they too could
1409 if (XINT (Flength (DEVICE_FRAME_LIST (d))) == 1)
1411 va_run_hook_with_args (Qdelete_device_hook, 1, device);
1412 if (!FRAME_LIVE_P (f)) /* Make sure the delete-device-hook didn't */
1413 { /* go ahead and delete anything. */
1418 if (XINT (Flength (CONSOLE_DEVICE_LIST (con))) == 1)
1420 va_run_hook_with_args (Qdelete_console_hook, 1, console);
1421 if (!FRAME_LIVE_P (f)) /* Make sure the delete-console-hook didn't */
1422 { /* go ahead and delete anything. */
1429 minibuffer_selected = EQ (minibuf_window, Fselected_window (Qnil));
1431 /* If we were focused on this frame, then we're not any more.
1432 Assume that we lost the focus; that way, the call to
1433 Fselect_frame() below won't end up making us explicitly
1434 focus on another frame, which is generally undesirable in
1435 a point-to-type world. If our mouse ends up sitting over
1436 another frame, we will receive a FocusIn event and end up
1437 making that frame the selected frame.
1439 #### This may not be an ideal solution in a click-to-type
1440 world (in that case, we might want to explicitly choose
1441 another frame to have the focus, rather than relying on
1442 the WM, which might focus on a frame in a different app
1443 or focus on nothing at all). But there's no easy way
1444 to detect which focus model we're running on, and the
1445 alternative is more heinous. */
1447 if (EQ (frame, DEVICE_FRAME_WITH_FOCUS_REAL (d)))
1448 DEVICE_FRAME_WITH_FOCUS_REAL (d) = Qnil;
1449 if (EQ (frame, DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d)))
1450 DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d) = Qnil;
1451 if (EQ (frame, DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS (d)))
1452 DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS (d) = Qnil;
1454 /* Don't allow the deleted frame to remain selected.
1455 Note that in the former scheme of things, this would
1456 have caused us to regain the focus. This no longer
1457 applies (see above); I think the new behavior is more
1458 logical. If someone disagrees, it can always be
1459 changed (or a new user variable can be introduced, ugh.) */
1460 if (EQ (frame, DEVICE_SELECTED_FRAME (d)))
1464 /* If this is a popup frame, select its parent if possible.
1465 Otherwise, find another visible frame; if none, just take any frame.
1466 First try the same device, then the same console. */
1468 next = DEVMETH_OR_GIVEN (d, get_frame_parent, (f), Qnil);
1469 if (NILP (next) || EQ (next, frame) || ! FRAME_LIVE_P (XFRAME (next)))
1470 next = next_frame_internal (frame, Qvisible, device,
1471 called_from_delete_device);
1472 if (NILP (next) || EQ (next, frame))
1473 next = next_frame_internal (frame, Qvisible, console,
1474 called_from_delete_device);
1475 if (NILP (next) || EQ (next, frame))
1476 next = next_frame_internal (frame, Qvisible, Qt,
1477 called_from_delete_device);
1478 if (NILP (next) || EQ (next, frame))
1479 next = next_frame_internal (frame, Qt, device,
1480 called_from_delete_device);
1481 if (NILP (next) || EQ (next, frame))
1482 next = next_frame_internal (frame, Qt, console,
1483 called_from_delete_device);
1484 if (NILP (next) || EQ (next, frame))
1485 next = next_frame_internal (frame, Qt, Qt, called_from_delete_device);
1487 /* if we haven't found another frame at this point
1488 then there aren't any. */
1489 if (NILP (next) || EQ (next, frame))
1494 /* if this is the global selected frame, select another one. */
1495 if (EQ (frame, Fselected_frame (Qnil)))
1497 Fselect_frame (next);
1501 * If the new frame we just selected is on a different
1502 * device then we still need to change DEVICE_SELECTED_FRAME(d)
1503 * to a live frame, if there are any left on this device.
1505 if (!EQ (device, FRAME_DEVICE(XFRAME(next))))
1507 Lisp_Object next_f =
1508 next_frame_internal (frame, Qt, device,
1509 called_from_delete_device);
1510 if (NILP (next_f) || EQ (next_f, frame))
1513 set_device_selected_frame (d, next_f);
1515 else if (! did_select)
1516 set_device_selected_frame (d, next);
1521 /* Don't allow minibuf_window to remain on a deleted frame. */
1522 if (EQ (f->minibuffer_window, minibuf_window))
1524 struct frame *sel_frame = selected_frame ();
1525 Fset_window_buffer (sel_frame->minibuffer_window,
1526 XWINDOW (minibuf_window)->buffer);
1527 minibuf_window = sel_frame->minibuffer_window;
1529 /* If the dying minibuffer window was selected,
1530 select the new one. */
1531 if (minibuffer_selected)
1532 Fselect_window (minibuf_window, Qnil);
1535 /* After this point, no errors must be allowed to occur. */
1537 #ifdef HAVE_MENUBARS
1538 free_frame_menubars (f);
1540 #ifdef HAVE_SCROLLBARS
1541 free_frame_scrollbars (f);
1543 #ifdef HAVE_TOOLBARS
1544 free_frame_toolbars (f);
1546 free_frame_gutters (f);
1548 /* This must be done before the window and window_mirror structures
1549 are freed. The scrollbar information is attached to them. */
1550 MAYBE_FRAMEMETH (f, delete_frame, (f));
1552 /* Mark all the windows that used to be on FRAME as deleted, and then
1553 remove the reference to them. */
1554 delete_all_subwindows (XWINDOW (f->root_window));
1555 f->root_window = Qnil;
1557 /* clear out the cached glyph information */
1558 if (f->subwindow_cachels)
1560 Dynarr_free (f->subwindow_cachels);
1561 f->subwindow_cachels = 0;
1564 /* Remove the frame now from the list. This way, any events generated
1565 on this frame by the maneuvers below will disperse themselves. */
1567 /* This used to be Fdelq(), but that will cause a seg fault if the
1568 QUIT checker happens to get invoked, because the frame list is in
1569 an inconsistent state. */
1570 d->frame_list = delq_no_quit (frame, d->frame_list);
1571 RESET_CHANGED_SET_FLAGS;
1576 free_window_mirror (f->root_mirror);
1577 /* free_line_insertion_deletion_costs (f); */
1579 /* If we've deleted the last non-minibuf frame, then try to find
1581 if (EQ (frame, CONSOLE_LAST_NONMINIBUF_FRAME (con)))
1583 Lisp_Object frmcons, devcons;
1585 set_console_last_nonminibuf_frame (con, Qnil);
1587 CONSOLE_FRAME_LOOP_NO_BREAK (frmcons, devcons, con)
1589 Lisp_Object ecran = XCAR (frmcons);
1590 if (!FRAME_MINIBUF_ONLY_P (XFRAME (ecran)))
1592 set_console_last_nonminibuf_frame (con, ecran);
1593 goto double_break_1;
1600 /* The following test is degenerate FALSE */
1601 if (called_from_delete_device < 0)
1602 /* then we're being called from delete-console, and we shouldn't
1603 try to find another default-minibuffer frame for the console.
1605 con->default_minibuffer_frame = Qnil;
1608 /* If we've deleted this console's default_minibuffer_frame, try to
1609 find another one. Prefer minibuffer-only frames, but also notice
1610 frames with other windows. */
1611 if (EQ (frame, con->default_minibuffer_frame))
1613 Lisp_Object frmcons, devcons;
1614 /* The last frame we saw with a minibuffer, minibuffer-only or not. */
1615 Lisp_Object frame_with_minibuf;
1616 /* Some frame we found on the same console, or nil if there are none. */
1617 Lisp_Object frame_on_same_console;
1619 frame_on_same_console = Qnil;
1620 frame_with_minibuf = Qnil;
1622 set_console_last_nonminibuf_frame (con, Qnil);
1624 CONSOLE_FRAME_LOOP_NO_BREAK (frmcons, devcons, con)
1629 this = XCAR (frmcons);
1632 /* Consider only frames on the same console
1633 and only those with minibuffers. */
1634 if (FRAME_HAS_MINIBUF_P (f1))
1636 frame_with_minibuf = this;
1637 if (FRAME_MINIBUF_ONLY_P (f1))
1638 goto double_break_2;
1641 frame_on_same_console = this;
1645 if (!NILP (frame_on_same_console))
1647 /* We know that there must be some frame with a minibuffer out
1648 there. If this were not true, all of the frames present
1649 would have to be minibuffer-less, which implies that at some
1650 point their minibuffer frames must have been deleted, but
1651 that is prohibited at the top; you can't delete surrogate
1652 minibuffer frames. */
1653 if (NILP (frame_with_minibuf))
1656 con->default_minibuffer_frame = frame_with_minibuf;
1659 /* No frames left on this console--say no minibuffer either. */
1660 con->default_minibuffer_frame = Qnil;
1663 nuke_all_frame_slots (f); /* nobody should be accessing the device
1664 or anything else any more, and making
1665 them Qnil allows for better GC'ing
1666 in case a pointer to the dead frame
1667 continues to hang around. */
1668 f->framemeths = dead_console_methods;
1673 io_error_delete_frame (Lisp_Object frame)
1675 delete_frame_internal (XFRAME (frame), 1, 0, 1);
1678 DEFUN ("delete-frame", Fdelete_frame, 0, 2, "", /*
1679 Delete FRAME, permanently eliminating it from use.
1680 If omitted, FRAME defaults to the selected frame.
1681 A frame may not be deleted if its minibuffer is used by other frames.
1682 Normally, you cannot delete the last non-minibuffer-only frame (you must
1683 use `save-buffers-kill-emacs' or `kill-emacs'). However, if optional
1684 second argument FORCE is non-nil, you can delete the last frame. (This
1685 will automatically call `save-buffers-kill-emacs'.)
1689 /* This function can GC */
1694 f = selected_frame ();
1695 XSETFRAME (frame, f);
1699 CHECK_FRAME (frame);
1703 delete_frame_internal (f, !NILP (force), 0, 0);
1708 /* Return mouse position in character cell units. */
1711 mouse_pixel_position_1 (struct device *d, Lisp_Object *frame,
1714 switch (DEVMETH_OR_GIVEN (d, get_mouse_position, (d, frame, x, y), -1))
1724 *frame = DEVICE_SELECTED_FRAME (d);
1728 abort (); /* method is incorrectly written */
1734 DEFUN ("mouse-pixel-position", Fmouse_pixel_position, 0, 1, 0, /*
1735 Return a list (WINDOW X . Y) giving the current mouse window and position.
1736 The position is given in pixel units, where (0, 0) is the upper-left corner.
1738 When the cursor is not over a window, the return value is a list (nil nil).
1740 DEVICE specifies the device on which to read the mouse position, and
1741 defaults to the selected device. If the device is a mouseless terminal
1742 or Emacs hasn't been programmed to read its mouse position, it returns
1743 the device's selected window for WINDOW and nil for X and Y.
1747 struct device *d = decode_device (device);
1749 Lisp_Object window = Qnil;
1750 Lisp_Object x = Qnil;
1751 Lisp_Object y = Qnil;
1754 if (mouse_pixel_position_1 (d, &frame, &intx, &inty) > 0)
1757 find_window_by_pixel_pos (intx, inty, XFRAME (frame)->root_window);
1760 XSETWINDOW (window, w);
1762 /* Adjust the position to be relative to the window. */
1763 intx -= w->pixel_left;
1764 inty -= w->pixel_top;
1769 else if (FRAMEP (frame))
1770 window = FRAME_SELECTED_WINDOW (XFRAME (frame));
1772 return Fcons (window, Fcons (x, y));
1775 DEFUN ("mouse-position", Fmouse_position, 0, 1, 0, /*
1776 Return a list (WINDOW X . Y) giving the current mouse window and position.
1777 The position is of a character under cursor, where (0, 0) is the upper-left
1778 corner of the window.
1780 When the cursor is not over a character, or not over a window, the return
1781 value is a list (nil nil).
1783 DEVICE specifies the device on which to read the mouse position, and
1784 defaults to the selected device. If the device is a mouseless terminal
1785 or Emacs hasn't been programmed to read its mouse position, it returns
1786 the device's selected window for WINDOW and nil for X and Y.
1790 struct device *d = decode_device (device);
1792 Lisp_Object frame, window = Qnil, lisp_x = Qnil, lisp_y = Qnil;
1793 int x, y, obj_x, obj_y;
1794 Bufpos bufpos, closest;
1795 Charcount modeline_closest;
1796 Lisp_Object obj1, obj2;
1798 if (mouse_pixel_position_1 (d, &frame, &x, &y) > 0)
1800 int res = pixel_to_glyph_translation (XFRAME (frame), x, y, &x, &y,
1801 &obj_x, &obj_y, &w, &bufpos,
1802 &closest, &modeline_closest,
1804 if (res == OVER_TEXT)
1806 lisp_x = make_int (x);
1807 lisp_y = make_int (y);
1808 XSETWINDOW (window, w);
1811 else if (FRAMEP (frame))
1812 window = FRAME_SELECTED_WINDOW (XFRAME (frame));
1814 return Fcons (window, Fcons (lisp_x, lisp_y));
1817 DEFUN ("mouse-position-as-motion-event", Fmouse_position_as_motion_event, 0, 1, 0, /*
1818 Return the current mouse position as a motion event.
1819 This allows you to call the standard event functions such as
1820 `event-over-toolbar-p' to determine where the mouse is.
1822 DEVICE specifies the device on which to read the mouse position, and
1823 defaults to the selected device. If the mouse position can't be determined
1824 \(e.g. DEVICE is a TTY device), nil is returned instead of an event.
1828 struct device *d = decode_device (device);
1832 if (mouse_pixel_position_1 (d, &frame, &intx, &inty))
1834 Lisp_Object event = Fmake_event (Qnil, Qnil);
1835 XEVENT (event)->event_type = pointer_motion_event;
1836 XEVENT (event)->channel = frame;
1837 XEVENT (event)->event.motion.x = intx;
1838 XEVENT (event)->event.motion.y = inty;
1845 DEFUN ("set-mouse-position", Fset_mouse_position, 3, 3, 0, /*
1846 Move the mouse pointer to the center of character cell (X,Y) in WINDOW.
1847 Note, this is a no-op for an X frame that is not visible.
1848 If you have just created a frame, you must wait for it to become visible
1849 before calling this function on it, like this.
1850 (while (not (frame-visible-p frame)) (sleep-for .5))
1851 Note also: Warping the mouse is contrary to the ICCCM, so be very sure
1852 that the behavior won't end up being obnoxious!
1859 CHECK_LIVE_WINDOW (window);
1863 /* Warping the mouse will cause EnterNotify and Focus events under X. */
1864 w = XWINDOW (window);
1865 glyph_to_pixel_translation (w, XINT (x), XINT (y), &pix_x, &pix_y);
1867 MAYBE_FRAMEMETH (XFRAME (w->frame), set_mouse_position, (w, pix_x, pix_y));
1872 DEFUN ("set-mouse-pixel-position", Fset_mouse_pixel_position, 3, 3, 0, /*
1873 Move the mouse pointer to pixel position (X,Y) in WINDOW.
1874 Note, this is a no-op for an X frame that is not visible.
1875 If you have just created a frame, you must wait for it to become visible
1876 before calling this function on it, like this.
1877 (while (not (frame-visible-p frame)) (sleep-for .5))
1883 CHECK_LIVE_WINDOW (window);
1887 /* Warping the mouse will cause EnterNotify and Focus events under X. */
1888 w = XWINDOW (window);
1889 FRAMEMETH (XFRAME (w->frame), set_mouse_position, (w, XINT (x), XINT (y)));
1894 DEFUN ("make-frame-visible", Fmake_frame_visible, 0, 1, 0, /*
1895 Make the frame FRAME visible (assuming it is an X-window).
1896 If omitted, FRAME defaults to the currently selected frame.
1897 Also raises the frame so that nothing obscures it.
1901 struct frame *f = decode_frame (frame);
1903 MAYBE_FRAMEMETH (f, make_frame_visible, (f));
1907 DEFUN ("make-frame-invisible", Fmake_frame_invisible, 0, 2, 0, /*
1908 Unconditionally removes frame from the display (assuming it is an X-window).
1909 If omitted, FRAME defaults to the currently selected frame.
1910 If what you want to do is iconify the frame (if the window manager uses
1911 icons) then you should call `iconify-frame' instead.
1912 Normally you may not make FRAME invisible if all other frames are invisible
1913 and uniconified, but if the second optional argument FORCE is non-nil,
1918 struct frame *f, *sel_frame;
1921 f = decode_frame (frame);
1922 d = XDEVICE (FRAME_DEVICE (f));
1923 sel_frame = XFRAME (DEVICE_SELECTED_FRAME (d));
1925 if (NILP (force) && !other_visible_frames (f))
1926 error ("Attempt to make invisible the sole visible or iconified frame");
1928 /* Don't allow minibuf_window to remain on a deleted frame. */
1929 if (EQ (f->minibuffer_window, minibuf_window))
1931 Fset_window_buffer (sel_frame->minibuffer_window,
1932 XWINDOW (minibuf_window)->buffer);
1933 minibuf_window = sel_frame->minibuffer_window;
1936 MAYBE_FRAMEMETH (f, make_frame_invisible, (f));
1941 DEFUN ("iconify-frame", Ficonify_frame, 0, 1, "", /*
1942 Make the frame FRAME into an icon, if the window manager supports icons.
1943 If omitted, FRAME defaults to the currently selected frame.
1947 struct frame *f, *sel_frame;
1950 f = decode_frame (frame);
1951 d = XDEVICE (FRAME_DEVICE (f));
1952 sel_frame = XFRAME (DEVICE_SELECTED_FRAME (d));
1954 /* Don't allow minibuf_window to remain on a deleted frame. */
1955 if (EQ (f->minibuffer_window, minibuf_window))
1957 Fset_window_buffer (sel_frame->minibuffer_window,
1958 XWINDOW (minibuf_window)->buffer);
1959 minibuf_window = sel_frame->minibuffer_window;
1962 MAYBE_FRAMEMETH (f, iconify_frame, (f));
1967 DEFUN ("deiconify-frame", Fdeiconify_frame, 0, 1, 0, /*
1968 Open (de-iconify) the iconified frame FRAME.
1969 Under X, this is currently the same as `make-frame-visible'.
1970 If omitted, FRAME defaults to the currently selected frame.
1971 Also raises the frame so that nothing obscures it.
1975 return Fmake_frame_visible (frame);
1978 /* FSF returns 'icon for iconized frames. What a crock! */
1980 DEFUN ("frame-visible-p", Fframe_visible_p, 0, 1, 0, /*
1981 Return non NIL if FRAME is now "visible" (actually in use for display).
1982 A frame that is not visible is not updated, and, if it works through a
1983 window system, may not show at all.
1984 N.B. Under X "visible" means Mapped. It the window is mapped but not
1985 actually visible on screen then frame_visible returns 'hidden.
1989 struct frame *f = decode_frame (frame);
1990 int visible = FRAMEMETH_OR_GIVEN (f, frame_visible_p, (f), f->visible);
1991 return visible ? ( visible > 0 ? Qt : Qhidden ) : Qnil;
1994 DEFUN ("frame-totally-visible-p", Fframe_totally_visible_p, 0, 1, 0, /*
1995 Return t if frame is not obscured by any other window system windows.
1996 Always returns t for tty frames.
2000 struct frame *f = decode_frame (frame);
2001 return (FRAMEMETH_OR_GIVEN (f, frame_totally_visible_p, (f), f->visible)
2005 DEFUN ("frame-iconified-p", Fframe_iconified_p, 0, 1, 0, /*
2006 Return t if FRAME is iconified.
2007 Not all window managers use icons; some merely unmap the window, so this
2008 function is not the inverse of `frame-visible-p'. It is possible for a
2009 frame to not be visible and not be iconified either. However, if the
2010 frame is iconified, it will not be visible.
2014 struct frame *f = decode_frame (frame);
2017 f->iconified = FRAMEMETH_OR_GIVEN (f, frame_iconified_p, (f), 0);
2018 return f->iconified ? Qt : Qnil;
2021 DEFUN ("visible-frame-list", Fvisible_frame_list, 0, 1, 0, /*
2022 Return a list of all frames now "visible" (being updated).
2023 If DEVICE is specified only frames on that device will be returned.
2024 Note that under virtual window managers not all these frame are necessarily
2029 Lisp_Object devcons, concons;
2035 DEVICE_LOOP_NO_BREAK (devcons, concons)
2037 assert (DEVICEP (XCAR (devcons)));
2039 if (NILP (device) || EQ (device, XCAR (devcons)))
2041 Lisp_Object frmcons;
2043 DEVICE_FRAME_LOOP (frmcons, XDEVICE (XCAR (devcons)))
2045 Lisp_Object frame = XCAR (frmcons);
2047 if (FRAME_VISIBLE_P(f))
2048 value = Fcons (frame, value);
2057 DEFUN ("raise-frame", Fraise_frame, 0, 1, "", /*
2058 Bring FRAME to the front, so it occludes any frames it overlaps.
2059 If omitted, FRAME defaults to the currently selected frame.
2060 If FRAME is invisible, make it visible.
2061 If Emacs is displaying on an ordinary terminal or some other device which
2062 doesn't support multiple overlapping frames, this function does nothing.
2066 struct frame *f = decode_frame (frame);
2068 /* Do like the documentation says. */
2069 Fmake_frame_visible (frame);
2070 MAYBE_FRAMEMETH (f, raise_frame, (f));
2074 DEFUN ("lower-frame", Flower_frame, 0, 1, "", /*
2075 Send FRAME to the back, so it is occluded by any frames that overlap it.
2076 If omitted, FRAME defaults to the currently selected frame.
2077 If Emacs is displaying on an ordinary terminal or some other device which
2078 doesn't support multiple overlapping frames, this function does nothing.
2082 struct frame *f = decode_frame (frame);
2084 MAYBE_FRAMEMETH (f, lower_frame, (f));
2088 /* Ben thinks there is no need for `redirect-frame-focus' or `frame-focus',
2089 crockish FSFmacs functions. See summary on focus in event-stream.c. */
2092 /***************************************************************************/
2093 /* frame properties */
2094 /***************************************************************************/
2096 static void internal_set_frame_size (struct frame *f, int cols, int rows,
2100 store_minibuf_frame_prop (struct frame *f, Lisp_Object val)
2103 XSETFRAME (frame, f);
2107 if (! MINI_WINDOW_P (XWINDOW (val)))
2109 ("Surrogate minibuffer windows must be minibuffer windows",
2112 if (FRAME_HAS_MINIBUF_P (f) || FRAME_MINIBUF_ONLY_P (f))
2114 ("Can't change the surrogate minibuffer of a frame with its own minibuffer", frame);
2116 /* Install the chosen minibuffer window, with proper buffer. */
2117 f->minibuffer_window = val;
2119 else if (EQ (val, Qt))
2121 if (FRAME_HAS_MINIBUF_P (f) || FRAME_MINIBUF_ONLY_P (f))
2123 ("Frame already has its own minibuffer", frame);
2126 setup_normal_frame (f);
2127 f->mirror_dirty = 1;
2129 update_frame_window_mirror (f);
2130 internal_set_frame_size (f, f->width, f->height, 1);
2137 /* possible code if you want to have symbols such as `default-background'
2138 map to setting the background of `default', etc. */
2141 dissect_as_face_setting (Lisp_Object sym, Lisp_Object *face_out,
2142 Lisp_Object *face_prop_out)
2144 Lisp_Object list = Vbuilt_in_face_specifiers;
2145 struct Lisp_String *s;
2150 s = symbol_name (XSYMBOL (sym));
2152 while (!NILP (list))
2154 Lisp_Object prop = Fcar (list);
2155 struct Lisp_String *prop_name;
2157 if (!SYMBOLP (prop))
2159 prop_name = symbol_name (XSYMBOL (prop));
2160 if (string_length (s) > string_length (prop_name) + 1
2161 && !memcmp (string_data (prop_name),
2162 string_data (s) + string_length (s)
2163 - string_length (prop_name),
2164 string_length (prop_name))
2165 && string_data (s)[string_length (s) - string_length (prop_name)
2169 Ffind_face (make_string (string_data (s),
2171 - string_length (prop_name)
2176 *face_prop_out = prop;
2190 get_property_alias (Lisp_Object prop)
2194 Lisp_Object alias = Qnil;
2197 alias = Fget (prop, Qframe_property_alias, Qnil);
2207 /* #### Using this to modify the internal border width has no effect
2208 because the change isn't propagated to the windows. Are there
2209 other properties which this claims to handle, but doesn't?
2211 But of course. This stuff needs more work, but it's a lot closer
2212 to sanity now than before with the horrible frame-params stuff. */
2214 DEFUN ("set-frame-properties", Fset_frame_properties, 2, 2, 0, /*
2215 Change some properties of a frame.
2216 PLIST is a property list.
2217 You can also change frame properties individually using `set-frame-property',
2218 but it may be more efficient to change many properties at once.
2220 Frame properties can be retrieved using `frame-property' or `frame-properties'.
2222 The following symbols etc. have predefined meanings:
2224 name Name of the frame. Used with X resources.
2225 Unchangeable after creation.
2227 height Height of the frame, in lines.
2229 width Width of the frame, in characters.
2231 minibuffer Gives the minibuffer behavior for this frame. Either
2232 t (frame has its own minibuffer), `only' (frame is
2233 a minibuffer-only frame), or a window (frame uses that
2234 window, which is on another frame, as the minibuffer).
2236 unsplittable If non-nil, frame cannot be split by `display-buffer'.
2238 current-display-table, menubar-visible-p, left-margin-width,
2239 right-margin-width, minimum-line-ascent, minimum-line-descent,
2240 use-left-overflow, use-right-overflow, scrollbar-width, scrollbar-height,
2241 default-toolbar, top-toolbar, bottom-toolbar, left-toolbar, right-toolbar,
2242 default-toolbar-height, default-toolbar-width, top-toolbar-height,
2243 bottom-toolbar-height, left-toolbar-width, right-toolbar-width,
2244 default-toolbar-visible-p, top-toolbar-visible-p, bottom-toolbar-visible-p,
2245 left-toolbar-visible-p, right-toolbar-visible-p, toolbar-buttons-captioned-p,
2246 top-toolbar-border-width, bottom-toolbar-border-width,
2247 left-toolbar-border-width, right-toolbar-border-width,
2248 modeline-shadow-thickness, has-modeline-p
2249 [Giving the name of any built-in specifier variable is
2250 equivalent to calling `set-specifier' on the specifier,
2251 with a locale of FRAME. Giving the name to `frame-property'
2252 calls `specifier-instance' on the specifier.]
2254 text-pointer-glyph, nontext-pointer-glyph, modeline-pointer-glyph,
2255 selection-pointer-glyph, busy-pointer-glyph, toolbar-pointer-glyph,
2256 menubar-pointer-glyph, scrollbar-pointer-glyph, gc-pointer-glyph,
2257 octal-escape-glyph, control-arrow-glyph, invisible-text-glyph,
2258 hscroll-glyph, truncation-glyph, continuation-glyph
2259 [Giving the name of any glyph variable is equivalent to
2260 calling `set-glyph-image' on the glyph, with a locale
2261 of FRAME. Giving the name to `frame-property' calls
2262 `glyph-image-instance' on the glyph.]
2264 [default foreground], [default background], [default font],
2265 [modeline foreground], [modeline background], [modeline font],
2267 [Giving a vector of a face and a property is equivalent
2268 to calling `set-face-property' on the face and property,
2269 with a locale of FRAME. Giving the vector to
2270 `frame-property' calls `face-property-instance' on the
2273 Finally, if a frame property symbol has the property `frame-property-alias'
2274 on it, then the value will be used in place of that symbol when looking
2275 up and setting frame property values. This allows you to alias one
2276 frame property name to another.
2278 See the variables `default-x-frame-plist', `default-tty-frame-plist'
2279 and `default-mswindows-frame-plist' for a description of the properties
2280 recognized for particular types of frames.
2284 struct frame *f = decode_frame (frame);
2287 struct gcpro gcpro1, gcpro2;
2289 XSETFRAME (frame, f);
2290 GCPRO2 (frame, plist);
2291 Fcheck_valid_plist (plist);
2292 plist = Fcopy_sequence (plist);
2293 Fcanonicalize_lax_plist (plist, Qnil);
2294 for (tail = plist; !NILP (tail); tail = Fcdr (Fcdr (tail)))
2296 Lisp_Object prop = Fcar (tail);
2297 Lisp_Object val = Fcar (Fcdr (tail));
2299 prop = get_property_alias (prop);
2302 /* mly wants this, but it's not reasonable to change the name of a
2303 frame after it has been created, because the old name was used
2304 for resource lookup. */
2305 if (EQ (prop, Qname))
2311 if (EQ (prop, Qminibuffer))
2312 store_minibuf_frame_prop (f, val);
2313 if (EQ (prop, Qunsplittable))
2314 f->no_split = !NILP (val);
2315 if (EQ (prop, Qbuffer_predicate))
2316 f->buffer_predicate = val;
2317 if (SYMBOLP (prop) && EQ (Fbuilt_in_variable_type (prop),
2319 call3 (Qset_specifier, Fsymbol_value (prop), val, frame);
2320 if (SYMBOLP (prop) && !NILP (Fget (prop, Qconst_glyph_variable, Qnil)))
2321 call3 (Qset_glyph_image, Fsymbol_value (prop), val, frame);
2322 if (VECTORP (prop) && XVECTOR_LENGTH (prop) == 2)
2324 Lisp_Object face_prop = XVECTOR_DATA (prop)[1];
2325 CHECK_SYMBOL (face_prop);
2326 call4 (Qset_face_property,
2327 Fget_face (XVECTOR_DATA (prop)[0]),
2328 face_prop, val, frame);
2332 MAYBE_FRAMEMETH (f, set_frame_properties, (f, plist));
2333 for (tailp = &plist; !NILP (*tailp);)
2335 Lisp_Object *next_tailp;
2339 next = Fcdr (*tailp);
2341 next_tailp = &XCDR (next);
2342 prop = Fcar (*tailp);
2344 prop = get_property_alias (prop);
2346 if (EQ (prop, Qminibuffer)
2347 || EQ (prop, Qunsplittable)
2348 || EQ (prop, Qbuffer_predicate)
2349 || EQ (prop, Qheight)
2350 || EQ (prop, Qwidth)
2351 || (SYMBOLP (prop) && EQ (Fbuilt_in_variable_type (prop),
2353 || (SYMBOLP (prop) && !NILP (Fget (prop, Qconst_glyph_variable,
2355 || (VECTORP (prop) && XVECTOR_LENGTH (prop) == 2)
2356 || FRAMEMETH_OR_GIVEN (f, internal_frame_property_p, (f, prop), 0))
2357 *tailp = *next_tailp;
2361 f->plist = nconc2 (plist, f->plist);
2362 Fcanonicalize_lax_plist (f->plist, Qnil);
2367 DEFUN ("frame-property", Fframe_property, 2, 3, 0, /*
2368 Return FRAME's value for property PROPERTY.
2369 See `set-frame-properties' for the built-in property names.
2371 (frame, property, default_))
2373 struct frame *f = decode_frame (frame);
2376 XSETFRAME (frame, f);
2378 property = get_property_alias (property);
2380 if (EQ (Qname, property)) return f->name;
2382 if (EQ (Qheight, property) || EQ (Qwidth, property))
2384 if (window_system_pixelated_geometry (frame))
2387 pixel_to_real_char_size (f, FRAME_PIXWIDTH (f), FRAME_PIXHEIGHT (f),
2389 return make_int (EQ (Qheight, property) ? height: width);
2392 return make_int (EQ (Qheight, property) ?
2397 /* NOTE: FSF returns Qnil instead of Qt for FRAME_HAS_MINIBUF_P.
2398 This is over-the-top bogosity, because it's inconsistent with
2399 the semantics of `minibuffer' when passed to `make-frame'.
2400 Returning Qt makes things consistent. */
2401 if (EQ (Qminibuffer, property))
2402 return (FRAME_MINIBUF_ONLY_P (f) ? Qonly :
2403 FRAME_HAS_MINIBUF_P (f) ? Qt :
2404 FRAME_MINIBUF_WINDOW (f));
2405 if (EQ (Qunsplittable, property))
2406 return FRAME_NO_SPLIT_P (f) ? Qt : Qnil;
2407 if (EQ (Qbuffer_predicate, property))
2408 return f->buffer_predicate;
2410 if (SYMBOLP (property))
2412 if (EQ (Fbuilt_in_variable_type (property), Qconst_specifier))
2413 return Fspecifier_instance (Fsymbol_value (property),
2414 frame, default_, Qnil);
2415 if (!NILP (Fget (property, Qconst_glyph_variable, Qnil)))
2417 Lisp_Object glyph = Fsymbol_value (property);
2418 CHECK_GLYPH (glyph);
2419 return Fspecifier_instance (XGLYPH_IMAGE (glyph),
2420 frame, default_, Qnil);
2424 if (VECTORP (property) && XVECTOR_LENGTH (property) == 2)
2426 Lisp_Object face_prop = XVECTOR_DATA (property)[1];
2427 CHECK_SYMBOL (face_prop);
2428 return call3 (Qface_property_instance,
2429 Fget_face (XVECTOR_DATA (property)[0]),
2433 if (HAS_FRAMEMETH_P (f, frame_property))
2434 if (!UNBOUNDP (value = FRAMEMETH (f, frame_property, (f, property))))
2437 if (!UNBOUNDP (value = external_plist_get (&f->plist, property, 1, ERROR_ME)))
2443 DEFUN ("frame-properties", Fframe_properties, 0, 1, 0, /*
2444 Return a property list of the properties of FRAME.
2445 Do not modify this list; use `set-frame-property' instead.
2449 struct frame *f = decode_frame (frame);
2450 Lisp_Object result = Qnil;
2451 struct gcpro gcpro1;
2455 XSETFRAME (frame, f);
2457 /* #### for the moment (since old code uses `frame-parameters'),
2458 we call `copy-sequence' on f->plist. That allows frame-parameters
2459 to destructively convert the plist into an alist, which is more
2460 efficient than doing it non-destructively. At some point we
2461 should remove the call to copy-sequence. */
2462 result = Fcopy_sequence (f->plist);
2464 /* #### should we be adding all the specifiers and glyphs?
2465 That would entail having a list of them all. */
2466 if (HAS_FRAMEMETH_P (f, frame_properties))
2467 result = nconc2 (FRAMEMETH (f, frame_properties, (f)), result);
2469 if (!NILP (f->buffer_predicate))
2470 result = cons3 (Qbuffer_predicate, f->buffer_predicate, result);
2472 if (FRAME_NO_SPLIT_P (f))
2473 result = cons3 (Qunsplittable, Qt, result);
2475 /* NOTE: FSF returns Qnil instead of Qt for FRAME_HAS_MINIBUF_P.
2476 This is over-the-top bogosity, because it's inconsistent with
2477 the semantics of `minibuffer' when passed to `make-frame'.
2478 Returning Qt makes things consistent. */
2479 result = cons3 (Qminibuffer,
2480 (FRAME_MINIBUF_ONLY_P (f) ? Qonly :
2481 FRAME_HAS_MINIBUF_P (f) ? Qt :
2482 FRAME_MINIBUF_WINDOW (f)),
2487 if (window_system_pixelated_geometry (frame))
2489 pixel_to_real_char_size (f, FRAME_PIXWIDTH (f), FRAME_PIXHEIGHT (f),
2494 height = FRAME_HEIGHT (f);
2495 width = FRAME_WIDTH (f);
2497 result = cons3 (Qwidth , make_int (width), result);
2498 result = cons3 (Qheight, make_int (height), result);
2501 result = cons3 (Qname, f->name, result);
2508 DEFUN ("frame-pixel-height", Fframe_pixel_height, 0, 1, 0, /*
2509 Return the height in pixels of FRAME.
2513 return make_int (decode_frame (frame)->pixheight);
2516 DEFUN ("frame-pixel-width", Fframe_pixel_width, 0, 1, 0, /*
2517 Return the width in pixels of FRAME.
2521 return make_int (decode_frame (frame)->pixwidth);
2524 DEFUN ("frame-name", Fframe_name, 0, 1, 0, /*
2525 Return the name of FRAME (defaulting to the selected frame).
2526 This is not the same as the `title' of the frame.
2530 return decode_frame (frame)->name;
2533 DEFUN ("frame-modified-tick", Fframe_modified_tick, 0, 1, 0, /*
2534 Return FRAME's tick counter, incremented for each change to the frame.
2535 Each frame has a tick counter which is incremented each time the frame
2536 is resized, a window is resized, added, or deleted, a face is changed,
2537 `set-window-buffer' or `select-window' is called on a window in the
2538 frame, the window-start of a window in the frame has changed, or
2539 anything else interesting has happened. It wraps around occasionally.
2540 No argument or nil as argument means use selected frame as FRAME.
2544 return make_int (decode_frame (frame)->modiff);
2548 internal_set_frame_size (struct frame *f, int cols, int rows, int pretend)
2550 /* An explicit size change cancels any pending frame size adjustment */
2551 CLEAR_FRAME_SIZE_SLIPPED(f);
2553 if (pretend || !HAS_FRAMEMETH_P (f, set_frame_size))
2554 change_frame_size (f, rows, cols, 0);
2556 FRAMEMETH (f, set_frame_size, (f, cols, rows));
2559 DEFUN ("set-frame-height", Fset_frame_height, 2, 3, 0, /*
2560 Specify that the frame FRAME has LINES lines.
2561 Optional third arg non-nil means that redisplay should use LINES lines
2562 but that the idea of the actual height of the frame should not be changed.
2564 (frame, rows, pretend))
2566 struct frame *f = decode_frame (frame);
2568 XSETFRAME (frame, f);
2571 if (window_system_pixelated_geometry (frame))
2573 char_to_real_pixel_size (f, 0, XINT (rows), 0, &height);
2574 width = FRAME_PIXWIDTH (f);
2578 height = XINT (rows);
2579 width = FRAME_WIDTH (f);
2582 internal_set_frame_size (f, width, height, !NILP (pretend));
2586 DEFUN ("set-frame-width", Fset_frame_width, 2, 3, 0, /*
2587 Specify that the frame FRAME has COLS columns.
2588 Optional third arg non-nil means that redisplay should use COLS columns
2589 but that the idea of the actual width of the frame should not be changed.
2591 (frame, cols, pretend))
2593 struct frame *f = decode_frame (frame);
2595 XSETFRAME (frame, f);
2598 if (window_system_pixelated_geometry (frame))
2600 char_to_real_pixel_size (f, XINT (cols), 0, &width, 0);
2601 height = FRAME_PIXHEIGHT (f);
2605 width = XINT (cols);
2606 height = FRAME_HEIGHT (f);
2609 internal_set_frame_size (f, width, height, !NILP (pretend));
2613 DEFUN ("set-frame-size", Fset_frame_size, 3, 4, 0, /*
2614 Set the size of FRAME to COLS by ROWS.
2615 Optional fourth arg non-nil means that redisplay should use COLS by ROWS
2616 but that the idea of the actual size of the frame should not be changed.
2618 (frame, cols, rows, pretend))
2620 struct frame *f = decode_frame (frame);
2622 XSETFRAME (frame, f);
2626 if (window_system_pixelated_geometry (frame))
2627 char_to_real_pixel_size (f, XINT (cols), XINT (rows), &width, &height);
2630 height = XINT (rows);
2631 width = XINT (cols);
2634 internal_set_frame_size (f, width, height, !NILP (pretend));
2638 DEFUN ("set-frame-position", Fset_frame_position, 3, 3, 0, /*
2639 Set position of FRAME in pixels to XOFFSET by YOFFSET.
2640 This is actually the position of the upper left corner of the frame.
2641 Negative values for XOFFSET or YOFFSET are interpreted relative to
2642 the rightmost or bottommost possible position (that stays within the screen).
2644 (frame, xoffset, yoffset))
2646 struct frame *f = decode_frame (frame);
2647 CHECK_INT (xoffset);
2648 CHECK_INT (yoffset);
2650 MAYBE_FRAMEMETH (f, set_frame_position, (f, XINT (xoffset), XINT (yoffset)));
2657 /* Frame size conversion functions moved here from EmacsFrame.c
2658 because they're generic and really don't belong in that file.
2659 Function get_default_char_pixel_size() removed because it's
2660 exactly the same as default_face_height_and_width(). */
2662 frame_conversion_internal (struct frame *f, int pixel_to_char,
2663 int *pixel_width, int *pixel_height,
2664 int *char_width, int *char_height,
2671 Lisp_Object frame, window;
2673 XSETFRAME (frame, f);
2675 default_face_height_and_width (frame, &cph, &cpw);
2677 default_face_height_and_width_1 (frame, &cph, &cpw);
2679 window = FRAME_SELECTED_WINDOW (f);
2681 egw = max (glyph_width (Vcontinuation_glyph, window),
2682 glyph_width (Vtruncation_glyph, window));
2683 egw = max (egw, cpw);
2684 bdr = 2 * f->internal_border_width;
2685 obw = FRAME_SCROLLBAR_WIDTH (f) + FRAME_THEORETICAL_LEFT_TOOLBAR_WIDTH (f) +
2686 FRAME_THEORETICAL_RIGHT_TOOLBAR_WIDTH (f) +
2687 2 * FRAME_THEORETICAL_LEFT_TOOLBAR_BORDER_WIDTH (f) +
2688 2 * FRAME_THEORETICAL_RIGHT_TOOLBAR_BORDER_WIDTH (f);
2689 obh = FRAME_SCROLLBAR_HEIGHT (f) + FRAME_THEORETICAL_TOP_TOOLBAR_HEIGHT (f) +
2690 FRAME_THEORETICAL_BOTTOM_TOOLBAR_HEIGHT (f) +
2691 2 * FRAME_THEORETICAL_TOP_TOOLBAR_BORDER_WIDTH (f) +
2692 2 * FRAME_THEORETICAL_BOTTOM_TOOLBAR_BORDER_WIDTH (f);
2697 *char_width = 1 + ((*pixel_width - egw) - bdr - obw) / cpw;
2699 *char_height = (*pixel_height - bdr - obh) / cph;
2704 *pixel_width = (*char_width - 1) * cpw + egw + bdr + obw;
2706 *pixel_height = *char_height * cph + bdr + obh;
2710 /* This takes the size in pixels of the text area, and returns the number
2711 of characters that will fit there, taking into account the internal
2712 border width, and the pixel width of the line terminator glyphs (which
2713 always count as one "character" wide, even if they are not the same size
2714 as the default character size of the default font). The frame scrollbar
2715 width and left and right toolbar widths are also subtracted out of the
2716 available width. The frame scrollbar height and top and bottom toolbar
2717 heights are subtracted out of the available height.
2719 Therefore the result is not necessarily a multiple of anything in
2722 pixel_to_char_size (struct frame *f, int pixel_width, int pixel_height,
2723 int *char_width, int *char_height)
2725 frame_conversion_internal (f, 1, &pixel_width, &pixel_height, char_width,
2729 /* Given a character size, this returns the minimum number of pixels
2730 necessary to display that many characters, taking into account the
2731 internal border width, scrollbar height and width, toolbar heights and
2732 widths and the size of the line terminator glyphs (assuming the line
2733 terminators take up exactly one character position).
2735 Therefore the result is not necessarily a multiple of anything in
2738 char_to_pixel_size (struct frame *f, int char_width, int char_height,
2739 int *pixel_width, int *pixel_height)
2741 frame_conversion_internal (f, 0, pixel_width, pixel_height, &char_width,
2745 /* Given a pixel size, rounds DOWN to the smallest size in pixels necessary
2746 to display the same number of characters as are displayable now.
2749 round_size_to_char (struct frame *f, int in_width, int in_height,
2750 int *out_width, int *out_height)
2754 pixel_to_char_size (f, in_width, in_height, &char_width, &char_height);
2755 char_to_pixel_size (f, char_width, char_height, out_width, out_height);
2758 /* Versions of the above which always account for real font metrics.
2761 pixel_to_real_char_size (struct frame *f, int pixel_width, int pixel_height,
2762 int *char_width, int *char_height)
2764 frame_conversion_internal (f, 1, &pixel_width, &pixel_height, char_width,
2769 char_to_real_pixel_size (struct frame *f, int char_width, int char_height,
2770 int *pixel_width, int *pixel_height)
2772 frame_conversion_internal (f, 0, pixel_width, pixel_height, &char_width,
2777 round_size_to_real_char (struct frame *f, int in_width, int in_height,
2778 int *out_width, int *out_height)
2782 pixel_to_real_char_size (f, in_width, in_height, &char_width, &char_height);
2783 char_to_real_pixel_size (f, char_width, char_height, out_width, out_height);
2786 /* Change the frame height and/or width. Values may be given as zero to
2787 indicate no change is to take place. */
2789 change_frame_size_1 (struct frame *f, int newheight, int newwidth)
2792 int new_pixheight, new_pixwidth;
2793 int font_height, real_font_height, font_width;
2795 /* #### Chuck -- shouldn't we be checking to see if the frame
2796 is being "changed" to its existing size, and do nothing if so? */
2797 /* No, because it would hose toolbar updates. The toolbar
2798 update code relies on this function to cause window `top' and
2799 `left' coordinates to be recomputed even though no frame size
2800 change occurs. --kyle */
2804 XSETFRAME (frame, f);
2806 default_face_height_and_width (frame, &real_font_height, 0);
2807 default_face_height_and_width_1 (frame, &font_height, &font_width);
2809 /* This size-change overrides any pending one for this frame. */
2810 FRAME_NEW_HEIGHT (f) = 0;
2811 FRAME_NEW_WIDTH (f) = 0;
2813 new_pixheight = newheight * font_height;
2814 new_pixwidth = (newwidth - 1) * font_width;
2816 /* #### dependency on FRAME_WIN_P should be removed. */
2817 if (FRAME_WIN_P (f))
2819 new_pixheight += FRAME_SCROLLBAR_HEIGHT (f);
2820 new_pixwidth += FRAME_SCROLLBAR_WIDTH (f);
2823 /* when frame_conversion_internal() calculated the number of rows/cols
2824 in the frame, the theoretical toolbar sizes were subtracted out.
2825 The calculations below adjust for real toolbar height/width in
2826 frame, which may be different from frame spec, taking the above
2827 fact into account */
2829 + FRAME_THEORETICAL_TOP_TOOLBAR_HEIGHT (f)
2830 + 2 * FRAME_THEORETICAL_TOP_TOOLBAR_BORDER_WIDTH (f)
2831 - FRAME_REAL_TOP_TOOLBAR_HEIGHT (f)
2832 - 2 * FRAME_REAL_TOP_TOOLBAR_BORDER_WIDTH (f);
2835 + FRAME_THEORETICAL_BOTTOM_TOOLBAR_HEIGHT (f)
2836 + 2 * FRAME_THEORETICAL_BOTTOM_TOOLBAR_BORDER_WIDTH (f)
2837 - FRAME_REAL_BOTTOM_TOOLBAR_HEIGHT (f)
2838 - 2 * FRAME_REAL_BOTTOM_TOOLBAR_BORDER_WIDTH (f);
2841 + FRAME_THEORETICAL_LEFT_TOOLBAR_WIDTH (f)
2842 + 2 * FRAME_THEORETICAL_LEFT_TOOLBAR_BORDER_WIDTH (f)
2843 - FRAME_REAL_LEFT_TOOLBAR_WIDTH (f)
2844 - 2 * FRAME_REAL_LEFT_TOOLBAR_BORDER_WIDTH (f);
2847 + FRAME_THEORETICAL_RIGHT_TOOLBAR_WIDTH (f)
2848 + 2 * FRAME_THEORETICAL_RIGHT_TOOLBAR_BORDER_WIDTH (f)
2849 - FRAME_REAL_RIGHT_TOOLBAR_WIDTH (f)
2850 - 2 * FRAME_REAL_RIGHT_TOOLBAR_BORDER_WIDTH (f);
2852 /* Adjust the width for the end glyph which may be a different width
2853 than the default character width. */
2855 int adjustment, trunc_width, cont_width;
2857 trunc_width = glyph_width (Vtruncation_glyph,
2858 FRAME_SELECTED_WINDOW (f));
2859 cont_width = glyph_width (Vcontinuation_glyph,
2860 FRAME_SELECTED_WINDOW (f));
2861 adjustment = max (trunc_width, cont_width);
2862 adjustment = max (adjustment, font_width);
2864 new_pixwidth += adjustment;
2867 /* If we don't have valid values, exit. */
2868 if (!new_pixheight && !new_pixwidth)
2873 XWINDOW (FRAME_ROOT_WINDOW (f))->pixel_top = FRAME_TOP_BORDER_END (f);
2875 if (FRAME_HAS_MINIBUF_P (f)
2876 && ! FRAME_MINIBUF_ONLY_P (f))
2877 /* Frame has both root and minibuffer. */
2880 * Leave the minibuffer height the same if the frame has
2881 * been initialized, and the minibuffer height is tall
2882 * enough to display at least one line of text in the default
2883 * font, and the old minibuffer height is a multiple of the
2884 * default font height. This should cause the minibuffer
2885 * height to be recomputed on font changes but not for
2886 * other frame size changes, which seems reasonable.
2888 int old_minibuf_height =
2889 XWINDOW(FRAME_MINIBUF_WINDOW(f))->pixel_height;
2890 int minibuf_height =
2891 f->init_finished && (old_minibuf_height % real_font_height) == 0 ?
2892 max(old_minibuf_height, real_font_height) :
2894 set_window_pixheight (FRAME_ROOT_WINDOW (f),
2895 /* - font_height for minibuffer */
2896 new_pixheight - minibuf_height, 0);
2898 XWINDOW (FRAME_MINIBUF_WINDOW (f))->pixel_top =
2899 new_pixheight - minibuf_height + FRAME_TOP_BORDER_END (f);
2901 set_window_pixheight (FRAME_MINIBUF_WINDOW (f), minibuf_height, 0);
2904 /* Frame has just one top-level window. */
2905 set_window_pixheight (FRAME_ROOT_WINDOW (f), new_pixheight, 0);
2907 FRAME_HEIGHT (f) = newheight;
2908 if (FRAME_TTY_P (f))
2909 f->pixheight = newheight;
2914 XWINDOW (FRAME_ROOT_WINDOW (f))->pixel_left = FRAME_LEFT_BORDER_END (f);
2915 set_window_pixwidth (FRAME_ROOT_WINDOW (f), new_pixwidth, 0);
2917 if (FRAME_HAS_MINIBUF_P (f))
2919 XWINDOW (FRAME_MINIBUF_WINDOW (f))->pixel_left =
2920 FRAME_LEFT_BORDER_END (f);
2921 set_window_pixwidth (FRAME_MINIBUF_WINDOW (f), new_pixwidth, 0);
2924 FRAME_WIDTH (f) = newwidth;
2925 if (FRAME_TTY_P (f))
2926 f->pixwidth = newwidth;
2929 if (window_system_pixelated_geometry (frame))
2930 pixel_to_real_char_size (f, FRAME_PIXWIDTH (f), FRAME_PIXHEIGHT (f),
2931 &FRAME_CHARWIDTH (f), &FRAME_CHARHEIGHT (f));
2934 FRAME_CHARWIDTH (f) = FRAME_WIDTH (f);
2935 FRAME_CHARHEIGHT (f) = FRAME_HEIGHT (f);
2938 MARK_FRAME_TOOLBARS_CHANGED (f);
2939 MARK_FRAME_CHANGED (f);
2940 f->echo_area_garbaged = 1;
2944 change_frame_size (struct frame *f, int newheight, int newwidth, int delay)
2946 /* sometimes we get passed a size that's too small (esp. when a
2947 client widget gets resized, since we have no control over this).
2949 check_frame_size (f, &newheight, &newwidth);
2951 if (delay || in_display || gc_in_progress)
2953 MARK_FRAME_SIZE_CHANGED (f);
2954 f->new_width = newwidth;
2955 f->new_height = newheight;
2959 f->size_change_pending = 0;
2960 /* For TTY frames, it's like one, like all ...
2961 Can't have two TTY frames of different sizes on the same device. */
2962 if (FRAME_TTY_P (f))
2964 Lisp_Object frmcons;
2966 DEVICE_FRAME_LOOP (frmcons, XDEVICE (FRAME_DEVICE (f)))
2967 change_frame_size_1 (XFRAME (XCAR (frmcons)), newheight, newwidth);
2970 change_frame_size_1 (f, newheight, newwidth);
2974 /* The caller is responsible for freeing the returned string. */
2976 generate_title_string (struct window *w, Lisp_Object format_str,
2977 face_index findex, int type)
2979 struct display_line *dl;
2980 struct display_block *db;
2983 dl = &title_string_display_line;
2984 db = get_display_block_from_line (dl, TEXT);
2985 Dynarr_reset (db->runes);
2987 generate_formatted_string_db (format_str, Qnil, w, dl, db, findex, 0,
2990 Dynarr_reset (title_string_emchar_dynarr);
2991 while (elt < Dynarr_length (db->runes))
2993 if (Dynarr_atp (db->runes, elt)->type == RUNE_CHAR)
2994 Dynarr_add (title_string_emchar_dynarr,
2995 Dynarr_atp (db->runes, elt)->object.chr.ch);
3000 convert_emchar_string_into_malloced_string
3001 (Dynarr_atp (title_string_emchar_dynarr, 0),
3002 Dynarr_length (title_string_emchar_dynarr), 0);
3006 update_frame_title (struct frame *f)
3008 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
3009 Lisp_Object title_format;
3010 Lisp_Object icon_format;
3013 /* We don't change the title for the minibuffer unless the frame
3014 only has a minibuffer. */
3015 if (MINI_WINDOW_P (w) && !FRAME_MINIBUF_ONLY_P (f))
3018 /* And we don't want dead buffers to blow up on us. */
3019 if (!BUFFER_LIVE_P (XBUFFER (w->buffer)))
3023 title_format = symbol_value_in_buffer (Qframe_title_format, w->buffer);
3024 icon_format = symbol_value_in_buffer (Qframe_icon_title_format, w->buffer);
3026 if (HAS_FRAMEMETH_P (f, set_title_from_bufbyte))
3028 title = generate_title_string (w, title_format,
3029 DEFAULT_INDEX, CURRENT_DISP);
3030 FRAMEMETH (f, set_title_from_bufbyte, (f, title));
3033 if (HAS_FRAMEMETH_P (f, set_icon_name_from_bufbyte))
3035 if (!EQ (icon_format, title_format) || !title)
3040 title = generate_title_string (w, icon_format,
3041 DEFAULT_INDEX, CURRENT_DISP);
3043 FRAMEMETH (f, set_icon_name_from_bufbyte, (f, title));
3051 DEFUN ("set-frame-pointer", Fset_frame_pointer, 2, 2, 0, /*
3052 Set the mouse pointer of FRAME to the given pointer image instance.
3053 You should not call this function directly. Instead, set one of
3054 the variables `text-pointer-glyph', `nontext-pointer-glyph',
3055 `modeline-pointer-glyph', `selection-pointer-glyph',
3056 `busy-pointer-glyph', or `toolbar-pointer-glyph'.
3058 (frame, image_instance))
3060 struct frame *f = decode_frame (frame);
3061 CHECK_POINTER_IMAGE_INSTANCE (image_instance);
3062 if (!EQ (f->pointer, image_instance))
3064 f->pointer = image_instance;
3065 MAYBE_FRAMEMETH (f, set_frame_pointer, (f));
3072 update_frame_icon (struct frame *f)
3074 if (f->icon_changed || f->windows_changed)
3077 Lisp_Object new_icon;
3079 XSETFRAME (frame, f);
3080 new_icon = glyph_image_instance (Vframe_icon_glyph, frame,
3082 if (!EQ (new_icon, f->icon))
3085 MAYBE_FRAMEMETH (f, set_frame_icon, (f));
3089 f->icon_changed = 0;
3093 icon_glyph_changed (Lisp_Object glyph, Lisp_Object property,
3100 /***************************************************************************/
3102 /* initialization */
3104 /***************************************************************************/
3113 title_string_emchar_dynarr = Dynarr_new (Emchar);
3114 xzero (title_string_display_line);
3119 syms_of_frame (void)
3121 defsymbol (&Qdelete_frame_hook, "delete-frame-hook");
3122 defsymbol (&Qselect_frame_hook, "select-frame-hook");
3123 defsymbol (&Qdeselect_frame_hook, "deselect-frame-hook");
3124 defsymbol (&Qcreate_frame_hook, "create-frame-hook");
3125 defsymbol (&Qcustom_initialize_frame, "custom-initialize-frame");
3126 defsymbol (&Qmouse_enter_frame_hook, "mouse-enter-frame-hook");
3127 defsymbol (&Qmouse_leave_frame_hook, "mouse-leave-frame-hook");
3128 defsymbol (&Qmap_frame_hook, "map-frame-hook");
3129 defsymbol (&Qunmap_frame_hook, "unmap-frame-hook");
3131 defsymbol (&Qframep, "framep");
3132 defsymbol (&Qframe_live_p, "frame-live-p");
3133 defsymbol (&Qdelete_frame, "delete-frame");
3134 defsymbol (&Qsynchronize_minibuffers, "synchronize-minibuffers");
3135 defsymbol (&Qbuffer_predicate, "buffer-predicate");
3136 defsymbol (&Qframe_being_created, "frame-being-created");
3137 defsymbol (&Qmake_initial_minibuffer_frame, "make-initial-minibuffer-frame");
3139 defsymbol (&Qframe_title_format, "frame-title-format");
3140 defsymbol (&Qframe_icon_title_format, "frame-icon-title-format");
3142 defsymbol (&Qhidden, "hidden");
3143 defsymbol (&Qvisible, "visible");
3144 defsymbol (&Qiconic, "iconic");
3145 defsymbol (&Qinvisible, "invisible");
3146 defsymbol (&Qvisible_iconic, "visible-iconic");
3147 defsymbol (&Qinvisible_iconic, "invisible-iconic");
3148 defsymbol (&Qnomini, "nomini");
3149 defsymbol (&Qvisible_nomini, "visible-nomini");
3150 defsymbol (&Qiconic_nomini, "iconic-nomini");
3151 defsymbol (&Qinvisible_nomini, "invisible-nomini");
3152 defsymbol (&Qvisible_iconic_nomini, "visible-iconic-nomini");
3153 defsymbol (&Qinvisible_iconic_nomini, "invisible-iconic-nomini");
3155 defsymbol (&Qminibuffer, "minibuffer");
3156 defsymbol (&Qunsplittable, "unsplittable");
3157 defsymbol (&Qinternal_border_width, "internal-border-width");
3158 defsymbol (&Qtop_toolbar_shadow_color, "top-toolbar-shadow-color");
3159 defsymbol (&Qbottom_toolbar_shadow_color, "bottom-toolbar-shadow-color");
3160 defsymbol (&Qbackground_toolbar_color, "background-toolbar-color");
3161 defsymbol (&Qtop_toolbar_shadow_pixmap, "top-toolbar-shadow-pixmap");
3162 defsymbol (&Qbottom_toolbar_shadow_pixmap, "bottom-toolbar-shadow-pixmap");
3163 defsymbol (&Qtoolbar_shadow_thickness, "toolbar-shadow-thickness");
3164 defsymbol (&Qscrollbar_placement, "scrollbar-placement");
3165 defsymbol (&Qinter_line_space, "inter-line-space");
3166 /* Qiconic already in this function. */
3167 defsymbol (&Qvisual_bell, "visual-bell");
3168 defsymbol (&Qbell_volume, "bell-volume");
3169 defsymbol (&Qpointer_background, "pointer-background");
3170 defsymbol (&Qpointer_color, "pointer-color");
3171 defsymbol (&Qtext_pointer, "text-pointer");
3172 defsymbol (&Qspace_pointer, "space-pointer");
3173 defsymbol (&Qmodeline_pointer, "modeline-pointer");
3174 defsymbol (&Qgc_pointer, "gc-pointer");
3175 defsymbol (&Qinitially_unmapped, "initially-unmapped");
3176 defsymbol (&Quse_backing_store, "use-backing-store");
3177 defsymbol (&Qborder_color, "border-color");
3178 defsymbol (&Qborder_width, "border-width");
3179 /* Qwidth, Qheight, Qleft, Qtop in general.c */
3180 defsymbol (&Qset_specifier, "set-specifier");
3181 defsymbol (&Qset_glyph_image, "set-glyph-image");
3182 defsymbol (&Qset_face_property, "set-face-property");
3183 defsymbol (&Qface_property_instance, "face-property-instance");
3184 defsymbol (&Qframe_property_alias, "frame-property-alias");
3186 DEFSUBR (Fmake_frame);
3188 DEFSUBR (Fframe_live_p);
3190 DEFSUBR (Fignore_event);
3192 DEFSUBR (Ffocus_frame);
3193 DEFSUBR (Fselect_frame);
3194 DEFSUBR (Fselected_frame);
3195 DEFSUBR (Factive_minibuffer_window);
3196 DEFSUBR (Flast_nonminibuf_frame);
3197 DEFSUBR (Fframe_root_window);
3198 DEFSUBR (Fframe_selected_window);
3199 DEFSUBR (Fset_frame_selected_window);
3200 DEFSUBR (Fframe_device);
3201 DEFSUBR (Fnext_frame);
3202 DEFSUBR (Fprevious_frame);
3203 DEFSUBR (Fdelete_frame);
3204 DEFSUBR (Fmouse_position);
3205 DEFSUBR (Fmouse_pixel_position);
3206 DEFSUBR (Fmouse_position_as_motion_event);
3207 DEFSUBR (Fset_mouse_position);
3208 DEFSUBR (Fset_mouse_pixel_position);
3209 DEFSUBR (Fmake_frame_visible);
3210 DEFSUBR (Fmake_frame_invisible);
3211 DEFSUBR (Ficonify_frame);
3212 DEFSUBR (Fdeiconify_frame);
3213 DEFSUBR (Fframe_visible_p);
3214 DEFSUBR (Fframe_totally_visible_p);
3215 DEFSUBR (Fframe_iconified_p);
3216 DEFSUBR (Fvisible_frame_list);
3217 DEFSUBR (Fraise_frame);
3218 DEFSUBR (Flower_frame);
3219 DEFSUBR (Fframe_property);
3220 DEFSUBR (Fframe_properties);
3221 DEFSUBR (Fset_frame_properties);
3222 DEFSUBR (Fframe_pixel_height);
3223 DEFSUBR (Fframe_pixel_width);
3224 DEFSUBR (Fframe_name);
3225 DEFSUBR (Fframe_modified_tick);
3226 DEFSUBR (Fset_frame_height);
3227 DEFSUBR (Fset_frame_width);
3228 DEFSUBR (Fset_frame_size);
3229 DEFSUBR (Fset_frame_position);
3230 DEFSUBR (Fset_frame_pointer);
3234 vars_of_frame (void)
3237 Vframe_being_created = Qnil;
3238 staticpro (&Vframe_being_created);
3241 Fprovide (intern ("cde"));
3244 #ifdef HAVE_OFFIX_DND
3245 Fprovide (intern ("offix"));
3248 #if 0 /* FSFmacs stupidity */
3249 xxDEFVAR_LISP ("emacs-iconified", &Vemacs_iconified /*
3250 Non-nil if all of emacs is iconified and frame updates are not needed.
3252 Vemacs_iconified = Qnil;
3255 DEFVAR_LISP ("select-frame-hook", &Vselect_frame_hook /*
3256 Function or functions to run just after a new frame is given the focus.
3257 Note that calling `select-frame' does not necessarily set the focus:
3258 The actual window-system focus will not be changed until the next time
3259 that XEmacs is waiting for an event, and even then, the window manager
3260 may refuse the focus-change request.
3262 Vselect_frame_hook = Qnil;
3264 DEFVAR_LISP ("deselect-frame-hook", &Vdeselect_frame_hook /*
3265 Function or functions to run just before a frame loses the focus.
3266 See `select-frame-hook'.
3268 Vdeselect_frame_hook = Qnil;
3270 DEFVAR_LISP ("delete-frame-hook", &Vdelete_frame_hook /*
3271 Function or functions to call when a frame is deleted.
3272 One argument, the about-to-be-deleted frame.
3274 Vdelete_frame_hook = Qnil;
3276 DEFVAR_LISP ("create-frame-hook", &Vcreate_frame_hook /*
3277 Function or functions to call when a frame is created.
3278 One argument, the newly-created frame.
3280 Vcreate_frame_hook = Qnil;
3282 DEFVAR_LISP ("mouse-enter-frame-hook", &Vmouse_enter_frame_hook /*
3283 Function or functions to call when the mouse enters a frame.
3284 One argument, the frame.
3285 Be careful not to make assumptions about the window manager's focus model.
3286 In most cases, the `deselect-frame-hook' is more appropriate.
3288 Vmouse_enter_frame_hook = Qnil;
3290 DEFVAR_LISP ("mouse-leave-frame-hook", &Vmouse_leave_frame_hook /*
3291 Function or functions to call when the mouse leaves a frame.
3292 One argument, the frame.
3293 Be careful not to make assumptions about the window manager's focus model.
3294 In most cases, the `select-frame-hook' is more appropriate.
3296 Vmouse_leave_frame_hook = Qnil;
3298 DEFVAR_LISP ("map-frame-hook", &Vmap_frame_hook /*
3299 Function or functions to call when a frame is mapped.
3300 One argument, the frame.
3302 Vmap_frame_hook = Qnil;
3304 DEFVAR_LISP ("unmap-frame-hook", &Vunmap_frame_hook /*
3305 Function or functions to call when a frame is unmapped.
3306 One argument, the frame.
3308 Vunmap_frame_hook = Qnil;
3310 DEFVAR_BOOL ("allow-deletion-of-last-visible-frame",
3311 &allow_deletion_of_last_visible_frame /*
3312 *Non-nil means to assume the force option to delete-frame.
3314 allow_deletion_of_last_visible_frame = 0;
3316 DEFVAR_LISP ("adjust-frame-function", &Vadjust_frame_function /*
3317 Function or constant controlling adjustment of frame.
3318 When scrollbars, toolbars, default font etc. change in frame, the frame
3319 needs to be adjusted. The adjustment is controlled by this variable.
3321 nil to keep character frame size unchanged when possible (resize)
3322 t to keep pixel size unchanged (never resize)
3323 function symbol or lambda form. This function must return boolean
3324 value which is treated as above. Function is passed one parameter,
3325 the frame being adjusted. It function should not modify or delete
3328 Vadjust_frame_function = Qnil;
3330 DEFVAR_LISP ("mouse-motion-handler", &Vmouse_motion_handler /*
3331 Handler for motion events. One arg, the event.
3332 For most applications, you should use `mode-motion-hook' instead of this.
3334 Vmouse_motion_handler = Qnil;
3336 DEFVAR_LISP ("synchronize-minibuffers",&Vsynchronize_minibuffers /*
3337 Set to t if all minibuffer windows are to be synchronized.
3338 This will cause echo area messages to appear in the minibuffers of all
3341 Vsynchronize_minibuffers = Qnil;
3343 DEFVAR_LISP ("frame-title-format", &Vframe_title_format /*
3344 Controls the title of the X window corresponding to the selected frame.
3345 This is the same format as `modeline-format' with the exception that
3348 Vframe_title_format = build_string ("%S: %b");
3350 DEFVAR_LISP ("frame-icon-title-format", &Vframe_icon_title_format /*
3351 Controls the title of the icon corresponding to the selected frame.
3352 See also the variable `frame-title-format'.
3354 Vframe_icon_title_format = build_string ("%b");
3356 DEFVAR_LISP ("default-frame-name", &Vdefault_frame_name /*
3357 The default name to assign to newly-created frames.
3358 This can be overridden by arguments to `make-frame'.
3359 This must be a string.
3362 Vdefault_frame_name = build_string ("emacs");
3364 Vdefault_frame_name = build_string ("InfoDock");
3367 DEFVAR_LISP ("default-frame-plist", &Vdefault_frame_plist /*
3368 Plist of default values for frame creation, other than the first one.
3369 These may be set in your init file, like this:
3371 \(setq default-frame-plist '(width 80 height 55))
3373 The properties may be in alist format for backward compatibility
3374 but you should not rely on this behavior.
3376 These override values given in window system configuration data,
3377 including X Windows' defaults database.
3379 Since the first X frame is created before loading your .emacs file,
3380 you must use the X resource database for that.
3382 For values specific to the first Emacs frame, see `initial-frame-plist'.
3383 For values specific to the separate minibuffer frame, see
3384 `minibuffer-frame-plist'.
3386 See also the variables `default-x-frame-plist' and
3387 `default-tty-frame-plist', which are like `default-frame-plist'
3388 except that they apply only to X or tty frames, respectively
3389 \(whereas `default-frame-plist' applies to all types of frames).
3391 Vdefault_frame_plist = Qnil;
3393 DEFVAR_LISP ("frame-icon-glyph", &Vframe_icon_glyph /*
3394 Icon glyph used to iconify a frame.
3399 complex_vars_of_frame (void)
3401 Vframe_icon_glyph = allocate_glyph (GLYPH_ICON, icon_glyph_changed);