3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
8 * Full author contact details are available in file CREDITS
13 #include "bufferlist.h"
15 #include "lastfiles.h"
20 #include "bufferview_funcs.h"
21 #include "BufferView.h"
23 #include "frontends/LyXView.h"
24 #include "vc-backend.h"
25 #include "TextCache.h"
28 #include "frontends/Alert.h"
30 #include "support/FileInfo.h"
31 #include "support/filetools.h"
32 #include "support/lyxmanip.h"
33 #include "support/lyxfunctional.h"
34 #include "support/LAssert.h"
36 #include <boost/bind.hpp>
50 extern BufferView * current_view;
53 BufferList::BufferList()
57 bool BufferList::empty() const
59 return bstore.empty();
63 bool BufferList::quitWriteBuffer(Buffer * buf)
67 file = OnlyFilename(buf->fileName());
69 file = MakeDisplayPath(buf->fileName(), 30);
71 string text = bformat(_("The document %1$s has unsaved changes.\n\n"
72 "Do you want to save the document?"), file);
73 int const ret = Alert::prompt(_("Save changed document?"),
74 text, 0, 2, _("&Save Changes"), _("&Discard Changes"), _("&Cancel"));
77 // FIXME: WriteAs can be asynch !
78 // but not right now...maybe we should remove that
83 succeeded = WriteAs(current_view, buf);
85 succeeded = MenuWrite(current_view, buf);
89 } else if (ret == 1) {
90 // if we crash after this we could
91 // have no autosave file but I guess
92 // this is really inprobable (Jug)
94 removeAutosaveFile(buf->fileName());
104 bool BufferList::quitWriteAll()
106 BufferStorage::iterator it = bstore.begin();
107 BufferStorage::iterator end = bstore.end();
108 for (; it != end; ++it) {
109 if ((*it)->isClean())
112 if (!quitWriteBuffer(*it))
120 void BufferList::release(Buffer * buf)
123 BufferStorage::iterator it = find(bstore.begin(), bstore.end(), buf);
124 if (it != bstore.end()) {
125 // Make sure that we don't store a LyXText in
126 // the textcache that points to the buffer
128 Buffer * tmp = (*it);
130 textcache.removeAllWithBuffer(tmp);
136 Buffer * BufferList::newBuffer(string const & s, bool ronly)
138 Buffer * tmpbuf = new Buffer(s, ronly);
139 tmpbuf->params.useClassDefaults();
140 lyxerr[Debug::INFO] << "Assigning to buffer "
141 << bstore.size() << endl;
142 bstore.push_back(tmpbuf);
147 void BufferList::closeAll()
149 // Since we are closing we can just as well delete all
150 // in the textcache this will also speed the closing/quiting up a bit.
153 while (!bstore.empty()) {
154 close(bstore.front(), false);
159 bool BufferList::close(Buffer * buf, bool ask)
163 // FIXME: is the quitting check still necessary ?
164 if (!ask || buf->isClean() || quitting || buf->paragraphs.empty()) {
170 if (buf->isUnnamed())
171 fname = OnlyFilename(buf->fileName());
173 fname = MakeDisplayPath(buf->fileName(), 30);
175 string text = bformat(_("The document %1$s has unsaved changes.\n\n"
176 "Do you want to save the document?"), fname);
177 int const ret = Alert::prompt(_("Save changed document?"),
178 text, 0, 2, _("&Save Changes"), _("&Discard Changes"), _("&Cancel"));
181 if (buf->isUnnamed()) {
182 if (!WriteAs(current_view, buf))
184 } else if (buf->save()) {
185 lastfiles->newFile(buf->fileName());
189 } else if (ret == 2) {
193 if (buf->isUnnamed()) {
194 removeAutosaveFile(buf->fileName());
202 vector<string> const BufferList::getFileNames() const
205 std::copy(bstore.begin(), bstore.end(),
206 lyx::back_inserter_fun(nvec, &Buffer::fileName));
211 Buffer * BufferList::first()
215 return bstore.front();
219 Buffer * BufferList::getBuffer(unsigned int choice)
221 if (choice >= bstore.size())
223 return bstore[choice];
227 void BufferList::updateIncludedTeXfiles(string const & mastertmpdir,
228 LatexRunParams const & runparams)
230 BufferStorage::iterator it = bstore.begin();
231 BufferStorage::iterator end = bstore.end();
232 for (; it != end; ++it) {
233 if (!(*it)->isDepClean(mastertmpdir)) {
234 string writefile = mastertmpdir;
236 writefile += (*it)->getLatexName();
237 (*it)->makeLaTeXFile(writefile, mastertmpdir,
238 runparams, false, true);
239 (*it)->markDepClean(mastertmpdir);
245 void BufferList::emergencyWriteAll()
247 for_each(bstore.begin(), bstore.end(),
248 boost::bind(&BufferList::emergencyWrite, this, _1));
252 void BufferList::emergencyWrite(Buffer * buf)
254 // assert(buf) // this is not good since C assert takes an int
255 // and a pointer is a long (JMarc)
256 assert(buf != 0); // use c assert to avoid a loop
259 // No need to save if the buffer has not changed.
263 string const doc = buf->isUnnamed()
264 ? OnlyFilename(buf->fileName()) : buf->fileName();
266 lyxerr << bformat(_("LyX: Attempting to save document %1$s"), doc) << endl;
268 // We try to save three places:
269 // 1) Same place as document. Unless it is an unnamed doc.
270 if (!buf->isUnnamed()) {
271 string s = buf->fileName();
273 lyxerr << " " << s << endl;
274 if (buf->writeFile(s)) {
276 lyxerr << _(" Save seems successful. Phew.") << endl;
279 lyxerr << _(" Save failed! Trying...") << endl;
283 // 2) In HOME directory.
284 string s = AddName(GetEnvPath("HOME"), buf->fileName());
286 lyxerr << ' ' << s << endl;
287 if (buf->writeFile(s)) {
289 lyxerr << _(" Save seems successful. Phew.") << endl;
293 lyxerr << _(" Save failed! Trying...") << endl;
295 // 3) In "/tmp" directory.
296 // MakeAbsPath to prepend the current
297 // drive letter on OS/2
298 s = AddName(MakeAbsPath("/tmp/"), buf->fileName());
300 lyxerr << ' ' << s << endl;
301 if (buf->writeFile(s)) {
303 lyxerr << _(" Save seems successful. Phew.") << endl;
306 lyxerr << _(" Save failed! Bummer. Document is lost.") << endl;
311 Buffer * BufferList::readFile(string const & s, bool ronly)
314 string e = OnlyPath(s);
316 // File information about normal file
317 FileInfo fileInfo2(s);
319 if (!fileInfo2.exist()) {
320 string const file = MakeDisplayPath(s, 50);
321 string text = bformat(_("The specified document\n%1$s"
322 "\ncould not be read."), file);
323 Alert::error(_("Could not read document"), text);
327 Buffer * b = newBuffer(s, ronly);
329 // Check if emergency save file exists and is newer.
330 e += OnlyFilename(s) + ".emergency";
331 FileInfo fileInfoE(e);
333 bool use_emergency = false;
335 if (fileInfoE.exist() && fileInfo2.exist()) {
336 if (fileInfoE.getModificationTime()
337 > fileInfo2.getModificationTime()) {
338 string const file = MakeDisplayPath(s, 20);
339 string text = bformat(_("An emergency save of the document %1$s exists.\n"
340 "\nRecover emergency save?"), file);
341 int const ret = Alert::prompt(_("Load emergency save?"),
342 text, 0, 1, _("&Recover"), _("&Load Original"));
346 // the file is not saved if we load the
349 use_emergency = true;
354 if (!use_emergency) {
355 // Now check if autosave file is newer.
357 a += OnlyFilename(s);
359 FileInfo fileInfoA(a);
360 if (fileInfoA.exist() && fileInfo2.exist()) {
361 if (fileInfoA.getModificationTime()
362 > fileInfo2.getModificationTime()) {
363 string const file = MakeDisplayPath(s, 20);
364 string text = bformat(_("The backup of the document %1$s is newer.\n\n"
365 "Load the backup instead?"), file);
366 int const ret = Alert::prompt(_("Load backup?"),
367 text, 0, 1, _("&Load backup"), _("Load &original"));
371 // the file is not saved if we load the
375 // Here, we should delete the autosave
381 // not sure if this is the correct place to begin LyXLex
384 if (b->readFile(lex, ts))
393 bool BufferList::exists(string const & s) const
395 return find_if(bstore.begin(), bstore.end(),
396 lyx::compare_memfun(&Buffer::fileName, s))
401 bool BufferList::isLoaded(Buffer const * b) const
405 BufferStorage::const_iterator cit =
406 find(bstore.begin(), bstore.end(), b);
407 return cit != bstore.end();
411 Buffer * BufferList::getBuffer(string const & s)
413 BufferStorage::iterator it =
414 find_if(bstore.begin(), bstore.end(),
415 lyx::compare_memfun(&Buffer::fileName, s));
416 return it != bstore.end() ? (*it) : 0;
420 Buffer * BufferList::newFile(string const & name, string tname, bool isNamed)
423 Buffer * b = newBuffer(name);
425 // use defaults.lyx as a default template if it exists.
427 tname = LibFileSearch("templates", "defaults.lyx");
429 if (!tname.empty()) {
430 bool templateok = false;
434 if (b->readFile(lex, tname)) {
439 string const file = MakeDisplayPath(tname, 50);
440 string text = bformat(_("The specified document template\n%1$s\n"
441 "could not be read."), file);
442 Alert::error(_("Could not read template"), text);
443 // no template, start with empty buffer
444 b->paragraphs.push_back(new Paragraph);
445 b->paragraphs.begin()->layout(b->params.getLyXTextClass().defaultLayout());
447 } else { // start with empty buffer
448 b->paragraphs.push_back(new Paragraph);
449 b->paragraphs.begin()->layout(b->params.getLyXTextClass().defaultLayout());
454 b->setFileName(name);
457 b->setReadonly(false);
458 b->updateDocLang(b->params.language);
464 Buffer * BufferList::loadLyXFile(string const & filename, bool tolastfiles)
466 // get absolute path of file and add ".lyx" to the filename if
468 string s = FileSearch(string(), filename, "lyx");
473 // file already open?
475 string const file = MakeDisplayPath(s, 20);
476 string text = bformat(_("The document %1$s is already loaded.\n\n"
477 "Do you want to revert to the saved version?"), file);
478 int const ret = Alert::prompt(_("Revert to saved document?"),
479 text, 0, 1, _("&Revert"), _("&Switch to document"));
482 // FIXME: should be LFUN_REVERT
483 if (!close(getBuffer(s), false)) {
486 // Fall through to new load. (Asger)
488 // Here, we pretend that we just loaded the
496 switch (IsFileWriteable(s)) {
503 b->lyxvc.file_found_hook(s);
505 break; //fine- it's r/w
507 string const file = MakeDisplayPath(s, 20);
508 // Here we probably should run
509 if (LyXVC::file_not_found_hook(s)) {
510 string text = bformat(_("Do you want to retrieve the document"
511 " %1$s from version control?"), file);
512 int const ret = Alert::prompt(_("Retrieve from version control?"),
513 text, 0, 1, _("&Retrieve"), _("&Cancel"));
516 // How can we know _how_ to do the checkout?
517 // With the current VC support it has to be,
518 // a RCS file since CVS do not have special ,v files.
520 return loadLyXFile(filename, tolastfiles);
524 string text = bformat(_("The document %1$s does not yet exist.\n\n"
525 "Do you want to create a new document?"), file);
526 int const ret = Alert::prompt(_("Create new document?"),
527 text, 0, 1, _("&Create"), _("Cancel"));
530 b = newFile(s, string(), true);
536 if (b && tolastfiles)
537 lastfiles->newFile(b->fileName());
543 void BufferList::setCurrentAuthor(string const & name, string const & email)
545 BufferStorage::iterator it = bstore.begin();
546 BufferStorage::iterator end = bstore.end();
547 for (; it != end; ++it) {
548 (*it)->authors().record(0, Author(name, email));