frame.c 135 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Generic frame functions.
Glenn Morris's avatar
Glenn Morris committed
2

3
Copyright (C) 1993-1995, 1997, 1999-2013 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

7
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
8
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

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/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

20
#include <config.h>
21

22 23
#define FRAME_INLINE EXTERN_INLINE

24
#include <stdio.h>
25 26
#include <errno.h>
#include <limits.h>
27 28 29

#include <c-ctype.h>

30
#include "lisp.h"
31
#include "character.h"
32 33 34 35 36

#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */

37 38 39 40
#include "buffer.h"
/* These help us bind and responding to switch-frame events.  */
#include "commands.h"
#include "keyboard.h"
41
#include "frame.h"
Kim F. Storm's avatar
Kim F. Storm committed
42
#include "blockinput.h"
43
#include "termchar.h"
44
#include "termhooks.h"
Andreas Schwab's avatar
Andreas Schwab committed
45
#include "dispextern.h"
46
#include "window.h"
47
#include "font.h"
Andreas Schwab's avatar
Andreas Schwab committed
48
#ifdef HAVE_WINDOW_SYSTEM
49 50
#include "fontset.h"
#endif
Morten Welinder's avatar
Morten Welinder committed
51 52
#ifdef MSDOS
#include "msdos.h"
53
#include "dosfns.h"
Morten Welinder's avatar
Morten Welinder committed
54
#endif
Jim Blandy's avatar
Jim Blandy committed
55

Chong Yidong's avatar
Chong Yidong committed
56 57 58 59
#ifdef HAVE_NS
Lisp_Object Qns_parse_geometry;
#endif

Kim F. Storm's avatar
Kim F. Storm committed
60 61
Lisp_Object Qframep, Qframe_live_p;
Lisp_Object Qicon, Qmodeline;
62
Lisp_Object Qonly, Qnone;
63
Lisp_Object Qx, Qw32, Qpc, Qns;
64
Lisp_Object Qvisible;
65
Lisp_Object Qdisplay_type;
66
static Lisp_Object Qbackground_mode;
67
Lisp_Object Qnoelisp;
Kim F. Storm's avatar
Kim F. Storm committed
68

69
static Lisp_Object Qx_frame_parameter;
Kim F. Storm's avatar
Kim F. Storm committed
70
Lisp_Object Qx_resource_name;
71 72
Lisp_Object Qterminal;
Lisp_Object Qterminal_live_p;
Kim F. Storm's avatar
Kim F. Storm committed
73 74 75 76 77 78 79 80 81

/* Frame parameters (set or reported).  */

Lisp_Object Qauto_raise, Qauto_lower;
Lisp_Object Qborder_color, Qborder_width;
Lisp_Object Qcursor_color, Qcursor_type;
Lisp_Object Qheight, Qwidth;
Lisp_Object Qleft, Qright;
Lisp_Object Qicon_left, Qicon_top, Qicon_type, Qicon_name;
82
Lisp_Object Qtooltip;
Kim F. Storm's avatar
Kim F. Storm committed
83 84 85 86 87 88 89 90
Lisp_Object Qinternal_border_width;
Lisp_Object Qmouse_color;
Lisp_Object Qminibuffer;
Lisp_Object Qscroll_bar_width, Qvertical_scroll_bars;
Lisp_Object Qvisibility;
Lisp_Object Qscroll_bar_foreground, Qscroll_bar_background;
Lisp_Object Qscreen_gamma;
Lisp_Object Qline_spacing;
91
static Lisp_Object Quser_position, Quser_size;
Kim F. Storm's avatar
Kim F. Storm committed
92
Lisp_Object Qwait_for_wm;
93
static Lisp_Object Qwindow_id;
Kim F. Storm's avatar
Kim F. Storm committed
94
#ifdef HAVE_X_WINDOWS
95
static Lisp_Object Qouter_window_id;
Kim F. Storm's avatar
Kim F. Storm committed
96 97 98
#endif
Lisp_Object Qparent_id;
Lisp_Object Qtitle, Qname;
99
static Lisp_Object Qexplicit_name;
Kim F. Storm's avatar
Kim F. Storm committed
100
Lisp_Object Qunsplittable;
101
Lisp_Object Qmenu_bar_lines, Qtool_bar_lines, Qtool_bar_position;
Kim F. Storm's avatar
Kim F. Storm committed
102
Lisp_Object Qleft_fringe, Qright_fringe;
103 104
Lisp_Object Qbuffer_predicate;
static Lisp_Object Qbuffer_list, Qburied_buffer_list;
105
Lisp_Object Qtty_color_mode;
106
Lisp_Object Qtty, Qtty_type;
Jim Blandy's avatar
Jim Blandy committed
107

108
Lisp_Object Qfullscreen, Qfullwidth, Qfullheight, Qfullboth, Qmaximized;
109
Lisp_Object Qsticky;
Kenichi Handa's avatar
Kenichi Handa committed
110
Lisp_Object Qfont_backend;
111
Lisp_Object Qalpha;
Kim F. Storm's avatar
Kim F. Storm committed
112 113 114

Lisp_Object Qface_set_after_frame_default;

