3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alfredo Braunstein
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * Full author contact details are available in file CREDITS.
20 #include "ConverterCache.h"
22 #include "buffer_funcs.h"
23 #include "bufferlist.h"
24 #include "converter.h"
27 #include "errorlist.h"
35 #include "LyXAction.h"
39 #include "lyxserver.h"
40 #include "lyxsocket.h"
41 #include "lyxtextclasslist.h"
42 #include "MenuBackend.h"
44 #include "ToolbarBackend.h"
46 #include "frontends/Alert.h"
47 #include "frontends/Application.h"
48 #include "frontends/Gui.h"
49 #include "frontends/LyXView.h"
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"
62 #include <boost/bind.hpp>
63 #include <boost/filesystem/operations.hpp>
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;
85 using support::Systemcall;
87 namespace Alert = frontend::Alert;
88 namespace os = support::os;
89 namespace fs = boost::filesystem;
96 #ifndef CXX_GLOBAL_CSTD
103 frontend::Application * theApp = 0;
105 /// are we using the GUI at all?
107 * We default to true and this is changed to false when the export feature is used.
114 // Filled with the command line arguments "foo" of "-sysdir foo" or
116 string cl_system_support;
117 string cl_user_support;
119 std::string geometryArg;
121 LyX * singleton_ = 0;
123 void showFileError(string const & error)
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)));
131 void reconfigureUserLyXDir()
133 string const configure_command = package().configure_command();
135 lyxerr << to_utf8(_("LyX: reconfiguring user directory")) << endl;
136 support::Path p(package().user_support());
138 one.startscript(Systemcall::Wait, configure_command);
139 lyxerr << "LyX: " << to_utf8(_("Done!")) << endl;
145 /// The main application class private implementation.
146 struct LyX::Singletons
148 Singletons(): iconv(ucs4_codeset, "UTF-8")
151 /// our function handler
154 BufferList buffer_list_;
156 boost::scoped_ptr<kb_keymap> toplevel_keymap_;
158 boost::scoped_ptr<LyXServer> lyx_server_;
160 boost::scoped_ptr<LyXServerSocket> lyx_socket_;
162 boost::scoped_ptr<frontend::Application> application_;
163 /// lyx session, containing lastfiles, lastfilepos, and lastopened
164 boost::scoped_ptr<Session> session_;
167 IconvProcessor iconv;
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.
185 BOOST_ASSERT(singleton_);
190 LyX const & LyX::cref()
192 BOOST_ASSERT(singleton_);
201 pimpl_.reset(new Singletons);
206 BufferList & LyX::bufferList()
208 return pimpl_->buffer_list_;
212 BufferList const & LyX::bufferList() const
214 return pimpl_->buffer_list_;
218 Session & LyX::session()
220 BOOST_ASSERT(pimpl_->session_.get());
221 return *pimpl_->session_.get();
225 Session const & LyX::session() const
227 BOOST_ASSERT(pimpl_->session_.get());
228 return *pimpl_->session_.get();
232 LyXFunc & LyX::lyxFunc()
234 return pimpl_->lyxfunc_;
238 LyXFunc const & LyX::lyxFunc() const
240 return pimpl_->lyxfunc_;
244 LyXServer & LyX::server()
246 BOOST_ASSERT(pimpl_->lyx_server_.get());
247 return *pimpl_->lyx_server_.get();
251 LyXServer const & LyX::server() const
253 BOOST_ASSERT(pimpl_->lyx_server_.get());
254 return *pimpl_->lyx_server_.get();
258 LyXServerSocket & LyX::socket()
260 BOOST_ASSERT(pimpl_->lyx_socket_.get());
261 return *pimpl_->lyx_socket_.get();
265 LyXServerSocket const & LyX::socket() const
267 BOOST_ASSERT(pimpl_->lyx_socket_.get());
268 return *pimpl_->lyx_socket_.get();
272 frontend::Application & LyX::application()
274 BOOST_ASSERT(pimpl_->application_.get());
275 return *pimpl_->application_.get();
279 frontend::Application const & LyX::application() const
281 BOOST_ASSERT(pimpl_->application_.get());
282 return *pimpl_->application_.get();
286 kb_keymap & LyX::topLevelKeymap()
288 BOOST_ASSERT(pimpl_->toplevel_keymap_.get());
289 return *pimpl_->toplevel_keymap_.get();
293 IconvProcessor & LyX::iconvProcessor()
295 return pimpl_->iconv;
299 kb_keymap const & LyX::topLevelKeymap() const
301 BOOST_ASSERT(pimpl_->toplevel_keymap_.get());
302 return *pimpl_->toplevel_keymap_.get();
306 Buffer const * const LyX::updateInset(InsetBase const * inset) const
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) {
317 pimpl_->application_->gui().view(*it).updateInset(inset);
325 int LyX::exec(int & argc, char * argv[])
327 // Here we need to parse the command line. At least
328 // we need to parse for "-dbg" and "-help"
329 easyParse(argc, argv);
331 support::init_package(argv[0], cl_system_support, cl_user_support,
332 support::top_build_dir_is_one_level_up);
334 vector<string> files;
337 // FIXME: create a ConsoleApplication
338 int exit_status = loadFiles(argc, argv, files);
344 if (batch_command.empty() || pimpl_->buffer_list_.empty()) {
349 BufferList::iterator begin = pimpl_->buffer_list_.begin();
350 BufferList::iterator end = pimpl_->buffer_list_.end();
352 bool final_success = false;
353 for (BufferList::iterator I = begin; I != end; ++I) {
355 bool success = false;
356 buf->dispatch(batch_command, &success);
357 final_success |= success;
360 return !final_success;
363 // Force adding of font path _before_ Application is initialized
364 support::addFontResources();
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();
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);
377 // Kill the application object before exiting.
378 pimpl_->application_.reset();
384 restoreGuiSession(files);
385 // Start the real execution loop.
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.
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")));
398 exit_status = pimpl_->application_->exec();
399 // Kill the application object before exiting. This avoid crash
401 pimpl_->application_.reset();
402 // Restore original font resources after Application is destroyed.
403 support::restoreFontResources();
409 void LyX::prepareExit()
411 // Set a flag that we do quitting from the program,
412 // so no refreshes are necessary.
415 // close buffers first
416 pimpl_->buffer_list_.closeAll();
418 // do any other cleanup procedures now
419 lyxerr[Debug::INFO] << "Deleting tmp dir " << package().temp_dir() << endl;
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;
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);
438 void LyX::earlyExit(int status)
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.
450 lyxerr[Debug::INFO] << "Running QuitLyX." << endl;
455 pimpl_->session_->writeFile();
456 pimpl_->lyx_server_.reset();
457 pimpl_->lyx_socket_.reset();
458 pimpl_->application_->exit(0);
464 int LyX::loadFiles(int & argc, char * argv[],
465 vector<string> & files)
467 // check for any spurious extra arguments
468 // other than documents
469 for (int argi = 1; argi < argc ; ++argi) {
470 if (argv[argi][0] == '-') {
472 bformat(_("Wrong command line option `%1$s'. Exiting."),
473 from_utf8(argv[argi]))) << endl;
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;
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
489 if (argv[argi][0] == '-')
491 files.push_back(os::internal_path(argv[argi]));
495 files.push_back(i18nLibFileSearch("examples", "splash.lyx").absFilename());
497 Buffer * last_loaded = 0;
499 vector<string>::const_iterator it = files.begin();
500 vector<string>::const_iterator end = files.end();
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();
507 Buffer * const b = newFile(*it, string(), true);
511 Buffer * buf = pimpl_->buffer_list_.newBuffer(s, false);
512 if (loadLyXFile(buf, s)) {
514 ErrorList const & el = buf->errorList("Parse");
516 for_each(el.begin(), el.end(),
517 boost::bind(&LyX::printError, this, _1));
520 pimpl_->buffer_list_.release(buf);
524 files.clear(); // the files are already loaded
530 void LyX::execBatchCommands()
532 // Execute batch commands if available
533 if (batch_command.empty())
536 lyxerr[Debug::INIT] << "About to handle -x '"
537 << batch_command << '\'' << endl;
539 pimpl_->lyxfunc_.dispatch(lyxaction.lookupFunc(batch_command));
543 void LyX::restoreGuiSession(vector<string> const & files)
545 LyXView * view = newLyXView();
548 for_each(files.begin(), files.end(),
549 bind(&LyXView::loadLyXFile, view, _1, true));
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));
560 // clear this list to save a few bytes of RAM
561 pimpl_->session_->lastOpened().clear();
565 LyXView * LyX::newLyXView()
570 // determine windows size and position, from lyxrc and/or session
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;
578 if (lyxrc.geometry_width != 0 && lyxrc.geometry_height != 0 ) {
579 width = lyxrc.geometry_width;
580 height = lyxrc.geometry_height;
582 // if lyxrc returns (0,0), then use session info
584 string val = session().sessionInfo().load("WindowWidth");
586 width = convert<unsigned int>(val);
587 val = session().sessionInfo().load("WindowHeight");
589 height = convert<unsigned int>(val);
590 if (session().sessionInfo().load("WindowIsMaximized") == "yes")
592 val = session().sessionInfo().load("IconSizeXY");
594 iconSizeXY = convert<unsigned int>(val);
597 // if user wants to restore window position
600 if (lyxrc.geometry_xysaved) {
601 string val = session().sessionInfo().load("WindowPosX");
603 posx = convert<int>(val);
604 val = session().sessionInfo().load("WindowPosY");
606 posy = convert<int>(val);
609 if (!geometryArg.empty())
615 // create the main window
616 LyXView * view = &pimpl_->application_->createView(width, height, posx, posy, maximize, iconSizeXY, geometryArg);
624 The SIGHUP signal does not exist on Windows and does not need to be handled.
626 Windows handles SIGFPE and SIGSEGV signals as expected.
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.
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.
639 For more information see:
641 http://aspn.activestate.com/ASPN/Mail/Message/ActiveTcl/2034055
642 ...signals are mostly useless on Windows for a variety of reasons that are
645 'UNIX Application Migration Guide, Chapter 9'
646 http://msdn.microsoft.com/library/en-us/dnucmg/html/UCMGch09.asp
648 'How To Terminate an Application "Cleanly" in Win32'
649 http://support.microsoft.com/default.aspx?scid=kb;en-us;178893
653 static void error_handler(int err_sig)
655 // Throw away any signals other than the first one received.
656 static sig_atomic_t handling_error = false;
659 handling_error = true;
661 // We have received a signal indicating a fatal error, so
662 // try and save the data ASAP.
663 LyX::cref().emergencyCleanup();
665 // These lyxerr calls may or may not work:
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
674 // This shouldn't matter here, however, as we've already invoked
679 lyxerr << "\nlyx: SIGHUP signal caught\nBye." << endl;
683 lyxerr << "\nlyx: SIGFPE signal caught\nBye." << endl;
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;
698 // Deinstall the signal handlers
700 signal(SIGHUP, SIG_DFL);
702 signal(SIGINT, SIG_DFL);
703 signal(SIGFPE, SIG_DFL);
704 signal(SIGSEGV, SIG_DFL);
705 signal(SIGTERM, SIG_DFL);
708 if (err_sig == SIGSEGV ||
709 (err_sig != SIGHUP && !getEnv("LYXDEBUG").empty()))
711 if (err_sig == SIGSEGV || !getEnv("LYXDEBUG").empty())
720 void LyX::printError(ErrorItem const & ei)
722 docstring tmp = _("LyX: ") + ei.error + char_type(':')
724 std::cerr << to_utf8(tmp) << std::endl;
728 void LyX::initGuiFont()
730 if (lyxrc.roman_font_name.empty())
731 lyxrc.roman_font_name = pimpl_->application_->romanFontName();
733 if (lyxrc.sans_font_name.empty())
734 lyxrc.sans_font_name = pimpl_->application_->sansFontName();
736 if (lyxrc.typewriter_font_name.empty())
737 lyxrc.typewriter_font_name
738 = pimpl_->application_->typewriterFontName();
745 signal(SIGHUP, error_handler);
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.
753 lyxrc.tempdir_path = package().temp_dir();
754 lyxrc.document_path = package().document_dir();
756 if (lyxrc.template_path.empty()) {
757 lyxrc.template_path = addPath(package().system_support(),
762 // Read configuration files
765 // This one may have been distributed along with LyX.
766 if (!readRcFile("lyxrc.dist"))
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());
776 if (!lyxrc.path_prefix.empty())
777 prependEnvPath("PATH", lyxrc.path_prefix);
779 // Check that user LyX directory is ok.
780 if (queryUserLyXDir(package().explicit_user_support()))
781 reconfigureUserLyXDir();
783 // no need for a splash when there is no GUI
788 // This one is generated in user_support directory by lib/configure.py.
789 if (!readRcFile("lyxrc.defaults"))
792 // Query the OS to know what formats are viewed natively
793 formats.setAutoOpen();
795 // Read lyxrc.dist again to be able to override viewer auto-detection.
796 readRcFile("lyxrc.dist");
798 system_lyxrc = lyxrc;
799 system_formats = formats;
800 system_converters = converters;
801 system_movers = movers;
802 system_lcolor = lcolor;
804 // This one is edited through the preferences dialog.
805 if (!readRcFile("preferences"))
808 if (!readEncodingsFile("encodings"))
810 if (!readLanguagesFile("languages"))
814 lyxerr[Debug::INIT] << "Reading layouts..." << endl;
820 pimpl_->toplevel_keymap_.reset(new kb_keymap);
821 defaultKeyBindings(pimpl_->toplevel_keymap_.get());
822 pimpl_->toplevel_keymap_->read(lyxrc.bind_file);
824 pimpl_->lyxfunc_.initKeySequences(pimpl_->toplevel_keymap_.get());
827 if (!readUIFile(lyxrc.ui_file))
831 if (lyxerr.debugging(Debug::LYXRC))
834 os::windows_style_tex_paths(lyxrc.windows_style_tex_paths);
835 if (!lyxrc.path_prefix.empty())
836 prependEnvPath("PATH", lyxrc.path_prefix);
838 if (fs::exists(lyxrc.document_path) &&
839 fs::is_directory(lyxrc.document_path))
840 package().document_dir() = lyxrc.document_path;
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.
857 if (lyxerr.debugging(Debug::INIT)) {
858 lyxerr << "LyX tmp dir: `" << package().temp_dir() << '\'' << endl;
861 lyxerr[Debug::INIT] << "Reading session information '.lyx/session'..." << endl;
862 pimpl_->session_.reset(new Session(lyxrc.num_lastfiles));
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();
872 void LyX::defaultKeyBindings(kb_keymap * kbmap)
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));
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));
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));
889 kbmap->bind("Return", FuncRequest(LFUN_BREAK_PARAGRAPH));
890 //kbmap->bind("~C-~S-~M-nobreakspace", FuncRequest(LFUN_PROTECTEDSPACE));
892 kbmap->bind("Delete", FuncRequest(LFUN_CHAR_DELETE_FORWARD));
893 kbmap->bind("BackSpace", FuncRequest(LFUN_CHAR_DELETE_BACKWARD));
895 // kbmap->bindings to enable the use of the numeric keypad
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));
924 void LyX::emergencyCleanup() const
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
931 pimpl_->buffer_list_.emergencyWriteAll();
933 pimpl_->lyx_server_->emergencyCleanup();
934 pimpl_->lyx_server_.reset();
935 pimpl_->lyx_socket_.reset();
940 void LyX::deadKeyBindings(kb_keymap * kbmap)
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));
968 // return true if file does not exist or is older than configure.py.
969 bool needsUpdate(string const & file)
971 static string const configure_script =
972 addName(package().system_support(), "configure.py");
973 string const absfile =
974 addName(package().user_support(), file);
976 return (! fs::exists(absfile))
977 || (fs::last_write_time(configure_script)
978 > fs::last_write_time(absfile));
984 bool LyX::queryUserLyXDir(bool explicit_userdir)
986 // Does user directory exist?
987 if (fs::exists(package().user_support()) &&
988 fs::is_directory(package().user_support())) {
991 return needsUpdate("lyxrc.defaults")
992 || needsUpdate("textclass.lst")
993 || needsUpdate("packages.lst");
996 first_start = !explicit_userdir;
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 &&
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())),
1008 _("&Create directory"),
1010 lyxerr << to_utf8(_("No user LyX directory. Exiting.")) << endl;
1011 earlyExit(EXIT_FAILURE);
1014 lyxerr << to_utf8(bformat(_("LyX: Creating directory %1$s"),
1015 from_utf8(package().user_support())))
1018 if (!createDirectory(package().user_support(), 0755)) {
1019 // Failed, so let's exit.
1020 lyxerr << to_utf8(_("Failed to create directory. Exiting."))
1022 earlyExit(EXIT_FAILURE);
1029 bool LyX::readRcFile(string const & name)
1031 lyxerr[Debug::INIT] << "About to read " << name << "... ";
1033 FileName const lyxrc_path = libFileSearch(string(), name);
1034 if (!lyxrc_path.empty()) {
1036 lyxerr[Debug::INIT] << "Found in " << lyxrc_path << endl;
1038 if (lyxrc.read(lyxrc_path) < 0) {
1039 showFileError(name);
1043 lyxerr[Debug::INIT] << "Not found." << lyxrc_path << endl;
1049 // Read the ui file `name'
1050 bool LyX::readUIFile(string const & name)
1060 struct keyword_item uitags[ui_last - 1] = {
1061 { "include", ui_include },
1062 { "menuset", ui_menuset },
1063 { "toolbar", ui_toolbar },
1064 { "toolbars", ui_toolbars }
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);
1073 lyxerr[Debug::INIT] << "UI file '" << name
1074 << "' has been read already. "
1075 << "Is this an include loop?"
1080 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
1082 FileName const ui_path = libFileSearch("ui", name, "ui");
1084 if (ui_path.empty()) {
1085 lyxerr[Debug::INIT] << "Could not find " << name << endl;
1086 showFileError(name);
1089 uifiles.push_back(name);
1091 lyxerr[Debug::INIT] << "Found " << name
1092 << " in " << ui_path << endl;
1093 LyXLex lex(uitags, ui_last - 1);
1094 lex.setFile(ui_path);
1096 lyxerr << "Unable to set LyXLeX for ui file: " << ui_path
1100 if (lyxerr.debugging(Debug::PARSER))
1101 lex.printTable(lyxerr);
1103 while (lex.isOK()) {
1104 switch (lex.lex()) {
1107 string const file = lex.getString();
1108 if (!readUIFile(file))
1113 menubackend.read(lex);
1117 toolbarbackend.read(lex);
1121 toolbarbackend.readToolbars(lex);
1125 if (!rtrim(lex.getString()).empty())
1126 lex.printError("LyX::ReadUIFile: "
1127 "Unknown menu tag: `$$Token'");
1135 // Read the languages file `name'
1136 bool LyX::readLanguagesFile(string const & name)
1138 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
1140 FileName const lang_path = libFileSearch(string(), name);
1141 if (lang_path.empty()) {
1142 showFileError(name);
1145 languages.read(lang_path);
1150 // Read the encodings file `name'
1151 bool LyX::readEncodingsFile(string const & name)
1153 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
1155 FileName const enc_path = libFileSearch(string(), name);
1156 if (enc_path.empty()) {
1157 showFileError(name);
1160 encodings.read(enc_path);
1169 /// return the the number of arguments consumed
1170 typedef boost::function<int(string const &, string const &)> cmd_helper;
1172 int parse_dbg(string const & arg, string const &)
1175 lyxerr << to_utf8(_("List of supported debug flags:")) << endl;
1176 Debug::showTags(lyxerr);
1179 lyxerr << to_utf8(bformat(_("Setting debug level to %1$s"), from_utf8(arg))) << endl;
1181 lyxerr.level(Debug::value(arg));
1182 Debug::showLevel(lyxerr, lyxerr.level());
1187 int parse_help(string const &, string const &)
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;
1212 int parse_version(string const &, string const &)
1214 lyxerr << "LyX " << lyx_version
1215 << " (" << lyx_release_date << ")" << endl;
1216 lyxerr << "Built on " << __DATE__ << ", " << __TIME__ << endl;
1218 lyxerr << lyx_version_info << endl;
1223 int parse_sysdir(string const & arg, string const &)
1226 lyxerr << to_utf8(_("Missing directory for -sysdir switch")) << endl;
1229 cl_system_support = arg;
1233 int parse_userdir(string const & arg, string const &)
1236 lyxerr << to_utf8(_("Missing directory for -userdir switch")) << endl;
1239 cl_user_support = arg;
1243 int parse_execute(string const & arg, string const &)
1246 lyxerr << to_utf8(_("Missing command string after --execute switch")) << endl;
1253 int parse_export(string const & type, string const &)
1256 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1257 "--export switch")) << endl;
1260 batch = "buffer-export " + type;
1265 int parse_import(string const & type, string const & file)
1268 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1269 "--import switch")) << endl;
1273 lyxerr << to_utf8(_("Missing filename for --import")) << endl;
1277 batch = "buffer-import " + type + ' ' + file;
1281 int parse_geometry(string const & arg1, string const &)
1284 #if defined(_WIN32) || (defined(__CYGWIN__) && defined(X_DISPLAY_MISSING))
1285 // remove also the arg
1288 // don't remove "-geometry"
1297 void LyX::easyParse(int & argc, char * argv[])
1299 std::map<string, cmd_helper> cmdmap;
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;
1316 for (int i = 1; i < argc; ++i) {
1317 std::map<string, cmd_helper>::const_iterator it
1318 = cmdmap.find(argv[i]);
1320 // don't complain if not found - may be parsed later
1321 if (it == cmdmap.end())
1324 string arg((i + 1 < argc) ? argv[i + 1] : "");
1325 string arg2((i + 2 < argc) ? argv[i + 2] : "");
1327 int const remove = 1 + it->second(arg, arg2);
1329 // Now, remove used arguments by shifting
1330 // the following ones remove places down.
1332 for (int j = i; j < argc; ++j)
1333 argv[j] = argv[j + remove];
1337 batch_command = batch;
1341 FuncStatus getStatus(FuncRequest const & action)
1343 return LyX::ref().lyxFunc().getStatus(action);
1347 void dispatch(FuncRequest const & action)
1349 LyX::ref().lyxFunc().dispatch(action);
1353 BufferList & theBufferList()
1355 return LyX::ref().bufferList();
1359 LyXFunc & theLyXFunc()
1361 return LyX::ref().lyxFunc();
1365 LyXServer & theLyXServer()
1367 // FIXME: this should not be use_gui dependent
1368 BOOST_ASSERT(use_gui);
1369 return LyX::ref().server();
1373 LyXServerSocket & theLyXServerSocket()
1375 // FIXME: this should not be use_gui dependent
1376 BOOST_ASSERT(use_gui);
1377 return LyX::ref().socket();
1381 kb_keymap & theTopLevelKeymap()
1383 BOOST_ASSERT(use_gui);
1384 return LyX::ref().topLevelKeymap();
1388 IconvProcessor & utf8ToUcs4()
1390 return LyX::ref().iconvProcessor();