]> git.lyx.org Git - lyx.git/blobdiff - src/Buffer.cpp
Slight re-organization.
[lyx.git] / src / Buffer.cpp
index 1c53b8a53b87168dea5360674a0dcc3cfd3e3824..5ee983f301fa15870cbb88b044ff1766010cbbb3 100644 (file)
@@ -66,7 +66,6 @@
 #include "WordLangTuple.h"
 #include "WordList.h"
 
-#include "insets/InsetBibitem.h"
 #include "insets/InsetBibtex.h"
 #include "insets/InsetBranch.h"
 #include "insets/InsetInclude.h"
@@ -128,7 +127,7 @@ namespace {
 
 // Do not remove the comment below, so we get merge conflict in
 // independent branches. Instead add your own.
-int const LYX_FORMAT = 404; // rgh: refstyle
+int const LYX_FORMAT = 410; // rgh: dummy format for list->labeling
 
 typedef map<string, bool> DepClean;
 typedef map<docstring, pair<InsetLabel const *, Buffer::References> > RefCache;
@@ -189,7 +188,7 @@ public:
        /// is autosave needed?
        mutable bool bak_clean;
 
-       /// is this a unnamed file (New...)?
+       /// is this an unnamed file (New...)?
        bool unnamed;
 
        /// buffer is r/o
@@ -414,9 +413,8 @@ Buffer::~Buffer()
                        from_utf8(d->temppath.absFileName())));
        }
 
-       // Remove any previewed LaTeX snippets associated with this buffer.
        if (!isClone())
-               thePreviews().removeLoader(*this);
+               removePreviews();
 
        delete d;
 }
@@ -643,10 +641,11 @@ void Buffer::setReadonly(bool const flag)
 }
 
 
-void Buffer::setFileName(string const & newfile)
+void Buffer::setFileName(FileName const & fname)
 {
-       d->filename = makeAbsPath(newfile);
+       d->filename = fname;
        setReadonly(d->filename.isReadOnly());
+       saveCheckSum();
        updateTitles();
 }
 
@@ -673,7 +672,7 @@ int Buffer::readHeader(Lexer & lex)
        params().headsep.erase();
        params().footskip.erase();
        params().columnsep.erase();
-       params().fontsCJK.erase();
+       params().fonts_cjk.erase();
        params().listings_params.clear();
        params().clearLayoutModules();
        params().clearRemovedModules();
@@ -876,6 +875,10 @@ Buffer::ReadStatus Buffer::readFile(FileName const & fn)
                return readFile(tmpFile);
        }
 
