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
40 #include "frontends/LyXView.h"
42 #include "support/filetools.h"
43 #include "support/lstrings.h"
44 #include "support/convert.h"
46 #include <boost/bind.hpp>
50 using lyx::support::compare_ascii_no_case;
51 using lyx::support::contains;
52 using lyx::support::makeDisplayPath;
53 using lyx::support::token;
67 extern BufferList bufferlist;
68 extern boost::scoped_ptr<kb_keymap> toplevel_keymap;
72 class MenuNamesEqual : public std::unary_function<Menu, bool> {
74 MenuNamesEqual(string const & name)
76 bool operator()(Menu const & menu) const
78 return menu.name() == name_;
87 // This is the global menu definition
88 MenuBackend menubackend;
91 MenuItem::MenuItem(Kind kind)
92 : kind_(kind), optional_(false)
96 MenuItem::MenuItem(Kind kind, string const & label,
97 string const & submenu, bool optional)
98 : kind_(kind), label_(label),
99 submenuname_(submenu), optional_(optional)
101 BOOST_ASSERT(kind == Submenu);
105 MenuItem::MenuItem(Kind kind, string const & label,
106 FuncRequest const & func, bool optional)
107 : kind_(kind), label_(label), func_(func), optional_(optional)
109 func_.origin = FuncRequest::UI;
113 MenuItem::~MenuItem()
117 void MenuItem::submenu(Menu * menu)
119 submenu_.reset(menu);
123 string const MenuItem::label() const
125 return token(label_, '|', 0);
129 string const MenuItem::shortcut() const
131 return token(label_, '|', 1);
135 string const MenuItem::binding() const
137 if (kind_ != Command)
140 // Get the keys bound to this action, but keep only the
142 kb_keymap::Bindings bindings = toplevel_keymap->findbindings(func_);
144 if (bindings.size()) {
145 return bindings.begin()->print();
149 << lyxaction.getActionName(func_.action)
150 << '(' << func_.argument << ')' << endl;
157 Menu & Menu::add(MenuItem const & i, LyXView const * view)
166 case MenuItem::Command: {
168 view->getLyXFunc().getStatus(i.func());
170 || (!status.enabled() && i.optional()))
173 items_.back().status(status);
177 case MenuItem::Submenu: {
179 bool enabled = false;
180 for (const_iterator cit = i.submenu()->begin();
181 cit != i.submenu()->end(); ++cit) {
182 if ((cit->kind() == MenuItem::Command
183 || cit->kind() == MenuItem::Submenu)
184 && cit->status().enabled()) {
189 if (enabled || !i.optional()) {
191 items_.back().status().enabled(enabled);
199 case MenuItem::Separator:
201 && items_.back().kind() != MenuItem::Separator)
213 Menu & Menu::read(LyXLex & lex)
237 struct keyword_item menutags[md_last - 1] = {
238 { "branches", md_branches },
239 { "charstyles", md_charstyles },
240 { "documents", md_documents },
241 { "end", md_endmenu },
242 { "exportformats", md_exportformats },
243 { "floatinsert", md_floatinsert },
244 { "floatlistinsert", md_floatlistinsert },
245 { "importformats", md_importformats },
247 { "lastfiles", md_lastfiles },
248 { "optitem", md_optitem },
249 { "optsubmenu", md_optsubmenu },
250 { "pasterecent", md_pasterecent },
251 { "separator", md_separator },
252 { "submenu", md_submenu },
254 { "updateformats", md_updateformats },
255 { "viewformats", md_viewformats }
258 lex.pushTable(menutags, md_last - 1);
259 if (lyxerr.debugging(Debug::PARSER))
260 lex.printTable(lyxerr);
263 bool optional = false;
265 while (lex.isOK() && !quit) {
269 // fallback to md_item
272 string const name = _(lex.getString());
274 string const command = lex.getString();
275 FuncRequest func = lyxaction.lookupFunc(command);
276 add(MenuItem(MenuItem::Command, name, func, optional));
282 add(MenuItem(MenuItem::Separator));
286 add(MenuItem(MenuItem::Lastfiles));
290 add(MenuItem(MenuItem::CharStyles));
294 add(MenuItem(MenuItem::Documents));
298 add(MenuItem(MenuItem::Toc));
302 add(MenuItem(MenuItem::ViewFormats));
305 case md_updateformats:
306 add(MenuItem(MenuItem::UpdateFormats));
309 case md_exportformats:
310 add(MenuItem(MenuItem::ExportFormats));
313 case md_importformats:
314 add(MenuItem(MenuItem::ImportFormats));
317 case md_floatlistinsert:
318 add(MenuItem(MenuItem::FloatListInsert));
322 add(MenuItem(MenuItem::FloatInsert));
326 add(MenuItem(MenuItem::PasteRecent));
330 add(MenuItem(MenuItem::Branches));
335 // fallback to md_submenu
338 string const mlabel = _(lex.getString());
340 string const mname = lex.getString();
341 add(MenuItem(MenuItem::Submenu, mlabel, mname,
352 lex.printError("Menu::read: "
353 "Unknown menu tag: `$$Token'");
362 MenuItem const & Menu::operator[](size_type i) const
368 bool Menu::hasFunc(FuncRequest const & func) const
370 return find_if(begin(), end(),
371 bind(std::equal_to<FuncRequest>(),
372 bind(&MenuItem::func, _1),
376 void Menu::checkShortcuts() const
378 // This is a quadratic algorithm, but we do not care because
379 // menus are short enough
380 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
381 string shortcut = it1->shortcut();
382 if (shortcut.empty())
384 if (!contains(it1->label(), shortcut))
385 lyxerr << "Menu warning: menu entry \""
387 << "\" does not contain shortcut `"
388 << shortcut << "'." << endl;
389 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
390 if (!compare_ascii_no_case(it2->shortcut(), shortcut)) {
391 lyxerr << "Menu warning: menu entries "
392 << '"' << it1->fulllabel()
393 << "\" and \"" << it2->fulllabel()
394 << "\" share the same shortcut."
402 void MenuBackend::specialMenu(string const &name)
405 specialmenu_ = &getMenu(name);
411 class compare_format {
413 bool operator()(Format const * p1, Format const * p2) {
418 string const limit_string_length(string const & str)
420 string::size_type const max_item_length = 45;
422 if (str.size() > max_item_length)
423 return str.substr(0, max_item_length - 3) + "...";
429 void expandLastfiles(Menu & tomenu, LyXView const * view)
431 lyx::Session::LastFiles const & lf = LyX::cref().session().lastFiles();
432 lyx::Session::LastFiles::const_iterator lfit = lf.begin();
436 for (; lfit != lf.end() && ii < 10; ++lfit, ++ii) {
437 string const label = convert<string>(ii) + ". "
438 + makeDisplayPath((*lfit), 30)
439 + '|' + convert<string>(ii);
440 tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, (*lfit))), view);
445 void expandDocuments(Menu & tomenu, LyXView const * view)
447 typedef vector<string> Strings;
448 Strings const names = bufferlist.getFileNames();
451 tomenu.add(MenuItem(MenuItem::Command, _("No Documents Open!"),
452 FuncRequest(LFUN_NOACTION)), view);
457 Strings::const_iterator docit = names.begin();
458 Strings::const_iterator end = names.end();
459 for (; docit != end; ++docit, ++ii) {
460 string label = makeDisplayPath(*docit, 20);
462 label = convert<string>(ii) + ". " + label + '|' + convert<string>(ii);
463 tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_BUFFER_SWITCH, *docit)), view);
468 void expandFormats(MenuItem::Kind kind, Menu & tomenu, LyXView const * view)
470 if (!view->buffer() && kind != MenuItem::ImportFormats) {
471 tomenu.add(MenuItem(MenuItem::Command,
472 _("No Documents Open!"),
473 FuncRequest(LFUN_NOACTION)),
478 typedef vector<Format const *> Formats;
483 case MenuItem::ImportFormats:
484 formats = Importer::GetImportableFormats();
485 action = LFUN_BUFFER_IMPORT;
487 case MenuItem::ViewFormats:
488 formats = Exporter::getExportableFormats(*view->buffer(), true);
489 action = LFUN_BUFFER_VIEW;
491 case MenuItem::UpdateFormats:
492 formats = Exporter::getExportableFormats(*view->buffer(), true);
493 action = LFUN_BUFFER_UPDATE;
496 formats = Exporter::getExportableFormats(*view->buffer(), false);
497 action = LFUN_BUFFER_EXPORT;
499 sort(formats.begin(), formats.end(), compare_format());
501 Formats::const_iterator fit = formats.begin();
502 Formats::const_iterator end = formats.end();
503 for (; fit != end ; ++fit) {
506 string label = (*fit)->prettyname();
507 // we need to hide the default graphic export formats
508 // from the external menu, because we need them only
509 // for the internal lyx-view and external latex run
510 if (label == "EPS" || label == "XPM" || label == "PNG")
513 if (kind == MenuItem::ImportFormats) {
514 if ((*fit)->name() == "text")
515 label = _("Plain Text as Lines");
516 else if ((*fit)->name() == "textparagraph")
517 label = _("Plain Text as Paragraphs");
519 } else if (kind == MenuItem::ExportFormats) {
520 // exporting to LyX does not make sense
521 // FIXME: Introduce noexport flag
522 if ((*fit)->name() == "lyx")
525 if (!(*fit)->shortcut().empty())
526 label += '|' + (*fit)->shortcut();
528 tomenu.add(MenuItem(MenuItem::Command, label,
529 FuncRequest(action, (*fit)->name())),
535 void expandFloatListInsert(Menu & tomenu, LyXView const * view)
537 if (!view->buffer()) {
538 tomenu.add(MenuItem(MenuItem::Command,
539 _("No Documents Open!"),
540 FuncRequest(LFUN_NOACTION)),
545 FloatList const & floats =
546 view->buffer()->params().getLyXTextClass().floats();
547 FloatList::const_iterator cit = floats.begin();
548 FloatList::const_iterator end = floats.end();
549 for (; cit != end; ++cit) {
550 tomenu.add(MenuItem(MenuItem::Command,
551 _(cit->second.listName()),
552 FuncRequest(LFUN_FLOAT_LIST,
553 cit->second.type())),
559 void expandFloatInsert(Menu & tomenu, LyXView const * view)
561 if (!view->buffer()) {
562 tomenu.add(MenuItem(MenuItem::Command,
563 _("No Documents Open!"),
564 FuncRequest(LFUN_NOACTION)),
569 FloatList const & floats =
570 view->buffer()->params().getLyXTextClass().floats();
571 FloatList::const_iterator cit = floats.begin();
572 FloatList::const_iterator end = floats.end();
573 for (; cit != end; ++cit) {
575 string const label = _(cit->second.name());
576 tomenu.add(MenuItem(MenuItem::Command, label,
577 FuncRequest(LFUN_FLOAT_INSERT,
578 cit->second.type())),
584 void expandCharStyleInsert(Menu & tomenu, LyXView const * view)
586 if (!view->buffer()) {
587 tomenu.add(MenuItem(MenuItem::Command,
588 _("No Documents Open!"),
589 FuncRequest(LFUN_NOACTION)),
593 CharStyles & charstyles =
594 view->buffer()->params().getLyXTextClass().charstyles();
595 CharStyles::iterator cit = charstyles.begin();
596 CharStyles::iterator end = charstyles.end();
597 for (; cit != end; ++cit) {
598 string const label = cit->name;
599 tomenu.add(MenuItem(MenuItem::Command, label,
600 FuncRequest(LFUN_CHARSTYLE_INSERT,
606 Menu::size_type const max_number_of_items = 25;
608 void expandToc2(Menu & tomenu,
609 lyx::toc::Toc const & toc_list,
610 lyx::toc::Toc::size_type from,
611 lyx::toc::Toc::size_type to, int depth)
613 int shortcut_count = 0;
615 // check whether depth is smaller than the smallest depth in toc.
616 int min_depth = 1000;
617 for (lyx::toc::Toc::size_type i = from; i < to; ++i)
618 min_depth = std::min(min_depth, toc_list[i].depth());
619 if (min_depth > depth)
623 if (to - from <= max_number_of_items) {
624 for (lyx::toc::Toc::size_type i = from; i < to; ++i) {
625 string label(4 * max(0, toc_list[i].depth() - depth),' ');
626 label += limit_string_length(toc_list[i].str());
627 if (toc_list[i].depth() == depth
628 && shortcut_count < 9) {
629 if (label.find(convert<string>(shortcut_count + 1)) != string::npos)
630 label += '|' + convert<string>(++shortcut_count);
632 tomenu.add(MenuItem(MenuItem::Command, label,
633 FuncRequest(toc_list[i].action())));
636 lyx::toc::Toc::size_type pos = from;
638 lyx::toc::Toc::size_type new_pos = pos + 1;
639 while (new_pos < to &&
640 toc_list[new_pos].depth() > depth)
643 string label(4 * max(0, toc_list[pos].depth() - depth), ' ');
644 label += limit_string_length(toc_list[pos].str());
645 if (toc_list[pos].depth() == depth &&
646 shortcut_count < 9) {
647 if (label.find(convert<string>(shortcut_count + 1)) != string::npos)
648 label += '|' + convert<string>(++shortcut_count);
650 if (new_pos == pos + 1) {
651 tomenu.add(MenuItem(MenuItem::Command,
652 label, FuncRequest(toc_list[pos].action())));
654 MenuItem item(MenuItem::Submenu, label);
655 item.submenu(new Menu);
656 expandToc2(*item.submenu(),
657 toc_list, pos, new_pos, depth + 1);
666 void expandToc(Menu & tomenu, LyXView const * view)
668 // To make things very cleanly, we would have to pass view to
669 // all MenuItem constructors and to expandToc2. However, we
670 // know that all the entries in a TOC will be have status_ ==
671 // OK, so we avoid this unnecessary overhead (JMarc)
674 Buffer const * buf = view->buffer();
676 tomenu.add(MenuItem(MenuItem::Command,
677 _("No Documents Open!"),
678 FuncRequest(LFUN_NOACTION)),
683 FloatList const & floatlist = buf->params().getLyXTextClass().floats();
684 lyx::toc::TocList const & toc_list = lyx::toc::getTocList(*buf);
685 lyx::toc::TocList::const_iterator cit = toc_list.begin();
686 lyx::toc::TocList::const_iterator end = toc_list.end();
687 for (; cit != end; ++cit) {
689 if (cit->first == "TOC")
692 // All the rest is for floats
693 auto_ptr<Menu> menu(new Menu);
694 lyx::toc::Toc::const_iterator ccit = cit->second.begin();
695 lyx::toc::Toc::const_iterator eend = cit->second.end();
696 for (; ccit != eend; ++ccit) {
697 string const label = limit_string_length(ccit->str());
698 menu->add(MenuItem(MenuItem::Command,
700 FuncRequest(ccit->action())));
702 string const & floatName = floatlist.getType(cit->first).listName();
703 MenuItem item(MenuItem::Submenu, _(floatName));
704 item.submenu(menu.release());
709 cit = toc_list.find("TOC");
711 tomenu.add(MenuItem(MenuItem::Command,
712 _("No Table of contents"),
716 expandToc2(tomenu, cit->second, 0, cit->second.size(), 0);
721 void expandPasteRecent(Menu & tomenu, LyXView const * view)
723 if (!view || !view->buffer())
726 vector<string> const sel =
727 lyx::cap::availableSelections(*view->buffer());
729 vector<string>::const_iterator cit = sel.begin();
730 vector<string>::const_iterator end = sel.end();
732 for (unsigned int index = 0; cit != end; ++cit, ++index) {
733 tomenu.add(MenuItem(MenuItem::Command, *cit,
734 FuncRequest(LFUN_PASTE, convert<string>(index))));
739 void expandBranches(Menu & tomenu, LyXView const * view)
741 if (!view || !view->buffer())
744 BufferParams const & params = view->buffer()->getMasterBuffer()->params();
746 BranchList::const_iterator cit = params.branchlist().begin();
747 BranchList::const_iterator end = params.branchlist().end();
749 for (int ii = 1; cit != end; ++cit, ++ii) {
750 string label = cit->getBranch();
752 label = convert<string>(ii) + ". " + label + "|" + convert<string>(ii);
753 tomenu.add(MenuItem(MenuItem::Command, label,
754 FuncRequest(LFUN_BRANCH_INSERT,
755 cit->getBranch())), view);
763 void MenuBackend::expand(Menu const & frommenu, Menu & tomenu,
764 LyXView const * view) const
769 for (Menu::const_iterator cit = frommenu.begin();
770 cit != frommenu.end() ; ++cit) {
771 switch (cit->kind()) {
772 case MenuItem::Lastfiles:
773 expandLastfiles(tomenu, view);
776 case MenuItem::Documents:
777 expandDocuments(tomenu, view);
780 case MenuItem::ImportFormats:
781 case MenuItem::ViewFormats:
782 case MenuItem::UpdateFormats:
783 case MenuItem::ExportFormats:
784 expandFormats(cit->kind(), tomenu, view);
787 case MenuItem::CharStyles:
788 expandCharStyleInsert(tomenu, view);
791 case MenuItem::FloatListInsert:
792 expandFloatListInsert(tomenu, view);
795 case MenuItem::FloatInsert:
796 expandFloatInsert(tomenu, view);
799 case MenuItem::PasteRecent:
800 expandPasteRecent(tomenu, view);
803 case MenuItem::Branches:
804 expandBranches(tomenu, view);
808 expandToc(tomenu, view);
811 case MenuItem::Submenu: {
813 item.submenu(new Menu(cit->submenuname()));
814 expand(getMenu(cit->submenuname()),
815 *item.submenu(), view);
816 tomenu.add(item, view);
820 case MenuItem::Separator:
821 tomenu.add(*cit, view);
824 case MenuItem::Command:
826 || !specialmenu_->hasFunc(cit->func()))
827 tomenu.add(*cit, view);
831 // we do not want the menu to end with a separator
833 && tomenu.items_.back().kind() == MenuItem::Separator)
834 tomenu.items_.pop_back();
836 // Check whether the shortcuts are unique
837 tomenu.checkShortcuts();
841 void MenuBackend::read(LyXLex & lex)
850 struct keyword_item menutags[md_last - 1] = {
851 { "end", md_endmenuset },
853 { "menubar", md_menubar }
857 if (compare_ascii_no_case(lex.getString(), "menuset")) {
858 lyxerr << "Menubackend::read: ERROR wrong token:`"
859 << lex.getString() << '\'' << endl;
862 lex.pushTable(menutags, md_last - 1);
863 if (lyxerr.debugging(Debug::PARSER))
864 lex.printTable(lyxerr);
868 while (lex.isOK() && !quit) {
875 string const name = lex.getString();
877 getMenu(name).read(lex);
889 lex.printError("menubackend::read: "
890 "Unknown menu tag: `$$Token'");
898 void MenuBackend::add(Menu const & menu)
900 menulist_.push_back(menu);
904 bool MenuBackend::hasMenu(string const & name) const
906 return find_if(begin(), end(), MenuNamesEqual(name)) != end();
910 Menu const & MenuBackend::getMenu(string const & name) const
912 const_iterator cit = find_if(begin(), end(), MenuNamesEqual(name));
914 lyxerr << "No submenu named " << name << endl;
915 BOOST_ASSERT(cit != end());
920 Menu & MenuBackend::getMenu(string const & name)
922 iterator it = find_if(begin(), end(), MenuNamesEqual(name));
924 lyxerr << "No submenu named " << name << endl;
925 BOOST_ASSERT(it != end());
930 Menu const & MenuBackend::getMenubar() const