]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetLayout.cpp
requires is a keyword in C++2a
[lyx.git] / src / insets / InsetLayout.cpp
index 6e081d94da162fbf4eaf70593fd1d4db3c273530..8df2ca5e8b7805a4473f7baccb283721c4aef345 100644 (file)
@@ -29,6 +29,8 @@ using std::string;
 using std::set;
 using std::vector;
 
+using namespace lyx::support;
+
 namespace lyx {
 
 InsetLayout::InsetLayout() :
@@ -39,10 +41,11 @@ InsetLayout::InsetLayout() :
        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)
+       parbreakignored_(false), freespacing_(false), keepempty_(false), forceltr_(false),
+       forceownlines_(false), needprotect_(false), needcprotect_(false),
+       needmboxprotect_(false), intoc_(false), spellcheck_(true),
+       resetsfont_(false), display_(true), forcelocalfontswitch_(false),
+       add_to_toc_(false), is_toc_caption_(false), edit_external_(false)
 {
        labelfont_.setColor(Color_error);
 }
@@ -50,11 +53,11 @@ InsetLayout::InsetLayout() :
 
 InsetLayout::InsetDecoration translateDecoration(std::string const & str)
 {
-       if (support::compare_ascii_no_case(str, "classic") == 0)
+       if (compare_ascii_no_case(str, "classic") == 0)
                return InsetLayout::CLASSIC;
-       if (support::compare_ascii_no_case(str, "minimalistic") == 0)
+       if (compare_ascii_no_case(str, "minimalistic") == 0)
                return InsetLayout::MINIMALISTIC;
-       if (support::compare_ascii_no_case(str, "conglomerate") == 0)
+       if (compare_ascii_no_case(str, "conglomerate") == 0)
                return InsetLayout::CONGLOMERATE;
        return InsetLayout::DEFAULT;
 }
