xmenu.c 65.2 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
extern Lisp_Object Qmenu_enable;
86
extern Lisp_Object Qmenu_bar;
87
extern Lisp_Object Qmouse_click, Qevent_kind;
88

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

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

97 98 99 100 101 102 103 104
static Lisp_Object xmenu_show ();
static void keymap_panes ();
static void single_keymap_panes ();
static void list_of_panes ();
static void list_of_items ();

/* This holds a Lisp vector that holds the results of decoding
   the keymaps or alist-of-alists that specify a menu.
Jim Blandy's avatar
Jim Blandy committed
105

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

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

114 115 116 117 118
   In some cases, multiple levels of menus may be described.
   A single vector slot containing nil indicates the start of a submenu.
   A single vector slot containing lambda indicates the end of a submenu.
   The submenu follows a menu item which is the way to reach the submenu.

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

122 123
   Using a Lisp vector to hold this information while we decode it
   takes care of protecting all the data from GC.  */
Jim Blandy's avatar
Jim Blandy committed
124

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

129 130 131 132
#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
133 134
#define MENU_ITEMS_ITEM_DEFINITION 4
#define MENU_ITEMS_ITEM_LENGTH 5
135

136
static Lisp_Object menu_items;
137

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

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

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

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

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

155 156 157 158 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
/* 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);
  
193
  frame_vector = new;
194 195 196
  XVECTOR (frame_vector)->contents[length] = frame;
  return length;
}
197

198 199 200 201 202 203 204 205 206 207
/* 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);
208 209
    }

210 211
  menu_items_used = 0;
  menu_items_n_panes = 0;
212
  menu_items_submenu_depth = 0;
213
}
214

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

218 219 220 221
static void
finish_menu_items ()
{
}
222

223 224
/* Call when finished using the data for the current menu
   in menu_items.  */
225

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

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

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

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

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

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

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

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

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

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

352 353 354 355
  /* 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;
356

357
  def = Fcdr (item1);
358

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

371 372
  GCPRO4 (def, def1, savedkey, descrip);

373 374 375 376 377 378
  /* Is it still valid?  */
  def1 = Qnil;
  if (!NILP (savedkey))
    def1 = Fkey_binding (savedkey, Qnil);
  /* If not, update it.  */
  if (! EQ (def1, def)
379 380
      /* If the command is an alias for another
         (such as easymenu.el and lmenu.el set it up),
381
         check if the original command matches the cached command.  */
382 383
      && !(SYMBOLP (def) && SYMBOLP (XSYMBOL (def)->function)
           && EQ (def1, XSYMBOL (def)->function))
384 385 386
      /* If something had no key binding before, don't recheck it--
	 doing that takes too much time and makes menus too slow.  */
      && !(!NILP (cachelist) && NILP (savedkey)))
