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,
110 LT_DOCBOOKINNERTAGTYPE,
113 LT_DOCBOOKWRAPPERTAG,
114 LT_DOCBOOKWRAPPERATTR,
115 LT_DOCBOOKWRAPPERTAGTYPE,
116 LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS,
118 LT_DOCBOOKSECTIONTAG,
119 LT_DOCBOOKITEMWRAPPERTAG,
120 LT_DOCBOOKITEMWRAPPERATTR,
121 LT_DOCBOOKITEMWRAPPERTAGTYPE,
124 LT_DOCBOOKITEMTAGTYPE,
125 LT_DOCBOOKITEMLABELTAG,
126 LT_DOCBOOKITEMLABELATTR,
127 LT_DOCBOOKITEMLABELTAGTYPE,
128 LT_DOCBOOKITEMINNERTAG,
129 LT_DOCBOOKITEMINNERATTR,
130 LT_DOCBOOKITEMINNERTAGTYPE,
131 LT_DOCBOOKFORCEABSTRACTTAG,
132 LT_DOCBOOKNOFONTINSIDE,
139 LT_STEPPARENTCOUNTER,
146 LT_INTITLE // keep this last!
149 /////////////////////
152 : add_to_toc_(false), is_toc_caption_(true)
155 margintype = MARGIN_STATIC;
156 latextype = LATEX_PARAGRAPH;
157 resumecounter = false;
158 stepparentcounter = false;
162 needcprotect = false;
163 needmboxprotect = false;
166 labelfont = inherit_font;
168 reslabelfont = sane_font;
169 nextnoindent = false;
174 labelbottomsep = 0.0;
176 align = LYX_ALIGN_BLOCK;
177 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
178 labeltype = LABEL_NO_LABEL;
179 endlabeltype = END_LABEL_NO_LABEL;
180 // Should or should not. That is the question.
181 // spacing.set(Spacing::OneHalf);
182 newline_allowed = true;
183 free_spacing = false;
185 parbreak_is_newline = false;
186 toclevel = NOT_IN_TOC;
188 htmllabelfirst_ = false;
189 htmlforcecss_ = false;
192 docbookabstract_ = false;
193 docbookwrappermergewithprevious_ = false;
194 docbooksection_ = false;
197 itemcommand_ = "item";
198 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
203 bool Layout::read(Lexer & lex, TextClass const & tclass, bool validating)
205 // If this is an empty layout, or if no force local version is set,
206 // we know that we will not discard the stuff to read
208 return readIgnoreForcelocal(lex, tclass, validating);
211 bool const ret = tmp.readIgnoreForcelocal(lex, tclass, validating);
213 // - the read version is higher
214 // - both versions are infinity (arbitrary decision)
215 // - the file did not contain any local version (needed for not
216 // skipping user defined local layouts)
217 if (tmp.forcelocal <= 0 || tmp.forcelocal > forcelocal)
223 bool Layout::readIgnoreForcelocal(Lexer & lex, TextClass const & tclass,
226 // This table is sorted alphabetically [asierra 30March96]
227 LexerKeyword layoutTags[] = {
228 { "addtotoc", LT_ADDTOTOC },
229 { "align", LT_ALIGN },
230 { "alignpossible", LT_ALIGNPOSSIBLE },
231 { "argument", LT_ARGUMENT },
232 { "autonests", LT_AUTONESTS },
233 { "babelpreamble", LT_BABELPREAMBLE },
234 { "bottomsep", LT_BOTTOMSEP },
235 { "category", LT_CATEGORY },
236 { "commanddepth", LT_COMMANDDEPTH },
237 { "copystyle", LT_COPYSTYLE },
238 { "dependson", LT_DEPENDSON },
239 { "docbookabstract", LT_DOCBOOKABSTRACT },
240 { "docbookattr", LT_DOCBOOKATTR },
241 { "docbookforceabstracttag", LT_DOCBOOKFORCEABSTRACTTAG },
242 { "docbookininfo", LT_DOCBOOKININFO },
243 { "docbookinnerattr", LT_DOCBOOKINNERATTR },
244 { "docbookinnertag", LT_DOCBOOKINNERTAG },
245 { "docbookinnertagtype", LT_DOCBOOKINNERTAGTYPE },
246 { "docbookitemattr", LT_DOCBOOKITEMATTR },
247 { "docbookiteminnerattr", LT_DOCBOOKITEMINNERATTR },
248 { "docbookiteminnertag", LT_DOCBOOKITEMINNERTAG },
249 { "docbookiteminnertagtype", LT_DOCBOOKITEMINNERTAGTYPE },
250 { "docbookitemlabelattr", LT_DOCBOOKITEMLABELATTR },
251 { "docbookitemlabeltag", LT_DOCBOOKITEMLABELTAG },
252 { "docbookitemlabeltagtype", LT_DOCBOOKITEMLABELTAGTYPE },
253 { "docbookitemtag", LT_DOCBOOKITEMTAG },
254 { "docbookitemtagtype", LT_DOCBOOKITEMTAGTYPE },
255 { "docbookitemwrapperattr", LT_DOCBOOKITEMWRAPPERATTR },
256 { "docbookitemwrappertag", LT_DOCBOOKITEMWRAPPERTAG },
257 { "docbookitemwrappertagtype", LT_DOCBOOKITEMWRAPPERTAGTYPE },
258 { "docbooknofontinside", LT_DOCBOOKNOFONTINSIDE, },
259 { "docbooksection", LT_DOCBOOKSECTION },
260 { "docbooksectiontag", LT_DOCBOOKSECTIONTAG },
261 { "docbooktag", LT_DOCBOOKTAG },
262 { "docbooktagtype", LT_DOCBOOKTAGTYPE },
263 { "docbookwrapperattr", LT_DOCBOOKWRAPPERATTR },
264 { "docbookwrappermergewithprevious", LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS },
265 { "docbookwrappertag", LT_DOCBOOKWRAPPERTAG },
266 { "docbookwrappertagtype", LT_DOCBOOKWRAPPERTAGTYPE },
268 { "endlabelstring", LT_ENDLABELSTRING },
269 { "endlabeltype", LT_ENDLABELTYPE },
271 { "forcelocal", LT_FORCELOCAL },
272 { "freespacing", LT_FREE_SPACING },
273 { "htmlattr", LT_HTMLATTR },
274 { "htmlforcecss", LT_HTMLFORCECSS },
275 { "htmlintoc", LT_HTMLINTOC },
276 { "htmlitem", LT_HTMLITEM },
277 { "htmlitemattr", LT_HTMLITEMATTR },
278 { "htmllabel", LT_HTMLLABEL },
279 { "htmllabelattr", LT_HTMLLABELATTR },
280 { "htmllabelfirst", LT_HTMLLABELFIRST },
281 { "htmlpreamble", LT_HTMLPREAMBLE },
282 { "htmlstyle", LT_HTMLSTYLE },
283 { "htmltag", LT_HTMLTAG },
284 { "htmltitle", LT_HTMLTITLE },
285 { "innertag", LT_INNERTAG },
286 { "inpreamble", LT_INPREAMBLE },
287 { "intitle", LT_INTITLE },
288 { "isautonestedby", LT_AUTONESTEDBY },
289 { "istoccaption", LT_ISTOCCAPTION },
290 { "itemcommand", LT_ITEMCOMMAND },
291 { "itemsep", LT_ITEMSEP },
292 { "itemtag", LT_ITEMTAG },
293 { "keepempty", LT_KEEPEMPTY },
294 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
295 { "labelcounter", LT_LABELCOUNTER },
296 { "labelfont", LT_LABELFONT },
297 { "labelindent", LT_LABELINDENT },
298 { "labelsep", LT_LABELSEP },
299 { "labelstring", LT_LABELSTRING },
300 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
301 { "labeltag", LT_LABELTAG },
302 { "labeltype", LT_LABELTYPE },
303 { "langpreamble", LT_LANGPREAMBLE },
304 { "latexname", LT_LATEXNAME },
305 { "latexparam", LT_LATEXPARAM },
306 { "latextype", LT_LATEXTYPE },
307 { "leftdelim", LT_LEFTDELIM },
308 { "leftmargin", LT_LEFTMARGIN },
309 { "margin", LT_MARGIN },
310 { "needcprotect", LT_NEED_CPROTECT },
311 { "needmboxprotect", LT_NEED_MBOXPROTECT },
312 { "needprotect", LT_NEED_PROTECT },
313 { "newline", LT_NEWLINE },
314 { "nextnoindent", LT_NEXTNOINDENT },
315 { "obsoletedby", LT_OBSOLETEDBY },
316 { "paragraphgroup", LT_PAR_GROUP },
317 { "parbreakisnewline", LT_PARBREAK_IS_NEWLINE },
318 { "parindent", LT_PARINDENT },
319 { "parsep", LT_PARSEP },
320 { "parskip", LT_PARSKIP },
321 { "passthru", LT_PASS_THRU },
322 { "passthruchars", LT_PASS_THRU_CHARS },
323 { "preamble", LT_PREAMBLE },
324 { "refprefix", LT_REFPREFIX },
325 { "requires", LT_REQUIRES },
326 { "resetargs", LT_RESETARGS },
327 { "resumecounter", LT_RESUMECOUNTER },
328 { "rightdelim", LT_RIGHTDELIM },
329 { "rightmargin", LT_RIGHTMARGIN },
330 { "spacing", LT_SPACING },
331 { "spellcheck", LT_SPELLCHECK },
332 { "stepparentcounter", LT_STEPPARENTCOUNTER },
333 { "textfont", LT_TEXTFONT },
334 { "toclevel", LT_TOCLEVEL },
335 { "toggleindent", LT_TOGGLE_INDENT },
336 { "topsep", LT_TOPSEP }
340 bool finished = false;
341 lex.pushTable(layoutTags);
343 // parse style section
344 while (!finished && lex.isOK() && !error) {
346 // See comment in LyXRC.cpp.
348 case Lexer::LEX_FEOF:
351 case Lexer::LEX_UNDEF:
353 lex.printError("Unknown layout tag `$$Token'");
360 switch (static_cast<LayoutTags>(le)) {
372 style = subst(style, '_', ' ');
374 if (tclass.hasLayout(style)) {
375 docstring const tmpname = name_;
376 this->operator=(tclass[style]);
379 LYXERR0("Cannot copy unknown style `"
381 << "All layouts so far:");
382 DocumentClass::const_iterator lit = tclass.begin();
383 DocumentClass::const_iterator len = tclass.end();
384 for (; lit != len; ++lit)
385 LYXERR0(lit->name());
390 case LT_OBSOLETEDBY: {
393 style = subst(style, '_', ' ');
395 if (tclass.hasLayout(style)) {
396 docstring const tmpname = name_;
397 this->operator=(tclass[style]);
399 if (obsoleted_by().empty())
400 obsoleted_by_ = style;
402 LYXERR0("Cannot replace with unknown style `"
405 //lex.printError("Cannot replace with"
414 depends_on_ = subst(depends_on_, '_', ' ');
443 postcommandargs_.clear();
444 listpreamble_.clear();
448 case LT_RESUMECOUNTER:
449 lex >> resumecounter;
452 case LT_STEPPARENTCOUNTER:
453 lex >> stepparentcounter;
457 readArgument(lex, validating);
460 case LT_NEED_PROTECT:
464 case LT_NEED_CPROTECT:
468 case LT_NEED_MBOXPROTECT:
469 lex >> needmboxprotect;
477 font = lyxRead(lex, font);
482 font = lyxRead(lex, font);
486 labelfont = lyxRead(lex, labelfont);
489 case LT_NEXTNOINDENT:
493 case LT_TOGGLE_INDENT: {
496 tog = support::ascii_lowercase(tog);
498 toggle_indent = ITOGGLE_ALWAYS;
499 else if (tog == "never")
500 toggle_indent = ITOGGLE_NEVER;
502 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
506 case LT_COMMANDDEPTH:
516 latexparam_ = subst(latexparam_, """, "\"");
521 leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
527 rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
548 preamble_ = lex.getLongString(from_ascii("EndPreamble"));
551 case LT_LANGPREAMBLE:
552 langpreamble_ = lex.getLongString(from_ascii("EndLangPreamble"));
555 case LT_BABELPREAMBLE:
556 babelpreamble_ = lex.getLongString(from_ascii("EndBabelPreamble"));
563 case LT_ENDLABELTYPE:
564 readEndLabelType(lex);
599 case LT_LABEL_BOTTOMSEP:
600 lex >> labelbottomsep;
605 labelsep = subst(labelsep, 'x', ' ');
613 lex >> newline_allowed;
620 case LT_ALIGNPOSSIBLE:
621 readAlignPossible(lex);
625 // FIXME: this means LT_LABELSTRING_APPENDIX may only
626 // occur after LT_LABELSTRING
628 labelstring_appendix_ = labelstring_;
631 case LT_ENDLABELSTRING:
632 lex >> endlabelstring_;
635 case LT_LABELSTRING_APPENDIX:
636 lex >> labelstring_appendix_;
639 case LT_LABELCOUNTER:
647 case LT_FREE_SPACING:
655 case LT_PASS_THRU_CHARS:
656 lex >> pass_thru_chars;
659 case LT_PARBREAK_IS_NEWLINE:
660 lex >> parbreak_is_newline;
669 vector<string> const req =
670 getVectorFromString(lex.getString(true));
671 required_.insert(req.begin(), req.end());
676 docstring autonest = lex.getLongString(from_ascii("EndAutoNests"));
677 autonest = subst(autonest, from_ascii("\n"), docstring());
678 autonest = subst(autonest, from_ascii("\t"), docstring());
679 autonest = subst(autonest, from_ascii("\""), docstring());
680 autonest = subst(autonest, '_', ' ');
681 vector<docstring> const autonests =
682 getVectorFromString(autonest, from_ascii(","), false, true);
683 autonests_.insert(autonests.begin(), autonests.end());
687 case LT_AUTONESTEDBY: {
688 docstring autonest = lex.getLongString(from_ascii("EndIsAutoNestedBy"));
689 autonest = subst(autonest, from_ascii("\n"), docstring());
690 autonest = subst(autonest, from_ascii("\t"), docstring());
691 autonest = subst(autonest, from_ascii("\""), docstring());
692 autonest = subst(autonest, '_', ' ');
693 vector<docstring> const autonests =
694 getVectorFromString(autonest, from_ascii(","), false, true);
695 autonested_by_.insert(autonests.begin(), autonests.end());
725 case LT_HTMLITEMATTR:
726 lex >> htmlitemattr_;
730 lex >> htmllabeltag_;
733 case LT_HTMLLABELATTR:
734 lex >> htmllabelattr_;
737 case LT_HTMLLABELFIRST:
738 lex >> htmllabelfirst_;
742 htmlstyle_ = lex.getLongString(from_ascii("EndHTMLStyle"));
745 case LT_HTMLFORCECSS:
746 lex >> htmlforcecss_;
749 case LT_HTMLPREAMBLE:
750 htmlpreamble_ = lex.getLongString(from_ascii("EndPreamble"));
765 case LT_DOCBOOKTAGTYPE:
766 lex >> docbooktagtype_;
769 case LT_DOCBOOKINNERTAG:
770 lex >> docbookinnertag_;
773 case LT_DOCBOOKINNERATTR:
774 lex >> docbookinnerattr_;
777 case LT_DOCBOOKINNERTAGTYPE:
778 lex >> docbookinnertagtype_;
781 case LT_DOCBOOKFORCEABSTRACTTAG:
782 lex >> docbookforceabstracttag_;
785 case LT_DOCBOOKININFO:
786 lex >> docbookininfo_;
789 case LT_DOCBOOKABSTRACT:
790 lex >> docbookabstract_;
793 case LT_DOCBOOKWRAPPERTAG:
794 lex >> docbookwrappertag_;
797 case LT_DOCBOOKWRAPPERATTR:
798 lex >> docbookwrapperattr_;
801 case LT_DOCBOOKWRAPPERTAGTYPE:
802 lex >> docbookwrappertagtype_;
805 case LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS:
806 lex >> docbookwrappermergewithprevious_;
809 case LT_DOCBOOKSECTION:
810 lex >> docbooksection_;
813 case LT_DOCBOOKSECTIONTAG:
814 lex >> docbooksectiontag_;
817 case LT_DOCBOOKITEMWRAPPERTAG:
818 lex >> docbookitemwrappertag_;
821 case LT_DOCBOOKITEMWRAPPERATTR:
822 lex >> docbookitemwrapperattr_;
825 case LT_DOCBOOKITEMWRAPPERTAGTYPE:
826 lex >> docbookitemwrappertagtype_;
829 case LT_DOCBOOKITEMTAG:
830 lex >> docbookitemtag_;
833 case LT_DOCBOOKITEMATTR:
834 lex >> docbookitemattr_;
837 case LT_DOCBOOKITEMTAGTYPE:
838 lex >> docbookitemtagtype_;
841 case LT_DOCBOOKITEMLABELTAG:
842 lex >> docbookitemlabeltag_;
845 case LT_DOCBOOKITEMLABELATTR:
846 lex >> docbookitemlabelattr_;
849 case LT_DOCBOOKITEMLABELTAGTYPE:
850 lex >> docbookitemlabeltagtype_;
853 case LT_DOCBOOKITEMINNERTAG:
854 lex >> docbookiteminnertag_;
857 case LT_DOCBOOKITEMINNERATTR:
858 lex >> docbookiteminnerattr_;
861 case LT_DOCBOOKITEMINNERTAGTYPE:
862 lex >> docbookiteminnertagtype_;
865 case LT_DOCBOOKNOFONTINSIDE:
866 lex >> docbooknofontinside_;
879 add_to_toc_ = !toc_type_.empty();
882 case LT_ISTOCCAPTION:
883 lex >> is_toc_caption_;
889 // make sure we only have inpreamble = true for commands
890 if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
891 LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
892 LYXERR0("Layout name: " << name());
896 return finished && !error;
909 LexerKeyword alignTags[] = {
910 { "block", AT_BLOCK },
911 { "center", AT_CENTER },
912 { "layout", AT_LAYOUT },
914 { "right", AT_RIGHT }
918 void Layout::readAlign(Lexer & lex)
920 PushPopHelper pph(lex, alignTags);
923 case Lexer::LEX_UNDEF:
924 lex.printError("Unknown alignment `$$Token'");
930 align = LYX_ALIGN_BLOCK;
933 align = LYX_ALIGN_LEFT;
936 align = LYX_ALIGN_RIGHT;
939 align = LYX_ALIGN_CENTER;
942 align = LYX_ALIGN_LAYOUT;
948 void Layout::readAlignPossible(Lexer & lex)
950 lex.pushTable(alignTags);
951 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
952 int lineno = lex.lineNumber();
956 case Lexer::LEX_UNDEF:
957 lex.printError("Unknown alignment `$$Token'");
963 alignpossible |= LYX_ALIGN_BLOCK;
966 alignpossible |= LYX_ALIGN_LEFT;
969 alignpossible |= LYX_ALIGN_RIGHT;
972 alignpossible |= LYX_ALIGN_CENTER;
975 alignpossible |= LYX_ALIGN_LAYOUT;
978 } while (lineno == lex.lineNumber());
983 void Layout::readLabelType(Lexer & lex)
998 LexerKeyword labelTypeTags[] = {
999 { "above", LA_ABOVE },
1000 { "bibliography", LA_BIBLIO },
1001 { "centered", LA_CENTERED },
1002 { "enumerate", LA_ENUMERATE },
1003 { "itemize", LA_ITEMIZE },
1004 { "manual", LA_MANUAL },
1005 { "no_label", LA_NO_LABEL },
1006 { "sensitive", LA_SENSITIVE },
1007 { "static", LA_STATIC }
1010 PushPopHelper pph(lex, labelTypeTags);
1013 case Lexer::LEX_UNDEF:
1014 lex.printError("Unknown labeltype tag `$$Token'");
1020 labeltype = LABEL_NO_LABEL;
1023 labeltype = LABEL_MANUAL;
1026 labeltype = LABEL_ABOVE;
1029 labeltype = LABEL_CENTERED;
1032 labeltype = LABEL_STATIC;
1035 labeltype = LABEL_SENSITIVE;
1038 labeltype = LABEL_ENUMERATE;
1041 labeltype = LABEL_ITEMIZE;
1044 labeltype = LABEL_BIBLIO;
1050 void Layout::readEndLabelType(Lexer & lex)
1052 // this should be const, but can't be because
1053 // of PushPopHelper.
1054 static LexerKeyword endlabelTypeTags[] = {
1055 { "box", END_LABEL_BOX },
1056 { "filled_box", END_LABEL_FILLED_BOX },
1057 { "no_label", END_LABEL_NO_LABEL },
1058 { "static", END_LABEL_STATIC }
1061 PushPopHelper pph(lex, endlabelTypeTags);
1064 case Lexer::LEX_UNDEF:
1065 lex.printError("Unknown labeltype tag `$$Token'");
1067 case END_LABEL_STATIC:
1069 case END_LABEL_FILLED_BOX:
1070 case END_LABEL_NO_LABEL:
1071 endlabeltype = static_cast<EndLabelType>(le);
1074 LYXERR0("Unhandled value " << le);
1080 void Layout::readMargin(Lexer & lex)
1082 LexerKeyword marginTags[] = {
1083 { "dynamic", MARGIN_DYNAMIC },
1084 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
1085 { "manual", MARGIN_MANUAL },
1086 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
1087 { "static", MARGIN_STATIC }
1090 PushPopHelper pph(lex, marginTags);
1094 case Lexer::LEX_UNDEF:
1095 lex.printError("Unknown margin type tag `$$Token'");
1099 case MARGIN_DYNAMIC:
1100 case MARGIN_FIRST_DYNAMIC:
1101 case MARGIN_RIGHT_ADDRESS_BOX:
1102 margintype = static_cast<MarginType>(le);
1105 LYXERR0("Unhandled value " << le);
1111 void Layout::readLatexType(Lexer & lex)
1113 LexerKeyword latexTypeTags[] = {
1114 { "bib_environment", LATEX_BIB_ENVIRONMENT },
1115 { "command", LATEX_COMMAND },
1116 { "environment", LATEX_ENVIRONMENT },
1117 { "item_environment", LATEX_ITEM_ENVIRONMENT },
1118 { "list_environment", LATEX_LIST_ENVIRONMENT },
1119 { "paragraph", LATEX_PARAGRAPH }
1122 PushPopHelper pph(lex, latexTypeTags);
1125 case Lexer::LEX_UNDEF:
1126 lex.printError("Unknown latextype tag `$$Token'");
1128 case LATEX_PARAGRAPH:
1130 case LATEX_ITEM_ENVIRONMENT:
1131 case LATEX_LIST_ENVIRONMENT:
1132 latextype = static_cast<LatexType>(le);
1134 case LATEX_ENVIRONMENT:
1135 case LATEX_BIB_ENVIRONMENT:
1136 latextype = static_cast<LatexType>(le);
1140 LYXERR0("Unhandled value " << le);
1146 void Layout::readSpacing(Lexer & lex)
1149 ST_SPACING_SINGLE = 1,
1155 LexerKeyword spacingTags[] = {
1156 {"double", ST_SPACING_DOUBLE },
1157 {"onehalf", ST_SPACING_ONEHALF },
1158 {"other", ST_OTHER },
1159 {"single", ST_SPACING_SINGLE }
1162 PushPopHelper pph(lex, spacingTags);
1165 case Lexer::LEX_UNDEF:
1166 lex.printError("Unknown spacing token `$$Token'");
1171 case ST_SPACING_SINGLE:
1172 spacing.set(Spacing::Single);
1174 case ST_SPACING_ONEHALF:
1175 spacing.set(Spacing::Onehalf);
1177 case ST_SPACING_DOUBLE:
1178 spacing.set(Spacing::Double);
1182 spacing.set(Spacing::Other, lex.getString());
1188 void Layout::readArgument(Lexer & lex, bool validating)
1191 LYXERR0("Unable to read argument ID!");
1194 string const id = lex.getString();
1196 bool const itemarg = prefixIs(id, "item:");
1197 bool const postcmd = prefixIs(id, "post:");
1198 bool const listpreamble = prefixIs(id, "listpreamble:");
1200 LaTeXArgMap & lam = itemarg ? itemargs_ :
1201 (postcmd ? postcommandargs_ :
1202 (listpreamble ? listpreamble_ :
1204 latexarg & arg = lam[id];
1207 // list preamble has no delimiters by default
1208 arg.nodelims = true;
1211 bool finished = false;
1212 while (!finished && lex.isOK() && !error) {
1214 string const tok = ascii_lowercase(lex.getString());
1218 } else if (tok == "endargument") {
1220 } else if (tok == "labelstring") {
1222 arg.labelstring = lex.getDocString();
1223 } else if (tok == "menustring") {
1225 arg.menustring = lex.getDocString();
1226 } else if (tok == "mandatory") {
1228 arg.mandatory = lex.getBool();
1229 } else if (tok == "autoinsert") {
1231 arg.autoinsert = lex.getBool();
1232 } else if (tok == "insertcotext") {
1234 arg.insertcotext = lex.getBool();
1235 } else if (tok == "leftdelim") {
1237 arg.ldelim = lex.getDocString();
1238 arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
1240 } else if (tok == "rightdelim") {
1242 arg.rdelim = lex.getDocString();
1243 arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
1245 } else if (tok == "defaultarg") {
1247 arg.defaultarg = lex.getDocString();
1248 } else if (tok == "presetarg") {
1250 arg.presetarg = lex.getDocString();
1251 } else if (tok == "tooltip") {
1253 arg.tooltip = lex.getDocString();
1254 } else if (tok == "requires") {
1256 arg.required = lex.getString();
1257 } else if (tok == "decoration") {
1259 arg.decoration = lex.getString();
1260 } else if (tok == "newlinecmd") {
1262 arg.newlinecmd = lex.getString();
1263 } else if (tok == "font") {
1264 arg.font = lyxRead(lex, arg.font);
1265 } else if (tok == "labelfont") {
1266 arg.labelfont = lyxRead(lex, arg.labelfont);
1267 } else if (tok == "passthruchars") {
1269 arg.pass_thru_chars = lex.getDocString();
1270 } else if (tok == "passthru") {
1272 docstring value = lex.getDocString();
1273 if (value == "true" || value == "1")
1274 arg.passthru = PT_TRUE;
1275 else if (value == "false" || value == "0")
1276 arg.passthru = PT_FALSE;
1278 arg.passthru = PT_INHERITED;
1279 } else if (tok == "istoccaption") {
1281 arg.is_toc_caption = lex.getBool();
1282 } else if (tok == "freespacing") {
1284 arg.free_spacing = lex.getBool();
1285 } else if (tok == "docbooktag") {
1287 arg.docbooktag = lex.getDocString();
1288 } else if (tok == "docbookattr") {
1290 arg.docbookattr = lex.getDocString();
1291 } else if (tok == "docbooktagtype") {
1293 arg.docbooktagtype = lex.getDocString();
1294 } else if (tok == "docbookargumentaftermaintag") {
1296 arg.docbookargumentaftermaintag = lex.getBool();
1297 } else if (tok == "docbookargumentbeforemaintag") {
1299 arg.docbookargumentbeforemaintag = lex.getBool();
1301 lex.printError("Unknown tag");
1305 if (!validating && arg.labelstring.empty()) {
1306 LYXERR0("Incomplete Argument definition!");
1307 // remove invalid definition
1313 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1315 os << "\tArgument " << id << '\n';
1316 if (!arg.labelstring.empty())
1317 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1318 if (!arg.menustring.empty())
1319 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1321 os << "\t\tMandatory " << arg.mandatory << '\n';
1323 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1324 if (arg.insertcotext)
1325 os << "\t\tInsertCotext " << arg.insertcotext << '\n';
1326 if (!arg.ldelim.empty())
1327 os << "\t\tLeftDelim \""
1328 << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1330 if (!arg.rdelim.empty())
1331 os << "\t\tRightDelim \""
1332 << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1334 if (!arg.defaultarg.empty())
1335 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1336 if (!arg.presetarg.empty())
1337 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1338 if (!arg.tooltip.empty())
1339 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1340 if (!arg.required.empty())
1341 os << "\t\tRequires \"" << arg.required << "\"\n";
1342 if (!arg.decoration.empty())
1343 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1344 if (!arg.newlinecmd.empty())
1345 os << "\t\tNewlineCmd \"" << arg.newlinecmd << "\"\n";
1346 if (arg.font != inherit_font)
1347 lyxWrite(os, arg.font, "Font", 2);
1348 if (arg.labelfont != inherit_font)
1349 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1350 switch (arg.passthru) {
1352 os << "\t\tPassThru true\n";
1355 os << "\t\tPassThru false\n";
1358 os << "\t\tPassThru inherited\n";
1361 if (!arg.pass_thru_chars.empty())
1362 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1363 if (arg.free_spacing)
1364 os << "\t\tFreeSpacing " << arg.free_spacing << "\n";
1365 os << "\tEndArgument\n";
1369 void Layout::write(ostream & os) const
1371 os << "Style \"" << to_utf8(name_) << "\"\n";
1372 if (!category_.empty() && obsoleted_by_.empty())
1373 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1374 // Can't deduce Copystyle here :-(
1375 if (!obsoleted_by_.empty()) {
1376 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1380 if (!depends_on_.empty())
1381 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1382 switch (margintype) {
1383 case MARGIN_DYNAMIC:
1384 os << "\tMargin Dynamic\n";
1386 case MARGIN_FIRST_DYNAMIC:
1387 os << "\tMargin First_Dynamic\n";
1390 os << "\tMargin Manual\n";
1392 case MARGIN_RIGHT_ADDRESS_BOX:
1393 os << "\tMargin Right_Address_Box\n";
1396 os << "\tMargin Static\n";
1399 switch (latextype) {
1400 case LATEX_BIB_ENVIRONMENT:
1401 os << "\tLatexType Bib_Environment\n";
1404 os << "\tLatexType Command\n";
1406 case LATEX_ENVIRONMENT:
1407 os << "\tLatexType Environment\n";
1409 case LATEX_ITEM_ENVIRONMENT:
1410 os << "\tLatexType Item_Environment\n";
1412 case LATEX_LIST_ENVIRONMENT:
1413 os << "\tLatexType List_Environment\n";
1415 case LATEX_PARAGRAPH:
1416 os << "\tLatexType Paragraph\n";
1419 os << "\tInTitle " << intitle << "\n"
1420 "\tInPreamble " << inpreamble << "\n"
1421 "\tTocLevel " << toclevel << "\n"
1422 "\tResumeCounter " << resumecounter << "\n"
1423 "\tStepParentCounter " << stepparentcounter << '\n';
1424 // ResetArgs does not make sense here
1425 for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1426 it != latexargs_.end(); ++it)
1427 writeArgument(os, it->first, it->second);
1428 for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1429 it != itemargs_.end(); ++it)
1430 writeArgument(os, it->first, it->second);
1431 for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1432 it != postcommandargs_.end(); ++it)
1433 writeArgument(os, it->first, it->second);
1434 for (LaTeXArgMap::const_iterator it = listpreamble_.begin();
1435 it != listpreamble_.end(); ++it)
1436 writeArgument(os, it->first, it->second);
1437 os << "\tNeedProtect " << needprotect << "\n"
1438 "\tNeedCProtect " << needcprotect << "\n"
1439 "\tNeedMBoxProtect " << needmboxprotect << "\n"
1440 "\tKeepEmpty " << keepempty << '\n';
1441 if (labelfont == font)
1442 lyxWrite(os, font, "Font", 1);
1444 lyxWrite(os, font, "TextFont", 1);
1445 lyxWrite(os, labelfont, "LabelFont", 1);
1447 os << "\tNextNoIndent " << nextnoindent << "\n"
1448 "\tCommandDepth " << commanddepth << '\n';
1449 if (!latexname_.empty())
1450 os << "\tLatexName \"" << latexname_ << "\"\n";
1451 if (!latexparam_.empty())
1452 os << "\tLatexParam \"" << subst(latexparam_, "\"", """)
1454 if (!leftdelim_.empty())
1455 os << "\tLeftDelim "
1456 << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1458 if (!rightdelim_.empty())
1459 os << "\tRightDelim "
1460 << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1462 if (!innertag_.empty())
1463 os << "\tInnerTag \"" << innertag_ << "\"\n";
1464 if (!labeltag_.empty())
1465 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1466 if (!itemtag_.empty())
1467 os << "\tItemTag \"" << itemtag_ << "\"\n";
1468 if (!itemcommand_.empty())
1469 os << "\tItemCommand " << itemcommand_ << '\n';
1470 if (!preamble_.empty())
1471 os << "\tPreamble\n\t"
1472 << to_utf8(subst(rtrim(preamble_, "\n"),
1473 from_ascii("\n"), from_ascii("\n\t")))
1474 << "\n\tEndPreamble\n";
1475 if (!langpreamble_.empty())
1476 os << "\tLangPreamble\n\t"
1477 << to_utf8(subst(rtrim(langpreamble_, "\n"),
1478 from_ascii("\n"), from_ascii("\n\t")))
1479 << "\n\tEndLangPreamble\n";
1480 if (!babelpreamble_.empty())
1481 os << "\tBabelPreamble\n\t"
1482 << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1483 from_ascii("\n"), from_ascii("\n\t")))
1484 << "\n\tEndBabelPreamble\n";
1485 switch (labeltype) {
1487 os << "\tLabelType Above\n";
1490 os << "\tLabelType Bibliography\n";
1492 case LABEL_CENTERED:
1493 os << "\tLabelType Centered\n";
1495 case LABEL_ENUMERATE:
1496 os << "\tLabelType Enumerate\n";
1499 os << "\tLabelType Itemize\n";
1502 os << "\tLabelType Manual\n";
1504 case LABEL_NO_LABEL:
1505 os << "\tLabelType No_Label\n";
1507 case LABEL_SENSITIVE:
1508 os << "\tLabelType Sensitive\n";
1511 os << "\tLabelType Static\n";
1514 switch (endlabeltype) {
1516 os << "\tEndLabelType Box\n";
1518 case END_LABEL_FILLED_BOX:
1519 os << "\tEndLabelType Filled_Box\n";
1521 case END_LABEL_NO_LABEL:
1522 os << "\tEndLabelType No_Label\n";
1524 case END_LABEL_STATIC:
1525 os << "\tEndLabelType Static\n";
1528 os << "\tParagraphGroup \"" << par_group_ << "\"\n";
1529 if (!leftmargin.empty())
1530 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1531 if (!rightmargin.empty())
1532 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1533 if (!labelindent.empty())
1534 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1535 if (!parindent.empty())
1536 os << "\tParIndent " << to_utf8(parindent) << '\n';
1537 os << "\tParSkip " << parskip << "\n"
1538 "\tItemSep " << itemsep << "\n"
1539 "\tTopSep " << topsep << "\n"
1540 "\tBottomSep " << bottomsep << "\n"
1541 "\tLabelBottomSep " << labelbottomsep << '\n';
1542 if (!labelsep.empty())
1543 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1545 os << "\tParSep " << parsep << "\n"
1546 "\tNewLine " << newline_allowed << '\n';
1548 case LYX_ALIGN_BLOCK:
1549 os << "\tAlign Block\n";
1551 case LYX_ALIGN_CENTER:
1552 os << "\tAlign Center\n";
1554 case LYX_ALIGN_LAYOUT:
1555 os << "\tAlign Layout\n";
1557 case LYX_ALIGN_LEFT:
1558 os << "\tAlign Left\n";
1560 case LYX_ALIGN_RIGHT:
1561 os << "\tAlign Right\n";
1563 case LYX_ALIGN_DECIMAL:
1564 case LYX_ALIGN_SPECIAL:
1565 case LYX_ALIGN_NONE:
1568 if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1569 LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1571 os << "\tAlignPossible";
1572 if (alignpossible & LYX_ALIGN_BLOCK) {
1576 if (alignpossible & LYX_ALIGN_CENTER) {
1582 if (alignpossible & LYX_ALIGN_LAYOUT) {
1588 if (alignpossible & LYX_ALIGN_LEFT) {
1594 if (alignpossible & LYX_ALIGN_RIGHT) {
1602 // LabelString must come before LabelStringAppendix
1603 if (!labelstring_.empty())
1604 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1605 if (!endlabelstring_.empty())
1606 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1607 if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1608 os << "\tLabelStringAppendix \""
1609 << to_utf8(labelstring_appendix_) << "\"\n";
1610 if (!counter.empty())
1611 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1612 os << "\tFreeSpacing " << free_spacing << '\n';
1613 os << "\tPassThru " << pass_thru << '\n';
1614 if (!pass_thru_chars.empty())
1615 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1616 os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1617 switch (spacing.getSpace()) {
1618 case Spacing::Double:
1619 os << "\tSpacing Double\n";
1621 case Spacing::Onehalf:
1622 os << "\tSpacing Onehalf\n";
1624 case Spacing::Other:
1625 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1627 case Spacing::Single:
1628 os << "\tSpacing Single\n";
1630 case Spacing::Default:
1633 if (!required_.empty()) {
1634 os << "\tRequires ";
1635 for (set<string>::const_iterator it = required_.begin();
1636 it != required_.end(); ++it) {
1637 if (it != required_.begin())
1643 if (!autonests_.empty()) {
1644 os << "\tAutoNests\n\t";
1645 for (set<docstring>::const_iterator it = autonests_.begin();
1646 it != autonests_.end(); ++it) {
1647 if (it != autonests_.begin())
1651 os << "\n\tEndAutoNests\n";
1653 if (!autonested_by_.empty()) {
1654 os << "\tIsAutoNestedBy\n\t\t";
1655 for (set<docstring>::const_iterator it = autonested_by_.begin();
1656 it != autonested_by_.end(); ++it) {
1657 if (it != autonested_by_.begin())
1661 os << "\n\tEndIsAutoNestedBy\n";
1663 if (refprefix.empty())
1664 os << "\tRefPrefix OFF\n";
1666 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1667 if (!htmltag_.empty())
1668 os << "\tHTMLTag " << htmltag_ << '\n';
1669 if (!htmlattr_.empty())
1670 os << "\tHTMLAttr " << htmlattr_ << '\n';
1671 if (!htmlitemtag_.empty())
1672 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1673 if (!htmlitemattr_.empty())
1674 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1675 if (!htmllabeltag_.empty())
1676 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1677 if (!htmllabelattr_.empty())
1678 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1679 os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1680 if (!htmlstyle_.empty())
1681 os << "\tHTMLStyle\n"
1682 << to_utf8(rtrim(htmlstyle_, "\n"))
1683 << "\n\tEndHTMLStyle\n";
1684 os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1685 if (!htmlpreamble_.empty())
1686 os << "\tHTMLPreamble\n"
1687 << to_utf8(rtrim(htmlpreamble_, "\n"))
1688 << "\n\tEndPreamble\n";
1689 os << "\tHTMLTitle " << htmltitle_ << "\n";
1690 if(!docbooktag_.empty())
1691 os << "\tDocBookTag " << docbooktag_ << '\n';
1692 if(!docbookattr_.empty())
1693 os << "\tDocBookAttr \"" << docbookattr_ << "\"\n";
1694 if(!docbooktagtype_.empty())
1695 os << "\tDocBookTagType " << docbooktagtype_ << '\n';
1696 if(!docbookinnertag_.empty())
1697 os << "\tDocBookInnerTag " << docbookinnertag_ << '\n';
1698 if(!docbookinnerattr_.empty())
1699 os << "\tDocBookInnerAttr \"" << docbookinnerattr_ << "\"\n";
1700 if(!docbookinnertagtype_.empty())
1701 os << "\tDocBookInnerTagType " << docbookinnertagtype_ << '\n';
1702 if(!docbookininfo_.empty())
1703 os << "\tDocBookInInfo " << docbookininfo_ << '\n';
1704 os << "\tDocBookAbstract " << docbookabstract_ << '\n';
1705 if(!docbookwrappertag_.empty())
1706 os << "\tDocBookWrapperTag " << docbookwrappertag_ << '\n';
1707 if(!docbookwrapperattr_.empty())
1708 os << "\tDocBookWrapperAttr " << docbookwrapperattr_ << '\n';
1709 if(!docbookwrappertagtype_.empty())
1710 os << "\tDocBookWrapperTagType " << docbookwrappertagtype_ << '\n';
1711 os << "\tDocBookSection " << docbooksection_ << '\n';
1712 if(!docbooksectiontag_.empty())
1713 os << "\tDocBookSectionTag " << docbooksectiontag_ << '\n';
1714 if(!docbookitemtag_.empty())
1715 os << "\tDocBookItemTag " << docbookitemtag_ << '\n';
1716 if(!docbookitemattr_.empty())
1717 os << "\tDocBookItemAttr " << docbookitemattr_ << '\n';
1718 if(!docbookitemtagtype_.empty())
1719 os << "\tDocBookItemTagType " << docbookitemtagtype_ << '\n';
1720 if(!docbookitemwrappertag_.empty())
1721 os << "\tDocBookItemWrapperTag " << docbookitemwrappertag_ << '\n';
1722 if(!docbookitemwrapperattr_.empty())
1723 os << "\tDocBookItemWrapperAttr " << docbookitemwrapperattr_ << '\n';
1724 if(!docbookitemwrappertagtype_.empty())
1725 os << "\tDocBookItemWrapperTagType " << docbookitemwrappertagtype_ << '\n';
1726 os << "\tDocBookWrapperMergeWithPrevious " << docbookwrappermergewithprevious_ << '\n';
1727 if(!docbookitemlabeltag_.empty())
1728 os << "\tDocBookItemLabelTag " << docbookitemlabeltag_ << '\n';
1729 if(!docbookitemlabelattr_.empty())
1730 os << "\tDocBookItemLabelAttr " << docbookitemlabelattr_ << '\n';
1731 if(!docbookitemlabeltagtype_.empty())
1732 os << "\tDocBookItemLabelTagType " << docbookitemlabeltagtype_ << '\n';
1733 if(!docbookiteminnertag_.empty())
1734 os << "\tDocBookItemInnerTag " << docbookiteminnertag_ << '\n';
1735 if(!docbookiteminnerattr_.empty())
1736 os << "\tDocBookItemInnerAttr " << docbookiteminnerattr_ << '\n';
1737 if(!docbookiteminnertagtype_.empty())
1738 os << "\tDocBookItemInnerTagType " << docbookiteminnertagtype_ << '\n';
1739 if(!docbookforceabstracttag_.empty())
1740 os << "\tDocBookForceAbstractTag " << docbookforceabstracttag_ << '\n';
1741 os << "\tDocBookNoFontInside " << docbooknofontinside_ << "\n"
1742 "\tSpellcheck " << spellcheck << "\n"
1743 "\tForceLocal " << forcelocal << "\n"
1748 bool Layout::hasArgs() const
1750 return !latexargs_.empty() || !postcommandargs_.empty() ||
1751 !itemargs_.empty() || !listpreamble_.empty();
1755 Layout::LaTeXArgMap Layout::args() const
1757 LaTeXArgMap args = latexargs_;
1758 if (!postcommandargs_.empty())
1759 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1760 if (!listpreamble_.empty())
1761 args.insert(listpreamble_.begin(), listpreamble_.end());
1762 if (!itemargs_.empty())
1763 args.insert(itemargs_.begin(), itemargs_.end());
1768 int Layout::optArgs() const
1771 LaTeXArgMap::const_iterator it = latexargs_.begin();
1772 for (; it != latexargs_.end(); ++it) {
1773 if (!(*it).second.mandatory)
1776 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1777 for (; iit != postcommandargs_.end(); ++iit) {
1778 if (!(*iit).second.mandatory)
1785 int Layout::requiredArgs() const
1788 LaTeXArgMap::const_iterator it = latexargs_.begin();
1789 for (; it != latexargs_.end(); ++it) {
1790 if ((*it).second.mandatory)
1793 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1794 for (; iit != postcommandargs_.end(); ++iit) {
1795 if (!(*iit).second.mandatory)
1802 string const & Layout::htmltag() const
1804 if (htmltag_.empty())
1810 string const & Layout::htmlattr() const
1812 if (htmlattr_.empty())
1813 htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
1818 string const & Layout::htmlitemtag() const
1820 if (htmlitemtag_.empty())
1821 htmlitemtag_ = "div";
1822 return htmlitemtag_;
1826 string const & Layout::htmlitemattr() const
1828 if (htmlitemattr_.empty())
1829 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1830 return htmlitemattr_;
1834 string const & Layout::htmllabeltag() const
1836 if (htmllabeltag_.empty())
1837 htmllabeltag_ = "span";
1838 return htmllabeltag_;
1842 string const & Layout::htmllabelattr() const
1844 if (htmllabelattr_.empty())
1845 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1846 return htmllabelattr_;
1850 docstring Layout::htmlstyle() const
1852 if (!htmlstyle_.empty() && !htmlforcecss_)
1854 if (htmldefaultstyle_.empty())
1856 docstring retval = htmldefaultstyle_;
1857 if (!htmlstyle_.empty())
1858 retval += '\n' + htmlstyle_;
1863 string Layout::defaultCSSClass() const
1865 if (!defaultcssclass_.empty())
1866 return defaultcssclass_;
1868 docstring::const_iterator it = name().begin();
1869 docstring::const_iterator en = name().end();
1870 for (; it != en; ++it) {
1871 char_type const c = *it;
1872 if (!isAlphaASCII(c)) {
1874 // make sure we don't start with an underscore,
1875 // as that sometimes causes problems.
1876 d = from_ascii("lyx_");
1879 } else if (isLower(c))
1882 // this is slow, so do it only if necessary
1885 defaultcssclass_ = to_utf8(d);
1886 return defaultcssclass_;
1890 string const & Layout::docbooktag() const
1892 if (docbooktag_.empty()) {
1893 if (to_ascii(name_) == "Plain Layout")
1894 docbooktag_ = "para";
1895 else // No sensible default value, unhappily...
1896 docbooktag_ = to_utf8(name_);
1902 string const & Layout::docbookattr() const
1904 // Perfectly OK to return no attributes, so docbookattr_ does not need to be filled.
1905 return docbookattr_;
1909 bool isValidTagType(std::string const & type)
1911 return !(type.empty() || (type != "block" && type != "paragraph" && type != "inline"));
1915 string const & Layout::docbooktagtype() const
1917 if (!isValidTagType(docbooktagtype_))
1918 docbooktagtype_ = "block";
1919 return docbooktagtype_;
1923 string const & Layout::docbookinnertag() const
1925 if (docbookinnertag_.empty())
1926 docbookinnertag_ = "NONE";
1927 return docbookinnertag_;
1931 string const & Layout::docbookinnerattr() const
1933 return docbookinnerattr_;
1937 string const & Layout::docbookinnertagtype() const
1939 if (!isValidTagType(docbookinnertagtype_))
1940 docbookinnertagtype_ = "block";
1941 return docbookinnertagtype_;
1945 string const & Layout::docbookininfo() const
1947 // Indeed, a trilean. Only titles should be "maybe": otherwise, metadata is "always", content is "never".
1948 if (docbookininfo_.empty() || (docbookininfo_ != "never" && docbookininfo_ != "always" && docbookininfo_ != "maybe"))
1949 docbookininfo_ = "never";
1950 return docbookininfo_;
1954 string const & Layout::docbookwrappertag() const
1956 if (docbookwrappertag_.empty())
1957 docbookwrappertag_ = "NONE";
1958 return docbookwrappertag_;
1962 string const & Layout::docbookwrapperattr() const
1964 return docbookwrapperattr_;
1968 string const & Layout::docbookwrappertagtype() const
1970 if (!isValidTagType(docbookwrappertagtype_))
1971 docbookwrappertagtype_ = "block";
1972 return docbookwrappertagtype_;
1976 string const & Layout::docbooksectiontag() const
1978 if (docbooksectiontag_.empty())
1979 docbooksectiontag_ = "section";
1980 return docbooksectiontag_;
1984 string const & Layout::docbookitemwrappertag() const
1986 if (docbookitemwrappertag_.empty())
1987 docbookitemwrappertag_ = "NONE";
1988 return docbookitemwrappertag_;
1992 string const & Layout::docbookitemwrapperattr() const
1994 return docbookitemwrapperattr_;
1998 string const & Layout::docbookitemwrappertagtype() const
2000 if (!isValidTagType(docbookitemwrappertagtype_))
2001 docbookitemwrappertagtype_ = "block";
2002 return docbookitemwrappertagtype_;
2006 string const & Layout::docbookitemtag() const
2008 if (docbookitemtag_.empty())
2009 docbookitemtag_ = "NONE";
2010 return docbookitemtag_;
2014 string const & Layout::docbookitemattr() const
2016 return docbookitemattr_;
2020 string const & Layout::docbookitemtagtype() const
2022 if (!isValidTagType(docbookitemtagtype_))
2023 docbookitemtagtype_ = "block";
2024 return docbookitemtagtype_;
2028 string const & Layout::docbookitemlabeltag() const
2030 if (docbookitemlabeltag_.empty())
2031 docbookitemlabeltag_ = "NONE";
2032 return docbookitemlabeltag_;
2036 string const & Layout::docbookitemlabelattr() const
2038 return docbookitemlabelattr_;
2042 string const & Layout::docbookitemlabeltagtype() const
2044 if (!isValidTagType(docbookitemlabeltagtype_))
2045 docbookitemlabeltagtype_ = "block";
2046 return docbookitemlabeltagtype_;
2050 string const & Layout::docbookiteminnertag() const
2052 if (docbookiteminnertag_.empty())
2053 docbookiteminnertag_ = "NONE";
2054 return docbookiteminnertag_;
2058 string const & Layout::docbookiteminnerattr() const
2060 return docbookiteminnerattr_;
2064 string const & Layout::docbookiteminnertagtype() const
2066 if (!isValidTagType(docbookiteminnertagtype_))
2067 docbookiteminnertagtype_ = "block";
2068 return docbookiteminnertagtype_;
2072 std::string const & Layout::docbookforceabstracttag() const
2074 if (docbookforceabstracttag_.empty())
2075 docbookforceabstracttag_ = "NONE";
2076 return docbookforceabstracttag_;
2083 string makeMarginValue(char const * side, double d)
2086 os << "margin-" << side << ": " << d << "ex;\n";
2093 void Layout::makeDefaultCSS() const
2095 // this never needs to be redone, since reloading layouts will
2096 // wipe out what we did before.
2097 if (!htmldefaultstyle_.empty())
2101 htmldefaultstyle_ = font.asCSS();
2106 tmp += makeMarginValue("top", topsep);
2108 tmp += makeMarginValue("bottom", bottomsep);
2109 if (!leftmargin.empty()) {
2110 // we can't really do what LyX does with the margin, so
2111 // we'll just figure out how many characters it is
2112 int const len = leftmargin.length();
2113 tmp += makeMarginValue("left", len);
2115 if (!rightmargin.empty()) {
2116 int const len = rightmargin.length();
2117 tmp += makeMarginValue("right", len);
2121 if (!htmldefaultstyle_.empty())
2122 htmldefaultstyle_ += from_ascii("\n");
2123 htmldefaultstyle_ += from_ascii(tmp);
2127 string where = alignmentToCSS(align);
2128 if (!where.empty()) {
2129 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
2132 // wrap up what we have, if anything
2133 if (!htmldefaultstyle_.empty())
2135 from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
2136 htmldefaultstyle_ + from_ascii("\n}\n");
2138 if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
2144 if (labelfont != font)
2145 labelCSS = labelfont.asCSS() + from_ascii("\n");
2146 if (labeltype == LABEL_CENTERED)
2147 labelCSS += from_ascii("text-align: center;\n");
2149 if (!labelCSS.empty())
2150 htmldefaultstyle_ +=
2151 from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
2152 labelCSS + from_ascii("\n}\n");
2156 bool Layout::operator==(Layout const & rhs) const
2158 // This is enough for the applications we actually make,
2159 // at least at the moment. But we could check more.
2160 return name() == rhs.name()
2161 && latexname() == rhs.latexname()
2162 && latextype == rhs.latextype;