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