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