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(true));
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;
939 arg.insertcotext = false;
941 bool finished = false;
942 arg.font = inherit_font;
943 arg.labelfont = inherit_font;
946 bool const itemarg = prefixIs(id, "item:");
947 bool const postcmd = prefixIs(id, "post:");
949 while (!finished && lex.isOK() && !error) {
951 string const tok = ascii_lowercase(lex.getString());
955 } else if (tok == "endargument") {
957 } else if (tok == "labelstring") {
959 arg.labelstring = lex.getDocString();
960 } else if (tok == "menustring") {
962 arg.menustring = lex.getDocString();
963 } else if (tok == "mandatory") {
965 arg.mandatory = lex.getBool();
966 } else if (tok == "autoinsert") {
968 arg.autoinsert = lex.getBool();
969 } else if (tok == "insertcotext") {
971 arg.insertcotext = lex.getBool();
972 } else if (tok == "leftdelim") {
974 arg.ldelim = lex.getDocString();
975 arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
977 } else if (tok == "rightdelim") {
979 arg.rdelim = lex.getDocString();
980 arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
982 } else if (tok == "defaultarg") {
984 arg.defaultarg = lex.getDocString();
985 } else if (tok == "presetarg") {
987 arg.presetarg = lex.getDocString();
988 } else if (tok == "tooltip") {
990 arg.tooltip = lex.getDocString();
991 } else if (tok == "requires") {
993 arg.requires = lex.getString();
994 } else if (tok == "decoration") {
996 arg.decoration = lex.getString();
997 } else if (tok == "font") {
998 arg.font = lyxRead(lex, arg.font);
999 } else if (tok == "labelfont") {
1000 arg.labelfont = lyxRead(lex, arg.labelfont);
1001 } else if (tok == "passthruchars") {
1003 arg.pass_thru_chars = lex.getDocString();
1005 lex.printError("Unknown tag");
1009 if (arg.labelstring.empty())
1010 LYXERR0("Incomplete Argument definition!");
1012 itemargs_[id] = arg;
1014 postcommandargs_[id] = arg;
1016 latexargs_[id] = arg;
1020 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1022 os << "\tArgument " << id << '\n';
1023 if (!arg.labelstring.empty())
1024 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1025 if (!arg.menustring.empty())
1026 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1028 os << "\t\tMandatory " << arg.mandatory << '\n';
1030 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1031 if (arg.insertcotext)
1032 os << "\t\tInsertCotext " << arg.insertcotext << '\n';
1033 if (!arg.ldelim.empty())
1034 os << "\t\tLeftDelim \""
1035 << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1037 if (!arg.rdelim.empty())
1038 os << "\t\tRightDelim \""
1039 << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1041 if (!arg.defaultarg.empty())
1042 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1043 if (!arg.presetarg.empty())
1044 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1045 if (!arg.tooltip.empty())
1046 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1047 if (!arg.requires.empty())
1048 os << "\t\tRequires \"" << arg.requires << "\"\n";
1049 if (!arg.decoration.empty())
1050 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1051 if (arg.font != inherit_font)
1052 lyxWrite(os, arg.font, "Font", 2);
1053 if (arg.labelfont != inherit_font)
1054 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1055 if (!arg.pass_thru_chars.empty())
1056 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1057 os << "\tEndArgument\n";
1061 void Layout::write(ostream & os) const
1063 os << "Style " << to_utf8(name_) << '\n';
1064 if (!category_.empty() && obsoleted_by_.empty())
1065 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1066 // Can't deduce Copystyle here :-(
1067 if (!obsoleted_by_.empty()) {
1068 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1072 if (!depends_on_.empty())
1073 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1074 switch (margintype) {
1075 case MARGIN_DYNAMIC:
1076 os << "\tMargin Dynamic\n";
1078 case MARGIN_FIRST_DYNAMIC:
1079 os << "\tMargin First_Dynamic\n";
1082 os << "\tMargin Manual\n";
1084 case MARGIN_RIGHT_ADDRESS_BOX:
1085 os << "\tMargin Right_Address_Box\n";
1088 os << "\tMargin Static\n";
1091 switch (latextype) {
1092 case LATEX_BIB_ENVIRONMENT:
1093 os << "\tLatexType Bib_Environment\n";
1096 os << "\tLatexType Command\n";
1098 case LATEX_ENVIRONMENT:
1099 os << "\tLatexType Environment\n";
1101 case LATEX_ITEM_ENVIRONMENT:
1102 os << "\tLatexType Item_Environment\n";
1104 case LATEX_LIST_ENVIRONMENT:
1105 os << "\tLatexType List_Environment\n";
1107 case LATEX_PARAGRAPH:
1108 os << "\tLatexType Paragraph\n";
1111 os << "\tInTitle " << intitle << "\n"
1112 "\tInPreamble " << inpreamble << "\n"
1113 "\tTocLevel " << toclevel << '\n';
1114 // ResetArgs does not make sense here
1115 for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1116 it != latexargs_.end(); ++it)
1117 writeArgument(os, it->first, it->second);
1118 for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1119 it != itemargs_.end(); ++it)
1120 writeArgument(os, it->first, it->second);
1121 for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1122 it != postcommandargs_.end(); ++it)
1123 writeArgument(os, it->first, it->second);
1124 os << "\tNeedProtect " << needprotect << "\n"
1125 "\tKeepEmpty " << keepempty << '\n';
1126 if (labelfont == font)
1127 lyxWrite(os, font, "Font", 1);
1129 lyxWrite(os, font, "TextFont", 1);
1130 lyxWrite(os, labelfont, "LabelFont", 1);
1132 os << "\tNextNoIndent " << nextnoindent << "\n"
1133 "\tCommandDepth " << commanddepth << '\n';
1134 if (!latexname_.empty())
1135 os << "\tLatexName \"" << latexname_ << "\"\n";
1136 if (!latexparam_.empty())
1137 os << "\tLatexParam \"" << subst(latexparam_, "\"", """)
1139 if (!leftdelim_.empty())
1140 os << "\tLeftDelim "
1141 << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1143 if (!rightdelim_.empty())
1144 os << "\tRightDelim "
1145 << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1147 if (!innertag_.empty())
1148 os << "\tInnerTag \"" << innertag_ << "\"\n";
1149 if (!labeltag_.empty())
1150 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1151 if (!itemtag_.empty())
1152 os << "\tItemTag \"" << itemtag_ << "\"\n";
1153 if (!itemcommand_.empty())
1154 os << "\tItemCommand " << itemcommand_ << '\n';
1155 if (!preamble_.empty())
1156 os << "\tPreamble\n\t"
1157 << to_utf8(subst(rtrim(preamble_, "\n"),
1158 from_ascii("\n"), from_ascii("\n\t")))
1159 << "\n\tEndPreamble\n";
1160 if (!langpreamble_.empty())
1161 os << "\tLangPreamble\n\t"
1162 << to_utf8(subst(rtrim(langpreamble_, "\n"),
1163 from_ascii("\n"), from_ascii("\n\t")))
1164 << "\n\tEndLangPreamble\n";
1165 if (!babelpreamble_.empty())
1166 os << "\tBabelPreamble\n\t"
1167 << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1168 from_ascii("\n"), from_ascii("\n\t")))
1169 << "\n\tEndBabelPreamble\n";
1170 switch (labeltype) {
1172 os << "\tLabelType Above\n";
1175 os << "\tLabelType Bibliography\n";
1177 case LABEL_CENTERED:
1178 os << "\tLabelType Centered\n";
1180 case LABEL_ENUMERATE:
1181 os << "\tLabelType Enumerate\n";
1184 os << "\tLabelType Itemize\n";
1187 os << "\tLabelType Manual\n";
1189 case LABEL_NO_LABEL:
1190 os << "\tLabelType No_Label\n";
1192 case LABEL_SENSITIVE:
1193 os << "\tLabelType Sensitive\n";
1196 os << "\tLabelType Static\n";
1199 switch (endlabeltype) {
1201 os << "\tEndLabelType Box\n";
1203 case END_LABEL_FILLED_BOX:
1204 os << "\tEndLabelType Filled_Box\n";
1206 case END_LABEL_NO_LABEL:
1207 os << "\tEndLabelType No_Label\n";
1209 case END_LABEL_STATIC:
1210 os << "\tEndLabelType Static\n";
1213 if (!leftmargin.empty())
1214 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1215 if (!rightmargin.empty())
1216 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1217 if (!labelindent.empty())
1218 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1219 if (!parindent.empty())
1220 os << "\tParIndent " << to_utf8(parindent) << '\n';
1221 os << "\tParSkip " << parskip << "\n"
1222 "\tItemSep " << itemsep << "\n"
1223 "\tTopSep " << topsep << "\n"
1224 "\tBottomSep " << bottomsep << "\n"
1225 "\tLabelBottomSep " << labelbottomsep << '\n';
1226 if (!labelsep.empty())
1227 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1229 os << "\tParSep " << parsep << "\n"
1230 "\tNewLine " << newline_allowed << '\n';
1232 case LYX_ALIGN_BLOCK:
1233 os << "\tAlign Block\n";
1235 case LYX_ALIGN_CENTER:
1236 os << "\tAlign Center\n";
1238 case LYX_ALIGN_LAYOUT:
1239 os << "\tAlign Layout\n";
1241 case LYX_ALIGN_LEFT:
1242 os << "\tAlign Left\n";
1244 case LYX_ALIGN_RIGHT:
1245 os << "\tAlign Right\n";
1247 case LYX_ALIGN_DECIMAL:
1248 case LYX_ALIGN_SPECIAL:
1249 case LYX_ALIGN_NONE:
1252 if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1253 LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1255 os << "\tAlignPossible";
1256 if (alignpossible & LYX_ALIGN_BLOCK) {
1262 if (alignpossible & LYX_ALIGN_CENTER) {
1268 if (alignpossible & LYX_ALIGN_LAYOUT) {
1274 if (alignpossible & LYX_ALIGN_LEFT) {
1280 if (alignpossible & LYX_ALIGN_RIGHT) {
1288 // LabelString must come before LabelStringAppendix
1289 if (!labelstring_.empty())
1290 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1291 if (!endlabelstring_.empty())
1292 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1293 if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1294 os << "\tLabelStringAppendix \""
1295 << to_utf8(labelstring_appendix_) << "\"\n";
1296 if (!counter.empty())
1297 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1298 os << "\tFreeSpacing " << free_spacing << '\n';
1299 os << "\tPassThru " << pass_thru << '\n';
1300 if (!pass_thru_chars.empty())
1301 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1302 os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1303 switch (spacing.getSpace()) {
1304 case Spacing::Double:
1305 os << "\tSpacing Double\n";
1307 case Spacing::Onehalf:
1308 os << "\tSpacing Onehalf\n";
1310 case Spacing::Other:
1311 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1313 case Spacing::Single:
1314 os << "\tSpacing Single\n";
1316 case Spacing::Default:
1319 if (!requires_.empty()) {
1320 os << "\tRequires ";
1321 for (set<string>::const_iterator it = requires_.begin();
1322 it != requires_.end(); ++it) {
1323 if (it != requires_.begin())
1329 if (refprefix.empty())
1330 os << "\tRefPrefix OFF\n";
1332 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1333 if (!htmltag_.empty())
1334 os << "\tHTMLTag " << htmltag_ << '\n';
1335 if (!htmlattr_.empty())
1336 os << "\tHTMLAttr " << htmlattr_ << '\n';
1337 if (!htmlitemtag_.empty())
1338 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1339 if (!htmlitemattr_.empty())
1340 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1341 if (!htmllabeltag_.empty())
1342 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1343 if (!htmllabelattr_.empty())
1344 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1345 os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1346 if (!htmlstyle_.empty())
1347 os << "\tHTMLStyle\n"
1348 << to_utf8(rtrim(htmlstyle_, "\n"))
1349 << "\n\tEndHTMLStyle\n";
1350 os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1351 if (!htmlpreamble_.empty())
1352 os << "\tHTMLPreamble\n"
1353 << to_utf8(rtrim(htmlpreamble_, "\n"))
1354 << "\n\tEndPreamble\n";
1355 os << "\tHTMLTitle " << htmltitle_ << "\n"
1356 "\tSpellcheck " << spellcheck << "\n"
1357 "\tForceLocal " << forcelocal << "\n"
1362 Layout::LaTeXArgMap Layout::args() const
1364 LaTeXArgMap args = latexargs_;
1365 if (!postcommandargs_.empty())
1366 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1367 if (!itemargs_.empty())
1368 args.insert(itemargs_.begin(), itemargs_.end());
1373 int Layout::optArgs() const
1376 LaTeXArgMap::const_iterator it = latexargs_.begin();
1377 for (; it != latexargs_.end(); ++it) {
1378 if (!(*it).second.mandatory)
1381 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1382 for (; iit != postcommandargs_.end(); ++iit) {
1383 if (!(*iit).second.mandatory)
1390 int Layout::requiredArgs() const
1393 LaTeXArgMap::const_iterator it = latexargs_.begin();
1394 for (; it != latexargs_.end(); ++it) {
1395 if ((*it).second.mandatory)
1398 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1399 for (; iit != postcommandargs_.end(); ++iit) {
1400 if (!(*iit).second.mandatory)
1407 string const & Layout::htmltag() const
1409 if (htmltag_.empty())
1415 string const & Layout::htmlattr() const
1417 if (htmlattr_.empty())
1418 htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
1423 string const & Layout::htmlitemtag() const
1425 if (htmlitemtag_.empty())
1426 htmlitemtag_ = "div";
1427 return htmlitemtag_;
1431 string const & Layout::htmlitemattr() const
1433 if (htmlitemattr_.empty())
1434 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1435 return htmlitemattr_;
1439 string const & Layout::htmllabeltag() const
1441 if (htmllabeltag_.empty()) {
1442 if (labeltype != LABEL_ABOVE &&
1443 labeltype != LABEL_CENTERED)
1444 htmllabeltag_ = "span";
1446 htmllabeltag_ = "div";
1448 return htmllabeltag_;
1452 string const & Layout::htmllabelattr() const
1454 if (htmllabelattr_.empty())
1455 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1456 return htmllabelattr_;
1460 docstring Layout::htmlstyle() const
1462 if (!htmlstyle_.empty() && !htmlforcecss_)
1464 if (htmldefaultstyle_.empty())
1466 docstring retval = htmldefaultstyle_;
1467 if (!htmlstyle_.empty())
1468 retval += '\n' + htmlstyle_;
1473 string Layout::defaultCSSClass() const
1475 if (!defaultcssclass_.empty())
1476 return defaultcssclass_;
1478 docstring::const_iterator it = name().begin();
1479 docstring::const_iterator en = name().end();
1480 for (; it != en; ++it) {
1481 char_type const c = *it;
1482 if (!isAlphaASCII(c)) {
1484 // make sure we don't start with an underscore,
1485 // as that sometimes causes problems.
1486 d = from_ascii("lyx_");
1489 } else if (isLower(c))
1492 // this is slow, so do it only if necessary
1495 defaultcssclass_ = to_utf8(d);
1496 return defaultcssclass_;
1502 string makeMarginValue(char const * side, double d)
1505 os << "margin-" << side << ": " << d << "ex;\n";
1512 void Layout::makeDefaultCSS() const
1514 // this never needs to be redone, since reloading layouts will
1515 // wipe out what we did before.
1516 if (!htmldefaultstyle_.empty())
1520 htmldefaultstyle_ = font.asCSS();
1525 tmp += makeMarginValue("top", topsep);
1527 tmp += makeMarginValue("bottom", bottomsep);
1528 if (!leftmargin.empty()) {
1529 // we can't really do what LyX does with the margin, so
1530 // we'll just figure out how many characters it is
1531 int const len = leftmargin.length();
1532 tmp += makeMarginValue("left", len);
1534 if (!rightmargin.empty()) {
1535 int const len = rightmargin.length();
1536 tmp += makeMarginValue("right", len);
1540 if (!htmldefaultstyle_.empty())
1541 htmldefaultstyle_ += from_ascii("\n");
1542 htmldefaultstyle_ += from_ascii(tmp);
1546 string where = alignmentToCSS(align);
1547 if (!where.empty()) {
1548 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
1551 // wrap up what we have, if anything
1552 if (!htmldefaultstyle_.empty())
1554 from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
1555 htmldefaultstyle_ + from_ascii("\n}\n");
1557 if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
1563 if (labelfont != font)
1564 labelCSS = labelfont.asCSS() + from_ascii("\n");
1565 if (labeltype == LABEL_CENTERED)
1566 labelCSS += from_ascii("text-align: center;\n");
1568 if (!labelCSS.empty())
1569 htmldefaultstyle_ +=
1570 from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
1571 labelCSS + from_ascii("\n}\n");
1575 bool Layout::operator==(Layout const & rhs) const
1577 // This is enough for the applications we actually make,
1578 // at least at the moment. But we could check more.
1579 return name() == rhs.name()
1580 && latexname() == rhs.latexname()
1581 && latextype == rhs.latextype;