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 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
extern Lisp_Object Qmenu_enable;
87
extern Lisp_Object Qmenu_bar;
88

89
#ifdef USE_X_TOOLKIT
90 91 92
extern void process_expose_from_menu ();
extern XtAppContext Xt_app_con;

93
static Lisp_Object xdialog_show ();
94
void popup_get_selection ();
95 96
#endif

97 98 99 100 101 102 103 104
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
105

106
   It describes the panes and items within the panes.
Jim Blandy's avatar
Jim Blandy committed
107

108 109 110 111 112
   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
113

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

119 120 121
   A single vector slot containing quote indicates that the
   following items should appear on the right of a dialog box.

122 123
   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
124

125 126 127
#define MENU_ITEMS_PANE_NAME 1
#define MENU_ITEMS_PANE_PREFIX 2
#define MENU_ITEMS_PANE_LENGTH 3
128

129 130 131 132 133
#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
134

135
static Lisp_Object menu_items;
136

137 138
/* Number of slots currently allocated in menu_items.  */
static int menu_items_allocated;
139

140 141
/* This is the index in menu_items of the first empty slot.  */
static int menu_items_used;
142

143 144
/* The number of panes currently recorded in menu_items,
   excluding those within submenus.  */
145
static int menu_items_n_panes;
146

147 148 149
/* Current depth within submenus.  */
static int menu_items_submenu_depth;

150
/* Flag which when set indicates a dialog or menu has been posted by
151
   Xt on behalf of one of the widget sets.  */
152 153 154
static int popup_activated_flag;


155 156 157 158 159 160 161 162 163 164
/* 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);
165 166
    }

167 168
  menu_items_used = 0;
  menu_items_n_panes = 0;
169
  menu_items_submenu_depth = 0;
170
}
171

172 173
/* Call at the end of generating the data in menu_items.
   This fills in the number of items in the last pane.  */
174

175 176 177 178
static void
finish_menu_items ()
{
}
179

180 181
/* Call when finished using the data for the current menu
   in menu_items.  */
182

183 184 185 186 187 188 189 190 191 192 193
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;
    }
}
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 230 231 232 233
/* 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--;
}

234 235 236 237 238 239 240 241 242 243 244
/* 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;
}

245 246
/* Start a new menu pane in menu_items..
   NAME is the pane name.  PREFIX_VEC is a prefix key for this pane.  */
247

248 249 250 251 252
static void
push_menu_pane (name, prefix_vec)
     Lisp_Object name, prefix_vec;
{
  if (menu_items_used + MENU_ITEMS_PANE_LENGTH > menu_items_allocated)
253
    grow_menu_items ();
Jim Blandy's avatar
Jim Blandy committed
254

255 256
  if (menu_items_submenu_depth == 0)
    menu_items_n_panes++;
257 258 259 260
  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
261

262 263 264 265 266
/* 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).  */
267

268 269 270 271 272
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)
273
    grow_menu_items ();
274

275 276 277 278 279 280 281 282 283 284 285 286
  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.  */
287

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
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;
304
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
305

306 307 308 309
  /* 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;
310

311
  def = Fcdr (item1);
312

313 314 315 316 317
  /* 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)))
318
    {
319 320 321 322
      cachelist = XCONS (def)->car;
      def = XCONS (def)->cdr;
      savedkey = XCONS (cachelist)->car;
      descrip = XCONS (cachelist)->cdr;
323
    }
324

325 326
  GCPRO4 (def, def1, savedkey, descrip);

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

352 353 354 355 356 357 358 359 360
      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
361
    }
362

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

375
  UNGCPRO;
376 377
  *descrip_ptr = descrip;
  return def;
378 379
}

380 381 382 383 384
/* This is used as the handler when calling internal_condition_case_1.  */

static Lisp_Object
menu_item_enabled_p_1 (arg)
     Lisp_Object arg;
385
{
386
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
387 388
}

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

static Lisp_Object
394
menu_item_enabled_p (def, notreal)
395
     Lisp_Object def;
396
     int notreal;
