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