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