menu.c 44.2 KB
Newer Older
1
/* Platform-independent code for terminal communications.
2

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1986, 1988, 1993-1994, 1996, 1999-2019 Free Software
4
Foundation, Inc.
5 6 7 8 9

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
10 11
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
12 13 14 15 16 17 18

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
19
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.  */
20 21 22

#include <config.h>
#include <stdio.h>
23
#include <limits.h> /* for INT_MAX */
24 25

#include "lisp.h"
26 27
#include "character.h"
#include "coding.h"
28 29 30
#include "keyboard.h"
#include "keymap.h"
#include "frame.h"
31
#include "window.h"
32 33
#include "termhooks.h"
#include "blockinput.h"
34
#include "buffer.h"
35 36 37 38 39

#ifdef USE_X_TOOLKIT
#include "../lwlib/lwlib.h"
#endif

40 41 42
#ifdef HAVE_WINDOW_SYSTEM
#include TERM_HEADER
#endif /* HAVE_WINDOW_SYSTEM */
43 44 45 46 47

#ifdef HAVE_NTGUI
extern AppendMenuW_Proc unicode_append_menu;
#endif /* HAVE_NTGUI  */

Andreas Schwab's avatar
Andreas Schwab committed
48
#include "menu.h"
49

50 51 52 53
/* Return non-zero if menus can handle radio and toggle buttons.  */
static bool
have_boxes (void)
{
54
#if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NTGUI) || defined(HAVE_NS)
55 56
  if (FRAME_WINDOW_P (XFRAME (Vmenu_updating_frame)))
    return 1;
57
#endif
58 59
  return 0;
}
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80

Lisp_Object menu_items;

/* If non-nil, means that the global vars defined here are already in use.
   Used to detect cases where we try to re-enter this non-reentrant code.  */
Lisp_Object menu_items_inuse;

/* Number of slots currently allocated in menu_items.  */
int menu_items_allocated;

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

/* The number of panes currently recorded in menu_items,
   excluding those within submenus.  */
int menu_items_n_panes;

/* Current depth within submenus.  */
static int menu_items_submenu_depth;

void
81
init_menu_items (void)
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
{
  if (!NILP (menu_items_inuse))
    error ("Trying to use a menu from within a menu-entry");

  if (NILP (menu_items))
    {
      menu_items_allocated = 60;
      menu_items = Fmake_vector (make_number (menu_items_allocated), Qnil);
    }

  menu_items_inuse = Qt;
  menu_items_used = 0;
  menu_items_n_panes = 0;
  menu_items_submenu_depth = 0;
}

/* Call at the end of generating the data in menu_items.  */

void
101
finish_menu_items (void)
102 103 104
{
}

105 106
void
unuse_menu_items (void)
107
{
108
  menu_items_inuse = Qnil;
109 110 111 112 113 114
}

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

void
115
discard_menu_items (void)
116 117 118 119 120 121 122 123
{
  /* 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;
    }
124
  eassert (NILP (menu_items_inuse));
125 126 127 128 129
}

/* This undoes save_menu_items, and it is called by the specpdl unwind
   mechanism.  */

130
static void
131
restore_menu_items (Lisp_Object saved)
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
{
  menu_items = XCAR (saved);
  menu_items_inuse = (! NILP (menu_items) ? Qt : Qnil);
  menu_items_allocated = (VECTORP (menu_items) ? ASIZE (menu_items) : 0);
  saved = XCDR (saved);
  menu_items_used = XINT (XCAR (saved));
  saved = XCDR (saved);
  menu_items_n_panes = XINT (XCAR (saved));
  saved = XCDR (saved);
  menu_items_submenu_depth = XINT (XCAR (saved));
}

/* Push the whole state of menu_items processing onto the specpdl.
   It will be restored when the specpdl is unwound.  */

void
148
save_menu_items (void)
149 150 151 152 153 154 155 156 157 158 159
{
  Lisp_Object saved = list4 (!NILP (menu_items_inuse) ? menu_items : Qnil,
			     make_number (menu_items_used),
			     make_number (menu_items_n_panes),
			     make_number (menu_items_submenu_depth));
  record_unwind_protect (restore_menu_items, saved);
  menu_items_inuse = Qnil;
  menu_items = Qnil;
}


160
/* Ensure that there is room for ITEMS items in the menu_items vector.  */
161 162

static void
163
ensure_menu_items (int items)
164
{
165
  int incr = items - (menu_items_allocated - menu_items_used);
166
  if (incr > 0)
167 168 169 170
    {
      menu_items = larger_vector (menu_items, incr, INT_MAX);
      menu_items_allocated = ASIZE (menu_items);
    }
171 172
}

173 174 175
#if (defined USE_X_TOOLKIT || defined USE_GTK || defined HAVE_NS \
     || defined HAVE_NTGUI)

176 177 178
/* Begin a submenu.  */

static void
179
push_submenu_start (void)
180
{
181
  ensure_menu_items (1);
182 183
  ASET (menu_items, menu_items_used, Qnil);
  menu_items_used++;
184 185 186 187 188 189
  menu_items_submenu_depth++;
}

/* End a submenu.  */

static void
190
push_submenu_end (void)
191
{
192
  ensure_menu_items (1);
193 194
  ASET (menu_items, menu_items_used, Qlambda);
  menu_items_used++;
195 196 197
  menu_items_submenu_depth--;
}

198 199
#endif /* USE_X_TOOLKIT || USE_GTK || HAVE_NS || defined HAVE_NTGUI */

200 201 202
/* Indicate boundary between left and right.  */

static void
203
push_left_right_boundary (void)
204
{
205
  ensure_menu_items (1);
206 207
  ASET (menu_items, menu_items_used, Qquote);
  menu_items_used++;
208 209 210 211 212
}

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

213
static void
214
push_menu_pane (Lisp_Object name, Lisp_Object prefix_vec)
215
{
216
  ensure_menu_items (MENU_ITEMS_PANE_LENGTH);
217 218
  if (menu_items_submenu_depth == 0)
    menu_items_n_panes++;
219 220 221 222 223 224
  ASET (menu_items, menu_items_used, Qt);
  menu_items_used++;
  ASET (menu_items, menu_items_used, name);
  menu_items_used++;
  ASET (menu_items, menu_items_used, prefix_vec);
  menu_items_used++;
225 226 227 228 229 230 231 232 233 234
}

