]> git.lyx.org Git - lyx.git/blobdiff - src/Buffer.cpp
Cmake build: Don't use temporary doc-files as source for installation
[lyx.git] / src / Buffer.cpp
index ac01cf41401aa79d755fb3841573c5f752969729..c4ce8ea053d45633e4ace7f8f3c4463e26047b14 100644 (file)
@@ -55,6 +55,7 @@
 #include "ParagraphParameters.h"
 #include "ParIterator.h"
 #include "PDFOptions.h"
+#include "Session.h"
 #include "SpellChecker.h"
 #include "sgml.h"
 #include "texstream.h"
@@ -76,7 +77,7 @@
 
 #include "mathed/InsetMathHull.h"
 #include "mathed/MacroTable.h"
-#include "mathed/MathMacroTemplate.h"
+#include "mathed/InsetMathMacroTemplate.h"
 #include "mathed/MathSupport.h"
 
 #include "graphics/GraphicsCache.h"
@@ -136,7 +137,7 @@ int const LYX_FORMAT = LYX_FORMAT_LYX;
 typedef map<string, bool> DepClean;
 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
 
-} // namespace anon
+} // namespace
 
 
 // A storehouse for the cloned buffers.
@@ -264,9 +265,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_;
 
        ///
@@ -380,14 +380,11 @@ public:
        // Make sure the file monitor monitors the good file.
        void refreshFileMonitor();
 
-       /// has it been notified of an external modification?
-       bool isExternallyModified() const { return externally_modified_; }
-
        /// Notify or clear of external modification
-       void fileExternallyModified(bool modified) const;
+       void fileExternallyModified(bool exists);
 
-       /// Block notifications of external modifications
-       FileMonitorBlocker blockFileMonitor() { return file_monitor_->block(10); }
+       /// has been externally modified? Can be reset by the user.
+       mutable bool externally_modified_;
 
 private:
        /// So we can force access via the accessors.
@@ -397,9 +394,6 @@ private:
        int char_count_;
        int blank_count_;
 
-       /// has been externally modified? Can be reset by the user.
-       mutable bool externally_modified_;
-
        FileMonitorPtr file_monitor_;
 };
 
@@ -436,14 +430,13 @@ 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),
-         tracked_changes_present_(0), parent_buffer(0),
-         word_count_(0), char_count_(0), blank_count_(0),
-         externally_modified_(false)
+         tracked_changes_present_(0), externally_modified_(false), parent_buffer(0),
+         word_count_(0), char_count_(0), blank_count_(0)
 {
        refreshFileMonitor();
        if (!cloned_buffer_) {
@@ -544,17 +537,21 @@ Buffer::~Buffer()
                Impl::BufferPositionMap::iterator end = d->children_positions.end();
                for (; it != end; ++it) {
                        Buffer * child = const_cast<Buffer *>(it->first);
-                       if (theBufferList().isLoaded(child)) { 
-                        if (theBufferList().isOthersChild(this, child))
-                                child->setParent(0);
-                        else
-                               theBufferList().release(child);
+                       if (theBufferList().isLoaded(child)) {
+                               if (theBufferList().isOthersChild(this, child))
+                                       child->setParent(0);
+                               else
+                                       theBufferList().release(child);
                        }
                }
 
                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);
                }
 
@@ -726,7 +723,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;
 }
 
 
@@ -835,7 +832,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;
@@ -984,6 +981,8 @@ int Buffer::readHeader(Lexer & lex)
                errorList.push_back(ErrorItem(_("Document header error"), s));
        }
 
+       params().shell_escape = theSession().shellescapeFiles().find(absFileName());
+
        params().makeDocumentClass();
 
        return unknown_tokens;
@@ -1086,7 +1085,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
@@ -1200,7 +1199,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;
 }
@@ -1314,7 +1313,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();
 
