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