xmenu.c 67.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
#ifdef MSDOS
#include "msdos.h"
#endif

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

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

#include "dispextern.h"

Morten Welinder's avatar
Morten Welinder committed
63
#ifdef HAVE_X_WINDOWS
64 65 66 67 68
#ifdef USE_X_TOOLKIT
#include <X11/Xlib.h>
#include <X11/IntrinsicP.h>
#include <X11/CoreP.h>
#include <X11/StringDefs.h>
69
#include <X11/Shell.h>
70
#include <X11/Xaw/Paned.h>
71
#include "../lwlib/lwlib.h"
72 73 74 75
#else /* not USE_X_TOOLKIT */
#include "../oldXMenu/XMenu.h"
#endif /* not USE_X_TOOLKIT */
#endif /* HAVE_X_WINDOWS */
76

Jim Blandy's avatar
Jim Blandy committed
77 78 79 80 81 82
#define min(x,y) (((x) < (y)) ? (x) : (y))
#define max(x,y) (((x) > (y)) ? (x) : (y))

#ifndef TRUE
#define TRUE 1
#define FALSE 0
83
#endif /* no TRUE */
Jim Blandy's avatar
Jim Blandy committed
84

85 86
Lisp_Object Qdebug_on_next_call;

87
extern Lisp_Object Qmenu_enable;
88
extern Lisp_Object Qmenu_bar;
89
extern Lisp_Object Qmouse_click, Qevent_kind;
90

91 92
extern Lisp_Object Vdefine_key_rebound_commands;

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

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

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

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

112 113
   Each pane is described by 3 elements in the vector:
   t, the pane name, the pane's prefix key.
114
   Then follow the pane's items, with 5 elements per item:
115
   the item string, the enable flag, the item's value,
116
   the definition, and the equivalent keyboard key's description string.
Jim Blandy's avatar
Jim Blandy committed
117

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

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

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

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

133 134 135 136
#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
137 138
#define MENU_ITEMS_ITEM_DEFINITION 4
#define MENU_ITEMS_ITEM_LENGTH 5
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
/* Flag which when set indicates a dialog or menu has been posted by
156
   Xt on behalf of one of the widget sets.  */
157 158
static int popup_activated_flag;

159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
/* This holds a Lisp vector
   which contains frames that have menu bars.
   Each frame that has a menu bar is found at some index in this vector
   and the menu bar widget refers to the frame through that index.  */
static Lisp_Object frame_vector;

/* Return the index of FRAME in frame_vector.
   If FRAME isn't in frame_vector yet, put it in,
   lengthening the vector if necessary.  */

static int
frame_vector_add_frame (f)
     FRAME_PTR *f;
{
  int length = XVECTOR (frame_vector)->size;
  int i, empty = -1;
  Lisp_Object new, frame;

  XSETFRAME (frame, f);

  for (i = 0; i < length; i++)
    {
      if (EQ (frame, XVECTOR (frame_vector)->contents[i]))
	return i;
      if (NILP (XVECTOR (frame_vector)->contents[i]))
	empty = i;
    }

  if (empty >= 0)
    {
      XVECTOR (frame_vector)->contents[empty] = frame;
      return empty;
    }

  new = Fmake_vector (make_number (length * 2), Qnil);
  bcopy (XVECTOR (frame_vector)->contents,
	 XVECTOR (new)->contents, sizeof (Lisp_Object) * length);
  
197
  frame_vector = new;
198 199 200
  XVECTOR (frame_vector)->contents[length] = frame;
  return length;
}
201

202 203 204 205 206 207 208 209 210 211
/* 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);
212 213
    }

214 215
  menu_items_used = 0;
  menu_items_n_panes = 0;
216
  menu_items_submenu_depth = 0;
217
}
218

219 220
/* Call at the end of generating the data in menu_items.
   This fills in the number of items in the last pane.  */
221

222 223 224 225
static void
finish_menu_items ()
{
}
226

227 228
/* Call when finished using the data for the current menu
   in menu_items.  */
229

230 231 232 233 234 235 236 237 238 239 240
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;
    }
}
241

