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]
55 LT_PARBREAK_IS_NEWLINE,
65 LT_LABELSTRING_APPENDIX,
109 LT_STEPMASTERCOUNTER,
115 LT_INTITLE // keep this last!
118 /////////////////////
121 : add_to_toc_(false), is_toc_caption_(false)
124 margintype = MARGIN_STATIC;
125 latextype = LATEX_PARAGRAPH;
126 resumecounter = false;
127 stepmastercounter = false;
133 labelfont = inherit_font;
135 reslabelfont = sane_font;
136 nextnoindent = false;
141 labelbottomsep = 0.0;
143 align = LYX_ALIGN_BLOCK;
144 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
145 labeltype = LABEL_NO_LABEL;
146 endlabeltype = END_LABEL_NO_LABEL;
147 // Should or should not. That is the question.
148 // spacing.set(Spacing::OneHalf);
149 newline_allowed = true;
150 free_spacing = false;
152 parbreak_is_newline = false;
153 toclevel = NOT_IN_TOC;
155 htmllabelfirst_ = false;
156 htmlforcecss_ = false;
160 itemcommand_ = "item";
161 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
166 bool Layout::read(Lexer & lex, TextClass const & tclass)
168 // If this is an empty layout, or if no force local version is set,
169 // we know that we will not discard the stuff to read
171 return readIgnoreForcelocal(lex, tclass);
174 bool const ret = tmp.readIgnoreForcelocal(lex, tclass);
176 // - the read version is higher
177 // - both versions are infinity (arbitrary decision)
178 // - the file did not contain any local version (needed for not
179 // skipping user defined local layouts)
180 if (tmp.forcelocal <= 0 || tmp.forcelocal > forcelocal)
186 bool Layout::readIgnoreForcelocal(Lexer & lex, TextClass const & tclass)
188 // This table is sorted alphabetically [asierra 30March96]
189 LexerKeyword layoutTags[] = {
190 { "addtotoc", LT_ADDTOTOC },
191 { "align", LT_ALIGN },
192 { "alignpossible", LT_ALIGNPOSSIBLE },
193 { "argument", LT_ARGUMENT },
194 { "babelpreamble", LT_BABELPREAMBLE },
195 { "bottomsep", LT_BOTTOMSEP },
196 { "category", LT_CATEGORY },
197 { "commanddepth", LT_COMMANDDEPTH },
198 { "copystyle", LT_COPYSTYLE },
199 { "dependson", LT_DEPENDSON },
201 { "endlabelstring", LT_ENDLABELSTRING },
202 { "endlabeltype", LT_ENDLABELTYPE },
204 { "forcelocal", LT_FORCELOCAL },
205 { "freespacing", LT_FREE_SPACING },
206 { "htmlattr", LT_HTMLATTR },
207 { "htmlforcecss", LT_HTMLFORCECSS },
208 { "htmlitem", LT_HTMLITEM },
209 { "htmlitemattr", LT_HTMLITEMATTR },
210 { "htmllabel", LT_HTMLLABEL },
211 { "htmllabelattr", LT_HTMLLABELATTR },
212 { "htmllabelfirst", LT_HTMLLABELFIRST },
213 { "htmlpreamble", LT_HTMLPREAMBLE },
214 { "htmlstyle", LT_HTMLSTYLE },
215 { "htmltag", LT_HTMLTAG },
216 { "htmltitle", LT_HTMLTITLE },
217 { "innertag", LT_INNERTAG },
218 { "inpreamble", LT_INPREAMBLE },
219 { "intitle", LT_INTITLE },
220 { "istoccaption", LT_ISTOCCAPTION },
221 { "itemcommand", LT_ITEMCOMMAND },
222 { "itemsep", LT_ITEMSEP },
223 { "itemtag", LT_ITEMTAG },
224 { "keepempty", LT_KEEPEMPTY },
225 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
226 { "labelcounter", LT_LABELCOUNTER },
227 { "labelfont", LT_LABELFONT },
228 { "labelindent", LT_LABELINDENT },
229 { "labelsep", LT_LABELSEP },
230 { "labelstring", LT_LABELSTRING },
231 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
232 { "labeltag", LT_LABELTAG },
233 { "labeltype", LT_LABELTYPE },
234 { "langpreamble", LT_LANGPREAMBLE },
235 { "latexname", LT_LATEXNAME },
236 { "latexparam", LT_LATEXPARAM },
237 { "latextype", LT_LATEXTYPE },
238 { "leftdelim", LT_LEFTDELIM },
239 { "leftmargin", LT_LEFTMARGIN },
240 { "margin", LT_MARGIN },
241 { "needprotect", LT_NEED_PROTECT },
242 { "newline", LT_NEWLINE },
243 { "nextnoindent", LT_NEXTNOINDENT },
244 { "obsoletedby", LT_OBSOLETEDBY },
245 { "paragraphgroup", LT_PAR_GROUP },
246 { "parbreakisnewline", LT_PARBREAK_IS_NEWLINE },
247 { "parindent", LT_PARINDENT },
248 { "parsep", LT_PARSEP },
249 { "parskip", LT_PARSKIP },
250 { "passthru", LT_PASS_THRU },
251 { "passthruchars", LT_PASS_THRU_CHARS },
252 { "preamble", LT_PREAMBLE },
253 { "refprefix", LT_REFPREFIX },
254 { "requires", LT_REQUIRES },
255 { "resetargs", LT_RESETARGS },
256 { "resumecounter", LT_RESUMECOUNTER },
257 { "rightdelim", LT_RIGHTDELIM },
258 { "rightmargin", LT_RIGHTMARGIN },
259 { "spacing", LT_SPACING },
260 { "spellcheck", LT_SPELLCHECK },
261 { "stepmastercounter", LT_STEPMASTERCOUNTER },
262 { "textfont", LT_TEXTFONT },
263 { "toclevel", LT_TOCLEVEL },
264 { "toggleindent", LT_TOGGLE_INDENT },
265 { "topsep", LT_TOPSEP }
269 bool finished = false;
270 lex.pushTable(layoutTags);
272 // parse style section
273 while (!finished && lex.isOK() && !error) {
275 // See comment in LyXRC.cpp.
277 case Lexer::LEX_FEOF:
280 case Lexer::LEX_UNDEF:
282 lex.printError("Unknown layout tag `$$Token'");
289 switch (static_cast<LayoutTags>(le)) {
301 style = subst(style, '_', ' ');
303 if (tclass.hasLayout(style)) {
304 docstring const tmpname = name_;
305 this->operator=(tclass[style]);
308 LYXERR0("Cannot copy unknown style `"
310 << "All layouts so far:");
311 DocumentClass::const_iterator lit = tclass.begin();
312 DocumentClass::const_iterator len = tclass.end();
313 for (; lit != len; ++lit)
314 LYXERR0(lit->name());
319 case LT_OBSOLETEDBY: {
322 style = subst(style, '_', ' ');
324 if (tclass.hasLayout(style)) {
325 docstring const tmpname = name_;
326 this->operator=(tclass[style]);
328 if (obsoleted_by().empty())
329 obsoleted_by_ = style;
331 LYXERR0("Cannot replace with unknown style `"
334 //lex.printError("Cannot replace with"
343 depends_on_ = subst(depends_on_, '_', ' ');
372 postcommandargs_.clear();
376 case LT_RESUMECOUNTER:
377 lex >> resumecounter;
380 case LT_STEPMASTERCOUNTER:
381 lex >> stepmastercounter;
388 case LT_NEED_PROTECT:
397 font = lyxRead(lex, font);
402 font = lyxRead(lex, font);
406 labelfont = lyxRead(lex, labelfont);
409 case LT_NEXTNOINDENT:
413 case LT_TOGGLE_INDENT: {
416 tog = support::ascii_lowercase(tog);
418 toggle_indent = ITOGGLE_ALWAYS;
419 else if (tog == "never")
420 toggle_indent = ITOGGLE_NEVER;
422 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
426 case LT_COMMANDDEPTH:
436 latexparam_ = subst(latexparam_, """, "\"");
441 leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
447 rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
468 preamble_ = lex.getLongString(from_ascii("EndPreamble"));
471 case LT_LANGPREAMBLE:
472 langpreamble_ = lex.getLongString(from_ascii("EndLangPreamble"));
475 case LT_BABELPREAMBLE:
476 babelpreamble_ = lex.getLongString(from_ascii("EndBabelPreamble"));
483 case LT_ENDLABELTYPE:
484 readEndLabelType(lex);
519 case LT_LABEL_BOTTOMSEP:
520 lex >> labelbottomsep;
525 labelsep = subst(labelsep, 'x', ' ');
533 lex >> newline_allowed;
540 case LT_ALIGNPOSSIBLE:
541 readAlignPossible(lex);
545 // FIXME: this means LT_LABELSTRING_APPENDIX may only
546 // occur after LT_LABELSTRING
548 labelstring_appendix_ = labelstring_;
551 case LT_ENDLABELSTRING:
552 lex >> endlabelstring_;
555 case LT_LABELSTRING_APPENDIX:
556 lex >> labelstring_appendix_;
559 case LT_LABELCOUNTER:
567 case LT_FREE_SPACING:
575 case LT_PASS_THRU_CHARS:
576 lex >> pass_thru_chars;
579 case LT_PARBREAK_IS_NEWLINE:
580 lex >> parbreak_is_newline;
589 vector<string> const req =
590 getVectorFromString(lex.getString(true));
591 requires_.insert(req.begin(), req.end());
617 case LT_HTMLITEMATTR:
618 lex >> htmlitemattr_;
622 lex >> htmllabeltag_;
625 case LT_HTMLLABELATTR:
626 lex >> htmllabelattr_;
629 case LT_HTMLLABELFIRST:
630 lex >> htmllabelfirst_;
634 htmlstyle_ = lex.getLongString(from_ascii("EndHTMLStyle"));
637 case LT_HTMLFORCECSS:
638 lex >> htmlforcecss_;
641 case LT_HTMLPREAMBLE:
642 htmlpreamble_ = lex.getLongString(from_ascii("EndPreamble"));
659 add_to_toc_ = !toc_type_.empty();
662 case LT_ISTOCCAPTION:
663 lex >> is_toc_caption_;
669 // make sure we only have inpreamble = true for commands
670 if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
671 LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
672 LYXERR0("Layout name: " << name());
676 return finished && !error;
689 LexerKeyword alignTags[] = {
690 { "block", AT_BLOCK },
691 { "center", AT_CENTER },
692 { "layout", AT_LAYOUT },
694 { "right", AT_RIGHT }
698 void Layout::readAlign(Lexer & lex)
700 PushPopHelper pph(lex, alignTags);
703 case Lexer::LEX_UNDEF:
704 lex.printError("Unknown alignment `$$Token'");
710 align = LYX_ALIGN_BLOCK;
713 align = LYX_ALIGN_LEFT;
716 align = LYX_ALIGN_RIGHT;
719 align = LYX_ALIGN_CENTER;
722 align = LYX_ALIGN_LAYOUT;
728 void Layout::readAlignPossible(Lexer & lex)
730 lex.pushTable(alignTags);
731 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
732 int lineno = lex.lineNumber();
736 case Lexer::LEX_UNDEF:
737 lex.printError("Unknown alignment `$$Token'");
743 alignpossible |= LYX_ALIGN_BLOCK;
746 alignpossible |= LYX_ALIGN_LEFT;
749 alignpossible |= LYX_ALIGN_RIGHT;
752 alignpossible |= LYX_ALIGN_CENTER;
755 alignpossible |= LYX_ALIGN_LAYOUT;
758 } while (lineno == lex.lineNumber());
763 void Layout::readLabelType(Lexer & lex)
778 LexerKeyword labelTypeTags[] = {
779 { "above", LA_ABOVE },
780 { "bibliography", LA_BIBLIO },
781 { "centered", LA_CENTERED },
782 { "enumerate", LA_ENUMERATE },
783 { "itemize", LA_ITEMIZE },
784 { "manual", LA_MANUAL },
785 { "no_label", LA_NO_LABEL },
786 { "sensitive", LA_SENSITIVE },
787 { "static", LA_STATIC }
790 PushPopHelper pph(lex, labelTypeTags);
793 case Lexer::LEX_UNDEF:
794 lex.printError("Unknown labeltype tag `$$Token'");
800 labeltype = LABEL_NO_LABEL;
803 labeltype = LABEL_MANUAL;
806 labeltype = LABEL_ABOVE;
809 labeltype = LABEL_CENTERED;
812 labeltype = LABEL_STATIC;
815 labeltype = LABEL_SENSITIVE;
818 labeltype = LABEL_ENUMERATE;
821 labeltype = LABEL_ITEMIZE;
824 labeltype = LABEL_BIBLIO;
830 void Layout::readEndLabelType(Lexer & lex)
832 // this should be const, but can't be because
834 static LexerKeyword endlabelTypeTags[] = {
835 { "box", END_LABEL_BOX },
836 { "filled_box", END_LABEL_FILLED_BOX },
837 { "no_label", END_LABEL_NO_LABEL },
838 { "static", END_LABEL_STATIC }
841 PushPopHelper pph(lex, endlabelTypeTags);
844 case Lexer::LEX_UNDEF:
845 lex.printError("Unknown labeltype tag `$$Token'");
847 case END_LABEL_STATIC:
849 case END_LABEL_FILLED_BOX:
850 case END_LABEL_NO_LABEL:
851 endlabeltype = static_cast<EndLabelType>(le);
854 LYXERR0("Unhandled value " << le);
860 void Layout::readMargin(Lexer & lex)
862 LexerKeyword marginTags[] = {
863 { "dynamic", MARGIN_DYNAMIC },
864 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
865 { "manual", MARGIN_MANUAL },
866 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
867 { "static", MARGIN_STATIC }
870 PushPopHelper pph(lex, marginTags);
874 case Lexer::LEX_UNDEF:
875 lex.printError("Unknown margin type tag `$$Token'");
880 case MARGIN_FIRST_DYNAMIC:
881 case MARGIN_RIGHT_ADDRESS_BOX:
882 margintype = static_cast<MarginType>(le);
885 LYXERR0("Unhandled value " << le);
891 void Layout::readLatexType(Lexer & lex)
893 LexerKeyword latexTypeTags[] = {
894 { "bib_environment", LATEX_BIB_ENVIRONMENT },
895 { "command", LATEX_COMMAND },
896 { "environment", LATEX_ENVIRONMENT },
897 { "item_environment", LATEX_ITEM_ENVIRONMENT },
898 { "list_environment", LATEX_LIST_ENVIRONMENT },
899 { "paragraph", LATEX_PARAGRAPH }
902 PushPopHelper pph(lex, latexTypeTags);
905 case Lexer::LEX_UNDEF:
906 lex.printError("Unknown latextype tag `$$Token'");
908 case LATEX_PARAGRAPH:
910 case LATEX_ITEM_ENVIRONMENT:
911 case LATEX_LIST_ENVIRONMENT:
912 latextype = static_cast<LatexType>(le);
914 case LATEX_ENVIRONMENT:
915 case LATEX_BIB_ENVIRONMENT:
916 latextype = static_cast<LatexType>(le);
920 LYXERR0("Unhandled value " << le);
926 void Layout::readSpacing(Lexer & lex)
929 ST_SPACING_SINGLE = 1,
935 LexerKeyword spacingTags[] = {
936 {"double", ST_SPACING_DOUBLE },
937 {"onehalf", ST_SPACING_ONEHALF },
938 {"other", ST_OTHER },
939 {"single", ST_SPACING_SINGLE }
942 PushPopHelper pph(lex, spacingTags);
945 case Lexer::LEX_UNDEF:
946 lex.printError("Unknown spacing token `$$Token'");
951 case ST_SPACING_SINGLE:
952 spacing.set(Spacing::Single);
954 case ST_SPACING_ONEHALF:
955 spacing.set(Spacing::Onehalf);
957 case ST_SPACING_DOUBLE:
958 spacing.set(Spacing::Double);
962 spacing.set(Spacing::Other, lex.getString());
968 void Layout::readArgument(Lexer & lex)
971 // writeArgument() makes use of these default values
972 arg.mandatory = false;
973 arg.autoinsert = false;
974 arg.insertcotext = false;
976 bool finished = false;
977 arg.font = inherit_font;
978 arg.labelfont = inherit_font;
979 arg.is_toc_caption = false;
980 arg.passthru = PT_INHERITED;
983 bool const itemarg = prefixIs(id, "item:");
984 bool const postcmd = prefixIs(id, "post:");
986 while (!finished && lex.isOK() && !error) {
988 string const tok = ascii_lowercase(lex.getString());
992 } else if (tok == "endargument") {
994 } else if (tok == "labelstring") {
996 arg.labelstring = lex.getDocString();
997 } else if (tok == "menustring") {
999 arg.menustring = lex.getDocString();
1000 } else if (tok == "mandatory") {
1002 arg.mandatory = lex.getBool();
1003 } else if (tok == "autoinsert") {
1005 arg.autoinsert = lex.getBool();
1006 } else if (tok == "insertcotext") {
1008 arg.insertcotext = lex.getBool();
1009 } else if (tok == "leftdelim") {
1011 arg.ldelim = lex.getDocString();
1012 arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
1014 } else if (tok == "rightdelim") {
1016 arg.rdelim = lex.getDocString();
1017 arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
1019 } else if (tok == "defaultarg") {
1021 arg.defaultarg = lex.getDocString();
1022 } else if (tok == "presetarg") {
1024 arg.presetarg = lex.getDocString();
1025 } else if (tok == "tooltip") {
1027 arg.tooltip = lex.getDocString();
1028 } else if (tok == "requires") {
1030 arg.requires = lex.getString();
1031 } else if (tok == "decoration") {
1033 arg.decoration = lex.getString();
1034 } else if (tok == "font") {
1035 arg.font = lyxRead(lex, arg.font);
1036 } else if (tok == "labelfont") {
1037 arg.labelfont = lyxRead(lex, arg.labelfont);
1038 } else if (tok == "passthruchars") {
1040 arg.pass_thru_chars = lex.getDocString();
1041 } else if (tok == "passthru") {
1043 docstring value = lex.getDocString();
1044 if (value == "true" || value == "1")
1045 arg.passthru = PT_TRUE;
1046 else if (value == "false" || value == "0")
1047 arg.passthru = PT_FALSE;
1049 arg.passthru = PT_INHERITED;
1050 } else if (tok == "istoccaption") {
1052 arg.is_toc_caption = lex.getBool();
1054 lex.printError("Unknown tag");
1058 if (arg.labelstring.empty())
1059 LYXERR0("Incomplete Argument definition!");
1061 itemargs_[id] = arg;
1063 postcommandargs_[id] = arg;
1065 latexargs_[id] = arg;
1069 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1071 os << "\tArgument " << id << '\n';
1072 if (!arg.labelstring.empty())
1073 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1074 if (!arg.menustring.empty())
1075 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1077 os << "\t\tMandatory " << arg.mandatory << '\n';
1079 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1080 if (arg.insertcotext)
1081 os << "\t\tInsertCotext " << arg.insertcotext << '\n';
1082 if (!arg.ldelim.empty())
1083 os << "\t\tLeftDelim \""
1084 << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1086 if (!arg.rdelim.empty())
1087 os << "\t\tRightDelim \""
1088 << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1090 if (!arg.defaultarg.empty())
1091 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1092 if (!arg.presetarg.empty())
1093 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1094 if (!arg.tooltip.empty())
1095 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1096 if (!arg.requires.empty())
1097 os << "\t\tRequires \"" << arg.requires << "\"\n";
1098 if (!arg.decoration.empty())
1099 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1100 if (arg.font != inherit_font)
1101 lyxWrite(os, arg.font, "Font", 2);
1102 if (arg.labelfont != inherit_font)
1103 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1104 switch (arg.passthru) {
1106 os << "\t\tPassThru true\n";
1109 os << "\t\tPassThru false\n";
1112 os << "\t\tPassThru inherited\n";
1115 if (!arg.pass_thru_chars.empty())
1116 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1117 os << "\tEndArgument\n";
1121 void Layout::write(ostream & os) const
1123 os << "Style \"" << to_utf8(name_) << "\"\n";
1124 if (!category_.empty() && obsoleted_by_.empty())
1125 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1126 // Can't deduce Copystyle here :-(
1127 if (!obsoleted_by_.empty()) {
1128 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1132 if (!depends_on_.empty())
1133 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1134 switch (margintype) {
1135 case MARGIN_DYNAMIC:
1136 os << "\tMargin Dynamic\n";
1138 case MARGIN_FIRST_DYNAMIC:
1139 os << "\tMargin First_Dynamic\n";
1142 os << "\tMargin Manual\n";
1144 case MARGIN_RIGHT_ADDRESS_BOX:
1145 os << "\tMargin Right_Address_Box\n";
1148 os << "\tMargin Static\n";
1151 switch (latextype) {
1152 case LATEX_BIB_ENVIRONMENT:
1153 os << "\tLatexType Bib_Environment\n";
1156 os << "\tLatexType Command\n";
1158 case LATEX_ENVIRONMENT:
1159 os << "\tLatexType Environment\n";
1161 case LATEX_ITEM_ENVIRONMENT:
1162 os << "\tLatexType Item_Environment\n";
1164 case LATEX_LIST_ENVIRONMENT:
1165 os << "\tLatexType List_Environment\n";
1167 case LATEX_PARAGRAPH:
1168 os << "\tLatexType Paragraph\n";
1171 os << "\tInTitle " << intitle << "\n"
1172 "\tInPreamble " << inpreamble << "\n"
1173 "\tTocLevel " << toclevel << "\n"
1174 "\tResumeCounter " << resumecounter << "\n"
1175 "\tStepMasterCounter " << stepmastercounter << '\n';
1176 // ResetArgs does not make sense here
1177 for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1178 it != latexargs_.end(); ++it)
1179 writeArgument(os, it->first, it->second);
1180 for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1181 it != itemargs_.end(); ++it)
1182 writeArgument(os, it->first, it->second);
1183 for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1184 it != postcommandargs_.end(); ++it)
1185 writeArgument(os, it->first, it->second);
1186 os << "\tNeedProtect " << needprotect << "\n"
1187 "\tKeepEmpty " << keepempty << '\n';
1188 if (labelfont == font)
1189 lyxWrite(os, font, "Font", 1);
1191 lyxWrite(os, font, "TextFont", 1);
1192 lyxWrite(os, labelfont, "LabelFont", 1);
1194 os << "\tNextNoIndent " << nextnoindent << "\n"
1195 "\tCommandDepth " << commanddepth << '\n';
1196 if (!latexname_.empty())
1197 os << "\tLatexName \"" << latexname_ << "\"\n";
1198 if (!latexparam_.empty())
1199 os << "\tLatexParam \"" << subst(latexparam_, "\"", """)
1201 if (!leftdelim_.empty())
1202 os << "\tLeftDelim "
1203 << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1205 if (!rightdelim_.empty())
1206 os << "\tRightDelim "
1207 << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1209 if (!innertag_.empty())
1210 os << "\tInnerTag \"" << innertag_ << "\"\n";
1211 if (!labeltag_.empty())
1212 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1213 if (!itemtag_.empty())
1214 os << "\tItemTag \"" << itemtag_ << "\"\n";
1215 if (!itemcommand_.empty())
1216 os << "\tItemCommand " << itemcommand_ << '\n';
1217 if (!preamble_.empty())
1218 os << "\tPreamble\n\t"
1219 << to_utf8(subst(rtrim(preamble_, "\n"),
1220 from_ascii("\n"), from_ascii("\n\t")))
1221 << "\n\tEndPreamble\n";
1222 if (!langpreamble_.empty())
1223 os << "\tLangPreamble\n\t"
1224 << to_utf8(subst(rtrim(langpreamble_, "\n"),
1225 from_ascii("\n"), from_ascii("\n\t")))
1226 << "\n\tEndLangPreamble\n";
1227 if (!babelpreamble_.empty())
1228 os << "\tBabelPreamble\n\t"
1229 << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1230 from_ascii("\n"), from_ascii("\n\t")))
1231 << "\n\tEndBabelPreamble\n";
1232 switch (labeltype) {
1234 os << "\tLabelType Above\n";
1237 os << "\tLabelType Bibliography\n";
1239 case LABEL_CENTERED:
1240 os << "\tLabelType Centered\n";
1242 case LABEL_ENUMERATE:
1243 os << "\tLabelType Enumerate\n";
1246 os << "\tLabelType Itemize\n";
1249 os << "\tLabelType Manual\n";
1251 case LABEL_NO_LABEL:
1252 os << "\tLabelType No_Label\n";
1254 case LABEL_SENSITIVE:
1255 os << "\tLabelType Sensitive\n";
1258 os << "\tLabelType Static\n";
1261 switch (endlabeltype) {
1263 os << "\tEndLabelType Box\n";
1265 case END_LABEL_FILLED_BOX:
1266 os << "\tEndLabelType Filled_Box\n";
1268 case END_LABEL_NO_LABEL:
1269 os << "\tEndLabelType No_Label\n";
1271 case END_LABEL_STATIC:
1272 os << "\tEndLabelType Static\n";
1275 os << "\tParagraphGroup \"" << par_group_ << "\"\n";
1276 if (!leftmargin.empty())
1277 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1278 if (!rightmargin.empty())
1279 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1280 if (!labelindent.empty())
1281 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1282 if (!parindent.empty())
1283 os << "\tParIndent " << to_utf8(parindent) << '\n';
1284 os << "\tParSkip " << parskip << "\n"
1285 "\tItemSep " << itemsep << "\n"
1286 "\tTopSep " << topsep << "\n"
1287 "\tBottomSep " << bottomsep << "\n"
1288 "\tLabelBottomSep " << labelbottomsep << '\n';
1289 if (!labelsep.empty())
1290 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1292 os << "\tParSep " << parsep << "\n"
1293 "\tNewLine " << newline_allowed << '\n';
1295 case LYX_ALIGN_BLOCK:
1296 os << "\tAlign Block\n";
1298 case LYX_ALIGN_CENTER:
1299 os << "\tAlign Center\n";
1301 case LYX_ALIGN_LAYOUT:
1302 os << "\tAlign Layout\n";
1304 case LYX_ALIGN_LEFT:
1305 os << "\tAlign Left\n";
1307 case LYX_ALIGN_RIGHT:
1308 os << "\tAlign Right\n";
1310 case LYX_ALIGN_DECIMAL:
1311 case LYX_ALIGN_SPECIAL:
1312 case LYX_ALIGN_NONE:
1315 if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1316 LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1318 os << "\tAlignPossible";
1319 if (alignpossible & LYX_ALIGN_BLOCK) {
1323 if (alignpossible & LYX_ALIGN_CENTER) {
1329 if (alignpossible & LYX_ALIGN_LAYOUT) {
1335 if (alignpossible & LYX_ALIGN_LEFT) {
1341 if (alignpossible & LYX_ALIGN_RIGHT) {
1349 // LabelString must come before LabelStringAppendix
1350 if (!labelstring_.empty())
1351 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1352 if (!endlabelstring_.empty())
1353 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1354 if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1355 os << "\tLabelStringAppendix \""
1356 << to_utf8(labelstring_appendix_) << "\"\n";
1357 if (!counter.empty())
1358 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1359 os << "\tFreeSpacing " << free_spacing << '\n';
1360 os << "\tPassThru " << pass_thru << '\n';
1361 if (!pass_thru_chars.empty())
1362 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1363 os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1364 switch (spacing.getSpace()) {
1365 case Spacing::Double:
1366 os << "\tSpacing Double\n";
1368 case Spacing::Onehalf:
1369 os << "\tSpacing Onehalf\n";
1371 case Spacing::Other:
1372 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1374 case Spacing::Single:
1375 os << "\tSpacing Single\n";
1377 case Spacing::Default:
1380 if (!requires_.empty()) {
1381 os << "\tRequires ";
1382 for (set<string>::const_iterator it = requires_.begin();
1383 it != requires_.end(); ++it) {
1384 if (it != requires_.begin())
1390 if (refprefix.empty())
1391 os << "\tRefPrefix OFF\n";
1393 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1394 if (!htmltag_.empty())
1395 os << "\tHTMLTag " << htmltag_ << '\n';
1396 if (!htmlattr_.empty())
1397 os << "\tHTMLAttr " << htmlattr_ << '\n';
1398 if (!htmlitemtag_.empty())
1399 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1400 if (!htmlitemattr_.empty())
1401 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1402 if (!htmllabeltag_.empty())
1403 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1404 if (!htmllabelattr_.empty())
1405 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1406 os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1407 if (!htmlstyle_.empty())
1408 os << "\tHTMLStyle\n"
1409 << to_utf8(rtrim(htmlstyle_, "\n"))
1410 << "\n\tEndHTMLStyle\n";
1411 os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1412 if (!htmlpreamble_.empty())
1413 os << "\tHTMLPreamble\n"
1414 << to_utf8(rtrim(htmlpreamble_, "\n"))
1415 << "\n\tEndPreamble\n";
1416 os << "\tHTMLTitle " << htmltitle_ << "\n"
1417 "\tSpellcheck " << spellcheck << "\n"
1418 "\tForceLocal " << forcelocal << "\n"
1423 bool Layout::hasArgs() const
1425 return !latexargs_.empty() || !postcommandargs_.empty() ||
1430 Layout::LaTeXArgMap Layout::args() const
1432 LaTeXArgMap args = latexargs_;
1433 if (!postcommandargs_.empty())
1434 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1435 if (!itemargs_.empty())
1436 args.insert(itemargs_.begin(), itemargs_.end());
1441 int Layout::optArgs() const
1444 LaTeXArgMap::const_iterator it = latexargs_.begin();
1445 for (; it != latexargs_.end(); ++it) {
1446 if (!(*it).second.mandatory)
1449 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1450 for (; iit != postcommandargs_.end(); ++iit) {
1451 if (!(*iit).second.mandatory)
1458 int Layout::requiredArgs() const
1461 LaTeXArgMap::const_iterator it = latexargs_.begin();
1462 for (; it != latexargs_.end(); ++it) {
1463 if ((*it).second.mandatory)
1466 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1467 for (; iit != postcommandargs_.end(); ++iit) {
1468 if (!(*iit).second.mandatory)
1475 string const & Layout::htmltag() const
1477 if (htmltag_.empty())
1483 string const & Layout::htmlattr() const
1485 if (htmlattr_.empty())
1486 htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
1491 string const & Layout::htmlitemtag() const
1493 if (htmlitemtag_.empty())
1494 htmlitemtag_ = "div";
1495 return htmlitemtag_;
1499 string const & Layout::htmlitemattr() const
1501 if (htmlitemattr_.empty())
1502 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1503 return htmlitemattr_;
1507 string const & Layout::htmllabeltag() const
1509 if (htmllabeltag_.empty()) {
1510 if (labeltype != LABEL_ABOVE &&
1511 labeltype != LABEL_CENTERED)
1512 htmllabeltag_ = "span";
1514 htmllabeltag_ = "div";
1516 return htmllabeltag_;
1520 string const & Layout::htmllabelattr() const
1522 if (htmllabelattr_.empty())
1523 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1524 return htmllabelattr_;
1528 docstring Layout::htmlstyle() const
1530 if (!htmlstyle_.empty() && !htmlforcecss_)
1532 if (htmldefaultstyle_.empty())
1534 docstring retval = htmldefaultstyle_;
1535 if (!htmlstyle_.empty())
1536 retval += '\n' + htmlstyle_;
1541 string Layout::defaultCSSClass() const
1543 if (!defaultcssclass_.empty())
1544 return defaultcssclass_;
1546 docstring::const_iterator it = name().begin();
1547 docstring::const_iterator en = name().end();
1548 for (; it != en; ++it) {
1549 char_type const c = *it;
1550 if (!isAlphaASCII(c)) {
1552 // make sure we don't start with an underscore,
1553 // as that sometimes causes problems.
1554 d = from_ascii("lyx_");
1557 } else if (isLower(c))
1560 // this is slow, so do it only if necessary
1563 defaultcssclass_ = to_utf8(d);
1564 return defaultcssclass_;
1570 string makeMarginValue(char const * side, double d)
1573 os << "margin-" << side << ": " << d << "ex;\n";
1580 void Layout::makeDefaultCSS() const
1582 // this never needs to be redone, since reloading layouts will
1583 // wipe out what we did before.
1584 if (!htmldefaultstyle_.empty())
1588 htmldefaultstyle_ = font.asCSS();
1593 tmp += makeMarginValue("top", topsep);
1595 tmp += makeMarginValue("bottom", bottomsep);
1596 if (!leftmargin.empty()) {
1597 // we can't really do what LyX does with the margin, so
1598 // we'll just figure out how many characters it is
1599 int const len = leftmargin.length();
1600 tmp += makeMarginValue("left", len);
1602 if (!rightmargin.empty()) {
1603 int const len = rightmargin.length();
1604 tmp += makeMarginValue("right", len);
1608 if (!htmldefaultstyle_.empty())
1609 htmldefaultstyle_ += from_ascii("\n");
1610 htmldefaultstyle_ += from_ascii(tmp);
1614 string where = alignmentToCSS(align);
1615 if (!where.empty()) {
1616 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
1619 // wrap up what we have, if anything
1620 if (!htmldefaultstyle_.empty())
1622 from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
1623 htmldefaultstyle_ + from_ascii("\n}\n");
1625 if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
1631 if (labelfont != font)
1632 labelCSS = labelfont.asCSS() + from_ascii("\n");
1633 if (labeltype == LABEL_CENTERED)
1634 labelCSS += from_ascii("text-align: center;\n");
1636 if (!labelCSS.empty())
1637 htmldefaultstyle_ +=
1638 from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
1639 labelCSS + from_ascii("\n}\n");
1643 bool Layout::operator==(Layout const & rhs) const
1645 // This is enough for the applications we actually make,
1646 // at least at the moment. But we could check more.
1647 return name() == rhs.name()
1648 && latexname() == rhs.latexname()
1649 && latextype == rhs.latextype;