frame.c 56.8 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Generic frame functions.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1993, 1994 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"
26
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
27

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

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

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;
171 172
  f->menu_bar_vector = Qnil;
  f->menu_bar_items_used = 0;
Jim Blandy's avatar
Jim Blandy committed
173

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

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

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

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

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

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

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

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

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

  /* Choose the minibuffer window to use.  */
Jim Blandy's avatar
Jim Blandy committed
252
  if (NILP (mini_window))
Jim Blandy's avatar
Jim Blandy committed
253
    {
Jim Blandy's avatar
Jim Blandy committed
254 255 256 257 258
      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
259 260 261
    }
  else
    {
262
      CHECK_LIVE_WINDOW (mini_window, 0);
Jim Blandy's avatar
Jim Blandy committed
263 264
    }

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
288
  XSET (frame, Lisp_Frame, f);
Jim Blandy's avatar
Jim Blandy committed
289

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

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

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

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

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

  Vframe_list = Qnil;
  f = make_frame (1);
325 326 327 328

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

Jim Blandy's avatar
Jim Blandy committed
329
  f->name = build_string ("terminal");
330
  FRAME_SET_VISIBLE (f, 1);
Jim Blandy's avatar
Jim Blandy committed
331 332 333
  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
334 335
}

336 337
static Lisp_Object
do_switch_frame (frame, no_enter, track)
Jim Blandy's avatar
Jim Blandy committed
338
     Lisp_Object frame, no_enter;
339
     int track;
