frame.c 136 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

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

#include <c-ctype.h>

28
#include "lisp.h"
29
#include "character.h"
30 31 32 33 34

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

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

Chong Yidong's avatar
Chong Yidong committed
54 55 56 57
#ifdef HAVE_NS
Lisp_Object Qns_parse_geometry;
#endif

Kim F. Storm's avatar
Kim F. Storm committed
58 59
Lisp_Object Qframep, Qframe_live_p;
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;
Kim F. Storm's avatar
Kim F. Storm committed
66

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

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

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

Lisp_Object Qface_set_after_frame_default;

112 113
static Lisp_Object Qfocus_in_hook;
static Lisp_Object Qfocus_out_hook;
114
static Lisp_Object Qdelete_frame_functions;
115

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

118 119 120 121 122 123 124 125 126 127 128 129 130
/* The currently selected frame.  */

Lisp_Object selected_frame;

/* A frame which is not just a mini-buffer, or NULL if there are no such
   frames.  This is usually the most recent such frame that was selected.  */

static struct frame *last_nonminibuf_frame;

/* Nonzero means there is at least one garbaged frame.  */

bool frame_garbaged;

131 132 133 134
#ifdef HAVE_WINDOW_SYSTEM
static void x_report_frame_params (struct frame *, Lisp_Object *);
#endif

135
/* These setters are used only in this file, so they can be private.  */
136
static void
137 138 139 140
fset_buffer_predicate (struct frame *f, Lisp_Object val)
{
  f->buffer_predicate = val;
}
141
static void
142 143 144 145 146
fset_minibuffer_window (struct frame *f, Lisp_Object val)
{
  f->minibuffer_window = val;
}

147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
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);
}

165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
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);
182

183 184 185 186 187 188 189 190 191 192 193 194 195
  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");
}

196
static void
197
set_menu_bar_lines_1 (Lisp_Object window, int n)
198 199 200
{
  struct window *w = XWINDOW (window);

201 202
  w->top_line += n;
  w->total_lines -= n;
203

204
  /* Handle just the top child in a vertical split.  */
205 206 207 208 209 210 211 212 213
  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);
      }
214 215
}

216
void
217
set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
218 219 220 221 222 223
{
  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
224
     frame itself, and get an error because you can't switch buffers
225 226 227 228
     in or split the minibuffer window.  */
  if (FRAME_MINIBUF_ONLY_P (f))
    return;

229
  if (TYPE_RANGED_INTEGERP (int, value))
230 231 232 233
    nlines = XINT (value);
  else
    nlines = 0;

234 235
  if (nlines != olines)
    {
236
      windows_or_buffers_changed = 14;
237 238
      FRAME_WINDOW_SIZES_CHANGED (f) = 1;
      FRAME_MENU_BAR_LINES (f) = nlines;
239
      set_menu_bar_lines_1 (f->root_window, nlines - olines);
240
      adjust_frame_glyphs (f);
241
    }
242 243 244 245
}

Lisp_Object Vframe_list;

Jim Blandy's avatar
Jim Blandy committed
246

Jim Blandy's avatar
Jim Blandy committed
247
DEFUN ("framep", Fframep, Sframep, 1, 1, 0,
248
       doc: /* Return non-nil if OBJECT is a frame.
249 250 251 252 253 254
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.
255
See also `frame-live-p'.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
256
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
257
{
258
  if (!FRAMEP (object))
Jim Blandy's avatar
Jim Blandy committed
259
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
260
  switch (XFRAME (object)->output_method)
Jim Blandy's avatar
Jim Blandy committed
261
    {
262
    case output_initial: /* The initial frame is like a termcap frame. */
Jim Blandy's avatar
Jim Blandy committed
263 264 265
    case output_termcap:
      return Qt;
    case output_x_window:
266
      return Qx;
267 268
    case output_w32:
      return Qw32;
269 270
    case output_msdos_raw:
      return Qpc;
271 272
    case output_ns:
      return Qns;
Jim Blandy's avatar
Jim Blandy committed
273
    default:
274
      emacs_abort ();
Jim Blandy's avatar
Jim Blandy committed
275 276 277
    }
}