@@ -63,21 +66,23 @@ namespace {
 
 InsetLayout::InsetLaTeXType translateLaTeXType(std::string const & str)
 {
-       if (support::compare_ascii_no_case(str, "command") == 0)
+       if (compare_ascii_no_case(str, "command") == 0)
                return InsetLayout::COMMAND;
-       if (support::compare_ascii_no_case(str, "environment") == 0)
+       if (compare_ascii_no_case(str, "environment") == 0)
                return InsetLayout::ENVIRONMENT;
-       if (support::compare_ascii_no_case(str, "none") == 0)
+       if (compare_ascii_no_case(str, "none") == 0)
                return InsetLayout::NOLATEXTYPE;
        return InsetLayout::ILT_ERROR;
 }
 
-} // namespace anon
+} // namespace
 
 
-bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
+bool InsetLayout::read(Lexer & lex, TextClass const & tclass,
+       bool validating)
 {
        enum {
+               IL_ADDTOTOC,
                IL_ARGUMENT,
                IL_BABELPREAMBLE,
                IL_BGCOLOR,
@@ -87,6 +92,7 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                IL_CUSTOMPARS,
                IL_DECORATION,
                IL_DISPLAY,
+               IL_EDITEXTERNAL,
                IL_FIXEDWIDTH_PREAMBLE_ENCODING,
                IL_FONT,
                IL_FORCE_LOCAL_FONT_SWITCH,
@@ -104,6 +110,7 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                IL_HTMLSTYLE,
                IL_HTMLPREAMBLE,
                IL_INTOC,
+               IL_ISTOCCAPTION,
                IL_LABELFONT,
                IL_LABELSTRING,
                IL_LANGPREAMBLE,
@@ -114,10 +121,15 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                IL_LYXTYPE,
                IL_OBSOLETEDBY,
                IL_KEEPEMPTY,
+               IL_MENUSTRING,
                IL_MULTIPAR,
+               IL_NEEDCPROTECT,
+               IL_NEEDMBOXPROTECT,
                IL_NEEDPROTECT,
+               IL_NEWLINE_CMD,
                IL_PASSTHRU,
                IL_PASSTHRU_CHARS,
+               IL_PARBREAKIGNORED,
                IL_PARBREAKISNEWLINE,
                IL_PREAMBLE,
                IL_REQUIRES,
@@ -131,6 +143,7 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
 
 
        LexerKeyword elementTags[] = {
+               { "addtotoc", IL_ADDTOTOC },
                { "argument", IL_ARGUMENT },
                { "babelpreamble", IL_BABELPREAMBLE },
                { "bgcolor", IL_BGCOLOR },
@@ -140,6 +153,7 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                { "custompars", IL_CUSTOMPARS },
                { "decoration", IL_DECORATION },
                { "display", IL_DISPLAY },
+               { "editexternal", IL_EDITEXTERNAL },
                { "end", IL_END },
                { "fixedwidthpreambleencoding", IL_FIXEDWIDTH_PREAMBLE_ENCODING },
                { "font", IL_FONT },
@@ -158,6 +172,7 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                { "htmlstyle", IL_HTMLSTYLE },
                { "htmltag", IL_HTMLTAG },
                { "intoc", IL_INTOC },
+               { "istoccaption", IL_ISTOCCAPTION },
                { "keepempty", IL_KEEPEMPTY },
                { "labelfont", IL_LABELFONT },
                { "labelstring", IL_LABELSTRING },
@@ -167,9 +182,14 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                { "latextype", IL_LATEXTYPE },
                { "leftdelim", IL_LEFTDELIM },
                { "lyxtype", IL_LYXTYPE },
+               { "menustring", IL_MENUSTRING },
                { "multipar", IL_MULTIPAR },
+               { "needcprotect", IL_NEEDCPROTECT },
+               { "needmboxprotect", IL_NEEDMBOXPROTECT },
                { "needprotect", IL_NEEDPROTECT },
+               { "newlinecmd", IL_NEWLINE_CMD },
                { "obsoletedby", IL_OBSOLETEDBY },
+               { "parbreakignored", IL_PARBREAKIGNORED },
                { "parbreakisnewline", IL_PARBREAKISNEWLINE },
                { "passthru", IL_PASSTHRU },
                { "passthruchars", IL_PASSTHRU_CHARS },
@@ -197,6 +217,8 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                switch (le) {
                case Lexer::LEX_UNDEF:
                        lex.printError("Unknown InsetLayout tag");
+                       if (validating)
+                               return false;
                        continue;
                default:
                        break;
@@ -213,28 +235,45 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                                LYXERR0("Flex insets must have names of the form `Flex:<name>'.\n"
                                        "This one has the name `" << to_utf8(name_) << "'\n"
                                        "Ignoring LyXType declaration.");
+                               // this is not really a reason to abort
+                               if (validating)
+                                       return false;
                                break;
                        }
                        string lt;
                        lex >> lt;
                        lyxtype_ = translateLyXType(lt);
-                       if (lyxtype_  == NOLYXTYPE)
+                       if (lyxtype_  == NOLYXTYPE) {
                                LYXERR0("Unknown LyXType `" << lt << "'.");
-                       if (lyxtype_ == CHARSTYLE)
+                               // this is not really a reason to abort
+                               if (validating)
+                                       return false;
+                       }
+                       if (lyxtype_ == CHARSTYLE) {
+                               // by default, charstyles force the plain layout
                                multipar_ = false;
+                               forceplain_ = true;
+                       }
                        break;
                }
                case IL_LATEXTYPE:  {
                        string lt;
                        lex >> lt;
                        latextype_ = translateLaTeXType(lt);
-                       if (latextype_  == ILT_ERROR)
+                       if (latextype_  == ILT_ERROR) {
                                LYXERR0("Unknown LaTeXType `" << lt << "'.");
+                               // this is not really a reason to abort
+                               if (validating)
+                                       return false;
+                       }
                        break;
                }
                case IL_LABELSTRING:
                        lex >> labelstring_;
                        break;
+               case IL_MENUSTRING:
+                       lex >> menustring_;
+                       break;
                case IL_DECORATION:
                        lex >> tmp;
                        decoration_ = translateDecoration(tmp);
@@ -244,11 +283,11 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                        break;
                case IL_LATEXPARAM:
                        lex >> tmp;
-                       latexparam_ = support::subst(tmp, "&quot;", "\"");
+                       latexparam_ = subst(tmp, "&quot;", "\"");
                        break;
                case IL_LEFTDELIM:
                        lex >> leftdelim_;
-                       leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
+                       leftdelim_ = subst(leftdelim_, from_ascii("<br/>"),
                                                    from_ascii("\n"));
                        break;
                case IL_FIXEDWIDTH_PREAMBLE_ENCODING:
@@ -259,7 +298,7 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                        break;
                case IL_RIGHTDELIM:
                        lex >> rightdelim_;
-                       rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
+                       rightdelim_ = subst(rightdelim_, from_ascii("<br/>"),
                                                     from_ascii("\n"));
                        break;
                case IL_LABELFONT:
@@ -301,6 +340,12 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                case IL_PASSTHRU_CHARS:
                        lex >> passthru_chars_;
                        break;
+               case IL_NEWLINE_CMD:
+                       lex >> newline_cmd_;
+                       break;
+               case IL_PARBREAKIGNORED:
+                       lex >> parbreakignored_;
+                       break;
                case IL_PARBREAKISNEWLINE:
                        lex >> parbreakisnewline_;
                        break;
@@ -313,6 +358,12 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                case IL_NEEDPROTECT:
                        lex >> needprotect_;
                        break;
+               case IL_NEEDCPROTECT:
+                       lex >> needcprotect_;
+                       break;
+               case IL_NEEDMBOXPROTECT:
+                       lex >> needmboxprotect_;
+                       break;
                case IL_CONTENTASLABEL:
                        lex >> contentaslabel_;
                        break;
@@ -320,7 +371,7 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                        // initialize with a known style
                        docstring style;
                        lex >> style;
-                       style = support::subst(style, '_', ' ');
+                       style = subst(style, '_', ' ');
 
                        // We don't want to apply the algorithm in DocumentClass::insetLayout()
                        // here. So we do it the long way.
@@ -341,13 +392,16 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                                                tclass.insetLayouts().end();
                                for (; lit != len; ++lit)
                                        lyxerr << lit->second.name() << "\n";
+                               // this is not really a reason to abort
+                               if (validating)
+                                       return false;
                        }
                        break;
                }
                case IL_OBSOLETEDBY: {
                        docstring style;
                        lex >> style;
-                       style = support::subst(style, '_', ' ');
+                       style = subst(style, '_', ' ');
 
                        // We don't want to apply the algorithm in DocumentClass::insetLayout()
                        // here. So we do it the long way.
@@ -371,6 +425,9 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                                                tclass.insetLayouts().end();
                                for (; lit != len; ++lit)
                                        lyxerr << lit->second.name() << "\n";
+                               // this is not really a reason to abort
+                               if (validating)
+                                       return false;
                        }
                        break;
                }
