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