/* 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, 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).  TYPE is the type of this menu
   item, one of nil, `toggle' or `radio'. */

235
static void
236
push_menu_item (Lisp_Object name, Lisp_Object enable, Lisp_Object key, Lisp_Object def, Lisp_Object equiv, Lisp_Object type, Lisp_Object selected, Lisp_Object help)
237
{
238
  ensure_menu_items (MENU_ITEMS_ITEM_LENGTH);
239

240 241 242 243 244 245 246 247 248 249
  ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_NAME,	name);
  ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_ENABLE,	enable);
  ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_VALUE,	key);
  ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_EQUIV_KEY, equiv);
  ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_DEFINITION, def);
  ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_TYPE,	type);
  ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_SELECTED,	selected);
  ASET (menu_items, menu_items_used + MENU_ITEMS_ITEM_HELP,	help);

  menu_items_used += MENU_ITEMS_ITEM_LENGTH;
250 251 252 253 254 255
}

/* Args passed between single_keymap_panes and single_menu_item.  */
struct skp
  {
     Lisp_Object pending_maps;
256
     int maxdepth;
257 258 259
     int notbuttons;
  };

260 261
static void single_menu_item (Lisp_Object, Lisp_Object, Lisp_Object,
                              void *);
262 263 264 265 266 267 268 269

/* This is a recursive subroutine of keymap_panes.
   It handles one keymap, KEYMAP.
   The other arguments are passed along
   or point to local variables of the previous function.

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

270
static void
271 272
single_keymap_panes (Lisp_Object keymap, Lisp_Object pane_name,
		     Lisp_Object prefix, int maxdepth)
273 274 275 276 277 278 279 280 281 282 283 284
{
  struct skp skp;

  skp.pending_maps = Qnil;
  skp.maxdepth = maxdepth;
  skp.notbuttons = 0;

  if (maxdepth <= 0)
    return;

  push_menu_pane (pane_name, prefix);

285 286 287 288 289 290 291 292
  if (!have_boxes ())
    {
      /* Remember index for first item in this pane so we can go back
	 and add a prefix when (if) we see the first button.  After
	 that, notbuttons is set to 0, to mark that we have seen a
	 button and all non button items need a prefix.  */
      skp.notbuttons = menu_items_used;
    }
293 294 295 296 297 298 299 300 301 302 303 304

  map_keymap_canonical (keymap, single_menu_item, Qnil, &skp);

  /* Process now any submenus which want to be panes at this level.  */
  while (CONSP (skp.pending_maps))
    {
      Lisp_Object elt, eltcdr, string;
      elt = XCAR (skp.pending_maps);
      eltcdr = XCDR (elt);
      string = XCAR (eltcdr);
      /* We no longer discard the @ from the beginning of the string here.
	 Instead, we do this in *menu_show.  */
305
      single_keymap_panes (Fcar (elt), string, XCDR (eltcdr), maxdepth - 1);
306 307 308 309 310 311 312 313 314 315 316 317
      skp.pending_maps = XCDR (skp.pending_maps);
    }
}

/* This is a subroutine of single_keymap_panes that handles one
   keymap entry.
   KEY is a key in a keymap and ITEM is its binding.
   SKP->PENDING_MAPS_PTR is a list of keymaps waiting to be made into
   separate panes.
   If we encounter submenus deeper than SKP->MAXDEPTH levels, ignore them.  */

static void
318
single_menu_item (Lisp_Object key, Lisp_Object item, Lisp_Object dummy, void *skp_v)
319 320
{
  Lisp_Object map, item_string, enabled;
321
  bool res;
322 323 324
  struct skp *skp = skp_v;

  /* Parse the menu item and leave the result in item_properties.  */
325
  res = parse_menu_item (item, 0);
326 327 328
  if (!res)
    return;			/* Not a menu item.  */

329
  map = AREF (item_properties, ITEM_PROPERTY_MAP);
330

331 332
  enabled = AREF (item_properties, ITEM_PROPERTY_ENABLE);
  item_string = AREF (item_properties, ITEM_PROPERTY_NAME);
333 334 335 336 337 338 339 340 341 342 343 344

  if (!NILP (map) && SREF (item_string, 0) == '@')
    {
      if (!NILP (enabled))
	/* An enabled separate pane. Remember this to handle it later.  */
	skp->pending_maps = Fcons (Fcons (map, Fcons (item_string, key)),
				   skp->pending_maps);
      return;
    }

  /* Simulate radio buttons and toggle boxes by putting a prefix in
     front of them.  */
345 346
  if (!have_boxes ())
    {
347
      char const *prefix = 0;
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
      Lisp_Object type = AREF (item_properties, ITEM_PROPERTY_TYPE);
      if (!NILP (type))
	{
	  Lisp_Object selected
	    = AREF (item_properties, ITEM_PROPERTY_SELECTED);

	  if (skp->notbuttons)
	    /* The first button. Line up previous items in this menu.  */
	    {
	      int idx = skp->notbuttons; /* Index for first item this menu.  */
	      int submenu = 0;
	      Lisp_Object tem;
	      while (idx < menu_items_used)
		{
		  tem
		    = AREF (menu_items, idx + MENU_ITEMS_ITEM_NAME);
		  if (NILP (tem))
		    {
		      idx++;
		      submenu++;		/* Skip sub menu.  */
		    }
		  else if (EQ (tem, Qlambda))
		    {
		      idx++;
		      submenu--;		/* End sub menu.  */
		    }
		  else if (EQ (tem, Qt))
		    idx += 3;		/* Skip new pane marker. */
		  else if (EQ (tem, Qquote))
		    idx++;		/* Skip a left, right divider. */
		  else
		    {
		      if (!submenu && SREF (tem, 0) != '\0'
			  && SREF (tem, 0) != '-')
382 383 384 385 386
			{
			  AUTO_STRING (spaces, "    ");
			  ASET (menu_items, idx + MENU_ITEMS_ITEM_NAME,
				concat2 (spaces, tem));
			}
387 388 389 390 391 392 393 394
		      idx += MENU_ITEMS_ITEM_LENGTH;
		    }
		}
	      skp->notbuttons = 0;
	    }

	  /* Calculate prefix, if any, for this item.  */
	  if (EQ (type, QCtoggle))
395
	    prefix = NILP (selected) ? "[ ] " : "[X] ";
396
	  else if (EQ (type, QCradio))
397
	    prefix = NILP (selected) ? "( ) " : "(*) ";
398 399 400 401
	}
      /* Not a button. If we have earlier buttons, then we need a prefix.  */
      else if (!skp->notbuttons && SREF (item_string, 0) != '\0'
	       && SREF (item_string, 0) != '-')
402
	prefix = "    ";
403

404
      if (prefix)
405
	{
406
	  AUTO_STRING_WITH_LEN (prefix_obj, prefix, 4);
407 408
	  item_string = concat2 (prefix_obj, item_string);
	}
409 410
  }

Eli Zaretskii's avatar
Eli Zaretskii committed
411 412
  if ((FRAME_TERMCAP_P (XFRAME (Vmenu_updating_frame))
       || FRAME_MSDOS_P (XFRAME (Vmenu_updating_frame)))
413
      && !NILP (map))
414
    /* Indicate visually that this is a submenu.  */
415 416 417 418
    {
      AUTO_STRING (space_gt, " >");
      item_string = concat2 (item_string, space_gt);
    }
419 420

  push_menu_item (item_string, enabled, key,
421 422 423 424 425
		  AREF (item_properties, ITEM_PROPERTY_DEF),
		  AREF (item_properties, ITEM_PROPERTY_KEYEQ),
		  AREF (item_properties, ITEM_PROPERTY_TYPE),
		  AREF (item_properties, ITEM_PROPERTY_SELECTED),
		  AREF (item_properties, ITEM_PROPERTY_HELP));
426

427
#if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
428
  /* Display a submenu using the toolkit.  */
429 430
  if (FRAME_WINDOW_P (XFRAME (Vmenu_updating_frame))
      && ! (NILP (map) || NILP (enabled)))
431 432
    {
      push_submenu_start ();
433
      single_keymap_panes (map, Qnil, key, skp->maxdepth - 1);
434 435 436 437 438 439
      push_submenu_end ();
    }
#endif
}

