?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Integration prefs pane update
[MacVim.git] / src / menu.c
blobbd4b4f292c998b6380a56675290333cde1f9ac30
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 mch_memmove(arg, arg + 1, STRLEN(arg));
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 mch_memmove(arg + 1, arg + 5, STRLEN(arg + 4));
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 #endif
1042 for (i = 0; i < MENU_MODES; i++)
1043 free_menu_string(menu, i);
1044 vim_free(menu);
1045
1046 #ifdef FEAT_GUI
1047 /* Want to update menus now even if mode not changed */
1048 force_menu_update = TRUE;
1049 #endif
1050 }
1051
1052 /*
1053 * Free the menu->string with the given index.
1054 */
1055 static void
1056 free_menu_string(menu, idx)
1057 vimmenu_T *menu;
1058 int idx;
1059 {
1060 int count = 0;
1061 int i;
1062
1063 for (i = 0; i < MENU_MODES; i++)
1064 if (menu->strings[i] == menu->strings[idx])
1065 count++;
1066 if (count == 1)
1067 vim_free(menu->strings[idx]);
1068 menu->strings[idx] = NULL;
1069 }
1070
1071 /*
1072 * Show the mapping associated with a menu item or hierarchy in a sub-menu.
1073 */
1074 static int
1075 show_menus(path_name, modes)
1076 char_u *path_name;
1077 int modes;
1078 {
1079 char_u *p;
1080 char_u *name;
1081 vimmenu_T *menu;
1082 vimmenu_T *parent = NULL;
1083
1084 menu = root_menu;
1085 name = path_name = vim_strsave(path_name);
1086 if (path_name == NULL)
1087 return FAIL;
1088
1089 /* First, find the (sub)menu with the given name */
1090 while (*name)
1091 {
1092 p = menu_name_skip(name);
1093 while (menu != NULL)
1094 {
1095 if (menu_name_equal(name, menu))
1096 {
1097 /* Found menu */
1098 if (*p != NUL && menu->children == NULL)
1099 {
1100 EMSG(_(e_notsubmenu));
1101 vim_free(path_name);
1102 return FAIL;
1103 }
1104 else if ((menu->modes & modes) == 0x0)
1105 {
1106 EMSG(_(e_othermode));
1107 vim_free(path_name);
1108 return FAIL;
1109 }
1110 break;
1111 }
1112 menu = menu->next;
1113 }
1114 if (menu == NULL)
1115 {
1116 EMSG2(_(e_nomenu), name);
1117 vim_free(path_name);
1118 return FAIL;
1119 }
1120 name = p;
1121 parent = menu;
1122 menu = menu->children;
1123 }
1124
1125 /* Now we have found the matching menu, and we list the mappings */
1126 /* Highlight title */
1127 MSG_PUTS_TITLE(_("\n--- Menus ---"));
1128
1129 show_menus_recursive(parent, modes, 0);
1130 return OK;
1131 }
1132
1133 /*
1134 * Recursively show the mappings associated with the menus under the given one
1135 */
1136 static void
1137 show_menus_recursive(menu, modes, depth)
1138 vimmenu_T *menu;
1139 int modes;
1140 int depth;
1141 {
1142 int i;
1143 int bit;
1144
1145 if (menu != NULL && (menu->modes & modes) == 0x0)
1146 return;
1147
1148 if (menu != NULL)
1149 {
1150 msg_putchar('\n');
1151 if (got_int) /* "q" hit for "--more--" */
1152 return;
1153 for (i = 0; i < depth; i++)
1154 MSG_PUTS(" ");
1155 if (menu->priority)
1156 {
1157 msg_outnum((long)menu->priority);
1158 MSG_PUTS(" ");
1159 }
1160 /* Same highlighting as for directories!? */
1161 msg_outtrans_attr(menu->name, hl_attr(HLF_D));
1162 }
1163
1164 if (menu != NULL && menu->children == NULL)
1165 {
1166 for (bit = 0; bit < MENU_MODES; bit++)
1167 if ((menu->modes & modes & (1 << bit)) != 0)
1168 {
1169 msg_putchar('\n');
1170 if (got_int) /* "q" hit for "--more--" */
1171 return;
1172 for (i = 0; i < depth + 2; i++)
1173 MSG_PUTS(" ");
1174 msg_putchar(menu_mode_chars[bit]);
1175 if (menu->noremap[bit] == REMAP_NONE)
1176 msg_putchar('*');
1177 else if (menu->noremap[bit] == REMAP_SCRIPT)
1178 msg_putchar('&');
1179 else
1180 msg_putchar(' ');
1181 if (menu->silent[bit])
1182 msg_putchar('s');
1183 else
1184 msg_putchar(' ');
1185 if ((menu->modes & menu->enabled & (1 << bit)) == 0)
1186 msg_putchar('-');
1187 else
1188 msg_putchar(' ');
1189 MSG_PUTS(" ");
1190 if (*menu->strings[bit] == NUL)
1191 msg_puts_attr((char_u *)"<Nop>", hl_attr(HLF_8));
1192 else
1193 msg_outtrans_special(menu->strings[bit], FALSE);
1194 }
1195 }
1196 else
1197 {
1198 if (menu == NULL)
1199 {
1200 menu = root_menu;
1201 depth--;
1202 }
1203 else
1204 menu = menu->children;
1205
1206 /* recursively show all children. Skip PopUp[nvoci]. */
1207 for (; menu != NULL && !got_int; menu = menu->next)
1208 if (!menu_is_hidden(menu->dname))
1209 show_menus_recursive(menu, modes, depth + 1);
1210 }
1211 }
1212
1213 #ifdef FEAT_CMDL_COMPL
1214
1215 /*
1216 * Used when expanding menu names.
1217 */
1218 static vimmenu_T *expand_menu = NULL;
1219 static int expand_modes = 0x0;
1220 static int expand_emenu; /* TRUE for ":emenu" command */
1221
1222 /*
1223 * Work out what to complete when doing command line completion of menu names.
1224 */
1225 char_u *
1226 set_context_in_menu_cmd(xp, cmd, arg, forceit)
1227 expand_T *xp;
1228 char_u *cmd;
1229 char_u *arg;
1230 int forceit;
1231 {
1232 char_u *after_dot;
1233 char_u *p;
1234 char_u *path_name = NULL;
1235 char_u *name;
1236 int unmenu;
1237 vimmenu_T *menu;
1238 int expand_menus;
1239
1240 xp->xp_context = EXPAND_UNSUCCESSFUL;
1241
1242
1243 /* Check for priority numbers, enable and disable */
1244 for (p = arg; *p; ++p)
1245 if (!VIM_ISDIGIT(*p) && *p != '.')
1246 break;
1247
1248 if (!vim_iswhite(*p))
1249 {
1250 if (STRNCMP(arg, "enable", 6) == 0
1251 && (arg[6] == NUL || vim_iswhite(arg[6])))
1252 p = arg + 6;
1253 else if (STRNCMP(arg, "disable", 7) == 0
1254 && (arg[7] == NUL || vim_iswhite(arg[7])))
1255 p = arg + 7;
1256 else
1257 p = arg;
1258 }
1259
1260 while (*p != NUL && vim_iswhite(*p))
1261 ++p;
1262
1263 arg = after_dot = p;
1264
1265 for (; *p && !vim_iswhite(*p); ++p)
1266 {
1267 if ((*p == '\\' || *p == Ctrl_V) && p[1] != NUL)
1268 p++;
1269 else if (*p == '.')
1270 after_dot = p + 1;
1271 }
1272
1273 /* ":tearoff" and ":popup" only use menus, not entries */
1274 expand_menus = !((*cmd == 't' && cmd[1] == 'e') || *cmd == 'p');
1275 expand_emenu = (*cmd == 'e');
1276 if (expand_menus && vim_iswhite(*p))
1277 return NULL; /* TODO: check for next command? */
1278 if (*p == NUL) /* Complete the menu name */
1279 {
1280 /*
1281 * With :unmenu, you only want to match menus for the appropriate mode.
1282 * With :menu though you might want to add a menu with the same name as
1283 * one in another mode, so match menus from other modes too.
1284 */
1285 expand_modes = get_menu_cmd_modes(cmd, forceit, NULL, &unmenu);
1286 if (!unmenu)
1287 expand_modes = MENU_ALL_MODES;
1288
1289 menu = root_menu;
1290 if (after_dot != arg)
1291 {
1292 path_name = alloc((unsigned)(after_dot - arg));
1293 if (path_name == NULL)
1294 return NULL;
1295 vim_strncpy(path_name, arg, after_dot - arg - 1);
1296 }
1297 name = path_name;
1298 while (name != NULL && *name)
1299 {
1300 p = menu_name_skip(name);
1301 while (menu != NULL)
1302 {
1303 if (menu_name_equal(name, menu))
1304 {
1305 /* Found menu */
1306 if ((*p != NUL && menu->children == NULL)
1307 || ((menu->modes & expand_modes) == 0x0))
1308 {
1309 /*
1310 * Menu path continues, but we have reached a leaf.
1311 * Or menu exists only in another mode.
1312 */
1313 vim_free(path_name);
1314 return NULL;
1315 }
1316 break;
1317 }
1318 menu = menu->next;
1319 }
1320 if (menu == NULL)
1321 {
1322 /* No menu found with the name we were looking for */
1323 vim_free(path_name);
1324 return NULL;
1325 }
1326 name = p;
1327 menu = menu->children;
1328 }
1329 vim_free(path_name);
1330
1331 xp->xp_context = expand_menus ? EXPAND_MENUNAMES : EXPAND_MENUS;
1332 xp->xp_pattern = after_dot;
1333 expand_menu = menu;
1334 }
1335 else /* We're in the mapping part */
1336 xp->xp_context = EXPAND_NOTHING;
1337 return NULL;
1338 }
1339
1340 /*
1341 * Function given to ExpandGeneric() to obtain the list of (sub)menus (not
1342 * entries).
1343 */
1344 /*ARGSUSED*/
1345 char_u *
1346 get_menu_name(xp, idx)
1347 expand_T *xp;
1348 int idx;
1349 {
1350 static vimmenu_T *menu = NULL;
1351 char_u *str;
1352
1353 if (idx == 0) /* first call: start at first item */
1354 menu = expand_menu;
1355
1356 /* Skip PopUp[nvoci]. */
1357 while (menu != NULL && (menu_is_hidden(menu->dname)
1358 || menu_is_separator(menu->dname)
1359 || menu_is_tearoff(menu->dname)
1360 || menu->children == NULL))
1361 menu = menu->next;
1362
1363 if (menu == NULL) /* at end of linked list */
1364 return NULL;
1365
1366 if (menu->modes & expand_modes)
1367 str = menu->dname;
1368 else
1369 str = (char_u *)"";
1370
1371 /* Advance to next menu entry. */
1372 menu = menu->next;
1373
1374 return str;
1375 }
1376
1377 /*
1378 * Function given to ExpandGeneric() to obtain the list of menus and menu
1379 * entries.
1380 */
1381 /*ARGSUSED*/
1382 char_u *
1383 get_menu_names(xp, idx)
1384 expand_T *xp;
1385 int idx;
1386 {
1387 static vimmenu_T *menu = NULL;
1388 static char_u tbuffer[256]; /*hack*/
1389 char_u *str;
1390
1391 if (idx == 0) /* first call: start at first item */
1392 menu = expand_menu;
1393
1394 /* Skip Browse-style entries, popup menus and separators. */
1395 while (menu != NULL
1396 && ( menu_is_hidden(menu->dname)
1397 || (expand_emenu && menu_is_separator(menu->dname))
1398 || menu_is_tearoff(menu->dname)
1399 #ifndef FEAT_BROWSE
1400 || menu->dname[STRLEN(menu->dname) - 1] == '.'
1401 #endif
1402 ))
1403 menu = menu->next;
1404
1405 if (menu == NULL) /* at end of linked list */
1406 return NULL;
1407
1408 if (menu->modes & expand_modes)
1409 {
1410 if (menu->children != NULL)
1411 {
1412 STRCPY(tbuffer, menu->dname);
1413 /* hack on menu separators: use a 'magic' char for the separator
1414 * so that '.' in names gets escaped properly */
1415 STRCAT(tbuffer, "\001");
1416 str = tbuffer;
1417 }
1418 else
1419 str = menu->dname;
1420 }
1421 else
1422 str = (char_u *)"";
1423
1424 /* Advance to next menu entry. */
1425 menu = menu->next;
1426
1427 return str;
1428 }
1429 #endif /* FEAT_CMDL_COMPL */
1430
1431 /*
1432 * Skip over this element of the menu path and return the start of the next
1433 * element. Any \ and ^Vs are removed from the current element.
1434 * "name" may be modified.
1435 */
1436 char_u *
1437 menu_name_skip(name)
1438 char_u *name;
1439 {
1440 char_u *p;
1441
1442 for (p = name; *p && *p != '.'; mb_ptr_adv(p))
1443 {
1444 if (*p == '\\' || *p == Ctrl_V)
1445 {
1446 mch_memmove(p, p + 1, STRLEN(p));
1447 if (*p == NUL)
1448 break;
1449 }
1450 }
1451 if (*p)
1452 *p++ = NUL;
1453 return p;
1454 }
1455
1456 /*
1457 * Return TRUE when "name" matches with menu "menu". The name is compared in
1458 * two ways: raw menu name and menu name without '&'. ignore part after a TAB.
1459 */
1460 static int
1461 menu_name_equal(name, menu)
1462 char_u *name;
1463 vimmenu_T *menu;
1464 {
1465 return (menu_namecmp(name, menu->name) || menu_namecmp(name, menu->dname));
1466 }
1467
1468 static int
1469 menu_namecmp(name, mname)
1470 char_u *name;
1471 char_u *mname;
1472 {
1473 int i;
1474
1475 for (i = 0; name[i] != NUL && name[i] != TAB; ++i)
1476 if (name[i] != mname[i])
1477 break;
1478 return ((name[i] == NUL || name[i] == TAB)
1479 && (mname[i] == NUL || mname[i] == TAB));
1480 }
1481
1482 /*
1483 * Return the modes specified by the given menu command (eg :menu! returns
1484 * MENU_CMDLINE_MODE | MENU_INSERT_MODE).
1485 * If "noremap" is not NULL, then the flag it points to is set according to
1486 * whether the command is a "nore" command.
1487 * If "unmenu" is not NULL, then the flag it points to is set according to
1488 * whether the command is an "unmenu" command.
1489 */
1490 static int
1491 get_menu_cmd_modes(cmd, forceit, noremap, unmenu)
1492 char_u *cmd;
1493 int forceit; /* Was there a "!" after the command? */
1494 int *noremap;
1495 int *unmenu;
1496 {
1497 int modes;
1498
1499 switch (*cmd++)
1500 {
1501 case 'v': /* vmenu, vunmenu, vnoremenu */
1502 modes = MENU_VISUAL_MODE | MENU_SELECT_MODE;
1503 break;
1504 case 'x': /* xmenu, xunmenu, xnoremenu */
1505 modes = MENU_VISUAL_MODE;
1506 break;
1507 case 's': /* smenu, sunmenu, snoremenu */
1508 modes = MENU_SELECT_MODE;
1509 break;
1510 case 'o': /* omenu */
1511 modes = MENU_OP_PENDING_MODE;
1512 break;
1513 case 'i': /* imenu */
1514 modes = MENU_INSERT_MODE;
1515 break;
1516 case 't':
1517 modes = MENU_TIP_MODE; /* tmenu */
1518 break;
1519 case 'c': /* cmenu */
1520 modes = MENU_CMDLINE_MODE;
1521 break;
1522 case 'a': /* amenu */
1523 modes = MENU_INSERT_MODE | MENU_CMDLINE_MODE | MENU_NORMAL_MODE
1524 | MENU_VISUAL_MODE | MENU_SELECT_MODE
1525 | MENU_OP_PENDING_MODE;
1526 break;
1527 case 'n':
1528 if (*cmd != 'o') /* nmenu, not noremenu */
1529 {
1530 modes = MENU_NORMAL_MODE;
1531 break;
1532 }
1533 /* FALLTHROUGH */
1534 default:
1535 --cmd;
1536 if (forceit) /* menu!! */
1537 modes = MENU_INSERT_MODE | MENU_CMDLINE_MODE;
1538 else /* menu */
1539 modes = MENU_NORMAL_MODE | MENU_VISUAL_MODE | MENU_SELECT_MODE
1540 | MENU_OP_PENDING_MODE;
1541 }
1542
1543 if (noremap != NULL)
1544 *noremap = (*cmd == 'n' ? REMAP_NONE : REMAP_YES);
1545 if (unmenu != NULL)
1546 *unmenu = (*cmd == 'u');
1547 return modes;
1548 }
1549
1550 /*
1551 * Modify a menu name starting with "PopUp" to include the mode character.
1552 * Returns the name in allocated memory (NULL for failure).
1553 */
1554 static char_u *
1555 popup_mode_name(name, idx)
1556 char_u *name;
1557 int idx;
1558 {
1559 char_u *p;
1560 int len = (int)STRLEN(name);
1561
1562 p = vim_strnsave(name, len + 1);
1563 if (p != NULL)
1564 {
1565 mch_memmove(p + 6, p + 5, (size_t)(len - 4));
1566 p[5] = menu_mode_chars[idx];
1567 }
1568 return p;
1569 }
1570
1571 #if defined(FEAT_GUI) || defined(PROTO)
1572 /*
1573 * Return the index into the menu->strings or menu->noremap arrays for the
1574 * current state. Returns MENU_INDEX_INVALID if there is no mapping for the
1575 * given menu in the current mode.
1576 */
1577 int
1578 get_menu_index(menu, state)
1579 vimmenu_T *menu;
1580 int state;
1581 {
1582 int idx;
1583
1584 if ((state & INSERT))
1585 idx = MENU_INDEX_INSERT;
1586 else if (state & CMDLINE)
1587 idx = MENU_INDEX_CMDLINE;
1588 #ifdef FEAT_VISUAL
1589 else if (VIsual_active)
1590 {
1591 if (VIsual_select)
1592 idx = MENU_INDEX_SELECT;
1593 else
1594 idx = MENU_INDEX_VISUAL;
1595 }
1596 #endif
1597 else if (state == HITRETURN || state == ASKMORE)
1598 idx = MENU_INDEX_CMDLINE;
1599 else if (finish_op)
1600 idx = MENU_INDEX_OP_PENDING;
1601 else if ((state & NORMAL))
1602 idx = MENU_INDEX_NORMAL;
1603 else
1604 idx = MENU_INDEX_INVALID;
1605
1606 if (idx != MENU_INDEX_INVALID && menu->strings[idx] == NULL)
1607 idx = MENU_INDEX_INVALID;
1608 return idx;
1609 }
1610 #endif
1611
1612 /*
1613 * Duplicate the menu item text and then process to see if a mnemonic key
1614 * and/or accelerator text has been identified.
1615 * Returns a pointer to allocated memory, or NULL for failure.
1616 * If mnemonic != NULL, *mnemonic is set to the character after the first '&'.
1617 * If actext != NULL, *actext is set to the text after the first TAB.
1618 */
1619 static char_u *
1620 menu_text(str, mnemonic, actext)
1621 char_u *str;
1622 int *mnemonic;
1623 char_u **actext;
1624 {
1625 char_u *p;
1626 char_u *text;
1627
1628 /* Locate accelerator text, after the first TAB */
1629 p = vim_strchr(str, TAB);
1630 if (p != NULL)
1631 {
1632 if (actext != NULL)
1633 *actext = vim_strsave(p + 1);
1634 text = vim_strnsave(str, (int)(p - str));
1635 }
1636 else
1637 text = vim_strsave(str);
1638
1639 /* Find mnemonic characters "&a" and reduce "&&" to "&". */
1640 for (p = text; p != NULL; )
1641 {
1642 p = vim_strchr(p, '&');
1643 if (p != NULL)
1644 {
1645 if (p[1] == NUL) /* trailing "&" */
1646 break;
1647 if (mnemonic != NULL && p[1] != '&')
1648 #if !defined(__MVS__) || defined(MOTIF390_MNEMONIC_FIXED)
1649 *mnemonic = p[1];
1650 #else
1651 {
1652 /*
1653 * Well there is a bug in the Motif libraries on OS390 Unix.
1654 * The mnemonic keys needs to be converted to ASCII values
1655 * first.
1656 * This behavior has been seen in 2.8 and 2.9.
1657 */
1658 char c = p[1];
1659 __etoa_l(&c, 1);
1660 *mnemonic = c;
1661 }
1662 #endif
1663 mch_memmove(p, p + 1, STRLEN(p));
1664 p = p + 1;
1665 }
1666 }
1667 return text;
1668 }
1669
1670 /*
1671 * Return TRUE if "name" can be a menu in the MenuBar.
1672 */
1673 int
1674 menu_is_menubar(name)
1675 char_u *name;
1676 {
1677 return (!menu_is_popup(name)
1678 && !menu_is_toolbar(name)
1679 && *name != MNU_HIDDEN_CHAR);
1680 }
1681
1682 /*
1683 * Return TRUE if "name" is a popup menu name.
1684 */
1685 int
1686 menu_is_popup(name)
1687 char_u *name;
1688 {
1689 return (STRNCMP(name, "PopUp", 5) == 0);
1690 }
1691
1692 #if (defined(FEAT_GUI_MOTIF) && (XmVersion <= 1002)) || defined(PROTO)
1693 /*
1694 * Return TRUE if "name" is part of a popup menu.
1695 */
1696 int
1697 menu_is_child_of_popup(menu)
1698 vimmenu_T *menu;
1699 {
1700 while (menu->parent != NULL)
1701 menu = menu->parent;
1702 return menu_is_popup(menu->name);
1703 }
1704 #endif
1705
1706 /*
1707 * Return TRUE if "name" is a toolbar menu name.
1708 */
1709 int
1710 menu_is_toolbar(name)
1711 char_u *name;
1712 {
1713 return (STRNCMP(name, "ToolBar", 7) == 0);
1714 }
1715
1716 /*
1717 * Return TRUE if the name is a menu separator identifier: Starts and ends
1718 * with '-'
1719 */
1720 int
1721 menu_is_separator(name)
1722 char_u *name;
1723 {
1724 return (name[0] == '-' && name[STRLEN(name) - 1] == '-');
1725 }
1726
1727 /*
1728 * Return TRUE if the menu is hidden: Starts with ']'
1729 */
1730 static int
1731 menu_is_hidden(name)
1732 char_u *name;
1733 {
1734 return (name[0] == ']') || (menu_is_popup(name) && name[5] != NUL);
1735 }
1736
1737 #if defined(FEAT_CMDL_COMPL) \
1738 || (defined(FEAT_GUI_W32) && defined(FEAT_TEAROFF))
1739 /*
1740 * Return TRUE if the menu is the tearoff menu.
1741 */
1742 /*ARGSUSED*/
1743 static int
1744 menu_is_tearoff(name)
1745 char_u *name;
1746 {
1747 #ifdef FEAT_GUI
1748 return (STRCMP(name, TEAR_STRING) == 0);
1749 #else
1750 return FALSE;
1751 #endif
1752 }
1753 #endif
1754
1755 #ifdef FEAT_GUI
1756
1757 static int
1758 get_menu_mode()
1759 {
1760 #ifdef FEAT_VISUAL
1761 if (VIsual_active)
1762 {
1763 if (VIsual_select)
1764 return MENU_INDEX_SELECT;
1765 return MENU_INDEX_VISUAL;
1766 }
1767 #endif
1768 if (State & INSERT)
1769 return MENU_INDEX_INSERT;
1770 if ((State & CMDLINE) || State == ASKMORE || State == HITRETURN)
1771 return MENU_INDEX_CMDLINE;
1772 if (finish_op)
1773 return MENU_INDEX_OP_PENDING;
1774 if (State & NORMAL)
1775 return MENU_INDEX_NORMAL;
1776 if (State & LANGMAP) /* must be a "r" command, like Insert mode */
1777 return MENU_INDEX_INSERT;
1778 return MENU_INDEX_INVALID;
1779 }
1780
1781 /*
1782 * Check that a pointer appears in the menu tree. Used to protect from using
1783 * a menu that was deleted after it was selected but before the event was
1784 * handled.
1785 * Return OK or FAIL. Used recursively.
1786 */
1787 int
1788 check_menu_pointer(root, menu_to_check)
1789 vimmenu_T *root;
1790 vimmenu_T *menu_to_check;
1791 {
1792 vimmenu_T *p;
1793
1794 for (p = root; p != NULL; p = p->next)
1795 if (p == menu_to_check
1796 || (p->children != NULL
1797 && check_menu_pointer(p->children, menu_to_check) == OK))
1798 return OK;
1799 return FAIL;
1800 }
1801
1802 /*
1803 * After we have started the GUI, then we can create any menus that have been
1804 * defined. This is done once here. add_menu_path() may have already been
1805 * called to define these menus, and may be called again. This function calls
1806 * itself recursively. Should be called at the top level with:
1807 * gui_create_initial_menus(root_menu, NULL);
1808 */
1809 void
1810 gui_create_initial_menus(menu)
1811 vimmenu_T *menu;
1812 {
1813 int idx = 0;
1814
1815 while (menu != NULL)
1816 {
1817 /* Don't add a menu when only a tip was defined. */
1818 if (menu->modes & MENU_ALL_MODES)
1819 {
1820 if (menu->children != NULL)
1821 {
1822 gui_mch_add_menu(menu, idx);
1823 gui_create_initial_menus(menu->children);
1824 }
1825 else
1826 gui_mch_add_menu_item(menu, idx);
1827 }
1828 menu = menu->next;
1829 ++idx;
1830 }
1831 }
1832
1833 /*
1834 * Used recursively by gui_update_menus (see below)
1835 */
1836 static void
1837 gui_update_menus_recurse(menu, mode)
1838 vimmenu_T *menu;
1839 int mode;
1840 {
1841 int grey;
1842
1843 while (menu)
1844 {
1845 if ((menu->modes & menu->enabled & mode)
1846 #if defined(FEAT_GUI_W32) && defined(FEAT_TEAROFF)
1847 || menu_is_tearoff(menu->dname)
1848 #endif
1849 )
1850 grey = FALSE;
1851 else
1852 grey = TRUE;
1853 #ifdef FEAT_GUI_ATHENA
1854 /* Hiding menus doesn't work for Athena, it can cause a crash. */
1855 gui_mch_menu_grey(menu, grey);
1856 #else
1857 /* Never hide a toplevel menu, it may make the menubar resize or
1858 * disappear. Same problem for ToolBar items. */
1859 if (vim_strchr(p_go, GO_GREY) != NULL || menu->parent == NULL
1860 # ifdef FEAT_TOOLBAR
1861 || menu_is_toolbar(menu->parent->name)
1862 # endif
1863 )
1864 gui_mch_menu_grey(menu, grey);
1865 else
1866 gui_mch_menu_hidden(menu, grey);
1867 #endif
1868 gui_update_menus_recurse(menu->children, mode);
1869 menu = menu->next;
1870 }
1871 }
1872
1873 /*
1874 * Make sure only the valid menu items appear for this mode. If
1875 * force_menu_update is not TRUE, then we only do this if the mode has changed
1876 * since last time. If "modes" is not 0, then we use these modes instead.
1877 */
1878 void
1879 gui_update_menus(modes)
1880 int modes;
1881 {
1882 static int prev_mode = -1;
1883 int mode = 0;
1884
1885 if (modes != 0x0)
1886 mode = modes;
1887 else
1888 {
1889 mode = get_menu_mode();
1890 if (mode == MENU_INDEX_INVALID)
1891 mode = 0;
1892 else
1893 mode = (1 << mode);
1894 }
1895
1896 if (force_menu_update || mode != prev_mode)
1897 {
1898 gui_update_menus_recurse(root_menu, mode);
1899 gui_mch_draw_menubar();
1900 prev_mode = mode;
1901 force_menu_update = FALSE;
1902 #ifdef FEAT_GUI_W32
1903 /* This can leave a tearoff as active window - make sure we
1904 * have the focus <negri>*/
1905 gui_mch_activate_window();
1906 #endif
1907 }
1908 }
1909
1910 #if defined(FEAT_GUI_MSWIN) || defined(FEAT_GUI_MOTIF) \
1911 || defined(FEAT_GUI_GTK) || defined(FEAT_GUI_PHOTON) || defined(PROTO)
1912 /*
1913 * Check if a key is used as a mnemonic for a toplevel menu.
1914 * Case of the key is ignored.
1915 */
1916 int
1917 gui_is_menu_shortcut(key)
1918 int key;
1919 {
1920 vimmenu_T *menu;
1921
1922 if (key < 256)
1923 key = TOLOWER_LOC(key);
1924 for (menu = root_menu; menu != NULL; menu = menu->next)
1925 if (menu->mnemonic == key
1926 || (menu->mnemonic < 256 && TOLOWER_LOC(menu->mnemonic) == key))
1927 return TRUE;
1928 return FALSE;
1929 }
1930 #endif
1931
1932 /*
1933 * Display the Special "PopUp" menu as a pop-up at the current mouse
1934 * position. The "PopUpn" menu is for Normal mode, "PopUpi" for Insert mode,
1935 * etc.
1936 */
1937 void
1938 gui_show_popupmenu()
1939 {
1940 vimmenu_T *menu;
1941 int mode;
1942
1943 mode = get_menu_mode();
1944 if (mode == MENU_INDEX_INVALID)
1945 return;
1946 mode = menu_mode_chars[mode];
1947
1948 #ifdef FEAT_AUTOCMD
1949 {
1950 char_u ename[2];
1951
1952 ename[0] = mode;
1953 ename[1] = NUL;
1954 apply_autocmds(EVENT_MENUPOPUP, ename, NULL, FALSE, curbuf);
1955 }
1956 #endif
1957
1958 for (menu = root_menu; menu != NULL; menu = menu->next)
1959 if (STRNCMP("PopUp", menu->name, 5) == 0 && menu->name[5] == mode)
1960 break;
1961
1962 /* Only show a popup when it is defined and has entries */
1963 if (menu != NULL && menu->children != NULL)
1964 gui_mch_show_popupmenu(menu);
1965 }
1966 #endif /* FEAT_GUI */
1967
1968 #if (defined(FEAT_GUI_W32) && defined(FEAT_TEAROFF)) || defined(PROTO)
1969
1970 /*
1971 * Deal with tearoff items that are added like a menu item.
1972 * Currently only for Win32 GUI. Others may follow later.
1973 */
1974
1975 void
1976 gui_mch_toggle_tearoffs(int enable)
1977 {
1978 int pri_tab[MENUDEPTH + 1];
1979 int i;
1980
1981 if (enable)
1982 {
1983 for (i = 0; i < MENUDEPTH; ++i)
1984 pri_tab[i] = 500;
1985 pri_tab[MENUDEPTH] = -1;
1986 gui_create_tearoffs_recurse(root_menu, (char_u *)"", pri_tab, 0);
1987 }
1988 else
1989 gui_destroy_tearoffs_recurse(root_menu);
1990 s_tearoffs = enable;
1991 }
1992
1993 /*
1994 * Recursively add tearoff items
1995 */
1996 static void
1997 gui_create_tearoffs_recurse(menu, pname, pri_tab, pri_idx)
1998 vimmenu_T *menu;
1999 const char_u *pname;
2000 int *pri_tab;
2001 int pri_idx;
2002 {
2003 char_u *newpname = NULL;
2004 int len;
2005 char_u *s;
2006 char_u *d;
2007
2008 if (pri_tab[pri_idx + 1] != -1)
2009 ++pri_idx;
2010 while (menu != NULL)
2011 {
2012 if (menu->children != NULL && menu_is_menubar(menu->name))
2013 {
2014 /* Add the menu name to the menu path. Insert a backslash before
2015 * dots (it's used to separate menu names). */
2016 len = (int)STRLEN(pname) + (int)STRLEN(menu->name);
2017 for (s = menu->name; *s; ++s)
2018 if (*s == '.' || *s == '\\')
2019 ++len;
2020 newpname = alloc(len + TEAR_LEN + 2);
2021 if (newpname != NULL)
2022 {
2023 STRCPY(newpname, pname);
2024 d = newpname + STRLEN(newpname);
2025 for (s = menu->name; *s; ++s)
2026 {
2027 if (*s == '.' || *s == '\\')
2028 *d++ = '\\';
2029 *d++ = *s;
2030 }
2031 *d = NUL;
2032
2033 /* check if tearoff already exists */
2034 if (STRCMP(menu->children->name, TEAR_STRING) != 0)
2035 {
2036 gui_add_tearoff(newpname, pri_tab, pri_idx - 1);
2037 *d = NUL; /* remove TEAR_STRING */
2038 }
2039
2040 STRCAT(newpname, ".");
2041 gui_create_tearoffs_recurse(menu->children, newpname,
2042 pri_tab, pri_idx);
2043 vim_free(newpname);
2044 }
2045 }
2046 menu = menu->next;
2047 }
2048 }
2049
2050 /*
2051 * Add tear-off menu item for a submenu.
2052 * "tearpath" is the menu path, and must have room to add TEAR_STRING.
2053 */
2054 static void
2055 gui_add_tearoff(tearpath, pri_tab, pri_idx)
2056 char_u *tearpath;
2057 int *pri_tab;
2058 int pri_idx;
2059 {
2060 char_u *tbuf;
2061 int t;
2062 vimmenu_T menuarg;
2063
2064 tbuf = alloc(5 + (unsigned int)STRLEN(tearpath));
2065 if (tbuf != NULL)
2066 {
2067 tbuf[0] = K_SPECIAL;
2068 tbuf[1] = K_SECOND(K_TEAROFF);
2069 tbuf[2] = K_THIRD(K_TEAROFF);
2070 STRCPY(tbuf + 3, tearpath);
2071 STRCAT(tbuf + 3, "\r");
2072
2073 STRCAT(tearpath, ".");
2074 STRCAT(tearpath, TEAR_STRING);
2075
2076 /* Priority of tear-off is always 1 */
2077 t = pri_tab[pri_idx + 1];
2078 pri_tab[pri_idx + 1] = 1;
2079
2080 #ifdef FEAT_TOOLBAR
2081 menuarg.iconfile = NULL;
2082 menuarg.iconidx = -1;
2083 menuarg.icon_builtin = FALSE;
2084 #endif
2085 menuarg.noremap[0] = REMAP_NONE;
2086 menuarg.silent[0] = TRUE;
2087
2088 menuarg.modes = MENU_ALL_MODES;
2089 add_menu_path(tearpath, &menuarg, pri_tab, tbuf, FALSE);
2090
2091 menuarg.modes = MENU_TIP_MODE;
2092 add_menu_path(tearpath, &menuarg, pri_tab,
2093 (char_u *)_("Tear off this menu"), FALSE);
2094
2095 pri_tab[pri_idx + 1] = t;
2096 vim_free(tbuf);
2097 }
2098 }
2099
2100 /*
2101 * Recursively destroy tearoff items
2102 */
2103 static void
2104 gui_destroy_tearoffs_recurse(menu)
2105 vimmenu_T *menu;
2106 {
2107 while (menu)
2108 {
2109 if (menu->children)
2110 {
2111 /* check if tearoff exists */
2112 if (STRCMP(menu->children->name, TEAR_STRING) == 0)
2113 {
2114 /* Disconnect the item and free the memory */
2115 free_menu(&menu->children);
2116 }
2117 if (menu->children != NULL) /* if not the last one */
2118 gui_destroy_tearoffs_recurse(menu->children);
2119 }
2120 menu = menu->next;
2121 }
2122 }
2123
2124 #endif /* FEAT_GUI_W32 && FEAT_TEAROFF */
2125
2126 /*
2127 * Given a menu descriptor, e.g. "File.New", find it in the menu hierarchy and
2128 * execute it.
2129 */
2130 void
2131 ex_emenu(eap)
2132 exarg_T *eap;
2133 {
2134 vimmenu_T *menu;
2135 char_u *name;
2136 char_u *saved_name;
2137 char_u *p;
2138 int idx;
2139 char_u *mode;
2140
2141 saved_name = vim_strsave(eap->arg);
2142 if (saved_name == NULL)
2143 return;
2144
2145 menu = root_menu;
2146 name = saved_name;
2147 while (*name)
2148 {
2149 /* Find in the menu hierarchy */
2150 p = menu_name_skip(name);
2151
2152 while (menu != NULL)
2153 {
2154 if (menu_name_equal(name, menu))
2155 {
2156 if (*p == NUL && menu->children != NULL)
2157 {
2158 EMSG(_("E333: Menu path must lead to a menu item"));
2159 menu = NULL;
2160 }
2161 else if (*p != NUL && menu->children == NULL)
2162 {
2163 EMSG(_(e_notsubmenu));
2164 menu = NULL;
2165 }
2166 break;
2167 }
2168 menu = menu->next;
2169 }
2170 if (menu == NULL || *p == NUL)
2171 break;
2172 menu = menu->children;
2173 name = p;
2174 }
2175 vim_free(saved_name);
2176 if (menu == NULL)
2177 {
2178 EMSG2(_("E334: Menu not found: %s"), eap->arg);
2179 return;
2180 }
2181
2182 /* Found the menu, so execute.
2183 * Use the Insert mode entry when returning to Insert mode. */
2184 if (restart_edit
2185 #ifdef FEAT_EVAL
2186 && !current_SID
2187 #endif
2188 )
2189 {
2190 mode = (char_u *)"Insert";
2191 idx = MENU_INDEX_INSERT;
2192 }
2193 else if (eap->addr_count)
2194 {
2195 pos_T tpos;
2196
2197 mode = (char_u *)"Visual";
2198 idx = MENU_INDEX_VISUAL;
2199
2200 /* GEDDES: This is not perfect - but it is a
2201 * quick way of detecting whether we are doing this from a
2202 * selection - see if the range matches up with the visual
2203 * select start and end. */
2204 if ((curbuf->b_visual.vi_start.lnum == eap->line1)
2205 && (curbuf->b_visual.vi_end.lnum) == eap->line2)
2206 {
2207 /* Set it up for visual mode - equivalent to gv. */
2208 VIsual_mode = curbuf->b_visual.vi_mode;
2209 tpos = curbuf->b_visual.vi_end;
2210 curwin->w_cursor = curbuf->b_visual.vi_start;
2211 curwin->w_curswant = curbuf->b_visual.vi_curswant;
2212 }
2213 else
2214 {
2215 /* Set it up for line-wise visual mode */
2216 VIsual_mode = 'V';
2217 curwin->w_cursor.lnum = eap->line1;
2218 curwin->w_cursor.col = 1;
2219 tpos.lnum = eap->line2;
2220 tpos.col = MAXCOL;
2221 #ifdef FEAT_VIRTUALEDIT
2222 tpos.coladd = 0;
2223 #endif
2224 }
2225
2226 /* Activate visual mode */
2227 VIsual_active = TRUE;
2228 VIsual_reselect = TRUE;
2229 check_cursor();
2230 VIsual = curwin->w_cursor;
2231 curwin->w_cursor = tpos;
2232
2233 check_cursor();
2234
2235 /* Adjust the cursor to make sure it is in the correct pos
2236 * for exclusive mode */
2237 if (*p_sel == 'e' && gchar_cursor() != NUL)
2238 ++curwin->w_cursor.col;
2239 }
2240 else
2241 {
2242 mode = (char_u *)"Normal";
2243 idx = MENU_INDEX_NORMAL;
2244 }
2245
2246 if (idx != MENU_INDEX_INVALID && menu->strings[idx] != NULL)
2247 {
2248 /* When executing a script or function execute the commands right now.
2249 * Otherwise put them in the typeahead buffer. */
2250 #ifdef FEAT_EVAL
2251 if (current_SID != 0)
2252 exec_normal_cmd(menu->strings[idx], menu->noremap[idx],
2253 menu->silent[idx]);
2254 else
2255 #endif
2256 ins_typebuf(menu->strings[idx], menu->noremap[idx], 0,
2257 TRUE, menu->silent[idx]);
2258 }
2259 else
2260 EMSG2(_("E335: Menu not defined for %s mode"), mode);
2261 }
2262
2263 #if defined(FEAT_GUI_MSWIN) || defined(FEAT_GUI_MACVIM)\
2264 || (defined(FEAT_GUI_GTK) && defined(FEAT_MENU)) \
2265 || defined(FEAT_BEVAL_TIP) || defined(PROTO)
2266 /*
2267 * Given a menu descriptor, e.g. "File.New", find it in the menu hierarchy.
2268 */
2269 vimmenu_T *
2270 gui_find_menu(path_name)
2271 char_u *path_name;
2272 {
2273 vimmenu_T *menu = NULL;
2274 char_u *name;
2275 char_u *saved_name;
2276 char_u *p;
2277
2278 menu = root_menu;
2279
2280 saved_name = vim_strsave(path_name);
2281 if (saved_name == NULL)
2282 return NULL;
2283
2284 name = saved_name;
2285 while (*name)
2286 {
2287 /* find the end of one dot-separated name and put a NUL at the dot */
2288 p = menu_name_skip(name);
2289
2290 while (menu != NULL)
2291 {
2292 if (STRCMP(name, menu->name) == 0 || STRCMP(name, menu->dname) == 0)
2293 {
2294 if (menu->children == NULL)
2295 {
2296 /* found a menu item instead of a sub-menu */
2297 if (*p == NUL)
2298 EMSG(_("E336: Menu path must lead to a sub-menu"));
2299 else
2300 EMSG(_(e_notsubmenu));
2301 menu = NULL;
2302 goto theend;
2303 }
2304 if (*p == NUL) /* found a full match */
2305 goto theend;
2306 break;
2307 }
2308 menu = menu->next;
2309 }
2310 if (menu == NULL) /* didn't find it */
2311 break;
2312
2313 /* Found a match, search the sub-menu. */
2314 menu = menu->children;
2315 name = p;
2316 }
2317
2318 if (menu == NULL)
2319 EMSG(_("E337: Menu not found - check menu names"));
2320 theend:
2321 vim_free(saved_name);
2322 return menu;
2323 }
2324 #endif
2325
2326 #ifdef FEAT_MULTI_LANG
2327 /*
2328 * Translation of menu names. Just a simple lookup table.
2329 */
2330
2331 typedef struct
2332 {
2333 char_u *from; /* English name */
2334 char_u *from_noamp; /* same, without '&' */
2335 char_u *to; /* translated name */
2336 } menutrans_T;
2337
2338 static garray_T menutrans_ga = {0, 0, 0, 0, NULL};
2339 #endif
2340
2341 /*
2342 * ":menutrans".
2343 * This function is also defined without the +multi_lang feature, in which
2344 * case the commands are ignored.
2345 */
2346 /*ARGSUSED*/
2347 void
2348 ex_menutranslate(eap)
2349 exarg_T *eap;
2350 {
2351 #ifdef FEAT_MULTI_LANG
2352 char_u *arg = eap->arg;
2353 menutrans_T *tp;
2354 int i;
2355 char_u *from, *from_noamp, *to;
2356
2357 if (menutrans_ga.ga_itemsize == 0)
2358 ga_init2(&menutrans_ga, (int)sizeof(menutrans_T), 5);
2359
2360 /*
2361 * ":menutrans clear": clear all translations.
2362 */
2363 if (STRNCMP(arg, "clear", 5) == 0 && ends_excmd(*skipwhite(arg + 5)))
2364 {
2365 tp = (menutrans_T *)menutrans_ga.ga_data;
2366 for (i = 0; i < menutrans_ga.ga_len; ++i)
2367 {
2368 vim_free(tp[i].from);
2369 vim_free(tp[i].from_noamp);
2370 vim_free(tp[i].to);
2371 }
2372 ga_clear(&menutrans_ga);
2373 # ifdef FEAT_EVAL
2374 /* Delete all "menutrans_" global variables. */
2375 del_menutrans_vars();
2376 # endif
2377 }
2378 else
2379 {
2380 /* ":menutrans from to": add translation */
2381 from = arg;
2382 arg = menu_skip_part(arg);
2383 to = skipwhite(arg);
2384 *arg = NUL;
2385 arg = menu_skip_part(to);
2386 if (arg == to)
2387 EMSG(_(e_invarg));
2388 else
2389 {
2390 if (ga_grow(&menutrans_ga, 1) == OK)
2391 {
2392 tp = (menutrans_T *)menutrans_ga.ga_data;
2393 from = vim_strsave(from);
2394 if (from != NULL)
2395 {
2396 from_noamp = menu_text(from, NULL, NULL);
2397 to = vim_strnsave(to, (int)(arg - to));
2398 if (from_noamp != NULL && to != NULL)
2399 {
2400 tp[menutrans_ga.ga_len].from = from;
2401 tp[menutrans_ga.ga_len].from_noamp = from_noamp;
2402 tp[menutrans_ga.ga_len].to = to;
2403 ++menutrans_ga.ga_len;
2404 }
2405 else
2406 {
2407 vim_free(from);
2408 vim_free(from_noamp);
2409 vim_free(to);
2410 }
2411 }
2412 }
2413 }
2414 }
2415 #endif
2416 }
2417
2418 #if defined(FEAT_MULTI_LANG) || defined(FEAT_TOOLBAR)
2419 /*
2420 * Find the character just after one part of a menu name.
2421 */
2422 static char_u *
2423 menu_skip_part(p)
2424 char_u *p;
2425 {
2426 while (*p != NUL && *p != '.' && !vim_iswhite(*p))
2427 {
2428 if ((*p == '\\' || *p == Ctrl_V) && p[1] != NUL)
2429 ++p;
2430 ++p;
2431 }
2432 return p;
2433 }
2434 #endif
2435
2436 #ifdef FEAT_MULTI_LANG
2437 /*
2438 * Lookup part of a menu name in the translations.
2439 * Return a pointer to the translation or NULL if not found.
2440 */
2441 static char_u *
2442 menutrans_lookup(name, len)
2443 char_u *name;
2444 int len;
2445 {
2446 menutrans_T *tp = (menutrans_T *)menutrans_ga.ga_data;
2447 int i;
2448 char_u *dname;
2449
2450 for (i = 0; i < menutrans_ga.ga_len; ++i)
2451 if (STRNCMP(name, tp[i].from, len) == 0 && tp[i].from[len] == NUL)
2452 return tp[i].to;
2453
2454 /* Now try again while ignoring '&' characters. */
2455 i = name[len];
2456 name[len] = NUL;
2457 dname = menu_text(name, NULL, NULL);
2458 name[len] = i;
2459 if (dname != NULL)
2460 {
2461 for (i = 0; i < menutrans_ga.ga_len; ++i)
2462 if (STRCMP(dname, tp[i].from_noamp) == 0)
2463 {
2464 vim_free(dname);
2465 return tp[i].to;
2466 }
2467 vim_free(dname);
2468 }
2469
2470 return NULL;
2471 }
2472 #endif /* FEAT_MULTI_LANG */
2473
2474
2475 #ifdef FEAT_GUI_MACVIM
2476 void
2477 ex_macmenukey(eap)
2478 exarg_T *eap;
2479 {
2480 char_u *arg = eap->arg;
2481 char_u *keys, *name, *p;
2482 vimmenu_T *menu;
2483 char_u *last_dash;
2484 int modifiers;
2485 int bit;
2486 int key;
2487
2488 /*
2489 * Isolate the menu name.
2490 */
2491 name = arg;
2492 if (*name == '.')
2493 {
2494 EMSG2(_(e_invarg2), name);
2495 return;
2496 }
2497
2498 while (*arg && !vim_iswhite(*arg))
2499 {
2500 if ((*arg == '\\' || *arg == Ctrl_V) && arg[1] != NUL)
2501 arg++;
2502 arg++;
2503 }
2504 if (*arg != NUL)
2505 *arg++ = NUL;
2506 arg = skipwhite(arg);
2507 keys = arg;
2508
2509 // TODO: move to gui_find_menu_item(path_name)
2510 menu = root_menu;
2511 while (*name)
2512 {
2513 /* find the end of one dot-separated name and put a NUL at the dot */
2514 p = menu_name_skip(name);
2515
2516 while (menu != NULL)
2517 {
2518 if (STRCMP(name, menu->name) == 0 || STRCMP(name, menu->dname) == 0)
2519 {
2520 if (*p == NUL)
2521 {
2522 if (menu->children != NULL)
2523 menu = NULL;
2524 goto search_end;
2525 }
2526 break;
2527 }
2528 menu = menu->next;
2529 }
2530 if (menu == NULL) /* didn't find it */
2531 break;
2532
2533 /* Found a match, search the sub-menu. */
2534 menu = menu->children;
2535 name = p;
2536 }
2537
2538 search_end:
2539 if (!menu) {
2540 EMSG(_("E337: Menu not found - check menu names"));
2541 return;
2542 }
2543
2544 if (keys[0] == '<')
2545 {
2546 key = 0;
2547
2548 /* Find end of modifier list */
2549 last_dash = keys;
2550 for (p = keys + 1; *p == '-' || vim_isIDc(*p); p++)
2551 {
2552 if (*p == '-')
2553 {
2554 last_dash = p;
2555 if (p[1] != NUL && p[2] == '>')
2556 ++p; /* anything accepted, like <C-?> */
2557 }
2558 if (p[0] == 't' && p[1] == '_' && p[2] && p[3])
2559 p += 3; /* skip t_xx, xx may be '-' or '>' */
2560 }
2561
2562 if (*p == '>') /* found matching '>' */
2563 {
2564 /* Which modifiers are given? */
2565 modifiers = 0x0;
2566 for (p = keys + 1; p < last_dash; p++)
2567 {
2568 if (*p != '-')
2569 {
2570 bit = name_to_mod_mask(*p);
2571 if (bit == 0x0)
2572 break; /* Illegal modifier name */
2573 modifiers |= bit;
2574 }
2575 }
2576
2577 /*
2578 * Legal modifier name.
2579 */
2580 if (p >= last_dash)
2581 {
2582 /*
2583 * Modifier with single letter, or special key name.
2584 */
2585 if (modifiers != 0 && last_dash[2] == '>')
2586 key = last_dash[1];
2587 else
2588 {
2589 key = get_special_key_code(last_dash + 1);
2590 key = handle_x_keys(key);
2591 }
2592 }
2593 }
2594
2595 if (key != 0)
2596 {
2597 menu->mac_key = key;
2598 menu->mac_mods = modifiers;
2599 }
2600 }
2601 else if (keys[0] == NUL)
2602 {
2603 /* Clear the key equivalent */
2604 menu->mac_key = 0;
2605 menu->mac_mods = 0;
2606 }
2607 else
2608 {
2609 EMSG(_(e_invarg));
2610 }
2611 }
2612 #endif /* FEAT_GUI_MACVIM */
2613
2614 #endif /* FEAT_MENU */
Vim for the Mac