]> git.lyx.org Git - features.git/blobdiff - src/frontends/qt4/Menus.cpp
Use a typedef for vector<Format const *>, which is what gets used
[features.git] / src / frontends / qt4 / Menus.cpp
index 2507ae31d8f624d5c5b1ce022f2af3172f28a9f4..53a845563fdb3f62c80a3231ed2243b4a0df2136 100644 (file)
@@ -78,9 +78,8 @@
 #include <QProxyStyle>
 #endif
 
-#include "support/shared_ptr.h"
-
 #include <algorithm>
+#include <memory>
 #include <vector>
 
 using namespace std;
@@ -199,8 +198,8 @@ public:
                 QString const & submenu = QString(),
                 QString const & tooltip = QString(),
                 bool optional = false)
-               : kind_(kind), label_(label), submenuname_(submenu),
-                 tooltip_(tooltip), optional_(optional)
+               : kind_(kind), label_(label), func_(make_shared<FuncRequest>()),
+                 submenuname_(submenu), tooltip_(tooltip), optional_(optional)
        {
                LATTEST(kind == Submenu || kind == Help || kind == Info);
        }
@@ -211,15 +210,12 @@ public:
                 QString const & tooltip = QString(),
                 bool optional = false,
                 FuncRequest::Origin origin = FuncRequest::MENU)
-               : kind_(kind), label_(label), func_(func),
+               : kind_(kind), label_(label), func_(make_shared<FuncRequest>(func)),
                  tooltip_(tooltip), optional_(optional)
        {
-               func_.setOrigin(origin);
+               func_->setOrigin(origin);
        }
 
-       // shared_ptr<MenuDefinition> needs this apprently...
-       ~MenuItem() {}
-
        /// The label of a given menuitem
        QString label() const
        {
@@ -238,7 +234,7 @@ public:
        /// The kind of entry
        Kind kind() const { return kind_; }
        /// the action (if relevant)
-       FuncRequest const & func() const { return func_; }
+       shared_ptr<FuncRequest const> func() const { return func_; }
        /// the tooltip
        QString const & tooltip() const { return tooltip_; }
        /// returns true if the entry should be omitted when disabled
@@ -257,13 +253,13 @@ public:
                        return QString();
                // Get the keys bound to this action, but keep only the
                // first one later
-               KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func_);
+               KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(*func_);
                if (!bindings.empty())
                        return toqstr(bindings.begin()->print(KeySequence::ForGui));
 
                LYXERR(Debug::KBMAP, "No binding for "
-                       << lyxaction.getActionName(func_.action())
-                       << '(' << func_.argument() << ')');
+                       << lyxaction.getActionName(func_->action())
+                       << '(' << func_->argument() << ')');
                return QString();
        }
 
@@ -289,7 +285,7 @@ private:
        ///
        QString label_;
        ///
-       FuncRequest func_;
+       shared_ptr<FuncRequest> func_;// non-null
        ///
        QString submenuname_;
        ///
@@ -323,8 +319,6 @@ public:
        ///
        size_t size() const { return items_.size(); }
        ///
-       MenuItem const & operator[](size_t) const;
-       ///
        const_iterator begin() const { return items_.begin(); }
        ///
        const_iterator end() const { return items_.end(); }
@@ -354,7 +348,7 @@ public:
        void expandFloatListInsert(Buffer const * buf);
        void expandFloatInsert(Buffer const * buf);
        void expandFlexInsert(Buffer const * buf, InsetLayout::InsetLyXType type);
-       void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth);
+       void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth, string toc_type);
        void expandToc(Buffer const * buf);
        void expandPasteRecent(Buffer const * buf);
        void expandToolbars();
