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