/* Look through KEYMAPS, a vector of keymaps that is NMAPS long,
440
   and generate menu panes for them in menu_items.  */
441

442
static void
443
keymap_panes (Lisp_Object *keymaps, ptrdiff_t nmaps)
444
{
445
  ptrdiff_t mapno;
446 447 448 449 450 451 452 453

  init_menu_items ();

  /* 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++)
    single_keymap_panes (keymaps[mapno],
454
			 Fkeymap_prompt (keymaps[mapno]), Qnil, 10);
455 456 457 458

  finish_menu_items ();
}

459 460 461 462 463 464 465 466 467 468
/* Encode a menu string as appropriate for menu-updating-frame's type.  */
static Lisp_Object
encode_menu_string (Lisp_Object str)
{
  /* TTY menu strings are encoded by write_glyphs, when they are
     delivered to the glass, so no need to encode them here.  */
  if (FRAME_TERMCAP_P (XFRAME (Vmenu_updating_frame)))
    return str;
  return ENCODE_MENU_STRING (str);
}
469 470 471

/* Push the items in a single pane defined by the alist PANE.  */
static void
472
list_of_items (Lisp_Object pane)
473 474 475 476 477 478 479
{
  Lisp_Object tail, item, item1;

  for (tail = pane; CONSP (tail); tail = XCDR (tail))
    {
      item = XCAR (tail);
      if (STRINGP (item))
480
	push_menu_item (encode_menu_string (item), Qnil, Qnil, Qt,
481 482 483 484 485
			Qnil, Qnil, Qnil, Qnil);
      else if (CONSP (item))
	{
	  item1 = XCAR (item);
	  CHECK_STRING (item1);
486
	  push_menu_item (encode_menu_string (item1), Qt, XCDR (item),
487 488 489 490 491 492 493 494 495 496 497 498
			  Qt, Qnil, Qnil, Qnil, Qnil);
	}
      else
	push_left_right_boundary ();

    }
}

/* Push all the panes and items of a menu described by the
   alist-of-alists MENU.
   This handles old-fashioned calls to x-popup-menu.  */
void
499
list_of_panes (Lisp_Object menu)
500 501 502 503 504 505 506 507 508 509 510
{
  Lisp_Object tail;

  init_menu_items ();

  for (tail = menu; CONSP (tail); tail = XCDR (tail))
    {
      Lisp_Object elt, pane_name, pane_data;
      elt = XCAR (tail);
      pane_name = Fcar (elt);
      CHECK_STRING (pane_name);
511
      push_menu_pane (encode_menu_string (pane_name), Qnil);
512 513 514 515 516 517 518 519 520 521 522
      pane_data = Fcdr (elt);
      CHECK_CONS (pane_data);
      list_of_items (pane_data);
    }

  finish_menu_items ();
}

/* Set up data in menu_items for a menu bar item
   whose event type is ITEM_KEY (with string ITEM_NAME)
   and whose contents come from the list of keymaps MAPS.  */
523 524 525
bool
parse_single_submenu (Lisp_Object item_key, Lisp_Object item_name,
		      Lisp_Object maps)
526 527
{
  Lisp_Object length;
528
  EMACS_INT len;
529
  Lisp_Object *mapvec;
530
  ptrdiff_t i;
531
  bool top_level_items = 0;
532
  USE_SAFE_ALLOCA;
533 534 535 536 537

  length = Flength (maps);
  len = XINT (length);

  /* Convert the list MAPS into a vector MAPVEC.  */
538
  SAFE_ALLOCA_LISP (mapvec, len);
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
  for (i = 0; i < len; i++)
    {
      mapvec[i] = Fcar (maps);
      maps = Fcdr (maps);
    }

  /* Loop over the given keymaps, making a pane for each map.
     But don't make a pane that is empty--ignore that map instead.  */
  for (i = 0; i < len; i++)
    {
      if (!KEYMAPP (mapvec[i]))
	{
	  /* Here we have a command at top level in the menu bar
	     as opposed to a submenu.  */
	  top_level_items = 1;
	  push_menu_pane (Qnil, Qnil);
	  push_menu_item (item_name, Qt, item_key, mapvec[i],
			  Qnil, Qnil, Qnil, Qnil);
	}
      else
	{
	  Lisp_Object prompt;
	  prompt = Fkeymap_prompt (mapvec[i]);
	  single_keymap_panes (mapvec[i],
			       !NILP (prompt) ? prompt : item_name,
564
			       item_key, 10);
565 566 567
	}
    }

568
  SAFE_FREE ();
569 570 571 572
  return top_level_items;
}


573
#if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
574

575
/* Allocate and basically initialize widget_value, blocking input.  */
576 577

widget_value *
578 579
make_widget_value (const char *name, char *value,
		   bool enabled, Lisp_Object help)
580
{
581
  widget_value *wv;
582

583
  block_input ();
584
  wv = xzalloc (sizeof (widget_value));
585
  unblock_input ();
586

587 588 589 590 591
  wv->name = (char *) name;
  wv->value = value;
  wv->enabled = enabled;
  wv->help = help;
  return wv;
592 593
}

594
/* This recursively calls xfree on the tree of widgets.
595 596 597 598 599
   It must free all data that was malloc'ed for these widget_values.
   In Emacs, many slots are pointers into the data of Lisp_Strings, and
   must be left alone.  */

void
600
free_menubar_widget_value_tree (widget_value *wv)
601 602 603 604 605
{
  if (! wv) return;

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

606
  if (wv->contents && (wv->contents != (widget_value *) 1))
607 608 609 610 611 612 613 614 615
    {
      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;
    }
616
  block_input ();
617
  xfree (wv);
618
  unblock_input ();
619 620 621 622 623 624 625
}

/* Create a tree of widget_value objects
   representing the panes and items
   in menu_items starting at index START, up to index END.  */

widget_value *
626
digest_single_submenu (int start, int end, bool top_level_items)
627 628 629 630 631
{
  widget_value *wv, *prev_wv, *save_wv, *first_wv;
  int i;
  int submenu_depth = 0;
  widget_value **submenu_stack;
632
  bool panes_seen = 0;
633
  struct frame *f = XFRAME (Vmenu_updating_frame);
634
  USE_SAFE_ALLOCA;
635

636
  SAFE_NALLOCA (submenu_stack, 1, menu_items_used);
637
  wv = make_widget_value ("menu", NULL, true, Qnil);
638 639 640 641 642 643 644 645 646 647 648 649
  wv->button_type = BUTTON_TYPE_NONE;
  first_wv = wv;
  save_wv = 0;
  prev_wv = 0;

  /* Loop over all panes and items made by the preceding call
     to parse_single_submenu and construct a tree of widget_value objects.
     Ignore the panes and items used by previous calls to
     digest_single_submenu, even though those are also in menu_items.  */
  i = start;
  while (i < end)
    {
650
      if (EQ (AREF (menu_items, i), Qnil))
651 652 653 654 655 656
	{
	  submenu_stack[submenu_depth++] = save_wv;
	  save_wv = prev_wv;
	  prev_wv = 0;
	  i++;
	}
657
      else if (EQ (AREF (menu_items, i), Qlambda))
658 659 660 661 662
	{
	  prev_wv = save_wv;
	  save_wv = submenu_stack[--submenu_depth];
	  i++;
	}
663
      else if (EQ (AREF (menu_items, i), Qt)
664 665 666 667
	       && submenu_depth != 0)
	i += MENU_ITEMS_PANE_LENGTH;
      /* Ignore a nil in the item list.
	 It's meaningful only for dialog boxes.  */
668
      else if (EQ (AREF (menu_items, i), Qquote))
669
	i += 1;
670
      else if (EQ (AREF (menu_items, i), Qt))
671 672
	{
	  /* Create a new pane.  */
673
	  Lisp_Object pane_name;
674
	  const char *pane_string;
675

676
	  panes_seen = 1;
677

678
	  pane_name = AREF (menu_items, i + MENU_ITEMS_PANE_NAME);
679

680 681 682
	  /* TTY menus display menu items via tty_write_glyphs, which
	     will encode the strings as appropriate.  */
	  if (!FRAME_TERMCAP_P (f))
683
	    {
684 685 686 687 688 689 690 691
#ifdef HAVE_NTGUI
	      if (STRINGP (pane_name))
		{
		  if (unicode_append_menu)
		    /* Encode as UTF-8 for now.  */
		    pane_name = ENCODE_UTF_8 (pane_name);
		  else if (STRING_MULTIBYTE (pane_name))
		    pane_name = ENCODE_SYSTEM (pane_name);
692

693 694
		  ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name);
		}
695
#elif defined (USE_LUCID) && defined (HAVE_XFT)
696 697 698 699 700
	      if (STRINGP (pane_name))
		{
		  pane_name = ENCODE_UTF_8 (pane_name);
		  ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name);
		}
701
#elif !defined (HAVE_MULTILINGUAL_MENU)
702 703 704 705 706
	      if (STRINGP (pane_name) && STRING_MULTIBYTE (pane_name))
		{
		  pane_name = ENCODE_MENU_STRING (pane_name);
		  ASET (menu_items, i + MENU_ITEMS_PANE_NAME, pane_name);
		}
707
#endif
708
	    }
709 710

	  pane_string = (NILP (pane_name)
711
			 ? "" : SSDATA (pane_name));
712 713 714 715 716 717 718 719 720 721
	  /* If there is just one top-level pane, put all its items directly
	     under the top-level menu.  */
	  if (menu_items_n_panes == 1)
	    pane_string = "";

	  /* If the pane has a meaningful name,
	     make the pane a top-level menu item
	     with its items as a submenu beneath it.  */
	  if (strcmp (pane_string, ""))
	    {
722 723
	      /* Set value to 1 so update_submenu_strings can handle '@'.  */
	      wv = make_widget_value (NULL, (char *) 1, true, Qnil);
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
	      if (save_wv)
		save_wv->next = wv;
	      else
		first_wv->contents = wv;
	      wv->lname = pane_name;
	      wv->button_type = BUTTON_TYPE_NONE;
	      save_wv = wv;
	    }
	  else
	    save_wv = first_wv;

	  prev_wv = 0;
	  i += MENU_ITEMS_PANE_LENGTH;
	}
      else
	{
	  /* Create a new item within current pane.  */
	  Lisp_Object item_name, enable, descrip, def, type, selected;
	  Lisp_Object help;

	  /* All items should be contained in panes.  */
745
	  if (! panes_seen)
746
	    emacs_abort ();
747 748 749 750 751 752 753 754 755

	  item_name = AREF (menu_items, i + MENU_ITEMS_ITEM_NAME);
	  enable = AREF (menu_items, i + MENU_ITEMS_ITEM_ENABLE);
	  descrip = AREF (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY);
	  def = AREF (menu_items, i + MENU_ITEMS_ITEM_DEFINITION);
	  type = AREF (menu_items, i + MENU_ITEMS_ITEM_TYPE);
	  selected = AREF (menu_items, i + MENU_ITEMS_ITEM_SELECTED);
	  help = AREF (menu_items, i + MENU_ITEMS_ITEM_HELP);

756 757 758
	  /* TTY menu items and their descriptions will be encoded by
	     tty_write_glyphs.  */
	  if (!FRAME_TERMCAP_P (f))
759
	    {
760 761 762 763 764 765 766
#ifdef HAVE_NTGUI
	      if (STRINGP (item_name))
		{
		  if (unicode_append_menu)
		    item_name = ENCODE_UTF_8 (item_name);
		  else if (STRING_MULTIBYTE (item_name))
		    item_name = ENCODE_SYSTEM (item_name);
767

768 769
		  ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name);
		}
770

771 772 773 774 775
	      if (STRINGP (descrip) && STRING_MULTIBYTE (descrip))
		{
		  descrip = ENCODE_SYSTEM (descrip);
		  ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip);
		}
776
#elif USE_LUCID
777 778 779 780 781
	      if (STRINGP (item_name))
		{
		  item_name = ENCODE_UTF_8 (item_name);
		  ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name);
		}
