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,
121 LT_DOCBOOKSECTIONTAG,
122 LT_DOCBOOKITEMWRAPPERTAG,
123 LT_DOCBOOKITEMWRAPPERATTR,
124 LT_DOCBOOKITEMWRAPPERTAGTYPE,
127 LT_DOCBOOKITEMTAGTYPE,
128 LT_DOCBOOKITEMLABELTAG,
129 LT_DOCBOOKITEMLABELATTR,
130 LT_DOCBOOKITEMLABELTAGTYPE,
131 LT_DOCBOOKITEMINNERTAG,
132 LT_DOCBOOKITEMINNERATTR,
133 LT_DOCBOOKITEMINNERTAGTYPE,
134 LT_DOCBOOKFORCEABSTRACTTAG,
141 LT_STEPPARENTCOUNTER,
147 LT_INTITLE // keep this last!
150 /////////////////////
153 : add_to_toc_(false), is_toc_caption_(true)
156 margintype = MARGIN_STATIC;
157 latextype = LATEX_PARAGRAPH;
158 resumecounter = false;
159 stepparentcounter = false;
163 needcprotect = false;
164 needmboxprotect = false;
167 labelfont = inherit_font;
169 reslabelfont = sane_font;
170 nextnoindent = false;
175 labelbottomsep = 0.0;
177 align = LYX_ALIGN_BLOCK;
178 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
179 labeltype = LABEL_NO_LABEL;
180 endlabeltype = END_LABEL_NO_LABEL;
181 // Should or should not. That is the question.
182 // spacing.set(Spacing::OneHalf);
183 newline_allowed = true;
184 free_spacing = false;
186 parbreak_is_newline = false;
187 toclevel = NOT_IN_TOC;
189 htmllabelfirst_ = false;
190 htmlforcecss_ = false;
192 docbookabstract_ = false;
193 docbookwrappermergewithprevious_ = false;
194 docbooksection_ = false;
197 itemcommand_ = "item";
198 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
203 bool Layout::read(Lexer & lex, TextClass const & tclass, bool validating)
205 // If this is an empty layout, or if no force local version is set,
206 // we know that we will not discard the stuff to read
208 return readIgnoreForcelocal(lex, tclass, validating);
211 bool const ret = tmp.readIgnoreForcelocal(lex, tclass, validating);
213 // - the read version is higher
214 // - both versions are infinity (arbitrary decision)
215 // - the file did not contain any local version (needed for not
216 // skipping user defined local layouts)
217 if (tmp.forcelocal <= 0 || tmp.forcelocal > forcelocal)
223 bool Layout::readIgnoreForcelocal(Lexer & lex, TextClass const & tclass,
226 // This table is sorted alphabetically [asierra 30March96]
227 LexerKeyword layoutTags[] = {
228 { "addtotoc", LT_ADDTOTOC },
229 { "align", LT_ALIGN },
230 { "alignpossible", LT_ALIGNPOSSIBLE },
231 { "argument", LT_ARGUMENT },
232 { "autonests", LT_AUTONESTS },
233 { "babelpreamble", LT_BABELPREAMBLE },
234 { "bottomsep", LT_BOTTOMSEP },
235 { "category", LT_CATEGORY },
236 { "commanddepth", LT_COMMANDDEPTH },
237 { "copystyle", LT_COPYSTYLE },
238 { "dependson", LT_DEPENDSON },
239 { "docbookabstract", LT_DOCBOOKABSTRACT },
240 { "docbookattr", LT_DOCBOOKATTR },
241 { "docbookforceabstracttag", LT_DOCBOOKFORCEABSTRACTTAG },
242 { "docbookininfo", LT_DOCBOOKININFO },
243 { "docbookinnerattr", LT_DOCBOOKINNERATTR },
244 { "docbookinnertag", LT_DOCBOOKINNERTAG },
245 { "docbookinnertagtype", LT_DOCBOOKINNERTAGTYPE },
246 { "docbookitemattr", LT_DOCBOOKITEMATTR },
247 { "docbookiteminnerattr", LT_DOCBOOKITEMINNERATTR },
248 { "docbookiteminnertag", LT_DOCBOOKITEMINNERTAG },
249 { "docbookiteminnertagtype", LT_DOCBOOKITEMINNERTAGTYPE },
250 { "docbookitemlabelattr", LT_DOCBOOKITEMLABELATTR },
251 { "docbookitemlabeltag", LT_DOCBOOKITEMLABELTAG },
252 { "docbookitemlabeltagtype", LT_DOCBOOKITEMLABELTAGTYPE },
253 { "docbookitemtag", LT_DOCBOOKITEMTAG },
254 { "docbookitemtagtype", LT_DOCBOOKITEMTAGTYPE },
255 { "docbookitemwrapperattr", LT_DOCBOOKITEMWRAPPERATTR },
256 { "docbookitemwrappertag", LT_DOCBOOKITEMWRAPPERTAG },
257 { "docbookitemwrappertagtype", LT_DOCBOOKITEMWRAPPERTAGTYPE },
258 { "docbooksection", LT_DOCBOOKSECTION },
259 { "docbooksectiontag", LT_DOCBOOKSECTIONTAG },
260 { "docbooktag", LT_DOCBOOKTAG },
261 { "docbooktagtype", LT_DOCBOOKTAGTYPE },
262 { "docbookwrapperattr", LT_DOCBOOKWRAPPERATTR },
263 { "docbookwrappermergewithprevious", LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS },
264 { "docbookwrappertag", LT_DOCBOOKWRAPPERTAG },
265 { "docbookwrappertagtype", LT_DOCBOOKWRAPPERTAGTYPE },
267 { "endlabelstring", LT_ENDLABELSTRING },
268 { "endlabeltype", LT_ENDLABELTYPE },
270 { "forcelocal", LT_FORCELOCAL },
271 { "freespacing", LT_FREE_SPACING },
272 { "htmlattr", LT_HTMLATTR },
273 { "htmlforcecss", LT_HTMLFORCECSS },
274 { "htmlitem", LT_HTMLITEM },
275 { "htmlitemattr", LT_HTMLITEMATTR },
276 { "htmllabel", LT_HTMLLABEL },
277 { "htmllabelattr", LT_HTMLLABELATTR },
278 { "htmllabelfirst", LT_HTMLLABELFIRST },
279 { "htmlpreamble", LT_HTMLPREAMBLE },
280 { "htmlstyle", LT_HTMLSTYLE },
281 { "htmltag", LT_HTMLTAG },
282 { "htmltitle", LT_HTMLTITLE },
283 { "innertag", LT_INNERTAG },
284 { "inpreamble", LT_INPREAMBLE },
285 { "intitle", LT_INTITLE },
286 { "isautonestedby", LT_AUTONESTEDBY },
287 { "istoccaption", LT_ISTOCCAPTION },
288 { "itemcommand", LT_ITEMCOMMAND },
289 { "itemsep", LT_ITEMSEP },
290 { "itemtag", LT_ITEMTAG },
291 { "keepempty", LT_KEEPEMPTY },
292 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
293 { "labelcounter", LT_LABELCOUNTER },
294 { "labelfont", LT_LABELFONT },
295 { "labelindent", LT_LABELINDENT },
296 { "labelsep", LT_LABELSEP },
297 { "labelstring", LT_LABELSTRING },
298 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
299 { "labeltag", LT_LABELTAG },
300 { "labeltype", LT_LABELTYPE },
301 { "langpreamble", LT_LANGPREAMBLE },
302 { "latexname", LT_LATEXNAME },
303 { "latexparam", LT_LATEXPARAM },
304 { "latextype", LT_LATEXTYPE },
305 { "leftdelim", LT_LEFTDELIM },
306 { "leftmargin", LT_LEFTMARGIN },
307 { "margin", LT_MARGIN },
308 { "needcprotect", LT_NEED_CPROTECT },
309 { "needmboxprotect", LT_NEED_MBOXPROTECT },
310 { "needprotect", LT_NEED_PROTECT },
311 { "newline", LT_NEWLINE },
312 { "nextnoindent", LT_NEXTNOINDENT },
313 { "obsoletedby", LT_OBSOLETEDBY },
314 { "paragraphgroup", LT_PAR_GROUP },
315 { "parbreakisnewline", LT_PARBREAK_IS_NEWLINE },
316 { "parindent", LT_PARINDENT },
317 { "parsep", LT_PARSEP },
318 { "parskip", LT_PARSKIP },
319 { "passthru", LT_PASS_THRU },
320 { "passthruchars", LT_PASS_THRU_CHARS },
321 { "preamble", LT_PREAMBLE },
322 { "refprefix", LT_REFPREFIX },
323 { "requires", LT_REQUIRES },
324 { "resetargs", LT_RESETARGS },
325 { "resumecounter", LT_RESUMECOUNTER },
326 { "rightdelim", LT_RIGHTDELIM },
327 { "rightmargin", LT_RIGHTMARGIN },
328 { "spacing", LT_SPACING },
329 { "spellcheck", LT_SPELLCHECK },
330 { "stepparentcounter", LT_STEPPARENTCOUNTER },
331 { "textfont", LT_TEXTFONT },
332 { "toclevel", LT_TOCLEVEL },
333 { "toggleindent", LT_TOGGLE_INDENT },
334 { "topsep", LT_TOPSEP }
338 bool finished = false;
339 lex.pushTable(layoutTags);
341 // parse style section
342 while (!finished && lex.isOK() && !error) {
344 // See comment in LyXRC.cpp.
346 case Lexer::LEX_FEOF:
349 case Lexer::LEX_UNDEF:
351 lex.printError("Unknown layout tag `$$Token'");
358 switch (static_cast<LayoutTags>(le)) {
370 style = subst(style, '_', ' ');
372 if (tclass.hasLayout(style)) {
373 docstring const tmpname = name_;
374 this->operator=(tclass[style]);
377 LYXERR0("Cannot copy unknown style `"
379 << "All layouts so far:");
380 DocumentClass::const_iterator lit = tclass.begin();
381 DocumentClass::const_iterator len = tclass.end();
382 for (; lit != len; ++lit)
383 LYXERR0(lit->name());
388 case LT_OBSOLETEDBY: {
391 style = subst(style, '_', ' ');
393 if (tclass.hasLayout(style)) {
394 docstring const tmpname = name_;
395 this->operator=(tclass[style]);
397 if (obsoleted_by().empty())
398 obsoleted_by_ = style;
400 LYXERR0("Cannot replace with unknown style `"
403 //lex.printError("Cannot replace with"
412 depends_on_ = subst(depends_on_, '_', ' ');
441 postcommandargs_.clear();
442 listpreamble_.clear();
446 case LT_RESUMECOUNTER:
447 lex >> resumecounter;
450 case LT_STEPPARENTCOUNTER:
451 lex >> stepparentcounter;
455 readArgument(lex, validating);
458 case LT_NEED_PROTECT:
462 case LT_NEED_CPROTECT:
466 case LT_NEED_MBOXPROTECT:
467 lex >> needmboxprotect;
475 font = lyxRead(lex, font);
480 font = lyxRead(lex, font);
484 labelfont = lyxRead(lex, labelfont);
487 case LT_NEXTNOINDENT:
491 case LT_TOGGLE_INDENT: {
494 tog = support::ascii_lowercase(tog);
496 toggle_indent = ITOGGLE_ALWAYS;
497 else if (tog == "never")
498 toggle_indent = ITOGGLE_NEVER;
500 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
504 case LT_COMMANDDEPTH:
514 latexparam_ = subst(latexparam_, """, "\"");
519 leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
525 rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
546 preamble_ = lex.getLongString(from_ascii("EndPreamble"));
549 case LT_LANGPREAMBLE:
550 langpreamble_ = lex.getLongString(from_ascii("EndLangPreamble"));
553 case LT_BABELPREAMBLE:
554 babelpreamble_ = lex.getLongString(from_ascii("EndBabelPreamble"));
561 case LT_ENDLABELTYPE:
562 readEndLabelType(lex);
597 case LT_LABEL_BOTTOMSEP:
598 lex >> labelbottomsep;
603 labelsep = subst(labelsep, 'x', ' ');
611 lex >> newline_allowed;
618 case LT_ALIGNPOSSIBLE:
619 readAlignPossible(lex);
623 // FIXME: this means LT_LABELSTRING_APPENDIX may only
624 // occur after LT_LABELSTRING
626 labelstring_appendix_ = labelstring_;
629 case LT_ENDLABELSTRING:
630 lex >> endlabelstring_;
633 case LT_LABELSTRING_APPENDIX:
634 lex >> labelstring_appendix_;
637 case LT_LABELCOUNTER:
645 case LT_FREE_SPACING:
653 case LT_PASS_THRU_CHARS:
654 lex >> pass_thru_chars;
657 case LT_PARBREAK_IS_NEWLINE:
658 lex >> parbreak_is_newline;
667 vector<string> const req =
668 getVectorFromString(lex.getString(true));
669 required_.insert(req.begin(), req.end());
674 docstring autonest = lex.getLongString(from_ascii("EndAutoNests"));
675 autonest = subst(autonest, from_ascii("\n"), docstring());
676 autonest = subst(autonest, from_ascii("\t"), docstring());
677 autonest = subst(autonest, from_ascii("\""), docstring());
678 autonest = subst(autonest, '_', ' ');
679 vector<docstring> const autonests =
680 getVectorFromString(autonest, from_ascii(","), false, true);
681 autonests_.insert(autonests.begin(), autonests.end());
685 case LT_AUTONESTEDBY: {
686 docstring autonest = lex.getLongString(from_ascii("EndIsAutoNestedBy"));
687 autonest = subst(autonest, from_ascii("\n"), docstring());
688 autonest = subst(autonest, from_ascii("\t"), docstring());
689 autonest = subst(autonest, from_ascii("\""), docstring());
690 autonest = subst(autonest, '_', ' ');
691 vector<docstring> const autonests =
692 getVectorFromString(autonest, from_ascii(","), false, true);
693 autonested_by_.insert(autonests.begin(), autonests.end());
719 case LT_HTMLITEMATTR:
720 lex >> htmlitemattr_;
724 lex >> htmllabeltag_;
727 case LT_HTMLLABELATTR:
728 lex >> htmllabelattr_;
731 case LT_HTMLLABELFIRST:
732 lex >> htmllabelfirst_;
736 htmlstyle_ = lex.getLongString(from_ascii("EndHTMLStyle"));
739 case LT_HTMLFORCECSS:
740 lex >> htmlforcecss_;
743 case LT_HTMLPREAMBLE:
744 htmlpreamble_ = lex.getLongString(from_ascii("EndPreamble"));
759 case LT_DOCBOOKTAGTYPE:
760 lex >> docbooktagtype_;
763 case LT_DOCBOOKINNERTAG:
764 lex >> docbookinnertag_;
767 case LT_DOCBOOKINNERATTR:
768 lex >> docbookinnerattr_;
771 case LT_DOCBOOKINNERTAGTYPE:
772 lex >> docbookinnertagtype_;
775 case LT_DOCBOOKFORCEABSTRACTTAG:
776 lex >> docbookforceabstracttag_;
779 case LT_DOCBOOKININFO:
780 lex >> docbookininfo_;
783 case LT_DOCBOOKABSTRACT:
784 lex >> docbookabstract_;
787 case LT_DOCBOOKWRAPPERTAG:
788 lex >> docbookwrappertag_;
791 case LT_DOCBOOKWRAPPERATTR:
792 lex >> docbookwrapperattr_;
795 case LT_DOCBOOKWRAPPERTAGTYPE:
796 lex >> docbookwrappertagtype_;
799 case LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS:
800 lex >> docbookwrappermergewithprevious_;
803 case LT_DOCBOOKSECTION:
804 lex >> docbooksection_;
807 case LT_DOCBOOKSECTIONTAG:
808 lex >> docbooksectiontag_;
811 case LT_DOCBOOKITEMWRAPPERTAG:
812 lex >> docbookitemwrappertag_;
815 case LT_DOCBOOKITEMWRAPPERATTR:
816 lex >> docbookitemwrapperattr_;
819 case LT_DOCBOOKITEMWRAPPERTAGTYPE:
820 lex >> docbookitemwrappertagtype_;
823 case LT_DOCBOOKITEMTAG:
824 lex >> docbookitemtag_;
827 case LT_DOCBOOKITEMATTR:
828 lex >> docbookitemattr_;
831 case LT_DOCBOOKITEMTAGTYPE:
832 lex >> docbookitemtagtype_;
835 case LT_DOCBOOKITEMLABELTAG:
836 lex >> docbookitemlabeltag_;
839 case LT_DOCBOOKITEMLABELATTR:
840 lex >> docbookitemlabelattr_;
843 case LT_DOCBOOKITEMLABELTAGTYPE:
844 lex >> docbookitemlabeltagtype_;
847 case LT_DOCBOOKITEMINNERTAG:
848 lex >> docbookiteminnertag_;
851 case LT_DOCBOOKITEMINNERATTR:
852 lex >> docbookiteminnerattr_;
855 case LT_DOCBOOKITEMINNERTAGTYPE:
856 lex >> docbookiteminnertagtype_;
869 add_to_toc_ = !toc_type_.empty();
872 case LT_ISTOCCAPTION:
873 lex >> is_toc_caption_;
879 // make sure we only have inpreamble = true for commands
880 if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
881 LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
882 LYXERR0("Layout name: " << name());
886 return finished && !error;
899 LexerKeyword alignTags[] = {
900 { "block", AT_BLOCK },
901 { "center", AT_CENTER },
902 { "layout", AT_LAYOUT },
904 { "right", AT_RIGHT }
908 void Layout::readAlign(Lexer & lex)
910 PushPopHelper pph(lex, alignTags);
913 case Lexer::LEX_UNDEF:
914 lex.printError("Unknown alignment `$$Token'");
920 align = LYX_ALIGN_BLOCK;
923 align = LYX_ALIGN_LEFT;
926 align = LYX_ALIGN_RIGHT;
929 align = LYX_ALIGN_CENTER;
932 align = LYX_ALIGN_LAYOUT;
938 void Layout::readAlignPossible(Lexer & lex)
940 lex.pushTable(alignTags);
941 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
942 int lineno = lex.lineNumber();
946 case Lexer::LEX_UNDEF:
947 lex.printError("Unknown alignment `$$Token'");
953 alignpossible |= LYX_ALIGN_BLOCK;
956 alignpossible |= LYX_ALIGN_LEFT;
959 alignpossible |= LYX_ALIGN_RIGHT;
962 alignpossible |= LYX_ALIGN_CENTER;
965 alignpossible |= LYX_ALIGN_LAYOUT;
968 } while (lineno == lex.lineNumber());
973 void Layout::readLabelType(Lexer & lex)
988 LexerKeyword labelTypeTags[] = {
989 { "above", LA_ABOVE },
990 { "bibliography", LA_BIBLIO },
991 { "centered", LA_CENTERED },
992 { "enumerate", LA_ENUMERATE },
993 { "itemize", LA_ITEMIZE },
994 { "manual", LA_MANUAL },
995 { "no_label", LA_NO_LABEL },
996 { "sensitive", LA_SENSITIVE },
997 { "static", LA_STATIC }
1000 PushPopHelper pph(lex, labelTypeTags);
1003 case Lexer::LEX_UNDEF:
1004 lex.printError("Unknown labeltype tag `$$Token'");
1010 labeltype = LABEL_NO_LABEL;
1013 labeltype = LABEL_MANUAL;
1016 labeltype = LABEL_ABOVE;
1019 labeltype = LABEL_CENTERED;
1022 labeltype = LABEL_STATIC;
1025 labeltype = LABEL_SENSITIVE;
1028 labeltype = LABEL_ENUMERATE;
1031 labeltype = LABEL_ITEMIZE;
1034 labeltype = LABEL_BIBLIO;
1040 void Layout::readEndLabelType(Lexer & lex)
1042 // this should be const, but can't be because
1043 // of PushPopHelper.
1044 static LexerKeyword endlabelTypeTags[] = {
1045 { "box", END_LABEL_BOX },
1046 { "filled_box", END_LABEL_FILLED_BOX },
1047 { "no_label", END_LABEL_NO_LABEL },
1048 { "static", END_LABEL_STATIC }
1051 PushPopHelper pph(lex, endlabelTypeTags);
1054 case Lexer::LEX_UNDEF:
1055 lex.printError("Unknown labeltype tag `$$Token'");
1057 case END_LABEL_STATIC:
1059 case END_LABEL_FILLED_BOX:
1060 case END_LABEL_NO_LABEL:
1061 endlabeltype = static_cast<EndLabelType>(le);
1064 LYXERR0("Unhandled value " << le);
1070 void Layout::readMargin(Lexer & lex)
1072 LexerKeyword marginTags[] = {
1073 { "dynamic", MARGIN_DYNAMIC },
1074 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
1075 { "manual", MARGIN_MANUAL },
1076 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
1077 { "static", MARGIN_STATIC }
1080 PushPopHelper pph(lex, marginTags);
1084 case Lexer::LEX_UNDEF:
1085 lex.printError("Unknown margin type tag `$$Token'");
1089 case MARGIN_DYNAMIC:
1090 case MARGIN_FIRST_DYNAMIC:
1091 case MARGIN_RIGHT_ADDRESS_BOX:
1092 margintype = static_cast<MarginType>(le);
1095 LYXERR0("Unhandled value " << le);
1101 void Layout::readLatexType(Lexer & lex)
1103 LexerKeyword latexTypeTags[] = {
1104 { "bib_environment", LATEX_BIB_ENVIRONMENT },
1105 { "command", LATEX_COMMAND },
1106 { "environment", LATEX_ENVIRONMENT },
1107 { "item_environment", LATEX_ITEM_ENVIRONMENT },
1108 { "list_environment", LATEX_LIST_ENVIRONMENT },
1109 { "paragraph", LATEX_PARAGRAPH }
1112 PushPopHelper pph(lex, latexTypeTags);
1115 case Lexer::LEX_UNDEF:
1116 lex.printError("Unknown latextype tag `$$Token'");
1118 case LATEX_PARAGRAPH:
1120 case LATEX_ITEM_ENVIRONMENT:
1121 case LATEX_LIST_ENVIRONMENT:
1122 latextype = static_cast<LatexType>(le);
1124 case LATEX_ENVIRONMENT:
1125 case LATEX_BIB_ENVIRONMENT:
1126 latextype = static_cast<LatexType>(le);
1130 LYXERR0("Unhandled value " << le);
1136 void Layout::readSpacing(Lexer & lex)
1139 ST_SPACING_SINGLE = 1,
1145 LexerKeyword spacingTags[] = {
1146 {"double", ST_SPACING_DOUBLE },
1147 {"onehalf", ST_SPACING_ONEHALF },
1148 {"other", ST_OTHER },
1149 {"single", ST_SPACING_SINGLE }
1152 PushPopHelper pph(lex, spacingTags);
1155 case Lexer::LEX_UNDEF:
1156 lex.printError("Unknown spacing token `$$Token'");
1161 case ST_SPACING_SINGLE:
1162 spacing.set(Spacing::Single);
1164 case ST_SPACING_ONEHALF:
1165 spacing.set(Spacing::Onehalf);
1167 case ST_SPACING_DOUBLE:
1168 spacing.set(Spacing::Double);
1172 spacing.set(Spacing::Other, lex.getString());
1178 void Layout::readArgument(Lexer & lex, bool validating)
1181 LYXERR0("Unable to read argument ID!");
1184 string const id = lex.getString();
1186 bool const itemarg = prefixIs(id, "item:");
1187 bool const postcmd = prefixIs(id, "post:");
1188 bool const listpreamble = prefixIs(id, "listpreamble:");
1190 LaTeXArgMap & lam = itemarg ? itemargs_ :
1191 (postcmd ? postcommandargs_ :
1192 (listpreamble ? listpreamble_ :
1194 latexarg & arg = lam[id];
1197 bool finished = false;
1198 while (!finished && lex.isOK() && !error) {
1200 string const tok = ascii_lowercase(lex.getString());
1204 } else if (tok == "endargument") {
1206 } else if (tok == "labelstring") {
1208 arg.labelstring = lex.getDocString();
1209 } else if (tok == "menustring") {
1211 arg.menustring = lex.getDocString();
1212 } else if (tok == "mandatory") {
1214 arg.mandatory = lex.getBool();
1215 } else if (tok == "autoinsert") {
1217 arg.autoinsert = lex.getBool();
1218 } else if (tok == "insertcotext") {
1220 arg.insertcotext = lex.getBool();
1221 } else if (tok == "leftdelim") {
1223 arg.ldelim = lex.getDocString();
1224 arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
1226 } else if (tok == "rightdelim") {
1228 arg.rdelim = lex.getDocString();
1229 arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
1231 } else if (tok == "defaultarg") {
1233 arg.defaultarg = lex.getDocString();
1234 } else if (tok == "presetarg") {
1236 arg.presetarg = lex.getDocString();
1237 } else if (tok == "tooltip") {
1239 arg.tooltip = lex.getDocString();
1240 } else if (tok == "requires") {
1242 arg.required = lex.getString();
1243 } else if (tok == "decoration") {
1245 arg.decoration = lex.getString();
1246 } else if (tok == "newlinecmd") {
1248 arg.newlinecmd = lex.getString();
1249 } else if (tok == "font") {
1250 arg.font = lyxRead(lex, arg.font);
1251 } else if (tok == "labelfont") {
1252 arg.labelfont = lyxRead(lex, arg.labelfont);
1253 } else if (tok == "passthruchars") {
1255 arg.pass_thru_chars = lex.getDocString();
1256 } else if (tok == "passthru") {
1258 docstring value = lex.getDocString();
1259 if (value == "true" || value == "1")
1260 arg.passthru = PT_TRUE;
1261 else if (value == "false" || value == "0")
1262 arg.passthru = PT_FALSE;
1264 arg.passthru = PT_INHERITED;
1265 } else if (tok == "istoccaption") {
1267 arg.is_toc_caption = lex.getBool();
1268 } else if (tok == "freespacing") {
1270 arg.free_spacing = lex.getBool();
1271 } else if (tok == "docbooktag") {
1273 arg.docbooktag = lex.getDocString();
1274 } else if (tok == "docbookattr") {
1276 arg.docbookattr = lex.getDocString();
1277 } else if (tok == "docbooktagtype") {
1279 arg.docbooktagtype = lex.getDocString();
1281 lex.printError("Unknown tag");
1285 if (!validating && arg.labelstring.empty()) {
1286 LYXERR0("Incomplete Argument definition!");
1287 // remove invalid definition
1293 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1295 os << "\tArgument " << id << '\n';
1296 if (!arg.labelstring.empty())
1297 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1298 if (!arg.menustring.empty())
1299 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1301 os << "\t\tMandatory " << arg.mandatory << '\n';
1303 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1304 if (arg.insertcotext)
1305 os << "\t\tInsertCotext " << arg.insertcotext << '\n';
1306 if (!arg.ldelim.empty())
1307 os << "\t\tLeftDelim \""
1308 << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1310 if (!arg.rdelim.empty())
1311 os << "\t\tRightDelim \""
1312 << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1314 if (!arg.defaultarg.empty())
1315 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1316 if (!arg.presetarg.empty())
1317 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1318 if (!arg.tooltip.empty())
1319 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1320 if (!arg.required.empty())
1321 os << "\t\tRequires \"" << arg.required << "\"\n";
1322 if (!arg.decoration.empty())
1323 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1324 if (!arg.newlinecmd.empty())
1325 os << "\t\tNewlineCmd \"" << arg.newlinecmd << "\"\n";
1326 if (arg.font != inherit_font)
1327 lyxWrite(os, arg.font, "Font", 2);
1328 if (arg.labelfont != inherit_font)
1329 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1330 switch (arg.passthru) {
1332 os << "\t\tPassThru true\n";
1335 os << "\t\tPassThru false\n";
1338 os << "\t\tPassThru inherited\n";
1341 if (!arg.pass_thru_chars.empty())
1342 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1343 if (arg.free_spacing)
1344 os << "\t\tFreeSpacing " << arg.free_spacing << "\n";
1345 os << "\tEndArgument\n";
1349 void Layout::write(ostream & os) const
1351 os << "Style \"" << to_utf8(name_) << "\"\n";
1352 if (!category_.empty() && obsoleted_by_.empty())
1353 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1354 // Can't deduce Copystyle here :-(
1355 if (!obsoleted_by_.empty()) {
1356 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1360 if (!depends_on_.empty())
1361 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1362 switch (margintype) {
1363 case MARGIN_DYNAMIC:
1364 os << "\tMargin Dynamic\n";
1366 case MARGIN_FIRST_DYNAMIC:
1367 os << "\tMargin First_Dynamic\n";
1370 os << "\tMargin Manual\n";
1372 case MARGIN_RIGHT_ADDRESS_BOX:
1373 os << "\tMargin Right_Address_Box\n";
1376 os << "\tMargin Static\n";
1379 switch (latextype) {
1380 case LATEX_BIB_ENVIRONMENT:
1381 os << "\tLatexType Bib_Environment\n";
1384 os << "\tLatexType Command\n";
1386 case LATEX_ENVIRONMENT:
1387 os << "\tLatexType Environment\n";
1389 case LATEX_ITEM_ENVIRONMENT:
1390 os << "\tLatexType Item_Environment\n";
1392 case LATEX_LIST_ENVIRONMENT:
1393 os << "\tLatexType List_Environment\n";
1395 case LATEX_PARAGRAPH:
1396 os << "\tLatexType Paragraph\n";
1399 os << "\tInTitle " << intitle << "\n"
1400 "\tInPreamble " << inpreamble << "\n"
1401 "\tTocLevel " << toclevel << "\n"
1402 "\tResumeCounter " << resumecounter << "\n"
1403 "\tStepParentCounter " << stepparentcounter << '\n';
1404 // ResetArgs does not make sense here
1405 for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1406 it != latexargs_.end(); ++it)
1407 writeArgument(os, it->first, it->second);
1408 for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1409 it != itemargs_.end(); ++it)
1410 writeArgument(os, it->first, it->second);
1411 for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1412 it != postcommandargs_.end(); ++it)
1413 writeArgument(os, it->first, it->second);
1414 for (LaTeXArgMap::const_iterator it = listpreamble_.begin();
1415 it != listpreamble_.end(); ++it)
1416 writeArgument(os, it->first, it->second);
1417 os << "\tNeedProtect " << needprotect << "\n"
1418 "\tNeedCProtect " << needcprotect << "\n"
1419 "\tNeedMBoxProtect " << needmboxprotect << "\n"
1420 "\tKeepEmpty " << keepempty << '\n';
1421 if (labelfont == font)
1422 lyxWrite(os, font, "Font", 1);
1424 lyxWrite(os, font, "TextFont", 1);
1425 lyxWrite(os, labelfont, "LabelFont", 1);
1427 os << "\tNextNoIndent " << nextnoindent << "\n"
1428 "\tCommandDepth " << commanddepth << '\n';
1429 if (!latexname_.empty())
1430 os << "\tLatexName \"" << latexname_ << "\"\n";
1431 if (!latexparam_.empty())
1432 os << "\tLatexParam \"" << subst(latexparam_, "\"", """)
1434 if (!leftdelim_.empty())
1435 os << "\tLeftDelim "
1436 << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1438 if (!rightdelim_.empty())
1439 os << "\tRightDelim "
1440 << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1442 if (!innertag_.empty())
1443 os << "\tInnerTag \"" << innertag_ << "\"\n";
1444 if (!labeltag_.empty())
1445 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1446 if (!itemtag_.empty())
1447 os << "\tItemTag \"" << itemtag_ << "\"\n";
1448 if (!itemcommand_.empty())
1449 os << "\tItemCommand " << itemcommand_ << '\n';
1450 if (!preamble_.empty())
1451 os << "\tPreamble\n\t"
1452 << to_utf8(subst(rtrim(preamble_, "\n"),
1453 from_ascii("\n"), from_ascii("\n\t")))
1454 << "\n\tEndPreamble\n";
1455 if (!langpreamble_.empty())
1456 os << "\tLangPreamble\n\t"
1457 << to_utf8(subst(rtrim(langpreamble_, "\n"),
1458 from_ascii("\n"), from_ascii("\n\t")))
1459 << "\n\tEndLangPreamble\n";
1460 if (!babelpreamble_.empty())
1461 os << "\tBabelPreamble\n\t"
1462 << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1463 from_ascii("\n"), from_ascii("\n\t")))
1464 << "\n\tEndBabelPreamble\n";
1465 switch (labeltype) {
1467 os << "\tLabelType Above\n";
1470 os << "\tLabelType Bibliography\n";
1472 case LABEL_CENTERED:
1473 os << "\tLabelType Centered\n";
1475 case LABEL_ENUMERATE:
1476 os << "\tLabelType Enumerate\n";
1479 os << "\tLabelType Itemize\n";
1482 os << "\tLabelType Manual\n";
1484 case LABEL_NO_LABEL:
1485 os << "\tLabelType No_Label\n";
1487 case LABEL_SENSITIVE:
1488 os << "\tLabelType Sensitive\n";
1491 os << "\tLabelType Static\n";
1494 switch (endlabeltype) {
1496 os << "\tEndLabelType Box\n";
1498 case END_LABEL_FILLED_BOX:
1499 os << "\tEndLabelType Filled_Box\n";
1501 case END_LABEL_NO_LABEL:
1502 os << "\tEndLabelType No_Label\n";
1504 case END_LABEL_STATIC:
1505 os << "\tEndLabelType Static\n";
1508 os << "\tParagraphGroup \"" << par_group_ << "\"\n";
1509 if (!leftmargin.empty())
1510 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1511 if (!rightmargin.empty())
1512 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1513 if (!labelindent.empty())
1514 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1515 if (!parindent.empty())
1516 os << "\tParIndent " << to_utf8(parindent) << '\n';
1517 os << "\tParSkip " << parskip << "\n"
1518 "\tItemSep " << itemsep << "\n"
1519 "\tTopSep " << topsep << "\n"
1520 "\tBottomSep " << bottomsep << "\n"
1521 "\tLabelBottomSep " << labelbottomsep << '\n';
1522 if (!labelsep.empty())
1523 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1525 os << "\tParSep " << parsep << "\n"
1526 "\tNewLine " << newline_allowed << '\n';
1528 case LYX_ALIGN_BLOCK:
1529 os << "\tAlign Block\n";
1531 case LYX_ALIGN_CENTER:
1532 os << "\tAlign Center\n";
1534 case LYX_ALIGN_LAYOUT:
1535 os << "\tAlign Layout\n";
1537 case LYX_ALIGN_LEFT:
1538 os << "\tAlign Left\n";
1540 case LYX_ALIGN_RIGHT:
1541 os << "\tAlign Right\n";
1543 case LYX_ALIGN_DECIMAL:
1544 case LYX_ALIGN_SPECIAL:
1545 case LYX_ALIGN_NONE:
1548 if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1549 LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1551 os << "\tAlignPossible";
1552 if (alignpossible & LYX_ALIGN_BLOCK) {
1556 if (alignpossible & LYX_ALIGN_CENTER) {
1562 if (alignpossible & LYX_ALIGN_LAYOUT) {
1568 if (alignpossible & LYX_ALIGN_LEFT) {
1574 if (alignpossible & LYX_ALIGN_RIGHT) {
1582 // LabelString must come before LabelStringAppendix
1583 if (!labelstring_.empty())
1584 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1585 if (!endlabelstring_.empty())
1586 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1587 if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1588 os << "\tLabelStringAppendix \""
1589 << to_utf8(labelstring_appendix_) << "\"\n";
1590 if (!counter.empty())
1591 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1592 os << "\tFreeSpacing " << free_spacing << '\n';
1593 os << "\tPassThru " << pass_thru << '\n';
1594 if (!pass_thru_chars.empty())
1595 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1596 os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1597 switch (spacing.getSpace()) {
1598 case Spacing::Double:
1599 os << "\tSpacing Double\n";
1601 case Spacing::Onehalf:
1602 os << "\tSpacing Onehalf\n";
1604 case Spacing::Other:
1605 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1607 case Spacing::Single:
1608 os << "\tSpacing Single\n";
1610 case Spacing::Default:
1613 if (!required_.empty()) {
1614 os << "\tRequires ";
1615 for (set<string>::const_iterator it = required_.begin();
1616 it != required_.end(); ++it) {
1617 if (it != required_.begin())
1623 if (!autonests_.empty()) {
1624 os << "\tAutoNests\n\t";
1625 for (set<docstring>::const_iterator it = autonests_.begin();
1626 it != autonests_.end(); ++it) {
1627 if (it != autonests_.begin())
1631 os << "\n\tEndAutoNests\n";
1633 if (!autonested_by_.empty()) {
1634 os << "\tIsAutoNestedBy\n\t\t";
1635 for (set<docstring>::const_iterator it = autonested_by_.begin();
1636 it != autonested_by_.end(); ++it) {
1637 if (it != autonested_by_.begin())
1641 os << "\n\tEndIsAutoNestedBy\n";
1643 if (refprefix.empty())
1644 os << "\tRefPrefix OFF\n";
1646 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1647 if (!htmltag_.empty())
1648 os << "\tHTMLTag " << htmltag_ << '\n';
1649 if (!htmlattr_.empty())
1650 os << "\tHTMLAttr " << htmlattr_ << '\n';
1651 if (!htmlitemtag_.empty())
1652 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1653 if (!htmlitemattr_.empty())
1654 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1655 if (!htmllabeltag_.empty())
1656 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1657 if (!htmllabelattr_.empty())
1658 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1659 os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1660 if (!htmlstyle_.empty())
1661 os << "\tHTMLStyle\n"
1662 << to_utf8(rtrim(htmlstyle_, "\n"))
1663 << "\n\tEndHTMLStyle\n";
1664 os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1665 if (!htmlpreamble_.empty())
1666 os << "\tHTMLPreamble\n"
1667 << to_utf8(rtrim(htmlpreamble_, "\n"))
1668 << "\n\tEndPreamble\n";
1669 os << "\tHTMLTitle " << htmltitle_ << "\n";
1670 if(!docbooktag_.empty())
1671 os << "\tDocBookTag " << docbooktag_ << '\n';
1672 if(!docbookattr_.empty())
1673 os << "\tDocBookAttr \"" << docbookattr_ << "\"\n";
1674 if(!docbooktagtype_.empty())
1675 os << "\tDocBookTagType " << docbooktagtype_ << '\n';
1676 if(!docbookinnertag_.empty())
1677 os << "\tDocBookInnerTag " << docbookinnertag_ << '\n';
1678 if(!docbookinnerattr_.empty())
1679 os << "\tDocBookInnerAttr \"" << docbookinnerattr_ << "\"\n";
1680 if(!docbookinnertagtype_.empty())
1681 os << "\tDocBookInnerTagType " << docbookinnertagtype_ << '\n';
1682 if(!docbookininfo_.empty())
1683 os << "\tDocBookInInfo " << docbookininfo_ << '\n';
1684 os << "\tDocBookAbstract " << docbookabstract_ << '\n';
1685 if(!docbookwrappertag_.empty())
1686 os << "\tDocBookWrapperTag " << docbookwrappertag_ << '\n';
1687 if(!docbookwrapperattr_.empty())
1688 os << "\tDocBookWrapperAttr " << docbookwrapperattr_ << '\n';
1689 if(!docbookwrappertagtype_.empty())
1690 os << "\tDocBookWrapperTagType " << docbookwrappertagtype_ << '\n';
1691 os << "\tDocBookSection " << docbooksection_ << '\n';
1692 if(!docbooksectiontag_.empty())
1693 os << "\tDocBookSectionTag " << docbooksectiontag_ << '\n';
1694 if(!docbookitemtag_.empty())
1695 os << "\tDocBookItemTag " << docbookitemtag_ << '\n';
1696 if(!docbookitemattr_.empty())
1697 os << "\tDocBookItemAttr " << docbookitemattr_ << '\n';
1698 if(!docbookitemtagtype_.empty())
1699 os << "\tDocBookItemTagType " << docbookitemtagtype_ << '\n';
1700 if(!docbookitemwrappertag_.empty())
1701 os << "\tDocBookItemWrapperTag " << docbookitemwrappertag_ << '\n';
1702 if(!docbookitemwrapperattr_.empty())
1703 os << "\tDocBookItemWrapperAttr " << docbookitemwrapperattr_ << '\n';
1704 if(!docbookitemwrappertagtype_.empty())
1705 os << "\tDocBookItemWrapperTagType " << docbookitemwrappertagtype_ << '\n';
1706 os << "\tDocBookWrapperMergeWithPrevious " << docbookwrappermergewithprevious_ << '\n';
1707 if(!docbookitemlabeltag_.empty())
1708 os << "\tDocBookItemLabelTag " << docbookitemlabeltag_ << '\n';
1709 if(!docbookitemlabelattr_.empty())
1710 os << "\tDocBookItemLabelAttr " << docbookitemlabelattr_ << '\n';
1711 if(!docbookitemlabeltagtype_.empty())
1712 os << "\tDocBookItemLabelTagType " << docbookitemlabeltagtype_ << '\n';
1713 if(!docbookiteminnertag_.empty())
1714 os << "\tDocBookItemInnerTag " << docbookiteminnertag_ << '\n';
1715 if(!docbookiteminnerattr_.empty())
1716 os << "\tDocBookItemInnerAttr " << docbookiteminnerattr_ << '\n';
1717 if(!docbookiteminnertagtype_.empty())
1718 os << "\tDocBookItemInnerTagType " << docbookiteminnertagtype_ << '\n';
1719 if(!docbookforceabstracttag_.empty())
1720 os << "\tDocBookForceAbstractTag " << docbookforceabstracttag_ << '\n';
1721 os << "\tSpellcheck " << spellcheck << "\n"
1722 "\tForceLocal " << forcelocal << "\n"
1727 bool Layout::hasArgs() const
1729 return !latexargs_.empty() || !postcommandargs_.empty() ||
1730 !itemargs_.empty() || !listpreamble_.empty();
1734 Layout::LaTeXArgMap Layout::args() const
1736 LaTeXArgMap args = latexargs_;
1737 if (!postcommandargs_.empty())
1738 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1739 if (!listpreamble_.empty())
1740 args.insert(listpreamble_.begin(), listpreamble_.end());
1741 if (!itemargs_.empty())
1742 args.insert(itemargs_.begin(), itemargs_.end());
1747 int Layout::optArgs() 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 int Layout::requiredArgs() const
1767 LaTeXArgMap::const_iterator it = latexargs_.begin();
1768 for (; it != latexargs_.end(); ++it) {
1769 if ((*it).second.mandatory)
1772 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1773 for (; iit != postcommandargs_.end(); ++iit) {
1774 if (!(*iit).second.mandatory)
1781 string const & Layout::htmltag() const
1783 if (htmltag_.empty())
1789 string const & Layout::htmlattr() const
1791 if (htmlattr_.empty())
1792 htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
1797 string const & Layout::htmlitemtag() const
1799 if (htmlitemtag_.empty())
1800 htmlitemtag_ = "div";
1801 return htmlitemtag_;
1805 string const & Layout::htmlitemattr() const
1807 if (htmlitemattr_.empty())
1808 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1809 return htmlitemattr_;
1813 string const & Layout::htmllabeltag() const
1815 if (htmllabeltag_.empty())
1816 htmllabeltag_ = "span";
1817 return htmllabeltag_;
1821 string const & Layout::htmllabelattr() const
1823 if (htmllabelattr_.empty())
1824 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1825 return htmllabelattr_;
1829 docstring Layout::htmlstyle() const
1831 if (!htmlstyle_.empty() && !htmlforcecss_)
1833 if (htmldefaultstyle_.empty())
1835 docstring retval = htmldefaultstyle_;
1836 if (!htmlstyle_.empty())
1837 retval += '\n' + htmlstyle_;
1842 string Layout::defaultCSSClass() const
1844 if (!defaultcssclass_.empty())
1845 return defaultcssclass_;
1847 docstring::const_iterator it = name().begin();
1848 docstring::const_iterator en = name().end();
1849 for (; it != en; ++it) {
1850 char_type const c = *it;
1851 if (!isAlphaASCII(c)) {
1853 // make sure we don't start with an underscore,
1854 // as that sometimes causes problems.
1855 d = from_ascii("lyx_");
1858 } else if (isLower(c))
1861 // this is slow, so do it only if necessary
1864 defaultcssclass_ = to_utf8(d);
1865 return defaultcssclass_;
1869 string const & Layout::docbooktag() const
1871 if (docbooktag_.empty()) {
1872 if (to_ascii(name_) == "Plain Layout")
1873 docbooktag_ = "para";
1874 else // No sensible default value, unhappily...
1875 docbooktag_ = to_utf8(name_);
1881 string const & Layout::docbookattr() const
1883 // Perfectly OK to return no attributes, so docbookattr_ does not need to be filled.
1884 return docbookattr_;
1888 bool isValidTagType(std::string const & type)
1890 return !(type.empty() || (type != "block" && type != "paragraph" && type != "inline"));
1894 string const & Layout::docbooktagtype() const
1896 if (!isValidTagType(docbooktagtype_))
1897 docbooktagtype_ = "block";
1898 return docbooktagtype_;
1902 string const & Layout::docbookinnertag() const
1904 if (docbookinnertag_.empty())
1905 docbookinnertag_ = "NONE";
1906 return docbookinnertag_;
1910 string const & Layout::docbookinnerattr() const
1912 return docbookinnerattr_;
1916 string const & Layout::docbookinnertagtype() const
1918 if (!isValidTagType(docbookinnertagtype_))
1919 docbookinnertagtype_ = "block";
1920 return docbookinnertagtype_;
1924 string const & Layout::docbookininfo() const
1926 // Indeed, a trilean. Only titles should be "maybe": otherwise, metadata is "always", content is "never".
1927 if (docbookininfo_.empty() || (docbookininfo_ != "never" && docbookininfo_ != "always" && docbookininfo_ != "maybe"))
1928 docbookininfo_ = "never";
1929 return docbookininfo_;
1933 string const & Layout::docbookwrappertag() const
1935 if (docbookwrappertag_.empty())
1936 docbookwrappertag_ = "NONE";
1937 return docbookwrappertag_;
1941 string const & Layout::docbookwrapperattr() const
1943 return docbookwrapperattr_;
1947 string const & Layout::docbookwrappertagtype() const
1949 if (!isValidTagType(docbookwrappertagtype_))
1950 docbookwrappertagtype_ = "block";
1951 return docbookwrappertagtype_;
1955 string const & Layout::docbooksectiontag() const
1957 if (docbooksectiontag_.empty())
1958 docbooksectiontag_ = "section";
1959 return docbooksectiontag_;
1963 string const & Layout::docbookitemwrappertag() const
1965 if (docbookitemwrappertag_.empty())
1966 docbookitemwrappertag_ = "NONE";
1967 return docbookitemwrappertag_;
1971 string const & Layout::docbookitemwrapperattr() const
1973 return docbookitemwrapperattr_;
1977 string const & Layout::docbookitemwrappertagtype() const
1979 if (!isValidTagType(docbookitemwrappertagtype_))
1980 docbookitemwrappertagtype_ = "block";
1981 return docbookitemwrappertagtype_;
1985 string const & Layout::docbookitemtag() const
1987 if (docbookitemtag_.empty())
1988 docbookitemtag_ = "NONE";
1989 return docbookitemtag_;
1993 string const & Layout::docbookitemattr() const
1995 return docbookitemattr_;
1999 string const & Layout::docbookitemtagtype() const
2001 if (!isValidTagType(docbookitemtagtype_))
2002 docbookitemtagtype_ = "block";
2003 return docbookitemtagtype_;
2007 string const & Layout::docbookitemlabeltag() const
2009 if (docbookitemlabeltag_.empty())
2010 docbookitemlabeltag_ = "NONE";
2011 return docbookitemlabeltag_;
2015 string const & Layout::docbookitemlabelattr() const
2017 return docbookitemlabelattr_;
2021 string const & Layout::docbookitemlabeltagtype() const
2023 if (!isValidTagType(docbookitemlabeltagtype_))
2024 docbookitemlabeltagtype_ = "block";
2025 return docbookitemlabeltagtype_;
2029 string const & Layout::docbookiteminnertag() const
2031 if (docbookiteminnertag_.empty())
2032 docbookiteminnertag_ = "NONE";
2033 return docbookiteminnertag_;
2037 string const & Layout::docbookiteminnerattr() const
2039 return docbookiteminnerattr_;
2043 string const & Layout::docbookiteminnertagtype() const
2045 if (!isValidTagType(docbookiteminnertagtype_))
2046 docbookiteminnertagtype_ = "block";
2047 return docbookiteminnertagtype_;
2051 std::string const & Layout::docbookforceabstracttag() const
2053 if (docbookforceabstracttag_.empty())
2054 docbookforceabstracttag_ = "NONE";
2055 return docbookforceabstracttag_;
2062 string makeMarginValue(char const * side, double d)
2065 os << "margin-" << side << ": " << d << "ex;\n";
2072 void Layout::makeDefaultCSS() const
2074 // this never needs to be redone, since reloading layouts will
2075 // wipe out what we did before.
2076 if (!htmldefaultstyle_.empty())
2080 htmldefaultstyle_ = font.asCSS();
2085 tmp += makeMarginValue("top", topsep);
2087 tmp += makeMarginValue("bottom", bottomsep);
2088 if (!leftmargin.empty()) {
2089 // we can't really do what LyX does with the margin, so
2090 // we'll just figure out how many characters it is
2091 int const len = leftmargin.length();
2092 tmp += makeMarginValue("left", len);
2094 if (!rightmargin.empty()) {
2095 int const len = rightmargin.length();
2096 tmp += makeMarginValue("right", len);
2100 if (!htmldefaultstyle_.empty())
2101 htmldefaultstyle_ += from_ascii("\n");
2102 htmldefaultstyle_ += from_ascii(tmp);
2106 string where = alignmentToCSS(align);
2107 if (!where.empty()) {
2108 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
2111 // wrap up what we have, if anything
2112 if (!htmldefaultstyle_.empty())
2114 from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
2115 htmldefaultstyle_ + from_ascii("\n}\n");
2117 if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
2123 if (labelfont != font)
2124 labelCSS = labelfont.asCSS() + from_ascii("\n");
2125 if (labeltype == LABEL_CENTERED)
2126 labelCSS += from_ascii("text-align: center;\n");
2128 if (!labelCSS.empty())
2129 htmldefaultstyle_ +=
2130 from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
2131 labelCSS + from_ascii("\n}\n");
2135 bool Layout::operator==(Layout const & rhs) const
2137 // This is enough for the applications we actually make,
2138 // at least at the moment. But we could check more.
2139 return name() == rhs.name()
2140 && latexname() == rhs.latexname()
2141 && latextype == rhs.latextype;