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 Bø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 "BranchList.h"
  27 #include "Buffer.h"
  28 #include "BufferList.h"
  29 #include "BufferParams.h"
  30 #include "Converter.h"
  31 #include "CutAndPaste.h"
  32 #include "Floating.h"
  33 #include "FloatList.h"
  34 #include "Format.h"
  35 #include "FuncRequest.h"
  36 #include "FuncStatus.h"
  37 #include "KeyMap.h"
  38 #include "Lexer.h"
  39 #include "LyXAction.h"
  40 #include "LyX.h" // for lastfiles
  41 #include "LyXFunc.h"
  42 #include "Paragraph.h"
  43 #include "Session.h"
  44 #include "TextClass.h"
  45 #include "TocBackend.h"
  46 #include "ToolbarBackend.h"
  47
  48 #include "support/convert.h"
  49 #include "support/debug.h"
  50 #include "support/filetools.h"
  51 #include "support/gettext.h"
  52 #include "support/lstrings.h"
  53
  54 #include <QCursor>
  55 #include <QHash>
  56 #include <QMenuBar>
  57 #include <QString>
  58
  59 #include <boost/shared_ptr.hpp>
  60
  61 #include <algorithm>
  62 #include <ostream>
  63 #include <vector>
  64
  65 using namespace std;
  66 using namespace lyx::support;
  67
  68
  69 namespace lyx {
  70 namespace frontend {
  71
  72 namespace {
  73
  74 // MacOSX specific stuff is at the end.
  75
  76 class MenuDefinition;
  77
  78 ///
  79 class MenuItem {
  80 public:
  81         /// The type of elements that can be in a menu
  82         enum Kind {
  83                 ///
  84                 Command,
  85                 ///
  86                 Submenu,
  87                 ///
  88                 Separator,
  89                 /** This is the list of last opened file,
  90                     typically for the File menu. */
  91                 Lastfiles,
  92                 /** This is the list of opened Documents,
  93                     typically for the Documents menu. */
  94                 Documents,
  95                 /** This is the bookmarks */
  96                 Bookmarks,
  97                 ///
  98                 Toc,
  99                 /** This is a list of viewable formats
 100                     typically for the File->View menu. */
 101                 ViewFormats,
 102                 /** This is a list of updatable formats
 103                     typically for the File->Update menu. */
 104                 UpdateFormats,
 105                 /** This is a list of exportable formats
 106                     typically for the File->Export menu. */
 107                 ExportFormats,
 108                 /** This is a list of importable formats
 109                     typically for the File->Export menu. */
 110                 ImportFormats,
 111                 /** This is the list of elements available
 112                  * for insertion into document. */
 113                 CharStyles,
 114                 /** This is the list of user-configurable
 115                 insets to insert into document */
 116                 Custom,
 117                 /** This is the list of XML elements to
 118                 insert into the document */
 119                 Elements,
 120                 /** This is the list of floats that we can
 121                     insert a list for. */
 122                 FloatListInsert,
 123                 /** This is the list of floats that we can
 124                     insert. */
 125                 FloatInsert,
 126                 /** This is the list of selections that can
 127                     be pasted. */
 128                 PasteRecent,
 129                 /** toolbars */
 130                 Toolbars,
 131                 /** Available branches in document */
 132                 Branches
 133         };
 134
 135         explicit MenuItem(Kind kind) : kind_(kind), optional_(false) {}
 136
 137         MenuItem(Kind kind,
 138                  QString const & label,
 139                  QString const & submenu = QString(),
 140                  bool optional = false)
 141                 : kind_(kind), label_(label), submenuname_(submenu), optional_(optional)
 142         {
 143                 BOOST_ASSERT(kind == Submenu);
 144         }
 145
 146         MenuItem(Kind kind,
 147                  QString const & label,
 148                  FuncRequest const & func,
 149                  bool optional = false)
 150                 : kind_(kind), label_(label), func_(func), optional_(optional)
 151         {
 152                 func_.origin = FuncRequest::MENU;
 153         }
 154
 155         // boost::shared_ptr<MenuDefinition> needs this apprently...
 156         ~MenuItem() {}
 157
 158         /// The label of a given menuitem
 159         QString label() const { return label_.split('|')[0]; }
 160
 161         /// The keyboard shortcut (usually underlined in the entry)
 162         QString shortcut() const
 163         {
 164                 return label_.contains('|') ? label_.split('|')[1] : QString();
 165         }
 166         /// The complete label, with label and shortcut separated by a '|'
 167         QString fulllabel() const { return label_;}
 168         /// The kind of entry
 169         Kind kind() const { return kind_; }
 170         /// the action (if relevant)
 171         FuncRequest const & func() const { return func_; }
 172         /// returns true if the entry should be ommited when disabled
 173         bool optional() const { return optional_; }
 174         /// returns the status of the lfun associated with this entry
 175         FuncStatus const & status() const { return status_; }
 176         /// returns the status of the lfun associated with this entry
 177         FuncStatus & status() { return status_; }
 178         /// returns the status of the lfun associated with this entry
 179         void status(FuncStatus const & status) { status_ = status; }
 180
 181         ///returns the binding associated to this action.
 182         QString binding() const
 183         {
 184                 if (kind_ != Command)
 185                         return QString();
 186                 // Get the keys bound to this action, but keep only the
 187                 // first one later
 188                 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func_);
 189                 if (bindings.size())
 190                         return toqstr(bindings.begin()->print(KeySequence::ForGui));
 191
 192                 LYXERR(Debug::KBMAP, "No binding for "
 193                         << lyxaction.getActionName(func_.action)
 194                         << '(' << func_.argument() << ')');
 195                 return QString();
 196         }
 197
 198         /// the description of the  submenu (if relevant)
 199         QString const & submenuname() const { return submenuname_; }
 200         /// set the description of the  submenu
 201         void submenuname(QString const & name) { submenuname_ = name; }
 202         ///
 203         MenuDefinition * submenu() const { return submenu_.get(); }
 204         ///
 205         void setSubmenu(MenuDefinition * menu) { submenu_.reset(menu); }
 206
 207 private:
 208         ///
 209         Kind kind_;
 210         ///
 211         QString label_;
 212         ///
 213         FuncRequest func_;
 214         ///
 215         QString submenuname_;
 216         ///
 217         bool optional_;
 218         ///
 219         FuncStatus status_;
 220         ///
 221         boost::shared_ptr<MenuDefinition> submenu_;
 222 };
 223
 224 ///
 225 class MenuDefinition {
 226 public:
 227         ///
 228         typedef std::vector<MenuItem> ItemList;
 229         ///
 230         typedef ItemList::const_iterator const_iterator;
 231         ///
 232         explicit MenuDefinition(QString const & name = QString()) : name_(name) {}
 233
 234         ///
 235         void read(Lexer &);
 236         ///
 237         QString const & name() const { return name_; }
 238         ///
 239         bool empty() const { return items_.empty(); }
 240         /// Clear the menu content.
 241         void clear() { items_.clear(); }
 242         ///
 243         size_t size() const { return items_.size(); }
 244         ///
 245         MenuItem const & operator[](size_t) const;
 246         ///
 247         const_iterator begin() const { return items_.begin(); }
 248         ///
 249         const_iterator end() const { return items_.end(); }
 250
 251         // search for func in this menu iteratively, and put menu
 252         // names in a stack.
 253         bool searchMenu(FuncRequest const & func, std::vector<docstring> & names)
 254                 const;
 255         ///
 256         bool hasFunc(FuncRequest const &) const;
 257         /// Add the menu item unconditionally
 258         void add(MenuItem const & item) { items_.push_back(item); }
 259         /// Checks the associated FuncRequest status before adding the
 260         /// menu item.
 261         void addWithStatusCheck(MenuItem const &);
 262         // Check whether the menu shortcuts are unique
 263         void checkShortcuts() const;
 264         ///
 265         void expandLastfiles();
 266         void expandDocuments();
 267         void expandBookmarks();
 268         void expandFormats(MenuItem::Kind kind, Buffer const * buf);
 269         void expandFloatListInsert(Buffer const * buf);
 270         void expandFloatInsert(Buffer const * buf);
 271         void expandFlexInsert(Buffer const * buf, std::string s);
 272         void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth);
 273         void expandToc(Buffer const * buf);
 274         void expandPasteRecent();
 275         void expandToolbars();
 276         void expandBranches(Buffer const * buf);
 277         ///
 278         ItemList items_;
 279         ///
 280         QString name_;
 281 };
 282
 283
 284 /// Helper for std::find_if
 285 class MenuNamesEqual
 286 {
 287 public:
 288         MenuNamesEqual(QString const & name) : name_(name) {}
 289         bool operator()(MenuDefinition const & menu) const { return menu.name() == name_; }
 290 private:
 291         QString name_;
 292 };
 293
 294
 295 ///
 296 typedef std::vector<MenuDefinition> MenuList;
 297 ///
 298 typedef MenuList::const_iterator const_iterator;
 299 ///
 300 typedef MenuList::iterator iterator;
 301
 302 /////////////////////////////////////////////////////////////////////
 303 // MenuDefinition implementation
 304 /////////////////////////////////////////////////////////////////////
 305
 306 void MenuDefinition::addWithStatusCheck(MenuItem const & i)
 307 {
 308         switch (i.kind()) {
 309
 310         case MenuItem::Command: {
 311                 FuncStatus status = lyx::getStatus(i.func());
 312                 if (status.unknown() || (!status.enabled() && i.optional()))
 313                         break;
 314                 items_.push_back(i);
 315                 items_.back().status(status);
 316                 break;
 317         }
 318
 319         case MenuItem::Submenu: {
 320                 if (i.submenu()) {
 321                         bool enabled = false;
 322                         for (const_iterator cit = i.submenu()->begin();
 323                              cit != i.submenu()->end(); ++cit) {
 324                                 if ((cit->kind() == MenuItem::Command
 325                                      || cit->kind() == MenuItem::Submenu)
 326                                     && cit->status().enabled()) {
 327                                         enabled = true;
 328                                         break;
 329                                 }
 330                         }
 331                         if (enabled || !i.optional()) {
 332                                 items_.push_back(i);
 333                                 items_.back().status().enabled(enabled);
 334                         }
 335                 }
 336                 else
 337                         items_.push_back(i);
 338                 break;
 339         }
 340
 341         case MenuItem::Separator:
 342                 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
 343                         items_.push_back(i);
 344                 break;
 345
 346         default:
 347                 items_.push_back(i);
 348         }
 349 }
 350
 351
 352 void MenuDefinition::read(Lexer & lex)
 353 {
 354         enum Menutags {
 355                 md_item = 1,
 356                 md_branches,
 357                 md_documents,
 358                 md_bookmarks,
 359                 md_charstyles,
 360                 md_custom,
 361                 md_elements,
 362                 md_endmenu,
 363                 md_exportformats,
 364                 md_importformats,
 365                 md_lastfiles,
 366                 md_optitem,
 367                 md_optsubmenu,
 368                 md_separator,
 369                 md_submenu,
 370                 md_toc,
 371                 md_updateformats,
 372                 md_viewformats,
 373                 md_floatlistinsert,
 374                 md_floatinsert,
 375                 md_pasterecent,
 376                 md_toolbars,
 377                 md_last
 378         };
 379
 380         struct keyword_item menutags[md_last - 1] = {
 381                 { "bookmarks", md_bookmarks },
 382                 { "branches", md_branches },
 383                 { "charstyles", md_charstyles },
 384                 { "custom", md_custom },
 385                 { "documents", md_documents },
 386                 { "elements", md_elements },
 387                 { "end", md_endmenu },
 388                 { "exportformats", md_exportformats },
 389                 { "floatinsert", md_floatinsert },
 390                 { "floatlistinsert", md_floatlistinsert },
 391                 { "importformats", md_importformats },
 392                 { "item", md_item },
 393                 { "lastfiles", md_lastfiles },
 394                 { "optitem", md_optitem },
 395                 { "optsubmenu", md_optsubmenu },
 396                 { "pasterecent", md_pasterecent },
 397                 { "separator", md_separator },
 398                 { "submenu", md_submenu },
 399                 { "toc", md_toc },
 400                 { "toolbars", md_toolbars },
 401                 { "updateformats", md_updateformats },
 402                 { "viewformats", md_viewformats }
 403         };
 404
 405         lex.pushTable(menutags, md_last - 1);
 406         if (lyxerr.debugging(Debug::PARSER))
 407                 lex.printTable(lyxerr);
 408
 409         bool quit = false;
 410         bool optional = false;
 411
 412         while (lex.isOK() && !quit) {
 413                 switch (lex.lex()) {
 414                 case md_optitem:
 415                         optional = true;
 416                         // fallback to md_item
 417                 case md_item: {
 418                         lex.next(true);
 419                         docstring const name = translateIfPossible(lex.getDocString());
 420                         lex.next(true);
 421                         string const command = lex.getString();
 422                         FuncRequest func = lyxaction.lookupFunc(command);
 423                         add(MenuItem(MenuItem::Command, toqstr(name), func, optional));
 424                         optional = false;
 425                         break;
 426                 }
 427
 428                 case md_separator:
 429                         add(MenuItem(MenuItem::Separator));
 430                         break;
 431
 432                 case md_lastfiles:
 433                         add(MenuItem(MenuItem::Lastfiles));
 434                         break;
 435
 436                 case md_charstyles:
 437                         add(MenuItem(MenuItem::CharStyles));
 438                         break;
 439
 440                 case md_custom:
 441                         add(MenuItem(MenuItem::Custom));
 442                         break;
 443
 444                 case md_elements:
 445                         add(MenuItem(MenuItem::Elements));
 446                         break;
 447
 448                 case md_documents:
 449                         add(MenuItem(MenuItem::Documents));
 450                         break;
 451
 452                 case md_bookmarks:
 453                         add(MenuItem(MenuItem::Bookmarks));
 454                         break;
 455
 456                 case md_toc:
 457                         add(MenuItem(MenuItem::Toc));
 458                         break;
 459
 460                 case md_viewformats:
 461                         add(MenuItem(MenuItem::ViewFormats));
 462                         break;
 463
 464                 case md_updateformats:
 465                         add(MenuItem(MenuItem::UpdateFormats));
 466                         break;
 467
 468                 case md_exportformats:
 469                         add(MenuItem(MenuItem::ExportFormats));
 470                         break;
 471
 472                 case md_importformats:
 473                         add(MenuItem(MenuItem::ImportFormats));
 474                         break;
 475
 476                 case md_floatlistinsert:
 477                         add(MenuItem(MenuItem::FloatListInsert));
 478                         break;
 479
 480                 case md_floatinsert:
 481                         add(MenuItem(MenuItem::FloatInsert));
 482                         break;
 483
 484                 case md_pasterecent:
 485                         add(MenuItem(MenuItem::PasteRecent));
 486                         break;
 487
 488                 case md_toolbars:
 489                         add(MenuItem(MenuItem::Toolbars));
 490                         break;
 491
 492                 case md_branches:
 493                         add(MenuItem(MenuItem::Branches));
 494                         break;
 495
 496                 case md_optsubmenu:
 497                         optional = true;
 498                         // fallback to md_submenu
 499                 case md_submenu: {
 500                         lex.next(true);
 501                         docstring const mlabel = translateIfPossible(lex.getDocString());
 502                         lex.next(true);
 503                         docstring const mname = lex.getDocString();
 504                         add(MenuItem(MenuItem::Submenu,
 505                                 toqstr(mlabel), toqstr(mname), optional));
 506                         optional = false;
 507                         break;
 508                 }
 509
 510                 case md_endmenu:
 511                         quit = true;
 512                         break;
 513
 514                 default:
 515                         lex.printError("MenuDefinition::read: "
 516                                        "Unknown menu tag: `$$Token'");
 517                         break;
 518                 }
 519         }
 520         lex.popTable();
 521 }
 522
 523
 524 MenuItem const & MenuDefinition::operator[](size_type i) const
 525 {
 526         return items_[i];
 527 }
 528
 529
 530 bool MenuDefinition::hasFunc(FuncRequest const & func) const
 531 {
 532         for (const_iterator it = begin(), et = end(); it != et; ++it)
 533                 if (it->func() == func)
 534                         return true;
 535         return false;
 536 }
 537
 538
 539 void MenuDefinition::checkShortcuts() const
 540 {
 541         // This is a quadratic algorithm, but we do not care because
 542         // menus are short enough
 543         for (const_iterator it1 = begin(); it1 != end(); ++it1) {
 544                 QString shortcut = it1->shortcut();
 545                 if (shortcut.isEmpty())
 546                         continue;
 547                 if (!it1->label().contains(shortcut))
 548                         lyxerr << "Menu warning: menu entry \""
 549                                << fromqstr(it1->label())
 550                                << "\" does not contain shortcut `"
 551                                << fromqstr(shortcut) << "'." << endl;
 552                 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
 553                         if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
 554                                 lyxerr << "Menu warning: menu entries "
 555                                        << '"' << fromqstr(it1->fulllabel())
 556                                        << "\" and \"" << fromqstr(it2->fulllabel())
 557                                        << "\" share the same shortcut."
 558                                        << endl;
 559                         }
 560                 }
 561         }
 562 }
 563
 564
 565 bool MenuDefinition::searchMenu(FuncRequest const & func, vector<docstring> & names) const
 566 {
 567         const_iterator m = begin();
 568         const_iterator m_end = end();
 569         for (; m != m_end; ++m) {
 570                 if (m->kind() == MenuItem::Command && m->func() == func) {
 571                         names.push_back(qstring_to_ucs4(m->label()));
 572                         return true;
 573                 }
 574                 if (m->kind() == MenuItem::Submenu) {
 575                         names.push_back(qstring_to_ucs4(m->label()));
 576                         MenuDefinition const & submenu = *m->submenu();
 577                         if (submenu.searchMenu(func, names))
 578                                 return true;
 579                         names.pop_back();
 580                 }
 581         }
 582         return false;
 583 }
 584
 585
 586 bool compareFormat(Format const * p1, Format const * p2)
 587 {
 588         return *p1 < *p2;
 589 }
 590
 591
 592 QString limitStringLength(docstring const & str)
 593 {
 594         size_t const max_item_length = 45;
 595
 596         if (str.size() > max_item_length)
 597                 return toqstr(str.substr(0, max_item_length - 3) + "...");
 598
 599         return toqstr(str);
 600 }
 601
 602
 603 void MenuDefinition::expandLastfiles()
 604 {
 605         LastFilesSection::LastFiles const & lf = LyX::cref().session().lastFiles().lastFiles();
 606         LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
 607
 608         int ii = 1;
 609
 610         for (; lfit != lf.end() && ii < 10; ++lfit, ++ii) {
 611                 string const file = lfit->absFilename();
 612                 QString const label = QString("%1. %2|%3").arg(ii)
 613                         .arg(toqstr(makeDisplayPath(file, 30))).arg(ii);
 614                 add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, file)));
 615         }
 616 }
 617
 618
 619 void MenuDefinition::expandDocuments()
 620 {
 621         Buffer * first = theBufferList().first();
 622         if (first) {
 623                 Buffer * b = first;
 624                 int ii = 1;
 625
 626                 // We cannot use a for loop as the buffer list cycles.
 627                 do {
 628                         QString label = toqstr(b->fileName().displayName(20));
 629                         if (!b->isClean())
 630                                 label += "*";
 631                         if (ii < 10)
 632                                 label = QString::number(ii) + ". " + label + '|' + QString::number(ii);
 633                         add(MenuItem(MenuItem::Command, label,
 634                                 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
 635
 636                         b = theBufferList().next(b);
 637                         ++ii;
 638                 } while (b != first);
 639         } else {
 640                 add(MenuItem(MenuItem::Command, qt_("No Documents Open!"),
 641                            FuncRequest(LFUN_NOACTION)));
 642         }
 643 }
 644
 645
 646 void MenuDefinition::expandBookmarks()
 647 {
 648         lyx::BookmarksSection const & bm = LyX::cref().session().bookmarks();
 649
 650         for (size_t i = 1; i <= bm.size(); ++i) {
 651                 if (bm.isValid(i)) {
 652                         string const file = bm.bookmark(i).filename.absFilename();
 653                         QString const label = QString("%1. %2|%3").arg(i)
 654                                 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
 655                         add(MenuItem(MenuItem::Command, label,
 656                                 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
 657                 }
 658         }
 659 }
 660
 661
 662 void MenuDefinition::expandFormats(MenuItem::Kind kind, Buffer const * buf)
 663 {
 664         if (!buf && kind != MenuItem::ImportFormats) {
 665                 add(MenuItem(MenuItem::Command,
 666                                     qt_("No Document Open!"),
 667                                     FuncRequest(LFUN_NOACTION)));
 668                 return;
 669         }
 670
 671         typedef vector<Format const *> Formats;
 672         Formats formats;
 673         kb_action action;
 674
 675         switch (kind) {
 676         case MenuItem::ImportFormats:
 677                 formats = theConverters().importableFormats();
 678                 action = LFUN_BUFFER_IMPORT;
 679                 break;
 680         case MenuItem::ViewFormats:
 681                 formats = buf->exportableFormats(true);
 682                 action = LFUN_BUFFER_VIEW;
 683                 break;
 684         case MenuItem::UpdateFormats:
 685                 formats = buf->exportableFormats(true);
 686                 action = LFUN_BUFFER_UPDATE;
 687                 break;
 688         default:
 689                 formats = buf->exportableFormats(false);
 690                 action = LFUN_BUFFER_EXPORT;
 691         }
 692         sort(formats.begin(), formats.end(), &compareFormat);
 693
 694         Formats::const_iterator fit = formats.begin();
 695         Formats::const_iterator end = formats.end();
 696         for (; fit != end ; ++fit) {
 697                 if ((*fit)->dummy())
 698                         continue;
 699                 QString label = toqstr((*fit)->prettyname());
 700                 QString const shortcut = toqstr((*fit)->shortcut());
 701
 702                 switch (kind) {
 703                 case MenuItem::ImportFormats:
 704                         // FIXME: This is a hack, we should rather solve
 705                         // FIXME: bug 2488 instead.
 706                         if ((*fit)->name() == "text")
 707                                 label = qt_("Plain Text");
 708                         else if ((*fit)->name() == "textparagraph")
 709                                 label = qt_("Plain Text, Join Lines");
 710                         label += "...";
 711                         break;
 712                 case MenuItem::ViewFormats:
 713                 case MenuItem::ExportFormats:
 714                 case MenuItem::UpdateFormats:
 715                         if (!(*fit)->documentFormat())
 716                                 continue;
 717                         break;
 718                 default:
 719                         BOOST_ASSERT(false);
 720                         break;
 721                 }
 722                 // FIXME: if we had proper support for translating the
 723                 // format names defined in configure.py, there would
 724                 // not be a need to check whether the shortcut is
 725                 // correct. If we add it uncondiitonally, it would
 726                 // create useless warnings on bad shortcuts
 727                 if (!shortcut.isEmpty() && label.contains(shortcut))
 728                         label += '|' + shortcut;
 729
 730                 if (buf)
 731                         addWithStatusCheck(MenuItem(MenuItem::Command, label,
 732                                 FuncRequest(action, (*fit)->name())));
 733                 else
 734                         add(MenuItem(MenuItem::Command, label,
 735                                 FuncRequest(action, (*fit)->name())));
 736         }
 737 }
 738
 739
 740 void MenuDefinition::expandFloatListInsert(Buffer const * buf)
 741 {
 742         if (!buf) {
 743                 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
 744                                     FuncRequest(LFUN_NOACTION)));
 745                 return;
 746         }
 747
 748         FloatList const & floats = buf->params().documentClass().floats();
 749         FloatList::const_iterator cit = floats.begin();
 750         FloatList::const_iterator end = floats.end();
 751         for (; cit != end; ++cit) {
 752                 addWithStatusCheck(MenuItem(MenuItem::Command,
 753                                     qt_(cit->second.listName()),
 754                                     FuncRequest(LFUN_FLOAT_LIST,
 755                                                 cit->second.type())));
 756         }
 757 }
 758
 759
 760 void MenuDefinition::expandFloatInsert(Buffer const * buf)
 761 {
 762         if (!buf) {
 763                 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
 764                                     FuncRequest(LFUN_NOACTION)));
 765                 return;
 766         }
 767
 768         FloatList const & floats = buf->params().documentClass().floats();
 769         FloatList::const_iterator cit = floats.begin();
 770         FloatList::const_iterator end = floats.end();
 771         for (; cit != end; ++cit) {
 772                 // normal float
 773                 QString const label = qt_(cit->second.name());
 774                 addWithStatusCheck(MenuItem(MenuItem::Command, label,
 775                                     FuncRequest(LFUN_FLOAT_INSERT,
 776                                                 cit->second.type())));
 777         }
 778 }
 779
 780
 781 void MenuDefinition::expandFlexInsert(Buffer const * buf, string s)
 782 {
 783         if (!buf) {
 784                 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
 785                                     FuncRequest(LFUN_NOACTION)));
 786                 return;
 787         }
 788         TextClass::InsetLayouts const & insetLayouts =
 789                 buf->params().documentClass().insetLayouts();
 790         TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
 791         TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
 792         for (; cit != end; ++cit) {
 793                 docstring const label = cit->first;
 794                 if (cit->second.lyxtype() == s)
 795                         addWithStatusCheck(MenuItem(MenuItem::Command,
 796                                 toqstr(label), FuncRequest(LFUN_FLEX_INSERT,
 797                                                 label)));
 798         }
 799 }
 800
 801
 802 size_t const max_number_of_items = 25;
 803
 804 void MenuDefinition::expandToc2(Toc const & toc_list,
 805                 size_t from, size_t to, int depth)
 806 {
 807         int shortcut_count = 0;
 808
 809         // check whether depth is smaller than the smallest depth in toc.
 810         int min_depth = 1000;
 811         for (size_t i = from; i < to; ++i)
 812                 min_depth = min(min_depth, toc_list[i].depth());
 813         if (min_depth > depth)
 814                 depth = min_depth;
 815
 816         if (to - from <= max_number_of_items) {
 817                 for (size_t i = from; i < to; ++i) {
 818                         QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
 819                         label += limitStringLength(toc_list[i].str());
 820                         if (toc_list[i].depth() == depth
 821                             && shortcut_count < 9) {
 822                                 if (label.contains(QString::number(shortcut_count + 1)))
 823                                         label += '|' + QString::number(++shortcut_count);
 824                         }
 825                         add(MenuItem(MenuItem::Command, label,
 826                                             FuncRequest(toc_list[i].action())));
 827                 }
 828         } else {
 829                 size_t pos = from;
 830                 while (pos < to) {
 831                         size_t new_pos = pos + 1;
 832                         while (new_pos < to &&
 833                                toc_list[new_pos].depth() > depth)
 834                                 ++new_pos;
 835
 836                         QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
 837                         label += limitStringLength(toc_list[pos].str());
 838                         if (toc_list[pos].depth() == depth &&
 839                             shortcut_count < 9) {
 840                                 if (label.contains(QString::number(shortcut_count + 1)))
 841                                         label += '|' + QString::number(++shortcut_count);
 842                         }
 843                         if (new_pos == pos + 1) {
 844                                 add(MenuItem(MenuItem::Command,
 845                                                     label, FuncRequest(toc_list[pos].action())));
 846                         } else {
 847                                 MenuItem item(MenuItem::Submenu, label);
 848                                 item.setSubmenu(new MenuDefinition);
 849                                 item.submenu()->expandToc2(toc_list, pos, new_pos, depth + 1);
 850                                 add(item);
 851                         }
 852                         pos = new_pos;
 853                 }
 854         }
 855 }
 856
 857
 858 void MenuDefinition::expandToc(Buffer const * buf)
 859 {
 860         // To make things very cleanly, we would have to pass buf to
 861         // all MenuItem constructors and to expandToc2. However, we
 862         // know that all the entries in a TOC will be have status_ ==
 863         // OK, so we avoid this unnecessary overhead (JMarc)
 864
 865         if (!buf) {
 866                 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
 867                                     FuncRequest(LFUN_NOACTION)));
 868                 return;
 869         }
 870
 871         Buffer* cbuf = const_cast<Buffer*>(buf);
 872         cbuf->tocBackend().update();
 873         cbuf->structureChanged();
 874
 875         // Add an entry for the master doc if this is a child doc
 876         Buffer const * const master = buf->masterBuffer();
 877         if (buf != master) {
 878                 ParIterator const pit = par_iterator_begin(master->inset());
 879                 string const arg = convert<string>(pit->id());
 880                 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
 881                 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
 882         }
 883
 884         FloatList const & floatlist = buf->params().documentClass().floats();
 885         TocList const & toc_list = buf->tocBackend().tocs();
 886         TocList::const_iterator cit = toc_list.begin();
 887         TocList::const_iterator end = toc_list.end();
 888         for (; cit != end; ++cit) {
 889                 // Handle this later
 890                 if (cit->first == "tableofcontents")
 891                         continue;
 892
 893                 // All the rest is for floats
 894                 MenuDefinition * submenu = new MenuDefinition;
 895                 TocIterator ccit = cit->second.begin();
 896                 TocIterator eend = cit->second.end();
 897                 for (; ccit != eend; ++ccit) {
 898                         QString const label = limitStringLength(ccit->str());
 899                         submenu->add(MenuItem(MenuItem::Command, label,
 900                                            FuncRequest(ccit->action())));
 901                 }
 902                 string const & floatName = floatlist.getType(cit->first).listName();
 903                 QString label;
 904                 if (!floatName.empty())
 905                         label = qt_(floatName);
 906                 // BUG3633: listings is not a proper float so its name
 907                 // is not shown in floatlist.
 908                 else if (cit->first == "equation")
 909                         label = qt_("List of Equations");
 910                 else if (cit->first == "index")
 911                         label = qt_("List of Indexes");
 912                 else if (cit->first == "listing")
 913                         label = qt_("List of Listings");
 914                 else if (cit->first == "marginalnote")
 915                         label = qt_("List of Marginal notes");
 916                 else if (cit->first == "note")
 917                         label = qt_("List of Notes");
 918                 else if (cit->first == "footnote")
 919                         label = qt_("List of Foot notes");
 920                 else if (cit->first == "label")
 921                         label = qt_("Labels and References");
 922                 else if (cit->first == "citation")
 923                         label = qt_("List of Citations");
 924                 // this should not happen now, but if something else like
 925                 // listings is added later, this can avoid an empty menu name.
 926                 else
 927                         label = qt_("Other floats");
 928                 MenuItem item(MenuItem::Submenu, label);
 929                 item.setSubmenu(submenu);
 930                 add(item);
 931         }
 932
 933         // Handle normal TOC
 934         cit = toc_list.find("tableofcontents");
 935         if (cit == end) {
 936                 addWithStatusCheck(MenuItem(MenuItem::Command,
 937                                     qt_("No Table of contents"),
 938                                     FuncRequest()));
 939         } else {
 940                 expandToc2(cit->second, 0, cit->second.size(), 0);
 941         }
 942 }
 943
 944
 945 void MenuDefinition::expandPasteRecent()
 946 {
 947         vector<docstring> const sel = cap::availableSelections();
 948
 949         vector<docstring>::const_iterator cit = sel.begin();
 950         vector<docstring>::const_iterator end = sel.end();
 951
 952         for (unsigned int index = 0; cit != end; ++cit, ++index) {
 953                 add(MenuItem(MenuItem::Command, toqstr(*cit),
 954                                     FuncRequest(LFUN_PASTE, convert<string>(index))));
 955         }
 956 }
 957
 958
 959 void MenuDefinition::expandToolbars()
 960 {
 961         //
 962         // extracts the toolbars from the backend
 963         ToolbarBackend::Toolbars::const_iterator cit = toolbarbackend.begin();
 964         ToolbarBackend::Toolbars::const_iterator end = toolbarbackend.end();
 965
 966         for (; cit != end; ++cit) {
 967                 QString label = qt_(cit->gui_name);
 968                 // frontends are not supposed to turn on/off toolbars,
 969                 // if they cannot update ToolbarBackend::flags. That
 970                 // is to say, ToolbarsBackend::flags should reflect
 971                 // the true state of toolbars.
 972                 //
 973                 // menu is displayed as
 974                 //       on/off review
 975                 // and
 976                 //              review (auto)
 977                 // in the case of auto.
 978                 if (cit->flags & ToolbarInfo::AUTO)
 979                         label += qt_(" (auto)");
 980                 add(MenuItem(MenuItem::Command, label,
 981                                     FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name + " allowauto")));
 982         }
 983 }
 984
 985
 986 void MenuDefinition::expandBranches(Buffer const * buf)
 987 {
 988         if (!buf) {
 989                 add(MenuItem(MenuItem::Command,
 990                                     qt_("No Document Open!"),
 991                                     FuncRequest(LFUN_NOACTION)));
 992                 return;
 993         }
 994
 995         BufferParams const & params = buf->masterBuffer()->params();
 996         if (params.branchlist().empty()) {
 997                 add(MenuItem(MenuItem::Command,
 998                                     qt_("No Branch in Document!"),
 999                                     FuncRequest(LFUN_NOACTION)));
1000                 return;
1001         }
1002
1003         BranchList::const_iterator cit = params.branchlist().begin();
1004         BranchList::const_iterator end = params.branchlist().end();
1005
1006         for (int ii = 1; cit != end; ++cit, ++ii) {
1007                 docstring label = cit->getBranch();
1008                 if (ii < 10)
1009                         label = convert<docstring>(ii) + ". " + label + char_type('|') + convert<docstring>(ii);
1010                 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1011                                     FuncRequest(LFUN_BRANCH_INSERT,
1012                                                 cit->getBranch())));
1013         }
1014 }
1015
1016 } // namespace anon
1017
1018
1019 /////////////////////////////////////////////////////////////////////
1020 // Menu::Impl definition and implementation
1021 /////////////////////////////////////////////////////////////////////
1022
1023 struct Menu::Impl
1024 {
1025         /// populates the menu or one of its submenu
1026         /// This is used as a recursive function
1027         void populate(QMenu * qMenu, MenuDefinition * menu);
1028
1029         /// Only needed for top level menus.
1030         MenuDefinition * top_level_menu;
1031         /// our owning view
1032         GuiView * view;
1033         /// the name of this menu
1034         QString name;
1035 };
1036
1037
1038
1039 /// Get a MenuDefinition item label from the menu backend
1040 static QString label(MenuItem const & mi)
1041 {
1042         QString label = mi.label();
1043         label.replace("&", "&&");
1044
1045         QString shortcut = mi.shortcut();
1046         if (!shortcut.isEmpty()) {
1047                 int pos = label.indexOf(shortcut);
1048                 if (pos != -1)
1049                         //label.insert(pos, 1, char_type('&'));
1050                         label.replace(pos, 0, "&");
1051         }
1052
1053         QString const binding = mi.binding();
1054         if (!binding.isEmpty())
1055                 label += '\t' + binding;
1056
1057         return label;
1058 }
1059
1060 void Menu::Impl::populate(QMenu * qMenu, MenuDefinition * menu)
1061 {
1062         LYXERR(Debug::GUI, "populating menu " << fromqstr(menu->name()));
1063         if (menu->size() == 0) {
1064                 LYXERR(Debug::GUI, "\tERROR: empty menu " << fromqstr(menu->name()));
1065                 return;
1066         }
1067         LYXERR(Debug::GUI, " *****  menu entries " << menu->size());
1068         MenuDefinition::const_iterator m = menu->begin();
1069         MenuDefinition::const_iterator end = menu->end();
1070         for (; m != end; ++m) {
1071                 if (m->kind() == MenuItem::Separator)
1072                         qMenu->addSeparator();
1073                 else if (m->kind() == MenuItem::Submenu) {
1074                         QMenu * subMenu = qMenu->addMenu(label(*m));
1075                         populate(subMenu, m->submenu());
1076                 } else {
1077                         // we have a MenuItem::Command
1078                         qMenu->addAction(new Action(*view, QIcon(), label(*m), m->func(),
1079                                 QString()));
1080                 }
1081         }
1082 }
1083
1084 /////////////////////////////////////////////////////////////////////
1085 // Menu implementation
1086 /////////////////////////////////////////////////////////////////////
1087
1088 Menu::Menu(GuiView * gv, QString const & name, bool top_level)
1089 : d(new Menu::Impl)
1090 {
1091         d->top_level_menu = top_level? new MenuDefinition : 0;
1092         d->view = gv;
1093         d->name = name;
1094         setTitle(name);
1095         if (d->top_level_menu)
1096                 connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView()));
1097 }
1098
1099
1100 Menu::~Menu()
1101 {
1102         delete d->top_level_menu;
1103         delete d;
1104 }
1105
1106
1107 void Menu::updateView()
1108 {
1109         guiApp->menus().updateMenu(d->name);
1110 }
1111
1112 /////////////////////////////////////////////////////////////////////
1113 // Menus::Impl definition and implementation
1114 /////////////////////////////////////////////////////////////////////
1115
1116 struct Menus::Impl {
1117         ///
1118         bool hasMenu(QString const &) const;
1119         ///
1120         MenuDefinition & getMenu(QString const &);
1121         ///
1122         MenuDefinition const & getMenu(QString const &) const;
1123
1124         /// Expands some special entries of the menu
1125         /** The entries with the following kind are expanded to a
1126             sequence of Command MenuItems: Lastfiles, Documents,
1127             ViewFormats, ExportFormats, UpdateFormats, Branches
1128         */
1129         void expand(MenuDefinition const & frommenu, MenuDefinition & tomenu,
1130                     Buffer const *) const;
1131
1132         /// Initialize specific MACOS X menubar
1133         void macxMenuBarInit(GuiView * view);
1134
1135         /// Mac special menu.
1136         /** This defines a menu whose entries list the FuncRequests
1137             that will be removed by expand() in other menus. This is
1138             used by the Qt/Mac code
1139         */
1140         MenuDefinition specialmenu_;
1141
1142         ///
1143         MenuList menulist_;
1144         ///
1145         MenuDefinition menubar_;
1146
1147         typedef QHash<QString, Menu *> NameMap;
1148
1149         /// name to menu for \c menu() method.
1150         NameMap name_map_;
1151 };
1152
1153 /*
1154   Here is what the Qt documentation says about how a menubar is chosen:
1155
1156      1) If the window has a QMenuBar then it is used. 2) If the window
1157      is a modal then its menubar is used. If no menubar is specified
1158      then a default menubar is used (as documented below) 3) If the
1159      window has no parent then the default menubar is used (as
1160      documented below).
1161
1162      The above 3 steps are applied all the way up the parent window
1163      chain until one of the above are satisifed. If all else fails a
1164      default menubar will be created, the default menubar on Qt/Mac is
1165      an empty menubar, however you can create a different default
1166      menubar by creating a parentless QMenuBar, the first one created
1167      will thus be designated the default menubar, and will be used
1168      whenever a default menubar is needed.
1169
1170   Thus, for Qt/Mac, we add the menus to a free standing menubar, so
1171   that this menubar will be used also when one of LyX' dialogs has
1172   focus. (JMarc)
1173 */
1174 void Menus::Impl::macxMenuBarInit(GuiView * view)
1175 {
1176         // The Mac menubar initialisation must be done only once!
1177         static bool done = false;
1178         if (done)
1179                 return;
1180         done = true;
1181
1182         /* Since Qt 4.2, the qt/mac menu code has special code for
1183            specifying the role of a menu entry. However, it does not
1184            work very well with our scheme of creating menus on demand,
1185            and therefore we need to put these entries in a special
1186            invisible menu. (JMarc)
1187         */
1188
1189         /* The entries of our special mac menu. If we add support for
1190          * special entries in Menus, we could imagine something
1191          * like
1192          *    SpecialItem About " "About LyX" "dialog-show aboutlyx"
1193          * and therefore avoid hardcoding. I am not sure it is worth
1194          * the hassle, though. (JMarc)
1195          */
1196         struct MacMenuEntry {
1197                 kb_action action;
1198                 char const * arg;
1199                 char const * label;
1200                 QAction::MenuRole role;
1201         };
1202
1203         MacMenuEntry entries[] = {
1204                 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
1205                  QAction::AboutRole},
1206                 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
1207                  QAction::PreferencesRole},
1208                 {LFUN_RECONFIGURE, "", "Reconfigure",
1209                  QAction::ApplicationSpecificRole},
1210                 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
1211         };
1212         const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
1213
1214         // the special menu for Menus.
1215         for (size_t i = 0 ; i < num_entries ; ++i) {
1216                 FuncRequest const func(entries[i].action,
1217                                        from_utf8(entries[i].arg));
1218                 specialmenu_.add(MenuItem(MenuItem::Command, entries[i].label, func));
1219         }
1220
1221         // add the entries to a QMenu that will eventually be empty
1222         // and therefore invisible.
1223         QMenu * qMenu = view->menuBar()->addMenu("special");
1224         MenuDefinition::const_iterator cit = specialmenu_.begin();
1225         MenuDefinition::const_iterator end = specialmenu_.end();
1226         for (size_t i = 0 ; cit != end ; ++cit, ++i) {
1227                 Action * action = new Action(*view, QIcon(), cit->label(),
1228                                              cit->func(), QString());
1229                 action->setMenuRole(entries[i].role);
1230                 qMenu->addAction(action);
1231         }
1232 }
1233
1234
1235 void Menus::Impl::expand(MenuDefinition const & frommenu, MenuDefinition & tomenu,
1236                          Buffer const * buf) const
1237 {
1238         if (!tomenu.empty())
1239                 tomenu.clear();
1240
1241         for (MenuDefinition::const_iterator cit = frommenu.begin();
1242              cit != frommenu.end() ; ++cit) {
1243                 switch (cit->kind()) {
1244                 case MenuItem::Lastfiles:
1245                         tomenu.expandLastfiles();
1246                         break;
1247
1248                 case MenuItem::Documents:
1249                         tomenu.expandDocuments();
1250                         break;
1251
1252                 case MenuItem::Bookmarks:
1253                         tomenu.expandBookmarks();
1254                         break;
1255
1256                 case MenuItem::ImportFormats:
1257                 case MenuItem::ViewFormats:
1258                 case MenuItem::UpdateFormats:
1259                 case MenuItem::ExportFormats:
1260                         tomenu.expandFormats(cit->kind(), buf);
1261                         break;
1262
1263                 case MenuItem::CharStyles:
1264                         tomenu.expandFlexInsert(buf, "charstyle");
1265                         break;
1266
1267                 case MenuItem::Custom:
1268                         tomenu.expandFlexInsert(buf, "custom");
1269                         break;
1270
1271                 case MenuItem::Elements:
1272                         tomenu.expandFlexInsert(buf, "element");
1273                         break;
1274
1275                 case MenuItem::FloatListInsert:
1276                         tomenu.expandFloatListInsert(buf);
1277                         break;
1278
1279                 case MenuItem::FloatInsert:
1280                         tomenu.expandFloatInsert(buf);
1281                         break;
1282
1283                 case MenuItem::PasteRecent:
1284                         tomenu.expandPasteRecent();
1285                         break;
1286
1287                 case MenuItem::Toolbars:
1288                         tomenu.expandToolbars();
1289                         break;
1290
1291                 case MenuItem::Branches:
1292                         tomenu.expandBranches(buf);
1293                         break;
1294
1295                 case MenuItem::Toc:
1296                         tomenu.expandToc(buf);
1297                         break;
1298
1299                 case MenuItem::Submenu: {
1300                         MenuItem item(*cit);
1301                         item.setSubmenu(new MenuDefinition(cit->submenuname()));
1302                         expand(getMenu(cit->submenuname()), *item.submenu(), buf);
1303                         tomenu.addWithStatusCheck(item);
1304                 }
1305                 break;
1306
1307                 case MenuItem::Separator:
1308                         tomenu.addWithStatusCheck(*cit);
1309                         break;
1310
1311                 case MenuItem::Command:
1312                         if (!specialmenu_.hasFunc(cit->func()))
1313                                 tomenu.addWithStatusCheck(*cit);
1314                 }
1315         }
1316
1317         // we do not want the menu to end with a separator
1318         if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
1319                 tomenu.items_.pop_back();
1320
1321         // Check whether the shortcuts are unique
1322         tomenu.checkShortcuts();
1323 }
1324
1325
1326 bool Menus::Impl::hasMenu(QString const & name) const
1327 {
1328         return find_if(menulist_.begin(), menulist_.end(),
1329                 MenuNamesEqual(name)) != menulist_.end();
1330 }
1331
1332
1333 MenuDefinition const & Menus::Impl::getMenu(QString const & name) const
1334 {
1335         const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
1336                 MenuNamesEqual(name));
1337         if (cit == menulist_.end())
1338                 lyxerr << "No submenu named " << fromqstr(name) << endl;
1339         BOOST_ASSERT(cit != menulist_.end());
1340         return (*cit);
1341 }
1342
1343
1344 MenuDefinition & Menus::Impl::getMenu(QString const & name)
1345 {
1346         iterator it = find_if(menulist_.begin(), menulist_.end(),
1347                 MenuNamesEqual(name));
1348         if (it == menulist_.end())
1349                 lyxerr << "No submenu named " << fromqstr(name) << endl;
1350         BOOST_ASSERT(it != menulist_.end());
1351         return (*it);
1352 }
1353
1354 /////////////////////////////////////////////////////////////////////
1355 // Menus implementation
1356 /////////////////////////////////////////////////////////////////////
1357
1358 Menus::Menus(): d(new Impl) {}
1359
1360
1361 void Menus::read(Lexer & lex)
1362 {
1363         enum Menutags {
1364                 md_menu = 1,
1365                 md_menubar,
1366                 md_endmenuset,
1367                 md_last
1368         };
1369
1370         struct keyword_item menutags[md_last - 1] = {
1371                 { "end", md_endmenuset },
1372                 { "menu", md_menu },
1373                 { "menubar", md_menubar }
1374         };
1375
1376         //consistency check
1377         if (compare_ascii_no_case(lex.getString(), "menuset")) {
1378                 lyxerr << "Menubackend::read: ERROR wrong token:`"
1379                        << lex.getString() << '\'' << endl;
1380         }
1381
1382         lex.pushTable(menutags, md_last - 1);
1383         if (lyxerr.debugging(Debug::PARSER))
1384                 lex.printTable(lyxerr);
1385
1386         bool quit = false;
1387
1388         while (lex.isOK() && !quit) {
1389                 switch (lex.lex()) {
1390                 case md_menubar:
1391                         d->menubar_.read(lex);
1392                         break;
1393                 case md_menu: {
1394                         lex.next(true);
1395                         QString const name = toqstr(lex.getDocString());
1396                         if (d->hasMenu(name))
1397                                 d->getMenu(name).read(lex);
1398                         else {
1399                                 MenuDefinition menu(name);
1400                                 menu.read(lex);
1401                                 d->menulist_.push_back(menu);
1402                         }
1403                         break;
1404                 }
1405                 case md_endmenuset:
1406                         quit = true;
1407                         break;
1408                 default:
1409                         lex.printError("menubackend::read: "
1410                                        "Unknown menu tag: `$$Token'");
1411                         break;
1412                 }
1413         }
1414         lex.popTable();
1415 }
1416
1417
1418 bool Menus::searchMenu(FuncRequest const & func,
1419         vector<docstring> & names) const
1420 {
1421         return d->menubar_.searchMenu(func, names);
1422 }
1423
1424
1425 void Menus::fillMenuBar(GuiView * view)
1426 {
1427         // Clear all menubar contents before filling it.
1428         view->menuBar()->clear();
1429
1430 #ifdef Q_WS_MACX
1431         // setup special mac specific menu item
1432         d->macxMenuBarInit(view);
1433 #endif
1434
1435         LYXERR(Debug::GUI, "populating menu bar" << fromqstr(d->menubar_.name()));
1436
1437         if (d->menubar_.size() == 0) {
1438                 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
1439                         << fromqstr(d->menubar_.name()));
1440                 return;
1441         }
1442         else {
1443                 LYXERR(Debug::GUI, "menu bar entries "
1444                         << d->menubar_.size());
1445         }
1446
1447         MenuDefinition menu;
1448         d->expand(d->menubar_, menu, view->buffer());
1449
1450         MenuDefinition::const_iterator m = menu.begin();
1451         MenuDefinition::const_iterator end = menu.end();
1452
1453         for (; m != end; ++m) {
1454
1455                 if (m->kind() != MenuItem::Submenu) {
1456                         LYXERR(Debug::GUI, "\tERROR: not a submenu " << fromqstr(m->label()));
1457                         continue;
1458                 }
1459
1460                 LYXERR(Debug::GUI, "menu bar item " << fromqstr(m->label())
1461                         << " is a submenu named " << fromqstr(m->submenuname()));
1462
1463                 QString name = m->submenuname();
1464                 if (!d->hasMenu(name)) {
1465                         LYXERR(Debug::GUI, "\tERROR: " << fromqstr(name)
1466                                 << " submenu has no menu!");
1467                         continue;
1468                 }
1469
1470                 Menu * menu = new Menu(view, m->submenuname(), true);
1471                 menu->setTitle(label(*m));
1472                 view->menuBar()->addMenu(menu);
1473
1474                 d->name_map_[name] = menu;
1475         }
1476 }
1477
1478
1479 void Menus::updateMenu(QString const & name)
1480 {
1481         Menu * qmenu = d->name_map_[name];
1482         LYXERR(Debug::GUI, "Triggered menu: " << fromqstr(name));
1483         qmenu->clear();
1484
1485         if (qmenu->d->name.isEmpty())
1486                 return;
1487
1488         // Here, We make sure that theLyXFunc points to the correct LyXView.
1489         theLyXFunc().setLyXView(qmenu->d->view);
1490
1491         if (!d->hasMenu(name)) {
1492                 qmenu->addAction(qt_("No action defined!"));
1493                 LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
1494                         << fromqstr(qmenu->d->name));
1495                 return;
1496         }
1497
1498         MenuDefinition const & fromLyxMenu = d->getMenu(name);
1499         d->expand(fromLyxMenu, *qmenu->d->top_level_menu, qmenu->d->view->buffer());
1500         qmenu->d->populate(qmenu, qmenu->d->top_level_menu);
1501 }
1502
1503
1504 Menu * Menus::menu(QString const & name, GuiView & view)
1505 {
1506         LYXERR(Debug::GUI, "Context menu requested: " << fromqstr(name));
1507         Menu * menu = d->name_map_.value(name, 0);
1508         if (!menu && !name.startsWith("context-")) {
1509                 LYXERR0("resquested context menu not found: " << fromqstr(name));
1510                 return 0;
1511         }
1512
1513         menu = new Menu(&view, name, true);
1514         d->name_map_[name] = menu;
1515         return menu;
1516 }
1517
1518 } // namespace frontend
1519 } // namespace lyx
1520
1521 #include "Menus_moc.cpp"