Jim Blandy's avatar
Jim Blandy committed
340
{
341 342 343 344 345 346 347
  /* 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;

348 349 350 351 352 353
  /* 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
354

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

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

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

376 377
	  if (XTYPE (XCONS (tail)->car) != Lisp_Frame)
	    abort ();
378

379
	  focus = FRAME_FOCUS_FRAME (XFRAME (XCONS (tail)->car));
380

381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
	  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 */
403

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

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

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

Jim Blandy's avatar
Jim Blandy committed
419
  return frame;
Jim Blandy's avatar
Jim Blandy committed
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 449 450
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
451 452
DEFUN ("selected-frame", Fselected_frame, Sselected_frame, 0, 0, 0,
  "Return the frame that is now selected.")
Jim Blandy's avatar
Jim Blandy committed
453 454 455
  ()
{
  Lisp_Object tem;
Jim Blandy's avatar
Jim Blandy committed
456
  XSET (tem, Lisp_Frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
457 458
  return tem;
}
459

Jim Blandy's avatar
Jim Blandy committed
460 461
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
462 463 464
  (window)
     Lisp_Object window;
{
465
  CHECK_LIVE_WINDOW (window, 0);
Jim Blandy's avatar
Jim Blandy committed
466
  return XWINDOW (window)->frame;
Jim Blandy's avatar
Jim Blandy committed
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 494 495
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
496
DEFUN ("frame-root-window", Fframe_root_window, Sframe_root_window, 0, 1, 0,
497 498
       "Returns the root-window of FRAME.\n\
If omitted, FRAME defaults to the currently selected frame.")
Jim Blandy's avatar
Jim Blandy committed
499 500
  (frame)
     Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
501
{
Jim Blandy's avatar
Jim Blandy committed
502 503
  if (NILP (frame))
    XSET (frame, Lisp_Frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
504
  else
Jim Blandy's avatar
Jim Blandy committed
505
    CHECK_LIVE_FRAME (frame, 0);
Jim Blandy's avatar
Jim Blandy committed
506

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

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

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

525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
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))
    XSET (frame, Lisp_Frame, selected_frame);
  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
549
DEFUN ("frame-list", Fframe_list, Sframe_list,
Jim Blandy's avatar
Jim Blandy committed
550
       0, 0, 0,
Jim Blandy's avatar
Jim Blandy committed
551
       "Return a list of all frames.")
Jim Blandy's avatar
Jim Blandy committed
552 553
  ()
{
Jim Blandy's avatar
Jim Blandy committed
554
  return Fcopy_sequence (Vframe_list);
Jim Blandy's avatar
Jim Blandy committed
555 556
}

Jim Blandy's avatar
Jim Blandy committed
557 558 559
/* 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
560
   their minibuffer.
561 562 563
   If MINIBUF is `visible', include all visible frames.
   Otherwise, include all frames.  */

Jim Blandy's avatar
Jim Blandy committed
564
Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
565 566
next_frame (frame, minibuf)
     Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
567
     Lisp_Object minibuf;
Jim Blandy's avatar
Jim Blandy committed
568 569 570 571
{
  Lisp_Object tail;
  int passed = 0;

Jim Blandy's avatar
Jim Blandy committed
572 573
  /* There must always be at least one frame in Vframe_list.  */
  if (! CONSP (Vframe_list))
Jim Blandy's avatar
Jim Blandy committed
574 575
    abort ();

Jim Blandy's avatar
Jim Blandy committed
576 577 578 579
  /* 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
580
  while (1)
Jim Blandy's avatar
Jim Blandy committed
581
    for (tail = Vframe_list; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
582
      {
583
	Lisp_Object f;
584

585
	f = XCONS (tail)->car;
Jim Blandy's avatar
Jim Blandy committed
586
	if (passed)
Jim Blandy's avatar
Jim Blandy committed
587
	  {
588 589 590 591 592 593 594 595 596 597 598 599 600
	    /* 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;
	      }
601 602 603 604 605 606 607
	    else if (EQ (minibuf, Qvisible))
	      {
		FRAME_SAMPLE_VISIBILITY (XFRAME (f));
		if (FRAME_VISIBLE_P (XFRAME (f)))
		  return f;
	      }
	    else if (WINDOWP (minibuf))
608 609 610 611 612
	      {
		if (EQ (FRAME_MINIBUF_WINDOW (XFRAME (f)), minibuf))
		  return f;
	      }
	    else
Jim Blandy's avatar
Jim Blandy committed
613
	      return f;
Jim Blandy's avatar
Jim Blandy committed
614
	  }
Jim Blandy's avatar
Jim Blandy committed
615

616
	if (EQ (frame, f))
Jim Blandy's avatar
Jim Blandy committed
617 618 619 620
	  passed++;
      }
}

Jim Blandy's avatar
Jim Blandy committed
621 622 623
/* 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
624
   their minibuffer.
625 626 627
   If MINIBUF is `visible', include all visible frames.
   Otherwise, include all frames.  */

Jim Blandy's avatar
Jim Blandy committed
628
Lisp_Object
Jim Blandy's avatar
Jim Blandy committed
629 630
prev_frame (frame, minibuf)
     Lisp_Object frame;
Jim Blandy's avatar
Jim Blandy committed
631
     Lisp_Object minibuf;
Jim Blandy's avatar
Jim Blandy committed
632 633 634 635
{
  Lisp_Object tail;
  Lisp_Object prev;

Jim Blandy's avatar
Jim Blandy committed
636 637
  /* There must always be at least one frame in Vframe_list.  */
  if (! CONSP (Vframe_list))
Jim Blandy's avatar
Jim Blandy committed
638 639
    abort ();

Jim Blandy's avatar
Jim Blandy committed
640
  prev = Qnil;
641
  for (tail = Vframe_list; CONSP (tail); tail = XCONS (tail)->cdr)
Jim Blandy's avatar
Jim Blandy committed
642
    {
643
      Lisp_Object f;
Jim Blandy's avatar
Jim Blandy committed
644

645
      f = XCONS (tail)->car;
646 647
      if (XTYPE (f) != Lisp_Frame)
	abort ();
Jim Blandy's avatar
Jim Blandy committed
648

649 650
      if (EQ (frame, f) && !NILP (prev))
	return prev;
Jim Blandy's avatar
Jim Blandy committed
651

652 653 654 655 656 657
      /* 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
658
	}
659 660 661 662 663
      else if (XTYPE (minibuf) == Lisp_Window)
	{
	  if (EQ (FRAME_MINIBUF_WINDOW (XFRAME (f)), minibuf))
	    prev = f;
	}
664 665 666 667 668 669
      else if (EQ (minibuf, Qvisible))
	{
	  FRAME_SAMPLE_VISIBILITY (XFRAME (f));
	  if (FRAME_VISIBLE_P (XFRAME (f)))
	    prev = f;
	}
670 671
      else
	prev = f;
Jim Blandy's avatar
Jim Blandy committed
672
    }
673 674 675 676 677 678 679 680 681 682 683

  /* 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
684 685
}

686

Jim Blandy's avatar
Jim Blandy committed
687 688
DEFUN ("next-frame", Fnext_frame, Snext_frame, 0, 2, 0,
  "Return the next frame in the frame list after FRAME.\n\
689
By default, skip minibuffer-only frames.\n\
690
If omitted, FRAME defaults to the selected frame.\n\
691
If optional argument MINIFRAME is nil, exclude minibuffer-only frames.\n\
692
If MINIFRAME is a window, include only frames using that window for their\n\
693
minibuffer.\n\
694 695
If MINIFRAME is `visible', include all visible frames.\n\
Otherwise, include all frames.")
Jim Blandy's avatar
Jim Blandy committed
696
  (frame, miniframe)
697
     Lisp_Object frame, miniframe;
Jim Blandy's avatar
Jim Blandy committed
698 699 700
{
  Lisp_Object tail;

Jim Blandy's avatar
Jim Blandy committed
701 702
  if (NILP (frame))
    XSET (frame, Lisp_Frame, selected_frame);
Jim Blandy's avatar
Jim Blandy committed
703
  else
Jim Blandy's avatar
Jim Blandy committed
704
    CHECK_LIVE_FRAME (frame, 0);
Jim Blandy's avatar
Jim Blandy committed
705

Jim Blandy's avatar
Jim Blandy committed
706
  return next_frame (frame, miniframe);
Jim Blandy's avatar
Jim Blandy committed
707
}
Jim Blandy's avatar
Jim Blandy committed
708

709 710 711 712 713 714 715
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\
716 717
If MINIFRAME is `visible', include all visible frames.\n\
Otherwise, include all frames.")
718 719 720 721 722 723 724 725 726 727 728 729
  (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
730

731 732 733
/* 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
734

735
int
736 737 738 739 740 741
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)
742 743 744 745 746 747 748 749
    {
      Lisp_Object frames;
      int count = 0;

      for (frames = Vframe_list;
	   CONSP (frames);
	   frames = XCONS (frames)->cdr)
	{
750
	  Lisp_Object this;
751

752
	  this = XCONS (frames)->car;
753 754 755
	  /* Verify that the frame's window still exists
	     and we can still talk to it.  And note any recent change
	     in visibility.  */
756 757 758 759 760 761 762 763
#ifdef HAVE_X_WINDOWS
	  if (FRAME_X_P (XFRAME (this)))
	    {
	      x_sync (this);
	      FRAME_SAMPLE_VISIBILITY (XFRAME (this));
	    }
#endif

764 765 766 767
	  if (FRAME_VISIBLE_P (XFRAME (this))
	      || FRAME_ICONIFIED_P (XFRAME (this))
	      /* Allow deleting the terminal frame when at least
		 one X frame exists!  */
768
	      || (FRAME_X_P (XFRAME (this)) && !FRAME_X_P (f)))
769 770
	    count++;
	}
771
      return count > 1;
772
    }
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
  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
803

Jim Blandy's avatar
Jim Blandy committed
804 805
  /* Does this frame have a minibuffer, and is it the surrogate
     minibuffer for any other frame?  */
806
  if (FRAME_HAS_MINIBUF_P (XFRAME (frame)))
Jim Blandy's avatar
Jim Blandy committed
807
    {
Jim Blandy's avatar
Jim Blandy committed
808
      Lisp_Object frames;
Jim Blandy's avatar
Jim Blandy committed
809

Jim Blandy's avatar
Jim Blandy committed
810 811 812
      for (frames = Vframe_list;
	   CONSP (frames);
	   frames = XCONS (frames)->cdr)
Jim Blandy's avatar
Jim Blandy committed
813
	{
814 815
	  Lisp_Object this;
	  this = XCONS (frames)->car;
Jim Blandy's avatar
Jim Blandy committed
816

Jim Blandy's avatar
Jim Blandy committed
817 818
	  if (! EQ (this, frame)
	      && EQ (frame,
819 820
		     WINDOW_FRAME (XWINDOW
				   (FRAME_MINIBUF_WINDOW (XFRAME (this))))))
Jim Blandy's avatar
Jim Blandy committed
821
	    error ("Attempt to delete a surrogate minibuffer frame");
Jim Blandy's avatar
Jim Blandy committed
822
	}
Jim Blandy's avatar
Jim Blandy committed
823 824
    }

Jim Blandy's avatar
Jim Blandy committed
825 826
  /* Don't let the frame remain selected.  */
  if (f == selected_frame)
827
    Fhandle_switch_frame (next_frame (frame, Qt), Qnil);
Jim Blandy's avatar
Jim Blandy committed
828

Jim Blandy's avatar
Jim Blandy committed
829 830
  /* 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
831
    {
Jim Blandy's avatar
Jim Blandy committed
832
      Fset_window_buffer (selected_frame->minibuffer_window,
Jim Blandy's avatar
Jim Blandy committed
833
			  XWINDOW (minibuf_window)->buffer);
Jim Blandy's avatar
Jim Blandy committed
834
      minibuf_window = selected_frame->minibuffer_window;
Jim Blandy's avatar
Jim Blandy committed
835 836
    }

837 838 839 840 841
  /* 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
842
  Vframe_list = Fdelq (frame, Vframe_list);
843
  FRAME_SET_VISIBLE (f, 0);
Jim Blandy's avatar
Jim Blandy committed
844

845 846 847 848 849
  /* 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
850 851

  /* I think this should be done with a hook.  */
Jim Blandy's avatar
Jim Blandy committed
852
#ifdef HAVE_X_WINDOWS
853
  if (FRAME_X_P (f))
854
    x_destroy_window (f);
Jim Blandy's avatar
Jim Blandy committed
855 856
#endif

857 858
  f->display.nothing = 0;

Jim Blandy's avatar
Jim Blandy committed
859
  /* If we've deleted the last_nonminibuf_frame, then try to find
Jim Blandy's avatar
Jim Blandy committed
860
     another one.  */
Jim Blandy's avatar
Jim Blandy committed
861
  if (f == last_nonminibuf_frame)
Jim Blandy's avatar
Jim Blandy committed
862
    {
Jim Blandy's avatar
Jim Blandy committed
863
      Lisp_Object frames;
Jim Blandy's avatar
Jim Blandy committed
864

Jim Blandy's avatar
Jim Blandy committed
865
      last_nonminibuf_frame = 0;
Jim Blandy's avatar
Jim Blandy committed
866

Jim Blandy's avatar
Jim Blandy committed
867 868 869
      for (frames = Vframe_list;
	   CONSP (frames);
	   frames = XCONS (frames)->cdr)
Jim Blandy's avatar
Jim Blandy committed
870
	{
Jim Blandy's avatar
Jim Blandy committed
871 872
	  f = XFRAME (XCONS (frames)->car);
	  if (!FRAME_MINIBUF_ONLY_P (f))
Jim Blandy's avatar
Jim Blandy committed
873
	    {
Jim Blandy's avatar
Jim Blandy committed
874
	      last_nonminibuf_frame = f;
Jim Blandy's avatar
Jim Blandy committed
875 876 877 878
	      break;
	    }
	}
    }
Jim Blandy's avatar
Jim Blandy committed
879

Jim Blandy's avatar
Jim Blandy committed
880 881
  /* 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
882
     with other windows.  */
Jim Blandy's avatar
Jim Blandy committed
883
  if (EQ (frame, Vdefault_minibuffer_frame))
Jim Blandy's avatar
Jim Blandy committed
884
    {
Jim Blandy's avatar
Jim Blandy committed
885
      Lisp_Object frames;
Jim Blandy's avatar
Jim Blandy committed
886

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

890
      frame_with_minibuf = Qnil;
Jim Blandy's avatar
Jim Blandy committed
891 892 893
      for (frames = Vframe_list;
	   CONSP (frames);
	   frames = XCONS (frames)->cdr)
Jim Blandy's avatar
Jim Blandy committed
894
	{
895
	  Lisp_Object this;
Jim Blandy's avatar
Jim Blandy committed
896

897
	  this = XCONS (frames)->car;
Jim Blandy's avatar
Jim Blandy committed
898
	  if (XTYPE (this) != Lisp_Frame)
Jim Blandy's avatar
Jim Blandy committed
899
	    abort ();
Jim Blandy's avatar
Jim Blandy committed
900
	  f = XFRAME (this);
Jim Blandy's avatar
Jim Blandy committed
901

902
	  if (FRAME_HAS_MINIBUF_P (f))
Jim Blandy's avatar
Jim Blandy committed
903
	    {
Jim Blandy's avatar
Jim Blandy committed
904 905
	      frame_with_minibuf = this;
	      if (FRAME_MINIBUF_ONLY_P (f))
Jim Blandy's avatar
Jim Blandy committed
906 907 908 909
		break;
	    }
	}

Jim Blandy's avatar
Jim Blandy committed
910 911
      /* 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
912
	 would have to be minibufferless, which implies that at some
Jim Blandy's avatar
Jim Blandy committed
913
	 point their minibuffer frames must have been deleted, but
Jim Blandy's avatar
Jim Blandy committed
914
	 that is prohibited at the top; you can't delete surrogate
Jim Blandy's avatar
Jim Blandy committed
915 916
	 minibuffer frames.  */
      if (NILP (frame_with_minibuf))
Jim Blandy's avatar
Jim Blandy committed
917 918
	abort ();

Jim Blandy's avatar
Jim Blandy committed
919
      Vdefault_minibuffer_frame = frame_with_minibuf;
Jim Blandy's avatar
Jim Blandy committed
920 921
    }

Jim Blandy's avatar
Jim Blandy committed
922 923 924 925 926
  return Qnil;
}

/* Return mouse position in character cell units.  */

Jim Blandy's avatar
Jim Blandy committed
927
DEFUN ("mouse-position", Fmouse_position, Smouse_position, 0, 0, 0,
Jim Blandy's avatar
Jim Blandy committed
928
  "Return a list (FRAME X . Y) giving the current mouse frame and position.\n\
929 930
The position is given in character cells, where (0, 0) is the\n\
upper-left corner.\n\
Jim Blandy's avatar
Jim Blandy committed
931
If Emacs is running on a mouseless terminal or hasn't been programmed\n\
Jim Blandy's avatar
Jim Blandy committed
932
to read the mouse position, it returns the selected frame for FRAME\n\
Jim Blandy's avatar
Jim Blandy committed
933 934
and nil for X and Y.")
  ()
Jim Blandy's avatar
Jim Blandy committed
935
{
Jim Blandy's avatar
Jim Blandy committed
936
  FRAME_PTR f;
Jim Blandy's avatar
Jim Blandy committed
937
  Lisp_Object lispy_dummy;
938
  enum scroll_bar_part party_dummy;
Jim Blandy's avatar
Jim Blandy committed
939
  Lisp_Object x, y;
940
  int col, row;
Jim Blandy's avatar
Jim Blandy committed
941
  unsigned long long_dummy;
Jim Blandy's avatar
Jim Blandy committed
942

943 944 945 946
  f = selected_frame;
  x = y = Qnil;

  /* It's okay for the hook to refrain from storing anything.  */
Jim Blandy's avatar
Jim Blandy committed
947
  if (mouse_position_hook)
Jim Blandy's avatar
Jim Blandy committed
948 949 950 951
    (*mouse_position_hook) (&f,
			    &lispy_dummy, &party_dummy,
			    &x, &y,
			    &long_dummy);
952 953 954 955
  if (! NILP (x))
    {
      col = XINT (x);
      row = XINT (y);
Karl Heuer's avatar
Karl Heuer committed
956
      pixel_to_glyph_coords (f, col, row, &col, &row, 0, 1);
957 958 959
      XSETINT (x, col);
      XSETINT (y, row);
    }
Jim Blandy's avatar
Jim Blandy committed
960
  XSET (lispy_dummy, Lisp_Frame, f);
961
  return Fcons (lispy_dummy, Fcons (x, y));
Jim Blandy's avatar
Jim Blandy committed
962 963
}

964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
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
994
DEFUN ("set-mouse-position", Fset_mouse_position, Sset_mouse_position, 3, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
995
  "Move the mouse pointer to the center of character cell (X,Y) in FRAME.\n\
996 997
WARNING:  If you use this under X windows,\n\
you should call `unfocus-frame' afterwards.")
Jim Blandy's avatar
Jim Blandy committed
998 999
  (frame, x, y)
     Lisp_Object frame, x, y;
Jim Blandy's avatar
Jim Blandy committed
1000
{
Jim Blandy's avatar
Jim Blandy committed
1001
  CHECK_LIVE_FRAME (frame, 0);
Jim Blandy's avatar
Jim Blandy committed
1002 1003 1004
  CHECK_NUMBER (x, 2);
  CHECK_NUMBER (y, 1);

Jim Blandy's avatar
Jim Blandy committed
1005
  /* I think this should be done with a hook.  */
Jim Blandy's avatar
Jim Blandy committed
1006
#ifdef HAVE_X_WINDOWS
1007
  if (FRAME_X_P (XFRAME (frame)))
Jim Blandy's avatar
Jim Blandy committed
1008
    /* Warping the mouse will cause  enternotify and focus events. */
Jim Blandy's avatar
Jim Blandy committed
1009
    x_set_mouse_position (XFRAME (frame), x, y);
Jim Blandy's avatar
Jim Blandy committed
1010 1011 1012 1013