387
    {
388 389
      changed = 1;
      descrip = Qnil;
390 391 392 393 394 395
      /* 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);
396 397 398 399 400
      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);

401 402 403 404 405 406
      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
407
    }
408

409 410
  /* 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
411 412 413 414
    {
      CHECK_IMPURE (item1);
      XCONS (item1)->cdr = Fcons (Fcons (savedkey, descrip), def);
    }
415
  else if (changed)
Jim Blandy's avatar
Jim Blandy committed
416
    {
417 418
      XCONS (cachelist)->car = savedkey;
      XCONS (cachelist)->cdr = descrip;
Jim Blandy's avatar
Jim Blandy committed
419
    }
420

421
  UNGCPRO;
422 423
  *descrip_ptr = descrip;
  return def;
424 425
}

426 427 428 429 430
/* This is used as the handler when calling internal_condition_case_1.  */

static Lisp_Object
menu_item_enabled_p_1 (arg)
     Lisp_Object arg;
431
{
432
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
433 434
}

435
/* Return non-nil if the command DEF is enabled when used as a menu item.
436 437
   This is based on looking for a menu-enable property.
   If NOTREAL is set, don't bother really computing this.  */
438 439

static Lisp_Object
440
menu_item_enabled_p (def, notreal)
441
     Lisp_Object def;
442
     int notreal;
443
{
444
  Lisp_Object enabled, tem;
445

446
  enabled = Qt;
447 448
  if (notreal)
    return enabled;
449
  if (SYMBOLP (def))
450 451 452 453 454 455 456 457 458 459 460 461 462 463
    {
      /* 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,
464 465 466
   and generate menu panes for them in menu_items.
   If NOTREAL is nonzero,
   don't bother really computing whether an item is enabled.  */
467

468
static void
469
keymap_panes (keymaps, nmaps, notreal)
470 471
     Lisp_Object *keymaps;
     int nmaps;
472
     int notreal;
473
{
474
  int mapno;
475

476
  init_menu_items ();
477

478 479 480 481
  /* 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++)
482
    single_keymap_panes (keymaps[mapno], Qnil, Qnil, notreal);
483 484 485 486 487 488 489

  finish_menu_items ();
}

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

static void
495
single_keymap_panes (keymap, pane_name, prefix, notreal)
496 497 498
     Lisp_Object keymap;
     Lisp_Object pane_name;
     Lisp_Object prefix;
499
     int notreal;
500 501 502 503 504 505 506 507 508
{
  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);

509
  for (tail = keymap; CONSP (tail); tail = XCONS (tail)->cdr)
510
    {
511 512 513
      /* Look at each key binding, and if it has a menu string,
	 make a menu item from it.  */
      item = XCONS (tail)->car;
514
      if (CONSP (item))
515
	{
516
	  item1 = XCONS (item)->cdr;
517
	  if (CONSP (item1))
518 519
	    {
	      item_string = XCONS (item1)->car;
520
	      if (STRINGP (item_string))
521 522 523 524 525 526 527 528
		{
		  /* 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;

529 530
		  /* GCPRO because ...enabled_p will call eval
		     and ..._equiv_key may autoload something.
531 532 533 534
		     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.  */
535
		  descrip = def = Qnil;
536
		  GCPRO4 (keymap, pending_maps, def, descrip);
537 538

		  def = menu_item_equiv_key (item_string, item1, &descrip);
539 540
		  enabled = menu_item_enabled_p (def, notreal);

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

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

601 602
		      /* GCPRO because ...enabled_p will call eval
			 and ..._equiv_key may autoload something.
603 604 605 606 607
			 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);
608 609 610
		      descrip = def = Qnil;

		      def = menu_item_equiv_key (item_string, item1, &descrip);
611
		      enabled = menu_item_enabled_p (def, notreal);
612

613 614 615 616 617 618 619 620 621
		      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
622 623
			{
			  Lisp_Object submap;
624
			  GCPRO4 (keymap, pending_maps, descrip, item_string);
625
			  submap = get_keymap_1 (def, 0, 1);
626
			  UNGCPRO;
627 628 629 630 631
#ifndef USE_X_TOOLKIT
			  if (!NILP (submap))
			    item_string = concat2 (item_string,
						   build_string (" >"));
#endif
632
			  /* If definition is nil, pass nil as the key.  */
633
			  push_menu_item (item_string, enabled, character,
634
					  def, descrip);
635 636 637 638 639 640 641 642 643 644
#ifdef USE_X_TOOLKIT
			  if (! NILP (submap))
			    {
			      push_submenu_start ();
			      single_keymap_panes (submap, Qnil,
						   character, notreal);
			      push_submenu_end ();
			    }
#endif
			}
645 646 647
		    }
		}
	    }
648 649
	}
    }
650 651 652 653

  /* Process now any submenus which want to be panes at this level.  */
  while (!NILP (pending_maps))
    {
654
      Lisp_Object elt, eltcdr, string;
655 656
      elt = Fcar (pending_maps);
      eltcdr = XCONS (elt)->cdr;
657 658 659 660 661
      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);
662 663
      pending_maps = Fcdr (pending_maps);
    }
664
}
665 666 667 668

