xmenu.c 61.1 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* X Communication module for terminals which understand the X protocol.
2
   Copyright (C) 1986, 1988, 1993, 1994 Free Software Foundation, Inc.
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
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 20 21 22 23 24 25 26
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.  */

/* X pop-up deck-of-cards menu facility for gnuemacs.
 *
 * Written by Jon Arnold and Roman Budzianowski
 * Mods and rewrite by Robert Krawitz
 *
 */

27 28 29
/* Modified by Fred Pierresteguy on December 93
   to make the popup menus and menubar use the Xt.  */

30 31
/* Rewritten for clarity and GC protection by rms in Feb 94.  */

Jim Blandy's avatar
Jim Blandy committed
32 33
/* On 4.3 this loses if it comes after xterm.h.  */
#include <signal.h>
34
#include <config.h>
35 36

#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
37
#include "lisp.h"
38
#include "termhooks.h"
Jim Blandy's avatar
Jim Blandy committed
39
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
40
#include "window.h"
Jim Blandy's avatar
Jim Blandy committed
41
#include "keyboard.h"
42
#include "blockinput.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
43
#include "puresize.h"
Jim Blandy's avatar
Jim Blandy committed
44

Morten Welinder's avatar
Morten Welinder committed
45
#ifdef HAVE_X_WINDOWS
Jim Blandy's avatar
Jim Blandy committed
46 47 48
/* This may include sys/types.h, and that somehow loses
   if this is not done before the other system files.  */
#include "xterm.h"
Morten Welinder's avatar
Morten Welinder committed
49
#endif
Jim Blandy's avatar
Jim Blandy committed
50 51 52 53 54 55 56 57 58

/* Load sys/types.h if not already loaded.
   In some systems loading it twice is suicidal.  */
#ifndef makedev
#include <sys/types.h>
#endif

#include "dispextern.h"

Morten Welinder's avatar
Morten Welinder committed
59
#ifdef HAVE_X_WINDOWS
Jim Blandy's avatar
Jim Blandy committed
60
#include "../oldXMenu/XMenu.h"
Morten Welinder's avatar
Morten Welinder committed
61
#endif
Jim Blandy's avatar
Jim Blandy committed
62

63 64 65 66 67
#ifdef USE_X_TOOLKIT
#include <X11/Xlib.h>
#include <X11/IntrinsicP.h>
#include <X11/CoreP.h>
#include <X11/StringDefs.h>
68
#include <X11/Shell.h>
69 70 71
#include "../lwlib/lwlib.h"
#endif /* USE_X_TOOLKIT */

Jim Blandy's avatar
Jim Blandy committed
72 73 74 75 76 77
#define min(x,y) (((x) < (y)) ? (x) : (y))
#define max(x,y) (((x) > (y)) ? (x) : (y))

#ifndef TRUE
#define TRUE 1
#define FALSE 0
78
#endif /* no TRUE */
Jim Blandy's avatar
Jim Blandy committed
79 80 81

extern Display *x_current_display;

82
extern Lisp_Object Qmenu_enable;
83
extern Lisp_Object Qmenu_bar;
84

85
#ifdef USE_X_TOOLKIT
86 87 88
extern void process_expose_from_menu ();
extern XtAppContext Xt_app_con;

89
static Lisp_Object xdialog_show ();
90
void popup_get_selection ();
91 92
#endif

93 94 95 96 97 98 99 100
static Lisp_Object xmenu_show ();
static void keymap_panes ();
static void single_keymap_panes ();
static void list_of_panes ();
static void list_of_items ();

/* This holds a Lisp vector that holds the results of decoding
   the keymaps or alist-of-alists that specify a menu.
Jim Blandy's avatar
Jim Blandy committed
101

102
   It describes the panes and items within the panes.
Jim Blandy's avatar
Jim Blandy committed
103

104 105 106 107 108
   Each pane is described by 3 elements in the vector:
   t, the pane name, the pane's prefix key.
   Then follow the pane's items, with 4 elements per item:
   the item string, the enable flag, the item's value,
   and the equivalent keyboard key's description string.
Jim Blandy's avatar
Jim Blandy committed
109

110 111 112 113 114
   In some cases, multiple levels of menus may be described.
   A single vector slot containing nil indicates the start of a submenu.
   A single vector slot containing lambda indicates the end of a submenu.
   The submenu follows a menu item which is the way to reach the submenu.

115 116 117
   A single vector slot containing quote indicates that the
   following items should appear on the right of a dialog box.

118 119
   Using a Lisp vector to hold this information while we decode it
   takes care of protecting all the data from GC.  */
Jim Blandy's avatar
Jim Blandy committed
120

