xmenu.c 63.3 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 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62

/* This may include sys/types.h, and that somehow loses
   if this is not done before the other system files.  */
#include "xterm.h"

/* 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"

#ifdef HAVE_X11
#include "../oldXMenu/XMenu.h"
#else
#include <X/XMenu.h>
#endif

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 82 83 84 85

#ifdef HAVE_X11
extern Display *x_current_display;
#else
#define	ButtonReleaseMask ButtonReleased
#endif /* not HAVE_X11 */

86 87 88 89
/* We need a unique id for each widget handled by the Lucid Widget
   library.  This includes the frame main windows, popup menu and
   dialog box.  */
LWLIB_ID widget_id_tick;
90

91
extern Lisp_Object Qmenu_enable;
92
extern Lisp_Object Qmenu_bar;
93

94
#ifdef USE_X_TOOLKIT
95 96 97
extern void process_expose_from_menu ();
extern XtAppContext Xt_app_con;

98
static Lisp_Object xdialog_show ();
99
void popup_get_selection ();
100 101
#endif

102 103 104 105 106 107 108 109
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
110

111
   It describes the panes and items within the panes.
Jim Blandy's avatar
Jim Blandy committed
112

113 114 115 116 117
   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
118

119 120 121 122 123
   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.

124 125 126
   A single vector slot containing quote indicates that the
   following items should appear on the right of a dialog box.

127 128
   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
129

130 131 132
#define MENU_ITEMS_PANE_NAME 1
#define MENU_ITEMS_PANE_PREFIX 2
#define MENU_ITEMS_PANE_LENGTH 3
133

134 135 136 137 138
#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
139

140
static Lisp_Object menu_items;
141

142 143
/* Number of slots currently allocated in menu_items.  */
static int menu_items_allocated;
144

145 146
/* This is the index in menu_items of the first empty slot.  */
static int menu_items_used;
147

148 149
/* The number of panes currently recorded in menu_items,
   excluding those within submenus.  */
150
static int menu_items_n_panes;
151

152 153 154
/* Current depth within submenus.  */
static int menu_items_submenu_depth;

155 156 157 158 159
/* Flag which when set indicates a dialog or menu has been posted by
   Xt on behalf of one of the widget sets. */
static int popup_activated_flag;


160 161 162 163 164 165 166 167 168 169
/* 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);
170 171
    }

172 173
  menu_items_used = 0;
  menu_items_n_panes = 0;
174
  menu_items_submenu_depth = 0;
175
}
176

177 178
/* Call at the end of generating the data in menu_items.
   This fills in the number of items in the last pane.  */
179

180 181 182 183
static void
finish_menu_items ()
{
}
184

185 186
/* Call when finished using the data for the current menu
   in menu_items.  */
187

188 189 190 191 192 193 194 195 196 197 198
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;
    }
}
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 230 231 232 233 234 235 236 237 238
/* 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--;
}

239 240 241 242 243 244 245 246 247 248 249
/* 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;
}

250 251
/* Start a new menu pane in menu_items..
   NAME is the pane name.  PREFIX_VEC is a prefix key for this pane.  */
252

253 254 255 256 257
static void
push_menu_pane (name, prefix_vec)
     Lisp_Object name, prefix_vec;
{
  if (menu_items_used + MENU_ITEMS_PANE_LENGTH > menu_items_allocated)
258
    grow_menu_items ();
Jim Blandy's avatar
Jim Blandy committed
259

260 261
  if (menu_items_submenu_depth == 0)
    menu_items_n_panes++;
262 263 264 265
  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
266

267 268 269 270 271
/* 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).  */
272

273 274 275 276 277
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)
278
    grow_menu_items ();
279

280 281 282 283 284 285 286 287 288 289 290 291
  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.  */
292

293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
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;
309
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
310

