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 SXEmacs
8 SXEmacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 SXEmacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 /* Synched up with: FSF 19.30. */
24 /* This file has been Mule-ized. */
29 #include "buffer.h" /* for Vbuffer_alist */
31 #define INCLUDE_EVENTS_H_PRIVATE_SPHERE
32 #include "events/events.h"
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_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 void frame_conversion_internal(struct frame *f, int pixel_to_char,
120 int *pixel_width, int *pixel_height,
121 int *char_width, int *char_height,
123 static struct display_line title_string_display_line;
124 /* Used by generate_title_string. Global because they get used so much that
125 the dynamic allocation time adds up. */
126 static Emchar_dynarr *title_string_emchar_dynarr;
128 static Lisp_Object 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 if (FRAME_LIVE_P(f)) /* device is nil for a dead frame */
136 MAYBE_FRAMEMETH(f, mark_frame, (f));
142 print_frame(Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
144 struct frame *frm = XFRAME(obj);
147 error("printing unreadable object #<frame %s 0x%x>",
148 XSTRING_DATA(frm->name), frm->header.uid);
150 write_fmt_string(printcharfun, "#<%s-frame ",
151 (!FRAME_LIVE_P(frm) ? "dead" : FRAME_TYPE_NAME(frm)));
152 print_internal(frm->name, printcharfun, 1);
153 write_fmt_str(printcharfun, " 0x%x>", frm->header.uid);
156 DEFINE_LRECORD_IMPLEMENTATION("frame", frame,
157 mark_frame, print_frame, 0, 0, 0, 0,
160 static void nuke_all_frame_slots(struct frame *f)
162 #define MARKED_SLOT(x) f->x = Qnil
163 #include "frameslots.h"
166 /* Allocate a new frame object and set all its fields to reasonable
167 values. The root window is created but the minibuffer will be done
170 static struct frame *allocate_frame_core(Lisp_Object device)
172 /* This function can GC */
174 Lisp_Object root_window;
175 struct frame *f = alloc_lcrecord_type(struct frame, &lrecord_frame);
178 nuke_all_frame_slots(f);
182 f->framemeths = XDEVICE(device)->devmeths;
183 f->buffer_alist = Fcopy_sequence(Vbuffer_alist);
185 root_window = allocate_window();
186 XWINDOW(root_window)->frame = frame;
189 Just so that there is "something there."
190 Correct size will be set up later with change_frame_size. */
195 XWINDOW(root_window)->pixel_width = 10;
196 XWINDOW(root_window)->pixel_height = 9;
198 f->root_window = root_window;
199 f->selected_window = root_window;
200 f->last_nonminibuf_window = root_window;
202 /* cache of subwindows visible on frame */
203 f->subwindow_instance_cache = make_weak_list(WEAK_LIST_SIMPLE);
205 /* associated exposure ignore list */
206 f->subwindow_exposures = 0;
207 f->subwindow_exposures_tail = 0;
209 FRAME_SET_PAGENUMBER(f, 1);
211 /* Choose a buffer for the frame's root window. */
212 XWINDOW(root_window)->buffer = Qt;
214 Lisp_Object buf = Fcurrent_buffer();
215 Lisp_Object tmp = Fbuffer_name(buf);
217 /* If buf is a 'hidden' buffer (i.e. one whose name starts with
218 a space), try to find another one. */
219 if (string_char(XSTRING(tmp), 0) == ' ') {
220 buf = Fother_buffer(buf, Qnil, Qnil);
222 Fset_window_buffer(root_window, buf, Qnil);
228 static void setup_normal_frame(struct frame *f)
230 Lisp_Object mini_window;
235 mini_window = allocate_window();
236 XWINDOW(f->root_window)->next = mini_window;
237 XWINDOW(mini_window)->prev = f->root_window;
238 XWINDOW(mini_window)->mini_p = Qt;
239 XWINDOW(mini_window)->frame = frame;
240 f->minibuffer_window = mini_window;
241 f->has_minibuffer = 1;
243 XWINDOW(mini_window)->buffer = Qt;
244 Fset_window_buffer(mini_window, Vminibuffer_zero, Qt);
247 /* Make a frame using a separate minibuffer window on another frame.
248 MINI_WINDOW is the minibuffer window to use. nil means use the
249 default-minibuffer-frame. */
252 setup_frame_without_minibuffer(struct frame *f, Lisp_Object mini_window)
254 /* This function can GC */
255 Lisp_Object device = f->device;
257 if (!NILP(mini_window))
258 CHECK_LIVE_WINDOW(mini_window);
260 if (!NILP(mini_window)
261 && !EQ(DEVICE_CONSOLE(XDEVICE(device)),
262 FRAME_CONSOLE(XFRAME(XWINDOW(mini_window)->frame))))
263 error("frame and minibuffer must be on the same console");
265 /* Do not create a default minibuffer frame on printer devices. */
266 if (NILP(mini_window)
267 && DEVICE_DISPLAY_P(XDEVICE(FRAME_DEVICE(f)))) {
268 struct console *con = XCONSOLE(FRAME_CONSOLE(f));
269 /* Use default-minibuffer-frame if possible. */
270 if (!FRAMEP(con->default_minibuffer_frame)
271 || !FRAME_LIVE_P(XFRAME(con->default_minibuffer_frame))) {
272 /* If there's no minibuffer frame to use, create one. */
273 con->default_minibuffer_frame
274 = call1(Qmake_initial_minibuffer_frame, device);
277 XFRAME(con->default_minibuffer_frame)->minibuffer_window;
280 /* Install the chosen minibuffer window, with proper buffer. */
281 if (!NILP(mini_window)) {
282 store_minibuf_frame_prop(f, mini_window);
283 Fset_window_buffer(mini_window, Vminibuffer_zero, Qt);
285 f->minibuffer_window = Qnil;
288 /* Make a frame containing only a minibuffer window. */
290 static void setup_minibuffer_frame(struct frame *f)
292 /* This function can GC */
293 /* First make a frame containing just a root window, no minibuffer. */
294 Lisp_Object mini_window;
300 f->has_minibuffer = 1;
302 /* Now label the root window as also being the minibuffer.
303 Avoid infinite looping on the window chain by marking next pointer
306 mini_window = f->minibuffer_window = f->root_window;
307 XWINDOW(mini_window)->mini_p = Qt;
308 XWINDOW(mini_window)->next = Qnil;
309 XWINDOW(mini_window)->prev = Qnil;
310 XWINDOW(mini_window)->frame = frame;
312 /* Put the proper buffer in that window. */
314 Fset_window_buffer(mini_window, Vminibuffer_zero, Qt);
317 static Lisp_Object make_sure_its_a_fresh_plist(Lisp_Object foolist)
319 Lisp_Object tmp = Fcar(foolist);
321 /* looks like an alist to me. */
322 foolist = Fcopy_alist(foolist);
323 foolist = Fdestructive_alist_to_plist(foolist);
325 foolist = Fcopy_sequence(foolist);
330 DEFUN("make-frame", Fmake_frame, 0, 2, "", /*
331 Create and return a new frame, displaying the current buffer.
332 Runs the functions listed in `create-frame-hook' after frame creation.
334 Optional argument PROPS is a property list (a list of alternating
335 keyword-value specifications) of properties for the new frame.
336 \(An alist is accepted for backward compatibility but should not
339 See `set-frame-properties', `default-x-frame-plist', and
340 `default-tty-frame-plist' for the specially-recognized properties.
346 Lisp_Object frame = Qnil, name = Qnil, minibuf;
347 struct gcpro gcpro1, gcpro2, gcpro3;
348 int speccount = specpdl_depth();
349 int first_frame_on_device = 0;
350 int first_frame_on_console = 0;
352 d = decode_device(device);
353 XSETDEVICE(device, d);
355 /* PROPS and NAME may be freshly-created, so make sure to GCPRO. */
356 GCPRO3(frame, props, name);
358 props = make_sure_its_a_fresh_plist(props);
359 if (DEVICE_SPECIFIC_FRAME_PROPS(d))
360 /* Put the device-specific props before the more general ones so
361 that they override them. */
362 props = nconc2(props,
363 make_sure_its_a_fresh_plist
364 (*DEVICE_SPECIFIC_FRAME_PROPS(d)));
366 nconc2(props, make_sure_its_a_fresh_plist(Vdefault_frame_plist));
367 Fcanonicalize_lax_plist(props, Qnil);
369 name = Flax_plist_get(props, Qname, Qnil);
372 else if (STRINGP(Vdefault_frame_name))
373 name = Vdefault_frame_name;
375 name = build_string("SXEmacs");
377 if (!NILP(Fstring_match(make_string((const Bufbyte *)"\\.", 2), name,
379 signal_simple_error(". not allowed in frame names", name);
381 f = allocate_frame_core(device);
384 specbind(Qframe_being_created, name);
387 FRAMEMETH(f, init_frame_1, (f, props));
389 minibuf = Flax_plist_get(props, Qminibuffer, Qunbound);
390 if (UNBOUNDP(minibuf)) {
391 /* If minibuf is unspecified, then look for a minibuffer X resource. */
392 /* #### Not implemented any more. We need to fix things up so
393 that we search out all X resources and append them to the end of
394 props, above. This is the only way in general to assure
395 coherent behavior for all frame properties/resources/etc. */
397 props = Flax_plist_remprop(props, Qminibuffer);
399 if (EQ(minibuf, Qnone) || NILP(minibuf))
400 setup_frame_without_minibuffer(f, Qnil);
401 else if (EQ(minibuf, Qonly))
402 setup_minibuffer_frame(f);
403 else if (WINDOWP(minibuf))
404 setup_frame_without_minibuffer(f, minibuf);
405 else if (EQ(minibuf, Qt) || UNBOUNDP(minibuf))
406 setup_normal_frame(f);
408 signal_simple_error("Invalid value for `minibuffer'", minibuf);
410 update_frame_window_mirror(f);
412 if (initialized && !DEVICE_STREAM_P(d)) {
413 if (!NILP(f->minibuffer_window))
414 reset_face_cachels(XWINDOW(f->minibuffer_window));
415 reset_face_cachels(XWINDOW(f->root_window));
418 /* If no frames on this device formerly existed, say this is the
419 first frame. It kind of assumes that frameless devices don't
420 exist, but it shouldn't be too harmful. */
421 if (NILP(DEVICE_FRAME_LIST(d)))
422 first_frame_on_device = 1;
424 /* This *must* go before the init_*() methods. Those functions
425 call Lisp code, and if any of them causes a warning to be displayed
426 and the *Warnings* buffer to be created, it won't get added to
427 the frame-specific version of the buffer-alist unless the frame
428 is accessible from the device. */
431 DEVICE_FRAME_LIST(d) = nconc2(DEVICE_FRAME_LIST(d), Fcons(frame, Qnil));
433 DEVICE_FRAME_LIST(d) = Fcons(frame, DEVICE_FRAME_LIST(d));
434 RESET_CHANGED_SET_FLAGS;
436 /* Now make sure that the initial cached values are set correctly.
437 Do this after the init_frame method is called because that may
438 do things (e.g. create widgets) that are necessary for the
439 specifier value-changed methods to work OK. */
440 recompute_all_cached_specifiers_in_frame(f);
442 if (!DEVICE_STREAM_P(d)) {
445 #ifdef HAVE_SCROLLBARS
446 /* Finish up resourcing the scrollbars. */
447 init_frame_scrollbars(f);
451 /* Create the initial toolbars. We have to do this after the frame
452 methods are called because it may potentially call some things itself
453 which depend on the normal frame methods having initialized
455 init_frame_toolbars(f);
457 reset_face_cachels(XWINDOW(FRAME_SELECTED_WINDOW(f)));
458 reset_glyph_cachels(XWINDOW(FRAME_SELECTED_WINDOW(f)));
460 change_frame_size(f, f->height, f->width, 0);
463 MAYBE_FRAMEMETH(f, init_frame_2, (f, props));
464 Fset_frame_properties(frame, props);
465 MAYBE_FRAMEMETH(f, init_frame_3, (f));
467 /* Hallelujah, praise the lord. */
468 f->init_finished = 1;
470 /* If this is the first frame on the device, make it the selected one. */
471 if (first_frame_on_device && NILP(DEVICE_SELECTED_FRAME(d)))
472 set_device_selected_frame(d, frame);
474 /* If at startup or if the current console is a stream console
475 (usually also at startup), make this console the selected one
476 so that messages show up on it. */
478 Lisp_Object tmp = Fselected_console();
479 if (NILP(tmp) || CONSOLE_STREAM_P(XCONSOLE(tmp))) {
480 Fselect_console(DEVICE_CONSOLE(d));
484 first_frame_on_console =
485 (first_frame_on_device &&
486 XINT(Flength(CONSOLE_DEVICE_LIST(XCONSOLE(DEVICE_CONSOLE(d)))))
489 /* #### all this calling of frame methods at various odd times
490 is somewhat of a mess. It's necessary to do it this way due
491 to strange console-type-specific things that need to be done. */
492 MAYBE_FRAMEMETH(f, after_init_frame, (f, first_frame_on_device,
493 first_frame_on_console));
495 if (!DEVICE_STREAM_P(d)) {
496 /* Now initialise the gutters. This won't change the frame size,
497 but is needed as input to the layout that change_frame_size
498 will eventually do. Unfortunately gutter sizing code relies
499 on the frame in question being visible so we can't do this
501 init_frame_gutters(f);
503 change_frame_size(f, f->height, f->width, 0);
506 if (first_frame_on_device) {
507 if (first_frame_on_console)
508 va_run_hook_with_args(Qcreate_console_hook, 1,
510 va_run_hook_with_args(Qcreate_device_hook, 1, device);
512 va_run_hook_with_args(Qcreate_frame_hook, 1, frame);
514 /* Initialize custom-specific stuff. */
515 if (!UNBOUNDP(symbol_function(XSYMBOL(Qcustom_initialize_frame))))
516 call1(Qcustom_initialize_frame, frame);
518 unbind_to(speccount, Qnil);
524 /* this function should be used in most cases when a Lisp function is passed
525 a FRAME argument. Use this unless you don't accept nil == current frame
526 (in which case, do a CHECK_LIVE_FRAME() and then an XFRAME()) or you
527 allow dead frames. Note that very few functions should accept dead
528 frames. It could be argued that functions should just do nothing when
529 given a dead frame, but the presence of a dead frame usually indicates
530 an oversight in the Lisp code that could potentially lead to strange
531 results and so it is better to catch the error early.
533 If you only accept X frames, use decode_x_frame(), which does what this
534 function does but also makes sure the frame is an X frame. */
536 struct frame *decode_frame(Lisp_Object frame)
539 return selected_frame();
541 CHECK_LIVE_FRAME(frame);
542 return XFRAME(frame);
545 struct frame *decode_frame_or_selected(Lisp_Object cdf)
548 cdf = CONSOLE_SELECTED_DEVICE(decode_console(cdf));
550 cdf = DEVICE_SELECTED_FRAME(decode_device(cdf));
551 return decode_frame(cdf);
554 Lisp_Object make_frame(struct frame * f)
562 * window size changes are held up during critical regions. Afterwards,
563 * we want to deal with any delayed changes.
565 void hold_frame_size_changes(void)
570 void unhold_one_frame_size_changes(struct frame *f)
574 if (f->size_change_pending)
575 change_frame_size(f, f->new_height, f->new_width, 0);
578 void unhold_frame_size_changes(void)
580 Lisp_Object frmcons, devcons, concons;
582 FRAME_LOOP_NO_BREAK(frmcons, devcons, concons)
583 unhold_one_frame_size_changes(XFRAME(XCAR(frmcons)));
586 void invalidate_vertical_divider_cache_in_frame(struct frame *f)
588 /* Invalidate cached value of needs_vertical_divider_p in
589 every and all windows */
590 map_windows(f, invalidate_vertical_divider_cache_in_window, 0);
594 * Frame size may change due to changes in scrollbars, toolbars,
595 * default font etc. These changes are applied early in redisplay
598 void adjust_frame_size(struct frame *f)
600 int keep_char_size = 0;
604 if (!f->size_slipped)
607 /* Don't adjust tty frames. #### May break when TTY have menubars.
608 Then, write an Vadjust_frame_function which will return t for TTY
609 frames. Another solution is frame_size_fixed_p method for TTYs,
610 which always returned yes it's fixed.
612 if (!FRAME_WIN_P(f)) {
613 CLEAR_FRAME_SIZE_SLIPPED(f);
617 /* frame_size_fixed_p tells that frame size cannot currently
618 be changed change due to external conditions */
619 if (!FRAMEMETH_OR_GIVEN(f, frame_size_fixed_p, (f), 0)) {
620 if (NILP(Vadjust_frame_function))
622 else if (EQ(Vadjust_frame_function, Qt))
626 NILP(call1_trapping_errors
627 ("Error in adjust-frame-function",
628 Vadjust_frame_function, frame));
631 Fset_frame_size(frame, make_int(FRAME_CHARWIDTH(f)),
632 make_int(FRAME_CHARHEIGHT(f)), Qnil);
635 if (!keep_char_size) {
637 pixel_to_char_size(f, FRAME_PIXWIDTH(f), FRAME_PIXHEIGHT(f),
639 change_frame_size(f, height, width, 0);
640 CLEAR_FRAME_SIZE_SLIPPED(f);
645 * This is a "specifier changed in frame" handler for various specifiers
646 * changing which causes frame size adjustment
649 frame_size_slipped(Lisp_Object specifier, struct frame *f, Lisp_Object oldval)
651 MARK_FRAME_SIZE_SLIPPED(f);
654 DEFUN("framep", Fframep, 1, 1, 0, /*
655 Return non-nil if OBJECT is a frame.
656 Also see `frame-live-p'.
657 Note that FSF Emacs kludgily returns a value indicating what type of
658 frame this is. Use the cleaner function `frame-type' for that.
662 return FRAMEP(object) ? Qt : Qnil;
665 DEFUN("frame-live-p", Fframe_live_p, 1, 1, 0, /*
666 Return non-nil if OBJECT is a frame which has not been deleted.
670 return FRAMEP(object) && FRAME_LIVE_P(XFRAME(object)) ? Qt : Qnil;
673 DEFUN("focus-frame", Ffocus_frame, 1, 1, 0, /*
674 Select FRAME and give it the window system focus.
675 This function is not affected by the value of `focus-follows-mouse'.
679 CHECK_LIVE_FRAME(frame);
681 MAYBE_DEVMETH(XDEVICE(FRAME_DEVICE(XFRAME(frame))), focus_on_frame,
683 /* FRAME will be selected by the time we receive the next event.
684 However, it is better to select it explicitly now, in case the
685 Lisp code depends on frame being selected. */
686 Fselect_frame(frame);
690 /* Called from Fselect_window() */
691 void select_frame_1(Lisp_Object frame)
693 struct frame *f = XFRAME(frame);
694 Lisp_Object old_selected_frame = Fselected_frame(Qnil);
696 if (EQ(frame, old_selected_frame))
699 /* now select the frame's device */
700 set_device_selected_frame(XDEVICE(FRAME_DEVICE(f)), frame);
701 select_device_1(FRAME_DEVICE(f));
703 update_frame_window_mirror(f);
706 DEFUN("select-frame", Fselect_frame, 1, 1, 0, /*
707 Select the frame FRAME.
708 Subsequent editing commands apply to its selected window.
709 The selection of FRAME lasts until the next time the user does
710 something to select a different frame, or until the next time this
713 Note that this does not actually cause the window-system focus to be
714 set to this frame, or the `select-frame-hook' or `deselect-frame-hook'
715 to be run, until the next time that SXEmacs is waiting for an event.
717 Also note that when focus-follows-mouse is non-nil, the frame
718 selection is temporary and is reverted when the current command
719 terminates, much like the buffer selected by `set-buffer'. In order
720 to effect a permanent focus change, use `focus-frame'.
724 CHECK_LIVE_FRAME(frame);
726 /* select the frame's selected window. This will call
727 selected_frame_1(). */
728 Fselect_window(FRAME_SELECTED_WINDOW(XFRAME(frame)), Qnil);
730 /* Nothing should be depending on the return value of this function.
731 But, of course, there is stuff out there which is. */
735 /* use this to retrieve the currently selected frame. You should use
736 this in preference to Fselected_frame (Qnil) unless you are prepared
737 to handle the possibility of there being no selected frame (this
738 happens at some points during startup). */
740 struct frame *selected_frame(void)
742 Lisp_Object device = Fselected_device(Qnil);
743 Lisp_Object frame = DEVICE_SELECTED_FRAME(XDEVICE(device));
745 signal_simple_error("No frames exist on device", device);
746 return XFRAME(frame);
749 /* use this instead of XFRAME (DEVICE_SELECTED_FRAME (d)) to catch
750 the possibility of there being no frames on the device (just created).
751 There is no point doing this inside of redisplay because errors
752 cause an abort(), indicating a flaw in the logic, and error_check_frame()
753 will catch this just as well. */
755 struct frame *device_selected_frame(struct device *d)
757 Lisp_Object frame = DEVICE_SELECTED_FRAME(d);
760 XSETDEVICE(device, d);
761 signal_simple_error("No frames exist on device", device);
763 return XFRAME(frame);
768 xxDEFUN("handle-switch-frame", Fhandle_switch_frame, 1, 2, "e", /*
769 Handle a switch-frame event EVENT.
770 Switch-frame events are usually bound to this function.
771 A switch-frame event tells Emacs that the window manager has requested
772 that the user's events be directed to the frame mentioned in the event.
773 This function selects the selected window of the frame of EVENT.
775 If EVENT is frame object, handle it as if it were a switch-frame event
780 /* Preserve prefix arg that the command loop just cleared. */
781 XCONSOLE(Vselected_console)->prefix_arg = Vcurrent_prefix_arg;
783 run_hook(Qmouse_leave_buffer_hook);
785 return do_switch_frame(frame, no_enter, 0);
788 /* A load of garbage. */
789 xxDEFUN("ignore-event", Fignore_event, 0, 0, "", /*
790 Do nothing, but preserve any prefix argument already specified.
791 This is a suitable binding for iconify-frame and make-frame-visible.
795 struct console *c = XCONSOLE(Vselected_console);
797 c->prefix_arg = Vcurrent_prefix_arg;
803 DEFUN("selected-frame", Fselected_frame, 0, 1, 0, /*
804 Return the frame that is now selected on device DEVICE.
805 If DEVICE is not specified, the selected device will be used.
806 If no frames exist on the device, nil is returned.
810 if (NILP(device) && NILP(Fselected_device(Qnil)))
811 return Qnil; /* happens early in temacs */
812 return DEVICE_SELECTED_FRAME(decode_device(device));
815 Lisp_Object frame_first_window(struct frame * f)
817 Lisp_Object w = f->root_window;
820 if (!NILP(XWINDOW(w)->hchild))
821 w = XWINDOW(w)->hchild;
822 else if (!NILP(XWINDOW(w)->vchild))
823 w = XWINDOW(w)->vchild;
831 DEFUN("active-minibuffer-window", Factive_minibuffer_window, 0, 0, 0, /*
832 Return the currently active minibuffer window, or nil if none.
836 return minibuf_level ? minibuf_window : Qnil;
839 DEFUN("last-nonminibuf-frame", Flast_nonminibuf_frame, 0, 1, 0, /*
840 Return the most-recently-selected non-minibuffer-only frame on CONSOLE.
841 This will always be the same as (selected-frame device) unless the
842 selected frame is a minibuffer-only frame.
843 CONSOLE defaults to the selected console if omitted.
849 XSETCONSOLE(console, decode_console(console));
850 /* Just in case the machinations in delete_frame_internal() resulted
851 in the last-nonminibuf-frame getting out of sync, make sure and
852 return the selected frame if it's acceptable. */
853 result = Fselected_frame(CONSOLE_SELECTED_DEVICE(XCONSOLE(console)));
854 if (!NILP(result) && !FRAME_MINIBUF_ONLY_P(XFRAME(result)))
856 return CONSOLE_LAST_NONMINIBUF_FRAME(XCONSOLE(console));
859 DEFUN("frame-root-window", Fframe_root_window, 0, 1, 0, /*
860 Return the root-window of FRAME.
861 If omitted, FRAME defaults to the currently selected frame.
865 struct frame *f = decode_frame(frame);
866 return FRAME_ROOT_WINDOW(f);
869 DEFUN("frame-selected-window", Fframe_selected_window, 0, 1, 0, /*
870 Return the selected window of frame object FRAME.
871 If omitted, FRAME defaults to the currently selected frame.
875 struct frame *f = decode_frame(frame);
876 return FRAME_SELECTED_WINDOW(f);
879 void set_frame_selected_window(struct frame *f, Lisp_Object window)
881 assert(XFRAME(WINDOW_FRAME(XWINDOW(window))) == f);
882 f->selected_window = window;
883 if (!MINI_WINDOW_P(XWINDOW(window)) || FRAME_MINIBUF_ONLY_P(f)) {
884 if (!EQ(f->last_nonminibuf_window, window)) {
886 MARK_TOOLBAR_CHANGED;
890 f->last_nonminibuf_window = window;
894 DEFUN("set-frame-selected-window", Fset_frame_selected_window, 2, 2, 0, /*
895 Set the selected window of FRAME to WINDOW.
896 If FRAME is nil, the selected frame is used.
897 If FRAME is the selected frame, this makes WINDOW the selected window.
901 XSETFRAME(frame, decode_frame(frame));
902 CHECK_LIVE_WINDOW(window);
904 if (!EQ(frame, WINDOW_FRAME(XWINDOW(window))))
905 error("In `set-frame-selected-window', WINDOW is not on FRAME");
907 if (XFRAME(frame) == selected_frame())
908 return Fselect_window(window, Qnil);
910 set_frame_selected_window(XFRAME(frame), window);
914 DEFUN("frame-device", Fframe_device, 0, 1, 0, /*
915 Return the device that FRAME is on.
916 If omitted, FRAME defaults to the currently selected frame.
920 return FRAME_DEVICE(decode_frame(frame));
923 int is_surrogate_for_selected_frame(struct frame *f)
925 struct device *d = XDEVICE(f->device);
926 struct frame *dsf = device_selected_frame(d);
928 /* Can't be a surrogate for ourselves. */
932 if (!FRAME_HAS_MINIBUF_P(dsf) &&
933 f == XFRAME(WINDOW_FRAME(XWINDOW(FRAME_MINIBUF_WINDOW(dsf)))))
939 static int frame_matches_frame_spec(Lisp_Object frame, Lisp_Object type)
941 struct frame *f = XFRAME(frame);
944 CHECK_LIVE_WINDOW(type);
946 if (EQ(FRAME_MINIBUF_WINDOW(f), type)
947 /* Check that F either is, or has forwarded
948 its focus to, TYPE's frame. */
949 && (EQ(WINDOW_FRAME(XWINDOW(type)), frame)
950 || EQ(WINDOW_FRAME(XWINDOW(type)),
951 FRAME_FOCUS_FRAME(f))))
957 if (EQ(type, Qvisible) || EQ(type, Qiconic) || EQ(type, Qvisible_iconic)
958 || EQ(type, Qvisible_nomini) || EQ(type, Qiconic_nomini)
959 || EQ(type, Qvisible_iconic_nomini))
960 FRAME_SAMPLE_VISIBILITY(f);
966 type = Qvisible_iconic;
968 if (EQ(type, Qvisible))
969 return FRAME_VISIBLE_P(f);
970 if (EQ(type, Qiconic))
971 return FRAME_ICONIFIED_P(f);
972 if (EQ(type, Qinvisible))
973 return !FRAME_VISIBLE_P(f) && !FRAME_ICONIFIED_P(f);
974 if (EQ(type, Qvisible_iconic))
975 return FRAME_VISIBLE_P(f) || FRAME_ICONIFIED_P(f);
976 if (EQ(type, Qinvisible_iconic))
977 return !FRAME_VISIBLE_P(f);
979 if (EQ(type, Qnomini))
980 return !FRAME_MINIBUF_ONLY_P(f);
981 if (EQ(type, Qvisible_nomini))
982 return FRAME_VISIBLE_P(f) && !FRAME_MINIBUF_ONLY_P(f);
983 if (EQ(type, Qiconic_nomini))
984 return FRAME_ICONIFIED_P(f) && !FRAME_MINIBUF_ONLY_P(f);
985 if (EQ(type, Qinvisible_nomini))
986 return !FRAME_VISIBLE_P(f) && !FRAME_ICONIFIED_P(f) &&
987 !FRAME_MINIBUF_ONLY_P(f);
988 if (EQ(type, Qvisible_iconic_nomini))
989 return ((FRAME_VISIBLE_P(f) || FRAME_ICONIFIED_P(f))
990 && !FRAME_MINIBUF_ONLY_P(f));
991 if (EQ(type, Qinvisible_iconic_nomini))
992 return !FRAME_VISIBLE_P(f) && !FRAME_MINIBUF_ONLY_P(f);
997 int device_matches_device_spec(Lisp_Object device, Lisp_Object device_spec)
999 if (EQ(device_spec, Qwindow_system))
1000 return DEVICE_WIN_P(XDEVICE(device));
1001 if (DEVICEP(device_spec))
1002 return EQ(device, device_spec);
1003 if (CONSOLEP(device_spec))
1004 return EQ(DEVICE_CONSOLE(XDEVICE(device)), device_spec);
1005 if (valid_console_type_p(device_spec))
1006 return EQ(DEVICE_TYPE(XDEVICE(device)), device_spec);
1010 /* Return the next frame in the frame list after FRAME.
1011 WHICH-FRAMES and WHICH-DEVICES control which frames and devices
1012 are considered; see `next-frame'. */
1015 next_frame(Lisp_Object frame, Lisp_Object which_frames,
1016 Lisp_Object which_devices)
1018 Lisp_Object first = Qnil;
1019 Lisp_Object devcons, concons;
1022 CHECK_LIVE_FRAME(frame);
1024 DEVICE_LOOP_NO_BREAK(devcons, concons) {
1025 Lisp_Object device = XCAR(devcons);
1026 Lisp_Object frmcons;
1028 if (!device_matches_device_spec(device, which_devices)) {
1029 if (EQ(device, FRAME_DEVICE(XFRAME(frame))))
1034 DEVICE_FRAME_LOOP(frmcons, XDEVICE(device)) {
1035 Lisp_Object f = XCAR(frmcons);
1038 if (frame_matches_frame_spec(f, which_frames))
1045 && frame_matches_frame_spec(f,
1054 /* We went through the whole frame list without finding a single
1055 acceptable frame. Return the original frame. */
1058 /* There were no acceptable frames in the list after FRAME; otherwise,
1059 we would have returned directly from the loop. Since FIRST is the last
1060 acceptable frame in the list, return it. */
1064 /* Return the previous frame in the frame list before FRAME.
1065 WHICH-FRAMES and WHICH-DEVICES control which frames and devices
1066 are considered; see `next-frame'. */
1069 previous_frame(Lisp_Object frame, Lisp_Object which_frames,
1070 Lisp_Object which_devices)
1072 Lisp_Object devcons, concons;
1073 Lisp_Object last = Qnil;
1075 CHECK_LIVE_FRAME(frame);
1077 DEVICE_LOOP_NO_BREAK(devcons, concons) {
1078 Lisp_Object device = XCAR(devcons);
1079 Lisp_Object frmcons;
1081 if (!device_matches_device_spec(device, which_devices)) {
1082 if (EQ(device, FRAME_DEVICE(XFRAME(frame)))
1088 DEVICE_FRAME_LOOP(frmcons, XDEVICE(device)) {
1089 Lisp_Object f = XCAR(frmcons);
1095 if (frame_matches_frame_spec(f, which_frames))
1102 /* We went through the whole frame list without finding a single
1103 acceptable frame. Return the original frame. */
1106 /* There were no acceptable frames in the list before FRAME; otherwise,
1107 we would have returned directly from the loop. Since LAST is the last
1108 acceptable frame in the list, return it. */
1112 DEFUN("next-frame", Fnext_frame, 0, 3, 0, /*
1113 Return the next frame of the right type in the frame list after FRAME.
1114 WHICH-FRAMES controls which frames are eligible to be returned; all
1115 others will be skipped. Note that if there is only one eligible
1116 frame, then `next-frame' called repeatedly will always return
1117 the same frame, and if there is no eligible frame, then FRAME is
1120 Possible values for WHICH-FRAMES are
1122 'visible Consider only frames that are visible.
1123 'iconic Consider only frames that are iconic.
1124 'invisible Consider only frames that are invisible
1125 (this is different from iconic).
1126 'visible-iconic Consider frames that are visible or iconic.
1127 'invisible-iconic Consider frames that are invisible or iconic.
1128 'nomini Consider all frames except minibuffer-only ones.
1129 'visible-nomini Like `visible' but omits minibuffer-only frames.
1130 'iconic-nomini Like `iconic' but omits minibuffer-only frames.
1131 'invisible-nomini Like `invisible' but omits minibuffer-only frames.
1132 'visible-iconic-nomini Like `visible-iconic' but omits minibuffer-only
1134 'invisible-iconic-nomini Like `invisible-iconic' but omits minibuffer-only
1136 any other value Consider all frames.
1138 If WHICH-FRAMES is omitted, 'nomini is used. A value for WHICH-FRAMES
1139 of 0 (a number) is treated like 'iconic, for backwards compatibility.
1141 If WHICH-FRAMES is a window, include only its own frame and any frame
1142 now using that window as the minibuffer.
1144 The optional third argument WHICH-DEVICES further clarifies on which
1145 devices to search for frames as specified by WHICH-FRAMES.
1146 If nil or omitted, search all devices on FRAME's console.
1147 If a device, only search that device.
1148 If a console, search all devices on that console.
1149 If a device type, search all devices of that type.
1150 If `window-system', search all window-system devices.
1151 Any other non-nil value means search all devices.
1153 (frame, which_frames, which_devices))
1155 XSETFRAME(frame, decode_frame(frame));
1157 return next_frame(frame, which_frames, which_devices);
1160 DEFUN("previous-frame", Fprevious_frame, 0, 3, 0, /*
1161 Return the next frame of the right type in the frame list after FRAME.
1162 WHICH-FRAMES controls which frames are eligible to be returned; all
1163 others will be skipped. Note that if there is only one eligible
1164 frame, then `previous-frame' called repeatedly will always return
1165 the same frame, and if there is no eligible frame, then FRAME is
1168 See `next-frame' for an explanation of the WHICH-FRAMES and WHICH-DEVICES
1171 (frame, which_frames, which_devices))
1173 XSETFRAME(frame, decode_frame(frame));
1175 return previous_frame(frame, which_frames, which_devices);
1178 /* Return any frame for which PREDICATE is non-zero, or return Qnil
1179 if there aren't any. */
1182 find_some_frame(int (*predicate) (Lisp_Object, void *), void *closure)
1184 Lisp_Object framecons, devcons, concons;
1186 FRAME_LOOP_NO_BREAK(framecons, devcons, concons) {
1187 Lisp_Object frame = XCAR(framecons);
1189 if ((predicate) (frame, closure))
1196 /* extern void free_line_insertion_deletion_costs (struct frame *f); */
1198 /* Return 1 if it is ok to delete frame F;
1199 0 if all frames aside from F are invisible.
1200 (Exception: if F is a stream frame, it's OK to delete if
1201 any other frames exist.) */
1203 int other_visible_frames(struct frame *f)
1207 XSETFRAME(frame, f);
1208 if (FRAME_STREAM_P(f))
1209 return !EQ(frame, next_frame(frame, Qt, Qt));
1210 return !EQ(frame, next_frame(frame, Qvisible_iconic_nomini, Qt));
1215 If FORCE is non-zero, allow deletion of the only frame.
1217 If CALLED_FROM_DELETE_DEVICE is non-zero, then, if
1218 deleting the last frame on a device, just delete it,
1219 instead of calling `delete-device'.
1221 If FROM_IO_ERROR is non-zero, then the frame is gone due
1222 to an I/O error. This affects what happens if we exit
1223 (we do an emergency exit instead of `save-buffers-kill-emacs'.)
1227 delete_frame_internal(struct frame *f, int force,
1228 int called_from_delete_device, int from_io_error)
1230 /* This function can GC */
1231 int minibuffer_selected;
1233 struct console *con;
1236 Lisp_Object console;
1237 struct gcpro gcpro1;
1239 /* OK to delete an already deleted frame. */
1240 if (!FRAME_LIVE_P(f))
1243 XSETFRAME(frame, f);
1246 device = FRAME_DEVICE(f);
1247 d = XDEVICE(device);
1248 console = DEVICE_CONSOLE(d);
1249 con = XCONSOLE(console);
1251 if (!called_from_delete_device
1252 && !DEVICE_IMPL_FLAG(d, XDEVIMPF_FRAMELESS_OK)) {
1253 /* If we're deleting the only non-minibuffer frame on the
1254 device, delete the device. */
1255 if (EQ(frame, next_frame(frame, Qnomini, FRAME_DEVICE(f)))) {
1256 delete_device_internal(d, force, 0, from_io_error);
1262 /* In FSF, delete-frame will not normally allow you to delete the
1263 last visible frame. This was too annoying, so we changed it to the
1264 only frame. However, this would let people shoot themselves by
1265 deleting all frames which were either visible or iconified and thus
1266 losing any way of communicating with the still running SXEmacs process.
1267 So we put it back. */
1268 if (!force && !allow_deletion_of_last_visible_frame &&
1269 !other_visible_frames(f))
1270 error("Attempt to delete the sole visible or iconified frame");
1272 /* Does this frame have a minibuffer, and is it the surrogate
1273 minibuffer for any other frame? */
1274 if (FRAME_HAS_MINIBUF_P(f)) {
1275 Lisp_Object frmcons, devcons, concons;
1277 FRAME_LOOP_NO_BREAK(frmcons, devcons, concons) {
1278 Lisp_Object this = XCAR(frmcons);
1280 if (!EQ(this, frame)
1281 && EQ(frame, (WINDOW_FRAME
1283 (FRAME_MINIBUF_WINDOW
1284 (XFRAME(this))))))) {
1285 /* We've found another frame whose minibuffer is on
1288 ("Attempt to delete a surrogate minibuffer frame",
1294 /* Test for popup frames hanging around. */
1295 /* Deletion of a parent frame with popups is deadly. */
1297 Lisp_Object frmcons, devcons, concons;
1299 FRAME_LOOP_NO_BREAK(frmcons, devcons, concons) {
1300 Lisp_Object this = XCAR(frmcons);
1302 if (!EQ(this, frame)) {
1303 struct device *devcons_d =
1304 XDEVICE(XCAR(devcons));
1307 DEVMETH_OR_GIVEN(devcons_d,
1309 (XFRAME(this)), Qnil)))
1310 /* We've found a popup frame whose parent is this frame. */
1312 ("Attempt to delete a frame with live popups",
1318 /* Before here, we haven't made any dangerous changes (just checked for
1319 error conditions). Now run the delete-frame-hook. Remember that
1320 user code there could do any number of dangerous things, including
1321 signalling an error. */
1323 va_run_hook_with_args(Qdelete_frame_hook, 1, frame);
1325 if (!FRAME_LIVE_P(f)) { /* Make sure the delete-frame-hook didn't *//* go ahead and delete anything. */
1330 /* Call the delete-device-hook and delete-console-hook now if
1331 appropriate, before we do any dangerous things -- they too could
1333 if (XINT(Flength(DEVICE_FRAME_LIST(d))) == 1) {
1334 va_run_hook_with_args(Qdelete_device_hook, 1, device);
1335 if (!FRAME_LIVE_P(f)) { /* Make sure the delete-device-hook didn't *//* go ahead and delete anything. */
1340 if (XINT(Flength(CONSOLE_DEVICE_LIST(con))) == 1) {
1341 va_run_hook_with_args(Qdelete_console_hook, 1, console);
1342 if (!FRAME_LIVE_P(f)) { /* Make sure the delete-console-hook didn't *//* go ahead and delete anything. */
1349 minibuffer_selected = EQ(minibuf_window, Fselected_window(Qnil));
1351 /* If we were focused on this frame, then we're not any more.
1352 Assume that we lost the focus; that way, the call to
1353 Fselect_frame() below won't end up making us explicitly
1354 focus on another frame, which is generally undesirable in
1355 a point-to-type world. If our mouse ends up sitting over
1356 another frame, we will receive a FocusIn event and end up
1357 making that frame the selected frame.
1359 #### This may not be an ideal solution in a click-to-type
1360 world (in that case, we might want to explicitly choose
1361 another frame to have the focus, rather than relying on
1362 the WM, which might focus on a frame in a different app
1363 or focus on nothing at all). But there's no easy way
1364 to detect which focus model we're running on, and the
1365 alternative is more heinous. */
1367 if (EQ(frame, DEVICE_FRAME_WITH_FOCUS_REAL(d)))
1368 DEVICE_FRAME_WITH_FOCUS_REAL(d) = Qnil;
1369 if (EQ(frame, DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS(d)))
1370 DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS(d) = Qnil;
1371 if (EQ(frame, DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS(d)))
1372 DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS(d) = Qnil;
1374 /* Don't allow the deleted frame to remain selected.
1375 Note that in the former scheme of things, this would
1376 have caused us to regain the focus. This no longer
1377 applies (see above); I think the new behavior is more
1378 logical. If someone disagrees, it can always be
1379 changed (or a new user variable can be introduced, ugh.) */
1380 if (EQ(frame, DEVICE_SELECTED_FRAME(d))) {
1383 /* If this is a popup frame, select its parent if possible.
1384 Otherwise, find another visible frame; if none, just take any frame.
1385 First try the same device, then the same console. */
1387 next = DEVMETH_OR_GIVEN(d, get_frame_parent, (f), Qnil);
1388 if (NILP(next) || EQ(next, frame)
1389 || !FRAME_LIVE_P(XFRAME(next)))
1390 next = next_frame(frame, Qvisible, device);
1391 if (NILP(next) || EQ(next, frame))
1392 next = next_frame(frame, Qvisible, console);
1393 if (NILP(next) || EQ(next, frame))
1394 next = next_frame(frame, Qvisible, Qt);
1395 if (NILP(next) || EQ(next, frame))
1396 next = next_frame(frame, Qt, device);
1397 if (NILP(next) || EQ(next, frame))
1398 next = next_frame(frame, Qt, console);
1399 if (NILP(next) || EQ(next, frame))
1400 next = next_frame(frame, Qt, Qt);
1402 /* if we haven't found another frame at this point
1403 then there aren't any. */
1404 if (NILP(next) || EQ(next, frame)) ;
1407 /* if this is the global selected frame, select another one. */
1408 if (EQ(frame, Fselected_frame(Qnil))) {
1409 Fselect_frame(next);
1413 * If the new frame we just selected is on a different
1414 * device then we still need to change DEVICE_SELECTED_FRAME(d)
1415 * to a live frame, if there are any left on this device.
1417 if (!EQ(device, FRAME_DEVICE(XFRAME(next)))) {
1418 Lisp_Object next_f =
1419 next_frame(frame, Qt, device);
1420 if (NILP(next_f) || EQ(next_f, frame))
1421 set_device_selected_frame(d, Qnil);
1423 set_device_selected_frame(d, next_f);
1424 } else if (!did_select)
1425 set_device_selected_frame(d, next);
1430 /* Don't allow minibuf_window to remain on a deleted frame. */
1431 if (EQ(f->minibuffer_window, minibuf_window)) {
1432 struct frame *sel_frame = selected_frame();
1433 Fset_window_buffer(sel_frame->minibuffer_window,
1434 XWINDOW(minibuf_window)->buffer, Qt);
1435 minibuf_window = sel_frame->minibuffer_window;
1437 /* If the dying minibuffer window was selected,
1438 select the new one. */
1439 if (minibuffer_selected)
1440 Fselect_window(minibuf_window, Qnil);
1443 /* After this point, no errors must be allowed to occur. */
1445 #ifdef HAVE_MENUBARS
1446 free_frame_menubars(f);
1448 #ifdef HAVE_SCROLLBARS
1449 free_frame_scrollbars(f);
1451 #ifdef HAVE_TOOLBARS
1452 free_frame_toolbars(f);
1454 free_frame_gutters(f);
1455 /* Unfortunately deleting the frame will also delete the parent of
1456 all of the subwindow instances current on the frame. I think this
1457 can lead to bad things when trying to finalize the
1458 instances. Thus we loop over all instance caches calling the
1459 finalize method for each instance. */
1460 free_frame_subwindow_instances(f);
1462 /* This must be done before the window and window_mirror structures
1463 are freed. The scrollbar information is attached to them. */
1464 MAYBE_FRAMEMETH(f, delete_frame, (f));
1466 /* Mark all the windows that used to be on FRAME as deleted, and then
1467 remove the reference to them. */
1468 delete_all_subwindows(XWINDOW(f->root_window));
1469 f->root_window = Qnil;
1471 /* clear out the cached glyph information */
1472 f->subwindow_instance_cache = Qnil;
1474 /* Remove the frame now from the list. This way, any events generated
1475 on this frame by the maneuvers below will disperse themselves. */
1477 /* This used to be Fdelq(), but that will cause a seg fault if the
1478 QUIT checker happens to get invoked, because the frame list is in
1479 an inconsistent state. */
1480 d->frame_list = delq_no_quit(frame, d->frame_list);
1481 RESET_CHANGED_SET_FLAGS;
1486 free_window_mirror(f->root_mirror);
1487 /* free_line_insertion_deletion_costs (f); */
1489 /* If we've deleted the last non-minibuf frame, then try to find
1491 if (EQ(frame, CONSOLE_LAST_NONMINIBUF_FRAME(con))) {
1492 Lisp_Object frmcons, devcons;
1494 set_console_last_nonminibuf_frame(con, Qnil);
1496 CONSOLE_FRAME_LOOP_NO_BREAK(frmcons, devcons, con) {
1497 Lisp_Object ecran = XCAR(frmcons);
1498 if (!FRAME_MINIBUF_ONLY_P(XFRAME(ecran))) {
1499 set_console_last_nonminibuf_frame(con, ecran);
1500 goto double_break_1;
1507 /* The following test is degenerate FALSE */
1508 if (called_from_delete_device < 0)
1509 /* then we're being called from delete-console, and we shouldn't
1510 try to find another default-minibuffer frame for the console.
1512 con->default_minibuffer_frame = Qnil;
1515 /* If we've deleted this console's default_minibuffer_frame, try to
1516 find another one. Prefer minibuffer-only frames, but also notice
1517 frames with other windows. */
1518 if (EQ(frame, con->default_minibuffer_frame)) {
1519 Lisp_Object frmcons, devcons;
1520 /* The last frame we saw with a minibuffer, minibuffer-only or not. */
1521 Lisp_Object frame_with_minibuf;
1522 /* Some frame we found on the same console, or nil if there are none. */
1523 Lisp_Object frame_on_same_console;
1525 frame_on_same_console = Qnil;
1526 frame_with_minibuf = Qnil;
1528 set_console_last_nonminibuf_frame(con, Qnil);
1530 CONSOLE_FRAME_LOOP_NO_BREAK(frmcons, devcons, con) {
1534 this = XCAR(frmcons);
1537 /* Consider only frames on the same console
1538 and only those with minibuffers. */
1539 if (FRAME_HAS_MINIBUF_P(f1)) {
1540 frame_with_minibuf = this;
1541 if (FRAME_MINIBUF_ONLY_P(f1))
1542 goto double_break_2;
1545 frame_on_same_console = this;
1549 if (!NILP(frame_on_same_console)) {
1550 /* We know that there must be some frame with a minibuffer out
1551 there. If this were not true, all of the frames present
1552 would have to be minibuffer-less, which implies that at some
1553 point their minibuffer frames must have been deleted, but
1554 that is prohibited at the top; you can't delete surrogate
1555 minibuffer frames. */
1556 if (NILP(frame_with_minibuf))
1559 con->default_minibuffer_frame = frame_with_minibuf;
1561 /* No frames left on this console--say no minibuffer either. */
1562 con->default_minibuffer_frame = Qnil;
1565 nuke_all_frame_slots(f); /* nobody should be accessing the device
1566 or anything else any more, and making
1567 them Qnil allows for better GC'ing
1568 in case a pointer to the dead frame
1569 continues to hang around. */
1570 f->framemeths = dead_console_methods;
1574 void io_error_delete_frame(Lisp_Object frame)
1576 delete_frame_internal(XFRAME(frame), 1, 0, 1);
1579 DEFUN("delete-frame", Fdelete_frame, 0, 2, "", /*
1580 Delete FRAME, permanently eliminating it from use.
1581 If omitted, FRAME defaults to the selected frame.
1582 A frame may not be deleted if its minibuffer is used by other frames.
1583 Normally, you cannot delete the last non-minibuffer-only frame (you must
1584 use `save-buffers-kill-emacs' or `kill-emacs'). However, if optional
1585 second argument FORCE is non-nil, you can delete the last frame. (This
1586 will automatically call `save-buffers-kill-emacs'.)
1590 /* This function can GC */
1594 f = selected_frame();
1595 XSETFRAME(frame, f);
1601 delete_frame_internal(f, !NILP(force), 0, 0);
1605 /* Return mouse position in character cell units. */
1608 mouse_pixel_position_1(struct device *d, Lisp_Object * frame, int *x, int *y)
1610 switch (DEVMETH_OR_GIVEN(d, get_mouse_position, (d, frame, x, y), -1)) {
1619 *frame = DEVICE_SELECTED_FRAME(d);
1623 abort(); /* method is incorrectly written */
1629 DEFUN("mouse-pixel-position", Fmouse_pixel_position, 0, 1, 0, /*
1630 Return a list (WINDOW X . Y) giving the current mouse window and position.
1631 The position is given in pixel units, where (0, 0) is the upper-left corner
1634 When the cursor is not over a window, the return value is a list (nil nil).
1636 DEVICE specifies the device on which to read the mouse position, and
1637 defaults to the selected device. If the device is a mouseless terminal
1638 or SXEmacs hasn't been programmed to read its mouse position, it returns
1639 the device's selected window for WINDOW and nil for X and Y.
1643 struct device *d = decode_device(device);
1645 Lisp_Object window = Qnil;
1646 Lisp_Object x = Qnil;
1647 Lisp_Object y = Qnil;
1650 if (mouse_pixel_position_1(d, &frame, &intx, &inty) > 0) {
1652 find_window_by_pixel_pos(intx, inty,
1653 XFRAME(frame)->root_window);
1655 XSETWINDOW(window, w);
1657 /* Adjust the position to be relative to the window. */
1658 intx -= w->pixel_left;
1659 inty -= w->pixel_top;
1663 } else if (FRAMEP(frame))
1664 window = FRAME_SELECTED_WINDOW(XFRAME(frame));
1666 return Fcons(window, Fcons(x, y));
1669 DEFUN("mouse-position", Fmouse_position, 0, 1, 0, /*
1670 Return a list (WINDOW X . Y) giving the current mouse window and position.
1671 The position is of a character under cursor, where (0, 0) is the upper-left
1672 corner of the window.
1674 When the cursor is not over a character, or not over a window, the return
1675 value is a list (nil nil).
1677 DEVICE specifies the device on which to read the mouse position, and
1678 defaults to the selected device. If the device is a mouseless terminal
1679 or Emacs hasn't been programmed to read its mouse position, it returns
1680 the device's selected window for WINDOW and nil for X and Y.
1684 struct device *d = decode_device(device);
1686 Lisp_Object frame, window = Qnil, lisp_x = Qnil, lisp_y = Qnil;
1687 int x, y, obj_x, obj_y;
1688 Bufpos bufpos, closest;
1689 Charcount modeline_closest;
1690 Lisp_Object obj1, obj2;
1692 if (mouse_pixel_position_1(d, &frame, &x, &y) > 0) {
1694 pixel_to_glyph_translation(XFRAME(frame), x, y, &x, &y,
1695 &obj_x, &obj_y, &w, &bufpos,
1696 &closest, &modeline_closest,
1698 if (res == OVER_TEXT) {
1699 lisp_x = make_int(x);
1700 lisp_y = make_int(y);
1701 XSETWINDOW(window, w);
1703 } else if (FRAMEP(frame))
1704 window = FRAME_SELECTED_WINDOW(XFRAME(frame));
1706 return Fcons(window, Fcons(lisp_x, lisp_y));
1709 DEFUN("mouse-position-as-motion-event", Fmouse_position_as_motion_event, 0, 1, 0, /*
1710 Return the current mouse position as a motion event.
1711 This allows you to call the standard event functions such as
1712 `event-over-toolbar-p' to determine where the mouse is.
1714 DEVICE specifies the device on which to read the mouse position, and
1715 defaults to the selected device. If the mouse position can't be determined
1716 \(e.g. DEVICE is a TTY device), nil is returned instead of an event.
1720 struct device *d = decode_device(device);
1724 if (mouse_pixel_position_1(d, &frame, &intx, &inty)) {
1725 Lisp_Object event = Fmake_event(Qnil, Qnil);
1726 XEVENT(event)->event_type = pointer_motion_event;
1727 XEVENT(event)->channel = frame;
1728 XEVENT(event)->event.motion.x = intx;
1729 XEVENT(event)->event.motion.y = inty;
1735 DEFUN("set-mouse-position", Fset_mouse_position, 3, 3, 0, /*
1736 Move the mouse pointer to the center of character cell (X,Y) in WINDOW.
1737 Note, this is a no-op for an X frame that is not visible.
1738 If you have just created a frame, you must wait for it to become visible
1739 before calling this function on it, like this.
1740 (while (not (frame-visible-p frame)) (sleep-for .5))
1741 Note also: Warping the mouse is contrary to the ICCCM, so be very sure
1742 that the behavior won't end up being obnoxious!
1749 CHECK_LIVE_WINDOW(window);
1753 /* Warping the mouse will cause EnterNotify and Focus events under X. */
1754 w = XWINDOW(window);
1755 glyph_to_pixel_translation(w, XINT(x), XINT(y), &pix_x, &pix_y);
1757 MAYBE_FRAMEMETH(XFRAME(w->frame), set_mouse_position,
1763 DEFUN("set-mouse-pixel-position", Fset_mouse_pixel_position, 3, 3, 0, /*
1764 Move the mouse pointer to pixel position (X,Y) in WINDOW.
1765 Note, this is a no-op for an X frame that is not visible.
1766 If you have just created a frame, you must wait for it to become visible
1767 before calling this function on it, like this.
1768 (while (not (frame-visible-p frame)) (sleep-for .5))
1774 CHECK_LIVE_WINDOW(window);
1778 /* Warping the mouse will cause EnterNotify and Focus events under X. */
1779 w = XWINDOW(window);
1780 FRAMEMETH(XFRAME(w->frame), set_mouse_position, (w, XINT(x), XINT(y)));
1785 DEFUN("make-frame-visible", Fmake_frame_visible, 0, 1, 0, /*
1786 Make the frame FRAME visible (assuming it is an X-window).
1787 If omitted, FRAME defaults to the currently selected frame.
1788 Also raises the frame so that nothing obscures it.
1792 struct frame *f = decode_frame(frame);
1794 MAYBE_FRAMEMETH(f, make_frame_visible, (f));
1798 DEFUN("make-frame-invisible", Fmake_frame_invisible, 0, 2, 0, /*
1799 Unconditionally removes frame from the display (assuming it is an X-window).
1800 If omitted, FRAME defaults to the currently selected frame.
1801 If what you want to do is iconify the frame (if the window manager uses
1802 icons) then you should call `iconify-frame' instead.
1803 Normally you may not make FRAME invisible if all other frames are invisible
1804 and uniconified, but if the second optional argument FORCE is non-nil,
1809 struct frame *f, *sel_frame;
1812 f = decode_frame(frame);
1813 d = XDEVICE(FRAME_DEVICE(f));
1814 sel_frame = XFRAME(DEVICE_SELECTED_FRAME(d));
1816 if (NILP(force) && !other_visible_frames(f))
1818 ("Attempt to make invisible the sole visible or iconified frame");
1820 /* Don't allow minibuf_window to remain on a deleted frame. */
1821 if (EQ(f->minibuffer_window, minibuf_window)) {
1822 Fset_window_buffer(sel_frame->minibuffer_window,
1823 XWINDOW(minibuf_window)->buffer, Qt);
1824 minibuf_window = sel_frame->minibuffer_window;
1827 MAYBE_FRAMEMETH(f, make_frame_invisible, (f));
1832 DEFUN("iconify-frame", Ficonify_frame, 0, 1, "", /*
1833 Make the frame FRAME into an icon, if the window manager supports icons.
1834 If omitted, FRAME defaults to the currently selected frame.
1838 struct frame *f, *sel_frame;
1841 f = decode_frame(frame);
1842 d = XDEVICE(FRAME_DEVICE(f));
1843 sel_frame = XFRAME(DEVICE_SELECTED_FRAME(d));
1845 /* Don't allow minibuf_window to remain on a deleted frame. */
1846 if (EQ(f->minibuffer_window, minibuf_window)) {
1847 Fset_window_buffer(sel_frame->minibuffer_window,
1848 XWINDOW(minibuf_window)->buffer, Qt);
1849 minibuf_window = sel_frame->minibuffer_window;
1852 MAYBE_FRAMEMETH(f, iconify_frame, (f));
1857 DEFUN("deiconify-frame", Fdeiconify_frame, 0, 1, 0, /*
1858 Open (de-iconify) the iconified frame FRAME.
1859 Under X, this is currently the same as `make-frame-visible'.
1860 If omitted, FRAME defaults to the currently selected frame.
1861 Also raises the frame so that nothing obscures it.
1865 return Fmake_frame_visible(frame);
1868 /* FSF returns 'icon for iconized frames. What a crock! */
1870 DEFUN("frame-visible-p", Fframe_visible_p, 0, 1, 0, /*
1871 Return non NIL if FRAME is now "visible" (actually in use for display).
1872 A frame that is not visible is not updated, and, if it works through a
1873 window system, may not show at all.
1874 N.B. Under X "visible" means Mapped. It the window is mapped but not
1875 actually visible on screen then `frame-visible-p' returns 'hidden.
1879 struct frame *f = decode_frame(frame);
1880 int visible = FRAMEMETH_OR_GIVEN(f, frame_visible_p, (f), f->visible);
1881 return visible ? (visible > 0 ? Qt : Qhidden) : Qnil;
1884 DEFUN("frame-totally-visible-p", Fframe_totally_visible_p, 0, 1, 0, /*
1885 Return t if frame is not obscured by any other window system windows.
1886 Always returns t for tty frames.
1890 struct frame *f = decode_frame(frame);
1891 return (FRAMEMETH_OR_GIVEN(f, frame_totally_visible_p, (f), f->visible)
1895 DEFUN("frame-iconified-p", Fframe_iconified_p, 0, 1, 0, /*
1896 Return t if FRAME is iconified.
1897 Not all window managers use icons; some merely unmap the window, so this
1898 function is not the inverse of `frame-visible-p'. It is possible for a
1899 frame to not be visible and not be iconified either. However, if the
1900 frame is iconified, it will not be visible.
1904 struct frame *f = decode_frame(frame);
1907 f->iconified = FRAMEMETH_OR_GIVEN(f, frame_iconified_p, (f), 0);
1908 return f->iconified ? Qt : Qnil;
1911 DEFUN("visible-frame-list", Fvisible_frame_list, 0, 1, 0, /*
1912 Return a list of all frames now "visible" (being updated).
1913 If DEVICE is specified only frames on that device will be returned.
1914 Note that under virtual window managers not all these frames are
1915 necessarily really updated.
1919 Lisp_Object devcons, concons;
1925 DEVICE_LOOP_NO_BREAK(devcons, concons) {
1926 assert(DEVICEP(XCAR(devcons)));
1928 if (NILP(device) || EQ(device, XCAR(devcons))) {
1929 Lisp_Object frmcons;
1931 DEVICE_FRAME_LOOP(frmcons, XDEVICE(XCAR(devcons))) {
1932 Lisp_Object frame = XCAR(frmcons);
1934 if (FRAME_VISIBLE_P(f))
1935 value = Fcons(frame, value);
1943 DEFUN("raise-frame", Fraise_frame, 0, 1, "", /*
1944 Bring FRAME to the front, so it occludes any frames it overlaps.
1945 If omitted, FRAME defaults to the currently selected frame.
1946 If FRAME is invisible, make it visible.
1947 If Emacs is displaying on an ordinary terminal or some other device which
1948 doesn't support multiple overlapping frames, this function does nothing.
1952 struct frame *f = decode_frame(frame);
1954 /* Do like the documentation says. */
1955 Fmake_frame_visible(frame);
1956 MAYBE_FRAMEMETH(f, raise_frame, (f));
1960 DEFUN("lower-frame", Flower_frame, 0, 1, "", /*
1961 Send FRAME to the back, so it is occluded by any frames that overlap it.
1962 If omitted, FRAME defaults to the currently selected frame.
1963 If Emacs is displaying on an ordinary terminal or some other device which
1964 doesn't support multiple overlapping frames, this function does nothing.
1968 struct frame *f = decode_frame(frame);
1970 MAYBE_FRAMEMETH(f, lower_frame, (f));
1974 DEFUN("disable-frame", Fdisable_frame, 1, 1, 0, /*
1975 Disable frame FRAME, so that it cannot have the focus or receive user input.
1976 This is normally used during modal dialog boxes.
1977 WARNING: Be very careful not to wedge SXEmacs!
1978 Use an `unwind-protect' that re-enables the frame to avoid this.
1982 struct frame *f = decode_frame(frame);
1985 MAYBE_FRAMEMETH(f, disable_frame, (f));
1989 DEFUN("enable-frame", Fenable_frame, 1, 1, 0, /*
1990 Enable frame FRAME, so that it can have the focus and receive user input.
1991 Frames are normally enabled, unless explicitly disabled using `disable-frame'.
1995 struct frame *f = decode_frame(frame);
1997 MAYBE_FRAMEMETH(f, enable_frame, (f));
2001 /* Ben thinks there is no need for `redirect-frame-focus' or `frame-focus',
2002 crockish FSFmacs functions. See summary on focus in event-stream.c. */
2004 DEFUN("print-job-page-number", Fprint_job_page_number, 1, 1, 0, /*
2005 Return current page number for the print job FRAME.
2009 CHECK_PRINTER_FRAME(frame);
2010 return make_int(FRAME_PAGENUMBER(XFRAME(frame)));
2013 DEFUN("print-job-eject-page", Fprint_job_eject_page, 1, 1, 0, /*
2014 Eject page in the print job FRAME.
2020 CHECK_PRINTER_FRAME(frame);
2022 FRAMEMETH(f, eject_page, (f));
2023 FRAME_SET_PAGENUMBER(f, 1 + FRAME_PAGENUMBER(f));
2029 /***************************************************************************/
2030 /* frame properties */
2031 /***************************************************************************/
2033 static void internal_set_frame_size(struct frame *f, int cols, int rows,
2036 static void store_minibuf_frame_prop(struct frame *f, Lisp_Object val)
2039 XSETFRAME(frame, f);
2042 if (!MINI_WINDOW_P(XWINDOW(val)))
2044 ("Surrogate minibuffer windows must be minibuffer windows",
2047 if (FRAME_HAS_MINIBUF_P(f) || FRAME_MINIBUF_ONLY_P(f))
2049 ("Can't change the surrogate minibuffer of a frame with its own minibuffer",
2052 /* Install the chosen minibuffer window, with proper buffer. */
2053 f->minibuffer_window = val;
2054 } else if (EQ(val, Qt)) {
2055 if (FRAME_HAS_MINIBUF_P(f) || FRAME_MINIBUF_ONLY_P(f))
2057 ("Frame already has its own minibuffer", frame);
2059 setup_normal_frame(f);
2060 f->mirror_dirty = 1;
2062 update_frame_window_mirror(f);
2063 internal_set_frame_size(f, f->width, f->height, 1);
2070 /* possible code if you want to have symbols such as `default-background'
2071 map to setting the background of `default', etc. */
2074 dissect_as_face_setting(Lisp_Object sym, Lisp_Object * face_out,
2075 Lisp_Object * face_prop_out)
2077 Lisp_Object list = Vbuilt_in_face_specifiers;
2083 s = symbol_name(XSYMBOL(sym));
2085 while (!NILP(list)) {
2086 Lisp_Object prop = Fcar(list);
2087 Lisp_String *prop_name;
2091 prop_name = symbol_name(XSYMBOL(prop));
2092 if (string_length(s) > string_length(prop_name) + 1
2093 && !memcmp(string_data(prop_name),
2094 string_data(s) + string_length(s)
2095 - string_length(prop_name),
2096 string_length(prop_name))
2097 && string_data(s)[string_length(s) -
2098 string_length(prop_name)
2101 Ffind_face(make_string(string_data(s),
2103 - string_length(prop_name)
2107 *face_prop_out = prop;
2120 static Lisp_Object get_property_alias(Lisp_Object prop)
2123 Lisp_Object alias = Qnil;
2126 alias = Fget(prop, Qframe_property_alias, Qnil);
2136 /* #### Using this to modify the internal border width has no effect
2137 because the change isn't propagated to the windows. Are there
2138 other properties which this claims to handle, but doesn't?
2140 But of course. This stuff needs more work, but it's a lot closer
2141 to sanity now than before with the horrible frame-params stuff. */
2143 DEFUN("set-frame-properties", Fset_frame_properties, 2, 2, 0, /*
2144 Change some properties of a frame.
2145 PLIST is a property list.
2146 You can also change frame properties individually using `set-frame-property',
2147 but it may be more efficient to change many properties at once.
2149 Frame properties can be retrieved using `frame-property' or `frame-properties'.
2151 The following symbols etc. have predefined meanings:
2153 name Name of the frame. Used with X resources.
2154 Unchangeable after creation.
2156 height Height of the frame, in lines.
2158 width Width of the frame, in characters.
2160 minibuffer Gives the minibuffer behavior for this frame. Either
2161 t (frame has its own minibuffer), `only' (frame is
2162 a minibuffer-only frame), `none' (frame has no minibuffer)
2163 or a window (frame uses that window, which is on another
2164 frame, as the minibuffer).
2166 unsplittable If non-nil, frame cannot be split by `display-buffer'.
2168 current-display-table, menubar-visible-p, left-margin-width,
2169 right-margin-width, minimum-line-ascent, minimum-line-descent,
2170 use-left-overflow, use-right-overflow, scrollbar-width, scrollbar-height,
2171 default-toolbar, top-toolbar, bottom-toolbar, left-toolbar, right-toolbar,
2172 default-toolbar-height, default-toolbar-width, top-toolbar-height,
2173 bottom-toolbar-height, left-toolbar-width, right-toolbar-width,
2174 default-toolbar-visible-p, top-toolbar-visible-p, bottom-toolbar-visible-p,
2175 left-toolbar-visible-p, right-toolbar-visible-p, toolbar-buttons-captioned-p,
2176 top-toolbar-border-width, bottom-toolbar-border-width,
2177 left-toolbar-border-width, right-toolbar-border-width,
2178 modeline-shadow-thickness, has-modeline-p,
2179 default-gutter, top-gutter, bottom-gutter, left-gutter, right-gutter,
2180 default-gutter-height, default-gutter-width, top-gutter-height,
2181 bottom-gutter-height, left-gutter-width, right-gutter-width,
2182 default-gutter-visible-p, top-gutter-visible-p, bottom-gutter-visible-p,
2183 left-gutter-visible-p, right-gutter-visible-p, top-gutter-border-width,
2184 bottom-gutter-border-width, left-gutter-border-width, right-gutter-border-width,
2185 [Giving the name of any built-in specifier variable is
2186 equivalent to calling `set-specifier' on the specifier,
2187 with a locale of FRAME. Giving the name to `frame-property'
2188 calls `specifier-instance' on the specifier.]
2190 text-pointer-glyph, nontext-pointer-glyph, modeline-pointer-glyph,
2191 selection-pointer-glyph, busy-pointer-glyph, toolbar-pointer-glyph,
2192 menubar-pointer-glyph, scrollbar-pointer-glyph, gc-pointer-glyph,
2193 octal-escape-glyph, control-arrow-glyph, invisible-text-glyph,
2194 hscroll-glyph, truncation-glyph, continuation-glyph
2195 [Giving the name of any glyph variable is equivalent to
2196 calling `set-glyph-image' on the glyph, with a locale
2197 of FRAME. Giving the name to `frame-property' calls
2198 `glyph-image-instance' on the glyph.]
2200 [default foreground], [default background], [default font],
2201 [modeline foreground], [modeline background], [modeline font],
2203 [Giving a vector of a face and a property is equivalent
2204 to calling `set-face-property' on the face and property,
2205 with a locale of FRAME. Giving the vector to
2206 `frame-property' calls `face-property-instance' on the
2209 Finally, if a frame property symbol has the property `frame-property-alias'
2210 on it, then the value will be used in place of that symbol when looking
2211 up and setting frame property values. This allows you to alias one
2212 frame property name to another.
2214 See the variables `default-x-frame-plist', `default-tty-frame-plist'
2215 and `default-mswindows-frame-plist' for a description of the properties
2216 recognized for particular types of frames.
2220 struct frame *f = decode_frame(frame);
2223 struct gcpro gcpro1, gcpro2;
2225 XSETFRAME(frame, f);
2226 GCPRO2(frame, plist);
2227 Fcheck_valid_plist(plist);
2228 plist = Fcopy_sequence(plist);
2229 Fcanonicalize_lax_plist(plist, Qnil);
2230 for (tail = plist; !NILP(tail); tail = Fcdr(Fcdr(tail))) {
2231 Lisp_Object prop = Fcar(tail);
2232 Lisp_Object val = Fcar(Fcdr(tail));
2234 prop = get_property_alias(prop);
2237 /* mly wants this, but it's not reasonable to change the name of a
2238 frame after it has been created, because the old name was used
2239 for resource lookup. */
2240 if (EQ(prop, Qname)) {
2245 if (EQ(prop, Qminibuffer))
2246 store_minibuf_frame_prop(f, val);
2247 if (EQ(prop, Qunsplittable))
2248 f->no_split = !NILP(val);
2249 if (EQ(prop, Qbuffer_predicate))
2250 f->buffer_predicate = val;
2251 if (SYMBOLP(prop) && EQ(Fbuilt_in_variable_type(prop),
2253 call3(Qset_specifier, Fsymbol_value(prop), val, frame);
2255 && !NILP(Fget(prop, Qconst_glyph_variable, Qnil)))
2256 call3(Qset_glyph_image, Fsymbol_value(prop), val,
2258 if (VECTORP(prop) && XVECTOR_LENGTH(prop) == 2) {
2259 Lisp_Object face_prop = XVECTOR_DATA(prop)[1];
2260 CHECK_SYMBOL(face_prop);
2261 call4(Qset_face_property,
2262 Fget_face(XVECTOR_DATA(prop)[0]),
2263 face_prop, val, frame);
2267 MAYBE_FRAMEMETH(f, set_frame_properties, (f, plist));
2268 for (tailp = &plist; !NILP(*tailp);) {
2269 Lisp_Object *next_tailp;
2273 next = Fcdr(*tailp);
2275 next_tailp = &XCDR(next);
2276 prop = Fcar(*tailp);
2278 prop = get_property_alias(prop);
2280 if (EQ(prop, Qminibuffer)
2281 || EQ(prop, Qunsplittable)
2282 || EQ(prop, Qbuffer_predicate)
2283 || EQ(prop, Qheight)
2285 || (SYMBOLP(prop) && EQ(Fbuilt_in_variable_type(prop),
2287 || (SYMBOLP(prop) && !NILP(Fget(prop, Qconst_glyph_variable,
2289 || (VECTORP(prop) && XVECTOR_LENGTH(prop) == 2)
2290 || FRAMEMETH_OR_GIVEN(f, internal_frame_property_p,
2292 *tailp = *next_tailp;
2296 f->plist = nconc2(plist, f->plist);
2297 Fcanonicalize_lax_plist(f->plist, Qnil);
2302 DEFUN("frame-property", Fframe_property, 2, 3, 0, /*
2303 Return FRAME's value for property PROPERTY.
2304 Return DEFAULT if there is no such property.
2305 See `set-frame-properties' for the built-in property names.
2307 (frame, property, default_))
2309 struct frame *f = decode_frame(frame);
2312 XSETFRAME(frame, f);
2314 property = get_property_alias(property);
2316 if (EQ(Qname, property))
2319 if (EQ(Qheight, property) || EQ(Qwidth, property)) {
2320 if (window_system_pixelated_geometry(frame)) {
2322 pixel_to_real_char_size(f, FRAME_PIXWIDTH(f),
2323 FRAME_PIXHEIGHT(f), &width,
2325 return make_int(EQ(Qheight, property) ? height : width);
2327 return make_int(EQ(Qheight, property) ?
2328 FRAME_HEIGHT(f) : FRAME_WIDTH(f));
2331 /* NOTE: FSF returns Qnil instead of Qt for FRAME_HAS_MINIBUF_P.
2332 This is over-the-top bogosity, because it's inconsistent with
2333 the semantics of `minibuffer' when passed to `make-frame'.
2334 Returning Qt makes things consistent. */
2335 if (EQ(Qminibuffer, property))
2336 return (FRAME_MINIBUF_ONLY_P(f) ? Qonly :
2337 FRAME_HAS_MINIBUF_P(f) ? Qt : FRAME_MINIBUF_WINDOW(f));
2338 if (EQ(Qunsplittable, property))
2339 return FRAME_NO_SPLIT_P(f) ? Qt : Qnil;
2340 if (EQ(Qbuffer_predicate, property))
2341 return f->buffer_predicate;
2343 if (SYMBOLP(property)) {
2344 if (EQ(Fbuilt_in_variable_type(property), Qconst_specifier))
2345 return Fspecifier_instance(Fsymbol_value(property),
2346 frame, default_, Qnil);
2347 if (!NILP(Fget(property, Qconst_glyph_variable, Qnil))) {
2348 Lisp_Object glyph = Fsymbol_value(property);
2350 return Fspecifier_instance(XGLYPH_IMAGE(glyph),
2351 frame, default_, Qnil);
2355 if (VECTORP(property) && XVECTOR_LENGTH(property) == 2) {
2356 Lisp_Object face_prop = XVECTOR_DATA(property)[1];
2357 CHECK_SYMBOL(face_prop);
2358 return call3(Qface_property_instance,
2359 Fget_face(XVECTOR_DATA(property)[0]),
2363 if (HAS_FRAMEMETH_P(f, frame_property))
2365 (value = FRAMEMETH(f, frame_property, (f, property))))
2369 (value = external_plist_get(&f->plist, property, 1, ERROR_ME)))
2375 DEFUN("frame-properties", Fframe_properties, 0, 1, 0, /*
2376 Return a property list of the properties of FRAME.
2377 Do not modify this list; use `set-frame-property' instead.
2381 struct frame *f = decode_frame(frame);
2382 Lisp_Object result = Qnil;
2383 struct gcpro gcpro1;
2387 XSETFRAME(frame, f);
2389 /* #### for the moment (since old code uses `frame-parameters'),
2390 we call `copy-sequence' on f->plist. That allows frame-parameters
2391 to destructively convert the plist into an alist, which is more
2392 efficient than doing it non-destructively. At some point we
2393 should remove the call to copy-sequence. */
2394 result = Fcopy_sequence(f->plist);
2396 /* #### should we be adding all the specifiers and glyphs?
2397 That would entail having a list of them all. */
2398 if (HAS_FRAMEMETH_P(f, frame_properties))
2399 result = nconc2(FRAMEMETH(f, frame_properties, (f)), result);
2401 if (!NILP(f->buffer_predicate))
2402 result = cons3(Qbuffer_predicate, f->buffer_predicate, result);
2404 if (FRAME_NO_SPLIT_P(f))
2405 result = cons3(Qunsplittable, Qt, result);
2407 /* NOTE: FSF returns Qnil instead of Qt for FRAME_HAS_MINIBUF_P.
2408 This is over-the-top bogosity, because it's inconsistent with
2409 the semantics of `minibuffer' when passed to `make-frame'.
2410 Returning Qt makes things consistent. */
2411 result = cons3(Qminibuffer,
2412 (FRAME_MINIBUF_ONLY_P(f) ? Qonly :
2413 FRAME_HAS_MINIBUF_P(f) ? Qt :
2414 FRAME_MINIBUF_WINDOW(f)), result);
2418 if (window_system_pixelated_geometry(frame)) {
2419 pixel_to_real_char_size(f, FRAME_PIXWIDTH(f),
2420 FRAME_PIXHEIGHT(f), &width,
2423 height = FRAME_HEIGHT(f);
2424 width = FRAME_WIDTH(f);
2426 result = cons3(Qwidth, make_int(width), result);
2427 result = cons3(Qheight, make_int(height), result);
2430 result = cons3(Qname, f->name, result);
2436 DEFUN("frame-pixel-height", Fframe_pixel_height, 0, 1, 0, /*
2437 Return the height in pixels of FRAME.
2441 return make_int(decode_frame(frame)->pixheight);
2444 DEFUN("frame-pixel-width", Fframe_pixel_width, 0, 1, 0, /*
2445 Return the width in pixels of FRAME.
2449 return make_int(decode_frame(frame)->pixwidth);
2452 DEFUN("frame-name", Fframe_name, 0, 1, 0, /*
2453 Return the name of FRAME (defaulting to the selected frame).
2454 This is not the same as the `title' of the frame.
2458 return decode_frame(frame)->name;
2461 DEFUN("frame-modified-tick", Fframe_modified_tick, 0, 1, 0, /*
2462 Return FRAME's tick counter, incremented for each change to the frame.
2463 Each frame has a tick counter which is incremented each time the frame
2464 is resized, a window is resized, added, or deleted, a face is changed,
2465 `set-window-buffer' or `select-window' is called on a window in the
2466 frame, the window-start of a window in the frame has changed, or
2467 anything else interesting has happened. It wraps around occasionally.
2468 No argument or nil as argument means use selected frame as FRAME.
2472 return make_int(decode_frame(frame)->modiff);
2476 internal_set_frame_size(struct frame *f, int cols, int rows, int pretend)
2478 /* An explicit size change cancels any pending frame size adjustment */
2479 CLEAR_FRAME_SIZE_SLIPPED(f);
2481 if (pretend || !HAS_FRAMEMETH_P(f, set_frame_size))
2482 change_frame_size(f, rows, cols, 0);
2484 FRAMEMETH(f, set_frame_size, (f, cols, rows));
2487 DEFUN("set-frame-height", Fset_frame_height, 2, 3, 0, /*
2488 Specify that the frame FRAME has LINES lines.
2489 Optional third arg non-nil means that redisplay should use LINES lines
2490 but that the idea of the actual height of the frame should not be changed.
2492 (frame, lines, pretend))
2494 struct frame *f = decode_frame(frame);
2496 XSETFRAME(frame, f);
2499 if (window_system_pixelated_geometry(frame)) {
2500 char_to_real_pixel_size(f, 0, XINT(lines), 0, &height);
2501 width = FRAME_PIXWIDTH(f);
2503 height = XINT(lines);
2504 width = FRAME_WIDTH(f);
2507 internal_set_frame_size(f, width, height, !NILP(pretend));
2511 DEFUN("set-frame-pixel-height", Fset_frame_pixel_height, 2, 3, 0, /*
2512 Specify that the frame FRAME is HEIGHT pixels tall.
2513 Optional third arg non-nil means that redisplay should be HEIGHT pixels tall
2514 but that the idea of the actual height of the frame should not be changed.
2516 (frame, height, pretend))
2518 struct frame *f = decode_frame(frame);
2520 XSETFRAME(frame, f);
2523 if (!window_system_pixelated_geometry(frame)) {
2524 int h = XINT(height);
2525 width = FRAME_WIDTH(f);
2526 /* Simply using pixel_to_real_char_size here is not good
2527 enough since we end up with a total frame size of HEIGHT
2528 rather than a displayable height of HEIGHT. */
2529 frame_conversion_internal(f, 2, 0, &h, 0, &pheight, 0);
2531 width = FRAME_PIXWIDTH(f);
2532 pheight = XINT(height);
2535 internal_set_frame_size(f, width, pheight, !NILP(pretend));
2539 DEFUN("set-frame-width", Fset_frame_width, 2, 3, 0, /*
2540 Specify that the frame FRAME has COLS columns.
2541 Optional third arg non-nil means that redisplay should use COLS columns
2542 but that the idea of the actual width of the frame should not be changed.
2544 (frame, cols, pretend))
2546 struct frame *f = decode_frame(frame);
2548 XSETFRAME(frame, f);
2551 if (window_system_pixelated_geometry(frame)) {
2552 char_to_real_pixel_size(f, XINT(cols), 0, &width, 0);
2553 height = FRAME_PIXHEIGHT(f);
2556 height = FRAME_HEIGHT(f);
2559 internal_set_frame_size(f, width, height, !NILP(pretend));
2563 DEFUN("set-frame-pixel-width", Fset_frame_pixel_width, 2, 3, 0, /*
2564 Specify that the frame FRAME is WIDTH pixels wide.
2565 Optional third arg non-nil means that redisplay should be WIDTH wide
2566 but that the idea of the actual height of the frame should not be changed.
2568 (frame, width, pretend))
2570 struct frame *f = decode_frame(frame);
2572 XSETFRAME(frame, f);
2575 if (!window_system_pixelated_geometry(frame)) {
2576 int w = XINT(width);
2577 height = FRAME_HEIGHT(f);
2578 /* Simply using pixel_to_real_char_size here is not good
2579 enough since we end up with a total frame size of WIDTH
2580 rather than a displayable height of WIDTH. */
2581 frame_conversion_internal(f, 2, &w, 0, &pwidth, 0, 0);
2583 height = FRAME_PIXHEIGHT(f);
2584 pwidth = XINT(width);
2587 internal_set_frame_size(f, pwidth, height, !NILP(pretend));
2591 DEFUN("set-frame-size", Fset_frame_size, 3, 4, 0, /*
2592 Set the size of FRAME to COLS by ROWS, measured in characters.
2593 Optional fourth arg non-nil means that redisplay should use COLS by ROWS
2594 but that the idea of the actual size of the frame should not be changed.
2596 (frame, cols, rows, pretend))
2598 struct frame *f = decode_frame(frame);
2600 XSETFRAME(frame, f);
2604 if (window_system_pixelated_geometry(frame))
2605 char_to_real_pixel_size(f, XINT(cols), XINT(rows), &width,
2608 height = XINT(rows);
2612 internal_set_frame_size(f, width, height, !NILP(pretend));
2616 DEFUN("set-frame-pixel-size", Fset_frame_pixel_size, 3, 4, 0, /*
2617 Set the size of FRAME to WIDTH by HEIGHT, measured in pixels.
2618 Optional fourth arg non-nil means that redisplay should use WIDTH by HEIGHT
2619 but that the idea of the actual size of the frame should not be changed.
2621 (frame, width, height, pretend))
2623 struct frame *f = decode_frame(frame);
2624 int pheight, pwidth;
2625 XSETFRAME(frame, f);
2629 if (!window_system_pixelated_geometry(frame)) {
2630 int w = XINT(width);
2631 int h = XINT(height);
2632 /* Simply using pixel_to_real_char_size here is not good enough
2633 since we end up with a total frame size of WIDTH x HEIGHT
2634 rather than a displayable height of WIDTH x HEIGHT. */
2635 frame_conversion_internal(f, 2, &w, &h, &pwidth, &pheight, 0);
2637 pheight = XINT(height);
2638 pwidth = XINT(width);
2641 internal_set_frame_size(f, pwidth, pheight, !NILP(pretend));
2645 DEFUN("set-frame-position", Fset_frame_position, 3, 3, 0, /*
2646 Set position of FRAME in pixels to XOFFSET by YOFFSET.
2647 This is actually the position of the upper left corner of the frame.
2648 Negative values for XOFFSET or YOFFSET are interpreted relative to
2649 the rightmost or bottommost possible position (that stays within the screen).
2651 (frame, xoffset, yoffset))
2653 struct frame *f = decode_frame(frame);
2657 MAYBE_FRAMEMETH(f, set_frame_position,
2658 (f, XINT(xoffset), XINT(yoffset)));
2663 /* Frame size conversion functions moved here from EmacsFrame.c
2664 because they're generic and really don't belong in that file.
2665 Function get_default_char_pixel_size() removed because it's
2666 exactly the same as default_face_height_and_width(). */
2668 frame_conversion_internal(struct frame *f, int pixel_to_char,
2669 int *pixel_width, int *pixel_height,
2670 int *char_width, int *char_height, int real_face)
2676 Lisp_Object frame, window;
2678 XSETFRAME(frame, f);
2680 default_face_height_and_width(frame, &cph, &cpw);
2682 default_face_height_and_width_1(frame, &cph, &cpw);
2684 window = FRAME_SELECTED_WINDOW(f);
2686 egw = max(glyph_width(Vcontinuation_glyph, window),
2687 glyph_width(Vtruncation_glyph, window));
2688 egw = max(egw, cpw);
2689 bdr = 2 * f->internal_border_width;
2691 FRAME_SCROLLBAR_WIDTH(f) + FRAME_THEORETICAL_LEFT_TOOLBAR_WIDTH(f) +
2692 FRAME_THEORETICAL_RIGHT_TOOLBAR_WIDTH(f) +
2693 2 * FRAME_THEORETICAL_LEFT_TOOLBAR_BORDER_WIDTH(f) +
2694 2 * FRAME_THEORETICAL_RIGHT_TOOLBAR_BORDER_WIDTH(f);
2696 FRAME_SCROLLBAR_HEIGHT(f) +
2697 FRAME_THEORETICAL_TOP_TOOLBAR_HEIGHT(f) +
2698 FRAME_THEORETICAL_BOTTOM_TOOLBAR_HEIGHT(f) +
2699 2 * FRAME_THEORETICAL_TOP_TOOLBAR_BORDER_WIDTH(f) +
2700 2 * FRAME_THEORETICAL_BOTTOM_TOOLBAR_BORDER_WIDTH(f);
2702 /* Convert to chars so that the displayable area is pixel_width x
2705 #### Consider rounding up to 0.5 characters to avoid adding too
2707 if (pixel_to_char > 1) {
2709 *char_width = ROUND_UP(*pixel_width, cpw) / cpw;
2711 *char_height = ROUND_UP(*pixel_height, cph) / cph;
2713 /* Convert to chars so that the total frame size is pixel_width x
2715 else if (pixel_to_char) {
2718 1 + ((*pixel_width - egw) - bdr - obw) / cpw;
2720 *char_height = (*pixel_height - bdr - obh) / cph;
2724 (*char_width - 1) * cpw + egw + bdr + obw;
2726 *pixel_height = *char_height * cph + bdr + obh;
2730 /* This takes the size in pixels of the text area, and returns the number
2731 of characters that will fit there, taking into account the internal
2732 border width, and the pixel width of the line terminator glyphs (which
2733 always count as one "character" wide, even if they are not the same size
2734 as the default character size of the default font). The frame scrollbar
2735 width and left and right toolbar widths are also subtracted out of the
2736 available width. The frame scrollbar height and top and bottom toolbar
2737 heights are subtracted out of the available height.
2739 Therefore the result is not necessarily a multiple of anything in
2742 pixel_to_char_size(struct frame *f, int pixel_width, int pixel_height,
2743 int *char_width, int *char_height)
2745 frame_conversion_internal(f, 1, &pixel_width, &pixel_height, char_width,
2749 /* Given a character size, this returns the minimum number of pixels
2750 necessary to display that many characters, taking into account the
2751 internal border width, scrollbar height and width, toolbar heights and
2752 widths and the size of the line terminator glyphs (assuming the line
2753 terminators take up exactly one character position).
2755 Therefore the result is not necessarily a multiple of anything in
2758 char_to_pixel_size(struct frame *f, int char_width, int char_height,
2759 int *pixel_width, int *pixel_height)
2761 frame_conversion_internal(f, 0, pixel_width, pixel_height, &char_width,
2765 /* Given a pixel size, rounds DOWN to the smallest size in pixels necessary
2766 to display the same number of characters as are displayable now.
2769 round_size_to_char(struct frame *f, int in_width, int in_height,
2770 int *out_width, int *out_height)
2774 pixel_to_char_size(f, in_width, in_height, &char_width, &char_height);
2775 char_to_pixel_size(f, char_width, char_height, out_width, out_height);
2778 /* Versions of the above which always account for real font metrics.
2781 pixel_to_real_char_size(struct frame *f, int pixel_width, int pixel_height,
2782 int *char_width, int *char_height)
2784 frame_conversion_internal(f, 1, &pixel_width, &pixel_height, char_width,
2789 char_to_real_pixel_size(struct frame *f, int char_width, int char_height,
2790 int *pixel_width, int *pixel_height)
2792 frame_conversion_internal(f, 0, pixel_width, pixel_height, &char_width,
2797 round_size_to_real_char(struct frame *f, int in_width, int in_height,
2798 int *out_width, int *out_height)
2802 pixel_to_real_char_size(f, in_width, in_height, &char_width,
2804 char_to_real_pixel_size(f, char_width, char_height, out_width,
2808 /* Change the frame height and/or width. Values may be given as zero to
2809 indicate no change is to take place. */
2810 static void change_frame_size_1(struct frame *f, int newheight, int newwidth)
2813 int new_pixheight, new_pixwidth;
2814 int font_height, real_font_height, font_width;
2816 /* #### Chuck -- shouldn't we be checking to see if the frame
2817 is being "changed" to its existing size, and do nothing if so? */
2818 /* No, because it would hose toolbar updates. The toolbar
2819 update code relies on this function to cause window `top' and
2820 `left' coordinates to be recomputed even though no frame size
2821 change occurs. --kyle */
2825 XSETFRAME(frame, f);
2827 default_face_height_and_width(frame, &real_font_height, 0);
2828 default_face_height_and_width_1(frame, &font_height, &font_width);
2830 /* This size-change overrides any pending one for this frame. */
2831 FRAME_NEW_HEIGHT(f) = 0;
2832 FRAME_NEW_WIDTH(f) = 0;
2834 new_pixheight = newheight * font_height;
2835 new_pixwidth = (newwidth - 1) * font_width;
2837 /* #### dependency on FRAME_WIN_P should be removed. */
2838 if (FRAME_WIN_P(f)) {
2839 new_pixheight += FRAME_SCROLLBAR_HEIGHT(f);
2840 new_pixwidth += FRAME_SCROLLBAR_WIDTH(f);
2843 /* when frame_conversion_internal() calculated the number of rows/cols
2844 in the frame, the theoretical toolbar sizes were subtracted out.
2845 The calculations below adjust for real toolbar height/width in
2846 frame, which may be different from frame spec, taking the above
2847 fact into account */
2848 new_pixheight += +FRAME_THEORETICAL_TOP_TOOLBAR_HEIGHT(f)
2849 + 2 * FRAME_THEORETICAL_TOP_TOOLBAR_BORDER_WIDTH(f)
2850 - FRAME_REAL_TOP_TOOLBAR_HEIGHT(f)
2851 - 2 * FRAME_REAL_TOP_TOOLBAR_BORDER_WIDTH(f);
2853 new_pixheight += +FRAME_THEORETICAL_BOTTOM_TOOLBAR_HEIGHT(f)
2854 + 2 * FRAME_THEORETICAL_BOTTOM_TOOLBAR_BORDER_WIDTH(f)
2855 - FRAME_REAL_BOTTOM_TOOLBAR_HEIGHT(f)
2856 - 2 * FRAME_REAL_BOTTOM_TOOLBAR_BORDER_WIDTH(f);
2858 new_pixwidth += +FRAME_THEORETICAL_LEFT_TOOLBAR_WIDTH(f)
2859 + 2 * FRAME_THEORETICAL_LEFT_TOOLBAR_BORDER_WIDTH(f)
2860 - FRAME_REAL_LEFT_TOOLBAR_WIDTH(f)
2861 - 2 * FRAME_REAL_LEFT_TOOLBAR_BORDER_WIDTH(f);
2863 new_pixwidth += +FRAME_THEORETICAL_RIGHT_TOOLBAR_WIDTH(f)
2864 + 2 * FRAME_THEORETICAL_RIGHT_TOOLBAR_BORDER_WIDTH(f)
2865 - FRAME_REAL_RIGHT_TOOLBAR_WIDTH(f)
2866 - 2 * FRAME_REAL_RIGHT_TOOLBAR_BORDER_WIDTH(f);
2868 /* Adjust the width for the end glyph which may be a different width
2869 than the default character width. */
2871 int adjustment, trunc_width, cont_width;
2873 trunc_width = glyph_width(Vtruncation_glyph,
2874 FRAME_SELECTED_WINDOW(f));
2875 cont_width = glyph_width(Vcontinuation_glyph,
2876 FRAME_SELECTED_WINDOW(f));
2877 adjustment = max(trunc_width, cont_width);
2878 adjustment = max(adjustment, font_width);
2880 new_pixwidth += adjustment;
2883 /* If we don't have valid values, exit. */
2884 if (!new_pixheight && !new_pixwidth)
2887 if (new_pixheight) {
2888 /* Adjust for gutters here so that we always get set
2890 new_pixheight -= (FRAME_TOP_GUTTER_BOUNDS(f)
2891 + FRAME_BOTTOM_GUTTER_BOUNDS(f));
2893 XWINDOW(FRAME_ROOT_WINDOW(f))->pixel_top
2894 = FRAME_TOP_BORDER_END(f) + FRAME_TOP_GUTTER_BOUNDS(f);
2896 if (FRAME_HAS_MINIBUF_P(f)
2897 && !FRAME_MINIBUF_ONLY_P(f))
2898 /* Frame has both root and minibuffer. */
2901 * Leave the minibuffer height the same if the frame has
2902 * been initialized, and the minibuffer height is tall
2903 * enough to display at least one line of text in the default
2904 * font, and the old minibuffer height is a multiple of the
2905 * default font height. This should cause the minibuffer
2906 * height to be recomputed on font changes but not for
2907 * other frame size changes, which seems reasonable.
2909 int old_minibuf_height =
2910 XWINDOW(FRAME_MINIBUF_WINDOW(f))->pixel_height;
2911 int minibuf_height =
2913 && (old_minibuf_height % real_font_height) ==
2914 0 ? max(old_minibuf_height,
2915 real_font_height) : real_font_height;
2916 set_window_pixheight(FRAME_ROOT_WINDOW(f),
2917 /* - font_height for minibuffer */
2918 new_pixheight - minibuf_height, 0);
2920 XWINDOW(FRAME_MINIBUF_WINDOW(f))->pixel_top =
2921 FRAME_TOP_BORDER_END(f) +
2922 FRAME_TOP_GUTTER_BOUNDS(f) +
2923 FRAME_BOTTOM_GUTTER_BOUNDS(f) +
2924 new_pixheight - minibuf_height;
2926 set_window_pixheight(FRAME_MINIBUF_WINDOW(f),
2929 /* Frame has just one top-level window. */
2930 set_window_pixheight(FRAME_ROOT_WINDOW(f),
2933 FRAME_HEIGHT(f) = newheight;
2935 f->pixheight = newheight;
2939 /* Adjust for gutters here so that we always get set
2941 new_pixwidth -= (FRAME_LEFT_GUTTER_BOUNDS(f)
2942 + FRAME_RIGHT_GUTTER_BOUNDS(f));
2944 XWINDOW(FRAME_ROOT_WINDOW(f))->pixel_left =
2945 FRAME_LEFT_BORDER_END(f) + FRAME_LEFT_GUTTER_BOUNDS(f);
2946 set_window_pixwidth(FRAME_ROOT_WINDOW(f), new_pixwidth, 0);
2948 if (FRAME_HAS_MINIBUF_P(f)) {
2949 XWINDOW(FRAME_MINIBUF_WINDOW(f))->pixel_left =
2950 FRAME_LEFT_BORDER_END(f) +
2951 FRAME_LEFT_GUTTER_BOUNDS(f);
2952 set_window_pixwidth(FRAME_MINIBUF_WINDOW(f),
2956 FRAME_WIDTH(f) = newwidth;
2958 f->pixwidth = newwidth;
2961 if (window_system_pixelated_geometry(frame))
2962 pixel_to_real_char_size(f, FRAME_PIXWIDTH(f),
2963 FRAME_PIXHEIGHT(f), &FRAME_CHARWIDTH(f),
2964 &FRAME_CHARHEIGHT(f));
2966 FRAME_CHARWIDTH(f) = FRAME_WIDTH(f);
2967 FRAME_CHARHEIGHT(f) = FRAME_HEIGHT(f);
2970 MARK_FRAME_TOOLBARS_CHANGED(f);
2971 MARK_FRAME_GUTTERS_CHANGED(f);
2972 MARK_FRAME_CHANGED(f);
2973 f->echo_area_garbaged = 1;
2976 void change_frame_size(struct frame *f, int newheight, int newwidth, int delay)
2978 /* sometimes we get passed a size that's too small (esp. when a
2979 client widget gets resized, since we have no control over this).
2981 check_frame_size(f, &newheight, &newwidth);
2983 /* Unconditionally mark that the frame has changed size. This is
2984 because many things need to know after the
2985 fact. f->size_change_pending will get reset below. The most that
2986 can happen is that we will cycle through redisplay once more
2988 MARK_FRAME_SIZE_CHANGED(f);
2990 if (delay || in_display || gc_in_progress) {
2991 f->new_width = newwidth;
2992 f->new_height = newheight;
2996 f->size_change_pending = 0;
2997 /* For TTY frames, it's like one, like all ...
2998 Can't have two TTY frames of different sizes on the same device. */
2999 if (FRAME_TTY_P(f)) {
3000 Lisp_Object frmcons;
3002 DEVICE_FRAME_LOOP(frmcons, XDEVICE(FRAME_DEVICE(f)))
3003 change_frame_size_1(XFRAME(XCAR(frmcons)), newheight,
3006 change_frame_size_1(f, newheight, newwidth);
3009 /* The caller is responsible for freeing the returned string. */
3010 static Bufbyte *generate_title_string(struct window *w, Lisp_Object format_str,
3011 face_index findex, int type)
3013 struct display_line *dl;
3014 struct display_block *db;
3017 dl = &title_string_display_line;
3018 db = get_display_block_from_line(dl, TEXT);
3019 Dynarr_reset(db->runes);
3021 generate_formatted_string_db(format_str, Qnil, w, dl, db, findex, 0,
3024 Dynarr_reset(title_string_emchar_dynarr);
3025 while (elt < Dynarr_length(db->runes)) {
3026 if (Dynarr_atp(db->runes, elt)->type == RUNE_CHAR)
3027 Dynarr_add(title_string_emchar_dynarr,
3028 Dynarr_atp(db->runes, elt)->object.chr.ch);
3033 convert_emchar_string_into_malloced_string
3034 (Dynarr_atp(title_string_emchar_dynarr, 0),
3035 Dynarr_length(title_string_emchar_dynarr), 0);
3038 void update_frame_title(struct frame *f)
3040 struct window *w = XWINDOW(FRAME_SELECTED_WINDOW(f));
3041 Lisp_Object title_format;
3042 Lisp_Object icon_format;
3045 /* We don't change the title for the minibuffer unless the frame
3046 only has a minibuffer. */
3047 if (MINI_WINDOW_P(w) && !FRAME_MINIBUF_ONLY_P(f))
3050 /* And we don't want dead buffers to blow up on us. */
3051 if (!BUFFER_LIVE_P(XBUFFER(w->buffer)))
3055 title_format = symbol_value_in_buffer(Qframe_title_format, w->buffer);
3057 symbol_value_in_buffer(Qframe_icon_title_format, w->buffer);
3059 if (HAS_FRAMEMETH_P(f, set_title_from_bufbyte)) {
3060 title = generate_title_string(w, title_format,
3061 DEFAULT_INDEX, CURRENT_DISP);
3062 FRAMEMETH(f, set_title_from_bufbyte, (f, title));
3065 if (HAS_FRAMEMETH_P(f, set_icon_name_from_bufbyte)) {
3066 if (!EQ(icon_format, title_format) || !title) {
3070 title = generate_title_string(w, icon_format,
3074 FRAMEMETH(f, set_icon_name_from_bufbyte, (f, title));
3081 DEFUN("set-frame-pointer", Fset_frame_pointer, 2, 2, 0, /*
3082 Set the mouse pointer of FRAME to the given pointer image instance.
3083 You should not call this function directly. Instead, set one of
3084 the variables `text-pointer-glyph', `nontext-pointer-glyph',
3085 `modeline-pointer-glyph', `selection-pointer-glyph',
3086 `busy-pointer-glyph', or `toolbar-pointer-glyph'.
3088 (frame, image_instance))
3090 struct frame *f = decode_frame(frame);
3091 CHECK_POINTER_IMAGE_INSTANCE(image_instance);
3092 if (!EQ(f->pointer, image_instance)) {
3093 f->pointer = image_instance;
3094 MAYBE_FRAMEMETH(f, set_frame_pointer, (f));
3099 void update_frame_icon(struct frame *f)
3101 if (f->icon_changed || f->windows_changed) {
3103 Lisp_Object new_icon;
3105 XSETFRAME(frame, f);
3106 new_icon = glyph_image_instance(Vframe_icon_glyph, frame,
3108 if (!EQ(new_icon, f->icon)) {
3110 MAYBE_FRAMEMETH(f, set_frame_icon, (f));
3114 f->icon_changed = 0;
3118 icon_glyph_changed(Lisp_Object glyph, Lisp_Object property, Lisp_Object locale)
3123 /***************************************************************************/
3125 /* initialization */
3127 /***************************************************************************/
3129 void init_frame(void)
3135 title_string_emchar_dynarr = Dynarr_new(Emchar);
3136 xzero(title_string_display_line);
3140 void syms_of_frame(void)
3142 INIT_LRECORD_IMPLEMENTATION(frame);
3144 defsymbol(&Qdelete_frame_hook, "delete-frame-hook");
3145 defsymbol(&Qselect_frame_hook, "select-frame-hook");
3146 defsymbol(&Qdeselect_frame_hook, "deselect-frame-hook");
3147 defsymbol(&Qcreate_frame_hook, "create-frame-hook");
3148 defsymbol(&Qcustom_initialize_frame, "custom-initialize-frame");
3149 defsymbol(&Qmouse_enter_frame_hook, "mouse-enter-frame-hook");
3150 defsymbol(&Qmouse_leave_frame_hook, "mouse-leave-frame-hook");
3151 defsymbol(&Qmap_frame_hook, "map-frame-hook");
3152 defsymbol(&Qunmap_frame_hook, "unmap-frame-hook");
3154 defsymbol(&Qframep, "framep");
3155 defsymbol(&Qframe_live_p, "frame-live-p");
3156 defsymbol(&Qdelete_frame, "delete-frame");
3157 defsymbol(&Qsynchronize_minibuffers, "synchronize-minibuffers");
3158 defsymbol(&Qbuffer_predicate, "buffer-predicate");
3159 defsymbol(&Qframe_being_created, "frame-being-created");
3160 defsymbol(&Qmake_initial_minibuffer_frame,
3161 "make-initial-minibuffer-frame");
3163 defsymbol(&Qframe_title_format, "frame-title-format");
3164 defsymbol(&Qframe_icon_title_format, "frame-icon-title-format");
3166 defsymbol(&Qhidden, "hidden");
3167 defsymbol(&Qvisible, "visible");
3168 defsymbol(&Qiconic, "iconic");
3169 defsymbol(&Qinvisible, "invisible");
3170 defsymbol(&Qvisible_iconic, "visible-iconic");
3171 defsymbol(&Qinvisible_iconic, "invisible-iconic");
3172 defsymbol(&Qnomini, "nomini");
3173 defsymbol(&Qvisible_nomini, "visible-nomini");
3174 defsymbol(&Qiconic_nomini, "iconic-nomini");
3175 defsymbol(&Qinvisible_nomini, "invisible-nomini");
3176 defsymbol(&Qvisible_iconic_nomini, "visible-iconic-nomini");
3177 defsymbol(&Qinvisible_iconic_nomini, "invisible-iconic-nomini");
3179 defsymbol(&Qminibuffer, "minibuffer");
3180 defsymbol(&Qunsplittable, "unsplittable");
3181 defsymbol(&Qinternal_border_width, "internal-border-width");
3182 defsymbol(&Qtop_toolbar_shadow_color, "top-toolbar-shadow-color");
3183 defsymbol(&Qbottom_toolbar_shadow_color, "bottom-toolbar-shadow-color");
3184 defsymbol(&Qbackground_toolbar_color, "background-toolbar-color");
3185 defsymbol(&Qtop_toolbar_shadow_pixmap, "top-toolbar-shadow-pixmap");
3186 defsymbol(&Qbottom_toolbar_shadow_pixmap,
3187 "bottom-toolbar-shadow-pixmap");
3188 defsymbol(&Qtoolbar_shadow_thickness, "toolbar-shadow-thickness");
3189 defsymbol(&Qscrollbar_placement, "scrollbar-placement");
3190 defsymbol(&Qinter_line_space, "inter-line-space");
3191 /* Qiconic already in this function. */
3192 defsymbol(&Qvisual_bell, "visual-bell");
3193 defsymbol(&Qbell_volume, "bell-volume");
3194 defsymbol(&Qpointer_background, "pointer-background");
3195 defsymbol(&Qpointer_color, "pointer-color");
3196 defsymbol(&Qtext_pointer, "text-pointer");
3197 defsymbol(&Qspace_pointer, "space-pointer");
3198 defsymbol(&Qmodeline_pointer, "modeline-pointer");
3199 defsymbol(&Qgc_pointer, "gc-pointer");
3200 defsymbol(&Qinitially_unmapped, "initially-unmapped");
3201 defsymbol(&Quse_backing_store, "use-backing-store");
3202 defsymbol(&Qborder_color, "border-color");
3203 defsymbol(&Qborder_width, "border-width");
3204 /* Qwidth, Qheight, Qleft, Qtop in general.c */
3205 defsymbol(&Qset_specifier, "set-specifier");
3206 defsymbol(&Qset_face_property, "set-face-property");
3207 defsymbol(&Qface_property_instance, "face-property-instance");
3208 defsymbol(&Qframe_property_alias, "frame-property-alias");
3210 DEFSUBR(Fmake_frame);
3212 DEFSUBR(Fframe_live_p);
3214 DEFSUBR(Fignore_event);
3216 DEFSUBR(Ffocus_frame);
3217 DEFSUBR(Fselect_frame);
3218 DEFSUBR(Fselected_frame);
3219 DEFSUBR(Factive_minibuffer_window);
3220 DEFSUBR(Flast_nonminibuf_frame);
3221 DEFSUBR(Fframe_root_window);
3222 DEFSUBR(Fframe_selected_window);
3223 DEFSUBR(Fset_frame_selected_window);
3224 DEFSUBR(Fframe_device);
3225 DEFSUBR(Fnext_frame);
3226 DEFSUBR(Fprevious_frame);
3227 DEFSUBR(Fdelete_frame);
3228 DEFSUBR(Fmouse_position);
3229 DEFSUBR(Fmouse_pixel_position);
3230 DEFSUBR(Fmouse_position_as_motion_event);
3231 DEFSUBR(Fset_mouse_position);
3232 DEFSUBR(Fset_mouse_pixel_position);
3233 DEFSUBR(Fmake_frame_visible);
3234 DEFSUBR(Fmake_frame_invisible);
3235 DEFSUBR(Ficonify_frame);
3236 DEFSUBR(Fdeiconify_frame);
3237 DEFSUBR(Fframe_visible_p);
3238 DEFSUBR(Fframe_totally_visible_p);
3239 DEFSUBR(Fframe_iconified_p);
3240 DEFSUBR(Fvisible_frame_list);
3241 DEFSUBR(Fraise_frame);
3242 DEFSUBR(Flower_frame);
3243 DEFSUBR(Fdisable_frame);
3244 DEFSUBR(Fenable_frame);
3245 DEFSUBR(Fframe_property);
3246 DEFSUBR(Fframe_properties);
3247 DEFSUBR(Fset_frame_properties);
3248 DEFSUBR(Fframe_pixel_height);
3249 DEFSUBR(Fframe_pixel_width);
3250 DEFSUBR(Fframe_name);
3251 DEFSUBR(Fframe_modified_tick);
3252 DEFSUBR(Fset_frame_height);
3253 DEFSUBR(Fset_frame_width);
3254 DEFSUBR(Fset_frame_size);
3255 DEFSUBR(Fset_frame_pixel_height);
3256 DEFSUBR(Fset_frame_pixel_width);
3257 DEFSUBR(Fset_frame_pixel_size);
3258 DEFSUBR(Fset_frame_position);
3259 DEFSUBR(Fset_frame_pointer);
3260 DEFSUBR(Fprint_job_page_number);
3261 DEFSUBR(Fprint_job_eject_page);
3264 void vars_of_frame(void)
3267 Vframe_being_created = Qnil;
3268 staticpro(&Vframe_being_created);
3271 Fprovide(intern("cde"));
3274 #ifdef HAVE_OFFIX_DND
3275 Fprovide(intern("offix"));
3278 #if 0 /* FSFmacs stupidity */
3279 xxDEFVAR_LISP("emacs-iconified", &Vemacs_iconified /*
3280 Non-nil if all of emacs is iconified and frame updates are not needed.
3282 Vemacs_iconified = Qnil;
3285 DEFVAR_LISP("select-frame-hook", &Vselect_frame_hook /*
3286 Function or functions to run just after a new frame is given the focus.
3287 Note that calling `select-frame' does not necessarily set the focus:
3288 The actual window-system focus will not be changed until the next time
3289 that SXEmacs is waiting for an event, and even then, the window manager
3290 may refuse the focus-change request.
3292 Vselect_frame_hook = Qnil;
3294 DEFVAR_LISP("deselect-frame-hook", &Vdeselect_frame_hook /*
3295 Function or functions to run just before a frame loses the focus.
3296 See `select-frame-hook'.
3298 Vdeselect_frame_hook = Qnil;
3300 DEFVAR_LISP("delete-frame-hook", &Vdelete_frame_hook /*
3301 Function or functions to call when a frame is deleted.
3302 One argument, the about-to-be-deleted frame.
3304 Vdelete_frame_hook = Qnil;
3306 DEFVAR_LISP("create-frame-hook", &Vcreate_frame_hook /*
3307 Function or functions to call when a frame is created.
3308 One argument, the newly-created frame.
3310 Vcreate_frame_hook = Qnil;
3312 DEFVAR_LISP("mouse-enter-frame-hook", &Vmouse_enter_frame_hook /*
3313 Function or functions to call when the mouse enters a frame.
3314 One argument, the frame.
3315 Be careful not to make assumptions about the window manager's focus model.
3316 In most cases, the `deselect-frame-hook' is more appropriate.
3318 Vmouse_enter_frame_hook = Qnil;
3320 DEFVAR_LISP("mouse-leave-frame-hook", &Vmouse_leave_frame_hook /*
3321 Function or functions to call when the mouse leaves a frame.
3322 One argument, the frame.
3323 Be careful not to make assumptions about the window manager's focus model.
3324 In most cases, the `select-frame-hook' is more appropriate.
3326 Vmouse_leave_frame_hook = Qnil;
3328 DEFVAR_LISP("map-frame-hook", &Vmap_frame_hook /*
3329 Function or functions to call when a frame is mapped.
3330 One argument, the frame.
3332 Vmap_frame_hook = Qnil;
3334 DEFVAR_LISP("unmap-frame-hook", &Vunmap_frame_hook /*
3335 Function or functions to call when a frame is unmapped.
3336 One argument, the frame.
3338 Vunmap_frame_hook = Qnil;
3340 DEFVAR_BOOL("allow-deletion-of-last-visible-frame", &allow_deletion_of_last_visible_frame /*
3341 *Non-nil means to assume the force option to delete-frame.
3343 allow_deletion_of_last_visible_frame = 0;
3345 DEFVAR_LISP("adjust-frame-function", &Vadjust_frame_function /*
3346 Function or constant controlling adjustment of frame.
3347 When scrollbars, toolbars, default font etc. change in frame, the frame
3348 needs to be adjusted. The adjustment is controlled by this variable.
3350 nil to keep character frame size unchanged when possible (resize)
3351 t to keep pixel size unchanged (never resize)
3352 function symbol or lambda form. This function must return boolean
3353 value which is treated as above. Function is passed one parameter,
3354 the frame being adjusted. It function should not modify or delete
3357 Vadjust_frame_function = Qnil;
3359 DEFVAR_LISP("mouse-motion-handler", &Vmouse_motion_handler /*
3360 Handler for motion events. One arg, the event.
3361 For most applications, you should use `mode-motion-hook' instead of this.
3363 Vmouse_motion_handler = Qnil;
3365 DEFVAR_LISP("synchronize-minibuffers", &Vsynchronize_minibuffers /*
3366 Set to t if all minibuffer windows are to be synchronized.
3367 This will cause echo area messages to appear in the minibuffers of all
3370 Vsynchronize_minibuffers = Qnil;
3372 DEFVAR_LISP("frame-title-format", &Vframe_title_format /*
3373 Controls the title of the window-system window of the selected frame.
3374 This is the same format as `modeline-format' with the exception that
3377 /* #### I would change this unilaterally but for the wrath of the Kyles
3379 Vframe_title_format = build_string("%S: %b");
3381 DEFVAR_LISP("frame-icon-title-format", &Vframe_icon_title_format /*
3382 Controls the title of the icon corresponding to the selected frame.
3383 See also the variable `frame-title-format'.
3385 Vframe_icon_title_format = build_string("%b");
3387 DEFVAR_LISP("default-frame-name", &Vdefault_frame_name /*
3388 The default name to assign to newly-created frames.
3389 This can be overridden by arguments to `make-frame'. This must be a string.
3390 This is used primarily for picking up X resources, and is *not* the title
3391 of the frame. (See `frame-title-format'.)
3394 Vdefault_frame_name = build_string("SXEmacs");
3396 Vdefault_frame_name = build_string("InfoDock");
3399 DEFVAR_LISP("default-frame-plist", &Vdefault_frame_plist /*
3400 Plist of default values for frame creation, other than the first one.
3401 These may be set in your init file, like this:
3403 \(setq default-frame-plist '(width 80 height 55))
3405 Predefined properties are described in `set-frame-properties'.
3407 The properties may be in alist format for backward compatibility
3408 but you should not rely on this behavior.
3410 These override values given in window system configuration data,
3411 including X Windows' defaults database.
3413 Values for the first Emacs frame are taken from `initial-frame-plist'.
3414 Since the first X frame is created before loading your .emacs file, you
3415 may wish use the X resource database to avoid flashing.
3417 For values specific to the separate minibuffer frame, see
3418 `minibuffer-frame-plist'. See also the variables `default-x-frame-plist'
3419 and `default-tty-frame-plist', which are like `default-frame-plist'
3420 except that they apply only to X or tty frames, respectively \(whereas
3421 `default-frame-plist' applies to all types of frames).
3423 Vdefault_frame_plist = Qnil;
3425 DEFVAR_LISP("frame-icon-glyph", &Vframe_icon_glyph /*
3426 Icon glyph used to iconify a frame.
3430 void complex_vars_of_frame(void)
3432 Vframe_icon_glyph = allocate_glyph(GLYPH_ICON, icon_glyph_changed);