src/LyX.cpp

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