311 312 313 314
  /* 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;
315

316
  def = Fcdr (item1);
317

318 319 320 321 322
  /* 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)))
323
    {
324 325 326 327
      cachelist = XCONS (def)->car;
      def = XCONS (def)->cdr;
      savedkey = XCONS (cachelist)->car;
      descrip = XCONS (cachelist)->cdr;
328
    }
329

330 331
  GCPRO4 (def, def1, savedkey, descrip);

332 333 334 335 336 337
  /* Is it still valid?  */
  def1 = Qnil;
  if (!NILP (savedkey))
    def1 = Fkey_binding (savedkey, Qnil);
  /* If not, update it.  */
  if (! EQ (def1, def)
338 339 340 341 342
      /* If the command is an alias for another
         (such as easymenu.el and lmenu.el set it up),
         check if the original command matches the cached command. */
      && !(SYMBOLP (def) && SYMBOLP (XSYMBOL (def)->function)
           && EQ (def1, XSYMBOL (def)->function))
343 344 345
      /* 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)))
346
    {
347 348 349
      changed = 1;
      descrip = Qnil;
      savedkey = Fwhere_is_internal (def, Qnil, Qt, Qnil);
350 351 352 353 354 355 356
      /* 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);

357 358 359 360 361 362 363 364 365
      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
366
    }
367

368 369
  /* 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
370 371 372 373
    {
      CHECK_IMPURE (item1);
      XCONS (item1)->cdr = Fcons (Fcons (savedkey, descrip), def);
    }
374
  else if (changed)
Jim Blandy's avatar
Jim Blandy committed
375
    {
376 377
      XCONS (cachelist)->car = savedkey;
      XCONS (cachelist)->cdr = descrip;
Jim Blandy's avatar
Jim Blandy committed
378
    }
379

380
  UNGCPRO;
381 382
  *descrip_ptr = descrip;
  return def;
383 384
}

385 386 387 388 389
/* This is used as the handler when calling internal_condition_case_1.  */

static Lisp_Object
menu_item_enabled_p_1 (arg)
     Lisp_Object arg;
390
{
391
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
392 393
}

394
/* Return non-nil if the command DEF is enabled when used as a menu item.
395 396
   This is based on looking for a menu-enable property.
   If NOTREAL is set, don't bother really computing this.  */
397 398

static Lisp_Object
399
menu_item_enabled_p (def, notreal)
400
     Lisp_Object def;
401
     int notreal;
402
{
403
  Lisp_Object enabled, tem;
404

405
  enabled = Qt;
406 407
  if (notreal)
    return enabled;
408
  if (SYMBOLP (def))
409 410 411 412 413 414 415 416 417 418 419 420 421 422
    {
      /* 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,
423 424 425
   and generate menu panes for them in menu_items.
   If NOTREAL is nonzero,
   don't bother really computing whether an item is enabled.  */
426

427
static void
428
keymap_panes (keymaps, nmaps, notreal)
429 430
     Lisp_Object *keymaps;
     int nmaps;
431
     int notreal;
432
{
433
  int mapno;
434

435
  init_menu_items ();
436

437 438 439 440
  /* 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++)
441
    single_keymap_panes (keymaps[mapno], Qnil, Qnil, notreal);
442 443 444 445 446 447 448

  finish_menu_items ();
}

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

static void
454
single_keymap_panes (keymap, pane_name, prefix, notreal)
455 456 457
     Lisp_Object keymap;
     Lisp_Object pane_name;
     Lisp_Object prefix;
458
     int notreal;
459 460 461 462 463 464 465 466 467
{
  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);

468
  for (tail = keymap; CONSP (tail); tail = XCONS (tail)->cdr)
469
    {
470 471 472
      /* Look at each key binding, and if it has a menu string,
	 make a menu item from it.  */
      item = XCONS (tail)->car;
473
      if (CONSP (item))
474
	{
475
	  item1 = XCONS (item)->cdr;
476
	  if (CONSP (item1))
477 478
	    {
	      item_string = XCONS (item1)->car;
479
	      if (STRINGP (item_string))
480 481 482 483 484 485 486 487
		{
		  /* 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;

488 489
		  /* GCPRO because ...enabled_p will call eval
		     and ..._equiv_key may autoload something.
490 491 492 493
		     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.  */
494
		  descrip = def = Qnil;
495
		  GCPRO4 (keymap, pending_maps, def, descrip);
496 497

		  def = menu_item_equiv_key (item_string, item1, &descrip);
498 499
		  enabled = menu_item_enabled_p (def, notreal);

500 501 502 503 504 505 506 507 508
		  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
509 510
		    {
		      Lisp_Object submap;
511
		      GCPRO4 (keymap, pending_maps, descrip, item_string);
512
		      submap = get_keymap_1 (def, 0, 1);
513
		      UNGCPRO;
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
#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
		    }
533 534 535
		}
	    }
	}
536
      else if (VECTORP (item))
537 538 539 540 541 542 543 544 545
	{
	  /* 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;
	      XFASTINT (character) = c;
	      item1 = XVECTOR (item)->contents[c];
546
	      if (CONSP (item1))
547 548
		{
		  item_string = XCONS (item1)->car;
549
		  if (STRINGP (item_string))
550 551 552 553 554 555 556 557
		    {
		      Lisp_Object def;

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

558 559
		      /* GCPRO because ...enabled_p will call eval
			 and ..._equiv_key may autoload something.
560 561 562 563 564
			 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);
565 566 567
		      descrip = def = Qnil;

		      def = menu_item_equiv_key (item_string, item1, &descrip);
568
		      enabled = menu_item_enabled_p (def, notreal);
569

570 571 572 573 574 575 576 577 578
		      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
579 580
			{
			  Lisp_Object submap;
581
			  GCPRO4 (keymap, pending_maps, descrip, item_string);
582
			  submap = get_keymap_1 (def, 0, 1);
583
			  UNGCPRO;
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600
#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
			}
601 602 603
		    }
		}
	    }
604 605
	}
    }
606 607 608 609

  /* Process now any submenus which want to be panes at this level.  */
  while (!NILP (pending_maps))
    {
610
      Lisp_Object elt, eltcdr, string;
611 612
      elt = Fcar (pending_maps);
      eltcdr = XCONS (elt)->cdr;
613 614 615 616 617
      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);
618 619
      pending_maps = Fcdr (pending_maps);
    }
620
}
621 622 623 624

/* 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.  */
625

626 627
static void
list_of_panes (menu)
628 629
     Lisp_Object menu;
{
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
  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))
661
	push_menu_item (item, Qnil, Qnil, Qnil);
662 663
      else if (NILP (item))
	push_left_right_boundary ();
664 665 666 667 668 669 670 671 672 673
      else
	{
	  CHECK_CONS (item, 0);
	  item1 = Fcar (item);
	  CHECK_STRING (item1, 1);
	  push_menu_item (item1, Qt, Fcdr (item), Qnil);
	}
    }
}