782

783 784 785 786 787
	      if (STRINGP (descrip))
		{
		  descrip = ENCODE_UTF_8 (descrip);
		  ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip);
		}
788
#elif !defined (HAVE_MULTILINGUAL_MENU)
789 790 791 792 793
	      if (STRING_MULTIBYTE (item_name))
		{
		  item_name = ENCODE_MENU_STRING (item_name);
		  ASET (menu_items, i + MENU_ITEMS_ITEM_NAME, item_name);
		}
794

795 796 797 798 799
	      if (STRINGP (descrip) && STRING_MULTIBYTE (descrip))
		{
		  descrip = ENCODE_MENU_STRING (descrip);
		  ASET (menu_items, i + MENU_ITEMS_ITEM_EQUIV_KEY, descrip);
		}
800
#endif
801
	    }
802

803 804
	  wv = make_widget_value (NULL, NULL, !NILP (enable),
				  STRINGP (help) ? help : Qnil);
805 806 807 808 809 810 811 812
	  if (prev_wv)
	    prev_wv->next = wv;
	  else
	    save_wv->contents = wv;

	  wv->lname = item_name;
	  if (!NILP (descrip))
	    wv->lkey = descrip;
813
	  /* The intptr_t cast avoids a warning.  There's no problem
814
	     as long as pointers have enough bits to hold small integers.  */
