xmenu.c 56.9 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* X Communication module for terminals which understand the X protocol.
2
   Copyright (C) 1986, 1988, 1993, 1994 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */

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

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

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

Jim Blandy's avatar
Jim Blandy committed
32 33 34 35
#include <stdio.h>

/* On 4.3 this loses if it comes after xterm.h.  */
#include <signal.h>
36
#include <config.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"
Jim Blandy's avatar
Jim Blandy committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

/* This may include sys/types.h, and that somehow loses
   if this is not done before the other system files.  */
#include "xterm.h"

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

#include "dispextern.h"

#ifdef HAVE_X11
#include "../oldXMenu/XMenu.h"
#else
#include <X/XMenu.h>
#endif

62 63 64 65 66 67 68 69 70 71
#ifdef USE_X_TOOLKIT
#include <X11/Xlib.h>
#include <X11/IntrinsicP.h>
#include <X11/CoreP.h>
#include <X11/StringDefs.h>
#include <X11/Xaw/Paned.h>
#include "../lwlib/lwlib.h"
#include "../lwlib/xlwmenuP.h"
#endif /* USE_X_TOOLKIT */

Jim Blandy's avatar
Jim Blandy committed
72 73 74 75 76 77
#define min(x,y) (((x) < (y)) ? (x) : (y))
#define max(x,y) (((x) > (y)) ? (x) : (y))

#ifndef TRUE
#define TRUE 1
#define FALSE 0
78
#endif /* no TRUE */
Jim Blandy's avatar
Jim Blandy committed
79 80 81 82 83 84 85

#ifdef HAVE_X11
extern Display *x_current_display;
#else
#define	ButtonReleaseMask ButtonReleased
#endif /* not HAVE_X11 */

86 87 88
/* We need a unique id for each popup menu and dialog box.  */
static unsigned int popup_id_tick;

89
extern Lisp_Object Qmenu_enable;
90
extern Lisp_Object Qmenu_bar;
91

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

96
static int string_width ();
97
static Lisp_Object xdialog_show ();
98 99
#endif

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

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

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

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

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

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

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

132 133 134 135 136
#define MENU_ITEMS_ITEM_NAME 0
#define MENU_ITEMS_ITEM_ENABLE 1
#define MENU_ITEMS_ITEM_VALUE 2
#define MENU_ITEMS_ITEM_EQUIV_KEY 3
#define MENU_ITEMS_ITEM_LENGTH 4
137

138
static Lisp_Object menu_items;
139

140 141
/* Number of slots currently allocated in menu_items.  */
static int menu_items_allocated;
142

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

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

150 151 152
/* Current depth within submenus.  */
static int menu_items_submenu_depth;

153 154 155 156 157 158 159 160 161 162
/* 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);
163 164
    }

165 166
  menu_items_used = 0;
  menu_items_n_panes = 0;
167
  menu_items_submenu_depth = 0;
168
}
169

170 171
/* Call at the end of generating the data in menu_items.
   This fills in the number of items in the last pane.  */
172

173 174 175 176
static void
finish_menu_items ()
{
}
177

178 179
/* Call when finished using the data for the current menu
   in menu_items.  */
180

181 182 183 184 185 186 187 188 189 190 191
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;
    }
}
192

193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
/* 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--;
}

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

243 244
/* Start a new menu pane in menu_items..
   NAME is the pane name.  PREFIX_VEC is a prefix key for this pane.  */
245

