xmenu.c 74.7 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* X Communication module for terminals which understand the X protocol.
Richard M. Stallman's avatar
Richard M. Stallman committed
2
   Copyright (C) 1986, 1988, 1993, 1994, 1996 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
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20 21 22 23 24 25 26 27

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

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

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

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

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

47 48 49 50
#ifdef MSDOS
#include "msdos.h"
#endif

Morten Welinder's avatar
Morten Welinder committed
51
#ifdef HAVE_X_WINDOWS
Jim Blandy's avatar
Jim Blandy committed
52 53 54
/* 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
55
#endif
Jim Blandy's avatar
Jim Blandy committed
56 57 58 59 60 61 62 63 64

/* 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
65
#ifdef HAVE_X_WINDOWS
66 67 68 69 70
#ifdef USE_X_TOOLKIT
#include <X11/Xlib.h>
#include <X11/IntrinsicP.h>
#include <X11/CoreP.h>
#include <X11/StringDefs.h>
71
#include <X11/Shell.h>
72
#ifdef USE_LUCID
73
#include <X11/Xaw/Paned.h>
74
#endif /* USE_LUCID */
75
#include "../lwlib/lwlib.h"
76 77 78 79
#else /* not USE_X_TOOLKIT */
#include "../oldXMenu/XMenu.h"
#endif /* not USE_X_TOOLKIT */
#endif /* HAVE_X_WINDOWS */
80

Jim Blandy's avatar
Jim Blandy committed
81 82 83 84 85 86
#define min(x,y) (((x) < (y)) ? (x) : (y))
#define max(x,y) (((x) > (y)) ? (x) : (y))

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

89 90
Lisp_Object Vmenu_updating_frame;

91 92
Lisp_Object Qdebug_on_next_call;

93 94
Lisp_Object Qmenu_alias;

95
extern Lisp_Object Qmenu_enable;
96
extern Lisp_Object Qmenu_bar;
97
extern Lisp_Object Qmouse_click, Qevent_kind;
98

99 100
extern Lisp_Object Vdefine_key_rebound_commands;

Richard M. Stallman's avatar
Richard M. Stallman committed
101 102 103 104 105 106 107
extern Lisp_Object Voverriding_local_map;
extern Lisp_Object Voverriding_local_map_menu_flag;

extern Lisp_Object Qoverriding_local_map, Qoverriding_terminal_local_map;

extern Lisp_Object Qmenu_bar_update_hook;

108
#ifdef USE_X_TOOLKIT
Richard M. Stallman's avatar
Richard M. Stallman committed
109
extern void set_frame_menubar ();
110 111 112
extern void process_expose_from_menu ();
extern XtAppContext Xt_app_con;

113
static Lisp_Object xdialog_show ();
114
void popup_get_selection ();
115 116
#endif

117 118 119 120 121 122 123 124
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
125

126
   It describes the panes and items within the panes.
Jim Blandy's avatar
Jim Blandy committed
127

128 129
   Each pane is described by 3 elements in the vector:
   t, the pane name, the pane's prefix key.
130
   Then follow the pane's items, with 5 elements per item:
131
   the item string, the enable flag, the item's value,
132
   the definition, and the equivalent keyboard key's description string.
Jim Blandy's avatar
Jim Blandy committed
133

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

139 140 141
   A single vector slot containing quote indicates that the
   following items should appear on the right of a dialog box.

142 143
   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
144

145 146 147
#define MENU_ITEMS_PANE_NAME 1
#define MENU_ITEMS_PANE_PREFIX 2
#define MENU_ITEMS_PANE_LENGTH 3
148

149 150 151 152
#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
153 154
#define MENU_ITEMS_ITEM_DEFINITION 4
#define MENU_ITEMS_ITEM_LENGTH 5
155

156
static Lisp_Object menu_items;
157

158 159
/* Number of slots currently allocated in menu_items.  */
static int menu_items_allocated;
160

161 162
/* This is the index in menu_items of the first empty slot.  */
static int menu_items_used;
163

164 165
/* The number of panes currently recorded in menu_items,
   excluding those within submenus.  */
166
static int menu_items_n_panes;
167

168 169 170
/* Current depth within submenus.  */
static int menu_items_submenu_depth;

