src/lyx_main.C

   1 /**
   2  * \file lyx_main.C
   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_main.h"
  19
  20 #include "ConverterCache.h"
  21 #include "buffer.h"
  22 #include "buffer_funcs.h"
  23 #include "bufferlist.h"
  24 #include "converter.h"
  25 #include "debug.h"
  26 #include "encoding.h"
  27 #include "errorlist.h"
  28 #include "format.h"
  29 #include "gettext.h"
  30 #include "kbmap.h"
  31 #include "language.h"
  32 #include "session.h"
  33 #include "LColor.h"
  34 #include "lyx_cb.h"
  35 #include "LyXAction.h"
  36 #include "lyxfunc.h"
  37 #include "lyxlex.h"
  38 #include "lyxrc.h"
  39 #include "lyxserver.h"
  40 #include "lyxsocket.h"
  41 #include "lyxtextclasslist.h"
  42 #include "MenuBackend.h"
  43 #include "mover.h"
  44 #include "ToolbarBackend.h"
  45
  46 #include "frontends/Alert.h"
  47 #include "frontends/Application.h"
  48 #include "frontends/Gui.h"
  49 #include "frontends/LyXView.h"
  50
  51 #include "support/environment.h"
  52 #include "support/filetools.h"
  53 #include "support/fontutils.h"
  54 #include "support/lyxlib.h"
  55 #include "support/convert.h"
  56 #include "support/os.h"
  57 #include "support/package.h"
  58 #include "support/path.h"
  59 #include "support/systemcall.h"
  60 #include "support/unicode.h"
  61
  62 #include <boost/bind.hpp>
  63 #include <boost/filesystem/operations.hpp>
  64
  65 #include <iostream>
  66 #include <csignal>
  67
  68
  69 namespace lyx {
  70
  71 using support::addName;
  72 using support::addPath;
  73 using support::bformat;
  74 using support::createDirectory;
  75 using support::createLyXTmpDir;
  76 using support::destroyDir;
  77 using support::fileSearch;
  78 using support::getEnv;
  79 using support::i18nLibFileSearch;
  80 using support::libFileSearch;
  81 using support::package;
  82 using support::prependEnvPath;
  83 using support::rtrim;
  84 using support::Systemcall;
  85
  86 namespace Alert = frontend::Alert;
  87 namespace os = support::os;
  88 namespace fs = boost::filesystem;
  89
  90 using std::endl;
  91 using std::string;
  92 using std::vector;
  93 using std::for_each;
  94
  95 #ifndef CXX_GLOBAL_CSTD
  96 using std::exit;
  97 using std::signal;
  98 using std::system;
  99 #endif
 100
 101 ///
 102 frontend::Application * theApp = 0;
 103
 104 /// are we using the GUI at all?
 105 /**
 106 * We default to true and this is changed to false when the export feature is used.
 107 */
 108 bool use_gui = true;
 109
 110
 111 namespace {
 112
 113 // Filled with the command line arguments "foo" of "-sysdir foo" or
 114 // "-userdir foo".
 115 string cl_system_support;
 116 string cl_user_support;
 117
 118 LyX * singleton_ = 0;
 119
 120 void showFileError(string const & error)
 121 {
 122         Alert::warning(_("Could not read configuration file"),
 123                        bformat(_("Error while reading the configuration file\n%1$s.\n"
 124                            "Please check your installation."), from_utf8(error)));
 125 }
 126
 127
 128 void reconfigureUserLyXDir()
 129 {
 130         string const configure_command = package().configure_command();
 131
 132         lyxerr << to_utf8(_("LyX: reconfiguring user directory")) << endl;
 133         support::Path p(package().user_support());
 134         Systemcall one;
 135         one.startscript(Systemcall::Wait, configure_command);
 136         lyxerr << "LyX: " << to_utf8(_("Done!")) << endl;
 137 }
 138
 139 } // namespace anon
 140
 141
 142 /// The main application class private implementation.
 143 struct LyX::Singletons
 144 {
 145         Singletons(): iconv(ucs4_codeset, "UTF-8")
 146         {
 147         }
 148         /// our function handler
 149         LyXFunc lyxfunc_;
 150         ///
 151         BufferList buffer_list_;
 152         ///
 153         boost::scoped_ptr<kb_keymap> toplevel_keymap_;
 154         ///
 155         boost::scoped_ptr<LyXServer> lyx_server_;
 156         ///
 157         boost::scoped_ptr<LyXServerSocket> lyx_socket_;
 158         ///
 159         boost::scoped_ptr<frontend::Application> application_;
 160         /// lyx session, containing lastfiles, lastfilepos, and lastopened
 161         boost::scoped_ptr<Session> session_;
 162
 163         ///
 164         IconvProcessor iconv;
 165 };
 166
 167
 168 LyX::~LyX()
 169 {
 170         // Static data are not treated in the same way at all on the Mac (and
 171         // the LyX singleton has static methods). This is the reason why the
 172         // exit command on the Mac bypasses our dispatch machinery altogether.
 173         // On Linux and Windows we won't pass a second time through quit()
 174         // because quitting will already be set to true.
 175         if (!quitting)
 176                 quit();
 177 }
 178
 179
 180 LyX & LyX::ref()
 181 {
 182         BOOST_ASSERT(singleton_);
 183         return *singleton_;
 184 }
 185
 186
 187 LyX const & LyX::cref()
 188 {
 189         BOOST_ASSERT(singleton_);
 190         return *singleton_;
 191 }
 192
 193
 194 LyX::LyX()
 195         : first_start(false), geometryOption_(false)
 196 {
 197         singleton_ = this;
 198         pimpl_.reset(new Singletons);
 199 }
 200
 201
 202 BufferList & LyX::bufferList()
 203 {
 204         return pimpl_->buffer_list_;
 205 }
 206
 207
 208 BufferList const & LyX::bufferList() const
 209 {
 210         return pimpl_->buffer_list_;
 211 }
 212
 213
 214 Session & LyX::session()
 215 {
 216         BOOST_ASSERT(pimpl_->session_.get());
 217         return *pimpl_->session_.get();
 218 }
 219
 220
 221 Session const & LyX::session() const
 222 {
 223         BOOST_ASSERT(pimpl_->session_.get());
 224         return *pimpl_->session_.get();
 225 }
 226
 227
 228 LyXFunc & LyX::lyxFunc()
 229 {
 230         return pimpl_->lyxfunc_;
 231 }
 232
 233
 234 LyXFunc const & LyX::lyxFunc() const
 235 {
 236         return pimpl_->lyxfunc_;
 237 }
 238
 239
 240 LyXServer & LyX::server()
 241 {
 242         BOOST_ASSERT(pimpl_->lyx_server_.get());
 243         return *pimpl_->lyx_server_.get();
 244 }
 245
 246
 247 LyXServer const & LyX::server() const
 248 {
 249         BOOST_ASSERT(pimpl_->lyx_server_.get());
 250         return *pimpl_->lyx_server_.get();
 251 }
 252
 253
 254 LyXServerSocket & LyX::socket()
 255 {
 256         BOOST_ASSERT(pimpl_->lyx_socket_.get());
 257         return *pimpl_->lyx_socket_.get();
 258 }
 259
 260
 261 LyXServerSocket const & LyX::socket() const
 262 {
 263         BOOST_ASSERT(pimpl_->lyx_socket_.get());
 264         return *pimpl_->lyx_socket_.get();
 265 }
 266
 267
 268 frontend::Application & LyX::application()
 269 {
 270         BOOST_ASSERT(pimpl_->application_.get());
 271         return *pimpl_->application_.get();
 272 }
 273
 274
 275 frontend::Application const & LyX::application() const
 276 {
 277         BOOST_ASSERT(pimpl_->application_.get());
 278         return *pimpl_->application_.get();
 279 }
 280
 281
 282 kb_keymap & LyX::topLevelKeymap()
 283 {
 284         BOOST_ASSERT(pimpl_->toplevel_keymap_.get());
 285         return *pimpl_->toplevel_keymap_.get();
 286 }
 287
 288
 289 IconvProcessor & LyX::iconvProcessor()
 290 {
 291         return pimpl_->iconv;
 292 }
 293
 294
 295 kb_keymap const & LyX::topLevelKeymap() const
 296 {
 297         BOOST_ASSERT(pimpl_->toplevel_keymap_.get());
 298         return *pimpl_->toplevel_keymap_.get();
 299 }
 300
 301
 302 Buffer const * const LyX::updateInset(InsetBase const * inset) const
 303 {
 304         if (!inset)
 305                 return 0;
 306
 307         Buffer const * buffer_ptr = 0;
 308         vector<int> const & view_ids = pimpl_->application_->gui().viewIds();
 309         vector<int>::const_iterator it = view_ids.begin();
 310         vector<int>::const_iterator const end = view_ids.end();
 311         for (; it != end; ++it) {
 312                 Buffer const * ptr =
 313                         pimpl_->application_->gui().view(*it).updateInset(inset);
 314                 if (ptr)
 315                         buffer_ptr = ptr;
 316         }
 317         return buffer_ptr;
 318 }
 319
 320
 321 int LyX::exec(int & argc, char * argv[])
 322 {
 323         // Here we need to parse the command line. At least
 324         // we need to parse for "-dbg" and "-help"
 325         easyParse(argc, argv);
 326
 327         support::init_package(argv[0], cl_system_support, cl_user_support,
 328                                    support::top_build_dir_is_one_level_up);
 329
 330         vector<string> files;
 331         int exit_status = execBatchCommands(argc, argv, files);
 332
 333         if (exit_status)
 334                 return exit_status;
 335
 336         if (use_gui) {
 337                 // Force adding of font path _before_ Application is initialized
 338                 support::addFontResources();
 339                 pimpl_->application_.reset(createApplication(argc, argv));
 340                 initGuiFont();
 341                 // FIXME: this global pointer should probably go.
 342                 theApp = pimpl_->application_.get();
 343                 restoreGuiSession(files);
 344                 // Start the real execution loop.
 345
 346                 // FIXME
 347                 /* Create a CoreApplication class that will provide the main event loop
 348                  * and the socket callback registering. With Qt4, only QtCore
 349                  * library would be needed.
 350                  * When this is done, a server_mode could be created and the following two
 351                  * line would be moved out from here.
 352                  */
 353                 pimpl_->lyx_server_.reset(new LyXServer(&pimpl_->lyxfunc_, lyxrc.lyxpipes));
 354                 pimpl_->lyx_socket_.reset(new LyXServerSocket(&pimpl_->lyxfunc_,
 355                         support::os::internal_path(package().temp_dir() + "/lyxsocket")));
 356
 357                 // handle the batch commands the user asked for
 358                 if (!batch_command.empty()) {
 359                         pimpl_->lyxfunc_.dispatch(lyxaction.lookupFunc(batch_command));
 360                 }
 361
 362                 exit_status = pimpl_->application_->start(batch_command);
 363                 // Kill the application object before exiting. This avoid crash
 364                 // on exit on Linux.
 365                 pimpl_->application_.reset();
 366                 // Restore original font resources after Application is destroyed.
 367                 support::restoreFontResources();
 368         }
 369         else {
 370                 // FIXME: create a ConsoleApplication
 371                 theApp = 0;
 372         }
 373
 374         return exit_status;
 375 }
 376
 377
 378 void LyX::prepareExit()
 379 {
 380         // Set a flag that we do quitting from the program,
 381         // so no refreshes are necessary.
 382         quitting = true;
 383
 384         // close buffers first
 385         pimpl_->buffer_list_.closeAll();
 386
 387         // do any other cleanup procedures now
 388         lyxerr[Debug::INFO] << "Deleting tmp dir " << package().temp_dir() << endl;
 389
 390         if (!destroyDir(package().temp_dir())) {
 391                 docstring const msg =
 392                         bformat(_("Unable to remove the temporary directory %1$s"),
 393                         from_utf8(package().temp_dir()));
 394                 Alert::warning(_("Unable to remove temporary directory"), msg);
 395         }
 396 }
 397
 398
 399 void LyX::earlyExit(int status)
 400 {
 401         BOOST_ASSERT(pimpl_->application_.get());
 402         // LyX::pimpl_::application_ is not initialised at this
 403         // point so it's safe to just exit after some cleanup.
 404         prepareExit();
 405         exit(status);
 406 }
 407
 408
 409 void LyX::quit()
 410 {
 411         lyxerr[Debug::INFO] << "Running QuitLyX." << endl;
 412
 413         prepareExit();
 414
 415         if (use_gui) {
 416                 pimpl_->session_->writeFile();
 417                 pimpl_->lyx_server_.reset();
 418                 pimpl_->lyx_socket_.reset();
 419                 pimpl_->application_->exit(0);
 420         }
 421 }
 422
 423
 424 int LyX::execBatchCommands(int & argc, char * argv[],
 425         vector<string> & files)
 426 {
 427         // check for any spurious extra arguments
 428         // other than documents
 429         for (int argi = 1; argi < argc ; ++argi) {
 430                 if (argv[argi][0] == '-') {
 431                         lyxerr << to_utf8(
 432                                 bformat(_("Wrong command line option `%1$s'. Exiting."),
 433                                 from_utf8(argv[argi]))) << endl;
 434                         return EXIT_FAILURE;
 435                 }
 436         }
 437
 438         // Initialization of LyX (reads lyxrc and more)
 439         lyxerr[Debug::INIT] << "Initializing LyX::init..." << endl;
 440         bool success = init();
 441         lyxerr[Debug::INIT] << "Initializing LyX::init...done" << endl;
 442         if (!success)
 443                 return EXIT_FAILURE;
 444
 445         for (int argi = argc - 1; argi >= 1; --argi)
 446                 files.push_back(os::internal_path(argv[argi]));
 447
 448         if (first_start)
 449                 files.push_back(i18nLibFileSearch("examples", "splash.lyx"));
 450
 451         // Execute batch commands if available
 452         if (!batch_command.empty()) {
 453
 454                 lyxerr[Debug::INIT] << "About to handle -x '"
 455                        << batch_command << '\'' << endl;
 456
 457                 Buffer * last_loaded = 0;
 458
 459                 vector<string>::const_iterator it = files.begin();
 460                 vector<string>::const_iterator end = files.end();
 461
 462                 for (; it != end; ++it) {
 463                         // get absolute path of file and add ".lyx" to
 464                         // the filename if necessary
 465                         string s = fileSearch(string(), *it, "lyx");
 466                         if (s.empty()) {
 467                                 Buffer * const b = newFile(*it, string(), true);
 468                                 if (b)
 469                                         last_loaded = b;
 470                         } else {
 471                                 Buffer * buf = pimpl_->buffer_list_.newBuffer(s, false);
 472                                 if (loadLyXFile(buf, s)) {
 473                                         last_loaded = buf;
 474                                         ErrorList const & el = buf->errorList("Parse");
 475                                         if (!el.empty())
 476                                                 for_each(el.begin(), el.end(),
 477                                                         boost::bind(&LyX::printError, this, _1));
 478                                 }
 479                                 else
 480                                         pimpl_->buffer_list_.release(buf);
 481                         }
 482                 }
 483
 484                 // try to dispatch to last loaded buffer first
 485                 if (last_loaded) {
 486                         success = false;
 487                         if (last_loaded->dispatch(batch_command, &success)) {
 488                                 prepareExit();
 489                                 return !success;
 490                         }
 491                 }
 492                 files.clear(); // the files are already loaded
 493         }
 494
 495         return EXIT_SUCCESS;
 496 }
 497
 498
 499 void LyX::restoreGuiSession(vector<string> const & files)
 500 {
 501         LyXView * view = newLyXView();
 502
 503         // load files
 504         for_each(files.begin(), files.end(),
 505                 bind(&LyXView::loadLyXFile, view, _1, true));
 506
 507         // if a file is specified, I assume that user wants to edit *that* file
 508         if (files.empty() && lyxrc.load_session) {
 509                 vector<string> const & lastopened = pimpl_->session_->lastOpened().getfiles();
 510                 // do not add to the lastfile list since these files are restored from
 511                 // last seesion, and should be already there (regular files), or should
 512                 // not be added at all (help files).
 513                 for_each(lastopened.begin(), lastopened.end(),
 514                         bind(&LyXView::loadLyXFile, view, _1, false));
 515         }
 516         // clear this list to save a few bytes of RAM
 517         pimpl_->session_->lastOpened().clear();
 518 }
 519
 520
 521 LyXView * LyX::newLyXView()
 522 {
 523         if (!lyx::use_gui)
 524                 return 0;
 525
 526         // determine windows size and position, from lyxrc and/or session
 527         // initial geometry
 528         unsigned int width = 690;
 529         unsigned int height = 510;
 530         bool maximize = false;
 531         // first try lyxrc
 532         if (lyxrc.geometry_width != 0 && lyxrc.geometry_height != 0 ) {
 533                 width = lyxrc.geometry_width;
 534                 height = lyxrc.geometry_height;
 535         }
 536         // if lyxrc returns (0,0), then use session info
 537         else {
 538                 string val = session().sessionInfo().load("WindowWidth");
 539                 if (!val.empty())
 540                         width = convert<unsigned int>(val);
 541                 val = session().sessionInfo().load("WindowHeight");
 542                 if (!val.empty())
 543                         height = convert<unsigned int>(val);
 544                 if (session().sessionInfo().load("WindowIsMaximized") == "yes")
 545                         maximize = true;
 546         }
 547
 548         // if user wants to restore window position
 549         int posx = -1;
 550         int posy = -1;
 551         if (lyxrc.geometry_xysaved) {
 552                 string val = session().sessionInfo().load("WindowPosX");
 553                 if (!val.empty())
 554                         posx = convert<int>(val);
 555                 val = session().sessionInfo().load("WindowPosY");
 556                 if (!val.empty())
 557                         posy = convert<int>(val);
 558         }
 559
 560         if (geometryOption_) {
 561                 width = 0;
 562                 height = 0;
 563         }
 564         // create the main window
 565         LyXView * view = &pimpl_->application_->createView(width, height, posx, posy, maximize);
 566
 567         return view;
 568 }
 569
 570 /*
 571 Signals and Windows
 572 ===================
 573 The SIGHUP signal does not exist on Windows and does not need to be handled.
 574
 575 Windows handles SIGFPE and SIGSEGV signals as expected.
 576
 577 Cntl+C interrupts (mapped to SIGINT by Windows' POSIX compatability layer)
 578 cause a new thread to be spawned. This may well result in unexpected
 579 behaviour by the single-threaded LyX.
 580
 581 SIGTERM signals will come only from another process actually sending
 582 that signal using 'raise' in Windows' POSIX compatability layer. It will
 583 not come from the general "terminate process" methods that everyone
 584 actually uses (and which can't be trapped). Killing an app 'politely' on
 585 Windows involves first sending a WM_CLOSE message, something that is
 586 caught already by the Qt frontend.
 587
 588 For more information see:
 589
 590 http://aspn.activestate.com/ASPN/Mail/Message/ActiveTcl/2034055
 591 ...signals are mostly useless on Windows for a variety of reasons that are
 592 Windows specific...
 593
 594 'UNIX Application Migration Guide, Chapter 9'
 595 http://msdn.microsoft.com/library/en-us/dnucmg/html/UCMGch09.asp
 596
 597 'How To Terminate an Application "Cleanly" in Win32'
 598 http://support.microsoft.com/default.aspx?scid=kb;en-us;178893
 599 */
 600 extern "C" {
 601
 602 static void error_handler(int err_sig)
 603 {
 604         // Throw away any signals other than the first one received.
 605         static sig_atomic_t handling_error = false;
 606         if (handling_error)
 607                 return;
 608         handling_error = true;
 609
 610         // We have received a signal indicating a fatal error, so
 611         // try and save the data ASAP.
 612         LyX::cref().emergencyCleanup();
 613
 614         // These lyxerr calls may or may not work:
 615
 616         // Signals are asynchronous, so the main program may be in a very
 617         // fragile state when a signal is processed and thus while a signal
 618         // handler function executes.
 619         // In general, therefore, we should avoid performing any
 620         // I/O operations or calling most library and system functions from
 621         // signal handlers.
 622
 623         // This shouldn't matter here, however, as we've already invoked
 624         // emergencyCleanup.
 625         switch (err_sig) {
 626 #ifdef SIGHUP
 627         case SIGHUP:
 628                 lyxerr << "\nlyx: SIGHUP signal caught\nBye." << endl;
 629                 break;
 630 #endif
 631         case SIGFPE:
 632                 lyxerr << "\nlyx: SIGFPE signal caught\nBye." << endl;
 633                 break;
 634         case SIGSEGV:
 635                 lyxerr << "\nlyx: SIGSEGV signal caught\n"
 636                           "Sorry, you have found a bug in LyX. "
 637                           "Please read the bug-reporting instructions "
 638                           "in Help->Introduction and send us a bug report, "
 639                           "if necessary. Thanks !\nBye." << endl;
 640                 break;
 641         case SIGINT:
 642         case SIGTERM:
 643                 // no comments
 644                 break;
 645         }
 646
 647         // Deinstall the signal handlers
 648 #ifdef SIGHUP
 649         signal(SIGHUP, SIG_DFL);
 650 #endif
 651         signal(SIGINT, SIG_DFL);
 652         signal(SIGFPE, SIG_DFL);
 653         signal(SIGSEGV, SIG_DFL);
 654         signal(SIGTERM, SIG_DFL);
 655
 656 #ifdef SIGHUP
 657         if (err_sig == SIGSEGV ||
 658             (err_sig != SIGHUP && !getEnv("LYXDEBUG").empty()))
 659 #else
 660         if (err_sig == SIGSEGV || !getEnv("LYXDEBUG").empty())
 661 #endif
 662                 support::abort();
 663         exit(0);
 664 }
 665
 666 }
 667
 668
 669 void LyX::printError(ErrorItem const & ei)
 670 {
 671         docstring tmp = _("LyX: ") + ei.error + char_type(':')
 672                 + ei.description;
 673         std::cerr << to_utf8(tmp) << std::endl;
 674 }
 675
 676
 677 void LyX::initGuiFont()
 678 {
 679         if (lyxrc.roman_font_name.empty())
 680                 lyxrc.roman_font_name = pimpl_->application_->romanFontName();
 681
 682         if (lyxrc.sans_font_name.empty())
 683                 lyxrc.sans_font_name = pimpl_->application_->sansFontName();
 684
 685         if (lyxrc.typewriter_font_name.empty())
 686                 lyxrc.typewriter_font_name
 687                         = pimpl_->application_->typewriterFontName();
 688 }
 689
 690
 691 bool LyX::init()
 692 {
 693 #ifdef SIGHUP
 694         signal(SIGHUP, error_handler);
 695 #endif
 696         signal(SIGFPE, error_handler);
 697         signal(SIGSEGV, error_handler);
 698         signal(SIGINT, error_handler);
 699         signal(SIGTERM, error_handler);
 700         // SIGPIPE can be safely ignored.
 701
 702         lyxrc.tempdir_path = package().temp_dir();
 703         lyxrc.document_path = package().document_dir();
 704
 705         if (lyxrc.template_path.empty()) {
 706                 lyxrc.template_path = addPath(package().system_support(),
 707                                               "templates");
 708         }
 709
 710         //
 711         // Read configuration files
 712         //
 713
 714         // This one may have been distributed along with LyX.
 715         if (!readRcFile("lyxrc.dist"))
 716                 return false;
 717
 718         // Set the PATH correctly.
 719 #if !defined (USE_POSIX_PACKAGING)
 720         // Add the directory containing the LyX executable to the path
 721         // so that LyX can find things like tex2lyx.
 722         if (package().build_support().empty())
 723                 prependEnvPath("PATH", package().binary_dir());
 724 #endif
 725         if (!lyxrc.path_prefix.empty())
 726                 prependEnvPath("PATH", lyxrc.path_prefix);
 727
 728         // Check that user LyX directory is ok.
 729         if (queryUserLyXDir(package().explicit_user_support()))
 730                 reconfigureUserLyXDir();
 731
 732         // no need for a splash when there is no GUI
 733         if (!use_gui) {
 734                 first_start = false;
 735         }
 736
 737         // This one is generated in user_support directory by lib/configure.py.
 738         if (!readRcFile("lyxrc.defaults"))
 739                 return false;
 740
 741         // Query the OS to know what formats are viewed natively
 742         formats.setAutoOpen();
 743
 744         // Read lyxrc.dist again to be able to override viewer auto-detection.
 745         readRcFile("lyxrc.dist");
 746
 747         system_lyxrc = lyxrc;
 748         system_formats = formats;
 749         system_converters = converters;
 750         system_movers = movers;
 751         system_lcolor = lcolor;
 752
 753         // This one is edited through the preferences dialog.
 754         if (!readRcFile("preferences"))
 755                 return false;
 756
 757         if (!readEncodingsFile("encodings"))
 758                 return false;
 759         if (!readLanguagesFile("languages"))
 760                 return false;
 761
 762         // Load the layouts
 763         lyxerr[Debug::INIT] << "Reading layouts..." << endl;
 764         if (!LyXSetStyle())
 765                 return false;
 766
 767         if (use_gui) {
 768                 // Set up bindings
 769                 pimpl_->toplevel_keymap_.reset(new kb_keymap);
 770                 defaultKeyBindings(pimpl_->toplevel_keymap_.get());
 771                 pimpl_->toplevel_keymap_->read(lyxrc.bind_file);
 772
 773                 pimpl_->lyxfunc_.initKeySequences(pimpl_->toplevel_keymap_.get());
 774
 775                 // Read menus
 776                 if (!readUIFile(lyxrc.ui_file))
 777                         return false;
 778         }
 779
 780         if (lyxerr.debugging(Debug::LYXRC))
 781                 lyxrc.print();
 782
 783         os::windows_style_tex_paths(lyxrc.windows_style_tex_paths);
 784         if (!lyxrc.path_prefix.empty())
 785                 prependEnvPath("PATH", lyxrc.path_prefix);
 786
 787         if (fs::exists(lyxrc.document_path) &&
 788             fs::is_directory(lyxrc.document_path))
 789                 package().document_dir() = lyxrc.document_path;
 790
 791         package().temp_dir() = createLyXTmpDir(lyxrc.tempdir_path);
 792         if (package().temp_dir().empty()) {
 793                 Alert::error(_("Could not create temporary directory"),
 794                              bformat(_("Could not create a temporary directory in\n"
 795                                                     "%1$s. Make sure that this\n"
 796                                                     "path exists and is writable and try again."),
 797                                      from_utf8(lyxrc.tempdir_path)));
 798                 // createLyXTmpDir() tries sufficiently hard to create a
 799                 // usable temp dir, so the probability to come here is
 800                 // close to zero. We therefore don't try to overcome this
 801                 // problem with e.g. asking the user for a new path and
 802                 // trying again but simply exit.
 803                 return false;
 804         }
 805
 806         if (lyxerr.debugging(Debug::INIT)) {
 807                 lyxerr << "LyX tmp dir: `" << package().temp_dir() << '\'' << endl;
 808         }
 809
 810         lyxerr[Debug::INIT] << "Reading session information '.lyx/session'..." << endl;
 811         pimpl_->session_.reset(new Session(lyxrc.num_lastfiles));
 812
 813         // This must happen after package initialization and after lyxrc is
 814         // read, therefore it can't be done by a static object.
 815         ConverterCache::init();
 816
 817         return true;
 818 }
 819
 820
 821 void LyX::defaultKeyBindings(kb_keymap  * kbmap)
 822 {
 823         kbmap->bind("Right", FuncRequest(LFUN_CHAR_FORWARD));
 824         kbmap->bind("Left", FuncRequest(LFUN_CHAR_BACKWARD));
 825         kbmap->bind("Up", FuncRequest(LFUN_UP));
 826         kbmap->bind("Down", FuncRequest(LFUN_DOWN));
 827
 828         kbmap->bind("Tab", FuncRequest(LFUN_CELL_FORWARD));
 829         kbmap->bind("C-Tab", FuncRequest(LFUN_CELL_SPLIT));
 830         kbmap->bind("~S-ISO_Left_Tab", FuncRequest(LFUN_CELL_BACKWARD));
 831         kbmap->bind("~S-BackTab", FuncRequest(LFUN_CELL_BACKWARD));
 832
 833         kbmap->bind("Home", FuncRequest(LFUN_LINE_BEGIN));
 834         kbmap->bind("End", FuncRequest(LFUN_LINE_END));
 835         kbmap->bind("Prior", FuncRequest(LFUN_SCREEN_UP));
 836         kbmap->bind("Next", FuncRequest(LFUN_SCREEN_DOWN));
 837
 838         kbmap->bind("Return", FuncRequest(LFUN_BREAK_PARAGRAPH));
 839         //kbmap->bind("~C-~S-~M-nobreakspace", FuncRequest(LFUN_PROTECTEDSPACE));
 840
 841         kbmap->bind("Delete", FuncRequest(LFUN_CHAR_DELETE_FORWARD));
 842         kbmap->bind("BackSpace", FuncRequest(LFUN_CHAR_DELETE_BACKWARD));
 843
 844         // kbmap->bindings to enable the use of the numeric keypad
 845         // e.g. Num Lock set
 846         //kbmap->bind("KP_0", FuncRequest(LFUN_SELF_INSERT));
 847         //kbmap->bind("KP_Decimal", FuncRequest(LFUN_SELF_INSERT));
 848         kbmap->bind("KP_Enter", FuncRequest(LFUN_BREAK_PARAGRAPH));
 849         //kbmap->bind("KP_1", FuncRequest(LFUN_SELF_INSERT));
 850         //kbmap->bind("KP_2", FuncRequest(LFUN_SELF_INSERT));
 851         //kbmap->bind("KP_3", FuncRequest(LFUN_SELF_INSERT));
 852         //kbmap->bind("KP_4", FuncRequest(LFUN_SELF_INSERT));
 853         //kbmap->bind("KP_5", FuncRequest(LFUN_SELF_INSERT));
 854         //kbmap->bind("KP_6", FuncRequest(LFUN_SELF_INSERT));
 855         //kbmap->bind("KP_Add", FuncRequest(LFUN_SELF_INSERT));
 856         //kbmap->bind("KP_7", FuncRequest(LFUN_SELF_INSERT));
 857         //kbmap->bind("KP_8", FuncRequest(LFUN_SELF_INSERT));
 858         //kbmap->bind("KP_9", FuncRequest(LFUN_SELF_INSERT));
 859         //kbmap->bind("KP_Divide", FuncRequest(LFUN_SELF_INSERT));
 860         //kbmap->bind("KP_Multiply", FuncRequest(LFUN_SELF_INSERT));
 861         //kbmap->bind("KP_Subtract", FuncRequest(LFUN_SELF_INSERT));
 862         kbmap->bind("KP_Right", FuncRequest(LFUN_CHAR_FORWARD));
 863         kbmap->bind("KP_Left", FuncRequest(LFUN_CHAR_BACKWARD));
 864         kbmap->bind("KP_Up", FuncRequest(LFUN_UP));
 865         kbmap->bind("KP_Down", FuncRequest(LFUN_DOWN));
 866         kbmap->bind("KP_Home", FuncRequest(LFUN_LINE_BEGIN));
 867         kbmap->bind("KP_End", FuncRequest(LFUN_LINE_END));
 868         kbmap->bind("KP_Prior", FuncRequest(LFUN_SCREEN_UP));
 869         kbmap->bind("KP_Next", FuncRequest(LFUN_SCREEN_DOWN));
 870 }
 871
 872
 873 void LyX::emergencyCleanup() const
 874 {
 875         // what to do about tmpfiles is non-obvious. we would
 876         // like to delete any we find, but our lyxdir might
 877         // contain documents etc. which might be helpful on
 878         // a crash
 879
 880         pimpl_->buffer_list_.emergencyWriteAll();
 881         if (use_gui) {
 882                 pimpl_->lyx_server_->emergencyCleanup();
 883                 pimpl_->lyx_server_.reset();
 884                 pimpl_->lyx_socket_.reset();
 885         }
 886 }
 887
 888
 889 void LyX::deadKeyBindings(kb_keymap * kbmap)
 890 {
 891         // bindKeyings for transparent handling of deadkeys
 892         // The keysyms are gotten from XFree86 X11R6
 893         kbmap->bind("~C-~S-~M-dead_acute", FuncRequest(LFUN_ACCENT_ACUTE));
 894         kbmap->bind("~C-~S-~M-dead_breve", FuncRequest(LFUN_ACCENT_BREVE));
 895         kbmap->bind("~C-~S-~M-dead_caron", FuncRequest(LFUN_ACCENT_CARON));
 896         kbmap->bind("~C-~S-~M-dead_cedilla", FuncRequest(LFUN_ACCENT_CEDILLA));
 897         kbmap->bind("~C-~S-~M-dead_abovering", FuncRequest(LFUN_ACCENT_CIRCLE));
 898         kbmap->bind("~C-~S-~M-dead_circumflex", FuncRequest(LFUN_ACCENT_CIRCUMFLEX));
 899         kbmap->bind("~C-~S-~M-dead_abovedot", FuncRequest(LFUN_ACCENT_DOT));
 900         kbmap->bind("~C-~S-~M-dead_grave", FuncRequest(LFUN_ACCENT_GRAVE));
 901         kbmap->bind("~C-~S-~M-dead_doubleacute", FuncRequest(LFUN_ACCENT_HUNGARIAN_UMLAUT));
 902         kbmap->bind("~C-~S-~M-dead_macron", FuncRequest(LFUN_ACCENT_MACRON));
 903         // nothing with this name
 904         // kbmap->bind("~C-~S-~M-dead_special_caron", LFUN_ACCENT_SPECIAL_CARON);
 905         kbmap->bind("~C-~S-~M-dead_tilde", FuncRequest(LFUN_ACCENT_TILDE));
 906         kbmap->bind("~C-~S-~M-dead_diaeresis", FuncRequest(LFUN_ACCENT_UMLAUT));
 907         // nothing with this name either...
 908         //kbmap->bind("~C-~S-~M-dead_underbar", FuncRequest(LFUN_ACCENT_UNDERBAR));
 909         kbmap->bind("~C-~S-~M-dead_belowdot", FuncRequest(LFUN_ACCENT_UNDERDOT));
 910         kbmap->bind("~C-~S-~M-dead_tie", FuncRequest(LFUN_ACCENT_TIE));
 911         kbmap->bind("~C-~S-~M-dead_ogonek",FuncRequest(LFUN_ACCENT_OGONEK));
 912 }
 913
 914
 915 namespace {
 916
 917 // return true if file does not exist or is older than configure.py.
 918 bool needsUpdate(string const & file)
 919 {
 920         static string const configure_script =
 921                 addName(package().system_support(), "configure.py");
 922         string const absfile =
 923                 addName(package().user_support(), file);
 924
 925         return (! fs::exists(absfile))
 926                 || (fs::last_write_time(configure_script)
 927                     > fs::last_write_time(absfile));
 928 }
 929
 930 }
 931
 932
 933 bool LyX::queryUserLyXDir(bool explicit_userdir)
 934 {
 935         // Does user directory exist?
 936         if (fs::exists(package().user_support()) &&
 937             fs::is_directory(package().user_support())) {
 938                 first_start = false;
 939
 940                 return needsUpdate("lyxrc.defaults")
 941                         || needsUpdate("textclass.lst")
 942                         || needsUpdate("packages.lst");
 943         }
 944
 945         first_start = !explicit_userdir;
 946
 947         // If the user specified explicitly a directory, ask whether
 948         // to create it. If the user says "no", then exit.
 949         if (explicit_userdir &&
 950             Alert::prompt(
 951                     _("Missing user LyX directory"),
 952                     bformat(_("You have specified a non-existent user "
 953                                            "LyX directory, %1$s.\n"
 954                                            "It is needed to keep your own configuration."),
 955                             from_utf8(package().user_support())),
 956                     1, 0,
 957                     _("&Create directory"),
 958                     _("&Exit LyX"))) {
 959                 lyxerr << to_utf8(_("No user LyX directory. Exiting.")) << endl;
 960                 earlyExit(EXIT_FAILURE);
 961         }
 962
 963         lyxerr << to_utf8(bformat(_("LyX: Creating directory %1$s"),
 964                           from_utf8(package().user_support())))
 965                << endl;
 966
 967         if (!createDirectory(package().user_support(), 0755)) {
 968                 // Failed, so let's exit.
 969                 lyxerr << to_utf8(_("Failed to create directory. Exiting."))
 970                        << endl;
 971                 earlyExit(EXIT_FAILURE);
 972         }
 973
 974         return true;
 975 }
 976
 977
 978 bool LyX::readRcFile(string const & name)
 979 {
 980         lyxerr[Debug::INIT] << "About to read " << name << "... ";
 981
 982         string const lyxrc_path = libFileSearch(string(), name);
 983         if (!lyxrc_path.empty()) {
 984
 985                 lyxerr[Debug::INIT] << "Found in " << lyxrc_path << endl;
 986
 987                 if (lyxrc.read(lyxrc_path) < 0) {
 988                         showFileError(name);
 989                         return false;
 990                 }
 991         } else
 992                 lyxerr[Debug::INIT] << "Not found." << lyxrc_path << endl;
 993         return true;
 994
 995 }
 996
 997
 998 // Read the ui file `name'
 999 bool LyX::readUIFile(string const & name)
