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/lassert.h"
24 #include "support/lstrings.h"
25 #include "support/Messages.h"
26 #include "support/textutils.h"
30 using namespace lyx::support;
34 /// Special value of toclevel for layouts that to not belong in a TOC
35 const int Layout::NOT_IN_TOC = -1000;
37 // The order of the LayoutTags enum is no more important. [asierra300396]
57 LT_PARBREAK_IS_NEWLINE,
67 LT_LABELSTRING_APPENDIX,
112 LT_STEPMASTERCOUNTER,
118 LT_INTITLE // keep this last!
121 /////////////////////
124 : add_to_toc_(false), is_toc_caption_(true)
127 margintype = MARGIN_STATIC;
128 latextype = LATEX_PARAGRAPH;
129 resumecounter = false;
130 stepmastercounter = false;
134 needcprotect = false;
137 labelfont = inherit_font;
139 reslabelfont = sane_font;
140 nextnoindent = false;
145 labelbottomsep = 0.0;
147 align = LYX_ALIGN_BLOCK;
148 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
149 labeltype = LABEL_NO_LABEL;
150 endlabeltype = END_LABEL_NO_LABEL;
151 // Should or should not. That is the question.
152 // spacing.set(Spacing::OneHalf);
153 newline_allowed = true;
154 free_spacing = false;
156 parbreak_is_newline = false;
157 toclevel = NOT_IN_TOC;
159 htmllabelfirst_ = false;
160 htmlforcecss_ = false;
164 itemcommand_ = "item";
165 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
170 bool Layout::read(Lexer & lex, TextClass const & tclass)
172 // If this is an empty layout, or if no force local version is set,
173 // we know that we will not discard the stuff to read
175 return readIgnoreForcelocal(lex, tclass);
178 bool const ret = tmp.readIgnoreForcelocal(lex, tclass);
180 // - the read version is higher
181 // - both versions are infinity (arbitrary decision)
182 // - the file did not contain any local version (needed for not
183 // skipping user defined local layouts)
184 if (tmp.forcelocal <= 0 || tmp.forcelocal > forcelocal)
190 bool Layout::readIgnoreForcelocal(Lexer & lex, TextClass const & tclass)
192 // This table is sorted alphabetically [asierra 30March96]
193 LexerKeyword layoutTags[] = {
194 { "addtotoc", LT_ADDTOTOC },
195 { "align", LT_ALIGN },
196 { "alignpossible", LT_ALIGNPOSSIBLE },
197 { "argument", LT_ARGUMENT },
198 { "autonests", LT_AUTONESTS },
199 { "babelpreamble", LT_BABELPREAMBLE },
200 { "bottomsep", LT_BOTTOMSEP },
201 { "category", LT_CATEGORY },
202 { "commanddepth", LT_COMMANDDEPTH },
203 { "copystyle", LT_COPYSTYLE },
204 { "dependson", LT_DEPENDSON },
206 { "endlabelstring", LT_ENDLABELSTRING },
207 { "endlabeltype", LT_ENDLABELTYPE },
209 { "forcelocal", LT_FORCELOCAL },
210 { "freespacing", LT_FREE_SPACING },
211 { "htmlattr", LT_HTMLATTR },
212 { "htmlforcecss", LT_HTMLFORCECSS },
213 { "htmlitem", LT_HTMLITEM },
214 { "htmlitemattr", LT_HTMLITEMATTR },
215 { "htmllabel", LT_HTMLLABEL },
216 { "htmllabelattr", LT_HTMLLABELATTR },
217 { "htmllabelfirst", LT_HTMLLABELFIRST },
218 { "htmlpreamble", LT_HTMLPREAMBLE },
219 { "htmlstyle", LT_HTMLSTYLE },
220 { "htmltag", LT_HTMLTAG },
221 { "htmltitle", LT_HTMLTITLE },
222 { "innertag", LT_INNERTAG },
223 { "inpreamble", LT_INPREAMBLE },
224 { "intitle", LT_INTITLE },
225 { "isautonestedby", LT_AUTONESTEDBY },
226 { "istoccaption", LT_ISTOCCAPTION },
227 { "itemcommand", LT_ITEMCOMMAND },
228 { "itemsep", LT_ITEMSEP },
229 { "itemtag", LT_ITEMTAG },
230 { "keepempty", LT_KEEPEMPTY },
231 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
232 { "labelcounter", LT_LABELCOUNTER },
233 { "labelfont", LT_LABELFONT },
234 { "labelindent", LT_LABELINDENT },
235 { "labelsep", LT_LABELSEP },
236 { "labelstring", LT_LABELSTRING },
237 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
238 { "labeltag", LT_LABELTAG },
239 { "labeltype", LT_LABELTYPE },
240 { "langpreamble", LT_LANGPREAMBLE },
241 { "latexname", LT_LATEXNAME },
242 { "latexparam", LT_LATEXPARAM },
243 { "latextype", LT_LATEXTYPE },
244 { "leftdelim", LT_LEFTDELIM },
245 { "leftmargin", LT_LEFTMARGIN },
246 { "margin", LT_MARGIN },
247 { "needcprotect", LT_NEED_CPROTECT },
248 { "needprotect", LT_NEED_PROTECT },
249 { "newline", LT_NEWLINE },
250 { "nextnoindent", LT_NEXTNOINDENT },
251 { "obsoletedby", LT_OBSOLETEDBY },
252 { "paragraphgroup", LT_PAR_GROUP },
253 { "parbreakisnewline", LT_PARBREAK_IS_NEWLINE },
254 { "parindent", LT_PARINDENT },
255 { "parsep", LT_PARSEP },
256 { "parskip", LT_PARSKIP },
257 { "passthru", LT_PASS_THRU },
258 { "passthruchars", LT_PASS_THRU_CHARS },
259 { "preamble", LT_PREAMBLE },
260 { "refprefix", LT_REFPREFIX },
261 { "requires", LT_REQUIRES },
262 { "resetargs", LT_RESETARGS },
263 { "resumecounter", LT_RESUMECOUNTER },
264 { "rightdelim", LT_RIGHTDELIM },
265 { "rightmargin", LT_RIGHTMARGIN },
266 { "spacing", LT_SPACING },
267 { "spellcheck", LT_SPELLCHECK },
268 { "stepmastercounter", LT_STEPMASTERCOUNTER },
269 { "textfont", LT_TEXTFONT },
270 { "toclevel", LT_TOCLEVEL },
271 { "toggleindent", LT_TOGGLE_INDENT },
272 { "topsep", LT_TOPSEP }
276 bool finished = false;
277 lex.pushTable(layoutTags);
279 // parse style section
280 while (!finished && lex.isOK() && !error) {
282 // See comment in LyXRC.cpp.
284 case Lexer::LEX_FEOF:
287 case Lexer::LEX_UNDEF:
289 lex.printError("Unknown layout tag `$$Token'");
296 switch (static_cast<LayoutTags>(le)) {
308 style = subst(style, '_', ' ');
310 if (tclass.hasLayout(style)) {
311 docstring const tmpname = name_;
312 this->operator=(tclass[style]);
315 LYXERR0("Cannot copy unknown style `"
317 << "All layouts so far:");
318 DocumentClass::const_iterator lit = tclass.begin();
319 DocumentClass::const_iterator len = tclass.end();
320 for (; lit != len; ++lit)
321 LYXERR0(lit->name());
326 case LT_OBSOLETEDBY: {
329 style = subst(style, '_', ' ');
331 if (tclass.hasLayout(style)) {
332 docstring const tmpname = name_;
333 this->operator=(tclass[style]);
335 if (obsoleted_by().empty())
336 obsoleted_by_ = style;
338 LYXERR0("Cannot replace with unknown style `"
341 //lex.printError("Cannot replace with"
350 depends_on_ = subst(depends_on_, '_', ' ');
379 postcommandargs_.clear();
380 listpreamble_.clear();
384 case LT_RESUMECOUNTER:
385 lex >> resumecounter;
388 case LT_STEPMASTERCOUNTER:
389 lex >> stepmastercounter;
396 case LT_NEED_PROTECT:
400 case LT_NEED_CPROTECT:
409 font = lyxRead(lex, font);
414 font = lyxRead(lex, font);
418 labelfont = lyxRead(lex, labelfont);
421 case LT_NEXTNOINDENT:
425 case LT_TOGGLE_INDENT: {
428 tog = support::ascii_lowercase(tog);
430 toggle_indent = ITOGGLE_ALWAYS;
431 else if (tog == "never")
432 toggle_indent = ITOGGLE_NEVER;
434 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
438 case LT_COMMANDDEPTH:
448 latexparam_ = subst(latexparam_, """, "\"");
453 leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
459 rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
480 preamble_ = lex.getLongString(from_ascii("EndPreamble"));
483 case LT_LANGPREAMBLE:
484 langpreamble_ = lex.getLongString(from_ascii("EndLangPreamble"));
487 case LT_BABELPREAMBLE:
488 babelpreamble_ = lex.getLongString(from_ascii("EndBabelPreamble"));
495 case LT_ENDLABELTYPE:
496 readEndLabelType(lex);
531 case LT_LABEL_BOTTOMSEP:
532 lex >> labelbottomsep;
537 labelsep = subst(labelsep, 'x', ' ');
545 lex >> newline_allowed;
552 case LT_ALIGNPOSSIBLE:
553 readAlignPossible(lex);
557 // FIXME: this means LT_LABELSTRING_APPENDIX may only
558 // occur after LT_LABELSTRING
560 labelstring_appendix_ = labelstring_;
563 case LT_ENDLABELSTRING:
564 lex >> endlabelstring_;
567 case LT_LABELSTRING_APPENDIX:
568 lex >> labelstring_appendix_;
571 case LT_LABELCOUNTER:
579 case LT_FREE_SPACING:
587 case LT_PASS_THRU_CHARS:
588 lex >> pass_thru_chars;
591 case LT_PARBREAK_IS_NEWLINE:
592 lex >> parbreak_is_newline;
601 vector<string> const req =
602 getVectorFromString(lex.getString(true));
603 requires_.insert(req.begin(), req.end());
608 docstring autonest = lex.getLongString(from_ascii("EndAutoNests"));
609 autonest = subst(autonest, from_ascii("\n"), docstring());
610 autonest = subst(autonest, from_ascii("\t"), docstring());
611 autonest = subst(autonest, from_ascii("\""), docstring());
612 autonest = subst(autonest, '_', ' ');
613 vector<docstring> const autonests =
614 getVectorFromString(autonest, from_ascii(","), false, true);
615 autonests_.insert(autonests.begin(), autonests.end());
619 case LT_AUTONESTEDBY: {
620 docstring autonest = lex.getLongString(from_ascii("EndIsAutoNestedBy"));
621 autonest = subst(autonest, from_ascii("\n"), docstring());
622 autonest = subst(autonest, from_ascii("\t"), docstring());
623 autonest = subst(autonest, from_ascii("\""), docstring());
624 autonest = subst(autonest, '_', ' ');
625 vector<docstring> const autonests =
626 getVectorFromString(autonest, from_ascii(","), false, true);
627 autonested_by_.insert(autonests.begin(), autonests.end());
653 case LT_HTMLITEMATTR:
654 lex >> htmlitemattr_;
658 lex >> htmllabeltag_;
661 case LT_HTMLLABELATTR:
662 lex >> htmllabelattr_;
665 case LT_HTMLLABELFIRST:
666 lex >> htmllabelfirst_;
670 htmlstyle_ = lex.getLongString(from_ascii("EndHTMLStyle"));
673 case LT_HTMLFORCECSS:
674 lex >> htmlforcecss_;
677 case LT_HTMLPREAMBLE:
678 htmlpreamble_ = lex.getLongString(from_ascii("EndPreamble"));
695 add_to_toc_ = !toc_type_.empty();
698 case LT_ISTOCCAPTION:
699 lex >> is_toc_caption_;
705 // make sure we only have inpreamble = true for commands
706 if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
707 LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
708 LYXERR0("Layout name: " << name());
712 return finished && !error;
725 LexerKeyword alignTags[] = {
726 { "block", AT_BLOCK },
727 { "center", AT_CENTER },
728 { "layout", AT_LAYOUT },
730 { "right", AT_RIGHT }
734 void Layout::readAlign(Lexer & lex)
736 PushPopHelper pph(lex, alignTags);
739 case Lexer::LEX_UNDEF:
740 lex.printError("Unknown alignment `$$Token'");
746 align = LYX_ALIGN_BLOCK;
749 align = LYX_ALIGN_LEFT;
752 align = LYX_ALIGN_RIGHT;
755 align = LYX_ALIGN_CENTER;
758 align = LYX_ALIGN_LAYOUT;
764 void Layout::readAlignPossible(Lexer & lex)
766 lex.pushTable(alignTags);
767 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
768 int lineno = lex.lineNumber();
772 case Lexer::LEX_UNDEF:
773 lex.printError("Unknown alignment `$$Token'");
779 alignpossible |= LYX_ALIGN_BLOCK;
782 alignpossible |= LYX_ALIGN_LEFT;
785 alignpossible |= LYX_ALIGN_RIGHT;
788 alignpossible |= LYX_ALIGN_CENTER;
791 alignpossible |= LYX_ALIGN_LAYOUT;
794 } while (lineno == lex.lineNumber());
799 void Layout::readLabelType(Lexer & lex)
814 LexerKeyword labelTypeTags[] = {
815 { "above", LA_ABOVE },
816 { "bibliography", LA_BIBLIO },
817 { "centered", LA_CENTERED },
818 { "enumerate", LA_ENUMERATE },
819 { "itemize", LA_ITEMIZE },
820 { "manual", LA_MANUAL },
821 { "no_label", LA_NO_LABEL },
822 { "sensitive", LA_SENSITIVE },
823 { "static", LA_STATIC }
826 PushPopHelper pph(lex, labelTypeTags);
829 case Lexer::LEX_UNDEF:
830 lex.printError("Unknown labeltype tag `$$Token'");
836 labeltype = LABEL_NO_LABEL;
839 labeltype = LABEL_MANUAL;
842 labeltype = LABEL_ABOVE;
845 labeltype = LABEL_CENTERED;
848 labeltype = LABEL_STATIC;
851 labeltype = LABEL_SENSITIVE;
854 labeltype = LABEL_ENUMERATE;
857 labeltype = LABEL_ITEMIZE;
860 labeltype = LABEL_BIBLIO;
866 void Layout::readEndLabelType(Lexer & lex)
868 // this should be const, but can't be because
870 static LexerKeyword endlabelTypeTags[] = {
871 { "box", END_LABEL_BOX },
872 { "filled_box", END_LABEL_FILLED_BOX },
873 { "no_label", END_LABEL_NO_LABEL },
874 { "static", END_LABEL_STATIC }
877 PushPopHelper pph(lex, endlabelTypeTags);
880 case Lexer::LEX_UNDEF:
881 lex.printError("Unknown labeltype tag `$$Token'");
883 case END_LABEL_STATIC:
885 case END_LABEL_FILLED_BOX:
886 case END_LABEL_NO_LABEL:
887 endlabeltype = static_cast<EndLabelType>(le);
890 LYXERR0("Unhandled value " << le);
896 void Layout::readMargin(Lexer & lex)
898 LexerKeyword marginTags[] = {
899 { "dynamic", MARGIN_DYNAMIC },
900 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
901 { "manual", MARGIN_MANUAL },
902 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
903 { "static", MARGIN_STATIC }
906 PushPopHelper pph(lex, marginTags);
910 case Lexer::LEX_UNDEF:
911 lex.printError("Unknown margin type tag `$$Token'");
916 case MARGIN_FIRST_DYNAMIC:
917 case MARGIN_RIGHT_ADDRESS_BOX:
918 margintype = static_cast<MarginType>(le);
921 LYXERR0("Unhandled value " << le);
927 void Layout::readLatexType(Lexer & lex)
929 LexerKeyword latexTypeTags[] = {
930 { "bib_environment", LATEX_BIB_ENVIRONMENT },
931 { "command", LATEX_COMMAND },
932 { "environment", LATEX_ENVIRONMENT },
933 { "item_environment", LATEX_ITEM_ENVIRONMENT },
934 { "list_environment", LATEX_LIST_ENVIRONMENT },
935 { "paragraph", LATEX_PARAGRAPH }
938 PushPopHelper pph(lex, latexTypeTags);
941 case Lexer::LEX_UNDEF:
942 lex.printError("Unknown latextype tag `$$Token'");
944 case LATEX_PARAGRAPH:
946 case LATEX_ITEM_ENVIRONMENT:
947 case LATEX_LIST_ENVIRONMENT:
948 latextype = static_cast<LatexType>(le);
950 case LATEX_ENVIRONMENT:
951 case LATEX_BIB_ENVIRONMENT:
952 latextype = static_cast<LatexType>(le);
956 LYXERR0("Unhandled value " << le);
962 void Layout::readSpacing(Lexer & lex)
965 ST_SPACING_SINGLE = 1,
971 LexerKeyword spacingTags[] = {
972 {"double", ST_SPACING_DOUBLE },
973 {"onehalf", ST_SPACING_ONEHALF },
974 {"other", ST_OTHER },
975 {"single", ST_SPACING_SINGLE }
978 PushPopHelper pph(lex, spacingTags);
981 case Lexer::LEX_UNDEF:
982 lex.printError("Unknown spacing token `$$Token'");
987 case ST_SPACING_SINGLE:
988 spacing.set(Spacing::Single);
990 case ST_SPACING_ONEHALF:
991 spacing.set(Spacing::Onehalf);
993 case ST_SPACING_DOUBLE:
994 spacing.set(Spacing::Double);
998 spacing.set(Spacing::Other, lex.getString());
1004 void Layout::readArgument(Lexer & lex)
1007 // writeArgument() makes use of these default values
1008 arg.mandatory = false;
1009 arg.nodelims = false;
1010 arg.autoinsert = false;
1011 arg.insertcotext = false;
1013 bool finished = false;
1014 arg.font = inherit_font;
1015 arg.labelfont = inherit_font;
1016 arg.is_toc_caption = false;
1017 arg.passthru = PT_INHERITED;
1020 bool const itemarg = prefixIs(id, "item:");
1021 bool const postcmd = prefixIs(id, "post:");
1022 bool const listpreamble = prefixIs(id, "listpreamble:");
1024 while (!finished && lex.isOK() && !error) {
1026 string const tok = ascii_lowercase(lex.getString());
1030 } else if (tok == "endargument") {
1032 } else if (tok == "labelstring") {
1034 arg.labelstring = lex.getDocString();
1035 } else if (tok == "menustring") {
1037 arg.menustring = lex.getDocString();
1038 } else if (tok == "mandatory") {
1040 arg.mandatory = lex.getBool();
1041 } else if (tok == "autoinsert") {
1043 arg.autoinsert = lex.getBool();
1044 } else if (tok == "insertcotext") {
1046 arg.insertcotext = lex.getBool();
1047 } else if (tok == "leftdelim") {
1049 arg.ldelim = lex.getDocString();
1050 arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
1052 } else if (tok == "rightdelim") {
1054 arg.rdelim = lex.getDocString();
1055 arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
1057 } else if (tok == "defaultarg") {
1059 arg.defaultarg = lex.getDocString();
1060 } else if (tok == "presetarg") {
1062 arg.presetarg = lex.getDocString();
1063 } else if (tok == "tooltip") {
1065 arg.tooltip = lex.getDocString();
1066 } else if (tok == "requires") {
1068 arg.requires = lex.getString();
1069 } else if (tok == "decoration") {
1071 arg.decoration = lex.getString();
1072 } else if (tok == "font") {
1073 arg.font = lyxRead(lex, arg.font);
1074 } else if (tok == "labelfont") {
1075 arg.labelfont = lyxRead(lex, arg.labelfont);
1076 } else if (tok == "passthruchars") {
1078 arg.pass_thru_chars = lex.getDocString();
1079 } else if (tok == "passthru") {
1081 docstring value = lex.getDocString();
1082 if (value == "true" || value == "1")
1083 arg.passthru = PT_TRUE;
1084 else if (value == "false" || value == "0")
1085 arg.passthru = PT_FALSE;
1087 arg.passthru = PT_INHERITED;
1088 } else if (tok == "istoccaption") {
1090 arg.is_toc_caption = lex.getBool();
1092 lex.printError("Unknown tag");
1096 if (arg.labelstring.empty())
1097 LYXERR0("Incomplete Argument definition!");
1099 itemargs_[id] = arg;
1101 postcommandargs_[id] = arg;
1102 else if (listpreamble) {
1103 // list preamble has no delimiters by default
1104 arg.nodelims = true;
1105 listpreamble_[id] = arg;
1107 latexargs_[id] = arg;
1111 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1113 os << "\tArgument " << id << '\n';
1114 if (!arg.labelstring.empty())
1115 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1116 if (!arg.menustring.empty())
1117 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1119 os << "\t\tMandatory " << arg.mandatory << '\n';
1121 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1122 if (arg.insertcotext)
1123 os << "\t\tInsertCotext " << arg.insertcotext << '\n';
1124 if (!arg.ldelim.empty())
1125 os << "\t\tLeftDelim \""
1126 << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1128 if (!arg.rdelim.empty())
1129 os << "\t\tRightDelim \""
1130 << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1132 if (!arg.defaultarg.empty())
1133 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1134 if (!arg.presetarg.empty())
1135 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1136 if (!arg.tooltip.empty())
1137 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1138 if (!arg.requires.empty())
1139 os << "\t\tRequires \"" << arg.requires << "\"\n";
1140 if (!arg.decoration.empty())
1141 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1142 if (arg.font != inherit_font)
1143 lyxWrite(os, arg.font, "Font", 2);
1144 if (arg.labelfont != inherit_font)
1145 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1146 switch (arg.passthru) {
1148 os << "\t\tPassThru true\n";
1151 os << "\t\tPassThru false\n";
1154 os << "\t\tPassThru inherited\n";
1157 if (!arg.pass_thru_chars.empty())
1158 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1159 os << "\tEndArgument\n";
1163 void Layout::write(ostream & os) const
1165 os << "Style \"" << to_utf8(name_) << "\"\n";
1166 if (!category_.empty() && obsoleted_by_.empty())
1167 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1168 // Can't deduce Copystyle here :-(
1169 if (!obsoleted_by_.empty()) {
1170 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1174 if (!depends_on_.empty())
1175 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1176 switch (margintype) {
1177 case MARGIN_DYNAMIC:
1178 os << "\tMargin Dynamic\n";
1180 case MARGIN_FIRST_DYNAMIC:
1181 os << "\tMargin First_Dynamic\n";
1184 os << "\tMargin Manual\n";
1186 case MARGIN_RIGHT_ADDRESS_BOX:
1187 os << "\tMargin Right_Address_Box\n";
1190 os << "\tMargin Static\n";
1193 switch (latextype) {
1194 case LATEX_BIB_ENVIRONMENT:
1195 os << "\tLatexType Bib_Environment\n";
1198 os << "\tLatexType Command\n";
1200 case LATEX_ENVIRONMENT:
1201 os << "\tLatexType Environment\n";
1203 case LATEX_ITEM_ENVIRONMENT:
1204 os << "\tLatexType Item_Environment\n";
1206 case LATEX_LIST_ENVIRONMENT:
1207 os << "\tLatexType List_Environment\n";
1209 case LATEX_PARAGRAPH:
1210 os << "\tLatexType Paragraph\n";
1213 os << "\tInTitle " << intitle << "\n"
1214 "\tInPreamble " << inpreamble << "\n"
1215 "\tTocLevel " << toclevel << "\n"
1216 "\tResumeCounter " << resumecounter << "\n"
1217 "\tStepMasterCounter " << stepmastercounter << '\n';
1218 // ResetArgs does not make sense here
1219 for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1220 it != latexargs_.end(); ++it)
1221 writeArgument(os, it->first, it->second);
1222 for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1223 it != itemargs_.end(); ++it)
1224 writeArgument(os, it->first, it->second);
1225 for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1226 it != postcommandargs_.end(); ++it)
1227 writeArgument(os, it->first, it->second);
1228 for (LaTeXArgMap::const_iterator it = listpreamble_.begin();
1229 it != listpreamble_.end(); ++it)
1230 writeArgument(os, it->first, it->second);
1231 os << "\tNeedProtect " << needprotect << "\n"
1232 "\tNeedCProtect " << needcprotect << "\n"
1233 "\tKeepEmpty " << keepempty << '\n';
1234 if (labelfont == font)
1235 lyxWrite(os, font, "Font", 1);
1237 lyxWrite(os, font, "TextFont", 1);
1238 lyxWrite(os, labelfont, "LabelFont", 1);
1240 os << "\tNextNoIndent " << nextnoindent << "\n"
1241 "\tCommandDepth " << commanddepth << '\n';
1242 if (!latexname_.empty())
1243 os << "\tLatexName \"" << latexname_ << "\"\n";
1244 if (!latexparam_.empty())
1245 os << "\tLatexParam \"" << subst(latexparam_, "\"", """)
1247 if (!leftdelim_.empty())
1248 os << "\tLeftDelim "
1249 << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1251 if (!rightdelim_.empty())
1252 os << "\tRightDelim "
1253 << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1255 if (!innertag_.empty())
1256 os << "\tInnerTag \"" << innertag_ << "\"\n";
1257 if (!labeltag_.empty())
1258 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1259 if (!itemtag_.empty())
1260 os << "\tItemTag \"" << itemtag_ << "\"\n";
1261 if (!itemcommand_.empty())
1262 os << "\tItemCommand " << itemcommand_ << '\n';
1263 if (!preamble_.empty())
1264 os << "\tPreamble\n\t"
1265 << to_utf8(subst(rtrim(preamble_, "\n"),
1266 from_ascii("\n"), from_ascii("\n\t")))
1267 << "\n\tEndPreamble\n";
1268 if (!langpreamble_.empty())
1269 os << "\tLangPreamble\n\t"
1270 << to_utf8(subst(rtrim(langpreamble_, "\n"),
1271 from_ascii("\n"), from_ascii("\n\t")))
1272 << "\n\tEndLangPreamble\n";
1273 if (!babelpreamble_.empty())
1274 os << "\tBabelPreamble\n\t"
1275 << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1276 from_ascii("\n"), from_ascii("\n\t")))
1277 << "\n\tEndBabelPreamble\n";
1278 switch (labeltype) {
1280 os << "\tLabelType Above\n";
1283 os << "\tLabelType Bibliography\n";
1285 case LABEL_CENTERED:
1286 os << "\tLabelType Centered\n";
1288 case LABEL_ENUMERATE:
1289 os << "\tLabelType Enumerate\n";
1292 os << "\tLabelType Itemize\n";
1295 os << "\tLabelType Manual\n";
1297 case LABEL_NO_LABEL:
1298 os << "\tLabelType No_Label\n";
1300 case LABEL_SENSITIVE:
1301 os << "\tLabelType Sensitive\n";
1304 os << "\tLabelType Static\n";
1307 switch (endlabeltype) {
1309 os << "\tEndLabelType Box\n";
1311 case END_LABEL_FILLED_BOX:
1312 os << "\tEndLabelType Filled_Box\n";
1314 case END_LABEL_NO_LABEL:
1315 os << "\tEndLabelType No_Label\n";
1317 case END_LABEL_STATIC:
1318 os << "\tEndLabelType Static\n";
1321 os << "\tParagraphGroup \"" << par_group_ << "\"\n";
1322 if (!leftmargin.empty())
1323 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1324 if (!rightmargin.empty())
1325 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1326 if (!labelindent.empty())
1327 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1328 if (!parindent.empty())
1329 os << "\tParIndent " << to_utf8(parindent) << '\n';
1330 os << "\tParSkip " << parskip << "\n"
1331 "\tItemSep " << itemsep << "\n"
1332 "\tTopSep " << topsep << "\n"
1333 "\tBottomSep " << bottomsep << "\n"
1334 "\tLabelBottomSep " << labelbottomsep << '\n';
1335 if (!labelsep.empty())
1336 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1338 os << "\tParSep " << parsep << "\n"
1339 "\tNewLine " << newline_allowed << '\n';
1341 case LYX_ALIGN_BLOCK:
1342 os << "\tAlign Block\n";
1344 case LYX_ALIGN_CENTER:
1345 os << "\tAlign Center\n";
1347 case LYX_ALIGN_LAYOUT:
1348 os << "\tAlign Layout\n";
1350 case LYX_ALIGN_LEFT:
1351 os << "\tAlign Left\n";
1353 case LYX_ALIGN_RIGHT:
1354 os << "\tAlign Right\n";
1356 case LYX_ALIGN_DECIMAL:
1357 case LYX_ALIGN_SPECIAL:
1358 case LYX_ALIGN_NONE:
1361 if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1362 LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1364 os << "\tAlignPossible";
1365 if (alignpossible & LYX_ALIGN_BLOCK) {
1369 if (alignpossible & LYX_ALIGN_CENTER) {
1375 if (alignpossible & LYX_ALIGN_LAYOUT) {
1381 if (alignpossible & LYX_ALIGN_LEFT) {
1387 if (alignpossible & LYX_ALIGN_RIGHT) {
1395 // LabelString must come before LabelStringAppendix
1396 if (!labelstring_.empty())
1397 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1398 if (!endlabelstring_.empty())
1399 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1400 if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1401 os << "\tLabelStringAppendix \""
1402 << to_utf8(labelstring_appendix_) << "\"\n";
1403 if (!counter.empty())
1404 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1405 os << "\tFreeSpacing " << free_spacing << '\n';
1406 os << "\tPassThru " << pass_thru << '\n';
1407 if (!pass_thru_chars.empty())
1408 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1409 os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1410 switch (spacing.getSpace()) {
1411 case Spacing::Double:
1412 os << "\tSpacing Double\n";
1414 case Spacing::Onehalf:
1415 os << "\tSpacing Onehalf\n";
1417 case Spacing::Other:
1418 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1420 case Spacing::Single:
1421 os << "\tSpacing Single\n";
1423 case Spacing::Default:
1426 if (!requires_.empty()) {
1427 os << "\tRequires ";
1428 for (set<string>::const_iterator it = requires_.begin();
1429 it != requires_.end(); ++it) {
1430 if (it != requires_.begin())
1436 if (!autonests_.empty()) {
1437 os << "\tAutoNests\n\t";
1438 for (set<docstring>::const_iterator it = autonests_.begin();
1439 it != autonests_.end(); ++it) {
1440 if (it != autonests_.begin())
1444 os << "\n\tEndAutoNests\n";
1446 if (!autonested_by_.empty()) {
1447 os << "\tIsAutoNestedBy\n\t\t";
1448 for (set<docstring>::const_iterator it = autonested_by_.begin();
1449 it != autonested_by_.end(); ++it) {
1450 if (it != autonested_by_.begin())
1454 os << "\n\tEndIsAutoNestedBy\n";
1456 if (refprefix.empty())
1457 os << "\tRefPrefix OFF\n";
1459 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1460 if (!htmltag_.empty())
1461 os << "\tHTMLTag " << htmltag_ << '\n';
1462 if (!htmlattr_.empty())
1463 os << "\tHTMLAttr " << htmlattr_ << '\n';
1464 if (!htmlitemtag_.empty())
1465 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1466 if (!htmlitemattr_.empty())
1467 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1468 if (!htmllabeltag_.empty())
1469 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1470 if (!htmllabelattr_.empty())
1471 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1472 os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1473 if (!htmlstyle_.empty())
1474 os << "\tHTMLStyle\n"
1475 << to_utf8(rtrim(htmlstyle_, "\n"))
1476 << "\n\tEndHTMLStyle\n";
1477 os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1478 if (!htmlpreamble_.empty())
1479 os << "\tHTMLPreamble\n"
1480 << to_utf8(rtrim(htmlpreamble_, "\n"))
1481 << "\n\tEndPreamble\n";
1482 os << "\tHTMLTitle " << htmltitle_ << "\n"
1483 "\tSpellcheck " << spellcheck << "\n"
1484 "\tForceLocal " << forcelocal << "\n"
1489 bool Layout::hasArgs() const
1491 return !latexargs_.empty() || !postcommandargs_.empty() ||
1492 !itemargs_.empty() || !listpreamble_.empty();
1496 Layout::LaTeXArgMap Layout::args() const
1498 LaTeXArgMap args = latexargs_;
1499 if (!postcommandargs_.empty())
1500 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1501 if (!listpreamble_.empty())
1502 args.insert(listpreamble_.begin(), listpreamble_.end());
1503 if (!itemargs_.empty())
1504 args.insert(itemargs_.begin(), itemargs_.end());
1509 int Layout::optArgs() const
1512 LaTeXArgMap::const_iterator it = latexargs_.begin();
1513 for (; it != latexargs_.end(); ++it) {
1514 if (!(*it).second.mandatory)
1517 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1518 for (; iit != postcommandargs_.end(); ++iit) {
1519 if (!(*iit).second.mandatory)
1526 int Layout::requiredArgs() const
1529 LaTeXArgMap::const_iterator it = latexargs_.begin();
1530 for (; it != latexargs_.end(); ++it) {
1531 if ((*it).second.mandatory)
1534 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1535 for (; iit != postcommandargs_.end(); ++iit) {
1536 if (!(*iit).second.mandatory)
1543 string const & Layout::htmltag() const
1545 if (htmltag_.empty())
1551 string const & Layout::htmlattr() const
1553 if (htmlattr_.empty())
1554 htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
1559 string const & Layout::htmlitemtag() const
1561 if (htmlitemtag_.empty())
1562 htmlitemtag_ = "div";
1563 return htmlitemtag_;
1567 string const & Layout::htmlitemattr() const
1569 if (htmlitemattr_.empty())
1570 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1571 return htmlitemattr_;
1575 string const & Layout::htmllabeltag() const
1577 if (htmllabeltag_.empty())
1578 htmllabeltag_ = "span";
1579 return htmllabeltag_;
1583 string const & Layout::htmllabelattr() const
1585 if (htmllabelattr_.empty())
1586 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1587 return htmllabelattr_;
1591 docstring Layout::htmlstyle() const
1593 if (!htmlstyle_.empty() && !htmlforcecss_)
1595 if (htmldefaultstyle_.empty())
1597 docstring retval = htmldefaultstyle_;
1598 if (!htmlstyle_.empty())
1599 retval += '\n' + htmlstyle_;
1604 string Layout::defaultCSSClass() const
1606 if (!defaultcssclass_.empty())
1607 return defaultcssclass_;
1609 docstring::const_iterator it = name().begin();
1610 docstring::const_iterator en = name().end();
1611 for (; it != en; ++it) {
1612 char_type const c = *it;
1613 if (!isAlphaASCII(c)) {
1615 // make sure we don't start with an underscore,
1616 // as that sometimes causes problems.
1617 d = from_ascii("lyx_");
1620 } else if (isLower(c))
1623 // this is slow, so do it only if necessary
1626 defaultcssclass_ = to_utf8(d);
1627 return defaultcssclass_;
1633 string makeMarginValue(char const * side, double d)
1636 os << "margin-" << side << ": " << d << "ex;\n";
1643 void Layout::makeDefaultCSS() const
1645 // this never needs to be redone, since reloading layouts will
1646 // wipe out what we did before.
1647 if (!htmldefaultstyle_.empty())
1651 htmldefaultstyle_ = font.asCSS();
1656 tmp += makeMarginValue("top", topsep);
1658 tmp += makeMarginValue("bottom", bottomsep);
1659 if (!leftmargin.empty()) {
1660 // we can't really do what LyX does with the margin, so
1661 // we'll just figure out how many characters it is
1662 int const len = leftmargin.length();
1663 tmp += makeMarginValue("left", len);
1665 if (!rightmargin.empty()) {
1666 int const len = rightmargin.length();
1667 tmp += makeMarginValue("right", len);
1671 if (!htmldefaultstyle_.empty())
1672 htmldefaultstyle_ += from_ascii("\n");
1673 htmldefaultstyle_ += from_ascii(tmp);
1677 string where = alignmentToCSS(align);
1678 if (!where.empty()) {
1679 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
1682 // wrap up what we have, if anything
1683 if (!htmldefaultstyle_.empty())
1685 from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
1686 htmldefaultstyle_ + from_ascii("\n}\n");
1688 if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
1694 if (labelfont != font)
1695 labelCSS = labelfont.asCSS() + from_ascii("\n");
1696 if (labeltype == LABEL_CENTERED)
1697 labelCSS += from_ascii("text-align: center;\n");
1699 if (!labelCSS.empty())
1700 htmldefaultstyle_ +=
1701 from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
1702 labelCSS + from_ascii("\n}\n");
1706 bool Layout::operator==(Layout const & rhs) const
1708 // This is enough for the applications we actually make,
1709 // at least at the moment. But we could check more.
1710 return name() == rhs.name()
1711 && latexname() == rhs.latexname()
1712 && latextype == rhs.latextype;