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