246 247 248 249 250
static void
push_menu_pane (name, prefix_vec)
     Lisp_Object name, prefix_vec;
{
  if (menu_items_used + MENU_ITEMS_PANE_LENGTH > menu_items_allocated)
251
    grow_menu_items ();
Jim Blandy's avatar
Jim Blandy committed
252

253 254
  if (menu_items_submenu_depth == 0)
    menu_items_n_panes++;
255 256 257 258
  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
259

260 261 262 263 264
/* Push one menu item into the current pane.
   NAME is the string to display.  ENABLE if non-nil means
   this item can be selected.  KEY is the key generated by
   choosing this item.  EQUIV is the textual description
   of the keyboard equivalent for this item (or nil if none).  */
265

266 267 268 269 270
static void
push_menu_item (name, enable, key, equiv)
     Lisp_Object name, enable, key, equiv;
{
  if (menu_items_used + MENU_ITEMS_ITEM_LENGTH > menu_items_allocated)
271
    grow_menu_items ();
272

273 274 275 276 277 278 279 280 281 282 283 284
  XVECTOR (menu_items)->contents[menu_items_used++] = name;
  XVECTOR (menu_items)->contents[menu_items_used++] = enable;
  XVECTOR (menu_items)->contents[menu_items_used++] = key;
  XVECTOR (menu_items)->contents[menu_items_used++] = equiv;
}

/* Figure out the current keyboard equivalent of a menu item ITEM1.
   The item string for menu display should be ITEM_STRING.
   Store the equivalent keyboard key sequence's
   textual description into *DESCRIP_PTR.
   Also cache them in the item itself.
   Return the real definition to execute.  */
285

286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301
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;
302

303 304 305 306
  /* 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;
307

308
  def = Fcdr (item1);
309

310 311 312 313 314
  /* 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)))
315
    {
316 317 318 319
      cachelist = XCONS (def)->car;
      def = XCONS (def)->cdr;
      savedkey = XCONS (cachelist)->car;
      descrip = XCONS (cachelist)->cdr;
320
    }
321 322 323 324 325 326 327 328 329 330

  /* Is it still valid?  */
  def1 = Qnil;
  if (!NILP (savedkey))
    def1 = Fkey_binding (savedkey, Qnil);
  /* If not, update it.  */
  if (! EQ (def1, def)
      /* 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)))
331
    {
332 333 334 335 336 337 338 339 340 341 342 343
      changed = 1;
      descrip = Qnil;
      savedkey = Fwhere_is_internal (def, Qnil, Qt, Qnil);
      if (VECTORP (savedkey)
	  && EQ (XVECTOR (savedkey)->contents[0], Qmenu_bar))
	savedkey = Qnil;
      if (!NILP (savedkey))
	{
	  descrip = Fkey_description (savedkey);
	  descrip = concat2 (make_string ("  (", 3), descrip);
	  descrip = concat2 (descrip, make_string (")", 1));
	}
Jim Blandy's avatar
Jim Blandy committed
344
    }
345

346 347 348 349
  /* Cache the data we just got in a sublist of the menu binding.  */
  if (NILP (cachelist))
    XCONS (item1)->cdr = Fcons (Fcons (savedkey, descrip), def);
  else if (changed)
Jim Blandy's avatar
Jim Blandy committed
350
    {
351 352
      XCONS (cachelist)->car = savedkey;
      XCONS (cachelist)->cdr = descrip;
Jim Blandy's avatar
Jim Blandy committed
353
    }
354

355 356
  *descrip_ptr = descrip;
  return def;
357 358
}

359 360 361 362 363
/* This is used as the handler when calling internal_condition_case_1.  */

static Lisp_Object
menu_item_enabled_p_1 (arg)
     Lisp_Object arg;
364
{
365
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
366 367
}

368
/* Return non-nil if the command DEF is enabled when used as a menu item.
369 370
   This is based on looking for a menu-enable property.
   If NOTREAL is set, don't bother really computing this.  */
371 372

static Lisp_Object
373
menu_item_enabled_p (def, notreal)
374
     Lisp_Object def;
375
{
376
  Lisp_Object enabled, tem;
377

378
  enabled = Qt;
379 380
  if (notreal)
    return enabled;
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
  if (XTYPE (def) == Lisp_Symbol)
    {
      /* 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,
396 397 398
   and generate menu panes for them in menu_items.
   If NOTREAL is nonzero,
   don't bother really computing whether an item is enabled.  */
399

400
static void
401
keymap_panes (keymaps, nmaps, notreal)
402 403
     Lisp_Object *keymaps;
     int nmaps;
404
     int notreal;
405
{
406
  int mapno;
407

408
  init_menu_items ();
409

410 411 412 413
  /* 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++)
414
    single_keymap_panes (keymaps[mapno], Qnil, Qnil, notreal);
415 416 417 418 419 420 421

  finish_menu_items ();
}

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

static void
427
single_keymap_panes (keymap, pane_name, prefix, notreal)
428 429 430
     Lisp_Object keymap;
     Lisp_Object pane_name;
     Lisp_Object prefix;
431
     int notreal;
432 433 434 435 436 437 438 439 440 441
{
  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);

  for (tail = keymap; XTYPE (tail) == Lisp_Cons; tail = XCONS (tail)->cdr)
442
    {
443 444 445 446
      /* Look at each key binding, and if it has a menu string,
	 make a menu item from it.  */
      item = XCONS (tail)->car;
      if (XTYPE (item) == Lisp_Cons)
447
	{
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
	  item1 = XCONS (item)->cdr;
	  if (XTYPE (item1) == Lisp_Cons)
	    {
	      item_string = XCONS (item1)->car;
	      if (XTYPE (item_string) == Lisp_String)
		{
		  /* 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;

		  def = menu_item_equiv_key (item_string, item1, &descrip);

		  /* GCPRO because we will call eval.
		     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);
469 470
		  enabled = menu_item_enabled_p (def, notreal);

471 472 473 474 475 476 477 478 479
		  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
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
		    {
		      Lisp_Object submap;
		      submap = get_keymap_1 (def, 0, 1);
#ifndef USE_X_TOOLKIT
		      /* Indicate visually that this is a submenu.  */
		      if (!NILP (submap))
			item_string = concat2 (item_string,
					       build_string (" >"));
#endif
		      push_menu_item (item_string, enabled, XCONS (item)->car,
				      descrip);
#ifdef USE_X_TOOLKIT
		      /* Display a submenu using the toolkit.  */
		      if (! NILP (submap))
			{
			  push_submenu_start ();
			  single_keymap_panes (submap, Qnil,
					       XCONS (item)->car, notreal);
			  push_submenu_end ();
			}
#endif
		    }
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
		}
	    }
	}
      else if (XTYPE (item) == Lisp_Vector)
	{
	  /* 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;
	      XFASTINT (character) = c;
	      item1 = XVECTOR (item)->contents[c];
	      if (XTYPE (item1) == Lisp_Cons)
		{
		  item_string = XCONS (item1)->car;
		  if (XTYPE (item_string) == Lisp_String)
		    {
		      Lisp_Object def;

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

		      def = menu_item_equiv_key (item_string, item1, &descrip);

		      /* GCPRO because we will call eval.
			 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);
535
		      enabled = menu_item_enabled_p (def, notreal);
536 537 538 539 540 541 542 543 544
		      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
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
			{
			  Lisp_Object submap;
			  submap = get_keymap_1 (def, 0, 1);
#ifndef USE_X_TOOLKIT
			  if (!NILP (submap))
			    item_string = concat2 (item_string,
						   build_string (" >"));
#endif
			  push_menu_item (item_string, enabled, character,
					  descrip);
#ifdef USE_X_TOOLKIT
			  if (! NILP (submap))
			    {
			      push_submenu_start ();
			      single_keymap_panes (submap, Qnil,
						   character, notreal);
			      push_submenu_end ();
			    }
#endif
			}
565 566 567
		    }
		}
	    }
568 569
	}
    }
570 571 572 573

  /* Process now any submenus which want to be panes at this level.  */
  while (!NILP (pending_maps))
    {
574
      Lisp_Object elt, eltcdr, string;
575 576
      elt = Fcar (pending_maps);
      eltcdr = XCONS (elt)->cdr;
577 578 579 580 581
      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);
582 583
      pending_maps = Fcdr (pending_maps);
    }
584
}
585 586 587 588

/* 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.  */
589

590 591
static void
list_of_panes (menu)
592 593
     Lisp_Object menu;
{
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
  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))
625
	push_menu_item (item, Qnil, Qnil, Qnil);
626 627
      else if (NILP (item))
	push_left_right_boundary ();
628 629 630 631 632 633 634 635 636 637
      else
	{
	  CHECK_CONS (item, 0);
	  item1 = Fcar (item);
	  CHECK_STRING (item1, 1);
	  push_menu_item (item1, Qt, Fcdr (item), Qnil);
	}
    }
}

