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_ = trim(labelstring_);
549 labelstring_appendix_ = labelstring_;
552 case LT_ENDLABELSTRING:
553 lex >> endlabelstring_;
554 endlabelstring_ = trim(endlabelstring_);
557 case LT_LABELSTRING_APPENDIX:
558 lex >> labelstring_appendix_;
559 labelstring_appendix_ = trim(labelstring_appendix_);
562 case LT_LABELCOUNTER:
564 counter = trim(counter);
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());
621 case LT_HTMLITEMATTR:
622 lex >> htmlitemattr_;
626 lex >> htmllabeltag_;
629 case LT_HTMLLABELATTR:
630 lex >> htmllabelattr_;
633 case LT_HTMLLABELFIRST:
634 lex >> htmllabelfirst_;
638 htmlstyle_ = lex.getLongString(from_ascii("EndHTMLStyle"));
641 case LT_HTMLFORCECSS:
642 lex >> htmlforcecss_;
645 case LT_HTMLPREAMBLE:
646 htmlpreamble_ = lex.getLongString(from_ascii("EndPreamble"));
663 add_to_toc_ = !toc_type_.empty();
666 case LT_ISTOCCAPTION:
667 lex >> is_toc_caption_;
673 // make sure we only have inpreamble = true for commands
674 if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
675 LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
676 LYXERR0("Layout name: " << name());
680 return finished && !error;
693 LexerKeyword alignTags[] = {
694 { "block", AT_BLOCK },
695 { "center", AT_CENTER },
696 { "layout", AT_LAYOUT },
698 { "right", AT_RIGHT }
702 void Layout::readAlign(Lexer & lex)
704 PushPopHelper pph(lex, alignTags);
707 case Lexer::LEX_UNDEF:
708 lex.printError("Unknown alignment `$$Token'");
714 align = LYX_ALIGN_BLOCK;
717 align = LYX_ALIGN_LEFT;
720 align = LYX_ALIGN_RIGHT;
723 align = LYX_ALIGN_CENTER;
726 align = LYX_ALIGN_LAYOUT;
732 void Layout::readAlignPossible(Lexer & lex)
734 lex.pushTable(alignTags);
735 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
736 int lineno = lex.lineNumber();
740 case Lexer::LEX_UNDEF:
741 lex.printError("Unknown alignment `$$Token'");
747 alignpossible |= LYX_ALIGN_BLOCK;
750 alignpossible |= LYX_ALIGN_LEFT;
753 alignpossible |= LYX_ALIGN_RIGHT;
756 alignpossible |= LYX_ALIGN_CENTER;
759 alignpossible |= LYX_ALIGN_LAYOUT;
762 } while (lineno == lex.lineNumber());
767 void Layout::readLabelType(Lexer & lex)
782 LexerKeyword labelTypeTags[] = {
783 { "above", LA_ABOVE },
784 { "bibliography", LA_BIBLIO },
785 { "centered", LA_CENTERED },
786 { "enumerate", LA_ENUMERATE },
787 { "itemize", LA_ITEMIZE },
788 { "manual", LA_MANUAL },
789 { "no_label", LA_NO_LABEL },
790 { "sensitive", LA_SENSITIVE },
791 { "static", LA_STATIC }
794 PushPopHelper pph(lex, labelTypeTags);
797 case Lexer::LEX_UNDEF:
798 lex.printError("Unknown labeltype tag `$$Token'");
804 labeltype = LABEL_NO_LABEL;
807 labeltype = LABEL_MANUAL;
810 labeltype = LABEL_ABOVE;
813 labeltype = LABEL_CENTERED;
816 labeltype = LABEL_STATIC;
819 labeltype = LABEL_SENSITIVE;
822 labeltype = LABEL_ENUMERATE;
825 labeltype = LABEL_ITEMIZE;
828 labeltype = LABEL_BIBLIO;
834 void Layout::readEndLabelType(Lexer & lex)
836 // this should be const, but can't be because
838 static LexerKeyword endlabelTypeTags[] = {
839 { "box", END_LABEL_BOX },
840 { "filled_box", END_LABEL_FILLED_BOX },
841 { "no_label", END_LABEL_NO_LABEL },
842 { "static", END_LABEL_STATIC }
845 PushPopHelper pph(lex, endlabelTypeTags);
848 case Lexer::LEX_UNDEF:
849 lex.printError("Unknown labeltype tag `$$Token'");
851 case END_LABEL_STATIC:
853 case END_LABEL_FILLED_BOX:
854 case END_LABEL_NO_LABEL:
855 endlabeltype = static_cast<EndLabelType>(le);
858 LYXERR0("Unhandled value " << le);
864 void Layout::readMargin(Lexer & lex)
866 LexerKeyword marginTags[] = {
867 { "dynamic", MARGIN_DYNAMIC },
868 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
869 { "manual", MARGIN_MANUAL },
870 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
871 { "static", MARGIN_STATIC }
874 PushPopHelper pph(lex, marginTags);
878 case Lexer::LEX_UNDEF:
879 lex.printError("Unknown margin type tag `$$Token'");
884 case MARGIN_FIRST_DYNAMIC:
885 case MARGIN_RIGHT_ADDRESS_BOX:
886 margintype = static_cast<MarginType>(le);
889 LYXERR0("Unhandled value " << le);
895 void Layout::readLatexType(Lexer & lex)
897 LexerKeyword latexTypeTags[] = {
898 { "bib_environment", LATEX_BIB_ENVIRONMENT },
899 { "command", LATEX_COMMAND },
900 { "environment", LATEX_ENVIRONMENT },
901 { "item_environment", LATEX_ITEM_ENVIRONMENT },
902 { "list_environment", LATEX_LIST_ENVIRONMENT },
903 { "paragraph", LATEX_PARAGRAPH }
906 PushPopHelper pph(lex, latexTypeTags);
909 case Lexer::LEX_UNDEF:
910 lex.printError("Unknown latextype tag `$$Token'");
912 case LATEX_PARAGRAPH:
914 case LATEX_ITEM_ENVIRONMENT:
915 case LATEX_LIST_ENVIRONMENT:
916 latextype = static_cast<LatexType>(le);
918 case LATEX_ENVIRONMENT:
919 case LATEX_BIB_ENVIRONMENT:
920 latextype = static_cast<LatexType>(le);
924 LYXERR0("Unhandled value " << le);
930 void Layout::readSpacing(Lexer & lex)
933 ST_SPACING_SINGLE = 1,
939 LexerKeyword spacingTags[] = {
940 {"double", ST_SPACING_DOUBLE },
941 {"onehalf", ST_SPACING_ONEHALF },
942 {"other", ST_OTHER },
943 {"single", ST_SPACING_SINGLE }
946 PushPopHelper pph(lex, spacingTags);
949 case Lexer::LEX_UNDEF:
950 lex.printError("Unknown spacing token `$$Token'");
955 case ST_SPACING_SINGLE:
956 spacing.set(Spacing::Single);
958 case ST_SPACING_ONEHALF:
959 spacing.set(Spacing::Onehalf);
961 case ST_SPACING_DOUBLE:
962 spacing.set(Spacing::Double);
966 spacing.set(Spacing::Other, lex.getString());
972 void Layout::readArgument(Lexer & lex)
975 // writeArgument() makes use of these default values
976 arg.mandatory = false;
977 arg.autoinsert = false;
978 arg.insertcotext = false;
980 bool finished = false;
981 arg.font = inherit_font;
982 arg.labelfont = inherit_font;
983 arg.is_toc_caption = false;
984 arg.passthru = PT_INHERITED;
987 bool const itemarg = prefixIs(id, "item:");
988 bool const postcmd = prefixIs(id, "post:");
990 while (!finished && lex.isOK() && !error) {
992 string const tok = ascii_lowercase(lex.getString());
996 } else if (tok == "endargument") {
998 } else if (tok == "labelstring") {
1000 arg.labelstring = lex.getDocString();
1001 } else if (tok == "menustring") {
1003 arg.menustring = lex.getDocString();
1004 } else if (tok == "mandatory") {
1006 arg.mandatory = lex.getBool();
1007 } else if (tok == "autoinsert") {
1009 arg.autoinsert = lex.getBool();
1010 } else if (tok == "insertcotext") {
1012 arg.insertcotext = lex.getBool();
1013 } else if (tok == "leftdelim") {
1015 arg.ldelim = lex.getDocString();
1016 arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
1018 } else if (tok == "rightdelim") {
1020 arg.rdelim = lex.getDocString();
1021 arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
1023 } else if (tok == "defaultarg") {
1025 arg.defaultarg = lex.getDocString();
1026 } else if (tok == "presetarg") {
1028 arg.presetarg = lex.getDocString();
1029 } else if (tok == "tooltip") {
1031 arg.tooltip = lex.getDocString();
1032 } else if (tok == "requires") {
1034 arg.requires = lex.getString();
1035 } else if (tok == "decoration") {
1037 arg.decoration = lex.getString();
1038 } else if (tok == "font") {
1039 arg.font = lyxRead(lex, arg.font);
1040 } else if (tok == "labelfont") {
1041 arg.labelfont = lyxRead(lex, arg.labelfont);
1042 } else if (tok == "passthruchars") {
1044 arg.pass_thru_chars = lex.getDocString();
1045 } else if (tok == "passthru") {
1047 docstring value = lex.getDocString();
1048 if (value == "true" || value == "1")
1049 arg.passthru = PT_TRUE;
1050 else if (value == "false" || value == "0")
1051 arg.passthru = PT_FALSE;
1053 arg.passthru = PT_INHERITED;
1054 } else if (tok == "istoccaption") {
1056 arg.is_toc_caption = lex.getBool();
1058 lex.printError("Unknown tag");
1062 if (arg.labelstring.empty())
1063 LYXERR0("Incomplete Argument definition!");
1065 itemargs_[id] = arg;
1067 postcommandargs_[id] = arg;
1069 latexargs_[id] = arg;
1073 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1075 os << "\tArgument " << id << '\n';
1076 if (!arg.labelstring.empty())
1077 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1078 if (!arg.menustring.empty())
1079 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1081 os << "\t\tMandatory " << arg.mandatory << '\n';
1083 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1084 if (arg.insertcotext)
1085 os << "\t\tInsertCotext " << arg.insertcotext << '\n';
1086 if (!arg.ldelim.empty())
1087 os << "\t\tLeftDelim \""
1088 << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1090 if (!arg.rdelim.empty())
1091 os << "\t\tRightDelim \""
1092 << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1094 if (!arg.defaultarg.empty())
1095 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1096 if (!arg.presetarg.empty())
1097 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1098 if (!arg.tooltip.empty())
1099 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1100 if (!arg.requires.empty())
1101 os << "\t\tRequires \"" << arg.requires << "\"\n";
1102 if (!arg.decoration.empty())
1103 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1104 if (arg.font != inherit_font)
1105 lyxWrite(os, arg.font, "Font", 2);
1106 if (arg.labelfont != inherit_font)
1107 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1108 switch (arg.passthru) {
1110 os << "\t\tPassThru true\n";
1113 os << "\t\tPassThru false\n";
1116 os << "\t\tPassThru inherited\n";
1119 if (!arg.pass_thru_chars.empty())
1120 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1121 os << "\tEndArgument\n";
1125 void Layout::write(ostream & os) const
1127 os << "Style \"" << to_utf8(name_) << "\"\n";
1128 if (!category_.empty() && obsoleted_by_.empty())
1129 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1130 // Can't deduce Copystyle here :-(
1131 if (!obsoleted_by_.empty()) {
1132 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1136 if (!depends_on_.empty())
1137 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1138 switch (margintype) {
1139 case MARGIN_DYNAMIC:
1140 os << "\tMargin Dynamic\n";
1142 case MARGIN_FIRST_DYNAMIC:
1143 os << "\tMargin First_Dynamic\n";
1146 os << "\tMargin Manual\n";
1148 case MARGIN_RIGHT_ADDRESS_BOX:
1149 os << "\tMargin Right_Address_Box\n";
1152 os << "\tMargin Static\n";
1155 switch (latextype) {
1156 case LATEX_BIB_ENVIRONMENT:
1157 os << "\tLatexType Bib_Environment\n";
1160 os << "\tLatexType Command\n";
1162 case LATEX_ENVIRONMENT:
1163 os << "\tLatexType Environment\n";
1165 case LATEX_ITEM_ENVIRONMENT:
1166 os << "\tLatexType Item_Environment\n";
1168 case LATEX_LIST_ENVIRONMENT:
1169 os << "\tLatexType List_Environment\n";
1171 case LATEX_PARAGRAPH:
1172 os << "\tLatexType Paragraph\n";
1175 os << "\tInTitle " << intitle << "\n"
1176 "\tInPreamble " << inpreamble << "\n"
1177 "\tTocLevel " << toclevel << "\n"
1178 "\tResumeCounter " << resumecounter << "\n"
1179 "\tStepMasterCounter " << stepmastercounter << '\n';
1180 // ResetArgs does not make sense here
1181 for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1182 it != latexargs_.end(); ++it)
1183 writeArgument(os, it->first, it->second);
1184 for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1185 it != itemargs_.end(); ++it)
1186 writeArgument(os, it->first, it->second);
1187 for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1188 it != postcommandargs_.end(); ++it)
1189 writeArgument(os, it->first, it->second);
1190 os << "\tNeedProtect " << needprotect << "\n"
1191 "\tKeepEmpty " << keepempty << '\n';
1192 if (labelfont == font)
1193 lyxWrite(os, font, "Font", 1);
1195 lyxWrite(os, font, "TextFont", 1);
1196 lyxWrite(os, labelfont, "LabelFont", 1);
1198 os << "\tNextNoIndent " << nextnoindent << "\n"
1199 "\tCommandDepth " << commanddepth << '\n';
1200 if (!latexname_.empty())
1201 os << "\tLatexName \"" << latexname_ << "\"\n";
1202 if (!latexparam_.empty())
1203 os << "\tLatexParam \"" << subst(latexparam_, "\"", """)
1205 if (!leftdelim_.empty())
1206 os << "\tLeftDelim "
1207 << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1209 if (!rightdelim_.empty())
1210 os << "\tRightDelim "
1211 << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1213 if (!innertag_.empty())
1214 os << "\tInnerTag \"" << innertag_ << "\"\n";
1215 if (!labeltag_.empty())
1216 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1217 if (!itemtag_.empty())
1218 os << "\tItemTag \"" << itemtag_ << "\"\n";
1219 if (!itemcommand_.empty())
1220 os << "\tItemCommand " << itemcommand_ << '\n';
1221 if (!preamble_.empty())
1222 os << "\tPreamble\n\t"
1223 << to_utf8(subst(rtrim(preamble_, "\n"),
1224 from_ascii("\n"), from_ascii("\n\t")))
1225 << "\n\tEndPreamble\n";
1226 if (!langpreamble_.empty())
1227 os << "\tLangPreamble\n\t"
1228 << to_utf8(subst(rtrim(langpreamble_, "\n"),
1229 from_ascii("\n"), from_ascii("\n\t")))
1230 << "\n\tEndLangPreamble\n";
1231 if (!babelpreamble_.empty())
1232 os << "\tBabelPreamble\n\t"
1233 << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1234 from_ascii("\n"), from_ascii("\n\t")))
1235 << "\n\tEndBabelPreamble\n";
1236 switch (labeltype) {
1238 os << "\tLabelType Above\n";
1241 os << "\tLabelType Bibliography\n";
1243 case LABEL_CENTERED:
1244 os << "\tLabelType Centered\n";
1246 case LABEL_ENUMERATE:
1247 os << "\tLabelType Enumerate\n";
1250 os << "\tLabelType Itemize\n";
1253 os << "\tLabelType Manual\n";
1255 case LABEL_NO_LABEL:
1256 os << "\tLabelType No_Label\n";
1258 case LABEL_SENSITIVE:
1259 os << "\tLabelType Sensitive\n";
1262 os << "\tLabelType Static\n";
1265 switch (endlabeltype) {
1267 os << "\tEndLabelType Box\n";
1269 case END_LABEL_FILLED_BOX:
1270 os << "\tEndLabelType Filled_Box\n";
1272 case END_LABEL_NO_LABEL:
1273 os << "\tEndLabelType No_Label\n";
1275 case END_LABEL_STATIC:
1276 os << "\tEndLabelType Static\n";
1279 os << "\tParagraphGroup \"" << par_group_ << "\"\n";
1280 if (!leftmargin.empty())
1281 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1282 if (!rightmargin.empty())
1283 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1284 if (!labelindent.empty())
1285 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1286 if (!parindent.empty())
1287 os << "\tParIndent " << to_utf8(parindent) << '\n';
1288 os << "\tParSkip " << parskip << "\n"
1289 "\tItemSep " << itemsep << "\n"
1290 "\tTopSep " << topsep << "\n"
1291 "\tBottomSep " << bottomsep << "\n"
1292 "\tLabelBottomSep " << labelbottomsep << '\n';
1293 if (!labelsep.empty())
1294 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1296 os << "\tParSep " << parsep << "\n"
1297 "\tNewLine " << newline_allowed << '\n';
1299 case LYX_ALIGN_BLOCK:
1300 os << "\tAlign Block\n";
1302 case LYX_ALIGN_CENTER:
1303 os << "\tAlign Center\n";
1305 case LYX_ALIGN_LAYOUT:
1306 os << "\tAlign Layout\n";
1308 case LYX_ALIGN_LEFT:
1309 os << "\tAlign Left\n";
1311 case LYX_ALIGN_RIGHT:
1312 os << "\tAlign Right\n";
1314 case LYX_ALIGN_DECIMAL:
1315 case LYX_ALIGN_SPECIAL:
1316 case LYX_ALIGN_NONE:
1319 if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1320 LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1322 os << "\tAlignPossible";
1323 if (alignpossible & LYX_ALIGN_BLOCK) {
1327 if (alignpossible & LYX_ALIGN_CENTER) {
1333 if (alignpossible & LYX_ALIGN_LAYOUT) {
1339 if (alignpossible & LYX_ALIGN_LEFT) {
1345 if (alignpossible & LYX_ALIGN_RIGHT) {
1353 // LabelString must come before LabelStringAppendix
1354 if (!labelstring_.empty())
1355 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1356 if (!endlabelstring_.empty())
1357 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1358 if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1359 os << "\tLabelStringAppendix \""
1360 << to_utf8(labelstring_appendix_) << "\"\n";
1361 if (!counter.empty())
1362 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1363 os << "\tFreeSpacing " << free_spacing << '\n';
1364 os << "\tPassThru " << pass_thru << '\n';
1365 if (!pass_thru_chars.empty())
1366 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1367 os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1368 switch (spacing.getSpace()) {
1369 case Spacing::Double:
1370 os << "\tSpacing Double\n";
1372 case Spacing::Onehalf:
1373 os << "\tSpacing Onehalf\n";
1375 case Spacing::Other:
1376 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1378 case Spacing::Single:
1379 os << "\tSpacing Single\n";
1381 case Spacing::Default:
1384 if (!requires_.empty()) {
1385 os << "\tRequires ";
1386 for (set<string>::const_iterator it = requires_.begin();
1387 it != requires_.end(); ++it) {
1388 if (it != requires_.begin())
1394 if (refprefix.empty())
1395 os << "\tRefPrefix OFF\n";
1397 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1398 if (!htmltag_.empty())
1399 os << "\tHTMLTag " << htmltag_ << '\n';
1400 if (!htmlattr_.empty())
1401 os << "\tHTMLAttr " << htmlattr_ << '\n';
1402 if (!htmlitemtag_.empty())
1403 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1404 if (!htmlitemattr_.empty())
1405 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1406 if (!htmllabeltag_.empty())
1407 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1408 if (!htmllabelattr_.empty())
1409 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1410 os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1411 if (!htmlstyle_.empty())
1412 os << "\tHTMLStyle\n"
1413 << to_utf8(rtrim(htmlstyle_, "\n"))
1414 << "\n\tEndHTMLStyle\n";
1415 os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1416 if (!htmlpreamble_.empty())
1417 os << "\tHTMLPreamble\n"
1418 << to_utf8(rtrim(htmlpreamble_, "\n"))
1419 << "\n\tEndPreamble\n";
1420 os << "\tHTMLTitle " << htmltitle_ << "\n"
1421 "\tSpellcheck " << spellcheck << "\n"
1422 "\tForceLocal " << forcelocal << "\n"
1427 bool Layout::hasArgs() const
1429 return !latexargs_.empty() || !postcommandargs_.empty() ||
1434 Layout::LaTeXArgMap Layout::args() const
1436 LaTeXArgMap args = latexargs_;
1437 if (!postcommandargs_.empty())
1438 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1439 if (!itemargs_.empty())
1440 args.insert(itemargs_.begin(), itemargs_.end());
1445 int Layout::optArgs() const
1448 LaTeXArgMap::const_iterator it = latexargs_.begin();
1449 for (; it != latexargs_.end(); ++it) {
1450 if (!(*it).second.mandatory)
1453 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1454 for (; iit != postcommandargs_.end(); ++iit) {
1455 if (!(*iit).second.mandatory)
1462 int Layout::requiredArgs() const
1465 LaTeXArgMap::const_iterator it = latexargs_.begin();
1466 for (; it != latexargs_.end(); ++it) {
1467 if ((*it).second.mandatory)
1470 LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1471 for (; iit != postcommandargs_.end(); ++iit) {
1472 if (!(*iit).second.mandatory)
1479 string const & Layout::htmltag() const
1481 if (htmltag_.empty())
1487 string const & Layout::htmlattr() const
1489 if (htmlattr_.empty())
1490 htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
1495 string const & Layout::htmlitemtag() const
1497 if (htmlitemtag_.empty())
1498 htmlitemtag_ = "div";
1499 return htmlitemtag_;
1503 string const & Layout::htmlitemattr() const
1505 if (htmlitemattr_.empty())
1506 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1507 return htmlitemattr_;
1511 string const & Layout::htmllabeltag() const
1513 if (htmllabeltag_.empty()) {
1514 if (labeltype != LABEL_ABOVE &&
1515 labeltype != LABEL_CENTERED)
1516 htmllabeltag_ = "span";
1518 htmllabeltag_ = "div";
1520 return htmllabeltag_;
1524 string const & Layout::htmllabelattr() const
1526 if (htmllabelattr_.empty())
1527 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1528 return htmllabelattr_;
1532 docstring Layout::htmlstyle() const
1534 if (!htmlstyle_.empty() && !htmlforcecss_)
1536 if (htmldefaultstyle_.empty())
1538 docstring retval = htmldefaultstyle_;
1539 if (!htmlstyle_.empty())
1540 retval += '\n' + htmlstyle_;
1545 string Layout::defaultCSSClass() const
1547 if (!defaultcssclass_.empty())
1548 return defaultcssclass_;
1550 docstring::const_iterator it = name().begin();
1551 docstring::const_iterator en = name().end();
1552 for (; it != en; ++it) {
1553 char_type const c = *it;
1554 if (!isAlphaASCII(c)) {
1556 // make sure we don't start with an underscore,
1557 // as that sometimes causes problems.
1558 d = from_ascii("lyx_");
1561 } else if (isLower(c))
1564 // this is slow, so do it only if necessary
1567 defaultcssclass_ = to_utf8(d);
1568 return defaultcssclass_;
1574 string makeMarginValue(char const * side, double d)
1577 os << "margin-" << side << ": " << d << "ex;\n";
1584 void Layout::makeDefaultCSS() const
1586 // this never needs to be redone, since reloading layouts will
1587 // wipe out what we did before.
1588 if (!htmldefaultstyle_.empty())
1592 htmldefaultstyle_ = font.asCSS();
1597 tmp += makeMarginValue("top", topsep);
1599 tmp += makeMarginValue("bottom", bottomsep);
1600 if (!leftmargin.empty()) {
1601 // we can't really do what LyX does with the margin, so
1602 // we'll just figure out how many characters it is
1603 int const len = leftmargin.length();
1604 tmp += makeMarginValue("left", len);
1606 if (!rightmargin.empty()) {
1607 int const len = rightmargin.length();
1608 tmp += makeMarginValue("right", len);
1612 if (!htmldefaultstyle_.empty())
1613 htmldefaultstyle_ += from_ascii("\n");
1614 htmldefaultstyle_ += from_ascii(tmp);
1618 string where = alignmentToCSS(align);
1619 if (!where.empty()) {
1620 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
1623 // wrap up what we have, if anything
1624 if (!htmldefaultstyle_.empty())
1626 from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
1627 htmldefaultstyle_ + from_ascii("\n}\n");
1629 if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
1635 if (labelfont != font)
1636 labelCSS = labelfont.asCSS() + from_ascii("\n");
1637 if (labeltype == LABEL_CENTERED)
1638 labelCSS += from_ascii("text-align: center;\n");
1640 if (!labelCSS.empty())
1641 htmldefaultstyle_ +=
1642 from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
1643 labelCSS + from_ascii("\n}\n");
1647 bool Layout::operator==(Layout const & rhs) const
1649 // This is enough for the applications we actually make,
1650 // at least at the moment. But we could check more.
1651 return name() == rhs.name()
1652 && latexname() == rhs.latexname()
1653 && latextype == rhs.latextype;