]> git.lyx.org Git - lyx.git/blobdiff - src/TextClass.cpp
Fix #10778 (issue with CJK and language nesting)
[lyx.git] / src / TextClass.cpp
index 8ebe0e32f278edb73b3f98148d8c294c8cb4efeb..cb8b8c43b2aad52600192e65a7e32494ef095280 100644 (file)
@@ -36,6 +36,7 @@
 #include "support/gettext.h"
 #include "support/lstrings.h"
 #include "support/os.h"
+#include "support/TempFile.h"
 
 #include <algorithm>
 #include <fstream>
@@ -57,11 +58,10 @@ namespace lyx {
 // LayoutFile.cpp. Additions will never do so, but syntax changes
 // could. See LayoutFileList::addEmptyClass() and, especially, the
 // definition of the layoutpost string.
-// You should also run (or ask someone who has bash to run) the
-// development/tools/updatelayouts.sh script, to update the format of
-// all of our layout files.
+// You should also run the development/tools/updatelayouts.py script,
+// to update the format of all of our layout files.
 //
-int const LAYOUT_FORMAT = 46; // gb: New Tag "ForceLocal"
+int const LAYOUT_FORMAT = 60; //lasgouttes LongTableNoNumber => Unnumbered
 
 namespace {
 
@@ -126,10 +126,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 +136,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 +170,8 @@ enum TextClassTags {
        TC_OUTPUTFORMAT,
        TC_INPUT,
        TC_STYLE,
-       TC_IFSTYLE,
+       TC_MODIFYSTYLE,
+       TC_PROVIDESTYLE,
        TC_DEFAULTSTYLE,
        TC_INSETLAYOUT,
        TC_NOINSETLAYOUT,
@@ -197,6 +188,7 @@ enum TextClassTags {
        TC_HTMLSTYLES,
        TC_PROVIDES,
        TC_REQUIRES,
+       TC_PKGOPTS,
        TC_LEFTMARGIN,
        TC_RIGHTMARGIN,
        TC_FLOAT,
@@ -219,6 +211,7 @@ enum TextClassTags {
        TC_CITEFORMAT,
        TC_DEFAULTBIBLIO,
        TC_FULLAUTHORLIST,
+       TC_OUTLINERNAME
 };
 
 
@@ -246,20 +239,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 },
        { "pagestyle",         TC_PAGESTYLE },
        { "preamble",          TC_PREAMBLE },
        { "provides",          TC_PROVIDES },
        { "providesmodule",    TC_PROVIDESMODULE },
+       { "providestyle",      TC_PROVIDESTYLE },
        { "requires",          TC_REQUIRES },
        { "rightmargin",       TC_RIGHTMARGIN },
        { "secnumdepth",       TC_SECNUMDEPTH },
@@ -276,22 +272,24 @@ LexerKeyword textClassTags[] = {
 bool TextClass::convertLayoutFormat(support::FileName const & filename, ReadType rt)
 {
        LYXERR(Debug::TCLASS, "Converting layout file to " << LAYOUT_FORMAT);
-       FileName const tempfile = FileName::tempName("convert_layout");
+       TempFile tmp("convertXXXXXX.layout");
+       FileName const tempfile = tmp.name();
        bool success = layout2layout(filename, tempfile);
        if (success)
                success = readWithoutConv(tempfile, rt) == OK;
-       tempfile.removeFile();
        return success;
 }
 
 
 std::string TextClass::convert(std::string const & str)
 {
-       FileName const fn = FileName::tempName("locallayout");
+       TempFile tmp1("localXXXXXX.layout");
+       FileName const fn = tmp1.name();
        ofstream os(fn.toFilesystemEncoding().c_str());
        os << str;
        os.close();
-       FileName const tempfile = FileName::tempName("convert_locallayout");
+       TempFile tmp2("convert_localXXXXXX.layout");
+       FileName const tempfile = tmp2.name();
        bool success = layout2layout(fn, tempfile);
        if (!success)
                return "";
@@ -303,7 +301,6 @@ std::string TextClass::convert(std::string const & str)
                ret += tmp + '\n';
        }
        is.close();
-       tempfile.removeFile();
        return ret;
 }
 
@@ -368,7 +365,8 @@ TextClass::ReturnValues TextClass::read(std::string const & str, ReadType rt)
                return retval;
 
        // write the layout string to a temporary file
-       FileName const tempfile = FileName::tempName("TextClass_read");
+       TempFile tmp("TextClass_read");
+       FileName const tempfile = tmp.name();
        ofstream os(tempfile.toFilesystemEncoding().c_str());
        if (!os) {
                LYXERR0("Unable to create temporary file");
@@ -384,7 +382,6 @@ TextClass::ReturnValues TextClass::read(std::string const & str, ReadType rt)
                        << LAYOUT_FORMAT);
                return ERROR;
        }
-       tempfile.removeFile();
        return OK_OLDFORMAT;
 }
 
@@ -417,8 +414,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)) {
 
@@ -449,8 +447,13 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
 
                case TC_INPUT: // Include file
                        if (lexrc.next()) {
+                               FileName tmp;
                                string const inc = lexrc.getString();
-                               FileName tmp = libFileSearch("layouts", inc,
+                               if (!path().empty() && (prefixIs(inc, "./") ||
+                                                       prefixIs(inc, "../")))
+                                       tmp = fileSearch(path(), inc, "layout");
+                               else
+                                       tmp = libFileSearch("layouts", inc,
                                                            "layout");
 
                                if (tmp.empty()) {
@@ -471,9 +474,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'.");
@@ -490,10 +499,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);
@@ -506,15 +526,15 @@ 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;
                                readStyle(lexrc, lay);
                        }
-
-                       // reset flag
-                       ifstyle = false;
                        break;
                }
 
@@ -634,6 +654,15 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                        break;
                }
 
