(c-postprocess-file-styles): Declare for compiler.
[bpt/emacs.git] / src / frame.c
... / ...
CommitLineData
1/* Generic frame functions.
2 Copyright (C) 1993, 1994, 1995, 1997, 1999, 2000, 2001, 2002, 2003,
3 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
4
5This file is part of GNU Emacs.
6
7GNU Emacs is free software: you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
9the Free Software Foundation, either version 3 of the License, or
10(at your option) any later version.
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19
20#include <config.h>
21
22#include <stdio.h>
23#include "lisp.h"
24#include "character.h"
25#ifdef HAVE_X_WINDOWS
26#include "xterm.h"
27#endif
28#ifdef WINDOWSNT
29#include "w32term.h"
30#endif
31#ifdef MAC_OS
32#include "macterm.h"
33#endif
34#include "buffer.h"
35/* These help us bind and responding to switch-frame events. */
36#include "commands.h"
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 "font.h"
46#include "fontset.h"
47#endif
48#ifdef MSDOS
49#include "msdos.h"
50#include "dosfns.h"
51#endif
52
53
54#ifdef HAVE_WINDOW_SYSTEM
55
56/* The name we're using in resource queries. Most often "emacs". */
57
58Lisp_Object Vx_resource_name;
59
60/* The application class we're using in resource queries.
61 Normally "Emacs". */
62
63Lisp_Object Vx_resource_class;
64
65#endif
66
67Lisp_Object Qframep, Qframe_live_p;
68Lisp_Object Qicon, Qmodeline;
69Lisp_Object Qonly;
70Lisp_Object Qx, Qw32, Qmac, Qpc;
71Lisp_Object Qvisible;
72Lisp_Object Qdisplay_type;
73Lisp_Object Qbackground_mode;
74Lisp_Object Qnoelisp;
75
76Lisp_Object Qx_frame_parameter;
77Lisp_Object Qx_resource_name;
78Lisp_Object Qterminal;
79Lisp_Object Qterminal_live_p;
80
81/* Frame parameters (set or reported). */
82
83Lisp_Object Qauto_raise, Qauto_lower;
84Lisp_Object Qborder_color, Qborder_width;
85Lisp_Object Qcursor_color, Qcursor_type;
86Lisp_Object Qgeometry; /* Not used */
87Lisp_Object Qheight, Qwidth;
88Lisp_Object Qleft, Qright;
89Lisp_Object Qicon_left, Qicon_top, Qicon_type, Qicon_name;
90Lisp_Object Qinternal_border_width;
91Lisp_Object Qmouse_color;
92Lisp_Object Qminibuffer;
93Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
94Lisp_Object Qvisibility;
95Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
96Lisp_Object Qscreen_gamma;
97Lisp_Object Qline_spacing;
98Lisp_Object Quser_position, Quser_size;
99Lisp_Object Qwait_for_wm;
100Lisp_Object Qwindow_id;
101#ifdef HAVE_X_WINDOWS
102Lisp_Object Qouter_window_id;
103#endif
104Lisp_Object Qparent_id;
105Lisp_Object Qtitle, Qname;
106Lisp_Object Qexplicit_name;
107Lisp_Object Qunsplittable;
108Lisp_Object Qmenu_bar_lines, Qtool_bar_lines;
109Lisp_Object Qleft_fringe, Qright_fringe;
110Lisp_Object Qbuffer_predicate, Qbuffer_list, Qburied_buffer_list;
111Lisp_Object Qtty_color_mode;
112Lisp_Object Qtty, Qtty_type;
113
114Lisp_Object Qfullscreen, Qfullwidth, Qfullheight, Qfullboth;
115Lisp_Object Qfont_backend;
116
117Lisp_Object Qinhibit_face_set_after_frame_default;
118Lisp_Object Qface_set_after_frame_default;
119
120Lisp_Object Vterminal_frame;
121Lisp_Object Vdefault_frame_alist;
122Lisp_Object Vdefault_frame_scroll_bars;
123Lisp_Object Vmouse_position_function;
124Lisp_Object Vmouse_highlight;
125static Lisp_Object Vdelete_frame_functions, Qdelete_frame_functions;
126
127int focus_follows_mouse;
128\f
129static void
130set_menu_bar_lines_1 (window, n)
131 Lisp_Object window;
132 int n;
133{
134 struct window *w = XWINDOW (window);
135
136 XSETFASTINT (w->last_modified, 0);
137 XSETFASTINT (w->top_line, XFASTINT (w->top_line) + n);
138 XSETFASTINT (w->total_lines, XFASTINT (w->total_lines) - n);
139
140 if (INTEGERP (w->orig_top_line))
141 XSETFASTINT (w->orig_top_line, XFASTINT (w->orig_top_line) + n);
142 if (INTEGERP (w->orig_total_lines))
143 XSETFASTINT (w->orig_total_lines, XFASTINT (w->orig_total_lines) - n);
144
145 /* Handle just the top child in a vertical split. */
146 if (!NILP (w->vchild))
147 set_menu_bar_lines_1 (w->vchild, n);
148
149 /* Adjust all children in a horizontal split. */
150 for (window = w->hchild; !NILP (window); window = w->next)
151 {
152 w = XWINDOW (window);
153 set_menu_bar_lines_1 (window, n);
154 }
155}
156
157void
158set_menu_bar_lines (f, value, oldval)
159 struct frame *f;
160 Lisp_Object value, oldval;
161{
162 int nlines;
163 int olines = FRAME_MENU_BAR_LINES (f);
164
165 /* Right now, menu bars don't work properly in minibuf-only frames;
166 most of the commands try to apply themselves to the minibuffer
167 frame itself, and get an error because you can't switch buffers
168 in or split the minibuffer window. */
169 if (FRAME_MINIBUF_ONLY_P (f))
170 return;
171
172 if (INTEGERP (value))
173 nlines = XINT (value);
174 else
175 nlines = 0;
176
177 if (nlines != olines)
178 {
179 windows_or_buffers_changed++;
180 FRAME_WINDOW_SIZES_CHANGED (f) = 1;
181 FRAME_MENU_BAR_LINES (f) = nlines;
182 set_menu_bar_lines_1 (f->root_window, nlines - olines);
183 adjust_glyphs (f);
184 }
185}
186\f
187Lisp_Object Vemacs_iconified;
188Lisp_Object Vframe_list;
189
190extern Lisp_Object Vminibuffer_list;
191extern Lisp_Object get_minibuffer ();
192extern Lisp_Object Fhandle_switch_frame ();
193extern Lisp_Object Fredirect_frame_focus ();
194extern Lisp_Object x_get_focus_frame ();
195\f
196DEFUN ("framep", Fframep, Sframep, 1, 1, 0,
197 doc: /* Return non-nil if OBJECT is a frame.
198Value is t for a termcap frame (a character-only terminal),
199`x' for an Emacs frame that is really an X window,
200`w32' for an Emacs frame that is a window on MS-Windows display,
201`mac' for an Emacs frame on a Macintosh display,
202`pc' for a direct-write MS-DOS frame.
203See also `frame-live-p'. */)
204 (object)
205 Lisp_Object object;
206{
207 if (!FRAMEP (object))
208 return Qnil;
209 switch (XFRAME (object)->output_method)
210 {
211 case output_initial: /* The initial frame is like a termcap frame. */
212 case output_termcap:
213 return Qt;
214 case output_x_window:
215 return Qx;
216 case output_w32:
217 return Qw32;
218 case output_msdos_raw:
219 return Qpc;
220 case output_mac:
221 return Qmac;
222 default:
223 abort ();
224 }
225}
226
227DEFUN ("frame-live-p", Fframe_live_p, Sframe_live_p, 1, 1, 0,
228 doc: /* Return non-nil if OBJECT is a frame which has not been deleted.
229Value is nil if OBJECT is not a live frame. If object is a live
230frame, the return value indicates what sort of terminal device it is
231displayed on. See the documentation of `framep' for possible
232return values. */)
233 (object)
234 Lisp_Object object;
235{
236 return ((FRAMEP (object)
237 && FRAME_LIVE_P (XFRAME (object)))
238 ? Fframep (object)
239 : Qnil);
240}
241
242DEFUN ("window-system", Fwindow_system, Swindow_system, 0, 1, 0,
243 doc: /* The name of the window system that FRAME is displaying through.
244The value is a symbol---for instance, 'x' for X windows.
245The value is nil if Emacs is using a text-only terminal.
246
247FRAME defaults to the currently selected frame. */)
248 (frame)
249 Lisp_Object frame;
250{
251 Lisp_Object type;
252 if (NILP (frame))
253 frame = selected_frame;
254
255 type = Fframep (frame);
256
257 if (NILP (type))
258 wrong_type_argument (Qframep, frame);
259
260 if (EQ (type, Qt))
261 return Qnil;
262 else
263 return type;
264}
265
266struct frame *
267make_frame (mini_p)
268 int mini_p;
269{
270 Lisp_Object frame;
271 register struct frame *f;
272 register Lisp_Object root_window;
273 register Lisp_Object mini_window;
274
275 f = allocate_frame ();
276 XSETFRAME (frame, f);
277
278 f->desired_matrix = 0;
279 f->current_matrix = 0;
280 f->desired_pool = 0;
281 f->current_pool = 0;
282 f->glyphs_initialized_p = 0;
283 f->decode_mode_spec_buffer = 0;
284 f->visible = 0;
285 f->async_visible = 0;
286 f->output_data.nothing = 0;
287 f->iconified = 0;
288 f->async_iconified = 0;
289 f->wants_modeline = 1;
290 f->auto_raise = 0;
291 f->auto_lower = 0;
292 f->no_split = 0;
293 f->garbaged = 1;
294 f->has_minibuffer = mini_p;
295 f->focus_frame = Qnil;
296 f->explicit_name = 0;
297 f->can_have_scroll_bars = 0;
298 f->vertical_scroll_bar_type = vertical_scroll_bar_none;
299 f->param_alist = Qnil;
300 f->scroll_bars = Qnil;
301 f->condemned_scroll_bars = Qnil;
302 f->face_alist = Qnil;
303 f->face_cache = NULL;
304 f->menu_bar_items = Qnil;
305 f->menu_bar_vector = Qnil;
306 f->menu_bar_items_used = 0;
307 f->buffer_predicate = Qnil;
308 f->buffer_list = Qnil;
309 f->buried_buffer_list = Qnil;
310 f->namebuf = 0;
311 f->title = Qnil;
312 f->menu_bar_window = Qnil;
313 f->tool_bar_window = Qnil;
314 f->tool_bar_items = Qnil;
315 f->desired_tool_bar_string = f->current_tool_bar_string = Qnil;
316 f->n_tool_bar_items = 0;
317 f->left_fringe_width = f->right_fringe_width = 0;
318 f->fringe_cols = 0;
319 f->scroll_bar_actual_width = 0;
320 f->border_width = 0;
321 f->internal_border_width = 0;
322 f->column_width = 1; /* !FRAME_WINDOW_P value */
323 f->line_height = 1; /* !FRAME_WINDOW_P value */
324 f->x_pixels_diff = f->y_pixels_diff = 0;
325#ifdef HAVE_WINDOW_SYSTEM
326 f->want_fullscreen = FULLSCREEN_NONE;
327#endif
328 f->size_hint_flags = 0;
329 f->win_gravity = 0;
330 f->font_driver_list = NULL;
331 f->font_data_list = NULL;
332
333 root_window = make_window ();
334 if (mini_p)
335 {
336 mini_window = make_window ();
337 XWINDOW (root_window)->next = mini_window;
338 XWINDOW (mini_window)->prev = root_window;
339 XWINDOW (mini_window)->mini_p = Qt;
340 XWINDOW (mini_window)->frame = frame;
341 f->minibuffer_window = mini_window;
342 }
343 else
344 {
345 mini_window = Qnil;
346 XWINDOW (root_window)->next = Qnil;
347 f->minibuffer_window = Qnil;
348 }
349
350 XWINDOW (root_window)->frame = frame;
351
352 /* 10 is arbitrary,
353 just so that there is "something there."
354 Correct size will be set up later with change_frame_size. */
355
356 SET_FRAME_COLS (f, 10);
357 FRAME_LINES (f) = 10;
358
359 XSETFASTINT (XWINDOW (root_window)->total_cols, 10);
360 XSETFASTINT (XWINDOW (root_window)->total_lines, (mini_p ? 9 : 10));
361
362 if (mini_p)
363 {
364 XSETFASTINT (XWINDOW (mini_window)->total_cols, 10);
365 XSETFASTINT (XWINDOW (mini_window)->top_line, 9);
366 XSETFASTINT (XWINDOW (mini_window)->total_lines, 1);
367 }
368
369 /* Choose a buffer for the frame's root window. */
370 {
371 Lisp_Object buf;
372
373 XWINDOW (root_window)->buffer = Qt;
374 buf = Fcurrent_buffer ();
375 /* If buf is a 'hidden' buffer (i.e. one whose name starts with
376 a space), try to find another one. */
377 if (SREF (Fbuffer_name (buf), 0) == ' ')
378 buf = Fother_buffer (buf, Qnil, Qnil);
379
380 /* Use set_window_buffer, not Fset_window_buffer, and don't let
381 hooks be run by it. The reason is that the whole frame/window
382 arrangement is not yet fully intialized at this point. Windows
383 don't have the right size, glyph matrices aren't initialized
384 etc. Running Lisp functions at this point surely ends in a
385 SEGV. */
386 set_window_buffer (root_window, buf, 0, 0);
387 f->buffer_list = Fcons (buf, Qnil);
388 }
389
390 if (mini_p)
391 {
392 XWINDOW (mini_window)->buffer = Qt;
393 set_window_buffer (mini_window,
394 (NILP (Vminibuffer_list)
395 ? get_minibuffer (0)
396 : Fcar (Vminibuffer_list)),
397 0, 0);
398 }
399
400 f->root_window = root_window;
401 f->selected_window = root_window;
402 /* Make sure this window seems more recently used than
403 a newly-created, never-selected window. */
404 ++window_select_count;
405 XSETFASTINT (XWINDOW (f->selected_window)->use_time, window_select_count);
406
407 f->default_face_done_p = 0;
408
409 return f;
410}
411\f
412#ifdef HAVE_WINDOW_SYSTEM
413/* Make a frame using a separate minibuffer window on another frame.
414 MINI_WINDOW is the minibuffer window to use. nil means use the
415 default (the global minibuffer). */
416
417struct frame *
418make_frame_without_minibuffer (mini_window, kb, display)
419 register Lisp_Object mini_window;
420 KBOARD *kb;
421 Lisp_Object display;
422{
423 register struct frame *f;
424 struct gcpro gcpro1;
425
426 if (!NILP (mini_window))
427 CHECK_LIVE_WINDOW (mini_window);
428
429#ifdef MULTI_KBOARD
430 if (!NILP (mini_window)
431 && FRAME_KBOARD (XFRAME (XWINDOW (mini_window)->frame)) != kb)
432 error ("Frame and minibuffer must be on the same terminal");
433#endif
434
435 /* Make a frame containing just a root window. */
436 f = make_frame (0);
437
438 if (NILP (mini_window))
439 {
440 /* Use default-minibuffer-frame if possible. */
441 if (!FRAMEP (kb->Vdefault_minibuffer_frame)
442 || ! FRAME_LIVE_P (XFRAME (kb->Vdefault_minibuffer_frame)))
443 {
444 Lisp_Object frame_dummy;
445
446 XSETFRAME (frame_dummy, f);
447 GCPRO1 (frame_dummy);
448 /* If there's no minibuffer frame to use, create one. */
449 kb->Vdefault_minibuffer_frame =
450 call1 (intern ("make-initial-minibuffer-frame"), display);
451 UNGCPRO;
452 }
453
454 mini_window = XFRAME (kb->Vdefault_minibuffer_frame)->minibuffer_window;
455 }
456
457 f->minibuffer_window = mini_window;
458
459 /* Make the chosen minibuffer window display the proper minibuffer,
460 unless it is already showing a minibuffer. */
461 if (NILP (Fmemq (XWINDOW (mini_window)->buffer, Vminibuffer_list)))
462 Fset_window_buffer (mini_window,
463 (NILP (Vminibuffer_list)
464 ? get_minibuffer (0)
465 : Fcar (Vminibuffer_list)), Qnil);
466 return f;
467}
468
469/* Make a frame containing only a minibuffer window. */
470
471struct frame *
472make_minibuffer_frame ()
473{
474 /* First make a frame containing just a root window, no minibuffer. */
475
476 register struct frame *f = make_frame (0);
477 register Lisp_Object mini_window;
478 register Lisp_Object frame;
479
480 XSETFRAME (frame, f);
481
482 f->auto_raise = 0;
483 f->auto_lower = 0;
484 f->no_split = 1;
485 f->wants_modeline = 0;
486 f->has_minibuffer = 1;
487
488 /* Now label the root window as also being the minibuffer.
489 Avoid infinite looping on the window chain by marking next pointer
490 as nil. */
491
492 mini_window = f->minibuffer_window = f->root_window;
493 XWINDOW (mini_window)->mini_p = Qt;
494 XWINDOW (mini_window)->next = Qnil;
495 XWINDOW (mini_window)->prev = Qnil;
496 XWINDOW (mini_window)->frame = frame;
497
498 /* Put the proper buffer in that window. */
499
500 Fset_window_buffer (mini_window,
501 (NILP (Vminibuffer_list)
502 ? get_minibuffer (0)
503 : Fcar (Vminibuffer_list)), Qnil);
504 return f;
505}
506#endif /* HAVE_WINDOW_SYSTEM */
507\f
508/* Construct a frame that refers to a terminal. */
509
510static int tty_frame_count;
511
512struct frame *
513make_initial_frame (void)
514{
515 struct frame *f;
516 struct terminal *terminal;
517 Lisp_Object frame;
518
519 eassert (initial_kboard);
520
521 /* The first call must initialize Vframe_list. */
522 if (! (NILP (Vframe_list) || CONSP (Vframe_list)))
523 Vframe_list = Qnil;
524
525 terminal = init_initial_terminal ();
526
527 f = make_frame (1);
528 XSETFRAME (frame, f);
529
530 Vframe_list = Fcons (frame, Vframe_list);
531
532 tty_frame_count = 1;
533 f->name = build_string ("F1");
534
535 f->visible = 1;
536 f->async_visible = 1;
537
538 f->output_method = terminal->type;
539 f->terminal = terminal;
540 f->terminal->reference_count++;
541 f->output_data.nothing = 0;
542
543 FRAME_FOREGROUND_PIXEL (f) = FACE_TTY_DEFAULT_FG_COLOR;
544 FRAME_BACKGROUND_PIXEL (f) = FACE_TTY_DEFAULT_BG_COLOR;
545
546 FRAME_CAN_HAVE_SCROLL_BARS (f) = 0;
547 FRAME_VERTICAL_SCROLL_BAR_TYPE (f) = vertical_scroll_bar_none;
548
549 return f;
550}
551
552
553struct frame *
554make_terminal_frame (struct terminal *terminal)
555{
556 register struct frame *f;
557 Lisp_Object frame;
558 char name[20];
559
560 if (!terminal->name)
561 error ("Terminal is not live, can't create new frames on it");
562
563 f = make_frame (1);
564
565 XSETFRAME (frame, f);
566 Vframe_list = Fcons (frame, Vframe_list);
567
568 tty_frame_count++;
569 sprintf (name, "F%d", tty_frame_count);
570 f->name = build_string (name);
571
572 f->visible = 1; /* FRAME_SET_VISIBLE wd set frame_garbaged. */
573 f->async_visible = 1; /* Don't let visible be cleared later. */
574#ifdef MSDOS
575 f->output_data.x = &the_only_x_display;
576 if (!inhibit_window_system
577 && (!FRAMEP (selected_frame) || !FRAME_LIVE_P (XFRAME (selected_frame))
578 || XFRAME (selected_frame)->output_method == output_msdos_raw))
579 {
580 f->output_method = output_msdos_raw;
581 /* This initialization of foreground and background pixels is
582 only important for the initial frame created in temacs. If
583 we don't do that, we get black background and foreground in
584 the dumped Emacs because the_only_x_display is a static
585 variable, hence it is born all-zeroes, and zero is the code
586 for the black color. Other frames all inherit their pixels
587 from what's already in the_only_x_display. */
588 if ((!FRAMEP (selected_frame) || !FRAME_LIVE_P (XFRAME (selected_frame)))
589 && FRAME_BACKGROUND_PIXEL (f) == 0
590 && FRAME_FOREGROUND_PIXEL (f) == 0)
591 {
592 FRAME_BACKGROUND_PIXEL (f) = FACE_TTY_DEFAULT_BG_COLOR;
593 FRAME_FOREGROUND_PIXEL (f) = FACE_TTY_DEFAULT_FG_COLOR;
594 }
595 }
596 else
597 f->output_method = output_termcap;
598#else
599 {
600 f->output_method = output_termcap;
601 f->terminal = terminal;
602 f->terminal->reference_count++;
603 create_tty_output (f);
604
605 FRAME_FOREGROUND_PIXEL (f) = FACE_TTY_DEFAULT_FG_COLOR;
606 FRAME_BACKGROUND_PIXEL (f) = FACE_TTY_DEFAULT_BG_COLOR;
607
608 FRAME_CAN_HAVE_SCROLL_BARS (f) = 0;
609 FRAME_VERTICAL_SCROLL_BAR_TYPE (f) = vertical_scroll_bar_none;
610
611 /* Set the top frame to the newly created frame. */
612 if (FRAMEP (FRAME_TTY (f)->top_frame)
613 && FRAME_LIVE_P (XFRAME (FRAME_TTY (f)->top_frame)))
614 XFRAME (FRAME_TTY (f)->top_frame)->async_visible = 2; /* obscured */
615
616 FRAME_TTY (f)->top_frame = frame;
617 }
618
619#ifdef CANNOT_DUMP
620 FRAME_FOREGROUND_PIXEL(f) = FACE_TTY_DEFAULT_FG_COLOR;
621 FRAME_BACKGROUND_PIXEL(f) = FACE_TTY_DEFAULT_BG_COLOR;
622#endif
623#endif /* MSDOS */
624
625 if (!noninteractive)
626 init_frame_faces (f);
627
628 return f;
629}
630
631/* Get a suitable value for frame parameter PARAMETER for a newly
632 created frame, based on (1) the user-supplied frame parameter
633 alist SUPPLIED_PARMS, (2) CURRENT_VALUE, and finally, if all else
634 fails, (3) Vdefault_frame_alist. */
635
636static Lisp_Object
637get_future_frame_param (Lisp_Object parameter,
638 Lisp_Object supplied_parms,
639 char *current_value)
640{
641 Lisp_Object result;
642
643 result = Fassq (parameter, supplied_parms);
644 if (NILP (result))
645 result = Fassq (parameter, XFRAME (selected_frame)->param_alist);
646 if (NILP (result) && current_value != NULL)
647 result = build_string (current_value);
648 if (NILP (result))
649 result = Fassq (parameter, Vdefault_frame_alist);
650 if (!NILP (result) && !STRINGP (result))
651 result = XCDR (result);
652 if (NILP (result) || !STRINGP (result))
653 result = Qnil;
654
655 return result;
656}
657
658DEFUN ("make-terminal-frame", Fmake_terminal_frame, Smake_terminal_frame,
659 1, 1, 0,
660 doc: /* Create an additional terminal frame, possibly on another terminal.
661This function takes one argument, an alist specifying frame parameters.
662
663You can create multiple frames on a single text-only terminal, but
664only one of them (the selected terminal frame) is actually displayed.
665
666In practice, generally you don't need to specify any parameters,
667except when you want to create a new frame on another terminal.
668In that case, the `tty' parameter specifies the device file to open,
669and the `tty-type' parameter specifies the terminal type. Example:
670
671 (make-terminal-frame '((tty . "/dev/pts/5") (tty-type . "xterm")))
672
673Note that changing the size of one terminal frame automatically
674affects all frames on the same terminal device. */)
675 (parms)
676 Lisp_Object parms;
677{
678 struct frame *f;
679 struct terminal *t = NULL;
680 Lisp_Object frame, tem;
681 struct frame *sf = SELECTED_FRAME ();
682
683#ifdef MSDOS
684 if (sf->output_method != output_msdos_raw
685 && sf->output_method != output_termcap)
686 abort ();
687#else /* not MSDOS */
688
689#if 0
690 /* This can happen for multi-tty when using both terminal frames and
691 Carbon frames. */
692 if (sf->output_method != output_mac)
693 error ("Not running on a Macintosh screen; cannot make a new Macintosh frame");
694#else
695#if 0 /* This should work now! */
696 if (sf->output_method != output_termcap)
697 error ("Not using an ASCII terminal now; cannot make a new ASCII frame");
698#endif
699#endif
700#endif /* not MSDOS */
701
702 {
703 Lisp_Object terminal;
704
705 terminal = Fassq (Qterminal, parms);
706 if (!NILP (terminal))
707 {
708 terminal = XCDR (terminal);
709 t = get_terminal (terminal, 1);
710 }
711 }
712
713 if (!t)
714 {
715 char *name = 0, *type = 0;
716 Lisp_Object tty, tty_type;
717
718 tty = get_future_frame_param
719 (Qtty, parms, (FRAME_TERMCAP_P (XFRAME (selected_frame))
720 ? FRAME_TTY (XFRAME (selected_frame))->name
721 : NULL));
722 if (!NILP (tty))
723 {
724 name = (char *) alloca (SBYTES (tty) + 1);
725 strncpy (name, SDATA (tty), SBYTES (tty));
726 name[SBYTES (tty)] = 0;
727 }
728
729 tty_type = get_future_frame_param
730 (Qtty_type, parms, (FRAME_TERMCAP_P (XFRAME (selected_frame))
731 ? FRAME_TTY (XFRAME (selected_frame))->type
732 : NULL));
733 if (!NILP (tty_type))
734 {
735 type = (char *) alloca (SBYTES (tty_type) + 1);
736 strncpy (type, SDATA (tty_type), SBYTES (tty_type));
737 type[SBYTES (tty_type)] = 0;
738 }
739
740 t = init_tty (name, type, 0); /* Errors are not fatal. */
741 }
742
743 f = make_terminal_frame (t);
744
745 {
746 int width, height;
747 get_tty_size (fileno (FRAME_TTY (f)->input), &width, &height);
748 change_frame_size (f, height, width, 0, 0, 0);
749 }
750
751 adjust_glyphs (f);
752 calculate_costs (f);
753 XSETFRAME (frame, f);
754 Fmodify_frame_parameters (frame, Vdefault_frame_alist);
755 Fmodify_frame_parameters (frame, parms);
756 Fmodify_frame_parameters (frame, Fcons (Fcons (Qtty_type,
757 build_string (t->display_info.tty->type)),
758 Qnil));
759 if (t->display_info.tty->name != NULL)
760 Fmodify_frame_parameters (frame, Fcons (Fcons (Qtty,
761 build_string (t->display_info.tty->name)),
762 Qnil));
763 else
764 Fmodify_frame_parameters (frame, Fcons (Fcons (Qtty, Qnil), Qnil));
765
766 /* Make the frame face alist be frame-specific, so that each
767 frame could change its face definitions independently. */
768 f->face_alist = Fcopy_alist (sf->face_alist);
769 /* Simple Fcopy_alist isn't enough, because we need the contents of
770 the vectors which are the CDRs of associations in face_alist to
771 be copied as well. */
772 for (tem = f->face_alist; CONSP (tem); tem = XCDR (tem))
773 XSETCDR (XCAR (tem), Fcopy_sequence (XCDR (XCAR (tem))));
774 return frame;
775}
776
777\f
778/* Perform the switch to frame FRAME.
779
780 If FRAME is a switch-frame event `(switch-frame FRAME1)', use
781 FRAME1 as frame.
782
783 If TRACK is non-zero and the frame that currently has the focus
784 redirects its focus to the selected frame, redirect that focused
785 frame's focus to FRAME instead.
786
787 FOR_DELETION non-zero means that the selected frame is being
788 deleted, which includes the possibility that the frame's terminal
789 is dead. */
790
791Lisp_Object
792do_switch_frame (frame, track, for_deletion)
793 Lisp_Object frame;
794 int track, for_deletion;
795{
796 struct frame *sf = SELECTED_FRAME ();
797
798 /* If FRAME is a switch-frame event, extract the frame we should
799 switch to. */
800 if (CONSP (frame)
801 && EQ (XCAR (frame), Qswitch_frame)
802 && CONSP (XCDR (frame)))
803 frame = XCAR (XCDR (frame));
804
805 /* This used to say CHECK_LIVE_FRAME, but apparently it's possible for
806 a switch-frame event to arrive after a frame is no longer live,
807 especially when deleting the initial frame during startup. */
808 CHECK_FRAME (frame);
809 if (! FRAME_LIVE_P (XFRAME (frame)))
810 return Qnil;
811
812 if (sf == XFRAME (frame))
813 return frame;
814
815 /* This is too greedy; it causes inappropriate focus redirection
816 that's hard to get rid of. */
817#if 0
818 /* If a frame's focus has been redirected toward the currently
819 selected frame, we should change the redirection to point to the
820 newly selected frame. This means that if the focus is redirected
821 from a minibufferless frame to a surrogate minibuffer frame, we
822 can use `other-window' to switch between all the frames using
823 that minibuffer frame, and the focus redirection will follow us
824 around. */
825 if (track)
826 {
827 Lisp_Object tail;
828
829 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
830 {
831 Lisp_Object focus;
832
833 if (!FRAMEP (XCAR (tail)))
834 abort ();
835
836 focus = FRAME_FOCUS_FRAME (XFRAME (XCAR (tail)));
837
838 if (FRAMEP (focus) && XFRAME (focus) == SELECTED_FRAME ())
839 Fredirect_frame_focus (XCAR (tail), frame);
840 }
841 }
842#else /* ! 0 */
843 /* Instead, apply it only to the frame we're pointing to. */
844#ifdef HAVE_WINDOW_SYSTEM
845 if (track && FRAME_WINDOW_P (XFRAME (frame)))
846 {
847 Lisp_Object focus, xfocus;
848
849 xfocus = x_get_focus_frame (XFRAME (frame));
850 if (FRAMEP (xfocus))
851 {
852 focus = FRAME_FOCUS_FRAME (XFRAME (xfocus));
853 if (FRAMEP (focus) && XFRAME (focus) == SELECTED_FRAME ())
854 Fredirect_frame_focus (xfocus, frame);
855 }
856 }
857#endif /* HAVE_X_WINDOWS */
858#endif /* ! 0 */
859
860 if (!for_deletion && FRAME_HAS_MINIBUF_P (sf))
861 resize_mini_window (XWINDOW (FRAME_MINIBUF_WINDOW (sf)), 1);
862
863 if (FRAME_TERMCAP_P (XFRAME (frame)))
864 {
865 if (FRAMEP (FRAME_TTY (XFRAME (frame))->top_frame))
866 /* Mark previously displayed frame as now obscured. */
867 XFRAME (FRAME_TTY (XFRAME (frame))->top_frame)->async_visible = 2;
868 XFRAME (frame)->async_visible = 1;
869 FRAME_TTY (XFRAME (frame))->top_frame = frame;
870 }
871
872 selected_frame = frame;
873 if (! FRAME_MINIBUF_ONLY_P (XFRAME (selected_frame)))
874 last_nonminibuf_frame = XFRAME (selected_frame);
875
876 Fselect_window (XFRAME (frame)->selected_window, Qnil);
877
878 /* We want to make sure that the next event generates a frame-switch
879 event to the appropriate frame. This seems kludgy to me, but
880 before you take it out, make sure that evaluating something like
881 (select-window (frame-root-window (new-frame))) doesn't end up
882 with your typing being interpreted in the new frame instead of
883 the one you're actually typing in. */
884 internal_last_event_frame = Qnil;
885
886 return frame;
887}
888
889DEFUN ("select-frame", Fselect_frame, Sselect_frame, 1, 1, "e",
890 doc: /* Select the frame FRAME.
891Subsequent editing commands apply to its selected window.
892The selection of FRAME lasts until the next time the user does
893something to select a different frame, or until the next time this
894function is called. If you are using a window system, the previously
895selected frame may be restored as the selected frame after return to
896the command loop, because it still may have the window system's input
897focus. On a text-only terminal, the next redisplay will display FRAME.
898
899This function returns FRAME, or nil if FRAME has been deleted. */)
900 (frame)
901 Lisp_Object frame;
902{
903 return do_switch_frame (frame, 1, 0);
904}
905
906
907DEFUN ("handle-switch-frame", Fhandle_switch_frame, Shandle_switch_frame, 1, 1, "e",
908 doc: /* Handle a switch-frame event EVENT.
909Switch-frame events are usually bound to this function.
910A switch-frame event tells Emacs that the window manager has requested
911that the user's events be directed to the frame mentioned in the event.
912This function selects the selected window of the frame of EVENT.
913
914If EVENT is frame object, handle it as if it were a switch-frame event
915to that frame. */)
916 (event)
917 Lisp_Object event;
918{
919 /* Preserve prefix arg that the command loop just cleared. */
920 current_kboard->Vprefix_arg = Vcurrent_prefix_arg;
921 call1 (Vrun_hooks, Qmouse_leave_buffer_hook);
922 return do_switch_frame (event, 0, 0);
923}
924
925DEFUN ("selected-frame", Fselected_frame, Sselected_frame, 0, 0, 0,
926 doc: /* Return the frame that is now selected. */)
927 ()
928{
929 return selected_frame;
930}
931\f
932DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 1, 1, 0,
933 doc: /* Return the frame object that window WINDOW is on. */)
934 (window)
935 Lisp_Object window;
936{
937 CHECK_LIVE_WINDOW (window);
938 return XWINDOW (window)->frame;
939}
940
941DEFUN ("frame-first-window", Fframe_first_window, Sframe_first_window, 0, 1, 0,
942 doc: /* Returns the topmost, leftmost window of FRAME.
943If omitted, FRAME defaults to the currently selected frame. */)
944 (frame)
945 Lisp_Object frame;
946{
947 Lisp_Object w;
948
949 if (NILP (frame))
950 w = SELECTED_FRAME ()->root_window;
951 else
952 {
953 CHECK_LIVE_FRAME (frame);
954 w = XFRAME (frame)->root_window;
955 }
956 while (NILP (XWINDOW (w)->buffer))
957 {
958 if (! NILP (XWINDOW (w)->hchild))
959 w = XWINDOW (w)->hchild;
960 else if (! NILP (XWINDOW (w)->vchild))
961 w = XWINDOW (w)->vchild;
962 else
963 abort ();
964 }
965 return w;
966}
967
968DEFUN ("active-minibuffer-window", Factive_minibuffer_window,
969 Sactive_minibuffer_window, 0, 0, 0,
970 doc: /* Return the currently active minibuffer window, or nil if none. */)
971 ()
972{
973 return minibuf_level ? minibuf_window : Qnil;
974}
975
976DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
977 doc: /* Returns the root-window of FRAME.
978If omitted, FRAME defaults to the currently selected frame. */)
979 (frame)
980 Lisp_Object frame;
981{
982 Lisp_Object window;
983
984 if (NILP (frame))
985 window = SELECTED_FRAME ()->root_window;
986 else
987 {
988 CHECK_LIVE_FRAME (frame);
989 window = XFRAME (frame)->root_window;
990 }
991
992 return window;
993}
994
995DEFUN ("frame-selected-window", Fframe_selected_window,
996 Sframe_selected_window, 0, 1, 0,
997 doc: /* Return the selected window of frame object FRAME.
998If omitted, FRAME defaults to the currently selected frame. */)
999 (frame)
1000 Lisp_Object frame;
1001{
1002 Lisp_Object window;
1003
1004 if (NILP (frame))
1005 window = SELECTED_FRAME ()->selected_window;
1006 else
1007 {
1008 CHECK_LIVE_FRAME (frame);
1009 window = XFRAME (frame)->selected_window;
1010 }
1011
1012 return window;
1013}
1014
1015DEFUN ("set-frame-selected-window", Fset_frame_selected_window,
1016 Sset_frame_selected_window, 2, 2, 0,
1017 doc: /* Set the selected window of frame object FRAME to WINDOW.
1018Return WINDOW.
1019If FRAME is nil, the selected frame is used.
1020If FRAME is the selected frame, this makes WINDOW the selected window. */)
1021 (frame, window)
1022 Lisp_Object frame, window;
1023{
1024 if (NILP (frame))
1025 frame = selected_frame;
1026
1027 CHECK_LIVE_FRAME (frame);
1028 CHECK_LIVE_WINDOW (window);
1029
1030 if (! EQ (frame, WINDOW_FRAME (XWINDOW (window))))
1031 error ("In `set-frame-selected-window', WINDOW is not on FRAME");
1032
1033 if (EQ (frame, selected_frame))
1034 return Fselect_window (window, Qnil);
1035
1036 return XFRAME (frame)->selected_window = window;
1037}
1038
1039\f
1040DEFUN ("frame-list", Fframe_list, Sframe_list,
1041 0, 0, 0,
1042 doc: /* Return a list of all frames. */)
1043 ()
1044{
1045 Lisp_Object frames;
1046 frames = Fcopy_sequence (Vframe_list);
1047#ifdef HAVE_WINDOW_SYSTEM
1048 if (FRAMEP (tip_frame))
1049 frames = Fdelq (tip_frame, frames);
1050#endif
1051 return frames;
1052}
1053
1054/* Return the next frame in the frame list after FRAME.
1055 If MINIBUF is nil, exclude minibuffer-only frames.
1056 If MINIBUF is a window, include only its own frame
1057 and any frame now using that window as the minibuffer.
1058 If MINIBUF is `visible', include all visible frames.
1059 If MINIBUF is 0, include all visible and iconified frames.
1060 Otherwise, include all frames. */
1061
1062static Lisp_Object
1063next_frame (frame, minibuf)
1064 Lisp_Object frame;
1065 Lisp_Object minibuf;
1066{
1067 Lisp_Object tail;
1068 int passed = 0;
1069
1070 /* There must always be at least one frame in Vframe_list. */
1071 if (! CONSP (Vframe_list))
1072 abort ();
1073
1074 /* If this frame is dead, it won't be in Vframe_list, and we'll loop
1075 forever. Forestall that. */
1076 CHECK_LIVE_FRAME (frame);
1077
1078 while (1)
1079 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1080 {
1081 Lisp_Object f;
1082
1083 f = XCAR (tail);
1084
1085 if (passed
1086 && ((!FRAME_TERMCAP_P (XFRAME (f)) && !FRAME_TERMCAP_P (XFRAME (frame))
1087 && FRAME_KBOARD (XFRAME (f)) == FRAME_KBOARD (XFRAME (frame)))
1088 || (FRAME_TERMCAP_P (XFRAME (f)) && FRAME_TERMCAP_P (XFRAME (frame))
1089 && FRAME_TTY (XFRAME (f)) == FRAME_TTY (XFRAME (frame)))))
1090 {
1091 /* Decide whether this frame is eligible to be returned. */
1092
1093 /* If we've looped all the way around without finding any
1094 eligible frames, return the original frame. */
1095 if (EQ (f, frame))
1096 return f;
1097
1098 /* Let minibuf decide if this frame is acceptable. */
1099 if (NILP (minibuf))
1100 {
1101 if (! FRAME_MINIBUF_ONLY_P (XFRAME (f)))
1102 return f;
1103 }
1104 else if (EQ (minibuf, Qvisible))
1105 {
1106 FRAME_SAMPLE_VISIBILITY (XFRAME (f));
1107 if (FRAME_VISIBLE_P (XFRAME (f)))
1108 return f;
1109 }
1110 else if (INTEGERP (minibuf) && XINT (minibuf) == 0)
1111 {
1112 FRAME_SAMPLE_VISIBILITY (XFRAME (f));
1113 if (FRAME_VISIBLE_P (XFRAME (f))
1114 || FRAME_ICONIFIED_P (XFRAME (f)))
1115 return f;
1116 }
1117 else if (WINDOWP (minibuf))
1118 {
1119 if (EQ (FRAME_MINIBUF_WINDOW (XFRAME (f)), minibuf)
1120 || EQ (WINDOW_FRAME (XWINDOW (minibuf)), f)
1121 || EQ (WINDOW_FRAME (XWINDOW (minibuf)),
1122 FRAME_FOCUS_FRAME (XFRAME (f))))
1123 return f;
1124 }
1125 else
1126 return f;
1127 }
1128
1129 if (EQ (frame, f))
1130 passed++;
1131 }
1132}
1133
1134/* Return the previous frame in the frame list before FRAME.
1135 If MINIBUF is nil, exclude minibuffer-only frames.
1136 If MINIBUF is a window, include only its own frame
1137 and any frame now using that window as the minibuffer.
1138 If MINIBUF is `visible', include all visible frames.
1139 If MINIBUF is 0, include all visible and iconified frames.
1140 Otherwise, include all frames. */
1141
1142static Lisp_Object
1143prev_frame (frame, minibuf)
1144 Lisp_Object frame;
1145 Lisp_Object minibuf;
1146{
1147 Lisp_Object tail;
1148 Lisp_Object prev;
1149
1150 /* There must always be at least one frame in Vframe_list. */
1151 if (! CONSP (Vframe_list))
1152 abort ();
1153
1154 prev = Qnil;
1155 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1156 {
1157 Lisp_Object f;
1158
1159 f = XCAR (tail);
1160 if (!FRAMEP (f))
1161 abort ();
1162
1163 if (EQ (frame, f) && !NILP (prev))
1164 return prev;
1165
1166 if ((!FRAME_TERMCAP_P (XFRAME (f)) && !FRAME_TERMCAP_P (XFRAME (frame))
1167 && FRAME_KBOARD (XFRAME (f)) == FRAME_KBOARD (XFRAME (frame)))
1168 || (FRAME_TERMCAP_P (XFRAME (f)) && FRAME_TERMCAP_P (XFRAME (frame))
1169 && FRAME_TTY (XFRAME (f)) == FRAME_TTY (XFRAME (frame))))
1170 {
1171 /* Decide whether this frame is eligible to be returned,
1172 according to minibuf. */
1173 if (NILP (minibuf))
1174 {
1175 if (! FRAME_MINIBUF_ONLY_P (XFRAME (f)))
1176 prev = f;
1177 }
1178 else if (WINDOWP (minibuf))
1179 {
1180 if (EQ (FRAME_MINIBUF_WINDOW (XFRAME (f)), minibuf)
1181 || EQ (WINDOW_FRAME (XWINDOW (minibuf)), f)
1182 || EQ (WINDOW_FRAME (XWINDOW (minibuf)),
1183 FRAME_FOCUS_FRAME (XFRAME (f))))
1184 prev = f;
1185 }
1186 else if (EQ (minibuf, Qvisible))
1187 {
1188 FRAME_SAMPLE_VISIBILITY (XFRAME (f));
1189 if (FRAME_VISIBLE_P (XFRAME (f)))
1190 prev = f;
1191 }
1192 else if (XFASTINT (minibuf) == 0)
1193 {
1194 FRAME_SAMPLE_VISIBILITY (XFRAME (f));
1195 if (FRAME_VISIBLE_P (XFRAME (f))
1196 || FRAME_ICONIFIED_P (XFRAME (f)))
1197 prev = f;
1198 }
1199 else
1200 prev = f;
1201 }
1202 }
1203
1204 /* We've scanned the entire list. */
1205 if (NILP (prev))
1206 /* We went through the whole frame list without finding a single
1207 acceptable frame. Return the original frame. */
1208 return frame;
1209 else
1210 /* There were no acceptable frames in the list before FRAME; otherwise,
1211 we would have returned directly from the loop. Since PREV is the last
1212 acceptable frame in the list, return it. */
1213 return prev;
1214}
1215
1216
1217DEFUN ("next-frame", Fnext_frame, Snext_frame, 0, 2, 0,
1218 doc: /* Return the next frame in the frame list after FRAME.
1219It considers only frames on the same terminal as FRAME.
1220By default, skip minibuffer-only frames.
1221If omitted, FRAME defaults to the selected frame.
1222If optional argument MINIFRAME is nil, exclude minibuffer-only frames.
1223If MINIFRAME is a window, include only its own frame
1224and any frame now using that window as the minibuffer.
1225If MINIFRAME is `visible', include all visible frames.
1226If MINIFRAME is 0, include all visible and iconified frames.
1227Otherwise, include all frames. */)
1228 (frame, miniframe)
1229 Lisp_Object frame, miniframe;
1230{
1231 if (NILP (frame))
1232 frame = selected_frame;
1233
1234 CHECK_LIVE_FRAME (frame);
1235 return next_frame (frame, miniframe);
1236}
1237
1238DEFUN ("previous-frame", Fprevious_frame, Sprevious_frame, 0, 2, 0,
1239 doc: /* Return the previous frame in the frame list before FRAME.
1240It considers only frames on the same terminal as FRAME.
1241By default, skip minibuffer-only frames.
1242If omitted, FRAME defaults to the selected frame.
1243If optional argument MINIFRAME is nil, exclude minibuffer-only frames.
1244If MINIFRAME is a window, include only its own frame
1245and any frame now using that window as the minibuffer.
1246If MINIFRAME is `visible', include all visible frames.
1247If MINIFRAME is 0, include all visible and iconified frames.
1248Otherwise, include all frames. */)
1249 (frame, miniframe)
1250 Lisp_Object frame, miniframe;
1251{
1252 if (NILP (frame))
1253 frame = selected_frame;
1254 CHECK_LIVE_FRAME (frame);
1255 return prev_frame (frame, miniframe);
1256}
1257\f
1258/* Return 1 if it is ok to delete frame F;
1259 0 if all frames aside from F are invisible.
1260 (Exception: if F is the terminal frame, and we are using X, return 1.) */
1261
1262int
1263other_visible_frames (f)
1264 FRAME_PTR f;
1265{
1266 /* We know the selected frame is visible,
1267 so if F is some other frame, it can't be the sole visible one. */
1268 if (f == SELECTED_FRAME ())
1269 {
1270 Lisp_Object frames;
1271 int count = 0;
1272
1273 for (frames = Vframe_list;
1274 CONSP (frames);
1275 frames = XCDR (frames))
1276 {
1277 Lisp_Object this;
1278
1279 this = XCAR (frames);
1280 /* Verify that the frame's window still exists
1281 and we can still talk to it. And note any recent change
1282 in visibility. */
1283#ifdef HAVE_WINDOW_SYSTEM
1284 if (FRAME_WINDOW_P (XFRAME (this)))
1285 {
1286 x_sync (XFRAME (this));
1287 FRAME_SAMPLE_VISIBILITY (XFRAME (this));
1288 }
1289#endif
1290
1291 if (FRAME_VISIBLE_P (XFRAME (this))
1292 || FRAME_ICONIFIED_P (XFRAME (this))
1293 /* Allow deleting the terminal frame when at least
1294 one X frame exists! */
1295 || (FRAME_WINDOW_P (XFRAME (this)) && !FRAME_WINDOW_P (f)))
1296 count++;
1297 }
1298 return count > 1;
1299 }
1300 return 1;
1301}
1302
1303/* Error handler for `delete-frame-functions'. */
1304static Lisp_Object
1305delete_frame_handler (Lisp_Object arg)
1306{
1307 add_to_log ("Error during `delete-frame': %s", arg, Qnil);
1308 return Qnil;
1309}
1310
1311extern Lisp_Object Qrun_hook_with_args;
1312
1313DEFUN ("delete-frame", Fdelete_frame, Sdelete_frame, 0, 2, "",
1314 doc: /* Delete FRAME, permanently eliminating it from use.
1315If omitted, FRAME defaults to the selected frame.
1316A frame may not be deleted if its minibuffer is used by other frames.
1317Normally, you may not delete a frame if all other frames are invisible,
1318but if the second optional argument FORCE is non-nil, you may do so.
1319
1320This function runs `delete-frame-functions' before actually deleting the
1321frame, unless the frame is a tooltip.
1322The functions are run with one arg, the frame to be deleted.
1323But FORCE inhibits this too. */)
1324/* FORCE is non-nil when handling a disconnected terminal. */
1325 (frame, force)
1326 Lisp_Object frame, force;
1327{
1328 struct frame *f;
1329 struct frame *sf = SELECTED_FRAME ();
1330 struct kboard *kb;
1331
1332 int minibuffer_selected;
1333
1334 if (EQ (frame, Qnil))
1335 {
1336 f = sf;
1337 XSETFRAME (frame, f);
1338 }
1339 else
1340 {
1341 CHECK_FRAME (frame);
1342 f = XFRAME (frame);
1343 }
1344
1345 if (! FRAME_LIVE_P (f))
1346 return Qnil;
1347
1348 if (NILP (force) && !other_visible_frames (f))
1349 error ("Attempt to delete the sole visible or iconified frame");
1350
1351#if 0
1352 /* This is a nice idea, but x_connection_closed needs to be able
1353 to delete the last frame, if it is gone. */
1354 if (NILP (XCDR (Vframe_list)))
1355 error ("Attempt to delete the only frame");
1356#endif
1357
1358 /* Does this frame have a minibuffer, and is it the surrogate
1359 minibuffer for any other frame? */
1360 if (FRAME_HAS_MINIBUF_P (XFRAME (frame)))
1361 {
1362 Lisp_Object frames;
1363
1364 for (frames = Vframe_list;
1365 CONSP (frames);
1366 frames = XCDR (frames))
1367 {
1368 Lisp_Object this;
1369 this = XCAR (frames);
1370
1371 if (! EQ (this, frame)
1372 && EQ (frame,
1373 WINDOW_FRAME (XWINDOW
1374 (FRAME_MINIBUF_WINDOW (XFRAME (this))))))
1375 {
1376 /* If we MUST delete this frame, delete the other first. */
1377 if (!NILP (force))
1378 Fdelete_frame (this, force);
1379 else
1380 error ("Attempt to delete a surrogate minibuffer frame");
1381 }
1382 }
1383 }
1384
1385 /* Run `delete-frame-functions'
1386 unless FORCE is `noelisp' or frame is a tooltip.
1387 FORCE is set to `noelisp' when handling a disconnect from the terminal,
1388 so we don't dare call Lisp code. */
1389 if (NILP (Vrun_hooks) || !NILP (Fframe_parameter (frame, intern ("tooltip"))))
1390 ;
1391 if (EQ (force, Qnoelisp))
1392 pending_funcalls
1393 = Fcons (list3 (Qrun_hook_with_args, Qdelete_frame_functions, frame),
1394 pending_funcalls);
1395 else
1396 safe_call2 (Qrun_hook_with_args, Qdelete_frame_functions, frame);
1397
1398 /* The hook may sometimes (indirectly) cause the frame to be deleted. */
1399 if (! FRAME_LIVE_P (f))
1400 return Qnil;
1401
1402 /* At this point, we are committed to deleting the frame.
1403 There is no more chance for errors to prevent it. */
1404
1405 minibuffer_selected = EQ (minibuf_window, selected_window);
1406
1407 /* Don't let the frame remain selected. */
1408 if (f == sf)
1409 {
1410 Lisp_Object tail, frame1;
1411
1412 /* Look for another visible frame on the same terminal. */
1413 frame1 = next_frame (frame, Qvisible);
1414
1415 /* If there is none, find *some* other frame. */
1416 if (NILP (frame1) || EQ (frame1, frame))
1417 {
1418 FOR_EACH_FRAME (tail, frame1)
1419 {
1420 if (! EQ (frame, frame1) && FRAME_LIVE_P (XFRAME (frame1)))
1421 break;
1422 }
1423 }
1424
1425 do_switch_frame (frame1, 0, 1);
1426 sf = SELECTED_FRAME ();
1427 }
1428
1429 /* Don't allow minibuf_window to remain on a deleted frame. */
1430 if (EQ (f->minibuffer_window, minibuf_window))
1431 {
1432 Fset_window_buffer (sf->minibuffer_window,
1433 XWINDOW (minibuf_window)->buffer, Qnil);
1434 minibuf_window = sf->minibuffer_window;
1435
1436 /* If the dying minibuffer window was selected,
1437 select the new one. */
1438 if (minibuffer_selected)
1439 Fselect_window (minibuf_window, Qnil);
1440 }
1441
1442 /* Don't let echo_area_window to remain on a deleted frame. */
1443 if (EQ (f->minibuffer_window, echo_area_window))
1444 echo_area_window = sf->minibuffer_window;
1445
1446 /* Clear any X selections for this frame. */
1447#ifdef HAVE_X_WINDOWS
1448 if (FRAME_X_P (f))
1449 x_clear_frame_selections (f);
1450#endif
1451#ifdef MAC_OS
1452 if (FRAME_MAC_P (f))
1453 x_clear_frame_selections (f);
1454#endif
1455
1456 /* Free glyphs.
1457 This function must be called before the window tree of the
1458 frame is deleted because windows contain dynamically allocated
1459 memory. */
1460 free_glyphs (f);
1461
1462#ifdef HAVE_WINDOW_SYSTEM
1463 /* Give chance to each font driver to free a frame specific data. */
1464 font_update_drivers (f, Qnil);
1465#endif
1466
1467 /* Mark all the windows that used to be on FRAME as deleted, and then
1468 remove the reference to them. */
1469 delete_all_subwindows (XWINDOW (f->root_window));
1470 f->root_window = Qnil;
1471
1472 Vframe_list = Fdelq (frame, Vframe_list);
1473 FRAME_SET_VISIBLE (f, 0);
1474
1475 if (f->namebuf)
1476 xfree (f->namebuf);
1477 if (f->decode_mode_spec_buffer)
1478 xfree (f->decode_mode_spec_buffer);
1479 if (FRAME_INSERT_COST (f))
1480 xfree (FRAME_INSERT_COST (f));
1481 if (FRAME_DELETEN_COST (f))
1482 xfree (FRAME_DELETEN_COST (f));
1483 if (FRAME_INSERTN_COST (f))
1484 xfree (FRAME_INSERTN_COST (f));
1485 if (FRAME_DELETE_COST (f))
1486 xfree (FRAME_DELETE_COST (f));
1487 if (FRAME_MESSAGE_BUF (f))
1488 xfree (FRAME_MESSAGE_BUF (f));
1489
1490 /* Since some events are handled at the interrupt level, we may get
1491 an event for f at any time; if we zero out the frame's terminal
1492 now, then we may trip up the event-handling code. Instead, we'll
1493 promise that the terminal of the frame must be valid until we
1494 have called the window-system-dependent frame destruction
1495 routine. */
1496
1497 if (FRAME_TERMINAL (f)->delete_frame_hook)
1498 (*FRAME_TERMINAL (f)->delete_frame_hook) (f);
1499
1500 {
1501 struct terminal *terminal = FRAME_TERMINAL (f);
1502 f->output_data.nothing = 0;
1503 f->terminal = 0; /* Now the frame is dead. */
1504
1505 /* If needed, delete the terminal that this frame was on.
1506 (This must be done after the frame is killed.) */
1507 terminal->reference_count--;
1508 if (terminal->reference_count == 0)
1509 {
1510 Lisp_Object tmp;
1511 XSETTERMINAL (tmp, terminal);
1512
1513 kb = NULL;
1514 Fdelete_terminal (tmp, NILP (force) ? Qt : force);
1515 }
1516#ifdef MULTI_KBOARD
1517 else
1518 kb = terminal->kboard;
1519#endif
1520 }
1521
1522 /* If we've deleted the last_nonminibuf_frame, then try to find
1523 another one. */
1524 if (f == last_nonminibuf_frame)
1525 {
1526 Lisp_Object frames;
1527
1528 last_nonminibuf_frame = 0;
1529
1530 for (frames = Vframe_list;
1531 CONSP (frames);
1532 frames = XCDR (frames))
1533 {
1534 f = XFRAME (XCAR (frames));
1535 if (!FRAME_MINIBUF_ONLY_P (f))
1536 {
1537 last_nonminibuf_frame = f;
1538 break;
1539 }
1540 }
1541 }
1542
1543 /* If there's no other frame on the same kboard, get out of
1544 single-kboard state if we're in it for this kboard. */
1545 if (kb != NULL)
1546 {
1547 Lisp_Object frames;
1548 /* Some frame we found on the same kboard, or nil if there are none. */
1549 Lisp_Object frame_on_same_kboard;
1550
1551 frame_on_same_kboard = Qnil;
1552
1553 for (frames = Vframe_list;
1554 CONSP (frames);
1555 frames = XCDR (frames))
1556 {
1557 Lisp_Object this;
1558 struct frame *f1;
1559
1560 this = XCAR (frames);
1561 if (!FRAMEP (this))
1562 abort ();
1563 f1 = XFRAME (this);
1564
1565 if (kb == FRAME_KBOARD (f1))
1566 frame_on_same_kboard = this;
1567 }
1568
1569 if (NILP (frame_on_same_kboard))
1570 not_single_kboard_state (kb);
1571 }
1572
1573
1574 /* If we've deleted this keyboard's default_minibuffer_frame, try to
1575 find another one. Prefer minibuffer-only frames, but also notice
1576 frames with other windows. */
1577 if (kb != NULL && EQ (frame, kb->Vdefault_minibuffer_frame))
1578 {
1579 Lisp_Object frames;
1580
1581 /* The last frame we saw with a minibuffer, minibuffer-only or not. */
1582 Lisp_Object frame_with_minibuf;
1583 /* Some frame we found on the same kboard, or nil if there are none. */
1584 Lisp_Object frame_on_same_kboard;
1585
1586 frame_on_same_kboard = Qnil;
1587 frame_with_minibuf = Qnil;
1588
1589 for (frames = Vframe_list;
1590 CONSP (frames);
1591 frames = XCDR (frames))
1592 {
1593 Lisp_Object this;
1594 struct frame *f1;
1595
1596 this = XCAR (frames);
1597 if (!FRAMEP (this))
1598 abort ();
1599 f1 = XFRAME (this);
1600
1601 /* Consider only frames on the same kboard
1602 and only those with minibuffers. */
1603 if (kb == FRAME_KBOARD (f1)
1604 && FRAME_HAS_MINIBUF_P (f1))
1605 {
1606 frame_with_minibuf = this;
1607 if (FRAME_MINIBUF_ONLY_P (f1))
1608 break;
1609 }
1610
1611 if (kb == FRAME_KBOARD (f1))
1612 frame_on_same_kboard = this;
1613 }
1614
1615 if (!NILP (frame_on_same_kboard))
1616 {
1617 /* We know that there must be some frame with a minibuffer out
1618 there. If this were not true, all of the frames present
1619 would have to be minibufferless, which implies that at some
1620 point their minibuffer frames must have been deleted, but
1621 that is prohibited at the top; you can't delete surrogate
1622 minibuffer frames. */
1623 if (NILP (frame_with_minibuf))
1624 abort ();
1625
1626 kb->Vdefault_minibuffer_frame = frame_with_minibuf;
1627 }
1628 else
1629 /* No frames left on this kboard--say no minibuffer either. */
1630 kb->Vdefault_minibuffer_frame = Qnil;
1631 }
1632
1633 /* Cause frame titles to update--necessary if we now have just one frame. */
1634 update_mode_lines = 1;
1635
1636 return Qnil;
1637}
1638\f
1639/* Return mouse position in character cell units. */
1640
1641DEFUN ("mouse-position", Fmouse_position, Smouse_position, 0, 0, 0,
1642 doc: /* Return a list (FRAME X . Y) giving the current mouse frame and position.
1643The position is given in character cells, where (0, 0) is the
1644upper-left corner of the frame, X is the horizontal offset, and Y is
1645the vertical offset.
1646If Emacs is running on a mouseless terminal or hasn't been programmed
1647to read the mouse position, it returns the selected frame for FRAME
1648and nil for X and Y.
1649If `mouse-position-function' is non-nil, `mouse-position' calls it,
1650passing the normal return value to that function as an argument,
1651and returns whatever that function returns. */)
1652 ()
1653{
1654 FRAME_PTR f;
1655 Lisp_Object lispy_dummy;
1656 enum scroll_bar_part party_dummy;
1657 Lisp_Object x, y, retval;
1658 int col, row;
1659 unsigned long long_dummy;
1660 struct gcpro gcpro1;
1661
1662 f = SELECTED_FRAME ();
1663 x = y = Qnil;
1664
1665#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1666 /* It's okay for the hook to refrain from storing anything. */
1667 if (FRAME_TERMINAL (f)->mouse_position_hook)
1668 (*FRAME_TERMINAL (f)->mouse_position_hook) (&f, -1,
1669 &lispy_dummy, &party_dummy,
1670 &x, &y,
1671 &long_dummy);
1672 if (! NILP (x))
1673 {
1674 col = XINT (x);
1675 row = XINT (y);
1676 pixel_to_glyph_coords (f, col, row, &col, &row, NULL, 1);
1677 XSETINT (x, col);
1678 XSETINT (y, row);
1679 }
1680#endif
1681 XSETFRAME (lispy_dummy, f);
1682 retval = Fcons (lispy_dummy, Fcons (x, y));
1683 GCPRO1 (retval);
1684 if (!NILP (Vmouse_position_function))
1685 retval = call1 (Vmouse_position_function, retval);
1686 RETURN_UNGCPRO (retval);
1687}
1688
1689DEFUN ("mouse-pixel-position", Fmouse_pixel_position,
1690 Smouse_pixel_position, 0, 0, 0,
1691 doc: /* Return a list (FRAME X . Y) giving the current mouse frame and position.
1692The position is given in pixel units, where (0, 0) is the
1693upper-left corner of the frame, X is the horizontal offset, and Y is
1694the vertical offset.
1695If Emacs is running on a mouseless terminal or hasn't been programmed
1696to read the mouse position, it returns the selected frame for FRAME
1697and nil for X and Y. */)
1698 ()
1699{
1700 FRAME_PTR f;
1701 Lisp_Object lispy_dummy;
1702 enum scroll_bar_part party_dummy;
1703 Lisp_Object x, y;
1704 unsigned long long_dummy;
1705
1706 f = SELECTED_FRAME ();
1707 x = y = Qnil;
1708
1709#if defined (HAVE_MOUSE) || defined (HAVE_GPM)
1710 /* It's okay for the hook to refrain from storing anything. */
1711 if (FRAME_TERMINAL (f)->mouse_position_hook)
1712 (*FRAME_TERMINAL (f)->mouse_position_hook) (&f, -1,
1713 &lispy_dummy, &party_dummy,
1714 &x, &y,
1715 &long_dummy);
1716#endif
1717 XSETFRAME (lispy_dummy, f);
1718 return Fcons (lispy_dummy, Fcons (x, y));
1719}
1720
1721DEFUN ("set-mouse-position", Fset_mouse_position, Sset_mouse_position, 3, 3, 0,
1722 doc: /* Move the mouse pointer to the center of character cell (X,Y) in FRAME.
1723Coordinates are relative to the frame, not a window,
1724so the coordinates of the top left character in the frame
1725may be nonzero due to left-hand scroll bars or the menu bar.
1726
1727The position is given in character cells, where (0, 0) is the
1728upper-left corner of the frame, X is the horizontal offset, and Y is
1729the vertical offset.
1730
1731This function is a no-op for an X frame that is not visible.
1732If you have just created a frame, you must wait for it to become visible
1733before calling this function on it, like this.
1734 (while (not (frame-visible-p frame)) (sleep-for .5)) */)
1735 (frame, x, y)
1736 Lisp_Object frame, x, y;
1737{
1738 CHECK_LIVE_FRAME (frame);
1739 CHECK_NUMBER (x);
1740 CHECK_NUMBER (y);
1741
1742 /* I think this should be done with a hook. */
1743#ifdef HAVE_WINDOW_SYSTEM
1744 if (FRAME_WINDOW_P (XFRAME (frame)))
1745 /* Warping the mouse will cause enternotify and focus events. */
1746 x_set_mouse_position (XFRAME (frame), XINT (x), XINT (y));
1747#else
1748#if defined (MSDOS) && defined (HAVE_MOUSE)
1749 if (FRAME_MSDOS_P (XFRAME (frame)))
1750 {
1751 Fselect_frame (frame);
1752 mouse_moveto (XINT (x), XINT (y));
1753 }
1754#else
1755#ifdef HAVE_GPM
1756 {
1757 Fselect_frame (frame);
1758 term_mouse_moveto (XINT (x), XINT (y));
1759 }
1760#endif
1761#endif
1762#endif
1763
1764 return Qnil;
1765}
1766
1767DEFUN ("set-mouse-pixel-position", Fset_mouse_pixel_position,
1768 Sset_mouse_pixel_position, 3, 3, 0,
1769 doc: /* Move the mouse pointer to pixel position (X,Y) in FRAME.
1770The position is given in pixels, where (0, 0) is the upper-left corner
1771of the frame, X is the horizontal offset, and Y is the vertical offset.
1772
1773Note, this is a no-op for an X frame that is not visible.
1774If you have just created a frame, you must wait for it to become visible
1775before calling this function on it, like this.
1776 (while (not (frame-visible-p frame)) (sleep-for .5)) */)
1777 (frame, x, y)
1778 Lisp_Object frame, x, y;
1779{
1780 CHECK_LIVE_FRAME (frame);
1781 CHECK_NUMBER (x);
1782 CHECK_NUMBER (y);
1783
1784 /* I think this should be done with a hook. */
1785#ifdef HAVE_WINDOW_SYSTEM
1786 if (FRAME_WINDOW_P (XFRAME (frame)))
1787 /* Warping the mouse will cause enternotify and focus events. */
1788 x_set_mouse_pixel_position (XFRAME (frame), XINT (x), XINT (y));
1789#else
1790#if defined (MSDOS) && defined (HAVE_MOUSE)
1791 if (FRAME_MSDOS_P (XFRAME (frame)))
1792 {
1793 Fselect_frame (frame);
1794 mouse_moveto (XINT (x), XINT (y));
1795 }
1796#else
1797#ifdef HAVE_GPM
1798 {
1799 Fselect_frame (frame);
1800 term_mouse_moveto (XINT (x), XINT (y));
1801 }
1802#endif
1803#endif
1804#endif
1805
1806 return Qnil;
1807}
1808\f
1809static void make_frame_visible_1 P_ ((Lisp_Object));
1810
1811DEFUN ("make-frame-visible", Fmake_frame_visible, Smake_frame_visible,
1812 0, 1, "",
1813 doc: /* Make the frame FRAME visible (assuming it is an X window).
1814If omitted, FRAME defaults to the currently selected frame. */)
1815 (frame)
1816 Lisp_Object frame;
1817{
1818 if (NILP (frame))
1819 frame = selected_frame;
1820
1821 CHECK_LIVE_FRAME (frame);
1822
1823 /* I think this should be done with a hook. */
1824#ifdef HAVE_WINDOW_SYSTEM
1825 if (FRAME_WINDOW_P (XFRAME (frame)))
1826 {
1827 FRAME_SAMPLE_VISIBILITY (XFRAME (frame));
1828 x_make_frame_visible (XFRAME (frame));
1829 }
1830#endif
1831
1832 make_frame_visible_1 (XFRAME (frame)->root_window);
1833
1834 /* Make menu bar update for the Buffers and Frames menus. */
1835 windows_or_buffers_changed++;
1836
1837 return frame;
1838}
1839
1840/* Update the display_time slot of the buffers shown in WINDOW
1841 and all its descendents. */
1842
1843static void
1844make_frame_visible_1 (window)
1845 Lisp_Object window;
1846{
1847 struct window *w;
1848
1849 for (;!NILP (window); window = w->next)
1850 {
1851 w = XWINDOW (window);
1852
1853 if (!NILP (w->buffer))
1854 XBUFFER (w->buffer)->display_time = Fcurrent_time ();
1855
1856 if (!NILP (w->vchild))
1857 make_frame_visible_1 (w->vchild);
1858 if (!NILP (w->hchild))
1859 make_frame_visible_1 (w->hchild);
1860 }
1861}
1862
1863DEFUN ("make-frame-invisible", Fmake_frame_invisible, Smake_frame_invisible,
1864 0, 2, "",
1865 doc: /* Make the frame FRAME invisible (assuming it is an X window).
1866If omitted, FRAME defaults to the currently selected frame.
1867Normally you may not make FRAME invisible if all other frames are invisible,
1868but if the second optional argument FORCE is non-nil, you may do so. */)
1869 (frame, force)
1870 Lisp_Object frame, force;
1871{
1872 if (NILP (frame))
1873 frame = selected_frame;
1874
1875 CHECK_LIVE_FRAME (frame);
1876
1877 if (NILP (force) && !other_visible_frames (XFRAME (frame)))
1878 error ("Attempt to make invisible the sole visible or iconified frame");
1879
1880#if 0 /* This isn't logically necessary, and it can do GC. */
1881 /* Don't let the frame remain selected. */
1882 if (EQ (frame, selected_frame))
1883 do_switch_frame (next_frame (frame, Qt), 0, 0)
1884#endif
1885
1886 /* Don't allow minibuf_window to remain on a deleted frame. */
1887 if (EQ (XFRAME (frame)->minibuffer_window, minibuf_window))
1888 {
1889 struct frame *sf = XFRAME (selected_frame);
1890 Fset_window_buffer (sf->minibuffer_window,
1891 XWINDOW (minibuf_window)->buffer, Qnil);
1892 minibuf_window = sf->minibuffer_window;
1893 }
1894
1895 /* I think this should be done with a hook. */
1896#ifdef HAVE_WINDOW_SYSTEM
1897 if (FRAME_WINDOW_P (XFRAME (frame)))
1898 x_make_frame_invisible (XFRAME (frame));
1899#endif
1900
1901 /* Make menu bar update for the Buffers and Frames menus. */
1902 windows_or_buffers_changed++;
1903
1904 return Qnil;
1905}
1906
1907DEFUN ("iconify-frame", Ficonify_frame, Siconify_frame,
1908 0, 1, "",
1909 doc: /* Make the frame FRAME into an icon.
1910If omitted, FRAME defaults to the currently selected frame. */)
1911 (frame)
1912 Lisp_Object frame;
1913{
1914 if (NILP (frame))
1915 frame = selected_frame;
1916
1917 CHECK_LIVE_FRAME (frame);
1918
1919#if 0 /* This isn't logically necessary, and it can do GC. */
1920 /* Don't let the frame remain selected. */
1921 if (EQ (frame, selected_frame))
1922 Fhandle_switch_frame (next_frame (frame, Qt));
1923#endif
1924
1925 /* Don't allow minibuf_window to remain on a deleted frame. */
1926 if (EQ (XFRAME (frame)->minibuffer_window, minibuf_window))
1927 {
1928 struct frame *sf = XFRAME (selected_frame);
1929 Fset_window_buffer (sf->minibuffer_window,
1930 XWINDOW (minibuf_window)->buffer, Qnil);
1931 minibuf_window = sf->minibuffer_window;
1932 }
1933
1934 /* I think this should be done with a hook. */
1935#ifdef HAVE_WINDOW_SYSTEM
1936 if (FRAME_WINDOW_P (XFRAME (frame)))
1937 x_iconify_frame (XFRAME (frame));
1938#endif
1939
1940 /* Make menu bar update for the Buffers and Frames menus. */
1941 windows_or_buffers_changed++;
1942
1943 return Qnil;
1944}
1945
1946DEFUN ("frame-visible-p", Fframe_visible_p, Sframe_visible_p,
1947 1, 1, 0,
1948 doc: /* Return t if FRAME is now \"visible\" (actually in use for display).
1949A frame that is not \"visible\" is not updated and, if it works through
1950a window system, it may not show at all.
1951Return the symbol `icon' if frame is visible only as an icon.
1952
1953On a text-only terminal, all frames are considered visible, whether
1954they are currently being displayed or not, and this function returns t
1955for all frames. */)
1956 (frame)
1957 Lisp_Object frame;
1958{
1959 CHECK_LIVE_FRAME (frame);
1960
1961 FRAME_SAMPLE_VISIBILITY (XFRAME (frame));
1962
1963 if (FRAME_VISIBLE_P (XFRAME (frame)))
1964 return Qt;
1965 if (FRAME_ICONIFIED_P (XFRAME (frame)))
1966 return Qicon;
1967 return Qnil;
1968}
1969
1970DEFUN ("visible-frame-list", Fvisible_frame_list, Svisible_frame_list,
1971 0, 0, 0,
1972 doc: /* Return a list of all frames now \"visible\" (being updated). */)
1973 ()
1974{
1975 Lisp_Object tail, frame;
1976 struct frame *f;
1977 Lisp_Object value;
1978
1979 value = Qnil;
1980 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1981 {
1982 frame = XCAR (tail);
1983 if (!FRAMEP (frame))
1984 continue;
1985 f = XFRAME (frame);
1986 if (FRAME_VISIBLE_P (f))
1987 value = Fcons (frame, value);
1988 }
1989 return value;
1990}
1991
1992
1993DEFUN ("raise-frame", Fraise_frame, Sraise_frame, 0, 1, "",
1994 doc: /* Bring FRAME to the front, so it occludes any frames it overlaps.
1995If FRAME is invisible or iconified, make it visible.
1996If you don't specify a frame, the selected frame is used.
1997If Emacs is displaying on an ordinary terminal or some other device which
1998doesn't support multiple overlapping frames, this function does nothing. */)
1999 (frame)
2000 Lisp_Object frame;
2001{
2002 struct frame *f;
2003 if (NILP (frame))
2004 frame = selected_frame;
2005
2006 CHECK_LIVE_FRAME (frame);
2007
2008 f = XFRAME (frame);
2009
2010 /* Do like the documentation says. */
2011 Fmake_frame_visible (frame);
2012
2013 if (FRAME_TERMINAL (f)->frame_raise_lower_hook)
2014 (*FRAME_TERMINAL (f)->frame_raise_lower_hook) (f, 1);
2015
2016 return Qnil;
2017}
2018
2019/* Should we have a corresponding function called Flower_Power? */
2020DEFUN ("lower-frame", Flower_frame, Slower_frame, 0, 1, "",
2021 doc: /* Send FRAME to the back, so it is occluded by any frames that overlap it.
2022If you don't specify a frame, the selected frame is used.
2023If Emacs is displaying on an ordinary terminal or some other device which
2024doesn't support multiple overlapping frames, this function does nothing. */)
2025 (frame)
2026 Lisp_Object frame;
2027{
2028 struct frame *f;
2029
2030 if (NILP (frame))
2031 frame = selected_frame;
2032
2033 CHECK_LIVE_FRAME (frame);
2034
2035 f = XFRAME (frame);
2036
2037 if (FRAME_TERMINAL (f)->frame_raise_lower_hook)
2038 (*FRAME_TERMINAL (f)->frame_raise_lower_hook) (f, 0);
2039
2040 return Qnil;
2041}
2042
2043\f
2044DEFUN ("redirect-frame-focus", Fredirect_frame_focus, Sredirect_frame_focus,
2045 1, 2, 0,
2046 doc: /* Arrange for keystrokes typed at FRAME to be sent to FOCUS-FRAME.
2047In other words, switch-frame events caused by events in FRAME will
2048request a switch to FOCUS-FRAME, and `last-event-frame' will be
2049FOCUS-FRAME after reading an event typed at FRAME.
2050
2051If FOCUS-FRAME is omitted or nil, any existing redirection is
2052cancelled, and the frame again receives its own keystrokes.
2053
2054Focus redirection is useful for temporarily redirecting keystrokes to
2055a surrogate minibuffer frame when a frame doesn't have its own
2056minibuffer window.
2057
2058A frame's focus redirection can be changed by `select-frame'. If frame
2059FOO is selected, and then a different frame BAR is selected, any
2060frames redirecting their focus to FOO are shifted to redirect their
2061focus to BAR. This allows focus redirection to work properly when the
2062user switches from one frame to another using `select-window'.
2063
2064This means that a frame whose focus is redirected to itself is treated
2065differently from a frame whose focus is redirected to nil; the former
2066is affected by `select-frame', while the latter is not.
2067
2068The redirection lasts until `redirect-frame-focus' is called to change it. */)
2069 (frame, focus_frame)
2070 Lisp_Object frame, focus_frame;
2071{
2072 struct frame *f;
2073
2074 /* Note that we don't check for a live frame here. It's reasonable
2075 to redirect the focus of a frame you're about to delete, if you
2076 know what other frame should receive those keystrokes. */
2077 CHECK_FRAME (frame);
2078
2079 if (! NILP (focus_frame))
2080 CHECK_LIVE_FRAME (focus_frame);
2081
2082 f = XFRAME (frame);
2083
2084 f->focus_frame = focus_frame;
2085
2086 if (FRAME_TERMINAL (f)->frame_rehighlight_hook)
2087 (*FRAME_TERMINAL (f)->frame_rehighlight_hook) (f);
2088
2089 return Qnil;
2090}
2091
2092
2093DEFUN ("frame-focus", Fframe_focus, Sframe_focus, 1, 1, 0,
2094 doc: /* Return the frame to which FRAME's keystrokes are currently being sent.
2095This returns nil if FRAME's focus is not redirected.
2096See `redirect-frame-focus'. */)
2097 (frame)
2098 Lisp_Object frame;
2099{
2100 CHECK_LIVE_FRAME (frame);
2101
2102 return FRAME_FOCUS_FRAME (XFRAME (frame));
2103}
2104
2105
2106\f
2107/* Return the value of frame parameter PROP in frame FRAME. */
2108
2109Lisp_Object
2110get_frame_param (frame, prop)
2111 register struct frame *frame;
2112 Lisp_Object prop;
2113{
2114 register Lisp_Object tem;
2115
2116 tem = Fassq (prop, frame->param_alist);
2117 if (EQ (tem, Qnil))
2118 return tem;
2119 return Fcdr (tem);
2120}
2121
2122/* Return the buffer-predicate of the selected frame. */
2123
2124Lisp_Object
2125frame_buffer_predicate (frame)
2126 Lisp_Object frame;
2127{
2128 return XFRAME (frame)->buffer_predicate;
2129}
2130
2131/* Return the buffer-list of the selected frame. */
2132
2133Lisp_Object
2134frame_buffer_list (frame)
2135 Lisp_Object frame;
2136{
2137 return XFRAME (frame)->buffer_list;
2138}
2139
2140/* Set the buffer-list of the selected frame. */
2141
2142void
2143set_frame_buffer_list (frame, list)
2144 Lisp_Object frame, list;
2145{
2146 XFRAME (frame)->buffer_list = list;
2147}
2148
2149/* Discard BUFFER from the buffer-list and buried-buffer-list of each frame. */
2150
2151void
2152frames_discard_buffer (buffer)
2153 Lisp_Object buffer;
2154{
2155 Lisp_Object frame, tail;
2156
2157 FOR_EACH_FRAME (tail, frame)
2158 {
2159 XFRAME (frame)->buffer_list
2160 = Fdelq (buffer, XFRAME (frame)->buffer_list);
2161 XFRAME (frame)->buried_buffer_list
2162 = Fdelq (buffer, XFRAME (frame)->buried_buffer_list);
2163 }
2164}
2165
2166/* Modify the alist in *ALISTPTR to associate PROP with VAL.
2167 If the alist already has an element for PROP, we change it. */
2168
2169void
2170store_in_alist (alistptr, prop, val)
2171 Lisp_Object *alistptr, val;
2172 Lisp_Object prop;
2173{
2174 register Lisp_Object tem;
2175
2176 tem = Fassq (prop, *alistptr);
2177 if (EQ (tem, Qnil))
2178 *alistptr = Fcons (Fcons (prop, val), *alistptr);
2179 else
2180 Fsetcdr (tem, val);
2181}
2182
2183static int
2184frame_name_fnn_p (str, len)
2185 char *str;
2186 EMACS_INT len;
2187{
2188 if (len > 1 && str[0] == 'F')
2189 {
2190 char *end_ptr;
2191
2192 strtol (str + 1, &end_ptr, 10);
2193
2194 if (end_ptr == str + len)
2195 return 1;
2196 }
2197 return 0;
2198}
2199
2200/* Set the name of the terminal frame. Also used by MSDOS frames.
2201 Modeled after x_set_name which is used for WINDOW frames. */
2202
2203static void
2204set_term_frame_name (f, name)
2205 struct frame *f;
2206 Lisp_Object name;
2207{
2208 f->explicit_name = ! NILP (name);
2209
2210 /* If NAME is nil, set the name to F<num>. */
2211 if (NILP (name))
2212 {
2213 char namebuf[20];
2214
2215 /* Check for no change needed in this very common case
2216 before we do any consing. */
2217 if (frame_name_fnn_p (SDATA (f->name),
2218 SBYTES (f->name)))
2219 return;
2220
2221 tty_frame_count++;
2222 sprintf (namebuf, "F%d", tty_frame_count);
2223 name = build_string (namebuf);
2224 }
2225 else
2226 {
2227 CHECK_STRING (name);
2228
2229 /* Don't change the name if it's already NAME. */
2230 if (! NILP (Fstring_equal (name, f->name)))
2231 return;
2232
2233 /* Don't allow the user to set the frame name to F<num>, so it
2234 doesn't clash with the names we generate for terminal frames. */
2235 if (frame_name_fnn_p (SDATA (name), SBYTES (name)))
2236 error ("Frame names of the form F<num> are usurped by Emacs");
2237 }
2238
2239 f->name = name;
2240 update_mode_lines = 1;
2241}
2242
2243void
2244store_frame_param (f, prop, val)
2245 struct frame *f;
2246 Lisp_Object prop, val;
2247{
2248 register Lisp_Object old_alist_elt;
2249
2250 /* The buffer-list parameters are stored in a special place and not
2251 in the alist. */
2252 if (EQ (prop, Qbuffer_list))
2253 {
2254 f->buffer_list = val;
2255 return;
2256 }
2257 if (EQ (prop, Qburied_buffer_list))
2258 {
2259 f->buried_buffer_list = val;
2260 return;
2261 }
2262
2263 /* If PROP is a symbol which is supposed to have frame-local values,
2264 and it is set up based on this frame, switch to the global
2265 binding. That way, we can create or alter the frame-local binding
2266 without messing up the symbol's status. */
2267 if (SYMBOLP (prop))
2268 {
2269 Lisp_Object valcontents;
2270 valcontents = SYMBOL_VALUE (prop);
2271 if ((BUFFER_LOCAL_VALUEP (valcontents))
2272 && XBUFFER_LOCAL_VALUE (valcontents)->check_frame
2273 && XBUFFER_LOCAL_VALUE (valcontents)->found_for_frame
2274 && XFRAME (XBUFFER_LOCAL_VALUE (valcontents)->frame) == f)
2275 swap_in_global_binding (prop);
2276 }
2277
2278#ifndef WINDOWSNT
2279 /* The tty color needed to be set before the frame's parameter
2280 alist was updated with the new value. This is not true any more,
2281 but we still do this test early on. */
2282 if (FRAME_TERMCAP_P (f) && EQ (prop, Qtty_color_mode)
2283 && f == FRAME_TTY (f)->previous_frame)
2284 /* Force redisplay of this tty. */
2285 FRAME_TTY (f)->previous_frame = NULL;
2286#endif
2287
2288 /* Update the frame parameter alist. */
2289 old_alist_elt = Fassq (prop, f->param_alist);
2290 if (EQ (old_alist_elt, Qnil))
2291 f->param_alist = Fcons (Fcons (prop, val), f->param_alist);
2292 else
2293 Fsetcdr (old_alist_elt, val);
2294
2295 /* Update some other special parameters in their special places
2296 in addition to the alist. */
2297
2298 if (EQ (prop, Qbuffer_predicate))
2299 f->buffer_predicate = val;
2300
2301 if (! FRAME_WINDOW_P (f))
2302 {
2303 if (EQ (prop, Qmenu_bar_lines))
2304 set_menu_bar_lines (f, val, make_number (FRAME_MENU_BAR_LINES (f)));
2305 else if (EQ (prop, Qname))
2306 set_term_frame_name (f, val);
2307 }
2308
2309 if (EQ (prop, Qminibuffer) && WINDOWP (val))
2310 {
2311 if (! MINI_WINDOW_P (XWINDOW (val)))
2312 error ("Surrogate minibuffer windows must be minibuffer windows");
2313
2314 if ((FRAME_HAS_MINIBUF_P (f) || FRAME_MINIBUF_ONLY_P (f))
2315 && !EQ (val, f->minibuffer_window))
2316 error ("Can't change the surrogate minibuffer of a frame with its own minibuffer");
2317
2318 /* Install the chosen minibuffer window, with proper buffer. */
2319 f->minibuffer_window = val;
2320 }
2321}
2322
2323DEFUN ("frame-parameters", Fframe_parameters, Sframe_parameters, 0, 1, 0,
2324 doc: /* Return the parameters-alist of frame FRAME.
2325It is a list of elements of the form (PARM . VALUE), where PARM is a symbol.
2326The meaningful PARMs depend on the kind of frame.
2327If FRAME is omitted, return information on the currently selected frame. */)
2328 (frame)
2329 Lisp_Object frame;
2330{
2331 Lisp_Object alist;
2332 FRAME_PTR f;
2333 int height, width;
2334 struct gcpro gcpro1;
2335
2336 if (NILP (frame))
2337 frame = selected_frame;
2338
2339 CHECK_FRAME (frame);
2340 f = XFRAME (frame);
2341
2342 if (!FRAME_LIVE_P (f))
2343 return Qnil;
2344
2345 alist = Fcopy_alist (f->param_alist);
2346 GCPRO1 (alist);
2347
2348 if (!FRAME_WINDOW_P (f))
2349 {
2350 int fg = FRAME_FOREGROUND_PIXEL (f);
2351 int bg = FRAME_BACKGROUND_PIXEL (f);
2352 Lisp_Object elt;
2353
2354 /* If the frame's parameter alist says the colors are
2355 unspecified and reversed, take the frame's background pixel
2356 for foreground and vice versa. */
2357 elt = Fassq (Qforeground_color, alist);
2358 if (CONSP (elt) && STRINGP (XCDR (elt)))
2359 {
2360 if (strncmp (SDATA (XCDR (elt)),
2361 unspecified_bg,
2362 SCHARS (XCDR (elt))) == 0)
2363 store_in_alist (&alist, Qforeground_color, tty_color_name (f, bg));
2364 else if (strncmp (SDATA (XCDR (elt)),
2365 unspecified_fg,
2366 SCHARS (XCDR (elt))) == 0)
2367 store_in_alist (&alist, Qforeground_color, tty_color_name (f, fg));
2368 }
2369 else
2370 store_in_alist (&alist, Qforeground_color, tty_color_name (f, fg));
2371 elt = Fassq (Qbackground_color, alist);
2372 if (CONSP (elt) && STRINGP (XCDR (elt)))
2373 {
2374 if (strncmp (SDATA (XCDR (elt)),
2375 unspecified_fg,
2376 SCHARS (XCDR (elt))) == 0)
2377 store_in_alist (&alist, Qbackground_color, tty_color_name (f, fg));
2378 else if (strncmp (SDATA (XCDR (elt)),
2379 unspecified_bg,
2380 SCHARS (XCDR (elt))) == 0)
2381 store_in_alist (&alist, Qbackground_color, tty_color_name (f, bg));
2382 }
2383 else
2384 store_in_alist (&alist, Qbackground_color, tty_color_name (f, bg));
2385 store_in_alist (&alist, intern ("font"),
2386 build_string (FRAME_MSDOS_P (f)
2387 ? "ms-dos"
2388 : FRAME_W32_P (f) ? "w32term"
2389 :"tty"));
2390 }
2391 store_in_alist (&alist, Qname, f->name);
2392 height = (f->new_text_lines ? f->new_text_lines : FRAME_LINES (f));
2393 store_in_alist (&alist, Qheight, make_number (height));
2394 width = (f->new_text_cols ? f->new_text_cols : FRAME_COLS (f));
2395 store_in_alist (&alist, Qwidth, make_number (width));
2396 store_in_alist (&alist, Qmodeline, (FRAME_WANTS_MODELINE_P (f) ? Qt : Qnil));
2397 store_in_alist (&alist, Qminibuffer,
2398 (! FRAME_HAS_MINIBUF_P (f) ? Qnil
2399 : FRAME_MINIBUF_ONLY_P (f) ? Qonly
2400 : FRAME_MINIBUF_WINDOW (f)));
2401 store_in_alist (&alist, Qunsplittable, (FRAME_NO_SPLIT_P (f) ? Qt : Qnil));
2402 store_in_alist (&alist, Qbuffer_list, frame_buffer_list (frame));
2403 store_in_alist (&alist, Qburied_buffer_list, XFRAME (frame)->buried_buffer_list);
2404
2405 /* I think this should be done with a hook. */
2406#ifdef HAVE_WINDOW_SYSTEM
2407 if (FRAME_WINDOW_P (f))
2408 x_report_frame_params (f, &alist);
2409 else
2410#endif
2411 {
2412 /* This ought to be correct in f->param_alist for an X frame. */
2413 Lisp_Object lines;
2414 XSETFASTINT (lines, FRAME_MENU_BAR_LINES (f));
2415 store_in_alist (&alist, Qmenu_bar_lines, lines);
2416 }
2417
2418 UNGCPRO;
2419 return alist;
2420}
2421
2422
2423DEFUN ("frame-parameter", Fframe_parameter, Sframe_parameter, 2, 2, 0,
2424 doc: /* Return FRAME's value for parameter PARAMETER.
2425If FRAME is nil, describe the currently selected frame. */)
2426 (frame, parameter)
2427 Lisp_Object frame, parameter;
2428{
2429 struct frame *f;
2430 Lisp_Object value;
2431
2432 if (NILP (frame))
2433 frame = selected_frame;
2434 else
2435 CHECK_FRAME (frame);
2436 CHECK_SYMBOL (parameter);
2437
2438 f = XFRAME (frame);
2439 value = Qnil;
2440
2441 if (FRAME_LIVE_P (f))
2442 {
2443 /* Avoid consing in frequent cases. */
2444 if (EQ (parameter, Qname))
2445 value = f->name;
2446#ifdef HAVE_X_WINDOWS
2447 else if (EQ (parameter, Qdisplay) && FRAME_X_P (f))
2448 value = XCAR (FRAME_X_DISPLAY_INFO (f)->name_list_element);
2449#endif /* HAVE_X_WINDOWS */
2450 else if (EQ (parameter, Qbackground_color)
2451 || EQ (parameter, Qforeground_color))
2452 {
2453 value = Fassq (parameter, f->param_alist);
2454 if (CONSP (value))
2455 {
2456 value = XCDR (value);
2457 /* Fframe_parameters puts the actual fg/bg color names,
2458 even if f->param_alist says otherwise. This is
2459 important when param_alist's notion of colors is
2460 "unspecified". We need to do the same here. */
2461 if (STRINGP (value) && !FRAME_WINDOW_P (f))
2462 {
2463 const char *color_name;
2464 EMACS_INT csz;
2465
2466 if (EQ (parameter, Qbackground_color))
2467 {
2468 color_name = SDATA (value);
2469 csz = SCHARS (value);
2470 if (strncmp (color_name, unspecified_bg, csz) == 0)
2471 value = tty_color_name (f, FRAME_BACKGROUND_PIXEL (f));
2472 else if (strncmp (color_name, unspecified_fg, csz) == 0)
2473 value = tty_color_name (f, FRAME_FOREGROUND_PIXEL (f));
2474 }
2475 else if (EQ (parameter, Qforeground_color))
2476 {
2477 color_name = SDATA (value);
2478 csz = SCHARS (value);
2479 if (strncmp (color_name, unspecified_fg, csz) == 0)
2480 value = tty_color_name (f, FRAME_FOREGROUND_PIXEL (f));
2481 else if (strncmp (color_name, unspecified_bg, csz) == 0)
2482 value = tty_color_name (f, FRAME_BACKGROUND_PIXEL (f));
2483 }
2484 }
2485 }
2486 else
2487 value = Fcdr (Fassq (parameter, Fframe_parameters (frame)));
2488 }
2489 else if (EQ (parameter, Qdisplay_type)
2490 || EQ (parameter, Qbackground_mode))
2491 value = Fcdr (Fassq (parameter, f->param_alist));
2492 else
2493 value = Fcdr (Fassq (parameter, Fframe_parameters (frame)));
2494 }
2495
2496 return value;
2497}
2498
2499
2500DEFUN ("modify-frame-parameters", Fmodify_frame_parameters,
2501 Smodify_frame_parameters, 2, 2, 0,
2502 doc: /* Modify the parameters of frame FRAME according to ALIST.
2503If FRAME is nil, it defaults to the selected frame.
2504ALIST is an alist of parameters to change and their new values.
2505Each element of ALIST has the form (PARM . VALUE), where PARM is a symbol.
2506The meaningful PARMs depend on the kind of frame.
2507Undefined PARMs are ignored, but stored in the frame's parameter list
2508so that `frame-parameters' will return them.
2509
2510The value of frame parameter FOO can also be accessed
2511as a frame-local binding for the variable FOO, if you have
2512enabled such bindings for that variable with `make-variable-frame-local'. */)
2513 (frame, alist)
2514 Lisp_Object frame, alist;
2515{
2516 FRAME_PTR f;
2517 register Lisp_Object tail, prop, val;
2518
2519 if (EQ (frame, Qnil))
2520 frame = selected_frame;
2521 CHECK_LIVE_FRAME (frame);
2522 f = XFRAME (frame);
2523
2524 /* I think this should be done with a hook. */
2525#ifdef HAVE_WINDOW_SYSTEM
2526 if (FRAME_WINDOW_P (f))
2527 x_set_frame_parameters (f, alist);
2528 else
2529#endif
2530#ifdef MSDOS
2531 if (FRAME_MSDOS_P (f))
2532 IT_set_frame_parameters (f, alist);
2533 else
2534#endif
2535
2536 {
2537 int length = XINT (Flength (alist));
2538 int i;
2539 Lisp_Object *parms
2540 = (Lisp_Object *) alloca (length * sizeof (Lisp_Object));
2541 Lisp_Object *values
2542 = (Lisp_Object *) alloca (length * sizeof (Lisp_Object));
2543
2544 /* Extract parm names and values into those vectors. */
2545
2546 i = 0;
2547 for (tail = alist; CONSP (tail); tail = XCDR (tail))
2548 {
2549 Lisp_Object elt;
2550
2551 elt = XCAR (tail);
2552 parms[i] = Fcar (elt);
2553 values[i] = Fcdr (elt);
2554 i++;
2555 }
2556
2557 /* Now process them in reverse of specified order. */
2558 for (i--; i >= 0; i--)
2559 {
2560 prop = parms[i];
2561 val = values[i];
2562 store_frame_param (f, prop, val);
2563
2564 /* Changing the background color might change the background
2565 mode, so that we have to load new defface specs.
2566 Call frame-set-background-mode to do that. */
2567 if (EQ (prop, Qbackground_color))
2568 call1 (Qframe_set_background_mode, frame);
2569 }
2570 }
2571 return Qnil;
2572}
2573\f
2574DEFUN ("frame-char-height", Fframe_char_height, Sframe_char_height,
2575 0, 1, 0,
2576 doc: /* Height in pixels of a line in the font in frame FRAME.
2577If FRAME is omitted, the selected frame is used.
2578For a terminal frame, the value is always 1. */)
2579 (frame)
2580 Lisp_Object frame;
2581{
2582 struct frame *f;
2583
2584 if (NILP (frame))
2585 frame = selected_frame;
2586 CHECK_FRAME (frame);
2587 f = XFRAME (frame);
2588
2589#ifdef HAVE_WINDOW_SYSTEM
2590 if (FRAME_WINDOW_P (f))
2591 return make_number (x_char_height (f));
2592 else
2593#endif
2594 return make_number (1);
2595}
2596
2597
2598DEFUN ("frame-char-width", Fframe_char_width, Sframe_char_width,
2599 0, 1, 0,
2600 doc: /* Width in pixels of characters in the font in frame FRAME.
2601If FRAME is omitted, the selected frame is used.
2602On a graphical screen, the width is the standard width of the default font.
2603For a terminal screen, the value is always 1. */)
2604 (frame)
2605 Lisp_Object frame;
2606{
2607 struct frame *f;
2608
2609 if (NILP (frame))
2610 frame = selected_frame;
2611 CHECK_FRAME (frame);
2612 f = XFRAME (frame);
2613
2614#ifdef HAVE_WINDOW_SYSTEM
2615 if (FRAME_WINDOW_P (f))
2616 return make_number (x_char_width (f));
2617 else
2618#endif
2619 return make_number (1);
2620}
2621
2622DEFUN ("frame-pixel-height", Fframe_pixel_height,
2623 Sframe_pixel_height, 0, 1, 0,
2624 doc: /* Return a FRAME's height in pixels.
2625This counts only the height available for text lines,
2626not menu bars on window-system Emacs frames.
2627For a terminal frame, the result really gives the height in characters.
2628If FRAME is omitted, the selected frame is used. */)
2629 (frame)
2630 Lisp_Object frame;
2631{
2632 struct frame *f;
2633
2634 if (NILP (frame))
2635 frame = selected_frame;
2636 CHECK_FRAME (frame);
2637 f = XFRAME (frame);
2638
2639#ifdef HAVE_WINDOW_SYSTEM
2640 if (FRAME_WINDOW_P (f))
2641 return make_number (x_pixel_height (f));
2642 else
2643#endif
2644 return make_number (FRAME_LINES (f));
2645}
2646
2647DEFUN ("frame-pixel-width", Fframe_pixel_width,
2648 Sframe_pixel_width, 0, 1, 0,
2649 doc: /* Return FRAME's width in pixels.
2650For a terminal frame, the result really gives the width in characters.
2651If FRAME is omitted, the selected frame is used. */)
2652 (frame)
2653 Lisp_Object frame;
2654{
2655 struct frame *f;
2656
2657 if (NILP (frame))
2658 frame = selected_frame;
2659 CHECK_FRAME (frame);
2660 f = XFRAME (frame);
2661
2662#ifdef HAVE_WINDOW_SYSTEM
2663 if (FRAME_WINDOW_P (f))
2664 return make_number (x_pixel_width (f));
2665 else
2666#endif
2667 return make_number (FRAME_COLS (f));
2668}
2669\f
2670DEFUN ("set-frame-height", Fset_frame_height, Sset_frame_height, 2, 3, 0,
2671 doc: /* Specify that the frame FRAME has LINES lines.
2672Optional third arg non-nil means that redisplay should use LINES lines
2673but that the idea of the actual height of the frame should not be changed. */)
2674 (frame, lines, pretend)
2675 Lisp_Object frame, lines, pretend;
2676{
2677 register struct frame *f;
2678
2679 CHECK_NUMBER (lines);
2680 if (NILP (frame))
2681 frame = selected_frame;
2682 CHECK_LIVE_FRAME (frame);
2683 f = XFRAME (frame);
2684
2685 /* I think this should be done with a hook. */
2686#ifdef HAVE_WINDOW_SYSTEM
2687 if (FRAME_WINDOW_P (f))
2688 {
2689 if (XINT (lines) != FRAME_LINES (f))
2690 x_set_window_size (f, 1, FRAME_COLS (f), XINT (lines));
2691 do_pending_window_change (0);
2692 }
2693 else
2694#endif
2695 change_frame_size (f, XINT (lines), 0, !NILP (pretend), 0, 0);
2696 return Qnil;
2697}
2698
2699DEFUN ("set-frame-width", Fset_frame_width, Sset_frame_width, 2, 3, 0,
2700 doc: /* Specify that the frame FRAME has COLS columns.
2701Optional third arg non-nil means that redisplay should use COLS columns
2702but that the idea of the actual width of the frame should not be changed. */)
2703 (frame, cols, pretend)
2704 Lisp_Object frame, cols, pretend;
2705{
2706 register struct frame *f;
2707 CHECK_NUMBER (cols);
2708 if (NILP (frame))
2709 frame = selected_frame;
2710 CHECK_LIVE_FRAME (frame);
2711 f = XFRAME (frame);
2712
2713 /* I think this should be done with a hook. */
2714#ifdef HAVE_WINDOW_SYSTEM
2715 if (FRAME_WINDOW_P (f))
2716 {
2717 if (XINT (cols) != FRAME_COLS (f))
2718 x_set_window_size (f, 1, XINT (cols), FRAME_LINES (f));
2719 do_pending_window_change (0);
2720 }
2721 else
2722#endif
2723 change_frame_size (f, 0, XINT (cols), !NILP (pretend), 0, 0);
2724 return Qnil;
2725}
2726
2727DEFUN ("set-frame-size", Fset_frame_size, Sset_frame_size, 3, 3, 0,
2728 doc: /* Sets size of FRAME to COLS by ROWS, measured in characters. */)
2729 (frame, cols, rows)
2730 Lisp_Object frame, cols, rows;
2731{
2732 register struct frame *f;
2733
2734 CHECK_LIVE_FRAME (frame);
2735 CHECK_NUMBER (cols);
2736 CHECK_NUMBER (rows);
2737 f = XFRAME (frame);
2738
2739 /* I think this should be done with a hook. */
2740#ifdef HAVE_WINDOW_SYSTEM
2741 if (FRAME_WINDOW_P (f))
2742 {
2743 if (XINT (rows) != FRAME_LINES (f)
2744 || XINT (cols) != FRAME_COLS (f)
2745 || f->new_text_lines || f->new_text_cols)
2746 x_set_window_size (f, 1, XINT (cols), XINT (rows));
2747 do_pending_window_change (0);
2748 }
2749 else
2750#endif
2751 change_frame_size (f, XINT (rows), XINT (cols), 0, 0, 0);
2752
2753 return Qnil;
2754}
2755
2756DEFUN ("set-frame-position", Fset_frame_position,
2757 Sset_frame_position, 3, 3, 0,
2758 doc: /* Sets position of FRAME in pixels to XOFFSET by YOFFSET.
2759This is actually the position of the upper left corner of the frame.
2760Negative values for XOFFSET or YOFFSET are interpreted relative to
2761the rightmost or bottommost possible position (that stays within the screen). */)
2762 (frame, xoffset, yoffset)
2763 Lisp_Object frame, xoffset, yoffset;
2764{
2765 register struct frame *f;
2766
2767 CHECK_LIVE_FRAME (frame);
2768 CHECK_NUMBER (xoffset);
2769 CHECK_NUMBER (yoffset);
2770 f = XFRAME (frame);
2771
2772 /* I think this should be done with a hook. */
2773#ifdef HAVE_WINDOW_SYSTEM
2774 if (FRAME_WINDOW_P (f))
2775 x_set_offset (f, XINT (xoffset), XINT (yoffset), 1);
2776#endif
2777
2778 return Qt;
2779}
2780
2781\f
2782/***********************************************************************
2783 Frame Parameters
2784 ***********************************************************************/
2785
2786/* Connect the frame-parameter names for X frames
2787 to the ways of passing the parameter values to the window system.
2788
2789 The name of a parameter, as a Lisp symbol,
2790 has an `x-frame-parameter' property which is an integer in Lisp
2791 that is an index in this table. */
2792
2793struct frame_parm_table {
2794 char *name;
2795 Lisp_Object *variable;
2796};
2797
2798static struct frame_parm_table frame_parms[] =
2799{
2800 {"auto-raise", &Qauto_raise},
2801 {"auto-lower", &Qauto_lower},
2802 {"background-color", 0},
2803 {"border-color", &Qborder_color},
2804 {"border-width", &Qborder_width},
2805 {"cursor-color", &Qcursor_color},
2806 {"cursor-type", &Qcursor_type},
2807 {"font", 0},
2808 {"foreground-color", 0},
2809 {"icon-name", &Qicon_name},
2810 {"icon-type", &Qicon_type},
2811 {"internal-border-width", &Qinternal_border_width},
2812 {"menu-bar-lines", &Qmenu_bar_lines},
2813 {"mouse-color", &Qmouse_color},
2814 {"name", &Qname},
2815 {"scroll-bar-width", &Qscroll_bar_width},
2816 {"title", &Qtitle},
2817 {"unsplittable", &Qunsplittable},
2818 {"vertical-scroll-bars", &Qvertical_scroll_bars},
2819 {"visibility", &Qvisibility},
2820 {"tool-bar-lines", &Qtool_bar_lines},
2821 {"scroll-bar-foreground", &Qscroll_bar_foreground},
2822 {"scroll-bar-background", &Qscroll_bar_background},
2823 {"screen-gamma", &Qscreen_gamma},
2824 {"line-spacing", &Qline_spacing},
2825 {"left-fringe", &Qleft_fringe},
2826 {"right-fringe", &Qright_fringe},
2827 {"wait-for-wm", &Qwait_for_wm},
2828 {"fullscreen", &Qfullscreen},
2829 {"font-backend", &Qfont_backend}
2830};
2831
2832#ifdef HAVE_WINDOW_SYSTEM
2833
2834extern Lisp_Object Qbox;
2835extern Lisp_Object Qtop;
2836
2837/* Calculate fullscreen size. Return in *TOP_POS and *LEFT_POS the
2838 wanted positions of the WM window (not Emacs window).
2839 Return in *WIDTH and *HEIGHT the wanted width and height of Emacs
2840 window (FRAME_X_WINDOW).
2841 */
2842
2843void
2844x_fullscreen_adjust (f, width, height, top_pos, left_pos)
2845 struct frame *f;
2846 int *width;
2847 int *height;
2848 int *top_pos;
2849 int *left_pos;
2850{
2851 int newwidth = FRAME_COLS (f);
2852 int newheight = FRAME_LINES (f);
2853
2854 *top_pos = f->top_pos;
2855 *left_pos = f->left_pos;
2856
2857 if (f->want_fullscreen & FULLSCREEN_HEIGHT)
2858 {
2859 int ph;
2860
2861 ph = FRAME_X_DISPLAY_INFO (f)->height;
2862 newheight = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, ph);
2863 ph = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, newheight) - f->y_pixels_diff;
2864 newheight = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, ph);
2865 *top_pos = 0;
2866 }
2867
2868 if (f->want_fullscreen & FULLSCREEN_WIDTH)
2869 {
2870 int pw;
2871
2872 pw = FRAME_X_DISPLAY_INFO (f)->width;
2873 newwidth = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, pw);
2874 pw = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, newwidth) - f->x_pixels_diff;
2875 newwidth = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, pw);
2876 *left_pos = 0;
2877 }
2878
2879 *width = newwidth;
2880 *height = newheight;
2881}
2882
2883
2884/* Change the parameters of frame F as specified by ALIST.
2885 If a parameter is not specially recognized, do nothing special;
2886 otherwise call the `x_set_...' function for that parameter.
2887 Except for certain geometry properties, always call store_frame_param
2888 to store the new value in the parameter alist. */
2889
2890void
2891x_set_frame_parameters (f, alist)
2892 FRAME_PTR f;
2893 Lisp_Object alist;
2894{
2895 Lisp_Object tail;
2896
2897 /* If both of these parameters are present, it's more efficient to
2898 set them both at once. So we wait until we've looked at the
2899 entire list before we set them. */
2900 int width, height;
2901
2902 /* Same here. */
2903 Lisp_Object left, top;
2904
2905 /* Same with these. */
2906 Lisp_Object icon_left, icon_top;
2907
2908 /* Record in these vectors all the parms specified. */
2909 Lisp_Object *parms;
2910 Lisp_Object *values;
2911 int i, p;
2912 int left_no_change = 0, top_no_change = 0;
2913 int icon_left_no_change = 0, icon_top_no_change = 0;
2914 int fullscreen_is_being_set = 0;
2915
2916 struct gcpro gcpro1, gcpro2;
2917
2918 i = 0;
2919 for (tail = alist; CONSP (tail); tail = Fcdr (tail))
2920 i++;
2921
2922 parms = (Lisp_Object *) alloca (i * sizeof (Lisp_Object));
2923 values = (Lisp_Object *) alloca (i * sizeof (Lisp_Object));
2924
2925 /* Extract parm names and values into those vectors. */
2926
2927 i = 0;
2928 for (tail = alist; CONSP (tail); tail = XCDR (tail))
2929 {
2930 Lisp_Object elt;
2931
2932 elt = XCAR (tail);
2933 parms[i] = Fcar (elt);
2934 values[i] = Fcdr (elt);
2935 i++;
2936 }
2937 /* TAIL and ALIST are not used again below here. */
2938 alist = tail = Qnil;
2939
2940 GCPRO2 (*parms, *values);
2941 gcpro1.nvars = i;
2942 gcpro2.nvars = i;
2943
2944 /* There is no need to gcpro LEFT, TOP, ICON_LEFT, or ICON_TOP,
2945 because their values appear in VALUES and strings are not valid. */
2946 top = left = Qunbound;
2947 icon_left = icon_top = Qunbound;
2948
2949 /* Provide default values for HEIGHT and WIDTH. */
2950 width = (f->new_text_cols ? f->new_text_cols : FRAME_COLS (f));
2951 height = (f->new_text_lines ? f->new_text_lines : FRAME_LINES (f));
2952
2953 /* Process foreground_color and background_color before anything else.
2954 They are independent of other properties, but other properties (e.g.,
2955 cursor_color) are dependent upon them. */
2956 /* Process default font as well, since fringe widths depends on it. */
2957 /* Also, process fullscreen, width and height depend upon that */
2958 for (p = 0; p < i; p++)
2959 {
2960 Lisp_Object prop, val;
2961
2962 prop = parms[p];
2963 val = values[p];
2964 if (EQ (prop, Qforeground_color)
2965 || EQ (prop, Qbackground_color)
2966 || EQ (prop, Qfont)
2967 || EQ (prop, Qfullscreen))
2968 {
2969 register Lisp_Object param_index, old_value;
2970 int count = SPECPDL_INDEX ();
2971
2972 old_value = get_frame_param (f, prop);
2973 fullscreen_is_being_set |= EQ (prop, Qfullscreen);
2974
2975 if (NILP (Fequal (val, old_value)))
2976 {
2977 /* For :font attributes, the frame_parm_handler
2978 x_set_font calls `face-set-after-frame-default'.
2979 Unless we bind inhibit-face-set-after-frame-default
2980 here, this would reset the :font attribute that we
2981 just applied to the default value for new faces. */
2982 specbind (Qinhibit_face_set_after_frame_default, Qt);
2983
2984 store_frame_param (f, prop, val);
2985
2986 param_index = Fget (prop, Qx_frame_parameter);
2987 if (NATNUMP (param_index)
2988 && (XFASTINT (param_index)
2989 < sizeof (frame_parms)/sizeof (frame_parms[0]))
2990 && FRAME_RIF (f)->frame_parm_handlers[XINT (param_index)])
2991 (*(FRAME_RIF (f)->frame_parm_handlers[XINT (param_index)])) (f, val, old_value);
2992 unbind_to (count, Qnil);
2993 }
2994 }
2995 }
2996
2997 /* Now process them in reverse of specified order. */
2998 for (i--; i >= 0; i--)
2999 {
3000 Lisp_Object prop, val;
3001
3002 prop = parms[i];
3003 val = values[i];
3004
3005 if (EQ (prop, Qwidth) && NATNUMP (val))
3006 width = XFASTINT (val);
3007 else if (EQ (prop, Qheight) && NATNUMP (val))
3008 height = XFASTINT (val);
3009 else if (EQ (prop, Qtop))
3010 top = val;
3011 else if (EQ (prop, Qleft))
3012 left = val;
3013 else if (EQ (prop, Qicon_top))
3014 icon_top = val;
3015 else if (EQ (prop, Qicon_left))
3016 icon_left = val;
3017 else if (EQ (prop, Qforeground_color)
3018 || EQ (prop, Qbackground_color)
3019 || EQ (prop, Qfont)
3020 || EQ (prop, Qfullscreen))
3021 /* Processed above. */
3022 continue;
3023 else
3024 {
3025 register Lisp_Object param_index, old_value;
3026
3027 old_value = get_frame_param (f, prop);
3028
3029 store_frame_param (f, prop, val);
3030
3031 param_index = Fget (prop, Qx_frame_parameter);
3032 if (NATNUMP (param_index)
3033 && (XFASTINT (param_index)
3034 < sizeof (frame_parms)/sizeof (frame_parms[0]))
3035 && FRAME_RIF (f)->frame_parm_handlers[XINT (param_index)])
3036 (*(FRAME_RIF (f)->frame_parm_handlers[XINT (param_index)])) (f, val, old_value);
3037 }
3038 }
3039
3040 /* Don't die if just one of these was set. */
3041 if (EQ (left, Qunbound))
3042 {
3043 left_no_change = 1;
3044 if (f->left_pos < 0)
3045 left = Fcons (Qplus, Fcons (make_number (f->left_pos), Qnil));
3046 else
3047 XSETINT (left, f->left_pos);
3048 }
3049 if (EQ (top, Qunbound))
3050 {
3051 top_no_change = 1;
3052 if (f->top_pos < 0)
3053 top = Fcons (Qplus, Fcons (make_number (f->top_pos), Qnil));
3054 else
3055 XSETINT (top, f->top_pos);
3056 }
3057
3058 /* If one of the icon positions was not set, preserve or default it. */
3059 if (EQ (icon_left, Qunbound) || ! INTEGERP (icon_left))
3060 {
3061 icon_left_no_change = 1;
3062 icon_left = Fcdr (Fassq (Qicon_left, f->param_alist));
3063 if (NILP (icon_left))
3064 XSETINT (icon_left, 0);
3065 }
3066 if (EQ (icon_top, Qunbound) || ! INTEGERP (icon_top))
3067 {
3068 icon_top_no_change = 1;
3069 icon_top = Fcdr (Fassq (Qicon_top, f->param_alist));
3070 if (NILP (icon_top))
3071 XSETINT (icon_top, 0);
3072 }
3073
3074 if (FRAME_VISIBLE_P (f) && fullscreen_is_being_set)
3075 {
3076 /* If the frame is visible already and the fullscreen parameter is
3077 being set, it is too late to set WM manager hints to specify
3078 size and position.
3079 Here we first get the width, height and position that applies to
3080 fullscreen. We then move the frame to the appropriate
3081 position. Resize of the frame is taken care of in the code after
3082 this if-statement. */
3083 int new_left, new_top;
3084
3085 x_fullscreen_adjust (f, &width, &height, &new_top, &new_left);
3086 if (new_top != f->top_pos || new_left != f->left_pos)
3087 x_set_offset (f, new_left, new_top, 1);
3088 }
3089
3090 /* Don't set these parameters unless they've been explicitly
3091 specified. The window might be mapped or resized while we're in
3092 this function, and we don't want to override that unless the lisp
3093 code has asked for it.
3094
3095 Don't set these parameters unless they actually differ from the
3096 window's current parameters; the window may not actually exist
3097 yet. */
3098 {
3099 Lisp_Object frame;
3100
3101 check_frame_size (f, &height, &width);
3102
3103 XSETFRAME (frame, f);
3104
3105 if (width != FRAME_COLS (f)
3106 || height != FRAME_LINES (f)
3107 || f->new_text_lines || f->new_text_cols)
3108 Fset_frame_size (frame, make_number (width), make_number (height));
3109
3110 if ((!NILP (left) || !NILP (top))
3111 && ! (left_no_change && top_no_change)
3112 && ! (NUMBERP (left) && XINT (left) == f->left_pos
3113 && NUMBERP (top) && XINT (top) == f->top_pos))
3114 {
3115 int leftpos = 0;
3116 int toppos = 0;
3117
3118 /* Record the signs. */
3119 f->size_hint_flags &= ~ (XNegative | YNegative);
3120 if (EQ (left, Qminus))
3121 f->size_hint_flags |= XNegative;
3122 else if (INTEGERP (left))
3123 {
3124 leftpos = XINT (left);
3125 if (leftpos < 0)
3126 f->size_hint_flags |= XNegative;
3127 }
3128 else if (CONSP (left) && EQ (XCAR (left), Qminus)
3129 && CONSP (XCDR (left))
3130 && INTEGERP (XCAR (XCDR (left))))
3131 {
3132 leftpos = - XINT (XCAR (XCDR (left)));
3133 f->size_hint_flags |= XNegative;
3134 }
3135 else if (CONSP (left) && EQ (XCAR (left), Qplus)
3136 && CONSP (XCDR (left))
3137 && INTEGERP (XCAR (XCDR (left))))
3138 {
3139 leftpos = XINT (XCAR (XCDR (left)));
3140 }
3141
3142 if (EQ (top, Qminus))
3143 f->size_hint_flags |= YNegative;
3144 else if (INTEGERP (top))
3145 {
3146 toppos = XINT (top);
3147 if (toppos < 0)
3148 f->size_hint_flags |= YNegative;
3149 }
3150 else if (CONSP (top) && EQ (XCAR (top), Qminus)
3151 && CONSP (XCDR (top))
3152 && INTEGERP (XCAR (XCDR (top))))
3153 {
3154 toppos = - XINT (XCAR (XCDR (top)));
3155 f->size_hint_flags |= YNegative;
3156 }
3157 else if (CONSP (top) && EQ (XCAR (top), Qplus)
3158 && CONSP (XCDR (top))
3159 && INTEGERP (XCAR (XCDR (top))))
3160 {
3161 toppos = XINT (XCAR (XCDR (top)));
3162 }
3163
3164
3165 /* Store the numeric value of the position. */
3166 f->top_pos = toppos;
3167 f->left_pos = leftpos;
3168
3169 f->win_gravity = NorthWestGravity;
3170
3171 /* Actually set that position, and convert to absolute. */
3172 x_set_offset (f, leftpos, toppos, -1);
3173 }
3174
3175 if ((!NILP (icon_left) || !NILP (icon_top))
3176 && ! (icon_left_no_change && icon_top_no_change))
3177 x_wm_set_icon_position (f, XINT (icon_left), XINT (icon_top));
3178 }
3179
3180 UNGCPRO;
3181}
3182
3183
3184/* Insert a description of internally-recorded parameters of frame X
3185 into the parameter alist *ALISTPTR that is to be given to the user.
3186 Only parameters that are specific to the X window system
3187 and whose values are not correctly recorded in the frame's
3188 param_alist need to be considered here. */
3189
3190void
3191x_report_frame_params (f, alistptr)
3192 struct frame *f;
3193 Lisp_Object *alistptr;
3194{
3195 char buf[16];
3196 Lisp_Object tem;
3197
3198 /* Represent negative positions (off the top or left screen edge)
3199 in a way that Fmodify_frame_parameters will understand correctly. */
3200 XSETINT (tem, f->left_pos);
3201 if (f->left_pos >= 0)
3202 store_in_alist (alistptr, Qleft, tem);
3203 else
3204 store_in_alist (alistptr, Qleft, Fcons (Qplus, Fcons (tem, Qnil)));
3205
3206 XSETINT (tem, f->top_pos);
3207 if (f->top_pos >= 0)
3208 store_in_alist (alistptr, Qtop, tem);
3209 else
3210 store_in_alist (alistptr, Qtop, Fcons (Qplus, Fcons (tem, Qnil)));
3211
3212 store_in_alist (alistptr, Qborder_width,
3213 make_number (f->border_width));
3214 store_in_alist (alistptr, Qinternal_border_width,
3215 make_number (FRAME_INTERNAL_BORDER_WIDTH (f)));
3216 store_in_alist (alistptr, Qleft_fringe,
3217 make_number (FRAME_LEFT_FRINGE_WIDTH (f)));
3218 store_in_alist (alistptr, Qright_fringe,
3219 make_number (FRAME_RIGHT_FRINGE_WIDTH (f)));
3220 store_in_alist (alistptr, Qscroll_bar_width,
3221 (! FRAME_HAS_VERTICAL_SCROLL_BARS (f)
3222 ? make_number (0)
3223 : FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0
3224 ? make_number (FRAME_CONFIG_SCROLL_BAR_WIDTH (f))
3225 /* nil means "use default width"
3226 for non-toolkit scroll bar.
3227 ruler-mode.el depends on this. */
3228 : Qnil));
3229 sprintf (buf, "%ld", (long) FRAME_X_WINDOW (f));
3230 store_in_alist (alistptr, Qwindow_id,
3231 build_string (buf));
3232#ifdef HAVE_X_WINDOWS
3233#ifdef USE_X_TOOLKIT
3234 /* Tooltip frame may not have this widget. */
3235 if (FRAME_X_OUTPUT (f)->widget)
3236#endif
3237 sprintf (buf, "%ld", (long) FRAME_OUTER_WINDOW (f));
3238 store_in_alist (alistptr, Qouter_window_id,
3239 build_string (buf));
3240#endif
3241 store_in_alist (alistptr, Qicon_name, f->icon_name);
3242 FRAME_SAMPLE_VISIBILITY (f);
3243 store_in_alist (alistptr, Qvisibility,
3244 (FRAME_VISIBLE_P (f) ? Qt
3245 : FRAME_ICONIFIED_P (f) ? Qicon : Qnil));
3246 store_in_alist (alistptr, Qdisplay,
3247 XCAR (FRAME_X_DISPLAY_INFO (f)->name_list_element));
3248
3249 if (FRAME_X_OUTPUT (f)->parent_desc == FRAME_X_DISPLAY_INFO (f)->root_window)
3250 tem = Qnil;
3251 else
3252 XSETFASTINT (tem, FRAME_X_OUTPUT (f)->parent_desc);
3253 store_in_alist (alistptr, Qexplicit_name, (f->explicit_name ? Qt : Qnil));
3254 store_in_alist (alistptr, Qparent_id, tem);
3255}
3256
3257
3258/* Change the `fullscreen' frame parameter of frame F. OLD_VALUE is
3259 the previous value of that parameter, NEW_VALUE is the new value. */
3260
3261void
3262x_set_fullscreen (f, new_value, old_value)
3263 struct frame *f;
3264 Lisp_Object new_value, old_value;
3265{
3266 if (NILP (new_value))
3267 f->want_fullscreen = FULLSCREEN_NONE;
3268 else if (EQ (new_value, Qfullboth))
3269 f->want_fullscreen = FULLSCREEN_BOTH;
3270 else if (EQ (new_value, Qfullwidth))
3271 f->want_fullscreen = FULLSCREEN_WIDTH;
3272 else if (EQ (new_value, Qfullheight))
3273 f->want_fullscreen = FULLSCREEN_HEIGHT;
3274
3275 if (FRAME_TERMINAL (f)->fullscreen_hook != NULL)
3276 FRAME_TERMINAL (f)->fullscreen_hook (f);
3277}
3278
3279
3280/* Change the `line-spacing' frame parameter of frame F. OLD_VALUE is
3281 the previous value of that parameter, NEW_VALUE is the new value. */
3282
3283void
3284x_set_line_spacing (f, new_value, old_value)
3285 struct frame *f;
3286 Lisp_Object new_value, old_value;
3287{
3288 if (NILP (new_value))
3289 f->extra_line_spacing = 0;
3290 else if (NATNUMP (new_value))
3291 f->extra_line_spacing = XFASTINT (new_value);
3292 else
3293 signal_error ("Invalid line-spacing", new_value);
3294 if (FRAME_VISIBLE_P (f))
3295 redraw_frame (f);
3296}
3297
3298
3299/* Change the `screen-gamma' frame parameter of frame F. OLD_VALUE is
3300 the previous value of that parameter, NEW_VALUE is the new value. */
3301
3302void
3303x_set_screen_gamma (f, new_value, old_value)
3304 struct frame *f;
3305 Lisp_Object new_value, old_value;
3306{
3307 Lisp_Object bgcolor;
3308
3309 if (NILP (new_value))
3310 f->gamma = 0;
3311 else if (NUMBERP (new_value) && XFLOATINT (new_value) > 0)
3312 /* The value 0.4545 is the normal viewing gamma. */
3313 f->gamma = 1.0 / (0.4545 * XFLOATINT (new_value));
3314 else
3315 signal_error ("Invalid screen-gamma", new_value);
3316
3317 /* Apply the new gamma value to the frame background. */
3318 bgcolor = Fassq (Qbackground_color, f->param_alist);
3319 if (CONSP (bgcolor) && (bgcolor = XCDR (bgcolor), STRINGP (bgcolor)))
3320 {
3321 Lisp_Object index = Fget (Qbackground_color, Qx_frame_parameter);
3322 if (NATNUMP (index)
3323 && (XFASTINT (index)
3324 < sizeof (frame_parms)/sizeof (frame_parms[0]))
3325 && FRAME_RIF (f)->frame_parm_handlers[XFASTINT (index)])
3326 (*FRAME_RIF (f)->frame_parm_handlers[XFASTINT (index)])
3327 (f, bgcolor, Qnil);
3328 }
3329
3330 Fclear_face_cache (Qnil);
3331}
3332
3333
3334void
3335x_set_font (f, arg, oldval)
3336 struct frame *f;
3337 Lisp_Object arg, oldval;
3338{
3339 Lisp_Object frame;
3340 int fontset = -1;
3341 Lisp_Object font_object;
3342
3343 /* Set the frame parameter back to the old value because we mail
3344 fail to use ARG as the new parameter value. */
3345 store_frame_param (f, Qfont, oldval);
3346
3347 /* ARG is a fontset name, a font name, or a font object.
3348 In the last case, this function never fail. */
3349 if (STRINGP (arg))
3350 {
3351 fontset = fs_query_fontset (arg, 0);
3352 if (fontset < 0)
3353 {
3354 font_object = font_open_by_name (f, SDATA (arg));
3355 if (NILP (font_object))
3356 error ("Font `%s' is not defined", SDATA (arg));
3357 arg = AREF (font_object, FONT_NAME_INDEX);
3358 }
3359 else if (fontset > 0)
3360 {
3361 Lisp_Object ascii_font = fontset_ascii (fontset);
3362
3363 font_object = font_open_by_name (f, SDATA (ascii_font));
3364 if (NILP (font_object))
3365 error ("Font `%s' is not defined", SDATA (arg));
3366 arg = fontset_name (fontset);
3367 }
3368 else
3369 error ("The default fontset can't be used for a frame font");
3370 }
3371 else if (FONT_OBJECT_P (arg))
3372 {
3373 font_object = arg;
3374 /* This is store the XLFD font name in the frame parameter for
3375 backward compatiblity. We should store the font-object
3376 itself in the future. */
3377 arg = AREF (font_object, FONT_NAME_INDEX);
3378 }
3379 else
3380 signal_error ("Invalid font", arg);
3381
3382 if (! NILP (Fequal (font_object, oldval)))
3383 return;
3384 x_new_font (f, font_object, fontset);
3385 store_frame_param (f, Qfont, arg);
3386 /* Recalculate toolbar height. */
3387 f->n_tool_bar_rows = 0;
3388 /* Ensure we redraw it. */
3389 clear_current_matrices (f);
3390
3391 recompute_basic_faces (f);
3392
3393 do_pending_window_change (0);
3394
3395 /* Don't call `face-set-after-frame-default' when faces haven't been
3396 initialized yet. This is the case when called from
3397 Fx_create_frame. In that case, the X widget or window doesn't
3398 exist either, and we can end up in x_report_frame_params with a
3399 null widget which gives a segfault. */
3400 if (FRAME_FACE_CACHE (f))
3401 {
3402 XSETFRAME (frame, f);
3403 call1 (Qface_set_after_frame_default, frame);
3404 }
3405}
3406
3407
3408void
3409x_set_font_backend (f, new_value, old_value)
3410 struct frame *f;
3411 Lisp_Object new_value, old_value;
3412{
3413 if (! NILP (new_value)
3414 && !CONSP (new_value))
3415 {
3416 char *p0, *p1;
3417
3418 CHECK_STRING (new_value);
3419 p0 = p1 = SDATA (new_value);
3420 new_value = Qnil;
3421 while (*p0)
3422 {
3423 while (*p1 && *p1 != ',') p1++;
3424 if (p0 < p1)
3425 new_value = Fcons (Fintern (make_string (p0, p1 - p0), Qnil),
3426 new_value);
3427 if (*p1)
3428 p1++;
3429 p0 = p1;
3430 }
3431 new_value = Fnreverse (new_value);
3432 }
3433
3434 if (! NILP (old_value) && ! NILP (Fequal (old_value, new_value)))
3435 return;
3436
3437 if (FRAME_FONT (f))
3438 free_all_realized_faces (Qnil);
3439
3440 new_value = font_update_drivers (f, NILP (new_value) ? Qt : new_value);
3441 if (NILP (new_value))
3442 {
3443 if (NILP (old_value))
3444 error ("No font backend available");
3445 font_update_drivers (f, old_value);
3446 error ("None of specified font backends are available");
3447 }
3448 store_frame_param (f, Qfont_backend, new_value);
3449
3450 if (FRAME_FONT (f))
3451 {
3452 Lisp_Object frame;
3453
3454 XSETFRAME (frame, f);
3455 x_set_font (f, Fframe_parameter (frame, Qfont), Qnil);
3456 ++face_change_count;
3457 ++windows_or_buffers_changed;
3458 }
3459}
3460
3461
3462void
3463x_set_fringe_width (f, new_value, old_value)
3464 struct frame *f;
3465 Lisp_Object new_value, old_value;
3466{
3467 compute_fringe_widths (f, 1);
3468}
3469
3470void
3471x_set_border_width (f, arg, oldval)
3472 struct frame *f;
3473 Lisp_Object arg, oldval;
3474{
3475 CHECK_NUMBER (arg);
3476
3477 if (XINT (arg) == f->border_width)
3478 return;
3479
3480 if (FRAME_X_WINDOW (f) != 0)
3481 error ("Cannot change the border width of a frame");
3482
3483 f->border_width = XINT (arg);
3484}
3485
3486void
3487x_set_internal_border_width (f, arg, oldval)
3488 struct frame *f;
3489 Lisp_Object arg, oldval;
3490{
3491 int old = FRAME_INTERNAL_BORDER_WIDTH (f);
3492
3493 CHECK_NUMBER (arg);
3494 FRAME_INTERNAL_BORDER_WIDTH (f) = XINT (arg);
3495 if (FRAME_INTERNAL_BORDER_WIDTH (f) < 0)
3496 FRAME_INTERNAL_BORDER_WIDTH (f) = 0;
3497
3498#ifdef USE_X_TOOLKIT
3499 if (FRAME_X_OUTPUT (f)->edit_widget)
3500 widget_store_internal_border (FRAME_X_OUTPUT (f)->edit_widget);
3501#endif
3502
3503 if (FRAME_INTERNAL_BORDER_WIDTH (f) == old)
3504 return;
3505
3506 if (FRAME_X_WINDOW (f) != 0)
3507 {
3508 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
3509 SET_FRAME_GARBAGED (f);
3510 do_pending_window_change (0);
3511 }
3512 else
3513 SET_FRAME_GARBAGED (f);
3514}
3515
3516void
3517x_set_visibility (f, value, oldval)
3518 struct frame *f;
3519 Lisp_Object value, oldval;
3520{
3521 Lisp_Object frame;
3522 XSETFRAME (frame, f);
3523
3524 if (NILP (value))
3525 Fmake_frame_invisible (frame, Qt);
3526 else if (EQ (value, Qicon))
3527 Ficonify_frame (frame);
3528 else
3529 Fmake_frame_visible (frame);
3530}
3531
3532void
3533x_set_autoraise (f, arg, oldval)
3534 struct frame *f;
3535 Lisp_Object arg, oldval;
3536{
3537 f->auto_raise = !EQ (Qnil, arg);
3538}
3539
3540void
3541x_set_autolower (f, arg, oldval)
3542 struct frame *f;
3543 Lisp_Object arg, oldval;
3544{
3545 f->auto_lower = !EQ (Qnil, arg);
3546}
3547
3548void
3549x_set_unsplittable (f, arg, oldval)
3550 struct frame *f;
3551 Lisp_Object arg, oldval;
3552{
3553 f->no_split = !NILP (arg);
3554}
3555
3556void
3557x_set_vertical_scroll_bars (f, arg, oldval)
3558 struct frame *f;
3559 Lisp_Object arg, oldval;
3560{
3561 if ((EQ (arg, Qleft) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f))
3562 || (EQ (arg, Qright) && FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f))
3563 || (NILP (arg) && FRAME_HAS_VERTICAL_SCROLL_BARS (f))
3564 || (!NILP (arg) && ! FRAME_HAS_VERTICAL_SCROLL_BARS (f)))
3565 {
3566 FRAME_VERTICAL_SCROLL_BAR_TYPE (f)
3567 = (NILP (arg)
3568 ? vertical_scroll_bar_none
3569 : EQ (Qleft, arg)
3570 ? vertical_scroll_bar_left
3571 : EQ (Qright, arg)
3572 ? vertical_scroll_bar_right
3573 : EQ (Qleft, Vdefault_frame_scroll_bars)
3574 ? vertical_scroll_bar_left
3575 : EQ (Qright, Vdefault_frame_scroll_bars)
3576 ? vertical_scroll_bar_right
3577 : vertical_scroll_bar_none);
3578
3579 /* We set this parameter before creating the X window for the
3580 frame, so we can get the geometry right from the start.
3581 However, if the window hasn't been created yet, we shouldn't
3582 call x_set_window_size. */
3583 if (FRAME_X_WINDOW (f))
3584 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
3585 do_pending_window_change (0);
3586 }
3587}
3588
3589void
3590x_set_scroll_bar_width (f, arg, oldval)
3591 struct frame *f;
3592 Lisp_Object arg, oldval;
3593{
3594 int wid = FRAME_COLUMN_WIDTH (f);
3595
3596 if (NILP (arg))
3597 {
3598 x_set_scroll_bar_default_width (f);
3599
3600 if (FRAME_X_WINDOW (f))
3601 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
3602 do_pending_window_change (0);
3603 }
3604 else if (INTEGERP (arg) && XINT (arg) > 0
3605 && XFASTINT (arg) != FRAME_CONFIG_SCROLL_BAR_WIDTH (f))
3606 {
3607 if (XFASTINT (arg) <= 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM)
3608 XSETINT (arg, 2 * VERTICAL_SCROLL_BAR_WIDTH_TRIM + 1);
3609
3610 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = XFASTINT (arg);
3611 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (XFASTINT (arg) + wid-1) / wid;
3612 if (FRAME_X_WINDOW (f))
3613 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
3614 do_pending_window_change (0);
3615 }
3616
3617 change_frame_size (f, 0, FRAME_COLS (f), 0, 0, 0);
3618 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.hpos = 0;
3619 XWINDOW (FRAME_SELECTED_WINDOW (f))->cursor.x = 0;
3620}
3621
3622
3623
3624/* Return non-nil if frame F wants a bitmap icon. */
3625
3626Lisp_Object
3627x_icon_type (f)
3628 FRAME_PTR f;
3629{
3630 Lisp_Object tem;
3631
3632 tem = assq_no_quit (Qicon_type, f->param_alist);
3633 if (CONSP (tem))
3634 return XCDR (tem);
3635 else
3636 return Qnil;
3637}
3638
3639\f
3640/* Subroutines of creating an X frame. */
3641
3642/* Make sure that Vx_resource_name is set to a reasonable value.
3643 Fix it up, or set it to `emacs' if it is too hopeless. */
3644
3645void
3646validate_x_resource_name ()
3647{
3648 int len = 0;
3649 /* Number of valid characters in the resource name. */
3650 int good_count = 0;
3651 /* Number of invalid characters in the resource name. */
3652 int bad_count = 0;
3653 Lisp_Object new;
3654 int i;
3655
3656 if (!STRINGP (Vx_resource_class))
3657 Vx_resource_class = build_string (EMACS_CLASS);
3658
3659 if (STRINGP (Vx_resource_name))
3660 {
3661 unsigned char *p = SDATA (Vx_resource_name);
3662 int i;
3663
3664 len = SBYTES (Vx_resource_name);
3665
3666 /* Only letters, digits, - and _ are valid in resource names.
3667 Count the valid characters and count the invalid ones. */
3668 for (i = 0; i < len; i++)
3669 {
3670 int c = p[i];
3671 if (! ((c >= 'a' && c <= 'z')
3672 || (c >= 'A' && c <= 'Z')
3673 || (c >= '0' && c <= '9')
3674 || c == '-' || c == '_'))
3675 bad_count++;
3676 else
3677 good_count++;
3678 }
3679 }
3680 else
3681 /* Not a string => completely invalid. */
3682 bad_count = 5, good_count = 0;
3683
3684 /* If name is valid already, return. */
3685 if (bad_count == 0)
3686 return;
3687
3688 /* If name is entirely invalid, or nearly so, use `emacs'. */
3689 if (good_count == 0
3690 || (good_count == 1 && bad_count > 0))
3691 {
3692 Vx_resource_name = build_string ("emacs");
3693 return;
3694 }
3695
3696 /* Name is partly valid. Copy it and replace the invalid characters
3697 with underscores. */
3698
3699 Vx_resource_name = new = Fcopy_sequence (Vx_resource_name);
3700
3701 for (i = 0; i < len; i++)
3702 {
3703 int c = SREF (new, i);
3704 if (! ((c >= 'a' && c <= 'z')
3705 || (c >= 'A' && c <= 'Z')
3706 || (c >= '0' && c <= '9')
3707 || c == '-' || c == '_'))
3708 SSET (new, i, '_');
3709 }
3710}
3711
3712
3713extern char *x_get_string_resource P_ ((XrmDatabase, char *, char *));
3714extern Display_Info *check_x_display_info P_ ((Lisp_Object));
3715
3716
3717/* Get specified attribute from resource database RDB.
3718 See Fx_get_resource below for other parameters. */
3719
3720static Lisp_Object
3721xrdb_get_resource (rdb, attribute, class, component, subclass)
3722 XrmDatabase rdb;
3723 Lisp_Object attribute, class, component, subclass;
3724{
3725 register char *value;
3726 char *name_key;
3727 char *class_key;
3728
3729 CHECK_STRING (attribute);
3730 CHECK_STRING (class);
3731
3732 if (!NILP (component))
3733 CHECK_STRING (component);
3734 if (!NILP (subclass))
3735 CHECK_STRING (subclass);
3736 if (NILP (component) != NILP (subclass))
3737 error ("x-get-resource: must specify both COMPONENT and SUBCLASS or neither");
3738
3739 validate_x_resource_name ();
3740
3741 /* Allocate space for the components, the dots which separate them,
3742 and the final '\0'. Make them big enough for the worst case. */
3743 name_key = (char *) alloca (SBYTES (Vx_resource_name)
3744 + (STRINGP (component)
3745 ? SBYTES (component) : 0)
3746 + SBYTES (attribute)
3747 + 3);
3748
3749 class_key = (char *) alloca (SBYTES (Vx_resource_class)
3750 + SBYTES (class)
3751 + (STRINGP (subclass)
3752 ? SBYTES (subclass) : 0)
3753 + 3);
3754
3755 /* Start with emacs.FRAMENAME for the name (the specific one)
3756 and with `Emacs' for the class key (the general one). */
3757 strcpy (name_key, SDATA (Vx_resource_name));
3758 strcpy (class_key, SDATA (Vx_resource_class));
3759
3760 strcat (class_key, ".");
3761 strcat (class_key, SDATA (class));
3762
3763 if (!NILP (component))
3764 {
3765 strcat (class_key, ".");
3766 strcat (class_key, SDATA (subclass));
3767
3768 strcat (name_key, ".");
3769 strcat (name_key, SDATA (component));
3770 }
3771
3772 strcat (name_key, ".");
3773 strcat (name_key, SDATA (attribute));
3774
3775 value = x_get_string_resource (rdb, name_key, class_key);
3776
3777 if (value != (char *) 0)
3778 return build_string (value);
3779 else
3780 return Qnil;
3781}
3782
3783
3784DEFUN ("x-get-resource", Fx_get_resource, Sx_get_resource, 2, 4, 0,
3785 doc: /* Return the value of ATTRIBUTE, of class CLASS, from the X defaults database.
3786This uses `INSTANCE.ATTRIBUTE' as the key and `Emacs.CLASS' as the
3787class, where INSTANCE is the name under which Emacs was invoked, or
3788the name specified by the `-name' or `-rn' command-line arguments.
3789
3790The optional arguments COMPONENT and SUBCLASS add to the key and the
3791class, respectively. You must specify both of them or neither.
3792If you specify them, the key is `INSTANCE.COMPONENT.ATTRIBUTE'
3793and the class is `Emacs.CLASS.SUBCLASS'. */)
3794 (attribute, class, component, subclass)
3795 Lisp_Object attribute, class, component, subclass;
3796{
3797#ifdef HAVE_X_WINDOWS
3798 check_x ();
3799#endif
3800
3801 return xrdb_get_resource (check_x_display_info (Qnil)->xrdb,
3802 attribute, class, component, subclass);
3803}
3804
3805/* Get an X resource, like Fx_get_resource, but for display DPYINFO. */
3806
3807Lisp_Object
3808display_x_get_resource (dpyinfo, attribute, class, component, subclass)
3809 Display_Info *dpyinfo;
3810 Lisp_Object attribute, class, component, subclass;
3811{
3812 return xrdb_get_resource (dpyinfo->xrdb,
3813 attribute, class, component, subclass);
3814}
3815
3816/* Used when C code wants a resource value. */
3817
3818char *
3819x_get_resource_string (attribute, class)
3820 char *attribute, *class;
3821{
3822 char *name_key;
3823 char *class_key;
3824 struct frame *sf = SELECTED_FRAME ();
3825
3826 /* Allocate space for the components, the dots which separate them,
3827 and the final '\0'. */
3828 name_key = (char *) alloca (SBYTES (Vinvocation_name)
3829 + strlen (attribute) + 2);
3830 class_key = (char *) alloca ((sizeof (EMACS_CLASS) - 1)
3831 + strlen (class) + 2);
3832
3833 sprintf (name_key, "%s.%s", SDATA (Vinvocation_name), attribute);
3834 sprintf (class_key, "%s.%s", EMACS_CLASS, class);
3835
3836 return x_get_string_resource (FRAME_X_DISPLAY_INFO (sf)->xrdb,
3837 name_key, class_key);
3838}
3839
3840
3841/* Return the value of parameter PARAM.
3842
3843 First search ALIST, then Vdefault_frame_alist, then the X defaults
3844 database, using ATTRIBUTE as the attribute name and CLASS as its class.
3845
3846 Convert the resource to the type specified by desired_type.
3847
3848 If no default is specified, return Qunbound. If you call
3849 x_get_arg, make sure you deal with Qunbound in a reasonable way,
3850 and don't let it get stored in any Lisp-visible variables! */
3851
3852Lisp_Object
3853x_get_arg (dpyinfo, alist, param, attribute, class, type)
3854 Display_Info *dpyinfo;
3855 Lisp_Object alist, param;
3856 char *attribute;
3857 char *class;
3858 enum resource_types type;
3859{
3860 register Lisp_Object tem;
3861
3862 tem = Fassq (param, alist);
3863
3864 if (!NILP (tem))
3865 {
3866 /* If we find this parm in ALIST, clear it out
3867 so that it won't be "left over" at the end. */
3868#ifndef WINDOWSNT /* w32fns.c has not yet been changed to cope with this. */
3869 Lisp_Object tail;
3870 XSETCAR (tem, Qnil);
3871 /* In case the parameter appears more than once in the alist,
3872 clear it out. */
3873 for (tail = alist; CONSP (tail); tail = XCDR (tail))
3874 if (CONSP (XCAR (tail))
3875 && EQ (XCAR (XCAR (tail)), param))
3876 XSETCAR (XCAR (tail), Qnil);
3877#endif
3878 }
3879 else
3880 tem = Fassq (param, Vdefault_frame_alist);
3881
3882 /* If it wasn't specified in ALIST or the Lisp-level defaults,
3883 look in the X resources. */
3884 if (EQ (tem, Qnil))
3885 {
3886 if (attribute)
3887 {
3888 tem = display_x_get_resource (dpyinfo,
3889 build_string (attribute),
3890 build_string (class),
3891 Qnil, Qnil);
3892
3893 if (NILP (tem))
3894 return Qunbound;
3895
3896 switch (type)
3897 {
3898 case RES_TYPE_NUMBER:
3899 return make_number (atoi (SDATA (tem)));
3900
3901 case RES_TYPE_FLOAT:
3902 return make_float (atof (SDATA (tem)));
3903
3904 case RES_TYPE_BOOLEAN:
3905 tem = Fdowncase (tem);
3906 if (!strcmp (SDATA (tem), "on")
3907 || !strcmp (SDATA (tem), "true"))
3908 return Qt;
3909 else
3910 return Qnil;
3911
3912 case RES_TYPE_STRING:
3913 return tem;
3914
3915 case RES_TYPE_SYMBOL:
3916 /* As a special case, we map the values `true' and `on'
3917 to Qt, and `false' and `off' to Qnil. */
3918 {
3919 Lisp_Object lower;
3920 lower = Fdowncase (tem);
3921 if (!strcmp (SDATA (lower), "on")
3922 || !strcmp (SDATA (lower), "true"))
3923 return Qt;
3924 else if (!strcmp (SDATA (lower), "off")
3925 || !strcmp (SDATA (lower), "false"))
3926 return Qnil;
3927 else
3928 return Fintern (tem, Qnil);
3929 }
3930
3931 default:
3932 abort ();
3933 }
3934 }
3935 else
3936 return Qunbound;
3937 }
3938 return Fcdr (tem);
3939}
3940
3941Lisp_Object
3942x_frame_get_arg (f, alist, param, attribute, class, type)
3943 struct frame *f;
3944 Lisp_Object alist, param;
3945 char *attribute;
3946 char *class;
3947 enum resource_types type;
3948{
3949 return x_get_arg (FRAME_X_DISPLAY_INFO (f),
3950 alist, param, attribute, class, type);
3951}
3952
3953/* Like x_frame_get_arg, but also record the value in f->param_alist. */
3954
3955Lisp_Object
3956x_frame_get_and_record_arg (f, alist, param, attribute, class, type)
3957 struct frame *f;
3958 Lisp_Object alist, param;
3959 char *attribute;
3960 char *class;
3961 enum resource_types type;
3962{
3963 Lisp_Object value;
3964
3965 value = x_get_arg (FRAME_X_DISPLAY_INFO (f), alist, param,
3966 attribute, class, type);
3967 if (! NILP (value) && ! EQ (value, Qunbound))
3968 store_frame_param (f, param, value);
3969
3970 return value;
3971}
3972
3973
3974/* Record in frame F the specified or default value according to ALIST
3975 of the parameter named PROP (a Lisp symbol).
3976 If no value is specified for PROP, look for an X default for XPROP
3977 on the frame named NAME.
3978 If that is not found either, use the value DEFLT. */
3979
3980Lisp_Object
3981x_default_parameter (f, alist, prop, deflt, xprop, xclass, type)
3982 struct frame *f;
3983 Lisp_Object alist;
3984 Lisp_Object prop;
3985 Lisp_Object deflt;
3986 char *xprop;
3987 char *xclass;
3988 enum resource_types type;
3989{
3990 Lisp_Object tem;
3991
3992 tem = x_frame_get_arg (f, alist, prop, xprop, xclass, type);
3993 if (EQ (tem, Qunbound))
3994 tem = deflt;
3995 x_set_frame_parameters (f, Fcons (Fcons (prop, tem), Qnil));
3996 return tem;
3997}
3998
3999
4000
4001\f
4002DEFUN ("x-parse-geometry", Fx_parse_geometry, Sx_parse_geometry, 1, 1, 0,
4003 doc: /* Parse an X-style geometry string STRING.
4004Returns an alist of the form ((top . TOP), (left . LEFT) ... ).
4005The properties returned may include `top', `left', `height', and `width'.
4006The value of `left' or `top' may be an integer,
4007or a list (+ N) meaning N pixels relative to top/left corner,
4008or a list (- N) meaning -N pixels relative to bottom/right corner. */)
4009 (string)
4010 Lisp_Object string;
4011{
4012 int geometry, x, y;
4013 unsigned int width, height;
4014 Lisp_Object result;
4015
4016 CHECK_STRING (string);
4017
4018 geometry = XParseGeometry ((char *) SDATA (string),
4019 &x, &y, &width, &height);
4020
4021#if 0
4022 if (!!(geometry & XValue) != !!(geometry & YValue))
4023 error ("Must specify both x and y position, or neither");
4024#endif
4025
4026 result = Qnil;
4027 if (geometry & XValue)
4028 {
4029 Lisp_Object element;
4030
4031 if (x >= 0 && (geometry & XNegative))
4032 element = Fcons (Qleft, Fcons (Qminus, Fcons (make_number (-x), Qnil)));
4033 else if (x < 0 && ! (geometry & XNegative))
4034 element = Fcons (Qleft, Fcons (Qplus, Fcons (make_number (x), Qnil)));
4035 else
4036 element = Fcons (Qleft, make_number (x));
4037 result = Fcons (element, result);
4038 }
4039
4040 if (geometry & YValue)
4041 {
4042 Lisp_Object element;
4043
4044 if (y >= 0 && (geometry & YNegative))
4045 element = Fcons (Qtop, Fcons (Qminus, Fcons (make_number (-y), Qnil)));
4046 else if (y < 0 && ! (geometry & YNegative))
4047 element = Fcons (Qtop, Fcons (Qplus, Fcons (make_number (y), Qnil)));
4048 else
4049 element = Fcons (Qtop, make_number (y));
4050 result = Fcons (element, result);
4051 }
4052
4053 if (geometry & WidthValue)
4054 result = Fcons (Fcons (Qwidth, make_number (width)), result);
4055 if (geometry & HeightValue)
4056 result = Fcons (Fcons (Qheight, make_number (height)), result);
4057
4058 return result;
4059}
4060
4061/* Calculate the desired size and position of frame F.
4062 Return the flags saying which aspects were specified.
4063
4064 Also set the win_gravity and size_hint_flags of F.
4065
4066 Adjust height for toolbar if TOOLBAR_P is 1.
4067
4068 This function does not make the coordinates positive. */
4069
4070#define DEFAULT_ROWS 40
4071#define DEFAULT_COLS 80
4072
4073int
4074x_figure_window_size (f, parms, toolbar_p)
4075 struct frame *f;
4076 Lisp_Object parms;
4077 int toolbar_p;
4078{
4079 register Lisp_Object tem0, tem1, tem2;
4080 long window_prompting = 0;
4081 Display_Info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
4082
4083 /* Default values if we fall through.
4084 Actually, if that happens we should get
4085 window manager prompting. */
4086 SET_FRAME_COLS (f, DEFAULT_COLS);
4087 FRAME_LINES (f) = DEFAULT_ROWS;
4088 /* Window managers expect that if program-specified
4089 positions are not (0,0), they're intentional, not defaults. */
4090 f->top_pos = 0;
4091 f->left_pos = 0;
4092
4093 /* Ensure that old new_text_cols and new_text_lines will not override the
4094 values set here. */
4095 /* ++KFS: This was specific to W32, but seems ok for all platforms */
4096 f->new_text_cols = f->new_text_lines = 0;
4097
4098 tem0 = x_get_arg (dpyinfo, parms, Qheight, 0, 0, RES_TYPE_NUMBER);
4099 tem1 = x_get_arg (dpyinfo, parms, Qwidth, 0, 0, RES_TYPE_NUMBER);
4100 tem2 = x_get_arg (dpyinfo, parms, Quser_size, 0, 0, RES_TYPE_NUMBER);
4101 if (! EQ (tem0, Qunbound) || ! EQ (tem1, Qunbound))
4102 {
4103 if (!EQ (tem0, Qunbound))
4104 {
4105 CHECK_NUMBER (tem0);
4106 FRAME_LINES (f) = XINT (tem0);
4107 }
4108 if (!EQ (tem1, Qunbound))
4109 {
4110 CHECK_NUMBER (tem1);
4111 SET_FRAME_COLS (f, XINT (tem1));
4112 }
4113 if (!NILP (tem2) && !EQ (tem2, Qunbound))
4114 window_prompting |= USSize;
4115 else
4116 window_prompting |= PSize;
4117 }
4118
4119 f->scroll_bar_actual_width
4120 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
4121
4122 /* This used to be done _before_ calling x_figure_window_size, but
4123 since the height is reset here, this was really a no-op. I
4124 assume that moving it here does what Gerd intended (although he
4125 no longer can remember what that was... ++KFS, 2003-03-25. */
4126
4127 /* Add the tool-bar height to the initial frame height so that the
4128 user gets a text display area of the size he specified with -g or
4129 via .Xdefaults. Later changes of the tool-bar height don't
4130 change the frame size. This is done so that users can create
4131 tall Emacs frames without having to guess how tall the tool-bar
4132 will get. */
4133 if (toolbar_p && FRAME_TOOL_BAR_LINES (f))
4134 {
4135 int margin, relief, bar_height;
4136
4137 relief = (tool_bar_button_relief >= 0
4138 ? tool_bar_button_relief
4139 : DEFAULT_TOOL_BAR_BUTTON_RELIEF);
4140
4141 if (INTEGERP (Vtool_bar_button_margin)
4142 && XINT (Vtool_bar_button_margin) > 0)
4143 margin = XFASTINT (Vtool_bar_button_margin);
4144 else if (CONSP (Vtool_bar_button_margin)
4145 && INTEGERP (XCDR (Vtool_bar_button_margin))
4146 && XINT (XCDR (Vtool_bar_button_margin)) > 0)
4147 margin = XFASTINT (XCDR (Vtool_bar_button_margin));
4148 else
4149 margin = 0;
4150
4151 bar_height = DEFAULT_TOOL_BAR_IMAGE_HEIGHT + 2 * margin + 2 * relief;
4152 FRAME_LINES (f) += (bar_height + FRAME_LINE_HEIGHT (f) - 1) / FRAME_LINE_HEIGHT (f);
4153 }
4154
4155 compute_fringe_widths (f, 0);
4156
4157 FRAME_PIXEL_WIDTH (f) = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, FRAME_COLS (f));
4158 FRAME_PIXEL_HEIGHT (f) = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
4159
4160 tem0 = x_get_arg (dpyinfo, parms, Qtop, 0, 0, RES_TYPE_NUMBER);
4161 tem1 = x_get_arg (dpyinfo, parms, Qleft, 0, 0, RES_TYPE_NUMBER);
4162 tem2 = x_get_arg (dpyinfo, parms, Quser_position, 0, 0, RES_TYPE_NUMBER);
4163 if (! EQ (tem0, Qunbound) || ! EQ (tem1, Qunbound))
4164 {
4165 if (EQ (tem0, Qminus))
4166 {
4167 f->top_pos = 0;
4168 window_prompting |= YNegative;
4169 }
4170 else if (CONSP (tem0) && EQ (XCAR (tem0), Qminus)
4171 && CONSP (XCDR (tem0))
4172 && INTEGERP (XCAR (XCDR (tem0))))
4173 {
4174 f->top_pos = - XINT (XCAR (XCDR (tem0)));
4175 window_prompting |= YNegative;
4176 }
4177 else if (CONSP (tem0) && EQ (XCAR (tem0), Qplus)
4178 && CONSP (XCDR (tem0))
4179 && INTEGERP (XCAR (XCDR (tem0))))
4180 {
4181 f->top_pos = XINT (XCAR (XCDR (tem0)));
4182 }
4183 else if (EQ (tem0, Qunbound))
4184 f->top_pos = 0;
4185 else
4186 {
4187 CHECK_NUMBER (tem0);
4188 f->top_pos = XINT (tem0);
4189 if (f->top_pos < 0)
4190 window_prompting |= YNegative;
4191 }
4192
4193 if (EQ (tem1, Qminus))
4194 {
4195 f->left_pos = 0;
4196 window_prompting |= XNegative;
4197 }
4198 else if (CONSP (tem1) && EQ (XCAR (tem1), Qminus)
4199 && CONSP (XCDR (tem1))
4200 && INTEGERP (XCAR (XCDR (tem1))))
4201 {
4202 f->left_pos = - XINT (XCAR (XCDR (tem1)));
4203 window_prompting |= XNegative;
4204 }
4205 else if (CONSP (tem1) && EQ (XCAR (tem1), Qplus)
4206 && CONSP (XCDR (tem1))
4207 && INTEGERP (XCAR (XCDR (tem1))))
4208 {
4209 f->left_pos = XINT (XCAR (XCDR (tem1)));
4210 }
4211 else if (EQ (tem1, Qunbound))
4212 f->left_pos = 0;
4213 else
4214 {
4215 CHECK_NUMBER (tem1);
4216 f->left_pos = XINT (tem1);
4217 if (f->left_pos < 0)
4218 window_prompting |= XNegative;
4219 }
4220
4221 if (!NILP (tem2) && ! EQ (tem2, Qunbound))
4222 window_prompting |= USPosition;
4223 else
4224 window_prompting |= PPosition;
4225 }
4226
4227 if (f->want_fullscreen != FULLSCREEN_NONE)
4228 {
4229 int left, top;
4230 int width, height;
4231
4232 /* It takes both for some WM:s to place it where we want */
4233 window_prompting |= USPosition | PPosition;
4234 x_fullscreen_adjust (f, &width, &height, &top, &left);
4235 FRAME_COLS (f) = width;
4236 FRAME_LINES (f) = height;
4237 FRAME_PIXEL_WIDTH (f) = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, width);
4238 FRAME_PIXEL_HEIGHT (f) = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, height);
4239 f->left_pos = left;
4240 f->top_pos = top;
4241 }
4242
4243 if (window_prompting & XNegative)
4244 {
4245 if (window_prompting & YNegative)
4246 f->win_gravity = SouthEastGravity;
4247 else
4248 f->win_gravity = NorthEastGravity;
4249 }
4250 else
4251 {
4252 if (window_prompting & YNegative)
4253 f->win_gravity = SouthWestGravity;
4254 else
4255 f->win_gravity = NorthWestGravity;
4256 }
4257
4258 f->size_hint_flags = window_prompting;
4259
4260 return window_prompting;
4261}
4262
4263
4264
4265#endif /* HAVE_WINDOW_SYSTEM */
4266
4267
4268\f
4269/***********************************************************************
4270 Initialization
4271 ***********************************************************************/
4272
4273void
4274syms_of_frame ()
4275{
4276 Qframep = intern ("framep");
4277 staticpro (&Qframep);
4278 Qframe_live_p = intern ("frame-live-p");
4279 staticpro (&Qframe_live_p);
4280 Qexplicit_name = intern ("explicit-name");
4281 staticpro (&Qexplicit_name);
4282 Qheight = intern ("height");
4283 staticpro (&Qheight);
4284 Qicon = intern ("icon");
4285 staticpro (&Qicon);
4286 Qminibuffer = intern ("minibuffer");
4287 staticpro (&Qminibuffer);
4288 Qmodeline = intern ("modeline");
4289 staticpro (&Qmodeline);
4290 Qonly = intern ("only");
4291 staticpro (&Qonly);
4292 Qwidth = intern ("width");
4293 staticpro (&Qwidth);
4294 Qgeometry = intern ("geometry");
4295 staticpro (&Qgeometry);
4296 Qicon_left = intern ("icon-left");
4297 staticpro (&Qicon_left);
4298 Qicon_top = intern ("icon-top");
4299 staticpro (&Qicon_top);
4300 Qleft = intern ("left");
4301 staticpro (&Qleft);
4302 Qright = intern ("right");
4303 staticpro (&Qright);
4304 Quser_position = intern ("user-position");
4305 staticpro (&Quser_position);
4306 Quser_size = intern ("user-size");
4307 staticpro (&Quser_size);
4308 Qwindow_id = intern ("window-id");
4309 staticpro (&Qwindow_id);
4310#ifdef HAVE_X_WINDOWS
4311 Qouter_window_id = intern ("outer-window-id");
4312 staticpro (&Qouter_window_id);
4313#endif
4314 Qparent_id = intern ("parent-id");
4315 staticpro (&Qparent_id);
4316 Qx = intern ("x");
4317 staticpro (&Qx);
4318 Qw32 = intern ("w32");
4319 staticpro (&Qw32);
4320 Qpc = intern ("pc");
4321 staticpro (&Qpc);
4322 Qmac = intern ("mac");
4323 staticpro (&Qmac);
4324 Qvisible = intern ("visible");
4325 staticpro (&Qvisible);
4326 Qbuffer_predicate = intern ("buffer-predicate");
4327 staticpro (&Qbuffer_predicate);
4328 Qbuffer_list = intern ("buffer-list");
4329 staticpro (&Qbuffer_list);
4330 Qburied_buffer_list = intern ("buried-buffer-list");
4331 staticpro (&Qburied_buffer_list);
4332 Qdisplay_type = intern ("display-type");
4333 staticpro (&Qdisplay_type);
4334 Qbackground_mode = intern ("background-mode");
4335 staticpro (&Qbackground_mode);
4336 Qnoelisp = intern ("noelisp");
4337 staticpro (&Qnoelisp);
4338 Qtty_color_mode = intern ("tty-color-mode");
4339 staticpro (&Qtty_color_mode);
4340 Qtty = intern ("tty");
4341 staticpro (&Qtty);
4342 Qtty_type = intern ("tty-type");
4343 staticpro (&Qtty_type);
4344
4345 Qface_set_after_frame_default = intern ("face-set-after-frame-default");
4346 staticpro (&Qface_set_after_frame_default);
4347
4348 Qinhibit_face_set_after_frame_default
4349 = intern ("inhibit-face-set-after-frame-default");
4350 staticpro (&Qinhibit_face_set_after_frame_default);
4351
4352 Qfullwidth = intern ("fullwidth");
4353 staticpro (&Qfullwidth);
4354 Qfullheight = intern ("fullheight");
4355 staticpro (&Qfullheight);
4356 Qfullboth = intern ("fullboth");
4357 staticpro (&Qfullboth);
4358 Qx_resource_name = intern ("x-resource-name");
4359 staticpro (&Qx_resource_name);
4360
4361 Qx_frame_parameter = intern ("x-frame-parameter");
4362 staticpro (&Qx_frame_parameter);
4363
4364 Qterminal = intern ("terminal");
4365 staticpro (&Qterminal);
4366 Qterminal_live_p = intern ("terminal-live-p");
4367 staticpro (&Qterminal_live_p);
4368
4369 {
4370 int i;
4371
4372 for (i = 0; i < sizeof (frame_parms) / sizeof (frame_parms[0]); i++)
4373 {
4374 Lisp_Object v = intern (frame_parms[i].name);
4375 if (frame_parms[i].variable)
4376 {
4377 *frame_parms[i].variable = v;
4378 staticpro (frame_parms[i].variable);
4379 }
4380 Fput (v, Qx_frame_parameter, make_number (i));
4381 }
4382 }
4383
4384#ifdef HAVE_WINDOW_SYSTEM
4385 DEFVAR_LISP ("x-resource-name", &Vx_resource_name,
4386 doc: /* The name Emacs uses to look up X resources.
4387`x-get-resource' uses this as the first component of the instance name
4388when requesting resource values.
4389Emacs initially sets `x-resource-name' to the name under which Emacs
4390was invoked, or to the value specified with the `-name' or `-rn'
4391switches, if present.
4392
4393It may be useful to bind this variable locally around a call
4394to `x-get-resource'. See also the variable `x-resource-class'. */);
4395 Vx_resource_name = Qnil;
4396
4397 DEFVAR_LISP ("x-resource-class", &Vx_resource_class,
4398 doc: /* The class Emacs uses to look up X resources.
4399`x-get-resource' uses this as the first component of the instance class
4400when requesting resource values.
4401
4402Emacs initially sets `x-resource-class' to "Emacs".
4403
4404Setting this variable permanently is not a reasonable thing to do,
4405but binding this variable locally around a call to `x-get-resource'
4406is a reasonable practice. See also the variable `x-resource-name'. */);
4407 Vx_resource_class = build_string (EMACS_CLASS);
4408#endif
4409
4410 DEFVAR_LISP ("default-frame-alist", &Vdefault_frame_alist,
4411 doc: /* Alist of default values for frame creation.
4412These may be set in your init file, like this:
4413 (setq default-frame-alist '((width . 80) (height . 55) (menu-bar-lines . 1)))
4414These override values given in window system configuration data,
4415 including X Windows' defaults database.
4416For values specific to the first Emacs frame, see `initial-frame-alist'.
4417For window-system specific values, see `window-system-default-frame-alist'.
4418For values specific to the separate minibuffer frame, see
4419 `minibuffer-frame-alist'.
4420The `menu-bar-lines' element of the list controls whether new frames
4421 have menu bars; `menu-bar-mode' works by altering this element.
4422Setting this variable does not affect existing frames, only new ones. */);
4423 Vdefault_frame_alist = Qnil;
4424
4425 DEFVAR_LISP ("default-frame-scroll-bars", &Vdefault_frame_scroll_bars,
4426 doc: /* Default position of scroll bars on this window-system. */);
4427#ifdef HAVE_WINDOW_SYSTEM
4428#if defined(HAVE_NTGUI) || defined(MAC_OS)
4429 /* MS-Windows has scroll bars on the right by default. */
4430 Vdefault_frame_scroll_bars = Qright;
4431#else
4432 Vdefault_frame_scroll_bars = Qleft;
4433#endif
4434#else
4435 Vdefault_frame_scroll_bars = Qnil;
4436#endif
4437
4438 DEFVAR_LISP ("terminal-frame", &Vterminal_frame,
4439 doc: /* The initial frame-object, which represents Emacs's stdout. */);
4440
4441 DEFVAR_LISP ("emacs-iconified", &Vemacs_iconified,
4442 doc: /* Non-nil if all of Emacs is iconified and frame updates are not needed. */);
4443 Vemacs_iconified = Qnil;
4444
4445 DEFVAR_LISP ("mouse-position-function", &Vmouse_position_function,
4446 doc: /* If non-nil, function to transform normal value of `mouse-position'.
4447`mouse-position' calls this function, passing its usual return value as
4448argument, and returns whatever this function returns.
4449This abnormal hook exists for the benefit of packages like `xt-mouse.el'
4450which need to do mouse handling at the Lisp level. */);
4451 Vmouse_position_function = Qnil;
4452
4453 DEFVAR_LISP ("mouse-highlight", &Vmouse_highlight,
4454 doc: /* If non-nil, clickable text is highlighted when mouse is over it.
4455If the value is an integer, highlighting is only shown after moving the
4456mouse, while keyboard input turns off the highlight even when the mouse
4457is over the clickable text. However, the mouse shape still indicates
4458when the mouse is over clickable text. */);
4459 Vmouse_highlight = Qt;
4460
4461 DEFVAR_LISP ("delete-frame-functions", &Vdelete_frame_functions,
4462 doc: /* Functions to be run before deleting a frame.
4463The functions are run with one arg, the frame to be deleted.
4464See `delete-frame'.
4465
4466Note that functions in this list may be called just before the frame is
4467actually deleted, or some time later (or even both when an earlier function
4468in `delete-frame-functions' (indirectly) calls `delete-frame'
4469recursively). */);
4470 Vdelete_frame_functions = Qnil;
4471 Qdelete_frame_functions = intern ("delete-frame-functions");
4472 staticpro (&Qdelete_frame_functions);
4473
4474 DEFVAR_KBOARD ("default-minibuffer-frame", Vdefault_minibuffer_frame,
4475 doc: /* Minibufferless frames use this frame's minibuffer.
4476
4477Emacs cannot create minibufferless frames unless this is set to an
4478appropriate surrogate.
4479
4480Emacs consults this variable only when creating minibufferless
4481frames; once the frame is created, it sticks with its assigned
4482minibuffer, no matter what this variable is set to. This means that
4483this variable doesn't necessarily say anything meaningful about the
4484current set of frames, or where the minibuffer is currently being
4485displayed.
4486
4487This variable is local to the current terminal and cannot be buffer-local. */);
4488
4489 DEFVAR_BOOL ("focus-follows-mouse", &focus_follows_mouse,
4490 doc: /* Non-nil if window system changes focus when you move the mouse.
4491You should set this variable to tell Emacs how your window manager
4492handles focus, since there is no way in general for Emacs to find out
4493automatically. */);
4494#ifdef HAVE_WINDOW_SYSTEM
4495#if defined(HAVE_NTGUI) || defined(MAC_OS)
4496 focus_follows_mouse = 0;
4497#else
4498 focus_follows_mouse = 1;
4499#endif
4500#else
4501 focus_follows_mouse = 0;
4502#endif
4503
4504 staticpro (&Vframe_list);
4505
4506 defsubr (&Sactive_minibuffer_window);
4507 defsubr (&Sframep);
4508 defsubr (&Sframe_live_p);
4509 defsubr (&Swindow_system);
4510 defsubr (&Smake_terminal_frame);
4511 defsubr (&Shandle_switch_frame);
4512 defsubr (&Sselect_frame);
4513 defsubr (&Sselected_frame);
4514 defsubr (&Swindow_frame);
4515 defsubr (&Sframe_root_window);
4516 defsubr (&Sframe_first_window);
4517 defsubr (&Sframe_selected_window);
4518 defsubr (&Sset_frame_selected_window);
4519 defsubr (&Sframe_list);
4520 defsubr (&Snext_frame);
4521 defsubr (&Sprevious_frame);
4522 defsubr (&Sdelete_frame);
4523 defsubr (&Smouse_position);
4524 defsubr (&Smouse_pixel_position);
4525 defsubr (&Sset_mouse_position);
4526 defsubr (&Sset_mouse_pixel_position);
4527#if 0
4528 defsubr (&Sframe_configuration);
4529 defsubr (&Srestore_frame_configuration);
4530#endif
4531 defsubr (&Smake_frame_visible);
4532 defsubr (&Smake_frame_invisible);
4533 defsubr (&Siconify_frame);
4534 defsubr (&Sframe_visible_p);
4535 defsubr (&Svisible_frame_list);
4536 defsubr (&Sraise_frame);
4537 defsubr (&Slower_frame);
4538 defsubr (&Sredirect_frame_focus);
4539 defsubr (&Sframe_focus);
4540 defsubr (&Sframe_parameters);
4541 defsubr (&Sframe_parameter);
4542 defsubr (&Smodify_frame_parameters);
4543 defsubr (&Sframe_char_height);
4544 defsubr (&Sframe_char_width);
4545 defsubr (&Sframe_pixel_height);
4546 defsubr (&Sframe_pixel_width);
4547 defsubr (&Sset_frame_height);
4548 defsubr (&Sset_frame_width);
4549 defsubr (&Sset_frame_size);
4550 defsubr (&Sset_frame_position);
4551
4552#ifdef HAVE_WINDOW_SYSTEM
4553 defsubr (&Sx_get_resource);
4554 defsubr (&Sx_parse_geometry);
4555#endif
4556
4557}
4558
4559/* arch-tag: 7dbf2c69-9aad-45f8-8296-db893d6dd039
4560 (do not change this comment) */