src/MenuBackend.C

   1 /* This file is part of
   2  * ======================================================
   3  *
   4  *           LyX, The Document Processor
   5  *
   6  *           Copyright 1995 Matthias Ettrich
   7  *           Copyright 1995-2001 The LyX Team.
   8  *
   9  *
  10  * ====================================================== */
  11
  12 #include <config.h>
  13
  14 #ifdef __GNUG__
  15 #pragma implementation
  16 #endif
  17
  18 #include <algorithm>
  19 #include "MenuBackend.h"
  20 #include "lyxlex.h"
  21 #include "LyXAction.h"
  22 #include "debug.h"
  23 #include "gettext.h"
  24 #include "lastfiles.h"
  25 #include "lyx_main.h" // for lastfiles
  26 #include "bufferlist.h"
  27 #include "converter.h"
  28 #include "exporter.h"
  29 #include "importer.h"
  30 #include "FloatList.h"
  31 #include "support/LAssert.h"
  32 #include "support/filetools.h"
  33 #include "support/lyxfunctional.h"
  34 #include "support/lstrings.h"
  35
  36 extern LyXAction lyxaction;
  37 extern BufferList bufferlist;
  38
  39 using std::endl;
  40 using std::vector;
  41 using std::pair;
  42 using std::find_if;
  43 using std::sort;
  44
  45 // This is the global menu definition
  46 MenuBackend menubackend;
  47
  48
  49 MenuItem::MenuItem(Kind kind, string const & label,
  50                    string const & command, bool optional)
  51         : kind_(kind), label_(label), optional_(optional)
  52 {
  53         switch (kind) {
  54         case Separator:
  55         case Documents:
  56         case Lastfiles:
  57         case Toc:
  58         case ViewFormats:
  59         case UpdateFormats:
  60         case ExportFormats:
  61         case ImportFormats:
  62         case FloatListInsert:
  63         case FloatInsert:
  64                 break;
  65         case Command:
  66                 action_ = lyxaction.LookupFunc(command);
  67
  68                 if (action_ == LFUN_UNKNOWN_ACTION) {
  69                         lyxerr << "MenuItem(): LyX command `"
  70                                << command << "' does not exist." << endl;
  71                 }
  72                 if (optional_)
  73                         lyxerr[Debug::GUI] << "Optional item "
  74                                            << command << endl;
  75                 break;
  76         case Submenu:
  77                 submenu_ = command;
  78                 break;
  79         }
  80 }
  81
  82
  83 string const MenuItem::label() const
  84 {
  85         return token(label_, '|', 0);
  86 }
  87
  88
  89 string const MenuItem::shortcut() const
  90 {
  91         return token(label_, '|', 1);
  92 }
  93
  94
  95 Menu & Menu::add(MenuItem const & i)
  96 {
  97         items_.push_back(i);
  98         return *this;
  99 }
 100
 101
 102 Menu & Menu::read(LyXLex & lex)
 103 {
 104         enum Menutags {
 105                 md_item = 1,
 106                 md_documents,
 107                 md_endmenu,
 108                 md_exportformats,
 109                 md_importformats,
 110                 md_lastfiles,
 111                 md_optitem,
 112                 md_separator,
 113                 md_submenu,
 114                 md_toc,
 115                 md_updateformats,
 116                 md_viewformats,
 117                 md_floatlistinsert,
 118                 md_floatinsert,
 119                 md_last
 120         };
 121
 122         struct keyword_item menutags[md_last - 1] = {
 123                 { "documents", md_documents },
 124                 { "end", md_endmenu },
 125                 { "exportformats", md_exportformats },
 126                 { "floatinsert", md_floatinsert },
 127                 { "floatlistinsert", md_floatlistinsert },
 128                 { "importformats", md_importformats },
 129                 { "item", md_item },
 130                 { "lastfiles", md_lastfiles },
 131                 { "optitem", md_optitem },
 132                 { "separator", md_separator },
 133                 { "submenu", md_submenu },
 134                 { "toc", md_toc },
 135                 { "updateformats", md_updateformats },
 136                 { "viewformats", md_viewformats }
 137         };
 138
 139         lex.pushTable(menutags, md_last - 1);
 140         if (lyxerr.debugging(Debug::PARSER))
 141                 lex.printTable(lyxerr);
 142
 143         bool quit = false;
 144         bool optional = false;
 145
 146         while (lex.isOK() && !quit) {
 147                 switch (lex.lex()) {
 148                 case md_optitem:
 149                         optional = true;
 150                         // fallback to md_item
 151                 case md_item: {
 152                         lex.next(true);
 153                         string const name = _(lex.getString());
 154                         lex.next(true);
 155                         string const command = lex.getString();
 156                         add(MenuItem(MenuItem::Command, name,
 157                                      command, optional));
 158                         optional = false;
 159                         break;
 160                 }
 161
 162                 case md_separator:
 163                         add(MenuItem(MenuItem::Separator));
 164                         break;
 165
 166                 case md_lastfiles:
 167                         add(MenuItem(MenuItem::Lastfiles));
 168                         break;
 169
 170                 case md_documents:
 171                         add(MenuItem(MenuItem::Documents));
 172                         break;
 173
 174                 case md_toc:
 175                         add(MenuItem(MenuItem::Toc));
 176                         break;
 177
 178                 case md_viewformats:
 179                         add(MenuItem(MenuItem::ViewFormats));
 180                         break;
 181
 182                 case md_updateformats:
 183                         add(MenuItem(MenuItem::UpdateFormats));
 184                         break;
 185
 186                 case md_exportformats:
 187                         add(MenuItem(MenuItem::ExportFormats));
 188                         break;
 189
 190                 case md_importformats:
 191                         add(MenuItem(MenuItem::ImportFormats));
 192                         break;
 193
 194                 case md_floatlistinsert:
 195                         add(MenuItem(MenuItem::FloatListInsert));
 196                         break;
 197
 198                 case md_floatinsert:
 199                         add(MenuItem(MenuItem::FloatInsert));
 200                         break;
 201
 202                 case md_submenu: {
 203                         lex.next(true);
 204                         string const mlabel = _(lex.getString());
 205                         lex.next(true);
 206                         string const mname = lex.getString();
 207                         add(MenuItem(MenuItem::Submenu, mlabel, mname));
 208                         break;
 209                 }
 210
 211                 case md_endmenu:
 212                         quit = true;
 213                         break;
 214
 215                 default:
 216                         lex.printError("menubar::read: "
 217                                        "Unknown menu tag: `$$Token'");
 218                         break;
 219                 }
 220         }
 221         lex.popTable();
 222         return *this;
 223 }
 224
 225
 226 void Menu::checkShortcuts() const
 227 {
 228         // This is a quadratic algorithm, but we do not care because
 229         // it is used for debugging only.
 230         for (const_iterator it1 = begin(); it1 != end(); ++it1) {
 231                 string shortcut = it1->shortcut();
 232                 if (shortcut.empty())
 233                         continue;
 234                 if (!contains(it1->label(), shortcut))
 235                         lyxerr << "Menu warning: menu entry \""
 236                                << it1->label()
 237                                << "\" does not contain shortcut `"
 238                                << shortcut << '\'' << endl;
 239                 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
 240                         if (!compare_no_case(it2->shortcut(), shortcut)) {
 241                                 lyxerr << "Menu warning: menu entries "
 242                                        << '"' << it1->fulllabel()
 243                                        << "\" and \"" << it2->fulllabel()
 244                                        << "\" share the same shortcut."
 245                                        << endl;
 246                         }
 247                 }
 248         }
 249 }
 250
 251
 252 namespace {
 253
 254 class compare_format {
 255 public:
 256         bool operator()(Format const * p1, Format const * p2) {
 257                 return *p1 < *p2;
 258         }
 259 };
 260
 261 } // namespace anon
 262
 263
 264 void Menu::expand(Menu & tomenu, Buffer * buf) const
 265 {
 266         for (const_iterator cit = begin();
 267              cit != end() ; ++cit) {
 268                 switch (cit->kind()) {
 269                 case MenuItem::Lastfiles: {
 270                         int ii = 1;
 271                         LastFiles::const_iterator lfit = lastfiles->begin();
 272                         LastFiles::const_iterator end = lastfiles->end();
 273
 274                         for (; lfit != end && ii < 10; ++lfit, ++ii) {
 275                                 string const label = tostr(ii) + ". "
 276                                         + MakeDisplayPath((*lfit), 30)
 277                                         + '|' + tostr(ii);
 278                                 int const action = lyxaction.
 279                                         getPseudoAction(LFUN_FILE_OPEN,
 280                                                         (*lfit));
 281                                 tomenu.add(MenuItem(MenuItem::Command,
 282                                                     label, action));
 283                         }
 284                 }
 285                 break;
 286
 287                 case MenuItem::Documents: {
 288                         typedef vector<string> Strings;
 289
 290                         Strings const names = bufferlist.getFileNames();
 291
 292                         if (names.empty()) {
 293                                 tomenu.add(MenuItem(MenuItem::Command,
 294                                                     _("No Documents Open!"),
 295                                                     LFUN_NOACTION));
 296                                 break;
 297                         }
 298
 299                         Strings::const_iterator docit = names.begin();
 300                         Strings::const_iterator end = names.end();
 301                         for (; docit != end ; ++docit) {
 302                                 int const action = lyxaction
 303                                         .getPseudoAction(LFUN_SWITCHBUFFER,
 304                                                          *docit);
 305                                 string const label =
 306                                         MakeDisplayPath(*docit, 30);
 307                                 tomenu.add(MenuItem(MenuItem::Command,
 308                                                     label, action));
 309                         }
 310                 }
 311                 break;
 312
 313                 case MenuItem::ImportFormats:
 314                 case MenuItem::ViewFormats:
 315                 case MenuItem::UpdateFormats:
 316                 case MenuItem::ExportFormats: {
 317
 318                         if (!buf && cit->kind() != MenuItem::ImportFormats) {
 319                                 tomenu.add(MenuItem(MenuItem::Command,
 320                                                     _("No Documents Open!"),
 321                                                     LFUN_NOACTION));
 322                                 continue;
 323                         }
 324
 325                         typedef vector<Format const *> Formats;
 326
 327                         Formats formats;
 328
 329                         kb_action action;
 330                         switch (cit->kind()) {
 331                         case MenuItem::ImportFormats:
 332                                 formats = Importer::GetImportableFormats();
 333                                 action = LFUN_IMPORT;
 334                                 break;
 335                         case MenuItem::ViewFormats:
 336                                 formats = Exporter::GetExportableFormats(buf, true);
 337                                 action = LFUN_PREVIEW;
 338                                 break;
 339                         case MenuItem::UpdateFormats:
 340                                 formats = Exporter::GetExportableFormats(buf, true);
 341                                 action = LFUN_UPDATE;
 342                                 break;
 343                         default:
 344                                 formats = Exporter::GetExportableFormats(buf, false);
 345                                 action = LFUN_EXPORT;
 346                         }
 347                         sort(formats.begin(), formats.end(), compare_format());
 348
 349                         Formats::const_iterator fit = formats.begin();
 350                         Formats::const_iterator end = formats.end();
 351
 352                         for (; fit != end ; ++fit) {
 353                                 if ((*fit)->dummy())
 354                                         continue;
 355                                 string label = (*fit)->prettyname();
 356                                 // we need to hide the default graphic export
 357                                 // formats from the external menu, because we
 358                                 // need them only for the internal lyx-view and
 359                                 // external latex run
 360                                 if (label == "EPS" ||
 361                                     label == "XPM" ||
 362                                     label == "PNG")
 363                                         continue;
 364
 365                                 if (cit->kind() == MenuItem::ImportFormats)
 366                                         if ((*fit)->name() == "text")
 367                                                 label = _("Ascii text as lines");
 368                                         else if ((*fit)->name() == "textparagraph")
 369                                                 label = _("Ascii text as paragraphs");
 370                                 if (!(*fit)->shortcut().empty())
 371                                         label += "|" + (*fit)->shortcut();
 372                                 int const action2 = lyxaction.
 373                                         getPseudoAction(action,
 374                                                         (*fit)->name());
 375                                 tomenu.add(MenuItem(MenuItem::Command,
 376                                                     label, action2));
 377                         }
 378                 }
 379                 break;
 380
 381                 case MenuItem::FloatListInsert:
 382                 {
 383                         FloatList::const_iterator cit = floatList.begin();
 384                         FloatList::const_iterator end = floatList.end();
 385                         for (; cit != end; ++cit) {
 386                                 int const action =  lyxaction
 387                                         .getPseudoAction(LFUN_FLOAT_LIST,
 388                                                          cit->second.type());
 389                                 tomenu.add(MenuItem(MenuItem::Command,
 390                                                     _(cit->second.listName()),
 391                                                     action));
 392                         }
 393                 }
 394                 break;
 395
 396                 case MenuItem::FloatInsert:
 397                 {
 398                         FloatList::const_iterator cit = floatList.begin();
 399                         FloatList::const_iterator end = floatList.end();
 400                         for (; cit != end; ++cit) {
 401                                 // normal float
 402                                 int const action = lyxaction
 403                                         .getPseudoAction(LFUN_INSET_FLOAT,
 404                                                          cit->second.type());
 405                                 string const label = _(cit->second.name());
 406                                 tomenu.add(MenuItem(MenuItem::Command,
 407                                                     label, action));
 408
 409                                 // and the wide version
 410                                 int const action2 = lyxaction
 411                                         .getPseudoAction(LFUN_INSET_WIDE_FLOAT,
 412                                                          cit->second.type());
 413                                 string const label2 = label + _(" (wide)");
 414                                 tomenu.add(MenuItem(MenuItem::Command,
 415                                                     label2, action2));
 416                         }
 417                 }
 418                 break;
 419
 420                 default:
 421                         tomenu.add(*cit);
 422                 }
 423         }
 424
 425         // Check whether the shortcuts are unique
 426         if (lyxerr.debugging(Debug::GUI))
 427                 checkShortcuts();
 428 }
 429
 430
 431 bool Menu::hasSubmenu(string const & name) const
 432 {
 433         return find_if(begin(), end(),
 434                        lyx::compare_memfun(&MenuItem::submenu, name)) != end();
 435 }
 436
 437
 438 void MenuBackend::read(LyXLex & lex)
 439 {
 440         enum Menutags {
 441                 md_menu = 1,
 442                 md_menubar,
 443                 md_endmenuset,
 444                 md_last
 445         };
 446
 447         struct keyword_item menutags[md_last - 1] = {
 448                 { "end", md_endmenuset },
 449                 { "menu", md_menu },
 450                 { "menubar", md_menubar }
 451         };
 452
 453         //consistency check
 454         if (compare_no_case(lex.getString(), "menuset")) {
 455                 lyxerr << "Menubackend::read: ERROR wrong token:`"
 456                        << lex.getString() << '\'' << endl;
 457         }
 458
 459         lex.pushTable(menutags, md_last - 1);
 460         if (lyxerr.debugging(Debug::PARSER))
 461                 lex.printTable(lyxerr);
 462
 463         bool quit = false;
 464         bool menubar = false;
 465
 466         while (lex.isOK() && !quit) {
 467                 switch (lex.lex()) {
 468                 case md_menubar:
 469                         menubar = true;
 470                         // fallback to md_menu
 471                 case md_menu: {
 472                         lex.next(true);
 473                         string const name = lex.getString();
 474                         if (hasMenu(name)) {
 475                                 if (getMenu(name).menubar() == menubar) {
 476                                         getMenu(name).read(lex);
 477                                 } else {
 478                                         lex.printError("Cannot append to menu `$$Token' unless it is of the same type");
 479                                         return;
 480                                 }
 481                         } else {
 482                                 Menu menu(name, menubar);
 483                                 menu.read(lex);
 484                                 add(menu);
 485                         }
 486                         menubar = false;
 487                         break;
 488                 }
 489                 case md_endmenuset:
 490                         quit = true;
 491                         break;
 492                 default:
 493                         lex.printError("menubackend::read: "
 494                                        "Unknown menu tag: `$$Token'");
 495                         break;
 496                 }
 497         }
 498         lex.popTable();
 499 }
 500
 501
 502 void MenuBackend::defaults()
 503 {
 504         menulist_.clear();
 505
 506         lyxerr[Debug::GUI] << "MenuBackend::defaults: using default values"
 507                            << endl;
 508
 509         Menu file("file");
 510         file
 511                 .add(MenuItem(MenuItem::Command, _("New...|N"), "buffer-new"))
 512                 .add(MenuItem(MenuItem::Command, _("Open...|O"), "file-open"))
 513                 .add(MenuItem(MenuItem::Submenu, _("Import|I"), "import"))
 514                 .add(MenuItem(MenuItem::Command, _("Quit|Q"), "lyx-quit"))
 515                 .add(MenuItem(MenuItem::Separator))
 516                 .add(MenuItem(MenuItem::Lastfiles));
 517         add(file);
 518
 519         Menu import("import");
 520         import
 521                 .add(MenuItem(MenuItem::Command,
 522                               _("LaTeX...|L"), "buffer-import latex"))
 523                 .add(MenuItem(MenuItem::Command,
 524                               _("LinuxDoc...|L"), "buffer-import linuxdoc"));
 525         add(import);
 526
 527         Menu edit("edit");
 528         edit
 529                 .add(MenuItem(MenuItem::Command, _("Cut"), "cut"))
 530                 .add(MenuItem(MenuItem::Command, _("Copy"), "copy"))
 531                 .add(MenuItem(MenuItem::Command, _("Paste"), "paste"))
 532                 .add(MenuItem(MenuItem::Command, _("Emphasize"), "font-emph"));
 533         add(edit);
 534
 535         Menu documents("documents");
 536         documents.add(MenuItem(MenuItem::Documents));
 537         add(documents);
 538
 539         Menu main("main", true);
 540         main
 541                 .add(MenuItem(MenuItem::Submenu, _("File|F"), "file"))
 542                 .add(MenuItem(MenuItem::Submenu, _("Edit|E"), "edit"))
 543                 .add(MenuItem(MenuItem::Submenu,
 544                               _("Documents|D"), "documents"));
 545         add(main);
 546
 547         Menu main_nobuffer("main_nobuffer", true);
 548         main_nobuffer.add(MenuItem(MenuItem::Submenu, _("File|F"), "file"));
 549         add(main_nobuffer);
 550
 551         if (lyxerr.debugging(Debug::GUI)) {
 552                 for (const_iterator cit = begin();
 553                     cit != end() ; ++cit)
 554                         lyxerr << "Menu name: " << cit->name()
 555                                << ", Menubar: " << cit->menubar()
 556                                << endl;
 557         }
 558 }
 559
 560
 561 void MenuBackend::add(Menu const & menu)
 562 {
 563         menulist_.push_back(menu);
 564 }
 565
 566
 567 bool MenuBackend::hasMenu(string const & name) const
 568 {
 569         return find_if(begin(), end(),
 570                        lyx::compare_memfun(&Menu::name, name)) != end();
 571 }
 572
 573
 574 Menu const & MenuBackend::getMenu(string const & name) const
 575 {
 576         const_iterator cit = find_if(begin(), end(),
 577                                      lyx::compare_memfun(&Menu::name, name));
 578         lyx::Assert(cit != end());
 579         return (*cit);
 580 }
 581
 582
 583 Menu & MenuBackend::getMenu(string const & name)
 584 {
 585         MenuList::iterator it =
 586                 find_if(menulist_.begin(), menulist_.end(),
 587                         lyx::compare_memfun(&Menu::name, name));
 588         lyx::Assert(it != menulist_.end());
 589         return (*it);
 590 }