815
	  wv->call_data = (!NILP (def) ? (void *) (intptr_t) i : 0);
816 817 818 819 820 821 822 823

	  if (NILP (type))
	    wv->button_type = BUTTON_TYPE_NONE;
	  else if (EQ (type, QCradio))
	    wv->button_type = BUTTON_TYPE_RADIO;
	  else if (EQ (type, QCtoggle))
	    wv->button_type = BUTTON_TYPE_TOGGLE;
	  else
824
	    emacs_abort ();
825 826 827 828 829 830 831 832 833 834 835 836 837

	  wv->selected = !NILP (selected);

	  prev_wv = wv;

	  i += MENU_ITEMS_ITEM_LENGTH;
	}
    }

  /* If we have just one "menu item"
     that was originally a button, return it by itself.  */
  if (top_level_items && first_wv->contents && first_wv->contents->next == 0)
    {
838 839 840
      wv = first_wv;
      first_wv = first_wv->contents;
      xfree (wv);
841 842
    }

843
  SAFE_FREE ();
844 845 846 847 848 849 850 851 852
  return first_wv;
}

/* Walk through the widget_value tree starting at FIRST_WV and update
   the char * pointers from the corresponding lisp values.
   We do this after building the whole tree, since GC may happen while the
   tree is constructed, and small strings are relocated.  So we must wait
   until no GC can happen before storing pointers into lisp values.  */
void
853
update_submenu_strings (widget_value *first_wv)
854 855 856 857 858 859 860
{
  widget_value *wv;

  for (wv = first_wv; wv; wv = wv->next)
    {
      if (STRINGP (wv->lname))
        {
861
          wv->name = SSDATA (wv->lname);
862 863 864 865 866 867 868 869 870 871 872 873

          /* Ignore the @ that means "separate pane".
             This is a kludge, but this isn't worth more time.  */
          if (wv->value == (char *)1)
            {
              if (wv->name[0] == '@')
		wv->name++;
              wv->value = 0;
            }
        }

      if (STRINGP (wv->lkey))
874
        wv->key = SSDATA (wv->lkey);
875 876 877 878 879 880 881 882 883 884 885 886

      if (wv->contents)
        update_submenu_strings (wv->contents);
    }
}

/* Find the menu selection and store it in the keyboard buffer.
   F is the frame the menu is on.
   MENU_BAR_ITEMS_USED is the length of VECTOR.
   VECTOR is an array of menu events for the whole menu.  */

void
Dmitry Antipov's avatar
Dmitry Antipov committed
887 888
find_and_call_menu_selection (struct frame *f, int menu_bar_items_used,
			      Lisp_Object vector, void *client_data)