121 122 123
#define MENU_ITEMS_PANE_NAME 1
#define MENU_ITEMS_PANE_PREFIX 2
#define MENU_ITEMS_PANE_LENGTH 3
124

125 126 127 128 129
#define MENU_ITEMS_ITEM_NAME 0
#define MENU_ITEMS_ITEM_ENABLE 1
#define MENU_ITEMS_ITEM_VALUE 2
#define MENU_ITEMS_ITEM_EQUIV_KEY 3
#define MENU_ITEMS_ITEM_LENGTH 4
130

131
static Lisp_Object menu_items;
132

133 134
/* Number of slots currently allocated in menu_items.  */
static int menu_items_allocated;
135

136 137
/* This is the index in menu_items of the first empty slot.  */
static int menu_items_used;
138

139 140
/* The number of panes currently recorded in menu_items,
   excluding those within submenus.  */
141
static int menu_items_n_panes;
142

143 144 145
/* Current depth within submenus.  */
static int menu_items_submenu_depth;

146
/* Flag which when set indicates a dialog or menu has been posted by
147
   Xt on behalf of one of the widget sets.  */
148 149 150
static int popup_activated_flag;


151 152 153 154 155 156 157 158 159 160
/* Initialize the menu_items structure if we haven't already done so.
   Also mark it as currently empty.  */

static void
init_menu_items ()
{
  if (NILP (menu_items))
    {
      menu_items_allocated = 60;
      menu_items = Fmake_vector (make_number (menu_items_allocated), Qnil);
161 162
    }

163 164
  menu_items_used = 0;
  menu_items_n_panes = 0;
165
  menu_items_submenu_depth = 0;
166
}
167

168 169
/* Call at the end of generating the data in menu_items.
   This fills in the number of items in the last pane.  */
170

171 172 173 174
static void
finish_menu_items ()
{
}
175

176 177
/* Call when finished using the data for the current menu
   in menu_items.  */
178

179 180 181 182 183 184 185 186 187 188 189
static void
discard_menu_items ()
{
  /* Free the structure if it is especially large.
     Otherwise, hold on to it, to save time.  */
  if (menu_items_allocated > 200)
    {
      menu_items = Qnil;
      menu_items_allocated = 0;
    }
}
190

191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
/* Make the menu_items vector twice as large.  */

static void
grow_menu_items ()
{
  Lisp_Object old;
  int old_size = menu_items_allocated;
  old = menu_items;

  menu_items_allocated *= 2;
  menu_items = Fmake_vector (make_number (menu_items_allocated), Qnil);
  bcopy (XVECTOR (old)->contents, XVECTOR (menu_items)->contents,
	 old_size * sizeof (Lisp_Object));
}

/* Begin a submenu.  */

static void
push_submenu_start ()
{
  if (menu_items_used + 1 > menu_items_allocated)
    grow_menu_items ();

  XVECTOR (menu_items)->contents[menu_items_used++] = Qnil;
  menu_items_submenu_depth++;
}

/* End a submenu.  */

static void
push_submenu_end ()
{
  if (menu_items_used + 1 > menu_items_allocated)
    grow_menu_items ();

  XVECTOR (menu_items)->contents[menu_items_used++] = Qlambda;
  menu_items_submenu_depth--;
}

230 231 232 233 234 235 236 237 238 239 240
/* Indicate boundary between left and right.  */

static void
push_left_right_boundary ()
{
  if (menu_items_used + 1 > menu_items_allocated)
    grow_menu_items ();

  XVECTOR (menu_items)->contents[menu_items_used++] = Qquote;
}

241 242
/* Start a new menu pane in menu_items..
   NAME is the pane name.  PREFIX_VEC is a prefix key for this pane.  */
243

244 245 246 247 248
static void
push_menu_pane (name, prefix_vec)
     Lisp_Object name, prefix_vec;
{
  if (menu_items_used + MENU_ITEMS_PANE_LENGTH > menu_items_allocated)
249
    grow_menu_items ();
Jim Blandy's avatar
Jim Blandy committed
250

251 252
  if (menu_items_submenu_depth == 0)
    menu_items_n_panes++;
253 254 255 256
  XVECTOR (menu_items)->contents[menu_items_used++] = Qt;
  XVECTOR (menu_items)->contents[menu_items_used++] = name;
  XVECTOR (menu_items)->contents[menu_items_used++] = prefix_vec;
}
Jim Blandy's avatar
Jim Blandy committed
257

258 259 260 261 262
/* Push one menu item into the current pane.
   NAME is the string to display.  ENABLE if non-nil means
   this item can be selected.  KEY is the key generated by
   choosing this item.  EQUIV is the textual description
   of the keyboard equivalent for this item (or nil if none).  */
