]> git.lyx.org Git - lyx.git/blobdiff - src/Buffer.cpp
Account for old versions of Pygments
[lyx.git] / src / Buffer.cpp
index 892898b046214f116139d61cffcc42fb65629509..61b89200c17a7b784205965985077d02fdb2e9a6 100644 (file)
@@ -91,6 +91,7 @@
 #include "support/debug.h"
 #include "support/docstring_list.h"
 #include "support/ExceptionMessage.h"
+#include "support/FileMonitor.h"
 #include "support/FileName.h"
 #include "support/FileNameList.h"
 #include "support/filetools.h"
@@ -263,9 +264,8 @@ public:
        /// Container for all sort of Buffer dependant errors.
        map<string, ErrorList> errorLists;
 
-       /// timestamp and checksum used to test if the file has been externally
-       /// modified. (Used to properly enable 'File->Revert to saved', bug 4114).
-       time_t timestamp_;
+       /// checksum used to test if the file has been externally modified.  Used to
+       /// double check whether the file had been externally modified when saving.
        unsigned long checksum_;
 
        ///
@@ -376,6 +376,15 @@ public:
        // display the review toolbar, for instance)
        mutable bool tracked_changes_present_;
 
+       // Make sure the file monitor monitors the good file.
+       void refreshFileMonitor();
+
+       /// Notify or clear of external modification
+       void fileExternallyModified(bool exists);
+
+       /// has been externally modified? Can be reset by the user.
+       mutable bool externally_modified_;
+
 private:
        /// So we can force access via the accessors.
        mutable Buffer const * parent_buffer;
@@ -384,6 +393,7 @@ private:
        int char_count_;
        int blank_count_;
 
+       FileMonitorPtr file_monitor_;
 };
 
 
@@ -419,13 +429,15 @@ Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
        : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
          internal_buffer(false), read_only(readonly_), filename(file),
          file_fully_loaded(false), file_format(LYX_FORMAT), need_format_backup(false),
-         ignore_parent(false),  toc_backend(owner), macro_lock(false), timestamp_(0),
+         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),
-         clone_list_(0), doing_export(false), parent_buffer(0),
+         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)
 {
+       refreshFileMonitor();
        if (!cloned_buffer_) {
                temppath = createBufferTmpDir();
                lyxvc.setBuffer(owner_);
@@ -534,7 +546,11 @@ Buffer::~Buffer()
 
                if (!isClean()) {
                        docstring msg = _("LyX attempted to close a document that had unsaved changes!\n");
-                       msg += emergencyWrite();
+                       try {
+                               msg += emergencyWrite();
+                       } catch (...) {
+                               msg += "  " + _("Save failed! Document is lost.");
+                       }
                        Alert::warning(_("Attempting to close changed document!"), msg);
                }
 
@@ -706,7 +722,7 @@ BufferParams const & Buffer::masterParams() const
 double Buffer::fontScalingFactor() const
 {
        return isExporting() ? 75.0 * params().html_math_img_scale
-               : 0.01 * lyxrc.dpi * lyxrc.zoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
+               : 0.01 * lyxrc.dpi * lyxrc.currentZoom * lyxrc.preview_scale_factor * params().display_pixel_ratio;
 }
 
 
@@ -815,7 +831,7 @@ string Buffer::logName(LogType * type) const
        FileName const bname(
                addName(path, onlyFileName(
                        changeExtension(filename,
-                                       formats.extension(params().bufferFormat()) + ".out"))));
+                                       theFormats().extension(params().bufferFormat()) + ".out"))));
 
        // Also consider the master buffer log file
        FileName masterfname = fname;
@@ -863,6 +879,7 @@ void Buffer::setFileName(FileName const & fname)
 {
        bool const changed = fname != d->filename;
        d->filename = fname;
+       d->refreshFileMonitor();
        if (changed)
                lyxvc().file_found_hook(fname);
        setReadonly(d->filename.isReadOnly());
@@ -1065,7 +1082,7 @@ bool Buffer::readDocument(Lexer & lex)
 
 bool Buffer::importString(string const & format, docstring const & contents, ErrorList & errorList)
 {
-       Format const * fmt = formats.getFormat(format);
+       Format const * fmt = theFormats().getFormat(format);
        if (!fmt)
                return false;
        // It is important to use the correct extension here, since some
@@ -1179,7 +1196,7 @@ Buffer::ReadStatus Buffer::readFile(FileName const & fn)
 
        d->file_fully_loaded = true;
        d->read_only = !d->filename.isWritable();
-       params().compressed = formats.isZippedFile(d->filename);
+       params().compressed = theFormats().isZippedFile(d->filename);
        saveCheckSum();
        return ReadSuccess;
 }
@@ -1293,7 +1310,7 @@ Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
        command << os::python()
                << ' ' << quoteName(lyx2lyx.toFilesystemEncoding())
                << " -t " << convert<string>(LYX_FORMAT)
-               << " -o " << quoteName(tmpfile.toFilesystemEncoding())
+               << " -o " << quoteName(tmpfile.toSafeFilesystemEncoding())
                << ' ' << quoteName(fn.toSafeFilesystemEncoding());
        string const command_str = command.str();
 
@@ -1374,7 +1391,7 @@ bool Buffer::save() const
        }
 
        // ask if the disk file has been externally modified (use checksum method)