171
/* Flag which when set indicates a dialog or menu has been posted by
172
   Xt on behalf of one of the widget sets.  */
173 174
static int popup_activated_flag;

Richard M. Stallman's avatar
Richard M. Stallman committed
175
static int next_menubar_widget_id;
176

177 178 179 180 181 182 183 184
/* This is set nonzero after the user activates the menu bar, and set
   to zero again after the menu bars are redisplayed by prepare_menu_bar.
   While it is nonzero, all calls to set_frame_menubar go deep.

   I don't understand why this is needed, but it does seem to be
   needed on Motif, according to Marcus Daniels <marcus@sysc.pdx.edu>.  */

int pending_menu_activation;
185

Richard M. Stallman's avatar
Richard M. Stallman committed
186
#ifdef USE_X_TOOLKIT
187

188
/* Return the frame whose ->output_data.x->id equals ID, or 0 if none.  */
189

Richard M. Stallman's avatar
Richard M. Stallman committed
190 191 192 193 194 195
static struct frame *
menubar_id_to_frame (id)
     LWLIB_ID id;
{
  Lisp_Object tail, frame;
  FRAME_PTR f;
196

Richard M. Stallman's avatar
Richard M. Stallman committed
197
  for (tail = Vframe_list; GC_CONSP (tail); tail = XCONS (tail)->cdr)
198
    {
Richard M. Stallman's avatar
Richard M. Stallman committed
199 200 201 202
      frame = XCONS (tail)->car;
      if (!GC_FRAMEP (frame))
        continue;
      f = XFRAME (frame);
Karl Heuer's avatar
Karl Heuer committed
203
      if (f->output_data.nothing == 1)
Richard M. Stallman's avatar
Richard M. Stallman committed
204
	continue;
205
      if (f->output_data.x->id == id)
Richard M. Stallman's avatar
Richard M. Stallman committed
206
	return f;
207
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
208
  return 0;
209
}
Richard M. Stallman's avatar
Richard M. Stallman committed
210 211

#endif
212

213 214 215 216 217 218 219 220 221 222
/* 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);
223 224
    }

225 226
  menu_items_used = 0;
  menu_items_n_panes = 0;
227
  menu_items_submenu_depth = 0;
228
}
229

230 231
/* Call at the end of generating the data in menu_items.
   This fills in the number of items in the last pane.  */
232

233 234 235 236
static void
finish_menu_items ()
{
}
237

238 239
/* Call when finished using the data for the current menu
   in menu_items.  */
240

241 242 243 244 245 246 247 248 249 250 251
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;
    }
}
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 281 282 283 284 285 286 287 288 289 290 291
/* 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--;
}

292 293 294 295 296 297 298 299 300 301 302
/* 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;
}

303 304
/* Start a new menu pane in menu_items..
   NAME is the pane name.  PREFIX_VEC is a prefix key for this pane.  */
305

306 307 308 309 310
static void
push_menu_pane (name, prefix_vec)
     Lisp_Object name, prefix_vec;
{
  if (menu_items_used + MENU_ITEMS_PANE_LENGTH > menu_items_allocated)
311
    grow_menu_items ();
Jim Blandy's avatar
Jim Blandy committed
312

313 314
  if (menu_items_submenu_depth == 0)
    menu_items_n_panes++;
315 316 317 318
  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
319

320 321 322
/* 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
323 324 325 326
   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).  */
327

328
static void
329 330
push_menu_item (name, enable, key, def, equiv)
     Lisp_Object name, enable, key, def, equiv;
331 332
{
  if (menu_items_used + MENU_ITEMS_ITEM_LENGTH > menu_items_allocated)
333
    grow_menu_items ();
334

335 336 337 338
  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;
339
  XVECTOR (menu_items)->contents[menu_items_used++] = def;
340 341 342 343 344 345 346 347
}

/* 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.  */
348

349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
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;
365
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
366

367 368 369 370
  /* 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;
371

372
  def = Fcdr (item1);
373

374 375 376 377 378
  /* 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)))
379
    {
380 381 382 383
      cachelist = XCONS (def)->car;
      def = XCONS (def)->cdr;
      savedkey = XCONS (cachelist)->car;
      descrip = XCONS (cachelist)->cdr;
384
    }
385

386 387
  GCPRO4 (def, def1, savedkey, descrip);

388 389 390 391 392 393
  /* Is it still valid?  */
  def1 = Qnil;
  if (!NILP (savedkey))
    def1 = Fkey_binding (savedkey, Qnil);
  /* If not, update it.  */
  if (! EQ (def1, def)
394 395
      /* If the command is an alias for another
         (such as easymenu.el and lmenu.el set it up),
396
         check if the original command matches the cached command.  */
397 398
      && !(SYMBOLP (def) && SYMBOLP (XSYMBOL (def)->function)
           && EQ (def1, XSYMBOL (def)->function))
399 400 401 402 403 404 405
      /* 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)))))
406
    {
407 408
      changed = 1;
      descrip = Qnil;
409 410 411
      /* 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.  */
412 413
      if (SYMBOLP (def) && SYMBOLP (XSYMBOL (def)->function)
	  && ! NILP (Fget (def, Qmenu_alias)))
414 415
	savedkey = Fwhere_is_internal (XSYMBOL (def)->function,
				       Qnil, Qt, Qnil);
416 417 418 419 420
      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);

421 422 423 424 425 426
      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
427
    }