263

264 265 266 267 268
static void
push_menu_item (name, enable, key, equiv)
     Lisp_Object name, enable, key, equiv;
{
  if (menu_items_used + MENU_ITEMS_ITEM_LENGTH > menu_items_allocated)
269
    grow_menu_items ();
270

271 272 273 274 275 276 277 278 279 280 281 282
  XVECTOR (menu_items)->contents[menu_items_used++] = name;
  XVECTOR (menu_items)->contents[menu_items_used++] = enable;
  XVECTOR (menu_items)->contents[menu_items_used++] = key;
  XVECTOR (menu_items)->contents[menu_items_used++] = equiv;
}

/* Figure out the current keyboard equivalent of a menu item ITEM1.
   The item string for menu display should be ITEM_STRING.
   Store the equivalent keyboard key sequence's
   textual description into *DESCRIP_PTR.
   Also cache them in the item itself.
   Return the real definition to execute.  */
283

284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
static Lisp_Object
menu_item_equiv_key (item_string, item1, descrip_ptr)
     Lisp_Object item_string;
     Lisp_Object item1;
     Lisp_Object *descrip_ptr;
{
  /* This is the real definition--the function to run.  */
  Lisp_Object def;
  /* This is the sublist that records cached equiv key data
     so we can save time.  */
  Lisp_Object cachelist;
  /* These are the saved equivalent keyboard key sequence
     and its key-description.  */
  Lisp_Object savedkey, descrip;
  Lisp_Object def1;
  int changed = 0;
300
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
301

302 303 304 305
  /* If a help string follows the item string, skip it.  */
  if (CONSP (XCONS (item1)->cdr)
      && STRINGP (XCONS (XCONS (item1)->cdr)->car))
    item1 = XCONS (item1)->cdr;
306

307
  def = Fcdr (item1);
308

309 310 311 312 313
  /* Get out the saved equivalent-keyboard-key info.  */
  cachelist = savedkey = descrip = Qnil;
  if (CONSP (def) && CONSP (XCONS (def)->car)
      && (NILP (XCONS (XCONS (def)->car)->car)
	  || VECTORP (XCONS (XCONS (def)->car)->car)))
314
    {
315 316 317 318
      cachelist = XCONS (def)->car;
      def = XCONS (def)->cdr;
      savedkey = XCONS (cachelist)->car;
      descrip = XCONS (cachelist)->cdr;
319
    }
320

321 322
  GCPRO4 (def, def1, savedkey, descrip);

323 324 325 326 327 328
  /* Is it still valid?  */
  def1 = Qnil;
  if (!NILP (savedkey))
    def1 = Fkey_binding (savedkey, Qnil);
  /* If not, update it.  */
  if (! EQ (def1, def)
329 330
      /* If the command is an alias for another
         (such as easymenu.el and lmenu.el set it up),
331
         check if the original command matches the cached command.  */
332 333
      && !(SYMBOLP (def) && SYMBOLP (XSYMBOL (def)->function)
           && EQ (def1, XSYMBOL (def)->function))
334 335 336
      /* If something had no key binding before, don't recheck it--
	 doing that takes too much time and makes menus too slow.  */
      && !(!NILP (cachelist) && NILP (savedkey)))
337
    {
338 339 340
      changed = 1;
      descrip = Qnil;
      savedkey = Fwhere_is_internal (def, Qnil, Qt, Qnil);
341 342 343 344 345 346 347
      /* If the command is an alias for another
	 (such as easymenu.el and lmenu.el set it up),
	 see if the original command name has equivalent keys.  */
      if (SYMBOLP (def) && SYMBOLP (XSYMBOL (def)->function))
	savedkey = Fwhere_is_internal (XSYMBOL (def)->function,
				       Qnil, Qt, Qnil);

348 349 350 351 352 353 354 355 356
      if (VECTORP (savedkey)
	  && EQ (XVECTOR (savedkey)->contents[0], Qmenu_bar))
	savedkey = Qnil;
      if (!NILP (savedkey))
	{
	  descrip = Fkey_description (savedkey);
	  descrip = concat2 (make_string ("  (", 3), descrip);
	  descrip = concat2 (descrip, make_string (")", 1));
	}
Jim Blandy's avatar
Jim Blandy committed
357
    }
358

359 360
  /* Cache the data we just got in a sublist of the menu binding.  */
  if (NILP (cachelist))
Richard M. Stallman's avatar
Richard M. Stallman committed
361 362 363 364
    {
      CHECK_IMPURE (item1);
      XCONS (item1)->cdr = Fcons (Fcons (savedkey, descrip), def);
    }
365
  else if (changed)
Jim Blandy's avatar
Jim Blandy committed
366
    {
367 368
      XCONS (cachelist)->car = savedkey;
      XCONS (cachelist)->cdr = descrip;
Jim Blandy's avatar
Jim Blandy committed
369
    }
370

371
  UNGCPRO;
372 373
  *descrip_ptr = descrip;
  return def;
374 375
}

