]> git.lyx.org Git - lyx.git/blobdiff - src/MenuBackend.C
Point fix, earlier forgotten
[lyx.git] / src / MenuBackend.C
index 30eadba0b24af63ae751109a22ff59c70d825f34..ef780bbc7aa32a43a7d0de61181733588cb57e58 100644 (file)
@@ -1,40 +1,50 @@
-/* This file is part of
- * ======================================================
+/**
+ * \file MenuBackend.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
+ * \author Asger Alstrup
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author André Pönitz
+ * \author Dekel Tsur
+ * \author Martin Vermeer
  *
- *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2001 The LyX Team.
- *
- *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS.
+ */
 
 #include <config.h>
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
-#include <algorithm>
 #include "MenuBackend.h"
 #include "lyxlex.h"
 #include "LyXAction.h"
 #include "debug.h"
 #include "gettext.h"
+#include "kbmap.h"
 #include "lastfiles.h"
+#include "lyxfunc.h"
 #include "lyx_main.h" // for lastfiles
 #include "bufferlist.h"
-#include "converter.h"
+#include "buffer.h"
+#include "format.h"
 #include "exporter.h"
 #include "importer.h"
 #include "FloatList.h"
 #include "toc.h"
+#include "CutAndPaste.h"
+#include "frontends/LyXView.h"
 #include "support/LAssert.h"
 #include "support/filetools.h"
 #include "support/lyxfunctional.h"
 #include "support/lstrings.h"
+#include "support/tostr.h"
+
+#include <algorithm>
 
 extern BufferList bufferlist;
+extern boost::scoped_ptr<kb_keymap> toplevel_keymap;
+
+using namespace lyx::support;
 
 using std::endl;
 using std::vector;
@@ -62,6 +72,8 @@ MenuItem::MenuItem(Kind kind, string const & label,
        case ImportFormats:
        case FloatListInsert:
        case FloatInsert:
+       case PasteRecent:
+       case Branches:
                break;
        case Command:
                action_ = lyxaction.LookupFunc(command);
@@ -108,10 +120,72 @@ string const MenuItem::shortcut() const
        return token(label_, '|', 1);
 }
 
+string const MenuItem::binding() const
+{
+       if (kind_ != Command)
+               return string();
+
+       // Get the keys bound to this action, but keep only the
+       // first one later
+       string bindings = toplevel_keymap->findbinding(action_);
+
+       if (!bindings.empty()) {
+               return bindings.substr(1, bindings.find(']') - 1);
+       } else
+               return string();
+}
+
 
-Menu & Menu::add(MenuItem const & i)
+Menu & Menu::add(MenuItem const & i, LyXView const * view)
 {
-       items_.push_back(i);
+       if (!view) {
+               items_.push_back(i);
+               return *this;
+       }
+
+       switch (i.kind()) {
+       case MenuItem::Command:
+       {
+               FuncStatus status =
+                       view->getLyXFunc().getStatus(i.action());
+               if (status.unknown()
+                   || (status.disabled() && i.optional()))
+                       break;
+               items_.push_back(i);
+               items_.back().status(status);
+               break;
+       }
+       case MenuItem::Submenu:
+       {
+               if (i.submenu()) {
+                       bool disabled = true;
+                       for (const_iterator cit = i.submenu()->begin();
+                            cit != i.submenu()->end(); ++cit) {
+                               if ((cit->kind() == MenuItem::Command
+                                    || cit->kind() == MenuItem::Submenu)
+                                   && !cit->status().disabled()) {
+                                       disabled = false;
+                                       break;
+                               }
+                       }
+                       if (!disabled || !i.optional()) {
+                               items_.push_back(i);
+                               items_.back().status().disabled(disabled);
+                       }
+               }
+               else
+                       items_.push_back(i);
+               break;
+       }
+       case MenuItem::Separator:
+               if (!items_.empty()
+                   && items_.back().kind() != MenuItem::Separator)
+                       items_.push_back(i);
+               break;
+       default:
+               items_.push_back(i);
+       }
+
        return *this;
 }
 
