src/MenuBackend.C

   1 /**
   2  * \file MenuBackend.C
   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 "CutAndPaste.h"
  25 #include "debug.h"
  26 #include "exporter.h"
  27 #include "Floating.h"
  28 #include "FloatList.h"
  29 #include "format.h"
  30 #include "gettext.h"
  31 #include "importer.h"
  32 #include "kbmap.h"
  33 #include "lastfiles.h"
  34 #include "LyXAction.h"
  35 #include "lyx_main.h" // for lastfiles
  36 #include "lyxfunc.h"
  37 #include "lyxlex.h"
  38 #include "toc.h"
  39
  40 #include "frontends/LyXView.h"
  41
  42 #include "support/filetools.h"
  43 #include "support/lstrings.h"
  44 #include "support/tostr.h"
  45
  46 #include <boost/bind.hpp>
  47
  48 #include <algorithm>
  49
  50 using lyx::support::compare_ascii_no_case;
  51 using lyx::support::contains;
  52 using lyx::support::MakeDisplayPath;
  53 using lyx::support::token;
  54
  55 using boost::bind;
  56
  57 using std::auto_ptr;
  58 using std::endl;
  59 using std::equal_to;
  60 using std::find_if;
  61 using std::max;
  62 using std::sort;
  63 using std::string;
  64 using std::vector;
  65
  66
  67 extern BufferList bufferlist;
  68 extern boost::scoped_ptr<kb_keymap> toplevel_keymap;
  69
  70 namespace {
  71
  72 class MenuNamesEqual : public std::unary_function<Menu, bool> {
  73 public:
  74         MenuNamesEqual(string const & name)
  75                 : name_(name) {}
  76         bool operator()(Menu const & menu) const
  77         {
  78                 return menu.name() == name_;
  79         }
  80 private:
  81         string name_;
  82 };
  83
  84 } // namespace anon
  85
  86
  87 // This is the global menu definition
  88 MenuBackend menubackend;
  89
  90
  91 MenuItem::MenuItem(Kind kind)
  92         : kind_(kind), optional_(false)
  93 {}
  94
  95
  96 MenuItem::MenuItem(Kind kind, string const & label,
  97                    string const & submenu, bool optional)
  98         : kind_(kind), label_(label),
  99           submenuname_(submenu), optional_(optional)
 100 {
 101         BOOST_ASSERT(kind == Submenu);
 102 }
 103
 104
 105 MenuItem::MenuItem(Kind kind, string const & label,
 106                    FuncRequest const & func, bool optional)
 107         : kind_(kind), label_(label), func_(func), optional_(optional)
 108 {
 109         func_.origin = FuncRequest::UI;
 110 }
 111
 112
 113 MenuItem::~MenuItem()
 114 {}
 115
 116
 117 void MenuItem::submenu(Menu * menu)
 118 {
 119         submenu_.reset(menu);
 120 }
 121
 122
 123 string const MenuItem::label() const
 124 {
 125         return token(label_, '|', 0);
 126 }
 127
 128
 129 string const MenuItem::shortcut() const
 130 {
 131         return token(label_, '|', 1);
 132 }
 133
 134
 135 string const MenuItem::binding() const
 136 {
 137         if (kind_ != Command)
 138                 return string();
 139
 140         // Get the keys bound to this action, but keep only the
 141         // first one later
 142         kb_keymap::Bindings bindings = toplevel_keymap->findbindings(func_);
 143
 144         if (bindings.size()) {
 145                 return bindings.begin()->print();
 146         } else {
 147                 lyxerr[Debug::KBMAP]
 148                         << "No binding for "
 149                         << lyxaction.getActionName(func_.action)
 150                         << '(' << func_.argument << ')' << endl;
 151                 return string();
 152         }
 153
 154 }
 155
 156
 157 Menu & Menu::add(MenuItem const & i, LyXView const * view)
 158 {
 159         if (!view) {
 160                 items_.push_back(i);
 161                 return *this;
 162         }
 163
 164         switch (i.kind()) {
 165
 166         case MenuItem::Command: {
 167                 FuncStatus status =
 168                         view->getLyXFunc().getStatus(i.func());
 169                 if (status.unknown()
 170                     || (!status.enabled() && i.optional()))
 171                         break;
 172                 items_.push_back(i);
 173                 items_.back().status(status);
 174                 break;
 175         }
 176
 177         case MenuItem::Submenu: {
 178                 if (i.submenu()) {
 179                         bool enabled = false;
 180                         for (const_iterator cit = i.submenu()->begin();
 181                              cit != i.submenu()->end(); ++cit) {
 182                                 if ((cit->kind() == MenuItem::Command
 183                                      || cit->kind() == MenuItem::Submenu)
 184                                     && cit->status().enabled()) {
 185                                         enabled = true;
 186                                         break;
 187                                 }
 188                         }
 189                         if (enabled || !i.optional()) {
 190                                 items_.push_back(i);
 191                                 items_.back().status().enabled(enabled);
 192                         }
 193                 }
 194                 else
 195                         items_.push_back(i);
 196                 break;
 197         }
 198
 199         case MenuItem::Separator:
 200                 if (!items_.empty()
 201                     && items_.back().kind() != MenuItem::Separator)
 202                         items_.push_back(i);
 203                 break;
 204
 205         default:
 206                 items_.push_back(i);
 207         }
 208
 209         return *this;
 210 }
 211
 212
 213 Menu & Menu::read(LyXLex & lex)
 214 {
 215         enum Menutags {
 216                 md_item = 1,
 217                 md_branches,
 218                 md_documents,
 219                 md_charstyles,
 220                 md_endmenu,
 221                 md_exportformats,
 222                 md_importformats,
 223                 md_lastfiles,
 224                 md_optitem,
 225                 md_optsubmenu,
 226                 md_separator,
 227                 md_submenu,
 228                 md_toc,
 229                 md_updateformats,
 230                 md_viewformats,
 231                 md_floatlistinsert,
 232                 md_floatinsert,
 233                 md_pasterecent,
 234                 md_last
 235         };
 236
 237         struct keyword_item menutags[md_last - 1] = {
 238                 { "branches", md_branches },
 239                 { "charstyles", md_charstyles },
 240                 { "documents", md_documents },
 241                 { "end", md_endmenu },
 242                 { "exportformats", md_exportformats },
 243                 { "floatinsert", md_floatinsert },
 244                 { "floatlistinsert", md_floatlistinsert },
 245                 { "importformats", md_importformats },
 246                 { "item", md_item },
 247                 { "lastfiles", md_lastfiles },
 248                 { "optitem", md_optitem },
 249                 { "optsubmenu", md_optsubmenu },
 250                 { "pasterecent", md_pasterecent },
 251                 { "separator", md_separator },
 252                 { "submenu", md_submenu },
 253                 { "toc", md_toc },
 254                 { "updateformats", md_updateformats },
 255                 { "viewformats", md_viewformats }
 256         };
 257
 258         lex.pushTable(menutags, md_last - 1);
 259         if (lyxerr.debugging(Debug::PARSER))
 260                 lex.printTable(lyxerr);
 261
 262         bool quit = false;
 263         bool optional = false;
 264
 265         while (lex.isOK() && !quit) {
 266                 switch (lex.lex()) {
 267                 case md_optitem:
 268                         optional = true;
 269                         // fallback to md_item
 270                 case md_item: {
 271                         lex.next(true);
 272                         string const name = _(lex.getString());
 273                         lex.next(true);
 274                         string const command = lex.getString();
 275                         FuncRequest func = lyxaction.lookupFunc(command);
 276                         add(MenuItem(MenuItem::Command, name, func, optional));
 277                         optional = false;
 278                         break;
 279                 }
 280
 281                 case md_separator:
 282                         add(MenuItem(MenuItem::Separator));
 283                         break;
 284
 285                 case md_lastfiles:
 286                         add(MenuItem(MenuItem::Lastfiles));
 287                         break;
 288
 289                 case md_charstyles:
 290                         add(MenuItem(MenuItem::CharStyles));
 291                         break;
 292
 293                 case md_documents:
 294                         add(MenuItem(MenuItem::Documents));
 295                         break;
 296
 297                 case md_toc:
 298                         add(MenuItem(MenuItem::Toc));
 299                         break;
 300
 301                 case md_viewformats:
 302                         add(MenuItem(MenuItem::ViewFormats));
 303                         break;
 304
 305                 case md_updateformats:
 306                         add(MenuItem(MenuItem::UpdateFormats));
 307                         break;
 308
 309                 case md_exportformats:
 310                         add(MenuItem(MenuItem::ExportFormats));
 311                         break;
 312
 313                 case md_importformats:
 314                         add(MenuItem(MenuItem::ImportFormats));
 315                         break;
 316
 317                 case md_floatlistinsert:
 318                         add(MenuItem(MenuItem::FloatListInsert));
 319                         break;
 320
 321                 case md_floatinsert:
 322                         add(MenuItem(MenuItem::FloatInsert));
 323                         break;
 324
 325                 case md_pasterecent:
 326                         add(MenuItem(MenuItem::PasteRecent));
 327                         break;
 328
 329                 case md_branches:
 330                         add(MenuItem(MenuItem::Branches));
 331                         break;
 332
 333                 case md_optsubmenu:
 334                         optional = true;
 335                         // fallback to md_submenu
 336                 case md_submenu: {
 337                         lex.next(true);
 338                         string const mlabel = _(lex.getString());
 339                         lex.next(true);
 340                         string const mname = lex.getString();
 341                         add(MenuItem(MenuItem::Submenu, mlabel, mname,
 342                                      optional));
 343                         optional = false;
 344                         break;
 345                 }
 346
 347                 case md_endmenu:
 348                         quit = true;
 349                         break;
 350
 351                 default:
 352                         lex.printError("Menu::read: "
 353                                        "Unknown menu tag: `$$Token'");
 354                         break;
 355                 }
 356         }
 357         lex.popTable();
 358         return *this;
 359 }
 360
 361
 362 MenuItem const & Menu::operator[](size_type i) const
 363 {
 364         return items_[i];
 365 }
 366
 367
 368 bool Menu::hasFunc(FuncRequest const & func) const
 369 {
 370         return find_if(begin(), end(),
 371                        bind(std::equal_to<FuncRequest>(),
 372                             bind(&MenuItem::func, _1),
 373                             func)) != end();
 374 }
 375
 376 void Menu::checkShortcuts() const
 377 {
 378         // This is a quadratic algorithm, but we do not care because
 379         // menus are short enough
 380         for (const_iterator it1 = begin(); it1 != end(); ++it1) {
 381                 string shortcut = it1->shortcut();
 382                 if (shortcut.empty())
 383                         continue;
 384                 if (!contains(it1->label(), shortcut))
 385                         lyxerr << "Menu warning: menu entry \""
 386                                << it1->label()
 387                                << "\" does not contain shortcut `"
 388                                << shortcut << "'." << endl;
 389                 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
 390                         if (!compare_ascii_no_case(it2->shortcut(), shortcut)) {
 391                                 lyxerr << "Menu warning: menu entries "
 392                                        << '"' << it1->fulllabel()
 393                                        << "\" and \"" << it2->fulllabel()
 394                                        << "\" share the same shortcut."
 395                                        << endl;
 396                         }
 397                 }
 398         }
 399 }
 400
 401
 402 void MenuBackend::specialMenu(string const &name)
 403 {
 404         if (hasMenu(name))
 405                 specialmenu_ = &getMenu(name);
 406 }
 407
 408
 409 namespace {
 410
 411 class compare_format {
 412 public:
 413         bool operator()(Format const * p1, Format const * p2) {
 414                 return *p1 < *p2;
 415         }
 416 };
 417
 418 string const limit_string_length(string const & str)
 419 {
 420         string::size_type const max_item_length = 45;
 421
 422         if (str.size() > max_item_length)
 423                 return str.substr(0, max_item_length - 3) + "...";
 424         else
 425                 return str;
 426 }
 427
 428
 429 void expandLastfiles(Menu & tomenu, LyXView const * view)
 430 {
 431         LastFiles const & lastfiles = LyX::cref().lastfiles();
 432
 433         int ii = 1;
 434         LastFiles::const_iterator lfit = lastfiles.begin();
 435         LastFiles::const_iterator end = lastfiles.end();
 436
 437         for (; lfit != end && ii < 10; ++lfit, ++ii) {
 438                 string const label = tostr(ii) + ". "
 439                         + MakeDisplayPath((*lfit), 30)
 440                         + '|' + tostr(ii);
 441                 tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, (*lfit))), view);
 442         }
 443 }
 444
 445 void expandDocuments(Menu & tomenu, LyXView const * view)
 446 {
 447         typedef vector<string> Strings;
 448         Strings const names = bufferlist.getFileNames();
 449
 450         if (names.empty()) {
 451                 tomenu.add(MenuItem(MenuItem::Command, _("No Documents Open!"),
 452                                     FuncRequest(LFUN_NOACTION)), view);
 453                 return;
 454         }
 455
 456         int ii = 1;
 457         Strings::const_iterator docit = names.begin();
 458         Strings::const_iterator end = names.end();
 459         for (; docit != end; ++docit, ++ii) {
 460                 string label = MakeDisplayPath(*docit, 20);
 461                 if (ii < 10)
 462                         label = tostr(ii) + ". " + label + '|' + tostr(ii);
 463                 tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_SWITCHBUFFER, *docit)), view);
 464         }
 465 }
 466
 467
 468 void expandFormats(MenuItem::Kind kind, Menu & tomenu, LyXView const * view)
 469 {
 470         if (!view->buffer() && kind != MenuItem::ImportFormats) {
 471                 tomenu.add(MenuItem(MenuItem::Command,
 472                                     _("No Documents Open!"),
 473                                     FuncRequest(LFUN_NOACTION)),
 474                                     view);
 475                 return;
 476         }
 477
 478         typedef vector<Format const *> Formats;
 479         Formats formats;
 480         kb_action action;
 481
 482         switch (kind) {
 483         case MenuItem::ImportFormats:
 484                 formats = Importer::GetImportableFormats();
 485                 action = LFUN_IMPORT;
 486                 break;
 487         case MenuItem::ViewFormats:
 488                 formats = Exporter::GetExportableFormats(*view->buffer(), true);
 489                 action = LFUN_PREVIEW;
 490                 break;
 491         case MenuItem::UpdateFormats:
 492                 formats = Exporter::GetExportableFormats(*view->buffer(), true);
 493                 action = LFUN_UPDATE;
 494                 break;
 495         default:
 496                 formats = Exporter::GetExportableFormats(*view->buffer(), false);
 497                 action = LFUN_EXPORT;
 498         }
 499         sort(formats.begin(), formats.end(), compare_format());
 500
 501         Formats::const_iterator fit = formats.begin();
 502         Formats::const_iterator end = formats.end();
 503         for (; fit != end ; ++fit) {
 504                 if ((*fit)->dummy())
 505                         continue;
 506                 string label = (*fit)->prettyname();
 507                 // we need to hide the default graphic export formats
 508                 // from the external menu, because we need them only
 509                 // for the internal lyx-view and external latex run
 510                 if (label == "EPS" || label == "XPM" || label == "PNG")
 511                         continue;
 512
 513                 if (kind == MenuItem::ImportFormats) {
 514                         if ((*fit)->name() == "text")
 515                                 label = _("ASCII text as lines");
 516                         else if ((*fit)->name() == "textparagraph")
 517                                 label = _("ASCII text as paragraphs");
 518                         label += "...";
 519                 }
 520                 if (!(*fit)->shortcut().empty())
 521                         label += '|' + (*fit)->shortcut();
 522
 523                 tomenu.add(MenuItem(MenuItem::Command, label,
 524                                     FuncRequest(action, (*fit)->name())),
 525                            view);
 526         }
 527 }
 528
 529
 530 void expandFloatListInsert(Menu & tomenu, LyXView const * view)
 531 {
 532         if (!view->buffer()) {
 533                 tomenu.add(MenuItem(MenuItem::Command,
 534                                     _("No Documents Open!"),
 535                                     FuncRequest(LFUN_NOACTION)),
 536                            view);
 537                 return;
 538         }
 539
 540         FloatList const & floats =
 541                 view->buffer()->params().getLyXTextClass().floats();
 542         FloatList::const_iterator cit = floats.begin();
 543         FloatList::const_iterator end = floats.end();
 544         for (; cit != end; ++cit) {
 545                 tomenu.add(MenuItem(MenuItem::Command,
 546                                     _(cit->second.listName()),
 547                                     FuncRequest(LFUN_FLOAT_LIST,
 548                                                 cit->second.type())),
 549                            view);
 550         }
 551 }
 552
 553
 554 void expandFloatInsert(Menu & tomenu, LyXView const * view)
 555 {
 556         if (!view->buffer()) {
 557                 tomenu.add(MenuItem(MenuItem::Command,
 558                                     _("No Documents Open!"),
 559                                     FuncRequest(LFUN_NOACTION)),
 560                            view);
 561                 return;
 562         }
 563
 564         FloatList const & floats =
 565                 view->buffer()->params().getLyXTextClass().floats();
 566         FloatList::const_iterator cit = floats.begin();
 567         FloatList::const_iterator end = floats.end();
 568         for (; cit != end; ++cit) {
 569                 // normal float
 570                 string const label = _(cit->second.name());
 571                 tomenu.add(MenuItem(MenuItem::Command, label,
 572                                     FuncRequest(LFUN_INSET_FLOAT,
 573                                                 cit->second.type())),
 574                            view);
 575         }
 576 }
 577
 578
 579 void expandCharStyleInsert(Menu & tomenu, LyXView const * view)
 580 {
 581         if (!view->buffer()) {
 582                 tomenu.add(MenuItem(MenuItem::Command,
 583                                     _("No Documents Open!"),
 584                                     FuncRequest(LFUN_NOACTION)),
 585                            view);
 586                 return;
 587         }
 588         CharStyles & charstyles =
 589                 view->buffer()->params().getLyXTextClass().charstyles();
 590         CharStyles::iterator cit = charstyles.begin();
 591         CharStyles::iterator end = charstyles.end();
 592         for (; cit != end; ++cit) {
 593                 string const label = cit->name;
 594                 tomenu.add(MenuItem(MenuItem::Command, label,
 595                                     FuncRequest(LFUN_INSERT_CHARSTYLE,
 596                                                 cit->name)), view);
 597         }
 598 }
 599
 600
 601 Menu::size_type const max_number_of_items = 25;
 602
 603 void expandToc2(Menu & tomenu,
 604                 lyx::toc::Toc const & toc_list,
 605                 lyx::toc::Toc::size_type from,
 606                 lyx::toc::Toc::size_type to, int depth)
 607 {
 608         int shortcut_count = 0;
 609         if (to - from <= max_number_of_items) {
 610                 for (lyx::toc::Toc::size_type i = from; i < to; ++i) {
 611                         string label(4 * max(0, toc_list[i].depth - depth),' ');
 612                         label += limit_string_length(toc_list[i].str);
 613                         if (toc_list[i].depth == depth
 614                             && shortcut_count < 9) {
 615                                 if (label.find(tostr(shortcut_count + 1)) != string::npos)
 616                                         label += '|' + tostr(++shortcut_count);
 617                         }
 618                         tomenu.add(MenuItem(MenuItem::Command, label,
 619                                             FuncRequest(toc_list[i].action())));
 620                 }
 621         } else {
 622                 lyx::toc::Toc::size_type pos = from;
 623                 while (pos < to) {
 624                         lyx::toc::Toc::size_type new_pos = pos + 1;
 625                         while (new_pos < to &&
 626                                toc_list[new_pos].depth > depth)
 627                                 ++new_pos;
 628
 629                         string label(4 * max(0, toc_list[pos].depth - depth), ' ');
 630                         label += limit_string_length(toc_list[pos].str);
 631                         if (toc_list[pos].depth == depth &&
 632                             shortcut_count < 9) {
 633                                 if (label.find(tostr(shortcut_count + 1)) != string::npos)
 634                                         label += '|' + tostr(++shortcut_count);
 635                                 }
 636                         if (new_pos == pos + 1) {
 637                                 tomenu.add(MenuItem(MenuItem::Command,
 638                                                     label, FuncRequest(toc_list[pos].action())));
 639                         } else {
 640                                 MenuItem item(MenuItem::Submenu, label);
 641                                 item.submenu(new Menu);
 642                                 expandToc2(*item.submenu(),
 643                                            toc_list, pos, new_pos, depth + 1);
 644                                 tomenu.add(item);
 645                         }
 646                         pos = new_pos;
 647                 }
 648         }
 649 }
 650
 651
 652 void expandToc(Menu & tomenu, LyXView const * view)
 653 {
 654         // To make things very cleanly, we would have to pass view to
 655         // all MenuItem constructors and to expandToc2. However, we
 656         // know that all the entries in a TOC will be have status_ ==
 657         // OK, so we avoid this unnecessary overhead (JMarc)
 658
 659         if (!view->buffer()) {
 660                 tomenu.add(MenuItem(MenuItem::Command,
 661                                     _("No Documents Open!"),
 662                                     FuncRequest(LFUN_NOACTION)),
 663                            view);
 664                 return;
 665         }
 666
 667         lyx::toc::TocList toc_list = lyx::toc::getTocList(*view->buffer());
 668         lyx::toc::TocList::const_iterator cit = toc_list.begin();
 669         lyx::toc::TocList::const_iterator end = toc_list.end();
 670         for (; cit != end; ++cit) {
 671                 // Handle this later
 672                 if (cit->first == "TOC")
 673                         continue;
 674
 675                 // All the rest is for floats
 676                 auto_ptr<Menu> menu(new Menu);
 677                 lyx::toc::Toc::const_iterator ccit = cit->second.begin();
 678                 lyx::toc::Toc::const_iterator eend = cit->second.end();
 679                 for (; ccit != eend; ++ccit) {
 680                         string const label = limit_string_length(ccit->str);
 681                         menu->add(MenuItem(MenuItem::Command,
 682                                            label,
 683                                            FuncRequest(ccit->action())));
 684                 }
 685                 string const & floatName = cit->first;
 686                 // Is the _(...) really needed here? (Lgb)
 687                 MenuItem item(MenuItem::Submenu, _(floatName));
 688                 item.submenu(menu.release());
 689                 tomenu.add(item);
 690         }
 691
 692         // Handle normal TOC
 693         cit = toc_list.find("TOC");
 694         if (cit == end) {
 695                 tomenu.add(MenuItem(MenuItem::Command,
 696                                     _("No Table of contents"),
 697                                     FuncRequest()),
 698                            view);
 699         } else {
 700                 expandToc2(tomenu, cit->second, 0, cit->second.size(), 0);
 701         }
 702 }
 703
 704
 705 void expandPasteRecent(Menu & tomenu, LyXView const * view)
 706 {
 707         if (!view || !view->buffer())
 708                 return;
 709
 710         vector<string> const sel =
 711                 lyx::cap::availableSelections(*view->buffer());
 712
 713         vector<string>::const_iterator cit = sel.begin();
 714         vector<string>::const_iterator end = sel.end();
 715
 716         for (unsigned int index = 0; cit != end; ++cit, ++index) {
 717                 tomenu.add(MenuItem(MenuItem::Command, *cit,
 718                                     FuncRequest(LFUN_PASTE, tostr(index))));
 719         }
 720 }
 721
 722
 723 void expandBranches(Menu & tomenu, LyXView const * view)
 724 {
 725         if (!view || !view->buffer())
 726                 return;
 727
 728         BufferParams const & params = view->buffer()->params();
 729
 730         std::list<Branch>::const_iterator cit = params.branchlist().begin();
 731         std::list<Branch>::const_iterator end = params.branchlist().end();
 732
 733         for (int ii = 1; cit != end; ++cit, ++ii) {
 734                 string label = cit->getBranch();
 735                 if (ii < 10)
 736                         label = tostr(ii) + ". " + label + "|" + tostr(ii);
 737                 tomenu.add(MenuItem(MenuItem::Command, label,
 738                                     FuncRequest(LFUN_INSERT_BRANCH,
 739                                                 cit->getBranch())), view);
 740         }
 741 }
 742
 743
 744 } // namespace anon
 745
 746
 747 void MenuBackend::expand(Menu const & frommenu, Menu & tomenu,
 748                          LyXView const * view) const
 749 {
 750         for (Menu::const_iterator cit = frommenu.begin();
 751              cit != frommenu.end() ; ++cit) {
 752                 switch (cit->kind()) {
 753                 case MenuItem::Lastfiles:
 754                         expandLastfiles(tomenu, view);
 755                         break;
 756
 757                 case MenuItem::Documents:
 758                         expandDocuments(tomenu, view);
 759                         break;
 760
 761                 case MenuItem::ImportFormats:
 762                 case MenuItem::ViewFormats:
 763                 case MenuItem::UpdateFormats:
 764                 case MenuItem::ExportFormats:
 765                         expandFormats(cit->kind(), tomenu, view);
 766                         break;
 767
 768                 case MenuItem::CharStyles:
 769                         expandCharStyleInsert(tomenu, view);
 770                         break;
 771
 772                 case MenuItem::FloatListInsert:
 773                         expandFloatListInsert(tomenu, view);
 774                         break;
 775
 776                 case MenuItem::FloatInsert:
 777                         expandFloatInsert(tomenu, view);
 778                         break;
 779
 780                 case MenuItem::PasteRecent:
 781                         expandPasteRecent(tomenu, view);
 782                         break;
 783
 784                 case MenuItem::Branches:
 785                         expandBranches(tomenu, view);
 786                         break;
 787
 788                 case MenuItem::Toc:
 789                         expandToc(tomenu, view);
 790                         break;
 791
 792                 case MenuItem::Submenu: {
 793                         MenuItem item(*cit);
 794                         item.submenu(new Menu(cit->submenuname()));
 795                         expand(getMenu(cit->submenuname()),
 796                                *item.submenu(), view);
 797                         tomenu.add(item, view);
 798                 }
 799                 break;
 800
 801                 case MenuItem::Separator:
 802                         tomenu.add(*cit, view);
 803                         break;
 804
 805                 case MenuItem::Command:
 806                         if (!specialmenu_
 807                             || !specialmenu_->hasFunc(cit->func()))
 808                                 tomenu.add(*cit, view);
 809                 }
 810         }
 811
 812         // we do not want the menu to end with a separator
 813         if (!tomenu.empty()
 814             && tomenu.items_.back().kind() == MenuItem::Separator)
 815                 tomenu.items_.pop_back();
 816
 817         // Check whether the shortcuts are unique
 818         tomenu.checkShortcuts();
 819 }
 820
 821
 822 void MenuBackend::read(LyXLex & lex)
 823 {
 824         enum Menutags {
 825                 md_menu = 1,
 826                 md_menubar,
 827                 md_endmenuset,
 828                 md_last
 829         };
 830
 831         struct keyword_item menutags[md_last - 1] = {
 832                 { "end", md_endmenuset },
 833                 { "menu", md_menu },
 834                 { "menubar", md_menubar }
 835         };
 836
 837         //consistency check
 838         if (compare_ascii_no_case(lex.getString(), "menuset")) {
 839                 lyxerr << "Menubackend::read: ERROR wrong token:`"
 840                        << lex.getString() << '\'' << endl;
 841         }
 842
 843         lex.pushTable(menutags, md_last - 1);
 844         if (lyxerr.debugging(Debug::PARSER))
 845                 lex.printTable(lyxerr);
 846
 847         bool quit = false;
 848
 849         while (lex.isOK() && !quit) {
 850                 switch (lex.lex()) {
 851                 case md_menubar:
 852                         menubar_.read(lex);
 853                         break;
 854                 case md_menu: {
 855                         lex.next(true);
 856                         string const name = lex.getString();
 857                         if (hasMenu(name)) {
 858                                 getMenu(name).read(lex);
 859                         } else {
 860                                 Menu menu(name);
 861                                 menu.read(lex);
 862                                 add(menu);
 863                         }
 864                         break;
 865                 }
 866                 case md_endmenuset:
 867                         quit = true;
 868                         break;
 869                 default:
 870                         lex.printError("menubackend::read: "
 871                                        "Unknown menu tag: `$$Token'");
 872                         break;
 873                 }
 874         }
 875         lex.popTable();
 876 }
 877
 878
 879 void MenuBackend::add(Menu const & menu)
 880 {
 881         menulist_.push_back(menu);
 882 }
 883
 884
 885 bool MenuBackend::hasMenu(string const & name) const
 886 {
 887         return find_if(begin(), end(), MenuNamesEqual(name)) != end();
 888 }
 889
 890
 891 Menu const & MenuBackend::getMenu(string const & name) const
 892 {
 893         const_iterator cit = find_if(begin(), end(), MenuNamesEqual(name));
 894         if (cit == end())
 895                 lyxerr << "No submenu named " << name << endl;
 896         BOOST_ASSERT(cit != end());
 897         return (*cit);
 898 }
 899
 900
 901 Menu & MenuBackend::getMenu(string const & name)
 902 {
 903         iterator it = find_if(begin(), end(), MenuNamesEqual(name));
 904         if (it == end())
 905                 lyxerr << "No submenu named " << name << endl;
 906         BOOST_ASSERT(it != end());
 907         return (*it);
 908 }
 909
 910
 911 Menu const & MenuBackend::getMenubar() const
 912 {
 913         return menubar_;
 914 }