115
static Lisp_Object Qdelete_frame_functions;
116

117
static Lisp_Object Qgeometry, Qworkarea, Qmm_size, Qframes, Qsource;
118

119 120 121 122
#ifdef HAVE_WINDOW_SYSTEM
static void x_report_frame_params (struct frame *, Lisp_Object *);
#endif

123
/* These setters are used only in this file, so they can be private.  */
124
static void
125 126 127 128
fset_buffer_predicate (struct frame *f, Lisp_Object val)
{
  f->buffer_predicate = val;
}
129
static void
130 131 132 133 134
fset_minibuffer_window (struct frame *f, Lisp_Object val)
{
  f->minibuffer_window = val;
}

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
struct frame *
decode_live_frame (register Lisp_Object frame)
{
  if (NILP (frame))
    frame = selected_frame;
  CHECK_LIVE_FRAME (frame);
  return XFRAME (frame);
}

struct frame *
decode_any_frame (register Lisp_Object frame)
{
  if (NILP (frame))
    frame = selected_frame;
  CHECK_FRAME (frame);
  return XFRAME (frame);
}

153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
bool
window_system_available (struct frame *f)
{
  if (f)
    return FRAME_WINDOW_P (f) || FRAME_MSDOS_P (f);
  else
#ifdef HAVE_WINDOW_SYSTEM
    return x_display_list != NULL;
#else
    return 0;
#endif
}

struct frame *
decode_window_system_frame (Lisp_Object frame)
{
  struct frame *f = decode_live_frame (frame);
170

171 172 173 174 175 176 177 178 179 180 181 182 183
  if (!window_system_available (f))
    error ("Window system frame should be used");
  return f;
}

void
check_window_system (struct frame *f)
{
  if (!window_system_available (f))
    error (f ? "Window system frame should be used"
	   : "Window system is not in use or not initialized");
}

184
static void
185
set_menu_bar_lines_1 (Lisp_Object window, int n)
186 187 188
{
  struct window *w = XWINDOW (window);

189
  w->last_modified = 0;
190 191
  w->top_line += n;
  w->total_lines -= n;
192

193
  /* Handle just the top child in a vertical split.  */
194 195 196 197 198 199 200 201 202
  if (WINDOW_VERTICAL_COMBINATION_P (w))
    set_menu_bar_lines_1 (w->contents, n);
  else if (WINDOW_HORIZONTAL_COMBINATION_P (w))
    /* Adjust all children in a horizontal split.  */
    for (window = w->contents; !NILP (window); window = w->next)
      {
	w = XWINDOW (window);
	set_menu_bar_lines_1 (window, n);
      }
203 204
}

205
void
206
set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
207 208 209 210 211 212
{
  int nlines;
  int olines = FRAME_MENU_BAR_LINES (f);

  /* Right now, menu bars don't work properly in minibuf-only frames;
     most of the commands try to apply themselves to the minibuffer
Karl Heuer's avatar
Karl Heuer committed
213
     frame itself, and get an error because you can't switch buffers
214 215 216 217
     in or split the minibuffer window.  */
  if (FRAME_MINIBUF_ONLY_P (f))
    return;

218
  if (TYPE_RANGED_INTEGERP (int, value))
219 220 221 222
    nlines = XINT (value);
  else
    nlines = 0;

223 224 225 226 227
  if (nlines != olines)
    {
      windows_or_buffers_changed++;
      FRAME_WINDOW_SIZES_CHANGED (f) = 1;
      FRAME_MENU_BAR_LINES (f) = nlines;
228
      set_menu_bar_lines_1 (f->root_window, nlines - olines);
229
      adjust_glyphs (f);
230
    }
231 232 233 234
}

Lisp_Object Vframe_list;

Jim Blandy's avatar
Jim Blandy committed
235

Jim Blandy's avatar
Jim Blandy committed
236
DEFUN ("framep", Fframep, Sframep, 1, 1, 0,
237
       doc: /* Return non-nil if OBJECT is a frame.
238 239 240 241 242 243
Value is:
  t for a termcap frame (a character-only terminal),
 'x' for an Emacs frame that is really an X window,
 'w32' for an Emacs frame that is a window on MS-Windows display,
 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
 'pc' for a direct-write MS-DOS frame.
244
See also `frame-live-p'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
245
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
246
{
247
  if (!FRAMEP (object))
Jim Blandy's avatar
Jim Blandy committed
248
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
249
  switch (XFRAME (object)->output_method)
Jim Blandy's avatar
Jim Blandy committed
250
    {
251
    case output_initial: /* The initial frame is like a termcap frame. */
Jim Blandy's avatar
Jim Blandy committed
252 253 254
    case output_termcap:
      return Qt;
    case output_x_window:
255
      return Qx;
256 257
    case output_w32:
      return Qw32;
258 259
    case output_msdos_raw:
      return Qpc;
260 261
    case output_ns:
      return Qns;
Jim Blandy's avatar
Jim Blandy committed
262
    default:
263
      emacs_abort ();
Jim Blandy's avatar
Jim Blandy committed
264 265 266
    }
}

