]> git.lyx.org Git - lyx.git/blobdiff - src/MenuBackend.C
* GuiView.C (updateTab): do not update early if current tab has
[lyx.git] / src / MenuBackend.C
index ce6f645ae0b67638407d106fb803161fa343b124..5419f6d8b718fb8ffa923724cd6e2073d18e3481 100644 (file)
@@ -35,7 +35,9 @@
 #include "lyx_main.h" // for lastfiles
 #include "lyxfunc.h"
 #include "lyxlex.h"
-#include "toc.h"
+#include "paragraph.h"
+#include "TocBackend.h"
+#include "ToolbarBackend.h"
 
 #include "support/filetools.h"
 #include "support/lstrings.h"
 
 #include <algorithm>
 
-using lyx::char_type;
-using lyx::docstring;
-using lyx::support::compare_no_case;
-using lyx::support::compare_ascii_no_case;
-using lyx::support::contains;
-using lyx::support::makeDisplayPath;
-using lyx::support::token;
+
+namespace lyx {
+
+using support::compare_no_case;
+using support::compare_ascii_no_case;
+using support::contains;
+using support::makeDisplayPath;
+using support::token;
+using support::uppercase;
 
 using boost::bind;
 
@@ -104,7 +108,7 @@ MenuItem::MenuItem(Kind kind, docstring const & label,
                   FuncRequest const & func, bool optional)
        : kind_(kind), label_(label), func_(func), optional_(optional)
 {
-       func_.origin = FuncRequest::UI;
+       func_.origin = FuncRequest::MENU;
 }
 
 
@@ -130,7 +134,7 @@ docstring const MenuItem::shortcut() const
 }
 
 
