frame.c 59.5 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 65 66
/* 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)))))
  */        

/*&&& symbols declared here &&&*/
Lisp_Object Qframep;
Jim Blandy's avatar
Jim Blandy committed
67
Lisp_Object Qframe_live_p;
68 69
Lisp_Object Qheight;
Lisp_Object Qicon;
Jim Blandy's avatar
Jim Blandy committed
70
Lisp_Object Qminibuffer;
71 72 73 74
Lisp_Object Qmodeline;
Lisp_Object Qname;
Lisp_Object Qonly;
Lisp_Object Qunsplittable;
75
Lisp_Object Qmenu_bar_lines;
76 77
Lisp_Object Qwidth;
Lisp_Object Qx;
78
Lisp_Object Qwin32;
79
Lisp_Object Qpc;
80
Lisp_Object Qvisible;
81
Lisp_Object Qbuffer_predicate;
82
Lisp_Object Qtitle;
Jim Blandy's avatar
Jim Blandy committed
83

84
Lisp_Object Vterminal_frame;
85
Lisp_Object Vdefault_frame_alist;
86 87 88 89 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

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);
115 116
  Qwin32 = intern ("win32");
  staticpro (&Qwin32);
117 118
  Qpc = intern ("pc");
  staticpro (&Qpc);
119 120 121 122
  Qvisible = intern ("visible");
  staticpro (&Qvisible);
  Qbuffer_predicate = intern ("buffer-predicate");
  staticpro (&Qbuffer_predicate);
123 124
  Qtitle = intern ("title");
  staticpro (&Qtitle);
125

126 127 128 129 130 131 132 133 134 135 136 137
  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;
138 139 140 141 142 143 144 145 146
}

static void
set_menu_bar_lines_1 (window, n)
  Lisp_Object window;
  int n;
{
  struct window *w = XWINDOW (window);

147
  XSETFASTINT (w->last_modified, 0);
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
  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
Karl Heuer's avatar
Karl Heuer committed
173
     frame itself, and get an error because you can't switch buffers
174 175 176 177 178 179 180 181 182
     in or split the minibuffer window.  */
  if (FRAME_MINIBUF_ONLY_P (f))
    return;

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

183 184 185 186 187 188 189
  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);
    }
190 191 192 193 194 195 196 197 198 199 200
}

#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
201 202
extern Lisp_Object Vminibuffer_list;
extern Lisp_Object get_minibuffer ();
203 204
extern Lisp_Object Fhandle_switch_frame ();
extern Lisp_Object Fredirect_frame_focus ();
Karl Heuer's avatar
Karl Heuer committed
205
extern Lisp_Object x_get_focus_frame ();
Jim Blandy's avatar
Jim Blandy committed
206

Jim Blandy's avatar
Jim Blandy committed
207 208 209
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
210 211
`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
212
See also `frame-live-p'.")
Jim Blandy's avatar
Jim Blandy committed
213 214
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
215
{
216
  if (!FRAMEP (object))
Jim Blandy's avatar
Jim Blandy committed
217
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
218
  switch (XFRAME (object)->output_method)
Jim Blandy's avatar
Jim Blandy committed
219 220 221 222
    {
    case output_termcap:
      return Qt;
    case output_x_window:
223
      return Qx;
224 225
    case output_win32:
      return Qwin32;
226 227
    case output_msdos_raw:
      return Qpc;
Jim Blandy's avatar
Jim Blandy committed
228 229 230 231 232
    default:
      abort ();
    }
}