+               case TC_PKGOPTS : {
+                       lexrc.next();
+                       string const pkg = lexrc.getString();
+                       lexrc.next();
+                       string const options = lexrc.getString();
+                       package_options_[pkg] = options;
+                       break;
+               }
+
                case TC_DEFAULTMODULE: {
                        lexrc.next();
                        string const module = lexrc.getString();
@@ -740,6 +769,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();
@@ -758,8 +788,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:
@@ -777,6 +805,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
@@ -791,7 +823,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_
@@ -962,6 +994,8 @@ bool TextClass::readCiteEngine(Lexer & lexrc)
                cite_styles_[ENGINE_TYPE_AUTHORYEAR].clear();
        if (type & ENGINE_TYPE_NUMERICAL)
                cite_styles_[ENGINE_TYPE_NUMERICAL].clear();
+       if (type & ENGINE_TYPE_DEFAULT)
+               cite_styles_[ENGINE_TYPE_DEFAULT].clear();
        string def;
        bool getout = false;
        while (!getout && lexrc.isOK()) {
@@ -1001,6 +1035,8 @@ bool TextClass::readCiteEngine(Lexer & lexrc)
                        cite_styles_[ENGINE_TYPE_AUTHORYEAR].push_back(cs);
                if (type & ENGINE_TYPE_NUMERICAL)
                        cite_styles_[ENGINE_TYPE_NUMERICAL].push_back(cs);
+               if (type & ENGINE_TYPE_DEFAULT)
+                       cite_styles_[ENGINE_TYPE_DEFAULT].push_back(cs);
        }
        return getout;
 }
