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