src/lyx_cb.C

   1 /* This file is part of
   2  * ======================================================
   3  *
   4  *           LyX, The Document Processor
   5  *
   6  *          Copyright 1995 Matthias Ettrich,
   7  *          Copyright 1995-2001 The LyX Team.
   8  *
   9  * ====================================================== */
  10
  11 #include <config.h>
  12
  13 #include "lyx_cb.h"
  14 #include "lyx_main.h"
  15 #include "buffer.h"
  16 #include "bufferlist.h"
  17 #include "bufferview_funcs.h"
  18 #include "debug.h"
  19 #include "lastfiles.h"
  20 #include "lyxrc.h"
  21 #include "lyxtext.h"
  22 #include "gettext.h"
  23 #include "BufferView.h"
  24
  25 #include "insets/insetlabel.h"
  26
  27 #include "frontends/lyx_gui.h"
  28 #include "frontends/LyXView.h"
  29 #include "frontends/Alert.h"
  30 #include "frontends/FileDialog.h"
  31
  32 #include "support/FileInfo.h"
  33 #include "support/filetools.h"
  34 #include "support/forkedcall.h"
  35 #include "support/path.h"
  36 #include "support/systemcall.h"
  37 #include "support/lstrings.h"
  38
  39 #include "BoostFormat.h"
  40
  41 #include <fstream>
  42 #include <algorithm>
  43 #include <utility>
  44
  45 using std::vector;
  46 using std::ifstream;
  47 using std::copy;
  48 using std::endl;
  49 using std::ios;
  50 using std::back_inserter;
  51 using std::istream_iterator;
  52 using std::pair;
  53 using std::make_pair;
  54
  55 extern BufferList bufferlist;
  56 // this should be static, but I need it in buffer.C
  57 bool quitting;  // flag, that we are quitting the program
  58
  59
  60 void ShowMessage(Buffer const * buf,
  61                  string const & msg1,
  62                  string const & msg2,
  63                  string const & msg3)
  64 {
  65         if (lyxrc.use_gui
  66             && buf && buf->getUser() && buf->getUser()->owner()) {
  67                         string const str = msg1 + ' ' + msg2 + ' ' + msg3;
  68                         buf->getUser()->owner()->message(str);
  69         } else
  70                 lyxerr << msg1 << msg2 << msg3 << endl;
  71 }
  72
  73
  74 //
  75 // Menu callbacks
  76 //
  77
  78 bool MenuWrite(BufferView * bv, Buffer * buffer)
  79 {
  80         if (buffer->save()) {
  81                 lastfiles->newFile(buffer->fileName());
  82                 return true;
  83         }
  84
  85         // FIXME: we don't tell the user *WHY* the save failed !!
  86
  87         string const file = MakeDisplayPath(buffer->fileName(), 30);
  88
  89 #if USE_BOOST_FORMAT
  90         boost::format fmt(_("The document %1$s could not be saved.\n\nDo you want to rename the document and try again?"));
  91         fmt % file;
  92         string text = fmt.str();
  93 #else
  94         string text = _("The document ");
  95         text += file + _(" could not be saved.\n\nDo you want to rename the document and try again?");
  96 #endif
  97         int const ret = Alert::prompt(_("Rename and save?"),
  98                 text, 0, _("&Rename"), _("&Cancel"));
  99
 100         if (ret == 0)
 101                 return WriteAs(bv, buffer);
 102         return false;
 103 }
 104
 105
 106
 107 bool WriteAs(BufferView * bv, Buffer * buffer, string const & filename)
 108 {
 109         string fname = buffer->fileName();
 110         string const oldname = fname;
 111
 112         if (filename.empty()) {
 113
 114                 FileDialog fileDlg(_("Choose a filename to save document as"),
 115                         LFUN_WRITEAS,
 116                         make_pair(string(_("Documents|#o#O")),
 117                                   string(lyxrc.document_path)),
 118                         make_pair(string(_("Templates|#T#t")),
 119                                   string(lyxrc.template_path)));
 120
 121                 if (!IsLyXFilename(fname))
 122                         fname += ".lyx";
 123
 124                 FileDialog::Result result =
 125                         fileDlg.save(OnlyPath(fname),
 126                                        _("*.lyx| LyX Documents (*.lyx)"),
 127                                        OnlyFilename(fname));
 128
 129                 if (result.first == FileDialog::Later)
 130                         return false;
 131
 132                 fname = result.second;
 133
 134                 if (fname.empty())
 135                         return false;
 136
 137                 // Make sure the absolute filename ends with appropriate suffix
 138                 fname = MakeAbsPath(fname);
 139                 if (!IsLyXFilename(fname))
 140                         fname += ".lyx";
 141         } else
 142                 fname = filename;
 143
 144         FileInfo const myfile(fname);
 145         if (myfile.isOK()) {
 146                 string const file = MakeDisplayPath(fname, 30);
 147
 148 #if USE_BOOST_FORMAT
 149                 boost::format fmt(_("The document %1$s already exists.\n\nDo you want to over-write that document?"));
 150                 fmt % file;
 151                 string text = fmt.str();
 152 #else
 153                 string text = _("The document ");
 154                 text += file + _(" already exists.\n\nDo you want to over-write that document?");
 155 #endif
 156                 int const ret = Alert::prompt(_("Over-write document?"),
 157                         text, 1, _("&Over-write"), _("&Cancel"));
 158
 159                 if (ret == 1)
 160                         return false;
 161         }
 162
 163         // Ok, change the name of the buffer
 164         buffer->setFileName(fname);
 165         buffer->markDirty();
 166         bool unnamed = buffer->isUnnamed();
 167         buffer->setUnnamed(false);
 168
 169         if (!MenuWrite(bv, buffer)) {
 170                 buffer->setFileName(oldname);
 171                 buffer->setUnnamed(unnamed);
 172                 return false;
 173         }
 174
 175         removeAutosaveFile(oldname);
 176         return true;
 177 }
 178
 179
 180 int MenuRunChktex(Buffer * buffer)
 181 {
 182         int ret;
 183
 184         if (buffer->isSGML()) {
 185                 Alert::alert(_("Chktex does not work with SGML derived documents."));
 186                 return 0;
 187         } else
 188                 ret = buffer->runChktex();
 189
 190         if (ret >= 0) {
 191                 string s;
 192                 string t;
 193                 if (ret == 0) {
 194                         s = _("No warnings found.");
 195                 } else if (ret == 1) {
 196                         s = _("One warning found.");
 197                         t = _("Use `Navigate->Error' to find it.");
 198                 } else {
 199                         s += tostr(ret);
 200                         s += _(" warnings found.");
 201                         t = _("Use `Navigate->Error' to find them.");
 202                 }
 203                 Alert::alert(_("Chktex run successfully"), s, t);
 204         } else {
 205                 Alert::alert(_("Error!"), _("It seems chktex does not work."));
 206         }
 207         return ret;
 208 }
 209
 210
 211 void QuitLyX()
 212 {
 213         lyxerr[Debug::INFO] << "Running QuitLyX." << endl;
 214
 215         if (lyxrc.use_gui) {
 216                 if (!bufferlist.quitWriteAll())
 217                         return;
 218
 219                 lastfiles->writeFile(lyxrc.lastfiles);
 220         }
 221
 222         // Set a flag that we do quitting from the program,
 223         // so no refreshes are necessary.
 224         quitting = true;
 225
 226         // close buffers first
 227         bufferlist.closeAll();
 228
 229         // do any other cleanup procedures now
 230         lyxerr[Debug::INFO] << "Deleting tmp dir " << system_tempdir << endl;
 231
 232         if (destroyDir(system_tempdir) != 0) {
 233 #if USE_BOOST_FORMAT
 234                 boost::format fmt = _("Could not remove the temporary directory %1$s");
 235                 fmt % system_tempdir;
 236                 string msg = fmt.str();
 237 #else
 238                 string msg = _("Could not remove the temporary directory ") + system_tempdir;
 239 #endif
 240                 Alert::warning(_("Could not remove temporary directory"), msg);
 241         }
 242
 243         lyx_gui::exit();
 244 }
 245
 246
 247 namespace {
 248
 249 class AutoSaveBuffer : public ForkedProcess {
 250 public:
 251         ///
 252         AutoSaveBuffer(BufferView & bv, string const & fname)
 253                 : bv_(bv), fname_(fname) {}
 254         ///
 255         virtual ForkedProcess * clone() const {
 256                 return new AutoSaveBuffer(*this);
 257         }
 258         ///
 259         int start();
 260 private:
 261         ///
 262         virtual int generateChild();
 263         ///
 264         BufferView & bv_;
 265         string fname_;
 266 };
 267
 268
 269 int AutoSaveBuffer::start()
 270 {
 271 #if USE_BOOST_FORMAT
 272         command_ = boost::io::str(boost::format(_("Auto-saving %1$s")) % fname_);
 273 #else
 274         command_ = _("Auto-saving ") + fname_;
 275 #endif
 276         return runNonBlocking();
 277 }
 278
 279
 280 int AutoSaveBuffer::generateChild()
 281 {
 282         // tmp_ret will be located (usually) in /tmp
 283         // will that be a problem?
 284         pid_t const pid = fork(); // If you want to debug the autosave
 285         // you should set pid to -1, and comment out the
 286         // fork.
 287         if (pid == 0 || pid == -1) {
 288                 // pid = -1 signifies that lyx was unable
 289                 // to fork. But we will do the save
 290                 // anyway.
 291                 bool failed = false;
 292
 293                 string const tmp_ret = lyx::tempName(string(), "lyxauto");
 294                 if (!tmp_ret.empty()) {
 295                         bv_.buffer()->writeFile(tmp_ret);
 296                         // assume successful write of tmp_ret
 297                         if (!lyx::rename(tmp_ret, fname_)) {
 298                                 failed = true;
 299                                 // most likely couldn't move between filesystems
 300                                 // unless write of tmp_ret failed
 301                                 // so remove tmp file (if it exists)
 302                                 lyx::unlink(tmp_ret);
 303                         }
 304                 } else {
 305                         failed = true;
 306                 }
 307
 308                 if (failed) {
 309                         // failed to write/rename tmp_ret so try writing direct
 310                         if (!bv_.buffer()->writeFile(fname_)) {
 311                                 // It is dangerous to do this in the child,
 312                                 // but safe in the parent, so...
 313                                 if (pid == -1)
 314                                         bv_.owner()->message(_("Autosave failed!"));
 315                         }
 316                 }
 317                 if (pid == 0) { // we are the child so...
 318                         _exit(0);
 319                 }
 320         }
 321         return pid;
 322 }
 323
 324 } // namespace anon
 325
 326
 327 void AutoSave(BufferView * bv)
 328         // should probably be moved into BufferList (Lgb)
 329         // Perfect target for a thread...
 330 {
 331         if (!bv->available())
 332                 return;
 333
 334         if (bv->buffer()->isBakClean() || bv->buffer()->isReadonly()) {
 335                 // We don't save now, but we'll try again later
 336                 bv->owner()->resetAutosaveTimer();
 337                 return;
 338         }
 339
 340         bv->owner()->message(_("Autosaving current document..."));
 341
 342         // create autosave filename
 343         string fname = bv->buffer()->filePath();
 344         fname += '#';
 345         fname += OnlyFilename(bv->buffer()->fileName());
 346         fname += '#';
 347
 348         AutoSaveBuffer autosave(*bv, fname);
 349         autosave.start();
 350
 351         bv->buffer()->markBakClean();
 352         bv->owner()->resetAutosaveTimer();
 353 }
 354
 355
 356 //
 357 // Copyright CHT Software Service GmbH
 358 // Uwe C. Schroeder
 359 //
 360 // create new file with template
 361 // SERVERCMD !
 362 //
 363 Buffer * NewFile(string const & filename)
 364 {
 365         // Split argument by :
 366         string name;
 367         string tmpname = split(filename, name, ':');
 368 #ifdef __EMX__ // Fix me! lyx_cb.C may not be low level enough to allow this.
 369         if (name.length() == 1
 370             && isalpha(static_cast<unsigned char>(name[0]))
 371             && (prefixIs(tmpname, "/") || prefixIs(tmpname, "\\"))) {
 372                 name += ':';
 373                 name += token(tmpname, ':', 0);
 374                 tmpname = split(tmpname, ':');
 375         }
 376 #endif
 377         lyxerr[Debug::INFO] << "Arg is " << filename
 378                             << "\nName is " << name
 379                             << "\nTemplate is " << tmpname << endl;
 380
 381         // find a free buffer
 382         Buffer * tmpbuf = bufferlist.newFile(name, tmpname);
 383         if (tmpbuf)
 384                 lastfiles->newFile(tmpbuf->fileName());
 385         return tmpbuf;
 386 }
 387
 388
 389 // Insert ascii file (if filename is empty, prompt for one)
 390 void InsertAsciiFile(BufferView * bv, string const & f, bool asParagraph)
 391 {
 392         if (!bv->available())
 393                 return;
 394
 395         string const tmpstr = getContentsOfAsciiFile(bv, f, asParagraph);
 396         if (tmpstr.empty())
 397                 return;
 398
 399         // insert the string
 400         bv->hideCursor();
 401
 402         // clear the selection
 403         bool flag = (bv->text == bv->getLyXText());
 404         if (flag)
 405                 bv->beforeChange(bv->text);
 406         if (!asParagraph)
 407                 bv->getLyXText()->insertStringAsLines(tmpstr);
 408         else
 409                 bv->getLyXText()->insertStringAsParagraphs(tmpstr);
 410         if (flag)
 411                 bv->update(BufferView::SELECT);
 412 }
 413
 414
 415 // Insert ascii file (if filename is empty, prompt for one)
 416 string getContentsOfAsciiFile(BufferView * bv, string const & f, bool asParagraph)
 417 {
 418         string fname = f;
 419
 420         if (fname.empty()) {
 421                 FileDialog fileDlg(_("Select file to insert"),
 422                         (asParagraph) ? LFUN_FILE_INSERT_ASCII_PARA : LFUN_FILE_INSERT_ASCII);
 423
 424                 FileDialog::Result result = fileDlg.open(bv->owner()->buffer()->filePath());
 425
 426                 if (result.first == FileDialog::Later)
 427                         return string();
 428
 429                 fname = result.second;
 430
 431                 if (fname.empty())
 432                         return string();
 433         }
 434
 435         FileInfo fi(fname);
 436
 437         if (!fi.readable()) {
 438                 string const error = strerror(errno);
 439                 string const file = MakeDisplayPath(fname, 50);
 440 #if USE_BOOST_FORMAT
 441                 boost::format fmt(_("Could not read the specified document\n%1$s\ndue to the error: %2$s"));
 442                 fmt % file;
 443                 fmt % error;
 444                 string text = fmt.str();
 445 #else
 446                 string text = _("Could not read the specified document\n");
 447                 text += file + _(" due to the error: ");
 448                 text += error;
 449 #endif
 450                 Alert::error(_("Could not read file"), text);
 451                 return string();
 452         }
 453
 454         ifstream ifs(fname.c_str());
 455         if (!ifs) {
 456                 string const error = strerror(errno);
 457                 string const file = MakeDisplayPath(fname, 50);
 458 #if USE_BOOST_FORMAT
 459                 boost::format fmt(_("Could not open the specified document\n%1$s\ndue to the error: %2$s"));
 460                 fmt % file;
 461                 fmt % error;
 462                 string text = fmt.str();
 463 #else
 464                 string text = _("Could not open the specified document\n");
 465                 text += file + _(" due to the error: ");
 466                 text += error;
 467 #endif
 468                 Alert::error(_("Could not open file"), text);
 469                 return string();
 470         }
 471
 472         ifs.unsetf(ios::skipws);
 473         istream_iterator<char> ii(ifs);
 474         istream_iterator<char> end;
 475 #if !defined(USE_INCLUDED_STRING) && !defined(STD_STRING_IS_GOOD)
 476         // We use this until the compilers get better...
 477         vector<char> tmp;
 478         copy(ii, end, back_inserter(tmp));
 479         string const tmpstr(tmp.begin(), tmp.end());
 480 #else
 481         // This is what we want to use and what we will use once the
 482         // compilers get good enough.
 483         //string tmpstr(ii, end); // yet a reason for using std::string
 484         // alternate approach to get the file into a string:
 485         string tmpstr;
 486         copy(ii, end, back_inserter(tmpstr));
 487 #endif
 488
 489         return tmpstr;
 490 }
 491
 492
 493 string const getPossibleLabel(BufferView const & bv)
 494 {
 495         Paragraph * par = bv.getLyXText()->cursor.par();
 496         LyXLayout_ptr layout = par->layout();
 497         if (layout->latextype == LATEX_PARAGRAPH && par->previous()) {
 498                 Paragraph * par2 = par->previous();
 499
 500                 LyXLayout_ptr const & layout2 = par2->layout();
 501
 502                 if (layout2->latextype != LATEX_PARAGRAPH) {
 503                         par = par2;
 504                         layout = layout2;
 505                 }
 506         }
 507
 508         string text = layout->latexname().substr(0, 3);
 509         if (layout->latexname() == "theorem")
 510                 text = "thm"; // Create a correct prefix for prettyref
 511
 512         text += ':';
 513         if (layout->latextype == LATEX_PARAGRAPH ||
 514             lyxrc.label_init_length < 0)
 515                 text.erase();
 516
 517         string par_text = par->asString(bv.buffer(), false);
 518         for (int i = 0; i < lyxrc.label_init_length; ++i) {
 519                 if (par_text.empty())
 520                         break;
 521                 string head;
 522                 par_text = split(par_text, head, ' ');
 523                 if (i > 0)
 524                         text += '-'; // Is it legal to use spaces in
 525                 // labels ?
 526                 text += head;
 527         }
 528
 529         return text;
 530 }
 531
 532
 533 // This function runs "configure" and then rereads lyx.defaults to
 534 // reconfigure the automatic settings.
 535 void Reconfigure(BufferView * bv)
 536 {
 537         bv->owner()->message(_("Running configure..."));
 538
 539         // Run configure in user lyx directory
 540         Path p(user_lyxdir);
 541         Systemcall one;
 542         one.startscript(Systemcall::Wait,
 543                         AddName(system_lyxdir, "configure"));
 544         p.pop();
 545         bv->owner()->message(_("Reloading configuration..."));
 546         lyxrc.read(LibFileSearch(string(), "lyxrc.defaults"));
 547
 548         Alert::information(_("System reconfigured"),
 549                 _("The system has been reconfigured.\n"
 550                 "You need to restart LyX to make use of any \n"
 551                 "updated document class specifications."));
 552 }