xmenu.c 60.9 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

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

#include "../oldXMenu/XMenu.h"

59 60 61 62 63
#ifdef USE_X_TOOLKIT
#include <X11/Xlib.h>
#include <X11/IntrinsicP.h>
#include <X11/CoreP.h>
#include <X11/StringDefs.h>
64
#include <X11/Shell.h>
65 66 67
#include "../lwlib/lwlib.h"
#endif /* USE_X_TOOLKIT */

Jim Blandy's avatar
Jim Blandy committed
68 69 70 71 72 73
#define min(x,y) (((x) < (y)) ? (x) : (y))
#define max(x,y) (((x) > (y)) ? (x) : (y))

#ifndef TRUE
#define TRUE 1
#define FALSE 0
74
#endif /* no TRUE */
Jim Blandy's avatar
Jim Blandy committed
75 76 77

extern Display *x_current_display;

78
extern Lisp_Object Qmenu_enable;
79
extern Lisp_Object Qmenu_bar;
80

81
#ifdef USE_X_TOOLKIT
82 83 84
extern void process_expose_from_menu ();
extern XtAppContext Xt_app_con;

85
static Lisp_Object xdialog_show ();
86
void popup_get_selection ();
87 88
#endif

89 90 91 92 93 94 95 96
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
97

98
   It describes the panes and items within the panes.
Jim Blandy's avatar
Jim Blandy committed
99

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

106 107 108 109 110
   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.

111 112 113
   A single vector slot containing quote indicates that the
   following items should appear on the right of a dialog box.

114 115
   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
116

117 118 119
#define MENU_ITEMS_PANE_NAME 1
#define MENU_ITEMS_PANE_PREFIX 2
#define MENU_ITEMS_PANE_LENGTH 3
120

121 122 123 124 125
#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
126

127
static Lisp_Object menu_items;
128

129 130
/* Number of slots currently allocated in menu_items.  */
static int menu_items_allocated;
131

132 133
/* This is the index in menu_items of the first empty slot.  */
static int menu_items_used;
134

135 136
/* The number of panes currently recorded in menu_items,
   excluding those within submenus.  */
137
static int menu_items_n_panes;
138

139 140 141
/* Current depth within submenus.  */
static int menu_items_submenu_depth;

142
/* Flag which when set indicates a dialog or menu has been posted by
143
   Xt on behalf of one of the widget sets.  */
144 145 146
static int popup_activated_flag;


147 148 149 150 151 152 153 154 155 156
/* 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);
157 158
    }

159 160
  menu_items_used = 0;
  menu_items_n_panes = 0;
161
  menu_items_submenu_depth = 0;
162
}
163

164 165
/* Call at the end of generating the data in menu_items.
   This fills in the number of items in the last pane.  */
166

167 168 169 170
static void
finish_menu_items ()
{
}
171

172 173
/* Call when finished using the data for the current menu
   in menu_items.  */
174

175 176 177 178 179 180 181 182 183 184 185
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;
    }
}
186

187 188 189 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
/* 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--;
}

226 227 228 229 230 231 232 233 234 235 236
/* 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;
}

237 238
/* Start a new menu pane in menu_items..
   NAME is the pane name.  PREFIX_VEC is a prefix key for this pane.  */
239

240 241 242 243 244
static void
push_menu_pane (name, prefix_vec)
     Lisp_Object name, prefix_vec;
{
  if (menu_items_used + MENU_ITEMS_PANE_LENGTH > menu_items_allocated)
245
    grow_menu_items ();
Jim Blandy's avatar
Jim Blandy committed
246

247 248
  if (menu_items_submenu_depth == 0)
    menu_items_n_panes++;
249 250 251 252
  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
253

254 255 256 257 258
/* 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).  */
259

260 261 262 263 264
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)
265
    grow_menu_items ();
266

267 268 269 270 271 272 273 274 275 276 277 278
  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.  */
279

280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
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;
296
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
297

298 299 300 301
  /* 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;
302

303
  def = Fcdr (item1);
304

305 306 307 308 309
  /* 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)))
310
    {
311 312 313 314
      cachelist = XCONS (def)->car;
      def = XCONS (def)->cdr;
      savedkey = XCONS (cachelist)->car;
      descrip = XCONS (cachelist)->cdr;
315
    }
316

317 318
  GCPRO4 (def, def1, savedkey, descrip);

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

344 345 346 347 348 349 350 351 352
      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
353
    }
354

355 356
  /* 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
357 358 359 360
    {
      CHECK_IMPURE (item1);
      XCONS (item1)->cdr = Fcons (Fcons (savedkey, descrip), def);
    }
361
  else if (changed)
Jim Blandy's avatar
Jim Blandy committed
362
    {
363 364
      XCONS (cachelist)->car = savedkey;
      XCONS (cachelist)->cdr = descrip;
Jim Blandy's avatar
Jim Blandy committed
365
    }
366

367
  UNGCPRO;
368 369
  *descrip_ptr = descrip;
  return def;
370 371
}

372 373 374 375 376
/* This is used as the handler when calling internal_condition_case_1.  */