638
DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0,
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
  "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\
where XOFFSET and YOFFSET are positions in characters from the top left\n\
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;
671
  Lisp_Object keymap, tem;
672 673 674 675
  int xpos, ypos;
  Lisp_Object title;
  char *error_name;
  Lisp_Object selection;
676
  int i, j;
677 678 679 680 681 682 683 684
  FRAME_PTR f;
  Lisp_Object x, y, window;
  int keymaps = 0;
  int menubarp = 0;
  struct gcpro gcpro1;

  if (! NILP (position))
    {
685 686
      check_x ();

687 688 689 690
      /* Decode the first argument: find the window and the coordinates.  */
      if (EQ (position, Qt))
	{
	  /* Use the mouse's current position.  */
691
	  FRAME_PTR new_f = 0;
692 693 694 695
	  Lisp_Object bar_window;
	  int part;
	  unsigned long time;

696 697 698 699 700 701 702 703
	  if (new_f != 0)
	    XSET (window, Lisp_Frame, new_f);
	  else
	    {
	      window = selected_window;
	      XFASTINT (x) = 0;
	      XFASTINT (y) = 0;
	    }
704 705 706 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 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
	}
      else
	{
	  tem = Fcar (position);
	  if (XTYPE (tem) == Lisp_Cons)
	    {
	      window = Fcar (Fcdr (position));
	      x = Fcar (tem);
	      y = Fcar (Fcdr (tem));
	    }
	  else
	    {
	      tem = Fcar (Fcdr (position));  /* EVENT_START (position) */
	      window = Fcar (tem);	     /* POSN_WINDOW (tem) */
	      tem = Fcar (Fcdr (Fcdr (tem))); /* POSN_WINDOW_POSN (tem) */
	      x = Fcar (tem);
	      y = Fcdr (tem);

	      /* Determine whether this menu is handling a menu bar click.  */
	      tem = Fcar (Fcdr (Fcar (Fcdr (position))));
	      if (XTYPE (Fcar (position)) != Lisp_Cons
		  && CONSP (tem)
		  && EQ (Fcar (tem), Qmenu_bar))
		menubarp = 1;
	    }
	}

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

      /* Decode where to put the menu.  */

      if (XTYPE (window) == Lisp_Frame)
	{
	  f = XFRAME (window);

	  xpos = 0;
	  ypos = 0;
	}
      else if (XTYPE (window) == Lisp_Window)
	{
	  CHECK_LIVE_WINDOW (window, 0);
	  f = XFRAME (WINDOW_FRAME (XWINDOW (window)));

	  xpos = (FONT_WIDTH (f->display.x->font) * XWINDOW (window)->left);
	  ypos = (FONT_HEIGHT (f->display.x->font) * XWINDOW (window)->top);
	}
      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.  */
764 765 766 767 768 769 770 771 772 773 774

  keymap = Fkeymapp (menu);
  tem = Qnil;
  if (XTYPE (menu) == Lisp_Cons)
    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);