674
DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0,
675 676 677
  "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\
678
where XOFFSET and YOFFSET are positions in pixels from the top left\n\
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
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;
707
  Lisp_Object keymap, tem;
708 709 710 711
  int xpos, ypos;
  Lisp_Object title;
  char *error_name;
  Lisp_Object selection;
712
  int i, j;
713 714 715 716 717 718 719 720
  FRAME_PTR f;
  Lisp_Object x, y, window;
  int keymaps = 0;
  int menubarp = 0;
  struct gcpro gcpro1;

  if (! NILP (position))
    {
721 722
      check_x ();

723 724 725 726
      /* Decode the first argument: find the window and the coordinates.  */
      if (EQ (position, Qt))
	{
	  /* Use the mouse's current position.  */
727
	  FRAME_PTR new_f = 0;
728 729 730 731
	  Lisp_Object bar_window;
	  int part;
	  unsigned long time;

732 733
	  if (mouse_position_hook)
	    (*mouse_position_hook) (&new_f, &bar_window, &part, &x, &y, &time);
734 735 736 737 738 739 740 741
	  if (new_f != 0)
	    XSET (window, Lisp_Frame, new_f);
	  else
	    {
	      window = selected_window;
	      XFASTINT (x) = 0;
	      XFASTINT (y) = 0;
	    }
742 743 744 745
	}
      else
	{
	  tem = Fcar (position);
746
	  if (CONSP (tem))
747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
	    {
	      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))));