Jim Blandy's avatar
Jim Blandy committed
267
DEFUN ("frame-live-p", Fframe_live_p, Sframe_live_p, 1, 1, 0,
268 269
       doc: /* Return non-nil if OBJECT is a frame which has not been deleted.
Value is nil if OBJECT is not a live frame.  If object is a live
270
frame, the return value indicates what sort of terminal device it is
Pavel Janík's avatar
Pavel Janík committed
271
displayed on.  See the documentation of `framep' for possible
Pavel Janík's avatar
Pavel Janík committed
272
return values.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
273
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
274
{
Jim Blandy's avatar
Jim Blandy committed
275 276 277
  return ((FRAMEP (object)
	   && FRAME_LIVE_P (XFRAME (object)))
	  ? Fframep (object)
Jim Blandy's avatar
Jim Blandy committed
278 279 280
	  : Qnil);
}

Paul Eggert's avatar
Paul Eggert committed
281
DEFUN ("window-system", Fwindow_system, Swindow_system, 0, 1, 0,
282
       doc: /* The name of the window system that FRAME is displaying through.
283 284 285 286 287 288 289 290 291 292 293 294
The value is a symbol:
 nil for a termcap frame (a character-only terminal),
 'x' for an Emacs frame that is really an X window,
 'w32' for an Emacs frame that is a window on MS-Windows display,
 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display,
 'pc' for a direct-write MS-DOS frame.

FRAME defaults to the currently selected frame.

Use of this function as a predicate is deprecated.  Instead,
use `display-graphic-p' or any of the other `display-*-p'
predicates which report frame's specific UI-related capabilities.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
295
  (Lisp_Object frame)
296 297 298 299 300 301 302 303 304 305 306 307 308 309
{
  Lisp_Object type;
  if (NILP (frame))
    frame = selected_frame;

  type = Fframep (frame);

  if (NILP (type))
    wrong_type_argument (Qframep, frame);

  if (EQ (type, Qt))
    return Qnil;
  else
    return type;
310
}
311

Jim Blandy's avatar
Jim Blandy committed
312
struct frame *
313
make_frame (int mini_p)
Jim Blandy's avatar
Jim Blandy committed
314
{
Jim Blandy's avatar
Jim Blandy committed
315 316
  Lisp_Object frame;
  register struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
317 318
  register Lisp_Object root_window;
  register Lisp_Object mini_window;
319 320

  f = allocate_frame ();
321
  XSETFRAME (frame, f);
Jim Blandy's avatar
Jim Blandy committed
322

323 324
  /* Initialize Lisp data.  Note that allocate_frame initializes all
     Lisp data to nil, so do it only for slots which should not be nil.  */
325
  fset_tool_bar_position (f, Qtop);
326 327 328 329 330

  /* Initialize non-Lisp data.  Note that allocate_frame zeroes out all
     non-Lisp data, so do it only for slots which should not be zero.
     To avoid subtle bugs and for the sake of readability, it's better to
     initialize enum members explicitly even if their values are zero.  */
Jim Blandy's avatar
Jim Blandy committed
331
  f->wants_modeline = 1;
332
  f->garbaged = 1;
Jim Blandy's avatar
Jim Blandy committed
333
  f->has_minibuffer = mini_p;
334
  f->vertical_scroll_bar_type = vertical_scroll_bar_none;
335 336
  f->column_width = 1;  /* !FRAME_WINDOW_P value */
  f->line_height = 1;  /* !FRAME_WINDOW_P value */
337
#ifdef HAVE_WINDOW_SYSTEM
338
  f->want_fullscreen = FULLSCREEN_NONE;
339
#endif
Jim Blandy's avatar
Jim Blandy committed
340

341
  root_window = make_window ();
Jim Blandy's avatar
Jim Blandy committed
342 343
  if (mini_p)
    {
344
      mini_window = make_window ();
Paul Eggert's avatar
Paul Eggert committed
345 346
      wset_next (XWINDOW (root_window), mini_window);
      wset_prev (XWINDOW (mini_window), root_window);
347
      XWINDOW (mini_window)->mini = 1;
Paul Eggert's avatar
Paul Eggert committed
348
      wset_frame (XWINDOW (mini_window), frame);
349
      fset_minibuffer_window (f, mini_window);
Jim Blandy's avatar
Jim Blandy committed
350 351 352 353
    }
  else
    {
      mini_window = Qnil;
Paul Eggert's avatar
Paul Eggert committed
354
      wset_next (XWINDOW (root_window), Qnil);
355
      fset_minibuffer_window (f, Qnil);
Jim Blandy's avatar
Jim Blandy committed
356 357
    }

Paul Eggert's avatar
Paul Eggert committed
358
  wset_frame (XWINDOW (root_window), frame);
Jim Blandy's avatar
Jim Blandy committed
359 360 361

  /* 10 is arbitrary,
     just so that there is "something there."
Jim Blandy's avatar
Jim Blandy committed
362
     Correct size will be set up later with change_frame_size.  */
Jim Blandy's avatar
Jim Blandy committed
363

364 365
  SET_FRAME_COLS (f, 10);
  FRAME_LINES (f) = 10;
Jim Blandy's avatar
Jim Blandy committed
366

367 368
  XWINDOW (root_window)->total_cols = 10;
  XWINDOW (root_window)->total_lines = mini_p ? 9 : 10;
Jim Blandy's avatar
Jim Blandy committed
369 370 371

  if (mini_p)
    {
372 373 374
      XWINDOW (mini_window)->total_cols = 10;
      XWINDOW (mini_window)->top_line = 9;
      XWINDOW (mini_window)->total_lines = 1;
Jim Blandy's avatar
Jim Blandy committed
375 376
    }

Jim Blandy's avatar
Jim Blandy committed
377
  /* Choose a buffer for the frame's root window.  */
Jim Blandy's avatar
Jim Blandy committed
378
  {
379
    Lisp_Object buf = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
380

381 382
    /* If current buffer is hidden, try to find another one.  */
    if (BUFFER_HIDDEN_P (XBUFFER (buf)))
383
      buf = other_buffer_safely (buf);
384

385 386
    /* Use set_window_buffer, not Fset_window_buffer, and don't let
       hooks be run by it.  The reason is that the whole frame/window
Juanma Barranquero's avatar
Juanma Barranquero committed
387
       arrangement is not yet fully initialized at this point.  Windows
388 389 390
       don't have the right size, glyph matrices aren't initialized
       etc.  Running Lisp functions at this point surely ends in a
       SEGV.  */
391
    set_window_buffer (root_window, buf, 0, 0);
392
    fset_buffer_list (f, list1 (buf));
Jim Blandy's avatar
Jim Blandy committed
393 394
  }

Jim Blandy's avatar
Jim Blandy committed
395
  if (mini_p)
396 397 398 399 400
    set_window_buffer (mini_window,
		       (NILP (Vminibuffer_list)
			? get_minibuffer (0)
			: Fcar (Vminibuffer_list)),
		       0, 0);
Jim Blandy's avatar
Jim Blandy committed
401

402 403
  fset_root_window (f, root_window);
  fset_selected_window (f, root_window);
Jim Blandy's avatar
Jim Blandy committed
404 405
  /* Make sure this window seems more recently used than
     a newly-created, never-selected window.  */
406
  XWINDOW (f->selected_window)->use_time = ++window_select_count;
Jim Blandy's avatar
Jim Blandy committed
407

Jim Blandy's avatar
Jim Blandy committed
408
  return f;
Jim Blandy's avatar
Jim Blandy committed
409 410
}

