]> git.lyx.org Git - lyx.git/blobdiff - src/Buffer.cpp
Provide proper fallback if a bibliography processor is not found
[lyx.git] / src / Buffer.cpp
index 4ea890af2cdf17ac7a3462c8332eb04bcfd4bf78..ec480f7584366bb26e987049a4d764a98387fa36 100644 (file)
@@ -135,7 +135,22 @@ namespace {
 int const LYX_FORMAT = LYX_FORMAT_LYX;
 
 typedef map<string, bool> DepClean;
-typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
+
+// Information about labels and their associated refs
+struct LabelInfo {
+       /// label string
+       docstring label;
+       /// label inset
+       InsetLabel const * inset;
+       /// associated references cache
+       Buffer::References references;
+       /// whether this label is active (i.e., not deleted)
+       bool active;
+};
+
+typedef vector<LabelInfo> LabelCache;
+
+typedef map<docstring, Buffer::References> RefCache;
 
 } // namespace
 
@@ -297,6 +312,8 @@ public:
        /// we ran updateBuffer(), i.e., whether citation labels may need
        /// to be updated.
        mutable bool cite_labels_valid_;
+       /// Do we have a bibliography environment?
+       mutable bool have_bibitems_;
 
        /// These two hold the file name and format, written to by
        /// Buffer::preview and read from by LFUN_BUFFER_VIEW_CACHE.
@@ -307,7 +324,11 @@ public:
        /// was missing).
        bool preview_error_;
 
+       /// Cache the references associated to a label and their positions
+       /// in the buffer.
        mutable RefCache ref_cache_;
+       /// Cache the label insets and their activity status.
+       mutable LabelCache label_cache_;
 
        /// our Text that should be wrapped in an InsetText
        InsetText * inset;
@@ -431,8 +452,8 @@ Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
          file_fully_loaded(false), file_format(LYX_FORMAT), need_format_backup(false),
          ignore_parent(false),  toc_backend(owner), macro_lock(false),
          checksum_(0), wa_(0),  gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
-         bibfile_cache_valid_(false), cite_labels_valid_(false), preview_error_(false),
-         inset(0), preview_loader_(0), cloned_buffer_(cloned_buffer),
+         bibfile_cache_valid_(false), cite_labels_valid_(false), have_bibitems_(false),
+         preview_error_(false), inset(0), preview_loader_(0), cloned_buffer_(cloned_buffer),
          clone_list_(0), doing_export(false),
          tracked_changes_present_(0), externally_modified_(false), parent_buffer(0),
          word_count_(0), char_count_(0), blank_count_(0)
@@ -454,6 +475,7 @@ Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
        bibfile_cache_valid_ = cloned_buffer_->d->bibfile_cache_valid_;
        bibfile_status_ = cloned_buffer_->d->bibfile_status_;
        cite_labels_valid_ = cloned_buffer_->d->cite_labels_valid_;
+       have_bibitems_ = cloned_buffer_->d->have_bibitems_;
        unnamed = cloned_buffer_->d->unnamed;
        internal_buffer = cloned_buffer_->d->internal_buffer;
        layout_position = cloned_buffer_->d->layout_position;
@@ -570,13 +592,13 @@ Buffer::~Buffer()
 }
 
 
-Buffer * Buffer::cloneFromMaster() const
+Buffer * Buffer::cloneWithChildren() const
 {
        BufferMap bufmap;
        cloned_buffers.push_back(new CloneList);
        CloneList * clones = cloned_buffers.back();
 
-       masterBuffer()->cloneWithChildren(bufmap, clones);
+       cloneWithChildren(bufmap, clones);
 
        // make sure we got cloned
        BufferMap::const_iterator bit = bufmap.find(this);
@@ -802,10 +824,9 @@ FileName Buffer::Impl::exportFileName() const
        if (branch_suffix.empty())
                return filename;
 
-       string const name = filename.onlyFileNameWithoutExt()
-               + to_utf8(branch_suffix);
+       string const name = addExtension(filename.onlyFileNameWithoutExt()
+                       + to_utf8(branch_suffix), filename.extension());
        FileName res(filename.onlyPath().absFileName() + "/" + name);
-       res.changeExtension(filename.extension());
 
        return res;
 }