Jim Blandy's avatar
Jim Blandy committed
278
DEFUN ("frame-live-p", Fframe_live_p, Sframe_live_p, 1, 1, 0,
279 280
       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
281
frame, the return value indicates what sort of terminal device it is
Pavel Janík's avatar
Pavel Janík committed
282
displayed on.  See the documentation of `framep' for possible
Pavel Janík's avatar
Pavel Janík committed
283
return values.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
284
  (Lisp_Object object)
Jim Blandy's avatar
Jim Blandy committed
285
{
Jim Blandy's avatar
Jim Blandy committed
286 287 288
  return ((FRAMEP (object)
	   && FRAME_LIVE_P (XFRAME (object)))
	  ? Fframep (object)
Jim Blandy's avatar
Jim Blandy committed
289 290 291
	  : Qnil);
}

Paul Eggert's avatar
Paul Eggert committed
292
DEFUN ("window-system", Fwindow_system, Swindow_system, 0, 1, 0,
293
       doc: /* The name of the window system that FRAME is displaying through.
294 295 296 297 298 299 300 301 302 303 304 305
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
306
  (Lisp_Object frame)
307 308 309 310 311 312 313 314 315 316 317 318 319 320
{
  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;
321
}
322

Jim Blandy's avatar
Jim Blandy committed
323
struct frame *
324
make_frame (bool mini_p)
Jim Blandy's avatar
Jim Blandy committed
325
{
Jim Blandy's avatar
Jim Blandy committed
326 327
  Lisp_Object frame;
  register struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
328 329
  register Lisp_Object root_window;
  register Lisp_Object mini_window;
330 331

  f = allocate_frame ();
332
  XSETFRAME (frame, f);
Jim Blandy's avatar
Jim Blandy committed
333

334 335
  /* Initialize Lisp data.  Note that allocate_frame initializes all
     Lisp data to nil, so do it only for slots which should not be nil.  */
336
  fset_tool_bar_position (f, Qtop);
337 338 339 340 341

  /* 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
342
  f->wants_modeline = 1;
343
  f->garbaged = 1;
344
  f->vertical_scroll_bar_type = vertical_scroll_bar_none;
345 346
  f->column_width = 1;  /* !FRAME_WINDOW_P value */
  f->line_height = 1;  /* !FRAME_WINDOW_P value */
347
#ifdef HAVE_WINDOW_SYSTEM
348
  f->want_fullscreen = FULLSCREEN_NONE;
349
#endif
Jim Blandy's avatar
Jim Blandy committed
350

351
  root_window = make_window ();
Jim Blandy's avatar
Jim Blandy committed
352 353
  if (mini_p)
    {
354
      mini_window = make_window ();
Paul Eggert's avatar
Paul Eggert committed
355 356
      wset_next (XWINDOW (root_window), mini_window);
      wset_prev (XWINDOW (mini_window), root_window);
357
      XWINDOW (mini_window)->mini = 1;
Paul Eggert's avatar
Paul Eggert committed
358
      wset_frame (XWINDOW (mini_window), frame);
359
      fset_minibuffer_window (f, mini_window);
Jim Blandy's avatar
Jim Blandy committed
360 361 362 363
    }
  else
    {
      mini_window = Qnil;
Paul Eggert's avatar
Paul Eggert committed
364
      wset_next (XWINDOW (root_window), Qnil);
365
      fset_minibuffer_window (f, Qnil);
Jim Blandy's avatar
Jim Blandy committed
366 367
    }

Paul Eggert's avatar
Paul Eggert committed
368
  wset_frame (XWINDOW (root_window), frame);
Jim Blandy's avatar
Jim Blandy committed
369 370 371

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

374 375
  SET_FRAME_COLS (f, 10);
  FRAME_LINES (f) = 10;
Jim Blandy's avatar
Jim Blandy committed
376

377 378
  XWINDOW (root_window)->total_cols = 10;
  XWINDOW (root_window)->total_lines = mini_p ? 9 : 10;
Jim Blandy's avatar
Jim Blandy committed
379 380 381

  if (mini_p)
    {
382 383 384
      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
385 386
    }

Jim Blandy's avatar
Jim Blandy committed
387
  /* Choose a buffer for the frame's root window.  */
Jim Blandy's avatar
Jim Blandy committed
388
  {
389
    Lisp_Object buf = Fcurrent_buffer ();
Jim Blandy's avatar
Jim Blandy committed
390

391 392
    /* If current buffer is hidden, try to find another one.  */
    if (BUFFER_HIDDEN_P (XBUFFER (buf)))
393
      buf = other_buffer_safely (buf);
394

395 396
    /* 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
397
       arrangement is not yet fully initialized at this point.  Windows
398 399 400
       don't have the right size, glyph matrices aren't initialized
       etc.  Running Lisp functions at this point surely ends in a
       SEGV.  */
401
    set_window_buffer (root_window, buf, 0, 0);
402
    fset_buffer_list (f, list1 (buf));
Jim Blandy's avatar
Jim Blandy committed
403 404
  }

Jim Blandy's avatar
Jim Blandy committed
405
  if (mini_p)
406 407 408 409 410
    set_window_buffer (mini_window,
		       (NILP (Vminibuffer_list)
			? get_minibuffer (0)
			: Fcar (Vminibuffer_list)),
		       0, 0);
Jim Blandy's avatar
Jim Blandy committed
411

412 413
  fset_root_window (f, root_window);
  fset_selected_window (f, root_window);
Jim Blandy's avatar
Jim Blandy committed
414 415
  /* Make sure this window seems more recently used than
     a newly-created, never-selected window.  */
416
  XWINDOW (f->selected_window)->use_time = ++window_select_count;
Jim Blandy's avatar
Jim Blandy committed
417

Jim Blandy's avatar
Jim Blandy committed
418
  return f;
Jim Blandy's avatar
Jim Blandy committed
419 420
}

421
#ifdef HAVE_WINDOW_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
422
/* Make a frame using a separate minibuffer window on another frame.
Jim Blandy's avatar
Jim Blandy committed
423 424 425
   MINI_WINDOW is the minibuffer window to use.  nil means use the
   default (the global minibuffer).  */

Jim Blandy's avatar
Jim Blandy committed
426
struct frame *
427
make_frame_without_minibuffer (register Lisp_Object mini_window, KBOARD *kb, Lisp_Object display)
Jim Blandy's avatar
Jim Blandy committed
428
{
Jim Blandy's avatar
Jim Blandy committed
429
  register struct frame *f;
430
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
431

432
  if (!NILP (mini_window))
433
    CHECK_LIVE_WINDOW (mini_window);
Jim Blandy's avatar
Jim Blandy committed
434

435
  if (!NILP (mini_window)
436
      && FRAME_KBOARD (XFRAME (XWINDOW (mini_window)->frame)) != kb)
437
    error ("Frame and minibuffer must be on the same terminal");
438

Jim Blandy's avatar
Jim Blandy committed
439 440
  /* Make a frame containing just a root window.  */
  f = make_frame (0);
Jim Blandy's avatar
Jim Blandy committed
441

442 443 444
  if (NILP (mini_window))
    {
      /* Use default-minibuffer-frame if possible.  */
445 446
      if (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
	  || ! FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame))))
447
	{
448 449 450 451
          Lisp_Object frame_dummy;

          XSETFRAME (frame_dummy, f);
          GCPRO1 (frame_dummy);
452
	  /* If there's no minibuffer frame to use, create one.  */
Paul Eggert's avatar
Paul Eggert committed
453 454
	  kset_default_minibuffer_frame
	    (kb, call1 (intern ("make-initial-minibuffer-frame"), display));
455
          UNGCPRO;
456
	}
457

458 459
      mini_window
	= XFRAME (KVAR (kb, Vdefault_minibuffer_frame))->minibuffer_window;
460
    }
461

462
  fset_minibuffer_window (f, mini_window);
463 464 465

  /* Make the chosen minibuffer window display the proper minibuffer,
     unless it is already showing a minibuffer.  */
466
  if (NILP (Fmemq (XWINDOW (mini_window)->contents, Vminibuffer_list)))
467 468 469 470 471 472
    /* 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
473
  return f;
Jim Blandy's avatar
Jim Blandy committed
474 475
}

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

Jim Blandy's avatar
Jim Blandy committed
478
struct frame *
479
make_minibuffer_frame (void)
Jim Blandy's avatar
Jim Blandy committed
480
{
Jim Blandy's avatar
Jim Blandy committed
481
  /* First make a frame containing just a root window, no minibuffer.  */
Jim Blandy's avatar
Jim Blandy committed
482

Jim Blandy's avatar
Jim Blandy committed
483
  register struct frame *f = make_frame (0);
Jim Blandy's avatar
Jim Blandy committed
484
  register Lisp_Object mini_window;
Jim Blandy's avatar
Jim Blandy committed
485
  register Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
486

487
  XSETFRAME (frame, f);
Jim Blandy's avatar
Jim Blandy committed
488

489
  f->auto_raise = 0;
Jim Blandy's avatar
Jim Blandy committed
490 491 492
  f->auto_lower = 0;
  f->no_split = 1;
  f->wants_modeline = 0;
Jim Blandy's avatar
Jim Blandy committed
493 494 495 496 497

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

498 499
  mini_window = f->root_window;
  fset_minibuffer_window (f, mini_window);
500
  XWINDOW (mini_window)->mini = 1;
Paul Eggert's avatar
Paul Eggert committed
501 502 503
  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
504 505 506

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

507 508 509 510 511 512
  /* 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
513
  return f;
Jim Blandy's avatar
Jim Blandy committed
514
}
515
#endif /* HAVE_WINDOW_SYSTEM */
Jim Blandy's avatar
Jim Blandy committed
516

517
/* Construct a frame that refers to a terminal.  */
Jim Blandy's avatar
Jim Blandy committed
518

519
static printmax_t tty_frame_count;
520

Jim Blandy's avatar
Jim Blandy committed
521
struct frame *
522
make_initial_frame (void)
Jim Blandy's avatar
Jim Blandy committed
523
{
524
  struct frame *f;
525
  struct terminal *terminal;
526
  Lisp_Object frame;
527

528
  eassert (initial_kboard);
529

530 531 532
  /* The first call must initialize Vframe_list.  */
  if (! (NILP (Vframe_list) || CONSP (Vframe_list)))
    Vframe_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
533

534
  terminal = init_initial_terminal ();
535 536 537 538 539 540

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

  Vframe_list = Fcons (frame, Vframe_list);

541
  tty_frame_count = 1;
542
  fset_name (f, build_pure_c_string ("F1"));
543

544
  SET_FRAME_VISIBLE (f, 1);
545

546 547 548
  f->output_method = terminal->type;
  f->terminal = terminal;
  f->terminal->reference_count++;
549
  f->output_data.nothing = 0;
550

551 552
  FRAME_FOREGROUND_PIXEL (f) = FACE_TTY_DEFAULT_FG_COLOR;
  FRAME_BACKGROUND_PIXEL (f) = FACE_TTY_DEFAULT_BG_COLOR;
553

554
  FRAME_VERTICAL_SCROLL_BAR_TYPE (f) = vertical_scroll_bar_none;
555 556 557

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

559 560 561
  if (!noninteractive)
    init_frame_faces (f);

562 563
  last_nonminibuf_frame = f;

564 565 566 567
  return f;
}


568
static struct frame *
569
make_terminal_frame (struct terminal *terminal)
570 571 572
{
  register struct frame *f;
  Lisp_Object frame;
573
  char name[sizeof "F" + INT_STRLEN_BOUND (printmax_t)];
574

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

Jim Blandy's avatar
Jim Blandy committed
578
  f = make_frame (1);
579

580
  XSETFRAME (frame, f);
581 582
  Vframe_list = Fcons (frame, Vframe_list);

583
  fset_name (f, make_formatted_string (name, "F%"pMd, ++tty_frame_count));
584

585 586
  SET_FRAME_VISIBLE (f, 1);

587 588
  f->terminal = terminal;
  f->terminal->reference_count++;
589
#ifdef MSDOS
590
  f->output_data.tty->display_info = &the_only_display_info;
591 592 593
  if (!inhibit_window_system
      && (!FRAMEP (selected_frame) || !FRAME_LIVE_P (XFRAME (selected_frame))
	  || XFRAME (selected_frame)->output_method == output_msdos_raw))
594
    f->output_method = output_msdos_raw;
595 596
  else
    f->output_method = output_termcap;
597 598 599 600 601 602
#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 */
603

604
  FRAME_VERTICAL_SCROLL_BAR_TYPE (f) = vertical_scroll_bar_none;
605
  FRAME_MENU_BAR_LINES(f) = NILP (Vmenu_bar_mode) ? 0 : 1;
606 607 608 609

  /* 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)))
610
    SET_FRAME_VISIBLE (XFRAME (FRAME_TTY (f)->top_frame), 2); /* obscured */
611 612 613

  FRAME_TTY (f)->top_frame = frame;

614 615
  if (!noninteractive)
    init_frame_faces (f);
616

Jim Blandy's avatar
Jim Blandy committed
617
  return f;
Jim Blandy's avatar
Jim Blandy committed
618
}
619

620 621
/* Get a suitable value for frame parameter PARAMETER for a newly
   created frame, based on (1) the user-supplied frame parameter
622
   alist SUPPLIED_PARMS, and (2) CURRENT_VALUE.  */
623 624 625 626 627 628 629 630 631 632

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))
633
    result = Fassq (parameter, XFRAME (selected_frame)->param_alist);
634 635 636 637 638 639 640 641 642 643
  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;
}

644
DEFUN ("make-terminal-frame", Fmake_terminal_frame, Smake_terminal_frame,
645
       1, 1, 0,
646
       doc: /* Create an additional terminal frame, possibly on another terminal.
647
This function takes one argument, an alist specifying frame parameters.
648

649 650
You can create multiple frames on a single text terminal, but only one
of them (the selected terminal frame) is actually displayed.
651 652 653 654 655 656 657 658

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

659 660
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
661
  (Lisp_Object parms)
662 663
{
  struct frame *f;
664
  struct terminal *t = NULL;
665
  Lisp_Object frame, tem;
666
  struct frame *sf = SELECTED_FRAME ();
667

668
#ifdef MSDOS
669 670
  if (sf->output_method != output_msdos_raw
      && sf->output_method != output_termcap)
671
    emacs_abort ();
672 673
#else /* not MSDOS */

674
#ifdef WINDOWSNT                           /* This should work now! */
675
  if (sf->output_method != output_termcap)
676
    error ("Not using an ASCII terminal now; cannot make a new ASCII frame");
677
#endif
678
#endif /* not MSDOS */
679

680
  {
681
    Lisp_Object terminal;
682

683
    terminal = Fassq (Qterminal, parms);
684
    if (CONSP (terminal))
685
      {
686 687
        terminal = XCDR (terminal);
        t = get_terminal (terminal, 1);
688
      }
689 690 691 692 693 694 695
#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
696
  }
697

698
  if (!t)
699
    {
700
      char *name = 0, *type = 0;
701
      Lisp_Object tty, tty_type;
702

703 704 705 706 707
      tty = get_future_frame_param
        (Qtty, parms, (FRAME_TERMCAP_P (XFRAME (selected_frame))
                       ? FRAME_TTY (XFRAME (selected_frame))->name
                       : NULL));
      if (!NILP (tty))
708
	name = xlispstrdupa (tty);
709

710 711 712 713 714
      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))
715
	type = xlispstrdupa (tty_type);
716

717
      t = init_tty (name, type, 0); /* Errors are not fatal.  */
718
    }
719

720
  f = make_terminal_frame (t);
721

722 723
  {
    int width, height;
724
    get_tty_size (fileno (FRAME_TTY (f)->input), &width, &height);
725 726
    change_frame_size (f, height, width, 0, 0, 0);
  }
727

728
  adjust_frame_glyphs (f);
729 730
  calculate_costs (f);
  XSETFRAME (frame, f);
731 732

  store_in_alist (&parms, Qtty_type, build_string (t->display_info.tty->type));
Paul Eggert's avatar
Paul Eggert committed
733
  store_in_alist (&parms, Qtty,
734 735 736
		  (t->display_info.tty->name
		   ? build_string (t->display_info.tty->name)
		   : Qnil));
737
  Fmodify_frame_parameters (frame, parms);
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
DEFUN ("handle-switch-frame", Fhandle_switch_frame, Shandle_switch_frame, 1, 1, "e",
891 892 893 894 895 896 897 898
       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
899
  (Lisp_Object event)
900
{
901
  /* Preserve prefix arg that the command loop just cleared.  */
Paul Eggert's avatar
Paul Eggert committed
902
  kset_prefix_arg (current_kboard, Vcurrent_prefix_arg);
903
  Frun_hooks (1, &Qmouse_leave_buffer_hook);
904 905
  /* `switch-frame' implies a focus in.  */
  call1 (intern ("handle-focus-in"), event);
906
  return do_switch_frame (event, 0, 0, Qnil);
907 908
}

Paul Eggert's avatar
Paul Eggert committed
909
DEFUN ("selected-frame", Fselected_frame, Sselected_frame, 0, 0, 0,
910
       doc: /* Return the frame that is now selected.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
911
  (void)
Jim Blandy's avatar
Jim Blandy committed
912
{
913
  return selected_frame;
Jim Blandy's avatar
Jim Blandy committed
914
}
915