#include "Buffer.h"
#include "Author.h"
+#include "BiblioInfo.h"
#include "BranchList.h"
#include "buffer_funcs.h"
#include "BufferList.h"
#include "Bullet.h"
#include "Chktex.h"
#include "debug.h"
+#include "DocIterator.h"
#include "Encoding.h"
#include "ErrorList.h"
#include "Exporter.h"
#include "Language.h"
#include "LaTeX.h"
#include "LaTeXFeatures.h"
+#include "Layout.h"
#include "LyXAction.h"
#include "Lexer.h"
#include "Text.h"
#include "paragraph_funcs.h"
#include "ParagraphParameters.h"
#include "ParIterator.h"
+#include "Session.h"
#include "sgml.h"
#include "TexRow.h"
+#include "TextClassList.h"
#include "TexStream.h"
#include "TocBackend.h"
#include "Undo.h"
#include "version.h"
+#include "EmbeddedFiles.h"
+#include "PDFOptions.h"
#include "insets/InsetBibitem.h"
#include "insets/InsetBibtex.h"
#include "mathed/MathSupport.h"
#include "frontends/alert.h"
+#include "frontends/Delegates.h"
+#include "frontends/WorkAreaManager.h"
+#include "frontends/FileDialog.h"
#include "graphics/Previews.h"
#include "support/types.h"
#include "support/lyxalgo.h"
+#include "support/FileFilterList.h"
#include "support/filetools.h"
+#include "support/Forkedcall.h"
#include "support/fs_extras.h"
#include "support/gzstream.h"
#include "support/lyxlib.h"
#include "support/textutils.h"
#include "support/convert.h"
+#if !defined (HAVE_FORK)
+# define fork() -1
+#endif
+
#include <boost/bind.hpp>
#include <boost/filesystem/exception.hpp>
#include <boost/filesystem/operations.hpp>
+#include <boost/shared_ptr.hpp>
#include <algorithm>
#include <iomanip>
using std::ostream;
using std::ostringstream;
using std::ofstream;
+using std::ifstream;
using std::pair;
using std::stack;
using std::vector;
using std::string;
using std::time_t;
-
namespace lyx {
using support::addName;
using support::tempName;
using support::trim;
using support::sum;
+using support::suffixIs;
namespace Alert = frontend::Alert;
namespace os = support::os;
namespace {
-int const LYX_FORMAT = 278;
+int const LYX_FORMAT = 295; //Uwe: htmlurl, href
} // namespace anon
/// Container for all sort of Buffer dependant errors.
map<string, ErrorList> errorLists;
+ /// all embedded files of this buffer
+ EmbeddedFiles embedded_files;
+
/// 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_;
unsigned long checksum_;
+
+ ///
+ frontend::WorkAreaManager * wa_;
};
Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_)
: lyx_clean(true), bak_clean(true), unnamed(false), read_only(readonly_),
filename(file), file_fully_loaded(false), inset(params),
- toc_backend(&parent), timestamp_(0), checksum_(0)
+ toc_backend(&parent), embedded_files(&parent), timestamp_(0),
+ checksum_(0), wa_(0)
{
inset.setAutoBreakRows(true);
lyxvc.buffer(&parent);
// FIXME: And now do something if temppath == string(), because we
// assume from now on that temppath points to a valid temp dir.
// See http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg67406.html
+
+ if (use_gui)
+ wa_ = new frontend::WorkAreaManager;
}
Buffer::Buffer(string const & file, bool readonly)
- : pimpl_(new Impl(*this, FileName(file), readonly))
+ : pimpl_(new Impl(*this, FileName(file), readonly)), gui_(0)
{
LYXERR(Debug::INFO) << "Buffer::Buffer()" << endl;
}
// here the buffer should take care that it is
// saved properly, before it goes into the void.
- closing();
+ Buffer * master = getMasterBuffer();
+ if (master != this && use_gui)
+ // We are closing buf which was a child document so we
+ // must update the labels and section numbering of its master
+ // Buffer.
+ updateLabels(*master);
if (!temppath().empty() && !destroyDir(FileName(temppath()))) {
Alert::warning(_("Could not remove temporary directory"),
// Remove any previewed LaTeX snippets associated with this buffer.
graphics::Previews::get().removeLoader(*this);
+
+ if (pimpl_->wa_) {
+ pimpl_->wa_->closeAll();
+ delete pimpl_->wa_;
+ }
+ delete pimpl_;
+}
+
+
+void Buffer::changed() const
+{
+ if (pimpl_->wa_)
+ pimpl_->wa_->redrawAll();
+}
+
+
+frontend::WorkAreaManager & Buffer::workAreaManager() const
+{
+ BOOST_ASSERT(pimpl_->wa_);
+ return *pimpl_->wa_;
}
}
+EmbeddedFiles & Buffer::embeddedFiles()
+{
+ return pimpl_->embedded_files;
+}
+
+
+EmbeddedFiles const & Buffer::embeddedFiles() const
+{
+ return pimpl_->embedded_files;
+}
+
+
string const Buffer::getLatexName(bool const no_path) const
{
string const name = changeExtension(makeLatexName(fileName()), ".tex");
params().headsep.erase();
params().footskip.erase();
params().listings_params.clear();
+ params().clearLayoutModules();
+ params().pdfoptions().clear();
+
for (int i = 0; i < 4; ++i) {
params().user_defined_bullet(i) = ITEMIZE_DEFAULTS[i];
params().temp_bullet(i) = ITEMIZE_DEFAULTS[i];
BOOST_ASSERT(paragraphs().empty());
readHeader(lex);
- if (!params().getTextClass().load(filePath())) {
- string theclass = params().getTextClass().name();
+ TextClass const & baseClass = textclasslist[params().getBaseClass()];
+ if (!baseClass.load(filePath())) {
+ string theclass = baseClass.name();
Alert::error(_("Can't load document class"), bformat(
_("Using the default document class, because the "
"class %1$s could not be loaded."), from_utf8(theclass)));
- params().textclass = 0;
+ params().setBaseClass(defaultTextclass());
}
if (params().outputChanges) {
"\\lyxadded and \\lyxdeleted in the LaTeX preamble."));
}
}
+ // read manifest after header
+ embeddedFiles().readManifest(lex, errorList);
+ // read main text
bool const res = text().read(*this, lex, errorList);
for_each(text().paragraphs().begin(),
text().paragraphs().end(),
bool Buffer::readFile(FileName const & filename)
{
+ FileName fname(filename);
// Check if the file is compressed.
- string const format = getFormatFromContents(filename);
+ string format = getFormatFromContents(filename);
+ if (format == "zip") {
+ // decompress to a temp directory
+ LYXERR(Debug::FILES) << filename << " is in zip format. Unzip to " << temppath() << endl;
+ ::unzipToDir(filename.toFilesystemEncoding(), temppath());
+ //
+ FileName lyxfile(addName(temppath(), "content.lyx"));
+ // if both manifest.txt and file.lyx exist, this is am embedded file
+ if (fs::exists(lyxfile.toFilesystemEncoding())) {
+ params().embedded = true;
+ fname = lyxfile;
+ }
+ }
+ // The embedded lyx file can also be compressed, for backward compatibility
+ format = getFormatFromContents(fname);
if (format == "gzip" || format == "zip" || format == "compress") {
params().compressed = true;
}
// remove dummy empty par
paragraphs().clear();
Lexer lex(0, 0);
- lex.setFile(filename);
- if (readFile(lex, filename) != success)
+ lex.setFile(fname);
+ if (readFile(lex, fname) != success)
return false;
return true;
}
lex.next();
- string const token(lex.getString());
+ string const token = lex.getString();
if (!lex) {
Alert::error(_("Document could not be read"),
int const file_format = convert<int>(tmp_format);
//lyxerr << "format: " << file_format << endl;
+ // save timestamp and checksum of the original disk file, making sure
+ // to not overwrite them with those of the file created in the tempdir
+ // when it has to be converted to the current format.
+ if (!pimpl_->checksum_) {
+ // Save the timestamp and checksum of disk file. If filename is an
+ // emergency file, save the timestamp and sum of the original lyx file
+ // because isExternallyModified will check for this file. (BUG4193)
+ string diskfile = filename.toFilesystemEncoding();
+ if (suffixIs(diskfile, ".emergency"))
+ diskfile = diskfile.substr(0, diskfile.size() - 10);
+ saveCheckSum(diskfile);
+ }
+
if (file_format != LYX_FORMAT) {
if (fromstring)
//MacroTable::localMacros().clear();
pimpl_->file_fully_loaded = true;
- // save the timestamp and checksum of disk file
- pimpl_->timestamp_ = fs::last_write_time(filename.toFilesystemEncoding());
- pimpl_->checksum_ = sum(filename);
return success;
}
if (writeFile(pimpl_->filename)) {
markClean();
removeAutosaveFile(fileName());
- pimpl_->timestamp_ = fs::last_write_time(pimpl_->filename.toFilesystemEncoding());
- pimpl_->checksum_ = sum(pimpl_->filename);
+ saveCheckSum(pimpl_->filename.toFilesystemEncoding());
return true;
} else {
// Saving failed, so backup is not backup
bool retval = false;
+ FileName content;
+ if (params().embedded)
+ // first write the .lyx file to the temporary directory
+ content = FileName(addName(temppath(), "content.lyx"));
+ else
+ content = fname;
+
if (params().compressed) {
- gz::ogzstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
+ gz::ogzstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
if (!ofs)
return false;
retval = write(ofs);
} else {
- ofstream ofs(fname.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
+ ofstream ofs(content.toFilesystemEncoding().c_str(), ios::out|ios::trunc);
if (!ofs)
return false;
retval = write(ofs);
}
+ if (retval && params().embedded) {
+ // write file.lyx and all the embedded files to the zip file fname
+ // if embedding is enabled
+ return pimpl_->embedded_files.writeFile(fname);
+ }
return retval;
}
params().writeFile(ofs);
ofs << "\\end_header\n";
+ // write the manifest after header
+ ofs << "\n\\begin_manifest\n";
+ pimpl_->embedded_files.update();
+ embeddedFiles().writeManifest(ofs);
+ ofs << "\\end_manifest\n";
+
// write the text
ofs << "\n\\begin_body\n";
text().write(*this, ofs);
}
-// This is also a buffer property (ale)
-void Buffer::fillWithBibKeys(vector<pair<string, docstring> > & keys)
- const
-{
- biblio::fillWithBibKeys(this, keys);
-}
-
-
void Buffer::updateBibfilesCache()
{
// if this is a child document and the parent is already loaded
bibfilesCache_.clear();
for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
- if (it->lyxCode() == Inset::BIBTEX_CODE) {
+ if (it->lyxCode() == BIBTEX_CODE) {
InsetBibtex const & inset =
static_cast<InsetBibtex const &>(*it);
vector<FileName> const bibfiles = inset.getFiles(*this);
bibfilesCache_.insert(bibfilesCache_.end(),
bibfiles.begin(),
bibfiles.end());
- } else if (it->lyxCode() == Inset::INCLUDE_CODE) {
+ } else if (it->lyxCode() == INCLUDE_CODE) {
InsetInclude & inset =
static_cast<InsetInclude &>(*it);
inset.updateBibfilesCache(*this);
for_each(par_iterator_begin(),
par_iterator_end(),
bind(&Paragraph::changeLanguage, _1, params(), from, to));
-
- text().current_font.setLanguage(to);
- text().real_current_font.setLanguage(to);
}
}
+void Buffer::saveCheckSum(string const & file) const
+{
+ if (fs::exists(file)) {
+ pimpl_->timestamp_ = fs::last_write_time(file);
+ pimpl_->checksum_ = sum(FileName(file));
+ } else {
+ // in the case of save to a new file.
+ pimpl_->timestamp_ = 0;
+ pimpl_->checksum_ = 0;
+ }
+}
+
+
void Buffer::markClean() const
{
if (!pimpl_->lyx_clean) {
}
-void Buffer::markBakClean()
+void Buffer::markBakClean() const
{
pimpl_->bak_clean = true;
}
if (!params().parentname.empty()
&& theBufferList().exists(params().parentname)) {
Buffer * buf = theBufferList().getBuffer(params().parentname);
- if (buf)
+ //We need to check if the parent is us...
+ //FIXME RECURSIVE INCLUDE
+ //This is not sufficient, since recursive includes could be downstream.
+ if (buf && buf != this)
return buf->getMasterBuffer();
}
InsetList::const_iterator end = insets.end();
for ( ; it != end; ++it) {
//lyxerr << "found inset code " << it->inset->lyxCode() << std::endl;
- if (it->inset->lyxCode() == Inset::MATHMACRO_CODE) {
+ if (it->inset->lyxCode() == MATHMACRO_CODE) {
MathMacroTemplate const & mac
= static_cast<MathMacroTemplate const &>(*it->inset);
insertMacro(mac.name(), mac.asMacroData());
}
-void Buffer::saveCursor(StableDocIterator cur, StableDocIterator anc)
-{
- cursor_ = cur;
- anchor_ = anc;
-}
-
-
void Buffer::changeRefsIfUnique(docstring const & from, docstring const & to,
- Inset::Code code)
+ InsetCode code)
{
//FIXME: This does not work for child documents yet.
- BOOST_ASSERT(code == Inset::CITE_CODE || code == Inset::REF_CODE);
+ BOOST_ASSERT(code == CITE_CODE || code == REF_CODE);
// Check if the label 'from' appears more than once
vector<docstring> labels;
- if (code == Inset::CITE_CODE) {
- vector<pair<string, docstring> > keys;
- fillWithBibKeys(keys);
- vector<pair<string, docstring> >::const_iterator bit = keys.begin();
- vector<pair<string, docstring> >::const_iterator bend = keys.end();
+ if (code == CITE_CODE) {
+ BiblioInfo keys;
+ keys.fillWithBibKeys(this);
+ BiblioInfo::const_iterator bit = keys.begin();
+ BiblioInfo::const_iterator bend = keys.end();
for (; bit != bend; ++bit)
// FIXME UNICODE
- labels.push_back(from_utf8(bit->first));
+ labels.push_back(bit->first);
} else
getLabelList(labels);
}
+void Buffer::structureChanged() const
+{
+ if (gui_)
+ gui_->structureChanged();
+}
+
+
+void Buffer::embeddingChanged() const
+{
+ if (gui_)
+ gui_->embeddingChanged();
+}
+
+
+void Buffer::errors(std::string const & err) const
+{
+ if (gui_)
+ gui_->errors(err);
+}
+
+
+void Buffer::message(docstring const & msg) const
+{
+ if (gui_)
+ gui_->message(msg);
+}
+
+
+void Buffer::busy(bool on) const
+{
+ if (gui_)
+ gui_->busy(on);
+}
+
+
+void Buffer::readonly(bool on) const
+{
+ if (gui_)
+ gui_->readonly(on);
+}
+
+
+void Buffer::updateTitles() const
+{
+ if (gui_)
+ gui_->updateTitles();
+}
+
+
+void Buffer::resetAutosaveTimers() const
+{
+ if (gui_)
+ gui_->resetAutosaveTimers();
+}
+
+
+void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
+{
+ gui_ = gui;
+}
+
+
+
+namespace {
+
+class AutoSaveBuffer : public support::ForkedProcess {
+public:
+ ///
+ AutoSaveBuffer(Buffer const & buffer, FileName const & fname)
+ : buffer_(buffer), fname_(fname) {}
+ ///
+ virtual boost::shared_ptr<ForkedProcess> clone() const
+ {
+ return boost::shared_ptr<ForkedProcess>(new AutoSaveBuffer(*this));
+ }
+ ///
+ int start()
+ {
+ command_ = to_utf8(bformat(_("Auto-saving %1$s"),
+ from_utf8(fname_.absFilename())));
+ return run(DontWait);
+ }
+private:
+ ///
+ virtual int generateChild();
+ ///
+ Buffer const & buffer_;
+ FileName fname_;
+};
+
+
+#if !defined (HAVE_FORK)
+# define fork() -1
+#endif
+
+int AutoSaveBuffer::generateChild()
+{
+ // tmp_ret will be located (usually) in /tmp
+ // will that be a problem?
+ pid_t const pid = fork();
+ // If you want to debug the autosave
+ // you should set pid to -1, and comment out the fork.
+ if (pid == 0 || pid == -1) {
+ // pid = -1 signifies that lyx was unable
+ // to fork. But we will do the save
+ // anyway.
+ bool failed = false;
+
+ FileName const tmp_ret(tempName(FileName(), "lyxauto"));
+ if (!tmp_ret.empty()) {
+ buffer_.writeFile(tmp_ret);
+ // assume successful write of tmp_ret
+ if (!rename(tmp_ret, fname_)) {
+ failed = true;
+ // most likely couldn't move between
+ // filesystems unless write of tmp_ret
+ // failed so remove tmp file (if it
+ // exists)
+ unlink(tmp_ret);
+ }
+ } else {
+ failed = true;
+ }
+
+ if (failed) {
+ // failed to write/rename tmp_ret so try writing direct
+ if (!buffer_.writeFile(fname_)) {
+ // It is dangerous to do this in the child,
+ // but safe in the parent, so...
+ if (pid == -1) // emit message signal.
+ buffer_.message(_("Autosave failed!"));
+ }
+ }
+ if (pid == 0) { // we are the child so...
+ _exit(0);
+ }
+ }
+ return pid;
+}
+
+} // namespace anon
+
+
+// Perfect target for a thread...
+void Buffer::autoSave() const
+{
+ if (isBakClean() || isReadonly()) {
+ // We don't save now, but we'll try again later
+ resetAutosaveTimers();
+ return;
+ }
+
+ // emit message signal.
+ message(_("Autosaving current document..."));
+
+ // create autosave filename
+ string fname = filePath();
+ fname += '#';
+ fname += onlyFilename(fileName());
+ fname += '#';
+
+ AutoSaveBuffer autosave(*this, FileName(fname));
+ autosave.start();
+
+ markBakClean();
+ resetAutosaveTimers();
+}
+
+
+/** Write a buffer to a new file name and rename the buffer
+ according to the new file name.
+
+ This function is e.g. used by menu callbacks and
+ LFUN_BUFFER_WRITE_AS.
+
+ If 'newname' is empty (the default), the user is asked via a
+ dialog for the buffer's new name and location.
+
+ If 'newname' is non-empty and has an absolute path, that is used.
+ Otherwise the base directory of the buffer is used as the base
+ for any relative path in 'newname'.
+*/
+
+bool Buffer::writeAs(string const & newname)
+{
+ string fname = fileName();
+ string const oldname = fname;
+
+ if (newname.empty()) { /// No argument? Ask user through dialog
+
+ // FIXME UNICODE
+ FileDialog fileDlg(_("Choose a filename to save document as"),
+ LFUN_BUFFER_WRITE_AS,
+ make_pair(_("Documents|#o#O"),
+ from_utf8(lyxrc.document_path)),
+ make_pair(_("Templates|#T#t"),
+ from_utf8(lyxrc.template_path)));
+
+ if (!support::isLyXFilename(fname))
+ fname += ".lyx";
+
+ support::FileFilterList const filter(_("LyX Documents (*.lyx)"));
+
+ FileDialog::Result result =
+ fileDlg.save(from_utf8(onlyPath(fname)),
+ filter,
+ from_utf8(onlyFilename(fname)));
+
+ if (result.first == FileDialog::Later)
+ return false;
+
+ fname = to_utf8(result.second);
+
+ if (fname.empty())
+ return false;
+
+ // Make sure the absolute filename ends with appropriate suffix
+ fname = makeAbsPath(fname).absFilename();
+ if (!support::isLyXFilename(fname))
+ fname += ".lyx";
+
+ } else
+ fname = makeAbsPath(newname, onlyPath(oldname)).absFilename();
+
+ if (fs::exists(FileName(fname).toFilesystemEncoding())) {
+ docstring const file = makeDisplayPath(fname, 30);
+ docstring text = bformat(_("The document %1$s already "
+ "exists.\n\nDo you want to "
+ "overwrite that document?"),
+ file);
+ int const ret = Alert::prompt(_("Overwrite document?"),
+ text, 0, 1, _("&Overwrite"), _("&Cancel"));
+
+ if (ret == 1)
+ return false;
+ }
+
+ // Ok, change the name of the buffer
+ setFileName(fname);
+ markDirty();
+ bool unnamed = isUnnamed();
+ setUnnamed(false);
+ saveCheckSum(fname);
+
+ if (!menuWrite()) {
+ setFileName(oldname);
+ setUnnamed(unnamed);
+ saveCheckSum(oldname);
+ return false;
+ }
+
+ removeAutosaveFile(oldname);
+ return true;
+}
+
+
+bool Buffer::menuWrite()
+{
+ if (save()) {
+ LyX::ref().session().lastFiles().add(FileName(fileName()));
+ return true;
+ }
+
+ // FIXME: we don't tell the user *WHY* the save failed !!
+
+ docstring const file = makeDisplayPath(fileName(), 30);
+
+ docstring text = bformat(_("The document %1$s could not be saved.\n\n"
+ "Do you want to rename the document and "
+ "try again?"), file);
+ int const ret = Alert::prompt(_("Rename and save?"),
+ text, 0, 1, _("&Rename"), _("&Cancel"));
+
+ if (ret != 0)
+ return false;
+
+ return writeAs();
+}
+
+
} // namespace lyx