376 377 378 379 380
/* This is used as the handler when calling internal_condition_case_1.  */

static Lisp_Object
menu_item_enabled_p_1 (arg)
     Lisp_Object arg;
381
{
382
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
383 384
}

385
/* Return non-nil if the command DEF is enabled when used as a menu item.
386 387
   This is based on looking for a menu-enable property.
   If NOTREAL is set, don't bother really computing this.  */
388 389

static Lisp_Object
390
menu_item_enabled_p (def, notreal)
391
     Lisp_Object def;
392
     int notreal;
393
{
394
  Lisp_Object enabled, tem;
395

396
  enabled = Qt;
397 398
  if (notreal)
    return enabled;
399
  if (SYMBOLP (def))
400 401 402 403 404 405 406 407 408 409 410 411 412 413
    {
      /* No property, or nil, means enable.
	 Otherwise, enable if value is not nil.  */
      tem = Fget (def, Qmenu_enable);
      if (!NILP (tem))
	/* (condition-case nil (eval tem)
	   (error nil))  */
	enabled = internal_condition_case_1 (Feval, tem, Qerror,
					     menu_item_enabled_p_1);
    }
  return enabled;
}

/* Look through KEYMAPS, a vector of keymaps that is NMAPS long,
414 415 416
   and generate menu panes for them in menu_items.
   If NOTREAL is nonzero,
   don't bother really computing whether an item is enabled.  */
417

418
static void
419
keymap_panes (keymaps, nmaps, notreal)
420 421
     Lisp_Object *keymaps;
     int nmaps;
422
     int notreal;
423
{
424
  int mapno;
425

426
  init_menu_items ();
427

428 429 430 431
  /* Loop over the given keymaps, making a pane for each map.
     But don't make a pane that is empty--ignore that map instead.
     P is the number of panes we have made so far.  */
  for (mapno = 0; mapno < nmaps; mapno++)
432
    single_keymap_panes (keymaps[mapno], Qnil, Qnil, notreal);
433 434 435 436 437 438 439

  finish_menu_items ();
}

/* This is a recursive subroutine of keymap_panes.
   It handles one keymap, KEYMAP.
   The other arguments are passed along
440 441 442
   or point to local variables of the previous function.
   If NOTREAL is nonzero,
   don't bother really computing whether an item is enabled.  */
443 444

static void
445
single_keymap_panes (keymap, pane_name, prefix, notreal)
446 447 448
     Lisp_Object keymap;
     Lisp_Object pane_name;
     Lisp_Object prefix;
449
     int notreal;