@@ -398,13 +455,13 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                        bgcolor_ = lcolor.getFromLyXName(tmp);
                        break;
                case IL_PREAMBLE:
-                       preamble_ = from_utf8(lex.getLongString("EndPreamble"));
+                       preamble_ = lex.getLongString(from_ascii("EndPreamble"));
                        break;
                case IL_BABELPREAMBLE:
-                       babelpreamble_ = from_utf8(lex.getLongString("EndBabelPreamble"));
+                       babelpreamble_ = lex.getLongString(from_ascii("EndBabelPreamble"));
                        break;
                case IL_LANGPREAMBLE:
-                       langpreamble_ = from_utf8(lex.getLongString("EndLangPreamble"));
+                       langpreamble_ = lex.getLongString(from_ascii("EndLangPreamble"));
                        break;
                case IL_REFPREFIX:
                        lex >> refprefix_;
@@ -431,15 +488,15 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                        lex >> htmlisblock_;
                        break;
                case IL_HTMLSTYLE:
-                       htmlstyle_ = from_utf8(lex.getLongString("EndHTMLStyle"));
+                       htmlstyle_ = lex.getLongString(from_ascii("EndHTMLStyle"));
                        break;
                case IL_HTMLPREAMBLE:
-                       htmlpreamble_ = from_utf8(lex.getLongString("EndPreamble"));
+                       htmlpreamble_ = lex.getLongString(from_ascii("EndPreamble"));
                        break;
                case IL_REQUIRES: {
                        lex.eatLine();
                        vector<string> const req
-                               = support::getVectorFromString(lex.getString());
+                               = getVectorFromString(lex.getString(true));
                        requires_.insert(req.begin(), req.end());
                        break;
                }
@@ -452,6 +509,16 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
                case IL_DISPLAY:
                        lex >> display_;
                        break;
+               case IL_ADDTOTOC:
+                       lex >> toc_type_;
+                       add_to_toc_ = !toc_type_.empty();
+                       break;
+               case IL_ISTOCCAPTION:
+                       lex >> is_toc_caption_;
+                       break;
+               case IL_EDITEXTERNAL:
+                       lex >> edit_external_;
+                       break;
                case IL_END:
                        getout = true;
                        break;