@@ -120,12 +194,14 @@ Menu & Menu::read(LyXLex & lex)
 {
        enum Menutags {
                md_item = 1,
+               md_branches,
                md_documents,
                md_endmenu,
                md_exportformats,
                md_importformats,
                md_lastfiles,
                md_optitem,
+               md_optsubmenu,
                md_separator,
                md_submenu,
                md_toc,
@@ -133,10 +209,12 @@ Menu & Menu::read(LyXLex & lex)
                md_viewformats,
                md_floatlistinsert,
                md_floatinsert,
+               md_pasterecent,
                md_last
        };
 
        struct keyword_item menutags[md_last - 1] = {
+               { "branches", md_branches },
                { "documents", md_documents },
                { "end", md_endmenu },
                { "exportformats", md_exportformats },
@@ -146,6 +224,8 @@ Menu & Menu::read(LyXLex & lex)
                { "item", md_item },
                { "lastfiles", md_lastfiles },
                { "optitem", md_optitem },
+               { "optsubmenu", md_optsubmenu },
+               { "pasterecent", md_pasterecent },
                { "separator", md_separator },
                { "submenu", md_submenu },
                { "toc", md_toc },
@@ -216,12 +296,25 @@ Menu & Menu::read(LyXLex & lex)
                        add(MenuItem(MenuItem::FloatInsert));
                        break;
 
+               case md_pasterecent:
+                       add(MenuItem(MenuItem::PasteRecent));
+                       break;
+
+               case md_branches:
+                       add(MenuItem(MenuItem::Branches));
+                       break;
+
+               case md_optsubmenu:
+                       optional = true;
+                       // fallback to md_submenu
                case md_submenu: {
                        lex.next(true);
                        string const mlabel = _(lex.getString());
                        lex.next(true);
                        string const mname = lex.getString();
-                       add(MenuItem(MenuItem::Submenu, mlabel, mname));
+                       add(MenuItem(MenuItem::Submenu, mlabel, mname,
+                                    optional));
+                       optional = false;
                        break;
                }
 
@@ -243,7 +336,7 @@ Menu & Menu::read(LyXLex & lex)
 void Menu::checkShortcuts() const
 {
        // This is a quadratic algorithm, but we do not care because
-       // it is used for debugging only.
+       // menus are short enough
        for (const_iterator it1 = begin(); it1 != end(); ++it1) {
                string shortcut = it1->shortcut();
                if (shortcut.empty())
@@ -252,7 +345,7 @@ void Menu::checkShortcuts() const
                        lyxerr << "Menu warning: menu entry \""
                               << it1->label()
                               << "\" does not contain shortcut `"
-                              << shortcut << '\'' << endl;
+                              << shortcut << "'." << endl;
                for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
                        if (!compare_ascii_no_case(it2->shortcut(), shortcut)) {
                                lyxerr << "Menu warning: menu entries "
@@ -286,7 +379,7 @@ string const limit_string_length(string const & str)
 }
 
 
-void expandLastfiles(Menu & tomenu)
+void expandLastfiles(Menu & tomenu, LyXView const * view)
 {
        int ii = 1;
        LastFiles::const_iterator lfit = lastfiles->begin();
@@ -299,19 +392,18 @@ void expandLastfiles(Menu & tomenu)
                int const action = lyxaction.
                        getPseudoAction(LFUN_FILE_OPEN,
                                        (*lfit));
-               tomenu.add(MenuItem(MenuItem::Command,
-                                   label, action));
+               tomenu.add(MenuItem(MenuItem::Command, label, action), view);
        }
 }
 
-void expandDocuments(Menu & tomenu)
+void expandDocuments(Menu & tomenu, LyXView const * view)
 {
        typedef vector<string> Strings;
        Strings const names = bufferlist.getFileNames();
 
        if (names.empty()) {
                tomenu.add(MenuItem(MenuItem::Command, _("No Documents Open!"),
-                                   LFUN_NOACTION));
+                                   LFUN_NOACTION), view);
                return;
        }
 
@@ -321,19 +413,20 @@ void expandDocuments(Menu & tomenu)
        for (; docit != end; ++docit, ++ii) {
                int const action =
                        lyxaction.getPseudoAction(LFUN_SWITCHBUFFER, *docit);
-               string label = MakeDisplayPath(*docit, 30);
+               string label = MakeDisplayPath(*docit, 20);
                if (ii < 10)
                        label = tostr(ii) + ". " + label + '|' + tostr(ii);
-               tomenu.add(MenuItem(MenuItem::Command, label, action));
+               tomenu.add(MenuItem(MenuItem::Command, label, action), view);
        }
 }
 
 
-void expandFormats(MenuItem::Kind kind, Menu & tomenu, Buffer const * buf)
+void expandFormats(MenuItem::Kind kind, Menu & tomenu, LyXView const * view)
 {
-       if (!buf && kind != MenuItem::ImportFormats) {
+       if (!view->buffer() && kind != MenuItem::ImportFormats) {
                tomenu.add(MenuItem(MenuItem::Command,
-                                   _("No Documents Open!"), LFUN_NOACTION));
+                                   _("No Documents Open!"), LFUN_NOACTION),
+                                   view);
                return;
        }
 
@@ -347,15 +440,15 @@ void expandFormats(MenuItem::Kind kind, Menu & tomenu, Buffer const * buf)
                action = LFUN_IMPORT;
                break;
        case MenuItem::ViewFormats:
-               formats = Exporter::GetExportableFormats(buf, true);
+               formats = Exporter::GetExportableFormats(*view->buffer(), true);
                action = LFUN_PREVIEW;
                break;
        case MenuItem::UpdateFormats:
-               formats = Exporter::GetExportableFormats(buf, true);
+               formats = Exporter::GetExportableFormats(*view->buffer(), true);
                action = LFUN_UPDATE;
                break;
        default:
-               formats = Exporter::GetExportableFormats(buf, false);
+               formats = Exporter::GetExportableFormats(*view->buffer(), false);
                action = LFUN_EXPORT;
        }
        sort(formats.begin(), formats.end(), compare_format());
