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