]> git.lyx.org Git - lyx.git/blobdiff - src/TextClass.cpp
sk review
[lyx.git] / src / TextClass.cpp
index d992c5ccd2e7d30737d1614532816f34f425259d..eb92612d847b6d9bad0ead06aa018324b53164fe 100644 (file)
@@ -62,7 +62,7 @@ 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 = 80; // spitz: Requires for floats
+int const LAYOUT_FORMAT = 82; // dourouc05: DocBook additions.
 
 
 // Layout format for the current lyx file format. Controls which format is
@@ -72,20 +72,6 @@ int const LYXFILE_LAYOUT_FORMAT = LAYOUT_FORMAT;
 
 namespace {
 
-class LayoutNamesEqual : public unary_function<Layout, bool> {
-public:
-       LayoutNamesEqual(docstring const & name)
-               : name_(name)
-       {}
-       bool operator()(Layout const & c) const
-       {
-               return c.name() == name_;
-       }
-private:
-       docstring name_;
-};
-
-
 bool layout2layout(FileName const & filename, FileName const & tempfile,
                    int const format = LAYOUT_FORMAT)
 {
@@ -153,12 +139,12 @@ TextClass::TextClass()
          opt_pagesize_("default|a4|a5|b5|letter|legal|executive"),
          opt_pagestyle_("empty|plain|headings|fancy"), fontsize_format_("$$spt"), pagesize_("default"),
          pagesize_format_("$$spaper"), pagestyle_("default"), tablestyle_("default"),
+         docbookroot_("article"), docbookforceabstract_(false),
          columns_(1), sides_(OneSide), secnumdepth_(3), tocdepth_(3), outputType_(LATEX),
          outputFormat_("latex"), has_output_format_(false), defaultfont_(sane_font), 
          titletype_(TITLE_COMMAND_AFTER), titlename_("maketitle"),
          min_toclevel_(0), max_toclevel_(0), maxcitenames_(2),
-         cite_full_author_list_(true), bibintoc_(false)
-{
+         cite_full_author_list_(true), bibintoc_(false) {
 }
 
 
@@ -230,7 +216,9 @@ enum TextClassTags {
        TC_FULLAUTHORLIST,
        TC_OUTLINERNAME,
        TC_TABLESTYLE,
-       TC_BIBINTOC
+       TC_BIBINTOC,
+       TC_DOCBOOKROOT,
+       TC_DOCBOOKFORCEABSTRACT
 };
 
 
@@ -253,6 +241,8 @@ LexerKeyword textClassTags[] = {
        { "defaultfont",       TC_DEFAULTFONT },
        { "defaultmodule",     TC_DEFAULTMODULE },
        { "defaultstyle",      TC_DEFAULTSTYLE },
+       { "docbookforceabstract", TC_DOCBOOKFORCEABSTRACT },
+       { "docbookroot",       TC_DOCBOOKROOT },
        { "excludesmodule",    TC_EXCLUDESMODULE },
        { "float",             TC_FLOAT },
        { "format",            TC_FORMAT },
@@ -466,9 +456,6 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                        case LATEX:
                                outputFormat_ = "latex";
                                break;
-                       case DOCBOOK:
-                               outputFormat_ = "docbook";
-                               break;
                        case LITERATE:
                                outputFormat_ = "literate";
                                break;
@@ -686,7 +673,7 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                        lexrc.eatLine();
                        vector<string> const req
                                = getVectorFromString(lexrc.getString());
-                       requires_.insert(req.begin(), req.end());
+                       required_.insert(req.begin(), req.end());
                        break;
                }
 
@@ -882,10 +869,20 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                        error = !readOutlinerName(lexrc);
                        break;
 
-               case TC_TABLESTYLE:
+        case TC_TABLESTYLE:
                        lexrc.next();
                        tablestyle_ = rtrim(lexrc.getString());
                        break;
+
+               case TC_DOCBOOKROOT:
+                       if (lexrc.next())
+                               docbookroot_ = lexrc.getString();
+                       break;
+
+               case TC_DOCBOOKFORCEABSTRACT:
+                       if (lexrc.next())
+                               docbookforceabstract_ = lexrc.getBool();
+                       break;
                } // end of switch
        }
 
@@ -913,7 +910,7 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
        // If we do not succeed, then it was not there, which means that
        // the textclass did not provide the definitions of the standard
        // insets. So we need to try to load them.
-       int erased = provides_.erase("stdinsets");
+       size_type const erased = provides_.erase("stdinsets");
        if (!erased) {
                FileName tmp = libFileSearch("layouts", "stdinsets.inc");
 
@@ -975,7 +972,6 @@ void TextClass::readTitleType(Lexer & lexrc)
 void TextClass::readOutputType(Lexer & lexrc)
 {
        LexerKeyword outputTypeTags[] = {
-               { "docbook",  DOCBOOK },
                { "latex",    LATEX },
                { "literate", LITERATE }
        };
@@ -988,7 +984,6 @@ void TextClass::readOutputType(Lexer & lexrc)
                lexrc.printError("Unknown output type `$$Token'");
                return;
        case LATEX:
-       case DOCBOOK:
        case LITERATE:
                outputType_ = static_cast<OutputType>(le);
                break;
@@ -1008,7 +1003,6 @@ void TextClass::readClassOptions(Lexer & lexrc)
                CO_PAGESIZE_FORMAT,
                CO_PAGESTYLE,
                CO_OTHER,
-               CO_HEADER,
                CO_END
        };
 
@@ -1016,7 +1010,6 @@ void TextClass::readClassOptions(Lexer & lexrc)
                {"end",       CO_END },
                {"fontsize",  CO_FONTSIZE },
                {"fontsizeformat", CO_FONTSIZE_FORMAT },
-               {"header",    CO_HEADER },
                {"other",     CO_OTHER },
                {"pagesize",  CO_PAGESIZE },
                {"pagesizeformat", CO_PAGESIZE_FORMAT },
@@ -1062,10 +1055,6 @@ void TextClass::readClassOptions(Lexer & lexrc)
                        else
                                options_ += ',' + lexrc.getString();
                        break;
-               case CO_HEADER:
-                       lexrc.next();
-                       class_header_ = subst(lexrc.getString(), "&quot;", "\"");
-                       break;
                case CO_END:
                        getout = true;
                        break;
@@ -1387,6 +1376,8 @@ bool TextClass::readFloat(Lexer & lexrc)
                FT_HTMLSTYLE,
                FT_HTMLATTR,
                FT_HTMLTAG,
+               FT_DOCBOOKATTR,
+               FT_DOCBOOKTAG,
                FT_LISTCOMMAND,
                FT_REFPREFIX,
                FT_ALLOWED_PLACEMENT,
@@ -1400,6 +1391,8 @@ bool TextClass::readFloat(Lexer & lexrc)
                { "allowedplacement", FT_ALLOWED_PLACEMENT },
                { "allowssideways", FT_ALLOWS_SIDEWAYS },
                { "allowswide", FT_ALLOWS_WIDE },
+               { "docbookattr", FT_DOCBOOKATTR },
+               { "docbooktag", FT_DOCBOOKTAG },
                { "end", FT_END },
                { "extension", FT_EXT },
                { "guiname", FT_NAME },
@@ -1424,6 +1417,8 @@ bool TextClass::readFloat(Lexer & lexrc)
        string htmlattr;
        docstring htmlstyle;
        string htmltag;
+       string docbookattr;
+       string docbooktag;
        string listname;
        string listcommand;
        string name;
@@ -1433,7 +1428,7 @@ bool TextClass::readFloat(Lexer & lexrc)
        string style;
        string type;
        string within;
-       string requires;
+       string required;
        bool usesfloat = true;
        bool ispredefined = false;
        bool allowswide = true;
@@ -1511,7 +1506,7 @@ bool TextClass::readFloat(Lexer & lexrc)
                        break;
                case FT_REQUIRES:
                        lexrc.next();
-                       requires = lexrc.getString();
+                       required = lexrc.getString();
                        break;
                case FT_PREDEFINED:
                        lexrc.next();
@@ -1537,6 +1532,14 @@ bool TextClass::readFloat(Lexer & lexrc)
                        lexrc.next();
                        htmltag = lexrc.getString();
                        break;
+               case FT_DOCBOOKATTR:
+                       lexrc.next();
+                       docbookattr = lexrc.getString();
+                       break;
+               case FT_DOCBOOKTAG:
+                       lexrc.next();
+                       docbooktag = lexrc.getString();
+                       break;
                case FT_END:
                        getout = true;
                        break;
@@ -1563,17 +1566,20 @@ bool TextClass::readFloat(Lexer & lexrc)
                                  "not be able to produce a float list.");
                }
                Floating fl(type, placement, ext, within, style, name,
-                           listname, listcommand, refprefix, allowed_placement,
-                           htmltag, htmlattr, htmlstyle, requires, usesfloat,
-                           ispredefined, allowswide, allowssideways);
+                       listname, listcommand, refprefix, allowed_placement,
+                       htmltag, htmlattr, htmlstyle, docbooktag, docbookattr,
+                       required, usesfloat, ispredefined, allowswide,
+                       allowssideways);
                floatlist_.newFloat(fl);
                // each float has its own counter
                counters_.newCounter(from_ascii(type), from_ascii(within),
-                                     docstring(), docstring());
+                               docstring(), docstring(),
+                               bformat(_("%1$s (Float)"), _(name)));
                // also define sub-float counters
                docstring const subtype = "sub-" + from_ascii(type);
                counters_.newCounter(subtype, from_ascii(type),
-                                     "\\alph{" + subtype + "}", docstring());
+                               "\\alph{" + subtype + "}", docstring(),
+                                bformat(_("Sub-%1$s (Float)"), _(name)));
        }
        return getout;
 }