428

429 430
  /* 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
431 432 433 434
    {
      CHECK_IMPURE (item1);
      XCONS (item1)->cdr = Fcons (Fcons (savedkey, descrip), def);
    }
435
  else if (changed)
Jim Blandy's avatar
Jim Blandy committed
436
    {
437 438
      XCONS (cachelist)->car = savedkey;
      XCONS (cachelist)->cdr = descrip;
Jim Blandy's avatar
Jim Blandy committed
439
    }
440

441
  UNGCPRO;
442 443
  *descrip_ptr = descrip;
  return def;
444 445
}

446 447 448 449 450
/* This is used as the handler when calling internal_condition_case_1.  */

static Lisp_Object
menu_item_enabled_p_1 (arg)
     Lisp_Object arg;
451
{
452 453 454 455 456
  /* 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);

457
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
458 459
}

460
/* Return non-nil if the command DEF is enabled when used as a menu item.
461 462
   This is based on looking for a menu-enable property.
   If NOTREAL is set, don't bother really computing this.  */
463 464

static Lisp_Object
465
menu_item_enabled_p (def, notreal)
466
     Lisp_Object def;
467
     int notreal;
468
{
469
  Lisp_Object enabled, tem;
470

471
  enabled = Qt;
472 473
  if (notreal)
    return enabled;
474
  if (SYMBOLP (def))
475 476 477 478 479 480 481 482 483 484 485 486 487 488
    {
      /* 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,
489 490 491
   and generate menu panes for them in menu_items.
   If NOTREAL is nonzero,
   don't bother really computing whether an item is enabled.  */
492

493
static void
494
keymap_panes (keymaps, nmaps, notreal)
495 496
     Lisp_Object *keymaps;
     int nmaps;
497
     int notreal;
498
{
499
  int mapno;
500

501
  init_menu_items ();
502

503 504 505 506
  /* 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++)
507
    single_keymap_panes (keymaps[mapno], Qnil, Qnil, notreal, 10);
508 509 510 511 512 513 514

  finish_menu_items ();
}

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

   If we encounter submenus deeper than MAXDEPTH levels, ignore them.  */
520 521

static void
522
single_keymap_panes (keymap, pane_name, prefix, notreal, maxdepth)
523 524 525
     Lisp_Object keymap;
     Lisp_Object pane_name;
     Lisp_Object prefix;
526
     int notreal;
527
     int maxdepth;
528 529 530 531 532
{
  Lisp_Object pending_maps;
  Lisp_Object tail, item, item1, item_string, table;
  struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;

533 534 535
  if (maxdepth <= 0)
    return;

536 537 538 539
  pending_maps = Qnil;

  push_menu_pane (pane_name, prefix);

540
  for (tail = keymap; CONSP (tail); tail = XCONS (tail)->cdr)
541
    {
542 543 544
      /* Look at each key binding, and if it has a menu string,
	 make a menu item from it.  */
      item = XCONS (tail)->car;
545
      if (CONSP (item))
546
	{
547
	  item1 = XCONS (item)->cdr;
548
	  if (CONSP (item1))
549 550
	    {
	      item_string = XCONS (item1)->car;
551
	      if (STRINGP (item_string))
552 553 554 555 556 557 558 559
		{
		  /* 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;

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

		  def = menu_item_equiv_key (item_string, item1, &descrip);
570 571
		  enabled = menu_item_enabled_p (def, notreal);

572 573 574 575 576 577 578 579 580
		  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
581 582
		    {
		      Lisp_Object submap;
583
		      GCPRO4 (keymap, pending_maps, descrip, item_string);
584
		      submap = get_keymap_1 (def, 0, 1);
585
		      UNGCPRO;
586 587 588 589 590 591
#ifndef USE_X_TOOLKIT
		      /* Indicate visually that this is a submenu.  */
		      if (!NILP (submap))
			item_string = concat2 (item_string,
					       build_string (" >"));
#endif
592 593 594
		      /* If definition is nil, pass nil as the key.  */
		      push_menu_item (item_string, enabled,
				      XCONS (item)->car, def,
595 596 597 598 599 600 601
				      descrip);
#ifdef USE_X_TOOLKIT
		      /* Display a submenu using the toolkit.  */
		      if (! NILP (submap))
			{
			  push_submenu_start ();
			  single_keymap_panes (submap, Qnil,
602 603
					       XCONS (item)->car, notreal,
					       maxdepth - 1);
604 605 606 607
			  push_submenu_end ();
			}
#endif
		    }
608 609 610
		}
	    }
	}
611
      else if (VECTORP (item))
612 613 614 615 616 617 618
	{
	  /* 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;
619
	      XSETFASTINT (character, c);
620
	      item1 = XVECTOR (item)->contents[c];
621
	      if (CONSP (item1))
622 623
		{
		  item_string = XCONS (item1)->car;
624
		  if (STRINGP (item_string))
625 626 627 628 629 630 631 632
		    {
		      Lisp_Object def;

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

633 634
		      /* GCPRO because ...enabled_p will call eval
			 and ..._equiv_key may autoload something.
635 636 637 638 639
			 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);
640 641 642
		      descrip = def = Qnil;

		      def = menu_item_equiv_key (item_string, item1, &descrip);
643
		      enabled = menu_item_enabled_p (def, notreal);
644

645 646 647 648 649 650 651 652 653
		      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
654 655
			{
			  Lisp_Object submap;
656
			  GCPRO4 (keymap, pending_maps, descrip, item_string);
657
			  submap = get_keymap_1 (def, 0, 1);
658
			  UNGCPRO;
659 660 661 662 663
#ifndef USE_X_TOOLKIT
			  if (!NILP (submap))
			    item_string = concat2 (item_string,
						   build_string (" >"));
#endif
664
			  /* If definition is nil, pass nil as the key.  */
665
			  push_menu_item (item_string, enabled, character,
666
					  def, descrip);
667 668 669 670 671
#ifdef USE_X_TOOLKIT
			  if (! NILP (submap))
			    {
			      push_submenu_start ();
			      single_keymap_panes (submap, Qnil,
672 673
						   character, notreal,
						   maxdepth - 1);
674 675 676 677
			      push_submenu_end ();
			    }
#endif
			}
678 679 680
		    }
		}
	    }
681 682
	}
    }
