]> git.lyx.org Git - lyx.git/blobdiff - src/Buffer.cpp
Improve error message and ctests for input encoding cp858.
[lyx.git] / src / Buffer.cpp
index eff76bf1e84653f2c868096a7054c75fb02aa9d7..cb08e3c4fb9fdc2acb75a0e73a18862227ce730f 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
 
@@ -295,6 +310,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.
@@ -305,7 +322,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;
@@ -428,7 +449,7 @@ 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),
-         cite_labels_valid_(false), preview_error_(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),
@@ -450,6 +471,7 @@ Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
        bibinfo_cache_valid_ = cloned_buffer_->d->bibinfo_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;
@@ -790,10 +812,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;
 }
@@ -1698,13 +1719,6 @@ Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
 {
        OutputParams runparams = runparams_in;
 
-       // XeTeX with TeX fonts is only safe with ASCII encoding (see also #9740),
-       // Check here, because the "flavor" is not known in BufferParams::encoding()
-       // (power users can override this safety measure selecting "utf8-plain").
-       if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
-           && (runparams.encoding->name() != "utf8-plain"))
-               runparams.encoding = encodings.fromLyXName("ascii");
-
        string const encoding = runparams.encoding->iconvName();
        LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << ", fname=" << fname.realPath());
 
@@ -1712,9 +1726,11 @@ Buffer::ExportStatus Buffer::makeLaTeXFile(FileName const & fname,
        try { ofs.reset(encoding); }
        catch (iconv_codecvt_facet_exception const & e) {
                lyxerr << "Caught iconv exception: " << e.what() << endl;
-               Alert::error(_("Iconv software exception Detected"), bformat(_("Please "
-                       "verify that the support software for your encoding (%1$s) is "
-                       "properly installed"), from_ascii(encoding)));
+               Alert::error(_("Iconv software exception Detected"),
+                       bformat(_("Please verify that the 'iconv' support software is"
+                                         " properly installed and supports the selected encoding"
+                                         " (%1$s), or change the encoding in"
+                                         " Document>Settings>Language."), from_ascii(encoding)));
                return ExportError;
        }
        if (!openFileWrite(ofs, fname))
@@ -1802,16 +1818,6 @@ Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
 
        OutputParams runparams = runparams_in;
 
-       // XeTeX with TeX fonts is only safe with ASCII encoding,
-       // Check here, because the "flavor" is not known in BufferParams::encoding()
-       // (power users can override this safety measure selecting "utf8-plain").
-       if (!params().useNonTeXFonts && (runparams.flavor == OutputParams::XETEX)
-           && (runparams.encoding->name() != "utf8-plain"))
-               runparams.encoding = encodings.fromLyXName("ascii");
-       // FIXME: when only the current paragraph is shown, this is ignored
-       //        (or not reached) and characters encodable in the current
-       //        encoding are not converted to ASCII-representation.
-
        // Some macros rely on font encoding
        runparams.main_fontenc = params().main_font_encoding();
 
@@ -1830,8 +1836,10 @@ Buffer::ExportStatus 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_CJK = features.mustProvide("CJK");
+       }
        LYXERR(Debug::LATEX, "  Buffer validation done.");
 
        bool const output_preamble =
@@ -1945,10 +1953,14 @@ Buffer::ExportStatus Buffer::writeLaTeXSource(otexstream & os,
 
                // Biblatex bibliographies are loaded here
                if (params().useBiblatex()) {
-                       vector<docstring> const bibfiles =
+                       vector<pair<docstring, string>> const bibfiles =
                                prepareBibFilePaths(runparams, getBibfiles(), true);
-                       for (docstring const & file: bibfiles)
-                               os << "\\addbibresource{" << file << "}\n";
+                       for (pair<docstring, string> const & file: bibfiles) {
+                               os << "\\addbibresource";
+                               if (!file.second.empty())
+                                       os << "[bibencoding=" << file.second << "]";
+                               os << "{" << file.first << "}\n";
+                       }
                }
 
                if (!runparams.dryrun && features.hasPolyglossiaExclusiveLanguages()
@@ -2404,6 +2416,13 @@ docstring_list const & Buffer::getBibfiles(UpdateScope scope) const
        Buffer const * const pbuf = masterBuffer();
        if (pbuf != this && scope != UpdateChildOnly)
                return pbuf->getBibfiles();
+
+       // In 2.3.x, we have:
+       //if (!d->bibfile_cache_valid_)
+       //      this->updateBibfilesCache(scope);
+       // I think that is a leftover, but there have been so many back-
+       // and-forths with this, due to Windows issues, that I am not sure.
+
        return d->bibfiles_cache_;
 }
 
@@ -2475,12 +2494,28 @@ void Buffer::checkIfBibInfoCacheIsValid() const
                return;
        }
 
-       // if we already know the cache is invalid, no need to check
-       // the timestamps
+       // 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;
 
-       // we'll assume it's ok and change this if it's not
+       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;
 
