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,
138 LT_STEPPARENTCOUNTER,
144 LT_INTITLE // keep this last!
147 /////////////////////
150 : add_to_toc_(false), is_toc_caption_(true)
153 margintype = MARGIN_STATIC;
154 latextype = LATEX_PARAGRAPH;
155 resumecounter = false;
156 stepparentcounter = false;
160 needcprotect = false;
161 needmboxprotect = false;
164 labelfont = inherit_font;
166 reslabelfont = sane_font;
167 nextnoindent = false;
172 labelbottomsep = 0.0;
174 align = LYX_ALIGN_BLOCK;
175 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
176 labeltype = LABEL_NO_LABEL;
177 endlabeltype = END_LABEL_NO_LABEL;
178 // Should or should not. That is the question.
179 // spacing.set(Spacing::OneHalf);
180 newline_allowed = true;
181 free_spacing = false;
183 parbreak_is_newline = false;
184 toclevel = NOT_IN_TOC;
186 htmllabelfirst_ = false;
187 htmlforcecss_ = false;
189 docbookabstract_ = false;
190 docbookwrappermergewithprevious_ = false;
191 docbooksection_ = false;
194 itemcommand_ = "item";
195 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
200 bool Layout::read(Lexer & lex, TextClass const & tclass, bool validating)
202 // If this is an empty layout, or if no force local version is set,
203 // we know that we will not discard the stuff to read
205 return readIgnoreForcelocal(lex, tclass, validating);
208 bool const ret = tmp.readIgnoreForcelocal(lex, tclass, validating);
210 // - the read version is higher
211 // - both versions are infinity (arbitrary decision)
212 // - the file did not contain any local version (needed for not
213 // skipping user defined local layouts)
214 if (tmp.forcelocal <= 0 || tmp.forcelocal > forcelocal)
220 bool Layout::readIgnoreForcelocal(Lexer & lex, TextClass const & tclass,
223 // This table is sorted alphabetically [asierra 30March96]
224 LexerKeyword layoutTags[] = {
225 { "addtotoc", LT_ADDTOTOC },
226 { "align", LT_ALIGN },
227 { "alignpossible", LT_ALIGNPOSSIBLE },
228 { "argument", LT_ARGUMENT },
229 { "autonests", LT_AUTONESTS },
230 { "babelpreamble", LT_BABELPREAMBLE },
231 { "bottomsep", LT_BOTTOMSEP },
232 { "category", LT_CATEGORY },
233 { "commanddepth", LT_COMMANDDEPTH },
234 { "copystyle", LT_COPYSTYLE },
235 { "dependson", LT_DEPENDSON },
236 { "docbookabstract", LT_DOCBOOKABSTRACT },
237 { "docbookattr", LT_DOCBOOKATTR },
238 { "docbookforceabstracttag", LT_DOCBOOKFORCEABSTRACTTAG },
239 { "docbookininfo", LT_DOCBOOKININFO },
240 { "docbookinnerattr", LT_DOCBOOKINNERATTR },
241 { "docbookinnertag", LT_DOCBOOKINNERTAG },
242 { "docbookinnertagtype", LT_DOCBOOKINNERTAGTYPE },
243 { "docbookitemattr", LT_DOCBOOKITEMATTR },
244 { "docbookiteminnerattr", LT_DOCBOOKITEMINNERATTR },
245 { "docbookiteminnertag", LT_DOCBOOKITEMINNERTAG },
246 { "docbookiteminnertagtype", LT_DOCBOOKITEMINNERTAGTYPE },
247 { "docbookitemlabelattr", LT_DOCBOOKITEMLABELATTR },
248 { "docbookitemlabeltag", LT_DOCBOOKITEMLABELTAG },
249 { "docbookitemlabeltagtype", LT_DOCBOOKITEMLABELTAGTYPE },
250 { "docbookitemtag", LT_DOCBOOKITEMTAG },
251 { "docbookitemtagtype", LT_DOCBOOKITEMTAGTYPE },
252 { "docbookitemwrapperattr", LT_DOCBOOKITEMWRAPPERATTR },
253 { "docbookitemwrappertag", LT_DOCBOOKITEMWRAPPERTAG },
254 { "docbookitemwrappertagtype", LT_DOCBOOKITEMWRAPPERTAGTYPE },
255 { "docbooksection", LT_DOCBOOKSECTION },
256 { "docbooksectiontag", LT_DOCBOOKSECTIONTAG },
257 { "docbooktag", LT_DOCBOOKTAG },
258 { "docbooktagtype", LT_DOCBOOKTAGTYPE },
259 { "docbookwrapperattr", LT_DOCBOOKWRAPPERATTR },
260 { "docbookwrappermergewithprevious", LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS },
261 { "docbookwrappertag", LT_DOCBOOKWRAPPERTAG },
262 { "docbookwrappertagtype", LT_DOCBOOKWRAPPERTAGTYPE },
264 { "endlabelstring", LT_ENDLABELSTRING },
265 { "endlabeltype", LT_ENDLABELTYPE },
267 { "forcelocal", LT_FORCELOCAL },
268 { "freespacing", LT_FREE_SPACING },
269 { "htmlattr", LT_HTMLATTR },
270 { "htmlforcecss", LT_HTMLFORCECSS },
271 { "htmlitem", LT_HTMLITEM },
272 { "htmlitemattr", LT_HTMLITEMATTR },
273 { "htmllabel", LT_HTMLLABEL },
274 { "htmllabelattr", LT_HTMLLABELATTR },
275 { "htmllabelfirst", LT_HTMLLABELFIRST },
276 { "htmlpreamble", LT_HTMLPREAMBLE },
277 { "htmlstyle", LT_HTMLSTYLE },
278 { "htmltag", LT_HTMLTAG },
279 { "htmltitle", LT_HTMLTITLE },
280 { "innertag", LT_INNERTAG },
281 { "inpreamble", LT_INPREAMBLE },
282 { "intitle", LT_INTITLE },
283 { "isautonestedby", LT_AUTONESTEDBY },
284 { "istoccaption", LT_ISTOCCAPTION },
285 { "itemcommand", LT_ITEMCOMMAND },
286 { "itemsep", LT_ITEMSEP },
287 { "itemtag", LT_ITEMTAG },
288 { "keepempty", LT_KEEPEMPTY },
289 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
290 { "labelcounter", LT_LABELCOUNTER },
291 { "labelfont", LT_LABELFONT },
292 { "labelindent", LT_LABELINDENT },
293 { "labelsep", LT_LABELSEP },
294 { "labelstring", LT_LABELSTRING },
295 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
296 { "labeltag", LT_LABELTAG },
297 { "labeltype", LT_LABELTYPE },
298 { "langpreamble", LT_LANGPREAMBLE },
299 { "latexname", LT_LATEXNAME },
300 { "latexparam", LT_LATEXPARAM },
301 { "latextype", LT_LATEXTYPE },
302 { "leftdelim", LT_LEFTDELIM },
303 { "leftmargin", LT_LEFTMARGIN },
304 { "margin", LT_MARGIN },
305 { "needcprotect", LT_NEED_CPROTECT },
306 { "needmboxprotect", LT_NEED_MBOXPROTECT },
307 { "needprotect", LT_NEED_PROTECT },
308 { "newline", LT_NEWLINE },
309 { "nextnoindent", LT_NEXTNOINDENT },
310 { "obsoletedby", LT_OBSOLETEDBY },
311 { "paragraphgroup", LT_PAR_GROUP },
312 { "parbreakisnewline", LT_PARBREAK_IS_NEWLINE },
313 { "parindent", LT_PARINDENT },
314 { "parsep", LT_PARSEP },
315 { "parskip", LT_PARSKIP },
316 { "passthru", LT_PASS_THRU },
317 { "passthruchars", LT_PASS_THRU_CHARS },
318 { "preamble", LT_PREAMBLE },
319 { "refprefix", LT_REFPREFIX },
320 { "requires", LT_REQUIRES },
321 { "resetargs", LT_RESETARGS },
322 { "resumecounter", LT_RESUMECOUNTER },
323 { "rightdelim", LT_RIGHTDELIM },
324 { "rightmargin", LT_RIGHTMARGIN },
325 { "spacing", LT_SPACING },
326 { "spellcheck", LT_SPELLCHECK },
327 { "stepparentcounter", LT_STEPPARENTCOUNTER },
328 { "textfont", LT_TEXTFONT },
329 { "toclevel", LT_TOCLEVEL },
330 { "toggleindent", LT_TOGGLE_INDENT },
331 { "topsep", LT_TOPSEP }
335 bool finished = false;
336 lex.pushTable(layoutTags);
338 // parse style section
339 while (!finished && lex.isOK() && !error) {
341 // See comment in LyXRC.cpp.
343 case Lexer::LEX_FEOF:
346 case Lexer::LEX_UNDEF:
348 lex.printError("Unknown layout tag `$$Token'");
355 switch (static_cast<LayoutTags>(le)) {
367 style = subst(style, '_', ' ');
369 if (tclass.hasLayout(style)) {
370 docstring const tmpname = name_;
371 this->operator=(tclass[style]);
374 LYXERR0("Cannot copy unknown style `"
376 << "All layouts so far:");
377 DocumentClass::const_iterator lit = tclass.begin();
378 DocumentClass::const_iterator len = tclass.end();
379 for (; lit != len; ++lit)
380 LYXERR0(lit->name());
385 case LT_OBSOLETEDBY: {
388 style = subst(style, '_', ' ');
390 if (tclass.hasLayout(style)) {
391 docstring const tmpname = name_;
392 this->operator=(tclass[style]);
394 if (obsoleted_by().empty())
395 obsoleted_by_ = style;
397 LYXERR0("Cannot replace with unknown style `"
400 //lex.printError("Cannot replace with"
409 depends_on_ = subst(depends_on_, '_', ' ');
438 postcommandargs_.clear();
439 listpreamble_.clear();
443 case LT_RESUMECOUNTER:
444 lex >> resumecounter;
447 case LT_STEPPARENTCOUNTER:
448 lex >> stepparentcounter;
452 readArgument(lex, validating);
455 case LT_NEED_PROTECT:
459 case LT_NEED_CPROTECT:
463 case LT_NEED_MBOXPROTECT:
464 lex >> needmboxprotect;
472 font = lyxRead(lex, font);
477 font = lyxRead(lex, font);
481 labelfont = lyxRead(lex, labelfont);
484 case LT_NEXTNOINDENT:
488 case LT_TOGGLE_INDENT: {
491 tog = support::ascii_lowercase(tog);
493 toggle_indent = ITOGGLE_ALWAYS;
494 else if (tog == "never")
495 toggle_indent = ITOGGLE_NEVER;
497 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
501 case LT_COMMANDDEPTH:
511 latexparam_ = subst(latexparam_, """, "\"");
516 leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
522 rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
543 preamble_ = lex.getLongString(from_ascii("EndPreamble"));
546 case LT_LANGPREAMBLE:
547 langpreamble_ = lex.getLongString(from_ascii("EndLangPreamble"));
550 case LT_BABELPREAMBLE:
551 babelpreamble_ = lex.getLongString(from_ascii("EndBabelPreamble"));
558 case LT_ENDLABELTYPE:
559 readEndLabelType(lex);
594 case LT_LABEL_BOTTOMSEP:
595 lex >> labelbottomsep;
600 labelsep = subst(labelsep, 'x', ' ');
608 lex >> newline_allowed;
615 case LT_ALIGNPOSSIBLE:
616 readAlignPossible(lex);
620 // FIXME: this means LT_LABELSTRING_APPENDIX may only
621 // occur after LT_LABELSTRING
623 labelstring_appendix_ = labelstring_;
626 case LT_ENDLABELSTRING:
627 lex >> endlabelstring_;
630 case LT_LABELSTRING_APPENDIX:
631 lex >> labelstring_appendix_;
634 case LT_LABELCOUNTER:
642 case LT_FREE_SPACING:
650 case LT_PASS_THRU_CHARS:
651 lex >> pass_thru_chars;
654 case LT_PARBREAK_IS_NEWLINE:
655 lex >> parbreak_is_newline;
664 vector<string> const req =
665 getVectorFromString(lex.getString(true));
666 required_.insert(req.begin(), req.end());
671 docstring autonest = lex.getLongString(from_ascii("EndAutoNests"));
672 autonest = subst(autonest, from_ascii("\n"), docstring());
673 autonest = subst(autonest, from_ascii("\t"), docstring());
674 autonest = subst(autonest, from_ascii("\""), docstring());
675 autonest = subst(autonest, '_', ' ');
676 vector<docstring> const autonests =
677 getVectorFromString(autonest, from_ascii(","), false, true);
678 autonests_.insert(autonests.begin(), autonests.end());
682 case LT_AUTONESTEDBY: {
683 docstring autonest = lex.getLongString(from_ascii("EndIsAutoNestedBy"));
684 autonest = subst(autonest, from_ascii("\n"), docstring());
685 autonest = subst(autonest, from_ascii("\t"), docstring());
686 autonest = subst(autonest, from_ascii("\""), docstring());
687 autonest = subst(autonest, '_', ' ');
688 vector<docstring> const autonests =
689 getVectorFromString(autonest, from_ascii(","), false, true);
690 autonested_by_.insert(autonests.begin(), autonests.end());
716 case LT_HTMLITEMATTR:
717 lex >> htmlitemattr_;
721 lex >> htmllabeltag_;
724 case LT_HTMLLABELATTR:
725 lex >> htmllabelattr_;
728 case LT_HTMLLABELFIRST:
729 lex >> htmllabelfirst_;
733 htmlstyle_ = lex.getLongString(from_ascii("EndHTMLStyle"));
736 case LT_HTMLFORCECSS:
737 lex >> htmlforcecss_;
740 case LT_HTMLPREAMBLE:
741 htmlpreamble_ = lex.getLongString(from_ascii("EndPreamble"));
756 case LT_DOCBOOKTAGTYPE:
757 lex >> docbooktagtype_;
760 case LT_DOCBOOKINNERTAG:
761 lex >> docbookinnertag_;
764 case LT_DOCBOOKINNERATTR:
765 lex >> docbookinnerattr_;
768 case LT_DOCBOOKINNERTAGTYPE:
769 lex >> docbookinnertagtype_;
772 case LT_DOCBOOKFORCEABSTRACTTAG:
773 lex >> docbookforceabstracttag_;
776 case LT_DOCBOOKININFO:
777 lex >> docbookininfo_;
780 case LT_DOCBOOKABSTRACT:
781 lex >> docbookabstract_;
784 case LT_DOCBOOKWRAPPERTAG:
785 lex >> docbookwrappertag_;
788 case LT_DOCBOOKWRAPPERATTR:
789 lex >> docbookwrapperattr_;
792 case LT_DOCBOOKWRAPPERTAGTYPE:
793 lex >> docbookwrappertagtype_;
796 case LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS:
797 lex >> docbookwrappermergewithprevious_;
800 case LT_DOCBOOKSECTION:
801 lex >> docbooksection_;
804 case LT_DOCBOOKSECTIONTAG:
805 lex >> docbooksectiontag_;
808 case LT_DOCBOOKITEMWRAPPERTAG:
809 lex >> docbookitemwrappertag_;
812 case LT_DOCBOOKITEMWRAPPERATTR:
813 lex >> docbookitemwrapperattr_;
816 case LT_DOCBOOKITEMWRAPPERTAGTYPE:
817 lex >> docbookitemwrappertagtype_;
820 case LT_DOCBOOKITEMTAG:
821 lex >> docbookitemtag_;
824 case LT_DOCBOOKITEMATTR:
825 lex >> docbookitemattr_;
828 case LT_DOCBOOKITEMTAGTYPE:
829 lex >> docbookitemtagtype_;
832 case LT_DOCBOOKITEMLABELTAG:
833 lex >> docbookitemlabeltag_;
836 case LT_DOCBOOKITEMLABELATTR:
837 lex >> docbookitemlabelattr_;
840 case LT_DOCBOOKITEMLABELTAGTYPE:
841 lex >> docbookitemlabeltagtype_;
844 case LT_DOCBOOKITEMINNERTAG:
845 lex >> docbookiteminnertag_;
848 case LT_DOCBOOKITEMINNERATTR:
849 lex >> docbookiteminnerattr_;
852 case LT_DOCBOOKITEMINNERTAGTYPE:
853 lex >> docbookiteminnertagtype_;
866 add_to_toc_ = !toc_type_.empty();
869 case LT_ISTOCCAPTION:
870 lex >> is_toc_caption_;
876 // make sure we only have inpreamble = true for commands
877 if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
878 LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
879 LYXERR0("Layout name: " << name());
883 return finished && !error;
896 LexerKeyword alignTags[] = {
897 { "block", AT_BLOCK },
898 { "center", AT_CENTER },
899 { "layout", AT_LAYOUT },
901 { "right", AT_RIGHT }
905 void Layout::readAlign(Lexer & lex)
907 PushPopHelper pph(lex, alignTags);
910 case Lexer::LEX_UNDEF:
911 lex.printError("Unknown alignment `$$Token'");
917 align = LYX_ALIGN_BLOCK;
920 align = LYX_ALIGN_LEFT;
923 align = LYX_ALIGN_RIGHT;
926 align = LYX_ALIGN_CENTER;
929 align = LYX_ALIGN_LAYOUT;
935 void Layout::readAlignPossible(Lexer & lex)
937 lex.pushTable(alignTags);
938 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
939 int lineno = lex.lineNumber();
943 case Lexer::LEX_UNDEF:
944 lex.printError("Unknown alignment `$$Token'");
950 alignpossible |= LYX_ALIGN_BLOCK;
953 alignpossible |= LYX_ALIGN_LEFT;
956 alignpossible |= LYX_ALIGN_RIGHT;
959 alignpossible |= LYX_ALIGN_CENTER;
962 alignpossible |= LYX_ALIGN_LAYOUT;
965 } while (lineno == lex.lineNumber());
970 void Layout::readLabelType(Lexer & lex)
985 LexerKeyword labelTypeTags[] = {
986 { "above", LA_ABOVE },
987 { "bibliography", LA_BIBLIO },
988 { "centered", LA_CENTERED },
989 { "enumerate", LA_ENUMERATE },
990 { "itemize", LA_ITEMIZE },
991 { "manual", LA_MANUAL },
992 { "no_label", LA_NO_LABEL },
993 { "sensitive", LA_SENSITIVE },
994 { "static", LA_STATIC }
997 PushPopHelper pph(lex, labelTypeTags);
1000 case Lexer::LEX_UNDEF:
1001 lex.printError("Unknown labeltype tag `$$Token'");
1007 labeltype = LABEL_NO_LABEL;
1010 labeltype = LABEL_MANUAL;
1013 labeltype = LABEL_ABOVE;
1016 labeltype = LABEL_CENTERED;
1019 labeltype = LABEL_STATIC;
1022 labeltype = LABEL_SENSITIVE;
1025 labeltype = LABEL_ENUMERATE;
1028 labeltype = LABEL_ITEMIZE;
1031 labeltype = LABEL_BIBLIO;
1037 void Layout::readEndLabelType(Lexer & lex)
1039 // this should be const, but can't be because
1040 // of PushPopHelper.
1041 static LexerKeyword endlabelTypeTags[] = {
1042 { "box", END_LABEL_BOX },
1043 { "filled_box", END_LABEL_FILLED_BOX },
1044 { "no_label", END_LABEL_NO_LABEL },
1045 { "static", END_LABEL_STATIC }
1048 PushPopHelper pph(lex, endlabelTypeTags);
1051 case Lexer::LEX_UNDEF:
1052 lex.printError("Unknown labeltype tag `$$Token'");
1054 case END_LABEL_STATIC:
1056 case END_LABEL_FILLED_BOX:
1057 case END_LABEL_NO_LABEL:
1058 endlabeltype = static_cast<EndLabelType>(le);
1061 LYXERR0("Unhandled value " << le);
1067 void Layout::readMargin(Lexer & lex)
1069 LexerKeyword marginTags[] = {
1070 { "dynamic", MARGIN_DYNAMIC },
1071 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
1072 { "manual", MARGIN_MANUAL },
1073 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
1074 { "static", MARGIN_STATIC }
1077 PushPopHelper pph(lex, marginTags);
1081 case Lexer::LEX_UNDEF:
1082 lex.printError("Unknown margin type tag `$$Token'");
1086 case MARGIN_DYNAMIC:
1087 case MARGIN_FIRST_DYNAMIC:
1088 case MARGIN_RIGHT_ADDRESS_BOX:
1089 margintype = static_cast<MarginType>(le);
1092 LYXERR0("Unhandled value " << le);
1098 void Layout::readLatexType(Lexer & lex)
1100 LexerKeyword latexTypeTags[] = {
1101 { "bib_environment", LATEX_BIB_ENVIRONMENT },
1102 { "command", LATEX_COMMAND },
1103 { "environment", LATEX_ENVIRONMENT },
1104 { "item_environment", LATEX_ITEM_ENVIRONMENT },
1105 { "list_environment", LATEX_LIST_ENVIRONMENT },
1106 { "paragraph", LATEX_PARAGRAPH }
1109 PushPopHelper pph(lex, latexTypeTags);
1112 case Lexer::LEX_UNDEF:
1113 lex.printError("Unknown latextype tag `$$Token'");
1115 case LATEX_PARAGRAPH:
1117 case LATEX_ITEM_ENVIRONMENT:
1118 case LATEX_LIST_ENVIRONMENT:
1119 latextype = static_cast<LatexType>(le);
1121 case LATEX_ENVIRONMENT:
1122 case LATEX_BIB_ENVIRONMENT:
1123 latextype = static_cast<LatexType>(le);
1127 LYXERR0("Unhandled value " << le);
1133 void Layout::readSpacing(Lexer & lex)
1136 ST_SPACING_SINGLE = 1,
1142 LexerKeyword spacingTags[] = {
1143 {"double", ST_SPACING_DOUBLE },
1144 {"onehalf", ST_SPACING_ONEHALF },
1145 {"other", ST_OTHER },
1146 {"single", ST_SPACING_SINGLE }
1149 PushPopHelper pph(lex, spacingTags);
1152 case Lexer::LEX_UNDEF:
1153 lex.printError("Unknown spacing token `$$Token'");
1158 case ST_SPACING_SINGLE:
1159 spacing.set(Spacing::Single);
1161 case ST_SPACING_ONEHALF:
1162 spacing.set(Spacing::Onehalf);
1164 case ST_SPACING_DOUBLE:
1165 spacing.set(Spacing::Double);
1169 spacing.set(Spacing::Other, lex.getString());
1175 void Layout::readArgument(Lexer & lex, bool validating)
1178 LYXERR0("Unable to read argument ID!");
1181 string const id = lex.getString();
1183 bool const itemarg = prefixIs(id, "item:");
1184 bool const postcmd = prefixIs(id, "post:");
1185 bool const listpreamble = prefixIs(id, "listpreamble:");
1187 LaTeXArgMap & lam = itemarg ? itemargs_ :
1188 (postcmd ? postcommandargs_ :
1189 (listpreamble ? listpreamble_ :
1191 latexarg & arg = lam[id];
1194 // list preamble has no delimiters by default
1195 arg.nodelims = true;
1198 bool finished = false;
1199 while (!finished && lex.isOK() && !error) {
1201 string const tok = ascii_lowercase(lex.getString());
1205 } else if (tok == "endargument") {
1207 } else if (tok == "labelstring") {
1209 arg.labelstring = lex.getDocString();
1210 } else if (tok == "menustring") {
1212 arg.menustring = lex.getDocString();
1213 } else if (tok == "mandatory") {
1215 arg.mandatory = lex.getBool();
1216 } else if (tok == "autoinsert") {
1218 arg.autoinsert = lex.getBool();
1219 } else if (tok == "insertcotext") {
1221 arg.insertcotext = lex.getBool();
1222 } else if (tok == "leftdelim") {
1224 arg.ldelim = lex.getDocString();
1225 arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
1227 } else if (tok == "rightdelim") {
1229 arg.rdelim = lex.getDocString();
1230 arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
1232 } else if (tok == "defaultarg") {
1234 arg.defaultarg = lex.getDocString();
1235 } else if (tok == "presetarg") {
1237 arg.presetarg = lex.getDocString();
1238 } else if (tok == "tooltip") {
1240 arg.tooltip = lex.getDocString();
1241 } else if (tok == "requires") {
1243 arg.required = lex.getString();
1244 } else if (tok == "decoration") {
1246 arg.decoration = lex.getString();
1247 } else if (tok == "newlinecmd") {
1249 arg.newlinecmd = lex.getString();
1250 } else if (tok == "font") {
1251 arg.font = lyxRead(lex, arg.font);
1252 } else if (tok == "labelfont") {
1253 arg.labelfont = lyxRead(lex, arg.labelfont);
1254 } else if (tok == "passthruchars") {
1256 arg.pass_thru_chars = lex.getDocString();
1257 } else if (tok == "passthru") {
1259 docstring value = lex.getDocString();
1260 if (value == "true" || value == "1")
1261 arg.passthru = PT_TRUE;
1262 else if (value == "false" || value == "0")
1263 arg.passthru = PT_FALSE;
1265 arg.passthru = PT_INHERITED;
1266 } else if (tok == "istoccaption") {
1268 arg.is_toc_caption = lex.getBool();
1269 } else if (tok == "freespacing") {
1271 arg.free_spacing = lex.getBool();
1272 } else if (tok == "docbooktag") {
1274 arg.docbooktag = lex.getDocString();
1275 } else if (tok == "docbookattr") {
1277 arg.docbookattr = lex.getDocString();
1278 } else if (tok == "docbooktagtype") {
1280 arg.docbooktagtype = lex.getDocString();
1282 lex.printError("Unknown tag");
1286 if (!validating && arg.labelstring.empty()) {
1287 LYXERR0("Incomplete Argument definition!");
1288 // remove invalid definition
1294 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1296 os << "\tArgument " << id << '\n';
1297 if (!arg.labelstring.empty())
1298 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1299 if (!arg.menustring.empty())
1300 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1302 os << "\t\tMandatory " << arg.mandatory << '\n';
1304 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1305 if (arg.insertcotext)
1306 os << "\t\tInsertCotext " << arg.insertcotext << '\n';
1307 if (!arg.ldelim.empty())
1308 os << "\t\tLeftDelim \""
1309 << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1311 if (!arg.rdelim.empty())
1312 os << "\t\tRightDelim \""
1313 << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1315 if (!arg.defaultarg.empty())
1316 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1317 if (!arg.presetarg.empty())
1318 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1319 if (!arg.tooltip.empty())
1320 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1321 if (!arg.required.empty())
1322 os << "\t\tRequires \"" << arg.required << "\"\n";
1323 if (!arg.decoration.empty())
1324 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1325 if (!arg.newlinecmd.empty())
1326 os << "\t\tNewlineCmd \"" << arg.newlinecmd << "\"\n";
1327 if (arg.font != inherit_font)
1328 lyxWrite(os, arg.font, "Font", 2);
1329 if (arg.labelfont != inherit_font)
1330 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1331 switch (arg.passthru) {
1333 os << "\t\tPassThru true\n";
1336 os << "\t\tPassThru false\n";
1339 os << "\t\tPassThru inherited\n";
1342 if (!arg.pass_thru_chars.empty())
1343 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1344 if (arg.free_spacing)
1345 os << "\t\tFreeSpacing " << arg.free_spacing << "\n";
1346 os << "\tEndArgument\n";
1350 void Layout::write(ostream & os) const
1352 os << "Style \"" << to_utf8(name_) << "\"\n";
1353 if (!category_.empty() && obsoleted_by_.empty())
1354 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1355 // Can't deduce Copystyle here :-(
1356 if (!obsoleted_by_.empty()) {
1357 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1361 if (!depends_on_.empty())
1362 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1363 switch (margintype) {
1364 case MARGIN_DYNAMIC:
1365 os << "\tMargin Dynamic\n";
1367 case MARGIN_FIRST_DYNAMIC:
1368 os << "\tMargin First_Dynamic\n";
1371 os << "\tMargin Manual\n";
1373 case MARGIN_RIGHT_ADDRESS_BOX:
1374 os << "\tMargin Right_Address_Box\n";
1377 os << "\tMargin Static\n";
1380 switch (latextype) {
1381 case LATEX_BIB_ENVIRONMENT:
1382 os << "\tLatexType Bib_Environment\n";
1385 os << "\tLatexType Command\n";
1387 case LATEX_ENVIRONMENT:
1388 os << "\tLatexType Environment\n";
1390 case LATEX_ITEM_ENVIRONMENT:
1391 os << "\tLatexType Item_Environment\n";
1393 case LATEX_LIST_ENVIRONMENT:
1394 os << "\tLatexType List_Environment\n";
1396 case LATEX_PARAGRAPH:
1397 os << "\tLatexType Paragraph\n";
1400 os << "\tInTitle " << intitle << "\n"
1401 "\tInPreamble " << inpreamble << "\n"
1402 "\tTocLevel " << toclevel << "\n"
1403 "\tResumeCounter " << resumecounter << "\n"
1404 "\tStepParentCounter " << stepparentcounter << '\n';
1405 // ResetArgs does not make sense here
1406 for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1407 it != latexargs_.end(); ++it)
1408 writeArgument(os, it->first, it->second);
1409 for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1410 it != itemargs_.end(); ++it)
1411 writeArgument(os, it->first, it->second);
1412 for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1413 it != postcommandargs_.end(); ++it)
1414 writeArgument(os, it->first, it->second);
1415 for (LaTeXArgMap::const_iterator it = listpreamble_.begin();
1416 it != listpreamble_.end(); ++it)
1417 writeArgument(os, it->first, it->second);
1418 os << "\tNeedProtect " << needprotect << "\n"
1419 "\tNeedCProtect " << needcprotect << "\n"
1420 "\tNeedMBoxProtect " << needmboxprotect << "\n"
1421 "\tKeepEmpty " << keepempty << '\n';
1422 if (labelfont == font)
1423 lyxWrite(os, font, "Font", 1);
1425 lyxWrite(os, font, "TextFont", 1);
1426 lyxWrite(os, labelfont, "LabelFont", 1);
1428 os << "\tNextNoIndent " << nextnoindent << "\n"
1429 "\tCommandDepth " << commanddepth << '\n';
1430 if (!latexname_.empty())
1431 os << "\tLatexName \"" << latexname_ << "\"\n";
1432 if (!latexparam_.empty())
1433 os << "\tLatexParam \"" << subst(latexparam_, "\"", """)
1435 if (!leftdelim_.empty())
1436 os << "\tLeftDelim "
1437 << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1439 if (!rightdelim_.empty())
1440 os << "\tRightDelim "
1441 << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1443 if (!innertag_.empty())
1444 os << "\tInnerTag \"" << innertag_ << "\"\n";
1445 if (!labeltag_.empty())
1446 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1447 if (!itemtag_.empty())
1448 os << "\tItemTag \"" << itemtag_ << "\"\n";
1449 if (!itemcommand_.empty())
1450 os << "\tItemCommand " << itemcommand_ << '\n';
1451 if (!preamble_.empty())
1452 os << "\tPreamble\n\t"
1453 << to_utf8(subst(rtrim(preamble_, "\n"),
1454 from_ascii("\n"), from_ascii("\n\t")))
1455 << "\n\tEndPreamble\n";
1456 if (!langpreamble_.empty())
1457 os << "\tLangPreamble\n\t"
1458 << to_utf8(subst(rtrim(langpreamble_, "\n"),
1459 from_ascii("\n"), from_ascii("\n\t")))
1460 << "\n\tEndLangPreamble\n";
1461 if (!babelpreamble_.empty())
1462 os << "\tBabelPreamble\n\t"
1463 << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1464 from_ascii("\n"), from_ascii("\n\t")))
1465 << "\n\tEndBabelPreamble\n";
1466 switch (labeltype) {
1468 os << "\tLabelType Above\n";
1471 os << "\tLabelType Bibliography\n";
1473 case LABEL_CENTERED:
1474 os << "\tLabelType Centered\n";
1476 case LABEL_ENUMERATE:
1477 os << "\tLabelType Enumerate\n";
1480 os << "\tLabelType Itemize\n";
1483 os << "\tLabelType Manual\n";
1485 case LABEL_NO_LABEL:
1486 os << "\tLabelType No_Label\n";
1488 case LABEL_SENSITIVE:
1489 os << "\tLabelType Sensitive\n";
1492 os << "\tLabelType Static\n";
1495 switch (endlabeltype) {
1497 os << "\tEndLabelType Box\n";
1499 case END_LABEL_FILLED_BOX:
1500 os << "\tEndLabelType Filled_Box\n";
1502 case END_LABEL_NO_LABEL:
1503 os << "\tEndLabelType No_Label\n";
1505 case END_LABEL_STATIC:
1506 os << "\tEndLabelType Static\n";
1509 os << "\tParagraphGroup \"" << par_group_ << "\"\n";
1510 if (!leftmargin.empty())
1511 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1512 if (!rightmargin.empty())
1513 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1514 if (!labelindent.empty())
1515 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1516 if (!parindent.empty())
1517 os << "\tParIndent " << to_utf8(parindent) << '\n';
1518 os << "\tParSkip " << parskip << "\n"
1519 "\tItemSep " << itemsep << "\n"
1520 "\tTopSep " << topsep << "\n"
1521 "\tBottomSep " << bottomsep << "\n"
1522 "\tLabelBottomSep " << labelbottomsep << '\n';
1523 if (!labelsep.empty())
1524 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1526 os << "\tParSep " << parsep << "\n"
1527 "\tNewLine " << newline_allowed << '\n';
1529 case LYX_ALIGN_BLOCK:
1530 os << "\tAlign Block\n";
1532 case LYX_ALIGN_CENTER:
1533 os << "\tAlign Center\n";
1535 case LYX_ALIGN_LAYOUT:
1536 os << "\tAlign Layout\n";
1538 case LYX_ALIGN_LEFT:
1539 os << "\tAlign Left\n";
1541 case LYX_ALIGN_RIGHT:
1542 os << "\tAlign Right\n";
1544 case LYX_ALIGN_DECIMAL:
1545 case LYX_ALIGN_SPECIAL:
1546 case LYX_ALIGN_NONE:
1549 if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1550 LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1552 os << "\tAlignPossible";
1553 if (alignpossible & LYX_ALIGN_BLOCK) {
1557 if (alignpossible & LYX_ALIGN_CENTER) {
1563 if (alignpossible & LYX_ALIGN_LAYOUT) {
1569 if (alignpossible & LYX_ALIGN_LEFT) {
1575 if (alignpossible & LYX_ALIGN_RIGHT) {
1583 // LabelString must come before LabelStringAppendix
1584 if (!labelstring_.empty())
1585 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1586 if (!endlabelstring_.empty())
1587 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1588 if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1589 os << "\tLabelStringAppendix \""
1590 << to_utf8(labelstring_appendix_) << "\"\n";
1591 if (!counter.empty())
1592 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1593 os << "\tFreeSpacing " << free_spacing << '\n';
1594 os << "\tPassThru " << pass_thru << '\n';
1595 if (!pass_thru_chars.empty())
1596 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1597 os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1598 switch (spacing.getSpace()) {
1599 case Spacing::Double:
1600 os << "\tSpacing Double\n";
1602 case Spacing::Onehalf:
1603 os << "\tSpacing Onehalf\n";
1605 case Spacing::Other:
1606 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1608 case Spacing::Single:
1609 os << "\tSpacing Single\n";
1611 case Spacing::Default:
1614 if (!required_.empty()) {
1615 os << "\tRequires ";
1616 for (set<string>::const_iterator it = required_.begin();
1617 it != required_.end(); ++it) {
1618 if (it != required_.begin())
1624 if (!autonests_.empty()) {
1625 os << "\tAutoNests\n\t";
1626 for (set<docstring>::const_iterator it = autonests_.begin();
1627 it != autonests_.end(); ++it) {
1628 if (it != autonests_.begin())
1632 os << "\n\tEndAutoNests\n";
1634 if (!autonested_by_.empty()) {
1635 os << "\tIsAutoNestedBy\n\t\t";
1636 for (set<docstring>::const_iterator it = autonested_by_.begin();
1637 it != autonested_by_.end(); ++it) {
1638 if (it != autonested_by_.begin())
1642 os << "\n\tEndIsAutoNestedBy\n";
1644 if (refprefix.empty())
1645 os << "\tRefPrefix OFF\n";
1647 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1648 if (!htmltag_.empty())
1649 os << "\tHTMLTag " << htmltag_ << '\n';
1650 if (!htmlattr_.empty())
1651 os << "\tHTMLAttr " << htmlattr_ << '\n';
1652 if (!htmlitemtag_.empty())
1653 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1654 if (!htmlitemattr_.empty())
1655 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1656 if (!htmllabeltag_.empty())
1657 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1658 if (!htmllabelattr_.empty())
1659 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1660 os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1661 if (!htmlstyle_.empty())
1662 os << "\tHTMLStyle\n"
1663 << to_utf8(rtrim(htmlstyle_, "\n"))
1664 << "\n\tEndHTMLStyle\n";
1665 os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1666 if (!htmlpreamble_.empty())
1667 os << "\tHTMLPreamble\n"
1668 << to_utf8(rtrim(htmlpreamble_, "\n"))
1669 << "\n\tEndPreamble\n";
1670 os << "\tHTMLTitle " << htmltitle_ << "\n";
1671 if(!docbooktag_.empty())
1672 os << "\tDocBookTag " << docbooktag_ << '\n';
1673 if(!docbookattr_.empty())
1674 os << "\tDocBookAttr \"" << docbookattr_ << "\"\n";
1675 if(!docbooktagtype_.empty())
1676 os << "\tDocBookTagType " << docbooktagtype_ << '\n';
1677 if(!docbookinnertag_.empty())
1678 os << "\tDocBookInnerTag " << docbookinnertag_ << '\n';
1679 if(!docbookinnerattr_.empty())
1680 os << "\tDocBookInnerAttr \"" << docbookinnerattr_ << "\"\n";
1681 if(!docbookinnertagtype_.empty())
1682 os << "\tDocBookInnerTagType " << docbookinnertagtype_ << '\n';
1683 if(!docbookininfo_.empty())
1684 os << "\tDocBookInInfo " << docbookininfo_ << '\n';
1685 os << "\tDocBookAbstract " << docbookabstract_ << '\n';
1686 if(!docbookwrappertag_.empty())
1687 os << "\tDocBookWrapperTag " << docbookwrappertag_ << '\n';
1688 if(!docbookwrapperattr_.empty())
1689 os << "\tDocBookWrapperAttr " << docbookwrapperattr_ << '\n';
1690 if(!docbookwrappertagtype_.empty())
1691 os << "\tDocBookWrapperTagType " << docbookwrappertagtype_ << '\n';
1692 os << "\tDocBookSection " << docbooksection_ << '\n';
1693 if(!docbooksectiontag_.empty())
1694 os << "\tDocBookSectionTag " << docbooksectiontag_ << '\n';
1695 if(!docbookitemtag_.empty())
1696 os << "\tDocBookItemTag " << docbookitemtag_ << '\n';
1697 if(!docbookitemattr_.empty())
1698 os << "\tDocBookItemAttr " << docbookitemattr_ << '\n';
1699 if(!docbookitemtagtype_.empty())
1700 os << "\tDocBookItemTagType " << docbookitemtagtype_ << '\n';
1701 if(!docbookitemwrappertag_.empty())
1702 os << "\tDocBookItemWrapperTag " << docbookitemwrappertag_ << '\n';
1703 if(!docbookitemwrapperattr_.empty())
1704 os << "\tDocBookItemWrapperAttr " << docbookitemwrapperattr_ << '\n';
1705 if(!docbookitemwrappertagtype_.empty())
1706 os << "\tDocBookItemWrapperTagType " << docbookitemwrappertagtype_ << '\n';
1707 os << "\tDocBookWrapperMergeWithPrevious " << docbookwrappermergewithprevious_ << '\n';
1708 if(!docbookitemlabeltag_.empty())
1709 os << "\tDocBookItemLabelTag " << docbookitemlabeltag_ << '\n';
1710 if(!docbookitemlabelattr_.empty())
1711 os << "\tDocBookItemLabelAttr " << docbookitemlabelattr_ << '\n';
1712 if(!docbookitemlabeltagtype_.empty())
1713 os << "\tDocBookItemLabelTagType " << docbookitemlabeltagtype_ << '\n';
1714 if(!docbookiteminnertag_.empty())
1715 os << "\tDocBookItemInnerTag " << docbookiteminnertag_ << '\n';
1716 if(!docbookiteminnerattr_.empty())
1717 os << "\tDocBookItemInnerAttr " << docbookiteminnerattr_ << '\n';
1718 if(!docbookiteminnertagtype_.empty())
1719 os << "\tDocBookItemInnerTagType " << docbookiteminnertagtype_ << '\n';
1720 if(!docbookforceabstracttag_.empty())
1721 os << "\tDocBookForceAbstractTag " << docbookforceabstracttag_ << '\n';
1722 os << "\tSpellcheck " << spellcheck << "\n"
1723 "\tForceLocal " << forcelocal << "\n"
1728 bool Layout::hasArgs() const
1730 return !latexargs_.empty() || !postcommandargs_.empty() ||
1731 !itemargs_.empty() || !listpreamble_.empty();
1735 Layout::LaTeXArgMap Layout::args() const
1737 LaTeXArgMap args = latexargs_;
1738 if (!postcommandargs_.empty())
1739 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1740 if (!listpreamble_.empty())
1741 args.insert(listpreamble_.begin(), listpreamble_.end());
1742 if (!itemargs_.empty())
1743 args.insert(itemargs_.begin(), itemargs_.end());
1748 int Layout::optArgs() const
1751 LaTeXArgMap::const_iterator it = latexargs_.begin();
1752 for (; it != latexargs_.end(); ++it) {
1753 if (!(*it).second.mandatory)
1756 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1757 for (; iit != postcommandargs_.end(); ++iit) {
1758 if (!(*iit).second.mandatory)
1765 int Layout::requiredArgs() const
1768 LaTeXArgMap::const_iterator it = latexargs_.begin();
1769 for (; it != latexargs_.end(); ++it) {
1770 if ((*it).second.mandatory)
1773 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1774 for (; iit != postcommandargs_.end(); ++iit) {
1775 if (!(*iit).second.mandatory)
1782 string const & Layout::htmltag() const
1784 if (htmltag_.empty())
1790 string const & Layout::htmlattr() const
1792 if (htmlattr_.empty())
1793 htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
1798 string const & Layout::htmlitemtag() const
1800 if (htmlitemtag_.empty())
1801 htmlitemtag_ = "div";
1802 return htmlitemtag_;
1806 string const & Layout::htmlitemattr() const
1808 if (htmlitemattr_.empty())
1809 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1810 return htmlitemattr_;
1814 string const & Layout::htmllabeltag() const
1816 if (htmllabeltag_.empty())
1817 htmllabeltag_ = "span";
1818 return htmllabeltag_;
1822 string const & Layout::htmllabelattr() const
1824 if (htmllabelattr_.empty())
1825 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1826 return htmllabelattr_;
1830 docstring Layout::htmlstyle() const
1832 if (!htmlstyle_.empty() && !htmlforcecss_)
1834 if (htmldefaultstyle_.empty())
1836 docstring retval = htmldefaultstyle_;
1837 if (!htmlstyle_.empty())
1838 retval += '\n' + htmlstyle_;
1843 string Layout::defaultCSSClass() const
1845 if (!defaultcssclass_.empty())
1846 return defaultcssclass_;
1848 docstring::const_iterator it = name().begin();
1849 docstring::const_iterator en = name().end();
1850 for (; it != en; ++it) {
1851 char_type const c = *it;
1852 if (!isAlphaASCII(c)) {
1854 // make sure we don't start with an underscore,
1855 // as that sometimes causes problems.
1856 d = from_ascii("lyx_");
1859 } else if (isLower(c))
1862 // this is slow, so do it only if necessary
1865 defaultcssclass_ = to_utf8(d);
1866 return defaultcssclass_;
1870 string const & Layout::docbooktag() const
1872 if (docbooktag_.empty()) {
1873 if (to_ascii(name_) == "Plain Layout")
1874 docbooktag_ = "para";
1875 else // No sensible default value, unhappily...
1876 docbooktag_ = to_utf8(name_);
1882 string const & Layout::docbookattr() const
1884 // Perfectly OK to return no attributes, so docbookattr_ does not need to be filled.
1885 return docbookattr_;
1889 bool isValidTagType(std::string const & type)
1891 return !(type.empty() || (type != "block" && type != "paragraph" && type != "inline"));
1895 string const & Layout::docbooktagtype() const
1897 if (!isValidTagType(docbooktagtype_))
1898 docbooktagtype_ = "block";
1899 return docbooktagtype_;
1903 string const & Layout::docbookinnertag() const
1905 if (docbookinnertag_.empty())
1906 docbookinnertag_ = "NONE";
1907 return docbookinnertag_;
1911 string const & Layout::docbookinnerattr() const
1913 return docbookinnerattr_;
1917 string const & Layout::docbookinnertagtype() const
1919 if (!isValidTagType(docbookinnertagtype_))
1920 docbookinnertagtype_ = "block";
1921 return docbookinnertagtype_;
1925 string const & Layout::docbookininfo() const
1927 // Indeed, a trilean. Only titles should be "maybe": otherwise, metadata is "always", content is "never".
1928 if (docbookininfo_.empty() || (docbookininfo_ != "never" && docbookininfo_ != "always" && docbookininfo_ != "maybe"))
1929 docbookininfo_ = "never";
1930 return docbookininfo_;
1934 string const & Layout::docbookwrappertag() const
1936 if (docbookwrappertag_.empty())
1937 docbookwrappertag_ = "NONE";
1938 return docbookwrappertag_;
1942 string const & Layout::docbookwrapperattr() const
1944 return docbookwrapperattr_;
1948 string const & Layout::docbookwrappertagtype() const
1950 if (!isValidTagType(docbookwrappertagtype_))
1951 docbookwrappertagtype_ = "block";
1952 return docbookwrappertagtype_;
1956 string const & Layout::docbooksectiontag() const
1958 if (docbooksectiontag_.empty())
1959 docbooksectiontag_ = "section";
1960 return docbooksectiontag_;
1964 string const & Layout::docbookitemwrappertag() const
1966 if (docbookitemwrappertag_.empty())
1967 docbookitemwrappertag_ = "NONE";
1968 return docbookitemwrappertag_;
1972 string const & Layout::docbookitemwrapperattr() const
1974 return docbookitemwrapperattr_;
1978 string const & Layout::docbookitemwrappertagtype() const
1980 if (!isValidTagType(docbookitemwrappertagtype_))
1981 docbookitemwrappertagtype_ = "block";
1982 return docbookitemwrappertagtype_;
1986 string const & Layout::docbookitemtag() const
1988 if (docbookitemtag_.empty())
1989 docbookitemtag_ = "NONE";
1990 return docbookitemtag_;
1994 string const & Layout::docbookitemattr() const
1996 return docbookitemattr_;
2000 string const & Layout::docbookitemtagtype() const
2002 if (!isValidTagType(docbookitemtagtype_))
2003 docbookitemtagtype_ = "block";
2004 return docbookitemtagtype_;
2008 string const & Layout::docbookitemlabeltag() const
2010 if (docbookitemlabeltag_.empty())
2011 docbookitemlabeltag_ = "NONE";
2012 return docbookitemlabeltag_;
2016 string const & Layout::docbookitemlabelattr() const
2018 return docbookitemlabelattr_;
2022 string const & Layout::docbookitemlabeltagtype() const
2024 if (!isValidTagType(docbookitemlabeltagtype_))
2025 docbookitemlabeltagtype_ = "block";
2026 return docbookitemlabeltagtype_;
2030 string const & Layout::docbookiteminnertag() const
2032 if (docbookiteminnertag_.empty())
2033 docbookiteminnertag_ = "NONE";
2034 return docbookiteminnertag_;
2038 string const & Layout::docbookiteminnerattr() const
2040 return docbookiteminnerattr_;
2044 string const & Layout::docbookiteminnertagtype() const
2046 if (!isValidTagType(docbookiteminnertagtype_))
2047 docbookiteminnertagtype_ = "block";
2048 return docbookiteminnertagtype_;
2052 std::string const & Layout::docbookforceabstracttag() const
2054 if (docbookforceabstracttag_.empty())
2055 docbookforceabstracttag_ = "NONE";
2056 return docbookforceabstracttag_;
2063 string makeMarginValue(char const * side, double d)
2066 os << "margin-" << side << ": " << d << "ex;\n";
2073 void Layout::makeDefaultCSS() const
2075 // this never needs to be redone, since reloading layouts will
2076 // wipe out what we did before.
2077 if (!htmldefaultstyle_.empty())
2081 htmldefaultstyle_ = font.asCSS();
2086 tmp += makeMarginValue("top", topsep);
2088 tmp += makeMarginValue("bottom", bottomsep);
2089 if (!leftmargin.empty()) {
2090 // we can't really do what LyX does with the margin, so
2091 // we'll just figure out how many characters it is
2092 int const len = leftmargin.length();
2093 tmp += makeMarginValue("left", len);
2095 if (!rightmargin.empty()) {
2096 int const len = rightmargin.length();
2097 tmp += makeMarginValue("right", len);
2101 if (!htmldefaultstyle_.empty())
2102 htmldefaultstyle_ += from_ascii("\n");
2103 htmldefaultstyle_ += from_ascii(tmp);
2107 string where = alignmentToCSS(align);
2108 if (!where.empty()) {
2109 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
2112 // wrap up what we have, if anything
2113 if (!htmldefaultstyle_.empty())
2115 from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
2116 htmldefaultstyle_ + from_ascii("\n}\n");
2118 if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
2124 if (labelfont != font)
2125 labelCSS = labelfont.asCSS() + from_ascii("\n");
2126 if (labeltype == LABEL_CENTERED)
2127 labelCSS += from_ascii("text-align: center;\n");
2129 if (!labelCSS.empty())
2130 htmldefaultstyle_ +=
2131 from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
2132 labelCSS + from_ascii("\n}\n");
2136 bool Layout::operator==(Layout const & rhs) const
2138 // This is enough for the applications we actually make,
2139 // at least at the moment. But we could check more.
2140 return name() == rhs.name()
2141 && latexname() == rhs.latexname()
2142 && latextype == rhs.latextype;