683 684 685 686

  /* Process now any submenus which want to be panes at this level.  */
  while (!NILP (pending_maps))
    {
687
      Lisp_Object elt, eltcdr, string;
688 689
      elt = Fcar (pending_maps);
      eltcdr = XCONS (elt)->cdr;
690 691 692 693
      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,
694
			   XCONS (eltcdr)->cdr, notreal, maxdepth - 1);
695 696
      pending_maps = Fcdr (pending_maps);
    }
697
}
698

Karl Heuer's avatar
Karl Heuer committed
699
/* Push all the panes and items of a menu described by the
700 701
   alist-of-alists MENU.
   This handles old-fashioned calls to x-popup-menu.  */
702

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

796
#ifdef HAVE_MENUS
797 798
  if (! NILP (position))
    {
799 800
      check_x ();

801
      /* Decode the first argument: find the window and the coordinates.  */
802 803
      if (EQ (position, Qt)
	  || (CONSP (position) && EQ (XCONS (position)->car, Qmenu_bar)))
804 805
	{
	  /* Use the mouse's current position.  */
806
	  FRAME_PTR new_f = selected_frame;
807 808 809 810
	  Lisp_Object bar_window;
	  int part;
	  unsigned long time;

811
	  if (mouse_position_hook)
812 813
	    (*mouse_position_hook) (&new_f, 1, &bar_window,
				    &part, &x, &y, &time);
814
	  if (new_f != 0)
815
	    XSETFRAME (window, new_f);
816 817 818
	  else
	    {
	      window = selected_window;
819 820
	      XSETFASTINT (x, 0);
	      XSETFASTINT (y, 0);
821
	    }
822 823 824 825
	}
      else
	{
	  tem = Fcar (position);
826
	  if (CONSP (tem))
827 828 829 830 831 832 833
	    {
	      window = Fcar (Fcdr (position));
	      x = Fcar (tem);
	      y = Fcar (Fcdr (tem));
	    }
	  else
	    {
834
	      for_click = 1;
835 836 837 838 839 840 841 842 843 844 845 846 847
	      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.  */

848
      if (FRAMEP (window))
849 850 851 852 853
	{
	  f = XFRAME (window);
	  xpos = 0;
	  ypos = 0;
	}
854
      else if (WINDOWP (window))
855 856 857 858
	{
	  CHECK_LIVE_WINDOW (window, 0);
	  f = XFRAME (WINDOW_FRAME (XWINDOW (window)));

859 860
	  xpos = (FONT_WIDTH (f->output_data.x->font) * XWINDOW (window)->left);
	  ypos = (f->output_data.x->line_height * XWINDOW (window)->top);
861 862 863 864 865 866 867 868
	}
      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);
869 870

      XSETFRAME (Vmenu_updating_frame, f);
871
    }
872
  Vmenu_updating_frame = Qnil;
873
#endif /* HAVE_MENUS */
874 875 876 877 878

  title = Qnil;
  GCPRO1 (title);

  /* Decode the menu items from what was specified.  */
879 880 881

  keymap = Fkeymapp (menu);
  tem = Qnil;
882
  if (CONSP (menu))
883 884 885 886 887 888 889
    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);

