]> git.lyx.org Git - lyx.git/blob - src/MenuBackend.C
various toc-related fixes
[lyx.git] / 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/convert.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 = convert<string>(ii) + ". "
439                         + MakeDisplayPath((*lfit), 30)
440                         + '|' + convert<string>(ii);
441                 tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, (*lfit))), view);
442         }
443 }
444
445
446 void expandDocuments(Menu & tomenu, LyXView const * view)
447 {
448         typedef vector<string> Strings;
449         Strings const names = bufferlist.getFileNames();
450
451         if (names.empty()) {
452                 tomenu.add(MenuItem(MenuItem::Command, _("No Documents Open!"),
453                                     FuncRequest(LFUN_NOACTION)), view);
454                 return;
455         }
456
457         int ii = 1;
458         Strings::const_iterator docit = names.begin();
459         Strings::const_iterator end = names.end();
460         for (; docit != end; ++docit, ++ii) {
461                 string label = MakeDisplayPath(*docit, 20);
462                 if (ii < 10)
463                         label = convert<string>(ii) + ". " + label + '|' + convert<string>(ii);
464                 tomenu.add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_SWITCHBUFFER, *docit)), view);
465         }
466 }
467
468
469 void expandFormats(MenuItem::Kind kind, Menu & tomenu, LyXView const * view)
470 {
471         if (!view->buffer() && kind != MenuItem::ImportFormats) {
472                 tomenu.add(MenuItem(MenuItem::Command,
473                                     _("No Documents Open!"),
474                                     FuncRequest(LFUN_NOACTION)),
475                                     view);
476                 return;
477         }
478
479         typedef vector<Format const *> Formats;
480         Formats formats;
481         kb_action action;
482
483         switch (kind) {
484         case MenuItem::ImportFormats:
485                 formats = Importer::GetImportableFormats();
486                 action = LFUN_IMPORT;
487                 break;
488         case MenuItem::ViewFormats:
489                 formats = Exporter::GetExportableFormats(*view->buffer(), true);
490                 action = LFUN_PREVIEW;
491                 break;
492         case MenuItem::UpdateFormats:
493                 formats = Exporter::GetExportableFormats(*view->buffer(), true);
494                 action = LFUN_UPDATE;
495                 break;
496         default:
497                 formats = Exporter::GetExportableFormats(*view->buffer(), false);
498                 action = LFUN_EXPORT;
499         }
500         sort(formats.begin(), formats.end(), compare_format());
501
502         Formats::const_iterator fit = formats.begin();
503         Formats::const_iterator end = formats.end();
504         for (; fit != end ; ++fit) {
505                 if ((*fit)->dummy())
506                         continue;
507                 string label = (*fit)->prettyname();
508                 // we need to hide the default graphic export formats
509                 // from the external menu, because we need them only
510                 // for the internal lyx-view and external latex run
511                 if (label == "EPS" || label == "XPM" || label == "PNG")
512                         continue;
513
514                 if (kind == MenuItem::ImportFormats) {
515                         if ((*fit)->name() == "text")
516                                 label = _("ASCII text as lines");
517                         else if ((*fit)->name() == "textparagraph")
518                                 label = _("ASCII text as paragraphs");
519                         label += "...";
520                 }
521                 if (!(*fit)->shortcut().empty())
522                         label += '|' + (*fit)->shortcut();
523
524                 tomenu.add(MenuItem(MenuItem::Command, label,
525                                     FuncRequest(action, (*fit)->name())),
526                            view);
527         }
528 }
529
530
531 void expandFloatListInsert(Menu & tomenu, LyXView const * view)
532 {
533         if (!view->buffer()) {
534                 tomenu.add(MenuItem(MenuItem::Command,
535                                     _("No Documents Open!"),
536                                     FuncRequest(LFUN_NOACTION)),
537                            view);
538                 return;
539         }
540
541         FloatList const & floats =
542                 view->buffer()->params().getLyXTextClass().floats();
543         FloatList::const_iterator cit = floats.begin();
544         FloatList::const_iterator end = floats.end();
545         for (; cit != end; ++cit) {
546                 tomenu.add(MenuItem(MenuItem::Command,
547                                     _(cit->second.listName()),
548                                     FuncRequest(LFUN_FLOAT_LIST,
549                                                 cit->second.type())),
550                            view);
551         }
552 }
553
554
555 void expandFloatInsert(Menu & tomenu, LyXView const * view)
556 {
557         if (!view->buffer()) {
558                 tomenu.add(MenuItem(MenuItem::Command,
559                                     _("No Documents Open!"),
560                                     FuncRequest(LFUN_NOACTION)),
561                            view);
562                 return;
563         }
564
565         FloatList const & floats =
566                 view->buffer()->params().getLyXTextClass().floats();
567         FloatList::const_iterator cit = floats.begin();
568         FloatList::const_iterator end = floats.end();
569         for (; cit != end; ++cit) {
570                 // normal float
571                 string const label = _(cit->second.name());
572                 tomenu.add(MenuItem(MenuItem::Command, label,
573                                     FuncRequest(LFUN_INSET_FLOAT,
574                                                 cit->second.type())),
575                            view);
576         }
577 }
578
579
580 void expandCharStyleInsert(Menu & tomenu, LyXView const * view)
581 {
582         if (!view->buffer()) {
583                 tomenu.add(MenuItem(MenuItem::Command,
584                                     _("No Documents Open!"),
585                                     FuncRequest(LFUN_NOACTION)),
586                            view);
587                 return;
588         }
589         CharStyles & charstyles =
590                 view->buffer()->params().getLyXTextClass().charstyles();
591         CharStyles::iterator cit = charstyles.begin();
592         CharStyles::iterator end = charstyles.end();
593         for (; cit != end; ++cit) {
594                 string const label = cit->name;
595                 tomenu.add(MenuItem(MenuItem::Command, label,
596                                     FuncRequest(LFUN_INSERT_CHARSTYLE,
597                                                 cit->name)), view);
598         }
599 }
600
601
602 Menu::size_type const max_number_of_items = 25;
603
604 void expandToc2(Menu & tomenu,
605                 lyx::toc::Toc const & toc_list,
606                 lyx::toc::Toc::size_type from,
607                 lyx::toc::Toc::size_type to, int depth)
608 {
609         int shortcut_count = 0;
610
611         // check whether depth is smaller than the smallest depth in toc.
612         int min_depth = 1000;
613         for (lyx::toc::Toc::size_type i = from; i < to; ++i) 
614                 min_depth = std::min(min_depth, toc_list[i].depth);
615         if (min_depth > depth)
616                 depth = min_depth;
617
618
619         if (to - from <= max_number_of_items) {
620                 for (lyx::toc::Toc::size_type i = from; i < to; ++i) {
621                         string label(4 * max(0, toc_list[i].depth - depth),' ');
622                         label += limit_string_length(toc_list[i].str);
623                         if (toc_list[i].depth == depth
624                             && shortcut_count < 9) {
625                                 if (label.find(convert<string>(shortcut_count + 1)) != string::npos)
626                                         label += '|' + convert<string>(++shortcut_count);
627                         }
628                         tomenu.add(MenuItem(MenuItem::Command, label,
629                                             FuncRequest(toc_list[i].action())));
630                 }
631         } else {
632                 lyx::toc::Toc::size_type pos = from;
633                 while (pos < to) {
634                         lyx::toc::Toc::size_type new_pos = pos + 1;
635                         while (new_pos < to &&
636                                toc_list[new_pos].depth > depth)
637                                 ++new_pos;
638
639                         string label(4 * max(0, toc_list[pos].depth - depth), ' ');
640                         label += limit_string_length(toc_list[pos].str);
641                         if (toc_list[pos].depth == depth &&
642                             shortcut_count < 9) {
643                                 if (label.find(convert<string>(shortcut_count + 1)) != string::npos)
644                                         label += '|' + convert<string>(++shortcut_count);
645                                 }
646                         if (new_pos == pos + 1) {
647                                 tomenu.add(MenuItem(MenuItem::Command,
648                                                     label, FuncRequest(toc_list[pos].action())));
649                         } else {
650                                 MenuItem item(MenuItem::Submenu, label);
651                                 item.submenu(new Menu);
652                                 expandToc2(*item.submenu(),
653                                            toc_list, pos, new_pos, depth + 1);
654                                 tomenu.add(item);
655                         }
656                         pos = new_pos;
657                 }
658         }
659 }
660
661
662 void expandToc(Menu & tomenu, LyXView const * view)
663 {
664         // To make things very cleanly, we would have to pass view to
665         // all MenuItem constructors and to expandToc2. However, we
666         // know that all the entries in a TOC will be have status_ ==
667         // OK, so we avoid this unnecessary overhead (JMarc)
668
669         if (!view->buffer()) {
670                 tomenu.add(MenuItem(MenuItem::Command,
671                                     _("No Documents Open!"),
672                                     FuncRequest(LFUN_NOACTION)),
673                            view);
674                 return;
675         }
676
677         lyx::toc::TocList toc_list = lyx::toc::getTocList(*view->buffer());
678         lyx::toc::TocList::const_iterator cit = toc_list.begin();
679         lyx::toc::TocList::const_iterator end = toc_list.end();
680         for (; cit != end; ++cit) {
681                 // Handle this later
682                 if (cit->first == "TOC")
683                         continue;
684
685                 // All the rest is for floats
686                 auto_ptr<Menu> menu(new Menu);
687                 lyx::toc::Toc::const_iterator ccit = cit->second.begin();
688                 lyx::toc::Toc::const_iterator eend = cit->second.end();
689                 for (; ccit != eend; ++ccit) {
690                         string const label = limit_string_length(ccit->str);
691                         menu->add(MenuItem(MenuItem::Command,
692                                            label,
693                                            FuncRequest(ccit->action())));
694                 }
695                 string const & floatName = cit->first;
696                 // Is the _(...) really needed here? (Lgb)
697                 MenuItem item(MenuItem::Submenu, _(floatName));
698                 item.submenu(menu.release());
699                 tomenu.add(item);
700         }
701
702         // Handle normal TOC
703         cit = toc_list.find("TOC");
704         if (cit == end) {
705                 tomenu.add(MenuItem(MenuItem::Command,
706                                     _("No Table of contents"),
707                                     FuncRequest()),
708                            view);
709         } else {
710                 expandToc2(tomenu, cit->second, 0, cit->second.size(), 0);
711         }
712 }
713
714
715 void expandPasteRecent(Menu & tomenu, LyXView const * view)
716 {
717         if (!view || !view->buffer())
718                 return;
719
720         vector<string> const sel =
721                 lyx::cap::availableSelections(*view->buffer());
722
723         vector<string>::const_iterator cit = sel.begin();
724         vector<string>::const_iterator end = sel.end();
725
726         for (unsigned int index = 0; cit != end; ++cit, ++index) {
727                 tomenu.add(MenuItem(MenuItem::Command, *cit,
728                                     FuncRequest(LFUN_PASTE, convert<string>(index))));
729         }
730 }
731
732
733 void expandBranches(Menu & tomenu, LyXView const * view)
734 {
735         if (!view || !view->buffer())
736                 return;
737
738         BufferParams const & params = view->buffer()->params();
739
740         std::list<Branch>::const_iterator cit = params.branchlist().begin();
741         std::list<Branch>::const_iterator end = params.branchlist().end();
742
743         for (int ii = 1; cit != end; ++cit, ++ii) {
744                 string label = cit->getBranch();
745                 if (ii < 10)
746                         label = convert<string>(ii) + ". " + label + "|" + convert<string>(ii);
747                 tomenu.add(MenuItem(MenuItem::Command, label,
748                                     FuncRequest(LFUN_INSERT_BRANCH,
749                                                 cit->getBranch())), view);
750         }
751 }
752
753
754 } // namespace anon
755
756
757 void MenuBackend::expand(Menu const & frommenu, Menu & tomenu,
758                          LyXView const * view) const
759 {
760         for (Menu::const_iterator cit = frommenu.begin();
761              cit != frommenu.end() ; ++cit) {
762                 switch (cit->kind()) {
763                 case MenuItem::Lastfiles:
764                         expandLastfiles(tomenu, view);
765                         break;
766
767                 case MenuItem::Documents:
768                         expandDocuments(tomenu, view);
769                         break;
770
771                 case MenuItem::ImportFormats:
772                 case MenuItem::ViewFormats:
773                 case MenuItem::UpdateFormats:
774                 case MenuItem::ExportFormats:
775                         expandFormats(cit->kind(), tomenu, view);
776                         break;
777
778                 case MenuItem::CharStyles:
779                         expandCharStyleInsert(tomenu, view);
780                         break;
781
782                 case MenuItem::FloatListInsert:
783                         expandFloatListInsert(tomenu, view);
784                         break;
785
786                 case MenuItem::FloatInsert:
787                         expandFloatInsert(tomenu, view);
788                         break;
789
790                 case MenuItem::PasteRecent:
791                         expandPasteRecent(tomenu, view);
792                         break;
793
794                 case MenuItem::Branches:
795                         expandBranches(tomenu, view);
796                         break;
797
798                 case MenuItem::Toc:
799                         expandToc(tomenu, view);
800                         break;
801
802                 case MenuItem::Submenu: {
803                         MenuItem item(*cit);
804                         item.submenu(new Menu(cit->submenuname()));
805                         expand(getMenu(cit->submenuname()),
806                                *item.submenu(), view);
807                         tomenu.add(item, view);
808                 }
809                 break;
810
811                 case MenuItem::Separator:
812                         tomenu.add(*cit, view);
813                         break;
814
815                 case MenuItem::Command:
816                         if (!specialmenu_
817                             || !specialmenu_->hasFunc(cit->func()))
818                                 tomenu.add(*cit, view);
819                 }
820         }
821
822         // we do not want the menu to end with a separator
823         if (!tomenu.empty()
824             && tomenu.items_.back().kind() == MenuItem::Separator)
825                 tomenu.items_.pop_back();
826
827         // Check whether the shortcuts are unique
828         tomenu.checkShortcuts();
829 }
830
831
832 void MenuBackend::read(LyXLex & lex)
833 {
834         enum Menutags {
835                 md_menu = 1,
836                 md_menubar,
837                 md_endmenuset,
838                 md_last
839         };
840
841         struct keyword_item menutags[md_last - 1] = {
842                 { "end", md_endmenuset },
843                 { "menu", md_menu },
844                 { "menubar", md_menubar }
845         };
846
847         //consistency check
848         if (compare_ascii_no_case(lex.getString(), "menuset")) {
849                 lyxerr << "Menubackend::read: ERROR wrong token:`"
850                        << lex.getString() << '\'' << endl;
851         }
852
853         lex.pushTable(menutags, md_last - 1);
854         if (lyxerr.debugging(Debug::PARSER))
855                 lex.printTable(lyxerr);
856
857         bool quit = false;
858
859         while (lex.isOK() && !quit) {
860                 switch (lex.lex()) {
861                 case md_menubar:
862                         menubar_.read(lex);
863                         break;
864                 case md_menu: {
865                         lex.next(true);
866                         string const name = lex.getString();
867                         if (hasMenu(name)) {
868                                 getMenu(name).read(lex);
869                         } else {
870                                 Menu menu(name);
871                                 menu.read(lex);
872                                 add(menu);
873                         }
874                         break;
875                 }
876                 case md_endmenuset:
877                         quit = true;
878                         break;
879                 default:
880                         lex.printError("menubackend::read: "
881                                        "Unknown menu tag: `$$Token'");
882                         break;
883                 }
884         }
885         lex.popTable();
886 }
887
888
889 void MenuBackend::add(Menu const & menu)
890 {
891         menulist_.push_back(menu);
892 }
893
894
895 bool MenuBackend::hasMenu(string const & name) const
896 {
897         return find_if(begin(), end(), MenuNamesEqual(name)) != end();
898 }
899
900
901 Menu const & MenuBackend::getMenu(string const & name) const
902 {
903         const_iterator cit = find_if(begin(), end(), MenuNamesEqual(name));
904         if (cit == end())
905                 lyxerr << "No submenu named " << name << endl;
906         BOOST_ASSERT(cit != end());
907         return (*cit);
908 }
909
910
911 Menu & MenuBackend::getMenu(string const & name)
912 {
913         iterator it = find_if(begin(), end(), MenuNamesEqual(name));
914         if (it == end())
915                 lyxerr << "No submenu named " << name << endl;
916         BOOST_ASSERT(it != end());
917         return (*it);
918 }
919
920
921 Menu const & MenuBackend::getMenubar() const
922 {
923         return menubar_;
924 }