src/frontends/qt4/Menus.cpp

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