450 451 452 453 454 455 456 457 458
{
  Lisp_Object pending_maps;
  Lisp_Object tail, item, item1, item_string, table;
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;

  pending_maps = Qnil;

  push_menu_pane (pane_name, prefix);

459
  for (tail = keymap; CONSP (tail); tail = XCONS (tail)->cdr)
460
    {
461 462 463
      /* Look at each key binding, and if it has a menu string,
	 make a menu item from it.  */
      item = XCONS (tail)->car;
464
      if (CONSP (item))
465
	{
466
	  item1 = XCONS (item)->cdr;
467
	  if (CONSP (item1))
468 469
	    {
	      item_string = XCONS (item1)->car;
470
	      if (STRINGP (item_string))
471 472 473 474 475 476 477 478
		{
		  /* This is the real definition--the function to run.  */
		  Lisp_Object def;
		  /* These are the saved equivalent keyboard key sequence
		     and its key-description.  */
		  Lisp_Object descrip;
		  Lisp_Object tem, enabled;

479 480
		  /* GCPRO because ...enabled_p will call eval
		     and ..._equiv_key may autoload something.
481 482 483 484
		     Protecting KEYMAP preserves everything we use;
		     aside from that, must protect whatever might be
		     a string.  Since there's no GCPRO5, we refetch
		     item_string instead of protecting it.  */
485
		  descrip = def = Qnil;
486
		  GCPRO4 (keymap, pending_maps, def, descrip);
487 488

		  def = menu_item_equiv_key (item_string, item1, &descrip);
489 490
		  enabled = menu_item_enabled_p (def, notreal);

491 492 493 494 495 496 497 498 499
		  UNGCPRO;

		  item_string = XCONS (item1)->car;

		  tem = Fkeymapp (def);
		  if (XSTRING (item_string)->data[0] == '@' && !NILP (tem))
		    pending_maps = Fcons (Fcons (def, Fcons (item_string, XCONS (item)->car)),
					  pending_maps);
		  else
500 501
		    {
		      Lisp_Object submap;
502
		      GCPRO4 (keymap, pending_maps, descrip, item_string);
503
		      submap = get_keymap_1 (def, 0, 1);
504
		      UNGCPRO;
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
#ifndef USE_X_TOOLKIT
		      /* Indicate visually that this is a submenu.  */
		      if (!NILP (submap))
			item_string = concat2 (item_string,
					       build_string (" >"));
#endif
		      push_menu_item (item_string, enabled, XCONS (item)->car,
				      descrip);
#ifdef USE_X_TOOLKIT
		      /* Display a submenu using the toolkit.  */
		      if (! NILP (submap))
			{
			  push_submenu_start ();
			  single_keymap_panes (submap, Qnil,
					       XCONS (item)->car, notreal);
			  push_submenu_end ();
			}
#endif
		    }
524 525 526
		}
	    }
	}
527
      else if (VECTORP (item))
528 529 530 531 532 533 534
	{
	  /* Loop over the char values represented in the vector.  */
	  int len = XVECTOR (item)->size;
	  int c;
	  for (c = 0; c < len; c++)
	    {
	      Lisp_Object character;
535
	      XSETFASTINT (character, c);
536
	      item1 = XVECTOR (item)->contents[c];
537
	      if (CONSP (item1))
538 539
		{
		  item_string = XCONS (item1)->car;
540
		  if (STRINGP (item_string))
541 542 543 544 545 546 547 548
		    {
		      Lisp_Object def;

		      /* These are the saved equivalent keyboard key sequence
			 and its key-description.  */
		      Lisp_Object descrip;
		      Lisp_Object tem, enabled;

549 550
		      /* GCPRO because ...enabled_p will call eval
			 and ..._equiv_key may autoload something.
551 552 553 554 555
			 Protecting KEYMAP preserves everything we use;
			 aside from that, must protect whatever might be
			 a string.  Since there's no GCPRO5, we refetch
			 item_string instead of protecting it.  */
		      GCPRO4 (keymap, pending_maps, def, descrip);
556 557 558
		      descrip = def = Qnil;

		      def = menu_item_equiv_key (item_string, item1, &descrip);
559
		      enabled = menu_item_enabled_p (def, notreal);
560

561 562 563 564 565 566 567 568 569
		      UNGCPRO;

		      item_string = XCONS (item1)->car;

		      tem = Fkeymapp (def);
		      if (XSTRING (item_string)->data[0] == '@' && !NILP (tem))
			pending_maps = Fcons (Fcons (def, Fcons (item_string, character)),
					      pending_maps);
		      else
570 571
			{
			  Lisp_Object submap;
572
			  GCPRO4 (keymap, pending_maps, descrip, item_string);
573
			  submap = get_keymap_1 (def, 0, 1);
574
			  UNGCPRO;
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
#ifndef USE_X_TOOLKIT
			  if (!NILP (submap))
			    item_string = concat2 (item_string,
						   build_string (" >"));
#endif
			  push_menu_item (item_string, enabled, character,
					  descrip);
#ifdef USE_X_TOOLKIT
			  if (! NILP (submap))
			    {
			      push_submenu_start ();
			      single_keymap_panes (submap, Qnil,
						   character, notreal);
			      push_submenu_end ();
			    }
#endif
			}
592 593 594
		    }
		}
	    }
595 596
	}
    }
597 598 599 600

  /* Process now any submenus which want to be panes at this level.  */
  while (!NILP (pending_maps))
    {
601
      Lisp_Object elt, eltcdr, string;
602 603
      elt = Fcar (pending_maps);
      eltcdr = XCONS (elt)->cdr;
604 605 606 607 608
      string = XCONS (eltcdr)->car;
      /* We no longer discard the @ from the beginning of the string here.
	 Instead, we do this in xmenu_show.  */
      single_keymap_panes (Fcar (elt), string,
			   XCONS (eltcdr)->cdr, notreal);
609 610
      pending_maps = Fcdr (pending_maps);
    }
611
}
612 613 614 615

/* Push all the panes and items of a menu decsribed by the
   alist-of-alists MENU.
   This handles old-fashioned calls to x-popup-menu.  */
616

