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,
145 LT_INTITLE // keep this last!
148 /////////////////////
151 : add_to_toc_(false), is_toc_caption_(true)
154 margintype = MARGIN_STATIC;
155 latextype = LATEX_PARAGRAPH;
156 resumecounter = false;
157 stepparentcounter = false;
161 needcprotect = false;
162 needmboxprotect = false;
165 labelfont = inherit_font;
167 reslabelfont = sane_font;
168 nextnoindent = false;
173 labelbottomsep = 0.0;
175 align = LYX_ALIGN_BLOCK;
176 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
177 labeltype = LABEL_NO_LABEL;
178 endlabeltype = END_LABEL_NO_LABEL;
179 // Should or should not. That is the question.
180 // spacing.set(Spacing::OneHalf);
181 newline_allowed = true;
182 free_spacing = false;
184 parbreak_is_newline = false;
185 toclevel = NOT_IN_TOC;
187 htmllabelfirst_ = false;
188 htmlforcecss_ = false;
190 docbookabstract_ = false;
191 docbookwrappermergewithprevious_ = false;
192 docbooksection_ = false;
195 itemcommand_ = "item";
196 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
201 bool Layout::read(Lexer & lex, TextClass const & tclass, bool validating)
203 // If this is an empty layout, or if no force local version is set,
204 // we know that we will not discard the stuff to read
206 return readIgnoreForcelocal(lex, tclass, validating);
209 bool const ret = tmp.readIgnoreForcelocal(lex, tclass, validating);
211 // - the read version is higher
212 // - both versions are infinity (arbitrary decision)
213 // - the file did not contain any local version (needed for not
214 // skipping user defined local layouts)
215 if (tmp.forcelocal <= 0 || tmp.forcelocal > forcelocal)
221 bool Layout::readIgnoreForcelocal(Lexer & lex, TextClass const & tclass,
224 // This table is sorted alphabetically [asierra 30March96]
225 LexerKeyword layoutTags[] = {
226 { "addtotoc", LT_ADDTOTOC },
227 { "align", LT_ALIGN },
228 { "alignpossible", LT_ALIGNPOSSIBLE },
229 { "argument", LT_ARGUMENT },
230 { "autonests", LT_AUTONESTS },
231 { "babelpreamble", LT_BABELPREAMBLE },
232 { "bottomsep", LT_BOTTOMSEP },
233 { "category", LT_CATEGORY },
234 { "commanddepth", LT_COMMANDDEPTH },
235 { "copystyle", LT_COPYSTYLE },
236 { "dependson", LT_DEPENDSON },
237 { "docbookabstract", LT_DOCBOOKABSTRACT },
238 { "docbookattr", LT_DOCBOOKATTR },
239 { "docbookforceabstracttag", LT_DOCBOOKFORCEABSTRACTTAG },
240 { "docbookininfo", LT_DOCBOOKININFO },
241 { "docbookinnerattr", LT_DOCBOOKINNERATTR },
242 { "docbookinnertag", LT_DOCBOOKINNERTAG },
243 { "docbookinnertagtype", LT_DOCBOOKINNERTAGTYPE },
244 { "docbookitemattr", LT_DOCBOOKITEMATTR },
245 { "docbookiteminnerattr", LT_DOCBOOKITEMINNERATTR },
246 { "docbookiteminnertag", LT_DOCBOOKITEMINNERTAG },
247 { "docbookiteminnertagtype", LT_DOCBOOKITEMINNERTAGTYPE },
248 { "docbookitemlabelattr", LT_DOCBOOKITEMLABELATTR },
249 { "docbookitemlabeltag", LT_DOCBOOKITEMLABELTAG },
250 { "docbookitemlabeltagtype", LT_DOCBOOKITEMLABELTAGTYPE },
251 { "docbookitemtag", LT_DOCBOOKITEMTAG },
252 { "docbookitemtagtype", LT_DOCBOOKITEMTAGTYPE },
253 { "docbookitemwrapperattr", LT_DOCBOOKITEMWRAPPERATTR },
254 { "docbookitemwrappertag", LT_DOCBOOKITEMWRAPPERTAG },
255 { "docbookitemwrappertagtype", LT_DOCBOOKITEMWRAPPERTAGTYPE },
256 { "docbooknofontinside", LT_DOCBOOKNOFONTINSIDE, },
257 { "docbooksection", LT_DOCBOOKSECTION },
258 { "docbooksectiontag", LT_DOCBOOKSECTIONTAG },
259 { "docbooktag", LT_DOCBOOKTAG },
260 { "docbooktagtype", LT_DOCBOOKTAGTYPE },
261 { "docbookwrapperattr", LT_DOCBOOKWRAPPERATTR },
262 { "docbookwrappermergewithprevious", LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS },
263 { "docbookwrappertag", LT_DOCBOOKWRAPPERTAG },
264 { "docbookwrappertagtype", LT_DOCBOOKWRAPPERTAGTYPE },
266 { "endlabelstring", LT_ENDLABELSTRING },
267 { "endlabeltype", LT_ENDLABELTYPE },
269 { "forcelocal", LT_FORCELOCAL },
270 { "freespacing", LT_FREE_SPACING },
271 { "htmlattr", LT_HTMLATTR },
272 { "htmlforcecss", LT_HTMLFORCECSS },
273 { "htmlitem", LT_HTMLITEM },
274 { "htmlitemattr", LT_HTMLITEMATTR },
275 { "htmllabel", LT_HTMLLABEL },
276 { "htmllabelattr", LT_HTMLLABELATTR },
277 { "htmllabelfirst", LT_HTMLLABELFIRST },
278 { "htmlpreamble", LT_HTMLPREAMBLE },
279 { "htmlstyle", LT_HTMLSTYLE },
280 { "htmltag", LT_HTMLTAG },
281 { "htmltitle", LT_HTMLTITLE },
282 { "innertag", LT_INNERTAG },
283 { "inpreamble", LT_INPREAMBLE },
284 { "intitle", LT_INTITLE },
285 { "isautonestedby", LT_AUTONESTEDBY },
286 { "istoccaption", LT_ISTOCCAPTION },
287 { "itemcommand", LT_ITEMCOMMAND },
288 { "itemsep", LT_ITEMSEP },
289 { "itemtag", LT_ITEMTAG },
290 { "keepempty", LT_KEEPEMPTY },
291 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
292 { "labelcounter", LT_LABELCOUNTER },
293 { "labelfont", LT_LABELFONT },
294 { "labelindent", LT_LABELINDENT },
295 { "labelsep", LT_LABELSEP },
296 { "labelstring", LT_LABELSTRING },
297 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
298 { "labeltag", LT_LABELTAG },
299 { "labeltype", LT_LABELTYPE },
300 { "langpreamble", LT_LANGPREAMBLE },
301 { "latexname", LT_LATEXNAME },
302 { "latexparam", LT_LATEXPARAM },
303 { "latextype", LT_LATEXTYPE },
304 { "leftdelim", LT_LEFTDELIM },
305 { "leftmargin", LT_LEFTMARGIN },
306 { "margin", LT_MARGIN },
307 { "needcprotect", LT_NEED_CPROTECT },
308 { "needmboxprotect", LT_NEED_MBOXPROTECT },
309 { "needprotect", LT_NEED_PROTECT },
310 { "newline", LT_NEWLINE },
311 { "nextnoindent", LT_NEXTNOINDENT },
312 { "obsoletedby", LT_OBSOLETEDBY },
313 { "paragraphgroup", LT_PAR_GROUP },
314 { "parbreakisnewline", LT_PARBREAK_IS_NEWLINE },
315 { "parindent", LT_PARINDENT },
316 { "parsep", LT_PARSEP },
317 { "parskip", LT_PARSKIP },
318 { "passthru", LT_PASS_THRU },
319 { "passthruchars", LT_PASS_THRU_CHARS },
320 { "preamble", LT_PREAMBLE },
321 { "refprefix", LT_REFPREFIX },
322 { "requires", LT_REQUIRES },
323 { "resetargs", LT_RESETARGS },
324 { "resumecounter", LT_RESUMECOUNTER },
325 { "rightdelim", LT_RIGHTDELIM },
326 { "rightmargin", LT_RIGHTMARGIN },
327 { "spacing", LT_SPACING },
328 { "spellcheck", LT_SPELLCHECK },
329 { "stepparentcounter", LT_STEPPARENTCOUNTER },
330 { "textfont", LT_TEXTFONT },
331 { "toclevel", LT_TOCLEVEL },
332 { "toggleindent", LT_TOGGLE_INDENT },
333 { "topsep", LT_TOPSEP }
337 bool finished = false;
338 lex.pushTable(layoutTags);
340 // parse style section
341 while (!finished && lex.isOK() && !error) {
343 // See comment in LyXRC.cpp.
345 case Lexer::LEX_FEOF:
348 case Lexer::LEX_UNDEF:
350 lex.printError("Unknown layout tag `$$Token'");
357 switch (static_cast<LayoutTags>(le)) {
369 style = subst(style, '_', ' ');
371 if (tclass.hasLayout(style)) {
372 docstring const tmpname = name_;
373 this->operator=(tclass[style]);
376 LYXERR0("Cannot copy unknown style `"
378 << "All layouts so far:");
379 DocumentClass::const_iterator lit = tclass.begin();
380 DocumentClass::const_iterator len = tclass.end();
381 for (; lit != len; ++lit)
382 LYXERR0(lit->name());
387 case LT_OBSOLETEDBY: {
390 style = subst(style, '_', ' ');
392 if (tclass.hasLayout(style)) {
393 docstring const tmpname = name_;
394 this->operator=(tclass[style]);
396 if (obsoleted_by().empty())
397 obsoleted_by_ = style;
399 LYXERR0("Cannot replace with unknown style `"
402 //lex.printError("Cannot replace with"
411 depends_on_ = subst(depends_on_, '_', ' ');
440 postcommandargs_.clear();
441 listpreamble_.clear();
445 case LT_RESUMECOUNTER:
446 lex >> resumecounter;
449 case LT_STEPPARENTCOUNTER:
450 lex >> stepparentcounter;
454 readArgument(lex, validating);
457 case LT_NEED_PROTECT:
461 case LT_NEED_CPROTECT:
465 case LT_NEED_MBOXPROTECT:
466 lex >> needmboxprotect;
474 font = lyxRead(lex, font);
479 font = lyxRead(lex, font);
483 labelfont = lyxRead(lex, labelfont);
486 case LT_NEXTNOINDENT:
490 case LT_TOGGLE_INDENT: {
493 tog = support::ascii_lowercase(tog);
495 toggle_indent = ITOGGLE_ALWAYS;
496 else if (tog == "never")
497 toggle_indent = ITOGGLE_NEVER;
499 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
503 case LT_COMMANDDEPTH:
513 latexparam_ = subst(latexparam_, """, "\"");
518 leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
524 rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
545 preamble_ = lex.getLongString(from_ascii("EndPreamble"));
548 case LT_LANGPREAMBLE:
549 langpreamble_ = lex.getLongString(from_ascii("EndLangPreamble"));
552 case LT_BABELPREAMBLE:
553 babelpreamble_ = lex.getLongString(from_ascii("EndBabelPreamble"));
560 case LT_ENDLABELTYPE:
561 readEndLabelType(lex);
596 case LT_LABEL_BOTTOMSEP:
597 lex >> labelbottomsep;
602 labelsep = subst(labelsep, 'x', ' ');
610 lex >> newline_allowed;
617 case LT_ALIGNPOSSIBLE:
618 readAlignPossible(lex);
622 // FIXME: this means LT_LABELSTRING_APPENDIX may only
623 // occur after LT_LABELSTRING
625 labelstring_appendix_ = labelstring_;
628 case LT_ENDLABELSTRING:
629 lex >> endlabelstring_;
632 case LT_LABELSTRING_APPENDIX:
633 lex >> labelstring_appendix_;
636 case LT_LABELCOUNTER:
644 case LT_FREE_SPACING:
652 case LT_PASS_THRU_CHARS:
653 lex >> pass_thru_chars;
656 case LT_PARBREAK_IS_NEWLINE:
657 lex >> parbreak_is_newline;
666 vector<string> const req =
667 getVectorFromString(lex.getString(true));
668 required_.insert(req.begin(), req.end());
673 docstring autonest = lex.getLongString(from_ascii("EndAutoNests"));
674 autonest = subst(autonest, from_ascii("\n"), docstring());
675 autonest = subst(autonest, from_ascii("\t"), docstring());
676 autonest = subst(autonest, from_ascii("\""), docstring());
677 autonest = subst(autonest, '_', ' ');
678 vector<docstring> const autonests =
679 getVectorFromString(autonest, from_ascii(","), false, true);
680 autonests_.insert(autonests.begin(), autonests.end());
684 case LT_AUTONESTEDBY: {
685 docstring autonest = lex.getLongString(from_ascii("EndIsAutoNestedBy"));
686 autonest = subst(autonest, from_ascii("\n"), docstring());
687 autonest = subst(autonest, from_ascii("\t"), docstring());
688 autonest = subst(autonest, from_ascii("\""), docstring());
689 autonest = subst(autonest, '_', ' ');
690 vector<docstring> const autonests =
691 getVectorFromString(autonest, from_ascii(","), false, true);
692 autonested_by_.insert(autonests.begin(), autonests.end());
718 case LT_HTMLITEMATTR:
719 lex >> htmlitemattr_;
723 lex >> htmllabeltag_;
726 case LT_HTMLLABELATTR:
727 lex >> htmllabelattr_;
730 case LT_HTMLLABELFIRST:
731 lex >> htmllabelfirst_;
735 htmlstyle_ = lex.getLongString(from_ascii("EndHTMLStyle"));
738 case LT_HTMLFORCECSS:
739 lex >> htmlforcecss_;
742 case LT_HTMLPREAMBLE:
743 htmlpreamble_ = lex.getLongString(from_ascii("EndPreamble"));
758 case LT_DOCBOOKTAGTYPE:
759 lex >> docbooktagtype_;
762 case LT_DOCBOOKINNERTAG:
763 lex >> docbookinnertag_;
766 case LT_DOCBOOKINNERATTR:
767 lex >> docbookinnerattr_;
770 case LT_DOCBOOKINNERTAGTYPE:
771 lex >> docbookinnertagtype_;
774 case LT_DOCBOOKFORCEABSTRACTTAG:
775 lex >> docbookforceabstracttag_;
778 case LT_DOCBOOKININFO:
779 lex >> docbookininfo_;
782 case LT_DOCBOOKABSTRACT:
783 lex >> docbookabstract_;
786 case LT_DOCBOOKWRAPPERTAG:
787 lex >> docbookwrappertag_;
790 case LT_DOCBOOKWRAPPERATTR:
791 lex >> docbookwrapperattr_;
794 case LT_DOCBOOKWRAPPERTAGTYPE:
795 lex >> docbookwrappertagtype_;
798 case LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS:
799 lex >> docbookwrappermergewithprevious_;
802 case LT_DOCBOOKSECTION:
803 lex >> docbooksection_;
806 case LT_DOCBOOKSECTIONTAG:
807 lex >> docbooksectiontag_;
810 case LT_DOCBOOKITEMWRAPPERTAG:
811 lex >> docbookitemwrappertag_;
814 case LT_DOCBOOKITEMWRAPPERATTR:
815 lex >> docbookitemwrapperattr_;
818 case LT_DOCBOOKITEMWRAPPERTAGTYPE:
819 lex >> docbookitemwrappertagtype_;
822 case LT_DOCBOOKITEMTAG:
823 lex >> docbookitemtag_;
826 case LT_DOCBOOKITEMATTR:
827 lex >> docbookitemattr_;
830 case LT_DOCBOOKITEMTAGTYPE:
831 lex >> docbookitemtagtype_;
834 case LT_DOCBOOKITEMLABELTAG:
835 lex >> docbookitemlabeltag_;
838 case LT_DOCBOOKITEMLABELATTR:
839 lex >> docbookitemlabelattr_;
842 case LT_DOCBOOKITEMLABELTAGTYPE:
843 lex >> docbookitemlabeltagtype_;
846 case LT_DOCBOOKITEMINNERTAG:
847 lex >> docbookiteminnertag_;
850 case LT_DOCBOOKITEMINNERATTR:
851 lex >> docbookiteminnerattr_;
854 case LT_DOCBOOKITEMINNERTAGTYPE:
855 lex >> docbookiteminnertagtype_;
858 case LT_DOCBOOKNOFONTINSIDE:
859 lex >> docbooknofontinside_;
872 add_to_toc_ = !toc_type_.empty();
875 case LT_ISTOCCAPTION:
876 lex >> is_toc_caption_;
882 // make sure we only have inpreamble = true for commands
883 if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
884 LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
885 LYXERR0("Layout name: " << name());
889 return finished && !error;
902 LexerKeyword alignTags[] = {
903 { "block", AT_BLOCK },
904 { "center", AT_CENTER },
905 { "layout", AT_LAYOUT },
907 { "right", AT_RIGHT }
911 void Layout::readAlign(Lexer & lex)
913 PushPopHelper pph(lex, alignTags);
916 case Lexer::LEX_UNDEF:
917 lex.printError("Unknown alignment `$$Token'");
923 align = LYX_ALIGN_BLOCK;
926 align = LYX_ALIGN_LEFT;
929 align = LYX_ALIGN_RIGHT;
932 align = LYX_ALIGN_CENTER;
935 align = LYX_ALIGN_LAYOUT;
941 void Layout::readAlignPossible(Lexer & lex)
943 lex.pushTable(alignTags);
944 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
945 int lineno = lex.lineNumber();
949 case Lexer::LEX_UNDEF:
950 lex.printError("Unknown alignment `$$Token'");
956 alignpossible |= LYX_ALIGN_BLOCK;
959 alignpossible |= LYX_ALIGN_LEFT;
962 alignpossible |= LYX_ALIGN_RIGHT;
965 alignpossible |= LYX_ALIGN_CENTER;
968 alignpossible |= LYX_ALIGN_LAYOUT;
971 } while (lineno == lex.lineNumber());
976 void Layout::readLabelType(Lexer & lex)
991 LexerKeyword labelTypeTags[] = {
992 { "above", LA_ABOVE },
993 { "bibliography", LA_BIBLIO },
994 { "centered", LA_CENTERED },
995 { "enumerate", LA_ENUMERATE },
996 { "itemize", LA_ITEMIZE },
997 { "manual", LA_MANUAL },
998 { "no_label", LA_NO_LABEL },
999 { "sensitive", LA_SENSITIVE },
1000 { "static", LA_STATIC }
1003 PushPopHelper pph(lex, labelTypeTags);
1006 case Lexer::LEX_UNDEF:
1007 lex.printError("Unknown labeltype tag `$$Token'");
1013 labeltype = LABEL_NO_LABEL;
1016 labeltype = LABEL_MANUAL;
1019 labeltype = LABEL_ABOVE;
1022 labeltype = LABEL_CENTERED;
1025 labeltype = LABEL_STATIC;
1028 labeltype = LABEL_SENSITIVE;
1031 labeltype = LABEL_ENUMERATE;
1034 labeltype = LABEL_ITEMIZE;
1037 labeltype = LABEL_BIBLIO;
1043 void Layout::readEndLabelType(Lexer & lex)
1045 // this should be const, but can't be because
1046 // of PushPopHelper.
1047 static LexerKeyword endlabelTypeTags[] = {
1048 { "box", END_LABEL_BOX },
1049 { "filled_box", END_LABEL_FILLED_BOX },
1050 { "no_label", END_LABEL_NO_LABEL },
1051 { "static", END_LABEL_STATIC }
1054 PushPopHelper pph(lex, endlabelTypeTags);
1057 case Lexer::LEX_UNDEF:
1058 lex.printError("Unknown labeltype tag `$$Token'");
1060 case END_LABEL_STATIC:
1062 case END_LABEL_FILLED_BOX:
1063 case END_LABEL_NO_LABEL:
1064 endlabeltype = static_cast<EndLabelType>(le);
1067 LYXERR0("Unhandled value " << le);
1073 void Layout::readMargin(Lexer & lex)
1075 LexerKeyword marginTags[] = {
1076 { "dynamic", MARGIN_DYNAMIC },
1077 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
1078 { "manual", MARGIN_MANUAL },
1079 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
1080 { "static", MARGIN_STATIC }
1083 PushPopHelper pph(lex, marginTags);
1087 case Lexer::LEX_UNDEF:
1088 lex.printError("Unknown margin type tag `$$Token'");
1092 case MARGIN_DYNAMIC:
1093 case MARGIN_FIRST_DYNAMIC:
1094 case MARGIN_RIGHT_ADDRESS_BOX:
1095 margintype = static_cast<MarginType>(le);
1098 LYXERR0("Unhandled value " << le);
1104 void Layout::readLatexType(Lexer & lex)
1106 LexerKeyword latexTypeTags[] = {
1107 { "bib_environment", LATEX_BIB_ENVIRONMENT },
1108 { "command", LATEX_COMMAND },
1109 { "environment", LATEX_ENVIRONMENT },
1110 { "item_environment", LATEX_ITEM_ENVIRONMENT },
1111 { "list_environment", LATEX_LIST_ENVIRONMENT },
1112 { "paragraph", LATEX_PARAGRAPH }
1115 PushPopHelper pph(lex, latexTypeTags);
1118 case Lexer::LEX_UNDEF:
1119 lex.printError("Unknown latextype tag `$$Token'");
1121 case LATEX_PARAGRAPH:
1123 case LATEX_ITEM_ENVIRONMENT:
1124 case LATEX_LIST_ENVIRONMENT:
1125 latextype = static_cast<LatexType>(le);
1127 case LATEX_ENVIRONMENT:
1128 case LATEX_BIB_ENVIRONMENT:
1129 latextype = static_cast<LatexType>(le);
1133 LYXERR0("Unhandled value " << le);
1139 void Layout::readSpacing(Lexer & lex)
1142 ST_SPACING_SINGLE = 1,
1148 LexerKeyword spacingTags[] = {
1149 {"double", ST_SPACING_DOUBLE },
1150 {"onehalf", ST_SPACING_ONEHALF },
1151 {"other", ST_OTHER },
1152 {"single", ST_SPACING_SINGLE }
1155 PushPopHelper pph(lex, spacingTags);
1158 case Lexer::LEX_UNDEF:
1159 lex.printError("Unknown spacing token `$$Token'");
1164 case ST_SPACING_SINGLE:
1165 spacing.set(Spacing::Single);
1167 case ST_SPACING_ONEHALF:
1168 spacing.set(Spacing::Onehalf);
1170 case ST_SPACING_DOUBLE:
1171 spacing.set(Spacing::Double);
1175 spacing.set(Spacing::Other, lex.getString());
1181 void Layout::readArgument(Lexer & lex, bool validating)
1184 LYXERR0("Unable to read argument ID!");
1187 string const id = lex.getString();
1189 bool const itemarg = prefixIs(id, "item:");
1190 bool const postcmd = prefixIs(id, "post:");
1191 bool const listpreamble = prefixIs(id, "listpreamble:");
1193 LaTeXArgMap & lam = itemarg ? itemargs_ :
1194 (postcmd ? postcommandargs_ :
1195 (listpreamble ? listpreamble_ :
1197 latexarg & arg = lam[id];
1200 // list preamble has no delimiters by default
1201 arg.nodelims = true;
1204 bool finished = false;
1205 while (!finished && lex.isOK() && !error) {
1207 string const tok = ascii_lowercase(lex.getString());
1211 } else if (tok == "endargument") {
1213 } else if (tok == "labelstring") {
1215 arg.labelstring = lex.getDocString();
1216 } else if (tok == "menustring") {
1218 arg.menustring = lex.getDocString();
1219 } else if (tok == "mandatory") {
1221 arg.mandatory = lex.getBool();
1222 } else if (tok == "autoinsert") {
1224 arg.autoinsert = lex.getBool();
1225 } else if (tok == "insertcotext") {
1227 arg.insertcotext = lex.getBool();
1228 } else if (tok == "leftdelim") {
1230 arg.ldelim = lex.getDocString();
1231 arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
1233 } else if (tok == "rightdelim") {
1235 arg.rdelim = lex.getDocString();
1236 arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
1238 } else if (tok == "defaultarg") {
1240 arg.defaultarg = lex.getDocString();
1241 } else if (tok == "presetarg") {
1243 arg.presetarg = lex.getDocString();
1244 } else if (tok == "tooltip") {
1246 arg.tooltip = lex.getDocString();
1247 } else if (tok == "requires") {
1249 arg.required = lex.getString();
1250 } else if (tok == "decoration") {
1252 arg.decoration = lex.getString();
1253 } else if (tok == "newlinecmd") {
1255 arg.newlinecmd = lex.getString();
1256 } else if (tok == "font") {
1257 arg.font = lyxRead(lex, arg.font);
1258 } else if (tok == "labelfont") {
1259 arg.labelfont = lyxRead(lex, arg.labelfont);
1260 } else if (tok == "passthruchars") {
1262 arg.pass_thru_chars = lex.getDocString();
1263 } else if (tok == "passthru") {
1265 docstring value = lex.getDocString();
1266 if (value == "true" || value == "1")
1267 arg.passthru = PT_TRUE;
1268 else if (value == "false" || value == "0")
1269 arg.passthru = PT_FALSE;
1271 arg.passthru = PT_INHERITED;
1272 } else if (tok == "istoccaption") {
1274 arg.is_toc_caption = lex.getBool();
1275 } else if (tok == "freespacing") {
1277 arg.free_spacing = lex.getBool();
1278 } else if (tok == "docbooktag") {
1280 arg.docbooktag = lex.getDocString();
1281 } else if (tok == "docbookattr") {
1283 arg.docbookattr = lex.getDocString();
1284 } else if (tok == "docbooktagtype") {
1286 arg.docbooktagtype = lex.getDocString();
1288 lex.printError("Unknown tag");
1292 if (!validating && arg.labelstring.empty()) {
1293 LYXERR0("Incomplete Argument definition!");
1294 // remove invalid definition
1300 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1302 os << "\tArgument " << id << '\n';
1303 if (!arg.labelstring.empty())
1304 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1305 if (!arg.menustring.empty())
1306 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1308 os << "\t\tMandatory " << arg.mandatory << '\n';
1310 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1311 if (arg.insertcotext)
1312 os << "\t\tInsertCotext " << arg.insertcotext << '\n';
1313 if (!arg.ldelim.empty())
1314 os << "\t\tLeftDelim \""
1315 << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1317 if (!arg.rdelim.empty())
1318 os << "\t\tRightDelim \""
1319 << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1321 if (!arg.defaultarg.empty())
1322 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1323 if (!arg.presetarg.empty())
1324 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1325 if (!arg.tooltip.empty())
1326 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1327 if (!arg.required.empty())
1328 os << "\t\tRequires \"" << arg.required << "\"\n";
1329 if (!arg.decoration.empty())
1330 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1331 if (!arg.newlinecmd.empty())
1332 os << "\t\tNewlineCmd \"" << arg.newlinecmd << "\"\n";
1333 if (arg.font != inherit_font)
1334 lyxWrite(os, arg.font, "Font", 2);
1335 if (arg.labelfont != inherit_font)
1336 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1337 switch (arg.passthru) {
1339 os << "\t\tPassThru true\n";
1342 os << "\t\tPassThru false\n";
1345 os << "\t\tPassThru inherited\n";
1348 if (!arg.pass_thru_chars.empty())
1349 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1350 if (arg.free_spacing)
1351 os << "\t\tFreeSpacing " << arg.free_spacing << "\n";
1352 os << "\tEndArgument\n";
1356 void Layout::write(ostream & os) const
1358 os << "Style \"" << to_utf8(name_) << "\"\n";
1359 if (!category_.empty() && obsoleted_by_.empty())
1360 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1361 // Can't deduce Copystyle here :-(
1362 if (!obsoleted_by_.empty()) {
1363 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1367 if (!depends_on_.empty())
1368 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1369 switch (margintype) {
1370 case MARGIN_DYNAMIC:
1371 os << "\tMargin Dynamic\n";
1373 case MARGIN_FIRST_DYNAMIC:
1374 os << "\tMargin First_Dynamic\n";
1377 os << "\tMargin Manual\n";
1379 case MARGIN_RIGHT_ADDRESS_BOX:
1380 os << "\tMargin Right_Address_Box\n";
1383 os << "\tMargin Static\n";
1386 switch (latextype) {
1387 case LATEX_BIB_ENVIRONMENT:
1388 os << "\tLatexType Bib_Environment\n";
1391 os << "\tLatexType Command\n";
1393 case LATEX_ENVIRONMENT:
1394 os << "\tLatexType Environment\n";
1396 case LATEX_ITEM_ENVIRONMENT:
1397 os << "\tLatexType Item_Environment\n";
1399 case LATEX_LIST_ENVIRONMENT:
1400 os << "\tLatexType List_Environment\n";
1402 case LATEX_PARAGRAPH:
1403 os << "\tLatexType Paragraph\n";
1406 os << "\tInTitle " << intitle << "\n"
1407 "\tInPreamble " << inpreamble << "\n"
1408 "\tTocLevel " << toclevel << "\n"
1409 "\tResumeCounter " << resumecounter << "\n"
1410 "\tStepParentCounter " << stepparentcounter << '\n';
1411 // ResetArgs does not make sense here
1412 for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1413 it != latexargs_.end(); ++it)
1414 writeArgument(os, it->first, it->second);
1415 for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1416 it != itemargs_.end(); ++it)
1417 writeArgument(os, it->first, it->second);
1418 for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1419 it != postcommandargs_.end(); ++it)
1420 writeArgument(os, it->first, it->second);
1421 for (LaTeXArgMap::const_iterator it = listpreamble_.begin();
1422 it != listpreamble_.end(); ++it)
1423 writeArgument(os, it->first, it->second);
1424 os << "\tNeedProtect " << needprotect << "\n"
1425 "\tNeedCProtect " << needcprotect << "\n"
1426 "\tNeedMBoxProtect " << needmboxprotect << "\n"
1427 "\tKeepEmpty " << keepempty << '\n';
1428 if (labelfont == font)
1429 lyxWrite(os, font, "Font", 1);
1431 lyxWrite(os, font, "TextFont", 1);
1432 lyxWrite(os, labelfont, "LabelFont", 1);
1434 os << "\tNextNoIndent " << nextnoindent << "\n"
1435 "\tCommandDepth " << commanddepth << '\n';
1436 if (!latexname_.empty())
1437 os << "\tLatexName \"" << latexname_ << "\"\n";
1438 if (!latexparam_.empty())
1439 os << "\tLatexParam \"" << subst(latexparam_, "\"", """)
1441 if (!leftdelim_.empty())
1442 os << "\tLeftDelim "
1443 << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1445 if (!rightdelim_.empty())
1446 os << "\tRightDelim "
1447 << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1449 if (!innertag_.empty())
1450 os << "\tInnerTag \"" << innertag_ << "\"\n";
1451 if (!labeltag_.empty())
1452 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1453 if (!itemtag_.empty())
1454 os << "\tItemTag \"" << itemtag_ << "\"\n";
1455 if (!itemcommand_.empty())
1456 os << "\tItemCommand " << itemcommand_ << '\n';
1457 if (!preamble_.empty())
1458 os << "\tPreamble\n\t"
1459 << to_utf8(subst(rtrim(preamble_, "\n"),
1460 from_ascii("\n"), from_ascii("\n\t")))
1461 << "\n\tEndPreamble\n";
1462 if (!langpreamble_.empty())
1463 os << "\tLangPreamble\n\t"
1464 << to_utf8(subst(rtrim(langpreamble_, "\n"),
1465 from_ascii("\n"), from_ascii("\n\t")))
1466 << "\n\tEndLangPreamble\n";
1467 if (!babelpreamble_.empty())
1468 os << "\tBabelPreamble\n\t"
1469 << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1470 from_ascii("\n"), from_ascii("\n\t")))
1471 << "\n\tEndBabelPreamble\n";
1472 switch (labeltype) {
1474 os << "\tLabelType Above\n";
1477 os << "\tLabelType Bibliography\n";
1479 case LABEL_CENTERED:
1480 os << "\tLabelType Centered\n";
1482 case LABEL_ENUMERATE:
1483 os << "\tLabelType Enumerate\n";
1486 os << "\tLabelType Itemize\n";
1489 os << "\tLabelType Manual\n";
1491 case LABEL_NO_LABEL:
1492 os << "\tLabelType No_Label\n";
1494 case LABEL_SENSITIVE:
1495 os << "\tLabelType Sensitive\n";
1498 os << "\tLabelType Static\n";
1501 switch (endlabeltype) {
1503 os << "\tEndLabelType Box\n";
1505 case END_LABEL_FILLED_BOX:
1506 os << "\tEndLabelType Filled_Box\n";
1508 case END_LABEL_NO_LABEL:
1509 os << "\tEndLabelType No_Label\n";
1511 case END_LABEL_STATIC:
1512 os << "\tEndLabelType Static\n";
1515 os << "\tParagraphGroup \"" << par_group_ << "\"\n";
1516 if (!leftmargin.empty())
1517 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1518 if (!rightmargin.empty())
1519 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1520 if (!labelindent.empty())
1521 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1522 if (!parindent.empty())
1523 os << "\tParIndent " << to_utf8(parindent) << '\n';
1524 os << "\tParSkip " << parskip << "\n"
1525 "\tItemSep " << itemsep << "\n"
1526 "\tTopSep " << topsep << "\n"
1527 "\tBottomSep " << bottomsep << "\n"
1528 "\tLabelBottomSep " << labelbottomsep << '\n';
1529 if (!labelsep.empty())
1530 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1532 os << "\tParSep " << parsep << "\n"
1533 "\tNewLine " << newline_allowed << '\n';
1535 case LYX_ALIGN_BLOCK:
1536 os << "\tAlign Block\n";
1538 case LYX_ALIGN_CENTER:
1539 os << "\tAlign Center\n";
1541 case LYX_ALIGN_LAYOUT:
1542 os << "\tAlign Layout\n";
1544 case LYX_ALIGN_LEFT:
1545 os << "\tAlign Left\n";
1547 case LYX_ALIGN_RIGHT:
1548 os << "\tAlign Right\n";
1550 case LYX_ALIGN_DECIMAL:
1551 case LYX_ALIGN_SPECIAL:
1552 case LYX_ALIGN_NONE:
1555 if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1556 LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1558 os << "\tAlignPossible";
1559 if (alignpossible & LYX_ALIGN_BLOCK) {
1563 if (alignpossible & LYX_ALIGN_CENTER) {
1569 if (alignpossible & LYX_ALIGN_LAYOUT) {
1575 if (alignpossible & LYX_ALIGN_LEFT) {
1581 if (alignpossible & LYX_ALIGN_RIGHT) {
1589 // LabelString must come before LabelStringAppendix
1590 if (!labelstring_.empty())
1591 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1592 if (!endlabelstring_.empty())
1593 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1594 if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1595 os << "\tLabelStringAppendix \""
1596 << to_utf8(labelstring_appendix_) << "\"\n";
1597 if (!counter.empty())
1598 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1599 os << "\tFreeSpacing " << free_spacing << '\n';
1600 os << "\tPassThru " << pass_thru << '\n';
1601 if (!pass_thru_chars.empty())
1602 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1603 os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1604 switch (spacing.getSpace()) {
1605 case Spacing::Double:
1606 os << "\tSpacing Double\n";
1608 case Spacing::Onehalf:
1609 os << "\tSpacing Onehalf\n";
1611 case Spacing::Other:
1612 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1614 case Spacing::Single:
1615 os << "\tSpacing Single\n";
1617 case Spacing::Default:
1620 if (!required_.empty()) {
1621 os << "\tRequires ";
1622 for (set<string>::const_iterator it = required_.begin();
1623 it != required_.end(); ++it) {
1624 if (it != required_.begin())
1630 if (!autonests_.empty()) {
1631 os << "\tAutoNests\n\t";
1632 for (set<docstring>::const_iterator it = autonests_.begin();
1633 it != autonests_.end(); ++it) {
1634 if (it != autonests_.begin())
1638 os << "\n\tEndAutoNests\n";
1640 if (!autonested_by_.empty()) {
1641 os << "\tIsAutoNestedBy\n\t\t";
1642 for (set<docstring>::const_iterator it = autonested_by_.begin();
1643 it != autonested_by_.end(); ++it) {
1644 if (it != autonested_by_.begin())
1648 os << "\n\tEndIsAutoNestedBy\n";
1650 if (refprefix.empty())
1651 os << "\tRefPrefix OFF\n";
1653 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1654 if (!htmltag_.empty())
1655 os << "\tHTMLTag " << htmltag_ << '\n';
1656 if (!htmlattr_.empty())
1657 os << "\tHTMLAttr " << htmlattr_ << '\n';
1658 if (!htmlitemtag_.empty())
1659 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1660 if (!htmlitemattr_.empty())
1661 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1662 if (!htmllabeltag_.empty())
1663 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1664 if (!htmllabelattr_.empty())
1665 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1666 os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1667 if (!htmlstyle_.empty())
1668 os << "\tHTMLStyle\n"
1669 << to_utf8(rtrim(htmlstyle_, "\n"))
1670 << "\n\tEndHTMLStyle\n";
1671 os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1672 if (!htmlpreamble_.empty())
1673 os << "\tHTMLPreamble\n"
1674 << to_utf8(rtrim(htmlpreamble_, "\n"))
1675 << "\n\tEndPreamble\n";
1676 os << "\tHTMLTitle " << htmltitle_ << "\n";
1677 if(!docbooktag_.empty())
1678 os << "\tDocBookTag " << docbooktag_ << '\n';
1679 if(!docbookattr_.empty())
1680 os << "\tDocBookAttr \"" << docbookattr_ << "\"\n";
1681 if(!docbooktagtype_.empty())
1682 os << "\tDocBookTagType " << docbooktagtype_ << '\n';
1683 if(!docbookinnertag_.empty())
1684 os << "\tDocBookInnerTag " << docbookinnertag_ << '\n';
1685 if(!docbookinnerattr_.empty())
1686 os << "\tDocBookInnerAttr \"" << docbookinnerattr_ << "\"\n";
1687 if(!docbookinnertagtype_.empty())
1688 os << "\tDocBookInnerTagType " << docbookinnertagtype_ << '\n';
1689 if(!docbookininfo_.empty())
1690 os << "\tDocBookInInfo " << docbookininfo_ << '\n';
1691 os << "\tDocBookAbstract " << docbookabstract_ << '\n';
1692 if(!docbookwrappertag_.empty())
1693 os << "\tDocBookWrapperTag " << docbookwrappertag_ << '\n';
1694 if(!docbookwrapperattr_.empty())
1695 os << "\tDocBookWrapperAttr " << docbookwrapperattr_ << '\n';
1696 if(!docbookwrappertagtype_.empty())
1697 os << "\tDocBookWrapperTagType " << docbookwrappertagtype_ << '\n';
1698 os << "\tDocBookSection " << docbooksection_ << '\n';
1699 if(!docbooksectiontag_.empty())
1700 os << "\tDocBookSectionTag " << docbooksectiontag_ << '\n';
1701 if(!docbookitemtag_.empty())
1702 os << "\tDocBookItemTag " << docbookitemtag_ << '\n';
1703 if(!docbookitemattr_.empty())
1704 os << "\tDocBookItemAttr " << docbookitemattr_ << '\n';
1705 if(!docbookitemtagtype_.empty())
1706 os << "\tDocBookItemTagType " << docbookitemtagtype_ << '\n';
1707 if(!docbookitemwrappertag_.empty())
1708 os << "\tDocBookItemWrapperTag " << docbookitemwrappertag_ << '\n';
1709 if(!docbookitemwrapperattr_.empty())
1710 os << "\tDocBookItemWrapperAttr " << docbookitemwrapperattr_ << '\n';
1711 if(!docbookitemwrappertagtype_.empty())
1712 os << "\tDocBookItemWrapperTagType " << docbookitemwrappertagtype_ << '\n';
1713 os << "\tDocBookWrapperMergeWithPrevious " << docbookwrappermergewithprevious_ << '\n';
1714 if(!docbookitemlabeltag_.empty())
1715 os << "\tDocBookItemLabelTag " << docbookitemlabeltag_ << '\n';
1716 if(!docbookitemlabelattr_.empty())
1717 os << "\tDocBookItemLabelAttr " << docbookitemlabelattr_ << '\n';
1718 if(!docbookitemlabeltagtype_.empty())
1719 os << "\tDocBookItemLabelTagType " << docbookitemlabeltagtype_ << '\n';
1720 if(!docbookiteminnertag_.empty())
1721 os << "\tDocBookItemInnerTag " << docbookiteminnertag_ << '\n';
1722 if(!docbookiteminnerattr_.empty())
1723 os << "\tDocBookItemInnerAttr " << docbookiteminnerattr_ << '\n';
1724 if(!docbookiteminnertagtype_.empty())
1725 os << "\tDocBookItemInnerTagType " << docbookiteminnertagtype_ << '\n';
1726 if(!docbookforceabstracttag_.empty())
1727 os << "\tDocBookForceAbstractTag " << docbookforceabstracttag_ << '\n';
1728 os << "\tDocBookNoFontInside " << docbooknofontinside_ << "\n"
1729 "\tSpellcheck " << spellcheck << "\n"
1730 "\tForceLocal " << forcelocal << "\n"
1735 bool Layout::hasArgs() const
1737 return !latexargs_.empty() || !postcommandargs_.empty() ||
1738 !itemargs_.empty() || !listpreamble_.empty();
1742 Layout::LaTeXArgMap Layout::args() const
1744 LaTeXArgMap args = latexargs_;
1745 if (!postcommandargs_.empty())
1746 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1747 if (!listpreamble_.empty())
1748 args.insert(listpreamble_.begin(), listpreamble_.end());
1749 if (!itemargs_.empty())
1750 args.insert(itemargs_.begin(), itemargs_.end());
1755 int Layout::optArgs() const
1758 LaTeXArgMap::const_iterator it = latexargs_.begin();
1759 for (; it != latexargs_.end(); ++it) {
1760 if (!(*it).second.mandatory)
1763 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1764 for (; iit != postcommandargs_.end(); ++iit) {
1765 if (!(*iit).second.mandatory)
1772 int Layout::requiredArgs() const
1775 LaTeXArgMap::const_iterator it = latexargs_.begin();
1776 for (; it != latexargs_.end(); ++it) {
1777 if ((*it).second.mandatory)
1780 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1781 for (; iit != postcommandargs_.end(); ++iit) {
1782 if (!(*iit).second.mandatory)
1789 string const & Layout::htmltag() const
1791 if (htmltag_.empty())
1797 string const & Layout::htmlattr() const
1799 if (htmlattr_.empty())
1800 htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
1805 string const & Layout::htmlitemtag() const
1807 if (htmlitemtag_.empty())
1808 htmlitemtag_ = "div";
1809 return htmlitemtag_;
1813 string const & Layout::htmlitemattr() const
1815 if (htmlitemattr_.empty())
1816 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1817 return htmlitemattr_;
1821 string const & Layout::htmllabeltag() const
1823 if (htmllabeltag_.empty())
1824 htmllabeltag_ = "span";
1825 return htmllabeltag_;
1829 string const & Layout::htmllabelattr() const
1831 if (htmllabelattr_.empty())
1832 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1833 return htmllabelattr_;
1837 docstring Layout::htmlstyle() const
1839 if (!htmlstyle_.empty() && !htmlforcecss_)
1841 if (htmldefaultstyle_.empty())
1843 docstring retval = htmldefaultstyle_;
1844 if (!htmlstyle_.empty())
1845 retval += '\n' + htmlstyle_;
1850 string Layout::defaultCSSClass() const
1852 if (!defaultcssclass_.empty())
1853 return defaultcssclass_;
1855 docstring::const_iterator it = name().begin();
1856 docstring::const_iterator en = name().end();
1857 for (; it != en; ++it) {
1858 char_type const c = *it;
1859 if (!isAlphaASCII(c)) {
1861 // make sure we don't start with an underscore,
1862 // as that sometimes causes problems.
1863 d = from_ascii("lyx_");
1866 } else if (isLower(c))
1869 // this is slow, so do it only if necessary
1872 defaultcssclass_ = to_utf8(d);
1873 return defaultcssclass_;
1877 string const & Layout::docbooktag() const
1879 if (docbooktag_.empty()) {
1880 if (to_ascii(name_) == "Plain Layout")
1881 docbooktag_ = "para";
1882 else // No sensible default value, unhappily...
1883 docbooktag_ = to_utf8(name_);
1889 string const & Layout::docbookattr() const
1891 // Perfectly OK to return no attributes, so docbookattr_ does not need to be filled.
1892 return docbookattr_;
1896 bool isValidTagType(std::string const & type)
1898 return !(type.empty() || (type != "block" && type != "paragraph" && type != "inline"));
1902 string const & Layout::docbooktagtype() const
1904 if (!isValidTagType(docbooktagtype_))
1905 docbooktagtype_ = "block";
1906 return docbooktagtype_;
1910 string const & Layout::docbookinnertag() const
1912 if (docbookinnertag_.empty())
1913 docbookinnertag_ = "NONE";
1914 return docbookinnertag_;
1918 string const & Layout::docbookinnerattr() const
1920 return docbookinnerattr_;
1924 string const & Layout::docbookinnertagtype() const
1926 if (!isValidTagType(docbookinnertagtype_))
1927 docbookinnertagtype_ = "block";
1928 return docbookinnertagtype_;
1932 string const & Layout::docbookininfo() const
1934 // Indeed, a trilean. Only titles should be "maybe": otherwise, metadata is "always", content is "never".
1935 if (docbookininfo_.empty() || (docbookininfo_ != "never" && docbookininfo_ != "always" && docbookininfo_ != "maybe"))
1936 docbookininfo_ = "never";
1937 return docbookininfo_;
1941 string const & Layout::docbookwrappertag() const
1943 if (docbookwrappertag_.empty())
1944 docbookwrappertag_ = "NONE";
1945 return docbookwrappertag_;
1949 string const & Layout::docbookwrapperattr() const
1951 return docbookwrapperattr_;
1955 string const & Layout::docbookwrappertagtype() const
1957 if (!isValidTagType(docbookwrappertagtype_))
1958 docbookwrappertagtype_ = "block";
1959 return docbookwrappertagtype_;
1963 string const & Layout::docbooksectiontag() const
1965 if (docbooksectiontag_.empty())
1966 docbooksectiontag_ = "section";
1967 return docbooksectiontag_;
1971 string const & Layout::docbookitemwrappertag() const
1973 if (docbookitemwrappertag_.empty())
1974 docbookitemwrappertag_ = "NONE";
1975 return docbookitemwrappertag_;
1979 string const & Layout::docbookitemwrapperattr() const
1981 return docbookitemwrapperattr_;
1985 string const & Layout::docbookitemwrappertagtype() const
1987 if (!isValidTagType(docbookitemwrappertagtype_))
1988 docbookitemwrappertagtype_ = "block";
1989 return docbookitemwrappertagtype_;
1993 string const & Layout::docbookitemtag() const
1995 if (docbookitemtag_.empty())
1996 docbookitemtag_ = "NONE";
1997 return docbookitemtag_;
2001 string const & Layout::docbookitemattr() const
2003 return docbookitemattr_;
2007 string const & Layout::docbookitemtagtype() const
2009 if (!isValidTagType(docbookitemtagtype_))
2010 docbookitemtagtype_ = "block";
2011 return docbookitemtagtype_;
2015 string const & Layout::docbookitemlabeltag() const
2017 if (docbookitemlabeltag_.empty())
2018 docbookitemlabeltag_ = "NONE";
2019 return docbookitemlabeltag_;
2023 string const & Layout::docbookitemlabelattr() const
2025 return docbookitemlabelattr_;
2029 string const & Layout::docbookitemlabeltagtype() const
2031 if (!isValidTagType(docbookitemlabeltagtype_))
2032 docbookitemlabeltagtype_ = "block";
2033 return docbookitemlabeltagtype_;
2037 string const & Layout::docbookiteminnertag() const
2039 if (docbookiteminnertag_.empty())
2040 docbookiteminnertag_ = "NONE";
2041 return docbookiteminnertag_;
2045 string const & Layout::docbookiteminnerattr() const
2047 return docbookiteminnerattr_;
2051 string const & Layout::docbookiteminnertagtype() const
2053 if (!isValidTagType(docbookiteminnertagtype_))
2054 docbookiteminnertagtype_ = "block";
2055 return docbookiteminnertagtype_;
2059 std::string const & Layout::docbookforceabstracttag() const
2061 if (docbookforceabstracttag_.empty())
2062 docbookforceabstracttag_ = "NONE";
2063 return docbookforceabstracttag_;
2070 string makeMarginValue(char const * side, double d)
2073 os << "margin-" << side << ": " << d << "ex;\n";
2080 void Layout::makeDefaultCSS() const
2082 // this never needs to be redone, since reloading layouts will
2083 // wipe out what we did before.
2084 if (!htmldefaultstyle_.empty())
2088 htmldefaultstyle_ = font.asCSS();
2093 tmp += makeMarginValue("top", topsep);
2095 tmp += makeMarginValue("bottom", bottomsep);
2096 if (!leftmargin.empty()) {
2097 // we can't really do what LyX does with the margin, so
2098 // we'll just figure out how many characters it is
2099 int const len = leftmargin.length();
2100 tmp += makeMarginValue("left", len);
2102 if (!rightmargin.empty()) {
2103 int const len = rightmargin.length();
2104 tmp += makeMarginValue("right", len);
2108 if (!htmldefaultstyle_.empty())
2109 htmldefaultstyle_ += from_ascii("\n");
2110 htmldefaultstyle_ += from_ascii(tmp);
2114 string where = alignmentToCSS(align);
2115 if (!where.empty()) {
2116 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
2119 // wrap up what we have, if anything
2120 if (!htmldefaultstyle_.empty())
2122 from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
2123 htmldefaultstyle_ + from_ascii("\n}\n");
2125 if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
2131 if (labelfont != font)
2132 labelCSS = labelfont.asCSS() + from_ascii("\n");
2133 if (labeltype == LABEL_CENTERED)
2134 labelCSS += from_ascii("text-align: center;\n");
2136 if (!labelCSS.empty())
2137 htmldefaultstyle_ +=
2138 from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
2139 labelCSS + from_ascii("\n}\n");
2143 bool Layout::operator==(Layout const & rhs) const
2145 // This is enough for the applications we actually make,
2146 // at least at the moment. But we could check more.
2147 return name() == rhs.name()
2148 && latexname() == rhs.latexname()
2149 && latextype == rhs.latextype;