@@ -402,7 +396,7 @@ void MenuDefinition::addWithStatusCheck(MenuItem const & i)
        switch (i.kind()) {
 
        case MenuItem::Command: {
-               FuncStatus status = lyx::getStatus(i.func());
+               FuncStatus status = lyx::getStatus(*i.func());
                if (status.unknown() || (!status.enabled() && i.optional()))
                        break;
                items_.push_back(i);
@@ -417,8 +411,9 @@ void MenuDefinition::addWithStatusCheck(MenuItem const & i)
                                  cit != i.submenu().end(); ++cit) {
                                // Only these kind of items affect the status of the submenu
                                if ((cit->kind() == MenuItem::Command
-                                       || cit->kind() == MenuItem::Submenu
-                                       || cit->kind() == MenuItem::Help)) {
+                                    || cit->kind() == MenuItem::Submenu
+                                    || cit->kind() == MenuItem::Help)
+                                   && cit->status().enabled()) {
                                        enabled = true;
                                        break;
                                }
@@ -685,16 +680,10 @@ void MenuDefinition::read(Lexer & lex)
 }
 
 
-MenuItem const & MenuDefinition::operator[](size_type i) const
-{
-       return items_[i];
-}
-
-
 bool MenuDefinition::hasFunc(FuncRequest const & func) const
 {
        for (const_iterator it = begin(), et = end(); it != et; ++it)
-               if (it->func() == func)
+               if (*it->func() == func)
                        return true;
        return false;
 }