411
#ifdef HAVE_WINDOW_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
412
/* Make a frame using a separate minibuffer window on another frame.
Jim Blandy's avatar
Jim Blandy committed
413 414 415
   MINI_WINDOW is the minibuffer window to use.  nil means use the
   default (the global minibuffer).  */

Jim Blandy's avatar
Jim Blandy committed
416
struct frame *
417
make_frame_without_minibuffer (register Lisp_Object mini_window, KBOARD *kb, Lisp_Object display)
Jim Blandy's avatar
Jim Blandy committed
418
{
Jim Blandy's avatar
Jim Blandy committed
419
  register struct frame *f;
420
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
421

422
  if (!NILP (mini_window))
423
    CHECK_LIVE_WINDOW (mini_window);
Jim Blandy's avatar
Jim Blandy committed
424

425
  if (!NILP (mini_window)
426
      && FRAME_KBOARD (XFRAME (XWINDOW (mini_window)->frame)) != kb)
427
    error ("Frame and minibuffer must be on the same terminal");
428

Jim Blandy's avatar
Jim Blandy committed
429 430
  /* Make a frame containing just a root window.  */
  f = make_frame (0);
Jim Blandy's avatar
Jim Blandy committed
431

432 433 434
  if (NILP (mini_window))
    {
      /* Use default-minibuffer-frame if possible.  */
435 436
      if (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
	  || ! FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame))))
437
	{
438 439 440 441
          Lisp_Object frame_dummy;

          XSETFRAME (frame_dummy, f);
          GCPRO1 (frame_dummy);
442
	  /* If there's no minibuffer frame to use, create one.  */
Paul Eggert's avatar
Paul Eggert committed
443 444
	  kset_default_minibuffer_frame
	    (kb, call1 (intern ("make-initial-minibuffer-frame"), display));
445
          UNGCPRO;
446
	}
447

448 449
      mini_window
	= XFRAME (KVAR (kb, Vdefault_minibuffer_frame))->minibuffer_window;
450
    }
451

452
  fset_minibuffer_window (f, mini_window);
453 454 455

  /* Make the chosen minibuffer window display the proper minibuffer,
     unless it is already showing a minibuffer.  */
456
  if (NILP (Fmemq (XWINDOW (mini_window)->contents, Vminibuffer_list)))
457 458 459 460 461 462
    /* Use set_window_buffer instead of Fset_window_buffer (see
       discussion of bug#11984, bug#12025, bug#12026).  */
    set_window_buffer (mini_window,
		       (NILP (Vminibuffer_list)
			? get_minibuffer (0)
			: Fcar (Vminibuffer_list)), 0, 0);
Jim Blandy's avatar
Jim Blandy committed
463
  return f;
