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