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