-       if (fileName().exists() && isExternallyModified(checksum_method)) {
+       if (fileName().exists() && isChecksumModified()) {
                docstring text =
                        bformat(_("Document %1$s has been externally modified. "
                                "Are you sure you want to overwrite this file?"), file);
@@ -1389,12 +1406,12 @@ bool Buffer::save() const
 
        // if the file does not yet exist, none of the backup activity
        // that follows is necessary
-  if (!fileName().exists()) {
+       if (!fileName().exists()) {
                if (!writeFile(fileName()))
-      return false;
-    markClean();
-    return true;
-  }
+                       return false;
+               markClean();
+               return true;
+       }
 
        // we first write the file to a new name, then move it to its
        // proper location once that has been done successfully. that
@@ -1585,7 +1602,7 @@ docstring Buffer::emergencyWrite()
                return user_message;
        }
 
-       user_message += "  " + _("Save failed! Bummer. Document is lost.");
+       user_message += "  " + _("Save failed! Document is lost.");
        // Don't try again.
        markClean();
        return user_message;
@@ -1720,6 +1737,7 @@ bool Buffer::makeLaTeXFile(FileName const & fname,
        catch (exception const & e) {
                errorList.push_back(ErrorItem(_("conversion failed"),
                                              _(e.what())));
+               lyxerr << e.what() << endl;
                failed_export = true;
        }
        catch (...) {
@@ -2514,7 +2532,7 @@ bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
        switch (cmd.action()) {
 
        case LFUN_BUFFER_TOGGLE_READ_ONLY:
-               flag.setOnOff(isReadonly());
+               flag.setOnOff(hasReadonlyFlag());
                break;
 
                // FIXME: There is need for a command-line import.
@@ -2533,8 +2551,8 @@ bool Buffer::getStatus(FuncRequest const & cmd, FuncStatus & flag)
                        enable = true;
                        break;
                }
-               string format =
-                       arg.empty() ? params().getDefaultOutputFormat() : to_utf8(arg);
+               string format = (arg.empty() || arg == "default") ?
+                       params().getDefaultOutputFormat() : to_utf8(arg);
                size_t pos = format.find(' ');
                if (pos != string::npos)
                        format = format.substr(0, pos);
@@ -2638,12 +2656,12 @@ void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
                                dr.setMessage(log);
                }
                else
-                       setReadonly(!isReadonly());
+                       setReadonly(!hasReadonlyFlag());
                break;
 
        case LFUN_BUFFER_EXPORT: {
-               string const format =
-                       argument.empty() ? params().getDefaultOutputFormat() : argument;
+               string const format = (argument.empty() || argument == "default") ?
+                       params().getDefaultOutputFormat() : argument;
                ExportStatus const status = doExport(format, false);
                dr.setError(status != ExportSuccess);
                if (status != ExportSuccess)
@@ -2667,7 +2685,7 @@ void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
        case LFUN_BUFFER_EXPORT_CUSTOM: {
                string format_name;
                string command = split(argument, format_name, ' ');
-               Format const * format = formats.getFormat(format_name);
+               Format const * format = theFormats().getFormat(format_name);
                if (!format) {
                        lyxerr << "Format \"" << format_name
                                << "\" not recognized!"
@@ -2826,7 +2844,7 @@ void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
        }
 
        case LFUN_BUFFER_VIEW_CACHE:
-               if (!formats.view(*this, d->preview_file_,
+               if (!theFormats().view(*this, d->preview_file_,
                                  d->preview_format_))
                        dr.setMessage(_("Error viewing the output file."));
                break;
@@ -2994,29 +3012,19 @@ bool Buffer::isClean() const
 }
 
 
-bool Buffer::isExternallyModified(CheckMethod method) const
+bool Buffer::isChecksumModified() const
 {
        LASSERT(d->filename.exists(), return false);
-       // if method == timestamp, check timestamp before checksum
-       return (method == checksum_method
-               || d->timestamp_ != d->filename.lastModified())
-               && d->checksum_ != d->filename.checksum();
+       return d->checksum_ != d->filename.checksum();
 }
 
 
 void Buffer::saveCheckSum() const
 {
        FileName const & file = d->filename;
-
        file.refresh();
-       if (file.exists()) {
-               d->timestamp_ = file.lastModified();
-               d->checksum_ = file.checksum();
-       } else {
-               // in the case of save to a new file.
-               d->timestamp_ = 0;
-               d->checksum_ = 0;
-       }
+       d->checksum_ = file.exists() ? file.checksum()
+               : 0; // in the case of save to a new file.
 }
 
 
@@ -3030,6 +3038,7 @@ void Buffer::markClean() const
        // autosave
        d->bak_clean = true;
        d->undo_.markDirty();
+       clearExternalModification();
 }
 
 
@@ -3250,12 +3259,18 @@ void Buffer::setLayoutPos(string const & path)
 }
 
 
-bool Buffer::isReadonly() const
+bool Buffer::hasReadonlyFlag() const
 {
        return d->read_only;
 }
 
 
+bool Buffer::isReadonly() const
+{
+       return hasReadonlyFlag() || notifiesExternalModification();
+}
+
+
 void Buffer::setParent(Buffer const * buffer)
 {
        // Avoids recursive include.
@@ -3926,6 +3941,7 @@ unique_ptr<TexRow> Buffer::getSourceCode(odocstream & os, string const & format,
                        ots.texrow().newlines(2);
                        if (master)
                                runparams.is_child = true;
+                       updateBuffer();
                        writeLaTeXSource(ots, string(), runparams, output);
                        texrow = ots.releaseTexRow();
                }
@@ -4132,7 +4148,7 @@ void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
 bool Buffer::autoSave() const
 {
        Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
-       if (buf->d->bak_clean || isReadonly())
+       if (buf->d->bak_clean || hasReadonlyFlag())
                return true;
 
        message(_("Autosaving current document..."));
@@ -4230,6 +4246,8 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir
        if (pos != string::npos) {
                dest_filename = target.substr(pos + 1, target.length() - pos - 1);
                format = target.substr(0, pos);
+               if (format == "default")
+                       format = params().getDefaultOutputFormat();
                runparams.export_folder = FileName(dest_filename).onlyPath().realPath();
                FileName(dest_filename).onlyPath().createPath();
                LYXERR(Debug::FILES, "format=" << format << ", dest_filename=" << dest_filename << ", export_folder=" << runparams.export_folder);
@@ -4260,7 +4278,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."),
-                                       formats.prettyName(format)));
+                                       theFormats().prettyName(format)));
                        }
                        return ExportNoPathToFormat;
                }
