]> git.lyx.org Git - lyx.git/blobdiff - src/TextClass.cpp
sk review
[lyx.git] / src / TextClass.cpp
index c11331e1a189bae4af341d898588b31d3b00a49c..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 = 79; // spitz: PagesizeFormat
+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;
                }
 
@@ -745,6 +732,7 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                                break;
                        }
                        docstring const name = subst(lexrc.getDocString(), '_', ' ');
+                       bool const validating = (rt == VALIDATION);
                        if (name.empty()) {
                                string s = "Could not read name for InsetLayout: `$$Token' "
                                        + lexrc.getString() + " is probably not valid UTF-8!";
@@ -753,15 +741,17 @@ 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.
                                il.read(lexrc, *this);
-                               // Let's try to continue rather than abort.
-                               // error = true;
+                               // Let's try to continue rather than abort, unless we're validating
+                               // in which case we want to report the error
+                               if (validating)
+                                       error = true;
                        } else if (hasInsetLayout(name)) {
                                InsetLayout & il = insetlayoutlist_[name];
-                               error = !il.read(lexrc, *this);
+                               error = !il.read(lexrc, *this, validating);
                        } else {
                                InsetLayout il;
                                il.setName(name);
-                               error = !il.read(lexrc, *this);
+                               error = !il.read(lexrc, *this, validating);
                                if (!error)
                                        insetlayoutlist_[name] = il;
                        }