762
	      if (CONSP (tem) && EQ (Fcar (tem), Qmenu_bar))
763 764 765 766 767 768 769 770 771
		menubarp = 1;
	    }
	}

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

      /* Decode where to put the menu.  */

772
      if (FRAMEP (window))
773 774 775 776 777 778
	{
	  f = XFRAME (window);

	  xpos = 0;
	  ypos = 0;
	}
779
      else if (WINDOWP (window))
780 781 782 783 784
	{
	  CHECK_LIVE_WINDOW (window, 0);
	  f = XFRAME (WINDOW_FRAME (XWINDOW (window)));

	  xpos = (FONT_WIDTH (f->display.x->font) * XWINDOW (window)->left);
785
	  ypos = (f->display.x->line_height * XWINDOW (window)->top);
786 787 788 789 790 791 792 793 794 795 796 797 798 799
	}
      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.  */
800 801 802

  keymap = Fkeymapp (menu);
  tem = Qnil;
803
  if (CONSP (menu))
804 805 806 807 808 809 810
    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);

811
      /* Extract the detailed info to make one pane.  */
812
      keymap_panes (&menu, 1, NILP (position));
813

814 815 816 817
      /* Search for a string appearing directly as an element of the keymap.
	 That string is the title of the menu.  */
      prompt = map_prompt (keymap);

818 819 820 821 822
      /* 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;
823 824 825 826 827 828 829 830
    }
  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;
831 832

      title = Qnil;
833 834 835

      /* The first keymap that has a prompt string
	 supplies the menu title.  */
836
      for (tem = menu, i = 0; CONSP (tem); tem = Fcdr (tem))
837
	{
838 839
	  Lisp_Object prompt;

840 841 842
	  maps[i++] = keymap = get_keymap (Fcar (tem));

	  prompt = map_prompt (keymap);
843 844
	  if (NILP (title) && !NILP (prompt))
	    title = prompt;
845 846 847
	}

      /* Extract the detailed info to make one pane.  */
848
      keymap_panes (maps, nmaps, NILP (position));
849 850 851 852 853 854

      /* 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;
855 856 857 858
    }
  else
    {
      /* We were given an old-fashioned menu.  */
859 860
      title = Fcar (menu);
      CHECK_STRING (title, 1);
861

862
      list_of_panes (Fcdr (menu));
863

864 865
      keymaps = 0;
    }
866
  
867
  if (NILP (position))
868
    {
869 870 871
      discard_menu_items ();
      UNGCPRO;
      return Qnil;
872 873
    }

874 875
  /* Display them in a menu.  */
  BLOCK_INPUT;
876

877 878 879
  selection = xmenu_show (f, xpos, ypos, menubarp,
			  keymaps, title, &error_name);
  UNBLOCK_INPUT;
880

881
  discard_menu_items ();
882

883
  UNGCPRO;
884

885 886
  if (error_name) error (error_name);
  return selection;
887
}
888

889
DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 2, 0,
890
  "Pop up a dialog box and return user's selection.\n\
891 892 893 894
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\
895
\n\
896 897 898
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\
899 900 901 902 903
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.)")
904 905
  (position, contents)
     Lisp_Object position, contents;