@@ -1052,6 +1073,10 @@ bool Buffer::readDocument(Lexer & lex)
                                                << absFileName()
                                                << ") does not include "
                                                "this document. Ignoring the master assignment.");
+                               // If the master has just been created, un-hide it (#11162)
+                               if (!master->fileName().exists())
+                                       lyx::dispatch(FuncRequest(LFUN_BUFFER_SWITCH,
+                                                                 master->absFileName()));
                        }
                }
        }
@@ -1427,6 +1452,9 @@ bool Buffer::save() const
 
        FileName savefile(tempfile->name());
        LYXERR(Debug::FILES, "Saving to " << savefile.absFileName());
+       if (!savefile.clonePermissions(fileName()))
+               LYXERR0("Failed to clone the permission from " << fileName().absFileName() << " to " << savefile.absFileName());
+
        if (!writeFile(savefile))
                return false;
 
@@ -1797,8 +1825,10 @@ void Buffer::writeLaTeXSource(otexstream & os,
        LaTeXFeatures features(*this, params(), runparams);
        validate(features);
        // This is only set once per document (in master)
-       if (!runparams.is_child)
+       if (!runparams.is_child) {
                runparams.use_polyglossia = features.usePolyglossia();
+               runparams.use_hyperref = features.isRequired("hyperref");
+       }
        LYXERR(Debug::LATEX, "  Buffer validation done.");
 
        bool const output_preamble =
@@ -1872,8 +1902,7 @@ void Buffer::writeLaTeXSource(otexstream & os,
                                            "file path name."),
                                          inputpath, uncodable_glyphs));
                        } else {
-                               string docdir =
-                                       support::latex_path(original_path);
+                               string docdir = os::latex_path(original_path);
                                if (contains(docdir, '#')) {
                                        docdir = subst(docdir, "#", "\\#");
                                        os << "\\catcode`\\#=11"
@@ -1884,9 +1913,27 @@ void Buffer::writeLaTeXSource(otexstream & os,
                                        os << "\\catcode`\\%=11"
                                              "\\def\\%{%}\\catcode`\\%=14\n";
                                }
+                               if (contains(docdir, '~'))
+                                       docdir = subst(docdir, "~", "\\string~");
+                               bool const nonascii = !isAscii(from_utf8(docdir));
+                               // LaTeX 2019/10/01 handles non-ascii path without detokenize
+                               bool const utfpathlatex = features.isAvailable("LaTeX-2019/10/01");
+                               bool const detokenize = !utfpathlatex && nonascii;
+                               bool const quote = contains(docdir, ' ');
+                               if (utfpathlatex && nonascii)
+                                       os << "\\UseRawInputEncoding\n";
                                os << "\\makeatletter\n"
-                                  << "\\def\\input@path{{"
-                                  << docdir << "}}\n"
+                                  << "\\def\\input@path{{";
+                               if (detokenize)
+                                       os << "\\detokenize{";
+                               if (quote)
+                                       os << "\"";
+                               os << docdir;
+                               if (quote)
+                                       os << "\"";
+                               if (detokenize)
+                                       os << "}";
+                               os << "}}\n"
                                   << "\\makeatother\n";
                        }
                }
@@ -2163,10 +2210,6 @@ void Buffer::writeLyXHTMLSource(odocstream & os,
                if (!styles.empty())
                        os << "\n<!-- Text Class Preamble -->\n" << styles << '\n';
 
-               styles = features.getPreambleSnippets().str;
-               if (!styles.empty())
-                       os << "\n<!-- Preamble Snippets -->\n" << styles << '\n';
-
                // we will collect CSS information in a stream, and then output it
                // either here, as part of the header, or else in a separate file.
                odocstringstream css;
@@ -2321,6 +2364,10 @@ void Buffer::getLabelList(vector<docstring> & list) const
 }
 
 
