3 * \file InsetLayout.cpp
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Martin Vermeer
10 * Full author contact details are available in file CREDITS.
15 #include "InsetLayout.h"
19 #include "TextClass.h"
21 #include "support/debug.h"
22 #include "support/lstrings.h"
32 InsetLayout::InsetLayout() :
33 name_(from_ascii("undefined")), lyxtype_(STANDARD),
34 labelstring_(from_ascii("UNDEFINED")), contentaslabel_(false),
35 decoration_(DEFAULT), latextype_(NOLATEXTYPE), font_(sane_font),
36 labelfont_(sane_font), bgcolor_(Color_error),
37 htmlforcecss_ (false), htmlisblock_(true),
38 multipar_(true), custompars_(true), forceplain_(false),
39 passthru_(false), parbreakisnewline_(false), freespacing_(false),
40 keepempty_(false), forceltr_(false),
41 needprotect_(false), intoc_(false), spellcheck_(true),
42 resetsfont_(true), display_(true)
44 labelfont_.setColor(Color_error);
50 InsetLayout::InsetDecoration translateDecoration(std::string const & str)
52 if (support::compare_ascii_no_case(str, "classic") == 0)
53 return InsetLayout::CLASSIC;
54 if (support::compare_ascii_no_case(str, "minimalistic") == 0)
55 return InsetLayout::MINIMALISTIC;
56 if (support::compare_ascii_no_case(str, "conglomerate") == 0)
57 return InsetLayout::CONGLOMERATE;
58 return InsetLayout::DEFAULT;
61 InsetLayout::InsetLaTeXType translateLaTeXType(std::string const & str)
63 if (support::compare_ascii_no_case(str, "command") == 0)
64 return InsetLayout::COMMAND;
65 if (support::compare_ascii_no_case(str, "environment") == 0)
66 return InsetLayout::ENVIRONMENT;
67 if (support::compare_ascii_no_case(str, "none") == 0)
68 return InsetLayout::NOLATEXTYPE;
69 return InsetLayout::ILT_ERROR;
75 bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
109 IL_PARBREAKISNEWLINE,
119 LexerKeyword elementTags[] = {
120 { "bgcolor", IL_BGCOLOR },
121 { "contentaslabel", IL_CONTENTASLABEL },
122 { "copystyle", IL_COPYSTYLE },
123 { "counter", IL_COUNTER},
124 { "custompars", IL_CUSTOMPARS },
125 { "decoration", IL_DECORATION },
126 { "display", IL_DISPLAY },
129 { "forceltr", IL_FORCELTR },
130 { "forceplain", IL_FORCEPLAIN },
131 { "freespacing", IL_FREESPACING },
132 { "htmlattr", IL_HTMLATTR },
133 { "htmlforcecss", IL_HTMLFORCECSS },
134 { "htmlinnerattr", IL_HTMLINNERATTR},
135 { "htmlinnertag", IL_HTMLINNERTAG},
136 { "htmlisblock", IL_HTMLISBLOCK},
137 { "htmllabel", IL_HTMLLABEL },
138 { "htmlpreamble", IL_HTMLPREAMBLE },
139 { "htmlstyle", IL_HTMLSTYLE },
140 { "htmltag", IL_HTMLTAG },
141 { "intoc", IL_INTOC },
142 { "keepempty", IL_KEEPEMPTY },
143 { "labelfont", IL_LABELFONT },
144 { "labelstring", IL_LABELSTRING },
145 { "latexname", IL_LATEXNAME },
146 { "latexparam", IL_LATEXPARAM },
147 { "latextype", IL_LATEXTYPE },
148 { "lyxtype", IL_LYXTYPE },
149 { "multipar", IL_MULTIPAR },
150 { "needprotect", IL_NEEDPROTECT },
151 { "parbreakisnewline", IL_PARBREAKISNEWLINE },
152 { "passthru", IL_PASSTHRU },
153 { "preamble", IL_PREAMBLE },
154 { "refprefix", IL_REFPREFIX },
155 { "requires", IL_REQUIRES },
156 { "resetsfont", IL_RESETSFONT },
157 { "spellcheck", IL_SPELLCHECK }
160 lex.pushTable(elementTags);
162 FontInfo font = inherit_font;
163 labelfont_ = inherit_font;
164 bgcolor_ = Color_none;
166 // whether we've read the CustomPars or ForcePlain tag
167 // for issuing a warning in case MultiPars comes later
168 bool readCustomOrPlain = false;
171 while (!getout && lex.isOK()) {
174 case Lexer::LEX_UNDEF:
175 lex.printError("Unknown InsetLayout tag");
182 // Perhaps a more elegant way to deal with the next two would be the
183 // way this sort of thing is handled in Layout::read(), namely, by
188 lyxtype_ = translateLyXType(lt);
189 if (lyxtype_ == NOLYXTYPE)
190 LYXERR0("Unknown LyXType `" << lt << "'.");
191 if (lyxtype_ == CHARSTYLE)
198 latextype_ = translateLaTeXType(lt);
199 if (latextype_ == ILT_ERROR)
200 LYXERR0("Unknown LaTeXType `" << lt << "'.");
208 decoration_ = translateDecoration(tmp);
215 latexparam_ = support::subst(tmp, """, "\"");
218 labelfont_ = lyxRead(lex, inherit_font);
228 // the defaults for these depend upon multipar_
229 if (readCustomOrPlain)
230 LYXERR0("Warning: Read MultiPar after CustomPars or ForcePlain. "
231 "Previous value may be overwritten!");
232 readCustomOrPlain = false;
233 custompars_ = multipar_;
234 forceplain_ = !multipar_;
241 readCustomOrPlain = true;
245 readCustomOrPlain = true;
250 case IL_PARBREAKISNEWLINE:
251 lex >> parbreakisnewline_;
262 case IL_CONTENTASLABEL:
263 lex >> contentaslabel_;
266 // initialize with a known style
269 style = support::subst(style, '_', ' ');
271 // We don't want to apply the algorithm in DocumentClass::insetLayout()
272 // here. So we do it the long way.
273 TextClass::InsetLayouts::const_iterator it =
274 tclass.insetLayouts().find(style);
275 if (it != tclass.insetLayouts().end()) {
276 docstring const tmpname = name_;
277 this->operator=(it->second);
280 LYXERR0("Cannot copy unknown InsetLayout `"
282 << "All InsetLayouts so far:");
283 TextClass::InsetLayouts::const_iterator lit =
284 tclass.insetLayouts().begin();
285 TextClass::InsetLayouts::const_iterator len =
286 tclass.insetLayouts().end();
287 for (; lit != len; ++lit)
288 lyxerr << lit->second.name() << "\n";
294 font_ = lyxRead(lex, inherit_font);
295 // If you want to define labelfont, you need to do so after
302 bgcolor_ = lcolor.getFromLyXName(tmp);
305 preamble_ = from_utf8(lex.getLongString("EndPreamble"));
316 case IL_HTMLFORCECSS:
317 lex >> htmlforcecss_;
319 case IL_HTMLINNERTAG:
320 lex >> htmlinnertag_;
322 case IL_HTMLINNERATTR:
323 lex >> htmlinnerattr_;
332 htmlstyle_ = from_utf8(lex.getLongString("EndHTMLStyle"));
334 case IL_HTMLPREAMBLE:
335 htmlpreamble_ = from_utf8(lex.getLongString("EndPreamble"));
339 vector<string> const req
340 = support::getVectorFromString(lex.getString());
341 requires_.insert(req.begin(), req.end());
359 // Here add element to list if getout == true
363 // The label font is generally used as-is without
364 // any realization against a given context.
365 labelfont_.realize(sane_font);
372 InsetLayout::InsetLyXType translateLyXType(std::string const & str)
375 if (support::compare_ascii_no_case(str, "charstyle") == 0)
376 return InsetLayout::CHARSTYLE;
377 if (support::compare_ascii_no_case(str, "custom") == 0)
378 return InsetLayout::CUSTOM;
379 if (support::compare_ascii_no_case(str, "element") == 0)
380 return InsetLayout::ELEMENT;
381 if (support::compare_ascii_no_case(str, "end") == 0)
382 return InsetLayout::END;
383 if (support::compare_ascii_no_case(str, "standard") == 0)
384 return InsetLayout::STANDARD;
385 return InsetLayout::NOLYXTYPE;
389 string const & InsetLayout::htmltag() const
391 if (htmltag_.empty())
392 htmltag_ = multipar_ ? "div" : "span";
397 string const & InsetLayout::htmlattr() const
399 if (htmlattr_.empty())
400 htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
405 string const & InsetLayout::htmlinnerattr() const
407 if (htmlinnerattr_.empty())
408 htmlinnerattr_ = "class=\"" + defaultCSSClass() + "_inner\"";
409 return htmlinnerattr_;
413 string InsetLayout::defaultCSSClass() const
415 if (!defaultcssclass_.empty())
416 return defaultcssclass_;
418 string n = to_utf8(name());
419 string::const_iterator it = n.begin();
420 string::const_iterator en = n.end();
421 for (; it != en; ++it) {
424 else if (islower(*it))
427 d += support::lowercase(*it);
429 // are there other characters we need to remove?
430 defaultcssclass_ = d;
431 return defaultcssclass_;
435 void InsetLayout::makeDefaultCSS() const
437 if (!htmldefaultstyle_.empty())
439 docstring const mainfontCSS = font_.asCSS();
440 if (!mainfontCSS.empty())
442 from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
443 mainfontCSS + from_ascii("\n}\n");
447 docstring InsetLayout::htmlstyle() const
449 if (!htmlstyle_.empty() && !htmlforcecss_)
451 if (htmldefaultstyle_.empty())
453 docstring retval = htmldefaultstyle_;
454 if (!htmlstyle_.empty())
455 retval += '\n' + htmlstyle_ + '\n';