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