frame.c 55.1 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Generic frame functions.
Jim Blandy's avatar
Jim Blandy committed
2
   Copyright (C) 1993 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 18 19
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
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */

Jim Blandy's avatar
Jim Blandy committed
20 21
#include <stdio.h>

22
#include <config.h>
23 24
#include "lisp.h"
#include "frame.h"
25
#include "termhooks.h"
Jim Blandy's avatar
Jim Blandy committed
26

Jim Blandy's avatar
Jim Blandy committed
27
#ifdef MULTI_FRAME
Jim Blandy's avatar
Jim Blandy committed
28

Jim Blandy's avatar
Jim Blandy committed
29
#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
30 31
#include "window.h"

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

Jim Blandy's avatar
Jim Blandy committed
36
Lisp_Object Vemacs_iconified;
Jim Blandy's avatar
Jim Blandy committed
37 38 39 40
Lisp_Object Vframe_list;
Lisp_Object Vterminal_frame;
Lisp_Object Vdefault_minibuffer_frame;
Lisp_Object Vdefault_frame_alist;
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 67 68 69 70 71 72 73 74 75 76

/* 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
77
Lisp_Object Qframe_live_p;
78 79
Lisp_Object Qheight;
Lisp_Object Qicon;
Jim Blandy's avatar
Jim Blandy committed
80
Lisp_Object Qminibuffer;
81 82 83 84
Lisp_Object Qmodeline;
Lisp_Object Qname;
Lisp_Object Qonly;
Lisp_Object Qunsplittable;
85
Lisp_Object Qmenu_bar_lines;
86 87
Lisp_Object Qwidth;
Lisp_Object Qx;
88
Lisp_Object Qvisible;
Jim Blandy's avatar
Jim Blandy committed
89 90 91

extern Lisp_Object Vminibuffer_list;
extern Lisp_Object get_minibuffer ();
92 93
extern Lisp_Object Fhandle_switch_frame ();
extern Lisp_Object Fredirect_frame_focus ();
Jim Blandy's avatar
Jim Blandy committed
94

Jim Blandy's avatar
Jim Blandy committed
95 96 97 98 99
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\
`x' for an Emacs frame that is really an X window.\n\
Also see `live-frame-p'.")
Jim Blandy's avatar
Jim Blandy committed
100 101
  (object)
     Lisp_Object object;
Jim Blandy's avatar
Jim Blandy committed
102
{
Jim Blandy's avatar
Jim Blandy committed
103
  if (XTYPE (object) != Lisp_Frame)
Jim Blandy's avatar
Jim Blandy committed
104
    return Qnil;
Jim Blandy's avatar
Jim Blandy committed
105
  switch (XFRAME (object)->output_method)
Jim Blandy's avatar
Jim Blandy committed
106 107 108 109
    {
    case output_termcap:
      return Qt;
    case output_x_window:
110
      return Qx;
Jim Blandy's avatar
Jim Blandy committed
111 112 113 114 115
    default:
      abort ();
    }
}

Jim Blandy's avatar
Jim Blandy committed
116
DEFUN ("frame-live-p", Fframe_live_p, Sframe_live_p, 1, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
117 118 119 120 121
  "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
122 123 124
  (object)
     Lisp_Object object;
{
Jim Blandy's avatar
Jim Blandy committed
125 126 127
  return ((FRAMEP (object)
	   && FRAME_LIVE_P (XFRAME (object)))
	  ? Fframep (object)
Jim Blandy's avatar
Jim Blandy committed
128 129 130
	  : Qnil);
}

Jim Blandy's avatar
Jim Blandy committed
131 132
struct frame *
make_frame (mini_p)
Jim Blandy's avatar
Jim Blandy committed
133 134
     int mini_p;
{
Jim Blandy's avatar
Jim Blandy committed
135 136
  Lisp_Object frame;
  register struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
137 138 139
  register Lisp_Object root_window;
  register Lisp_Object mini_window;

Jim Blandy's avatar
Jim Blandy committed
140
  frame = Fmake_vector (((sizeof (struct frame) - (sizeof (Lisp_Vector)
Jim Blandy's avatar
Jim Blandy committed
141 142
						     - sizeof (Lisp_Object)))
			  / sizeof (Lisp_Object)),
Jim Blandy's avatar
Jim Blandy committed
143
			 make_number (0));
Jim Blandy's avatar
Jim Blandy committed
144 145 146 147 148 149 150 151
  XSETTYPE (frame, Lisp_Frame);
  f = XFRAME (frame);

  f->cursor_x = 0;
  f->cursor_y = 0;
  f->current_glyphs = 0;
  f->desired_glyphs = 0;
  f->visible = 0;
152
  f->async_visible = 0;
Jim Blandy's avatar
Jim Blandy committed
153 154
  f->display.nothing = 0;
  f->iconified = 0;
155
  f->async_iconified = 0;
Jim Blandy's avatar
Jim Blandy committed
156 157 158 159 160 161
  f->wants_modeline = 1;
  f->auto_raise = 0;
  f->auto_lower = 0;
  f->no_split = 0;
  f->garbaged = 0;
  f->has_minibuffer = mini_p;
162
  f->focus_frame = Qnil;
163
  f->explicit_name = 0;
164 165
  f->can_have_scroll_bars = 0;
  f->has_vertical_scroll_bars = 0;
Jim Blandy's avatar
Jim Blandy committed
166
  f->param_alist = Qnil;
167 168
  f->scroll_bars = Qnil;
  f->condemned_scroll_bars = Qnil;
169
  f->face_alist = Qnil;
170
  f->menu_bar_items = Qnil;
Jim Blandy's avatar
Jim Blandy committed
171

172
  root_window = make_window ();
Jim Blandy's avatar
Jim Blandy committed
173 174
  if (mini_p)
    {
175
      mini_window = make_window ();
Jim Blandy's avatar
Jim Blandy committed
176 177 178
      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
179 180
      XWINDOW (mini_window)->frame = frame;
      f->minibuffer_window = mini_window;
Jim Blandy's avatar
Jim Blandy committed
181 182 183 184 185
    }
  else
    {
      mini_window = Qnil;
      XWINDOW (root_window)->next = Qnil;
Jim Blandy's avatar
Jim Blandy committed
186
      f->minibuffer_window = Qnil;
Jim Blandy's avatar
Jim Blandy committed
187 188
    }

Jim Blandy's avatar
Jim Blandy committed
189
  XWINDOW (root_window)->frame = frame;
Jim Blandy's avatar
Jim Blandy committed
190 191 192

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

Jim Blandy's avatar
Jim Blandy committed
195 196
  f->width = 10;
  f->height = 10;
Jim Blandy's avatar
Jim Blandy committed
197 198 199 200 201 202 203 204 205 206 207

  XFASTINT (XWINDOW (root_window)->width) = 10;
  XFASTINT (XWINDOW (root_window)->height) = (mini_p ? 9 : 10);

  if (mini_p)
    {
      XFASTINT (XWINDOW (mini_window)->width) = 10;
      XFASTINT (XWINDOW (mini_window)->top) = 9;
      XFASTINT (XWINDOW (mini_window)->height) = 1;
    }

Jim Blandy's avatar
Jim Blandy committed
208
  /* Choose a buffer for the frame's root window.  */
