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 "AspellChecker.h"
22 #include "BufferList.h"
25 #include "ConverterCache.h"
26 #include "Converter.h"
27 #include "CutAndPaste.h"
29 #include "ErrorList.h"
31 #include "FuncStatus.h"
34 #include "LayoutFile.h"
36 #include "LyXAction.h"
39 #include "ModuleList.h"
42 #include "ServerSocket.h"
45 #include "frontends/alert.h"
46 #include "frontends/Application.h"
48 #include "graphics/Previews.h"
50 #include "support/lassert.h"
51 #include "support/debug.h"
52 #include "support/environment.h"
53 #include "support/ExceptionMessage.h"
54 #include "support/filetools.h"
55 #include "support/gettext.h"
56 #include "support/lstrings.h"
57 #include "support/Messages.h"
58 #include "support/os.h"
59 #include "support/Package.h"
60 #include "support/Path.h"
61 #include "support/Systemcall.h"
63 #include <boost/bind.hpp>
64 #include <boost/scoped_ptr.hpp>
75 using namespace lyx::support;
79 namespace Alert = frontend::Alert;
80 namespace os = support::os;
84 // Are we using the GUI at all? We default to true and this is changed
85 // to false when the export feature is used.
91 // Filled with the command line arguments "foo" of "-sysdir foo" or
93 string cl_system_support;
94 string cl_user_support;
100 void showFileError(string const & error)
102 Alert::warning(_("Could not read configuration file"),
103 bformat(_("Error while reading the configuration file\n%1$s.\n"
104 "Please check your installation."), from_utf8(error)));
108 void reconfigureUserLyXDir()
110 string const configure_command = package().configure_command();
112 lyxerr << to_utf8(_("LyX: reconfiguring user directory")) << endl;
113 PathChanger p(package().user_support());
115 one.startscript(Systemcall::Wait, configure_command);
116 lyxerr << "LyX: " << to_utf8(_("Done!")) << endl;
122 /// The main application class private implementation.
127 // Set the default User Interface language as soon as possible.
128 // The language used will be derived from the environment
130 messages_["GUI"] = Messages();
132 #if defined(USE_ASPELL)
133 spell_checker_ = new AspellChecker();
141 delete spell_checker_;
144 /// our function handler
147 BufferList buffer_list_;
149 KeyMap toplevel_keymap_;
151 CmdDef toplevel_cmddef_;
153 boost::scoped_ptr<Server> lyx_server_;
155 boost::scoped_ptr<ServerSocket> lyx_socket_;
157 boost::scoped_ptr<frontend::Application> application_;
158 /// lyx session, containing lastfiles, lastfilepos, and lastopened
159 boost::scoped_ptr<Session> session_;
161 /// Files to load at start.
162 vector<string> files_to_load_;
164 /// The messages translators.
165 map<string, Messages> messages_;
167 /// The file converters.
168 Converters converters_;
170 // The system converters copy after reading lyxrc.defaults.
171 Converters system_converters_;
176 Movers system_movers_;
178 /// has this user started lyx for the first time?
180 /// the parsed command line batch command if any
181 vector<string> batch_commands;
184 graphics::Previews preview_;
186 SpellChecker * spell_checker_;
190 frontend::Application * theApp()
193 return singleton_->pimpl_->application_.get();
206 void lyx_exit(int exit_code)
209 // Something wrong happened so better save everything, just in
214 // Properly crash in debug mode in order to get a useful backtrace.
218 // In release mode, try to exit gracefully.
220 theApp()->exit(exit_code);
234 Messages & LyX::messages(string const & language)
236 map<string, Messages>::iterator it = pimpl_->messages_.find(language);
238 if (it != pimpl_->messages_.end())
241 pair<map<string, Messages>::iterator, bool> result =
242 pimpl_->messages_.insert(make_pair(language, Messages(language)));
244 LASSERT(result.second, /**/);
245 return result.first->second;
249 void setRcGuiLanguage()
251 LASSERT(singleton_, /**/);
252 if (lyxrc.gui_language == "auto")
254 Language const * language = languages.getLanguage(lyxrc.gui_language);
256 LYXERR(Debug::LOCALE, "Setting LANGUAGE to " << language->code());
257 if (!setEnv("LANGUAGE", language->code()))
258 LYXERR(Debug::LOCALE, "\t... failed!");
260 LYXERR(Debug::LOCALE, "Setting LC_ALL to en_US");
261 if (!setEnv("LC_ALL", "en_US"))
262 LYXERR(Debug::LOCALE, "\t... failed!");
264 singleton_->pimpl_->messages_["GUI"] = Messages();
268 int LyX::exec(int & argc, char * argv[])
270 // Here we need to parse the command line. At least
271 // we need to parse for "-dbg" and "-help"
272 easyParse(argc, argv);
275 init_package(to_utf8(from_local8bit(argv[0])),
276 cl_system_support, cl_user_support,
277 top_build_dir_is_one_level_up);
278 } catch (ExceptionMessage const & message) {
279 if (message.type_ == ErrorException) {
280 Alert::error(message.title_, message.details_);
282 } else if (message.type_ == WarningException) {
283 Alert::warning(message.title_, message.details_);
287 // Reinit the messages machinery in case package() knows
288 // something interesting about the locale directory.
292 // FIXME: create a ConsoleApplication
293 int exit_status = init(argc, argv);
299 // this is correct, since return values are inverted.
300 exit_status = !loadFiles();
302 if (pimpl_->batch_commands.empty() || pimpl_->buffer_list_.empty()) {
307 BufferList::iterator begin = pimpl_->buffer_list_.begin();
309 bool final_success = false;
310 for (BufferList::iterator I = begin; I != pimpl_->buffer_list_.end(); ++I) {
312 if (buf != buf->masterBuffer())
314 vector<string>::const_iterator bcit = pimpl_->batch_commands.begin();
315 vector<string>::const_iterator bcend = pimpl_->batch_commands.end();
317 for (; bcit != bcend; bcit++) {
318 LYXERR(Debug::ACTION, "Buffer::dispatch: cmd: " << *bcit);
319 buf->dispatch(*bcit, dr);
320 final_success |= !dr.error();
324 return !final_success;
327 // Let the frontend parse and remove all arguments that it knows
328 pimpl_->application_.reset(createApplication(argc, argv));
330 // Reestablish our defaults, as Qt overwrites them
331 // after createApplication()
334 // Parse and remove all known arguments in the LyX singleton
335 // Give an error for all remaining ones.
336 int exit_status = init(argc, argv);
338 // Kill the application object before exiting.
339 pimpl_->application_.reset();
346 /* Create a CoreApplication class that will provide the main event loop
347 * and the socket callback registering. With Qt4, only QtCore
348 * library would be needed.
349 * When this is done, a server_mode could be created and the following two
350 * line would be moved out from here.
352 // Note: socket callback must be registered after init(argc, argv)
353 // such that package().temp_dir() is properly initialized.
354 pimpl_->lyx_server_.reset(new Server(&pimpl_->lyxfunc_, lyxrc.lyxpipes));
355 pimpl_->lyx_socket_.reset(new ServerSocket(&pimpl_->lyxfunc_,
356 FileName(package().temp_dir().absFilename() + "/lyxsocket")));
358 // Start the real execution loop.
359 exit_status = pimpl_->application_->exec();
367 void LyX::prepareExit()
369 // Clear the clipboard and selection stack:
370 cap::clearCutStack();
371 cap::clearSelection();
373 // Write the index file of the converter cache
374 ConverterCache::get().writeIndex();
376 // close buffers first
377 pimpl_->buffer_list_.closeAll();
379 // register session changes and shutdown server and socket
381 if (pimpl_->session_)
382 pimpl_->session_->writeFile();
383 pimpl_->session_.reset();
384 pimpl_->lyx_server_.reset();
385 pimpl_->lyx_socket_.reset();
388 // do any other cleanup procedures now
389 if (package().temp_dir() != package().system_temp_dir()) {
390 string const abs_tmpdir = package().temp_dir().absFilename();
391 if (!contains(package().temp_dir().absFilename(), "lyx_tmpdir")) {
392 docstring const msg =
393 bformat(_("%1$s does not appear like a LyX created temporary directory."),
394 from_utf8(abs_tmpdir));
395 Alert::warning(_("Cannot remove temporary directory"), msg);
397 LYXERR(Debug::INFO, "Deleting tmp dir "
398 << package().temp_dir().absFilename());
399 if (!package().temp_dir().destroyDirectory()) {
400 docstring const msg =
401 bformat(_("Unable to remove the temporary directory %1$s"),
402 from_utf8(package().temp_dir().absFilename()));
403 Alert::warning(_("Unable to remove temporary directory"), msg);
408 // Kill the application object before exiting. This avoids crashes
409 // when exiting on Linux.
410 if (pimpl_->application_)
411 pimpl_->application_.reset();
415 void LyX::earlyExit(int status)
417 LASSERT(pimpl_->application_.get(), /**/);
418 // LyX::pimpl_::application_ is not initialised at this
419 // point so it's safe to just exit after some cleanup.
425 int LyX::init(int & argc, char * argv[])
427 // check for any spurious extra arguments
428 // other than documents
429 for (int argi = 1; argi < argc ; ++argi) {
430 if (argv[argi][0] == '-') {
432 bformat(_("Wrong command line option `%1$s'. Exiting."),
433 from_utf8(argv[argi]))) << endl;
438 // Initialization of LyX (reads lyxrc and more)
439 LYXERR(Debug::INIT, "Initializing LyX::init...");
440 bool success = init();
441 LYXERR(Debug::INIT, "Initializing LyX::init...done");
445 // Remaining arguments are assumed to be files to load.
446 for (int argi = argc - 1; argi >= 1; --argi)
447 pimpl_->files_to_load_.push_back(to_utf8(from_local8bit(argv[argi])));
450 pimpl_->files_to_load_.push_back(
451 i18nLibFileSearch("examples", "splash.lyx").absFilename());
458 bool LyX::loadFiles()
460 LASSERT(!use_gui, /**/);
462 vector<string>::const_iterator it = pimpl_->files_to_load_.begin();
463 vector<string>::const_iterator end = pimpl_->files_to_load_.end();
465 for (; it != end; ++it) {
466 // get absolute path of file and add ".lyx" to
467 // the filename if necessary
468 FileName fname = fileSearch(string(), os::internal_path(*it), "lyx",
474 Buffer * buf = pimpl_->buffer_list_.newBuffer(fname.absFilename(), false);
475 if (buf->loadLyXFile(fname)) {
476 ErrorList const & el = buf->errorList("Parse");
478 for_each(el.begin(), el.end(),
479 boost::bind(&LyX::printError, this, _1));
482 pimpl_->buffer_list_.release(buf);
490 void execBatchCommands()
492 LASSERT(singleton_, /**/);
493 singleton_->execCommands();
497 void LyX::execCommands()
499 // The advantage of doing this here is that the event loop
500 // is already started. So any need for interaction will be
503 // if reconfiguration is needed.
504 while (LayoutFileList::get().empty()) {
505 switch (Alert::prompt(
506 _("No textclass is found"),
507 _("LyX cannot continue because no textclass is found. "
508 "You can either reconfigure normally, or reconfigure using "
509 "default textclasses, or quit LyX."),
516 // regular reconfigure
517 pimpl_->lyxfunc_.dispatch(FuncRequest(LFUN_RECONFIGURE, ""));
520 // reconfigure --without-latex-config
521 pimpl_->lyxfunc_.dispatch(FuncRequest(LFUN_RECONFIGURE,
522 " --without-latex-config"));
525 pimpl_->lyxfunc_.dispatch(FuncRequest(LFUN_LYX_QUIT));
530 // create the first main window
531 pimpl_->lyxfunc_.dispatch(FuncRequest(LFUN_WINDOW_NEW, geometryArg));
533 if (!pimpl_->files_to_load_.empty()) {
534 // if some files were specified at command-line we assume that the
535 // user wants to edit *these* files and not to restore the session.
536 for (size_t i = 0; i != pimpl_->files_to_load_.size(); ++i) {
537 pimpl_->lyxfunc_.dispatch(
538 FuncRequest(LFUN_FILE_OPEN, pimpl_->files_to_load_[i]));
540 // clear this list to save a few bytes of RAM
541 pimpl_->files_to_load_.clear();
543 pimpl_->application_->restoreGuiSession();
545 // Execute batch commands if available
546 if (pimpl_->batch_commands.empty())
549 vector<string>::const_iterator bcit = pimpl_->batch_commands.begin();
550 vector<string>::const_iterator bcend = pimpl_->batch_commands.end();
551 for (; bcit != bcend; bcit++) {
552 LYXERR(Debug::INIT, "About to handle -x '" << *bcit << '\'');
553 pimpl_->lyxfunc_.dispatch(lyxaction.lookupFunc(*bcit));
561 The SIGHUP signal does not exist on Windows and does not need to be handled.
563 Windows handles SIGFPE and SIGSEGV signals as expected.
565 Ctrl+C interrupts (mapped to SIGINT by Windows' POSIX compatability layer)
566 cause a new thread to be spawned. This may well result in unexpected
567 behaviour by the single-threaded LyX.
569 SIGTERM signals will come only from another process actually sending
570 that signal using 'raise' in Windows' POSIX compatability layer. It will
571 not come from the general "terminate process" methods that everyone
572 actually uses (and which can't be trapped). Killing an app 'politely' on
573 Windows involves first sending a WM_CLOSE message, something that is
574 caught already by the Qt frontend.
576 For more information see:
578 http://aspn.activestate.com/ASPN/Mail/Message/ActiveTcl/2034055
579 ...signals are mostly useless on Windows for a variety of reasons that are
582 'UNIX Application Migration Guide, Chapter 9'
583 http://msdn.microsoft.com/library/en-us/dnucmg/html/UCMGch09.asp
585 'How To Terminate an Application "Cleanly" in Win32'
586 http://support.microsoft.com/default.aspx?scid=kb;en-us;178893
590 static void error_handler(int err_sig)
592 // Throw away any signals other than the first one received.
593 static sig_atomic_t handling_error = false;
596 handling_error = true;
598 // We have received a signal indicating a fatal error, so
599 // try and save the data ASAP.
602 // These lyxerr calls may or may not work:
604 // Signals are asynchronous, so the main program may be in a very
605 // fragile state when a signal is processed and thus while a signal
606 // handler function executes.
607 // In general, therefore, we should avoid performing any
608 // I/O operations or calling most library and system functions from
611 // This shouldn't matter here, however, as we've already invoked
616 lyxerr << "\nlyx: SIGHUP signal caught\nBye." << endl;
620 lyxerr << "\nlyx: SIGFPE signal caught\nBye." << endl;
623 lyxerr << "\nlyx: SIGSEGV signal caught\n"
624 "Sorry, you have found a bug in LyX. "
625 "Please read the bug-reporting instructions "
626 "in Help->Introduction and send us a bug report, "
627 "if necessary. Thanks !\nBye." << endl;
635 // Deinstall the signal handlers
637 signal(SIGHUP, SIG_DFL);
639 signal(SIGINT, SIG_DFL);
640 signal(SIGFPE, SIG_DFL);
641 signal(SIGSEGV, SIG_DFL);
642 signal(SIGTERM, SIG_DFL);
645 if (err_sig == SIGSEGV ||
646 (err_sig != SIGHUP && !getEnv("LYXDEBUG").empty()))
648 if (err_sig == SIGSEGV || !getEnv("LYXDEBUG").empty())
657 void LyX::printError(ErrorItem const & ei)
659 docstring tmp = _("LyX: ") + ei.error + char_type(':')
661 cerr << to_utf8(tmp) << endl;
668 signal(SIGHUP, error_handler);
670 signal(SIGFPE, error_handler);
671 signal(SIGSEGV, error_handler);
672 signal(SIGINT, error_handler);
673 signal(SIGTERM, error_handler);
674 // SIGPIPE can be safely ignored.
676 lyxrc.tempdir_path = package().temp_dir().absFilename();
677 lyxrc.document_path = package().document_dir().absFilename();
679 if (lyxrc.example_path.empty()) {
680 lyxrc.example_path = addPath(package().system_support().absFilename(),
683 if (lyxrc.template_path.empty()) {
684 lyxrc.template_path = addPath(package().system_support().absFilename(),
689 // Read configuration files
692 // This one may have been distributed along with LyX.
693 if (!readRcFile("lyxrc.dist"))
696 // Set the language defined by the distributor.
699 // Set the PATH correctly.
700 #if !defined (USE_POSIX_PACKAGING)
701 // Add the directory containing the LyX executable to the path
702 // so that LyX can find things like tex2lyx.
703 if (package().build_support().empty())
704 prependEnvPath("PATH", package().binary_dir().absFilename());
706 if (!lyxrc.path_prefix.empty())
707 prependEnvPath("PATH", lyxrc.path_prefix);
709 // Check that user LyX directory is ok.
710 if (queryUserLyXDir(package().explicit_user_support()))
711 reconfigureUserLyXDir();
713 // no need for a splash when there is no GUI
718 // This one is generated in user_support directory by lib/configure.py.
719 if (!readRcFile("lyxrc.defaults"))
722 // Query the OS to know what formats are viewed natively
723 formats.setAutoOpen();
725 // Read lyxrc.dist again to be able to override viewer auto-detection.
726 readRcFile("lyxrc.dist");
728 // Set again the language defined by the distributor.
731 system_lyxrc = lyxrc;
732 system_formats = formats;
733 pimpl_->system_converters_ = pimpl_->converters_;
734 pimpl_->system_movers_ = pimpl_->movers_;
735 system_lcolor = lcolor;
737 // This one is edited through the preferences dialog.
738 if (!readRcFile("preferences"))
741 if (!readEncodingsFile("encodings", "unicodesymbols"))
743 if (!readLanguagesFile("languages"))
746 // Set the language defined by the user.
750 LYXERR(Debug::INIT, "Reading layouts...");
756 // read keymap and ui files in batch mode as well
757 // because InsetInfo needs to know these to produce
758 // the correct output
760 // Set up command definitions
761 pimpl_->toplevel_cmddef_.read(lyxrc.def_file);
764 pimpl_->toplevel_keymap_.read("site");
765 pimpl_->toplevel_keymap_.read(lyxrc.bind_file);
766 // load user bind file user.bind
767 pimpl_->toplevel_keymap_.read("user", 0, KeyMap::MissingOK);
769 pimpl_->lyxfunc_.initKeySequences(&pimpl_->toplevel_keymap_);
771 if (lyxerr.debugging(Debug::LYXRC))
774 os::windows_style_tex_paths(lyxrc.windows_style_tex_paths);
775 if (!lyxrc.path_prefix.empty())
776 prependEnvPath("PATH", lyxrc.path_prefix);
778 FileName const document_path(lyxrc.document_path);
779 if (document_path.exists() && document_path.isDirectory())
780 package().document_dir() = document_path;
782 package().set_temp_dir(createLyXTmpDir(FileName(lyxrc.tempdir_path)));
783 if (package().temp_dir().empty()) {
784 Alert::error(_("Could not create temporary directory"),
785 bformat(_("Could not create a temporary directory in\n"
787 "Make sure that this path exists and is writable and try again."),
788 from_utf8(lyxrc.tempdir_path)));
789 // createLyXTmpDir() tries sufficiently hard to create a
790 // usable temp dir, so the probability to come here is
791 // close to zero. We therefore don't try to overcome this
792 // problem with e.g. asking the user for a new path and
793 // trying again but simply exit.
797 LYXERR(Debug::INIT, "LyX tmp dir: `"
798 << package().temp_dir().absFilename() << '\'');
800 LYXERR(Debug::INIT, "Reading session information '.lyx/session'...");
801 pimpl_->session_.reset(new Session(lyxrc.num_lastfiles));
803 // This must happen after package initialization and after lyxrc is
804 // read, therefore it can't be done by a static object.
805 ConverterCache::init();
811 void emergencyCleanup()
813 // what to do about tmpfiles is non-obvious. we would
814 // like to delete any we find, but our lyxdir might
815 // contain documents etc. which might be helpful on
818 singleton_->pimpl_->buffer_list_.emergencyWriteAll();
820 if (singleton_->pimpl_->lyx_server_)
821 singleton_->pimpl_->lyx_server_->emergencyCleanup();
822 singleton_->pimpl_->lyx_server_.reset();
823 singleton_->pimpl_->lyx_socket_.reset();
828 // return true if file does not exist or is older than configure.py.
829 static bool needsUpdate(string const & file)
831 // We cannot initialize configure_script directly because the package
832 // is not initialized yet when static objects are constructed.
833 static FileName configure_script;
834 static bool firstrun = true;
837 FileName(addName(package().system_support().absFilename(),
843 FileName(addName(package().user_support().absFilename(), file));
844 return !absfile.exists()
845 || configure_script.lastModified() > absfile.lastModified();
849 bool LyX::queryUserLyXDir(bool explicit_userdir)
851 // Does user directory exist?
852 FileName const sup = package().user_support();
853 if (sup.exists() && sup.isDirectory()) {
856 return needsUpdate("lyxrc.defaults")
857 || needsUpdate("lyxmodules.lst")
858 || needsUpdate("textclass.lst")
859 || needsUpdate("packages.lst");
862 first_start = !explicit_userdir;
864 // If the user specified explicitly a directory, ask whether
865 // to create it. If the user says "no", then exit.
866 if (explicit_userdir &&
868 _("Missing user LyX directory"),
869 bformat(_("You have specified a non-existent user "
870 "LyX directory, %1$s.\n"
871 "It is needed to keep your own configuration."),
872 from_utf8(package().user_support().absFilename())),
874 _("&Create directory"),
876 lyxerr << to_utf8(_("No user LyX directory. Exiting.")) << endl;
877 earlyExit(EXIT_FAILURE);
880 lyxerr << to_utf8(bformat(_("LyX: Creating directory %1$s"),
881 from_utf8(sup.absFilename()))) << endl;
883 if (!sup.createDirectory(0755)) {
884 // Failed, so let's exit.
885 lyxerr << to_utf8(_("Failed to create directory. Exiting."))
887 earlyExit(EXIT_FAILURE);
894 bool LyX::readRcFile(string const & name)
896 LYXERR(Debug::INIT, "About to read " << name << "... ");
898 FileName const lyxrc_path = libFileSearch(string(), name);
899 if (!lyxrc_path.empty()) {
900 LYXERR(Debug::INIT, "Found in " << lyxrc_path);
901 if (lyxrc.read(lyxrc_path) < 0) {
906 LYXERR(Debug::INIT, "Not found." << lyxrc_path);
911 // Read the languages file `name'
912 bool LyX::readLanguagesFile(string const & name)
914 LYXERR(Debug::INIT, "About to read " << name << "...");
916 FileName const lang_path = libFileSearch(string(), name);
917 if (lang_path.empty()) {
921 languages.read(lang_path);
926 // Read the encodings file `name'
927 bool LyX::readEncodingsFile(string const & enc_name,
928 string const & symbols_name)
930 LYXERR(Debug::INIT, "About to read " << enc_name << " and "
931 << symbols_name << "...");
933 FileName const symbols_path = libFileSearch(string(), symbols_name);
934 if (symbols_path.empty()) {
935 showFileError(symbols_name);
939 FileName const enc_path = libFileSearch(string(), enc_name);
940 if (enc_path.empty()) {
941 showFileError(enc_name);
944 encodings.read(enc_path, symbols_path);
951 /// return the the number of arguments consumed
952 typedef boost::function<int(string const &, string const &, string &)> cmd_helper;
954 int parse_dbg(string const & arg, string const &, string &)
957 lyxerr << to_utf8(_("List of supported debug flags:")) << endl;
958 Debug::showTags(lyxerr);
961 lyxerr << to_utf8(bformat(_("Setting debug level to %1$s"), from_utf8(arg))) << endl;
963 lyxerr.level(Debug::value(arg));
964 Debug::showLevel(lyxerr, lyxerr.level());
969 int parse_help(string const &, string const &, string &)
972 to_utf8(_("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
973 "Command line switches (case sensitive):\n"
974 "\t-help summarize LyX usage\n"
975 "\t-userdir dir set user directory to dir\n"
976 "\t-sysdir dir set system directory to dir\n"
977 "\t-geometry WxH+X+Y set geometry of the main window\n"
978 "\t-dbg feature[,feature]...\n"
979 " select the features to debug.\n"
980 " Type `lyx -dbg' to see the list of features\n"
981 "\t-x [--execute] command\n"
982 " where command is a lyx command.\n"
983 "\t-e [--export] fmt\n"
984 " where fmt is the export format of choice.\n"
985 " Look on Tools->Preferences->File formats->Format\n"
986 " to get an idea which parameters should be passed.\n"
987 " Note that the order of -e and -x switches matters.\n"
988 "\t-i [--import] fmt file.xxx\n"
989 " where fmt is the import format of choice\n"
990 " and file.xxx is the file to be imported.\n"
991 "\t--batch execute commands and exit\n"
992 "\t-version summarize version and build info\n"
993 "Check the LyX man page for more details.")) << endl;
999 int parse_version(string const &, string const &, string &)
1001 lyxerr << "LyX " << lyx_version
1002 << " (" << lyx_release_date << ")" << endl;
1003 lyxerr << "Built on " << __DATE__ << ", " << __TIME__ << endl;
1005 lyxerr << lyx_version_info << endl;
1011 int parse_sysdir(string const & arg, string const &, string &)
1014 Alert::error(_("No system directory"),
1015 _("Missing directory for -sysdir switch"));
1018 cl_system_support = arg;
1023 int parse_userdir(string const & arg, string const &, string &)
1026 Alert::error(_("No user directory"),
1027 _("Missing directory for -userdir switch"));
1030 cl_user_support = arg;
1035 int parse_execute(string const & arg, string const &, string & batch)
1038 Alert::error(_("Incomplete command"),
1039 _("Missing command string after --execute switch"));
1047 int parse_export(string const & type, string const &, string & batch)
1050 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1051 "--export switch")) << endl;
1054 batch = "buffer-export " + type;
1060 int parse_import(string const & type, string const & file, string & batch)
1063 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1064 "--import switch")) << endl;
1068 lyxerr << to_utf8(_("Missing filename for --import")) << endl;
1072 batch = "buffer-import " + type + ' ' + file;
1077 int parse_geometry(string const & arg1, string const &, string &)
1080 // don't remove "-geometry", it will be pruned out later in the
1081 // frontend if need be.
1086 int parse_batch(string const &, string const &, string &)
1096 void LyX::easyParse(int & argc, char * argv[])
1098 map<string, cmd_helper> cmdmap;
1100 cmdmap["-dbg"] = parse_dbg;
1101 cmdmap["-help"] = parse_help;
1102 cmdmap["--help"] = parse_help;
1103 cmdmap["-version"] = parse_version;
1104 cmdmap["--version"] = parse_version;
1105 cmdmap["-sysdir"] = parse_sysdir;
1106 cmdmap["-userdir"] = parse_userdir;
1107 cmdmap["-x"] = parse_execute;
1108 cmdmap["--execute"] = parse_execute;
1109 cmdmap["-e"] = parse_export;
1110 cmdmap["--export"] = parse_export;
1111 cmdmap["-i"] = parse_import;
1112 cmdmap["--import"] = parse_import;
1113 cmdmap["-geometry"] = parse_geometry;
1114 cmdmap["--batch"] = parse_batch;
1116 for (int i = 1; i < argc; ++i) {
1117 map<string, cmd_helper>::const_iterator it
1118 = cmdmap.find(argv[i]);
1120 // don't complain if not found - may be parsed later
1121 if (it == cmdmap.end())
1125 (i + 1 < argc) ? to_utf8(from_local8bit(argv[i + 1])) : string();
1127 (i + 2 < argc) ? to_utf8(from_local8bit(argv[i + 2])) : string();
1130 int const remove = 1 + it->second(arg, arg2, batch);
1132 pimpl_->batch_commands.push_back(batch);
1134 // Now, remove used arguments by shifting
1135 // the following ones remove places down.
1138 for (int j = i; j < argc; ++j)
1139 argv[j] = argv[j + remove];
1146 FuncStatus getStatus(FuncRequest const & action)
1148 LASSERT(singleton_, /**/);
1149 return singleton_->pimpl_->lyxfunc_.getStatus(action);
1153 void dispatch(FuncRequest const & action)
1155 LASSERT(singleton_, /**/);
1156 singleton_->pimpl_->lyxfunc_.dispatch(action);
1160 BufferList & theBufferList()
1162 LASSERT(singleton_, /**/);
1163 return singleton_->pimpl_->buffer_list_;
1167 LyXFunc & theLyXFunc()
1169 LASSERT(singleton_, /**/);
1170 return singleton_->pimpl_->lyxfunc_;
1174 Server & theServer()
1176 // FIXME: this should not be use_gui dependent
1177 LASSERT(use_gui, /**/);
1178 LASSERT(singleton_, /**/);
1179 return *singleton_->pimpl_->lyx_server_.get();
1183 ServerSocket & theServerSocket()
1185 // FIXME: this should not be use_gui dependent
1186 LASSERT(use_gui, /**/);
1187 LASSERT(singleton_, /**/);
1188 return *singleton_->pimpl_->lyx_socket_.get();
1192 KeyMap & theTopLevelKeymap()
1194 LASSERT(singleton_, /**/);
1195 return singleton_->pimpl_->toplevel_keymap_;
1199 Converters & theConverters()
1201 LASSERT(singleton_, /**/);
1202 return singleton_->pimpl_->converters_;
1206 Converters & theSystemConverters()
1208 LASSERT(singleton_, /**/);
1209 return singleton_->pimpl_->system_converters_;
1213 Movers & theMovers()
1215 LASSERT(singleton_, /**/);
1216 return singleton_->pimpl_->movers_;
1220 Mover const & getMover(string const & fmt)
1222 LASSERT(singleton_, /**/);
1223 return singleton_->pimpl_->movers_(fmt);
1227 void setMover(string const & fmt, string const & command)
1229 LASSERT(singleton_, /**/);
1230 singleton_->pimpl_->movers_.set(fmt, command);
1234 Movers & theSystemMovers()
1236 LASSERT(singleton_, /**/);
1237 return singleton_->pimpl_->system_movers_;
1241 Messages & getMessages(string const & language)
1243 LASSERT(singleton_, /**/);
1244 return singleton_->messages(language);
1248 Messages & getGuiMessages()
1250 LASSERT(singleton_, /**/);
1251 return singleton_->pimpl_->messages_["GUI"];
1255 graphics::Previews & thePreviews()
1257 LASSERT(singleton_, /**/);
1258 return singleton_->pimpl_->preview_;
1262 Session & theSession()
1264 LASSERT(singleton_, /**/);
1265 return *singleton_->pimpl_->session_.get();
1269 CmdDef & theTopLevelCmdDef()
1271 LASSERT(singleton_, /**/);
1272 return singleton_->pimpl_->toplevel_cmddef_;
1276 SpellChecker * theSpellChecker()
1278 return singleton_->pimpl_->spell_checker_;