]> git.lyx.org Git - lyx.git/blobdiff - src/TextClass.cpp
Implement PassThru option to arguments.
[lyx.git] / src / TextClass.cpp
index cc8fb993bbe9de3d86b76f5355a93a835b5607c7..46a96e4815500b5367a3614928cd48907f38f1cd 100644 (file)
@@ -61,7 +61,13 @@ namespace lyx {
 // You should also run the development/tools/updatelayouts.py script,
 // to update the format of all of our layout files.
 //
-int const LAYOUT_FORMAT = 53; //spitz: add ObsoletedBy tag for InsetLayouts
+int const LAYOUT_FORMAT = 62; //spitz PassThru for arguments.
+
+
+// Layout format for the current lyx file format. Controls which format is
+// targeted by Local Layout > Convert. In master, equal to LAYOUT_FORMAT.
+int const LYXFILE_LAYOUT_FORMAT = LAYOUT_FORMAT;
+
 
 namespace {
 
@@ -79,26 +85,29 @@ private:
 };
 
 
-bool layout2layout(FileName const & filename, FileName const & tempfile)
+bool layout2layout(FileName const & filename, FileName const & tempfile,
+                   int const format = LAYOUT_FORMAT)
 {
        FileName const script = libFileSearch("scripts", "layout2layout.py");
        if (script.empty()) {
                LYXERR0("Could not find layout conversion "
-                         "script layout2layout.py.");
+                       "script layout2layout.py.");
                return false;
        }
 
        ostringstream command;
        command << os::python() << ' ' << quoteName(script.toFilesystemEncoding())
-               << ' ' << quoteName(filename.toFilesystemEncoding())
-               << ' ' << quoteName(tempfile.toFilesystemEncoding());
+               << " -t " << format
+               << ' ' << quoteName(filename.toFilesystemEncoding())
+               << ' ' << quoteName(tempfile.toFilesystemEncoding());
        string const command_str = command.str();
 
        LYXERR(Debug::TCLASS, "Running `" << command_str << '\'');
 
        cmd_ret const ret = runCommand(command_str);
        if (ret.first != 0) {
-               LYXERR0("Could not run layout conversion script layout2layout.py.");
+               if (format == LAYOUT_FORMAT)
+                       LYXERR0("Conversion of layout with layout2layout.py has failed.");
                return false;
        }
        return true;
@@ -126,10 +135,7 @@ string translateReadType(TextClass::ReadType rt)
 
 // This string should not be translated here,
 // because it is a layout identifier.
-docstring const TextClass::plain_layout_ = from_ascii("Plain Layout");
-
-
-InsetLayout DocumentClass::plain_insetlayout_;
+docstring const TextClass::plain_layout_ = from_ascii(N_("Plain Layout"));
 
 
 /////////////////////////////////////////////////////////////////////////
@@ -139,23 +145,16 @@ InsetLayout DocumentClass::plain_insetlayout_;
 /////////////////////////////////////////////////////////////////////////
 
 TextClass::TextClass()
+       : loaded_(false), tex_class_avail_(false),
+         opt_enginetype_("authoryear|numerical"), opt_fontsize_("10|11|12"),
+         opt_pagestyle_("empty|plain|headings|fancy"), pagestyle_("default"),
+         columns_(1), sides_(OneSide), secnumdepth_(3), tocdepth_(3),
+         outputType_(LATEX), outputFormat_("latex"),
+         defaultfont_(sane_font),
+         titletype_(TITLE_COMMAND_AFTER), titlename_("maketitle"),
+         min_toclevel_(0), max_toclevel_(0),
+         cite_full_author_list_(true)
 {
-       outputType_ = LATEX;
-       outputFormat_ = "latex";
-       columns_ = 1;
-       sides_ = OneSide;
-       secnumdepth_ = 3;
-       tocdepth_ = 3;
-       pagestyle_ = "default";
-       defaultfont_ = sane_font;
-       opt_enginetype_ = "authoryear|numerical";
-       opt_fontsize_ = "10|11|12";
-       opt_pagestyle_ = "empty|plain|headings|fancy";
-       cite_full_author_list_ = true;
-       titletype_ = TITLE_COMMAND_AFTER;
-       titlename_ = "maketitle";
-       loaded_ = false;
-       _("Plain Layout"); // a hack to make this translatable
 }
 
 
@@ -180,7 +179,8 @@ enum TextClassTags {
        TC_OUTPUTFORMAT,
        TC_INPUT,
        TC_STYLE,
-       TC_IFSTYLE,
+       TC_MODIFYSTYLE,
+       TC_PROVIDESTYLE,
        TC_DEFAULTSTYLE,
        TC_INSETLAYOUT,
        TC_NOINSETLAYOUT,
@@ -219,7 +219,8 @@ enum TextClassTags {
        TC_CITEENGINETYPE,
        TC_CITEFORMAT,
        TC_DEFAULTBIBLIO,
-       TC_FULLAUTHORLIST
+       TC_FULLAUTHORLIST,
+       TC_OUTLINERNAME
 };
 
 
@@ -247,21 +248,23 @@ LexerKeyword textClassTags[] = {
        { "htmlstyles",        TC_HTMLSTYLES },
        { "htmltocsection",    TC_HTMLTOCSECTION },
        { "ifcounter",         TC_IFCOUNTER },
-       { "ifstyle",           TC_IFSTYLE },
        { "input",             TC_INPUT },
        { "insetlayout",       TC_INSETLAYOUT },
        { "leftmargin",        TC_LEFTMARGIN },
+       { "modifystyle",       TC_MODIFYSTYLE },
        { "nocounter",         TC_NOCOUNTER },
        { "nofloat",           TC_NOFLOAT },
        { "noinsetlayout",     TC_NOINSETLAYOUT },
        { "nostyle",           TC_NOSTYLE },
+       { "outlinername",      TC_OUTLINERNAME },
        { "outputformat",      TC_OUTPUTFORMAT },
        { "outputtype",        TC_OUTPUTTYPE },
-       { "packageoptions",        TC_PKGOPTS },
+       { "packageoptions",    TC_PKGOPTS },
        { "pagestyle",         TC_PAGESTYLE },
        { "preamble",          TC_PREAMBLE },
        { "provides",          TC_PROVIDES },
        { "providesmodule",    TC_PROVIDESMODULE },
+       { "providestyle",      TC_PROVIDESTYLE },
        { "requires",          TC_REQUIRES },
        { "rightmargin",       TC_RIGHTMARGIN },
        { "secnumdepth",       TC_SECNUMDEPTH },
@@ -296,7 +299,7 @@ std::string TextClass::convert(std::string const & str)
        os.close();
        TempFile tmp2("convert_localXXXXXX.layout");
        FileName const tempfile = tmp2.name();
-       bool success = layout2layout(fn, tempfile);
+       bool success = layout2layout(fn, tempfile, LYXFILE_LAYOUT_FORMAT);
        if (!success)
                return "";
        ifstream is(tempfile.toFilesystemEncoding().c_str());
@@ -381,13 +384,13 @@ TextClass::ReturnValues TextClass::read(std::string const & str, ReadType rt)
        os << str;
        os.close();
 
-       // now try to convert it
-       bool const worx = convertLayoutFormat(tempfile, rt);
-       if (!worx) {
+       // now try to convert it to LAYOUT_FORMAT
+       if (!convertLayoutFormat(tempfile, rt)) {
                LYXERR0("Unable to convert internal layout information to format "
                        << LAYOUT_FORMAT);
                return ERROR;
        }
+
        return OK_OLDFORMAT;
 }
 
@@ -420,8 +423,9 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                }
 
                // used below to track whether we are in an IfStyle or IfCounter tag.
-               bool ifstyle    = false;
-               bool ifcounter  = false;
+               bool modifystyle  = false;
+               bool providestyle = false;
+               bool ifcounter    = false;
 
                switch (static_cast<TextClassTags>(le)) {
 
@@ -474,9 +478,15 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                        }
                        break;
 
-               case TC_IFSTYLE:
-                       ifstyle = true;
-                       // fall through
+               case TC_MODIFYSTYLE:
+                       modifystyle = true;
+               // fall through
+               case TC_PROVIDESTYLE:
+                       // if modifystyle is true, then we got here by falling through
+                       // so we are not in an ProvideStyle block
+                       if (!modifystyle)
+                               providestyle = true;
+               // fall through
                case TC_STYLE: {
                        if (!lexrc.next()) {
                                lexrc.printError("No name given for style: `$$Token'.");
@@ -493,10 +503,21 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                                // Since we couldn't read the name, we just scan the rest
                                // of the style and discard it.
                                error = !readStyle(lexrc, lay);
-                       } else if (hasLayout(name)) {
+                               break;
+                       }
+                       
+                       bool const have_layout = hasLayout(name);
+                       
+                       // If the layout already exists, then we want to add it to
+                       // the existing layout, as long as we are not in an ProvideStyle
+                       // block.
+                       if (have_layout && !providestyle) {
                                Layout & lay = operator[](name);
                                error = !readStyle(lexrc, lay);
-                       } else if (!ifstyle) {
+                       }
+                       // If the layout does not exist, then we want to create a new
+                       // one, but not if we are in a ModifyStyle block.
+                       else if (!have_layout && !modifystyle) {
                                Layout layout;
                                layout.setName(name);
                                error = !readStyle(lexrc, layout);
@@ -509,15 +530,17 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                                        defaultlayout_ = name;
                                }
                        }
+                       // There are two ways to get here:
+                       //  (i)  The layout exists but we are in an ProvideStyle block
+                       //  (ii) The layout doesn't exist, but we are in an ModifyStyle
+                       //       block.
+                       // Either way, we just scan the rest and discard it
                        else {
-                               // this was an ifstyle where we didn't have the style
-                               // scan the rest and discard it
                                Layout lay;
+                               // false positive from coverity
+                               // coverity[CHECKED_RETURN]
                                readStyle(lexrc, lay);
                        }
-
-                       // reset flag
-                       ifstyle = false;
                        break;
                }
 
@@ -591,15 +614,15 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                        break;
 
                case TC_PREAMBLE:
-                       preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
+                       preamble_ = lexrc.getLongString(from_ascii("EndPreamble"));
                        break;
 
                case TC_HTMLPREAMBLE:
-                       htmlpreamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
+                       htmlpreamble_ = lexrc.getLongString(from_ascii("EndPreamble"));
                        break;
 
                case TC_HTMLSTYLES:
-                       htmlstyles_ = from_utf8(lexrc.getLongString("EndStyles"));
+                       htmlstyles_ = lexrc.getLongString(from_ascii("EndStyles"));
                        break;
 
                case TC_HTMLTOCSECTION:
@@ -607,15 +630,15 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                        break;
 
                case TC_ADDTOPREAMBLE:
-                       preamble_ += from_utf8(lexrc.getLongString("EndPreamble"));
+                       preamble_ += lexrc.getLongString(from_ascii("EndPreamble"));
                        break;
 
                case TC_ADDTOHTMLPREAMBLE:
-                       htmlpreamble_ += from_utf8(lexrc.getLongString("EndPreamble"));
+                       htmlpreamble_ += lexrc.getLongString(from_ascii("EndPreamble"));
                        break;
 
                case TC_ADDTOHTMLSTYLES:
-                       htmlstyles_ += from_utf8(lexrc.getLongString("EndStyles"));
+                       htmlstyles_ += lexrc.getLongString(from_ascii("EndStyles"));
                        break;
 
                case TC_PROVIDES: {
@@ -752,6 +775,7 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
 
                case TC_IFCOUNTER:
                        ifcounter = true;
+                       // fall through
                case TC_COUNTER:
                        if (lexrc.next()) {
                                docstring const name = lexrc.getDocString();
@@ -770,8 +794,6 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                                lexrc.printError("No name given for style: `$$Token'.");
                                error = true;
                        }
-                       // reset flag
-                       ifcounter = false;
                        break;
 
                case TC_TITLELATEXTYPE:
@@ -789,6 +811,10 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                                floatlist_.erase(nofloat);
                        }
                        break;
+
+               case TC_OUTLINERNAME:
+                       error = !readOutlinerName(lexrc);
+                       break;
                } // end of switch
 
                // Note that this is triggered the first time through the loop unless