static Lisp_Object
menu_item_enabled_p_1 (arg)
     Lisp_Object arg;
377
{
378
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
379 380
}

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

static Lisp_Object
386
menu_item_enabled_p (def, notreal)
387
     Lisp_Object def;
388
     int notreal;
389
{
390
  Lisp_Object enabled, tem;
391

392
  enabled = Qt;
393 394
  if (notreal)
    return enabled;
395
  if (SYMBOLP (def))
396 397 398 399 400 401 402 403 404 405 406 407 408 409
    {
      /* 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,
410 411 412
   and generate menu panes for them in menu_items.
   If NOTREAL is nonzero,
   don't bother really computing whether an item is enabled.  */
413

414
static void
415
keymap_panes (keymaps, nmaps, notreal)
416 417
     Lisp_Object *keymaps;
     int nmaps;
418
     int notreal;
419
{
420
  int mapno;
421

422
  init_menu_items ();
423

424 425 426 427
  /* 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++)
428
    single_keymap_panes (keymaps[mapno], Qnil, Qnil, notreal);
429 430 431 432 433 434 435

  finish_menu_items ();
}

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

static void
441
single_keymap_panes (keymap, pane_name, prefix, notreal)
442 443 444
     Lisp_Object keymap;
     Lisp_Object pane_name;
     Lisp_Object prefix;
445
     int notreal;
446 447 448 449 450 451 452 453 454
{
  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);

455
  for (tail = keymap; CONSP (tail); tail = XCONS (tail)->cdr)
456
    {
457 458 459
      /* Look at each key binding, and if it has a menu string,
	 make a menu item from it.  */
      item = XCONS (tail)->car;
460
      if (CONSP (item))
461
	{
462
	  item1 = XCONS (item)->cdr;
463
	  if (CONSP (item1))
464 465
	    {
	      item_string = XCONS (item1)->car;
466
	      if (STRINGP (item_string))
467 468 469 470 471 472 473 474
		{
		  /* 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;

475 476
		  /* GCPRO because ...enabled_p will call eval
		     and ..._equiv_key may autoload something.
477 478 479 480
		     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.  */
481
		  descrip = def = Qnil;
482
		  GCPRO4 (keymap, pending_maps, def, descrip);
483 484

		  def = menu_item_equiv_key (item_string, item1, &descrip);
485 486
		  enabled = menu_item_enabled_p (def, notreal);

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

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

545 546
		      /* GCPRO because ...enabled_p will call eval
			 and ..._equiv_key may autoload something.
547 548 549 550 551
			 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);
552 553 554
		      descrip = def = Qnil;

		      def = menu_item_equiv_key (item_string, item1, &descrip);
555
		      enabled = menu_item_enabled_p (def, notreal);
556

557 558 559 560 561 562 563 564 565
		      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
566 567
			{
			  Lisp_Object submap;
568
			  GCPRO4 (keymap, pending_maps, descrip, item_string);
569
			  submap = get_keymap_1 (def, 0, 1);
570
			  UNGCPRO;
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
#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
			}
588 589 590
		    }
		}
	    }
591 592
	}
    }
593 594 595 596

  /* Process now any submenus which want to be panes at this level.  */
  while (!NILP (pending_maps))
    {
597
      Lisp_Object elt, eltcdr, string;
598 599
      elt = Fcar (pending_maps);
      eltcdr = XCONS (elt)->cdr;
600 601 602 603 604
      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);
605 606
      pending_maps = Fcdr (pending_maps);
    }
607
}
608 609 610 611

/* 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.  */
612

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

  if (! NILP (position))
    {
708 709
      check_x ();

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

719 720
	  if (mouse_position_hook)
	    (*mouse_position_hook) (&new_f, &bar_window, &part, &x, &y, &time);
721
	  if (new_f != 0)
722
	    XSETFRAME (window, new_f);
723 724 725
	  else
	    {
	      window = selected_window;
726 727
	      XSETFASTINT (x, 0);
	      XSETFASTINT (y, 0);
728
	    }
729 730 731 732
	}
      else
	{
	  tem = Fcar (position);
733
	  if (CONSP (tem))
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
	    {
	      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))));
749
	      if (CONSP (tem) && EQ (Fcar (tem), Qmenu_bar))
750 751 752 753 754 755 756 757 758
		menubarp = 1;
	    }
	}

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

      /* Decode where to put the menu.  */