775
      /* Extract the detailed info to make one pane.  */
776
      keymap_panes (&menu, 1, NILP (position));
777

778 779 780 781
      /* Search for a string appearing directly as an element of the keymap.
	 That string is the title of the menu.  */
      prompt = map_prompt (keymap);

782 783 784 785 786
      /* 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;
787 788 789 790 791 792 793 794
    }
  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;
795 796

      title = Qnil;
797 798 799 800 801

      /* The first keymap that has a prompt string
	 supplies the menu title.  */
      for (tem = menu, i = 0; XTYPE (tem) == Lisp_Cons; tem = Fcdr (tem))
	{
802 803
	  Lisp_Object prompt;

804 805 806
	  maps[i++] = keymap = get_keymap (Fcar (tem));

	  prompt = map_prompt (keymap);
807 808
	  if (NILP (title) && !NILP (prompt))
	    title = prompt;
809 810 811
	}

      /* Extract the detailed info to make one pane.  */
812
      keymap_panes (maps, nmaps, NILP (position));
813 814 815 816 817 818

      /* 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;
819 820 821 822
    }
  else
    {
      /* We were given an old-fashioned menu.  */
823 824
      title = Fcar (menu);
      CHECK_STRING (title, 1);
825

826
      list_of_panes (Fcdr (menu));