+// This is not in master, so it has been removed at 2126d5a3, on
+// 14 December 2018, so as to test whether it's needed. If there
+// aren't any complaints, it can be fully removed.
+#if 0
 void Buffer::updateBibfilesCache(UpdateScope scope) const
 {
        // FIXME This is probably unnecssary, given where we call this.
@@ -2330,6 +2377,7 @@ void Buffer::updateBibfilesCache(UpdateScope scope) const
                return;
        }
 
+       docstring_list old_cache = d->bibfiles_cache_;
        d->bibfiles_cache_.clear();
        for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
                if (it->lyxCode() == BIBTEX_CODE) {
@@ -2353,15 +2401,18 @@ void Buffer::updateBibfilesCache(UpdateScope scope) const
                }
        }
        d->bibfile_cache_valid_ = true;
-       d->bibinfo_cache_valid_ = false;
        d->cite_labels_valid_ = false;
+       if (d->bibfiles_cache_ != old_cache)
+               d->bibinfo_cache_valid_ = false;
 }
+#endif
 
 
 void Buffer::invalidateBibinfoCache() const
 {
        d->bibinfo_cache_valid_ = false;
        d->cite_labels_valid_ = false;
+       removeBiblioTempFiles();
        // also invalidate the cache for the parent buffer
        Buffer const * const pbuf = d->parent();
        if (pbuf)
@@ -2377,9 +2428,6 @@ docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
        if (pbuf != this && scope != UpdateChildOnly)
                return pbuf->getBibfiles();
 
-       if (!d->bibfile_cache_valid_)
-               this->updateBibfilesCache(scope);
-
        return d->bibfiles_cache_;
 }
 
@@ -2424,17 +2472,25 @@ FileName Buffer::getBibfilePath(docstring const & bibid) const
        map<docstring, FileName>::const_iterator it =
                bibfileCache.find(bibid);
        if (it != bibfileCache.end()) {
-               // i.e., bibfileCache[bibid]
+               // i.e., return bibfileCache[bibid];
                return it->second;
        }
 
        LYXERR(Debug::FILES, "Reading file location for " << bibid);
-       string texfile = changeExtension(to_utf8(bibid), "bib");
-       // note that, if the filename can be found directly from the path,
-       // findtexfile will just return a FileName object for that path.
-       FileName file(findtexfile(texfile, "bib"));
-       if (file.empty())
-               file = FileName(makeAbsPath(texfile, filePath()));
+       string const texfile = changeExtension(to_utf8(bibid), "bib");
+       // we need to check first if this file exists where it's said to be.
+       // there's a weird bug that occurs otherwise: if the file is in the
+       // Buffer's directory but has the same name as some file that would be
+       // found by kpsewhich, then we find the latter, not the former.
+       FileName const local_file = makeAbsPath(texfile, filePath());
+       FileName file = local_file;
+       if (!file.exists()) {
+               // there's no need now to check whether the file can be found
+               // locally
+               file = findtexfile(texfile, "bib", true);
+               if (file.empty())
+                       file = local_file;
+       }
        LYXERR(Debug::FILES, "Found at: " << file);
 
        bibfileCache[bibid] = file;
@@ -2451,6 +2507,30 @@ void Buffer::checkIfBibInfoCacheIsValid() const
                return;
        }
 
+       // If we already know the cache is invalid, stop here.
+       // This is important in the case when the bibliography
+       // environment (rather than Bib[la]TeX) is used.
+       // In that case, the timestamp check below gives no
+       // sensible result. Rather than that, the cache will
+       // be invalidated explicitly via invalidateBibInfoCache()
+       // by the Bibitem inset.
+       // Same applies for bib encoding changes, which trigger
+       // invalidateBibInfoCache() by InsetBibtex.
+       if (!d->bibinfo_cache_valid_)
+               return;
+
+       if (d->have_bibitems_) {
+               // We have a bibliography environment.
+               // Invalidate the bibinfo cache unconditionally.
+               // Cite labels will get invalidated by the inset if needed.
+               d->bibinfo_cache_valid_ = false;
+               return;
+       }
+
+       // OK. This is with Bib(la)tex. We'll assume the cache
+       // is valid and change this if we find changes in the bibs.
+       d->bibinfo_cache_valid_ = true;
+       d->cite_labels_valid_ = true;
        // compare the cached timestamps with the actual ones.
        docstring_list const & bibfiles_cache = getBibfiles();
        for (auto const & bf : bibfiles_cache) {
@@ -2466,8 +2546,17 @@ void Buffer::checkIfBibInfoCacheIsValid() const
 }
 
 