@@ -2532,6 +2567,7 @@ void Buffer::reloadBibInfoCache(bool const force) const
        clearBibFileCache();
        d->bibinfo_.clear();
        FileNameList checkedFiles;
+       d->have_bibitems_ = false;
        collectBibKeys(checkedFiles);
        d->bibinfo_cache_valid_ = true;
 }
@@ -2539,8 +2575,15 @@ void Buffer::reloadBibInfoCache(bool const force) 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;
+               }
+       }
 }
 
 
@@ -3245,7 +3288,7 @@ string const Buffer::prepareFileNameForLaTeX(string const & name,
 }
 
 
-vector<docstring> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
+vector<pair<docstring, string>> const Buffer::prepareBibFilePaths(OutputParams const & runparams,
                                                docstring_list const & bibfilelist,
                                                bool const add_extension) const
 {
@@ -3259,7 +3302,7 @@ vector<docstring> const Buffer::prepareBibFilePaths(OutputParams const & runpara
        // Otherwise, store the (maybe absolute) path to the original,
        // unmangled database name.
 
-       vector<docstring> res;
+       vector<pair<docstring, string>> res;
 
        // determine the export format
        string const tex_format = flavor2format(runparams.flavor);
@@ -3331,9 +3374,20 @@ vector<docstring> const Buffer::prepareBibFilePaths(OutputParams const & runpara
 
                if (contains(path, ' '))
                        found_space = true;
+               string enc;
+               if (params().useBiblatex() && !params().bibFileEncoding(utf8input).empty())
+                       enc = params().bibFileEncoding(utf8input);
+
+               bool recorded = false;
+               for (pair<docstring, string> pe : res) {
+                       if (pe.first == path) {
+                               recorded = true;
+                               break;
+                       }
 
-               if (find(res.begin(), res.end(), path) == res.end())
-                       res.push_back(path);
+               }
+               if (!recorded)
+                       res.push_back(make_pair(path, enc));
        }
 
        // Check if there are spaces in the path and warn BibTeX users, if so.
@@ -3877,13 +3931,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;
 }
 
 
@@ -3900,22 +3953,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)
+{
+       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,
+                                     bool const active) const
 {
-       masterBuffer()->d->ref_cache_[label].first = il;
+       for (auto & rc : masterBuffer()->d->label_cache_) {
+               if (rc.label == label && (rc.active || !active))
+                       return rc.inset;
+       }
+       return nullptr;
 }
 
 
-InsetLabel const * Buffer::insetLabel(docstring const & label) const
+bool Buffer::activeLabel(docstring const & label) const
 {
-       return masterBuffer()->d->ref_cache_[label].first;
+       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();
+       }
 }
 
 
@@ -4384,9 +4458,15 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir
                        if (!put_in_tempdir) {
                                // Only show this alert if this is an export to a non-temporary
                                // file (not for previewing).
-                               Alert::error(_("Couldn't export file"), bformat(
-                                       _("No information for exporting the format %1$s."),
-                                       theFormats().prettyName(format)));
+                               docstring s = bformat(_("No information for exporting the format %1$s."),
+                                                     theFormats().prettyName(format));
+                               if (format == "pdf4")
+                                       s += "\n"
+                                         + bformat(_("Hint: use non-TeX fonts or set input encoding "
+                                                     " to '%1$s' or '%2$s'"),
+                                                   from_utf8(encodings.fromLyXName("utf8")->guiName()),
+                                                   from_utf8(encodings.fromLyXName("ascii")->guiName()));
+                               Alert::error(_("Couldn't export file"), s);
                        }
                        return ExportNoPathToFormat;
                }
@@ -4457,7 +4537,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;
@@ -4697,6 +4777,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;
        }
 
@@ -5038,16 +5144,20 @@ void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
                docstring itemlabel;
                switch (par.itemdepth) {
                case 0:
+                       // • U+2022 BULLET
                        itemlabel = char_type(0x2022);
                        break;
                case 1:
+                       // – U+2013 EN DASH
                        itemlabel = char_type(0x2013);
                        break;
                case 2:
+                       // ∗ U+2217 ASTERISK OPERATOR
                        itemlabel = char_type(0x2217);
                        break;
                case 3:
-                       itemlabel = char_type(0x2219); // or 0x00b7
+                       // · U+00B7 MIDDLE DOT
+                       itemlabel = char_type(0x00b7);
                        break;
                }
                par.params().labelString(itemlabel);
@@ -5149,6 +5259,11 @@ void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
        // to resolve macros in it.
        parit.text()->setMacrocontextPosition(parit);
 
+       // Reset bibitem counter in master (#8499)
+       Buffer const * const master = masterBuffer();
+       if (master == this && !d->ignore_parent)
+               master->params().documentClass().counters().reset(from_ascii("bibitem"));
+
        depth_type maxdepth = 0;
        pit_type const lastpit = parit.lastpit();
        for ( ; parit.pit() <= lastpit ; ++parit.pit()) {