Clarify wording about functions' argument lists
[emacs.git] / src / frame.c
blob0a6ca26f5d7467004c99c4f3c97758a99a05d99e
1 /* Generic frame functions.
3 Copyright (C) 1993-1995, 1997, 1999-2018 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or (at
10 your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. */
20 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <errno.h>
25 #include <limits.h>
27 #include <c-ctype.h>
29 #include "lisp.h"
31 #ifdef HAVE_WINDOW_SYSTEM
32 #include TERM_HEADER
33 #endif /* HAVE_WINDOW_SYSTEM */
35 #include "buffer.h"
36 /* These help us bind and responding to switch-frame events. */
37 #include "keyboard.h"
38 #include "frame.h"
39 #include "blockinput.h"
40 #include "termchar.h"
41 #include "termhooks.h"
42 #include "dispextern.h"
43 #include "window.h"
44 #ifdef HAVE_WINDOW_SYSTEM
45 #include "fontset.h"
46 #endif
47 #include "cm.h"
48 #ifdef MSDOS
49 #include "msdos.h"
50 #include "dosfns.h"
51 #endif
52 #ifdef USE_X_TOOLKIT
53 #include "widget.h"
54 #endif
56 /* The currently selected frame. */
58 Lisp_Object selected_frame;
60 /* A frame which is not just a mini-buffer, or NULL if there are no such
61 frames. This is usually the most recent such frame that was selected. */
63 static struct frame *last_nonminibuf_frame;
65 /* False means there are no visible garbaged frames. */
66 bool frame_garbaged;
68 /* The default tool bar height for future frames. */
69 #if defined USE_GTK || defined HAVE_NS
70 enum { frame_default_tool_bar_height = 0 };
71 #else
72 int frame_default_tool_bar_height;
73 #endif
75 #ifdef HAVE_WINDOW_SYSTEM
76 static void x_report_frame_params (struct frame *, Lisp_Object *);
77 #endif
79 /* These setters are used only in this file, so they can be private. */
80 static void
81 fset_buffer_predicate (struct frame *f, Lisp_Object val)
83 f->buffer_predicate = val;
85 static void
86 fset_minibuffer_window (struct frame *f, Lisp_Object val)
88 f->minibuffer_window = val;
91 struct frame *
92 decode_live_frame (register Lisp_Object frame)
94 if (NILP (frame))
95 frame = selected_frame;
96 CHECK_LIVE_FRAME (frame);
97 return XFRAME (frame);
100 struct frame *
101 decode_any_frame (register Lisp_Object frame)
103 if (NILP (frame))
104 frame = selected_frame;
105 CHECK_FRAME (frame);
106 return XFRAME (frame);
109 #ifdef HAVE_WINDOW_SYSTEM
110 bool
111 display_available (void)
113 return x_display_list != NULL;
115 #endif
117 struct frame *
118 decode_window_system_frame (Lisp_Object frame)
120 struct frame *f = decode_live_frame (frame);
121 check_window_system (f);
122 #ifdef HAVE_WINDOW_SYSTEM
123 return f;
124 #endif
127 void
128 check_window_system (struct frame *f)
130 #ifdef HAVE_WINDOW_SYSTEM
131 if (window_system_available (f))
132 return;
133 #endif
134 error (f ? "Window system frame should be used"
135 : "Window system is not in use or not initialized");
138 /* Return the value of frame parameter PROP in frame FRAME. */
140 Lisp_Object
141 get_frame_param (register struct frame *frame, Lisp_Object prop)
143 register Lisp_Object tem;
145 tem = Fassq (prop, frame->param_alist);
146 if (EQ (tem, Qnil))
147 return tem;
148 return Fcdr (tem);
152 void
153 frame_size_history_add (struct frame *f, Lisp_Object fun_symbol,
154 int width, int height, Lisp_Object rest)
156 Lisp_Object frame;
158 XSETFRAME (frame, f);
159 if (CONSP (frame_size_history)
160 && INTEGERP (XCAR (frame_size_history))
161 && 0 < XINT (XCAR (frame_size_history)))
162 frame_size_history =
163 Fcons (make_number (XINT (XCAR (frame_size_history)) - 1),
164 Fcons (list4
165 (frame, fun_symbol,
166 ((width > 0)
167 ? list4 (make_number (FRAME_TEXT_WIDTH (f)),
168 make_number (FRAME_TEXT_HEIGHT (f)),
169 make_number (width),
170 make_number (height))
171 : Qnil),
172 rest),
173 XCDR (frame_size_history)));
177 /* Return 1 if `frame-inhibit-implied-resize' is non-nil or fullscreen
178 state of frame F would be affected by a vertical (horizontal if
179 HORIZONTAL is true) resize. PARAMETER is the symbol of the frame
180 parameter that is changed. */
181 bool
182 frame_inhibit_resize (struct frame *f, bool horizontal, Lisp_Object parameter)
184 Lisp_Object fullscreen = get_frame_param (f, Qfullscreen);
185 bool inhibit
186 = (f->after_make_frame
187 ? (EQ (frame_inhibit_implied_resize, Qt)
188 || (CONSP (frame_inhibit_implied_resize)
189 && !NILP (Fmemq (parameter, frame_inhibit_implied_resize)))
190 || (horizontal
191 && !EQ (fullscreen, Qnil) && !EQ (fullscreen, Qfullheight))
192 || (!horizontal
193 && !EQ (fullscreen, Qnil) && !EQ (fullscreen, Qfullwidth))
194 || FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
195 : ((horizontal && f->inhibit_horizontal_resize)
196 || (!horizontal && f->inhibit_vertical_resize)));
197 if (inhibit && !FRAME_TERMCAP_P (f) && !FRAME_MSDOS_P (f))
198 frame_size_history_add
199 (f, Qframe_inhibit_resize, 0, 0,
200 list5 (horizontal ? Qt : Qnil, parameter,
201 f->after_make_frame ? Qt : Qnil,
202 frame_inhibit_implied_resize,
203 fullscreen));
205 return inhibit;
208 static void
209 set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
211 int nlines;
212 int olines = FRAME_MENU_BAR_LINES (f);
214 /* Right now, menu bars don't work properly in minibuf-only frames;
215 most of the commands try to apply themselves to the minibuffer
216 frame itself, and get an error because you can't switch buffers
217 in or split the minibuffer window. */
218 if (FRAME_MINIBUF_ONLY_P (f))
219 return;
221 if (TYPE_RANGED_INTEGERP (int, value))
222 nlines = XINT (value);
223 else
224 nlines = 0;
226 if (nlines != olines)
228 windows_or_buffers_changed = 14;
229 FRAME_MENU_BAR_LINES (f) = nlines;
230 FRAME_MENU_BAR_HEIGHT (f) = nlines * FRAME_LINE_HEIGHT (f);
231 change_frame_size (f, FRAME_COLS (f),
232 FRAME_LINES (f) + olines - nlines,
233 0, 1, 0, 0);
237 Lisp_Object Vframe_list;
240 DEFUN ("framep", Fframep, Sframep, 1, 1, 0,
241 doc: /* Return non-nil if OBJECT is a frame.
242 Value is:
243 t for a termcap frame (a character-only terminal),
244 `x' for an Emacs frame that is really an X window,
245 `w32' for an Emacs frame that is a window on MS-Windows display,
246 `ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
247 `pc' for a direct-write MS-DOS frame.
248 See also `frame-live-p'. */)
249 (Lisp_Object object)
251 if (!FRAMEP (object))
252 return Qnil;
253 switch (XFRAME (object)->output_method)
255 case output_initial: /* The initial frame is like a termcap frame. */
256 case output_termcap:
257 return Qt;
258 case output_x_window:
259 return Qx;
260 case output_w32:
261 return Qw32;
262 case output_msdos_raw:
263 return Qpc;
264 case output_ns:
265 return Qns;
266 default:
267 emacs_abort ();
271 DEFUN ("frame-live-p", Fframe_live_p, Sframe_live_p, 1, 1, 0,
272 doc: /* Return non-nil if OBJECT is a frame which has not been deleted.
273 Value is nil if OBJECT is not a live frame. If object is a live
274 frame, the return value indicates what sort of terminal device it is
275 displayed on. See the documentation of `framep' for possible
276 return values. */)
277 (Lisp_Object object)
279 return ((FRAMEP (object)
280 && FRAME_LIVE_P (XFRAME (object)))
281 ? Fframep (object)
282 : Qnil);
285 DEFUN ("window-system", Fwindow_system, Swindow_system, 0, 1, 0,
286 doc: /* The name of the window system that FRAME is displaying through.
287 The value is a symbol:
288 nil for a termcap frame (a character-only terminal),
289 `x' for an Emacs frame that is really an X window,
290 `w32' for an Emacs frame that is a window on MS-Windows display,
291 `ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
292 `pc' for a direct-write MS-DOS frame.
294 FRAME defaults to the currently selected frame.
296 Use of this function as a predicate is deprecated. Instead,
297 use `display-graphic-p' or any of the other `display-*-p'
298 predicates which report frame's specific UI-related capabilities. */)
299 (Lisp_Object frame)
301 Lisp_Object type;
302 if (NILP (frame))
303 frame = selected_frame;
305 type = Fframep (frame);
307 if (NILP (type))
308 wrong_type_argument (Qframep, frame);
310 if (EQ (type, Qt))
311 return Qnil;
312 else
313 return type;
316 /* Placeholder used by temacs -nw before window.el is loaded. */
317 DEFUN ("frame-windows-min-size", Fframe_windows_min_size,
318 Sframe_windows_min_size, 4, 4, 0,
319 doc: /* */
320 attributes: const)
321 (Lisp_Object frame, Lisp_Object horizontal,
322 Lisp_Object ignore, Lisp_Object pixelwise)
324 return make_number (0);
328 * frame_windows_min_size:
330 * Return the minimum number of lines (columns if HORIZONTAL is non-nil)
331 * of FRAME. If PIXELWISE is non-nil, return the minimum inner height
332 * (width) of FRAME in pixels.
334 * This value is calculated by the function `frame-windows-min-size' in
335 * window.el unless the `min-height' (`min-width' if HORIZONTAL is
336 * non-nil) parameter of FRAME is non-nil thus explicitly specifying the
337 * value to be returned. In that latter case IGNORE is ignored.
339 * If `frame-windows-min-size' is called, it will make sure that the
340 * return value accommodates all windows of FRAME respecting the values
341 * of `window-min-height' (`window-min-width' if HORIZONTAL is non-nil).
342 * With IGNORE non-nil the values of these variables are ignored.
344 * In either case, never return a value less than 1. For TTY frames,
345 * additionally limit the minimum frame height to a value large enough
346 * to support the menu bar, the mode line, and the echo area.
348 static int
349 frame_windows_min_size (Lisp_Object frame, Lisp_Object horizontal,
350 Lisp_Object ignore, Lisp_Object pixelwise)
352 struct frame *f = XFRAME (frame);
353 Lisp_Object par_size;
354 int retval;
356 if ((!NILP (horizontal)
357 && NUMBERP (par_size = get_frame_param (f, Qmin_width)))
358 || (NILP (horizontal)
359 && NUMBERP (par_size = get_frame_param (f, Qmin_height))))
361 int min_size = XINT (par_size);
363 /* Don't allow phantom frames. */
364 if (min_size < 1)
365 min_size = 1;
367 retval = (NILP (pixelwise)
368 ? min_size
369 : min_size * (NILP (horizontal)
370 ? FRAME_LINE_HEIGHT (f)
371 : FRAME_COLUMN_WIDTH (f)));
373 else
374 retval = XINT (call4 (Qframe_windows_min_size, frame, horizontal,
375 ignore, pixelwise));
376 /* Don't allow too small height of text-mode frames, or else cm.c
377 might abort in cmcheckmagic. */
378 if ((FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f)) && NILP (horizontal))
380 int min_height = (FRAME_MENU_BAR_LINES (f)
381 + FRAME_WANTS_MODELINE_P (f)
382 + 2); /* one text line and one echo-area line */
383 if (retval < min_height)
384 retval = min_height;
387 return retval;
391 #ifdef HAVE_WINDOW_SYSTEM
393 * keep_ratio:
395 * Preserve ratios of frame F which usually happens after its parent
396 * frame P got resized. OLD_WIDTH, OLD_HEIGHT specifies the old native
397 * size of F's parent, NEW_WIDTH and NEW_HEIGHT its new size.
399 * Adjust F's width if F's 'keep_ratio' parameter is non-nil and, if
400 * it is a cons, its car is not 'height-only'. Adjust F's height if F's
401 * 'keep_ratio' parameter is non-nil and, if it is a cons, its car
402 * is not 'width-only'.
404 * Adjust F's left position if F's 'keep_ratio' parameter is non-nil
405 * and, if its is a cons, its cdr is non-nil and not 'top-only'. Adjust
406 * F's top position if F's 'keep_ratio' parameter is non-nil and, if
407 * its is a cons, its cdr is non-nil and not 'left-only'.
409 * Note that when positional adjustment is requested but the size of F
410 * should remain unaltered in the corresponding direction, this routine
411 * tries to constrain F to its parent frame - something which usually
412 * happens when the parent frame shrinks. This means, however, that
413 * when the parent frame is re-enlarged later, the child's original
414 * position will not get restored to its pre-shrinking value.
416 * This routine is currently useful for child frames only. It might be
417 * eventually useful when moving non-child frames between monitors with
418 * different resolutions.
420 static void
421 keep_ratio (struct frame *f, struct frame *p, int old_width, int old_height,
422 int new_width, int new_height)
424 Lisp_Object keep_ratio = get_frame_param (f, Qkeep_ratio);
427 if (!NILP (keep_ratio))
429 double width_factor = (double)new_width / (double)old_width;
430 double height_factor = (double)new_height / (double)old_height;
431 int pixel_width, pixel_height, pos_x, pos_y;
433 if (!CONSP (keep_ratio) || !NILP (Fcdr (keep_ratio)))
435 if (CONSP (keep_ratio) && EQ (Fcdr (keep_ratio), Qtop_only))
436 pos_x = f->left_pos;
437 else
439 pos_x = (int)(f->left_pos * width_factor + 0.5);
441 if (CONSP (keep_ratio)
442 && (NILP (Fcar (keep_ratio))
443 || EQ (Fcar (keep_ratio), Qheight_only))
444 && p->pixel_width - f->pixel_width < pos_x)
446 int p_f_width = p->pixel_width - f->pixel_width;
448 if (p_f_width <= 0)
449 pos_x = 0;
450 else
451 pos_x = (int)(p_f_width * width_factor * 0.5 + 0.5);
454 f->left_pos = pos_x;
457 if (CONSP (keep_ratio) && EQ (Fcdr (keep_ratio), Qleft_only))
458 pos_y = f->top_pos;
459 else
461 pos_y = (int)(f->top_pos * height_factor + 0.5);
463 if (CONSP (keep_ratio)
464 && (NILP (Fcar (keep_ratio))
465 || EQ (Fcar (keep_ratio), Qwidth_only))
466 && p->pixel_height - f->pixel_height < pos_y)
467 /* When positional adjustment was requested and the
468 width of F should remain unaltered, try to constrain
469 F to its parent. This means that when the parent
470 frame is enlarged later the child's original position
471 won't get restored. */
473 int p_f_height = p->pixel_height - f->pixel_height;
475 if (p_f_height <= 0)
476 pos_y = 0;
477 else
478 pos_y = (int)(p_f_height * height_factor * 0.5 + 0.5);
481 f->top_pos = pos_y;
484 x_set_offset (f, pos_x, pos_y, -1);
487 if (!CONSP (keep_ratio) || !NILP (Fcar (keep_ratio)))
489 if (CONSP (keep_ratio) && EQ (Fcar (keep_ratio), Qheight_only))
490 pixel_width = -1;
491 else
493 pixel_width = (int)(f->pixel_width * width_factor + 0.5);
494 pixel_width = FRAME_PIXEL_TO_TEXT_WIDTH (f, pixel_width);
497 if (CONSP (keep_ratio) && EQ (Fcar (keep_ratio), Qwidth_only))
498 pixel_height = -1;
499 else
501 pixel_height = (int)(f->pixel_height * height_factor + 0.5);
502 pixel_height = FRAME_PIXEL_TO_TEXT_HEIGHT (f, pixel_height);
505 adjust_frame_size (f, pixel_width, pixel_height, 1, 0,
506 Qkeep_ratio);
510 #endif
514 * adjust_frame_size:
516 * Adjust size of frame F. NEW_WIDTH and NEW_HEIGHT specify the new
517 * text size of F in pixels. A value of -1 means no change is requested
518 * for that direction (but the frame may still have to be resized to
519 * accommodate windows with their minimum sizes). This can either issue
520 * a request to resize the frame externally (via x_set_window_size), to
521 * resize the frame internally (via resize_frame_windows) or do nothing
522 * at all.
524 * The argument INHIBIT can assume the following values:
526 * 0 means to unconditionally call x_set_window_size even if sizes
527 * apparently do not change. Fx_create_frame uses this to pass the
528 * initial size to the window manager.
530 * 1 means to call x_set_window_size if the native frame size really
531 * changes. Fset_frame_size, Fset_frame_height, ... use this.
533 * 2 means to call x_set_window_size provided frame_inhibit_resize
534 * allows it. The menu and tool bar code use this ("3" won't work
535 * here in general because menu and tool bar are often not counted in
536 * the frame's text height).
538 * 3 means call x_set_window_size if window minimum sizes must be
539 * preserved or frame_inhibit_resize allows it. x_set_left_fringe,
540 * x_set_scroll_bar_width, x_new_font ... use (or should use) this.
542 * 4 means call x_set_window_size only if window minimum sizes must be
543 * preserved. x_set_right_divider_width, x_set_border_width and the
544 * code responsible for wrapping the tool bar use this.
546 * 5 means to never call x_set_window_size. change_frame_size uses
547 * this.
549 * Note that even when x_set_window_size is not called, individual
550 * windows may have to be resized (via `window--sanitize-window-sizes')
551 * in order to support minimum size constraints.
553 * PRETEND is as for change_frame_size. PARAMETER, if non-nil, is the
554 * symbol of the parameter changed (like `menu-bar-lines', `font', ...).
555 * This is passed on to frame_inhibit_resize to let the latter decide on
556 * a case-by-case basis whether the frame may be resized externally.
558 void
559 adjust_frame_size (struct frame *f, int new_width, int new_height, int inhibit,
560 bool pretend, Lisp_Object parameter)
562 int unit_width = FRAME_COLUMN_WIDTH (f);
563 int unit_height = FRAME_LINE_HEIGHT (f);
564 int old_pixel_width = FRAME_PIXEL_WIDTH (f);
565 int old_pixel_height = FRAME_PIXEL_HEIGHT (f);
566 int old_cols = FRAME_COLS (f);
567 int old_lines = FRAME_LINES (f);
568 int new_pixel_width, new_pixel_height;
569 /* The following two values are calculated from the old frame pixel
570 sizes and any "new" settings for tool bar, menu bar and internal
571 borders. We do it this way to detect whether we have to call
572 x_set_window_size as consequence of the new settings. */
573 int windows_width = FRAME_WINDOWS_WIDTH (f);
574 int windows_height = FRAME_WINDOWS_HEIGHT (f);
575 int min_windows_width, min_windows_height;
576 /* These are a bit tedious, maybe we should use a macro. */
577 struct window *r = XWINDOW (FRAME_ROOT_WINDOW (f));
578 int old_windows_width = WINDOW_PIXEL_WIDTH (r);
579 int old_windows_height
580 = (WINDOW_PIXEL_HEIGHT (r)
581 + ((FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
582 ? WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_MINIBUF_WINDOW (f)))
583 : 0));
584 int new_windows_width, new_windows_height;
585 int old_text_width = FRAME_TEXT_WIDTH (f);
586 int old_text_height = FRAME_TEXT_HEIGHT (f);
587 /* If a size is < 0 use the old value. */
588 int new_text_width = (new_width >= 0) ? new_width : old_text_width;
589 int new_text_height = (new_height >= 0) ? new_height : old_text_height;
590 int new_cols, new_lines;
591 bool inhibit_horizontal, inhibit_vertical;
592 Lisp_Object frame;
594 XSETFRAME (frame, f);
596 frame_size_history_add
597 (f, Qadjust_frame_size_1, new_text_width, new_text_height,
598 list2 (parameter, make_number (inhibit)));
600 /* The following two values are calculated from the old window body
601 sizes and any "new" settings for scroll bars, dividers, fringes and
602 margins (though the latter should have been processed already). */
603 min_windows_width
604 = frame_windows_min_size (frame, Qt, (inhibit == 5) ? Qt : Qnil, Qt);
605 min_windows_height
606 = frame_windows_min_size (frame, Qnil, (inhibit == 5) ? Qt : Qnil, Qt);
608 if (inhibit >= 2 && inhibit <= 4)
609 /* When INHIBIT is in [2..4] inhibit if the "old" window sizes stay
610 within the limits and either resizing is inhibited or INHIBIT
611 equals 4. */
613 inhibit_horizontal = (windows_width >= min_windows_width
614 && (inhibit == 4
615 || frame_inhibit_resize (f, true, parameter)));
616 inhibit_vertical = (windows_height >= min_windows_height
617 && (inhibit == 4
618 || frame_inhibit_resize (f, false, parameter)));
620 else
621 /* Otherwise inhibit if INHIBIT equals 5. */
622 inhibit_horizontal = inhibit_vertical = inhibit == 5;
624 new_pixel_width = ((inhibit_horizontal && (inhibit < 5))
625 ? old_pixel_width
626 : max (FRAME_TEXT_TO_PIXEL_WIDTH (f, new_text_width),
627 min_windows_width
628 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f)));
629 new_windows_width = new_pixel_width - 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
630 new_text_width = FRAME_PIXEL_TO_TEXT_WIDTH (f, new_pixel_width);
631 new_cols = new_text_width / unit_width;
633 new_pixel_height = ((inhibit_vertical && (inhibit < 5))
634 ? old_pixel_height
635 : max (FRAME_TEXT_TO_PIXEL_HEIGHT (f, new_text_height),
636 min_windows_height
637 + FRAME_TOP_MARGIN_HEIGHT (f)
638 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f)));
639 new_windows_height = (new_pixel_height
640 - FRAME_TOP_MARGIN_HEIGHT (f)
641 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
642 new_text_height = FRAME_PIXEL_TO_TEXT_HEIGHT (f, new_pixel_height);
643 new_lines = new_text_height / unit_height;
645 #ifdef HAVE_WINDOW_SYSTEM
646 if (FRAME_WINDOW_P (f)
647 && f->can_x_set_window_size
648 && ((!inhibit_horizontal
649 && (new_pixel_width != old_pixel_width
650 || inhibit == 0 || inhibit == 2))
651 || (!inhibit_vertical
652 && (new_pixel_height != old_pixel_height
653 || inhibit == 0 || inhibit == 2))))
654 /* We are either allowed to change the frame size or the minimum
655 sizes request such a change. Do not care for fixing minimum
656 sizes here, we do that eventually when we're called from
657 change_frame_size. */
659 /* Make sure we respect fullheight and fullwidth. */
660 if (inhibit_horizontal)
661 new_text_width = old_text_width;
662 else if (inhibit_vertical)
663 new_text_height = old_text_height;
665 frame_size_history_add
666 (f, Qadjust_frame_size_2, new_text_width, new_text_height,
667 list2 (inhibit_horizontal ? Qt : Qnil,
668 inhibit_vertical ? Qt : Qnil));
670 x_set_window_size (f, 0, new_text_width, new_text_height, 1);
671 f->resized_p = true;
673 return;
675 #endif
677 if (new_text_width == old_text_width
678 && new_text_height == old_text_height
679 && new_windows_width == old_windows_width
680 && new_windows_height == old_windows_height
681 && new_pixel_width == old_pixel_width
682 && new_pixel_height == old_pixel_height
683 && new_cols == old_cols
684 && new_lines == old_lines)
685 /* No change. Sanitize window sizes and return. */
687 sanitize_window_sizes (Qt);
688 sanitize_window_sizes (Qnil);
690 return;
693 block_input ();
695 #ifdef MSDOS
696 /* We only can set screen dimensions to certain values supported by
697 our video hardware. Try to find the smallest size greater or
698 equal to the requested dimensions, while accounting for the fact
699 that the menu-bar lines are not counted in the frame height. */
700 int dos_new_lines = new_lines + FRAME_TOP_MARGIN (f);
701 dos_set_window_size (&dos_new_lines, &new_cols);
702 new_lines = dos_new_lines - FRAME_TOP_MARGIN (f);
703 #endif
705 if (new_windows_width != old_windows_width)
707 resize_frame_windows (f, new_windows_width, 1, 1);
709 /* MSDOS frames cannot PRETEND, as they change frame size by
710 manipulating video hardware. */
711 if ((FRAME_TERMCAP_P (f) && !pretend) || FRAME_MSDOS_P (f))
712 FrameCols (FRAME_TTY (f)) = new_cols;
714 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
715 if (WINDOWP (f->tool_bar_window))
717 XWINDOW (f->tool_bar_window)->pixel_width = new_windows_width;
718 XWINDOW (f->tool_bar_window)->total_cols
719 = new_windows_width / unit_width;
721 #endif
723 else if (new_cols != old_cols)
724 call2 (Qwindow__pixel_to_total, frame, Qt);
726 if (new_windows_height != old_windows_height
727 /* When the top margin has changed we have to recalculate the top
728 edges of all windows. No such calculation is necessary for the
729 left edges. */
730 || WINDOW_TOP_PIXEL_EDGE (r) != FRAME_TOP_MARGIN_HEIGHT (f))
732 resize_frame_windows (f, new_windows_height, 0, 1);
734 /* MSDOS frames cannot PRETEND, as they change frame size by
735 manipulating video hardware. */
736 if ((FRAME_TERMCAP_P (f) && !pretend) || FRAME_MSDOS_P (f))
737 FrameRows (FRAME_TTY (f)) = new_lines + FRAME_TOP_MARGIN (f);
739 else if (new_lines != old_lines)
740 call2 (Qwindow__pixel_to_total, frame, Qnil);
742 frame_size_history_add
743 (f, Qadjust_frame_size_3, new_text_width, new_text_height,
744 list4 (make_number (old_pixel_width), make_number (old_pixel_height),
745 make_number (new_pixel_width), make_number (new_pixel_height)));
747 /* Assign new sizes. */
748 FRAME_TEXT_WIDTH (f) = new_text_width;
749 FRAME_TEXT_HEIGHT (f) = new_text_height;
750 FRAME_PIXEL_WIDTH (f) = new_pixel_width;
751 FRAME_PIXEL_HEIGHT (f) = new_pixel_height;
752 SET_FRAME_COLS (f, new_cols);
753 SET_FRAME_LINES (f, new_lines);
756 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
757 int text_area_x, text_area_y, text_area_width, text_area_height;
759 window_box (w, TEXT_AREA, &text_area_x, &text_area_y, &text_area_width,
760 &text_area_height);
761 if (w->cursor.x >= text_area_x + text_area_width)
762 w->cursor.hpos = w->cursor.x = 0;
763 if (w->cursor.y >= text_area_y + text_area_height)
764 w->cursor.vpos = w->cursor.y = 0;
767 /* Sanitize window sizes. */
768 sanitize_window_sizes (Qt);
769 sanitize_window_sizes (Qnil);
771 adjust_frame_glyphs (f);
772 calculate_costs (f);
773 SET_FRAME_GARBAGED (f);
775 /* A frame was "resized" if one of its pixelsizes changed, even if its
776 X window wasn't resized at all. */
777 f->resized_p = (new_pixel_width != old_pixel_width
778 || new_pixel_height != old_pixel_height);
780 unblock_input ();
782 #ifdef HAVE_WINDOW_SYSTEM
784 /* Adjust size of F's child frames. */
785 Lisp_Object frames, frame1;
787 FOR_EACH_FRAME (frames, frame1)
788 if (FRAME_PARENT_FRAME (XFRAME (frame1)) == f)
789 keep_ratio (XFRAME (frame1), f, old_pixel_width, old_pixel_height,
790 new_pixel_width, new_pixel_height);
792 #endif
795 /* Allocate basically initialized frame. */
797 static struct frame *
798 allocate_frame (void)
800 return ALLOCATE_ZEROED_PSEUDOVECTOR (struct frame, face_cache, PVEC_FRAME);
803 struct frame *
804 make_frame (bool mini_p)
806 Lisp_Object frame;
807 struct frame *f;
808 struct window *rw, *mw UNINIT;
809 Lisp_Object root_window;
810 Lisp_Object mini_window;
812 f = allocate_frame ();
813 XSETFRAME (frame, f);
815 #ifdef USE_GTK
816 /* Initialize Lisp data. Note that allocate_frame initializes all
817 Lisp data to nil, so do it only for slots which should not be nil. */
818 fset_tool_bar_position (f, Qtop);
819 #endif
821 /* Initialize non-Lisp data. Note that allocate_frame zeroes out all
822 non-Lisp data, so do it only for slots which should not be zero.
823 To avoid subtle bugs and for the sake of readability, it's better to
824 initialize enum members explicitly even if their values are zero. */
825 f->wants_modeline = true;
826 f->redisplay = true;
827 f->garbaged = true;
828 f->can_x_set_window_size = false;
829 f->after_make_frame = false;
830 f->inhibit_horizontal_resize = false;
831 f->inhibit_vertical_resize = false;
832 f->tool_bar_redisplayed = false;
833 f->tool_bar_resized = false;
834 f->column_width = 1; /* !FRAME_WINDOW_P value. */
835 f->line_height = 1; /* !FRAME_WINDOW_P value. */
836 #ifdef HAVE_WINDOW_SYSTEM
837 f->vertical_scroll_bar_type = vertical_scroll_bar_none;
838 f->horizontal_scroll_bars = false;
839 f->want_fullscreen = FULLSCREEN_NONE;
840 f->undecorated = false;
841 f->no_special_glyphs = false;
842 #ifndef HAVE_NTGUI
843 f->override_redirect = false;
844 #endif
845 f->skip_taskbar = false;
846 f->no_focus_on_map = false;
847 f->no_accept_focus = false;
848 f->z_group = z_group_none;
849 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
850 f->last_tool_bar_item = -1;
851 #endif
852 #ifdef NS_IMPL_COCOA
853 f->ns_appearance = ns_appearance_aqua;
854 f->ns_transparent_titlebar = false;
855 #endif
856 #endif
858 root_window = make_window ();
859 rw = XWINDOW (root_window);
860 if (mini_p)
862 mini_window = make_window ();
863 mw = XWINDOW (mini_window);
864 wset_next (rw, mini_window);
865 wset_prev (mw, root_window);
866 mw->mini = 1;
867 wset_frame (mw, frame);
868 fset_minibuffer_window (f, mini_window);
869 store_frame_param (f, Qminibuffer, Qt);
871 else
873 mini_window = Qnil;
874 wset_next (rw, Qnil);
875 fset_minibuffer_window (f, Qnil);
878 wset_frame (rw, frame);
880 /* 10 is arbitrary,
881 just so that there is "something there."
882 Correct size will be set up later with adjust_frame_size. */
884 SET_FRAME_COLS (f, 10);
885 SET_FRAME_LINES (f, 10);
886 SET_FRAME_WIDTH (f, FRAME_COLS (f) * FRAME_COLUMN_WIDTH (f));
887 SET_FRAME_HEIGHT (f, FRAME_LINES (f) * FRAME_LINE_HEIGHT (f));
889 rw->total_cols = 10;
890 rw->pixel_width = rw->total_cols * FRAME_COLUMN_WIDTH (f);
891 rw->total_lines = mini_p ? 9 : 10;
892 rw->pixel_height = rw->total_lines * FRAME_LINE_HEIGHT (f);
894 if (mini_p)
896 mw->top_line = rw->total_lines;
897 mw->pixel_top = rw->pixel_height;
898 mw->total_cols = rw->total_cols;
899 mw->pixel_width = rw->pixel_width;
900 mw->total_lines = 1;
901 mw->pixel_height = FRAME_LINE_HEIGHT (f);
904 /* Choose a buffer for the frame's root window. */
906 Lisp_Object buf = Fcurrent_buffer ();
908 /* If current buffer is hidden, try to find another one. */
909 if (BUFFER_HIDDEN_P (XBUFFER (buf)))
910 buf = other_buffer_safely (buf);
912 /* Use set_window_buffer, not Fset_window_buffer, and don't let
913 hooks be run by it. The reason is that the whole frame/window
914 arrangement is not yet fully initialized at this point. Windows
915 don't have the right size, glyph matrices aren't initialized
916 etc. Running Lisp functions at this point surely ends in a
917 SEGV. */
918 set_window_buffer (root_window, buf, 0, 0);
919 fset_buffer_list (f, list1 (buf));
922 if (mini_p)
924 set_window_buffer (mini_window,
925 (NILP (Vminibuffer_list)
926 ? get_minibuffer (0)
927 : Fcar (Vminibuffer_list)),
928 0, 0);
929 /* No horizontal scroll bars in minibuffers. */
930 wset_horizontal_scroll_bar (mw, Qnil);
933 fset_root_window (f, root_window);
934 fset_selected_window (f, root_window);
935 /* Make sure this window seems more recently used than
936 a newly-created, never-selected window. */
937 XWINDOW (f->selected_window)->use_time = ++window_select_count;
939 return f;
942 #ifdef HAVE_WINDOW_SYSTEM
943 /* Make a frame using a separate minibuffer window on another frame.
944 MINI_WINDOW is the minibuffer window to use. nil means use the
945 default (the global minibuffer). */
947 struct frame *
948 make_frame_without_minibuffer (Lisp_Object mini_window, KBOARD *kb,
949 Lisp_Object display)
951 struct frame *f;
953 if (!NILP (mini_window))
954 CHECK_LIVE_WINDOW (mini_window);
956 if (!NILP (mini_window)
957 && FRAME_KBOARD (XFRAME (XWINDOW (mini_window)->frame)) != kb)
958 error ("Frame and minibuffer must be on the same terminal");
960 /* Make a frame containing just a root window. */
961 f = make_frame (0);
963 if (NILP (mini_window))
965 /* Use default-minibuffer-frame if possible. */
966 if (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
967 || ! FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame))))
969 Lisp_Object frame_dummy;
971 XSETFRAME (frame_dummy, f);
972 /* If there's no minibuffer frame to use, create one. */
973 kset_default_minibuffer_frame
974 (kb, call1 (intern ("make-initial-minibuffer-frame"), display));
977 mini_window
978 = XFRAME (KVAR (kb, Vdefault_minibuffer_frame))->minibuffer_window;
981 fset_minibuffer_window (f, mini_window);
982 store_frame_param (f, Qminibuffer, mini_window);
984 /* Make the chosen minibuffer window display the proper minibuffer,
985 unless it is already showing a minibuffer. */
986 if (NILP (Fmemq (XWINDOW (mini_window)->contents, Vminibuffer_list)))
987 /* Use set_window_buffer instead of Fset_window_buffer (see
988 discussion of bug#11984, bug#12025, bug#12026). */
989 set_window_buffer (mini_window,
990 (NILP (Vminibuffer_list)
991 ? get_minibuffer (0)
992 : Fcar (Vminibuffer_list)), 0, 0);
993 return f;
996 /* Make a frame containing only a minibuffer window. */
998 struct frame *
999 make_minibuffer_frame (void)
1001 /* First make a frame containing just a root window, no minibuffer. */
1003 register struct frame *f = make_frame (0);
1004 register Lisp_Object mini_window;
1005 register Lisp_Object frame;
1007 XSETFRAME (frame, f);
1009 f->auto_raise = 0;
1010 f->auto_lower = 0;
1011 f->no_split = 1;
1012 f->wants_modeline = 0;
1014 /* Now label the root window as also being the minibuffer.
1015 Avoid infinite looping on the window chain by marking next pointer
1016 as nil. */
1018 mini_window = f->root_window;
1019 fset_minibuffer_window (f, mini_window);
1020 store_frame_param (f, Qminibuffer, Qonly);
1021 XWINDOW (mini_window)->mini = 1;
1022 wset_next (XWINDOW (mini_window), Qnil);
1023 wset_prev (XWINDOW (mini_window), Qnil);
1024 wset_frame (XWINDOW (mini_window), frame);
1026 /* Put the proper buffer in that window. */
1028 /* Use set_window_buffer instead of Fset_window_buffer (see
1029 discussion of bug#11984, bug#12025, bug#12026). */
1030 set_window_buffer (mini_window,
1031 (NILP (Vminibuffer_list)
1032 ? get_minibuffer (0)
1033 : Fcar (Vminibuffer_list)), 0, 0);
1034 return f;
1036 #endif /* HAVE_WINDOW_SYSTEM */
1038 /* Construct a frame that refers to a terminal. */
1040 static printmax_t tty_frame_count;
1042 struct frame *
1043 make_initial_frame (void)
1045 struct frame *f;
1046 struct terminal *terminal;
1047 Lisp_Object frame;
1049 eassert (initial_kboard);
1051 /* The first call must initialize Vframe_list. */
1052 if (! (NILP (Vframe_list) || CONSP (Vframe_list)))
1053 Vframe_list = Qnil;
1055 terminal = init_initial_terminal ();
1057 f = make_frame (1);
1058 XSETFRAME (frame, f);
1060 Vframe_list = Fcons (frame, Vframe_list);
1062 tty_frame_count = 1;
1063 fset_name (f, build_pure_c_string ("F1"));
1065 SET_FRAME_VISIBLE (f, 1);
1067 f->output_method = terminal->type;
1068 f->terminal = terminal;
1069 f->terminal->reference_count++;
1070 f->output_data.nothing = 0;
1072 FRAME_FOREGROUND_PIXEL (f) = FACE_TTY_DEFAULT_FG_COLOR;
1073 FRAME_BACKGROUND_PIXEL (f) = FACE_TTY_DEFAULT_BG_COLOR;
1075 #ifdef HAVE_WINDOW_SYSTEM
1076 f->vertical_scroll_bar_type = vertical_scroll_bar_none;
1077 f->horizontal_scroll_bars = false;
1078 #endif
1080 /* The default value of menu-bar-mode is t. */
1081 set_menu_bar_lines (f, make_number (1), Qnil);
1083 /* Allocate glyph matrices. */
1084 adjust_frame_glyphs (f);
1086 if (!noninteractive)
1087 init_frame_faces (f);
1089 last_nonminibuf_frame = f;
1091 f->can_x_set_window_size = true;
1092 f->after_make_frame = true;
1094 return f;
1098 static struct frame *
1099 make_terminal_frame (struct terminal *terminal)
1101 register struct frame *f;
1102 Lisp_Object frame;
1103 char name[sizeof "F" + INT_STRLEN_BOUND (printmax_t)];
1105 if (!terminal->name)
1106 error ("Terminal is not live, can't create new frames on it");
1108 f = make_frame (1);
1110 XSETFRAME (frame, f);
1111 Vframe_list = Fcons (frame, Vframe_list);
1113 fset_name (f, make_formatted_string (name, "F%"pMd, ++tty_frame_count));
1115 SET_FRAME_VISIBLE (f, 1);
1117 f->terminal = terminal;
1118 f->terminal->reference_count++;
1119 #ifdef MSDOS
1120 f->output_data.tty->display_info = &the_only_display_info;
1121 if (!inhibit_window_system
1122 && (!FRAMEP (selected_frame) || !FRAME_LIVE_P (XFRAME (selected_frame))
1123 || XFRAME (selected_frame)->output_method == output_msdos_raw))
1124 f->output_method = output_msdos_raw;
1125 else
1126 f->output_method = output_termcap;
1127 #else /* not MSDOS */
1128 f->output_method = output_termcap;
1129 create_tty_output (f);
1130 FRAME_FOREGROUND_PIXEL (f) = FACE_TTY_DEFAULT_FG_COLOR;
1131 FRAME_BACKGROUND_PIXEL (f) = FACE_TTY_DEFAULT_BG_COLOR;
1132 #endif /* not MSDOS */
1134 #ifdef HAVE_WINDOW_SYSTEM
1135 f->vertical_scroll_bar_type = vertical_scroll_bar_none;
1136 f->horizontal_scroll_bars = false;
1137 #endif
1139 FRAME_MENU_BAR_LINES (f) = NILP (Vmenu_bar_mode) ? 0 : 1;
1140 FRAME_LINES (f) = FRAME_LINES (f) - FRAME_MENU_BAR_LINES (f);
1141 FRAME_MENU_BAR_HEIGHT (f) = FRAME_MENU_BAR_LINES (f) * FRAME_LINE_HEIGHT (f);
1142 FRAME_TEXT_HEIGHT (f) = FRAME_TEXT_HEIGHT (f) - FRAME_MENU_BAR_HEIGHT (f);
1144 /* Set the top frame to the newly created frame. */
1145 if (FRAMEP (FRAME_TTY (f)->top_frame)
1146 && FRAME_LIVE_P (XFRAME (FRAME_TTY (f)->top_frame)))
1147 SET_FRAME_VISIBLE (XFRAME (FRAME_TTY (f)->top_frame), 2); /* obscured */
1149 FRAME_TTY (f)->top_frame = frame;
1151 if (!noninteractive)
1152 init_frame_faces (f);
1154 return f;
1157 /* Get a suitable value for frame parameter PARAMETER for a newly
1158 created frame, based on (1) the user-supplied frame parameter
1159 alist SUPPLIED_PARMS, and (2) CURRENT_VALUE. */
1161 static Lisp_Object
1162 get_future_frame_param (Lisp_Object parameter,
1163 Lisp_Object supplied_parms,
1164 char *current_value)
1166 Lisp_Object result;
1168 result = Fassq (parameter, supplied_parms);
1169 if (NILP (result))
1170 result = Fassq (parameter, XFRAME (selected_frame)->param_alist);
1171 if (NILP (result) && current_value != NULL)
1172 result = build_string (current_value);
1173 if (!NILP (result) && !STRINGP (result))
1174 result = XCDR (result);
1175 if (NILP (result) || !STRINGP (result))
1176 result = Qnil;
1178 return result;
1181 DEFUN ("make-terminal-frame", Fmake_terminal_frame, Smake_terminal_frame,
1182 1, 1, 0,
1183 doc: /* Create an additional terminal frame, possibly on another terminal.
1184 This function takes one argument, an alist specifying frame parameters.
1186 You can create multiple frames on a single text terminal, but only one
1187 of them (the selected terminal frame) is actually displayed.
1189 In practice, generally you don't need to specify any parameters,
1190 except when you want to create a new frame on another terminal.
1191 In that case, the `tty' parameter specifies the device file to open,
1192 and the `tty-type' parameter specifies the terminal type. Example:
1194 (make-terminal-frame \\='((tty . "/dev/pts/5") (tty-type . "xterm")))
1196 Note that changing the size of one terminal frame automatically
1197 affects all frames on the same terminal device. */)
1198 (Lisp_Object parms)
1200 struct frame *f;
1201 struct terminal *t = NULL;
1202 Lisp_Object frame, tem;
1203 struct frame *sf = SELECTED_FRAME ();
1205 #ifdef MSDOS
1206 if (sf->output_method != output_msdos_raw
1207 && sf->output_method != output_termcap)
1208 emacs_abort ();
1209 #else /* not MSDOS */
1211 #ifdef WINDOWSNT /* This should work now! */
1212 if (sf->output_method != output_termcap)
1213 error ("Not using an ASCII terminal now; cannot make a new ASCII frame");
1214 #endif
1215 #endif /* not MSDOS */
1218 Lisp_Object terminal;
1220 terminal = Fassq (Qterminal, parms);
1221 if (CONSP (terminal))
1223 terminal = XCDR (terminal);
1224 t = decode_live_terminal (terminal);
1226 #ifdef MSDOS
1227 if (t && t != the_only_display_info.terminal)
1228 /* msdos.c assumes a single tty_display_info object. */
1229 error ("Multiple terminals are not supported on this platform");
1230 if (!t)
1231 t = the_only_display_info.terminal;
1232 #endif
1235 if (!t)
1237 char *name = 0, *type = 0;
1238 Lisp_Object tty, tty_type;
1239 USE_SAFE_ALLOCA;
1241 tty = get_future_frame_param
1242 (Qtty, parms, (FRAME_TERMCAP_P (XFRAME (selected_frame))
1243 ? FRAME_TTY (XFRAME (selected_frame))->name
1244 : NULL));
1245 if (!NILP (tty))
1246 SAFE_ALLOCA_STRING (name, tty);
1248 tty_type = get_future_frame_param
1249 (Qtty_type, parms, (FRAME_TERMCAP_P (XFRAME (selected_frame))
1250 ? FRAME_TTY (XFRAME (selected_frame))->type
1251 : NULL));
1252 if (!NILP (tty_type))
1253 SAFE_ALLOCA_STRING (type, tty_type);
1255 t = init_tty (name, type, 0); /* Errors are not fatal. */
1256 SAFE_FREE ();
1259 f = make_terminal_frame (t);
1262 int width, height;
1263 get_tty_size (fileno (FRAME_TTY (f)->input), &width, &height);
1264 adjust_frame_size (f, width, height - FRAME_MENU_BAR_LINES (f),
1265 5, 0, Qterminal_frame);
1268 adjust_frame_glyphs (f);
1269 calculate_costs (f);
1270 XSETFRAME (frame, f);
1272 store_in_alist (&parms, Qtty_type, build_string (t->display_info.tty->type));
1273 store_in_alist (&parms, Qtty,
1274 (t->display_info.tty->name
1275 ? build_string (t->display_info.tty->name)
1276 : Qnil));
1277 /* On terminal frames the `minibuffer' frame parameter is always
1278 virtually t. Avoid that a different value in parms causes
1279 complaints, see Bug#24758. */
1280 store_in_alist (&parms, Qminibuffer, Qt);
1281 Fmodify_frame_parameters (frame, parms);
1283 /* Make the frame face alist be frame-specific, so that each
1284 frame could change its face definitions independently. */
1285 fset_face_alist (f, Fcopy_alist (sf->face_alist));
1286 /* Simple Fcopy_alist isn't enough, because we need the contents of
1287 the vectors which are the CDRs of associations in face_alist to
1288 be copied as well. */
1289 for (tem = f->face_alist; CONSP (tem); tem = XCDR (tem))
1290 XSETCDR (XCAR (tem), Fcopy_sequence (XCDR (XCAR (tem))));
1292 f->can_x_set_window_size = true;
1293 f->after_make_frame = true;
1295 return frame;
1299 /* Perform the switch to frame FRAME.
1301 If FRAME is a switch-frame event `(switch-frame FRAME1)', use
1302 FRAME1 as frame.
1304 If TRACK is non-zero and the frame that currently has the focus
1305 redirects its focus to the selected frame, redirect that focused
1306 frame's focus to FRAME instead.
1308 FOR_DELETION non-zero means that the selected frame is being
1309 deleted, which includes the possibility that the frame's terminal
1310 is dead.
1312 The value of NORECORD is passed as argument to Fselect_window. */
1314 Lisp_Object
1315 do_switch_frame (Lisp_Object frame, int track, int for_deletion, Lisp_Object norecord)
1317 struct frame *sf = SELECTED_FRAME (), *f;
1319 /* If FRAME is a switch-frame event, extract the frame we should
1320 switch to. */
1321 if (CONSP (frame)
1322 && EQ (XCAR (frame), Qswitch_frame)
1323 && CONSP (XCDR (frame)))
1324 frame = XCAR (XCDR (frame));
1326 /* This used to say CHECK_LIVE_FRAME, but apparently it's possible for
1327 a switch-frame event to arrive after a frame is no longer live,
1328 especially when deleting the initial frame during startup. */
1329 CHECK_FRAME (frame);
1330 f = XFRAME (frame);
1331 if (!FRAME_LIVE_P (f))
1332 return Qnil;
1333 else if (f == sf)
1334 return frame;
1336 /* If a frame's focus has been redirected toward the currently
1337 selected frame, we should change the redirection to point to the
1338 newly selected frame. This means that if the focus is redirected
1339 from a minibufferless frame to a surrogate minibuffer frame, we
1340 can use `other-window' to switch between all the frames using
1341 that minibuffer frame, and the focus redirection will follow us
1342 around. */
1343 #if 0
1344 /* This is too greedy; it causes inappropriate focus redirection
1345 that's hard to get rid of. */
1346 if (track)
1348 Lisp_Object tail;
1350 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1352 Lisp_Object focus;
1354 if (!FRAMEP (XCAR (tail)))
1355 emacs_abort ();
1357 focus = FRAME_FOCUS_FRAME (XFRAME (XCAR (tail)));
1359 if (FRAMEP (focus) && XFRAME (focus) == SELECTED_FRAME ())
1360 Fredirect_frame_focus (XCAR (tail), frame);
1363 #else /* ! 0 */
1364 /* Instead, apply it only to the frame we're pointing to. */
1365 #ifdef HAVE_WINDOW_SYSTEM
1366 if (track && FRAME_WINDOW_P (f))
1368 Lisp_Object focus, xfocus;
1370 xfocus = x_get_focus_frame (f);
1371 if (FRAMEP (xfocus))
1373 focus = FRAME_FOCUS_FRAME (XFRAME (xfocus));
1374 if ((FRAMEP (focus) && XFRAME (focus) == SELECTED_FRAME ())
1375 /* Redirect frame focus also when FRAME has its minibuffer
1376 window on the selected frame (see Bug#24500). */
1377 || (NILP (focus)
1378 && EQ (FRAME_MINIBUF_WINDOW (f), sf->selected_window)))
1379 Fredirect_frame_focus (xfocus, frame);
1382 #endif /* HAVE_X_WINDOWS */
1383 #endif /* ! 0 */
1385 if (!for_deletion && FRAME_HAS_MINIBUF_P (sf))
1386 resize_mini_window (XWINDOW (FRAME_MINIBUF_WINDOW (sf)), 1);
1388 if (FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
1390 struct tty_display_info *tty = FRAME_TTY (f);
1391 Lisp_Object top_frame = tty->top_frame;
1393 /* Don't mark the frame garbaged and/or obscured if we are
1394 switching to the frame that is already the top frame of that
1395 TTY. */
1396 if (!EQ (frame, top_frame))
1398 if (FRAMEP (top_frame))
1399 /* Mark previously displayed frame as now obscured. */
1400 SET_FRAME_VISIBLE (XFRAME (top_frame), 2);
1401 SET_FRAME_VISIBLE (f, 1);
1402 /* If the new TTY frame changed dimensions, we need to
1403 resync term.c's idea of the frame size with the new
1404 frame's data. */
1405 if (FRAME_COLS (f) != FrameCols (tty))
1406 FrameCols (tty) = FRAME_COLS (f);
1407 if (FRAME_TOTAL_LINES (f) != FrameRows (tty))
1408 FrameRows (tty) = FRAME_TOTAL_LINES (f);
1410 tty->top_frame = frame;
1413 selected_frame = frame;
1414 if (! FRAME_MINIBUF_ONLY_P (XFRAME (selected_frame)))
1415 last_nonminibuf_frame = XFRAME (selected_frame);
1417 Fselect_window (f->selected_window, norecord);
1419 /* We want to make sure that the next event generates a frame-switch
1420 event to the appropriate frame. This seems kludgy to me, but
1421 before you take it out, make sure that evaluating something like
1422 (select-window (frame-root-window (make-frame))) doesn't end up
1423 with your typing being interpreted in the new frame instead of
1424 the one you're actually typing in. */
1425 #ifdef HAVE_WINDOW_SYSTEM
1426 if (!frame_ancestor_p (f, sf))
1427 #endif
1428 internal_last_event_frame = Qnil;
1430 return frame;
1433 DEFUN ("select-frame", Fselect_frame, Sselect_frame, 1, 2, "e",
1434 doc: /* Select FRAME.
1435 Subsequent editing commands apply to its selected window.
1436 Optional argument NORECORD means to neither change the order of
1437 recently selected windows nor the buffer list.
1439 The selection of FRAME lasts until the next time the user does
1440 something to select a different frame, or until the next time
1441 this function is called. If you are using a window system, the
1442 previously selected frame may be restored as the selected frame
1443 when returning to the command loop, because it still may have
1444 the window system's input focus. On a text terminal, the next
1445 redisplay will display FRAME.
1447 This function returns FRAME, or nil if FRAME has been deleted. */)
1448 (Lisp_Object frame, Lisp_Object norecord)
1450 return do_switch_frame (frame, 1, 0, norecord);
1453 DEFUN ("handle-switch-frame", Fhandle_switch_frame, Shandle_switch_frame, 1, 1, "^e",
1454 doc: /* Handle a switch-frame event EVENT.
1455 Switch-frame events are usually bound to this function.
1456 A switch-frame event tells Emacs that the window manager has requested
1457 that the user's events be directed to the frame mentioned in the event.
1458 This function selects the selected window of the frame of EVENT.
1460 If EVENT is frame object, handle it as if it were a switch-frame event
1461 to that frame. */)
1462 (Lisp_Object event)
1464 Lisp_Object value;
1466 /* Preserve prefix arg that the command loop just cleared. */
1467 kset_prefix_arg (current_kboard, Vcurrent_prefix_arg);
1468 run_hook (Qmouse_leave_buffer_hook);
1469 /* `switch-frame' implies a focus in. */
1470 value = do_switch_frame (event, 0, 0, Qnil);
1471 call1 (intern ("handle-focus-in"), event);
1472 return value;
1475 DEFUN ("selected-frame", Fselected_frame, Sselected_frame, 0, 0, 0,
1476 doc: /* Return the frame that is now selected. */)
1477 (void)
1479 return selected_frame;
1482 DEFUN ("frame-list", Fframe_list, Sframe_list,
1483 0, 0, 0,
1484 doc: /* Return a list of all live frames. */)
1485 (void)
1487 Lisp_Object frames;
1488 frames = Fcopy_sequence (Vframe_list);
1489 #ifdef HAVE_WINDOW_SYSTEM
1490 if (FRAMEP (tip_frame)
1491 #ifdef USE_GTK
1492 && !NILP (Fframe_parameter (tip_frame, Qtooltip))
1493 #endif
1495 frames = Fdelq (tip_frame, frames);
1496 #endif
1497 return frames;
1500 DEFUN ("frame-parent", Fframe_parent, Sframe_parent,
1501 0, 1, 0,
1502 doc: /* Return the parent frame of FRAME.
1503 The parent frame of FRAME is the Emacs frame whose window-system window
1504 is the parent window of FRAME's window-system window. When such a frame
1505 exists, FRAME is considered a child frame of that frame.
1507 Return nil if FRAME has no parent frame. This means that FRAME's
1508 window-system window is either a "top-level" window (a window whose
1509 parent window is the window-system's root window) or an embedded window
1510 \(a window whose parent window is owned by some other application). */)
1511 (Lisp_Object frame)
1513 struct frame *f = decode_live_frame (frame);
1514 struct frame *p = FRAME_PARENT_FRAME (f);
1515 Lisp_Object parent;
1517 /* Can't return f->parent_frame directly since it might not be defined
1518 for this platform. */
1519 if (p)
1521 XSETFRAME (parent, p);
1523 return parent;
1525 else
1526 return Qnil;
1529 #ifdef HAVE_WINDOW_SYSTEM
1530 bool
1531 frame_ancestor_p (struct frame *af, struct frame *df)
1533 struct frame *pf = FRAME_PARENT_FRAME (df);
1535 while (pf)
1537 if (pf == af)
1538 return true;
1539 else
1540 pf = FRAME_PARENT_FRAME (pf);
1543 return false;
1545 #endif
1547 DEFUN ("frame-ancestor-p", Fframe_ancestor_p, Sframe_ancestor_p,
1548 2, 2, 0,
1549 doc: /* Return non-nil if ANCESTOR is an ancestor of DESCENDANT.
1550 ANCESTOR is an ancestor of DESCENDANT when it is either DESCENDANT's
1551 parent frame or it is an ancestor of DESCENDANT's parent frame. Both,
1552 ANCESTOR and DESCENDANT must be live frames and default to the selected
1553 frame. */)
1554 (Lisp_Object ancestor, Lisp_Object descendant)
1556 #ifdef HAVE_WINDOW_SYSTEM
1557 struct frame *af = decode_live_frame (ancestor);
1558 struct frame *df = decode_live_frame (descendant);
1560 return frame_ancestor_p (af, df) ? Qt : Qnil;
1561 #else
1562 return Qnil;
1563 #endif
1566 /* Return CANDIDATE if it can be used as 'other-than-FRAME' frame on the
1567 same tty (for tty frames) or among frames which uses FRAME's keyboard.
1568 If MINIBUF is nil, do not consider minibuffer-only candidate.
1569 If MINIBUF is `visible', do not consider an invisible candidate.
1570 If MINIBUF is a window, consider only its own frame and candidate now
1571 using that window as the minibuffer.
1572 If MINIBUF is 0, consider candidate if it is visible or iconified.
1573 Otherwise consider any candidate and return nil if CANDIDATE is not
1574 acceptable. */
1576 static Lisp_Object
1577 candidate_frame (Lisp_Object candidate, Lisp_Object frame, Lisp_Object minibuf)
1579 struct frame *c = XFRAME (candidate), *f = XFRAME (frame);
1581 if ((!FRAME_TERMCAP_P (c) && !FRAME_TERMCAP_P (f)
1582 && FRAME_KBOARD (c) == FRAME_KBOARD (f))
1583 || (FRAME_TERMCAP_P (c) && FRAME_TERMCAP_P (f)
1584 && FRAME_TTY (c) == FRAME_TTY (f)))
1586 if (!NILP (get_frame_param (c, Qno_other_frame)))
1587 return Qnil;
1588 else if (NILP (minibuf))
1590 if (!FRAME_MINIBUF_ONLY_P (c))
1591 return candidate;
1593 else if (EQ (minibuf, Qvisible))
1595 if (FRAME_VISIBLE_P (c))
1596 return candidate;
1598 else if (WINDOWP (minibuf))
1600 if (EQ (FRAME_MINIBUF_WINDOW (c), minibuf)
1601 || EQ (WINDOW_FRAME (XWINDOW (minibuf)), candidate)
1602 || EQ (WINDOW_FRAME (XWINDOW (minibuf)),
1603 FRAME_FOCUS_FRAME (c)))
1604 return candidate;
1606 else if (INTEGERP (minibuf) && XINT (minibuf) == 0)
1608 if (FRAME_VISIBLE_P (c) || FRAME_ICONIFIED_P (c))
1609 return candidate;
1611 else
1612 return candidate;
1614 return Qnil;
1617 /* Return the next frame in the frame list after FRAME. */
1619 static Lisp_Object
1620 next_frame (Lisp_Object frame, Lisp_Object minibuf)
1622 Lisp_Object f, tail;
1623 int passed = 0;
1625 eassume (CONSP (Vframe_list));
1627 while (passed < 2)
1628 FOR_EACH_FRAME (tail, f)
1630 if (passed)
1632 f = candidate_frame (f, frame, minibuf);
1633 if (!NILP (f))
1634 return f;
1636 if (EQ (frame, f))
1637 passed++;
1639 return frame;
1642 /* Return the previous frame in the frame list before FRAME. */
1644 static Lisp_Object
1645 prev_frame (Lisp_Object frame, Lisp_Object minibuf)
1647 Lisp_Object f, tail, prev = Qnil;
1649 eassume (CONSP (Vframe_list));
1651 FOR_EACH_FRAME (tail, f)
1653 if (EQ (frame, f) && !NILP (prev))
1654 return prev;
1655 f = candidate_frame (f, frame, minibuf);
1656 if (!NILP (f))
1657 prev = f;
1660 /* We've scanned the entire list. */
1661 if (NILP (prev))
1662 /* We went through the whole frame list without finding a single
1663 acceptable frame. Return the original frame. */
1664 return frame;
1665 else
1666 /* There were no acceptable frames in the list before FRAME; otherwise,
1667 we would have returned directly from the loop. Since PREV is the last
1668 acceptable frame in the list, return it. */
1669 return prev;
1673 DEFUN ("next-frame", Fnext_frame, Snext_frame, 0, 2, 0,
1674 doc: /* Return the next frame in the frame list after FRAME.
1675 It considers only frames on the same terminal as FRAME.
1676 By default, skip minibuffer-only frames.
1677 If omitted, FRAME defaults to the selected frame.
1678 If optional argument MINIFRAME is nil, exclude minibuffer-only frames.
1679 If MINIFRAME is a window, include only its own frame
1680 and any frame now using that window as the minibuffer.
1681 If MINIFRAME is `visible', include all visible frames.
1682 If MINIFRAME is 0, include all visible and iconified frames.
1683 Otherwise, include all frames. */)
1684 (Lisp_Object frame, Lisp_Object miniframe)
1686 if (NILP (frame))
1687 frame = selected_frame;
1688 CHECK_LIVE_FRAME (frame);
1689 return next_frame (frame, miniframe);
1692 DEFUN ("previous-frame", Fprevious_frame, Sprevious_frame, 0, 2, 0,
1693 doc: /* Return the previous frame in the frame list before FRAME.
1694 It considers only frames on the same terminal as FRAME.
1695 By default, skip minibuffer-only frames.
1696 If omitted, FRAME defaults to the selected frame.
1697 If optional argument MINIFRAME is nil, exclude minibuffer-only frames.
1698 If MINIFRAME is a window, include only its own frame
1699 and any frame now using that window as the minibuffer.
1700 If MINIFRAME is `visible', include all visible frames.
1701 If MINIFRAME is 0, include all visible and iconified frames.
1702 Otherwise, include all frames. */)
1703 (Lisp_Object frame, Lisp_Object miniframe)
1705 if (NILP (frame))
1706 frame = selected_frame;
1707 CHECK_LIVE_FRAME (frame);
1708 return prev_frame (frame, miniframe);
1711 DEFUN ("last-nonminibuffer-frame", Flast_nonminibuf_frame,
1712 Slast_nonminibuf_frame, 0, 0, 0,
1713 doc: /* Return last non-minibuffer frame selected. */)
1714 (void)
1716 Lisp_Object frame = Qnil;
1718 if (last_nonminibuf_frame)
1719 XSETFRAME (frame, last_nonminibuf_frame);
1721 return frame;
1725 * other_frames:
1727 * Return true if there exists at least one visible or iconified frame
1728 * but F. Return false otherwise.
1730 * INVISIBLE true means we are called from make_frame_invisible where
1731 * such a frame must be visible or iconified. INVISIBLE nil means we
1732 * are called from delete_frame. In that case FORCE true means that the
1733 * visibility status of such a frame can be ignored.
1735 * If F is the terminal frame and we are using X, return true if at
1736 * least one X frame exists.
1738 static bool
1739 other_frames (struct frame *f, bool invisible, bool force)
1741 Lisp_Object frames, frame, frame1;
1742 struct frame *f1;
1743 Lisp_Object minibuffer_window = FRAME_MINIBUF_WINDOW (f);
1745 XSETFRAME (frame, f);
1746 if (WINDOWP (minibuffer_window)
1747 && !EQ (frame, WINDOW_FRAME (XWINDOW (minibuffer_window))))
1748 minibuffer_window = Qnil;
1750 FOR_EACH_FRAME (frames, frame1)
1752 f1 = XFRAME (frame1);
1753 if (f != f1)
1755 /* Verify that we can still talk to the frame's X window, and
1756 note any recent change in visibility. */
1757 #ifdef HAVE_X_WINDOWS
1758 if (FRAME_WINDOW_P (f1))
1759 x_sync (f1);
1760 #endif
1761 if (NILP (Fframe_parameter (frame1, Qtooltip))
1762 /* Tooltips and child frames count neither for
1763 invisibility nor for deletions. */
1764 && !FRAME_PARENT_FRAME (f1)
1765 /* Frames with a non-nil `delete-before' parameter don't
1766 count for deletions. */
1767 && (invisible || NILP (get_frame_param (f1, Qdelete_before)))
1768 /* For invisibility and normal deletions, at least one
1769 visible or iconified frame must remain (Bug#26682). */
1770 && (FRAME_VISIBLE_P (f1) || FRAME_ICONIFIED_P (f1)
1771 || (!invisible
1772 && (force
1773 /* Allow deleting the terminal frame when at
1774 least one X frame exists. */
1775 || (FRAME_WINDOW_P (f1) && !FRAME_WINDOW_P (f))))))
1776 return true;
1780 return false;
1783 /* Make sure that minibuf_window doesn't refer to FRAME's minibuffer
1784 window. Preferably use the selected frame's minibuffer window
1785 instead. If the selected frame doesn't have one, get some other
1786 frame's minibuffer window. SELECT non-zero means select the new
1787 minibuffer window. */
1788 static void
1789 check_minibuf_window (Lisp_Object frame, int select)
1791 struct frame *f = decode_live_frame (frame);
1793 XSETFRAME (frame, f);
1795 if (WINDOWP (minibuf_window) && EQ (f->minibuffer_window, minibuf_window))
1797 Lisp_Object frames, this, window = make_number (0);
1799 if (!EQ (frame, selected_frame)
1800 && FRAME_HAS_MINIBUF_P (XFRAME (selected_frame)))
1801 window = FRAME_MINIBUF_WINDOW (XFRAME (selected_frame));
1802 else
1803 FOR_EACH_FRAME (frames, this)
1805 if (!EQ (this, frame) && FRAME_HAS_MINIBUF_P (XFRAME (this)))
1807 window = FRAME_MINIBUF_WINDOW (XFRAME (this));
1808 break;
1812 /* Don't abort if no window was found (Bug#15247). */
1813 if (WINDOWP (window))
1815 /* Use set_window_buffer instead of Fset_window_buffer (see
1816 discussion of bug#11984, bug#12025, bug#12026). */
1817 set_window_buffer (window, XWINDOW (minibuf_window)->contents, 0, 0);
1818 minibuf_window = window;
1820 /* SELECT non-zero usually means that FRAME's minibuffer
1821 window was selected; select the new one. */
1822 if (select)
1823 Fselect_window (minibuf_window, Qnil);
1830 * delete_frame:
1832 * Delete FRAME. When FORCE equals Qnoelisp, delete FRAME
1833 * unconditionally. x_connection_closed and delete_terminal use this.
1834 * Any other value of FORCE implements the semantics described for
1835 * Fdelete_frame. */
1836 Lisp_Object
1837 delete_frame (Lisp_Object frame, Lisp_Object force)
1839 struct frame *f = decode_any_frame (frame);
1840 struct frame *sf;
1841 struct kboard *kb;
1842 Lisp_Object frames, frame1;
1843 int minibuffer_selected, is_tooltip_frame;
1844 bool nochild = !FRAME_PARENT_FRAME (f);
1846 if (!FRAME_LIVE_P (f))
1847 return Qnil;
1848 else if (!EQ (force, Qnoelisp) && !other_frames (f, false, !NILP (force)))
1850 if (NILP (force))
1851 error ("Attempt to delete the sole visible or iconified frame");
1852 else
1853 error ("Attempt to delete the only frame");
1856 XSETFRAME (frame, f);
1858 /* Softly delete all frames with this frame as their parent frame or
1859 as their `delete-before' frame parameter value. */
1860 FOR_EACH_FRAME (frames, frame1)
1861 if (FRAME_PARENT_FRAME (XFRAME (frame1)) == f
1862 /* Process `delete-before' parameter iff FRAME is not a child
1863 frame. This avoids that we enter an infinite chain of mixed
1864 dependencies. */
1865 || (nochild
1866 && EQ (get_frame_param (XFRAME (frame1), Qdelete_before), frame)))
1867 delete_frame (frame1, Qnil);
1869 /* Does this frame have a minibuffer, and is it the surrogate
1870 minibuffer for any other frame? */
1871 if (FRAME_HAS_MINIBUF_P (f))
1873 FOR_EACH_FRAME (frames, frame1)
1875 Lisp_Object fminiw;
1877 if (EQ (frame1, frame))
1878 continue;
1880 fminiw = FRAME_MINIBUF_WINDOW (XFRAME (frame1));
1882 if (WINDOWP (fminiw) && EQ (frame, WINDOW_FRAME (XWINDOW (fminiw))))
1884 /* If we MUST delete this frame, delete the other first.
1885 But do this only if FORCE equals `noelisp'. */
1886 if (EQ (force, Qnoelisp))
1887 delete_frame (frame1, Qnoelisp);
1888 else
1889 error ("Attempt to delete a surrogate minibuffer frame");
1894 is_tooltip_frame = !NILP (Fframe_parameter (frame, Qtooltip));
1896 /* Run `delete-frame-functions' unless FORCE is `noelisp' or
1897 frame is a tooltip. FORCE is set to `noelisp' when handling
1898 a disconnect from the terminal, so we don't dare call Lisp
1899 code. */
1900 if (NILP (Vrun_hooks) || is_tooltip_frame)
1902 else if (EQ (force, Qnoelisp))
1903 pending_funcalls
1904 = Fcons (list3 (Qrun_hook_with_args, Qdelete_frame_functions, frame),
1905 pending_funcalls);
1906 else
1908 #ifdef HAVE_X_WINDOWS
1909 /* Also, save clipboard to the clipboard manager. */
1910 x_clipboard_manager_save_frame (frame);
1911 #endif
1913 safe_call2 (Qrun_hook_with_args, Qdelete_frame_functions, frame);
1916 /* delete_frame_functions may have deleted any frame, including this
1917 one. */
1918 if (!FRAME_LIVE_P (f))
1919 return Qnil;
1920 else if (!EQ (force, Qnoelisp) && !other_frames (f, false, !NILP (force)))
1922 if (NILP (force))
1923 error ("Attempt to delete the sole visible or iconified frame");
1924 else
1925 error ("Attempt to delete the only frame");
1928 /* At this point, we are committed to deleting the frame.
1929 There is no more chance for errors to prevent it. */
1930 minibuffer_selected = EQ (minibuf_window, selected_window);
1931 sf = SELECTED_FRAME ();
1932 /* Don't let the frame remain selected. */
1933 if (f == sf)
1935 Lisp_Object tail;
1936 Lisp_Object frame1 UNINIT; /* This line works around GCC bug 85563. */
1937 eassume (CONSP (Vframe_list));
1939 /* Look for another visible frame on the same terminal.
1940 Do not call next_frame here because it may loop forever.
1941 See https://debbugs.gnu.org/cgi/bugreport.cgi?bug=15025. */
1942 FOR_EACH_FRAME (tail, frame1)
1943 if (!EQ (frame, frame1)
1944 && NILP (Fframe_parameter (frame1, Qtooltip))
1945 && (FRAME_TERMINAL (XFRAME (frame))
1946 == FRAME_TERMINAL (XFRAME (frame1)))
1947 && FRAME_VISIBLE_P (XFRAME (frame1)))
1948 break;
1950 /* If there is none, find *some* other frame. */
1951 if (NILP (frame1) || EQ (frame1, frame))
1953 FOR_EACH_FRAME (tail, frame1)
1955 if (!EQ (frame, frame1)
1956 && FRAME_LIVE_P (XFRAME (frame1))
1957 && NILP (Fframe_parameter (frame1, Qtooltip)))
1959 /* Do not change a text terminal's top-frame. */
1960 struct frame *f1 = XFRAME (frame1);
1961 if (FRAME_TERMCAP_P (f1) || FRAME_MSDOS_P (f1))
1963 Lisp_Object top_frame = FRAME_TTY (f1)->top_frame;
1964 if (!EQ (top_frame, frame))
1965 frame1 = top_frame;
1967 break;
1971 #ifdef NS_IMPL_COCOA
1972 else
1973 /* Under NS, there is no system mechanism for choosing a new
1974 window to get focus -- it is left to application code.
1975 So the portion of THIS application interfacing with NS
1976 needs to know about it. We call Fraise_frame, but the
1977 purpose is really to transfer focus. */
1978 Fraise_frame (frame1);
1979 #endif
1981 do_switch_frame (frame1, 0, 1, Qnil);
1982 sf = SELECTED_FRAME ();
1985 /* Don't allow minibuf_window to remain on a deleted frame. */
1986 check_minibuf_window (frame, minibuffer_selected);
1988 /* Don't let echo_area_window to remain on a deleted frame. */
1989 if (EQ (f->minibuffer_window, echo_area_window))
1990 echo_area_window = sf->minibuffer_window;
1992 /* Clear any X selections for this frame. */
1993 #ifdef HAVE_X_WINDOWS
1994 if (FRAME_X_P (f))
1995 x_clear_frame_selections (f);
1996 #endif
1998 /* Free glyphs.
1999 This function must be called before the window tree of the
2000 frame is deleted because windows contain dynamically allocated
2001 memory. */
2002 free_glyphs (f);
2004 #ifdef HAVE_WINDOW_SYSTEM
2005 /* Give chance to each font driver to free a frame specific data. */
2006 font_update_drivers (f, Qnil);
2007 #endif
2009 /* Mark all the windows that used to be on FRAME as deleted, and then
2010 remove the reference to them. */
2011 delete_all_child_windows (f->root_window);
2012 fset_root_window (f, Qnil);
2014 Vframe_list = Fdelq (frame, Vframe_list);
2015 SET_FRAME_VISIBLE (f, 0);
2017 /* Allow the vector of menu bar contents to be freed in the next
2018 garbage collection. The frame object itself may not be garbage
2019 collected until much later, because recent_keys and other data
2020 structures can still refer to it. */
2021 fset_menu_bar_vector (f, Qnil);
2023 /* If FRAME's buffer lists contains killed
2024 buffers, this helps GC to reclaim them. */
2025 fset_buffer_list (f, Qnil);
2026 fset_buried_buffer_list (f, Qnil);
2028 free_font_driver_list (f);
2029 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2030 xfree (f->namebuf);
2031 #endif
2032 xfree (f->decode_mode_spec_buffer);
2033 xfree (FRAME_INSERT_COST (f));
2034 xfree (FRAME_DELETEN_COST (f));
2035 xfree (FRAME_INSERTN_COST (f));
2036 xfree (FRAME_DELETE_COST (f));
2038 /* Since some events are handled at the interrupt level, we may get
2039 an event for f at any time; if we zero out the frame's terminal
2040 now, then we may trip up the event-handling code. Instead, we'll
2041 promise that the terminal of the frame must be valid until we
2042 have called the window-system-dependent frame destruction
2043 routine. */
2045 struct terminal *terminal;
2046 block_input ();
2047 if (FRAME_TERMINAL (f)->delete_frame_hook)
2048 (*FRAME_TERMINAL (f)->delete_frame_hook) (f);
2049 terminal = FRAME_TERMINAL (f);
2050 f->output_data.nothing = 0;
2051 f->terminal = 0; /* Now the frame is dead. */
2052 unblock_input ();
2054 /* If needed, delete the terminal that this frame was on.
2055 (This must be done after the frame is killed.) */
2056 terminal->reference_count--;
2057 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
2058 /* FIXME: Deleting the terminal crashes emacs because of a GTK
2059 bug.
2060 https://lists.gnu.org/r/emacs-devel/2011-10/msg00363.html */
2062 /* Since a similar behavior was observed on the Lucid and Motif
2063 builds (see Bug#5802, Bug#21509, Bug#23499, Bug#27816), we now
2064 don't delete the terminal for these builds either. */
2065 if (terminal->reference_count == 0 && terminal->type == output_x_window)
2066 terminal->reference_count = 1;
2067 #endif /* USE_X_TOOLKIT || USE_GTK */
2068 if (terminal->reference_count == 0)
2070 Lisp_Object tmp;
2071 XSETTERMINAL (tmp, terminal);
2073 kb = NULL;
2074 Fdelete_terminal (tmp, NILP (force) ? Qt : force);
2076 else
2077 kb = terminal->kboard;
2080 /* If we've deleted the last_nonminibuf_frame, then try to find
2081 another one. */
2082 if (f == last_nonminibuf_frame)
2084 last_nonminibuf_frame = 0;
2086 FOR_EACH_FRAME (frames, frame1)
2088 struct frame *f1 = XFRAME (frame1);
2090 if (!FRAME_MINIBUF_ONLY_P (f1))
2092 last_nonminibuf_frame = f1;
2093 break;
2098 /* If there's no other frame on the same kboard, get out of
2099 single-kboard state if we're in it for this kboard. */
2100 if (kb != NULL)
2102 /* Some frame we found on the same kboard, or nil if there are none. */
2103 Lisp_Object frame_on_same_kboard = Qnil;
2105 FOR_EACH_FRAME (frames, frame1)
2106 if (kb == FRAME_KBOARD (XFRAME (frame1)))
2107 frame_on_same_kboard = frame1;
2109 if (NILP (frame_on_same_kboard))
2110 not_single_kboard_state (kb);
2114 /* If we've deleted this keyboard's default_minibuffer_frame, try to
2115 find another one. Prefer minibuffer-only frames, but also notice
2116 frames with other windows. */
2117 if (kb != NULL && EQ (frame, KVAR (kb, Vdefault_minibuffer_frame)))
2119 /* The last frame we saw with a minibuffer, minibuffer-only or not. */
2120 Lisp_Object frame_with_minibuf = Qnil;
2121 /* Some frame we found on the same kboard, or nil if there are none. */
2122 Lisp_Object frame_on_same_kboard = Qnil;
2124 FOR_EACH_FRAME (frames, frame1)
2126 struct frame *f1 = XFRAME (frame1);
2128 /* Consider only frames on the same kboard
2129 and only those with minibuffers. */
2130 if (kb == FRAME_KBOARD (f1)
2131 && FRAME_HAS_MINIBUF_P (f1))
2133 frame_with_minibuf = frame1;
2134 if (FRAME_MINIBUF_ONLY_P (f1))
2135 break;
2138 if (kb == FRAME_KBOARD (f1))
2139 frame_on_same_kboard = frame1;
2142 if (!NILP (frame_on_same_kboard))
2144 /* We know that there must be some frame with a minibuffer out
2145 there. If this were not true, all of the frames present
2146 would have to be minibufferless, which implies that at some
2147 point their minibuffer frames must have been deleted, but
2148 that is prohibited at the top; you can't delete surrogate
2149 minibuffer frames. */
2150 if (NILP (frame_with_minibuf))
2151 emacs_abort ();
2153 kset_default_minibuffer_frame (kb, frame_with_minibuf);
2155 else
2156 /* No frames left on this kboard--say no minibuffer either. */
2157 kset_default_minibuffer_frame (kb, Qnil);
2160 /* Cause frame titles to update--necessary if we now have just one frame. */
2161 if (!is_tooltip_frame)
2162 update_mode_lines = 15;
2164 return Qnil;
2167 DEFUN ("delete-frame", Fdelete_frame, Sdelete_frame, 0, 2, "",
2168 doc: /* Delete FRAME, permanently eliminating it from use.
2169 FRAME must be a live frame and defaults to the selected one.
2171 A frame may not be deleted if its minibuffer serves as surrogate
2172 minibuffer for another frame. Normally, you may not delete a frame if
2173 all other frames are invisible, but if the second optional argument
2174 FORCE is non-nil, you may do so.
2176 This function runs `delete-frame-functions' before actually
2177 deleting the frame, unless the frame is a tooltip.
2178 The functions are run with one argument, the frame to be deleted. */)
2179 (Lisp_Object frame, Lisp_Object force)
2181 return delete_frame (frame, !NILP (force) ? Qt : Qnil);
2184 #ifdef HAVE_WINDOW_SYSTEM
2186 * frame_internal_border_part:
2188 * Return part of internal border the coordinates X and Y relative to
2189 * frame F are on. Return nil if the coordinates are not on the
2190 * internal border of F.
2192 * Return one of INTERNAL_BORDER_LEFT_EDGE, INTERNAL_BORDER_TOP_EDGE,
2193 * INTERNAL_BORDER_RIGHT_EDGE or INTERNAL_BORDER_BOTTOM_EDGE when the
2194 * mouse cursor is on the corresponding border with an offset of at
2195 * least one canonical character height from that border's edges.
2197 * If no border part could be found this way, return one of
2198 * INTERNAL_BORDER_TOP_LEFT_CORNER, INTERNAL_BORDER_TOP_RIGHT_CORNER,
2199 * INTERNAL_BORDER_BOTTOM_LEFT_CORNER or
2200 * INTERNAL_BORDER_BOTTOM_RIGHT_CORNER to indicate that the mouse is in
2201 * one of the corresponding corners. This means that for very small
2202 * frames an `edge' return value is preferred.
2204 enum internal_border_part
2205 frame_internal_border_part (struct frame *f, int x, int y)
2207 int border = FRAME_INTERNAL_BORDER_WIDTH (f);
2208 int offset = FRAME_LINE_HEIGHT (f);
2209 int width = FRAME_PIXEL_WIDTH (f);
2210 int height = FRAME_PIXEL_HEIGHT (f);
2211 enum internal_border_part part = INTERNAL_BORDER_NONE;
2213 if (offset < border)
2214 /* For very wide borders make offset at least as large as
2215 border. */
2216 offset = border;
2218 if (offset < x && x < width - offset)
2219 /* Top or bottom border. */
2221 if (0 <= y && y <= border)
2222 part = INTERNAL_BORDER_TOP_EDGE;
2223 else if (height - border <= y && y <= height)
2224 part = INTERNAL_BORDER_BOTTOM_EDGE;
2226 else if (offset < y && y < height - offset)
2227 /* Left or right border. */
2229 if (0 <= x && x <= border)
2230 part = INTERNAL_BORDER_LEFT_EDGE;
2231 else if (width - border <= x && x <= width)
2232 part = INTERNAL_BORDER_RIGHT_EDGE;
2234 else
2236 /* An edge. */
2237 int half_width = width / 2;
2238 int half_height = height / 2;
2240 if (0 <= x && x <= border)
2242 /* A left edge. */
2243 if (0 <= y && y <= half_height)
2244 part = INTERNAL_BORDER_TOP_LEFT_CORNER;
2245 else if (half_height < y && y <= height)
2246 part = INTERNAL_BORDER_BOTTOM_LEFT_CORNER;
2248 else if (width - border <= x && x <= width)
2250 /* A right edge. */
2251 if (0 <= y && y <= half_height)
2252 part = INTERNAL_BORDER_TOP_RIGHT_CORNER;
2253 else if (half_height < y && y <= height)
2254 part = INTERNAL_BORDER_BOTTOM_RIGHT_CORNER;
2256 else if (0 <= y && y <= border)
2258 /* A top edge. */
2259 if (0 <= x && x <= half_width)
2260 part = INTERNAL_BORDER_TOP_LEFT_CORNER;
2261 else if (half_width < x && x <= width)
2262 part = INTERNAL_BORDER_TOP_RIGHT_CORNER;
2264 else if (height - border <= y && y <= height)
2266 /* A bottom edge. */
2267 if (0 <= x && x <= half_width)
2268 part = INTERNAL_BORDER_BOTTOM_LEFT_CORNER;
2269 else if (half_width < x && x <= width)
2270 part = INTERNAL_BORDER_BOTTOM_RIGHT_CORNER;
2274 return part;
2276 #endif
2278 /* Return mouse position in character cell units. */
2280 DEFUN ("mouse-position", Fmouse_position, Smouse_position, 0, 0, 0,
2281 doc: /* Return a list (FRAME X . Y) giving the current mouse frame and position.
2282 The position is given in canonical character cells, where (0, 0) is the
2283 upper-left corner of the frame, X is the horizontal offset, and Y is the
2284 vertical offset, measured in units of the frame's default character size.
2285 If Emacs is running on a mouseless terminal or hasn't been programmed
2286 to read the mouse position, it returns the selected frame for FRAME
2287 and nil for X and Y.
2288 If `mouse-position-function' is non-nil, `mouse-position' calls it,
2289 passing the normal return value to that function as an argument,
2290 and returns whatever that function returns. */)
2291 (void)
2293 struct frame *f;
2294 Lisp_Object lispy_dummy;
2295 Lisp_Object x, y, retval;
2297 f = SELECTED_FRAME ();
2298 x = y = Qnil;
2300 /* It's okay for the hook to refrain from storing anything. */
2301 if (FRAME_TERMINAL (f)->mouse_position_hook)
2303 enum scroll_bar_part party_dummy;
2304 Time time_dummy;
2305 (*FRAME_TERMINAL (f)->mouse_position_hook) (&f, -1,
2306 &lispy_dummy, &party_dummy,
2307 &x, &y,
2308 &time_dummy);
2311 if (! NILP (x))
2313 int col = XINT (x);
2314 int row = XINT (y);
2315 pixel_to_glyph_coords (f, col, row, &col, &row, NULL, 1);
2316 XSETINT (x, col);
2317 XSETINT (y, row);
2319 XSETFRAME (lispy_dummy, f);
2320 retval = Fcons (lispy_dummy, Fcons (x, y));
2321 if (!NILP (Vmouse_position_function))
2322 retval = call1 (Vmouse_position_function, retval);
2323 return retval;
2326 DEFUN ("mouse-pixel-position", Fmouse_pixel_position,
2327 Smouse_pixel_position, 0, 0, 0,
2328 doc: /* Return a list (FRAME X . Y) giving the current mouse frame and position.
2329 The position is given in pixel units, where (0, 0) is the
2330 upper-left corner of the frame, X is the horizontal offset, and Y is
2331 the vertical offset.
2332 If Emacs is running on a mouseless terminal or hasn't been programmed
2333 to read the mouse position, it returns the selected frame for FRAME
2334 and nil for X and Y. */)
2335 (void)
2337 struct frame *f;
2338 Lisp_Object lispy_dummy;
2339 Lisp_Object x, y, retval;
2341 f = SELECTED_FRAME ();
2342 x = y = Qnil;
2344 /* It's okay for the hook to refrain from storing anything. */
2345 if (FRAME_TERMINAL (f)->mouse_position_hook)
2347 enum scroll_bar_part party_dummy;
2348 Time time_dummy;
2349 (*FRAME_TERMINAL (f)->mouse_position_hook) (&f, -1,
2350 &lispy_dummy, &party_dummy,
2351 &x, &y,
2352 &time_dummy);
2355 XSETFRAME (lispy_dummy, f);
2356 retval = Fcons (lispy_dummy, Fcons (x, y));
2357 if (!NILP (Vmouse_position_function))
2358 retval = call1 (Vmouse_position_function, retval);
2359 return retval;
2362 #ifdef HAVE_WINDOW_SYSTEM
2364 /* On frame F, convert character coordinates X and Y to pixel
2365 coordinates *PIX_X and *PIX_Y. */
2367 static void
2368 frame_char_to_pixel_position (struct frame *f, int x, int y,
2369 int *pix_x, int *pix_y)
2371 *pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
2372 *pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
2374 if (*pix_x < 0)
2375 *pix_x = 0;
2376 if (*pix_x > FRAME_PIXEL_WIDTH (f))
2377 *pix_x = FRAME_PIXEL_WIDTH (f);
2379 if (*pix_y < 0)
2380 *pix_y = 0;
2381 if (*pix_y > FRAME_PIXEL_HEIGHT (f))
2382 *pix_y = FRAME_PIXEL_HEIGHT (f);
2385 /* On frame F, reposition mouse pointer to character coordinates X and Y. */
2387 static void
2388 frame_set_mouse_position (struct frame *f, int x, int y)
2390 int pix_x, pix_y;
2392 frame_char_to_pixel_position (f, x, y, &pix_x, &pix_y);
2393 frame_set_mouse_pixel_position (f, pix_x, pix_y);
2396 #endif /* HAVE_WINDOW_SYSTEM */
2398 DEFUN ("set-mouse-position", Fset_mouse_position, Sset_mouse_position, 3, 3, 0,
2399 doc: /* Move the mouse pointer to the center of character cell (X,Y) in FRAME.
2400 Coordinates are relative to the frame, not a window,
2401 so the coordinates of the top left character in the frame
2402 may be nonzero due to left-hand scroll bars or the menu bar.
2404 The position is given in canonical character cells, where (0, 0) is
2405 the upper-left corner of the frame, X is the horizontal offset, and
2406 Y is the vertical offset, measured in units of the frame's default
2407 character size.
2409 This function is a no-op for an X frame that is not visible.
2410 If you have just created a frame, you must wait for it to become visible
2411 before calling this function on it, like this.
2412 (while (not (frame-visible-p frame)) (sleep-for .5)) */)
2413 (Lisp_Object frame, Lisp_Object x, Lisp_Object y)
2415 CHECK_LIVE_FRAME (frame);
2416 CHECK_TYPE_RANGED_INTEGER (int, x);
2417 CHECK_TYPE_RANGED_INTEGER (int, y);
2419 /* I think this should be done with a hook. */
2420 #ifdef HAVE_WINDOW_SYSTEM
2421 if (FRAME_WINDOW_P (XFRAME (frame)))
2422 /* Warping the mouse will cause enternotify and focus events. */
2423 frame_set_mouse_position (XFRAME (frame), XINT (x), XINT (y));
2424 #else
2425 #if defined (MSDOS)
2426 if (FRAME_MSDOS_P (XFRAME (frame)))
2428 Fselect_frame (frame, Qnil);
2429 mouse_moveto (XINT (x), XINT (y));
2431 #else
2432 #ifdef HAVE_GPM
2434 Fselect_frame (frame, Qnil);
2435 term_mouse_moveto (XINT (x), XINT (y));
2437 #endif
2438 #endif
2439 #endif
2441 return Qnil;
2444 DEFUN ("set-mouse-pixel-position", Fset_mouse_pixel_position,
2445 Sset_mouse_pixel_position, 3, 3, 0,
2446 doc: /* Move the mouse pointer to pixel position (X,Y) in FRAME.
2447 The position is given in pixels, where (0, 0) is the upper-left corner
2448 of the frame, X is the horizontal offset, and Y is the vertical offset.
2450 Note, this is a no-op for an X frame that is not visible.
2451 If you have just created a frame, you must wait for it to become visible
2452 before calling this function on it, like this.
2453 (while (not (frame-visible-p frame)) (sleep-for .5)) */)
2454 (Lisp_Object frame, Lisp_Object x, Lisp_Object y)
2456 CHECK_LIVE_FRAME (frame);
2457 CHECK_TYPE_RANGED_INTEGER (int, x);
2458 CHECK_TYPE_RANGED_INTEGER (int, y);
2460 /* I think this should be done with a hook. */
2461 #ifdef HAVE_WINDOW_SYSTEM
2462 if (FRAME_WINDOW_P (XFRAME (frame)))
2463 /* Warping the mouse will cause enternotify and focus events. */
2464 frame_set_mouse_pixel_position (XFRAME (frame), XINT (x), XINT (y));
2465 #else
2466 #if defined (MSDOS)
2467 if (FRAME_MSDOS_P (XFRAME (frame)))
2469 Fselect_frame (frame, Qnil);
2470 mouse_moveto (XINT (x), XINT (y));
2472 #else
2473 #ifdef HAVE_GPM
2475 Fselect_frame (frame, Qnil);
2476 term_mouse_moveto (XINT (x), XINT (y));
2478 #endif
2479 #endif
2480 #endif
2482 return Qnil;
2485 static void make_frame_visible_1 (Lisp_Object);
2487 DEFUN ("make-frame-visible", Fmake_frame_visible, Smake_frame_visible,
2488 0, 1, "",
2489 doc: /* Make the frame FRAME visible (assuming it is an X window).
2490 If omitted, FRAME defaults to the currently selected frame. */)
2491 (Lisp_Object frame)
2493 struct frame *f = decode_live_frame (frame);
2495 /* I think this should be done with a hook. */
2496 #ifdef HAVE_WINDOW_SYSTEM
2497 if (FRAME_WINDOW_P (f))
2498 x_make_frame_visible (f);
2499 #endif
2501 make_frame_visible_1 (f->root_window);
2503 /* Make menu bar update for the Buffers and Frames menus. */
2504 /* windows_or_buffers_changed = 15; FIXME: Why? */
2506 XSETFRAME (frame, f);
2507 return frame;
2510 /* Update the display_time slot of the buffers shown in WINDOW
2511 and all its descendants. */
2513 static void
2514 make_frame_visible_1 (Lisp_Object window)
2516 struct window *w;
2518 for (; !NILP (window); window = w->next)
2520 w = XWINDOW (window);
2521 if (WINDOWP (w->contents))
2522 make_frame_visible_1 (w->contents);
2523 else
2524 bset_display_time (XBUFFER (w->contents), Fcurrent_time ());
2528 DEFUN ("make-frame-invisible", Fmake_frame_invisible, Smake_frame_invisible,
2529 0, 2, "",
2530 doc: /* Make the frame FRAME invisible.
2531 If omitted, FRAME defaults to the currently selected frame.
2532 On graphical displays, invisible frames are not updated and are
2533 usually not displayed at all, even in a window system's \"taskbar\".
2535 Normally you may not make FRAME invisible if all other frames are invisible,
2536 but if the second optional argument FORCE is non-nil, you may do so.
2538 This function has no effect on text terminal frames. Such frames are
2539 always considered visible, whether or not they are currently being
2540 displayed in the terminal. */)
2541 (Lisp_Object frame, Lisp_Object force)
2543 struct frame *f = decode_live_frame (frame);
2545 if (NILP (force) && !other_frames (f, true, false))
2546 error ("Attempt to make invisible the sole visible or iconified frame");
2548 /* Don't allow minibuf_window to remain on an invisible frame. */
2549 check_minibuf_window (frame, EQ (minibuf_window, selected_window));
2551 /* I think this should be done with a hook. */
2552 #ifdef HAVE_WINDOW_SYSTEM
2553 if (FRAME_WINDOW_P (f))
2554 x_make_frame_invisible (f);
2555 #endif
2557 /* Make menu bar update for the Buffers and Frames menus. */
2558 windows_or_buffers_changed = 16;
2560 return Qnil;
2563 DEFUN ("iconify-frame", Ficonify_frame, Siconify_frame,
2564 0, 1, "",
2565 doc: /* Make the frame FRAME into an icon.
2566 If omitted, FRAME defaults to the currently selected frame.
2568 If FRAME is a child frame, consult the variable `iconify-child-frame'
2569 for how to proceed. */)
2570 (Lisp_Object frame)
2572 struct frame *f = decode_live_frame (frame);
2573 #ifdef HAVE_WINDOW_SYSTEM
2574 Lisp_Object parent = f->parent_frame;
2576 if (!NILP (parent))
2578 if (NILP (iconify_child_frame))
2579 /* Do nothing. */
2580 return Qnil;
2581 else if (EQ (iconify_child_frame, Qiconify_top_level))
2583 /* Iconify top level frame instead (the default). */
2584 Ficonify_frame (parent);
2585 return Qnil;
2587 else if (EQ (iconify_child_frame, Qmake_invisible))
2589 /* Make frame invisible instead. */
2590 Fmake_frame_invisible (frame, Qnil);
2591 return Qnil;
2594 #endif /* HAVE_WINDOW_SYSTEM */
2596 /* Don't allow minibuf_window to remain on an iconified frame. */
2597 check_minibuf_window (frame, EQ (minibuf_window, selected_window));
2599 /* I think this should be done with a hook. */
2600 if (FRAME_WINDOW_P (f))
2602 #ifdef HAVE_WINDOW_SYSTEM
2603 x_iconify_frame (f);
2604 #endif
2607 return Qnil;
2610 DEFUN ("frame-visible-p", Fframe_visible_p, Sframe_visible_p,
2611 1, 1, 0,
2612 doc: /* Return t if FRAME is \"visible\" (actually in use for display).
2613 Return the symbol `icon' if FRAME is iconified or \"minimized\".
2614 Return nil if FRAME was made invisible, via `make-frame-invisible'.
2615 On graphical displays, invisible frames are not updated and are
2616 usually not displayed at all, even in a window system's \"taskbar\".
2618 If FRAME is a text terminal frame, this always returns t.
2619 Such frames are always considered visible, whether or not they are
2620 currently being displayed on the terminal. */)
2621 (Lisp_Object frame)
2623 CHECK_LIVE_FRAME (frame);
2625 if (FRAME_VISIBLE_P (XFRAME (frame)))
2626 return Qt;
2627 if (FRAME_ICONIFIED_P (XFRAME (frame)))
2628 return Qicon;
2629 return Qnil;
2632 DEFUN ("visible-frame-list", Fvisible_frame_list, Svisible_frame_list,
2633 0, 0, 0,
2634 doc: /* Return a list of all frames now \"visible\" (being updated). */)
2635 (void)
2637 Lisp_Object tail, frame, value = Qnil;
2639 FOR_EACH_FRAME (tail, frame)
2640 if (FRAME_VISIBLE_P (XFRAME (frame)))
2641 value = Fcons (frame, value);
2643 return value;
2647 DEFUN ("raise-frame", Fraise_frame, Sraise_frame, 0, 1, "",
2648 doc: /* Bring FRAME to the front, so it occludes any frames it overlaps.
2649 If FRAME is invisible or iconified, make it visible.
2650 If you don't specify a frame, the selected frame is used.
2651 If Emacs is displaying on an ordinary terminal or some other device which
2652 doesn't support multiple overlapping frames, this function selects FRAME. */)
2653 (Lisp_Object frame)
2655 struct frame *f = decode_live_frame (frame);
2657 XSETFRAME (frame, f);
2659 if (FRAME_TERMCAP_P (f))
2660 /* On a text terminal select FRAME. */
2661 Fselect_frame (frame, Qnil);
2662 else
2663 /* Do like the documentation says. */
2664 Fmake_frame_visible (frame);
2666 if (FRAME_TERMINAL (f)->frame_raise_lower_hook)
2667 (*FRAME_TERMINAL (f)->frame_raise_lower_hook) (f, 1);
2669 return Qnil;
2672 /* Should we have a corresponding function called Flower_Power? */
2673 DEFUN ("lower-frame", Flower_frame, Slower_frame, 0, 1, "",
2674 doc: /* Send FRAME to the back, so it is occluded by any frames that overlap it.
2675 If you don't specify a frame, the selected frame is used.
2676 If Emacs is displaying on an ordinary terminal or some other device which
2677 doesn't support multiple overlapping frames, this function does nothing. */)
2678 (Lisp_Object frame)
2680 struct frame *f = decode_live_frame (frame);
2682 if (FRAME_TERMINAL (f)->frame_raise_lower_hook)
2683 (*FRAME_TERMINAL (f)->frame_raise_lower_hook) (f, 0);
2685 return Qnil;
2689 DEFUN ("redirect-frame-focus", Fredirect_frame_focus, Sredirect_frame_focus,
2690 1, 2, 0,
2691 doc: /* Arrange for keystrokes typed at FRAME to be sent to FOCUS-FRAME.
2692 In other words, switch-frame events caused by events in FRAME will
2693 request a switch to FOCUS-FRAME, and `last-event-frame' will be
2694 FOCUS-FRAME after reading an event typed at FRAME.
2696 If FOCUS-FRAME is nil, any existing redirection is canceled, and the
2697 frame again receives its own keystrokes.
2699 Focus redirection is useful for temporarily redirecting keystrokes to
2700 a surrogate minibuffer frame when a frame doesn't have its own
2701 minibuffer window.
2703 A frame's focus redirection can be changed by `select-frame'. If frame
2704 FOO is selected, and then a different frame BAR is selected, any
2705 frames redirecting their focus to FOO are shifted to redirect their
2706 focus to BAR. This allows focus redirection to work properly when the
2707 user switches from one frame to another using `select-window'.
2709 This means that a frame whose focus is redirected to itself is treated
2710 differently from a frame whose focus is redirected to nil; the former
2711 is affected by `select-frame', while the latter is not.
2713 The redirection lasts until `redirect-frame-focus' is called to change it. */)
2714 (Lisp_Object frame, Lisp_Object focus_frame)
2716 /* Note that we don't check for a live frame here. It's reasonable
2717 to redirect the focus of a frame you're about to delete, if you
2718 know what other frame should receive those keystrokes. */
2719 struct frame *f = decode_any_frame (frame);
2721 if (! NILP (focus_frame))
2722 CHECK_LIVE_FRAME (focus_frame);
2724 fset_focus_frame (f, focus_frame);
2726 if (FRAME_TERMINAL (f)->frame_rehighlight_hook)
2727 (*FRAME_TERMINAL (f)->frame_rehighlight_hook) (f);
2729 return Qnil;
2733 DEFUN ("frame-focus", Fframe_focus, Sframe_focus, 0, 1, 0,
2734 doc: /* Return the frame to which FRAME's keystrokes are currently being sent.
2735 If FRAME is omitted or nil, the selected frame is used.
2736 Return nil if FRAME's focus is not redirected.
2737 See `redirect-frame-focus'. */)
2738 (Lisp_Object frame)
2740 return FRAME_FOCUS_FRAME (decode_live_frame (frame));
2743 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 2, 0,
2744 doc: /* Set the input focus to FRAME.
2745 FRAME nil means use the selected frame. Optional argument NOACTIVATE
2746 means do not activate FRAME.
2748 If there is no window system support, this function does nothing. */)
2749 (Lisp_Object frame, Lisp_Object noactivate)
2751 #ifdef HAVE_WINDOW_SYSTEM
2752 x_focus_frame (decode_window_system_frame (frame), !NILP (noactivate));
2753 #endif
2754 return Qnil;
2757 DEFUN ("frame-after-make-frame",
2758 Fframe_after_make_frame,
2759 Sframe_after_make_frame, 2, 2, 0,
2760 doc: /* Mark FRAME as made.
2761 FRAME nil means use the selected frame. Second argument MADE non-nil
2762 means functions on `window-configuration-change-hook' are called
2763 whenever the window configuration of FRAME changes. MADE nil means
2764 these functions are not called.
2766 This function is currently called by `make-frame' only and should be
2767 otherwise used with utter care to avoid that running functions on
2768 `window-configuration-change-hook' is impeded forever. */)
2769 (Lisp_Object frame, Lisp_Object made)
2771 struct frame *f = decode_live_frame (frame);
2772 f->after_make_frame = !NILP (made);
2773 f->inhibit_horizontal_resize = false;
2774 f->inhibit_vertical_resize = false;
2775 return made;
2779 /* Discard BUFFER from the buffer-list and buried-buffer-list of each frame. */
2781 void
2782 frames_discard_buffer (Lisp_Object buffer)
2784 Lisp_Object frame, tail;
2786 FOR_EACH_FRAME (tail, frame)
2788 fset_buffer_list
2789 (XFRAME (frame), Fdelq (buffer, XFRAME (frame)->buffer_list));
2790 fset_buried_buffer_list
2791 (XFRAME (frame), Fdelq (buffer, XFRAME (frame)->buried_buffer_list));
2795 /* Modify the alist in *ALISTPTR to associate PROP with VAL.
2796 If the alist already has an element for PROP, we change it. */
2798 void
2799 store_in_alist (Lisp_Object *alistptr, Lisp_Object prop, Lisp_Object val)
2801 register Lisp_Object tem;
2803 tem = Fassq (prop, *alistptr);
2804 if (EQ (tem, Qnil))
2805 *alistptr = Fcons (Fcons (prop, val), *alistptr);
2806 else
2807 Fsetcdr (tem, val);
2810 static int
2811 frame_name_fnn_p (char *str, ptrdiff_t len)
2813 if (len > 1 && str[0] == 'F' && '0' <= str[1] && str[1] <= '9')
2815 char *p = str + 2;
2816 while ('0' <= *p && *p <= '9')
2817 p++;
2818 if (p == str + len)
2819 return 1;
2821 return 0;
2824 /* Set the name of the terminal frame. Also used by MSDOS frames.
2825 Modeled after x_set_name which is used for WINDOW frames. */
2827 static void
2828 set_term_frame_name (struct frame *f, Lisp_Object name)
2830 f->explicit_name = ! NILP (name);
2832 /* If NAME is nil, set the name to F<num>. */
2833 if (NILP (name))
2835 char namebuf[sizeof "F" + INT_STRLEN_BOUND (printmax_t)];
2837 /* Check for no change needed in this very common case
2838 before we do any consing. */
2839 if (frame_name_fnn_p (SSDATA (f->name), SBYTES (f->name)))
2840 return;
2842 name = make_formatted_string (namebuf, "F%"pMd, ++tty_frame_count);
2844 else
2846 CHECK_STRING (name);
2848 /* Don't change the name if it's already NAME. */
2849 if (! NILP (Fstring_equal (name, f->name)))
2850 return;
2852 /* Don't allow the user to set the frame name to F<num>, so it
2853 doesn't clash with the names we generate for terminal frames. */
2854 if (frame_name_fnn_p (SSDATA (name), SBYTES (name)))
2855 error ("Frame names of the form F<num> are usurped by Emacs");
2858 fset_name (f, name);
2859 update_mode_lines = 16;
2862 void
2863 store_frame_param (struct frame *f, Lisp_Object prop, Lisp_Object val)
2865 register Lisp_Object old_alist_elt;
2867 if (EQ (prop, Qminibuffer))
2869 if (WINDOWP (val))
2871 if (!MINI_WINDOW_P (XWINDOW (val)))
2872 error ("The `minibuffer' parameter does not specify a valid minibuffer window");
2873 else if (FRAME_MINIBUF_ONLY_P (f))
2875 if (EQ (val, FRAME_MINIBUF_WINDOW (f)))
2876 val = Qonly;
2877 else
2878 error ("Can't change the minibuffer window of a minibuffer-only frame");
2880 else if (FRAME_HAS_MINIBUF_P (f))
2882 if (EQ (val, FRAME_MINIBUF_WINDOW (f)))
2883 val = Qt;
2884 else
2885 error ("Can't change the minibuffer window of a frame with its own minibuffer");
2887 else
2888 /* Store the chosen minibuffer window. */
2889 fset_minibuffer_window (f, val);
2891 else
2893 Lisp_Object old_val = Fcdr (Fassq (Qminibuffer, f->param_alist));
2895 if (!NILP (old_val))
2897 if (WINDOWP (old_val) && NILP (val))
2898 /* Don't change the value for a minibuffer-less frame if
2899 only nil was specified as new value. */
2900 val = old_val;
2901 else if (!EQ (old_val, val))
2902 error ("Can't change the `minibuffer' parameter of this frame");
2907 /* Check each parent-frame and delete-before parameter for a
2908 circular dependency. Do not check between parameters, so you can
2909 still create circular dependencies with different properties, for
2910 example a chain of frames F1->F2->...Fn such that F1 is an ancestor
2911 frame of Fn and thus cannot be deleted before Fn and a second chain
2912 Fn->Fn-1->...F1 such that Fn cannot be deleted before F1. */
2913 else if (EQ (prop, Qparent_frame) || EQ (prop, Qdelete_before))
2915 Lisp_Object oldval = Fcdr (Fassq (prop, f->param_alist));
2917 if (!EQ (oldval, val) && !NILP (val))
2919 Lisp_Object frame;
2920 Lisp_Object frame1 = val;
2922 if (!FRAMEP (frame1) || !FRAME_LIVE_P (XFRAME (frame1)))
2923 error ("Invalid `%s' frame parameter",
2924 SSDATA (SYMBOL_NAME (prop)));
2926 XSETFRAME (frame, f);
2928 while (FRAMEP (frame1) && FRAME_LIVE_P (XFRAME (frame1)))
2929 if (EQ (frame1, frame))
2930 error ("Circular specification of `%s' frame parameter",
2931 SSDATA (SYMBOL_NAME (prop)));
2932 else
2933 frame1 = get_frame_param (XFRAME (frame1), prop);
2937 /* The buffer-list parameters are stored in a special place and not
2938 in the alist. All buffers must be live. */
2939 else if (EQ (prop, Qbuffer_list))
2941 Lisp_Object list = Qnil;
2942 for (; CONSP (val); val = XCDR (val))
2943 if (!NILP (Fbuffer_live_p (XCAR (val))))
2944 list = Fcons (XCAR (val), list);
2945 fset_buffer_list (f, Fnreverse (list));
2946 return;
2948 else if (EQ (prop, Qburied_buffer_list))
2950 Lisp_Object list = Qnil;
2951 for (; CONSP (val); val = XCDR (val))
2952 if (!NILP (Fbuffer_live_p (XCAR (val))))
2953 list = Fcons (XCAR (val), list);
2954 fset_buried_buffer_list (f, Fnreverse (list));
2955 return;
2958 /* The tty color needed to be set before the frame's parameter
2959 alist was updated with the new value. This is not true any more,
2960 but we still do this test early on. */
2961 if (FRAME_TERMCAP_P (f) && EQ (prop, Qtty_color_mode)
2962 && f == FRAME_TTY (f)->previous_frame)
2963 /* Force redisplay of this tty. */
2964 FRAME_TTY (f)->previous_frame = NULL;
2966 /* Update the frame parameter alist. */
2967 old_alist_elt = Fassq (prop, f->param_alist);
2968 if (EQ (old_alist_elt, Qnil))
2969 fset_param_alist (f, Fcons (Fcons (prop, val), f->param_alist));
2970 else
2971 Fsetcdr (old_alist_elt, val);
2973 /* Update some other special parameters in their special places
2974 in addition to the alist. */
2976 if (EQ (prop, Qbuffer_predicate))
2977 fset_buffer_predicate (f, val);
2979 if (! FRAME_WINDOW_P (f))
2981 if (EQ (prop, Qmenu_bar_lines))
2982 set_menu_bar_lines (f, val, make_number (FRAME_MENU_BAR_LINES (f)));
2983 else if (EQ (prop, Qname))
2984 set_term_frame_name (f, val);
2988 /* Return color matches UNSPEC on frame F or nil if UNSPEC
2989 is not an unspecified foreground or background color. */
2991 static Lisp_Object
2992 frame_unspecified_color (struct frame *f, Lisp_Object unspec)
2994 return (!strncmp (SSDATA (unspec), unspecified_bg, SBYTES (unspec))
2995 ? tty_color_name (f, FRAME_BACKGROUND_PIXEL (f))
2996 : (!strncmp (SSDATA (unspec), unspecified_fg, SBYTES (unspec))
2997 ? tty_color_name (f, FRAME_FOREGROUND_PIXEL (f)) : Qnil));
3000 DEFUN ("frame-parameters", Fframe_parameters, Sframe_parameters, 0, 1, 0,
3001 doc: /* Return the parameters-alist of frame FRAME.
3002 It is a list of elements of the form (PARM . VALUE), where PARM is a symbol.
3003 The meaningful PARMs depend on the kind of frame.
3004 If FRAME is omitted or nil, return information on the currently selected frame. */)
3005 (Lisp_Object frame)
3007 Lisp_Object alist;
3008 struct frame *f = decode_any_frame (frame);
3009 int height, width;
3011 if (!FRAME_LIVE_P (f))
3012 return Qnil;
3014 alist = Fcopy_alist (f->param_alist);
3016 if (!FRAME_WINDOW_P (f))
3018 Lisp_Object elt;
3020 /* If the frame's parameter alist says the colors are
3021 unspecified and reversed, take the frame's background pixel
3022 for foreground and vice versa. */
3023 elt = Fassq (Qforeground_color, alist);
3024 if (CONSP (elt) && STRINGP (XCDR (elt)))
3026 elt = frame_unspecified_color (f, XCDR (elt));
3027 if (!NILP (elt))
3028 store_in_alist (&alist, Qforeground_color, elt);
3030 else
3031 store_in_alist (&alist, Qforeground_color,
3032 tty_color_name (f, FRAME_FOREGROUND_PIXEL (f)));
3033 elt = Fassq (Qbackground_color, alist);
3034 if (CONSP (elt) && STRINGP (XCDR (elt)))
3036 elt = frame_unspecified_color (f, XCDR (elt));
3037 if (!NILP (elt))
3038 store_in_alist (&alist, Qbackground_color, elt);
3040 else
3041 store_in_alist (&alist, Qbackground_color,
3042 tty_color_name (f, FRAME_BACKGROUND_PIXEL (f)));
3043 store_in_alist (&alist, Qfont,
3044 build_string (FRAME_MSDOS_P (f)
3045 ? "ms-dos"
3046 : FRAME_W32_P (f) ? "w32term"
3047 :"tty"));
3049 store_in_alist (&alist, Qname, f->name);
3050 height = (f->new_height
3051 ? (f->new_pixelwise
3052 ? (f->new_height / FRAME_LINE_HEIGHT (f))
3053 : f->new_height)
3054 : FRAME_LINES (f));
3055 store_in_alist (&alist, Qheight, make_number (height));
3056 width = (f->new_width
3057 ? (f->new_pixelwise
3058 ? (f->new_width / FRAME_COLUMN_WIDTH (f))
3059 : f->new_width)
3060 : FRAME_COLS (f));
3061 store_in_alist (&alist, Qwidth, make_number (width));
3062 store_in_alist (&alist, Qmodeline, (FRAME_WANTS_MODELINE_P (f) ? Qt : Qnil));
3063 store_in_alist (&alist, Qunsplittable, (FRAME_NO_SPLIT_P (f) ? Qt : Qnil));
3064 store_in_alist (&alist, Qbuffer_list, f->buffer_list);
3065 store_in_alist (&alist, Qburied_buffer_list, f->buried_buffer_list);
3067 /* I think this should be done with a hook. */
3068 #ifdef HAVE_WINDOW_SYSTEM
3069 if (FRAME_WINDOW_P (f))
3070 x_report_frame_params (f, &alist);
3071 else
3072 #endif
3074 /* This ought to be correct in f->param_alist for an X frame. */
3075 Lisp_Object lines;
3076 XSETFASTINT (lines, FRAME_MENU_BAR_LINES (f));
3077 store_in_alist (&alist, Qmenu_bar_lines, lines);
3080 return alist;
3084 DEFUN ("frame-parameter", Fframe_parameter, Sframe_parameter, 2, 2, 0,
3085 doc: /* Return FRAME's value for parameter PARAMETER.
3086 If FRAME is nil, describe the currently selected frame. */)
3087 (Lisp_Object frame, Lisp_Object parameter)
3089 struct frame *f = decode_any_frame (frame);
3090 Lisp_Object value = Qnil;
3092 CHECK_SYMBOL (parameter);
3094 XSETFRAME (frame, f);
3096 if (FRAME_LIVE_P (f))
3098 /* Avoid consing in frequent cases. */
3099 if (EQ (parameter, Qname))
3100 value = f->name;
3101 #ifdef HAVE_WINDOW_SYSTEM
3102 /* These are used by vertical motion commands. */
3103 else if (EQ (parameter, Qvertical_scroll_bars))
3104 value = (f->vertical_scroll_bar_type == vertical_scroll_bar_none
3105 ? Qnil
3106 : (f->vertical_scroll_bar_type == vertical_scroll_bar_left
3107 ? Qleft : Qright));
3108 else if (EQ (parameter, Qhorizontal_scroll_bars))
3109 value = f->horizontal_scroll_bars ? Qt : Qnil;
3110 else if (EQ (parameter, Qline_spacing) && f->extra_line_spacing == 0)
3111 /* If this is non-zero, we can't determine whether the user specified
3112 an integer or float value without looking through 'param_alist'. */
3113 value = make_number (0);
3114 else if (EQ (parameter, Qfont) && FRAME_X_P (f))
3115 value = FRAME_FONT (f)->props[FONT_NAME_INDEX];
3116 #endif /* HAVE_WINDOW_SYSTEM */
3117 #ifdef HAVE_X_WINDOWS
3118 else if (EQ (parameter, Qdisplay) && FRAME_X_P (f))
3119 value = XCAR (FRAME_DISPLAY_INFO (f)->name_list_element);
3120 #endif /* HAVE_X_WINDOWS */
3121 else if (EQ (parameter, Qbackground_color)
3122 || EQ (parameter, Qforeground_color))
3124 value = Fassq (parameter, f->param_alist);
3125 if (CONSP (value))
3127 value = XCDR (value);
3128 /* Fframe_parameters puts the actual fg/bg color names,
3129 even if f->param_alist says otherwise. This is
3130 important when param_alist's notion of colors is
3131 "unspecified". We need to do the same here. */
3132 if (STRINGP (value) && !FRAME_WINDOW_P (f))
3134 Lisp_Object tem = frame_unspecified_color (f, value);
3136 if (!NILP (tem))
3137 value = tem;
3140 else
3141 value = Fcdr (Fassq (parameter, Fframe_parameters (frame)));
3143 else if (EQ (parameter, Qdisplay_type)
3144 || EQ (parameter, Qbackground_mode))
3145 value = Fcdr (Fassq (parameter, f->param_alist));
3146 else
3147 /* FIXME: Avoid this code path at all (as well as code duplication)
3148 by sharing more code with Fframe_parameters. */
3149 value = Fcdr (Fassq (parameter, Fframe_parameters (frame)));
3152 return value;
3156 DEFUN ("modify-frame-parameters", Fmodify_frame_parameters,
3157 Smodify_frame_parameters, 2, 2, 0,
3158 doc: /* Modify FRAME according to new values of its parameters in ALIST.
3159 If FRAME is nil, it defaults to the selected frame.
3160 ALIST is an alist of parameters to change and their new values.
3161 Each element of ALIST has the form (PARM . VALUE), where PARM is a symbol.
3162 Which PARMs are meaningful depends on the kind of frame.
3163 The meaningful parameters are acted upon, i.e. the frame is changed
3164 according to their new values, and are also stored in the frame's
3165 parameter list so that `frame-parameters' will return them.
3166 PARMs that are not meaningful are still stored in the frame's parameter
3167 list, but are otherwise ignored. */)
3168 (Lisp_Object frame, Lisp_Object alist)
3170 struct frame *f = decode_live_frame (frame);
3171 Lisp_Object prop, val;
3173 /* I think this should be done with a hook. */
3174 #ifdef HAVE_WINDOW_SYSTEM
3175 if (FRAME_WINDOW_P (f))
3176 x_set_frame_parameters (f, alist);
3177 else
3178 #endif
3179 #ifdef MSDOS
3180 if (FRAME_MSDOS_P (f))
3181 IT_set_frame_parameters (f, alist);
3182 else
3183 #endif
3186 EMACS_INT length = XFASTINT (Flength (alist));
3187 ptrdiff_t i;
3188 Lisp_Object *parms;
3189 Lisp_Object *values;
3190 USE_SAFE_ALLOCA;
3191 SAFE_ALLOCA_LISP (parms, 2 * length);
3192 values = parms + length;
3194 /* Extract parm names and values into those vectors. */
3196 for (i = 0; CONSP (alist); alist = XCDR (alist))
3198 Lisp_Object elt;
3200 elt = XCAR (alist);
3201 parms[i] = Fcar (elt);
3202 values[i] = Fcdr (elt);
3203 i++;
3206 /* Now process them in reverse of specified order. */
3207 while (--i >= 0)
3209 prop = parms[i];
3210 val = values[i];
3211 store_frame_param (f, prop, val);
3213 if (EQ (prop, Qforeground_color)
3214 || EQ (prop, Qbackground_color))
3215 update_face_from_frame_parameter (f, prop, val);
3218 SAFE_FREE ();
3220 return Qnil;
3223 DEFUN ("frame-char-height", Fframe_char_height, Sframe_char_height,
3224 0, 1, 0,
3225 doc: /* Height in pixels of a line in the font in frame FRAME.
3226 If FRAME is omitted or nil, the selected frame is used.
3227 For a terminal frame, the value is always 1. */)
3228 (Lisp_Object frame)
3230 #ifdef HAVE_WINDOW_SYSTEM
3231 struct frame *f = decode_any_frame (frame);
3233 if (FRAME_WINDOW_P (f))
3234 return make_number (FRAME_LINE_HEIGHT (f));
3235 else
3236 #endif
3237 return make_number (1);
3241 DEFUN ("frame-char-width", Fframe_char_width, Sframe_char_width,
3242 0, 1, 0,
3243 doc: /* Width in pixels of characters in the font in frame FRAME.
3244 If FRAME is omitted or nil, the selected frame is used.
3245 On a graphical screen, the width is the standard width of the default font.
3246 For a terminal screen, the value is always 1. */)
3247 (Lisp_Object frame)
3249 #ifdef HAVE_WINDOW_SYSTEM
3250 struct frame *f = decode_any_frame (frame);
3252 if (FRAME_WINDOW_P (f))
3253 return make_number (FRAME_COLUMN_WIDTH (f));
3254 else
3255 #endif
3256 return make_number (1);
3259 DEFUN ("frame-native-width", Fframe_native_width,
3260 Sframe_native_width, 0, 1, 0,
3261 doc: /* Return FRAME's native width in pixels.
3262 For a terminal frame, the result really gives the width in characters.
3263 If FRAME is omitted or nil, the selected frame is used. */)
3264 (Lisp_Object frame)
3266 struct frame *f = decode_any_frame (frame);
3268 #ifdef HAVE_WINDOW_SYSTEM
3269 if (FRAME_WINDOW_P (f))
3270 return make_number (FRAME_PIXEL_WIDTH (f));
3271 else
3272 #endif
3273 return make_number (FRAME_TOTAL_COLS (f));
3276 DEFUN ("frame-native-height", Fframe_native_height,
3277 Sframe_native_height, 0, 1, 0,
3278 doc: /* Return FRAME's native height in pixels.
3279 If FRAME is omitted or nil, the selected frame is used. The exact value
3280 of the result depends on the window-system and toolkit in use:
3282 In the Gtk+ and NS versions, it includes only any window (including the
3283 minibuffer or echo area), mode line, and header line. It does not
3284 include the tool bar or menu bar. With other graphical versions, it may
3285 also include the tool bar and the menu bar.
3287 For a text terminal, it includes the menu bar. In this case, the
3288 result is really in characters rather than pixels (i.e., is identical
3289 to `frame-height'). */)
3290 (Lisp_Object frame)
3292 struct frame *f = decode_any_frame (frame);
3294 #ifdef HAVE_WINDOW_SYSTEM
3295 if (FRAME_WINDOW_P (f))
3296 return make_number (FRAME_PIXEL_HEIGHT (f));
3297 else
3298 #endif
3299 return make_number (FRAME_TOTAL_LINES (f));
3302 DEFUN ("tool-bar-pixel-width", Ftool_bar_pixel_width,
3303 Stool_bar_pixel_width, 0, 1, 0,
3304 doc: /* Return width in pixels of FRAME's tool bar.
3305 The result is greater than zero only when the tool bar is on the left
3306 or right side of FRAME. If FRAME is omitted or nil, the selected frame
3307 is used. */)
3308 (Lisp_Object frame)
3310 #ifdef FRAME_TOOLBAR_WIDTH
3311 struct frame *f = decode_any_frame (frame);
3313 if (FRAME_WINDOW_P (f))
3314 return make_number (FRAME_TOOLBAR_WIDTH (f));
3315 #endif
3316 return make_number (0);
3319 DEFUN ("frame-text-cols", Fframe_text_cols, Sframe_text_cols, 0, 1, 0,
3320 doc: /* Return width in columns of FRAME's text area. */)
3321 (Lisp_Object frame)
3323 return make_number (FRAME_COLS (decode_any_frame (frame)));
3326 DEFUN ("frame-text-lines", Fframe_text_lines, Sframe_text_lines, 0, 1, 0,
3327 doc: /* Return height in lines of FRAME's text area. */)
3328 (Lisp_Object frame)
3330 return make_number (FRAME_LINES (decode_any_frame (frame)));
3333 DEFUN ("frame-total-cols", Fframe_total_cols, Sframe_total_cols, 0, 1, 0,
3334 doc: /* Return number of total columns of FRAME. */)
3335 (Lisp_Object frame)
3337 return make_number (FRAME_TOTAL_COLS (decode_any_frame (frame)));
3340 DEFUN ("frame-total-lines", Fframe_total_lines, Sframe_total_lines, 0, 1, 0,
3341 doc: /* Return number of total lines of FRAME. */)
3342 (Lisp_Object frame)
3344 return make_number (FRAME_TOTAL_LINES (decode_any_frame (frame)));
3347 DEFUN ("frame-text-width", Fframe_text_width, Sframe_text_width, 0, 1, 0,
3348 doc: /* Return text area width of FRAME in pixels. */)
3349 (Lisp_Object frame)
3351 return make_number (FRAME_TEXT_WIDTH (decode_any_frame (frame)));
3354 DEFUN ("frame-text-height", Fframe_text_height, Sframe_text_height, 0, 1, 0,
3355 doc: /* Return text area height of FRAME in pixels. */)
3356 (Lisp_Object frame)
3358 return make_number (FRAME_TEXT_HEIGHT (decode_any_frame (frame)));
3361 DEFUN ("frame-scroll-bar-width", Fscroll_bar_width, Sscroll_bar_width, 0, 1, 0,
3362 doc: /* Return scroll bar width of FRAME in pixels. */)
3363 (Lisp_Object frame)
3365 return make_number (FRAME_SCROLL_BAR_AREA_WIDTH (decode_any_frame (frame)));
3368 DEFUN ("frame-scroll-bar-height", Fscroll_bar_height, Sscroll_bar_height, 0, 1, 0,
3369 doc: /* Return scroll bar height of FRAME in pixels. */)
3370 (Lisp_Object frame)
3372 return make_number (FRAME_SCROLL_BAR_AREA_HEIGHT (decode_any_frame (frame)));
3375 DEFUN ("frame-fringe-width", Ffringe_width, Sfringe_width, 0, 1, 0,
3376 doc: /* Return fringe width of FRAME in pixels. */)
3377 (Lisp_Object frame)
3379 return make_number (FRAME_TOTAL_FRINGE_WIDTH (decode_any_frame (frame)));
3382 DEFUN ("frame-internal-border-width", Fframe_internal_border_width, Sframe_internal_border_width, 0, 1, 0,
3383 doc: /* Return width of FRAME's internal border in pixels. */)
3384 (Lisp_Object frame)
3386 return make_number (FRAME_INTERNAL_BORDER_WIDTH (decode_any_frame (frame)));
3389 DEFUN ("frame-right-divider-width", Fright_divider_width, Sright_divider_width, 0, 1, 0,
3390 doc: /* Return width (in pixels) of vertical window dividers on FRAME. */)
3391 (Lisp_Object frame)
3393 return make_number (FRAME_RIGHT_DIVIDER_WIDTH (decode_any_frame (frame)));
3396 DEFUN ("frame-bottom-divider-width", Fbottom_divider_width, Sbottom_divider_width, 0, 1, 0,
3397 doc: /* Return width (in pixels) of horizontal window dividers on FRAME. */)
3398 (Lisp_Object frame)
3400 return make_number (FRAME_BOTTOM_DIVIDER_WIDTH (decode_any_frame (frame)));
3403 DEFUN ("set-frame-height", Fset_frame_height, Sset_frame_height, 2, 4, 0,
3404 doc: /* Set text height of frame FRAME to HEIGHT lines.
3405 Optional third arg PRETEND non-nil means that redisplay should use
3406 HEIGHT lines but that the idea of the actual height of the frame should
3407 not be changed.
3409 Optional fourth argument PIXELWISE non-nil means that FRAME should be
3410 HEIGHT pixels high. Note: When `frame-resize-pixelwise' is nil, some
3411 window managers may refuse to honor a HEIGHT that is not an integer
3412 multiple of the default frame font height. */)
3413 (Lisp_Object frame, Lisp_Object height, Lisp_Object pretend, Lisp_Object pixelwise)
3415 struct frame *f = decode_live_frame (frame);
3416 int pixel_height;
3418 CHECK_TYPE_RANGED_INTEGER (int, height);
3420 pixel_height = (!NILP (pixelwise)
3421 ? XINT (height)
3422 : XINT (height) * FRAME_LINE_HEIGHT (f));
3423 adjust_frame_size (f, -1, pixel_height, 1, !NILP (pretend), Qheight);
3425 return Qnil;
3428 DEFUN ("set-frame-width", Fset_frame_width, Sset_frame_width, 2, 4, 0,
3429 doc: /* Set text width of frame FRAME to WIDTH columns.
3430 Optional third arg PRETEND non-nil means that redisplay should use WIDTH
3431 columns but that the idea of the actual width of the frame should not
3432 be changed.
3434 Optional fourth argument PIXELWISE non-nil means that FRAME should be
3435 WIDTH pixels wide. Note: When `frame-resize-pixelwise' is nil, some
3436 window managers may refuse to honor a WIDTH that is not an integer
3437 multiple of the default frame font width. */)
3438 (Lisp_Object frame, Lisp_Object width, Lisp_Object pretend, Lisp_Object pixelwise)
3440 struct frame *f = decode_live_frame (frame);
3441 int pixel_width;
3443 CHECK_TYPE_RANGED_INTEGER (int, width);
3445 pixel_width = (!NILP (pixelwise)
3446 ? XINT (width)
3447 : XINT (width) * FRAME_COLUMN_WIDTH (f));
3448 adjust_frame_size (f, pixel_width, -1, 1, !NILP (pretend), Qwidth);
3450 return Qnil;
3453 DEFUN ("set-frame-size", Fset_frame_size, Sset_frame_size, 3, 4, 0,
3454 doc: /* Set text size of FRAME to WIDTH by HEIGHT, measured in characters.
3455 Optional argument PIXELWISE non-nil means to measure in pixels. Note:
3456 When `frame-resize-pixelwise' is nil, some window managers may refuse to
3457 honor a WIDTH that is not an integer multiple of the default frame font
3458 width or a HEIGHT that is not an integer multiple of the default frame
3459 font height. */)
3460 (Lisp_Object frame, Lisp_Object width, Lisp_Object height, Lisp_Object pixelwise)
3462 struct frame *f = decode_live_frame (frame);
3463 int pixel_width, pixel_height;
3465 CHECK_TYPE_RANGED_INTEGER (int, width);
3466 CHECK_TYPE_RANGED_INTEGER (int, height);
3468 pixel_width = (!NILP (pixelwise)
3469 ? XINT (width)
3470 : XINT (width) * FRAME_COLUMN_WIDTH (f));
3471 pixel_height = (!NILP (pixelwise)
3472 ? XINT (height)
3473 : XINT (height) * FRAME_LINE_HEIGHT (f));
3474 adjust_frame_size (f, pixel_width, pixel_height, 1, 0, Qsize);
3476 return Qnil;
3479 DEFUN ("frame-position", Fframe_position,
3480 Sframe_position, 0, 1, 0,
3481 doc: /* Return top left corner of FRAME in pixels.
3482 FRAME must be a live frame and defaults to the selected one. The return
3483 value is a cons (x, y) of the coordinates of the top left corner of
3484 FRAME's outer frame, in pixels relative to an origin (0, 0) of FRAME's
3485 display. */)
3486 (Lisp_Object frame)
3488 register struct frame *f = decode_live_frame (frame);
3490 return Fcons (make_number (f->left_pos), make_number (f->top_pos));
3493 DEFUN ("set-frame-position", Fset_frame_position,
3494 Sset_frame_position, 3, 3, 0,
3495 doc: /* Set position of FRAME to (X, Y).
3496 FRAME must be a live frame and defaults to the selected one. X and Y,
3497 if positive, specify the coordinate of the left and top edge of FRAME's
3498 outer frame in pixels relative to an origin (0, 0) of FRAME's display.
3499 If any of X or Y is negative, it specifies the coordinates of the right
3500 or bottom edge of the outer frame of FRAME relative to the right or
3501 bottom edge of FRAME's display. */)
3502 (Lisp_Object frame, Lisp_Object x, Lisp_Object y)
3504 struct frame *f = decode_live_frame (frame);
3506 CHECK_TYPE_RANGED_INTEGER (int, x);
3507 CHECK_TYPE_RANGED_INTEGER (int, y);
3509 /* I think this should be done with a hook. */
3510 if (FRAME_WINDOW_P (f))
3512 #ifdef HAVE_WINDOW_SYSTEM
3513 x_set_offset (f, XINT (x), XINT (y), 1);
3514 #endif
3517 return Qt;
3520 /***********************************************************************
3521 Frame Parameters
3522 ***********************************************************************/
3524 /* Connect the frame-parameter names for X frames
3525 to the ways of passing the parameter values to the window system.
3527 The name of a parameter, as a Lisp symbol,
3528 has an `x-frame-parameter' property which is an integer in Lisp
3529 that is an index in this table. */
3531 struct frame_parm_table {
3532 const char *name;
3533 int sym;
3536 static const struct frame_parm_table frame_parms[] =
3538 {"auto-raise", SYMBOL_INDEX (Qauto_raise)},
3539 {"auto-lower", SYMBOL_INDEX (Qauto_lower)},
3540 {"background-color", -1},
3541 {"border-color", SYMBOL_INDEX (Qborder_color)},
3542 {"border-width", SYMBOL_INDEX (Qborder_width)},
3543 {"cursor-color", SYMBOL_INDEX (Qcursor_color)},
3544 {"cursor-type", SYMBOL_INDEX (Qcursor_type)},
3545 {"font", -1},
3546 {"foreground-color", -1},
3547 {"icon-name", SYMBOL_INDEX (Qicon_name)},
3548 {"icon-type", SYMBOL_INDEX (Qicon_type)},
3549 {"internal-border-width", SYMBOL_INDEX (Qinternal_border_width)},
3550 {"right-divider-width", SYMBOL_INDEX (Qright_divider_width)},
3551 {"bottom-divider-width", SYMBOL_INDEX (Qbottom_divider_width)},
3552 {"menu-bar-lines", SYMBOL_INDEX (Qmenu_bar_lines)},
3553 {"mouse-color", SYMBOL_INDEX (Qmouse_color)},
3554 {"name", SYMBOL_INDEX (Qname)},
3555 {"scroll-bar-width", SYMBOL_INDEX (Qscroll_bar_width)},
3556 {"scroll-bar-height", SYMBOL_INDEX (Qscroll_bar_height)},
3557 {"title", SYMBOL_INDEX (Qtitle)},
3558 {"unsplittable", SYMBOL_INDEX (Qunsplittable)},
3559 {"vertical-scroll-bars", SYMBOL_INDEX (Qvertical_scroll_bars)},
3560 {"horizontal-scroll-bars", SYMBOL_INDEX (Qhorizontal_scroll_bars)},
3561 {"visibility", SYMBOL_INDEX (Qvisibility)},
3562 {"tool-bar-lines", SYMBOL_INDEX (Qtool_bar_lines)},
3563 {"scroll-bar-foreground", SYMBOL_INDEX (Qscroll_bar_foreground)},
3564 {"scroll-bar-background", SYMBOL_INDEX (Qscroll_bar_background)},
3565 {"screen-gamma", SYMBOL_INDEX (Qscreen_gamma)},
3566 {"line-spacing", SYMBOL_INDEX (Qline_spacing)},
3567 {"left-fringe", SYMBOL_INDEX (Qleft_fringe)},
3568 {"right-fringe", SYMBOL_INDEX (Qright_fringe)},
3569 {"wait-for-wm", SYMBOL_INDEX (Qwait_for_wm)},
3570 {"fullscreen", SYMBOL_INDEX (Qfullscreen)},
3571 {"font-backend", SYMBOL_INDEX (Qfont_backend)},
3572 {"alpha", SYMBOL_INDEX (Qalpha)},
3573 {"sticky", SYMBOL_INDEX (Qsticky)},
3574 {"tool-bar-position", SYMBOL_INDEX (Qtool_bar_position)},
3575 {"inhibit-double-buffering", SYMBOL_INDEX (Qinhibit_double_buffering)},
3576 {"undecorated", SYMBOL_INDEX (Qundecorated)},
3577 {"parent-frame", SYMBOL_INDEX (Qparent_frame)},
3578 {"skip-taskbar", SYMBOL_INDEX (Qskip_taskbar)},
3579 {"no-focus-on-map", SYMBOL_INDEX (Qno_focus_on_map)},
3580 {"no-accept-focus", SYMBOL_INDEX (Qno_accept_focus)},
3581 {"z-group", SYMBOL_INDEX (Qz_group)},
3582 {"override-redirect", SYMBOL_INDEX (Qoverride_redirect)},
3583 {"no-special-glyphs", SYMBOL_INDEX (Qno_special_glyphs)},
3584 #ifdef NS_IMPL_COCOA
3585 {"ns-appearance", SYMBOL_INDEX (Qns_appearance)},
3586 {"ns-transparent-titlebar", SYMBOL_INDEX (Qns_transparent_titlebar)},
3587 #endif
3590 #ifdef HAVE_WINDOW_SYSTEM
3592 /* Enumeration type for switch in frame_float. */
3593 enum frame_float_type
3595 FRAME_FLOAT_WIDTH,
3596 FRAME_FLOAT_HEIGHT,
3597 FRAME_FLOAT_LEFT,
3598 FRAME_FLOAT_TOP
3602 * frame_float:
3604 * Process the value VAL of the float type frame parameter 'width',
3605 * 'height', 'left', or 'top' specified via a frame_float_type
3606 * enumeration type WHAT for frame F. Such parameters relate the outer
3607 * size or position of F to the size of the F's display or parent frame
3608 * which have to be both available in some way.
3610 * The return value is a size or position value in pixels. VAL must be
3611 * in the range 0.0 to 1.0 where a width/height of 0.0 means to return 0
3612 * and 1.0 means to return the full width/height of the display/parent.
3613 * For positions, 0.0 means position in the left/top corner of the
3614 * display/parent while 1.0 means to position at the right/bottom corner
3615 * of the display/parent frame.
3617 * Set PARENT_DONE and OUTER_DONE to avoid recalculation of the outer
3618 * size or parent or display attributes when more float parameters are
3619 * calculated in a row: -1 means not processed yet, 0 means processing
3620 * failed, 1 means processing succeeded.
3622 * Return DEFAULT_VALUE when processing fails for whatever reason with
3623 * one exception: When calculating F's outer edges fails (probably
3624 * because F has not been created yet) return the difference between F's
3625 * native and text size.
3627 static int
3628 frame_float (struct frame *f, Lisp_Object val, enum frame_float_type what,
3629 int *parent_done, int *outer_done, int default_value)
3631 double d_val = XFLOAT_DATA (val);
3633 if (d_val < 0.0 || d_val > 1.0)
3634 /* Invalid VAL. */
3635 return default_value;
3636 else
3638 static unsigned parent_width, parent_height;
3639 static int parent_left, parent_top;
3640 static unsigned outer_minus_text_width, outer_minus_text_height;
3641 struct frame *p = FRAME_PARENT_FRAME (f);
3643 if (*parent_done == 1)
3645 else if (p)
3647 parent_width = FRAME_PIXEL_WIDTH (p);
3648 parent_height = FRAME_PIXEL_HEIGHT (p);
3649 *parent_done = 1;
3651 else
3653 if (*parent_done == 0)
3654 /* No workarea available. */
3655 return default_value;
3656 else if (*parent_done == -1)
3658 Lisp_Object monitor_attributes;
3659 Lisp_Object workarea;
3660 Lisp_Object frame;
3662 XSETFRAME (frame, f);
3663 monitor_attributes = Fcar (call1 (Qdisplay_monitor_attributes_list, frame));
3664 if (NILP (monitor_attributes))
3666 /* No monitor attributes available. */
3667 *parent_done = 0;
3669 return default_value;
3672 workarea = Fcdr (Fassq (Qworkarea, monitor_attributes));
3673 if (NILP (workarea))
3675 /* No workarea available. */
3676 *parent_done = 0;
3678 return default_value;
3681 /* Workarea available. */
3682 parent_left = XINT (Fnth (make_number (0), workarea));
3683 parent_top = XINT (Fnth (make_number (1), workarea));
3684 parent_width = XINT (Fnth (make_number (2), workarea));
3685 parent_height = XINT (Fnth (make_number (3), workarea));
3686 *parent_done = 1;
3690 if (*outer_done == 1)
3692 else if (FRAME_UNDECORATED (f))
3694 outer_minus_text_width
3695 = FRAME_PIXEL_WIDTH (f) - FRAME_TEXT_WIDTH (f);
3696 outer_minus_text_height
3697 = FRAME_PIXEL_HEIGHT (f) - FRAME_TEXT_HEIGHT (f);
3698 *outer_done = 1;
3700 else if (*outer_done == 0)
3701 /* No outer size available. */
3702 return default_value;
3703 else if (*outer_done == -1)
3705 Lisp_Object frame, outer_edges;
3707 XSETFRAME (frame, f);
3708 outer_edges = call2 (Qframe_edges, frame, Qouter_edges);
3710 if (!NILP (outer_edges))
3712 outer_minus_text_width
3713 = (XINT (Fnth (make_number (2), outer_edges))
3714 - XINT (Fnth (make_number (0), outer_edges))
3715 - FRAME_TEXT_WIDTH (f));
3716 outer_minus_text_height
3717 = (XINT (Fnth (make_number (3), outer_edges))
3718 - XINT (Fnth (make_number (1), outer_edges))
3719 - FRAME_TEXT_HEIGHT (f));
3721 else
3723 /* If we can't get any outer edges, proceed as if the frame
3724 were undecorated. */
3725 outer_minus_text_width
3726 = FRAME_PIXEL_WIDTH (f) - FRAME_TEXT_WIDTH (f);
3727 outer_minus_text_height
3728 = FRAME_PIXEL_HEIGHT (f) - FRAME_TEXT_HEIGHT (f);
3731 *outer_done = 1;
3734 switch (what)
3736 case FRAME_FLOAT_WIDTH:
3737 return parent_width * d_val - outer_minus_text_width;
3739 case FRAME_FLOAT_HEIGHT:
3740 return parent_height * d_val - outer_minus_text_height;
3742 case FRAME_FLOAT_LEFT:
3744 int rest_width = (parent_width
3745 - FRAME_TEXT_WIDTH (f)
3746 - outer_minus_text_width);
3748 if (p)
3749 return (rest_width <= 0 ? 0 : d_val * rest_width);
3750 else
3751 return (rest_width <= 0
3752 ? parent_left
3753 : parent_left + d_val * rest_width);
3755 case FRAME_FLOAT_TOP:
3757 int rest_height = (parent_height
3758 - FRAME_TEXT_HEIGHT (f)
3759 - outer_minus_text_height);
3761 if (p)
3762 return (rest_height <= 0 ? 0 : d_val * rest_height);
3763 else
3764 return (rest_height <= 0
3765 ? parent_top
3766 : parent_top + d_val * rest_height);
3768 default:
3769 emacs_abort ();
3774 /* Change the parameters of frame F as specified by ALIST.
3775 If a parameter is not specially recognized, do nothing special;
3776 otherwise call the `x_set_...' function for that parameter.
3777 Except for certain geometry properties, always call store_frame_param
3778 to store the new value in the parameter alist. */
3780 void
3781 x_set_frame_parameters (struct frame *f, Lisp_Object alist)
3783 Lisp_Object tail, frame;
3786 /* If both of these parameters are present, it's more efficient to
3787 set them both at once. So we wait until we've looked at the
3788 entire list before we set them. */
3789 int width = -1, height = -1; /* -1 denotes they were not changed. */
3791 /* Same here. */
3792 Lisp_Object left, top;
3794 /* Same with these. */
3795 Lisp_Object icon_left, icon_top;
3797 /* And with this. */
3798 Lisp_Object fullscreen;
3799 bool fullscreen_change = false;
3801 /* Record in these vectors all the parms specified. */
3802 Lisp_Object *parms;
3803 Lisp_Object *values;
3804 ptrdiff_t i, j, size;
3805 bool left_no_change = 0, top_no_change = 0;
3806 #ifdef HAVE_X_WINDOWS
3807 bool icon_left_no_change = 0, icon_top_no_change = 0;
3808 #endif
3809 int parent_done = -1, outer_done = -1;
3811 XSETFRAME (frame, f);
3812 for (size = 0, tail = alist; CONSP (tail); tail = XCDR (tail))
3813 size++;
3814 CHECK_LIST_END (tail, alist);
3816 USE_SAFE_ALLOCA;
3817 SAFE_ALLOCA_LISP (parms, 2 * size);
3818 values = parms + size;
3820 /* Extract parm names and values into those vectors. */
3822 i = 0, j = size - 1;
3823 for (tail = alist; CONSP (tail); tail = XCDR (tail))
3825 Lisp_Object elt = XCAR (tail), prop = Fcar (elt), val = Fcdr (elt);
3827 /* Some properties are independent of other properties, but other
3828 properties are dependent upon them. These special properties
3829 are foreground_color, background_color (affects cursor_color)
3830 and font (affects fringe widths); they're recorded starting
3831 from the end of PARMS and VALUES to process them first by using
3832 reverse iteration. */
3834 if (EQ (prop, Qforeground_color)
3835 || EQ (prop, Qbackground_color)
3836 || EQ (prop, Qfont))
3838 parms[j] = prop;
3839 values[j] = val;
3840 j--;
3842 else
3844 parms[i] = prop;
3845 values[i] = val;
3846 i++;
3850 /* TAIL and ALIST are not used again below here. */
3851 alist = tail = Qnil;
3853 top = left = Qunbound;
3854 icon_left = icon_top = Qunbound;
3856 /* Reverse order is used to make sure that special
3857 properties noticed above are processed first. */
3858 for (i = size - 1; i >= 0; i--)
3860 Lisp_Object prop, val;
3862 prop = parms[i];
3863 val = values[i];
3865 if (EQ (prop, Qwidth))
3867 if (RANGED_INTEGERP (0, val, INT_MAX))
3868 width = XFASTINT (val) * FRAME_COLUMN_WIDTH (f) ;
3869 else if (CONSP (val) && EQ (XCAR (val), Qtext_pixels)
3870 && RANGED_INTEGERP (0, XCDR (val), INT_MAX))
3871 width = XFASTINT (XCDR (val));
3872 else if (FLOATP (val))
3873 width = frame_float (f, val, FRAME_FLOAT_WIDTH, &parent_done,
3874 &outer_done, -1);
3876 else if (EQ (prop, Qheight))
3878 if (RANGED_INTEGERP (0, val, INT_MAX))
3879 height = XFASTINT (val) * FRAME_LINE_HEIGHT (f);
3880 else if (CONSP (val) && EQ (XCAR (val), Qtext_pixels)
3881 && RANGED_INTEGERP (0, XCDR (val), INT_MAX))
3882 height = XFASTINT (XCDR (val));
3883 else if (FLOATP (val))
3884 height = frame_float (f, val, FRAME_FLOAT_HEIGHT, &parent_done,
3885 &outer_done, -1);
3887 else if (EQ (prop, Qtop))
3888 top = val;
3889 else if (EQ (prop, Qleft))
3890 left = val;
3891 else if (EQ (prop, Qicon_top))
3892 icon_top = val;
3893 else if (EQ (prop, Qicon_left))
3894 icon_left = val;
3895 else if (EQ (prop, Qfullscreen))
3897 fullscreen = val;
3898 fullscreen_change = true;
3900 else
3902 register Lisp_Object param_index, old_value;
3904 old_value = get_frame_param (f, prop);
3906 store_frame_param (f, prop, val);
3908 param_index = Fget (prop, Qx_frame_parameter);
3909 if (NATNUMP (param_index)
3910 && XFASTINT (param_index) < ARRAYELTS (frame_parms)
3911 && FRAME_RIF (f)->frame_parm_handlers[XINT (param_index)])
3912 (*(FRAME_RIF (f)->frame_parm_handlers[XINT (param_index)])) (f, val, old_value);
3916 /* Don't die if just one of these was set. */
3917 if (EQ (left, Qunbound))
3919 left_no_change = 1;
3920 if (f->left_pos < 0)
3921 left = list2 (Qplus, make_number (f->left_pos));
3922 else
3923 XSETINT (left, f->left_pos);
3925 if (EQ (top, Qunbound))
3927 top_no_change = 1;
3928 if (f->top_pos < 0)
3929 top = list2 (Qplus, make_number (f->top_pos));
3930 else
3931 XSETINT (top, f->top_pos);
3934 /* If one of the icon positions was not set, preserve or default it. */
3935 if (! TYPE_RANGED_INTEGERP (int, icon_left))
3937 #ifdef HAVE_X_WINDOWS
3938 icon_left_no_change = 1;
3939 #endif
3940 icon_left = Fcdr (Fassq (Qicon_left, f->param_alist));
3941 if (NILP (icon_left))
3942 XSETINT (icon_left, 0);
3944 if (! TYPE_RANGED_INTEGERP (int, icon_top))
3946 #ifdef HAVE_X_WINDOWS
3947 icon_top_no_change = 1;
3948 #endif
3949 icon_top = Fcdr (Fassq (Qicon_top, f->param_alist));
3950 if (NILP (icon_top))
3951 XSETINT (icon_top, 0);
3954 /* Don't set these parameters unless they've been explicitly
3955 specified. The window might be mapped or resized while we're in
3956 this function, and we don't want to override that unless the lisp
3957 code has asked for it.
3959 Don't set these parameters unless they actually differ from the
3960 window's current parameters; the window may not actually exist
3961 yet. */
3962 if ((width != -1 && width != FRAME_TEXT_WIDTH (f))
3963 || (height != -1 && height != FRAME_TEXT_HEIGHT (f)))
3964 /* We could consider checking f->after_make_frame here, but I
3965 don't have the faintest idea why the following is needed at
3966 all. With the old setting it can get a Heisenbug when
3967 EmacsFrameResize intermittently provokes a delayed
3968 change_frame_size in the middle of adjust_frame_size. */
3969 /** || (f->can_x_set_window_size && (f->new_height || f->new_width))) **/
3970 adjust_frame_size (f, width, height, 1, 0, Qx_set_frame_parameters);
3972 if ((!NILP (left) || !NILP (top))
3973 && ! (left_no_change && top_no_change)
3974 && ! (NUMBERP (left) && XINT (left) == f->left_pos
3975 && NUMBERP (top) && XINT (top) == f->top_pos))
3977 int leftpos = 0;
3978 int toppos = 0;
3980 /* Record the signs. */
3981 f->size_hint_flags &= ~ (XNegative | YNegative);
3982 if (EQ (left, Qminus))
3983 f->size_hint_flags |= XNegative;
3984 else if (TYPE_RANGED_INTEGERP (int, left))
3986 leftpos = XINT (left);
3987 if (leftpos < 0)
3988 f->size_hint_flags |= XNegative;
3990 else if (CONSP (left) && EQ (XCAR (left), Qminus)
3991 && CONSP (XCDR (left))
3992 && RANGED_INTEGERP (-INT_MAX, XCAR (XCDR (left)), INT_MAX))
3994 leftpos = - XINT (XCAR (XCDR (left)));
3995 f->size_hint_flags |= XNegative;
3997 else if (CONSP (left) && EQ (XCAR (left), Qplus)
3998 && CONSP (XCDR (left))
3999 && TYPE_RANGED_INTEGERP (int, XCAR (XCDR (left))))
4000 leftpos = XINT (XCAR (XCDR (left)));
4001 else if (FLOATP (left))
4002 leftpos = frame_float (f, left, FRAME_FLOAT_LEFT, &parent_done,
4003 &outer_done, 0);
4005 if (EQ (top, Qminus))
4006 f->size_hint_flags |= YNegative;
4007 else if (TYPE_RANGED_INTEGERP (int, top))
4009 toppos = XINT (top);
4010 if (toppos < 0)
4011 f->size_hint_flags |= YNegative;
4013 else if (CONSP (top) && EQ (XCAR (top), Qminus)
4014 && CONSP (XCDR (top))
4015 && RANGED_INTEGERP (-INT_MAX, XCAR (XCDR (top)), INT_MAX))
4017 toppos = - XINT (XCAR (XCDR (top)));
4018 f->size_hint_flags |= YNegative;
4020 else if (CONSP (top) && EQ (XCAR (top), Qplus)
4021 && CONSP (XCDR (top))
4022 && TYPE_RANGED_INTEGERP (int, XCAR (XCDR (top))))
4023 toppos = XINT (XCAR (XCDR (top)));
4024 else if (FLOATP (top))
4025 toppos = frame_float (f, top, FRAME_FLOAT_TOP, &parent_done,
4026 &outer_done, 0);
4028 /* Store the numeric value of the position. */
4029 f->top_pos = toppos;
4030 f->left_pos = leftpos;
4032 f->win_gravity = NorthWestGravity;
4034 /* Actually set that position, and convert to absolute. */
4035 x_set_offset (f, leftpos, toppos, -1);
4038 if (fullscreen_change)
4040 Lisp_Object old_value = get_frame_param (f, Qfullscreen);
4042 frame_size_history_add
4043 (f, Qx_set_fullscreen, 0, 0, list2 (old_value, fullscreen));
4045 store_frame_param (f, Qfullscreen, fullscreen);
4046 if (!EQ (fullscreen, old_value))
4047 x_set_fullscreen (f, fullscreen, old_value);
4051 #ifdef HAVE_X_WINDOWS
4052 if ((!NILP (icon_left) || !NILP (icon_top))
4053 && ! (icon_left_no_change && icon_top_no_change))
4054 x_wm_set_icon_position (f, XINT (icon_left), XINT (icon_top));
4055 #endif /* HAVE_X_WINDOWS */
4057 SAFE_FREE ();
4061 /* Insert a description of internally-recorded parameters of frame X
4062 into the parameter alist *ALISTPTR that is to be given to the user.
4063 Only parameters that are specific to the X window system
4064 and whose values are not correctly recorded in the frame's
4065 param_alist need to be considered here. */
4067 void
4068 x_report_frame_params (struct frame *f, Lisp_Object *alistptr)
4070 Lisp_Object tem;
4071 uprintmax_t w;
4072 char buf[INT_BUFSIZE_BOUND (w)];
4074 /* Represent negative positions (off the top or left screen edge)
4075 in a way that Fmodify_frame_parameters will understand correctly. */
4076 XSETINT (tem, f->left_pos);
4077 if (f->left_pos >= 0)
4078 store_in_alist (alistptr, Qleft, tem);
4079 else
4080 store_in_alist (alistptr, Qleft, list2 (Qplus, tem));
4082 XSETINT (tem, f->top_pos);
4083 if (f->top_pos >= 0)
4084 store_in_alist (alistptr, Qtop, tem);
4085 else
4086 store_in_alist (alistptr, Qtop, list2 (Qplus, tem));
4088 store_in_alist (alistptr, Qborder_width,
4089 make_number (f->border_width));
4090 store_in_alist (alistptr, Qinternal_border_width,
4091 make_number (FRAME_INTERNAL_BORDER_WIDTH (f)));
4092 store_in_alist (alistptr, Qright_divider_width,
4093 make_number (FRAME_RIGHT_DIVIDER_WIDTH (f)));
4094 store_in_alist (alistptr, Qbottom_divider_width,
4095 make_number (FRAME_BOTTOM_DIVIDER_WIDTH (f)));
4096 store_in_alist (alistptr, Qleft_fringe,
4097 make_number (FRAME_LEFT_FRINGE_WIDTH (f)));
4098 store_in_alist (alistptr, Qright_fringe,
4099 make_number (FRAME_RIGHT_FRINGE_WIDTH (f)));
4100 store_in_alist (alistptr, Qscroll_bar_width,
4101 (! FRAME_HAS_VERTICAL_SCROLL_BARS (f)
4102 ? make_number (0)
4103 : FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0
4104 ? make_number (FRAME_CONFIG_SCROLL_BAR_WIDTH (f))
4105 /* nil means "use default width"
4106 for non-toolkit scroll bar.
4107 ruler-mode.el depends on this. */
4108 : Qnil));
4109 store_in_alist (alistptr, Qscroll_bar_height,
4110 (! FRAME_HAS_HORIZONTAL_SCROLL_BARS (f)
4111 ? make_number (0)
4112 : FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) > 0
4113 ? make_number (FRAME_CONFIG_SCROLL_BAR_HEIGHT (f))
4114 /* nil means "use default height"
4115 for non-toolkit scroll bar. */
4116 : Qnil));
4117 /* FRAME_X_WINDOW is not guaranteed to return an integer. E.g., on
4118 MS-Windows it returns a value whose type is HANDLE, which is
4119 actually a pointer. Explicit casting avoids compiler
4120 warnings. */
4121 w = (uintptr_t) FRAME_X_WINDOW (f);
4122 store_in_alist (alistptr, Qwindow_id,
4123 make_formatted_string (buf, "%"pMu, w));
4124 #ifdef HAVE_X_WINDOWS
4125 #ifdef USE_X_TOOLKIT
4126 /* Tooltip frame may not have this widget. */
4127 if (FRAME_X_OUTPUT (f)->widget)
4128 #endif
4129 w = (uintptr_t) FRAME_OUTER_WINDOW (f);
4130 store_in_alist (alistptr, Qouter_window_id,
4131 make_formatted_string (buf, "%"pMu, w));
4132 #endif
4133 store_in_alist (alistptr, Qicon_name, f->icon_name);
4134 store_in_alist (alistptr, Qvisibility,
4135 (FRAME_VISIBLE_P (f) ? Qt
4136 : FRAME_ICONIFIED_P (f) ? Qicon : Qnil));
4137 store_in_alist (alistptr, Qdisplay,
4138 XCAR (FRAME_DISPLAY_INFO (f)->name_list_element));
4140 if (FRAME_X_OUTPUT (f)->parent_desc == FRAME_DISPLAY_INFO (f)->root_window)
4141 tem = Qnil;
4142 else
4143 tem = make_natnum ((uintptr_t) FRAME_X_OUTPUT (f)->parent_desc);
4144 store_in_alist (alistptr, Qexplicit_name, (f->explicit_name ? Qt : Qnil));
4145 store_in_alist (alistptr, Qparent_id, tem);
4146 store_in_alist (alistptr, Qtool_bar_position, FRAME_TOOL_BAR_POSITION (f));
4150 /* Change the `fullscreen' frame parameter of frame F. OLD_VALUE is
4151 the previous value of that parameter, NEW_VALUE is the new value. */
4153 void
4154 x_set_fullscreen (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
4156 if (NILP (new_value))
4157 f->want_fullscreen = FULLSCREEN_NONE;
4158 else if (EQ (new_value, Qfullboth) || EQ (new_value, Qfullscreen))
4159 f->want_fullscreen = FULLSCREEN_BOTH;
4160 else if (EQ (new_value, Qfullwidth))
4161 f->want_fullscreen = FULLSCREEN_WIDTH;
4162 else if (EQ (new_value, Qfullheight))
4163 f->want_fullscreen = FULLSCREEN_HEIGHT;
4164 else if (EQ (new_value, Qmaximized))
4165 f->want_fullscreen = FULLSCREEN_MAXIMIZED;
4167 if (FRAME_TERMINAL (f)->fullscreen_hook != NULL)
4168 FRAME_TERMINAL (f)->fullscreen_hook (f);
4172 /* Change the `line-spacing' frame parameter of frame F. OLD_VALUE is
4173 the previous value of that parameter, NEW_VALUE is the new value. */
4175 void
4176 x_set_line_spacing (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
4178 if (NILP (new_value))
4179 f->extra_line_spacing = 0;
4180 else if (RANGED_INTEGERP (0, new_value, INT_MAX))
4181 f->extra_line_spacing = XFASTINT (new_value);
4182 else if (FLOATP (new_value))
4184 int new_spacing = XFLOAT_DATA (new_value) * FRAME_LINE_HEIGHT (f) + 0.5;
4186 if (new_spacing >= 0)
4187 f->extra_line_spacing = new_spacing;
4188 else
4189 signal_error ("Invalid line-spacing", new_value);
4191 else
4192 signal_error ("Invalid line-spacing", new_value);
4193 if (FRAME_VISIBLE_P (f))
4194 redraw_frame (f);
4198 /* Change the `screen-gamma' frame parameter of frame F. OLD_VALUE is
4199 the previous value of that parameter, NEW_VALUE is the new value. */
4201 void
4202 x_set_screen_gamma (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
4204 Lisp_Object bgcolor;
4206 if (NILP (new_value))
4207 f->gamma = 0;
4208 else if (NUMBERP (new_value) && XFLOATINT (new_value) > 0)
4209 /* The value 0.4545 is the normal viewing gamma. */
4210 f->gamma = 1.0 / (0.4545 * XFLOATINT (new_value));
4211 else
4212 signal_error ("Invalid screen-gamma", new_value);
4214 /* Apply the new gamma value to the frame background. */
4215 bgcolor = Fassq (Qbackground_color, f->param_alist);
4216 if (CONSP (bgcolor) && (bgcolor = XCDR (bgcolor), STRINGP (bgcolor)))
4218 Lisp_Object parm_index = Fget (Qbackground_color, Qx_frame_parameter);
4219 if (NATNUMP (parm_index)
4220 && XFASTINT (parm_index) < ARRAYELTS (frame_parms)
4221 && FRAME_RIF (f)->frame_parm_handlers[XFASTINT (parm_index)])
4222 (*FRAME_RIF (f)->frame_parm_handlers[XFASTINT (parm_index)])
4223 (f, bgcolor, Qnil);
4226 clear_face_cache (true); /* FIXME: Why of all frames? */
4227 fset_redisplay (f);
4231 void
4232 x_set_font (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4234 Lisp_Object font_object;
4235 int fontset = -1;
4236 #ifdef HAVE_X_WINDOWS
4237 Lisp_Object font_param = arg;
4238 #endif
4240 /* Set the frame parameter back to the old value because we may
4241 fail to use ARG as the new parameter value. */
4242 store_frame_param (f, Qfont, oldval);
4244 /* ARG is a fontset name, a font name, a cons of fontset name and a
4245 font object, or a font object. In the last case, this function
4246 never fail. */
4247 if (STRINGP (arg))
4249 fontset = fs_query_fontset (arg, 0);
4250 if (fontset < 0)
4252 font_object = font_open_by_name (f, arg);
4253 if (NILP (font_object))
4254 error ("Font `%s' is not defined", SSDATA (arg));
4255 arg = AREF (font_object, FONT_NAME_INDEX);
4257 else if (fontset > 0)
4259 font_object = font_open_by_name (f, fontset_ascii (fontset));
4260 if (NILP (font_object))
4261 error ("Font `%s' is not defined", SDATA (arg));
4262 arg = AREF (font_object, FONT_NAME_INDEX);
4264 else
4265 error ("The default fontset can't be used for a frame font");
4267 else if (CONSP (arg) && STRINGP (XCAR (arg)) && FONT_OBJECT_P (XCDR (arg)))
4269 /* This is the case that the ASCII font of F's fontset XCAR
4270 (arg) is changed to the font XCDR (arg) by
4271 `set-fontset-font'. */
4272 fontset = fs_query_fontset (XCAR (arg), 0);
4273 if (fontset < 0)
4274 error ("Unknown fontset: %s", SDATA (XCAR (arg)));
4275 font_object = XCDR (arg);
4276 arg = AREF (font_object, FONT_NAME_INDEX);
4277 #ifdef HAVE_X_WINDOWS
4278 font_param = Ffont_get (font_object, QCname);
4279 #endif
4281 else if (FONT_OBJECT_P (arg))
4283 font_object = arg;
4284 #ifdef HAVE_X_WINDOWS
4285 font_param = Ffont_get (font_object, QCname);
4286 #endif
4287 /* This is to store the XLFD font name in the frame parameter for
4288 backward compatibility. We should store the font-object
4289 itself in the future. */
4290 arg = AREF (font_object, FONT_NAME_INDEX);
4291 fontset = FRAME_FONTSET (f);
4292 /* Check if we can use the current fontset. If not, set FONTSET
4293 to -1 to generate a new fontset from FONT-OBJECT. */
4294 if (fontset >= 0)
4296 Lisp_Object ascii_font = fontset_ascii (fontset);
4297 Lisp_Object spec = font_spec_from_name (ascii_font);
4299 /* SPEC might be nil because ASCII_FONT's name doesn't parse
4300 according to stupid XLFD rules, which, for example,
4301 disallow font names that include a dash followed by a
4302 number. So in those cases we simply request x_new_font
4303 below to generate a new fontset. */
4304 if (NILP (spec) || ! font_match_p (spec, font_object))
4305 fontset = -1;
4308 else
4309 signal_error ("Invalid font", arg);
4311 if (! NILP (Fequal (font_object, oldval)))
4312 return;
4314 x_new_font (f, font_object, fontset);
4315 store_frame_param (f, Qfont, arg);
4316 #ifdef HAVE_X_WINDOWS
4317 store_frame_param (f, Qfont_parameter, font_param);
4318 #endif
4319 /* Recalculate toolbar height. */
4320 f->n_tool_bar_rows = 0;
4322 /* Ensure we redraw it. */
4323 clear_current_matrices (f);
4325 /* Attempt to hunt down bug#16028. */
4326 SET_FRAME_GARBAGED (f);
4328 /* This is important if we are called by some Lisp as part of
4329 redisplaying the frame, see redisplay_internal. */
4330 f->fonts_changed = true;
4332 recompute_basic_faces (f);
4334 do_pending_window_change (0);
4336 /* We used to call face-set-after-frame-default here, but it leads to
4337 recursive calls (since that function can set the `default' face's
4338 font which in turns changes the frame's `font' parameter).
4339 Also I don't know what this call is meant to do, but it seems the
4340 wrong way to do it anyway (it does a lot more work than what seems
4341 reasonable in response to a change to `font'). */
4345 void
4346 x_set_font_backend (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
4348 if (! NILP (new_value)
4349 && !CONSP (new_value))
4351 char *p0, *p1;
4353 CHECK_STRING (new_value);
4354 p0 = p1 = SSDATA (new_value);
4355 new_value = Qnil;
4356 while (*p0)
4358 while (*p1 && ! c_isspace (*p1) && *p1 != ',') p1++;
4359 if (p0 < p1)
4360 new_value = Fcons (Fintern (make_string (p0, p1 - p0), Qnil),
4361 new_value);
4362 if (*p1)
4364 int c;
4366 while ((c = *++p1) && c_isspace (c));
4368 p0 = p1;
4370 new_value = Fnreverse (new_value);
4373 if (! NILP (old_value) && ! NILP (Fequal (old_value, new_value)))
4374 return;
4376 if (FRAME_FONT (f))
4377 free_all_realized_faces (Qnil);
4379 new_value = font_update_drivers (f, NILP (new_value) ? Qt : new_value);
4380 if (NILP (new_value))
4382 if (NILP (old_value))
4383 error ("No font backend available");
4384 font_update_drivers (f, old_value);
4385 error ("None of specified font backends are available");
4387 store_frame_param (f, Qfont_backend, new_value);
4389 if (FRAME_FONT (f))
4391 Lisp_Object frame;
4393 XSETFRAME (frame, f);
4394 x_set_font (f, Fframe_parameter (frame, Qfont), Qnil);
4395 face_change = true;
4396 windows_or_buffers_changed = 18;
4400 void
4401 x_set_left_fringe (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
4403 int unit = FRAME_COLUMN_WIDTH (f);
4404 int old_width = FRAME_LEFT_FRINGE_WIDTH (f);
4405 int new_width;
4407 new_width = (RANGED_INTEGERP (-INT_MAX, new_value, INT_MAX)
4408 ? eabs (XINT (new_value)) : 8);
4410 if (new_width != old_width)
4412 f->left_fringe_width = new_width;
4413 f->fringe_cols /* Round up. */
4414 = (new_width + FRAME_RIGHT_FRINGE_WIDTH (f) + unit - 1) / unit;
4416 if (FRAME_X_WINDOW (f) != 0)
4417 adjust_frame_size (f, -1, -1, 3, 0, Qleft_fringe);
4419 SET_FRAME_GARBAGED (f);
4424 void
4425 x_set_right_fringe (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
4427 int unit = FRAME_COLUMN_WIDTH (f);
4428 int old_width = FRAME_RIGHT_FRINGE_WIDTH (f);
4429 int new_width;
4431 new_width = (RANGED_INTEGERP (-INT_MAX, new_value, INT_MAX)
4432 ? eabs (XINT (new_value)) : 8);
4434 if (new_width != old_width)
4436 f->right_fringe_width = new_width;
4437 f->fringe_cols /* Round up. */
4438 = (new_width + FRAME_LEFT_FRINGE_WIDTH (f) + unit - 1) / unit;
4440 if (FRAME_X_WINDOW (f) != 0)
4441 adjust_frame_size (f, -1, -1, 3, 0, Qright_fringe);
4443 SET_FRAME_GARBAGED (f);
4448 void
4449 x_set_border_width (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4451 CHECK_TYPE_RANGED_INTEGER (int, arg);
4453 if (XINT (arg) == f->border_width)
4454 return;
4456 if (FRAME_X_WINDOW (f) != 0)
4457 error ("Cannot change the border width of a frame");
4459 f->border_width = XINT (arg);
4462 void
4463 x_set_right_divider_width (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4465 int old = FRAME_RIGHT_DIVIDER_WIDTH (f);
4466 CHECK_TYPE_RANGED_INTEGER (int, arg);
4467 int new = max (0, XINT (arg));
4468 if (new != old)
4470 f->right_divider_width = new;
4471 adjust_frame_size (f, -1, -1, 4, 0, Qright_divider_width);
4472 adjust_frame_glyphs (f);
4473 SET_FRAME_GARBAGED (f);
4477 void
4478 x_set_bottom_divider_width (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4480 int old = FRAME_BOTTOM_DIVIDER_WIDTH (f);
4481 CHECK_TYPE_RANGED_INTEGER (int, arg);
4482 int new = max (0, XINT (arg));
4483 if (new != old)
4485 f->bottom_divider_width = new;
4486 adjust_frame_size (f, -1, -1, 4, 0, Qbottom_divider_width);
4487 adjust_frame_glyphs (f);
4488 SET_FRAME_GARBAGED (f);
4492 void
4493 x_set_visibility (struct frame *f, Lisp_Object value, Lisp_Object oldval)
4495 Lisp_Object frame;
4496 XSETFRAME (frame, f);
4498 if (NILP (value))
4499 Fmake_frame_invisible (frame, Qt);
4500 else if (EQ (value, Qicon))
4501 Ficonify_frame (frame);
4502 else
4503 Fmake_frame_visible (frame);
4506 void
4507 x_set_autoraise (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4509 f->auto_raise = !EQ (Qnil, arg);
4512 void
4513 x_set_autolower (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4515 f->auto_lower = !EQ (Qnil, arg);
4518 void
4519 x_set_unsplittable (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4521 f->no_split = !NILP (arg);
4524 void
4525 x_set_vertical_scroll_bars (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4527 if ((EQ (arg, Qleft) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f))
4528 || (EQ (arg, Qright) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
4529 || (NILP (arg) && FRAME_HAS_VERTICAL_SCROLL_BARS (f))
4530 || (!NILP (arg) && !FRAME_HAS_VERTICAL_SCROLL_BARS (f)))
4532 FRAME_VERTICAL_SCROLL_BAR_TYPE (f)
4533 = (NILP (arg)
4534 ? vertical_scroll_bar_none
4535 : EQ (Qleft, arg)
4536 ? vertical_scroll_bar_left
4537 : EQ (Qright, arg)
4538 ? vertical_scroll_bar_right
4539 : EQ (Qleft, Vdefault_frame_scroll_bars)
4540 ? vertical_scroll_bar_left
4541 : EQ (Qright, Vdefault_frame_scroll_bars)
4542 ? vertical_scroll_bar_right
4543 : vertical_scroll_bar_none);
4545 /* We set this parameter before creating the X window for the
4546 frame, so we can get the geometry right from the start.
4547 However, if the window hasn't been created yet, we shouldn't
4548 call x_set_window_size. */
4549 if (FRAME_X_WINDOW (f))
4550 adjust_frame_size (f, -1, -1, 3, 0, Qvertical_scroll_bars);
4552 SET_FRAME_GARBAGED (f);
4556 void
4557 x_set_horizontal_scroll_bars (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4559 #if USE_HORIZONTAL_SCROLL_BARS
4560 if ((NILP (arg) && FRAME_HAS_HORIZONTAL_SCROLL_BARS (f))
4561 || (!NILP (arg) && !FRAME_HAS_HORIZONTAL_SCROLL_BARS (f)))
4563 f->horizontal_scroll_bars = NILP (arg) ? false : true;
4565 /* We set this parameter before creating the X window for the
4566 frame, so we can get the geometry right from the start.
4567 However, if the window hasn't been created yet, we shouldn't
4568 call x_set_window_size. */
4569 if (FRAME_X_WINDOW (f))
4570 adjust_frame_size (f, -1, -1, 3, 0, Qhorizontal_scroll_bars);
4572 SET_FRAME_GARBAGED (f);
4574 #endif
4577 void
4578 x_set_scroll_bar_width (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4580 int unit = FRAME_COLUMN_WIDTH (f);
4582 if (NILP (arg))
4584 x_set_scroll_bar_default_width (f);
4586 if (FRAME_X_WINDOW (f))
4587 adjust_frame_size (f, -1, -1, 3, 0, Qscroll_bar_width);
4589 SET_FRAME_GARBAGED (f);
4591 else if (RANGED_INTEGERP (1, arg, INT_MAX)
4592 && XFASTINT (arg) != FRAME_CONFIG_SCROLL_BAR_WIDTH (f))
4594 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = XFASTINT (arg);
4595 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (XFASTINT (arg) + unit - 1) / unit;
4596 if (FRAME_X_WINDOW (f))
4597 adjust_frame_size (f, -1, -1, 3, 0, Qscroll_bar_width);
4599 SET_FRAME_GARBAGED (f);
4602 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.hpos = 0;
4603 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.x = 0;
4606 void
4607 x_set_scroll_bar_height (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4609 #if USE_HORIZONTAL_SCROLL_BARS
4610 int unit = FRAME_LINE_HEIGHT (f);
4612 if (NILP (arg))
4614 x_set_scroll_bar_default_height (f);
4616 if (FRAME_X_WINDOW (f))
4617 adjust_frame_size (f, -1, -1, 3, 0, Qscroll_bar_height);
4619 SET_FRAME_GARBAGED (f);
4621 else if (RANGED_INTEGERP (1, arg, INT_MAX)
4622 && XFASTINT (arg) != FRAME_CONFIG_SCROLL_BAR_HEIGHT (f))
4624 FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) = XFASTINT (arg);
4625 FRAME_CONFIG_SCROLL_BAR_LINES (f) = (XFASTINT (arg) + unit - 1) / unit;
4626 if (FRAME_X_WINDOW (f))
4627 adjust_frame_size (f, -1, -1, 3, 0, Qscroll_bar_height);
4629 SET_FRAME_GARBAGED (f);
4632 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.vpos = 0;
4633 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.y = 0;
4634 #endif
4637 void
4638 x_set_alpha (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4640 double alpha = 1.0;
4641 double newval[2];
4642 int i;
4643 Lisp_Object item;
4645 for (i = 0; i < 2; i++)
4647 newval[i] = 1.0;
4648 if (CONSP (arg))
4650 item = CAR (arg);
4651 arg = CDR (arg);
4653 else
4654 item = arg;
4656 if (NILP (item))
4657 alpha = - 1.0;
4658 else if (FLOATP (item))
4660 alpha = XFLOAT_DATA (item);
4661 if (! (0 <= alpha && alpha <= 1.0))
4662 args_out_of_range (make_float (0.0), make_float (1.0));
4664 else if (INTEGERP (item))
4666 EMACS_INT ialpha = XINT (item);
4667 if (! (0 <= ialpha && ialpha <= 100))
4668 args_out_of_range (make_number (0), make_number (100));
4669 alpha = ialpha / 100.0;
4671 else
4672 wrong_type_argument (Qnumberp, item);
4673 newval[i] = alpha;
4676 for (i = 0; i < 2; i++)
4677 f->alpha[i] = newval[i];
4679 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI) || defined (NS_IMPL_COCOA)
4680 block_input ();
4681 x_set_frame_alpha (f);
4682 unblock_input ();
4683 #endif
4685 return;
4690 * x_set_no_special_glyphs:
4692 * Set frame F's `no-special-glyphs' parameter which, if non-nil,
4693 * suppresses the display of truncation and continuation glyphs
4694 * outside fringes.
4696 void
4697 x_set_no_special_glyphs (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
4699 if (!EQ (new_value, old_value))
4700 FRAME_NO_SPECIAL_GLYPHS (f) = !NILP (new_value);
4704 #ifndef HAVE_NS
4706 /* Non-zero if mouse is grabbed on DPYINFO
4707 and we know the frame where it is. */
4709 bool x_mouse_grabbed (Display_Info *dpyinfo)
4711 return (dpyinfo->grabbed
4712 && dpyinfo->last_mouse_frame
4713 && FRAME_LIVE_P (dpyinfo->last_mouse_frame));
4716 /* Re-highlight something with mouse-face properties
4717 on DPYINFO using saved frame and mouse position. */
4719 void
4720 x_redo_mouse_highlight (Display_Info *dpyinfo)
4722 if (dpyinfo->last_mouse_motion_frame
4723 && FRAME_LIVE_P (dpyinfo->last_mouse_motion_frame))
4724 note_mouse_highlight (dpyinfo->last_mouse_motion_frame,
4725 dpyinfo->last_mouse_motion_x,
4726 dpyinfo->last_mouse_motion_y);
4729 #endif /* HAVE_NS */
4731 /* Subroutines of creating an X frame. */
4733 /* Make sure that Vx_resource_name is set to a reasonable value.
4734 Fix it up, or set it to `emacs' if it is too hopeless. */
4736 void
4737 validate_x_resource_name (void)
4739 ptrdiff_t len = 0;
4740 /* Number of valid characters in the resource name. */
4741 ptrdiff_t good_count = 0;
4742 /* Number of invalid characters in the resource name. */
4743 ptrdiff_t bad_count = 0;
4744 Lisp_Object new;
4745 ptrdiff_t i;
4747 if (!STRINGP (Vx_resource_class))
4748 Vx_resource_class = build_string (EMACS_CLASS);
4750 if (STRINGP (Vx_resource_name))
4752 unsigned char *p = SDATA (Vx_resource_name);
4754 len = SBYTES (Vx_resource_name);
4756 /* Only letters, digits, - and _ are valid in resource names.
4757 Count the valid characters and count the invalid ones. */
4758 for (i = 0; i < len; i++)
4760 int c = p[i];
4761 if (! ((c >= 'a' && c <= 'z')
4762 || (c >= 'A' && c <= 'Z')
4763 || (c >= '0' && c <= '9')
4764 || c == '-' || c == '_'))
4765 bad_count++;
4766 else
4767 good_count++;
4770 else
4771 /* Not a string => completely invalid. */
4772 bad_count = 5, good_count = 0;
4774 /* If name is valid already, return. */
4775 if (bad_count == 0)
4776 return;
4778 /* If name is entirely invalid, or nearly so, or is so implausibly
4779 large that alloca might not work, use `emacs'. */
4780 if (good_count < 2 || MAX_ALLOCA - sizeof ".customization" < len)
4782 Vx_resource_name = build_string ("emacs");
4783 return;
4786 /* Name is partly valid. Copy it and replace the invalid characters
4787 with underscores. */
4789 Vx_resource_name = new = Fcopy_sequence (Vx_resource_name);
4791 for (i = 0; i < len; i++)
4793 int c = SREF (new, i);
4794 if (! ((c >= 'a' && c <= 'z')
4795 || (c >= 'A' && c <= 'Z')
4796 || (c >= '0' && c <= '9')
4797 || c == '-' || c == '_'))
4798 SSET (new, i, '_');
4802 /* Get specified attribute from resource database RDB.
4803 See Fx_get_resource below for other parameters. */
4805 static Lisp_Object
4806 xrdb_get_resource (XrmDatabase rdb, Lisp_Object attribute, Lisp_Object class, Lisp_Object component, Lisp_Object subclass)
4808 CHECK_STRING (attribute);
4809 CHECK_STRING (class);
4811 if (!NILP (component))
4812 CHECK_STRING (component);
4813 if (!NILP (subclass))
4814 CHECK_STRING (subclass);
4815 if (NILP (component) != NILP (subclass))
4816 error ("x-get-resource: must specify both COMPONENT and SUBCLASS or neither");
4818 validate_x_resource_name ();
4820 /* Allocate space for the components, the dots which separate them,
4821 and the final '\0'. Make them big enough for the worst case. */
4822 ptrdiff_t name_keysize = (SBYTES (Vx_resource_name)
4823 + (STRINGP (component)
4824 ? SBYTES (component) : 0)
4825 + SBYTES (attribute)
4826 + 3);
4828 ptrdiff_t class_keysize = (SBYTES (Vx_resource_class)
4829 + SBYTES (class)
4830 + (STRINGP (subclass)
4831 ? SBYTES (subclass) : 0)
4832 + 3);
4833 USE_SAFE_ALLOCA;
4834 char *name_key = SAFE_ALLOCA (name_keysize + class_keysize);
4835 char *class_key = name_key + name_keysize;
4837 /* Start with emacs.FRAMENAME for the name (the specific one)
4838 and with `Emacs' for the class key (the general one). */
4839 char *nz = lispstpcpy (name_key, Vx_resource_name);
4840 char *cz = lispstpcpy (class_key, Vx_resource_class);
4842 *cz++ = '.';
4843 cz = lispstpcpy (cz, class);
4845 if (!NILP (component))
4847 *cz++ = '.';
4848 lispstpcpy (cz, subclass);
4850 *nz++ = '.';
4851 nz = lispstpcpy (nz, component);
4854 *nz++ = '.';
4855 lispstpcpy (nz, attribute);
4857 char *value = x_get_string_resource (rdb, name_key, class_key);
4858 SAFE_FREE();
4860 if (value && *value)
4861 return build_string (value);
4862 else
4863 return Qnil;
4867 DEFUN ("x-get-resource", Fx_get_resource, Sx_get_resource, 2, 4, 0,
4868 doc: /* Return the value of ATTRIBUTE, of class CLASS, from the X defaults database.
4869 This uses `INSTANCE.ATTRIBUTE' as the key and `Emacs.CLASS' as the
4870 class, where INSTANCE is the name under which Emacs was invoked, or
4871 the name specified by the `-name' or `-rn' command-line arguments.
4873 The optional arguments COMPONENT and SUBCLASS add to the key and the
4874 class, respectively. You must specify both of them or neither.
4875 If you specify them, the key is `INSTANCE.COMPONENT.ATTRIBUTE'
4876 and the class is `Emacs.CLASS.SUBCLASS'. */)
4877 (Lisp_Object attribute, Lisp_Object class, Lisp_Object component,
4878 Lisp_Object subclass)
4880 check_window_system (NULL);
4882 return xrdb_get_resource (check_x_display_info (Qnil)->xrdb,
4883 attribute, class, component, subclass);
4886 /* Get an X resource, like Fx_get_resource, but for display DPYINFO. */
4888 Lisp_Object
4889 display_x_get_resource (Display_Info *dpyinfo, Lisp_Object attribute,
4890 Lisp_Object class, Lisp_Object component,
4891 Lisp_Object subclass)
4893 return xrdb_get_resource (dpyinfo->xrdb,
4894 attribute, class, component, subclass);
4897 #if defined HAVE_X_WINDOWS && !defined USE_X_TOOLKIT && !defined USE_GTK
4898 /* Used when C code wants a resource value. */
4899 /* Called from oldXMenu/Create.c. */
4900 char *
4901 x_get_resource_string (const char *attribute, const char *class)
4903 char *result;
4904 struct frame *sf = SELECTED_FRAME ();
4905 ptrdiff_t invocation_namelen = SBYTES (Vinvocation_name);
4906 USE_SAFE_ALLOCA;
4908 /* Allocate space for the components, the dots which separate them,
4909 and the final '\0'. */
4910 ptrdiff_t name_keysize = invocation_namelen + strlen (attribute) + 2;
4911 ptrdiff_t class_keysize = sizeof (EMACS_CLASS) - 1 + strlen (class) + 2;
4912 char *name_key = SAFE_ALLOCA (name_keysize + class_keysize);
4913 char *class_key = name_key + name_keysize;
4915 esprintf (name_key, "%s.%s", SSDATA (Vinvocation_name), attribute);
4916 sprintf (class_key, "%s.%s", EMACS_CLASS, class);
4918 result = x_get_string_resource (FRAME_DISPLAY_INFO (sf)->xrdb,
4919 name_key, class_key);
4920 SAFE_FREE ();
4921 return result;
4923 #endif
4925 /* Return the value of parameter PARAM.
4927 First search ALIST, then Vdefault_frame_alist, then the X defaults
4928 database, using ATTRIBUTE as the attribute name and CLASS as its class.
4930 Convert the resource to the type specified by desired_type.
4932 If no default is specified, return Qunbound. If you call
4933 x_get_arg, make sure you deal with Qunbound in a reasonable way,
4934 and don't let it get stored in any Lisp-visible variables! */
4936 Lisp_Object
4937 x_get_arg (Display_Info *dpyinfo, Lisp_Object alist, Lisp_Object param,
4938 const char *attribute, const char *class, enum resource_types type)
4940 Lisp_Object tem;
4942 tem = Fassq (param, alist);
4944 if (!NILP (tem))
4946 /* If we find this parm in ALIST, clear it out
4947 so that it won't be "left over" at the end. */
4948 Lisp_Object tail;
4949 XSETCAR (tem, Qnil);
4950 /* In case the parameter appears more than once in the alist,
4951 clear it out. */
4952 for (tail = alist; CONSP (tail); tail = XCDR (tail))
4953 if (CONSP (XCAR (tail))
4954 && EQ (XCAR (XCAR (tail)), param))
4955 XSETCAR (XCAR (tail), Qnil);
4957 else
4958 tem = Fassq (param, Vdefault_frame_alist);
4960 /* If it wasn't specified in ALIST or the Lisp-level defaults,
4961 look in the X resources. */
4962 if (EQ (tem, Qnil))
4964 if (attribute && dpyinfo)
4966 AUTO_STRING (at, attribute);
4967 AUTO_STRING (cl, class);
4968 tem = display_x_get_resource (dpyinfo, at, cl, Qnil, Qnil);
4970 if (NILP (tem))
4971 return Qunbound;
4973 switch (type)
4975 case RES_TYPE_NUMBER:
4976 return make_number (atoi (SSDATA (tem)));
4978 case RES_TYPE_BOOLEAN_NUMBER:
4979 if (!strcmp (SSDATA (tem), "on")
4980 || !strcmp (SSDATA (tem), "true"))
4981 return make_number (1);
4982 return make_number (atoi (SSDATA (tem)));
4983 break;
4985 case RES_TYPE_FLOAT:
4986 return make_float (atof (SSDATA (tem)));
4988 case RES_TYPE_BOOLEAN:
4989 tem = Fdowncase (tem);
4990 if (!strcmp (SSDATA (tem), "on")
4991 #ifdef HAVE_NS
4992 || !strcmp (SSDATA (tem), "yes")
4993 #endif
4994 || !strcmp (SSDATA (tem), "true"))
4995 return Qt;
4996 else
4997 return Qnil;
4999 case RES_TYPE_STRING:
5000 return tem;
5002 case RES_TYPE_SYMBOL:
5003 /* As a special case, we map the values `true' and `on'
5004 to Qt, and `false' and `off' to Qnil. */
5006 Lisp_Object lower;
5007 lower = Fdowncase (tem);
5008 if (!strcmp (SSDATA (lower), "on")
5009 #ifdef HAVE_NS
5010 || !strcmp (SSDATA (lower), "yes")
5011 #endif
5012 || !strcmp (SSDATA (lower), "true"))
5013 return Qt;
5014 else if (!strcmp (SSDATA (lower), "off")
5015 #ifdef HAVE_NS
5016 || !strcmp (SSDATA (lower), "no")
5017 #endif
5018 || !strcmp (SSDATA (lower), "false"))
5019 return Qnil;
5020 else
5021 return Fintern (tem, Qnil);
5024 default:
5025 emacs_abort ();
5028 else
5029 return Qunbound;
5031 return Fcdr (tem);
5034 static Lisp_Object
5035 x_frame_get_arg (struct frame *f, Lisp_Object alist, Lisp_Object param,
5036 const char *attribute, const char *class,
5037 enum resource_types type)
5039 return x_get_arg (FRAME_DISPLAY_INFO (f),
5040 alist, param, attribute, class, type);
5043 /* Like x_frame_get_arg, but also record the value in f->param_alist. */
5045 Lisp_Object
5046 x_frame_get_and_record_arg (struct frame *f, Lisp_Object alist,
5047 Lisp_Object param,
5048 const char *attribute, const char *class,
5049 enum resource_types type)
5051 Lisp_Object value;
5053 value = x_get_arg (FRAME_DISPLAY_INFO (f), alist, param,
5054 attribute, class, type);
5055 if (! NILP (value) && ! EQ (value, Qunbound))
5056 store_frame_param (f, param, value);
5058 return value;
5062 /* Record in frame F the specified or default value according to ALIST
5063 of the parameter named PROP (a Lisp symbol).
5064 If no value is specified for PROP, look for an X default for XPROP
5065 on the frame named NAME.
5066 If that is not found either, use the value DEFLT. */
5068 Lisp_Object
5069 x_default_parameter (struct frame *f, Lisp_Object alist, Lisp_Object prop,
5070 Lisp_Object deflt, const char *xprop, const char *xclass,
5071 enum resource_types type)
5073 Lisp_Object tem;
5075 tem = x_frame_get_arg (f, alist, prop, xprop, xclass, type);
5076 if (EQ (tem, Qunbound))
5077 tem = deflt;
5078 AUTO_FRAME_ARG (arg, prop, tem);
5079 x_set_frame_parameters (f, arg);
5080 return tem;
5084 #if !defined (HAVE_X_WINDOWS) && defined (NoValue)
5087 * XParseGeometry parses strings of the form
5088 * "=<width>x<height>{+-}<xoffset>{+-}<yoffset>", where
5089 * width, height, xoffset, and yoffset are unsigned integers.
5090 * Example: "=80x24+300-49"
5091 * The equal sign is optional.
5092 * It returns a bitmask that indicates which of the four values
5093 * were actually found in the string. For each value found,
5094 * the corresponding argument is updated; for each value
5095 * not found, the corresponding argument is left unchanged.
5098 static int
5099 XParseGeometry (char *string,
5100 int *x, int *y,
5101 unsigned int *width, unsigned int *height)
5103 int mask = NoValue;
5104 char *strind;
5105 unsigned long tempWidth UNINIT, tempHeight UNINIT;
5106 long int tempX UNINIT, tempY UNINIT;
5107 char *nextCharacter;
5109 if (string == NULL || *string == '\0')
5110 return mask;
5111 if (*string == '=')
5112 string++; /* ignore possible '=' at beg of geometry spec */
5114 strind = string;
5115 if (*strind != '+' && *strind != '-' && *strind != 'x')
5117 tempWidth = strtoul (strind, &nextCharacter, 10);
5118 if (strind == nextCharacter)
5119 return 0;
5120 strind = nextCharacter;
5121 mask |= WidthValue;
5124 if (*strind == 'x' || *strind == 'X')
5126 strind++;
5127 tempHeight = strtoul (strind, &nextCharacter, 10);
5128 if (strind == nextCharacter)
5129 return 0;
5130 strind = nextCharacter;
5131 mask |= HeightValue;
5134 if (*strind == '+' || *strind == '-')
5136 if (*strind == '-')
5137 mask |= XNegative;
5138 tempX = strtol (strind, &nextCharacter, 10);
5139 if (strind == nextCharacter)
5140 return 0;
5141 strind = nextCharacter;
5142 mask |= XValue;
5143 if (*strind == '+' || *strind == '-')
5145 if (*strind == '-')
5146 mask |= YNegative;
5147 tempY = strtol (strind, &nextCharacter, 10);
5148 if (strind == nextCharacter)
5149 return 0;
5150 strind = nextCharacter;
5151 mask |= YValue;
5155 /* If strind isn't at the end of the string then it's an invalid
5156 geometry specification. */
5158 if (*strind != '\0')
5159 return 0;
5161 if (mask & XValue)
5162 *x = clip_to_bounds (INT_MIN, tempX, INT_MAX);
5163 if (mask & YValue)
5164 *y = clip_to_bounds (INT_MIN, tempY, INT_MAX);
5165 if (mask & WidthValue)
5166 *width = min (tempWidth, UINT_MAX);
5167 if (mask & HeightValue)
5168 *height = min (tempHeight, UINT_MAX);
5169 return mask;
5172 #endif /* !defined (HAVE_X_WINDOWS) && defined (NoValue) */
5175 /* NS used to define x-parse-geometry in ns-win.el, but that confused
5176 make-docfile: the documentation string in ns-win.el was used for
5177 x-parse-geometry even in non-NS builds.
5179 With two definitions of x-parse-geometry in this file, various
5180 things still get confused (eg M-x apropos documentation), so that
5181 it is best if the two definitions just share the same doc-string.
5183 DEFUN ("x-parse-geometry", Fx_parse_geometry, Sx_parse_geometry, 1, 1, 0,
5184 doc: /* Parse a display geometry string STRING.
5185 Returns an alist of the form ((top . TOP), (left . LEFT) ... ).
5186 The properties returned may include `top', `left', `height', and `width'.
5187 For X, the value of `left' or `top' may be an integer,
5188 or a list (+ N) meaning N pixels relative to top/left corner,
5189 or a list (- N) meaning -N pixels relative to bottom/right corner.
5190 On Nextstep, this just calls `ns-parse-geometry'. */)
5191 (Lisp_Object string)
5193 int geometry, x, y;
5194 unsigned int width, height;
5195 Lisp_Object result;
5197 CHECK_STRING (string);
5199 #ifdef HAVE_NS
5200 if (strchr (SSDATA (string), ' ') != NULL)
5201 return call1 (Qns_parse_geometry, string);
5202 #endif
5203 geometry = XParseGeometry (SSDATA (string),
5204 &x, &y, &width, &height);
5205 result = Qnil;
5206 if (geometry & XValue)
5208 Lisp_Object element;
5210 if (x >= 0 && (geometry & XNegative))
5211 element = list3 (Qleft, Qminus, make_number (-x));
5212 else if (x < 0 && ! (geometry & XNegative))
5213 element = list3 (Qleft, Qplus, make_number (x));
5214 else
5215 element = Fcons (Qleft, make_number (x));
5216 result = Fcons (element, result);
5219 if (geometry & YValue)
5221 Lisp_Object element;
5223 if (y >= 0 && (geometry & YNegative))
5224 element = list3 (Qtop, Qminus, make_number (-y));
5225 else if (y < 0 && ! (geometry & YNegative))
5226 element = list3 (Qtop, Qplus, make_number (y));
5227 else
5228 element = Fcons (Qtop, make_number (y));
5229 result = Fcons (element, result);
5232 if (geometry & WidthValue)
5233 result = Fcons (Fcons (Qwidth, make_number (width)), result);
5234 if (geometry & HeightValue)
5235 result = Fcons (Fcons (Qheight, make_number (height)), result);
5237 return result;
5241 /* Calculate the desired size and position of frame F.
5242 Return the flags saying which aspects were specified.
5244 Also set the win_gravity and size_hint_flags of F.
5246 Adjust height for toolbar if TOOLBAR_P is 1.
5248 This function does not make the coordinates positive. */
5250 #define DEFAULT_ROWS 36
5251 #define DEFAULT_COLS 80
5253 long
5254 x_figure_window_size (struct frame *f, Lisp_Object parms, bool toolbar_p, int *x_width, int *x_height)
5256 Lisp_Object height, width, user_size, top, left, user_position;
5257 long window_prompting = 0;
5258 Display_Info *dpyinfo = FRAME_DISPLAY_INFO (f);
5259 int parent_done = -1, outer_done = -1;
5261 /* Default values if we fall through.
5262 Actually, if that happens we should get
5263 window manager prompting. */
5264 SET_FRAME_WIDTH (f, DEFAULT_COLS * FRAME_COLUMN_WIDTH (f));
5265 SET_FRAME_COLS (f, DEFAULT_COLS);
5266 SET_FRAME_HEIGHT (f, DEFAULT_ROWS * FRAME_LINE_HEIGHT (f));
5267 SET_FRAME_LINES (f, DEFAULT_ROWS);
5269 /* Window managers expect that if program-specified
5270 positions are not (0,0), they're intentional, not defaults. */
5271 f->top_pos = 0;
5272 f->left_pos = 0;
5274 /* Calculate a tool bar height so that the user gets a text display
5275 area of the size he specified with -g or via .Xdefaults. Later
5276 changes of the tool bar height don't change the frame size. This
5277 is done so that users can create tall Emacs frames without having
5278 to guess how tall the tool bar will get. */
5279 if (toolbar_p && FRAME_TOOL_BAR_LINES (f))
5281 if (frame_default_tool_bar_height)
5282 FRAME_TOOL_BAR_HEIGHT (f) = frame_default_tool_bar_height;
5283 else
5285 int margin, relief;
5287 relief = (tool_bar_button_relief >= 0
5288 ? tool_bar_button_relief
5289 : DEFAULT_TOOL_BAR_BUTTON_RELIEF);
5291 if (RANGED_INTEGERP (1, Vtool_bar_button_margin, INT_MAX))
5292 margin = XFASTINT (Vtool_bar_button_margin);
5293 else if (CONSP (Vtool_bar_button_margin)
5294 && RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin), INT_MAX))
5295 margin = XFASTINT (XCDR (Vtool_bar_button_margin));
5296 else
5297 margin = 0;
5299 FRAME_TOOL_BAR_HEIGHT (f)
5300 = DEFAULT_TOOL_BAR_IMAGE_HEIGHT + 2 * margin + 2 * relief;
5304 /* Ensure that earlier new_width and new_height settings won't
5305 override what we specify below. */
5306 f->new_width = f->new_height = 0;
5308 height = x_get_arg (dpyinfo, parms, Qheight, 0, 0, RES_TYPE_NUMBER);
5309 width = x_get_arg (dpyinfo, parms, Qwidth, 0, 0, RES_TYPE_NUMBER);
5310 if (!EQ (width, Qunbound) || !EQ (height, Qunbound))
5312 if (!EQ (width, Qunbound))
5314 if (CONSP (width) && EQ (XCAR (width), Qtext_pixels))
5316 CHECK_NUMBER (XCDR (width));
5317 if ((XINT (XCDR (width)) < 0 || XINT (XCDR (width)) > INT_MAX))
5318 xsignal1 (Qargs_out_of_range, XCDR (width));
5320 SET_FRAME_WIDTH (f, XINT (XCDR (width)));
5321 f->inhibit_horizontal_resize = true;
5322 *x_width = XINT (XCDR (width));
5324 else if (FLOATP (width))
5326 double d_width = XFLOAT_DATA (width);
5328 if (d_width < 0.0 || d_width > 1.0)
5329 xsignal1 (Qargs_out_of_range, width);
5330 else
5332 int new_width = frame_float (f, width, FRAME_FLOAT_WIDTH,
5333 &parent_done, &outer_done, -1);
5335 if (new_width > -1)
5336 SET_FRAME_WIDTH (f, new_width);
5339 else
5341 CHECK_NUMBER (width);
5342 if ((XINT (width) < 0 || XINT (width) > INT_MAX))
5343 xsignal1 (Qargs_out_of_range, width);
5345 SET_FRAME_WIDTH (f, XINT (width) * FRAME_COLUMN_WIDTH (f));
5349 if (!EQ (height, Qunbound))
5351 if (CONSP (height) && EQ (XCAR (height), Qtext_pixels))
5353 CHECK_NUMBER (XCDR (height));
5354 if ((XINT (XCDR (height)) < 0 || XINT (XCDR (height)) > INT_MAX))
5355 xsignal1 (Qargs_out_of_range, XCDR (height));
5357 SET_FRAME_HEIGHT (f, XINT (XCDR (height)));
5358 f->inhibit_vertical_resize = true;
5359 *x_height = XINT (XCDR (height));
5361 else if (FLOATP (height))
5363 double d_height = XFLOAT_DATA (height);
5365 if (d_height < 0.0 || d_height > 1.0)
5366 xsignal1 (Qargs_out_of_range, height);
5367 else
5369 int new_height = frame_float (f, height, FRAME_FLOAT_HEIGHT,
5370 &parent_done, &outer_done, -1);
5372 if (new_height > -1)
5373 SET_FRAME_HEIGHT (f, new_height);
5376 else
5378 CHECK_NUMBER (height);
5379 if ((XINT (height) < 0) || (XINT (height) > INT_MAX))
5380 xsignal1 (Qargs_out_of_range, height);
5382 SET_FRAME_HEIGHT (f, XINT (height) * FRAME_LINE_HEIGHT (f));
5386 user_size = x_get_arg (dpyinfo, parms, Quser_size, 0, 0, RES_TYPE_NUMBER);
5387 if (!NILP (user_size) && !EQ (user_size, Qunbound))
5388 window_prompting |= USSize;
5389 else
5390 window_prompting |= PSize;
5393 top = x_get_arg (dpyinfo, parms, Qtop, 0, 0, RES_TYPE_NUMBER);
5394 left = x_get_arg (dpyinfo, parms, Qleft, 0, 0, RES_TYPE_NUMBER);
5395 user_position = x_get_arg (dpyinfo, parms, Quser_position, 0, 0, RES_TYPE_NUMBER);
5396 if (! EQ (top, Qunbound) || ! EQ (left, Qunbound))
5398 if (EQ (top, Qminus))
5400 f->top_pos = 0;
5401 window_prompting |= YNegative;
5403 else if (CONSP (top) && EQ (XCAR (top), Qminus)
5404 && CONSP (XCDR (top))
5405 && RANGED_INTEGERP (-INT_MAX, XCAR (XCDR (top)), INT_MAX))
5407 f->top_pos = - XINT (XCAR (XCDR (top)));
5408 window_prompting |= YNegative;
5410 else if (CONSP (top) && EQ (XCAR (top), Qplus)
5411 && CONSP (XCDR (top))
5412 && TYPE_RANGED_INTEGERP (int, XCAR (XCDR (top))))
5414 f->top_pos = XINT (XCAR (XCDR (top)));
5416 else if (FLOATP (top))
5417 f->top_pos = frame_float (f, top, FRAME_FLOAT_TOP, &parent_done,
5418 &outer_done, 0);
5419 else if (EQ (top, Qunbound))
5420 f->top_pos = 0;
5421 else
5423 CHECK_TYPE_RANGED_INTEGER (int, top);
5424 f->top_pos = XINT (top);
5425 if (f->top_pos < 0)
5426 window_prompting |= YNegative;
5429 if (EQ (left, Qminus))
5431 f->left_pos = 0;
5432 window_prompting |= XNegative;
5434 else if (CONSP (left) && EQ (XCAR (left), Qminus)
5435 && CONSP (XCDR (left))
5436 && RANGED_INTEGERP (-INT_MAX, XCAR (XCDR (left)), INT_MAX))
5438 f->left_pos = - XINT (XCAR (XCDR (left)));
5439 window_prompting |= XNegative;
5441 else if (CONSP (left) && EQ (XCAR (left), Qplus)
5442 && CONSP (XCDR (left))
5443 && TYPE_RANGED_INTEGERP (int, XCAR (XCDR (left))))
5445 f->left_pos = XINT (XCAR (XCDR (left)));
5447 else if (FLOATP (left))
5448 f->left_pos = frame_float (f, left, FRAME_FLOAT_LEFT, &parent_done,
5449 &outer_done, 0);
5450 else if (EQ (left, Qunbound))
5451 f->left_pos = 0;
5452 else
5454 CHECK_TYPE_RANGED_INTEGER (int, left);
5455 f->left_pos = XINT (left);
5456 if (f->left_pos < 0)
5457 window_prompting |= XNegative;
5460 if (!NILP (user_position) && ! EQ (user_position, Qunbound))
5461 window_prompting |= USPosition;
5462 else
5463 window_prompting |= PPosition;
5466 if (window_prompting & XNegative)
5468 if (window_prompting & YNegative)
5469 f->win_gravity = SouthEastGravity;
5470 else
5471 f->win_gravity = NorthEastGravity;
5473 else
5475 if (window_prompting & YNegative)
5476 f->win_gravity = SouthWestGravity;
5477 else
5478 f->win_gravity = NorthWestGravity;
5481 f->size_hint_flags = window_prompting;
5483 return window_prompting;
5488 #endif /* HAVE_WINDOW_SYSTEM */
5490 void
5491 frame_make_pointer_invisible (struct frame *f)
5493 if (! NILP (Vmake_pointer_invisible))
5495 if (f && FRAME_LIVE_P (f) && !f->pointer_invisible
5496 && FRAME_TERMINAL (f)->toggle_invisible_pointer_hook)
5498 f->mouse_moved = 0;
5499 FRAME_TERMINAL (f)->toggle_invisible_pointer_hook (f, 1);
5500 f->pointer_invisible = 1;
5505 void
5506 frame_make_pointer_visible (struct frame *f)
5508 /* We don't check Vmake_pointer_invisible here in case the
5509 pointer was invisible when Vmake_pointer_invisible was set to nil. */
5510 if (f && FRAME_LIVE_P (f) && f->pointer_invisible && f->mouse_moved
5511 && FRAME_TERMINAL (f)->toggle_invisible_pointer_hook)
5513 FRAME_TERMINAL (f)->toggle_invisible_pointer_hook (f, 0);
5514 f->pointer_invisible = 0;
5518 DEFUN ("frame-pointer-visible-p", Fframe_pointer_visible_p,
5519 Sframe_pointer_visible_p, 0, 1, 0,
5520 doc: /* Return t if the mouse pointer displayed on FRAME is visible.
5521 Otherwise it returns nil. FRAME omitted or nil means the
5522 selected frame. This is useful when `make-pointer-invisible' is set. */)
5523 (Lisp_Object frame)
5525 return decode_any_frame (frame)->pointer_invisible ? Qnil : Qt;
5530 /***********************************************************************
5531 Multimonitor data
5532 ***********************************************************************/
5534 #ifdef HAVE_WINDOW_SYSTEM
5536 # if (defined HAVE_NS \
5537 || (!defined USE_GTK && (defined HAVE_XINERAMA || defined HAVE_XRANDR)))
5538 void
5539 free_monitors (struct MonitorInfo *monitors, int n_monitors)
5541 int i;
5542 for (i = 0; i < n_monitors; ++i)
5543 xfree (monitors[i].name);
5544 xfree (monitors);
5546 # endif
5548 Lisp_Object
5549 make_monitor_attribute_list (struct MonitorInfo *monitors,
5550 int n_monitors,
5551 int primary_monitor,
5552 Lisp_Object monitor_frames,
5553 const char *source)
5555 Lisp_Object attributes_list = Qnil;
5556 Lisp_Object primary_monitor_attributes = Qnil;
5557 int i;
5559 for (i = 0; i < n_monitors; ++i)
5561 Lisp_Object geometry, workarea, attributes = Qnil;
5562 struct MonitorInfo *mi = &monitors[i];
5564 if (mi->geom.width == 0) continue;
5566 workarea = list4i (mi->work.x, mi->work.y,
5567 mi->work.width, mi->work.height);
5568 geometry = list4i (mi->geom.x, mi->geom.y,
5569 mi->geom.width, mi->geom.height);
5570 attributes = Fcons (Fcons (Qsource, build_string (source)),
5571 attributes);
5572 attributes = Fcons (Fcons (Qframes, AREF (monitor_frames, i)),
5573 attributes);
5574 attributes = Fcons (Fcons (Qmm_size,
5575 list2i (mi->mm_width, mi->mm_height)),
5576 attributes);
5577 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
5578 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
5579 if (mi->name)
5580 attributes = Fcons (Fcons (Qname, make_string (mi->name,
5581 strlen (mi->name))),
5582 attributes);
5584 if (i == primary_monitor)
5585 primary_monitor_attributes = attributes;
5586 else
5587 attributes_list = Fcons (attributes, attributes_list);
5590 if (!NILP (primary_monitor_attributes))
5591 attributes_list = Fcons (primary_monitor_attributes, attributes_list);
5592 return attributes_list;
5595 #endif /* HAVE_WINDOW_SYSTEM */
5598 /***********************************************************************
5599 Initialization
5600 ***********************************************************************/
5602 void
5603 syms_of_frame (void)
5605 DEFSYM (Qframep, "framep");
5606 DEFSYM (Qframe_live_p, "frame-live-p");
5607 DEFSYM (Qframe_windows_min_size, "frame-windows-min-size");
5608 DEFSYM (Qdisplay_monitor_attributes_list, "display-monitor-attributes-list");
5609 DEFSYM (Qwindow__pixel_to_total, "window--pixel-to-total");
5610 DEFSYM (Qexplicit_name, "explicit-name");
5611 DEFSYM (Qheight, "height");
5612 DEFSYM (Qicon, "icon");
5613 DEFSYM (Qminibuffer, "minibuffer");
5614 DEFSYM (Qundecorated, "undecorated");
5615 DEFSYM (Qno_special_glyphs, "no-special-glyphs");
5616 DEFSYM (Qparent_frame, "parent-frame");
5617 DEFSYM (Qskip_taskbar, "skip-taskbar");
5618 DEFSYM (Qno_focus_on_map, "no-focus-on-map");
5619 DEFSYM (Qno_accept_focus, "no-accept-focus");
5620 DEFSYM (Qz_group, "z-group");
5621 DEFSYM (Qoverride_redirect, "override-redirect");
5622 DEFSYM (Qdelete_before, "delete-before");
5623 DEFSYM (Qmodeline, "modeline");
5624 DEFSYM (Qonly, "only");
5625 DEFSYM (Qnone, "none");
5626 DEFSYM (Qwidth, "width");
5627 DEFSYM (Qtext_pixels, "text-pixels");
5628 DEFSYM (Qgeometry, "geometry");
5629 DEFSYM (Qicon_left, "icon-left");
5630 DEFSYM (Qicon_top, "icon-top");
5631 DEFSYM (Qtooltip, "tooltip");
5632 DEFSYM (Quser_position, "user-position");
5633 DEFSYM (Quser_size, "user-size");
5634 DEFSYM (Qwindow_id, "window-id");
5635 #ifdef HAVE_X_WINDOWS
5636 DEFSYM (Qouter_window_id, "outer-window-id");
5637 #endif
5638 DEFSYM (Qparent_id, "parent-id");
5639 DEFSYM (Qx, "x");
5640 DEFSYM (Qw32, "w32");
5641 DEFSYM (Qpc, "pc");
5642 DEFSYM (Qns, "ns");
5643 DEFSYM (Qvisible, "visible");
5644 DEFSYM (Qbuffer_predicate, "buffer-predicate");
5645 DEFSYM (Qbuffer_list, "buffer-list");
5646 DEFSYM (Qburied_buffer_list, "buried-buffer-list");
5647 DEFSYM (Qdisplay_type, "display-type");
5648 DEFSYM (Qbackground_mode, "background-mode");
5649 DEFSYM (Qnoelisp, "noelisp");
5650 DEFSYM (Qtty_color_mode, "tty-color-mode");
5651 DEFSYM (Qtty, "tty");
5652 DEFSYM (Qtty_type, "tty-type");
5654 DEFSYM (Qface_set_after_frame_default, "face-set-after-frame-default");
5656 DEFSYM (Qfullwidth, "fullwidth");
5657 DEFSYM (Qfullheight, "fullheight");
5658 DEFSYM (Qfullboth, "fullboth");
5659 DEFSYM (Qmaximized, "maximized");
5660 DEFSYM (Qx_resource_name, "x-resource-name");
5661 DEFSYM (Qx_frame_parameter, "x-frame-parameter");
5663 DEFSYM (Qworkarea, "workarea");
5664 DEFSYM (Qmm_size, "mm-size");
5665 DEFSYM (Qframes, "frames");
5666 DEFSYM (Qsource, "source");
5668 DEFSYM (Qframe_edges, "frame-edges");
5669 DEFSYM (Qouter_edges, "outer-edges");
5670 DEFSYM (Qouter_position, "outer-position");
5671 DEFSYM (Qouter_size, "outer-size");
5672 DEFSYM (Qnative_edges, "native-edges");
5673 DEFSYM (Qinner_edges, "inner-edges");
5674 DEFSYM (Qexternal_border_size, "external-border-size");
5675 DEFSYM (Qtitle_bar_size, "title-bar-size");
5676 DEFSYM (Qmenu_bar_external, "menu-bar-external");
5677 DEFSYM (Qmenu_bar_size, "menu-bar-size");
5678 DEFSYM (Qtool_bar_external, "tool-bar-external");
5679 DEFSYM (Qtool_bar_size, "tool-bar-size");
5680 /* The following are used for frame_size_history. */
5681 DEFSYM (Qadjust_frame_size_1, "adjust-frame-size-1");
5682 DEFSYM (Qadjust_frame_size_2, "adjust-frame-size-2");
5683 DEFSYM (Qadjust_frame_size_3, "adjust-frame-size-3");
5684 DEFSYM (Qx_set_frame_parameters, "x-set-frame-parameters");
5685 DEFSYM (QEmacsFrameResize, "EmacsFrameResize");
5686 DEFSYM (Qset_frame_size, "set-frame-size");
5687 DEFSYM (Qframe_inhibit_resize, "frame-inhibit-resize");
5688 DEFSYM (Qx_set_fullscreen, "x-set-fullscreen");
5689 DEFSYM (Qx_check_fullscreen, "x-check-fullscreen");
5690 DEFSYM (Qxg_frame_resized, "xg-frame-resized");
5691 DEFSYM (Qxg_frame_set_char_size_1, "xg-frame-set-char-size-1");
5692 DEFSYM (Qxg_frame_set_char_size_2, "xg-frame-set-char-size-2");
5693 DEFSYM (Qxg_frame_set_char_size_3, "xg-frame-set-char-size-3");
5694 DEFSYM (Qx_set_window_size_1, "x-set-window-size-1");
5695 DEFSYM (Qx_set_window_size_2, "x-set-window-size-2");
5696 DEFSYM (Qx_set_window_size_3, "x-set-window-size-3");
5697 DEFSYM (Qxg_change_toolbar_position, "xg-change-toolbar-position");
5698 DEFSYM (Qx_net_wm_state, "x-net-wm-state");
5699 DEFSYM (Qx_handle_net_wm_state, "x-handle-net-wm-state");
5700 DEFSYM (Qtb_size_cb, "tb-size-cb");
5701 DEFSYM (Qupdate_frame_tool_bar, "update-frame-tool-bar");
5702 DEFSYM (Qfree_frame_tool_bar, "free-frame-tool-bar");
5703 DEFSYM (Qx_set_menu_bar_lines, "x-set-menu-bar-lines");
5704 DEFSYM (Qchange_frame_size, "change-frame-size");
5705 DEFSYM (Qxg_frame_set_char_size, "xg-frame-set-char-size");
5706 DEFSYM (Qset_window_configuration, "set-window-configuration");
5707 DEFSYM (Qx_create_frame_1, "x-create-frame-1");
5708 DEFSYM (Qx_create_frame_2, "x-create-frame-2");
5709 DEFSYM (Qterminal_frame, "terminal-frame");
5711 #ifdef HAVE_NS
5712 DEFSYM (Qns_parse_geometry, "ns-parse-geometry");
5713 #endif
5714 #ifdef NS_IMPL_COCOA
5715 DEFSYM (Qns_appearance, "ns-appearance");
5716 DEFSYM (Qns_transparent_titlebar, "ns-transparent-titlebar");
5717 #endif
5719 DEFSYM (Qalpha, "alpha");
5720 DEFSYM (Qauto_lower, "auto-lower");
5721 DEFSYM (Qauto_raise, "auto-raise");
5722 DEFSYM (Qborder_color, "border-color");
5723 DEFSYM (Qborder_width, "border-width");
5724 DEFSYM (Qouter_border_width, "outer-border-width");
5725 DEFSYM (Qbottom_divider_width, "bottom-divider-width");
5726 DEFSYM (Qcursor_color, "cursor-color");
5727 DEFSYM (Qcursor_type, "cursor-type");
5728 DEFSYM (Qfont_backend, "font-backend");
5729 DEFSYM (Qfullscreen, "fullscreen");
5730 DEFSYM (Qhorizontal_scroll_bars, "horizontal-scroll-bars");
5731 DEFSYM (Qicon_name, "icon-name");
5732 DEFSYM (Qicon_type, "icon-type");
5733 DEFSYM (Qinternal_border_width, "internal-border-width");
5734 DEFSYM (Qleft_fringe, "left-fringe");
5735 DEFSYM (Qline_spacing, "line-spacing");
5736 DEFSYM (Qmenu_bar_lines, "menu-bar-lines");
5737 DEFSYM (Qupdate_frame_menubar, "update-frame-menubar");
5738 DEFSYM (Qfree_frame_menubar_1, "free-frame-menubar-1");
5739 DEFSYM (Qfree_frame_menubar_2, "free-frame-menubar-2");
5740 DEFSYM (Qmouse_color, "mouse-color");
5741 DEFSYM (Qname, "name");
5742 DEFSYM (Qright_divider_width, "right-divider-width");
5743 DEFSYM (Qright_fringe, "right-fringe");
5744 DEFSYM (Qscreen_gamma, "screen-gamma");
5745 DEFSYM (Qscroll_bar_background, "scroll-bar-background");
5746 DEFSYM (Qscroll_bar_foreground, "scroll-bar-foreground");
5747 DEFSYM (Qscroll_bar_height, "scroll-bar-height");
5748 DEFSYM (Qscroll_bar_width, "scroll-bar-width");
5749 DEFSYM (Qsticky, "sticky");
5750 DEFSYM (Qtitle, "title");
5751 DEFSYM (Qtool_bar_lines, "tool-bar-lines");
5752 DEFSYM (Qtool_bar_position, "tool-bar-position");
5753 DEFSYM (Qunsplittable, "unsplittable");
5754 DEFSYM (Qvertical_scroll_bars, "vertical-scroll-bars");
5755 DEFSYM (Qvisibility, "visibility");
5756 DEFSYM (Qwait_for_wm, "wait-for-wm");
5757 DEFSYM (Qinhibit_double_buffering, "inhibit-double-buffering");
5758 DEFSYM (Qno_other_frame, "no-other-frame");
5759 DEFSYM (Qbelow, "below");
5760 DEFSYM (Qabove_suspended, "above-suspended");
5761 DEFSYM (Qmin_width, "min-width");
5762 DEFSYM (Qmin_height, "min-height");
5763 DEFSYM (Qmouse_wheel_frame, "mouse-wheel-frame");
5764 DEFSYM (Qkeep_ratio, "keep-ratio");
5765 DEFSYM (Qwidth_only, "width-only");
5766 DEFSYM (Qheight_only, "height-only");
5767 DEFSYM (Qleft_only, "left-only");
5768 DEFSYM (Qtop_only, "top-only");
5769 DEFSYM (Qiconify_top_level, "iconify-top-level");
5770 DEFSYM (Qmake_invisible, "make-invisible");
5773 int i;
5775 for (i = 0; i < ARRAYELTS (frame_parms); i++)
5777 Lisp_Object v = (frame_parms[i].sym < 0
5778 ? intern_c_string (frame_parms[i].name)
5779 : builtin_lisp_symbol (frame_parms[i].sym));
5780 Fput (v, Qx_frame_parameter, make_number (i));
5784 #ifdef HAVE_WINDOW_SYSTEM
5785 DEFVAR_LISP ("x-resource-name", Vx_resource_name,
5786 doc: /* The name Emacs uses to look up X resources.
5787 `x-get-resource' uses this as the first component of the instance name
5788 when requesting resource values.
5789 Emacs initially sets `x-resource-name' to the name under which Emacs
5790 was invoked, or to the value specified with the `-name' or `-rn'
5791 switches, if present.
5793 It may be useful to bind this variable locally around a call
5794 to `x-get-resource'. See also the variable `x-resource-class'. */);
5795 Vx_resource_name = Qnil;
5797 DEFVAR_LISP ("x-resource-class", Vx_resource_class,
5798 doc: /* The class Emacs uses to look up X resources.
5799 `x-get-resource' uses this as the first component of the instance class
5800 when requesting resource values.
5802 Emacs initially sets `x-resource-class' to "Emacs".
5804 Setting this variable permanently is not a reasonable thing to do,
5805 but binding this variable locally around a call to `x-get-resource'
5806 is a reasonable practice. See also the variable `x-resource-name'. */);
5807 Vx_resource_class = build_string (EMACS_CLASS);
5809 DEFVAR_LISP ("frame-alpha-lower-limit", Vframe_alpha_lower_limit,
5810 doc: /* The lower limit of the frame opacity (alpha transparency).
5811 The value should range from 0 (invisible) to 100 (completely opaque).
5812 You can also use a floating number between 0.0 and 1.0. */);
5813 Vframe_alpha_lower_limit = make_number (20);
5814 #endif
5816 DEFVAR_LISP ("default-frame-alist", Vdefault_frame_alist,
5817 doc: /* Alist of default values for frame creation.
5818 These may be set in your init file, like this:
5819 (setq default-frame-alist \\='((width . 80) (height . 55) (menu-bar-lines . 1)))
5820 These override values given in window system configuration data,
5821 including X Windows' defaults database.
5822 For values specific to the first Emacs frame, see `initial-frame-alist'.
5823 For window-system specific values, see `window-system-default-frame-alist'.
5824 For values specific to the separate minibuffer frame, see
5825 `minibuffer-frame-alist'.
5826 The `menu-bar-lines' element of the list controls whether new frames
5827 have menu bars; `menu-bar-mode' works by altering this element.
5828 Setting this variable does not affect existing frames, only new ones. */);
5829 Vdefault_frame_alist = Qnil;
5831 DEFVAR_LISP ("default-frame-scroll-bars", Vdefault_frame_scroll_bars,
5832 doc: /* Default position of vertical scroll bars on this window-system. */);
5833 #ifdef HAVE_WINDOW_SYSTEM
5834 #if defined (HAVE_NTGUI) || defined (NS_IMPL_COCOA) || (defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS))
5835 /* MS-Windows, macOS, and GTK have scroll bars on the right by
5836 default. */
5837 Vdefault_frame_scroll_bars = Qright;
5838 #else
5839 Vdefault_frame_scroll_bars = Qleft;
5840 #endif
5841 #else
5842 Vdefault_frame_scroll_bars = Qnil;
5843 #endif
5845 DEFVAR_BOOL ("scroll-bar-adjust-thumb-portion",
5846 scroll_bar_adjust_thumb_portion_p,
5847 doc: /* Adjust thumb for overscrolling for Gtk+ and MOTIF.
5848 Non-nil means adjust the thumb in the scroll bar so it can be dragged downwards
5849 even if the end of the buffer is shown (i.e. overscrolling).
5850 Set to nil if you want the thumb to be at the bottom when the end of the buffer
5851 is shown. Also, the thumb fills the whole scroll bar when the entire buffer
5852 is visible. In this case you can not overscroll. */);
5853 scroll_bar_adjust_thumb_portion_p = 1;
5855 DEFVAR_LISP ("terminal-frame", Vterminal_frame,
5856 doc: /* The initial frame-object, which represents Emacs's stdout. */);
5858 DEFVAR_LISP ("mouse-position-function", Vmouse_position_function,
5859 doc: /* If non-nil, function to transform normal value of `mouse-position'.
5860 `mouse-position' and `mouse-pixel-position' call this function, passing their
5861 usual return value as argument, and return whatever this function returns.
5862 This abnormal hook exists for the benefit of packages like `xt-mouse.el'
5863 which need to do mouse handling at the Lisp level. */);
5864 Vmouse_position_function = Qnil;
5866 DEFVAR_LISP ("mouse-highlight", Vmouse_highlight,
5867 doc: /* If non-nil, clickable text is highlighted when mouse is over it.
5868 If the value is an integer, highlighting is only shown after moving the
5869 mouse, while keyboard input turns off the highlight even when the mouse
5870 is over the clickable text. However, the mouse shape still indicates
5871 when the mouse is over clickable text. */);
5872 Vmouse_highlight = Qt;
5874 DEFVAR_LISP ("make-pointer-invisible", Vmake_pointer_invisible,
5875 doc: /* If non-nil, make pointer invisible while typing.
5876 The pointer becomes visible again when the mouse is moved. */);
5877 Vmake_pointer_invisible = Qt;
5879 DEFVAR_LISP ("focus-in-hook", Vfocus_in_hook,
5880 doc: /* Normal hook run when a frame gains input focus.
5881 The frame gaining focus is selected at the time this hook is run. */);
5882 Vfocus_in_hook = Qnil;
5884 DEFVAR_LISP ("focus-out-hook", Vfocus_out_hook,
5885 doc: /* Normal hook run when all frames lost input focus. */);
5886 Vfocus_out_hook = Qnil;
5888 DEFVAR_LISP ("move-frame-functions", Vmove_frame_functions,
5889 doc: /* Functions run after a frame was moved.
5890 The functions are run with one arg, the frame that moved. */);
5891 Vmove_frame_functions = Qnil;
5893 DEFVAR_LISP ("delete-frame-functions", Vdelete_frame_functions,
5894 doc: /* Functions run before deleting a frame.
5895 The functions are run with one arg, the frame to be deleted.
5896 See `delete-frame'.
5898 Note that functions in this list may be called just before the frame is
5899 actually deleted, or some time later (or even both when an earlier function
5900 in `delete-frame-functions' (indirectly) calls `delete-frame'
5901 recursively). */);
5902 Vdelete_frame_functions = Qnil;
5903 DEFSYM (Qdelete_frame_functions, "delete-frame-functions");
5905 DEFVAR_LISP ("menu-bar-mode", Vmenu_bar_mode,
5906 doc: /* Non-nil if Menu-Bar mode is enabled.
5907 See the command `menu-bar-mode' for a description of this minor mode.
5908 Setting this variable directly does not take effect;
5909 either customize it (see the info node `Easy Customization')
5910 or call the function `menu-bar-mode'. */);
5911 Vmenu_bar_mode = Qt;
5913 DEFVAR_LISP ("tool-bar-mode", Vtool_bar_mode,
5914 doc: /* Non-nil if Tool-Bar mode is enabled.
5915 See the command `tool-bar-mode' for a description of this minor mode.
5916 Setting this variable directly does not take effect;
5917 either customize it (see the info node `Easy Customization')
5918 or call the function `tool-bar-mode'. */);
5919 #ifdef HAVE_WINDOW_SYSTEM
5920 Vtool_bar_mode = Qt;
5921 #else
5922 Vtool_bar_mode = Qnil;
5923 #endif
5925 DEFVAR_KBOARD ("default-minibuffer-frame", Vdefault_minibuffer_frame,
5926 doc: /* Minibuffer-less frames by default use this frame's minibuffer.
5927 Emacs consults this variable only when creating a minibuffer-less frame
5928 and no explicit minibuffer window has been specified for that frame via
5929 the `minibuffer' frame parameter. Once such a frame has been created,
5930 setting this variable does not change that frame's previous association.
5932 This variable is local to the current terminal and cannot be buffer-local. */);
5934 DEFVAR_LISP ("focus-follows-mouse", focus_follows_mouse,
5935 doc: /* Non-nil if window system changes focus when you move the mouse.
5936 You should set this variable to tell Emacs how your window manager
5937 handles focus, since there is no way in general for Emacs to find out
5938 automatically.
5940 There are three meaningful values:
5942 - The default nil should be used when your window manager follows a
5943 "click-to-focus" policy where you have to click the mouse inside of a
5944 frame in order for that frame to get focus.
5946 - The value t should be used when your window manager has the focus
5947 automatically follow the position of the mouse pointer but a window
5948 that gains focus is not raised automatically.
5950 - The value `auto-raise' should be used when your window manager has the
5951 focus automatically follow the position of the mouse pointer and a
5952 window that gains focus is raised automatically.
5954 If this option is non-nil, Emacs moves the mouse pointer to the frame
5955 selected by `select-frame-set-input-focus'. This function is used by a
5956 number of commands like, for example, `other-frame' and `pop-to-buffer'.
5957 If this option is nil and your focus follows mouse window manager does
5958 not autonomously move the mouse pointer to the newly selected frame, the
5959 previously selected window manager window might get reselected instead
5960 immediately.
5962 The distinction between the values t and `auto-raise' is not needed for
5963 "normal" frames because the window manager takes care of raising them.
5964 Setting this to `auto-raise' will, however, override the standard
5965 behavior of a window manager that does not automatically raise the frame
5966 that gets focus. Setting this to `auto-raise' is also necessary to
5967 automatically raise child frames which are usually left alone by the
5968 window manager.
5970 Note that this option does not distinguish "sloppy" focus (where the
5971 frame that previously had focus retains focus as long as the mouse
5972 pointer does not move into another window manager window) from "strict"
5973 focus (where a frame immediately loses focus when it's left by the mouse
5974 pointer).
5976 In order to extend a "focus follows mouse" policy to individual Emacs
5977 windows, customize the variable `mouse-autoselect-window'. */);
5978 focus_follows_mouse = Qnil;
5980 DEFVAR_BOOL ("frame-resize-pixelwise", frame_resize_pixelwise,
5981 doc: /* Non-nil means resize frames pixelwise.
5982 If this option is nil, resizing a frame rounds its sizes to the frame's
5983 current values of `frame-char-height' and `frame-char-width'. If this
5984 is non-nil, no rounding occurs, hence frame sizes can increase/decrease
5985 by one pixel.
5987 With some window managers you may have to set this to non-nil in order
5988 to set the size of a frame in pixels, to maximize frames or to make them
5989 fullscreen. To resize your initial frame pixelwise, set this option to
5990 a non-nil value in your init file. */);
5991 frame_resize_pixelwise = 0;
5993 DEFVAR_LISP ("frame-inhibit-implied-resize", frame_inhibit_implied_resize,
5994 doc: /* Whether frames should be resized implicitly.
5995 If this option is nil, setting font, menu bar, tool bar, internal
5996 borders, fringes or scroll bars of a specific frame may resize the frame
5997 in order to preserve the number of columns or lines it displays. If
5998 this option is t, no such resizing is done. Note that the size of
5999 fullscreen and maximized frames, the height of fullheight frames and the
6000 width of fullwidth frames never change implicitly.
6002 The value of this option can be also be a list of frame parameters. In
6003 this case, resizing is inhibited when changing a parameter that appears
6004 in that list. The parameters currently handled by this option include
6005 `font', `font-backend', `internal-border-width', `menu-bar-lines' and
6006 `tool-bar-lines'.
6008 Changing any of the parameters `scroll-bar-width', `scroll-bar-height',
6009 `vertical-scroll-bars', `horizontal-scroll-bars', `left-fringe' and
6010 `right-fringe' is handled as if the frame contained just one live
6011 window. This means, for example, that removing vertical scroll bars on
6012 a frame containing several side by side windows will shrink the frame
6013 width by the width of one scroll bar provided this option is nil and
6014 keep it unchanged if this option is either t or a list containing
6015 `vertical-scroll-bars'.
6017 The default value is \\='(tool-bar-lines) on Lucid, Motif and Windows
6018 \(which means that adding/removing a tool bar does not change the frame
6019 height), nil on all other window systems including GTK+ (which means
6020 that changing any of the parameters listed above may change the size of
6021 the frame), and t otherwise (which means the frame size never changes
6022 implicitly when there's no window system support).
6024 Note that when a frame is not large enough to accommodate a change of
6025 any of the parameters listed above, Emacs may try to enlarge the frame
6026 even if this option is non-nil. */);
6027 #if defined (HAVE_WINDOW_SYSTEM)
6028 #if defined (USE_LUCID) || defined (USE_MOTIF) || defined (HAVE_NTGUI)
6029 frame_inhibit_implied_resize = list1 (Qtool_bar_lines);
6030 #else
6031 frame_inhibit_implied_resize = Qnil;
6032 #endif
6033 #else
6034 frame_inhibit_implied_resize = Qt;
6035 #endif
6037 DEFVAR_LISP ("frame-size-history", frame_size_history,
6038 doc: /* History of frame size adjustments.
6039 If non-nil, list recording frame size adjustment. Adjustments are
6040 recorded only if the first element of this list is a positive number.
6041 Adding an adjustment decrements that number by one.
6043 The remaining elements are the adjustments. Each adjustment is a list
6044 of four elements `frame', `function', `sizes' and `more'. `frame' is
6045 the affected frame and `function' the invoking function. `sizes' is
6046 usually a list of four elements `old-width', `old-height', `new-width'
6047 and `new-height' representing the old and new sizes recorded/requested
6048 by `function'. `more' is a list with additional information.
6050 The function `frame--size-history' displays the value of this variable
6051 in a more readable form. */);
6052 frame_size_history = Qnil;
6054 DEFVAR_BOOL ("tooltip-reuse-hidden-frame", tooltip_reuse_hidden_frame,
6055 doc: /* Non-nil means reuse hidden tooltip frames.
6056 When this is nil, delete a tooltip frame when hiding the associated
6057 tooltip. When this is non-nil, make the tooltip frame invisible only,
6058 so it can be reused when the next tooltip is shown.
6060 Setting this to non-nil may drastically reduce the consing overhead
6061 incurred by creating new tooltip frames. However, a value of non-nil
6062 means also that intermittent changes of faces or `default-frame-alist'
6063 are not applied when showing a tooltip in a reused frame.
6065 This variable is effective only with the X toolkit (and there only when
6066 Gtk+ tooltips are not used) and on Windows. */);
6067 tooltip_reuse_hidden_frame = false;
6069 DEFVAR_LISP ("iconify-child-frame", iconify_child_frame,
6070 doc: /* How to handle iconification of child frames.
6071 This variable tells Emacs how to proceed when it is asked to iconify a
6072 child frame. If it is nil, `iconify-frame' will do nothing when invoked
6073 on a child frame. If it is `iconify-top-level', Emacs will try to
6074 iconify the top level frame associated with this child frame instead.
6075 If it is `make-invisible', Emacs will try to make this child frame
6076 invisible instead.
6078 Any other value means to try iconifying the child frame. Since such an
6079 attempt is not honored by all window managers and may even lead to
6080 making the child frame unresponsive to user actions, the default is to
6081 iconify the top level frame instead. */);
6082 iconify_child_frame = Qiconify_top_level;
6084 staticpro (&Vframe_list);
6086 defsubr (&Sframep);
6087 defsubr (&Sframe_live_p);
6088 defsubr (&Swindow_system);
6089 defsubr (&Sframe_windows_min_size);
6090 defsubr (&Smake_terminal_frame);
6091 defsubr (&Shandle_switch_frame);
6092 defsubr (&Sselect_frame);
6093 defsubr (&Sselected_frame);
6094 defsubr (&Sframe_list);
6095 defsubr (&Sframe_parent);
6096 defsubr (&Sframe_ancestor_p);
6097 defsubr (&Snext_frame);
6098 defsubr (&Sprevious_frame);
6099 defsubr (&Slast_nonminibuf_frame);
6100 defsubr (&Sdelete_frame);
6101 defsubr (&Smouse_position);
6102 defsubr (&Smouse_pixel_position);
6103 defsubr (&Sset_mouse_position);
6104 defsubr (&Sset_mouse_pixel_position);
6105 #if 0
6106 defsubr (&Sframe_configuration);
6107 defsubr (&Srestore_frame_configuration);
6108 #endif
6109 defsubr (&Smake_frame_visible);
6110 defsubr (&Smake_frame_invisible);
6111 defsubr (&Siconify_frame);
6112 defsubr (&Sframe_visible_p);
6113 defsubr (&Svisible_frame_list);
6114 defsubr (&Sraise_frame);
6115 defsubr (&Slower_frame);
6116 defsubr (&Sx_focus_frame);
6117 defsubr (&Sframe_after_make_frame);
6118 defsubr (&Sredirect_frame_focus);
6119 defsubr (&Sframe_focus);
6120 defsubr (&Sframe_parameters);
6121 defsubr (&Sframe_parameter);
6122 defsubr (&Smodify_frame_parameters);
6123 defsubr (&Sframe_char_height);
6124 defsubr (&Sframe_char_width);
6125 defsubr (&Sframe_native_height);
6126 defsubr (&Sframe_native_width);
6127 defsubr (&Sframe_text_cols);
6128 defsubr (&Sframe_text_lines);
6129 defsubr (&Sframe_total_cols);
6130 defsubr (&Sframe_total_lines);
6131 defsubr (&Sframe_text_width);
6132 defsubr (&Sframe_text_height);
6133 defsubr (&Sscroll_bar_width);
6134 defsubr (&Sscroll_bar_height);
6135 defsubr (&Sfringe_width);
6136 defsubr (&Sframe_internal_border_width);
6137 defsubr (&Sright_divider_width);
6138 defsubr (&Sbottom_divider_width);
6139 defsubr (&Stool_bar_pixel_width);
6140 defsubr (&Sset_frame_height);
6141 defsubr (&Sset_frame_width);
6142 defsubr (&Sset_frame_size);
6143 defsubr (&Sframe_position);
6144 defsubr (&Sset_frame_position);
6145 defsubr (&Sframe_pointer_visible_p);
6147 #ifdef HAVE_WINDOW_SYSTEM
6148 defsubr (&Sx_get_resource);
6149 defsubr (&Sx_parse_geometry);
6150 #endif