?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Cleanup
[MacVim.git] / src / menu.c
blobefe494ff92310a1bd633027c4f289837fe0f9d40
1 /* vi:set ts=8 sts=4 sw=4:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 * GUI/Motif support by Robert Webb
5 *
6 * Do ":help uganda" in Vim to read copying and usage conditions.
7 * Do ":help credits" in Vim to see a list of people who contributed.
8 * See README.txt for an overview of the Vim source code.
9 */
10
11 /*
12 * Code for menus. Used for the GUI and 'wildmenu'.
13 */
14
15 #include "vim.h"
16
17 #if defined(FEAT_MENU) || defined(PROTO)
18
19 #define MENUDEPTH 10 /* maximum depth of menus */
20
21 #ifdef FEAT_GUI_W32
22 static int add_menu_path __ARGS((char_u *, vimmenu_T *, int *, char_u *, int));
23 #else
24 static int add_menu_path __ARGS((char_u *, vimmenu_T *, int *, char_u *));
25 #endif
26 static int menu_nable_recurse __ARGS((vimmenu_T *menu, char_u *name, int modes, int enable));
27 static int remove_menu __ARGS((vimmenu_T **, char_u *, int, int silent));
28 static void free_menu __ARGS((vimmenu_T **menup));
29 static void free_menu_string __ARGS((vimmenu_T *, int));
30 static int show_menus __ARGS((char_u *, int));
31 static void show_menus_recursive __ARGS((vimmenu_T *, int, int));
32 static int menu_name_equal __ARGS((char_u *name, vimmenu_T *menu));
33 static int menu_namecmp __ARGS((char_u *name, char_u *mname));
34 static int get_menu_cmd_modes __ARGS((char_u *, int, int *, int *));
35 static char_u *popup_mode_name __ARGS((char_u *name, int idx));
36 static char_u *menu_text __ARGS((char_u *text, int *mnemonic, char_u **actext));
37 #ifdef FEAT_GUI
38 static int get_menu_mode __ARGS((void));
39 static void gui_update_menus_recurse __ARGS((vimmenu_T *, int));
40 #endif
41
42 #if defined(FEAT_GUI_W32) && defined(FEAT_TEAROFF)
43 static void gui_create_tearoffs_recurse __ARGS((vimmenu_T *menu, const char_u *pname, int *pri_tab, int pri_idx));
44 static void gui_add_tearoff __ARGS((char_u *tearpath, int *pri_tab, int pri_idx));
45 static void gui_destroy_tearoffs_recurse __ARGS((vimmenu_T *menu));
46 static int s_tearoffs = FALSE;
47 #endif
48
49 static int menu_is_hidden __ARGS((char_u *name));
50 #if defined(FEAT_CMDL_COMPL) || (defined(FEAT_GUI_W32) && defined(FEAT_TEAROFF))
51 static int menu_is_tearoff __ARGS((char_u *name));
52 #endif
53
54 #if defined(FEAT_MULTI_LANG) || defined(FEAT_TOOLBAR)
55 static char_u *menu_skip_part __ARGS((char_u *p));
56 #endif
57 #ifdef FEAT_MULTI_LANG
58 static char_u *menutrans_lookup __ARGS((char_u *name, int len));
59 #endif
60
61 /* The character for each menu mode */
62 static char_u menu_mode_chars[] = {'n', 'v', 's', 'o', 'i', 'c', 't'};
63
64 static char_u e_notsubmenu[] = N_("E327: Part of menu-item path is not sub-menu");
65 static char_u e_othermode[] = N_("E328: Menu only exists in another mode");
66 static char_u e_nomenu[] = N_("E329: No menu \"%s\"");
67
68 #ifdef FEAT_TOOLBAR
69 static const char *toolbar_names[] =
70 {
71 /* 0 */ "New", "Open", "Save", "Undo", "Redo",
72 /* 5 */ "Cut", "Copy", "Paste", "Print", "Help",
73 /* 10 */ "Find", "SaveAll", "SaveSesn", "NewSesn", "LoadSesn",
74 /* 15 */ "RunScript", "Replace", "WinClose", "WinMax", "WinMin",
75 /* 20 */ "WinSplit", "Shell", "FindPrev", "FindNext", "FindHelp",
76 /* 25 */ "Make", "TagJump", "RunCtags", "WinVSplit", "WinMaxWidth",
77 /* 30 */ "WinMinWidth", "Exit"
78 };
79 # define TOOLBAR_NAME_COUNT (sizeof(toolbar_names) / sizeof(char *))
80 #endif
81
82 /*
83 * Do the :menu command and relatives.
84 */
85 void
86 ex_menu(eap)
87 exarg_T *eap; /* Ex command arguments */
88 {
89 char_u *menu_path;
90 int modes;
91 char_u *map_to;
92 int noremap;
93 int silent = FALSE;
94 int special = FALSE;
95 int unmenu;
96 char_u *map_buf;
97 char_u *arg;
98 char_u *p;
99 int i;
100 #if defined(FEAT_GUI) && !(defined(FEAT_GUI_GTK) || defined(FEAT_GUI_MACVIM))
101 int old_menu_height;
102 # if defined(FEAT_TOOLBAR) && !defined(FEAT_GUI_W32) && !defined(FEAT_GUI_W16)
103 int old_toolbar_height;
104 # endif
105 #endif
106 int pri_tab[MENUDEPTH + 1];
107 int enable = MAYBE; /* TRUE for "menu enable", FALSE for "menu
108 * disable */
109 #ifdef FEAT_MULTI_LANG
110 char_u *tofree = NULL;
111 char_u *new_cmd;
112 #endif
113 #ifdef FEAT_TOOLBAR
114 char_u *icon = NULL;
115 #endif
116 vimmenu_T menuarg;
117
118 modes = get_menu_cmd_modes(eap->cmd, eap->forceit, &noremap, &unmenu);
119 arg = eap->arg;
120
121 for (;;)
122 {
123 if (STRNCMP(arg, "<script>", 8) == 0)
124 {
125 noremap = REMAP_SCRIPT;
126 arg = skipwhite(arg + 8);
127 continue;
128 }
129 if (STRNCMP(arg, "<silent>", 8) == 0)
130 {
131 silent = TRUE;
132 arg = skipwhite(arg + 8);
133 continue;
134 }
135 if (STRNCMP(arg, "<special>", 9) == 0)
136 {
137 special = TRUE;
138 arg = skipwhite(arg + 9);
139 continue;
140 }
141 break;
142 }
143
144
145 /* Locate an optional "icon=filename" argument. */
146 if (STRNCMP(arg, "icon=", 5) == 0)
147 {
148 arg += 5;
149 #ifdef FEAT_TOOLBAR
150 icon = arg;
151 #endif
152 while (*arg != NUL && *arg != ' ')
153 {
154 if (*arg == '\\')
155 STRMOVE(arg, arg + 1);
156 mb_ptr_adv(arg);
157 }
158 if (*arg != NUL)
159 {
160 *arg++ = NUL;
161 arg = skipwhite(arg);
162 }
163 }
164
165 /*
166 * Fill in the priority table.
167 */
168 for (p = arg; *p; ++p)
169 if (!VIM_ISDIGIT(*p) && *p != '.')
170 break;
171 if (vim_iswhite(*p))
172 {
173 for (i = 0; i < MENUDEPTH && !vim_iswhite(*arg); ++i)
174 {
175 pri_tab[i] = getdigits(&arg);
176 if (pri_tab[i] == 0)
177 pri_tab[i] = 500;
178 if (*arg == '.')
179 ++arg;
180 }
181 arg = skipwhite(arg);
182 }
183 else if (eap->addr_count && eap->line2 != 0)
184 {
185 pri_tab[0] = eap->line2;
186 i = 1;
187 }
188 else
189 i = 0;
190 while (i < MENUDEPTH)
191 pri_tab[i++] = 500;
192 pri_tab[MENUDEPTH] = -1; /* mark end of the table */
193
194 /*
195 * Check for "disable" or "enable" argument.
196 */
197 if (STRNCMP(arg, "enable", 6) == 0 && vim_iswhite(arg[6]))
198 {
199 enable = TRUE;
200 arg = skipwhite(arg + 6);
201 }
202 else if (STRNCMP(arg, "disable", 7) == 0 && vim_iswhite(arg[7]))
203 {
204 enable = FALSE;
205 arg = skipwhite(arg + 7);
206 }
207
208 /*
209 * If there is no argument, display all menus.
210 */
211 if (*arg == NUL)
212 {
213 show_menus(arg, modes);
214 return;
215 }
216
217 #ifdef FEAT_TOOLBAR
218 /*
219 * Need to get the toolbar icon index before doing the translation.
220 */
221 menuarg.iconidx = -1;
222 menuarg.icon_builtin = FALSE;
223 if (menu_is_toolbar(arg))
224 {
225 menu_path = menu_skip_part(arg);
226 if (*menu_path == '.')
227 {
228 p = menu_skip_part(++menu_path);
229 if (STRNCMP(menu_path, "BuiltIn", 7) == 0)
230 {
231 if (skipdigits(menu_path + 7) == p)
232 {
233 menuarg.iconidx = atoi((char *)menu_path + 7);
234 if (menuarg.iconidx >= TOOLBAR_NAME_COUNT)
235 menuarg.iconidx = -1;
236 else
237 menuarg.icon_builtin = TRUE;
238 }
239 }
240 else
241 {
242 for (i = 0; i < TOOLBAR_NAME_COUNT; ++i)
243 if (STRNCMP(toolbar_names[i], menu_path, p - menu_path)
244 == 0)
245 {
246 menuarg.iconidx = i;
247 break;
248 }
249 }
250 }
251 }
252 #endif
253
254 #ifdef FEAT_MULTI_LANG
255 /*
256 * Translate menu names as specified with ":menutrans" commands.
257 */
258 menu_path = arg;
259 while (*menu_path)
260 {
261 /* find the end of one part and check if it should be translated */
262 p = menu_skip_part(menu_path);
263 map_to = menutrans_lookup(menu_path, (int)(p - menu_path));
264 if (map_to != NULL)
265 {
266 /* found a match: replace with the translated part */
267 i = (int)STRLEN(map_to);
268 new_cmd = alloc((unsigned)STRLEN(arg) + i + 1);
269 if (new_cmd == NULL)
270 break;
271 mch_memmove(new_cmd, arg, menu_path - arg);
272 mch_memmove(new_cmd + (menu_path - arg), map_to, (size_t)i);
273 STRCPY(new_cmd + (menu_path - arg) + i, p);
274 p = new_cmd + (menu_path - arg) + i;
275 vim_free(tofree);
276 tofree = new_cmd;
277 arg = new_cmd;
278 }
279 if (*p != '.')
280 break;
281 menu_path = p + 1;
282 }
283 #endif
284
285 /*
286 * Isolate the menu name.
287 * Skip the menu name, and translate <Tab> into a real TAB.
288 */
289 menu_path = arg;
290 if (*menu_path == '.')
291 {
292 EMSG2(_(e_invarg2), menu_path);
293 goto theend;
294 }
295
296 while (*arg && !vim_iswhite(*arg))
297 {
298 if ((*arg == '\\' || *arg == Ctrl_V) && arg[1] != NUL)
299 arg++;
300 else if (STRNICMP(arg, "<TAB>", 5) == 0)
301 {
302 *arg = TAB;
303 STRMOVE(arg + 1, arg + 5);
304 }
305 arg++;
306 }
307 if (*arg != NUL)
308 *arg++ = NUL;
309 arg = skipwhite(arg);
310 map_to = arg;
311
312 /*
313 * If there is only a menu name, display menus with that name.
314 */
315 if (*map_to == NUL && !unmenu && enable == MAYBE)
316 {
317 show_menus(menu_path, modes);
318 goto theend;
319 }
320 else if (*map_to != NUL && (unmenu || enable != MAYBE))
321 {
322 EMSG(_(e_trailing));
323 goto theend;
324 }
325 #if defined(FEAT_GUI) && !(defined(FEAT_GUI_GTK) || defined(FEAT_GUI_PHOTON) \
326 || defined(FEAT_GUI_MACVIM))
327 old_menu_height = gui.menu_height;
328 # if defined(FEAT_TOOLBAR) && !defined(FEAT_GUI_W32) && !defined(FEAT_GUI_W16)
329 old_toolbar_height = gui.toolbar_height;
330 # endif
331 #endif
332
333 if (enable != MAYBE)
334 {
335 /*
336 * Change sensitivity of the menu.
337 * For the PopUp menu, remove a menu for each mode separately.
338 * Careful: menu_nable_recurse() changes menu_path.
339 */
340 if (STRCMP(menu_path, "*") == 0) /* meaning: do all menus */
341 menu_path = (char_u *)"";
342
343 if (menu_is_popup(menu_path))
344 {
345 for (i = 0; i < MENU_INDEX_TIP; ++i)
346 if (modes & (1 << i))
347 {
348 p = popup_mode_name(menu_path, i);
349 if (p != NULL)
350 {
351 menu_nable_recurse(root_menu, p, MENU_ALL_MODES,
352 enable);
353 vim_free(p);
354 }
355 }
356 }
357 menu_nable_recurse(root_menu, menu_path, modes, enable);
358 }
359 else if (unmenu)
360 {
361 /*
362 * Delete menu(s).
363 */
364 if (STRCMP(menu_path, "*") == 0) /* meaning: remove all menus */
365 menu_path = (char_u *)"";
366
367 /*
368 * For the PopUp menu, remove a menu for each mode separately.
369 */
370 if (menu_is_popup(menu_path))
371 {
372 for (i = 0; i < MENU_INDEX_TIP; ++i)
373 if (modes & (1 << i))
374 {
375 p = popup_mode_name(menu_path, i);
376 if (p != NULL)
377 {
378 remove_menu(&root_menu, p, MENU_ALL_MODES, TRUE);
379 vim_free(p);
380 }
381 }
382 }
383
384 /* Careful: remove_menu() changes menu_path */
385 remove_menu(&root_menu, menu_path, modes, FALSE);
386 }
387 else
388 {
389 /*
390 * Add menu(s).
391 * Replace special key codes.
392 */
393 if (STRICMP(map_to, "<nop>") == 0) /* "<Nop>" means nothing */
394 {
395 map_to = (char_u *)"";
396 map_buf = NULL;
397 }
398 else if (modes & MENU_TIP_MODE)
399 map_buf = NULL; /* Menu tips are plain text. */
400 else
401 map_to = replace_termcodes(map_to, &map_buf, FALSE, TRUE, special);
402 menuarg.modes = modes;
403 #ifdef FEAT_TOOLBAR
404 menuarg.iconfile = icon;
405 #endif
406 menuarg.noremap[0] = noremap;
407 menuarg.silent[0] = silent;
408 add_menu_path(menu_path, &menuarg, pri_tab, map_to
409 #ifdef FEAT_GUI_W32
410 , TRUE
411 #endif
412 );
413
414 /*
415 * For the PopUp menu, add a menu for each mode separately.
416 */
417 if (menu_is_popup(menu_path))
418 {
419 for (i = 0; i < MENU_INDEX_TIP; ++i)
420 if (modes & (1 << i))
421 {
422 p = popup_mode_name(menu_path, i);
423 if (p != NULL)
424 {
425 /* Include all modes, to make ":amenu" work */
426 menuarg.modes = modes;
427 #ifdef FEAT_TOOLBAR
428 menuarg.iconfile = NULL;
429 menuarg.iconidx = -1;
430 menuarg.icon_builtin = FALSE;
431 #endif
432 add_menu_path(p, &menuarg, pri_tab, map_to
433 #ifdef FEAT_GUI_W32
434 , TRUE
435 #endif
436 );
437 vim_free(p);
438 }
439 }
440 }
441
442 vim_free(map_buf);
443 }
444
445 #if defined(FEAT_GUI) && !(defined(FEAT_GUI_GTK) || defined(FEAT_GUI_MACVIM))
446 /* If the menubar height changed, resize the window */
447 if (gui.in_use
448 && (gui.menu_height != old_menu_height
449 # if defined(FEAT_TOOLBAR) && !defined(FEAT_GUI_W32) && !defined(FEAT_GUI_W16)
450 || gui.toolbar_height != old_toolbar_height
451 # endif
452 ))
453 gui_set_shellsize(FALSE, FALSE, RESIZE_VERT);
454 #endif
455
456 theend:
457 #ifdef FEAT_MULTI_LANG
458 vim_free(tofree);
459 #else
460 ;
461 #endif
462 }
463
464 /*
465 * Add the menu with the given name to the menu hierarchy
466 */
467 static int
468 add_menu_path(menu_path, menuarg, pri_tab, call_data
469 #ifdef FEAT_GUI_W32
470 , addtearoff
471 #endif
472 )
473 char_u *menu_path;
474 vimmenu_T *menuarg; /* passes modes, iconfile, iconidx,
475 icon_builtin, silent[0], noremap[0] */
476 int *pri_tab;
477 char_u *call_data;
478 #ifdef FEAT_GUI_W32
479 int addtearoff; /* may add tearoff item */
480 #endif
481 {
482 char_u *path_name;
483 int modes = menuarg->modes;
484 vimmenu_T **menup;
485 vimmenu_T *menu = NULL;
486 vimmenu_T *parent;
487 vimmenu_T **lower_pri;
488 char_u *p;
489 char_u *name;
490 char_u *dname;
491 char_u *next_name;
492 int i;
493 int c;
494 #ifdef FEAT_GUI
495 int idx;
496 int new_idx;
497 #endif
498 int pri_idx = 0;
499 int old_modes = 0;
500 int amenu;
501
502 /* Make a copy so we can stuff around with it, since it could be const */
503 path_name = vim_strsave(menu_path);
504 if (path_name == NULL)
505 return FAIL;
506 menup = &root_menu;
507 parent = NULL;
508 name = path_name;
509 while (*name)
510 {
511 /* Get name of this element in the menu hierarchy, and the simplified
512 * name (without mnemonic and accelerator text). */
513 next_name = menu_name_skip(name);
514 dname = menu_text(name, NULL, NULL);
515 if (dname == NULL)
516 goto erret;
517 if (*dname == NUL)
518 {
519 /* Only a mnemonic or accelerator is not valid. */
520 EMSG(_("E792: Empty menu name"));
521 goto erret;
522 }
523
524 /* See if it's already there */
525 lower_pri = menup;
526 #ifdef FEAT_GUI
527 idx = 0;
528 new_idx = 0;
529 #endif
530 menu = *menup;
531 while (menu != NULL)
532 {
533 if (menu_name_equal(name, menu) || menu_name_equal(dname, menu))
534 {
535 if (*next_name == NUL && menu->children != NULL)
536 {
537 if (!sys_menu)
538 EMSG(_("E330: Menu path must not lead to a sub-menu"));
539 goto erret;
540 }
541 if (*next_name != NUL && menu->children == NULL
542 #ifdef FEAT_GUI_W32
543 && addtearoff
544 #endif
545 )
546 {
547 if (!sys_menu)
548 EMSG(_(e_notsubmenu));
549 goto erret;
550 }
551 break;
552 }
553 menup = &menu->next;
554
555 /* Count menus, to find where this one needs to be inserted.
556 * Ignore menus that are not in the menubar (PopUp and Toolbar) */
557 if (parent != NULL || menu_is_menubar(menu->name))
558 {
559 #ifdef FEAT_GUI
560 ++idx;
561 #endif
562 if (menu->priority <= pri_tab[pri_idx])
563 {
564 lower_pri = menup;
565 #ifdef FEAT_GUI
566 new_idx = idx;
567 #endif
568 }
569 }
570 menu = menu->next;
571 }
572
573 if (menu == NULL)
574 {
575 if (*next_name == NUL && parent == NULL)
576 {
577 EMSG(_("E331: Must not add menu items directly to menu bar"));
578 goto erret;
579 }
580
581 if (menu_is_separator(dname) && *next_name != NUL)
582 {
583 EMSG(_("E332: Separator cannot be part of a menu path"));
584 goto erret;
585 }
586
587 /* Not already there, so lets add it */
588 menu = (vimmenu_T *)alloc_clear((unsigned)sizeof(vimmenu_T));
589 if (menu == NULL)
590 goto erret;
591
592 menu->modes = modes;
593 menu->enabled = MENU_ALL_MODES;
594 menu->name = vim_strsave(name);
595 /* separate mnemonic and accelerator text from actual menu name */
596 menu->dname = menu_text(name, &menu->mnemonic, &menu->actext);
597 menu->priority = pri_tab[pri_idx];
598 menu->parent = parent;
599 #ifdef FEAT_GUI_MOTIF
600 menu->sensitive = TRUE; /* the default */
601 #endif
602 #ifdef FEAT_BEVAL_TIP
603 menu->tip = NULL;
604 #endif
605 #ifdef FEAT_GUI_ATHENA
606 menu->image = None; /* X-Windows definition for NULL*/
607 #endif
608
609 /*
610 * Add after menu that has lower priority.
611 */
612 menu->next = *lower_pri;
613 *lower_pri = menu;
614
615 old_modes = 0;
616
617 #ifdef FEAT_TOOLBAR
618 menu->iconidx = menuarg->iconidx;
619 menu->icon_builtin = menuarg->icon_builtin;
620 if (*next_name == NUL && menuarg->iconfile != NULL)
621 menu->iconfile = vim_strsave(menuarg->iconfile);
622 #endif
623 #if defined(FEAT_GUI_W32) && defined(FEAT_TEAROFF)
624 /* the tearoff item must be present in the modes of each item. */
625 if (parent != NULL && menu_is_tearoff(parent->children->dname))
626 parent->children->modes |= modes;
627 #endif
628 }
629 else
630 {
631 old_modes = menu->modes;
632
633 /*
634 * If this menu option was previously only available in other
635 * modes, then make sure it's available for this one now
636 * Also enable a menu when it's created or changed.
637 */
638 #ifdef FEAT_GUI_W32
639 /* If adding a tearbar (addtearoff == FALSE) don't update modes */
640 if (addtearoff)
641 #endif
642 {
643 menu->modes |= modes;
644 menu->enabled |= modes;
645 }
646 }
647
648 #ifdef FEAT_GUI
649 /*
650 * Add the menu item when it's used in one of the modes, but not when
651 * only a tooltip is defined.
652 */
653 if ((old_modes & MENU_ALL_MODES) == 0
654 && (menu->modes & MENU_ALL_MODES) != 0)
655 {
656 if (gui.in_use) /* Otherwise it will be added when GUI starts */
657 {
658 if (*next_name == NUL)
659 {
660 /* Real menu item, not sub-menu */
661 gui_mch_add_menu_item(menu, new_idx);
662
663 /* Want to update menus now even if mode not changed */
664 force_menu_update = TRUE;
665 }
666 else
667 {
668 /* Sub-menu (not at end of path yet) */
669 gui_mch_add_menu(menu, new_idx);
670 }
671 }
672
673 # if defined(FEAT_GUI_W32) & defined(FEAT_TEAROFF)
674 /* When adding a new submenu, may add a tearoff item */
675 if ( addtearoff
676 && *next_name
677 && vim_strchr(p_go, GO_TEAROFF) != NULL
678 && menu_is_menubar(name))
679 {
680 char_u *tearpath;
681
682 /*
683 * The pointers next_name & path_name refer to a string with
684 * \'s and ^V's stripped out. But menu_path is a "raw"
685 * string, so we must correct for special characters.
686 */
687 tearpath = alloc((unsigned int)STRLEN(menu_path) + TEAR_LEN + 2);
688 if (tearpath != NULL)
689 {
690 char_u *s;
691 int idx;
692
693 STRCPY(tearpath, menu_path);
694 idx = (int)(next_name - path_name - 1);
695 for (s = tearpath; *s && s < tearpath + idx; mb_ptr_adv(s))
696 {
697 if ((*s == '\\' || *s == Ctrl_V) && s[1])
698 {
699 ++idx;
700 ++s;
701 }
702 }
703 tearpath[idx] = NUL;
704 gui_add_tearoff(tearpath, pri_tab, pri_idx);
705 vim_free(tearpath);
706 }
707 }
708 # endif
709 }
710 #endif /* FEAT_GUI */
711
712 menup = &menu->children;
713 parent = menu;
714 name = next_name;
715 vim_free(dname);
716 dname = NULL;
717 if (pri_tab[pri_idx + 1] != -1)
718 ++pri_idx;
719 }
720 vim_free(path_name);
721
722 /*
723 * Only add system menu items which have not been defined yet.
724 * First check if this was an ":amenu".
725 */
726 amenu = ((modes & (MENU_NORMAL_MODE | MENU_INSERT_MODE)) ==
727 (MENU_NORMAL_MODE | MENU_INSERT_MODE));
728 if (sys_menu)
729 modes &= ~old_modes;
730
731 if (menu != NULL && modes)
732 {
733 #ifdef FEAT_GUI
734 menu->cb = gui_menu_cb;
735 #endif
736 p = (call_data == NULL) ? NULL : vim_strsave(call_data);
737
738 /* loop over all modes, may add more than one */
739 for (i = 0; i < MENU_MODES; ++i)
740 {
741 if (modes & (1 << i))
742 {
743 /* free any old menu */
744 free_menu_string(menu, i);
745
746 /* For "amenu", may insert an extra character.
747 * Don't do this if adding a tearbar (addtearoff == FALSE).
748 * Don't do this for "<Nop>". */
749 c = 0;
750 if (amenu && call_data != NULL && *call_data != NUL
751 #ifdef FEAT_GUI_W32
752 && addtearoff
753 #endif
754 )
755 {
756 switch (1 << i)
757 {
758 case MENU_VISUAL_MODE:
759 case MENU_SELECT_MODE:
760 case MENU_OP_PENDING_MODE:
761 case MENU_CMDLINE_MODE:
762 c = Ctrl_C;
763 break;
764 case MENU_INSERT_MODE:
765 c = Ctrl_O;
766 break;
767 }
768 }
769
770 if (c)
771 {
772 menu->strings[i] = alloc((unsigned)(STRLEN(call_data) + 4));
773 if (menu->strings[i] != NULL)
774 {
775 menu->strings[i][0] = c;
776 STRCPY(menu->strings[i] + 1, call_data);
777 if (c == Ctrl_C)
778 {
779 int len = (int)STRLEN(menu->strings[i]);
780
781 /* Append CTRL-\ CTRL-G to obey 'insertmode'. */
782 menu->strings[i][len] = Ctrl_BSL;
783 menu->strings[i][len + 1] = Ctrl_G;
784 menu->strings[i][len + 2] = NUL;
785 }
786 }
787 }
788 else
789 menu->strings[i] = p;
790 menu->noremap[i] = menuarg->noremap[0];
791 menu->silent[i] = menuarg->silent[0];
792 }
793 }
794 #if defined(FEAT_TOOLBAR) && !defined(FEAT_GUI_W32) \
795 && (defined(FEAT_BEVAL) || defined(FEAT_GUI_GTK))
796 /* Need to update the menu tip. */
797 if (modes & MENU_TIP_MODE)
798 gui_mch_menu_set_tip(menu);
799 #endif
800 }
801 return OK;
802
803 erret:
804 vim_free(path_name);
805 vim_free(dname);
806
807 /* Delete any empty submenu we added before discovering the error. Repeat
808 * for higher levels. */
809 while (parent != NULL && parent->children == NULL)
810 {
811 if (parent->parent == NULL)
812 menup = &root_menu;
813 else
814 menup = &parent->parent->children;
815 for ( ; *menup != NULL && *menup != parent; menup = &((*menup)->next))
816 ;
817 if (*menup == NULL) /* safety check */
818 break;
819 parent = parent->parent;
820 free_menu(menup);
821 }
822 return FAIL;
823 }
824
825 /*
826 * Set the (sub)menu with the given name to enabled or disabled.
827 * Called recursively.
828 */
829 static int
830 menu_nable_recurse(menu, name, modes, enable)
831 vimmenu_T *menu;
832 char_u *name;
833 int modes;
834 int enable;
835 {
836 char_u *p;
837
838 if (menu == NULL)
839 return OK; /* Got to bottom of hierarchy */
840
841 /* Get name of this element in the menu hierarchy */
842 p = menu_name_skip(name);
843
844 /* Find the menu */
845 while (menu != NULL)
846 {
847 if (*name == NUL || *name == '*' || menu_name_equal(name, menu))
848 {
849 if (*p != NUL)
850 {
851 if (menu->children == NULL)
852 {
853 EMSG(_(e_notsubmenu));
854 return FAIL;
855 }
856 if (menu_nable_recurse(menu->children, p, modes, enable)
857 == FAIL)
858 return FAIL;
859 }
860 else
861 if (enable)
862 menu->enabled |= modes;
863 else
864 menu->enabled &= ~modes;
865
866 /*
867 * When name is empty, we are doing all menu items for the given
868 * modes, so keep looping, otherwise we are just doing the named
869 * menu item (which has been found) so break here.
870 */
871 if (*name != NUL && *name != '*')
872 break;
873 }
874 menu = menu->next;
875 }
876 if (*name != NUL && *name != '*' && menu == NULL)
877 {
878 EMSG2(_(e_nomenu), name);
879 return FAIL;
880 }
881
882 #ifdef FEAT_GUI
883 /* Want to update menus now even if mode not changed */
884 force_menu_update = TRUE;
885 #endif
886
887 return OK;
888 }
889
890 /*
891 * Remove the (sub)menu with the given name from the menu hierarchy
892 * Called recursively.
893 */
894 static int
895 remove_menu(menup, name, modes, silent)
896 vimmenu_T **menup;
897 char_u *name;
898 int modes;
899 int silent; /* don't give error messages */
900 {
901 vimmenu_T *menu;
902 vimmenu_T *child;
903 char_u *p;
904
905 if (*menup == NULL)
906 return OK; /* Got to bottom of hierarchy */
907
908 /* Get name of this element in the menu hierarchy */
909 p = menu_name_skip(name);
910
911 /* Find the menu */
912 while ((menu = *menup) != NULL)
913 {
914 if (*name == NUL || menu_name_equal(name, menu))
915 {
916 if (*p != NUL && menu->children == NULL)
917 {
918 if (!silent)
919 EMSG(_(e_notsubmenu));
920 return FAIL;
921 }
922 if ((menu->modes & modes) != 0x0)
923 {
924 #if defined(FEAT_GUI_W32) & defined(FEAT_TEAROFF)
925 /*
926 * If we are removing all entries for this menu,MENU_ALL_MODES,
927 * Then kill any tearoff before we start
928 */
929 if (*p == NUL && modes == MENU_ALL_MODES)
930 {
931 if (IsWindow(menu->tearoff_handle))
932 DestroyWindow(menu->tearoff_handle);
933 }
934 #endif
935 if (remove_menu(&menu->children, p, modes, silent) == FAIL)
936 return FAIL;
937 }
938 else if (*name != NUL)
939 {
940 if (!silent)
941 EMSG(_(e_othermode));
942 return FAIL;
943 }
944
945 /*
946 * When name is empty, we are removing all menu items for the given
947 * modes, so keep looping, otherwise we are just removing the named
948 * menu item (which has been found) so break here.
949 */
950 if (*name != NUL)
951 break;
952
953 /* Remove the menu item for the given mode[s]. If the menu item
954 * is no longer valid in ANY mode, delete it */
955 menu->modes &= ~modes;
956 if (modes & MENU_TIP_MODE)
957 free_menu_string(menu, MENU_INDEX_TIP);
958 if ((menu->modes & MENU_ALL_MODES) == 0)
959 free_menu(menup);
960 else
961 menup = &menu->next;
962 }
963 else
964 menup = &menu->next;
965 }
966 if (*name != NUL)
967 {
968 if (menu == NULL)
969 {
970 if (!silent)
971 EMSG2(_(e_nomenu), name);
972 return FAIL;
973 }
974
975
976 /* Recalculate modes for menu based on the new updated children */
977 menu->modes &= ~modes;
978 #if defined(FEAT_GUI_W32) & defined(FEAT_TEAROFF)
979 if ((s_tearoffs) && (menu->children != NULL)) /* there's a tear bar.. */
980 child = menu->children->next; /* don't count tearoff bar */
981 else
982 #endif
983 child = menu->children;
984 for ( ; child != NULL; child = child->next)
985 menu->modes |= child->modes;
986 if (modes & MENU_TIP_MODE)
987 {
988 free_menu_string(menu, MENU_INDEX_TIP);
989 #if defined(FEAT_TOOLBAR) && !defined(FEAT_GUI_W32) \
990 && (defined(FEAT_BEVAL) || defined(FEAT_GUI_GTK))
991 /* Need to update the menu tip. */
992 if (gui.in_use)
993 gui_mch_menu_set_tip(menu);
994 #endif
995 }
996 if ((menu->modes & MENU_ALL_MODES) == 0)
997 {
998 /* The menu item is no longer valid in ANY mode, so delete it */
999 #if defined(FEAT_GUI_W32) & defined(FEAT_TEAROFF)
1000 if (s_tearoffs && menu->children != NULL) /* there's a tear bar.. */
1001 free_menu(&menu->children);
1002 #endif
1003 *menup = menu;
1004 free_menu(menup);
1005 }
1006 }
1007
1008 return OK;
1009 }
1010
1011 /*
1012 * Free the given menu structure and remove it from the linked list.
1013 */
1014 static void
1015 free_menu(menup)
1016 vimmenu_T **menup;
1017 {
1018 int i;
1019 vimmenu_T *menu;
1020
1021 menu = *menup;
1022
1023 #ifdef FEAT_GUI
1024 /* Free machine specific menu structures (only when already created) */
1025 /* Also may rebuild a tearoff'ed menu */
1026 if (gui.in_use)
1027 gui_mch_destroy_menu(menu);
1028 #endif
1029
1030 /* Don't change *menup until after calling gui_mch_destroy_menu(). The
1031 * MacOS code needs the original structure to properly delete the menu. */
1032 *menup = menu->next;
1033 vim_free(menu->name);
1034 vim_free(menu->dname);
1035 vim_free(menu->actext);
1036 #ifdef FEAT_TOOLBAR
1037 vim_free(menu->iconfile);
1038 # ifdef FEAT_GUI_MOTIF
1039 vim_free(menu->xpm_fname);
1040 # endif
1041 #ifdef FEAT_GUI_MACVIM
1042 vim_free(menu->mac_action);
1043 #endif
1044 #endif
1045 for (i = 0; i < MENU_MODES; i++)
1046 free_menu_string(menu, i);
1047 vim_free(menu);
1048
1049 #ifdef FEAT_GUI
1050 /* Want to update menus now even if mode not changed */
1051 force_menu_update = TRUE;
1052 #endif
1053 }
1054
1055 /*
1056 * Free the menu->string with the given index.
1057 */
1058 static void
1059 free_menu_string(menu, idx)
1060 vimmenu_T *menu;
1061 int idx;
1062 {
1063 int count = 0;
1064 int i;
1065
1066 for (i = 0; i < MENU_MODES; i++)
1067 if (menu->strings[i] == menu->strings[idx])
1068 count++;
1069 if (count == 1)
1070 vim_free(menu->strings[idx]);
1071 menu->strings[idx] = NULL;
1072 }
1073
1074 /*
1075 * Show the mapping associated with a menu item or hierarchy in a sub-menu.
1076 */
1077 static int
1078 show_menus(path_name, modes)
1079 char_u *path_name;
1080 int modes;
1081 {
1082 char_u *p;
1083 char_u *name;
1084 vimmenu_T *menu;
1085 vimmenu_T *parent = NULL;
1086
1087 menu = root_menu;
1088 name = path_name = vim_strsave(path_name);
1089 if (path_name == NULL)
1090 return FAIL;
1091
1092 /* First, find the (sub)menu with the given name */
1093 while (*name)
1094 {
1095 p = menu_name_skip(name);
1096 while (menu != NULL)
1097 {
1098 if (menu_name_equal(name, menu))
1099 {
1100 /* Found menu */
1101 if (*p != NUL && menu->children == NULL)
1102 {
1103 EMSG(_(e_notsubmenu));
1104 vim_free(path_name);
1105 return FAIL;
1106 }
1107 else if ((menu->modes & modes) == 0x0)
1108 {
1109 EMSG(_(e_othermode));
1110 vim_free(path_name);
1111 return FAIL;
1112 }
1113 break;
1114 }
1115 menu = menu->next;
1116 }
1117 if (menu == NULL)
1118 {
1119 EMSG2(_(e_nomenu), name);
1120 vim_free(path_name);
1121 return FAIL;
1122 }
1123 name = p;
1124 parent = menu;
1125 menu = menu->children;
1126 }
1127 vim_free(path_name);
1128
1129 /* Now we have found the matching menu, and we list the mappings */
1130 /* Highlight title */
1131 MSG_PUTS_TITLE(_("\n--- Menus ---"));
1132
1133 show_menus_recursive(parent, modes, 0);
1134 return OK;
1135 }
1136
1137 /*
1138 * Recursively show the mappings associated with the menus under the given one
1139 */
1140 static void
1141 show_menus_recursive(menu, modes, depth)
1142 vimmenu_T *menu;
1143 int modes;
1144 int depth;
1145 {
1146 int i;
1147 int bit;
1148
1149 if (menu != NULL && (menu->modes & modes) == 0x0)
1150 return;
1151
1152 if (menu != NULL)
1153 {
1154 msg_putchar('\n');
1155 if (got_int) /* "q" hit for "--more--" */
1156 return;
1157 for (i = 0; i < depth; i++)
1158 MSG_PUTS(" ");
1159 if (menu->priority)
1160 {
1161 msg_outnum((long)menu->priority);
1162 MSG_PUTS(" ");
1163 }
1164 /* Same highlighting as for directories!? */
1165 msg_outtrans_attr(menu->name, hl_attr(HLF_D));
1166 }
1167
1168 if (menu != NULL && menu->children == NULL)
1169 {
1170 for (bit = 0; bit < MENU_MODES; bit++)
1171 if ((menu->modes & modes & (1 << bit)) != 0)
1172 {
1173 msg_putchar('\n');
1174 if (got_int) /* "q" hit for "--more--" */
1175 return;
1176 for (i = 0; i < depth + 2; i++)
1177 MSG_PUTS(" ");
1178 msg_putchar(menu_mode_chars[bit]);
1179 if (menu->noremap[bit] == REMAP_NONE)
1180 msg_putchar('*');
1181 else if (menu->noremap[bit] == REMAP_SCRIPT)
1182 msg_putchar('&');
1183 else
1184 msg_putchar(' ');
1185 if (menu->silent[bit])
1186 msg_putchar('s');
1187 else
1188 msg_putchar(' ');
1189 if ((menu->modes & menu->enabled & (1 << bit)) == 0)
1190 msg_putchar('-');
1191 else
1192 msg_putchar(' ');
1193 MSG_PUTS(" ");
1194 if (*menu->strings[bit] == NUL)
1195 msg_puts_attr((char_u *)"<Nop>", hl_attr(HLF_8));
1196 else
1197 msg_outtrans_special(menu->strings[bit], FALSE);
1198 }
1199 }
1200 else
1201 {
1202 if (menu == NULL)
1203 {
1204 menu = root_menu;
1205 depth--;
1206 }
1207 else
1208 menu = menu->children;
1209
1210 /* recursively show all children. Skip PopUp[nvoci]. */
1211 for (; menu != NULL && !got_int; menu = menu->next)
1212 if (!menu_is_hidden(menu->dname))
1213 show_menus_recursive(menu, modes, depth + 1);
1214 }
1215 }
1216
1217 #ifdef FEAT_CMDL_COMPL
1218
1219 /*
1220 * Used when expanding menu names.
1221 */
1222 static vimmenu_T *expand_menu = NULL;
1223 static int expand_modes = 0x0;
1224 static int expand_emenu; /* TRUE for ":emenu" command */
1225
1226 /*
1227 * Work out what to complete when doing command line completion of menu names.
1228 */
1229 char_u *
1230 set_context_in_menu_cmd(xp, cmd, arg, forceit)
1231 expand_T *xp;
1232 char_u *cmd;
1233 char_u *arg;
1234 int forceit;
1235 {
1236 char_u *after_dot;
1237 char_u *p;
1238 char_u *path_name = NULL;
1239 char_u *name;
1240 int unmenu;
1241 vimmenu_T *menu;
1242 int expand_menus;
1243
1244 xp->xp_context = EXPAND_UNSUCCESSFUL;
1245
1246
1247 /* Check for priority numbers, enable and disable */
1248 for (p = arg; *p; ++p)
1249 if (!VIM_ISDIGIT(*p) && *p != '.')
1250 break;
1251
1252 if (!vim_iswhite(*p))
1253 {
1254 if (STRNCMP(arg, "enable", 6) == 0
1255 && (arg[6] == NUL || vim_iswhite(arg[6])))
1256 p = arg + 6;
1257 else if (STRNCMP(arg, "disable", 7) == 0
1258 && (arg[7] == NUL || vim_iswhite(arg[7])))
1259 p = arg + 7;
1260 else
1261 p = arg;
1262 }
1263
1264 while (*p != NUL && vim_iswhite(*p))
1265 ++p;
1266
1267 arg = after_dot = p;
1268
1269 for (; *p && !vim_iswhite(*p); ++p)
1270 {
1271 if ((*p == '\\' || *p == Ctrl_V) && p[1] != NUL)
1272 p++;
1273 else if (*p == '.')
1274 after_dot = p + 1;
1275 }
1276
1277 /* ":tearoff" and ":popup" only use menus, not entries */
1278 expand_menus = !((*cmd == 't' && cmd[1] == 'e') || *cmd == 'p');
1279 expand_emenu = (*cmd == 'e');
1280 if (expand_menus && vim_iswhite(*p))
1281 return NULL; /* TODO: check for next command? */
1282 if (*p == NUL) /* Complete the menu name */
1283 {
1284 /*
1285 * With :unmenu, you only want to match menus for the appropriate mode.
1286 * With :menu though you might want to add a menu with the same name as
1287 * one in another mode, so match menus from other modes too.
1288 */
1289 expand_modes = get_menu_cmd_modes(cmd, forceit, NULL, &unmenu);
1290 if (!unmenu)
1291 expand_modes = MENU_ALL_MODES;
1292
1293 menu = root_menu;
1294 if (after_dot != arg)
1295 {
1296 path_name = alloc((unsigned)(after_dot - arg));
1297 if (path_name == NULL)
1298 return NULL;
1299 vim_strncpy(path_name, arg, after_dot - arg - 1);
1300 }
1301 name = path_name;
1302 while (name != NULL && *name)
1303 {
1304 p = menu_name_skip(name);
1305 while (menu != NULL)
1306 {
1307 if (menu_name_equal(name, menu))
1308 {
1309 /* Found menu */
1310 if ((*p != NUL && menu->children == NULL)
1311 || ((menu->modes & expand_modes) == 0x0))
1312 {
1313 /*
1314 * Menu path continues, but we have reached a leaf.
1315 * Or menu exists only in another mode.
1316 */
1317 vim_free(path_name);
1318 return NULL;
1319 }
1320 break;
1321 }
1322 menu = menu->next;
1323 }
1324 if (menu == NULL)
1325 {
1326 /* No menu found with the name we were looking for */
1327 vim_free(path_name);
1328 return NULL;
1329 }
1330 name = p;
1331 menu = menu->children;
1332 }
1333 vim_free(path_name);
1334
1335 xp->xp_context = expand_menus ? EXPAND_MENUNAMES : EXPAND_MENUS;
1336 xp->xp_pattern = after_dot;
1337 expand_menu = menu;
1338 }
1339 else /* We're in the mapping part */
1340 xp->xp_context = EXPAND_NOTHING;
1341 return NULL;
1342 }
1343
1344 /*
1345 * Function given to ExpandGeneric() to obtain the list of (sub)menus (not
1346 * entries).
1347 */
1348 /*ARGSUSED*/
1349 char_u *
1350 get_menu_name(xp, idx)
1351 expand_T *xp;
1352 int idx;
1353 {
1354 static vimmenu_T *menu = NULL;
1355 char_u *str;
1356
1357 if (idx == 0) /* first call: start at first item */
1358 menu = expand_menu;
1359
1360 /* Skip PopUp[nvoci]. */
1361 while (menu != NULL && (menu_is_hidden(menu->dname)
1362 || menu_is_separator(menu->dname)
1363 || menu_is_tearoff(menu->dname)
1364 || menu->children == NULL))
1365 menu = menu->next;
1366
1367 if (menu == NULL) /* at end of linked list */
1368 return NULL;
1369
1370 if (menu->modes & expand_modes)
1371 str = menu->dname;
1372 else
1373 str = (char_u *)"";
1374
1375 /* Advance to next menu entry. */
1376 menu = menu->next;
1377
1378 return str;
1379 }
1380
1381 /*
1382 * Function given to ExpandGeneric() to obtain the list of menus and menu
1383 * entries.
1384 */
1385 /*ARGSUSED*/
1386 char_u *
1387 get_menu_names(xp, idx)
1388 expand_T *xp;
1389 int idx;
1390 {
1391 static vimmenu_T *menu = NULL;
1392 static char_u tbuffer[256]; /*hack*/
1393 char_u *str;
1394
1395 if (idx == 0) /* first call: start at first item */
1396 menu = expand_menu;
1397
1398 /* Skip Browse-style entries, popup menus and separators. */
1399 while (menu != NULL
1400 && ( menu_is_hidden(menu->dname)
1401 || (expand_emenu && menu_is_separator(menu->dname))
1402 || menu_is_tearoff(menu->dname)
1403 #ifndef FEAT_BROWSE
1404 || menu->dname[STRLEN(menu->dname) - 1] == '.'
1405 #endif
1406 ))
1407 menu = menu->next;
1408
1409 if (menu == NULL) /* at end of linked list */
1410 return NULL;
1411
1412 if (menu->modes & expand_modes)
1413 {
1414 if (menu->children != NULL)
1415 {
1416 STRCPY(tbuffer, menu->dname);
1417 /* hack on menu separators: use a 'magic' char for the separator
1418 * so that '.' in names gets escaped properly */
1419 STRCAT(tbuffer, "\001");
1420 str = tbuffer;
1421 }
1422 else
1423 str = menu->dname;
1424 }
1425 else
1426 str = (char_u *)"";
1427
1428 /* Advance to next menu entry. */
1429 menu = menu->next;
1430
1431 return str;
1432 }
1433 #endif /* FEAT_CMDL_COMPL */
1434
1435 /*
1436 * Skip over this element of the menu path and return the start of the next
1437 * element. Any \ and ^Vs are removed from the current element.
1438 * "name" may be modified.
1439 */
1440 char_u *
1441 menu_name_skip(name)
1442 char_u *name;
1443 {
1444 char_u *p;
1445
1446 for (p = name; *p && *p != '.'; mb_ptr_adv(p))
1447 {
1448 if (*p == '\\' || *p == Ctrl_V)
1449 {
1450 STRMOVE(p, p + 1);
1451 if (*p == NUL)
1452 break;
1453 }
1454 }
1455 if (*p)
1456 *p++ = NUL;
1457 return p;
1458 }
1459
1460 /*
1461 * Return TRUE when "name" matches with menu "menu". The name is compared in
1462 * two ways: raw menu name and menu name without '&'. ignore part after a TAB.
1463 */
1464 static int
1465 menu_name_equal(name, menu)
1466 char_u *name;
1467 vimmenu_T *menu;
1468 {
1469 return (menu_namecmp(name, menu->name) || menu_namecmp(name, menu->dname));
1470 }
1471
1472 static int
1473 menu_namecmp(name, mname)
1474 char_u *name;
1475 char_u *mname;
1476 {
1477 int i;
1478
1479 for (i = 0; name[i] != NUL && name[i] != TAB; ++i)
1480 if (name[i] != mname[i])
1481 break;
1482 return ((name[i] == NUL || name[i] == TAB)
1483 && (mname[i] == NUL || mname[i] == TAB));
1484 }
1485
1486 /*
1487 * Return the modes specified by the given menu command (eg :menu! returns
1488 * MENU_CMDLINE_MODE | MENU_INSERT_MODE).
1489 * If "noremap" is not NULL, then the flag it points to is set according to
1490 * whether the command is a "nore" command.
1491 * If "unmenu" is not NULL, then the flag it points to is set according to
1492 * whether the command is an "unmenu" command.
1493 */
1494 static int
1495 get_menu_cmd_modes(cmd, forceit, noremap, unmenu)
1496 char_u *cmd;
1497 int forceit; /* Was there a "!" after the command? */
1498 int *noremap;
1499 int *unmenu;
1500 {
1501 int modes;
1502
1503 switch (*cmd++)
1504 {
1505 case 'v': /* vmenu, vunmenu, vnoremenu */
1506 modes = MENU_VISUAL_MODE | MENU_SELECT_MODE;
1507 break;
1508 case 'x': /* xmenu, xunmenu, xnoremenu */
1509 modes = MENU_VISUAL_MODE;
1510 break;
1511 case 's': /* smenu, sunmenu, snoremenu */
1512 modes = MENU_SELECT_MODE;
1513 break;
1514 case 'o': /* omenu */
1515 modes = MENU_OP_PENDING_MODE;
1516 break;
1517 case 'i': /* imenu */
1518 modes = MENU_INSERT_MODE;
1519 break;
1520 case 't':
1521 modes = MENU_TIP_MODE; /* tmenu */
1522 break;
1523 case 'c': /* cmenu */
1524 modes = MENU_CMDLINE_MODE;
1525 break;
1526 case 'a': /* amenu */
1527 modes = MENU_INSERT_MODE | MENU_CMDLINE_MODE | MENU_NORMAL_MODE
1528 | MENU_VISUAL_MODE | MENU_SELECT_MODE
1529 | MENU_OP_PENDING_MODE;
1530 break;
1531 case 'n':
1532 if (*cmd != 'o') /* nmenu, not noremenu */
1533 {
1534 modes = MENU_NORMAL_MODE;
1535 break;
1536 }
1537 /* FALLTHROUGH */
1538 default:
1539 --cmd;
1540 if (forceit) /* menu!! */
1541 modes = MENU_INSERT_MODE | MENU_CMDLINE_MODE;
1542 else /* menu */
1543 modes = MENU_NORMAL_MODE | MENU_VISUAL_MODE | MENU_SELECT_MODE
1544 | MENU_OP_PENDING_MODE;
1545 }
1546
1547 if (noremap != NULL)
1548 *noremap = (*cmd == 'n' ? REMAP_NONE : REMAP_YES);
1549 if (unmenu != NULL)
1550 *unmenu = (*cmd == 'u');
1551 return modes;
1552 }
1553
1554 /*
1555 * Modify a menu name starting with "PopUp" to include the mode character.
1556 * Returns the name in allocated memory (NULL for failure).
1557 */
1558 static char_u *
1559 popup_mode_name(name, idx)
1560 char_u *name;
1561 int idx;
1562 {
1563 char_u *p;
1564 int len = (int)STRLEN(name);
1565
1566 p = vim_strnsave(name, len + 1);
1567 if (p != NULL)
1568 {
1569 mch_memmove(p + 6, p + 5, (size_t)(len - 4));
1570 p[5] = menu_mode_chars[idx];
1571 }
1572 return p;
1573 }
1574
1575 #if defined(FEAT_GUI) || defined(PROTO)
1576 /*
1577 * Return the index into the menu->strings or menu->noremap arrays for the
1578 * current state. Returns MENU_INDEX_INVALID if there is no mapping for the
1579 * given menu in the current mode.
1580 */
1581 int
1582 get_menu_index(menu, state)
1583 vimmenu_T *menu;
1584 int state;
1585 {
1586 int idx;
1587
1588 if ((state & INSERT))
1589 idx = MENU_INDEX_INSERT;
1590 else if (state & CMDLINE)
1591 idx = MENU_INDEX_CMDLINE;
1592 #ifdef FEAT_VISUAL
1593 else if (VIsual_active)
1594 {
1595 if (VIsual_select)
1596 idx = MENU_INDEX_SELECT;
1597 else
1598 idx = MENU_INDEX_VISUAL;
1599 }
1600 #endif
1601 else if (state == HITRETURN || state == ASKMORE)
1602 idx = MENU_INDEX_CMDLINE;
1603 else if (finish_op)
1604 idx = MENU_INDEX_OP_PENDING;
1605 else if ((state & NORMAL))
1606 idx = MENU_INDEX_NORMAL;
1607 else
1608 idx = MENU_INDEX_INVALID;
1609
1610 if (idx != MENU_INDEX_INVALID && menu->strings[idx] == NULL)
1611 idx = MENU_INDEX_INVALID;
1612 return idx;
1613 }
1614 #endif
1615
1616 /*
1617 * Duplicate the menu item text and then process to see if a mnemonic key
1618 * and/or accelerator text has been identified.
1619 * Returns a pointer to allocated memory, or NULL for failure.
1620 * If mnemonic != NULL, *mnemonic is set to the character after the first '&'.
1621 * If actext != NULL, *actext is set to the text after the first TAB.
1622 */
1623 static char_u *
1624 menu_text(str, mnemonic, actext)
1625 char_u *str;
1626 int *mnemonic;
1627 char_u **actext;
1628 {
1629 char_u *p;
1630 char_u *text;
1631
1632 /* Locate accelerator text, after the first TAB */
1633 p = vim_strchr(str, TAB);
1634 if (p != NULL)
1635 {
1636 if (actext != NULL)
1637 *actext = vim_strsave(p + 1);
1638 text = vim_strnsave(str, (int)(p - str));
1639 }
1640 else
1641 text = vim_strsave(str);
1642
1643 /* Find mnemonic characters "&a" and reduce "&&" to "&". */
1644 for (p = text; p != NULL; )
1645 {
1646 p = vim_strchr(p, '&');
1647 if (p != NULL)
1648 {
1649 if (p[1] == NUL) /* trailing "&" */
1650 break;
1651 if (mnemonic != NULL && p[1] != '&')
1652 #if !defined(__MVS__) || defined(MOTIF390_MNEMONIC_FIXED)
1653 *mnemonic = p[1];
1654 #else
1655 {
1656 /*
1657 * Well there is a bug in the Motif libraries on OS390 Unix.
1658 * The mnemonic keys needs to be converted to ASCII values
1659 * first.
1660 * This behavior has been seen in 2.8 and 2.9.
1661 */
1662 char c = p[1];
1663 __etoa_l(&c, 1);
1664 *mnemonic = c;
1665 }
1666 #endif
1667 STRMOVE(p, p + 1);
1668 p = p + 1;
1669 }
1670 }
1671 return text;
1672 }
1673
1674 /*
1675 * Return TRUE if "name" can be a menu in the MenuBar.
1676 */
1677 int
1678 menu_is_menubar(name)
1679 char_u *name;
1680 {
1681 return (!menu_is_popup(name)
1682 && !menu_is_toolbar(name)
1683 && *name != MNU_HIDDEN_CHAR);
1684 }
1685
1686 /*
1687 * Return TRUE if "name" is a popup menu name.
1688 */
1689 int
1690 menu_is_popup(name)
1691 char_u *name;
1692 {
1693 return (STRNCMP(name, "PopUp", 5) == 0);
1694 }
1695
1696 #if (defined(FEAT_GUI_MOTIF) && (XmVersion <= 1002)) || defined(PROTO)
1697 /*
1698 * Return TRUE if "name" is part of a popup menu.
1699 */
1700 int
1701 menu_is_child_of_popup(menu)
1702 vimmenu_T *menu;
1703 {
1704 while (menu->parent != NULL)
1705 menu = menu->parent;
1706 return menu_is_popup(menu->name);
1707 }
1708 #endif
1709
1710 /*
1711 * Return TRUE if "name" is a toolbar menu name.
1712 */
1713 int
1714 menu_is_toolbar(name)
1715 char_u *name;
1716 {
1717 return (STRNCMP(name, "ToolBar", 7) == 0);
1718 }
1719
1720 /*
1721 * Return TRUE if the name is a menu separator identifier: Starts and ends
1722 * with '-'
1723 */
1724 int
1725 menu_is_separator(name)
1726 char_u *name;
1727 {
1728 return (name[0] == '-' && name[STRLEN(name) - 1] == '-');
1729 }
1730
1731 /*
1732 * Return TRUE if the menu is hidden: Starts with ']'
1733 */
1734 static int
1735 menu_is_hidden(name)
1736 char_u *name;
1737 {
1738 return (name[0] == ']') || (menu_is_popup(name) && name[5] != NUL);
1739 }
1740
1741 #if defined(FEAT_CMDL_COMPL) \
1742 || (defined(FEAT_GUI_W32) && defined(FEAT_TEAROFF))
1743 /*
1744 * Return TRUE if the menu is the tearoff menu.
1745 */
1746 /*ARGSUSED*/
1747 static int
1748 menu_is_tearoff(name)
1749 char_u *name;
1750 {
1751 #ifdef FEAT_GUI
1752 return (STRCMP(name, TEAR_STRING) == 0);
1753 #else
1754 return FALSE;
1755 #endif
1756 }
1757 #endif
1758
1759 #ifdef FEAT_GUI
1760
1761 static int
1762 get_menu_mode()
1763 {
1764 #ifdef FEAT_VISUAL
1765 if (VIsual_active)
1766 {
1767 if (VIsual_select)
1768 return MENU_INDEX_SELECT;
1769 return MENU_INDEX_VISUAL;
1770 }
1771 #endif
1772 if (State & INSERT)
1773 return MENU_INDEX_INSERT;
1774 if ((State & CMDLINE) || State == ASKMORE || State == HITRETURN)
1775 return MENU_INDEX_CMDLINE;
1776 if (finish_op)
1777 return MENU_INDEX_OP_PENDING;
1778 if (State & NORMAL)
1779 return MENU_INDEX_NORMAL;
1780 if (State & LANGMAP) /* must be a "r" command, like Insert mode */
1781 return MENU_INDEX_INSERT;
1782 return MENU_INDEX_INVALID;
1783 }
1784
1785 /*
1786 * Check that a pointer appears in the menu tree. Used to protect from using
1787 * a menu that was deleted after it was selected but before the event was
1788 * handled.
1789 * Return OK or FAIL. Used recursively.
1790 */
1791 int
1792 check_menu_pointer(root, menu_to_check)
1793 vimmenu_T *root;
1794 vimmenu_T *menu_to_check;
1795 {
1796 vimmenu_T *p;
1797
1798 for (p = root; p != NULL; p = p->next)
1799 if (p == menu_to_check
1800 || (p->children != NULL
1801 && check_menu_pointer(p->children, menu_to_check) == OK))
1802 return OK;
1803 return FAIL;
1804 }
1805
1806 /*
1807 * After we have started the GUI, then we can create any menus that have been
1808 * defined. This is done once here. add_menu_path() may have already been
1809 * called to define these menus, and may be called again. This function calls
1810 * itself recursively. Should be called at the top level with:
1811 * gui_create_initial_menus(root_menu, NULL);
1812 */
1813 void
1814 gui_create_initial_menus(menu)
1815 vimmenu_T *menu;
1816 {
1817 int idx = 0;
1818
1819 while (menu != NULL)
1820 {
1821 /* Don't add a menu when only a tip was defined. */
1822 if (menu->modes & MENU_ALL_MODES)
1823 {
1824 if (menu->children != NULL)
1825 {
1826 gui_mch_add_menu(menu, idx);
1827 gui_create_initial_menus(menu->children);
1828 }
1829 else
1830 gui_mch_add_menu_item(menu, idx);
1831 }
1832 menu = menu->next;
1833 ++idx;
1834 }
1835 }
1836
1837 /*
1838 * Used recursively by gui_update_menus (see below)
1839 */
1840 static void
1841 gui_update_menus_recurse(menu, mode)
1842 vimmenu_T *menu;
1843 int mode;
1844 {
1845 int grey;
1846
1847 while (menu)
1848 {
1849 if ((menu->modes & menu->enabled & mode)
1850 #if defined(FEAT_GUI_W32) && defined(FEAT_TEAROFF)
1851 || menu_is_tearoff(menu->dname)
1852 #endif
1853 )
1854 grey = FALSE;
1855 else
1856 grey = TRUE;
1857 #ifdef FEAT_GUI_ATHENA
1858 /* Hiding menus doesn't work for Athena, it can cause a crash. */
1859 gui_mch_menu_grey(menu, grey);
1860 #else
1861 /* Never hide a toplevel menu, it may make the menubar resize or
1862 * disappear. Same problem for ToolBar items. */
1863 if (vim_strchr(p_go, GO_GREY) != NULL || menu->parent == NULL
1864 # ifdef FEAT_TOOLBAR
1865 || menu_is_toolbar(menu->parent->name)
1866 # endif
1867 )
1868 gui_mch_menu_grey(menu, grey);
1869 else
1870 gui_mch_menu_hidden(menu, grey);
1871 #endif
1872 gui_update_menus_recurse(menu->children, mode);
1873 menu = menu->next;
1874 }
1875 }
1876
1877 /*
1878 * Make sure only the valid menu items appear for this mode. If
1879 * force_menu_update is not TRUE, then we only do this if the mode has changed
1880 * since last time. If "modes" is not 0, then we use these modes instead.
1881 */
1882 void
1883 gui_update_menus(modes)
1884 int modes;
1885 {
1886 static int prev_mode = -1;
1887 int mode = 0;
1888
1889 if (modes != 0x0)
1890 mode = modes;
1891 else
1892 {
1893 mode = get_menu_mode();
1894 if (mode == MENU_INDEX_INVALID)
1895 mode = 0;
1896 else
1897 mode = (1 << mode);
1898 }
1899
1900 if (force_menu_update || mode != prev_mode)
1901 {
1902 gui_update_menus_recurse(root_menu, mode);
1903 gui_mch_draw_menubar();
1904 prev_mode = mode;
1905 force_menu_update = FALSE;
1906 #ifdef FEAT_GUI_W32
1907 /* This can leave a tearoff as active window - make sure we
1908 * have the focus <negri>*/
1909 gui_mch_activate_window();
1910 #endif
1911 }
1912 }
1913
1914 #if defined(FEAT_GUI_MSWIN) || defined(FEAT_GUI_MOTIF) \
1915 || defined(FEAT_GUI_GTK) || defined(FEAT_GUI_PHOTON) || defined(PROTO)
1916 /*
1917 * Check if a key is used as a mnemonic for a toplevel menu.
1918 * Case of the key is ignored.
1919 */
1920 int
1921 gui_is_menu_shortcut(key)
1922 int key;
1923 {
1924 vimmenu_T *menu;
1925
1926 if (key < 256)
1927 key = TOLOWER_LOC(key);
1928 for (menu = root_menu; menu != NULL; menu = menu->next)
1929 if (menu->mnemonic == key
1930 || (menu->mnemonic < 256 && TOLOWER_LOC(menu->mnemonic) == key))
1931 return TRUE;
1932 return FALSE;
1933 }
1934 #endif
1935
1936 /*
1937 * Display the Special "PopUp" menu as a pop-up at the current mouse
1938 * position. The "PopUpn" menu is for Normal mode, "PopUpi" for Insert mode,
1939 * etc.
1940 */
1941 void
1942 gui_show_popupmenu()
1943 {
1944 vimmenu_T *menu;
1945 int mode;
1946
1947 mode = get_menu_mode();
1948 if (mode == MENU_INDEX_INVALID)
1949 return;
1950 mode = menu_mode_chars[mode];
1951
1952 #ifdef FEAT_AUTOCMD
1953 {
1954 char_u ename[2];
1955
1956 ename[0] = mode;
1957 ename[1] = NUL;
1958 apply_autocmds(EVENT_MENUPOPUP, ename, NULL, FALSE, curbuf);
1959 }
1960 #endif
1961
1962 for (menu = root_menu; menu != NULL; menu = menu->next)
1963 if (STRNCMP("PopUp", menu->name, 5) == 0 && menu->name[5] == mode)
1964 break;
1965
1966 /* Only show a popup when it is defined and has entries */
1967 if (menu != NULL && menu->children != NULL)
1968 gui_mch_show_popupmenu(menu);
1969 }
1970 #endif /* FEAT_GUI */
1971
1972 #if (defined(FEAT_GUI_W32) && defined(FEAT_TEAROFF)) || defined(PROTO)
1973
1974 /*
1975 * Deal with tearoff items that are added like a menu item.
1976 * Currently only for Win32 GUI. Others may follow later.
1977 */
1978
1979 void
1980 gui_mch_toggle_tearoffs(int enable)
1981 {
1982 int pri_tab[MENUDEPTH + 1];
1983 int i;
1984
1985 if (enable)
1986 {
1987 for (i = 0; i < MENUDEPTH; ++i)
1988 pri_tab[i] = 500;
1989 pri_tab[MENUDEPTH] = -1;
1990 gui_create_tearoffs_recurse(root_menu, (char_u *)"", pri_tab, 0);
1991 }
1992 else
1993 gui_destroy_tearoffs_recurse(root_menu);
1994 s_tearoffs = enable;
1995 }
1996
1997 /*
1998 * Recursively add tearoff items
1999 */
2000 static void
2001 gui_create_tearoffs_recurse(menu, pname, pri_tab, pri_idx)
2002 vimmenu_T *menu;
2003 const char_u *pname;
2004 int *pri_tab;
2005 int pri_idx;
2006 {
2007 char_u *newpname = NULL;
2008 int len;
2009 char_u *s;
2010 char_u *d;
2011
2012 if (pri_tab[pri_idx + 1] != -1)
2013 ++pri_idx;
2014 while (menu != NULL)
2015 {
2016 if (menu->children != NULL && menu_is_menubar(menu->name))
2017 {
2018 /* Add the menu name to the menu path. Insert a backslash before
2019 * dots (it's used to separate menu names). */
2020 len = (int)STRLEN(pname) + (int)STRLEN(menu->name);
2021 for (s = menu->name; *s; ++s)
2022 if (*s == '.' || *s == '\\')
2023 ++len;
2024 newpname = alloc(len + TEAR_LEN + 2);
2025 if (newpname != NULL)
2026 {
2027 STRCPY(newpname, pname);
2028 d = newpname + STRLEN(newpname);
2029 for (s = menu->name; *s; ++s)
2030 {
2031 if (*s == '.' || *s == '\\')
2032 *d++ = '\\';
2033 *d++ = *s;
2034 }
2035 *d = NUL;
2036
2037 /* check if tearoff already exists */
2038 if (STRCMP(menu->children->name, TEAR_STRING) != 0)
2039 {
2040 gui_add_tearoff(newpname, pri_tab, pri_idx - 1);
2041 *d = NUL; /* remove TEAR_STRING */
2042 }
2043
2044 STRCAT(newpname, ".");
2045 gui_create_tearoffs_recurse(menu->children, newpname,
2046 pri_tab, pri_idx);
2047 vim_free(newpname);
2048 }
2049 }
2050 menu = menu->next;
2051 }
2052 }
2053
2054 /*
2055 * Add tear-off menu item for a submenu.
2056 * "tearpath" is the menu path, and must have room to add TEAR_STRING.
2057 */
2058 static void
2059 gui_add_tearoff(tearpath, pri_tab, pri_idx)
2060 char_u *tearpath;
2061 int *pri_tab;
2062 int pri_idx;
2063 {
2064 char_u *tbuf;
2065 int t;
2066 vimmenu_T menuarg;
2067
2068 tbuf = alloc(5 + (unsigned int)STRLEN(tearpath));
2069 if (tbuf != NULL)
2070 {
2071 tbuf[0] = K_SPECIAL;
2072 tbuf[1] = K_SECOND(K_TEAROFF);
2073 tbuf[2] = K_THIRD(K_TEAROFF);
2074 STRCPY(tbuf + 3, tearpath);
2075 STRCAT(tbuf + 3, "\r");
2076
2077 STRCAT(tearpath, ".");
2078 STRCAT(tearpath, TEAR_STRING);
2079
2080 /* Priority of tear-off is always 1 */
2081 t = pri_tab[pri_idx + 1];
2082 pri_tab[pri_idx + 1] = 1;
2083
2084 #ifdef FEAT_TOOLBAR
2085 menuarg.iconfile = NULL;
2086 menuarg.iconidx = -1;
2087 menuarg.icon_builtin = FALSE;
2088 #endif
2089 menuarg.noremap[0] = REMAP_NONE;
2090 menuarg.silent[0] = TRUE;
2091
2092 menuarg.modes = MENU_ALL_MODES;
2093 add_menu_path(tearpath, &menuarg, pri_tab, tbuf, FALSE);
2094
2095 menuarg.modes = MENU_TIP_MODE;
2096 add_menu_path(tearpath, &menuarg, pri_tab,
2097 (char_u *)_("Tear off this menu"), FALSE);
2098
2099 pri_tab[pri_idx + 1] = t;
2100 vim_free(tbuf);
2101 }
2102 }
2103
2104 /*
2105 * Recursively destroy tearoff items
2106 */
2107 static void
2108 gui_destroy_tearoffs_recurse(menu)
2109 vimmenu_T *menu;
2110 {
2111 while (menu)
2112 {
2113 if (menu->children)
2114 {
2115 /* check if tearoff exists */
2116 if (STRCMP(menu->children->name, TEAR_STRING) == 0)
2117 {
2118 /* Disconnect the item and free the memory */
2119 free_menu(&menu->children);
2120 }
2121 if (menu->children != NULL) /* if not the last one */
2122 gui_destroy_tearoffs_recurse(menu->children);
2123 }
2124 menu = menu->next;
2125 }
2126 }
2127
2128 #endif /* FEAT_GUI_W32 && FEAT_TEAROFF */
2129
2130 /*
2131 * Given a menu descriptor, e.g. "File.New", find it in the menu hierarchy and
2132 * execute it.
2133 */
2134 void
2135 ex_emenu(eap)
2136 exarg_T *eap;
2137 {
2138 vimmenu_T *menu;
2139 char_u *name;
2140 char_u *saved_name;
2141 char_u *p;
2142 int idx;
2143 char_u *mode;
2144 #ifdef FEAT_GUI_MACVIM
2145 char_u *old_arg;
2146 #endif
2147
2148 saved_name = vim_strsave(eap->arg);
2149 if (saved_name == NULL)
2150 return;
2151
2152 menu = root_menu;
2153 name = saved_name;
2154 while (*name)
2155 {
2156 /* Find in the menu hierarchy */
2157 p = menu_name_skip(name);
2158
2159 while (menu != NULL)
2160 {
2161 if (menu_name_equal(name, menu))
2162 {
2163 if (*p == NUL && menu->children != NULL)
2164 {
2165 EMSG(_("E333: Menu path must lead to a menu item"));
2166 menu = NULL;
2167 }
2168 else if (*p != NUL && menu->children == NULL)
2169 {
2170 EMSG(_(e_notsubmenu));
2171 menu = NULL;
2172 }
2173 break;
2174 }
2175 menu = menu->next;
2176 }
2177 if (menu == NULL || *p == NUL)
2178 break;
2179 menu = menu->children;
2180 name = p;
2181 }
2182 vim_free(saved_name);
2183 if (menu == NULL)
2184 {
2185 EMSG2(_("E334: Menu not found: %s"), eap->arg);
2186 return;
2187 }
2188
2189 /* Found the menu, so execute.
2190 * Use the Insert mode entry when returning to Insert mode. */
2191 if (restart_edit
2192 #ifdef FEAT_EVAL
2193 && !current_SID
2194 #endif
2195 )
2196 {
2197 mode = (char_u *)"Insert";
2198 idx = MENU_INDEX_INSERT;
2199 }
2200 else if (eap->addr_count)
2201 {
2202 pos_T tpos;
2203
2204 mode = (char_u *)"Visual";
2205 idx = MENU_INDEX_VISUAL;
2206
2207 /* GEDDES: This is not perfect - but it is a
2208 * quick way of detecting whether we are doing this from a
2209 * selection - see if the range matches up with the visual
2210 * select start and end. */
2211 if ((curbuf->b_visual.vi_start.lnum == eap->line1)
2212 && (curbuf->b_visual.vi_end.lnum) == eap->line2)
2213 {
2214 /* Set it up for visual mode - equivalent to gv. */
2215 VIsual_mode = curbuf->b_visual.vi_mode;
2216 tpos = curbuf->b_visual.vi_end;
2217 curwin->w_cursor = curbuf->b_visual.vi_start;
2218 curwin->w_curswant = curbuf->b_visual.vi_curswant;
2219 }
2220 else
2221 {
2222 /* Set it up for line-wise visual mode */
2223 VIsual_mode = 'V';
2224 curwin->w_cursor.lnum = eap->line1;
2225 curwin->w_cursor.col = 1;
2226 tpos.lnum = eap->line2;
2227 tpos.col = MAXCOL;
2228 #ifdef FEAT_VIRTUALEDIT
2229 tpos.coladd = 0;
2230 #endif
2231 }
2232
2233 /* Activate visual mode */
2234 VIsual_active = TRUE;
2235 VIsual_reselect = TRUE;
2236 check_cursor();
2237 VIsual = curwin->w_cursor;
2238 curwin->w_cursor = tpos;
2239
2240 check_cursor();
2241
2242 /* Adjust the cursor to make sure it is in the correct pos
2243 * for exclusive mode */
2244 if (*p_sel == 'e' && gchar_cursor() != NUL)
2245 ++curwin->w_cursor.col;
2246 }
2247 else
2248 {
2249 mode = (char_u *)"Normal";
2250 idx = MENU_INDEX_NORMAL;
2251 }
2252
2253 if (idx != MENU_INDEX_INVALID && menu->strings[idx] != NULL &&
2254 menu->strings[idx][0] != NUL)
2255 {
2256
2257 /* When executing a script or function execute the commands right now.
2258 * Otherwise put them in the typeahead buffer. */
2259 #ifdef FEAT_EVAL
2260 if (current_SID != 0)
2261 exec_normal_cmd(menu->strings[idx], menu->noremap[idx],
2262 menu->silent[idx]);
2263 else
2264 #endif
2265 ins_typebuf(menu->strings[idx], menu->noremap[idx], 0,
2266 TRUE, menu->silent[idx]);
2267 }
2268 #ifdef FEAT_GUI_MACVIM
2269 else if (menu->mac_action != NULL && menu->strings[idx][0] == NUL)
2270 {
2271 /* This allows us to bind a menu to an action without mapping to
2272 * anything so that pressing the menu's key equivalent and typing
2273 * ":emenu ..." does the same thing. (HACK: We count on the fact that
2274 * ex_macaction() only looks at eap->arg.) */
2275 old_arg = eap->arg;
2276 eap->arg = menu->mac_action;
2277 ex_macaction(eap);
2278 eap->arg = old_arg;
2279 }
2280 #endif /* FEAT_GUI_MACVIM */
2281 else
2282 EMSG2(_("E335: Menu not defined for %s mode"), mode);
2283 }
2284
2285 #if defined(FEAT_GUI_MSWIN) || defined(FEAT_GUI_MACVIM)\
2286 || (defined(FEAT_GUI_GTK) && defined(FEAT_MENU)) \
2287 || defined(FEAT_BEVAL_TIP) || defined(PROTO)
2288 /*
2289 * Given a menu descriptor, e.g. "File.New", find it in the menu hierarchy.
2290 */
2291 vimmenu_T *
2292 gui_find_menu(path_name)
2293 char_u *path_name;
2294 {
2295 vimmenu_T *menu = NULL;
2296 char_u *name;
2297 char_u *saved_name;
2298 char_u *p;
2299
2300 menu = root_menu;
2301
2302 saved_name = vim_strsave(path_name);
2303 if (saved_name == NULL)
2304 return NULL;
2305
2306 name = saved_name;
2307 while (*name)
2308 {
2309 /* find the end of one dot-separated name and put a NUL at the dot */
2310 p = menu_name_skip(name);
2311
2312 while (menu != NULL)
2313 {
2314 if (STRCMP(name, menu->name) == 0 || STRCMP(name, menu->dname) == 0)
2315 {
2316 if (menu->children == NULL)
2317 {
2318 /* found a menu item instead of a sub-menu */
2319 if (*p == NUL)
2320 EMSG(_("E336: Menu path must lead to a sub-menu"));
2321 else
2322 EMSG(_(e_notsubmenu));
2323 menu = NULL;
2324 goto theend;
2325 }
2326 if (*p == NUL) /* found a full match */
2327 goto theend;
2328 break;
2329 }
2330 menu = menu->next;
2331 }
2332 if (menu == NULL) /* didn't find it */
2333 break;
2334
2335 /* Found a match, search the sub-menu. */
2336 menu = menu->children;
2337 name = p;
2338 }
2339
2340 if (menu == NULL)
2341 EMSG(_("E337: Menu not found - check menu names"));
2342 theend:
2343 vim_free(saved_name);
2344 return menu;
2345 }
2346 #endif
2347
2348 #ifdef FEAT_MULTI_LANG
2349 /*
2350 * Translation of menu names. Just a simple lookup table.
2351 */
2352
2353 typedef struct
2354 {
2355 char_u *from; /* English name */
2356 char_u *from_noamp; /* same, without '&' */
2357 char_u *to; /* translated name */
2358 } menutrans_T;
2359
2360 static garray_T menutrans_ga = {0, 0, 0, 0, NULL};
2361 #endif
2362
2363 /*
2364 * ":menutrans".
2365 * This function is also defined without the +multi_lang feature, in which
2366 * case the commands are ignored.
2367 */
2368 /*ARGSUSED*/
2369 void
2370 ex_menutranslate(eap)
2371 exarg_T *eap;
2372 {
2373 #ifdef FEAT_MULTI_LANG
2374 char_u *arg = eap->arg;
2375 menutrans_T *tp;
2376 int i;
2377 char_u *from, *from_noamp, *to;
2378
2379 if (menutrans_ga.ga_itemsize == 0)
2380 ga_init2(&menutrans_ga, (int)sizeof(menutrans_T), 5);
2381
2382 /*
2383 * ":menutrans clear": clear all translations.
2384 */
2385 if (STRNCMP(arg, "clear", 5) == 0 && ends_excmd(*skipwhite(arg + 5)))
2386 {
2387 tp = (menutrans_T *)menutrans_ga.ga_data;
2388 for (i = 0; i < menutrans_ga.ga_len; ++i)
2389 {
2390 vim_free(tp[i].from);
2391 vim_free(tp[i].from_noamp);
2392 vim_free(tp[i].to);
2393 }
2394 ga_clear(&menutrans_ga);
2395 # ifdef FEAT_EVAL
2396 /* Delete all "menutrans_" global variables. */
2397 del_menutrans_vars();
2398 # endif
2399 }
2400 else
2401 {
2402 /* ":menutrans from to": add translation */
2403 from = arg;
2404 arg = menu_skip_part(arg);
2405 to = skipwhite(arg);
2406 *arg = NUL;
2407 arg = menu_skip_part(to);
2408 if (arg == to)
2409 EMSG(_(e_invarg));
2410 else
2411 {
2412 if (ga_grow(&menutrans_ga, 1) == OK)
2413 {
2414 tp = (menutrans_T *)menutrans_ga.ga_data;
2415 from = vim_strsave(from);
2416 if (from != NULL)
2417 {
2418 from_noamp = menu_text(from, NULL, NULL);
2419 to = vim_strnsave(to, (int)(arg - to));
2420 if (from_noamp != NULL && to != NULL)
2421 {
2422 tp[menutrans_ga.ga_len].from = from;
2423 tp[menutrans_ga.ga_len].from_noamp = from_noamp;
2424 tp[menutrans_ga.ga_len].to = to;
2425 ++menutrans_ga.ga_len;
2426 }
2427 else
2428 {
2429 vim_free(from);
2430 vim_free(from_noamp);
2431 vim_free(to);
2432 }
2433 }
2434 }
2435 }
2436 }
2437 #endif
2438 }
2439
2440 #if defined(FEAT_MULTI_LANG) || defined(FEAT_TOOLBAR)
2441 /*
2442 * Find the character just after one part of a menu name.
2443 */
2444 static char_u *
2445 menu_skip_part(p)
2446 char_u *p;
2447 {
2448 while (*p != NUL && *p != '.' && !vim_iswhite(*p))
2449 {
2450 if ((*p == '\\' || *p == Ctrl_V) && p[1] != NUL)
2451 ++p;
2452 ++p;
2453 }
2454 return p;
2455 }
2456 #endif
2457
2458 #ifdef FEAT_MULTI_LANG
2459 /*
2460 * Lookup part of a menu name in the translations.
2461 * Return a pointer to the translation or NULL if not found.
2462 */
2463 static char_u *
2464 menutrans_lookup(name, len)
2465 char_u *name;
2466 int len;
2467 {
2468 menutrans_T *tp = (menutrans_T *)menutrans_ga.ga_data;
2469 int i;
2470 char_u *dname;
2471
2472 for (i = 0; i < menutrans_ga.ga_len; ++i)
2473 if (STRNCMP(name, tp[i].from, len) == 0 && tp[i].from[len] == NUL)
2474 return tp[i].to;
2475
2476 /* Now try again while ignoring '&' characters. */
2477 i = name[len];
2478 name[len] = NUL;
2479 dname = menu_text(name, NULL, NULL);
2480 name[len] = i;
2481 if (dname != NULL)
2482 {
2483 for (i = 0; i < menutrans_ga.ga_len; ++i)
2484 if (STRCMP(dname, tp[i].from_noamp) == 0)
2485 {
2486 vim_free(dname);
2487 return tp[i].to;
2488 }
2489 vim_free(dname);
2490 }
2491
2492 return NULL;
2493 }
2494 #endif /* FEAT_MULTI_LANG */
2495
2496
2497 #ifdef FEAT_GUI_MACVIM
2498 vimmenu_T *
2499 menu_for_path(char_u *menu_path)
2500 {
2501 vimmenu_T *menu;
2502 char_u *name;
2503 char_u *saved_name;
2504 char_u *p;
2505
2506 saved_name = vim_strsave(menu_path);
2507 if (saved_name == NULL)
2508 return NULL;
2509
2510 menu = root_menu;
2511 name = saved_name;
2512 while (*name)
2513 {
2514 /* Find in the menu hierarchy */
2515 p = menu_name_skip(name);
2516
2517 while (menu != NULL)
2518 {
2519 if (menu_name_equal(name, menu))
2520 {
2521 if (*p == NUL && menu->children != NULL)
2522 {
2523 EMSG(_("E333: Menu path must lead to a menu item"));
2524 menu = NULL;
2525 }
2526 else if (*p != NUL && menu->children == NULL)
2527 {
2528 EMSG(_(e_notsubmenu));
2529 menu = NULL;
2530 }
2531 break;
2532 }
2533 menu = menu->next;
2534 }
2535 if (menu == NULL || *p == NUL)
2536 break;
2537 menu = menu->children;
2538 name = p;
2539 }
2540
2541 vim_free(saved_name);
2542
2543 if (menu == NULL)
2544 {
2545 EMSG2(_("E334: Menu not found: %s"), menu_path);
2546 return NULL;
2547 }
2548
2549 return menu;
2550 }
2551
2552 /*
2553 * Handle the ":macmenu" command.
2554 */
2555 void
2556 ex_macmenu(eap)
2557 exarg_T *eap;
2558 {
2559 vimmenu_T *menu = NULL;
2560 char_u *arg;
2561 char_u *menu_path;
2562 char_u *p;
2563 char_u *keys;
2564 int len;
2565 #ifdef FEAT_MULTI_LANG
2566 char_u *tofree = NULL;
2567 char_u *new_cmd;
2568 #endif
2569 char_u *linep;
2570 char_u *key_start;
2571 char_u *key = NULL;
2572 char_u *arg_start = NULL;
2573 int error = FALSE;
2574 char_u *action = NULL;
2575 int mac_key = 0;
2576 int mac_mods = 0;
2577 int mac_alternate = 0;
2578 char_u *last_dash;
2579 int bit;
2580 int set_action = FALSE;
2581 int set_key = FALSE;
2582 int set_alt = FALSE;
2583
2584 arg = eap->arg;
2585
2586 #ifdef FEAT_MULTI_LANG
2587 /*
2588 * Translate menu names as specified with ":menutrans" commands.
2589 */
2590 menu_path = arg;
2591 while (*menu_path)
2592 {
2593 /* find the end of one part and check if it should be translated */
2594 p = menu_skip_part(menu_path);
2595 keys = menutrans_lookup(menu_path, (int)(p - menu_path));
2596 if (keys != NULL)
2597 {
2598 /* found a match: replace with the translated part */
2599 len = (int)STRLEN(keys);
2600 new_cmd = alloc((unsigned)STRLEN(arg) + len + 1);
2601 if (new_cmd == NULL)
2602 break;
2603 mch_memmove(new_cmd, arg, menu_path - arg);
2604 mch_memmove(new_cmd + (menu_path - arg), keys, (size_t)len);
2605 STRCPY(new_cmd + (menu_path - arg) + len, p);
2606 p = new_cmd + (menu_path - arg) + len;
2607 vim_free(tofree);
2608 tofree = new_cmd;
2609 arg = new_cmd;
2610 }
2611 if (*p != '.')
2612 break;
2613 menu_path = p + 1;
2614 }
2615 #endif
2616
2617 /*
2618 * Isolate the menu name.
2619 * Skip the menu name, and translate <Tab> into a real TAB.
2620 */
2621 menu_path = arg;
2622 if (*menu_path == '.')
2623 {
2624 EMSG2(_(e_invarg2), menu_path);
2625 goto theend;
2626 }
2627
2628 while (*arg && !vim_iswhite(*arg))
2629 {
2630 if ((*arg == '\\' || *arg == Ctrl_V) && arg[1] != NUL)
2631 arg++;
2632 else if (STRNICMP(arg, "<TAB>", 5) == 0)
2633 {
2634 *arg = TAB;
2635 mch_memmove(arg + 1, arg + 5, STRLEN(arg + 4));
2636 }
2637 arg++;
2638 }
2639 if (*arg != NUL)
2640 *arg++ = NUL;
2641 arg = skipwhite(arg);
2642 keys = arg;
2643
2644 menu = menu_for_path(menu_path);
2645 if (!menu) goto theend;
2646
2647 /*
2648 * Parse all key=value arguments.
2649 */
2650 arg = NULL;
2651 linep = keys;
2652 while (!ends_excmd(*linep))
2653 {
2654 key_start = linep;
2655 if (*linep == '=')
2656 {
2657 EMSG2(_("E415: unexpected equal sign: %s"), key_start);
2658 error = TRUE;
2659 break;
2660 }
2661
2662 /*
2663 * Isolate the key ("action", "alt", or "key").
2664 */
2665 while (*linep && !vim_iswhite(*linep) && *linep != '=')
2666 ++linep;
2667 vim_free(key);
2668 key = vim_strnsave_up(key_start, (int)(linep - key_start));
2669 if (key == NULL)
2670 {
2671 error = TRUE;
2672 break;
2673 }
2674 linep = skipwhite(linep);
2675
2676 /*
2677 * Check for the equal sign.
2678 */
2679 if (*linep != '=')
2680 {
2681 EMSG2(_("E416: missing equal sign: %s"), key_start);
2682 error = TRUE;
2683 break;
2684 }
2685 ++linep;
2686
2687 /*
2688 * Isolate the argument.
2689 */
2690 linep = skipwhite(linep);
2691 arg_start = linep;
2692 linep = skiptowhite(linep);
2693
2694 if (linep == arg_start)
2695 {
2696 EMSG2(_("E417: missing argument: %s"), key_start);
2697 error = TRUE;
2698 break;
2699 }
2700 vim_free(arg);
2701 arg = vim_strnsave(arg_start, (int)(linep - arg_start));
2702 if (arg == NULL)
2703 {
2704 error = TRUE;
2705 break;
2706 }
2707
2708 /*
2709 * Store the argument.
2710 */
2711 if (STRCMP(key, "ACTION") == 0)
2712 {
2713 action = vim_strsave(arg);
2714 if (action == NULL)
2715 {
2716 error = TRUE;
2717 break;
2718 }
2719
2720 if (!is_valid_macaction(action))
2721 {
2722 EMSG2(_("E???: Invalid action: %s"), arg);
2723 error = TRUE;
2724 break;
2725 }
2726
2727 set_action = TRUE;
2728 }
2729 else if (STRCMP(key, "ALT") == 0)
2730 {
2731 len = (int)STRLEN(arg);
2732 if ( (len == 1 && (*arg == '0' || *arg == '1')) ||
2733 (STRICMP("no", arg) == 0 || STRICMP("yes", arg) == 0) )
2734 {
2735 mac_alternate = (*arg == '1' || STRICMP("yes", arg) == 0);
2736 set_alt = TRUE;
2737 }
2738 else
2739 {
2740 EMSG2(_(e_invarg2), arg);
2741 error = TRUE;
2742 break;
2743 }
2744 }
2745 else if (STRCMP(key, "KEY") == 0)
2746 {
2747 if (arg[0] != '<')
2748 {
2749 EMSG2(_(e_invarg2), arg);
2750 error = TRUE;
2751 break;
2752 }
2753
2754 if (STRICMP("<nop>", arg) == 0)
2755 {
2756 /* This is to let the user unset a key equivalent, thereby
2757 * freeing up that key combination to be used for a :map
2758 * command (which would otherwise not be possible since key
2759 * equivalents take precedence over :map). */
2760 mac_key = 0;
2761 mac_mods = 0;
2762 set_key = TRUE;
2763 continue;
2764 }
2765
2766 /* Find end of modifier list */
2767 last_dash = arg;
2768 for (p = arg + 1; *p == '-' || vim_isIDc(*p); p++)
2769 {
2770 if (*p == '-')
2771 {
2772 last_dash = p;
2773 if (p[1] != NUL && p[2] == '>')
2774 ++p; /* anything accepted, like <C-?> */
2775 }
2776 if (p[0] == 't' && p[1] == '_' && p[2] && p[3])
2777 p += 3; /* skip t_xx, xx may be '-' or '>' */
2778 }
2779
2780 if (*p == '>') /* found matching '>' */
2781 {
2782 /* Which modifiers are given? */
2783 mac_mods = 0x0;
2784 for (p = arg + 1; p < last_dash; p++)
2785 {
2786 if (*p != '-')
2787 {
2788 bit = name_to_mod_mask(*p);
2789 if (bit == 0x0)
2790 break; /* Illegal modifier name */
2791 mac_mods |= bit;
2792 }
2793 }
2794
2795 /*
2796 * Legal modifier name.
2797 */
2798 if (p >= last_dash)
2799 {
2800 /*
2801 * Modifier with single letter, or special key name.
2802 */
2803 if (mac_mods != 0 && last_dash[2] == '>')
2804 mac_key = last_dash[1];
2805 else
2806 {
2807 mac_key = get_special_key_code(last_dash + 1);
2808 mac_key = handle_x_keys(mac_key);
2809 }
2810 }
2811 }
2812
2813 set_key = (mac_key != 0);
2814
2815 if (mac_key == 0)
2816 {
2817 EMSG2(_(e_invarg2), arg);
2818 error = TRUE;
2819 break;
2820 }
2821 }
2822 else
2823 {
2824 EMSG2(_(e_invarg2), key_start);
2825 error = TRUE;
2826 break;
2827 }
2828
2829 /*
2830 * Continue with next argument.
2831 */
2832 linep = skipwhite(linep);
2833 }
2834
2835 vim_free(key);
2836 vim_free(arg);
2837
2838 /*
2839 * Store all the keys that were set in the menu item.
2840 */
2841 if (!error)
2842 {
2843 if (set_action)
2844 menu->mac_action = action;
2845 if (set_key)
2846 {
2847 menu->mac_key = mac_key;
2848 menu->mac_mods = mac_mods;
2849 }
2850 if (set_alt)
2851 menu->mac_alternate = mac_alternate;
2852 }
2853 else
2854 {
2855 vim_free(action);
2856 }
2857
2858 theend:
2859 #ifdef FEAT_MULTI_LANG
2860 vim_free(tofree);
2861 #else
2862 ;
2863 #endif
2864
2865 }
2866 #endif /* FEAT_GUI_MACVIM */
2867
2868 #endif /* FEAT_MENU */
Vim for the Mac