@@ -744,7 +733,7 @@ bool MenuDefinition::searchMenu(FuncRequest const & func, docstring_list & names
        const_iterator m = begin();
        const_iterator m_end = end();
        for (; m != m_end; ++m) {
-               if (m->kind() == MenuItem::Command && m->func() == func) {
+               if (m->kind() == MenuItem::Command && *m->func() == func) {
                        names.push_back(qstring_to_ucs4(m->label()));
                        return true;
                }
@@ -1037,8 +1026,7 @@ void MenuDefinition::expandFormats(MenuItem::Kind const kind, Buffer const * buf
        if (!buf && kind != MenuItem::ImportFormats)
                return;
 
-       typedef vector<Format const *> Formats;
-       Formats formats;
+       FormatList formats;
        FuncCode action = LFUN_NOACTION;
 
        switch (kind) {
@@ -1062,7 +1050,6 @@ void MenuDefinition::expandFormats(MenuItem::Kind const kind, Buffer const * buf
                LATTEST(false);
                return;
        }
-       sort(formats.begin(), formats.end(), Format::formatSorter);
 
        bool const view_update = (kind == MenuItem::ViewFormats
                        || kind == MenuItem::UpdateFormats);
@@ -1075,14 +1062,12 @@ void MenuDefinition::expandFormats(MenuItem::Kind const kind, Buffer const * buf
        MenuItem item(MenuItem::Submenu, smenue);
        item.setSubmenu(MenuDefinition(smenue));
 
-       Formats::const_iterator fit = formats.begin();
-       Formats::const_iterator end = formats.end();
-       for (; fit != end ; ++fit) {
-               if ((*fit)->dummy())
+       for (Format const * f : formats) {
+               if (f->dummy())
                        continue;
 
-               docstring lab = from_utf8((*fit)->prettyname());
-               docstring const scut = from_utf8((*fit)->shortcut());
+               docstring lab = f->prettyname();
+               docstring const scut = from_utf8(f->shortcut());
                docstring const tmplab = lab;
 
                if (!scut.empty())
@@ -1099,7 +1084,7 @@ void MenuDefinition::expandFormats(MenuItem::Kind const kind, Buffer const * buf
                        break;
                case MenuItem::ViewFormats:
                case MenuItem::UpdateFormats:
-                       if ((*fit)->name() == buf->params().getDefaultOutputFormat()) {
+                       if (f->name() == buf->params().getDefaultOutputFormat()) {
                                docstring lbl = (kind == MenuItem::ViewFormats
                                        ? bformat(_("View [%1$s]|V"), label)
                                        : bformat(_("Update [%1$s]|U"), label));
@@ -1108,7 +1093,7 @@ void MenuDefinition::expandFormats(MenuItem::Kind const kind, Buffer const * buf
                        }
                // fall through
                case MenuItem::ExportFormats:
-                       if (!(*fit)->inExportMenu())
+                       if (!f->inExportMenu())
                                continue;
                        break;
                default:
@@ -1123,14 +1108,14 @@ void MenuDefinition::expandFormats(MenuItem::Kind const kind, Buffer const * buf
                        // note that at this point, we know that buf is not null
                        LATTEST(buf);
                        item.submenu().addWithStatusCheck(MenuItem(MenuItem::Command,
-                               toqstr(label), FuncRequest(action, (*fit)->name())));
+                               toqstr(label), FuncRequest(action, f->name())));
                } else {
                        if (buf)
                                addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
-                                       FuncRequest(action, (*fit)->name())));
+                                       FuncRequest(action, f->name())));
                        else
                                add(MenuItem(MenuItem::Command, toqstr(label),
-                                       FuncRequest(action, (*fit)->name())));
+                                       FuncRequest(action, f->name())));
                }
        }
        if (view_update)
@@ -1217,10 +1202,18 @@ void MenuDefinition::expandFlexInsert(
 }
 
 
+// Threshold before we stop displaying sub-items alongside items
+// (for display purposes). Ideally this should fit on a screen.
 size_t const max_number_of_items = 30;
+// Size limit for the menu. This is for performance purposes,
+// because qt already displays a scrollable menu when necessary.
+// Ideally this should be the menu size from which scrollable
+// menus become unpractical.
+size_t const menu_size_limit = 80;
 
 void MenuDefinition::expandToc2(Toc const & toc_list,
-               size_t from, size_t to, int depth)
+                                size_t from, size_t to, int depth,
+                                string toc_type)
 {
        int shortcut_count = 0;
 
@@ -1250,6 +1243,7 @@ void MenuDefinition::expandToc2(Toc const & toc_list,
                }
        } else {
                size_t pos = from;
+               size_t size = 1;
                while (pos < to) {
                        size_t new_pos = pos + 1;
                        while (new_pos < to && toc_list[new_pos].depth() > depth)
@@ -1264,16 +1258,22 @@ void MenuDefinition::expandToc2(Toc const & toc_list,
                                                label += QString::number(++shortcut_count);
                                }
                        }
+                       if (size >= menu_size_limit) {
+                               FuncRequest f(LFUN_DIALOG_SHOW, "toc " + toc_type);
+                               add(MenuItem(MenuItem::Command, "...", f));
+                               break;
+                       }
                        if (new_pos == pos + 1) {
                                add(MenuItem(MenuItem::Command,
                                                    label, FuncRequest(toc_list[pos].action())));
                        } else {
                                MenuDefinition sub;
-                               sub.expandToc2(toc_list, pos, new_pos, depth + 1);
+                               sub.expandToc2(toc_list, pos, new_pos, depth + 1, toc_type);
                                MenuItem item(MenuItem::Submenu, label);
                                item.setSubmenu(sub);
                                add(item);
                        }
+                       ++size;
                        pos = new_pos;
                }
        }
@@ -1311,10 +1311,10 @@ void MenuDefinition::expandToc(Buffer const * buf)
                MenuDefinition submenu;
                // "Open outliner..." entry
                FuncRequest f(LFUN_DIALOG_SHOW, "toc " + cit->first);
-               submenu.add(MenuItem(MenuItem::Command, qt_("Open outliner..."), f));
+               submenu.add(MenuItem(MenuItem::Command, qt_("Open Outliner..."), f));
                submenu.add(MenuItem(MenuItem::Separator));
                // add entries
-               submenu.expandToc2(* cit->second, 0, cit->second->size(), 0);
+               submenu.expandToc2(*cit->second, 0, cit->second->size(), 0, cit->first);
                MenuItem item(MenuItem::Submenu, guiName(cit->first, buf->params()));
                item.setSubmenu(submenu);
                // deserves to be in the main menu?