242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
/* 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--;
}

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

292 293
/* Start a new menu pane in menu_items..
   NAME is the pane name.  PREFIX_VEC is a prefix key for this pane.  */
294

295 296 297 298 299
static void
push_menu_pane (name, prefix_vec)
     Lisp_Object name, prefix_vec;
{
  if (menu_items_used + MENU_ITEMS_PANE_LENGTH > menu_items_allocated)
300
    grow_menu_items ();
Jim Blandy's avatar
Jim Blandy committed
301

302 303
  if (menu_items_submenu_depth == 0)
    menu_items_n_panes++;
304 305 306 307
  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
308

309 310 311
/* 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
312 313 314 315
   choosing this item, or nil if this item doesn't really have a definition.
   DEF is the definition of this item.
   EQUIV is the textual description of the keyboard equivalent for
   this item (or nil if none).  */
316

317
static void
318 319
push_menu_item (name, enable, key, def, equiv)
     Lisp_Object name, enable, key, def, equiv;
320 321
{
  if (menu_items_used + MENU_ITEMS_ITEM_LENGTH > menu_items_allocated)
322
    grow_menu_items ();
323

324 325 326 327
  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;
328
  XVECTOR (menu_items)->contents[menu_items_used++] = def;
329 330 331 332 333 334 335 336
}

/* 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.  */
337

338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
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;
354
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
355

356 357 358 359
  /* 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;
360

361
  def = Fcdr (item1);
362

363 364 365 366 367
  /* 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)))
368
    {
369 370 371 372
      cachelist = XCONS (def)->car;
      def = XCONS (def)->cdr;
      savedkey = XCONS (cachelist)->car;
      descrip = XCONS (cachelist)->cdr;
373
    }
374

375 376
  GCPRO4 (def, def1, savedkey, descrip);

377 378 379 380 381 382
  /* Is it still valid?  */
  def1 = Qnil;
  if (!NILP (savedkey))
    def1 = Fkey_binding (savedkey, Qnil);
  /* If not, update it.  */
  if (! EQ (def1, def)
383 384
      /* If the command is an alias for another
         (such as easymenu.el and lmenu.el set it up),
385
         check if the original command matches the cached command.  */
386 387
      && !(SYMBOLP (def) && SYMBOLP (XSYMBOL (def)->function)
           && EQ (def1, XSYMBOL (def)->function))
388 389 390 391 392 393 394
      /* If something had no key binding before, don't recheck it
	 because that is too slow--except if we have a list of rebound
	 commands in Vdefine_key_rebound_commands, do recheck any command
	 that appears in that list.  */
      && (NILP (cachelist) || !NILP (savedkey)
	  || (! EQ (Qt, Vdefine_key_rebound_commands)
	      && !NILP (Fmemq (def, Vdefine_key_rebound_commands)))))
395
    {
396 397
      changed = 1;
      descrip = Qnil;
398 399 400 401 402 403
      /* 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);
404 405 406 407 408
      else
	/* Otherwise look up the specified command itself.
	   We don't try both, because that makes easymenu menus slow.  */
	savedkey = Fwhere_is_internal (def, Qnil, Qt, Qnil);

409 410 411 412 413 414
      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
415
    }
416

417 418
  /* 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
419 420 421 422
    {
      CHECK_IMPURE (item1);
      XCONS (item1)->cdr = Fcons (Fcons (savedkey, descrip), def);
    }
423
  else if (changed)
Jim Blandy's avatar
Jim Blandy committed
424
    {
425 426
      XCONS (cachelist)->car = savedkey;
      XCONS (cachelist)->cdr = descrip;
Jim Blandy's avatar
Jim Blandy committed
427
    }
428

429
  UNGCPRO;
430 431
  *descrip_ptr = descrip;
  return def;
432 433
}

434 435 436 437 438
/* This is used as the handler when calling internal_condition_case_1.  */

static Lisp_Object
menu_item_enabled_p_1 (arg)
     Lisp_Object arg;
439
{
440 441 442 443 444
  /* If we got a quit from within the menu computation,
     quit all the way out of it.  This takes care of C-] in the debugger.  */
  if (CONSP (arg) && EQ (XCONS (arg)->car, Qquit))
    Fsignal (Qquit, Qnil);

445
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
446 447
}

448
/* Return non-nil if the command DEF is enabled when used as a menu item.
449 450
   This is based on looking for a menu-enable property.
   If NOTREAL is set, don't bother really computing this.  */
451 452

static Lisp_Object
453
menu_item_enabled_p (def, notreal)
454
     Lisp_Object def;
455
     int notreal;
456
{
457
  Lisp_Object enabled, tem;
458

459
  enabled = Qt;
460 461
  if (notreal)
    return enabled;
462
  if (SYMBOLP (def))
463 464 465 466 467 468 469 470 471 472 473 474 475 476
    {
      /* 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,
477 478 479
   and generate menu panes for them in menu_items.
   If NOTREAL is nonzero,
   don't bother really computing whether an item is enabled.  */
480

481
static void
482
keymap_panes (keymaps, nmaps, notreal)
483 484
     Lisp_Object *keymaps;
     int nmaps;
485
     int notreal;
486
{
487
  int mapno;
488

489
  init_menu_items ();
490

491 492 493 494
  /* 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++)
495
    single_keymap_panes (keymaps[mapno], Qnil, Qnil, notreal);
496 497 498 499 500 501 502

  finish_menu_items ();
}

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

static void
508
single_keymap_panes (keymap, pane_name, prefix, notreal)
509 510 511
     Lisp_Object keymap;
     Lisp_Object pane_name;
     Lisp_Object prefix;
512
     int notreal;
513 514 515 516 517 518 519 520 521
{
  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);

522
  for (tail = keymap; CONSP (tail); tail = XCONS (tail)->cdr)
523
    {
524 525 526
      /* Look at each key binding, and if it has a menu string,
	 make a menu item from it.  */
      item = XCONS (tail)->car;
527
      if (CONSP (item))
528
	{
529
	  item1 = XCONS (item)->cdr;
530
	  if (CONSP (item1))
531 532
	    {
	      item_string = XCONS (item1)->car;
533
	      if (STRINGP (item_string))
534 535 536 537 538 539 540 541
		{
		  /* 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;

542 543
		  /* GCPRO because ...enabled_p will call eval
		     and ..._equiv_key may autoload something.
544 545 546 547
		     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.  */
548
		  descrip = def = Qnil;
549
		  GCPRO4 (keymap, pending_maps, def, descrip);
550 551

		  def = menu_item_equiv_key (item_string, item1, &descrip);
552 553
		  enabled = menu_item_enabled_p (def, notreal);

554 555 556 557 558 559 560 561 562
		  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
563 564
		    {
		      Lisp_Object submap;
565
		      GCPRO4 (keymap, pending_maps, descrip, item_string);
566
		      submap = get_keymap_1 (def, 0, 1);
567
		      UNGCPRO;
568 569 570 571 572 573
#ifndef USE_X_TOOLKIT
		      /* Indicate visually that this is a submenu.  */
		      if (!NILP (submap))
			item_string = concat2 (item_string,
					       build_string (" >"));
#endif
574 575 576
		      /* If definition is nil, pass nil as the key.  */
		      push_menu_item (item_string, enabled,
				      XCONS (item)->car, def,
577 578 579 580 581 582 583 584 585 586 587 588
				      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
		    }
589 590 591
		}
	    }
	}
592
      else if (VECTORP (item))
593 594 595 596 597 598 599
	{
	  /* 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;
600
	      XSETFASTINT (character, c);
601
	      item1 = XVECTOR (item)->contents[c];
602
	      if (CONSP (item1))
603 604
		{
		  item_string = XCONS (item1)->car;
605
		  if (STRINGP (item_string))
606 607 608 609 610 611 612 613
		    {
		      Lisp_Object def;

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

614 615
		      /* GCPRO because ...enabled_p will call eval
			 and ..._equiv_key may autoload something.
616 617 618 619 620
			 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);
621 622 623
		      descrip = def = Qnil;

		      def = menu_item_equiv_key (item_string, item1, &descrip);
624
		      enabled = menu_item_enabled_p (def, notreal);
625

626 627 628 629 630 631 632 633 634
		      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
635 636
			{
			  Lisp_Object submap;
637
			  GCPRO4 (keymap, pending_maps, descrip, item_string);
638
			  submap = get_keymap_1 (def, 0, 1);
639
			  UNGCPRO;
640 641 642 643 644
#ifndef USE_X_TOOLKIT
			  if (!NILP (submap))
			    item_string = concat2 (item_string,
						   build_string (" >"));
#endif
645
			  /* If definition is nil, pass nil as the key.  */
646
			  push_menu_item (item_string, enabled, character,
647
					  def, descrip);
648 649 650 651 652 653 654 655 656 657
#ifdef USE_X_TOOLKIT
			  if (! NILP (submap))
			    {
			      push_submenu_start ();
			      single_keymap_panes (submap, Qnil,
						   character, notreal);
			      push_submenu_end ();
			    }
#endif
			}
658 659 660
		    }
		}
	    }
661 662
	}
    }