890
      /* Extract the detailed info to make one pane.  */
891
      keymap_panes (&menu, 1, NILP (position));
892

893 894 895
      /* Search for a string appearing directly as an element of the keymap.
	 That string is the title of the menu.  */
      prompt = map_prompt (keymap);
896 897
      if (NILP (title) && !NILP (prompt))
	title = prompt;
898

899 900 901 902 903
      /* 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;
904 905 906 907 908 909 910 911
    }
  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;
912 913

      title = Qnil;
914 915 916

      /* The first keymap that has a prompt string
	 supplies the menu title.  */
917
      for (tem = menu, i = 0; CONSP (tem); tem = Fcdr (tem))
918
	{
919 920
	  Lisp_Object prompt;

921 922 923
	  maps[i++] = keymap = get_keymap (Fcar (tem));

	  prompt = map_prompt (keymap);
924 925
	  if (NILP (title) && !NILP (prompt))
	    title = prompt;
926 927 928
	}

      /* Extract the detailed info to make one pane.  */
929
      keymap_panes (maps, nmaps, NILP (position));
930 931 932 933 934 935

      /* 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;
936 937 938 939
    }
  else
    {
      /* We were given an old-fashioned menu.  */
940 941
      title = Fcar (menu);
      CHECK_STRING (title, 1);
942

943
      list_of_panes (Fcdr (menu));
944

945 946
      keymaps = 0;
    }
947
  
948
  if (NILP (position))
949
    {
950 951 952
      discard_menu_items ();
      UNGCPRO;
      return Qnil;
953 954
    }

955
#ifdef HAVE_MENUS
956 957
  /* Display them in a menu.  */
  BLOCK_INPUT;
958

959
  selection = xmenu_show (f, xpos, ypos, for_click,
960 961
			  keymaps, title, &error_name);
  UNBLOCK_INPUT;
962

963
  discard_menu_items ();
964

965
  UNGCPRO;
966
#endif /* HAVE_MENUS */
967