@@ -1008,8 +1044,8 @@ bool TextClass::readCiteEngine(Lexer & lexrc)
 
 int TextClass::readCiteEngineType(Lexer & lexrc) const
 {
-       int const ENGINE_TYPE_DEFAULT =
-               ENGINE_TYPE_AUTHORYEAR | ENGINE_TYPE_NUMERICAL;
+       LATTEST(ENGINE_TYPE_DEFAULT ==
+               (ENGINE_TYPE_AUTHORYEAR | ENGINE_TYPE_NUMERICAL));
        if (!lexrc.next()) {
                lexrc.printError("No cite engine type given for token: `$$Token'.");
                return ENGINE_TYPE_DEFAULT;
@@ -1050,11 +1086,15 @@ bool TextClass::readCiteFormat(Lexer & lexrc)
                                cite_macros_[ENGINE_TYPE_AUTHORYEAR][etype] = definition;
                        if (type & ENGINE_TYPE_NUMERICAL)
                                cite_macros_[ENGINE_TYPE_NUMERICAL][etype] = definition;
+                       if (type & ENGINE_TYPE_DEFAULT)
+                               cite_macros_[ENGINE_TYPE_DEFAULT][etype] = definition;
                } else {
                        if (type & ENGINE_TYPE_AUTHORYEAR)
                                cite_formats_[ENGINE_TYPE_AUTHORYEAR][etype] = definition;
                        if (type & ENGINE_TYPE_NUMERICAL)
                                cite_formats_[ENGINE_TYPE_NUMERICAL][etype] = definition;
+                       if (type & ENGINE_TYPE_DEFAULT)
+                               cite_formats_[ENGINE_TYPE_DEFAULT][etype] = definition;
                }
        }
        return true;
@@ -1078,10 +1118,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 },
@@ -1109,12 +1155,15 @@ bool TextClass::readFloat(Lexer & lexrc)
        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()) {
@@ -1152,6 +1201,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();
@@ -1186,6 +1239,14 @@ 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();
@@ -1226,8 +1287,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),
@@ -1241,6 +1303,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_, ',')) {
@@ -1402,13 +1497,26 @@ InsetLayout const & DocumentClass::insetLayout(docstring const & name) const
        InsetLayouts::const_iterator cen = insetlayoutlist_.end();
        while (!n.empty()) {
                InsetLayouts::const_iterator cit = insetlayoutlist_.lower_bound(n);
-               if (cit != cen && cit->first == n)
-                       return cit->second;
+               if (cit != cen && cit->first == n) {
+                       if (cit->second.obsoleted_by().empty())
+                               return cit->second;
+                       n = cit->second.obsoleted_by();
+                       return insetLayout(n);
+               }
+               // If we have a generic prefix (e.g., "Note:"),
+               // try if this one alone is found.
                size_t i = n.find(':');
                if (i == string::npos)
                        break;
                n = n.substr(0, i);
        }
+       // Layout "name" not found.
+       return plainInsetLayout();
+}
+
+
+InsetLayout const & DocumentClass::plainInsetLayout() {
+       static const InsetLayout plain_insetlayout_;
        return plain_insetlayout_;
 }
 
@@ -1470,7 +1578,8 @@ Layout TextClass::createBasicLayout(docstring const & name, bool unknown) const
 
 
 DocumentClassPtr getDocumentClass(
-               LayoutFile const & baseClass, LayoutModuleList const & modlist)
+               LayoutFile const & baseClass, LayoutModuleList const & modlist,
+               bool const clone)
 {
        DocumentClassPtr doc_class =
            DocumentClassPtr(new DocumentClass(baseClass));
@@ -1485,10 +1594,11 @@ DocumentClassPtr getDocumentClass(
                                                "this document but has not been found in the list of\n"
                                                "available modules. If you recently installed it, you\n"
                                                "probably need to reconfigure LyX.\n"), from_utf8(modName));
-                       frontend::Alert::warning(_("Module not available"), msg);
+                       if (!clone)
+                               frontend::Alert::warning(_("Module not available"), msg);
                        continue;
                }
-               if (!lm->isAvailable()) {
+               if (!lm->isAvailable() && !clone) {
                        docstring const prereqs = from_utf8(getStringFromVector(lm->prerequisites(), "\n\t"));
                        docstring const msg =
                                bformat(_("The module %1$s requires a package that is not\n"