@@ -803,17 +793,15 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                        if (lexrc.next()) {
                                vector<string> const dbs =
                                        getVectorFromString(rtrim(lexrc.getString()), "|");
-                               vector<string>::const_iterator it  = dbs.begin();
-                               vector<string>::const_iterator end = dbs.end();
-                               for (; it != end; ++it) {
-                                       if (!contains(*it, ':')) {
+                               for (auto const & dbase : dbs) {
+                                       if (!contains(dbase, ':')) {
                                                vector<string> const enginetypes =
                                                        getVectorFromString(opt_enginetype_, "|");
-                                               for (string const &s: enginetypes)
-                                                       cite_default_biblio_style_[s] = *it;
+                                               for (string const & s: enginetypes)
+                                                       cite_default_biblio_style_[s] = dbase;
                                        } else {
                                                string eng;
-                                               string const db = split(*it, eng, ':');
+                                               string const db = split(dbase, eng, ':');
                                                cite_default_biblio_style_[eng] = db;
                                        }
                                }
@@ -881,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
        }
 
@@ -912,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");
 
@@ -929,10 +927,8 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
 
        min_toclevel_ = Layout::NOT_IN_TOC;
        max_toclevel_ = Layout::NOT_IN_TOC;
-       const_iterator lit = begin();
-       const_iterator len = end();
-       for (; lit != len; ++lit) {
-               int const toclevel = lit->toclevel;
+       for (auto const & lay : *this) {
+               int const toclevel = lay.toclevel;
                if (toclevel != Layout::NOT_IN_TOC) {
                        if (min_toclevel_ == Layout::NOT_IN_TOC)
                                min_toclevel_ = toclevel;
@@ -976,7 +972,6 @@ void TextClass::readTitleType(Lexer & lexrc)
 void TextClass::readOutputType(Lexer & lexrc)
 {
        LexerKeyword outputTypeTags[] = {
-               { "docbook",  DOCBOOK },
                { "latex",    LATEX },
                { "literate", LITERATE }
        };
@@ -989,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;
@@ -1009,7 +1003,6 @@ void TextClass::readClassOptions(Lexer & lexrc)
                CO_PAGESIZE_FORMAT,
                CO_PAGESTYLE,
                CO_OTHER,
-               CO_HEADER,
                CO_END
        };
 
@@ -1017,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 },
@@ -1063,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;
@@ -1197,7 +1185,7 @@ bool TextClass::readCiteEngine(Lexer & lexrc, ReadType rt, bool const add)
                cs.cmd = latex_cmd.empty() ? lyx_cmd : latex_cmd;
                if (!alias.empty()) {
                        vector<string> const aliases = getVectorFromString(alias);
-                       for (string const &s: aliases)
+                       for (string const & s: aliases)
                                cite_command_aliases_[s] = lyx_cmd;
                }
                vector<string> const stardescs = getVectorFromString(stardesc, "!");
@@ -1388,11 +1376,14 @@ bool TextClass::readFloat(Lexer & lexrc)
                FT_HTMLSTYLE,
                FT_HTMLATTR,
                FT_HTMLTAG,
+               FT_DOCBOOKATTR,
+               FT_DOCBOOKTAG,
                FT_LISTCOMMAND,
                FT_REFPREFIX,
                FT_ALLOWED_PLACEMENT,
                FT_ALLOWS_SIDEWAYS,
-               FT_ALLOWS_WIDE,
+               FT_ALLOWS_WIDE,
+               FT_REQUIRES,
                FT_END
        };
 
@@ -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 },
@@ -1412,6 +1405,7 @@ bool TextClass::readFloat(Lexer & lexrc)
                { "numberwithin", FT_WITHIN },
                { "placement", FT_PLACEMENT },
                { "refprefix", FT_REFPREFIX },
+               { "requires", FT_REQUIRES },
                { "style", FT_STYLE },
                { "type", FT_TYPE },
                { "usesfloatpkg", FT_USESFLOAT }
@@ -1423,6 +1417,8 @@ bool TextClass::readFloat(Lexer & lexrc)
        string htmlattr;
        docstring htmlstyle;
        string htmltag;
+       string docbookattr;
+       string docbooktag;
        string listname;
        string listcommand;
        string name;
@@ -1432,6 +1428,7 @@ bool TextClass::readFloat(Lexer & lexrc)
        string style;
        string type;
        string within;
+       string required;
        bool usesfloat = true;
        bool ispredefined = false;
        bool allowswide = true;
@@ -1507,6 +1504,10 @@ bool TextClass::readFloat(Lexer & lexrc)
                        lexrc.next();
                        usesfloat = lexrc.getBool();
                        break;
+               case FT_REQUIRES:
+                       lexrc.next();
+                       required = lexrc.getString();
+                       break;
                case FT_PREDEFINED:
                        lexrc.next();
                        ispredefined = lexrc.getBool();
@@ -1531,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;
@@ -1544,11 +1553,9 @@ bool TextClass::readFloat(Lexer & lexrc)
                if (!usesfloat && listcommand.empty()) {
                        // if this float uses the same auxfile as an existing one,
                        // there is no need for it to provide a list command.
-                       FloatList::const_iterator it = floatlist_.begin();
-                       FloatList::const_iterator en = floatlist_.end();
                        bool found_ext = false;
-                       for (; it != en; ++it) {
-                               if (it->second.ext() == ext) {
+                       for (auto const & f : floatlist_) {
+                               if (f.second.ext() == ext) {
                                        found_ext = true;
                                        break;
                                }
@@ -1559,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, 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;
 }
@@ -1609,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;
 }
 
 
@@ -1629,21 +1636,19 @@ 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 (const_iterator cit = begin(); cit != end(); ++cit)
-                       lyxerr  << " " << to_utf8(cit->name()) << endl;
+               for (auto const & lay : *this)
+                       lyxerr  << " " << to_utf8(lay.name()) << endl;
 
                // We require the name to exist
                static const Layout dummy;
                LASSERT(false, return dummy);
        }
 
-       return *it;
+       return *c;
 }
 
 
@@ -1652,22 +1657,21 @@ 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 (const_iterator cit = begin(); cit != end(); ++cit)
-                       LYXERR0(" " << to_utf8(cit->name()));
+               for (auto const & lay : *this)
+                       LYXERR0(" " << to_utf8(lay.name()));
 
                // we require the name to exist
                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;
 }
 
 
@@ -1678,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;
@@ -1721,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))
@@ -1735,14 +1763,13 @@ string DocumentClass::forcedLayouts() const
 {
        ostringstream os;
        bool first = true;
-       const_iterator const e = end();
-       for (const_iterator i = begin(); i != e; ++i) {
-               if (i->forcelocal > 0) {
+       for (auto const & lay : *this) {
+               if (lay.forcelocal > 0) {
                        if (first) {
                                os << "Format " << LAYOUT_FORMAT << '\n';
                                first = false;
                        }
-                       i->write(os);
+                       lay.write(os);
                }
        }
        return os.str();
@@ -1807,7 +1834,7 @@ bool TextClass::isPlainLayout(Layout const & layout) const
 
 Layout TextClass::createBasicLayout(docstring const & name, bool unknown) const
 {
-       static Layout * defaultLayout = NULL;
+       static Layout * defaultLayout = nullptr;
 
        if (defaultLayout) {
                defaultLayout->setUnknown(unknown);
@@ -1843,17 +1870,14 @@ DocumentClassPtr getDocumentClass(
 {
        DocumentClassPtr doc_class =
            DocumentClassPtr(new DocumentClass(baseClass));
-       LayoutModuleList::const_iterator it = modlist.begin();
-       LayoutModuleList::const_iterator en = modlist.end();
-       for (; it != en; ++it) {
-               string const modName = *it;
-               LyXModule * lm = theModuleList[modName];
+       for (auto const & mod : modlist) {
+               LyXModule * lm = theModuleList[mod];
                if (!lm) {
                        docstring const msg =
                                                bformat(_("The module %1$s has been requested by\n"
                                                "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));
+                                               "probably need to reconfigure LyX.\n"), from_utf8(mod));
                        if (!clone)
                                frontend::Alert::warning(_("Module not available"), msg);
                        continue;
@@ -1867,13 +1891,13 @@ DocumentClassPtr getDocumentClass(
                                        "Missing prerequisites:\n"
                                                "\t%2$s\n"
                                        "See section 3.1.2.3 (Modules) of the User's Guide for more information."),
-                               from_utf8(modName), prereqs);
+                               from_utf8(mod), prereqs);
                        frontend::Alert::warning(_("Package not available"), msg, true);
                }
                FileName layout_file = libFileSearch("layouts", lm->getFilename());
                if (!doc_class->read(layout_file, TextClass::MODULE)) {
                        docstring const msg =
-                                               bformat(_("Error reading module %1$s\n"), from_utf8(modName));
+                                               bformat(_("Error reading module %1$s\n"), from_utf8(mod));
                        frontend::Alert::warning(_("Read Error"), msg);
                }
        }
@@ -1927,10 +1951,8 @@ DocumentClass::DocumentClass(LayoutFile const & tc)
 
 bool DocumentClass::hasLaTeXLayout(std::string const & lay) const
 {
-       LayoutList::const_iterator it  = layoutlist_.begin();
-       LayoutList::const_iterator end = layoutlist_.end();
-       for (; it != end; ++it)
-               if (it->latexname() == lay)
+       for (auto const & l : layoutlist_)
+               if (l.latexname() == lay)
                        return true;
        return false;
 }
@@ -1951,17 +1973,15 @@ bool DocumentClass::hasTocLevels() const
 Layout const & DocumentClass::getTOCLayout() const
 {
        // we're going to look for the layout with the minimum toclevel
-       TextClass::LayoutList::const_iterator lit = begin();
-       TextClass::LayoutList::const_iterator const len = end();
        int minlevel = 1000;
-       Layout const * lay = NULL;
-       for (; lit != len; ++lit) {
-               int const level = lit->toclevel;
+       Layout const * lay = nullptr;
+       for (auto const & l : *this) {
+               int const level = l.toclevel;
                // we don't want Part or unnumbered sections
                if (level == Layout::NOT_IN_TOC || level < 0
-                   || level >= minlevel || lit->counter.empty())
+                       || level >= minlevel || l.counter.empty())
                        continue;
-               lay = &*lit;
+               lay = &l;
                minlevel = level;
        }
        if (lay)
@@ -2020,13 +2040,10 @@ vector<string> const DocumentClass::citeCommands(
        CiteEngineType const & type) const
 {
        vector<CitationStyle> const styles = citeStyles(type);
-       vector<CitationStyle>::const_iterator it = styles.begin();
-       vector<CitationStyle>::const_iterator end = styles.end();
        vector<string> cmds;
-       for (; it != end; ++it) {
-               CitationStyle const cite = *it;
-               cmds.push_back(cite.name);
-       }
+       for (auto const & cs : styles)
+               cmds.push_back(cs.name);
+
        return cmds;
 }