src/LyX.cpp

   1 /**
   2  * \file LyX.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Alfredo Braunstein
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author John Levon
  10  * \author André Pönitz
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #include <config.h>
  16 #include <version.h>
  17
  18 #include "LyX.h"
  19
  20 #include "LayoutFile.h"
  21 #include "Buffer.h"
  22 #include "BufferList.h"
  23 #include "CmdDef.h"
  24 #include "Color.h"
  25 #include "ConverterCache.h"
  26 #include "Converter.h"
  27 #include "CutAndPaste.h"
  28 #include "Encoding.h"
  29 #include "ErrorList.h"
  30 #include "Format.h"
  31 #include "FuncStatus.h"
  32 #include "KeyMap.h"
  33 #include "Language.h"
  34 #include "Lexer.h"
  35 #include "LyXAction.h"
  36 #include "LyXFunc.h"
  37 #include "LyXRC.h"
  38 #include "ModuleList.h"
  39 #include "Mover.h"
  40 #include "Server.h"
  41 #include "ServerSocket.h"
  42 #include "Session.h"
  43
  44 #include "frontends/alert.h"
  45 #include "frontends/Application.h"
  46
  47 #include "support/lassert.h"
  48 #include "support/debug.h"
  49 #include "support/environment.h"
  50 #include "support/ExceptionMessage.h"
  51 #include "support/filetools.h"
  52 #include "support/gettext.h"
  53 #include "support/lstrings.h"
  54 #include "support/Messages.h"
  55 #include "support/os.h"
  56 #include "support/Package.h"
  57 #include "support/Path.h"
  58 #include "support/Systemcall.h"
  59
  60 #include <boost/bind.hpp>
  61 #include <boost/scoped_ptr.hpp>
  62
  63 #include <algorithm>
  64 #include <iostream>
  65 #include <csignal>
  66 #include <map>
  67 #include <stdlib.h>
  68 #include <string>
  69 #include <vector>
  70
  71 using namespace std;
  72 using namespace lyx::support;
  73
  74 namespace lyx {
  75
  76 namespace Alert = frontend::Alert;
  77 namespace os = support::os;
  78
  79
  80
  81 // Are we using the GUI at all?  We default to true and this is changed
  82 // to false when the export feature is used.
  83
  84 bool use_gui = true;
  85
  86 namespace {
  87
  88 // Filled with the command line arguments "foo" of "-sysdir foo" or
  89 // "-userdir foo".
  90 string cl_system_support;
  91 string cl_user_support;
  92
  93 string geometryArg;
  94
  95 LyX * singleton_ = 0;
  96
  97 void showFileError(string const & error)
  98 {
  99         Alert::warning(_("Could not read configuration file"),
 100                        bformat(_("Error while reading the configuration file\n%1$s.\n"
 101                            "Please check your installation."), from_utf8(error)));
 102 }
 103
 104
 105 void reconfigureUserLyXDir()
 106 {
 107         string const configure_command = package().configure_command();
 108
 109         lyxerr << to_utf8(_("LyX: reconfiguring user directory")) << endl;
 110         PathChanger p(package().user_support());
 111         Systemcall one;
 112         one.startscript(Systemcall::Wait, configure_command);
 113         lyxerr << "LyX: " << to_utf8(_("Done!")) << endl;
 114 }
 115
 116 } // namespace anon
 117
 118
 119 /// The main application class private implementation.
 120 struct LyX::Impl
 121 {
 122         Impl()
 123         {
 124                 // Set the default User Interface language as soon as possible.
 125                 // The language used will be derived from the environment
 126                 // variables.
 127                 messages_["GUI"] = Messages();
 128         }
 129         /// our function handler
 130         LyXFunc lyxfunc_;
 131         ///
 132         BufferList buffer_list_;
 133         ///
 134         KeyMap toplevel_keymap_;
 135         ///
 136         CmdDef toplevel_cmddef_;
 137         ///
 138         boost::scoped_ptr<Server> lyx_server_;
 139         ///
 140         boost::scoped_ptr<ServerSocket> lyx_socket_;
 141         ///
 142         boost::scoped_ptr<frontend::Application> application_;
 143         /// lyx session, containing lastfiles, lastfilepos, and lastopened
 144         boost::scoped_ptr<Session> session_;
 145
 146         /// Files to load at start.
 147         vector<string> files_to_load_;
 148
 149         /// The messages translators.
 150         map<string, Messages> messages_;
 151
 152         /// The file converters.
 153         Converters converters_;
 154
 155         // The system converters copy after reading lyxrc.defaults.
 156         Converters system_converters_;
 157
 158         ///
 159         Movers movers_;
 160         ///
 161         Movers system_movers_;
 162
 163         /// has this user started lyx for the first time?
 164         bool first_start;
 165         /// the parsed command line batch command if any
 166         vector<string> batch_commands;
 167 };
 168
 169 ///
 170 frontend::Application * theApp()
 171 {
 172         if (singleton_)
 173                 return singleton_->pimpl_->application_.get();
 174         else
 175                 return 0;
 176 }
 177
 178
 179 LyX::~LyX()
 180 {
 181         delete pimpl_;
 182 }
 183
 184
 185 void LyX::exit(int exit_code) const
 186 {
 187         if (exit_code)
 188                 // Something wrong happened so better save everything, just in
 189                 // case.
 190                 emergencyCleanup();
 191
 192 #ifndef NDEBUG
 193         // Properly crash in debug mode in order to get a useful backtrace.
 194         abort();
 195 #endif
 196
 197         // In release mode, try to exit gracefully.
 198         if (theApp())
 199                 theApp()->exit(exit_code);
 200         else
 201                 exit(exit_code);
 202 }
 203
 204
 205 LyX & LyX::ref()
 206 {
 207         LASSERT(singleton_, /**/);
 208         return *singleton_;
 209 }
 210
 211
 212 LyX const & LyX::cref()
 213 {
 214         LASSERT(singleton_, /**/);
 215         return *singleton_;
 216 }
 217
 218
 219 LyX::LyX()
 220         : first_start(false)
 221 {
 222         singleton_ = this;
 223         pimpl_ = new Impl;
 224 }
 225
 226
 227 BufferList & LyX::bufferList()
 228 {
 229         return pimpl_->buffer_list_;
 230 }
 231
 232
 233 BufferList const & LyX::bufferList() const
 234 {
 235         return pimpl_->buffer_list_;
 236 }
 237
 238
 239 Session & LyX::session()
 240 {
 241         LASSERT(pimpl_->session_.get(), /**/);
 242         return *pimpl_->session_.get();
 243 }
 244
 245
 246 Session const & LyX::session() const
 247 {
 248         LASSERT(pimpl_->session_.get(), /**/);
 249         return *pimpl_->session_.get();
 250 }
 251
 252
 253 LyXFunc & LyX::lyxFunc()
 254 {
 255         return pimpl_->lyxfunc_;
 256 }
 257
 258
 259 LyXFunc const & LyX::lyxFunc() const
 260 {
 261         return pimpl_->lyxfunc_;
 262 }
 263
 264
 265 Server & LyX::server()
 266 {
 267         LASSERT(pimpl_->lyx_server_.get(), /**/);
 268         return *pimpl_->lyx_server_.get();
 269 }
 270
 271
 272 Server const & LyX::server() const
 273 {
 274         LASSERT(pimpl_->lyx_server_.get(), /**/);
 275         return *pimpl_->lyx_server_.get();
 276 }
 277
 278
 279 ServerSocket & LyX::socket()
 280 {
 281         LASSERT(pimpl_->lyx_socket_.get(), /**/);
 282         return *pimpl_->lyx_socket_.get();
 283 }
 284
 285
 286 ServerSocket const & LyX::socket() const
 287 {
 288         LASSERT(pimpl_->lyx_socket_.get(), /**/);
 289         return *pimpl_->lyx_socket_.get();
 290 }
 291
 292
 293 frontend::Application & LyX::application()
 294 {
 295         LASSERT(pimpl_->application_.get(), /**/);
 296         return *pimpl_->application_.get();
 297 }
 298
 299
 300 frontend::Application const & LyX::application() const
 301 {
 302         LASSERT(pimpl_->application_.get(), /**/);
 303         return *pimpl_->application_.get();
 304 }
 305
 306
 307 CmdDef & LyX::topLevelCmdDef()
 308 {
 309         return pimpl_->toplevel_cmddef_;
 310 }
 311
 312
 313 Converters & LyX::converters()
 314 {
 315         return pimpl_->converters_;
 316 }
 317
 318
 319 Converters & LyX::systemConverters()
 320 {
 321         return pimpl_->system_converters_;
 322 }
 323
 324
 325 Messages & LyX::getMessages(string const & language)
 326 {
 327         map<string, Messages>::iterator it = pimpl_->messages_.find(language);
 328
 329         if (it != pimpl_->messages_.end())
 330                 return it->second;
 331
 332         pair<map<string, Messages>::iterator, bool> result =
 333                         pimpl_->messages_.insert(make_pair(language, Messages(language)));
 334
 335         LASSERT(result.second, /**/);
 336         return result.first->second;
 337 }
 338
 339
 340 Messages & LyX::getGuiMessages()
 341 {
 342         return pimpl_->messages_["GUI"];
 343 }
 344
 345
 346 void LyX::setGuiLanguage(string const & language)
 347 {
 348         pimpl_->messages_["GUI"] = Messages(language);
 349 }
 350
 351
 352 int LyX::exec(int & argc, char * argv[])
 353 {
 354         // Here we need to parse the command line. At least
 355         // we need to parse for "-dbg" and "-help"
 356         easyParse(argc, argv);
 357
 358         try {
 359                 init_package(to_utf8(from_local8bit(argv[0])),
 360                               cl_system_support, cl_user_support,
 361                               top_build_dir_is_one_level_up);
 362         } catch (ExceptionMessage const & message) {
 363                 if (message.type_ == ErrorException) {
 364                         Alert::error(message.title_, message.details_);
 365                         exit(1);
 366                 } else if (message.type_ == WarningException) {
 367                         Alert::warning(message.title_, message.details_);
 368                 }
 369         }
 370
 371         // Reinit the messages machinery in case package() knows
 372         // something interesting about the locale directory.
 373         Messages::init();
 374
 375         if (!use_gui) {
 376                 // FIXME: create a ConsoleApplication
 377                 int exit_status = init(argc, argv);
 378                 if (exit_status) {
 379                         prepareExit();
 380                         return exit_status;
 381                 }
 382
 383                 // this is correct, since return values are inverted.
 384                 exit_status = !loadFiles();
 385
 386                 if (pimpl_->batch_commands.empty() || pimpl_->buffer_list_.empty()) {
 387                         prepareExit();
 388                         return exit_status;
 389                 }
 390
 391                 BufferList::iterator begin = pimpl_->buffer_list_.begin();
 392
 393                 bool final_success = false;
 394                 for (BufferList::iterator I = begin; I != pimpl_->buffer_list_.end(); ++I) {
 395                         Buffer * buf = *I;
 396                         if (buf != buf->masterBuffer())
 397                                 continue;
 398                         bool success = false;
 399                         vector<string>::const_iterator bcit  = pimpl_->batch_commands.begin();
 400                         vector<string>::const_iterator bcend = pimpl_->batch_commands.end();
 401                         for (; bcit != bcend; bcit++) {
 402                                 buf->dispatch(*bcit, &success);
 403                                 final_success |= success;
 404                         }
 405                 }
 406                 prepareExit();
 407                 return !final_success;
 408         }
 409
 410         // Let the frontend parse and remove all arguments that it knows
 411         pimpl_->application_.reset(createApplication(argc, argv));
 412
 413         // Parse and remove all known arguments in the LyX singleton
 414         // Give an error for all remaining ones.
 415         int exit_status = init(argc, argv);
 416         if (exit_status) {
 417                 // Kill the application object before exiting.
 418                 pimpl_->application_.reset();
 419                 use_gui = false;
 420                 prepareExit();
 421                 return exit_status;
 422         }
 423
 424         // FIXME
 425         /* Create a CoreApplication class that will provide the main event loop
 426         * and the socket callback registering. With Qt4, only QtCore
 427         * library would be needed.
 428         * When this is done, a server_mode could be created and the following two
 429         * line would be moved out from here.
 430         */
 431         // Note: socket callback must be registered after init(argc, argv)
 432         // such that package().temp_dir() is properly initialized.
 433         pimpl_->lyx_server_.reset(new Server(&pimpl_->lyxfunc_, lyxrc.lyxpipes));
 434         pimpl_->lyx_socket_.reset(new ServerSocket(&pimpl_->lyxfunc_,
 435                         FileName(package().temp_dir().absFilename() + "/lyxsocket")));
 436
 437         // Start the real execution loop.
 438         exit_status = pimpl_->application_->exec();
 439
 440         prepareExit();
 441
 442         return exit_status;
 443 }
 444
 445
 446 void LyX::prepareExit()
 447 {
 448         // Clear the clipboard and selection stack:
 449         cap::clearCutStack();
 450         cap::clearSelection();
 451
 452         // close buffers first
 453         pimpl_->buffer_list_.closeAll();
 454
 455         // register session changes and shutdown server and socket
 456         if (use_gui) {
 457                 if (pimpl_->session_)
 458                         pimpl_->session_->writeFile();
 459                 pimpl_->session_.reset();
 460                 pimpl_->lyx_server_.reset();
 461                 pimpl_->lyx_socket_.reset();
 462         }
 463
 464         // do any other cleanup procedures now
 465         if (package().temp_dir() != package().system_temp_dir()) {
 466                 string const abs_tmpdir = package().temp_dir().absFilename();
 467                 if (!contains(package().temp_dir().absFilename(), "lyx_tmpdir")) {
 468                         docstring const msg =
 469                                 bformat(_("%1$s does not appear like a LyX created temporary directory."),
 470                                 from_utf8(abs_tmpdir));
 471                         Alert::warning(_("Cannot remove temporary directory"), msg);
 472                 } else {
 473                         LYXERR(Debug::INFO, "Deleting tmp dir "
 474                                 << package().temp_dir().absFilename());
 475                         if (!package().temp_dir().destroyDirectory()) {
 476                                 docstring const msg =
 477                                         bformat(_("Unable to remove the temporary directory %1$s"),
 478                                         from_utf8(package().temp_dir().absFilename()));
 479                                 Alert::warning(_("Unable to remove temporary directory"), msg);
 480                         }
 481                 }
 482         }
 483
 484         // Kill the application object before exiting. This avoids crashes
 485         // when exiting on Linux.
 486         if (pimpl_->application_)
 487                 pimpl_->application_.reset();
 488 }
 489
 490
 491 void LyX::earlyExit(int status)
 492 {
 493         LASSERT(pimpl_->application_.get(), /**/);
 494         // LyX::pimpl_::application_ is not initialised at this
 495         // point so it's safe to just exit after some cleanup.
 496         prepareExit();
 497         exit(status);
 498 }
 499
 500
 501 int LyX::init(int & argc, char * argv[])
 502 {
 503         // check for any spurious extra arguments
 504         // other than documents
 505         for (int argi = 1; argi < argc ; ++argi) {
 506                 if (argv[argi][0] == '-') {
 507                         lyxerr << to_utf8(
 508                                 bformat(_("Wrong command line option `%1$s'. Exiting."),
 509                                 from_utf8(argv[argi]))) << endl;
 510                         return EXIT_FAILURE;
 511                 }
 512         }
 513
 514         // Initialization of LyX (reads lyxrc and more)
 515         LYXERR(Debug::INIT, "Initializing LyX::init...");
 516         bool success = init();
 517         LYXERR(Debug::INIT, "Initializing LyX::init...done");
 518         if (!success)
 519                 return EXIT_FAILURE;
 520
 521         // Remaining arguments are assumed to be files to load.
 522         for (int argi = argc - 1; argi >= 1; --argi)
 523                 pimpl_->files_to_load_.push_back(to_utf8(from_local8bit(argv[argi])));
 524
 525         if (first_start) {
 526                 pimpl_->files_to_load_.push_back(
 527                         i18nLibFileSearch("examples", "splash.lyx").absFilename());
 528         }
 529
 530         return EXIT_SUCCESS;
 531 }
 532
 533
 534 bool LyX::loadFiles()
 535 {
 536         LASSERT(!use_gui, /**/);
 537         bool success = true;
 538         vector<string>::const_iterator it = pimpl_->files_to_load_.begin();
 539         vector<string>::const_iterator end = pimpl_->files_to_load_.end();
 540
 541         for (; it != end; ++it) {
 542                 // get absolute path of file and add ".lyx" to
 543                 // the filename if necessary
 544                 FileName fname = fileSearch(string(), os::internal_path(*it), "lyx",
 545                         may_not_exist);
 546
 547                 if (fname.empty())
 548                         continue;
 549
 550                 Buffer * buf = pimpl_->buffer_list_.newBuffer(fname.absFilename(), false);
 551                 if (buf->loadLyXFile(fname)) {
 552                         ErrorList const & el = buf->errorList("Parse");
 553                         if (!el.empty())
 554                                 for_each(el.begin(), el.end(),
 555                                 boost::bind(&LyX::printError, this, _1));
 556                 }
 557                 else {
 558                         pimpl_->buffer_list_.release(buf);
 559                         success = false;
 560                 }
 561         }
 562         return success;
 563 }
 564
 565
 566 void LyX::execBatchCommands()
 567 {
 568         // The advantage of doing this here is that the event loop
 569         // is already started. So any need for interaction will be
 570         // aknowledged.
 571
 572         // if reconfiguration is needed.
 573         while (LayoutFileList::get().empty()) {
 574                 switch (Alert::prompt(
 575                         _("No textclass is found"),
 576                         _("LyX cannot continue because no textclass is found. "
 577                                 "You can either reconfigure normally, or reconfigure using "
 578                                 "default textclasses, or quit LyX."),
 579                         0, 2,
 580                         _("&Reconfigure"),
 581                         _("&Use Default"),
 582                         _("&Exit LyX")))
 583                 {
 584                 case 0:
 585                         // regular reconfigure
 586                         pimpl_->lyxfunc_.dispatch(FuncRequest(LFUN_RECONFIGURE, ""));
 587                         break;
 588                 case 1:
 589                         // reconfigure --without-latex-config
 590                         pimpl_->lyxfunc_.dispatch(FuncRequest(LFUN_RECONFIGURE,
 591                                 " --without-latex-config"));
 592                         break;
 593                 default:
 594                         pimpl_->lyxfunc_.dispatch(FuncRequest(LFUN_LYX_QUIT));
 595                         return;
 596                 }
 597         }
 598
 599         // create the first main window
 600         pimpl_->lyxfunc_.dispatch(FuncRequest(LFUN_WINDOW_NEW, geometryArg));
 601
 602         if (!pimpl_->files_to_load_.empty()) {
 603                 // if some files were specified at command-line we assume that the
 604                 // user wants to edit *these* files and not to restore the session.
 605                 for (size_t i = 0; i != pimpl_->files_to_load_.size(); ++i) {
 606                         pimpl_->lyxfunc_.dispatch(
 607                                 FuncRequest(LFUN_FILE_OPEN, pimpl_->files_to_load_[i]));
 608                 }
 609                 // clear this list to save a few bytes of RAM
 610                 pimpl_->files_to_load_.clear();
 611         }
 612         else
 613                 pimpl_->application_->restoreGuiSession();
 614
 615         // Execute batch commands if available
 616         if (pimpl_->batch_commands.empty())
 617                 return;
 618
 619         vector<string>::const_iterator bcit  = pimpl_->batch_commands.begin();
 620         vector<string>::const_iterator bcend = pimpl_->batch_commands.end();
 621         for (; bcit != bcend; bcit++) {
 622                 LYXERR(Debug::INIT, "About to handle -x '" << *bcit << '\'');
 623                 pimpl_->lyxfunc_.dispatch(lyxaction.lookupFunc(*bcit));
 624         }
 625 }
 626
 627
 628 /*
 629 Signals and Windows
 630 ===================
 631 The SIGHUP signal does not exist on Windows and does not need to be handled.
 632
 633 Windows handles SIGFPE and SIGSEGV signals as expected.
 634
 635 Cntl+C interrupts (mapped to SIGINT by Windows' POSIX compatability layer)
 636 cause a new thread to be spawned. This may well result in unexpected
 637 behaviour by the single-threaded LyX.
 638
 639 SIGTERM signals will come only from another process actually sending
 640 that signal using 'raise' in Windows' POSIX compatability layer. It will
 641 not come from the general "terminate process" methods that everyone
 642 actually uses (and which can't be trapped). Killing an app 'politely' on
 643 Windows involves first sending a WM_CLOSE message, something that is
 644 caught already by the Qt frontend.
 645
 646 For more information see:
 647
 648 http://aspn.activestate.com/ASPN/Mail/Message/ActiveTcl/2034055
 649 ...signals are mostly useless on Windows for a variety of reasons that are
 650 Windows specific...
 651
 652 'UNIX Application Migration Guide, Chapter 9'
 653 http://msdn.microsoft.com/library/en-us/dnucmg/html/UCMGch09.asp
 654
 655 'How To Terminate an Application "Cleanly" in Win32'
 656 http://support.microsoft.com/default.aspx?scid=kb;en-us;178893
 657 */
 658 extern "C" {
 659
 660 static void error_handler(int err_sig)
 661 {
 662         // Throw away any signals other than the first one received.
 663         static sig_atomic_t handling_error = false;
 664         if (handling_error)
 665                 return;
 666         handling_error = true;
 667
 668         // We have received a signal indicating a fatal error, so
 669         // try and save the data ASAP.
 670         LyX::cref().emergencyCleanup();
 671
 672         // These lyxerr calls may or may not work:
 673
 674         // Signals are asynchronous, so the main program may be in a very
 675         // fragile state when a signal is processed and thus while a signal
 676         // handler function executes.
 677         // In general, therefore, we should avoid performing any
 678         // I/O operations or calling most library and system functions from
 679         // signal handlers.
 680
 681         // This shouldn't matter here, however, as we've already invoked
 682         // emergencyCleanup.
 683         switch (err_sig) {
 684 #ifdef SIGHUP
 685         case SIGHUP:
 686                 lyxerr << "\nlyx: SIGHUP signal caught\nBye." << endl;
 687                 break;
 688 #endif
 689         case SIGFPE:
 690                 lyxerr << "\nlyx: SIGFPE signal caught\nBye." << endl;
 691                 break;
 692         case SIGSEGV:
 693                 lyxerr << "\nlyx: SIGSEGV signal caught\n"
 694                           "Sorry, you have found a bug in LyX. "
 695                           "Please read the bug-reporting instructions "
 696                           "in Help->Introduction and send us a bug report, "
 697                           "if necessary. Thanks !\nBye." << endl;
 698                 break;
 699         case SIGINT:
 700         case SIGTERM:
 701                 // no comments
 702                 break;
 703         }
 704
 705         // Deinstall the signal handlers
 706 #ifdef SIGHUP
 707         signal(SIGHUP, SIG_DFL);
 708 #endif
 709         signal(SIGINT, SIG_DFL);
 710         signal(SIGFPE, SIG_DFL);
 711         signal(SIGSEGV, SIG_DFL);
 712         signal(SIGTERM, SIG_DFL);
 713
 714 #ifdef SIGHUP
 715         if (err_sig == SIGSEGV ||
 716             (err_sig != SIGHUP && !getEnv("LYXDEBUG").empty()))
 717 #else
 718         if (err_sig == SIGSEGV || !getEnv("LYXDEBUG").empty())
 719 #endif
 720                 abort();
 721         exit(0);
 722 }
 723
 724 }
 725
 726
 727 void LyX::printError(ErrorItem const & ei)
 728 {
 729         docstring tmp = _("LyX: ") + ei.error + char_type(':')
 730                 + ei.description;
 731         cerr << to_utf8(tmp) << endl;
 732 }
 733
 734
 735 bool LyX::init()
 736 {
 737 #ifdef SIGHUP
 738         signal(SIGHUP, error_handler);
 739 #endif
 740         signal(SIGFPE, error_handler);
 741         signal(SIGSEGV, error_handler);
 742         signal(SIGINT, error_handler);
 743         signal(SIGTERM, error_handler);
 744         // SIGPIPE can be safely ignored.
 745
 746         lyxrc.tempdir_path = package().temp_dir().absFilename();
 747         lyxrc.document_path = package().document_dir().absFilename();
 748
 749         if (lyxrc.example_path.empty()) {
 750                 lyxrc.example_path = addPath(package().system_support().absFilename(),
 751                                               "examples");
 752         }
 753         if (lyxrc.template_path.empty()) {
 754                 lyxrc.template_path = addPath(package().system_support().absFilename(),
 755                                               "templates");
 756         }
 757
 758         //
 759         // Read configuration files
 760         //
 761
 762         // This one may have been distributed along with LyX.
 763         if (!readRcFile("lyxrc.dist"))
 764                 return false;
 765
 766         // Set the language defined by the distributor.
 767         //setGuiLanguage(lyxrc.gui_language);
 768
 769         // Set the PATH correctly.
 770 #if !defined (USE_POSIX_PACKAGING)
 771         // Add the directory containing the LyX executable to the path
 772         // so that LyX can find things like tex2lyx.
 773         if (package().build_support().empty())
 774                 prependEnvPath("PATH", package().binary_dir().absFilename());
 775 #endif
 776         if (!lyxrc.path_prefix.empty())
 777                 prependEnvPath("PATH", lyxrc.path_prefix);
 778
 779         // Check that user LyX directory is ok.
 780         if (queryUserLyXDir(package().explicit_user_support()))
 781                 reconfigureUserLyXDir();
 782
 783         // no need for a splash when there is no GUI
 784         if (!use_gui) {
 785                 first_start = false;
 786         }
 787
 788         // This one is generated in user_support directory by lib/configure.py.
 789         if (!readRcFile("lyxrc.defaults"))
 790                 return false;
 791
 792         // Query the OS to know what formats are viewed natively
 793         formats.setAutoOpen();
 794
 795         // Read lyxrc.dist again to be able to override viewer auto-detection.
 796         readRcFile("lyxrc.dist");
 797
 798         system_lyxrc = lyxrc;
 799         system_formats = formats;
 800         pimpl_->system_converters_ = pimpl_->converters_;
 801         pimpl_->system_movers_ = pimpl_->movers_;
 802         system_lcolor = lcolor;
 803
 804         // This one is edited through the preferences dialog.
 805         if (!readRcFile("preferences"))
 806                 return false;
 807
 808         if (!readEncodingsFile("encodings", "unicodesymbols"))
 809                 return false;
 810         if (!readLanguagesFile("languages"))
 811                 return false;
 812
 813         // Load the layouts
 814         LYXERR(Debug::INIT, "Reading layouts...");
 815         if (!LyXSetStyle())
 816                 return false;
 817         //...and the modules
 818         moduleList.load();
 819
 820         // read keymap and ui files in batch mode as well
 821         // because InsetInfo needs to know these to produce
 822         // the correct output
 823
 824         // Set the language defined by the user.
 825         //setGuiLanguage(lyxrc.gui_language);
 826
 827         // Set up command definitions
 828         pimpl_->toplevel_cmddef_.read(lyxrc.def_file);
 829
 830         // Set up bindings
 831         pimpl_->toplevel_keymap_.read("site");
 832         pimpl_->toplevel_keymap_.read(lyxrc.bind_file);
 833         // load user bind file user.bind
 834         pimpl_->toplevel_keymap_.read("user");
 835
 836         pimpl_->lyxfunc_.initKeySequences(&pimpl_->toplevel_keymap_);
 837
 838         if (lyxerr.debugging(Debug::LYXRC))
 839                 lyxrc.print();
 840
 841         os::windows_style_tex_paths(lyxrc.windows_style_tex_paths);
 842         if (!lyxrc.path_prefix.empty())
 843                 prependEnvPath("PATH", lyxrc.path_prefix);
 844
 845         FileName const document_path(lyxrc.document_path);
 846         if (document_path.exists() && document_path.isDirectory())
 847                 package().document_dir() = document_path;
 848
 849         package().set_temp_dir(createLyXTmpDir(FileName(lyxrc.tempdir_path)));
 850         if (package().temp_dir().empty()) {
 851                 Alert::error(_("Could not create temporary directory"),
 852                              bformat(_("Could not create a temporary directory in\n"
 853                                                        "\"%1$s\"\n"
 854                                                            "Make sure that this path exists and is writable and try again."),
 855                                      from_utf8(lyxrc.tempdir_path)));
 856                 // createLyXTmpDir() tries sufficiently hard to create a
 857                 // usable temp dir, so the probability to come here is
 858                 // close to zero. We therefore don't try to overcome this
 859                 // problem with e.g. asking the user for a new path and
 860                 // trying again but simply exit.
 861                 return false;
 862         }
 863
 864         LYXERR(Debug::INIT, "LyX tmp dir: `"
 865                             << package().temp_dir().absFilename() << '\'');
 866
 867         LYXERR(Debug::INIT, "Reading session information '.lyx/session'...");
 868         pimpl_->session_.reset(new Session(lyxrc.num_lastfiles));
 869
 870         // This must happen after package initialization and after lyxrc is
 871         // read, therefore it can't be done by a static object.
 872         ConverterCache::init();
 873
 874         return true;
 875 }
 876
 877
 878 void LyX::emergencyCleanup() const
 879 {
 880         // what to do about tmpfiles is non-obvious. we would
 881         // like to delete any we find, but our lyxdir might
 882         // contain documents etc. which might be helpful on
 883         // a crash
 884
 885         pimpl_->buffer_list_.emergencyWriteAll();
 886         if (use_gui) {
 887                 if (pimpl_->lyx_server_)
 888                         pimpl_->lyx_server_->emergencyCleanup();
 889                 pimpl_->lyx_server_.reset();
 890                 pimpl_->lyx_socket_.reset();
 891         }
 892 }
 893
 894
 895 // return true if file does not exist or is older than configure.py.
 896 static bool needsUpdate(string const & file)
 897 {
 898         // We cannot initialize configure_script directly because the package
 899         // is not initialized yet when  static objects are constructed.
 900         static FileName configure_script;
 901         static bool firstrun = true;
 902         if (firstrun) {
 903                 configure_script =
 904                         FileName(addName(package().system_support().absFilename(),
 905                                 "configure.py"));
 906                 firstrun = false;
 907         }
 908
 909         FileName absfile =
 910                 FileName(addName(package().user_support().absFilename(), file));
 911         return !absfile.exists()
 912                 || configure_script.lastModified() > absfile.lastModified();
 913 }
 914
 915
 916 bool LyX::queryUserLyXDir(bool explicit_userdir)
 917 {
 918         // Does user directory exist?
 919         FileName const sup = package().user_support();
 920         if (sup.exists() && sup.isDirectory()) {
 921                 first_start = false;
 922
 923                 return needsUpdate("lyxrc.defaults")
 924                         || needsUpdate("lyxmodules.lst")
 925                         || needsUpdate("textclass.lst")
 926                         || needsUpdate("packages.lst");
 927         }
 928
 929         first_start = !explicit_userdir;
 930
 931         // If the user specified explicitly a directory, ask whether
 932         // to create it. If the user says "no", then exit.
 933         if (explicit_userdir &&
 934             Alert::prompt(
 935                     _("Missing user LyX directory"),
 936                     bformat(_("You have specified a non-existent user "
 937                                            "LyX directory, %1$s.\n"
 938                                            "It is needed to keep your own configuration."),
 939                             from_utf8(package().user_support().absFilename())),
 940                     1, 0,
 941                     _("&Create directory"),
 942                     _("&Exit LyX"))) {
 943                 lyxerr << to_utf8(_("No user LyX directory. Exiting.")) << endl;
 944                 earlyExit(EXIT_FAILURE);
 945         }
 946
 947         lyxerr << to_utf8(bformat(_("LyX: Creating directory %1$s"),
 948                           from_utf8(sup.absFilename()))) << endl;
 949
 950         if (!sup.createDirectory(0755)) {
 951                 // Failed, so let's exit.
 952                 lyxerr << to_utf8(_("Failed to create directory. Exiting."))
 953                        << endl;
 954                 earlyExit(EXIT_FAILURE);
 955         }
 956
 957         return true;
 958 }
 959
 960
 961 bool LyX::readRcFile(string const & name)
 962 {
 963         LYXERR(Debug::INIT, "About to read " << name << "... ");
 964
 965         FileName const lyxrc_path = libFileSearch(string(), name);
 966         if (!lyxrc_path.empty()) {
 967                 LYXERR(Debug::INIT, "Found in " << lyxrc_path);
 968                 if (lyxrc.read(lyxrc_path) < 0) {
 969                         showFileError(name);
 970                         return false;
 971                 }
 972         } else {
 973                 LYXERR(Debug::INIT, "Not found." << lyxrc_path);
 974         }
 975         return true;
 976 }
 977
 978 // Read the languages file `name'
 979 bool LyX::readLanguagesFile(string const & name)
 980 {
 981         LYXERR(Debug::INIT, "About to read " << name << "...");
 982
 983         FileName const lang_path = libFileSearch(string(), name);
 984         if (lang_path.empty()) {
 985                 showFileError(name);
 986                 return false;
 987         }
 988         languages.read(lang_path);
 989         return true;
 990 }
 991
 992
 993 // Read the encodings file `name'
 994 bool LyX::readEncodingsFile(string const & enc_name,
 995                             string const & symbols_name)
 996 {
 997         LYXERR(Debug::INIT, "About to read " << enc_name << " and "
 998                             << symbols_name << "...");
 999
1000         FileName const symbols_path = libFileSearch(string(), symbols_name);
1001         if (symbols_path.empty()) {
1002                 showFileError(symbols_name);
1003                 return false;
1004         }
1005
1006         FileName const enc_path = libFileSearch(string(), enc_name);
1007         if (enc_path.empty()) {
1008                 showFileError(enc_name);
1009                 return false;
1010         }
1011         encodings.read(enc_path, symbols_path);
1012         return true;
1013 }
1014
1015
1016 namespace {
1017
1018 /// return the the number of arguments consumed
1019 typedef boost::function<int(string const &, string const &, string &)> cmd_helper;
1020
1021 int parse_dbg(string const & arg, string const &, string &)
1022 {
1023         if (arg.empty()) {
1024                 lyxerr << to_utf8(_("List of supported debug flags:")) << endl;
1025                 Debug::showTags(lyxerr);
1026                 exit(0);
1027         }
1028         lyxerr << to_utf8(bformat(_("Setting debug level to %1$s"), from_utf8(arg))) << endl;
1029
1030         lyxerr.level(Debug::value(arg));
1031         Debug::showLevel(lyxerr, lyxerr.level());
1032         return 1;
1033 }
1034
1035
1036 int parse_help(string const &, string const &, string &)
1037 {
1038         lyxerr <<
1039                 to_utf8(_("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
1040                   "Command line switches (case sensitive):\n"
1041                   "\t-help              summarize LyX usage\n"
1042                   "\t-userdir dir       set user directory to dir\n"
1043                   "\t-sysdir dir        set system directory to dir\n"
1044                   "\t-geometry WxH+X+Y  set geometry of the main window\n"
1045                   "\t-dbg feature[,feature]...\n"
1046                   "                  select the features to debug.\n"
1047                   "                  Type `lyx -dbg' to see the list of features\n"
1048                   "\t-x [--execute] command\n"
1049                   "                  where command is a lyx command.\n"
1050                   "\t-e [--export] fmt\n"
1051                   "                  where fmt is the export format of choice.\n"
1052                   "                  Look on Tools->Preferences->File formats->Format\n"
1053                   "                  to get an idea which parameters should be passed.\n"
1054                   "\t-i [--import] fmt file.xxx\n"
1055                   "                  where fmt is the import format of choice\n"
1056                   "                  and file.xxx is the file to be imported.\n"
1057                   "\t-version        summarize version and build info\n"
1058                                "Check the LyX man page for more details.")) << endl;
1059         exit(0);
1060         return 0;
1061 }
1062
1063
1064 int parse_version(string const &, string const &, string &)
1065 {
1066         lyxerr << "LyX " << lyx_version
1067                << " (" << lyx_release_date << ")" << endl;
1068         lyxerr << "Built on " << __DATE__ << ", " << __TIME__ << endl;
1069
1070         lyxerr << lyx_version_info << endl;
1071         exit(0);
1072         return 0;
1073 }
1074
1075
1076 int parse_sysdir(string const & arg, string const &, string &)
1077 {
1078         if (arg.empty()) {
1079                 Alert::error(_("No system directory"),
1080                         _("Missing directory for -sysdir switch"));
1081                 exit(1);
1082         }
1083         cl_system_support = arg;
1084         return 1;
1085 }
1086
1087
1088 int parse_userdir(string const & arg, string const &, string &)
1089 {
1090         if (arg.empty()) {
1091                 Alert::error(_("No user directory"),
1092                         _("Missing directory for -userdir switch"));
1093                 exit(1);
1094         }
1095         cl_user_support = arg;
1096         return 1;
1097 }
1098
1099
1100 int parse_execute(string const & arg, string const &, string & batch)
1101 {
1102         if (arg.empty()) {
1103                 Alert::error(_("Incomplete command"),
1104                         _("Missing command string after --execute switch"));
1105                 exit(1);
1106         }
1107         batch = arg;
1108         return 1;
1109 }
1110
1111
1112 int parse_export(string const & type, string const &, string & batch)
1113 {
1114         if (type.empty()) {
1115                 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1116                                          "--export switch")) << endl;
1117                 exit(1);
1118         }
1119         batch = "buffer-export " + type;
1120         use_gui = false;
1121         return 1;
1122 }
1123
1124
1125 int parse_import(string const & type, string const & file, string & batch)
1126 {
1127         if (type.empty()) {
1128                 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1129                                          "--import switch")) << endl;
1130                 exit(1);
1131         }
1132         if (file.empty()) {
1133                 lyxerr << to_utf8(_("Missing filename for --import")) << endl;
1134                 exit(1);
1135         }
1136
1137         batch = "buffer-import " + type + ' ' + file;
1138         return 2;
1139 }
1140
1141
1142 int parse_geometry(string const & arg1, string const &, string &)
1143 {
1144         geometryArg = arg1;
1145 #if defined(_WIN32) || (defined(__CYGWIN__) && defined(X_DISPLAY_MISSING))
1146         // remove also the arg
1147         return 1;
1148 #else
1149         // don't remove "-geometry"
1150         return -1;
1151 #endif
1152 }
1153
1154
1155 } // namespace anon
1156
1157
1158 void LyX::easyParse(int & argc, char * argv[])
1159 {
1160         map<string, cmd_helper> cmdmap;
1161
1162         cmdmap["-dbg"] = parse_dbg;
1163         cmdmap["-help"] = parse_help;
1164         cmdmap["--help"] = parse_help;
1165         cmdmap["-version"] = parse_version;
1166         cmdmap["--version"] = parse_version;
1167         cmdmap["-sysdir"] = parse_sysdir;
1168         cmdmap["-userdir"] = parse_userdir;
1169         cmdmap["-x"] = parse_execute;
1170         cmdmap["--execute"] = parse_execute;
1171         cmdmap["-e"] = parse_export;
1172         cmdmap["--export"] = parse_export;
1173         cmdmap["-i"] = parse_import;
1174         cmdmap["--import"] = parse_import;
1175         cmdmap["-geometry"] = parse_geometry;
1176
1177         for (int i = 1; i < argc; ++i) {
1178                 map<string, cmd_helper>::const_iterator it
1179                         = cmdmap.find(argv[i]);
1180
1181                 // don't complain if not found - may be parsed later
1182                 if (it == cmdmap.end())
1183                         continue;
1184
1185                 string const arg =
1186                         (i + 1 < argc) ? to_utf8(from_local8bit(argv[i + 1])) : string();
1187                 string const arg2 =
1188                         (i + 2 < argc) ? to_utf8(from_local8bit(argv[i + 2])) : string();
1189
1190                 string batch;
1191                 int const remove = 1 + it->second(arg, arg2, batch);
1192                 if (!batch.empty())
1193                         pimpl_->batch_commands.push_back(batch);
1194
1195                 // Now, remove used arguments by shifting
1196                 // the following ones remove places down.
1197                 if (remove > 0) {
1198                         argc -= remove;
1199                         for (int j = i; j < argc; ++j)
1200                                 argv[j] = argv[j + remove];
1201                         --i;
1202                 }
1203         }
1204 }
1205
1206
1207 FuncStatus getStatus(FuncRequest const & action)
1208 {
1209         return LyX::ref().lyxFunc().getStatus(action);
1210 }
1211
1212
1213 void dispatch(FuncRequest const & action)
1214 {
1215         LyX::ref().lyxFunc().dispatch(action);
1216 }
1217
1218
1219 BufferList & theBufferList()
1220 {
1221         return LyX::ref().bufferList();
1222 }
1223
1224
1225 LyXFunc & theLyXFunc()
1226 {
1227         return LyX::ref().lyxFunc();
1228 }
1229
1230
1231 Server & theServer()
1232 {
1233         // FIXME: this should not be use_gui dependent
1234         LASSERT(use_gui, /**/);
1235         return LyX::ref().server();
1236 }
1237
1238
1239 ServerSocket & theServerSocket()
1240 {
1241         // FIXME: this should not be use_gui dependent
1242         LASSERT(use_gui, /**/);
1243         return LyX::ref().socket();
1244 }
1245
1246
1247 KeyMap & theTopLevelKeymap()
1248 {
1249         return LyX::ref().pimpl_->toplevel_keymap_;
1250 }
1251
1252
1253 Converters & theConverters()
1254 {
1255         return  LyX::ref().converters();
1256 }
1257
1258
1259 Converters & theSystemConverters()
1260 {
1261         return  LyX::ref().systemConverters();
1262 }
1263
1264
1265 Movers & theMovers()
1266 {
1267         return  LyX::ref().pimpl_->movers_;
1268 }
1269
1270
1271 Mover const & getMover(string  const & fmt)
1272 {
1273         return  LyX::ref().pimpl_->movers_(fmt);
1274 }
1275
1276
1277 void setMover(string const & fmt, string const & command)
1278 {
1279         LyX::ref().pimpl_->movers_.set(fmt, command);
1280 }
1281
1282
1283 Movers & theSystemMovers()
1284 {
1285         return  LyX::ref().pimpl_->system_movers_;
1286 }
1287
1288
1289 Messages & getMessages(string const & language)
1290 {
1291         return LyX::ref().getMessages(language);
1292 }
1293
1294
1295 Messages & getGuiMessages()
1296 {
1297         return LyX::ref().getGuiMessages();
1298 }
1299
1300 } // namespace lyx