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
Lisp_Object Qterminal;
Kim F. Storm's avatar
Kim F. Storm committed
72 73 74 75 76 77 78 79 80

/* 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;
81
Lisp_Object Qtooltip;
Kim F. Storm's avatar
Kim F. Storm committed
82 83 84 85 86 87 88 89
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;
90
static Lisp_Object Quser_position, Quser_size;
Kim F. Storm's avatar
Kim F. Storm committed
91
Lisp_Object Qwait_for_wm;
92
static Lisp_Object Qwindow_id;
Kim F. Storm's avatar
Kim F. Storm committed
93
#ifdef HAVE_X_WINDOWS
94
static Lisp_Object Qouter_window_id;
Kim F. Storm's avatar
Kim F. Storm committed
95 96 97
#endif
Lisp_Object Qparent_id;
Lisp_Object Qtitle, Qname;
98
static Lisp_Object Qexplicit_name;
Kim F. Storm's avatar
Kim F. Storm committed
99
Lisp_Object Qunsplittable;
100
Lisp_Object Qmenu_bar_lines, Qtool_bar_lines, Qtool_bar_position;
Kim F. Storm's avatar
Kim F. Storm committed
101
Lisp_Object Qleft_fringe, Qright_fringe;
102 103
Lisp_Object Qbuffer_predicate;
static Lisp_Object Qbuffer_list, Qburied_buffer_list;
104
Lisp_Object Qtty_color_mode;
105
Lisp_Object Qtty, Qtty_type;
Jim Blandy's avatar
Jim Blandy committed
106

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

Lisp_Object Qface_set_after_frame_default;

114
static Lisp_Object Qdelete_frame_functions;
115

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

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

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

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
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);
}

152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
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);
169

170 171 172 173 174 175 176 177 178 179 180 181 182
  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");
}

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

188 189
  w->top_line += n;
  w->total_lines -= n;
190

191
  /* Handle just the top child in a vertical split.  */
192 193 194 195 196 197 198 199 200
  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);
      }
201 202
}

203
void
204
set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
205 206 207 208 209 210
{
  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
211
     frame itself, and get an error because you can't switch buffers
212 213 214 215
     in or split the minibuffer window.  */
  if (FRAME_MINIBUF_ONLY_P (f))
    return;

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

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

Jim Blandy's avatar
Jim Blandy committed
233

Jim Blandy's avatar
Jim Blandy committed
234
DEFUN ("framep", Fframep, Sframep, 1, 1, 0,
235
       doc: /* Return non-nil if OBJECT is a frame.
236 237 238 239 240 241
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.
242
See also `frame-live-p'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
243
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
244
{
245
  if (!FRAMEP (object))
Jim Blandy's avatar
Jim Blandy committed
246
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
247
  switch (XFRAME (object)->output_method)
Jim Blandy's avatar
Jim Blandy committed
248
    {
249
    case output_initial: /* The initial frame is like a termcap frame. */
Jim Blandy's avatar
Jim Blandy committed
250 251 252
    case output_termcap:
      return Qt;
    case output_x_window:
253
      return Qx;
254 255
    case output_w32:
      return Qw32;
256 257
    case output_msdos_raw:
      return Qpc;
258 259
    case output_ns:
      return Qns;
Jim Blandy's avatar
Jim Blandy committed
260
    default:
261
      emacs_abort ();
Jim Blandy's avatar
Jim Blandy committed
262 263 264
    }
}