617 618
static void
list_of_panes (menu)
619 620
     Lisp_Object menu;
{
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
  Lisp_Object tail;

  init_menu_items ();

  for (tail = menu; !NILP (tail); tail = Fcdr (tail))
    {
      Lisp_Object elt, pane_name, pane_data;
      elt = Fcar (tail);
      pane_name = Fcar (elt);
      CHECK_STRING (pane_name, 0);
      push_menu_pane (pane_name, Qnil);
      pane_data = Fcdr (elt);
      CHECK_CONS (pane_data, 0);
      list_of_items (pane_data);
    }

  finish_menu_items ();
}

/* Push the items in a single pane defined by the alist PANE.  */

static void
list_of_items (pane)
     Lisp_Object pane;
{
  Lisp_Object tail, item, item1;

  for (tail = pane; !NILP (tail); tail = Fcdr (tail))
    {
      item = Fcar (tail);
      if (STRINGP (item))
652
	push_menu_item (item, Qnil, Qnil, Qnil);
653 654
      else if (NILP (item))
	push_left_right_boundary ();
655 656 657 658 659 660 661 662 663 664
      else
	{
	  CHECK_CONS (item, 0);
	  item1 = Fcar (item);
	  CHECK_STRING (item1, 1);
	  push_menu_item (item1, Qt, Fcdr (item), Qnil);
	}
    }
}