@@ -1335,7 +1335,8 @@ void MenuDefinition::expandToc(Buffer const * buf)
                LYXERR(Debug::GUI, "No table of contents.");
        else {
                if (!cit->second->empty())
-                       expandToc2(* cit->second, 0, cit->second->size(), 0);
+                       expandToc2(*cit->second, 0, cit->second->size(), 0,
+                                  "tableofcontents");
                else
                        add(MenuItem(MenuItem::Info, qt_("(Empty Table of Contents)")));
        }
@@ -1600,47 +1601,37 @@ void MenuDefinition::expandCaptions(Buffer const * buf, bool switchcap)
        if (!buf)
                return;
 
-       vector<docstring> caps;
        DocumentClass const & dc = buf->params().documentClass();
-       TextClass::InsetLayouts::const_iterator lit = dc.insetLayouts().begin();
-       TextClass::InsetLayouts::const_iterator len = dc.insetLayouts().end();
-       for (; lit != len; ++lit) {
-               if (prefixIs(lit->first, from_ascii("Caption:")))
-                       caps.push_back(lit->first);
+       vector< pair<docstring, FuncRequest> > caps;
+       for (pair<docstring, InsetLayout> const & il : dc.insetLayouts()) {
+               docstring instype;
+               docstring const type = split(il.first, instype, ':');
+               if (instype == "Caption") {
+                       // skip forbidden caption types
+                       FuncRequest const cmd = switchcap
+                               ? FuncRequest(LFUN_INSET_MODIFY, from_ascii("changetype ") + type)
+                               : FuncRequest(LFUN_CAPTION_INSERT, type);
+                       if (getStatus(cmd).enabled())
+                               caps.push_back(make_pair(type, cmd));
+               }
        }
 
        if (caps.empty() || (switchcap && caps.size() == 1))
                return;
        if (caps.size() == 1) {
-               docstring dummy;
-               docstring const type = split(*caps.begin(), dummy, ':');
-               add(MenuItem(MenuItem::Command, qt_("Caption"),
-                        FuncRequest(LFUN_CAPTION_INSERT, translateIfPossible(type))));
+               add(MenuItem(MenuItem::Command, qt_("Caption"), caps.front().second));
                return;
        }
 
        MenuDefinition captions;
-
-       vector<docstring>::const_iterator cit = caps.begin();
-       vector<docstring>::const_iterator end = caps.end();
-
-       for (int ii = 1; cit != end; ++cit, ++ii) {
-               docstring dummy;
-               docstring const type = split(*cit, dummy, ':');
+       for (pair<docstring, FuncRequest> const & cap : caps) {
+               docstring const type = cap.first;
                docstring const trtype = translateIfPossible(type);
                docstring const cmitem = bformat(_("Caption (%1$s)"), trtype);
-               // make menu item optional, otherwise we would also see
-               // forbidden caption types
                if (switchcap)
-                       addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cmitem),
-                                    FuncRequest(LFUN_INSET_MODIFY,
-                                                from_ascii("changetype ")
-                                                + type), QString(), true));
+                       add(MenuItem(MenuItem::Command, toqstr(cmitem), cap.second));
                else