@@ -372,70 +465,94 @@ void expandFormats(MenuItem::Kind kind, Menu & tomenu, Buffer const * buf)
                if (label == "EPS" || label == "XPM" || label == "PNG")
                        continue;
 
-               if (kind == MenuItem::ImportFormats)
+               if (kind == MenuItem::ImportFormats) {
                        if ((*fit)->name() == "text")
-                               label = _("Ascii text as lines");
+                               label = _("ASCII text as lines");
                        else if ((*fit)->name() == "textparagraph")
-                               label = _("Ascii text as paragraphs");
+                               label = _("ASCII text as paragraphs");
+                       label += "...";
+               }
                if (!(*fit)->shortcut().empty())
-                       label += "|" + (*fit)->shortcut();
+                       label += '|' + (*fit)->shortcut();
                int const action2 = lyxaction.
                        getPseudoAction(action, (*fit)->name());
-               tomenu.add(MenuItem(MenuItem::Command, label, action2));
+               tomenu.add(MenuItem(MenuItem::Command, label, action2),
+                          view);
        }
 }
 
 
-void expandFloatListInsert(Menu & tomenu)
+void expandFloatListInsert(Menu & tomenu, LyXView const * view)
 {
-       FloatList::const_iterator cit = floatList.begin();
-       FloatList::const_iterator end = floatList.end();
+       if (!view->buffer()) {
+               tomenu.add(MenuItem(MenuItem::Command,
+                                   _("No Documents Open!"), LFUN_NOACTION),
+                          view);
+               return;
+       }
+
+       FloatList const & floats =
+               view->buffer()->params.getLyXTextClass().floats();
+       FloatList::const_iterator cit = floats.begin();
+       FloatList::const_iterator end = floats.end();
        for (; cit != end; ++cit) {
                int const action =  lyxaction
                        .getPseudoAction(LFUN_FLOAT_LIST, cit->second.type());
                tomenu.add(MenuItem(MenuItem::Command,
-                                   _(cit->second.listName()),
-                                   action));
+                                   _(cit->second.listName()), action),
+                          view);
        }
 }
 
 
