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 "GuiView.h"
  24 #include "GuiWorkArea.h"
  25 #include "qt_helpers.h"
  26
  27 #include "BiblioInfo.h"
  28 #include "BranchList.h"
  29 #include "Buffer.h"
  30 #include "BufferList.h"
  31 #include "BufferParams.h"
  32 #include "BufferView.h"
  33 #include "Converter.h"
  34 #include "CutAndPaste.h"
  35 #include "Floating.h"
  36 #include "FloatList.h"
  37 #include "Format.h"
  38 #include "FuncRequest.h"
  39 #include "FuncStatus.h"
  40 #include "IndicesList.h"
  41 #include "KeyMap.h"
  42 #include "Language.h"
  43 #include "Layout.h"
  44 #include "Lexer.h"
  45 #include "LyXAction.h"
  46 #include "LyX.h"
  47 #include "LyXRC.h"
  48 #include "lyxfind.h"
  49 #include "Paragraph.h"
  50 #include "ParagraphParameters.h"
  51 #include "ParIterator.h"
  52 #include "Session.h"
  53 #include "SpellChecker.h"
  54 #include "TextClass.h"
  55 #include "Text.h"
  56 #include "TocBackend.h"
  57 #include "Toolbars.h"
  58 #include "WordLangTuple.h"
  59
  60 #include "insets/Inset.h"
  61 #include "insets/InsetCitation.h"
  62 #include "insets/InsetGraphics.h"
  63
  64 #include "support/lassert.h"
  65 #include "support/convert.h"
  66 #include "support/debug.h"
  67 #include "support/docstring_list.h"
  68 #include "support/filetools.h"
  69 #include "support/gettext.h"
  70 #include "support/lstrings.h"
  71
  72 #include <QCursor>
  73 #include <QHash>
  74 #include <QList>
  75 #include <QMenuBar>
  76 #include <QString>
  77 #if QT_VERSION >= 0x040600
  78 #include <QProxyStyle>
  79 #endif
  80
  81 #include <algorithm>
  82 #include <memory>
  83 #include <vector>
  84
  85 using namespace std;
  86 using namespace lyx::support;
  87
  88
  89 namespace lyx {
  90 namespace frontend {
  91
  92 namespace {
  93
  94 // MacOSX specific stuff is at the end.
  95
  96 class MenuDefinition;
  97
  98 ///
  99 class MenuItem {
 100 public:
 101         /// The type of elements that can be in a menu
 102         enum Kind {
 103                 ///
 104                 Command,
 105                 ///
 106                 Submenu,
 107                 ///
 108                 Separator,
 109                 /** This type of item explains why something is unavailable. If this
 110                     menuitem is in a submenu, the submenu is enabled to make sure the
 111                     user sees the information. */
 112                 Help,
 113                 /** This type of item merely shows that there might be a list or
 114                     something alike at this position, but the list is still empty.
 115                     If this item is in a submenu, the submenu will not always be
 116                     enabled. */
 117                 Info,
 118                 /** This is the list of last opened file,
 119                     typically for the File menu. */
 120                 Lastfiles,
 121                 /** This is the list of opened Documents,
 122                     typically for the Documents menu. */
 123                 Documents,
 124                 /** This is the bookmarks */
 125                 Bookmarks,
 126                 ///
 127                 Toc,
 128                 /** This is a list of viewable formats
 129                     typically for the File->View menu. */
 130                 ViewFormats,
 131                 /** This is a list of updatable formats
 132                     typically for the File->Update menu. */
 133                 UpdateFormats,
 134                 /** This is a list of exportable formats
 135                     typically for the File->Export menu. */
 136                 ExportFormats,
 137                 /** This is a list of importable formats
 138                     typically for the File->Import menu. */
 139                 ImportFormats,
 140                 /** This is the list of elements available
 141                  * for insertion into document. */
 142                 CharStyles,
 143                 /** This is the list of user-configurable
 144                 insets to insert into document */
 145                 Custom,
 146                 /** This is the list of XML elements to
 147                 insert into the document */
 148                 Elements,
 149                 /** This is the list of floats that we can
 150                     insert a list for. */
 151                 FloatListInsert,
 152                 /** This is the list of floats that we can
 153                     insert. */
 154                 FloatInsert,
 155                 /** This is the list of selections that can
 156                     be pasted. */
 157                 PasteRecent,
 158                 /** toolbars */
 159                 Toolbars,
 160                 /** Available branches in document */
 161                 Branches,
 162                 /** Available indices in document */
 163                 Indices,
 164                 /** Context menu for indices in document */
 165                 IndicesContext,
 166                 /** Available index lists in document */
 167                 IndicesLists,
 168                 /** Context menu for available indices lists in document */
 169                 IndicesListsContext,
 170                 /** Available citation styles for a given citation */
 171                 CiteStyles,
 172                 /** Available graphics groups */
 173                 GraphicsGroups,
 174                 /// Words suggested by the spellchecker.
 175                 SpellingSuggestions,
 176                 /** Used Languages */
 177                 LanguageSelector,
 178                 /** This is the list of arguments available
 179                     for insertion into the current layout. */
 180                 Arguments,
 181                 /** This is the list of arguments available
 182                     in the InsetArgument context menu. */
 183                 SwitchArguments,
 184                 /** This is the list of captions available
 185                 in the current layout. */
 186                 Captions,
 187                 /** This is the list of captions available
 188                 in the InsetCaption context menu. */
 189                 SwitchCaptions,
 190                 /** Commands to separate environments. */
 191                 EnvironmentSeparators
 192         };
 193
 194         explicit MenuItem(Kind kind) : kind_(kind), optional_(false) {}
 195
 196         MenuItem(Kind kind,
 197                  QString const & label,
 198                  QString const & submenu = QString(),
 199                  QString const & tooltip = QString(),
 200                  bool optional = false)
 201                 : kind_(kind), label_(label), func_(make_shared<FuncRequest>()),
 202                   submenuname_(submenu), tooltip_(tooltip), optional_(optional)
 203         {
 204                 LATTEST(kind == Submenu || kind == Help || kind == Info);
 205         }
 206
 207         MenuItem(Kind kind,
 208                  QString const & label,
 209                  FuncRequest const & func,
 210                  QString const & tooltip = QString(),
 211                  bool optional = false,
 212                  FuncRequest::Origin origin = FuncRequest::MENU)
 213                 : kind_(kind), label_(label), func_(make_shared<FuncRequest>(func)),
 214                   tooltip_(tooltip), optional_(optional)
 215         {
 216                 func_->setOrigin(origin);
 217         }
 218
 219         /// The label of a given menuitem
 220         QString label() const
 221         {
 222                 int const index = label_.lastIndexOf('|');
 223                 return index == -1 ? label_ : label_.left(index);
 224         }
 225
 226         /// The keyboard shortcut (usually underlined in the entry)
 227         QString shortcut() const
 228         {
 229                 int const index = label_.lastIndexOf('|');
 230                 return index == -1 ? QString() : label_.mid(index + 1);
 231         }
 232         /// The complete label, with label and shortcut separated by a '|'
 233         QString fulllabel() const { return label_; }
 234         /// The kind of entry
 235         Kind kind() const { return kind_; }
 236         /// the action (if relevant)
 237         shared_ptr<FuncRequest const> func() const { return func_; }
 238         /// the tooltip
 239         QString const & tooltip() const { return tooltip_; }
 240         /// returns true if the entry should be omitted when disabled
 241         bool optional() const { return optional_; }
 242         /// returns the status of the lfun associated with this entry
 243         FuncStatus const & status() const { return status_; }
 244         /// returns the status of the lfun associated with this entry
 245         FuncStatus & status() { return status_; }
 246         /// returns the status of the lfun associated with this entry
 247         void status(FuncStatus const & status) { status_ = status; }
 248
 249         ///returns the binding associated to this action.
 250         QString binding() const
 251         {
 252                 if (kind_ != Command)
 253                         return QString();
 254                 // Get the keys bound to this action, but keep only the
 255                 // first one later
 256                 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(*func_);
 257                 if (!bindings.empty())
 258                         return toqstr(bindings.begin()->print(KeySequence::ForGui));
 259
 260                 LYXERR(Debug::KBMAP, "No binding for "
 261                         << lyxaction.getActionName(func_->action())
 262                         << '(' << func_->argument() << ')');
 263                 return QString();
 264         }
 265
 266         /// the description of the  submenu (if relevant)
 267         QString const & submenuname() const { return submenuname_; }
 268         /// set the description of the  submenu
 269         void submenuname(QString const & name) { submenuname_ = name; }
 270         ///
 271         bool hasSubmenu() const { return !submenu_.isEmpty(); }
 272         ///
 273         MenuDefinition const & submenu() const { return submenu_.at(0); }
 274         MenuDefinition & submenu() { return submenu_[0]; }
 275         ///
 276         void setSubmenu(MenuDefinition const & menu)
 277         {
 278                 submenu_.clear();
 279                 submenu_.append(menu);
 280         }
 281
 282 private:
 283         ///
 284         Kind kind_;
 285         ///
 286         QString label_;
 287         ///
 288         shared_ptr<FuncRequest> func_;// non-null
 289         ///
 290         QString submenuname_;
 291         ///
 292         QString tooltip_;
 293         ///
 294         bool optional_;
 295         ///
 296         FuncStatus status_;
 297         /// contains 0 or 1 item.
 298         QList<MenuDefinition> submenu_;
 299 };
 300
 301 ///
 302 class MenuDefinition {
 303 public:
 304         ///
 305         typedef std::vector<MenuItem> ItemList;
 306         ///
 307         typedef ItemList::const_iterator const_iterator;
 308         ///
 309         explicit MenuDefinition(QString const & name = QString()) : name_(name) {}
 310
 311         ///
 312         void read(Lexer &);
 313         ///
 314         QString const & name() const { return name_; }
 315         ///
 316         bool empty() const { return items_.empty(); }
 317         /// Clear the menu content.
 318         void clear() { items_.clear(); }
 319         ///
 320         size_t size() const { return items_.size(); }
 321         ///
 322         const_iterator begin() const { return items_.begin(); }
 323         ///
 324         const_iterator end() const { return items_.end(); }
 325         ///
 326         void cat(MenuDefinition const & other);
 327         ///
 328         void catSub(docstring const & name);
 329
 330         // search for func in this menu iteratively, and put menu
 331         // names in a stack.
 332         bool searchMenu(FuncRequest const & func, docstring_list & names)
 333                 const;
 334         ///
 335         bool hasFunc(FuncRequest const &) const;
 336         /// Add the menu item unconditionally
 337         void add(MenuItem const & item) { items_.push_back(item); }
 338         /// Checks the associated FuncRequest status before adding the
 339         /// menu item.
 340         void addWithStatusCheck(MenuItem const &);
 341         // Check whether the menu shortcuts are unique
 342         void checkShortcuts() const;
 343         ///
 344         void expandLastfiles();
 345         void expandDocuments();
 346         void expandBookmarks();
 347         void expandFormats(MenuItem::Kind const kind, Buffer const * buf);
 348         void expandFloatListInsert(Buffer const * buf);
 349         void expandFloatInsert(Buffer const * buf);
 350         void expandFlexInsert(Buffer const * buf, InsetLayout::InsetLyXType type);
 351         void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth, string toc_type);
 352         void expandToc(Buffer const * buf);
 353         void expandPasteRecent(Buffer const * buf);
 354         void expandToolbars();
 355         void expandBranches(Buffer const * buf);
 356         void expandIndices(Buffer const * buf, bool listof = false);
 357         void expandIndicesContext(Buffer const * buf, bool listof = false);
 358         void expandCiteStyles(BufferView const *);
 359         void expandGraphicsGroups(BufferView const *);
 360         void expandSpellingSuggestions(BufferView const *);
 361         void expandLanguageSelector(Buffer const * buf);
 362         void expandArguments(BufferView const *, bool switcharg = false);
 363         void expandCaptions(Buffer const * buf, bool switchcap = false);
 364         void expandEnvironmentSeparators(BufferView const *);
 365         ///
 366         ItemList items_;
 367         ///
 368         QString name_;
 369 };
 370
 371
 372 /// Helper for std::find_if
 373 class MenuNamesEqual
 374 {
 375 public:
 376         MenuNamesEqual(QString const & name) : name_(name) {}
 377         bool operator()(MenuDefinition const & menu) const { return menu.name() == name_; }
 378 private:
 379         QString name_;
 380 };
 381
 382
 383 ///
 384 typedef std::vector<MenuDefinition> MenuList;
 385 ///
 386 typedef MenuList::const_iterator const_iterator;
 387 ///
 388 typedef MenuList::iterator iterator;
 389
 390 /////////////////////////////////////////////////////////////////////
 391 // MenuDefinition implementation
 392 /////////////////////////////////////////////////////////////////////
 393
 394 void MenuDefinition::addWithStatusCheck(MenuItem const & i)
 395 {
 396         switch (i.kind()) {
 397
 398         case MenuItem::Command: {
 399                 FuncStatus status = lyx::getStatus(*i.func());
 400                 if (status.unknown() || (!status.enabled() && i.optional()))
 401                         break;
 402                 items_.push_back(i);
 403                 items_.back().status(status);
 404                 break;
 405         }
 406
 407         case MenuItem::Submenu: {
 408                 bool enabled = false;
 409                 if (i.hasSubmenu()) {
 410                         for (const_iterator cit = i.submenu().begin();
 411                                   cit != i.submenu().end(); ++cit) {
 412                                 // Only these kind of items affect the status of the submenu
 413                                 if ((cit->kind() == MenuItem::Command
 414                                      || cit->kind() == MenuItem::Submenu
 415                                      || cit->kind() == MenuItem::Help)
 416                                     && cit->status().enabled()) {
 417                                         enabled = true;
 418                                         break;
 419                                 }
 420                         }
 421                 }
 422                 if (enabled || !i.optional()) {
 423                         items_.push_back(i);
 424                         items_.back().status().setEnabled(enabled);
 425                 }
 426                 break;
 427         }
 428
 429         case MenuItem::Separator:
 430                 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
 431                         items_.push_back(i);
 432                 break;
 433
 434         default:
 435                 items_.push_back(i);
 436         }
 437 }
 438
 439
 440 void MenuDefinition::read(Lexer & lex)
 441 {
 442         enum {
 443                 md_item = 1,
 444                 md_branches,
 445                 md_citestyles,
 446                 md_documents,
 447                 md_bookmarks,
 448                 md_charstyles,
 449                 md_custom,
 450                 md_elements,
 451                 md_endmenu,
 452                 md_exportformats,
 453                 md_importformats,
 454                 md_indices,
 455                 md_indicescontext,
 456                 md_indiceslists,
 457                 md_indiceslistscontext,
 458                 md_lastfiles,
 459                 md_optitem,
 460                 md_optsubmenu,
 461                 md_separator,
 462                 md_submenu,
 463                 md_toc,
 464                 md_updateformats,
 465                 md_viewformats,
 466                 md_floatlistinsert,
 467                 md_floatinsert,
 468                 md_pasterecent,
 469                 md_toolbars,
 470                 md_graphicsgroups,
 471                 md_spellingsuggestions,
 472                 md_languageselector,
 473                 md_arguments,
 474                 md_switcharguments,
 475                 md_captions,
 476                 md_switchcaptions,
 477                 md_env_separators
 478         };
 479
 480         LexerKeyword menutags[] = {
 481                 { "arguments", md_arguments },
 482                 { "bookmarks", md_bookmarks },
 483                 { "branches", md_branches },
 484                 { "captions", md_captions },
 485                 { "charstyles", md_charstyles },
 486                 { "citestyles", md_citestyles },
 487                 { "custom", md_custom },
 488                 { "documents", md_documents },
 489                 { "elements", md_elements },
 490                 { "end", md_endmenu },
 491                 { "environmentseparators", md_env_separators },
 492                 { "exportformats", md_exportformats },
 493                 { "floatinsert", md_floatinsert },
 494                 { "floatlistinsert", md_floatlistinsert },
 495                 { "graphicsgroups", md_graphicsgroups },
 496                 { "importformats", md_importformats },
 497                 { "indices", md_indices },
 498                 { "indicescontext", md_indicescontext },
 499                 { "indiceslists", md_indiceslists },
 500                 { "indiceslistscontext", md_indiceslistscontext },
 501                 { "item", md_item },
 502                 { "languageselector", md_languageselector },
 503                 { "lastfiles", md_lastfiles },
 504                 { "optitem", md_optitem },
 505                 { "optsubmenu", md_optsubmenu },
 506                 { "pasterecent", md_pasterecent },
 507                 { "separator", md_separator },
 508                 { "spellingsuggestions", md_spellingsuggestions },
 509                 { "submenu", md_submenu },
 510                 { "switcharguments", md_switcharguments },
 511                 { "switchcaptions", md_switchcaptions },
 512                 { "toc", md_toc },
 513                 { "toolbars", md_toolbars },
 514                 { "updateformats", md_updateformats },
 515                 { "viewformats", md_viewformats }
 516         };
 517
 518         lex.pushTable(menutags);
 519         lex.setContext("MenuDefinition::read: ");
 520
 521         int md_type = 0;
 522         while (lex.isOK() && md_type != md_endmenu) {
 523                 switch (md_type = lex.lex()) {
 524                 case md_optitem:
 525                 case md_item: {
 526                         lex.next(true);
 527                         docstring const name = translateIfPossible(lex.getDocString());
 528                         lex.next(true);
 529                         string const command = lex.getString();
 530                         FuncRequest func = lyxaction.lookupFunc(command);
 531                         FuncRequest::Origin origin = FuncRequest::MENU;
 532                         if (name_.startsWith("context-toc-"))
 533                                 origin = FuncRequest::TOC;
 534                         bool const optional = (md_type == md_optitem);
 535                         add(MenuItem(MenuItem::Command, toqstr(name), func, QString(), optional, origin));
 536                         break;
 537                 }
 538
 539                 case md_separator:
 540                         add(MenuItem(MenuItem::Separator));
 541                         break;
 542
 543                 case md_lastfiles:
 544                         add(MenuItem(MenuItem::Lastfiles));
 545                         break;
 546
 547                 case md_charstyles:
 548                         add(MenuItem(MenuItem::CharStyles));
 549                         break;
 550
 551                 case md_custom:
 552                         add(MenuItem(MenuItem::Custom));
 553                         break;
 554
 555                 case md_elements:
 556                         add(MenuItem(MenuItem::Elements));
 557                         break;
 558
 559                 case md_documents:
 560                         add(MenuItem(MenuItem::Documents));
 561                         break;
 562
 563                 case md_bookmarks:
 564                         add(MenuItem(MenuItem::Bookmarks));
 565                         break;
 566
 567                 case md_toc:
 568                         add(MenuItem(MenuItem::Toc));
 569                         break;
 570
 571                 case md_viewformats:
 572                         add(MenuItem(MenuItem::ViewFormats));
 573                         break;
 574
 575                 case md_updateformats:
 576                         add(MenuItem(MenuItem::UpdateFormats));
 577                         break;
 578
 579                 case md_exportformats:
 580                         add(MenuItem(MenuItem::ExportFormats));
 581                         break;
 582
 583                 case md_importformats:
 584                         add(MenuItem(MenuItem::ImportFormats));
 585                         break;
 586
 587                 case md_floatlistinsert:
 588                         add(MenuItem(MenuItem::FloatListInsert));
 589                         break;
 590
 591                 case md_floatinsert:
 592                         add(MenuItem(MenuItem::FloatInsert));
 593                         break;
 594
 595                 case md_pasterecent:
 596                         add(MenuItem(MenuItem::PasteRecent));
 597                         break;
 598
 599                 case md_toolbars:
 600                         add(MenuItem(MenuItem::Toolbars));
 601                         break;
 602
 603                 case md_branches:
 604                         add(MenuItem(MenuItem::Branches));
 605                         break;
 606
 607                 case md_citestyles:
 608                         add(MenuItem(MenuItem::CiteStyles));
 609                         break;
 610
 611                 case md_graphicsgroups:
 612                         add(MenuItem(MenuItem::GraphicsGroups));
 613                         break;
 614
 615                 case md_spellingsuggestions:
 616                         add(MenuItem(MenuItem::SpellingSuggestions));
 617                         break;
 618
 619                 case md_languageselector:
 620                         add(MenuItem(MenuItem::LanguageSelector));
 621                         break;
 622
 623                 case md_indices:
 624                         add(MenuItem(MenuItem::Indices));
 625                         break;
 626
 627                 case md_indicescontext:
 628                         add(MenuItem(MenuItem::IndicesContext));
 629                         break;
 630
 631                 case md_indiceslists:
 632                         add(MenuItem(MenuItem::IndicesLists));
 633                         break;
 634
 635                 case md_indiceslistscontext:
 636                         add(MenuItem(MenuItem::IndicesListsContext));
 637                         break;
 638
 639                 case md_arguments:
 640                         add(MenuItem(MenuItem::Arguments));
 641                         break;
 642
 643                 case md_switcharguments:
 644                         add(MenuItem(MenuItem::SwitchArguments));
 645                         break;
 646
 647                 case md_captions:
 648                         add(MenuItem(MenuItem::Captions));
 649                         break;
 650
 651                 case md_switchcaptions:
 652                         add(MenuItem(MenuItem::SwitchCaptions));
 653                         break;
 654
 655                 case md_env_separators:
 656                         add(MenuItem(MenuItem::EnvironmentSeparators));
 657                         break;
 658
 659                 case md_optsubmenu:
 660                 case md_submenu: {
 661                         lex.next(true);
 662                         docstring const mlabel = translateIfPossible(lex.getDocString());
 663                         lex.next(true);
 664                         docstring const mname = lex.getDocString();
 665                         bool const optional = (md_type == md_optsubmenu);
 666                         add(MenuItem(MenuItem::Submenu,
 667                                 toqstr(mlabel), toqstr(mname), QString(), optional));
 668                         break;
 669                 }
 670
 671                 case md_endmenu:
 672                         break;
 673
 674                 default:
 675                         lex.printError("Unknown menu tag");
 676                         break;
 677                 }
 678         }
 679         lex.popTable();
 680 }
 681
 682
 683 bool MenuDefinition::hasFunc(FuncRequest const & func) const
 684 {
 685         for (const_iterator it = begin(), et = end(); it != et; ++it)
 686                 if (*it->func() == func)
 687                         return true;
 688         return false;
 689 }
 690
 691
 692 void MenuDefinition::catSub(docstring const & name)
 693 {
 694         add(MenuItem(MenuItem::Submenu,
 695                      qt_("More...|M"), toqstr(name), QString(), false));
 696 }
 697
 698 void MenuDefinition::cat(MenuDefinition const & other)
 699 {
 700         const_iterator et = other.end();
 701         for (const_iterator it = other.begin(); it != et; ++it)
 702                 add(*it);
 703 }
 704
 705
 706 void MenuDefinition::checkShortcuts() const
 707 {
 708         // This is a quadratic algorithm, but we do not care because
 709         // menus are short enough
 710         for (const_iterator it1 = begin(); it1 != end(); ++it1) {
 711                 QString shortcut = it1->shortcut();
 712                 if (shortcut.isEmpty())
 713                         continue;
 714                 if (!it1->label().contains(shortcut))
 715                         LYXERR0("Menu warning: menu entry \""
 716                                << it1->label()
 717                                << "\" does not contain shortcut `"
 718                                << shortcut << "'.");
 719                 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
 720                         if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
 721                                 LYXERR0("Menu warning: menu entries "
 722                                        << '"' << it1->fulllabel()
 723                                        << "\" and \"" << it2->fulllabel()
 724                                        << "\" share the same shortcut.");
 725                         }
 726                 }
 727         }
 728 }
 729
 730
 731 bool MenuDefinition::searchMenu(FuncRequest const & func, docstring_list & names) const
 732 {
 733         const_iterator m = begin();
 734         const_iterator m_end = end();
 735         for (; m != m_end; ++m) {
 736                 if (m->kind() == MenuItem::Command && *m->func() == func) {
 737                         names.push_back(qstring_to_ucs4(m->label()));
 738                         return true;
 739                 }
 740                 if (m->kind() == MenuItem::Submenu) {
 741                         names.push_back(qstring_to_ucs4(m->label()));
 742                         if (!m->hasSubmenu()) {
 743                                 LYXERR(Debug::GUI, "Warning: non existing sub menu label="
 744                                         << m->label() << " name=" << m->submenuname());
 745                                 names.pop_back();
 746                                 continue;
 747                         }
 748                         if (m->submenu().searchMenu(func, names))
 749                                 return true;
 750                         names.pop_back();
 751                 }
 752         }
 753         return false;
 754 }
 755
 756
 757 QString limitStringLength(docstring const & str)
 758 {
 759         size_t const max_item_length = 45;
 760         docstring ret = str.substr(0, max_item_length + 1);
 761         support::truncateWithEllipsis(ret, max_item_length);
 762         return toqstr(ret);
 763 }
 764
 765
 766 void MenuDefinition::expandGraphicsGroups(BufferView const * bv)
 767 {
 768         if (!bv)
 769                 return;
 770         set<string> grp;
 771         graphics::getGraphicsGroups(bv->buffer(), grp);
 772         if (grp.empty())
 773                 return;
 774
 775         set<string>::const_iterator it = grp.begin();
 776         set<string>::const_iterator end = grp.end();
 777         add(MenuItem(MenuItem::Command, qt_("No Group"),
 778                      FuncRequest(LFUN_SET_GRAPHICS_GROUP)));
 779         for (; it != end; ++it) {
 780                 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(*it) + '|',
 781                                 FuncRequest(LFUN_SET_GRAPHICS_GROUP, *it)));
 782         }
 783 }
 784
 785
 786 void MenuDefinition::expandSpellingSuggestions(BufferView const * bv)
 787 {
 788         if (!bv)
 789                 return;
 790         Cursor const & cur = bv->cursor();
 791         if (!cur.inTexted())
 792                 return;
 793         WordLangTuple wl;
 794         docstring_list suggestions;
 795         Paragraph const & par = cur.paragraph();
 796         pos_type from = cur.pos();
 797         pos_type to = from;
 798         SpellChecker::Result res = par.spellCheck(from, to, wl, suggestions, true, true);
 799         switch (res) {
 800         case SpellChecker::UNKNOWN_WORD:
 801                 if (lyxrc.spellcheck_continuously) {
 802                         LYXERR(Debug::GUI, "Misspelled Word! Suggested Words = ");
 803                         docstring const & selection = cur.selectionAsString(false);
 804                         if (!cur.selection() || selection == wl.word()) {
 805                                 size_t i = 0;
 806                                 size_t m = 10; // first submenu index
 807                                 MenuItem item(MenuItem::Submenu, qt_("More Spelling Suggestions"));
 808                                 item.setSubmenu(MenuDefinition(qt_("More Spelling Suggestions")));
 809                                 for (; i != suggestions.size(); ++i) {
 810                                         docstring const & suggestion = suggestions[i];
 811                                         LYXERR(Debug::GUI, suggestion);
 812                                         MenuItem w(MenuItem::Command, toqstr(suggestion),
 813                                                 FuncRequest(LFUN_WORD_REPLACE,
 814                                                         replace2string(suggestion, selection,
 815                                                                 true,     // case sensitive
 816                                                                 true,     // match word
 817                                                                 false,    // all words
 818                                                                 true,     // forward
 819                                                                 false))); // find next
 820                                         if (i < m)
 821                                                 add(w);
 822                                         else
 823                                                 item.submenu().add(w);
 824                                 }
 825                                 if (i > m)
 826                                         add(item);
 827                                 if (i > 0)
 828                                         add(MenuItem(MenuItem::Separator));
 829                                 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
 830                                 add(MenuItem(MenuItem::Command, qt_("Add to personal dictionary|n"),
 831                                                 FuncRequest(LFUN_SPELLING_ADD, arg)));
 832                                 add(MenuItem(MenuItem::Command, qt_("Ignore all|I"),
 833                                                 FuncRequest(LFUN_SPELLING_IGNORE, arg)));
 834                         }
 835                 }
 836                 break;
 837         case SpellChecker::LEARNED_WORD: {
 838                         LYXERR(Debug::GUI, "Learned Word.");
 839                         docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
 840                         add(MenuItem(MenuItem::Command, qt_("Remove from personal dictionary|r"),
 841                                         FuncRequest(LFUN_SPELLING_REMOVE, arg)));
 842                 }
 843                 break;
 844         case SpellChecker::NO_DICTIONARY:
 845                 LYXERR(Debug::GUI, "No dictionary for language " + from_ascii(wl.lang()->lang()));
 846                 // FALLTHROUGH
 847         case SpellChecker::WORD_OK:
 848         case SpellChecker::COMPOUND_WORD:
 849         case SpellChecker::ROOT_FOUND:
 850         case SpellChecker::IGNORED_WORD:
 851                 break;
 852         }
 853 }
 854
 855 struct sortLanguageByName {
 856         bool operator()(const Language * a, const Language * b) const {
 857                 return qt_(a->display()).localeAwareCompare(qt_(b->display())) < 0;
 858         }
 859 };
 860
 861 void MenuDefinition::expandLanguageSelector(Buffer const * buf)
 862 {
 863         if (!buf)
 864                 return;
 865
 866         std::set<Language const *> languages_buffer =
 867                 buf->masterBuffer()->getLanguages();
 868
 869         if (languages_buffer.size() < 2)
 870                 return;
 871
 872         std::set<Language const *, sortLanguageByName> languages;
 873
 874         std::set<Language const *>::const_iterator const beg =
 875                 languages_buffer.begin();
 876         for (std::set<Language const *>::const_iterator cit = beg;
 877              cit != languages_buffer.end(); ++cit) {
 878                 languages.insert(*cit);
 879         }
 880
 881         MenuItem item(MenuItem::Submenu, qt_("Language|L"));
 882         item.setSubmenu(MenuDefinition(qt_("Language")));
 883         QString morelangs = qt_("More Languages ...|M");
 884         QStringList accelerators;
 885         if (morelangs.contains('|'))
 886                 accelerators.append(morelangs.section('|', -1));
 887         std::set<Language const *, sortLanguageByName>::const_iterator const begin = languages.begin();
 888         for (std::set<Language const *, sortLanguageByName>::const_iterator cit = begin;
 889              cit != languages.end(); ++cit) {
 890                 QString label = qt_((*cit)->display());
 891                 // try to add an accelerator
 892                 bool success = false;
 893                 // try capitals first
 894                 for (int i = 0; i < label.size(); ++i) {
 895                         QChar const ch = label[i];
 896                         if (!ch.isUpper())
 897                                 continue;
 898                         if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
 899                                 label = label + toqstr("|") + ch;
 900                                 accelerators.append(ch);
 901                                 success = true;
 902                                 break;
 903                         }
 904                 }
 905                 // if all capitals are taken, try the rest
 906                 if (!success) {
 907                         for (int i = 0; i < label.size(); ++i) {
 908                                 if (label[i].isSpace())
 909                                         continue;
 910                                 QString const ch = QString(label[i]);
 911                                 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
 912                                         label = label + toqstr("|") + ch;
 913                                         accelerators.append(ch);
 914                                         break;
 915                                 }
 916                         }
 917                 }
 918                 MenuItem w(MenuItem::Command, label,
 919                         FuncRequest(LFUN_LANGUAGE, (*cit)->lang() + " set"));
 920                 item.submenu().addWithStatusCheck(w);
 921         }
 922         item.submenu().add(MenuItem(MenuItem::Separator));
 923         item.submenu().add(MenuItem(MenuItem::Command, morelangs,
 924                         FuncRequest(LFUN_DIALOG_SHOW, "character")));
 925         add(item);
 926 }
 927
 928
 929 void MenuDefinition::expandLastfiles()
 930 {
 931         LastFilesSection::LastFiles const & lf = theSession().lastFiles().lastFiles();
 932         LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
 933
 934         unsigned int ii = 1;
 935
 936         for (; lfit != lf.end() && ii <= lyxrc.num_lastfiles; ++lfit, ++ii) {
 937                 string const file = lfit->absFileName();
 938                 QString const short_path = toqstr(makeDisplayPath(file, 30));
 939                 QString const long_path = toqstr(makeDisplayPath(file));
 940                 QString label;
 941                 if (ii < 10)
 942                         label = QString("%1. %2|%3").arg(ii).arg(short_path).arg(ii);
 943                 else
 944                         label = QString("%1. %2").arg(ii).arg(short_path);
 945                 add(MenuItem(MenuItem::Command, label,
 946                         FuncRequest(LFUN_FILE_OPEN, file), long_path));
 947         }
 948 }
 949
 950
 951 void MenuDefinition::expandDocuments()
 952 {
 953         MenuItem item(MenuItem::Submenu, qt_("Hidden|H"));
 954         item.setSubmenu(MenuDefinition(qt_("Hidden|H")));
 955
 956         Buffer * first = theBufferList().first();
 957         if (!first) {
 958                 add(MenuItem(MenuItem::Info, qt_("<No Documents Open>")));
 959                 return;
 960         }
 961
 962         int i = 0;
 963         while (true) {
 964                 if (!guiApp->currentView())
 965                         break;
 966                 GuiWorkArea * wa = guiApp->currentView()->workArea(i);
 967                 if (!wa)
 968                         break;
 969                 Buffer const & b = wa->bufferView().buffer();
 970                 QString label = toqstr(b.fileName().displayName(20));
 971                 if (!b.isClean())
 972                         label += "*";
 973                 if (i < 10)
 974                         label = QString::number(i) + ". " + label + '|' + QString::number(i);
 975                 add(MenuItem(MenuItem::Command, label,
 976                         FuncRequest(LFUN_BUFFER_SWITCH, b.absFileName())));
 977                 ++i;
 978         }
 979
 980
 981         i = 0;
 982         Buffer * b = first;
 983         // We cannot use a for loop as the buffer list cycles.
 984         do {
 985                 if (!(guiApp->currentView()
 986                     && guiApp->currentView()->workArea(*b))) {
 987                         QString label = toqstr(b->fileName().displayName(20));
 988                         if (!b->isClean())
 989                                 label += "*";
 990                         if (i < 10)
 991                                 label = QString::number(i) + ". " + label + '|' + QString::number(i);
 992                         item.submenu().add(MenuItem(MenuItem::Command, label,
 993                                 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
 994                         ++i;
 995                 }
 996                 b = theBufferList().next(b);
 997         } while (b != first);
 998
 999         if (!item.submenu().empty())
1000                 add(item);
1001 }
1002
1003
1004 void MenuDefinition::expandBookmarks()
1005 {
1006         lyx::BookmarksSection const & bm = theSession().bookmarks();
1007
1008         bool empty = true;
1009         for (size_t i = 1; i <= bm.size(); ++i) {
1010                 if (bm.isValid(i)) {
1011                         string const file = bm.bookmark(i).filename.absFileName();
1012                         QString const label = QString("%1. %2|%3").arg(i)
1013                                 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
1014                         add(MenuItem(MenuItem::Command, label,
1015                                 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
1016                         empty = false;
1017                 }
1018         }
1019         if (empty)
1020                 add(MenuItem(MenuItem::Info, qt_("<No Bookmarks Saved Yet>")));
1021 }
1022
1023
1024 void MenuDefinition::expandFormats(MenuItem::Kind const kind, Buffer const * buf)
1025 {
1026         if (!buf && kind != MenuItem::ImportFormats)
1027                 return;
1028
1029         FormatList formats;
1030         FuncCode action = LFUN_NOACTION;
1031
1032         switch (kind) {
1033         case MenuItem::ImportFormats:
1034                 formats = theConverters().importableFormats();
1035                 action = LFUN_BUFFER_IMPORT;
1036                 break;
1037         case MenuItem::ViewFormats:
1038                 formats = buf->params().exportableFormats(true);
1039                 action = LFUN_BUFFER_VIEW;
1040                 break;
1041         case MenuItem::UpdateFormats:
1042                 formats = buf->params().exportableFormats(true);
1043                 action = LFUN_BUFFER_UPDATE;
1044                 break;
1045         case MenuItem::ExportFormats:
1046                 formats = buf->params().exportableFormats(false);
1047                 action = LFUN_BUFFER_EXPORT;
1048                 break;
1049         default:
1050                 LATTEST(false);
1051                 return;
1052         }
1053
1054         bool const view_update = (kind == MenuItem::ViewFormats
1055                         || kind == MenuItem::UpdateFormats);
1056
1057         QString smenue;
1058         if (view_update)
1059                 smenue = (kind == MenuItem::ViewFormats
1060                         ? qt_("View (Other Formats)|F")
1061                         : qt_("Update (Other Formats)|p"));
1062         MenuItem item(MenuItem::Submenu, smenue);
1063         item.setSubmenu(MenuDefinition(smenue));
1064
1065         for (Format const * f : formats) {
1066                 if (f->dummy())
1067                         continue;
1068
1069                 docstring lab = f->prettyname();
1070                 docstring const scut = from_utf8(f->shortcut());
1071                 docstring const tmplab = lab;
1072
1073                 if (!scut.empty())
1074                         lab += char_type('|') + scut;
1075                 docstring const lab_i18n = translateIfPossible(lab);
1076                 docstring const shortcut = split(lab_i18n, lab, '|');
1077
1078                 bool const untranslated = (lab == lab_i18n);
1079                 docstring label = untranslated ? translateIfPossible(tmplab) : lab;
1080
1081                 switch (kind) {
1082                 case MenuItem::ImportFormats:
1083                         label += from_ascii("...");
1084                         break;
1085                 case MenuItem::ViewFormats:
1086                 case MenuItem::UpdateFormats:
1087                         if (f->name() == buf->params().getDefaultOutputFormat()) {
1088                                 docstring lbl = (kind == MenuItem::ViewFormats
1089                                         ? bformat(_("View [%1$s]|V"), label)
1090                                         : bformat(_("Update [%1$s]|U"), label));
1091                                 add(MenuItem(MenuItem::Command, toqstr(lbl), FuncRequest(action)));
1092                                 continue;
1093                         }
1094                 // fall through
1095                 case MenuItem::ExportFormats:
1096                         if (!f->inExportMenu())
1097                                 continue;
1098                         break;
1099                 default:
1100                         // we already asserted earlier in this case
1101                         // LATTEST(false);
1102                         continue;
1103                 }
1104                 if (!shortcut.empty())
1105                         label += '|' + shortcut;
1106
1107                 if (view_update) {
1108                         // note that at this point, we know that buf is not null
1109                         LATTEST(buf);
1110                         item.submenu().addWithStatusCheck(MenuItem(MenuItem::Command,
1111                                 toqstr(label), FuncRequest(action, f->name())));
1112                 } else {
1113                         if (buf)
1114                                 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1115                                         FuncRequest(action, f->name())));
1116                         else
1117                                 add(MenuItem(MenuItem::Command, toqstr(label),
1118                                         FuncRequest(action, f->name())));
1119                 }
1120         }
1121         if (view_update)
1122                 add(item);
1123 }
1124
1125
1126 void MenuDefinition::expandFloatListInsert(Buffer const * buf)
1127 {
1128         if (!buf)
1129                 return;
1130
1131         FloatList const & floats = buf->params().documentClass().floats();
1132         FloatList::const_iterator cit = floats.begin();
1133         FloatList::const_iterator end = floats.end();
1134         set<string> seen;
1135         for (; cit != end; ++cit) {
1136                 if (!cit->second.usesFloatPkg()) {
1137                         // Different floats could declare the same ListCommand. We only
1138                         // want it on the list once, though.
1139                         string const & list_cmd = cit->second.listCommand();
1140                         if (list_cmd.empty())
1141                                 // we do not know how to generate such a list
1142                                 continue;
1143                         // This form of insert returns an iterator pointing to the newly
1144                         // inserted element OR the existing element with that value, and
1145                         // a bool indicating whether we inserted a new element. So we can
1146                         // see if one is there and insert it if not all at once.
1147                         pair<set<string>::iterator, bool> ret = seen.insert(list_cmd);
1148                         if (!ret.second)
1149                                 continue;
1150                 }
1151                 string const & list_name = cit->second.listName();
1152                 addWithStatusCheck(MenuItem(MenuItem::Command, qt_(list_name),
1153                         FuncRequest(LFUN_FLOAT_LIST_INSERT, cit->second.floattype())));
1154         }
1155 }
1156
1157
1158 void MenuDefinition::expandFloatInsert(Buffer const * buf)
1159 {
1160         if (!buf)
1161                 return;
1162
1163         FloatList const & floats = buf->params().documentClass().floats();
1164         FloatList::const_iterator cit = floats.begin();
1165         FloatList::const_iterator end = floats.end();
1166         for (; cit != end; ++cit) {
1167                 // normal float
1168                 QString const label = qt_(cit->second.name());
1169                 addWithStatusCheck(MenuItem(MenuItem::Command, label,
1170                                     FuncRequest(LFUN_FLOAT_INSERT,
1171                                                 cit->second.floattype())));
1172         }
1173 }
1174
1175
1176 void MenuDefinition::expandFlexInsert(
1177                 Buffer const * buf, InsetLayout::InsetLyXType type)
1178 {
1179         if (!buf)
1180                 return;
1181
1182         TextClass::InsetLayouts const & insetLayouts =
1183                 buf->params().documentClass().insetLayouts();
1184         TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
1185         TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
1186         for (; cit != end; ++cit) {
1187                 if (cit->second.lyxtype() == type) {
1188                         if (!cit->second.obsoleted_by().empty())
1189                                 continue;
1190                         docstring label = cit->first;
1191                         // we remove the "Flex:" prefix, if it is present
1192                         if (prefixIs(label, from_ascii("Flex:")))
1193                                 label = label.substr(5);
1194                         addWithStatusCheck(MenuItem(MenuItem::Command,
1195                                 toqstr(translateIfPossible(label)),
1196                                 FuncRequest(LFUN_FLEX_INSERT, Lexer::quoteString(label))));
1197                 }
1198         }
1199         // FIXME This is a little clunky.
1200         if (items_.empty() && type == InsetLayout::CUSTOM && !buf->isReadonly())
1201                 add(MenuItem(MenuItem::Help, qt_("No Custom Insets Defined!")));
1202 }
1203
1204
1205 // Threshold before we stop displaying sub-items alongside items
1206 // (for display purposes). Ideally this should fit on a screen.
1207 size_t const max_number_of_items = 30;
1208 // Size limit for the menu. This is for performance purposes,
1209 // because qt already displays a scrollable menu when necessary.
1210 // Ideally this should be the menu size from which scrollable
1211 // menus become unpractical.
1212 size_t const menu_size_limit = 80;
1213
1214 void MenuDefinition::expandToc2(Toc const & toc_list,
1215                                 size_t from, size_t to, int depth,
1216                                 string toc_type)
1217 {
1218         int shortcut_count = 0;
1219
1220         // check whether depth is smaller than the smallest depth in toc.
1221         int min_depth = 1000;
1222         for (size_t i = from; i < to; ++i)
1223                 min_depth = min(min_depth, toc_list[i].depth());
1224         if (min_depth > depth)
1225                 depth = min_depth;
1226
1227         if (to - from <= max_number_of_items) {
1228                 for (size_t i = from; i < to; ++i) {
1229                         QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
1230                         label += limitStringLength(toc_list[i].asString());
1231                         if (toc_list[i].depth() == depth) {
1232                                 label += '|';
1233                             if (shortcut_count < 9) {
1234                                         if (label.contains(QString::number(shortcut_count + 1)))
1235                                                 label += QString::number(++shortcut_count);
1236                                 }
1237                         }
1238                         add(MenuItem(MenuItem::Command, label,
1239                                             FuncRequest(toc_list[i].action())));
1240                         // separator after the menu heading
1241                         if (toc_list[i].depth() < depth)
1242                                 add(MenuItem(MenuItem::Separator));
1243                 }
1244         } else {
1245                 size_t pos = from;
1246                 size_t size = 1;
1247                 while (pos < to) {
1248                         size_t new_pos = pos + 1;
1249                         while (new_pos < to && toc_list[new_pos].depth() > depth)
1250                                 ++new_pos;
1251
1252                         QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
1253                         label += limitStringLength(toc_list[pos].asString());
1254                         if (toc_list[pos].depth() == depth) {
1255                                 label += '|';
1256                             if (shortcut_count < 9) {
1257                                         if (label.contains(QString::number(shortcut_count + 1)))
1258                                                 label += QString::number(++shortcut_count);
1259                                 }
1260                         }
1261                         if (size >= menu_size_limit) {
1262                                 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + toc_type);
1263                                 add(MenuItem(MenuItem::Command, "...", f));
1264                                 break;
1265                         }
1266                         if (new_pos == pos + 1) {
1267                                 add(MenuItem(MenuItem::Command,
1268                                                     label, FuncRequest(toc_list[pos].action())));
1269                         } else {
1270                                 MenuDefinition sub;
1271                                 sub.expandToc2(toc_list, pos, new_pos, depth + 1, toc_type);
1272                                 MenuItem item(MenuItem::Submenu, label);
1273                                 item.setSubmenu(sub);
1274                                 add(item);
1275                         }
1276                         ++size;
1277                         pos = new_pos;
1278                 }
1279         }
1280 }
1281
1282
1283 void MenuDefinition::expandToc(Buffer const * buf)
1284 {
1285         // To make things very cleanly, we would have to pass buf to
1286         // all MenuItem constructors and to expandToc2. However, we
1287         // know that all the entries in a TOC will be have status_ ==
1288         // OK, so we avoid this unnecessary overhead (JMarc)
1289         if (!buf) {
1290                 add(MenuItem(MenuItem::Info, qt_("(No Document Open)")));
1291                 return;
1292         }
1293         // Add an entry for the master doc if this is a child doc
1294         Buffer const * const master = buf->masterBuffer();
1295         if (buf != master) {
1296                 ParIterator const pit = par_iterator_begin(master->inset());
1297                 string const arg = convert<string>(pit->id());
1298                 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
1299                 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
1300         }
1301
1302         MenuDefinition other_lists;
1303         FloatList const & floatlist = buf->params().documentClass().floats();
1304         TocList const & toc_list = buf->tocBackend().tocs();
1305         TocList::const_iterator cit = toc_list.begin();
1306         TocList::const_iterator end = toc_list.end();
1307         for (; cit != end; ++cit) {
1308                 // Handle table of contents later
1309                 if (cit->first == "tableofcontents" || cit->second->empty())
1310                         continue;
1311                 MenuDefinition submenu;
1312                 // "Open outliner..." entry
1313                 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + cit->first);
1314                 submenu.add(MenuItem(MenuItem::Command, qt_("Open Outliner..."), f));
1315                 submenu.add(MenuItem(MenuItem::Separator));
1316                 // add entries
1317                 submenu.expandToc2(*cit->second, 0, cit->second->size(), 0, cit->first);
1318                 MenuItem item(MenuItem::Submenu, guiName(cit->first, buf->params()));
1319                 item.setSubmenu(submenu);
1320                 // deserves to be in the main menu?
1321                 if (floatlist.typeExist(cit->first) || cit->first == "child")
1322                         add(item);
1323                 else
1324                         other_lists.add(item);
1325         }
1326         if (!other_lists.empty()) {
1327                 MenuItem item(MenuItem::Submenu, qt_("Other Lists"));
1328                 item.setSubmenu(other_lists);
1329                 add(item);
1330         }
1331         // Handle normal TOC
1332         add(MenuItem(MenuItem::Separator));
1333         cit = toc_list.find("tableofcontents");
1334         if (cit == end)
1335                 LYXERR(Debug::GUI, "No table of contents.");
1336         else {
1337                 if (!cit->second->empty())
1338                         expandToc2(*cit->second, 0, cit->second->size(), 0,
1339                                    "tableofcontents");
1340                 else
1341                         add(MenuItem(MenuItem::Info, qt_("(Empty Table of Contents)")));
1342         }
1343 }
1344
1345
1346 void MenuDefinition::expandPasteRecent(Buffer const * buf)
1347 {
1348         docstring_list const sel = cap::availableSelections(buf);
1349
1350         docstring_list::const_iterator cit = sel.begin();
1351         docstring_list::const_iterator end = sel.end();
1352
1353         for (unsigned int index = 0; cit != end; ++cit, ++index) {
1354                 add(MenuItem(MenuItem::Command, toqstr(*cit) + '|',
1355                                     FuncRequest(LFUN_PASTE, convert<string>(index))));
1356         }
1357 }
1358
1359
1360 void MenuDefinition::expandToolbars()
1361 {
1362         MenuDefinition other_lists;
1363         // extracts the toolbars from the backend
1364         Toolbars::Infos::const_iterator cit = guiApp->toolbars().begin();
1365         Toolbars::Infos::const_iterator end = guiApp->toolbars().end();
1366         for (; cit != end; ++cit) {
1367                 MenuItem const item(MenuItem::Command, toqstr(cit->gui_name),
1368                                 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name));
1369                 if (guiApp->toolbars().isMainToolbar(cit->name))
1370                         add(item);
1371                 else
1372                         other_lists.add(item);
1373         }
1374
1375         if (!other_lists.empty()) {
1376                 MenuItem item(MenuItem::Submenu, qt_("Other Toolbars"));
1377                 item.setSubmenu(other_lists);
1378                 add(item);
1379         }
1380 }
1381
1382
1383 void MenuDefinition::expandBranches(Buffer const * buf)
1384 {
1385         if (!buf || buf->isReadonly())
1386                 return;
1387
1388         BufferParams const & master_params = buf->masterBuffer()->params();
1389         BufferParams const & params = buf->params();
1390         if (params.branchlist().empty() && master_params.branchlist().empty() ) {
1391                 add(MenuItem(MenuItem::Help, qt_("No Branches Set for Document!")));
1392                 return;
1393         }
1394
1395         BranchList::const_iterator cit = master_params.branchlist().begin();
1396         BranchList::const_iterator end = master_params.branchlist().end();
1397
1398         for (int ii = 1; cit != end; ++cit, ++ii) {
1399                 docstring label = cit->branch();
1400                 if (ii < 10) {
1401                         label = convert<docstring>(ii) + ". " + label
1402                                 + char_type('|') + convert<docstring>(ii);
1403                 }
1404                 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1405                                     FuncRequest(LFUN_BRANCH_INSERT,
1406                                                 cit->branch())));
1407         }
1408
1409         if (buf == buf->masterBuffer())
1410                 return;
1411
1412         MenuDefinition child_branches;
1413
1414         BranchList::const_iterator ccit = params.branchlist().begin();
1415         BranchList::const_iterator cend = params.branchlist().end();
1416
1417         for (int ii = 1; ccit != cend; ++ccit, ++ii) {
1418                 docstring label = ccit->branch();
1419                 if (ii < 10) {
1420                         label = convert<docstring>(ii) + ". " + label
1421                                 + char_type('|') + convert<docstring>(ii);
1422                 } else
1423                         label += char_type('|');
1424                 child_branches.addWithStatusCheck(MenuItem(MenuItem::Command,
1425                                     toqstr(label),
1426                                     FuncRequest(LFUN_BRANCH_INSERT,
1427                                                 ccit->branch())));
1428         }
1429
1430         if (!child_branches.empty()) {
1431                 MenuItem item(MenuItem::Submenu, qt_("Child Document"));
1432                 item.setSubmenu(child_branches);
1433                 add(item);
1434         }
1435 }
1436
1437
1438 void MenuDefinition::expandIndices(Buffer const * buf, bool listof)
1439 {
1440         if (!buf)
1441                 return;
1442
1443         BufferParams const & params = buf->masterBuffer()->params();
1444         if (!params.use_indices) {
1445                 if (listof)
1446                         addWithStatusCheck(MenuItem(MenuItem::Command,
1447                                            qt_("Index List|I"),
1448                                            FuncRequest(LFUN_INDEX_PRINT,
1449                                                   from_ascii("idx"))));
1450                 else
1451                         addWithStatusCheck(MenuItem(MenuItem::Command,
1452                                            qt_("Index Entry|d"),
1453                                            FuncRequest(LFUN_INDEX_INSERT,
1454                                                   from_ascii("idx"))));
1455                 return;
1456         }
1457
1458         if (params.indiceslist().empty())
1459                 return;
1460
1461         IndicesList::const_iterator cit = params.indiceslist().begin();
1462         IndicesList::const_iterator end = params.indiceslist().end();
1463
1464         for (int ii = 1; cit != end; ++cit, ++ii) {
1465                 if (listof) {
1466                         docstring const label =
1467                                 bformat(_("Index: %1$s"), cit->index());
1468                         addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1469                                            FuncRequest(LFUN_INDEX_PRINT, cit->shortcut())));
1470                 } else {
1471                         docstring const label =
1472                                 bformat(_("Index Entry (%1$s)"), cit->index());
1473                         addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1474                                            FuncRequest(LFUN_INDEX_INSERT, cit->shortcut())));
1475                 }
1476         }
1477 }
1478
1479
1480 void MenuDefinition::expandIndicesContext(Buffer const * buf, bool listof)
1481 {
1482         if (!buf)
1483                 return;
1484
1485         BufferParams const & params = buf->masterBuffer()->params();
1486         if (!params.use_indices || params.indiceslist().empty())
1487                 return;
1488
1489         IndicesList::const_iterator cit = params.indiceslist().begin();
1490         IndicesList::const_iterator end = params.indiceslist().end();
1491
1492         for (int ii = 1; cit != end; ++cit, ++ii) {
1493                 if (listof) {
1494                         InsetCommandParams p(INDEX_PRINT_CODE);
1495                         p["type"] = cit->shortcut();
1496                         string const data = InsetCommand::params2string(p);
1497                         addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cit->index()),
1498                                            FuncRequest(LFUN_INSET_MODIFY, data)));
1499                 } else {
1500                         docstring const label =
1501                                         bformat(_("Index Entry (%1$s)"), cit->index());
1502                         addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1503                                            FuncRequest(LFUN_INSET_MODIFY,
1504                                                   from_ascii("changetype ") + cit->shortcut())));
1505                 }
1506         }
1507 }
1508
1509
1510 void MenuDefinition::expandCiteStyles(BufferView const * bv)
1511 {
1512         if (!bv)
1513                 return;
1514
1515         Inset const * inset = bv->cursor().nextInset();
1516         if (!inset || inset->lyxCode() != CITE_CODE) {
1517                 add(MenuItem(MenuItem::Command,
1518                                     qt_("No Citation in Scope!"),
1519                                     FuncRequest(LFUN_NOACTION)));
1520                 return;
1521         }
1522         InsetCommand const * citinset =
1523                                 static_cast<InsetCommand const *>(inset);
1524
1525         Buffer const * buf = &bv->buffer();
1526         string const cmd = citinset->params().getCmdName();
1527
1528         docstring const & key = citinset->getParam("key");
1529         if (key.empty()) {
1530                 add(MenuItem(MenuItem::Command,
1531                                     qt_("No citations selected!"),
1532                                     FuncRequest(LFUN_NOACTION)));
1533                 return;
1534         }
1535
1536         docstring const & before = citinset->getParam("before");
1537         docstring const & after = citinset->getParam("after");
1538
1539         size_t const n = cmd.size();
1540         bool const force = cmd[0] == 'C';
1541         bool const full = cmd[n] == '*';
1542
1543         vector<docstring> const keys = getVectorFromString(key);
1544
1545         vector<CitationStyle> const citeStyleList = buf->params().citeStyles();
1546         static const size_t max_length = 40;
1547         vector<docstring> citeStrings =
1548                 buf->masterBibInfo().getCiteStrings(keys, citeStyleList, bv->buffer(),
1549                 before, after, from_utf8("dialog"), max_length);
1550
1551         vector<docstring>::const_iterator cit = citeStrings.begin();
1552         vector<docstring>::const_iterator end = citeStrings.end();
1553
1554         for (int ii = 1; cit != end; ++cit, ++ii) {
1555                 docstring label = *cit;
1556                 CitationStyle cs = citeStyleList[ii - 1];
1557                 cs.forceUpperCase &= force;
1558                 cs.fullAuthorList &= full;
1559                 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1560                                     FuncRequest(LFUN_INSET_MODIFY,
1561                                                 "changetype " + from_utf8(citationStyleToString(cs)))));
1562         }
1563 }
1564
1565
1566 void MenuDefinition::expandArguments(BufferView const * bv, bool switcharg)
1567 {
1568         if (!bv)
1569                 return;
1570
1571         if (!bv->cursor().inTexted())
1572                 return;
1573
1574         Inset const * inset = &bv->cursor().inset();
1575         Layout::LaTeXArgMap args = bv->cursor().paragraph().layout().args();
1576         if (inset && args.empty())
1577                 args = inset->getLayout().args();
1578         if (args.empty() || (switcharg && args.size() == 1))
1579                 return;
1580         Layout::LaTeXArgMap::const_iterator lait = args.begin();
1581         Layout::LaTeXArgMap::const_iterator const laend = args.end();
1582         for (; lait != laend; ++lait) {
1583                 Layout::latexarg arg = (*lait).second;
1584                 docstring str = arg.menustring.empty()? arg.labelstring : arg.menustring;
1585                 QString item = toqstr(translateIfPossible(str));
1586                 if (switcharg)
1587                         add(MenuItem(MenuItem::Command, item,
1588                                      FuncRequest(LFUN_INSET_MODIFY,
1589                                                  from_ascii("changetype ")
1590                                                  + from_ascii((*lait).first))));
1591                 else
1592                         add(MenuItem(MenuItem::Command, item,
1593                                      FuncRequest(LFUN_ARGUMENT_INSERT,
1594                                                  from_ascii((*lait).first))));
1595         }
1596 }
1597
1598
1599 void MenuDefinition::expandCaptions(Buffer const * buf, bool switchcap)
1600 {
1601         if (!buf)
1602                 return;
1603
1604         DocumentClass const & dc = buf->params().documentClass();
1605         vector< pair<docstring, FuncRequest> > caps;
1606         for (pair<docstring, InsetLayout> const & il : dc.insetLayouts()) {
1607                 docstring instype;
1608                 docstring const type = split(il.first, instype, ':');
1609                 if (instype == "Caption") {
1610                         // skip forbidden caption types
1611                         FuncRequest const cmd = switchcap
1612                                 ? FuncRequest(LFUN_INSET_MODIFY, from_ascii("changetype ") + type)
1613                                 : FuncRequest(LFUN_CAPTION_INSERT, type);
1614                         if (getStatus(cmd).enabled())
1615                                 caps.push_back(make_pair(type, cmd));
1616                 }
1617         }
1618
1619         if (caps.empty() || (switchcap && caps.size() == 1))
1620                 return;
1621         if (caps.size() == 1) {
1622                 add(MenuItem(MenuItem::Command, qt_("Caption"), caps.front().second));
1623                 return;
1624         }
1625
1626         MenuDefinition captions;
1627         for (pair<docstring, FuncRequest> const & cap : caps) {
1628                 docstring const type = cap.first;
1629                 docstring const trtype = translateIfPossible(type);
1630                 docstring const cmitem = bformat(_("Caption (%1$s)"), trtype);
1631                 if (switchcap)
1632                         add(MenuItem(MenuItem::Command, toqstr(cmitem), cap.second));
1633                 else
1634                         captions.add(MenuItem(MenuItem::Command, toqstr(trtype), cap.second));
1635         }
1636         if (!captions.empty()) {
1637                 MenuItem item(MenuItem::Submenu, qt_("Caption"));
1638                 item.setSubmenu(captions);
1639                 add(item);
1640         }
1641 }
1642
1643
1644 void MenuDefinition::expandEnvironmentSeparators(BufferView const * bv)
1645 {
1646         if (!bv)
1647                 return;
1648         Text const * text = bv->cursor().text();
1649         // no paragraphs and no separators exist in math
1650         if (!text)
1651                 return;
1652
1653         pit_type pit = bv->cursor().selBegin().pit();
1654         Paragraph const & par = text->getPar(pit);
1655         docstring const curlayout = par.layout().name();
1656         docstring outerlayout;
1657         depth_type current_depth = par.params().depth();
1658         // check if we have an environment in our nesting hierarchy
1659         Paragraph cpar = par;
1660         while (true) {
1661                 if (pit == 0 || cpar.params().depth() == 0)
1662                         break;
1663                 --pit;
1664                 cpar = text->getPar(pit);
1665                 if (cpar.params().depth() < current_depth
1666                     && cpar.layout().isEnvironment()) {
1667                                 outerlayout = cpar.layout().name();
1668                                 current_depth = cpar.params().depth();
1669                 }
1670         }
1671         if (par.layout().isEnvironment()) {
1672                 docstring const label =
1673                         bformat(_("Start New Environment (%1$s)"),
1674                                 translateIfPossible(curlayout));
1675                 add(MenuItem(MenuItem::Command, toqstr(label),
1676                              FuncRequest(LFUN_ENVIRONMENT_SPLIT)));
1677         }
1678         if (!outerlayout.empty()) {
1679                 docstring const label =
1680                         bformat(_("Start New Parent Environment (%1$s)"),
1681                                 translateIfPossible(outerlayout));
1682                 add(MenuItem(MenuItem::Command, toqstr(label),
1683                              FuncRequest(LFUN_ENVIRONMENT_SPLIT,
1684                                          from_ascii("outer"))));
1685         }
1686 }
1687
1688 } // namespace anon
1689
1690
1691 /////////////////////////////////////////////////////////////////////
1692 // Menu::Impl definition and implementation
1693 /////////////////////////////////////////////////////////////////////
1694
1695 struct Menu::Impl
1696 {
1697         /// populates the menu or one of its submenu
1698         /// This is used as a recursive function
1699         void populate(QMenu * qMenu, MenuDefinition const & menu);
1700
1701         /// Only needed for top level menus.
1702         MenuDefinition * top_level_menu;
1703         /// our owning view
1704         GuiView * view;
1705         /// the name of this menu
1706         QString name;
1707 };
1708
1709
1710
1711 /// Get a MenuDefinition item label from the menu backend
1712 static QString label(MenuItem const & mi)
1713 {
1714         QString label = mi.label();
1715         label.replace("&", "&&");
1716
1717         QString shortcut = mi.shortcut();
1718         if (!shortcut.isEmpty()) {
1719                 int pos = label.indexOf(shortcut);
1720                 if (pos != -1)
1721                         //label.insert(pos, 1, char_type('&'));
1722                         label.replace(pos, 0, "&");
1723         }
1724
1725         QString const binding = mi.binding();
1726         if (!binding.isEmpty())
1727                 label += '\t' + binding;
1728
1729         return label;
1730 }
1731
1732 void Menu::Impl::populate(QMenu * qMenu, MenuDefinition const & menu)
1733 {
1734         LYXERR(Debug::GUI, "populating menu " << menu.name());
1735         if (menu.empty()) {
1736                 LYXERR(Debug::GUI, "\tERROR: empty menu " << menu.name());
1737                 return;
1738         }
1739         LYXERR(Debug::GUI, " *****  menu entries " << menu.size());
1740         for (MenuItem const & m : menu)
1741                 switch (m.kind()) {
1742                 case MenuItem::Separator:
1743                         qMenu->addSeparator();
1744                         break;
1745                 case MenuItem::Submenu: {
1746                         QMenu * subMenu = qMenu->addMenu(label(m));
1747                         populate(subMenu, m.submenu());
1748                         subMenu->setEnabled(!subMenu->isEmpty());
1749                         break;
1750                 }
1751                 case MenuItem::Command:
1752                 default:
1753                         // FIXME: A previous comment assured that MenuItem::Command was the
1754                         // only possible case in practice, but this is wrong.  It would be
1755                         // good to document which cases are actually treated here.
1756                         qMenu->addAction(new Action(m.func(), QIcon(), label(m),
1757                                                     m.tooltip(), qMenu));
1758                         break;
1759                 }
1760 }
1761
1762 #if (defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)) && (QT_VERSION >= 0x040600)
1763 class AlwaysMnemonicStyle : public QProxyStyle {
1764 public:
1765         int styleHint(StyleHint hint, const QStyleOption *opt = 0, const QWidget *widget = 0,
1766                 QStyleHintReturn *returnData = 0) const
1767         {
1768                 if (hint == QStyle::SH_UnderlineShortcut)
1769                         return 1;
1770                 return QProxyStyle::styleHint(hint, opt, widget, returnData);
1771         }
1772 };
1773 #endif
1774
1775 /////////////////////////////////////////////////////////////////////
1776 // Menu implementation
1777 /////////////////////////////////////////////////////////////////////
1778
1779 Menu::Menu(GuiView * gv, QString const & name, bool top_level, bool keyboard)
1780 : QMenu(gv), d(new Menu::Impl)
1781 {
1782 #if (defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)) && (QT_VERSION >= 0x040600)
1783         if (keyboard)
1784                 setStyle(new AlwaysMnemonicStyle);
1785 #else
1786         (void) keyboard;
1787 #endif
1788         d->top_level_menu = top_level? new MenuDefinition : 0;
1789         d->view = gv;
1790         d->name = name;
1791         setTitle(name);
1792         if (d->top_level_menu)
1793                 connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView()));
1794 }
1795
1796
1797 Menu::~Menu()
1798 {
1799         delete d->top_level_menu;
1800         delete d;
1801 }
1802
1803
1804 void Menu::updateView()
1805 {
1806         guiApp->menus().updateMenu(this);
1807 }
1808
1809
1810 void Menu::clear()
1811 {
1812         QList<QAction *> items = actions();
1813         for (int i = 0; i != items.size(); ++i) {
1814                 // QAction::menu() returns 0 if there's no submenu.
1815                 delete items.at(i)->menu();
1816         }
1817         QMenu::clear();
1818 }
1819
1820
1821 /////////////////////////////////////////////////////////////////////
1822 // Menus::Impl definition and implementation
1823 /////////////////////////////////////////////////////////////////////
1824
1825 struct Menus::Impl {
1826         ///
1827         bool hasMenu(QString const &) const;
1828         ///
1829         MenuDefinition & getMenu(QString const &);
1830         ///
1831         MenuDefinition const & getMenu(QString const &) const;
1832
1833         /// Expands some special entries of the menu
1834         /** The entries with the following kind are expanded to a
1835             sequence of Command MenuItems: Lastfiles, Documents,
1836             ViewFormats, ExportFormats, UpdateFormats, Branches,
1837             Indices, Arguments, SwitchArguments, Captions, SwitchCaptions,
1838             EnvironmentSeparators
1839         */
1840         void expand(MenuDefinition const & frommenu, MenuDefinition & tomenu,
1841                 BufferView const *) const;
1842
1843         /// Initialize specific MACOS X menubar
1844         void macxMenuBarInit(QMenuBar * qmb);
1845
1846         /// Mac special menu.
1847         /** This defines a menu whose entries list the FuncRequests
1848             that will be removed by expand() in other menus. This is
1849             used by the Qt/Mac code.
1850
1851             NOTE: Qt does not remove the menu items when clearing a QMenuBar,
1852             such that the items will keep accessing the FuncRequests in
1853             the MenuDefinition. While Menus::Impl might be recreated,
1854             we keep mac_special_menu_ in memory by making it static.
1855         */
1856         static MenuDefinition mac_special_menu_;
1857
1858         ///
1859         MenuList menulist_;
1860         ///
1861         MenuDefinition menubar_;
1862
1863         typedef QMap<GuiView *, QHash<QString, Menu*> > NameMap;
1864
1865         /// name to menu for \c menu() method.
1866         NameMap name_map_;
1867 };
1868
1869
1870 MenuDefinition Menus::Impl::mac_special_menu_;
1871
1872
1873 /*
1874   Here is what the Qt documentation says about how a menubar is chosen:
1875
1876      1) If the window has a QMenuBar then it is used. 2) If the window
1877      is a modal then its menubar is used. If no menubar is specified
1878      then a default menubar is used (as documented below) 3) If the
1879      window has no parent then the default menubar is used (as
1880      documented below).
1881
1882      The above 3 steps are applied all the way up the parent window
1883      chain until one of the above are satisifed. If all else fails a
1884      default menubar will be created, the default menubar on Qt/Mac is
1885      an empty menubar, however you can create a different default
1886      menubar by creating a parentless QMenuBar, the first one created
1887      will thus be designated the default menubar, and will be used
1888      whenever a default menubar is needed.
1889
1890   Thus, for Qt/Mac, we add the menus to a free standing menubar, so
1891   that this menubar will be used also when one of LyX' dialogs has
1892   focus. (JMarc)
1893 */
1894 void Menus::Impl::macxMenuBarInit(QMenuBar * qmb)
1895 {
1896         /* Since Qt 4.2, the qt/mac menu code has special code for
1897            specifying the role of a menu entry. However, it does not
1898            work very well with our scheme of creating menus on demand,
1899            and therefore we need to put these entries in a special
1900            invisible menu. (JMarc)
1901         */
1902
1903         /* The entries of our special mac menu. If we add support for
1904          * special entries in Menus, we could imagine something
1905          * like
1906          *    SpecialItem About " "About LyX" "dialog-show aboutlyx"
1907          * and therefore avoid hardcoding. I am not sure it is worth
1908          * the hassle, though. (JMarc)
1909          */
1910         struct MacMenuEntry {
1911                 FuncCode action;
1912                 char const * arg;
1913                 char const * label;
1914                 QAction::MenuRole role;
1915         };
1916
1917         static const MacMenuEntry entries[] = {
1918                 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
1919                  QAction::AboutRole},
1920                 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
1921                  QAction::PreferencesRole},
1922 #if !(defined(QT_MAC_USE_COCOA) || (QT_VERSION >= 0x050000))
1923                 /* This doesn't work with Cocoa. */
1924                 {LFUN_RECONFIGURE, "", "Reconfigure",
1925                  QAction::ApplicationSpecificRole},
1926 #endif
1927                 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
1928         };
1929         const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
1930         const bool first_call = mac_special_menu_.empty();
1931
1932         LYXERR(Debug::GUI, "Creating Mac OS X special menu bar");
1933         // the special menu for Menus. Fill it up only once.
1934         if (first_call) {
1935                 for (size_t i = 0 ; i < num_entries ; ++i) {
1936                         FuncRequest const func(entries[i].action,
1937                                 from_utf8(entries[i].arg));
1938                         mac_special_menu_.add(MenuItem(MenuItem::Command,
1939                                 entries[i].label, func));
1940                 }
1941         }
1942
1943         // add the entries to a QMenu that will eventually be empty
1944         // and therefore invisible.
1945         QMenu * qMenu = qmb->addMenu("special");
1946         size_t i = 0;
1947         for (MenuItem const & m : mac_special_menu_) {
1948                 Action * action = new Action(m.func(), QIcon(), m.label(),
1949                                              QString(), qMenu);
1950                 action->setMenuRole(entries[i].role);
1951                 qMenu->addAction(action);
1952                 ++i;
1953         }
1954 }
1955
1956
1957 void Menus::Impl::expand(MenuDefinition const & frommenu,
1958         MenuDefinition & tomenu, BufferView const * bv) const
1959 {
1960         if (!tomenu.empty())
1961                 tomenu.clear();
1962
1963         for (MenuDefinition::const_iterator cit = frommenu.begin();
1964              cit != frommenu.end() ; ++cit) {
1965                 Buffer const * buf = bv ? &bv->buffer() : 0;
1966                 switch (cit->kind()) {
1967                 case MenuItem::Lastfiles:
1968                         tomenu.expandLastfiles();
1969                         break;
1970
1971                 case MenuItem::Documents:
1972                         tomenu.expandDocuments();
1973                         break;
1974
1975                 case MenuItem::Bookmarks:
1976                         tomenu.expandBookmarks();
1977                         break;
1978
1979                 case MenuItem::ImportFormats:
1980                 case MenuItem::ViewFormats:
1981                 case MenuItem::UpdateFormats:
1982                 case MenuItem::ExportFormats:
1983                         tomenu.expandFormats(cit->kind(), buf);
1984                         break;
1985
1986                 case MenuItem::CharStyles:
1987                         tomenu.expandFlexInsert(buf, InsetLayout::CHARSTYLE);
1988                         break;
1989
1990                 case MenuItem::Custom:
1991                         tomenu.expandFlexInsert(buf, InsetLayout::CUSTOM);
1992                         break;
1993
1994                 case MenuItem::Elements:
1995                         tomenu.expandFlexInsert(buf, InsetLayout::ELEMENT);
1996                         break;
1997
1998                 case MenuItem::FloatListInsert:
1999                         tomenu.expandFloatListInsert(buf);
2000                         break;
2001
2002                 case MenuItem::FloatInsert:
2003                         tomenu.expandFloatInsert(buf);
2004                         break;
2005
2006                 case MenuItem::PasteRecent:
2007                         tomenu.expandPasteRecent(buf);
2008                         break;
2009
2010                 case MenuItem::Toolbars:
2011                         tomenu.expandToolbars();
2012                         break;
2013
2014                 case MenuItem::Branches:
2015                         tomenu.expandBranches(buf);
2016                         break;
2017
2018                 case MenuItem::Indices:
2019                         tomenu.expandIndices(buf);
2020                         break;
2021
2022                 case MenuItem::IndicesContext:
2023                         tomenu.expandIndicesContext(buf);
2024                         break;
2025
2026                 case MenuItem::IndicesLists:
2027                         tomenu.expandIndices(buf, true);
2028                         break;
2029
2030                 case MenuItem::IndicesListsContext:
2031                         tomenu.expandIndicesContext(buf, true);
2032                         break;
2033
2034                 case MenuItem::CiteStyles:
2035                         tomenu.expandCiteStyles(bv);
2036                         break;
2037
2038                 case MenuItem::Toc:
2039                         tomenu.expandToc(buf);
2040                         break;
2041
2042                 case MenuItem::GraphicsGroups:
2043                         tomenu.expandGraphicsGroups(bv);
2044                         break;
2045
2046                 case MenuItem::SpellingSuggestions:
2047                         tomenu.expandSpellingSuggestions(bv);
2048                         break;
2049
2050                 case MenuItem::LanguageSelector:
2051                         tomenu.expandLanguageSelector(buf);
2052                         break;
2053
2054                 case MenuItem::Arguments:
2055                         tomenu.expandArguments(bv, false);
2056                         break;
2057
2058                 case MenuItem::SwitchArguments:
2059                         tomenu.expandArguments(bv, true);
2060                         break;
2061
2062                 case MenuItem::Captions:
2063                         tomenu.expandCaptions(buf, false);
2064                         break;
2065
2066                 case MenuItem::SwitchCaptions:
2067                         tomenu.expandCaptions(buf, true);
2068                         break;
2069
2070                 case MenuItem::EnvironmentSeparators:
2071                         tomenu.expandEnvironmentSeparators(bv);
2072                         break;
2073
2074                 case MenuItem::Submenu: {
2075                         MenuItem item(*cit);
2076                         item.setSubmenu(MenuDefinition(cit->submenuname()));
2077                         expand(getMenu(cit->submenuname()), item.submenu(), bv);
2078                         tomenu.addWithStatusCheck(item);
2079                 }
2080                 break;
2081
2082                 case MenuItem::Info:
2083                 case MenuItem::Help:
2084                 case MenuItem::Separator:
2085                         tomenu.addWithStatusCheck(*cit);
2086                         break;
2087
2088                 case MenuItem::Command:
2089                         if (!mac_special_menu_.hasFunc(*cit->func()))
2090                                 tomenu.addWithStatusCheck(*cit);
2091                 }
2092         }
2093
2094         // we do not want the menu to end with a separator
2095         if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
2096                 tomenu.items_.pop_back();
2097
2098         // Check whether the shortcuts are unique
2099         tomenu.checkShortcuts();
2100 }
2101
2102
2103 bool Menus::Impl::hasMenu(QString const & name) const
2104 {
2105         return find_if(menulist_.begin(), menulist_.end(),
2106                 MenuNamesEqual(name)) != menulist_.end();
2107 }
2108
2109
2110 MenuDefinition const & Menus::Impl::getMenu(QString const & name) const
2111 {
2112         const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
2113                 MenuNamesEqual(name));
2114         if (cit == menulist_.end()) {
2115                 LYXERR0("No submenu named " << name);
2116                 LASSERT(false, { static const MenuDefinition m; return m; });
2117         }
2118         return (*cit);
2119 }
2120
2121
2122 MenuDefinition & Menus::Impl::getMenu(QString const & name)
2123 {
2124         iterator it = find_if(menulist_.begin(), menulist_.end(),
2125                 MenuNamesEqual(name));
2126         if (it == menulist_.end()) {
2127                 LYXERR0("No submenu named " << name);
2128                 LASSERT(false, { static MenuDefinition m; return m; });
2129         }
2130         return (*it);
2131 }
2132
2133
2134 /////////////////////////////////////////////////////////////////////
2135 //
2136 // Menus
2137 //
2138 /////////////////////////////////////////////////////////////////////
2139
2140 Menus::Menus() : d(new Impl) {}
2141
2142
2143 Menus::~Menus()
2144 {
2145         delete d;
2146 }
2147
2148
2149 void Menus::reset()
2150 {
2151         delete d;
2152         d = new Impl;
2153 }
2154
2155
2156 void Menus::read(Lexer & lex)
2157 {
2158         enum {
2159                 md_menu,
2160                 md_menubar,
2161                 md_endmenuset
2162         };
2163
2164         LexerKeyword menutags[] = {
2165                 { "end", md_endmenuset },
2166                 { "menu", md_menu },
2167                 { "menubar", md_menubar }
2168         };
2169
2170         // consistency check
2171         if (compare_ascii_no_case(lex.getString(), "menuset"))
2172                 LYXERR0("Menus::read: ERROR wrong token: `" << lex.getString() << '\'');
2173
2174         lex.pushTable(menutags);
2175         lex.setContext("Menus::read");
2176
2177         bool quit = false;
2178
2179         while (lex.isOK() && !quit) {
2180                 switch (lex.lex()) {
2181                 case md_menubar:
2182                         d->menubar_.read(lex);
2183                         break;
2184                 case md_menu: {
2185                         lex.next(true);
2186                         QString const name = toqstr(lex.getDocString());
2187                         if (d->hasMenu(name))
2188                                 d->getMenu(name).read(lex);
2189                         else {
2190                                 MenuDefinition menu(name);
2191                                 menu.read(lex);
2192                                 d->menulist_.push_back(menu);
2193                         }
2194                         break;
2195                 }
2196                 case md_endmenuset:
2197                         quit = true;
2198                         break;
2199                 default:
2200                         lex.printError("Unknown menu tag");
2201                         break;
2202                 }
2203         }
2204         lex.popTable();
2205 }
2206
2207
2208 bool Menus::searchMenu(FuncRequest const & func,
2209         docstring_list & names) const
2210 {
2211         MenuDefinition menu;
2212         d->expand(d->menubar_, menu, 0);
2213         return menu.searchMenu(func, names);
2214 }
2215
2216
2217 void Menus::fillMenuBar(QMenuBar * qmb, GuiView * view, bool initial)
2218 {
2219         if (initial) {
2220 #ifdef Q_OS_MAC
2221                 // setup special mac specific menu items, but only do this
2222                 // the first time a QMenuBar is created. Otherwise Qt will
2223                 // create duplicate items in the application menu. It seems
2224                 // that Qt does not remove them when the QMenubar is cleared.
2225                 d->macxMenuBarInit(qmb);
2226 #endif
2227         } else {
2228                 // Clear all menubar contents before filling it.
2229                 qmb->clear();
2230 #if (QT_VERSION >= 0x050000 && defined(Q_OS_MAC))
2231                 d->macxMenuBarInit(qmb);
2232 #endif
2233         }
2234
2235         LYXERR(Debug::GUI, "populating menu bar" << d->menubar_.name());
2236
2237         if (d->menubar_.empty()) {
2238                 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
2239                         << d->menubar_.name());
2240                 return;
2241         }
2242         LYXERR(Debug::GUI, "menu bar entries " << d->menubar_.size());
2243
2244         MenuDefinition menu;
2245         BufferView * bv = 0;
2246         if (view)
2247                 bv = view->currentBufferView();
2248         d->expand(d->menubar_, menu, bv);
2249
2250         MenuDefinition::const_iterator m = menu.begin();
2251         MenuDefinition::const_iterator end = menu.end();
2252
2253         for (; m != end; ++m) {
2254
2255                 if (m->kind() != MenuItem::Submenu) {
2256                         LYXERR(Debug::GUI, "\tERROR: not a submenu " << m->label());
2257                         continue;
2258                 }
2259
2260                 LYXERR(Debug::GUI, "menu bar item " << m->label()
2261                         << " is a submenu named " << m->submenuname());
2262
2263                 QString name = m->submenuname();
2264                 if (!d->hasMenu(name)) {
2265                         LYXERR(Debug::GUI, "\tERROR: " << name
2266                                 << " submenu has no menu!");
2267                         continue;
2268                 }
2269
2270                 Menu * menu = new Menu(view, m->submenuname(), true);
2271                 menu->setTitle(label(*m));
2272
2273 #if defined(Q_OS_MAC) && (defined(QT_MAC_USE_COCOA) || (QT_VERSION >= 0x050000))
2274                 // On Mac OS with QT/cocoa, the menu is not displayed if there is no action
2275                 // so we create a temporary one here
2276                 QAction * action = new QAction(menu);
2277                 menu->addAction(action);
2278 #endif
2279
2280                 qmb->addMenu(menu);
2281
2282                 d->name_map_[view][name] = menu;
2283         }
2284 }
2285
2286
2287 void Menus::updateMenu(Menu * qmenu)
2288 {
2289         LYXERR(Debug::GUI, "Triggered menu: " << qmenu->d->name);
2290         qmenu->clear();
2291
2292         if (qmenu->d->name.isEmpty())
2293                 return;
2294
2295         docstring identifier = qstring_to_ucs4(qmenu->d->name);
2296         MenuDefinition fromLyxMenu(qmenu->d->name);
2297         while (!identifier.empty()) {
2298                 docstring menu_name;
2299                 identifier = split(identifier, menu_name, ';');
2300
2301                 if (!d->hasMenu(toqstr(menu_name))) {
2302                         LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
2303                                 << menu_name);
2304                         continue;
2305                 }
2306
2307                 MenuDefinition cat_menu = d->getMenu(toqstr(menu_name));
2308                 //FIXME: 50 is a wild guess. We should take into account here
2309                 //the expansion of menu items, disabled optional items etc.
2310                 bool const in_sub_menu = !fromLyxMenu.empty()
2311                         && fromLyxMenu.size() + cat_menu.size() > 50 ;
2312                 if (in_sub_menu)
2313                         fromLyxMenu.catSub(menu_name);
2314                 else
2315                         fromLyxMenu.cat(cat_menu);
2316                 fromLyxMenu.add(MenuItem(MenuItem::Separator));
2317         }
2318
2319         if (fromLyxMenu.empty()) {
2320                 qmenu->addAction(qt_("No Action Defined!"));
2321                 return;
2322         }
2323
2324         BufferView * bv = 0;
2325         if (qmenu->d->view)
2326                 bv = qmenu->d->view->currentBufferView();
2327         d->expand(fromLyxMenu, *qmenu->d->top_level_menu, bv);
2328         qmenu->d->populate(qmenu, *qmenu->d->top_level_menu);
2329 }
2330
2331
2332 Menu * Menus::menu(QString const & name, GuiView & view, bool keyboard)
2333 {
2334         LYXERR(Debug::GUI, "Context menu requested: " << name);
2335         Menu * menu = d->name_map_[&view].value(name, 0);
2336         if (!menu && !name.startsWith("context-")) {
2337                 LYXERR0("requested context menu not found: " << name);
2338                 return 0;
2339         }
2340
2341         menu = new Menu(&view, name, true, keyboard);
2342         d->name_map_[&view][name] = menu;
2343         return menu;
2344 }
2345
2346 } // namespace frontend
2347 } // namespace lyx
2348
2349 #include "moc_Menus.cpp"