1000 {
1001         enum Uitags {
1002                 ui_menuset = 1,
1003                 ui_toolbar,
1004                 ui_toolbars,
1005                 ui_include,
1006                 ui_last
1007         };
1008
1009         struct keyword_item uitags[ui_last - 1] = {
1010                 { "include", ui_include },
1011                 { "menuset", ui_menuset },
1012                 { "toolbar", ui_toolbar },
1013                 { "toolbars", ui_toolbars }
1014         };
1015
1016         // Ensure that a file is read only once (prevents include loops)
1017         static std::list<string> uifiles;
1018         std::list<string>::const_iterator it  = uifiles.begin();
1019         std::list<string>::const_iterator end = uifiles.end();
1020         it = std::find(it, end, name);
1021         if (it != end) {
1022                 lyxerr[Debug::INIT] << "UI file '" << name
1023                                     << "' has been read already. "
1024                                     << "Is this an include loop?"
1025                                     << endl;
1026                 return false;
1027         }
1028
1029         lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
1030
1031         string const ui_path = libFileSearch("ui", name, "ui");
1032
1033         if (ui_path.empty()) {
1034                 lyxerr[Debug::INIT] << "Could not find " << name << endl;
1035                 showFileError(name);
1036                 return false;
1037         }
1038         uifiles.push_back(name);
1039
1040         lyxerr[Debug::INIT] << "Found " << name
1041                             << " in " << ui_path << endl;
1042         LyXLex lex(uitags, ui_last - 1);
1043         lex.setFile(ui_path);
1044         if (!lex.isOK()) {
1045                 lyxerr << "Unable to set LyXLeX for ui file: " << ui_path
1046                        << endl;
1047         }
1048
1049         if (lyxerr.debugging(Debug::PARSER))
1050                 lex.printTable(lyxerr);
1051
1052         while (lex.isOK()) {
1053                 switch (lex.lex()) {
1054                 case ui_include: {
1055                         lex.next(true);
1056                         string const file = lex.getString();
1057                         if (!readUIFile(file))
1058                                 return false;
1059                         break;
1060                 }
1061                 case ui_menuset:
1062                         menubackend.read(lex);
1063                         break;
1064
1065                 case ui_toolbar:
1066                         toolbarbackend.read(lex);
1067                         break;
1068
1069                 case ui_toolbars:
1070                         toolbarbackend.readToolbars(lex);
1071                         break;
1072
1073                 default:
1074                         if (!rtrim(lex.getString()).empty())
1075                                 lex.printError("LyX::ReadUIFile: "
1076                                                "Unknown menu tag: `$$Token'");
1077                         break;
1078                 }
1079         }
1080         return true;
1081 }
1082
1083
1084 // Read the languages file `name'
1085 bool LyX::readLanguagesFile(string const & name)
1086 {
1087         lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
1088
1089         string const lang_path = libFileSearch(string(), name);
1090         if (lang_path.empty()) {
1091                 showFileError(name);
1092                 return false;
1093         }
1094         languages.read(lang_path);
1095         return true;
1096 }
1097
1098
1099 // Read the encodings file `name'
1100 bool LyX::readEncodingsFile(string const & name)
1101 {
1102         lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
1103
1104         string const enc_path = libFileSearch(string(), name);
1105         if (enc_path.empty()) {
1106                 showFileError(name);
1107                 return false;
1108         }
1109         encodings.read(enc_path);
1110         return true;
1111 }
1112
1113
1114 namespace {
1115
1116 string batch;
1117
1118 /// return the the number of arguments consumed
1119 typedef boost::function<int(string const &, string const &)> cmd_helper;
1120
1121 int parse_dbg(string const & arg, string const &)
1122 {
1123         if (arg.empty()) {
1124                 lyxerr << to_utf8(_("List of supported debug flags:")) << endl;
1125                 Debug::showTags(lyxerr);
1126                 exit(0);
1127         }
1128         lyxerr << to_utf8(bformat(_("Setting debug level to %1$s"), from_utf8(arg))) << endl;
1129
1130         lyxerr.level(Debug::value(arg));
1131         Debug::showLevel(lyxerr, lyxerr.level());
1132         return 1;
1133 }
1134
1135
1136 int parse_help(string const &, string const &)
1137 {
1138         lyxerr <<
1139                 to_utf8(_("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
1140                   "Command line switches (case sensitive):\n"
1141                   "\t-help              summarize LyX usage\n"
1142                   "\t-userdir dir       set user directory to dir\n"
1143                   "\t-sysdir dir        set system directory to dir\n"
1144                   "\t-geometry WxH+X+Y  set geometry of the main window\n"
1145                   "\t-dbg feature[,feature]...\n"
1146                   "                  select the features to debug.\n"
1147                   "                  Type `lyx -dbg' to see the list of features\n"
1148                   "\t-x [--execute] command\n"
1149                   "                  where command is a lyx command.\n"
1150                   "\t-e [--export] fmt\n"
1151                   "                  where fmt is the export format of choice.\n"
1152                   "\t-i [--import] fmt file.xxx\n"
1153                   "                  where fmt is the import format of choice\n"
1154                   "                  and file.xxx is the file to be imported.\n"
1155                   "\t-version        summarize version and build info\n"
1156                                "Check the LyX man page for more details.")) << endl;
1157         exit(0);
1158         return 0;
1159 }
1160
1161 int parse_version(string const &, string const &)
1162 {
1163         lyxerr << "LyX " << lyx_version
1164                << " (" << lyx_release_date << ")" << endl;
1165         lyxerr << "Built on " << __DATE__ << ", " << __TIME__ << endl;
1166
1167         lyxerr << lyx_version_info << endl;
1168         exit(0);
1169         return 0;
1170 }
1171
1172 int parse_sysdir(string const & arg, string const &)
1173 {
1174         if (arg.empty()) {
1175                 lyxerr << to_utf8(_("Missing directory for -sysdir switch")) << endl;
1176                 exit(1);
1177         }
1178         cl_system_support = arg;
1179         return 1;
1180 }
1181
1182 int parse_userdir(string const & arg, string const &)
1183 {
1184         if (arg.empty()) {
1185                 lyxerr << to_utf8(_("Missing directory for -userdir switch")) << endl;
1186                 exit(1);
1187         }
1188         cl_user_support = arg;
1189         return 1;
1190 }
1191
1192 int parse_execute(string const & arg, string const &)
1193 {
1194         if (arg.empty()) {
1195                 lyxerr << to_utf8(_("Missing command string after --execute switch")) << endl;
1196                 exit(1);
1197         }
1198         batch = arg;
1199         return 1;
1200 }
1201
1202 int parse_export(string const & type, string const &)
1203 {
1204         if (type.empty()) {
1205                 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1206                                          "--export switch")) << endl;
1207                 exit(1);
1208         }
1209         batch = "buffer-export " + type;
1210         use_gui = false;
1211         return 1;
1212 }
1213
1214 int parse_import(string const & type, string const & file)
1215 {
1216         if (type.empty()) {
1217                 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1218                                          "--import switch")) << endl;
1219                 exit(1);
1220         }
1221         if (file.empty()) {
1222                 lyxerr << to_utf8(_("Missing filename for --import")) << endl;
1223                 exit(1);
1224         }
1225
1226         batch = "buffer-import " + type + ' ' + file;
1227         return 2;
1228 }
1229
1230 } // namespace anon
1231
1232
1233 void LyX::easyParse(int & argc, char * argv[])
1234 {
1235         std::map<string, cmd_helper> cmdmap;
1236
1237         cmdmap["-dbg"] = parse_dbg;
1238         cmdmap["-help"] = parse_help;
1239         cmdmap["--help"] = parse_help;
1240         cmdmap["-version"] = parse_version;
1241         cmdmap["--version"] = parse_version;
1242         cmdmap["-sysdir"] = parse_sysdir;
1243         cmdmap["-userdir"] = parse_userdir;
1244         cmdmap["-x"] = parse_execute;
1245         cmdmap["--execute"] = parse_execute;
1246         cmdmap["-e"] = parse_export;
1247         cmdmap["--export"] = parse_export;
1248         cmdmap["-i"] = parse_import;
1249         cmdmap["--import"] = parse_import;
1250
1251         for (int i = 1; i < argc; ++i) {
1252                 std::map<string, cmd_helper>::const_iterator it
1253                         = cmdmap.find(argv[i]);
1254
1255                 // check for X11 -geometry option
1256                 if (support::compare(argv[i], "-geometry") == 0)
1257                         geometryOption_ = true;
1258
1259                 // don't complain if not found - may be parsed later
1260                 if (it == cmdmap.end())
1261                         continue;
1262
1263                 string arg((i + 1 < argc) ? argv[i + 1] : "");
1264                 string arg2((i + 2 < argc) ? argv[i + 2] : "");
1265
1266                 int const remove = 1 + it->second(arg, arg2);
1267
1268                 // Now, remove used arguments by shifting
1269                 // the following ones remove places down.
1270                 argc -= remove;
1271                 for (int j = i; j < argc; ++j)
1272                         argv[j] = argv[j + remove];
1273                 --i;
1274         }
1275
1276         batch_command = batch;
1277 }
1278
1279
1280 FuncStatus getStatus(FuncRequest const & action)
1281 {
1282         return LyX::ref().lyxFunc().getStatus(action);
1283 }
1284
1285
1286 void dispatch(FuncRequest const & action)
1287 {
1288         LyX::ref().lyxFunc().dispatch(action);
1289 }
1290
1291
1292 BufferList & theBufferList()
1293 {
1294         return LyX::ref().bufferList();
1295 }
1296
1297
1298 LyXFunc & theLyXFunc()
1299 {
1300         return LyX::ref().lyxFunc();
1301 }
1302
1303
1304 LyXServer & theLyXServer()
1305 {
1306         // FIXME: this should not be use_gui dependent
1307         BOOST_ASSERT(use_gui);
1308         return LyX::ref().server();
1309 }
1310
1311
1312 LyXServerSocket & theLyXServerSocket()
1313 {
1314         // FIXME: this should not be use_gui dependent
1315         BOOST_ASSERT(use_gui);
1316         return LyX::ref().socket();
1317 }
1318
1319
1320 kb_keymap & theTopLevelKeymap()
1321 {
1322         BOOST_ASSERT(use_gui);
1323         return LyX::ref().topLevelKeymap();
1324 }
1325
1326
1327 IconvProcessor & utf8ToUcs4()
1328 {
1329         return LyX::ref().iconvProcessor();
1330 }
1331
1332 } // namespace lyx