2 * \file MenuBackend.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
11 * \author Martin Vermeer
13 * Full author contact details are available in file CREDITS.
18 #include "MenuBackend.h"
20 #include "BranchList.h"
22 #include "BufferList.h"
23 #include "BufferParams.h"
24 #include "Converter.h"
25 #include "CutAndPaste.h"
26 #include "support/debug.h"
28 #include "FloatList.h"
30 #include "support/gettext.h"
33 #include "LyXAction.h"
34 #include "LyX.h" // for lastfiles
37 #include "Paragraph.h"
38 #include "TextClass.h"
39 #include "TocBackend.h"
40 #include "ToolbarBackend.h"
42 #include "support/filetools.h"
43 #include "support/lstrings.h"
44 #include "support/convert.h"
46 #include <boost/bind.hpp>
56 using support::compare_ascii_no_case;
57 using support::contains;
58 using support::makeDisplayPath;
63 class MenuNamesEqual : public std::unary_function<Menu, bool> {
65 MenuNamesEqual(docstring const & name)
67 bool operator()(Menu const & menu) const {
68 return menu.name() == name_;
77 // This is the global menu definition
78 MenuBackend menubackend;
81 MenuItem::MenuItem(Kind kind)
82 : kind_(kind), optional_(false)
86 MenuItem::MenuItem(Kind kind, docstring const & label,
87 docstring const & submenu, bool optional)
88 : kind_(kind), label_(label),
89 submenuname_(submenu), optional_(optional)
91 BOOST_ASSERT(kind == Submenu);
95 MenuItem::MenuItem(Kind kind, docstring const & label,
96 FuncRequest const & func, bool optional)
97 : kind_(kind), label_(label), func_(func), optional_(optional)
99 func_.origin = FuncRequest::MENU;
103 MenuItem::~MenuItem()
107 void MenuItem::submenu(Menu * menu)
109 submenu_.reset(menu);
113 docstring const MenuItem::label() const
115 return token(label_, char_type('|'), 0);
119 docstring const MenuItem::shortcut() const
121 return token(label_, char_type('|'), 1);
125 docstring const MenuItem::binding(bool forgui) const
127 if (kind_ != Command)
130 // Get the keys bound to this action, but keep only the
132 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func_);
135 return bindings.begin()->print(KeySequence::ForGui);
137 LYXERR(Debug::KBMAP, "No binding for "
138 << lyxaction.getActionName(func_.action)
139 << '(' << to_utf8(func_.argument()) << ')');
144 Menu & Menu::add(MenuItem const & i)
151 Menu & Menu::addWithStatusCheck(MenuItem const & i)
155 case MenuItem::Command: {
156 FuncStatus status = lyx::getStatus(i.func());
157 if (status.unknown() || (!status.enabled() && i.optional()))
160 items_.back().status(status);
164 case MenuItem::Submenu: {
166 bool enabled = false;
167 for (const_iterator cit = i.submenu()->begin();
168 cit != i.submenu()->end(); ++cit) {
169 if ((cit->kind() == MenuItem::Command
170 || cit->kind() == MenuItem::Submenu)
171 && cit->status().enabled()) {
176 if (enabled || !i.optional()) {
178 items_.back().status().enabled(enabled);
186 case MenuItem::Separator:
188 && items_.back().kind() != MenuItem::Separator)
200 Menu & Menu::read(Lexer & lex)
228 struct keyword_item menutags[md_last - 1] = {
229 { "bookmarks", md_bookmarks },
230 { "branches", md_branches },
231 { "charstyles", md_charstyles },
232 { "custom", md_custom },
233 { "documents", md_documents },
234 { "elements", md_elements },
235 { "end", md_endmenu },
236 { "exportformats", md_exportformats },
237 { "floatinsert", md_floatinsert },
238 { "floatlistinsert", md_floatlistinsert },
239 { "importformats", md_importformats },
241 { "lastfiles", md_lastfiles },
242 { "optitem", md_optitem },
243 { "optsubmenu", md_optsubmenu },
244 { "pasterecent", md_pasterecent },
245 { "separator", md_separator },
246 { "submenu", md_submenu },
248 { "toolbars", md_toolbars },
249 { "updateformats", md_updateformats },
250 { "viewformats", md_viewformats }
253 lex.pushTable(menutags, md_last - 1);
254 if (lyxerr.debugging(Debug::PARSER))
255 lex.printTable(lyxerr);
258 bool optional = false;
260 while (lex.isOK() && !quit) {
264 // fallback to md_item
267 docstring const name = translateIfPossible(lex.getDocString());
269 string const command = lex.getString();
270 FuncRequest func = lyxaction.lookupFunc(command);
271 add(MenuItem(MenuItem::Command, name, func, optional));
277 add(MenuItem(MenuItem::Separator));
281 add(MenuItem(MenuItem::Lastfiles));
285 add(MenuItem(MenuItem::CharStyles));
289 add(MenuItem(MenuItem::Custom));
293 add(MenuItem(MenuItem::Elements));
297 add(MenuItem(MenuItem::Documents));
301 add(MenuItem(MenuItem::Bookmarks));
305 add(MenuItem(MenuItem::Toc));
309 add(MenuItem(MenuItem::ViewFormats));
312 case md_updateformats:
313 add(MenuItem(MenuItem::UpdateFormats));
316 case md_exportformats:
317 add(MenuItem(MenuItem::ExportFormats));
320 case md_importformats:
321 add(MenuItem(MenuItem::ImportFormats));
324 case md_floatlistinsert:
325 add(MenuItem(MenuItem::FloatListInsert));
329 add(MenuItem(MenuItem::FloatInsert));
333 add(MenuItem(MenuItem::PasteRecent));
337 add(MenuItem(MenuItem::Toolbars));
341 add(MenuItem(MenuItem::Branches));
346 // fallback to md_submenu
349 docstring const mlabel = translateIfPossible(lex.getDocString());
351 docstring const mname = lex.getDocString();
352 add(MenuItem(MenuItem::Submenu, mlabel, mname,
363 lex.printError("Menu::read: "
364 "Unknown menu tag: `$$Token'");
373 MenuItem const & Menu::operator[](size_type i) const
379 bool Menu::hasFunc(FuncRequest const & func) const
381 return find_if(begin(), end(),
382 bind(std::equal_to<FuncRequest>(),
383 bind(&MenuItem::func, _1),
387 void Menu::checkShortcuts() const
389 // This is a quadratic algorithm, but we do not care because
390 // menus are short enough
391 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
392 docstring shortcut = it1->shortcut();
393 if (shortcut.empty())
395 if (!contains(it1->label(), shortcut))
396 lyxerr << "Menu warning: menu entry \""
397 << to_utf8(it1->label())
398 << "\" does not contain shortcut `"
399 << to_utf8(shortcut) << "'." << endl;
400 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
401 if (!compare_ascii_no_case(it2->shortcut(), shortcut)) {
402 lyxerr << "Menu warning: menu entries "
403 << '"' << to_utf8(it1->fulllabel())
404 << "\" and \"" << to_utf8(it2->fulllabel())
405 << "\" share the same shortcut."
413 bool Menu::searchFunc(FuncRequest & func, stack<docstring> & names)
415 const_iterator m = begin();
416 const_iterator m_end = end();
417 for (; m != m_end; ++m) {
418 if (m->kind() == MenuItem::Command && m->func() == func) {
419 names.push(m->label());
421 } else if (m->kind() == MenuItem::Submenu) {
422 names.push(m->label());
423 Menu submenu = menubackend.getMenu(m->submenuname());
424 if (submenu.searchFunc(func, names))
434 void MenuBackend::specialMenu(Menu const & menu)
442 class compare_format {
444 bool operator()(Format const * p1, Format const * p2) {
449 docstring const limit_string_length(docstring const & str)
451 docstring::size_type const max_item_length = 45;
453 if (str.size() > max_item_length)
454 return str.substr(0, max_item_length - 3) + "...";
460 void expandLastfiles(Menu & tomenu)
462 lyx::LastFilesSection::LastFiles const & lf = LyX::cref().session().lastFiles().lastFiles();
463 lyx::LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
467 for (; lfit != lf.end() && ii < 10; ++lfit, ++ii) {
468 string const file = lfit->absFilename();
469 docstring const label = convert<docstring>(ii) + ". "
470 + makeDisplayPath(file, 30)
471 + char_type('|') + convert<docstring>(ii);
472 tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, file)));
477 void expandDocuments(Menu & tomenu)
479 Buffer * first = theBufferList().first();
484 // We cannot use a for loop as the buffer list cycles.
486 docstring label = b->fileName().displayName(20);
490 label = convert<docstring>(ii) + ". " + label + '|' + convert<docstring>(ii);
491 tomenu.add(MenuItem(MenuItem::Command, label,
492 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
494 b = theBufferList().next(b);
496 } while (b != first);
498 tomenu.add(MenuItem(MenuItem::Command, _("No Documents Open!"),
499 FuncRequest(LFUN_NOACTION)));
504 void expandBookmarks(Menu & tomenu)
506 lyx::BookmarksSection const & bm = LyX::cref().session().bookmarks();
508 for (size_t i = 1; i <= bm.size(); ++i) {
510 docstring const label = convert<docstring>(i) + ". "
511 + makeDisplayPath(bm.bookmark(i).filename.absFilename(), 20)
512 + char_type('|') + convert<docstring>(i);
513 tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_BOOKMARK_GOTO,
514 convert<docstring>(i))));
520 void expandFormats(MenuItem::Kind kind, Menu & tomenu, Buffer const * buf)
522 if (!buf && kind != MenuItem::ImportFormats) {
523 tomenu.add(MenuItem(MenuItem::Command,
524 _("No Document Open!"),
525 FuncRequest(LFUN_NOACTION)));
529 typedef vector<Format const *> Formats;
534 case MenuItem::ImportFormats:
535 formats = theConverters().importableFormats();
536 action = LFUN_BUFFER_IMPORT;
538 case MenuItem::ViewFormats:
539 formats = buf->exportableFormats(true);
540 action = LFUN_BUFFER_VIEW;
542 case MenuItem::UpdateFormats:
543 formats = buf->exportableFormats(true);
544 action = LFUN_BUFFER_UPDATE;
547 formats = buf->exportableFormats(false);
548 action = LFUN_BUFFER_EXPORT;
550 sort(formats.begin(), formats.end(), compare_format());
552 Formats::const_iterator fit = formats.begin();
553 Formats::const_iterator end = formats.end();
554 for (; fit != end ; ++fit) {
557 docstring label = from_utf8((*fit)->prettyname());
560 case MenuItem::ImportFormats:
561 // FIXME: This is a hack, we should rather solve
562 // FIXME: bug 2488 instead.
563 if ((*fit)->name() == "text")
564 label = _("Plain Text");
565 else if ((*fit)->name() == "textparagraph")
566 label = _("Plain Text, Join Lines");
569 case MenuItem::ViewFormats:
570 case MenuItem::ExportFormats:
571 case MenuItem::UpdateFormats:
572 if (!(*fit)->documentFormat())
579 if (!(*fit)->shortcut().empty())
580 label += char_type('|') + from_utf8((*fit)->shortcut());
583 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
584 FuncRequest(action, (*fit)->name())));
586 tomenu.add(MenuItem(MenuItem::Command, label,
587 FuncRequest(action, (*fit)->name())));
592 void expandFloatListInsert(Menu & tomenu, Buffer const * buf)
595 tomenu.add(MenuItem(MenuItem::Command,
596 _("No Document Open!"),
597 FuncRequest(LFUN_NOACTION)));
601 FloatList const & floats =
602 buf->params().getTextClass().floats();
603 FloatList::const_iterator cit = floats.begin();
604 FloatList::const_iterator end = floats.end();
605 for (; cit != end; ++cit) {
606 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command,
607 _(cit->second.listName()),
608 FuncRequest(LFUN_FLOAT_LIST,
609 cit->second.type())));
614 void expandFloatInsert(Menu & tomenu, Buffer const * buf)
617 tomenu.add(MenuItem(MenuItem::Command,
618 _("No Document Open!"),
619 FuncRequest(LFUN_NOACTION)));
623 FloatList const & floats =
624 buf->params().getTextClass().floats();
625 FloatList::const_iterator cit = floats.begin();
626 FloatList::const_iterator end = floats.end();
627 for (; cit != end; ++cit) {
629 docstring const label = _(cit->second.name());
630 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
631 FuncRequest(LFUN_FLOAT_INSERT,
632 cit->second.type())));
637 void expandFlexInsert(Menu & tomenu, Buffer const * buf, std::string s)
640 tomenu.add(MenuItem(MenuItem::Command,
641 _("No Document Open!"),
642 FuncRequest(LFUN_NOACTION)));
645 InsetLayouts const & insetlayouts =
646 buf->params().getTextClass().insetlayouts();
647 InsetLayouts::const_iterator cit = insetlayouts.begin();
648 InsetLayouts::const_iterator end = insetlayouts.end();
649 for (; cit != end; ++cit) {
650 docstring const label = cit->first;
651 if (cit->second.lyxtype == s)
652 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command,
653 label, FuncRequest(LFUN_FLEX_INSERT,
659 Menu::size_type const max_number_of_items = 25;
661 void expandToc2(Menu & tomenu,
662 Toc const & toc_list,
664 Toc::size_type to, int depth)
666 int shortcut_count = 0;
668 // check whether depth is smaller than the smallest depth in toc.
669 int min_depth = 1000;
670 for (Toc::size_type i = from; i < to; ++i)
671 min_depth = std::min(min_depth, toc_list[i].depth());
672 if (min_depth > depth)
676 if (to - from <= max_number_of_items) {
677 for (Toc::size_type i = from; i < to; ++i) {
678 docstring label(4 * max(0, toc_list[i].depth() - depth), char_type(' '));
679 label += limit_string_length(toc_list[i].str());
680 if (toc_list[i].depth() == depth
681 && shortcut_count < 9) {
682 if (label.find(convert<docstring>(shortcut_count + 1)) != docstring::npos)
683 label += char_type('|') + convert<docstring>(++shortcut_count);
685 tomenu.add(MenuItem(MenuItem::Command, label,
686 FuncRequest(toc_list[i].action())));
689 Toc::size_type pos = from;
691 Toc::size_type new_pos = pos + 1;
692 while (new_pos < to &&
693 toc_list[new_pos].depth() > depth)
696 docstring label(4 * max(0, toc_list[pos].depth() - depth), ' ');
697 label += limit_string_length(toc_list[pos].str());
698 if (toc_list[pos].depth() == depth &&
699 shortcut_count < 9) {
700 if (label.find(convert<docstring>(shortcut_count + 1)) != docstring::npos)
701 label += char_type('|') + convert<docstring>(++shortcut_count);
703 if (new_pos == pos + 1) {
704 tomenu.add(MenuItem(MenuItem::Command,
705 label, FuncRequest(toc_list[pos].action())));
707 MenuItem item(MenuItem::Submenu, label);
708 item.submenu(new Menu);
709 expandToc2(*item.submenu(),
710 toc_list, pos, new_pos, depth + 1);
719 void expandToc(Menu & tomenu, Buffer const * buf)
721 // To make things very cleanly, we would have to pass buf to
722 // all MenuItem constructors and to expandToc2. However, we
723 // know that all the entries in a TOC will be have status_ ==
724 // OK, so we avoid this unnecessary overhead (JMarc)
727 tomenu.add(MenuItem(MenuItem::Command,
728 _("No Document Open!"),
729 FuncRequest(LFUN_NOACTION)));
733 Buffer* cbuf = const_cast<Buffer*>(buf);
734 cbuf->tocBackend().update();
735 cbuf->structureChanged();
737 // Add an entry for the master doc if this is a child doc
738 Buffer const * const master = buf->masterBuffer();
740 ParIterator const pit = par_iterator_begin(master->inset());
741 string const arg = convert<string>(pit->id());
742 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
743 tomenu.add(MenuItem(MenuItem::Command, _("Master Document"), f));
746 FloatList const & floatlist = buf->params().getTextClass().floats();
747 TocList const & toc_list = buf->tocBackend().tocs();
748 TocList::const_iterator cit = toc_list.begin();
749 TocList::const_iterator end = toc_list.end();
750 for (; cit != end; ++cit) {
752 if (cit->first == "tableofcontents")
755 // All the rest is for floats
756 auto_ptr<Menu> menu(new Menu);
757 TocIterator ccit = cit->second.begin();
758 TocIterator eend = cit->second.end();
759 for (; ccit != eend; ++ccit) {
760 docstring const label = limit_string_length(ccit->str());
761 menu->add(MenuItem(MenuItem::Command,
763 FuncRequest(ccit->action())));
765 string const & floatName = floatlist.getType(cit->first).listName();
767 if (!floatName.empty())
768 label = _(floatName);
769 // BUG3633: listings is not a proper float so its name
770 // is not shown in floatlist.
771 else if (cit->first == "listing")
772 label = _("List of listings");
773 // this should not happen now, but if something else like
774 // listings is added later, this can avoid an empty menu name.
776 label = _("Other floats");
777 MenuItem item(MenuItem::Submenu, label);
778 item.submenu(menu.release());
783 cit = toc_list.find("tableofcontents");
785 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command,
786 _("No Table of contents"),
789 expandToc2(tomenu, cit->second, 0, cit->second.size(), 0);
794 void expandPasteRecent(Menu & tomenu, Buffer const * buf)
799 vector<docstring> const sel =
800 cap::availableSelections(*buf);
802 vector<docstring>::const_iterator cit = sel.begin();
803 vector<docstring>::const_iterator end = sel.end();
805 for (unsigned int index = 0; cit != end; ++cit, ++index) {
806 tomenu.add(MenuItem(MenuItem::Command, *cit,
807 FuncRequest(LFUN_PASTE, convert<string>(index))));
812 void expandToolbars(Menu & tomenu)
815 // extracts the toolbars from the backend
816 ToolbarBackend::Toolbars::const_iterator cit = toolbarbackend.begin();
817 ToolbarBackend::Toolbars::const_iterator end = toolbarbackend.end();
819 for (; cit != end; ++cit) {
820 docstring label = _(cit->gui_name);
821 // frontends are not supposed to turn on/off toolbars,
822 // if they cannot update ToolbarBackend::flags. That
823 // is to say, ToolbarsBackend::flags should reflect
824 // the true state of toolbars.
826 // menu is displayed as
830 // in the case of auto.
831 if (cit->flags & ToolbarInfo::AUTO)
832 label += _(" (auto)");
833 tomenu.add(MenuItem(MenuItem::Command, label,
834 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name + " allowauto")));
839 void expandBranches(Menu & tomenu, Buffer const * buf)
842 tomenu.add(MenuItem(MenuItem::Command,
843 _("No Document Open!"),
844 FuncRequest(LFUN_NOACTION)));
848 BufferParams const & params = buf->masterBuffer()->params();
849 if (params.branchlist().empty()) {
850 tomenu.add(MenuItem(MenuItem::Command,
851 _("No Branch in Document!"),
852 FuncRequest(LFUN_NOACTION)));
856 BranchList::const_iterator cit = params.branchlist().begin();
857 BranchList::const_iterator end = params.branchlist().end();
859 for (int ii = 1; cit != end; ++cit, ++ii) {
860 docstring label = cit->getBranch();
862 label = convert<docstring>(ii) + ". " + label + char_type('|') + convert<docstring>(ii);
863 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
864 FuncRequest(LFUN_BRANCH_INSERT,
873 void MenuBackend::expand(Menu const & frommenu, Menu & tomenu,
874 Buffer const * buf) const
879 for (Menu::const_iterator cit = frommenu.begin();
880 cit != frommenu.end() ; ++cit) {
881 switch (cit->kind()) {
882 case MenuItem::Lastfiles:
883 expandLastfiles(tomenu);
886 case MenuItem::Documents:
887 expandDocuments(tomenu);
890 case MenuItem::Bookmarks:
891 expandBookmarks(tomenu);
894 case MenuItem::ImportFormats:
895 case MenuItem::ViewFormats:
896 case MenuItem::UpdateFormats:
897 case MenuItem::ExportFormats:
898 expandFormats(cit->kind(), tomenu, buf);
901 case MenuItem::CharStyles:
902 expandFlexInsert(tomenu, buf, "charstyle");
905 case MenuItem::Custom:
906 expandFlexInsert(tomenu, buf, "custom");
909 case MenuItem::Elements:
910 expandFlexInsert(tomenu, buf, "element");
913 case MenuItem::FloatListInsert:
914 expandFloatListInsert(tomenu, buf);
917 case MenuItem::FloatInsert:
918 expandFloatInsert(tomenu, buf);
921 case MenuItem::PasteRecent:
922 expandPasteRecent(tomenu, buf);
925 case MenuItem::Toolbars:
926 expandToolbars(tomenu);
929 case MenuItem::Branches:
930 expandBranches(tomenu, buf);
934 expandToc(tomenu, buf);
937 case MenuItem::Submenu: {
939 item.submenu(new Menu(cit->submenuname()));
940 expand(getMenu(cit->submenuname()),
941 *item.submenu(), buf);
942 tomenu.addWithStatusCheck(item);
946 case MenuItem::Separator:
947 tomenu.addWithStatusCheck(*cit);
950 case MenuItem::Command:
951 if (!specialmenu_.hasFunc(cit->func()))
952 tomenu.addWithStatusCheck(*cit);
956 // we do not want the menu to end with a separator
958 && tomenu.items_.back().kind() == MenuItem::Separator)
959 tomenu.items_.pop_back();
961 // Check whether the shortcuts are unique
962 tomenu.checkShortcuts();
966 void MenuBackend::read(Lexer & lex)
975 struct keyword_item menutags[md_last - 1] = {
976 { "end", md_endmenuset },
978 { "menubar", md_menubar }
982 if (compare_ascii_no_case(lex.getString(), "menuset")) {
983 lyxerr << "Menubackend::read: ERROR wrong token:`"
984 << lex.getString() << '\'' << endl;
987 lex.pushTable(menutags, md_last - 1);
988 if (lyxerr.debugging(Debug::PARSER))
989 lex.printTable(lyxerr);
993 while (lex.isOK() && !quit) {
1000 docstring const name = lex.getDocString();
1001 if (hasMenu(name)) {
1002 getMenu(name).read(lex);
1014 lex.printError("menubackend::read: "
1015 "Unknown menu tag: `$$Token'");
1023 void MenuBackend::add(Menu const & menu)
1025 menulist_.push_back(menu);
1029 bool MenuBackend::hasMenu(docstring const & name) const
1031 return find_if(begin(), end(), MenuNamesEqual(name)) != end();
1035 Menu const & MenuBackend::getMenu(docstring const & name) const
1037 const_iterator cit = find_if(begin(), end(), MenuNamesEqual(name));
1039 lyxerr << "No submenu named " << to_utf8(name) << endl;
1040 BOOST_ASSERT(cit != end());
1045 Menu & MenuBackend::getMenu(docstring const & name)
1047 iterator it = find_if(begin(), end(), MenuNamesEqual(name));
1049 lyxerr << "No submenu named " << to_utf8(name) << endl;
1050 BOOST_ASSERT(it != end());
1055 Menu const & MenuBackend::getMenubar() const