frame.c 69.7 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Generic frame functions.
2
   Copyright (C) 1993, 1994, 1995 Free Software Foundation.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20

21
#include <config.h>
22 23

#include <stdio.h>
24 25
#include "lisp.h"
#include "frame.h"
26
#include "termhooks.h"
27
#include "window.h"
Morten Welinder's avatar
Morten Welinder committed
28 29 30
#ifdef MSDOS
#include "msdos.h"
#endif
Jim Blandy's avatar
Jim Blandy committed
31

32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
/* Evaluate this expression to rebuild the section of syms_of_frame
   that initializes and staticpros the symbols declared below.  Note
   that Emacs 18 has a bug that keeps C-x C-e from being able to
   evaluate this expression.

(progn
  ;; Accumulate a list of the symbols we want to initialize from the
  ;; declarations at the top of the file.
  (goto-char (point-min))
  (search-forward "/\*&&& symbols declared here &&&*\/\n")
  (let (symbol-list)
    (while (looking-at "Lisp_Object \\(Q[a-z_]+\\)")
      (setq symbol-list
	    (cons (buffer-substring (match-beginning 1) (match-end 1))
		  symbol-list))
      (forward-line 1))
    (setq symbol-list (nreverse symbol-list))
    ;; Delete the section of syms_of_... where we initialize the symbols.
    (search-forward "\n  /\*&&& init symbols here &&&*\/\n")
    (let ((start (point)))
      (while (looking-at "^  Q")
	(forward-line 2))
      (kill-region start (point)))
    ;; Write a new symbol initialization section.
    (while symbol-list
      (insert (format "  %s = intern (\"" (car symbol-list)))
      (let ((start (point)))
	(insert (substring (car symbol-list) 1))
	(subst-char-in-region start (point) ?_ ?-))
      (insert (format "\");\n  staticpro (&%s);\n" (car symbol-list)))
      (setq symbol-list (cdr symbol-list)))))
  */        

65 66
/* We need most of these symbols even if not MULTI_FRAME;
   easiest to define them all, all of the time.  */
67 68
/*&&& symbols declared here &&&*/
Lisp_Object Qframep;
Jim Blandy's avatar
Jim Blandy committed
69
Lisp_Object Qframe_live_p;
70 71
Lisp_Object Qheight;
Lisp_Object Qicon;
Jim Blandy's avatar
Jim Blandy committed
72
Lisp_Object Qminibuffer;
73 74 75 76
Lisp_Object Qmodeline;
Lisp_Object Qname;
Lisp_Object Qonly;
Lisp_Object Qunsplittable;
77
Lisp_Object Qmenu_bar_lines;
78 79
Lisp_Object Qwidth;
Lisp_Object Qx;
80
Lisp_Object Qwin32;
81
Lisp_Object Qvisible;
82
Lisp_Object Qbuffer_predicate;
83
Lisp_Object Qtitle;
Jim Blandy's avatar
Jim Blandy committed
84

85
Lisp_Object Vterminal_frame;
86
Lisp_Object Vdefault_frame_alist;
87

88 89
Lisp_Object Qmouse_leave_buffer_hook;

90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
static void
syms_of_frame_1 ()
{
  /*&&& init symbols here &&&*/
  Qframep = intern ("framep");
  staticpro (&Qframep);
  Qframe_live_p = intern ("frame-live-p");
  staticpro (&Qframe_live_p);
  Qheight = intern ("height");
  staticpro (&Qheight);
  Qicon = intern ("icon");
  staticpro (&Qicon);
  Qminibuffer = intern ("minibuffer");
  staticpro (&Qminibuffer);
  Qmodeline = intern ("modeline");
  staticpro (&Qmodeline);
  Qname = intern ("name");
  staticpro (&Qname);
  Qonly = intern ("only");
  staticpro (&Qonly);
  Qunsplittable = intern ("unsplittable");
  staticpro (&Qunsplittable);
  Qmenu_bar_lines = intern ("menu-bar-lines");
  staticpro (&Qmenu_bar_lines);
  Qwidth = intern ("width");
  staticpro (&Qwidth);
  Qx = intern ("x");
  staticpro (&Qx);
118 119
  Qwin32 = intern ("win32");
  staticpro (&Qwin32);
120 121 122 123
  Qvisible = intern ("visible");
  staticpro (&Qvisible);
  Qbuffer_predicate = intern ("buffer-predicate");
  staticpro (&Qbuffer_predicate);
124 125
  Qtitle = intern ("title");
  staticpro (&Qtitle);
126 127 128

  Qmouse_leave_buffer_hook = intern ("mouse-leave-buffer-hook");
  staticpro (&Qmouse_leave_buffer_hook);
129 130 131 132 133 134 135 136 137 138 139 140 141

  DEFVAR_LISP ("default-frame-alist", &Vdefault_frame_alist,
    "Alist of default values for frame creation.\n\
These may be set in your init file, like this:\n\
  (setq default-frame-alist '((width . 80) (height . 55) (menu-bar-lines . 1))\n\
These override values given in window system configuration data,\n\
 including X Windows' defaults database.\n\
For values specific to the first Emacs frame, see `initial-frame-alist'.\n\
For values specific to the separate minibuffer frame, see\n\
 `minibuffer-frame-alist'.\n\
The `menu-bar-lines' element of the list controls whether new frames\n\
 have menu bars; `menu-bar-mode' works by altering this element.");
  Vdefault_frame_alist = Qnil;
142 143 144 145 146 147 148 149 150
}