+       // FIXME: InsetInfo needs to know whether the file is under VCS 
+       // during the parse process, so this has to be done before.
+       lyxvc().file_found_hook(d->filename);
+
        if (readDocument(lex)) {
                Alert::error(_("Document format failure"),
                        bformat(_("%1$s ended unexpectedly, which means"
@@ -885,10 +888,8 @@ Buffer::ReadStatus Buffer::readFile(FileName const & fn)
        }
 
        d->file_fully_loaded = true;
-       // InsetInfo needs to know if file is under VCS
-       lyxvc().file_found_hook(fn);
-       d->read_only = !fname.isWritable();
-       params().compressed = fname.isZippedFile();
+       d->read_only = !d->filename.isWritable();
+       params().compressed = d->filename.isZippedFile();
        saveCheckSum();
        return ReadSuccess;
 }
@@ -906,6 +907,19 @@ void Buffer::setFullyLoaded(bool value)
 }
 
 
+void Buffer::updatePreviews() const
+{
+       if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
+               thePreviews().generateBufferPreviews(*this);
+}
+
+
+void Buffer::removePreviews() const
+{
+       thePreviews().removeLoader(*this);
+}
+
+
 Buffer::ReadStatus Buffer::parseLyXFormat(Lexer & lex,
        FileName const & fn, int & file_format) const
 {
@@ -973,14 +987,14 @@ Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
                if (from_format < LYX_FORMAT) {
                        Alert::error(_("Conversion script failed"),
                                bformat(_("%1$s is from an older version"
-                                       " of LyX, but the lyx2lyx script"
+                                       " of LyX and the lyx2lyx script"
                                        " failed to convert it."),
                                        from_utf8(fn.absFileName())));
                        return LyX2LyXOlderFormat;
                } else {
                        Alert::error(_("Conversion script failed"),
-                               bformat(_("%1$s is from an newer version"
-                                       " of LyX, but the lyx2lyx script"
+                               bformat(_("%1$s is from a newer version"
+                                       " of LyX and the lyx2lyx script"
                                        " failed to convert it."),
                                        from_utf8(fn.absFileName())));
                        return LyX2LyXNewerFormat;
@@ -993,11 +1007,25 @@ Buffer::ReadStatus Buffer::convertLyXFormat(FileName const & fn,
 // Should probably be moved to somewhere else: BufferView? GuiView?
 bool Buffer::save() const
 {
+       docstring const file = makeDisplayPath(absFileName(), 20);
+       d->filename.refresh();
+
+       // check the read-only status before moving the file as a backup
+       if (d->filename.exists()) {
+               bool const read_only = !d->filename.isWritable();
+               if (read_only) {
+                       Alert::warning(_("File is read-only"),
+                               bformat(_("The file %1$s cannot be written because it "
+                               "is marked as read-only."), file));
+                       return false;
+               }
+       }
+
        // ask if the disk file has been externally modified (use checksum method)
        if (fileName().exists() && isExternallyModified(checksum_method)) {
-               docstring const file = makeDisplayPath(absFileName(), 20);
-               docstring text = bformat(_("Document %1$s has been externally modified. Are you sure "
-                                                            "you want to overwrite this file?"), file);
+               docstring text = 
+                       bformat(_("Document %1$s has been externally modified. "
+                               "Are you sure you want to overwrite this file?"), file);
                int const ret = Alert::prompt(_("Overwrite modified file?"),
                        text, 1, 1, _("&Overwrite"), _("&Cancel"));
                if (ret == 1)
@@ -1098,10 +1126,10 @@ docstring Buffer::emergencyWrite()
                LYXERR0("  " << s);
                if (writeFile(FileName(s))) {
                        markClean();
-                       user_message += bformat(_("  Saved to %1$s. Phew.\n"), from_utf8(s));
+                       user_message += "  " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
                        return user_message;
                } else {
-                       user_message += _("  Save failed! Trying again...\n");
+                       user_message += "  " + _("Save failed! Trying again...\n");
                }
        }
 
@@ -1111,11 +1139,11 @@ docstring Buffer::emergencyWrite()
        lyxerr << ' ' << s << endl;
        if (writeFile(FileName(s))) {
                markClean();
-               user_message += bformat(_("  Saved to %1$s. Phew.\n"), from_utf8(s));
+               user_message += "  " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
                return user_message;
        }
 
-       user_message += _("  Save failed! Trying yet again...\n");
+       user_message += "  " + _("Save failed! Trying yet again...\n");
 
        // 3) In "/tmp" directory.
        // MakeAbsPath to prepend the current
@@ -1125,11 +1153,11 @@ docstring Buffer::emergencyWrite()
        lyxerr << ' ' << s << endl;
        if (writeFile(FileName(s))) {
                markClean();
-               user_message += bformat(_("  Saved to %1$s. Phew.\n"), from_utf8(s));
+               user_message += "  " + bformat(_("Saved to %1$s. Phew.\n"), from_utf8(s));
                return user_message;
        }
 
-       user_message += _("  Save failed! Bummer. Document is lost.");
+       user_message += "  " + _("Save failed! Bummer. Document is lost.");
        // Don't try again.
        markClean();
        return user_message;
@@ -1203,8 +1231,11 @@ bool Buffer::makeLaTeXFile(FileName const & fname,
                           bool output_preamble, bool output_body) const
 {
        OutputParams runparams = runparams_in;
-       if (params().useXetex)
-               runparams.flavor = OutputParams::XETEX;
+
+       // This is necessary for LuaTeX/XeTeX with tex fonts.
+       // See FIXME in BufferParams::encoding()
+       if (runparams.isFullUnicode())
+               runparams.encoding = encodings.fromLyXName("utf8-plain");
 
        string const encoding = runparams.encoding->iconvName();
        LYXERR(Debug::LATEX, "makeLaTeXFile encoding: " << encoding << "...");
@@ -1371,6 +1402,7 @@ void Buffer::writeLaTeXSource(odocstream & os,
                MacroSet parentMacros;
                listParentMacros(parentMacros, features);
 
+               runparams.use_polyglossia = features.usePolyglossia();
                // Write the preamble
                runparams.use_babel = params().writeLaTeX(os, features,
                                                          d->texrow,
@@ -1599,7 +1631,7 @@ void Buffer::writeLyXHTMLSource(odocstream & os,
 
                os << "\n<!-- Text Class Preamble -->\n"
                   << features.getTClassHTMLPreamble()
-                  << "\n<!-- Premable Snippets -->\n"
+                  << "\n<!-- Preamble Snippets -->\n"
                   << from_utf8(features.getPreambleSnippets());
 
                os << "\n<!-- Layout-provided Styles -->\n";
@@ -2011,6 +2043,7 @@ void Buffer::dispatch(FuncRequest const & func, DispatchResult & dr)
 
        case LFUN_BUFFER_AUTO_SAVE:
                autoSave();
+               resetAutosaveTimers();
                break;
 
        case LFUN_BRANCH_ADD: {
@@ -2980,22 +3013,23 @@ void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
 {
        //FIXME: This does not work for child documents yet.
        LASSERT(code == CITE_CODE, /**/);
+
        // Check if the label 'from' appears more than once
-       vector<docstring> labels;
-       string paramName;
        checkBibInfoCache();
+
        BiblioInfo const & keys = masterBibInfo();
        BiblioInfo::const_iterator bit  = keys.begin();
        BiblioInfo::const_iterator bend = keys.end();
+       vector<docstring> labels;
 
        for (; bit != bend; ++bit)
                // FIXME UNICODE
                labels.push_back(bit->first);
-       paramName = "key";
 
        if (count(labels.begin(), labels.end(), from) > 1)
                return;
 
+       string const paramName = "key";
        for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
                if (it->lyxCode() == code) {
                        InsetCommand * inset = it->asInsetCommand();
@@ -3014,7 +3048,7 @@ void Buffer::getSourceCode(odocstream & os, pit_type par_begin,
 {
        OutputParams runparams(&params().encoding());
        runparams.nice = true;
-       runparams.flavor = params().useXetex ? 
+       runparams.flavor = params().useNonTeXFonts ? 
                OutputParams::XETEX : OutputParams::LATEX;
        runparams.linelen = lyxrc.plaintext_linelen;
        // No side effect of file copying and image conversion
@@ -3216,13 +3250,7 @@ int AutoSaveBuffer::generateChild()
 
 FileName Buffer::getEmergencyFileName() const
 {
-       return getEmergencyFileNameFor(d->filename);
-}
-
-
-FileName Buffer::getEmergencyFileNameFor(FileName const & fn) const
-{
-       return FileName(fn.absFileName() + ".emergency");
+       return FileName(d->filename.absFileName() + ".emergency");
 }
 
 
@@ -3238,15 +3266,9 @@ FileName Buffer::getAutosaveFileName() const
        if (!isUnnamed() || fpath.empty() || !FileName(fpath).exists())
                fpath = filePath();
 
-       string const fname = d->filename.onlyFileName();
-       return getAutosaveFileNameFor(makeAbsPath(fname, fpath));
-}
-
+       string const fname = "#" + d->filename.onlyFileName() + "#";
 
-FileName Buffer::getAutosaveFileNameFor(FileName const & fn) const
-{
-       string const fname = "#" + onlyFileName(fn.absFileName()) + "#";
-       return FileName(onlyPath(fn.absFileName()) + fname);
+       return makeAbsPath(fname, fpath);
 }
 
 
@@ -3268,23 +3290,36 @@ void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
 }
 
 
-// Perfect target for a thread...
-void Buffer::autoSave() const
+bool Buffer::autoSave() const 
 {
-       if (d->bak_clean || isReadonly()) {
-               // We don't save now, but we'll try again later
-               resetAutosaveTimers();
-               return;
-       }
+       Buffer const * buf = d->cloned_buffer_ ? d->cloned_buffer_ : this;
+       if (buf->d->bak_clean || isReadonly())
+               return true;
 
-       // emit message signal.
        message(_("Autosaving current document..."));
-       AutoSaveBuffer autosave(*this, getAutosaveFileName());
-       autosave.start();
-
-       d->bak_clean = true;
-
-       resetAutosaveTimers();
+       buf->d->bak_clean = true;
+       
+       FileName const fname = getAutosaveFileName();
+       if (d->cloned_buffer_) {
+               // If this buffer is cloned, we assume that
+               // we are running in a separate thread already.
+               FileName const tmp_ret = FileName::tempName("lyxauto");
+               if (!tmp_ret.empty()) {
+                       writeFile(tmp_ret);
+                       // assume successful write of tmp_ret
+                       if (tmp_ret.moveTo(fname))
+                               return true;
+               }
+               // failed to write/rename tmp_ret so try writing direct
+               return writeFile(fname);
+       } else {        
+               /// This function is deprecated as the frontend needs to take care
+               /// of cloning the buffer and autosaving it in another thread. It
+               /// is still here to allow (QT_VERSION < 0x040400).
+               AutoSaveBuffer autosave(*this, fname);
+               autosave.start();
+               return true;
+       }
 }
 
 
@@ -3292,7 +3327,7 @@ string Buffer::bufferFormat() const
 {
        string format = params().documentClass().outputFormat();
        if (format == "latex") {
-               if (params().useXetex)
+               if (params().useNonTeXFonts)
                        return "xetex";
                if (params().encoding().package() == Encoding::japanese)
                        return "platex";
@@ -3303,14 +3338,14 @@ string Buffer::bufferFormat() const
 
 string Buffer::getDefaultOutputFormat() const
 {
-       if (!params().defaultOutputFormat.empty()
-           && params().defaultOutputFormat != "default")
-               return params().defaultOutputFormat;
+       if (!params().default_output_format.empty()
+           && params().default_output_format != "default")
+               return params().default_output_format;
        typedef vector<Format const *> Formats;
        Formats formats = exportableFormats(true);
        if (isDocBook()
            || isLiterate()
-           || params().useXetex
+           || params().useNonTeXFonts
            || params().encoding().package() == Encoding::japanese) {
                if (formats.empty())
                        return string();
@@ -3390,6 +3425,10 @@ bool Buffer::doExport(string const & format, bool put_in_tempdir,
                // FIXME: Don't hardcode format names here, but use a flag
                if (backend_format == "pdflatex")
                        runparams.flavor = OutputParams::PDFLATEX;
+               else if (backend_format == "luatex")
+                       runparams.flavor = OutputParams::LUATEX;
+               else if (backend_format == "xetex")
+                       runparams.flavor = OutputParams::XETEX;
        }
 
        string filename = latexName(false);
@@ -3420,11 +3459,10 @@ bool Buffer::doExport(string const & format, bool put_in_tempdir,
                        break;
                case BufferParams::LaTeX:
                        runparams.math_flavor = OutputParams::MathAsLaTeX; 
-                       break;                                                                                  
+                       break;
                }
-               
                makeLyXHTMLFile(FileName(filename), runparams);
-       }       else if (backend_format == "lyx")
+       } else if (backend_format == "lyx")
                writeFile(FileName(filename));
        // Docbook backend
        else if (isDocBook()) {
@@ -3596,8 +3634,12 @@ vector<string> Buffer::backends() const
        vector<string> v;
        v.push_back(bufferFormat());
        // FIXME: Don't hardcode format names here, but use a flag
-       if (v.back() == "latex")
+       if (v.back() == "latex") {
                v.push_back("pdflatex");
+               v.push_back("luatex");
+               v.push_back("xetex");
+       } else if (v.back() == "xetex")
+               v.push_back("luatex");
        v.push_back("xhtml");
        v.push_back("text");
        v.push_back("lyx");
@@ -3605,25 +3647,25 @@ vector<string> Buffer::backends() const
 }
 
 
-Buffer::ReadStatus Buffer::extractFromVC(FileName const & fn)
+Buffer::ReadStatus Buffer::extractFromVC()
 {
-       bool const found = LyXVC::file_not_found_hook(fn);
+       bool const found = LyXVC::file_not_found_hook(d->filename);
        if (!found)
                return ReadFileNotFound;
-       if (!fn.isReadableFile())
+       if (!d->filename.isReadableFile())
                return ReadVCError;
        return ReadSuccess;
 }
 
 
-Buffer::ReadStatus Buffer::loadEmergency(FileName const & fn)
+Buffer::ReadStatus Buffer::loadEmergency()
 {
-       FileName const emergencyFile = getEmergencyFileNameFor(fn);
+       FileName const emergencyFile = getEmergencyFileName();
        if (!emergencyFile.exists() 
-                 || emergencyFile.lastModified() <= fn.lastModified())
+                 || emergencyFile.lastModified() <= d->filename.lastModified())
                return ReadFileNotFound;
 
-       docstring const file = makeDisplayPath(fn.absFileName(), 20);
+       docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
        docstring const text = bformat(_("An emergency save of the document "
                "%1$s exists.\n\nRecover emergency save?"), file);
        
@@ -3637,12 +3679,19 @@ Buffer::ReadStatus Buffer::loadEmergency(FileName const & fn)
                ReadStatus const ret_llf = loadThisLyXFile(emergencyFile);
                bool const success = (ret_llf == ReadSuccess);
                if (success) {
+                       if (isReadonly()) {
+                               Alert::warning(_("File is read-only"),
+                                       bformat(_("An emergency file is succesfully loaded, "
+                                       "but the original file %1$s is marked read-only. "
+                                       "Please make sure to save the document as a different "
+                                       "file."), from_utf8(d->filename.absFileName())));
+                       }
                        markDirty();
                        str = _("Document was successfully recovered.");
                } else
                        str = _("Document was NOT successfully recovered.");
                str += "\n\n" + bformat(_("Remove emergency file now?\n(%1$s)"),
-                                       makeDisplayPath(emergencyFile.absFileName()));
+                       makeDisplayPath(emergencyFile.absFileName()));
 
                int const del_emerg = 
                        Alert::prompt(_("Delete emergency file?"), str, 1, 1,
@@ -3672,15 +3721,15 @@ Buffer::ReadStatus Buffer::loadEmergency(FileName const & fn)
 }
 
 
-Buffer::ReadStatus Buffer::loadAutosave(FileName const & fn)
+Buffer::ReadStatus Buffer::loadAutosave()
 {
        // Now check if autosave file is newer.
-       FileName const autosaveFile = getAutosaveFileNameFor(fn);
+       FileName const autosaveFile = getAutosaveFileName();
        if (!autosaveFile.exists() 
-                 || autosaveFile.lastModified() <= fn.lastModified()) 
+                 || autosaveFile.lastModified() <= d->filename.lastModified()) 
                return ReadFileNotFound;
 
-       docstring const file = makeDisplayPath(fn.absFileName(), 20);
+       docstring const file = makeDisplayPath(d->filename.absFileName(), 20);
        docstring const text = bformat(_("The backup of the document %1$s " 
                "is newer.\n\nLoad the backup instead?"), file);
        int const ret = Alert::prompt(_("Load backup?"), text, 0, 2,
@@ -3692,6 +3741,14 @@ Buffer::ReadStatus Buffer::loadAutosave(FileName const & fn)
                ReadStatus const ret_llf = loadThisLyXFile(autosaveFile);
                // the file is not saved if we load the autosave file.
                if (ret_llf == ReadSuccess) {
+                       if (isReadonly()) {
+                               Alert::warning(_("File is read-only"),
+                                       bformat(_("A backup file is succesfully loaded,  "
+                                       "but the original file %1$s is marked read-only. "
+                                       "Please make sure to save the document as a "
+                                       "different file."), 
+                                       from_utf8(d->filename.absFileName())));
+                       }
                        markDirty();
                        return ReadSuccess;
                }
@@ -3708,23 +3765,23 @@ Buffer::ReadStatus Buffer::loadAutosave(FileName const & fn)
 }
 
 
-Buffer::ReadStatus Buffer::loadLyXFile(FileName const & fn)
+Buffer::ReadStatus Buffer::loadLyXFile()
 {
-       if (!fn.isReadableFile()) {
-               ReadStatus const ret_rvc = extractFromVC(fn);
+       if (!d->filename.isReadableFile()) {
+               ReadStatus const ret_rvc = extractFromVC();
                if (ret_rvc != ReadSuccess)
                        return ret_rvc;
        }
 
-       ReadStatus const ret_re = loadEmergency(fn);
+       ReadStatus const ret_re = loadEmergency();
        if (ret_re == ReadSuccess || ret_re == ReadCancel)
                return ret_re;
        
-       ReadStatus const ret_ra = loadAutosave(fn);
+       ReadStatus const ret_ra = loadAutosave();
        if (ret_ra == ReadSuccess || ret_ra == ReadCancel)
                return ret_ra;
 
-       return loadThisLyXFile(fn);
+       return loadThisLyXFile(d->filename);
 }
 
 
@@ -3922,11 +3979,11 @@ void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
        switch(layout.labeltype) {
        case LABEL_COUNTER:
                if (layout.toclevel <= bp.secnumdepth
-                   && (layout.latextype != LATEX_ENVIRONMENT
-                       || it.text()->isFirstInSequence(it.pit()))) {
-                       counters.step(layout.counter, utype);
-                       par.params().labelString(
-                               par.expandLabel(layout, bp));
+                     && (layout.latextype != LATEX_ENVIRONMENT
+                         || it.text()->isFirstInSequence(it.pit()))) {
+                       if (counters.hasCounter(layout.counter))
+                               counters.step(layout.counter, utype);
+                       par.params().labelString(par.expandLabel(layout, bp));
                } else
                        par.params().labelString(docstring());
                break;
@@ -4099,32 +4156,62 @@ int Buffer::spellCheck(DocIterator & from, DocIterator & to,
 Buffer::ReadStatus Buffer::reload()
 {
        setBusy(true);
-       // c.f. bug 6587
+       // c.f. bug http://www.lyx.org/trac/ticket/6587
        removeAutosaveFile();
        // e.g., read-only status could have changed due to version control
        d->filename.refresh();
        docstring const disp_fn = makeDisplayPath(d->filename.absFileName());
 
-       ReadStatus const status = loadLyXFile(d->filename);
+       ReadStatus const status = loadLyXFile();
        if (status == ReadSuccess) {
                updateBuffer();
                changed(true);
                updateTitles();
                markClean();
-               saveCheckSum();
                message(bformat(_("Document %1$s reloaded."), disp_fn));
        } else {
                message(bformat(_("Could not reload document %1$s."), disp_fn));
        }       
        setBusy(false);
-       thePreviews().removeLoader(*this);
-       if (graphics::Previews::status() != LyXRC::PREVIEW_OFF)
-               thePreviews().generateBufferPreviews(*this);
+       removePreviews();
+       updatePreviews();
        errors("Parse");
        return status;
 }
 
 
+bool Buffer::saveAs(FileName const & fn)
+{
+       FileName const old_name = fileName();
+       FileName const old_auto = getAutosaveFileName();
+       bool const old_unnamed = isUnnamed();
+
+       setFileName(fn);
+       markDirty();
+       setUnnamed(false);
+
+       if (save()) {
+               // bring the autosave file with us, just in case.
+               moveAutosaveFile(old_auto);
+               // validate version control data and
+               // correct buffer title
+               lyxvc().file_found_hook(fileName());
+               updateTitles();
+               // the file has now been saved to the new location.
+               // we need to check that the locations of child buffers
+               // are still valid.
+               checkChildBuffers();
+               return true;
+       } else {
+               // save failed
+               // reset the old filename and unnamed state
+               setFileName(old_name);
+               setUnnamed(old_unnamed);
+               return false;
+       }
+}
+
+
 // FIXME We could do better here, but it is complicated. What would be
 // nice is to offer either (a) to save the child buffer to an appropriate
 // location, so that it would "move with the master", or else (b) to update