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.
19 #include "output_xhtml.h"
20 #include "TextClass.h"
22 #include "support/debug.h"
23 #include "support/docstream.h"
24 #include "support/lassert.h"
25 #include "support/lstrings.h"
26 #include "support/Messages.h"
27 #include "support/textutils.h"
31 using namespace lyx::support;
35 /// Special value of toclevel for layouts that do not belong to a TOC
36 const int Layout::NOT_IN_TOC = -1000;
38 // The order of the LayoutTags enum is no more important. [asierra300396]
58 LT_PARBREAK_IS_NEWLINE,
68 LT_LABELSTRING_APPENDIX,
113 LT_DOCBOOKINNERTAGTYPE,
116 LT_DOCBOOKWRAPPERTAG,
117 LT_DOCBOOKWRAPPERATTR,
118 LT_DOCBOOKWRAPPERTAGTYPE,
119 LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS,
120 LT_DOCBOOKSECTIONTAG,
121 LT_DOCBOOKITEMWRAPPERTAG,
122 LT_DOCBOOKITEMWRAPPERATTR,
123 LT_DOCBOOKITEMWRAPPERTAGTYPE,
126 LT_DOCBOOKITEMTAGTYPE,
127 LT_DOCBOOKITEMLABELTAG,
128 LT_DOCBOOKITEMLABELATTR,
129 LT_DOCBOOKITEMLABELTAGTYPE,
130 LT_DOCBOOKITEMINNERTAG,
131 LT_DOCBOOKITEMINNERATTR,
132 LT_DOCBOOKITEMINNERTAGTYPE,
133 LT_DOCBOOKFORCEABSTRACTTAG,
140 LT_STEPMASTERCOUNTER,
146 LT_INTITLE // keep this last!
149 /////////////////////
152 : add_to_toc_(false), is_toc_caption_(true)
155 margintype = MARGIN_STATIC;
156 latextype = LATEX_PARAGRAPH;
157 resumecounter = false;
158 stepmastercounter = false;
162 needcprotect = false;
163 needmboxprotect = false;
166 labelfont = inherit_font;
168 reslabelfont = sane_font;
169 nextnoindent = false;
174 labelbottomsep = 0.0;
176 align = LYX_ALIGN_BLOCK;
177 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
178 labeltype = LABEL_NO_LABEL;
179 endlabeltype = END_LABEL_NO_LABEL;
180 // Should or should not. That is the question.
181 // spacing.set(Spacing::OneHalf);
182 newline_allowed = true;
183 free_spacing = false;
185 parbreak_is_newline = false;
186 toclevel = NOT_IN_TOC;
188 htmllabelfirst_ = false;
189 htmlforcecss_ = false;
191 docbookabstract_ = false;
192 docbookwrappermergewithprevious_ = 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 { "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 { "stepmastercounter", LT_STEPMASTERCOUNTER },
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_STEPMASTERCOUNTER:
448 lex >> stepmastercounter;
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_DOCBOOKSECTIONTAG:
801 lex >> docbooksectiontag_;
804 case LT_DOCBOOKITEMWRAPPERTAG:
805 lex >> docbookitemwrappertag_;
808 case LT_DOCBOOKITEMWRAPPERATTR:
809 lex >> docbookitemwrapperattr_;
812 case LT_DOCBOOKITEMWRAPPERTAGTYPE:
813 lex >> docbookitemwrappertagtype_;
816 case LT_DOCBOOKITEMTAG:
817 lex >> docbookitemtag_;
820 case LT_DOCBOOKITEMATTR:
821 lex >> docbookitemattr_;
824 case LT_DOCBOOKITEMTAGTYPE:
825 lex >> docbookitemtagtype_;
828 case LT_DOCBOOKITEMLABELTAG:
829 lex >> docbookitemlabeltag_;
832 case LT_DOCBOOKITEMLABELATTR:
833 lex >> docbookitemlabelattr_;
836 case LT_DOCBOOKITEMLABELTAGTYPE:
837 lex >> docbookitemlabeltagtype_;
840 case LT_DOCBOOKITEMINNERTAG:
841 lex >> docbookiteminnertag_;
844 case LT_DOCBOOKITEMINNERATTR:
845 lex >> docbookiteminnerattr_;
848 case LT_DOCBOOKITEMINNERTAGTYPE:
849 lex >> docbookiteminnertagtype_;
862 add_to_toc_ = !toc_type_.empty();
865 case LT_ISTOCCAPTION:
866 lex >> is_toc_caption_;
872 // make sure we only have inpreamble = true for commands
873 if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
874 LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
875 LYXERR0("Layout name: " << name());
879 return finished && !error;
892 LexerKeyword alignTags[] = {
893 { "block", AT_BLOCK },
894 { "center", AT_CENTER },
895 { "layout", AT_LAYOUT },
897 { "right", AT_RIGHT }
901 void Layout::readAlign(Lexer & lex)
903 PushPopHelper pph(lex, alignTags);
906 case Lexer::LEX_UNDEF:
907 lex.printError("Unknown alignment `$$Token'");
913 align = LYX_ALIGN_BLOCK;
916 align = LYX_ALIGN_LEFT;
919 align = LYX_ALIGN_RIGHT;
922 align = LYX_ALIGN_CENTER;
925 align = LYX_ALIGN_LAYOUT;
931 void Layout::readAlignPossible(Lexer & lex)
933 lex.pushTable(alignTags);
934 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
935 int lineno = lex.lineNumber();
939 case Lexer::LEX_UNDEF:
940 lex.printError("Unknown alignment `$$Token'");
946 alignpossible |= LYX_ALIGN_BLOCK;
949 alignpossible |= LYX_ALIGN_LEFT;
952 alignpossible |= LYX_ALIGN_RIGHT;
955 alignpossible |= LYX_ALIGN_CENTER;
958 alignpossible |= LYX_ALIGN_LAYOUT;
961 } while (lineno == lex.lineNumber());
966 void Layout::readLabelType(Lexer & lex)
981 LexerKeyword labelTypeTags[] = {
982 { "above", LA_ABOVE },
983 { "bibliography", LA_BIBLIO },
984 { "centered", LA_CENTERED },
985 { "enumerate", LA_ENUMERATE },
986 { "itemize", LA_ITEMIZE },
987 { "manual", LA_MANUAL },
988 { "no_label", LA_NO_LABEL },
989 { "sensitive", LA_SENSITIVE },
990 { "static", LA_STATIC }
993 PushPopHelper pph(lex, labelTypeTags);
996 case Lexer::LEX_UNDEF:
997 lex.printError("Unknown labeltype tag `$$Token'");
1003 labeltype = LABEL_NO_LABEL;
1006 labeltype = LABEL_MANUAL;
1009 labeltype = LABEL_ABOVE;
1012 labeltype = LABEL_CENTERED;
1015 labeltype = LABEL_STATIC;
1018 labeltype = LABEL_SENSITIVE;
1021 labeltype = LABEL_ENUMERATE;
1024 labeltype = LABEL_ITEMIZE;
1027 labeltype = LABEL_BIBLIO;
1033 void Layout::readEndLabelType(Lexer & lex)
1035 // this should be const, but can't be because
1036 // of PushPopHelper.
1037 static LexerKeyword endlabelTypeTags[] = {
1038 { "box", END_LABEL_BOX },
1039 { "filled_box", END_LABEL_FILLED_BOX },
1040 { "no_label", END_LABEL_NO_LABEL },
1041 { "static", END_LABEL_STATIC }
1044 PushPopHelper pph(lex, endlabelTypeTags);
1047 case Lexer::LEX_UNDEF:
1048 lex.printError("Unknown labeltype tag `$$Token'");
1050 case END_LABEL_STATIC:
1052 case END_LABEL_FILLED_BOX:
1053 case END_LABEL_NO_LABEL:
1054 endlabeltype = static_cast<EndLabelType>(le);
1057 LYXERR0("Unhandled value " << le);
1063 void Layout::readMargin(Lexer & lex)
1065 LexerKeyword marginTags[] = {
1066 { "dynamic", MARGIN_DYNAMIC },
1067 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
1068 { "manual", MARGIN_MANUAL },
1069 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
1070 { "static", MARGIN_STATIC }
1073 PushPopHelper pph(lex, marginTags);
1077 case Lexer::LEX_UNDEF:
1078 lex.printError("Unknown margin type tag `$$Token'");
1082 case MARGIN_DYNAMIC:
1083 case MARGIN_FIRST_DYNAMIC:
1084 case MARGIN_RIGHT_ADDRESS_BOX:
1085 margintype = static_cast<MarginType>(le);
1088 LYXERR0("Unhandled value " << le);
1094 void Layout::readLatexType(Lexer & lex)
1096 LexerKeyword latexTypeTags[] = {
1097 { "bib_environment", LATEX_BIB_ENVIRONMENT },
1098 { "command", LATEX_COMMAND },
1099 { "environment", LATEX_ENVIRONMENT },
1100 { "item_environment", LATEX_ITEM_ENVIRONMENT },
1101 { "list_environment", LATEX_LIST_ENVIRONMENT },
1102 { "paragraph", LATEX_PARAGRAPH }
1105 PushPopHelper pph(lex, latexTypeTags);
1108 case Lexer::LEX_UNDEF:
1109 lex.printError("Unknown latextype tag `$$Token'");
1111 case LATEX_PARAGRAPH:
1113 case LATEX_ITEM_ENVIRONMENT:
1114 case LATEX_LIST_ENVIRONMENT:
1115 latextype = static_cast<LatexType>(le);
1117 case LATEX_ENVIRONMENT:
1118 case LATEX_BIB_ENVIRONMENT:
1119 latextype = static_cast<LatexType>(le);
1123 LYXERR0("Unhandled value " << le);
1129 void Layout::readSpacing(Lexer & lex)
1132 ST_SPACING_SINGLE = 1,
1138 LexerKeyword spacingTags[] = {
1139 {"double", ST_SPACING_DOUBLE },
1140 {"onehalf", ST_SPACING_ONEHALF },
1141 {"other", ST_OTHER },
1142 {"single", ST_SPACING_SINGLE }
1145 PushPopHelper pph(lex, spacingTags);
1148 case Lexer::LEX_UNDEF:
1149 lex.printError("Unknown spacing token `$$Token'");
1154 case ST_SPACING_SINGLE:
1155 spacing.set(Spacing::Single);
1157 case ST_SPACING_ONEHALF:
1158 spacing.set(Spacing::Onehalf);
1160 case ST_SPACING_DOUBLE:
1161 spacing.set(Spacing::Double);
1165 spacing.set(Spacing::Other, lex.getString());
1171 void Layout::readArgument(Lexer & lex, bool validating)
1174 LYXERR0("Unable to read argument ID!");
1177 string const id = lex.getString();
1179 bool const itemarg = prefixIs(id, "item:");
1180 bool const postcmd = prefixIs(id, "post:");
1181 bool const listpreamble = prefixIs(id, "listpreamble:");
1183 LaTeXArgMap & lam = itemarg ? itemargs_ :
1184 (postcmd ? postcommandargs_ :
1185 (listpreamble ? listpreamble_ :
1187 latexarg & arg = lam[id];
1190 bool finished = false;
1191 while (!finished && lex.isOK() && !error) {
1193 string const tok = ascii_lowercase(lex.getString());
1197 } else if (tok == "endargument") {
1199 } else if (tok == "labelstring") {
1201 arg.labelstring = lex.getDocString();
1202 } else if (tok == "menustring") {
1204 arg.menustring = lex.getDocString();
1205 } else if (tok == "mandatory") {
1207 arg.mandatory = lex.getBool();
1208 } else if (tok == "autoinsert") {
1210 arg.autoinsert = lex.getBool();
1211 } else if (tok == "insertcotext") {
1213 arg.insertcotext = lex.getBool();
1214 } else if (tok == "leftdelim") {
1216 arg.ldelim = lex.getDocString();
1217 arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
1219 } else if (tok == "rightdelim") {
1221 arg.rdelim = lex.getDocString();
1222 arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
1224 } else if (tok == "defaultarg") {
1226 arg.defaultarg = lex.getDocString();
1227 } else if (tok == "presetarg") {
1229 arg.presetarg = lex.getDocString();
1230 } else if (tok == "tooltip") {
1232 arg.tooltip = lex.getDocString();
1233 } else if (tok == "requires") {
1235 arg.required = lex.getString();
1236 } else if (tok == "decoration") {
1238 arg.decoration = lex.getString();
1239 } else if (tok == "newlinecmd") {
1241 arg.newlinecmd = lex.getString();
1242 } else if (tok == "font") {
1243 arg.font = lyxRead(lex, arg.font);
1244 } else if (tok == "labelfont") {
1245 arg.labelfont = lyxRead(lex, arg.labelfont);
1246 } else if (tok == "passthruchars") {
1248 arg.pass_thru_chars = lex.getDocString();
1249 } else if (tok == "passthru") {
1251 docstring value = lex.getDocString();
1252 if (value == "true" || value == "1")
1253 arg.passthru = PT_TRUE;
1254 else if (value == "false" || value == "0")
1255 arg.passthru = PT_FALSE;
1257 arg.passthru = PT_INHERITED;
1258 } else if (tok == "istoccaption") {
1260 arg.is_toc_caption = lex.getBool();
1261 } else if (tok == "freespacing") {
1263 arg.free_spacing = lex.getBool();
1265 lex.printError("Unknown tag");
1269 if (!validating && arg.labelstring.empty()) {
1270 LYXERR0("Incomplete Argument definition!");
1271 // remove invalid definition
1277 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1279 os << "\tArgument " << id << '\n';
1280 if (!arg.labelstring.empty())
1281 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1282 if (!arg.menustring.empty())
1283 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1285 os << "\t\tMandatory " << arg.mandatory << '\n';
1287 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1288 if (arg.insertcotext)
1289 os << "\t\tInsertCotext " << arg.insertcotext << '\n';
1290 if (!arg.ldelim.empty())
1291 os << "\t\tLeftDelim \""
1292 << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1294 if (!arg.rdelim.empty())
1295 os << "\t\tRightDelim \""
1296 << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1298 if (!arg.defaultarg.empty())
1299 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1300 if (!arg.presetarg.empty())
1301 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1302 if (!arg.tooltip.empty())
1303 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1304 if (!arg.required.empty())
1305 os << "\t\tRequires \"" << arg.required << "\"\n";
1306 if (!arg.decoration.empty())
1307 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1308 if (!arg.newlinecmd.empty())
1309 os << "\t\tNewlineCmd \"" << arg.newlinecmd << "\"\n";
1310 if (arg.font != inherit_font)
1311 lyxWrite(os, arg.font, "Font", 2);
1312 if (arg.labelfont != inherit_font)
1313 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1314 switch (arg.passthru) {
1316 os << "\t\tPassThru true\n";
1319 os << "\t\tPassThru false\n";
1322 os << "\t\tPassThru inherited\n";
1325 if (!arg.pass_thru_chars.empty())
1326 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1327 if (arg.free_spacing)
1328 os << "\t\tFreeSpacing " << arg.free_spacing << "\n";
1329 os << "\tEndArgument\n";
1333 void Layout::write(ostream & os) const
1335 os << "Style \"" << to_utf8(name_) << "\"\n";
1336 if (!category_.empty() && obsoleted_by_.empty())
1337 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1338 // Can't deduce Copystyle here :-(
1339 if (!obsoleted_by_.empty()) {
1340 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1344 if (!depends_on_.empty())
1345 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1346 switch (margintype) {
1347 case MARGIN_DYNAMIC:
1348 os << "\tMargin Dynamic\n";
1350 case MARGIN_FIRST_DYNAMIC:
1351 os << "\tMargin First_Dynamic\n";
1354 os << "\tMargin Manual\n";
1356 case MARGIN_RIGHT_ADDRESS_BOX:
1357 os << "\tMargin Right_Address_Box\n";
1360 os << "\tMargin Static\n";
1363 switch (latextype) {
1364 case LATEX_BIB_ENVIRONMENT:
1365 os << "\tLatexType Bib_Environment\n";
1368 os << "\tLatexType Command\n";
1370 case LATEX_ENVIRONMENT:
1371 os << "\tLatexType Environment\n";
1373 case LATEX_ITEM_ENVIRONMENT:
1374 os << "\tLatexType Item_Environment\n";
1376 case LATEX_LIST_ENVIRONMENT:
1377 os << "\tLatexType List_Environment\n";
1379 case LATEX_PARAGRAPH:
1380 os << "\tLatexType Paragraph\n";
1383 os << "\tInTitle " << intitle << "\n"
1384 "\tInPreamble " << inpreamble << "\n"
1385 "\tTocLevel " << toclevel << "\n"
1386 "\tResumeCounter " << resumecounter << "\n"
1387 "\tStepMasterCounter " << stepmastercounter << '\n';
1388 // ResetArgs does not make sense here
1389 for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1390 it != latexargs_.end(); ++it)
1391 writeArgument(os, it->first, it->second);
1392 for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1393 it != itemargs_.end(); ++it)
1394 writeArgument(os, it->first, it->second);
1395 for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1396 it != postcommandargs_.end(); ++it)
1397 writeArgument(os, it->first, it->second);
1398 for (LaTeXArgMap::const_iterator it = listpreamble_.begin();
1399 it != listpreamble_.end(); ++it)
1400 writeArgument(os, it->first, it->second);
1401 os << "\tNeedProtect " << needprotect << "\n"
1402 "\tNeedCProtect " << needcprotect << "\n"
1403 "\tNeedMBoxProtect " << needmboxprotect << "\n"
1404 "\tKeepEmpty " << keepempty << '\n';
1405 if (labelfont == font)
1406 lyxWrite(os, font, "Font", 1);
1408 lyxWrite(os, font, "TextFont", 1);
1409 lyxWrite(os, labelfont, "LabelFont", 1);
1411 os << "\tNextNoIndent " << nextnoindent << "\n"
1412 "\tCommandDepth " << commanddepth << '\n';
1413 if (!latexname_.empty())
1414 os << "\tLatexName \"" << latexname_ << "\"\n";
1415 if (!latexparam_.empty())
1416 os << "\tLatexParam \"" << subst(latexparam_, "\"", """)
1418 if (!leftdelim_.empty())
1419 os << "\tLeftDelim "
1420 << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1422 if (!rightdelim_.empty())
1423 os << "\tRightDelim "
1424 << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1426 if (!innertag_.empty())
1427 os << "\tInnerTag \"" << innertag_ << "\"\n";
1428 if (!labeltag_.empty())
1429 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1430 if (!itemtag_.empty())
1431 os << "\tItemTag \"" << itemtag_ << "\"\n";
1432 if (!itemcommand_.empty())
1433 os << "\tItemCommand " << itemcommand_ << '\n';
1434 if (!preamble_.empty())
1435 os << "\tPreamble\n\t"
1436 << to_utf8(subst(rtrim(preamble_, "\n"),
1437 from_ascii("\n"), from_ascii("\n\t")))
1438 << "\n\tEndPreamble\n";
1439 if (!langpreamble_.empty())
1440 os << "\tLangPreamble\n\t"
1441 << to_utf8(subst(rtrim(langpreamble_, "\n"),
1442 from_ascii("\n"), from_ascii("\n\t")))
1443 << "\n\tEndLangPreamble\n";
1444 if (!babelpreamble_.empty())
1445 os << "\tBabelPreamble\n\t"
1446 << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1447 from_ascii("\n"), from_ascii("\n\t")))
1448 << "\n\tEndBabelPreamble\n";
1449 switch (labeltype) {
1451 os << "\tLabelType Above\n";
1454 os << "\tLabelType Bibliography\n";
1456 case LABEL_CENTERED:
1457 os << "\tLabelType Centered\n";
1459 case LABEL_ENUMERATE:
1460 os << "\tLabelType Enumerate\n";
1463 os << "\tLabelType Itemize\n";
1466 os << "\tLabelType Manual\n";
1468 case LABEL_NO_LABEL:
1469 os << "\tLabelType No_Label\n";
1471 case LABEL_SENSITIVE:
1472 os << "\tLabelType Sensitive\n";
1475 os << "\tLabelType Static\n";
1478 switch (endlabeltype) {
1480 os << "\tEndLabelType Box\n";
1482 case END_LABEL_FILLED_BOX:
1483 os << "\tEndLabelType Filled_Box\n";
1485 case END_LABEL_NO_LABEL:
1486 os << "\tEndLabelType No_Label\n";
1488 case END_LABEL_STATIC:
1489 os << "\tEndLabelType Static\n";
1492 os << "\tParagraphGroup \"" << par_group_ << "\"\n";
1493 if (!leftmargin.empty())
1494 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1495 if (!rightmargin.empty())
1496 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1497 if (!labelindent.empty())
1498 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1499 if (!parindent.empty())
1500 os << "\tParIndent " << to_utf8(parindent) << '\n';
1501 os << "\tParSkip " << parskip << "\n"
1502 "\tItemSep " << itemsep << "\n"
1503 "\tTopSep " << topsep << "\n"
1504 "\tBottomSep " << bottomsep << "\n"
1505 "\tLabelBottomSep " << labelbottomsep << '\n';
1506 if (!labelsep.empty())
1507 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1509 os << "\tParSep " << parsep << "\n"
1510 "\tNewLine " << newline_allowed << '\n';
1512 case LYX_ALIGN_BLOCK:
1513 os << "\tAlign Block\n";
1515 case LYX_ALIGN_CENTER:
1516 os << "\tAlign Center\n";
1518 case LYX_ALIGN_LAYOUT:
1519 os << "\tAlign Layout\n";
1521 case LYX_ALIGN_LEFT:
1522 os << "\tAlign Left\n";
1524 case LYX_ALIGN_RIGHT:
1525 os << "\tAlign Right\n";
1527 case LYX_ALIGN_DECIMAL:
1528 case LYX_ALIGN_SPECIAL:
1529 case LYX_ALIGN_NONE:
1532 if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1533 LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1535 os << "\tAlignPossible";
1536 if (alignpossible & LYX_ALIGN_BLOCK) {
1540 if (alignpossible & LYX_ALIGN_CENTER) {
1546 if (alignpossible & LYX_ALIGN_LAYOUT) {
1552 if (alignpossible & LYX_ALIGN_LEFT) {
1558 if (alignpossible & LYX_ALIGN_RIGHT) {
1566 // LabelString must come before LabelStringAppendix
1567 if (!labelstring_.empty())
1568 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1569 if (!endlabelstring_.empty())
1570 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1571 if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1572 os << "\tLabelStringAppendix \""
1573 << to_utf8(labelstring_appendix_) << "\"\n";
1574 if (!counter.empty())
1575 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1576 os << "\tFreeSpacing " << free_spacing << '\n';
1577 os << "\tPassThru " << pass_thru << '\n';
1578 if (!pass_thru_chars.empty())
1579 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1580 os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1581 switch (spacing.getSpace()) {
1582 case Spacing::Double:
1583 os << "\tSpacing Double\n";
1585 case Spacing::Onehalf:
1586 os << "\tSpacing Onehalf\n";
1588 case Spacing::Other:
1589 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1591 case Spacing::Single:
1592 os << "\tSpacing Single\n";
1594 case Spacing::Default:
1597 if (!required_.empty()) {
1598 os << "\tRequires ";
1599 for (set<string>::const_iterator it = required_.begin();
1600 it != required_.end(); ++it) {
1601 if (it != required_.begin())
1607 if (!autonests_.empty()) {
1608 os << "\tAutoNests\n\t";
1609 for (set<docstring>::const_iterator it = autonests_.begin();
1610 it != autonests_.end(); ++it) {
1611 if (it != autonests_.begin())
1615 os << "\n\tEndAutoNests\n";
1617 if (!autonested_by_.empty()) {
1618 os << "\tIsAutoNestedBy\n\t\t";
1619 for (set<docstring>::const_iterator it = autonested_by_.begin();
1620 it != autonested_by_.end(); ++it) {
1621 if (it != autonested_by_.begin())
1625 os << "\n\tEndIsAutoNestedBy\n";
1627 if (refprefix.empty())
1628 os << "\tRefPrefix OFF\n";
1630 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1631 if (!htmltag_.empty())
1632 os << "\tHTMLTag " << htmltag_ << '\n';
1633 if (!htmlattr_.empty())
1634 os << "\tHTMLAttr " << htmlattr_ << '\n';
1635 if (!htmlitemtag_.empty())
1636 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1637 if (!htmlitemattr_.empty())
1638 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1639 if (!htmllabeltag_.empty())
1640 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1641 if (!htmllabelattr_.empty())
1642 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1643 os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1644 if (!htmlstyle_.empty())
1645 os << "\tHTMLStyle\n"
1646 << to_utf8(rtrim(htmlstyle_, "\n"))
1647 << "\n\tEndHTMLStyle\n";
1648 os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1649 if (!htmlpreamble_.empty())
1650 os << "\tHTMLPreamble\n"
1651 << to_utf8(rtrim(htmlpreamble_, "\n"))
1652 << "\n\tEndPreamble\n";
1653 os << "\tHTMLTitle " << htmltitle_ << "\n";
1654 if(!docbooktag_.empty())
1655 os << "\tDocBookTag " << docbooktag_ << '\n';
1656 if(!docbookattr_.empty())
1657 os << "\tDocBookAttr \"" << docbookattr_ << "\"\n";
1658 if(!docbooktagtype_.empty())
1659 os << "\tDocBookTagType " << docbooktagtype_ << '\n';
1660 if(!docbookinnertag_.empty())
1661 os << "\tDocBookInnerTag " << docbookinnertag_ << '\n';
1662 if(!docbookinnerattr_.empty())
1663 os << "\tDocBookInnerAttr \"" << docbookinnerattr_ << "\"\n";
1664 if(!docbookinnertagtype_.empty())
1665 os << "\tDocBookInnerTagType " << docbookinnertagtype_ << '\n';
1666 if(!docbookininfo_.empty())
1667 os << "\tDocBookInInfo " << docbookininfo_ << '\n';
1668 os << "\tDocBookAbstract " << docbookabstract_ << '\n';
1669 if(!docbookwrappertag_.empty())
1670 os << "\tDocBookWrapperTag " << docbookwrappertag_ << '\n';
1671 if(!docbookwrapperattr_.empty())
1672 os << "\tDocBookWrapperAttr " << docbookwrapperattr_ << '\n';
1673 if(!docbookwrappertagtype_.empty())
1674 os << "\tDocBookWrapperTagType " << docbookwrappertagtype_ << '\n';
1675 if(!docbooksectiontag_.empty())
1676 os << "\tDocBookSectionTag " << docbooksectiontag_ << '\n';
1677 if(!docbookitemtag_.empty())
1678 os << "\tDocBookItemTag " << docbookitemtag_ << '\n';
1679 if(!docbookitemattr_.empty())
1680 os << "\tDocBookItemAttr " << docbookitemattr_ << '\n';
1681 if(!docbookitemtagtype_.empty())
1682 os << "\tDocBookItemTagType " << docbookitemtagtype_ << '\n';
1683 if(!docbookitemwrappertag_.empty())
1684 os << "\tDocBookItemWrapperTag " << docbookitemwrappertag_ << '\n';
1685 if(!docbookitemwrapperattr_.empty())
1686 os << "\tDocBookItemWrapperAttr " << docbookitemwrapperattr_ << '\n';
1687 if(!docbookitemwrappertagtype_.empty())
1688 os << "\tDocBookItemWrapperTagType " << docbookitemwrappertagtype_ << '\n';
1689 os << "\tDocBookWrapperMergeWithPrevious " << docbookwrappermergewithprevious_ << '\n';
1690 if(!docbookitemlabeltag_.empty())
1691 os << "\tDocBookItemLabelTag " << docbookitemlabeltag_ << '\n';
1692 if(!docbookitemlabelattr_.empty())
1693 os << "\tDocBookItemLabelAttr " << docbookitemlabelattr_ << '\n';
1694 if(!docbookitemlabeltagtype_.empty())
1695 os << "\tDocBookItemLabelTagType " << docbookitemlabeltagtype_ << '\n';
1696 if(!docbookiteminnertag_.empty())
1697 os << "\tDocBookItemInnerTag " << docbookiteminnertag_ << '\n';
1698 if(!docbookiteminnerattr_.empty())
1699 os << "\tDocBookItemInnerAttr " << docbookiteminnerattr_ << '\n';
1700 if(!docbookiteminnertagtype_.empty())
1701 os << "\tDocBookItemInnerTagType " << docbookiteminnertagtype_ << '\n';
1702 if(!docbookforceabstracttag_.empty())
1703 os << "\tDocBookForceAbstractTag " << docbookforceabstracttag_ << '\n';
1704 os << "\tSpellcheck " << spellcheck << "\n"
1705 "\tForceLocal " << forcelocal << "\n"
1710 bool Layout::hasArgs() const
1712 return !latexargs_.empty() || !postcommandargs_.empty() ||
1713 !itemargs_.empty() || !listpreamble_.empty();
1717 Layout::LaTeXArgMap Layout::args() const
1719 LaTeXArgMap args = latexargs_;
1720 if (!postcommandargs_.empty())
1721 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1722 if (!listpreamble_.empty())
1723 args.insert(listpreamble_.begin(), listpreamble_.end());
1724 if (!itemargs_.empty())
1725 args.insert(itemargs_.begin(), itemargs_.end());
1730 int Layout::optArgs() const
1733 LaTeXArgMap::const_iterator it = latexargs_.begin();
1734 for (; it != latexargs_.end(); ++it) {
1735 if (!(*it).second.mandatory)
1738 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1739 for (; iit != postcommandargs_.end(); ++iit) {
1740 if (!(*iit).second.mandatory)
1747 int Layout::requiredArgs() const
1750 LaTeXArgMap::const_iterator it = latexargs_.begin();
1751 for (; it != latexargs_.end(); ++it) {
1752 if ((*it).second.mandatory)
1755 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1756 for (; iit != postcommandargs_.end(); ++iit) {
1757 if (!(*iit).second.mandatory)
1764 string const & Layout::htmltag() const
1766 if (htmltag_.empty())
1772 string const & Layout::htmlattr() const
1774 if (htmlattr_.empty())
1775 htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
1780 string const & Layout::htmlitemtag() const
1782 if (htmlitemtag_.empty())
1783 htmlitemtag_ = "div";
1784 return htmlitemtag_;
1788 string const & Layout::htmlitemattr() const
1790 if (htmlitemattr_.empty())
1791 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1792 return htmlitemattr_;
1796 string const & Layout::htmllabeltag() const
1798 if (htmllabeltag_.empty())
1799 htmllabeltag_ = "span";
1800 return htmllabeltag_;
1804 string const & Layout::htmllabelattr() const
1806 if (htmllabelattr_.empty())
1807 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1808 return htmllabelattr_;
1812 docstring Layout::htmlstyle() const
1814 if (!htmlstyle_.empty() && !htmlforcecss_)
1816 if (htmldefaultstyle_.empty())
1818 docstring retval = htmldefaultstyle_;
1819 if (!htmlstyle_.empty())
1820 retval += '\n' + htmlstyle_;
1825 string Layout::defaultCSSClass() const
1827 if (!defaultcssclass_.empty())
1828 return defaultcssclass_;
1830 docstring::const_iterator it = name().begin();
1831 docstring::const_iterator en = name().end();
1832 for (; it != en; ++it) {
1833 char_type const c = *it;
1834 if (!isAlphaASCII(c)) {
1836 // make sure we don't start with an underscore,
1837 // as that sometimes causes problems.
1838 d = from_ascii("lyx_");
1841 } else if (isLower(c))
1844 // this is slow, so do it only if necessary
1847 defaultcssclass_ = to_utf8(d);
1848 return defaultcssclass_;
1852 string const & Layout::docbooktag() const
1854 if (docbooktag_.empty()) {
1855 if (to_ascii(name_) == "Plain Layout")
1856 docbooktag_ = "para";
1857 else // No sensible default value, unhappily...
1858 docbooktag_ = to_utf8(name_);
1864 string const & Layout::docbookattr() const
1866 // Perfectly OK to return no attributes, so docbookattr_ does not need to be filled.
1867 return docbookattr_;
1871 bool isValidTagType(std::string type)
1873 return !(type.empty() || (type != "block" && type != "paragraph" && type != "inline"));
1877 string const & Layout::docbooktagtype() const
1879 if (!isValidTagType(docbooktagtype_))
1880 docbooktagtype_ = "block";
1881 return docbooktagtype_;
1885 string const & Layout::docbookinnertag() const
1887 if (docbookinnertag_.empty())
1888 docbookinnertag_ = "NONE";
1889 return docbookinnertag_;
1893 string const & Layout::docbookinnerattr() const
1895 return docbookinnerattr_;
1899 string const & Layout::docbookinnertagtype() const
1901 if (!isValidTagType(docbookinnertagtype_))
1902 docbookinnertagtype_ = "block";
1903 return docbookinnertagtype_;
1907 string const & Layout::docbookininfo() const
1909 // Indeed, a trilean. Only titles should be "maybe": otherwise, metadata is "always", content is "never".
1910 if (docbookininfo_.empty() || (docbookininfo_ != "never" && docbookininfo_ != "always" && docbookininfo_ != "maybe"))
1911 docbookininfo_ = "never";
1912 return docbookininfo_;
1916 string const & Layout::docbookwrappertag() const
1918 if (docbookwrappertag_.empty())
1919 docbookwrappertag_ = "NONE";
1920 return docbookwrappertag_;
1924 string const & Layout::docbookwrapperattr() const
1926 return docbookwrapperattr_;
1930 string const & Layout::docbookwrappertagtype() const
1932 if (!isValidTagType(docbookwrappertagtype_))
1933 docbookwrappertagtype_ = "block";
1934 return docbookwrappertagtype_;
1938 string const & Layout::docbooksectiontag() const
1940 if (docbooksectiontag_.empty())
1941 docbooksectiontag_ = "section";
1942 return docbooksectiontag_;
1946 string const & Layout::docbookitemwrappertag() const
1948 if (docbookitemwrappertag_.empty())
1949 docbookitemwrappertag_ = "NONE";
1950 return docbookitemwrappertag_;
1954 string const & Layout::docbookitemwrapperattr() const
1956 return docbookitemwrapperattr_;
1960 string const & Layout::docbookitemwrappertagtype() const
1962 if (!isValidTagType(docbookitemwrappertagtype_))
1963 docbookitemwrappertagtype_ = "block";
1964 return docbookitemwrappertagtype_;
1968 string const & Layout::docbookitemtag() const
1970 if (docbookitemtag_.empty())
1971 docbookitemtag_ = "NONE";
1972 return docbookitemtag_;
1976 string const & Layout::docbookitemattr() const
1978 return docbookitemattr_;
1982 string const & Layout::docbookitemtagtype() const
1984 if (!isValidTagType(docbookitemtagtype_))
1985 docbookitemtagtype_ = "block";
1986 return docbookitemtagtype_;
1990 string const & Layout::docbookitemlabeltag() const
1992 if (docbookitemlabeltag_.empty())
1993 docbookitemlabeltag_ = "NONE";
1994 return docbookitemlabeltag_;
1998 string const & Layout::docbookitemlabelattr() const
2000 return docbookitemlabelattr_;
2004 string const & Layout::docbookitemlabeltagtype() const
2006 if (!isValidTagType(docbookitemlabeltagtype_))
2007 docbookitemlabeltagtype_ = "block";
2008 return docbookitemlabeltagtype_;
2012 string const & Layout::docbookiteminnertag() const
2014 if (docbookiteminnertag_.empty())
2015 docbookiteminnertag_ = "NONE";
2016 return docbookiteminnertag_;
2020 string const & Layout::docbookiteminnerattr() const
2022 return docbookiteminnerattr_;
2026 string const & Layout::docbookiteminnertagtype() const
2028 if (!isValidTagType(docbookiteminnertagtype_))
2029 docbookiteminnertagtype_ = "block";
2030 return docbookiteminnertagtype_;
2034 std::string const & Layout::docbookforceabstracttag() const
2036 if (docbookforceabstracttag_.empty())
2037 docbookforceabstracttag_ = "NONE";
2038 return docbookforceabstracttag_;
2045 string makeMarginValue(char const * side, double d)
2048 os << "margin-" << side << ": " << d << "ex;\n";
2055 void Layout::makeDefaultCSS() const
2057 // this never needs to be redone, since reloading layouts will
2058 // wipe out what we did before.
2059 if (!htmldefaultstyle_.empty())
2063 htmldefaultstyle_ = font.asCSS();
2068 tmp += makeMarginValue("top", topsep);
2070 tmp += makeMarginValue("bottom", bottomsep);
2071 if (!leftmargin.empty()) {
2072 // we can't really do what LyX does with the margin, so
2073 // we'll just figure out how many characters it is
2074 int const len = leftmargin.length();
2075 tmp += makeMarginValue("left", len);
2077 if (!rightmargin.empty()) {
2078 int const len = rightmargin.length();
2079 tmp += makeMarginValue("right", len);
2083 if (!htmldefaultstyle_.empty())
2084 htmldefaultstyle_ += from_ascii("\n");
2085 htmldefaultstyle_ += from_ascii(tmp);
2089 string where = alignmentToCSS(align);
2090 if (!where.empty()) {
2091 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
2094 // wrap up what we have, if anything
2095 if (!htmldefaultstyle_.empty())
2097 from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
2098 htmldefaultstyle_ + from_ascii("\n}\n");
2100 if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
2106 if (labelfont != font)
2107 labelCSS = labelfont.asCSS() + from_ascii("\n");
2108 if (labeltype == LABEL_CENTERED)
2109 labelCSS += from_ascii("text-align: center;\n");
2111 if (!labelCSS.empty())
2112 htmldefaultstyle_ +=
2113 from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
2114 labelCSS + from_ascii("\n}\n");
2118 bool Layout::operator==(Layout const & rhs) const
2120 // This is enough for the applications we actually make,
2121 // at least at the moment. But we could check more.
2122 return name() == rhs.name()
2123 && latexname() == rhs.latexname()
2124 && latextype == rhs.latextype;