static void
set_menu_bar_lines_1 (window, n)
  Lisp_Object window;
  int n;
{
  struct window *w = XWINDOW (window);

151
  XSETFASTINT (w->last_modified, 0);
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
  XSETFASTINT (w->top, XFASTINT (w->top) + n);
  XSETFASTINT (w->height, XFASTINT (w->height) - n);

  /* Handle just the top child in a vertical split.  */
  if (!NILP (w->vchild))
    set_menu_bar_lines_1 (w->vchild, n);

  /* Adjust all children in a horizontal split.  */
  for (window = w->hchild; !NILP (window); window = w->next)
    {
      w = XWINDOW (window);
      set_menu_bar_lines_1 (window, n);
    }
}

static void
set_menu_bar_lines (f, value, oldval)
     struct frame *f;
     Lisp_Object value, oldval;
{
  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
     frame itslef, and get an error because you can't switch buffers
     in or split the minibuffer window.  */
  if (FRAME_MINIBUF_ONLY_P (f))
    return;

  if (INTEGERP (value))
    nlines = XINT (value);
  else
    nlines = 0;

187 188 189 190 191 192 193
  if (nlines != olines)
    {
      windows_or_buffers_changed++;
      FRAME_WINDOW_SIZES_CHANGED (f) = 1;
      FRAME_MENU_BAR_LINES (f) = nlines;
      set_menu_bar_lines_1 (f->root_window, nlines - olines);
    }
194 195 196 197 198 199 200 201 202 203 204 205 206
}

#ifdef MULTI_FRAME

#include "buffer.h"

/* These help us bind and responding to switch-frame events.  */
#include "commands.h"
#include "keyboard.h"

Lisp_Object Vemacs_iconified;
Lisp_Object Vframe_list;

Jim Blandy's avatar
Jim Blandy committed
207 208
extern Lisp_Object Vminibuffer_list;
extern Lisp_Object get_minibuffer ();
209 210
extern Lisp_Object Fhandle_switch_frame ();
extern Lisp_Object Fredirect_frame_focus ();
Karl Heuer's avatar
Karl Heuer committed
211
extern Lisp_Object x_get_focus_frame ();
Jim Blandy's avatar
Jim Blandy committed
212

Jim Blandy's avatar
Jim Blandy committed
213 214 215
DEFUN ("framep", Fframep, Sframep, 1, 1, 0,
  "Return non-nil if OBJECT is a frame.\n\
Value is t for a termcap frame (a character-only terminal),\n\
Morten Welinder's avatar
Morten Welinder committed
216 217
`x' for an Emacs frame that is really an X window,\n\
`pc' for a direct-write MS-DOS frame.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
218
See also `frame-live-p'.")
Jim Blandy's avatar
Jim Blandy committed
219 220
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
221
{
222
  if (!FRAMEP (object))
Jim Blandy's avatar
Jim Blandy committed
223
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
224
  switch (XFRAME (object)->output_method)
Jim Blandy's avatar
Jim Blandy committed
225 226 227 228
    {
    case output_termcap:
      return Qt;
    case output_x_window:
229
      return Qx;
230 231
    case output_win32:
      return Qwin32;
Morten Welinder's avatar
Morten Welinder committed
232
      /* The `pc' case is in the Fframep below.  */
Jim Blandy's avatar
Jim Blandy committed
233 234 235 236 237
    default:
      abort ();
    }
}

Jim Blandy's avatar
Jim Blandy committed
238
DEFUN ("frame-live-p", Fframe_live_p, Sframe_live_p, 1, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
239 240 241 242 243
  "Return non-nil if OBJECT is a frame which has not been deleted.\n\
Value is nil if OBJECT is not a live frame.  If object is a live\n\
frame, the return value indicates what sort of output device it is\n\
displayed on.  Value is t for a termcap frame (a character-only\n\
terminal), `x' for an Emacs frame being displayed in an X window.")
Jim Blandy's avatar
Jim Blandy committed
244 245 246
  (object)
     Lisp_Object object;
{
Jim Blandy's avatar
Jim Blandy committed
247 248 249
  return ((FRAMEP (object)
	   && FRAME_LIVE_P (XFRAME (object)))
	  ? Fframep (object)
Jim Blandy's avatar
Jim Blandy committed
250 251 252
	  : Qnil);
}

