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,
110 LT_INTITLE // keep this last!
113 /////////////////////
118 margintype = MARGIN_STATIC;
119 latextype = LATEX_PARAGRAPH;
125 labelfont = inherit_font;
127 reslabelfont = sane_font;
128 nextnoindent = false;
133 labelbottomsep = 0.0;
135 align = LYX_ALIGN_BLOCK;
136 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
137 labeltype = LABEL_NO_LABEL;
138 endlabeltype = END_LABEL_NO_LABEL;
139 // Should or should not. That is the question.
140 // spacing.set(Spacing::OneHalf);
141 newline_allowed = true;
142 free_spacing = false;
144 parbreak_is_newline = false;
145 toclevel = NOT_IN_TOC;
147 htmllabelfirst_ = false;
148 htmlforcecss_ = false;
152 itemcommand_ = "item";
153 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
157 bool Layout::read(Lexer & lex, TextClass const & tclass)
159 // If this is an empty layout, or if no force local version is set,
160 // we know that we will not discard the stuff to read
162 return readIgnoreForcelocal(lex, tclass);
165 bool const ret = tmp.readIgnoreForcelocal(lex, tclass);
167 // - the read version is higher
168 // - both versions are infinity (arbitrary decision)
169 // - the file did not contain any local version (needed for not
170 // skipping user defined local layouts)
171 if (tmp.forcelocal <= 0 || tmp.forcelocal > forcelocal)
177 bool Layout::readIgnoreForcelocal(Lexer & lex, TextClass const & tclass)
179 // This table is sorted alphabetically [asierra 30March96]
180 LexerKeyword layoutTags[] = {
181 { "align", LT_ALIGN },
182 { "alignpossible", LT_ALIGNPOSSIBLE },
183 { "argument", LT_ARGUMENT },
184 { "babelpreamble", LT_BABELPREAMBLE },
185 { "bottomsep", LT_BOTTOMSEP },
186 { "category", LT_CATEGORY },
187 { "commanddepth", LT_COMMANDDEPTH },
188 { "copystyle", LT_COPYSTYLE },
189 { "dependson", LT_DEPENDSON },
191 { "endlabelstring", LT_ENDLABELSTRING },
192 { "endlabeltype", LT_ENDLABELTYPE },
194 { "forcelocal", LT_FORCELOCAL },
195 { "freespacing", LT_FREE_SPACING },
196 { "htmlattr", LT_HTMLATTR },
197 { "htmlforcecss", LT_HTMLFORCECSS },
198 { "htmlitem", LT_HTMLITEM },
199 { "htmlitemattr", LT_HTMLITEMATTR },
200 { "htmllabel", LT_HTMLLABEL },
201 { "htmllabelattr", LT_HTMLLABELATTR },
202 { "htmllabelfirst", LT_HTMLLABELFIRST },
203 { "htmlpreamble", LT_HTMLPREAMBLE },
204 { "htmlstyle", LT_HTMLSTYLE },
205 { "htmltag", LT_HTMLTAG },
206 { "htmltitle", LT_HTMLTITLE },
207 { "innertag", LT_INNERTAG },
208 { "inpreamble", LT_INPREAMBLE },
209 { "intitle", LT_INTITLE },
210 { "itemcommand", LT_ITEMCOMMAND },
211 { "itemsep", LT_ITEMSEP },
212 { "itemtag", LT_ITEMTAG },
213 { "keepempty", LT_KEEPEMPTY },
214 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
215 { "labelcounter", LT_LABELCOUNTER },
216 { "labelfont", LT_LABELFONT },
217 { "labelindent", LT_LABELINDENT },
218 { "labelsep", LT_LABELSEP },
219 { "labelstring", LT_LABELSTRING },
220 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
221 { "labeltag", LT_LABELTAG },
222 { "labeltype", LT_LABELTYPE },
223 { "langpreamble", LT_LANGPREAMBLE },
224 { "latexname", LT_LATEXNAME },
225 { "latexparam", LT_LATEXPARAM },
226 { "latextype", LT_LATEXTYPE },
227 { "leftdelim", LT_LEFTDELIM },
228 { "leftmargin", LT_LEFTMARGIN },
229 { "margin", LT_MARGIN },
230 { "needprotect", LT_NEED_PROTECT },
231 { "newline", LT_NEWLINE },
232 { "nextnoindent", LT_NEXTNOINDENT },
233 { "obsoletedby", LT_OBSOLETEDBY },
234 { "parbreakisnewline", LT_PARBREAK_IS_NEWLINE },
235 { "parindent", LT_PARINDENT },
236 { "parsep", LT_PARSEP },
237 { "parskip", LT_PARSKIP },
238 { "passthru", LT_PASS_THRU },
239 { "passthruchars", LT_PASS_THRU_CHARS },
240 { "preamble", LT_PREAMBLE },
241 { "refprefix", LT_REFPREFIX },
242 { "requires", LT_REQUIRES },
243 { "resetargs", LT_RESETARGS },
244 { "rightdelim", LT_RIGHTDELIM },
245 { "rightmargin", LT_RIGHTMARGIN },
246 { "spacing", LT_SPACING },
247 { "spellcheck", LT_SPELLCHECK },
248 { "textfont", LT_TEXTFONT },
249 { "toclevel", LT_TOCLEVEL },
250 { "toggleindent", LT_TOGGLE_INDENT },
251 { "topsep", LT_TOPSEP }
255 bool finished = false;
256 lex.pushTable(layoutTags);
258 // parse style section
259 while (!finished && lex.isOK() && !error) {
261 // See comment in LyXRC.cpp.
263 case Lexer::LEX_FEOF:
266 case Lexer::LEX_UNDEF:
268 lex.printError("Unknown layout tag `$$Token'");
275 switch (static_cast<LayoutTags>(le)) {
287 style = subst(style, '_', ' ');
289 if (tclass.hasLayout(style)) {
290 docstring const tmpname = name_;
291 this->operator=(tclass[style]);
294 LYXERR0("Cannot copy unknown style `"
296 << "All layouts so far:");
297 DocumentClass::const_iterator lit = tclass.begin();
298 DocumentClass::const_iterator len = tclass.end();
299 for (; lit != len; ++lit)
300 LYXERR0(lit->name());
305 case LT_OBSOLETEDBY: {
308 style = subst(style, '_', ' ');
310 if (tclass.hasLayout(style)) {
311 docstring const tmpname = name_;
312 this->operator=(tclass[style]);
314 if (obsoleted_by().empty())
315 obsoleted_by_ = style;
317 LYXERR0("Cannot replace with unknown style `"
320 //lex.printError("Cannot replace with"
329 depends_on_ = subst(depends_on_, '_', ' ');
358 postcommandargs_.clear();
366 case LT_NEED_PROTECT:
375 font = lyxRead(lex, font);
380 font = lyxRead(lex, font);
384 labelfont = lyxRead(lex, labelfont);
387 case LT_NEXTNOINDENT:
391 case LT_TOGGLE_INDENT: {
394 tog = support::ascii_lowercase(tog);
396 toggle_indent = ITOGGLE_ALWAYS;
397 else if (tog == "never")
398 toggle_indent = ITOGGLE_NEVER;
400 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
404 case LT_COMMANDDEPTH:
414 latexparam_ = subst(latexparam_, """, "\"");
419 leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
425 rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
446 preamble_ = from_utf8(lex.getLongString("EndPreamble"));
449 case LT_LANGPREAMBLE:
450 langpreamble_ = from_utf8(lex.getLongString("EndLangPreamble"));
453 case LT_BABELPREAMBLE:
454 babelpreamble_ = from_utf8(lex.getLongString("EndBabelPreamble"));
461 case LT_ENDLABELTYPE:
462 readEndLabelType(lex);
497 case LT_LABEL_BOTTOMSEP:
498 lex >> labelbottomsep;
503 labelsep = subst(labelsep, 'x', ' ');
511 lex >> newline_allowed;
518 case LT_ALIGNPOSSIBLE:
519 readAlignPossible(lex);
523 // FIXME: this means LT_LABELSTRING_APPENDIX may only
524 // occur after LT_LABELSTRING
526 labelstring_ = trim(labelstring_);
527 labelstring_appendix_ = labelstring_;
530 case LT_ENDLABELSTRING:
531 lex >> endlabelstring_;
532 endlabelstring_ = trim(endlabelstring_);
535 case LT_LABELSTRING_APPENDIX:
536 lex >> labelstring_appendix_;
537 labelstring_appendix_ = trim(labelstring_appendix_);
540 case LT_LABELCOUNTER:
542 counter = trim(counter);
545 case LT_FREE_SPACING:
553 case LT_PASS_THRU_CHARS:
554 lex >> pass_thru_chars;
557 case LT_PARBREAK_IS_NEWLINE:
558 lex >> parbreak_is_newline;
567 vector<string> const req =
568 getVectorFromString(lex.getString());
569 requires_.insert(req.begin(), req.end());
595 case LT_HTMLITEMATTR:
596 lex >> htmlitemattr_;
600 lex >> htmllabeltag_;
603 case LT_HTMLLABELATTR:
604 lex >> htmllabelattr_;
607 case LT_HTMLLABELFIRST:
608 lex >> htmllabelfirst_;
612 htmlstyle_ = from_utf8(lex.getLongString("EndHTMLStyle"));
615 case LT_HTMLFORCECSS:
616 lex >> htmlforcecss_;
619 case LT_HTMLPREAMBLE:
620 htmlpreamble_ = from_utf8(lex.getLongString("EndPreamble"));
637 // make sure we only have inpreamble = true for commands
638 if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
639 LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
640 LYXERR0("Layout name: " << name());
644 return finished && !error;
657 LexerKeyword alignTags[] = {
658 { "block", AT_BLOCK },
659 { "center", AT_CENTER },
660 { "layout", AT_LAYOUT },
662 { "right", AT_RIGHT }
666 void Layout::readAlign(Lexer & lex)
668 PushPopHelper pph(lex, alignTags);
671 case Lexer::LEX_UNDEF:
672 lex.printError("Unknown alignment `$$Token'");
678 align = LYX_ALIGN_BLOCK;
681 align = LYX_ALIGN_LEFT;
684 align = LYX_ALIGN_RIGHT;
687 align = LYX_ALIGN_CENTER;
690 align = LYX_ALIGN_LAYOUT;
696 void Layout::readAlignPossible(Lexer & lex)
698 lex.pushTable(alignTags);
699 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
700 int lineno = lex.lineNumber();
704 case Lexer::LEX_UNDEF:
705 lex.printError("Unknown alignment `$$Token'");
711 alignpossible |= LYX_ALIGN_BLOCK;
714 alignpossible |= LYX_ALIGN_LEFT;
717 alignpossible |= LYX_ALIGN_RIGHT;
720 alignpossible |= LYX_ALIGN_CENTER;
723 alignpossible |= LYX_ALIGN_LAYOUT;
726 } while (lineno == lex.lineNumber());
731 void Layout::readLabelType(Lexer & lex)
746 LexerKeyword labelTypeTags[] = {
747 { "above", LA_ABOVE },
748 { "bibliography", LA_BIBLIO },
749 { "centered", LA_CENTERED },
750 { "enumerate", LA_ENUMERATE },
751 { "itemize", LA_ITEMIZE },
752 { "manual", LA_MANUAL },
753 { "no_label", LA_NO_LABEL },
754 { "sensitive", LA_SENSITIVE },
755 { "static", LA_STATIC }
758 PushPopHelper pph(lex, labelTypeTags);
761 case Lexer::LEX_UNDEF:
762 lex.printError("Unknown labeltype tag `$$Token'");
768 labeltype = LABEL_NO_LABEL;
771 labeltype = LABEL_MANUAL;
774 labeltype = LABEL_ABOVE;
777 labeltype = LABEL_CENTERED;
780 labeltype = LABEL_STATIC;
783 labeltype = LABEL_SENSITIVE;
786 labeltype = LABEL_ENUMERATE;
789 labeltype = LABEL_ITEMIZE;
792 labeltype = LABEL_BIBLIO;
798 void Layout::readEndLabelType(Lexer & lex)
800 // this should be const, but can't be because
802 static LexerKeyword endlabelTypeTags[] = {
803 { "box", END_LABEL_BOX },
804 { "filled_box", END_LABEL_FILLED_BOX },
805 { "no_label", END_LABEL_NO_LABEL },
806 { "static", END_LABEL_STATIC }
809 PushPopHelper pph(lex, endlabelTypeTags);
812 case Lexer::LEX_UNDEF:
813 lex.printError("Unknown labeltype tag `$$Token'");
815 case END_LABEL_STATIC:
817 case END_LABEL_FILLED_BOX:
818 case END_LABEL_NO_LABEL:
819 endlabeltype = static_cast<EndLabelType>(le);
822 LYXERR0("Unhandled value " << le);
828 void Layout::readMargin(Lexer & lex)
830 LexerKeyword marginTags[] = {
831 { "dynamic", MARGIN_DYNAMIC },
832 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
833 { "manual", MARGIN_MANUAL },
834 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
835 { "static", MARGIN_STATIC }
838 PushPopHelper pph(lex, marginTags);
842 case Lexer::LEX_UNDEF:
843 lex.printError("Unknown margin type tag `$$Token'");
848 case MARGIN_FIRST_DYNAMIC:
849 case MARGIN_RIGHT_ADDRESS_BOX:
850 margintype = static_cast<MarginType>(le);
853 LYXERR0("Unhandled value " << le);
859 void Layout::readLatexType(Lexer & lex)
861 LexerKeyword latexTypeTags[] = {
862 { "bib_environment", LATEX_BIB_ENVIRONMENT },
863 { "command", LATEX_COMMAND },
864 { "environment", LATEX_ENVIRONMENT },
865 { "item_environment", LATEX_ITEM_ENVIRONMENT },
866 { "list_environment", LATEX_LIST_ENVIRONMENT },
867 { "paragraph", LATEX_PARAGRAPH }
870 PushPopHelper pph(lex, latexTypeTags);
873 case Lexer::LEX_UNDEF:
874 lex.printError("Unknown latextype tag `$$Token'");
876 case LATEX_PARAGRAPH:
878 case LATEX_ENVIRONMENT:
879 case LATEX_ITEM_ENVIRONMENT:
880 case LATEX_BIB_ENVIRONMENT:
881 case LATEX_LIST_ENVIRONMENT:
882 latextype = static_cast<LatexType>(le);
885 LYXERR0("Unhandled value " << le);
891 void Layout::readSpacing(Lexer & lex)
894 ST_SPACING_SINGLE = 1,
900 LexerKeyword spacingTags[] = {
901 {"double", ST_SPACING_DOUBLE },
902 {"onehalf", ST_SPACING_ONEHALF },
903 {"other", ST_OTHER },
904 {"single", ST_SPACING_SINGLE }
907 PushPopHelper pph(lex, spacingTags);
910 case Lexer::LEX_UNDEF:
911 lex.printError("Unknown spacing token `$$Token'");
916 case ST_SPACING_SINGLE:
917 spacing.set(Spacing::Single);
919 case ST_SPACING_ONEHALF:
920 spacing.set(Spacing::Onehalf);
922 case ST_SPACING_DOUBLE:
923 spacing.set(Spacing::Double);
927 spacing.set(Spacing::Other, lex.getString());
933 void Layout::readArgument(Lexer & lex)
936 // writeArgument() makes use of these default values
937 arg.mandatory = false;
938 arg.autoinsert = false;
940 bool finished = false;
941 arg.font = inherit_font;
942 arg.labelfont = inherit_font;
945 bool const itemarg = prefixIs(id, "item:");
946 bool const postcmd = prefixIs(id, "post:");
948 while (!finished && lex.isOK() && !error) {
950 string const tok = ascii_lowercase(lex.getString());
954 } else if (tok == "endargument") {
956 } else if (tok == "labelstring") {
958 arg.labelstring = lex.getDocString();
959 } else if (tok == "menustring") {
961 arg.menustring = lex.getDocString();
962 } else if (tok == "mandatory") {
964 arg.mandatory = lex.getBool();
965 } else if (tok == "autoinsert") {
967 arg.autoinsert = lex.getBool();
968 } else if (tok == "leftdelim") {
970 arg.ldelim = lex.getDocString();
971 arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
973 } else if (tok == "rightdelim") {
975 arg.rdelim = lex.getDocString();
976 arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
978 } else if (tok == "defaultarg") {
980 arg.defaultarg = lex.getDocString();
981 } else if (tok == "presetarg") {
983 arg.presetarg = lex.getDocString();
984 } else if (tok == "tooltip") {
986 arg.tooltip = lex.getDocString();
987 } else if (tok == "requires") {
989 arg.requires = lex.getString();
990 } else if (tok == "decoration") {
992 arg.decoration = lex.getString();
993 } else if (tok == "font") {
994 arg.font = lyxRead(lex, arg.font);
995 } else if (tok == "labelfont") {
996 arg.labelfont = lyxRead(lex, arg.labelfont);
997 } else if (tok == "passthruchars") {
999 arg.pass_thru_chars = lex.getDocString();
1001 lex.printError("Unknown tag");
1005 if (arg.labelstring.empty())
1006 LYXERR0("Incomplete Argument definition!");
1008 itemargs_[id] = arg;
1010 postcommandargs_[id] = arg;
1012 latexargs_[id] = arg;
1016 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1018 os << "\tArgument " << id << '\n';
1019 if (!arg.labelstring.empty())
1020 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1021 if (!arg.menustring.empty())
1022 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1024 os << "\t\tMandatory " << arg.mandatory << '\n';
1026 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1027 if (!arg.ldelim.empty())
1028 os << "\t\tLeftDelim \""
1029 << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1031 if (!arg.rdelim.empty())
1032 os << "\t\tRightDelim \""
1033 << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1035 if (!arg.defaultarg.empty())
1036 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1037 if (!arg.presetarg.empty())
1038 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1039 if (!arg.tooltip.empty())
1040 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1041 if (!arg.requires.empty())
1042 os << "\t\tRequires \"" << arg.requires << "\"\n";
1043 if (!arg.decoration.empty())
1044 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1045 if (arg.font != inherit_font)
1046 lyxWrite(os, arg.font, "Font", 2);
1047 if (arg.labelfont != inherit_font)
1048 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1049 if (!arg.pass_thru_chars.empty())
1050 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1051 os << "\tEndArgument\n";
1055 void Layout::write(ostream & os) const
1057 os << "Style " << to_utf8(name_) << '\n';
1058 if (!category_.empty() && obsoleted_by_.empty())
1059 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1060 // Can't deduce Copystyle here :-(
1061 if (!obsoleted_by_.empty()) {
1062 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1066 if (!depends_on_.empty())
1067 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1068 switch (margintype) {
1069 case MARGIN_DYNAMIC:
1070 os << "\tMargin Dynamic\n";
1072 case MARGIN_FIRST_DYNAMIC:
1073 os << "\tMargin First_Dynamic\n";
1076 os << "\tMargin Manual\n";
1078 case MARGIN_RIGHT_ADDRESS_BOX:
1079 os << "\tMargin Right_Address_Box\n";
1082 os << "\tMargin Static\n";
1085 switch (latextype) {
1086 case LATEX_BIB_ENVIRONMENT:
1087 os << "\tLatexType Bib_Environment\n";
1090 os << "\tLatexType Command\n";
1092 case LATEX_ENVIRONMENT:
1093 os << "\tLatexType Environment\n";
1095 case LATEX_ITEM_ENVIRONMENT:
1096 os << "\tLatexType Item_Environment\n";
1098 case LATEX_LIST_ENVIRONMENT:
1099 os << "\tLatexType List_Environment\n";
1101 case LATEX_PARAGRAPH:
1102 os << "\tLatexType Paragraph\n";
1105 os << "\tInTitle " << intitle << "\n"
1106 "\tInPreamble " << inpreamble << "\n"
1107 "\tTocLevel " << toclevel << '\n';
1108 // ResetArgs does not make sense here
1109 for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1110 it != latexargs_.end(); ++it)
1111 writeArgument(os, it->first, it->second);
1112 for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1113 it != itemargs_.end(); ++it)
1114 writeArgument(os, it->first, it->second);
1115 for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1116 it != postcommandargs_.end(); ++it)
1117 writeArgument(os, it->first, it->second);
1118 os << "\tNeedProtect " << needprotect << "\n"
1119 "\tKeepEmpty " << keepempty << '\n';
1120 if (labelfont == font)
1121 lyxWrite(os, font, "Font", 1);
1123 lyxWrite(os, font, "TextFont", 1);
1124 lyxWrite(os, labelfont, "LabelFont", 1);
1126 os << "\tNextNoIndent " << nextnoindent << "\n"
1127 "\tCommandDepth " << commanddepth << '\n';
1128 if (!latexname_.empty())
1129 os << "\tLatexName \"" << latexname_ << "\"\n";
1130 if (!latexparam_.empty())
1131 os << "\tLatexParam \"" << subst(latexparam_, "\"", """)
1133 if (!leftdelim_.empty())
1134 os << "\tLeftDelim "
1135 << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1137 if (!rightdelim_.empty())
1138 os << "\tRightDelim "
1139 << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1141 if (!innertag_.empty())
1142 os << "\tInnerTag \"" << innertag_ << "\"\n";
1143 if (!labeltag_.empty())
1144 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1145 if (!itemtag_.empty())
1146 os << "\tItemTag \"" << itemtag_ << "\"\n";
1147 if (!itemcommand_.empty())
1148 os << "\tItemCommand " << itemcommand_ << '\n';
1149 if (!preamble_.empty())
1150 os << "\tPreamble\n\t"
1151 << to_utf8(subst(rtrim(preamble_, "\n"),
1152 from_ascii("\n"), from_ascii("\n\t")))
1153 << "\n\tEndPreamble\n";
1154 if (!langpreamble_.empty())
1155 os << "\tLangPreamble\n\t"
1156 << to_utf8(subst(rtrim(langpreamble_, "\n"),
1157 from_ascii("\n"), from_ascii("\n\t")))
1158 << "\n\tEndLangPreamble\n";
1159 if (!babelpreamble_.empty())
1160 os << "\tBabelPreamble\n\t"
1161 << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1162 from_ascii("\n"), from_ascii("\n\t")))
1163 << "\n\tEndBabelPreamble\n";
1164 switch (labeltype) {
1166 os << "\tLabelType Above\n";
1169 os << "\tLabelType Bibliography\n";
1171 case LABEL_CENTERED:
1172 os << "\tLabelType Centered\n";
1174 case LABEL_ENUMERATE:
1175 os << "\tLabelType Enumerate\n";
1178 os << "\tLabelType Itemize\n";
1181 os << "\tLabelType Manual\n";
1183 case LABEL_NO_LABEL:
1184 os << "\tLabelType No_Label\n";
1186 case LABEL_SENSITIVE:
1187 os << "\tLabelType Sensitive\n";
1190 os << "\tLabelType Static\n";
1193 switch (endlabeltype) {
1195 os << "\tEndLabelType Box\n";
1197 case END_LABEL_FILLED_BOX:
1198 os << "\tEndLabelType Filled_Box\n";
1200 case END_LABEL_NO_LABEL:
1201 os << "\tEndLabelType No_Label\n";
1203 case END_LABEL_STATIC:
1204 os << "\tEndLabelType Static\n";
1207 if (!leftmargin.empty())
1208 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1209 if (!rightmargin.empty())
1210 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1211 if (!labelindent.empty())
1212 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1213 if (!parindent.empty())
1214 os << "\tParIndent " << to_utf8(parindent) << '\n';
1215 os << "\tParSkip " << parskip << "\n"
1216 "\tItemSep " << itemsep << "\n"
1217 "\tTopSep " << topsep << "\n"
1218 "\tBottomSep " << bottomsep << "\n"
1219 "\tLabelBottomSep " << labelbottomsep << '\n';
1220 if (!labelsep.empty())
1221 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1223 os << "\tParSep " << parsep << "\n"
1224 "\tNewLine " << newline_allowed << '\n';
1226 case LYX_ALIGN_BLOCK:
1227 os << "\tAlign Block\n";
1229 case LYX_ALIGN_CENTER:
1230 os << "\tAlign Center\n";
1232 case LYX_ALIGN_LAYOUT:
1233 os << "\tAlign Layout\n";
1235 case LYX_ALIGN_LEFT:
1236 os << "\tAlign Left\n";
1238 case LYX_ALIGN_RIGHT:
1239 os << "\tAlign Right\n";
1241 case LYX_ALIGN_DECIMAL:
1242 case LYX_ALIGN_SPECIAL:
1243 case LYX_ALIGN_NONE:
1246 if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1247 LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1249 os << "\tAlignPossible";
1250 if (alignpossible & LYX_ALIGN_BLOCK) {
1256 if (alignpossible & LYX_ALIGN_CENTER) {
1262 if (alignpossible & LYX_ALIGN_LAYOUT) {
1268 if (alignpossible & LYX_ALIGN_LEFT) {
1274 if (alignpossible & LYX_ALIGN_RIGHT) {
1282 // LabelString must come before LabelStringAppendix
1283 if (!labelstring_.empty())
1284 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1285 if (!endlabelstring_.empty())
1286 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1287 if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1288 os << "\tLabelStringAppendix \""
1289 << to_utf8(labelstring_appendix_) << "\"\n";
1290 if (!counter.empty())
1291 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1292 os << "\tFreeSpacing " << free_spacing << '\n';
1293 os << "\tPassThru " << pass_thru << '\n';
1294 if (!pass_thru_chars.empty())
1295 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1296 os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1297 switch (spacing.getSpace()) {
1298 case Spacing::Double:
1299 os << "\tSpacing Double\n";
1301 case Spacing::Onehalf:
1302 os << "\tSpacing Onehalf\n";
1304 case Spacing::Other:
1305 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1307 case Spacing::Single:
1308 os << "\tSpacing Single\n";
1310 case Spacing::Default:
1313 if (!requires_.empty()) {
1314 os << "\tRequires ";
1315 for (set<string>::const_iterator it = requires_.begin();
1316 it != requires_.end(); ++it) {
1317 if (it != requires_.begin())
1323 if (refprefix.empty())
1324 os << "\tRefPrefix OFF\n";
1326 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1327 if (!htmltag_.empty())
1328 os << "\tHTMLTag " << htmltag_ << '\n';
1329 if (!htmlattr_.empty())
1330 os << "\tHTMLAttr " << htmlattr_ << '\n';
1331 if (!htmlitemtag_.empty())
1332 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1333 if (!htmlitemattr_.empty())
1334 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1335 if (!htmllabeltag_.empty())
1336 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1337 if (!htmllabelattr_.empty())
1338 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1339 os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1340 if (!htmlstyle_.empty())
1341 os << "\tHTMLStyle\n"
1342 << to_utf8(rtrim(htmlstyle_, "\n"))
1343 << "\n\tEndHTMLStyle\n";
1344 os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1345 if (!htmlpreamble_.empty())
1346 os << "\tHTMLPreamble\n"
1347 << to_utf8(rtrim(htmlpreamble_, "\n"))
1348 << "\n\tEndPreamble\n";
1349 os << "\tHTMLTitle " << htmltitle_ << "\n"
1350 "\tSpellcheck " << spellcheck << "\n"
1351 "\tForceLocal " << forcelocal << "\n"
1356 Layout::LaTeXArgMap Layout::args() const
1358 LaTeXArgMap args = latexargs_;
1359 if (!postcommandargs_.empty())
1360 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1361 if (!itemargs_.empty())
1362 args.insert(itemargs_.begin(), itemargs_.end());
1367 int Layout::optArgs() const
1370 LaTeXArgMap::const_iterator it = latexargs_.begin();
1371 for (; it != latexargs_.end(); ++it) {
1372 if (!(*it).second.mandatory)
1375 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1376 for (; iit != postcommandargs_.end(); ++iit) {
1377 if (!(*iit).second.mandatory)
1384 int Layout::requiredArgs() const
1387 LaTeXArgMap::const_iterator it = latexargs_.begin();
1388 for (; it != latexargs_.end(); ++it) {
1389 if ((*it).second.mandatory)
1392 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1393 for (; iit != postcommandargs_.end(); ++iit) {
1394 if (!(*iit).second.mandatory)
1401 string const & Layout::htmltag() const
1403 if (htmltag_.empty())
1409 string const & Layout::htmlattr() const
1411 if (htmlattr_.empty())
1412 htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
1417 string const & Layout::htmlitemtag() const
1419 if (htmlitemtag_.empty())
1420 htmlitemtag_ = "div";
1421 return htmlitemtag_;
1425 string const & Layout::htmlitemattr() const
1427 if (htmlitemattr_.empty())
1428 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1429 return htmlitemattr_;
1433 string const & Layout::htmllabeltag() const
1435 if (htmllabeltag_.empty()) {
1436 if (labeltype != LABEL_ABOVE &&
1437 labeltype != LABEL_CENTERED)
1438 htmllabeltag_ = "span";
1440 htmllabeltag_ = "div";
1442 return htmllabeltag_;
1446 string const & Layout::htmllabelattr() const
1448 if (htmllabelattr_.empty())
1449 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1450 return htmllabelattr_;
1454 docstring Layout::htmlstyle() const
1456 if (!htmlstyle_.empty() && !htmlforcecss_)
1458 if (htmldefaultstyle_.empty())
1460 docstring retval = htmldefaultstyle_;
1461 if (!htmlstyle_.empty())
1462 retval += '\n' + htmlstyle_;
1467 string Layout::defaultCSSClass() const
1469 if (!defaultcssclass_.empty())
1470 return defaultcssclass_;
1472 docstring::const_iterator it = name().begin();
1473 docstring::const_iterator en = name().end();
1474 for (; it != en; ++it) {
1475 char_type const c = *it;
1476 if (!isAlphaASCII(c)) {
1478 // make sure we don't start with an underscore,
1479 // as that sometimes causes problems.
1480 d = from_ascii("lyx_");
1483 } else if (isLower(c))
1486 // this is slow, so do it only if necessary
1489 defaultcssclass_ = to_utf8(d);
1490 return defaultcssclass_;
1496 string makeMarginValue(char const * side, double d)
1499 os << "margin-" << side << ": " << d << "ex;\n";
1506 void Layout::makeDefaultCSS() const
1508 // this never needs to be redone, since reloading layouts will
1509 // wipe out what we did before.
1510 if (!htmldefaultstyle_.empty())
1514 htmldefaultstyle_ = font.asCSS();
1519 tmp += makeMarginValue("top", topsep);
1521 tmp += makeMarginValue("bottom", bottomsep);
1522 if (!leftmargin.empty()) {
1523 // we can't really do what LyX does with the margin, so
1524 // we'll just figure out how many characters it is
1525 int const len = leftmargin.length();
1526 tmp += makeMarginValue("left", len);
1528 if (!rightmargin.empty()) {
1529 int const len = rightmargin.length();
1530 tmp += makeMarginValue("right", len);
1534 if (!htmldefaultstyle_.empty())
1535 htmldefaultstyle_ += from_ascii("\n");
1536 htmldefaultstyle_ += from_ascii(tmp);
1540 string where = alignmentToCSS(align);
1541 if (!where.empty()) {
1542 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
1545 // wrap up what we have, if anything
1546 if (!htmldefaultstyle_.empty())
1548 from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
1549 htmldefaultstyle_ + from_ascii("\n}\n");
1551 if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
1557 if (labelfont != font)
1558 labelCSS = labelfont.asCSS() + from_ascii("\n");
1559 if (labeltype == LABEL_CENTERED)
1560 labelCSS += from_ascii("text-align: center;\n");
1562 if (!labelCSS.empty())
1563 htmldefaultstyle_ +=
1564 from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
1565 labelCSS + from_ascii("\n}\n");
1569 bool Layout::operator==(Layout const & rhs) const
1571 // This is enough for the applications we actually make,
1572 // at least at the moment. But we could check more.
1573 return name() == rhs.name()
1574 && latexname() == rhs.latexname()
1575 && latextype == rhs.latextype;