]> git.lyx.org Git - lyx.git/blobdiff - src/Layout.cpp
Fix shaded box UI color (#7395) as good as it gets ATM
[lyx.git] / src / Layout.cpp
index daf298f509d33dd959d5d64e464222b96575f2f3..2ff77edafcb82ef36e2dea01e762f576441cc779 100644 (file)
@@ -13,6 +13,7 @@
 #include <config.h>
 
 #include "Layout.h"
+#include "Encoding.h"
 #include "FontInfo.h"
 #include "Language.h"
 #include "Lexer.h"
@@ -23,8 +24,8 @@
 #include "support/lassert.h"
 #include "support/lstrings.h"
 #include "support/Messages.h"
+#include "support/textutils.h"
 
-#include "support/regex.h"
 
 using namespace std;
 using namespace lyx::support;
@@ -39,6 +40,7 @@ const int Layout::NOT_IN_TOC = -1000;
 enum LayoutTags {
        LT_ALIGN = 1,
        LT_ALIGNPOSSIBLE,
+       LT_ARGUMENT,
        LT_MARGIN,
        LT_BOTTOMSEP,
        LT_CATEGORY,
@@ -46,18 +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_PARBREAK_IS_NEWLINE,
-       //LT_HEADINGS,
        LT_ITEMSEP,
        LT_KEEPEMPTY,
        LT_LABEL_BOTTOMSEP,
@@ -73,8 +68,8 @@ enum LayoutTags {
        LT_ENDLABELTYPE,
        LT_LATEXNAME,
        LT_LATEXPARAM,
-       LT_OPTARGS,
        LT_LATEXTYPE,
+       LT_LEFTDELIM,
        LT_LEFTMARGIN,
        LT_NEED_PROTECT,
        LT_NEWLINE,
@@ -82,7 +77,6 @@ enum LayoutTags {
        LT_PARINDENT,
        LT_PARSEP,
        LT_PARSKIP,
-       //LT_PLAIN,
        LT_PREAMBLE,
        LT_LANGPREAMBLE,
        LT_BABELPREAMBLE,
@@ -108,7 +102,8 @@ enum LayoutTags {
        LT_HTMLTITLE,
        LT_SPELLCHECK,
        LT_REFPREFIX,
-       LT_REQARGS,
+       LT_RESETARGS,
+       LT_RIGHTDELIM,
        LT_INTITLE // keep this last!
 };
 
@@ -140,8 +135,6 @@ 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;
@@ -152,8 +145,6 @@ Layout::Layout()
        htmlforcecss_ = false;
        htmltitle_ = false;
        spellcheck = true;
-       optargs = 0;
-       reqargs = 0;
 }
 
 
@@ -163,6 +154,7 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
        LexerKeyword layoutTags[] = {
                { "align",          LT_ALIGN },
                { "alignpossible",  LT_ALIGNPOSSIBLE },
+               { "argument",       LT_ARGUMENT },
                { "babelpreamble",  LT_BABELPREAMBLE },
                { "bottomsep",      LT_BOTTOMSEP },
                { "category",       LT_CATEGORY },
@@ -172,8 +164,6 @@ 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 },
@@ -183,7 +173,7 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                { "htmllabel",      LT_HTMLLABEL },
                { "htmllabelattr",  LT_HTMLLABELATTR },
                { "htmllabelfirst", LT_HTMLLABELFIRST },
-               { "htmlpremable",   LT_HTMLPREAMBLE },
+               { "htmlpreamble",   LT_HTMLPREAMBLE },
                { "htmlstyle",      LT_HTMLSTYLE },
                { "htmltag",        LT_HTMLTAG },
                { "htmltitle",      LT_HTMLTITLE },
@@ -206,13 +196,13 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                { "latexname",      LT_LATEXNAME },
                { "latexparam",     LT_LATEXPARAM },
                { "latextype",      LT_LATEXTYPE },
+               { "leftdelim",      LT_LEFTDELIM },
                { "leftmargin",     LT_LEFTMARGIN },
                { "margin",         LT_MARGIN },
                { "needprotect",    LT_NEED_PROTECT },
                { "newline",        LT_NEWLINE },
                { "nextnoindent",   LT_NEXTNOINDENT },
                { "obsoletedby",    LT_OBSOLETEDBY },
-               { "optionalargs",   LT_OPTARGS },
                { "parbreakisnewline", LT_PARBREAK_IS_NEWLINE },
                { "parindent",      LT_PARINDENT },
                { "parsep",         LT_PARSEP },
@@ -220,8 +210,9 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                { "passthru",       LT_PASS_THRU },
                { "preamble",       LT_PREAMBLE },
                { "refprefix",      LT_REFPREFIX },
-               { "requiredargs",   LT_REQARGS },
                { "requires",       LT_REQUIRES },
+               { "resetargs",      LT_RESETARGS },
+               { "rightdelim",     LT_RIGHTDELIM },
                { "rightmargin",    LT_RIGHTMARGIN },
                { "spacing",        LT_SPACING },
                { "spellcheck",     LT_SPELLCHECK },
@@ -233,6 +224,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();
@@ -241,7 +233,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;
@@ -250,7 +243,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;
 
@@ -258,7 +251,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, '_', ' ');
@@ -279,7 +272,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, '_', ' ');
@@ -306,11 +299,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;
 
@@ -326,12 +319,17 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                        lex >> toclevel;
                        break;
 
-               case LT_OPTARGS:
-                       lex >> optargs;
+               case LT_RESETARGS:
+                       bool reset;
+                       lex >> reset;
+                       if (reset) {
+                               latexargs_.clear();
+                               itemargs_.clear();
+                       }
                        break;
 
-               case LT_REQARGS:
-                       lex >> reqargs;
+               case LT_ARGUMENT:
+                       readArgument(lex);
                        break;
 
                case LT_NEED_PROTECT:
@@ -355,7 +353,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;
 
@@ -372,6 +370,18 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                        latexparam_ = subst(latexparam_, "&quot;", "\"");
                        break;
 
+               case LT_LEFTDELIM:
+                       lex >> leftdelim_;
+                       leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
+                                                   from_ascii("\n"));
+                       break;
+
+               case LT_RIGHTDELIM:
+                       lex >> rightdelim_;
+                       rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
+                                                    from_ascii("\n"));
+                       break;
+
                case LT_INNERTAG:
                        lex >> innertag_;
                        break;