397
{
398
  Lisp_Object enabled, tem;
399

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

422
static void
423
keymap_panes (keymaps, nmaps, notreal)
424 425
     Lisp_Object *keymaps;
     int nmaps;
426
     int notreal;
427
{
428
  int mapno;
429

430
  init_menu_items ();
431

432 433 434 435
  /* 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++)
436
    single_keymap_panes (keymaps[mapno], Qnil, Qnil, notreal);
437 438 439 440 441 442 443

  finish_menu_items ();
}

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

static void
449
single_keymap_panes (keymap, pane_name, prefix, notreal)
450 451 452
     Lisp_Object keymap;
     Lisp_Object pane_name;
     Lisp_Object prefix;
453
     int notreal;
454 455 456 457 458 459 460 461 462
{
  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);

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

483 484
		  /* GCPRO because ...enabled_p will call eval
		     and ..._equiv_key may autoload something.
485 486 487 488
		     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.  */
489
		  descrip = def = Qnil;
490
		  GCPRO4 (keymap, pending_maps, def, descrip);
491 492

		  def = menu_item_equiv_key (item_string, item1, &descrip);
493 494
		  enabled = menu_item_enabled_p (def, notreal);

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

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

553 554
		      /* GCPRO because ...enabled_p will call eval
			 and ..._equiv_key may autoload something.
555 556 557 558 559
			 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);
560 561 562
		      descrip = def = Qnil;

		      def = menu_item_equiv_key (item_string, item1, &descrip);
563
		      enabled = menu_item_enabled_p (def, notreal);
564

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

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

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

  if (! NILP (position))
    {
716 717
      check_x ();

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

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

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

      /* Decode where to put the menu.  */

767
      if (FRAMEP (window))
768 769 770 771 772 773
	{
	  f = XFRAME (window);

	  xpos = 0;
	  ypos = 0;
	}
774
      else if (WINDOWP (window))
775 776 777 778 779
	{
	  CHECK_LIVE_WINDOW (window, 0);
	  f = XFRAME (WINDOW_FRAME (XWINDOW (window)));

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

  keymap = Fkeymapp (menu);
  tem = Qnil;
798
  if (CONSP (menu))
799 800 801 802 803 804 805
    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);

806
      /* Extract the detailed info to make one pane.  */
807
      keymap_panes (&menu, 1, NILP (position));
808

809 810 811 812
      /* Search for a string appearing directly as an element of the keymap.
	 That string is the title of the menu.  */
      prompt = map_prompt (keymap);

813 814 815 816 817
      /* 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;
818 819 820 821 822 823 824 825
    }
  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;
826 827

      title = Qnil;
828 829 830

      /* The first keymap that has a prompt string
	 supplies the menu title.  */
831
      for (tem = menu, i = 0; CONSP (tem); tem = Fcdr (tem))
832
	{
833 834
	  Lisp_Object prompt;

835 836 837
	  maps[i++] = keymap = get_keymap (Fcar (tem));

	  prompt = map_prompt (keymap);
838 839
	  if (NILP (title) && !NILP (prompt))
	    title = prompt;
840 841 842
	}

      /* Extract the detailed info to make one pane.  */
843
      keymap_panes (maps, nmaps, NILP (position));
844 845 846 847 848 849

      /* 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;
850 851 852 853
    }
  else
    {
      /* We were given an old-fashioned menu.  */
854 855
      title = Fcar (menu);
      CHECK_STRING (title, 1);
856

857
      list_of_panes (Fcdr (menu));
858

859 860
      keymaps = 0;
    }
861
  
862
  if (NILP (position))
863
    {
864 865 866
      discard_menu_items ();
      UNGCPRO;
      return Qnil;
867 868
    }

869 870
  /* Display them in a menu.  */
  BLOCK_INPUT;
871

872 873 874
  selection = xmenu_show (f, xpos, ypos, menubarp,
			  keymaps, title, &error_name);
  UNBLOCK_INPUT;
875

876
  discard_menu_items ();
877

878
  UNGCPRO;
879

880 881
  if (error_name) error (error_name);
  return selection;
882
}
883

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

  check_x ();

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

918
      (*mouse_position_hook) (&new_f, &bar_window, &part, &x, &y, &time);
919

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

944
  /* Decode where to put the menu.  */
945

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

958 959 960 961 962
#ifndef USE_X_TOOLKIT
  /* Display a menu with these alternatives
     in the middle of frame F.  */
  {
    Lisp_Object x, y, frame, newpos;
963 964 965
    XSETFRAME (frame, f);
    XSETINT (x, x_pixel_width (f) / 2);
    XSETINT (y, x_pixel_height (f) / 2);
966 967 968 969 970 971 972 973 974 975
    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;
976

977 978 979
    /* Decode the dialog items from what was specified.  */
    title = Fcar (contents);
    CHECK_STRING (title, 1);
980

981
    list_of_panes (Fcons (contents, Qnil));
982

983 984 985 986
    /* Display them in a dialog box.  */
    BLOCK_INPUT;
    selection = xdialog_show (f, 0, 0, title, &error_name);
    UNBLOCK_INPUT;
987

988 989 990 991 992
    discard_menu_items ();

    if (error_name) error (error_name);
    return selection;
  }
993
#endif
994
}
995 996

#ifdef USE_X_TOOLKIT
997

998
/* Loop in Xt until the menu pulldown or dialog popup has been
999 1000 1001 1002
   popped down (deactivated).

   NOTE: All calls to popup_get_selection() should be protected
   with BLOCK_INPUT, UNBLOCK_INPUT wrappers.  */
1003 1004 1005
void
popup_get_selection (initial_event)
     XEvent *initial_event;
1006
{
1007
  XEvent event;
1008

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

1014
  while (1)
1015
    {
1016 1017 1018 1019
      XtDispatchEvent (&event);
      if (!popup_activated())
	break;
      XtAppNextEvent (Xt_app_con, &event);
1020 1021 1022
    }
}

1023
/* Detect if a dialog or menu has been posted.  */
1024 1025 1026 1027 1028 1029 1030 1031 1032
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.  */
1033 1034

static void
1035
popup_activate_callback (widget, id, client_data)
1036 1037 1038 1039
     Widget widget;
     LWLIB_ID id;
     XtPointer client_data;
{