@@ -803,7 +829,7 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                return ERROR;
 
        if (rt != BASECLASS)
-               return (error ? ERROR : OK);
+               return OK;
 
        if (defaultlayout_.empty()) {
                LYXERR0("Error: Textclass '" << name_
@@ -1098,10 +1124,16 @@ bool TextClass::readFloat(Lexer & lexrc)
                FT_HTMLTAG,
                FT_LISTCOMMAND,
                FT_REFPREFIX,
+               FT_ALLOWED_PLACEMENT,
+               FT_ALLOWS_SIDEWAYS,
+               FT_ALLOWS_WIDE,
                FT_END
        };
 
        LexerKeyword floatTags[] = {
+               { "allowedplacement", FT_ALLOWED_PLACEMENT },
+               { "allowssideways", FT_ALLOWS_SIDEWAYS },
+               { "allowswide", FT_ALLOWS_WIDE },
                { "end", FT_END },
                { "extension", FT_EXT },
                { "guiname", FT_NAME },
@@ -1123,18 +1155,21 @@ bool TextClass::readFloat(Lexer & lexrc)
 
        string ext;
        string htmlattr;
-       string htmlstyle;
+       docstring htmlstyle;
        string htmltag;
        string listname;
        string listcommand;
        string name;
        string placement;
+       string allowed_placement = "!htbpH";
        string refprefix;
        string style;
        string type;
        string within;
        bool usesfloat = true;
        bool ispredefined = false;
+       bool allowswide = true;
+       bool allowssideways = true;
 
        bool getout = false;
        while (!getout && lexrc.isOK()) {
@@ -1172,6 +1207,10 @@ bool TextClass::readFloat(Lexer & lexrc)
                        lexrc.next();
                        placement = lexrc.getString();
                        break;
+               case FT_ALLOWED_PLACEMENT:
+                       lexrc.next();
+                       allowed_placement = lexrc.getString();
+                       break;
                case FT_EXT:
                        lexrc.next();
                        ext = lexrc.getString();
@@ -1206,13 +1245,21 @@ bool TextClass::readFloat(Lexer & lexrc)
                        lexrc.next();
                        ispredefined = lexrc.getBool();
                        break;
+               case FT_ALLOWS_SIDEWAYS:
+                       lexrc.next();
+                       allowssideways = lexrc.getBool();
+                       break;
+               case FT_ALLOWS_WIDE:
+                       lexrc.next();
+                       allowswide = lexrc.getBool();
+                       break;
                case FT_HTMLATTR:
                        lexrc.next();
                        htmlattr = lexrc.getString();
                        break;
                case FT_HTMLSTYLE:
                        lexrc.next();
-                       htmlstyle = lexrc.getLongString("EndHTMLStyle");
+                       htmlstyle = lexrc.getLongString(from_ascii("EndHTMLStyle"));
                        break;
                case FT_HTMLTAG:
                        lexrc.next();
@@ -1246,8 +1293,9 @@ bool TextClass::readFloat(Lexer & lexrc)
                                  "not be able to produce a float list.");
                }
                Floating fl(type, placement, ext, within, style, name,
-                               listname, listcommand, refprefix,
-                               htmltag, htmlattr, htmlstyle, usesfloat, ispredefined);
+                           listname, listcommand, refprefix, allowed_placement,
+                           htmltag, htmlattr, htmlstyle, usesfloat, ispredefined,
+                           allowswide, allowssideways);
                floatlist_.newFloat(fl);
                // each float has its own counter
                counters_.newCounter(from_ascii(type), from_ascii(within),
@@ -1261,6 +1309,39 @@ bool TextClass::readFloat(Lexer & lexrc)
 }
 
 
