src/LyX.cpp

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