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