Jim Blandy's avatar
Jim Blandy committed
233
DEFUN ("frame-live-p", Fframe_live_p, Sframe_live_p, 1, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
234 235 236 237 238
  "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
239 240 241
  (object)
     Lisp_Object object;
{
Jim Blandy's avatar
Jim Blandy committed
242 243 244
  return ((FRAMEP (object)
	   && FRAME_LIVE_P (XFRAME (object)))
	  ? Fframep (object)
Jim Blandy's avatar
Jim Blandy committed
245 246 247
	  : Qnil);
}

Jim Blandy's avatar
Jim Blandy committed
248 249
struct frame *
make_frame (mini_p)
Jim Blandy's avatar
Jim Blandy committed
250 251
     int mini_p;
{
Jim Blandy's avatar
Jim Blandy committed
252 253
  Lisp_Object frame;
  register struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
254 255
  register Lisp_Object root_window;
  register Lisp_Object mini_window;
256 257 258 259 260 261 262 263 264
  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
265 266 267 268 269 270

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

299
  root_window = make_window ();
Jim Blandy's avatar
Jim Blandy committed
300 301
  if (mini_p)
    {
302
      mini_window = make_window ();
Jim Blandy's avatar
Jim Blandy committed
303 304 305
      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
306 307
      XWINDOW (mini_window)->frame = frame;
      f->minibuffer_window = mini_window;
Jim Blandy's avatar
Jim Blandy committed
308 309 310 311 312
    }
  else
    {
      mini_window = Qnil;
      XWINDOW (root_window)->next = Qnil;
Jim Blandy's avatar
Jim Blandy committed
313
      f->minibuffer_window = Qnil;
Jim Blandy's avatar
Jim Blandy committed
314 315
    }

Jim Blandy's avatar
Jim Blandy committed
316
  XWINDOW (root_window)->frame = frame;
Jim Blandy's avatar
Jim Blandy committed
317 318 319

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

Jim Blandy's avatar
Jim Blandy committed
322 323
  f->width = 10;
  f->height = 10;
Jim Blandy's avatar
Jim Blandy committed
324

325 326
  XSETFASTINT (XWINDOW (root_window)->width, 10);
  XSETFASTINT (XWINDOW (root_window)->height, (mini_p ? 9 : 10));
Jim Blandy's avatar
Jim Blandy committed
327 328 329

  if (mini_p)
    {
330 331 332
      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
333 334
    }

Jim Blandy's avatar
Jim Blandy committed
335
  /* Choose a buffer for the frame's root window.  */
Jim Blandy's avatar
Jim Blandy committed
336 337 338 339 340 341 342 343
  {
    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] == ' ')
344
      buf = Fother_buffer (buf, Qnil);
Jim Blandy's avatar
Jim Blandy committed
345 346 347
    Fset_window_buffer (root_window, buf);
  }

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

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

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

Jim Blandy's avatar
Jim Blandy committed
370
struct frame *
371
make_frame_without_minibuffer (mini_window, kb, display)
Jim Blandy's avatar
Jim Blandy committed
372
     register Lisp_Object mini_window;
373
     KBOARD *kb;
374
     Lisp_Object display;
Jim Blandy's avatar
Jim Blandy committed
375
{
Jim Blandy's avatar
Jim Blandy committed
376
  register struct frame *f;
377
  struct gcpro gcpro1;
Jim Blandy's avatar
Jim Blandy committed
378

379 380
  if (!NILP (mini_window))
    CHECK_LIVE_WINDOW (mini_window, 0);
Jim Blandy's avatar
Jim Blandy committed
381

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

Jim Blandy's avatar
Jim Blandy committed
388 389
  /* Make a frame containing just a root window.  */
  f = make_frame (0);
Jim Blandy's avatar
Jim Blandy committed
390

391 392 393 394 395 396
  if (NILP (mini_window))
    {
      /* Use default-minibuffer-frame if possible.  */
      if (!FRAMEP (kb->Vdefault_minibuffer_frame)
	  || ! FRAME_LIVE_P (XFRAME (kb->Vdefault_minibuffer_frame)))
	{
397 398 399 400
          Lisp_Object frame_dummy;

          XSETFRAME (frame_dummy, f);
          GCPRO1 (frame_dummy);
401
	  /* If there's no minibuffer frame to use, create one.  */
402 403 404
	  kb->Vdefault_minibuffer_frame =
	    call1 (intern ("make-initial-minibuffer-frame"), display);
          UNGCPRO;
405
	}
406
   
407 408
      mini_window = XFRAME (kb->Vdefault_minibuffer_frame)->minibuffer_window;
    }
409

Jim Blandy's avatar
Jim Blandy committed
410
  f->minibuffer_window = mini_window;
411 412 413 414 415 416 417 418

  /* Make the chosen minibuffer window display the proper minibuffer,
     unless it is already showing a minibuffer.  */
  if (NILP (Fmemq (XWINDOW (mini_window)->buffer, Vminibuffer_list)))
    Fset_window_buffer (mini_window,
			(NILP (Vminibuffer_list)
			 ? get_minibuffer (0)
			 : Fcar (Vminibuffer_list)));
Jim Blandy's avatar
Jim Blandy committed
419
  return f;
Jim Blandy's avatar
Jim Blandy committed
420 421
}

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

