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 "CutAndPaste.h"
28 #include "FloatList.h"
34 #include "LyXAction.h"
35 #include "lyx_main.h" // for lastfiles
38 #include "paragraph.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>
53 using support::compare_ascii_no_case;
54 using support::contains;
55 using support::makeDisplayPath;
57 using support::uppercase;
73 class MenuNamesEqual : public std::unary_function<Menu, bool> {
75 MenuNamesEqual(docstring const & name)
77 bool operator()(Menu const & menu) const
79 return menu.name() == name_;
88 // This is the global menu definition
89 MenuBackend menubackend;
92 MenuItem::MenuItem(Kind kind)
93 : kind_(kind), optional_(false)
97 MenuItem::MenuItem(Kind kind, docstring const & label,
98 docstring const & submenu, bool optional)
99 : kind_(kind), label_(label),
100 submenuname_(submenu), optional_(optional)
102 BOOST_ASSERT(kind == Submenu);
106 MenuItem::MenuItem(Kind kind, docstring const & label,
107 FuncRequest const & func, bool optional)
108 : kind_(kind), label_(label), func_(func), optional_(optional)
110 func_.origin = FuncRequest::MENU;
114 MenuItem::~MenuItem()
118 void MenuItem::submenu(Menu * menu)
120 submenu_.reset(menu);
124 docstring const MenuItem::label() const
126 return token(label_, char_type('|'), 0);
130 docstring const MenuItem::shortcut() const
132 return token(label_, char_type('|'), 1);
136 docstring const MenuItem::binding(bool forgui) const
138 if (kind_ != Command)
141 // Get the keys bound to this action, but keep only the
143 kb_keymap::Bindings bindings = theTopLevelKeymap().findbindings(func_);
145 if (bindings.size()) {
146 return bindings.begin()->print(forgui);
150 << lyxaction.getActionName(func_.action)
151 << '(' << to_utf8(func_.argument()) << ')' << endl;
158 Menu & Menu::add(MenuItem const & i)
165 Menu & Menu::addWithStatusCheck(MenuItem const & i)
169 case MenuItem::Command: {
170 FuncStatus status = lyx::getStatus(i.func());
171 if (status.unknown() || (!status.enabled() && i.optional()))
174 items_.back().status(status);
178 case MenuItem::Submenu: {
180 bool enabled = false;
181 for (const_iterator cit = i.submenu()->begin();
182 cit != i.submenu()->end(); ++cit) {
183 if ((cit->kind() == MenuItem::Command
184 || cit->kind() == MenuItem::Submenu)
185 && cit->status().enabled()) {
190 if (enabled || !i.optional()) {
192 items_.back().status().enabled(enabled);
200 case MenuItem::Separator:
202 && items_.back().kind() != MenuItem::Separator)
214 Menu & Menu::read(LyXLex & lex)
240 struct keyword_item menutags[md_last - 1] = {
241 { "bookmarks", md_bookmarks },
242 { "branches", md_branches },
243 { "charstyles", md_charstyles },
244 { "documents", md_documents },
245 { "end", md_endmenu },
246 { "exportformats", md_exportformats },
247 { "floatinsert", md_floatinsert },
248 { "floatlistinsert", md_floatlistinsert },
249 { "importformats", md_importformats },
251 { "lastfiles", md_lastfiles },
252 { "optitem", md_optitem },
253 { "optsubmenu", md_optsubmenu },
254 { "pasterecent", md_pasterecent },
255 { "separator", md_separator },
256 { "submenu", md_submenu },
258 { "toolbars", md_toolbars },
259 { "updateformats", md_updateformats },
260 { "viewformats", md_viewformats }
263 lex.pushTable(menutags, md_last - 1);
264 if (lyxerr.debugging(Debug::PARSER))
265 lex.printTable(lyxerr);
268 bool optional = false;
270 while (lex.isOK() && !quit) {
274 // fallback to md_item
277 docstring const name = translateIfPossible(lex.getDocString());
279 string const command = lex.getString();
280 FuncRequest func = lyxaction.lookupFunc(command);
281 add(MenuItem(MenuItem::Command, name, func, optional));
287 add(MenuItem(MenuItem::Separator));
291 add(MenuItem(MenuItem::Lastfiles));
295 add(MenuItem(MenuItem::CharStyles));
299 add(MenuItem(MenuItem::Documents));
303 add(MenuItem(MenuItem::Bookmarks));
307 add(MenuItem(MenuItem::Toc));
311 add(MenuItem(MenuItem::ViewFormats));
314 case md_updateformats:
315 add(MenuItem(MenuItem::UpdateFormats));
318 case md_exportformats:
319 add(MenuItem(MenuItem::ExportFormats));
322 case md_importformats:
323 add(MenuItem(MenuItem::ImportFormats));
326 case md_floatlistinsert:
327 add(MenuItem(MenuItem::FloatListInsert));
331 add(MenuItem(MenuItem::FloatInsert));
335 add(MenuItem(MenuItem::PasteRecent));
339 add(MenuItem(MenuItem::Toolbars));
343 add(MenuItem(MenuItem::Branches));
348 // fallback to md_submenu
351 docstring const mlabel = translateIfPossible(lex.getDocString());
353 docstring const mname = lex.getDocString();
354 add(MenuItem(MenuItem::Submenu, mlabel, mname,
365 lex.printError("Menu::read: "
366 "Unknown menu tag: `$$Token'");
375 MenuItem const & Menu::operator[](size_type i) const
381 bool Menu::hasFunc(FuncRequest const & func) const
383 return find_if(begin(), end(),
384 bind(std::equal_to<FuncRequest>(),
385 bind(&MenuItem::func, _1),
389 void Menu::checkShortcuts() const
391 // This is a quadratic algorithm, but we do not care because
392 // menus are short enough
393 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
394 docstring shortcut = it1->shortcut();
395 if (shortcut.empty())
397 if (!contains(it1->label(), shortcut))
398 lyxerr << "Menu warning: menu entry \""
399 << to_utf8(it1->label())
400 << "\" does not contain shortcut `"
401 << to_utf8(shortcut) << "'." << endl;
402 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
403 if (!compare_ascii_no_case(it2->shortcut(), shortcut)) {
404 lyxerr << "Menu warning: menu entries "
405 << '"' << to_utf8(it1->fulllabel())
406 << "\" and \"" << to_utf8(it2->fulllabel())
407 << "\" share the same shortcut."
415 void MenuBackend::specialMenu(Menu const & menu)
423 class compare_format {
425 bool operator()(Format const * p1, Format const * p2) {
430 docstring const limit_string_length(docstring const & str)
432 docstring::size_type const max_item_length = 45;
434 if (str.size() > max_item_length)
435 return str.substr(0, max_item_length - 3) + "...";
441 void expandLastfiles(Menu & tomenu)
443 lyx::LastFilesSection::LastFiles const & lf = LyX::cref().session().lastFiles().lastFiles();
444 lyx::LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
448 for (; lfit != lf.end() && ii < 10; ++lfit, ++ii) {
449 string const file = lfit->absFilename();
450 docstring const label = convert<docstring>(ii) + ". "
451 + makeDisplayPath(file, 30)
452 + char_type('|') + convert<docstring>(ii);
453 tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, file)));
458 void expandDocuments(Menu & tomenu)
460 typedef vector<string> Strings;
461 Strings const names = theBufferList().getFileNames();
464 tomenu.add(MenuItem(MenuItem::Command, _("No Documents Open!"),
465 FuncRequest(LFUN_NOACTION)));
470 Strings::const_iterator docit = names.begin();
471 Strings::const_iterator end = names.end();
472 for (; docit != end; ++docit, ++ii) {
473 docstring label = makeDisplayPath(*docit, 20);
475 label = convert<docstring>(ii) + ". " + label + char_type('|') + convert<docstring>(ii);
476 tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_BUFFER_SWITCH, *docit)));
481 void expandBookmarks(Menu & tomenu)
483 lyx::BookmarksSection const & bm = LyX::cref().session().bookmarks();
485 for (size_t i = 1; i <= bm.size(); ++i) {
487 docstring const label = convert<docstring>(i) + ". "
488 + makeDisplayPath(bm.bookmark(i).filename.absFilename(), 20)
489 + char_type('|') + convert<docstring>(i);
490 tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_BOOKMARK_GOTO,
491 convert<docstring>(i))));
497 void expandFormats(MenuItem::Kind kind, Menu & tomenu, Buffer const * buf)
499 if (!buf && kind != MenuItem::ImportFormats) {
500 tomenu.add(MenuItem(MenuItem::Command,
501 _("No Documents Open!"),
502 FuncRequest(LFUN_NOACTION)));
506 typedef vector<Format const *> Formats;
511 case MenuItem::ImportFormats:
512 formats = Importer::GetImportableFormats();
513 action = LFUN_BUFFER_IMPORT;
515 case MenuItem::ViewFormats:
516 formats = Exporter::getExportableFormats(*buf, true);
517 action = LFUN_BUFFER_VIEW;
519 case MenuItem::UpdateFormats:
520 formats = Exporter::getExportableFormats(*buf, true);
521 action = LFUN_BUFFER_UPDATE;
524 formats = Exporter::getExportableFormats(*buf, false);
525 action = LFUN_BUFFER_EXPORT;
527 sort(formats.begin(), formats.end(), compare_format());
529 Formats::const_iterator fit = formats.begin();
530 Formats::const_iterator end = formats.end();
531 for (; fit != end ; ++fit) {
534 docstring label = from_utf8((*fit)->prettyname());
537 case MenuItem::ImportFormats:
538 // FIXME: This is a hack, we should rather solve
539 // FIXME: bug 2488 instead.
540 if ((*fit)->name() == "text")
541 label = _("Plain Text");
542 else if ((*fit)->name() == "textparagraph")
543 label = _("Plain Text, Join Lines");
546 case MenuItem::ViewFormats:
547 case MenuItem::ExportFormats:
548 case MenuItem::UpdateFormats:
549 if (!(*fit)->documentFormat())
556 if (!(*fit)->shortcut().empty())
557 label += char_type('|') + from_utf8((*fit)->shortcut());
560 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
561 FuncRequest(action, (*fit)->name())));
563 tomenu.add(MenuItem(MenuItem::Command, label,
564 FuncRequest(action, (*fit)->name())));
569 void expandFloatListInsert(Menu & tomenu, Buffer const * buf)
572 tomenu.add(MenuItem(MenuItem::Command,
573 _("No Documents Open!"),
574 FuncRequest(LFUN_NOACTION)));
578 FloatList const & floats =
579 buf->params().getLyXTextClass().floats();
580 FloatList::const_iterator cit = floats.begin();
581 FloatList::const_iterator end = floats.end();
582 for (; cit != end; ++cit) {
583 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command,
584 _(cit->second.listName()),
585 FuncRequest(LFUN_FLOAT_LIST,
586 cit->second.type())));
591 void expandFloatInsert(Menu & tomenu, Buffer const * buf)
594 tomenu.add(MenuItem(MenuItem::Command,
595 _("No Documents Open!"),
596 FuncRequest(LFUN_NOACTION)));
600 FloatList const & floats =
601 buf->params().getLyXTextClass().floats();
602 FloatList::const_iterator cit = floats.begin();
603 FloatList::const_iterator end = floats.end();
604 for (; cit != end; ++cit) {
606 docstring const label = _(cit->second.name());
607 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
608 FuncRequest(LFUN_FLOAT_INSERT,
609 cit->second.type())));
614 void expandCharStyleInsert(Menu & tomenu, Buffer const * buf)
617 tomenu.add(MenuItem(MenuItem::Command,
618 _("No Documents Open!"),
619 FuncRequest(LFUN_NOACTION)));
622 CharStyles & charstyles =
623 buf->params().getLyXTextClass().charstyles();
624 CharStyles::iterator cit = charstyles.begin();
625 CharStyles::iterator end = charstyles.end();
626 for (; cit != end; ++cit) {
627 docstring const label = from_utf8(cit->name);
628 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
629 FuncRequest(LFUN_CHARSTYLE_INSERT,
635 Menu::size_type const max_number_of_items = 25;
637 void expandToc2(Menu & tomenu,
638 Toc const & toc_list,
640 Toc::size_type to, int depth)
642 int shortcut_count = 0;
644 // check whether depth is smaller than the smallest depth in toc.
645 int min_depth = 1000;
646 for (Toc::size_type i = from; i < to; ++i)
647 min_depth = std::min(min_depth, toc_list[i].depth());
648 if (min_depth > depth)
652 if (to - from <= max_number_of_items) {
653 for (Toc::size_type i = from; i < to; ++i) {
654 docstring label(4 * max(0, toc_list[i].depth() - depth), char_type(' '));
655 label += limit_string_length(toc_list[i].str());
656 if (toc_list[i].depth() == depth
657 && shortcut_count < 9) {
658 if (label.find(convert<docstring>(shortcut_count + 1)) != docstring::npos)
659 label += char_type('|') + convert<docstring>(++shortcut_count);
661 tomenu.add(MenuItem(MenuItem::Command, label,
662 FuncRequest(toc_list[i].action())));
665 Toc::size_type pos = from;
667 Toc::size_type new_pos = pos + 1;
668 while (new_pos < to &&
669 toc_list[new_pos].depth() > depth)
672 docstring label(4 * max(0, toc_list[pos].depth() - depth), ' ');
673 label += limit_string_length(toc_list[pos].str());
674 if (toc_list[pos].depth() == depth &&
675 shortcut_count < 9) {
676 if (label.find(convert<docstring>(shortcut_count + 1)) != docstring::npos)
677 label += char_type('|') + convert<docstring>(++shortcut_count);
679 if (new_pos == pos + 1) {
680 tomenu.add(MenuItem(MenuItem::Command,
681 label, FuncRequest(toc_list[pos].action())));
683 MenuItem item(MenuItem::Submenu, label);
684 item.submenu(new Menu);
685 expandToc2(*item.submenu(),
686 toc_list, pos, new_pos, depth + 1);
695 void expandToc(Menu & tomenu, Buffer const * buf)
697 // To make things very cleanly, we would have to pass buf to
698 // all MenuItem constructors and to expandToc2. However, we
699 // know that all the entries in a TOC will be have status_ ==
700 // OK, so we avoid this unnecessary overhead (JMarc)
703 tomenu.add(MenuItem(MenuItem::Command,
704 _("No Documents Open!"),
705 FuncRequest(LFUN_NOACTION)));
709 // Add an entry for the master doc if this is a child doc
710 Buffer const * const master = buf->getMasterBuffer();
712 ParIterator const pit = par_iterator_begin(master->inset());
713 string const arg = convert<string>(pit->id());
714 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
715 tomenu.add(MenuItem(MenuItem::Command, _("Master Document"), f));
718 FloatList const & floatlist = buf->params().getLyXTextClass().floats();
719 TocList const & toc_list = buf->tocBackend().tocs();
720 TocList::const_iterator cit = toc_list.begin();
721 TocList::const_iterator end = toc_list.end();
722 for (; cit != end; ++cit) {
724 if (cit->first == "tableofcontents")
727 // All the rest is for floats
728 auto_ptr<Menu> menu(new Menu);
729 TocIterator ccit = cit->second.begin();
730 TocIterator eend = cit->second.end();
731 for (; ccit != eend; ++ccit) {
732 docstring const label = limit_string_length(ccit->str());
733 menu->add(MenuItem(MenuItem::Command,
735 FuncRequest(ccit->action())));
737 string const & floatName = floatlist.getType(cit->first).listName();
738 MenuItem item(MenuItem::Submenu, _(floatName));
739 item.submenu(menu.release());
744 cit = toc_list.find("tableofcontents");
746 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command,
747 _("No Table of contents"),
750 expandToc2(tomenu, cit->second, 0, cit->second.size(), 0);
755 void expandPasteRecent(Menu & tomenu, Buffer const * buf)
760 vector<docstring> const sel =
761 cap::availableSelections(*buf);
763 vector<docstring>::const_iterator cit = sel.begin();
764 vector<docstring>::const_iterator end = sel.end();
766 for (unsigned int index = 0; cit != end; ++cit, ++index) {
767 tomenu.add(MenuItem(MenuItem::Command, *cit,
768 FuncRequest(LFUN_PASTE, convert<string>(index))));
773 void expandToolbars(Menu & tomenu)
776 // extracts the toolbars from the backend
777 ToolbarBackend::Toolbars::const_iterator cit = toolbarbackend.begin();
778 ToolbarBackend::Toolbars::const_iterator end = toolbarbackend.end();
780 for (; cit != end; ++cit) {
781 docstring label = _(cit->gui_name);
782 // frontends are not supposed to turn on/off toolbars, if they cannot
783 // update ToolbarBackend::flags. That is to say, ToolbarsBackend::flags
784 // should reflect the true state of toolbars.
786 // menu is displayed as
790 // in the case of auto.
791 if (cit->flags & ToolbarBackend::AUTO)
792 label += _(" (auto)");
793 tomenu.add(MenuItem(MenuItem::Command, label,
794 FuncRequest(LFUN_TOOLBAR_TOGGLE_STATE, cit->name)));
799 void expandBranches(Menu & tomenu, Buffer const * buf)
804 BufferParams const & params = buf->getMasterBuffer()->params();
806 BranchList::const_iterator cit = params.branchlist().begin();
807 BranchList::const_iterator end = params.branchlist().end();
809 for (int ii = 1; cit != end; ++cit, ++ii) {
810 docstring label = cit->getBranch();
812 label = convert<docstring>(ii) + ". " + label + char_type('|') + convert<docstring>(ii);
813 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
814 FuncRequest(LFUN_BRANCH_INSERT,
823 void MenuBackend::expand(Menu const & frommenu, Menu & tomenu,
824 Buffer const * buf) const
829 for (Menu::const_iterator cit = frommenu.begin();
830 cit != frommenu.end() ; ++cit) {
831 switch (cit->kind()) {
832 case MenuItem::Lastfiles:
833 expandLastfiles(tomenu);
836 case MenuItem::Documents:
837 expandDocuments(tomenu);
840 case MenuItem::Bookmarks:
841 expandBookmarks(tomenu);
844 case MenuItem::ImportFormats:
845 case MenuItem::ViewFormats:
846 case MenuItem::UpdateFormats:
847 case MenuItem::ExportFormats:
848 expandFormats(cit->kind(), tomenu, buf);
851 case MenuItem::CharStyles:
852 expandCharStyleInsert(tomenu, buf);
855 case MenuItem::FloatListInsert:
856 expandFloatListInsert(tomenu, buf);
859 case MenuItem::FloatInsert:
860 expandFloatInsert(tomenu, buf);
863 case MenuItem::PasteRecent:
864 expandPasteRecent(tomenu, buf);
867 case MenuItem::Toolbars:
868 expandToolbars(tomenu);
871 case MenuItem::Branches:
872 expandBranches(tomenu, buf);
876 expandToc(tomenu, buf);
879 case MenuItem::Submenu: {
881 item.submenu(new Menu(cit->submenuname()));
882 expand(getMenu(cit->submenuname()),
883 *item.submenu(), buf);
884 tomenu.addWithStatusCheck(item);
888 case MenuItem::Separator:
889 tomenu.addWithStatusCheck(*cit);
892 case MenuItem::Command:
893 if (!specialmenu_.hasFunc(cit->func()))
894 tomenu.addWithStatusCheck(*cit);
898 // we do not want the menu to end with a separator
900 && tomenu.items_.back().kind() == MenuItem::Separator)
901 tomenu.items_.pop_back();
903 // Check whether the shortcuts are unique
904 tomenu.checkShortcuts();
908 void MenuBackend::read(LyXLex & lex)
917 struct keyword_item menutags[md_last - 1] = {
918 { "end", md_endmenuset },
920 { "menubar", md_menubar }
924 if (compare_ascii_no_case(lex.getString(), "menuset")) {
925 lyxerr << "Menubackend::read: ERROR wrong token:`"
926 << lex.getString() << '\'' << endl;
929 lex.pushTable(menutags, md_last - 1);
930 if (lyxerr.debugging(Debug::PARSER))
931 lex.printTable(lyxerr);
935 while (lex.isOK() && !quit) {
942 docstring const name = lex.getDocString();
944 getMenu(name).read(lex);
956 lex.printError("menubackend::read: "
957 "Unknown menu tag: `$$Token'");
965 void MenuBackend::add(Menu const & menu)
967 menulist_.push_back(menu);
971 bool MenuBackend::hasMenu(docstring const & name) const
973 return find_if(begin(), end(), MenuNamesEqual(name)) != end();
977 Menu const & MenuBackend::getMenu(docstring const & name) const
979 const_iterator cit = find_if(begin(), end(), MenuNamesEqual(name));
981 lyxerr << "No submenu named " << to_utf8(name) << endl;
982 BOOST_ASSERT(cit != end());
987 Menu & MenuBackend::getMenu(docstring const & name)
989 iterator it = find_if(begin(), end(), MenuNamesEqual(name));
991 lyxerr << "No submenu named " << to_utf8(name) << endl;
992 BOOST_ASSERT(it != end());
997 Menu const & MenuBackend::getMenubar() const