/* 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.  */
669

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

  if (! NILP (position))
    {
765 766
      check_x ();

767
      /* Decode the first argument: find the window and the coordinates.  */
768 769
      if (EQ (position, Qt)
	  || (CONSP (position) && EQ (XCONS (position)->car, Qmenu_bar)))
770 771
	{
	  /* Use the mouse's current position.  */
772
	  FRAME_PTR new_f = selected_frame;
773 774 775 776
	  Lisp_Object bar_window;
	  int part;
	  unsigned long time;

777
	  if (mouse_position_hook)
778 779
	    (*mouse_position_hook) (&new_f, 1, &bar_window,
				    &part, &x, &y, &time);
780
	  if (new_f != 0)
781
	    XSETFRAME (window, new_f);
782 783 784
	  else
	    {
	      window = selected_window;
785 786
	      XSETFASTINT (x, 0);
	      XSETFASTINT (y, 0);
787
	    }
788 789 790 791
	}
      else
	{
	  tem = Fcar (position);
792
	  if (CONSP (tem))
793 794 795 796 797 798 799
	    {
	      window = Fcar (Fcdr (position));
	      x = Fcar (tem);
	      y = Fcar (Fcdr (tem));
	    }
	  else
	    {
800
	      for_click = 1;
801 802 803 804 805 806 807 808 809 810 811 812 813
	      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.  */

814
      if (FRAMEP (window))
815 816 817 818 819
	{
	  f = XFRAME (window);
	  xpos = 0;
	  ypos = 0;
	}
820
      else if (WINDOWP (window))
821 822 823 824 825
	{
	  CHECK_LIVE_WINDOW (window, 0);
	  f = XFRAME (WINDOW_FRAME (XWINDOW (window)));

	  xpos = (FONT_WIDTH (f->display.x->font) * XWINDOW (window)->left);
826
	  ypos = (f->display.x->line_height * XWINDOW (window)->top);
827 828 829 830 831 832 833 834 835 836 837 838 839 840
	}
      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.  */
841 842 843

  keymap = Fkeymapp (menu);
  tem = Qnil;
844
  if (CONSP (menu))
845 846 847 848 849 850 851
    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);

852
      /* Extract the detailed info to make one pane.  */
853
      keymap_panes (&menu, 1, NILP (position));
854

855 856 857 858
      /* Search for a string appearing directly as an element of the keymap.
	 That string is the title of the menu.  */
      prompt = map_prompt (keymap);

859 860 861 862 863
      /* 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;
864 865 866 867 868 869 870 871
    }
  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;
872 873

      title = Qnil;
874 875 876

      /* The first keymap that has a prompt string
	 supplies the menu title.  */
877
      for (tem = menu, i = 0; CONSP (tem); tem = Fcdr (tem))
878
	{
879 880
	  Lisp_Object prompt;

881 882 883
	  maps[i++] = keymap = get_keymap (Fcar (tem));

	  prompt = map_prompt (keymap);
884 885
	  if (NILP (title) && !NILP (prompt))
	    title = prompt;
886 887 888
	}

      /* Extract the detailed info to make one pane.  */
889
      keymap_panes (maps, nmaps, NILP (position));
890 891 892 893 894 895

      /* 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;
896 897 898 899
    }
  else
    {
      /* We were given an old-fashioned menu.  */
900 901
      title = Fcar (menu);
      CHECK_STRING (title, 1);
902

903
      list_of_panes (Fcdr (menu));
904

905 906
      keymaps = 0;
    }
907
  
908
  if (NILP (position))
909
    {
910 911 912
      discard_menu_items ();
      UNGCPRO;
      return Qnil;
913 914
    }

915 916
  /* Display them in a menu.  */
  BLOCK_INPUT;
917

918
  selection = xmenu_show (f, xpos, ypos, for_click,
919 920
			  keymaps, title, &error_name);
  UNBLOCK_INPUT;
921

922
  discard_menu_items ();
923

924
  UNGCPRO;
925

926 927
  if (error_name) error (error_name);
  return selection;
928
}
929

930
DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 2, 0,
931
  "Pop up a dialog box and return user's selection.\n\
932 933 934 935
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\
936
\n\
937 938 939
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\
940 941 942 943 944
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.)")
945 946
  (position, contents)
     Lisp_Object position, contents;
