src/frontends/qt4/Menus.cpp

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