663 664 665 666

  /* Process now any submenus which want to be panes at this level.  */
  while (!NILP (pending_maps))
    {
667
      Lisp_Object elt, eltcdr, string;
668 669
      elt = Fcar (pending_maps);
      eltcdr = XCONS (elt)->cdr;
670 671 672 673 674
      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);
675 676
      pending_maps = Fcdr (pending_maps);
    }
677
}
678 679 680 681

/* 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.  */
682

683 684
static void
list_of_panes (menu)
685 686
     Lisp_Object menu;
{
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
  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))
718
	push_menu_item (item, Qnil, Qnil, Qt, Qnil);
719 720
      else if (NILP (item))
	push_left_right_boundary ();
721 722 723 724 725
      else
	{
	  CHECK_CONS (item, 0);
	  item1 = Fcar (item);
	  CHECK_STRING (item1, 1);
726
	  push_menu_item (item1, Qt, Fcdr (item), Qt, Qnil);
727 728 729 730
	}
    }
}

731
DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0,
732 733 734
  "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\
735
where XOFFSET and YOFFSET are positions in pixels from the top left\n\
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
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;
764
  Lisp_Object keymap, tem;
765 766 767 768
  int xpos, ypos;
  Lisp_Object title;
  char *error_name;
  Lisp_Object selection;
