#include "Buffer.h"
#include "Author.h"
+#include "BiblioInfo.h"
#include "BranchList.h"
#include "buffer_funcs.h"
#include "BufferList.h"
#include "BufferParams.h"
-#include "Counters.h"
#include "Bullet.h"
#include "Chktex.h"
+#include "Converter.h"
+#include "Counters.h"
#include "debug.h"
+#include "DocIterator.h"
+#include "EmbeddedFiles.h"
#include "Encoding.h"
#include "ErrorList.h"
#include "Exporter.h"
#include "FuncRequest.h"
#include "gettext.h"
#include "InsetIterator.h"
+#include "InsetList.h"
#include "Language.h"
-#include "LaTeX.h"
#include "LaTeXFeatures.h"
-#include "LyXAction.h"
+#include "LaTeX.h"
+#include "Layout.h"
#include "Lexer.h"
-#include "Text.h"
+#include "LyXAction.h"
#include "LyX.h"
#include "LyXRC.h"
#include "LyXVC.h"
#include "Messages.h"
-#include "output.h"
#include "output_docbook.h"
+#include "output.h"
#include "output_latex.h"
-#include "Paragraph.h"
+#include "output_plaintext.h"
#include "paragraph_funcs.h"
+#include "Paragraph.h"
#include "ParagraphParameters.h"
#include "ParIterator.h"
+#include "PDFOptions.h"
+#include "Session.h"
#include "sgml.h"
#include "TexRow.h"
#include "TexStream.h"
+#include "TextClassList.h"
+#include "Text.h"
#include "TocBackend.h"
#include "Undo.h"
+#include "VCBackend.h"
#include "version.h"
#include "insets/InsetBibitem.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::changeExtension;
using support::cmd_ret;
using support::createBufferTmpDir;
-using support::destroyDir;
using support::FileName;
-using support::getFormatFromContents;
using support::libFileSearch;
using support::latex_path;
using support::ltrim;
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 = 296; //RGH: InsetInclude changes
} // namespace anon
{
public:
Impl(Buffer & parent, FileName const & file, bool readonly);
-
- limited_stack<Undo> undostack;
- limited_stack<Undo> redostack;
+
BufferParams params;
LyXVC lyxvc;
string temppath;
/// 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_;
+
+ ///
+ Undo undo_;
};
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), undo_(parent)
{
inset.setAutoBreakRows(true);
- lyxvc.buffer(&parent);
+ lyxvc.setBuffer(&parent);
temppath = createBufferTmpDir();
params.filepath = onlyPath(file.absFilename());
// 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 = masterBuffer();
+ 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()))) {
+ if (!temppath().empty() && !FileName(temppath()).destroyDirectory()) {
Alert::warning(_("Could not remove temporary directory"),
bformat(_("Could not remove the temporary directory %1$s"),
from_utf8(temppath())));
// Remove any previewed LaTeX snippets associated with this buffer.
graphics::Previews::get().removeLoader(*this);
-}
-
-Text & Buffer::text() const
-{
- return const_cast<Text &>(pimpl_->inset.text_);
-}
-
-
-Inset & Buffer::inset() const
-{
- return const_cast<InsetText &>(pimpl_->inset);
+ if (pimpl_->wa_) {
+ pimpl_->wa_->closeAll();
+ delete pimpl_->wa_;
+ }
+ delete pimpl_;
}
-limited_stack<Undo> & Buffer::undostack()
+void Buffer::changed() const
{
- return pimpl_->undostack;
+ if (pimpl_->wa_)
+ pimpl_->wa_->redrawAll();
}
-limited_stack<Undo> const & Buffer::undostack() const
+frontend::WorkAreaManager & Buffer::workAreaManager() const
{
- return pimpl_->undostack;
+ BOOST_ASSERT(pimpl_->wa_);
+ return *pimpl_->wa_;
}
-limited_stack<Undo> & Buffer::redostack()
+Text & Buffer::text() const
{
- return pimpl_->redostack;
+ return const_cast<Text &>(pimpl_->inset.text_);
}
-limited_stack<Undo> const & Buffer::redostack() const
+Inset & Buffer::inset() const
{
- return pimpl_->redostack;
+ return const_cast<InsetText &>(pimpl_->inset);
}
}
-string const Buffer::getLatexName(bool const no_path) const
+EmbeddedFiles & Buffer::embeddedFiles()
{
- string const name = changeExtension(makeLatexName(fileName()), ".tex");
+ return pimpl_->embedded_files;
+}
+
+
+EmbeddedFiles const & Buffer::embeddedFiles() const
+{
+ return pimpl_->embedded_files;
+}
+
+
+Undo & Buffer::undo()
+{
+ return pimpl_->undo_;
+}
+
+
+string Buffer::latexName(bool const no_path) const
+{
+ string const name = changeExtension(makeLatexName(absFileName()), ".tex");
return no_path ? onlyFilename(name) : name;
}
-pair<Buffer::LogType, string> const Buffer::getLogName() const
+pair<Buffer::LogType, string> Buffer::logName() const
{
- string const filename = getLatexName(false);
+ string const filename = latexName(false);
if (filename.empty())
return make_pair(Buffer::latexlog, string());
// If no Latex log or Build log is newer, show Build log
- if (fs::exists(bname.toFilesystemEncoding()) &&
- (!fs::exists(fname.toFilesystemEncoding()) ||
- fs::last_write_time(fname.toFilesystemEncoding()) < fs::last_write_time(bname.toFilesystemEncoding()))) {
+ if (bname.exists() &&
+ (!fname.exists() || fname.lastModified() < bname.lastModified())) {
LYXERR(Debug::FILES) << "Log name calculated as: " << bname << endl;
return make_pair(Buffer::buildlog, bname.absFilename());
}
{
pimpl_->filename = makeAbsPath(newfile);
params().filepath = onlyPath(pimpl_->filename.absFilename());
- setReadonly(fs::is_readonly(pimpl_->filename.toFilesystemEncoding()));
+ setReadonly(pimpl_->filename.isReadOnly());
updateTitles();
}
-// We'll remove this later. (Lgb)
-namespace {
-
-void unknownClass(string const & unknown)
-{
- Alert::warning(_("Unknown document class"),
- bformat(_("Using the default document class, because the "
- "class %1$s is unknown."), from_utf8(unknown)));
-}
-
-} // anon
-
-
int Buffer::readHeader(Lexer & lex)
{
int unknown_tokens = 0;
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];
string unknown = params().readToken(lex, token);
if (!unknown.empty()) {
if (unknown[0] != '\\' && token == "\\textclass") {
- unknownClass(unknown);
+ Alert::warning(_("Unknown document class"),
+ bformat(_("Using the default document class, because the "
+ "class %1$s is unknown."), from_utf8(unknown)));
} else {
++unknown_tokens;
docstring const s = bformat(_("Unknown token: "
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) {
}
}
+ // 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);
- if (format == "gzip" || format == "zip" || format == "compress") {
- params().compressed = true;
+ string format = filename.guessFormatFromContents();
+ 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 (lyxfile.exists()) {
+ params().embedded = true;
+ fname = lyxfile;
+ }
}
+ // The embedded lyx file can also be compressed, for backward compatibility
+ format = fname.guessFormatFromContents();
+ 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;
}
-bool Buffer::fully_loaded() const
+bool Buffer::isFullyLoaded() const
{
return pimpl_->file_fully_loaded;
}
-void Buffer::fully_loaded(bool const value)
+void Buffer::setFullyLoaded(bool value)
{
pimpl_->file_fully_loaded = value;
}
}
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(FileName(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;
}
// make a backup if the file already exists
if (lyxrc.make_backup && fs::exists(encodedFilename)) {
- backupName = FileName(fileName() + '~');
- if (!lyxrc.backupdir_path.empty())
+ backupName = FileName(absFileName() + '~');
+ if (!lyxrc.backupdir_path.empty()) {
+ string const mangledName =
+ subst(subst(os::internal_path(
+ backupName.absFilename()), '/', '!'), ':', '!');
backupName = FileName(addName(lyxrc.backupdir_path,
- subst(os::internal_path(backupName.absFilename()), '/', '!')));
-
+ mangledName));
+ }
try {
fs::copy_file(encodedFilename, backupName.toFilesystemEncoding(), false);
madeBackup = true;
// ask if the disk file has been externally modified (use checksum method)
if (fs::exists(encodedFilename) && isExternallyModified(checksum_method)) {
- docstring const file = makeDisplayPath(fileName(), 20);
+ 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);
int const ret = Alert::prompt(_("Overwrite modified file?"),
if (writeFile(pimpl_->filename)) {
markClean();
- removeAutosaveFile(fileName());
- pimpl_->timestamp_ = fs::last_write_time(pimpl_->filename.toFilesystemEncoding());
- pimpl_->checksum_ = sum(pimpl_->filename);
+ removeAutosaveFile(absFileName());
+ saveCheckSum(pimpl_->filename);
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().parentname.erase();
}
+ loadChildDocuments();
+
// the real stuff
latexParagraphs(*this, paragraphs(), os, texrow(), runparams);
preamble += "<!ENTITY % output.print.bmp \"IGNORE\">\n";
}
- string const name = runparams.nice ? changeExtension(fileName(), ".sgml")
- : fname;
+ string const name = runparams.nice
+ ? changeExtension(absFileName(), ".sgml") : fname;
preamble += features.getIncludedFiles(name);
preamble += features.getLyXSGMLEntities();
params().getTextClass().counters().reset();
+ loadChildDocuments();
+
sgml::openTag(os, top);
os << '\n';
docbookParagraphs(paragraphs(), *this, os, runparams);
// Other flags: -wall -v0 -x
int Buffer::runChktex()
{
- busy(true);
+ setBusy(true);
// get LaTeX-Filename
FileName const path(temppath());
- string const name = addName(path.absFilename(), getLatexName());
+ string const name = addName(path.absFilename(), latexName());
string const org_path = filePath();
support::Path p(path); // path to LaTeX file
Alert::error(_("chktex failure"),
_("Could not run chktex successfully."));
} else if (res > 0) {
- ErrorList & errorList = pimpl_->errorLists["ChkTeX"];
- // Clear out old errors
- errorList.clear();
- // Fill-in the error list with the TeX errors
- bufferErrors(*this, terr, errorList);
+ ErrorList & errlist = pimpl_->errorLists["ChkTeX"];
+ errlist.clear();
+ bufferErrors(terr, errlist);
}
- busy(false);
+ setBusy(false);
errors("ChkTeX");
if (params().use_esint == BufferParams::package_on)
features.require("esint");
+ loadChildDocuments();
+
for_each(paragraphs().begin(), paragraphs().end(),
boost::bind(&Paragraph::validate, _1, boost::ref(features)));
{
/// if this is a child document and the parent is already loaded
/// Use the parent's list instead [ale990407]
- Buffer const * tmp = getMasterBuffer();
+ Buffer const * tmp = masterBuffer();
if (!tmp) {
- lyxerr << "getMasterBuffer() failed!" << endl;
+ lyxerr << "masterBuffer() failed!" << endl;
BOOST_ASSERT(tmp);
}
if (tmp != this) {
return;
}
+ loadChildDocuments();
+
for (InsetIterator it = inset_iterator_begin(inset()); it; ++it)
it.nextInset()->getLabelList(*this, list);
}
-// This is also a buffer property (ale)
-void Buffer::fillWithBibKeys(vector<pair<string, docstring> > & keys)
- const
-{
- /// if this is a child document and the parent is already loaded
- /// use the parent's list instead [ale990412]
- Buffer const * tmp = getMasterBuffer();
- BOOST_ASSERT(tmp);
- if (tmp != this) {
- tmp->fillWithBibKeys(keys);
- return;
- }
-
- for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
- if (it->lyxCode() == Inset::BIBTEX_CODE) {
- InsetBibtex const & inset =
- static_cast<InsetBibtex const &>(*it);
- inset.fillWithBibKeys(*this, keys);
- } else if (it->lyxCode() == Inset::INCLUDE_CODE) {
- InsetInclude const & inset =
- static_cast<InsetInclude const &>(*it);
- inset.fillWithBibKeys(*this, keys);
- } else if (it->lyxCode() == Inset::BIBITEM_CODE) {
- InsetBibitem const & inset =
- static_cast<InsetBibitem const &>(*it);
- // FIXME UNICODE
- string const key = to_utf8(inset.getParam("key"));
- docstring const label = inset.getParam("label");
- DocIterator doc_it(it); doc_it.forwardPos();
- docstring const ref = doc_it.paragraph().asString(*this, false);
- docstring const info = label + "TheBibliographyRef" + ref;
- keys.push_back(pair<string, docstring>(key, info));
- }
- }
-}
-
-
void Buffer::updateBibfilesCache()
{
// if this is a child document and the parent is already loaded
// update the parent's cache instead
- Buffer * tmp = getMasterBuffer();
+ Buffer * tmp = masterBuffer();
BOOST_ASSERT(tmp);
if (tmp != this) {
tmp->updateBibfilesCache();
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);
{
// if this is a child document and the parent is already loaded
// use the parent's cache instead
- Buffer const * tmp = getMasterBuffer();
+ Buffer const * tmp = masterBuffer();
BOOST_ASSERT(tmp);
if (tmp != this)
return tmp->getBibfilesCache();
switch (func.action) {
case LFUN_BUFFER_EXPORT: {
- bool const tmp = Exporter::Export(this, to_utf8(func.argument()), false);
+ bool const tmp = doExport(to_utf8(func.argument()), false);
if (result)
*result = tmp;
break;
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);
}
}
-Language const * Buffer::getLanguage() const
+Language const * Buffer::language() const
{
return params().language;
}
bool Buffer::isExternallyModified(CheckMethod method) const
{
- BOOST_ASSERT(fs::exists(pimpl_->filename.toFilesystemEncoding()));
+ BOOST_ASSERT(pimpl_->filename.exists());
// if method == timestamp, check timestamp before checksum
return (method == checksum_method
- || pimpl_->timestamp_ != fs::last_write_time(pimpl_->filename.toFilesystemEncoding()))
+ || pimpl_->timestamp_ != pimpl_->filename.lastModified())
&& pimpl_->checksum_ != sum(pimpl_->filename);
}
+void Buffer::saveCheckSum(FileName const & file) const
+{
+ if (file.exists()) {
+ pimpl_->timestamp_ = file.lastModified();
+ pimpl_->checksum_ = sum(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;
}
}
-string const Buffer::fileName() const
+string Buffer::absFileName() const
{
return pimpl_->filename.absFilename();
}
}
-Buffer const * Buffer::getMasterBuffer() const
+Buffer const * Buffer::masterBuffer() const
{
if (!params().parentname.empty()
&& theBufferList().exists(params().parentname)) {
//FIXME RECURSIVE INCLUDE
//This is not sufficient, since recursive includes could be downstream.
if (buf && buf != this)
- return buf->getMasterBuffer();
+ return buf->masterBuffer();
}
return this;
}
-Buffer * Buffer::getMasterBuffer()
+Buffer * Buffer::masterBuffer()
{
if (!params().parentname.empty()
&& theBufferList().exists(params().parentname)) {
Buffer * buf = theBufferList().getBuffer(params().parentname);
- if (buf)
- return buf->getMasterBuffer();
+ //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->masterBuffer();
}
return this;
for (size_t i = 0, n = pars.size(); i != n; ++i) {
//lyxerr << "searching main par " << i
// << " for macro definitions" << std::endl;
- InsetList const & insets = pars[i].insetlist;
+ InsetList const & insets = pars[i].insetList();
InsetList::const_iterator it = insets.begin();
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();
+ string paramName;
+ 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));
- } else
+ labels.push_back(bit->first);
+ paramName = "key";
+ } else {
getLabelList(labels);
+ paramName = "reference";
+ }
if (std::count(labels.begin(), labels.end(), from) > 1)
return;
for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
if (it->lyxCode() == code) {
InsetCommand & inset = static_cast<InsetCommand &>(*it);
- inset.replaceContents(to_utf8(from), to_utf8(to));
+ docstring const oldValue = inset.getParam(paramName);
+ if (oldValue == from)
+ inset.setParam(paramName, to);
}
}
}
if (isLatex())
writeLaTeXSource(os, filePath(), runparams, true, true);
else {
- writeDocBookSource(os, fileName(), runparams, false);
+ writeDocBookSource(os, absFileName(), runparams, false);
}
} else {
runparams.par_begin = par_begin;
}
+void Buffer::structureChanged() const
+{
+ if (gui_)
+ gui_->structureChanged();
+}
+
+
+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::setBusy(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(absFileName());
+ 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 = absFileName();
+ 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 (FileName(fname).exists()) {
+ 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(FileName(fname));
+
+ if (!menuWrite()) {
+ setFileName(oldname);
+ setUnnamed(unnamed);
+ saveCheckSum(FileName(oldname));
+ return false;
+ }
+
+ removeAutosaveFile(oldname);
+ return true;
+}
+
+
+bool Buffer::menuWrite()
+{
+ if (save()) {
+ LyX::ref().session().lastFiles().add(FileName(absFileName()));
+ return true;
+ }
+
+ // FIXME: we don't tell the user *WHY* the save failed !!
+
+ docstring const file = makeDisplayPath(absFileName(), 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();
+}
+
+
+void Buffer::loadChildDocuments() const
+{
+ bool parse_error = false;
+
+ for (InsetIterator it = inset_iterator_begin(inset()); it; ++it) {
+ if (it->lyxCode() != INCLUDE_CODE)
+ continue;
+ InsetCommand const & inset = static_cast<InsetCommand const &>(*it);
+ InsetCommandParams const & ip = inset.params();
+ Buffer * child = loadIfNeeded(*this, ip);
+ if (!child)
+ continue;
+ parse_error |= !child->errorList("Parse").empty();
+ child->loadChildDocuments();
+ }
+
+ if (use_gui && masterBuffer() == this)
+ updateLabels(*this);
+}
+
+
+string Buffer::bufferFormat() const
+{
+ if (isDocBook())
+ return "docbook";
+ if (isLiterate())
+ return "literate";
+ return "latex";
+}
+
+
+bool Buffer::doExport(string const & format,
+ bool put_in_tempdir, string & result_file)
+{
+ string backend_format;
+ OutputParams runparams(¶ms().encoding());
+ runparams.flavor = OutputParams::LATEX;
+ runparams.linelen = lyxrc.plaintext_linelen;
+ vector<string> backs = backends();
+ if (find(backs.begin(), backs.end(), format) == backs.end()) {
+ // Get shortest path to format
+ Graph::EdgePath path;
+ for (vector<string>::const_iterator it = backs.begin();
+ it != backs.end(); ++it) {
+ Graph::EdgePath p = theConverters().getPath(*it, format);
+ if (!p.empty() && (path.empty() || p.size() < path.size())) {
+ backend_format = *it;
+ path = p;
+ }
+ }
+ if (!path.empty())
+ runparams.flavor = theConverters().getFlavor(path);
+ else {
+ Alert::error(_("Couldn't export file"),
+ bformat(_("No information for exporting the format %1$s."),
+ formats.prettyName(format)));
+ return false;
+ }
+ } else {
+ backend_format = format;
+ // FIXME: Don't hardcode format names here, but use a flag
+ if (backend_format == "pdflatex")
+ runparams.flavor = OutputParams::PDFLATEX;
+ }
+
+ string filename = latexName(false);
+ filename = addName(temppath(), filename);
+ filename = changeExtension(filename,
+ formats.extension(backend_format));
+
+ // Plain text backend
+ if (backend_format == "text")
+ writePlaintextFile(*this, FileName(filename), runparams);
+ // no backend
+ else if (backend_format == "lyx")
+ writeFile(FileName(filename));
+ // Docbook backend
+ else if (isDocBook()) {
+ runparams.nice = !put_in_tempdir;
+ makeDocBookFile(FileName(filename), runparams);
+ }
+ // LaTeX backend
+ else if (backend_format == format) {
+ runparams.nice = true;
+ if (!makeLaTeXFile(FileName(filename), string(), runparams))
+ return false;
+ } else if (!lyxrc.tex_allows_spaces
+ && support::contains(filePath(), ' ')) {
+ Alert::error(_("File name error"),
+ _("The directory path to the document cannot contain spaces."));
+ return false;
+ } else {
+ runparams.nice = false;
+ if (!makeLaTeXFile(FileName(filename), filePath(), runparams))
+ return false;
+ }
+
+ string const error_type = (format == "program")
+ ? "Build" : bufferFormat();
+ string const ext = formats.extension(format);
+ FileName const tmp_result_file(changeExtension(filename, ext));
+ bool const success = theConverters().convert(this, FileName(filename),
+ tmp_result_file, FileName(absFileName()), backend_format, format,
+ errorList(error_type));
+ // Emit the signal to show the error list.
+ if (format != backend_format)
+ errors(error_type);
+ if (!success)
+ return false;
+
+ if (put_in_tempdir)
+ result_file = tmp_result_file.absFilename();
+ else {
+ result_file = changeExtension(absFileName(), ext);
+ // We need to copy referenced files (e. g. included graphics
+ // if format == "dvi") to the result dir.
+ vector<ExportedFile> const files =
+ runparams.exportdata->externalFiles(format);
+ string const dest = onlyPath(result_file);
+ CopyStatus status = SUCCESS;
+ for (vector<ExportedFile>::const_iterator it = files.begin();
+ it != files.end() && status != CANCEL; ++it) {
+ string const fmt =
+ formats.getFormatFromFile(it->sourceName);
+ status = copyFile(fmt, it->sourceName,
+ makeAbsPath(it->exportName, dest),
+ it->exportName, status == FORCE);
+ }
+ if (status == CANCEL) {
+ message(_("Document export cancelled."));
+ } else if (tmp_result_file.exists()) {
+ // Finally copy the main file
+ status = copyFile(format, tmp_result_file,
+ FileName(result_file), result_file,
+ status == FORCE);
+ message(bformat(_("Document exported as %1$s "
+ "to file `%2$s'"),
+ formats.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)));
+ }
+ }
+
+ return true;
+}
+
+
+bool Buffer::doExport(string const & format, bool put_in_tempdir)
+{
+ string result_file;
+ return doExport(format, put_in_tempdir, result_file);
+}
+
+
+bool Buffer::preview(string const & format)
+{
+ string result_file;
+ if (!doExport(format, true, result_file))
+ return false;
+ return formats.view(*this, FileName(result_file), format);
+}
+
+
+bool Buffer::isExportable(string const & format) const
+{
+ vector<string> backs = backends();
+ for (vector<string>::const_iterator it = backs.begin();
+ it != backs.end(); ++it)
+ if (theConverters().isReachable(*it, format))
+ return true;
+ return false;
+}
+
+
+vector<Format const *> Buffer::exportableFormats(bool only_viewable) const
+{
+ vector<string> backs = backends();
+ vector<Format const *> result =
+ theConverters().getReachable(backs[0], only_viewable, true);
+ for (vector<string>::const_iterator it = backs.begin() + 1;
+ it != backs.end(); ++it) {
+ vector<Format const *> r =
+ theConverters().getReachable(*it, only_viewable, false);
+ result.insert(result.end(), r.begin(), r.end());
+ }
+ return result;
+}
+
+
+vector<string> Buffer::backends() const
+{
+ vector<string> v;
+ if (params().getTextClass().isTeXClassAvailable()) {
+ v.push_back(bufferFormat());
+ // FIXME: Don't hardcode format names here, but use a flag
+ if (v.back() == "latex")
+ v.push_back("pdflatex");
+ }
+ v.push_back("text");
+ v.push_back("lyx");
+ return v;
+}
+
+
+bool Buffer::readFileHelper(FileName const & s)
+{
+ // File information about normal file
+ if (!s.exists()) {
+ docstring const file = makeDisplayPath(s.absFilename(), 50);
+ docstring text = bformat(_("The specified document\n%1$s"
+ "\ncould not be read."), file);
+ Alert::error(_("Could not read document"), text);
+ return false;
+ }
+
+ // Check if emergency save file exists and is newer.
+ FileName const e(s.absFilename() + ".emergency");
+
+ if (e.exists() && s.exists() && e.lastModified() > s.lastModified()) {
+ docstring const file = makeDisplayPath(s.absFilename(), 20);
+ docstring const text =
+ bformat(_("An emergency save of the document "
+ "%1$s exists.\n\n"
+ "Recover emergency save?"), file);
+ switch (Alert::prompt(_("Load emergency save?"), text, 0, 2,
+ _("&Recover"), _("&Load Original"),
+ _("&Cancel")))
+ {
+ case 0:
+ // the file is not saved if we load the emergency file.
+ markDirty();
+ return readFile(e);
+ case 1:
+ break;
+ default:
+ return false;
+ }
+ }
+
+ // Now check if autosave file is newer.
+ FileName const a(onlyPath(s.absFilename()) + '#' + onlyFilename(s.absFilename()) + '#');
+
+ if (a.exists() && s.exists() && a.lastModified() > s.lastModified()) {
+ docstring const file = makeDisplayPath(s.absFilename(), 20);
+ docstring const text =
+ bformat(_("The backup of the document "
+ "%1$s is newer.\n\nLoad the "
+ "backup instead?"), file);
+ switch (Alert::prompt(_("Load backup?"), text, 0, 2,
+ _("&Load backup"), _("Load &original"),
+ _("&Cancel") ))
+ {
+ case 0:
+ // the file is not saved if we load the autosave file.
+ markDirty();
+ return readFile(a);
+ case 1:
+ // Here we delete the autosave
+ unlink(a);
+ break;
+ default:
+ return false;
+ }
+ }
+ return readFile(s);
+}
+
+
+bool Buffer::loadLyXFile(FileName const & s)
+{
+ if (s.isReadable()) {
+ if (readFileHelper(s)) {
+ lyxvc().file_found_hook(s);
+ if (!s.isWritable())
+ setReadonly(true);
+ return true;
+ }
+ } else {
+ docstring const file = makeDisplayPath(s.absFilename(), 20);
+ // Here we probably should run
+ if (LyXVC::file_not_found_hook(s)) {
+ docstring const text =
+ bformat(_("Do you want to retrieve the document"
+ " %1$s from version control?"), file);
+ int const ret = Alert::prompt(_("Retrieve from version control?"),
+ text, 0, 1, _("&Retrieve"), _("&Cancel"));
+
+ if (ret == 0) {
+ // How can we know _how_ to do the checkout?
+ // With the current VC support it has to be,
+ // a RCS file since CVS do not have special ,v files.
+ RCS::retrieve(s);
+ return loadLyXFile(s);
+ }
+ }
+ }
+ return false;
+}
+
+
+void Buffer::bufferErrors(TeXErrors const & terr, ErrorList & errorList) const
+{
+ TeXErrors::Errors::const_iterator cit = terr.begin();
+ TeXErrors::Errors::const_iterator end = terr.end();
+
+ for (; cit != end; ++cit) {
+ int id_start = -1;
+ int pos_start = -1;
+ int errorRow = cit->error_in_line;
+ bool found = texrow().getIdFromRow(errorRow, id_start,
+ pos_start);
+ int id_end = -1;
+ int pos_end = -1;
+ do {
+ ++errorRow;
+ found = texrow().getIdFromRow(errorRow, id_end, pos_end);
+ } while (found && id_start == id_end && pos_start == pos_end);
+
+ errorList.push_back(ErrorItem(cit->error_desc,
+ cit->error_text, id_start, pos_start, pos_end));
+ }
+}
+
} // namespace lyx