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