@@ -4290,7 +4308,7 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir
        string filename = latexName(false);
        filename = addName(temppath(), filename);
        filename = changeExtension(filename,
-                                  formats.extension(backend_format));
+                                  theFormats().extension(backend_format));
        LYXERR(Debug::FILES, "filename=" << filename);
 
        // Plain text backend
@@ -4336,7 +4354,7 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir
        string const error_type = (format == "program")
                ? "Build" : params().bufferFormat();
        ErrorList & error_list = d->errorLists[error_type];
-       string const ext = formats.extension(format);
+       string const ext = theFormats().extension(format);
        FileName const tmp_result_file(changeExtension(filename, ext));
        bool const success = converters.convert(this, FileName(filename),
                tmp_result_file, FileName(absFileName()), backend_format, format,
@@ -4404,7 +4422,7 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir
        vector<ExportedFile>::const_iterator it = files.begin();
        vector<ExportedFile>::const_iterator const en = files.end();
        for (; it != en && status != CANCEL; ++it) {
-               string const fmt = formats.getFormatFromFile(it->sourceName);
+               string const fmt = theFormats().getFormatFromFile(it->sourceName);
                string fixedName = it->exportName;
                if (!runparams.export_folder.empty()) {
                        // Relative pathnames starting with ../ will be sanitized
@@ -4440,13 +4458,13 @@ Buffer::ExportStatus Buffer::doExport(string const & target, bool put_in_tempdir
                } else {
                        message(bformat(_("Document exported as %1$s "
                                "to file `%2$s'"),
-                               formats.prettyName(format),
+                               theFormats().prettyName(format),
                                makeDisplayPath(result_file)));
                }
        } else {
                // This must be a dummy converter like fax (bug 1888)
                message(bformat(_("Document exported as %1$s"),
-                       formats.prettyName(format)));
+                       theFormats().prettyName(format)));
        }
 
        return success ? ExportSuccess : ExportConverterError;
