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                 theApp = 0;
 421         }
 422 }
 423
 424
 425 int LyX::execBatchCommands(int & argc, char * argv[],
 426         vector<string> & files)
 427 {
 428         // Initialization of LyX (reads lyxrc and more)
 429         lyxerr[Debug::INIT] << "Initializing LyX::init..." << endl;
 430         bool success = init();
 431         lyxerr[Debug::INIT] << "Initializing LyX::init...done" << endl;
 432         if (!success)
 433                 return EXIT_FAILURE;
 434
 435         for (int argi = argc - 1; argi >= 1; --argi) {
 436                 // check for any remaining extra arguments other than
 437                 // document file names. These will be passed out to the
 438                 // frontend.
 439                 if (argv[argi][0] == '-')
 440                         continue;
 441                 files.push_back(os::internal_path(argv[argi]));
 442         }
 443
 444         if (first_start)
 445                 files.push_back(i18nLibFileSearch("examples", "splash.lyx"));
 446
 447         // Execute batch commands if available
 448         if (!batch_command.empty()) {
 449
 450                 lyxerr[Debug::INIT] << "About to handle -x '"
 451                        << batch_command << '\'' << endl;
 452
 453                 Buffer * last_loaded = 0;
 454
 455                 vector<string>::const_iterator it = files.begin();
 456                 vector<string>::const_iterator end = files.end();
 457
 458                 for (; it != end; ++it) {
 459                         // get absolute path of file and add ".lyx" to
 460                         // the filename if necessary
 461                         string s = fileSearch(string(), *it, "lyx");
 462                         if (s.empty()) {
 463                                 Buffer * const b = newFile(*it, string(), true);
 464                                 if (b)
 465                                         last_loaded = b;
 466                         } else {
 467                                 Buffer * buf = pimpl_->buffer_list_.newBuffer(s, false);
 468                                 if (loadLyXFile(buf, s)) {
 469                                         last_loaded = buf;
 470                                         ErrorList const & el = buf->errorList("Parse");
 471                                         if (!el.empty())
 472                                                 for_each(el.begin(), el.end(),
 473                                                         boost::bind(&LyX::printError, this, _1));
 474                                 }
 475                                 else
 476                                         pimpl_->buffer_list_.release(buf);
 477                         }
 478                 }
 479
 480                 // try to dispatch to last loaded buffer first
 481                 if (last_loaded) {
 482                         success = false;
 483                         if (last_loaded->dispatch(batch_command, &success)) {
 484                                 prepareExit();
 485                                 return !success;
 486                         }
 487                 }
 488                 files.clear(); // the files are already loaded
 489         }
 490
 491         return EXIT_SUCCESS;
 492 }
 493
 494
 495 void LyX::restoreGuiSession(vector<string> const & files)
 496 {
 497         LyXView * view = newLyXView();
 498
 499         // load files
 500         for_each(files.begin(), files.end(),
 501                 bind(&LyXView::loadLyXFile, view, _1, true));
 502
 503         // if a file is specified, I assume that user wants to edit *that* file
 504         if (files.empty() && lyxrc.load_session) {
 505                 vector<string> const & lastopened = pimpl_->session_->lastOpened().getfiles();
 506                 // do not add to the lastfile list since these files are restored from
 507                 // last seesion, and should be already there (regular files), or should
 508                 // not be added at all (help files).
 509                 for_each(lastopened.begin(), lastopened.end(),
 510                         bind(&LyXView::loadLyXFile, view, _1, false));
 511         }
 512         // clear this list to save a few bytes of RAM
 513         pimpl_->session_->lastOpened().clear();
 514 }
 515
 516
 517 LyXView * LyX::newLyXView()
 518 {
 519         if (!lyx::use_gui)
 520                 return 0;
 521
 522         // determine windows size and position, from lyxrc and/or session
 523         // initial geometry
 524         unsigned int width = 690;
 525         unsigned int height = 510;
 526         bool maximize = false;
 527         // first try lyxrc
 528         if (lyxrc.geometry_width != 0 && lyxrc.geometry_height != 0 ) {
 529                 width = lyxrc.geometry_width;
 530                 height = lyxrc.geometry_height;
 531         }
 532         // if lyxrc returns (0,0), then use session info
 533         else {
 534                 string val = session().sessionInfo().load("WindowWidth");
 535                 if (!val.empty())
 536                         width = convert<unsigned int>(val);
 537                 val = session().sessionInfo().load("WindowHeight");
 538                 if (!val.empty())
 539                         height = convert<unsigned int>(val);
 540                 if (session().sessionInfo().load("WindowIsMaximized") == "yes")
 541                         maximize = true;
 542         }
 543
 544         // if user wants to restore window position
 545         int posx = -1;
 546         int posy = -1;
 547         if (lyxrc.geometry_xysaved) {
 548                 string val = session().sessionInfo().load("WindowPosX");
 549                 if (!val.empty())
 550                         posx = convert<int>(val);
 551                 val = session().sessionInfo().load("WindowPosY");
 552                 if (!val.empty())
 553                         posy = convert<int>(val);
 554         }
 555
 556         if (geometryOption_) {
 557                 width = 0;
 558                 height = 0;
 559         }
 560         // create the main window
 561         LyXView * view = &pimpl_->application_->createView(width, height, posx, posy, maximize);
 562
 563         return view;
 564 }
 565
 566 /*
 567 Signals and Windows
 568 ===================
 569 The SIGHUP signal does not exist on Windows and does not need to be handled.
 570
 571 Windows handles SIGFPE and SIGSEGV signals as expected.
 572
 573 Cntl+C interrupts (mapped to SIGINT by Windows' POSIX compatability layer)
 574 cause a new thread to be spawned. This may well result in unexpected
 575 behaviour by the single-threaded LyX.
 576
 577 SIGTERM signals will come only from another process actually sending
 578 that signal using 'raise' in Windows' POSIX compatability layer. It will
 579 not come from the general "terminate process" methods that everyone
 580 actually uses (and which can't be trapped). Killing an app 'politely' on
 581 Windows involves first sending a WM_CLOSE message, something that is
 582 caught already by the Qt frontend.
 583
 584 For more information see:
 585
 586 http://aspn.activestate.com/ASPN/Mail/Message/ActiveTcl/2034055
 587 ...signals are mostly useless on Windows for a variety of reasons that are
 588 Windows specific...
 589
 590 'UNIX Application Migration Guide, Chapter 9'
 591 http://msdn.microsoft.com/library/en-us/dnucmg/html/UCMGch09.asp
 592
 593 'How To Terminate an Application "Cleanly" in Win32'
 594 http://support.microsoft.com/default.aspx?scid=kb;en-us;178893
 595 */
 596 extern "C" {
 597
 598 static void error_handler(int err_sig)
 599 {
 600         // Throw away any signals other than the first one received.
 601         static sig_atomic_t handling_error = false;
 602         if (handling_error)
 603                 return;
 604         handling_error = true;
 605
 606         // We have received a signal indicating a fatal error, so
 607         // try and save the data ASAP.
 608         LyX::cref().emergencyCleanup();
 609
 610         // These lyxerr calls may or may not work:
 611
 612         // Signals are asynchronous, so the main program may be in a very
 613         // fragile state when a signal is processed and thus while a signal
 614         // handler function executes.
 615         // In general, therefore, we should avoid performing any
 616         // I/O operations or calling most library and system functions from
 617         // signal handlers.
 618
 619         // This shouldn't matter here, however, as we've already invoked
 620         // emergencyCleanup.
 621         switch (err_sig) {
 622 #ifdef SIGHUP
 623         case SIGHUP:
 624                 lyxerr << "\nlyx: SIGHUP signal caught\nBye." << endl;
 625                 break;
 626 #endif
 627         case SIGFPE:
 628                 lyxerr << "\nlyx: SIGFPE signal caught\nBye." << endl;
 629                 break;
 630         case SIGSEGV:
 631                 lyxerr << "\nlyx: SIGSEGV signal caught\n"
 632                           "Sorry, you have found a bug in LyX. "
 633                           "Please read the bug-reporting instructions "
 634                           "in Help->Introduction and send us a bug report, "
 635                           "if necessary. Thanks !\nBye." << endl;
 636                 break;
 637         case SIGINT:
 638         case SIGTERM:
 639                 // no comments
 640                 break;
 641         }
 642
 643         // Deinstall the signal handlers
 644 #ifdef SIGHUP
 645         signal(SIGHUP, SIG_DFL);
 646 #endif
 647         signal(SIGINT, SIG_DFL);
 648         signal(SIGFPE, SIG_DFL);
 649         signal(SIGSEGV, SIG_DFL);
 650         signal(SIGTERM, SIG_DFL);
 651
 652 #ifdef SIGHUP
 653         if (err_sig == SIGSEGV ||
 654             (err_sig != SIGHUP && !getEnv("LYXDEBUG").empty()))
 655 #else
 656         if (err_sig == SIGSEGV || !getEnv("LYXDEBUG").empty())
 657 #endif
 658                 support::abort();
 659         exit(0);
 660 }
 661
 662 }
 663
 664
 665 void LyX::printError(ErrorItem const & ei)
 666 {
 667         docstring tmp = _("LyX: ") + ei.error + char_type(':')
 668                 + ei.description;
 669         std::cerr << to_utf8(tmp) << std::endl;
 670 }
 671
 672
 673 void LyX::initGuiFont()
 674 {
 675         if (lyxrc.roman_font_name.empty())
 676                 lyxrc.roman_font_name = pimpl_->application_->romanFontName();
 677
 678         if (lyxrc.sans_font_name.empty())
 679                 lyxrc.sans_font_name = pimpl_->application_->sansFontName();
 680
 681         if (lyxrc.typewriter_font_name.empty())
 682                 lyxrc.typewriter_font_name
 683                         = pimpl_->application_->typewriterFontName();
 684 }
 685
 686
 687 bool LyX::init()
 688 {
 689 #ifdef SIGHUP
 690         signal(SIGHUP, error_handler);
 691 #endif
 692         signal(SIGFPE, error_handler);
 693         signal(SIGSEGV, error_handler);
 694         signal(SIGINT, error_handler);
 695         signal(SIGTERM, error_handler);
 696         // SIGPIPE can be safely ignored.
 697
 698         lyxrc.tempdir_path = package().temp_dir();
 699         lyxrc.document_path = package().document_dir();
 700
 701         if (lyxrc.template_path.empty()) {
 702                 lyxrc.template_path = addPath(package().system_support(),
 703                                               "templates");
 704         }
 705
 706         //
 707         // Read configuration files
 708         //
 709
 710         // This one may have been distributed along with LyX.
 711         if (!readRcFile("lyxrc.dist"))
 712                 return false;
 713
 714         // Set the PATH correctly.
 715 #if !defined (USE_POSIX_PACKAGING)
 716         // Add the directory containing the LyX executable to the path
 717         // so that LyX can find things like tex2lyx.
 718         if (package().build_support().empty())
 719                 prependEnvPath("PATH", package().binary_dir());
 720 #endif
 721         if (!lyxrc.path_prefix.empty())
 722                 prependEnvPath("PATH", lyxrc.path_prefix);
 723
 724         // Check that user LyX directory is ok.
 725         if (queryUserLyXDir(package().explicit_user_support()))
 726                 reconfigureUserLyXDir();
 727
 728         // no need for a splash when there is no GUI
 729         if (!use_gui) {
 730                 first_start = false;
 731         }
 732
 733         // This one is generated in user_support directory by lib/configure.py.
 734         if (!readRcFile("lyxrc.defaults"))
 735                 return false;
 736
 737         // Query the OS to know what formats are viewed natively
 738         formats.setAutoOpen();
 739
 740         // Read lyxrc.dist again to be able to override viewer auto-detection.
 741         readRcFile("lyxrc.dist");
 742
 743         system_lyxrc = lyxrc;
 744         system_formats = formats;
 745         system_converters = converters;
 746         system_movers = movers;
 747         system_lcolor = lcolor;
 748
 749         // This one is edited through the preferences dialog.
 750         if (!readRcFile("preferences"))
 751                 return false;
 752
 753         if (!readEncodingsFile("encodings"))
 754                 return false;
 755         if (!readLanguagesFile("languages"))
 756                 return false;
 757
 758         // Load the layouts
 759         lyxerr[Debug::INIT] << "Reading layouts..." << endl;
 760         if (!LyXSetStyle())
 761                 return false;
 762
 763         if (use_gui) {
 764                 // Set up bindings
 765                 pimpl_->toplevel_keymap_.reset(new kb_keymap);
 766                 defaultKeyBindings(pimpl_->toplevel_keymap_.get());
 767                 pimpl_->toplevel_keymap_->read(lyxrc.bind_file);
 768
 769                 pimpl_->lyxfunc_.initKeySequences(pimpl_->toplevel_keymap_.get());
 770
 771                 // Read menus
 772                 if (!readUIFile(lyxrc.ui_file))
 773                         return false;
 774         }
 775
 776         if (lyxerr.debugging(Debug::LYXRC))
 777                 lyxrc.print();
 778
 779         os::windows_style_tex_paths(lyxrc.windows_style_tex_paths);
 780         if (!lyxrc.path_prefix.empty())
 781                 prependEnvPath("PATH", lyxrc.path_prefix);
 782
 783         if (fs::exists(lyxrc.document_path) &&
 784             fs::is_directory(lyxrc.document_path))
 785                 package().document_dir() = lyxrc.document_path;
 786
 787         package().temp_dir() = createLyXTmpDir(lyxrc.tempdir_path);
 788         if (package().temp_dir().empty()) {
 789                 Alert::error(_("Could not create temporary directory"),
 790                              bformat(_("Could not create a temporary directory in\n"
 791                                                     "%1$s. Make sure that this\n"
 792                                                     "path exists and is writable and try again."),
 793                                      from_utf8(lyxrc.tempdir_path)));
 794                 // createLyXTmpDir() tries sufficiently hard to create a
 795                 // usable temp dir, so the probability to come here is
 796                 // close to zero. We therefore don't try to overcome this
 797                 // problem with e.g. asking the user for a new path and
 798                 // trying again but simply exit.
 799                 return false;
 800         }
 801
 802         if (lyxerr.debugging(Debug::INIT)) {
 803                 lyxerr << "LyX tmp dir: `" << package().temp_dir() << '\'' << endl;
 804         }
 805
 806         lyxerr[Debug::INIT] << "Reading session information '.lyx/session'..." << endl;
 807         pimpl_->session_.reset(new Session(lyxrc.num_lastfiles));
 808
 809         // This must happen after package initialization and after lyxrc is
 810         // read, therefore it can't be done by a static object.
 811         ConverterCache::init();
 812
 813         return true;
 814 }
 815
 816
 817 void LyX::defaultKeyBindings(kb_keymap  * kbmap)
 818 {
 819         kbmap->bind("Right", FuncRequest(LFUN_CHAR_FORWARD));
 820         kbmap->bind("Left", FuncRequest(LFUN_CHAR_BACKWARD));
 821         kbmap->bind("Up", FuncRequest(LFUN_UP));
 822         kbmap->bind("Down", FuncRequest(LFUN_DOWN));
 823
 824         kbmap->bind("Tab", FuncRequest(LFUN_CELL_FORWARD));
 825         kbmap->bind("C-Tab", FuncRequest(LFUN_CELL_SPLIT));
 826         kbmap->bind("~S-ISO_Left_Tab", FuncRequest(LFUN_CELL_BACKWARD));
 827         kbmap->bind("~S-BackTab", FuncRequest(LFUN_CELL_BACKWARD));
 828
 829         kbmap->bind("Home", FuncRequest(LFUN_LINE_BEGIN));
 830         kbmap->bind("End", FuncRequest(LFUN_LINE_END));
 831         kbmap->bind("Prior", FuncRequest(LFUN_SCREEN_UP));
 832         kbmap->bind("Next", FuncRequest(LFUN_SCREEN_DOWN));
 833
 834         kbmap->bind("Return", FuncRequest(LFUN_BREAK_PARAGRAPH));
 835         //kbmap->bind("~C-~S-~M-nobreakspace", FuncRequest(LFUN_PROTECTEDSPACE));
 836
 837         kbmap->bind("Delete", FuncRequest(LFUN_CHAR_DELETE_FORWARD));
 838         kbmap->bind("BackSpace", FuncRequest(LFUN_CHAR_DELETE_BACKWARD));
 839
 840         // kbmap->bindings to enable the use of the numeric keypad
 841         // e.g. Num Lock set
 842         //kbmap->bind("KP_0", FuncRequest(LFUN_SELF_INSERT));
 843         //kbmap->bind("KP_Decimal", FuncRequest(LFUN_SELF_INSERT));
 844         kbmap->bind("KP_Enter", FuncRequest(LFUN_BREAK_PARAGRAPH));
 845         //kbmap->bind("KP_1", FuncRequest(LFUN_SELF_INSERT));
 846         //kbmap->bind("KP_2", FuncRequest(LFUN_SELF_INSERT));
 847         //kbmap->bind("KP_3", FuncRequest(LFUN_SELF_INSERT));
 848         //kbmap->bind("KP_4", FuncRequest(LFUN_SELF_INSERT));
 849         //kbmap->bind("KP_5", FuncRequest(LFUN_SELF_INSERT));
 850         //kbmap->bind("KP_6", FuncRequest(LFUN_SELF_INSERT));
 851         //kbmap->bind("KP_Add", FuncRequest(LFUN_SELF_INSERT));
 852         //kbmap->bind("KP_7", FuncRequest(LFUN_SELF_INSERT));
 853         //kbmap->bind("KP_8", FuncRequest(LFUN_SELF_INSERT));
 854         //kbmap->bind("KP_9", FuncRequest(LFUN_SELF_INSERT));
 855         //kbmap->bind("KP_Divide", FuncRequest(LFUN_SELF_INSERT));
 856         //kbmap->bind("KP_Multiply", FuncRequest(LFUN_SELF_INSERT));
 857         //kbmap->bind("KP_Subtract", FuncRequest(LFUN_SELF_INSERT));
 858         kbmap->bind("KP_Right", FuncRequest(LFUN_CHAR_FORWARD));
 859         kbmap->bind("KP_Left", FuncRequest(LFUN_CHAR_BACKWARD));
 860         kbmap->bind("KP_Up", FuncRequest(LFUN_UP));
 861         kbmap->bind("KP_Down", FuncRequest(LFUN_DOWN));
 862         kbmap->bind("KP_Home", FuncRequest(LFUN_LINE_BEGIN));
 863         kbmap->bind("KP_End", FuncRequest(LFUN_LINE_END));
 864         kbmap->bind("KP_Prior", FuncRequest(LFUN_SCREEN_UP));
 865         kbmap->bind("KP_Next", FuncRequest(LFUN_SCREEN_DOWN));
 866 }
 867
 868
 869 void LyX::emergencyCleanup() const
 870 {
 871         // what to do about tmpfiles is non-obvious. we would
 872         // like to delete any we find, but our lyxdir might
 873         // contain documents etc. which might be helpful on
 874         // a crash
 875
 876         pimpl_->buffer_list_.emergencyWriteAll();
 877         if (use_gui) {
 878                 pimpl_->lyx_server_->emergencyCleanup();
 879                 pimpl_->lyx_server_.reset();
 880                 pimpl_->lyx_socket_.reset();
 881         }
 882 }
 883
 884
 885 void LyX::deadKeyBindings(kb_keymap * kbmap)
 886 {
 887         // bindKeyings for transparent handling of deadkeys
 888         // The keysyms are gotten from XFree86 X11R6
 889         kbmap->bind("~C-~S-~M-dead_acute", FuncRequest(LFUN_ACCENT_ACUTE));
 890         kbmap->bind("~C-~S-~M-dead_breve", FuncRequest(LFUN_ACCENT_BREVE));
 891         kbmap->bind("~C-~S-~M-dead_caron", FuncRequest(LFUN_ACCENT_CARON));
 892         kbmap->bind("~C-~S-~M-dead_cedilla", FuncRequest(LFUN_ACCENT_CEDILLA));
 893         kbmap->bind("~C-~S-~M-dead_abovering", FuncRequest(LFUN_ACCENT_CIRCLE));
 894         kbmap->bind("~C-~S-~M-dead_circumflex", FuncRequest(LFUN_ACCENT_CIRCUMFLEX));
 895         kbmap->bind("~C-~S-~M-dead_abovedot", FuncRequest(LFUN_ACCENT_DOT));
 896         kbmap->bind("~C-~S-~M-dead_grave", FuncRequest(LFUN_ACCENT_GRAVE));
 897         kbmap->bind("~C-~S-~M-dead_doubleacute", FuncRequest(LFUN_ACCENT_HUNGARIAN_UMLAUT));
 898         kbmap->bind("~C-~S-~M-dead_macron", FuncRequest(LFUN_ACCENT_MACRON));
 899         // nothing with this name
 900         // kbmap->bind("~C-~S-~M-dead_special_caron", LFUN_ACCENT_SPECIAL_CARON);
 901         kbmap->bind("~C-~S-~M-dead_tilde", FuncRequest(LFUN_ACCENT_TILDE));
 902         kbmap->bind("~C-~S-~M-dead_diaeresis", FuncRequest(LFUN_ACCENT_UMLAUT));
 903         // nothing with this name either...
 904         //kbmap->bind("~C-~S-~M-dead_underbar", FuncRequest(LFUN_ACCENT_UNDERBAR));
 905         kbmap->bind("~C-~S-~M-dead_belowdot", FuncRequest(LFUN_ACCENT_UNDERDOT));
 906         kbmap->bind("~C-~S-~M-dead_tie", FuncRequest(LFUN_ACCENT_TIE));
 907         kbmap->bind("~C-~S-~M-dead_ogonek",FuncRequest(LFUN_ACCENT_OGONEK));
 908 }
 909
 910
 911 namespace {
 912
 913 // return true if file does not exist or is older than configure.py.
 914 bool needsUpdate(string const & file)
 915 {
 916         static string const configure_script =
 917                 addName(package().system_support(), "configure.py");
 918         string const absfile =
 919                 addName(package().user_support(), file);
 920
 921         return (! fs::exists(absfile))
 922                 || (fs::last_write_time(configure_script)
 923                     > fs::last_write_time(absfile));
 924 }
 925
 926 }
 927
 928
 929 bool LyX::queryUserLyXDir(bool explicit_userdir)
 930 {
 931         // Does user directory exist?
 932         if (fs::exists(package().user_support()) &&
 933             fs::is_directory(package().user_support())) {
 934                 first_start = false;
 935
 936                 return needsUpdate("lyxrc.defaults")
 937                         || needsUpdate("textclass.lst")
 938                         || needsUpdate("packages.lst");
 939         }
 940
 941         first_start = !explicit_userdir;
 942
 943         // If the user specified explicitly a directory, ask whether
 944         // to create it. If the user says "no", then exit.
 945         if (explicit_userdir &&
 946             Alert::prompt(
 947                     _("Missing user LyX directory"),
 948                     bformat(_("You have specified a non-existent user "
 949                                            "LyX directory, %1$s.\n"
 950                                            "It is needed to keep your own configuration."),
 951                             from_utf8(package().user_support())),
 952                     1, 0,
 953                     _("&Create directory"),
 954                     _("&Exit LyX"))) {
 955                 lyxerr << to_utf8(_("No user LyX directory. Exiting.")) << endl;
 956                 earlyExit(EXIT_FAILURE);
 957         }
 958
 959         lyxerr << to_utf8(bformat(_("LyX: Creating directory %1$s"),
 960                           from_utf8(package().user_support())))
 961                << endl;
 962
 963         if (!createDirectory(package().user_support(), 0755)) {
 964                 // Failed, so let's exit.
 965                 lyxerr << to_utf8(_("Failed to create directory. Exiting."))
 966                        << endl;
 967                 earlyExit(EXIT_FAILURE);
 968         }
 969
 970         return true;
 971 }
 972
 973
 974 bool LyX::readRcFile(string const & name)
 975 {
 976         lyxerr[Debug::INIT] << "About to read " << name << "... ";
 977
 978         string const lyxrc_path = libFileSearch(string(), name);
 979         if (!lyxrc_path.empty()) {
 980
 981                 lyxerr[Debug::INIT] << "Found in " << lyxrc_path << endl;
 982
 983                 if (lyxrc.read(lyxrc_path) < 0) {
 984                         showFileError(name);
 985                         return false;
 986                 }
 987         } else
 988                 lyxerr[Debug::INIT] << "Not found." << lyxrc_path << endl;
 989         return true;
 990
 991 }
 992
 993
 994 // Read the ui file `name'
 995 bool LyX::readUIFile(string const & name)
 996 {
 997         enum Uitags {
 998                 ui_menuset = 1,
 999                 ui_toolbar,
1000                 ui_toolbars,
1001                 ui_include,
1002                 ui_last
1003         };
1004
1005         struct keyword_item uitags[ui_last - 1] = {
1006                 { "include", ui_include },
1007                 { "menuset", ui_menuset },
1008                 { "toolbar", ui_toolbar },
1009                 { "toolbars", ui_toolbars }
1010         };
1011
1012         // Ensure that a file is read only once (prevents include loops)
1013         static std::list<string> uifiles;
1014         std::list<string>::const_iterator it  = uifiles.begin();
1015         std::list<string>::const_iterator end = uifiles.end();
1016         it = std::find(it, end, name);
1017         if (it != end) {
1018                 lyxerr[Debug::INIT] << "UI file '" << name
1019                                     << "' has been read already. "
1020                                     << "Is this an include loop?"
1021                                     << endl;
1022                 return false;
1023         }
1024
1025         lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
1026
1027         string const ui_path = libFileSearch("ui", name, "ui");
1028
1029         if (ui_path.empty()) {
1030                 lyxerr[Debug::INIT] << "Could not find " << name << endl;
1031                 showFileError(name);
1032                 return false;
1033         }
1034         uifiles.push_back(name);
1035
1036         lyxerr[Debug::INIT] << "Found " << name
1037                             << " in " << ui_path << endl;
1038         LyXLex lex(uitags, ui_last - 1);
1039         lex.setFile(ui_path);
1040         if (!lex.isOK()) {
1041                 lyxerr << "Unable to set LyXLeX for ui file: " << ui_path
1042                        << endl;
1043         }
1044
1045         if (lyxerr.debugging(Debug::PARSER))
1046                 lex.printTable(lyxerr);
1047
1048         while (lex.isOK()) {
1049                 switch (lex.lex()) {
1050                 case ui_include: {
1051                         lex.next(true);
1052                         string const file = lex.getString();
1053                         if (!readUIFile(file))
1054                                 return false;
1055                         break;
1056                 }
1057                 case ui_menuset:
1058                         menubackend.read(lex);
1059                         break;
1060
1061                 case ui_toolbar:
1062                         toolbarbackend.read(lex);
1063                         break;
1064
1065                 case ui_toolbars:
1066                         toolbarbackend.readToolbars(lex);
1067                         break;
1068
1069                 default:
1070                         if (!rtrim(lex.getString()).empty())
1071                                 lex.printError("LyX::ReadUIFile: "
1072                                                "Unknown menu tag: `$$Token'");
1073                         break;
1074                 }
1075         }
1076         return true;
1077 }
1078
1079
1080 // Read the languages file `name'
1081 bool LyX::readLanguagesFile(string const & name)
1082 {
1083         lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
1084
1085         string const lang_path = libFileSearch(string(), name);
1086         if (lang_path.empty()) {
1087                 showFileError(name);
1088                 return false;
1089         }
1090         languages.read(lang_path);
1091         return true;
1092 }
1093
1094
1095 // Read the encodings file `name'
1096 bool LyX::readEncodingsFile(string const & name)
1097 {
1098         lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
1099
1100         string const enc_path = libFileSearch(string(), name);
1101         if (enc_path.empty()) {
1102                 showFileError(name);
1103                 return false;
1104         }
1105         encodings.read(enc_path);
1106         return true;
1107 }
1108
1109
1110 namespace {
1111
1112 string batch;
1113
1114 /// return the the number of arguments consumed
1115 typedef boost::function<int(string const &, string const &)> cmd_helper;
1116
1117 int parse_dbg(string const & arg, string const &)
1118 {
1119         if (arg.empty()) {
1120                 lyxerr << to_utf8(_("List of supported debug flags:")) << endl;
1121                 Debug::showTags(lyxerr);
1122                 exit(0);
1123         }
1124         lyxerr << to_utf8(bformat(_("Setting debug level to %1$s"), from_utf8(arg))) << endl;
1125
1126         lyxerr.level(Debug::value(arg));
1127         Debug::showLevel(lyxerr, lyxerr.level());
1128         return 1;
1129 }
1130
1131
1132 int parse_help(string const &, string const &)
1133 {
1134         lyxerr <<
1135                 to_utf8(_("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
1136                   "Command line switches (case sensitive):\n"
1137                   "\t-help              summarize LyX usage\n"
1138                   "\t-userdir dir       set user directory to dir\n"
1139                   "\t-sysdir dir        set system directory to dir\n"
1140                   "\t-geometry WxH+X+Y  set geometry of the main window\n"
1141                   "\t-dbg feature[,feature]...\n"
1142                   "                  select the features to debug.\n"
1143                   "                  Type `lyx -dbg' to see the list of features\n"
1144                   "\t-x [--execute] command\n"
1145                   "                  where command is a lyx command.\n"
1146                   "\t-e [--export] fmt\n"
1147                   "                  where fmt is the export format of choice.\n"
1148                   "\t-i [--import] fmt file.xxx\n"
1149                   "                  where fmt is the import format of choice\n"
1150                   "                  and file.xxx is the file to be imported.\n"
1151                   "\t-version        summarize version and build info\n"
1152                                "Check the LyX man page for more details.")) << endl;
1153         exit(0);
1154         return 0;
1155 }
1156
1157 int parse_version(string const &, string const &)
1158 {
1159         lyxerr << "LyX " << lyx_version
1160                << " (" << lyx_release_date << ")" << endl;
1161         lyxerr << "Built on " << __DATE__ << ", " << __TIME__ << endl;
1162
1163         lyxerr << lyx_version_info << endl;
1164         exit(0);
1165         return 0;
1166 }
1167
1168 int parse_sysdir(string const & arg, string const &)
1169 {
1170         if (arg.empty()) {
1171                 lyxerr << to_utf8(_("Missing directory for -sysdir switch")) << endl;
1172                 exit(1);
1173         }
1174         cl_system_support = arg;
1175         return 1;
1176 }
1177
1178 int parse_userdir(string const & arg, string const &)
1179 {
1180         if (arg.empty()) {
1181                 lyxerr << to_utf8(_("Missing directory for -userdir switch")) << endl;
1182                 exit(1);
1183         }
1184         cl_user_support = arg;
1185         return 1;
1186 }
1187
1188 int parse_execute(string const & arg, string const &)
1189 {
1190         if (arg.empty()) {
1191                 lyxerr << to_utf8(_("Missing command string after --execute switch")) << endl;
1192                 exit(1);
1193         }
1194         batch = arg;
1195         return 1;
1196 }
1197
1198 int parse_export(string const & type, string const &)
1199 {
1200         if (type.empty()) {
1201                 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1202                                          "--export switch")) << endl;
1203                 exit(1);
1204         }
1205         batch = "buffer-export " + type;
1206         use_gui = false;
1207         return 1;
1208 }
1209
1210 int parse_import(string const & type, string const & file)
1211 {
1212         if (type.empty()) {
1213                 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1214                                          "--import switch")) << endl;
1215                 exit(1);
1216         }
1217         if (file.empty()) {
1218                 lyxerr << to_utf8(_("Missing filename for --import")) << endl;
1219                 exit(1);
1220         }
1221
1222         batch = "buffer-import " + type + ' ' + file;
1223         return 2;
1224 }
1225
1226 } // namespace anon
1227
1228
1229 void LyX::easyParse(int & argc, char * argv[])
1230 {
1231         std::map<string, cmd_helper> cmdmap;
1232
1233         cmdmap["-dbg"] = parse_dbg;
1234         cmdmap["-help"] = parse_help;
1235         cmdmap["--help"] = parse_help;
1236         cmdmap["-version"] = parse_version;
1237         cmdmap["--version"] = parse_version;
1238         cmdmap["-sysdir"] = parse_sysdir;
1239         cmdmap["-userdir"] = parse_userdir;
1240         cmdmap["-x"] = parse_execute;
1241         cmdmap["--execute"] = parse_execute;
1242         cmdmap["-e"] = parse_export;
1243         cmdmap["--export"] = parse_export;
1244         cmdmap["-i"] = parse_import;
1245         cmdmap["--import"] = parse_import;
1246
1247         for (int i = 1; i < argc; ++i) {
1248                 std::map<string, cmd_helper>::const_iterator it
1249                         = cmdmap.find(argv[i]);
1250
1251                 // check for X11 -geometry option
1252                 if (support::compare(argv[i], "-geometry") == 0)
1253                         geometryOption_ = true;
1254
1255                 // don't complain if not found - may be parsed later
1256                 if (it == cmdmap.end())
1257                         continue;
1258
1259                 string arg((i + 1 < argc) ? argv[i + 1] : "");
1260                 string arg2((i + 2 < argc) ? argv[i + 2] : "");
1261
1262                 int const remove = 1 + it->second(arg, arg2);
1263
1264                 // Now, remove used arguments by shifting
1265                 // the following ones remove places down.
1266                 argc -= remove;
1267                 for (int j = i; j < argc; ++j)
1268                         argv[j] = argv[j + remove];
1269                 --i;
1270         }
1271
1272         batch_command = batch;
1273 }
1274
1275
1276 FuncStatus getStatus(FuncRequest const & action)
1277 {
1278         return LyX::ref().lyxFunc().getStatus(action);
1279 }
1280
1281
1282 void dispatch(FuncRequest const & action)
1283 {
1284         LyX::ref().lyxFunc().dispatch(action);
1285 }
1286
1287
1288 BufferList & theBufferList()
1289 {
1290         return LyX::ref().bufferList();
1291 }
1292
1293
1294 LyXFunc & theLyXFunc()
1295 {
1296         return LyX::ref().lyxFunc();
1297 }
1298
1299
1300 LyXServer & theLyXServer()
1301 {
1302         // FIXME: this should not be use_gui dependent
1303         BOOST_ASSERT(use_gui);
1304         return LyX::ref().server();
1305 }
1306
1307
1308 LyXServerSocket & theLyXServerSocket()
1309 {
1310         // FIXME: this should not be use_gui dependent
1311         BOOST_ASSERT(use_gui);
1312         return LyX::ref().socket();
1313 }
1314
1315
1316 kb_keymap & theTopLevelKeymap()
1317 {
1318         BOOST_ASSERT(use_gui);
1319         return LyX::ref().topLevelKeymap();
1320 }
1321
1322
1323 IconvProcessor & utf8ToUcs4()
1324 {
1325         return LyX::ref().iconvProcessor();
1326 }
1327
1328 } // namespace lyx