]> git.lyx.org Git - lyx.git/blobdiff - src/Layout.cpp
listerrors.lyx : Update a link.
[lyx.git] / src / Layout.cpp
index 7df75754ff77974e66d24b10b5d32201b78e4331..80393cb982fa447838f25c630ad46122f6a51555 100644 (file)
 #include <config.h>
 
 #include "Layout.h"
+#include "Encoding.h"
+#include "FontInfo.h"
 #include "Language.h"
-#include "TextClass.h"
 #include "Lexer.h"
-#include "Font.h"
+#include "output_xhtml.h"
+#include "TextClass.h"
 
-#include "support/Messages.h"
 #include "support/debug.h"
 #include "support/lassert.h"
 #include "support/lstrings.h"
+#include "support/Messages.h"
+#include "support/regex.h"
+#include "support/textutils.h"
 
-#include <boost/regex.hpp>
 
 using namespace std;
 using namespace lyx::support;
@@ -45,17 +48,11 @@ enum LayoutTags {
        LT_COPYSTYLE,
        LT_DEPENDSON,
        LT_OBSOLETEDBY,
-       //LT_EMPTY,
        LT_END,
-       //LT_ENVIRONMENT_DEFAULT,
-       //LT_FANCYHDR,
-       LT_FILL_BOTTOM,
-       LT_FILL_TOP,
-       //LT_FIRST_COUNTER,
        LT_FONT,
        LT_FREE_SPACING,
        LT_PASS_THRU,
-       //LT_HEADINGS,
+       LT_PARBREAK_IS_NEWLINE,
        LT_ITEMSEP,
        LT_KEEPEMPTY,
        LT_LABEL_BOTTOMSEP,
@@ -80,7 +77,6 @@ enum LayoutTags {
        LT_PARINDENT,
        LT_PARSEP,
        LT_PARSKIP,
-       //LT_PLAIN,
        LT_PREAMBLE,
        LT_LANGPREAMBLE,
        LT_BABELPREAMBLE,
@@ -101,7 +97,12 @@ enum LayoutTags {
        LT_HTMLLABELFIRST,
        LT_HTMLPREAMBLE,
        LT_HTMLSTYLE,
-       LT_HTMLFORCEDEFAULT,
+       LT_HTMLFORCECSS,
+       LT_INPREAMBLE,
+       LT_HTMLTITLE,
+       LT_SPELLCHECK,
+       LT_REFPREFIX,
+       LT_REQARGS,
        LT_INTITLE // keep this last!
 };
 
@@ -113,7 +114,7 @@ Layout::Layout()
        margintype = MARGIN_STATIC;
        latextype = LATEX_PARAGRAPH;
        intitle = false;
-       optionalargs = 0;
+       inpreamble = false;
        needprotect = false;
        keepempty = false;
        font = inherit_font;
@@ -133,15 +134,18 @@ Layout::Layout()
        endlabeltype = END_LABEL_NO_LABEL;
        // Should or should not. That is the question.
        // spacing.set(Spacing::OneHalf);
-       fill_top = false;
-       fill_bottom = false;
        newline_allowed = true;
        free_spacing = false;
        pass_thru = false;
+       parbreak_is_newline = false;
        toclevel = NOT_IN_TOC;
        commanddepth = 0;
        htmllabelfirst_ = false;
-       htmlforcedefault_ = false;
+       htmlforcecss_ = false;
+       htmltitle_ = false;
+       spellcheck = true;
+       optargs = 0;
+       reqargs = 0;
 }
 
 
@@ -160,21 +164,21 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                { "end",            LT_END },
                { "endlabelstring", LT_ENDLABELSTRING },
                { "endlabeltype",   LT_ENDLABELTYPE },
-               { "fill_bottom",    LT_FILL_BOTTOM },
-               { "fill_top",       LT_FILL_TOP },
                { "font",           LT_FONT },
                { "freespacing",    LT_FREE_SPACING },
                { "htmlattr",       LT_HTMLATTR },
-               { "htmlforcedefault", LT_HTMLFORCEDEFAULT },
+               { "htmlforcecss",   LT_HTMLFORCECSS },
                { "htmlitem",       LT_HTMLITEM },
                { "htmlitemattr",   LT_HTMLITEMATTR },
                { "htmllabel",      LT_HTMLLABEL },
                { "htmllabelattr",  LT_HTMLLABELATTR },
                { "htmllabelfirst", LT_HTMLLABELFIRST },
-               { "htmlpremable",   LT_HTMLPREAMBLE },
+               { "htmlpreamble",   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 },
@@ -199,14 +203,18 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                { "nextnoindent",   LT_NEXTNOINDENT },
                { "obsoletedby",    LT_OBSOLETEDBY },
                { "optionalargs",   LT_OPTARGS },
+               { "parbreakisnewline", LT_PARBREAK_IS_NEWLINE },
                { "parindent",      LT_PARINDENT },
                { "parsep",         LT_PARSEP },
                { "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 }
@@ -215,6 +223,7 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
        bool error = false;
        bool finished = false;
        lex.pushTable(layoutTags);
+
        // parse style section
        while (!finished && lex.isOK() && !error) {
                int le = lex.lex();
@@ -223,7 +232,8 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                case Lexer::LEX_FEOF:
                        continue;
 
-               case Lexer::LEX_UNDEF:          // parse error
+               case Lexer::LEX_UNDEF:
+                       // parse error
                        lex.printError("Unknown layout tag `$$Token'");
                        error = true;
                        continue;
@@ -232,7 +242,7 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                        break;
                }
                switch (static_cast<LayoutTags>(le)) {
-               case LT_END:            // end of structure
+               case LT_END:
                        finished = true;
                        break;
 
@@ -240,7 +250,7 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                        lex >> category_;
                        break;
 
-               case LT_COPYSTYLE: {     // initialize with a known style
+               case LT_COPYSTYLE: {
                        docstring style;
                        lex >> style;
                        style = subst(style, '_', ' ');
@@ -261,7 +271,7 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                        break;
                        }
 
-               case LT_OBSOLETEDBY: {   // replace with a known style
+               case LT_OBSOLETEDBY: {
                        docstring style;
                        lex >> style;
                        style = subst(style, '_', ' ');
@@ -288,11 +298,11 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                        depends_on_ = subst(depends_on_, '_', ' ');
                        break;
 
-               case LT_MARGIN:         // margin style definition.
+               case LT_MARGIN:
                        readMargin(lex);
                        break;
 
-               case LT_LATEXTYPE:      // LaTeX style definition.
+               case LT_LATEXTYPE:
                        readLatexType(lex);
                        break;
 
@@ -300,12 +310,20 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                        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:
@@ -329,7 +347,7 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                        labelfont = lyxRead(lex, labelfont);
                        break;
 
-               case LT_NEXTNOINDENT:   // Indent next paragraph?
+               case LT_NEXTNOINDENT:
                        lex >> nextnoindent;
                        break;
 
@@ -378,71 +396,64 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                        readEndLabelType(lex);
                        break;
 
-               case LT_LEFTMARGIN:     // left margin type
+               case LT_LEFTMARGIN:
                        lex >> leftmargin;
                        break;
 
-               case LT_RIGHTMARGIN:    // right margin type
+               case LT_RIGHTMARGIN:
                        lex >> rightmargin;
                        break;
 
-               case LT_LABELINDENT:    // label indenting flag
+               case LT_LABELINDENT:
                        lex >> labelindent;
                        break;
 
-               case LT_PARINDENT:      // paragraph indent. flag
+               case LT_PARINDENT:
                        lex >> parindent;
                        break;
 
-               case LT_PARSKIP:        // paragraph skip size
+               case LT_PARSKIP:
                        lex >> parskip;
                        break;
 
-               case LT_ITEMSEP:        // item separation size
+               case LT_ITEMSEP:
                        lex >> itemsep;
                        break;
 
-               case LT_TOPSEP:         // top separation size
+               case LT_TOPSEP:
                        lex >> topsep;
                        break;
 
-               case LT_BOTTOMSEP:      // bottom separation size
+               case LT_BOTTOMSEP:
                        lex >> bottomsep;
                        break;
 
-               case LT_LABEL_BOTTOMSEP: // label bottom separation size
+               case LT_LABEL_BOTTOMSEP:
                        lex >> labelbottomsep;
                        break;
 
-               case LT_LABELSEP:       // label separator
+               case LT_LABELSEP:
                        lex >> labelsep;
                        labelsep = subst(labelsep, 'x', ' ');
                        break;
 
-               case LT_PARSEP:         // par. separation size
+               case LT_PARSEP:
                        lex >> parsep;
                        break;
 
-               case LT_FILL_TOP:       // fill top flag
-                       lex >> fill_top;
-                       break;
-
-               case LT_FILL_BOTTOM:    // fill bottom flag
-                       lex >> fill_bottom;
-                       break;
-
-               case LT_NEWLINE:        // newlines allowed?
+               case LT_NEWLINE:
                        lex >> newline_allowed;
                        break;
 
-               case LT_ALIGN:          // paragraph align
+               case LT_ALIGN:
                        readAlign(lex);
                        break;
-               case LT_ALIGNPOSSIBLE:  // paragraph allowed align
+       
+               case LT_ALIGNPOSSIBLE:
                        readAlignPossible(lex);
                        break;
 
-               case LT_LABELSTRING:    // label string definition
+               case LT_LABELSTRING:
                        // FIXME: this means LT_ENDLABELSTRING may only
                        // occur after LT_LABELSTRING
                        lex >> labelstring_;
@@ -450,30 +461,34 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                        labelstring_appendix_ = labelstring_;
                        break;
 
-               case LT_ENDLABELSTRING: // endlabel string definition
+               case LT_ENDLABELSTRING:
                        lex >> endlabelstring_; 
                        endlabelstring_ = trim(endlabelstring_);
                        break;
 
-               case LT_LABELSTRING_APPENDIX: // label string appendix definition
+               case LT_LABELSTRING_APPENDIX:
                        lex >> labelstring_appendix_;   
                        labelstring_appendix_ = trim(labelstring_appendix_);
                        break;
 
-               case LT_LABELCOUNTER: // name of counter to use
+               case LT_LABELCOUNTER:
                        lex >> counter; 
                        counter = trim(counter);
                        break;
 
-               case LT_FREE_SPACING:   // Allow for free spacing.
+               case LT_FREE_SPACING:
                        lex >> free_spacing;
                        break;
 
-               case LT_PASS_THRU:      // Allow for pass thru.
+               case LT_PASS_THRU:
                        lex >> pass_thru;
                        break;
 
-               case LT_SPACING: // setspace.sty
+               case LT_PARBREAK_IS_NEWLINE:
+                       lex >> parbreak_is_newline;
+                       break;
+
+               case LT_SPACING:
                        readSpacing(lex);
                        break;
 
@@ -484,6 +499,16 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                        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_;
@@ -494,7 +519,7 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                        break;
 
                case LT_HTMLITEM:
-                       lex >> htmlitem_;
+                       lex >> htmlitemtag_;
                        break;
        
                case LT_HTMLITEMATTR:
@@ -502,7 +527,7 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                        break;
        
                case LT_HTMLLABEL:
-                       lex >> htmllabel_;
+                       lex >> htmllabeltag_;
                        break;
 
                case LT_HTMLLABELATTR: 
@@ -517,18 +542,32 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                        htmlstyle_ = from_utf8(lex.getLongString("EndHTMLStyle"));
                        break;
 
-               case LT_HTMLFORCEDEFAULT:
-                       lex >> htmlforcedefault_;
+               case LT_HTMLFORCECSS:
+                       lex >> htmlforcecss_;
+                       break;
 
                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 && latextype != LATEX_PARAGRAPH) {
+               LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
+               LYXERR0("Layout name: " << name());
+               inpreamble = false;
+       }
 
-       return !error;
+       return finished && !error;
 }
 
 
@@ -822,32 +861,39 @@ void Layout::readSpacing(Lexer & lex)
 
 namespace {
 
-docstring const i18npreamble(Language const * lang, docstring const & templ)
+docstring const i18npreamble(Language const * lang, Encoding const & enc,
+                            docstring const & templ, bool const polyglossia)
 {
        if (templ.empty())
                return templ;
 
-       string preamble = subst(to_utf8(templ), "$$lang", lang->babel());
+       string preamble = polyglossia ?
+               subst(to_utf8(templ), "$$lang", lang->polyglossia()) :
+               subst(to_utf8(templ), "$$lang", lang->babel());
 
 #ifdef TEX2LYX
        // tex2lyx does not have getMessages()
        LASSERT(false, /**/);
+       (void)enc;
 #else
+       string const langenc = lang->encoding()->iconvName();
+       string const texenc = lang->encoding()->latexName();
+       string const bufenc = enc.iconvName();
+       // First and second character of plane 15 (Private Use Area)
+       string const s1 = "\xf3\xb0\x80\x80"; // U+F0000
+       string const s2 = "\xf3\xb0\x80\x81"; // U+F0001
        // FIXME UNICODE
-       // boost::regex is not unicode-safe.
+       // lyx::regex is not unicode-safe.
        // Should use QRegExp or (boost::u32regex, but that requires ICU)
-       static boost::regex const reg("_\\(([^\\)]+)\\)");
-       boost::smatch sub;
-       while (boost::regex_search(preamble, sub, reg)) {
+       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;
-               }
+               string translated = to_utf8(lang->translateLayout(key));
+               if (langenc != bufenc)
+                       translated = "\\inputencoding{" + texenc + "}"
+                               + s1 + langenc + s2 + translated
+                               + s1 + bufenc + s2;
                preamble = subst(preamble, sub.str(), translated);
        }
 #endif
@@ -857,20 +903,75 @@ docstring const i18npreamble(Language const * lang, docstring const & templ)
 }
 
 
-docstring const Layout::langpreamble(Language const * lang) const
+docstring const Layout::langpreamble(Language const * lang,
+                       Encoding const & enc, bool const polyglossia) const
 {
-       return i18npreamble(lang, langpreamble_);
+       return i18npreamble(lang, enc, langpreamble_, polyglossia);
 }
 
 
-docstring const Layout::babelpreamble(Language const * lang) const
+docstring const Layout::babelpreamble(Language const * lang,
+                       Encoding const & enc, bool const polyglossia) const
 {
-       return i18npreamble(lang, babelpreamble_);
+       return i18npreamble(lang, enc, babelpreamble_, polyglossia);
+}
+
+
+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()) {
+               if (labeltype != LABEL_TOP_ENVIRONMENT &&
+                   labeltype != LABEL_CENTERED_TOP_ENVIRONMENT)
+                       htmllabeltag_ = "span";
+               else
+                       htmllabeltag_ = "div";
+       }
+       return htmllabeltag_; 
+}
+
+
+string const & Layout::htmllabelattr() const 
+{ 
+       if (htmllabelattr_.empty())
+               htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
+       return htmllabelattr_; 
 }
 
 
 docstring Layout::htmlstyle() const {
-       if (!htmlstyle_.empty() && !htmlforcedefault_)
+       if (!htmlstyle_.empty() && !htmlforcecss_)
                return htmlstyle_;
        if (htmldefaultstyle_.empty()) 
                makeDefaultCSS();
@@ -881,9 +982,104 @@ docstring Layout::htmlstyle() const {
 }
 
 
+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) {
+               char_type const c = *it;
+               if (!isAlphaASCII(c)) {
+                       if (d.empty())
+                               // make sure we don't start with an underscore,
+                               // as that sometimes causes problems.
+                               d = from_ascii("lyx_");
+                       else
+                               d += '_';
+               } else if (islower(c))
+                       d += c;
+               else
+                       // this is slow, so do it only if necessary
+                       d += lowercase(c);
+       }
+       defaultcssclass_ = to_utf8(d);
+       return defaultcssclass_;
+}
+
+
+namespace {
+       string makeMarginValue(char const * side, double d) {
+               ostringstream os;
+               os << "margin-" << side << ": " << d << "ex;\n";
+               return os.str();
+       }
+}
+
+
 void Layout::makeDefaultCSS() const {
-// FIXME just an empty hook for now. 
-// i'll get to this shortly.
+       // this never needs to be redone, since reloading layouts will
+       // wipe out what we did before.
+       if (!htmldefaultstyle_.empty()) 
+               return;
+       
+       // main font
+       htmldefaultstyle_ = font.asCSS();
+       
+       // bottom margins
+       string tmp;
+       if (topsep > 0)
+               tmp += makeMarginValue("top", topsep);
+       if (bottomsep > 0)
+               tmp += makeMarginValue("bottom", bottomsep);
+       if (!leftmargin.empty()) {
+               // we can't really do what LyX does with the margin, so 
+               // we'll just figure out how many characters it is
+               int const len = leftmargin.length();
+               tmp += makeMarginValue("left", len);
+       }
+       if (!rightmargin.empty()) {
+               int const len = rightmargin.length();
+               tmp += makeMarginValue("right", len);
+       }
+               
+       if (!tmp.empty()) {
+               if (!htmldefaultstyle_.empty())
+                       htmldefaultstyle_ += from_ascii("\n");
+               htmldefaultstyle_ += from_ascii(tmp);
+       }
+
+// tex2lyx does not see output_xhtml.cpp
+#ifndef TEX2LYX
+       // alignment
+       string where = alignmentToCSS(align);
+       if (!where.empty()) {
+               htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
+       }
+#endif
+       
+       // wrap up what we have, if anything
+       if (!htmldefaultstyle_.empty())
+               htmldefaultstyle_ = 
+                       from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
+                       htmldefaultstyle_ + from_ascii("\n}\n");
+       
+       if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
+               return;
+       
+       docstring labelCSS;
+       
+       // label font
+       if (labelfont != font)
+               labelCSS = labelfont.asCSS() + from_ascii("\n");
+       if (labeltype == LABEL_CENTERED_TOP_ENVIRONMENT)
+               labelCSS += from_ascii("text-align: center;\n");
+       
+       if (!labelCSS.empty())
+               htmldefaultstyle_ +=
+                       from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
+                       labelCSS + from_ascii("\n}\n");
 }