Jim Blandy's avatar
Jim Blandy committed
209 210 211 212 213 214 215 216
  {
    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] == ' ')
217
      buf = Fother_buffer (buf, Qnil);
Jim Blandy's avatar
Jim Blandy committed
218 219 220
    Fset_window_buffer (root_window, buf);
  }

Jim Blandy's avatar
Jim Blandy committed
221 222 223 224
  if (mini_p)
    {
      XWINDOW (mini_window)->buffer = Qt;
      Fset_window_buffer (mini_window,
Jim Blandy's avatar
Jim Blandy committed
225
			  (NILP (Vminibuffer_list)
Jim Blandy's avatar
Jim Blandy committed
226 227 228 229
			   ? get_minibuffer (0)
			   : Fcar (Vminibuffer_list)));
    }

Jim Blandy's avatar
Jim Blandy committed
230 231
  f->root_window = root_window;
  f->selected_window = root_window;
Jim Blandy's avatar
Jim Blandy committed
232 233
  /* Make sure this window seems more recently used than
     a newly-created, never-selected window.  */
Jim Blandy's avatar
Jim Blandy committed
234
  XFASTINT (XWINDOW (f->selected_window)->use_time) = ++window_select_count;
Jim Blandy's avatar
Jim Blandy committed
235

Jim Blandy's avatar
Jim Blandy committed
236
  return f;
Jim Blandy's avatar
Jim Blandy committed
237 238
}

Jim Blandy's avatar
Jim Blandy committed
239
/* Make a frame using a separate minibuffer window on another frame.
Jim Blandy's avatar
Jim Blandy committed
240 241 242
   MINI_WINDOW is the minibuffer window to use.  nil means use the
   default (the global minibuffer).  */

Jim Blandy's avatar
Jim Blandy committed
243 244
struct frame *
make_frame_without_minibuffer (mini_window)
Jim Blandy's avatar
Jim Blandy committed
245 246
     register Lisp_Object mini_window;
{
Jim Blandy's avatar
Jim Blandy committed
247
  register struct frame *f;
Jim Blandy's avatar
Jim Blandy committed
248 249

  /* Choose the minibuffer window to use.  */
Jim Blandy's avatar
Jim Blandy committed
250
  if (NILP (mini_window))
Jim Blandy's avatar
Jim Blandy committed
251
    {
Jim Blandy's avatar
Jim Blandy committed
252 253 254 255 256
      if (XTYPE (Vdefault_minibuffer_frame) != Lisp_Frame)
	error ("default-minibuffer-frame must be set when creating minibufferless frames");
      if (! FRAME_LIVE_P (XFRAME (Vdefault_minibuffer_frame)))
	error ("default-minibuffer-frame must be a live frame");
      mini_window = XFRAME (Vdefault_minibuffer_frame)->minibuffer_window;
Jim Blandy's avatar
Jim Blandy committed
257 258 259
    }
  else
    {
260
      CHECK_LIVE_WINDOW (mini_window, 0);
Jim Blandy's avatar
Jim Blandy committed
261 262
    }

Jim Blandy's avatar
Jim Blandy committed
263 264
  /* Make a frame containing just a root window.  */
  f = make_frame (0);
Jim Blandy's avatar
Jim Blandy committed
265 266

  /* Install the chosen minibuffer window, with proper buffer.  */
Jim Blandy's avatar
Jim Blandy committed
267
  f->minibuffer_window = mini_window;
Jim Blandy's avatar
Jim Blandy committed
268
  Fset_window_buffer (mini_window,
Jim Blandy's avatar
Jim Blandy committed
269
		      (NILP (Vminibuffer_list)
Jim Blandy's avatar
Jim Blandy committed
270 271
		       ? get_minibuffer (0)
		       : Fcar (Vminibuffer_list)));
Jim Blandy's avatar
Jim Blandy committed
272
  return f;
Jim Blandy's avatar
Jim Blandy committed
273 274
}

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