@@ -404,71 +414,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_;
@@ -476,26 +479,26 @@ 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;
 
@@ -503,7 +506,7 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
                        lex >> parbreak_is_newline;
                        break;
 
-               case LT_SPACING: // setspace.sty
+               case LT_SPACING:
                        readSpacing(lex);
                        break;
 
@@ -576,8 +579,8 @@ bool Layout::read(Lexer & lex, TextClass const & tclass)
        }
        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.");
+       if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
+               LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
                LYXERR0("Layout name: " << name());
                inpreamble = false;
        }
@@ -874,52 +877,90 @@ void Layout::readSpacing(Lexer & lex)
 }
 
 
-namespace {
-
-docstring const i18npreamble(Language const * lang, docstring const & templ)
+void Layout::readArgument(Lexer & lex)
 {
-       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;
+       latexarg arg;
+       arg.mandatory = false;
+       bool error = false;
+       bool finished = false;
+       arg.font = inherit_font;
+       arg.labelfont = inherit_font;
+       string id;
+       lex >> id;
+       bool const itemarg = prefixIs(id, "item:");
+
+       while (!finished && lex.isOK() && !error) {
+               lex.next();
+               string const tok = ascii_lowercase(lex.getString());
+
+               if (tok.empty()) {
+                       continue;
+               } else if (tok == "endargument") {
+                       finished = true;
+               } else if (tok == "labelstring") {
+                       lex.next();
+                       arg.labelstring = lex.getDocString();
+               } else if (tok == "mandatory") {
+                       lex.next();
+                       arg.mandatory = lex.getBool();
+               } else if (tok == "leftdelim") {
+                       lex.next();
+                       arg.ldelim = lex.getDocString();
+                       arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
+                                                   from_ascii("\n"));
+               } else if (tok == "rightdelim") {
+                       lex.next();
+                       arg.rdelim = lex.getDocString();
+                       arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
+                                                   from_ascii("\n"));
+               } else if (tok == "tooltip") {
+                       lex.next();
+                       arg.tooltip = lex.getDocString();
+               } else if (tok == "requires") {
+                       lex.next();
+                       arg.requires = lex.getString();
+               } else if (tok == "decoration") {
+                       lex.next();
+                       arg.decoration = lex.getString();
+               } else if (tok == "font") {
+                       arg.font = lyxRead(lex, arg.font);
+               } else if (tok == "labelfont") {
+                       arg.labelfont = lyxRead(lex, arg.labelfont);
+               } else {
+                       lex.printError("Unknown tag");
+                       error = true;
                }
-               preamble = subst(preamble, sub.str(), translated);
        }
