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_DOCBOOKWRAPPERTAG,
115 LT_DOCBOOKWRAPPERATTR,
116 LT_DOCBOOKWRAPPERTAGTYPE,
117 LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS,
119 LT_DOCBOOKSECTIONTAG,
120 LT_DOCBOOKITEMWRAPPERTAG,
121 LT_DOCBOOKITEMWRAPPERATTR,
122 LT_DOCBOOKITEMWRAPPERTAGTYPE,
125 LT_DOCBOOKITEMTAGTYPE,
126 LT_DOCBOOKITEMLABELTAG,
127 LT_DOCBOOKITEMLABELATTR,
128 LT_DOCBOOKITEMLABELTAGTYPE,
129 LT_DOCBOOKITEMINNERTAG,
130 LT_DOCBOOKITEMINNERATTR,
131 LT_DOCBOOKITEMINNERTAGTYPE,
132 LT_DOCBOOKFORCEABSTRACTTAG,
133 LT_DOCBOOKNOFONTINSIDE,
140 LT_STEPPARENTCOUNTER,
147 LT_INTITLE // keep this last!
150 /////////////////////
153 : add_to_toc_(false), is_toc_caption_(true)
156 margintype = MARGIN_STATIC;
157 latextype = LATEX_PARAGRAPH;
158 resumecounter = false;
159 stepparentcounter = false;
163 needcprotect = false;
164 needmboxprotect = false;
167 labelfont = inherit_font;
169 reslabelfont = sane_font;
170 nextnoindent = false;
175 labelbottomsep = 0.0;
177 align = LYX_ALIGN_BLOCK;
178 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
179 labeltype = LABEL_NO_LABEL;
180 endlabeltype = END_LABEL_NO_LABEL;
181 // Should or should not. That is the question.
182 // spacing.set(Spacing::OneHalf);
183 newline_allowed = true;
184 free_spacing = false;
186 parbreak_is_newline = false;
187 toclevel = NOT_IN_TOC;
189 htmllabelfirst_ = false;
190 htmlforcecss_ = false;
193 docbookabstract_ = false;
194 docbookwrappermergewithprevious_ = false;
195 docbooksection_ = false;
198 itemcommand_ = "item";
199 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
204 bool Layout::read(Lexer & lex, TextClass const & tclass, bool validating)
206 // If this is an empty layout, or if no force local version is set,
207 // we know that we will not discard the stuff to read
209 return readIgnoreForcelocal(lex, tclass, validating);
212 bool const ret = tmp.readIgnoreForcelocal(lex, tclass, validating);
214 // - the read version is higher
215 // - both versions are infinity (arbitrary decision)
216 // - the file did not contain any local version (needed for not
217 // skipping user defined local layouts)
218 if (tmp.forcelocal <= 0 || tmp.forcelocal > forcelocal)
224 bool Layout::readIgnoreForcelocal(Lexer & lex, TextClass const & tclass,
227 // This table is sorted alphabetically [asierra 30March96]
228 LexerKeyword layoutTags[] = {
229 { "addtotoc", LT_ADDTOTOC },
230 { "align", LT_ALIGN },
231 { "alignpossible", LT_ALIGNPOSSIBLE },
232 { "argument", LT_ARGUMENT },
233 { "autonests", LT_AUTONESTS },
234 { "babelpreamble", LT_BABELPREAMBLE },
235 { "bottomsep", LT_BOTTOMSEP },
236 { "category", LT_CATEGORY },
237 { "commanddepth", LT_COMMANDDEPTH },
238 { "copystyle", LT_COPYSTYLE },
239 { "dependson", LT_DEPENDSON },
240 { "docbookabstract", LT_DOCBOOKABSTRACT },
241 { "docbookattr", LT_DOCBOOKATTR },
242 { "docbookforceabstracttag", LT_DOCBOOKFORCEABSTRACTTAG },
243 { "docbookininfo", LT_DOCBOOKININFO },
244 { "docbookinnerattr", LT_DOCBOOKINNERATTR },
245 { "docbookinnertag", LT_DOCBOOKINNERTAG },
246 { "docbookinnertagtype", LT_DOCBOOKINNERTAGTYPE },
247 { "docbookitemattr", LT_DOCBOOKITEMATTR },
248 { "docbookiteminnerattr", LT_DOCBOOKITEMINNERATTR },
249 { "docbookiteminnertag", LT_DOCBOOKITEMINNERTAG },
250 { "docbookiteminnertagtype", LT_DOCBOOKITEMINNERTAGTYPE },
251 { "docbookitemlabelattr", LT_DOCBOOKITEMLABELATTR },
252 { "docbookitemlabeltag", LT_DOCBOOKITEMLABELTAG },
253 { "docbookitemlabeltagtype", LT_DOCBOOKITEMLABELTAGTYPE },
254 { "docbookitemtag", LT_DOCBOOKITEMTAG },
255 { "docbookitemtagtype", LT_DOCBOOKITEMTAGTYPE },
256 { "docbookitemwrapperattr", LT_DOCBOOKITEMWRAPPERATTR },
257 { "docbookitemwrappertag", LT_DOCBOOKITEMWRAPPERTAG },
258 { "docbookitemwrappertagtype", LT_DOCBOOKITEMWRAPPERTAGTYPE },
259 { "docbooknofontinside", LT_DOCBOOKNOFONTINSIDE, },
260 { "docbooksection", LT_DOCBOOKSECTION },
261 { "docbooksectiontag", LT_DOCBOOKSECTIONTAG },
262 { "docbooktag", LT_DOCBOOKTAG },
263 { "docbooktagtype", LT_DOCBOOKTAGTYPE },
264 { "docbookwrapperattr", LT_DOCBOOKWRAPPERATTR },
265 { "docbookwrappermergewithprevious", LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS },
266 { "docbookwrappertag", LT_DOCBOOKWRAPPERTAG },
267 { "docbookwrappertagtype", LT_DOCBOOKWRAPPERTAGTYPE },
269 { "endlabelstring", LT_ENDLABELSTRING },
270 { "endlabeltype", LT_ENDLABELTYPE },
272 { "forcelocal", LT_FORCELOCAL },
273 { "freespacing", LT_FREE_SPACING },
274 { "htmlattr", LT_HTMLATTR },
275 { "htmlclass", LT_HTMLCLASS },
276 { "htmlforcecss", LT_HTMLFORCECSS },
277 { "htmlintoc", LT_HTMLINTOC },
278 { "htmlitem", LT_HTMLITEM },
279 { "htmlitemattr", LT_HTMLITEMATTR },
280 { "htmllabel", LT_HTMLLABEL },
281 { "htmllabelattr", LT_HTMLLABELATTR },
282 { "htmllabelfirst", LT_HTMLLABELFIRST },
283 { "htmlpreamble", LT_HTMLPREAMBLE },
284 { "htmlstyle", LT_HTMLSTYLE },
285 { "htmltag", LT_HTMLTAG },
286 { "htmltitle", LT_HTMLTITLE },
287 { "innertag", LT_INNERTAG },
288 { "inpreamble", LT_INPREAMBLE },
289 { "intitle", LT_INTITLE },
290 { "isautonestedby", LT_AUTONESTEDBY },
291 { "istoccaption", LT_ISTOCCAPTION },
292 { "itemcommand", LT_ITEMCOMMAND },
293 { "itemsep", LT_ITEMSEP },
294 { "itemtag", LT_ITEMTAG },
295 { "keepempty", LT_KEEPEMPTY },
296 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
297 { "labelcounter", LT_LABELCOUNTER },
298 { "labelfont", LT_LABELFONT },
299 { "labelindent", LT_LABELINDENT },
300 { "labelsep", LT_LABELSEP },
301 { "labelstring", LT_LABELSTRING },
302 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
303 { "labeltag", LT_LABELTAG },
304 { "labeltype", LT_LABELTYPE },
305 { "langpreamble", LT_LANGPREAMBLE },
306 { "latexname", LT_LATEXNAME },
307 { "latexparam", LT_LATEXPARAM },
308 { "latextype", LT_LATEXTYPE },
309 { "leftdelim", LT_LEFTDELIM },
310 { "leftmargin", LT_LEFTMARGIN },
311 { "margin", LT_MARGIN },
312 { "needcprotect", LT_NEED_CPROTECT },
313 { "needmboxprotect", LT_NEED_MBOXPROTECT },
314 { "needprotect", LT_NEED_PROTECT },
315 { "newline", LT_NEWLINE },
316 { "nextnoindent", LT_NEXTNOINDENT },
317 { "obsoletedby", LT_OBSOLETEDBY },
318 { "paragraphgroup", LT_PAR_GROUP },
319 { "parbreakisnewline", LT_PARBREAK_IS_NEWLINE },
320 { "parindent", LT_PARINDENT },
321 { "parsep", LT_PARSEP },
322 { "parskip", LT_PARSKIP },
323 { "passthru", LT_PASS_THRU },
324 { "passthruchars", LT_PASS_THRU_CHARS },
325 { "preamble", LT_PREAMBLE },
326 { "refprefix", LT_REFPREFIX },
327 { "requires", LT_REQUIRES },
328 { "resetargs", LT_RESETARGS },
329 { "resumecounter", LT_RESUMECOUNTER },
330 { "rightdelim", LT_RIGHTDELIM },
331 { "rightmargin", LT_RIGHTMARGIN },
332 { "spacing", LT_SPACING },
333 { "spellcheck", LT_SPELLCHECK },
334 { "stepparentcounter", LT_STEPPARENTCOUNTER },
335 { "textfont", LT_TEXTFONT },
336 { "toclevel", LT_TOCLEVEL },
337 { "toggleindent", LT_TOGGLE_INDENT },
338 { "topsep", LT_TOPSEP }
342 bool finished = false;
343 lex.pushTable(layoutTags);
345 // parse style section
346 while (!finished && lex.isOK() && !error) {
348 // See comment in LyXRC.cpp.
350 case Lexer::LEX_FEOF:
353 case Lexer::LEX_UNDEF:
355 lex.printError("Unknown layout tag `$$Token'");
362 switch (static_cast<LayoutTags>(le)) {
374 style = subst(style, '_', ' ');
376 if (tclass.hasLayout(style)) {
377 docstring const tmpname = name_;
378 this->operator=(tclass[style]);
381 LYXERR0("Cannot copy unknown style `"
383 << "All layouts so far:");
384 DocumentClass::const_iterator lit = tclass.begin();
385 DocumentClass::const_iterator len = tclass.end();
386 for (; lit != len; ++lit)
387 LYXERR0(lit->name());
392 case LT_OBSOLETEDBY: {
395 style = subst(style, '_', ' ');
397 if (tclass.hasLayout(style)) {
398 docstring const tmpname = name_;
399 this->operator=(tclass[style]);
401 if (obsoleted_by().empty())
402 obsoleted_by_ = style;
404 LYXERR0("Cannot replace with unknown style `"
407 //lex.printError("Cannot replace with"
416 depends_on_ = subst(depends_on_, '_', ' ');
445 postcommandargs_.clear();
446 listpreamble_.clear();
450 case LT_RESUMECOUNTER:
451 lex >> resumecounter;
454 case LT_STEPPARENTCOUNTER:
455 lex >> stepparentcounter;
459 readArgument(lex, validating);
462 case LT_NEED_PROTECT:
466 case LT_NEED_CPROTECT:
470 case LT_NEED_MBOXPROTECT:
471 lex >> needmboxprotect;
479 font = lyxRead(lex, font);
484 font = lyxRead(lex, font);
488 labelfont = lyxRead(lex, labelfont);
491 case LT_NEXTNOINDENT:
495 case LT_TOGGLE_INDENT: {
498 tog = support::ascii_lowercase(tog);
500 toggle_indent = ITOGGLE_ALWAYS;
501 else if (tog == "never")
502 toggle_indent = ITOGGLE_NEVER;
504 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
508 case LT_COMMANDDEPTH:
518 latexparam_ = subst(latexparam_, """, "\"");
523 leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
529 rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
550 preamble_ = lex.getLongString(from_ascii("EndPreamble"));
553 case LT_LANGPREAMBLE:
554 langpreamble_ = lex.getLongString(from_ascii("EndLangPreamble"));
557 case LT_BABELPREAMBLE:
558 babelpreamble_ = lex.getLongString(from_ascii("EndBabelPreamble"));
565 case LT_ENDLABELTYPE:
566 readEndLabelType(lex);
601 case LT_LABEL_BOTTOMSEP:
602 lex >> labelbottomsep;
607 labelsep = subst(labelsep, 'x', ' ');
615 lex >> newline_allowed;
622 case LT_ALIGNPOSSIBLE:
623 readAlignPossible(lex);
627 // FIXME: this means LT_LABELSTRING_APPENDIX may only
628 // occur after LT_LABELSTRING
630 labelstring_appendix_ = labelstring_;
633 case LT_ENDLABELSTRING:
634 lex >> endlabelstring_;
637 case LT_LABELSTRING_APPENDIX:
638 lex >> labelstring_appendix_;
641 case LT_LABELCOUNTER:
649 case LT_FREE_SPACING:
657 case LT_PASS_THRU_CHARS:
658 lex >> pass_thru_chars;
661 case LT_PARBREAK_IS_NEWLINE:
662 lex >> parbreak_is_newline;
671 vector<string> const req =
672 getVectorFromString(lex.getString(true));
673 required_.insert(req.begin(), req.end());
678 docstring autonest = lex.getLongString(from_ascii("EndAutoNests"));
679 autonest = subst(autonest, from_ascii("\n"), docstring());
680 autonest = subst(autonest, from_ascii("\t"), docstring());
681 autonest = subst(autonest, from_ascii("\""), docstring());
682 autonest = subst(autonest, '_', ' ');
683 vector<docstring> const autonests =
684 getVectorFromString(autonest, from_ascii(","), false, true);
685 autonests_.insert(autonests.begin(), autonests.end());
689 case LT_AUTONESTEDBY: {
690 docstring autonest = lex.getLongString(from_ascii("EndIsAutoNestedBy"));
691 autonest = subst(autonest, from_ascii("\n"), docstring());
692 autonest = subst(autonest, from_ascii("\t"), docstring());
693 autonest = subst(autonest, from_ascii("\""), docstring());
694 autonest = subst(autonest, '_', ' ');
695 vector<docstring> const autonests =
696 getVectorFromString(autonest, from_ascii(","), false, true);
697 autonested_by_.insert(autonests.begin(), autonests.end());
731 case LT_HTMLITEMATTR:
732 lex >> htmlitemattr_;
736 lex >> htmllabeltag_;
739 case LT_HTMLLABELATTR:
740 lex >> htmllabelattr_;
743 case LT_HTMLLABELFIRST:
744 lex >> htmllabelfirst_;
748 htmlstyle_ = lex.getLongString(from_ascii("EndHTMLStyle"));
751 case LT_HTMLFORCECSS:
752 lex >> htmlforcecss_;
755 case LT_HTMLPREAMBLE:
756 htmlpreamble_ = lex.getLongString(from_ascii("EndPreamble"));
771 case LT_DOCBOOKTAGTYPE:
772 lex >> docbooktagtype_;
775 case LT_DOCBOOKINNERTAG:
776 lex >> docbookinnertag_;
779 case LT_DOCBOOKINNERATTR:
780 lex >> docbookinnerattr_;
783 case LT_DOCBOOKINNERTAGTYPE:
784 lex >> docbookinnertagtype_;
787 case LT_DOCBOOKFORCEABSTRACTTAG:
788 lex >> docbookforceabstracttag_;
791 case LT_DOCBOOKININFO:
792 lex >> docbookininfo_;
795 case LT_DOCBOOKABSTRACT:
796 lex >> docbookabstract_;
799 case LT_DOCBOOKWRAPPERTAG:
800 lex >> docbookwrappertag_;
803 case LT_DOCBOOKWRAPPERATTR:
804 lex >> docbookwrapperattr_;
807 case LT_DOCBOOKWRAPPERTAGTYPE:
808 lex >> docbookwrappertagtype_;
811 case LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS:
812 lex >> docbookwrappermergewithprevious_;
815 case LT_DOCBOOKSECTION:
816 lex >> docbooksection_;
819 case LT_DOCBOOKSECTIONTAG:
820 lex >> docbooksectiontag_;
823 case LT_DOCBOOKITEMWRAPPERTAG:
824 lex >> docbookitemwrappertag_;
827 case LT_DOCBOOKITEMWRAPPERATTR:
828 lex >> docbookitemwrapperattr_;
831 case LT_DOCBOOKITEMWRAPPERTAGTYPE:
832 lex >> docbookitemwrappertagtype_;
835 case LT_DOCBOOKITEMTAG:
836 lex >> docbookitemtag_;
839 case LT_DOCBOOKITEMATTR:
840 lex >> docbookitemattr_;
843 case LT_DOCBOOKITEMTAGTYPE:
844 lex >> docbookitemtagtype_;
847 case LT_DOCBOOKITEMLABELTAG:
848 lex >> docbookitemlabeltag_;
851 case LT_DOCBOOKITEMLABELATTR:
852 lex >> docbookitemlabelattr_;
855 case LT_DOCBOOKITEMLABELTAGTYPE:
856 lex >> docbookitemlabeltagtype_;
859 case LT_DOCBOOKITEMINNERTAG:
860 lex >> docbookiteminnertag_;
863 case LT_DOCBOOKITEMINNERATTR:
864 lex >> docbookiteminnerattr_;
867 case LT_DOCBOOKITEMINNERTAGTYPE:
868 lex >> docbookiteminnertagtype_;
871 case LT_DOCBOOKNOFONTINSIDE:
872 lex >> docbooknofontinside_;
885 add_to_toc_ = !toc_type_.empty();
888 case LT_ISTOCCAPTION:
889 lex >> is_toc_caption_;
895 // make sure we only have inpreamble = true for commands
896 if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
897 LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
898 LYXERR0("Layout name: " << name());
902 return finished && !error;
915 LexerKeyword alignTags[] = {
916 { "block", AT_BLOCK },
917 { "center", AT_CENTER },
918 { "layout", AT_LAYOUT },
920 { "right", AT_RIGHT }
924 void Layout::readAlign(Lexer & lex)
926 PushPopHelper pph(lex, alignTags);
929 case Lexer::LEX_UNDEF:
930 lex.printError("Unknown alignment `$$Token'");
936 align = LYX_ALIGN_BLOCK;
939 align = LYX_ALIGN_LEFT;
942 align = LYX_ALIGN_RIGHT;
945 align = LYX_ALIGN_CENTER;
948 align = LYX_ALIGN_LAYOUT;
954 void Layout::readAlignPossible(Lexer & lex)
956 lex.pushTable(alignTags);
957 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
958 int lineno = lex.lineNumber();
962 case Lexer::LEX_UNDEF:
963 lex.printError("Unknown alignment `$$Token'");
969 alignpossible |= LYX_ALIGN_BLOCK;
972 alignpossible |= LYX_ALIGN_LEFT;
975 alignpossible |= LYX_ALIGN_RIGHT;
978 alignpossible |= LYX_ALIGN_CENTER;
981 alignpossible |= LYX_ALIGN_LAYOUT;
984 } while (lineno == lex.lineNumber());
989 void Layout::readLabelType(Lexer & lex)
1004 LexerKeyword labelTypeTags[] = {
1005 { "above", LA_ABOVE },
1006 { "bibliography", LA_BIBLIO },
1007 { "centered", LA_CENTERED },
1008 { "enumerate", LA_ENUMERATE },
1009 { "itemize", LA_ITEMIZE },
1010 { "manual", LA_MANUAL },
1011 { "no_label", LA_NO_LABEL },
1012 { "sensitive", LA_SENSITIVE },
1013 { "static", LA_STATIC }
1016 PushPopHelper pph(lex, labelTypeTags);
1019 case Lexer::LEX_UNDEF:
1020 lex.printError("Unknown labeltype tag `$$Token'");
1026 labeltype = LABEL_NO_LABEL;
1029 labeltype = LABEL_MANUAL;
1032 labeltype = LABEL_ABOVE;
1035 labeltype = LABEL_CENTERED;
1038 labeltype = LABEL_STATIC;
1041 labeltype = LABEL_SENSITIVE;
1044 labeltype = LABEL_ENUMERATE;
1047 labeltype = LABEL_ITEMIZE;
1050 labeltype = LABEL_BIBLIO;
1056 void Layout::readEndLabelType(Lexer & lex)
1058 // this should be const, but can't be because
1059 // of PushPopHelper.
1060 static LexerKeyword endlabelTypeTags[] = {
1061 { "box", END_LABEL_BOX },
1062 { "filled_box", END_LABEL_FILLED_BOX },
1063 { "no_label", END_LABEL_NO_LABEL },
1064 { "static", END_LABEL_STATIC }
1067 PushPopHelper pph(lex, endlabelTypeTags);
1070 case Lexer::LEX_UNDEF:
1071 lex.printError("Unknown labeltype tag `$$Token'");
1073 case END_LABEL_STATIC:
1075 case END_LABEL_FILLED_BOX:
1076 case END_LABEL_NO_LABEL:
1077 endlabeltype = static_cast<EndLabelType>(le);
1080 LYXERR0("Unhandled value " << le);
1086 void Layout::readMargin(Lexer & lex)
1088 LexerKeyword marginTags[] = {
1089 { "dynamic", MARGIN_DYNAMIC },
1090 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
1091 { "manual", MARGIN_MANUAL },
1092 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
1093 { "static", MARGIN_STATIC }
1096 PushPopHelper pph(lex, marginTags);
1100 case Lexer::LEX_UNDEF:
1101 lex.printError("Unknown margin type tag `$$Token'");
1105 case MARGIN_DYNAMIC:
1106 case MARGIN_FIRST_DYNAMIC:
1107 case MARGIN_RIGHT_ADDRESS_BOX:
1108 margintype = static_cast<MarginType>(le);
1111 LYXERR0("Unhandled value " << le);
1117 void Layout::readLatexType(Lexer & lex)
1119 LexerKeyword latexTypeTags[] = {
1120 { "bib_environment", LATEX_BIB_ENVIRONMENT },
1121 { "command", LATEX_COMMAND },
1122 { "environment", LATEX_ENVIRONMENT },
1123 { "item_environment", LATEX_ITEM_ENVIRONMENT },
1124 { "list_environment", LATEX_LIST_ENVIRONMENT },
1125 { "paragraph", LATEX_PARAGRAPH }
1128 PushPopHelper pph(lex, latexTypeTags);
1131 case Lexer::LEX_UNDEF:
1132 lex.printError("Unknown latextype tag `$$Token'");
1134 case LATEX_PARAGRAPH:
1136 case LATEX_ITEM_ENVIRONMENT:
1137 case LATEX_LIST_ENVIRONMENT:
1138 latextype = static_cast<LatexType>(le);
1140 case LATEX_ENVIRONMENT:
1141 case LATEX_BIB_ENVIRONMENT:
1142 latextype = static_cast<LatexType>(le);
1146 LYXERR0("Unhandled value " << le);
1152 void Layout::readSpacing(Lexer & lex)
1155 ST_SPACING_SINGLE = 1,
1161 LexerKeyword spacingTags[] = {
1162 {"double", ST_SPACING_DOUBLE },
1163 {"onehalf", ST_SPACING_ONEHALF },
1164 {"other", ST_OTHER },
1165 {"single", ST_SPACING_SINGLE }
1168 PushPopHelper pph(lex, spacingTags);
1171 case Lexer::LEX_UNDEF:
1172 lex.printError("Unknown spacing token `$$Token'");
1177 case ST_SPACING_SINGLE:
1178 spacing.set(Spacing::Single);
1180 case ST_SPACING_ONEHALF:
1181 spacing.set(Spacing::Onehalf);
1183 case ST_SPACING_DOUBLE:
1184 spacing.set(Spacing::Double);
1188 spacing.set(Spacing::Other, lex.getString());
1194 void Layout::readArgument(Lexer & lex, bool validating)
1197 LYXERR0("Unable to read argument ID!");
1200 string const id = lex.getString();
1202 bool const itemarg = prefixIs(id, "item:");
1203 bool const postcmd = prefixIs(id, "post:");
1204 bool const listpreamble = prefixIs(id, "listpreamble:");
1206 LaTeXArgMap & lam = itemarg ? itemargs_ :
1207 (postcmd ? postcommandargs_ :
1208 (listpreamble ? listpreamble_ :
1210 latexarg & arg = lam[id];
1213 // list preamble has no delimiters by default
1214 arg.nodelims = true;
1217 bool finished = false;
1218 while (!finished && lex.isOK() && !error) {
1220 string const tok = ascii_lowercase(lex.getString());
1224 } else if (tok == "endargument") {
1226 } else if (tok == "labelstring") {
1228 arg.labelstring = lex.getDocString();
1229 } else if (tok == "menustring") {
1231 arg.menustring = lex.getDocString();
1232 } else if (tok == "mandatory") {
1234 arg.mandatory = lex.getBool();
1235 } else if (tok == "autoinsert") {
1237 arg.autoinsert = lex.getBool();
1238 } else if (tok == "insertcotext") {
1240 arg.insertcotext = lex.getBool();
1241 } else if (tok == "leftdelim") {
1243 arg.ldelim = lex.getDocString();
1244 arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
1246 } else if (tok == "rightdelim") {
1248 arg.rdelim = lex.getDocString();
1249 arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
1251 } else if (tok == "defaultarg") {
1253 arg.defaultarg = lex.getDocString();
1254 } else if (tok == "presetarg") {
1256 arg.presetarg = lex.getDocString();
1257 } else if (tok == "tooltip") {
1259 arg.tooltip = lex.getDocString();
1260 } else if (tok == "requires") {
1262 arg.required = lex.getString();
1263 } else if (tok == "decoration") {
1265 arg.decoration = lex.getString();
1266 } else if (tok == "newlinecmd") {
1268 arg.newlinecmd = lex.getString();
1269 } else if (tok == "font") {
1270 arg.font = lyxRead(lex, arg.font);
1271 } else if (tok == "labelfont") {
1272 arg.labelfont = lyxRead(lex, arg.labelfont);
1273 } else if (tok == "passthruchars") {
1275 arg.pass_thru_chars = lex.getDocString();
1276 } else if (tok == "passthru") {
1278 docstring value = lex.getDocString();
1279 if (value == "true" || value == "1")
1280 arg.passthru = PT_TRUE;
1281 else if (value == "false" || value == "0")
1282 arg.passthru = PT_FALSE;
1284 arg.passthru = PT_INHERITED;
1285 } else if (tok == "istoccaption") {
1287 arg.is_toc_caption = lex.getBool();
1288 } else if (tok == "freespacing") {
1290 arg.free_spacing = lex.getBool();
1291 } else if (tok == "docbooktag") {
1293 arg.docbooktag = lex.getDocString();
1294 } else if (tok == "docbookattr") {
1296 arg.docbookattr = lex.getDocString();
1297 } else if (tok == "docbooktagtype") {
1299 arg.docbooktagtype = lex.getDocString();
1300 } else if (tok == "docbookargumentaftermaintag") {
1302 arg.docbookargumentaftermaintag = lex.getBool();
1303 } else if (tok == "docbookargumentbeforemaintag") {
1305 arg.docbookargumentbeforemaintag = lex.getBool();
1307 lex.printError("Unknown tag");
1311 if (!validating && arg.labelstring.empty()) {
1312 LYXERR0("Incomplete Argument definition!");
1313 // remove invalid definition
1319 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1321 os << "\tArgument " << id << '\n';
1322 if (!arg.labelstring.empty())
1323 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1324 if (!arg.menustring.empty())
1325 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1327 os << "\t\tMandatory " << arg.mandatory << '\n';
1329 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1330 if (arg.insertcotext)
1331 os << "\t\tInsertCotext " << arg.insertcotext << '\n';
1332 if (!arg.ldelim.empty())
1333 os << "\t\tLeftDelim \""
1334 << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1336 if (!arg.rdelim.empty())
1337 os << "\t\tRightDelim \""
1338 << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1340 if (!arg.defaultarg.empty())
1341 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1342 if (!arg.presetarg.empty())
1343 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1344 if (!arg.tooltip.empty())
1345 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1346 if (!arg.required.empty())
1347 os << "\t\tRequires \"" << arg.required << "\"\n";
1348 if (!arg.decoration.empty())
1349 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1350 if (!arg.newlinecmd.empty())
1351 os << "\t\tNewlineCmd \"" << arg.newlinecmd << "\"\n";
1352 if (arg.font != inherit_font)
1353 lyxWrite(os, arg.font, "Font", 2);
1354 if (arg.labelfont != inherit_font)
1355 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1356 switch (arg.passthru) {
1358 os << "\t\tPassThru true\n";
1361 os << "\t\tPassThru false\n";
1364 os << "\t\tPassThru inherited\n";
1367 if (!arg.pass_thru_chars.empty())
1368 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1369 if (arg.free_spacing)
1370 os << "\t\tFreeSpacing " << arg.free_spacing << "\n";
1371 os << "\tEndArgument\n";
1375 void Layout::write(ostream & os) const
1377 os << "Style \"" << to_utf8(name_) << "\"\n";
1378 if (!category_.empty() && obsoleted_by_.empty())
1379 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1380 // Can't deduce Copystyle here :-(
1381 if (!obsoleted_by_.empty()) {
1382 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1386 if (!depends_on_.empty())
1387 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1388 switch (margintype) {
1389 case MARGIN_DYNAMIC:
1390 os << "\tMargin Dynamic\n";
1392 case MARGIN_FIRST_DYNAMIC:
1393 os << "\tMargin First_Dynamic\n";
1396 os << "\tMargin Manual\n";
1398 case MARGIN_RIGHT_ADDRESS_BOX:
1399 os << "\tMargin Right_Address_Box\n";
1402 os << "\tMargin Static\n";
1405 switch (latextype) {
1406 case LATEX_BIB_ENVIRONMENT:
1407 os << "\tLatexType Bib_Environment\n";
1410 os << "\tLatexType Command\n";
1412 case LATEX_ENVIRONMENT:
1413 os << "\tLatexType Environment\n";
1415 case LATEX_ITEM_ENVIRONMENT:
1416 os << "\tLatexType Item_Environment\n";
1418 case LATEX_LIST_ENVIRONMENT:
1419 os << "\tLatexType List_Environment\n";
1421 case LATEX_PARAGRAPH:
1422 os << "\tLatexType Paragraph\n";
1425 os << "\tInTitle " << intitle << "\n"
1426 "\tInPreamble " << inpreamble << "\n"
1427 "\tTocLevel " << toclevel << "\n"
1428 "\tResumeCounter " << resumecounter << "\n"
1429 "\tStepParentCounter " << stepparentcounter << '\n';
1430 // ResetArgs does not make sense here
1431 for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1432 it != latexargs_.end(); ++it)
1433 writeArgument(os, it->first, it->second);
1434 for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1435 it != itemargs_.end(); ++it)
1436 writeArgument(os, it->first, it->second);
1437 for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1438 it != postcommandargs_.end(); ++it)
1439 writeArgument(os, it->first, it->second);
1440 for (LaTeXArgMap::const_iterator it = listpreamble_.begin();
1441 it != listpreamble_.end(); ++it)
1442 writeArgument(os, it->first, it->second);
1443 os << "\tNeedProtect " << needprotect << "\n"
1444 "\tNeedCProtect " << needcprotect << "\n"
1445 "\tNeedMBoxProtect " << needmboxprotect << "\n"
1446 "\tKeepEmpty " << keepempty << '\n';
1447 if (labelfont == font)
1448 lyxWrite(os, font, "Font", 1);
1450 lyxWrite(os, font, "TextFont", 1);
1451 lyxWrite(os, labelfont, "LabelFont", 1);
1453 os << "\tNextNoIndent " << nextnoindent << "\n"
1454 "\tCommandDepth " << commanddepth << '\n';
1455 if (!latexname_.empty())
1456 os << "\tLatexName \"" << latexname_ << "\"\n";
1457 if (!latexparam_.empty())
1458 os << "\tLatexParam \"" << subst(latexparam_, "\"", """)
1460 if (!leftdelim_.empty())
1461 os << "\tLeftDelim "
1462 << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1464 if (!rightdelim_.empty())
1465 os << "\tRightDelim "
1466 << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1468 if (!innertag_.empty())
1469 os << "\tInnerTag \"" << innertag_ << "\"\n";
1470 if (!labeltag_.empty())
1471 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1472 if (!itemtag_.empty())
1473 os << "\tItemTag \"" << itemtag_ << "\"\n";
1474 if (!itemcommand_.empty())
1475 os << "\tItemCommand " << itemcommand_ << '\n';
1476 if (!preamble_.empty())
1477 os << "\tPreamble\n\t"
1478 << to_utf8(subst(rtrim(preamble_, "\n"),
1479 from_ascii("\n"), from_ascii("\n\t")))
1480 << "\n\tEndPreamble\n";
1481 if (!langpreamble_.empty())
1482 os << "\tLangPreamble\n\t"
1483 << to_utf8(subst(rtrim(langpreamble_, "\n"),
1484 from_ascii("\n"), from_ascii("\n\t")))
1485 << "\n\tEndLangPreamble\n";
1486 if (!babelpreamble_.empty())
1487 os << "\tBabelPreamble\n\t"
1488 << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1489 from_ascii("\n"), from_ascii("\n\t")))
1490 << "\n\tEndBabelPreamble\n";
1491 switch (labeltype) {
1493 os << "\tLabelType Above\n";
1496 os << "\tLabelType Bibliography\n";
1498 case LABEL_CENTERED:
1499 os << "\tLabelType Centered\n";
1501 case LABEL_ENUMERATE:
1502 os << "\tLabelType Enumerate\n";
1505 os << "\tLabelType Itemize\n";
1508 os << "\tLabelType Manual\n";
1510 case LABEL_NO_LABEL:
1511 os << "\tLabelType No_Label\n";
1513 case LABEL_SENSITIVE:
1514 os << "\tLabelType Sensitive\n";
1517 os << "\tLabelType Static\n";
1520 switch (endlabeltype) {
1522 os << "\tEndLabelType Box\n";
1524 case END_LABEL_FILLED_BOX:
1525 os << "\tEndLabelType Filled_Box\n";
1527 case END_LABEL_NO_LABEL:
1528 os << "\tEndLabelType No_Label\n";
1530 case END_LABEL_STATIC:
1531 os << "\tEndLabelType Static\n";
1534 os << "\tParagraphGroup \"" << par_group_ << "\"\n";
1535 if (!leftmargin.empty())
1536 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1537 if (!rightmargin.empty())
1538 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1539 if (!labelindent.empty())
1540 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1541 if (!parindent.empty())
1542 os << "\tParIndent " << to_utf8(parindent) << '\n';
1543 os << "\tParSkip " << parskip << "\n"
1544 "\tItemSep " << itemsep << "\n"
1545 "\tTopSep " << topsep << "\n"
1546 "\tBottomSep " << bottomsep << "\n"
1547 "\tLabelBottomSep " << labelbottomsep << '\n';
1548 if (!labelsep.empty())
1549 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1551 os << "\tParSep " << parsep << "\n"
1552 "\tNewLine " << newline_allowed << '\n';
1554 case LYX_ALIGN_BLOCK:
1555 os << "\tAlign Block\n";
1557 case LYX_ALIGN_CENTER:
1558 os << "\tAlign Center\n";
1560 case LYX_ALIGN_LAYOUT:
1561 os << "\tAlign Layout\n";
1563 case LYX_ALIGN_LEFT:
1564 os << "\tAlign Left\n";
1566 case LYX_ALIGN_RIGHT:
1567 os << "\tAlign Right\n";
1569 case LYX_ALIGN_DECIMAL:
1570 case LYX_ALIGN_SPECIAL:
1571 case LYX_ALIGN_NONE:
1574 if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1575 LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1577 os << "\tAlignPossible";
1578 if (alignpossible & LYX_ALIGN_BLOCK) {
1582 if (alignpossible & LYX_ALIGN_CENTER) {
1588 if (alignpossible & LYX_ALIGN_LAYOUT) {
1594 if (alignpossible & LYX_ALIGN_LEFT) {
1600 if (alignpossible & LYX_ALIGN_RIGHT) {
1608 // LabelString must come before LabelStringAppendix
1609 if (!labelstring_.empty())
1610 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1611 if (!endlabelstring_.empty())
1612 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1613 if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1614 os << "\tLabelStringAppendix \""
1615 << to_utf8(labelstring_appendix_) << "\"\n";
1616 if (!counter.empty())
1617 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1618 os << "\tFreeSpacing " << free_spacing << '\n';
1619 os << "\tPassThru " << pass_thru << '\n';
1620 if (!pass_thru_chars.empty())
1621 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1622 os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1623 switch (spacing.getSpace()) {
1624 case Spacing::Double:
1625 os << "\tSpacing Double\n";
1627 case Spacing::Onehalf:
1628 os << "\tSpacing Onehalf\n";
1630 case Spacing::Other:
1631 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1633 case Spacing::Single:
1634 os << "\tSpacing Single\n";
1636 case Spacing::Default:
1639 if (!required_.empty()) {
1640 os << "\tRequires ";
1641 for (set<string>::const_iterator it = required_.begin();
1642 it != required_.end(); ++it) {
1643 if (it != required_.begin())
1649 if (!autonests_.empty()) {
1650 os << "\tAutoNests\n\t";
1651 for (set<docstring>::const_iterator it = autonests_.begin();
1652 it != autonests_.end(); ++it) {
1653 if (it != autonests_.begin())
1657 os << "\n\tEndAutoNests\n";
1659 if (!autonested_by_.empty()) {
1660 os << "\tIsAutoNestedBy\n\t\t";
1661 for (set<docstring>::const_iterator it = autonested_by_.begin();
1662 it != autonested_by_.end(); ++it) {
1663 if (it != autonested_by_.begin())
1667 os << "\n\tEndIsAutoNestedBy\n";
1669 if (refprefix.empty())
1670 os << "\tRefPrefix OFF\n";
1672 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1673 if (!htmltag_.empty())
1674 os << "\tHTMLTag " << htmltag_ << '\n';
1675 if (!htmlattr_.empty())
1676 os << "\tHTMLAttr " << htmlattr_ << '\n';
1677 if (!htmlclass_.empty())
1678 os << "\tHTMLClass " << htmlclass_ << '\n';
1680 os << "\tHTMLInToc " << htmlintoc_ << '\n';
1681 if (!htmlitemtag_.empty())
1682 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1683 if (!htmlitemattr_.empty())
1684 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1685 if (!htmllabeltag_.empty())
1686 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1687 if (!htmllabelattr_.empty())
1688 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1689 os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1690 if (!htmlstyle_.empty())
1691 os << "\tHTMLStyle\n"
1692 << to_utf8(rtrim(htmlstyle_, "\n"))
1693 << "\n\tEndHTMLStyle\n";
1694 os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1695 if (!htmlpreamble_.empty())
1696 os << "\tHTMLPreamble\n"
1697 << to_utf8(rtrim(htmlpreamble_, "\n"))
1698 << "\n\tEndPreamble\n";
1699 os << "\tHTMLTitle " << htmltitle_ << "\n";
1700 if(!docbooktag_.empty())
1701 os << "\tDocBookTag " << docbooktag_ << '\n';
1702 if(!docbookattr_.empty())
1703 os << "\tDocBookAttr \"" << docbookattr_ << "\"\n";
1704 if(!docbooktagtype_.empty())
1705 os << "\tDocBookTagType " << docbooktagtype_ << '\n';
1706 if(!docbookinnertag_.empty())
1707 os << "\tDocBookInnerTag " << docbookinnertag_ << '\n';
1708 if(!docbookinnerattr_.empty())
1709 os << "\tDocBookInnerAttr \"" << docbookinnerattr_ << "\"\n";
1710 if(!docbookinnertagtype_.empty())
1711 os << "\tDocBookInnerTagType " << docbookinnertagtype_ << '\n';
1712 if(!docbookininfo_.empty())
1713 os << "\tDocBookInInfo " << docbookininfo_ << '\n';
1714 os << "\tDocBookAbstract " << docbookabstract_ << '\n';
1715 if(!docbookwrappertag_.empty())
1716 os << "\tDocBookWrapperTag " << docbookwrappertag_ << '\n';
1717 if(!docbookwrapperattr_.empty())
1718 os << "\tDocBookWrapperAttr " << docbookwrapperattr_ << '\n';
1719 if(!docbookwrappertagtype_.empty())
1720 os << "\tDocBookWrapperTagType " << docbookwrappertagtype_ << '\n';
1721 os << "\tDocBookSection " << docbooksection_ << '\n';
1722 if(!docbooksectiontag_.empty())
1723 os << "\tDocBookSectionTag " << docbooksectiontag_ << '\n';
1724 if(!docbookitemtag_.empty())
1725 os << "\tDocBookItemTag " << docbookitemtag_ << '\n';
1726 if(!docbookitemattr_.empty())
1727 os << "\tDocBookItemAttr " << docbookitemattr_ << '\n';
1728 if(!docbookitemtagtype_.empty())
1729 os << "\tDocBookItemTagType " << docbookitemtagtype_ << '\n';
1730 if(!docbookitemwrappertag_.empty())
1731 os << "\tDocBookItemWrapperTag " << docbookitemwrappertag_ << '\n';
1732 if(!docbookitemwrapperattr_.empty())
1733 os << "\tDocBookItemWrapperAttr " << docbookitemwrapperattr_ << '\n';
1734 if(!docbookitemwrappertagtype_.empty())
1735 os << "\tDocBookItemWrapperTagType " << docbookitemwrappertagtype_ << '\n';
1736 os << "\tDocBookWrapperMergeWithPrevious " << docbookwrappermergewithprevious_ << '\n';
1737 if(!docbookitemlabeltag_.empty())
1738 os << "\tDocBookItemLabelTag " << docbookitemlabeltag_ << '\n';
1739 if(!docbookitemlabelattr_.empty())
1740 os << "\tDocBookItemLabelAttr " << docbookitemlabelattr_ << '\n';
1741 if(!docbookitemlabeltagtype_.empty())
1742 os << "\tDocBookItemLabelTagType " << docbookitemlabeltagtype_ << '\n';
1743 if(!docbookiteminnertag_.empty())
1744 os << "\tDocBookItemInnerTag " << docbookiteminnertag_ << '\n';
1745 if(!docbookiteminnerattr_.empty())
1746 os << "\tDocBookItemInnerAttr " << docbookiteminnerattr_ << '\n';
1747 if(!docbookiteminnertagtype_.empty())
1748 os << "\tDocBookItemInnerTagType " << docbookiteminnertagtype_ << '\n';
1749 if(!docbookforceabstracttag_.empty())
1750 os << "\tDocBookForceAbstractTag " << docbookforceabstracttag_ << '\n';
1751 os << "\tDocBookNoFontInside " << docbooknofontinside_ << "\n"
1752 "\tSpellcheck " << spellcheck << "\n"
1753 "\tForceLocal " << forcelocal << "\n"
1758 bool Layout::hasArgs() const
1760 return !latexargs_.empty() || !postcommandargs_.empty() ||
1761 !itemargs_.empty() || !listpreamble_.empty();
1765 Layout::LaTeXArgMap Layout::args() const
1767 LaTeXArgMap args = latexargs_;
1768 if (!postcommandargs_.empty())
1769 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1770 if (!listpreamble_.empty())
1771 args.insert(listpreamble_.begin(), listpreamble_.end());
1772 if (!itemargs_.empty())
1773 args.insert(itemargs_.begin(), itemargs_.end());
1778 int Layout::optArgs() const
1781 LaTeXArgMap::const_iterator it = latexargs_.begin();
1782 for (; it != latexargs_.end(); ++it) {
1783 if (!(*it).second.mandatory)
1786 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1787 for (; iit != postcommandargs_.end(); ++iit) {
1788 if (!(*iit).second.mandatory)
1795 int Layout::requiredArgs() const
1798 LaTeXArgMap::const_iterator it = latexargs_.begin();
1799 for (; it != latexargs_.end(); ++it) {
1800 if ((*it).second.mandatory)
1803 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1804 for (; iit != postcommandargs_.end(); ++iit) {
1805 if (!(*iit).second.mandatory)
1812 string const & Layout::htmltag() const
1814 if (htmltag_.empty())
1820 string const & Layout::htmlclass() const
1822 // If it's an enumeration or itemize list, then we recalculate the class each
1823 // time through (unless it has been given explicitly). So we do nothing here.
1824 if (htmlclass_.empty() && labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
1825 htmlclass_ = defaultCSSClass();
1830 string const & Layout::htmlGetAttrString() const {
1831 if (!htmlfullattrs_.empty())
1832 return htmlfullattrs_;
1833 htmlfullattrs_ = htmlclass();
1834 if (!htmlfullattrs_.empty())
1835 htmlfullattrs_ = "class='" + htmlfullattrs_ + "'";
1836 if (!htmlattr_.empty())
1837 htmlfullattrs_ += " " + htmlattr_;
1838 return htmlfullattrs_;
1842 string const & Layout::htmlitemtag() const
1844 if (htmlitemtag_.empty())
1845 htmlitemtag_ = "div";
1846 return htmlitemtag_;
1850 string const & Layout::htmlitemattr() const
1852 if (htmlitemattr_.empty())
1853 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1854 return htmlitemattr_;
1858 string const & Layout::htmllabeltag() const
1860 if (htmllabeltag_.empty())
1861 htmllabeltag_ = "span";
1862 return htmllabeltag_;
1866 string const & Layout::htmllabelattr() const
1868 if (htmllabelattr_.empty())
1869 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1870 return htmllabelattr_;
1874 docstring Layout::htmlstyle() const
1876 if (!htmlstyle_.empty() && !htmlforcecss_)
1878 if (htmldefaultstyle_.empty())
1880 docstring retval = htmldefaultstyle_;
1881 if (!htmlstyle_.empty())
1882 retval += '\n' + htmlstyle_;
1887 string Layout::defaultCSSClass() const
1889 if (!defaultcssclass_.empty())
1890 return defaultcssclass_;
1892 docstring::const_iterator it = name().begin();
1893 docstring::const_iterator en = name().end();
1894 for (; it != en; ++it) {
1895 char_type const c = *it;
1896 if (!isAlphaASCII(c)) {
1898 // make sure we don't start with an underscore,
1899 // as that sometimes causes problems.
1900 d = from_ascii("lyx_");
1903 } else if (isLower(c))
1906 // this is slow, so do it only if necessary
1909 defaultcssclass_ = to_utf8(d);
1910 return defaultcssclass_;
1914 string const & Layout::docbooktag() const
1916 if (docbooktag_.empty()) {
1917 if (to_ascii(name_) == "Plain Layout")
1918 docbooktag_ = "para";
1919 else // No sensible default value, unhappily...
1920 docbooktag_ = to_utf8(name_);
1926 string const & Layout::docbookattr() const
1928 // Perfectly OK to return no attributes, so docbookattr_ does not need to be filled.
1929 return docbookattr_;
1933 bool isValidTagType(std::string const & type)
1935 return !(type.empty() || (type != "block" && type != "paragraph" && type != "inline"));
1939 string const & Layout::docbooktagtype() const
1941 if (!isValidTagType(docbooktagtype_))
1942 docbooktagtype_ = "block";
1943 return docbooktagtype_;
1947 string const & Layout::docbookinnertag() const
1949 if (docbookinnertag_.empty())
1950 docbookinnertag_ = "NONE";
1951 return docbookinnertag_;
1955 string const & Layout::docbookinnerattr() const
1957 return docbookinnerattr_;
1961 string const & Layout::docbookinnertagtype() const
1963 if (!isValidTagType(docbookinnertagtype_))
1964 docbookinnertagtype_ = "block";
1965 return docbookinnertagtype_;
1969 string const & Layout::docbookininfo() const
1971 // Indeed, a trilean. Only titles should be "maybe": otherwise, metadata is "always", content is "never".
1972 if (docbookininfo_.empty() || (docbookininfo_ != "never" && docbookininfo_ != "always" && docbookininfo_ != "maybe"))
1973 docbookininfo_ = "never";
1974 return docbookininfo_;
1978 string const & Layout::docbookwrappertag() const
1980 if (docbookwrappertag_.empty())
1981 docbookwrappertag_ = "NONE";
1982 return docbookwrappertag_;
1986 string const & Layout::docbookwrapperattr() const
1988 return docbookwrapperattr_;
1992 string const & Layout::docbookwrappertagtype() const
1994 if (!isValidTagType(docbookwrappertagtype_))
1995 docbookwrappertagtype_ = "block";
1996 return docbookwrappertagtype_;
2000 string const & Layout::docbooksectiontag() const
2002 if (docbooksectiontag_.empty())
2003 docbooksectiontag_ = "section";
2004 return docbooksectiontag_;
2008 string const & Layout::docbookitemwrappertag() const
2010 if (docbookitemwrappertag_.empty())
2011 docbookitemwrappertag_ = "NONE";
2012 return docbookitemwrappertag_;
2016 string const & Layout::docbookitemwrapperattr() const
2018 return docbookitemwrapperattr_;
2022 string const & Layout::docbookitemwrappertagtype() const
2024 if (!isValidTagType(docbookitemwrappertagtype_))
2025 docbookitemwrappertagtype_ = "block";
2026 return docbookitemwrappertagtype_;
2030 string const & Layout::docbookitemtag() const
2032 if (docbookitemtag_.empty())
2033 docbookitemtag_ = "NONE";
2034 return docbookitemtag_;
2038 string const & Layout::docbookitemattr() const
2040 return docbookitemattr_;
2044 string const & Layout::docbookitemtagtype() const
2046 if (!isValidTagType(docbookitemtagtype_))
2047 docbookitemtagtype_ = "block";
2048 return docbookitemtagtype_;
2052 string const & Layout::docbookitemlabeltag() const
2054 if (docbookitemlabeltag_.empty())
2055 docbookitemlabeltag_ = "NONE";
2056 return docbookitemlabeltag_;
2060 string const & Layout::docbookitemlabelattr() const
2062 return docbookitemlabelattr_;
2066 string const & Layout::docbookitemlabeltagtype() const
2068 if (!isValidTagType(docbookitemlabeltagtype_))
2069 docbookitemlabeltagtype_ = "block";
2070 return docbookitemlabeltagtype_;
2074 string const & Layout::docbookiteminnertag() const
2076 if (docbookiteminnertag_.empty())
2077 docbookiteminnertag_ = "NONE";
2078 return docbookiteminnertag_;
2082 string const & Layout::docbookiteminnerattr() const
2084 return docbookiteminnerattr_;
2088 string const & Layout::docbookiteminnertagtype() const
2090 if (!isValidTagType(docbookiteminnertagtype_))
2091 docbookiteminnertagtype_ = "block";
2092 return docbookiteminnertagtype_;
2096 std::string const & Layout::docbookforceabstracttag() const
2098 if (docbookforceabstracttag_.empty())
2099 docbookforceabstracttag_ = "NONE";
2100 return docbookforceabstracttag_;
2107 string makeMarginValue(char const * side, double d)
2110 os << "margin-" << side << ": " << d << "ex;\n";
2117 void Layout::makeDefaultCSS() const
2119 // this never needs to be redone, since reloading layouts will
2120 // wipe out what we did before.
2121 if (!htmldefaultstyle_.empty())
2125 htmldefaultstyle_ = font.asCSS();
2130 tmp += makeMarginValue("top", topsep);
2132 tmp += makeMarginValue("bottom", bottomsep);
2133 if (!leftmargin.empty()) {
2134 // we can't really do what LyX does with the margin, so
2135 // we'll just figure out how many characters it is
2136 int const len = leftmargin.length();
2137 tmp += makeMarginValue("left", len);
2139 if (!rightmargin.empty()) {
2140 int const len = rightmargin.length();
2141 tmp += makeMarginValue("right", len);
2145 if (!htmldefaultstyle_.empty())
2146 htmldefaultstyle_ += from_ascii("\n");
2147 htmldefaultstyle_ += from_ascii(tmp);
2151 string where = alignmentToCSS(align);
2152 if (!where.empty()) {
2153 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
2156 // wrap up what we have, if anything
2157 if (!htmldefaultstyle_.empty())
2159 from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
2160 htmldefaultstyle_ + from_ascii("\n}\n");
2162 if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
2168 if (labelfont != font)
2169 labelCSS = labelfont.asCSS() + from_ascii("\n");
2170 if (labeltype == LABEL_CENTERED)
2171 labelCSS += from_ascii("text-align: center;\n");
2173 if (!labelCSS.empty())
2174 htmldefaultstyle_ +=
2175 from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
2176 labelCSS + from_ascii("\n}\n");
2180 bool Layout::operator==(Layout const & rhs) const
2182 // This is enough for the applications we actually make,
2183 // at least at the moment. But we could check more.
2184 return name() == rhs.name()
2185 && latexname() == rhs.latexname()
2186 && latextype == rhs.latextype;