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 /// are we using the GUI at all?
105 * We default to true and this is changed to false when the export feature is used.
112 // Filled with the command line arguments "foo" of "-sysdir foo" or
114 string cl_system_support;
115 string cl_user_support;
117 std::string geometryArg;
119 LyX * singleton_ = 0;
121 void showFileError(string const & error)
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)));
129 void reconfigureUserLyXDir()
131 string const configure_command = package().configure_command();
133 lyxerr << to_utf8(_("LyX: reconfiguring user directory")) << endl;
134 support::Path p(package().user_support());
136 one.startscript(Systemcall::Wait, configure_command);
137 lyxerr << "LyX: " << to_utf8(_("Done!")) << endl;
143 /// The main application class private implementation.
144 struct LyX::Singletons
146 Singletons(): iconv(ucs4_codeset, "UTF-8")
149 /// our function handler
152 BufferList buffer_list_;
154 boost::scoped_ptr<kb_keymap> toplevel_keymap_;
156 boost::scoped_ptr<LyXServer> lyx_server_;
158 boost::scoped_ptr<LyXServerSocket> lyx_socket_;
160 boost::scoped_ptr<frontend::Application> application_;
161 /// lyx session, containing lastfiles, lastfilepos, and lastopened
162 boost::scoped_ptr<Session> session_;
165 IconvProcessor iconv;
169 frontend::Application * theApp()
172 return &singleton_->application();
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.
192 BOOST_ASSERT(singleton_);
197 LyX const & LyX::cref()
199 BOOST_ASSERT(singleton_);
208 pimpl_.reset(new Singletons);
213 BufferList & LyX::bufferList()
215 return pimpl_->buffer_list_;
219 BufferList const & LyX::bufferList() const
221 return pimpl_->buffer_list_;
225 Session & LyX::session()
227 BOOST_ASSERT(pimpl_->session_.get());
228 return *pimpl_->session_.get();
232 Session const & LyX::session() const
234 BOOST_ASSERT(pimpl_->session_.get());
235 return *pimpl_->session_.get();
239 LyXFunc & LyX::lyxFunc()
241 return pimpl_->lyxfunc_;
245 LyXFunc const & LyX::lyxFunc() const
247 return pimpl_->lyxfunc_;
251 LyXServer & LyX::server()
253 BOOST_ASSERT(pimpl_->lyx_server_.get());
254 return *pimpl_->lyx_server_.get();
258 LyXServer const & LyX::server() const
260 BOOST_ASSERT(pimpl_->lyx_server_.get());
261 return *pimpl_->lyx_server_.get();
265 LyXServerSocket & LyX::socket()
267 BOOST_ASSERT(pimpl_->lyx_socket_.get());
268 return *pimpl_->lyx_socket_.get();
272 LyXServerSocket const & LyX::socket() const
274 BOOST_ASSERT(pimpl_->lyx_socket_.get());
275 return *pimpl_->lyx_socket_.get();
279 frontend::Application & LyX::application()
281 BOOST_ASSERT(pimpl_->application_.get());
282 return *pimpl_->application_.get();
286 frontend::Application const & LyX::application() const
288 BOOST_ASSERT(pimpl_->application_.get());
289 return *pimpl_->application_.get();
293 kb_keymap & LyX::topLevelKeymap()
295 BOOST_ASSERT(pimpl_->toplevel_keymap_.get());
296 return *pimpl_->toplevel_keymap_.get();
300 IconvProcessor & LyX::iconvProcessor()
302 return pimpl_->iconv;
306 kb_keymap const & LyX::topLevelKeymap() const
308 BOOST_ASSERT(pimpl_->toplevel_keymap_.get());
309 return *pimpl_->toplevel_keymap_.get();
313 Buffer const * const LyX::updateInset(InsetBase const * inset) const
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) {
324 pimpl_->application_->gui().view(*it).updateInset(inset);
332 int LyX::exec(int & argc, char * argv[])
334 // Here we need to parse the command line. At least
335 // we need to parse for "-dbg" and "-help"
336 easyParse(argc, argv);
338 support::init_package(argv[0], cl_system_support, cl_user_support,
339 support::top_build_dir_is_one_level_up);
341 vector<FileName> files;
344 // FIXME: create a ConsoleApplication
345 int exit_status = loadFiles(argc, argv, files);
351 if (batch_command.empty() || pimpl_->buffer_list_.empty()) {
356 BufferList::iterator begin = pimpl_->buffer_list_.begin();
357 BufferList::iterator end = pimpl_->buffer_list_.end();
359 bool final_success = false;
360 for (BufferList::iterator I = begin; I != end; ++I) {
362 bool success = false;
363 buf->dispatch(batch_command, &success);
364 final_success |= success;
367 return !final_success;
370 // Force adding of font path _before_ Application is initialized
371 support::addFontResources();
373 // Let the frontend parse and remove all arguments that it knows
374 pimpl_->application_.reset(createApplication(argc, argv));
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);
382 // Kill the application object before exiting.
383 pimpl_->application_.reset();
389 restoreGuiSession(files);
390 // Start the real execution loop.
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.
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")));
403 exit_status = pimpl_->application_->exec();
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
410 pimpl_->application_.reset();
412 // Restore original font resources after Application is destroyed.
413 support::restoreFontResources();
419 void LyX::prepareExit()
421 // Set a flag that we do quitting from the program,
422 // so no refreshes are necessary.
425 // close buffers first
426 pimpl_->buffer_list_.closeAll();
428 // do any other cleanup procedures now
429 lyxerr[Debug::INFO] << "Deleting tmp dir " << package().temp_dir() << endl;
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;
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);
448 void LyX::earlyExit(int status)
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.
460 lyxerr[Debug::INFO] << "Running QuitLyX." << endl;
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);
474 int LyX::loadFiles(int & argc, char * argv[],
475 vector<FileName> & files)
477 // check for any spurious extra arguments
478 // other than documents
479 for (int argi = 1; argi < argc ; ++argi) {
480 if (argv[argi][0] == '-') {
482 bformat(_("Wrong command line option `%1$s'. Exiting."),
483 from_utf8(argv[argi]))) << endl;
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;
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
499 if (argv[argi][0] == '-')
501 // get absolute path of file and add ".lyx" to
502 // the filename if necessary
503 files.push_back(fileSearch(string(), os::internal_path(argv[argi]), "lyx"));
507 files.push_back(i18nLibFileSearch("examples", "splash.lyx"));
509 Buffer * last_loaded = 0;
511 vector<FileName>::const_iterator it = files.begin();
512 vector<FileName>::const_iterator end = files.end();
514 for (; it != end; ++it) {
516 Buffer * const b = newFile(it->absFilename(), string(), true);
520 Buffer * buf = pimpl_->buffer_list_.newBuffer(it->absFilename(), false);
521 if (loadLyXFile(buf, *it)) {
523 ErrorList const & el = buf->errorList("Parse");
525 for_each(el.begin(), el.end(),
526 boost::bind(&LyX::printError, this, _1));
529 pimpl_->buffer_list_.release(buf);
533 files.clear(); // the files are already loaded
539 void LyX::execBatchCommands()
541 // Execute batch commands if available
542 if (batch_command.empty())
545 lyxerr[Debug::INIT] << "About to handle -x '"
546 << batch_command << '\'' << endl;
548 pimpl_->lyxfunc_.dispatch(lyxaction.lookupFunc(batch_command));
552 void LyX::restoreGuiSession(vector<FileName> const & files)
554 LyXView * view = newLyXView();
557 for_each(files.begin(), files.end(),
558 bind(&LyXView::loadLyXFile, view, _1, true));
560 // if a file is specified, I assume that user wants to edit *that* file
561 if (files.empty() && lyxrc.load_session) {
562 vector<FileName> const & lastopened = pimpl_->session_->lastOpened().getfiles();
563 // do not add to the lastfile list since these files are restored from
564 // last seesion, and should be already there (regular files), or should
565 // not be added at all (help files).
566 for_each(lastopened.begin(), lastopened.end(),
567 bind(&LyXView::loadLyXFile, view, _1, false));
569 // clear this list to save a few bytes of RAM
570 pimpl_->session_->lastOpened().clear();
574 LyXView * LyX::newLyXView()
579 // determine windows size and position, from lyxrc and/or session
581 unsigned int width = 690;
582 unsigned int height = 510;
583 // default icon size, will be overwritten by stored session value
584 unsigned int iconSizeXY = 0;
585 bool maximize = false;
587 if (lyxrc.geometry_width != 0 && lyxrc.geometry_height != 0 ) {
588 width = lyxrc.geometry_width;
589 height = lyxrc.geometry_height;
591 // if lyxrc returns (0,0), then use session info
593 string val = session().sessionInfo().load("WindowWidth");
595 width = convert<unsigned int>(val);
596 val = session().sessionInfo().load("WindowHeight");
598 height = convert<unsigned int>(val);
599 if (session().sessionInfo().load("WindowIsMaximized") == "yes")
601 val = session().sessionInfo().load("IconSizeXY");
603 iconSizeXY = convert<unsigned int>(val);
606 // if user wants to restore window position
609 if (lyxrc.geometry_xysaved) {
610 string val = session().sessionInfo().load("WindowPosX");
612 posx = convert<int>(val);
613 val = session().sessionInfo().load("WindowPosY");
615 posy = convert<int>(val);
618 if (!geometryArg.empty())
624 // create the main window
625 LyXView * view = &pimpl_->application_->createView(width, height, posx, posy, maximize, iconSizeXY, geometryArg);
633 The SIGHUP signal does not exist on Windows and does not need to be handled.
635 Windows handles SIGFPE and SIGSEGV signals as expected.
637 Cntl+C interrupts (mapped to SIGINT by Windows' POSIX compatability layer)
638 cause a new thread to be spawned. This may well result in unexpected
639 behaviour by the single-threaded LyX.
641 SIGTERM signals will come only from another process actually sending
642 that signal using 'raise' in Windows' POSIX compatability layer. It will
643 not come from the general "terminate process" methods that everyone
644 actually uses (and which can't be trapped). Killing an app 'politely' on
645 Windows involves first sending a WM_CLOSE message, something that is
646 caught already by the Qt frontend.
648 For more information see:
650 http://aspn.activestate.com/ASPN/Mail/Message/ActiveTcl/2034055
651 ...signals are mostly useless on Windows for a variety of reasons that are
654 'UNIX Application Migration Guide, Chapter 9'
655 http://msdn.microsoft.com/library/en-us/dnucmg/html/UCMGch09.asp
657 'How To Terminate an Application "Cleanly" in Win32'
658 http://support.microsoft.com/default.aspx?scid=kb;en-us;178893
662 static void error_handler(int err_sig)
664 // Throw away any signals other than the first one received.
665 static sig_atomic_t handling_error = false;
668 handling_error = true;
670 // We have received a signal indicating a fatal error, so
671 // try and save the data ASAP.
672 LyX::cref().emergencyCleanup();
674 // These lyxerr calls may or may not work:
676 // Signals are asynchronous, so the main program may be in a very
677 // fragile state when a signal is processed and thus while a signal
678 // handler function executes.
679 // In general, therefore, we should avoid performing any
680 // I/O operations or calling most library and system functions from
683 // This shouldn't matter here, however, as we've already invoked
688 lyxerr << "\nlyx: SIGHUP signal caught\nBye." << endl;
692 lyxerr << "\nlyx: SIGFPE signal caught\nBye." << endl;
695 lyxerr << "\nlyx: SIGSEGV signal caught\n"
696 "Sorry, you have found a bug in LyX. "
697 "Please read the bug-reporting instructions "
698 "in Help->Introduction and send us a bug report, "
699 "if necessary. Thanks !\nBye." << endl;
707 // Deinstall the signal handlers
709 signal(SIGHUP, SIG_DFL);
711 signal(SIGINT, SIG_DFL);
712 signal(SIGFPE, SIG_DFL);
713 signal(SIGSEGV, SIG_DFL);
714 signal(SIGTERM, SIG_DFL);
717 if (err_sig == SIGSEGV ||
718 (err_sig != SIGHUP && !getEnv("LYXDEBUG").empty()))
720 if (err_sig == SIGSEGV || !getEnv("LYXDEBUG").empty())
729 void LyX::printError(ErrorItem const & ei)
731 docstring tmp = _("LyX: ") + ei.error + char_type(':')
733 std::cerr << to_utf8(tmp) << std::endl;
737 void LyX::initGuiFont()
739 if (lyxrc.roman_font_name.empty())
740 lyxrc.roman_font_name = pimpl_->application_->romanFontName();
742 if (lyxrc.sans_font_name.empty())
743 lyxrc.sans_font_name = pimpl_->application_->sansFontName();
745 if (lyxrc.typewriter_font_name.empty())
746 lyxrc.typewriter_font_name
747 = pimpl_->application_->typewriterFontName();
754 signal(SIGHUP, error_handler);
756 signal(SIGFPE, error_handler);
757 signal(SIGSEGV, error_handler);
758 signal(SIGINT, error_handler);
759 signal(SIGTERM, error_handler);
760 // SIGPIPE can be safely ignored.
762 lyxrc.tempdir_path = package().temp_dir();
763 lyxrc.document_path = package().document_dir();
765 if (lyxrc.template_path.empty()) {
766 lyxrc.template_path = addPath(package().system_support(),
771 // Read configuration files
774 // This one may have been distributed along with LyX.
775 if (!readRcFile("lyxrc.dist"))
778 // Set the PATH correctly.
779 #if !defined (USE_POSIX_PACKAGING)
780 // Add the directory containing the LyX executable to the path
781 // so that LyX can find things like tex2lyx.
782 if (package().build_support().empty())
783 prependEnvPath("PATH", package().binary_dir());
785 if (!lyxrc.path_prefix.empty())
786 prependEnvPath("PATH", lyxrc.path_prefix);
788 // Check that user LyX directory is ok.
789 if (queryUserLyXDir(package().explicit_user_support()))
790 reconfigureUserLyXDir();
792 // no need for a splash when there is no GUI
797 // This one is generated in user_support directory by lib/configure.py.
798 if (!readRcFile("lyxrc.defaults"))
801 // Query the OS to know what formats are viewed natively
802 formats.setAutoOpen();
804 // Read lyxrc.dist again to be able to override viewer auto-detection.
805 readRcFile("lyxrc.dist");
807 system_lyxrc = lyxrc;
808 system_formats = formats;
809 system_converters = converters;
810 system_movers = movers;
811 system_lcolor = lcolor;
813 // This one is edited through the preferences dialog.
814 if (!readRcFile("preferences"))
817 if (!readEncodingsFile("encodings"))
819 if (!readLanguagesFile("languages"))
823 lyxerr[Debug::INIT] << "Reading layouts..." << endl;
829 pimpl_->toplevel_keymap_.reset(new kb_keymap);
830 defaultKeyBindings(pimpl_->toplevel_keymap_.get());
831 pimpl_->toplevel_keymap_->read(lyxrc.bind_file);
833 pimpl_->lyxfunc_.initKeySequences(pimpl_->toplevel_keymap_.get());
836 if (!readUIFile(lyxrc.ui_file))
840 if (lyxerr.debugging(Debug::LYXRC))
843 os::windows_style_tex_paths(lyxrc.windows_style_tex_paths);
844 if (!lyxrc.path_prefix.empty())
845 prependEnvPath("PATH", lyxrc.path_prefix);
847 if (fs::exists(lyxrc.document_path) &&
848 fs::is_directory(lyxrc.document_path))
849 package().document_dir() = lyxrc.document_path;
851 package().temp_dir() = createLyXTmpDir(FileName(lyxrc.tempdir_path)).absFilename();
852 if (package().temp_dir().empty()) {
853 Alert::error(_("Could not create temporary directory"),
854 bformat(_("Could not create a temporary directory in\n"
855 "%1$s. Make sure that this\n"
856 "path exists and is writable and try again."),
857 from_utf8(lyxrc.tempdir_path)));
858 // createLyXTmpDir() tries sufficiently hard to create a
859 // usable temp dir, so the probability to come here is
860 // close to zero. We therefore don't try to overcome this
861 // problem with e.g. asking the user for a new path and
862 // trying again but simply exit.
866 if (lyxerr.debugging(Debug::INIT)) {
867 lyxerr << "LyX tmp dir: `" << package().temp_dir() << '\'' << endl;
870 lyxerr[Debug::INIT] << "Reading session information '.lyx/session'..." << endl;
871 pimpl_->session_.reset(new Session(lyxrc.num_lastfiles));
873 // This must happen after package initialization and after lyxrc is
874 // read, therefore it can't be done by a static object.
875 ConverterCache::init();
881 void LyX::defaultKeyBindings(kb_keymap * kbmap)
883 kbmap->bind("Right", FuncRequest(LFUN_CHAR_FORWARD));
884 kbmap->bind("Left", FuncRequest(LFUN_CHAR_BACKWARD));
885 kbmap->bind("Up", FuncRequest(LFUN_UP));
886 kbmap->bind("Down", FuncRequest(LFUN_DOWN));
888 kbmap->bind("Tab", FuncRequest(LFUN_CELL_FORWARD));
889 kbmap->bind("C-Tab", FuncRequest(LFUN_CELL_SPLIT));
890 kbmap->bind("~S-ISO_Left_Tab", FuncRequest(LFUN_CELL_BACKWARD));
891 kbmap->bind("~S-BackTab", FuncRequest(LFUN_CELL_BACKWARD));
893 kbmap->bind("Home", FuncRequest(LFUN_LINE_BEGIN));
894 kbmap->bind("End", FuncRequest(LFUN_LINE_END));
895 kbmap->bind("Prior", FuncRequest(LFUN_SCREEN_UP));
896 kbmap->bind("Next", FuncRequest(LFUN_SCREEN_DOWN));
898 kbmap->bind("Return", FuncRequest(LFUN_BREAK_PARAGRAPH));
899 //kbmap->bind("~C-~S-~M-nobreakspace", FuncRequest(LFUN_PROTECTEDSPACE));
901 kbmap->bind("Delete", FuncRequest(LFUN_CHAR_DELETE_FORWARD));
902 kbmap->bind("BackSpace", FuncRequest(LFUN_CHAR_DELETE_BACKWARD));
904 // kbmap->bindings to enable the use of the numeric keypad
906 //kbmap->bind("KP_0", FuncRequest(LFUN_SELF_INSERT));
907 //kbmap->bind("KP_Decimal", FuncRequest(LFUN_SELF_INSERT));
908 kbmap->bind("KP_Enter", FuncRequest(LFUN_BREAK_PARAGRAPH));
909 //kbmap->bind("KP_1", FuncRequest(LFUN_SELF_INSERT));
910 //kbmap->bind("KP_2", FuncRequest(LFUN_SELF_INSERT));
911 //kbmap->bind("KP_3", FuncRequest(LFUN_SELF_INSERT));
912 //kbmap->bind("KP_4", FuncRequest(LFUN_SELF_INSERT));
913 //kbmap->bind("KP_5", FuncRequest(LFUN_SELF_INSERT));
914 //kbmap->bind("KP_6", FuncRequest(LFUN_SELF_INSERT));
915 //kbmap->bind("KP_Add", FuncRequest(LFUN_SELF_INSERT));
916 //kbmap->bind("KP_7", FuncRequest(LFUN_SELF_INSERT));
917 //kbmap->bind("KP_8", FuncRequest(LFUN_SELF_INSERT));
918 //kbmap->bind("KP_9", FuncRequest(LFUN_SELF_INSERT));
919 //kbmap->bind("KP_Divide", FuncRequest(LFUN_SELF_INSERT));
920 //kbmap->bind("KP_Multiply", FuncRequest(LFUN_SELF_INSERT));
921 //kbmap->bind("KP_Subtract", FuncRequest(LFUN_SELF_INSERT));
922 kbmap->bind("KP_Right", FuncRequest(LFUN_CHAR_FORWARD));
923 kbmap->bind("KP_Left", FuncRequest(LFUN_CHAR_BACKWARD));
924 kbmap->bind("KP_Up", FuncRequest(LFUN_UP));
925 kbmap->bind("KP_Down", FuncRequest(LFUN_DOWN));
926 kbmap->bind("KP_Home", FuncRequest(LFUN_LINE_BEGIN));
927 kbmap->bind("KP_End", FuncRequest(LFUN_LINE_END));
928 kbmap->bind("KP_Prior", FuncRequest(LFUN_SCREEN_UP));
929 kbmap->bind("KP_Next", FuncRequest(LFUN_SCREEN_DOWN));
933 void LyX::emergencyCleanup() const
935 // what to do about tmpfiles is non-obvious. we would
936 // like to delete any we find, but our lyxdir might
937 // contain documents etc. which might be helpful on
940 pimpl_->buffer_list_.emergencyWriteAll();
942 if (pimpl_->lyx_server_)
943 pimpl_->lyx_server_->emergencyCleanup();
944 pimpl_->lyx_server_.reset();
945 pimpl_->lyx_socket_.reset();
950 void LyX::deadKeyBindings(kb_keymap * kbmap)
952 // bindKeyings for transparent handling of deadkeys
953 // The keysyms are gotten from XFree86 X11R6
954 kbmap->bind("~C-~S-~M-dead_acute", FuncRequest(LFUN_ACCENT_ACUTE));
955 kbmap->bind("~C-~S-~M-dead_breve", FuncRequest(LFUN_ACCENT_BREVE));
956 kbmap->bind("~C-~S-~M-dead_caron", FuncRequest(LFUN_ACCENT_CARON));
957 kbmap->bind("~C-~S-~M-dead_cedilla", FuncRequest(LFUN_ACCENT_CEDILLA));
958 kbmap->bind("~C-~S-~M-dead_abovering", FuncRequest(LFUN_ACCENT_CIRCLE));
959 kbmap->bind("~C-~S-~M-dead_circumflex", FuncRequest(LFUN_ACCENT_CIRCUMFLEX));
960 kbmap->bind("~C-~S-~M-dead_abovedot", FuncRequest(LFUN_ACCENT_DOT));
961 kbmap->bind("~C-~S-~M-dead_grave", FuncRequest(LFUN_ACCENT_GRAVE));
962 kbmap->bind("~C-~S-~M-dead_doubleacute", FuncRequest(LFUN_ACCENT_HUNGARIAN_UMLAUT));
963 kbmap->bind("~C-~S-~M-dead_macron", FuncRequest(LFUN_ACCENT_MACRON));
964 // nothing with this name
965 // kbmap->bind("~C-~S-~M-dead_special_caron", LFUN_ACCENT_SPECIAL_CARON);
966 kbmap->bind("~C-~S-~M-dead_tilde", FuncRequest(LFUN_ACCENT_TILDE));
967 kbmap->bind("~C-~S-~M-dead_diaeresis", FuncRequest(LFUN_ACCENT_UMLAUT));
968 // nothing with this name either...
969 //kbmap->bind("~C-~S-~M-dead_underbar", FuncRequest(LFUN_ACCENT_UNDERBAR));
970 kbmap->bind("~C-~S-~M-dead_belowdot", FuncRequest(LFUN_ACCENT_UNDERDOT));
971 kbmap->bind("~C-~S-~M-dead_tie", FuncRequest(LFUN_ACCENT_TIE));
972 kbmap->bind("~C-~S-~M-dead_ogonek",FuncRequest(LFUN_ACCENT_OGONEK));
978 // return true if file does not exist or is older than configure.py.
979 bool needsUpdate(string const & file)
981 static string const configure_script =
982 addName(package().system_support(), "configure.py");
983 string const absfile =
984 addName(package().user_support(), file);
986 return (! fs::exists(absfile))
987 || (fs::last_write_time(configure_script)
988 > fs::last_write_time(absfile));
994 bool LyX::queryUserLyXDir(bool explicit_userdir)
996 // Does user directory exist?
997 if (fs::exists(package().user_support()) &&
998 fs::is_directory(package().user_support())) {
1001 return needsUpdate("lyxrc.defaults")
1002 || needsUpdate("textclass.lst")
1003 || needsUpdate("packages.lst");
1006 first_start = !explicit_userdir;
1008 // If the user specified explicitly a directory, ask whether
1009 // to create it. If the user says "no", then exit.
1010 if (explicit_userdir &&
1012 _("Missing user LyX directory"),
1013 bformat(_("You have specified a non-existent user "
1014 "LyX directory, %1$s.\n"
1015 "It is needed to keep your own configuration."),
1016 from_utf8(package().user_support())),
1018 _("&Create directory"),
1020 lyxerr << to_utf8(_("No user LyX directory. Exiting.")) << endl;
1021 earlyExit(EXIT_FAILURE);
1024 lyxerr << to_utf8(bformat(_("LyX: Creating directory %1$s"),
1025 from_utf8(package().user_support())))
1028 if (!createDirectory(package().user_support(), 0755)) {
1029 // Failed, so let's exit.
1030 lyxerr << to_utf8(_("Failed to create directory. Exiting."))
1032 earlyExit(EXIT_FAILURE);
1039 bool LyX::readRcFile(string const & name)
1041 lyxerr[Debug::INIT] << "About to read " << name << "... ";
1043 FileName const lyxrc_path = libFileSearch(string(), name);
1044 if (!lyxrc_path.empty()) {
1046 lyxerr[Debug::INIT] << "Found in " << lyxrc_path << endl;
1048 if (lyxrc.read(lyxrc_path) < 0) {
1049 showFileError(name);
1053 lyxerr[Debug::INIT] << "Not found." << lyxrc_path << endl;
1059 // Read the ui file `name'
1060 bool LyX::readUIFile(string const & name)
1070 struct keyword_item uitags[ui_last - 1] = {
1071 { "include", ui_include },
1072 { "menuset", ui_menuset },
1073 { "toolbar", ui_toolbar },
1074 { "toolbars", ui_toolbars }
1077 // Ensure that a file is read only once (prevents include loops)
1078 static std::list<string> uifiles;
1079 std::list<string>::const_iterator it = uifiles.begin();
1080 std::list<string>::const_iterator end = uifiles.end();
1081 it = std::find(it, end, name);
1083 lyxerr[Debug::INIT] << "UI file '" << name
1084 << "' has been read already. "
1085 << "Is this an include loop?"
1090 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
1092 FileName const ui_path = libFileSearch("ui", name, "ui");
1094 if (ui_path.empty()) {
1095 lyxerr[Debug::INIT] << "Could not find " << name << endl;
1096 showFileError(name);
1099 uifiles.push_back(name);
1101 lyxerr[Debug::INIT] << "Found " << name
1102 << " in " << ui_path << endl;
1103 LyXLex lex(uitags, ui_last - 1);
1104 lex.setFile(ui_path);
1106 lyxerr << "Unable to set LyXLeX for ui file: " << ui_path
1110 if (lyxerr.debugging(Debug::PARSER))
1111 lex.printTable(lyxerr);
1113 while (lex.isOK()) {
1114 switch (lex.lex()) {
1117 string const file = lex.getString();
1118 if (!readUIFile(file))
1123 menubackend.read(lex);
1127 toolbarbackend.read(lex);
1131 toolbarbackend.readToolbars(lex);
1135 if (!rtrim(lex.getString()).empty())
1136 lex.printError("LyX::ReadUIFile: "
1137 "Unknown menu tag: `$$Token'");
1145 // Read the languages file `name'
1146 bool LyX::readLanguagesFile(string const & name)
1148 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
1150 FileName const lang_path = libFileSearch(string(), name);
1151 if (lang_path.empty()) {
1152 showFileError(name);
1155 languages.read(lang_path);
1160 // Read the encodings file `name'
1161 bool LyX::readEncodingsFile(string const & name)
1163 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
1165 FileName const enc_path = libFileSearch(string(), name);
1166 if (enc_path.empty()) {
1167 showFileError(name);
1170 encodings.read(enc_path);
1179 /// return the the number of arguments consumed
1180 typedef boost::function<int(string const &, string const &)> cmd_helper;
1182 int parse_dbg(string const & arg, string const &)
1185 lyxerr << to_utf8(_("List of supported debug flags:")) << endl;
1186 Debug::showTags(lyxerr);
1189 lyxerr << to_utf8(bformat(_("Setting debug level to %1$s"), from_utf8(arg))) << endl;
1191 lyxerr.level(Debug::value(arg));
1192 Debug::showLevel(lyxerr, lyxerr.level());
1197 int parse_help(string const &, string const &)
1200 to_utf8(_("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
1201 "Command line switches (case sensitive):\n"
1202 "\t-help summarize LyX usage\n"
1203 "\t-userdir dir set user directory to dir\n"
1204 "\t-sysdir dir set system directory to dir\n"
1205 "\t-geometry WxH+X+Y set geometry of the main window\n"
1206 "\t-dbg feature[,feature]...\n"
1207 " select the features to debug.\n"
1208 " Type `lyx -dbg' to see the list of features\n"
1209 "\t-x [--execute] command\n"
1210 " where command is a lyx command.\n"
1211 "\t-e [--export] fmt\n"
1212 " where fmt is the export format of choice.\n"
1213 "\t-i [--import] fmt file.xxx\n"
1214 " where fmt is the import format of choice\n"
1215 " and file.xxx is the file to be imported.\n"
1216 "\t-version summarize version and build info\n"
1217 "Check the LyX man page for more details.")) << endl;
1222 int parse_version(string const &, string const &)
1224 lyxerr << "LyX " << lyx_version
1225 << " (" << lyx_release_date << ")" << endl;
1226 lyxerr << "Built on " << __DATE__ << ", " << __TIME__ << endl;
1228 lyxerr << lyx_version_info << endl;
1233 int parse_sysdir(string const & arg, string const &)
1236 lyxerr << to_utf8(_("Missing directory for -sysdir switch")) << endl;
1239 cl_system_support = arg;
1243 int parse_userdir(string const & arg, string const &)
1246 lyxerr << to_utf8(_("Missing directory for -userdir switch")) << endl;
1249 cl_user_support = arg;
1253 int parse_execute(string const & arg, string const &)
1256 lyxerr << to_utf8(_("Missing command string after --execute switch")) << endl;
1263 int parse_export(string const & type, string const &)
1266 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1267 "--export switch")) << endl;
1270 batch = "buffer-export " + type;
1275 int parse_import(string const & type, string const & file)
1278 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1279 "--import switch")) << endl;
1283 lyxerr << to_utf8(_("Missing filename for --import")) << endl;
1287 batch = "buffer-import " + type + ' ' + file;
1291 int parse_geometry(string const & arg1, string const &)
1294 #if defined(_WIN32) || (defined(__CYGWIN__) && defined(X_DISPLAY_MISSING))
1295 // remove also the arg
1298 // don't remove "-geometry"
1307 void LyX::easyParse(int & argc, char * argv[])
1309 std::map<string, cmd_helper> cmdmap;
1311 cmdmap["-dbg"] = parse_dbg;
1312 cmdmap["-help"] = parse_help;
1313 cmdmap["--help"] = parse_help;
1314 cmdmap["-version"] = parse_version;
1315 cmdmap["--version"] = parse_version;
1316 cmdmap["-sysdir"] = parse_sysdir;
1317 cmdmap["-userdir"] = parse_userdir;
1318 cmdmap["-x"] = parse_execute;
1319 cmdmap["--execute"] = parse_execute;
1320 cmdmap["-e"] = parse_export;
1321 cmdmap["--export"] = parse_export;
1322 cmdmap["-i"] = parse_import;
1323 cmdmap["--import"] = parse_import;
1324 cmdmap["-geometry"] = parse_geometry;
1326 for (int i = 1; i < argc; ++i) {
1327 std::map<string, cmd_helper>::const_iterator it
1328 = cmdmap.find(argv[i]);
1330 // don't complain if not found - may be parsed later
1331 if (it == cmdmap.end())
1334 string arg((i + 1 < argc) ? argv[i + 1] : "");
1335 string arg2((i + 2 < argc) ? argv[i + 2] : "");
1337 int const remove = 1 + it->second(arg, arg2);
1339 // Now, remove used arguments by shifting
1340 // the following ones remove places down.
1343 for (int j = i; j < argc; ++j)
1344 argv[j] = argv[j + remove];
1349 batch_command = batch;
1353 FuncStatus getStatus(FuncRequest const & action)
1355 return LyX::ref().lyxFunc().getStatus(action);
1359 void dispatch(FuncRequest const & action)
1361 LyX::ref().lyxFunc().dispatch(action);
1365 BufferList & theBufferList()
1367 return LyX::ref().bufferList();
1371 LyXFunc & theLyXFunc()
1373 return LyX::ref().lyxFunc();
1377 LyXServer & theLyXServer()
1379 // FIXME: this should not be use_gui dependent
1380 BOOST_ASSERT(use_gui);
1381 return LyX::ref().server();
1385 LyXServerSocket & theLyXServerSocket()
1387 // FIXME: this should not be use_gui dependent
1388 BOOST_ASSERT(use_gui);
1389 return LyX::ref().socket();
1393 kb_keymap & theTopLevelKeymap()
1395 BOOST_ASSERT(use_gui);
1396 return LyX::ref().topLevelKeymap();
1400 IconvProcessor & utf8ToUcs4()
1402 return LyX::ref().iconvProcessor();