-#endif
-       return from_utf8(preamble);
-}
-
+       if (arg.labelstring.empty())
+               LYXERR0("Incomplete Argument definition!");
+       else if (itemarg)
+               itemargs_[id] = arg;
+       else
+               latexargs_[id] = arg;
 }
 
 
-docstring const Layout::langpreamble(Language const * lang) const
+int Layout::optArgs() const
 {
-       return i18npreamble(lang, langpreamble_);
+       int nr = 0;
+       LaTeXArgMap::const_iterator it = latexargs_.begin();
+       for (; it != latexargs_.end(); ++it) {
+               if (!(*it).second.mandatory)
+                       ++nr;
+       }
+       return nr;
 }
 
 
-docstring const Layout::babelpreamble(Language const * lang) const
+int Layout::requiredArgs() const
 {
-       return i18npreamble(lang, babelpreamble_);
+       int nr = 0;
+       LaTeXArgMap::const_iterator it = latexargs_.begin();
+       for (; it != latexargs_.end(); ++it) {
+               if ((*it).second.mandatory)
+                       ++nr;
+       }
+       return nr;
 }
 
 
@@ -957,8 +998,13 @@ string const & Layout::htmlitemattr() const
 
 string const & Layout::htmllabeltag() const 
 { 
-       if (htmllabeltag_.empty())
-               htmllabeltag_ = "span";
+       if (htmllabeltag_.empty()) {
+               if (labeltype != LABEL_TOP_ENVIRONMENT &&
+                   labeltype != LABEL_CENTERED_TOP_ENVIRONMENT)
+                       htmllabeltag_ = "span";
+               else
+                       htmllabeltag_ = "div";
+       }
        return htmllabeltag_; 
 }
 
@@ -971,7 +1017,8 @@ string const & Layout::htmllabelattr() const
 }
 
 
-docstring Layout::htmlstyle() const {
+docstring Layout::htmlstyle() const
+{
        if (!htmlstyle_.empty() && !htmlforcecss_)
                return htmlstyle_;
        if (htmldefaultstyle_.empty()) 
@@ -991,29 +1038,39 @@ string Layout::defaultCSSClass() const
        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);
+               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);
        }
-       // are there other characters we need to remove?
        defaultcssclass_ = to_utf8(d);
        return defaultcssclass_;
 }
 
 
 namespace {
-       string makeMarginValue(double d) {
-               ostringstream os;
-               os << d << "ex";
-               return os.str();
-       }
+
+string makeMarginValue(char const * side, double d)
+{
+       ostringstream os;
+       os << "margin-" << side << ": " << d << "ex;\n";
+       return os.str();
 }
 
+}
 
-void Layout::makeDefaultCSS() const {
+
+void Layout::makeDefaultCSS() const
+{
        // this never needs to be redone, since reloading layouts will
        // wipe out what we did before.
        if (!htmldefaultstyle_.empty()) 
@@ -1022,12 +1079,23 @@ void Layout::makeDefaultCSS() const {
        // main font
        htmldefaultstyle_ = font.asCSS();
        
-       // top and bottom margins
+       // bottom margins
        string tmp;
        if (topsep > 0)
-               tmp += "margin-top: " + makeMarginValue(topsep) + ";\n";
+               tmp += makeMarginValue("top", topsep);
        if (bottomsep > 0)
-               tmp += "margin-bottom: " + makeMarginValue(bottomsep) + ";\n";
+               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");
@@ -1049,15 +1117,21 @@ void Layout::makeDefaultCSS() const {
                        from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
                        htmldefaultstyle_ + from_ascii("\n}\n");
        
-       if (labelfont == font || htmllabeltag() == "NONE")
+       if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
                return;
        
+       docstring labelCSS;
+       
        // label font
-       docstring const labelfontCSS = labelfont.asCSS();
-       if (!labelfontCSS.empty())
+       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") +
-                       labelfontCSS + from_ascii("\n}\n");
+                       labelCSS + from_ascii("\n}\n");
 }