947 948
{
  FRAME_PTR f;
949
  Lisp_Object window;
950 951 952

  check_x ();

953
  /* Decode the first argument: find the window or frame to use.  */
954 955
  if (EQ (position, Qt)
      || (CONSP (position) && EQ (XCONS (position)->car, Qmenu_bar)))
956
    {
957
#if 0 /* Using the frame the mouse is on may not be right.  */
958
      /* Use the mouse's current position.  */
959
      FRAME_PTR new_f = selected_frame;
960 961 962 963
      Lisp_Object bar_window;
      int part;
      unsigned long time;
      Lisp_Object x, y;
964

965
      (*mouse_position_hook) (&new_f, 1, &bar_window, &part, &x, &y, &time);
966

967
      if (new_f != 0)
968
	XSETFRAME (window, new_f);
969 970
      else
	window = selected_window;
971
#endif
972
      window = selected_window;
973 974 975 976 977
    }
  else if (CONSP (position))
    {
      Lisp_Object tem;
      tem = Fcar (position);
978
      if (CONSP (tem))
979
	window = Fcar (Fcdr (position));
980 981
      else
	{
982 983
	  tem = Fcar (Fcdr (position));  /* EVENT_START (position) */
	  window = Fcar (tem);	     /* POSN_WINDOW (tem) */
984 985
	}
    }
986 987
  else if (WINDOWP (position) || FRAMEP (position))
    window = position;
988

989
  /* Decode where to put the menu.  */
990

991
  if (FRAMEP (window))
992
    f = XFRAME (window);
993
  else if (WINDOWP (window))
994
    {
995 996
      CHECK_LIVE_WINDOW (window, 0);
      f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
997
    }
998 999 1000 1001
  else
    /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
       but I don't want to make one now.  */
    CHECK_WINDOW (window, 0);
1002

1003 1004 1005 1006 1007
#ifndef USE_X_TOOLKIT
  /* Display a menu with these alternatives
     in the middle of frame F.  */
  {
    Lisp_Object x, y, frame, newpos;
1008 1009 1010
    XSETFRAME (frame, f);
    XSETINT (x, x_pixel_width (f) / 2);
    XSETINT (y, x_pixel_height (f) / 2);
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
    newpos = Fcons (Fcons (x, Fcons (y, Qnil)), Fcons (frame, Qnil));

    return Fx_popup_menu (newpos,
			  Fcons (Fcar (contents), Fcons (contents, Qnil)));
  }
#else
  {
    Lisp_Object title;
    char *error_name;
    Lisp_Object selection;
1021

1022 1023 1024
    /* Decode the dialog items from what was specified.  */
    title = Fcar (contents);
    CHECK_STRING (title, 1);
1025

1026
    list_of_panes (Fcons (contents, Qnil));
1027

1028 1029
    /* Display them in a dialog box.  */
    BLOCK_INPUT;
1030
    selection = xdialog_show (f, 0, title, &error_name);
1031
    UNBLOCK_INPUT;
1032

1033 1034 1035 1036 1037
    discard_menu_items ();

    if (error_name) error (error_name);
    return selection;
  }
1038
#endif
1039
}
1040 1041

#ifdef USE_X_TOOLKIT
1042

1043
/* Loop in Xt until the menu pulldown or dialog popup has been
1044 1045
   popped down (deactivated).

1046
   NOTE: All calls to popup_get_selection should be protected
1047
   with BLOCK_INPUT, UNBLOCK_INPUT wrappers.  */
1048

1049
void
1050
popup_get_selection (initial_event, dpyinfo, id)
1051
     XEvent *initial_event;
1052
     struct x_display_info *dpyinfo;
1053
     LWLIB_ID id;
1054
{
1055
  XEvent event;
1056

1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
  /* Define a queue to save up for later unreading
     all X events that don't pertain to the menu.  */
  struct event_queue
    {
      XEvent event;
      struct event_queue *next;
    };
  
  struct event_queue *queue = NULL;
  struct event_queue *queue_tmp;

1068 1069 1070 1071
  if (initial_event)
    event = *initial_event;
  else
    XtAppNextEvent (Xt_app_con, &event);
Richard M. Stallman's avatar