src/BufferList.cpp

   1 /**
   2  * \file BufferList.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "BufferList.h"
  14
  15 #include "Author.h"
  16 #include "Buffer.h"
  17 #include "BufferParams.h"
  18 #include "debug.h"
  19 #include "gettext.h"
  20 #include "Session.h"
  21 #include "callback.h"
  22 #include "LyX.h"
  23 #include "output_latex.h"
  24 #include "ParagraphList.h"
  25
  26 #include "frontends/alert.h"
  27
  28 #include "support/filetools.h"
  29 #include "support/Package.h"
  30
  31 #include <boost/bind.hpp>
  32
  33 #include <algorithm>
  34 #include <functional>
  35
  36 using boost::bind;
  37
  38 using std::auto_ptr;
  39 using std::endl;
  40 using std::equal_to;
  41 using std::find;
  42 using std::find_if;
  43 using std::for_each;
  44 using std::string;
  45 using std::vector;
  46 using std::back_inserter;
  47 using std::transform;
  48
  49
  50 namespace lyx {
  51
  52 using support::addName;
  53 using support::bformat;
  54 using support::FileName;
  55 using support::makeDisplayPath;
  56 using support::onlyFilename;
  57 using support::removeAutosaveFile;
  58 using support::package;
  59 using support::prefixIs;
  60
  61 namespace Alert = lyx::frontend::Alert;
  62
  63
  64 BufferList::BufferList()
  65 {}
  66
  67
  68 bool BufferList::empty() const
  69 {
  70         return bstore.empty();
  71 }
  72
  73
  74 BufferList::iterator BufferList::begin()
  75 {
  76         return bstore.begin();
  77 }
  78
  79
  80 BufferList::const_iterator BufferList::begin() const
  81 {
  82         return bstore.begin();
  83 }
  84
  85
  86 BufferList::iterator BufferList::end()
  87 {
  88         return bstore.end();
  89 }
  90
  91
  92 BufferList::const_iterator BufferList::end() const
  93 {
  94         return bstore.end();
  95 }
  96
  97
  98 bool BufferList::quitWriteBuffer(Buffer * buf)
  99 {
 100         BOOST_ASSERT(buf);
 101
 102         docstring file;
 103         if (buf->isUnnamed())
 104                 file = from_utf8(onlyFilename(buf->fileName()));
 105         else
 106                 file = makeDisplayPath(buf->fileName(), 30);
 107
 108         docstring const text =
 109                 bformat(_("The document %1$s has unsaved changes.\n\n"
 110                                        "Do you want to save the document or discard the changes?"),
 111                                            file);
 112         int const ret = Alert::prompt(_("Save changed document?"),
 113                 text, 0, 2, _("&Save"), _("&Discard"), _("&Cancel"));
 114
 115         if (ret == 0) {
 116                 // FIXME: WriteAs can be asynch !
 117                 // but not right now...maybe we should remove that
 118
 119                 bool succeeded;
 120
 121                 if (buf->isUnnamed())
 122                         succeeded = writeAs(buf);
 123                 else
 124                         succeeded = menuWrite(buf);
 125
 126                 if (!succeeded)
 127                         return false;
 128         } else if (ret == 1) {
 129                 // if we crash after this we could
 130                 // have no autosave file but I guess
 131                 // this is really inprobable (Jug)
 132                 if (buf->isUnnamed())
 133                         removeAutosaveFile(buf->fileName());
 134
 135         } else {
 136                 return false;
 137         }
 138
 139         return true;
 140 }
 141
 142
 143 bool BufferList::quitWriteAll()
 144 {
 145         BufferStorage::iterator it = bstore.begin();
 146         BufferStorage::iterator end = bstore.end();
 147         for (; it != end; ++it) {
 148                 if ((*it)->isClean())
 149                         continue;
 150
 151                 if (!quitWriteBuffer(*it))
 152                         return false;
 153         }
 154         // now, all buffers have been written sucessfully
 155         // save file names to .lyx/session
 156         it = bstore.begin();
 157         for (; it != end; ++it) {
 158                 // if master/slave are both open, do not save slave since it
 159                 // will be automatically loaded when the master is loaded
 160                 if ((*it)->getMasterBuffer() == (*it))
 161                         LyX::ref().session().lastOpened().add(FileName((*it)->fileName()));
 162         }
 163
 164         return true;
 165 }
 166
 167
 168 void BufferList::release(Buffer * buf)
 169 {
 170         BOOST_ASSERT(buf);
 171         BufferStorage::iterator const it =
 172                 find(bstore.begin(), bstore.end(), buf);
 173         if (it != bstore.end()) {
 174                 Buffer * tmp = (*it);
 175                 BOOST_ASSERT(tmp);
 176                 bstore.erase(it);
 177                 delete tmp;
 178         }
 179 }
 180
 181
 182 Buffer * BufferList::newBuffer(string const & s, bool const ronly)
 183 {
 184         auto_ptr<Buffer> tmpbuf(new Buffer(s, ronly));
 185         tmpbuf->params().useClassDefaults();
 186         LYXERR(Debug::INFO) << "Assigning to buffer "
 187                             << bstore.size() << endl;
 188         bstore.push_back(tmpbuf.get());
 189         return tmpbuf.release();
 190 }
 191
 192
 193 void BufferList::closeAll()
 194 {
 195         while (!bstore.empty()) {
 196                 close(bstore.front(), false);
 197         }
 198 }
 199
 200
 201 bool BufferList::close(Buffer * buf, bool const ask)
 202 {
 203         BOOST_ASSERT(buf);
 204
 205         if (!ask || buf->isClean() || buf->paragraphs().empty()) {
 206                 release(buf);
 207                 return true;
 208         }
 209
 210         docstring fname;
 211         if (buf->isUnnamed())
 212                 fname = from_utf8(onlyFilename(buf->fileName()));
 213         else
 214                 fname = makeDisplayPath(buf->fileName(), 30);
 215
 216         docstring const text =
 217                 bformat(_("The document %1$s has unsaved changes.\n\n"
 218                                        "Do you want to save the document or discard the changes?"),
 219                                            fname);
 220         int const ret = Alert::prompt(_("Save changed document?"),
 221                 text, 0, 2, _("&Save"), _("&Discard"), _("&Cancel"));
 222
 223         if (ret == 0) {
 224                 if (buf->isUnnamed()) {
 225                         if (!writeAs(buf))
 226                                 return false;
 227                 } else if (!menuWrite(buf))
 228                         return false;
 229                 else
 230                         return false;
 231         } else if (ret == 2)
 232                 return false;
 233
 234         if (buf->isUnnamed()) {
 235                 removeAutosaveFile(buf->fileName());
 236         }
 237
 238         release(buf);
 239         return true;
 240 }
 241
 242
 243 vector<string> const BufferList::getFileNames() const
 244 {
 245         vector<string> nvec;
 246         transform(bstore.begin(), bstore.end(),
 247                   back_inserter(nvec),
 248                   boost::bind(&Buffer::fileName, _1));
 249         return nvec;
 250 }
 251
 252
 253 Buffer * BufferList::first()
 254 {
 255         if (bstore.empty())
 256                 return 0;
 257         return bstore.front();
 258 }
 259
 260
 261 Buffer * BufferList::last()
 262 {
 263         if (bstore.empty())
 264                 return 0;
 265         return bstore.back();
 266 }
 267
 268
 269 Buffer * BufferList::getBuffer(unsigned int const choice)
 270 {
 271         if (choice >= bstore.size())
 272                 return 0;
 273         return bstore[choice];
 274 }
 275
 276
 277 Buffer * BufferList::next(Buffer const * buf) const
 278 {
 279         BOOST_ASSERT(buf);
 280
 281         if (bstore.empty())
 282                 return 0;
 283         BufferStorage::const_iterator it = find(bstore.begin(),
 284                                                 bstore.end(), buf);
 285         BOOST_ASSERT(it != bstore.end());
 286         ++it;
 287         if (it == bstore.end())
 288                 return bstore.front();
 289         else
 290                 return *it;
 291 }
 292
 293
 294 Buffer * BufferList::previous(Buffer const * buf) const
 295 {
 296         BOOST_ASSERT(buf);
 297
 298         if (bstore.empty())
 299                 return 0;
 300         BufferStorage::const_iterator it = find(bstore.begin(),
 301                                                 bstore.end(), buf);
 302         BOOST_ASSERT(it != bstore.end());
 303         if (it == bstore.begin())
 304                 return bstore.back();
 305         else
 306                 return *(it - 1);
 307 }
 308
 309
 310 void BufferList::updateIncludedTeXfiles(string const & mastertmpdir,
 311                                         OutputParams const & runparams)
 312 {
 313         BufferStorage::iterator it = bstore.begin();
 314         BufferStorage::iterator end = bstore.end();
 315         for (; it != end; ++it) {
 316                 if (!(*it)->isDepClean(mastertmpdir)) {
 317                         string writefile = addName(mastertmpdir, (*it)->getLatexName());
 318                         (*it)->makeLaTeXFile(FileName(writefile), mastertmpdir,
 319                                              runparams, false);
 320                         (*it)->markDepClean(mastertmpdir);
 321                 }
 322         }
 323 }
 324
 325
 326 void BufferList::emergencyWriteAll()
 327 {
 328         for_each(bstore.begin(), bstore.end(),
 329                  bind(&BufferList::emergencyWrite, this, _1));
 330 }
 331
 332
 333 void BufferList::emergencyWrite(Buffer * buf)
 334 {
 335         // Use ::assert to avoid a loop, BOOST_ASSERT ends up calling ::assert
 336         // compare with 0 to avoid pointer/interger comparison
 337         assert(buf != 0);
 338
 339         // No need to save if the buffer has not changed.
 340         if (buf->isClean())
 341                 return;
 342
 343         string const doc = buf->isUnnamed()
 344                 ? onlyFilename(buf->fileName()) : buf->fileName();
 345
 346         lyxerr << to_utf8(
 347                 bformat(_("LyX: Attempting to save document %1$s"), from_utf8(doc)))
 348                 << endl;
 349
 350         // We try to save three places:
 351         // 1) Same place as document. Unless it is an unnamed doc.
 352         if (!buf->isUnnamed()) {
 353                 string s = buf->fileName();
 354                 s += ".emergency";
 355                 lyxerr << "  " << s << endl;
 356                 if (buf->writeFile(FileName(s))) {
 357                         buf->markClean();
 358                         lyxerr << to_utf8(_("  Save seems successful. Phew.")) << endl;
 359                         return;
 360                 } else {
 361                         lyxerr << to_utf8(_("  Save failed! Trying...")) << endl;
 362                 }
 363         }
 364
 365         // 2) In HOME directory.
 366         string s = addName(package().home_dir().absFilename(), buf->fileName());
 367         s += ".emergency";
 368         lyxerr << ' ' << s << endl;
 369         if (buf->writeFile(FileName(s))) {
 370                 buf->markClean();
 371                 lyxerr << to_utf8(_("  Save seems successful. Phew.")) << endl;
 372                 return;
 373         }
 374
 375         lyxerr << to_utf8(_("  Save failed! Trying...")) << endl;
 376
 377         // 3) In "/tmp" directory.
 378         // MakeAbsPath to prepend the current
 379         // drive letter on OS/2
 380         s = addName(package().temp_dir().absFilename(), buf->fileName());
 381         s += ".emergency";
 382         lyxerr << ' ' << s << endl;
 383         if (buf->writeFile(FileName(s))) {
 384                 buf->markClean();
 385                 lyxerr << to_utf8(_("  Save seems successful. Phew.")) << endl;
 386                 return;
 387         }
 388         lyxerr << to_utf8(_("  Save failed! Bummer. Document is lost.")) << endl;
 389 }
 390
 391
 392 bool BufferList::exists(string const & s) const
 393 {
 394         return find_if(bstore.begin(), bstore.end(),
 395                        bind(equal_to<string>(),
 396                             bind(&Buffer::fileName, _1),
 397                             s))
 398                 != bstore.end();
 399 }
 400
 401
 402 bool BufferList::isLoaded(Buffer const * b) const
 403 {
 404         BOOST_ASSERT(b);
 405         BufferStorage::const_iterator cit =
 406                 find(bstore.begin(), bstore.end(), b);
 407         return cit != bstore.end();
 408 }
 409
 410
 411 Buffer * BufferList::getBuffer(string const & s)
 412 {
 413         BufferStorage::iterator it =
 414                 find_if(bstore.begin(), bstore.end(),
 415                         bind(equal_to<string>(),
 416                              bind(&Buffer::fileName, _1),
 417                              s));
 418
 419         return it != bstore.end() ? (*it) : 0;
 420 }
 421
 422
 423 Buffer * BufferList::getBufferFromTmp(string const & s)
 424 {
 425         BufferStorage::iterator it = bstore.begin();
 426         BufferStorage::iterator end = bstore.end();
 427         for (; it < end; ++it)
 428                 if (prefixIs(s, (*it)->temppath()))
 429                         return *it;
 430         return 0;
 431 }
 432
 433
 434 void BufferList::setCurrentAuthor(docstring const & name, docstring const & email)
 435 {
 436         BufferStorage::iterator it = bstore.begin();
 437         BufferStorage::iterator end = bstore.end();
 438         for (; it != end; ++it) {
 439                 (*it)->params().authors().record(0, Author(name, email));
 440         }
 441 }
 442
 443
 444 } // namespace lyx