889 890 891 892 893
{
  Lisp_Object prefix, entry;
  Lisp_Object *subprefix_stack;
  int submenu_depth = 0;
  int i;
894
  USE_SAFE_ALLOCA;
895 896

  entry = Qnil;
897
  SAFE_NALLOCA (subprefix_stack, 1, menu_bar_items_used);
898 899 900 901 902
  prefix = Qnil;
  i = 0;

  while (i < menu_bar_items_used)
    {
903
      if (EQ (AREF (vector, i), Qnil))
904 905 906 907 908
	{
	  subprefix_stack[submenu_depth++] = prefix;
	  prefix = entry;
	  i++;
	}
909
      else if (EQ (AREF (vector, i), Qlambda))
910 911 912 913
	{
	  prefix = subprefix_stack[--submenu_depth];
	  i++;
	}
914
      else if (EQ (AREF (vector, i), Qt))
915
	{
916
	  prefix = AREF (vector, i + MENU_ITEMS_PANE_PREFIX);
917 918 919 920
	  i += MENU_ITEMS_PANE_LENGTH;
	}
      else
	{
921
	  entry = AREF (vector, i + MENU_ITEMS_ITEM_VALUE);
922
	  /* Treat the pointer as an integer.  There's no problem
923
	     as long as pointers have enough bits to hold small integers.  */
924
	  if ((intptr_t) client_data == i)
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
	    {
	      int j;
	      struct input_event buf;
	      Lisp_Object frame;
	      EVENT_INIT (buf);

	      XSETFRAME (frame, f);
	      buf.kind = MENU_BAR_EVENT;
	      buf.frame_or_window = frame;
	      buf.arg = frame;
	      kbd_buffer_store_event (&buf);

	      for (j = 0; j < submenu_depth; j++)
		if (!NILP (subprefix_stack[j]))
		  {
		    buf.kind = MENU_BAR_EVENT;
		    buf.frame_or_window = frame;
		    buf.arg = subprefix_stack[j];
		    kbd_buffer_store_event (&buf);
		  }

	      if (!NILP (prefix))
		{
		  buf.kind = MENU_BAR_EVENT;
		  buf.frame_or_window = frame;
		  buf.arg = prefix;
		  kbd_buffer_store_event (&buf);
		}

	      buf.kind = MENU_BAR_EVENT;
	      buf.frame_or_window = frame;
	      buf.arg = entry;
	      kbd_buffer_store_event (&buf);

959
	      break;
960 961 962 963
	    }
	  i += MENU_ITEMS_ITEM_LENGTH;
	}
    }
964 965

  SAFE_FREE ();
966 967
}

968 969 970 971
#endif /* USE_X_TOOLKIT || USE_GTK || HAVE_NS || HAVE_NTGUI */

#ifdef HAVE_NS
/* As above, but return the menu selection instead of storing in kb buffer.
972
   If KEYMAPS, return full prefixes to selection. */
973
Lisp_Object
Dmitry Antipov's avatar
Dmitry Antipov committed
974
find_and_return_menu_selection (struct frame *f, bool keymaps, void *client_data)
975 976 977 978 979
{
  Lisp_Object prefix, entry;
  int i;
  Lisp_Object *subprefix_stack;
  int submenu_depth = 0;
980
  USE_SAFE_ALLOCA;
981 982 983

  prefix = entry = Qnil;
  i = 0;
984
  SAFE_ALLOCA_LISP (subprefix_stack, menu_items_used);
985 986 987

  while (i < menu_items_used)
    {
988
      if (EQ (AREF (menu_items, i), Qnil))
989 990 991 992 993
        {
          subprefix_stack[submenu_depth++] = prefix;
          prefix = entry;
          i++;
        }
994
      else if (EQ (AREF (menu_items, i), Qlambda))
995 996 997 998
        {
          prefix = subprefix_stack[--submenu_depth];
          i++;
        }
999
      else if (EQ (AREF (menu_items, i), Qt))
1000 1001
        {
          prefix
1002
            = AREF (menu_items, i + MENU_ITEMS_PANE_PREFIX);
1003 1004 1005 1006
          i += MENU_ITEMS_PANE_LENGTH;
        }
      /* Ignore a nil in the item list.
         It's meaningful only for dialog boxes.  */
1007
      else if (EQ (AREF (menu_items, i), Qquote))
1008 1009 1010 1011
        i += 1;
      else
        {
          entry
1012
            = AREF (menu_items, i + MENU_ITEMS_ITEM_VALUE);
1013
          if (aref_addr (menu_items, i) == client_data)
1014
            {
1015
              if (keymaps)
1016 1017 1018
                {
                  int j;

1019
                  entry = list1 (entry);
1020 1021 1022 1023 1024 1025
                  if (!NILP (prefix))
                    entry = Fcons (prefix, entry);
                  for (j = submenu_depth - 1; j >= 0; j--)
                    if (!NILP (subprefix_stack[j]))
                      entry = Fcons (subprefix_stack[j], entry);
                }
1026
	      SAFE_FREE ();
1027 1028 1029 1030 1031
              return entry;
            }
          i += MENU_ITEMS_ITEM_LENGTH;
        }
    }
1032
  SAFE_FREE ();
1033
  return Qnil;
1034
}
1035
#endif  /* HAVE_NS */
1036

1037 1038
ptrdiff_t
menu_item_width (const unsigned char *str)
1039
{
1040 1041
  ptrdiff_t len;
  const unsigned char *p;
1042 1043 1044 1045 1046 1047

  for (len = 0, p = str; *p; )
    {
      int ch_len;
      int ch = STRING_CHAR_AND_LENGTH (p, ch_len);

1048
      len += CHARACTER_WIDTH (ch);
1049 1050 1051 1052 1053
      p += ch_len;
    }
  return len;
}

1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
DEFUN ("menu-bar-menu-at-x-y", Fmenu_bar_menu_at_x_y, Smenu_bar_menu_at_x_y,
       2, 3, 0,
       doc: /* Return the menu-bar menu on FRAME at pixel coordinates X, Y.
X and Y are frame-relative pixel coordinates, assumed to define
a location within the menu bar.
If FRAME is nil or omitted, it defaults to the selected frame.

Value is the symbol of the menu at X/Y, or nil if the specified
coordinates are not within the FRAME's menu bar.  The symbol can
be used to look up the menu like this:

1065 1066 1067 1068
     (lookup-key MAP [menu-bar SYMBOL])

where MAP is either the current global map or the current local map,
since menu-bar items come from both.
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090

This function can return non-nil only on a text-terminal frame
or on an X frame that doesn't use any GUI toolkit.  Otherwise,
Emacs does not manage the menu bar and cannot convert coordinates
into menu items.  */)
  (Lisp_Object x, Lisp_Object y, Lisp_Object frame)
{
  int row, col;
  struct frame *f = decode_any_frame (frame);

  if (!FRAME_LIVE_P (f))
    return Qnil;

  pixel_to_glyph_coords (f, XINT (x), XINT (y), &col, &row, NULL, 1);
  if (0 <= row && row < FRAME_MENU_BAR_LINES (f))
    {
      Lisp_Object items, item;
      int i;

      /* Find the menu bar item under `col'.  */
      item = Qnil;
      items = FRAME_MENU_BAR_ITEMS (f);
Eli Zaretskii's avatar
Eli Zaretskii committed
1091 1092 1093
      /* This loop assumes a single menu-bar line, and will fail to
	 find an item if it is not in the first line.  Note that
	 make_lispy_event in keyboard.c makes the same assumption.  */
1094 1095 1096 1097 1098 1099 1100 1101
      for (i = 0; i < ASIZE (items); i += 4)
	{
	  Lisp_Object pos, str;

	  str = AREF (items, i + 1);
	  pos = AREF (items, i + 3);
	  if (NILP (str))
	    return item;
1102 1103 1104
	  if (XINT (pos) <= col
	      /* We use <= so the blank between 2 items on a TTY is
		 considered part of the previous item.  */
1105
	      && col <= XINT (pos) + menu_item_width (SDATA (str)))
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
	    {
	      item = AREF (items, i);
	      return item;
	    }
	}
    }
  return Qnil;
}