665
DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0,
666 667 668
  "Pop up a deck-of-cards menu and return user's selection.\n\
POSITION is a position specification.  This is either a mouse button event\n\
or a list ((XOFFSET YOFFSET) WINDOW)\n\
669
where XOFFSET and YOFFSET are positions in pixels from the top left\n\
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
corner of WINDOW's frame.  (WINDOW may be a frame object instead of a window.)\n\
This controls the position of the center of the first line\n\
in the first pane of the menu, not the top left of the menu as a whole.\n\
If POSITION is t, it means to use the current mouse position.\n\
\n\
MENU is a specifier for a menu.  For the simplest case, MENU is a keymap.\n\
The menu items come from key bindings that have a menu string as well as\n\
a definition; actually, the \"definition\" in such a key binding looks like\n\
\(STRING . REAL-DEFINITION).  To give the menu a title, put a string into\n\
the keymap as a top-level element.\n\n\
You can also use a list of keymaps as MENU.\n\
  Then each keymap makes a separate pane.\n\
When MENU is a keymap or a list of keymaps, the return value\n\
is a list of events.\n\n\
Alternatively, you can specify a menu of multiple panes\n\
  with a list of the form (TITLE PANE1 PANE2...),\n\
where each pane is a list of form (TITLE ITEM1 ITEM2...).\n\
Each ITEM is normally a cons cell (STRING . VALUE);\n\
but a string can appear as an item--that makes a nonselectable line\n\
in the menu.\n\
With this form of menu, the return value is VALUE from the chosen item.\n\
\n\
If POSITION is nil, don't display the menu at all, just precalculate the\n\
cached information about equivalent key sequences.")
  (position, menu)
     Lisp_Object position, menu;
{
  int number_of_panes, panes;
698
  Lisp_Object keymap, tem;
699 700 701 702
  int xpos, ypos;
  Lisp_Object title;
  char *error_name;
  Lisp_Object selection;
703
  int i, j;
704 705 706 707 708 709 710 711
  FRAME_PTR f;
  Lisp_Object x, y, window;
  int keymaps = 0;
  int menubarp = 0;
  struct gcpro gcpro1;

  if (! NILP (position))
    {
712 713
      check_x ();

714 715 716 717
      /* Decode the first argument: find the window and the coordinates.  */
      if (EQ (position, Qt))
	{
	  /* Use the mouse's current position.  */
718
	  FRAME_PTR new_f = 0;
719 720 721 722
	  Lisp_Object bar_window;
	  int part;
	  unsigned long time;

723 724
	  if (mouse_position_hook)
	    (*mouse_position_hook) (&new_f, &bar_window, &part, &x, &y, &time);
725
	  if (new_f != 0)
726
	    XSETFRAME (window, new_f);
727 728 729
	  else
	    {
	      window = selected_window;
730 731
	      XSETFASTINT (x, 0);
	      XSETFASTINT (y, 0);
732
	    }
733 734 735 736
	}
      else
	{
	  tem = Fcar (position);
737
	  if (CONSP (tem))
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
	    {
	      window = Fcar (Fcdr (position));
	      x = Fcar (tem);
	      y = Fcar (Fcdr (tem));
	    }
	  else
	    {
	      tem = Fcar (Fcdr (position));  /* EVENT_START (position) */
	      window = Fcar (tem);	     /* POSN_WINDOW (tem) */
	      tem = Fcar (Fcdr (Fcdr (tem))); /* POSN_WINDOW_POSN (tem) */
	      x = Fcar (tem);
	      y = Fcdr (tem);

	      /* Determine whether this menu is handling a menu bar click.  */
	      tem = Fcar (Fcdr (Fcar (Fcdr (position))));
753
	      if (CONSP (tem) && EQ (Fcar (tem), Qmenu_bar))
754 755 756 757 758 759 760 761 762
		menubarp = 1;
	    }
	}

      CHECK_NUMBER (x, 0);
      CHECK_NUMBER (y, 0);

      /* Decode where to put the menu.  */

763
      if (FRAMEP (window))
764 765 766 767 768
	{
	  f = XFRAME (window);
	  xpos = 0;
	  ypos = 0;
	}
769
      else if (WINDOWP (window))
770 771 772 773 774
	{
	  CHECK_LIVE_WINDOW (window, 0);
	  f = XFRAME (WINDOW_FRAME (XWINDOW (window)));

	  xpos = (FONT_WIDTH (f->display.x->font) * XWINDOW (window)->left);
775
	  ypos = (f->display.x->line_height * XWINDOW (window)->top);
776 777 778 779 780 781 782 783 784 785 786 787 788 789
	}
      else
	/* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
	   but I don't want to make one now.  */
	CHECK_WINDOW (window, 0);

      xpos += XINT (x);
      ypos += XINT (y);
    }

  title = Qnil;
  GCPRO1 (title);

  /* Decode the menu items from what was specified.  */
790 791 792

  keymap = Fkeymapp (menu);
  tem = Qnil;
793
  if (CONSP (menu))
794 795 796 797 798 799 800
    tem = Fkeymapp (Fcar (menu));
  if (!NILP (keymap))
    {
      /* We were given a keymap.  Extract menu info from the keymap.  */
      Lisp_Object prompt;
      keymap = get_keymap (menu);

801
      /* Extract the detailed info to make one pane.  */
802
      keymap_panes (&menu, 1, NILP (position));
803

804 805 806 807
      /* Search for a string appearing directly as an element of the keymap.
	 That string is the title of the menu.  */
      prompt = map_prompt (keymap);

808 809 810 811 812
      /* Make that be the pane title of the first pane.  */
      if (!NILP (prompt) && menu_items_n_panes >= 0)
	XVECTOR (menu_items)->contents[MENU_ITEMS_PANE_NAME] = prompt;

      keymaps = 1;
813 814 815 816 817 818 819 820
    }
  else if (!NILP (tem))
    {
      /* We were given a list of keymaps.  */
      int nmaps = XFASTINT (Flength (menu));
      Lisp_Object *maps
	= (Lisp_Object *) alloca (nmaps * sizeof (Lisp_Object));
      int i;
821 822

      title = Qnil;
823 824 825

      /* The first keymap that has a prompt string
	 supplies the menu title.  */
826
      for (tem = menu, i = 0; CONSP (tem); tem = Fcdr (tem))
827
	{
828 829
	  Lisp_Object prompt;

830 831 832
	  maps[i++] = keymap = get_keymap (Fcar (tem));

	  prompt = map_prompt (keymap);
833 834
	  if (NILP (title) && !NILP (prompt))
	    title = prompt;
835 836 837
	}

      /* Extract the detailed info to make one pane.  */
838
      keymap_panes (maps, nmaps, NILP (position));
839 840 841 842 843 844

      /* Make the title be the pane title of the first pane.  */
      if (!NILP (title) && menu_items_n_panes >= 0)
	XVECTOR (menu_items)->contents[MENU_ITEMS_PANE_NAME] = title;

      keymaps = 1;
845 846 847 848
    }
  else
    {
      /* We were given an old-fashioned menu.  */
849 850
      title = Fcar (menu);
      CHECK_STRING (title, 1);
851

852
      list_of_panes (Fcdr (menu));
853

854 855
      keymaps = 0;
    }
856
  
857
  if (NILP (position))
858
    {
859 860 861
      discard_menu_items ();
      UNGCPRO;
      return Qnil;
862 863
    }

864 865
  /* Display them in a menu.  */
  BLOCK_INPUT;
866

867 868 869
  selection = xmenu_show (f, xpos, ypos, menubarp,
			  keymaps, title, &error_name);
  UNBLOCK_INPUT;
870

871
  discard_menu_items ();
872

873
  UNGCPRO;
874

875 876
  if (error_name) error (error_name);
  return selection;
877
}
878

