src/MenuBackend.cpp

   1 /**
   2  * \file MenuBackend.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Asger Alstrup
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author André Pönitz
  10  * \author Dekel Tsur
  11  * \author Martin Vermeer
  12  *
  13  * Full author contact details are available in file CREDITS.
  14  */
  15
  16 #include <config.h>
  17
  18 #include "MenuBackend.h"
  19
  20 #include "BranchList.h"
  21 #include "Buffer.h"
  22 #include "BufferList.h"
  23 #include "BufferParams.h"
  24 #include "Converter.h"
  25 #include "CutAndPaste.h"
  26 #include "support/debug.h"
  27 #include "Floating.h"
  28 #include "FloatList.h"
  29 #include "Format.h"
  30 #include "support/gettext.h"
  31 #include "KeyMap.h"
  32 #include "Session.h"
  33 #include "LyXAction.h"
  34 #include "LyX.h" // for lastfiles
  35 #include "LyXFunc.h"
  36 #include "Lexer.h"
  37 #include "Paragraph.h"
  38 #include "TextClass.h"
  39 #include "TocBackend.h"
  40 #include "ToolbarBackend.h"
  41
  42 #include "frontends/Application.h"
  43
  44 #include "support/filetools.h"
  45 #include "support/lstrings.h"
  46 #include "support/convert.h"
  47
  48 #include <boost/bind.hpp>
  49
  50 #include <algorithm>
  51 #include <ostream>
  52
  53 using namespace std;
  54 using boost::bind;
  55 using namespace lyx::support;
  56
  57 namespace lyx {
  58
  59 namespace {
  60
  61 class MenuNamesEqual : public unary_function<Menu, bool> {
  62 public:
  63         MenuNamesEqual(docstring const & name)
  64                 : name_(name) {}
  65         bool operator()(Menu const & menu) const {
  66                 return menu.name() == name_;
  67         }
  68 private:
  69         docstring name_;
  70 };
  71
  72 } // namespace anon
  73
  74
  75 MenuItem::MenuItem(Kind kind)
  76         : kind_(kind), optional_(false)
  77 {}
  78
  79
  80 MenuItem::MenuItem(Kind kind, docstring const & label,
  81                    docstring const & submenu, bool optional)
  82         : kind_(kind), label_(label),
  83           submenuname_(submenu), optional_(optional)
  84 {
  85         BOOST_ASSERT(kind == Submenu);
  86 }
  87
  88
  89 MenuItem::MenuItem(Kind kind, docstring const & label,
  90                    FuncRequest const & func, bool optional)
  91         : kind_(kind), label_(label), func_(func), optional_(optional)
  92 {
  93         func_.origin = FuncRequest::MENU;
  94 }
  95
  96
  97 MenuItem::~MenuItem()
  98 {}
  99
 100
 101 void MenuItem::submenu(Menu * menu)
 102 {
 103         submenu_.reset(menu);
 104 }
 105
 106
 107 docstring const MenuItem::label() const
 108 {
 109         return token(label_, char_type('|'), 0);
 110 }
 111
 112
 113 docstring const MenuItem::shortcut() const
 114 {
 115         return token(label_, char_type('|'), 1);
 116 }
 117
 118
 119 docstring const MenuItem::binding() const
 120 {
 121         if (kind_ != Command)
 122                 return docstring();
 123
 124         // Get the keys bound to this action, but keep only the
 125         // first one later
 126         KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func_);
 127
 128         if (bindings.size())
 129                 return bindings.begin()->print(KeySequence::ForGui);
 130
 131         LYXERR(Debug::KBMAP, "No binding for "
 132                 << lyxaction.getActionName(func_.action)
 133                 << '(' << to_utf8(func_.argument()) << ')');
 134         return docstring();
 135 }
 136
 137
 138 Menu & Menu::add(MenuItem const & i)
 139 {
 140         items_.push_back(i);
 141         return *this;
 142 }
 143
 144
 145 Menu & Menu::addWithStatusCheck(MenuItem const & i)
 146 {
 147         switch (i.kind()) {
 148
 149         case MenuItem::Command: {
 150                 FuncStatus status = lyx::getStatus(i.func());
 151                 if (status.unknown() || (!status.enabled() && i.optional()))
 152                         break;
 153                 items_.push_back(i);
 154                 items_.back().status(status);
 155                 break;
 156         }
 157
 158         case MenuItem::Submenu: {
 159                 if (i.submenu()) {
 160                         bool enabled = false;
 161                         for (const_iterator cit = i.submenu()->begin();
 162                              cit != i.submenu()->end(); ++cit) {
 163                                 if ((cit->kind() == MenuItem::Command
 164                                      || cit->kind() == MenuItem::Submenu)
 165                                     && cit->status().enabled()) {
 166                                         enabled = true;
 167                                         break;
 168                                 }
 169                         }
 170                         if (enabled || !i.optional()) {
 171                                 items_.push_back(i);
 172                                 items_.back().status().enabled(enabled);
 173                         }
 174                 }
 175                 else
 176                         items_.push_back(i);
 177                 break;
 178         }
 179
 180         case MenuItem::Separator:
 181                 if (!items_.empty()
 182                     && items_.back().kind() != MenuItem::Separator)
 183                         items_.push_back(i);
 184                 break;
 185
 186         default:
 187                 items_.push_back(i);
 188         }
 189
 190         return *this;
 191 }
 192
 193
 194 Menu & Menu::read(Lexer & lex)
 195 {
 196         enum Menutags {
 197                 md_item = 1,
 198                 md_branches,
 199                 md_documents,
 200                 md_bookmarks,
 201                 md_charstyles,
 202                 md_custom,
 203                 md_elements,
 204                 md_endmenu,
 205                 md_exportformats,
 206                 md_importformats,
 207                 md_lastfiles,
 208                 md_optitem,
 209                 md_optsubmenu,
 210                 md_separator,
 211                 md_submenu,
 212                 md_toc,
 213                 md_updateformats,
 214                 md_viewformats,
 215                 md_floatlistinsert,
 216                 md_floatinsert,
 217                 md_pasterecent,
 218                 md_toolbars,
 219                 md_last
 220         };
 221
 222         struct keyword_item menutags[md_last - 1] = {
 223                 { "bookmarks", md_bookmarks },
 224                 { "branches", md_branches },
 225                 { "charstyles", md_charstyles },
 226                 { "custom", md_custom },
 227                 { "documents", md_documents },
 228                 { "elements", md_elements },
 229                 { "end", md_endmenu },
 230                 { "exportformats", md_exportformats },
 231                 { "floatinsert", md_floatinsert },
 232                 { "floatlistinsert", md_floatlistinsert },
 233                 { "importformats", md_importformats },
 234                 { "item", md_item },
 235                 { "lastfiles", md_lastfiles },
 236                 { "optitem", md_optitem },
 237                 { "optsubmenu", md_optsubmenu },
 238                 { "pasterecent", md_pasterecent },
 239                 { "separator", md_separator },
 240                 { "submenu", md_submenu },
 241                 { "toc", md_toc },
 242                 { "toolbars", md_toolbars },
 243                 { "updateformats", md_updateformats },
 244                 { "viewformats", md_viewformats }
 245         };
 246
 247         lex.pushTable(menutags, md_last - 1);
 248         if (lyxerr.debugging(Debug::PARSER))
 249                 lex.printTable(lyxerr);
 250
 251         bool quit = false;
 252         bool optional = false;
 253
 254         while (lex.isOK() && !quit) {
 255                 switch (lex.lex()) {
 256                 case md_optitem:
 257                         optional = true;
 258                         // fallback to md_item
 259                 case md_item: {
 260                         lex.next(true);
 261                         docstring const name = translateIfPossible(lex.getDocString());
 262                         lex.next(true);
 263                         string const command = lex.getString();
 264                         FuncRequest func = lyxaction.lookupFunc(command);
 265                         add(MenuItem(MenuItem::Command, name, func, optional));
 266                         optional = false;
 267                         break;
 268                 }
 269
 270                 case md_separator:
 271                         add(MenuItem(MenuItem::Separator));
 272                         break;
 273
 274                 case md_lastfiles:
 275                         add(MenuItem(MenuItem::Lastfiles));
 276                         break;
 277
 278                 case md_charstyles:
 279                         add(MenuItem(MenuItem::CharStyles));
 280                         break;
 281
 282                 case md_custom:
 283                         add(MenuItem(MenuItem::Custom));
 284                         break;
 285
 286                 case md_elements:
 287                         add(MenuItem(MenuItem::Elements));
 288                         break;
 289
 290                 case md_documents:
 291                         add(MenuItem(MenuItem::Documents));
 292                         break;
 293
 294                 case md_bookmarks:
 295                         add(MenuItem(MenuItem::Bookmarks));
 296                         break;
 297
 298                 case md_toc:
 299                         add(MenuItem(MenuItem::Toc));
 300                         break;
 301
 302                 case md_viewformats:
 303                         add(MenuItem(MenuItem::ViewFormats));
 304                         break;
 305
 306                 case md_updateformats:
 307                         add(MenuItem(MenuItem::UpdateFormats));
 308                         break;
 309
 310                 case md_exportformats:
 311                         add(MenuItem(MenuItem::ExportFormats));
 312                         break;
 313
 314                 case md_importformats:
 315                         add(MenuItem(MenuItem::ImportFormats));
 316                         break;
 317
 318                 case md_floatlistinsert:
 319                         add(MenuItem(MenuItem::FloatListInsert));
 320                         break;
 321
 322                 case md_floatinsert:
 323                         add(MenuItem(MenuItem::FloatInsert));
 324                         break;
 325
 326                 case md_pasterecent:
 327                         add(MenuItem(MenuItem::PasteRecent));
 328                         break;
 329
 330                 case md_toolbars:
 331                         add(MenuItem(MenuItem::Toolbars));
 332                         break;
 333
 334                 case md_branches:
 335                         add(MenuItem(MenuItem::Branches));
 336                         break;
 337
 338                 case md_optsubmenu:
 339                         optional = true;
 340                         // fallback to md_submenu
 341                 case md_submenu: {
 342                         lex.next(true);
 343                         docstring const mlabel = translateIfPossible(lex.getDocString());
 344                         lex.next(true);
 345                         docstring const mname = lex.getDocString();
 346                         add(MenuItem(MenuItem::Submenu, mlabel, mname,
 347                                      optional));
 348                         optional = false;
 349                         break;
 350                 }
 351
 352                 case md_endmenu:
 353                         quit = true;
 354                         break;
 355
 356                 default:
 357                         lex.printError("Menu::read: "
 358                                        "Unknown menu tag: `$$Token'");
 359                         break;
 360                 }
 361         }
 362         lex.popTable();
 363         return *this;
 364 }
 365
 366
 367 MenuItem const & Menu::operator[](size_type i) const
 368 {
 369         return items_[i];
 370 }
 371
 372
 373 bool Menu::hasFunc(FuncRequest const & func) const
 374 {
 375         return find_if(begin(), end(),
 376                        bind(equal_to<FuncRequest>(),
 377                             bind(&MenuItem::func, _1),
 378                             func)) != end();
 379 }
 380
 381 void Menu::checkShortcuts() const
 382 {
 383         // This is a quadratic algorithm, but we do not care because
 384         // menus are short enough
 385         for (const_iterator it1 = begin(); it1 != end(); ++it1) {
 386                 docstring shortcut = it1->shortcut();
 387                 if (shortcut.empty())
 388                         continue;
 389                 if (!contains(it1->label(), shortcut))
 390                         lyxerr << "Menu warning: menu entry \""
 391                                << to_utf8(it1->label())
 392                                << "\" does not contain shortcut `"
 393                                << to_utf8(shortcut) << "'." << endl;
 394                 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
 395                         if (!compare_ascii_no_case(it2->shortcut(), shortcut)) {
 396                                 lyxerr << "Menu warning: menu entries "
 397                                        << '"' << to_utf8(it1->fulllabel())
 398                                        << "\" and \"" << to_utf8(it2->fulllabel())
 399                                        << "\" share the same shortcut."
 400                                        << endl;
 401                         }
 402                 }
 403         }
 404 }
 405
 406
 407 bool Menu::searchFunc(FuncRequest & func, stack<docstring> & names) const
 408 {
 409         const_iterator m = begin();
 410         const_iterator m_end = end();
 411         for (; m != m_end; ++m) {
 412                 if (m->kind() == MenuItem::Command && m->func() == func) {
 413                         names.push(m->label());
 414                         return true;
 415                 } else if (m->kind() == MenuItem::Submenu) {
 416                         names.push(m->label());
 417                         Menu submenu = theApp()->menuBackend().getMenu(m->submenuname());
 418                         if (submenu.searchFunc(func, names))
 419                                 return true;
 420                         else
 421                                 names.pop();
 422                 }
 423         }
 424         return false;
 425 }
 426
 427
 428 void MenuBackend::specialMenu(Menu const & menu)
 429 {
 430         specialmenu_ = menu;
 431 }
 432
 433
 434 namespace {
 435
 436 class compare_format {
 437 public:
 438         bool operator()(Format const * p1, Format const * p2) {
 439                 return *p1 < *p2;
 440         }
 441 };
 442
 443 docstring const limit_string_length(docstring const & str)
 444 {
 445         docstring::size_type const max_item_length = 45;
 446
 447         if (str.size() > max_item_length)
 448                 return str.substr(0, max_item_length - 3) + "...";
 449         else
 450                 return str;
 451 }
 452
 453
 454 void expandLastfiles(Menu & tomenu)
 455 {
 456         lyx::LastFilesSection::LastFiles const & lf = LyX::cref().session().lastFiles().lastFiles();
 457         lyx::LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
 458
 459         int ii = 1;
 460
 461         for (; lfit != lf.end() && ii < 10; ++lfit, ++ii) {
 462                 string const file = lfit->absFilename();
 463                 docstring const label = convert<docstring>(ii) + ". "
 464                         + makeDisplayPath(file, 30)
 465                         + char_type('|') + convert<docstring>(ii);
 466                 tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, file)));
 467         }
 468 }
 469
 470
 471 void expandDocuments(Menu & tomenu)
 472 {
 473         Buffer * first = theBufferList().first();
 474         if (first) {
 475                 Buffer * b = first;
 476                 int ii = 1;
 477
 478                 // We cannot use a for loop as the buffer list cycles.
 479                 do {
 480                         docstring label = b->fileName().displayName(20);
 481                         if (!b->isClean())
 482                                 label = label + "*";
 483                         if (ii < 10)
 484                                 label = convert<docstring>(ii) + ". " + label + '|' + convert<docstring>(ii);
 485                         tomenu.add(MenuItem(MenuItem::Command, label,
 486                                 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
 487
 488                         b = theBufferList().next(b);
 489                         ++ii;
 490                 } while (b != first);
 491         } else {
 492                 tomenu.add(MenuItem(MenuItem::Command, _("No Documents Open!"),
 493                            FuncRequest(LFUN_NOACTION)));
 494         }
 495 }
 496
 497
 498 void expandBookmarks(Menu & tomenu)
 499 {
 500         lyx::BookmarksSection const & bm = LyX::cref().session().bookmarks();
 501
 502         for (size_t i = 1; i <= bm.size(); ++i) {
 503                 if (bm.isValid(i)) {
 504                         docstring const label = convert<docstring>(i) + ". "
 505                                 + makeDisplayPath(bm.bookmark(i).filename.absFilename(), 20)
 506                                 + char_type('|') + convert<docstring>(i);
 507                         tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_BOOKMARK_GOTO,
 508                                 convert<docstring>(i))));
 509                 }
 510         }
 511 }
 512
 513
 514 void expandFormats(MenuItem::Kind kind, Menu & tomenu, Buffer const * buf)
 515 {
 516         if (!buf && kind != MenuItem::ImportFormats) {
 517                 tomenu.add(MenuItem(MenuItem::Command,
 518                                     _("No Document Open!"),
 519                                     FuncRequest(LFUN_NOACTION)));
 520                 return;
 521         }
 522
 523         typedef vector<Format const *> Formats;
 524         Formats formats;
 525         kb_action action;
 526
 527         switch (kind) {
 528         case MenuItem::ImportFormats:
 529                 formats = theConverters().importableFormats();
 530                 action = LFUN_BUFFER_IMPORT;
 531                 break;
 532         case MenuItem::ViewFormats:
 533                 formats = buf->exportableFormats(true);
 534                 action = LFUN_BUFFER_VIEW;
 535                 break;
 536         case MenuItem::UpdateFormats:
 537                 formats = buf->exportableFormats(true);
 538                 action = LFUN_BUFFER_UPDATE;
 539                 break;
 540         default:
 541                 formats = buf->exportableFormats(false);
 542                 action = LFUN_BUFFER_EXPORT;
 543         }
 544         sort(formats.begin(), formats.end(), compare_format());
 545
 546         Formats::const_iterator fit = formats.begin();
 547         Formats::const_iterator end = formats.end();
 548         for (; fit != end ; ++fit) {
 549                 if ((*fit)->dummy())
 550                         continue;
 551                 docstring label = from_utf8((*fit)->prettyname());
 552                 docstring const shortcut = from_utf8((*fit)->shortcut());
 553
 554                 switch (kind) {
 555                 case MenuItem::ImportFormats:
 556                         // FIXME: This is a hack, we should rather solve
 557                         // FIXME: bug 2488 instead.
 558                         if ((*fit)->name() == "text")
 559                                 label = _("Plain Text");
 560                         else if ((*fit)->name() == "textparagraph")
 561                                 label = _("Plain Text, Join Lines");
 562                         label += "...";
 563                         break;
 564                 case MenuItem::ViewFormats:
 565                 case MenuItem::ExportFormats:
 566                 case MenuItem::UpdateFormats:
 567                         if (!(*fit)->documentFormat())
 568                                 continue;
 569                         break;
 570                 default:
 571                         BOOST_ASSERT(false);
 572                         break;
 573                 }
 574                 // FIXME: if we had proper support for translating the
 575                 // format names defined in configure.py, there would
 576                 // not be a need to check whether the shortcut is
 577                 // correct. If we add it uncondiitonally, it would
 578                 // create useless warnings on bad shortcuts
 579                 if (!shortcut.empty() && contains(label, shortcut))
 580                         label += char_type('|') + shortcut;
 581
 582                 if (buf)
 583                         tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
 584                                 FuncRequest(action, (*fit)->name())));
 585                 else
 586                         tomenu.add(MenuItem(MenuItem::Command, label,
 587                                 FuncRequest(action, (*fit)->name())));
 588         }
 589 }
 590
 591
 592 void expandFloatListInsert(Menu & tomenu, Buffer const * buf)
 593 {
 594         if (!buf) {
 595                 tomenu.add(MenuItem(MenuItem::Command,
 596                                     _("No Document Open!"),
 597                                     FuncRequest(LFUN_NOACTION)));
 598                 return;
 599         }
 600
 601         FloatList const & floats =
 602                 buf->params().getTextClass().floats();
 603         FloatList::const_iterator cit = floats.begin();
 604         FloatList::const_iterator end = floats.end();
 605         for (; cit != end; ++cit) {
 606                 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command,
 607                                     _(cit->second.listName()),
 608                                     FuncRequest(LFUN_FLOAT_LIST,
 609                                                 cit->second.type())));
 610         }
 611 }
 612
 613
 614 void expandFloatInsert(Menu & tomenu, Buffer const * buf)
 615 {
 616         if (!buf) {
 617                 tomenu.add(MenuItem(MenuItem::Command,
 618                                     _("No Document Open!"),
 619                                     FuncRequest(LFUN_NOACTION)));
 620                 return;
 621         }
 622
 623         FloatList const & floats =
 624                 buf->params().getTextClass().floats();
 625         FloatList::const_iterator cit = floats.begin();
 626         FloatList::const_iterator end = floats.end();
 627         for (; cit != end; ++cit) {
 628                 // normal float
 629                 docstring const label = _(cit->second.name());
 630                 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
 631                                     FuncRequest(LFUN_FLOAT_INSERT,
 632                                                 cit->second.type())));
 633         }
 634 }
 635
 636
 637 void expandFlexInsert(Menu & tomenu, Buffer const * buf, string s)
 638 {
 639         if (!buf) {
 640                 tomenu.add(MenuItem(MenuItem::Command,
 641                                     _("No Document Open!"),
 642                                     FuncRequest(LFUN_NOACTION)));
 643                 return;
 644         }
 645         InsetLayouts const & insetlayouts =
 646                 buf->params().getTextClass().insetlayouts();
 647         InsetLayouts::const_iterator cit = insetlayouts.begin();
 648         InsetLayouts::const_iterator end = insetlayouts.end();
 649         for (; cit != end; ++cit) {
 650                 docstring const label = cit->first;
 651                 if (cit->second.lyxtype == s)
 652                         tomenu.addWithStatusCheck(MenuItem(MenuItem::Command,
 653                                 label, FuncRequest(LFUN_FLEX_INSERT,
 654                                                 label)));
 655         }
 656 }
 657
 658
 659 Menu::size_type const max_number_of_items = 25;
 660
 661 void expandToc2(Menu & tomenu,
 662                 Toc const & toc_list,
 663                 Toc::size_type from,
 664                 Toc::size_type to, int depth)
 665 {
 666         int shortcut_count = 0;
 667
 668         // check whether depth is smaller than the smallest depth in toc.
 669         int min_depth = 1000;
 670         for (Toc::size_type i = from; i < to; ++i)
 671                 min_depth = min(min_depth, toc_list[i].depth());
 672         if (min_depth > depth)
 673                 depth = min_depth;
 674
 675
 676         if (to - from <= max_number_of_items) {
 677                 for (Toc::size_type i = from; i < to; ++i) {
 678                         docstring label(4 * max(0, toc_list[i].depth() - depth), char_type(' '));
 679                         label += limit_string_length(toc_list[i].str());
 680                         if (toc_list[i].depth() == depth
 681                             && shortcut_count < 9) {
 682                                 if (label.find(convert<docstring>(shortcut_count + 1)) != docstring::npos)
 683                                         label += char_type('|') + convert<docstring>(++shortcut_count);
 684                         }
 685                         tomenu.add(MenuItem(MenuItem::Command, label,
 686                                             FuncRequest(toc_list[i].action())));
 687                 }
 688         } else {
 689                 Toc::size_type pos = from;
 690                 while (pos < to) {
 691                         Toc::size_type new_pos = pos + 1;
 692                         while (new_pos < to &&
 693                                toc_list[new_pos].depth() > depth)
 694                                 ++new_pos;
 695
 696                         docstring label(4 * max(0, toc_list[pos].depth() - depth), ' ');
 697                         label += limit_string_length(toc_list[pos].str());
 698                         if (toc_list[pos].depth() == depth &&
 699                             shortcut_count < 9) {
 700                                 if (label.find(convert<docstring>(shortcut_count + 1)) != docstring::npos)
 701                                         label += char_type('|') + convert<docstring>(++shortcut_count);
 702                         }
 703                         if (new_pos == pos + 1) {
 704                                 tomenu.add(MenuItem(MenuItem::Command,
 705                                                     label, FuncRequest(toc_list[pos].action())));
 706                         } else {
 707                                 MenuItem item(MenuItem::Submenu, label);
 708                                 item.submenu(new Menu);
 709                                 expandToc2(*item.submenu(),
 710                                            toc_list, pos, new_pos, depth + 1);
 711                                 tomenu.add(item);
 712                         }
 713                         pos = new_pos;
 714                 }
 715         }
 716 }
 717
 718
 719 void expandToc(Menu & tomenu, Buffer const * buf)
 720 {
 721         // To make things very cleanly, we would have to pass buf to
 722         // all MenuItem constructors and to expandToc2. However, we
 723         // know that all the entries in a TOC will be have status_ ==
 724         // OK, so we avoid this unnecessary overhead (JMarc)
 725
 726         if (!buf) {
 727                 tomenu.add(MenuItem(MenuItem::Command,
 728                                     _("No Document Open!"),
 729                                     FuncRequest(LFUN_NOACTION)));
 730                 return;
 731         }
 732
 733         Buffer* cbuf = const_cast<Buffer*>(buf);
 734         cbuf->tocBackend().update();
 735         cbuf->structureChanged();
 736
 737         // Add an entry for the master doc if this is a child doc
 738         Buffer const * const master = buf->masterBuffer();
 739         if (buf != master) {
 740                 ParIterator const pit = par_iterator_begin(master->inset());
 741                 string const arg = convert<string>(pit->id());
 742                 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
 743                 tomenu.add(MenuItem(MenuItem::Command, _("Master Document"), f));
 744         }
 745
 746         FloatList const & floatlist = buf->params().getTextClass().floats();
 747         TocList const & toc_list = buf->tocBackend().tocs();
 748         TocList::const_iterator cit = toc_list.begin();
 749         TocList::const_iterator end = toc_list.end();
 750         for (; cit != end; ++cit) {
 751                 // Handle this later
 752                 if (cit->first == "tableofcontents")
 753                         continue;
 754
 755                 // All the rest is for floats
 756                 auto_ptr<Menu> menu(new Menu);
 757                 TocIterator ccit = cit->second.begin();
 758                 TocIterator eend = cit->second.end();
 759                 for (; ccit != eend; ++ccit) {
 760                         docstring const label = limit_string_length(ccit->str());
 761                         menu->add(MenuItem(MenuItem::Command,
 762                                            label,
 763                                            FuncRequest(ccit->action())));
 764                 }
 765                 string const & floatName = floatlist.getType(cit->first).listName();
 766                 docstring label;
 767                 if (!floatName.empty())
 768                         label = _(floatName);
 769                 // BUG3633: listings is not a proper float so its name
 770                 // is not shown in floatlist.
 771                 else if (cit->first == "equation")
 772                         label = _("List of Equations");
 773                 else if (cit->first == "index")
 774                         label = _("List of Indexes");
 775                 else if (cit->first == "listing")
 776                         label = _("List of Listings");
 777                 else if (cit->first == "marginalnote")
 778                         label = _("List of Marginal notes");
 779                 else if (cit->first == "note")
 780                         label = _("List of Notes");
 781                 else if (cit->first == "footnote")
 782                         label = _("List of Foot notes");
 783                 // this should not happen now, but if something else like
 784                 // listings is added later, this can avoid an empty menu name.
 785                 else
 786                         label = _("Other floats");
 787                 MenuItem item(MenuItem::Submenu, label);
 788                 item.submenu(menu.release());
 789                 tomenu.add(item);
 790         }
 791
 792         // Handle normal TOC
 793         cit = toc_list.find("tableofcontents");
 794         if (cit == end) {
 795                 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command,
 796                                     _("No Table of contents"),
 797                                     FuncRequest()));
 798         } else {
 799                 expandToc2(tomenu, cit->second, 0, cit->second.size(), 0);
 800         }
 801 }
 802
 803
 804 void expandPasteRecent(Menu & tomenu, Buffer const * buf)
 805 {
 806         if (!buf)
 807                 return;
 808
 809         vector<docstring> const sel =
 810                 cap::availableSelections(*buf);
 811
 812         vector<docstring>::const_iterator cit = sel.begin();
 813         vector<docstring>::const_iterator end = sel.end();
 814
 815         for (unsigned int index = 0; cit != end; ++cit, ++index) {
 816                 tomenu.add(MenuItem(MenuItem::Command, *cit,
 817                                     FuncRequest(LFUN_PASTE, convert<string>(index))));
 818         }
 819 }
 820
 821
 822 void expandToolbars(Menu & tomenu)
 823 {
 824         //
 825         // extracts the toolbars from the backend
 826         ToolbarBackend::Toolbars::const_iterator cit = toolbarbackend.begin();
 827         ToolbarBackend::Toolbars::const_iterator end = toolbarbackend.end();
 828
 829         for (; cit != end; ++cit) {
 830                 docstring label = _(cit->gui_name);
 831                 // frontends are not supposed to turn on/off toolbars,
 832                 // if they cannot update ToolbarBackend::flags. That
 833                 // is to say, ToolbarsBackend::flags should reflect
 834                 // the true state of toolbars.
 835                 //
 836                 // menu is displayed as
 837                 //       on/off review
 838                 // and
 839                 //              review (auto)
 840                 // in the case of auto.
 841                 if (cit->flags & ToolbarInfo::AUTO)
 842                         label += _(" (auto)");
 843                 tomenu.add(MenuItem(MenuItem::Command, label,
 844                                     FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name + " allowauto")));
 845         }
 846 }
 847
 848
 849 void expandBranches(Menu & tomenu, Buffer const * buf)
 850 {
 851         if (!buf) {
 852                 tomenu.add(MenuItem(MenuItem::Command,
 853                                     _("No Document Open!"),
 854                                     FuncRequest(LFUN_NOACTION)));
 855                 return;
 856         }
 857
 858         BufferParams const & params = buf->masterBuffer()->params();
 859         if (params.branchlist().empty()) {
 860                 tomenu.add(MenuItem(MenuItem::Command,
 861                                     _("No Branch in Document!"),
 862                                     FuncRequest(LFUN_NOACTION)));
 863                 return;
 864         }
 865
 866         BranchList::const_iterator cit = params.branchlist().begin();
 867         BranchList::const_iterator end = params.branchlist().end();
 868
 869         for (int ii = 1; cit != end; ++cit, ++ii) {
 870                 docstring label = cit->getBranch();
 871                 if (ii < 10)
 872                         label = convert<docstring>(ii) + ". " + label + char_type('|') + convert<docstring>(ii);
 873                 tomenu.addWithStatusCheck(MenuItem(MenuItem::Command, label,
 874                                     FuncRequest(LFUN_BRANCH_INSERT,
 875                                                 cit->getBranch())));
 876         }
 877 }
 878
 879
 880 } // namespace anon
 881
 882
 883 void MenuBackend::expand(Menu const & frommenu, Menu & tomenu,
 884                          Buffer const * buf) const
 885 {
 886         if (!tomenu.empty())
 887                 tomenu.clear();
 888
 889         for (Menu::const_iterator cit = frommenu.begin();
 890              cit != frommenu.end() ; ++cit) {
 891                 switch (cit->kind()) {
 892                 case MenuItem::Lastfiles:
 893                         expandLastfiles(tomenu);
 894                         break;
 895
 896                 case MenuItem::Documents:
 897                         expandDocuments(tomenu);
 898                         break;
 899
 900                 case MenuItem::Bookmarks:
 901                         expandBookmarks(tomenu);
 902                         break;
 903
 904                 case MenuItem::ImportFormats:
 905                 case MenuItem::ViewFormats:
 906                 case MenuItem::UpdateFormats:
 907                 case MenuItem::ExportFormats:
 908                         expandFormats(cit->kind(), tomenu, buf);
 909                         break;
 910
 911                 case MenuItem::CharStyles:
 912                         expandFlexInsert(tomenu, buf, "charstyle");
 913                         break;
 914
 915                 case MenuItem::Custom:
 916                         expandFlexInsert(tomenu, buf, "custom");
 917                         break;
 918
 919                 case MenuItem::Elements:
 920                         expandFlexInsert(tomenu, buf, "element");
 921                         break;
 922
 923                 case MenuItem::FloatListInsert:
 924                         expandFloatListInsert(tomenu, buf);
 925                         break;
 926
 927                 case MenuItem::FloatInsert:
 928                         expandFloatInsert(tomenu, buf);
 929                         break;
 930
 931                 case MenuItem::PasteRecent:
 932                         expandPasteRecent(tomenu, buf);
 933                         break;
 934
 935                 case MenuItem::Toolbars:
 936                         expandToolbars(tomenu);
 937                         break;
 938
 939                 case MenuItem::Branches:
 940                         expandBranches(tomenu, buf);
 941                         break;
 942
 943                 case MenuItem::Toc:
 944                         expandToc(tomenu, buf);
 945                         break;
 946
 947                 case MenuItem::Submenu: {
 948                         MenuItem item(*cit);
 949                         item.submenu(new Menu(cit->submenuname()));
 950                         expand(getMenu(cit->submenuname()),
 951                                *item.submenu(), buf);
 952                         tomenu.addWithStatusCheck(item);
 953                 }
 954                 break;
 955
 956                 case MenuItem::Separator:
 957                         tomenu.addWithStatusCheck(*cit);
 958                         break;
 959
 960                 case MenuItem::Command:
 961                         if (!specialmenu_.hasFunc(cit->func()))
 962                                 tomenu.addWithStatusCheck(*cit);
 963                 }
 964         }
 965
 966         // we do not want the menu to end with a separator
 967         if (!tomenu.empty()
 968             && tomenu.items_.back().kind() == MenuItem::Separator)
 969                 tomenu.items_.pop_back();
 970
 971         // Check whether the shortcuts are unique
 972         tomenu.checkShortcuts();
 973 }
 974
 975
 976 void MenuBackend::read(Lexer & lex)
 977 {
 978         enum Menutags {
 979                 md_menu = 1,
 980                 md_menubar,
 981                 md_endmenuset,
 982                 md_last
 983         };
 984
 985         struct keyword_item menutags[md_last - 1] = {
 986                 { "end", md_endmenuset },
 987                 { "menu", md_menu },
 988                 { "menubar", md_menubar }
 989         };
 990
 991         //consistency check
 992         if (compare_ascii_no_case(lex.getString(), "menuset")) {
 993                 lyxerr << "Menubackend::read: ERROR wrong token:`"
 994                        << lex.getString() << '\'' << endl;
 995         }
 996
 997         lex.pushTable(menutags, md_last - 1);
 998         if (lyxerr.debugging(Debug::PARSER))
 999                 lex.printTable(lyxerr);
1000
1001         bool quit = false;
1002
1003         while (lex.isOK() && !quit) {
1004                 switch (lex.lex()) {
1005                 case md_menubar:
1006                         menubar_.read(lex);
1007                         break;
1008                 case md_menu: {
1009                         lex.next(true);
1010                         docstring const name = lex.getDocString();
1011                         if (hasMenu(name)) {
1012                                 getMenu(name).read(lex);
1013                         } else {
1014                                 Menu menu(name);
1015                                 menu.read(lex);
1016                                 add(menu);
1017                         }
1018                         break;
1019                 }
1020                 case md_endmenuset:
1021                         quit = true;
1022                         break;
1023                 default:
1024                         lex.printError("menubackend::read: "
1025                                        "Unknown menu tag: `$$Token'");
1026                         break;
1027                 }
1028         }
1029         lex.popTable();
1030 }
1031
1032
1033 void MenuBackend::add(Menu const & menu)
1034 {
1035         menulist_.push_back(menu);
1036 }
1037
1038
1039 bool MenuBackend::hasMenu(docstring const & name) const
1040 {
1041         return find_if(begin(), end(), MenuNamesEqual(name)) != end();
1042 }
1043
1044
1045 Menu const & MenuBackend::getMenu(docstring const & name) const
1046 {
1047         const_iterator cit = find_if(begin(), end(), MenuNamesEqual(name));
1048         if (cit == end())
1049                 lyxerr << "No submenu named " << to_utf8(name) << endl;
1050         BOOST_ASSERT(cit != end());
1051         return (*cit);
1052 }
1053
1054
1055 Menu & MenuBackend::getMenu(docstring const & name)
1056 {
1057         iterator it = find_if(begin(), end(), MenuNamesEqual(name));
1058         if (it == end())
1059                 lyxerr << "No submenu named " << to_utf8(name) << endl;
1060         BOOST_ASSERT(it != end());
1061         return (*it);
1062 }
1063
1064
1065 Menu const & MenuBackend::getMenubar() const
1066 {
1067         return menubar_;
1068 }
1069
1070
1071 } // namespace lyx