Jim Blandy's avatar
Jim Blandy committed
253 254
struct frame *
make_frame (mini_p)
Jim Blandy's avatar
Jim Blandy committed
255 256
     int mini_p;
{
Jim Blandy's avatar
Jim Blandy committed
257 258
  Lisp_Object frame;
  register struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
259 260
  register Lisp_Object root_window;
  register Lisp_Object mini_window;
261 262 263 264 265 266 267 268 269
  register struct Lisp_Vector *vec;
  int i;

  vec = allocate_vectorlike ((EMACS_INT) VECSIZE (struct frame));
  for (i = 0; i < VECSIZE (struct frame); i++)
    XSETFASTINT (vec->contents[i], 0);
  vec->size = VECSIZE (struct frame);
  f = (struct frame *)vec;
  XSETFRAME (frame, f);
Jim Blandy's avatar
Jim Blandy committed
270 271 272 273 274 275

  f->cursor_x = 0;
  f->cursor_y = 0;
  f->current_glyphs = 0;
  f->desired_glyphs = 0;
  f->visible = 0;
276
  f->async_visible = 0;
277
  f->output_data.nothing = 0;
Jim Blandy's avatar
Jim Blandy committed
278
  f->iconified = 0;
279
  f->async_iconified = 0;
Jim Blandy's avatar
Jim Blandy committed
280 281 282 283 284 285
  f->wants_modeline = 1;
  f->auto_raise = 0;
  f->auto_lower = 0;
  f->no_split = 0;
  f->garbaged = 0;
  f->has_minibuffer = mini_p;
286
  f->focus_frame = Qnil;
287
  f->explicit_name = 0;
288 289
  f->can_have_scroll_bars = 0;
  f->has_vertical_scroll_bars = 0;
Jim Blandy's avatar
Jim Blandy committed
290
  f->param_alist = Qnil;
291 292
  f->scroll_bars = Qnil;
  f->condemned_scroll_bars = Qnil;
293
  f->face_alist = Qnil;
294
  f->menu_bar_items = Qnil;
295 296
  f->menu_bar_vector = Qnil;
  f->menu_bar_items_used = 0;
297
  f->buffer_predicate = Qnil;
298 299 300
#ifdef MULTI_KBOARD
  f->kboard = initial_kboard;
#endif
301
  f->namebuf = 0;
Jim Blandy's avatar
Jim Blandy committed
302

303
  root_window = make_window ();
Jim Blandy's avatar
Jim Blandy committed
304 305
  if (mini_p)
    {
306
      mini_window = make_window ();
Jim Blandy's avatar
Jim Blandy committed
307 308 309
      XWINDOW (root_window)->next = mini_window;
      XWINDOW (mini_window)->prev = root_window;
      XWINDOW (mini_window)->mini_p = Qt;
Jim Blandy's avatar
Jim Blandy committed
310 311
      XWINDOW (mini_window)->frame = frame;
      f->minibuffer_window = mini_window;
Jim Blandy's avatar
Jim Blandy committed
312 313 314 315 316
    }
  else
    {
      mini_window = Qnil;
      XWINDOW (root_window)->next = Qnil;
Jim Blandy's avatar
Jim Blandy committed
317
      f->minibuffer_window = Qnil;
Jim Blandy's avatar
Jim Blandy committed
318 319
    }

Jim Blandy's avatar
Jim Blandy committed
320
  XWINDOW (root_window)->frame = frame;
Jim Blandy's avatar
Jim Blandy committed
321 322 323

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

Jim Blandy's avatar
Jim Blandy committed
326 327
  f->width = 10;
  f->height = 10;
Jim Blandy's avatar
Jim Blandy committed
328

329 330
  XSETFASTINT (XWINDOW (root_window)->width, 10);
  XSETFASTINT (XWINDOW (root_window)->height, (mini_p ? 9 : 10));
Jim Blandy's avatar
Jim Blandy committed
331 332 333

  if (mini_p)
    {
334 335 336
      XSETFASTINT (XWINDOW (mini_window)->width, 10);
      XSETFASTINT (XWINDOW (mini_window)->top, 9);
      XSETFASTINT (XWINDOW (mini_window)->height, 1);
Jim Blandy's avatar
Jim Blandy committed
337 338
    }

Jim Blandy's avatar
Jim Blandy committed
339
  /* Choose a buffer for the frame's root window.  */
Jim Blandy's avatar
Jim Blandy committed
340 341 342 343 344 345 346 347
  {
    Lisp_Object buf;

    XWINDOW (root_window)->buffer = Qt;
    buf = Fcurrent_buffer ();
    /* If buf is a 'hidden' buffer (i.e. one whose name starts with
       a space), try to find another one.  */
    if (XSTRING (Fbuffer_name (buf))->data[0] == ' ')
348
      buf = Fother_buffer (buf, Qnil);
Jim Blandy's avatar
Jim Blandy committed
349 350 351
    Fset_window_buffer (root_window, buf);
  }

Jim Blandy's avatar
Jim Blandy committed
352 353 354 355
  if (mini_p)
    {
      XWINDOW (mini_window)->buffer = Qt;
      Fset_window_buffer (mini_window,
Jim Blandy's avatar
Jim Blandy committed
356
			  (NILP (Vminibuffer_list)
Jim Blandy's avatar
Jim Blandy committed
357 358 359 360
			   ? get_minibuffer (0)
			   : Fcar (Vminibuffer_list)));
    }

Jim Blandy's avatar
Jim Blandy committed
361 362
  f->root_window = root_window;
  f->selected_window = root_window;
Jim Blandy's avatar
Jim Blandy committed
363 364
  /* Make sure this window seems more recently used than
     a newly-created, never-selected window.  */
365
  XSETFASTINT (XWINDOW (f->selected_window)->use_time, ++window_select_count);
Jim Blandy's avatar
Jim Blandy committed
366

Jim Blandy's avatar
Jim Blandy committed
367
  return f;
Jim Blandy's avatar
Jim Blandy committed
368 369
}

Jim Blandy's avatar
Jim Blandy committed
370
/* Make a frame using a separate minibuffer window on another frame.
Jim Blandy's avatar
Jim Blandy committed
371 372 373
   MINI_WINDOW is the minibuffer window to use.  nil means use the
   default (the global minibuffer).  */

Jim Blandy's avatar
Jim Blandy committed
374
struct frame *
375
make_frame_without_minibuffer (mini_window, kb, display)
Jim Blandy's avatar
Jim Blandy committed
376
     register Lisp_Object mini_window;
377
     KBOARD *kb;
378
     Lisp_Object display;
