xmenu.c 71.5 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"
Richard M. Stallman's avatar
Richard M. Stallman committed
44
#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
45

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

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

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

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

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

88 89
Lisp_Object Qdebug_on_next_call;

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

94 95
extern Lisp_Object Vdefine_key_rebound_commands;

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

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

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

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

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

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

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

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

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

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

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

151
static Lisp_Object menu_items;
152

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

358
  def = Fcdr (item1);
359

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

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

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

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

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

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

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

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

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

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

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

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

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

486
  init_menu_items ();
487

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

  finish_menu_items ();
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      title = Qnil;
884 885 886

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

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

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

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

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

913
      list_of_panes (Fcdr (menu));
914

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

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

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

932
  discard_menu_items ();
933

934
  UNGCPRO;
935

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

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

  check_x ();

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

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

977
      if (new_f != 0)