* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Jean-Marc Lasgouttes
- * \author André Pönitz
+ * \author André Pönitz
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "Layout.h"
+#include "Language.h"
#include "TextClass.h"
#include "Lexer.h"
-#include "Font.h"
+#include "FontInfo.h"
+#include "support/Messages.h"
#include "support/debug.h"
+#include "support/lassert.h"
#include "support/lstrings.h"
+#include "support/regex.h"
+
using namespace std;
using namespace lyx::support;
LT_LATEXPARAM,
LT_OPTARGS,
LT_LATEXTYPE,
- LT_LATEXHEADER,
- LT_LATEXFOOTER,
- LT_LATEXPARAGRAPH,
LT_LEFTMARGIN,
LT_NEED_PROTECT,
LT_NEWLINE,
LT_PARSKIP,
//LT_PLAIN,
LT_PREAMBLE,
+ LT_LANGPREAMBLE,
+ LT_BABELPREAMBLE,
LT_REQUIRES,
LT_RIGHTMARGIN,
LT_SPACING,
LT_INNERTAG,
LT_LABELTAG,
LT_ITEMTAG,
+ LT_HTMLTAG,
+ LT_HTMLATTR,
+ LT_HTMLITEM,
+ LT_HTMLITEMATTR,
+ LT_HTMLLABEL,
+ LT_HTMLLABELATTR,
+ LT_HTMLLABELFIRST,
+ LT_HTMLPREAMBLE,
+ LT_HTMLSTYLE,
+ LT_HTMLFORCECSS,
+ LT_INPREAMBLE,
+ LT_HTMLTITLE,
+ LT_SPELLCHECK,
+ LT_REFPREFIX,
+ LT_REQARGS,
LT_INTITLE // keep this last!
};
Layout::Layout()
{
+ unknown_ = false;
margintype = MARGIN_STATIC;
latextype = LATEX_PARAGRAPH;
intitle = false;
- optionalargs = 0;
+ inpreamble = false;
needprotect = false;
keepempty = false;
font = inherit_font;
pass_thru = false;
toclevel = NOT_IN_TOC;
commanddepth = 0;
+ htmllabelfirst_ = false;
+ htmlforcecss_ = false;
+ htmltitle_ = false;
+ spellcheck = true;
+ optargs = 0;
+ reqargs = 0;
}
LexerKeyword layoutTags[] = {
{ "align", LT_ALIGN },
{ "alignpossible", LT_ALIGNPOSSIBLE },
+ { "babelpreamble", LT_BABELPREAMBLE },
{ "bottomsep", LT_BOTTOMSEP },
{ "category", LT_CATEGORY },
{ "commanddepth", LT_COMMANDDEPTH },
{ "fill_top", LT_FILL_TOP },
{ "font", LT_FONT },
{ "freespacing", LT_FREE_SPACING },
+ { "htmlattr", LT_HTMLATTR },
+ { "htmlforcecss", LT_HTMLFORCECSS },
+ { "htmlitem", LT_HTMLITEM },
+ { "htmlitemattr", LT_HTMLITEMATTR },
+ { "htmllabel", LT_HTMLLABEL },
+ { "htmllabelattr", LT_HTMLLABELATTR },
+ { "htmllabelfirst", LT_HTMLLABELFIRST },
+ { "htmlpremable", LT_HTMLPREAMBLE },
+ { "htmlstyle", LT_HTMLSTYLE },
+ { "htmltag", LT_HTMLTAG },
+ { "htmltitle", LT_HTMLTITLE },
{ "innertag", LT_INNERTAG },
+ { "inpreamble", LT_INPREAMBLE },
{ "intitle", LT_INTITLE },
{ "itemsep", LT_ITEMSEP },
{ "itemtag", LT_ITEMTAG },
{ "labelstringappendix", LT_LABELSTRING_APPENDIX },
{ "labeltag", LT_LABELTAG },
{ "labeltype", LT_LABELTYPE },
- { "latexfooter", LT_LATEXFOOTER },
- { "latexheader", LT_LATEXHEADER },
+ { "langpreamble", LT_LANGPREAMBLE },
{ "latexname", LT_LATEXNAME },
- { "latexparagraph", LT_LATEXPARAGRAPH },
{ "latexparam", LT_LATEXPARAM },
{ "latextype", LT_LATEXTYPE },
{ "leftmargin", LT_LEFTMARGIN },
{ "parskip", LT_PARSKIP },
{ "passthru", LT_PASS_THRU },
{ "preamble", LT_PREAMBLE },
+ { "refprefix", LT_REFPREFIX },
+ { "requiredargs", LT_REQARGS },
{ "requires", LT_REQUIRES },
{ "rightmargin", LT_RIGHTMARGIN },
{ "spacing", LT_SPACING },
+ { "spellcheck", LT_SPELLCHECK },
{ "textfont", LT_TEXTFONT },
{ "toclevel", LT_TOCLEVEL },
{ "topsep", LT_TOPSEP }
lex.printError("Unknown layout tag `$$Token'");
error = true;
continue;
- default: break;
+
+ default:
+ break;
}
switch (static_cast<LayoutTags>(le)) {
case LT_END: // end of structure
readLatexType(lex);
break;
- case LT_LATEXHEADER: // header for environments
- lex >> latexheader;
- break;
-
- case LT_LATEXFOOTER: // footer for environments
- lex >> latexfooter;
- break;
-
- case LT_LATEXPARAGRAPH:
- lex >> latexparagraph;
- break;
-
case LT_INTITLE:
lex >> intitle;
break;
+ case LT_INPREAMBLE:
+ lex >> inpreamble;
+ break;
+
case LT_TOCLEVEL:
lex >> toclevel;
break;
case LT_OPTARGS:
- lex >> optionalargs ;
+ lex >> optargs;
+ break;
+
+ case LT_REQARGS:
+ lex >> reqargs;
break;
case LT_NEED_PROTECT:
preamble_ = from_utf8(lex.getLongString("EndPreamble"));
break;
+ case LT_LANGPREAMBLE:
+ langpreamble_ = from_utf8(lex.getLongString("EndLangPreamble"));
+ break;
+
+ case LT_BABELPREAMBLE:
+ babelpreamble_ = from_utf8(lex.getLongString("EndBabelPreamble"));
+ break;
+
case LT_LABELTYPE:
readLabelType(lex);
break;
case LT_LABELSTRING: // label string definition
// FIXME: this means LT_ENDLABELSTRING may only
// occur after LT_LABELSTRING
- lex >> labelstring_;
+ lex >> labelstring_;
labelstring_ = trim(labelstring_);
labelstring_appendix_ = labelstring_;
break;
readSpacing(lex);
break;
- case LT_REQUIRES:
+ case LT_REQUIRES: {
lex.eatLine();
vector<string> const req =
getVectorFromString(lex.getString());
requires_.insert(req.begin(), req.end());
break;
+ }
+
+ case LT_REFPREFIX: {
+ docstring arg;
+ lex >> arg;
+ if (arg == "OFF")
+ refprefix.clear();
+ else
+ refprefix = arg;
+ break;
+ }
+
+ case LT_HTMLTAG:
+ lex >> htmltag_;
+ break;
+
+ case LT_HTMLATTR:
+ lex >> htmlattr_;
+ break;
+
+ case LT_HTMLITEM:
+ lex >> htmlitemtag_;
+ break;
+
+ case LT_HTMLITEMATTR:
+ lex >> htmlitemattr_;
+ break;
+
+ case LT_HTMLLABEL:
+ lex >> htmllabeltag_;
+ break;
+
+ case LT_HTMLLABELATTR:
+ lex >> htmllabelattr_;
+ break;
+
+ case LT_HTMLLABELFIRST:
+ lex >> htmllabelfirst_;
+ break;
+
+ case LT_HTMLSTYLE:
+ htmlstyle_ = from_utf8(lex.getLongString("EndHTMLStyle"));
+ break;
+
+ case LT_HTMLFORCECSS:
+ lex >> htmlforcecss_;
+
+ case LT_HTMLPREAMBLE:
+ htmlpreamble_ = from_utf8(lex.getLongString("EndPreamble"));
+ break;
+
+ case LT_HTMLTITLE:
+ lex >> htmltitle_;
+ break;
+ case LT_SPELLCHECK:
+ lex >> spellcheck;
+ break;
}
}
lex.popTable();
+ // make sure we only have inpreamble = true for commands
+ if (inpreamble && latextype != LATEX_COMMAND) {
+ LYXERR0("InPreamble not permitted except with Command-type layouts.");
+ LYXERR0("Layout name: " << name());
+ inpreamble = false;
+ }
- return !error;
+ return finished && !error;
}
}
-docstring const & Layout::name() const
+namespace {
+
+docstring const i18npreamble(Language const * lang, docstring const & templ)
{
- return name_;
+ if (templ.empty())
+ return templ;
+
+ string preamble = subst(to_utf8(templ), "$$lang", lang->babel());
+
+#ifdef TEX2LYX
+ // tex2lyx does not have getMessages()
+ LASSERT(false, /**/);
+#else
+ // FIXME UNICODE
+ // lyx::regex is not unicode-safe.
+ // Should use QRegExp or (boost::u32regex, but that requires ICU)
+ static regex const reg("_\\(([^\\)]+)\\)");
+ smatch sub;
+ while (regex_search(preamble, sub, reg)) {
+ string const key = sub.str(1);
+ string translated;
+ if (isAscii(key))
+ translated = to_utf8(getMessages(lang->code()).get(key));
+ else {
+ lyxerr << "Warning: not translating `" << key
+ << "' because it is not pure ASCII." << endl;
+ translated = key;
+ }
+ preamble = subst(preamble, sub.str(), translated);
+ }
+#endif
+ return from_utf8(preamble);
+}
+
}
-void Layout::setName(docstring const & name)
+docstring const Layout::langpreamble(Language const * lang) const
{
- name_ = name;
+ return i18npreamble(lang, langpreamble_);
}
-docstring const & Layout::obsoleted_by() const
+docstring const Layout::babelpreamble(Language const * lang) const
{
- return obsoleted_by_;
+ return i18npreamble(lang, babelpreamble_);
}
-docstring const & Layout::depends_on() const
-{
- return depends_on_;
+string const & Layout::htmltag() const
+{
+ if (htmltag_.empty())
+ htmltag_ = "div";
+ return htmltag_;
+}
+
+
+string const & Layout::htmlattr() const
+{
+ if (htmlattr_.empty())
+ htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
+ return htmlattr_;
+}
+
+
+string const & Layout::htmlitemtag() const
+{
+ if (htmlitemtag_.empty())
+ htmlitemtag_ = "div";
+ return htmlitemtag_;
+}
+
+
+string const & Layout::htmlitemattr() const
+{
+ if (htmlitemattr_.empty())
+ htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
+ return htmlitemattr_;
+}
+
+
+string const & Layout::htmllabeltag() const
+{
+ if (htmllabeltag_.empty())
+ htmllabeltag_ = "span";
+ return htmllabeltag_;
+}
+
+
+string const & Layout::htmllabelattr() const
+{
+ if (htmllabelattr_.empty())
+ htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
+ return htmllabelattr_;
+}
+
+
+docstring Layout::htmlstyle() const {
+ if (!htmlstyle_.empty() && !htmlforcecss_)
+ return htmlstyle_;
+ if (htmldefaultstyle_.empty())
+ makeDefaultCSS();
+ docstring retval = htmldefaultstyle_;
+ if (!htmlstyle_.empty())
+ retval += '\n' + htmlstyle_;
+ return retval;
+}
+
+
+string Layout::defaultCSSClass() const
+{
+ if (!defaultcssclass_.empty())
+ return defaultcssclass_;
+ docstring d;
+ docstring::const_iterator it = name().begin();
+ docstring::const_iterator en = name().end();
+ for (; it != en; ++it) {
+ if (!isalpha(*it))
+ continue;
+ if (islower(*it))
+ d += *it;
+ else
+ d += lowercase(*it);
+ }
+ // are there other characters we need to remove?
+ defaultcssclass_ = to_utf8(d);
+ return defaultcssclass_;
+}
+
+
+// NOTE There is a whole ton of stuff that could go into this.
+// Things like bottomsep, topsep, and parsep could become various
+// sorts of margins or padding, for example. But for now we are
+// going to keep it simple.
+void Layout::makeDefaultCSS() const {
+ // this never needs to be redone, since reloading layouts will
+ // wipe out what we did before.
+ if (!htmldefaultstyle_.empty())
+ return;
+ docstring const mainfontCSS = font.asCSS();
+ if (!mainfontCSS.empty())
+ htmldefaultstyle_ =
+ from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
+ mainfontCSS + from_ascii("\n}\n");
+ if (labelfont == font || htmllabeltag() == "NONE")
+ return;
+ docstring const labelfontCSS = labelfont.asCSS();
+ if (!labelfontCSS.empty())
+ htmldefaultstyle_ +=
+ from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
+ labelfontCSS + from_ascii("\n}\n");
}