Jim Blandy's avatar
Jim Blandy committed
379
{
Jim Blandy's avatar
Jim Blandy committed
380
  register struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
381

382 383
  if (!NILP (mini_window))
    CHECK_LIVE_WINDOW (mini_window, 0);
Jim Blandy's avatar
Jim Blandy committed
384

385
#ifdef MULTI_KBOARD
386 387
  if (!NILP (mini_window)
      && XFRAME (XWINDOW (mini_window)->frame)->kboard != kb)
388 389 390
    error ("frame and minibuffer must be on the same display");
#endif

Jim Blandy's avatar
Jim Blandy committed
391 392
  /* Make a frame containing just a root window.  */
  f = make_frame (0);
Jim Blandy's avatar
Jim Blandy committed
393

394 395 396 397 398 399 400 401 402 403 404 405
  if (NILP (mini_window))
    {
      /* Use default-minibuffer-frame if possible.  */
      if (!FRAMEP (kb->Vdefault_minibuffer_frame)
	  || ! FRAME_LIVE_P (XFRAME (kb->Vdefault_minibuffer_frame)))
	{
	  /* If there's no minibuffer frame to use, create one.  */
	  kb->Vdefault_minibuffer_frame
	    = call1 (intern ("make-initial-minibuffer-frame"), display);
	}
      mini_window = XFRAME (kb->Vdefault_minibuffer_frame)->minibuffer_window;
    }
Jim Blandy's avatar
Jim Blandy committed
406
  /* Install the chosen minibuffer window, with proper buffer.  */
Jim Blandy's avatar
Jim Blandy committed
407
  f->minibuffer_window = mini_window;
Jim Blandy's avatar
Jim Blandy committed
408
  Fset_window_buffer (mini_window,
Jim Blandy's avatar
Jim Blandy committed
409
		      (NILP (Vminibuffer_list)
Jim Blandy's avatar
Jim Blandy committed
410 411
		       ? get_minibuffer (0)
		       : Fcar (Vminibuffer_list)));
Jim Blandy's avatar
Jim Blandy committed
412
  return f;
Jim Blandy's avatar
Jim Blandy committed
413 414
}

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

Jim Blandy's avatar
Jim Blandy committed
417 418
struct frame *
make_minibuffer_frame ()
Jim Blandy's avatar
Jim Blandy committed
419
{
Jim Blandy's avatar
Jim Blandy committed
420
  /* First make a frame containing just a root window, no minibuffer.  */
Jim Blandy's avatar
Jim Blandy committed
421

Jim Blandy's avatar
Jim Blandy committed
422
  register struct frame *f = make_frame (0);
Jim Blandy's avatar
Jim Blandy committed
423
  register Lisp_Object mini_window;
Jim Blandy's avatar
Jim Blandy committed
424
  register Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
425

426
  XSETFRAME (frame, f);
Jim Blandy's avatar
Jim Blandy committed
427

428
  f->auto_raise = 0;
Jim Blandy's avatar
Jim Blandy committed
429 430 431 432
  f->auto_lower = 0;
  f->no_split = 1;
  f->wants_modeline = 0;
  f->has_minibuffer = 1;
Jim Blandy's avatar
Jim Blandy committed
433 434 435 436 437

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

Jim Blandy's avatar
Jim Blandy committed
438
  mini_window = f->minibuffer_window = f->root_window;
Jim Blandy's avatar
Jim Blandy committed
439 440
  XWINDOW (mini_window)->mini_p = Qt;
  XWINDOW (mini_window)->next = Qnil;
441
  XWINDOW (mini_window)->prev = Qnil;
Jim Blandy's avatar
Jim Blandy committed
442
  XWINDOW (mini_window)->frame = frame;
Jim Blandy's avatar
Jim Blandy committed
443 444 445 446

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

  Fset_window_buffer (mini_window,
Jim Blandy's avatar
Jim Blandy committed
447
		      (NILP (Vminibuffer_list)
Jim Blandy's avatar
Jim Blandy committed
448 449
		       ? get_minibuffer (0)
		       : Fcar (Vminibuffer_list)));
Jim Blandy's avatar
Jim Blandy committed
450
  return f;
Jim Blandy's avatar
Jim Blandy committed
451 452
}

Jim Blandy's avatar
Jim Blandy committed
453
/* Construct a frame that refers to the terminal (stdin and stdout).  */
Jim Blandy's avatar
Jim Blandy committed
454

455 456
static int terminal_frame_count;

Jim Blandy's avatar
Jim Blandy committed
457 458
struct frame *
make_terminal_frame ()
Jim Blandy's avatar
Jim Blandy committed
459
{
Jim Blandy's avatar
Jim Blandy committed
460
  register struct frame *f;
461
  Lisp_Object frame;
462 463
  char name[20];

464 465 466 467 468
#ifdef MULTI_KBOARD
  if (!initial_kboard)
    {
      initial_kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
      init_kboard (initial_kboard);
469 470
      initial_kboard->next_kboard = all_kboards;
      all_kboards = initial_kboard;
471 472 473
    }
#endif

474 475 476
  /* The first call must initialize Vframe_list.  */
  if (! (NILP (Vframe_list) || CONSP (Vframe_list)))
    Vframe_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
477 478

  f = make_frame (1);
479

480
  XSETFRAME (frame, f);
481 482
  Vframe_list = Fcons (frame, Vframe_list);

483
  terminal_frame_count++;
484 485 486 487 488 489 490 491 492
  if (terminal_frame_count == 1)
    {
      f->name = build_string ("Emacs");
    }
  else
    {
      sprintf (name, "Emacs-%d", terminal_frame_count);
      f->name = build_string (name);
    }
493 494 495

  f->visible = 1;		/* FRAME_SET_VISIBLE wd set frame_garbaged. */
  f->async_visible = 1;		/* Don't let visible be cleared later. */
496
  f->output_data.nothing = 1;	/* Nonzero means frame isn't deleted.  */
Jim Blandy's avatar
Jim Blandy committed
497
  return f;
Jim Blandy's avatar
Jim Blandy committed
498
}
499 500