@@ -1613,10 +1619,7 @@ string const & TextClass::prerequisites(string const & sep) const
 bool TextClass::hasLayout(docstring const & n) const
 {
        docstring const name = n.empty() ? defaultLayoutName() : n;
-
-       return find_if(layoutlist_.begin(), layoutlist_.end(),
-                      LayoutNamesEqual(name))
-               != layoutlist_.end();
+       return getLayout(name) != nullptr;
 }
 
 
@@ -1633,10 +1636,8 @@ Layout const & TextClass::operator[](docstring const & name) const
 {
        LATTEST(!name.empty());
 
-       const_iterator it =
-               find_if(begin(), end(), LayoutNamesEqual(name));
-
-       if (it == end()) {
+       Layout const * c = getLayout(name);
+       if (!c) {
                LYXERR0("We failed to find the layout '" << name
                       << "' in the layout list. You MUST investigate!");
                for (auto const & lay : *this)
@@ -1647,7 +1648,7 @@ Layout const & TextClass::operator[](docstring const & name) const
                LASSERT(false, return dummy);
        }
 
-       return *it;
+       return *c;
 }
 
 
@@ -1656,9 +1657,8 @@ Layout & TextClass::operator[](docstring const & name)
        LATTEST(!name.empty());
        // Safe to continue, given what we do below.
 
-       iterator it = find_if(begin(), end(), LayoutNamesEqual(name));
-
-       if (it == end()) {
+       Layout * c = getLayout(name);
+       if (!c) {
                LYXERR0("We failed to find the layout '" << to_utf8(name)
                       << "' in the layout list. You MUST investigate!");
                for (auto const & lay : *this)
@@ -1668,10 +1668,10 @@ Layout & TextClass::operator[](docstring const & name)
                LATTEST(false);
                // we are here only in release mode
                layoutlist_.push_back(createBasicLayout(name, true));
-               it = find_if(begin(), end(), LayoutNamesEqual(name));
+               c = getLayout(name);
        }
 
-       return *it;
+       return *c;
 }
 
 
@@ -1682,9 +1682,9 @@ bool TextClass::deleteLayout(docstring const & name)
 
        LayoutList::iterator it =
                remove_if(layoutlist_.begin(), layoutlist_.end(),
-                         LayoutNamesEqual(name));
+                       [name](const Layout &c) { return c.name() == name; });
 
-       LayoutList::iterator end = layoutlist_.end();
+       LayoutList::iterator const end = layoutlist_.end();
        bool const ret = (it != end);
        layoutlist_.erase(it, end);
        return ret;
@@ -1725,6 +1725,30 @@ bool TextClass::load(string const & path) const
 }
 
 
+Layout const * TextClass::getLayout(docstring const & name) const
+{
+       LayoutList::const_iterator cit =
+               find_if(begin(), end(),
+                       [name](const Layout &c) { return c.name() == name; });
+       if (cit == layoutlist_.end())
+               return nullptr;
+
+       return &(*cit);
+}
+
+
+Layout * TextClass::getLayout(docstring const & name)
+{
+       LayoutList::iterator it =
+               find_if(layoutlist_.begin(), layoutlist_.end(),
+                       [name](const Layout &c) { return c.name() == name; });
+       if (it == layoutlist_.end())
+               return nullptr;
+
+       return &(*it);
+}
+
+
 bool DocumentClass::addLayoutIfNeeded(docstring const & n) const
 {
        if (hasLayout(n))