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_no_case;
54 using support::compare_ascii_no_case;
55 using support::contains;
56 using support::makeDisplayPath;
58 using support::uppercase;
74 class MenuNamesEqual : public std::unary_function<Menu, bool> {
76 MenuNamesEqual(docstring const & name)
78 bool operator()(Menu const & menu) const
80 return menu.name() == name_;
89 // This is the global menu definition
90 MenuBackend menubackend;
93 MenuItem::MenuItem(Kind kind)
94 : kind_(kind), optional_(false)
98 MenuItem::MenuItem(Kind kind, docstring const & label,
99 docstring const & submenu, bool optional)
100 : kind_(kind), label_(label),
101 submenuname_(submenu), optional_(optional)
103 BOOST_ASSERT(kind == Submenu);
107 MenuItem::MenuItem(Kind kind, docstring const & label,
108 FuncRequest const & func, bool optional)
109 : kind_(kind), label_(label), func_(func), optional_(optional)
111 func_.origin = FuncRequest::MENU;
115 MenuItem::~MenuItem()
119 void MenuItem::submenu(Menu * menu)
121 submenu_.reset(menu);
125 docstring const MenuItem::label() const
127 return token(label_, char_type('|'), 0);
131 docstring const MenuItem::shortcut() const
133 return token(label_, char_type('|'), 1);
137 docstring const MenuItem::binding() const
139 if (kind_ != Command)
142 // Get the keys bound to this action, but keep only the
144 kb_keymap::Bindings bindings = theTopLevelKeymap().findbindings(func_);
146 if (bindings.size()) {
147 return bindings.begin()->print();
151 << lyxaction.getActionName(func_.action)
152 << '(' << to_utf8(func_.argument()) << ')' << endl;
159 Menu & Menu::add(MenuItem const & i)
166 Menu & Menu::addWithStatusCheck(MenuItem const & i)
170 case MenuItem::Command: {
171 FuncStatus status = lyx::getStatus(i.func());
172 if (status.unknown() || (!status.enabled() && i.optional()))
175 items_.back().status(status);
179 case MenuItem::Submenu: {
181 bool enabled = false;
182 for (const_iterator cit = i.submenu()->begin();
183 cit != i.submenu()->end(); ++cit) {
184 if ((cit->kind() == MenuItem::Command
185 || cit->kind() == MenuItem::Submenu)
186 && cit->status().enabled()) {
191 if (enabled || !i.optional()) {
193 items_.back().status().enabled(enabled);
201 case MenuItem::Separator:
203 && items_.back().kind() != MenuItem::Separator)
215 Menu & Menu::read(LyXLex & lex)
241 struct keyword_item menutags[md_last - 1] = {
242 { "bookmarks", md_bookmarks },
243 { "branches", md_branches },
244 { "charstyles", md_charstyles },
245 { "documents", md_documents },
246 { "end", md_endmenu },
247 { "exportformats", md_exportformats },
248 { "floatinsert", md_floatinsert },
249 { "floatlistinsert", md_floatlistinsert },
250 { "importformats", md_importformats },
252 { "lastfiles", md_lastfiles },
253 { "optitem", md_optitem },
254 { "optsubmenu", md_optsubmenu },
255 { "pasterecent", md_pasterecent },
256 { "separator", md_separator },
257 { "submenu", md_submenu },
259 { "toolbars", md_toolbars },
260 { "updateformats", md_updateformats },
261 { "viewformats", md_viewformats }
264 lex.pushTable(menutags, md_last - 1);
265 if (lyxerr.debugging(Debug::PARSER))
266 lex.printTable(lyxerr);
269 bool optional = false;
271 while (lex.isOK() && !quit) {
275 // fallback to md_item
278 docstring const name = translateIfPossible(lex.getDocString());
280 string const command = lex.getString();
281 FuncRequest func = lyxaction.lookupFunc(command);
282 add(MenuItem(MenuItem::Command, name, func, optional));
288 add(MenuItem(MenuItem::Separator));
292 add(MenuItem(MenuItem::Lastfiles));
296 add(MenuItem(MenuItem::CharStyles));
300 add(MenuItem(MenuItem::Documents));
304 add(MenuItem(MenuItem::Bookmarks));
308 add(MenuItem(MenuItem::Toc));
312 add(MenuItem(MenuItem::ViewFormats));
315 case md_updateformats:
316 add(MenuItem(MenuItem::UpdateFormats));
319 case md_exportformats:
320 add(MenuItem(MenuItem::ExportFormats));
323 case md_importformats:
324 add(MenuItem(MenuItem::ImportFormats));
327 case md_floatlistinsert:
328 add(MenuItem(MenuItem::FloatListInsert));
332 add(MenuItem(MenuItem::FloatInsert));
336 add(MenuItem(MenuItem::PasteRecent));
340 add(MenuItem(MenuItem::Toolbars));
344 add(MenuItem(MenuItem::Branches));
349 // fallback to md_submenu
352 docstring const mlabel = translateIfPossible(lex.getDocString());
354 docstring const mname = lex.getDocString();
355 add(MenuItem(MenuItem::Submenu, mlabel, mname,
366 lex.printError("Menu::read: "
367 "Unknown menu tag: `$$Token'");
376 MenuItem const & Menu::operator[](size_type i) const
382 bool Menu::hasFunc(FuncRequest const & func) const
384 return find_if(begin(), end(),
385 bind(std::equal_to<FuncRequest>(),
386 bind(&MenuItem::func, _1),
390 void Menu::checkShortcuts() const
392 // This is a quadratic algorithm, but we do not care because
393 // menus are short enough
394 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
395 docstring shortcut = it1->shortcut();
396 if (shortcut.empty())
398 if (!contains(it1->label(), shortcut))
399 lyxerr << "Menu warning: menu entry \""
400 << to_utf8(it1->label())
401 << "\" does not contain shortcut `"
402 << to_utf8(shortcut) << "'." << endl;
403 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
404 if (!compare_no_case(it2->shortcut(), shortcut)) {
405 lyxerr << "Menu warning: menu entries "
406 << '"' << to_utf8(it1->fulllabel())
407 << "\" and \"" << to_utf8(it2->fulllabel())
408 << "\" share the same shortcut."
416 void MenuBackend::specialMenu(Menu const & menu)
424 class compare_format {
426 bool operator()(Format const * p1, Format const * p2) {
431 docstring const limit_string_length(docstring const & str)
433 docstring::size_type const max_item_length = 45;
435 if (str.size() > max_item_length)
436 return str.substr(0, max_item_length - 3) + "...";
442 void expandLastfiles(Menu & tomenu)
444 lyx::LastFilesSection::LastFiles const & lf = LyX::cref().session().lastFiles().lastFiles();
445 lyx::LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
449 for (; lfit != lf.end() && ii < 10; ++lfit, ++ii) {
450 string const file = lfit->absFilename();
451 docstring const label = convert<docstring>(ii) + ". "
452 + makeDisplayPath(file, 30)
453 + char_type('|') + convert<docstring>(ii);
454 tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, file)));
459 void expandDocuments(Menu & tomenu)
461 typedef vector<string> Strings;
462 Strings const names = theBufferList().getFileNames();
465 tomenu.add(MenuItem(MenuItem::Command, _("No Documents Open!"),
466 FuncRequest(LFUN_NOACTION)));
471 Strings::const_iterator docit = names.begin();
472 Strings::const_iterator end = names.end();
473 for (; docit != end; ++docit, ++ii) {
474 docstring label = makeDisplayPath(*docit, 20);
476 label = convert<docstring>(ii) + ". " + label + char_type('|') + convert<docstring>(ii);
477 tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_BUFFER_SWITCH, *docit)));
482 void expandBookmarks(Menu & tomenu)
484 lyx::BookmarksSection const & bm = LyX::cref().session().bookmarks();
486 for (size_t i = 1; i <= bm.size(); ++i) {
488 docstring const label = convert<docstring>(i) + ". "
489 + makeDisplayPath(bm.bookmark(i).filename.absFilename(), 20)
490 + char_type('|') + convert<docstring>(i);
491 tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_BOOKMARK_GOTO,
492 convert<docstring>(i))));
498 void expandFormats(MenuItem::Kind kind, Menu & tomenu, Buffer const * buf)
500 if (!buf && kind != MenuItem::ImportFormats) {
501 tomenu.add(MenuItem(MenuItem::Command,
502 _("No Documents Open!"),
503 FuncRequest(LFUN_NOACTION)));
507 typedef vector<Format const *> Formats;
512 case MenuItem::ImportFormats:
513 formats = Importer::GetImportableFormats();
514 action = LFUN_BUFFER_IMPORT;
516 case MenuItem::ViewFormats:
517 formats = Exporter::getExportableFormats(*buf, true);
518 action = LFUN_BUFFER_VIEW;
520 case MenuItem::UpdateFormats:
521 formats = Exporter::getExportableFormats(*buf, true);
522 action = LFUN_BUFFER_UPDATE;
525 formats = Exporter::getExportableFormats(*buf, false);
526 action = LFUN_BUFFER_EXPORT;
528 sort(formats.begin(), formats.end(), compare_format());
530 Formats::const_iterator fit = formats.begin();
531 Formats::const_iterator end = formats.end();
532 for (; fit != end ; ++fit) {
535 docstring label = from_utf8((*fit)->prettyname());
538 case MenuItem::ImportFormats:
539 if ((*fit)->name() == "text")
540 label = _("Plain Text as Lines");
541 else if ((*fit)->name() == "textparagraph")
542 label = _("Plain Text as Paragraphs");
545 case MenuItem::ViewFormats:
546 case MenuItem::ExportFormats:
547 case MenuItem::UpdateFormats:
548 if (!(*fit)->documentFormat())
555 if (!(*fit)->shortcut().empty())
556 label += char_type('|') + from_utf8((*fit)->shortcut());
559 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
560 FuncRequest(action, (*fit)->name())));
562 tomenu.add(MenuItem(MenuItem::Command, label,
563 FuncRequest(action, (*fit)->name())));
568 void expandFloatListInsert(Menu & tomenu, Buffer const * buf)
571 tomenu.add(MenuItem(MenuItem::Command,
572 _("No Documents Open!"),
573 FuncRequest(LFUN_NOACTION)));
577 FloatList const & floats =
578 buf->params().getLyXTextClass().floats();
579 FloatList::const_iterator cit = floats.begin();
580 FloatList::const_iterator end = floats.end();
581 for (; cit != end; ++cit) {
582 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command,
583 _(cit->second.listName()),
584 FuncRequest(LFUN_FLOAT_LIST,
585 cit->second.type())));
590 void expandFloatInsert(Menu & tomenu, Buffer const * buf)
593 tomenu.add(MenuItem(MenuItem::Command,
594 _("No Documents Open!"),
595 FuncRequest(LFUN_NOACTION)));
599 FloatList const & floats =
600 buf->params().getLyXTextClass().floats();
601 FloatList::const_iterator cit = floats.begin();
602 FloatList::const_iterator end = floats.end();
603 for (; cit != end; ++cit) {
605 docstring const label = _(cit->second.name());
606 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
607 FuncRequest(LFUN_FLOAT_INSERT,
608 cit->second.type())));
613 void expandCharStyleInsert(Menu & tomenu, Buffer const * buf)
616 tomenu.add(MenuItem(MenuItem::Command,
617 _("No Documents Open!"),
618 FuncRequest(LFUN_NOACTION)));
621 CharStyles & charstyles =
622 buf->params().getLyXTextClass().charstyles();
623 CharStyles::iterator cit = charstyles.begin();
624 CharStyles::iterator end = charstyles.end();
625 for (; cit != end; ++cit) {
626 docstring const label = from_utf8(cit->name);
627 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
628 FuncRequest(LFUN_CHARSTYLE_INSERT,
634 Menu::size_type const max_number_of_items = 25;
636 void expandToc2(Menu & tomenu,
637 Toc const & toc_list,
639 Toc::size_type to, int depth)
641 int shortcut_count = 0;
643 // check whether depth is smaller than the smallest depth in toc.
644 int min_depth = 1000;
645 for (Toc::size_type i = from; i < to; ++i)
646 min_depth = std::min(min_depth, toc_list[i].depth());
647 if (min_depth > depth)
651 if (to - from <= max_number_of_items) {
652 for (Toc::size_type i = from; i < to; ++i) {
653 docstring label(4 * max(0, toc_list[i].depth() - depth), char_type(' '));
654 label += limit_string_length(toc_list[i].str());
655 if (toc_list[i].depth() == depth
656 && shortcut_count < 9) {
657 if (label.find(convert<docstring>(shortcut_count + 1)) != docstring::npos)
658 label += char_type('|') + convert<docstring>(++shortcut_count);
660 tomenu.add(MenuItem(MenuItem::Command, label,
661 FuncRequest(toc_list[i].action())));
664 Toc::size_type pos = from;
666 Toc::size_type new_pos = pos + 1;
667 while (new_pos < to &&
668 toc_list[new_pos].depth() > depth)
671 docstring label(4 * max(0, toc_list[pos].depth() - depth), ' ');
672 label += limit_string_length(toc_list[pos].str());
673 if (toc_list[pos].depth() == depth &&
674 shortcut_count < 9) {
675 if (label.find(convert<docstring>(shortcut_count + 1)) != docstring::npos)
676 label += char_type('|') + convert<docstring>(++shortcut_count);
678 if (new_pos == pos + 1) {
679 tomenu.add(MenuItem(MenuItem::Command,
680 label, FuncRequest(toc_list[pos].action())));
682 MenuItem item(MenuItem::Submenu, label);
683 item.submenu(new Menu);
684 expandToc2(*item.submenu(),
685 toc_list, pos, new_pos, depth + 1);
694 void expandToc(Menu & tomenu, Buffer const * buf)
696 // To make things very cleanly, we would have to pass buf to
697 // all MenuItem constructors and to expandToc2. However, we
698 // know that all the entries in a TOC will be have status_ ==
699 // OK, so we avoid this unnecessary overhead (JMarc)
702 tomenu.add(MenuItem(MenuItem::Command,
703 _("No Documents Open!"),
704 FuncRequest(LFUN_NOACTION)));
708 // Add an entry for the master doc if this is a child doc
709 Buffer const * const master = buf->getMasterBuffer();
711 ParIterator const pit = par_iterator_begin(master->inset());
712 string const arg = convert<string>(pit->id());
713 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
714 tomenu.add(MenuItem(MenuItem::Command, _("Master Document"), f));
717 FloatList const & floatlist = buf->params().getLyXTextClass().floats();
718 TocList const & toc_list = buf->tocBackend().tocs();
719 TocList::const_iterator cit = toc_list.begin();
720 TocList::const_iterator end = toc_list.end();
721 for (; cit != end; ++cit) {
723 if (cit->first == "tableofcontents")
726 // All the rest is for floats
727 auto_ptr<Menu> menu(new Menu);
728 TocIterator ccit = cit->second.begin();
729 TocIterator eend = cit->second.end();
730 for (; ccit != eend; ++ccit) {
731 docstring const label = limit_string_length(ccit->str());
732 menu->add(MenuItem(MenuItem::Command,
734 FuncRequest(ccit->action())));
736 string const & floatName = floatlist.getType(cit->first).listName();
737 MenuItem item(MenuItem::Submenu, _(floatName));
738 item.submenu(menu.release());
743 cit = toc_list.find("tableofcontents");
745 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command,
746 _("No Table of contents"),
749 expandToc2(tomenu, cit->second, 0, cit->second.size(), 0);
754 void expandPasteRecent(Menu & tomenu, Buffer const * buf)
759 vector<docstring> const sel =
760 cap::availableSelections(*buf);
762 vector<docstring>::const_iterator cit = sel.begin();
763 vector<docstring>::const_iterator end = sel.end();
765 for (unsigned int index = 0; cit != end; ++cit, ++index) {
766 tomenu.add(MenuItem(MenuItem::Command, *cit,
767 FuncRequest(LFUN_PASTE, convert<string>(index))));
772 void expandToolbars(Menu & tomenu)
775 // extracts the toolbars from the backend
776 ToolbarBackend::Toolbars::const_iterator cit = toolbarbackend.begin();
777 ToolbarBackend::Toolbars::const_iterator end = toolbarbackend.end();
779 for (; cit != end; ++cit) {
780 docstring label = _(cit->gui_name);
781 // frontends are not supposed to turn on/off toolbars, if they cannot
782 // update ToolbarBackend::flags. That is to say, ToolbarsBackend::flags
783 // should reflect the true state of toolbars.
785 // menu is displayed as
789 // in the case of auto.
790 if (cit->flags & ToolbarBackend::AUTO)
791 label += _(" (auto)");
792 tomenu.add(MenuItem(MenuItem::Command, label,
793 FuncRequest(LFUN_TOOLBAR_TOGGLE_STATE, cit->name)));
798 void expandBranches(Menu & tomenu, Buffer const * buf)
803 BufferParams const & params = buf->getMasterBuffer()->params();
805 BranchList::const_iterator cit = params.branchlist().begin();
806 BranchList::const_iterator end = params.branchlist().end();
808 for (int ii = 1; cit != end; ++cit, ++ii) {
809 docstring label = cit->getBranch();
811 label = convert<docstring>(ii) + ". " + label + char_type('|') + convert<docstring>(ii);
812 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
813 FuncRequest(LFUN_BRANCH_INSERT,
822 void MenuBackend::expand(Menu const & frommenu, Menu & tomenu,
823 Buffer const * buf) const
828 for (Menu::const_iterator cit = frommenu.begin();
829 cit != frommenu.end() ; ++cit) {
830 switch (cit->kind()) {
831 case MenuItem::Lastfiles:
832 expandLastfiles(tomenu);
835 case MenuItem::Documents:
836 expandDocuments(tomenu);
839 case MenuItem::Bookmarks:
840 expandBookmarks(tomenu);
843 case MenuItem::ImportFormats:
844 case MenuItem::ViewFormats:
845 case MenuItem::UpdateFormats:
846 case MenuItem::ExportFormats:
847 expandFormats(cit->kind(), tomenu, buf);
850 case MenuItem::CharStyles:
851 expandCharStyleInsert(tomenu, buf);
854 case MenuItem::FloatListInsert:
855 expandFloatListInsert(tomenu, buf);
858 case MenuItem::FloatInsert:
859 expandFloatInsert(tomenu, buf);
862 case MenuItem::PasteRecent:
863 expandPasteRecent(tomenu, buf);
866 case MenuItem::Toolbars:
867 expandToolbars(tomenu);
870 case MenuItem::Branches:
871 expandBranches(tomenu, buf);
875 expandToc(tomenu, buf);
878 case MenuItem::Submenu: {
880 item.submenu(new Menu(cit->submenuname()));
881 expand(getMenu(cit->submenuname()),
882 *item.submenu(), buf);
883 tomenu.addWithStatusCheck(item);
887 case MenuItem::Separator:
888 tomenu.addWithStatusCheck(*cit);
891 case MenuItem::Command:
892 if (!specialmenu_.hasFunc(cit->func()))
893 tomenu.addWithStatusCheck(*cit);
897 // we do not want the menu to end with a separator
899 && tomenu.items_.back().kind() == MenuItem::Separator)
900 tomenu.items_.pop_back();
902 // Check whether the shortcuts are unique
903 tomenu.checkShortcuts();
907 void MenuBackend::read(LyXLex & lex)
916 struct keyword_item menutags[md_last - 1] = {
917 { "end", md_endmenuset },
919 { "menubar", md_menubar }
923 if (compare_ascii_no_case(lex.getString(), "menuset")) {
924 lyxerr << "Menubackend::read: ERROR wrong token:`"
925 << lex.getString() << '\'' << endl;
928 lex.pushTable(menutags, md_last - 1);
929 if (lyxerr.debugging(Debug::PARSER))
930 lex.printTable(lyxerr);
934 while (lex.isOK() && !quit) {
941 docstring const name = lex.getDocString();
943 getMenu(name).read(lex);
955 lex.printError("menubackend::read: "
956 "Unknown menu tag: `$$Token'");
964 void MenuBackend::add(Menu const & menu)
966 menulist_.push_back(menu);
970 bool MenuBackend::hasMenu(docstring const & name) const
972 return find_if(begin(), end(), MenuNamesEqual(name)) != end();
976 Menu const & MenuBackend::getMenu(docstring const & name) const
978 const_iterator cit = find_if(begin(), end(), MenuNamesEqual(name));
980 lyxerr << "No submenu named " << to_utf8(name) << endl;
981 BOOST_ASSERT(cit != end());
986 Menu & MenuBackend::getMenu(docstring const & name)
988 iterator it = find_if(begin(), end(), MenuNamesEqual(name));
990 lyxerr << "No submenu named " << to_utf8(name) << endl;
991 BOOST_ASSERT(it != end());
996 Menu const & MenuBackend::getMenubar() const