3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
10 * Full author contact details are available in file CREDITS.
17 #include "output_xhtml.h"
18 #include "TextClass.h"
20 #include "support/debug.h"
21 #include "support/docstream.h"
22 #include "support/lassert.h"
23 #include "support/lstrings.h"
24 #include "support/textutils.h"
28 using namespace lyx::support;
32 /// Special value of toclevel for layouts that do not belong to a TOC
33 const int Layout::NOT_IN_TOC = -1000;
35 // The order of the LayoutTags enum is no more important. [asierra300396]
55 LT_PARBREAK_IS_NEWLINE,
65 LT_LABELSTRING_APPENDIX,
111 LT_DOCBOOKINNERTAGTYPE,
114 LT_DOCBOOKGENERATETITLE,
115 LT_DOCBOOKWRAPPERTAG,
116 LT_DOCBOOKWRAPPERATTR,
117 LT_DOCBOOKWRAPPERTAGTYPE,
118 LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS,
120 LT_DOCBOOKSECTIONTAG,
121 LT_DOCBOOKITEMWRAPPERTAG,
122 LT_DOCBOOKITEMWRAPPERATTR,
123 LT_DOCBOOKITEMWRAPPERTAGTYPE,
126 LT_DOCBOOKITEMTAGTYPE,
127 LT_DOCBOOKITEMLABELTAG,
128 LT_DOCBOOKITEMLABELATTR,
129 LT_DOCBOOKITEMLABELTAGTYPE,
130 LT_DOCBOOKITEMINNERTAG,
131 LT_DOCBOOKITEMINNERATTR,
132 LT_DOCBOOKITEMINNERTAGTYPE,
133 LT_DOCBOOKFORCEABSTRACTTAG,
134 LT_DOCBOOKNOFONTINSIDE,
141 LT_STEPPARENTCOUNTER,
148 LT_INTITLE // keep this last!
151 /////////////////////
154 : add_to_toc_(false), is_toc_caption_(true)
157 margintype = MARGIN_STATIC;
158 latextype = LATEX_PARAGRAPH;
159 resumecounter = false;
160 stepparentcounter = false;
164 needcprotect = false;
165 needmboxprotect = false;
168 labelfont = inherit_font;
170 reslabelfont = sane_font;
171 nextnoindent = false;
176 labelbottomsep = 0.0;
178 align = LYX_ALIGN_BLOCK;
179 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
180 labeltype = LABEL_NO_LABEL;
181 endlabeltype = END_LABEL_NO_LABEL;
182 // Should or should not. That is the question.
183 // spacing.set(Spacing::OneHalf);
184 newline_allowed = true;
185 free_spacing = false;
187 parbreak_is_newline = false;
188 toclevel = NOT_IN_TOC;
190 htmllabelfirst_ = false;
191 htmlforcecss_ = false;
194 docbookabstract_ = false;
195 docbookwrappermergewithprevious_ = false;
196 docbooksection_ = false;
199 itemcommand_ = "item";
200 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
205 bool Layout::read(Lexer & lex, TextClass const & tclass, bool validating)
207 // If this is an empty layout, or if no force local version is set,
208 // we know that we will not discard the stuff to read
210 return readIgnoreForcelocal(lex, tclass, validating);
213 bool const ret = tmp.readIgnoreForcelocal(lex, tclass, validating);
215 // - the read version is higher
216 // - both versions are infinity (arbitrary decision)
217 // - the file did not contain any local version (needed for not
218 // skipping user defined local layouts)
219 if (tmp.forcelocal <= 0 || tmp.forcelocal > forcelocal)
225 bool Layout::readIgnoreForcelocal(Lexer & lex, TextClass const & tclass,
228 // This table is sorted alphabetically [asierra 30March96]
229 LexerKeyword layoutTags[] = {
230 { "addtotoc", LT_ADDTOTOC },
231 { "align", LT_ALIGN },
232 { "alignpossible", LT_ALIGNPOSSIBLE },
233 { "argument", LT_ARGUMENT },
234 { "autonests", LT_AUTONESTS },
235 { "babelpreamble", LT_BABELPREAMBLE },
236 { "bottomsep", LT_BOTTOMSEP },
237 { "category", LT_CATEGORY },
238 { "commanddepth", LT_COMMANDDEPTH },
239 { "copystyle", LT_COPYSTYLE },
240 { "dependson", LT_DEPENDSON },
241 { "docbookabstract", LT_DOCBOOKABSTRACT },
242 { "docbookattr", LT_DOCBOOKATTR },
243 { "docbookforceabstracttag", LT_DOCBOOKFORCEABSTRACTTAG },
244 { "docbookgeneratetitle", LT_DOCBOOKGENERATETITLE },
245 { "docbookininfo", LT_DOCBOOKININFO },
246 { "docbookinnerattr", LT_DOCBOOKINNERATTR },
247 { "docbookinnertag", LT_DOCBOOKINNERTAG },
248 { "docbookinnertagtype", LT_DOCBOOKINNERTAGTYPE },
249 { "docbookitemattr", LT_DOCBOOKITEMATTR },
250 { "docbookiteminnerattr", LT_DOCBOOKITEMINNERATTR },
251 { "docbookiteminnertag", LT_DOCBOOKITEMINNERTAG },
252 { "docbookiteminnertagtype", LT_DOCBOOKITEMINNERTAGTYPE },
253 { "docbookitemlabelattr", LT_DOCBOOKITEMLABELATTR },
254 { "docbookitemlabeltag", LT_DOCBOOKITEMLABELTAG },
255 { "docbookitemlabeltagtype", LT_DOCBOOKITEMLABELTAGTYPE },
256 { "docbookitemtag", LT_DOCBOOKITEMTAG },
257 { "docbookitemtagtype", LT_DOCBOOKITEMTAGTYPE },
258 { "docbookitemwrapperattr", LT_DOCBOOKITEMWRAPPERATTR },
259 { "docbookitemwrappertag", LT_DOCBOOKITEMWRAPPERTAG },
260 { "docbookitemwrappertagtype", LT_DOCBOOKITEMWRAPPERTAGTYPE },
261 { "docbooknofontinside", LT_DOCBOOKNOFONTINSIDE, },
262 { "docbooksection", LT_DOCBOOKSECTION },
263 { "docbooksectiontag", LT_DOCBOOKSECTIONTAG },
264 { "docbooktag", LT_DOCBOOKTAG },
265 { "docbooktagtype", LT_DOCBOOKTAGTYPE },
266 { "docbookwrapperattr", LT_DOCBOOKWRAPPERATTR },
267 { "docbookwrappermergewithprevious", LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS },
268 { "docbookwrappertag", LT_DOCBOOKWRAPPERTAG },
269 { "docbookwrappertagtype", LT_DOCBOOKWRAPPERTAGTYPE },
271 { "endlabelstring", LT_ENDLABELSTRING },
272 { "endlabeltype", LT_ENDLABELTYPE },
274 { "forcelocal", LT_FORCELOCAL },
275 { "freespacing", LT_FREE_SPACING },
276 { "htmlattr", LT_HTMLATTR },
277 { "htmlclass", LT_HTMLCLASS },
278 { "htmlforcecss", LT_HTMLFORCECSS },
279 { "htmlintoc", LT_HTMLINTOC },
280 { "htmlitem", LT_HTMLITEM },
281 { "htmlitemattr", LT_HTMLITEMATTR },
282 { "htmllabel", LT_HTMLLABEL },
283 { "htmllabelattr", LT_HTMLLABELATTR },
284 { "htmllabelfirst", LT_HTMLLABELFIRST },
285 { "htmlpreamble", LT_HTMLPREAMBLE },
286 { "htmlstyle", LT_HTMLSTYLE },
287 { "htmltag", LT_HTMLTAG },
288 { "htmltitle", LT_HTMLTITLE },
289 { "innertag", LT_INNERTAG },
290 { "inpreamble", LT_INPREAMBLE },
291 { "intitle", LT_INTITLE },
292 { "isautonestedby", LT_AUTONESTEDBY },
293 { "istoccaption", LT_ISTOCCAPTION },
294 { "itemcommand", LT_ITEMCOMMAND },
295 { "itemsep", LT_ITEMSEP },
296 { "itemtag", LT_ITEMTAG },
297 { "keepempty", LT_KEEPEMPTY },
298 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
299 { "labelcounter", LT_LABELCOUNTER },
300 { "labelfont", LT_LABELFONT },
301 { "labelindent", LT_LABELINDENT },
302 { "labelsep", LT_LABELSEP },
303 { "labelstring", LT_LABELSTRING },
304 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
305 { "labeltag", LT_LABELTAG },
306 { "labeltype", LT_LABELTYPE },
307 { "langpreamble", LT_LANGPREAMBLE },
308 { "latexname", LT_LATEXNAME },
309 { "latexparam", LT_LATEXPARAM },
310 { "latextype", LT_LATEXTYPE },
311 { "leftdelim", LT_LEFTDELIM },
312 { "leftmargin", LT_LEFTMARGIN },
313 { "margin", LT_MARGIN },
314 { "needcprotect", LT_NEED_CPROTECT },
315 { "needmboxprotect", LT_NEED_MBOXPROTECT },
316 { "needprotect", LT_NEED_PROTECT },
317 { "newline", LT_NEWLINE },
318 { "nextnoindent", LT_NEXTNOINDENT },
319 { "obsoletedby", LT_OBSOLETEDBY },
320 { "paragraphgroup", LT_PAR_GROUP },
321 { "parbreakisnewline", LT_PARBREAK_IS_NEWLINE },
322 { "parindent", LT_PARINDENT },
323 { "parsep", LT_PARSEP },
324 { "parskip", LT_PARSKIP },
325 { "passthru", LT_PASS_THRU },
326 { "passthruchars", LT_PASS_THRU_CHARS },
327 { "preamble", LT_PREAMBLE },
328 { "refprefix", LT_REFPREFIX },
329 { "requires", LT_REQUIRES },
330 { "resetargs", LT_RESETARGS },
331 { "resumecounter", LT_RESUMECOUNTER },
332 { "rightdelim", LT_RIGHTDELIM },
333 { "rightmargin", LT_RIGHTMARGIN },
334 { "spacing", LT_SPACING },
335 { "spellcheck", LT_SPELLCHECK },
336 { "stepparentcounter", LT_STEPPARENTCOUNTER },
337 { "textfont", LT_TEXTFONT },
338 { "toclevel", LT_TOCLEVEL },
339 { "toggleindent", LT_TOGGLE_INDENT },
340 { "topsep", LT_TOPSEP }
344 bool finished = false;
345 lex.pushTable(layoutTags);
347 // parse style section
348 while (!finished && lex.isOK() && !error) {
350 // See comment in LyXRC.cpp.
352 case Lexer::LEX_FEOF:
355 case Lexer::LEX_UNDEF:
357 lex.printError("Unknown layout tag `$$Token'");
364 switch (static_cast<LayoutTags>(le)) {
376 style = subst(style, '_', ' ');
378 if (tclass.hasLayout(style)) {
379 docstring const tmpname = name_;
380 this->operator=(tclass[style]);
383 LYXERR0("Cannot copy unknown style `"
385 << "All layouts so far:");
386 DocumentClass::const_iterator lit = tclass.begin();
387 DocumentClass::const_iterator len = tclass.end();
388 for (; lit != len; ++lit)
389 LYXERR0(lit->name());
394 case LT_OBSOLETEDBY: {
397 style = subst(style, '_', ' ');
399 if (tclass.hasLayout(style)) {
400 docstring const tmpname = name_;
401 this->operator=(tclass[style]);
403 if (obsoleted_by().empty())
404 obsoleted_by_ = style;
406 LYXERR0("Cannot replace with unknown style `"
409 //lex.printError("Cannot replace with"
418 depends_on_ = subst(depends_on_, '_', ' ');
447 postcommandargs_.clear();
448 listpreamble_.clear();
452 case LT_RESUMECOUNTER:
453 lex >> resumecounter;
456 case LT_STEPPARENTCOUNTER:
457 lex >> stepparentcounter;
461 readArgument(lex, validating);
464 case LT_NEED_PROTECT:
468 case LT_NEED_CPROTECT:
472 case LT_NEED_MBOXPROTECT:
473 lex >> needmboxprotect;
481 font = lyxRead(lex, font);
486 font = lyxRead(lex, font);
490 labelfont = lyxRead(lex, labelfont);
493 case LT_NEXTNOINDENT:
497 case LT_TOGGLE_INDENT: {
500 tog = support::ascii_lowercase(tog);
502 toggle_indent = ITOGGLE_ALWAYS;
503 else if (tog == "never")
504 toggle_indent = ITOGGLE_NEVER;
506 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
510 case LT_COMMANDDEPTH:
520 latexparam_ = subst(latexparam_, """, "\"");
525 leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
531 rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
552 preamble_ = lex.getLongString(from_ascii("EndPreamble"));
555 case LT_LANGPREAMBLE:
556 langpreamble_ = lex.getLongString(from_ascii("EndLangPreamble"));
559 case LT_BABELPREAMBLE:
560 babelpreamble_ = lex.getLongString(from_ascii("EndBabelPreamble"));
567 case LT_ENDLABELTYPE:
568 readEndLabelType(lex);
603 case LT_LABEL_BOTTOMSEP:
604 lex >> labelbottomsep;
609 labelsep = subst(labelsep, 'x', ' ');
617 lex >> newline_allowed;
624 case LT_ALIGNPOSSIBLE:
625 readAlignPossible(lex);
629 // FIXME: this means LT_LABELSTRING_APPENDIX may only
630 // occur after LT_LABELSTRING
632 labelstring_appendix_ = labelstring_;
635 case LT_ENDLABELSTRING:
636 lex >> endlabelstring_;
639 case LT_LABELSTRING_APPENDIX:
640 lex >> labelstring_appendix_;
643 case LT_LABELCOUNTER:
651 case LT_FREE_SPACING:
659 case LT_PASS_THRU_CHARS:
660 lex >> pass_thru_chars;
663 case LT_PARBREAK_IS_NEWLINE:
664 lex >> parbreak_is_newline;
673 vector<string> const req =
674 getVectorFromString(lex.getString(true));
675 required_.insert(req.begin(), req.end());
680 docstring autonest = lex.getLongString(from_ascii("EndAutoNests"));
681 autonest = subst(autonest, from_ascii("\n"), docstring());
682 autonest = subst(autonest, from_ascii("\t"), docstring());
683 autonest = subst(autonest, from_ascii("\""), docstring());
684 autonest = subst(autonest, '_', ' ');
685 vector<docstring> const autonests =
686 getVectorFromString(autonest, from_ascii(","), false, true);
687 autonests_.insert(autonests.begin(), autonests.end());
691 case LT_AUTONESTEDBY: {
692 docstring autonest = lex.getLongString(from_ascii("EndIsAutoNestedBy"));
693 autonest = subst(autonest, from_ascii("\n"), docstring());
694 autonest = subst(autonest, from_ascii("\t"), docstring());
695 autonest = subst(autonest, from_ascii("\""), docstring());
696 autonest = subst(autonest, '_', ' ');
697 vector<docstring> const autonests =
698 getVectorFromString(autonest, from_ascii(","), false, true);
699 autonested_by_.insert(autonests.begin(), autonests.end());
733 case LT_HTMLITEMATTR:
734 lex >> htmlitemattr_;
738 lex >> htmllabeltag_;
741 case LT_HTMLLABELATTR:
742 lex >> htmllabelattr_;
745 case LT_HTMLLABELFIRST:
746 lex >> htmllabelfirst_;
750 htmlstyle_ = lex.getLongString(from_ascii("EndHTMLStyle"));
753 case LT_HTMLFORCECSS:
754 lex >> htmlforcecss_;
757 case LT_HTMLPREAMBLE:
758 htmlpreamble_ = lex.getLongString(from_ascii("EndPreamble"));
773 case LT_DOCBOOKTAGTYPE:
774 lex >> docbooktagtype_;
777 case LT_DOCBOOKINNERTAG:
778 lex >> docbookinnertag_;
781 case LT_DOCBOOKINNERATTR:
782 lex >> docbookinnerattr_;
785 case LT_DOCBOOKINNERTAGTYPE:
786 lex >> docbookinnertagtype_;
789 case LT_DOCBOOKFORCEABSTRACTTAG:
790 lex >> docbookforceabstracttag_;
793 case LT_DOCBOOKININFO:
794 lex >> docbookininfo_;
797 case LT_DOCBOOKABSTRACT:
798 lex >> docbookabstract_;
801 case LT_DOCBOOKWRAPPERTAG:
802 lex >> docbookwrappertag_;
805 case LT_DOCBOOKWRAPPERATTR:
806 lex >> docbookwrapperattr_;
809 case LT_DOCBOOKWRAPPERTAGTYPE:
810 lex >> docbookwrappertagtype_;
813 case LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS:
814 lex >> docbookwrappermergewithprevious_;
817 case LT_DOCBOOKSECTION:
818 lex >> docbooksection_;
821 case LT_DOCBOOKSECTIONTAG:
822 lex >> docbooksectiontag_;
825 case LT_DOCBOOKITEMWRAPPERTAG:
826 lex >> docbookitemwrappertag_;
829 case LT_DOCBOOKITEMWRAPPERATTR:
830 lex >> docbookitemwrapperattr_;
833 case LT_DOCBOOKITEMWRAPPERTAGTYPE:
834 lex >> docbookitemwrappertagtype_;
837 case LT_DOCBOOKITEMTAG:
838 lex >> docbookitemtag_;
841 case LT_DOCBOOKITEMATTR:
842 lex >> docbookitemattr_;
845 case LT_DOCBOOKITEMTAGTYPE:
846 lex >> docbookitemtagtype_;
849 case LT_DOCBOOKITEMLABELTAG:
850 lex >> docbookitemlabeltag_;
853 case LT_DOCBOOKITEMLABELATTR:
854 lex >> docbookitemlabelattr_;
857 case LT_DOCBOOKITEMLABELTAGTYPE:
858 lex >> docbookitemlabeltagtype_;
861 case LT_DOCBOOKITEMINNERTAG:
862 lex >> docbookiteminnertag_;
865 case LT_DOCBOOKITEMINNERATTR:
866 lex >> docbookiteminnerattr_;
869 case LT_DOCBOOKITEMINNERTAGTYPE:
870 lex >> docbookiteminnertagtype_;
873 case LT_DOCBOOKNOFONTINSIDE:
874 lex >> docbooknofontinside_;
877 case LT_DOCBOOKGENERATETITLE:
878 lex >> docbookgeneratetitle_;
891 add_to_toc_ = !toc_type_.empty();
894 case LT_ISTOCCAPTION:
895 lex >> is_toc_caption_;
901 // make sure we only have inpreamble = true for commands
902 if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
903 LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
904 LYXERR0("Layout name: " << name());
908 return finished && !error;
921 LexerKeyword alignTags[] = {
922 { "block", AT_BLOCK },
923 { "center", AT_CENTER },
924 { "layout", AT_LAYOUT },
926 { "right", AT_RIGHT }
930 void Layout::readAlign(Lexer & lex)
932 PushPopHelper pph(lex, alignTags);
935 case Lexer::LEX_UNDEF:
936 lex.printError("Unknown alignment `$$Token'");
942 align = LYX_ALIGN_BLOCK;
945 align = LYX_ALIGN_LEFT;
948 align = LYX_ALIGN_RIGHT;
951 align = LYX_ALIGN_CENTER;
954 align = LYX_ALIGN_LAYOUT;
960 void Layout::readAlignPossible(Lexer & lex)
962 lex.pushTable(alignTags);
963 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
964 int lineno = lex.lineNumber();
968 case Lexer::LEX_UNDEF:
969 lex.printError("Unknown alignment `$$Token'");
975 alignpossible |= LYX_ALIGN_BLOCK;
978 alignpossible |= LYX_ALIGN_LEFT;
981 alignpossible |= LYX_ALIGN_RIGHT;
984 alignpossible |= LYX_ALIGN_CENTER;
987 alignpossible |= LYX_ALIGN_LAYOUT;
990 } while (lineno == lex.lineNumber());
995 void Layout::readLabelType(Lexer & lex)
1010 LexerKeyword labelTypeTags[] = {
1011 { "above", LA_ABOVE },
1012 { "bibliography", LA_BIBLIO },
1013 { "centered", LA_CENTERED },
1014 { "enumerate", LA_ENUMERATE },
1015 { "itemize", LA_ITEMIZE },
1016 { "manual", LA_MANUAL },
1017 { "no_label", LA_NO_LABEL },
1018 { "sensitive", LA_SENSITIVE },
1019 { "static", LA_STATIC }
1022 PushPopHelper pph(lex, labelTypeTags);
1025 case Lexer::LEX_UNDEF:
1026 lex.printError("Unknown labeltype tag `$$Token'");
1032 labeltype = LABEL_NO_LABEL;
1035 labeltype = LABEL_MANUAL;
1038 labeltype = LABEL_ABOVE;
1041 labeltype = LABEL_CENTERED;
1044 labeltype = LABEL_STATIC;
1047 labeltype = LABEL_SENSITIVE;
1050 labeltype = LABEL_ENUMERATE;
1053 labeltype = LABEL_ITEMIZE;
1056 labeltype = LABEL_BIBLIO;
1062 void Layout::readEndLabelType(Lexer & lex)
1064 // this should be const, but can't be because
1065 // of PushPopHelper.
1066 static LexerKeyword endlabelTypeTags[] = {
1067 { "box", END_LABEL_BOX },
1068 { "filled_box", END_LABEL_FILLED_BOX },
1069 { "no_label", END_LABEL_NO_LABEL },
1070 { "static", END_LABEL_STATIC }
1073 PushPopHelper pph(lex, endlabelTypeTags);
1076 case Lexer::LEX_UNDEF:
1077 lex.printError("Unknown labeltype tag `$$Token'");
1079 case END_LABEL_STATIC:
1081 case END_LABEL_FILLED_BOX:
1082 case END_LABEL_NO_LABEL:
1083 endlabeltype = static_cast<EndLabelType>(le);
1086 LYXERR0("Unhandled value " << le);
1092 void Layout::readMargin(Lexer & lex)
1094 LexerKeyword marginTags[] = {
1095 { "dynamic", MARGIN_DYNAMIC },
1096 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
1097 { "manual", MARGIN_MANUAL },
1098 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
1099 { "static", MARGIN_STATIC }
1102 PushPopHelper pph(lex, marginTags);
1106 case Lexer::LEX_UNDEF:
1107 lex.printError("Unknown margin type tag `$$Token'");
1111 case MARGIN_DYNAMIC:
1112 case MARGIN_FIRST_DYNAMIC:
1113 case MARGIN_RIGHT_ADDRESS_BOX:
1114 margintype = static_cast<MarginType>(le);
1117 LYXERR0("Unhandled value " << le);
1123 void Layout::readLatexType(Lexer & lex)
1125 LexerKeyword latexTypeTags[] = {
1126 { "bib_environment", LATEX_BIB_ENVIRONMENT },
1127 { "command", LATEX_COMMAND },
1128 { "environment", LATEX_ENVIRONMENT },
1129 { "item_environment", LATEX_ITEM_ENVIRONMENT },
1130 { "list_environment", LATEX_LIST_ENVIRONMENT },
1131 { "paragraph", LATEX_PARAGRAPH }
1134 PushPopHelper pph(lex, latexTypeTags);
1137 case Lexer::LEX_UNDEF:
1138 lex.printError("Unknown latextype tag `$$Token'");
1140 case LATEX_PARAGRAPH:
1142 case LATEX_ITEM_ENVIRONMENT:
1143 case LATEX_LIST_ENVIRONMENT:
1144 latextype = static_cast<LatexType>(le);
1146 case LATEX_ENVIRONMENT:
1147 case LATEX_BIB_ENVIRONMENT:
1148 latextype = static_cast<LatexType>(le);
1152 LYXERR0("Unhandled value " << le);
1158 void Layout::readSpacing(Lexer & lex)
1161 ST_SPACING_SINGLE = 1,
1167 LexerKeyword spacingTags[] = {
1168 {"double", ST_SPACING_DOUBLE },
1169 {"onehalf", ST_SPACING_ONEHALF },
1170 {"other", ST_OTHER },
1171 {"single", ST_SPACING_SINGLE }
1174 PushPopHelper pph(lex, spacingTags);
1177 case Lexer::LEX_UNDEF:
1178 lex.printError("Unknown spacing token `$$Token'");
1183 case ST_SPACING_SINGLE:
1184 spacing.set(Spacing::Single);
1186 case ST_SPACING_ONEHALF:
1187 spacing.set(Spacing::Onehalf);
1189 case ST_SPACING_DOUBLE:
1190 spacing.set(Spacing::Double);
1194 spacing.set(Spacing::Other, lex.getString());
1200 void Layout::readArgument(Lexer & lex, bool validating)
1203 LYXERR0("Unable to read argument ID!");
1206 string const id = lex.getString();
1208 bool const itemarg = prefixIs(id, "item:");
1209 bool const postcmd = prefixIs(id, "post:");
1210 bool const listpreamble = prefixIs(id, "listpreamble:");
1212 LaTeXArgMap & lam = itemarg ? itemargs_ :
1213 (postcmd ? postcommandargs_ :
1214 (listpreamble ? listpreamble_ :
1216 latexarg & arg = lam[id];
1219 // list preamble has no delimiters by default
1220 arg.nodelims = true;
1223 bool finished = false;
1224 while (!finished && lex.isOK() && !error) {
1226 string const tok = ascii_lowercase(lex.getString());
1230 } else if (tok == "endargument") {
1232 } else if (tok == "labelstring") {
1234 arg.labelstring = lex.getDocString();
1235 } else if (tok == "menustring") {
1237 arg.menustring = lex.getDocString();
1238 } else if (tok == "mandatory") {
1240 arg.mandatory = lex.getBool();
1241 } else if (tok == "autoinsert") {
1243 arg.autoinsert = lex.getBool();
1244 } else if (tok == "insertcotext") {
1246 arg.insertcotext = lex.getBool();
1247 } else if (tok == "leftdelim") {
1249 arg.ldelim = lex.getDocString();
1250 arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
1252 } else if (tok == "rightdelim") {
1254 arg.rdelim = lex.getDocString();
1255 arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
1257 } else if (tok == "defaultarg") {
1259 arg.defaultarg = lex.getDocString();
1260 } else if (tok == "presetarg") {
1262 arg.presetarg = lex.getDocString();
1263 } else if (tok == "tooltip") {
1265 arg.tooltip = lex.getDocString();
1266 } else if (tok == "requires") {
1268 arg.required = lex.getString();
1269 } else if (tok == "decoration") {
1271 arg.decoration = lex.getString();
1272 } else if (tok == "newlinecmd") {
1274 arg.newlinecmd = lex.getString();
1275 } else if (tok == "font") {
1276 arg.font = lyxRead(lex, arg.font);
1277 } else if (tok == "labelfont") {
1278 arg.labelfont = lyxRead(lex, arg.labelfont);
1279 } else if (tok == "passthruchars") {
1281 arg.pass_thru_chars = lex.getDocString();
1282 } else if (tok == "passthru") {
1284 docstring value = lex.getDocString();
1285 if (value == "true" || value == "1")
1286 arg.passthru = PT_TRUE;
1287 else if (value == "false" || value == "0")
1288 arg.passthru = PT_FALSE;
1290 arg.passthru = PT_INHERITED;
1291 } else if (tok == "istoccaption") {
1293 arg.is_toc_caption = lex.getBool();
1294 } else if (tok == "freespacing") {
1296 arg.free_spacing = lex.getBool();
1297 } else if (tok == "docbooktag") {
1299 arg.docbooktag = lex.getDocString();
1300 } else if (tok == "docbookattr") {
1302 arg.docbookattr = lex.getDocString();
1303 } else if (tok == "docbooktagtype") {
1305 arg.docbooktagtype = lex.getDocString();
1306 } else if (tok == "docbookargumentaftermaintag") {
1308 arg.docbookargumentaftermaintag = lex.getBool();
1309 } else if (tok == "docbookargumentbeforemaintag") {
1311 arg.docbookargumentbeforemaintag = lex.getBool();
1313 lex.printError("Unknown tag");
1317 if (!validating && arg.labelstring.empty()) {
1318 LYXERR0("Incomplete Argument definition!");
1319 // remove invalid definition
1325 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1327 os << "\tArgument " << id << '\n';
1328 if (!arg.labelstring.empty())
1329 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1330 if (!arg.menustring.empty())
1331 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1333 os << "\t\tMandatory " << arg.mandatory << '\n';
1335 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1336 if (arg.insertcotext)
1337 os << "\t\tInsertCotext " << arg.insertcotext << '\n';
1338 if (!arg.ldelim.empty())
1339 os << "\t\tLeftDelim \""
1340 << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1342 if (!arg.rdelim.empty())
1343 os << "\t\tRightDelim \""
1344 << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1346 if (!arg.defaultarg.empty())
1347 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1348 if (!arg.presetarg.empty())
1349 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1350 if (!arg.tooltip.empty())
1351 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1352 if (!arg.required.empty())
1353 os << "\t\tRequires \"" << arg.required << "\"\n";
1354 if (!arg.decoration.empty())
1355 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1356 if (!arg.newlinecmd.empty())
1357 os << "\t\tNewlineCmd \"" << arg.newlinecmd << "\"\n";
1358 if (arg.font != inherit_font)
1359 lyxWrite(os, arg.font, "Font", 2);
1360 if (arg.labelfont != inherit_font)
1361 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1362 switch (arg.passthru) {
1364 os << "\t\tPassThru true\n";
1367 os << "\t\tPassThru false\n";
1370 os << "\t\tPassThru inherited\n";
1373 if (!arg.pass_thru_chars.empty())
1374 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1375 if (arg.free_spacing)
1376 os << "\t\tFreeSpacing " << arg.free_spacing << "\n";
1377 os << "\tEndArgument\n";
1381 void Layout::write(ostream & os) const
1383 os << "Style \"" << to_utf8(name_) << "\"\n";
1384 if (!category_.empty() && obsoleted_by_.empty())
1385 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1386 // Can't deduce Copystyle here :-(
1387 if (!obsoleted_by_.empty()) {
1388 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1392 if (!depends_on_.empty())
1393 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1394 switch (margintype) {
1395 case MARGIN_DYNAMIC:
1396 os << "\tMargin Dynamic\n";
1398 case MARGIN_FIRST_DYNAMIC:
1399 os << "\tMargin First_Dynamic\n";
1402 os << "\tMargin Manual\n";
1404 case MARGIN_RIGHT_ADDRESS_BOX:
1405 os << "\tMargin Right_Address_Box\n";
1408 os << "\tMargin Static\n";
1411 switch (latextype) {
1412 case LATEX_BIB_ENVIRONMENT:
1413 os << "\tLatexType Bib_Environment\n";
1416 os << "\tLatexType Command\n";
1418 case LATEX_ENVIRONMENT:
1419 os << "\tLatexType Environment\n";
1421 case LATEX_ITEM_ENVIRONMENT:
1422 os << "\tLatexType Item_Environment\n";
1424 case LATEX_LIST_ENVIRONMENT:
1425 os << "\tLatexType List_Environment\n";
1427 case LATEX_PARAGRAPH:
1428 os << "\tLatexType Paragraph\n";
1431 os << "\tInTitle " << intitle << "\n"
1432 "\tInPreamble " << inpreamble << "\n"
1433 "\tTocLevel " << toclevel << "\n"
1434 "\tResumeCounter " << resumecounter << "\n"
1435 "\tStepParentCounter " << stepparentcounter << '\n';
1436 // ResetArgs does not make sense here
1437 for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1438 it != latexargs_.end(); ++it)
1439 writeArgument(os, it->first, it->second);
1440 for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1441 it != itemargs_.end(); ++it)
1442 writeArgument(os, it->first, it->second);
1443 for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1444 it != postcommandargs_.end(); ++it)
1445 writeArgument(os, it->first, it->second);
1446 for (LaTeXArgMap::const_iterator it = listpreamble_.begin();
1447 it != listpreamble_.end(); ++it)
1448 writeArgument(os, it->first, it->second);
1449 os << "\tNeedProtect " << needprotect << "\n"
1450 "\tNeedCProtect " << needcprotect << "\n"
1451 "\tNeedMBoxProtect " << needmboxprotect << "\n"
1452 "\tKeepEmpty " << keepempty << '\n';
1453 if (labelfont == font)
1454 lyxWrite(os, font, "Font", 1);
1456 lyxWrite(os, font, "TextFont", 1);
1457 lyxWrite(os, labelfont, "LabelFont", 1);
1459 os << "\tNextNoIndent " << nextnoindent << "\n"
1460 "\tCommandDepth " << commanddepth << '\n';
1461 if (!latexname_.empty())
1462 os << "\tLatexName \"" << latexname_ << "\"\n";
1463 if (!latexparam_.empty())
1464 os << "\tLatexParam \"" << subst(latexparam_, "\"", """)
1466 if (!leftdelim_.empty())
1467 os << "\tLeftDelim "
1468 << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1470 if (!rightdelim_.empty())
1471 os << "\tRightDelim "
1472 << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1474 if (!innertag_.empty())
1475 os << "\tInnerTag \"" << innertag_ << "\"\n";
1476 if (!labeltag_.empty())
1477 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1478 if (!itemtag_.empty())
1479 os << "\tItemTag \"" << itemtag_ << "\"\n";
1480 if (!itemcommand_.empty())
1481 os << "\tItemCommand " << itemcommand_ << '\n';
1482 if (!preamble_.empty())
1483 os << "\tPreamble\n\t"
1484 << to_utf8(subst(rtrim(preamble_, "\n"),
1485 from_ascii("\n"), from_ascii("\n\t")))
1486 << "\n\tEndPreamble\n";
1487 if (!langpreamble_.empty())
1488 os << "\tLangPreamble\n\t"
1489 << to_utf8(subst(rtrim(langpreamble_, "\n"),
1490 from_ascii("\n"), from_ascii("\n\t")))
1491 << "\n\tEndLangPreamble\n";
1492 if (!babelpreamble_.empty())
1493 os << "\tBabelPreamble\n\t"
1494 << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1495 from_ascii("\n"), from_ascii("\n\t")))
1496 << "\n\tEndBabelPreamble\n";
1497 switch (labeltype) {
1499 os << "\tLabelType Above\n";
1502 os << "\tLabelType Bibliography\n";
1504 case LABEL_CENTERED:
1505 os << "\tLabelType Centered\n";
1507 case LABEL_ENUMERATE:
1508 os << "\tLabelType Enumerate\n";
1511 os << "\tLabelType Itemize\n";
1514 os << "\tLabelType Manual\n";
1516 case LABEL_NO_LABEL:
1517 os << "\tLabelType No_Label\n";
1519 case LABEL_SENSITIVE:
1520 os << "\tLabelType Sensitive\n";
1523 os << "\tLabelType Static\n";
1526 switch (endlabeltype) {
1528 os << "\tEndLabelType Box\n";
1530 case END_LABEL_FILLED_BOX:
1531 os << "\tEndLabelType Filled_Box\n";
1533 case END_LABEL_NO_LABEL:
1534 os << "\tEndLabelType No_Label\n";
1536 case END_LABEL_STATIC:
1537 os << "\tEndLabelType Static\n";
1540 os << "\tParagraphGroup \"" << par_group_ << "\"\n";
1541 if (!leftmargin.empty())
1542 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1543 if (!rightmargin.empty())
1544 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1545 if (!labelindent.empty())
1546 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1547 if (!parindent.empty())
1548 os << "\tParIndent " << to_utf8(parindent) << '\n';
1549 os << "\tParSkip " << parskip << "\n"
1550 "\tItemSep " << itemsep << "\n"
1551 "\tTopSep " << topsep << "\n"
1552 "\tBottomSep " << bottomsep << "\n"
1553 "\tLabelBottomSep " << labelbottomsep << '\n';
1554 if (!labelsep.empty())
1555 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1557 os << "\tParSep " << parsep << "\n"
1558 "\tNewLine " << newline_allowed << '\n';
1560 case LYX_ALIGN_BLOCK:
1561 os << "\tAlign Block\n";
1563 case LYX_ALIGN_CENTER:
1564 os << "\tAlign Center\n";
1566 case LYX_ALIGN_LAYOUT:
1567 os << "\tAlign Layout\n";
1569 case LYX_ALIGN_LEFT:
1570 os << "\tAlign Left\n";
1572 case LYX_ALIGN_RIGHT:
1573 os << "\tAlign Right\n";
1575 case LYX_ALIGN_DECIMAL:
1576 case LYX_ALIGN_SPECIAL:
1577 case LYX_ALIGN_NONE:
1580 if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1581 LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1583 os << "\tAlignPossible";
1584 if (alignpossible & LYX_ALIGN_BLOCK) {
1588 if (alignpossible & LYX_ALIGN_CENTER) {
1594 if (alignpossible & LYX_ALIGN_LAYOUT) {
1600 if (alignpossible & LYX_ALIGN_LEFT) {
1606 if (alignpossible & LYX_ALIGN_RIGHT) {
1614 // LabelString must come before LabelStringAppendix
1615 if (!labelstring_.empty())
1616 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1617 if (!endlabelstring_.empty())
1618 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1619 if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1620 os << "\tLabelStringAppendix \""
1621 << to_utf8(labelstring_appendix_) << "\"\n";
1622 if (!counter.empty())
1623 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1624 os << "\tFreeSpacing " << free_spacing << '\n';
1625 os << "\tPassThru " << pass_thru << '\n';
1626 if (!pass_thru_chars.empty())
1627 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1628 os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1629 switch (spacing.getSpace()) {
1630 case Spacing::Double:
1631 os << "\tSpacing Double\n";
1633 case Spacing::Onehalf:
1634 os << "\tSpacing Onehalf\n";
1636 case Spacing::Other:
1637 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1639 case Spacing::Single:
1640 os << "\tSpacing Single\n";
1642 case Spacing::Default:
1645 if (!required_.empty()) {
1646 os << "\tRequires ";
1647 for (set<string>::const_iterator it = required_.begin();
1648 it != required_.end(); ++it) {
1649 if (it != required_.begin())
1655 if (!autonests_.empty()) {
1656 os << "\tAutoNests\n\t";
1657 for (set<docstring>::const_iterator it = autonests_.begin();
1658 it != autonests_.end(); ++it) {
1659 if (it != autonests_.begin())
1663 os << "\n\tEndAutoNests\n";
1665 if (!autonested_by_.empty()) {
1666 os << "\tIsAutoNestedBy\n\t\t";
1667 for (set<docstring>::const_iterator it = autonested_by_.begin();
1668 it != autonested_by_.end(); ++it) {
1669 if (it != autonested_by_.begin())
1673 os << "\n\tEndIsAutoNestedBy\n";
1675 if (refprefix.empty())
1676 os << "\tRefPrefix OFF\n";
1678 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1679 if (!htmltag_.empty())
1680 os << "\tHTMLTag " << htmltag_ << '\n';
1681 if (!htmlattr_.empty())
1682 os << "\tHTMLAttr " << htmlattr_ << '\n';
1683 if (!htmlclass_.empty())
1684 os << "\tHTMLClass " << htmlclass_ << '\n';
1686 os << "\tHTMLInToc " << htmlintoc_ << '\n';
1687 if (!htmlitemtag_.empty())
1688 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1689 if (!htmlitemattr_.empty())
1690 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1691 if (!htmllabeltag_.empty())
1692 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1693 if (!htmllabelattr_.empty())
1694 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1695 os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1696 if (!htmlstyle_.empty())
1697 os << "\tHTMLStyle\n"
1698 << to_utf8(rtrim(htmlstyle_, "\n"))
1699 << "\n\tEndHTMLStyle\n";
1700 os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1701 if (!htmlpreamble_.empty())
1702 os << "\tHTMLPreamble\n"
1703 << to_utf8(rtrim(htmlpreamble_, "\n"))
1704 << "\n\tEndPreamble\n";
1705 os << "\tHTMLTitle " << htmltitle_ << "\n";
1706 if (!docbooktag_.empty())
1707 os << "\tDocBookTag " << docbooktag_ << '\n';
1708 if (!docbookattr_.empty())
1709 os << "\tDocBookAttr \"" << docbookattr_ << "\"\n";
1710 if (!docbooktagtype_.empty())
1711 os << "\tDocBookTagType " << docbooktagtype_ << '\n';
1712 if (!docbookinnertag_.empty())
1713 os << "\tDocBookInnerTag " << docbookinnertag_ << '\n';
1714 if (!docbookinnerattr_.empty())
1715 os << "\tDocBookInnerAttr \"" << docbookinnerattr_ << "\"\n";
1716 if (!docbookinnertagtype_.empty())
1717 os << "\tDocBookInnerTagType " << docbookinnertagtype_ << '\n';
1718 if (!docbookininfo_.empty())
1719 os << "\tDocBookInInfo " << docbookininfo_ << '\n';
1720 os << "\tDocBookAbstract " << docbookabstract_ << '\n';
1721 if (!docbookwrappertag_.empty())
1722 os << "\tDocBookWrapperTag " << docbookwrappertag_ << '\n';
1723 if (!docbookwrapperattr_.empty())
1724 os << "\tDocBookWrapperAttr " << docbookwrapperattr_ << '\n';
1725 if (!docbookwrappertagtype_.empty())
1726 os << "\tDocBookWrapperTagType " << docbookwrappertagtype_ << '\n';
1727 os << "\tDocBookSection " << docbooksection_ << '\n';
1728 if (!docbooksectiontag_.empty())
1729 os << "\tDocBookSectionTag " << docbooksectiontag_ << '\n';
1730 if (!docbookitemtag_.empty())
1731 os << "\tDocBookItemTag " << docbookitemtag_ << '\n';
1732 if (!docbookitemattr_.empty())
1733 os << "\tDocBookItemAttr " << docbookitemattr_ << '\n';
1734 if (!docbookitemtagtype_.empty())
1735 os << "\tDocBookItemTagType " << docbookitemtagtype_ << '\n';
1736 if (!docbookitemwrappertag_.empty())
1737 os << "\tDocBookItemWrapperTag " << docbookitemwrappertag_ << '\n';
1738 if (!docbookitemwrapperattr_.empty())
1739 os << "\tDocBookItemWrapperAttr " << docbookitemwrapperattr_ << '\n';
1740 if (!docbookitemwrappertagtype_.empty())
1741 os << "\tDocBookItemWrapperTagType " << docbookitemwrappertagtype_ << '\n';
1742 os << "\tDocBookWrapperMergeWithPrevious " << docbookwrappermergewithprevious_ << '\n';
1743 if (!docbookitemlabeltag_.empty())
1744 os << "\tDocBookItemLabelTag " << docbookitemlabeltag_ << '\n';
1745 if (!docbookitemlabelattr_.empty())
1746 os << "\tDocBookItemLabelAttr " << docbookitemlabelattr_ << '\n';
1747 if (!docbookitemlabeltagtype_.empty())
1748 os << "\tDocBookItemLabelTagType " << docbookitemlabeltagtype_ << '\n';
1749 if (!docbookiteminnertag_.empty())
1750 os << "\tDocBookItemInnerTag " << docbookiteminnertag_ << '\n';
1751 if (!docbookiteminnerattr_.empty())
1752 os << "\tDocBookItemInnerAttr " << docbookiteminnerattr_ << '\n';
1753 if (!docbookiteminnertagtype_.empty())
1754 os << "\tDocBookItemInnerTagType " << docbookiteminnertagtype_ << '\n';
1755 if (!docbookforceabstracttag_.empty())
1756 os << "\tDocBookForceAbstractTag " << docbookforceabstracttag_ << '\n';
1757 os << "\tDocBookNoFontInside " << docbooknofontinside_ << "\n"
1758 "\tSpellcheck " << spellcheck << "\n"
1759 "\tForceLocal " << forcelocal << "\n"
1764 bool Layout::hasArgs() const
1766 return !latexargs_.empty() || !postcommandargs_.empty() ||
1767 !itemargs_.empty() || !listpreamble_.empty();
1771 Layout::LaTeXArgMap Layout::args() const
1773 LaTeXArgMap args = latexargs_;
1774 if (!postcommandargs_.empty())
1775 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1776 if (!listpreamble_.empty())
1777 args.insert(listpreamble_.begin(), listpreamble_.end());
1778 if (!itemargs_.empty())
1779 args.insert(itemargs_.begin(), itemargs_.end());
1784 int Layout::optArgs() const
1787 LaTeXArgMap::const_iterator it = latexargs_.begin();
1788 for (; it != latexargs_.end(); ++it) {
1789 if (!(*it).second.mandatory)
1792 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1793 for (; iit != postcommandargs_.end(); ++iit) {
1794 if (!(*iit).second.mandatory)
1801 int Layout::requiredArgs() const
1804 LaTeXArgMap::const_iterator it = latexargs_.begin();
1805 for (; it != latexargs_.end(); ++it) {
1806 if ((*it).second.mandatory)
1809 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1810 for (; iit != postcommandargs_.end(); ++iit) {
1811 if (!(*iit).second.mandatory)
1818 string const & Layout::htmltag() const
1820 if (htmltag_.empty())
1826 string const & Layout::htmlclass() const
1828 // If it's an enumeration or itemize list, then we recalculate the class each
1829 // time through (unless it has been given explicitly). So we do nothing here.
1830 if (htmlclass_.empty() && labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
1831 htmlclass_ = defaultCSSClass();
1836 string const & Layout::htmlGetAttrString() const {
1837 if (!htmlfullattrs_.empty())
1838 return htmlfullattrs_;
1839 htmlfullattrs_ = htmlclass();
1840 if (!htmlfullattrs_.empty())
1841 htmlfullattrs_ = "class='" + htmlfullattrs_ + "'";
1842 if (!htmlattr_.empty())
1843 htmlfullattrs_ += " " + htmlattr_;
1844 return htmlfullattrs_;
1848 string const & Layout::htmlitemtag() const
1850 if (htmlitemtag_.empty())
1851 htmlitemtag_ = "div";
1852 return htmlitemtag_;
1856 string const & Layout::htmlitemattr() const
1858 if (htmlitemattr_.empty())
1859 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1860 return htmlitemattr_;
1864 string const & Layout::htmllabeltag() const
1866 if (htmllabeltag_.empty())
1867 htmllabeltag_ = "span";
1868 return htmllabeltag_;
1872 string const & Layout::htmllabelattr() const
1874 if (htmllabelattr_.empty())
1875 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1876 return htmllabelattr_;
1880 docstring Layout::htmlstyle() const
1882 if (!htmlstyle_.empty() && !htmlforcecss_)
1884 if (htmldefaultstyle_.empty())
1886 docstring retval = htmldefaultstyle_;
1887 if (!htmlstyle_.empty())
1888 retval += '\n' + htmlstyle_;
1893 string Layout::defaultCSSClass() const
1895 if (!defaultcssclass_.empty())
1896 return defaultcssclass_;
1898 docstring::const_iterator it = name().begin();
1899 docstring::const_iterator en = name().end();
1900 for (; it != en; ++it) {
1901 char_type const c = *it;
1902 if (!isAlphaASCII(c)) {
1904 // make sure we don't start with an underscore,
1905 // as that sometimes causes problems.
1906 d = from_ascii("lyx_");
1909 } else if (isLower(c))
1912 // this is slow, so do it only if necessary
1915 defaultcssclass_ = to_utf8(d);
1916 return defaultcssclass_;
1920 string const & Layout::docbooktag() const
1922 if (docbooktag_.empty()) {
1923 if (to_ascii(name_) == "Plain Layout")
1924 docbooktag_ = "para";
1925 else // No sensible default value, unhappily...
1926 docbooktag_ = to_utf8(name_);
1932 string const & Layout::docbookattr() const
1934 // Perfectly OK to return no attributes, so docbookattr_ does not need to be filled.
1935 return docbookattr_;
1939 bool isValidTagType(std::string const & type)
1941 return !(type.empty() || (type != "block" && type != "paragraph" && type != "inline"));
1945 string const & Layout::docbooktagtype() const
1947 if (!isValidTagType(docbooktagtype_))
1948 docbooktagtype_ = "block";
1949 return docbooktagtype_;
1953 string const & Layout::docbookinnertag() const
1955 if (docbookinnertag_.empty())
1956 docbookinnertag_ = "NONE";
1957 return docbookinnertag_;
1961 string const & Layout::docbookinnerattr() const
1963 return docbookinnerattr_;
1967 string const & Layout::docbookinnertagtype() const
1969 if (!isValidTagType(docbookinnertagtype_))
1970 docbookinnertagtype_ = "block";
1971 return docbookinnertagtype_;
1975 string const & Layout::docbookininfo() const
1977 // Indeed, a trilean. Only titles should be "maybe": otherwise, metadata is "always", content is "never".
1978 if (docbookininfo_.empty() || (docbookininfo_ != "never" && docbookininfo_ != "always" && docbookininfo_ != "maybe"))
1979 docbookininfo_ = "never";
1980 return docbookininfo_;
1984 string const & Layout::docbookwrappertag() const
1986 if (docbookwrappertag_.empty())
1987 docbookwrappertag_ = "NONE";
1988 return docbookwrappertag_;
1992 string const & Layout::docbookwrapperattr() const
1994 return docbookwrapperattr_;
1998 string const & Layout::docbookwrappertagtype() const
2000 if (!isValidTagType(docbookwrappertagtype_))
2001 docbookwrappertagtype_ = "block";
2002 return docbookwrappertagtype_;
2006 string const & Layout::docbooksectiontag() const
2008 if (docbooksectiontag_.empty())
2009 docbooksectiontag_ = "section";
2010 return docbooksectiontag_;
2014 string const & Layout::docbookitemwrappertag() const
2016 if (docbookitemwrappertag_.empty())
2017 docbookitemwrappertag_ = "NONE";
2018 return docbookitemwrappertag_;
2022 string const & Layout::docbookitemwrapperattr() const
2024 return docbookitemwrapperattr_;
2028 string const & Layout::docbookitemwrappertagtype() const
2030 if (!isValidTagType(docbookitemwrappertagtype_))
2031 docbookitemwrappertagtype_ = "block";
2032 return docbookitemwrappertagtype_;
2036 string const & Layout::docbookitemtag() const
2038 if (docbookitemtag_.empty())
2039 docbookitemtag_ = "NONE";
2040 return docbookitemtag_;
2044 string const & Layout::docbookitemattr() const
2046 return docbookitemattr_;
2050 string const & Layout::docbookitemtagtype() const
2052 if (!isValidTagType(docbookitemtagtype_))
2053 docbookitemtagtype_ = "block";
2054 return docbookitemtagtype_;
2058 string const & Layout::docbookitemlabeltag() const
2060 if (docbookitemlabeltag_.empty())
2061 docbookitemlabeltag_ = "NONE";
2062 return docbookitemlabeltag_;
2066 string const & Layout::docbookitemlabelattr() const
2068 return docbookitemlabelattr_;
2072 string const & Layout::docbookitemlabeltagtype() const
2074 if (!isValidTagType(docbookitemlabeltagtype_))
2075 docbookitemlabeltagtype_ = "block";
2076 return docbookitemlabeltagtype_;
2080 string const & Layout::docbookiteminnertag() const
2082 if (docbookiteminnertag_.empty())
2083 docbookiteminnertag_ = "NONE";
2084 return docbookiteminnertag_;
2088 string const & Layout::docbookiteminnerattr() const
2090 return docbookiteminnerattr_;
2094 string const & Layout::docbookiteminnertagtype() const
2096 if (!isValidTagType(docbookiteminnertagtype_))
2097 docbookiteminnertagtype_ = "block";
2098 return docbookiteminnertagtype_;
2102 std::string const & Layout::docbookforceabstracttag() const
2104 if (docbookforceabstracttag_.empty())
2105 docbookforceabstracttag_ = "NONE";
2106 return docbookforceabstracttag_;
2113 string makeMarginValue(char const * side, double d)
2116 os << "margin-" << side << ": " << d << "ex;\n";
2123 void Layout::makeDefaultCSS() const
2125 // this never needs to be redone, since reloading layouts will
2126 // wipe out what we did before.
2127 if (!htmldefaultstyle_.empty())
2131 htmldefaultstyle_ = font.asCSS();
2136 tmp += makeMarginValue("top", topsep);
2138 tmp += makeMarginValue("bottom", bottomsep);
2139 if (!leftmargin.empty()) {
2140 // we can't really do what LyX does with the margin, so
2141 // we'll just figure out how many characters it is
2142 int const len = leftmargin.length();
2143 tmp += makeMarginValue("left", len);
2145 if (!rightmargin.empty()) {
2146 int const len = rightmargin.length();
2147 tmp += makeMarginValue("right", len);
2151 if (!htmldefaultstyle_.empty())
2152 htmldefaultstyle_ += from_ascii("\n");
2153 htmldefaultstyle_ += from_ascii(tmp);
2157 string where = alignmentToCSS(align);
2158 if (!where.empty()) {
2159 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
2162 // wrap up what we have, if anything
2163 if (!htmldefaultstyle_.empty())
2165 from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
2166 htmldefaultstyle_ + from_ascii("\n}\n");
2168 if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
2174 if (labelfont != font)
2175 labelCSS = labelfont.asCSS() + from_ascii("\n");
2176 if (labeltype == LABEL_CENTERED)
2177 labelCSS += from_ascii("text-align: center;\n");
2179 if (!labelCSS.empty())
2180 htmldefaultstyle_ +=
2181 from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
2182 labelCSS + from_ascii("\n}\n");
2186 bool Layout::operator==(Layout const & rhs) const
2188 // This is enough for the applications we actually make,
2189 // at least at the moment. But we could check more.
2190 return name() == rhs.name()
2191 && latexname() == rhs.latexname()
2192 && latextype == rhs.latextype;