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