-void expandFloatInsert(Menu & tomenu)
+void expandFloatInsert(Menu & tomenu, LyXView const * view)
 {
-       FloatList::const_iterator cit = floatList.begin();
-       FloatList::const_iterator end = floatList.end();
+       if (!view->buffer()) {
+               tomenu.add(MenuItem(MenuItem::Command,
+                                   _("No Documents Open!"), LFUN_NOACTION),
+                          view);
+               return;
+       }
+
+       FloatList const & floats =
+               view->buffer()->params.getLyXTextClass().floats();
+       FloatList::const_iterator cit = floats.begin();
+       FloatList::const_iterator end = floats.end();
        for (; cit != end; ++cit) {
                // normal float
                int const action =
                        lyxaction.getPseudoAction(LFUN_INSET_FLOAT,
                                                  cit->second.type());
                string const label = _(cit->second.name());
-               tomenu.add(MenuItem(MenuItem::Command, label, action));
+               tomenu.add(MenuItem(MenuItem::Command, label, action),
+                          view);
        }
 }
 
 
 Menu::size_type const max_number_of_items = 25;
 
-void expandToc2(Menu & tomenu, toc::Toc const & toc_list,
-               toc::Toc::size_type from, toc::Toc::size_type to, int depth)
+void expandToc2(Menu & tomenu,
+               lyx::toc::Toc const & toc_list,
+               lyx::toc::Toc::size_type from,
+               lyx::toc::Toc::size_type to, int depth)
 {
        int shortcut_count = 0;
        if (to - from <= max_number_of_items) {
-               for (toc::Toc::size_type i = from; i < to; ++i) {
+               for (lyx::toc::Toc::size_type i = from; i < to; ++i) {
                        int const action = toc_list[i].action();
                        string label(4 * max(0, toc_list[i].depth - depth),' ');
                        label += limit_string_length(toc_list[i].str);
                        if (toc_list[i].depth == depth
                            && ++shortcut_count <= 9) {
-                               label += "|" + tostr(shortcut_count);
+                               label += '|' + tostr(shortcut_count);
                        }
                        tomenu.add(MenuItem(MenuItem::Command, label, action));
                }
        } else {
-               toc::Toc::size_type pos = from;
+               lyx::toc::Toc::size_type pos = from;
                while (pos < to) {
-                       toc::Toc::size_type new_pos = pos + 1;
+                       lyx::toc::Toc::size_type new_pos = pos + 1;
                        while (new_pos < to &&
                               toc_list[new_pos].depth > depth)
                                ++new_pos;
@@ -463,26 +580,40 @@ void expandToc2(Menu & tomenu, toc::Toc const & toc_list,
 }
 
 
-void expandToc(Menu & tomenu, Buffer const * buf)
+void expandToc(Menu & tomenu, LyXView const * view)
 {
-       toc::TocList toc_list = toc::getTocList(buf);
-       toc::TocList::const_iterator cit = toc_list.begin();
-       toc::TocList::const_iterator end = toc_list.end();
+       // To make things very cleanly, we would have to pass view to
+       // all MenuItem constructors and to expandToc2. However, we
+       // know that all the entries in a TOC will be have status_ ==
+       // OK, so we avoid this unnecessary overhead (JMarc)
+
+       if (!view->buffer()) {
+               tomenu.add(MenuItem(MenuItem::Command,
+                                   _("No Documents Open!"), LFUN_NOACTION),
+                          view);
+               return;
+       }
+
+       lyx::toc::TocList toc_list = lyx::toc::getTocList(*view->buffer());
+       lyx::toc::TocList::const_iterator cit = toc_list.begin();
+       lyx::toc::TocList::const_iterator end = toc_list.end();
        for (; cit != end; ++cit) {
                // Handle this later
-               if (cit->first == "TOC") continue;
+               if (cit->first == "TOC")
+                       continue;
 
                // All the rest is for floats
                Menu * menu = new Menu;
-               toc::Toc::const_iterator ccit = cit->second.begin();
-               toc::Toc::const_iterator eend = cit->second.end();
+               lyx::toc::Toc::const_iterator ccit = cit->second.begin();
+               lyx::toc::Toc::const_iterator eend = cit->second.end();
                for (; ccit != eend; ++ccit) {
                        string const label = limit_string_length(ccit->str);
                        menu->add(MenuItem(MenuItem::Command,
                                           label, ccit->action()));
                }
-               MenuItem item(MenuItem::Submenu,
-                             floatList[cit->first]->second.name());
+               string const & floatName = cit->first;
+               // Is the _(...) really needed here? (Lgb)
+               MenuItem item(MenuItem::Submenu, _(floatName));
                item.submenu(menu);
                tomenu.add(item);
        }
@@ -491,66 +622,120 @@ void expandToc(Menu & tomenu, Buffer const * buf)
        cit = toc_list.find("TOC");
        if (cit == end) {
                tomenu.add(MenuItem(MenuItem::Command,
-                                   _("No Table of contents")));
+                                   _("No Table of contents")),
+                          view);
        } else {
                expandToc2(tomenu, cit->second, 0, cit->second.size(), 0);
        }
 }
 
 
+void expandPasteRecent(Menu & tomenu, LyXView const * view)
+{
+       if (!view || !view->buffer())
+               return;
+
+       vector<string> const selL =
+               CutAndPaste::availableSelections(*view->buffer());
+
+       vector<string>::const_iterator cit = selL.begin();
+       vector<string>::const_iterator end = selL.end();
+
+       for (unsigned int index = 0; cit != end; ++cit, ++index) {
+               int const action = lyxaction.getPseudoAction(LFUN_PASTE,
+                                                            tostr(index));
+               tomenu.add(MenuItem(MenuItem::Command, *cit, action));
+       }
+}
+
+
+void expandBranches(Menu & tomenu, LyXView const * view)
+{
+       if (!view || !view->buffer())
+               return;
+
+       BufferParams const & params = view->buffer()->params;
+
+       std::list<Branch>::const_iterator cit = params.branchlist.begin();
+       std::list<Branch>::const_iterator end = params.branchlist.end();
+
+       for (int ii = 1; cit != end; ++cit, ++ii) {
+               string label = cit->getBranch();
+               int const action = lyxaction.
+                       getPseudoAction(LFUN_INSERT_BRANCH,
+                                       (cit->getBranch()));
+               if (ii < 10)
+                       label = tostr(ii) + ". " + label + "|" + tostr(ii);
+               tomenu.add(MenuItem(MenuItem::Command, label, action), view);
+       }
+}
+
+
 } // namespace anon
 
 
 void MenuBackend::expand(Menu const & frommenu, Menu & tomenu,
-                        Buffer const * buf) const
+                        LyXView const * view) const
 {
        for (Menu::const_iterator cit = frommenu.begin();
             cit != frommenu.end() ; ++cit) {
                switch (cit->kind()) {
                case MenuItem::Lastfiles:
-                       expandLastfiles(tomenu);
+                       expandLastfiles(tomenu, view);
                        break;
 
                case MenuItem::Documents:
-                       expandDocuments(tomenu);
+                       expandDocuments(tomenu, view);
                        break;
 
                case MenuItem::ImportFormats:
                case MenuItem::ViewFormats:
                case MenuItem::UpdateFormats:
                case MenuItem::ExportFormats:
-                       expandFormats(cit->kind(), tomenu, buf);
+                       expandFormats(cit->kind(), tomenu, view);
                        break;
 
                case MenuItem::FloatListInsert:
-                       expandFloatListInsert(tomenu);
+                       expandFloatListInsert(tomenu, view);
                        break;
 
                case MenuItem::FloatInsert:
-                       expandFloatInsert(tomenu);
+                       expandFloatInsert(tomenu, view);
+                       break;
+
+               case MenuItem::PasteRecent:
+                       expandPasteRecent(tomenu, view);
+                       break;
+
+               case MenuItem::Branches:
+                       expandBranches(tomenu, view);
                        break;
 
                case MenuItem::Toc:
-                       expandToc(tomenu, buf);
+                       expandToc(tomenu, view);
                        break;
 
                case MenuItem::Submenu: {
                        MenuItem item(*cit);
                        item.submenu(new Menu(cit->submenuname()));
                        expand(getMenu(cit->submenuname()),
-                              *item.submenu(), buf);
-                       tomenu.add(item);
+                              *item.submenu(), view);
+                       tomenu.add(item, view);
                }
                break;
 
                default:
-                       tomenu.add(*cit);
+                       tomenu.add(*cit, view);
                }
        }
 