906 907
{
  FRAME_PTR f;
908
  Lisp_Object window;
909 910 911

  check_x ();

912 913
  /* Decode the first argument: find the window or frame to use.  */
  if (EQ (position, Qt))
914
    {
915
#if 0 /* Using the frame the mouse is on may not be right.  */
916 917 918 919 920 921
      /* Use the mouse's current position.  */
      FRAME_PTR new_f = 0;
      Lisp_Object bar_window;
      int part;
      unsigned long time;
      Lisp_Object x, y;
922

923
      (*mouse_position_hook) (&new_f, &bar_window, &part, &x, &y, &time);
924

925 926 927 928
      if (new_f != 0)
	XSET (window, Lisp_Frame, new_f);
      else
	window = selected_window;
929 930 931
#endif
      /* Decode the first argument: find the window and the coordinates.  */
      if (EQ (position, Qt))
932
	window = selected_window;
933 934 935 936 937
    }
  else if (CONSP (position))
    {
      Lisp_Object tem;
      tem = Fcar (position);
938
      if (CONSP (tem))
939
	window = Fcar (Fcdr (position));
940 941
      else
	{
942 943
	  tem = Fcar (Fcdr (position));  /* EVENT_START (position) */
	  window = Fcar (tem);	     /* POSN_WINDOW (tem) */
944 945
	}
    }
946 947
  else if (WINDOWP (position) || FRAMEP (position))
    window = position;
948

949
  /* Decode where to put the menu.  */
950

951
  if (FRAMEP (window))
952
    f = XFRAME (window);
953
  else if (WINDOWP (window))
954
    {
955 956
      CHECK_LIVE_WINDOW (window, 0);
      f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
957
    }
958 959 960 961
  else
    /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
       but I don't want to make one now.  */
    CHECK_WINDOW (window, 0);
962

963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
#ifndef USE_X_TOOLKIT
  /* Display a menu with these alternatives
     in the middle of frame F.  */
  {
    Lisp_Object x, y, frame, newpos;
    XSET (frame, Lisp_Frame, f);
    XSET (x, Lisp_Int, x_pixel_width (f) / 2);
    XSET (y, Lisp_Int, x_pixel_height (f) / 2);
    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;
981

982 983 984
    /* Decode the dialog items from what was specified.  */
    title = Fcar (contents);
    CHECK_STRING (title, 1);
985

986
    list_of_panes (Fcons (contents, Qnil));
987

988 989 990 991
    /* Display them in a dialog box.  */
    BLOCK_INPUT;
    selection = xdialog_show (f, 0, 0, title, &error_name);
    UNBLOCK_INPUT;
992

993 994 995 996 997
    discard_menu_items ();

    if (error_name) error (error_name);
    return selection;
  }
998
#endif
999
}
1000 1001

#ifdef USE_X_TOOLKIT
1002

1003 1004 1005 1006 1007
/* Loop in Xt until the menu pulldown or dialog popup has been
   popped down (deactivated). */
void
popup_get_selection (initial_event)
     XEvent *initial_event;
1008
{
1009
  XEvent event;
1010

1011 1012 1013 1014
  if (initial_event)
    event = *initial_event;
  else
    XtAppNextEvent (Xt_app_con, &event);
1015

1016
  while (1)
1017
    {
1018 1019 1020 1021 1022 1023
      BLOCK_INPUT;
      XtDispatchEvent (&event);
      UNBLOCK_INPUT;
      if (!popup_activated())
	break;
      XtAppNextEvent (Xt_app_con, &event);
1024 1025 1026
    }
}

1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
/* Detect if a dialog or menu has been posted. */
int
popup_activated ()
{
  return popup_activated_flag;
}


/* This callback is invoked when the user selects a menubar cascade
   pushbutton, but before the pulldown menu is posted.  */
1037 1038

static void
1039
popup_activate_callback (widget, id, client_data)
1040 1041 1042 1043
     Widget widget;
     LWLIB_ID id;
     XtPointer client_data;
{
1044
  popup_activated_flag = 1;
1045 1046
}

1047 1048 1049 1050 1051
/* This callback is called from the menu bar pulldown menu
   when the user makes a selection.
   Figure out what the user chose
   and put the appropriate events into the keyboard buffer.  */

1052
static void
1053
menubar_selection_callback (widget, id, client_data)
1054 1055 1056 1057
     Widget widget;
     LWLIB_ID id;
     XtPointer client_data;
{