DEFUN ("make-terminal-frame", Fmake_terminal_frame, Smake_terminal_frame,
501 502 503 504 505 506
       1, 1, 0, "Create an additional terminal frame.\n\
You can create multiple frames on a text-only terminal in this way.\n\
Only the selected terminal frame is actually displayed.\n\
This function takes one argument, an alist specifying frame parameters.\n\
In practice, generally you don't need to specify any parameters.\n\
Note that changing the size of one terminal frame automatically affects all.")
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522
  (parms)
     Lisp_Object parms;
{
  struct frame *f;
  Lisp_Object frame;

  if (selected_frame->output_method != output_termcap)
    error ("Not using an ASCII terminal now; cannot make a new ASCII frame");

  f = make_terminal_frame ();
  change_frame_size (f, FRAME_HEIGHT (selected_frame),
		     FRAME_WIDTH (selected_frame), 0, 0);
  remake_frame_glyphs (f);
  calculate_costs (f);
  XSETFRAME (frame, f);
  Fmodify_frame_parameters (frame, parms);
523
  f->face_alist = selected_frame->face_alist;
524 525
  return frame;
}
Jim Blandy's avatar
Jim Blandy committed
526

527
Lisp_Object
528
do_switch_frame (frame, no_enter, track)
Jim Blandy's avatar
Jim Blandy committed
529
     Lisp_Object frame, no_enter;
530
     int track;
Jim Blandy's avatar
Jim Blandy committed
531
{
532 533 534 535 536 537 538
  /* If FRAME is a switch-frame event, extract the frame we should
     switch to.  */
  if (CONSP (frame)
      && EQ (XCONS (frame)->car, Qswitch_frame)
      && CONSP (XCONS (frame)->cdr))
    frame = XCONS (XCONS (frame)->cdr)->car;

539 540 541 542 543 544
  /* 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.  */
  CHECK_FRAME (frame, 0);
  if (! FRAME_LIVE_P (XFRAME (frame)))
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
545

Jim Blandy's avatar
Jim Blandy committed
546 547
  if (selected_frame == XFRAME (frame))
    return frame;
Jim Blandy's avatar
Jim Blandy committed
548

549 550 551
  /* This is too greedy; it causes inappropriate focus redirection
     that's hard to get rid of.  */
#if 0
552 553 554 555 556 557 558
  /* 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.  */
559 560 561
  if (track)
    {
      Lisp_Object tail;
562

563 564 565
      for (tail = Vframe_list; CONSP (tail); tail = XCONS (tail)->cdr)
	{
	  Lisp_Object focus;
566

567
	  if (!FRAMEP (XCONS (tail)->car))
568
	    abort ();
569

570
	  focus = FRAME_FOCUS_FRAME (XFRAME (XCONS (tail)->car));
571

572
	  if (FRAMEP (focus) && XFRAME (focus) == selected_frame)
573 574 575 576 577
	    Fredirect_frame_focus (XCONS (tail)->car, frame);
	}
    }
#else /* ! 0 */
  /* Instead, apply it only to the frame we're pointing to.  */
578 579
#ifdef HAVE_WINDOW_SYSTEM
  if (track && (FRAME_WINDOW_P (XFRAME (frame))))
580 581 582
    {
      Lisp_Object focus, xfocus;

583
      xfocus = x_get_focus_frame (XFRAME (frame));
584 585 586 587 588 589 590 591 592
      if (FRAMEP (xfocus))
	{
	  focus = FRAME_FOCUS_FRAME (XFRAME (xfocus));
	  if (FRAMEP (focus) && XFRAME (focus) == selected_frame)
	    Fredirect_frame_focus (xfocus, frame);
	}
    }
#endif /* HAVE_X_WINDOWS */
#endif /* ! 0 */
593

Jim Blandy's avatar
Jim Blandy committed
594 595 596
  selected_frame = XFRAME (frame);
  if (! FRAME_MINIBUF_ONLY_P (selected_frame))
    last_nonminibuf_frame = selected_frame;
Jim Blandy's avatar
Jim Blandy committed
597

Jim Blandy's avatar
Jim Blandy committed
598
  Fselect_window (XFRAME (frame)->selected_window);
Jim Blandy's avatar
Jim Blandy committed
599

600
  /* We want to make sure that the next event generates a frame-switch
601
     event to the appropriate frame.  This seems kludgy to me, but
602 603 604 605
     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.  */
606
  internal_last_event_frame = Qnil;
607

Jim Blandy's avatar
Jim Blandy committed
608
  return frame;
Jim Blandy's avatar
Jim Blandy committed
609 610
}

611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
DEFUN ("select-frame", Fselect_frame, Sselect_frame, 1, 2, "e",
  "Select the frame FRAME.\n\
Subsequent editing commands apply to its selected window.\n\
The selection of FRAME lasts until the next time the user does\n\
something to select a different frame, or until the next time this\n\
function is called.")
  (frame, no_enter)
    Lisp_Object frame, no_enter;
{
  return do_switch_frame (frame, no_enter, 1);
}