-docstring const MenuItem::binding() const
+docstring const MenuItem::binding(bool forgui) const
 {
        if (kind_ != Command)
                return docstring();
@@ -140,12 +144,12 @@ docstring const MenuItem::binding() const
        kb_keymap::Bindings bindings = theTopLevelKeymap().findbindings(func_);
 
        if (bindings.size()) {
-               return lyx::from_utf8(bindings.begin()->print());
+               return bindings.begin()->print(forgui);
        } else {
                lyxerr[Debug::KBMAP]
                        << "No binding for "
                        << lyxaction.getActionName(func_.action)
-                       << '(' << lyx::to_utf8(func_.argument()) << ')' << endl;
+                       << '(' << to_utf8(func_.argument()) << ')' << endl;
                return docstring();
        }
 
@@ -164,10 +168,8 @@ Menu & Menu::addWithStatusCheck(MenuItem const & i)
        switch (i.kind()) {
 
        case MenuItem::Command: {
-               FuncStatus status =
-                       lyx::getStatus(i.func());
-               if (status.unknown()
-                   || (!status.enabled() && i.optional()))
+               FuncStatus status = lyx::getStatus(i.func());
+               if (status.unknown() || (!status.enabled() && i.optional()))
                        break;
                items_.push_back(i);
                items_.back().status(status);
@@ -216,6 +218,7 @@ Menu & Menu::read(LyXLex & lex)
                md_item = 1,
                md_branches,
                md_documents,
+               md_bookmarks,
                md_charstyles,
                md_endmenu,
                md_exportformats,
@@ -231,10 +234,12 @@ Menu & Menu::read(LyXLex & lex)
                md_floatlistinsert,
                md_floatinsert,
                md_pasterecent,
+               md_toolbars,
                md_last
        };
 
        struct keyword_item menutags[md_last - 1] = {
+               { "bookmarks", md_bookmarks },
                { "branches", md_branches },
                { "charstyles", md_charstyles },
                { "documents", md_documents },
@@ -251,6 +256,7 @@ Menu & Menu::read(LyXLex & lex)
                { "separator", md_separator },
                { "submenu", md_submenu },
                { "toc", md_toc },
+               { "toolbars", md_toolbars },
                { "updateformats", md_updateformats },
                { "viewformats", md_viewformats }
        };
@@ -269,7 +275,7 @@ Menu & Menu::read(LyXLex & lex)
                        // fallback to md_item
                case md_item: {
                        lex.next(true);
-                       docstring const name = _(lex.getString());
+                       docstring const name = translateIfPossible(lex.getDocString());
                        lex.next(true);
                        string const command = lex.getString();
                        FuncRequest func = lyxaction.lookupFunc(command);
@@ -294,6 +300,10 @@ Menu & Menu::read(LyXLex & lex)
                        add(MenuItem(MenuItem::Documents));
                        break;
 
+               case md_bookmarks:
+                       add(MenuItem(MenuItem::Bookmarks));
+                       break;
+
                case md_toc:
                        add(MenuItem(MenuItem::Toc));
                        break;
@@ -326,6 +336,10 @@ Menu & Menu::read(LyXLex & lex)
                        add(MenuItem(MenuItem::PasteRecent));
                        break;
 
+               case md_toolbars:
+                       add(MenuItem(MenuItem::Toolbars));
+                       break;
+
                case md_branches:
                        add(MenuItem(MenuItem::Branches));
                        break;
@@ -335,9 +349,9 @@ Menu & Menu::read(LyXLex & lex)
                        // fallback to md_submenu
                case md_submenu: {
                        lex.next(true);
-                       docstring const mlabel = _(lex.getString());
+                       docstring const mlabel = translateIfPossible(lex.getDocString());
                        lex.next(true);
-                       docstring const mname = lyx::from_utf8(lex.getString());
+                       docstring const mname = lex.getDocString();
                        add(MenuItem(MenuItem::Submenu, mlabel, mname,
                                     optional));
                        optional = false;
@@ -383,14 +397,14 @@ void Menu::checkShortcuts() const
                        continue;
                if (!contains(it1->label(), shortcut))
                        lyxerr << "Menu warning: menu entry \""
-                              << lyx::to_utf8(it1->label())
+                              << to_utf8(it1->label())
                               << "\" does not contain shortcut `"
-                              << lyx::to_utf8(shortcut) << "'." << endl;
+                              << to_utf8(shortcut) << "'." << endl;
                for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
                        if (!compare_no_case(it2->shortcut(), shortcut)) {
                                lyxerr << "Menu warning: menu entries "
-                                      << '"' << lyx::to_utf8(it1->fulllabel())
-                                      << "\" and \"" << lyx::to_utf8(it2->fulllabel())
+                                      << '"' << to_utf8(it1->fulllabel())
+                                      << "\" and \"" << to_utf8(it2->fulllabel())
                                       << "\" share the same shortcut."
                                       << endl;
                        }
@@ -399,10 +413,9 @@ void Menu::checkShortcuts() const
 }
 
 
-void MenuBackend::specialMenu(docstring const &name)
+void MenuBackend::specialMenu(Menu const & menu)
 {
-       if (hasMenu(name))
-               specialmenu_ = &getMenu(name);
+       specialmenu_ = menu;
 }
 
 
@@ -428,16 +441,17 @@ docstring const limit_string_length(docstring const & str)
 
 void expandLastfiles(Menu & tomenu)
 {
-       lyx::Session::LastFiles const & lf = LyX::cref().session().lastFiles();
-       lyx::Session::LastFiles::const_iterator lfit = lf.begin();
+       lyx::LastFilesSection::LastFiles const & lf = LyX::cref().session().lastFiles().lastFiles();
+       lyx::LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
 
        int ii = 1;
 
        for (; lfit != lf.end() && ii < 10; ++lfit, ++ii) {
+               string const file = lfit->absFilename();
                docstring const label = convert<docstring>(ii) + ". "
-                       + makeDisplayPath((*lfit), 30)
+                       + makeDisplayPath(file, 30)
                        + char_type('|') + convert<docstring>(ii);
-               tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, (*lfit))));
+               tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, file)));
        }
 }
 
@@ -465,6 +479,22 @@ void expandDocuments(Menu & tomenu)
 }
 
 
+void expandBookmarks(Menu & tomenu)
+{
+       lyx::BookmarksSection const & bm = LyX::cref().session().bookmarks();
+
+       for (size_t i = 1; i <= bm.size(); ++i) {
+               if (bm.isValid(i)) {
+                       docstring const label = convert<docstring>(i) + ". "
+                               + makeDisplayPath(bm.bookmark(i).filename.absFilename(), 20)
+                               + char_type('|') + convert<docstring>(i);
+                       tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_BOOKMARK_GOTO, 
+                               convert<docstring>(i))));
+               }
+       }
+}
+
+
 void expandFormats(MenuItem::Kind kind, Menu & tomenu, Buffer const * buf)
 {
        if (!buf && kind != MenuItem::ImportFormats) {
@@ -502,14 +532,16 @@ void expandFormats(MenuItem::Kind kind, Menu & tomenu, Buffer const * buf)
        for (; fit != end ; ++fit) {
                if ((*fit)->dummy())
                        continue;
-               docstring label = lyx::from_utf8((*fit)->prettyname());
+               docstring label = from_utf8((*fit)->prettyname());
 
                switch (kind) {
                case MenuItem::ImportFormats:
+                       // FIXME: This is a hack, we should rather solve
+                       // FIXME: bug 2488 instead.
                        if ((*fit)->name() == "text")
-                               label = _("Plain Text as Lines");
+                               label = _("Plain Text");
                        else if ((*fit)->name() == "textparagraph")
-                               label = _("Plain Text as Paragraphs");
+                               label = _("Plain Text, Join Lines");
                        label += "...";
                        break;
                case MenuItem::ViewFormats:
@@ -523,7 +555,7 @@ void expandFormats(MenuItem::Kind kind, Menu & tomenu, Buffer const * buf)
                        break;
                }
                if (!(*fit)->shortcut().empty())
-                       label += char_type('|') + lyx::from_utf8((*fit)->shortcut());
+                       label += char_type('|') + from_utf8((*fit)->shortcut());
 
                if (buf)
                        tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
@@ -593,10 +625,10 @@ void expandCharStyleInsert(Menu & tomenu, Buffer const * buf)
        CharStyles::iterator cit = charstyles.begin();
        CharStyles::iterator end = charstyles.end();
        for (; cit != end; ++cit) {
-               docstring const label = lyx::from_utf8(cit->name);
+               docstring const label = from_utf8(cit->name);
                tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
                                    FuncRequest(LFUN_CHARSTYLE_INSERT,
-                                               cit->name)));
+                                               label)));
        }
 }
 
