src/frontends/qt/Menus.cpp

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