DEFUN ("handle-switch-frame", Fhandle_switch_frame, Shandle_switch_frame, 1, 2, "e",
  "Handle a switch-frame event EVENT.\n\
Switch-frame events are usually bound to this function.\n\
A switch-frame event tells Emacs that the window manager has requested\n\
that the user's events be directed to the frame mentioned in the event.\n\
This function selects the selected window of the frame of EVENT.\n\
\n\
If EVENT is frame object, handle it as if it were a switch-frame event\n\
to that frame.")
633 634
  (event, no_enter)
     Lisp_Object event, no_enter;
635
{
636 637
  /* Preserve prefix arg that the command loop just cleared.  */
  current_kboard->Vprefix_arg = Vcurrent_prefix_arg;
638
  call1 (Vrun_hooks, Qmouse_leave_buffer_hook);
639
  return do_switch_frame (event, no_enter, 0);
640 641
}

642 643 644 645 646 647 648 649
DEFUN ("ignore-event", Fignore_event, Signore_event, 0, 0, "",
  "Do nothing, but preserve any prefix argument already specified.\n\
This is a suitable binding for iconify-frame and make-frame-visible.")
     ()
{
  current_kboard->Vprefix_arg = Vcurrent_prefix_arg;
  return Qnil;
}
650

Jim Blandy's avatar
Jim Blandy committed
651 652
DEFUN ("selected-frame", Fselected_frame, Sselected_frame, 0, 0, 0,
  "Return the frame that is now selected.")
Jim Blandy's avatar
Jim Blandy committed
653 654 655
  ()
{
  Lisp_Object tem;
656
  XSETFRAME (tem, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
657 658
  return tem;
}
659

Jim Blandy's avatar
Jim Blandy committed
660 661
DEFUN ("window-frame", Fwindow_frame, Swindow_frame, 1, 1, 0,
  "Return the frame object that window WINDOW is on.")
Jim Blandy's avatar
Jim Blandy committed
662 663 664
  (window)
     Lisp_Object window;
{
665
  CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
666
  return XWINDOW (window)->frame;
Jim Blandy's avatar
Jim Blandy committed
667 668
}

669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
DEFUN ("frame-first-window", Fframe_first_window, Sframe_first_window, 0, 1, 0,
  "Returns the topmost, leftmost window of FRAME.\n\
If omitted, FRAME defaults to the currently selected frame.")
  (frame)
     Lisp_Object frame;
{
  Lisp_Object w;

  if (NILP (frame))
    w = selected_frame->root_window;
  else
    {
      CHECK_LIVE_FRAME (frame, 0);
      w = XFRAME (frame)->root_window;
    }
  while (NILP (XWINDOW (w)->buffer))
    {
      if (! NILP (XWINDOW (w)->hchild))
	w = XWINDOW (w)->hchild;
      else if (! NILP (XWINDOW (w)->vchild))
	w = XWINDOW (w)->vchild;
      else
	abort ();
    }
  return w;
}

696 697 698 699 700 701 702 703
DEFUN ("active-minibuffer-window", Factive_minibuffer_window,
       Sactive_minibuffer_window, 0, 0, 0,
       "Return the currently active minibuffer window, or nil if none.")
  ()
{
  return minibuf_level ? minibuf_window : Qnil;
}

Jim Blandy's avatar
Jim Blandy committed
704
DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
705 706
       "Returns the root-window of FRAME.\n\
If omitted, FRAME defaults to the currently selected frame.")
Jim Blandy's avatar
Jim Blandy committed
707 708
  (frame)
     Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