@@ -1380,7 +1379,6 @@ FileName Buffer::getBackupName() const {
 // Should probably be moved to somewhere else: BufferView? GuiView?
 bool Buffer::save() const
 {
-       FileMonitorBlocker block = d->blockFileMonitor();
        docstring const file = makeDisplayPath(absFileName(), 20);
        d->filename.refresh();
 
@@ -1607,7 +1605,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;
@@ -1742,6 +1740,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 (...) {
@@ -1938,7 +1937,7 @@ void Buffer::writeLaTeXSource(otexstream & os,
                                            support::bformat(_("The languages %1$s are only supported by Polyglossia."), langs)
                                          : support::bformat(_("The language %1$s is only supported by Polyglossia."), langs);
                                if (!blangs.empty())
-                                       plangs += "\n"; 
+                                       plangs += "\n";
                        }
 
                        frontend::Alert::warning(
@@ -2536,7 +2535,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.
@@ -2660,7 +2659,7 @@ void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
                                dr.setMessage(log);
                }
                else
-                       setReadonly(!isReadonly());
+                       setReadonly(!hasReadonlyFlag());
                break;
 
        case LFUN_BUFFER_EXPORT: {
@@ -2689,7 +2688,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!"
@@ -2848,7 +2847,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;
@@ -3026,16 +3025,9 @@ bool Buffer::isChecksumModified() const
 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.
 }
 
 
@@ -3270,12 +3262,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.
@@ -3603,7 +3601,7 @@ void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
                                continue;
 
                        // get macro data
-                       MathMacroTemplate & macroTemplate =
+                       InsetMathMacroTemplate & macroTemplate =
                                *iit->inset->asInsetMath()->asMacroTemplate();
                        MacroContext mc(owner_, it);
                        macroTemplate.updateToContext(mc);
@@ -3722,8 +3720,12 @@ void Buffer::listMacroNames(MacroNameSet & macros) const
        // loop over children
        Impl::BufferPositionMap::iterator it = d->children_positions.begin();
        Impl::BufferPositionMap::iterator end = d->children_positions.end();
-       for (; it != end; ++it)
-               it->first->listMacroNames(macros);
+       for (; it != end; ++it) {
+               Buffer * child = const_cast<Buffer *>(it->first);
+               // The buffer might have been closed (see #10766).
+               if (theBufferList().isLoaded(child))
+                       child->listMacroNames(macros);
+       }
 
        // call parent
        Buffer const * const pbuf = d->parent();
@@ -3753,7 +3755,7 @@ void Buffer::listParentMacros(MacroSet & macros, LaTeXFeatures & features) const
                if (data) {
                        macros.insert(data);
 
-                       // we cannot access the original MathMacroTemplate anymore
+                       // we cannot access the original InsetMathMacroTemplate anymore
                        // here to calls validate method. So we do its work here manually.
                        // FIXME: somehow make the template accessible here.
                        if (data->optionals() > 0)
@@ -3946,6 +3948,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();
                }
@@ -4104,7 +4107,7 @@ int AutoSaveBuffer::generateChild()
        return pid;
 }
 
-} // namespace anon
+} // namespace
 
 
 FileName Buffer::getEmergencyFileName() const
@@ -4152,7 +4155,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..."));
@@ -4282,7 +4285,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;
                }
@@ -4312,7 +4315,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
@@ -4358,7 +4361,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,
@@ -4426,7 +4429,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
@@ -4462,13 +4465,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;
@@ -4507,7 +4510,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?
@@ -4549,7 +4552,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. "
@@ -4612,7 +4615,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. "
@@ -4759,16 +4762,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();
 }
@@ -4912,8 +4916,10 @@ void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
                switch (par.itemdepth) {
                case 2:
                        enumcounter += 'i';
+                       // fall through
                case 1:
                        enumcounter += 'i';
+                       // fall through
                case 0:
                        enumcounter += 'i';
                        break;
@@ -5026,7 +5032,7 @@ void Buffer::updateBuffer(ParIterator & parit, UpdateType utype) const
                // set the counter for this paragraph
                d->setLabel(parit, utype);
 
-               // update change-tracking flag 
+               // update change-tracking flag
                parit->addChangesToBuffer(*this);
 
                // now the insets
@@ -5319,38 +5325,57 @@ void Buffer::updateChangesPresent() const
 
 void Buffer::Impl::refreshFileMonitor()
 {
-       if (file_monitor_ && file_monitor_->filename() == filename.absFileName())
-               return file_monitor_->refresh();
+       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);
-       fileExternallyModified(false);
        // file_monitor_ will be destroyed with *this, so it is not going to call a
        // destroyed object method.
-       file_monitor_->connect([this](){ fileExternallyModified(true); });
+       file_monitor_->connect([this](bool exists) {
+                       fileExternallyModified(exists);
+               });
 }
 
 
-void Buffer::Impl::fileExternallyModified(bool modified) const
+void Buffer::Impl::fileExternallyModified(bool const exists)
 {
-       if (modified)
-               lyx_clean = bak_clean = false;
-       externally_modified_ = modified;
-       if (wa_)
+       // 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->isExternallyModified();
+       return d->externally_modified_;
 }
 
 
 void Buffer::clearExternalModification() const
 {
-       d->fileExternallyModified(false);
+       d->externally_modified_ = false;
+       if (d->wa_)
+               d->wa_->updateTitles();
 }