+void Buffer::clearBibFileCache() const
+{
+       bibfileCache.clear();
+}
+
+
 void Buffer::reloadBibInfoCache() const
 {
+       if (isInternal())
+               return;
+
        // use the master's cache
        Buffer const * const tmp = masterBuffer();
        if (tmp != this) {
@@ -2478,14 +2567,16 @@ void Buffer::reloadBibInfoCache() const
        checkIfBibInfoCacheIsValid();
        if (d->bibinfo_cache_valid_)
                return;
+       LYXERR(Debug::FILES, "Bibinfo cache was invalid.");
 
        // re-read file locations when this info changes
        // FIXME Is this sufficient? Or should we also force that
        // in some other cases? If so, then it is easy enough to
        // add the following line in some other places.
-       bibfileCache.clear();
+       clearBibFileCache();
        d->bibinfo_.clear();
        FileNameList checkedFiles;
+       d->have_bibitems_ = false;
        collectBibKeys(checkedFiles);
        d->bibinfo_cache_valid_ = true;
 }
@@ -2493,23 +2584,28 @@ void Buffer::reloadBibInfoCache() const
 
 void Buffer::collectBibKeys(FileNameList & checkedFiles) const
 {
-       for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
+       for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
                it->collectBibKeys(it, checkedFiles);
+               if (it->lyxCode() == BIBITEM_CODE) {
+                       if (parent() != 0)
+                               parent()->d->have_bibitems_ = true;
+                       else
+                               d->have_bibitems_ = true;
+               }
+       }
 }
 
 
 void Buffer::addBiblioInfo(BiblioInfo const & bin) const
 {
-       // We add the biblio info to the master buffer,
-       // if there is one, but also to every single buffer,
-       // in case a child is compiled alone.
+       // We add the biblio info to the parent buffer,
+       // if there is one, but also to this buffer, in case
+       // it is compiled alone.
        BiblioInfo & bi = d->bibinfo_;
        bi.mergeBiblioInfo(bin);
 
-       if (parent() != 0) {
-               BiblioInfo & masterbi = parent()->d->bibinfo_;
-               masterbi.mergeBiblioInfo(bin);
-       }
+       if (parent())
+               parent()->addBiblioInfo(bin);
 }
 
 
@@ -2953,6 +3049,7 @@ void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
                for ( ; cur ; cur.forwardPar())
                        cur.paragraph().anonymize();
                dr.forceBufferUpdate();
+               dr.screenUpdate(Update::Force);
                break;
        }
 
@@ -3847,13 +3944,12 @@ Buffer::References & Buffer::getReferenceCache(docstring const & label)
 
        RefCache::iterator it = d->ref_cache_.find(label);
        if (it != d->ref_cache_.end())
-               return it->second.second;
+               return it->second;
 
-       static InsetLabel const * dummy_il = 0;
        static References const dummy_refs = References();
        it = d->ref_cache_.insert(
-               make_pair(label, make_pair(dummy_il, dummy_refs))).first;
-       return it->second.second;
+               make_pair(label, dummy_refs)).first;
+       return it->second;
 }
 
 
@@ -3870,22 +3966,43 @@ void Buffer::addReference(docstring const & label, Inset * inset, ParIterator it
 }
 
 
-void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il)
+void Buffer::setInsetLabel(docstring const & label, InsetLabel const * il,
+                          bool const active)
 {
-       masterBuffer()->d->ref_cache_[label].first = il;
+       LabelInfo linfo;
+       linfo.label = label;
+       linfo.inset = il;
+       linfo.active = active;
+       masterBuffer()->d->label_cache_.push_back(linfo);
 }
 
 
