]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetLayout.cpp
Initialize recently added forceownlines_ bool
[lyx.git] / src / insets / InsetLayout.cpp
index 41180c4a0cc356ad13baab91c8cbe4e70cdbba03..aa8c81be0e8e016c96807813beacb1c14f73dfe6 100644 (file)
 #include "InsetLayout.h"
 
 #include "ColorSet.h"
+#include "Layout.h"
 #include "Lexer.h"
 #include "TextClass.h"
 
 #include "support/debug.h"
 #include "support/lstrings.h"
+#include "support/textutils.h"
 
 #include <vector>
 
@@ -31,20 +33,21 @@ namespace lyx {
 
 InsetLayout::InsetLayout() :
        name_(from_ascii("undefined")), lyxtype_(STANDARD),
-       labelstring_(from_ascii("UNDEFINED")), decoration_(DEFAULT),
-       latextype_(NOLATEXTYPE), font_(sane_font), 
+       labelstring_(from_ascii("UNDEFINED")), contentaslabel_(false),
+       decoration_(DEFAULT), latextype_(NOLATEXTYPE), font_(inherit_font), 
        labelfont_(sane_font), bgcolor_(Color_error), 
        htmlforcecss_ (false), htmlisblock_(true),
        multipar_(true), custompars_(true), forceplain_(false), 
-       passthru_(false), needprotect_(false), freespacing_(false), 
-       keepempty_(false), forceltr_(false), intoc_(false)
-{ 
+       passthru_(false), parbreakisnewline_(false), freespacing_(false), 
+       keepempty_(false), forceltr_(false), 
+       needprotect_(false), intoc_(false), spellcheck_(true), 
+       resetsfont_(false), display_(true), forcelocalfontswitch_(false),
+       forceownlines_(false)
+{
        labelfont_.setColor(Color_error);
 }
 
 
-namespace {
-
 InsetLayout::InsetDecoration translateDecoration(std::string const & str) 
 {
        if (support::compare_ascii_no_case(str, "classic") == 0)
@@ -56,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)
@@ -73,13 +78,19 @@ InsetLayout::InsetLaTeXType translateLaTeXType(std::string const & str)
 bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
 {
        enum {
+               IL_ARGUMENT,
+               IL_BABELPREAMBLE,
                IL_BGCOLOR,
+               IL_CONTENTASLABEL,
                IL_COPYSTYLE,
                IL_COUNTER,
                IL_CUSTOMPARS,
                IL_DECORATION,
+               IL_DISPLAY,
                IL_FONT,
+               IL_FORCE_LOCAL_FONT_SWITCH,
                IL_FORCELTR,
+               IL_FORCEOWNLINES,
                IL_FORCEPLAIN,
                IL_FREESPACING,
                IL_HTMLTAG,
@@ -94,29 +105,44 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                IL_INTOC,
                IL_LABELFONT,
                IL_LABELSTRING,
+               IL_LANGPREAMBLE,
                IL_LATEXNAME,
                IL_LATEXPARAM,
                IL_LATEXTYPE,
+               IL_LEFTDELIM,
                IL_LYXTYPE,
+               IL_OBSOLETEDBY,
                IL_KEEPEMPTY,
                IL_MULTIPAR,
                IL_NEEDPROTECT,
                IL_PASSTHRU,
+               IL_PARBREAKISNEWLINE,
                IL_PREAMBLE,
                IL_REQUIRES,
+               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 }, 
                { "counter", IL_COUNTER},
                { "custompars", IL_CUSTOMPARS },
                { "decoration", IL_DECORATION },
+               { "display", IL_DISPLAY },
                { "end", IL_END },
                { "font", IL_FONT },
+               { "forcelocalfontswitch", IL_FORCE_LOCAL_FONT_SWITCH },
                { "forceltr", IL_FORCELTR },
+               { "forceownlines", IL_FORCEOWNLINES },
                { "forceplain", IL_FORCEPLAIN },
                { "freespacing", IL_FREESPACING },
                { "htmlattr", IL_HTMLATTR },
@@ -132,20 +158,28 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                { "keepempty", IL_KEEPEMPTY },
                { "labelfont", IL_LABELFONT },
                { "labelstring", IL_LABELSTRING },
+               { "langpreamble", IL_LANGPREAMBLE },
                { "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 },
-               { "requires", IL_REQUIRES }
+               { "refprefix", IL_REFPREFIX },
+               { "requires", IL_REQUIRES },
+               { "resetargs", IL_RESETARGS },
+               { "resetsfont", IL_RESETSFONT },
+               { "rightdelim", IL_RIGHTDELIM },
+               { "spellcheck", IL_SPELLCHECK }
        };
 
        lex.pushTable(elementTags);
 
-       FontInfo font = inherit_font;
        labelfont_ = inherit_font;
        bgcolor_ = Color_none;
        bool getout = false;
@@ -169,11 +203,21 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                // way this sort of thing is handled in Layout::read(), namely, by
                // using the Lexer.
                case IL_LYXTYPE: {
+                       // make sure that we have the right sort of name.
+                       if (name_ != from_ascii("undefined")
+                           && name_.substr(0,5) != from_ascii("Flex:")) {
+                               LYXERR0("Flex insets must have names of the form `Flex:<name>'.\n"
+                                       "This one has the name `" << to_utf8(name_) << "'\n"
+                                       "Ignoring LyXType declaration.");
+                               break;
+                       }
                        string lt;
                        lex >> lt;
                        lyxtype_ = translateLyXType(lt);
                        if (lyxtype_  == NOLYXTYPE)
                                LYXERR0("Unknown LyXType `" << lt << "'.");
+                       if (lyxtype_ == CHARSTYLE)
+                               multipar_ = false;
                        break;
                }
                case IL_LATEXTYPE:  {
@@ -198,12 +242,28 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                        lex >> tmp;
                        latexparam_ = support::subst(tmp, "&quot;", "\"");
                        break;
+               case IL_LEFTDELIM:
+                       lex >> leftdelim_;
+                       leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
+                                                   from_ascii("\n"));
+                       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;
@@ -226,10 +286,13 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                        break;
                case IL_FORCEPLAIN:
                        lex >> forceplain_;
+                       readCustomOrPlain = true;
                        break;
                case IL_PASSTHRU:
                        lex >> passthru_;
-                       readCustomOrPlain = true;
+                       break;
+               case IL_PARBREAKISNEWLINE:
+                       lex >> parbreakisnewline_;
                        break;
                case IL_KEEPEMPTY:
                        lex >> keepempty_;
@@ -240,7 +303,11 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                case IL_NEEDPROTECT:
                        lex >> needprotect_;
                        break;
-               case IL_COPYSTYLE: {     // initialize with a known style
+               case IL_CONTENTASLABEL:
+                       lex >> contentaslabel_;
+                       break;
+               case IL_COPYSTYLE: {
+                       // initialize with a known style
                        docstring style;
                        lex >> style;
                        style = support::subst(style, '_', ' ');
@@ -255,6 +322,37 @@ 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 = 
@@ -274,6 +372,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);
@@ -281,6 +390,15 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                case IL_PREAMBLE:
                        preamble_ = from_utf8(lex.getLongString("EndPreamble"));
                        break;
+               case IL_BABELPREAMBLE:
+                       babelpreamble_ = from_utf8(lex.getLongString("EndBabelPreamble"));
+                       break;
+               case IL_LANGPREAMBLE:
+                       langpreamble_ = from_utf8(lex.getLongString("EndLangPreamble"));
+                       break;
+               case IL_REFPREFIX:
+                       lex >> refprefix_;
+                       break;
                case IL_HTMLTAG:
                        lex >> htmltag_;
                        break;
@@ -315,6 +433,15 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                        requires_.insert(req.begin(), req.end());
                        break;
                }
+               case IL_SPELLCHECK:
+                       lex >> spellcheck_;
+                       break;
+               case IL_RESETSFONT:
+                       lex >> resetsfont_;
+                       break;
+               case IL_DISPLAY:
+                       lex >> display_;
+                       break;
                case IL_END:
                        getout = true;
                        break;
@@ -354,7 +481,7 @@ InsetLayout::InsetLyXType translateLyXType(std::string const & str)
 string const & InsetLayout::htmltag() const
 {
        if (htmltag_.empty())
-               htmltag_ = "span";
+               htmltag_ = multipar_ ? "div" : "span";
        return htmltag_; 
 }
 
@@ -384,9 +511,9 @@ string InsetLayout::defaultCSSClass() const
        string::const_iterator it = n.begin();
        string::const_iterator en = n.end();
        for (; it != en; ++it) {
-               if (!isalpha(*it))
+               if (!isAlphaASCII(*it))
                        d += "_";
-               else if (islower(*it))
+               else if (isLower(*it))
                        d += *it;
                else
                        d += support::lowercase(*it);
@@ -421,5 +548,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