Jim Blandy's avatar
Jim Blandy committed
464 465
}

Jim Blandy's avatar
Jim Blandy committed
466
/* Make a frame containing only a minibuffer window.  */
Jim Blandy's avatar
Jim Blandy committed
467

Jim Blandy's avatar
Jim Blandy committed
468
struct frame *
469
make_minibuffer_frame (void)
Jim Blandy's avatar
Jim Blandy committed
470
{
Jim Blandy's avatar
Jim Blandy committed
471
  /* First make a frame containing just a root window, no minibuffer.  */
Jim Blandy's avatar
Jim Blandy committed
472

Jim Blandy's avatar
Jim Blandy committed
473
  register struct frame *f = make_frame (0);
Jim Blandy's avatar
Jim Blandy committed
474
  register Lisp_Object mini_window;
Jim Blandy's avatar
Jim Blandy committed
475
  register Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
476

477
  XSETFRAME (frame, f);
Jim Blandy's avatar
Jim Blandy committed
478

479
  f->auto_raise = 0;
Jim Blandy's avatar
Jim Blandy committed
480 481 482 483
  f->auto_lower = 0;
  f->no_split = 1;
  f->wants_modeline = 0;
  f->has_minibuffer = 1;
Jim Blandy's avatar
Jim Blandy committed
484 485 486 487 488

  /* Now label the root window as also being the minibuffer.
     Avoid infinite looping on the window chain by marking next pointer
     as nil. */

489 490
  mini_window = f->root_window;
  fset_minibuffer_window (f, mini_window);
491
  XWINDOW (mini_window)->mini = 1;
Paul Eggert's avatar
Paul Eggert committed
492 493 494
  wset_next (XWINDOW (mini_window), Qnil);
  wset_prev (XWINDOW (mini_window), Qnil);
  wset_frame (XWINDOW (mini_window), frame);
Jim Blandy's avatar
Jim Blandy committed
495 496 497

  /* Put the proper buffer in that window.  */

498 499 500 501 502 503
  /* Use set_window_buffer instead of Fset_window_buffer (see
     discussion of bug#11984, bug#12025, bug#12026).  */
  set_window_buffer (mini_window,
		     (NILP (Vminibuffer_list)
		      ? get_minibuffer (0)
		      : Fcar (Vminibuffer_list)), 0, 0);
Jim Blandy's avatar
Jim Blandy committed
504
  return f;
Jim Blandy's avatar
Jim Blandy committed
505
}
506
#endif /* HAVE_WINDOW_SYSTEM */
Jim Blandy's avatar
Jim Blandy committed
507

508
/* Construct a frame that refers to a terminal.  */
Jim Blandy's avatar
Jim Blandy committed
509

510
static printmax_t tty_frame_count;
511

Jim Blandy's avatar
Jim Blandy committed
512
struct frame *
513
make_initial_frame (void)
Jim Blandy's avatar
Jim Blandy committed
514
{
515
  struct frame *f;
516
  struct terminal *terminal;
517
  Lisp_Object frame;
518

519
  eassert (initial_kboard);
520

521 522 523
  /* The first call must initialize Vframe_list.  */
  if (! (NILP (Vframe_list) || CONSP (Vframe_list)))
    Vframe_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
524

525
  terminal = init_initial_terminal ();
526 527 528 529 530 531

  f = make_frame (1);
  XSETFRAME (frame, f);

  Vframe_list = Fcons (frame, Vframe_list);

532
  tty_frame_count = 1;
533
  fset_name (f, build_pure_c_string ("F1"));
534

535
  SET_FRAME_VISIBLE (f, 1);
536

537 538 539
  f->output_method = terminal->type;
  f->terminal = terminal;
  f->terminal->reference_count++;
540
  f->output_data.nothing = 0;
541

542 543
  FRAME_FOREGROUND_PIXEL (f) = FACE_TTY_DEFAULT_FG_COLOR;
  FRAME_BACKGROUND_PIXEL (f) = FACE_TTY_DEFAULT_BG_COLOR;
544

545
  FRAME_VERTICAL_SCROLL_BAR_TYPE (f) = vertical_scroll_bar_none;
546 547 548

  /* The default value of menu-bar-mode is t.  */
  set_menu_bar_lines (f, make_number (1), Qnil);
549

550 551 552
  if (!noninteractive)
    init_frame_faces (f);

553 554 555 556
  return f;
}


