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;
193 string const limit_string_length(string const & str)
195 string::size_type const max_item_length = 45;
197 if (str.size() > max_item_length)
198 return str.substr(0, max_item_length - 3) + "...";
205 int get_new_submenu(vector<int> & smn, Window win)
207 static size_type max_number_of_menus = 32;
208 if (smn.size() >= max_number_of_menus)
209 max_number_of_menus =
210 fl_setpup_maxpup(static_cast<int>(2*smn.size()));
211 int menu = fl_newpup(win);
217 size_type const max_number_of_items = 25;
220 string const fixlabel(string const & str)
223 return subst(str, '%', '?');
225 return subst(str, "%", "%%");
230 void add_toc2(int menu, string const & extra_label,
231 vector<int> & smn, Window win,
232 vector<Buffer::TocItem> const & toc_list,
233 size_type from, size_type to, int depth)
235 if (to - from <= max_number_of_items) {
236 for (size_type i = from; i < to; ++i) {
237 int const action = lyxaction.
238 getPseudoAction(LFUN_GOTO_PARAGRAPH,
239 tostr(toc_list[i].par->id()));
240 string label(4 * max(0, toc_list[i].depth - depth),' ');
241 label += fixlabel(toc_list[i].str);
242 label = limit_string_length(label);
243 label += "%x" + tostr(action + action_offset);
244 if (i == to - 1 && depth == 0)
245 label += extra_label;
246 fl_addtopup(menu, label.c_str());
249 size_type pos = from;
253 if (count > max_number_of_items) {
254 int menu2 = get_new_submenu(smn, win);
255 add_toc2(menu2, extra_label, smn, win,
256 toc_list, pos, to, depth);
257 string label = _("More");
260 label += extra_label;
261 fl_addtopup(menu, label.c_str(), menu2);
264 size_type new_pos = pos+1;
265 while (new_pos < to &&
266 toc_list[new_pos].depth > depth)
269 int const action = lyxaction.
270 getPseudoAction(LFUN_GOTO_PARAGRAPH,
271 tostr(toc_list[pos].par->id()));
272 string label(4 * max(0, toc_list[pos].depth - depth), ' ');
273 label += fixlabel(toc_list[pos].str);
274 label = limit_string_length(label);
275 if (new_pos == to && depth == 0)
276 label += extra_label;
278 if (new_pos == pos + 1) {
279 label += "%x" + tostr(action + action_offset);
280 fl_addtopup(menu, label.c_str());
282 int menu2 = get_new_submenu(smn, win);
283 add_toc2(menu2, extra_label, smn, win,
284 toc_list, pos, new_pos, depth+1);
286 fl_addtopup(menu, label.c_str(), menu2);
294 void Menubar::Pimpl::add_toc(int menu, string const & extra_label,
295 vector<int> & smn, Window win)
297 //xgettext:no-c-format
298 static char const * MenuNames[3] = { N_("List of Figures%m"),
299 //xgettext:no-c-format
300 N_("List of Tables%m"),
301 //xgettext:no-c-format
302 N_("List of Algorithms%m") };
304 vector<vector<Buffer::TocItem> > toc_list =
305 owner_->buffer()->getTocList();
307 // Handle LOF/LOT/LOA
308 int max_nonempty = 0;
309 for (int i = 1; i <= 3; ++i)
310 if (!toc_list[i].empty())
313 for (int j = 1; j <= 3; ++j)
314 if (!toc_list[j].empty()) {
315 int menu2 = get_new_submenu(smn, win);
316 for (size_type i = 0; i < toc_list[j].size(); ++i) {
317 if (i > max_number_of_items) {
318 fl_addtopup(menu2, ". . .%d");
321 int const action = lyxaction.
322 getPseudoAction(LFUN_GOTO_PARAGRAPH,
323 tostr(toc_list[j][i].par->id()));
324 string label = fixlabel(toc_list[j][i].str);
325 label = limit_string_length(label);
326 label += "%x" + tostr(action + action_offset);
327 fl_addtopup(menu2, label.c_str());
329 if (j == max_nonempty) {
330 string label = _(MenuNames[j - 1]);
332 fl_addtopup(menu, label.c_str(), menu2);
334 fl_addtopup(menu, _(MenuNames[j - 1]), menu2);
338 if (max_nonempty == 0 && toc_list[0].empty()) {
339 fl_addtopup(menu,_("No Table of Contents%i"));
343 add_toc2(menu, extra_label, smn, win,
344 toc_list[0], 0, toc_list[0].size(), 0);
348 void add_references2(int menu, vector<int> & smn, Window win,
349 vector<string> const & label_list, string const & type)
351 size_type const max_number_of_items = 25;
352 size_type const max_number_of_items2 = 20;
353 string::size_type const max_item_length = 40;
354 string::size_type const max_item_length2 = 20;
356 if (label_list.size() <= max_number_of_items)
357 for (size_type i = 0; i < label_list.size(); ++i) {
358 int const action = (type == "goto")
359 ? lyxaction.getPseudoAction(LFUN_REF_GOTO,
361 : lyxaction.getPseudoAction(LFUN_REF_INSERT,
364 string label = label_list[i];
365 if (label.size() > max_item_length)
366 label = label.substr(0, max_item_length-1) + "$";
367 label += "%x" + tostr(action + action_offset);
368 fl_addtopup(menu, label.c_str());
372 for (size_type i = 0; i < label_list.size();
373 i += max_number_of_items2) {
375 if (count > max_number_of_items) {
376 fl_addtopup(menu, ". . .%d");
379 size_type j = min(label_list.size(),
380 i+max_number_of_items2);
383 label += (label_list[i].size() > max_item_length2)
384 ? label_list[i].substr(0, max_item_length2-1) + "$"
387 label += (label_list[j-1].size() > max_item_length2)
388 ? label_list[j-1].substr(0, max_item_length2-1) + "$"
389 : label += label_list[j-1];
391 int menu2 = get_new_submenu(smn, win);
392 for (size_type k = i; k < j; ++k) {
393 int const action = (type == "goto")
394 ? lyxaction.getPseudoAction(LFUN_REF_GOTO,
396 : lyxaction.getPseudoAction(LFUN_REF_INSERT,
399 string label2 = label_list[k];
400 if (label2.size() > max_item_length)
401 label2 = label2.substr(0, max_item_length-1) + "$";
402 label2 += "%x" + tostr(action + action_offset);
403 fl_addtopup(menu2, label2.c_str());
406 fl_addtopup(menu, label.c_str(), menu2);
412 void Menubar::Pimpl::add_references(int menu, string const & extra_label,
413 vector<int> & smn, Window win)
415 //xgettext:no-c-format
416 static char const * MenuNames[6] = { N_("Insert Reference%m"),
417 //xgettext:no-c-format
418 N_("Insert Page Number%m"),
419 //xgettext:no-c-format
421 //xgettext:no-c-format
422 N_("Insert vpageref%m"),
423 //xgettext:no-c-format
424 N_("Insert Pretty Ref%m"),
425 //xgettext:no-c-format
426 N_("Goto Reference%m") };
430 int const READONLY = 4;
432 static int MenuFlags[6] = {
435 EMPTY | READONLY | SGML,
436 EMPTY | READONLY | SGML,
437 EMPTY | READONLY | SGML,
440 static string const MenuTypes[6] = {
441 "ref", "pageref", "vref", "vpageref", "prettyref", "goto" };
443 vector<string> label_list = owner_->buffer()->getLabelList();
446 if (label_list.empty())
448 if (owner_->buffer()->isSGML())
450 if (owner_->buffer()->isReadonly())
453 int max_nonempty = -1;
454 for (int i = 0; i < 6; ++i)
455 if ((MenuFlags[i] & flag) == 0)
458 for (int i = 0; i < 6; ++i) {
459 if ((MenuFlags[i] & flag) == 0) {
460 string label = _(MenuNames[i]);
461 if (i == max_nonempty)
462 label += extra_label;
463 int menu2 = get_new_submenu(smn, win);
464 add_references2(menu2, smn, win, label_list,
466 fl_addtopup(menu, label.c_str(), menu2);
472 int Menubar::Pimpl::create_submenu(Window win, LyXView * view,
473 string const & menu_name,
476 if (!menubackend_->hasMenu(menu_name)){
477 lyxerr << "ERROR:create_submenu: Unknown menu `"
478 << menu_name << "'" << endl;
482 menubackend_->getMenu(menu_name).expand(md, owner_->buffer());
484 int menu = get_new_submenu(smn, win);
485 fl_setpup_softedge(menu, true);
486 fl_setpup_bw(menu, -1);
487 lyxerr[Debug::GUI] << "Adding menu " << menu
488 << " in deletion list" << endl;
490 // Compute the size of the largest label (because xforms is
491 // not able to support shortcuts correctly...)
494 Menu::const_iterator end = md.end();
495 for (Menu::const_iterator i = md.begin(); i != end; ++i) {
496 MenuItem const & item = (*i);
497 if (item.kind() == MenuItem::Command) {
498 string label = item.label() + '\t';
499 int width = string_width(label);
500 if (width > max_width) {
502 widest_label = label;
506 lyxerr[Debug::GUI] << "max_width=" << max_width
507 << ", widest_label=`" << widest_label
510 // Compute where to put separators
511 vector<string> extra_labels(md.size());
512 vector<string>::iterator it = extra_labels.begin();
513 vector<string>::iterator last = it;
514 for (Menu::const_iterator i = md.begin(); i != end; ++i, ++it)
515 if (i->kind() == MenuItem::Separator)
517 else if (!i->optional() ||
518 !(view->getLyXFunc()->getStatus(i->action()) & LyXFunc::Disabled))
521 it = extra_labels.begin();
522 for (Menu::const_iterator i = md.begin(); i != end; ++i, ++it) {
523 MenuItem const & item = (*i);
524 string & extra_label = *it;
526 switch (item.kind()) {
527 case MenuItem::Command: {
528 LyXFunc::func_status flag =
529 view->getLyXFunc()->getStatus(item.action());
531 // handle optional entries.
532 if (item.optional() && (flag & LyXFunc::Disabled)) {
534 << "Skipping optional item "
535 << item.label() << endl;
539 // Get the keys bound to this action, but keep only the
541 string const accel = toplevel_keymap->findbinding(item.action());
542 // Build the menu label from all the info
543 string label = item.label();
545 if (!accel.empty()) {
546 // Try to be clever and add just enough
547 // tabs to align shortcuts.
550 while (string_width(label) < max_width);
551 label += accel.substr(1,accel.find(']') - 1);
553 label += "%x" + tostr(item.action() + action_offset)
556 // Modify the entry using the function status
558 if (flag & (LyXFunc::Disabled | LyXFunc::Unknown))
560 if (flag & LyXFunc::ToggleOn)
562 if (flag & LyXFunc::ToggleOff)
566 // Finally the menu shortcut
567 string shortcut = item.shortcut();
569 if (!shortcut.empty()) {
570 shortcut += lowercase(shortcut[0]);
572 fl_addtopup(menu, label.c_str(),
575 fl_addtopup(menu, label.c_str());
577 lyxerr[Debug::GUI] << "Command: \""
578 << lyxaction.getActionName(item.action())
579 << "\", binding \"" << accel
580 << "\", shortcut \"" << shortcut
585 case MenuItem::Submenu: {
586 int submenu = create_submenu(win, view,
587 item.submenu(), smn);
590 string label = item.label();
591 label += extra_label + "%m";
592 string shortcut = item.shortcut();
593 if (!shortcut.empty()) {
594 shortcut += lowercase(shortcut[0]);
596 fl_addtopup(menu, label.c_str(),
597 submenu, shortcut.c_str());
600 fl_addtopup(menu, label.c_str(), submenu);
605 case MenuItem::Separator:
606 // already done, and if it was the first one,
607 // we just ignore it.
611 add_toc(menu, extra_label, smn, win);
614 case MenuItem::References:
615 add_references(menu, extra_label, smn, win);
618 case MenuItem::Documents:
619 case MenuItem::Lastfiles:
620 case MenuItem::ViewFormats:
621 case MenuItem::UpdateFormats:
622 case MenuItem::ExportFormats:
623 case MenuItem::ImportFormats:
624 lyxerr << "Menubar::Pimpl::create_submenu: "
625 "this should not happen" << endl;
635 void C_Menubar_Pimpl_MenuCallback(FL_OBJECT * ob, long button)
637 Menubar::Pimpl::MenuCallback(ob, button);
641 void Menubar::Pimpl::MenuCallback(FL_OBJECT * ob, long button)
643 ItemInfo * iteminfo = static_cast<ItemInfo *>(ob->u_vdata);
644 // lyxerr << "MenuCallback: ItemInfo address=" << iteminfo
645 // << "Val=(pimpl_=" << iteminfo->pimpl_
646 // << ", item_=" << iteminfo->item_
647 // << ", obj_=" << iteminfo->obj_ << ")" <<endl;
649 LyXView * view = iteminfo->pimpl_->owner_;
650 MenuItem const * item = iteminfo->item_;
653 // set the pseudo menu-button
654 fl_set_object_boxtype(ob, FL_DOWN_BOX);
655 fl_set_button(ob, 0);
656 fl_redraw_object(ob);
660 Assert(item->kind() == MenuItem::Submenu);
662 // set tabstop length
663 fl_set_tabstop(menu_tabstop);
664 vector<int> submenus;
665 int menu = iteminfo->pimpl_->
666 create_submenu(FL_ObjWin(ob), view,
667 item->submenu(), submenus);
670 fl_setpup_position(view->getForm()->x + ob->x,
671 view->getForm()->y + ob->y + ob->h + 10);
672 int choice = fl_dopup(menu);
675 // set the pseudo menu-button back
676 fl_set_object_boxtype(ob, FL_FLAT_BOX);
677 fl_redraw_object(ob);
680 // If the action value is too low, then it is not a
681 // valid action, but something else.
682 if (choice >= action_offset + 1) {
683 view->getLyXFunc()->Dispatch(choice - action_offset);
687 << "MenuCallback: ignoring bogus action "
692 lyxerr << "Error in MenuCallback" << endl;
694 std::for_each(submenus.begin(), submenus.end(), fl_freepup);
695 // restore tabstop length
696 fl_set_tabstop(default_tabstop);