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();
383 case LT_RESUMECOUNTER:
384 lex >> resumecounter;
387 case LT_STEPMASTERCOUNTER:
388 lex >> stepmastercounter;
395 case LT_NEED_PROTECT:
399 case LT_NEED_CPROTECT:
408 font = lyxRead(lex, font);
413 font = lyxRead(lex, font);
417 labelfont = lyxRead(lex, labelfont);
420 case LT_NEXTNOINDENT:
424 case LT_TOGGLE_INDENT: {
427 tog = support::ascii_lowercase(tog);
429 toggle_indent = ITOGGLE_ALWAYS;
430 else if (tog == "never")
431 toggle_indent = ITOGGLE_NEVER;
433 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
437 case LT_COMMANDDEPTH:
447 latexparam_ = subst(latexparam_, """, "\"");
452 leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
458 rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
479 preamble_ = lex.getLongString(from_ascii("EndPreamble"));
482 case LT_LANGPREAMBLE:
483 langpreamble_ = lex.getLongString(from_ascii("EndLangPreamble"));
486 case LT_BABELPREAMBLE:
487 babelpreamble_ = lex.getLongString(from_ascii("EndBabelPreamble"));
494 case LT_ENDLABELTYPE:
495 readEndLabelType(lex);
530 case LT_LABEL_BOTTOMSEP:
531 lex >> labelbottomsep;
536 labelsep = subst(labelsep, 'x', ' ');
544 lex >> newline_allowed;
551 case LT_ALIGNPOSSIBLE:
552 readAlignPossible(lex);
556 // FIXME: this means LT_LABELSTRING_APPENDIX may only
557 // occur after LT_LABELSTRING
559 labelstring_appendix_ = labelstring_;
562 case LT_ENDLABELSTRING:
563 lex >> endlabelstring_;
566 case LT_LABELSTRING_APPENDIX:
567 lex >> labelstring_appendix_;
570 case LT_LABELCOUNTER:
578 case LT_FREE_SPACING:
586 case LT_PASS_THRU_CHARS:
587 lex >> pass_thru_chars;
590 case LT_PARBREAK_IS_NEWLINE:
591 lex >> parbreak_is_newline;
600 vector<string> const req =
601 getVectorFromString(lex.getString(true));
602 requires_.insert(req.begin(), req.end());
607 docstring const autonest =
608 subst(subst(subst(lex.getLongString(from_ascii("EndAutoNests")),
609 from_ascii("\n"), docstring()),
610 from_ascii(" "), docstring()),
611 from_ascii("\t"), docstring());
612 vector<docstring> const autonests =
613 getVectorFromString(autonest);
614 autonests_.insert(autonests.begin(), autonests.end());
618 case LT_AUTONESTEDBY: {
619 docstring const autonest =
620 subst(subst(subst(lex.getLongString(from_ascii("EndIsAutoNestedBy")),
621 from_ascii("\n"), docstring()),
622 from_ascii(" "), docstring()),
623 from_ascii("\t"), docstring());
624 vector<docstring> const autonests =
625 getVectorFromString(autonest);
626 autonested_by_.insert(autonests.begin(), autonests.end());
652 case LT_HTMLITEMATTR:
653 lex >> htmlitemattr_;
657 lex >> htmllabeltag_;
660 case LT_HTMLLABELATTR:
661 lex >> htmllabelattr_;
664 case LT_HTMLLABELFIRST:
665 lex >> htmllabelfirst_;
669 htmlstyle_ = lex.getLongString(from_ascii("EndHTMLStyle"));
672 case LT_HTMLFORCECSS:
673 lex >> htmlforcecss_;
676 case LT_HTMLPREAMBLE:
677 htmlpreamble_ = lex.getLongString(from_ascii("EndPreamble"));
694 add_to_toc_ = !toc_type_.empty();
697 case LT_ISTOCCAPTION:
698 lex >> is_toc_caption_;
704 // make sure we only have inpreamble = true for commands
705 if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
706 LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
707 LYXERR0("Layout name: " << name());
711 return finished && !error;
724 LexerKeyword alignTags[] = {
725 { "block", AT_BLOCK },
726 { "center", AT_CENTER },
727 { "layout", AT_LAYOUT },
729 { "right", AT_RIGHT }
733 void Layout::readAlign(Lexer & lex)
735 PushPopHelper pph(lex, alignTags);
738 case Lexer::LEX_UNDEF:
739 lex.printError("Unknown alignment `$$Token'");
745 align = LYX_ALIGN_BLOCK;
748 align = LYX_ALIGN_LEFT;
751 align = LYX_ALIGN_RIGHT;
754 align = LYX_ALIGN_CENTER;
757 align = LYX_ALIGN_LAYOUT;
763 void Layout::readAlignPossible(Lexer & lex)
765 lex.pushTable(alignTags);
766 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
767 int lineno = lex.lineNumber();
771 case Lexer::LEX_UNDEF:
772 lex.printError("Unknown alignment `$$Token'");
778 alignpossible |= LYX_ALIGN_BLOCK;
781 alignpossible |= LYX_ALIGN_LEFT;
784 alignpossible |= LYX_ALIGN_RIGHT;
787 alignpossible |= LYX_ALIGN_CENTER;
790 alignpossible |= LYX_ALIGN_LAYOUT;
793 } while (lineno == lex.lineNumber());
798 void Layout::readLabelType(Lexer & lex)
813 LexerKeyword labelTypeTags[] = {
814 { "above", LA_ABOVE },
815 { "bibliography", LA_BIBLIO },
816 { "centered", LA_CENTERED },
817 { "enumerate", LA_ENUMERATE },
818 { "itemize", LA_ITEMIZE },
819 { "manual", LA_MANUAL },
820 { "no_label", LA_NO_LABEL },
821 { "sensitive", LA_SENSITIVE },
822 { "static", LA_STATIC }
825 PushPopHelper pph(lex, labelTypeTags);
828 case Lexer::LEX_UNDEF:
829 lex.printError("Unknown labeltype tag `$$Token'");
835 labeltype = LABEL_NO_LABEL;
838 labeltype = LABEL_MANUAL;
841 labeltype = LABEL_ABOVE;
844 labeltype = LABEL_CENTERED;
847 labeltype = LABEL_STATIC;
850 labeltype = LABEL_SENSITIVE;
853 labeltype = LABEL_ENUMERATE;
856 labeltype = LABEL_ITEMIZE;
859 labeltype = LABEL_BIBLIO;
865 void Layout::readEndLabelType(Lexer & lex)
867 // this should be const, but can't be because
869 static LexerKeyword endlabelTypeTags[] = {
870 { "box", END_LABEL_BOX },
871 { "filled_box", END_LABEL_FILLED_BOX },
872 { "no_label", END_LABEL_NO_LABEL },
873 { "static", END_LABEL_STATIC }
876 PushPopHelper pph(lex, endlabelTypeTags);
879 case Lexer::LEX_UNDEF:
880 lex.printError("Unknown labeltype tag `$$Token'");
882 case END_LABEL_STATIC:
884 case END_LABEL_FILLED_BOX:
885 case END_LABEL_NO_LABEL:
886 endlabeltype = static_cast<EndLabelType>(le);
889 LYXERR0("Unhandled value " << le);
895 void Layout::readMargin(Lexer & lex)
897 LexerKeyword marginTags[] = {
898 { "dynamic", MARGIN_DYNAMIC },
899 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
900 { "manual", MARGIN_MANUAL },
901 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
902 { "static", MARGIN_STATIC }
905 PushPopHelper pph(lex, marginTags);
909 case Lexer::LEX_UNDEF:
910 lex.printError("Unknown margin type tag `$$Token'");
915 case MARGIN_FIRST_DYNAMIC:
916 case MARGIN_RIGHT_ADDRESS_BOX:
917 margintype = static_cast<MarginType>(le);
920 LYXERR0("Unhandled value " << le);
926 void Layout::readLatexType(Lexer & lex)
928 LexerKeyword latexTypeTags[] = {
929 { "bib_environment", LATEX_BIB_ENVIRONMENT },
930 { "command", LATEX_COMMAND },
931 { "environment", LATEX_ENVIRONMENT },
932 { "item_environment", LATEX_ITEM_ENVIRONMENT },
933 { "list_environment", LATEX_LIST_ENVIRONMENT },
934 { "paragraph", LATEX_PARAGRAPH }
937 PushPopHelper pph(lex, latexTypeTags);
940 case Lexer::LEX_UNDEF:
941 lex.printError("Unknown latextype tag `$$Token'");
943 case LATEX_PARAGRAPH:
945 case LATEX_ITEM_ENVIRONMENT:
946 case LATEX_LIST_ENVIRONMENT:
947 latextype = static_cast<LatexType>(le);
949 case LATEX_ENVIRONMENT:
950 case LATEX_BIB_ENVIRONMENT:
951 latextype = static_cast<LatexType>(le);
955 LYXERR0("Unhandled value " << le);
961 void Layout::readSpacing(Lexer & lex)
964 ST_SPACING_SINGLE = 1,
970 LexerKeyword spacingTags[] = {
971 {"double", ST_SPACING_DOUBLE },
972 {"onehalf", ST_SPACING_ONEHALF },
973 {"other", ST_OTHER },
974 {"single", ST_SPACING_SINGLE }
977 PushPopHelper pph(lex, spacingTags);
980 case Lexer::LEX_UNDEF:
981 lex.printError("Unknown spacing token `$$Token'");
986 case ST_SPACING_SINGLE:
987 spacing.set(Spacing::Single);
989 case ST_SPACING_ONEHALF:
990 spacing.set(Spacing::Onehalf);
992 case ST_SPACING_DOUBLE:
993 spacing.set(Spacing::Double);
997 spacing.set(Spacing::Other, lex.getString());
1003 void Layout::readArgument(Lexer & lex)
1006 // writeArgument() makes use of these default values
1007 arg.mandatory = false;
1008 arg.autoinsert = false;
1009 arg.insertcotext = false;
1011 bool finished = false;
1012 arg.font = inherit_font;
1013 arg.labelfont = inherit_font;
1014 arg.is_toc_caption = false;
1015 arg.passthru = PT_INHERITED;
1018 bool const itemarg = prefixIs(id, "item:");
1019 bool const postcmd = prefixIs(id, "post:");
1021 while (!finished && lex.isOK() && !error) {
1023 string const tok = ascii_lowercase(lex.getString());
1027 } else if (tok == "endargument") {
1029 } else if (tok == "labelstring") {
1031 arg.labelstring = lex.getDocString();
1032 } else if (tok == "menustring") {
1034 arg.menustring = lex.getDocString();
1035 } else if (tok == "mandatory") {
1037 arg.mandatory = lex.getBool();
1038 } else if (tok == "autoinsert") {
1040 arg.autoinsert = lex.getBool();
1041 } else if (tok == "insertcotext") {
1043 arg.insertcotext = lex.getBool();
1044 } else if (tok == "leftdelim") {
1046 arg.ldelim = lex.getDocString();
1047 arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
1049 } else if (tok == "rightdelim") {
1051 arg.rdelim = lex.getDocString();
1052 arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
1054 } else if (tok == "defaultarg") {
1056 arg.defaultarg = lex.getDocString();
1057 } else if (tok == "presetarg") {
1059 arg.presetarg = lex.getDocString();
1060 } else if (tok == "tooltip") {
1062 arg.tooltip = lex.getDocString();
1063 } else if (tok == "requires") {
1065 arg.requires = lex.getString();
1066 } else if (tok == "decoration") {
1068 arg.decoration = lex.getString();
1069 } else if (tok == "font") {
1070 arg.font = lyxRead(lex, arg.font);
1071 } else if (tok == "labelfont") {
1072 arg.labelfont = lyxRead(lex, arg.labelfont);
1073 } else if (tok == "passthruchars") {
1075 arg.pass_thru_chars = lex.getDocString();
1076 } else if (tok == "passthru") {
1078 docstring value = lex.getDocString();
1079 if (value == "true" || value == "1")
1080 arg.passthru = PT_TRUE;
1081 else if (value == "false" || value == "0")
1082 arg.passthru = PT_FALSE;
1084 arg.passthru = PT_INHERITED;
1085 } else if (tok == "istoccaption") {
1087 arg.is_toc_caption = lex.getBool();
1089 lex.printError("Unknown tag");
1093 if (arg.labelstring.empty())
1094 LYXERR0("Incomplete Argument definition!");
1096 itemargs_[id] = arg;
1098 postcommandargs_[id] = arg;
1100 latexargs_[id] = arg;
1104 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1106 os << "\tArgument " << id << '\n';
1107 if (!arg.labelstring.empty())
1108 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1109 if (!arg.menustring.empty())
1110 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1112 os << "\t\tMandatory " << arg.mandatory << '\n';
1114 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1115 if (arg.insertcotext)
1116 os << "\t\tInsertCotext " << arg.insertcotext << '\n';
1117 if (!arg.ldelim.empty())
1118 os << "\t\tLeftDelim \""
1119 << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1121 if (!arg.rdelim.empty())
1122 os << "\t\tRightDelim \""
1123 << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1125 if (!arg.defaultarg.empty())
1126 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1127 if (!arg.presetarg.empty())
1128 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1129 if (!arg.tooltip.empty())
1130 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1131 if (!arg.requires.empty())
1132 os << "\t\tRequires \"" << arg.requires << "\"\n";
1133 if (!arg.decoration.empty())
1134 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1135 if (arg.font != inherit_font)
1136 lyxWrite(os, arg.font, "Font", 2);
1137 if (arg.labelfont != inherit_font)
1138 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1139 switch (arg.passthru) {
1141 os << "\t\tPassThru true\n";
1144 os << "\t\tPassThru false\n";
1147 os << "\t\tPassThru inherited\n";
1150 if (!arg.pass_thru_chars.empty())
1151 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1152 os << "\tEndArgument\n";
1156 void Layout::write(ostream & os) const
1158 os << "Style \"" << to_utf8(name_) << "\"\n";
1159 if (!category_.empty() && obsoleted_by_.empty())
1160 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1161 // Can't deduce Copystyle here :-(
1162 if (!obsoleted_by_.empty()) {
1163 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1167 if (!depends_on_.empty())
1168 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1169 switch (margintype) {
1170 case MARGIN_DYNAMIC:
1171 os << "\tMargin Dynamic\n";
1173 case MARGIN_FIRST_DYNAMIC:
1174 os << "\tMargin First_Dynamic\n";
1177 os << "\tMargin Manual\n";
1179 case MARGIN_RIGHT_ADDRESS_BOX:
1180 os << "\tMargin Right_Address_Box\n";
1183 os << "\tMargin Static\n";
1186 switch (latextype) {
1187 case LATEX_BIB_ENVIRONMENT:
1188 os << "\tLatexType Bib_Environment\n";
1191 os << "\tLatexType Command\n";
1193 case LATEX_ENVIRONMENT:
1194 os << "\tLatexType Environment\n";
1196 case LATEX_ITEM_ENVIRONMENT:
1197 os << "\tLatexType Item_Environment\n";
1199 case LATEX_LIST_ENVIRONMENT:
1200 os << "\tLatexType List_Environment\n";
1202 case LATEX_PARAGRAPH:
1203 os << "\tLatexType Paragraph\n";
1206 os << "\tInTitle " << intitle << "\n"
1207 "\tInPreamble " << inpreamble << "\n"
1208 "\tTocLevel " << toclevel << "\n"
1209 "\tResumeCounter " << resumecounter << "\n"
1210 "\tStepMasterCounter " << stepmastercounter << '\n';
1211 // ResetArgs does not make sense here
1212 for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1213 it != latexargs_.end(); ++it)
1214 writeArgument(os, it->first, it->second);
1215 for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1216 it != itemargs_.end(); ++it)
1217 writeArgument(os, it->first, it->second);
1218 for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1219 it != postcommandargs_.end(); ++it)
1220 writeArgument(os, it->first, it->second);
1221 os << "\tNeedProtect " << needprotect << "\n"
1222 "\tNeedCProtect " << needcprotect << "\n"
1223 "\tKeepEmpty " << keepempty << '\n';
1224 if (labelfont == font)
1225 lyxWrite(os, font, "Font", 1);
1227 lyxWrite(os, font, "TextFont", 1);
1228 lyxWrite(os, labelfont, "LabelFont", 1);
1230 os << "\tNextNoIndent " << nextnoindent << "\n"
1231 "\tCommandDepth " << commanddepth << '\n';
1232 if (!latexname_.empty())
1233 os << "\tLatexName \"" << latexname_ << "\"\n";
1234 if (!latexparam_.empty())
1235 os << "\tLatexParam \"" << subst(latexparam_, "\"", """)
1237 if (!leftdelim_.empty())
1238 os << "\tLeftDelim "
1239 << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1241 if (!rightdelim_.empty())
1242 os << "\tRightDelim "
1243 << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1245 if (!innertag_.empty())
1246 os << "\tInnerTag \"" << innertag_ << "\"\n";
1247 if (!labeltag_.empty())
1248 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1249 if (!itemtag_.empty())
1250 os << "\tItemTag \"" << itemtag_ << "\"\n";
1251 if (!itemcommand_.empty())
1252 os << "\tItemCommand " << itemcommand_ << '\n';
1253 if (!preamble_.empty())
1254 os << "\tPreamble\n\t"
1255 << to_utf8(subst(rtrim(preamble_, "\n"),
1256 from_ascii("\n"), from_ascii("\n\t")))
1257 << "\n\tEndPreamble\n";
1258 if (!langpreamble_.empty())
1259 os << "\tLangPreamble\n\t"
1260 << to_utf8(subst(rtrim(langpreamble_, "\n"),
1261 from_ascii("\n"), from_ascii("\n\t")))
1262 << "\n\tEndLangPreamble\n";
1263 if (!babelpreamble_.empty())
1264 os << "\tBabelPreamble\n\t"
1265 << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1266 from_ascii("\n"), from_ascii("\n\t")))
1267 << "\n\tEndBabelPreamble\n";
1268 switch (labeltype) {
1270 os << "\tLabelType Above\n";
1273 os << "\tLabelType Bibliography\n";
1275 case LABEL_CENTERED:
1276 os << "\tLabelType Centered\n";
1278 case LABEL_ENUMERATE:
1279 os << "\tLabelType Enumerate\n";
1282 os << "\tLabelType Itemize\n";
1285 os << "\tLabelType Manual\n";
1287 case LABEL_NO_LABEL:
1288 os << "\tLabelType No_Label\n";
1290 case LABEL_SENSITIVE:
1291 os << "\tLabelType Sensitive\n";
1294 os << "\tLabelType Static\n";
1297 switch (endlabeltype) {
1299 os << "\tEndLabelType Box\n";
1301 case END_LABEL_FILLED_BOX:
1302 os << "\tEndLabelType Filled_Box\n";
1304 case END_LABEL_NO_LABEL:
1305 os << "\tEndLabelType No_Label\n";
1307 case END_LABEL_STATIC:
1308 os << "\tEndLabelType Static\n";
1311 os << "\tParagraphGroup \"" << par_group_ << "\"\n";
1312 if (!leftmargin.empty())
1313 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1314 if (!rightmargin.empty())
1315 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1316 if (!labelindent.empty())
1317 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1318 if (!parindent.empty())
1319 os << "\tParIndent " << to_utf8(parindent) << '\n';
1320 os << "\tParSkip " << parskip << "\n"
1321 "\tItemSep " << itemsep << "\n"
1322 "\tTopSep " << topsep << "\n"
1323 "\tBottomSep " << bottomsep << "\n"
1324 "\tLabelBottomSep " << labelbottomsep << '\n';
1325 if (!labelsep.empty())
1326 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1328 os << "\tParSep " << parsep << "\n"
1329 "\tNewLine " << newline_allowed << '\n';
1331 case LYX_ALIGN_BLOCK:
1332 os << "\tAlign Block\n";
1334 case LYX_ALIGN_CENTER:
1335 os << "\tAlign Center\n";
1337 case LYX_ALIGN_LAYOUT:
1338 os << "\tAlign Layout\n";
1340 case LYX_ALIGN_LEFT:
1341 os << "\tAlign Left\n";
1343 case LYX_ALIGN_RIGHT:
1344 os << "\tAlign Right\n";
1346 case LYX_ALIGN_DECIMAL:
1347 case LYX_ALIGN_SPECIAL:
1348 case LYX_ALIGN_NONE:
1351 if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1352 LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1354 os << "\tAlignPossible";
1355 if (alignpossible & LYX_ALIGN_BLOCK) {
1359 if (alignpossible & LYX_ALIGN_CENTER) {
1365 if (alignpossible & LYX_ALIGN_LAYOUT) {
1371 if (alignpossible & LYX_ALIGN_LEFT) {
1377 if (alignpossible & LYX_ALIGN_RIGHT) {
1385 // LabelString must come before LabelStringAppendix
1386 if (!labelstring_.empty())
1387 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1388 if (!endlabelstring_.empty())
1389 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1390 if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1391 os << "\tLabelStringAppendix \""
1392 << to_utf8(labelstring_appendix_) << "\"\n";
1393 if (!counter.empty())
1394 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1395 os << "\tFreeSpacing " << free_spacing << '\n';
1396 os << "\tPassThru " << pass_thru << '\n';
1397 if (!pass_thru_chars.empty())
1398 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1399 os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1400 switch (spacing.getSpace()) {
1401 case Spacing::Double:
1402 os << "\tSpacing Double\n";
1404 case Spacing::Onehalf:
1405 os << "\tSpacing Onehalf\n";
1407 case Spacing::Other:
1408 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1410 case Spacing::Single:
1411 os << "\tSpacing Single\n";
1413 case Spacing::Default:
1416 if (!requires_.empty()) {
1417 os << "\tRequires ";
1418 for (set<string>::const_iterator it = requires_.begin();
1419 it != requires_.end(); ++it) {
1420 if (it != requires_.begin())
1426 if (!autonests_.empty()) {
1427 os << "\tAutoNests\n\t";
1428 for (set<docstring>::const_iterator it = autonests_.begin();
1429 it != autonests_.end(); ++it) {
1430 if (it != autonests_.begin())
1434 os << "\n\tEndAutoNests\n";
1436 if (!autonested_by_.empty()) {
1437 os << "\tIsAutoNestedBy\n\t\t";
1438 for (set<docstring>::const_iterator it = autonested_by_.begin();
1439 it != autonested_by_.end(); ++it) {
1440 if (it != autonested_by_.begin())
1444 os << "\n\tEndIsAutoNestedBy\n";
1446 if (refprefix.empty())
1447 os << "\tRefPrefix OFF\n";
1449 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1450 if (!htmltag_.empty())
1451 os << "\tHTMLTag " << htmltag_ << '\n';
1452 if (!htmlattr_.empty())
1453 os << "\tHTMLAttr " << htmlattr_ << '\n';
1454 if (!htmlitemtag_.empty())
1455 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1456 if (!htmlitemattr_.empty())
1457 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1458 if (!htmllabeltag_.empty())
1459 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1460 if (!htmllabelattr_.empty())
1461 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1462 os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1463 if (!htmlstyle_.empty())
1464 os << "\tHTMLStyle\n"
1465 << to_utf8(rtrim(htmlstyle_, "\n"))
1466 << "\n\tEndHTMLStyle\n";
1467 os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1468 if (!htmlpreamble_.empty())
1469 os << "\tHTMLPreamble\n"
1470 << to_utf8(rtrim(htmlpreamble_, "\n"))
1471 << "\n\tEndPreamble\n";
1472 os << "\tHTMLTitle " << htmltitle_ << "\n"
1473 "\tSpellcheck " << spellcheck << "\n"
1474 "\tForceLocal " << forcelocal << "\n"
1479 bool Layout::hasArgs() const
1481 return !latexargs_.empty() || !postcommandargs_.empty() ||
1486 Layout::LaTeXArgMap Layout::args() const
1488 LaTeXArgMap args = latexargs_;
1489 if (!postcommandargs_.empty())
1490 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1491 if (!itemargs_.empty())
1492 args.insert(itemargs_.begin(), itemargs_.end());
1497 int Layout::optArgs() const
1500 LaTeXArgMap::const_iterator it = latexargs_.begin();
1501 for (; it != latexargs_.end(); ++it) {
1502 if (!(*it).second.mandatory)
1505 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1506 for (; iit != postcommandargs_.end(); ++iit) {
1507 if (!(*iit).second.mandatory)
1514 int Layout::requiredArgs() const
1517 LaTeXArgMap::const_iterator it = latexargs_.begin();
1518 for (; it != latexargs_.end(); ++it) {
1519 if ((*it).second.mandatory)
1522 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1523 for (; iit != postcommandargs_.end(); ++iit) {
1524 if (!(*iit).second.mandatory)
1531 string const & Layout::htmltag() const
1533 if (htmltag_.empty())
1539 string const & Layout::htmlattr() const
1541 if (htmlattr_.empty())
1542 htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
1547 string const & Layout::htmlitemtag() const
1549 if (htmlitemtag_.empty())
1550 htmlitemtag_ = "div";
1551 return htmlitemtag_;
1555 string const & Layout::htmlitemattr() const
1557 if (htmlitemattr_.empty())
1558 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1559 return htmlitemattr_;
1563 string const & Layout::htmllabeltag() const
1565 if (htmllabeltag_.empty())
1566 htmllabeltag_ = "span";
1567 return htmllabeltag_;
1571 string const & Layout::htmllabelattr() const
1573 if (htmllabelattr_.empty())
1574 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1575 return htmllabelattr_;
1579 docstring Layout::htmlstyle() const
1581 if (!htmlstyle_.empty() && !htmlforcecss_)
1583 if (htmldefaultstyle_.empty())
1585 docstring retval = htmldefaultstyle_;
1586 if (!htmlstyle_.empty())
1587 retval += '\n' + htmlstyle_;
1592 string Layout::defaultCSSClass() const
1594 if (!defaultcssclass_.empty())
1595 return defaultcssclass_;
1597 docstring::const_iterator it = name().begin();
1598 docstring::const_iterator en = name().end();
1599 for (; it != en; ++it) {
1600 char_type const c = *it;
1601 if (!isAlphaASCII(c)) {
1603 // make sure we don't start with an underscore,
1604 // as that sometimes causes problems.
1605 d = from_ascii("lyx_");
1608 } else if (isLower(c))
1611 // this is slow, so do it only if necessary
1614 defaultcssclass_ = to_utf8(d);
1615 return defaultcssclass_;
1621 string makeMarginValue(char const * side, double d)
1624 os << "margin-" << side << ": " << d << "ex;\n";
1631 void Layout::makeDefaultCSS() const
1633 // this never needs to be redone, since reloading layouts will
1634 // wipe out what we did before.
1635 if (!htmldefaultstyle_.empty())
1639 htmldefaultstyle_ = font.asCSS();
1644 tmp += makeMarginValue("top", topsep);
1646 tmp += makeMarginValue("bottom", bottomsep);
1647 if (!leftmargin.empty()) {
1648 // we can't really do what LyX does with the margin, so
1649 // we'll just figure out how many characters it is
1650 int const len = leftmargin.length();
1651 tmp += makeMarginValue("left", len);
1653 if (!rightmargin.empty()) {
1654 int const len = rightmargin.length();
1655 tmp += makeMarginValue("right", len);
1659 if (!htmldefaultstyle_.empty())
1660 htmldefaultstyle_ += from_ascii("\n");
1661 htmldefaultstyle_ += from_ascii(tmp);
1665 string where = alignmentToCSS(align);
1666 if (!where.empty()) {
1667 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
1670 // wrap up what we have, if anything
1671 if (!htmldefaultstyle_.empty())
1673 from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
1674 htmldefaultstyle_ + from_ascii("\n}\n");
1676 if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
1682 if (labelfont != font)
1683 labelCSS = labelfont.asCSS() + from_ascii("\n");
1684 if (labeltype == LABEL_CENTERED)
1685 labelCSS += from_ascii("text-align: center;\n");
1687 if (!labelCSS.empty())
1688 htmldefaultstyle_ +=
1689 from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
1690 labelCSS + from_ascii("\n}\n");
1694 bool Layout::operator==(Layout const & rhs) const
1696 // This is enough for the applications we actually make,
1697 // at least at the moment. But we could check more.
1698 return name() == rhs.name()
1699 && latexname() == rhs.latexname()
1700 && latextype == rhs.latextype;