]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetLayout.cpp
Replace hardcoded hack with InsetLayout tag
[lyx.git] / src / insets / InsetLayout.cpp
index f92a5e6ab7d4020da90156866e08ebf55eb1d986..6b30f5a37b9f5aa2a240c7f213337e633d06a443 100644 (file)
@@ -15,6 +15,7 @@
 #include "InsetLayout.h"
 
 #include "ColorSet.h"
+#include "Layout.h"
 #include "Lexer.h"
 #include "TextClass.h"
 
@@ -33,22 +34,21 @@ namespace lyx {
 InsetLayout::InsetLayout() :
        name_(from_ascii("undefined")), lyxtype_(STANDARD),
        labelstring_(from_ascii("UNDEFINED")), contentaslabel_(false),
-       decoration_(DEFAULT), latextype_(NOLATEXTYPE), font_(sane_font), 
-       labelfont_(sane_font), bgcolor_(Color_error), 
-       htmlforcecss_ (false), htmlisblock_(true),
-       multipar_(true), custompars_(true), forceplain_(false), 
-       passthru_(false), parbreakisnewline_(false), freespacing_(false), 
-       keepempty_(false), forceltr_(false), 
-       needprotect_(false), intoc_(false), spellcheck_(true), 
-       resetsfont_(true), display_(true)
-{ 
+       decoration_(DEFAULT), latextype_(NOLATEXTYPE), font_(inherit_font),
+       labelfont_(sane_font), bgcolor_(Color_error),
+       fixedwidthpreambleencoding_(false), htmlforcecss_ (false),
+       htmlisblock_(true), multipar_(true), custompars_(true),
+       forceplain_(false), passthru_(false), parbreakisnewline_(false),
+       freespacing_(false), keepempty_(false), forceltr_(false),
+       forceownlines_(false), needprotect_(false), intoc_(false),
+       spellcheck_(true), resetsfont_(false), display_(true),
+       forcelocalfontswitch_(false)
+{
        labelfont_.setColor(Color_error);
 }
 
 
-namespace {
-
-InsetLayout::InsetDecoration translateDecoration(std::string const & str) 
+InsetLayout::InsetDecoration translateDecoration(std::string const & str)
 {
        if (support::compare_ascii_no_case(str, "classic") == 0)
                return InsetLayout::CLASSIC;
@@ -59,6 +59,8 @@ InsetLayout::InsetDecoration translateDecoration(std::string const & str)
        return InsetLayout::DEFAULT;
 }
 
+namespace {
+
 InsetLayout::InsetLaTeXType translateLaTeXType(std::string const & str)
 {
        if (support::compare_ascii_no_case(str, "command") == 0)
@@ -76,6 +78,7 @@ InsetLayout::InsetLaTeXType translateLaTeXType(std::string const & str)
 bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
 {
        enum {
+               IL_ARGUMENT,
                IL_BABELPREAMBLE,
                IL_BGCOLOR,
                IL_CONTENTASLABEL,
@@ -84,8 +87,11 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                IL_CUSTOMPARS,
                IL_DECORATION,
                IL_DISPLAY,
+               IL_FIXEDWIDTH_PREAMBLE_ENCODING,
                IL_FONT,
+               IL_FORCE_LOCAL_FONT_SWITCH,
                IL_FORCELTR,
+               IL_FORCEOWNLINES,
                IL_FORCEPLAIN,
                IL_FREESPACING,
                IL_HTMLTAG,
@@ -104,7 +110,9 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                IL_LATEXNAME,
                IL_LATEXPARAM,
                IL_LATEXTYPE,
+               IL_LEFTDELIM,
                IL_LYXTYPE,
+               IL_OBSOLETEDBY,
                IL_KEEPEMPTY,
                IL_MULTIPAR,
                IL_NEEDPROTECT,
@@ -112,25 +120,31 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                IL_PARBREAKISNEWLINE,
                IL_PREAMBLE,
                IL_REQUIRES,
-               IL_SPELLCHECK,
+               IL_RIGHTDELIM,
                IL_REFPREFIX,
+               IL_RESETARGS,
                IL_RESETSFONT,
+               IL_SPELLCHECK,
                IL_END
        };
 
 
        LexerKeyword elementTags[] = {
+               { "argument", IL_ARGUMENT },
                { "babelpreamble", IL_BABELPREAMBLE },
                { "bgcolor", IL_BGCOLOR },
                { "contentaslabel", IL_CONTENTASLABEL },
-               { "copystyle", IL_COPYSTYLE }, 
+               { "copystyle", IL_COPYSTYLE },
                { "counter", IL_COUNTER},
                { "custompars", IL_CUSTOMPARS },
                { "decoration", IL_DECORATION },
                { "display", IL_DISPLAY },
                { "end", IL_END },
+               { "fixedwidthpreambleencoding", IL_FIXEDWIDTH_PREAMBLE_ENCODING },
                { "font", IL_FONT },
+               { "forcelocalfontswitch", IL_FORCE_LOCAL_FONT_SWITCH },
                { "forceltr", IL_FORCELTR },
+               { "forceownlines", IL_FORCEOWNLINES },
                { "forceplain", IL_FORCEPLAIN },
                { "freespacing", IL_FREESPACING },
                { "htmlattr", IL_HTMLATTR },
@@ -150,15 +164,19 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                { "latexname", IL_LATEXNAME },
                { "latexparam", IL_LATEXPARAM },
                { "latextype", IL_LATEXTYPE },
+               { "leftdelim", IL_LEFTDELIM },
                { "lyxtype", IL_LYXTYPE },
                { "multipar", IL_MULTIPAR },
                { "needprotect", IL_NEEDPROTECT },
+               { "obsoletedby", IL_OBSOLETEDBY },
                { "parbreakisnewline", IL_PARBREAKISNEWLINE },
                { "passthru", IL_PASSTHRU },
                { "preamble", IL_PREAMBLE },
                { "refprefix", IL_REFPREFIX },
                { "requires", IL_REQUIRES },
+               { "resetargs", IL_RESETARGS },
                { "resetsfont", IL_RESETSFONT },
+               { "rightdelim", IL_RIGHTDELIM },
                { "spellcheck", IL_SPELLCHECK }
        };
 
@@ -171,7 +189,7 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
        // for issuing a warning in case MultiPars comes later
        bool readCustomOrPlain = false;
 
-       string tmp;     
+       string tmp;
        while (!getout && lex.isOK()) {
                int le = lex.lex();
                switch (le) {
@@ -226,12 +244,31 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                        lex >> tmp;
                        latexparam_ = support::subst(tmp, """, "\"");
                        break;
+               case IL_LEFTDELIM:
+                       lex >> leftdelim_;
+                       leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
+                                                   from_ascii("\n"));
+                       break;
+               case IL_FIXEDWIDTH_PREAMBLE_ENCODING:
+                       lex >> fixedwidthpreambleencoding_;
+                       break;
+               case IL_FORCE_LOCAL_FONT_SWITCH:
+                       lex >> forcelocalfontswitch_;
+                       break;
+               case IL_RIGHTDELIM:
+                       lex >> rightdelim_;
+                       rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
+                                                    from_ascii("\n"));
+                       break;
                case IL_LABELFONT:
                        labelfont_ = lyxRead(lex, inherit_font);
                        break;
                case IL_FORCELTR:
                        lex >> forceltr_;
                        break;
+               case IL_FORCEOWNLINES:
+                       lex >> forceownlines_;
+                       break;
                case IL_INTOC:
                        lex >> intoc_;
                        break;
@@ -282,7 +319,7 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
 
                        // We don't want to apply the algorithm in DocumentClass::insetLayout()
                        // here. So we do it the long way.
-                       TextClass::InsetLayouts::const_iterator it = 
+                       TextClass::InsetLayouts::const_iterator it =
                                        tclass.insetLayouts().find(style);
                        if (it != tclass.insetLayouts().end()) {
                                docstring const tmpname = name_;
@@ -290,11 +327,42 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                                name_ = tmpname;
                        } else {
                                LYXERR0("Cannot copy unknown InsetLayout `"
+                                       << style << "' to InsetLayout `"
+                                       << name() << "'\n"
+                                       << "All InsetLayouts so far:");
+                               TextClass::InsetLayouts::const_iterator lit =
+                                               tclass.insetLayouts().begin();
+                               TextClass::InsetLayouts::const_iterator len =
+                                               tclass.insetLayouts().end();
+                               for (; lit != len; ++lit)
+                                       lyxerr << lit->second.name() << "\n";
+                       }
+                       break;
+               }
+               case IL_OBSOLETEDBY: {
+                       docstring style;
+                       lex >> style;
+                       style = support::subst(style, '_', ' ');
+
+                       // We don't want to apply the algorithm in DocumentClass::insetLayout()
+                       // here. So we do it the long way.
+                       TextClass::InsetLayouts::const_iterator it =
+                                       tclass.insetLayouts().find(style);
+                       if (it != tclass.insetLayouts().end()) {
+                               docstring const tmpname = name_;
+                               this->operator=(it->second);
+                               name_ = tmpname;
+                               if (obsoleted_by().empty())
+                                       obsoleted_by_ = style;
+                       } else {
+                               LYXERR0("Cannot replace InsetLayout `"
+                                       << name()
+                                       << "' with unknown InsetLayout `"
                                        << style << "'\n"
                                        << "All InsetLayouts so far:");
-                               TextClass::InsetLayouts::const_iterator lit = 
+                               TextClass::InsetLayouts::const_iterator lit =
                                                tclass.insetLayouts().begin();
-                               TextClass::InsetLayouts::const_iterator len = 
+                               TextClass::InsetLayouts::const_iterator len =
                                                tclass.insetLayouts().end();
                                for (; lit != len; ++lit)
                                        lyxerr << lit->second.name() << "\n";
@@ -309,6 +377,17 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                        labelfont_ = font_;
                        break;
                }
+               case IL_RESETARGS:
+                       bool reset;
+                       lex >> reset;
+                       if (reset) {
+                               latexargs_.clear();
+                               postcommandargs_.clear();
+                       }
+                       break;
+               case IL_ARGUMENT:
+                       readArgument(lex);
+                       break;
                case IL_BGCOLOR:
                        lex >> tmp;
                        bgcolor_ = lcolor.getFromLyXName(tmp);
@@ -354,7 +433,7 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                        break;
                case IL_REQUIRES: {
                        lex.eatLine();
-                       vector<string> const req 
+                       vector<string> const req
                                = support::getVectorFromString(lex.getString());
                        requires_.insert(req.begin(), req.end());
                        break;
@@ -377,7 +456,7 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
        // Here add element to list if getout == true
        if (!getout)
                return false;
-       
+
        // The label font is generally used as-is without
        // any realization against a given context.
        labelfont_.realize(sane_font);
@@ -387,9 +466,8 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
 }
 
 
-InsetLayout::InsetLyXType translateLyXType(std::string const & str) 
+InsetLayout::InsetLyXType translateLyXType(std::string const & str)
 {
-       
        if (support::compare_ascii_no_case(str, "charstyle") == 0)
                return InsetLayout::CHARSTYLE;
        if (support::compare_ascii_no_case(str, "custom") == 0)
@@ -408,7 +486,7 @@ string const & InsetLayout::htmltag() const
 {
        if (htmltag_.empty())
                htmltag_ = multipar_ ? "div" : "span";
-       return htmltag_; 
+       return htmltag_;
 }
 
 
@@ -416,7 +494,7 @@ string const & InsetLayout::htmlattr() const
 {
        if (htmlattr_.empty())
                htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
-       return htmlattr_; 
+       return htmlattr_;
 }
 
 
@@ -424,12 +502,12 @@ string const & InsetLayout::htmlinnerattr() const
 {
        if (htmlinnerattr_.empty())
                htmlinnerattr_ = "class=\"" + defaultCSSClass() + "_inner\"";
-       return htmlinnerattr_; 
+       return htmlinnerattr_;
 }
 
 
 string InsetLayout::defaultCSSClass() const
-{ 
+{
        if (!defaultcssclass_.empty())
                return defaultcssclass_;
        string d;
@@ -452,18 +530,18 @@ string InsetLayout::defaultCSSClass() const
 
 void InsetLayout::makeDefaultCSS() const
 {
-       if (!htmldefaultstyle_.empty()) 
+       if (!htmldefaultstyle_.empty())
                return;
        docstring const mainfontCSS = font_.asCSS();
        if (!mainfontCSS.empty())
-               htmldefaultstyle_ = 
+               htmldefaultstyle_ =
                                from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
                                mainfontCSS + from_ascii("\n}\n");
 }
 
 
-docstring InsetLayout::htmlstyle() const 
-{ 
+docstring InsetLayout::htmlstyle() const
+{
        if (!htmlstyle_.empty() && !htmlforcecss_)
                return htmlstyle_;
        if (htmldefaultstyle_.empty())
@@ -474,5 +552,114 @@ docstring InsetLayout::htmlstyle() const
        return retval;
 }
 
+void InsetLayout::readArgument(Lexer & lex)
+{
+       Layout::latexarg arg;
+       arg.mandatory = false;
+       arg.autoinsert = false;
+       bool error = false;
+       bool finished = false;
+       arg.font = inherit_font;
+       arg.labelfont = inherit_font;
+       string nr;
+       lex >> nr;
+       bool const postcmd = support::prefixIs(nr, "post:");
+       while (!finished && lex.isOK() && !error) {
+               lex.next();
+               string const tok = support::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 == "menustring") {
+                       lex.next();
+                       arg.menustring = lex.getDocString();
+               } else if (tok == "mandatory") {
+                       lex.next();
+                       arg.mandatory = lex.getBool();
+               } else if (tok == "autoinsert") {
+                       lex.next();
+                       arg.autoinsert = 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 == "defaultarg") {
+                       lex.next();
+                       arg.defaultarg = lex.getDocString();
+               } else if (tok == "presetarg") {
+                       lex.next();
+                       arg.presetarg = lex.getDocString();
+               } 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;
+               }
+       }
+       if (arg.labelstring.empty())
+               LYXERR0("Incomplete Argument definition!");
+       else if (postcmd)
+               postcommandargs_[nr] = arg;
+       else
+               latexargs_[nr] = arg;
+}
+
+
+Layout::LaTeXArgMap InsetLayout::args() const
+{
+       Layout::LaTeXArgMap args = latexargs_;
+       if (!postcommandargs_.empty())
+               args.insert(postcommandargs_.begin(), postcommandargs_.end());
+       return args;
+}
+
+
+unsigned int InsetLayout::optArgs() const
+{
+       unsigned int nr = 0;
+       Layout::LaTeXArgMap const args = InsetLayout::args();
+       Layout::LaTeXArgMap::const_iterator it = args.begin();
+       for (; it != args.end(); ++it) {
+               if (!(*it).second.mandatory)
+                       ++nr;
+       }
+       return nr;
+}
+
+
+unsigned int InsetLayout::requiredArgs() const
+{
+       unsigned int nr = 0;
+       Layout::LaTeXArgMap const args = InsetLayout::args();
+       Layout::LaTeXArgMap::const_iterator it = args.begin();
+       for (; it != args.end(); ++it) {
+               if ((*it).second.mandatory)
+                       ++nr;
+       }
+       return nr;
+}
+
 
 } //namespace lyx