879
DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 2, 0,
880
  "Pop up a dialog box and return user's selection.\n\
881 882 883 884
POSITION specifies which frame to use.\n\
This is normally a mouse button event or a window or frame.\n\
If POSITION is t, it means to use the frame the mouse is on.\n\
The dialog box appears in the middle of the specified frame.\n\
885
\n\
886 887 888
CONTENTS specifies the alternatives to display in the dialog box.\n\
It is a list of the form (TITLE ITEM1 ITEM2...).\n\
Each ITEM is a cons cell (STRING . VALUE).\n\
889 890 891 892 893
The return value is VALUE from the chosen item.\n\n\
An ITEM may also be just a string--that makes a nonselectable item.\n\
An ITEM may also be nil--that means to put all preceding items\n\
on the left of the dialog box and all following items on the right.\n\
\(By default, approximately half appear on each side.)")
894 895
  (position, contents)
     Lisp_Object position, contents;
896 897
{
  FRAME_PTR f;
898
  Lisp_Object window;
899 900 901

  check_x ();

902 903
  /* Decode the first argument: find the window or frame to use.  */
  if (EQ (position, Qt))
904
    {
905
#if 0 /* Using the frame the mouse is on may not be right.  */
906 907 908 909 910 911
      /* Use the mouse's current position.  */
      FRAME_PTR new_f = 0;
      Lisp_Object bar_window;
      int part;
      unsigned long time;
      Lisp_Object x, y;
912

913
      (*mouse_position_hook) (&new_f, &bar_window, &part, &x, &y, &time);
914

915
      if (new_f != 0)
916
	XSETFRAME (window, new_f);
917 918
      else
	window = selected_window;
919 920 921
#endif
      /* Decode the first argument: find the window and the coordinates.  */
      if (EQ (position, Qt))
922
	window = selected_window;
923 924 925 926 927
    }
  else if (CONSP (position))
    {
      Lisp_Object tem;
      tem = Fcar (position);
928
      if (CONSP (tem))
929
	window = Fcar (Fcdr (position));
930 931
      else
	{
932 933
	  tem = Fcar (Fcdr (position));  /* EVENT_START (position) */
	  window = Fcar (tem);	     /* POSN_WINDOW (tem) */
934 935
	}
    }
936 937
  else if (WINDOWP (position) || FRAMEP (position))
    window = position;
938

939
  /* Decode where to put the menu.  */
940

941
  if (FRAMEP (window))
942
    f = XFRAME (window);
943
  else if (WINDOWP (window))
944
    {
945 946
      CHECK_LIVE_WINDOW (window, 0);
      f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
947
    }
948 949 950 951
  else
    /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
       but I don't want to make one now.  */
    CHECK_WINDOW (window, 0);
952

953 954 955 956 957
#ifndef USE_X_TOOLKIT
  /* Display a menu with these alternatives
     in the middle of frame F.  */
  {
    Lisp_Object x, y, frame, newpos;
958 959 960
    XSETFRAME (frame, f);
    XSETINT (x, x_pixel_width (f) / 2);
    XSETINT (y, x_pixel_height (f) / 2);
961 962 963 964 965 966 967 968 969 970
    newpos = Fcons (Fcons (x, Fcons (y, Qnil)), Fcons (frame, Qnil));

    return Fx_popup_menu (newpos,
			  Fcons (Fcar (contents), Fcons (contents, Qnil)));
  }
#else
  {
    Lisp_Object title;
    char *error_name;
    Lisp_Object selection;
971

972 973 974
    /* Decode the dialog items from what was specified.  */
    title = Fcar (contents);
    CHECK_STRING (title, 1);
975

976
    list_of_panes (Fcons (contents, Qnil));
977

978 979 980 981
    /* Display them in a dialog box.  */
    BLOCK_INPUT;
    selection = xdialog_show (f, 0, 0, title, &error_name);
    UNBLOCK_INPUT;
982

983 984 985 986 987
    discard_menu_items ();

    if (error_name) error (error_name);
    return selection;
  }
988
#endif
989
}
990 991

#ifdef USE_X_TOOLKIT
992

993
/* Loop in Xt until the menu pulldown or dialog popup has been
994 995 996 997
   popped down (deactivated).

   NOTE: All calls to popup_get_selection() should be protected
   with BLOCK_INPUT, UNBLOCK_INPUT wrappers.  */
998 999 1000
void
popup_get_selection (initial_event)
     XEvent *initial_event;
1001
{
1002
  XEvent event;
1003

1004 1005 1006 1007
  if (initial_event)
    event = *initial_event;
  else
    XtAppNextEvent (Xt_app_con, &event);
1008

1009
  while (1)
1010
    {
1011 1012 1013 1014
      XtDispatchEvent (&event);
      if (!popup_activated())
	break;
      XtAppNextEvent (Xt_app_con, &event);