src/LyX.cpp

   1 /**
   2  * \file LyX.cpp
   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.h"
  19
  20 #include "buffer_funcs.h"
  21 #include "Buffer.h"
  22 #include "BufferList.h"
  23 #include "CmdDef.h"
  24 #include "Color.h"
  25 #include "ConverterCache.h"
  26 #include "Converter.h"
  27 #include "CutAndPaste.h"
  28 #include "Encoding.h"
  29 #include "ErrorList.h"
  30 #include "Format.h"
  31 #include "KeyMap.h"
  32 #include "Language.h"
  33 #include "Lexer.h"
  34 #include "LyXAction.h"
  35 #include "LyXFunc.h"
  36 #include "LyXRC.h"
  37 #include "MenuBackend.h"
  38 #include "ModuleList.h"
  39 #include "Mover.h"
  40 #include "Server.h"
  41 #include "ServerSocket.h"
  42 #include "Session.h"
  43 #include "TextClassList.h"
  44 #include "ToolbarBackend.h"
  45
  46 #include "frontends/alert.h"
  47 #include "frontends/Application.h"
  48
  49 #include "support/debug.h"
  50 #include "support/environment.h"
  51 #include "support/ExceptionMessage.h"
  52 #include "support/filetools.h"
  53 #include "support/gettext.h"
  54 #include "support/lstrings.h"
  55 #include "support/Messages.h"
  56 #include "support/os.h"
  57 #include "support/Package.h"
  58 #include "support/Path.h"
  59 #include "support/Systemcall.h"
  60
  61 #include <boost/bind.hpp>
  62 #include <boost/scoped_ptr.hpp>
  63
  64 #include <algorithm>
  65 #include <iostream>
  66 #include <csignal>
  67 #include <map>
  68 #include <stdlib.h>
  69 #include <string>
  70 #include <vector>
  71
  72 using namespace std;
  73 using namespace lyx::support;
  74
  75 namespace lyx {
  76
  77 namespace Alert = frontend::Alert;
  78 namespace os = support::os;
  79
  80
  81
  82 // Are we using the GUI at all?  We default to true and this is changed
  83 // to false when the export feature is used.
  84
  85 bool use_gui = true;
  86
  87 bool quitting;  // flag, that we are quitting the program
  88
  89 namespace {
  90
  91 // Filled with the command line arguments "foo" of "-sysdir foo" or
  92 // "-userdir foo".
  93 string cl_system_support;
  94 string cl_user_support;
  95
  96 string geometryArg;
  97
  98 LyX * singleton_ = 0;
  99
 100 void showFileError(string const & error)
 101 {
 102         Alert::warning(_("Could not read configuration file"),
 103                        bformat(_("Error while reading the configuration file\n%1$s.\n"
 104                            "Please check your installation."), from_utf8(error)));
 105 }
 106
 107
 108 void reconfigureUserLyXDir()
 109 {
 110         string const configure_command = package().configure_command();
 111
 112         lyxerr << to_utf8(_("LyX: reconfiguring user directory")) << endl;
 113         PathChanger p(package().user_support());
 114         Systemcall one;
 115         one.startscript(Systemcall::Wait, configure_command);
 116         lyxerr << "LyX: " << to_utf8(_("Done!")) << endl;
 117 }
 118
 119 } // namespace anon
 120
 121
 122 /// The main application class private implementation.
 123 struct LyX::Impl
 124 {
 125         Impl()
 126         {
 127                 // Set the default User Interface language as soon as possible.
 128                 // The language used will be derived from the environment
 129                 // variables.
 130                 messages_["GUI"] = Messages();
 131         }
 132         /// our function handler
 133         LyXFunc lyxfunc_;
 134         ///
 135         BufferList buffer_list_;
 136         ///
 137         KeyMap toplevel_keymap_;
 138         ///
 139         CmdDef toplevel_cmddef_;
 140         ///
 141         boost::scoped_ptr<Server> lyx_server_;
 142         ///
 143         boost::scoped_ptr<ServerSocket> lyx_socket_;
 144         ///
 145         boost::scoped_ptr<frontend::Application> application_;
 146         /// lyx session, containing lastfiles, lastfilepos, and lastopened
 147         boost::scoped_ptr<Session> session_;
 148
 149         /// Files to load at start.
 150         vector<string> files_to_load_;
 151
 152         /// The messages translators.
 153         map<string, Messages> messages_;
 154
 155         /// The file converters.
 156         Converters converters_;
 157
 158         // The system converters copy after reading lyxrc.defaults.
 159         Converters system_converters_;
 160
 161         ///
 162         Movers movers_;
 163         ///
 164         Movers system_movers_;
 165
 166         /// has this user started lyx for the first time?
 167         bool first_start;
 168         /// the parsed command line batch command if any
 169         string batch_command;
 170 };
 171
 172 ///
 173 frontend::Application * theApp()
 174 {
 175         if (singleton_)
 176                 return singleton_->pimpl_->application_.get();
 177         else
 178                 return 0;
 179 }
 180
 181
 182 LyX::~LyX()
 183 {
 184         delete pimpl_;
 185 }
 186
 187
 188 void LyX::exit(int exit_code) const
 189 {
 190         if (exit_code)
 191                 // Something wrong happened so better save everything, just in
 192                 // case.
 193                 emergencyCleanup();
 194
 195 #ifndef NDEBUG
 196         // Properly crash in debug mode in order to get a useful backtrace.
 197         abort();
 198 #endif
 199
 200         // In release mode, try to exit gracefully.
 201         if (theApp())
 202                 theApp()->exit(exit_code);
 203         else
 204                 exit(exit_code);
 205 }
 206
 207
 208 LyX & LyX::ref()
 209 {
 210         BOOST_ASSERT(singleton_);
 211         return *singleton_;
 212 }
 213
 214
 215 LyX const & LyX::cref()
 216 {
 217         BOOST_ASSERT(singleton_);
 218         return *singleton_;
 219 }
 220
 221
 222 LyX::LyX()
 223         : first_start(false)
 224 {
 225         singleton_ = this;
 226         pimpl_ = new Impl;
 227 }
 228
 229
 230 BufferList & LyX::bufferList()
 231 {
 232         return pimpl_->buffer_list_;
 233 }
 234
 235
 236 BufferList const & LyX::bufferList() const
 237 {
 238         return pimpl_->buffer_list_;
 239 }
 240
 241
 242 Session & LyX::session()
 243 {
 244         BOOST_ASSERT(pimpl_->session_.get());
 245         return *pimpl_->session_.get();
 246 }
 247
 248
 249 Session const & LyX::session() const
 250 {
 251         BOOST_ASSERT(pimpl_->session_.get());
 252         return *pimpl_->session_.get();
 253 }
 254
 255
 256 LyXFunc & LyX::lyxFunc()
 257 {
 258         return pimpl_->lyxfunc_;
 259 }
 260
 261
 262 LyXFunc const & LyX::lyxFunc() const
 263 {
 264         return pimpl_->lyxfunc_;
 265 }
 266
 267
 268 Server & LyX::server()
 269 {
 270         BOOST_ASSERT(pimpl_->lyx_server_.get());
 271         return *pimpl_->lyx_server_.get();
 272 }
 273
 274
 275 Server const & LyX::server() const
 276 {
 277         BOOST_ASSERT(pimpl_->lyx_server_.get());
 278         return *pimpl_->lyx_server_.get();
 279 }
 280
 281
 282 ServerSocket & LyX::socket()
 283 {
 284         BOOST_ASSERT(pimpl_->lyx_socket_.get());
 285         return *pimpl_->lyx_socket_.get();
 286 }
 287
 288
 289 ServerSocket const & LyX::socket() const
 290 {
 291         BOOST_ASSERT(pimpl_->lyx_socket_.get());
 292         return *pimpl_->lyx_socket_.get();
 293 }
 294
 295
 296 frontend::Application & LyX::application()
 297 {
 298         BOOST_ASSERT(pimpl_->application_.get());
 299         return *pimpl_->application_.get();
 300 }
 301
 302
 303 frontend::Application const & LyX::application() const
 304 {
 305         BOOST_ASSERT(pimpl_->application_.get());
 306         return *pimpl_->application_.get();
 307 }
 308
 309
 310 KeyMap & LyX::topLevelKeymap()
 311 {
 312         return pimpl_->toplevel_keymap_;
 313 }
 314
 315
 316 CmdDef & LyX::topLevelCmdDef()
 317 {
 318         return pimpl_->toplevel_cmddef_;
 319 }
 320
 321
 322 Converters & LyX::converters()
 323 {
 324         return pimpl_->converters_;
 325 }
 326
 327
 328 Converters & LyX::systemConverters()
 329 {
 330         return pimpl_->system_converters_;
 331 }
 332
 333
 334 KeyMap const & LyX::topLevelKeymap() const
 335 {
 336         return pimpl_->toplevel_keymap_;
 337 }
 338
 339
 340 Messages & LyX::getMessages(string const & language)
 341 {
 342         map<string, Messages>::iterator it = pimpl_->messages_.find(language);
 343
 344         if (it != pimpl_->messages_.end())
 345                 return it->second;
 346
 347         pair<map<string, Messages>::iterator, bool> result =
 348                         pimpl_->messages_.insert(make_pair(language, Messages(language)));
 349
 350         BOOST_ASSERT(result.second);
 351         return result.first->second;
 352 }
 353
 354
 355 Messages & LyX::getGuiMessages()
 356 {
 357         return pimpl_->messages_["GUI"];
 358 }
 359
 360
 361 void LyX::setGuiLanguage(string const & language)
 362 {
 363         pimpl_->messages_["GUI"] = Messages(language);
 364 }
 365
 366
 367 int LyX::exec(int & argc, char * argv[])
 368 {
 369         // Here we need to parse the command line. At least
 370         // we need to parse for "-dbg" and "-help"
 371         easyParse(argc, argv);
 372
 373         try {
 374                 init_package(to_utf8(from_local8bit(argv[0])),
 375                               cl_system_support, cl_user_support,
 376                               top_build_dir_is_one_level_up);
 377         } catch (ExceptionMessage const & message) {
 378                 if (message.type_ == ErrorException) {
 379                         Alert::error(message.title_, message.details_);
 380                         exit(1);
 381                 } else if (message.type_ == WarningException) {
 382                         Alert::warning(message.title_, message.details_);
 383                 }
 384         }
 385
 386         // Reinit the messages machinery in case package() knows
 387         // something interesting about the locale directory.
 388         Messages::init();
 389
 390         if (!use_gui) {
 391                 // FIXME: create a ConsoleApplication
 392                 int exit_status = init(argc, argv);
 393                 if (exit_status) {
 394                         prepareExit();
 395                         return exit_status;
 396                 }
 397
 398                 loadFiles();
 399
 400                 if (pimpl_->batch_command.empty() || pimpl_->buffer_list_.empty()) {
 401                         prepareExit();
 402                         return EXIT_SUCCESS;
 403                 }
 404
 405                 BufferList::iterator begin = pimpl_->buffer_list_.begin();
 406
 407                 bool final_success = false;
 408                 for (BufferList::iterator I = begin; I != pimpl_->buffer_list_.end(); ++I) {
 409                         Buffer * buf = *I;
 410                         if (buf != buf->masterBuffer())
 411                                 continue;
 412                         bool success = false;
 413                         buf->dispatch(pimpl_->batch_command, &success);
 414                         final_success |= success;
 415                 }
 416                 prepareExit();
 417                 return !final_success;
 418         }
 419
 420         // Let the frontend parse and remove all arguments that it knows
 421         pimpl_->application_.reset(createApplication(argc, argv));
 422
 423         // Parse and remove all known arguments in the LyX singleton
 424         // Give an error for all remaining ones.
 425         int exit_status = init(argc, argv);
 426         if (exit_status) {
 427                 // Kill the application object before exiting.
 428                 pimpl_->application_.reset();
 429                 use_gui = false;
 430                 prepareExit();
 431                 return exit_status;
 432         }
 433
 434         // FIXME
 435         /* Create a CoreApplication class that will provide the main event loop
 436         * and the socket callback registering. With Qt4, only QtCore
 437         * library would be needed.
 438         * When this is done, a server_mode could be created and the following two
 439         * line would be moved out from here.
 440         */
 441         // Note: socket callback must be registered after init(argc, argv)
 442         // such that package().temp_dir() is properly initialized.
 443         pimpl_->lyx_server_.reset(new Server(&pimpl_->lyxfunc_, lyxrc.lyxpipes));
 444         pimpl_->lyx_socket_.reset(new ServerSocket(&pimpl_->lyxfunc_,
 445                         FileName(package().temp_dir().absFilename() + "/lyxsocket")));
 446
 447         // Start the real execution loop.
 448         exit_status = pimpl_->application_->exec();
 449
 450         prepareExit();
 451
 452         return exit_status;
 453 }
 454
 455
 456 void LyX::prepareExit()
 457 {
 458         // Clear the clipboard and selection stack:
 459         cap::clearCutStack();
 460         cap::clearSelection();
 461
 462         // Set a flag that we do quitting from the program,
 463         // so no refreshes are necessary.
 464         quitting = true;
 465
 466         // close buffers first
 467         pimpl_->buffer_list_.closeAll();
 468
 469         // register session changes and shutdown server and socket
 470         if (use_gui) {
 471                 if (pimpl_->session_)
 472                         pimpl_->session_->writeFile();
 473                 pimpl_->session_.reset();
 474                 pimpl_->lyx_server_.reset();
 475                 pimpl_->lyx_socket_.reset();
 476         }
 477
 478         // do any other cleanup procedures now
 479         if (package().temp_dir() != package().system_temp_dir()) {
 480                 LYXERR(Debug::INFO, "Deleting tmp dir "
 481                                     << package().temp_dir().absFilename());
 482
 483                 if (!package().temp_dir().destroyDirectory()) {
 484                         docstring const msg =
 485                                 bformat(_("Unable to remove the temporary directory %1$s"),
 486                                 from_utf8(package().temp_dir().absFilename()));
 487                         Alert::warning(_("Unable to remove temporary directory"), msg);
 488                 }
 489         }
 490
 491         // Kill the application object before exiting. This avoids crashes
 492         // when exiting on Linux.
 493         if (pimpl_->application_)
 494                 pimpl_->application_.reset();
 495 }
 496
 497
 498 void LyX::earlyExit(int status)
 499 {
 500         BOOST_ASSERT(pimpl_->application_.get());
 501         // LyX::pimpl_::application_ is not initialised at this
 502         // point so it's safe to just exit after some cleanup.
 503         prepareExit();
 504         exit(status);
 505 }
 506
 507
 508 int LyX::init(int & argc, char * argv[])
 509 {
 510         // check for any spurious extra arguments
 511         // other than documents
 512         for (int argi = 1; argi < argc ; ++argi) {
 513                 if (argv[argi][0] == '-') {
 514                         lyxerr << to_utf8(
 515                                 bformat(_("Wrong command line option `%1$s'. Exiting."),
 516                                 from_utf8(argv[argi]))) << endl;
 517                         return EXIT_FAILURE;
 518                 }
 519         }
 520
 521         // Initialization of LyX (reads lyxrc and more)
 522         LYXERR(Debug::INIT, "Initializing LyX::init...");
 523         bool success = init();
 524         LYXERR(Debug::INIT, "Initializing LyX::init...done");
 525         if (!success)
 526                 return EXIT_FAILURE;
 527
 528         // Remaining arguments are assumed to be files to load.
 529         for (int argi = argc - 1; argi >= 1; --argi)
 530                 pimpl_->files_to_load_.push_back(to_utf8(from_local8bit(argv[argi])));
 531
 532         if (first_start) {
 533                 pimpl_->files_to_load_.push_back(
 534                         i18nLibFileSearch("examples", "splash.lyx").absFilename());
 535         }
 536
 537         return EXIT_SUCCESS;
 538 }
 539
 540
 541 void LyX::addFileToLoad(string const & fname)
 542 {
 543         vector<string>::const_iterator cit = find(
 544                 pimpl_->files_to_load_.begin(), pimpl_->files_to_load_.end(),
 545                 fname);
 546
 547         if (cit == pimpl_->files_to_load_.end())
 548                 pimpl_->files_to_load_.push_back(fname);
 549 }
 550
 551
 552 void LyX::loadFiles()
 553 {
 554         vector<string>::const_iterator it = pimpl_->files_to_load_.begin();
 555         vector<string>::const_iterator end = pimpl_->files_to_load_.end();
 556
 557         for (; it != end; ++it) {
 558                 // get absolute path of file and add ".lyx" to
 559                 // the filename if necessary
 560                 FileName fname = fileSearch(string(), os::internal_path(*it), "lyx",
 561                         may_not_exist);
 562
 563                 if (fname.empty())
 564                         continue;
 565
 566                 Buffer * buf = pimpl_->buffer_list_.newBuffer(fname.absFilename(), false);
 567                 if (buf->loadLyXFile(fname)) {
 568                         ErrorList const & el = buf->errorList("Parse");
 569                         if (!el.empty())
 570                                 for_each(el.begin(), el.end(),
 571                                 boost::bind(&LyX::printError, this, _1));
 572                 }
 573                 else
 574                         pimpl_->buffer_list_.release(buf);
 575         }
 576 }
 577
 578
 579 void LyX::execBatchCommands()
 580 {
 581         // The advantage of doing this here is that the event loop
 582         // is already started. So any need for interaction will be
 583         // aknowledged.
 584
 585         // if reconfiguration is needed.
 586         while (textclasslist.empty()) {
 587             switch (Alert::prompt(
 588                     _("No textclass is found"),
 589                     _("LyX cannot continue because no textclass is found. "
 590                       "You can either reconfigure normally, or reconfigure using "
 591                       "default textclasses, or quit LyX."),
 592                     0, 2,
 593                     _("&Reconfigure"),
 594                     _("&Use Default"),
 595                     _("&Exit LyX")))
 596                 {
 597                 case 0:
 598                         // regular reconfigure
 599                         pimpl_->lyxfunc_.dispatch(FuncRequest(LFUN_RECONFIGURE, ""));
 600                         break;
 601                 case 1:
 602                         // reconfigure --without-latex-config
 603                         pimpl_->lyxfunc_.dispatch(FuncRequest(LFUN_RECONFIGURE,
 604                                 " --without-latex-config"));
 605                         break;
 606                 default:
 607                         pimpl_->lyxfunc_.dispatch(FuncRequest(LFUN_LYX_QUIT));
 608                         return;
 609                 }
 610         }
 611
 612         // create the first main window
 613         pimpl_->lyxfunc_.dispatch(FuncRequest(LFUN_WINDOW_NEW, geometryArg));
 614
 615         if (!pimpl_->files_to_load_.empty()) {
 616                 // if some files were specified at command-line we assume that the
 617                 // user wants to edit *these* files and not to restore the session.
 618                 for (size_t i = 0; i != pimpl_->files_to_load_.size(); ++i) {
 619                         pimpl_->lyxfunc_.dispatch(
 620                                 FuncRequest(LFUN_FILE_OPEN, pimpl_->files_to_load_[i]));
 621                 }
 622                 // clear this list to save a few bytes of RAM
 623                 pimpl_->files_to_load_.clear();
 624         }
 625         else
 626                 pimpl_->application_->restoreGuiSession();
 627
 628         BufferList::iterator I = theBufferList().begin();
 629         BufferList::iterator end = theBufferList().end();
 630         for (; I != end; ++I) {
 631                 Buffer * buf = *I;
 632                 if (buf != buf->masterBuffer())
 633                         continue;
 634                 updateLabels(*buf);
 635         }
 636
 637         // Execute batch commands if available
 638         if (pimpl_->batch_command.empty())
 639                 return;
 640
 641         LYXERR(Debug::INIT, "About to handle -x '" << pimpl_->batch_command << '\'');
 642
 643         pimpl_->lyxfunc_.dispatch(lyxaction.lookupFunc(pimpl_->batch_command));
 644 }
 645
 646
 647 /*
 648 Signals and Windows
 649 ===================
 650 The SIGHUP signal does not exist on Windows and does not need to be handled.
 651
 652 Windows handles SIGFPE and SIGSEGV signals as expected.
 653
 654 Cntl+C interrupts (mapped to SIGINT by Windows' POSIX compatability layer)
 655 cause a new thread to be spawned. This may well result in unexpected
 656 behaviour by the single-threaded LyX.
 657
 658 SIGTERM signals will come only from another process actually sending
 659 that signal using 'raise' in Windows' POSIX compatability layer. It will
 660 not come from the general "terminate process" methods that everyone
 661 actually uses (and which can't be trapped). Killing an app 'politely' on
 662 Windows involves first sending a WM_CLOSE message, something that is
 663 caught already by the Qt frontend.
 664
 665 For more information see:
 666
 667 http://aspn.activestate.com/ASPN/Mail/Message/ActiveTcl/2034055
 668 ...signals are mostly useless on Windows for a variety of reasons that are
 669 Windows specific...
 670
 671 'UNIX Application Migration Guide, Chapter 9'
 672 http://msdn.microsoft.com/library/en-us/dnucmg/html/UCMGch09.asp
 673
 674 'How To Terminate an Application "Cleanly" in Win32'
 675 http://support.microsoft.com/default.aspx?scid=kb;en-us;178893
 676 */
 677 extern "C" {
 678
 679 static void error_handler(int err_sig)
 680 {
 681         // Throw away any signals other than the first one received.
 682         static sig_atomic_t handling_error = false;
 683         if (handling_error)
 684                 return;
 685         handling_error = true;
 686
 687         // We have received a signal indicating a fatal error, so
 688         // try and save the data ASAP.
 689         LyX::cref().emergencyCleanup();
 690
 691         // These lyxerr calls may or may not work:
 692
 693         // Signals are asynchronous, so the main program may be in a very
 694         // fragile state when a signal is processed and thus while a signal
 695         // handler function executes.
 696         // In general, therefore, we should avoid performing any
 697         // I/O operations or calling most library and system functions from
 698         // signal handlers.
 699
 700         // This shouldn't matter here, however, as we've already invoked
 701         // emergencyCleanup.
 702         switch (err_sig) {
 703 #ifdef SIGHUP
 704         case SIGHUP:
 705                 lyxerr << "\nlyx: SIGHUP signal caught\nBye." << endl;
 706                 break;
 707 #endif
 708         case SIGFPE:
 709                 lyxerr << "\nlyx: SIGFPE signal caught\nBye." << endl;
 710                 break;
 711         case SIGSEGV:
 712                 lyxerr << "\nlyx: SIGSEGV signal caught\n"
 713                           "Sorry, you have found a bug in LyX. "
 714                           "Please read the bug-reporting instructions "
 715                           "in Help->Introduction and send us a bug report, "
 716                           "if necessary. Thanks !\nBye." << endl;
 717                 break;
 718         case SIGINT:
 719         case SIGTERM:
 720                 // no comments
 721                 break;
 722         }
 723
 724         // Deinstall the signal handlers
 725 #ifdef SIGHUP
 726         signal(SIGHUP, SIG_DFL);
 727 #endif
 728         signal(SIGINT, SIG_DFL);
 729         signal(SIGFPE, SIG_DFL);
 730         signal(SIGSEGV, SIG_DFL);
 731         signal(SIGTERM, SIG_DFL);
 732
 733 #ifdef SIGHUP
 734         if (err_sig == SIGSEGV ||
 735             (err_sig != SIGHUP && !getEnv("LYXDEBUG").empty()))
 736 #else
 737         if (err_sig == SIGSEGV || !getEnv("LYXDEBUG").empty())
 738 #endif
 739                 abort();
 740         exit(0);
 741 }
 742
 743 }
 744
 745
 746 void LyX::printError(ErrorItem const & ei)
 747 {
 748         docstring tmp = _("LyX: ") + ei.error + char_type(':')
 749                 + ei.description;
 750         cerr << to_utf8(tmp) << endl;
 751 }
 752
 753
 754 bool LyX::init()
 755 {
 756 #ifdef SIGHUP
 757         signal(SIGHUP, error_handler);
 758 #endif
 759         signal(SIGFPE, error_handler);
 760         signal(SIGSEGV, error_handler);
 761         signal(SIGINT, error_handler);
 762         signal(SIGTERM, error_handler);
 763         // SIGPIPE can be safely ignored.
 764
 765         lyxrc.tempdir_path = package().temp_dir().absFilename();
 766         lyxrc.document_path = package().document_dir().absFilename();
 767
 768         if (lyxrc.example_path.empty()) {
 769                 lyxrc.example_path = addPath(package().system_support().absFilename(),
 770                                               "examples");
 771         }
 772         if (lyxrc.template_path.empty()) {
 773                 lyxrc.template_path = addPath(package().system_support().absFilename(),
 774                                               "templates");
 775         }
 776
 777         //
 778         // Read configuration files
 779         //
 780
 781         // This one may have been distributed along with LyX.
 782         if (!readRcFile("lyxrc.dist"))
 783                 return false;
 784
 785         // Set the language defined by the distributor.
 786         //setGuiLanguage(lyxrc.gui_language);
 787
 788         // Set the PATH correctly.
 789 #if !defined (USE_POSIX_PACKAGING)
 790         // Add the directory containing the LyX executable to the path
 791         // so that LyX can find things like tex2lyx.
 792         if (package().build_support().empty())
 793                 prependEnvPath("PATH", package().binary_dir().absFilename());
 794 #endif
 795         if (!lyxrc.path_prefix.empty())
 796                 prependEnvPath("PATH", lyxrc.path_prefix);
 797
 798         // Check that user LyX directory is ok.
 799         if (queryUserLyXDir(package().explicit_user_support()))
 800                 reconfigureUserLyXDir();
 801
 802         // no need for a splash when there is no GUI
 803         if (!use_gui) {
 804                 first_start = false;
 805         }
 806
 807         // This one is generated in user_support directory by lib/configure.py.
 808         if (!readRcFile("lyxrc.defaults"))
 809                 return false;
 810
 811         // Query the OS to know what formats are viewed natively
 812         formats.setAutoOpen();
 813
 814         // Read lyxrc.dist again to be able to override viewer auto-detection.
 815         readRcFile("lyxrc.dist");
 816
 817         system_lyxrc = lyxrc;
 818         system_formats = formats;
 819         pimpl_->system_converters_ = pimpl_->converters_;
 820         pimpl_->system_movers_ = pimpl_->movers_;
 821         system_lcolor = lcolor;
 822
 823         // This one is edited through the preferences dialog.
 824         if (!readRcFile("preferences"))
 825                 return false;
 826
 827         if (!readEncodingsFile("encodings", "unicodesymbols"))
 828                 return false;
 829         if (!readLanguagesFile("languages"))
 830                 return false;
 831
 832         // Load the layouts
 833         LYXERR(Debug::INIT, "Reading layouts...");
 834         if (!LyXSetStyle())
 835                 return false;
 836         //...and the modules
 837         moduleList.load();
 838
 839         // read keymap and ui files in batch mode as well
 840         // because InsetInfo needs to know these to produce
 841         // the correct output
 842
 843         // Set the language defined by the user.
 844         //setGuiLanguage(lyxrc.gui_language);
 845
 846         // Set up command definitions
 847         pimpl_->toplevel_cmddef_.read(lyxrc.def_file);
 848
 849         // Set up bindings
 850         pimpl_->toplevel_keymap_.read("site");
 851         pimpl_->toplevel_keymap_.read(lyxrc.bind_file);
 852         // load user bind file user.bind
 853         pimpl_->toplevel_keymap_.read("user");
 854
 855         pimpl_->lyxfunc_.initKeySequences(&pimpl_->toplevel_keymap_);
 856
 857         // Read menus
 858         if (!readUIFile(lyxrc.ui_file))
 859                 return false;
 860
 861         if (lyxerr.debugging(Debug::LYXRC))
 862                 lyxrc.print();
 863
 864         os::windows_style_tex_paths(lyxrc.windows_style_tex_paths);
 865         if (!lyxrc.path_prefix.empty())
 866                 prependEnvPath("PATH", lyxrc.path_prefix);
 867
 868         FileName const document_path(lyxrc.document_path);
 869         if (document_path.exists() && document_path.isDirectory())
 870                 package().document_dir() = document_path;
 871
 872         package().temp_dir() = createLyXTmpDir(FileName(lyxrc.tempdir_path));
 873         if (package().temp_dir().empty()) {
 874                 Alert::error(_("Could not create temporary directory"),
 875                              bformat(_("Could not create a temporary directory in\n"
 876                                                     "%1$s. Make sure that this\n"
 877                                                     "path exists and is writable and try again."),
 878                                      from_utf8(lyxrc.tempdir_path)));
 879                 // createLyXTmpDir() tries sufficiently hard to create a
 880                 // usable temp dir, so the probability to come here is
 881                 // close to zero. We therefore don't try to overcome this
 882                 // problem with e.g. asking the user for a new path and
 883                 // trying again but simply exit.
 884                 return false;
 885         }
 886
 887         LYXERR(Debug::INIT, "LyX tmp dir: `"
 888                             << package().temp_dir().absFilename() << '\'');
 889
 890         LYXERR(Debug::INIT, "Reading session information '.lyx/session'...");
 891         pimpl_->session_.reset(new Session(lyxrc.num_lastfiles));
 892
 893         // This must happen after package initialization and after lyxrc is
 894         // read, therefore it can't be done by a static object.
 895         ConverterCache::init();
 896
 897         return true;
 898 }
 899
 900
 901 void LyX::emergencyCleanup() const
 902 {
 903         // what to do about tmpfiles is non-obvious. we would
 904         // like to delete any we find, but our lyxdir might
 905         // contain documents etc. which might be helpful on
 906         // a crash
 907
 908         pimpl_->buffer_list_.emergencyWriteAll();
 909         if (use_gui) {
 910                 if (pimpl_->lyx_server_)
 911                         pimpl_->lyx_server_->emergencyCleanup();
 912                 pimpl_->lyx_server_.reset();
 913                 pimpl_->lyx_socket_.reset();
 914         }
 915 }
 916
 917
 918 void LyX::deadKeyBindings(KeyMap * kbmap)
 919 {
 920         // bindKeyings for transparent handling of deadkeys
 921         // The keysyms are gotten from XFree86 X11R6
 922         kbmap->bind("~C-~S-~M-dead_acute", FuncRequest(LFUN_ACCENT_ACUTE));
 923         kbmap->bind("~C-~S-~M-dead_breve", FuncRequest(LFUN_ACCENT_BREVE));
 924         kbmap->bind("~C-~S-~M-dead_caron", FuncRequest(LFUN_ACCENT_CARON));
 925         kbmap->bind("~C-~S-~M-dead_cedilla", FuncRequest(LFUN_ACCENT_CEDILLA));
 926         kbmap->bind("~C-~S-~M-dead_abovering", FuncRequest(LFUN_ACCENT_CIRCLE));
 927         kbmap->bind("~C-~S-~M-dead_circumflex", FuncRequest(LFUN_ACCENT_CIRCUMFLEX));
 928         kbmap->bind("~C-~S-~M-dead_abovedot", FuncRequest(LFUN_ACCENT_DOT));
 929         kbmap->bind("~C-~S-~M-dead_grave", FuncRequest(LFUN_ACCENT_GRAVE));
 930         kbmap->bind("~C-~S-~M-dead_doubleacute", FuncRequest(LFUN_ACCENT_HUNGARIAN_UMLAUT));
 931         kbmap->bind("~C-~S-~M-dead_macron", FuncRequest(LFUN_ACCENT_MACRON));
 932         // nothing with this name
 933         // kbmap->bind("~C-~S-~M-dead_special_caron", LFUN_ACCENT_SPECIAL_CARON);
 934         kbmap->bind("~C-~S-~M-dead_tilde", FuncRequest(LFUN_ACCENT_TILDE));
 935         kbmap->bind("~C-~S-~M-dead_diaeresis", FuncRequest(LFUN_ACCENT_UMLAUT));
 936         // nothing with this name either...
 937         //kbmap->bind("~C-~S-~M-dead_underbar", FuncRequest(LFUN_ACCENT_UNDERBAR));
 938         kbmap->bind("~C-~S-~M-dead_belowdot", FuncRequest(LFUN_ACCENT_UNDERDOT));
 939         kbmap->bind("~C-~S-~M-dead_tie", FuncRequest(LFUN_ACCENT_TIE));
 940         kbmap->bind("~C-~S-~M-dead_ogonek",FuncRequest(LFUN_ACCENT_OGONEK));
 941 }
 942
 943
 944 // return true if file does not exist or is older than configure.py.
 945 static bool needsUpdate(string const & file)
 946 {
 947         // We cannot initialize configure_script directly because the package
 948         // is not initialized yet when  static objects are constructed.
 949         static FileName configure_script;
 950         static bool firstrun = true;
 951         if (firstrun) {
 952                 configure_script =
 953                         FileName(addName(package().system_support().absFilename(),
 954                                 "configure.py"));
 955                 firstrun = false;
 956         }
 957
 958         FileName absfile =
 959                 FileName(addName(package().user_support().absFilename(), file));
 960         return !absfile.exists()
 961                 || configure_script.lastModified() > absfile.lastModified();
 962 }
 963
 964
 965 bool LyX::queryUserLyXDir(bool explicit_userdir)
 966 {
 967         // Does user directory exist?
 968         FileName const sup = package().user_support();
 969         if (sup.exists() && sup.isDirectory()) {
 970                 first_start = false;
 971
 972                 return needsUpdate("lyxrc.defaults")
 973                         || needsUpdate("lyxmodules.lst")
 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().absFilename())),
 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(sup.absFilename()))) << endl;
 998
 999         if (!sup.createDirectory(0755)) {
1000                 // Failed, so let's exit.
1001                 lyxerr << to_utf8(_("Failed to create directory. Exiting."))
1002                        << endl;
1003                 earlyExit(EXIT_FAILURE);
1004         }
1005
1006         return true;
1007 }
1008
1009
1010 bool LyX::readRcFile(string const & name)
1011 {
1012         LYXERR(Debug::INIT, "About to read " << name << "... ");
1013
1014         FileName const lyxrc_path = libFileSearch(string(), name);
1015         if (!lyxrc_path.empty()) {
1016                 LYXERR(Debug::INIT, "Found in " << lyxrc_path);
1017                 if (lyxrc.read(lyxrc_path) < 0) {
1018                         showFileError(name);
1019                         return false;
1020                 }
1021         } else {
1022                 LYXERR(Debug::INIT, "Not found." << lyxrc_path);
1023         }
1024         return true;
1025 }
1026
1027
1028 // Read the ui file `name'
1029 bool LyX::readUIFile(string const & name, bool include)
1030 {
1031         enum Uitags {
1032                 ui_menuset = 1,
1033                 ui_toolbars,
1034                 ui_toolbarset,
1035                 ui_include,
1036                 ui_last
1037         };
1038
1039         struct keyword_item uitags[ui_last - 1] = {
1040                 { "include", ui_include },
1041                 { "menuset", ui_menuset },
1042                 { "toolbars", ui_toolbars },
1043                 { "toolbarset", ui_toolbarset }
1044         };
1045
1046         // Ensure that a file is read only once (prevents include loops)
1047         static list<string> uifiles;
1048         list<string>::const_iterator it  = uifiles.begin();
1049         list<string>::const_iterator end = uifiles.end();
1050         it = find(it, end, name);
1051         if (it != end) {
1052                 LYXERR(Debug::INIT, "UI file '" << name << "' has been read already. "
1053                                     << "Is this an include loop?");
1054                 return false;
1055         }
1056
1057         LYXERR(Debug::INIT, "About to read " << name << "...");
1058
1059
1060         FileName ui_path;
1061         if (include) {
1062                 ui_path = libFileSearch("ui", name, "inc");
1063                 if (ui_path.empty())
1064                         ui_path = libFileSearch("ui",
1065                                                 changeExtension(name, "inc"));
1066         }
1067         else
1068                 ui_path = libFileSearch("ui", name, "ui");
1069
1070         if (ui_path.empty()) {
1071                 LYXERR(Debug::INIT, "Could not find " << name);
1072                 showFileError(name);
1073                 return false;
1074         }
1075
1076         uifiles.push_back(name);
1077
1078         LYXERR(Debug::INIT, "Found " << name << " in " << ui_path);
1079         Lexer lex(uitags, ui_last - 1);
1080         lex.setFile(ui_path);
1081         if (!lex.isOK()) {
1082                 lyxerr << "Unable to set LyXLeX for ui file: " << ui_path
1083                        << endl;
1084         }
1085
1086         if (lyxerr.debugging(Debug::PARSER))
1087                 lex.printTable(lyxerr);
1088
1089         while (lex.isOK()) {
1090                 switch (lex.lex()) {
1091                 case ui_include: {
1092                         lex.next(true);
1093                         string const file = lex.getString();
1094                         if (!readUIFile(file, true))
1095                                 return false;
1096                         break;
1097                 }
1098                 case ui_menuset:
1099                         theApp()->menuBackend().read(lex);
1100                         break;
1101
1102                 case ui_toolbarset:
1103                         toolbarbackend.readToolbars(lex);
1104                         break;
1105
1106                 case ui_toolbars:
1107                         toolbarbackend.readToolbarSettings(lex);
1108                         break;
1109
1110                 default:
1111                         if (!rtrim(lex.getString()).empty())
1112                                 lex.printError("LyX::ReadUIFile: "
1113                                                "Unknown menu tag: `$$Token'");
1114                         break;
1115                 }
1116         }
1117         return true;
1118 }
1119
1120
1121 // Read the languages file `name'
1122 bool LyX::readLanguagesFile(string const & name)
1123 {
1124         LYXERR(Debug::INIT, "About to read " << name << "...");
1125
1126         FileName const lang_path = libFileSearch(string(), name);
1127         if (lang_path.empty()) {
1128                 showFileError(name);
1129                 return false;
1130         }
1131         languages.read(lang_path);
1132         return true;
1133 }
1134
1135
1136 // Read the encodings file `name'
1137 bool LyX::readEncodingsFile(string const & enc_name,
1138                             string const & symbols_name)
1139 {
1140         LYXERR(Debug::INIT, "About to read " << enc_name << " and "
1141                             << symbols_name << "...");
1142
1143         FileName const symbols_path = libFileSearch(string(), symbols_name);
1144         if (symbols_path.empty()) {
1145                 showFileError(symbols_name);
1146                 return false;
1147         }
1148
1149         FileName const enc_path = libFileSearch(string(), enc_name);
1150         if (enc_path.empty()) {
1151                 showFileError(enc_name);
1152                 return false;
1153         }
1154         encodings.read(enc_path, symbols_path);
1155         return true;
1156 }
1157
1158
1159 namespace {
1160
1161 string batch;
1162
1163 /// return the the number of arguments consumed
1164 typedef boost::function<int(string const &, string const &)> cmd_helper;
1165
1166 int parse_dbg(string const & arg, string const &)
1167 {
1168         if (arg.empty()) {
1169                 lyxerr << to_utf8(_("List of supported debug flags:")) << endl;
1170                 Debug::showTags(lyxerr);
1171                 exit(0);
1172         }
1173         lyxerr << to_utf8(bformat(_("Setting debug level to %1$s"), from_utf8(arg))) << endl;
1174
1175         lyxerr.level(Debug::value(arg));
1176         Debug::showLevel(lyxerr, lyxerr.level());
1177         return 1;
1178 }
1179
1180
1181 int parse_help(string const &, string const &)
1182 {
1183         lyxerr <<
1184                 to_utf8(_("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
1185                   "Command line switches (case sensitive):\n"
1186                   "\t-help              summarize LyX usage\n"
1187                   "\t-userdir dir       set user directory to dir\n"
1188                   "\t-sysdir dir        set system directory to dir\n"
1189                   "\t-geometry WxH+X+Y  set geometry of the main window\n"
1190                   "\t-dbg feature[,feature]...\n"
1191                   "                  select the features to debug.\n"
1192                   "                  Type `lyx -dbg' to see the list of features\n"
1193                   "\t-x [--execute] command\n"
1194                   "                  where command is a lyx command.\n"
1195                   "\t-e [--export] fmt\n"
1196                   "                  where fmt is the export format of choice.\n"
1197                   "                  Look on Tools->Preferences->File formats->Format\n"
1198                   "                  to get an idea which parameters should be passed.\n"
1199                   "\t-i [--import] fmt file.xxx\n"
1200                   "                  where fmt is the import format of choice\n"
1201                   "                  and file.xxx is the file to be imported.\n"
1202                   "\t-version        summarize version and build info\n"
1203                                "Check the LyX man page for more details.")) << endl;
1204         exit(0);
1205         return 0;
1206 }
1207
1208
1209 int parse_version(string const &, string const &)
1210 {
1211         lyxerr << "LyX " << lyx_version
1212                << " (" << lyx_release_date << ")" << endl;
1213         lyxerr << "Built on " << __DATE__ << ", " << __TIME__ << endl;
1214
1215         lyxerr << lyx_version_info << endl;
1216         exit(0);
1217         return 0;
1218 }
1219
1220
1221 int parse_sysdir(string const & arg, string const &)
1222 {
1223         if (arg.empty()) {
1224                 Alert::error(_("No system directory"),
1225                         _("Missing directory for -sysdir switch"));
1226                 exit(1);
1227         }
1228         cl_system_support = arg;
1229         return 1;
1230 }
1231
1232
1233 int parse_userdir(string const & arg, string const &)
1234 {
1235         if (arg.empty()) {
1236                 Alert::error(_("No user directory"),
1237                         _("Missing directory for -userdir switch"));
1238                 exit(1);
1239         }
1240         cl_user_support = arg;
1241         return 1;
1242 }
1243
1244
1245 int parse_execute(string const & arg, string const &)
1246 {
1247         if (arg.empty()) {
1248                 Alert::error(_("Incomplete command"),
1249                         _("Missing command string after --execute switch"));
1250                 exit(1);
1251         }
1252         batch = arg;
1253         return 1;
1254 }
1255
1256
1257 int parse_export(string const & type, string const &)
1258 {
1259         if (type.empty()) {
1260                 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1261                                          "--export switch")) << endl;
1262                 exit(1);
1263         }
1264         batch = "buffer-export " + type;
1265         use_gui = false;
1266         return 1;
1267 }
1268
1269
1270 int parse_import(string const & type, string const & file)
1271 {
1272         if (type.empty()) {
1273                 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1274                                          "--import switch")) << endl;
1275                 exit(1);
1276         }
1277         if (file.empty()) {
1278                 lyxerr << to_utf8(_("Missing filename for --import")) << endl;
1279                 exit(1);
1280         }
1281
1282         batch = "buffer-import " + type + ' ' + file;
1283         return 2;
1284 }
1285
1286
1287 int parse_geometry(string const & arg1, string const &)
1288 {
1289         geometryArg = arg1;
1290 #if defined(_WIN32) || (defined(__CYGWIN__) && defined(X_DISPLAY_MISSING))
1291         // remove also the arg
1292         return 1;
1293 #else
1294         // don't remove "-geometry"
1295         return -1;
1296 #endif
1297 }
1298
1299
1300 } // namespace anon
1301
1302
1303 void LyX::easyParse(int & argc, char * argv[])
1304 {
1305         map<string, cmd_helper> cmdmap;
1306
1307         cmdmap["-dbg"] = parse_dbg;
1308         cmdmap["-help"] = parse_help;
1309         cmdmap["--help"] = parse_help;
1310         cmdmap["-version"] = parse_version;
1311         cmdmap["--version"] = parse_version;
1312         cmdmap["-sysdir"] = parse_sysdir;
1313         cmdmap["-userdir"] = parse_userdir;
1314         cmdmap["-x"] = parse_execute;
1315         cmdmap["--execute"] = parse_execute;
1316         cmdmap["-e"] = parse_export;
1317         cmdmap["--export"] = parse_export;
1318         cmdmap["-i"] = parse_import;
1319         cmdmap["--import"] = parse_import;
1320         cmdmap["-geometry"] = parse_geometry;
1321
1322         for (int i = 1; i < argc; ++i) {
1323                 map<string, cmd_helper>::const_iterator it
1324                         = cmdmap.find(argv[i]);
1325
1326                 // don't complain if not found - may be parsed later
1327                 if (it == cmdmap.end())
1328                         continue;
1329
1330                 string const arg =
1331                         (i + 1 < argc) ? to_utf8(from_local8bit(argv[i + 1])) : string();
1332                 string const arg2 =
1333                         (i + 2 < argc) ? to_utf8(from_local8bit(argv[i + 2])) : string();
1334
1335                 int const remove = 1 + it->second(arg, arg2);
1336
1337                 // Now, remove used arguments by shifting
1338                 // the following ones remove places down.
1339                 if (remove > 0) {
1340                         argc -= remove;
1341                         for (int j = i; j < argc; ++j)
1342                                 argv[j] = argv[j + remove];
1343                         --i;
1344                 }
1345         }
1346
1347         pimpl_->batch_command = batch;
1348 }
1349
1350
1351 FuncStatus getStatus(FuncRequest const & action)
1352 {
1353         return LyX::ref().lyxFunc().getStatus(action);
1354 }
1355
1356
1357 void dispatch(FuncRequest const & action)
1358 {
1359         LyX::ref().lyxFunc().dispatch(action);
1360 }
1361
1362
1363 BufferList & theBufferList()
1364 {
1365         return LyX::ref().bufferList();
1366 }
1367
1368
1369 LyXFunc & theLyXFunc()
1370 {
1371         return LyX::ref().lyxFunc();
1372 }
1373
1374
1375 Server & theServer()
1376 {
1377         // FIXME: this should not be use_gui dependent
1378         BOOST_ASSERT(use_gui);
1379         return LyX::ref().server();
1380 }
1381
1382
1383 ServerSocket & theServerSocket()
1384 {
1385         // FIXME: this should not be use_gui dependent
1386         BOOST_ASSERT(use_gui);
1387         return LyX::ref().socket();
1388 }
1389
1390
1391 KeyMap & theTopLevelKeymap()
1392 {
1393         return LyX::ref().topLevelKeymap();
1394 }
1395
1396
1397 Converters & theConverters()
1398 {
1399         return  LyX::ref().converters();
1400 }
1401
1402
1403 Converters & theSystemConverters()
1404 {
1405         return  LyX::ref().systemConverters();
1406 }
1407
1408
1409 Movers & theMovers()
1410 {
1411         return  LyX::ref().pimpl_->movers_;
1412 }
1413
1414
1415 Mover const & getMover(string  const & fmt)
1416 {
1417         return  LyX::ref().pimpl_->movers_(fmt);
1418 }
1419
1420
1421 void setMover(string const & fmt, string const & command)
1422 {
1423         LyX::ref().pimpl_->movers_.set(fmt, command);
1424 }
1425
1426
1427 Movers & theSystemMovers()
1428 {
1429         return  LyX::ref().pimpl_->system_movers_;
1430 }
1431
1432
1433 Messages & getMessages(string const & language)
1434 {
1435         return LyX::ref().getMessages(language);
1436 }
1437
1438
1439 Messages & getGuiMessages()
1440 {
1441         return LyX::ref().getGuiMessages();
1442 }
1443
1444 } // namespace lyx