Paul Eggert's avatar
Paul Eggert committed
1116
DEFUN ("x-popup-menu", Fx_popup_menu, Sx_popup_menu, 2, 2, 0,
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127
       doc: /* Pop up a deck-of-cards menu and return user's selection.
POSITION is a position specification.  This is either a mouse button event
or a list ((XOFFSET YOFFSET) WINDOW)
where XOFFSET and YOFFSET are positions in pixels from the top left
corner of WINDOW.  (WINDOW may be a window or a frame object.)
This controls the position of the top left of the menu as a whole.
If POSITION is t, it means to use the current mouse position.

MENU is a specifier for a menu.  For the simplest case, MENU is a keymap.
The menu items come from key bindings that have a menu string as well as
a definition; actually, the "definition" in such a key binding looks like
1128
\(STRING . REAL-DEFINITION).  To give the menu a title, put a string into
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
the keymap as a top-level element.

If REAL-DEFINITION is nil, that puts a nonselectable string in the menu.
Otherwise, REAL-DEFINITION should be a valid key binding definition.

You can also use a list of keymaps as MENU.
  Then each keymap makes a separate pane.

When MENU is a keymap or a list of keymaps, the return value is the
list of events corresponding to the user's choice. Note that
`x-popup-menu' does not actually execute the command bound to that
sequence of events.

Alternatively, you can specify a menu of multiple panes
  with a list of the form (TITLE PANE1 PANE2...),
where each pane is a list of form (TITLE ITEM1 ITEM2...).
Each ITEM is normally a cons cell (STRING . VALUE);
but a string can appear as an item--that makes a nonselectable line
in the menu.
With this form of menu, the return value is VALUE from the chosen item.

If POSITION is nil, don't display the menu at all, just precalculate the
cached information about equivalent key sequences.

If the user gets rid of the menu without making a valid choice, for
instance by clicking the mouse away from a valid choice or by typing
keyboard input, then this normally results in a quit and
`x-popup-menu' does not return.  But if POSITION is a mouse button
event (indicating that the user invoked the menu with the mouse) then
no quit occurs and `x-popup-menu' returns nil.  */)
1159
  (Lisp_Object position, Lisp_Object menu)