-                       captions.addWithStatusCheck(MenuItem(MenuItem::Command,
-                                                            toqstr(trtype),
-                                                            FuncRequest(LFUN_CAPTION_INSERT,
-                                                            type), QString(), true));
+                       captions.add(MenuItem(MenuItem::Command, toqstr(trtype), cap.second));
        }
        if (!captions.empty()) {
                MenuItem item(MenuItem::Submenu, qt_("Caption"));
@@ -1705,7 +1696,7 @@ struct Menu::Impl
 {
        /// populates the menu or one of its submenu
        /// This is used as a recursive function
-       void populate(QMenu & qMenu, MenuDefinition const & menu);
+       void populate(QMenu * qMenu, MenuDefinition const & menu);
 
        /// Only needed for top level menus.
        MenuDefinition * top_level_menu;
@@ -1738,7 +1729,7 @@ static QString label(MenuItem const & mi)
        return label;
 }
 
-void Menu::Impl::populate(QMenu & qMenu, MenuDefinition const & menu)
+void Menu::Impl::populate(QMenu * qMenu, MenuDefinition const & menu)
 {
        LYXERR(Debug::GUI, "populating menu " << menu.name());
        if (menu.empty()) {
@@ -1746,21 +1737,26 @@ void Menu::Impl::populate(QMenu & qMenu, MenuDefinition const & menu)
                return;
        }
        LYXERR(Debug::GUI, " *****  menu entries " << menu.size());
-       MenuDefinition::const_iterator m = menu.begin();
-       MenuDefinition::const_iterator end = menu.end();
-       for (; m != end; ++m) {
-               if (m->kind() == MenuItem::Separator)
-                       qMenu.addSeparator();
-               else if (m->kind() == MenuItem::Submenu) {
-                       QMenu * subMenu = qMenu.addMenu(label(*m));
-                       populate(*subMenu, m->submenu());
-                       subMenu->setEnabled(m->status().enabled());
-               } else {
-                       // we have a MenuItem::Command
-                       qMenu.addAction(new Action(QIcon(), label(*m),
-                               m->func(), m->tooltip(), &qMenu));
+       for (MenuItem const & m : menu)
+               switch (m.kind()) {
+               case MenuItem::Separator:
+                       qMenu->addSeparator();
+                       break;
+               case MenuItem::Submenu: {
+                       QMenu * subMenu = qMenu->addMenu(label(m));
+                       populate(subMenu, m.submenu());
+                       subMenu->setEnabled(!subMenu->isEmpty());
+                       break;
+               }
+               case MenuItem::Command:
+               default:
+                       // FIXME: A previous comment assured that MenuItem::Command was the
+                       // only possible case in practice, but this is wrong.  It would be
+                       // good to document which cases are actually treated here.
+                       qMenu->addAction(new Action(m.func(), QIcon(), label(m),
+                                                   m.tooltip(), qMenu));
+                       break;
                }
-       }
 }
 
 #if (defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)) && (QT_VERSION >= 0x040600)
@@ -1918,7 +1914,7 @@ void Menus::Impl::macxMenuBarInit(QMenuBar * qmb)
                QAction::MenuRole role;
        };
 
-       static MacMenuEntry entries[] = {
+       static const MacMenuEntry entries[] = {
                {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
                 QAction::AboutRole},
                {LFUN_DIALOG_SHOW, "prefs", "Preferences",
@@ -1947,13 +1943,13 @@ void Menus::Impl::macxMenuBarInit(QMenuBar * qmb)
        // add the entries to a QMenu that will eventually be empty
        // and therefore invisible.
        QMenu * qMenu = qmb->addMenu("special");
-       MenuDefinition::const_iterator cit = mac_special_menu_.begin();
-       MenuDefinition::const_iterator end = mac_special_menu_.end();
-       for (size_t i = 0 ; cit != end ; ++cit, ++i) {
-               Action * action = new Action(QIcon(), cit->label(),
-                       cit->func(), QString(), qMenu);
+       size_t i = 0;
+       for (MenuItem const & m : mac_special_menu_) {
+               Action * action = new Action(m.func(), QIcon(), m.label(),
+                                            QString(), qMenu);
                action->setMenuRole(entries[i].role);
                qMenu->addAction(action);
+               ++i;
        }
 }
 
@@ -2090,7 +2086,7 @@ void Menus::Impl::expand(MenuDefinition const & frommenu,
                        break;
 
                case MenuItem::Command:
-                       if (!mac_special_menu_.hasFunc(cit->func()))
+                       if (!mac_special_menu_.hasFunc(*cit->func()))
                                tomenu.addWithStatusCheck(*cit);
                }
        }
@@ -2329,7 +2325,7 @@ void Menus::updateMenu(Menu * qmenu)
        if (qmenu->d->view)
                bv = qmenu->d->view->currentBufferView();
        d->expand(fromLyxMenu, *qmenu->d->top_level_menu, bv);
-       qmenu->d->populate(*qmenu, *qmenu->d->top_level_menu);
+       qmenu->d->populate(qmenu, *qmenu->d->top_level_menu);
 }