+       // we do not want the menu to end with a separator
+       if (!tomenu.empty()
+           && tomenu.items_.back().kind() == MenuItem::Separator)
+               tomenu.items_.pop_back();
+
        // Check whether the shortcuts are unique
-       if (lyxerr.debugging(Debug::GUI))
-               tomenu.checkShortcuts();
+       tomenu.checkShortcuts();
 }
 
 
@@ -619,51 +804,6 @@ void MenuBackend::read(LyXLex & lex)
 }
 
 
-void MenuBackend::defaults()
-{
-       menulist_.clear();
-
-       lyxerr[Debug::GUI] << "MenuBackend::defaults: using default values"
-                          << endl;
-
-       Menu file("file");
-       file
-               .add(MenuItem(MenuItem::Command, _("New...|N"), "buffer-new"))
-               .add(MenuItem(MenuItem::Command, _("Open...|O"), "file-open"))
-               .add(MenuItem(MenuItem::Submenu, _("Import|I"), "import"))
-               .add(MenuItem(MenuItem::Command, _("Quit|Q"), "lyx-quit"))
-               .add(MenuItem(MenuItem::Separator))
-               .add(MenuItem(MenuItem::Lastfiles));
-       add(file);
-
-       Menu import("import");
-       import
-               .add(MenuItem(MenuItem::Command,
-                             _("LaTeX...|L"), "buffer-import latex"))
-               .add(MenuItem(MenuItem::Command,
-                             _("LinuxDoc...|L"), "buffer-import linuxdoc"));
-       add(import);
-
-       Menu edit("edit");
-       edit
-               .add(MenuItem(MenuItem::Command, _("Cut"), "cut"))
-               .add(MenuItem(MenuItem::Command, _("Copy"), "copy"))
-               .add(MenuItem(MenuItem::Command, _("Paste"), "paste"))
-               .add(MenuItem(MenuItem::Command, _("Emphasize"), "font-emph"));
-       add(edit);
-
-       Menu documents("documents");
-       documents.add(MenuItem(MenuItem::Documents));
-       add(documents);
-
-       menubar_.add(MenuItem(MenuItem::Submenu, _("File|F"), "file"))
-               .add(MenuItem(MenuItem::Submenu, _("Edit|E"), "edit"))
-               .add(MenuItem(MenuItem::Submenu,
-                             _("Documents|D"), "documents"));
-
-}
-
-
 void MenuBackend::add(Menu const & menu)
 {
        menulist_.push_back(menu);
@@ -681,7 +821,9 @@ Menu const & MenuBackend::getMenu(string const & name) const
 {
        const_iterator cit = find_if(begin(), end(),
                                     lyx::compare_memfun(&Menu::name, name));
-       lyx::Assert(cit != end());
+       if (cit == end())
+               lyxerr << "No submenu named " << name << endl;
+       Assert(cit != end());
        return (*cit);
 }
 
@@ -691,7 +833,7 @@ Menu & MenuBackend::getMenu(string const & name)
        MenuList::iterator it =
                find_if(menulist_.begin(), menulist_.end(),
                        lyx::compare_memfun(&Menu::name, name));
-       lyx::Assert(it != menulist_.end());
+       Assert(it != menulist_.end());
        return (*it);
 }