1160
{
1161
  Lisp_Object keymap, tem, tem2;
1162 1163
  int xpos = 0, ypos = 0;
  Lisp_Object title;
1164
  const char *error_name = NULL;
1165
  Lisp_Object selection = Qnil;
Dmitry Antipov's avatar
Dmitry Antipov committed
1166
  struct frame *f = NULL;
1167
  Lisp_Object x, y, window;
1168
  int menuflags = 0;
1169
  ptrdiff_t specpdl_count = SPECPDL_INDEX ();
1170 1171 1172 1173 1174 1175 1176

  if (NILP (position))
    /* This is an obsolete call, which wants us to precompute the
       keybinding equivalents, but we don't do that any more anyway.  */
    return Qnil;

  {
1177
    bool get_current_pos_p = 0;
1178

1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196
    /* Decode the first argument: find the window and the coordinates.  */
    if (EQ (position, Qt)
	|| (CONSP (position) && (EQ (XCAR (position), Qmenu_bar)
				 || EQ (XCAR (position), Qtool_bar))))
      {
	get_current_pos_p = 1;
      }
    else
      {
	tem = Fcar (position);
	if (CONSP (tem))
	  {
	    window = Fcar (Fcdr (position));
	    x = XCAR (tem);
	    y = Fcar (XCDR (tem));
	  }
	else
	  {
1197
	    menuflags |= MENU_FOR_CLICK;
1198 1199
	    tem = Fcar (Fcdr (position));  /* EVENT_START (position) */
	    window = Fcar (tem);	     /* POSN_WINDOW (tem) */
1200
	    tem2 = Fcar (Fcdr (tem));	     /* POSN_POSN (tem) */
1201 1202
	    /* The MENU_KBD_NAVIGATION field is set when the menu
	       was invoked by F10, which probably means they have no
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
	       mouse.  In that case, we let them switch between
	       top-level menu-bar menus by using C-f/C-b and
	       horizontal arrow keys, since they cannot click the
	       mouse to open a different submenu.  This flag is only
	       supported by tty_menu_show.  We set it when POSITION
	       and last_nonmenu_event are different, which means we
	       constructed POSITION by hand (in popup-menu, see
	       menu-bar.el) to look like a mouse click on the menu bar
	       event.  */
	    if (!EQ (POSN_POSN (last_nonmenu_event),
		     POSN_POSN (position))
		&& CONSP (tem2) && EQ (Fcar (tem2), Qmenu_bar))
1215
	      menuflags |= MENU_KBD_NAVIGATION;
1216 1217 1218
	    tem = Fcar (Fcdr (Fcdr (tem))); /* POSN_WINDOW_POSN (tem) */
	    x = Fcar (tem);
	    y = Fcdr (tem);
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232
	  }

	/* If a click happens in an external tool bar or a detached
	   tool bar, x and y is NIL.  In that case, use the current
	   mouse position.  This happens for the help button in the
	   tool bar.  Ideally popup-menu should pass NIL to
	   this function, but it doesn't.  */
	if (NILP (x) && NILP (y))
	  get_current_pos_p = 1;
      }

    if (get_current_pos_p)
      {
	/* Use the mouse's current position.  */
Dmitry Antipov's avatar
Dmitry Antipov committed
1233
	struct frame *new_f = SELECTED_FRAME ();
1234 1235 1236

	XSETFASTINT (x, 0);
	XSETFASTINT (y, 0);
1237
#ifdef HAVE_X_WINDOWS
1238
	if (FRAME_X_P (new_f))
1239
	  {
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
	    /* Can't use mouse_position_hook for X since it returns
	       coordinates relative to the window the mouse is in,
	       we need coordinates relative to the edit widget always.  */
	    if (new_f != 0)
	      {
		int cur_x, cur_y;

		x_relative_mouse_position (new_f, &cur_x, &cur_y);
		/* cur_x/y may be negative, so use make_number.  */
		x = make_number (cur_x);
		y = make_number (cur_y);
	      }
	  }
	else
#endif /* HAVE_X_WINDOWS */
	  {
	    Lisp_Object bar_window;
	    enum scroll_bar_part part;
	    Time time;
	    void (*mouse_position_hook) (struct frame **, int,
					 Lisp_Object *,
					 enum scroll_bar_part *,
					 Lisp_Object *,
					 Lisp_Object *,
					 Time *) =
	      FRAME_TERMINAL (new_f)->mouse_position_hook;

	    if (mouse_position_hook)
	      (*mouse_position_hook) (&new_f, 1, &bar_window,
				      &part, &x, &y, &time);
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303
	  }

	if (new_f != 0)
	  XSETFRAME (window, new_f);
	else
	  {
	    window = selected_window;
	    XSETFASTINT (x, 0);
	    XSETFASTINT (y, 0);
	  }
      }

    /* Decode where to put the menu.  */

    if (FRAMEP (window))
      {
	f = XFRAME (window);
	xpos = 0;
	ypos = 0;
      }
    else if (WINDOWP (window))
      {
	struct window *win = XWINDOW (window);
	CHECK_LIVE_WINDOW (window);
	f = XFRAME (WINDOW_FRAME (win));

	xpos = WINDOW_LEFT_EDGE_X (win);
	ypos = WINDOW_TOP_EDGE_Y (win);
      }
    else
      /* ??? Not really clean; should be CHECK_WINDOW_OR_FRAME,
	 but I don't want to make one now.  */
      CHECK_WINDOW (window);

1304 1305
    CHECK_RANGED_INTEGER (x,
			  (xpos < INT_MIN - MOST_NEGATIVE_FIXNUM
1306 1307
			   ? (EMACS_INT) INT_MIN - xpos
			   : MOST_NEGATIVE_FIXNUM),
1308 1309 1310
			  INT_MAX - xpos);
    CHECK_RANGED_INTEGER (y,
			  (ypos < INT_MIN - MOST_NEGATIVE_FIXNUM
1311 1312
			   ? (EMACS_INT) INT_MIN - ypos
			   : MOST_NEGATIVE_FIXNUM),
1313
			  INT_MAX - ypos);
1314 1315 1316 1317 1318 1319 1320
    xpos += XINT (x);
    ypos += XINT (y);

    XSETFRAME (Vmenu_updating_frame, f);
  }

  /* Now parse the lisp menus.  */
1321
  record_unwind_protect_void (unuse_menu_items);
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349

  title = Qnil;

  /* Decode the menu items from what was specified.  */

  keymap = get_keymap (menu, 0, 0);
  if (CONSP (keymap))
    {
      /* We were given a keymap.  Extract menu info from the keymap.  */
      Lisp_Object prompt;

      /* Extract the detailed info to make one pane.  */
      keymap_panes (&menu, 1);

      /* Search for a string appearing directly as an element of the keymap.
	 That string is the title of the menu.  */
      prompt = Fkeymap_prompt (keymap);
      if (!NILP (prompt))
	title = prompt;
#ifdef HAVE_NS		/* Is that needed and NS-specific?  --Stef  */
      else
	title = build_string ("Select");
#endif

      /* Make that be the pane title of the first pane.  */
      if (!NILP (prompt) && menu_items_n_panes >= 0)
	ASET (menu_items, MENU_ITEMS_PANE_NAME, prompt);

1350
      menuflags |= MENU_KEYMAPS;
1351 1352 1353 1354
    }
  else if (CONSP (menu) && KEYMAPP (XCAR (menu)))
    {
      /* We were given a list of keymaps.  */
1355 1356 1357 1358
      EMACS_INT nmaps = XFASTINT (Flength (menu));
      Lisp_Object *maps;
      ptrdiff_t i;
      USE_SAFE_ALLOCA;
1359

1360
      SAFE_ALLOCA_LISP (maps, nmaps);
1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
      title = Qnil;

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

	  maps[i++] = keymap = get_keymap (XCAR (tem), 1, 0);

	  prompt = Fkeymap_prompt (keymap);
	  if (NILP (title) && !NILP (prompt))
	    title = prompt;
	}

      /* Extract the detailed info to make one pane.  */
      keymap_panes (maps, nmaps);

      /* Make the title be the pane title of the first pane.  */
      if (!NILP (title) && menu_items_n_panes >= 0)
	ASET (menu_items, MENU_ITEMS_PANE_NAME, title);

1383
      menuflags |= MENU_KEYMAPS;
1384 1385

      SAFE_FREE ();
1386 1387 1388 1389 1390 1391 1392 1393 1394
    }
  else
    {
      /* We were given an old-fashioned menu.  */
      title = Fcar (menu);
      CHECK_STRING (title);

      list_of_panes (Fcdr (menu));

1395
      menuflags &= ~MENU_KEYMAPS;
1396 1397 1398 1399
    }

  unbind_to (specpdl_count, Qnil);

1400
#ifdef HAVE_WINDOW_SYSTEM
1401
  /* Hide a previous tip, if any.  */
1402
  if (!FRAME_TERMCAP_P (f))
John Wiegley's avatar
John Wiegley committed
1403
    Fx_hide_tip ();
1404
#endif
1405 1406 1407 1408 1409 1410 1411

#ifdef HAVE_NTGUI     /* FIXME: Is it really w32-specific?  --Stef  */
  /* If resources from a previous popup menu still exist, does nothing
     until the `menu_free_timer' has freed them (see w32fns.c). This
     can occur if you press ESC or click outside a menu without selecting
     a menu item.
  */