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