1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright (C) 1999 The LyX Team.
8 *======================================================*/
11 #pragma implementation
17 #include "support/lstrings.h"
18 #include "support/LAssert.h"
20 #include "LyXAction.h"
25 #include "MenuBackend.h"
26 #include "Menubar_pimpl.h"
33 typedef vector<int>::size_type size_type;
35 extern kb_keymap * toplevel_keymap;
36 extern LyXAction lyxaction;
39 static const int MENU_LABEL_SIZE = FL_NORMAL_SIZE;
40 static const int mheight = 30;
41 static const int mbheight= 22;
42 // where to place the menubar?
43 static const int yloc = (mheight - mbheight)/2; //air + bw;
44 static const int mbadd = 20; // menu button add (to width)
45 // Some space between buttons on the menubar
46 static const int air = 2;
47 static char const * menu_tabstop = "aa";
48 static char const * default_tabstop = "aaaaaaaa";
49 // We do not want to mix position values in a menu (like the index of
50 // a submenu) with the action numbers which convey actual information.
51 // Therefore we offset all the action values by an arbitrary large
53 static const int action_offset = 1000;
56 //Defined later, used in makeMenubar().
58 void C_Menubar_Pimpl_MenuCallback(FL_OBJECT * ob, long button);
60 // This is used a few times below.
62 int string_width(string const & str)
64 return fl_get_string_widthTAB(FL_NORMAL_STYLE, MENU_LABEL_SIZE,
66 static_cast<int>(str.length()));
70 Menubar::Pimpl::Pimpl(LyXView * view, MenuBackend const & mb)
71 : owner_(view), menubackend_(&mb), current_group_(0)
73 for (MenuBackend::const_iterator menu = menubackend_->begin();
74 menu != menubackend_->end() ; ++menu) {
75 if (menu->menubar()) {
76 FL_OBJECT * group = fl_bgn_group();
79 fl_hide_object(group);
81 << "Menubar::Pimpl::Pimpl: "
82 << "creating and hiding group " << group
83 << " for menubar " << menu->name() << endl;
84 menubarmap_[menu->name()] = group;
90 Menubar::Pimpl::~Pimpl()
92 // Should we do something here?
96 void Menubar::Pimpl::makeMenubar(Menu const &menu)
98 FL_FORM * form = owner_->getForm();
101 // Create menu frame if there is non yet.
102 FL_OBJECT * frame = fl_add_frame(FL_UP_FRAME, 0, 0,
103 form->w, mheight, "");
104 fl_set_object_resize(frame, FL_RESIZE_ALL);
105 fl_set_object_gravity(frame, NorthWestGravity,
108 for (Menu::const_iterator i = menu.begin();
109 i != menu.end(); ++i) {
111 if (i->kind() != MenuItem::Submenu) {
112 lyxerr << "ERROR: Menubar::Pimpl::createMenubar:"
113 " only submenus can appear in a menubar";
116 string label = i->label();
117 string shortcut = "#" + i->shortcut();
118 int width = string_width(label);
119 obj = fl_add_button(FL_MENU_BUTTON,
124 fl_set_object_boxtype(obj, FL_FLAT_BOX);
125 fl_set_object_color(obj, FL_MCOL, FL_MCOL);
126 fl_set_object_lsize(obj, MENU_LABEL_SIZE);
127 fl_set_object_lstyle(obj, FL_NORMAL_STYLE);
128 fl_set_object_resize(obj, FL_RESIZE_ALL);
129 fl_set_object_gravity(obj, NorthWestGravity,
131 moffset += obj->w + air;
132 fl_set_object_shortcut(obj, shortcut.c_str(), 1);
133 fl_set_object_callback(obj, C_Menubar_Pimpl_MenuCallback, 1);
135 ItemInfo * iteminfo = new ItemInfo(this,
136 new MenuItem(*i), obj);
137 buttonlist_.push_back(iteminfo);
138 obj->u_vdata = iteminfo;
143 void Menubar::Pimpl::set(string const & menu_name)
145 lyxerr[Debug::GUI] << "Entering Menubar::Pimpl::set "
146 << "for menu `" << menu_name << "'" << endl;
148 if (menu_name != current_menu_name_) {
149 MenubarMap::iterator mbit = menubarmap_.find(menu_name);
151 if (mbit == menubarmap_.end()) {
152 lyxerr << "ERROR:set: Unknown menu `" << menu_name
157 if (current_group_) {
158 lyxerr[Debug::GUI] << " hiding group "
159 << current_group_ << endl;
160 fl_hide_object(current_group_);
163 lyxerr[Debug::GUI] << " showing group "
164 << mbit->second << endl;
165 fl_show_object(mbit->second);
166 current_menu_name_ = menu_name;
167 current_group_ = mbit->second;
168 lyxerr[Debug::GUI] << "Menubar::Pimpl::set: Menubar set."
172 lyxerr [Debug::GUI] << "Menubar::Pimpl::set: Nothing to do."
176 void Menubar::Pimpl::openByName(string const & name)
178 if (menubackend_->getMenu(current_menu_name_).hasSubmenu(name)) {
179 for (ButtonList::const_iterator cit = buttonlist_.begin();
180 cit != buttonlist_.end(); ++cit) {
181 if ((*cit)->item_->submenu() == name) {
182 MenuCallback((*cit)->obj_, 1);
187 lyxerr << "Menubar::Pimpl::openByName: menu "
188 << name << " not found" << endl;
192 string limit_string_length(string const & str)
194 string::size_type const max_item_length = 45;
196 if (str.size() > max_item_length)
197 return str.substr(0, max_item_length - 3) + "...";
203 int get_new_submenu(vector<int> & smn, Window win)
205 static size_type max_number_of_menus = 32;
206 if (smn.size() >= max_number_of_menus)
207 max_number_of_menus =
208 fl_setpup_maxpup(static_cast<int>(2*smn.size()));
209 int menu = fl_newpup(win);
214 size_type const max_number_of_items = 25;
217 string const fixlabel(string const & str)
220 return subst(str, '%', '?');
222 return subst(str, "%", "%%");
226 void add_toc2(int menu, string const & extra_label,
227 vector<int> & smn, Window win,
228 vector<Buffer::TocItem> const & toc_list,
229 size_type from, size_type to, int depth)
231 if (to - from <= max_number_of_items) {
232 for (size_type i = from; i < to; ++i) {
233 int action = lyxaction.
234 getPseudoAction(LFUN_GOTO_PARAGRAPH,
235 tostr(toc_list[i].par->id()));
236 string label(4 * max(0, toc_list[i].depth - depth),' ');
237 label += fixlabel(toc_list[i].str);
238 label = limit_string_length(label);
239 label += "%x" + tostr(action + action_offset);
240 if (i == to - 1 && depth == 0)
241 label += extra_label;
242 fl_addtopup(menu, label.c_str());
245 size_type pos = from;
249 if (count > max_number_of_items) {
250 int menu2 = get_new_submenu(smn, win);
251 add_toc2(menu2, extra_label, smn, win,
252 toc_list, pos, to, depth);
253 string label = _("More");
256 label += extra_label;
257 fl_addtopup(menu, label.c_str(), menu2);
260 size_type new_pos = pos+1;
261 while (new_pos < to &&
262 toc_list[new_pos].depth > depth)
265 int action = lyxaction.
266 getPseudoAction(LFUN_GOTO_PARAGRAPH,
267 tostr(toc_list[pos].par->id()));
268 string label(4 * max(0, toc_list[pos].depth - depth), ' ');
269 label += fixlabel(toc_list[pos].str);
270 label = limit_string_length(label);
271 if (new_pos == to && depth == 0)
272 label += extra_label;
274 if (new_pos == pos + 1) {
275 label += "%x" + tostr(action + action_offset);
276 fl_addtopup(menu, label.c_str());
278 int menu2 = get_new_submenu(smn, win);
279 add_toc2(menu2, extra_label, smn, win,
280 toc_list, pos, new_pos, depth+1);
282 fl_addtopup(menu, label.c_str(), menu2);
289 void Menubar::Pimpl::add_toc(int menu, string const & extra_label,
290 vector<int> & smn, Window win)
292 //xgettext:no-c-format
293 static char const * MenuNames[3] = { N_("List of Figures%m"),
294 //xgettext:no-c-format
295 N_("List of Tables%m"),
296 //xgettext:no-c-format
297 N_("List of Algorithms%m") };
299 vector<vector<Buffer::TocItem> > toc_list =
300 owner_->buffer()->getTocList();
302 // Handle LOF/LOT/LOA
303 int max_nonempty = 0;
304 for (int i = 1; i <= 3; ++i)
305 if (!toc_list[i].empty())
308 for (int j = 1; j <= 3; ++j)
309 if (!toc_list[j].empty()) {
310 int menu2 = get_new_submenu(smn, win);
311 for (size_type i = 0; i < toc_list[j].size(); ++i) {
312 if (i > max_number_of_items) {
313 fl_addtopup(menu2, ". . .%d");
316 int action = lyxaction.
317 getPseudoAction(LFUN_GOTO_PARAGRAPH,
318 tostr(toc_list[j][i].par->id()));
319 string label = fixlabel(toc_list[j][i].str);
320 label = limit_string_length(label);
321 label += "%x" + tostr(action + action_offset);
322 fl_addtopup(menu2, label.c_str());
324 if (j == max_nonempty) {
325 string label = _(MenuNames[j - 1]);
327 fl_addtopup(menu, label.c_str(), menu2);
329 fl_addtopup(menu, _(MenuNames[j - 1]), menu2);
333 if (max_nonempty == 0 && toc_list[0].empty()) {
334 fl_addtopup(menu,_("No Table of Contents%i"));
338 add_toc2(menu, extra_label, smn, win,
339 toc_list[0], 0, toc_list[0].size(), 0);
343 void add_references2(int menu, vector<int> & smn, Window win,
344 vector<string> const & label_list, string const & type)
346 size_type const max_number_of_items = 25;
347 size_type const max_number_of_items2 = 20;
348 string::size_type const max_item_length = 40;
349 string::size_type const max_item_length2 = 20;
351 if (label_list.size() <= max_number_of_items)
352 for (size_type i = 0; i < label_list.size(); ++i) {
353 int action = (type == "goto")
354 ? lyxaction.getPseudoAction(LFUN_REF_GOTO,
356 : lyxaction.getPseudoAction(LFUN_REF_INSERT,
359 string label = label_list[i];
360 if (label.size() > max_item_length)
361 label = label.substr(0, max_item_length-1) + "$";
362 label += "%x" + tostr(action + action_offset);
363 fl_addtopup(menu, label.c_str());
367 for (size_type i = 0; i < label_list.size();
368 i += max_number_of_items2) {
370 if (count > max_number_of_items) {
371 fl_addtopup(menu, ". . .%d");
374 size_type j = min(label_list.size(),
375 i+max_number_of_items2);
378 label += (label_list[i].size() > max_item_length2)
379 ? label_list[i].substr(0, max_item_length2-1) + "$"
382 label += (label_list[j-1].size() > max_item_length2)
383 ? label_list[j-1].substr(0, max_item_length2-1) + "$"
384 : label += label_list[j-1];
386 int menu2 = get_new_submenu(smn, win);
387 for (size_type k = i; k < j; ++k) {
388 int action = (type == "goto")
389 ? lyxaction.getPseudoAction(LFUN_REF_GOTO,
391 : lyxaction.getPseudoAction(LFUN_REF_INSERT,
394 string label2 = label_list[k];
395 if (label2.size() > max_item_length)
396 label2 = label2.substr(0, max_item_length-1) + "$";
397 label2 += "%x" + tostr(action + action_offset);
398 fl_addtopup(menu2, label2.c_str());
401 fl_addtopup(menu, label.c_str(), menu2);
407 void Menubar::Pimpl::add_references(int menu, string const & extra_label,
408 vector<int> & smn, Window win)
410 //xgettext:no-c-format
411 static char const * MenuNames[6] = { N_("Insert Reference%m"),
412 //xgettext:no-c-format
413 N_("Insert Page Number%m"),
414 //xgettext:no-c-format
416 //xgettext:no-c-format
417 N_("Insert vpageref%m"),
418 //xgettext:no-c-format
419 N_("Insert Pretty Ref%m"),
420 //xgettext:no-c-format
421 N_("Goto Reference%m") };
425 int const READONLY = 4;
427 static int MenuFlags[6] = {
430 EMPTY | READONLY | SGML,
431 EMPTY | READONLY | SGML,
432 EMPTY | READONLY | SGML,
435 static string const MenuTypes[6] = {
436 "ref", "pageref", "vref", "vpageref", "prettyref", "goto" };
438 vector<string> label_list = owner_->buffer()->getLabelList();
441 if (label_list.empty())
443 if (owner_->buffer()->isSGML())
445 if (owner_->buffer()->isReadonly())
448 int max_nonempty = -1;
449 for (int i = 0; i < 6; ++i)
450 if ((MenuFlags[i] & flag) == 0)
453 for (int i = 0; i < 6; ++i) {
454 if ((MenuFlags[i] & flag) == 0) {
455 string label = _(MenuNames[i]);
456 if (i == max_nonempty)
457 label += extra_label;
458 int menu2 = get_new_submenu(smn, win);
459 add_references2(menu2, smn, win, label_list,
461 fl_addtopup(menu, label.c_str(), menu2);
467 int Menubar::Pimpl::create_submenu(Window win, LyXView * view,
468 string const & menu_name,
471 if (!menubackend_->hasMenu(menu_name)){
472 lyxerr << "ERROR:create_submenu: Unknown menu `"
473 << menu_name << "'" << endl;
477 menubackend_->getMenu(menu_name).expand(md, owner_->buffer());
479 int menu = get_new_submenu(smn, win);
480 fl_setpup_softedge(menu, true);
481 fl_setpup_bw(menu, -1);
482 lyxerr[Debug::GUI] << "Adding menu " << menu
483 << " in deletion list" << endl;
485 // Compute the size of the largest label (because xforms is
486 // not able to support shortcuts correctly...)
489 Menu::const_iterator end = md.end();
490 for (Menu::const_iterator i = md.begin(); i != end; ++i) {
491 MenuItem const & item = (*i);
492 if (item.kind() == MenuItem::Command) {
493 string label = item.label() + '\t';
494 int width = string_width(label);
495 if (width > max_width) {
497 widest_label = label;
501 lyxerr[Debug::GUI] << "max_width=" << max_width
502 << ", widest_label=`" << widest_label
505 // Compute where to put separators
506 vector<string> extra_labels(md.size());
507 vector<string>::iterator it = extra_labels.begin();
508 vector<string>::iterator last = it;
509 for (Menu::const_iterator i = md.begin(); i != end; ++i, ++it)
510 if (i->kind() == MenuItem::Separator)
512 else if (!i->optional() ||
513 !(view->getLyXFunc()->getStatus(i->action()) & LyXFunc::Disabled))
516 it = extra_labels.begin();
517 for (Menu::const_iterator i = md.begin(); i != end; ++i, ++it) {
518 MenuItem const & item = (*i);
519 string & extra_label = *it;
521 switch (item.kind()) {
522 case MenuItem::Command: {
523 LyXFunc::func_status flag =
524 view->getLyXFunc()->getStatus(item.action());
526 // handle optional entries.
527 if (item.optional() && (flag & LyXFunc::Disabled)) {
529 << "Skipping optional item "
530 << item.label() << endl;
534 // Get the keys bound to this action, but keep only the
536 string accel = toplevel_keymap->findbinding(item.action());
537 // Build the menu label from all the info
538 string label = item.label();
540 if (!accel.empty()) {
541 // Try to be clever and add just enough
542 // tabs to align shortcuts.
545 while (string_width(label) < max_width);
546 label += accel.substr(1,accel.find(']') - 1);
548 label += "%x" + tostr(item.action() + action_offset)
551 // Modify the entry using the function status
553 if (flag & (LyXFunc::Disabled | LyXFunc::Unknown))
555 if (flag & LyXFunc::ToggleOn)
557 if (flag & LyXFunc::ToggleOff)
561 // Finally the menu shortcut
562 string shortcut = item.shortcut();
564 if (!shortcut.empty()) {
565 shortcut += lowercase(shortcut[0]);
567 fl_addtopup(menu, label.c_str(),
570 fl_addtopup(menu, label.c_str());
572 lyxerr[Debug::GUI] << "Command: \""
573 << lyxaction.getActionName(item.action())
574 << "\", binding \"" << accel
575 << "\", shortcut \"" << shortcut
580 case MenuItem::Submenu: {
581 int submenu = create_submenu(win, view,
582 item.submenu(), smn);
585 string label = item.label();
586 label += extra_label + "%m";
587 string shortcut = item.shortcut();
588 if (!shortcut.empty()) {
589 shortcut += lowercase(shortcut[0]);
591 fl_addtopup(menu, label.c_str(),
592 submenu, shortcut.c_str());
595 fl_addtopup(menu, label.c_str(), submenu);
600 case MenuItem::Separator:
601 // already done, and if it was the first one,
602 // we just ignore it.
606 add_toc(menu, extra_label, smn, win);
609 case MenuItem::References:
610 add_references(menu, extra_label, smn, win);
613 case MenuItem::Documents:
614 case MenuItem::Lastfiles:
615 case MenuItem::ViewFormats:
616 case MenuItem::UpdateFormats:
617 case MenuItem::ExportFormats:
618 case MenuItem::ImportFormats:
619 lyxerr << "Menubar::Pimpl::create_submenu: "
620 "this should not happen" << endl;
629 void C_Menubar_Pimpl_MenuCallback(FL_OBJECT * ob, long button)
631 Menubar::Pimpl::MenuCallback(ob, button);
635 void Menubar::Pimpl::MenuCallback(FL_OBJECT * ob, long button)
637 ItemInfo * iteminfo = static_cast<ItemInfo *>(ob->u_vdata);
638 // lyxerr << "MenuCallback: ItemInfo address=" << iteminfo
639 // << "Val=(pimpl_=" << iteminfo->pimpl_
640 // << ", item_=" << iteminfo->item_
641 // << ", obj_=" << iteminfo->obj_ << ")" <<endl;
643 LyXView * view = iteminfo->pimpl_->owner_;
644 MenuItem const * item = iteminfo->item_;
647 // set the pseudo menu-button
648 fl_set_object_boxtype(ob, FL_DOWN_BOX);
649 fl_set_button(ob, 0);
650 fl_redraw_object(ob);
654 Assert(item->kind() == MenuItem::Submenu);
656 // set tabstop length
657 fl_set_tabstop(menu_tabstop);
658 vector<int> submenus;
659 int menu = iteminfo->pimpl_->
660 create_submenu(FL_ObjWin(ob), view,
661 item->submenu(), submenus);
664 fl_setpup_position(view->getForm()->x + ob->x,
665 view->getForm()->y + ob->y + ob->h + 10);
666 int choice = fl_dopup(menu);
669 // set the pseudo menu-button back
670 fl_set_object_boxtype(ob, FL_FLAT_BOX);
671 fl_redraw_object(ob);
674 // If the action value is too low, then it is not a
675 // valid action, but something else.
676 if (choice >= action_offset + 1) {
677 view->getLyXFunc()->Dispatch(choice - action_offset);
681 << "MenuCallback: ignoring bogus action "
686 lyxerr << "Error in MenuCallback" << endl;
688 std::for_each(submenus.begin(), submenus.end(), fl_freepup);
689 // restore tabstop length
690 fl_set_tabstop(default_tabstop);