]> git.lyx.org Git - lyx.git/blob - src/Layout.cpp
DocBook: add a layout tag to tell whether an item is the abstract or not.
[lyx.git] / src / Layout.cpp
1 /**
2  * \file Layout.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Lars Gullik Bjønnes
7  * \author Jean-Marc Lasgouttes
8  * \author André Pönitz
9  *
10  * Full author contact details are available in file CREDITS.
11  */
12
13 #include <config.h>
14
15 #include "Layout.h"
16 #include "FontInfo.h"
17 #include "Language.h"
18 #include "Lexer.h"
19 #include "output_xhtml.h"
20 #include "TextClass.h"
21
22 #include "support/debug.h"
23 #include "support/lassert.h"
24 #include "support/lstrings.h"
25 #include "support/Messages.h"
26 #include "support/textutils.h"
27
28
29 using namespace std;
30 using namespace lyx::support;
31
32 namespace lyx {
33
34 /// Special value of toclevel for layouts that do not belong to a TOC
35 const int Layout::NOT_IN_TOC = -1000;
36
37 //  The order of the LayoutTags enum is no more important. [asierra300396]
38 // Tags indexes.
39 enum LayoutTags {
40         LT_ALIGN = 1,
41         LT_ALIGNPOSSIBLE,
42         LT_ARGUMENT,
43         LT_AUTONESTS,
44         LT_AUTONESTEDBY,
45         LT_MARGIN,
46         LT_BOTTOMSEP,
47         LT_CATEGORY,
48         LT_COMMANDDEPTH,
49         LT_COPYSTYLE,
50         LT_DEPENDSON,
51         LT_OBSOLETEDBY,
52         LT_END,
53         LT_FONT,
54         LT_FREE_SPACING,
55         LT_PASS_THRU,
56         LT_PASS_THRU_CHARS,
57         LT_PARBREAK_IS_NEWLINE,
58         LT_ITEMCOMMAND,
59         LT_ITEMSEP,
60         LT_KEEPEMPTY,
61         LT_LABEL_BOTTOMSEP,
62         LT_LABELFONT,
63         LT_TEXTFONT,
64         LT_LABELINDENT,
65         LT_LABELSEP,
66         LT_LABELSTRING,
67         LT_LABELSTRING_APPENDIX,
68         LT_LABELCOUNTER,
69         LT_LABELTYPE,
70         LT_ENDLABELSTRING,
71         LT_ENDLABELTYPE,
72         LT_LATEXNAME,
73         LT_LATEXPARAM,
74         LT_LATEXTYPE,
75         LT_LEFTDELIM,
76         LT_LEFTMARGIN,
77         LT_NEED_CPROTECT,
78         LT_NEED_MBOXPROTECT,
79         LT_NEED_PROTECT,
80         LT_NEWLINE,
81         LT_NEXTNOINDENT,
82         LT_PAR_GROUP,
83         LT_PARINDENT,
84         LT_PARSEP,
85         LT_PARSKIP,
86         LT_PREAMBLE,
87         LT_LANGPREAMBLE,
88         LT_BABELPREAMBLE,
89         LT_REQUIRES,
90         LT_RIGHTMARGIN,
91         LT_SPACING,
92         LT_TOPSEP,
93         LT_TOCLEVEL,
94         LT_INNERTAG,
95         LT_LABELTAG,
96         LT_ITEMTAG,
97         LT_HTMLTAG,
98         LT_HTMLATTR,
99         LT_HTMLITEM,
100         LT_HTMLITEMATTR,
101         LT_HTMLLABEL,
102         LT_HTMLLABELATTR,
103         LT_HTMLLABELFIRST,
104         LT_HTMLPREAMBLE,
105         LT_HTMLSTYLE,
106         LT_HTMLFORCECSS,
107         LT_DOCBOOKTAG,
108         LT_DOCBOOKATTR,
109         LT_DOCBOOKININFO,
110         LT_DOCBOOKABSTRACT,
111         LT_DOCBOOKWRAPPERTAG,
112         LT_DOCBOOKWRAPPERATTR,
113         LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS,
114         LT_DOCBOOKSECTIONTAG,
115         LT_DOCBOOKITEMWRAPPERTAG,
116         LT_DOCBOOKITEMWRAPPERATTR,
117         LT_DOCBOOKITEMTAG,
118         LT_DOCBOOKITEMATTR,
119         LT_DOCBOOKITEMLABELTAG,
120         LT_DOCBOOKITEMLABELATTR,
121         LT_DOCBOOKITEMINNERTAG,
122         LT_DOCBOOKITEMINNERATTR,
123         LT_DOCBOOKFORCEABSTRACTTAG,
124         LT_INPREAMBLE,
125         LT_HTMLTITLE,
126         LT_SPELLCHECK,
127         LT_REFPREFIX,
128         LT_RESETARGS,
129         LT_RESUMECOUNTER,
130         LT_STEPMASTERCOUNTER,
131         LT_RIGHTDELIM,
132         LT_FORCELOCAL,
133         LT_TOGGLE_INDENT,
134         LT_ADDTOTOC,
135         LT_ISTOCCAPTION,
136         LT_INTITLE // keep this last!
137 };
138
139 /////////////////////
140
141 Layout::Layout()
142         : add_to_toc_(false), is_toc_caption_(true)
143 {
144         unknown_ = false;
145         margintype = MARGIN_STATIC;
146         latextype = LATEX_PARAGRAPH;
147         resumecounter = false;
148         stepmastercounter = false;
149         intitle = false;
150         inpreamble = false;
151         needprotect = false;
152         needcprotect = false;
153         needmboxprotect = false;
154         keepempty = false;
155         font = inherit_font;
156         labelfont = inherit_font;
157         resfont = sane_font;
158         reslabelfont = sane_font;
159         nextnoindent = false;
160         parskip = 0.0;
161         itemsep = 0;
162         topsep = 0.0;
163         bottomsep = 0.0;
164         labelbottomsep = 0.0;
165         parsep = 0;
166         align = LYX_ALIGN_BLOCK;
167         alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
168         labeltype = LABEL_NO_LABEL;
169         endlabeltype = END_LABEL_NO_LABEL;
170         // Should or should not. That is the question.
171         // spacing.set(Spacing::OneHalf);
172         newline_allowed = true;
173         free_spacing = false;
174         pass_thru = false;
175         parbreak_is_newline = false;
176         toclevel = NOT_IN_TOC;
177         commanddepth = 0;
178         htmllabelfirst_ = false;
179         htmlforcecss_ = false;
180         htmltitle_ = false;
181         docbookabstract_ = false;
182         docbookwrappermergewithprevious_ = false;
183         spellcheck = true;
184         forcelocal = 0;
185         itemcommand_ = "item";
186         toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
187         par_group_ = false;
188 }
189
190
191 bool Layout::read(Lexer & lex, TextClass const & tclass)
192 {
193         // If this is an empty layout, or if no force local version is set,
194         // we know that we will not discard the stuff to read
195         if (forcelocal == 0)
196                 return readIgnoreForcelocal(lex, tclass);
197         Layout tmp(*this);
198         tmp.forcelocal = 0;
199         bool const ret = tmp.readIgnoreForcelocal(lex, tclass);
200         // Keep the stuff if
201         // - the read version is higher
202         // - both versions are infinity (arbitrary decision)
203         // - the file did not contain any local version (needed for not
204         //   skipping user defined local layouts)
205         if (tmp.forcelocal <= 0 || tmp.forcelocal > forcelocal)
206                 *this = tmp;
207         return ret;
208 }
209
210
211 bool Layout::readIgnoreForcelocal(Lexer & lex, TextClass const & tclass)
212 {
213         // This table is sorted alphabetically [asierra 30March96]
214         LexerKeyword layoutTags[] = {
215                 { "addtotoc",       LT_ADDTOTOC },
216                 { "align",          LT_ALIGN },
217                 { "alignpossible",  LT_ALIGNPOSSIBLE },
218                 { "argument",       LT_ARGUMENT },
219                 { "autonests",      LT_AUTONESTS },
220                 { "babelpreamble",  LT_BABELPREAMBLE },
221                 { "bottomsep",      LT_BOTTOMSEP },
222                 { "category",       LT_CATEGORY },
223                 { "commanddepth",   LT_COMMANDDEPTH },
224                 { "copystyle",      LT_COPYSTYLE },
225                 { "dependson",      LT_DEPENDSON },
226                 { "docbookabstract",         LT_DOCBOOKABSTRACT },
227                 { "docbookattr",             LT_DOCBOOKATTR },
228                 { "docbookforceabstracttag", LT_DOCBOOKFORCEABSTRACTTAG },
229                 { "docbookininfo",           LT_DOCBOOKININFO },
230                 { "docbookitemattr",         LT_DOCBOOKITEMATTR },
231                 { "docbookiteminnerattr",    LT_DOCBOOKITEMINNERATTR },
232                 { "docbookiteminnertag",     LT_DOCBOOKITEMINNERTAG },
233                 { "docbookitemlabelattr",    LT_DOCBOOKITEMLABELATTR },
234                 { "docbookitemlabeltag",     LT_DOCBOOKITEMLABELTAG },
235                 { "docbookitemtag",          LT_DOCBOOKITEMTAG },
236                 { "docbookitemwrapperattr",  LT_DOCBOOKITEMWRAPPERATTR },
237                 { "docbookitemwrappertag",   LT_DOCBOOKITEMWRAPPERTAG },
238                 { "docbooksectiontag",       LT_DOCBOOKSECTIONTAG },
239                 { "docbooktag",              LT_DOCBOOKTAG },
240                 { "docbookwrapperattr",      LT_DOCBOOKWRAPPERATTR },
241                 { "docbookwrappermergewithprevious", LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS },
242                 { "docbookwrappertag",       LT_DOCBOOKWRAPPERTAG },
243                 { "end",            LT_END },
244                 { "endlabelstring", LT_ENDLABELSTRING },
245                 { "endlabeltype",   LT_ENDLABELTYPE },
246                 { "font",           LT_FONT },
247                 { "forcelocal",     LT_FORCELOCAL },
248                 { "freespacing",    LT_FREE_SPACING },
249                 { "htmlattr",       LT_HTMLATTR },
250                 { "htmlforcecss",   LT_HTMLFORCECSS },
251                 { "htmlitem",       LT_HTMLITEM },
252                 { "htmlitemattr",   LT_HTMLITEMATTR },
253                 { "htmllabel",      LT_HTMLLABEL },
254                 { "htmllabelattr",  LT_HTMLLABELATTR },
255                 { "htmllabelfirst", LT_HTMLLABELFIRST },
256                 { "htmlpreamble",   LT_HTMLPREAMBLE },
257                 { "htmlstyle",      LT_HTMLSTYLE },
258                 { "htmltag",        LT_HTMLTAG },
259                 { "htmltitle",      LT_HTMLTITLE },
260                 { "innertag",       LT_INNERTAG },
261                 { "inpreamble",     LT_INPREAMBLE },
262                 { "intitle",        LT_INTITLE },
263                 { "isautonestedby", LT_AUTONESTEDBY },
264                 { "istoccaption",   LT_ISTOCCAPTION },
265                 { "itemcommand",    LT_ITEMCOMMAND },
266                 { "itemsep",        LT_ITEMSEP },
267                 { "itemtag",        LT_ITEMTAG },
268                 { "keepempty",      LT_KEEPEMPTY },
269                 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
270                 { "labelcounter",   LT_LABELCOUNTER },
271                 { "labelfont",      LT_LABELFONT },
272                 { "labelindent",    LT_LABELINDENT },
273                 { "labelsep",       LT_LABELSEP },
274                 { "labelstring",    LT_LABELSTRING },
275                 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
276                 { "labeltag",       LT_LABELTAG },
277                 { "labeltype",      LT_LABELTYPE },
278                 { "langpreamble",   LT_LANGPREAMBLE },
279                 { "latexname",      LT_LATEXNAME },
280                 { "latexparam",     LT_LATEXPARAM },
281                 { "latextype",      LT_LATEXTYPE },
282                 { "leftdelim",      LT_LEFTDELIM },
283                 { "leftmargin",     LT_LEFTMARGIN },
284                 { "margin",         LT_MARGIN },
285                 { "needcprotect",    LT_NEED_CPROTECT },
286                 { "needmboxprotect", LT_NEED_MBOXPROTECT },
287                 { "needprotect",    LT_NEED_PROTECT },
288                 { "newline",        LT_NEWLINE },
289                 { "nextnoindent",   LT_NEXTNOINDENT },
290                 { "obsoletedby",    LT_OBSOLETEDBY },
291                 { "paragraphgroup", LT_PAR_GROUP },
292                 { "parbreakisnewline", LT_PARBREAK_IS_NEWLINE },
293                 { "parindent",      LT_PARINDENT },
294                 { "parsep",         LT_PARSEP },
295                 { "parskip",        LT_PARSKIP },
296                 { "passthru",       LT_PASS_THRU },
297                 { "passthruchars",  LT_PASS_THRU_CHARS },
298                 { "preamble",       LT_PREAMBLE },
299                 { "refprefix",      LT_REFPREFIX },
300                 { "requires",       LT_REQUIRES },
301                 { "resetargs",      LT_RESETARGS },
302                 { "resumecounter",  LT_RESUMECOUNTER },
303                 { "rightdelim",     LT_RIGHTDELIM },
304                 { "rightmargin",    LT_RIGHTMARGIN },
305                 { "spacing",        LT_SPACING },
306                 { "spellcheck",     LT_SPELLCHECK },
307                 { "stepmastercounter",  LT_STEPMASTERCOUNTER },
308                 { "textfont",       LT_TEXTFONT },
309                 { "toclevel",       LT_TOCLEVEL },
310                 { "toggleindent",   LT_TOGGLE_INDENT },
311                 { "topsep",         LT_TOPSEP }
312         };
313
314         bool error = false;
315         bool finished = false;
316         lex.pushTable(layoutTags);
317
318         // parse style section
319         while (!finished && lex.isOK() && !error) {
320                 int le = lex.lex();
321                 // See comment in LyXRC.cpp.
322                 switch (le) {
323                 case Lexer::LEX_FEOF:
324                         continue;
325
326                 case Lexer::LEX_UNDEF:
327                         // parse error
328                         lex.printError("Unknown layout tag `$$Token'");
329                         error = true;
330                         continue;
331
332                 default:
333                         break;
334                 }
335                 switch (static_cast<LayoutTags>(le)) {
336                 case LT_END:
337                         finished = true;
338                         break;
339
340                 case LT_CATEGORY:
341                         lex >> category_;
342                         break;
343
344                 case LT_COPYSTYLE: {
345                         docstring style;
346                         lex >> style;
347                         style = subst(style, '_', ' ');
348
349                         if (tclass.hasLayout(style)) {
350                                 docstring const tmpname = name_;
351                                 this->operator=(tclass[style]);
352                                 name_ = tmpname;
353                         } else {
354                                 LYXERR0("Cannot copy unknown style `"
355                                         << style << "'\n"
356                                         << "All layouts so far:");
357                                 DocumentClass::const_iterator lit = tclass.begin();
358                                 DocumentClass::const_iterator len = tclass.end();
359                                 for (; lit != len; ++lit)
360                                         LYXERR0(lit->name());
361                         }
362                         break;
363                         }
364
365                 case LT_OBSOLETEDBY: {
366                         docstring style;
367                         lex >> style;
368                         style = subst(style, '_', ' ');
369
370                         if (tclass.hasLayout(style)) {
371                                 docstring const tmpname = name_;
372                                 this->operator=(tclass[style]);
373                                 name_ = tmpname;
374                                 if (obsoleted_by().empty())
375                                         obsoleted_by_ = style;
376                         } else {
377                                 LYXERR0("Cannot replace with unknown style `"
378                                         << style << '\'');
379
380                                 //lex.printError("Cannot replace with"
381                                 //               " unknown style "
382                                 //               "`$$Token'");
383                         }
384                         break;
385                 }
386
387                 case LT_DEPENDSON:
388                         lex >> depends_on_;
389                         depends_on_ = subst(depends_on_, '_', ' ');
390                         break;
391
392                 case LT_MARGIN:
393                         readMargin(lex);
394                         break;
395
396                 case LT_LATEXTYPE:
397                         readLatexType(lex);
398                         break;
399
400                 case LT_INTITLE:
401                         lex >> intitle;
402                         break;
403
404                 case LT_INPREAMBLE:
405                         lex >> inpreamble;
406                         break;
407
408                 case LT_TOCLEVEL:
409                         lex >> toclevel;
410                         break;
411
412                 case LT_RESETARGS:
413                         bool reset;
414                         lex >> reset;
415                         if (reset) {
416                                 latexargs_.clear();
417                                 itemargs_.clear();
418                                 postcommandargs_.clear();
419                                 listpreamble_.clear();
420                         }
421                         break;
422
423                 case LT_RESUMECOUNTER:
424                         lex >> resumecounter;
425                         break;
426
427                 case LT_STEPMASTERCOUNTER:
428                         lex >> stepmastercounter;
429                         break;
430
431                 case LT_ARGUMENT:
432                         readArgument(lex);
433                         break;
434
435                 case LT_NEED_PROTECT:
436                         lex >> needprotect;
437                         break;
438
439                 case LT_NEED_CPROTECT:
440                         lex >> needcprotect;
441                         break;
442
443                 case LT_NEED_MBOXPROTECT:
444                         lex >> needmboxprotect;
445                         break;
446
447                 case LT_KEEPEMPTY:
448                         lex >> keepempty;
449                         break;
450
451                 case LT_FONT:
452                         font = lyxRead(lex, font);
453                         labelfont = font;
454                         break;
455
456                 case LT_TEXTFONT:
457                         font = lyxRead(lex, font);
458                         break;
459
460                 case LT_LABELFONT:
461                         labelfont = lyxRead(lex, labelfont);
462                         break;
463
464                 case LT_NEXTNOINDENT:
465                         lex >> nextnoindent;
466                         break;
467
468                 case LT_TOGGLE_INDENT: {
469                         string tog;
470                         lex >> tog;
471                         tog = support::ascii_lowercase(tog);
472                         if (tog == "always")
473                                 toggle_indent = ITOGGLE_ALWAYS;
474                         else if (tog == "never")
475                                 toggle_indent = ITOGGLE_NEVER;
476                         else
477                                 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
478                         break;
479                 }
480
481                 case LT_COMMANDDEPTH:
482                         lex >> commanddepth;
483                         break;
484
485                 case LT_LATEXNAME:
486                         lex >> latexname_;
487                         break;
488
489                 case LT_LATEXPARAM:
490                         lex >> latexparam_;
491                         latexparam_ = subst(latexparam_, "&quot;", "\"");
492                         break;
493
494                 case LT_LEFTDELIM:
495                         lex >> leftdelim_;
496                         leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
497                                                     from_ascii("\n"));
498                         break;
499
500                 case LT_RIGHTDELIM:
501                         lex >> rightdelim_;
502                         rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
503                                                      from_ascii("\n"));
504                         break;
505
506                 case LT_INNERTAG:
507                         lex >> innertag_;
508                         break;
509
510                 case LT_LABELTAG:
511                         lex >> labeltag_;
512                         break;
513
514                 case LT_ITEMTAG:
515                         lex >> itemtag_;
516                         break;
517
518                 case LT_ITEMCOMMAND:
519                         lex >> itemcommand_;
520                         break;
521
522                 case LT_PREAMBLE:
523                         preamble_ = lex.getLongString(from_ascii("EndPreamble"));
524                         break;
525
526                 case LT_LANGPREAMBLE:
527                         langpreamble_ = lex.getLongString(from_ascii("EndLangPreamble"));
528                         break;
529
530                 case LT_BABELPREAMBLE:
531                         babelpreamble_ = lex.getLongString(from_ascii("EndBabelPreamble"));
532                         break;
533
534                 case LT_LABELTYPE:
535                         readLabelType(lex);
536                         break;
537
538                 case LT_ENDLABELTYPE:
539                         readEndLabelType(lex);
540                         break;
541
542                 case LT_LEFTMARGIN:
543                         lex >> leftmargin;
544                         break;
545
546                 case LT_RIGHTMARGIN:
547                         lex >> rightmargin;
548                         break;
549
550                 case LT_LABELINDENT:
551                         lex >> labelindent;
552                         break;
553
554                 case LT_PARINDENT:
555                         lex >> parindent;
556                         break;
557
558                 case LT_PARSKIP:
559                         lex >> parskip;
560                         break;
561
562                 case LT_ITEMSEP:
563                         lex >> itemsep;
564                         break;
565
566                 case LT_TOPSEP:
567                         lex >> topsep;
568                         break;
569
570                 case LT_BOTTOMSEP:
571                         lex >> bottomsep;
572                         break;
573
574                 case LT_LABEL_BOTTOMSEP:
575                         lex >> labelbottomsep;
576                         break;
577
578                 case LT_LABELSEP:
579                         lex >> labelsep;
580                         labelsep = subst(labelsep, 'x', ' ');
581                         break;
582
583                 case LT_PARSEP:
584                         lex >> parsep;
585                         break;
586
587                 case LT_NEWLINE:
588                         lex >> newline_allowed;
589                         break;
590
591                 case LT_ALIGN:
592                         readAlign(lex);
593                         break;
594
595                 case LT_ALIGNPOSSIBLE:
596                         readAlignPossible(lex);
597                         break;
598
599                 case LT_LABELSTRING:
600                         // FIXME: this means LT_LABELSTRING_APPENDIX may only
601                         // occur after LT_LABELSTRING
602                         lex >> labelstring_;
603                         labelstring_appendix_ = labelstring_;
604                         break;
605
606                 case LT_ENDLABELSTRING:
607                         lex >> endlabelstring_;
608                         break;
609
610                 case LT_LABELSTRING_APPENDIX:
611                         lex >> labelstring_appendix_;
612                         break;
613
614                 case LT_LABELCOUNTER:
615                         lex >> counter;
616                         break;
617
618                 case LT_PAR_GROUP:
619                         lex >> par_group_;
620                         break;
621
622                 case LT_FREE_SPACING:
623                         lex >> free_spacing;
624                         break;
625
626                 case LT_PASS_THRU:
627                         lex >> pass_thru;
628                         break;
629
630                 case LT_PASS_THRU_CHARS:
631                         lex >> pass_thru_chars;
632                         break;
633
634                 case LT_PARBREAK_IS_NEWLINE:
635                         lex >> parbreak_is_newline;
636                         break;
637
638                 case LT_SPACING:
639                         readSpacing(lex);
640                         break;
641
642                 case LT_REQUIRES: {
643                         lex.eatLine();
644                         vector<string> const req =
645                                 getVectorFromString(lex.getString(true));
646                         required_.insert(req.begin(), req.end());
647                         break;
648                 }
649
650                 case LT_AUTONESTS: {
651                         docstring autonest = lex.getLongString(from_ascii("EndAutoNests"));
652                         autonest = subst(autonest, from_ascii("\n"), docstring());
653                         autonest = subst(autonest, from_ascii("\t"), docstring());
654                         autonest = subst(autonest, from_ascii("\""), docstring());
655                         autonest = subst(autonest, '_', ' ');
656                         vector<docstring> const autonests =
657                                 getVectorFromString(autonest, from_ascii(","), false, true);
658                         autonests_.insert(autonests.begin(), autonests.end());
659                         break;
660                 }
661
662                 case LT_AUTONESTEDBY: {
663                         docstring autonest = lex.getLongString(from_ascii("EndIsAutoNestedBy"));
664                         autonest = subst(autonest, from_ascii("\n"), docstring());
665                         autonest = subst(autonest, from_ascii("\t"), docstring());
666                         autonest = subst(autonest, from_ascii("\""), docstring());
667                         autonest = subst(autonest, '_', ' ');
668                         vector<docstring> const autonests =
669                                 getVectorFromString(autonest, from_ascii(","), false, true);
670                         autonested_by_.insert(autonests.begin(), autonests.end());
671                         break;
672                 }
673
674                 case LT_REFPREFIX: {
675                         docstring arg;
676                         lex >> arg;
677                         if (arg == "OFF")
678                                 refprefix.clear();
679                         else
680                                 refprefix = arg;
681                         break;
682                 }
683
684                 case LT_HTMLTAG:
685                         lex >> htmltag_;
686                         break;
687
688                 case LT_HTMLATTR:
689                         lex >> htmlattr_;
690                         break;
691
692                 case LT_HTMLITEM:
693                         lex >> htmlitemtag_;
694                         break;
695
696                 case LT_HTMLITEMATTR:
697                         lex >> htmlitemattr_;
698                         break;
699
700                 case LT_HTMLLABEL:
701                         lex >> htmllabeltag_;
702                         break;
703
704                 case LT_HTMLLABELATTR:
705                         lex >> htmllabelattr_;
706                         break;
707
708                 case LT_HTMLLABELFIRST:
709                         lex >> htmllabelfirst_;
710                         break;
711
712                 case LT_HTMLSTYLE:
713                         htmlstyle_ = lex.getLongString(from_ascii("EndHTMLStyle"));
714                         break;
715
716                 case LT_HTMLFORCECSS:
717                         lex >> htmlforcecss_;
718                         break;
719
720                 case LT_HTMLPREAMBLE:
721                         htmlpreamble_ = lex.getLongString(from_ascii("EndPreamble"));
722                         break;
723
724                 case LT_HTMLTITLE:
725                         lex >> htmltitle_;
726                         break;
727
728                 case LT_DOCBOOKTAG:
729                         lex >> docbooktag_;
730                         break;
731
732                 case LT_DOCBOOKATTR:
733                         lex >> docbookattr_;
734                         break;
735
736                 case LT_DOCBOOKFORCEABSTRACTTAG:
737                         lex >> docbookforceabstracttag_;
738                         break;
739
740                 case LT_DOCBOOKININFO:
741                         lex >> docbookininfo_;
742                         break;
743
744                 case LT_DOCBOOKABSTRACT:
745                         lex >> docbookabstract_;
746                         break;
747
748                 case LT_DOCBOOKWRAPPERTAG:
749                         lex >> docbookwrappertag_;
750                         break;
751
752                 case LT_DOCBOOKWRAPPERATTR:
753                         lex >> docbookwrapperattr_;
754                         break;
755
756                 case LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS:
757                         lex >> docbookwrappermergewithprevious_;
758                         break;
759
760                 case LT_DOCBOOKSECTIONTAG:
761                         lex >> docbooksectiontag_;
762                         break;
763
764         case LT_DOCBOOKITEMWRAPPERTAG:
765             lex >> docbookitemwrappertag_;
766             break;
767
768         case LT_DOCBOOKITEMWRAPPERATTR:
769                         lex >> docbookitemwrapperattr_;
770                         break;
771
772                 case LT_DOCBOOKITEMTAG:
773                         lex >> docbookitemtag_;
774                         break;
775
776                 case LT_DOCBOOKITEMATTR:
777                         lex >> docbookitemattr_;
778                         break;
779
780                 case LT_DOCBOOKITEMLABELTAG:
781                         lex >> docbookitemlabeltag_;
782                         break;
783
784                 case LT_DOCBOOKITEMLABELATTR:
785                         lex >> docbookitemlabelattr_;
786                         break;
787
788                 case LT_DOCBOOKITEMINNERTAG:
789                         lex >> docbookiteminnertag_;
790                         break;
791
792                 case LT_DOCBOOKITEMINNERATTR:
793                         lex >> docbookiteminnerattr_;
794                         break;
795
796                 case LT_SPELLCHECK:
797                         lex >> spellcheck;
798                         break;
799
800                 case LT_FORCELOCAL:
801                         lex >> forcelocal;
802                         break;
803
804                 case LT_ADDTOTOC:
805                         lex >> toc_type_;
806                         add_to_toc_ = !toc_type_.empty();
807                         break;
808
809                 case LT_ISTOCCAPTION:
810                         lex >> is_toc_caption_;
811                         break;
812
813                 }
814         }
815         lex.popTable();
816         // make sure we only have inpreamble = true for commands
817         if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
818                 LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
819                 LYXERR0("Layout name: " << name());
820                 inpreamble = false;
821         }
822
823         return finished && !error;
824 }
825
826
827 enum {
828         AT_BLOCK = 1,
829         AT_LEFT,
830         AT_RIGHT,
831         AT_CENTER,
832         AT_LAYOUT
833 };
834
835
836 LexerKeyword alignTags[] = {
837         { "block",  AT_BLOCK },
838         { "center", AT_CENTER },
839         { "layout", AT_LAYOUT },
840         { "left",   AT_LEFT },
841         { "right",  AT_RIGHT }
842 };
843
844
845 void Layout::readAlign(Lexer & lex)
846 {
847         PushPopHelper pph(lex, alignTags);
848         int le = lex.lex();
849         switch (le) {
850         case Lexer::LEX_UNDEF:
851                 lex.printError("Unknown alignment `$$Token'");
852                 return;
853         default: break;
854         };
855         switch (le) {
856         case AT_BLOCK:
857                 align = LYX_ALIGN_BLOCK;
858                 break;
859         case AT_LEFT:
860                 align = LYX_ALIGN_LEFT;
861                 break;
862         case AT_RIGHT:
863                 align = LYX_ALIGN_RIGHT;
864                 break;
865         case AT_CENTER:
866                 align = LYX_ALIGN_CENTER;
867                 break;
868         case AT_LAYOUT:
869                 align = LYX_ALIGN_LAYOUT;
870                 break;
871         }
872 }
873
874
875 void Layout::readAlignPossible(Lexer & lex)
876 {
877         lex.pushTable(alignTags);
878         alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
879         int lineno = lex.lineNumber();
880         do {
881                 int le = lex.lex();
882                 switch (le) {
883                 case Lexer::LEX_UNDEF:
884                         lex.printError("Unknown alignment `$$Token'");
885                         continue;
886                 default: break;
887                 };
888                 switch (le) {
889                 case AT_BLOCK:
890                         alignpossible |= LYX_ALIGN_BLOCK;
891                         break;
892                 case AT_LEFT:
893                         alignpossible |= LYX_ALIGN_LEFT;
894                         break;
895                 case AT_RIGHT:
896                         alignpossible |= LYX_ALIGN_RIGHT;
897                         break;
898                 case AT_CENTER:
899                         alignpossible |= LYX_ALIGN_CENTER;
900                         break;
901                 case AT_LAYOUT:
902                         alignpossible |= LYX_ALIGN_LAYOUT;
903                         break;
904                 }
905         } while (lineno == lex.lineNumber());
906         lex.popTable();
907 }
908
909
910 void Layout::readLabelType(Lexer & lex)
911 {
912         enum {
913                 LA_NO_LABEL = 1,
914                 LA_MANUAL,
915                 LA_ABOVE,
916                 LA_CENTERED,
917                 LA_STATIC,
918                 LA_SENSITIVE,
919                 LA_ENUMERATE,
920                 LA_ITEMIZE,
921                 LA_BIBLIO
922         };
923
924
925         LexerKeyword labelTypeTags[] = {
926           { "above",        LA_ABOVE },
927                 { "bibliography", LA_BIBLIO },
928                 { "centered",     LA_CENTERED },
929                 { "enumerate",    LA_ENUMERATE },
930                 { "itemize",      LA_ITEMIZE },
931                 { "manual",       LA_MANUAL },
932                 { "no_label",     LA_NO_LABEL },
933                 { "sensitive",    LA_SENSITIVE },
934                 { "static",       LA_STATIC }
935         };
936
937         PushPopHelper pph(lex, labelTypeTags);
938         int le = lex.lex();
939         switch (le) {
940         case Lexer::LEX_UNDEF:
941                 lex.printError("Unknown labeltype tag `$$Token'");
942                 return;
943         default: break;
944         }
945         switch (le) {
946         case LA_NO_LABEL:
947                 labeltype = LABEL_NO_LABEL;
948                 break;
949         case LA_MANUAL:
950                 labeltype = LABEL_MANUAL;
951                 break;
952         case LA_ABOVE:
953                 labeltype = LABEL_ABOVE;
954                 break;
955         case LA_CENTERED:
956                 labeltype = LABEL_CENTERED;
957                 break;
958         case LA_STATIC:
959                 labeltype = LABEL_STATIC;
960                 break;
961         case LA_SENSITIVE:
962                 labeltype = LABEL_SENSITIVE;
963                 break;
964         case LA_ENUMERATE:
965                 labeltype = LABEL_ENUMERATE;
966                 break;
967         case LA_ITEMIZE:
968                 labeltype = LABEL_ITEMIZE;
969                 break;
970         case LA_BIBLIO:
971                 labeltype = LABEL_BIBLIO;
972                 break;
973         }
974 }
975
976
977 void Layout::readEndLabelType(Lexer & lex)
978 {
979         // this should be const, but can't be because
980         // of PushPopHelper.
981         static LexerKeyword endlabelTypeTags[] = {
982                 { "box",              END_LABEL_BOX },
983                 { "filled_box", END_LABEL_FILLED_BOX },
984                 { "no_label",     END_LABEL_NO_LABEL },
985                 { "static",     END_LABEL_STATIC }
986         };
987
988         PushPopHelper pph(lex, endlabelTypeTags);
989         int le = lex.lex();
990         switch (le) {
991         case Lexer::LEX_UNDEF:
992                 lex.printError("Unknown labeltype tag `$$Token'");
993                 break;
994         case END_LABEL_STATIC:
995         case END_LABEL_BOX:
996         case END_LABEL_FILLED_BOX:
997         case END_LABEL_NO_LABEL:
998                 endlabeltype = static_cast<EndLabelType>(le);
999                 break;
1000         default:
1001                 LYXERR0("Unhandled value " << le);
1002                 break;
1003         }
1004 }
1005
1006
1007 void Layout::readMargin(Lexer & lex)
1008 {
1009         LexerKeyword marginTags[] = {
1010                 { "dynamic",           MARGIN_DYNAMIC },
1011                 { "first_dynamic",     MARGIN_FIRST_DYNAMIC },
1012                 { "manual",            MARGIN_MANUAL },
1013                 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
1014                 { "static",            MARGIN_STATIC }
1015         };
1016
1017         PushPopHelper pph(lex, marginTags);
1018
1019         int le = lex.lex();
1020         switch (le) {
1021         case Lexer::LEX_UNDEF:
1022                 lex.printError("Unknown margin type tag `$$Token'");
1023                 return;
1024         case MARGIN_STATIC:
1025         case MARGIN_MANUAL:
1026         case MARGIN_DYNAMIC:
1027         case MARGIN_FIRST_DYNAMIC:
1028         case MARGIN_RIGHT_ADDRESS_BOX:
1029                 margintype = static_cast<MarginType>(le);
1030                 break;
1031         default:
1032                 LYXERR0("Unhandled value " << le);
1033                 break;
1034         }
1035 }
1036
1037
1038 void Layout::readLatexType(Lexer & lex)
1039 {
1040         LexerKeyword latexTypeTags[] = {
1041                 { "bib_environment",  LATEX_BIB_ENVIRONMENT },
1042                 { "command",          LATEX_COMMAND },
1043                 { "environment",      LATEX_ENVIRONMENT },
1044                 { "item_environment", LATEX_ITEM_ENVIRONMENT },
1045                 { "list_environment", LATEX_LIST_ENVIRONMENT },
1046                 { "paragraph",        LATEX_PARAGRAPH }
1047         };
1048
1049         PushPopHelper pph(lex, latexTypeTags);
1050         int le = lex.lex();
1051         switch (le) {
1052         case Lexer::LEX_UNDEF:
1053                 lex.printError("Unknown latextype tag `$$Token'");
1054                 return;
1055         case LATEX_PARAGRAPH:
1056         case LATEX_COMMAND:
1057         case LATEX_ITEM_ENVIRONMENT:
1058         case LATEX_LIST_ENVIRONMENT:
1059                 latextype = static_cast<LatexType>(le);
1060                 break;
1061         case LATEX_ENVIRONMENT:
1062         case LATEX_BIB_ENVIRONMENT:
1063                 latextype = static_cast<LatexType>(le);
1064                 par_group_ = true;
1065                 break;
1066         default:
1067                 LYXERR0("Unhandled value " << le);
1068                 break;
1069         }
1070 }
1071
1072
1073 void Layout::readSpacing(Lexer & lex)
1074 {
1075         enum {
1076                 ST_SPACING_SINGLE = 1,
1077                 ST_SPACING_ONEHALF,
1078                 ST_SPACING_DOUBLE,
1079                 ST_OTHER
1080         };
1081
1082         LexerKeyword spacingTags[] = {
1083                 {"double",  ST_SPACING_DOUBLE },
1084                 {"onehalf", ST_SPACING_ONEHALF },
1085                 {"other",   ST_OTHER },
1086                 {"single",  ST_SPACING_SINGLE }
1087         };
1088
1089         PushPopHelper pph(lex, spacingTags);
1090         int le = lex.lex();
1091         switch (le) {
1092         case Lexer::LEX_UNDEF:
1093                 lex.printError("Unknown spacing token `$$Token'");
1094                 return;
1095         default: break;
1096         }
1097         switch (le) {
1098         case ST_SPACING_SINGLE:
1099                 spacing.set(Spacing::Single);
1100                 break;
1101         case ST_SPACING_ONEHALF:
1102                 spacing.set(Spacing::Onehalf);
1103                 break;
1104         case ST_SPACING_DOUBLE:
1105                 spacing.set(Spacing::Double);
1106                 break;
1107         case ST_OTHER:
1108                 lex.next();
1109                 spacing.set(Spacing::Other, lex.getString());
1110                 break;
1111         }
1112 }
1113
1114
1115 void Layout::readArgument(Lexer & lex)
1116 {
1117         latexarg arg;
1118         // writeArgument() makes use of these default values
1119         arg.mandatory = false;
1120         arg.nodelims = false;
1121         arg.autoinsert = false;
1122         arg.insertcotext = false;
1123         arg.insertonnewline = false;
1124         bool error = false;
1125         bool finished = false;
1126         arg.font = inherit_font;
1127         arg.labelfont = inherit_font;
1128         arg.is_toc_caption = false;
1129         arg.passthru = PT_INHERITED;
1130         arg.free_spacing = false;
1131         string id;
1132         lex >> id;
1133         bool const itemarg = prefixIs(id, "item:");
1134         bool const postcmd = prefixIs(id, "post:");
1135         bool const listpreamble = prefixIs(id, "listpreamble:");
1136
1137         while (!finished && lex.isOK() && !error) {
1138                 lex.next();
1139                 string const tok = ascii_lowercase(lex.getString());
1140
1141                 if (tok.empty()) {
1142                         continue;
1143                 } else if (tok == "endargument") {
1144                         finished = true;
1145                 } else if (tok == "labelstring") {
1146                         lex.next();
1147                         arg.labelstring = lex.getDocString();
1148                 } else if (tok == "menustring") {
1149                         lex.next();
1150                         arg.menustring = lex.getDocString();
1151                 } else if (tok == "mandatory") {
1152                         lex.next();
1153                         arg.mandatory = lex.getBool();
1154                 } else if (tok == "autoinsert") {
1155                         lex.next();
1156                         arg.autoinsert = lex.getBool();
1157                 } else if (tok == "insertcotext") {
1158                         lex.next();
1159                         arg.insertcotext = lex.getBool();
1160                 } else if (tok == "leftdelim") {
1161                         lex.next();
1162                         arg.ldelim = lex.getDocString();
1163                         arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
1164                                                     from_ascii("\n"));
1165                 } else if (tok == "rightdelim") {
1166                         lex.next();
1167                         arg.rdelim = lex.getDocString();
1168                         arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
1169                                                     from_ascii("\n"));
1170                 } else if (tok == "defaultarg") {
1171                         lex.next();
1172                         arg.defaultarg = lex.getDocString();
1173                 } else if (tok == "presetarg") {
1174                         lex.next();
1175                         arg.presetarg = lex.getDocString();
1176                 } else if (tok == "tooltip") {
1177                         lex.next();
1178                         arg.tooltip = lex.getDocString();
1179                 } else if (tok == "requires") {
1180                         lex.next();
1181                         arg.required = lex.getString();
1182                 } else if (tok == "decoration") {
1183                         lex.next();
1184                         arg.decoration = lex.getString();
1185                 } else if (tok == "newlinecmd") {
1186                         lex.next();
1187                         arg.newlinecmd = lex.getString();
1188                 } else if (tok == "font") {
1189                         arg.font = lyxRead(lex, arg.font);
1190                 } else if (tok == "labelfont") {
1191                         arg.labelfont = lyxRead(lex, arg.labelfont);
1192                 } else if (tok == "passthruchars") {
1193                         lex.next();
1194                         arg.pass_thru_chars = lex.getDocString();
1195                 } else if (tok == "passthru") {
1196                         lex.next();
1197                         docstring value = lex.getDocString();
1198                         if (value == "true" || value == "1")
1199                                 arg.passthru = PT_TRUE;
1200                         else if (value == "false" || value == "0")
1201                                 arg.passthru = PT_FALSE;
1202                         else
1203                                 arg.passthru = PT_INHERITED;
1204                 } else if (tok == "istoccaption") {
1205                         lex.next();
1206                         arg.is_toc_caption = lex.getBool();
1207                 } else if (tok == "freespacing") {
1208                         lex.next();
1209                         arg.free_spacing = lex.getBool();
1210                 } else {
1211                         lex.printError("Unknown tag");
1212                         error = true;
1213                 }
1214         }
1215         if (arg.labelstring.empty())
1216                 LYXERR0("Incomplete Argument definition!");
1217         else if (itemarg)
1218                 itemargs_[id] = arg;
1219         else if (postcmd)
1220                 postcommandargs_[id] = arg;
1221         else if (listpreamble) {
1222                 // list preamble has no delimiters by default
1223                 arg.nodelims = true;
1224                 listpreamble_[id] = arg;
1225         } else
1226                 latexargs_[id] = arg;
1227 }
1228
1229
1230 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1231 {
1232         os << "\tArgument " << id << '\n';
1233         if (!arg.labelstring.empty())
1234                 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1235         if (!arg.menustring.empty())
1236                 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1237         if (arg.mandatory)
1238                 os << "\t\tMandatory " << arg.mandatory << '\n';
1239         if (arg.autoinsert)
1240                 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1241         if (arg.insertcotext)
1242                 os << "\t\tInsertCotext " << arg.insertcotext << '\n';
1243         if (!arg.ldelim.empty())
1244                 os << "\t\tLeftDelim \""
1245                    << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1246                    << "\"\n";
1247         if (!arg.rdelim.empty())
1248                 os << "\t\tRightDelim \""
1249                    << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1250                    << "\"\n";
1251         if (!arg.defaultarg.empty())
1252                 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1253         if (!arg.presetarg.empty())
1254                 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1255         if (!arg.tooltip.empty())
1256                 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1257         if (!arg.required.empty())
1258                 os << "\t\tRequires \"" << arg.required << "\"\n";
1259         if (!arg.decoration.empty())
1260                 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1261         if (!arg.newlinecmd.empty())
1262                 os << "\t\tNewlineCmd \"" << arg.newlinecmd << "\"\n";
1263         if (arg.font != inherit_font)
1264                 lyxWrite(os, arg.font, "Font", 2);
1265         if (arg.labelfont != inherit_font)
1266                 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1267         switch (arg.passthru) {
1268                 case PT_TRUE:
1269                         os << "\t\tPassThru true\n";
1270                         break;
1271                 case PT_FALSE:
1272                         os << "\t\tPassThru false\n";
1273                         break;
1274                 case PT_INHERITED:
1275                         os << "\t\tPassThru inherited\n";
1276                         break;
1277         }
1278         if (!arg.pass_thru_chars.empty())
1279                 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1280         if (arg.free_spacing)
1281                 os << "\t\tFreeSpacing " << arg.free_spacing << "\n";
1282         os << "\tEndArgument\n";
1283 }
1284
1285
1286 void Layout::write(ostream & os) const
1287 {
1288         os << "Style \"" << to_utf8(name_) << "\"\n";
1289         if (!category_.empty() && obsoleted_by_.empty())
1290                 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1291         // Can't deduce Copystyle here :-(
1292         if (!obsoleted_by_.empty()) {
1293                 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1294                    << "\"\nEnd\n";
1295                 return;
1296         }
1297         if (!depends_on_.empty())
1298                 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1299         switch (margintype) {
1300                 case MARGIN_DYNAMIC:
1301                         os << "\tMargin Dynamic\n";
1302                         break;
1303                 case MARGIN_FIRST_DYNAMIC:
1304                         os << "\tMargin First_Dynamic\n";
1305                         break;
1306                 case MARGIN_MANUAL:
1307                         os << "\tMargin Manual\n";
1308                         break;
1309                 case MARGIN_RIGHT_ADDRESS_BOX:
1310                         os << "\tMargin Right_Address_Box\n";
1311                         break;
1312                 case MARGIN_STATIC:
1313                         os << "\tMargin Static\n";
1314                         break;
1315         }
1316         switch (latextype) {
1317                 case LATEX_BIB_ENVIRONMENT:
1318                         os << "\tLatexType Bib_Environment\n";
1319                         break;
1320                 case LATEX_COMMAND:
1321                         os << "\tLatexType Command\n";
1322                         break;
1323                 case LATEX_ENVIRONMENT:
1324                         os << "\tLatexType Environment\n";
1325                         break;
1326                 case LATEX_ITEM_ENVIRONMENT:
1327                         os << "\tLatexType Item_Environment\n";
1328                         break;
1329                 case LATEX_LIST_ENVIRONMENT:
1330                         os << "\tLatexType List_Environment\n";
1331                         break;
1332                 case LATEX_PARAGRAPH:
1333                         os << "\tLatexType Paragraph\n";
1334                         break;
1335         }
1336         os << "\tInTitle " << intitle << "\n"
1337               "\tInPreamble " << inpreamble << "\n"
1338               "\tTocLevel " << toclevel << "\n"
1339               "\tResumeCounter " << resumecounter << "\n"
1340              "\tStepMasterCounter " << stepmastercounter << '\n';
1341         // ResetArgs does not make sense here
1342         for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1343              it != latexargs_.end(); ++it)
1344                 writeArgument(os, it->first, it->second);
1345         for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1346              it != itemargs_.end(); ++it)
1347                 writeArgument(os, it->first, it->second);
1348         for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1349              it != postcommandargs_.end(); ++it)
1350                 writeArgument(os, it->first, it->second);
1351         for (LaTeXArgMap::const_iterator it = listpreamble_.begin();
1352              it != listpreamble_.end(); ++it)
1353                 writeArgument(os, it->first, it->second);
1354         os << "\tNeedProtect " << needprotect << "\n"
1355               "\tNeedCProtect " << needcprotect << "\n"
1356               "\tNeedMBoxProtect " << needmboxprotect << "\n"
1357               "\tKeepEmpty " << keepempty << '\n';
1358         if (labelfont == font)
1359                 lyxWrite(os, font, "Font", 1);
1360         else {
1361                 lyxWrite(os, font, "TextFont", 1);
1362                 lyxWrite(os, labelfont, "LabelFont", 1);
1363         }
1364         os << "\tNextNoIndent " << nextnoindent << "\n"
1365               "\tCommandDepth " << commanddepth << '\n';
1366         if (!latexname_.empty())
1367                 os << "\tLatexName \"" << latexname_ << "\"\n";
1368         if (!latexparam_.empty())
1369                 os << "\tLatexParam \"" << subst(latexparam_, "\"", "&quot;")
1370                    << "\"\n";
1371         if (!leftdelim_.empty())
1372                 os << "\tLeftDelim "
1373                    << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1374                    << '\n';
1375         if (!rightdelim_.empty())
1376                 os << "\tRightDelim "
1377                    << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1378                    << '\n';
1379         if (!innertag_.empty())
1380                 os << "\tInnerTag \"" << innertag_ << "\"\n";
1381         if (!labeltag_.empty())
1382                 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1383         if (!itemtag_.empty())
1384                 os << "\tItemTag \"" << itemtag_ << "\"\n";
1385         if (!itemcommand_.empty())
1386                 os << "\tItemCommand " << itemcommand_ << '\n';
1387         if (!preamble_.empty())
1388                 os << "\tPreamble\n\t"
1389                    << to_utf8(subst(rtrim(preamble_, "\n"),
1390                                     from_ascii("\n"), from_ascii("\n\t")))
1391                    << "\n\tEndPreamble\n";
1392         if (!langpreamble_.empty())
1393                 os << "\tLangPreamble\n\t"
1394                    << to_utf8(subst(rtrim(langpreamble_, "\n"),
1395                                     from_ascii("\n"), from_ascii("\n\t")))
1396                    << "\n\tEndLangPreamble\n";
1397         if (!babelpreamble_.empty())
1398                 os << "\tBabelPreamble\n\t"
1399                    << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1400                                     from_ascii("\n"), from_ascii("\n\t")))
1401                    << "\n\tEndBabelPreamble\n";
1402         switch (labeltype) {
1403         case LABEL_ABOVE:
1404                 os << "\tLabelType Above\n";
1405                 break;
1406         case LABEL_BIBLIO:
1407                 os << "\tLabelType Bibliography\n";
1408                 break;
1409         case LABEL_CENTERED:
1410                 os << "\tLabelType Centered\n";
1411                 break;
1412         case LABEL_ENUMERATE:
1413                 os << "\tLabelType Enumerate\n";
1414                 break;
1415         case LABEL_ITEMIZE:
1416                 os << "\tLabelType Itemize\n";
1417                 break;
1418         case LABEL_MANUAL:
1419                 os << "\tLabelType Manual\n";
1420                 break;
1421         case LABEL_NO_LABEL:
1422                 os << "\tLabelType No_Label\n";
1423                 break;
1424         case LABEL_SENSITIVE:
1425                 os << "\tLabelType Sensitive\n";
1426                 break;
1427         case LABEL_STATIC:
1428                 os << "\tLabelType Static\n";
1429                 break;
1430         }
1431         switch (endlabeltype) {
1432         case END_LABEL_BOX:
1433                 os << "\tEndLabelType Box\n";
1434                 break;
1435         case END_LABEL_FILLED_BOX:
1436                 os << "\tEndLabelType Filled_Box\n";
1437                 break;
1438         case END_LABEL_NO_LABEL:
1439                 os << "\tEndLabelType No_Label\n";
1440                 break;
1441         case END_LABEL_STATIC:
1442                 os << "\tEndLabelType Static\n";
1443                 break;
1444         }
1445         os << "\tParagraphGroup \"" << par_group_ << "\"\n";
1446         if (!leftmargin.empty())
1447                 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1448         if (!rightmargin.empty())
1449                 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1450         if (!labelindent.empty())
1451                 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1452         if (!parindent.empty())
1453                 os << "\tParIndent " << to_utf8(parindent) << '\n';
1454         os << "\tParSkip " << parskip << "\n"
1455               "\tItemSep " << itemsep << "\n"
1456               "\tTopSep " << topsep << "\n"
1457               "\tBottomSep " << bottomsep << "\n"
1458               "\tLabelBottomSep " << labelbottomsep << '\n';
1459         if (!labelsep.empty())
1460                 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1461                    << '\n';
1462         os << "\tParSep " << parsep << "\n"
1463               "\tNewLine " << newline_allowed << '\n';
1464         switch (align) {
1465         case LYX_ALIGN_BLOCK:
1466                 os << "\tAlign Block\n";
1467                 break;
1468         case LYX_ALIGN_CENTER:
1469                 os << "\tAlign Center\n";
1470                 break;
1471         case LYX_ALIGN_LAYOUT:
1472                 os << "\tAlign Layout\n";
1473                 break;
1474         case LYX_ALIGN_LEFT:
1475                 os << "\tAlign Left\n";
1476                 break;
1477         case LYX_ALIGN_RIGHT:
1478                 os << "\tAlign Right\n";
1479                 break;
1480         case LYX_ALIGN_DECIMAL:
1481         case LYX_ALIGN_SPECIAL:
1482         case LYX_ALIGN_NONE:
1483                 break;
1484         }
1485         if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1486                              LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1487                 bool first = true;
1488                 os << "\tAlignPossible";
1489                 if (alignpossible & LYX_ALIGN_BLOCK) {
1490                         os << " Block";
1491                         first = false;
1492                 }
1493                 if (alignpossible & LYX_ALIGN_CENTER) {
1494                         if (!first)
1495                                 os << ',';
1496                         os << " Center";
1497                         first = false;
1498                 }
1499                 if (alignpossible & LYX_ALIGN_LAYOUT) {
1500                         if (!first)
1501                                 os << ',';
1502                         os << " Layout";
1503                         first = false;
1504                 }
1505                 if (alignpossible & LYX_ALIGN_LEFT) {
1506                         if (!first)
1507                                 os << ',';
1508                         os << " Left";
1509                         first = false;
1510                 }
1511                 if (alignpossible & LYX_ALIGN_RIGHT) {
1512                         if (!first)
1513                                 os << ',';
1514                         os << " Right";
1515                         first = false;
1516                 }
1517                 os << '\n';
1518         }
1519         // LabelString must come before LabelStringAppendix
1520         if (!labelstring_.empty())
1521                 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1522         if (!endlabelstring_.empty())
1523                 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1524         if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1525                 os << "\tLabelStringAppendix \""
1526                    << to_utf8(labelstring_appendix_) << "\"\n";
1527         if (!counter.empty())
1528                 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1529         os << "\tFreeSpacing " << free_spacing << '\n';
1530         os << "\tPassThru " << pass_thru << '\n';
1531         if (!pass_thru_chars.empty())
1532                 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1533         os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1534         switch (spacing.getSpace()) {
1535         case Spacing::Double:
1536                 os << "\tSpacing Double\n";
1537                 break;
1538         case Spacing::Onehalf:
1539                 os << "\tSpacing Onehalf\n";
1540                 break;
1541         case Spacing::Other:
1542                 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1543                 break;
1544         case Spacing::Single:
1545                 os << "\tSpacing Single\n";
1546                 break;
1547         case Spacing::Default:
1548                 break;
1549         }
1550         if (!required_.empty()) {
1551                 os << "\tRequires ";
1552                 for (set<string>::const_iterator it = required_.begin();
1553                      it != required_.end(); ++it) {
1554                         if (it != required_.begin())
1555                                 os << ',';
1556                         os << *it;
1557                 }
1558                 os << '\n';
1559         }
1560         if (!autonests_.empty()) {
1561                 os << "\tAutoNests\n\t";
1562                 for (set<docstring>::const_iterator it = autonests_.begin();
1563                      it != autonests_.end(); ++it) {
1564                         if (it != autonests_.begin())
1565                                 os << ',';
1566                         os << to_utf8(*it);
1567                 }
1568                 os << "\n\tEndAutoNests\n";
1569         }
1570         if (!autonested_by_.empty()) {
1571                 os << "\tIsAutoNestedBy\n\t\t";
1572                 for (set<docstring>::const_iterator it = autonested_by_.begin();
1573                      it != autonested_by_.end(); ++it) {
1574                         if (it != autonested_by_.begin())
1575                                 os << ',';
1576                         os << to_utf8(*it);
1577                 }
1578                 os << "\n\tEndIsAutoNestedBy\n";
1579         }
1580         if (refprefix.empty())
1581                 os << "\tRefPrefix OFF\n";
1582         else
1583                 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1584         if (!htmltag_.empty())
1585                 os << "\tHTMLTag " << htmltag_ << '\n';
1586         if (!htmlattr_.empty())
1587                 os << "\tHTMLAttr " << htmlattr_ << '\n';
1588         if (!htmlitemtag_.empty())
1589                 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1590         if (!htmlitemattr_.empty())
1591                 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1592         if (!htmllabeltag_.empty())
1593                 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1594         if (!htmllabelattr_.empty())
1595                 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1596         os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1597         if (!htmlstyle_.empty())
1598                 os << "\tHTMLStyle\n"
1599                    << to_utf8(rtrim(htmlstyle_, "\n"))
1600                    << "\n\tEndHTMLStyle\n";
1601         os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1602         if (!htmlpreamble_.empty())
1603                 os << "\tHTMLPreamble\n"
1604                    << to_utf8(rtrim(htmlpreamble_, "\n"))
1605                    << "\n\tEndPreamble\n";
1606         os << "\tHTMLTitle " << htmltitle_ << "\n";
1607         if(!docbooktag_.empty())
1608                 os << "\tDocBookTag " << docbooktag_ << '\n';
1609         if(!docbookattr_.empty())
1610                 os << "\tDocBookAttr " << docbookattr_ << '\n';
1611         if(!docbookininfo_.empty())
1612                 os << "\tDocBookInInfo " << docbookininfo_ << '\n';
1613         os << "\tDocBookAbstract " << docbookabstract_ << '\n';
1614         if(!docbookwrappertag_.empty())
1615                 os << "\tDocBookWrapperTag " << docbookwrappertag_ << '\n';
1616         if(!docbookwrapperattr_.empty())
1617                 os << "\tDocBookWrapperAttr " << docbookwrapperattr_ << '\n';
1618         if(!docbooksectiontag_.empty())
1619                 os << "\tDocBookSectionTag " << docbooksectiontag_ << '\n';
1620         if(!docbookitemtag_.empty())
1621                 os << "\tDocBookItemTag " << docbookitemtag_ << '\n';
1622         if(!docbookitemattr_.empty())
1623                 os << "\tDocBookItemAttr " << docbookitemattr_ << '\n';
1624         if(!docbookitemwrappertag_.empty())
1625                 os << "\tDocBookItemWrapperTag " << docbookitemwrappertag_ << '\n';
1626         if(!docbookitemwrapperattr_.empty())
1627                 os << "\tDocBookItemWrapperAttr " << docbookitemwrapperattr_ << '\n';
1628         os << "\tDocBookItemWrapperMergeWithPrevious " << docbookwrappermergewithprevious_ << '\n';
1629         if(!docbookitemlabeltag_.empty())
1630                 os << "\tDocBookItemLabelTag " << docbookitemlabeltag_ << '\n';
1631         if(!docbookitemlabelattr_.empty())
1632                 os << "\tDocBookItemLabelAttr " << docbookitemlabelattr_ << '\n';
1633         if(!docbookiteminnertag_.empty())
1634                 os << "\tDocBookItemInnerTag " << docbookiteminnertag_ << '\n';
1635         if(!docbookiteminnerattr_.empty())
1636                 os << "\tDocBookItemInnerAttr " << docbookiteminnerattr_ << '\n';
1637         if(!docbookforceabstracttag_.empty())
1638                 os << "\tDocBookForceAbstractTag " << docbookforceabstracttag_ << '\n';
1639         os << "\tSpellcheck " << spellcheck << "\n"
1640               "\tForceLocal " << forcelocal << "\n"
1641               "End\n";
1642 }
1643
1644
1645 bool Layout::hasArgs() const
1646 {
1647         return !latexargs_.empty() || !postcommandargs_.empty() ||
1648                 !itemargs_.empty() || !listpreamble_.empty();
1649 }
1650
1651
1652 Layout::LaTeXArgMap Layout::args() const
1653 {
1654         LaTeXArgMap args = latexargs_;
1655         if (!postcommandargs_.empty())
1656                 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1657         if (!listpreamble_.empty())
1658                 args.insert(listpreamble_.begin(), listpreamble_.end());
1659         if (!itemargs_.empty())
1660                 args.insert(itemargs_.begin(), itemargs_.end());
1661         return args;
1662 }
1663
1664
1665 int Layout::optArgs() const
1666 {
1667         int nr = 0;
1668         LaTeXArgMap::const_iterator it = latexargs_.begin();
1669         for (; it != latexargs_.end(); ++it) {
1670                 if (!(*it).second.mandatory)
1671                         ++nr;
1672         }
1673         LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1674         for (; iit != postcommandargs_.end(); ++iit) {
1675                 if (!(*iit).second.mandatory)
1676                         ++nr;
1677         }
1678         return nr;
1679 }
1680
1681
1682 int Layout::requiredArgs() const
1683 {
1684         int nr = 0;
1685         LaTeXArgMap::const_iterator it = latexargs_.begin();
1686         for (; it != latexargs_.end(); ++it) {
1687                 if ((*it).second.mandatory)
1688                         ++nr;
1689         }
1690         LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1691         for (; iit != postcommandargs_.end(); ++iit) {
1692                 if (!(*iit).second.mandatory)
1693                         ++nr;
1694         }
1695         return nr;
1696 }
1697
1698
1699 string const & Layout::htmltag() const
1700 {
1701         if (htmltag_.empty())
1702                 htmltag_ =  "div";
1703         return htmltag_;
1704 }
1705
1706
1707 string const & Layout::htmlattr() const
1708 {
1709         if (htmlattr_.empty())
1710                 htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
1711         return htmlattr_;
1712 }
1713
1714
1715 string const & Layout::htmlitemtag() const
1716 {
1717         if (htmlitemtag_.empty())
1718                 htmlitemtag_ = "div";
1719         return htmlitemtag_;
1720 }
1721
1722
1723 string const & Layout::htmlitemattr() const
1724 {
1725         if (htmlitemattr_.empty())
1726                 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1727         return htmlitemattr_;
1728 }
1729
1730
1731 string const & Layout::htmllabeltag() const
1732 {
1733         if (htmllabeltag_.empty())
1734                         htmllabeltag_ = "span";
1735         return htmllabeltag_;
1736 }
1737
1738
1739 string const & Layout::htmllabelattr() const
1740 {
1741         if (htmllabelattr_.empty())
1742                 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1743         return htmllabelattr_;
1744 }
1745
1746
1747 docstring Layout::htmlstyle() const
1748 {
1749         if (!htmlstyle_.empty() && !htmlforcecss_)
1750                 return htmlstyle_;
1751         if (htmldefaultstyle_.empty())
1752                 makeDefaultCSS();
1753         docstring retval = htmldefaultstyle_;
1754         if (!htmlstyle_.empty())
1755                 retval += '\n' + htmlstyle_;
1756         return retval;
1757 }
1758
1759
1760 string Layout::defaultCSSClass() const
1761 {
1762         if (!defaultcssclass_.empty())
1763                 return defaultcssclass_;
1764         docstring d;
1765         docstring::const_iterator it = name().begin();
1766         docstring::const_iterator en = name().end();
1767         for (; it != en; ++it) {
1768                 char_type const c = *it;
1769                 if (!isAlphaASCII(c)) {
1770                         if (d.empty())
1771                                 // make sure we don't start with an underscore,
1772                                 // as that sometimes causes problems.
1773                                 d = from_ascii("lyx_");
1774                         else
1775                                 d += '_';
1776                 } else if (isLower(c))
1777                         d += c;
1778                 else
1779                         // this is slow, so do it only if necessary
1780                         d += lowercase(c);
1781         }
1782         defaultcssclass_ = to_utf8(d);
1783         return defaultcssclass_;
1784 }
1785
1786
1787 string const & Layout::docbooktag() const
1788 {
1789         // No sensible default value, unhappily...
1790         if (docbooktag_.empty())
1791                 docbooktag_ = to_utf8(name_);
1792         return docbooktag_;
1793 }
1794
1795
1796 string const & Layout::docbookattr() const
1797 {
1798         // Perfectly OK to return no attributes, so docbookattr_ does not need to be filled.
1799         return docbookattr_;
1800 }
1801
1802
1803 string const & Layout::docbookininfo() const
1804 {
1805         // Indeed, a trilean. Only titles should be "maybe": otherwise, metadata is "always", content is "never". 
1806         if (docbookininfo_.empty() || (docbookininfo_ != "never" && docbookininfo_ != "always" && docbookininfo_ != "maybe"))
1807                 docbookininfo_ = "never";
1808         return docbookininfo_;
1809 }
1810
1811
1812 string const & Layout::docbookwrappertag() const
1813 {
1814     if (docbookwrappertag_.empty())
1815         docbookwrappertag_ = "NONE";
1816     return docbookwrappertag_;
1817 }
1818
1819
1820 string const & Layout::docbookwrapperattr() const
1821 {
1822     return docbookwrapperattr_;
1823 }
1824
1825
1826 string const & Layout::docbooksectiontag() const
1827 {
1828         if (docbooksectiontag_.empty())
1829                 docbooksectiontag_ = "section";
1830         return docbooksectiontag_;
1831 }
1832
1833
1834 string const & Layout::docbookitemwrappertag() const
1835 {
1836     if (docbookitemwrappertag_.empty())
1837         docbookitemwrappertag_ = "NONE";
1838     return docbookitemwrappertag_;
1839 }
1840
1841
1842 string const & Layout::docbookitemwrapperattr() const
1843 {
1844     return docbookitemwrapperattr_;
1845 }
1846
1847
1848 string const & Layout::docbookitemtag() const
1849 {
1850     return docbookitemtag_;
1851 }
1852
1853
1854 string const & Layout::docbookitemattr() const
1855 {
1856     return docbookitemattr_;
1857 }
1858
1859
1860 string const & Layout::docbookitemlabeltag() const
1861 {
1862         if (docbookitemlabeltag_.empty())
1863                 docbookitemlabeltag_ = "NONE";
1864         return docbookitemlabeltag_;
1865 }
1866
1867
1868 string const & Layout::docbookitemlabelattr() const
1869 {
1870         return docbookitemlabelattr_;
1871 }
1872
1873
1874 string const & Layout::docbookiteminnertag() const
1875 {
1876         if (docbookiteminnertag_.empty())
1877                 docbookiteminnertag_ = "NONE";
1878         return docbookiteminnertag_;
1879 }
1880
1881
1882 string const & Layout::docbookiteminnerattr() const
1883 {
1884         return docbookiteminnerattr_;
1885 }
1886
1887
1888 std::string const & Layout::docbookforceabstracttag() const
1889 {
1890         if (docbookforceabstracttag_.empty())
1891                 docbookforceabstracttag_ = "NONE";
1892         return docbookforceabstracttag_;
1893 }
1894
1895
1896
1897 namespace {
1898
1899 string makeMarginValue(char const * side, double d)
1900 {
1901         ostringstream os;
1902         os << "margin-" << side << ": " << d << "ex;\n";
1903         return os.str();
1904 }
1905
1906 } // namespace
1907
1908
1909 void Layout::makeDefaultCSS() const
1910 {
1911         // this never needs to be redone, since reloading layouts will
1912         // wipe out what we did before.
1913         if (!htmldefaultstyle_.empty())
1914                 return;
1915
1916         // main font
1917         htmldefaultstyle_ = font.asCSS();
1918
1919         // bottom margins
1920         string tmp;
1921         if (topsep > 0)
1922                 tmp += makeMarginValue("top", topsep);
1923         if (bottomsep > 0)
1924                 tmp += makeMarginValue("bottom", bottomsep);
1925         if (!leftmargin.empty()) {
1926                 // we can't really do what LyX does with the margin, so
1927                 // we'll just figure out how many characters it is
1928                 int const len = leftmargin.length();
1929                 tmp += makeMarginValue("left", len);
1930         }
1931         if (!rightmargin.empty()) {
1932                 int const len = rightmargin.length();
1933                 tmp += makeMarginValue("right", len);
1934         }
1935
1936         if (!tmp.empty()) {
1937                 if (!htmldefaultstyle_.empty())
1938                         htmldefaultstyle_ += from_ascii("\n");
1939                 htmldefaultstyle_ += from_ascii(tmp);
1940         }
1941
1942         // alignment
1943         string where = alignmentToCSS(align);
1944         if (!where.empty()) {
1945                 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
1946         }
1947
1948         // wrap up what we have, if anything
1949         if (!htmldefaultstyle_.empty())
1950                 htmldefaultstyle_ =
1951                         from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
1952                         htmldefaultstyle_ + from_ascii("\n}\n");
1953
1954         if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
1955                 return;
1956
1957         docstring labelCSS;
1958
1959         // label font
1960         if (labelfont != font)
1961                 labelCSS = labelfont.asCSS() + from_ascii("\n");
1962         if (labeltype == LABEL_CENTERED)
1963                 labelCSS += from_ascii("text-align: center;\n");
1964
1965         if (!labelCSS.empty())
1966                 htmldefaultstyle_ +=
1967                         from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
1968                         labelCSS + from_ascii("\n}\n");
1969 }
1970
1971
1972 bool Layout::operator==(Layout const & rhs) const
1973 {
1974         // This is enough for the applications we actually make,
1975         // at least at the moment. But we could check more.
1976         return name() == rhs.name()
1977                 && latexname() == rhs.latexname()
1978                 && latextype == rhs.latextype;
1979 }
1980
1981
1982 } // namespace lyx