@@ -473,15 +540,15 @@ bool InsetLayout::read(Lexer & lex, TextClass const & tclass)
 
 InsetLayout::InsetLyXType translateLyXType(std::string const & str)
 {
-       if (support::compare_ascii_no_case(str, "charstyle") == 0)
+       if (compare_ascii_no_case(str, "charstyle") == 0)
                return InsetLayout::CHARSTYLE;
-       if (support::compare_ascii_no_case(str, "custom") == 0)
+       if (compare_ascii_no_case(str, "custom") == 0)
                return InsetLayout::CUSTOM;
-       if (support::compare_ascii_no_case(str, "element") == 0)
+       if (compare_ascii_no_case(str, "element") == 0)
                return InsetLayout::ELEMENT;
-       if (support::compare_ascii_no_case(str, "end") == 0)
+       if (compare_ascii_no_case(str, "end") == 0)
                return InsetLayout::END;
-       if (support::compare_ascii_no_case(str, "standard") == 0)
+       if (compare_ascii_no_case(str, "standard") == 0)
                return InsetLayout::STANDARD;
        return InsetLayout::NOLYXTYPE;
 }
@@ -525,7 +592,7 @@ string InsetLayout::defaultCSSClass() const
                else if (isLower(*it))
                        d += *it;
                else
-                       d += support::lowercase(*it);
+                       d += lowercase(*it);
        }
        // are there other characters we need to remove?
        defaultcssclass_ = d;
@@ -562,16 +629,22 @@ void InsetLayout::readArgument(Lexer & lex)
        Layout::latexarg arg;
        arg.mandatory = false;
        arg.autoinsert = false;
+       arg.insertcotext = false;
+       arg.insertonnewline = false;
        bool error = false;
        bool finished = false;
        arg.font = inherit_font;
        arg.labelfont = inherit_font;
+       arg.is_toc_caption = false;
+       arg.free_spacing = false;
+       arg.passthru = PT_INHERITED;
+       arg.nodelims = false;
        string nr;
        lex >> nr;
-       bool const postcmd = support::prefixIs(nr, "post:");
+       bool const postcmd = prefixIs(nr, "post:");
        while (!finished && lex.isOK() && !error) {
                lex.next();
-               string const tok = support::ascii_lowercase(lex.getString());
+               string const tok = ascii_lowercase(lex.getString());
 
                if (tok.empty()) {
                        continue;
@@ -589,15 +662,21 @@ void InsetLayout::readArgument(Lexer & lex)
                } else if (tok == "autoinsert") {
                        lex.next();
                        arg.autoinsert = lex.getBool();
+               } else if (tok == "insertcotext") {
+                       lex.next();
+                       arg.insertcotext = lex.getBool();
+               } else if (tok == "insertonnewline") {
+                       lex.next();
+                       arg.insertonnewline = lex.getBool();
                } else if (tok == "leftdelim") {
                        lex.next();
                        arg.ldelim = lex.getDocString();
-                       arg.ldelim = support::subst(arg.ldelim,
+                       arg.ldelim = 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,
+                       arg.rdelim = subst(arg.rdelim,
                                                    from_ascii("<br/>"), from_ascii("\n"));
                } else if (tok == "defaultarg") {
                        lex.next();
@@ -610,14 +689,35 @@ void InsetLayout::readArgument(Lexer & lex)
                        arg.tooltip = lex.getDocString();
                } else if (tok == "requires") {
                        lex.next();
-                       arg.requires = lex.getString();
+                       arg.required = lex.getString();
                } else if (tok == "decoration") {
                        lex.next();
                        arg.decoration = lex.getString();
+               } else if (tok == "newlinecmd") {
+                       lex.next();
+                       arg.newlinecmd = lex.getString();
                } else if (tok == "font") {
                        arg.font = lyxRead(lex, arg.font);
                } else if (tok == "labelfont") {
                        arg.labelfont = lyxRead(lex, arg.labelfont);
+               } else if (tok == "passthruchars") {
+                       lex.next();
+                       arg.pass_thru_chars = lex.getDocString();
+               } else if (tok == "passthru") {
+                       lex.next();
+                       docstring value = lex.getDocString();
+                       if (value == "true" || value == "1")
+                               arg.passthru = PT_TRUE;
+                       else if (value == "false" || value == "0")
+                               arg.passthru = PT_FALSE;
+                       else
+                               arg.passthru = PT_INHERITED;
+               } else if (tok == "istoccaption") {
+                       lex.next();
+                       arg.is_toc_caption = lex.getBool();
+               } else if (tok == "freespacing") {
+                       lex.next();
+                       arg.free_spacing = lex.getBool();
                } else {
                        lex.printError("Unknown tag");
                        error = true;