769
  int i, j;
770 771 772
  FRAME_PTR f;
  Lisp_Object x, y, window;
  int keymaps = 0;
773
  int for_click = 0;
774 775 776 777
  struct gcpro gcpro1;

  if (! NILP (position))
    {
778 779
      check_x ();

780
      /* Decode the first argument: find the window and the coordinates.  */
781 782
      if (EQ (position, Qt)
	  || (CONSP (position) && EQ (XCONS (position)->car, Qmenu_bar)))
783 784
	{
	  /* Use the mouse's current position.  */
785
	  FRAME_PTR new_f = selected_frame;
786 787 788 789
	  Lisp_Object bar_window;
	  int part;
	  unsigned long time;

790
	  if (mouse_position_hook)
791 792
	    (*mouse_position_hook) (&new_f, 1, &bar_window,
				    &part, &x, &y, &time);
793
	  if (new_f != 0)
794
	    XSETFRAME (window, new_f);
795 796 797
	  else
	    {
	      window = selected_window;
798 799
	      XSETFASTINT (x, 0);
	      XSETFASTINT (y, 0);
800
	    }
801 802 803 804
	}
      else
	{
	  tem = Fcar (position);
805
	  if (CONSP (tem))
806 807 808 809 810 811 812
	    {
	      window = Fcar (Fcdr (position));
	      x = Fcar (tem);
	      y = Fcar (Fcdr (tem));
	    }
	  else
	    {
813
	      for_click = 1;
814 815 816 817 818 819 820 821 822 823 824 825 826
	      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);
	    }
	}

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

      /* Decode where to put the menu.  */

827
      if (FRAMEP (window))
828 829 830 831 832
	{
	  f = XFRAME (window);
	  xpos = 0;
	  ypos = 0;
	}
833
      else if (WINDOWP (window))
