xmenu.c 71.7 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
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 Qdebug_on_next_call;

91
extern Lisp_Object Qmenu_enable;
92
extern Lisp_Object Qmenu_bar;
93
extern Lisp_Object Qmouse_click, Qevent_kind;
94

95 96
extern Lisp_Object Vdefine_key_rebound_commands;

Richard M. Stallman's avatar
Richard M. Stallman committed
97 98 99 100 101 102 103
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;

104
#ifdef USE_X_TOOLKIT
Richard M. Stallman's avatar
Richard M. Stallman committed
105
extern void set_frame_menubar ();
106 107 108
extern void process_expose_from_menu ();
extern XtAppContext Xt_app_con;

109
static Lisp_Object xdialog_show ();
110
void popup_get_selection ();
111 112
#endif

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

122
   It describes the panes and items within the panes.
Jim Blandy's avatar
Jim Blandy committed
123

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

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

135 136 137
   A single vector slot containing quote indicates that the
   following items should appear on the right of a dialog box.

138 139
   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
140

141 142 143
#define MENU_ITEMS_PANE_NAME 1
#define MENU_ITEMS_PANE_PREFIX 2
#define MENU_ITEMS_PANE_LENGTH 3
144

145 146 147 148
#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
149 150
#define MENU_ITEMS_ITEM_DEFINITION 4
#define MENU_ITEMS_ITEM_LENGTH 5
151

152
static Lisp_Object menu_items;
153

154 155
/* Number of slots currently allocated in menu_items.  */
static int menu_items_allocated;
156

157 158
/* This is the index in menu_items of the first empty slot.  */
static int menu_items_used;
159

160 161
/* The number of panes currently recorded in menu_items,
   excluding those within submenus.  */
162
static int menu_items_n_panes;
163

164 165 166
/* Current depth within submenus.  */
static int menu_items_submenu_depth;

167
/* Flag which when set indicates a dialog or menu has been posted by
168
   Xt on behalf of one of the widget sets.  */
169 170
static int popup_activated_flag;

Richard M. Stallman's avatar
Richard M. Stallman committed
171
static int next_menubar_widget_id;
172

Richard M. Stallman's avatar
Richard M. Stallman committed
173
#ifdef USE_X_TOOLKIT
174

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