Jim Blandy's avatar
Jim Blandy committed
424 425
struct frame *
make_minibuffer_frame ()
Jim Blandy's avatar
Jim Blandy committed
426
{
Jim Blandy's avatar
Jim Blandy committed
427
  /* First make a frame containing just a root window, no minibuffer.  */
Jim Blandy's avatar
Jim Blandy committed
428

Jim Blandy's avatar
Jim Blandy committed
429
  register struct frame *f = make_frame (0);
Jim Blandy's avatar
Jim Blandy committed
430
  register Lisp_Object mini_window;
Jim Blandy's avatar
Jim Blandy committed
431
  register Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
432

433
  XSETFRAME (frame, f);
Jim Blandy's avatar
Jim Blandy committed
434

435
  f->auto_raise = 0;
Jim Blandy's avatar
Jim Blandy committed
436 437 438 439
  f->auto_lower = 0;
  f->no_split = 1;
  f->wants_modeline = 0;
  f->has_minibuffer = 1;
Jim Blandy's avatar
Jim Blandy committed
440 441 442 443 444

  /* 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
445
  mini_window = f->minibuffer_window = f->root_window;
Jim Blandy's avatar
Jim Blandy committed
446 447
  XWINDOW (mini_window)->mini_p = Qt;
  XWINDOW (mini_window)->next = Qnil;
448
  XWINDOW (mini_window)->prev = Qnil;
Jim Blandy's avatar
Jim Blandy committed
449
  XWINDOW (mini_window)->frame = frame;
Jim Blandy's avatar
Jim Blandy committed
450 451 452 453

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

  Fset_window_buffer (mini_window,
Jim Blandy's avatar
Jim Blandy committed
454
		      (NILP (Vminibuffer_list)
Jim Blandy's avatar
Jim Blandy committed
455 456
		       ? get_minibuffer (0)
		       : Fcar (Vminibuffer_list)));
Jim Blandy's avatar
Jim Blandy committed
457
  return f;
Jim Blandy's avatar
Jim Blandy committed
458 459
}

Jim Blandy's avatar
Jim Blandy committed
460
/* Construct a frame that refers to the terminal (stdin and stdout).  */
Jim Blandy's avatar
Jim Blandy committed
461

462 463
static int terminal_frame_count;

Jim Blandy's avatar
Jim Blandy committed
464 465
struct frame *
make_terminal_frame ()
Jim Blandy's avatar
Jim Blandy committed
466
{
Jim Blandy's avatar
Jim Blandy committed
467
  register struct frame *f;
468
  Lisp_Object frame;
469 470
  char name[20];

471 472 473 474 475
#ifdef MULTI_KBOARD
  if (!initial_kboard)
    {
      initial_kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
      init_kboard (initial_kboard);
476 477
      initial_kboard->next_kboard = all_kboards;
      all_kboards = initial_kboard;
478 479 480
    }
#endif

481 482 483
  /* The first call must initialize Vframe_list.  */
  if (! (NILP (Vframe_list) || CONSP (Vframe_list)))
    Vframe_list = Qnil;
Jim Blandy's avatar
Jim Blandy committed
484 485

  f = make_frame (1);
486

487
  XSETFRAME (frame, f);
488 489
  Vframe_list = Fcons (frame, Vframe_list);

490
  terminal_frame_count++;
491 492 493 494 495 496 497 498 499
  if (terminal_frame_count == 1)
    {
      f->name = build_string ("Emacs");
    }
  else
    {
      sprintf (name, "Emacs-%d", terminal_frame_count);
      f->name = build_string (name);
    }
500 501 502

  f->visible = 1;		/* FRAME_SET_VISIBLE wd set frame_garbaged. */
  f->async_visible = 1;		/* Don't let visible be cleared later. */
503 504 505 506 507
#ifdef MSDOS
  f->output_data.x = &the_only_x_display;
  f->output_method = output_msdos_raw;
  init_frame_faces (f);
#else /* not MSDOS */
508
  f->output_data.nothing = 1;	/* Nonzero means frame isn't deleted.  */
509
#endif
Jim Blandy's avatar
Jim Blandy committed
510
  return f;
Jim Blandy's avatar
Jim Blandy committed
511
}
512 513

DEFUN ("make-terminal-frame", Fmake_terminal_frame, Smake_terminal_frame,
514 515 516 517 518 519
       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.")
520 521 522 523 524 525
  (parms)
     Lisp_Object parms;
{
  struct frame *f;
  Lisp_Object frame;

526
#ifdef MSDOS
527 528 529
  if (selected_frame->output_method != output_msdos_raw)
    abort ();
#else
530 531
  if (selected_frame->output_method != output_termcap)
    error ("Not using an ASCII terminal now; cannot make a new ASCII frame");
532
#endif
533 534 535 536 537 538 539

  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);
540
  Fmodify_frame_parameters (frame, Vdefault_frame_alist);
541
  Fmodify_frame_parameters (frame, parms);
542
  f->face_alist = selected_frame->face_alist;
543 544
  return frame;
}
Jim Blandy's avatar
Jim Blandy committed
545

546
Lisp_Object
547
do_switch_frame (frame, no_enter, track)
Jim Blandy's avatar
Jim Blandy committed
548
     Lisp_Object frame, no_enter;
549
     int track;
Jim Blandy's avatar
Jim Blandy committed
550
{
551 552 553 554 555 556 557
  /* 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;

558 559 560 561 562 563
  /* 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
564

Jim Blandy's avatar
Jim Blandy committed
565 566
  if (selected_frame == XFRAME (frame))
    return frame;
Jim Blandy's avatar
Jim Blandy committed
567

568 569 570
  /* This is too greedy; it causes inappropriate focus redirection
     that's hard to get rid of.  */
#if 0
571 572 573 574 575 576 577
  /* 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.  */
578 579 580
  if (track)
    {
      Lisp_Object tail;
581

582 583 584
      for (tail = Vframe_list; CONSP (tail); tail = XCONS (tail)->cdr)
	{
	  Lisp_Object focus;
585

586
	  if (!FRAMEP (XCONS (tail)->car))
587
	    abort ();
588

589
	  focus = FRAME_FOCUS_FRAME (XFRAME (XCONS (tail)->car));
590

591
	  if (FRAMEP (focus) && XFRAME (focus) == selected_frame)
592 593 594 595 596
	    Fredirect_frame_focus (XCONS (tail)->car, frame);
	}
    }
#else /* ! 0 */
  /* Instead, apply it only to the frame we're pointing to.  */
597 598
#ifdef HAVE_WINDOW_SYSTEM
  if (track && (FRAME_WINDOW_P (XFRAME (frame))))
599 600 601
    {
      Lisp_Object focus, xfocus;

602
      xfocus = x_get_focus_frame (XFRAME (frame));
603 604 605 606 607 608 609 610 611
      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 */
612

Jim Blandy's avatar
Jim Blandy committed
613 614 615
  selected_frame = XFRAME (frame);
  if (! FRAME_MINIBUF_ONLY_P (selected_frame))
    last_nonminibuf_frame = selected_frame;
Jim Blandy's avatar
Jim Blandy committed
616

Jim Blandy's avatar
Jim Blandy committed
617
  Fselect_window (XFRAME (frame)->selected_window);
Jim Blandy's avatar
Jim Blandy committed
618

619
  /* We want to make sure that the next event generates a frame-switch
620
     event to the appropriate frame.  This seems kludgy to me, but
621 622 623 624
     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.  */
625
  internal_last_event_frame = Qnil;
626

Jim Blandy's avatar
Jim Blandy committed
627
  return frame;
Jim Blandy's avatar
Jim Blandy committed
628 629
}

630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
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.")
652 653
  (event, no_enter)
     Lisp_Object event, no_enter;
654
{
655 656
  /* Preserve prefix arg that the command loop just cleared.  */
  current_kboard->Vprefix_arg = Vcurrent_prefix_arg;
657
  call1 (Vrun_hooks, Qmouse_leave_buffer_hook);
658
  return do_switch_frame (event, no_enter, 0);
659 660
}

661 662 663 664 665 666 667 668
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;
}
669

Jim Blandy's avatar
Jim Blandy committed
670 671
DEFUN ("selected-frame", Fselected_frame, Sselected_frame, 0, 0, 0,
  "Return the frame that is now selected.")
Jim Blandy's avatar
Jim Blandy committed
672 673 674
  ()
{
  Lisp_Object tem;
675
  XSETFRAME (tem, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
676 677
  return tem;
}
678

Jim Blandy's avatar
Jim Blandy committed
679 680
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
681 682 683
  (window)
     Lisp_Object window;
{
684
  CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
685
  return XWINDOW (window)->frame;
Jim Blandy's avatar
Jim Blandy committed
686 687
}

688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
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;
}

715 716 717 718 719 720 721 722
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
723
DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
724 725
       "Returns the root-window of FRAME.\n\
If omitted, FRAME defaults to the currently selected frame.")
Jim Blandy's avatar
Jim Blandy committed
726 727
  (frame)
     Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
