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