+bool TextClass::readOutlinerName(Lexer & lexrc)
+{
+       std::string type;
+       docstring name;
+       if (lexrc.next())
+               type = lexrc.getString();
+       else {
+               lexrc.printError("No type given for OutlinerName: `$$Token'.");
+               return false;
+       }
+       if (lexrc.next())
+               name = lexrc.getDocString();
+       else {
+               lexrc.printError("No name given for OutlinerName: `$$Token'.");
+               return false;
+       }
+       outliner_names_[type] = name;
+    return true;
+}
+
+
+docstring TextClass::outlinerName(std::string const & type) const
+{
+       std::map<std::string,docstring>::const_iterator const it
+               = outliner_names_.find(type);
+       if (it == outliner_names_.end()) {
+               LYXERR0("Missing OutlinerName for " << type << "!");
+               return from_utf8(type);
+       } else
+               return it->second;
+}
+
+
 string const & TextClass::prerequisites(string const & sep) const
 {
        if (contains(prerequisites_, ',')) {
@@ -1436,6 +1517,12 @@ InsetLayout const & DocumentClass::insetLayout(docstring const & name) const
                n = n.substr(0, i);
        }
        // Layout "name" not found.
+       return plainInsetLayout();
+}
+
+
+InsetLayout const & DocumentClass::plainInsetLayout() {
+       static const InsetLayout plain_insetlayout_;
        return plain_insetlayout_;
 }