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,
111 LT_STEPMASTERCOUNTER,
117 LT_INTITLE // keep this last!
120 /////////////////////
123 : add_to_toc_(false), is_toc_caption_(true)
126 margintype = MARGIN_STATIC;
127 latextype = LATEX_PARAGRAPH;
128 resumecounter = false;
129 stepmastercounter = false;
135 labelfont = inherit_font;
137 reslabelfont = sane_font;
138 nextnoindent = false;
143 labelbottomsep = 0.0;
145 align = LYX_ALIGN_BLOCK;
146 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
147 labeltype = LABEL_NO_LABEL;
148 endlabeltype = END_LABEL_NO_LABEL;
149 // Should or should not. That is the question.
150 // spacing.set(Spacing::OneHalf);
151 newline_allowed = true;
152 free_spacing = false;
154 parbreak_is_newline = false;
155 toclevel = NOT_IN_TOC;
157 htmllabelfirst_ = false;
158 htmlforcecss_ = false;
162 itemcommand_ = "item";
163 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
168 bool Layout::read(Lexer & lex, TextClass const & tclass)
170 // If this is an empty layout, or if no force local version is set,
171 // we know that we will not discard the stuff to read
173 return readIgnoreForcelocal(lex, tclass);
176 bool const ret = tmp.readIgnoreForcelocal(lex, tclass);
178 // - the read version is higher
179 // - both versions are infinity (arbitrary decision)
180 // - the file did not contain any local version (needed for not
181 // skipping user defined local layouts)
182 if (tmp.forcelocal <= 0 || tmp.forcelocal > forcelocal)
188 bool Layout::readIgnoreForcelocal(Lexer & lex, TextClass const & tclass)
190 // This table is sorted alphabetically [asierra 30March96]
191 LexerKeyword layoutTags[] = {
192 { "addtotoc", LT_ADDTOTOC },
193 { "align", LT_ALIGN },
194 { "alignpossible", LT_ALIGNPOSSIBLE },
195 { "argument", LT_ARGUMENT },
196 { "autonests", LT_AUTONESTS },
197 { "babelpreamble", LT_BABELPREAMBLE },
198 { "bottomsep", LT_BOTTOMSEP },
199 { "category", LT_CATEGORY },
200 { "commanddepth", LT_COMMANDDEPTH },
201 { "copystyle", LT_COPYSTYLE },
202 { "dependson", LT_DEPENDSON },
204 { "endlabelstring", LT_ENDLABELSTRING },
205 { "endlabeltype", LT_ENDLABELTYPE },
207 { "forcelocal", LT_FORCELOCAL },
208 { "freespacing", LT_FREE_SPACING },
209 { "htmlattr", LT_HTMLATTR },
210 { "htmlforcecss", LT_HTMLFORCECSS },
211 { "htmlitem", LT_HTMLITEM },
212 { "htmlitemattr", LT_HTMLITEMATTR },
213 { "htmllabel", LT_HTMLLABEL },
214 { "htmllabelattr", LT_HTMLLABELATTR },
215 { "htmllabelfirst", LT_HTMLLABELFIRST },
216 { "htmlpreamble", LT_HTMLPREAMBLE },
217 { "htmlstyle", LT_HTMLSTYLE },
218 { "htmltag", LT_HTMLTAG },
219 { "htmltitle", LT_HTMLTITLE },
220 { "innertag", LT_INNERTAG },
221 { "inpreamble", LT_INPREAMBLE },
222 { "intitle", LT_INTITLE },
223 { "isautonestedby", LT_AUTONESTEDBY },
224 { "istoccaption", LT_ISTOCCAPTION },
225 { "itemcommand", LT_ITEMCOMMAND },
226 { "itemsep", LT_ITEMSEP },
227 { "itemtag", LT_ITEMTAG },
228 { "keepempty", LT_KEEPEMPTY },
229 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
230 { "labelcounter", LT_LABELCOUNTER },
231 { "labelfont", LT_LABELFONT },
232 { "labelindent", LT_LABELINDENT },
233 { "labelsep", LT_LABELSEP },
234 { "labelstring", LT_LABELSTRING },
235 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
236 { "labeltag", LT_LABELTAG },
237 { "labeltype", LT_LABELTYPE },
238 { "langpreamble", LT_LANGPREAMBLE },
239 { "latexname", LT_LATEXNAME },
240 { "latexparam", LT_LATEXPARAM },
241 { "latextype", LT_LATEXTYPE },
242 { "leftdelim", LT_LEFTDELIM },
243 { "leftmargin", LT_LEFTMARGIN },
244 { "margin", LT_MARGIN },
245 { "needprotect", LT_NEED_PROTECT },
246 { "newline", LT_NEWLINE },
247 { "nextnoindent", LT_NEXTNOINDENT },
248 { "obsoletedby", LT_OBSOLETEDBY },
249 { "paragraphgroup", LT_PAR_GROUP },
250 { "parbreakisnewline", LT_PARBREAK_IS_NEWLINE },
251 { "parindent", LT_PARINDENT },
252 { "parsep", LT_PARSEP },
253 { "parskip", LT_PARSKIP },
254 { "passthru", LT_PASS_THRU },
255 { "passthruchars", LT_PASS_THRU_CHARS },
256 { "preamble", LT_PREAMBLE },
257 { "refprefix", LT_REFPREFIX },
258 { "requires", LT_REQUIRES },
259 { "resetargs", LT_RESETARGS },
260 { "resumecounter", LT_RESUMECOUNTER },
261 { "rightdelim", LT_RIGHTDELIM },
262 { "rightmargin", LT_RIGHTMARGIN },
263 { "spacing", LT_SPACING },
264 { "spellcheck", LT_SPELLCHECK },
265 { "stepmastercounter", LT_STEPMASTERCOUNTER },
266 { "textfont", LT_TEXTFONT },
267 { "toclevel", LT_TOCLEVEL },
268 { "toggleindent", LT_TOGGLE_INDENT },
269 { "topsep", LT_TOPSEP }
273 bool finished = false;
274 lex.pushTable(layoutTags);
276 // parse style section
277 while (!finished && lex.isOK() && !error) {
279 // See comment in LyXRC.cpp.
281 case Lexer::LEX_FEOF:
284 case Lexer::LEX_UNDEF:
286 lex.printError("Unknown layout tag `$$Token'");
293 switch (static_cast<LayoutTags>(le)) {
305 style = subst(style, '_', ' ');
307 if (tclass.hasLayout(style)) {
308 docstring const tmpname = name_;
309 this->operator=(tclass[style]);
312 LYXERR0("Cannot copy unknown style `"
314 << "All layouts so far:");
315 DocumentClass::const_iterator lit = tclass.begin();
316 DocumentClass::const_iterator len = tclass.end();
317 for (; lit != len; ++lit)
318 LYXERR0(lit->name());
323 case LT_OBSOLETEDBY: {
326 style = subst(style, '_', ' ');
328 if (tclass.hasLayout(style)) {
329 docstring const tmpname = name_;
330 this->operator=(tclass[style]);
332 if (obsoleted_by().empty())
333 obsoleted_by_ = style;
335 LYXERR0("Cannot replace with unknown style `"
338 //lex.printError("Cannot replace with"
347 depends_on_ = subst(depends_on_, '_', ' ');
376 postcommandargs_.clear();
380 case LT_RESUMECOUNTER:
381 lex >> resumecounter;
384 case LT_STEPMASTERCOUNTER:
385 lex >> stepmastercounter;
392 case LT_NEED_PROTECT:
401 font = lyxRead(lex, font);
406 font = lyxRead(lex, font);
410 labelfont = lyxRead(lex, labelfont);
413 case LT_NEXTNOINDENT:
417 case LT_TOGGLE_INDENT: {
420 tog = support::ascii_lowercase(tog);
422 toggle_indent = ITOGGLE_ALWAYS;
423 else if (tog == "never")
424 toggle_indent = ITOGGLE_NEVER;
426 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
430 case LT_COMMANDDEPTH:
440 latexparam_ = subst(latexparam_, """, "\"");
445 leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
451 rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
472 preamble_ = lex.getLongString(from_ascii("EndPreamble"));
475 case LT_LANGPREAMBLE:
476 langpreamble_ = lex.getLongString(from_ascii("EndLangPreamble"));
479 case LT_BABELPREAMBLE:
480 babelpreamble_ = lex.getLongString(from_ascii("EndBabelPreamble"));
487 case LT_ENDLABELTYPE:
488 readEndLabelType(lex);
523 case LT_LABEL_BOTTOMSEP:
524 lex >> labelbottomsep;
529 labelsep = subst(labelsep, 'x', ' ');
537 lex >> newline_allowed;
544 case LT_ALIGNPOSSIBLE:
545 readAlignPossible(lex);
549 // FIXME: this means LT_LABELSTRING_APPENDIX may only
550 // occur after LT_LABELSTRING
552 labelstring_appendix_ = labelstring_;
555 case LT_ENDLABELSTRING:
556 lex >> endlabelstring_;
559 case LT_LABELSTRING_APPENDIX:
560 lex >> labelstring_appendix_;
563 case LT_LABELCOUNTER:
571 case LT_FREE_SPACING:
579 case LT_PASS_THRU_CHARS:
580 lex >> pass_thru_chars;
583 case LT_PARBREAK_IS_NEWLINE:
584 lex >> parbreak_is_newline;
593 vector<string> const req =
594 getVectorFromString(lex.getString(true));
595 requires_.insert(req.begin(), req.end());
600 docstring autonest = lex.getLongString(from_ascii("EndAutoNests"));
601 autonest = subst(autonest, from_ascii("\n"), docstring());
602 autonest = subst(autonest, from_ascii("\t"), docstring());
603 autonest = subst(autonest, from_ascii("\""), docstring());
604 autonest = subst(autonest, '_', ' ');
605 vector<docstring> const autonests =
606 getVectorFromString(autonest, from_ascii(","), false, true);
607 autonests_.insert(autonests.begin(), autonests.end());
611 case LT_AUTONESTEDBY: {
612 docstring autonest = lex.getLongString(from_ascii("EndIsAutoNestedBy"));
613 autonest = subst(autonest, from_ascii("\n"), docstring());
614 autonest = subst(autonest, from_ascii("\t"), docstring());
615 autonest = subst(autonest, from_ascii("\""), docstring());
616 autonest = subst(autonest, '_', ' ');
617 vector<docstring> const autonests =
618 getVectorFromString(autonest, from_ascii(","), false, true);
619 autonested_by_.insert(autonests.begin(), autonests.end());
645 case LT_HTMLITEMATTR:
646 lex >> htmlitemattr_;
650 lex >> htmllabeltag_;
653 case LT_HTMLLABELATTR:
654 lex >> htmllabelattr_;
657 case LT_HTMLLABELFIRST:
658 lex >> htmllabelfirst_;
662 htmlstyle_ = lex.getLongString(from_ascii("EndHTMLStyle"));
665 case LT_HTMLFORCECSS:
666 lex >> htmlforcecss_;
669 case LT_HTMLPREAMBLE:
670 htmlpreamble_ = lex.getLongString(from_ascii("EndPreamble"));
687 add_to_toc_ = !toc_type_.empty();
690 case LT_ISTOCCAPTION:
691 lex >> is_toc_caption_;
697 // make sure we only have inpreamble = true for commands
698 if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
699 LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
700 LYXERR0("Layout name: " << name());
704 return finished && !error;
717 LexerKeyword alignTags[] = {
718 { "block", AT_BLOCK },
719 { "center", AT_CENTER },
720 { "layout", AT_LAYOUT },
722 { "right", AT_RIGHT }
726 void Layout::readAlign(Lexer & lex)
728 PushPopHelper pph(lex, alignTags);
731 case Lexer::LEX_UNDEF:
732 lex.printError("Unknown alignment `$$Token'");
738 align = LYX_ALIGN_BLOCK;
741 align = LYX_ALIGN_LEFT;
744 align = LYX_ALIGN_RIGHT;
747 align = LYX_ALIGN_CENTER;
750 align = LYX_ALIGN_LAYOUT;
756 void Layout::readAlignPossible(Lexer & lex)
758 lex.pushTable(alignTags);
759 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
760 int lineno = lex.lineNumber();
764 case Lexer::LEX_UNDEF:
765 lex.printError("Unknown alignment `$$Token'");
771 alignpossible |= LYX_ALIGN_BLOCK;
774 alignpossible |= LYX_ALIGN_LEFT;
777 alignpossible |= LYX_ALIGN_RIGHT;
780 alignpossible |= LYX_ALIGN_CENTER;
783 alignpossible |= LYX_ALIGN_LAYOUT;
786 } while (lineno == lex.lineNumber());
791 void Layout::readLabelType(Lexer & lex)
806 LexerKeyword labelTypeTags[] = {
807 { "above", LA_ABOVE },
808 { "bibliography", LA_BIBLIO },
809 { "centered", LA_CENTERED },
810 { "enumerate", LA_ENUMERATE },
811 { "itemize", LA_ITEMIZE },
812 { "manual", LA_MANUAL },
813 { "no_label", LA_NO_LABEL },
814 { "sensitive", LA_SENSITIVE },
815 { "static", LA_STATIC }
818 PushPopHelper pph(lex, labelTypeTags);
821 case Lexer::LEX_UNDEF:
822 lex.printError("Unknown labeltype tag `$$Token'");
828 labeltype = LABEL_NO_LABEL;
831 labeltype = LABEL_MANUAL;
834 labeltype = LABEL_ABOVE;
837 labeltype = LABEL_CENTERED;
840 labeltype = LABEL_STATIC;
843 labeltype = LABEL_SENSITIVE;
846 labeltype = LABEL_ENUMERATE;
849 labeltype = LABEL_ITEMIZE;
852 labeltype = LABEL_BIBLIO;
858 void Layout::readEndLabelType(Lexer & lex)
860 // this should be const, but can't be because
862 static LexerKeyword endlabelTypeTags[] = {
863 { "box", END_LABEL_BOX },
864 { "filled_box", END_LABEL_FILLED_BOX },
865 { "no_label", END_LABEL_NO_LABEL },
866 { "static", END_LABEL_STATIC }
869 PushPopHelper pph(lex, endlabelTypeTags);
872 case Lexer::LEX_UNDEF:
873 lex.printError("Unknown labeltype tag `$$Token'");
875 case END_LABEL_STATIC:
877 case END_LABEL_FILLED_BOX:
878 case END_LABEL_NO_LABEL:
879 endlabeltype = static_cast<EndLabelType>(le);
882 LYXERR0("Unhandled value " << le);
888 void Layout::readMargin(Lexer & lex)
890 LexerKeyword marginTags[] = {
891 { "dynamic", MARGIN_DYNAMIC },
892 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
893 { "manual", MARGIN_MANUAL },
894 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
895 { "static", MARGIN_STATIC }
898 PushPopHelper pph(lex, marginTags);
902 case Lexer::LEX_UNDEF:
903 lex.printError("Unknown margin type tag `$$Token'");
908 case MARGIN_FIRST_DYNAMIC:
909 case MARGIN_RIGHT_ADDRESS_BOX:
910 margintype = static_cast<MarginType>(le);
913 LYXERR0("Unhandled value " << le);
919 void Layout::readLatexType(Lexer & lex)
921 LexerKeyword latexTypeTags[] = {
922 { "bib_environment", LATEX_BIB_ENVIRONMENT },
923 { "command", LATEX_COMMAND },
924 { "environment", LATEX_ENVIRONMENT },
925 { "item_environment", LATEX_ITEM_ENVIRONMENT },
926 { "list_environment", LATEX_LIST_ENVIRONMENT },
927 { "paragraph", LATEX_PARAGRAPH }
930 PushPopHelper pph(lex, latexTypeTags);
933 case Lexer::LEX_UNDEF:
934 lex.printError("Unknown latextype tag `$$Token'");
936 case LATEX_PARAGRAPH:
938 case LATEX_ITEM_ENVIRONMENT:
939 case LATEX_LIST_ENVIRONMENT:
940 latextype = static_cast<LatexType>(le);
942 case LATEX_ENVIRONMENT:
943 case LATEX_BIB_ENVIRONMENT:
944 latextype = static_cast<LatexType>(le);
948 LYXERR0("Unhandled value " << le);
954 void Layout::readSpacing(Lexer & lex)
957 ST_SPACING_SINGLE = 1,
963 LexerKeyword spacingTags[] = {
964 {"double", ST_SPACING_DOUBLE },
965 {"onehalf", ST_SPACING_ONEHALF },
966 {"other", ST_OTHER },
967 {"single", ST_SPACING_SINGLE }
970 PushPopHelper pph(lex, spacingTags);
973 case Lexer::LEX_UNDEF:
974 lex.printError("Unknown spacing token `$$Token'");
979 case ST_SPACING_SINGLE:
980 spacing.set(Spacing::Single);
982 case ST_SPACING_ONEHALF:
983 spacing.set(Spacing::Onehalf);
985 case ST_SPACING_DOUBLE:
986 spacing.set(Spacing::Double);
990 spacing.set(Spacing::Other, lex.getString());
996 void Layout::readArgument(Lexer & lex)
999 // writeArgument() makes use of these default values
1000 arg.mandatory = false;
1001 arg.autoinsert = false;
1002 arg.insertcotext = false;
1004 bool finished = false;
1005 arg.font = inherit_font;
1006 arg.labelfont = inherit_font;
1007 arg.is_toc_caption = false;
1008 arg.passthru = PT_INHERITED;
1011 bool const itemarg = prefixIs(id, "item:");
1012 bool const postcmd = prefixIs(id, "post:");
1014 while (!finished && lex.isOK() && !error) {
1016 string const tok = ascii_lowercase(lex.getString());
1020 } else if (tok == "endargument") {
1022 } else if (tok == "labelstring") {
1024 arg.labelstring = lex.getDocString();
1025 } else if (tok == "menustring") {
1027 arg.menustring = lex.getDocString();
1028 } else if (tok == "mandatory") {
1030 arg.mandatory = lex.getBool();
1031 } else if (tok == "autoinsert") {
1033 arg.autoinsert = lex.getBool();
1034 } else if (tok == "insertcotext") {
1036 arg.insertcotext = lex.getBool();
1037 } else if (tok == "leftdelim") {
1039 arg.ldelim = lex.getDocString();
1040 arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
1042 } else if (tok == "rightdelim") {
1044 arg.rdelim = lex.getDocString();
1045 arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
1047 } else if (tok == "defaultarg") {
1049 arg.defaultarg = lex.getDocString();
1050 } else if (tok == "presetarg") {
1052 arg.presetarg = lex.getDocString();
1053 } else if (tok == "tooltip") {
1055 arg.tooltip = lex.getDocString();
1056 } else if (tok == "requires") {
1058 arg.requires = lex.getString();
1059 } else if (tok == "decoration") {
1061 arg.decoration = lex.getString();
1062 } else if (tok == "font") {
1063 arg.font = lyxRead(lex, arg.font);
1064 } else if (tok == "labelfont") {
1065 arg.labelfont = lyxRead(lex, arg.labelfont);
1066 } else if (tok == "passthruchars") {
1068 arg.pass_thru_chars = lex.getDocString();
1069 } else if (tok == "passthru") {
1071 docstring value = lex.getDocString();
1072 if (value == "true" || value == "1")
1073 arg.passthru = PT_TRUE;
1074 else if (value == "false" || value == "0")
1075 arg.passthru = PT_FALSE;
1077 arg.passthru = PT_INHERITED;
1078 } else if (tok == "istoccaption") {
1080 arg.is_toc_caption = lex.getBool();
1082 lex.printError("Unknown tag");
1086 if (arg.labelstring.empty())
1087 LYXERR0("Incomplete Argument definition!");
1089 itemargs_[id] = arg;
1091 postcommandargs_[id] = arg;
1093 latexargs_[id] = arg;
1097 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1099 os << "\tArgument " << id << '\n';
1100 if (!arg.labelstring.empty())
1101 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1102 if (!arg.menustring.empty())
1103 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1105 os << "\t\tMandatory " << arg.mandatory << '\n';
1107 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1108 if (arg.insertcotext)
1109 os << "\t\tInsertCotext " << arg.insertcotext << '\n';
1110 if (!arg.ldelim.empty())
1111 os << "\t\tLeftDelim \""
1112 << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1114 if (!arg.rdelim.empty())
1115 os << "\t\tRightDelim \""
1116 << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1118 if (!arg.defaultarg.empty())
1119 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1120 if (!arg.presetarg.empty())
1121 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1122 if (!arg.tooltip.empty())
1123 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1124 if (!arg.requires.empty())
1125 os << "\t\tRequires \"" << arg.requires << "\"\n";
1126 if (!arg.decoration.empty())
1127 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1128 if (arg.font != inherit_font)
1129 lyxWrite(os, arg.font, "Font", 2);
1130 if (arg.labelfont != inherit_font)
1131 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1132 switch (arg.passthru) {
1134 os << "\t\tPassThru true\n";
1137 os << "\t\tPassThru false\n";
1140 os << "\t\tPassThru inherited\n";
1143 if (!arg.pass_thru_chars.empty())
1144 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1145 os << "\tEndArgument\n";
1149 void Layout::write(ostream & os) const
1151 os << "Style \"" << to_utf8(name_) << "\"\n";
1152 if (!category_.empty() && obsoleted_by_.empty())
1153 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1154 // Can't deduce Copystyle here :-(
1155 if (!obsoleted_by_.empty()) {
1156 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1160 if (!depends_on_.empty())
1161 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1162 switch (margintype) {
1163 case MARGIN_DYNAMIC:
1164 os << "\tMargin Dynamic\n";
1166 case MARGIN_FIRST_DYNAMIC:
1167 os << "\tMargin First_Dynamic\n";
1170 os << "\tMargin Manual\n";
1172 case MARGIN_RIGHT_ADDRESS_BOX:
1173 os << "\tMargin Right_Address_Box\n";
1176 os << "\tMargin Static\n";
1179 switch (latextype) {
1180 case LATEX_BIB_ENVIRONMENT:
1181 os << "\tLatexType Bib_Environment\n";
1184 os << "\tLatexType Command\n";
1186 case LATEX_ENVIRONMENT:
1187 os << "\tLatexType Environment\n";
1189 case LATEX_ITEM_ENVIRONMENT:
1190 os << "\tLatexType Item_Environment\n";
1192 case LATEX_LIST_ENVIRONMENT:
1193 os << "\tLatexType List_Environment\n";
1195 case LATEX_PARAGRAPH:
1196 os << "\tLatexType Paragraph\n";
1199 os << "\tInTitle " << intitle << "\n"
1200 "\tInPreamble " << inpreamble << "\n"
1201 "\tTocLevel " << toclevel << "\n"
1202 "\tResumeCounter " << resumecounter << "\n"
1203 "\tStepMasterCounter " << stepmastercounter << '\n';
1204 // ResetArgs does not make sense here
1205 for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1206 it != latexargs_.end(); ++it)
1207 writeArgument(os, it->first, it->second);
1208 for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1209 it != itemargs_.end(); ++it)
1210 writeArgument(os, it->first, it->second);
1211 for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1212 it != postcommandargs_.end(); ++it)
1213 writeArgument(os, it->first, it->second);
1214 os << "\tNeedProtect " << needprotect << "\n"
1215 "\tKeepEmpty " << keepempty << '\n';
1216 if (labelfont == font)
1217 lyxWrite(os, font, "Font", 1);
1219 lyxWrite(os, font, "TextFont", 1);
1220 lyxWrite(os, labelfont, "LabelFont", 1);
1222 os << "\tNextNoIndent " << nextnoindent << "\n"
1223 "\tCommandDepth " << commanddepth << '\n';
1224 if (!latexname_.empty())
1225 os << "\tLatexName \"" << latexname_ << "\"\n";
1226 if (!latexparam_.empty())
1227 os << "\tLatexParam \"" << subst(latexparam_, "\"", """)
1229 if (!leftdelim_.empty())
1230 os << "\tLeftDelim "
1231 << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1233 if (!rightdelim_.empty())
1234 os << "\tRightDelim "
1235 << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1237 if (!innertag_.empty())
1238 os << "\tInnerTag \"" << innertag_ << "\"\n";
1239 if (!labeltag_.empty())
1240 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1241 if (!itemtag_.empty())
1242 os << "\tItemTag \"" << itemtag_ << "\"\n";
1243 if (!itemcommand_.empty())
1244 os << "\tItemCommand " << itemcommand_ << '\n';
1245 if (!preamble_.empty())
1246 os << "\tPreamble\n\t"
1247 << to_utf8(subst(rtrim(preamble_, "\n"),
1248 from_ascii("\n"), from_ascii("\n\t")))
1249 << "\n\tEndPreamble\n";
1250 if (!langpreamble_.empty())
1251 os << "\tLangPreamble\n\t"
1252 << to_utf8(subst(rtrim(langpreamble_, "\n"),
1253 from_ascii("\n"), from_ascii("\n\t")))
1254 << "\n\tEndLangPreamble\n";
1255 if (!babelpreamble_.empty())
1256 os << "\tBabelPreamble\n\t"
1257 << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1258 from_ascii("\n"), from_ascii("\n\t")))
1259 << "\n\tEndBabelPreamble\n";
1260 switch (labeltype) {
1262 os << "\tLabelType Above\n";
1265 os << "\tLabelType Bibliography\n";
1267 case LABEL_CENTERED:
1268 os << "\tLabelType Centered\n";
1270 case LABEL_ENUMERATE:
1271 os << "\tLabelType Enumerate\n";
1274 os << "\tLabelType Itemize\n";
1277 os << "\tLabelType Manual\n";
1279 case LABEL_NO_LABEL:
1280 os << "\tLabelType No_Label\n";
1282 case LABEL_SENSITIVE:
1283 os << "\tLabelType Sensitive\n";
1286 os << "\tLabelType Static\n";
1289 switch (endlabeltype) {
1291 os << "\tEndLabelType Box\n";
1293 case END_LABEL_FILLED_BOX:
1294 os << "\tEndLabelType Filled_Box\n";
1296 case END_LABEL_NO_LABEL:
1297 os << "\tEndLabelType No_Label\n";
1299 case END_LABEL_STATIC:
1300 os << "\tEndLabelType Static\n";
1303 os << "\tParagraphGroup \"" << par_group_ << "\"\n";
1304 if (!leftmargin.empty())
1305 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1306 if (!rightmargin.empty())
1307 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1308 if (!labelindent.empty())
1309 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1310 if (!parindent.empty())
1311 os << "\tParIndent " << to_utf8(parindent) << '\n';
1312 os << "\tParSkip " << parskip << "\n"
1313 "\tItemSep " << itemsep << "\n"
1314 "\tTopSep " << topsep << "\n"
1315 "\tBottomSep " << bottomsep << "\n"
1316 "\tLabelBottomSep " << labelbottomsep << '\n';
1317 if (!labelsep.empty())
1318 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1320 os << "\tParSep " << parsep << "\n"
1321 "\tNewLine " << newline_allowed << '\n';
1323 case LYX_ALIGN_BLOCK:
1324 os << "\tAlign Block\n";
1326 case LYX_ALIGN_CENTER:
1327 os << "\tAlign Center\n";
1329 case LYX_ALIGN_LAYOUT:
1330 os << "\tAlign Layout\n";
1332 case LYX_ALIGN_LEFT:
1333 os << "\tAlign Left\n";
1335 case LYX_ALIGN_RIGHT:
1336 os << "\tAlign Right\n";
1338 case LYX_ALIGN_DECIMAL:
1339 case LYX_ALIGN_SPECIAL:
1340 case LYX_ALIGN_NONE:
1343 if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1344 LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1346 os << "\tAlignPossible";
1347 if (alignpossible & LYX_ALIGN_BLOCK) {
1351 if (alignpossible & LYX_ALIGN_CENTER) {
1357 if (alignpossible & LYX_ALIGN_LAYOUT) {
1363 if (alignpossible & LYX_ALIGN_LEFT) {
1369 if (alignpossible & LYX_ALIGN_RIGHT) {
1377 // LabelString must come before LabelStringAppendix
1378 if (!labelstring_.empty())
1379 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1380 if (!endlabelstring_.empty())
1381 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1382 if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1383 os << "\tLabelStringAppendix \""
1384 << to_utf8(labelstring_appendix_) << "\"\n";
1385 if (!counter.empty())
1386 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1387 os << "\tFreeSpacing " << free_spacing << '\n';
1388 os << "\tPassThru " << pass_thru << '\n';
1389 if (!pass_thru_chars.empty())
1390 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1391 os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1392 switch (spacing.getSpace()) {
1393 case Spacing::Double:
1394 os << "\tSpacing Double\n";
1396 case Spacing::Onehalf:
1397 os << "\tSpacing Onehalf\n";
1399 case Spacing::Other:
1400 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1402 case Spacing::Single:
1403 os << "\tSpacing Single\n";
1405 case Spacing::Default:
1408 if (!requires_.empty()) {
1409 os << "\tRequires ";
1410 for (set<string>::const_iterator it = requires_.begin();
1411 it != requires_.end(); ++it) {
1412 if (it != requires_.begin())
1418 if (!autonests_.empty()) {
1419 os << "\tAutoNests\n\t";
1420 for (set<docstring>::const_iterator it = autonests_.begin();
1421 it != autonests_.end(); ++it) {
1422 if (it != autonests_.begin())
1426 os << "\n\tEndAutoNests\n";
1428 if (!autonested_by_.empty()) {
1429 os << "\tIsAutoNestedBy\n\t";
1430 for (set<docstring>::const_iterator it = autonested_by_.begin();
1431 it != autonested_by_.end(); ++it) {
1432 if (it != autonested_by_.begin())
1436 os << "\n\tIsAutoNestedBy\n";
1438 if (refprefix.empty())
1439 os << "\tRefPrefix OFF\n";
1441 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1442 if (!htmltag_.empty())
1443 os << "\tHTMLTag " << htmltag_ << '\n';
1444 if (!htmlattr_.empty())
1445 os << "\tHTMLAttr " << htmlattr_ << '\n';
1446 if (!htmlitemtag_.empty())
1447 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1448 if (!htmlitemattr_.empty())
1449 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1450 if (!htmllabeltag_.empty())
1451 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1452 if (!htmllabelattr_.empty())
1453 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1454 os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1455 if (!htmlstyle_.empty())
1456 os << "\tHTMLStyle\n"
1457 << to_utf8(rtrim(htmlstyle_, "\n"))
1458 << "\n\tEndHTMLStyle\n";
1459 os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1460 if (!htmlpreamble_.empty())
1461 os << "\tHTMLPreamble\n"
1462 << to_utf8(rtrim(htmlpreamble_, "\n"))
1463 << "\n\tEndPreamble\n";
1464 os << "\tHTMLTitle " << htmltitle_ << "\n"
1465 "\tSpellcheck " << spellcheck << "\n"
1466 "\tForceLocal " << forcelocal << "\n"
1471 bool Layout::hasArgs() const
1473 return !latexargs_.empty() || !postcommandargs_.empty() ||
1478 Layout::LaTeXArgMap Layout::args() const
1480 LaTeXArgMap args = latexargs_;
1481 if (!postcommandargs_.empty())
1482 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1483 if (!itemargs_.empty())
1484 args.insert(itemargs_.begin(), itemargs_.end());
1489 int Layout::optArgs() const
1492 LaTeXArgMap::const_iterator it = latexargs_.begin();
1493 for (; it != latexargs_.end(); ++it) {
1494 if (!(*it).second.mandatory)
1497 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1498 for (; iit != postcommandargs_.end(); ++iit) {
1499 if (!(*iit).second.mandatory)
1506 int Layout::requiredArgs() const
1509 LaTeXArgMap::const_iterator it = latexargs_.begin();
1510 for (; it != latexargs_.end(); ++it) {
1511 if ((*it).second.mandatory)
1514 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1515 for (; iit != postcommandargs_.end(); ++iit) {
1516 if (!(*iit).second.mandatory)
1523 string const & Layout::htmltag() const
1525 if (htmltag_.empty())
1531 string const & Layout::htmlattr() const
1533 if (htmlattr_.empty())
1534 htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
1539 string const & Layout::htmlitemtag() const
1541 if (htmlitemtag_.empty())
1542 htmlitemtag_ = "div";
1543 return htmlitemtag_;
1547 string const & Layout::htmlitemattr() const
1549 if (htmlitemattr_.empty())
1550 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1551 return htmlitemattr_;
1555 string const & Layout::htmllabeltag() const
1557 if (htmllabeltag_.empty())
1558 htmllabeltag_ = "span";
1559 return htmllabeltag_;
1563 string const & Layout::htmllabelattr() const
1565 if (htmllabelattr_.empty())
1566 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1567 return htmllabelattr_;
1571 docstring Layout::htmlstyle() const
1573 if (!htmlstyle_.empty() && !htmlforcecss_)
1575 if (htmldefaultstyle_.empty())
1577 docstring retval = htmldefaultstyle_;
1578 if (!htmlstyle_.empty())
1579 retval += '\n' + htmlstyle_;
1584 string Layout::defaultCSSClass() const
1586 if (!defaultcssclass_.empty())
1587 return defaultcssclass_;
1589 docstring::const_iterator it = name().begin();
1590 docstring::const_iterator en = name().end();
1591 for (; it != en; ++it) {
1592 char_type const c = *it;
1593 if (!isAlphaASCII(c)) {
1595 // make sure we don't start with an underscore,
1596 // as that sometimes causes problems.
1597 d = from_ascii("lyx_");
1600 } else if (isLower(c))
1603 // this is slow, so do it only if necessary
1606 defaultcssclass_ = to_utf8(d);
1607 return defaultcssclass_;
1613 string makeMarginValue(char const * side, double d)
1616 os << "margin-" << side << ": " << d << "ex;\n";
1623 void Layout::makeDefaultCSS() const
1625 // this never needs to be redone, since reloading layouts will
1626 // wipe out what we did before.
1627 if (!htmldefaultstyle_.empty())
1631 htmldefaultstyle_ = font.asCSS();
1636 tmp += makeMarginValue("top", topsep);
1638 tmp += makeMarginValue("bottom", bottomsep);
1639 if (!leftmargin.empty()) {
1640 // we can't really do what LyX does with the margin, so
1641 // we'll just figure out how many characters it is
1642 int const len = leftmargin.length();
1643 tmp += makeMarginValue("left", len);
1645 if (!rightmargin.empty()) {
1646 int const len = rightmargin.length();
1647 tmp += makeMarginValue("right", len);
1651 if (!htmldefaultstyle_.empty())
1652 htmldefaultstyle_ += from_ascii("\n");
1653 htmldefaultstyle_ += from_ascii(tmp);
1657 string where = alignmentToCSS(align);
1658 if (!where.empty()) {
1659 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
1662 // wrap up what we have, if anything
1663 if (!htmldefaultstyle_.empty())
1665 from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
1666 htmldefaultstyle_ + from_ascii("\n}\n");
1668 if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
1674 if (labelfont != font)
1675 labelCSS = labelfont.asCSS() + from_ascii("\n");
1676 if (labeltype == LABEL_CENTERED)
1677 labelCSS += from_ascii("text-align: center;\n");
1679 if (!labelCSS.empty())
1680 htmldefaultstyle_ +=
1681 from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
1682 labelCSS + from_ascii("\n}\n");
1686 bool Layout::operator==(Layout const & rhs) const
1688 // This is enough for the applications we actually make,
1689 // at least at the moment. But we could check more.
1690 return name() == rhs.name()
1691 && latexname() == rhs.latexname()
1692 && latextype == rhs.latextype;