834 835 836 837 838
	{
	  CHECK_LIVE_WINDOW (window, 0);
	  f = XFRAME (WINDOW_FRAME (XWINDOW (window)));

	  xpos = (FONT_WIDTH (f->display.x->font) * XWINDOW (window)->left);
839
	  ypos = (f->display.x->line_height * XWINDOW (window)->top);
840 841 842 843 844 845 846 847 848 849 850 851 852 853
	}
      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.  */
854 855 856

  keymap = Fkeymapp (menu);
  tem = Qnil;
857
  if (CONSP (menu))
858 859 860 861 862 863 864
    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);

865
      /* Extract the detailed info to make one pane.  */
866
      keymap_panes (&menu, 1, NILP (position));
867

868 869 870 871
      /* Search for a string appearing directly as an element of the keymap.
	 That string is the title of the menu.  */
      prompt = map_prompt (keymap);

872 873 874 875 876
      /* 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;
877 878 879 880 881 882 883 884
    }
  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;
885 886

      title = Qnil;
887 888 889

      /* The first keymap that has a prompt string
	 supplies the menu title.  */
890
      for (tem = menu, i = 0; CONSP (tem); tem = Fcdr (tem))
891
	{
892 893
	  Lisp_Object prompt;

894 895 896
	  maps[i++] = keymap = get_keymap (Fcar (tem));

	  prompt = map_prompt (keymap);
897 898
	  if (NILP (title) && !NILP (prompt))
	    title = prompt;
899 900 901
	}

      /* Extract the detailed info to make one pane.  */
902
      keymap_panes (maps, nmaps, NILP (position));
903 904 905 906 907 908

      /* 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;
909 910 911 912
    }
  else
    {
      /* We were given an old-fashioned menu.  */
913 914
      title = Fcar (menu);
      CHECK_STRING (title, 1);
915

916
      list_of_panes (Fcdr (menu));
917

918 919
      keymaps = 0;
    }
920
  
921
  if (NILP (position))
922
    {
923 924 925
      discard_menu_items ();
      UNGCPRO;
      return Qnil;
926 927
    }

928 929
  /* Display them in a menu.  */
  BLOCK_INPUT;
930

931
  selection = xmenu_show (f, xpos, ypos, for_click,
932 933
			  keymaps, title, &error_name);
  UNBLOCK_INPUT;
934

935
  discard_menu_items ();
936

937
  UNGCPRO;
938

939 940
  if (error_name) error (error_name);
  return selection;
941
}
942

943
DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 2, 0,
944
  "Pop up a dialog box and return user's selection.\n\
945 946 947 948
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\
949
\n\
950 951 952
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\
953 954 955 956 957
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.)")
958 959
  (position, contents)
     Lisp_Object position, contents;
960 961
{
  FRAME_PTR f;
962
  Lisp_Object window;
963 964 965

  check_x ();

966
  /* Decode the first argument: find the window or frame to use.  */
967 968
  if (EQ (position, Qt)
      || (CONSP (position) && EQ (XCONS (position)->car, Qmenu_bar)))
969
    {
970
#if 0 /* Using the frame the mouse is on may not be right.  */
971
      /* Use the mouse's current position.  */
972
      FRAME_PTR new_f = selected_frame;
973 974 975 976
      Lisp_Object bar_window;
      int part;
      unsigned long time;
      Lisp_Object x, y;
977

978
      (*mouse_position_hook) (&new_f, 1, &bar_window, &part, &x, &y, &time);
979

980
      if (new_f != 0)
981
	XSETFRAME (window, new_f);
982 983
      else
	window = selected_window;
984
#endif
985
      window = selected_window;
986 987 988 989 990
    }
  else if (CONSP (position))
    {
      Lisp_Object tem;
      tem = Fcar (position);
991
      if (CONSP (tem))
992
	window = Fcar (Fcdr (position));
993 994
      else
	{
995 996
	  tem = Fcar (Fcdr (position));  /* EVENT_START (position) */
	  window = Fcar (tem);	     /* POSN_WINDOW (tem) */
997 998
	}
    }
999 1000
  else if (WINDOWP (position) || FRAMEP (position))
    window = position;
1001

1002
  /* Decode where to put the menu.  */
1003

1004
  if (FRAMEP (