@@ -604,22 +636,22 @@ void expandCharStyleInsert(Menu & tomenu, Buffer const * buf)
 Menu::size_type const max_number_of_items = 25;
 
 void expandToc2(Menu & tomenu,
-               lyx::toc::Toc const & toc_list,
-               lyx::toc::Toc::size_type from,
-               lyx::toc::Toc::size_type to, int depth)
+               Toc const & toc_list,
+               Toc::size_type from,
+               Toc::size_type to, int depth)
 {
        int shortcut_count = 0;
 
        // check whether depth is smaller than the smallest depth in toc.
        int min_depth = 1000;
-       for (lyx::toc::Toc::size_type i = from; i < to; ++i)
+       for (Toc::size_type i = from; i < to; ++i)
                min_depth = std::min(min_depth, toc_list[i].depth());
        if (min_depth > depth)
                depth = min_depth;
 
 
        if (to - from <= max_number_of_items) {
-               for (lyx::toc::Toc::size_type i = from; i < to; ++i) {
+               for (Toc::size_type i = from; i < to; ++i) {
                        docstring label(4 * max(0, toc_list[i].depth() - depth), char_type(' '));
                        label += limit_string_length(toc_list[i].str());
                        if (toc_list[i].depth() == depth
@@ -631,9 +663,9 @@ void expandToc2(Menu & tomenu,
                                            FuncRequest(toc_list[i].action())));
                }
        } else {
-               lyx::toc::Toc::size_type pos = from;
+               Toc::size_type pos = from;
                while (pos < to) {
-                       lyx::toc::Toc::size_type new_pos = pos + 1;
+                       Toc::size_type new_pos = pos + 1;
                        while (new_pos < to &&
                               toc_list[new_pos].depth() > depth)
                                ++new_pos;
@@ -675,19 +707,28 @@ void expandToc(Menu & tomenu, Buffer const * buf)
                return;
        }
 
+       // Add an entry for the master doc if this is a child doc
+       Buffer const * const master = buf->getMasterBuffer();
+       if (buf != master) {
+               ParIterator const pit = par_iterator_begin(master->inset());
+               string const arg = convert<string>(pit->id());
+               FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
+               tomenu.add(MenuItem(MenuItem::Command, _("Master Document"), f));
+       }
+
        FloatList const & floatlist = buf->params().getLyXTextClass().floats();
-       lyx::toc::TocList const & toc_list = lyx::toc::getTocList(*buf);
-       lyx::toc::TocList::const_iterator cit = toc_list.begin();
-       lyx::toc::TocList::const_iterator end = toc_list.end();
+       TocList const & toc_list = buf->tocBackend().tocs();
+       TocList::const_iterator cit = toc_list.begin();
+       TocList::const_iterator end = toc_list.end();
        for (; cit != end; ++cit) {
                // Handle this later
-               if (cit->first == "TOC")
+               if (cit->first == "tableofcontents")
                        continue;
 
                // All the rest is for floats
                auto_ptr<Menu> menu(new Menu);
-               lyx::toc::Toc::const_iterator ccit = cit->second.begin();
-               lyx::toc::Toc::const_iterator eend = cit->second.end();
+               TocIterator ccit = cit->second.begin();
+               TocIterator eend = cit->second.end();
                for (; ccit != eend; ++ccit) {
                        docstring const label = limit_string_length(ccit->str());
                        menu->add(MenuItem(MenuItem::Command,
@@ -701,7 +742,7 @@ void expandToc(Menu & tomenu, Buffer const * buf)
        }
 
        // Handle normal TOC
-       cit = toc_list.find("TOC");
+       cit = toc_list.find("tableofcontents");
        if (cit == end) {
                tomenu.addWithStatusCheck(MenuItem(MenuItem::Command,
                                    _("No Table of contents"),
@@ -718,7 +759,7 @@ void expandPasteRecent(Menu & tomenu, Buffer const * buf)
                return;
 
        vector<docstring> const sel =
-               lyx::cap::availableSelections(*buf);
+               cap::availableSelections(*buf);
 
        vector<docstring>::const_iterator cit = sel.begin();
        vector<docstring>::const_iterator end = sel.end();
@@ -730,6 +771,32 @@ void expandPasteRecent(Menu & tomenu, Buffer const * buf)
 }
 
 
+void expandToolbars(Menu & tomenu)
+{
+       //
+       // extracts the toolbars from the backend
+       ToolbarBackend::Toolbars::const_iterator cit = toolbarbackend.begin();
+       ToolbarBackend::Toolbars::const_iterator end = toolbarbackend.end();
+
+       for (; cit != end; ++cit) {
+               docstring label = _(cit->gui_name);
+               // frontends are not supposed to turn on/off toolbars, if they cannot
+               // update ToolbarBackend::flags. That is to say, ToolbarsBackend::flags
+               // should reflect the true state of toolbars.
+               // 
+               // menu is displayed as 
+               //       on/off review
+               // and 
+               //              review (auto)
+               // in the case of auto.
+               if (cit->flags & ToolbarBackend::AUTO)
+                       label += _(" (auto)");
+               tomenu.add(MenuItem(MenuItem::Command, label,
+                                   FuncRequest(LFUN_TOOLBAR_TOGGLE_STATE, cit->name)));
+       }
+}
+
+
 void expandBranches(Menu & tomenu, Buffer const * buf)
 {
        if (!buf)
@@ -741,7 +808,7 @@ void expandBranches(Menu & tomenu, Buffer const * buf)
        BranchList::const_iterator end = params.branchlist().end();
 
        for (int ii = 1; cit != end; ++cit, ++ii) {
-               docstring label = lyx::from_utf8(cit->getBranch());
+               docstring label = cit->getBranch();
                if (ii < 10)
                        label = convert<docstring>(ii) + ". " + label + char_type('|') + convert<docstring>(ii);
                tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
@@ -771,6 +838,10 @@ void MenuBackend::expand(Menu const & frommenu, Menu & tomenu,
                        expandDocuments(tomenu);
                        break;
 
+               case MenuItem::Bookmarks:
+                       expandBookmarks(tomenu);
+                       break;
+
                case MenuItem::ImportFormats:
                case MenuItem::ViewFormats:
                case MenuItem::UpdateFormats:
@@ -794,6 +865,10 @@ void MenuBackend::expand(Menu const & frommenu, Menu & tomenu,
                        expandPasteRecent(tomenu, buf);
                        break;
 
+               case MenuItem::Toolbars:
+                       expandToolbars(tomenu);
+                       break;
+
                case MenuItem::Branches:
                        expandBranches(tomenu, buf);
                        break;
@@ -816,8 +891,7 @@ void MenuBackend::expand(Menu const & frommenu, Menu & tomenu,
                        break;
 
                case MenuItem::Command:
-                       if (!specialmenu_
-                           || !specialmenu_->hasFunc(cit->func()))
+                       if (!specialmenu_.hasFunc(cit->func()))
                                tomenu.addWithStatusCheck(*cit);
                }
        }
@@ -866,7 +940,7 @@ void MenuBackend::read(LyXLex & lex)
                        break;
                case md_menu: {
                        lex.next(true);
-                       docstring const name = lyx::from_utf8(lex.getString());
+                       docstring const name = lex.getDocString();
                        if (hasMenu(name)) {
                                getMenu(name).read(lex);
                        } else {
@@ -905,7 +979,7 @@ Menu const & MenuBackend::getMenu(docstring const & name) const
 {
        const_iterator cit = find_if(begin(), end(), MenuNamesEqual(name));
        if (cit == end())
-               lyxerr << "No submenu named " << lyx::to_utf8(name) << endl;
+               lyxerr << "No submenu named " << to_utf8(name) << endl;
        BOOST_ASSERT(cit != end());
        return (*cit);
 }
@@ -915,7 +989,7 @@ Menu & MenuBackend::getMenu(docstring const & name)
 {
        iterator it = find_if(begin(), end(), MenuNamesEqual(name));
        if (it == end())
-               lyxerr << "No submenu named " << lyx::to_utf8(name) << endl;
+               lyxerr << "No submenu named " << to_utf8(name) << endl;
        BOOST_ASSERT(it != end());
        return (*it);
 }
@@ -925,3 +999,6 @@ Menu const & MenuBackend::getMenubar() const
 {
        return menubar_;
 }
+
+
+} // namespace lyx