709
{
Jim Blandy's avatar
Jim Blandy committed
710
  if (NILP (frame))
711
    XSETFRAME (frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
712
  else
Jim Blandy's avatar
Jim Blandy committed
713
    CHECK_LIVE_FRAME (frame, 0);
Jim Blandy's avatar
Jim Blandy committed
714

Jim Blandy's avatar
Jim Blandy committed
715
  return XFRAME (frame)->root_window;
Jim Blandy's avatar
Jim Blandy committed
716 717
}

Jim Blandy's avatar
Jim Blandy committed
718 719
DEFUN ("frame-selected-window", Fframe_selected_window,
       Sframe_selected_window, 0, 1, 0,
720 721
  "Return the selected window of frame object FRAME.\n\
If omitted, FRAME defaults to the currently selected frame.")
Jim Blandy's avatar
Jim Blandy committed
722 723
  (frame)
     Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
724
{
Jim Blandy's avatar
Jim Blandy committed
725
  if (NILP (frame))
726
    XSETFRAME (frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
727
  else
Jim Blandy's avatar
Jim Blandy committed
728
    CHECK_LIVE_FRAME (frame, 0);
Jim Blandy's avatar
Jim Blandy committed
729

Jim Blandy's avatar
Jim Blandy committed
730
  return XFRAME (frame)->selected_window;
Jim Blandy's avatar
Jim Blandy committed
731 732
}

733 734 735 736 737 738 739 740 741
DEFUN ("set-frame-selected-window", Fset_frame_selected_window,
       Sset_frame_selected_window, 2, 2, 0,
  "Set the selected window of frame object FRAME to WINDOW.\n\
If FRAME is nil, the selected frame is used.\n\
If FRAME is the selected frame, this makes WINDOW the selected window.")
  (frame, window)
     Lisp_Object frame, window;
{
  if (NILP (frame))
742
    XSETFRAME (frame, selected_frame);
743 744 745 746 747 748 749 750 751 752 753 754 755 756
  else
    CHECK_LIVE_FRAME (frame, 0);

  CHECK_LIVE_WINDOW (window, 1);

  if (! EQ (frame, WINDOW_FRAME (XWINDOW (window))))
    error ("In `set-frame-selected-window', WINDOW is not on FRAME");

  if (XFRAME (frame) == selected_frame)
    return Fselect_window (window);

  return XFRAME (frame)->selected_window = window;
}

Jim Blandy's avatar
Jim Blandy committed
757
DEFUN ("frame-list", Fframe_list, Sframe_list,
Jim Blandy's avatar
Jim Blandy committed
758
       0, 0, 0,
Jim Blandy's avatar
Jim Blandy committed
759
       "Return a list of all frames.")
Jim Blandy's avatar
Jim Blandy committed
760 761
  ()
{
Jim Blandy's avatar
Jim Blandy committed
762
  return Fcopy_sequence (Vframe_list);
Jim Blandy's avatar
Jim Blandy committed
763 764
}

Jim Blandy's avatar
Jim Blandy committed
765 766
/* Return the next frame in the frame list after FRAME.
   If MINIBUF is nil, exclude minibuffer-only frames.
767 768
   If MINIBUF is a window, include only its own frame
   and any frame now using that window as the minibuffer.
769
   If MINIBUF is `visible', include all visible frames.
770
   If MINIBUF is 0, include all visible and iconified frames.
771 772
   Otherwise, include all frames.  */

Jim Blandy's avatar
Jim Blandy committed
773
Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
774 775
next_frame (frame, minibuf)
     Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
776
     Lisp_Object minibuf;
Jim Blandy's avatar
Jim Blandy committed
777 778 779 780
{
  Lisp_Object tail;
  int passed = 0;

Jim Blandy's avatar
Jim Blandy committed
781 782
  /* There must always be at least one frame in Vframe_list.  */
  if (! CONSP (Vframe_list))
Jim Blandy's avatar
Jim Blandy committed
783 784
    abort ();

Jim Blandy's avatar
Jim Blandy committed
785 786 787 788
  /* If this frame is dead, it won't be in Vframe_list, and we'll loop
     forever.  Forestall that.  */
  CHECK_LIVE_FRAME (frame, 0);

Jim Blandy's avatar
Jim Blandy committed
789
  while (1)
Jim Blandy's avatar
Jim Blandy committed
790
    for (tail = Vframe_list; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
791
      {
792
	Lisp_Object f;
793

794
	f = XCONS (tail)->car;
795 796 797

	if (passed
	    && FRAME_KBOARD (XFRAME (f)) == FRAME_KBOARD (XFRAME (frame)))
Jim Blandy's avatar
Jim Blandy committed
798
	  {
799 800 801 802 803 804 805 806 807 808 809 810 811
	    /* Decide whether this frame is eligible to be returned.  */

	    /* If we've looped all the way around without finding any
	       eligible frames, return the original frame.  */
	    if (EQ (f, frame))
	      return f;

	    /* Let minibuf decide if this frame is acceptable.  */
	    if (NILP (minibuf))
	      {
		if (! FRAME_MINIBUF_ONLY_P (XFRAME (f)))
		  return f;
	      }
812 813 814 815 816 817
	    else if (EQ (minibuf, Qvisible))
	      {
		FRAME_SAMPLE_VISIBILITY (XFRAME (f));
		if (FRAME_VISIBLE_P (XFRAME (f)))
		  return f;
	      }
818 819 820 821 822 823 824
	    else if (XFASTINT (minibuf) == 0)
	      {
		FRAME_SAMPLE_VISIBILITY (XFRAME (f));
		if (FRAME_VISIBLE_P (XFRAME (f))
		    || FRAME_ICONIFIED_P (XFRAME (f)))
		  return f;
	      }
825
	    else if (WINDOWP (minibuf))
826
	      {
827 828 829 830 831 832
		if (EQ (FRAME_MINIBUF_WINDOW (XFRAME (f)), minibuf)
		    /* Check that F either is, or has forwarded its focus to,
		       MINIBUF's frame.  */
		    && (EQ (WINDOW_FRAME (XWINDOW (minibuf)), f)
			|| EQ (WINDOW_FRAME (XWINDOW (minibuf)),
			       FRAME_FOCUS_FRAME (XFRAME (f)))))
833 834 835
		  return f;
	      }
	    else
Jim Blandy's avatar
Jim Blandy committed
836
	      return f;
Jim Blandy's avatar
Jim Blandy committed
837
	  }
Jim Blandy's avatar
Jim Blandy committed
838

839
	if (EQ (frame, f))
Jim Blandy's avatar
Jim Blandy committed
840 841 842 843
	  passed++;
      }
}

Jim Blandy's avatar
Jim Blandy committed
844 845
/* Return the previous frame in the frame list before FRAME.
   If MINIBUF is nil, exclude minibuffer-only frames.
846 847
   If MINIBUF is a window, include only its own frame
   and any frame now using that window as the minibuffer.
848
   If MINIBUF is `visible', include all visible frames.
849
   If MINIBUF is 0, include all visible and iconified frames.
850 851
   Otherwise, include all frames.  */

Jim Blandy's avatar
Jim Blandy committed
852
Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
853 854
prev_frame (frame, minibuf)
     Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
855
     Lisp_Object minibuf;
Jim Blandy's avatar
Jim Blandy committed
856 857 858 859
{
  Lisp_Object tail;
  Lisp_Object prev;

Jim Blandy's avatar
Jim Blandy committed
860 861
  /* There must always be at least one frame in Vframe_list.  */
  if (! CONSP (Vframe_list))
Jim Blandy's avatar
Jim Blandy committed
862 863
    abort ();

Jim Blandy's avatar
Jim Blandy committed
864
  prev = Qnil;
865
  for (tail = Vframe_list; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
866
    {
867
      Lisp_Object f;
Jim Blandy's avatar
Jim Blandy committed
868

869
      f = XCONS (tail)->car;
870
      if (!FRAMEP (f))
871
	abort ();
Jim Blandy's avatar
Jim Blandy committed
872

873 874
      if (EQ (frame, f) && !NILP (prev))
	return prev;
Jim Blandy's avatar
Jim Blandy committed
875

876
      if (FRAME_KBOARD (XFRAME (f)) == FRAME_KBOARD (XFRAME (frame)))
877
	{
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
	  /* Decide whether this frame is eligible to be returned,
	     according to minibuf.  */
	  if (NILP (minibuf))
	    {
	      if (! FRAME_MINIBUF_ONLY_P (XFRAME (f)))
		prev = f;
	    }
	  else if (WINDOWP (minibuf))
	    {
	      if (EQ (FRAME_MINIBUF_WINDOW (XFRAME (f)), minibuf)
		  /* Check that F either is, or has forwarded its focus to,
		     MINIBUF's frame.  */
		  && (EQ (WINDOW_FRAME (XWINDOW (minibuf)), f)
		      || EQ (WINDOW_FRAME (XWINDOW (minibuf)),
			     FRAME_FOCUS_FRAME (XFRAME (f)))))
		prev = f;
	    }
	  else if (EQ (minibuf, Qvisible))
	    {
	      FRAME_SAMPLE_VISIBILITY (XFRAME (f));
	      if (FRAME_VISIBLE_P (XFRAME (f)))
		prev = f;
	    }
	  else if (XFASTINT (minibuf) == 0)
	    {
	      FRAME_SAMPLE_VISIBILITY (XFRAME (f));
	      if (FRAME_VISIBLE_P (XFRAME (f))
		  || FRAME_ICONIFIED_P (XFRAME (f)))
		prev = f;
	    }
	  else
909 910
	    prev = f;
	}
Jim Blandy's avatar
Jim Blandy committed
911
    }
912 913 914 915 916 917 918 919 920 921 922

  /* We've scanned the entire list.  */
  if (NILP (prev))
    /* We went through the whole frame list without finding a single
       acceptable frame.  Return the original frame.  */
    return frame;
  else
    /* There were no acceptable frames in the list before FRAME; otherwise,
       we would have returned directly from the loop.  Since PREV is the last
       acceptable frame in the list, return it.  */
    return prev;
Jim Blandy's avatar
Jim Blandy committed
923 924
}

925

Jim Blandy's avatar
Jim Blandy committed
926 927
DEFUN ("next-frame", Fnext_frame, Snext_frame, 0, 2, 0,
  "Return the next frame in the frame list after FRAME.\n\
928
It considers only frames on the same terminal as FRAME.\n\
929
By default, skip minibuffer-only frames.\n\
930
If omitted, FRAME defaults to the selected frame.\n\
931
If optional argument MINIFRAME is nil, exclude minibuffer-only frames.\n\
932
If MINIFRAME is a window, include only its own frame\n\
933
and any frame now using that window as the minibuffer.\n\
934
If MINIFRAME is `visible', include all visible frames.\n\
935
If MINIFRAME is 0, include all visible and iconified frames.\n\
936
Otherwise, include all frames.")
Jim Blandy's avatar
Jim Blandy committed
937
  (frame, miniframe)
938
     Lisp_Object frame, miniframe;
Jim Blandy's avatar
Jim Blandy committed
939 940 941
{
  Lisp_Object tail;

Jim Blandy's avatar
Jim Blandy committed
942
  if (NILP (frame))
943
    XSETFRAME (frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
944
  else
Jim Blandy's avatar
Jim Blandy committed
945
    CHECK_LIVE_FRAME (frame, 0);
Jim Blandy's avatar
Jim Blandy committed
946

Jim Blandy's avatar
Jim Blandy committed
947
  return next_frame (frame, miniframe);
Jim Blandy's avatar
Jim Blandy committed
948
}
Jim Blandy's avatar
Jim Blandy committed
949

950 951
DEFUN ("previous-frame", Fprevious_frame, Sprevious_frame, 0, 2, 0,
  "Return the previous frame in the frame list before FRAME.\n\
952
It considers only frames on the same terminal as FRAME.\n\
953 954 955
By default, skip minibuffer-only frames.\n\
If omitted, FRAME defaults to the selected frame.\n\
If optional argument MINIFRAME is nil, exclude minibuffer-only frames.\n\
956
If MINIFRAME is a window, include only its own frame\n\
957
and any frame now using that window as the minibuffer.\n\
958
If MINIFRAME is `visible', include all visible frames.\n\
959
If MINIFRAME is 0, include all visible and iconified frames.\n\
960
Otherwise, include all frames.")
961 962 963 964 965 966
  (frame, miniframe)
     Lisp_Object frame, miniframe;
{
  Lisp_Object tail;

  if (NILP (frame))
967
    XSETFRAME (frame, selected_frame);
968 969 970 971 972
  else
    CHECK_LIVE_FRAME (frame, 0);

  return prev_frame (frame, miniframe);
}