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