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