-InsetLabel const * Buffer::insetLabel(docstring const & label) const
+InsetLabel const * Buffer::insetLabel(docstring const & label,
+                                     bool const active) const
 {
-       return masterBuffer()->d->ref_cache_[label].first;
+       for (auto & rc : masterBuffer()->d->label_cache_) {
+               if (rc.label == label && (rc.active || !active))
+                       return rc.inset;
+       }
+       return nullptr;
+}
+
+
+bool Buffer::activeLabel(docstring const & label) const
+{
+       if (!insetLabel(label, true))
+               return false;
+
+       return true;
 }
 
 
 void Buffer::clearReferenceCache() const
 {
-       if (!d->parent())
+       if (!d->parent()) {
                d->ref_cache_.clear();
+               d->label_cache_.clear();
+       }
 }
 
 
@@ -3977,6 +4094,7 @@ unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
                        LaTeXFeatures features(*this, params(), runparams);
                        validate(features);
                        runparams.use_polyglossia = features.usePolyglossia();
+                       runparams.use_hyperref = features.isRequired("hyperref");
                        // latex or literate
                        otexstream ots(os);
                        // output above
@@ -4360,7 +4478,7 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir
                                // file (not for previewing).
                                Alert::error(_("Couldn't export file"), bformat(
                                        _("No information for exporting the format %1$s."),
-                                       theFormats().prettyName(format)));
+                                       translateIfPossible(theFormats().prettyName(format))));
                        }
                        return ExportNoPathToFormat;
                }
@@ -4425,7 +4543,7 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir
                        bformat(_("The directory path to the document\n%1$s\n"
                            "contains spaces, but your TeX installation does "
                            "not allow them. You should save the file to a directory "
-                                       "whose name does not contain spaces."), from_ascii(filePath())));
+                                       "whose name does not contain spaces."), from_utf8(filePath())));
                return ExportTexPathHasSpaces;
        } else {
                runparams.nice = false;
@@ -4544,13 +4662,13 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir
                } else {
                        message(bformat(_("Document exported as %1$s "
                                "to file `%2$s'"),
-                               theFormats().prettyName(format),
+                               translateIfPossible(theFormats().prettyName(format)),
                                makeDisplayPath(result_file)));
                }
        } else {
                // This must be a dummy converter like fax (bug 1888)
                message(bformat(_("Document exported as %1$s"),
-                       theFormats().prettyName(format)));
+                       translateIfPossible(theFormats().prettyName(format))));
        }
 
        return success ? ExportSuccess : ExportConverterError;
@@ -4664,6 +4782,32 @@ Buffer::ReadStatus Buffer::loadEmergency()
                                _("&Remove"), _("&Keep"));
                if (del_emerg == 0)
                        emergencyFile.removeFile();
+               else {
+                       // See bug #11464
+                       FileName newname;
+                       string const ename = emergencyFile.absFileName();
+                       bool noname = true;
+                       // Surely we can find one in 100 tries?
+                       for (int i = 1; i < 100; ++i) {
+                               newname.set(ename + to_string(i) + ".lyx");
+                               if (!newname.exists()) {
+                                       noname = false;
+                                       break;
+                               }
+                       }
+                       if (!noname) {
+                               // renameTo returns true on success. So inverting that
+                               // will give us true if we fail.
+                               noname = !emergencyFile.renameTo(newname);
+                       }
+                       if (noname) {
+                               Alert::warning(_("Can't rename emergency file!"),
+                                       _("LyX was unable to rename the emergency file. "
+                                         "You should do so manually. Otherwise, you will be"
+                                         "asked about it again the next time you try to load"
+                                         "this file, and may over-write your own work."));
+                       }
+               }
                return ReadOriginal;
        }
 
@@ -4798,6 +4942,11 @@ void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
        if (master == this && !d->ignore_parent) {
                textclass.counters().reset(from_ascii("bibitem"));
                reloadBibInfoCache();
+               // we will re-read this cache as we go through, but we need
+               // to know whether it's changed to know whether we need to
+               // update the bibinfo cache.
+               old_bibfiles = d->bibfiles_cache_;
+               d->bibfiles_cache_.clear();
        }
 
        // keep the buffers to be children in this set. If the call from the