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 "AppleSpellChecker.h"
21 #include "AspellChecker.h"
23 #include "BufferList.h"
25 #include "CiteEnginesList.h"
27 #include "ConverterCache.h"
28 #include "Converter.h"
29 #include "CutAndPaste.h"
30 #include "EnchantChecker.h"
32 #include "ErrorList.h"
34 #include "FuncStatus.h"
35 #include "HunspellChecker.h"
38 #include "LaTeXFonts.h"
39 #include "LayoutFile.h"
42 #include "LyXAction.h"
44 #include "ModuleList.h"
47 #include "ServerSocket.h"
51 #include "frontends/alert.h"
52 #include "frontends/Application.h"
54 #include "support/ConsoleApplication.h"
55 #include "support/convert.h"
56 #include "support/lassert.h"
57 #include "support/debug.h"
58 #include "support/environment.h"
59 #include "support/ExceptionMessage.h"
60 #include "support/filetools.h"
61 #include "support/gettext.h"
62 #include "support/lstrings.h"
63 #include "support/Messages.h"
64 #include "support/os.h"
65 #include "support/Package.h"
66 #include "support/unique_ptr.h"
77 #include <qglobal.h> // For QT_VERSION
80 using namespace lyx::support;
82 #if defined (USE_MACOSX_PACKAGING)
83 #include <crt_externs.h>
88 namespace Alert = frontend::Alert;
89 namespace os = support::os;
93 // Are we using the GUI at all? We default to true and this is changed
94 // to false when the export feature is used.
99 // Report on the terminal about spawned commands. The default is false
100 // and can be changed with the option -v (--verbose).
102 bool verbose = false;
105 // Do not treat the "missing glyphs" warning of fontspec as an error message.
106 // The default is false and can be changed with the option
107 // --ignore-error-message missing_glyphs
108 // This is used in automated testing.
109 bool ignore_missing_glyphs = false;
112 // We default to open documents in an already running instance, provided that
113 // the lyxpipe has been setup. This can be overridden either on the command
114 // line or through preference settings.
116 RunMode run_mode = PREFERRED;
119 // Tell what files can be silently overwritten during batch export.
120 // Possible values are: NO_FILES, MAIN_FILE, ALL_FILES, UNSPECIFIED.
121 // Unless specified on command line (through the -f switch) or through the
122 // environment variable LYX_FORCE_OVERWRITE, the default will be MAIN_FILE.
124 OverwriteFiles force_overwrite = UNSPECIFIED;
127 // Scale the GUI by this factor. This works whether we have a HiDpi screen
128 // or not and scales everything, also fonts. Can only be changed by setting
129 // the QT_SCALE_FACTOR environment variable before launching LyX and only
130 // works properly with Qt 5.6 or higher.
132 double qt_scale_factor = 1.0;
137 // Filled with the command line arguments "foo" of "-sysdir foo" or
139 string cl_system_support;
140 string cl_user_support;
144 LyX * singleton_ = 0;
146 void showFileError(string const & error)
148 Alert::warning(_("Could not read configuration file"),
149 bformat(_("Error while reading the configuration file\n%1$s.\n"
150 "Please check your installation."), from_utf8(error)));
155 /// The main application class private implementation.
158 : latexfonts_(0), spell_checker_(0), apple_spell_checker_(0), aspell_checker_(0), enchant_checker_(0), hunspell_checker_(0)
164 delete apple_spell_checker_;
165 delete aspell_checker_;
166 delete enchant_checker_;
167 delete hunspell_checker_;
171 BufferList buffer_list_;
173 KeyMap toplevel_keymap_;
175 CmdDef toplevel_cmddef_;
177 unique_ptr<Server> lyx_server_;
179 unique_ptr<ServerSocket> lyx_socket_;
181 unique_ptr<frontend::Application> application_;
182 /// lyx session, containing lastfiles, lastfilepos, and lastopened
183 unique_ptr<Session> session_;
185 /// Files to load at start.
186 vector<string> files_to_load_;
188 /// The messages translators.
189 map<string, Messages> messages_;
191 /// The file converters.
192 Converters converters_;
193 /// The system converters after reading lyxrc.defaults.
194 Converters system_converters_;
196 /// Global format information
198 /// The system formats after reading lyxrc.defaults.
199 Formats system_formats_;
205 Movers system_movers_;
207 /// the parsed command line batch command if any
208 vector<string> batch_commands;
211 LaTeXFonts * latexfonts_;
214 SpellChecker * spell_checker_;
216 SpellChecker * apple_spell_checker_;
218 SpellChecker * aspell_checker_;
220 SpellChecker * enchant_checker_;
222 SpellChecker * hunspell_checker_;
226 /// The main application class for console mode
227 class LyXConsoleApp : public ConsoleApplication
230 LyXConsoleApp(LyX * lyx, int & argc, char * argv[])
231 : ConsoleApplication(lyx_package, argc, argv), lyx_(lyx),
232 argc_(argc), argv_(argv)
237 int const exit_status = lyx_->execWithoutGui(argc_, argv_);
248 frontend::Application * theApp()
251 return singleton_->pimpl_->application_.get();
264 void lyx_exit(int exit_code)
267 // Something wrong happened so better save everything, just in
272 // Properly crash in debug mode in order to get a useful backtrace.
276 // In release mode, try to exit gracefully.
278 theApp()->exit(exit_code);
292 Messages & LyX::messages(string const & language)
294 map<string, Messages>::iterator it = pimpl_->messages_.find(language);
296 if (it != pimpl_->messages_.end())
299 pair<map<string, Messages>::iterator, bool> result =
300 pimpl_->messages_.insert(make_pair(language, Messages(language)));
302 LATTEST(result.second);
303 return result.first->second;
307 int LyX::exec(int & argc, char * argv[])
309 // Minimal setting of locale before parsing command line
311 init_package(os::utf8_argv(0), string(), string());
312 // we do not get to this point when init_package throws an exception
314 } catch (ExceptionMessage const & message) {
315 LYXERR(Debug::LOCALE, message.title_ + ", " + message.details_);
318 // Here we need to parse the command line. At least
319 // we need to parse for "-dbg" and "-help"
320 easyParse(argc, argv);
322 #if QT_VERSION >= 0x050600
323 // Check whether Qt will scale all GUI elements and accordingly
324 // set the scale factor so that to avoid blurred images and text
325 char const * const scale_factor = getenv("QT_SCALE_FACTOR");
327 qt_scale_factor = convert<double>(scale_factor);
328 if (qt_scale_factor < 1.0)
329 qt_scale_factor = 1.0;
334 init_package(os::utf8_argv(0), cl_system_support, cl_user_support);
335 } catch (ExceptionMessage const & message) {
336 if (message.type_ == ErrorException) {
337 Alert::error(message.title_, message.details_);
339 } else if (message.type_ == WarningException) {
340 Alert::warning(message.title_, message.details_);
344 // Reinit the messages machinery in case package() knows
345 // something interesting about the locale directory.
349 LyXConsoleApp app(this, argc, argv);
351 // Reestablish our defaults, as Qt overwrites them
352 // after creating app
358 // Let the frontend parse and remove all arguments that it knows
359 pimpl_->application_.reset(createApplication(argc, argv));
361 // Reestablish our defaults, as Qt overwrites them
362 // after createApplication()
365 // Parse and remove all known arguments in the LyX singleton
366 // Give an error for all remaining ones.
367 int exit_status = init(argc, argv);
369 // Kill the application object before exiting.
370 pimpl_->application_.reset();
376 // If not otherwise specified by a command line option or
377 // by preferences, we default to reuse a running instance.
378 if (run_mode == PREFERRED)
379 run_mode = USE_REMOTE;
382 /* Create a CoreApplication class that will provide the main event loop
383 * and the socket callback registering. With Qt, only QtCore
384 * library would be needed.
385 * When this is done, a server_mode could be created and the following two
386 * line would be moved out from here.
387 * However, note that the first of the two lines below triggers the
388 * "single instance" behavior, which should occur right at this point.
390 // Note: socket callback must be registered after init(argc, argv)
391 // such that package().temp_dir() is properly initialized.
392 pimpl_->lyx_server_.reset(new Server(lyxrc.lyxpipes));
393 pimpl_->lyx_socket_.reset(new ServerSocket(
394 FileName(package().temp_dir().absFileName() + "/lyxsocket")));
396 // Start the real execution loop.
397 if (!pimpl_->lyx_server_->deferredLoadingToOtherInstance())
398 exit_status = pimpl_->application_->exec();
399 else if (!pimpl_->files_to_load_.empty()) {
400 vector<string>::const_iterator it = pimpl_->files_to_load_.begin();
401 vector<string>::const_iterator end = pimpl_->files_to_load_.end();
402 lyxerr << _("The following files could not be loaded:") << endl;
403 for (; it != end; ++it)
404 lyxerr << *it << endl;
413 void LyX::prepareExit()
415 // Clear the clipboard and selection stack:
416 cap::clearCutStack();
417 cap::clearSelection();
419 // Write the index file of the converter cache
420 ConverterCache::get().writeIndex();
422 // closing buffer may throw exceptions, but we ignore them since we
425 // close buffers first
426 pimpl_->buffer_list_.closeAll();
427 } catch (ExceptionMessage const &) {}
429 // register session changes and shutdown server and socket
431 if (pimpl_->session_)
432 pimpl_->session_->writeFile();
433 pimpl_->session_.reset();
434 pimpl_->lyx_server_.reset();
435 pimpl_->lyx_socket_.reset();
438 // do any other cleanup procedures now
439 if (package().temp_dir() != package().system_temp_dir()) {
440 string const abs_tmpdir = package().temp_dir().absFileName();
441 if (!contains(abs_tmpdir, "lyx_tmpdir")) {
442 docstring const msg =
443 bformat(_("%1$s does not appear like a LyX created temporary directory."),
444 from_utf8(abs_tmpdir));
445 Alert::warning(_("Cannot remove temporary directory"), msg);
447 LYXERR(Debug::INFO, "Deleting tmp dir " << abs_tmpdir);
448 if (!package().temp_dir().destroyDirectory()) {
449 LYXERR0(bformat(_("Unable to remove the temporary directory %1$s"),
450 from_utf8(abs_tmpdir)));
455 // Kill the application object before exiting. This avoids crashes
456 // when exiting on Linux.
457 pimpl_->application_.reset();
461 void LyX::earlyExit(int status)
463 LATTEST(pimpl_->application_.get());
464 // LyX::pimpl_::application_ is not initialised at this
465 // point so it's safe to just exit after some cleanup.
471 int LyX::init(int & argc, char * argv[])
473 // check for any spurious extra arguments
474 // other than documents
475 for (int argi = 1; argi < argc ; ++argi) {
476 if (argv[argi][0] == '-') {
478 bformat(_("Wrong command line option `%1$s'. Exiting."),
479 from_utf8(os::utf8_argv(argi)))) << endl;
484 // Initialization of LyX (reads lyxrc and more)
485 LYXERR(Debug::INIT, "Initializing LyX::init...");
486 bool success = init();
487 LYXERR(Debug::INIT, "Initializing LyX::init...done");
491 // Remaining arguments are assumed to be files to load.
492 for (int argi = 1; argi < argc; ++argi)
493 pimpl_->files_to_load_.push_back(os::utf8_argv(argi));
495 if (!use_gui && pimpl_->files_to_load_.empty()) {
496 lyxerr << to_utf8(_("Missing filename for this operation.")) << endl;
501 pimpl_->files_to_load_.push_back(
502 i18nLibFileSearch("examples", "Welcome.lyx").absFileName());
509 int LyX::execWithoutGui(int & argc, char * argv[])
511 int exit_status = init(argc, argv);
517 // Used to keep track of which buffers were explicitly loaded by user request.
518 // This is necessary because master and child document buffers are loaded, even
519 // if they were not named on the command line. We do not want to dispatch to
521 vector<Buffer *> command_line_buffers;
523 // Load the files specified on the command line
524 vector<string>::const_iterator it = pimpl_->files_to_load_.begin();
525 vector<string>::const_iterator end = pimpl_->files_to_load_.end();
526 for (; it != end; ++it) {
527 // get absolute path of file and add ".lyx" to the filename if necessary
528 FileName fname = fileSearch(string(), os::internal_path(*it), "lyx",
534 Buffer * buf = pimpl_->buffer_list_.newBuffer(fname.absFileName());
535 LYXERR(Debug::FILES, "Loading " << fname);
536 if (buf && buf->loadLyXFile() == Buffer::ReadSuccess) {
537 ErrorList const & el = buf->errorList("Parse");
538 for(ErrorItem const & e : el)
540 command_line_buffers.push_back(buf);
543 pimpl_->buffer_list_.release(buf);
544 docstring const error_message =
545 bformat(_("LyX failed to load the following file: %1$s"),
546 from_utf8(fname.absFileName()));
547 lyxerr << to_utf8(error_message) << endl;
548 exit_status = 1; // failed
552 if (exit_status || pimpl_->batch_commands.empty() || pimpl_->buffer_list_.empty()) {
557 // Iterate through the buffers that were specified on the command line
558 bool final_success = false;
559 vector<Buffer *>::iterator buf_it = command_line_buffers.begin();
560 for (; buf_it != command_line_buffers.end(); ++buf_it) {
561 Buffer * buf = *buf_it;
562 vector<string>::const_iterator bcit = pimpl_->batch_commands.begin();
563 vector<string>::const_iterator bcend = pimpl_->batch_commands.end();
565 for (; bcit != bcend; ++bcit) {
566 LYXERR(Debug::ACTION, "Buffer::dispatch: cmd: " << *bcit);
567 buf->dispatch(*bcit, dr);
568 final_success |= !dr.error();
572 return !final_success;
576 void execBatchCommands()
579 singleton_->execCommands();
583 void LyX::execCommands()
585 // The advantage of doing this here is that the event loop
586 // is already started. So any need for interaction will be
589 // if reconfiguration is needed.
590 if (LayoutFileList::get().empty()) {
591 switch (Alert::prompt(
592 _("No textclass is found"),
593 _("LyX will only have minimal functionality because no textclasses "
594 "have been found. You can either try to reconfigure LyX normally, "
595 "try to reconfigure without checking your LaTeX installation, or continue."),
602 // regular reconfigure
603 lyx::dispatch(FuncRequest(LFUN_RECONFIGURE, ""));
606 // reconfigure --without-latex-config
607 lyx::dispatch(FuncRequest(LFUN_RECONFIGURE,
608 " --without-latex-config"));
615 // create the first main window
616 lyx::dispatch(FuncRequest(LFUN_WINDOW_NEW, geometryArg));
618 if (!pimpl_->files_to_load_.empty()) {
619 // if some files were specified at command-line we assume that the
620 // user wants to edit *these* files and not to restore the session.
621 for (size_t i = 0; i != pimpl_->files_to_load_.size(); ++i) {
623 FuncRequest(LFUN_FILE_OPEN, pimpl_->files_to_load_[i]));
625 // clear this list to save a few bytes of RAM
626 pimpl_->files_to_load_.clear();
628 pimpl_->application_->restoreGuiSession();
630 // Execute batch commands if available
631 if (pimpl_->batch_commands.empty())
634 vector<string>::const_iterator bcit = pimpl_->batch_commands.begin();
635 vector<string>::const_iterator bcend = pimpl_->batch_commands.end();
636 for (; bcit != bcend; ++bcit) {
637 LYXERR(Debug::INIT, "About to handle -x '" << *bcit << '\'');
638 lyx::dispatch(lyxaction.lookupFunc(*bcit));
646 The SIGHUP signal does not exist on Windows and does not need to be handled.
648 Windows handles SIGFPE and SIGSEGV signals as expected.
650 Ctrl+C interrupts (mapped to SIGINT by Windows' POSIX compatability layer)
651 cause a new thread to be spawned. This may well result in unexpected
652 behaviour by the single-threaded LyX.
654 SIGTERM signals will come only from another process actually sending
655 that signal using 'raise' in Windows' POSIX compatability layer. It will
656 not come from the general "terminate process" methods that everyone
657 actually uses (and which can't be trapped). Killing an app 'politely' on
658 Windows involves first sending a WM_CLOSE message, something that is
659 caught already by the Qt frontend.
661 For more information see:
663 http://aspn.activestate.com/ASPN/Mail/Message/ActiveTcl/2034055
664 ...signals are mostly useless on Windows for a variety of reasons that are
667 'UNIX Application Migration Guide, Chapter 9'
668 http://msdn.microsoft.com/library/en-us/dnucmg/html/UCMGch09.asp
670 'How To Terminate an Application "Cleanly" in Win32'
671 http://support.microsoft.com/default.aspx?scid=kb;en-us;178893
675 static void error_handler(int err_sig)
677 // Throw away any signals other than the first one received.
678 static sig_atomic_t handling_error = false;
681 handling_error = true;
683 // We have received a signal indicating a fatal error, so
684 // try and save the data ASAP.
687 // These lyxerr calls may or may not work:
689 // Signals are asynchronous, so the main program may be in a very
690 // fragile state when a signal is processed and thus while a signal
691 // handler function executes.
692 // In general, therefore, we should avoid performing any
693 // I/O operations or calling most library and system functions from
696 // This shouldn't matter here, however, as we've already invoked
702 msg = _("SIGHUP signal caught!\nBye.");
706 msg = _("SIGFPE signal caught!\nBye.");
709 msg = _("SIGSEGV signal caught!\n"
710 "Sorry, you have found a bug in LyX, "
711 "hope you have not lost any data.\n"
712 "Please read the bug-reporting instructions "
713 "in 'Help->Introduction' and send us a bug report, "
714 "if necessary. Thanks!\nBye.");
723 lyxerr << "\nlyx: " << msg << endl;
724 // try to make a GUI message
725 Alert::error(_("LyX crashed!"), msg, true);
728 // Deinstall the signal handlers
730 signal(SIGHUP, SIG_DFL);
732 signal(SIGINT, SIG_DFL);
733 signal(SIGFPE, SIG_DFL);
734 signal(SIGSEGV, SIG_DFL);
735 signal(SIGTERM, SIG_DFL);
738 if (err_sig == SIGSEGV ||
739 (err_sig != SIGHUP && !getEnv("LYXDEBUG").empty())) {
741 if (err_sig == SIGSEGV || !getEnv("LYXDEBUG").empty()) {
744 // with abort() it crashes again.
757 void LyX::printError(ErrorItem const & ei)
759 docstring tmp = _("LyX: ") + ei.error + char_type(':')
761 cerr << to_utf8(tmp) << endl;
764 #if defined (USE_MACOSX_PACKAGING)
766 // Unexposed--extract an environment variable name from its NAME=VALUE
768 std::string varname(const char* line)
770 size_t nameLen = strcspn(line, "=");
771 if (nameLen == strlen(line)) {
772 return std::string();
774 return std::string(line, nameLen);
779 void cleanDuplicateEnvVars()
781 std::set<std::string> seen;
782 std::set<std::string> dupes;
784 // Create a list of the environment variables that appear more than once
785 for (char **read = *_NSGetEnviron(); *read; read++) {
786 std::string name = varname(*read);
787 if (name.size() == 0) {
790 if (seen.find(name) != seen.end()) {
797 // Loop over the list of duplicated variables
798 std::set<std::string>::iterator dupe = dupes.begin();
799 std::set<std::string>::iterator const dend = dupes.end();
800 for (; dupe != dend; ++dupe) {
801 const char *name = (*dupe).c_str();
802 char *val = getenv(name);
804 LYXERR(Debug::INIT, "Duplicate environment variable: " << name);
805 // unsetenv removes *all* instances of the variable from the environment
808 // replace with the value from getenv (in practice appears to be the
809 // first value in the list)
810 setenv(name, val, 0);
817 static void initTemplatePath()
819 FileName const package_template_path =
820 FileName(addName(package().system_support().absFileName(), "templates"));
822 if (lyxrc.template_path.empty()) {
823 lyxrc.template_path = package_template_path.absFileName();
825 #if defined (USE_MACOSX_PACKAGING)
826 FileName const user_template_path =
827 FileName(addName(package().user_support().absFileName(), "templates"));
829 if (package_template_path != FileName(lyxrc.template_path) &&
830 user_template_path != FileName(lyxrc.template_path))
834 FileName const user_template_link =
835 FileName(addName(user_template_path.absFileName(),"SystemTemplates"));
836 if (user_template_link.isSymLink() && !equivalent(user_template_link, package_template_path)) {
837 user_template_link.removeFile();
839 if (!user_template_link.exists()) {
840 if (!package_template_path.link(user_template_link)) {
841 FileName const user_support = package().user_support();
842 if (user_support.exists() && user_support.isDirectory()) {
843 LYXERR(Debug::INIT, "Cannot create symlink " + user_template_link.absFileName());
844 lyxrc.template_path = package_template_path.absFileName();
848 LYXERR(Debug::INIT, "Symlink \"" << user_template_link.absFileName() << "\" created.");
850 lyxrc.template_path = user_template_path.absFileName();
858 signal(SIGHUP, error_handler);
860 signal(SIGFPE, error_handler);
861 signal(SIGSEGV, error_handler);
862 signal(SIGINT, error_handler);
863 signal(SIGTERM, error_handler);
864 // SIGPIPE can be safely ignored.
866 #if defined (USE_MACOSX_PACKAGING)
867 cleanDuplicateEnvVars();
870 lyxrc.tempdir_path = package().temp_dir().absFileName();
871 lyxrc.document_path = package().document_dir().absFileName();
873 if (lyxrc.example_path.empty()) {
874 lyxrc.example_path = addPath(package().system_support().absFileName(),
879 // init LyXDir environment variable
880 string const lyx_dir = package().lyx_dir().absFileName();
881 LYXERR(Debug::INIT, "Setting LyXDir... to \"" << lyx_dir << "\"");
882 if (!setEnv("LyXDir", lyx_dir))
883 LYXERR(Debug::INIT, "\t... failed!");
885 if (package().explicit_user_support() && getEnv(LYX_USERDIR_VER).empty()) {
886 // -userdir was given on the command line.
887 // Make it available to child processes, otherwise tex2lyx
888 // would not find all layout files, and other converters might
890 string const user_dir = package().user_support().absFileName();
891 LYXERR(Debug::INIT, "Setting " LYX_USERDIR_VER "... to \""
893 if (!setEnv(LYX_USERDIR_VER, user_dir))
894 LYXERR(Debug::INIT, "\t... failed!");
898 // Read configuration files
901 // This one may have been distributed along with LyX.
902 if (!readRcFile("lyxrc.dist"))
905 // Set the PATH correctly.
906 #if !defined (USE_POSIX_PACKAGING) && !defined (USE_HAIKU_PACKAGING)
907 // Add the directory containing the LyX executable to the path
908 // so that LyX can find things like tex2lyx.
909 if (package().build_support().empty())
910 prependEnvPath("PATH", package().binary_dir().absFileName());
912 if (!lyxrc.path_prefix.empty())
913 prependEnvPath("PATH", replaceEnvironmentPath(lyxrc.path_prefix));
915 // Check that user LyX directory is ok.
917 string const lock_file = package().getConfigureLockName();
918 int fd = fileLock(lock_file.c_str());
920 if (queryUserLyXDir(package().explicit_user_support())) {
921 package().reconfigureUserLyXDir("");
922 // Now the user directory is present on first start.
925 fileUnlock(fd, lock_file.c_str());
929 // No need for a splash when there is no GUI
931 // Default is to overwrite the main file during export, unless
932 // the -f switch was specified or LYX_FORCE_OVERWRITE was set
933 if (force_overwrite == UNSPECIFIED) {
934 string const what = getEnv("LYX_FORCE_OVERWRITE");
936 force_overwrite = ALL_FILES;
937 else if (what == "none")
938 force_overwrite = NO_FILES;
940 force_overwrite = MAIN_FILE;
944 // This one is generated in user_support directory by lib/configure.py.
945 if (!readRcFile("lyxrc.defaults"))
948 // Query the OS to know what formats are viewed natively
949 theFormats().setAutoOpen();
951 // Read lyxrc.dist again to be able to override viewer auto-detection.
952 readRcFile("lyxrc.dist");
954 system_lyxrc = lyxrc;
955 theSystemFormats() = theFormats();
956 pimpl_->system_converters_ = pimpl_->converters_;
957 pimpl_->system_movers_ = pimpl_->movers_;
958 system_lcolor = lcolor;
960 // This one is edited through the preferences dialog.
961 if (!readRcFile("preferences", true))
964 // The language may have been set to someting useful through prefs
967 if (!readEncodingsFile("encodings", "unicodesymbols"))
969 if (!readLanguagesFile("languages"))
972 LYXERR(Debug::INIT, "Reading layouts...");
974 LayoutFileList::get().read();
976 theModuleList.read();
977 //... and the cite engines
978 theCiteEnginesList.read();
980 // read keymap and ui files in batch mode as well
981 // because InsetInfo needs to know these to produce
982 // the correct output
984 // Set up command definitions
985 pimpl_->toplevel_cmddef_.read(lyxrc.def_file);
989 pimpl_->toplevel_keymap_.read("site");
990 pimpl_->toplevel_keymap_.read(lyxrc.bind_file);
991 // load user bind file user.bind
992 pimpl_->toplevel_keymap_.read("user", 0, KeyMap::MissingOK);
994 if (lyxerr.debugging(Debug::LYXRC))
997 os::windows_style_tex_paths(lyxrc.windows_style_tex_paths);
998 // Prepend path prefix a second time to take the user preferences into a account
999 if (!lyxrc.path_prefix.empty())
1000 prependEnvPath("PATH", replaceEnvironmentPath(lyxrc.path_prefix));
1002 FileName const document_path(lyxrc.document_path);
1003 if (document_path.exists() && document_path.isDirectory())
1004 package().document_dir() = document_path;
1006 package().set_temp_dir(createLyXTmpDir(FileName(lyxrc.tempdir_path)));
1007 if (package().temp_dir().empty()) {
1008 Alert::error(_("Could not create temporary directory"),
1009 bformat(_("Could not create a temporary directory in\n"
1011 "Make sure that this path exists and is writable and try again."),
1012 from_utf8(lyxrc.tempdir_path)));
1013 // createLyXTmpDir() tries sufficiently hard to create a
1014 // usable temp dir, so the probability to come here is
1015 // close to zero. We therefore don't try to overcome this
1016 // problem with e.g. asking the user for a new path and
1017 // trying again but simply exit.
1021 LYXERR(Debug::INIT, "LyX tmp dir: `"
1022 << package().temp_dir().absFileName() << '\'');
1024 LYXERR(Debug::INIT, "Reading session information '.lyx/session'...");
1025 pimpl_->session_.reset(new Session(lyxrc.num_lastfiles));
1027 // This must happen after package initialization and after lyxrc is
1028 // read, therefore it can't be done by a static object.
1029 ConverterCache::init();
1035 void emergencyCleanup()
1037 // what to do about tmpfiles is non-obvious. we would
1038 // like to delete any we find, but our lyxdir might
1039 // contain documents etc. which might be helpful on
1042 singleton_->pimpl_->buffer_list_.emergencyWriteAll();
1044 if (singleton_->pimpl_->lyx_server_)
1045 singleton_->pimpl_->lyx_server_->emergencyCleanup();
1046 singleton_->pimpl_->lyx_server_.reset();
1047 singleton_->pimpl_->lyx_socket_.reset();
1052 bool LyX::queryUserLyXDir(bool explicit_userdir)
1054 // Does user directory exist?
1055 FileName const sup = package().user_support();
1056 if (sup.exists() && sup.isDirectory()) {
1057 first_start = false;
1059 return configFileNeedsUpdate("lyxrc.defaults")
1060 || configFileNeedsUpdate("lyxmodules.lst")
1061 || configFileNeedsUpdate("textclass.lst")
1062 || configFileNeedsUpdate("packages.lst")
1063 || configFileNeedsUpdate("lyxciteengines.lst")
1064 || configFileNeedsUpdate("xtemplates.lst");
1067 first_start = !explicit_userdir;
1069 // If the user specified explicitly a directory, ask whether
1070 // to create it. If the user says "no", then exit.
1071 if (explicit_userdir &&
1073 _("Missing user LyX directory"),
1074 bformat(_("You have specified a non-existent user "
1075 "LyX directory, %1$s.\n"
1076 "It is needed to keep your own configuration."),
1077 from_utf8(package().user_support().absFileName())),
1079 _("&Create directory"),
1081 lyxerr << to_utf8(_("No user LyX directory. Exiting.")) << endl;
1082 earlyExit(EXIT_FAILURE);
1085 lyxerr << to_utf8(bformat(_("LyX: Creating directory %1$s"),
1086 from_utf8(sup.absFileName()))) << endl;
1088 if (!sup.createDirectory(0755)) {
1089 // Failed, so let's exit.
1090 lyxerr << to_utf8(_("Failed to create directory. Exiting."))
1092 earlyExit(EXIT_FAILURE);
1099 bool LyX::readRcFile(string const & name, bool check_format)
1101 LYXERR(Debug::INIT, "About to read " << name << "... ");
1103 FileName const lyxrc_path = libFileSearch(string(), name);
1104 if (lyxrc_path.empty()) {
1105 LYXERR(Debug::INIT, "Not found." << lyxrc_path);
1107 // This was the previous logic, but can it be right??
1110 LYXERR(Debug::INIT, "Found in " << lyxrc_path);
1111 bool const success = lyxrc.read(lyxrc_path, check_format);
1113 showFileError(name);
1117 // Read the languages file `name'
1118 bool LyX::readLanguagesFile(string const & name)
1120 LYXERR(Debug::INIT, "About to read " << name << "...");
1122 FileName const lang_path = libFileSearch(string(), name);
1123 if (lang_path.empty()) {
1124 showFileError(name);
1127 languages.read(lang_path);
1132 // Read the encodings file `name'
1133 bool LyX::readEncodingsFile(string const & enc_name,
1134 string const & symbols_name)
1136 LYXERR(Debug::INIT, "About to read " << enc_name << " and "
1137 << symbols_name << "...");
1139 FileName const symbols_path = libFileSearch(string(), symbols_name);
1140 if (symbols_path.empty()) {
1141 showFileError(symbols_name);
1145 FileName const enc_path = libFileSearch(string(), enc_name);
1146 if (enc_path.empty()) {
1147 showFileError(enc_name);
1150 encodings.read(enc_path, symbols_path);
1157 /// return the the number of arguments consumed
1158 typedef function<int(string const &, string const &, string &)> cmd_helper;
1160 int parse_dbg(string const & arg, string const &, string &)
1163 cout << to_utf8(_("List of supported debug flags:")) << endl;
1164 Debug::showTags(cout);
1167 lyxerr << to_utf8(bformat(_("Setting debug level to %1$s"), from_utf8(arg))) << endl;
1169 lyxerr.setLevel(Debug::value(arg));
1170 Debug::showLevel(lyxerr, lyxerr.level());
1175 int parse_help(string const &, string const &, string &)
1178 to_utf8(_("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
1179 "Command line switches (case sensitive):\n"
1180 "\t-help summarize LyX usage\n"
1181 "\t-userdir dir set user directory to dir\n"
1182 "\t-sysdir dir set system directory to dir\n"
1183 "\t-geometry WxH+X+Y set geometry of the main window\n"
1184 "\t-dbg feature[,feature]...\n"
1185 " select the features to debug.\n"
1186 " Type `lyx -dbg' to see the list of features\n"
1187 "\t-x [--execute] command\n"
1188 " where command is a lyx command.\n"
1189 "\t-e [--export] fmt\n"
1190 " where fmt is the export format of choice. Look in\n"
1191 " Tools->Preferences->File Handling->File Formats->Short Name\n"
1192 " to see which parameter (which differs from the format name\n"
1193 " in the File->Export menu) should be passed. To export to\n"
1194 " the document's default output format, use 'default'.\n"
1195 " Note that the order of -e and -x switches matters.\n"
1196 "\t-E [--export-to] fmt filename\n"
1197 " where fmt is the export format of choice (see --export),\n"
1198 " and filename is the destination filename.\n"
1199 "\t-i [--import] fmt file.xxx\n"
1200 " where fmt is the import format of choice\n"
1201 " and file.xxx is the file to be imported.\n"
1202 "\t-f [--force-overwrite] what\n"
1203 " where what is either `all', `main' or `none',\n"
1204 " specifying whether all files, main file only, or no files,\n"
1205 " respectively, are to be overwritten during a batch export.\n"
1206 " Anything else is equivalent to `all', but is not consumed.\n"
1207 "\t--ignore-error-message which\n"
1208 " allows you to ignore specific LaTeX error messages.\n"
1209 " Do not use for final documents! Currently supported values:\n"
1210 " * missing_glyphs: Fontspec `missing glyphs' error.\n"
1211 "\t-n [--no-remote]\n"
1212 " open documents in a new instance\n"
1214 " open documents in an already running instance\n"
1215 " (a working lyxpipe is needed)\n"
1216 "\t-v [--verbose]\n"
1217 " report on terminal about spawned commands.\n"
1218 "\t-batch execute commands without launching GUI and exit.\n"
1219 "\t-version summarize version and build info\n"
1220 "Check the LyX man page for more details.")) << endl;
1226 int parse_version(string const &, string const &, string &)
1228 cout << "LyX " << lyx_version
1229 << " (" << lyx_release_date << ")" << endl;
1230 if (string(lyx_git_commit_hash) != "none")
1231 cout << to_utf8(_(" Git commit hash "))
1232 << string(lyx_git_commit_hash).substr(0,8) << endl;
1233 cout << lyx_version_info << endl;
1239 int parse_sysdir(string const & arg, string const &, string &)
1242 Alert::error(_("No system directory"),
1243 _("Missing directory for -sysdir switch"));
1246 cl_system_support = arg;
1251 int parse_userdir(string const & arg, string const &, string &)
1254 Alert::error(_("No user directory"),
1255 _("Missing directory for -userdir switch"));
1258 cl_user_support = arg;
1263 int parse_execute(string const & arg, string const &, string & batch)
1266 Alert::error(_("Incomplete command"),
1267 _("Missing command string after --execute switch"));
1275 int parse_export_to(string const & type, string const & output_file, string & batch)
1278 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1279 "--export-to switch")) << endl;
1282 if (output_file.empty()) {
1283 lyxerr << to_utf8(_("Missing destination filename after "
1284 "--export-to switch")) << endl;
1287 batch = "buffer-export " + type + " " + output_file;
1293 int parse_export(string const & type, string const &, string & batch)
1296 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1297 "--export switch")) << endl;
1300 batch = "buffer-export " + type;
1306 int parse_import(string const & type, string const & file, string & batch)
1309 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1310 "--import switch")) << endl;
1314 lyxerr << to_utf8(_("Missing filename for --import")) << endl;
1317 batch = "buffer-import " + type + ' ' + file;
1322 int parse_geometry(string const & arg1, string const &, string &)
1325 // don't remove "-geometry", it will be pruned out later in the
1326 // frontend if need be.
1331 int parse_batch(string const &, string const &, string &)
1338 int parse_noremote(string const &, string const &, string &)
1340 run_mode = NEW_INSTANCE;
1345 int parse_remote(string const &, string const &, string &)
1347 run_mode = USE_REMOTE;
1352 int parse_verbose(string const &, string const &, string &)
1359 int parse_ignore_error_message(string const & arg1, string const &, string &)
1361 if (arg1 == "missing_glyphs") {
1362 ignore_missing_glyphs = true;
1369 int parse_force(string const & arg, string const &, string &)
1372 force_overwrite = ALL_FILES;
1374 } else if (arg == "main") {
1375 force_overwrite = MAIN_FILE;
1377 } else if (arg == "none") {
1378 force_overwrite = NO_FILES;
1381 force_overwrite = ALL_FILES;
1389 void LyX::easyParse(int & argc, char * argv[])
1391 map<string, cmd_helper> cmdmap;
1393 cmdmap["-dbg"] = parse_dbg;
1394 cmdmap["-help"] = parse_help;
1395 cmdmap["--help"] = parse_help;
1396 cmdmap["-version"] = parse_version;
1397 cmdmap["--version"] = parse_version;
1398 cmdmap["-sysdir"] = parse_sysdir;
1399 cmdmap["-userdir"] = parse_userdir;
1400 cmdmap["-x"] = parse_execute;
1401 cmdmap["--execute"] = parse_execute;
1402 cmdmap["-e"] = parse_export;
1403 cmdmap["--export"] = parse_export;
1404 cmdmap["-E"] = parse_export_to;
1405 cmdmap["--export-to"] = parse_export_to;
1406 cmdmap["-i"] = parse_import;
1407 cmdmap["--import"] = parse_import;
1408 cmdmap["-geometry"] = parse_geometry;
1409 cmdmap["-batch"] = parse_batch;
1410 cmdmap["-f"] = parse_force;
1411 cmdmap["--force-overwrite"] = parse_force;
1412 cmdmap["-n"] = parse_noremote;
1413 cmdmap["--no-remote"] = parse_noremote;
1414 cmdmap["-r"] = parse_remote;
1415 cmdmap["--remote"] = parse_remote;
1416 cmdmap["-v"] = parse_verbose;
1417 cmdmap["--verbose"] = parse_verbose;
1418 cmdmap["--ignore-error-message"] = parse_ignore_error_message;
1420 for (int i = 1; i < argc; ++i) {
1421 map<string, cmd_helper>::const_iterator it
1422 = cmdmap.find(argv[i]);
1424 // don't complain if not found - may be parsed later
1425 if (it == cmdmap.end())
1429 (i + 1 < argc) ? os::utf8_argv(i + 1) : string();
1431 (i + 2 < argc) ? os::utf8_argv(i + 2) : string();
1434 int const remove = 1 + it->second(arg, arg2, batch);
1436 pimpl_->batch_commands.push_back(batch);
1438 // Now, remove used arguments by shifting
1439 // the following ones remove places down.
1441 os::remove_internal_args(i, remove);
1443 for (int j = i; j < argc; ++j)
1444 argv[j] = argv[j + remove];
1451 FuncStatus getStatus(FuncRequest const & action)
1454 return theApp()->getStatus(action);
1458 DispatchResult const & dispatch(FuncRequest const & action)
1461 return theApp()->dispatch(action);
1465 void dispatch(FuncRequest const & action, DispatchResult & dr)
1468 theApp()->dispatch(action, dr);
1472 vector<string> & theFilesToLoad()
1474 LAPPERR(singleton_);
1475 return singleton_->pimpl_->files_to_load_;
1479 BufferList & theBufferList()
1481 LAPPERR(singleton_);
1482 return singleton_->pimpl_->buffer_list_;
1486 Server & theServer()
1488 // FIXME: this should not be use_gui dependent
1490 LAPPERR(singleton_);
1491 return *singleton_->pimpl_->lyx_server_;
1495 ServerSocket & theServerSocket()
1497 // FIXME: this should not be use_gui dependent
1499 LAPPERR(singleton_);
1500 return *singleton_->pimpl_->lyx_socket_;
1504 KeyMap & theTopLevelKeymap()
1506 LAPPERR(singleton_);
1507 return singleton_->pimpl_->toplevel_keymap_;
1511 Formats & theFormats()
1513 LAPPERR(singleton_);
1514 return singleton_->pimpl_->formats_;
1518 Formats & theSystemFormats()
1520 LAPPERR(singleton_);
1521 return singleton_->pimpl_->system_formats_;
1525 Converters & theConverters()
1527 LAPPERR(singleton_);
1528 return singleton_->pimpl_->converters_;
1532 Converters & theSystemConverters()
1534 LAPPERR(singleton_);
1535 return singleton_->pimpl_->system_converters_;
1539 Movers & theMovers()
1541 LAPPERR(singleton_);
1542 return singleton_->pimpl_->movers_;
1546 Mover const & getMover(string const & fmt)
1548 LAPPERR(singleton_);
1549 return singleton_->pimpl_->movers_(fmt);
1553 void setMover(string const & fmt, string const & command)
1555 LAPPERR(singleton_);
1556 singleton_->pimpl_->movers_.set(fmt, command);
1560 Movers & theSystemMovers()
1562 LAPPERR(singleton_);
1563 return singleton_->pimpl_->system_movers_;
1567 Messages const & getMessages(string const & language)
1569 LAPPERR(singleton_);
1570 return singleton_->messages(language);
1574 Messages const & getGuiMessages()
1576 LAPPERR(singleton_);
1577 return singleton_->messages(Messages::guiLanguage());
1581 Session & theSession()
1583 LAPPERR(singleton_);
1584 return *singleton_->pimpl_->session_.get();
1588 LaTeXFonts & theLaTeXFonts()
1590 LAPPERR(singleton_);
1591 if (!singleton_->pimpl_->latexfonts_)
1592 singleton_->pimpl_->latexfonts_ = new LaTeXFonts;
1593 return *singleton_->pimpl_->latexfonts_;
1597 CmdDef & theTopLevelCmdDef()
1599 LAPPERR(singleton_);
1600 return singleton_->pimpl_->toplevel_cmddef_;
1604 SpellChecker * theSpellChecker()
1606 if (!singleton_->pimpl_->spell_checker_)
1608 return singleton_->pimpl_->spell_checker_;
1612 void setSpellChecker()
1614 SpellChecker::ChangeNumber speller_change_number =singleton_->pimpl_->spell_checker_ ?
1615 singleton_->pimpl_->spell_checker_->changeNumber() : 0;
1617 if (lyxrc.spellchecker == "native") {
1618 #if defined(USE_MACOSX_PACKAGING)
1619 if (!singleton_->pimpl_->apple_spell_checker_)
1620 singleton_->pimpl_->apple_spell_checker_ = new AppleSpellChecker;
1621 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->apple_spell_checker_;
1623 singleton_->pimpl_->spell_checker_ = 0;
1625 } else if (lyxrc.spellchecker == "aspell") {
1626 #if defined(USE_ASPELL)
1627 if (!singleton_->pimpl_->aspell_checker_)
1628 singleton_->pimpl_->aspell_checker_ = new AspellChecker;
1629 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->aspell_checker_;
1631 singleton_->pimpl_->spell_checker_ = 0;
1633 } else if (lyxrc.spellchecker == "enchant") {
1634 #if defined(USE_ENCHANT)
1635 if (!singleton_->pimpl_->enchant_checker_)
1636 singleton_->pimpl_->enchant_checker_ = new EnchantChecker;
1637 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->enchant_checker_;
1639 singleton_->pimpl_->spell_checker_ = 0;
1641 } else if (lyxrc.spellchecker == "hunspell") {
1642 #if defined(USE_HUNSPELL)
1643 if (!singleton_->pimpl_->hunspell_checker_)
1644 singleton_->pimpl_->hunspell_checker_ = new HunspellChecker;
1645 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->hunspell_checker_;
1647 singleton_->pimpl_->spell_checker_ = 0;
1650 singleton_->pimpl_->spell_checker_ = 0;
1652 if (singleton_->pimpl_->spell_checker_) {
1653 singleton_->pimpl_->spell_checker_->changeNumber(speller_change_number);
1654 singleton_->pimpl_->spell_checker_->advanceChangeNumber();