@@ -4485,7 +4503,7 @@ Buffer::ExportStatus Buffer::preview(string const & format, bool includeall) con
                return status;
 
        if (previewFile.exists())
-               return formats.view(*this, previewFile, format) ?
+               return theFormats().view(*this, previewFile, format) ?
                        PreviewSuccess : PreviewError;
 
        // Successful export but no output file?
@@ -4527,7 +4545,7 @@ Buffer::ReadStatus Buffer::loadEmergency()
                ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
                bool const success = (ret_llf == ReadSuccess);
                if (success) {
-                       if (isReadonly()) {
+                       if (hasReadonlyFlag()) {
                                Alert::warning(_("File is read-only"),
                                        bformat(_("An emergency file is successfully loaded, "
                                        "but the original file %1$s is marked read-only. "
@@ -4590,7 +4608,7 @@ Buffer::ReadStatus Buffer::loadAutosave()
                ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
                // the file is not saved if we load the autosave file.
                if (ret_llf == ReadSuccess) {
-                       if (isReadonly()) {
+                       if (hasReadonlyFlag()) {
                                Alert::warning(_("File is read-only"),
                                        bformat(_("A backup file is successfully loaded, "
                                        "but the original file %1$s is marked read-only. "
@@ -4644,7 +4662,7 @@ Buffer::ReadStatus Buffer::loadThisLyXFile(FileName const & fn)
 void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
 {
        for (auto const & err : terr) {
-               TexRow::TextEntry start, end = TexRow::text_none;
+               TexRow::TextEntry start = TexRow::text_none, end = TexRow::text_none;
                int errorRow = err.error_in_line;
                Buffer const * buf = 0;
                Impl const * p = d;
@@ -4737,16 +4755,17 @@ void Buffer::updateBuffer(UpdateScope scope, UpdateType utype) const
        ParIterator parit = cbuf.par_iterator_begin();
        updateBuffer(parit, utype);
 
-       /// FIXME: Perf
-       /// Update the tocBackend for any buffer. The outliner uses the master's,
-       /// and the navigation menu uses the child's.
-       cbuf.tocBackend().update(true, utype);
-
        if (master != this)
+               // If this document has siblings, then update the TocBackend later. The
+               // reason is to ensure that later siblings are up to date when e.g. the
+               // broken or not status of references is computed. The update is called
+               // in InsetInclude::addToToc.
                return;
 
        d->bibinfo_cache_valid_ = true;
        d->cite_labels_valid_ = true;
+       /// FIXME: Perf
+       cbuf.tocBackend().update(true, utype);
        if (scope == UpdateMaster)
                cbuf.structureChanged();
 }
@@ -5295,5 +5314,60 @@ void Buffer::updateChangesPresent() const
 }
 
 
+void Buffer::Impl::refreshFileMonitor()
+{
+       if (file_monitor_ && file_monitor_->filename() == filename.absFileName()) {
+               file_monitor_->refresh();
+               return;
+       }
+
+       // The previous file monitor is invalid
+       // This also destroys the previous file monitor and all its connections
+       file_monitor_ = FileSystemWatcher::monitor(filename);
+       // file_monitor_ will be destroyed with *this, so it is not going to call a
+       // destroyed object method.
+       file_monitor_->connect([this](bool exists) {
+                       fileExternallyModified(exists);
+               });
+}
+
+
+void Buffer::Impl::fileExternallyModified(bool const exists)
+{
+       // ignore notifications after our own saving operations
+       if (checksum_ == filename.checksum()) {
+               LYXERR(Debug::FILES, "External modification but "
+                      "checksum unchanged: " << filename);
+               return;
+       }
+       lyx_clean = bak_clean = false;
+       // If the file has been deleted, only mark the file as dirty since it is
+       // pointless to prompt for reloading. If later a file is moved into this
+       // location, then the externally modified warning will appear then.
+       if (exists)
+                       externally_modified_ = true;
+       // Update external modification notification.
+       // Dirty buffers must be visible at all times.
+       if (wa_ && wa_->unhide(owner_))
+               wa_->updateTitles();
+       else
+               // Unable to unhide the buffer (e.g. no GUI or not current View)
+               lyx_clean = true;
+}
+
+
+bool Buffer::notifiesExternalModification() const
+{
+       return d->externally_modified_;
+}
+
+
+void Buffer::clearExternalModification() const
+{
+       d->externally_modified_ = false;
+       if (d->wa_)
+               d->wa_->updateTitles();
+}
+
 
 } // namespace lyx