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