557
static struct frame *
558
make_terminal_frame (struct terminal *terminal)
559 560 561
{
  register struct frame *f;
  Lisp_Object frame;
562
  char name[sizeof "F" + INT_STRLEN_BOUND (printmax_t)];
563

564 565
  if (!terminal->name)
    error ("Terminal is not live, can't create new frames on it");
566

Jim Blandy's avatar
Jim Blandy committed
567
  f = make_frame (1);
568

569
  XSETFRAME (frame, f);
570 571
  Vframe_list = Fcons (frame, Vframe_list);

572
  fset_name (f, make_formatted_string (name, "F%"pMd, ++tty_frame_count));
573

574 575
  SET_FRAME_VISIBLE (f, 1);

576 577
  f->terminal = terminal;
  f->terminal->reference_count++;
578
#ifdef MSDOS
579
  f->output_data.tty->display_info = &the_only_display_info;
580 581 582
  if (!inhibit_window_system
      && (!FRAMEP (selected_frame) || !FRAME_LIVE_P (XFRAME (selected_frame))
	  || XFRAME (selected_frame)->output_method == output_msdos_raw))
583
    f->output_method = output_msdos_raw;
584 585
  else
    f->output_method = output_termcap;
586 587 588 589 590 591
#else /* not MSDOS */
  f->output_method = output_termcap;
  create_tty_output (f);
  FRAME_FOREGROUND_PIXEL (f) = FACE_TTY_DEFAULT_FG_COLOR;
  FRAME_BACKGROUND_PIXEL (f) = FACE_TTY_DEFAULT_BG_COLOR;
#endif /* not MSDOS */
592

593
  FRAME_VERTICAL_SCROLL_BAR_TYPE (f) = vertical_scroll_bar_none;
594
  FRAME_MENU_BAR_LINES(f) = NILP (Vmenu_bar_mode) ? 0 : 1;
595 596 597 598

  /* Set the top frame to the newly created frame. */
  if (FRAMEP (FRAME_TTY (f)->top_frame)
      && FRAME_LIVE_P (XFRAME (FRAME_TTY (f)->top_frame)))
599
    SET_FRAME_VISIBLE (XFRAME (FRAME_TTY (f)->top_frame), 2); /* obscured */
600 601 602

  FRAME_TTY (f)->top_frame = frame;

603 604
  if (!noninteractive)
    init_frame_faces (f);
605

Jim Blandy's avatar
Jim Blandy committed
606
  return f;
Jim Blandy's avatar
Jim Blandy committed
607
}
608

609 610
/* Get a suitable value for frame parameter PARAMETER for a newly
   created frame, based on (1) the user-supplied frame parameter
611
   alist SUPPLIED_PARMS, and (2) CURRENT_VALUE.  */
612 613 614 615 616 617 618 619 620 621

static Lisp_Object
get_future_frame_param (Lisp_Object parameter,
                        Lisp_Object supplied_parms,
                        char *current_value)
{
  Lisp_Object result;

  result = Fassq (parameter, supplied_parms);
  if (NILP (result))
622
    result = Fassq (parameter, XFRAME (selected_frame)->param_alist);
623 624 625 626 627 628 629 630 631 632
  if (NILP (result) && current_value != NULL)
    result = build_string (current_value);
  if (!NILP (result) && !STRINGP (result))
    result = XCDR (result);
  if (NILP (result) || !STRINGP (result))
    result = Qnil;

  return result;
}

633
DEFUN ("make-terminal-frame", Fmake_terminal_frame, Smake_terminal_frame,
634
       1, 1, 0,
635
       doc: /* Create an additional terminal frame, possibly on another terminal.
636
This function takes one argument, an alist specifying frame parameters.
637

638 639
You can create multiple frames on a single text terminal, but only one
of them (the selected terminal frame) is actually displayed.
640 641 642 643 644 645 646 647

In practice, generally you don't need to specify any parameters,
except when you want to create a new frame on another terminal.
In that case, the `tty' parameter specifies the device file to open,
and the `tty-type' parameter specifies the terminal type.  Example:

   (make-terminal-frame '((tty . "/dev/pts/5") (tty-type . "xterm")))

648 649
Note that changing the size of one terminal frame automatically
affects all frames on the same terminal device.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
650
  (Lisp_Object parms)
651 652
{
  struct frame *f;
653
  struct terminal *t = NULL;
654
  Lisp_Object frame, tem;
655
  struct frame *sf = SELECTED_FRAME ();
656

657
#ifdef MSDOS
658 659
  if (sf->output_method != output_msdos_raw
      && sf->output_method != output_termcap)
660
    emacs_abort ();
661 662
#else /* not MSDOS */

663
#ifdef WINDOWSNT                           /* This should work now! */
664
  if (sf->output_method != output_termcap)
665
    error ("Not using an ASCII terminal now; cannot make a new ASCII frame");
666
#endif
667
#endif /* not MSDOS */
668

669
  {
670
    Lisp_Object terminal;
671

672
    terminal = Fassq (Qterminal, parms);
673
    if (CONSP (terminal))
674
      {
675 676
        terminal = XCDR (terminal);
        t = get_terminal (terminal, 1);
677
      }
678 679 680 681 682 683 684
#ifdef MSDOS
    if (t && t != the_only_display_info.terminal)
      /* msdos.c assumes a single tty_display_info object.  */
      error ("Multiple terminals are not supported on this platform");
    if (!t)
      t = the_only_display_info.terminal;
#endif
685
  }
686

687
  if (!t)
688
    {
689
      char *name = 0, *type = 0;
690
      Lisp_Object tty, tty_type;
691

692 693 694 695 696
      tty = get_future_frame_param
        (Qtty, parms, (FRAME_TERMCAP_P (XFRAME (selected_frame))
                       ? FRAME_TTY (XFRAME (selected_frame))->name
                       : NULL));
      if (!NILP (tty))
697
        {
698
          name = alloca (SBYTES (tty) + 1);
699
          memcpy (name, SSDATA (tty), SBYTES (tty));
700 701
          name[SBYTES (tty)] = 0;
        }
702

703 704 705 706 707
      tty_type = get_future_frame_param
        (Qtty_type, parms, (FRAME_TERMCAP_P (XFRAME (selected_frame))
                            ? FRAME_TTY (XFRAME (selected_frame))->type
                            : NULL));
      if (!NILP (tty_type))
708
        {
709
          type = alloca (SBYTES (tty_type) + 1);
710
          memcpy (type, SSDATA (tty_type), SBYTES (tty_type));
711 712 713
          type[SBYTES (tty_type)] = 0;
        }

714
      t = init_tty (name, type, 0); /* Errors are not fatal. */
715
    }
716

717
  f = make_terminal_frame (t);
718

719 720
  {
    int width, height;
721
    get_tty_size (fileno (FRAME_TTY (f)->input), &width, &height);
722 723
    change_frame_size (f, height, width, 0, 0, 0);
  }
724

725
  adjust_glyphs (f);
726 727 728
  calculate_costs (f);
  XSETFRAME (frame, f);
  Fmodify_frame_parameters (frame, parms);
729 730 731
  Fmodify_frame_parameters
    (frame, list1 (Fcons (Qtty_type,
			  build_string (t->display_info.tty->type))));
732
  if (t->display_info.tty->name != NULL)
733 734 735
    Fmodify_frame_parameters
      (frame, list1 (Fcons (Qtty,
			    build_string (t->display_info.tty->name))));
736
  else
737
    Fmodify_frame_parameters (frame, list1 (Fcons (Qtty, Qnil)));
738

739 740
  /* Make the frame face alist be frame-specific, so that each
     frame could change its face definitions independently.  */
741
  fset_face_alist (f, Fcopy_alist (sf->face_alist));
742 743 744
  /* Simple Fcopy_alist isn't enough, because we need the contents of
     the vectors which are the CDRs of associations in face_alist to
     be copied as well.  */
745
  for (tem = f->face_alist; CONSP (tem); tem = XCDR (tem))
746
    XSETCDR (XCAR (tem), Fcopy_sequence (XCDR (XCAR (tem))));
747 748
  return frame;
}
749

