src/frontends/qt4/Menus.cpp

   1 /**
   2  * \file qt4/Menus.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author John Levon
   7  * \author Asger Alstrup
   8  * \author Lars Gullik Bjønnes
   9  * \author Jean-Marc Lasgouttes
  10  * \author André Pönitz
  11  * \author Dekel Tsur
  12  * \author Martin Vermeer
  13  *
  14  * Full author contact details are available in file CREDITS.
  15  */
  16
  17 #include <config.h>
  18
  19 #include "Menus.h"
  20
  21 #include "Action.h"
  22 #include "GuiApplication.h"
  23 #include "GuiPopupMenu.h"
  24 #include "GuiView.h"
  25
  26 #include "BranchList.h"
  27 #include "Buffer.h"
  28 #include "BufferList.h"
  29 #include "BufferParams.h"
  30 #include "Converter.h"
  31 #include "CutAndPaste.h"
  32 #include "Floating.h"
  33 #include "FloatList.h"
  34 #include "Format.h"
  35 #include "KeyMap.h"
  36 #include "Session.h"
  37 #include "LyXAction.h"
  38 #include "LyX.h" // for lastfiles
  39 #include "LyXFunc.h"
  40 #include "Lexer.h"
  41 #include "Paragraph.h"
  42 #include "TextClass.h"
  43 #include "TocBackend.h"
  44 #include "ToolbarBackend.h"
  45
  46 #include "frontends/Application.h"
  47
  48 #include "support/convert.h"
  49 #include "support/debug.h"
  50 #include "support/filetools.h"
  51 #include "support/gettext.h"
  52 #include "support/lstrings.h"
  53
  54 #include "qt_helpers.h"
  55
  56 #include <QCursor>
  57 #include <QMenuBar>
  58
  59 #include <algorithm>
  60 #include <ostream>
  61
  62 using namespace std;
  63 using namespace lyx::support;
  64
  65
  66 namespace lyx {
  67 namespace frontend {
  68
  69 namespace {
  70
  71 class MenuNamesEqual
  72 {
  73 public:
  74         MenuNamesEqual(QString const & name) : name_(name) {}
  75         bool operator()(Menu const & menu) const { return menu.name() == name_; }
  76 private:
  77         QString name_;
  78 };
  79
  80 } // namespace anon
  81
  82 // MacOSX specific stuff is at the end.
  83
  84 void Menus::fillMenuBar(GuiView * view)
  85 {
  86         // Clear all menubar contents before filling it.
  87         view->menuBar()->clear();
  88
  89 #ifdef Q_WS_MACX
  90         // setup special mac specific menu item
  91         macxMenuBarInit(view);
  92 #endif
  93
  94         LYXERR(Debug::GUI, "populating menu bar" << fromqstr(getMenubar().name()));
  95
  96         if (getMenubar().size() == 0) {
  97                 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
  98                         << fromqstr(getMenubar().name()));
  99                 return;
 100         }
 101         else {
 102                 LYXERR(Debug::GUI, "menu bar entries "
 103                         << getMenubar().size());
 104         }
 105
 106         Menu menu;
 107         expand(getMenubar(), menu, view->buffer());
 108
 109         Menu::const_iterator m = menu.begin();
 110         Menu::const_iterator end = menu.end();
 111
 112         for (; m != end; ++m) {
 113
 114                 if (m->kind() != MenuItem::Submenu) {
 115                         LYXERR(Debug::GUI, "\tERROR: not a submenu " << fromqstr(m->label()));
 116                         continue;
 117                 }
 118
 119                 LYXERR(Debug::GUI, "menu bar item " << fromqstr(m->label())
 120                         << " is a submenu named " << fromqstr(m->submenuname()));
 121
 122                 QString name = m->submenuname();
 123                 if (!hasMenu(name)) {
 124                         LYXERR(Debug::GUI, "\tERROR: " << fromqstr(name)
 125                                 << " submenu has no menu!");
 126                         continue;
 127                 }
 128
 129                 GuiPopupMenu * qMenu = new GuiPopupMenu(view, *m, true);
 130                 view->menuBar()->addMenu(qMenu);
 131
 132                 name_map_[name] = qMenu;
 133         }
 134 }
 135
 136
 137 QMenu * Menus::menu(QString const & name)
 138 {
 139         LYXERR(Debug::GUI, "Context menu requested: " << fromqstr(name));
 140         GuiPopupMenu * menu = name_map_.value(name, 0);
 141         if (!menu)
 142                 LYXERR0("resquested context menu not found: " << fromqstr(name));
 143         return menu;
 144 }
 145
 146
 147 /// Some special Qt/Mac support hacks
 148
 149 /*
 150   Here is what the Qt documentation says about how a menubar is chosen:
 151
 152      1) If the window has a QMenuBar then it is used. 2) If the window
 153      is a modal then its menubar is used. If no menubar is specified
 154      then a default menubar is used (as documented below) 3) If the
 155      window has no parent then the default menubar is used (as
 156      documented below).
 157
 158      The above 3 steps are applied all the way up the parent window
 159      chain until one of the above are satisifed. If all else fails a
 160      default menubar will be created, the default menubar on Qt/Mac is
 161      an empty menubar, however you can create a different default
 162      menubar by creating a parentless QMenuBar, the first one created
 163      will thus be designated the default menubar, and will be used
 164      whenever a default menubar is needed.
 165
 166   Thus, for Qt/Mac, we add the menus to a free standing menubar, so
 167   that this menubar will be used also when one of LyX' dialogs has
 168   focus. (JMarc)
 169 */
 170
 171 void Menus::macxMenuBarInit(GuiView * view)
 172 {
 173         // The Mac menubar initialisation must be done only once!
 174         static bool done = false;
 175         if (done)
 176                 return;
 177         done = true;
 178
 179         /* Since Qt 4.2, the qt/mac menu code has special code for
 180            specifying the role of a menu entry. However, it does not
 181            work very well with our scheme of creating menus on demand,
 182            and therefore we need to put these entries in a special
 183            invisible menu. (JMarc)
 184         */
 185
 186         /* The entries of our special mac menu. If we add support for
 187          * special entries in Menus, we could imagine something
 188          * like
 189          *    SpecialItem About " "About LyX" "dialog-show aboutlyx"
 190          * and therefore avoid hardcoding. I am not sure it is worth
 191          * the hassle, though. (JMarc)
 192          */
 193         struct MacMenuEntry {
 194                 kb_action action;
 195                 char const * arg;
 196                 char const * label;
 197                 QAction::MenuRole role;
 198         };
 199
 200         MacMenuEntry entries[] = {
 201                 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
 202                  QAction::AboutRole},
 203                 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
 204                  QAction::PreferencesRole},
 205                 {LFUN_RECONFIGURE, "", "Reconfigure",
 206                  QAction::ApplicationSpecificRole},
 207                 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
 208         };
 209         const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
 210
 211         // the special menu for Menus.
 212         Menu special;
 213         for (size_t i = 0 ; i < num_entries ; ++i) {
 214                 FuncRequest const func(entries[i].action,
 215                                        from_utf8(entries[i].arg));
 216                 special.add(MenuItem(MenuItem::Command, entries[i].label, func));
 217         }
 218         setSpecialMenu(special);
 219
 220         // add the entries to a QMenu that will eventually be empty
 221         // and therefore invisible.
 222         QMenu * qMenu = view->menuBar()->addMenu("special");
 223
 224         // we do not use 'special' because it is a temporary variable,
 225         // whereas Menus::specialMenu points to a persistent copy.
 226         Menu::const_iterator cit = specialMenu().begin();
 227         Menu::const_iterator end = specialMenu().end();
 228         for (size_t i = 0 ; cit != end ; ++cit, ++i) {
 229                 Action * action = new Action(*view, QIcon(), cit->label(),
 230                                              cit->func(), QString());
 231                 action->setMenuRole(entries[i].role);
 232                 qMenu->addAction(action);
 233         }
 234 }
 235
 236
 237 MenuItem::MenuItem(Kind kind)
 238         : kind_(kind), optional_(false)
 239 {}
 240
 241
 242 MenuItem::MenuItem(Kind kind, QString const & label,
 243                    QString const & submenu, bool optional)
 244         : kind_(kind), label_(label),
 245           submenuname_(submenu), optional_(optional)
 246 {
 247         BOOST_ASSERT(kind == Submenu);
 248 }
 249
 250
 251 MenuItem::MenuItem(Kind kind, QString const & label,
 252                    FuncRequest const & func, bool optional)
 253         : kind_(kind), label_(label), func_(func), optional_(optional)
 254 {
 255         func_.origin = FuncRequest::MENU;
 256 }
 257
 258
 259 MenuItem::~MenuItem()
 260 {}
 261
 262
 263 void MenuItem::setSubmenu(Menu * menu)
 264 {
 265         submenu_.reset(menu);
 266 }
 267
 268
 269 QString MenuItem::label() const
 270 {
 271         return label_.split('|')[0];
 272 }
 273
 274
 275 QString MenuItem::shortcut() const
 276 {
 277         return label_.contains('|') ? label_.split('|')[1] : QString();
 278 }
 279
 280
 281 QString MenuItem::binding() const
 282 {
 283         if (kind_ != Command)
 284                 return QString();
 285
 286         // Get the keys bound to this action, but keep only the
 287         // first one later
 288         KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func_);
 289
 290         if (bindings.size())
 291                 return toqstr(bindings.begin()->print(KeySequence::ForGui));
 292
 293         LYXERR(Debug::KBMAP, "No binding for "
 294                 << lyxaction.getActionName(func_.action)
 295                 << '(' << func_.argument() << ')');
 296         return QString();
 297 }
 298
 299
 300 void Menu::addWithStatusCheck(MenuItem const & i)
 301 {
 302         switch (i.kind()) {
 303
 304         case MenuItem::Command: {
 305                 FuncStatus status = lyx::getStatus(i.func());
 306                 if (status.unknown() || (!status.enabled() && i.optional()))
 307                         break;
 308                 items_.push_back(i);
 309                 items_.back().status(status);
 310                 break;
 311         }
 312
 313         case MenuItem::Submenu: {
 314                 if (i.submenu()) {
 315                         bool enabled = false;
 316                         for (const_iterator cit = i.submenu()->begin();
 317                              cit != i.submenu()->end(); ++cit) {
 318                                 if ((cit->kind() == MenuItem::Command
 319                                      || cit->kind() == MenuItem::Submenu)
 320                                     && cit->status().enabled()) {
 321                                         enabled = true;
 322                                         break;
 323                                 }
 324                         }
 325                         if (enabled || !i.optional()) {
 326                                 items_.push_back(i);
 327                                 items_.back().status().enabled(enabled);
 328                         }
 329                 }
 330                 else
 331                         items_.push_back(i);
 332                 break;
 333         }
 334
 335         case MenuItem::Separator:
 336                 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
 337                         items_.push_back(i);
 338                 break;
 339
 340         default:
 341                 items_.push_back(i);
 342         }
 343 }
 344
 345
 346 void Menu::read(Lexer & lex)
 347 {
 348         enum Menutags {
 349                 md_item = 1,
 350                 md_branches,
 351                 md_documents,
 352                 md_bookmarks,
 353                 md_charstyles,
 354                 md_custom,
 355                 md_elements,
 356                 md_endmenu,
 357                 md_exportformats,
 358                 md_importformats,
 359                 md_lastfiles,
 360                 md_optitem,
 361                 md_optsubmenu,
 362                 md_separator,
 363                 md_submenu,
 364                 md_toc,
 365                 md_updateformats,
 366                 md_viewformats,
 367                 md_floatlistinsert,
 368                 md_floatinsert,
 369                 md_pasterecent,
 370                 md_toolbars,
 371                 md_last
 372         };
 373
 374         struct keyword_item menutags[md_last - 1] = {
 375                 { "bookmarks", md_bookmarks },
 376                 { "branches", md_branches },
 377                 { "charstyles", md_charstyles },
 378                 { "custom", md_custom },
 379                 { "documents", md_documents },
 380                 { "elements", md_elements },
 381                 { "end", md_endmenu },
 382                 { "exportformats", md_exportformats },
 383                 { "floatinsert", md_floatinsert },
 384                 { "floatlistinsert", md_floatlistinsert },
 385                 { "importformats", md_importformats },
 386                 { "item", md_item },
 387                 { "lastfiles", md_lastfiles },
 388                 { "optitem", md_optitem },
 389                 { "optsubmenu", md_optsubmenu },
 390                 { "pasterecent", md_pasterecent },
 391                 { "separator", md_separator },
 392                 { "submenu", md_submenu },
 393                 { "toc", md_toc },
 394                 { "toolbars", md_toolbars },
 395                 { "updateformats", md_updateformats },
 396                 { "viewformats", md_viewformats }
 397         };
 398
 399         lex.pushTable(menutags, md_last - 1);
 400         if (lyxerr.debugging(Debug::PARSER))
 401                 lex.printTable(lyxerr);
 402
 403         bool quit = false;
 404         bool optional = false;
 405
 406         while (lex.isOK() && !quit) {
 407                 switch (lex.lex()) {
 408                 case md_optitem:
 409                         optional = true;
 410                         // fallback to md_item
 411                 case md_item: {
 412                         lex.next(true);
 413                         docstring const name = translateIfPossible(lex.getDocString());
 414                         lex.next(true);
 415                         string const command = lex.getString();
 416                         FuncRequest func = lyxaction.lookupFunc(command);
 417                         add(MenuItem(MenuItem::Command, toqstr(name), func, optional));
 418                         optional = false;
 419                         break;
 420                 }
 421
 422                 case md_separator:
 423                         add(MenuItem(MenuItem::Separator));
 424                         break;
 425
 426                 case md_lastfiles:
 427                         add(MenuItem(MenuItem::Lastfiles));
 428                         break;
 429
 430                 case md_charstyles:
 431                         add(MenuItem(MenuItem::CharStyles));
 432                         break;
 433
 434                 case md_custom:
 435                         add(MenuItem(MenuItem::Custom));
 436                         break;
 437
 438                 case md_elements:
 439                         add(MenuItem(MenuItem::Elements));
 440                         break;
 441
 442                 case md_documents:
 443                         add(MenuItem(MenuItem::Documents));
 444                         break;
 445
 446                 case md_bookmarks:
 447                         add(MenuItem(MenuItem::Bookmarks));
 448                         break;
 449
 450                 case md_toc:
 451                         add(MenuItem(MenuItem::Toc));
 452                         break;
 453
 454                 case md_viewformats:
 455                         add(MenuItem(MenuItem::ViewFormats));
 456                         break;
 457
 458                 case md_updateformats:
 459                         add(MenuItem(MenuItem::UpdateFormats));
 460                         break;
 461
 462                 case md_exportformats:
 463                         add(MenuItem(MenuItem::ExportFormats));
 464                         break;
 465
 466                 case md_importformats:
 467                         add(MenuItem(MenuItem::ImportFormats));
 468                         break;
 469
 470                 case md_floatlistinsert:
 471                         add(MenuItem(MenuItem::FloatListInsert));
 472                         break;
 473
 474                 case md_floatinsert:
 475                         add(MenuItem(MenuItem::FloatInsert));
 476                         break;
 477
 478                 case md_pasterecent:
 479                         add(MenuItem(MenuItem::PasteRecent));
 480                         break;
 481
 482                 case md_toolbars:
 483                         add(MenuItem(MenuItem::Toolbars));
 484                         break;
 485
 486                 case md_branches:
 487                         add(MenuItem(MenuItem::Branches));
 488                         break;
 489
 490                 case md_optsubmenu:
 491                         optional = true;
 492                         // fallback to md_submenu
 493                 case md_submenu: {
 494                         lex.next(true);
 495                         docstring const mlabel = translateIfPossible(lex.getDocString());
 496                         lex.next(true);
 497                         docstring const mname = lex.getDocString();
 498                         add(MenuItem(MenuItem::Submenu,
 499                                 toqstr(mlabel), toqstr(mname), optional));
 500                         optional = false;
 501                         break;
 502                 }
 503
 504                 case md_endmenu:
 505                         quit = true;
 506                         break;
 507
 508                 default:
 509                         lex.printError("Menu::read: "
 510                                        "Unknown menu tag: `$$Token'");
 511                         break;
 512                 }
 513         }
 514         lex.popTable();
 515 }
 516
 517
 518 MenuItem const & Menu::operator[](size_type i) const
 519 {
 520         return items_[i];
 521 }
 522
 523
 524 bool Menu::hasFunc(FuncRequest const & func) const
 525 {
 526         for (const_iterator it = begin(), et = end(); it != et; ++it)
 527                 if (it->func() == func)
 528                         return true;
 529         return false;
 530 }
 531
 532
 533 void Menu::checkShortcuts() const
 534 {
 535         // This is a quadratic algorithm, but we do not care because
 536         // menus are short enough
 537         for (const_iterator it1 = begin(); it1 != end(); ++it1) {
 538                 QString shortcut = it1->shortcut();
 539                 if (shortcut.isEmpty())
 540                         continue;
 541                 if (!it1->label().contains(shortcut))
 542                         lyxerr << "Menu warning: menu entry \""
 543                                << fromqstr(it1->label())
 544                                << "\" does not contain shortcut `"
 545                                << fromqstr(shortcut) << "'." << endl;
 546                 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
 547                         if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
 548                                 lyxerr << "Menu warning: menu entries "
 549                                        << '"' << fromqstr(it1->fulllabel())
 550                                        << "\" and \"" << fromqstr(it2->fulllabel())
 551                                        << "\" share the same shortcut."
 552                                        << endl;
 553                         }
 554                 }
 555         }
 556 }
 557
 558
 559 bool Menu::searchMenu(FuncRequest const & func, vector<docstring> & names) const
 560 {
 561         const_iterator m = begin();
 562         const_iterator m_end = end();
 563         for (; m != m_end; ++m) {
 564                 if (m->kind() == MenuItem::Command && m->func() == func) {
 565                         names.push_back(qstring_to_ucs4(m->label()));
 566                         return true;
 567                 }
 568                 if (m->kind() == MenuItem::Submenu) {
 569                         names.push_back(qstring_to_ucs4(m->label()));
 570                         Menu const & submenu = *m->submenu();
 571                         if (submenu.searchMenu(func, names))
 572                                 return true;
 573                         names.pop_back();
 574                 }
 575         }
 576         return false;
 577 }
 578
 579
 580 namespace {
 581
 582 bool compareFormat(Format const * p1, Format const * p2)
 583 {
 584         return *p1 < *p2;
 585 }
 586
 587
 588 QString limitStringLength(docstring const & str)
 589 {
 590         size_t const max_item_length = 45;
 591
 592         if (str.size() > max_item_length)
 593                 return toqstr(str.substr(0, max_item_length - 3) + "...");
 594
 595         return toqstr(str);
 596 }
 597
 598 } // namespace anon
 599
 600
 601 void Menu::expandLastfiles()
 602 {
 603         LastFilesSection::LastFiles const & lf = LyX::cref().session().lastFiles().lastFiles();
 604         LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
 605
 606         int ii = 1;
 607
 608         for (; lfit != lf.end() && ii < 10; ++lfit, ++ii) {
 609                 string const file = lfit->absFilename();
 610                 QString const label = QString("%1. %2|%3").arg(ii)
 611                         .arg(toqstr(makeDisplayPath(file, 30))).arg(ii);
 612                 add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, file)));
 613         }
 614 }
 615
 616
 617 void Menu::expandDocuments()
 618 {
 619         Buffer * first = theBufferList().first();
 620         if (first) {
 621                 Buffer * b = first;
 622                 int ii = 1;
 623
 624                 // We cannot use a for loop as the buffer list cycles.
 625                 do {
 626                         QString label = toqstr(b->fileName().displayName(20));
 627                         if (!b->isClean())
 628                                 label += "*";
 629                         if (ii < 10)
 630                                 label = QString::number(ii) + ". " + label + '|' + QString::number(ii);
 631                         add(MenuItem(MenuItem::Command, label,
 632                                 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
 633
 634                         b = theBufferList().next(b);
 635                         ++ii;
 636                 } while (b != first);
 637         } else {
 638                 add(MenuItem(MenuItem::Command, qt_("No Documents Open!"),
 639                            FuncRequest(LFUN_NOACTION)));
 640         }
 641 }
 642
 643
 644 void Menu::expandBookmarks()
 645 {
 646         lyx::BookmarksSection const & bm = LyX::cref().session().bookmarks();
 647
 648         for (size_t i = 1; i <= bm.size(); ++i) {
 649                 if (bm.isValid(i)) {
 650                         string const file = bm.bookmark(i).filename.absFilename();
 651                         QString const label = QString("%1. %2|%3").arg(i)
 652                                 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
 653                         add(MenuItem(MenuItem::Command, label,
 654                                 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
 655                 }
 656         }
 657 }
 658
 659
 660 void Menu::expandFormats(MenuItem::Kind kind, Buffer const * buf)
 661 {
 662         if (!buf && kind != MenuItem::ImportFormats) {
 663                 add(MenuItem(MenuItem::Command,
 664                                     qt_("No Document Open!"),
 665                                     FuncRequest(LFUN_NOACTION)));
 666                 return;
 667         }
 668
 669         typedef vector<Format const *> Formats;
 670         Formats formats;
 671         kb_action action;
 672
 673         switch (kind) {
 674         case MenuItem::ImportFormats:
 675                 formats = theConverters().importableFormats();
 676                 action = LFUN_BUFFER_IMPORT;
 677                 break;
 678         case MenuItem::ViewFormats:
 679                 formats = buf->exportableFormats(true);
 680                 action = LFUN_BUFFER_VIEW;
 681                 break;
 682         case MenuItem::UpdateFormats:
 683                 formats = buf->exportableFormats(true);
 684                 action = LFUN_BUFFER_UPDATE;
 685                 break;
 686         default:
 687                 formats = buf->exportableFormats(false);
 688                 action = LFUN_BUFFER_EXPORT;
 689         }
 690         sort(formats.begin(), formats.end(), &compareFormat);
 691
 692         Formats::const_iterator fit = formats.begin();
 693         Formats::const_iterator end = formats.end();
 694         for (; fit != end ; ++fit) {
 695                 if ((*fit)->dummy())
 696                         continue;
 697                 QString label = toqstr((*fit)->prettyname());
 698                 QString const shortcut = toqstr((*fit)->shortcut());
 699
 700                 switch (kind) {
 701                 case MenuItem::ImportFormats:
 702                         // FIXME: This is a hack, we should rather solve
 703                         // FIXME: bug 2488 instead.
 704                         if ((*fit)->name() == "text")
 705                                 label = qt_("Plain Text");
 706                         else if ((*fit)->name() == "textparagraph")
 707                                 label = qt_("Plain Text, Join Lines");
 708                         label += "...";
 709                         break;
 710                 case MenuItem::ViewFormats:
 711                 case MenuItem::ExportFormats:
 712                 case MenuItem::UpdateFormats:
 713                         if (!(*fit)->documentFormat())
 714                                 continue;
 715                         break;
 716                 default:
 717                         BOOST_ASSERT(false);
 718                         break;
 719                 }
 720                 // FIXME: if we had proper support for translating the
 721                 // format names defined in configure.py, there would
 722                 // not be a need to check whether the shortcut is
 723                 // correct. If we add it uncondiitonally, it would
 724                 // create useless warnings on bad shortcuts
 725                 if (!shortcut.isEmpty() && label.contains(shortcut))
 726                         label += '|' + shortcut;
 727
 728                 if (buf)
 729                         addWithStatusCheck(MenuItem(MenuItem::Command, label,
 730                                 FuncRequest(action, (*fit)->name())));
 731                 else
 732                         add(MenuItem(MenuItem::Command, label,
 733                                 FuncRequest(action, (*fit)->name())));
 734         }
 735 }
 736
 737
 738 void Menu::expandFloatListInsert(Buffer const * buf)
 739 {
 740         if (!buf) {
 741                 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
 742                                     FuncRequest(LFUN_NOACTION)));
 743                 return;
 744         }
 745
 746         FloatList const & floats = buf->params().documentClass().floats();
 747         FloatList::const_iterator cit = floats.begin();
 748         FloatList::const_iterator end = floats.end();
 749         for (; cit != end; ++cit) {
 750                 addWithStatusCheck(MenuItem(MenuItem::Command,
 751                                     qt_(cit->second.listName()),
 752                                     FuncRequest(LFUN_FLOAT_LIST,
 753                                                 cit->second.type())));
 754         }
 755 }
 756
 757
 758 void Menu::expandFloatInsert(Buffer const * buf)
 759 {
 760         if (!buf) {
 761                 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
 762                                     FuncRequest(LFUN_NOACTION)));
 763                 return;
 764         }
 765
 766         FloatList const & floats = buf->params().documentClass().floats();
 767         FloatList::const_iterator cit = floats.begin();
 768         FloatList::const_iterator end = floats.end();
 769         for (; cit != end; ++cit) {
 770                 // normal float
 771                 QString const label = qt_(cit->second.name());
 772                 addWithStatusCheck(MenuItem(MenuItem::Command, label,
 773                                     FuncRequest(LFUN_FLOAT_INSERT,
 774                                                 cit->second.type())));
 775         }
 776 }
 777
 778
 779 void Menu::expandFlexInsert(Buffer const * buf, string s)
 780 {
 781         if (!buf) {
 782                 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
 783                                     FuncRequest(LFUN_NOACTION)));
 784                 return;
 785         }
 786         TextClass::InsetLayouts const & insetLayouts =
 787                 buf->params().documentClass().insetLayouts();
 788         TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
 789         TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
 790         for (; cit != end; ++cit) {
 791                 docstring const label = cit->first;
 792                 if (cit->second.lyxtype() == s)
 793                         addWithStatusCheck(MenuItem(MenuItem::Command,
 794                                 toqstr(label), FuncRequest(LFUN_FLEX_INSERT,
 795                                                 label)));
 796         }
 797 }
 798
 799
 800 size_t const max_number_of_items = 25;
 801
 802 void Menu::expandToc2(Toc const & toc_list,
 803                 size_t from, size_t to, int depth)
 804 {
 805         int shortcut_count = 0;
 806
 807         // check whether depth is smaller than the smallest depth in toc.
 808         int min_depth = 1000;
 809         for (size_t i = from; i < to; ++i)
 810                 min_depth = min(min_depth, toc_list[i].depth());
 811         if (min_depth > depth)
 812                 depth = min_depth;
 813
 814         if (to - from <= max_number_of_items) {
 815                 for (size_t i = from; i < to; ++i) {
 816                         QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
 817                         label += limitStringLength(toc_list[i].str());
 818                         if (toc_list[i].depth() == depth
 819                             && shortcut_count < 9) {
 820                                 if (label.contains(QString::number(shortcut_count + 1)))
 821                                         label += '|' + QString::number(++shortcut_count);
 822                         }
 823                         add(MenuItem(MenuItem::Command, label,
 824                                             FuncRequest(toc_list[i].action())));
 825                 }
 826         } else {
 827                 size_t pos = from;
 828                 while (pos < to) {
 829                         size_t new_pos = pos + 1;
 830                         while (new_pos < to &&
 831                                toc_list[new_pos].depth() > depth)
 832                                 ++new_pos;
 833
 834                         QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
 835                         label += limitStringLength(toc_list[pos].str());
 836                         if (toc_list[pos].depth() == depth &&
 837                             shortcut_count < 9) {
 838                                 if (label.contains(QString::number(shortcut_count + 1)))
 839                                         label += '|' + QString::number(++shortcut_count);
 840                         }
 841                         if (new_pos == pos + 1) {
 842                                 add(MenuItem(MenuItem::Command,
 843                                                     label, FuncRequest(toc_list[pos].action())));
 844                         } else {
 845                                 MenuItem item(MenuItem::Submenu, label);
 846                                 item.setSubmenu(new Menu);
 847                                 item.submenu()->expandToc2(toc_list, pos, new_pos, depth + 1);
 848                                 add(item);
 849                         }
 850                         pos = new_pos;
 851                 }
 852         }
 853 }
 854
 855
 856 void Menu::expandToc(Buffer const * buf)
 857 {
 858         // To make things very cleanly, we would have to pass buf to
 859         // all MenuItem constructors and to expandToc2. However, we
 860         // know that all the entries in a TOC will be have status_ ==
 861         // OK, so we avoid this unnecessary overhead (JMarc)
 862
 863         if (!buf) {
 864                 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
 865                                     FuncRequest(LFUN_NOACTION)));
 866                 return;
 867         }
 868
 869         Buffer* cbuf = const_cast<Buffer*>(buf);
 870         cbuf->tocBackend().update();
 871         cbuf->structureChanged();
 872
 873         // Add an entry for the master doc if this is a child doc
 874         Buffer const * const master = buf->masterBuffer();
 875         if (buf != master) {
 876                 ParIterator const pit = par_iterator_begin(master->inset());
 877                 string const arg = convert<string>(pit->id());
 878                 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
 879                 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
 880         }
 881
 882         FloatList const & floatlist = buf->params().documentClass().floats();
 883         TocList const & toc_list = buf->tocBackend().tocs();
 884         TocList::const_iterator cit = toc_list.begin();
 885         TocList::const_iterator end = toc_list.end();
 886         for (; cit != end; ++cit) {
 887                 // Handle this later
 888                 if (cit->first == "tableofcontents")
 889                         continue;
 890
 891                 // All the rest is for floats
 892                 auto_ptr<Menu> menu(new Menu);
 893                 TocIterator ccit = cit->second.begin();
 894                 TocIterator eend = cit->second.end();
 895                 for (; ccit != eend; ++ccit) {
 896                         QString const label = limitStringLength(ccit->str());
 897                         menu->add(MenuItem(MenuItem::Command, label,
 898                                            FuncRequest(ccit->action())));
 899                 }
 900                 string const & floatName = floatlist.getType(cit->first).listName();
 901                 QString label;
 902                 if (!floatName.empty())
 903                         label = qt_(floatName);
 904                 // BUG3633: listings is not a proper float so its name
 905                 // is not shown in floatlist.
 906                 else if (cit->first == "equation")
 907                         label = qt_("List of Equations");
 908                 else if (cit->first == "index")
 909                         label = qt_("List of Indexes");
 910                 else if (cit->first == "listing")
 911                         label = qt_("List of Listings");
 912                 else if (cit->first == "marginalnote")
 913                         label = qt_("List of Marginal notes");
 914                 else if (cit->first == "note")
 915                         label = qt_("List of Notes");
 916                 else if (cit->first == "footnote")
 917                         label = qt_("List of Foot notes");
 918                 else if (cit->first == "label")
 919                         label = qt_("Labels and References");
 920                 else if (cit->first == "citation")
 921                         label = qt_("List of Citations");
 922                 // this should not happen now, but if something else like
 923                 // listings is added later, this can avoid an empty menu name.
 924                 else
 925                         label = qt_("Other floats");
 926                 MenuItem item(MenuItem::Submenu, label);
 927                 item.setSubmenu(menu.release());
 928                 add(item);
 929         }
 930
 931         // Handle normal TOC
 932         cit = toc_list.find("tableofcontents");
 933         if (cit == end) {
 934                 addWithStatusCheck(MenuItem(MenuItem::Command,
 935                                     qt_("No Table of contents"),
 936                                     FuncRequest()));
 937         } else {
 938                 expandToc2(cit->second, 0, cit->second.size(), 0);
 939         }
 940 }
 941
 942
 943 void Menu::expandPasteRecent()
 944 {
 945         vector<docstring> const sel = cap::availableSelections();
 946
 947         vector<docstring>::const_iterator cit = sel.begin();
 948         vector<docstring>::const_iterator end = sel.end();
 949
 950         for (unsigned int index = 0; cit != end; ++cit, ++index) {
 951                 add(MenuItem(MenuItem::Command, toqstr(*cit),
 952                                     FuncRequest(LFUN_PASTE, convert<string>(index))));
 953         }
 954 }
 955
 956
 957 void Menu::expandToolbars()
 958 {
 959         //
 960         // extracts the toolbars from the backend
 961         ToolbarBackend::Toolbars::const_iterator cit = toolbarbackend.begin();
 962         ToolbarBackend::Toolbars::const_iterator end = toolbarbackend.end();
 963
 964         for (; cit != end; ++cit) {
 965                 QString label = qt_(cit->gui_name);
 966                 // frontends are not supposed to turn on/off toolbars,
 967                 // if they cannot update ToolbarBackend::flags. That
 968                 // is to say, ToolbarsBackend::flags should reflect
 969                 // the true state of toolbars.
 970                 //
 971                 // menu is displayed as
 972                 //       on/off review
 973                 // and
 974                 //              review (auto)
 975                 // in the case of auto.
 976                 if (cit->flags & ToolbarInfo::AUTO)
 977                         label += qt_(" (auto)");
 978                 add(MenuItem(MenuItem::Command, label,
 979                                     FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name + " allowauto")));
 980         }
 981 }
 982
 983
 984 void Menu::expandBranches(Buffer const * buf)
 985 {
 986         if (!buf) {
 987                 add(MenuItem(MenuItem::Command,
 988                                     qt_("No Document Open!"),
 989                                     FuncRequest(LFUN_NOACTION)));
 990                 return;
 991         }
 992
 993         BufferParams const & params = buf->masterBuffer()->params();
 994         if (params.branchlist().empty()) {
 995                 add(MenuItem(MenuItem::Command,
 996                                     qt_("No Branch in Document!"),
 997                                     FuncRequest(LFUN_NOACTION)));
 998                 return;
 999         }
1000
1001         BranchList::const_iterator cit = params.branchlist().begin();
1002         BranchList::const_iterator end = params.branchlist().end();
1003
1004         for (int ii = 1; cit != end; ++cit, ++ii) {
1005                 docstring label = cit->getBranch();
1006                 if (ii < 10)
1007                         label = convert<docstring>(ii) + ". " + label + char_type('|') + convert<docstring>(ii);
1008                 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1009                                     FuncRequest(LFUN_BRANCH_INSERT,
1010                                                 cit->getBranch())));
1011         }
1012 }
1013
1014
1015 void Menus::expand(Menu const & frommenu, Menu & tomenu,
1016                          Buffer const * buf) const
1017 {
1018         if (!tomenu.empty())
1019                 tomenu.clear();
1020
1021         for (Menu::const_iterator cit = frommenu.begin();
1022              cit != frommenu.end() ; ++cit) {
1023                 switch (cit->kind()) {
1024                 case MenuItem::Lastfiles:
1025                         tomenu.expandLastfiles();
1026                         break;
1027
1028                 case MenuItem::Documents:
1029                         tomenu.expandDocuments();
1030                         break;
1031
1032                 case MenuItem::Bookmarks:
1033                         tomenu.expandBookmarks();
1034                         break;
1035
1036                 case MenuItem::ImportFormats:
1037                 case MenuItem::ViewFormats:
1038                 case MenuItem::UpdateFormats:
1039                 case MenuItem::ExportFormats:
1040                         tomenu.expandFormats(cit->kind(), buf);
1041                         break;
1042
1043                 case MenuItem::CharStyles:
1044                         tomenu.expandFlexInsert(buf, "charstyle");
1045                         break;
1046
1047                 case MenuItem::Custom:
1048                         tomenu.expandFlexInsert(buf, "custom");
1049                         break;
1050
1051                 case MenuItem::Elements:
1052                         tomenu.expandFlexInsert(buf, "element");
1053                         break;
1054
1055                 case MenuItem::FloatListInsert:
1056                         tomenu.expandFloatListInsert(buf);
1057                         break;
1058
1059                 case MenuItem::FloatInsert:
1060                         tomenu.expandFloatInsert(buf);
1061                         break;
1062
1063                 case MenuItem::PasteRecent:
1064                         tomenu.expandPasteRecent();
1065                         break;
1066
1067                 case MenuItem::Toolbars:
1068                         tomenu.expandToolbars();
1069                         break;
1070
1071                 case MenuItem::Branches:
1072                         tomenu.expandBranches(buf);
1073                         break;
1074
1075                 case MenuItem::Toc:
1076                         tomenu.expandToc(buf);
1077                         break;
1078
1079                 case MenuItem::Submenu: {
1080                         MenuItem item(*cit);
1081                         item.setSubmenu(new Menu(cit->submenuname()));
1082                         expand(getMenu(cit->submenuname()),
1083                                *item.submenu(), buf);
1084                         tomenu.addWithStatusCheck(item);
1085                 }
1086                 break;
1087
1088                 case MenuItem::Separator:
1089                         tomenu.addWithStatusCheck(*cit);
1090                         break;
1091
1092                 case MenuItem::Command:
1093                         if (!specialmenu_.hasFunc(cit->func()))
1094                                 tomenu.addWithStatusCheck(*cit);
1095                 }
1096         }
1097
1098         // we do not want the menu to end with a separator
1099         if (!tomenu.empty()
1100             && tomenu.items_.back().kind() == MenuItem::Separator)
1101                 tomenu.items_.pop_back();
1102
1103         // Check whether the shortcuts are unique
1104         tomenu.checkShortcuts();
1105 }
1106
1107
1108 void Menus::read(Lexer & lex)
1109 {
1110         enum Menutags {
1111                 md_menu = 1,
1112                 md_menubar,
1113                 md_endmenuset,
1114                 md_last
1115         };
1116
1117         struct keyword_item menutags[md_last - 1] = {
1118                 { "end", md_endmenuset },
1119                 { "menu", md_menu },
1120                 { "menubar", md_menubar }
1121         };
1122
1123         //consistency check
1124         if (compare_ascii_no_case(lex.getString(), "menuset")) {
1125                 lyxerr << "Menubackend::read: ERROR wrong token:`"
1126                        << lex.getString() << '\'' << endl;
1127         }
1128
1129         lex.pushTable(menutags, md_last - 1);
1130         if (lyxerr.debugging(Debug::PARSER))
1131                 lex.printTable(lyxerr);
1132
1133         bool quit = false;
1134
1135         while (lex.isOK() && !quit) {
1136                 switch (lex.lex()) {
1137                 case md_menubar:
1138                         menubar_.read(lex);
1139                         break;
1140                 case md_menu: {
1141                         lex.next(true);
1142                         QString const name = toqstr(lex.getDocString());
1143                         if (hasMenu(name)) {
1144                                 getMenu(name).read(lex);
1145                         } else {
1146                                 Menu menu(name);
1147                                 menu.read(lex);
1148                                 add(menu);
1149                         }
1150                         break;
1151                 }
1152                 case md_endmenuset:
1153                         quit = true;
1154                         break;
1155                 default:
1156                         lex.printError("menubackend::read: "
1157                                        "Unknown menu tag: `$$Token'");
1158                         break;
1159                 }
1160         }
1161         lex.popTable();
1162 }
1163
1164
1165 void Menus::add(Menu const & menu)
1166 {
1167         menulist_.push_back(menu);
1168 }
1169
1170
1171 bool Menus::hasMenu(QString const & name) const
1172 {
1173         return find_if(begin(), end(), MenuNamesEqual(name)) != end();
1174 }
1175
1176
1177 Menu const & Menus::getMenu(QString const & name) const
1178 {
1179         const_iterator cit = find_if(begin(), end(), MenuNamesEqual(name));
1180         if (cit == end())
1181                 lyxerr << "No submenu named " << fromqstr(name) << endl;
1182         BOOST_ASSERT(cit != end());
1183         return (*cit);
1184 }
1185
1186
1187 Menu & Menus::getMenu(QString const & name)
1188 {
1189         iterator it = find_if(begin(), end(), MenuNamesEqual(name));
1190         if (it == end())
1191                 lyxerr << "No submenu named " << fromqstr(name) << endl;
1192         BOOST_ASSERT(it != end());
1193         return (*it);
1194 }
1195
1196
1197 Menu const & Menus::getMenubar() const
1198 {
1199         return menubar_;
1200 }
1201
1202
1203 } // namespace frontend
1204 } // namespace lyx
1205
1206 #include "Menus_moc.cpp"