728
{
Jim Blandy's avatar
Jim Blandy committed
729
  if (NILP (frame))
730
    XSETFRAME (frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
731
  else
Jim Blandy's avatar
Jim Blandy committed
732
    CHECK_LIVE_FRAME (frame, 0);
Jim Blandy's avatar
Jim Blandy committed
733

Jim Blandy's avatar
Jim Blandy committed
734
  return XFRAME (frame)->root_window;
Jim Blandy's avatar
Jim Blandy committed
735 736
}

Jim Blandy's avatar
Jim Blandy committed
737 738
DEFUN ("frame-selected-window", Fframe_selected_window,
       Sframe_selected_window, 0, 1, 0,
739 740
  "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
741 742
  (frame)
     Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
743
{
Jim Blandy's avatar
Jim Blandy committed
744
  if (NILP (frame))
745
    XSETFRAME (frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
746
  else
Jim Blandy's avatar
Jim Blandy committed
747
    CHECK_LIVE_FRAME (frame, 0);
Jim Blandy's avatar
Jim Blandy committed
748

Jim Blandy's avatar
Jim Blandy committed
749
  return XFRAME (frame)->selected_window;
Jim Blandy's avatar
Jim Blandy committed
750 751
}

752 753 754 755 756 757 758 759 760
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))
761
    XSETFRAME (frame, selected_frame);
762 763 764 765 766 767 768 769 770 771 772 773 774 775
  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
776
DEFUN ("frame-list", Fframe_list, Sframe_list,
Jim Blandy's avatar
Jim Blandy committed
777
       0, 0, 0,
Jim Blandy's avatar
Jim Blandy committed
778
       "Return a list of all frames.")
Jim Blandy's avatar
Jim Blandy committed
779 780
  ()
{
Jim Blandy's avatar
Jim Blandy committed
781
  return Fcopy_sequence (Vframe_list);
Jim Blandy's avatar
Jim Blandy committed
782 783
}

Jim Blandy's avatar
Jim Blandy committed
784 785
/* Return the next frame in the frame list after FRAME.
   If MINIBUF is nil, exclude minibuffer-only frames.
786 787
   If MINIBUF is a window, include only its own frame
   and any frame now using that window as the minibuffer.
788
   If MINIBUF is `visible', include all visible frames.
789
   If MINIBUF is 0, include all visible and iconified frames.
790 791
   Otherwise, include all frames.  */

Jim Blandy's avatar
Jim Blandy committed
792
Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
793 794
next_frame (frame, minibuf)
     Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
795
     Lisp_Object minibuf;
Jim Blandy's avatar
Jim Blandy committed
796 797 798 799
{
  Lisp_Object tail;
  int passed = 0;

Jim Blandy's avatar
Jim Blandy committed
800 801
  /* There must always be at least one frame in Vframe_list.  */
  if (! CONSP (Vframe_list))
Jim Blandy's avatar
Jim Blandy committed
802 803
    abort ();

Jim Blandy's avatar
Jim Blandy committed
804 805 806 807
  /* 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
808
  while (1)
Jim Blandy's avatar
Jim Blandy committed
809
    for (tail = Vframe_list; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
810
      {
811
	Lisp_Object f;
812

813
	f = XCONS (tail)->car;
814 815 816

	if (passed
	    && FRAME_KBOARD (XFRAME (f)) == FRAME_KBOARD (XFRAME (frame)))
Jim Blandy's avatar
Jim Blandy committed
817
	  {
818 819 820 821 822 823 824 825 826 827 828 829 830
	    /* 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;
	      }
831 832 833 834 835 836
	    else if (EQ (minibuf, Qvisible))
	      {
		FRAME_SAMPLE_VISIBILITY (XFRAME (f));
		if (FRAME_VISIBLE_P (XFRAME (f)))
		  return f;
	      }
837 838 839 840 841 842 843
	    else if (XFASTINT (minibuf) == 0)
	      {
		FRAME_SAMPLE_VISIBILITY (XFRAME (f));
		if (FRAME_VISIBLE_P (XFRAME (f))
		    || FRAME_ICONIFIED_P (XFRAME (f)))
		  return f;
	      }
844
	    else if (WINDOWP (minibuf))
845
	      {
846 847 848 849 850 851
		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)))))
852 853 854
		  return f;
	      }
	    else
Jim Blandy's avatar
Jim Blandy committed
855
	      return f;
Jim Blandy's avatar
Jim Blandy committed
856
	  }
Jim Blandy's avatar
Jim Blandy committed
857

858
	if (EQ (frame, f))
Jim Blandy's avatar
Jim Blandy committed
859 860 861 862
	  passed++;
      }
}

Jim Blandy's avatar
Jim Blandy committed
863 864
/* Return the previous frame in the frame list before FRAME.
   If MINIBUF is nil, exclude minibuffer-only frames.
865 866
   If MINIBUF is a window, include only its own frame
   and any frame now using that window as the minibuffer.
867
   If MINIBUF is `visible', include all visible frames.
868
   If MINIBUF is 0, include all visible and iconified frames.
869 870
   Otherwise, include all frames.  */

Jim Blandy's avatar
Jim Blandy committed
871
Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
872 873
prev_frame (frame, minibuf)
     Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
874
     Lisp_Object minibuf;
Jim Blandy's avatar
Jim Blandy committed
875 876 877 878
{
  Lisp_Object tail;
  Lisp_Object prev;

Jim Blandy's avatar
Jim Blandy committed
879 880
  /* There must always be at least one frame in Vframe_list.  */
  if (! CONSP (Vframe_list))
Jim Blandy's avatar
Jim Blandy committed
881 882
    abort ();

Jim Blandy's avatar
Jim Blandy committed
883
  prev = Qnil;
884
  for (tail = Vframe_list; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
885
    {
886
      Lisp_Object f;
Jim Blandy's avatar
Jim Blandy committed
887

888
      f = XCONS (tail)->car;
889
      if (!FRAMEP (f))
890
	abort ();
Jim Blandy's avatar
Jim Blandy committed
891

892 893
      if (EQ (frame, f) && !NILP (prev))
	return prev;
Jim Blandy's avatar
Jim Blandy committed
894

895
      if (FRAME_KBOARD (XFRAME (f)) == FRAME_KBOARD (XFRAME (frame)))
896
	{
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927
	  /* 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
928 929
	    prev = f;
	}
Jim Blandy's avatar
Jim Blandy committed
930
    }
931 932 933 934 935 936 937 938 939 940 941

  /* 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
942 943
}

944

Jim Blandy's avatar
Jim Blandy committed
945 946
DEFUN ("next-frame", Fnext_frame, Snext_frame, 0, 2, 0,
  "Return the next frame in the frame list after FRAME.\n\
947
It considers only frames on the same terminal as FRAME.\n\
948
By default, skip minibuffer-only frames.\n\
949
If omitted, FRAME defaults to the selected frame.\n\
950
If optional argument MINIFRAME is nil, exclude minibuffer-only frames.\n\
951
If MINIFRAME is a window, include only its own frame\n\
952
and any frame now using that window as the minibuffer.\n\
953
If MINIFRAME is `visible', include all visible frames.\n\
954
If MINIFRAME is 0, include all visible and iconified frames.\n\
955
Otherwise, include all frames.")
Jim Blandy's avatar
Jim Blandy committed
956
  (frame, miniframe)
957
     Lisp_Object frame, miniframe;
Jim Blandy's avatar
Jim Blandy committed
958 959 960
{
  Lisp_Object tail;

Jim Blandy's avatar
Jim Blandy committed
961
  if (NILP (frame))
962
    XSETFRAME (frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
963
  else
Jim Blandy's avatar
Jim Blandy committed
964
    CHECK_LIVE_FRAME (frame, 0);
Jim Blandy's avatar
Jim Blandy committed
965

Jim Blandy's avatar
Jim Blandy committed
966
  return next_frame (frame, miniframe);
Jim Blandy's avatar
Jim Blandy committed
967
}
Jim Blandy's avatar
Jim Blandy committed
968

969 970
DEFUN ("previous-frame", Fprevious_frame, Sprevious_frame, 0, 2, 0,
  "Return the previous frame in the frame list before FRAME.\n\
971
It considers only frames on the same terminal as FRAME.\n\
972 973 974
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\
975
If MINIFRAME is a window, include only its own frame\n\
976
and any frame now using that window as the minibuffer.\n\
977
If MINIFRAME is `visible', include all visible frames.\n\
978
If MINIFRAME is 0, include all visible and iconified frames.\n\
979
Otherwise, include all frames.")
980 981 982 983 984 985
  (frame, miniframe)
     Lisp_Object frame, miniframe;
{
  Lisp_Object tail;

  if (NILP (frame))
986
    XSETFRAME (frame, selected_frame);
987 988 989 990 991
  else
    CHECK_LIVE_FRAME (frame, 0);

  return prev_frame (frame, miniframe);
}
Jim Blandy's avatar
Jim Blandy committed
992

993 994 995
/* Return 1 if it is ok to delete frame F;
   0 if all frames aside from F are invisible.
   (Exception: if F is the terminal frame, and we are using X, return 1.)  */
Jim Blandy's avatar
Jim Blandy committed
996

997
int
998 999 1000 1001 1002 1003
other_visible_frames (f)
     FRAME_PTR f;
{
  /* We know the selected frame is visible,
     so if F is some other frame, it can't be the sole visible one.  */
  if (f == selected_frame)
1004 1005 1006 1007 1008 1009 1010 1011
    {
      Lisp_Object frames;
      int count = 0;

      for (frames = Vframe_list;
	   CONSP (frames);
	   frames = XCONS (frames)->cdr)
	{
1012
	  Lisp_Object this;
1013

1014
	  this = XCONS (frames)->car;
1015 1016 1017
	  /* Verify that the frame's window still exists
	     and we can still talk to it.  And note any recent change
	     in visibility.  */
1018 1019
#ifdef HAVE_WINDOW_SYSTEM
	  if (FRAME_WINDOW_P (XFRAME (this)))
1020
	    {
1021
	      x_sync (XFRAME (this));
1022 1023 1024 1025
	      FRAME_SAMPLE_VISIBILITY (XFRAME (this));
	    }
#endif

1026 1027 1028 1029
	  if (FRAME_VISIBLE_P (XFRAME (this))
	      || FRAME_ICONIFIED_P (XFRAME (this))
	      /* Allow deleting the terminal frame when at least
		 one X frame exists!  */
1030
	      || (FRAME_WINDOW_P (XFRAME (this)) && !FRAME_WINDOW_P (f)))
1031 1032
	    count++;
	}
1033
      return count > 1;