Richard M. Stallman's avatar
Richard M. Stallman committed
177 178 179 180 181 182
static struct frame *
menubar_id_to_frame (id)
     LWLIB_ID id;
{
  Lisp_Object tail, frame;
  FRAME_PTR f;
183

Richard M. Stallman's avatar
Richard M. Stallman committed
184
  for (tail = Vframe_list; GC_CONSP (tail); tail = XCONS (tail)->cdr)
185
    {
Richard M. Stallman's avatar
Richard M. Stallman committed
186 187 188 189
      frame = XCONS (tail)->car;
      if (!GC_FRAMEP (frame))
        continue;
      f = XFRAME (frame);
Karl Heuer's avatar
Karl Heuer committed
190
      if (f->output_data.nothing == 1)
Richard M. Stallman's avatar
Richard M. Stallman committed
191
	continue;
192
      if (f->output_data.x->id == id)
Richard M. Stallman's avatar
Richard M. Stallman committed
193
	return f;
194
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
195
  return 0;
196
}
Richard M. Stallman's avatar
Richard M. Stallman committed
197 198

#endif
199

200 201 202 203 204 205 206 207 208 209
/* 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);
210 211
    }

212 213
  menu_items_used = 0;
  menu_items_n_panes = 0;
214
  menu_items_submenu_depth = 0;
215
}
216

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

220 221 222 223
static void
finish_menu_items ()
{
}
224

225 226
/* Call when finished using the data for the current menu
   in menu_items.  */
227

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

240 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
/* 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--;
}

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

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

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

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

307 308 309
/* 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
310 311 312 313
   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).  */
314

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

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

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

354 355 356 357
  /* 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;
358

359
  def = Fcdr (item1);
360

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

373 374
  GCPRO4 (def, def1, savedkey, descrip);

375 376 377 378 379 380
  /* Is it still valid?  */
  def1 = Qnil;
  if (!NILP (savedkey))
    def1 = Fkey_binding (savedkey, Qnil);
  /* If not, update it.  */
  if (! EQ (def1, def)
381 382
      /* If the command is an alias for another
         (such as easymenu.el and lmenu.el set it up),
383
         check if the original command matches the cached command.  */
384 385
      && !(SYMBOLP (def) && SYMBOLP (XSYMBOL (def)->function)
           && EQ (def1, XSYMBOL (def)->function))
386 387 388 389 390 391 392
      /* 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)))))
393
    {
394 395
      changed = 1;
      descrip = Qnil;
396 397 398 399 400 401
      /* 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);
402 403 404 405 406
      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);

407 408 409 410 411 412
      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
413
    }
414

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

427
  UNGCPRO;
428 429
  *descrip_ptr = descrip;
  return def;
430 431
}

432 433 434 435 436
/* This is used as the handler when calling internal_condition_case_1.  */

static Lisp_Object
menu_item_enabled_p_1 (arg)
     Lisp_Object arg;
437
{
438 439 440 441 442
  /* 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);

443
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
444 445
}

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

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

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

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

487
  init_menu_items ();
488

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

  finish_menu_items ();
}

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

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

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

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

		  def = menu_item_equiv_key (item_string, item1, &descrip);
550 551
		  enabled = menu_item_enabled_p (def, notreal);

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

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

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

		      def = menu_item_equiv_key (item_string, item1, &descrip);
622
		      enabled = menu_item_enabled_p (def, notreal);
623

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

  /* Process now any submenus which want to be panes at this level.  */
  while (!NILP (pending_maps))
    {
665
      Lisp_Object elt, eltcdr, string;
666 667
      elt = Fcar (pending_maps);
      eltcdr = XCONS (elt)->cdr;
668 669 670 671 672
      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);
673 674
      pending_maps = Fcdr (pending_maps);
    }
675
}
676

Karl Heuer's avatar
Karl Heuer committed
677
/* Push all the panes and items of a menu described by the
678 679
   alist-of-alists MENU.
   This handles old-fashioned calls to x-popup-menu.  */
680

681 682
static void
list_of_panes (menu)
683 684
     Lisp_Object menu;
{
685 686 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
  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))
716
	push_menu_item (item, Qnil, Qnil, Qt, Qnil);
717 718
      else if (NILP (item))
	push_left_right_boundary ();
719 720 721 722 723
      else
	{
	  CHECK_CONS (item, 0);
	  item1 = Fcar (item);
	  CHECK_STRING (item1, 1);
724
	  push_menu_item (item1, Qt, Fcdr (item), Qt, Qnil);
725 726 727 728
	}
    }
}

729
DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0,
730 731 732
  "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\
733
where XOFFSET and YOFFSET are positions in pixels from the top left\n\
734 735 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
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;
762
  Lisp_Object keymap, tem;
763 764 765 766
  int xpos, ypos;
  Lisp_Object title;
  char *error_name;
  Lisp_Object selection;
767
  int i, j;
768 769 770
  FRAME_PTR f;
  Lisp_Object x, y, window;
  int keymaps = 0;
771
  int for_click = 0;
772 773 774 775
  struct gcpro gcpro1;

  if (! NILP (position))
    {
776 777
      check_x ();

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

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

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

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

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

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

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

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

      title = Qnil;
885 886 887

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

892 893 894
	  maps[i++] = keymap = get_keymap (Fcar (tem));

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

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

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

914
      list_of_panes (Fcdr (menu));
915

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

926 927
  /* Display them in a menu.  */
  BLOCK_INPUT;
928

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

933
  discard_menu_items ();
934

935
  UNGCPRO;
936

937 938
  if (error_name) error (error_name);
  return selection;
939
}
940

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

  check_x ();

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

976
      (*mouse_position_hook) (&new_f, 1, &bar_window, &part, &x, &y, &time);
977