src/bufferlist.C

   1 /* This file is part of
   2  * ======================================================
   3  *
   4  *           LyX, The Document Word Processor
   5  *
   6  *           Copyright 1995 Matthias Ettrich
   7  *           Copyright 1995-2001 The LyX Team.
   8  *
   9  *           This file is Copyright 1996-2001
  10  *           Lars Gullik Bjønnes
  11  *
  12  * ======================================================
  13  */
  14
  15 #include <config.h>
  16
  17 #ifdef __GNUG__
  18 #pragma implementation
  19 #endif
  20
  21 #include "bufferlist.h"
  22 #include "lyx_main.h"
  23 #include "lastfiles.h"
  24 #include "debug.h"
  25 #include "lyxrc.h"
  26 #include "lyxtext.h"
  27 #include "lyx_cb.h"
  28 #include "bufferview_funcs.h"
  29 #include "BufferView.h"
  30 #include "gettext.h"
  31 #include "frontends/LyXView.h"
  32 #include "vc-backend.h"
  33 #include "TextCache.h"
  34 #include "lyxlex.h"
  35
  36 #include "frontends/Alert.h"
  37
  38 #include "support/FileInfo.h"
  39 #include "support/filetools.h"
  40 #include "support/lyxmanip.h"
  41 #include "support/lyxfunctional.h"
  42 #include "support/LAssert.h"
  43
  44 #include <boost/bind.hpp>
  45
  46 #include <cassert>
  47 #include <algorithm>
  48 #include <functional>
  49
  50
  51 using std::vector;
  52 using std::find;
  53 using std::endl;
  54 using std::find_if;
  55 using std::for_each;
  56 using std::mem_fun;
  57
  58 extern BufferView * current_view;
  59
  60 //
  61 // Class BufferStorage
  62 //
  63
  64 void BufferStorage::release(Buffer * buf)
  65 {
  66         lyx::Assert(buf);
  67         Container::iterator it = find(container.begin(), container.end(), buf);
  68         if (it != container.end()) {
  69                 // Make sure that we don't store a LyXText in
  70                 // the textcache that points to the buffer
  71                 // we just deleted.
  72                 Buffer * tmp = (*it);
  73                 container.erase(it);
  74                 textcache.removeAllWithBuffer(tmp);
  75                 delete tmp;
  76         }
  77 }
  78
  79
  80 Buffer * BufferStorage::newBuffer(string const & s, bool ronly)
  81 {
  82         Buffer * tmpbuf = new Buffer(s, ronly);
  83         tmpbuf->params.useClassDefaults();
  84         lyxerr[Debug::INFO] << "Assigning to buffer "
  85                             << container.size() << endl;
  86         container.push_back(tmpbuf);
  87         return tmpbuf;
  88 }
  89
  90
  91 //
  92 // Class BufferList
  93 //
  94
  95 BufferList::BufferList()
  96         : state_(BufferList::OK)
  97 {}
  98
  99
 100 bool BufferList::empty() const
 101 {
 102         return bstore.empty();
 103 }
 104
 105
 106 bool BufferList::qwriteOne(Buffer * buf, string const & fname,
 107                            string & unsaved_list)
 108 {
 109         bool reask = true;
 110         while (reask) {
 111                 switch (Alert::askConfirmation(_("Changes in document:"),
 112                                        fname,
 113                                        _("Save document?"))) {
 114                 case 1: // Yes
 115                         // FIXME: WriteAs can be asynch !
 116                         if (buf->isUnnamed())
 117                                 reask = !WriteAs(current_view, buf);
 118                         else {
 119                                 reask = !MenuWrite(current_view, buf);
 120                         }
 121                         break;
 122                 case 2: // No
 123                         // if we crash after this we could
 124                         // have no autosave file but I guess
 125                         // this is really inprobable (Jug)
 126                         if (buf->isUnnamed()) {
 127                                 removeAutosaveFile(buf->fileName());
 128                         }
 129
 130                         unsaved_list += MakeDisplayPath(fname, 50) + "\n";
 131                         return true;
 132                 case 3: // Cancel
 133                         return false;
 134                 }
 135         }
 136         return true;
 137 }
 138
 139
 140 bool BufferList::qwriteAll()
 141 {
 142         string unsaved;
 143         BufferStorage::iterator it = bstore.begin();
 144         BufferStorage::iterator end = bstore.end();
 145         for (; it != end; ++it) {
 146                 if (!(*it)->isClean()) {
 147                         string fname;
 148                         if ((*it)->isUnnamed())
 149                                 fname = OnlyFilename((*it)->fileName());
 150                         else
 151                                 fname = MakeDisplayPath((*it)->fileName(), 50);
 152                         if (!qwriteOne(*it, fname, unsaved)) // cancel the request!
 153                                 return false;
 154                 }
 155         }
 156
 157         return true;
 158 }
 159
 160
 161 void BufferList::closeAll()
 162 {
 163         state_ = BufferList::CLOSING;
 164         // Since we are closing we can just as well delete all
 165         // in the textcache this will also speed the closing/quiting up a bit.
 166         textcache.clear();
 167
 168         while (!bstore.empty()) {
 169                 close(bstore.front());
 170         }
 171         state_ = BufferList::OK;
 172 }
 173
 174
 175 bool BufferList::close(Buffer * buf)
 176 {
 177         lyx::Assert(buf);
 178
 179         // CHECK
 180         // Trace back why we need to use buf->getUser here.
 181         // Perhaps slight rewrite is in order? (Lgb)
 182
 183         if (buf->getUser())
 184                 buf->getUser()->insetUnlock();
 185
 186         if (!buf->paragraphs.empty() && !buf->isClean() && !quitting) {
 187                 if (buf->getUser())
 188                         buf->getUser()->owner()->prohibitInput();
 189                 string fname;
 190                 if (buf->isUnnamed())
 191                         fname = OnlyFilename(buf->fileName());
 192                 else
 193                         fname = MakeDisplayPath(buf->fileName(), 50);
 194                 bool reask = true;
 195                 while (reask) {
 196                         switch (Alert::askConfirmation(_("Changes in document:"),
 197                                                fname,
 198                                                _("Save document?"))) {
 199                         case 1: // Yes
 200                                 if (buf->isUnnamed())
 201                                         reask = !WriteAs(current_view, buf);
 202                                 else if (buf->save()) {
 203                                         lastfiles->newFile(buf->fileName());
 204                                         reask = false;
 205                                 } else {
 206                                         if (buf->getUser())
 207                                                 buf->getUser()->owner()->allowInput();
 208                                         return false;
 209                                 }
 210                                 break;
 211                         case 2:
 212                                 if (buf->isUnnamed()) {
 213                                         removeAutosaveFile(buf->fileName());
 214                                 }
 215                                 reask = false;
 216                                 break;
 217                         case 3: // Cancel
 218                                 if (buf->getUser())
 219                                         buf->getUser()->owner()->allowInput();
 220                                 return false;
 221                         }
 222                 }
 223                 if (buf->getUser())
 224                         buf->getUser()->owner()->allowInput();
 225         }
 226
 227         bstore.release(buf);
 228         return true;
 229 }
 230
 231
 232 vector<string> const BufferList::getFileNames() const
 233 {
 234         vector<string> nvec;
 235         std::copy(bstore.begin(), bstore.end(),
 236                   lyx::back_inserter_fun(nvec, &Buffer::fileName));
 237         return nvec;
 238 }
 239
 240
 241 Buffer * BufferList::first()
 242 {
 243         if (bstore.empty())
 244                 return 0;
 245         return bstore.front();
 246 }
 247
 248
 249 Buffer * BufferList::getBuffer(unsigned int choice)
 250 {
 251         if (choice >= bstore.size())
 252                 return 0;
 253         return bstore[choice];
 254 }
 255
 256
 257 int BufferList::unlockInset(UpdatableInset * inset)
 258 {
 259         lyx::Assert(inset);
 260
 261         BufferStorage::iterator it = bstore.begin();
 262         BufferStorage::iterator end = bstore.end();
 263         for (; it != end; ++it) {
 264                 if ((*it)->getUser()
 265                     && (*it)->getUser()->theLockingInset() == inset) {
 266                         (*it)->getUser()->insetUnlock();
 267                         return 0;
 268                 }
 269         }
 270         return 1;
 271 }
 272
 273
 274 void BufferList::updateIncludedTeXfiles(string const & mastertmpdir)
 275 {
 276         BufferStorage::iterator it = bstore.begin();
 277         BufferStorage::iterator end = bstore.end();
 278         for (; it != end; ++it) {
 279                 if (!(*it)->isDepClean(mastertmpdir)) {
 280                         string writefile = mastertmpdir;
 281                         writefile += '/';
 282                         writefile += (*it)->getLatexName();
 283                         (*it)->makeLaTeXFile(writefile, mastertmpdir,
 284                                              false, true);
 285                         (*it)->markDepClean(mastertmpdir);
 286                 }
 287         }
 288 }
 289
 290
 291 void BufferList::emergencyWriteAll()
 292 {
 293         for_each(bstore.begin(), bstore.end(),
 294                  boost::bind(&BufferList::emergencyWrite, this, _1));
 295 }
 296
 297
 298 void BufferList::emergencyWrite(Buffer * buf)
 299 {
 300         // assert(buf) // this is not good since C assert takes an int
 301                        // and a pointer is a long (JMarc)
 302         assert(buf != 0); // use c assert to avoid a loop
 303
 304
 305         // No need to save if the buffer has not changed.
 306         if (buf->isClean())
 307                 return;
 308
 309         string const doc = buf->isUnnamed()
 310                 ? OnlyFilename(buf->fileName()) : buf->fileName();
 311
 312         lyxerr << _("LyX: Attempting to save document ") << doc << endl;
 313
 314         // We try to save three places:
 315
 316         // 1) Same place as document. Unless it is an unnamed doc.
 317         if (!buf->isUnnamed()) {
 318                 string s = buf->fileName();
 319                 s += ".emergency";
 320                 lyxerr << "  " << s << endl;
 321                 if (buf->writeFile(s)) {
 322                         buf->markClean();
 323                         lyxerr << _("  Save seems successful. Phew.") << endl;
 324                         return;
 325                 } else {
 326                         lyxerr << _("  Save failed! Trying...") << endl;
 327                 }
 328         }
 329
 330         // 2) In HOME directory.
 331         string s = AddName(GetEnvPath("HOME"), buf->fileName());
 332         s += ".emergency";
 333         lyxerr << " " << s << endl;
 334         if (buf->writeFile(s)) {
 335                 buf->markClean();
 336                 lyxerr << _("  Save seems successful. Phew.") << endl;
 337                 return;
 338         }
 339
 340         lyxerr << _("  Save failed! Trying...") << endl;
 341
 342         // 3) In "/tmp" directory.
 343         // MakeAbsPath to prepend the current
 344         // drive letter on OS/2
 345         s = AddName(MakeAbsPath("/tmp/"), buf->fileName());
 346         s += ".emergency";
 347         lyxerr << " " << s << endl;
 348         if (buf->writeFile(s)) {
 349                 buf->markClean();
 350                 lyxerr << _("  Save seems successful. Phew.") << endl;
 351                 return;
 352         }
 353         lyxerr << _("  Save failed! Bummer. Document is lost.") << endl;
 354 }
 355
 356
 357
 358 Buffer * BufferList::readFile(string const & s, bool ronly)
 359 {
 360         string ts(s);
 361         string e = OnlyPath(s);
 362         string a = e;
 363         // File information about normal file
 364         FileInfo fileInfo2(s);
 365
 366         if (!fileInfo2.exist()) {
 367                 Alert::alert(_("Error!"), _("Cannot open file"),
 368                         MakeDisplayPath(s));
 369                 return 0;
 370         }
 371
 372         Buffer * b = bstore.newBuffer(s, ronly);
 373
 374         // Check if emergency save file exists and is newer.
 375         e += OnlyFilename(s) + ".emergency";
 376         FileInfo fileInfoE(e);
 377
 378         bool use_emergency = false;
 379
 380         if (fileInfoE.exist() && fileInfo2.exist()) {
 381                 if (fileInfoE.getModificationTime()
 382                     > fileInfo2.getModificationTime()) {
 383                         if (Alert::askQuestion(_("An emergency save of this document exists!"),
 384                                         MakeDisplayPath(s, 50),
 385                                         _("Try to load that instead?"))) {
 386                                 ts = e;
 387                                 // the file is not saved if we load the
 388                                 // emergency file.
 389                                 b->markDirty();
 390                                 use_emergency = true;
 391                         } else {
 392                                 // Here, we should delete the emergency save
 393                                 lyx::unlink(e);
 394                         }
 395                 }
 396         }
 397
 398         if (!use_emergency) {
 399                 // Now check if autosave file is newer.
 400                 a += '#';
 401                 a += OnlyFilename(s);
 402                 a += '#';
 403                 FileInfo fileInfoA(a);
 404                 if (fileInfoA.exist() && fileInfo2.exist()) {
 405                         if (fileInfoA.getModificationTime()
 406                             > fileInfo2.getModificationTime()) {
 407                                 if (Alert::askQuestion(_("Autosave file is newer."),
 408                                                 MakeDisplayPath(s, 50),
 409                                                 _("Load that one instead?"))) {
 410                                         ts = a;
 411                                         // the file is not saved if we load the
 412                                         // autosave file.
 413                                         b->markDirty();
 414                                 } else {
 415                                         // Here, we should delete the autosave
 416                                         lyx::unlink(a);
 417                                 }
 418                         }
 419                 }
 420         }
 421         // not sure if this is the correct place to begin LyXLex
 422         LyXLex lex(0, 0);
 423         lex.setFile(ts);
 424         if (b->readFile(lex))
 425                 return b;
 426         else {
 427                 bstore.release(b);
 428                 return 0;
 429         }
 430 }
 431
 432
 433 bool BufferList::exists(string const & s) const
 434 {
 435         return find_if(bstore.begin(), bstore.end(),
 436                        lyx::compare_memfun(&Buffer::fileName, s))
 437                 != bstore.end();
 438 }
 439
 440
 441 bool BufferList::isLoaded(Buffer const * b) const
 442 {
 443         lyx::Assert(b);
 444
 445         BufferStorage::const_iterator cit =
 446                 find(bstore.begin(), bstore.end(), b);
 447         return cit != bstore.end();
 448 }
 449
 450
 451 Buffer * BufferList::getBuffer(string const & s)
 452 {
 453         BufferStorage::iterator it =
 454                 find_if(bstore.begin(), bstore.end(),
 455                         lyx::compare_memfun(&Buffer::fileName, s));
 456         return it != bstore.end() ? (*it) : 0;
 457 }
 458
 459
 460 Buffer * BufferList::newFile(string const & name, string tname, bool isNamed)
 461 {
 462         // get a free buffer
 463         Buffer * b = bstore.newBuffer(name);
 464
 465         // use defaults.lyx as a default template if it exists.
 466         if (tname.empty()) {
 467                 tname = LibFileSearch("templates", "defaults.lyx");
 468         }
 469         if (!tname.empty()) {
 470                 bool templateok = false;
 471                 LyXLex lex(0, 0);
 472                 lex.setFile(tname);
 473                 if (lex.isOK()) {
 474                         if (b->readFile(lex)) {
 475                                 templateok = true;
 476                         }
 477                 }
 478                 if (!templateok) {
 479                         Alert::alert(_("Error!"), _("Unable to open template"),
 480                                    MakeDisplayPath(tname));
 481                         // no template, start with empty buffer
 482                         b->paragraphs.set(new Paragraph);
 483                         b->paragraphs.begin()->layout(b->params.getLyXTextClass().defaultLayout());
 484                 }
 485         } else {  // start with empty buffer
 486                 b->paragraphs.set(new Paragraph);
 487                 b->paragraphs.begin()->layout(b->params.getLyXTextClass().defaultLayout());
 488         }
 489
 490         if (!isNamed) {
 491                 b->setUnnamed();
 492                 b->setFileName(name);
 493         }
 494
 495         b->setReadonly(false);
 496
 497         return b;
 498 }
 499
 500
 501 Buffer * BufferList::loadLyXFile(string const & filename, bool tolastfiles)
 502 {
 503         // get absolute path of file and add ".lyx" to the filename if
 504         // necessary
 505         string s = FileSearch(string(), filename, "lyx");
 506         if (s.empty()) {
 507                 s = filename;
 508         }
 509
 510         // file already open?
 511         if (exists(s)) {
 512                 if (Alert::askQuestion(_("Document is already open:"),
 513                                 MakeDisplayPath(s, 50),
 514                                 _("Do you want to reload that document?"))) {
 515                         // Reload is accomplished by closing and then loading
 516                         if (!close(getBuffer(s))) {
 517                                 return 0;
 518                         }
 519                         // Fall through to new load. (Asger)
 520                 } else {
 521                         // Here, we pretend that we just loaded the
 522                         // open document
 523                         return getBuffer(s);
 524                 }
 525         }
 526         Buffer * b = 0;
 527         bool ro = false;
 528         switch (IsFileWriteable(s)) {
 529         case 0:
 530                 ro = true;
 531                 // Fall through
 532         case 1:
 533                 b = readFile(s, ro);
 534                 if (b) {
 535                         b->lyxvc.file_found_hook(s);
 536                 }
 537                 break; //fine- it's r/w
 538         case -1:
 539                 // Here we probably should run
 540                 if (LyXVC::file_not_found_hook(s)) {
 541                         // Ask if the file should be checked out for
 542                         // viewing/editing, if so: load it.
 543                         if (Alert::askQuestion(_("Do you want to retrieve file under version control?"))) {
 544                                 // How can we know _how_ to do the checkout?
 545                                 // With the current VC support it has to be,
 546                                 // a RCS file since CVS do not have special ,v files.
 547                                 RCS::retrieve(s);
 548                                 return loadLyXFile(filename, tolastfiles);
 549                         }
 550                 }
 551                 if (Alert::askQuestion(_("Cannot open specified file:"),
 552                                 MakeDisplayPath(s, 50),
 553                                 _("Create new document with this name?")))
 554                         {
 555                                 // Find a free buffer
 556                                 b = newFile(s, string(), true);
 557                         }
 558                 break;
 559         }
 560
 561         if (b && tolastfiles)
 562                 lastfiles->newFile(b->fileName());
 563
 564         return b;
 565 }