Jim Blandy's avatar
Jim Blandy committed
277 278
struct frame *
make_minibuffer_frame ()
Jim Blandy's avatar
Jim Blandy committed
279
{
Jim Blandy's avatar
Jim Blandy committed
280
  /* First make a frame containing just a root window, no minibuffer.  */
Jim Blandy's avatar
Jim Blandy committed
281

Jim Blandy's avatar
Jim Blandy committed
282
  register struct frame *f = make_frame (0);
Jim Blandy's avatar
Jim Blandy committed
283
  register Lisp_Object mini_window;
Jim Blandy's avatar
Jim Blandy committed
284
  register Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
285

Jim Blandy's avatar
Jim Blandy committed
286
  XSET (frame, Lisp_Frame, f);
Jim Blandy's avatar
Jim Blandy committed
287

288
  f->auto_raise = 0;
Jim Blandy's avatar
Jim Blandy committed
289 290 291 292
  f->auto_lower = 0;
  f->no_split = 1;
  f->wants_modeline = 0;
  f->has_minibuffer = 1;
Jim Blandy's avatar
Jim Blandy committed
293 294 295 296 297

  /* 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
298
  mini_window = f->minibuffer_window = f->root_window;
Jim Blandy's avatar
Jim Blandy committed
299 300
  XWINDOW (mini_window)->mini_p = Qt;
  XWINDOW (mini_window)->next = Qnil;
301
  XWINDOW (mini_window)->prev = Qnil;
Jim Blandy's avatar
Jim Blandy committed
302
  XWINDOW (mini_window)->frame = frame;
Jim Blandy's avatar
Jim Blandy committed
303 304 305 306

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

  Fset_window_buffer (mini_window,
Jim Blandy's avatar
Jim Blandy committed
307
		      (NILP (Vminibuffer_list)
Jim Blandy's avatar
Jim Blandy committed
308 309
		       ? get_minibuffer (0)
		       : Fcar (Vminibuffer_list)));
Jim Blandy's avatar
Jim Blandy committed
310
  return f;
Jim Blandy's avatar
Jim Blandy committed
311 312
}

Jim Blandy's avatar
Jim Blandy committed
313
/* Construct a frame that refers to the terminal (stdin and stdout).  */
Jim Blandy's avatar
Jim Blandy committed
314

Jim Blandy's avatar
Jim Blandy committed
315 316
struct frame *
make_terminal_frame ()
Jim Blandy's avatar
Jim Blandy committed
317
{
Jim Blandy's avatar
Jim Blandy committed
318
  register struct frame *f;
319
  Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
320 321 322

  Vframe_list = Qnil;
  f = make_frame (1);
323 324 325 326

  XSET (frame, Lisp_Frame, f);
  Vframe_list = Fcons (frame, Vframe_list);

Jim Blandy's avatar
Jim Blandy committed
327
  f->name = build_string ("terminal");
328
  FRAME_SET_VISIBLE (f, 1);
Jim Blandy's avatar
Jim Blandy committed
329 330 331
  f->display.nothing = 1;   /* Nonzero means frame isn't deleted.  */
  XSET (Vterminal_frame, Lisp_Frame, f);
  return f;
Jim Blandy's avatar
Jim Blandy committed
332 333
}

334 335
static Lisp_Object
do_switch_frame (frame, no_enter, track)
Jim Blandy's avatar
Jim Blandy committed
336
     Lisp_Object frame, no_enter;
337
     int track;
Jim Blandy's avatar
Jim Blandy committed
338
{
339 340 341 342 343 344 345
  /* 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;

346 347 348 349 350 351
  /* 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
352

Jim Blandy's avatar
Jim Blandy committed
353 354
  if (selected_frame == XFRAME (frame))
    return frame;
Jim Blandy's avatar
Jim Blandy committed
355

356 357 358
  /* This is too greedy; it causes inappropriate focus redirection
     that's hard to get rid of.  */
#if 0
359 360 361 362 363 364 365
  /* 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.  */
366 367 368
  if (track)
    {
      Lisp_Object tail;
369

370 371 372
      for (tail = Vframe_list; CONSP (tail); tail = XCONS (tail)->cdr)
	{
	  Lisp_Object focus;
373

374 375
	  if (XTYPE (XCONS (tail)->car) != Lisp_Frame)
	    abort ();
376

377
	  focus = FRAME_FOCUS_FRAME (XFRAME (XCONS (tail)->car));
378

379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
	  if (XTYPE (focus) == Lisp_Frame
	      && XFRAME (focus) == selected_frame)
	    Fredirect_frame_focus (XCONS (tail)->car, frame);
	}
    }
#else /* ! 0 */
  /* Instead, apply it only to the frame we're pointing to.  */
#ifdef HAVE_X_WINDOWS
  if (track)
    {
      Lisp_Object focus, xfocus;

      xfocus = x_get_focus_frame ();
      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 */
401

Jim Blandy's avatar
Jim Blandy committed
402 403 404
  selected_frame = XFRAME (frame);
  if (! FRAME_MINIBUF_ONLY_P (selected_frame))
    last_nonminibuf_frame = selected_frame;
Jim Blandy's avatar
Jim Blandy committed
405

Jim Blandy's avatar
Jim Blandy committed
406 407
  Fselect_window (XFRAME (frame)->selected_window);
  choose_minibuf_frame ();
Jim Blandy's avatar
Jim Blandy committed
408

409
  /* We want to make sure that the next event generates a frame-switch
410
     event to the appropriate frame.  This seems kludgy to me, but
411 412 413 414
     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.  */
415
  internal_last_event_frame = Qnil;
416

Jim Blandy's avatar
Jim Blandy committed
417
  return frame;
Jim Blandy's avatar
Jim Blandy committed
418 419
}

420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
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.")
  (frame, no_enter)
     Lisp_Object frame, no_enter;
{
  return do_switch_frame (frame, no_enter, 0);
}


Jim Blandy's avatar
Jim Blandy committed
449 450
DEFUN ("selected-frame", Fselected_frame, Sselected_frame, 0, 0, 0,
  "Return the frame that is now selected.")
Jim Blandy's avatar
Jim Blandy committed
451 452 453
  ()
{
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
454
  XSET (tem, Lisp_Frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
455 456 457
  return tem;
}

Jim Blandy's avatar
Jim Blandy committed
458 459
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
460 461 462
  (window)
     Lisp_Object window;
{
463
  CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
464
  return XWINDOW (window)->frame;
Jim Blandy's avatar
Jim Blandy committed
465 466
}

467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
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;
}

Jim Blandy's avatar
Jim Blandy committed
494
DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
495 496
       "Returns the root-window of FRAME.\n\
If omitted, FRAME defaults to the currently selected frame.")
Jim Blandy's avatar
Jim Blandy committed
497 498
  (frame)
     Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
499
{
Jim Blandy's avatar
Jim Blandy committed
500 501
  if (NILP (frame))
    XSET (frame, Lisp_Frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
502
  else
Jim Blandy's avatar
Jim Blandy committed
503
    CHECK_LIVE_FRAME (frame, 0);
Jim Blandy's avatar
Jim Blandy committed
504

Jim Blandy's avatar
Jim Blandy committed
505
  return XFRAME (frame)->root_window;
Jim Blandy's avatar
Jim Blandy committed
506 507
}

Jim Blandy's avatar
Jim Blandy committed
508 509
DEFUN ("frame-selected-window", Fframe_selected_window,
       Sframe_selected_window, 0, 1, 0,
510 511
  "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
512 513
  (frame)
     Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
514
{
Jim Blandy's avatar
Jim Blandy committed
515 516
  if (NILP (frame))
    XSET (frame, Lisp_Frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
517
  else
Jim Blandy's avatar
Jim Blandy committed
518
    CHECK_LIVE_FRAME (frame, 0);
Jim Blandy's avatar
Jim Blandy committed
519

Jim Blandy's avatar
Jim Blandy committed
520
  return XFRAME (frame)->selected_window;
Jim Blandy's avatar
Jim Blandy committed
521 522
}

Jim Blandy's avatar
Jim Blandy committed
523
DEFUN ("frame-list", Fframe_list, Sframe_list,
Jim Blandy's avatar
Jim Blandy committed
524
       0, 0, 0,
Jim Blandy's avatar
Jim Blandy committed
525
       "Return a list of all frames.")
Jim Blandy's avatar
Jim Blandy committed
526 527
  ()
{
Jim Blandy's avatar
Jim Blandy committed
528
  return Fcopy_sequence (Vframe_list);
Jim Blandy's avatar
Jim Blandy committed
529 530
}

Jim Blandy's avatar
Jim Blandy committed
531 532 533
/* Return the next frame in the frame list after FRAME.
   If MINIBUF is nil, exclude minibuffer-only frames.
   If MINIBUF is a window, include only frames using that window for
534
   their minibuffer.
535 536 537
   If MINIBUF is `visible', include all visible frames.
   Otherwise, include all frames.  */

Jim Blandy's avatar
Jim Blandy committed
538
Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
539 540
next_frame (frame, minibuf)
     Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
541
     Lisp_Object minibuf;
Jim Blandy's avatar
Jim Blandy committed
542 543 544 545
{
  Lisp_Object tail;
  int passed = 0;

Jim Blandy's avatar
Jim Blandy committed
546 547
  /* There must always be at least one frame in Vframe_list.  */
  if (! CONSP (Vframe_list))
Jim Blandy's avatar
Jim Blandy committed
548 549
    abort ();

Jim Blandy's avatar
Jim Blandy committed
550 551 552 553
  /* 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
554
  while (1)
Jim Blandy's avatar
Jim Blandy committed
555
    for (tail = Vframe_list; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
556
      {
557
	Lisp_Object f;
558

559
	f = XCONS (tail)->car;
Jim Blandy's avatar
Jim Blandy committed
560
	if (passed)
Jim Blandy's avatar
Jim Blandy committed
561
	  {
562 563 564 565 566 567 568 569 570 571 572 573 574
	    /* 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;
	      }
575 576 577 578 579 580 581
	    else if (EQ (minibuf, Qvisible))
	      {
		FRAME_SAMPLE_VISIBILITY (XFRAME (f));
		if (FRAME_VISIBLE_P (XFRAME (f)))
		  return f;
	      }
	    else if (WINDOWP (minibuf))
582 583 584 585 586
	      {
		if (EQ (FRAME_MINIBUF_WINDOW (XFRAME (f)), minibuf))
		  return f;
	      }
	    else
Jim Blandy's avatar
Jim Blandy committed
587
	      return f;
Jim Blandy's avatar
Jim Blandy committed
588
	  }
Jim Blandy's avatar
Jim Blandy committed
589

590
	if (EQ (frame, f))
Jim Blandy's avatar
Jim Blandy committed
591 592 593 594
	  passed++;
      }
}

Jim Blandy's avatar
Jim Blandy committed
595 596 597
/* Return the previous frame in the frame list before FRAME.
   If MINIBUF is nil, exclude minibuffer-only frames.
   If MINIBUF is a window, include only frames using that window for
598
   their minibuffer.
599 600 601
   If MINIBUF is `visible', include all visible frames.
   Otherwise, include all frames.  */

Jim Blandy's avatar
Jim Blandy committed
602
Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
603 604
prev_frame (frame, minibuf)
     Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
605
     Lisp_Object minibuf;
Jim Blandy's avatar
Jim Blandy committed
606 607 608 609
{
  Lisp_Object tail;
  Lisp_Object prev;

Jim Blandy's avatar
Jim Blandy committed
610 611
  /* There must always be at least one frame in Vframe_list.  */
  if (! CONSP (Vframe_list))
Jim Blandy's avatar
Jim Blandy committed
612 613
    abort ();

Jim Blandy's avatar
Jim Blandy committed
614
  prev = Qnil;
615
  for (tail = Vframe_list; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
616
    {
617
      Lisp_Object f;
Jim Blandy's avatar
Jim Blandy committed
618

619
      f = XCONS (tail)->car;
620 621
      if (XTYPE (f) != Lisp_Frame)
	abort ();
Jim Blandy's avatar
Jim Blandy committed
622

623 624
      if (EQ (frame, f) && !NILP (prev))
	return prev;
Jim Blandy's avatar
Jim Blandy committed
625

626 627 628 629 630 631
      /* Decide whether this frame is eligible to be returned,
	 according to minibuf.  */
      if (NILP (minibuf))
	{
	  if (! FRAME_MINIBUF_ONLY_P (XFRAME (f)))
	    prev = f;
Jim Blandy's avatar
Jim Blandy committed
632
	}
633 634 635 636 637
      else if (XTYPE (minibuf) == Lisp_Window)
	{
	  if (EQ (FRAME_MINIBUF_WINDOW (XFRAME (f)), minibuf))
	    prev = f;
	}
638 639 640 641 642 643
      else if (EQ (minibuf, Qvisible))
	{
	  FRAME_SAMPLE_VISIBILITY (XFRAME (f));
	  if (FRAME_VISIBLE_P (XFRAME (f)))
	    prev = f;
	}
644 645
      else
	prev = f;
Jim Blandy's avatar
Jim Blandy committed
646
    }
647 648 649 650 651 652 653 654 655 656 657

  /* 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
658 659
}

660

Jim Blandy's avatar
Jim Blandy committed
661 662
DEFUN ("next-frame", Fnext_frame, Snext_frame, 0, 2, 0,
  "Return the next frame in the frame list after FRAME.\n\
663
By default, skip minibuffer-only frames.\n\
664
If omitted, FRAME defaults to the selected frame.\n\
665
If optional argument MINIFRAME is nil, exclude minibuffer-only frames.\n\
666
If MINIFRAME is a window, include only frames using that window for their\n\
667
minibuffer.\n\
668 669
If MINIFRAME is `visible', include all visible frames.\n\
Otherwise, include all frames.")
Jim Blandy's avatar
Jim Blandy committed
670
  (frame, miniframe)
671
     Lisp_Object frame, miniframe;
Jim Blandy's avatar
Jim Blandy committed
672 673 674
{
  Lisp_Object tail;

Jim Blandy's avatar
Jim Blandy committed
675 676
  if (NILP (frame))
    XSET (frame, Lisp_Frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
677
  else
Jim Blandy's avatar
Jim Blandy committed
678
    CHECK_LIVE_FRAME (frame, 0);
Jim Blandy's avatar
Jim Blandy committed
679

Jim Blandy's avatar
Jim Blandy committed
680
  return next_frame (frame, miniframe);
Jim Blandy's avatar
Jim Blandy committed
681
}
Jim Blandy's avatar
Jim Blandy committed
682

683 684 685 686 687 688 689
DEFUN ("previous-frame", Fprevious_frame, Sprevious_frame, 0, 2, 0,
  "Return the previous frame in the frame list before FRAME.\n\
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\
If MINIFRAME is a window, include only frames using that window for their\n\
minibuffer.\n\
690 691
If MINIFRAME is `visible', include all visible frames.\n\
Otherwise, include all frames.")
692 693 694 695 696 697 698 699 700 701 702 703
  (frame, miniframe)
     Lisp_Object frame, miniframe;
{
  Lisp_Object tail;

  if (NILP (frame))
    XSET (frame, Lisp_Frame, selected_frame);
  else
    CHECK_LIVE_FRAME (frame, 0);

  return prev_frame (frame, miniframe);
}
Jim Blandy's avatar
Jim Blandy committed
704

705 706 707
/* 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
708

709 710 711 712 713 714 715
static int
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)
716 717 718 719 720 721 722 723
    {
      Lisp_Object frames;
      int count = 0;

      for (frames = Vframe_list;
	   CONSP (frames);
	   frames = XCONS (frames)->cdr)
	{
724
	  Lisp_Object this;
725

726
	  this = XCONS (frames)->car;
727 728 729
	  /* Verify that the frame's window still exists
	     and we can still talk to it.  And note any recent change
	     in visibility.  */
730 731 732 733 734 735 736 737
#ifdef HAVE_X_WINDOWS
	  if (FRAME_X_P (XFRAME (this)))
	    {
	      x_sync (this);
	      FRAME_SAMPLE_VISIBILITY (XFRAME (this));
	    }
#endif

738 739 740 741
	  if (FRAME_VISIBLE_P (XFRAME (this))
	      || FRAME_ICONIFIED_P (XFRAME (this))
	      /* Allow deleting the terminal frame when at least
		 one X frame exists!  */
742
	      || (FRAME_X_P (XFRAME (this)) && !FRAME_X_P (f)))
743 744
	    count++;
	}
745
      return count > 1;
746
    }
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
  return 1;
}

DEFUN ("delete-frame", Fdelete_frame, Sdelete_frame, 0, 2, "",
  "Delete FRAME, permanently eliminating it from use.\n\
If omitted, FRAME defaults to the selected frame.\n\
A frame may not be deleted if its minibuffer is used by other frames.\n\
Normally, you may not delete a frame if all other frames are invisible,\n\
but if the second optional argument FORCE is non-nil, you may do so.")
  (frame, force)
     Lisp_Object frame, force;
{
  struct frame *f;

  if (EQ (frame, Qnil))
    {
      f = selected_frame;
      XSET (frame, Lisp_Frame, f);
    }
  else
    {
      CHECK_FRAME (frame, 0);
      f = XFRAME (frame);
    }

  if (! FRAME_LIVE_P (f))
    return Qnil;

  if (NILP (force) && !other_visible_frames (f))
    error ("Attempt to delete the sole visible or iconified frame");
Jim Blandy's avatar
Jim Blandy committed
777

Jim Blandy's avatar
Jim Blandy committed
778 779
  /* Does this frame have a minibuffer, and is it the surrogate
     minibuffer for any other frame?  */
780
  if (FRAME_HAS_MINIBUF_P (XFRAME (frame)))
Jim Blandy's avatar
Jim Blandy committed
781
    {
Jim Blandy's avatar
Jim Blandy committed
782
      Lisp_Object frames;
Jim Blandy's avatar
Jim Blandy committed
783

Jim Blandy's avatar
Jim Blandy committed
784 785 786
      for (frames = Vframe_list;
	   CONSP (frames);
	   frames = XCONS (frames)->cdr)
Jim Blandy's avatar
Jim Blandy committed
787
	{
788 789
	  Lisp_Object this;
	  this = XCONS (frames)->car;
Jim Blandy's avatar
Jim Blandy committed
790

Jim Blandy's avatar
Jim Blandy committed
791 792
	  if (! EQ (this, frame)
	      && EQ (frame,
793 794
		     WINDOW_FRAME (XWINDOW
				   (FRAME_MINIBUF_WINDOW (XFRAME (this))))))
Jim Blandy's avatar
Jim Blandy committed
795
	    error ("Attempt to delete a surrogate minibuffer frame");
Jim Blandy's avatar
Jim Blandy committed
796
	}
Jim Blandy's avatar
Jim Blandy committed
797 798
    }

Jim Blandy's avatar
Jim Blandy committed
799 800
  /* Don't let the frame remain selected.  */
  if (f == selected_frame)
801
    Fhandle_switch_frame (next_frame (frame, Qt), Qnil);
Jim Blandy's avatar
Jim Blandy committed
802

Jim Blandy's avatar
Jim Blandy committed
803 804
  /* Don't allow minibuf_window to remain on a deleted frame.  */
  if (EQ (f->minibuffer_window, minibuf_window))
Jim Blandy's avatar
Jim Blandy committed
805
    {
Jim Blandy's avatar
Jim Blandy committed
806
      Fset_window_buffer (selected_frame->minibuffer_window,
Jim Blandy's avatar
Jim Blandy committed
807
			  XWINDOW (minibuf_window)->buffer);
Jim Blandy's avatar
Jim Blandy committed
808
      minibuf_window = selected_frame->minibuffer_window;
Jim Blandy's avatar
Jim Blandy committed
809 810
    }

811 812 813 814 815
  /* Mark all the windows that used to be on FRAME as deleted, and then
     remove the reference to them.  */
  delete_all_subwindows (XWINDOW (f->root_window));
  f->root_window = Qnil;

Jim Blandy's avatar
Jim Blandy committed
816
  Vframe_list = Fdelq (frame, Vframe_list);
817
  FRAME_SET_VISIBLE (f, 0);
Jim Blandy's avatar
Jim Blandy committed
818

819 820 821 822 823
  /* Since some events are handled at the interrupt level, we may get
     an event for f at any time; if we zero out the frame's display
     now, then we may trip up the event-handling code.  Instead, we'll
     promise that the display of the frame must be valid until we have
     called the window-system-dependent frame destruction routine.  */
Jim Blandy's avatar
Jim Blandy committed
824 825

  /* I think this should be done with a hook.  */
Jim Blandy's avatar
Jim Blandy committed
826
#ifdef HAVE_X_WINDOWS
827
  if (FRAME_X_P (f))
828
    x_destroy_window (f);
Jim Blandy's avatar
Jim Blandy committed
829 830
#endif

831 832
  f->display.nothing = 0;

Jim Blandy's avatar
Jim Blandy committed
833
  /* If we've deleted the last_nonminibuf_frame, then try to find
Jim Blandy's avatar
Jim Blandy committed
834
     another one.  */
Jim Blandy's avatar
Jim Blandy committed
835
  if (f == last_nonminibuf_frame)
Jim Blandy's avatar
Jim Blandy committed
836
    {
Jim Blandy's avatar
Jim Blandy committed
837
      Lisp_Object frames;
Jim Blandy's avatar
Jim Blandy committed
838

Jim Blandy's avatar
Jim Blandy committed
839
      last_nonminibuf_frame = 0;
Jim Blandy's avatar
Jim Blandy committed
840

Jim Blandy's avatar
Jim Blandy committed
841 842 843
      for (frames = Vframe_list;
	   CONSP (frames);
	   frames = XCONS (frames)->cdr)
Jim Blandy's avatar
Jim Blandy committed
844
	{
Jim Blandy's avatar
Jim Blandy committed
845 846
	  f = XFRAME (XCONS (frames)->car);
	  if (!FRAME_MINIBUF_ONLY_P (f))
Jim Blandy's avatar
Jim Blandy committed
847
	    {
Jim Blandy's avatar
Jim Blandy committed
848
	      last_nonminibuf_frame = f;
Jim Blandy's avatar
Jim Blandy committed
849 850 851 852
	      break;
	    }
	}
    }
Jim Blandy's avatar
Jim Blandy committed
853

Jim Blandy's avatar
Jim Blandy committed
854 855
  /* If we've deleted Vdefault_minibuffer_frame, try to find another
     one.  Prefer minibuffer-only frames, but also notice frames
Jim Blandy's avatar
Jim Blandy committed
856
     with other windows.  */
Jim Blandy's avatar
Jim Blandy committed
857
  if (EQ (frame, Vdefault_minibuffer_frame))
Jim Blandy's avatar
Jim Blandy committed
858
    {
Jim Blandy's avatar
Jim Blandy committed
859
      Lisp_Object frames;
Jim Blandy's avatar
Jim Blandy committed
860

Jim Blandy's avatar
Jim Blandy committed
861
      /* The last frame we saw with a minibuffer, minibuffer-only or not.  */
862
      Lisp_Object frame_with_minibuf;
Jim Blandy's avatar
Jim Blandy committed
863

864
      frame_with_minibuf = Qnil;
Jim Blandy's avatar
Jim Blandy committed
865 866 867
      for (frames = Vframe_list;
	   CONSP (frames);
	   frames = XCONS (frames)->cdr)
Jim Blandy's avatar
Jim Blandy committed
868
	{
869
	  Lisp_Object this;
Jim Blandy's avatar
Jim Blandy committed
870

871
	  this = XCONS (frames)->car;
Jim Blandy's avatar
Jim Blandy committed
872
	  if (XTYPE (this) != Lisp_Frame)
Jim Blandy's avatar
Jim Blandy committed
873
	    abort ();
Jim Blandy's avatar
Jim Blandy committed
874
	  f = XFRAME (this);
Jim Blandy's avatar
Jim Blandy committed
875

876
	  if (FRAME_HAS_MINIBUF_P (f))
Jim Blandy's avatar
Jim Blandy committed
877
	    {
Jim Blandy's avatar
Jim Blandy committed
878 879
	      frame_with_minibuf = this;
	      if (FRAME_MINIBUF_ONLY_P (f))
Jim Blandy's avatar
Jim Blandy committed
880 881 882 883
		break;
	    }
	}

Jim Blandy's avatar
Jim Blandy committed
884 885
      /* We know that there must be some frame with a minibuffer out
	 there.  If this were not true, all of the frames present
Jim Blandy's avatar
Jim Blandy committed
886
	 would have to be minibufferless, which implies that at some
Jim Blandy's avatar
Jim Blandy committed
887
	 point their minibuffer frames must have been deleted, but
Jim Blandy's avatar
Jim Blandy committed
888
	 that is prohibited at the top; you can't delete surrogate
Jim Blandy's avatar
Jim Blandy committed
889 890
	 minibuffer frames.  */
      if (NILP (frame_with_minibuf))
Jim Blandy's avatar
Jim Blandy committed
891 892
	abort ();

Jim Blandy's avatar
Jim Blandy committed
893
      Vdefault_minibuffer_frame = frame_with_minibuf;
Jim Blandy's avatar
Jim Blandy committed
894 895
    }

Jim Blandy's avatar
Jim Blandy committed
896 897 898 899 900
  return Qnil;
}

/* Return mouse position in character cell units.  */

Jim Blandy's avatar
Jim Blandy committed
901
DEFUN ("mouse-position", Fmouse_position, Smouse_position, 0, 0, 0,
Jim Blandy's avatar
Jim Blandy committed
902
  "Return a list (FRAME X . Y) giving the current mouse frame and position.\n\
903 904
The position is given in character cells, where (0, 0) is the\n\
upper-left corner.\n\
Jim Blandy's avatar
Jim Blandy committed
905
If Emacs is running on a mouseless terminal or hasn't been programmed\n\
Jim Blandy's avatar
Jim Blandy committed
906
to read the mouse position, it returns the selected frame for FRAME\n\
Jim Blandy's avatar
Jim Blandy committed
907 908
and nil for X and Y.")
  ()
Jim Blandy's avatar
Jim Blandy committed
909
{
Jim Blandy's avatar
Jim Blandy committed
910
  FRAME_PTR f;
Jim Blandy's avatar
Jim Blandy committed
911
  Lisp_Object lispy_dummy;
912
  enum scroll_bar_part party_dummy;
Jim Blandy's avatar
Jim Blandy committed
913
  Lisp_Object x, y;
914
  int col, row;
Jim Blandy's avatar
Jim Blandy committed
915
  unsigned long long_dummy;
Jim Blandy's avatar
Jim Blandy committed
916

917 918 919 920
  f = selected_frame;
  x = y = Qnil;

  /* It's okay for the hook to refrain from storing anything.  */
Jim Blandy's avatar
Jim Blandy committed
921
  if (mouse_position_hook)
Jim Blandy's avatar
Jim Blandy committed
922 923 924 925
    (*mouse_position_hook) (&f,
			    &lispy_dummy, &party_dummy,
			    &x, &y,
			    &long_dummy);
926 927 928 929
  if (! NILP (x))
    {
      col = XINT (x);
      row = XINT (y);
Karl Heuer's avatar
Karl Heuer committed
930
      pixel_to_glyph_coords (f, col, row, &col, &row, 0, 1);
931 932 933
      XSETINT (x, col);
      XSETINT (y, row);
    }
Jim Blandy's avatar
Jim Blandy committed
934
  XSET (lispy_dummy, Lisp_Frame, f);
935
  return Fcons (lispy_dummy, Fcons (x, y));
Jim Blandy's avatar
Jim Blandy committed
936 937
}

938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
DEFUN ("mouse-pixel-position", Fmouse_pixel_position,
       Smouse_pixel_position, 0, 0, 0,
  "Return a list (FRAME X . Y) giving the current mouse frame and position.\n\
The position is given in pixel units, where (0, 0) is the\n\
upper-left corner.\n\
If Emacs is running on a mouseless terminal or hasn't been programmed\n\
to read the mouse position, it returns the selected frame for FRAME\n\
and nil for X and Y.")
  ()
{
  FRAME_PTR f;
  Lisp_Object lispy_dummy;
  enum scroll_bar_part party_dummy;
  Lisp_Object x, y;
  int col, row;
  unsigned long long_dummy;

  f = selected_frame;
  x = y = Qnil;

  /* It's okay for the hook to refrain from storing anything.  */
  if (mouse_position_hook)
    (*mouse_position_hook) (&f,
			    &lispy_dummy, &party_dummy,
			    &x, &y,
			    &long_dummy);
  XSET (lispy_dummy, Lisp_Frame, f);
  return Fcons (lispy_dummy, Fcons (x, y));
}

Jim Blandy's avatar
Jim Blandy committed
968
DEFUN ("set-mouse-position", Fset_mouse_position, Sset_mouse_position, 3, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
969
  "Move the mouse pointer to the center of character cell (X,Y) in FRAME.\n\
970 971
WARNING:  If you use this under X windows,\n\
you should call `unfocus-frame' afterwards.")
Jim Blandy's avatar
Jim Blandy committed
972 973
  (frame, x, y)
     Lisp_Object frame, x, y;
Jim Blandy's avatar
Jim Blandy committed
974
{
Jim Blandy's avatar
Jim Blandy committed
975
  CHECK_LIVE_FRAME (frame, 0);
Jim Blandy's avatar
Jim Blandy committed
976 977 978
  CHECK_NUMBER (x, 2);
  CHECK_NUMBER (y, 1);

Jim Blandy's avatar
Jim Blandy committed
979
  /* I think this should be done with a hook.  */
Jim Blandy's avatar
Jim Blandy committed
980
#ifdef HAVE_X_WINDOWS
981
  if (FRAME_X_P (XFRAME (frame)))
Jim Blandy's avatar
Jim Blandy committed
982
    /* Warping the mouse will cause  enternotify and focus events. */
Jim Blandy's avatar
Jim Blandy committed
983
    x_set_mouse_position (XFRAME (frame), x, y);
Jim Blandy's avatar
Jim Blandy committed
984 985 986 987
#endif

  return Qnil;
}
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009

DEFUN ("set-mouse-pixel-position", Fset_mouse_pixel_position,
       Sset_mouse_pixel_position, 3, 3, 0,
  "Move the mouse pointer to pixel position (X,Y) in FRAME.\n\
WARNING:  If you use this under X windows,\n\
you should call `unfocus-frame' afterwards.")
  (frame, x, y)
     Lisp_Object frame, x, y;
{
  CHECK_LIVE_FRAME (frame, 0);
  CHECK_NUMBER (x, 2);
  CHECK_NUMBER (y, 1);

  /* I think this should be done with a hook.  */
#ifdef HAVE_X_WINDOWS
  if (FRAME_X_P (XFRAME (frame)))
    /* Warping the mouse will cause  enternotify and focus events. */
    x_set_mouse_pixel_position (XFRAME (frame), x, y);
#endif

  return Qnil;
}
Jim Blandy's avatar
Jim Blandy committed
1010

Jim Blandy's avatar
Jim Blandy committed
1011
DEFUN ("make-frame-visible", Fmake_frame_visible, Smake_frame_visible,
1012
       0, 1, "",
Jim Blandy's avatar
Jim Blandy committed
1013
  "Make the frame FRAME visible (assuming it is an X-window).\n\