827

828 829
      keymaps = 0;
    }
830
  
831
  if (NILP (position))
832
    {
833 834 835
      discard_menu_items ();
      UNGCPRO;
      return Qnil;
836 837
    }

838 839
  /* Display them in a menu.  */
  BLOCK_INPUT;
840

841 842 843
  selection = xmenu_show (f, xpos, ypos, menubarp,
			  keymaps, title, &error_name);
  UNBLOCK_INPUT;
844

845
  discard_menu_items ();
846

847
  UNGCPRO;
848

849 850
  if (error_name) error (error_name);
  return selection;
851
}
852

853
DEFUN ("x-popup-dialog", Fx_popup_dialog, Sx_popup_dialog, 2, 2, 0,
854
  "Pop up a dialog box and return user's selection.\n\
855 856 857 858
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\
859
\n\
860 861 862
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\
863 864 865 866 867
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.)")
868 869
  (position, contents)
     Lisp_Object position, contents;
870 871
{
  FRAME_PTR f;
872
  Lisp_Object window;
873 874 875

  check_x ();

876 877
  /* Decode the first argument: find the window or frame to use.  */
  if (EQ (position, Qt))
878
    {
879
#if 0 /* Using the frame the mouse is on may not be right.  */
880 881 882 883 884 885
      /* Use the mouse's current position.  */
      FRAME_PTR new_f = 0;
      Lisp_Object bar_window;
      int part;
      unsigned long time;
      Lisp_Object x, y;
886

887
      (*mouse_position_hook) (&new_f, &bar_window, &part, &x, &y, &time);
888

889 890 891 892
      if (new_f != 0)
	XSET (window, Lisp_Frame, new_f);
      else
	window = selected_window;
893 894 895
#endif
      /* Decode the first argument: find the window and the coordinates.  */
      if (EQ (position, Qt))
896
	window = selected_window;
897 898 899 900 901 902 903
    }
  else if (CONSP (position))
    {
      Lisp_Object tem;
      tem = Fcar (position);
      if (XTYPE (tem) == Lisp_Cons)
	window = Fcar (Fcdr (position));
904 905
      else
	{
906 907
	  tem = Fcar (Fcdr (position));  /* EVENT_START (position) */
	  window = Fcar (tem);	     /* POSN_WINDOW (tem) */
908 909
	}
    }
910 911
  else if (WINDOWP (position) || FRAMEP (position))
    window = position;
912

913
  /* Decode where to put the menu.  */
914

915 916 917
  if (XTYPE (window) == Lisp_Frame)
    f = XFRAME (window);
  else if (XTYPE (window) == Lisp_Window)
918
    {
919 920
      CHECK_LIVE_WINDOW (window, 0);
      f = XFRAME (WINDOW_FRAME (XWINDOW (window)));
921
    }
922 923 924 925
  else
    /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
       but I don't want to make one now.  */
    CHECK_WINDOW (window, 0);
926

927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
#ifndef USE_X_TOOLKIT
  /* Display a menu with these alternatives
     in the middle of frame F.  */
  {
    Lisp_Object x, y, frame, newpos;
    XSET (frame, Lisp_Frame, f);
    XSET (x, Lisp_Int, x_pixel_width (f) / 2);
    XSET (y, Lisp_Int, x_pixel_height (f) / 2);
    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;
945

946 947 948
    /* Decode the dialog items from what was specified.  */
    title = Fcar (contents);
    CHECK_STRING (title, 1);
949

950
    list_of_panes (Fcons (contents, Qnil));
951

952 953 954 955
    /* Display them in a dialog box.  */
    BLOCK_INPUT;
    selection = xdialog_show (f, 0, 0, title, &error_name);
    UNBLOCK_INPUT;
956

957 958 959 960 961
    discard_menu_items ();

    if (error_name) error (error_name);
    return selection;
  }
962
#endif
963
}
964 965

