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_ = nullptr;
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_(nullptr), spell_checker_(nullptr),
159 apple_spell_checker_(nullptr), aspell_checker_(nullptr),
160 enchant_checker_(nullptr), hunspell_checker_(nullptr)
166 delete apple_spell_checker_;
167 delete aspell_checker_;
168 delete enchant_checker_;
169 delete hunspell_checker_;
173 BufferList buffer_list_;
175 KeyMap toplevel_keymap_;
177 CmdDef toplevel_cmddef_;
179 unique_ptr<Server> lyx_server_;
181 unique_ptr<ServerSocket> lyx_socket_;
183 unique_ptr<frontend::Application> application_;
184 /// lyx session, containing lastfiles, lastfilepos, and lastopened
185 unique_ptr<Session> session_;
187 /// Files to load at start.
188 vector<string> files_to_load_;
190 /// The messages translators.
191 map<string, Messages> messages_;
193 /// The file converters.
194 Converters converters_;
195 /// The system converters after reading lyxrc.defaults.
196 Converters system_converters_;
198 /// Global format information
200 /// The system formats after reading lyxrc.defaults.
201 Formats system_formats_;
207 Movers system_movers_;
209 /// the parsed command line batch command if any
210 vector<string> batch_commands;
213 LaTeXFonts * latexfonts_;
216 SpellChecker * spell_checker_;
218 SpellChecker * apple_spell_checker_;
220 SpellChecker * aspell_checker_;
222 SpellChecker * enchant_checker_;
224 SpellChecker * hunspell_checker_;
228 /// The main application class for console mode
229 class LyXConsoleApp : public ConsoleApplication
232 LyXConsoleApp(LyX * lyx, int & argc, char * argv[])
233 : ConsoleApplication(lyx_package, argc, argv), lyx_(lyx),
234 argc_(argc), argv_(argv)
239 int const exit_status = lyx_->execWithoutGui(argc_, argv_);
250 frontend::Application * theApp()
253 return singleton_->pimpl_->application_.get();
262 singleton_ = nullptr;
266 void lyx_exit(int exit_code)
269 // Something wrong happened so better save everything, just in
274 // Properly crash in debug mode in order to get a useful backtrace.
278 // In release mode, try to exit gracefully.
280 theApp()->exit(exit_code);
294 Messages & LyX::messages(string const & language)
296 map<string, Messages>::iterator it = pimpl_->messages_.find(language);
298 if (it != pimpl_->messages_.end())
301 pair<map<string, Messages>::iterator, bool> result =
302 pimpl_->messages_.insert(make_pair(language, Messages(language)));
304 LATTEST(result.second);
305 return result.first->second;
309 int LyX::exec(int & argc, char * argv[])
311 // Minimal setting of locale before parsing command line
313 init_package(os::utf8_argv(0), string(), string());
314 // we do not get to this point when init_package throws an exception
316 } catch (ExceptionMessage const & message) {
317 LYXERR(Debug::LOCALE, message.title_ + ", " + message.details_);
320 // Here we need to parse the command line. At least
321 // we need to parse for "-dbg" and "-help"
322 easyParse(argc, argv);
324 #if QT_VERSION >= 0x050600
325 // Check whether Qt will scale all GUI elements and accordingly
326 // set the scale factor so that to avoid blurred images and text
327 char const * const scale_factor = getenv("QT_SCALE_FACTOR");
329 qt_scale_factor = convert<double>(scale_factor);
330 if (qt_scale_factor < 1.0)
331 qt_scale_factor = 1.0;
336 init_package(os::utf8_argv(0), cl_system_support, cl_user_support);
337 } catch (ExceptionMessage const & message) {
338 if (message.type_ == ErrorException) {
339 Alert::error(message.title_, message.details_);
341 } else if (message.type_ == WarningException) {
342 Alert::warning(message.title_, message.details_);
346 // Reinit the messages machinery in case package() knows
347 // something interesting about the locale directory.
351 LyXConsoleApp app(this, argc, argv);
353 // Reestablish our defaults, as Qt overwrites them
354 // after creating app
360 // Let the frontend parse and remove all arguments that it knows
361 pimpl_->application_.reset(createApplication(argc, argv));
363 // Reestablish our defaults, as Qt overwrites them
364 // after createApplication()
367 // Parse and remove all known arguments in the LyX singleton
368 // Give an error for all remaining ones.
369 int exit_status = init(argc, argv);
371 // Kill the application object before exiting.
372 pimpl_->application_.reset();
378 // If not otherwise specified by a command line option or
379 // by preferences, we default to reuse a running instance.
380 if (run_mode == PREFERRED)
381 run_mode = USE_REMOTE;
384 /* Create a CoreApplication class that will provide the main event loop
385 * and the socket callback registering. With Qt, only QtCore
386 * library would be needed.
387 * When this is done, a server_mode could be created and the following two
388 * line would be moved out from here.
389 * However, note that the first of the two lines below triggers the
390 * "single instance" behavior, which should occur right at this point.
392 // Note: socket callback must be registered after init(argc, argv)
393 // such that package().temp_dir() is properly initialized.
394 pimpl_->lyx_server_.reset(new Server(lyxrc.lyxpipes));
395 pimpl_->lyx_socket_.reset(new ServerSocket(
396 FileName(package().temp_dir().absFileName() + "/lyxsocket")));
398 // Start the real execution loop.
399 if (!pimpl_->lyx_server_->deferredLoadingToOtherInstance())
400 exit_status = pimpl_->application_->exec();
401 else if (!pimpl_->files_to_load_.empty()) {
402 lyxerr << _("The following files could not be loaded:") << endl;
403 for (auto const & f : pimpl_->files_to_load_)
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());
913 // Add the directory containing the dt2dv and dv2dt executables to the path
915 if (!package().build_support().empty()) {
916 // dtl executables should be in the same dir ar tex2lyx
917 dtldir = package().binary_dir();
920 dtldir = FileName(addName(package().system_support().absFileName(), "extratools"));
923 string dtlexe = "dt2dv.exe";
925 string dtlexe = "dt2dv";
927 FileName const dt2dv = FileName(addName(dtldir.absFileName(), dtlexe));
929 prependEnvPath("PATH", dtldir.absFileName());
931 if (!lyxrc.path_prefix.empty())
932 prependEnvPath("PATH", replaceEnvironmentPath(lyxrc.path_prefix));
934 // Check that user LyX directory is ok.
936 string const lock_file = package().getConfigureLockName();
937 int fd = fileLock(lock_file.c_str());
939 if (queryUserLyXDir(package().explicit_user_support())) {
940 package().reconfigureUserLyXDir("");
941 // Now the user directory is present on first start.
944 fileUnlock(fd, lock_file.c_str());
948 // No need for a splash when there is no GUI
950 // Default is to overwrite the main file during export, unless
951 // the -f switch was specified or LYX_FORCE_OVERWRITE was set
952 if (force_overwrite == UNSPECIFIED) {
953 string const what = getEnv("LYX_FORCE_OVERWRITE");
955 force_overwrite = ALL_FILES;
956 else if (what == "none")
957 force_overwrite = NO_FILES;
959 force_overwrite = MAIN_FILE;
963 // This one is generated in user_support directory by lib/configure.py.
964 if (!readRcFile("lyxrc.defaults"))
967 // Query the OS to know what formats are viewed natively
968 theFormats().setAutoOpen();
970 // Read lyxrc.dist again to be able to override viewer auto-detection.
971 readRcFile("lyxrc.dist");
973 system_lyxrc = lyxrc;
974 theSystemFormats() = theFormats();
975 pimpl_->system_converters_ = pimpl_->converters_;
976 pimpl_->system_movers_ = pimpl_->movers_;
977 system_lcolor = lcolor;
979 // This one is edited through the preferences dialog.
980 if (!readRcFile("preferences", true))
983 // The language may have been set to someting useful through prefs
986 if (!readEncodingsFile("encodings", "unicodesymbols"))
988 if (!readLanguagesFile("languages"))
991 LYXERR(Debug::INIT, "Reading layouts...");
993 LayoutFileList::get().read();
995 theModuleList.read();
996 //... and the cite engines
997 theCiteEnginesList.read();
999 // read keymap and ui files in batch mode as well
1000 // because InsetInfo needs to know these to produce
1001 // the correct output
1003 // Set up command definitions
1004 pimpl_->toplevel_cmddef_.read(lyxrc.def_file);
1008 pimpl_->toplevel_keymap_.read("site");
1009 pimpl_->toplevel_keymap_.read(lyxrc.bind_file);
1010 // load user bind file user.bind
1011 pimpl_->toplevel_keymap_.read("user", nullptr, KeyMap::MissingOK);
1013 if (lyxerr.debugging(Debug::LYXRC))
1016 os::windows_style_tex_paths(lyxrc.windows_style_tex_paths);
1017 // Prepend path prefix a second time to take the user preferences into a account
1018 if (!lyxrc.path_prefix.empty())
1019 prependEnvPath("PATH", replaceEnvironmentPath(lyxrc.path_prefix));
1021 FileName const document_path(lyxrc.document_path);
1022 if (document_path.exists() && document_path.isDirectory())
1023 package().document_dir() = document_path;
1025 package().set_temp_dir(createLyXTmpDir(FileName(lyxrc.tempdir_path)));
1026 if (package().temp_dir().empty()) {
1027 Alert::error(_("Could not create temporary directory"),
1028 bformat(_("Could not create a temporary directory in\n"
1030 "Make sure that this path exists and is writable and try again."),
1031 from_utf8(lyxrc.tempdir_path)));
1032 // createLyXTmpDir() tries sufficiently hard to create a
1033 // usable temp dir, so the probability to come here is
1034 // close to zero. We therefore don't try to overcome this
1035 // problem with e.g. asking the user for a new path and
1036 // trying again but simply exit.
1040 LYXERR(Debug::INIT, "LyX tmp dir: `"
1041 << package().temp_dir().absFileName() << '\'');
1043 LYXERR(Debug::INIT, "Reading session information '.lyx/session'...");
1044 pimpl_->session_.reset(new Session(lyxrc.num_lastfiles));
1046 // This must happen after package initialization and after lyxrc is
1047 // read, therefore it can't be done by a static object.
1048 ConverterCache::init();
1054 void emergencyCleanup()
1056 // what to do about tmpfiles is non-obvious. we would
1057 // like to delete any we find, but our lyxdir might
1058 // contain documents etc. which might be helpful on
1061 singleton_->pimpl_->buffer_list_.emergencyWriteAll();
1063 if (singleton_->pimpl_->lyx_server_)
1064 singleton_->pimpl_->lyx_server_->emergencyCleanup();
1065 singleton_->pimpl_->lyx_server_.reset();
1066 singleton_->pimpl_->lyx_socket_.reset();
1071 bool LyX::queryUserLyXDir(bool explicit_userdir)
1073 // Does user directory exist?
1074 FileName const sup = package().user_support();
1075 if (sup.exists() && sup.isDirectory()) {
1076 first_start = false;
1078 return configFileNeedsUpdate("lyxrc.defaults")
1079 || configFileNeedsUpdate("lyxmodules.lst")
1080 || configFileNeedsUpdate("textclass.lst")
1081 || configFileNeedsUpdate("packages.lst")
1082 || configFileNeedsUpdate("lyxciteengines.lst")
1083 || configFileNeedsUpdate("xtemplates.lst");
1086 first_start = !explicit_userdir;
1088 // If the user specified explicitly a directory, ask whether
1089 // to create it. If the user says "no", then exit.
1090 if (explicit_userdir &&
1092 _("Missing user LyX directory"),
1093 bformat(_("You have specified a non-existent user "
1094 "LyX directory, %1$s.\n"
1095 "It is needed to keep your own configuration."),
1096 from_utf8(package().user_support().absFileName())),
1098 _("&Create directory"),
1100 lyxerr << to_utf8(_("No user LyX directory. Exiting.")) << endl;
1101 earlyExit(EXIT_FAILURE);
1104 lyxerr << to_utf8(bformat(_("LyX: Creating directory %1$s"),
1105 from_utf8(sup.absFileName()))) << endl;
1107 if (!sup.createDirectory(0755)) {
1108 // Failed, so let's exit.
1109 lyxerr << to_utf8(_("Failed to create directory. Exiting."))
1111 earlyExit(EXIT_FAILURE);
1118 bool LyX::readRcFile(string const & name, bool check_format)
1120 LYXERR(Debug::INIT, "About to read " << name << "... ");
1122 FileName const lyxrc_path = libFileSearch(string(), name);
1123 if (lyxrc_path.empty()) {
1124 LYXERR(Debug::INIT, "Not found." << lyxrc_path);
1126 // This was the previous logic, but can it be right??
1129 LYXERR(Debug::INIT, "Found in " << lyxrc_path);
1130 bool const success = lyxrc.read(lyxrc_path, check_format);
1132 showFileError(name);
1136 // Read the languages file `name'
1137 bool LyX::readLanguagesFile(string const & name)
1139 LYXERR(Debug::INIT, "About to read " << name << "...");
1141 FileName const lang_path = libFileSearch(string(), name);
1142 if (lang_path.empty()) {
1143 showFileError(name);
1146 languages.read(lang_path);
1151 // Read the encodings file `name'
1152 bool LyX::readEncodingsFile(string const & enc_name,
1153 string const & symbols_name)
1155 LYXERR(Debug::INIT, "About to read " << enc_name << " and "
1156 << symbols_name << "...");
1158 FileName const symbols_path = libFileSearch(string(), symbols_name);
1159 if (symbols_path.empty()) {
1160 showFileError(symbols_name);
1164 FileName const enc_path = libFileSearch(string(), enc_name);
1165 if (enc_path.empty()) {
1166 showFileError(enc_name);
1169 encodings.read(enc_path, symbols_path);
1176 /// return the the number of arguments consumed
1177 typedef function<int(string const &, string const &, string &)> cmd_helper;
1179 int parse_dbg(string const & arg, string const &, string &)
1182 cout << to_utf8(_("List of supported debug flags:")) << endl;
1183 Debug::showTags(cout);
1186 lyxerr << to_utf8(bformat(_("Setting debug level to %1$s"), from_utf8(arg))) << endl;
1188 lyxerr.setLevel(Debug::value(arg));
1189 Debug::showLevel(lyxerr, lyxerr.level());
1194 int parse_help(string const &, string const &, string &)
1197 to_utf8(_("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
1198 "Command line switches (case sensitive):\n"
1199 "\t-help summarize LyX usage\n"
1200 "\t-userdir dir set user directory to dir\n"
1201 "\t-sysdir dir set system directory to dir\n"
1202 "\t-geometry WxH+X+Y set geometry of the main window\n"
1203 "\t-dbg feature[,feature]...\n"
1204 " select the features to debug.\n"
1205 " Type `lyx -dbg' to see the list of features\n"
1206 "\t-x [--execute] command\n"
1207 " where command is a lyx command.\n"
1208 "\t-e [--export] fmt\n"
1209 " where fmt is the export format of choice. Look in\n"
1210 " Tools->Preferences->File Handling->File Formats->Short Name\n"
1211 " to see which parameter (which differs from the format name\n"
1212 " in the File->Export menu) should be passed. To export to\n"
1213 " the document's default output format, use 'default'.\n"
1214 " Note that the order of -e and -x switches matters.\n"
1215 "\t-E [--export-to] fmt filename\n"
1216 " where fmt is the export format of choice (see --export),\n"
1217 " and filename is the destination filename.\n"
1218 "\t-i [--import] fmt file.xxx\n"
1219 " where fmt is the import format of choice\n"
1220 " and file.xxx is the file to be imported.\n"
1221 "\t-f [--force-overwrite] what\n"
1222 " where what is either `all', `main' or `none',\n"
1223 " specifying whether all files, main file only, or no files,\n"
1224 " respectively, are to be overwritten during a batch export.\n"
1225 " Anything else is equivalent to `all', but is not consumed.\n"
1226 "\t--ignore-error-message which\n"
1227 " allows you to ignore specific LaTeX error messages.\n"
1228 " Do not use for final documents! Currently supported values:\n"
1229 " * missing_glyphs: Fontspec `missing glyphs' error.\n"
1230 "\t-n [--no-remote]\n"
1231 " open documents in a new instance\n"
1233 " open documents in an already running instance\n"
1234 " (a working lyxpipe is needed)\n"
1235 "\t-v [--verbose]\n"
1236 " report on terminal about spawned commands.\n"
1237 "\t-batch execute commands without launching GUI and exit.\n"
1238 "\t-version summarize version and build info\n"
1239 "Check the LyX man page for more details.")) << endl;
1245 int parse_version(string const &, string const &, string &)
1247 cout << "LyX " << lyx_version
1248 << " (" << lyx_release_date << ")" << endl;
1249 if (string(lyx_git_commit_hash) != "none")
1250 cout << to_utf8(_(" Git commit hash "))
1251 << string(lyx_git_commit_hash).substr(0,8) << endl;
1252 cout << lyx_version_info << endl;
1258 int parse_sysdir(string const & arg, string const &, string &)
1261 Alert::error(_("No system directory"),
1262 _("Missing directory for -sysdir switch"));
1265 cl_system_support = arg;
1270 int parse_userdir(string const & arg, string const &, string &)
1273 Alert::error(_("No user directory"),
1274 _("Missing directory for -userdir switch"));
1277 cl_user_support = arg;
1282 int parse_execute(string const & arg, string const &, string & batch)
1285 Alert::error(_("Incomplete command"),
1286 _("Missing command string after --execute switch"));
1294 int parse_export_to(string const & type, string const & output_file, string & batch)
1297 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1298 "--export-to switch")) << endl;
1301 if (output_file.empty()) {
1302 lyxerr << to_utf8(_("Missing destination filename after "
1303 "--export-to switch")) << endl;
1306 batch = "buffer-export " + type + " " + output_file;
1312 int parse_export(string const & type, string const &, string & batch)
1315 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1316 "--export switch")) << endl;
1319 batch = "buffer-export " + type;
1325 int parse_import(string const & type, string const & file, string & batch)
1328 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1329 "--import switch")) << endl;
1333 lyxerr << to_utf8(_("Missing filename for --import")) << endl;
1336 batch = "buffer-import " + type + ' ' + file;
1341 int parse_geometry(string const & arg1, string const &, string &)
1344 // don't remove "-geometry", it will be pruned out later in the
1345 // frontend if need be.
1350 int parse_batch(string const &, string const &, string &)
1357 int parse_noremote(string const &, string const &, string &)
1359 run_mode = NEW_INSTANCE;
1364 int parse_remote(string const &, string const &, string &)
1366 run_mode = USE_REMOTE;
1371 int parse_verbose(string const &, string const &, string &)
1378 int parse_ignore_error_message(string const & arg1, string const &, string &)
1380 if (arg1 == "missing_glyphs") {
1381 ignore_missing_glyphs = true;
1388 int parse_force(string const & arg, string const &, string &)
1391 force_overwrite = ALL_FILES;
1393 } else if (arg == "main") {
1394 force_overwrite = MAIN_FILE;
1396 } else if (arg == "none") {
1397 force_overwrite = NO_FILES;
1400 force_overwrite = ALL_FILES;
1408 void LyX::easyParse(int & argc, char * argv[])
1410 map<string, cmd_helper> cmdmap;
1412 cmdmap["-dbg"] = parse_dbg;
1413 cmdmap["-help"] = parse_help;
1414 cmdmap["--help"] = parse_help;
1415 cmdmap["-version"] = parse_version;
1416 cmdmap["--version"] = parse_version;
1417 cmdmap["-sysdir"] = parse_sysdir;
1418 cmdmap["-userdir"] = parse_userdir;
1419 cmdmap["-x"] = parse_execute;
1420 cmdmap["--execute"] = parse_execute;
1421 cmdmap["-e"] = parse_export;
1422 cmdmap["--export"] = parse_export;
1423 cmdmap["-E"] = parse_export_to;
1424 cmdmap["--export-to"] = parse_export_to;
1425 cmdmap["-i"] = parse_import;
1426 cmdmap["--import"] = parse_import;
1427 cmdmap["-geometry"] = parse_geometry;
1428 cmdmap["-batch"] = parse_batch;
1429 cmdmap["-f"] = parse_force;
1430 cmdmap["--force-overwrite"] = parse_force;
1431 cmdmap["-n"] = parse_noremote;
1432 cmdmap["--no-remote"] = parse_noremote;
1433 cmdmap["-r"] = parse_remote;
1434 cmdmap["--remote"] = parse_remote;
1435 cmdmap["-v"] = parse_verbose;
1436 cmdmap["--verbose"] = parse_verbose;
1437 cmdmap["--ignore-error-message"] = parse_ignore_error_message;
1439 for (int i = 1; i < argc; ++i) {
1440 map<string, cmd_helper>::const_iterator it
1441 = cmdmap.find(argv[i]);
1443 // don't complain if not found - may be parsed later
1444 if (it == cmdmap.end())
1448 (i + 1 < argc) ? os::utf8_argv(i + 1) : string();
1450 (i + 2 < argc) ? os::utf8_argv(i + 2) : string();
1453 int const remove = 1 + it->second(arg, arg2, batch);
1455 pimpl_->batch_commands.push_back(batch);
1457 // Now, remove used arguments by shifting
1458 // the following ones remove places down.
1460 os::remove_internal_args(i, remove);
1462 for (int j = i; j < argc; ++j)
1463 argv[j] = argv[j + remove];
1470 FuncStatus getStatus(FuncRequest const & action)
1473 return theApp()->getStatus(action);
1477 DispatchResult const & dispatch(FuncRequest const & action)
1480 return theApp()->dispatch(action);
1484 void dispatch(FuncRequest const & action, DispatchResult & dr)
1487 theApp()->dispatch(action, dr);
1491 vector<string> & theFilesToLoad()
1493 LAPPERR(singleton_);
1494 return singleton_->pimpl_->files_to_load_;
1498 BufferList & theBufferList()
1500 LAPPERR(singleton_);
1501 return singleton_->pimpl_->buffer_list_;
1505 Server & theServer()
1507 // FIXME: this should not be use_gui dependent
1509 LAPPERR(singleton_);
1510 return *singleton_->pimpl_->lyx_server_;
1514 ServerSocket & theServerSocket()
1516 // FIXME: this should not be use_gui dependent
1518 LAPPERR(singleton_);
1519 return *singleton_->pimpl_->lyx_socket_;
1523 KeyMap & theTopLevelKeymap()
1525 LAPPERR(singleton_);
1526 return singleton_->pimpl_->toplevel_keymap_;
1530 Formats & theFormats()
1532 LAPPERR(singleton_);
1533 return singleton_->pimpl_->formats_;
1537 Formats & theSystemFormats()
1539 LAPPERR(singleton_);
1540 return singleton_->pimpl_->system_formats_;
1544 Converters & theConverters()
1546 LAPPERR(singleton_);
1547 return singleton_->pimpl_->converters_;
1551 Converters & theSystemConverters()
1553 LAPPERR(singleton_);
1554 return singleton_->pimpl_->system_converters_;
1558 Movers & theMovers()
1560 LAPPERR(singleton_);
1561 return singleton_->pimpl_->movers_;
1565 Mover const & getMover(string const & fmt)
1567 LAPPERR(singleton_);
1568 return singleton_->pimpl_->movers_(fmt);
1572 void setMover(string const & fmt, string const & command)
1574 LAPPERR(singleton_);
1575 singleton_->pimpl_->movers_.set(fmt, command);
1579 Movers & theSystemMovers()
1581 LAPPERR(singleton_);
1582 return singleton_->pimpl_->system_movers_;
1586 Messages const & getMessages(string const & language)
1588 LAPPERR(singleton_);
1589 return singleton_->messages(language);
1593 Messages const & getGuiMessages()
1595 LAPPERR(singleton_);
1596 return singleton_->messages(Messages::guiLanguage());
1600 Session & theSession()
1602 LAPPERR(singleton_);
1603 return *singleton_->pimpl_->session_.get();
1607 LaTeXFonts & theLaTeXFonts()
1609 LAPPERR(singleton_);
1610 if (!singleton_->pimpl_->latexfonts_)
1611 singleton_->pimpl_->latexfonts_ = new LaTeXFonts;
1612 return *singleton_->pimpl_->latexfonts_;
1616 CmdDef & theTopLevelCmdDef()
1618 LAPPERR(singleton_);
1619 return singleton_->pimpl_->toplevel_cmddef_;
1623 SpellChecker * theSpellChecker()
1625 if (!singleton_->pimpl_->spell_checker_)
1627 return singleton_->pimpl_->spell_checker_;
1631 void setSpellChecker()
1633 SpellChecker::ChangeNumber speller_change_number =singleton_->pimpl_->spell_checker_ ?
1634 singleton_->pimpl_->spell_checker_->changeNumber() : 0;
1636 if (lyxrc.spellchecker == "native") {
1637 #if defined(USE_MACOSX_PACKAGING)
1638 if (!singleton_->pimpl_->apple_spell_checker_)
1639 singleton_->pimpl_->apple_spell_checker_ = new AppleSpellChecker;
1640 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->apple_spell_checker_;
1642 singleton_->pimpl_->spell_checker_ = nullptr;
1644 } else if (lyxrc.spellchecker == "aspell") {
1645 #if defined(USE_ASPELL)
1646 if (!singleton_->pimpl_->aspell_checker_)
1647 singleton_->pimpl_->aspell_checker_ = new AspellChecker;
1648 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->aspell_checker_;
1650 singleton_->pimpl_->spell_checker_ = nullptr;
1652 } else if (lyxrc.spellchecker == "enchant") {
1653 #if defined(USE_ENCHANT)
1654 if (!singleton_->pimpl_->enchant_checker_)
1655 singleton_->pimpl_->enchant_checker_ = new EnchantChecker;
1656 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->enchant_checker_;
1658 singleton_->pimpl_->spell_checker_ = nullptr;
1660 } else if (lyxrc.spellchecker == "hunspell") {
1661 #if defined(USE_HUNSPELL)
1662 if (!singleton_->pimpl_->hunspell_checker_)
1663 singleton_->pimpl_->hunspell_checker_ = new HunspellChecker;
1664 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->hunspell_checker_;
1666 singleton_->pimpl_->spell_checker_ = nullptr;
1669 singleton_->pimpl_->spell_checker_ = nullptr;
1671 if (singleton_->pimpl_->spell_checker_) {
1672 singleton_->pimpl_->spell_checker_->changeNumber(speller_change_number);
1673 singleton_->pimpl_->spell_checker_->advanceChangeNumber();