Jim Blandy's avatar
Jim Blandy committed
265
DEFUN ("frame-live-p", Fframe_live_p, Sframe_live_p, 1, 1, 0,
266 267
       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
268
frame, the return value indicates what sort of terminal device it is
Pavel Janík's avatar
Pavel Janík committed
269
displayed on.  See the documentation of `framep' for possible
Pavel Janík's avatar
Pavel Janík committed
270
return values.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
271
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
272
{
Jim Blandy's avatar
Jim Blandy committed
273 274 275
  return ((FRAMEP (object)
	   && FRAME_LIVE_P (XFRAME (object)))
	  ? Fframep (object)
Jim Blandy's avatar
Jim Blandy committed
276 277 278
	  : Qnil);
}

Paul Eggert's avatar
Paul Eggert committed
279
DEFUN ("window-system", Fwindow_system, Swindow_system, 0, 1, 0,
280
       doc: /* The name of the window system that FRAME is displaying through.
281 282 283 284 285 286 287 288 289 290 291 292
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
293
  (Lisp_Object frame)
294 295 296 297 298 299 300 301 302 303 304 305 306 307
{
  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;
308
}
309

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

  f = allocate_frame ();
319
  XSETFRAME (frame, f);
Jim Blandy's avatar
Jim Blandy committed
320

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

  /* 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
329
  f->wants_modeline = 1;
330
  f->garbaged = 1;
Jim Blandy's avatar
Jim Blandy committed
331
  f->has_minibuffer = mini_p;
332
  f->vertical_scroll_bar_type = vertical_scroll_bar_none;
333 334
  f->column_width = 1;  /* !FRAME_WINDOW_P value */
  f->line_height = 1;  /* !FRAME_WINDOW_P value */
335
#ifdef HAVE_WINDOW_SYSTEM
336
  f->want_fullscreen = FULLSCREEN_NONE;
337
#endif
Jim Blandy's avatar
Jim Blandy committed
338

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

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

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

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

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

  if (mini_p)
    {
370 371 372
      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
373 374
    }

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

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

383 384
    /* 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
385
       arrangement is not yet fully initialized at this point.  Windows
386 387 388
       don't have the right size, glyph matrices aren't initialized
       etc.  Running Lisp functions at this point surely ends in a
       SEGV.  */
389
    set_window_buffer (root_window, buf, 0, 0);
390
    fset_buffer_list (f, list1 (buf));
Jim Blandy's avatar
Jim Blandy committed
391 392
  }

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

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

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

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

420
  if (!NILP (mini_window))
421
    CHECK_LIVE_WINDOW (mini_window);
Jim Blandy's avatar
Jim Blandy committed
422

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

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

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

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

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

450
  fset_minibuffer_window (f, mini_window);
451 452 453

  /* Make the chosen minibuffer window display the proper minibuffer,
     unless it is already showing a minibuffer.  */
454
  if (NILP (Fmemq (XWINDOW (mini_window)->contents, Vminibuffer_list)))
455 456 457 458 459 460
    /* 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
461
  return f;
Jim Blandy's avatar
Jim Blandy committed
462 463
}

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

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

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

475
  XSETFRAME (frame, f);
Jim Blandy's avatar
Jim Blandy committed
476

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

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

487 488
  mini_window = f->root_window;
  fset_minibuffer_window (f, mini_window);
489
  XWINDOW (mini_window)->mini = 1;
Paul Eggert's avatar
Paul Eggert committed
490 491 492
  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
493 494 495

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

496 497 498 499 500 501
  /* 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
502
  return f;
Jim Blandy's avatar
Jim Blandy committed
503
}
504
#endif /* HAVE_WINDOW_SYSTEM */
Jim Blandy's avatar
Jim Blandy committed
505

506
/* Construct a frame that refers to a terminal.  */
Jim Blandy's avatar
Jim Blandy committed
507

508
static printmax_t tty_frame_count;
509

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

517
  eassert (initial_kboard);
518

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

523
  terminal = init_initial_terminal ();
524 525 526 527 528 529

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

  Vframe_list = Fcons (frame, Vframe_list);

530
  tty_frame_count = 1;
531
  fset_name (f, build_pure_c_string ("F1"));
532

533
  SET_FRAME_VISIBLE (f, 1);
534

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

540 541
  FRAME_FOREGROUND_PIXEL (f) = FACE_TTY_DEFAULT_FG_COLOR;
  FRAME_BACKGROUND_PIXEL (f) = FACE_TTY_DEFAULT_BG_COLOR;
542

543
  FRAME_VERTICAL_SCROLL_BAR_TYPE (f) = vertical_scroll_bar_none;
544 545 546

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

548 549 550
  if (!noninteractive)
    init_frame_faces (f);

551 552 553 554
  return f;
}


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

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

Jim Blandy's avatar
Jim Blandy committed
565
  f = make_frame (1);
566

567
  XSETFRAME (frame, f);
568 569
  Vframe_list = Fcons (frame, Vframe_list);

570
  fset_name (f, make_formatted_string (name, "F%"pMd, ++tty_frame_count));
571

572 573
  SET_FRAME_VISIBLE (f, 1);

574 575
  f->terminal = terminal;
  f->terminal->reference_count++;
576
#ifdef MSDOS
577
  f->output_data.tty->display_info = &the_only_display_info;
578 579 580
  if (!inhibit_window_system
      && (!FRAMEP (selected_frame) || !FRAME_LIVE_P (XFRAME (selected_frame))
	  || XFRAME (selected_frame)->output_method == output_msdos_raw))
581
    f->output_method = output_msdos_raw;
582 583
  else
    f->output_method = output_termcap;
584 585 586 587 588 589
#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 */
590

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

  /* 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)))
597
    SET_FRAME_VISIBLE (XFRAME (FRAME_TTY (f)->top_frame), 2); /* obscured */
598 599 600

  FRAME_TTY (f)->top_frame = frame;

601 602
  if (!noninteractive)
    init_frame_faces (f);
603

Jim Blandy's avatar
Jim Blandy committed
604
  return f;
Jim Blandy's avatar
Jim Blandy committed
605
}
606

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

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))
620
    result = Fassq (parameter, XFRAME (selected_frame)->param_alist);
621 622 623 624 625 626 627 628 629 630
  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;
}

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

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

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")))

646 647
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
648
  (Lisp_Object parms)
649 650
{
  struct frame *f;
651
  struct terminal *t = NULL;
652
  Lisp_Object frame, tem;
653
  struct frame *sf = SELECTED_FRAME ();
654

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

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

667
  {
668
    Lisp_Object terminal;
669

670
    terminal = Fassq (Qterminal, parms);
671
    if (CONSP (terminal))
672
      {
673 674
        terminal = XCDR (terminal);
        t = get_terminal (terminal, 1);
675
      }
676 677 678 679 680 681 682
#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
683
  }
684

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

690 691 692 693 694
      tty = get_future_frame_param
        (Qtty, parms, (FRAME_TERMCAP_P (XFRAME (selected_frame))
                       ? FRAME_TTY (XFRAME (selected_frame))->name
                       : NULL));
      if (!NILP (tty))
695
	name = xlispstrdupa (tty);
696

697 698 699 700 701
      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))
702
	type = xlispstrdupa (tty_type);
703

704
      t = init_tty (name, type, 0); /* Errors are not fatal.  */
705
    }
706

707
  f = make_terminal_frame (t);
708

709 710
  {
    int width, height;
711
    get_tty_size (fileno (FRAME_TTY (f)->input), &width, &height);
712 713
    change_frame_size (f, height, width, 0, 0, 0);
  }
714

715
  adjust_glyphs (f);
716 717
  calculate_costs (f);
  XSETFRAME (frame, f);
718 719

  store_in_alist (&parms, Qtty_type, build_string (t->display_info.tty->type));
Paul Eggert's avatar
Paul Eggert committed
720
  store_in_alist (&parms, Qtty,
721 722 723
		  (t->display_info.tty->name
		   ? build_string (t->display_info.tty->name)
		   : Qnil));
724
  Fmodify_frame_parameters (frame, parms);
725

726 727
  /* Make the frame face alist be frame-specific, so that each
     frame could change its face definitions independently.  */
728
  fset_face_alist (f, Fcopy_alist (sf->face_alist));
729 730 731
  /* 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.  */
732
  for (tem = f->face_alist; CONSP (tem); tem = XCDR (tem))
733
    XSETCDR (XCAR (tem), Fcopy_sequence (XCDR (XCAR (tem))));
734 735
  return frame;
}
736

Jim Blandy's avatar
Jim Blandy committed
737

738 739 740 741 742 743 744 745 746 747
/* 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
748
   deleted, which includes the possibility that the frame's terminal
749 750 751
   is dead.

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

753
Lisp_Object
754
do_switch_frame (Lisp_Object frame, int track, int for_deletion, Lisp_Object norecord)
Jim Blandy's avatar
Jim Blandy committed
755
{
756
  struct frame *sf = SELECTED_FRAME ();
757

758 759 760
  /* If FRAME is a switch-frame event, extract the frame we should
     switch to.  */
  if (CONSP (frame)
761 762 763
      && EQ (XCAR (frame), Qswitch_frame)
      && CONSP (XCDR (frame)))
    frame = XCAR (XCDR (frame));
764

765 766 767
  /* 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.  */
768
  CHECK_FRAME (frame);
769 770
  if (! FRAME_LIVE_P (XFRAME (frame)))
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
771

772
  if (sf == XFRAME (frame))
Jim Blandy's avatar
Jim Blandy committed
773
    return frame;
Jim Blandy's avatar
Jim Blandy committed
774

775 776 777
  /* This is too greedy; it causes inappropriate focus redirection
     that's hard to get rid of.  */
#if 0
778 779 780 781 782 783 784
  /* 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.  */
785 786 787
  if (track)
    {
      Lisp_Object tail;
788

789
      for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
790 791
	{
	  Lisp_Object focus;
792

793
	  if (!FRAMEP (XCAR (tail)))
794
	    emacs_abort ();
795

796
	  focus = FRAME_FOCUS_FRAME (XFRAME (XCAR (tail)));
797

798
	  if (FRAMEP (focus) && XFRAME (focus) == SELECTED_FRAME ())
799
	    Fredirect_frame_focus (XCAR (tail), frame);
800 801 802 803
	}
    }
#else /* ! 0 */
  /* Instead, apply it only to the frame we're pointing to.  */
804
#ifdef HAVE_WINDOW_SYSTEM
805
  if (track && FRAME_WINDOW_P (XFRAME (frame)))
806 807 808
    {
      Lisp_Object focus, xfocus;

809
      xfocus = x_get_focus_frame (XFRAME (frame));
810 811 812
      if (FRAMEP (xfocus))
	{
	  focus = FRAME_FOCUS_FRAME (XFRAME (xfocus));
813
	  if (FRAMEP (focus) && XFRAME (focus) == SELECTED_FRAME ())
814 815 816 817 818
	    Fredirect_frame_focus (xfocus, frame);
	}
    }
#endif /* HAVE_X_WINDOWS */
#endif /* ! 0 */
819

820
  if (!for_deletion && FRAME_HAS_MINIBUF_P (sf))
821 822
    resize_mini_window (XWINDOW (FRAME_MINIBUF_WINDOW (sf)), 1);

823
  if (FRAME_TERMCAP_P (XFRAME (frame)) || FRAME_MSDOS_P (XFRAME (frame)))
824
    {
825 826 827 828 829 830 831 832 833 834 835 836
      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);
	}
837 838 839
      FRAME_TTY (XFRAME (frame))->top_frame = frame;
    }

840 841 842
  selected_frame = frame;
  if (! FRAME_MINIBUF_ONLY_P (XFRAME (selected_frame)))
    last_nonminibuf_frame = XFRAME (selected_frame);
Jim Blandy's avatar
Jim Blandy committed
843

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

846
  /* We want to make sure that the next event generates a frame-switch
847
     event to the appropriate frame.  This seems kludgy to me, but
848 849 850 851
     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.  */
852
  internal_last_event_frame = Qnil;
853

Jim Blandy's avatar
Jim Blandy committed
854
  return frame;
Jim Blandy's avatar
Jim Blandy committed
855 856
}

Paul Eggert's avatar
Paul Eggert committed
857
DEFUN ("select-frame", Fselect_frame, Sselect_frame, 1, 2, "e",
858
       doc: /* Select FRAME.
859
Subsequent editing commands apply to its selected window.
860 861 862
Optional argument NORECORD means to neither change the order of
recently selected windows nor the buffer list.

863
The selection of FRAME lasts until the next time the user does
864 865 866
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
867
when returning to the command loop, because it still may have
868 869
the window system's input focus.  On a text terminal, the next
redisplay will display FRAME.
870 871

This function returns FRAME, or nil if FRAME has been deleted.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
872
  (Lisp_Object frame, Lisp_Object norecord)
873
{
874
  return do_switch_frame (frame, 1, 0, norecord);
875 876
}

877 878 879 880 881 882 883 884
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)
{
885
  return call0 (intern ("blink-cursor-check"));
886 887 888 889 890 891 892 893 894
}

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)
{
895
  return call0 (intern ("blink-cursor-suspend"));
896
}
897

898
DEFUN ("handle-switch-frame", Fhandle_switch_frame, Shandle_switch_frame, 1, 1, "e",
899 900 901 902 903 904 905 906
       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
907
  (Lisp_Object event)
908
{
909
  /* Preserve prefix arg that the command loop just cleared.  */
Paul Eggert's avatar
Paul Eggert committed
910
  kset_prefix_arg (current_kboard, Vcurrent_prefix_arg);
911
  Frun_hooks (1, &Qmouse_leave_buffer_hook);
912
  Fhandle_focus_in (event); // switch-frame implies a focus in.
913
  return do_switch_frame (event, 0, 0, Qnil);
914 915
}

Paul Eggert's avatar
Paul Eggert committed
916
DEFUN ("selected-frame", Fselected_frame, Sselected_frame, 0, 0, 0,
917
       doc: /* Return the frame that is now selected.  */)