#ifdef USE_X_TOOLKIT
966 967

static void
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
dispatch_dummy_expose (w, x, y)
     Widget w;
     int x;
     int y;
{
  XExposeEvent dummy;
	
  dummy.type = Expose;
  dummy.window = XtWindow (w);
  dummy.count = 0;
  dummy.serial = 0;
  dummy.send_event = 0;
  dummy.display = XtDisplay (w);
  dummy.x = x;
  dummy.y = y;

  XtDispatchEvent (&dummy);
}

static int
string_width (mw, s)
     XlwMenuWidget mw;
     char* s;
{
  XCharStruct xcs;
  int drop;
  
  XTextExtents (mw->menu.font, s, strlen (s), &drop, &drop, &drop, &xcs);
  return xcs.width;
}

static int
event_is_in_menu_item (mw, event, name, string_w)
     XlwMenuWidget mw;
     struct input_event *event;
     char *name;
     int *string_w;
{
  *string_w += (string_width (mw, name) 
		+ 2 * (mw->menu.horizontal_spacing
		       + mw->menu.shadow_thickness));
  return XINT (event->x) < *string_w;
}


1013 1014
/* Return the menu bar key which corresponds to event EVENT in frame F.  */

1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
Lisp_Object
map_event_to_object (event, f)
     struct input_event *event;
     FRAME_PTR f;
{
  int i,j, string_w;
  window_state*	ws;
  XlwMenuWidget mw = (XlwMenuWidget) f->display.x->menubar_widget;
  widget_value *val;


  string_w = 0;
  /* Find the window */
  for (val = mw->menu.old_stack [0]->contents; val; val = val->next)
    {
      ws = &mw->menu.windows [0];
      if (ws && event_is_in_menu_item (mw, event, val->name, &string_w))
	{
	  Lisp_Object items;
1034 1035
	  int i;

1036
	  items = FRAME_MENU_BAR_ITEMS (f);
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049

	  for (i = 0; i < XVECTOR (items)->size; i += 3)
	    {
	      Lisp_Object pos, string, item;
	      item = XVECTOR (items)->contents[i];
	      string = XVECTOR (items)->contents[i + 1];
	      pos = XVECTOR (items)->contents[i + 2];
	      if (NILP (string))
		break;

	      if (!strcmp (val->name, XSTRING (string)->data))
		return item;
	    }
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
	}
    }
  return Qnil;
}

static Lisp_Object *menu_item_selection;

static void
popup_selection_callback (widget, id, client_data)
     Widget widget;
     LWLIB_ID id;
     XtPointer client_data;
{
  menu_item_selection = (Lisp_Object *) client_data;
}

static void
popup_down_callback (widget, id, client_data)
     Widget widget;
     LWLIB_ID id;
     XtPointer client_data;
{
1072 1073 1074 1075 1076
  BLOCK_INPUT;
  lw_destroy_all_widgets (id);
  UNBLOCK_INPUT;
}

1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
static void
dialog_selection_callback (widget, id, client_data)
     Widget widget;
     LWLIB_ID id;
     XtPointer client_data;
{
  if ((int)client_data != -1)
    menu_item_selection = (Lisp_Object *) client_data;
  BLOCK_INPUT;
  lw_destroy_all_widgets (id);
  UNBLOCK_INPUT;
}

