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