Jim Blandy's avatar
Jim Blandy committed
750

751 752 753 754 755 756 757 758 759 760
/* Perform the switch to frame FRAME.

   If FRAME is a switch-frame event `(switch-frame FRAME1)', use
   FRAME1 as frame.

   If TRACK is non-zero and the frame that currently has the focus
   redirects its focus to the selected frame, redirect that focused
   frame's focus to FRAME instead.

   FOR_DELETION non-zero means that the selected frame is being
761
   deleted, which includes the possibility that the frame's terminal
762 763 764
   is dead.

   The value of NORECORD is passed as argument to Fselect_window.  */
765

766
Lisp_Object
767
do_switch_frame (Lisp_Object frame, int track, int for_deletion, Lisp_Object norecord)
Jim Blandy's avatar
Jim Blandy committed
768
{
769
  struct frame *sf = SELECTED_FRAME ();
770

771 772 773
  /* If FRAME is a switch-frame event, extract the frame we should
     switch to.  */
  if (CONSP (frame)
774 775 776
      && EQ (XCAR (frame), Qswitch_frame)
      && CONSP (XCDR (frame)))
    frame = XCAR (XCDR (frame));
777

778 779 780
  /* This used to say CHECK_LIVE_FRAME, but apparently it's possible for
     a switch-frame event to arrive after a frame is no longer live,
     especially when deleting the initial frame during startup.  */
781
  CHECK_FRAME (frame);
782 783
  if (! FRAME_LIVE_P (XFRAME (frame)))
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
784

785
  if (sf == XFRAME (frame))
Jim Blandy's avatar
Jim Blandy committed
786
    return frame;
Jim Blandy's avatar
Jim Blandy committed
787

788 789 790
  /* This is too greedy; it causes inappropriate focus redirection
     that's hard to get rid of.  */
#if 0
791 792 793 794 795 796 797
  /* If a frame's focus has been redirected toward the currently
     selected frame, we should change the redirection to point to the
     newly selected frame.  This means that if the focus is redirected
     from a minibufferless frame to a surrogate minibuffer frame, we
     can use `other-window' to switch between all the frames using
     that minibuffer frame, and the focus redirection will follow us
     around.  */
798 799 800
  if (track)
    {
      Lisp_Object tail;
801

802
      for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
803 804
	{
	  Lisp_Object focus;
805

806
	  if (!FRAMEP (XCAR (tail)))
807
	    emacs_abort ();
808

809
	  focus = FRAME_FOCUS_FRAME (XFRAME (XCAR (tail)));
810

811
	  if (FRAMEP (focus) && XFRAME (focus) == SELECTED_FRAME ())
812
	    Fredirect_frame_focus (XCAR (tail), frame);
813 814 815 816
	}
    }
#else /* ! 0 */
  /* Instead, apply it only to the frame we're pointing to.  */
817
#ifdef HAVE_WINDOW_SYSTEM
818
  if (track && FRAME_WINDOW_P (XFRAME (frame)))
819 820 821
    {
      Lisp_Object focus, xfocus;

822
      xfocus = x_get_focus_frame (XFRAME (frame));
823 824 825
      if (FRAMEP (xfocus))
	{
	  focus = FRAME_FOCUS_FRAME (XFRAME (xfocus));
826
	  if (FRAMEP (focus) && XFRAME (focus) == SELECTED_FRAME ())
827 828 829 830 831
	    Fredirect_frame_focus (xfocus, frame);
	}
    }
#endif /* HAVE_X_WINDOWS */
#endif /* ! 0 */
832

833
  if (!for_deletion && FRAME_HAS_MINIBUF_P (sf))
834 835
    resize_mini_window (XWINDOW (FRAME_MINIBUF_WINDOW (sf)), 1);

836
  if (FRAME_TERMCAP_P (XFRAME (frame)) || FRAME_MSDOS_P (XFRAME (frame)))
837
    {
838 839 840 841 842 843 844 845 846 847 848 849
      Lisp_Object top_frame = FRAME_TTY (XFRAME (frame))->top_frame;

      /* Don't mark the frame garbaged and/or obscured if we are
	 switching to the frame that is already the top frame of that
	 TTY.  */
      if (!EQ (frame, top_frame))
	{
	  if (FRAMEP (top_frame))
	    /* Mark previously displayed frame as now obscured.  */
	    SET_FRAME_VISIBLE (XFRAME (top_frame), 2);
	  SET_FRAME_VISIBLE (XFRAME (frame), 1);
	}
850 851 852
      FRAME_TTY (XFRAME (frame))->top_frame = frame;
    }

853 854 855
  selected_frame = frame;
  if (! FRAME_MINIBUF_ONLY_P (XFRAME (selected_frame)))
    last_nonminibuf_frame = XFRAME (selected_frame);
Jim Blandy's avatar
Jim Blandy committed
856

857
  Fselect_window (XFRAME (frame)->selected_window, norecord);
Jim Blandy's avatar
Jim Blandy committed
858

859
  /* We want to make sure that the next event generates a frame-switch
860
     event to the appropriate frame.  This seems kludgy to me, but
861 862 863 864
     before you take it out, make sure that evaluating something like
     (select-window (frame-root-window (new-frame))) doesn't end up
     with your typing being interpreted in the new frame instead of
     the one you're actually typing in.  */
865
  internal_last_event_frame = Qnil;
866

Jim Blandy's avatar
Jim Blandy committed
867
  return frame;
Jim Blandy's avatar
Jim Blandy committed
868 869
}