1090 1091
/* This recursively calls free_widget_value() on the tree of widgets.
   It must free all data that was malloc'ed for these widget_values.
1092 1093 1094
   In Emacs, many slots are pointers into the data of Lisp_Strings, and
   must be left alone.  */

1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
void
free_menubar_widget_value_tree (wv)
     widget_value *wv;
{
  if (! wv) return;

  wv->name = wv->value = wv->key = (char *) 0xDEADBEEF;

  if (wv->contents && (wv->contents != (widget_value*)1))
    {
      free_menubar_widget_value_tree (wv->contents);
      wv->contents = (widget_value *) 0xDEADBEEF;
    }
  if (wv->next)
    {
      free_menubar_widget_value_tree (wv->next);
      wv->next = (widget_value *) 0xDEADBEEF;
    }
  BLOCK_INPUT;
  free_widget_value (wv);
  UNBLOCK_INPUT;
}

1118 1119
extern void EmacsFrameSetCharSize ();

1120
static void
1121
update_frame_menubar (f)
1122 1123 1124
     FRAME_PTR f;
{
  struct x_display *x = f->display.x;
1125
  int columns, rows;
1126 1127 1128 1129 1130 1131 1132 1133 1134
  int menubar_changed;
  
  menubar_changed = (x->menubar_widget
		     && !XtIsManaged (x->menubar_widget));

  if (! (menubar_changed))
    return;

  BLOCK_INPUT;
1135 1136 1137 1138 1139 1140
  /* Save the size of the frame because the pane widget doesn't accept to
     resize itself. So force it.  */
  columns = f->width;
  rows = f->height;


1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
  XawPanedSetRefigureMode (x->column_widget, 0);
  
  /* the order in which children are managed is the top to
     bottom order in which they are displayed in the paned window.
     First, remove the text-area widget.
   */
  XtUnmanageChild (x->edit_widget);

  /* remove the menubar that is there now, and put up the menubar that
     should be there.
   */
  if (menubar_changed)
    {
      XtManageChild (x->menubar_widget);
      XtMapWidget (x->menubar_widget);
      XtVaSetValues (x->menubar_widget, XtNmappedWhenManaged, 1, 0);
    }


  /* Re-manage the text-area widget */
  XtManageChild (x->edit_widget);

  /* and now thrash the sizes */
  XawPanedSetRefigureMode (x->column_widget, 1);
1165 1166 1167 1168

  /* Force the pane widget to resize itself with the right values.  */
  EmacsFrameSetCharSize (x->edit_widget, columns, rows);

1169 1170 1171 1172
  UNBLOCK_INPUT;
}

void
1173
set_frame_menubar (f, first_time)
1174
     FRAME_PTR f;
1175
     int first_time;
1176 1177 1178
{
  Widget menubar_widget = f->display.x->menubar_widget;
  int id = (int) f;
1179
  Lisp_Object tail, items;
1180
  widget_value *wv, *save_wv, *first_wv, *prev_wv = 0;
1181
  int i;
1182 1183 1184 1185 1186 1187 1188 1189 1190

  BLOCK_INPUT;

  wv = malloc_widget_value ();
  wv->name = "menubar";
  wv->value = 0;
  wv->enabled = 1;
  save_wv = first_wv = wv;

1191 1192
  if (NILP (items = FRAME_MENU_BAR_ITEMS (f)))
    items = FRAME_MENU_BAR_ITEMS (f) = menu_bar_items (FRAME_MENU_BAR_ITEMS (f));
1193

1194
  for (i = 0; i < XVECTOR (items)->size; i += 3)
1195 1196 1197
    {
      Lisp_Object string;

1198 1199 1200
      string = XVECTOR (items)->contents[i + 1];
      if (NILP (string))
	break;
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231

      wv = malloc_widget_value ();
      if (prev_wv) 
	prev_wv->next = wv;
      else 
	save_wv->contents = wv;
      wv->name = XSTRING (string)->data;
      wv->value = 0;
      wv->enabled = 1;
      prev_wv = wv;