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