Paul Eggert's avatar
Paul Eggert committed
870
DEFUN ("select-frame", Fselect_frame, Sselect_frame, 1, 2, "e",
871
       doc: /* Select FRAME.
872
Subsequent editing commands apply to its selected window.
873 874 875
Optional argument NORECORD means to neither change the order of
recently selected windows nor the buffer list.

876
The selection of FRAME lasts until the next time the user does
877 878 879
something to select a different frame, or until the next time
this function is called.  If you are using a window system, the
previously selected frame may be restored as the selected frame
Juanma Barranquero's avatar
Juanma Barranquero committed
880
when returning to the command loop, because it still may have
881 882
the window system's input focus.  On a text terminal, the next
redisplay will display FRAME.
883 884

This function returns FRAME, or nil if FRAME has been deleted.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
885
  (Lisp_Object frame, Lisp_Object norecord)
886
{
887
  return do_switch_frame (frame, 1, 0, norecord);
888 889
}

890 891 892 893 894 895 896 897
DEFUN ("handle-focus-in", Fhandle_focus_in, Shandle_focus_in, 1, 1, "e",
       doc: /* Handle a focus-in event.
Focus in events are usually bound to this function.
Focus in events occur when a frame has focus, but a switch-frame event
is not generated.
This function checks if blink-cursor timers should be turned on again.  */)
  (Lisp_Object event)
{
898
  return call0 (intern ("blink-cursor-check"));
899 900 901 902 903 904 905 906 907
}

DEFUN ("handle-focus-out", Fhandle_focus_out, Shandle_focus_out, 1, 1, "e",
       doc: /* Handle a focus-out event.
Focus out events are usually bound to this function.
Focus out events occur when no frame has focus.
This function checks if blink-cursor timers should be turned off.  */)
  (Lisp_Object event)
{
908
  return call0 (intern ("blink-cursor-suspend"));
909
}
910

911
DEFUN ("handle-switch-frame", Fhandle_switch_frame, Shandle_switch_frame, 1, 1, "e",
912 913 914 915 916 917 918 919
       doc: /* Handle a switch-frame event EVENT.
Switch-frame events are usually bound to this function.
A switch-frame event tells Emacs that the window manager has requested
that the user's events be directed to the frame mentioned in the event.
This function selects the selected window of the frame of EVENT.

If EVENT is frame object, handle it as if it were a switch-frame event
to that frame.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
920
  (Lisp_Object event)
<