759
      if (FRAMEP (window))
760 761 762 763 764 765
	{
	  f = XFRAME (window);

	  xpos = 0;
	  ypos = 0;
	}
766
      else if (WINDOWP (window))
767 768 769 770 771
	{
	  CHECK_LIVE_WINDOW (window, 0);
	  f = XFRAME (WINDOW_FRAME (XWINDOW (window)));

	  xpos = (FONT_WIDTH (f->display.x->font) * XWINDOW (window)->left);
772
	  ypos = (f->display.x->line_height * XWINDOW (window)->top);
773 774 775 776 777 778 779 780 781 782 783 784 785 786
	}
      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.  */
787 788 789

  keymap = Fkeymapp (menu);
  tem = Qnil;
790
  if (CONSP (menu))
791 792 793 794 795 796 797
    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);

798
      /* Extract the detailed info to make one pane.  */
799
      keymap_panes (&menu, 1, NILP (position));
800

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

805 806 807 808 809
      /* 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;
810 811 812 813 814 815 816 817
    }
  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;
818 819

      title = Qnil;
820 821 822

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

827 828 829
	  maps[i++] = keymap = get_keymap (Fcar (tem));

	  prompt = map_prompt (keymap);
830 831
	  if (NILP (title) && !NILP (prompt))
	    title = prompt;
832 833 834
	}

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

      /* 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;
842 843 844 845
    }
  else
    {
      /* We were given an old-fashioned menu.  */
846 847
      title = Fcar (menu);
      CHECK_STRING (title, 1);
848

849
      list_of_panes (Fcdr (menu));
850

851 852
      keymaps = 0;
    }
853
  
854
  if (NILP (position))
855
    {
856 857 858
      discard_menu_items ();
      UNGCPRO;
      return Qnil;
859 860
    }

861 862
  /* Display them in a menu.  */
  BLOCK_INPUT;
863

864 865 866
  selection = xmenu_show (f, xpos, ypos, menubarp,
			  keymaps, title, &error_name);
  UNBLOCK_INPUT;
867

868
  discard_menu_items ();
869

870
  UNGCPRO;
871

872 873
  if (error_name) error (error_name);
  return selection;
874
}
875

876
DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 2, 0,
877
  "Pop up a dialog box and return user's selection.\n\
878 879 880 881
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\
882
\n\
883 884 885
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\
886 887 888 889 890
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.)")
891 892
  (position, contents)
     Lisp_Object position, contents;
893 894
{
  FRAME_PTR f;
895
  Lisp_Object window;
896 897 898

  check_x ();

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

910
      (*mouse_position_hook) (&new_f, &bar_window, &part, &x, &y, &time);
911

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

936
  /* Decode where to put the menu.  */
937

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

950 951 952 953 954
#ifndef USE_X_TOOLKIT
  /* Display a menu with these alternatives
     in the middle of frame F.  */
  {
    Lisp_Object x, y, frame, newpos;
955 956 957
    XSETFRAME (frame, f);
    XSETINT (x, x_pixel_width (f) / 2);
    XSETINT (y, x_pixel_height (f) / 2);
958 959 960 961 962 963 964 965 966 967
    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;
968

969 970 971
    /* Decode the dialog items from what was specified.  */
    title = Fcar (contents);
    CHECK_STRING (title, 1);
972

973
    list_of_panes (Fcons (contents, Qnil));
974

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

980 981 982 983 984
    discard_menu_items ();

    if (error_name) error (error_name);
    return selection;
  }
985
#endif
986
}
987 988

#ifdef USE_X_TOOLKIT
989

990
/* Loop in Xt until the menu pulldown or dialog popup has been
991 992 993 994
   popped down (deactivated).

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

1001 1002 1003 1004
  if (initial_event)
    event = *initial_event;
  else
    XtAppNextEvent (Xt_app_con, &event);
1005

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

1015
/* Detect if a dialog or menu has been posted.  */
1016 1017 1018 1019 1020 1021 1022 1023 1024
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.  */
1025 1026

static void
1027
popup_activate_callback (widget, id, client_data)