Merge from Gnulib
[emacs.git] / src / frame.c
blob2b32751c0d3da6a485678188580284f875ba3611
1 /* Generic frame functions.
3 Copyright (C) 1993-1995, 1997, 1999-2017 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.
346 static int
347 frame_windows_min_size (Lisp_Object frame, Lisp_Object horizontal,
348 Lisp_Object ignore, Lisp_Object pixelwise)
350 struct frame *f = XFRAME (frame);
351 Lisp_Object par_size;
353 if ((!NILP (horizontal)
354 && NUMBERP (par_size = get_frame_param (f, Qmin_width)))
355 || (NILP (horizontal)
356 && NUMBERP (par_size = get_frame_param (f, Qmin_height))))
358 int min_size = XINT (par_size);
360 /* Don't allow phantom frames. */
361 if (min_size < 1)
362 min_size = 1;
364 return (NILP (pixelwise)
365 ? min_size
366 : min_size * (NILP (horizontal)
367 ? FRAME_LINE_HEIGHT (f)
368 : FRAME_COLUMN_WIDTH (f)));
370 else
371 return XINT (call4 (Qframe_windows_min_size, frame, horizontal,
372 ignore, pixelwise));
376 #ifdef HAVE_WINDOW_SYSTEM
378 * keep_ratio:
380 * Preserve ratios of frame F which usually happens after its parent
381 * frame P got resized. OLD_WIDTH, OLD_HEIGHT specifies the old native
382 * size of F's parent, NEW_WIDTH and NEW_HEIGHT its new size.
384 * Adjust F's width if F's 'keep_ratio' parameter is non-nil and, if
385 * it is a cons, its car is not 'height-only'. Adjust F's height if F's
386 * 'keep_ratio' parameter is non-nil and, if it is a cons, its car
387 * is not 'width-only'.
389 * Adjust F's left position if F's 'keep_ratio' parameter is non-nil
390 * and, if its is a cons, its cdr is non-nil and not 'top-only'. Adjust
391 * F's top position if F's 'keep_ratio' parameter is non-nil and, if
392 * its is a cons, its cdr is non-nil and not 'left-only'.
394 * Note that when positional adjustment is requested but the size of F
395 * should remain unaltered in the corresponding direction, this routine
396 * tries to constrain F to its parent frame - something which usually
397 * happens when the parent frame shrinks. This means, however, that
398 * when the parent frame is re-enlarged later, the child's original
399 * position will not get restored to its pre-shrinking value.
401 * This routine is currently useful for child frames only. It might be
402 * eventually useful when moving non-child frames between monitors with
403 * different resolutions.
405 static void
406 keep_ratio (struct frame *f, struct frame *p, int old_width, int old_height,
407 int new_width, int new_height)
409 Lisp_Object keep_ratio = get_frame_param (f, Qkeep_ratio);
412 if (!NILP (keep_ratio))
414 double width_factor = (double)new_width / (double)old_width;
415 double height_factor = (double)new_height / (double)old_height;
416 int pixel_width, pixel_height, pos_x, pos_y;
418 if (!CONSP (keep_ratio) || !NILP (Fcdr (keep_ratio)))
420 if (CONSP (keep_ratio) && EQ (Fcdr (keep_ratio), Qtop_only))
421 pos_x = f->left_pos;
422 else
424 pos_x = (int)(f->left_pos * width_factor + 0.5);
426 if (CONSP (keep_ratio)
427 && (NILP (Fcar (keep_ratio))
428 || EQ (Fcar (keep_ratio), Qheight_only))
429 && p->pixel_width - f->pixel_width < pos_x)
431 int p_f_width = p->pixel_width - f->pixel_width;
433 if (p_f_width <= 0)
434 pos_x = 0;
435 else
436 pos_x = (int)(p_f_width * width_factor * 0.5 + 0.5);
439 f->left_pos = pos_x;
442 if (CONSP (keep_ratio) && EQ (Fcdr (keep_ratio), Qleft_only))
443 pos_y = f->top_pos;
444 else
446 pos_y = (int)(f->top_pos * height_factor + 0.5);
448 if (CONSP (keep_ratio)
449 && (NILP (Fcar (keep_ratio))
450 || EQ (Fcar (keep_ratio), Qwidth_only))
451 && p->pixel_height - f->pixel_height < pos_y)
452 /* When positional adjustment was requested and the
453 width of F should remain unaltered, try to constrain
454 F to its parent. This means that when the parent
455 frame is enlarged later the child's original position
456 won't get restored. */
458 int p_f_height = p->pixel_height - f->pixel_height;
460 if (p_f_height <= 0)
461 pos_y = 0;
462 else
463 pos_y = (int)(p_f_height * height_factor * 0.5 + 0.5);
466 f->top_pos = pos_y;
469 x_set_offset (f, pos_x, pos_y, -1);
472 if (!CONSP (keep_ratio) || !NILP (Fcar (keep_ratio)))
474 if (CONSP (keep_ratio) && EQ (Fcar (keep_ratio), Qheight_only))
475 pixel_width = -1;
476 else
478 pixel_width = (int)(f->pixel_width * width_factor + 0.5);
479 pixel_width = FRAME_PIXEL_TO_TEXT_WIDTH (f, pixel_width);
482 if (CONSP (keep_ratio) && EQ (Fcar (keep_ratio), Qwidth_only))
483 pixel_height = -1;
484 else
486 pixel_height = (int)(f->pixel_height * height_factor + 0.5);
487 pixel_height = FRAME_PIXEL_TO_TEXT_HEIGHT (f, pixel_height);
490 adjust_frame_size (f, pixel_width, pixel_height, 1, 0,
491 Qkeep_ratio);
495 #endif
499 * adjust_frame_size:
501 * Adjust size of frame F. NEW_WIDTH and NEW_HEIGHT specify the new
502 * text size of F in pixels. A value of -1 means no change is requested
503 * for that direction (but the frame may still have to be resized to
504 * accommodate windows with their minimum sizes). This can either issue
505 * a request to resize the frame externally (via x_set_window_size), to
506 * resize the frame internally (via resize_frame_windows) or do nothing
507 * at all.
509 * The argument INHIBIT can assume the following values:
511 * 0 means to unconditionally call x_set_window_size even if sizes
512 * apparently do not change. Fx_create_frame uses this to pass the
513 * initial size to the window manager.
515 * 1 means to call x_set_window_size if the native frame size really
516 * changes. Fset_frame_size, Fset_frame_height, ... use this.
518 * 2 means to call x_set_window_size provided frame_inhibit_resize
519 * allows it. The menu and tool bar code use this ("3" won't work
520 * here in general because menu and tool bar are often not counted in
521 * the frame's text height).
523 * 3 means call x_set_window_size if window minimum sizes must be
524 * preserved or frame_inhibit_resize allows it. x_set_left_fringe,
525 * x_set_scroll_bar_width, x_new_font ... use (or should use) this.
527 * 4 means call x_set_window_size only if window minimum sizes must be
528 * preserved. x_set_right_divider_width, x_set_border_width and the
529 * code responsible for wrapping the tool bar use this.
531 * 5 means to never call x_set_window_size. change_frame_size uses
532 * this.
534 * Note that even when x_set_window_size is not called, individual
535 * windows may have to be resized (via `window--sanitize-window-sizes')
536 * in order to support minimum size constraints.
538 * PRETEND is as for change_frame_size. PARAMETER, if non-nil, is the
539 * symbol of the parameter changed (like `menu-bar-lines', `font', ...).
540 * This is passed on to frame_inhibit_resize to let the latter decide on
541 * a case-by-case basis whether the frame may be resized externally.
543 void
544 adjust_frame_size (struct frame *f, int new_width, int new_height, int inhibit,
545 bool pretend, Lisp_Object parameter)
547 int unit_width = FRAME_COLUMN_WIDTH (f);
548 int unit_height = FRAME_LINE_HEIGHT (f);
549 int old_pixel_width = FRAME_PIXEL_WIDTH (f);
550 int old_pixel_height = FRAME_PIXEL_HEIGHT (f);
551 int old_cols = FRAME_COLS (f);
552 int old_lines = FRAME_LINES (f);
553 int new_pixel_width, new_pixel_height;
554 /* The following two values are calculated from the old frame pixel
555 sizes and any "new" settings for tool bar, menu bar and internal
556 borders. We do it this way to detect whether we have to call
557 x_set_window_size as consequence of the new settings. */
558 int windows_width = FRAME_WINDOWS_WIDTH (f);
559 int windows_height = FRAME_WINDOWS_HEIGHT (f);
560 int min_windows_width, min_windows_height;
561 /* These are a bit tedious, maybe we should use a macro. */
562 struct window *r = XWINDOW (FRAME_ROOT_WINDOW (f));
563 int old_windows_width = WINDOW_PIXEL_WIDTH (r);
564 int old_windows_height
565 = (WINDOW_PIXEL_HEIGHT (r)
566 + ((FRAME_HAS_MINIBUF_P (f) && !FRAME_MINIBUF_ONLY_P (f))
567 ? WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_MINIBUF_WINDOW (f)))
568 : 0));
569 int new_windows_width, new_windows_height;
570 int old_text_width = FRAME_TEXT_WIDTH (f);
571 int old_text_height = FRAME_TEXT_HEIGHT (f);
572 /* If a size is < 0 use the old value. */
573 int new_text_width = (new_width >= 0) ? new_width : old_text_width;
574 int new_text_height = (new_height >= 0) ? new_height : old_text_height;
575 int new_cols, new_lines;
576 bool inhibit_horizontal, inhibit_vertical;
577 Lisp_Object frame;
579 XSETFRAME (frame, f);
581 frame_size_history_add
582 (f, Qadjust_frame_size_1, new_text_width, new_text_height,
583 list2 (parameter, make_number (inhibit)));
585 /* The following two values are calculated from the old window body
586 sizes and any "new" settings for scroll bars, dividers, fringes and
587 margins (though the latter should have been processed already). */
588 min_windows_width
589 = frame_windows_min_size (frame, Qt, (inhibit == 5) ? Qt : Qnil, Qt);
590 min_windows_height
591 = frame_windows_min_size (frame, Qnil, (inhibit == 5) ? Qt : Qnil, Qt);
593 if (inhibit >= 2 && inhibit <= 4)
594 /* When INHIBIT is in [2..4] inhibit if the "old" window sizes stay
595 within the limits and either resizing is inhibited or INHIBIT
596 equals 4. */
598 inhibit_horizontal = (windows_width >= min_windows_width
599 && (inhibit == 4
600 || frame_inhibit_resize (f, true, parameter)));
601 inhibit_vertical = (windows_height >= min_windows_height
602 && (inhibit == 4
603 || frame_inhibit_resize (f, false, parameter)));
605 else
606 /* Otherwise inhibit if INHIBIT equals 5. */
607 inhibit_horizontal = inhibit_vertical = inhibit == 5;
609 new_pixel_width = ((inhibit_horizontal && (inhibit < 5))
610 ? old_pixel_width
611 : max (FRAME_TEXT_TO_PIXEL_WIDTH (f, new_text_width),
612 min_windows_width
613 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f)));
614 new_windows_width = new_pixel_width - 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
615 new_text_width = FRAME_PIXEL_TO_TEXT_WIDTH (f, new_pixel_width);
616 new_cols = new_text_width / unit_width;
618 new_pixel_height = ((inhibit_vertical && (inhibit < 5))
619 ? old_pixel_height
620 : max (FRAME_TEXT_TO_PIXEL_HEIGHT (f, new_text_height),
621 min_windows_height
622 + FRAME_TOP_MARGIN_HEIGHT (f)
623 + 2 * FRAME_INTERNAL_BORDER_WIDTH (f)));
624 new_windows_height = (new_pixel_height
625 - FRAME_TOP_MARGIN_HEIGHT (f)
626 - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
627 new_text_height = FRAME_PIXEL_TO_TEXT_HEIGHT (f, new_pixel_height);
628 new_lines = new_text_height / unit_height;
630 #ifdef HAVE_WINDOW_SYSTEM
631 if (FRAME_WINDOW_P (f)
632 && f->can_x_set_window_size
633 && ((!inhibit_horizontal
634 && (new_pixel_width != old_pixel_width
635 || inhibit == 0 || inhibit == 2))
636 || (!inhibit_vertical
637 && (new_pixel_height != old_pixel_height
638 || inhibit == 0 || inhibit == 2))))
639 /* We are either allowed to change the frame size or the minimum
640 sizes request such a change. Do not care for fixing minimum
641 sizes here, we do that eventually when we're called from
642 change_frame_size. */
644 /* Make sure we respect fullheight and fullwidth. */
645 if (inhibit_horizontal)
646 new_text_width = old_text_width;
647 else if (inhibit_vertical)
648 new_text_height = old_text_height;
650 frame_size_history_add
651 (f, Qadjust_frame_size_2, new_text_width, new_text_height,
652 list2 (inhibit_horizontal ? Qt : Qnil,
653 inhibit_vertical ? Qt : Qnil));
655 x_set_window_size (f, 0, new_text_width, new_text_height, 1);
656 f->resized_p = true;
658 return;
660 #endif
662 if (new_text_width == old_text_width
663 && new_text_height == old_text_height
664 && new_windows_width == old_windows_width
665 && new_windows_height == old_windows_height
666 && new_pixel_width == old_pixel_width
667 && new_pixel_height == old_pixel_height
668 && new_cols == old_cols
669 && new_lines == old_lines)
670 /* No change. Sanitize window sizes and return. */
672 sanitize_window_sizes (Qt);
673 sanitize_window_sizes (Qnil);
675 return;
678 block_input ();
680 #ifdef MSDOS
681 /* We only can set screen dimensions to certain values supported by
682 our video hardware. Try to find the smallest size greater or
683 equal to the requested dimensions, while accounting for the fact
684 that the menu-bar lines are not counted in the frame height. */
685 int dos_new_lines = new_lines + FRAME_TOP_MARGIN (f);
686 dos_set_window_size (&dos_new_lines, &new_cols);
687 new_lines = dos_new_lines - FRAME_TOP_MARGIN (f);
688 #endif
690 if (new_windows_width != old_windows_width)
692 resize_frame_windows (f, new_windows_width, 1, 1);
694 /* MSDOS frames cannot PRETEND, as they change frame size by
695 manipulating video hardware. */
696 if ((FRAME_TERMCAP_P (f) && !pretend) || FRAME_MSDOS_P (f))
697 FrameCols (FRAME_TTY (f)) = new_cols;
699 #if defined (HAVE_WINDOW_SYSTEM) && ! defined (USE_GTK) && ! defined (HAVE_NS)
700 if (WINDOWP (f->tool_bar_window))
702 XWINDOW (f->tool_bar_window)->pixel_width = new_windows_width;
703 XWINDOW (f->tool_bar_window)->total_cols
704 = new_windows_width / unit_width;
706 #endif
708 else if (new_cols != old_cols)
709 call2 (Qwindow__pixel_to_total, frame, Qt);
711 if (new_windows_height != old_windows_height
712 /* When the top margin has changed we have to recalculate the top
713 edges of all windows. No such calculation is necessary for the
714 left edges. */
715 || WINDOW_TOP_PIXEL_EDGE (r) != FRAME_TOP_MARGIN_HEIGHT (f))
717 resize_frame_windows (f, new_windows_height, 0, 1);
719 /* MSDOS frames cannot PRETEND, as they change frame size by
720 manipulating video hardware. */
721 if ((FRAME_TERMCAP_P (f) && !pretend) || FRAME_MSDOS_P (f))
722 FrameRows (FRAME_TTY (f)) = new_lines + FRAME_TOP_MARGIN (f);
724 else if (new_lines != old_lines)
725 call2 (Qwindow__pixel_to_total, frame, Qnil);
727 frame_size_history_add
728 (f, Qadjust_frame_size_3, new_text_width, new_text_height,
729 list4 (make_number (old_pixel_width), make_number (old_pixel_height),
730 make_number (new_pixel_width), make_number (new_pixel_height)));
732 /* Assign new sizes. */
733 FRAME_TEXT_WIDTH (f) = new_text_width;
734 FRAME_TEXT_HEIGHT (f) = new_text_height;
735 FRAME_PIXEL_WIDTH (f) = new_pixel_width;
736 FRAME_PIXEL_HEIGHT (f) = new_pixel_height;
737 SET_FRAME_COLS (f, new_cols);
738 SET_FRAME_LINES (f, new_lines);
741 struct window *w = XWINDOW (FRAME_SELECTED_WINDOW (f));
742 int text_area_x, text_area_y, text_area_width, text_area_height;
744 window_box (w, TEXT_AREA, &text_area_x, &text_area_y, &text_area_width,
745 &text_area_height);
746 if (w->cursor.x >= text_area_x + text_area_width)
747 w->cursor.hpos = w->cursor.x = 0;
748 if (w->cursor.y >= text_area_y + text_area_height)
749 w->cursor.vpos = w->cursor.y = 0;
752 /* Sanitize window sizes. */
753 sanitize_window_sizes (Qt);
754 sanitize_window_sizes (Qnil);
756 adjust_frame_glyphs (f);
757 calculate_costs (f);
758 SET_FRAME_GARBAGED (f);
760 /* A frame was "resized" if one of its pixelsizes changed, even if its
761 X window wasn't resized at all. */
762 f->resized_p = (new_pixel_width != old_pixel_width
763 || new_pixel_height != old_pixel_height);
765 unblock_input ();
767 #ifdef HAVE_WINDOW_SYSTEM
769 /* Adjust size of F's child frames. */
770 Lisp_Object frames, frame1;
772 FOR_EACH_FRAME (frames, frame1)
773 if (FRAME_PARENT_FRAME (XFRAME (frame1)) == f)
774 keep_ratio (XFRAME (frame1), f, old_pixel_width, old_pixel_height,
775 new_pixel_width, new_pixel_height);
777 #endif
780 /* Allocate basically initialized frame. */
782 static struct frame *
783 allocate_frame (void)
785 return ALLOCATE_ZEROED_PSEUDOVECTOR (struct frame, face_cache, PVEC_FRAME);
788 struct frame *
789 make_frame (bool mini_p)
791 Lisp_Object frame;
792 struct frame *f;
793 struct window *rw, *mw UNINIT;
794 Lisp_Object root_window;
795 Lisp_Object mini_window;
797 f = allocate_frame ();
798 XSETFRAME (frame, f);
800 #ifdef USE_GTK
801 /* Initialize Lisp data. Note that allocate_frame initializes all
802 Lisp data to nil, so do it only for slots which should not be nil. */
803 fset_tool_bar_position (f, Qtop);
804 #endif
806 /* Initialize non-Lisp data. Note that allocate_frame zeroes out all
807 non-Lisp data, so do it only for slots which should not be zero.
808 To avoid subtle bugs and for the sake of readability, it's better to
809 initialize enum members explicitly even if their values are zero. */
810 f->wants_modeline = true;
811 f->redisplay = true;
812 f->garbaged = true;
813 f->can_x_set_window_size = false;
814 f->after_make_frame = false;
815 f->inhibit_horizontal_resize = false;
816 f->inhibit_vertical_resize = false;
817 f->tool_bar_redisplayed = false;
818 f->tool_bar_resized = false;
819 f->column_width = 1; /* !FRAME_WINDOW_P value. */
820 f->line_height = 1; /* !FRAME_WINDOW_P value. */
821 #ifdef HAVE_WINDOW_SYSTEM
822 f->vertical_scroll_bar_type = vertical_scroll_bar_none;
823 f->horizontal_scroll_bars = false;
824 f->want_fullscreen = FULLSCREEN_NONE;
825 f->undecorated = false;
826 f->no_special_glyphs = false;
827 #ifndef HAVE_NTGUI
828 f->override_redirect = false;
829 #endif
830 f->skip_taskbar = false;
831 f->no_focus_on_map = false;
832 f->no_accept_focus = false;
833 f->z_group = z_group_none;
834 #if ! defined (USE_GTK) && ! defined (HAVE_NS)
835 f->last_tool_bar_item = -1;
836 #endif
837 #ifdef NS_IMPL_COCOA
838 f->ns_appearance = ns_appearance_aqua;
839 f->ns_transparent_titlebar = false;
840 #endif
841 #endif
843 root_window = make_window ();
844 rw = XWINDOW (root_window);
845 if (mini_p)
847 mini_window = make_window ();
848 mw = XWINDOW (mini_window);
849 wset_next (rw, mini_window);
850 wset_prev (mw, root_window);
851 mw->mini = 1;
852 wset_frame (mw, frame);
853 fset_minibuffer_window (f, mini_window);
854 store_frame_param (f, Qminibuffer, Qt);
856 else
858 mini_window = Qnil;
859 wset_next (rw, Qnil);
860 fset_minibuffer_window (f, Qnil);
863 wset_frame (rw, frame);
865 /* 10 is arbitrary,
866 just so that there is "something there."
867 Correct size will be set up later with adjust_frame_size. */
869 SET_FRAME_COLS (f, 10);
870 SET_FRAME_LINES (f, 10);
871 SET_FRAME_WIDTH (f, FRAME_COLS (f) * FRAME_COLUMN_WIDTH (f));
872 SET_FRAME_HEIGHT (f, FRAME_LINES (f) * FRAME_LINE_HEIGHT (f));
874 rw->total_cols = 10;
875 rw->pixel_width = rw->total_cols * FRAME_COLUMN_WIDTH (f);
876 rw->total_lines = mini_p ? 9 : 10;
877 rw->pixel_height = rw->total_lines * FRAME_LINE_HEIGHT (f);
879 if (mini_p)
881 mw->top_line = rw->total_lines;
882 mw->pixel_top = rw->pixel_height;
883 mw->total_cols = rw->total_cols;
884 mw->pixel_width = rw->pixel_width;
885 mw->total_lines = 1;
886 mw->pixel_height = FRAME_LINE_HEIGHT (f);
889 /* Choose a buffer for the frame's root window. */
891 Lisp_Object buf = Fcurrent_buffer ();
893 /* If current buffer is hidden, try to find another one. */
894 if (BUFFER_HIDDEN_P (XBUFFER (buf)))
895 buf = other_buffer_safely (buf);
897 /* Use set_window_buffer, not Fset_window_buffer, and don't let
898 hooks be run by it. The reason is that the whole frame/window
899 arrangement is not yet fully initialized at this point. Windows
900 don't have the right size, glyph matrices aren't initialized
901 etc. Running Lisp functions at this point surely ends in a
902 SEGV. */
903 set_window_buffer (root_window, buf, 0, 0);
904 fset_buffer_list (f, list1 (buf));
907 if (mini_p)
909 set_window_buffer (mini_window,
910 (NILP (Vminibuffer_list)
911 ? get_minibuffer (0)
912 : Fcar (Vminibuffer_list)),
913 0, 0);
914 /* No horizontal scroll bars in minibuffers. */
915 wset_horizontal_scroll_bar (mw, Qnil);
918 fset_root_window (f, root_window);
919 fset_selected_window (f, root_window);
920 /* Make sure this window seems more recently used than
921 a newly-created, never-selected window. */
922 XWINDOW (f->selected_window)->use_time = ++window_select_count;
924 return f;
927 #ifdef HAVE_WINDOW_SYSTEM
928 /* Make a frame using a separate minibuffer window on another frame.
929 MINI_WINDOW is the minibuffer window to use. nil means use the
930 default (the global minibuffer). */
932 struct frame *
933 make_frame_without_minibuffer (Lisp_Object mini_window, KBOARD *kb,
934 Lisp_Object display)
936 struct frame *f;
938 if (!NILP (mini_window))
939 CHECK_LIVE_WINDOW (mini_window);
941 if (!NILP (mini_window)
942 && FRAME_KBOARD (XFRAME (XWINDOW (mini_window)->frame)) != kb)
943 error ("Frame and minibuffer must be on the same terminal");
945 /* Make a frame containing just a root window. */
946 f = make_frame (0);
948 if (NILP (mini_window))
950 /* Use default-minibuffer-frame if possible. */
951 if (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
952 || ! FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame))))
954 Lisp_Object frame_dummy;
956 XSETFRAME (frame_dummy, f);
957 /* If there's no minibuffer frame to use, create one. */
958 kset_default_minibuffer_frame
959 (kb, call1 (intern ("make-initial-minibuffer-frame"), display));
962 mini_window
963 = XFRAME (KVAR (kb, Vdefault_minibuffer_frame))->minibuffer_window;
966 fset_minibuffer_window (f, mini_window);
967 store_frame_param (f, Qminibuffer, mini_window);
969 /* Make the chosen minibuffer window display the proper minibuffer,
970 unless it is already showing a minibuffer. */
971 if (NILP (Fmemq (XWINDOW (mini_window)->contents, Vminibuffer_list)))
972 /* Use set_window_buffer instead of Fset_window_buffer (see
973 discussion of bug#11984, bug#12025, bug#12026). */
974 set_window_buffer (mini_window,
975 (NILP (Vminibuffer_list)
976 ? get_minibuffer (0)
977 : Fcar (Vminibuffer_list)), 0, 0);
978 return f;
981 /* Make a frame containing only a minibuffer window. */
983 struct frame *
984 make_minibuffer_frame (void)
986 /* First make a frame containing just a root window, no minibuffer. */
988 register struct frame *f = make_frame (0);
989 register Lisp_Object mini_window;
990 register Lisp_Object frame;
992 XSETFRAME (frame, f);
994 f->auto_raise = 0;
995 f->auto_lower = 0;
996 f->no_split = 1;
997 f->wants_modeline = 0;
999 /* Now label the root window as also being the minibuffer.
1000 Avoid infinite looping on the window chain by marking next pointer
1001 as nil. */
1003 mini_window = f->root_window;
1004 fset_minibuffer_window (f, mini_window);
1005 store_frame_param (f, Qminibuffer, Qonly);
1006 XWINDOW (mini_window)->mini = 1;
1007 wset_next (XWINDOW (mini_window), Qnil);
1008 wset_prev (XWINDOW (mini_window), Qnil);
1009 wset_frame (XWINDOW (mini_window), frame);
1011 /* Put the proper buffer in that window. */
1013 /* Use set_window_buffer instead of Fset_window_buffer (see
1014 discussion of bug#11984, bug#12025, bug#12026). */
1015 set_window_buffer (mini_window,
1016 (NILP (Vminibuffer_list)
1017 ? get_minibuffer (0)
1018 : Fcar (Vminibuffer_list)), 0, 0);
1019 return f;
1021 #endif /* HAVE_WINDOW_SYSTEM */
1023 /* Construct a frame that refers to a terminal. */
1025 static printmax_t tty_frame_count;
1027 struct frame *
1028 make_initial_frame (void)
1030 struct frame *f;
1031 struct terminal *terminal;
1032 Lisp_Object frame;
1034 eassert (initial_kboard);
1036 /* The first call must initialize Vframe_list. */
1037 if (! (NILP (Vframe_list) || CONSP (Vframe_list)))
1038 Vframe_list = Qnil;
1040 terminal = init_initial_terminal ();
1042 f = make_frame (1);
1043 XSETFRAME (frame, f);
1045 Vframe_list = Fcons (frame, Vframe_list);
1047 tty_frame_count = 1;
1048 fset_name (f, build_pure_c_string ("F1"));
1050 SET_FRAME_VISIBLE (f, 1);
1052 f->output_method = terminal->type;
1053 f->terminal = terminal;
1054 f->terminal->reference_count++;
1055 f->output_data.nothing = 0;
1057 FRAME_FOREGROUND_PIXEL (f) = FACE_TTY_DEFAULT_FG_COLOR;
1058 FRAME_BACKGROUND_PIXEL (f) = FACE_TTY_DEFAULT_BG_COLOR;
1060 #ifdef HAVE_WINDOW_SYSTEM
1061 f->vertical_scroll_bar_type = vertical_scroll_bar_none;
1062 f->horizontal_scroll_bars = false;
1063 #endif
1065 /* The default value of menu-bar-mode is t. */
1066 set_menu_bar_lines (f, make_number (1), Qnil);
1068 /* Allocate glyph matrices. */
1069 adjust_frame_glyphs (f);
1071 if (!noninteractive)
1072 init_frame_faces (f);
1074 last_nonminibuf_frame = f;
1076 f->can_x_set_window_size = true;
1077 f->after_make_frame = true;
1079 return f;
1083 static struct frame *
1084 make_terminal_frame (struct terminal *terminal)
1086 register struct frame *f;
1087 Lisp_Object frame;
1088 char name[sizeof "F" + INT_STRLEN_BOUND (printmax_t)];
1090 if (!terminal->name)
1091 error ("Terminal is not live, can't create new frames on it");
1093 f = make_frame (1);
1095 XSETFRAME (frame, f);
1096 Vframe_list = Fcons (frame, Vframe_list);
1098 fset_name (f, make_formatted_string (name, "F%"pMd, ++tty_frame_count));
1100 SET_FRAME_VISIBLE (f, 1);
1102 f->terminal = terminal;
1103 f->terminal->reference_count++;
1104 #ifdef MSDOS
1105 f->output_data.tty->display_info = &the_only_display_info;
1106 if (!inhibit_window_system
1107 && (!FRAMEP (selected_frame) || !FRAME_LIVE_P (XFRAME (selected_frame))
1108 || XFRAME (selected_frame)->output_method == output_msdos_raw))
1109 f->output_method = output_msdos_raw;
1110 else
1111 f->output_method = output_termcap;
1112 #else /* not MSDOS */
1113 f->output_method = output_termcap;
1114 create_tty_output (f);
1115 FRAME_FOREGROUND_PIXEL (f) = FACE_TTY_DEFAULT_FG_COLOR;
1116 FRAME_BACKGROUND_PIXEL (f) = FACE_TTY_DEFAULT_BG_COLOR;
1117 #endif /* not MSDOS */
1119 #ifdef HAVE_WINDOW_SYSTEM
1120 f->vertical_scroll_bar_type = vertical_scroll_bar_none;
1121 f->horizontal_scroll_bars = false;
1122 #endif
1124 FRAME_MENU_BAR_LINES (f) = NILP (Vmenu_bar_mode) ? 0 : 1;
1125 FRAME_LINES (f) = FRAME_LINES (f) - FRAME_MENU_BAR_LINES (f);
1126 FRAME_MENU_BAR_HEIGHT (f) = FRAME_MENU_BAR_LINES (f) * FRAME_LINE_HEIGHT (f);
1127 FRAME_TEXT_HEIGHT (f) = FRAME_TEXT_HEIGHT (f) - FRAME_MENU_BAR_HEIGHT (f);
1129 /* Set the top frame to the newly created frame. */
1130 if (FRAMEP (FRAME_TTY (f)->top_frame)
1131 && FRAME_LIVE_P (XFRAME (FRAME_TTY (f)->top_frame)))
1132 SET_FRAME_VISIBLE (XFRAME (FRAME_TTY (f)->top_frame), 2); /* obscured */
1134 FRAME_TTY (f)->top_frame = frame;
1136 if (!noninteractive)
1137 init_frame_faces (f);
1139 return f;
1142 /* Get a suitable value for frame parameter PARAMETER for a newly
1143 created frame, based on (1) the user-supplied frame parameter
1144 alist SUPPLIED_PARMS, and (2) CURRENT_VALUE. */
1146 static Lisp_Object
1147 get_future_frame_param (Lisp_Object parameter,
1148 Lisp_Object supplied_parms,
1149 char *current_value)
1151 Lisp_Object result;
1153 result = Fassq (parameter, supplied_parms);
1154 if (NILP (result))
1155 result = Fassq (parameter, XFRAME (selected_frame)->param_alist);
1156 if (NILP (result) && current_value != NULL)
1157 result = build_string (current_value);
1158 if (!NILP (result) && !STRINGP (result))
1159 result = XCDR (result);
1160 if (NILP (result) || !STRINGP (result))
1161 result = Qnil;
1163 return result;
1166 DEFUN ("make-terminal-frame", Fmake_terminal_frame, Smake_terminal_frame,
1167 1, 1, 0,
1168 doc: /* Create an additional terminal frame, possibly on another terminal.
1169 This function takes one argument, an alist specifying frame parameters.
1171 You can create multiple frames on a single text terminal, but only one
1172 of them (the selected terminal frame) is actually displayed.
1174 In practice, generally you don't need to specify any parameters,
1175 except when you want to create a new frame on another terminal.
1176 In that case, the `tty' parameter specifies the device file to open,
1177 and the `tty-type' parameter specifies the terminal type. Example:
1179 (make-terminal-frame \\='((tty . "/dev/pts/5") (tty-type . "xterm")))
1181 Note that changing the size of one terminal frame automatically
1182 affects all frames on the same terminal device. */)
1183 (Lisp_Object parms)
1185 struct frame *f;
1186 struct terminal *t = NULL;
1187 Lisp_Object frame, tem;
1188 struct frame *sf = SELECTED_FRAME ();
1190 #ifdef MSDOS
1191 if (sf->output_method != output_msdos_raw
1192 && sf->output_method != output_termcap)
1193 emacs_abort ();
1194 #else /* not MSDOS */
1196 #ifdef WINDOWSNT /* This should work now! */
1197 if (sf->output_method != output_termcap)
1198 error ("Not using an ASCII terminal now; cannot make a new ASCII frame");
1199 #endif
1200 #endif /* not MSDOS */
1203 Lisp_Object terminal;
1205 terminal = Fassq (Qterminal, parms);
1206 if (CONSP (terminal))
1208 terminal = XCDR (terminal);
1209 t = decode_live_terminal (terminal);
1211 #ifdef MSDOS
1212 if (t && t != the_only_display_info.terminal)
1213 /* msdos.c assumes a single tty_display_info object. */
1214 error ("Multiple terminals are not supported on this platform");
1215 if (!t)
1216 t = the_only_display_info.terminal;
1217 #endif
1220 if (!t)
1222 char *name = 0, *type = 0;
1223 Lisp_Object tty, tty_type;
1224 USE_SAFE_ALLOCA;
1226 tty = get_future_frame_param
1227 (Qtty, parms, (FRAME_TERMCAP_P (XFRAME (selected_frame))
1228 ? FRAME_TTY (XFRAME (selected_frame))->name
1229 : NULL));
1230 if (!NILP (tty))
1231 SAFE_ALLOCA_STRING (name, tty);
1233 tty_type = get_future_frame_param
1234 (Qtty_type, parms, (FRAME_TERMCAP_P (XFRAME (selected_frame))
1235 ? FRAME_TTY (XFRAME (selected_frame))->type
1236 : NULL));
1237 if (!NILP (tty_type))
1238 SAFE_ALLOCA_STRING (type, tty_type);
1240 t = init_tty (name, type, 0); /* Errors are not fatal. */
1241 SAFE_FREE ();
1244 f = make_terminal_frame (t);
1247 int width, height;
1248 get_tty_size (fileno (FRAME_TTY (f)->input), &width, &height);
1249 adjust_frame_size (f, width, height - FRAME_MENU_BAR_LINES (f),
1250 5, 0, Qterminal_frame);
1253 adjust_frame_glyphs (f);
1254 calculate_costs (f);
1255 XSETFRAME (frame, f);
1257 store_in_alist (&parms, Qtty_type, build_string (t->display_info.tty->type));
1258 store_in_alist (&parms, Qtty,
1259 (t->display_info.tty->name
1260 ? build_string (t->display_info.tty->name)
1261 : Qnil));
1262 /* On terminal frames the `minibuffer' frame parameter is always
1263 virtually t. Avoid that a different value in parms causes
1264 complaints, see Bug#24758. */
1265 store_in_alist (&parms, Qminibuffer, Qt);
1266 Fmodify_frame_parameters (frame, parms);
1268 /* Make the frame face alist be frame-specific, so that each
1269 frame could change its face definitions independently. */
1270 fset_face_alist (f, Fcopy_alist (sf->face_alist));
1271 /* Simple Fcopy_alist isn't enough, because we need the contents of
1272 the vectors which are the CDRs of associations in face_alist to
1273 be copied as well. */
1274 for (tem = f->face_alist; CONSP (tem); tem = XCDR (tem))
1275 XSETCDR (XCAR (tem), Fcopy_sequence (XCDR (XCAR (tem))));
1277 f->can_x_set_window_size = true;
1278 f->after_make_frame = true;
1280 return frame;
1284 /* Perform the switch to frame FRAME.
1286 If FRAME is a switch-frame event `(switch-frame FRAME1)', use
1287 FRAME1 as frame.
1289 If TRACK is non-zero and the frame that currently has the focus
1290 redirects its focus to the selected frame, redirect that focused
1291 frame's focus to FRAME instead.
1293 FOR_DELETION non-zero means that the selected frame is being
1294 deleted, which includes the possibility that the frame's terminal
1295 is dead.
1297 The value of NORECORD is passed as argument to Fselect_window. */
1299 Lisp_Object
1300 do_switch_frame (Lisp_Object frame, int track, int for_deletion, Lisp_Object norecord)
1302 struct frame *sf = SELECTED_FRAME (), *f;
1304 /* If FRAME is a switch-frame event, extract the frame we should
1305 switch to. */
1306 if (CONSP (frame)
1307 && EQ (XCAR (frame), Qswitch_frame)
1308 && CONSP (XCDR (frame)))
1309 frame = XCAR (XCDR (frame));
1311 /* This used to say CHECK_LIVE_FRAME, but apparently it's possible for
1312 a switch-frame event to arrive after a frame is no longer live,
1313 especially when deleting the initial frame during startup. */
1314 CHECK_FRAME (frame);
1315 f = XFRAME (frame);
1316 if (!FRAME_LIVE_P (f))
1317 return Qnil;
1318 else if (f == sf)
1319 return frame;
1321 /* If a frame's focus has been redirected toward the currently
1322 selected frame, we should change the redirection to point to the
1323 newly selected frame. This means that if the focus is redirected
1324 from a minibufferless frame to a surrogate minibuffer frame, we
1325 can use `other-window' to switch between all the frames using
1326 that minibuffer frame, and the focus redirection will follow us
1327 around. */
1328 #if 0
1329 /* This is too greedy; it causes inappropriate focus redirection
1330 that's hard to get rid of. */
1331 if (track)
1333 Lisp_Object tail;
1335 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1337 Lisp_Object focus;
1339 if (!FRAMEP (XCAR (tail)))
1340 emacs_abort ();
1342 focus = FRAME_FOCUS_FRAME (XFRAME (XCAR (tail)));
1344 if (FRAMEP (focus) && XFRAME (focus) == SELECTED_FRAME ())
1345 Fredirect_frame_focus (XCAR (tail), frame);
1348 #else /* ! 0 */
1349 /* Instead, apply it only to the frame we're pointing to. */
1350 #ifdef HAVE_WINDOW_SYSTEM
1351 if (track && FRAME_WINDOW_P (f))
1353 Lisp_Object focus, xfocus;
1355 xfocus = x_get_focus_frame (f);
1356 if (FRAMEP (xfocus))
1358 focus = FRAME_FOCUS_FRAME (XFRAME (xfocus));
1359 if ((FRAMEP (focus) && XFRAME (focus) == SELECTED_FRAME ())
1360 /* Redirect frame focus also when FRAME has its minibuffer
1361 window on the selected frame (see Bug#24500). */
1362 || (NILP (focus)
1363 && EQ (FRAME_MINIBUF_WINDOW (f), sf->selected_window)))
1364 Fredirect_frame_focus (xfocus, frame);
1367 #endif /* HAVE_X_WINDOWS */
1368 #endif /* ! 0 */
1370 if (!for_deletion && FRAME_HAS_MINIBUF_P (sf))
1371 resize_mini_window (XWINDOW (FRAME_MINIBUF_WINDOW (sf)), 1);
1373 if (FRAME_TERMCAP_P (f) || FRAME_MSDOS_P (f))
1375 struct tty_display_info *tty = FRAME_TTY (f);
1376 Lisp_Object top_frame = tty->top_frame;
1378 /* Don't mark the frame garbaged and/or obscured if we are
1379 switching to the frame that is already the top frame of that
1380 TTY. */
1381 if (!EQ (frame, top_frame))
1383 if (FRAMEP (top_frame))
1384 /* Mark previously displayed frame as now obscured. */
1385 SET_FRAME_VISIBLE (XFRAME (top_frame), 2);
1386 SET_FRAME_VISIBLE (f, 1);
1387 /* If the new TTY frame changed dimensions, we need to
1388 resync term.c's idea of the frame size with the new
1389 frame's data. */
1390 if (FRAME_COLS (f) != FrameCols (tty))
1391 FrameCols (tty) = FRAME_COLS (f);
1392 if (FRAME_TOTAL_LINES (f) != FrameRows (tty))
1393 FrameRows (tty) = FRAME_TOTAL_LINES (f);
1395 tty->top_frame = frame;
1398 selected_frame = frame;
1399 if (! FRAME_MINIBUF_ONLY_P (XFRAME (selected_frame)))
1400 last_nonminibuf_frame = XFRAME (selected_frame);
1402 Fselect_window (f->selected_window, norecord);
1404 /* We want to make sure that the next event generates a frame-switch
1405 event to the appropriate frame. This seems kludgy to me, but
1406 before you take it out, make sure that evaluating something like
1407 (select-window (frame-root-window (new-frame))) doesn't end up
1408 with your typing being interpreted in the new frame instead of
1409 the one you're actually typing in. */
1410 #ifdef HAVE_WINDOW_SYSTEM
1411 if (!frame_ancestor_p (f, sf))
1412 #endif
1413 internal_last_event_frame = Qnil;
1415 return frame;
1418 DEFUN ("select-frame", Fselect_frame, Sselect_frame, 1, 2, "e",
1419 doc: /* Select FRAME.
1420 Subsequent editing commands apply to its selected window.
1421 Optional argument NORECORD means to neither change the order of
1422 recently selected windows nor the buffer list.
1424 The selection of FRAME lasts until the next time the user does
1425 something to select a different frame, or until the next time
1426 this function is called. If you are using a window system, the
1427 previously selected frame may be restored as the selected frame
1428 when returning to the command loop, because it still may have
1429 the window system's input focus. On a text terminal, the next
1430 redisplay will display FRAME.
1432 This function returns FRAME, or nil if FRAME has been deleted. */)
1433 (Lisp_Object frame, Lisp_Object norecord)
1435 return do_switch_frame (frame, 1, 0, norecord);
1438 DEFUN ("handle-switch-frame", Fhandle_switch_frame, Shandle_switch_frame, 1, 1, "^e",
1439 doc: /* Handle a switch-frame event EVENT.
1440 Switch-frame events are usually bound to this function.
1441 A switch-frame event tells Emacs that the window manager has requested
1442 that the user's events be directed to the frame mentioned in the event.
1443 This function selects the selected window of the frame of EVENT.
1445 If EVENT is frame object, handle it as if it were a switch-frame event
1446 to that frame. */)
1447 (Lisp_Object event)
1449 Lisp_Object value;
1451 /* Preserve prefix arg that the command loop just cleared. */
1452 kset_prefix_arg (current_kboard, Vcurrent_prefix_arg);
1453 run_hook (Qmouse_leave_buffer_hook);
1454 /* `switch-frame' implies a focus in. */
1455 value = do_switch_frame (event, 0, 0, Qnil);
1456 call1 (intern ("handle-focus-in"), event);
1457 return value;
1460 DEFUN ("selected-frame", Fselected_frame, Sselected_frame, 0, 0, 0,
1461 doc: /* Return the frame that is now selected. */)
1462 (void)
1464 return selected_frame;
1467 DEFUN ("frame-list", Fframe_list, Sframe_list,
1468 0, 0, 0,
1469 doc: /* Return a list of all live frames. */)
1470 (void)
1472 Lisp_Object frames;
1473 frames = Fcopy_sequence (Vframe_list);
1474 #ifdef HAVE_WINDOW_SYSTEM
1475 if (FRAMEP (tip_frame)
1476 #ifdef USE_GTK
1477 && !NILP (Fframe_parameter (tip_frame, Qtooltip))
1478 #endif
1480 frames = Fdelq (tip_frame, frames);
1481 #endif
1482 return frames;
1485 DEFUN ("frame-parent", Fframe_parent, Sframe_parent,
1486 0, 1, 0,
1487 doc: /* Return the parent frame of FRAME.
1488 The parent frame of FRAME is the Emacs frame whose window-system window
1489 is the parent window of FRAME's window-system window. When such a frame
1490 exists, FRAME is considered a child frame of that frame.
1492 Return nil if FRAME has no parent frame. This means that FRAME's
1493 window-system window is either a "top-level" window (a window whose
1494 parent window is the window-system's root window) or an embedded window
1495 \(a window whose parent window is owned by some other application). */)
1496 (Lisp_Object frame)
1498 struct frame *f = decode_live_frame (frame);
1499 struct frame *p = FRAME_PARENT_FRAME (f);
1500 Lisp_Object parent;
1502 /* Can't return f->parent_frame directly since it might not be defined
1503 for this platform. */
1504 if (p)
1506 XSETFRAME (parent, p);
1508 return parent;
1510 else
1511 return Qnil;
1514 #ifdef HAVE_WINDOW_SYSTEM
1515 bool
1516 frame_ancestor_p (struct frame *af, struct frame *df)
1518 struct frame *pf = FRAME_PARENT_FRAME (df);
1520 while (pf)
1522 if (pf == af)
1523 return true;
1524 else
1525 pf = FRAME_PARENT_FRAME (pf);
1528 return false;
1530 #endif
1532 DEFUN ("frame-ancestor-p", Fframe_ancestor_p, Sframe_ancestor_p,
1533 2, 2, 0,
1534 doc: /* Return non-nil if ANCESTOR is an ancestor of DESCENDANT.
1535 ANCESTOR is an ancestor of DESCENDANT when it is either DESCENDANT's
1536 parent frame or it is an ancestor of DESCENDANT's parent frame. Both,
1537 ANCESTOR and DESCENDANT must be live frames and default to the selected
1538 frame. */)
1539 (Lisp_Object ancestor, Lisp_Object descendant)
1541 #ifdef HAVE_WINDOW_SYSTEM
1542 struct frame *af = decode_live_frame (ancestor);
1543 struct frame *df = decode_live_frame (descendant);
1545 return frame_ancestor_p (af, df) ? Qt : Qnil;
1546 #else
1547 return Qnil;
1548 #endif
1551 /* Return CANDIDATE if it can be used as 'other-than-FRAME' frame on the
1552 same tty (for tty frames) or among frames which uses FRAME's keyboard.
1553 If MINIBUF is nil, do not consider minibuffer-only candidate.
1554 If MINIBUF is `visible', do not consider an invisible candidate.
1555 If MINIBUF is a window, consider only its own frame and candidate now
1556 using that window as the minibuffer.
1557 If MINIBUF is 0, consider candidate if it is visible or iconified.
1558 Otherwise consider any candidate and return nil if CANDIDATE is not
1559 acceptable. */
1561 static Lisp_Object
1562 candidate_frame (Lisp_Object candidate, Lisp_Object frame, Lisp_Object minibuf)
1564 struct frame *c = XFRAME (candidate), *f = XFRAME (frame);
1566 if ((!FRAME_TERMCAP_P (c) && !FRAME_TERMCAP_P (f)
1567 && FRAME_KBOARD (c) == FRAME_KBOARD (f))
1568 || (FRAME_TERMCAP_P (c) && FRAME_TERMCAP_P (f)
1569 && FRAME_TTY (c) == FRAME_TTY (f)))
1571 if (!NILP (get_frame_param (c, Qno_other_frame)))
1572 return Qnil;
1573 else if (NILP (minibuf))
1575 if (!FRAME_MINIBUF_ONLY_P (c))
1576 return candidate;
1578 else if (EQ (minibuf, Qvisible))
1580 if (FRAME_VISIBLE_P (c))
1581 return candidate;
1583 else if (WINDOWP (minibuf))
1585 if (EQ (FRAME_MINIBUF_WINDOW (c), minibuf)
1586 || EQ (WINDOW_FRAME (XWINDOW (minibuf)), candidate)
1587 || EQ (WINDOW_FRAME (XWINDOW (minibuf)),
1588 FRAME_FOCUS_FRAME (c)))
1589 return candidate;
1591 else if (INTEGERP (minibuf) && XINT (minibuf) == 0)
1593 if (FRAME_VISIBLE_P (c) || FRAME_ICONIFIED_P (c))
1594 return candidate;
1596 else
1597 return candidate;
1599 return Qnil;
1602 /* Return the next frame in the frame list after FRAME. */
1604 static Lisp_Object
1605 next_frame (Lisp_Object frame, Lisp_Object minibuf)
1607 Lisp_Object f, tail;
1608 int passed = 0;
1610 while (passed < 2)
1611 FOR_EACH_FRAME (tail, f)
1613 if (passed)
1615 f = candidate_frame (f, frame, minibuf);
1616 if (!NILP (f))
1617 return f;
1619 if (EQ (frame, f))
1620 passed++;
1622 return frame;
1625 /* Return the previous frame in the frame list before FRAME. */
1627 static Lisp_Object
1628 prev_frame (Lisp_Object frame, Lisp_Object minibuf)
1630 Lisp_Object f, tail, prev = Qnil;
1632 FOR_EACH_FRAME (tail, f)
1634 if (EQ (frame, f) && !NILP (prev))
1635 return prev;
1636 f = candidate_frame (f, frame, minibuf);
1637 if (!NILP (f))
1638 prev = f;
1641 /* We've scanned the entire list. */
1642 if (NILP (prev))
1643 /* We went through the whole frame list without finding a single
1644 acceptable frame. Return the original frame. */
1645 return frame;
1646 else
1647 /* There were no acceptable frames in the list before FRAME; otherwise,
1648 we would have returned directly from the loop. Since PREV is the last
1649 acceptable frame in the list, return it. */
1650 return prev;
1654 DEFUN ("next-frame", Fnext_frame, Snext_frame, 0, 2, 0,
1655 doc: /* Return the next frame in the frame list after FRAME.
1656 It considers only frames on the same terminal as FRAME.
1657 By default, skip minibuffer-only frames.
1658 If omitted, FRAME defaults to the selected frame.
1659 If optional argument MINIFRAME is nil, exclude minibuffer-only frames.
1660 If MINIFRAME is a window, include only its own frame
1661 and any frame now using that window as the minibuffer.
1662 If MINIFRAME is `visible', include all visible frames.
1663 If MINIFRAME is 0, include all visible and iconified frames.
1664 Otherwise, include all frames. */)
1665 (Lisp_Object frame, Lisp_Object miniframe)
1667 if (NILP (frame))
1668 frame = selected_frame;
1669 CHECK_LIVE_FRAME (frame);
1670 return next_frame (frame, miniframe);
1673 DEFUN ("previous-frame", Fprevious_frame, Sprevious_frame, 0, 2, 0,
1674 doc: /* Return the previous frame in the frame list before 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 prev_frame (frame, miniframe);
1692 DEFUN ("last-nonminibuffer-frame", Flast_nonminibuf_frame,
1693 Slast_nonminibuf_frame, 0, 0, 0,
1694 doc: /* Return last non-minibuffer frame selected. */)
1695 (void)
1697 Lisp_Object frame = Qnil;
1699 if (last_nonminibuf_frame)
1700 XSETFRAME (frame, last_nonminibuf_frame);
1702 return frame;
1706 * other_frames:
1708 * Return true if there exists at least one visible or iconified frame
1709 * but F. Return false otherwise.
1711 * INVISIBLE true means we are called from make_frame_invisible where
1712 * such a frame must be visible or iconified. INVISIBLE nil means we
1713 * are called from delete_frame. In that case FORCE true means that the
1714 * visibility status of such a frame can be ignored.
1716 * If F is the terminal frame and we are using X, return true if at
1717 * least one X frame exists.
1719 static bool
1720 other_frames (struct frame *f, bool invisible, bool force)
1722 Lisp_Object frames, frame, frame1;
1723 struct frame *f1;
1724 Lisp_Object minibuffer_window = FRAME_MINIBUF_WINDOW (f);
1726 XSETFRAME (frame, f);
1727 if (WINDOWP (minibuffer_window)
1728 && !EQ (frame, WINDOW_FRAME (XWINDOW (minibuffer_window))))
1729 minibuffer_window = Qnil;
1731 FOR_EACH_FRAME (frames, frame1)
1733 f1 = XFRAME (frame1);
1734 if (f != f1)
1736 /* Verify that we can still talk to the frame's X window, and
1737 note any recent change in visibility. */
1738 #ifdef HAVE_X_WINDOWS
1739 if (FRAME_WINDOW_P (f1))
1740 x_sync (f1);
1741 #endif
1742 if (NILP (Fframe_parameter (frame1, Qtooltip))
1743 /* Tooltips and child frames count neither for
1744 invisibility nor for deletions. */
1745 && !FRAME_PARENT_FRAME (f1)
1746 /* Frames with a non-nil `delete-before' parameter don't
1747 count for deletions. */
1748 && (invisible || NILP (get_frame_param (f1, Qdelete_before)))
1749 /* For invisibility and normal deletions, at least one
1750 visible or iconified frame must remain (Bug#26682). */
1751 && (FRAME_VISIBLE_P (f1) || FRAME_ICONIFIED_P (f1)
1752 || (!invisible
1753 && (force
1754 /* Allow deleting the terminal frame when at
1755 least one X frame exists. */
1756 || (FRAME_WINDOW_P (f1) && !FRAME_WINDOW_P (f))))))
1757 return true;
1761 return false;
1764 /* Make sure that minibuf_window doesn't refer to FRAME's minibuffer
1765 window. Preferably use the selected frame's minibuffer window
1766 instead. If the selected frame doesn't have one, get some other
1767 frame's minibuffer window. SELECT non-zero means select the new
1768 minibuffer window. */
1769 static void
1770 check_minibuf_window (Lisp_Object frame, int select)
1772 struct frame *f = decode_live_frame (frame);
1774 XSETFRAME (frame, f);
1776 if (WINDOWP (minibuf_window) && EQ (f->minibuffer_window, minibuf_window))
1778 Lisp_Object frames, this, window = make_number (0);
1780 if (!EQ (frame, selected_frame)
1781 && FRAME_HAS_MINIBUF_P (XFRAME (selected_frame)))
1782 window = FRAME_MINIBUF_WINDOW (XFRAME (selected_frame));
1783 else
1784 FOR_EACH_FRAME (frames, this)
1786 if (!EQ (this, frame) && FRAME_HAS_MINIBUF_P (XFRAME (this)))
1788 window = FRAME_MINIBUF_WINDOW (XFRAME (this));
1789 break;
1793 /* Don't abort if no window was found (Bug#15247). */
1794 if (WINDOWP (window))
1796 /* Use set_window_buffer instead of Fset_window_buffer (see
1797 discussion of bug#11984, bug#12025, bug#12026). */
1798 set_window_buffer (window, XWINDOW (minibuf_window)->contents, 0, 0);
1799 minibuf_window = window;
1801 /* SELECT non-zero usually means that FRAME's minibuffer
1802 window was selected; select the new one. */
1803 if (select)
1804 Fselect_window (minibuf_window, Qnil);
1811 * delete_frame:
1813 * Delete FRAME. When FORCE equals Qnoelisp, delete FRAME
1814 * unconditionally. x_connection_closed and delete_terminal use this.
1815 * Any other value of FORCE implements the semantics described for
1816 * Fdelete_frame. */
1817 Lisp_Object
1818 delete_frame (Lisp_Object frame, Lisp_Object force)
1820 struct frame *f = decode_any_frame (frame);
1821 struct frame *sf;
1822 struct kboard *kb;
1823 Lisp_Object frames, frame1;
1824 int minibuffer_selected, is_tooltip_frame;
1825 bool nochild = !FRAME_PARENT_FRAME (f);
1827 if (!FRAME_LIVE_P (f))
1828 return Qnil;
1829 else if (!EQ (force, Qnoelisp) && !other_frames (f, false, !NILP (force)))
1831 if (NILP (force))
1832 error ("Attempt to delete the sole visible or iconified frame");
1833 else
1834 error ("Attempt to delete the only frame");
1837 XSETFRAME (frame, f);
1839 /* Softly delete all frames with this frame as their parent frame or
1840 as their `delete-before' frame parameter value. */
1841 FOR_EACH_FRAME (frames, frame1)
1842 if (FRAME_PARENT_FRAME (XFRAME (frame1)) == f
1843 /* Process `delete-before' parameter iff FRAME is not a child
1844 frame. This avoids that we enter an infinite chain of mixed
1845 dependencies. */
1846 || (nochild
1847 && EQ (get_frame_param (XFRAME (frame1), Qdelete_before), frame)))
1848 delete_frame (frame1, Qnil);
1850 /* Does this frame have a minibuffer, and is it the surrogate
1851 minibuffer for any other frame? */
1852 if (FRAME_HAS_MINIBUF_P (f))
1854 FOR_EACH_FRAME (frames, frame1)
1856 Lisp_Object fminiw;
1858 if (EQ (frame1, frame))
1859 continue;
1861 fminiw = FRAME_MINIBUF_WINDOW (XFRAME (frame1));
1863 if (WINDOWP (fminiw) && EQ (frame, WINDOW_FRAME (XWINDOW (fminiw))))
1865 /* If we MUST delete this frame, delete the other first.
1866 But do this only if FORCE equals `noelisp'. */
1867 if (EQ (force, Qnoelisp))
1868 delete_frame (frame1, Qnoelisp);
1869 else
1870 error ("Attempt to delete a surrogate minibuffer frame");
1875 is_tooltip_frame = !NILP (Fframe_parameter (frame, Qtooltip));
1877 /* Run `delete-frame-functions' unless FORCE is `noelisp' or
1878 frame is a tooltip. FORCE is set to `noelisp' when handling
1879 a disconnect from the terminal, so we don't dare call Lisp
1880 code. */
1881 if (NILP (Vrun_hooks) || is_tooltip_frame)
1883 else if (EQ (force, Qnoelisp))
1884 pending_funcalls
1885 = Fcons (list3 (Qrun_hook_with_args, Qdelete_frame_functions, frame),
1886 pending_funcalls);
1887 else
1889 #ifdef HAVE_X_WINDOWS
1890 /* Also, save clipboard to the clipboard manager. */
1891 x_clipboard_manager_save_frame (frame);
1892 #endif
1894 safe_call2 (Qrun_hook_with_args, Qdelete_frame_functions, frame);
1897 /* delete_frame_functions may have deleted any frame, including this
1898 one. */
1899 if (!FRAME_LIVE_P (f))
1900 return Qnil;
1901 else if (!EQ (force, Qnoelisp) && !other_frames (f, false, !NILP (force)))
1903 if (NILP (force))
1904 error ("Attempt to delete the sole visible or iconified frame");
1905 else
1906 error ("Attempt to delete the only frame");
1909 /* At this point, we are committed to deleting the frame.
1910 There is no more chance for errors to prevent it. */
1911 minibuffer_selected = EQ (minibuf_window, selected_window);
1912 sf = SELECTED_FRAME ();
1913 /* Don't let the frame remain selected. */
1914 if (f == sf)
1916 Lisp_Object tail;
1918 /* Look for another visible frame on the same terminal.
1919 Do not call next_frame here because it may loop forever.
1920 See https://debbugs.gnu.org/cgi/bugreport.cgi?bug=15025. */
1921 FOR_EACH_FRAME (tail, frame1)
1922 if (!EQ (frame, frame1)
1923 && (FRAME_TERMINAL (XFRAME (frame))
1924 == FRAME_TERMINAL (XFRAME (frame1)))
1925 && FRAME_VISIBLE_P (XFRAME (frame1)))
1926 break;
1928 /* If there is none, find *some* other frame. */
1929 if (NILP (frame1) || EQ (frame1, frame))
1931 FOR_EACH_FRAME (tail, frame1)
1933 if (! EQ (frame, frame1) && FRAME_LIVE_P (XFRAME (frame1)))
1935 /* Do not change a text terminal's top-frame. */
1936 struct frame *f1 = XFRAME (frame1);
1937 if (FRAME_TERMCAP_P (f1) || FRAME_MSDOS_P (f1))
1939 Lisp_Object top_frame = FRAME_TTY (f1)->top_frame;
1940 if (!EQ (top_frame, frame))
1941 frame1 = top_frame;
1943 break;
1947 #ifdef NS_IMPL_COCOA
1948 else
1949 /* Under NS, there is no system mechanism for choosing a new
1950 window to get focus -- it is left to application code.
1951 So the portion of THIS application interfacing with NS
1952 needs to know about it. We call Fraise_frame, but the
1953 purpose is really to transfer focus. */
1954 Fraise_frame (frame1);
1955 #endif
1957 do_switch_frame (frame1, 0, 1, Qnil);
1958 sf = SELECTED_FRAME ();
1961 /* Don't allow minibuf_window to remain on a deleted frame. */
1962 check_minibuf_window (frame, minibuffer_selected);
1964 /* Don't let echo_area_window to remain on a deleted frame. */
1965 if (EQ (f->minibuffer_window, echo_area_window))
1966 echo_area_window = sf->minibuffer_window;
1968 /* Clear any X selections for this frame. */
1969 #ifdef HAVE_X_WINDOWS
1970 if (FRAME_X_P (f))
1971 x_clear_frame_selections (f);
1972 #endif
1974 /* Free glyphs.
1975 This function must be called before the window tree of the
1976 frame is deleted because windows contain dynamically allocated
1977 memory. */
1978 free_glyphs (f);
1980 #ifdef HAVE_WINDOW_SYSTEM
1981 /* Give chance to each font driver to free a frame specific data. */
1982 font_update_drivers (f, Qnil);
1983 #endif
1985 /* Mark all the windows that used to be on FRAME as deleted, and then
1986 remove the reference to them. */
1987 delete_all_child_windows (f->root_window);
1988 fset_root_window (f, Qnil);
1990 Vframe_list = Fdelq (frame, Vframe_list);
1991 SET_FRAME_VISIBLE (f, 0);
1993 /* Allow the vector of menu bar contents to be freed in the next
1994 garbage collection. The frame object itself may not be garbage
1995 collected until much later, because recent_keys and other data
1996 structures can still refer to it. */
1997 fset_menu_bar_vector (f, Qnil);
1999 /* If FRAME's buffer lists contains killed
2000 buffers, this helps GC to reclaim them. */
2001 fset_buffer_list (f, Qnil);
2002 fset_buried_buffer_list (f, Qnil);
2004 free_font_driver_list (f);
2005 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI)
2006 xfree (f->namebuf);
2007 #endif
2008 xfree (f->decode_mode_spec_buffer);
2009 xfree (FRAME_INSERT_COST (f));
2010 xfree (FRAME_DELETEN_COST (f));
2011 xfree (FRAME_INSERTN_COST (f));
2012 xfree (FRAME_DELETE_COST (f));
2014 /* Since some events are handled at the interrupt level, we may get
2015 an event for f at any time; if we zero out the frame's terminal
2016 now, then we may trip up the event-handling code. Instead, we'll
2017 promise that the terminal of the frame must be valid until we
2018 have called the window-system-dependent frame destruction
2019 routine. */
2021 struct terminal *terminal;
2022 block_input ();
2023 if (FRAME_TERMINAL (f)->delete_frame_hook)
2024 (*FRAME_TERMINAL (f)->delete_frame_hook) (f);
2025 terminal = FRAME_TERMINAL (f);
2026 f->output_data.nothing = 0;
2027 f->terminal = 0; /* Now the frame is dead. */
2028 unblock_input ();
2030 /* If needed, delete the terminal that this frame was on.
2031 (This must be done after the frame is killed.) */
2032 terminal->reference_count--;
2033 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
2034 /* FIXME: Deleting the terminal crashes emacs because of a GTK
2035 bug.
2036 https://lists.gnu.org/archive/html/emacs-devel/2011-10/msg00363.html */
2038 /* Since a similar behavior was observed on the Lucid and Motif
2039 builds (see Bug#5802, Bug#21509, Bug#23499, Bug#27816), we now
2040 don't delete the terminal for these builds either. */
2041 if (terminal->reference_count == 0 && terminal->type == output_x_window)
2042 terminal->reference_count = 1;
2043 #endif /* USE_X_TOOLKIT || USE_GTK */
2044 if (terminal->reference_count == 0)
2046 Lisp_Object tmp;
2047 XSETTERMINAL (tmp, terminal);
2049 kb = NULL;
2050 Fdelete_terminal (tmp, NILP (force) ? Qt : force);
2052 else
2053 kb = terminal->kboard;
2056 /* If we've deleted the last_nonminibuf_frame, then try to find
2057 another one. */
2058 if (f == last_nonminibuf_frame)
2060 last_nonminibuf_frame = 0;
2062 FOR_EACH_FRAME (frames, frame1)
2064 struct frame *f1 = XFRAME (frame1);
2066 if (!FRAME_MINIBUF_ONLY_P (f1))
2068 last_nonminibuf_frame = f1;
2069 break;
2074 /* If there's no other frame on the same kboard, get out of
2075 single-kboard state if we're in it for this kboard. */
2076 if (kb != NULL)
2078 /* Some frame we found on the same kboard, or nil if there are none. */
2079 Lisp_Object frame_on_same_kboard = Qnil;
2081 FOR_EACH_FRAME (frames, frame1)
2082 if (kb == FRAME_KBOARD (XFRAME (frame1)))
2083 frame_on_same_kboard = frame1;
2085 if (NILP (frame_on_same_kboard))
2086 not_single_kboard_state (kb);
2090 /* If we've deleted this keyboard's default_minibuffer_frame, try to
2091 find another one. Prefer minibuffer-only frames, but also notice
2092 frames with other windows. */
2093 if (kb != NULL && EQ (frame, KVAR (kb, Vdefault_minibuffer_frame)))
2095 /* The last frame we saw with a minibuffer, minibuffer-only or not. */
2096 Lisp_Object frame_with_minibuf = Qnil;
2097 /* Some frame we found on the same kboard, or nil if there are none. */
2098 Lisp_Object frame_on_same_kboard = Qnil;
2100 FOR_EACH_FRAME (frames, frame1)
2102 struct frame *f1 = XFRAME (frame1);
2104 /* Consider only frames on the same kboard
2105 and only those with minibuffers. */
2106 if (kb == FRAME_KBOARD (f1)
2107 && FRAME_HAS_MINIBUF_P (f1))
2109 frame_with_minibuf = frame1;
2110 if (FRAME_MINIBUF_ONLY_P (f1))
2111 break;
2114 if (kb == FRAME_KBOARD (f1))
2115 frame_on_same_kboard = frame1;
2118 if (!NILP (frame_on_same_kboard))
2120 /* We know that there must be some frame with a minibuffer out
2121 there. If this were not true, all of the frames present
2122 would have to be minibufferless, which implies that at some
2123 point their minibuffer frames must have been deleted, but
2124 that is prohibited at the top; you can't delete surrogate
2125 minibuffer frames. */
2126 if (NILP (frame_with_minibuf))
2127 emacs_abort ();
2129 kset_default_minibuffer_frame (kb, frame_with_minibuf);
2131 else
2132 /* No frames left on this kboard--say no minibuffer either. */
2133 kset_default_minibuffer_frame (kb, Qnil);
2136 /* Cause frame titles to update--necessary if we now have just one frame. */
2137 if (!is_tooltip_frame)
2138 update_mode_lines = 15;
2140 return Qnil;
2143 DEFUN ("delete-frame", Fdelete_frame, Sdelete_frame, 0, 2, "",
2144 doc: /* Delete FRAME, permanently eliminating it from use.
2145 FRAME must be a live frame and defaults to the selected one.
2147 A frame may not be deleted if its minibuffer serves as surrogate
2148 minibuffer for another frame. Normally, you may not delete a frame if
2149 all other frames are invisible, but if the second optional argument
2150 FORCE is non-nil, you may do so.
2152 This function runs `delete-frame-functions' before actually
2153 deleting the frame, unless the frame is a tooltip.
2154 The functions are run with one argument, the frame to be deleted. */)
2155 (Lisp_Object frame, Lisp_Object force)
2157 return delete_frame (frame, !NILP (force) ? Qt : Qnil);
2160 #ifdef HAVE_WINDOW_SYSTEM
2162 * frame_internal_border_part:
2164 * Return part of internal border the coordinates X and Y relative to
2165 * frame F are on. Return nil if the coordinates are not on the
2166 * internal border of F.
2168 * Return one of INTERNAL_BORDER_LEFT_EDGE, INTERNAL_BORDER_TOP_EDGE,
2169 * INTERNAL_BORDER_RIGHT_EDGE or INTERNAL_BORDER_BOTTOM_EDGE when the
2170 * mouse cursor is on the corresponding border with an offset of at
2171 * least one canonical character height from that border's edges.
2173 * If no border part could be found this way, return one of
2174 * INTERNAL_BORDER_TOP_LEFT_CORNER, INTERNAL_BORDER_TOP_RIGHT_CORNER,
2175 * INTERNAL_BORDER_BOTTOM_LEFT_CORNER or
2176 * INTERNAL_BORDER_BOTTOM_RIGHT_CORNER to indicate that the mouse is in
2177 * one of the corresponding corners. This means that for very small
2178 * frames an `edge' return value is preferred.
2180 enum internal_border_part
2181 frame_internal_border_part (struct frame *f, int x, int y)
2183 int border = FRAME_INTERNAL_BORDER_WIDTH (f);
2184 int offset = FRAME_LINE_HEIGHT (f);
2185 int width = FRAME_PIXEL_WIDTH (f);
2186 int height = FRAME_PIXEL_HEIGHT (f);
2187 enum internal_border_part part = INTERNAL_BORDER_NONE;
2189 if (offset < border)
2190 /* For very wide borders make offset at least as large as
2191 border. */
2192 offset = border;
2194 if (offset < x && x < width - offset)
2195 /* Top or bottom border. */
2197 if (0 <= y && y <= border)
2198 part = INTERNAL_BORDER_TOP_EDGE;
2199 else if (height - border <= y && y <= height)
2200 part = INTERNAL_BORDER_BOTTOM_EDGE;
2202 else if (offset < y && y < height - offset)
2203 /* Left or right border. */
2205 if (0 <= x && x <= border)
2206 part = INTERNAL_BORDER_LEFT_EDGE;
2207 else if (width - border <= x && x <= width)
2208 part = INTERNAL_BORDER_RIGHT_EDGE;
2210 else
2212 /* An edge. */
2213 int half_width = width / 2;
2214 int half_height = height / 2;
2216 if (0 <= x && x <= border)
2218 /* A left edge. */
2219 if (0 <= y && y <= half_height)
2220 part = INTERNAL_BORDER_TOP_LEFT_CORNER;
2221 else if (half_height < y && y <= height)
2222 part = INTERNAL_BORDER_BOTTOM_LEFT_CORNER;
2224 else if (width - border <= x && x <= width)
2226 /* A right edge. */
2227 if (0 <= y && y <= half_height)
2228 part = INTERNAL_BORDER_TOP_RIGHT_CORNER;
2229 else if (half_height < y && y <= height)
2230 part = INTERNAL_BORDER_BOTTOM_RIGHT_CORNER;
2232 else if (0 <= y && y <= border)
2234 /* A top edge. */
2235 if (0 <= x && x <= half_width)
2236 part = INTERNAL_BORDER_TOP_LEFT_CORNER;
2237 else if (half_width < x && x <= width)
2238 part = INTERNAL_BORDER_TOP_RIGHT_CORNER;
2240 else if (height - border <= y && y <= height)
2242 /* A bottom edge. */
2243 if (0 <= x && x <= half_width)
2244 part = INTERNAL_BORDER_BOTTOM_LEFT_CORNER;
2245 else if (half_width < x && x <= width)
2246 part = INTERNAL_BORDER_BOTTOM_RIGHT_CORNER;
2250 return part;
2252 #endif
2254 /* Return mouse position in character cell units. */
2256 DEFUN ("mouse-position", Fmouse_position, Smouse_position, 0, 0, 0,
2257 doc: /* Return a list (FRAME X . Y) giving the current mouse frame and position.
2258 The position is given in canonical character cells, where (0, 0) is the
2259 upper-left corner of the frame, X is the horizontal offset, and Y is the
2260 vertical offset, measured in units of the frame's default character size.
2261 If Emacs is running on a mouseless terminal or hasn't been programmed
2262 to read the mouse position, it returns the selected frame for FRAME
2263 and nil for X and Y.
2264 If `mouse-position-function' is non-nil, `mouse-position' calls it,
2265 passing the normal return value to that function as an argument,
2266 and returns whatever that function returns. */)
2267 (void)
2269 struct frame *f;
2270 Lisp_Object lispy_dummy;
2271 Lisp_Object x, y, retval;
2273 f = SELECTED_FRAME ();
2274 x = y = Qnil;
2276 /* It's okay for the hook to refrain from storing anything. */
2277 if (FRAME_TERMINAL (f)->mouse_position_hook)
2279 enum scroll_bar_part party_dummy;
2280 Time time_dummy;
2281 (*FRAME_TERMINAL (f)->mouse_position_hook) (&f, -1,
2282 &lispy_dummy, &party_dummy,
2283 &x, &y,
2284 &time_dummy);
2287 if (! NILP (x))
2289 int col = XINT (x);
2290 int row = XINT (y);
2291 pixel_to_glyph_coords (f, col, row, &col, &row, NULL, 1);
2292 XSETINT (x, col);
2293 XSETINT (y, row);
2295 XSETFRAME (lispy_dummy, f);
2296 retval = Fcons (lispy_dummy, Fcons (x, y));
2297 if (!NILP (Vmouse_position_function))
2298 retval = call1 (Vmouse_position_function, retval);
2299 return retval;
2302 DEFUN ("mouse-pixel-position", Fmouse_pixel_position,
2303 Smouse_pixel_position, 0, 0, 0,
2304 doc: /* Return a list (FRAME X . Y) giving the current mouse frame and position.
2305 The position is given in pixel units, where (0, 0) is the
2306 upper-left corner of the frame, X is the horizontal offset, and Y is
2307 the vertical offset.
2308 If Emacs is running on a mouseless terminal or hasn't been programmed
2309 to read the mouse position, it returns the selected frame for FRAME
2310 and nil for X and Y. */)
2311 (void)
2313 struct frame *f;
2314 Lisp_Object lispy_dummy;
2315 Lisp_Object x, y, retval;
2317 f = SELECTED_FRAME ();
2318 x = y = Qnil;
2320 /* It's okay for the hook to refrain from storing anything. */
2321 if (FRAME_TERMINAL (f)->mouse_position_hook)
2323 enum scroll_bar_part party_dummy;
2324 Time time_dummy;
2325 (*FRAME_TERMINAL (f)->mouse_position_hook) (&f, -1,
2326 &lispy_dummy, &party_dummy,
2327 &x, &y,
2328 &time_dummy);
2331 XSETFRAME (lispy_dummy, f);
2332 retval = Fcons (lispy_dummy, Fcons (x, y));
2333 if (!NILP (Vmouse_position_function))
2334 retval = call1 (Vmouse_position_function, retval);
2335 return retval;
2338 #ifdef HAVE_WINDOW_SYSTEM
2340 /* On frame F, convert character coordinates X and Y to pixel
2341 coordinates *PIX_X and *PIX_Y. */
2343 static void
2344 frame_char_to_pixel_position (struct frame *f, int x, int y,
2345 int *pix_x, int *pix_y)
2347 *pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
2348 *pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
2350 if (*pix_x < 0)
2351 *pix_x = 0;
2352 if (*pix_x > FRAME_PIXEL_WIDTH (f))
2353 *pix_x = FRAME_PIXEL_WIDTH (f);
2355 if (*pix_y < 0)
2356 *pix_y = 0;
2357 if (*pix_y > FRAME_PIXEL_HEIGHT (f))
2358 *pix_y = FRAME_PIXEL_HEIGHT (f);
2361 /* On frame F, reposition mouse pointer to character coordinates X and Y. */
2363 static void
2364 frame_set_mouse_position (struct frame *f, int x, int y)
2366 int pix_x, pix_y;
2368 frame_char_to_pixel_position (f, x, y, &pix_x, &pix_y);
2369 frame_set_mouse_pixel_position (f, pix_x, pix_y);
2372 #endif /* HAVE_WINDOW_SYSTEM */
2374 DEFUN ("set-mouse-position", Fset_mouse_position, Sset_mouse_position, 3, 3, 0,
2375 doc: /* Move the mouse pointer to the center of character cell (X,Y) in FRAME.
2376 Coordinates are relative to the frame, not a window,
2377 so the coordinates of the top left character in the frame
2378 may be nonzero due to left-hand scroll bars or the menu bar.
2380 The position is given in canonical character cells, where (0, 0) is
2381 the upper-left corner of the frame, X is the horizontal offset, and
2382 Y is the vertical offset, measured in units of the frame's default
2383 character size.
2385 This function is a no-op for an X frame that is not visible.
2386 If you have just created a frame, you must wait for it to become visible
2387 before calling this function on it, like this.
2388 (while (not (frame-visible-p frame)) (sleep-for .5)) */)
2389 (Lisp_Object frame, Lisp_Object x, Lisp_Object y)
2391 CHECK_LIVE_FRAME (frame);
2392 CHECK_TYPE_RANGED_INTEGER (int, x);
2393 CHECK_TYPE_RANGED_INTEGER (int, y);
2395 /* I think this should be done with a hook. */
2396 #ifdef HAVE_WINDOW_SYSTEM
2397 if (FRAME_WINDOW_P (XFRAME (frame)))
2398 /* Warping the mouse will cause enternotify and focus events. */
2399 frame_set_mouse_position (XFRAME (frame), XINT (x), XINT (y));
2400 #else
2401 #if defined (MSDOS)
2402 if (FRAME_MSDOS_P (XFRAME (frame)))
2404 Fselect_frame (frame, Qnil);
2405 mouse_moveto (XINT (x), XINT (y));
2407 #else
2408 #ifdef HAVE_GPM
2410 Fselect_frame (frame, Qnil);
2411 term_mouse_moveto (XINT (x), XINT (y));
2413 #endif
2414 #endif
2415 #endif
2417 return Qnil;
2420 DEFUN ("set-mouse-pixel-position", Fset_mouse_pixel_position,
2421 Sset_mouse_pixel_position, 3, 3, 0,
2422 doc: /* Move the mouse pointer to pixel position (X,Y) in FRAME.
2423 The position is given in pixels, where (0, 0) is the upper-left corner
2424 of the frame, X is the horizontal offset, and Y is the vertical offset.
2426 Note, this is a no-op for an X frame that is not visible.
2427 If you have just created a frame, you must wait for it to become visible
2428 before calling this function on it, like this.
2429 (while (not (frame-visible-p frame)) (sleep-for .5)) */)
2430 (Lisp_Object frame, Lisp_Object x, Lisp_Object y)
2432 CHECK_LIVE_FRAME (frame);
2433 CHECK_TYPE_RANGED_INTEGER (int, x);
2434 CHECK_TYPE_RANGED_INTEGER (int, y);
2436 /* I think this should be done with a hook. */
2437 #ifdef HAVE_WINDOW_SYSTEM
2438 if (FRAME_WINDOW_P (XFRAME (frame)))
2439 /* Warping the mouse will cause enternotify and focus events. */
2440 frame_set_mouse_pixel_position (XFRAME (frame), XINT (x), XINT (y));
2441 #else
2442 #if defined (MSDOS)
2443 if (FRAME_MSDOS_P (XFRAME (frame)))
2445 Fselect_frame (frame, Qnil);
2446 mouse_moveto (XINT (x), XINT (y));
2448 #else
2449 #ifdef HAVE_GPM
2451 Fselect_frame (frame, Qnil);
2452 term_mouse_moveto (XINT (x), XINT (y));
2454 #endif
2455 #endif
2456 #endif
2458 return Qnil;
2461 static void make_frame_visible_1 (Lisp_Object);
2463 DEFUN ("make-frame-visible", Fmake_frame_visible, Smake_frame_visible,
2464 0, 1, "",
2465 doc: /* Make the frame FRAME visible (assuming it is an X window).
2466 If omitted, FRAME defaults to the currently selected frame. */)
2467 (Lisp_Object frame)
2469 struct frame *f = decode_live_frame (frame);
2471 /* I think this should be done with a hook. */
2472 #ifdef HAVE_WINDOW_SYSTEM
2473 if (FRAME_WINDOW_P (f))
2474 x_make_frame_visible (f);
2475 #endif
2477 make_frame_visible_1 (f->root_window);
2479 /* Make menu bar update for the Buffers and Frames menus. */
2480 /* windows_or_buffers_changed = 15; FIXME: Why? */
2482 XSETFRAME (frame, f);
2483 return frame;
2486 /* Update the display_time slot of the buffers shown in WINDOW
2487 and all its descendants. */
2489 static void
2490 make_frame_visible_1 (Lisp_Object window)
2492 struct window *w;
2494 for (; !NILP (window); window = w->next)
2496 w = XWINDOW (window);
2497 if (WINDOWP (w->contents))
2498 make_frame_visible_1 (w->contents);
2499 else
2500 bset_display_time (XBUFFER (w->contents), Fcurrent_time ());
2504 DEFUN ("make-frame-invisible", Fmake_frame_invisible, Smake_frame_invisible,
2505 0, 2, "",
2506 doc: /* Make the frame FRAME invisible.
2507 If omitted, FRAME defaults to the currently selected frame.
2508 On graphical displays, invisible frames are not updated and are
2509 usually not displayed at all, even in a window system's \"taskbar\".
2511 Normally you may not make FRAME invisible if all other frames are invisible,
2512 but if the second optional argument FORCE is non-nil, you may do so.
2514 This function has no effect on text terminal frames. Such frames are
2515 always considered visible, whether or not they are currently being
2516 displayed in the terminal. */)
2517 (Lisp_Object frame, Lisp_Object force)
2519 struct frame *f = decode_live_frame (frame);
2521 if (NILP (force) && !other_frames (f, true, false))
2522 error ("Attempt to make invisible the sole visible or iconified frame");
2524 /* Don't allow minibuf_window to remain on an invisible frame. */
2525 check_minibuf_window (frame, EQ (minibuf_window, selected_window));
2527 /* I think this should be done with a hook. */
2528 #ifdef HAVE_WINDOW_SYSTEM
2529 if (FRAME_WINDOW_P (f))
2530 x_make_frame_invisible (f);
2531 #endif
2533 /* Make menu bar update for the Buffers and Frames menus. */
2534 windows_or_buffers_changed = 16;
2536 return Qnil;
2539 DEFUN ("iconify-frame", Ficonify_frame, Siconify_frame,
2540 0, 1, "",
2541 doc: /* Make the frame FRAME into an icon.
2542 If omitted, FRAME defaults to the currently selected frame.
2544 If FRAME is a child frame, consult the variable `iconify-child-frame'
2545 for how to proceed. */)
2546 (Lisp_Object frame)
2548 struct frame *f = decode_live_frame (frame);
2549 #ifdef HAVE_WINDOW_SYSTEM
2550 Lisp_Object parent = f->parent_frame;
2552 if (!NILP (parent))
2554 if (NILP (iconify_child_frame))
2555 /* Do nothing. */
2556 return Qnil;
2557 else if (EQ (iconify_child_frame, Qiconify_top_level))
2559 /* Iconify top level frame instead (the default). */
2560 Ficonify_frame (parent);
2561 return Qnil;
2563 else if (EQ (iconify_child_frame, Qmake_invisible))
2565 /* Make frame invisible instead. */
2566 Fmake_frame_invisible (frame, Qnil);
2567 return Qnil;
2570 #endif /* HAVE_WINDOW_SYSTEM */
2572 /* Don't allow minibuf_window to remain on an iconified frame. */
2573 check_minibuf_window (frame, EQ (minibuf_window, selected_window));
2575 /* I think this should be done with a hook. */
2576 if (FRAME_WINDOW_P (f))
2578 #ifdef HAVE_WINDOW_SYSTEM
2579 x_iconify_frame (f);
2580 #endif
2583 return Qnil;
2586 DEFUN ("frame-visible-p", Fframe_visible_p, Sframe_visible_p,
2587 1, 1, 0,
2588 doc: /* Return t if FRAME is \"visible\" (actually in use for display).
2589 Return the symbol `icon' if FRAME is iconified or \"minimized\".
2590 Return nil if FRAME was made invisible, via `make-frame-invisible'.
2591 On graphical displays, invisible frames are not updated and are
2592 usually not displayed at all, even in a window system's \"taskbar\".
2594 If FRAME is a text terminal frame, this always returns t.
2595 Such frames are always considered visible, whether or not they are
2596 currently being displayed on the terminal. */)
2597 (Lisp_Object frame)
2599 CHECK_LIVE_FRAME (frame);
2601 if (FRAME_VISIBLE_P (XFRAME (frame)))
2602 return Qt;
2603 if (FRAME_ICONIFIED_P (XFRAME (frame)))
2604 return Qicon;
2605 return Qnil;
2608 DEFUN ("visible-frame-list", Fvisible_frame_list, Svisible_frame_list,
2609 0, 0, 0,
2610 doc: /* Return a list of all frames now \"visible\" (being updated). */)
2611 (void)
2613 Lisp_Object tail, frame, value = Qnil;
2615 FOR_EACH_FRAME (tail, frame)
2616 if (FRAME_VISIBLE_P (XFRAME (frame)))
2617 value = Fcons (frame, value);
2619 return value;
2623 DEFUN ("raise-frame", Fraise_frame, Sraise_frame, 0, 1, "",
2624 doc: /* Bring FRAME to the front, so it occludes any frames it overlaps.
2625 If FRAME is invisible or iconified, make it visible.
2626 If you don't specify a frame, the selected frame is used.
2627 If Emacs is displaying on an ordinary terminal or some other device which
2628 doesn't support multiple overlapping frames, this function selects FRAME. */)
2629 (Lisp_Object frame)
2631 struct frame *f = decode_live_frame (frame);
2633 XSETFRAME (frame, f);
2635 if (FRAME_TERMCAP_P (f))
2636 /* On a text terminal select FRAME. */
2637 Fselect_frame (frame, Qnil);
2638 else
2639 /* Do like the documentation says. */
2640 Fmake_frame_visible (frame);
2642 if (FRAME_TERMINAL (f)->frame_raise_lower_hook)
2643 (*FRAME_TERMINAL (f)->frame_raise_lower_hook) (f, 1);
2645 return Qnil;
2648 /* Should we have a corresponding function called Flower_Power? */
2649 DEFUN ("lower-frame", Flower_frame, Slower_frame, 0, 1, "",
2650 doc: /* Send FRAME to the back, so it is occluded by any frames that overlap it.
2651 If you don't specify a frame, the selected frame is used.
2652 If Emacs is displaying on an ordinary terminal or some other device which
2653 doesn't support multiple overlapping frames, this function does nothing. */)
2654 (Lisp_Object frame)
2656 struct frame *f = decode_live_frame (frame);
2658 if (FRAME_TERMINAL (f)->frame_raise_lower_hook)
2659 (*FRAME_TERMINAL (f)->frame_raise_lower_hook) (f, 0);
2661 return Qnil;
2665 DEFUN ("redirect-frame-focus", Fredirect_frame_focus, Sredirect_frame_focus,
2666 1, 2, 0,
2667 doc: /* Arrange for keystrokes typed at FRAME to be sent to FOCUS-FRAME.
2668 In other words, switch-frame events caused by events in FRAME will
2669 request a switch to FOCUS-FRAME, and `last-event-frame' will be
2670 FOCUS-FRAME after reading an event typed at FRAME.
2672 If FOCUS-FRAME is nil, any existing redirection is canceled, and the
2673 frame again receives its own keystrokes.
2675 Focus redirection is useful for temporarily redirecting keystrokes to
2676 a surrogate minibuffer frame when a frame doesn't have its own
2677 minibuffer window.
2679 A frame's focus redirection can be changed by `select-frame'. If frame
2680 FOO is selected, and then a different frame BAR is selected, any
2681 frames redirecting their focus to FOO are shifted to redirect their
2682 focus to BAR. This allows focus redirection to work properly when the
2683 user switches from one frame to another using `select-window'.
2685 This means that a frame whose focus is redirected to itself is treated
2686 differently from a frame whose focus is redirected to nil; the former
2687 is affected by `select-frame', while the latter is not.
2689 The redirection lasts until `redirect-frame-focus' is called to change it. */)
2690 (Lisp_Object frame, Lisp_Object focus_frame)
2692 /* Note that we don't check for a live frame here. It's reasonable
2693 to redirect the focus of a frame you're about to delete, if you
2694 know what other frame should receive those keystrokes. */
2695 struct frame *f = decode_any_frame (frame);
2697 if (! NILP (focus_frame))
2698 CHECK_LIVE_FRAME (focus_frame);
2700 fset_focus_frame (f, focus_frame);
2702 if (FRAME_TERMINAL (f)->frame_rehighlight_hook)
2703 (*FRAME_TERMINAL (f)->frame_rehighlight_hook) (f);
2705 return Qnil;
2709 DEFUN ("frame-focus", Fframe_focus, Sframe_focus, 0, 1, 0,
2710 doc: /* Return the frame to which FRAME's keystrokes are currently being sent.
2711 If FRAME is omitted or nil, the selected frame is used.
2712 Return nil if FRAME's focus is not redirected.
2713 See `redirect-frame-focus'. */)
2714 (Lisp_Object frame)
2716 return FRAME_FOCUS_FRAME (decode_live_frame (frame));
2719 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 2, 0,
2720 doc: /* Set the input focus to FRAME.
2721 FRAME nil means use the selected frame. Optional argument NOACTIVATE
2722 means do not activate FRAME.
2724 If there is no window system support, this function does nothing. */)
2725 (Lisp_Object frame, Lisp_Object noactivate)
2727 #ifdef HAVE_WINDOW_SYSTEM
2728 x_focus_frame (decode_window_system_frame (frame), !NILP (noactivate));
2729 #endif
2730 return Qnil;
2733 DEFUN ("frame-after-make-frame",
2734 Fframe_after_make_frame,
2735 Sframe_after_make_frame, 2, 2, 0,
2736 doc: /* Mark FRAME as made.
2737 FRAME nil means use the selected frame. Second argument MADE non-nil
2738 means functions on `window-configuration-change-hook' are called
2739 whenever the window configuration of FRAME changes. MADE nil means
2740 these functions are not called.
2742 This function is currently called by `make-frame' only and should be
2743 otherwise used with utter care to avoid that running functions on
2744 `window-configuration-change-hook' is impeded forever. */)
2745 (Lisp_Object frame, Lisp_Object made)
2747 struct frame *f = decode_live_frame (frame);
2748 f->after_make_frame = !NILP (made);
2749 f->inhibit_horizontal_resize = false;
2750 f->inhibit_vertical_resize = false;
2751 return made;
2755 /* Discard BUFFER from the buffer-list and buried-buffer-list of each frame. */
2757 void
2758 frames_discard_buffer (Lisp_Object buffer)
2760 Lisp_Object frame, tail;
2762 FOR_EACH_FRAME (tail, frame)
2764 fset_buffer_list
2765 (XFRAME (frame), Fdelq (buffer, XFRAME (frame)->buffer_list));
2766 fset_buried_buffer_list
2767 (XFRAME (frame), Fdelq (buffer, XFRAME (frame)->buried_buffer_list));
2771 /* Modify the alist in *ALISTPTR to associate PROP with VAL.
2772 If the alist already has an element for PROP, we change it. */
2774 void
2775 store_in_alist (Lisp_Object *alistptr, Lisp_Object prop, Lisp_Object val)
2777 register Lisp_Object tem;
2779 tem = Fassq (prop, *alistptr);
2780 if (EQ (tem, Qnil))
2781 *alistptr = Fcons (Fcons (prop, val), *alistptr);
2782 else
2783 Fsetcdr (tem, val);
2786 static int
2787 frame_name_fnn_p (char *str, ptrdiff_t len)
2789 if (len > 1 && str[0] == 'F' && '0' <= str[1] && str[1] <= '9')
2791 char *p = str + 2;
2792 while ('0' <= *p && *p <= '9')
2793 p++;
2794 if (p == str + len)
2795 return 1;
2797 return 0;
2800 /* Set the name of the terminal frame. Also used by MSDOS frames.
2801 Modeled after x_set_name which is used for WINDOW frames. */
2803 static void
2804 set_term_frame_name (struct frame *f, Lisp_Object name)
2806 f->explicit_name = ! NILP (name);
2808 /* If NAME is nil, set the name to F<num>. */
2809 if (NILP (name))
2811 char namebuf[sizeof "F" + INT_STRLEN_BOUND (printmax_t)];
2813 /* Check for no change needed in this very common case
2814 before we do any consing. */
2815 if (frame_name_fnn_p (SSDATA (f->name), SBYTES (f->name)))
2816 return;
2818 name = make_formatted_string (namebuf, "F%"pMd, ++tty_frame_count);
2820 else
2822 CHECK_STRING (name);
2824 /* Don't change the name if it's already NAME. */
2825 if (! NILP (Fstring_equal (name, f->name)))
2826 return;
2828 /* Don't allow the user to set the frame name to F<num>, so it
2829 doesn't clash with the names we generate for terminal frames. */
2830 if (frame_name_fnn_p (SSDATA (name), SBYTES (name)))
2831 error ("Frame names of the form F<num> are usurped by Emacs");
2834 fset_name (f, name);
2835 update_mode_lines = 16;
2838 void
2839 store_frame_param (struct frame *f, Lisp_Object prop, Lisp_Object val)
2841 register Lisp_Object old_alist_elt;
2843 if (EQ (prop, Qminibuffer))
2845 if (WINDOWP (val))
2847 if (!MINI_WINDOW_P (XWINDOW (val)))
2848 error ("The `minibuffer' parameter does not specify a valid minibuffer window");
2849 else if (FRAME_MINIBUF_ONLY_P (f))
2851 if (EQ (val, FRAME_MINIBUF_WINDOW (f)))
2852 val = Qonly;
2853 else
2854 error ("Can't change the minibuffer window of a minibuffer-only frame");
2856 else if (FRAME_HAS_MINIBUF_P (f))
2858 if (EQ (val, FRAME_MINIBUF_WINDOW (f)))
2859 val = Qt;
2860 else
2861 error ("Can't change the minibuffer window of a frame with its own minibuffer");
2863 else
2864 /* Store the chosen minibuffer window. */
2865 fset_minibuffer_window (f, val);
2867 else
2869 Lisp_Object old_val = Fcdr (Fassq (Qminibuffer, f->param_alist));
2871 if (!NILP (old_val))
2873 if (WINDOWP (old_val) && NILP (val))
2874 /* Don't change the value for a minibuffer-less frame if
2875 only nil was specified as new value. */
2876 val = old_val;
2877 else if (!EQ (old_val, val))
2878 error ("Can't change the `minibuffer' parameter of this frame");
2883 /* Check each parent-frame and delete-before parameter for a
2884 circular dependency. Do not check between parameters, so you can
2885 still create circular dependencies with different properties, for
2886 example a chain of frames F1->F2->...Fn such that F1 is an ancestor
2887 frame of Fn and thus cannot be deleted before Fn and a second chain
2888 Fn->Fn-1->...F1 such that Fn cannot be deleted before F1. */
2889 else if (EQ (prop, Qparent_frame) || EQ (prop, Qdelete_before))
2891 Lisp_Object oldval = Fcdr (Fassq (prop, f->param_alist));
2893 if (!EQ (oldval, val) && !NILP (val))
2895 Lisp_Object frame;
2896 Lisp_Object frame1 = val;
2898 if (!FRAMEP (frame1) || !FRAME_LIVE_P (XFRAME (frame1)))
2899 error ("Invalid `%s' frame parameter",
2900 SSDATA (SYMBOL_NAME (prop)));
2902 XSETFRAME (frame, f);
2904 while (FRAMEP (frame1) && FRAME_LIVE_P (XFRAME (frame1)))
2905 if (EQ (frame1, frame))
2906 error ("Circular specification of `%s' frame parameter",
2907 SSDATA (SYMBOL_NAME (prop)));
2908 else
2909 frame1 = get_frame_param (XFRAME (frame1), prop);
2913 /* The buffer-list parameters are stored in a special place and not
2914 in the alist. All buffers must be live. */
2915 else if (EQ (prop, Qbuffer_list))
2917 Lisp_Object list = Qnil;
2918 for (; CONSP (val); val = XCDR (val))
2919 if (!NILP (Fbuffer_live_p (XCAR (val))))
2920 list = Fcons (XCAR (val), list);
2921 fset_buffer_list (f, Fnreverse (list));
2922 return;
2924 else if (EQ (prop, Qburied_buffer_list))
2926 Lisp_Object list = Qnil;
2927 for (; CONSP (val); val = XCDR (val))
2928 if (!NILP (Fbuffer_live_p (XCAR (val))))
2929 list = Fcons (XCAR (val), list);
2930 fset_buried_buffer_list (f, Fnreverse (list));
2931 return;
2934 /* The tty color needed to be set before the frame's parameter
2935 alist was updated with the new value. This is not true any more,
2936 but we still do this test early on. */
2937 if (FRAME_TERMCAP_P (f) && EQ (prop, Qtty_color_mode)
2938 && f == FRAME_TTY (f)->previous_frame)
2939 /* Force redisplay of this tty. */
2940 FRAME_TTY (f)->previous_frame = NULL;
2942 /* Update the frame parameter alist. */
2943 old_alist_elt = Fassq (prop, f->param_alist);
2944 if (EQ (old_alist_elt, Qnil))
2945 fset_param_alist (f, Fcons (Fcons (prop, val), f->param_alist));
2946 else
2947 Fsetcdr (old_alist_elt, val);
2949 /* Update some other special parameters in their special places
2950 in addition to the alist. */
2952 if (EQ (prop, Qbuffer_predicate))
2953 fset_buffer_predicate (f, val);
2955 if (! FRAME_WINDOW_P (f))
2957 if (EQ (prop, Qmenu_bar_lines))
2958 set_menu_bar_lines (f, val, make_number (FRAME_MENU_BAR_LINES (f)));
2959 else if (EQ (prop, Qname))
2960 set_term_frame_name (f, val);
2964 /* Return color matches UNSPEC on frame F or nil if UNSPEC
2965 is not an unspecified foreground or background color. */
2967 static Lisp_Object
2968 frame_unspecified_color (struct frame *f, Lisp_Object unspec)
2970 return (!strncmp (SSDATA (unspec), unspecified_bg, SBYTES (unspec))
2971 ? tty_color_name (f, FRAME_BACKGROUND_PIXEL (f))
2972 : (!strncmp (SSDATA (unspec), unspecified_fg, SBYTES (unspec))
2973 ? tty_color_name (f, FRAME_FOREGROUND_PIXEL (f)) : Qnil));
2976 DEFUN ("frame-parameters", Fframe_parameters, Sframe_parameters, 0, 1, 0,
2977 doc: /* Return the parameters-alist of frame FRAME.
2978 It is a list of elements of the form (PARM . VALUE), where PARM is a symbol.
2979 The meaningful PARMs depend on the kind of frame.
2980 If FRAME is omitted or nil, return information on the currently selected frame. */)
2981 (Lisp_Object frame)
2983 Lisp_Object alist;
2984 struct frame *f = decode_any_frame (frame);
2985 int height, width;
2987 if (!FRAME_LIVE_P (f))
2988 return Qnil;
2990 alist = Fcopy_alist (f->param_alist);
2992 if (!FRAME_WINDOW_P (f))
2994 Lisp_Object elt;
2996 /* If the frame's parameter alist says the colors are
2997 unspecified and reversed, take the frame's background pixel
2998 for foreground and vice versa. */
2999 elt = Fassq (Qforeground_color, alist);
3000 if (CONSP (elt) && STRINGP (XCDR (elt)))
3002 elt = frame_unspecified_color (f, XCDR (elt));
3003 if (!NILP (elt))
3004 store_in_alist (&alist, Qforeground_color, elt);
3006 else
3007 store_in_alist (&alist, Qforeground_color,
3008 tty_color_name (f, FRAME_FOREGROUND_PIXEL (f)));
3009 elt = Fassq (Qbackground_color, alist);
3010 if (CONSP (elt) && STRINGP (XCDR (elt)))
3012 elt = frame_unspecified_color (f, XCDR (elt));
3013 if (!NILP (elt))
3014 store_in_alist (&alist, Qbackground_color, elt);
3016 else
3017 store_in_alist (&alist, Qbackground_color,
3018 tty_color_name (f, FRAME_BACKGROUND_PIXEL (f)));
3019 store_in_alist (&alist, Qfont,
3020 build_string (FRAME_MSDOS_P (f)
3021 ? "ms-dos"
3022 : FRAME_W32_P (f) ? "w32term"
3023 :"tty"));
3025 store_in_alist (&alist, Qname, f->name);
3026 height = (f->new_height
3027 ? (f->new_pixelwise
3028 ? (f->new_height / FRAME_LINE_HEIGHT (f))
3029 : f->new_height)
3030 : FRAME_LINES (f));
3031 store_in_alist (&alist, Qheight, make_number (height));
3032 width = (f->new_width
3033 ? (f->new_pixelwise
3034 ? (f->new_width / FRAME_COLUMN_WIDTH (f))
3035 : f->new_width)
3036 : FRAME_COLS (f));
3037 store_in_alist (&alist, Qwidth, make_number (width));
3038 store_in_alist (&alist, Qmodeline, (FRAME_WANTS_MODELINE_P (f) ? Qt : Qnil));
3039 store_in_alist (&alist, Qunsplittable, (FRAME_NO_SPLIT_P (f) ? Qt : Qnil));
3040 store_in_alist (&alist, Qbuffer_list, f->buffer_list);
3041 store_in_alist (&alist, Qburied_buffer_list, f->buried_buffer_list);
3043 /* I think this should be done with a hook. */
3044 #ifdef HAVE_WINDOW_SYSTEM
3045 if (FRAME_WINDOW_P (f))
3046 x_report_frame_params (f, &alist);
3047 else
3048 #endif
3050 /* This ought to be correct in f->param_alist for an X frame. */
3051 Lisp_Object lines;
3052 XSETFASTINT (lines, FRAME_MENU_BAR_LINES (f));
3053 store_in_alist (&alist, Qmenu_bar_lines, lines);
3056 return alist;
3060 DEFUN ("frame-parameter", Fframe_parameter, Sframe_parameter, 2, 2, 0,
3061 doc: /* Return FRAME's value for parameter PARAMETER.
3062 If FRAME is nil, describe the currently selected frame. */)
3063 (Lisp_Object frame, Lisp_Object parameter)
3065 struct frame *f = decode_any_frame (frame);
3066 Lisp_Object value = Qnil;
3068 CHECK_SYMBOL (parameter);
3070 XSETFRAME (frame, f);
3072 if (FRAME_LIVE_P (f))
3074 /* Avoid consing in frequent cases. */
3075 if (EQ (parameter, Qname))
3076 value = f->name;
3077 #ifdef HAVE_WINDOW_SYSTEM
3078 /* These are used by vertical motion commands. */
3079 else if (EQ (parameter, Qvertical_scroll_bars))
3080 value = (f->vertical_scroll_bar_type == vertical_scroll_bar_none
3081 ? Qnil
3082 : (f->vertical_scroll_bar_type == vertical_scroll_bar_left
3083 ? Qleft : Qright));
3084 else if (EQ (parameter, Qhorizontal_scroll_bars))
3085 value = f->horizontal_scroll_bars ? Qt : Qnil;
3086 else if (EQ (parameter, Qline_spacing) && f->extra_line_spacing == 0)
3087 /* If this is non-zero, we can't determine whether the user specified
3088 an integer or float value without looking through 'param_alist'. */
3089 value = make_number (0);
3090 else if (EQ (parameter, Qfont) && FRAME_X_P (f))
3091 value = FRAME_FONT (f)->props[FONT_NAME_INDEX];
3092 #endif /* HAVE_WINDOW_SYSTEM */
3093 #ifdef HAVE_X_WINDOWS
3094 else if (EQ (parameter, Qdisplay) && FRAME_X_P (f))
3095 value = XCAR (FRAME_DISPLAY_INFO (f)->name_list_element);
3096 #endif /* HAVE_X_WINDOWS */
3097 else if (EQ (parameter, Qbackground_color)
3098 || EQ (parameter, Qforeground_color))
3100 value = Fassq (parameter, f->param_alist);
3101 if (CONSP (value))
3103 value = XCDR (value);
3104 /* Fframe_parameters puts the actual fg/bg color names,
3105 even if f->param_alist says otherwise. This is
3106 important when param_alist's notion of colors is
3107 "unspecified". We need to do the same here. */
3108 if (STRINGP (value) && !FRAME_WINDOW_P (f))
3110 Lisp_Object tem = frame_unspecified_color (f, value);
3112 if (!NILP (tem))
3113 value = tem;
3116 else
3117 value = Fcdr (Fassq (parameter, Fframe_parameters (frame)));
3119 else if (EQ (parameter, Qdisplay_type)
3120 || EQ (parameter, Qbackground_mode))
3121 value = Fcdr (Fassq (parameter, f->param_alist));
3122 else
3123 /* FIXME: Avoid this code path at all (as well as code duplication)
3124 by sharing more code with Fframe_parameters. */
3125 value = Fcdr (Fassq (parameter, Fframe_parameters (frame)));
3128 return value;
3132 DEFUN ("modify-frame-parameters", Fmodify_frame_parameters,
3133 Smodify_frame_parameters, 2, 2, 0,
3134 doc: /* Modify FRAME according to new values of its parameters in ALIST.
3135 If FRAME is nil, it defaults to the selected frame.
3136 ALIST is an alist of parameters to change and their new values.
3137 Each element of ALIST has the form (PARM . VALUE), where PARM is a symbol.
3138 Which PARMs are meaningful depends on the kind of frame.
3139 The meaningful parameters are acted upon, i.e. the frame is changed
3140 according to their new values, and are also stored in the frame's
3141 parameter list so that `frame-parameters' will return them.
3142 PARMs that are not meaningful are still stored in the frame's parameter
3143 list, but are otherwise ignored. */)
3144 (Lisp_Object frame, Lisp_Object alist)
3146 struct frame *f = decode_live_frame (frame);
3147 Lisp_Object prop, val;
3149 /* I think this should be done with a hook. */
3150 #ifdef HAVE_WINDOW_SYSTEM
3151 if (FRAME_WINDOW_P (f))
3152 x_set_frame_parameters (f, alist);
3153 else
3154 #endif
3155 #ifdef MSDOS
3156 if (FRAME_MSDOS_P (f))
3157 IT_set_frame_parameters (f, alist);
3158 else
3159 #endif
3162 EMACS_INT length = XFASTINT (Flength (alist));
3163 ptrdiff_t i;
3164 Lisp_Object *parms;
3165 Lisp_Object *values;
3166 USE_SAFE_ALLOCA;
3167 SAFE_ALLOCA_LISP (parms, 2 * length);
3168 values = parms + length;
3170 /* Extract parm names and values into those vectors. */
3172 for (i = 0; CONSP (alist); alist = XCDR (alist))
3174 Lisp_Object elt;
3176 elt = XCAR (alist);
3177 parms[i] = Fcar (elt);
3178 values[i] = Fcdr (elt);
3179 i++;
3182 /* Now process them in reverse of specified order. */
3183 while (--i >= 0)
3185 prop = parms[i];
3186 val = values[i];
3187 store_frame_param (f, prop, val);
3189 if (EQ (prop, Qforeground_color)
3190 || EQ (prop, Qbackground_color))
3191 update_face_from_frame_parameter (f, prop, val);
3194 SAFE_FREE ();
3196 return Qnil;
3199 DEFUN ("frame-char-height", Fframe_char_height, Sframe_char_height,
3200 0, 1, 0,
3201 doc: /* Height in pixels of a line in the font in frame FRAME.
3202 If FRAME is omitted or nil, the selected frame is used.
3203 For a terminal frame, the value is always 1. */)
3204 (Lisp_Object frame)
3206 #ifdef HAVE_WINDOW_SYSTEM
3207 struct frame *f = decode_any_frame (frame);
3209 if (FRAME_WINDOW_P (f))
3210 return make_number (FRAME_LINE_HEIGHT (f));
3211 else
3212 #endif
3213 return make_number (1);
3217 DEFUN ("frame-char-width", Fframe_char_width, Sframe_char_width,
3218 0, 1, 0,
3219 doc: /* Width in pixels of characters in the font in frame FRAME.
3220 If FRAME is omitted or nil, the selected frame is used.
3221 On a graphical screen, the width is the standard width of the default font.
3222 For a terminal screen, the value is always 1. */)
3223 (Lisp_Object frame)
3225 #ifdef HAVE_WINDOW_SYSTEM
3226 struct frame *f = decode_any_frame (frame);
3228 if (FRAME_WINDOW_P (f))
3229 return make_number (FRAME_COLUMN_WIDTH (f));
3230 else
3231 #endif
3232 return make_number (1);
3235 DEFUN ("frame-native-width", Fframe_native_width,
3236 Sframe_native_width, 0, 1, 0,
3237 doc: /* Return FRAME's native width in pixels.
3238 For a terminal frame, the result really gives the width in characters.
3239 If FRAME is omitted or nil, the selected frame is used. */)
3240 (Lisp_Object frame)
3242 struct frame *f = decode_any_frame (frame);
3244 #ifdef HAVE_WINDOW_SYSTEM
3245 if (FRAME_WINDOW_P (f))
3246 return make_number (FRAME_PIXEL_WIDTH (f));
3247 else
3248 #endif
3249 return make_number (FRAME_TOTAL_COLS (f));
3252 DEFUN ("frame-native-height", Fframe_native_height,
3253 Sframe_native_height, 0, 1, 0,
3254 doc: /* Return FRAME's native height in pixels.
3255 If FRAME is omitted or nil, the selected frame is used. The exact value
3256 of the result depends on the window-system and toolkit in use:
3258 In the Gtk+ and NS versions, it includes only any window (including the
3259 minibuffer or echo area), mode line, and header line. It does not
3260 include the tool bar or menu bar. With other graphical versions, it may
3261 also include the tool bar and the menu bar.
3263 For a text terminal, it includes the menu bar. In this case, the
3264 result is really in characters rather than pixels (i.e., is identical
3265 to `frame-height'). */)
3266 (Lisp_Object frame)
3268 struct frame *f = decode_any_frame (frame);
3270 #ifdef HAVE_WINDOW_SYSTEM
3271 if (FRAME_WINDOW_P (f))
3272 return make_number (FRAME_PIXEL_HEIGHT (f));
3273 else
3274 #endif
3275 return make_number (FRAME_TOTAL_LINES (f));
3278 DEFUN ("tool-bar-pixel-width", Ftool_bar_pixel_width,
3279 Stool_bar_pixel_width, 0, 1, 0,
3280 doc: /* Return width in pixels of FRAME's tool bar.
3281 The result is greater than zero only when the tool bar is on the left
3282 or right side of FRAME. If FRAME is omitted or nil, the selected frame
3283 is used. */)
3284 (Lisp_Object frame)
3286 #ifdef FRAME_TOOLBAR_WIDTH
3287 struct frame *f = decode_any_frame (frame);
3289 if (FRAME_WINDOW_P (f))
3290 return make_number (FRAME_TOOLBAR_WIDTH (f));
3291 #endif
3292 return make_number (0);
3295 DEFUN ("frame-text-cols", Fframe_text_cols, Sframe_text_cols, 0, 1, 0,
3296 doc: /* Return width in columns of FRAME's text area. */)
3297 (Lisp_Object frame)
3299 return make_number (FRAME_COLS (decode_any_frame (frame)));
3302 DEFUN ("frame-text-lines", Fframe_text_lines, Sframe_text_lines, 0, 1, 0,
3303 doc: /* Return height in lines of FRAME's text area. */)
3304 (Lisp_Object frame)
3306 return make_number (FRAME_LINES (decode_any_frame (frame)));
3309 DEFUN ("frame-total-cols", Fframe_total_cols, Sframe_total_cols, 0, 1, 0,
3310 doc: /* Return number of total columns of FRAME. */)
3311 (Lisp_Object frame)
3313 return make_number (FRAME_TOTAL_COLS (decode_any_frame (frame)));
3316 DEFUN ("frame-total-lines", Fframe_total_lines, Sframe_total_lines, 0, 1, 0,
3317 doc: /* Return number of total lines of FRAME. */)
3318 (Lisp_Object frame)
3320 return make_number (FRAME_TOTAL_LINES (decode_any_frame (frame)));
3323 DEFUN ("frame-text-width", Fframe_text_width, Sframe_text_width, 0, 1, 0,
3324 doc: /* Return text area width of FRAME in pixels. */)
3325 (Lisp_Object frame)
3327 return make_number (FRAME_TEXT_WIDTH (decode_any_frame (frame)));
3330 DEFUN ("frame-text-height", Fframe_text_height, Sframe_text_height, 0, 1, 0,
3331 doc: /* Return text area height of FRAME in pixels. */)
3332 (Lisp_Object frame)
3334 return make_number (FRAME_TEXT_HEIGHT (decode_any_frame (frame)));
3337 DEFUN ("frame-scroll-bar-width", Fscroll_bar_width, Sscroll_bar_width, 0, 1, 0,
3338 doc: /* Return scroll bar width of FRAME in pixels. */)
3339 (Lisp_Object frame)
3341 return make_number (FRAME_SCROLL_BAR_AREA_WIDTH (decode_any_frame (frame)));
3344 DEFUN ("frame-scroll-bar-height", Fscroll_bar_height, Sscroll_bar_height, 0, 1, 0,
3345 doc: /* Return scroll bar height of FRAME in pixels. */)
3346 (Lisp_Object frame)
3348 return make_number (FRAME_SCROLL_BAR_AREA_HEIGHT (decode_any_frame (frame)));
3351 DEFUN ("frame-fringe-width", Ffringe_width, Sfringe_width, 0, 1, 0,
3352 doc: /* Return fringe width of FRAME in pixels. */)
3353 (Lisp_Object frame)
3355 return make_number (FRAME_TOTAL_FRINGE_WIDTH (decode_any_frame (frame)));
3358 DEFUN ("frame-internal-border-width", Fframe_internal_border_width, Sframe_internal_border_width, 0, 1, 0,
3359 doc: /* Return width of FRAME's internal border in pixels. */)
3360 (Lisp_Object frame)
3362 return make_number (FRAME_INTERNAL_BORDER_WIDTH (decode_any_frame (frame)));
3365 DEFUN ("frame-right-divider-width", Fright_divider_width, Sright_divider_width, 0, 1, 0,
3366 doc: /* Return width (in pixels) of vertical window dividers on FRAME. */)
3367 (Lisp_Object frame)
3369 return make_number (FRAME_RIGHT_DIVIDER_WIDTH (decode_any_frame (frame)));
3372 DEFUN ("frame-bottom-divider-width", Fbottom_divider_width, Sbottom_divider_width, 0, 1, 0,
3373 doc: /* Return width (in pixels) of horizontal window dividers on FRAME. */)
3374 (Lisp_Object frame)
3376 return make_number (FRAME_BOTTOM_DIVIDER_WIDTH (decode_any_frame (frame)));
3379 DEFUN ("set-frame-height", Fset_frame_height, Sset_frame_height, 2, 4, 0,
3380 doc: /* Set text height of frame FRAME to HEIGHT lines.
3381 Optional third arg PRETEND non-nil means that redisplay should use
3382 HEIGHT lines but that the idea of the actual height of the frame should
3383 not be changed.
3385 Optional fourth argument PIXELWISE non-nil means that FRAME should be
3386 HEIGHT pixels high. Note: When `frame-resize-pixelwise' is nil, some
3387 window managers may refuse to honor a HEIGHT that is not an integer
3388 multiple of the default frame font height. */)
3389 (Lisp_Object frame, Lisp_Object height, Lisp_Object pretend, Lisp_Object pixelwise)
3391 struct frame *f = decode_live_frame (frame);
3392 int pixel_height;
3394 CHECK_TYPE_RANGED_INTEGER (int, height);
3396 pixel_height = (!NILP (pixelwise)
3397 ? XINT (height)
3398 : XINT (height) * FRAME_LINE_HEIGHT (f));
3399 adjust_frame_size (f, -1, pixel_height, 1, !NILP (pretend), Qheight);
3401 return Qnil;
3404 DEFUN ("set-frame-width", Fset_frame_width, Sset_frame_width, 2, 4, 0,
3405 doc: /* Set text width of frame FRAME to WIDTH columns.
3406 Optional third arg PRETEND non-nil means that redisplay should use WIDTH
3407 columns but that the idea of the actual width of the frame should not
3408 be changed.
3410 Optional fourth argument PIXELWISE non-nil means that FRAME should be
3411 WIDTH pixels wide. Note: When `frame-resize-pixelwise' is nil, some
3412 window managers may refuse to honor a WIDTH that is not an integer
3413 multiple of the default frame font width. */)
3414 (Lisp_Object frame, Lisp_Object width, Lisp_Object pretend, Lisp_Object pixelwise)
3416 struct frame *f = decode_live_frame (frame);
3417 int pixel_width;
3419 CHECK_TYPE_RANGED_INTEGER (int, width);
3421 pixel_width = (!NILP (pixelwise)
3422 ? XINT (width)
3423 : XINT (width) * FRAME_COLUMN_WIDTH (f));
3424 adjust_frame_size (f, pixel_width, -1, 1, !NILP (pretend), Qwidth);
3426 return Qnil;
3429 DEFUN ("set-frame-size", Fset_frame_size, Sset_frame_size, 3, 4, 0,
3430 doc: /* Set text size of FRAME to WIDTH by HEIGHT, measured in characters.
3431 Optional argument PIXELWISE non-nil means to measure in pixels. Note:
3432 When `frame-resize-pixelwise' is nil, some window managers may refuse to
3433 honor a WIDTH that is not an integer multiple of the default frame font
3434 width or a HEIGHT that is not an integer multiple of the default frame
3435 font height. */)
3436 (Lisp_Object frame, Lisp_Object width, Lisp_Object height, Lisp_Object pixelwise)
3438 struct frame *f = decode_live_frame (frame);
3439 int pixel_width, pixel_height;
3441 CHECK_TYPE_RANGED_INTEGER (int, width);
3442 CHECK_TYPE_RANGED_INTEGER (int, height);
3444 pixel_width = (!NILP (pixelwise)
3445 ? XINT (width)
3446 : XINT (width) * FRAME_COLUMN_WIDTH (f));
3447 pixel_height = (!NILP (pixelwise)
3448 ? XINT (height)
3449 : XINT (height) * FRAME_LINE_HEIGHT (f));
3450 adjust_frame_size (f, pixel_width, pixel_height, 1, 0, Qsize);
3452 return Qnil;
3455 DEFUN ("frame-position", Fframe_position,
3456 Sframe_position, 0, 1, 0,
3457 doc: /* Return top left corner of FRAME in pixels.
3458 FRAME must be a live frame and defaults to the selected one. The return
3459 value is a cons (x, y) of the coordinates of the top left corner of
3460 FRAME's outer frame, in pixels relative to an origin (0, 0) of FRAME's
3461 display. */)
3462 (Lisp_Object frame)
3464 register struct frame *f = decode_live_frame (frame);
3466 return Fcons (make_number (f->left_pos), make_number (f->top_pos));
3469 DEFUN ("set-frame-position", Fset_frame_position,
3470 Sset_frame_position, 3, 3, 0,
3471 doc: /* Set position of FRAME to (X, Y).
3472 FRAME must be a live frame and defaults to the selected one. X and Y,
3473 if positive, specify the coordinate of the left and top edge of FRAME's
3474 outer frame in pixels relative to an origin (0, 0) of FRAME's display.
3475 If any of X or Y is negative, it specifies the coordinates of the right
3476 or bottom edge of the outer frame of FRAME relative to the right or
3477 bottom edge of FRAME's display. */)
3478 (Lisp_Object frame, Lisp_Object x, Lisp_Object y)
3480 struct frame *f = decode_live_frame (frame);
3482 CHECK_TYPE_RANGED_INTEGER (int, x);
3483 CHECK_TYPE_RANGED_INTEGER (int, y);
3485 /* I think this should be done with a hook. */
3486 if (FRAME_WINDOW_P (f))
3488 #ifdef HAVE_WINDOW_SYSTEM
3489 x_set_offset (f, XINT (x), XINT (y), 1);
3490 #endif
3493 return Qt;
3496 /***********************************************************************
3497 Frame Parameters
3498 ***********************************************************************/
3500 /* Connect the frame-parameter names for X frames
3501 to the ways of passing the parameter values to the window system.
3503 The name of a parameter, as a Lisp symbol,
3504 has an `x-frame-parameter' property which is an integer in Lisp
3505 that is an index in this table. */
3507 struct frame_parm_table {
3508 const char *name;
3509 int sym;
3512 static const struct frame_parm_table frame_parms[] =
3514 {"auto-raise", SYMBOL_INDEX (Qauto_raise)},
3515 {"auto-lower", SYMBOL_INDEX (Qauto_lower)},
3516 {"background-color", -1},
3517 {"border-color", SYMBOL_INDEX (Qborder_color)},
3518 {"border-width", SYMBOL_INDEX (Qborder_width)},
3519 {"cursor-color", SYMBOL_INDEX (Qcursor_color)},
3520 {"cursor-type", SYMBOL_INDEX (Qcursor_type)},
3521 {"font", -1},
3522 {"foreground-color", -1},
3523 {"icon-name", SYMBOL_INDEX (Qicon_name)},
3524 {"icon-type", SYMBOL_INDEX (Qicon_type)},
3525 {"internal-border-width", SYMBOL_INDEX (Qinternal_border_width)},
3526 {"right-divider-width", SYMBOL_INDEX (Qright_divider_width)},
3527 {"bottom-divider-width", SYMBOL_INDEX (Qbottom_divider_width)},
3528 {"menu-bar-lines", SYMBOL_INDEX (Qmenu_bar_lines)},
3529 {"mouse-color", SYMBOL_INDEX (Qmouse_color)},
3530 {"name", SYMBOL_INDEX (Qname)},
3531 {"scroll-bar-width", SYMBOL_INDEX (Qscroll_bar_width)},
3532 {"scroll-bar-height", SYMBOL_INDEX (Qscroll_bar_height)},
3533 {"title", SYMBOL_INDEX (Qtitle)},
3534 {"unsplittable", SYMBOL_INDEX (Qunsplittable)},
3535 {"vertical-scroll-bars", SYMBOL_INDEX (Qvertical_scroll_bars)},
3536 {"horizontal-scroll-bars", SYMBOL_INDEX (Qhorizontal_scroll_bars)},
3537 {"visibility", SYMBOL_INDEX (Qvisibility)},
3538 {"tool-bar-lines", SYMBOL_INDEX (Qtool_bar_lines)},
3539 {"scroll-bar-foreground", SYMBOL_INDEX (Qscroll_bar_foreground)},
3540 {"scroll-bar-background", SYMBOL_INDEX (Qscroll_bar_background)},
3541 {"screen-gamma", SYMBOL_INDEX (Qscreen_gamma)},
3542 {"line-spacing", SYMBOL_INDEX (Qline_spacing)},
3543 {"left-fringe", SYMBOL_INDEX (Qleft_fringe)},
3544 {"right-fringe", SYMBOL_INDEX (Qright_fringe)},
3545 {"wait-for-wm", SYMBOL_INDEX (Qwait_for_wm)},
3546 {"fullscreen", SYMBOL_INDEX (Qfullscreen)},
3547 {"font-backend", SYMBOL_INDEX (Qfont_backend)},
3548 {"alpha", SYMBOL_INDEX (Qalpha)},
3549 {"sticky", SYMBOL_INDEX (Qsticky)},
3550 {"tool-bar-position", SYMBOL_INDEX (Qtool_bar_position)},
3551 {"inhibit-double-buffering", SYMBOL_INDEX (Qinhibit_double_buffering)},
3552 {"undecorated", SYMBOL_INDEX (Qundecorated)},
3553 {"parent-frame", SYMBOL_INDEX (Qparent_frame)},
3554 {"skip-taskbar", SYMBOL_INDEX (Qskip_taskbar)},
3555 {"no-focus-on-map", SYMBOL_INDEX (Qno_focus_on_map)},
3556 {"no-accept-focus", SYMBOL_INDEX (Qno_accept_focus)},
3557 {"z-group", SYMBOL_INDEX (Qz_group)},
3558 {"override-redirect", SYMBOL_INDEX (Qoverride_redirect)},
3559 {"no-special-glyphs", SYMBOL_INDEX (Qno_special_glyphs)},
3560 #ifdef NS_IMPL_COCOA
3561 {"ns-appearance", SYMBOL_INDEX (Qns_appearance)},
3562 {"ns-transparent-titlebar", SYMBOL_INDEX (Qns_transparent_titlebar)},
3563 #endif
3566 #ifdef HAVE_WINDOW_SYSTEM
3568 /* Enumeration type for switch in frame_float. */
3569 enum frame_float_type
3571 FRAME_FLOAT_WIDTH,
3572 FRAME_FLOAT_HEIGHT,
3573 FRAME_FLOAT_LEFT,
3574 FRAME_FLOAT_TOP
3578 * frame_float:
3580 * Process the value VAL of the float type frame parameter 'width',
3581 * 'height', 'left', or 'top' specified via a frame_float_type
3582 * enumeration type WHAT for frame F. Such parameters relate the outer
3583 * size or position of F to the size of the F's display or parent frame
3584 * which have to be both available in some way.
3586 * The return value is a size or position value in pixels. VAL must be
3587 * in the range 0.0 to 1.0 where a width/height of 0.0 means to return 0
3588 * and 1.0 means to return the full width/height of the display/parent.
3589 * For positions, 0.0 means position in the left/top corner of the
3590 * display/parent while 1.0 means to position at the right/bottom corner
3591 * of the display/parent frame.
3593 * Set PARENT_DONE and OUTER_DONE to avoid recalculation of the outer
3594 * size or parent or display attributes when more float parameters are
3595 * calculated in a row: -1 means not processed yet, 0 means processing
3596 * failed, 1 means processing succeeded.
3598 * Return DEFAULT_VALUE when processing fails for whatever reason with
3599 * one exception: When calculating F's outer edges fails (probably
3600 * because F has not been created yet) return the difference between F's
3601 * native and text size.
3603 static int
3604 frame_float (struct frame *f, Lisp_Object val, enum frame_float_type what,
3605 int *parent_done, int *outer_done, int default_value)
3607 double d_val = XFLOAT_DATA (val);
3609 if (d_val < 0.0 || d_val > 1.0)
3610 /* Invalid VAL. */
3611 return default_value;
3612 else
3614 static unsigned parent_width, parent_height;
3615 static int parent_left, parent_top;
3616 static unsigned outer_minus_text_width, outer_minus_text_height;
3617 struct frame *p = FRAME_PARENT_FRAME (f);
3619 if (*parent_done == 1)
3621 else if (p)
3623 parent_width = FRAME_PIXEL_WIDTH (p);
3624 parent_height = FRAME_PIXEL_HEIGHT (p);
3625 *parent_done = 1;
3627 else
3629 if (*parent_done == 0)
3630 /* No workarea available. */
3631 return default_value;
3632 else if (*parent_done == -1)
3634 Lisp_Object monitor_attributes;
3635 Lisp_Object workarea;
3636 Lisp_Object frame;
3638 XSETFRAME (frame, f);
3639 monitor_attributes = Fcar (call1 (Qdisplay_monitor_attributes_list, frame));
3640 if (NILP (monitor_attributes))
3642 /* No monitor attributes available. */
3643 *parent_done = 0;
3645 return default_value;
3648 workarea = Fcdr (Fassq (Qworkarea, monitor_attributes));
3649 if (NILP (workarea))
3651 /* No workarea available. */
3652 *parent_done = 0;
3654 return default_value;
3657 /* Workarea available. */
3658 parent_left = XINT (Fnth (make_number (0), workarea));
3659 parent_top = XINT (Fnth (make_number (1), workarea));
3660 parent_width = XINT (Fnth (make_number (2), workarea));
3661 parent_height = XINT (Fnth (make_number (3), workarea));
3662 *parent_done = 1;
3666 if (*outer_done == 1)
3668 else if (FRAME_UNDECORATED (f))
3670 outer_minus_text_width
3671 = FRAME_PIXEL_WIDTH (f) - FRAME_TEXT_WIDTH (f);
3672 outer_minus_text_height
3673 = FRAME_PIXEL_HEIGHT (f) - FRAME_TEXT_HEIGHT (f);
3674 *outer_done = 1;
3676 else if (*outer_done == 0)
3677 /* No outer size available. */
3678 return default_value;
3679 else if (*outer_done == -1)
3681 Lisp_Object frame, outer_edges;
3683 XSETFRAME (frame, f);
3684 outer_edges = call2 (Qframe_edges, frame, Qouter_edges);
3686 if (!NILP (outer_edges))
3688 outer_minus_text_width
3689 = (XINT (Fnth (make_number (2), outer_edges))
3690 - XINT (Fnth (make_number (0), outer_edges))
3691 - FRAME_TEXT_WIDTH (f));
3692 outer_minus_text_height
3693 = (XINT (Fnth (make_number (3), outer_edges))
3694 - XINT (Fnth (make_number (1), outer_edges))
3695 - FRAME_TEXT_HEIGHT (f));
3697 else
3699 /* If we can't get any outer edges, proceed as if the frame
3700 were undecorated. */
3701 outer_minus_text_width
3702 = FRAME_PIXEL_WIDTH (f) - FRAME_TEXT_WIDTH (f);
3703 outer_minus_text_height
3704 = FRAME_PIXEL_HEIGHT (f) - FRAME_TEXT_HEIGHT (f);
3707 *outer_done = 1;
3710 switch (what)
3712 case FRAME_FLOAT_WIDTH:
3713 return parent_width * d_val - outer_minus_text_width;
3715 case FRAME_FLOAT_HEIGHT:
3716 return parent_height * d_val - outer_minus_text_height;
3718 case FRAME_FLOAT_LEFT:
3720 int rest_width = (parent_width
3721 - FRAME_TEXT_WIDTH (f)
3722 - outer_minus_text_width);
3724 if (p)
3725 return (rest_width <= 0 ? 0 : d_val * rest_width);
3726 else
3727 return (rest_width <= 0
3728 ? parent_left
3729 : parent_left + d_val * rest_width);
3731 case FRAME_FLOAT_TOP:
3733 int rest_height = (parent_height
3734 - FRAME_TEXT_HEIGHT (f)
3735 - outer_minus_text_height);
3737 if (p)
3738 return (rest_height <= 0 ? 0 : d_val * rest_height);
3739 else
3740 return (rest_height <= 0
3741 ? parent_top
3742 : parent_top + d_val * rest_height);
3744 default:
3745 emacs_abort ();
3750 /* Change the parameters of frame F as specified by ALIST.
3751 If a parameter is not specially recognized, do nothing special;
3752 otherwise call the `x_set_...' function for that parameter.
3753 Except for certain geometry properties, always call store_frame_param
3754 to store the new value in the parameter alist. */
3756 void
3757 x_set_frame_parameters (struct frame *f, Lisp_Object alist)
3759 Lisp_Object tail, frame;
3762 /* If both of these parameters are present, it's more efficient to
3763 set them both at once. So we wait until we've looked at the
3764 entire list before we set them. */
3765 int width = -1, height = -1; /* -1 denotes they were not changed. */
3767 /* Same here. */
3768 Lisp_Object left, top;
3770 /* Same with these. */
3771 Lisp_Object icon_left, icon_top;
3773 /* And with this. */
3774 Lisp_Object fullscreen;
3775 bool fullscreen_change = false;
3777 /* Record in these vectors all the parms specified. */
3778 Lisp_Object *parms;
3779 Lisp_Object *values;
3780 ptrdiff_t i, j, size;
3781 bool left_no_change = 0, top_no_change = 0;
3782 #ifdef HAVE_X_WINDOWS
3783 bool icon_left_no_change = 0, icon_top_no_change = 0;
3784 #endif
3785 int parent_done = -1, outer_done = -1;
3787 XSETFRAME (frame, f);
3788 for (size = 0, tail = alist; CONSP (tail); tail = XCDR (tail))
3789 size++;
3790 CHECK_LIST_END (tail, alist);
3792 USE_SAFE_ALLOCA;
3793 SAFE_ALLOCA_LISP (parms, 2 * size);
3794 values = parms + size;
3796 /* Extract parm names and values into those vectors. */
3798 i = 0, j = size - 1;
3799 for (tail = alist; CONSP (tail); tail = XCDR (tail))
3801 Lisp_Object elt = XCAR (tail), prop = Fcar (elt), val = Fcdr (elt);
3803 /* Some properties are independent of other properties, but other
3804 properties are dependent upon them. These special properties
3805 are foreground_color, background_color (affects cursor_color)
3806 and font (affects fringe widths); they're recorded starting
3807 from the end of PARMS and VALUES to process them first by using
3808 reverse iteration. */
3810 if (EQ (prop, Qforeground_color)
3811 || EQ (prop, Qbackground_color)
3812 || EQ (prop, Qfont))
3814 parms[j] = prop;
3815 values[j] = val;
3816 j--;
3818 else
3820 parms[i] = prop;
3821 values[i] = val;
3822 i++;
3826 /* TAIL and ALIST are not used again below here. */
3827 alist = tail = Qnil;
3829 top = left = Qunbound;
3830 icon_left = icon_top = Qunbound;
3832 /* Reverse order is used to make sure that special
3833 properties noticed above are processed first. */
3834 for (i = size - 1; i >= 0; i--)
3836 Lisp_Object prop, val;
3838 prop = parms[i];
3839 val = values[i];
3841 if (EQ (prop, Qwidth))
3843 if (RANGED_INTEGERP (0, val, INT_MAX))
3844 width = XFASTINT (val) * FRAME_COLUMN_WIDTH (f) ;
3845 else if (CONSP (val) && EQ (XCAR (val), Qtext_pixels)
3846 && RANGED_INTEGERP (0, XCDR (val), INT_MAX))
3847 width = XFASTINT (XCDR (val));
3848 else if (FLOATP (val))
3849 width = frame_float (f, val, FRAME_FLOAT_WIDTH, &parent_done,
3850 &outer_done, -1);
3852 else if (EQ (prop, Qheight))
3854 if (RANGED_INTEGERP (0, val, INT_MAX))
3855 height = XFASTINT (val) * FRAME_LINE_HEIGHT (f);
3856 else if (CONSP (val) && EQ (XCAR (val), Qtext_pixels)
3857 && RANGED_INTEGERP (0, XCDR (val), INT_MAX))
3858 height = XFASTINT (XCDR (val));
3859 else if (FLOATP (val))
3860 height = frame_float (f, val, FRAME_FLOAT_HEIGHT, &parent_done,
3861 &outer_done, -1);
3863 else if (EQ (prop, Qtop))
3864 top = val;
3865 else if (EQ (prop, Qleft))
3866 left = val;
3867 else if (EQ (prop, Qicon_top))
3868 icon_top = val;
3869 else if (EQ (prop, Qicon_left))
3870 icon_left = val;
3871 else if (EQ (prop, Qfullscreen))
3873 fullscreen = val;
3874 fullscreen_change = true;
3876 else
3878 register Lisp_Object param_index, old_value;
3880 old_value = get_frame_param (f, prop);
3882 store_frame_param (f, prop, val);
3884 param_index = Fget (prop, Qx_frame_parameter);
3885 if (NATNUMP (param_index)
3886 && XFASTINT (param_index) < ARRAYELTS (frame_parms)
3887 && FRAME_RIF (f)->frame_parm_handlers[XINT (param_index)])
3888 (*(FRAME_RIF (f)->frame_parm_handlers[XINT (param_index)])) (f, val, old_value);
3892 /* Don't die if just one of these was set. */
3893 if (EQ (left, Qunbound))
3895 left_no_change = 1;
3896 if (f->left_pos < 0)
3897 left = list2 (Qplus, make_number (f->left_pos));
3898 else
3899 XSETINT (left, f->left_pos);
3901 if (EQ (top, Qunbound))
3903 top_no_change = 1;
3904 if (f->top_pos < 0)
3905 top = list2 (Qplus, make_number (f->top_pos));
3906 else
3907 XSETINT (top, f->top_pos);
3910 /* If one of the icon positions was not set, preserve or default it. */
3911 if (! TYPE_RANGED_INTEGERP (int, icon_left))
3913 #ifdef HAVE_X_WINDOWS
3914 icon_left_no_change = 1;
3915 #endif
3916 icon_left = Fcdr (Fassq (Qicon_left, f->param_alist));
3917 if (NILP (icon_left))
3918 XSETINT (icon_left, 0);
3920 if (! TYPE_RANGED_INTEGERP (int, icon_top))
3922 #ifdef HAVE_X_WINDOWS
3923 icon_top_no_change = 1;
3924 #endif
3925 icon_top = Fcdr (Fassq (Qicon_top, f->param_alist));
3926 if (NILP (icon_top))
3927 XSETINT (icon_top, 0);
3930 /* Don't set these parameters unless they've been explicitly
3931 specified. The window might be mapped or resized while we're in
3932 this function, and we don't want to override that unless the lisp
3933 code has asked for it.
3935 Don't set these parameters unless they actually differ from the
3936 window's current parameters; the window may not actually exist
3937 yet. */
3938 if ((width != -1 && width != FRAME_TEXT_WIDTH (f))
3939 || (height != -1 && height != FRAME_TEXT_HEIGHT (f)))
3940 /* We could consider checking f->after_make_frame here, but I
3941 don't have the faintest idea why the following is needed at
3942 all. With the old setting it can get a Heisenbug when
3943 EmacsFrameResize intermittently provokes a delayed
3944 change_frame_size in the middle of adjust_frame_size. */
3945 /** || (f->can_x_set_window_size && (f->new_height || f->new_width))) **/
3946 adjust_frame_size (f, width, height, 1, 0, Qx_set_frame_parameters);
3948 if ((!NILP (left) || !NILP (top))
3949 && ! (left_no_change && top_no_change)
3950 && ! (NUMBERP (left) && XINT (left) == f->left_pos
3951 && NUMBERP (top) && XINT (top) == f->top_pos))
3953 int leftpos = 0;
3954 int toppos = 0;
3956 /* Record the signs. */
3957 f->size_hint_flags &= ~ (XNegative | YNegative);
3958 if (EQ (left, Qminus))
3959 f->size_hint_flags |= XNegative;
3960 else if (TYPE_RANGED_INTEGERP (int, left))
3962 leftpos = XINT (left);
3963 if (leftpos < 0)
3964 f->size_hint_flags |= XNegative;
3966 else if (CONSP (left) && EQ (XCAR (left), Qminus)
3967 && CONSP (XCDR (left))
3968 && RANGED_INTEGERP (-INT_MAX, XCAR (XCDR (left)), INT_MAX))
3970 leftpos = - XINT (XCAR (XCDR (left)));
3971 f->size_hint_flags |= XNegative;
3973 else if (CONSP (left) && EQ (XCAR (left), Qplus)
3974 && CONSP (XCDR (left))
3975 && TYPE_RANGED_INTEGERP (int, XCAR (XCDR (left))))
3976 leftpos = XINT (XCAR (XCDR (left)));
3977 else if (FLOATP (left))
3978 leftpos = frame_float (f, left, FRAME_FLOAT_LEFT, &parent_done,
3979 &outer_done, 0);
3981 if (EQ (top, Qminus))
3982 f->size_hint_flags |= YNegative;
3983 else if (TYPE_RANGED_INTEGERP (int, top))
3985 toppos = XINT (top);
3986 if (toppos < 0)
3987 f->size_hint_flags |= YNegative;
3989 else if (CONSP (top) && EQ (XCAR (top), Qminus)
3990 && CONSP (XCDR (top))
3991 && RANGED_INTEGERP (-INT_MAX, XCAR (XCDR (top)), INT_MAX))
3993 toppos = - XINT (XCAR (XCDR (top)));
3994 f->size_hint_flags |= YNegative;
3996 else if (CONSP (top) && EQ (XCAR (top), Qplus)
3997 && CONSP (XCDR (top))
3998 && TYPE_RANGED_INTEGERP (int, XCAR (XCDR (top))))
3999 toppos = XINT (XCAR (XCDR (top)));
4000 else if (FLOATP (top))
4001 toppos = frame_float (f, top, FRAME_FLOAT_TOP, &parent_done,
4002 &outer_done, 0);
4004 /* Store the numeric value of the position. */
4005 f->top_pos = toppos;
4006 f->left_pos = leftpos;
4008 f->win_gravity = NorthWestGravity;
4010 /* Actually set that position, and convert to absolute. */
4011 x_set_offset (f, leftpos, toppos, -1);
4014 if (fullscreen_change)
4016 Lisp_Object old_value = get_frame_param (f, Qfullscreen);
4018 frame_size_history_add
4019 (f, Qx_set_fullscreen, 0, 0, list2 (old_value, fullscreen));
4021 store_frame_param (f, Qfullscreen, fullscreen);
4022 if (!EQ (fullscreen, old_value))
4023 x_set_fullscreen (f, fullscreen, old_value);
4027 #ifdef HAVE_X_WINDOWS
4028 if ((!NILP (icon_left) || !NILP (icon_top))
4029 && ! (icon_left_no_change && icon_top_no_change))
4030 x_wm_set_icon_position (f, XINT (icon_left), XINT (icon_top));
4031 #endif /* HAVE_X_WINDOWS */
4033 SAFE_FREE ();
4037 /* Insert a description of internally-recorded parameters of frame X
4038 into the parameter alist *ALISTPTR that is to be given to the user.
4039 Only parameters that are specific to the X window system
4040 and whose values are not correctly recorded in the frame's
4041 param_alist need to be considered here. */
4043 void
4044 x_report_frame_params (struct frame *f, Lisp_Object *alistptr)
4046 Lisp_Object tem;
4047 uprintmax_t w;
4048 char buf[INT_BUFSIZE_BOUND (w)];
4050 /* Represent negative positions (off the top or left screen edge)
4051 in a way that Fmodify_frame_parameters will understand correctly. */
4052 XSETINT (tem, f->left_pos);
4053 if (f->left_pos >= 0)
4054 store_in_alist (alistptr, Qleft, tem);
4055 else
4056 store_in_alist (alistptr, Qleft, list2 (Qplus, tem));
4058 XSETINT (tem, f->top_pos);
4059 if (f->top_pos >= 0)
4060 store_in_alist (alistptr, Qtop, tem);
4061 else
4062 store_in_alist (alistptr, Qtop, list2 (Qplus, tem));
4064 store_in_alist (alistptr, Qborder_width,
4065 make_number (f->border_width));
4066 store_in_alist (alistptr, Qinternal_border_width,
4067 make_number (FRAME_INTERNAL_BORDER_WIDTH (f)));
4068 store_in_alist (alistptr, Qright_divider_width,
4069 make_number (FRAME_RIGHT_DIVIDER_WIDTH (f)));
4070 store_in_alist (alistptr, Qbottom_divider_width,
4071 make_number (FRAME_BOTTOM_DIVIDER_WIDTH (f)));
4072 store_in_alist (alistptr, Qleft_fringe,
4073 make_number (FRAME_LEFT_FRINGE_WIDTH (f)));
4074 store_in_alist (alistptr, Qright_fringe,
4075 make_number (FRAME_RIGHT_FRINGE_WIDTH (f)));
4076 store_in_alist (alistptr, Qscroll_bar_width,
4077 (! FRAME_HAS_VERTICAL_SCROLL_BARS (f)
4078 ? make_number (0)
4079 : FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0
4080 ? make_number (FRAME_CONFIG_SCROLL_BAR_WIDTH (f))
4081 /* nil means "use default width"
4082 for non-toolkit scroll bar.
4083 ruler-mode.el depends on this. */
4084 : Qnil));
4085 store_in_alist (alistptr, Qscroll_bar_height,
4086 (! FRAME_HAS_HORIZONTAL_SCROLL_BARS (f)
4087 ? make_number (0)
4088 : FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) > 0
4089 ? make_number (FRAME_CONFIG_SCROLL_BAR_HEIGHT (f))
4090 /* nil means "use default height"
4091 for non-toolkit scroll bar. */
4092 : Qnil));
4093 /* FRAME_X_WINDOW is not guaranteed to return an integer. E.g., on
4094 MS-Windows it returns a value whose type is HANDLE, which is
4095 actually a pointer. Explicit casting avoids compiler
4096 warnings. */
4097 w = (uintptr_t) FRAME_X_WINDOW (f);
4098 store_in_alist (alistptr, Qwindow_id,
4099 make_formatted_string (buf, "%"pMu, w));
4100 #ifdef HAVE_X_WINDOWS
4101 #ifdef USE_X_TOOLKIT
4102 /* Tooltip frame may not have this widget. */
4103 if (FRAME_X_OUTPUT (f)->widget)
4104 #endif
4105 w = (uintptr_t) FRAME_OUTER_WINDOW (f);
4106 store_in_alist (alistptr, Qouter_window_id,
4107 make_formatted_string (buf, "%"pMu, w));
4108 #endif
4109 store_in_alist (alistptr, Qicon_name, f->icon_name);
4110 store_in_alist (alistptr, Qvisibility,
4111 (FRAME_VISIBLE_P (f) ? Qt
4112 : FRAME_ICONIFIED_P (f) ? Qicon : Qnil));
4113 store_in_alist (alistptr, Qdisplay,
4114 XCAR (FRAME_DISPLAY_INFO (f)->name_list_element));
4116 if (FRAME_X_OUTPUT (f)->parent_desc == FRAME_DISPLAY_INFO (f)->root_window)
4117 tem = Qnil;
4118 else
4119 tem = make_natnum ((uintptr_t) FRAME_X_OUTPUT (f)->parent_desc);
4120 store_in_alist (alistptr, Qexplicit_name, (f->explicit_name ? Qt : Qnil));
4121 store_in_alist (alistptr, Qparent_id, tem);
4122 store_in_alist (alistptr, Qtool_bar_position, FRAME_TOOL_BAR_POSITION (f));
4126 /* Change the `fullscreen' frame parameter of frame F. OLD_VALUE is
4127 the previous value of that parameter, NEW_VALUE is the new value. */
4129 void
4130 x_set_fullscreen (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
4132 if (NILP (new_value))
4133 f->want_fullscreen = FULLSCREEN_NONE;
4134 else if (EQ (new_value, Qfullboth) || EQ (new_value, Qfullscreen))
4135 f->want_fullscreen = FULLSCREEN_BOTH;
4136 else if (EQ (new_value, Qfullwidth))
4137 f->want_fullscreen = FULLSCREEN_WIDTH;
4138 else if (EQ (new_value, Qfullheight))
4139 f->want_fullscreen = FULLSCREEN_HEIGHT;
4140 else if (EQ (new_value, Qmaximized))
4141 f->want_fullscreen = FULLSCREEN_MAXIMIZED;
4143 if (FRAME_TERMINAL (f)->fullscreen_hook != NULL)
4144 FRAME_TERMINAL (f)->fullscreen_hook (f);
4148 /* Change the `line-spacing' frame parameter of frame F. OLD_VALUE is
4149 the previous value of that parameter, NEW_VALUE is the new value. */
4151 void
4152 x_set_line_spacing (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
4154 if (NILP (new_value))
4155 f->extra_line_spacing = 0;
4156 else if (RANGED_INTEGERP (0, new_value, INT_MAX))
4157 f->extra_line_spacing = XFASTINT (new_value);
4158 else if (FLOATP (new_value))
4160 int new_spacing = XFLOAT_DATA (new_value) * FRAME_LINE_HEIGHT (f) + 0.5;
4162 if (new_spacing >= 0)
4163 f->extra_line_spacing = new_spacing;
4164 else
4165 signal_error ("Invalid line-spacing", new_value);
4167 else
4168 signal_error ("Invalid line-spacing", new_value);
4169 if (FRAME_VISIBLE_P (f))
4170 redraw_frame (f);
4174 /* Change the `screen-gamma' frame parameter of frame F. OLD_VALUE is
4175 the previous value of that parameter, NEW_VALUE is the new value. */
4177 void
4178 x_set_screen_gamma (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
4180 Lisp_Object bgcolor;
4182 if (NILP (new_value))
4183 f->gamma = 0;
4184 else if (NUMBERP (new_value) && XFLOATINT (new_value) > 0)
4185 /* The value 0.4545 is the normal viewing gamma. */
4186 f->gamma = 1.0 / (0.4545 * XFLOATINT (new_value));
4187 else
4188 signal_error ("Invalid screen-gamma", new_value);
4190 /* Apply the new gamma value to the frame background. */
4191 bgcolor = Fassq (Qbackground_color, f->param_alist);
4192 if (CONSP (bgcolor) && (bgcolor = XCDR (bgcolor), STRINGP (bgcolor)))
4194 Lisp_Object parm_index = Fget (Qbackground_color, Qx_frame_parameter);
4195 if (NATNUMP (parm_index)
4196 && XFASTINT (parm_index) < ARRAYELTS (frame_parms)
4197 && FRAME_RIF (f)->frame_parm_handlers[XFASTINT (parm_index)])
4198 (*FRAME_RIF (f)->frame_parm_handlers[XFASTINT (parm_index)])
4199 (f, bgcolor, Qnil);
4202 clear_face_cache (true); /* FIXME: Why of all frames? */
4203 fset_redisplay (f);
4207 void
4208 x_set_font (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4210 Lisp_Object font_object;
4211 int fontset = -1;
4212 #ifdef HAVE_X_WINDOWS
4213 Lisp_Object font_param = arg;
4214 #endif
4216 /* Set the frame parameter back to the old value because we may
4217 fail to use ARG as the new parameter value. */
4218 store_frame_param (f, Qfont, oldval);
4220 /* ARG is a fontset name, a font name, a cons of fontset name and a
4221 font object, or a font object. In the last case, this function
4222 never fail. */
4223 if (STRINGP (arg))
4225 fontset = fs_query_fontset (arg, 0);
4226 if (fontset < 0)
4228 font_object = font_open_by_name (f, arg);
4229 if (NILP (font_object))
4230 error ("Font `%s' is not defined", SSDATA (arg));
4231 arg = AREF (font_object, FONT_NAME_INDEX);
4233 else if (fontset > 0)
4235 font_object = font_open_by_name (f, fontset_ascii (fontset));
4236 if (NILP (font_object))
4237 error ("Font `%s' is not defined", SDATA (arg));
4238 arg = AREF (font_object, FONT_NAME_INDEX);
4240 else
4241 error ("The default fontset can't be used for a frame font");
4243 else if (CONSP (arg) && STRINGP (XCAR (arg)) && FONT_OBJECT_P (XCDR (arg)))
4245 /* This is the case that the ASCII font of F's fontset XCAR
4246 (arg) is changed to the font XCDR (arg) by
4247 `set-fontset-font'. */
4248 fontset = fs_query_fontset (XCAR (arg), 0);
4249 if (fontset < 0)
4250 error ("Unknown fontset: %s", SDATA (XCAR (arg)));
4251 font_object = XCDR (arg);
4252 arg = AREF (font_object, FONT_NAME_INDEX);
4253 #ifdef HAVE_X_WINDOWS
4254 font_param = Ffont_get (font_object, QCname);
4255 #endif
4257 else if (FONT_OBJECT_P (arg))
4259 font_object = arg;
4260 #ifdef HAVE_X_WINDOWS
4261 font_param = Ffont_get (font_object, QCname);
4262 #endif
4263 /* This is to store the XLFD font name in the frame parameter for
4264 backward compatibility. We should store the font-object
4265 itself in the future. */
4266 arg = AREF (font_object, FONT_NAME_INDEX);
4267 fontset = FRAME_FONTSET (f);
4268 /* Check if we can use the current fontset. If not, set FONTSET
4269 to -1 to generate a new fontset from FONT-OBJECT. */
4270 if (fontset >= 0)
4272 Lisp_Object ascii_font = fontset_ascii (fontset);
4273 Lisp_Object spec = font_spec_from_name (ascii_font);
4275 /* SPEC might be nil because ASCII_FONT's name doesn't parse
4276 according to stupid XLFD rules, which, for example,
4277 disallow font names that include a dash followed by a
4278 number. So in those cases we simply request x_new_font
4279 below to generate a new fontset. */
4280 if (NILP (spec) || ! font_match_p (spec, font_object))
4281 fontset = -1;
4284 else
4285 signal_error ("Invalid font", arg);
4287 if (! NILP (Fequal (font_object, oldval)))
4288 return;
4290 x_new_font (f, font_object, fontset);
4291 store_frame_param (f, Qfont, arg);
4292 #ifdef HAVE_X_WINDOWS
4293 store_frame_param (f, Qfont_parameter, font_param);
4294 #endif
4295 /* Recalculate toolbar height. */
4296 f->n_tool_bar_rows = 0;
4298 /* Ensure we redraw it. */
4299 clear_current_matrices (f);
4301 /* Attempt to hunt down bug#16028. */
4302 SET_FRAME_GARBAGED (f);
4304 /* This is important if we are called by some Lisp as part of
4305 redisplaying the frame, see redisplay_internal. */
4306 f->fonts_changed = true;
4308 recompute_basic_faces (f);
4310 do_pending_window_change (0);
4312 /* We used to call face-set-after-frame-default here, but it leads to
4313 recursive calls (since that function can set the `default' face's
4314 font which in turns changes the frame's `font' parameter).
4315 Also I don't know what this call is meant to do, but it seems the
4316 wrong way to do it anyway (it does a lot more work than what seems
4317 reasonable in response to a change to `font'). */
4321 void
4322 x_set_font_backend (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
4324 if (! NILP (new_value)
4325 && !CONSP (new_value))
4327 char *p0, *p1;
4329 CHECK_STRING (new_value);
4330 p0 = p1 = SSDATA (new_value);
4331 new_value = Qnil;
4332 while (*p0)
4334 while (*p1 && ! c_isspace (*p1) && *p1 != ',') p1++;
4335 if (p0 < p1)
4336 new_value = Fcons (Fintern (make_string (p0, p1 - p0), Qnil),
4337 new_value);
4338 if (*p1)
4340 int c;
4342 while ((c = *++p1) && c_isspace (c));
4344 p0 = p1;
4346 new_value = Fnreverse (new_value);
4349 if (! NILP (old_value) && ! NILP (Fequal (old_value, new_value)))
4350 return;
4352 if (FRAME_FONT (f))
4353 free_all_realized_faces (Qnil);
4355 new_value = font_update_drivers (f, NILP (new_value) ? Qt : new_value);
4356 if (NILP (new_value))
4358 if (NILP (old_value))
4359 error ("No font backend available");
4360 font_update_drivers (f, old_value);
4361 error ("None of specified font backends are available");
4363 store_frame_param (f, Qfont_backend, new_value);
4365 if (FRAME_FONT (f))
4367 Lisp_Object frame;
4369 XSETFRAME (frame, f);
4370 x_set_font (f, Fframe_parameter (frame, Qfont), Qnil);
4371 face_change = true;
4372 windows_or_buffers_changed = 18;
4376 void
4377 x_set_left_fringe (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
4379 int unit = FRAME_COLUMN_WIDTH (f);
4380 int old_width = FRAME_LEFT_FRINGE_WIDTH (f);
4381 int new_width;
4383 new_width = (RANGED_INTEGERP (-INT_MAX, new_value, INT_MAX)
4384 ? eabs (XINT (new_value)) : 8);
4386 if (new_width != old_width)
4388 f->left_fringe_width = new_width;
4389 f->fringe_cols /* Round up. */
4390 = (new_width + FRAME_RIGHT_FRINGE_WIDTH (f) + unit - 1) / unit;
4392 if (FRAME_X_WINDOW (f) != 0)
4393 adjust_frame_size (f, -1, -1, 3, 0, Qleft_fringe);
4395 SET_FRAME_GARBAGED (f);
4400 void
4401 x_set_right_fringe (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
4403 int unit = FRAME_COLUMN_WIDTH (f);
4404 int old_width = FRAME_RIGHT_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->right_fringe_width = new_width;
4413 f->fringe_cols /* Round up. */
4414 = (new_width + FRAME_LEFT_FRINGE_WIDTH (f) + unit - 1) / unit;
4416 if (FRAME_X_WINDOW (f) != 0)
4417 adjust_frame_size (f, -1, -1, 3, 0, Qright_fringe);
4419 SET_FRAME_GARBAGED (f);
4424 void
4425 x_set_border_width (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4427 CHECK_TYPE_RANGED_INTEGER (int, arg);
4429 if (XINT (arg) == f->border_width)
4430 return;
4432 if (FRAME_X_WINDOW (f) != 0)
4433 error ("Cannot change the border width of a frame");
4435 f->border_width = XINT (arg);
4438 void
4439 x_set_right_divider_width (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4441 int old = FRAME_RIGHT_DIVIDER_WIDTH (f);
4442 CHECK_TYPE_RANGED_INTEGER (int, arg);
4443 int new = max (0, XINT (arg));
4444 if (new != old)
4446 f->right_divider_width = new;
4447 adjust_frame_size (f, -1, -1, 4, 0, Qright_divider_width);
4448 adjust_frame_glyphs (f);
4449 SET_FRAME_GARBAGED (f);
4453 void
4454 x_set_bottom_divider_width (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4456 int old = FRAME_BOTTOM_DIVIDER_WIDTH (f);
4457 CHECK_TYPE_RANGED_INTEGER (int, arg);
4458 int new = max (0, XINT (arg));
4459 if (new != old)
4461 f->bottom_divider_width = new;
4462 adjust_frame_size (f, -1, -1, 4, 0, Qbottom_divider_width);
4463 adjust_frame_glyphs (f);
4464 SET_FRAME_GARBAGED (f);
4468 void
4469 x_set_visibility (struct frame *f, Lisp_Object value, Lisp_Object oldval)
4471 Lisp_Object frame;
4472 XSETFRAME (frame, f);
4474 if (NILP (value))
4475 Fmake_frame_invisible (frame, Qt);
4476 else if (EQ (value, Qicon))
4477 Ficonify_frame (frame);
4478 else
4479 Fmake_frame_visible (frame);
4482 void
4483 x_set_autoraise (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4485 f->auto_raise = !EQ (Qnil, arg);
4488 void
4489 x_set_autolower (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4491 f->auto_lower = !EQ (Qnil, arg);
4494 void
4495 x_set_unsplittable (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4497 f->no_split = !NILP (arg);
4500 void
4501 x_set_vertical_scroll_bars (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4503 if ((EQ (arg, Qleft) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f))
4504 || (EQ (arg, Qright) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
4505 || (NILP (arg) && FRAME_HAS_VERTICAL_SCROLL_BARS (f))
4506 || (!NILP (arg) && !FRAME_HAS_VERTICAL_SCROLL_BARS (f)))
4508 FRAME_VERTICAL_SCROLL_BAR_TYPE (f)
4509 = (NILP (arg)
4510 ? vertical_scroll_bar_none
4511 : EQ (Qleft, arg)
4512 ? vertical_scroll_bar_left
4513 : EQ (Qright, arg)
4514 ? vertical_scroll_bar_right
4515 : EQ (Qleft, Vdefault_frame_scroll_bars)
4516 ? vertical_scroll_bar_left
4517 : EQ (Qright, Vdefault_frame_scroll_bars)
4518 ? vertical_scroll_bar_right
4519 : vertical_scroll_bar_none);
4521 /* We set this parameter before creating the X window for the
4522 frame, so we can get the geometry right from the start.
4523 However, if the window hasn't been created yet, we shouldn't
4524 call x_set_window_size. */
4525 if (FRAME_X_WINDOW (f))
4526 adjust_frame_size (f, -1, -1, 3, 0, Qvertical_scroll_bars);
4528 SET_FRAME_GARBAGED (f);
4532 void
4533 x_set_horizontal_scroll_bars (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4535 #if USE_HORIZONTAL_SCROLL_BARS
4536 if ((NILP (arg) && FRAME_HAS_HORIZONTAL_SCROLL_BARS (f))
4537 || (!NILP (arg) && !FRAME_HAS_HORIZONTAL_SCROLL_BARS (f)))
4539 f->horizontal_scroll_bars = NILP (arg) ? false : true;
4541 /* We set this parameter before creating the X window for the
4542 frame, so we can get the geometry right from the start.
4543 However, if the window hasn't been created yet, we shouldn't
4544 call x_set_window_size. */
4545 if (FRAME_X_WINDOW (f))
4546 adjust_frame_size (f, -1, -1, 3, 0, Qhorizontal_scroll_bars);
4548 SET_FRAME_GARBAGED (f);
4550 #endif
4553 void
4554 x_set_scroll_bar_width (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4556 int unit = FRAME_COLUMN_WIDTH (f);
4558 if (NILP (arg))
4560 x_set_scroll_bar_default_width (f);
4562 if (FRAME_X_WINDOW (f))
4563 adjust_frame_size (f, -1, -1, 3, 0, Qscroll_bar_width);
4565 SET_FRAME_GARBAGED (f);
4567 else if (RANGED_INTEGERP (1, arg, INT_MAX)
4568 && XFASTINT (arg) != FRAME_CONFIG_SCROLL_BAR_WIDTH (f))
4570 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = XFASTINT (arg);
4571 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (XFASTINT (arg) + unit - 1) / unit;
4572 if (FRAME_X_WINDOW (f))
4573 adjust_frame_size (f, -1, -1, 3, 0, Qscroll_bar_width);
4575 SET_FRAME_GARBAGED (f);
4578 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.hpos = 0;
4579 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.x = 0;
4582 void
4583 x_set_scroll_bar_height (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4585 #if USE_HORIZONTAL_SCROLL_BARS
4586 int unit = FRAME_LINE_HEIGHT (f);
4588 if (NILP (arg))
4590 x_set_scroll_bar_default_height (f);
4592 if (FRAME_X_WINDOW (f))
4593 adjust_frame_size (f, -1, -1, 3, 0, Qscroll_bar_height);
4595 SET_FRAME_GARBAGED (f);
4597 else if (RANGED_INTEGERP (1, arg, INT_MAX)
4598 && XFASTINT (arg) != FRAME_CONFIG_SCROLL_BAR_HEIGHT (f))
4600 FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) = XFASTINT (arg);
4601 FRAME_CONFIG_SCROLL_BAR_LINES (f) = (XFASTINT (arg) + unit - 1) / unit;
4602 if (FRAME_X_WINDOW (f))
4603 adjust_frame_size (f, -1, -1, 3, 0, Qscroll_bar_height);
4605 SET_FRAME_GARBAGED (f);
4608 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.vpos = 0;
4609 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.y = 0;
4610 #endif
4613 void
4614 x_set_alpha (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
4616 double alpha = 1.0;
4617 double newval[2];
4618 int i;
4619 Lisp_Object item;
4621 for (i = 0; i < 2; i++)
4623 newval[i] = 1.0;
4624 if (CONSP (arg))
4626 item = CAR (arg);
4627 arg = CDR (arg);
4629 else
4630 item = arg;
4632 if (NILP (item))
4633 alpha = - 1.0;
4634 else if (FLOATP (item))
4636 alpha = XFLOAT_DATA (item);
4637 if (! (0 <= alpha && alpha <= 1.0))
4638 args_out_of_range (make_float (0.0), make_float (1.0));
4640 else if (INTEGERP (item))
4642 EMACS_INT ialpha = XINT (item);
4643 if (! (0 <= ialpha && ialpha <= 100))
4644 args_out_of_range (make_number (0), make_number (100));
4645 alpha = ialpha / 100.0;
4647 else
4648 wrong_type_argument (Qnumberp, item);
4649 newval[i] = alpha;
4652 for (i = 0; i < 2; i++)
4653 f->alpha[i] = newval[i];
4655 #if defined (HAVE_X_WINDOWS) || defined (HAVE_NTGUI) || defined (NS_IMPL_COCOA)
4656 block_input ();
4657 x_set_frame_alpha (f);
4658 unblock_input ();
4659 #endif
4661 return;
4666 * x_set_no_special_glyphs:
4668 * Set frame F's `no-special-glyphs' parameter which, if non-nil,
4669 * suppresses the display of truncation and continuation glyphs
4670 * outside fringes.
4672 void
4673 x_set_no_special_glyphs (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
4675 if (!EQ (new_value, old_value))
4676 FRAME_NO_SPECIAL_GLYPHS (f) = !NILP (new_value);
4680 #ifndef HAVE_NS
4682 /* Non-zero if mouse is grabbed on DPYINFO
4683 and we know the frame where it is. */
4685 bool x_mouse_grabbed (Display_Info *dpyinfo)
4687 return (dpyinfo->grabbed
4688 && dpyinfo->last_mouse_frame
4689 && FRAME_LIVE_P (dpyinfo->last_mouse_frame));
4692 /* Re-highlight something with mouse-face properties
4693 on DPYINFO using saved frame and mouse position. */
4695 void
4696 x_redo_mouse_highlight (Display_Info *dpyinfo)
4698 if (dpyinfo->last_mouse_motion_frame
4699 && FRAME_LIVE_P (dpyinfo->last_mouse_motion_frame))
4700 note_mouse_highlight (dpyinfo->last_mouse_motion_frame,
4701 dpyinfo->last_mouse_motion_x,
4702 dpyinfo->last_mouse_motion_y);
4705 #endif /* HAVE_NS */
4707 /* Subroutines of creating an X frame. */
4709 /* Make sure that Vx_resource_name is set to a reasonable value.
4710 Fix it up, or set it to `emacs' if it is too hopeless. */
4712 void
4713 validate_x_resource_name (void)
4715 ptrdiff_t len = 0;
4716 /* Number of valid characters in the resource name. */
4717 ptrdiff_t good_count = 0;
4718 /* Number of invalid characters in the resource name. */
4719 ptrdiff_t bad_count = 0;
4720 Lisp_Object new;
4721 ptrdiff_t i;
4723 if (!STRINGP (Vx_resource_class))
4724 Vx_resource_class = build_string (EMACS_CLASS);
4726 if (STRINGP (Vx_resource_name))
4728 unsigned char *p = SDATA (Vx_resource_name);
4730 len = SBYTES (Vx_resource_name);
4732 /* Only letters, digits, - and _ are valid in resource names.
4733 Count the valid characters and count the invalid ones. */
4734 for (i = 0; i < len; i++)
4736 int c = p[i];
4737 if (! ((c >= 'a' && c <= 'z')
4738 || (c >= 'A' && c <= 'Z')
4739 || (c >= '0' && c <= '9')
4740 || c == '-' || c == '_'))
4741 bad_count++;
4742 else
4743 good_count++;
4746 else
4747 /* Not a string => completely invalid. */
4748 bad_count = 5, good_count = 0;
4750 /* If name is valid already, return. */
4751 if (bad_count == 0)
4752 return;
4754 /* If name is entirely invalid, or nearly so, or is so implausibly
4755 large that alloca might not work, use `emacs'. */
4756 if (good_count < 2 || MAX_ALLOCA - sizeof ".customization" < len)
4758 Vx_resource_name = build_string ("emacs");
4759 return;
4762 /* Name is partly valid. Copy it and replace the invalid characters
4763 with underscores. */
4765 Vx_resource_name = new = Fcopy_sequence (Vx_resource_name);
4767 for (i = 0; i < len; i++)
4769 int c = SREF (new, i);
4770 if (! ((c >= 'a' && c <= 'z')
4771 || (c >= 'A' && c <= 'Z')
4772 || (c >= '0' && c <= '9')
4773 || c == '-' || c == '_'))
4774 SSET (new, i, '_');
4778 /* Get specified attribute from resource database RDB.
4779 See Fx_get_resource below for other parameters. */
4781 static Lisp_Object
4782 xrdb_get_resource (XrmDatabase rdb, Lisp_Object attribute, Lisp_Object class, Lisp_Object component, Lisp_Object subclass)
4784 CHECK_STRING (attribute);
4785 CHECK_STRING (class);
4787 if (!NILP (component))
4788 CHECK_STRING (component);
4789 if (!NILP (subclass))
4790 CHECK_STRING (subclass);
4791 if (NILP (component) != NILP (subclass))
4792 error ("x-get-resource: must specify both COMPONENT and SUBCLASS or neither");
4794 validate_x_resource_name ();
4796 /* Allocate space for the components, the dots which separate them,
4797 and the final '\0'. Make them big enough for the worst case. */
4798 ptrdiff_t name_keysize = (SBYTES (Vx_resource_name)
4799 + (STRINGP (component)
4800 ? SBYTES (component) : 0)
4801 + SBYTES (attribute)
4802 + 3);
4804 ptrdiff_t class_keysize = (SBYTES (Vx_resource_class)
4805 + SBYTES (class)
4806 + (STRINGP (subclass)
4807 ? SBYTES (subclass) : 0)
4808 + 3);
4809 USE_SAFE_ALLOCA;
4810 char *name_key = SAFE_ALLOCA (name_keysize + class_keysize);
4811 char *class_key = name_key + name_keysize;
4813 /* Start with emacs.FRAMENAME for the name (the specific one)
4814 and with `Emacs' for the class key (the general one). */
4815 char *nz = lispstpcpy (name_key, Vx_resource_name);
4816 char *cz = lispstpcpy (class_key, Vx_resource_class);
4818 *cz++ = '.';
4819 cz = lispstpcpy (cz, class);
4821 if (!NILP (component))
4823 *cz++ = '.';
4824 lispstpcpy (cz, subclass);
4826 *nz++ = '.';
4827 nz = lispstpcpy (nz, component);
4830 *nz++ = '.';
4831 lispstpcpy (nz, attribute);
4833 char *value = x_get_string_resource (rdb, name_key, class_key);
4834 SAFE_FREE();
4836 if (value && *value)
4837 return build_string (value);
4838 else
4839 return Qnil;
4843 DEFUN ("x-get-resource", Fx_get_resource, Sx_get_resource, 2, 4, 0,
4844 doc: /* Return the value of ATTRIBUTE, of class CLASS, from the X defaults database.
4845 This uses `INSTANCE.ATTRIBUTE' as the key and `Emacs.CLASS' as the
4846 class, where INSTANCE is the name under which Emacs was invoked, or
4847 the name specified by the `-name' or `-rn' command-line arguments.
4849 The optional arguments COMPONENT and SUBCLASS add to the key and the
4850 class, respectively. You must specify both of them or neither.
4851 If you specify them, the key is `INSTANCE.COMPONENT.ATTRIBUTE'
4852 and the class is `Emacs.CLASS.SUBCLASS'. */)
4853 (Lisp_Object attribute, Lisp_Object class, Lisp_Object component,
4854 Lisp_Object subclass)
4856 check_window_system (NULL);
4858 return xrdb_get_resource (check_x_display_info (Qnil)->xrdb,
4859 attribute, class, component, subclass);
4862 /* Get an X resource, like Fx_get_resource, but for display DPYINFO. */
4864 Lisp_Object
4865 display_x_get_resource (Display_Info *dpyinfo, Lisp_Object attribute,
4866 Lisp_Object class, Lisp_Object component,
4867 Lisp_Object subclass)
4869 return xrdb_get_resource (dpyinfo->xrdb,
4870 attribute, class, component, subclass);
4873 #if defined HAVE_X_WINDOWS && !defined USE_X_TOOLKIT && !defined USE_GTK
4874 /* Used when C code wants a resource value. */
4875 /* Called from oldXMenu/Create.c. */
4876 char *
4877 x_get_resource_string (const char *attribute, const char *class)
4879 char *result;
4880 struct frame *sf = SELECTED_FRAME ();
4881 ptrdiff_t invocation_namelen = SBYTES (Vinvocation_name);
4882 USE_SAFE_ALLOCA;
4884 /* Allocate space for the components, the dots which separate them,
4885 and the final '\0'. */
4886 ptrdiff_t name_keysize = invocation_namelen + strlen (attribute) + 2;
4887 ptrdiff_t class_keysize = sizeof (EMACS_CLASS) - 1 + strlen (class) + 2;
4888 char *name_key = SAFE_ALLOCA (name_keysize + class_keysize);
4889 char *class_key = name_key + name_keysize;
4891 esprintf (name_key, "%s.%s", SSDATA (Vinvocation_name), attribute);
4892 sprintf (class_key, "%s.%s", EMACS_CLASS, class);
4894 result = x_get_string_resource (FRAME_DISPLAY_INFO (sf)->xrdb,
4895 name_key, class_key);
4896 SAFE_FREE ();
4897 return result;
4899 #endif
4901 /* Return the value of parameter PARAM.
4903 First search ALIST, then Vdefault_frame_alist, then the X defaults
4904 database, using ATTRIBUTE as the attribute name and CLASS as its class.
4906 Convert the resource to the type specified by desired_type.
4908 If no default is specified, return Qunbound. If you call
4909 x_get_arg, make sure you deal with Qunbound in a reasonable way,
4910 and don't let it get stored in any Lisp-visible variables! */
4912 Lisp_Object
4913 x_get_arg (Display_Info *dpyinfo, Lisp_Object alist, Lisp_Object param,
4914 const char *attribute, const char *class, enum resource_types type)
4916 Lisp_Object tem;
4918 tem = Fassq (param, alist);
4920 if (!NILP (tem))
4922 /* If we find this parm in ALIST, clear it out
4923 so that it won't be "left over" at the end. */
4924 Lisp_Object tail;
4925 XSETCAR (tem, Qnil);
4926 /* In case the parameter appears more than once in the alist,
4927 clear it out. */
4928 for (tail = alist; CONSP (tail); tail = XCDR (tail))
4929 if (CONSP (XCAR (tail))
4930 && EQ (XCAR (XCAR (tail)), param))
4931 XSETCAR (XCAR (tail), Qnil);
4933 else
4934 tem = Fassq (param, Vdefault_frame_alist);
4936 /* If it wasn't specified in ALIST or the Lisp-level defaults,
4937 look in the X resources. */
4938 if (EQ (tem, Qnil))
4940 if (attribute && dpyinfo)
4942 AUTO_STRING (at, attribute);
4943 AUTO_STRING (cl, class);
4944 tem = display_x_get_resource (dpyinfo, at, cl, Qnil, Qnil);
4946 if (NILP (tem))
4947 return Qunbound;
4949 switch (type)
4951 case RES_TYPE_NUMBER:
4952 return make_number (atoi (SSDATA (tem)));
4954 case RES_TYPE_BOOLEAN_NUMBER:
4955 if (!strcmp (SSDATA (tem), "on")
4956 || !strcmp (SSDATA (tem), "true"))
4957 return make_number (1);
4958 return make_number (atoi (SSDATA (tem)));
4959 break;
4961 case RES_TYPE_FLOAT:
4962 return make_float (atof (SSDATA (tem)));
4964 case RES_TYPE_BOOLEAN:
4965 tem = Fdowncase (tem);
4966 if (!strcmp (SSDATA (tem), "on")
4967 #ifdef HAVE_NS
4968 || !strcmp (SSDATA (tem), "yes")
4969 #endif
4970 || !strcmp (SSDATA (tem), "true"))
4971 return Qt;
4972 else
4973 return Qnil;
4975 case RES_TYPE_STRING:
4976 return tem;
4978 case RES_TYPE_SYMBOL:
4979 /* As a special case, we map the values `true' and `on'
4980 to Qt, and `false' and `off' to Qnil. */
4982 Lisp_Object lower;
4983 lower = Fdowncase (tem);
4984 if (!strcmp (SSDATA (lower), "on")
4985 #ifdef HAVE_NS
4986 || !strcmp (SSDATA (lower), "yes")
4987 #endif
4988 || !strcmp (SSDATA (lower), "true"))
4989 return Qt;
4990 else if (!strcmp (SSDATA (lower), "off")
4991 #ifdef HAVE_NS
4992 || !strcmp (SSDATA (lower), "no")
4993 #endif
4994 || !strcmp (SSDATA (lower), "false"))
4995 return Qnil;
4996 else
4997 return Fintern (tem, Qnil);
5000 default:
5001 emacs_abort ();
5004 else
5005 return Qunbound;
5007 return Fcdr (tem);
5010 static Lisp_Object
5011 x_frame_get_arg (struct frame *f, Lisp_Object alist, Lisp_Object param,
5012 const char *attribute, const char *class,
5013 enum resource_types type)
5015 return x_get_arg (FRAME_DISPLAY_INFO (f),
5016 alist, param, attribute, class, type);
5019 /* Like x_frame_get_arg, but also record the value in f->param_alist. */
5021 Lisp_Object
5022 x_frame_get_and_record_arg (struct frame *f, Lisp_Object alist,
5023 Lisp_Object param,
5024 const char *attribute, const char *class,
5025 enum resource_types type)
5027 Lisp_Object value;
5029 value = x_get_arg (FRAME_DISPLAY_INFO (f), alist, param,
5030 attribute, class, type);
5031 if (! NILP (value) && ! EQ (value, Qunbound))
5032 store_frame_param (f, param, value);
5034 return value;
5038 /* Record in frame F the specified or default value according to ALIST
5039 of the parameter named PROP (a Lisp symbol).
5040 If no value is specified for PROP, look for an X default for XPROP
5041 on the frame named NAME.
5042 If that is not found either, use the value DEFLT. */
5044 Lisp_Object
5045 x_default_parameter (struct frame *f, Lisp_Object alist, Lisp_Object prop,
5046 Lisp_Object deflt, const char *xprop, const char *xclass,
5047 enum resource_types type)
5049 Lisp_Object tem;
5051 tem = x_frame_get_arg (f, alist, prop, xprop, xclass, type);
5052 if (EQ (tem, Qunbound))
5053 tem = deflt;
5054 AUTO_FRAME_ARG (arg, prop, tem);
5055 x_set_frame_parameters (f, arg);
5056 return tem;
5060 #if !defined (HAVE_X_WINDOWS) && defined (NoValue)
5063 * XParseGeometry parses strings of the form
5064 * "=<width>x<height>{+-}<xoffset>{+-}<yoffset>", where
5065 * width, height, xoffset, and yoffset are unsigned integers.
5066 * Example: "=80x24+300-49"
5067 * The equal sign is optional.
5068 * It returns a bitmask that indicates which of the four values
5069 * were actually found in the string. For each value found,
5070 * the corresponding argument is updated; for each value
5071 * not found, the corresponding argument is left unchanged.
5074 static int
5075 XParseGeometry (char *string,
5076 int *x, int *y,
5077 unsigned int *width, unsigned int *height)
5079 int mask = NoValue;
5080 char *strind;
5081 unsigned long tempWidth UNINIT, tempHeight UNINIT;
5082 long int tempX UNINIT, tempY UNINIT;
5083 char *nextCharacter;
5085 if (string == NULL || *string == '\0')
5086 return mask;
5087 if (*string == '=')
5088 string++; /* ignore possible '=' at beg of geometry spec */
5090 strind = string;
5091 if (*strind != '+' && *strind != '-' && *strind != 'x')
5093 tempWidth = strtoul (strind, &nextCharacter, 10);
5094 if (strind == nextCharacter)
5095 return 0;
5096 strind = nextCharacter;
5097 mask |= WidthValue;
5100 if (*strind == 'x' || *strind == 'X')
5102 strind++;
5103 tempHeight = strtoul (strind, &nextCharacter, 10);
5104 if (strind == nextCharacter)
5105 return 0;
5106 strind = nextCharacter;
5107 mask |= HeightValue;
5110 if (*strind == '+' || *strind == '-')
5112 if (*strind == '-')
5113 mask |= XNegative;
5114 tempX = strtol (strind, &nextCharacter, 10);
5115 if (strind == nextCharacter)
5116 return 0;
5117 strind = nextCharacter;
5118 mask |= XValue;
5119 if (*strind == '+' || *strind == '-')
5121 if (*strind == '-')
5122 mask |= YNegative;
5123 tempY = strtol (strind, &nextCharacter, 10);
5124 if (strind == nextCharacter)
5125 return 0;
5126 strind = nextCharacter;
5127 mask |= YValue;
5131 /* If strind isn't at the end of the string then it's an invalid
5132 geometry specification. */
5134 if (*strind != '\0')
5135 return 0;
5137 if (mask & XValue)
5138 *x = clip_to_bounds (INT_MIN, tempX, INT_MAX);
5139 if (mask & YValue)
5140 *y = clip_to_bounds (INT_MIN, tempY, INT_MAX);
5141 if (mask & WidthValue)
5142 *width = min (tempWidth, UINT_MAX);
5143 if (mask & HeightValue)
5144 *height = min (tempHeight, UINT_MAX);
5145 return mask;
5148 #endif /* !defined (HAVE_X_WINDOWS) && defined (NoValue) */
5151 /* NS used to define x-parse-geometry in ns-win.el, but that confused
5152 make-docfile: the documentation string in ns-win.el was used for
5153 x-parse-geometry even in non-NS builds.
5155 With two definitions of x-parse-geometry in this file, various
5156 things still get confused (eg M-x apropos documentation), so that
5157 it is best if the two definitions just share the same doc-string.
5159 DEFUN ("x-parse-geometry", Fx_parse_geometry, Sx_parse_geometry, 1, 1, 0,
5160 doc: /* Parse a display geometry string STRING.
5161 Returns an alist of the form ((top . TOP), (left . LEFT) ... ).
5162 The properties returned may include `top', `left', `height', and `width'.
5163 For X, the value of `left' or `top' may be an integer,
5164 or a list (+ N) meaning N pixels relative to top/left corner,
5165 or a list (- N) meaning -N pixels relative to bottom/right corner.
5166 On Nextstep, this just calls `ns-parse-geometry'. */)
5167 (Lisp_Object string)
5169 int geometry, x, y;
5170 unsigned int width, height;
5171 Lisp_Object result;
5173 CHECK_STRING (string);
5175 #ifdef HAVE_NS
5176 if (strchr (SSDATA (string), ' ') != NULL)
5177 return call1 (Qns_parse_geometry, string);
5178 #endif
5179 geometry = XParseGeometry (SSDATA (string),
5180 &x, &y, &width, &height);
5181 result = Qnil;
5182 if (geometry & XValue)
5184 Lisp_Object element;
5186 if (x >= 0 && (geometry & XNegative))
5187 element = list3 (Qleft, Qminus, make_number (-x));
5188 else if (x < 0 && ! (geometry & XNegative))
5189 element = list3 (Qleft, Qplus, make_number (x));
5190 else
5191 element = Fcons (Qleft, make_number (x));
5192 result = Fcons (element, result);
5195 if (geometry & YValue)
5197 Lisp_Object element;
5199 if (y >= 0 && (geometry & YNegative))
5200 element = list3 (Qtop, Qminus, make_number (-y));
5201 else if (y < 0 && ! (geometry & YNegative))
5202 element = list3 (Qtop, Qplus, make_number (y));
5203 else
5204 element = Fcons (Qtop, make_number (y));
5205 result = Fcons (element, result);
5208 if (geometry & WidthValue)
5209 result = Fcons (Fcons (Qwidth, make_number (width)), result);
5210 if (geometry & HeightValue)
5211 result = Fcons (Fcons (Qheight, make_number (height)), result);
5213 return result;
5217 /* Calculate the desired size and position of frame F.
5218 Return the flags saying which aspects were specified.
5220 Also set the win_gravity and size_hint_flags of F.
5222 Adjust height for toolbar if TOOLBAR_P is 1.
5224 This function does not make the coordinates positive. */
5226 #define DEFAULT_ROWS 36
5227 #define DEFAULT_COLS 80
5229 long
5230 x_figure_window_size (struct frame *f, Lisp_Object parms, bool toolbar_p, int *x_width, int *x_height)
5232 Lisp_Object height, width, user_size, top, left, user_position;
5233 long window_prompting = 0;
5234 Display_Info *dpyinfo = FRAME_DISPLAY_INFO (f);
5235 int parent_done = -1, outer_done = -1;
5237 /* Default values if we fall through.
5238 Actually, if that happens we should get
5239 window manager prompting. */
5240 SET_FRAME_WIDTH (f, DEFAULT_COLS * FRAME_COLUMN_WIDTH (f));
5241 SET_FRAME_COLS (f, DEFAULT_COLS);
5242 SET_FRAME_HEIGHT (f, DEFAULT_ROWS * FRAME_LINE_HEIGHT (f));
5243 SET_FRAME_LINES (f, DEFAULT_ROWS);
5245 /* Window managers expect that if program-specified
5246 positions are not (0,0), they're intentional, not defaults. */
5247 f->top_pos = 0;
5248 f->left_pos = 0;
5250 /* Calculate a tool bar height so that the user gets a text display
5251 area of the size he specified with -g or via .Xdefaults. Later
5252 changes of the tool bar height don't change the frame size. This
5253 is done so that users can create tall Emacs frames without having
5254 to guess how tall the tool bar will get. */
5255 if (toolbar_p && FRAME_TOOL_BAR_LINES (f))
5257 if (frame_default_tool_bar_height)
5258 FRAME_TOOL_BAR_HEIGHT (f) = frame_default_tool_bar_height;
5259 else
5261 int margin, relief;
5263 relief = (tool_bar_button_relief >= 0
5264 ? tool_bar_button_relief
5265 : DEFAULT_TOOL_BAR_BUTTON_RELIEF);
5267 if (RANGED_INTEGERP (1, Vtool_bar_button_margin, INT_MAX))
5268 margin = XFASTINT (Vtool_bar_button_margin);
5269 else if (CONSP (Vtool_bar_button_margin)
5270 && RANGED_INTEGERP (1, XCDR (Vtool_bar_button_margin), INT_MAX))
5271 margin = XFASTINT (XCDR (Vtool_bar_button_margin));
5272 else
5273 margin = 0;
5275 FRAME_TOOL_BAR_HEIGHT (f)
5276 = DEFAULT_TOOL_BAR_IMAGE_HEIGHT + 2 * margin + 2 * relief;
5280 /* Ensure that earlier new_width and new_height settings won't
5281 override what we specify below. */
5282 f->new_width = f->new_height = 0;
5284 height = x_get_arg (dpyinfo, parms, Qheight, 0, 0, RES_TYPE_NUMBER);
5285 width = x_get_arg (dpyinfo, parms, Qwidth, 0, 0, RES_TYPE_NUMBER);
5286 if (!EQ (width, Qunbound) || !EQ (height, Qunbound))
5288 if (!EQ (width, Qunbound))
5290 if (CONSP (width) && EQ (XCAR (width), Qtext_pixels))
5292 CHECK_NUMBER (XCDR (width));
5293 if ((XINT (XCDR (width)) < 0 || XINT (XCDR (width)) > INT_MAX))
5294 xsignal1 (Qargs_out_of_range, XCDR (width));
5296 SET_FRAME_WIDTH (f, XINT (XCDR (width)));
5297 f->inhibit_horizontal_resize = true;
5298 *x_width = XINT (XCDR (width));
5300 else if (FLOATP (width))
5302 double d_width = XFLOAT_DATA (width);
5304 if (d_width < 0.0 || d_width > 1.0)
5305 xsignal1 (Qargs_out_of_range, width);
5306 else
5308 int new_width = frame_float (f, width, FRAME_FLOAT_WIDTH,
5309 &parent_done, &outer_done, -1);
5311 if (new_width > -1)
5312 SET_FRAME_WIDTH (f, new_width);
5315 else
5317 CHECK_NUMBER (width);
5318 if ((XINT (width) < 0 || XINT (width) > INT_MAX))
5319 xsignal1 (Qargs_out_of_range, width);
5321 SET_FRAME_WIDTH (f, XINT (width) * FRAME_COLUMN_WIDTH (f));
5325 if (!EQ (height, Qunbound))
5327 if (CONSP (height) && EQ (XCAR (height), Qtext_pixels))
5329 CHECK_NUMBER (XCDR (height));
5330 if ((XINT (XCDR (height)) < 0 || XINT (XCDR (height)) > INT_MAX))
5331 xsignal1 (Qargs_out_of_range, XCDR (height));
5333 SET_FRAME_HEIGHT (f, XINT (XCDR (height)));
5334 f->inhibit_vertical_resize = true;
5335 *x_height = XINT (XCDR (height));
5337 else if (FLOATP (height))
5339 double d_height = XFLOAT_DATA (height);
5341 if (d_height < 0.0 || d_height > 1.0)
5342 xsignal1 (Qargs_out_of_range, height);
5343 else
5345 int new_height = frame_float (f, height, FRAME_FLOAT_HEIGHT,
5346 &parent_done, &outer_done, -1);
5348 if (new_height > -1)
5349 SET_FRAME_HEIGHT (f, new_height);
5352 else
5354 CHECK_NUMBER (height);
5355 if ((XINT (height) < 0) || (XINT (height) > INT_MAX))
5356 xsignal1 (Qargs_out_of_range, height);
5358 SET_FRAME_HEIGHT (f, XINT (height) * FRAME_LINE_HEIGHT (f));
5362 user_size = x_get_arg (dpyinfo, parms, Quser_size, 0, 0, RES_TYPE_NUMBER);
5363 if (!NILP (user_size) && !EQ (user_size, Qunbound))
5364 window_prompting |= USSize;
5365 else
5366 window_prompting |= PSize;
5369 top = x_get_arg (dpyinfo, parms, Qtop, 0, 0, RES_TYPE_NUMBER);
5370 left = x_get_arg (dpyinfo, parms, Qleft, 0, 0, RES_TYPE_NUMBER);
5371 user_position = x_get_arg (dpyinfo, parms, Quser_position, 0, 0, RES_TYPE_NUMBER);
5372 if (! EQ (top, Qunbound) || ! EQ (left, Qunbound))
5374 if (EQ (top, Qminus))
5376 f->top_pos = 0;
5377 window_prompting |= YNegative;
5379 else if (CONSP (top) && EQ (XCAR (top), Qminus)
5380 && CONSP (XCDR (top))
5381 && RANGED_INTEGERP (-INT_MAX, XCAR (XCDR (top)), INT_MAX))
5383 f->top_pos = - XINT (XCAR (XCDR (top)));
5384 window_prompting |= YNegative;
5386 else if (CONSP (top) && EQ (XCAR (top), Qplus)
5387 && CONSP (XCDR (top))
5388 && TYPE_RANGED_INTEGERP (int, XCAR (XCDR (top))))
5390 f->top_pos = XINT (XCAR (XCDR (top)));
5392 else if (FLOATP (top))
5393 f->top_pos = frame_float (f, top, FRAME_FLOAT_TOP, &parent_done,
5394 &outer_done, 0);
5395 else if (EQ (top, Qunbound))
5396 f->top_pos = 0;
5397 else
5399 CHECK_TYPE_RANGED_INTEGER (int, top);
5400 f->top_pos = XINT (top);
5401 if (f->top_pos < 0)
5402 window_prompting |= YNegative;
5405 if (EQ (left, Qminus))
5407 f->left_pos = 0;
5408 window_prompting |= XNegative;
5410 else if (CONSP (left) && EQ (XCAR (left), Qminus)
5411 && CONSP (XCDR (left))
5412 && RANGED_INTEGERP (-INT_MAX, XCAR (XCDR (left)), INT_MAX))
5414 f->left_pos = - XINT (XCAR (XCDR (left)));
5415 window_prompting |= XNegative;
5417 else if (CONSP (left) && EQ (XCAR (left), Qplus)
5418 && CONSP (XCDR (left))
5419 && TYPE_RANGED_INTEGERP (int, XCAR (XCDR (left))))
5421 f->left_pos = XINT (XCAR (XCDR (left)));
5423 else if (FLOATP (left))
5424 f->left_pos = frame_float (f, left, FRAME_FLOAT_LEFT, &parent_done,
5425 &outer_done, 0);
5426 else if (EQ (left, Qunbound))
5427 f->left_pos = 0;
5428 else
5430 CHECK_TYPE_RANGED_INTEGER (int, left);
5431 f->left_pos = XINT (left);
5432 if (f->left_pos < 0)
5433 window_prompting |= XNegative;
5436 if (!NILP (user_position) && ! EQ (user_position, Qunbound))
5437 window_prompting |= USPosition;
5438 else
5439 window_prompting |= PPosition;
5442 if (window_prompting & XNegative)
5444 if (window_prompting & YNegative)
5445 f->win_gravity = SouthEastGravity;
5446 else
5447 f->win_gravity = NorthEastGravity;
5449 else
5451 if (window_prompting & YNegative)
5452 f->win_gravity = SouthWestGravity;
5453 else
5454 f->win_gravity = NorthWestGravity;
5457 f->size_hint_flags = window_prompting;
5459 return window_prompting;
5464 #endif /* HAVE_WINDOW_SYSTEM */
5466 void
5467 frame_make_pointer_invisible (struct frame *f)
5469 if (! NILP (Vmake_pointer_invisible))
5471 if (f && FRAME_LIVE_P (f) && !f->pointer_invisible
5472 && FRAME_TERMINAL (f)->toggle_invisible_pointer_hook)
5474 f->mouse_moved = 0;
5475 FRAME_TERMINAL (f)->toggle_invisible_pointer_hook (f, 1);
5476 f->pointer_invisible = 1;
5481 void
5482 frame_make_pointer_visible (struct frame *f)
5484 /* We don't check Vmake_pointer_invisible here in case the
5485 pointer was invisible when Vmake_pointer_invisible was set to nil. */
5486 if (f && FRAME_LIVE_P (f) && f->pointer_invisible && f->mouse_moved
5487 && FRAME_TERMINAL (f)->toggle_invisible_pointer_hook)
5489 FRAME_TERMINAL (f)->toggle_invisible_pointer_hook (f, 0);
5490 f->pointer_invisible = 0;
5494 DEFUN ("frame-pointer-visible-p", Fframe_pointer_visible_p,
5495 Sframe_pointer_visible_p, 0, 1, 0,
5496 doc: /* Return t if the mouse pointer displayed on FRAME is visible.
5497 Otherwise it returns nil. FRAME omitted or nil means the
5498 selected frame. This is useful when `make-pointer-invisible' is set. */)
5499 (Lisp_Object frame)
5501 return decode_any_frame (frame)->pointer_invisible ? Qnil : Qt;
5506 /***********************************************************************
5507 Multimonitor data
5508 ***********************************************************************/
5510 #ifdef HAVE_WINDOW_SYSTEM
5512 # if (defined HAVE_NS \
5513 || (!defined USE_GTK && (defined HAVE_XINERAMA || defined HAVE_XRANDR)))
5514 void
5515 free_monitors (struct MonitorInfo *monitors, int n_monitors)
5517 int i;
5518 for (i = 0; i < n_monitors; ++i)
5519 xfree (monitors[i].name);
5520 xfree (monitors);
5522 # endif
5524 Lisp_Object
5525 make_monitor_attribute_list (struct MonitorInfo *monitors,
5526 int n_monitors,
5527 int primary_monitor,
5528 Lisp_Object monitor_frames,
5529 const char *source)
5531 Lisp_Object attributes_list = Qnil;
5532 Lisp_Object primary_monitor_attributes = Qnil;
5533 int i;
5535 for (i = 0; i < n_monitors; ++i)
5537 Lisp_Object geometry, workarea, attributes = Qnil;
5538 struct MonitorInfo *mi = &monitors[i];
5540 if (mi->geom.width == 0) continue;
5542 workarea = list4i (mi->work.x, mi->work.y,
5543 mi->work.width, mi->work.height);
5544 geometry = list4i (mi->geom.x, mi->geom.y,
5545 mi->geom.width, mi->geom.height);
5546 attributes = Fcons (Fcons (Qsource, build_string (source)),
5547 attributes);
5548 attributes = Fcons (Fcons (Qframes, AREF (monitor_frames, i)),
5549 attributes);
5550 attributes = Fcons (Fcons (Qmm_size,
5551 list2i (mi->mm_width, mi->mm_height)),
5552 attributes);
5553 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
5554 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
5555 if (mi->name)
5556 attributes = Fcons (Fcons (Qname, make_string (mi->name,
5557 strlen (mi->name))),
5558 attributes);
5560 if (i == primary_monitor)
5561 primary_monitor_attributes = attributes;
5562 else
5563 attributes_list = Fcons (attributes, attributes_list);
5566 if (!NILP (primary_monitor_attributes))
5567 attributes_list = Fcons (primary_monitor_attributes, attributes_list);
5568 return attributes_list;
5571 #endif /* HAVE_WINDOW_SYSTEM */
5574 /***********************************************************************
5575 Initialization
5576 ***********************************************************************/
5578 void
5579 syms_of_frame (void)
5581 DEFSYM (Qframep, "framep");
5582 DEFSYM (Qframe_live_p, "frame-live-p");
5583 DEFSYM (Qframe_windows_min_size, "frame-windows-min-size");
5584 DEFSYM (Qdisplay_monitor_attributes_list, "display-monitor-attributes-list");
5585 DEFSYM (Qwindow__pixel_to_total, "window--pixel-to-total");
5586 DEFSYM (Qexplicit_name, "explicit-name");
5587 DEFSYM (Qheight, "height");
5588 DEFSYM (Qicon, "icon");
5589 DEFSYM (Qminibuffer, "minibuffer");
5590 DEFSYM (Qundecorated, "undecorated");
5591 DEFSYM (Qno_special_glyphs, "no-special-glyphs");
5592 DEFSYM (Qparent_frame, "parent-frame");
5593 DEFSYM (Qskip_taskbar, "skip-taskbar");
5594 DEFSYM (Qno_focus_on_map, "no-focus-on-map");
5595 DEFSYM (Qno_accept_focus, "no-accept-focus");
5596 DEFSYM (Qz_group, "z-group");
5597 DEFSYM (Qoverride_redirect, "override-redirect");
5598 DEFSYM (Qdelete_before, "delete-before");
5599 DEFSYM (Qmodeline, "modeline");
5600 DEFSYM (Qonly, "only");
5601 DEFSYM (Qnone, "none");
5602 DEFSYM (Qwidth, "width");
5603 DEFSYM (Qtext_pixels, "text-pixels");
5604 DEFSYM (Qgeometry, "geometry");
5605 DEFSYM (Qicon_left, "icon-left");
5606 DEFSYM (Qicon_top, "icon-top");
5607 DEFSYM (Qtooltip, "tooltip");
5608 DEFSYM (Quser_position, "user-position");
5609 DEFSYM (Quser_size, "user-size");
5610 DEFSYM (Qwindow_id, "window-id");
5611 #ifdef HAVE_X_WINDOWS
5612 DEFSYM (Qouter_window_id, "outer-window-id");
5613 #endif
5614 DEFSYM (Qparent_id, "parent-id");
5615 DEFSYM (Qx, "x");
5616 DEFSYM (Qw32, "w32");
5617 DEFSYM (Qpc, "pc");
5618 DEFSYM (Qns, "ns");
5619 DEFSYM (Qvisible, "visible");
5620 DEFSYM (Qbuffer_predicate, "buffer-predicate");
5621 DEFSYM (Qbuffer_list, "buffer-list");
5622 DEFSYM (Qburied_buffer_list, "buried-buffer-list");
5623 DEFSYM (Qdisplay_type, "display-type");
5624 DEFSYM (Qbackground_mode, "background-mode");
5625 DEFSYM (Qnoelisp, "noelisp");
5626 DEFSYM (Qtty_color_mode, "tty-color-mode");
5627 DEFSYM (Qtty, "tty");
5628 DEFSYM (Qtty_type, "tty-type");
5630 DEFSYM (Qface_set_after_frame_default, "face-set-after-frame-default");
5632 DEFSYM (Qfullwidth, "fullwidth");
5633 DEFSYM (Qfullheight, "fullheight");
5634 DEFSYM (Qfullboth, "fullboth");
5635 DEFSYM (Qmaximized, "maximized");
5636 DEFSYM (Qx_resource_name, "x-resource-name");
5637 DEFSYM (Qx_frame_parameter, "x-frame-parameter");
5639 DEFSYM (Qworkarea, "workarea");
5640 DEFSYM (Qmm_size, "mm-size");
5641 DEFSYM (Qframes, "frames");
5642 DEFSYM (Qsource, "source");
5644 DEFSYM (Qframe_edges, "frame-edges");
5645 DEFSYM (Qouter_edges, "outer-edges");
5646 DEFSYM (Qouter_position, "outer-position");
5647 DEFSYM (Qouter_size, "outer-size");
5648 DEFSYM (Qnative_edges, "native-edges");
5649 DEFSYM (Qinner_edges, "inner-edges");
5650 DEFSYM (Qexternal_border_size, "external-border-size");
5651 DEFSYM (Qtitle_bar_size, "title-bar-size");
5652 DEFSYM (Qmenu_bar_external, "menu-bar-external");
5653 DEFSYM (Qmenu_bar_size, "menu-bar-size");
5654 DEFSYM (Qtool_bar_external, "tool-bar-external");
5655 DEFSYM (Qtool_bar_size, "tool-bar-size");
5656 /* The following are used for frame_size_history. */
5657 DEFSYM (Qadjust_frame_size_1, "adjust-frame-size-1");
5658 DEFSYM (Qadjust_frame_size_2, "adjust-frame-size-2");
5659 DEFSYM (Qadjust_frame_size_3, "adjust-frame-size-3");
5660 DEFSYM (Qx_set_frame_parameters, "x-set-frame-parameters");
5661 DEFSYM (QEmacsFrameResize, "EmacsFrameResize");
5662 DEFSYM (Qset_frame_size, "set-frame-size");
5663 DEFSYM (Qframe_inhibit_resize, "frame-inhibit-resize");
5664 DEFSYM (Qx_set_fullscreen, "x-set-fullscreen");
5665 DEFSYM (Qx_check_fullscreen, "x-check-fullscreen");
5666 DEFSYM (Qxg_frame_resized, "xg-frame-resized");
5667 DEFSYM (Qxg_frame_set_char_size_1, "xg-frame-set-char-size-1");
5668 DEFSYM (Qxg_frame_set_char_size_2, "xg-frame-set-char-size-2");
5669 DEFSYM (Qxg_frame_set_char_size_3, "xg-frame-set-char-size-3");
5670 DEFSYM (Qx_set_window_size_1, "x-set-window-size-1");
5671 DEFSYM (Qx_set_window_size_2, "x-set-window-size-2");
5672 DEFSYM (Qx_set_window_size_3, "x-set-window-size-3");
5673 DEFSYM (Qxg_change_toolbar_position, "xg-change-toolbar-position");
5674 DEFSYM (Qx_net_wm_state, "x-net-wm-state");
5675 DEFSYM (Qx_handle_net_wm_state, "x-handle-net-wm-state");
5676 DEFSYM (Qtb_size_cb, "tb-size-cb");
5677 DEFSYM (Qupdate_frame_tool_bar, "update-frame-tool-bar");
5678 DEFSYM (Qfree_frame_tool_bar, "free-frame-tool-bar");
5679 DEFSYM (Qx_set_menu_bar_lines, "x-set-menu-bar-lines");
5680 DEFSYM (Qchange_frame_size, "change-frame-size");
5681 DEFSYM (Qxg_frame_set_char_size, "xg-frame-set-char-size");
5682 DEFSYM (Qset_window_configuration, "set-window-configuration");
5683 DEFSYM (Qx_create_frame_1, "x-create-frame-1");
5684 DEFSYM (Qx_create_frame_2, "x-create-frame-2");
5685 DEFSYM (Qterminal_frame, "terminal-frame");
5687 #ifdef HAVE_NS
5688 DEFSYM (Qns_parse_geometry, "ns-parse-geometry");
5689 #endif
5690 #ifdef NS_IMPL_COCOA
5691 DEFSYM (Qns_appearance, "ns-appearance");
5692 DEFSYM (Qns_transparent_titlebar, "ns-transparent-titlebar");
5693 #endif
5695 DEFSYM (Qalpha, "alpha");
5696 DEFSYM (Qauto_lower, "auto-lower");
5697 DEFSYM (Qauto_raise, "auto-raise");
5698 DEFSYM (Qborder_color, "border-color");
5699 DEFSYM (Qborder_width, "border-width");
5700 DEFSYM (Qouter_border_width, "outer-border-width");
5701 DEFSYM (Qbottom_divider_width, "bottom-divider-width");
5702 DEFSYM (Qcursor_color, "cursor-color");
5703 DEFSYM (Qcursor_type, "cursor-type");
5704 DEFSYM (Qfont_backend, "font-backend");
5705 DEFSYM (Qfullscreen, "fullscreen");
5706 DEFSYM (Qhorizontal_scroll_bars, "horizontal-scroll-bars");
5707 DEFSYM (Qicon_name, "icon-name");
5708 DEFSYM (Qicon_type, "icon-type");
5709 DEFSYM (Qinternal_border_width, "internal-border-width");
5710 DEFSYM (Qleft_fringe, "left-fringe");
5711 DEFSYM (Qline_spacing, "line-spacing");
5712 DEFSYM (Qmenu_bar_lines, "menu-bar-lines");
5713 DEFSYM (Qupdate_frame_menubar, "update-frame-menubar");
5714 DEFSYM (Qfree_frame_menubar_1, "free-frame-menubar-1");
5715 DEFSYM (Qfree_frame_menubar_2, "free-frame-menubar-2");
5716 DEFSYM (Qmouse_color, "mouse-color");
5717 DEFSYM (Qname, "name");
5718 DEFSYM (Qright_divider_width, "right-divider-width");
5719 DEFSYM (Qright_fringe, "right-fringe");
5720 DEFSYM (Qscreen_gamma, "screen-gamma");
5721 DEFSYM (Qscroll_bar_background, "scroll-bar-background");
5722 DEFSYM (Qscroll_bar_foreground, "scroll-bar-foreground");
5723 DEFSYM (Qscroll_bar_height, "scroll-bar-height");
5724 DEFSYM (Qscroll_bar_width, "scroll-bar-width");
5725 DEFSYM (Qsticky, "sticky");
5726 DEFSYM (Qtitle, "title");
5727 DEFSYM (Qtool_bar_lines, "tool-bar-lines");
5728 DEFSYM (Qtool_bar_position, "tool-bar-position");
5729 DEFSYM (Qunsplittable, "unsplittable");
5730 DEFSYM (Qvertical_scroll_bars, "vertical-scroll-bars");
5731 DEFSYM (Qvisibility, "visibility");
5732 DEFSYM (Qwait_for_wm, "wait-for-wm");
5733 DEFSYM (Qinhibit_double_buffering, "inhibit-double-buffering");
5734 DEFSYM (Qno_other_frame, "no-other-frame");
5735 DEFSYM (Qbelow, "below");
5736 DEFSYM (Qabove_suspended, "above-suspended");
5737 DEFSYM (Qmin_width, "min-width");
5738 DEFSYM (Qmin_height, "min-height");
5739 DEFSYM (Qmouse_wheel_frame, "mouse-wheel-frame");
5740 DEFSYM (Qkeep_ratio, "keep-ratio");
5741 DEFSYM (Qwidth_only, "width-only");
5742 DEFSYM (Qheight_only, "height-only");
5743 DEFSYM (Qleft_only, "left-only");
5744 DEFSYM (Qtop_only, "top-only");
5745 DEFSYM (Qiconify_top_level, "iconify-top-level");
5746 DEFSYM (Qmake_invisible, "make-invisible");
5749 int i;
5751 for (i = 0; i < ARRAYELTS (frame_parms); i++)
5753 Lisp_Object v = (frame_parms[i].sym < 0
5754 ? intern_c_string (frame_parms[i].name)
5755 : builtin_lisp_symbol (frame_parms[i].sym));
5756 Fput (v, Qx_frame_parameter, make_number (i));
5760 #ifdef HAVE_WINDOW_SYSTEM
5761 DEFVAR_LISP ("x-resource-name", Vx_resource_name,
5762 doc: /* The name Emacs uses to look up X resources.
5763 `x-get-resource' uses this as the first component of the instance name
5764 when requesting resource values.
5765 Emacs initially sets `x-resource-name' to the name under which Emacs
5766 was invoked, or to the value specified with the `-name' or `-rn'
5767 switches, if present.
5769 It may be useful to bind this variable locally around a call
5770 to `x-get-resource'. See also the variable `x-resource-class'. */);
5771 Vx_resource_name = Qnil;
5773 DEFVAR_LISP ("x-resource-class", Vx_resource_class,
5774 doc: /* The class Emacs uses to look up X resources.
5775 `x-get-resource' uses this as the first component of the instance class
5776 when requesting resource values.
5778 Emacs initially sets `x-resource-class' to "Emacs".
5780 Setting this variable permanently is not a reasonable thing to do,
5781 but binding this variable locally around a call to `x-get-resource'
5782 is a reasonable practice. See also the variable `x-resource-name'. */);
5783 Vx_resource_class = build_string (EMACS_CLASS);
5785 DEFVAR_LISP ("frame-alpha-lower-limit", Vframe_alpha_lower_limit,
5786 doc: /* The lower limit of the frame opacity (alpha transparency).
5787 The value should range from 0 (invisible) to 100 (completely opaque).
5788 You can also use a floating number between 0.0 and 1.0. */);
5789 Vframe_alpha_lower_limit = make_number (20);
5790 #endif
5792 DEFVAR_LISP ("default-frame-alist", Vdefault_frame_alist,
5793 doc: /* Alist of default values for frame creation.
5794 These may be set in your init file, like this:
5795 (setq default-frame-alist \\='((width . 80) (height . 55) (menu-bar-lines . 1)))
5796 These override values given in window system configuration data,
5797 including X Windows' defaults database.
5798 For values specific to the first Emacs frame, see `initial-frame-alist'.
5799 For window-system specific values, see `window-system-default-frame-alist'.
5800 For values specific to the separate minibuffer frame, see
5801 `minibuffer-frame-alist'.
5802 The `menu-bar-lines' element of the list controls whether new frames
5803 have menu bars; `menu-bar-mode' works by altering this element.
5804 Setting this variable does not affect existing frames, only new ones. */);
5805 Vdefault_frame_alist = Qnil;
5807 DEFVAR_LISP ("default-frame-scroll-bars", Vdefault_frame_scroll_bars,
5808 doc: /* Default position of vertical scroll bars on this window-system. */);
5809 #ifdef HAVE_WINDOW_SYSTEM
5810 #if defined (HAVE_NTGUI) || defined (NS_IMPL_COCOA) || (defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS))
5811 /* MS-Windows, macOS, and GTK have scroll bars on the right by
5812 default. */
5813 Vdefault_frame_scroll_bars = Qright;
5814 #else
5815 Vdefault_frame_scroll_bars = Qleft;
5816 #endif
5817 #else
5818 Vdefault_frame_scroll_bars = Qnil;
5819 #endif
5821 DEFVAR_BOOL ("scroll-bar-adjust-thumb-portion",
5822 scroll_bar_adjust_thumb_portion_p,
5823 doc: /* Adjust thumb for overscrolling for Gtk+ and MOTIF.
5824 Non-nil means adjust the thumb in the scroll bar so it can be dragged downwards
5825 even if the end of the buffer is shown (i.e. overscrolling).
5826 Set to nil if you want the thumb to be at the bottom when the end of the buffer
5827 is shown. Also, the thumb fills the whole scroll bar when the entire buffer
5828 is visible. In this case you can not overscroll. */);
5829 scroll_bar_adjust_thumb_portion_p = 1;
5831 DEFVAR_LISP ("terminal-frame", Vterminal_frame,
5832 doc: /* The initial frame-object, which represents Emacs's stdout. */);
5834 DEFVAR_LISP ("mouse-position-function", Vmouse_position_function,
5835 doc: /* If non-nil, function to transform normal value of `mouse-position'.
5836 `mouse-position' and `mouse-pixel-position' call this function, passing their
5837 usual return value as argument, and return whatever this function returns.
5838 This abnormal hook exists for the benefit of packages like `xt-mouse.el'
5839 which need to do mouse handling at the Lisp level. */);
5840 Vmouse_position_function = Qnil;
5842 DEFVAR_LISP ("mouse-highlight", Vmouse_highlight,
5843 doc: /* If non-nil, clickable text is highlighted when mouse is over it.
5844 If the value is an integer, highlighting is only shown after moving the
5845 mouse, while keyboard input turns off the highlight even when the mouse
5846 is over the clickable text. However, the mouse shape still indicates
5847 when the mouse is over clickable text. */);
5848 Vmouse_highlight = Qt;
5850 DEFVAR_LISP ("make-pointer-invisible", Vmake_pointer_invisible,
5851 doc: /* If non-nil, make pointer invisible while typing.
5852 The pointer becomes visible again when the mouse is moved. */);
5853 Vmake_pointer_invisible = Qt;
5855 DEFVAR_LISP ("focus-in-hook", Vfocus_in_hook,
5856 doc: /* Normal hook run when a frame gains input focus.
5857 The frame gaining focus is selected at the time this hook is run. */);
5858 Vfocus_in_hook = Qnil;
5860 DEFVAR_LISP ("focus-out-hook", Vfocus_out_hook,
5861 doc: /* Normal hook run when all frames lost input focus. */);
5862 Vfocus_out_hook = Qnil;
5864 DEFVAR_LISP ("move-frame-functions", Vmove_frame_functions,
5865 doc: /* Functions run after a frame was moved.
5866 The functions are run with one arg, the frame that moved. */);
5867 Vmove_frame_functions = Qnil;
5869 DEFVAR_LISP ("delete-frame-functions", Vdelete_frame_functions,
5870 doc: /* Functions run before deleting a frame.
5871 The functions are run with one arg, the frame to be deleted.
5872 See `delete-frame'.
5874 Note that functions in this list may be called just before the frame is
5875 actually deleted, or some time later (or even both when an earlier function
5876 in `delete-frame-functions' (indirectly) calls `delete-frame'
5877 recursively). */);
5878 Vdelete_frame_functions = Qnil;
5879 DEFSYM (Qdelete_frame_functions, "delete-frame-functions");
5881 DEFVAR_LISP ("menu-bar-mode", Vmenu_bar_mode,
5882 doc: /* Non-nil if Menu-Bar mode is enabled.
5883 See the command `menu-bar-mode' for a description of this minor mode.
5884 Setting this variable directly does not take effect;
5885 either customize it (see the info node `Easy Customization')
5886 or call the function `menu-bar-mode'. */);
5887 Vmenu_bar_mode = Qt;
5889 DEFVAR_LISP ("tool-bar-mode", Vtool_bar_mode,
5890 doc: /* Non-nil if Tool-Bar mode is enabled.
5891 See the command `tool-bar-mode' for a description of this minor mode.
5892 Setting this variable directly does not take effect;
5893 either customize it (see the info node `Easy Customization')
5894 or call the function `tool-bar-mode'. */);
5895 #ifdef HAVE_WINDOW_SYSTEM
5896 Vtool_bar_mode = Qt;
5897 #else
5898 Vtool_bar_mode = Qnil;
5899 #endif
5901 DEFVAR_KBOARD ("default-minibuffer-frame", Vdefault_minibuffer_frame,
5902 doc: /* Minibuffer-less frames by default use this frame's minibuffer.
5903 Emacs consults this variable only when creating a minibuffer-less frame
5904 and no explicit minibuffer window has been specified for that frame via
5905 the `minibuffer' frame parameter. Once such a frame has been created,
5906 setting this variable does not change that frame's previous association.
5908 This variable is local to the current terminal and cannot be buffer-local. */);
5910 DEFVAR_LISP ("focus-follows-mouse", focus_follows_mouse,
5911 doc: /* Non-nil if window system changes focus when you move the mouse.
5912 You should set this variable to tell Emacs how your window manager
5913 handles focus, since there is no way in general for Emacs to find out
5914 automatically.
5916 There are three meaningful values:
5918 - The default nil should be used when your window manager follows a
5919 "click-to-focus" policy where you have to click the mouse inside of a
5920 frame in order for that frame to get focus.
5922 - The value t should be used when your window manager has the focus
5923 automatically follow the position of the mouse pointer but a window
5924 that gains focus is not raised automatically.
5926 - The value `auto-raise' should be used when your window manager has the
5927 focus automatically follow the position of the mouse pointer and a
5928 window that gains focus is raised automatically.
5930 If this option is non-nil, Emacs moves the mouse pointer to the frame
5931 selected by `select-frame-set-input-focus'. This function is used by a
5932 number of commands like, for example, `other-frame' and `pop-to-buffer'.
5933 If this option is nil and your focus follows mouse window manager does
5934 not autonomously move the mouse pointer to the newly selected frame, the
5935 previously selected window manager window might get reselected instead
5936 immediately.
5938 The distinction between the values t and `auto-raise' is not needed for
5939 "normal" frames because the window manager takes care of raising them.
5940 Setting this to `auto-raise' will, however, override the standard
5941 behavior of a window manager that does not automatically raise the frame
5942 that gets focus. Setting this to `auto-raise' is also necessary to
5943 automatically raise child frames which are usually left alone by the
5944 window manager.
5946 Note that this option does not distinguish "sloppy" focus (where the
5947 frame that previously had focus retains focus as long as the mouse
5948 pointer does not move into another window manager window) from "strict"
5949 focus (where a frame immediately loses focus when it's left by the mouse
5950 pointer).
5952 In order to extend a "focus follows mouse" policy to individual Emacs
5953 windows, customize the variable `mouse-autoselect-window'. */);
5954 focus_follows_mouse = Qnil;
5956 DEFVAR_BOOL ("frame-resize-pixelwise", frame_resize_pixelwise,
5957 doc: /* Non-nil means resize frames pixelwise.
5958 If this option is nil, resizing a frame rounds its sizes to the frame's
5959 current values of `frame-char-height' and `frame-char-width'. If this
5960 is non-nil, no rounding occurs, hence frame sizes can increase/decrease
5961 by one pixel.
5963 With some window managers you may have to set this to non-nil in order
5964 to set the size of a frame in pixels, to maximize frames or to make them
5965 fullscreen. To resize your initial frame pixelwise, set this option to
5966 a non-nil value in your init file. */);
5967 frame_resize_pixelwise = 0;
5969 DEFVAR_LISP ("frame-inhibit-implied-resize", frame_inhibit_implied_resize,
5970 doc: /* Whether frames should be resized implicitly.
5971 If this option is nil, setting font, menu bar, tool bar, internal
5972 borders, fringes or scroll bars of a specific frame may resize the frame
5973 in order to preserve the number of columns or lines it displays. If
5974 this option is t, no such resizing is done. Note that the size of
5975 fullscreen and maximized frames, the height of fullheight frames and the
5976 width of fullwidth frames never change implicitly.
5978 The value of this option can be also be a list of frame parameters. In
5979 this case, resizing is inhibited when changing a parameter that appears
5980 in that list. The parameters currently handled by this option include
5981 `font', `font-backend', `internal-border-width', `menu-bar-lines' and
5982 `tool-bar-lines'.
5984 Changing any of the parameters `scroll-bar-width', `scroll-bar-height',
5985 `vertical-scroll-bars', `horizontal-scroll-bars', `left-fringe' and
5986 `right-fringe' is handled as if the frame contained just one live
5987 window. This means, for example, that removing vertical scroll bars on
5988 a frame containing several side by side windows will shrink the frame
5989 width by the width of one scroll bar provided this option is nil and
5990 keep it unchanged if this option is either t or a list containing
5991 `vertical-scroll-bars'.
5993 The default value is \\='(tool-bar-lines) on Lucid, Motif and Windows
5994 \(which means that adding/removing a tool bar does not change the frame
5995 height), nil on all other window systems including GTK+ (which means
5996 that changing any of the parameters listed above may change the size of
5997 the frame), and t otherwise (which means the frame size never changes
5998 implicitly when there's no window system support).
6000 Note that when a frame is not large enough to accommodate a change of
6001 any of the parameters listed above, Emacs may try to enlarge the frame
6002 even if this option is non-nil. */);
6003 #if defined (HAVE_WINDOW_SYSTEM)
6004 #if defined (USE_LUCID) || defined (USE_MOTIF) || defined (HAVE_NTGUI)
6005 frame_inhibit_implied_resize = list1 (Qtool_bar_lines);
6006 #else
6007 frame_inhibit_implied_resize = Qnil;
6008 #endif
6009 #else
6010 frame_inhibit_implied_resize = Qt;
6011 #endif
6013 DEFVAR_LISP ("frame-size-history", frame_size_history,
6014 doc: /* History of frame size adjustments.
6015 If non-nil, list recording frame size adjustment. Adjustments are
6016 recorded only if the first element of this list is a positive number.
6017 Adding an adjustment decrements that number by one.
6019 The remaining elements are the adjustments. Each adjustment is a list
6020 of four elements `frame', `function', `sizes' and `more'. `frame' is
6021 the affected frame and `function' the invoking function. `sizes' is
6022 usually a list of four elements `old-width', `old-height', `new-width'
6023 and `new-height' representing the old and new sizes recorded/requested
6024 by `function'. `more' is a list with additional information.
6026 The function `frame--size-history' displays the value of this variable
6027 in a more readable form. */);
6028 frame_size_history = Qnil;
6030 DEFVAR_BOOL ("tooltip-reuse-hidden-frame", tooltip_reuse_hidden_frame,
6031 doc: /* Non-nil means reuse hidden tooltip frames.
6032 When this is nil, delete a tooltip frame when hiding the associated
6033 tooltip. When this is non-nil, make the tooltip frame invisible only,
6034 so it can be reused when the next tooltip is shown.
6036 Setting this to non-nil may drastically reduce the consing overhead
6037 incurred by creating new tooltip frames. However, a value of non-nil
6038 means also that intermittent changes of faces or `default-frame-alist'
6039 are not applied when showing a tooltip in a reused frame.
6041 This variable is effective only with the X toolkit (and there only when
6042 Gtk+ tooltips are not used) and on Windows. */);
6043 tooltip_reuse_hidden_frame = false;
6045 DEFVAR_LISP ("iconify-child-frame", iconify_child_frame,
6046 doc: /* How to handle iconification of child frames.
6047 This variable tells Emacs how to proceed when it is asked to iconify a
6048 child frame. If it is nil, `iconify-frame' will do nothing when invoked
6049 on a child frame. If it is `iconify-top-level', Emacs will try to
6050 iconify the top level frame associated with this child frame instead.
6051 If it is `make-invisible', Emacs will try to make this child frame
6052 invisible instead.
6054 Any other value means to try iconifying the child frame. Since such an
6055 attempt is not honored by all window managers and may even lead to
6056 making the child frame unresponsive to user actions, the default is to
6057 iconify the top level frame instead. */);
6058 iconify_child_frame = Qiconify_top_level;
6060 staticpro (&Vframe_list);
6062 defsubr (&Sframep);
6063 defsubr (&Sframe_live_p);
6064 defsubr (&Swindow_system);
6065 defsubr (&Sframe_windows_min_size);
6066 defsubr (&Smake_terminal_frame);
6067 defsubr (&Shandle_switch_frame);
6068 defsubr (&Sselect_frame);
6069 defsubr (&Sselected_frame);
6070 defsubr (&Sframe_list);
6071 defsubr (&Sframe_parent);
6072 defsubr (&Sframe_ancestor_p);
6073 defsubr (&Snext_frame);
6074 defsubr (&Sprevious_frame);
6075 defsubr (&Slast_nonminibuf_frame);
6076 defsubr (&Sdelete_frame);
6077 defsubr (&Smouse_position);
6078 defsubr (&Smouse_pixel_position);
6079 defsubr (&Sset_mouse_position);
6080 defsubr (&Sset_mouse_pixel_position);
6081 #if 0
6082 defsubr (&Sframe_configuration);
6083 defsubr (&Srestore_frame_configuration);
6084 #endif
6085 defsubr (&Smake_frame_visible);
6086 defsubr (&Smake_frame_invisible);
6087 defsubr (&Siconify_frame);
6088 defsubr (&Sframe_visible_p);
6089 defsubr (&Svisible_frame_list);
6090 defsubr (&Sraise_frame);
6091 defsubr (&Slower_frame);
6092 defsubr (&Sx_focus_frame);
6093 defsubr (&Sframe_after_make_frame);
6094 defsubr (&Sredirect_frame_focus);
6095 defsubr (&Sframe_focus);
6096 defsubr (&Sframe_parameters);
6097 defsubr (&Sframe_parameter);
6098 defsubr (&Smodify_frame_parameters);
6099 defsubr (&Sframe_char_height);
6100 defsubr (&Sframe_char_width);
6101 defsubr (&Sframe_native_height);
6102 defsubr (&Sframe_native_width);
6103 defsubr (&Sframe_text_cols);
6104 defsubr (&Sframe_text_lines);
6105 defsubr (&Sframe_total_cols);
6106 defsubr (&Sframe_total_lines);
6107 defsubr (&Sframe_text_width);
6108 defsubr (&Sframe_text_height);
6109 defsubr (&Sscroll_bar_width);
6110 defsubr (&Sscroll_bar_height);
6111 defsubr (&Sfringe_width);
6112 defsubr (&Sframe_internal_border_width);
6113 defsubr (&Sright_divider_width);
6114 defsubr (&Sbottom_divider_width);
6115 defsubr (&Stool_bar_pixel_width);
6116 defsubr (&Sset_frame_height);
6117 defsubr (&Sset_frame_width);
6118 defsubr (&Sset_frame_size);
6119 defsubr (&Sframe_position);
6120 defsubr (&Sset_frame_position);
6121 defsubr (&Sframe_pointer_visible_p);
6123 #ifdef HAVE_WINDOW_SYSTEM
6124 defsubr (&Sx_get_resource);
6125 defsubr (&Sx_parse_geometry);
6126 #endif