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_;
194 // The system converters copy after reading lyxrc.defaults.
195 Converters system_converters_;
200 Movers system_movers_;
202 /// the parsed command line batch command if any
203 vector<string> batch_commands;
206 LaTeXFonts * latexfonts_;
209 SpellChecker * spell_checker_;
211 SpellChecker * apple_spell_checker_;
213 SpellChecker * aspell_checker_;
215 SpellChecker * enchant_checker_;
217 SpellChecker * hunspell_checker_;
221 /// The main application class for console mode
222 class LyXConsoleApp : public ConsoleApplication
225 LyXConsoleApp(LyX * lyx, int & argc, char * argv[])
226 : ConsoleApplication(lyx_package, argc, argv), lyx_(lyx),
227 argc_(argc), argv_(argv)
232 int const exit_status = lyx_->execWithoutGui(argc_, argv_);
243 frontend::Application * theApp()
246 return singleton_->pimpl_->application_.get();
259 void lyx_exit(int exit_code)
262 // Something wrong happened so better save everything, just in
267 // Properly crash in debug mode in order to get a useful backtrace.
271 // In release mode, try to exit gracefully.
273 theApp()->exit(exit_code);
287 Messages & LyX::messages(string const & language)
289 map<string, Messages>::iterator it = pimpl_->messages_.find(language);
291 if (it != pimpl_->messages_.end())
294 pair<map<string, Messages>::iterator, bool> result =
295 pimpl_->messages_.insert(make_pair(language, Messages(language)));
297 LATTEST(result.second);
298 return result.first->second;
302 int LyX::exec(int & argc, char * argv[])
304 // Minimal setting of locale before parsing command line
306 init_package(os::utf8_argv(0), string(), string());
307 // we do not get to this point when init_package throws an exception
309 } catch (ExceptionMessage const & message) {
310 LYXERR(Debug::LOCALE, message.title_ + ", " + message.details_);
313 // Here we need to parse the command line. At least
314 // we need to parse for "-dbg" and "-help"
315 easyParse(argc, argv);
317 #if QT_VERSION >= 0x050600
318 // Check whether Qt will scale all GUI elements and accordingly
319 // set the scale factor so that to avoid blurred images and text
320 char const * const scale_factor = getenv("QT_SCALE_FACTOR");
322 qt_scale_factor = convert<double>(scale_factor);
323 if (qt_scale_factor < 1.0)
324 qt_scale_factor = 1.0;
329 init_package(os::utf8_argv(0), cl_system_support, cl_user_support);
330 } catch (ExceptionMessage const & message) {
331 if (message.type_ == ErrorException) {
332 Alert::error(message.title_, message.details_);
334 } else if (message.type_ == WarningException) {
335 Alert::warning(message.title_, message.details_);
339 // Reinit the messages machinery in case package() knows
340 // something interesting about the locale directory.
344 LyXConsoleApp app(this, argc, argv);
346 // Reestablish our defaults, as Qt overwrites them
347 // after creating app
353 // Let the frontend parse and remove all arguments that it knows
354 pimpl_->application_.reset(createApplication(argc, argv));
356 // Reestablish our defaults, as Qt overwrites them
357 // after createApplication()
360 // Parse and remove all known arguments in the LyX singleton
361 // Give an error for all remaining ones.
362 int exit_status = init(argc, argv);
364 // Kill the application object before exiting.
365 pimpl_->application_.reset();
371 // If not otherwise specified by a command line option or
372 // by preferences, we default to reuse a running instance.
373 if (run_mode == PREFERRED)
374 run_mode = USE_REMOTE;
377 /* Create a CoreApplication class that will provide the main event loop
378 * and the socket callback registering. With Qt, only QtCore
379 * library would be needed.
380 * When this is done, a server_mode could be created and the following two
381 * line would be moved out from here.
382 * However, note that the first of the two lines below triggers the
383 * "single instance" behavior, which should occur right at this point.
385 // Note: socket callback must be registered after init(argc, argv)
386 // such that package().temp_dir() is properly initialized.
387 pimpl_->lyx_server_.reset(new Server(lyxrc.lyxpipes));
388 pimpl_->lyx_socket_.reset(new ServerSocket(
389 FileName(package().temp_dir().absFileName() + "/lyxsocket")));
391 // Start the real execution loop.
392 if (!theServer().deferredLoadingToOtherInstance())
393 exit_status = pimpl_->application_->exec();
394 else if (!pimpl_->files_to_load_.empty()) {
395 vector<string>::const_iterator it = pimpl_->files_to_load_.begin();
396 vector<string>::const_iterator end = pimpl_->files_to_load_.end();
397 lyxerr << _("The following files could not be loaded:") << endl;
398 for (; it != end; ++it)
399 lyxerr << *it << endl;
408 void LyX::prepareExit()
410 // Clear the clipboard and selection stack:
411 cap::clearCutStack();
412 cap::clearSelection();
414 // Write the index file of the converter cache
415 ConverterCache::get().writeIndex();
417 // close buffers first
418 pimpl_->buffer_list_.closeAll();
420 // register session changes and shutdown server and socket
422 if (pimpl_->session_)
423 pimpl_->session_->writeFile();
424 pimpl_->session_.reset();
425 pimpl_->lyx_server_.reset();
426 pimpl_->lyx_socket_.reset();
429 // do any other cleanup procedures now
430 if (package().temp_dir() != package().system_temp_dir()) {
431 string const abs_tmpdir = package().temp_dir().absFileName();
432 if (!contains(package().temp_dir().absFileName(), "lyx_tmpdir")) {
433 docstring const msg =
434 bformat(_("%1$s does not appear like a LyX created temporary directory."),
435 from_utf8(abs_tmpdir));
436 Alert::warning(_("Cannot remove temporary directory"), msg);
438 LYXERR(Debug::INFO, "Deleting tmp dir "
439 << package().temp_dir().absFileName());
440 if (!package().temp_dir().destroyDirectory()) {
441 LYXERR0(bformat(_("Unable to remove the temporary directory %1$s"),
442 from_utf8(package().temp_dir().absFileName())));
447 // Kill the application object before exiting. This avoids crashes
448 // when exiting on Linux.
449 pimpl_->application_.reset();
453 void LyX::earlyExit(int status)
455 LATTEST(pimpl_->application_.get());
456 // LyX::pimpl_::application_ is not initialised at this
457 // point so it's safe to just exit after some cleanup.
463 int LyX::init(int & argc, char * argv[])
465 // check for any spurious extra arguments
466 // other than documents
467 for (int argi = 1; argi < argc ; ++argi) {
468 if (argv[argi][0] == '-') {
470 bformat(_("Wrong command line option `%1$s'. Exiting."),
471 from_utf8(os::utf8_argv(argi)))) << endl;
476 // Initialization of LyX (reads lyxrc and more)
477 LYXERR(Debug::INIT, "Initializing LyX::init...");
478 bool success = init();
479 LYXERR(Debug::INIT, "Initializing LyX::init...done");
483 // Remaining arguments are assumed to be files to load.
484 for (int argi = 1; argi < argc; ++argi)
485 pimpl_->files_to_load_.push_back(os::utf8_argv(argi));
487 if (!use_gui && pimpl_->files_to_load_.empty()) {
488 lyxerr << to_utf8(_("Missing filename for this operation.")) << endl;
493 pimpl_->files_to_load_.push_back(
494 i18nLibFileSearch("examples", "splash.lyx").absFileName());
501 int LyX::execWithoutGui(int & argc, char * argv[])
503 int exit_status = init(argc, argv);
509 // Used to keep track of which buffers were explicitly loaded by user request.
510 // This is necessary because master and child document buffers are loaded, even
511 // if they were not named on the command line. We do not want to dispatch to
513 vector<Buffer *> command_line_buffers;
515 // Load the files specified on the command line
516 vector<string>::const_iterator it = pimpl_->files_to_load_.begin();
517 vector<string>::const_iterator end = pimpl_->files_to_load_.end();
518 for (; it != end; ++it) {
519 // get absolute path of file and add ".lyx" to the filename if necessary
520 FileName fname = fileSearch(string(), os::internal_path(*it), "lyx",
526 Buffer * buf = pimpl_->buffer_list_.newBuffer(fname.absFileName());
527 LYXERR(Debug::FILES, "Loading " << fname);
528 if (buf && buf->loadLyXFile() == Buffer::ReadSuccess) {
529 ErrorList const & el = buf->errorList("Parse");
530 for(ErrorItem const & e : el)
532 command_line_buffers.push_back(buf);
535 pimpl_->buffer_list_.release(buf);
536 docstring const error_message =
537 bformat(_("LyX failed to load the following file: %1$s"),
538 from_utf8(fname.absFileName()));
539 lyxerr << to_utf8(error_message) << endl;
540 exit_status = 1; // failed
544 if (exit_status || pimpl_->batch_commands.empty() || pimpl_->buffer_list_.empty()) {
549 // Iterate through the buffers that were specified on the command line
550 bool final_success = false;
551 vector<Buffer *>::iterator buf_it = command_line_buffers.begin();
552 for (; buf_it != command_line_buffers.end(); ++buf_it) {
553 Buffer * buf = *buf_it;
554 vector<string>::const_iterator bcit = pimpl_->batch_commands.begin();
555 vector<string>::const_iterator bcend = pimpl_->batch_commands.end();
557 for (; bcit != bcend; ++bcit) {
558 LYXERR(Debug::ACTION, "Buffer::dispatch: cmd: " << *bcit);
559 buf->dispatch(*bcit, dr);
560 final_success |= !dr.error();
564 return !final_success;
568 void execBatchCommands()
571 singleton_->execCommands();
575 void LyX::execCommands()
577 // The advantage of doing this here is that the event loop
578 // is already started. So any need for interaction will be
581 // if reconfiguration is needed.
582 if (LayoutFileList::get().empty()) {
583 switch (Alert::prompt(
584 _("No textclass is found"),
585 _("LyX will only have minimal functionality because no textclasses "
586 "have been found. You can either try to reconfigure LyX normally, "
587 "try to reconfigure without checking your LaTeX installation, or continue."),
594 // regular reconfigure
595 lyx::dispatch(FuncRequest(LFUN_RECONFIGURE, ""));
598 // reconfigure --without-latex-config
599 lyx::dispatch(FuncRequest(LFUN_RECONFIGURE,
600 " --without-latex-config"));
607 // create the first main window
608 lyx::dispatch(FuncRequest(LFUN_WINDOW_NEW, geometryArg));
610 if (!pimpl_->files_to_load_.empty()) {
611 // if some files were specified at command-line we assume that the
612 // user wants to edit *these* files and not to restore the session.
613 for (size_t i = 0; i != pimpl_->files_to_load_.size(); ++i) {
615 FuncRequest(LFUN_FILE_OPEN, pimpl_->files_to_load_[i]));
617 // clear this list to save a few bytes of RAM
618 pimpl_->files_to_load_.clear();
620 pimpl_->application_->restoreGuiSession();
622 // Execute batch commands if available
623 if (pimpl_->batch_commands.empty())
626 vector<string>::const_iterator bcit = pimpl_->batch_commands.begin();
627 vector<string>::const_iterator bcend = pimpl_->batch_commands.end();
628 for (; bcit != bcend; ++bcit) {
629 LYXERR(Debug::INIT, "About to handle -x '" << *bcit << '\'');
630 lyx::dispatch(lyxaction.lookupFunc(*bcit));
638 The SIGHUP signal does not exist on Windows and does not need to be handled.
640 Windows handles SIGFPE and SIGSEGV signals as expected.
642 Ctrl+C interrupts (mapped to SIGINT by Windows' POSIX compatability layer)
643 cause a new thread to be spawned. This may well result in unexpected
644 behaviour by the single-threaded LyX.
646 SIGTERM signals will come only from another process actually sending
647 that signal using 'raise' in Windows' POSIX compatability layer. It will
648 not come from the general "terminate process" methods that everyone
649 actually uses (and which can't be trapped). Killing an app 'politely' on
650 Windows involves first sending a WM_CLOSE message, something that is
651 caught already by the Qt frontend.
653 For more information see:
655 http://aspn.activestate.com/ASPN/Mail/Message/ActiveTcl/2034055
656 ...signals are mostly useless on Windows for a variety of reasons that are
659 'UNIX Application Migration Guide, Chapter 9'
660 http://msdn.microsoft.com/library/en-us/dnucmg/html/UCMGch09.asp
662 'How To Terminate an Application "Cleanly" in Win32'
663 http://support.microsoft.com/default.aspx?scid=kb;en-us;178893
667 static void error_handler(int err_sig)
669 // Throw away any signals other than the first one received.
670 static sig_atomic_t handling_error = false;
673 handling_error = true;
675 // We have received a signal indicating a fatal error, so
676 // try and save the data ASAP.
679 // These lyxerr calls may or may not work:
681 // Signals are asynchronous, so the main program may be in a very
682 // fragile state when a signal is processed and thus while a signal
683 // handler function executes.
684 // In general, therefore, we should avoid performing any
685 // I/O operations or calling most library and system functions from
688 // This shouldn't matter here, however, as we've already invoked
694 msg = _("SIGHUP signal caught!\nBye.");
698 msg = _("SIGFPE signal caught!\nBye.");
701 msg = _("SIGSEGV signal caught!\n"
702 "Sorry, you have found a bug in LyX, "
703 "hope you have not lost any data.\n"
704 "Please read the bug-reporting instructions "
705 "in 'Help->Introduction' and send us a bug report, "
706 "if necessary. Thanks!\nBye.");
715 lyxerr << "\nlyx: " << msg << endl;
716 // try to make a GUI message
717 Alert::error(_("LyX crashed!"), msg, true);
720 // Deinstall the signal handlers
722 signal(SIGHUP, SIG_DFL);
724 signal(SIGINT, SIG_DFL);
725 signal(SIGFPE, SIG_DFL);
726 signal(SIGSEGV, SIG_DFL);
727 signal(SIGTERM, SIG_DFL);
730 if (err_sig == SIGSEGV ||
731 (err_sig != SIGHUP && !getEnv("LYXDEBUG").empty())) {
733 if (err_sig == SIGSEGV || !getEnv("LYXDEBUG").empty()) {
736 // with abort() it crashes again.
749 void LyX::printError(ErrorItem const & ei)
751 docstring tmp = _("LyX: ") + ei.error + char_type(':')
753 cerr << to_utf8(tmp) << endl;
756 #if defined (USE_MACOSX_PACKAGING)
758 // Unexposed--extract an environment variable name from its NAME=VALUE
760 std::string varname(const char* line)
762 size_t nameLen = strcspn(line, "=");
763 if (nameLen == strlen(line)) {
764 return std::string();
766 return std::string(line, nameLen);
771 void cleanDuplicateEnvVars()
773 std::set<std::string> seen;
774 std::set<std::string> dupes;
776 // Create a list of the environment variables that appear more than once
777 for (char **read = *_NSGetEnviron(); *read; read++) {
778 std::string name = varname(*read);
779 if (name.size() == 0) {
782 if (seen.find(name) != seen.end()) {
789 // Loop over the list of duplicated variables
790 std::set<std::string>::iterator dupe = dupes.begin();
791 std::set<std::string>::iterator const dend = dupes.end();
792 for (; dupe != dend; ++dupe) {
793 const char *name = (*dupe).c_str();
794 char *val = getenv(name);
796 LYXERR(Debug::INIT, "Duplicate environment variable: " << name);
797 // unsetenv removes *all* instances of the variable from the environment
800 // replace with the value from getenv (in practice appears to be the
801 // first value in the list)
802 setenv(name, val, 0);
809 static void initTemplatePath()
811 FileName const package_template_path =
812 FileName(addName(package().system_support().absFileName(), "templates"));
814 if (lyxrc.template_path.empty()) {
815 lyxrc.template_path = package_template_path.absFileName();
817 #if defined (USE_MACOSX_PACKAGING)
818 FileName const user_template_path =
819 FileName(addName(package().user_support().absFileName(), "templates"));
821 if (package_template_path != FileName(lyxrc.template_path) &&
822 user_template_path != FileName(lyxrc.template_path))
826 FileName const user_template_link =
827 FileName(addName(user_template_path.absFileName(),"SystemTemplates"));
828 if (user_template_link.isSymLink() && !equivalent(user_template_link, package_template_path)) {
829 user_template_link.removeFile();
831 if (!user_template_link.exists()) {
832 if (!package_template_path.link(user_template_link)) {
833 FileName const user_support = package().user_support();
834 if (user_support.exists() && user_support.isDirectory()) {
835 LYXERR(Debug::INIT, "Cannot create symlink " + user_template_link.absFileName());
836 lyxrc.template_path = package_template_path.absFileName();
840 LYXERR(Debug::INIT, "Symlink \"" << user_template_link.absFileName() << "\" created.");
842 lyxrc.template_path = user_template_path.absFileName();
850 signal(SIGHUP, error_handler);
852 signal(SIGFPE, error_handler);
853 signal(SIGSEGV, error_handler);
854 signal(SIGINT, error_handler);
855 signal(SIGTERM, error_handler);
856 // SIGPIPE can be safely ignored.
858 #if defined (USE_MACOSX_PACKAGING)
859 cleanDuplicateEnvVars();
862 lyxrc.tempdir_path = package().temp_dir().absFileName();
863 lyxrc.document_path = ".";
865 if (lyxrc.example_path.empty()) {
866 lyxrc.example_path = addPath(package().system_support().absFileName(),
871 // init LyXDir environment variable
872 string const lyx_dir = package().lyx_dir().absFileName();
873 LYXERR(Debug::INIT, "Setting LyXDir... to \"" << lyx_dir << "\"");
874 if (!setEnv("LyXDir", lyx_dir))
875 LYXERR(Debug::INIT, "\t... failed!");
877 if (package().explicit_user_support() && getEnv(LYX_USERDIR_VER).empty()) {
878 // -userdir was given on the command line.
879 // Make it available to child processes, otherwise tex2lyx
880 // would not find all layout files, and other converters might
882 string const user_dir = package().user_support().absFileName();
883 LYXERR(Debug::INIT, "Setting " LYX_USERDIR_VER "... to \""
885 if (!setEnv(LYX_USERDIR_VER, user_dir))
886 LYXERR(Debug::INIT, "\t... failed!");
890 // Read configuration files
893 // This one may have been distributed along with LyX.
894 if (!readRcFile("lyxrc.dist"))
897 // Set the PATH correctly.
898 #if !defined (USE_POSIX_PACKAGING) && !defined (USE_HAIKU_PACKAGING)
899 // Add the directory containing the LyX executable to the path
900 // so that LyX can find things like tex2lyx.
901 if (package().build_support().empty())
902 prependEnvPath("PATH", package().binary_dir().absFileName());
904 if (!lyxrc.path_prefix.empty())
905 prependEnvPath("PATH", replaceEnvironmentPath(lyxrc.path_prefix));
907 // Check that user LyX directory is ok.
909 string const lock_file = package().getConfigureLockName();
910 int fd = fileLock(lock_file.c_str());
912 if (queryUserLyXDir(package().explicit_user_support())) {
913 package().reconfigureUserLyXDir("");
914 // Now the user directory is present on first start.
917 fileUnlock(fd, lock_file.c_str());
921 // No need for a splash when there is no GUI
923 // Default is to overwrite the main file during export, unless
924 // the -f switch was specified or LYX_FORCE_OVERWRITE was set
925 if (force_overwrite == UNSPECIFIED) {
926 string const what = getEnv("LYX_FORCE_OVERWRITE");
928 force_overwrite = ALL_FILES;
929 else if (what == "none")
930 force_overwrite = NO_FILES;
932 force_overwrite = MAIN_FILE;
936 // This one is generated in user_support directory by lib/configure.py.
937 if (!readRcFile("lyxrc.defaults"))
940 // Query the OS to know what formats are viewed natively
941 formats.setAutoOpen();
943 // Read lyxrc.dist again to be able to override viewer auto-detection.
944 readRcFile("lyxrc.dist");
946 system_lyxrc = lyxrc;
947 system_formats = formats;
948 pimpl_->system_converters_ = pimpl_->converters_;
949 pimpl_->system_movers_ = pimpl_->movers_;
950 system_lcolor = lcolor;
952 // This one is edited through the preferences dialog.
953 if (!readRcFile("preferences", true))
956 // The language may have been set to someting useful through prefs
959 if (!readEncodingsFile("encodings", "unicodesymbols"))
961 if (!readLanguagesFile("languages"))
964 LYXERR(Debug::INIT, "Reading layouts...");
966 LayoutFileList::get().read();
968 theModuleList.read();
969 //... and the cite engines
970 theCiteEnginesList.read();
972 // read keymap and ui files in batch mode as well
973 // because InsetInfo needs to know these to produce
974 // the correct output
976 // Set up command definitions
977 pimpl_->toplevel_cmddef_.read(lyxrc.def_file);
981 pimpl_->toplevel_keymap_.read("site");
982 pimpl_->toplevel_keymap_.read(lyxrc.bind_file);
983 // load user bind file user.bind
984 pimpl_->toplevel_keymap_.read("user", 0, KeyMap::MissingOK);
986 if (lyxerr.debugging(Debug::LYXRC))
989 os::windows_style_tex_paths(lyxrc.windows_style_tex_paths);
990 // Prepend path prefix a second time to take the user preferences into a account
991 if (!lyxrc.path_prefix.empty())
992 prependEnvPath("PATH", replaceEnvironmentPath(lyxrc.path_prefix));
994 FileName const document_path(lyxrc.document_path);
995 if (document_path.exists() && document_path.isDirectory())
996 package().document_dir() = document_path;
998 package().set_temp_dir(createLyXTmpDir(FileName(lyxrc.tempdir_path)));
999 if (package().temp_dir().empty()) {
1000 Alert::error(_("Could not create temporary directory"),
1001 bformat(_("Could not create a temporary directory in\n"
1003 "Make sure that this path exists and is writable and try again."),
1004 from_utf8(lyxrc.tempdir_path)));
1005 // createLyXTmpDir() tries sufficiently hard to create a
1006 // usable temp dir, so the probability to come here is
1007 // close to zero. We therefore don't try to overcome this
1008 // problem with e.g. asking the user for a new path and
1009 // trying again but simply exit.
1013 LYXERR(Debug::INIT, "LyX tmp dir: `"
1014 << package().temp_dir().absFileName() << '\'');
1016 LYXERR(Debug::INIT, "Reading session information '.lyx/session'...");
1017 pimpl_->session_.reset(new Session(lyxrc.num_lastfiles));
1019 // This must happen after package initialization and after lyxrc is
1020 // read, therefore it can't be done by a static object.
1021 ConverterCache::init();
1027 void emergencyCleanup()
1029 // what to do about tmpfiles is non-obvious. we would
1030 // like to delete any we find, but our lyxdir might
1031 // contain documents etc. which might be helpful on
1034 singleton_->pimpl_->buffer_list_.emergencyWriteAll();
1036 if (singleton_->pimpl_->lyx_server_)
1037 singleton_->pimpl_->lyx_server_->emergencyCleanup();
1038 singleton_->pimpl_->lyx_server_.reset();
1039 singleton_->pimpl_->lyx_socket_.reset();
1044 bool LyX::queryUserLyXDir(bool explicit_userdir)
1046 // Does user directory exist?
1047 FileName const sup = package().user_support();
1048 if (sup.exists() && sup.isDirectory()) {
1049 first_start = false;
1051 return configFileNeedsUpdate("lyxrc.defaults")
1052 || configFileNeedsUpdate("lyxmodules.lst")
1053 || configFileNeedsUpdate("textclass.lst")
1054 || configFileNeedsUpdate("packages.lst")
1055 || configFileNeedsUpdate("lyxciteengines.lst");
1058 first_start = !explicit_userdir;
1060 // If the user specified explicitly a directory, ask whether
1061 // to create it. If the user says "no", then exit.
1062 if (explicit_userdir &&
1064 _("Missing user LyX directory"),
1065 bformat(_("You have specified a non-existent user "
1066 "LyX directory, %1$s.\n"
1067 "It is needed to keep your own configuration."),
1068 from_utf8(package().user_support().absFileName())),
1070 _("&Create directory"),
1072 lyxerr << to_utf8(_("No user LyX directory. Exiting.")) << endl;
1073 earlyExit(EXIT_FAILURE);
1076 lyxerr << to_utf8(bformat(_("LyX: Creating directory %1$s"),
1077 from_utf8(sup.absFileName()))) << endl;
1079 if (!sup.createDirectory(0755)) {
1080 // Failed, so let's exit.
1081 lyxerr << to_utf8(_("Failed to create directory. Exiting."))
1083 earlyExit(EXIT_FAILURE);
1090 bool LyX::readRcFile(string const & name, bool check_format)
1092 LYXERR(Debug::INIT, "About to read " << name << "... ");
1094 FileName const lyxrc_path = libFileSearch(string(), name);
1095 if (lyxrc_path.empty()) {
1096 LYXERR(Debug::INIT, "Not found." << lyxrc_path);
1098 // This was the previous logic, but can it be right??
1101 LYXERR(Debug::INIT, "Found in " << lyxrc_path);
1102 bool const success = lyxrc.read(lyxrc_path, check_format);
1104 showFileError(name);
1108 // Read the languages file `name'
1109 bool LyX::readLanguagesFile(string const & name)
1111 LYXERR(Debug::INIT, "About to read " << name << "...");
1113 FileName const lang_path = libFileSearch(string(), name);
1114 if (lang_path.empty()) {
1115 showFileError(name);
1118 languages.read(lang_path);
1123 // Read the encodings file `name'
1124 bool LyX::readEncodingsFile(string const & enc_name,
1125 string const & symbols_name)
1127 LYXERR(Debug::INIT, "About to read " << enc_name << " and "
1128 << symbols_name << "...");
1130 FileName const symbols_path = libFileSearch(string(), symbols_name);
1131 if (symbols_path.empty()) {
1132 showFileError(symbols_name);
1136 FileName const enc_path = libFileSearch(string(), enc_name);
1137 if (enc_path.empty()) {
1138 showFileError(enc_name);
1141 encodings.read(enc_path, symbols_path);
1148 /// return the the number of arguments consumed
1149 typedef function<int(string const &, string const &, string &)> cmd_helper;
1151 int parse_dbg(string const & arg, string const &, string &)
1154 cout << to_utf8(_("List of supported debug flags:")) << endl;
1155 Debug::showTags(cout);
1158 lyxerr << to_utf8(bformat(_("Setting debug level to %1$s"), from_utf8(arg))) << endl;
1160 lyxerr.setLevel(Debug::value(arg));
1161 Debug::showLevel(lyxerr, lyxerr.level());
1166 int parse_help(string const &, string const &, string &)
1169 to_utf8(_("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
1170 "Command line switches (case sensitive):\n"
1171 "\t-help summarize LyX usage\n"
1172 "\t-userdir dir set user directory to dir\n"
1173 "\t-sysdir dir set system directory to dir\n"
1174 "\t-geometry WxH+X+Y set geometry of the main window\n"
1175 "\t-dbg feature[,feature]...\n"
1176 " select the features to debug.\n"
1177 " Type `lyx -dbg' to see the list of features\n"
1178 "\t-x [--execute] command\n"
1179 " where command is a lyx command.\n"
1180 "\t-e [--export] fmt\n"
1181 " where fmt is the export format of choice. Look in\n"
1182 " Tools->Preferences->File Handling->File Formats->Short Name\n"
1183 " to see which parameter (which differs from the format name\n"
1184 " in the File->Export menu) should be passed. To export to\n"
1185 " the document's default output format, use 'default'.\n"
1186 " Note that the order of -e and -x switches matters.\n"
1187 "\t-E [--export-to] fmt filename\n"
1188 " where fmt is the export format of choice (see --export),\n"
1189 " and filename is the destination filename.\n"
1190 "\t-i [--import] fmt file.xxx\n"
1191 " where fmt is the import format of choice\n"
1192 " and file.xxx is the file to be imported.\n"
1193 "\t-f [--force-overwrite] what\n"
1194 " where what is either `all', `main' or `none',\n"
1195 " specifying whether all files, main file only, or no files,\n"
1196 " respectively, are to be overwritten during a batch export.\n"
1197 " Anything else is equivalent to `all', but is not consumed.\n"
1198 "\t--ignore-error-message which\n"
1199 " allows you to ignore specific LaTeX error messages.\n"
1200 " Do not use for final documents! Currently supported values:\n"
1201 " * missing_glyphs: Fontspec `missing glyphs' error.\n"
1202 "\t-n [--no-remote]\n"
1203 " open documents in a new instance\n"
1205 " open documents in an already running instance\n"
1206 " (a working lyxpipe is needed)\n"
1207 "\t-v [--verbose]\n"
1208 " report on terminal about spawned commands.\n"
1209 "\t-batch execute commands without launching GUI and exit.\n"
1210 "\t-version summarize version and build info\n"
1211 "Check the LyX man page for more details.")) << endl;
1217 int parse_version(string const &, string const &, string &)
1219 cout << "LyX " << lyx_version
1220 << " (" << lyx_release_date << ")" << endl;
1221 if (string(lyx_git_commit_hash) != "none")
1222 cout << to_utf8(_(" Git commit hash "))
1223 << string(lyx_git_commit_hash).substr(0,8) << endl;
1224 cout << lyx_version_info << endl;
1230 int parse_sysdir(string const & arg, string const &, string &)
1233 Alert::error(_("No system directory"),
1234 _("Missing directory for -sysdir switch"));
1237 cl_system_support = arg;
1242 int parse_userdir(string const & arg, string const &, string &)
1245 Alert::error(_("No user directory"),
1246 _("Missing directory for -userdir switch"));
1249 cl_user_support = arg;
1254 int parse_execute(string const & arg, string const &, string & batch)
1257 Alert::error(_("Incomplete command"),
1258 _("Missing command string after --execute switch"));
1266 int parse_export_to(string const & type, string const & output_file, string & batch)
1269 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1270 "--export-to switch")) << endl;
1273 if (output_file.empty()) {
1274 lyxerr << to_utf8(_("Missing destination filename after "
1275 "--export-to switch")) << endl;
1278 batch = "buffer-export " + type + " " + output_file;
1284 int parse_export(string const & type, string const &, string & batch)
1287 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1288 "--export switch")) << endl;
1291 batch = "buffer-export " + type;
1297 int parse_import(string const & type, string const & file, string & batch)
1300 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1301 "--import switch")) << endl;
1305 lyxerr << to_utf8(_("Missing filename for --import")) << endl;
1308 batch = "buffer-import " + type + ' ' + file;
1313 int parse_geometry(string const & arg1, string const &, string &)
1316 // don't remove "-geometry", it will be pruned out later in the
1317 // frontend if need be.
1322 int parse_batch(string const &, string const &, string &)
1329 int parse_noremote(string const &, string const &, string &)
1331 run_mode = NEW_INSTANCE;
1336 int parse_remote(string const &, string const &, string &)
1338 run_mode = USE_REMOTE;
1343 int parse_verbose(string const &, string const &, string &)
1350 int parse_ignore_error_message(string const & arg1, string const &, string &)
1352 if (arg1 == "missing_glyphs") {
1353 ignore_missing_glyphs = true;
1360 int parse_force(string const & arg, string const &, string &)
1363 force_overwrite = ALL_FILES;
1365 } else if (arg == "main") {
1366 force_overwrite = MAIN_FILE;
1368 } else if (arg == "none") {
1369 force_overwrite = NO_FILES;
1372 force_overwrite = ALL_FILES;
1380 void LyX::easyParse(int & argc, char * argv[])
1382 map<string, cmd_helper> cmdmap;
1384 cmdmap["-dbg"] = parse_dbg;
1385 cmdmap["-help"] = parse_help;
1386 cmdmap["--help"] = parse_help;
1387 cmdmap["-version"] = parse_version;
1388 cmdmap["--version"] = parse_version;
1389 cmdmap["-sysdir"] = parse_sysdir;
1390 cmdmap["-userdir"] = parse_userdir;
1391 cmdmap["-x"] = parse_execute;
1392 cmdmap["--execute"] = parse_execute;
1393 cmdmap["-e"] = parse_export;
1394 cmdmap["--export"] = parse_export;
1395 cmdmap["-E"] = parse_export_to;
1396 cmdmap["--export-to"] = parse_export_to;
1397 cmdmap["-i"] = parse_import;
1398 cmdmap["--import"] = parse_import;
1399 cmdmap["-geometry"] = parse_geometry;
1400 cmdmap["-batch"] = parse_batch;
1401 cmdmap["-f"] = parse_force;
1402 cmdmap["--force-overwrite"] = parse_force;
1403 cmdmap["-n"] = parse_noremote;
1404 cmdmap["--no-remote"] = parse_noremote;
1405 cmdmap["-r"] = parse_remote;
1406 cmdmap["--remote"] = parse_remote;
1407 cmdmap["-v"] = parse_verbose;
1408 cmdmap["--verbose"] = parse_verbose;
1409 cmdmap["--ignore-error-message"] = parse_ignore_error_message;
1411 for (int i = 1; i < argc; ++i) {
1412 map<string, cmd_helper>::const_iterator it
1413 = cmdmap.find(argv[i]);
1415 // don't complain if not found - may be parsed later
1416 if (it == cmdmap.end())
1420 (i + 1 < argc) ? os::utf8_argv(i + 1) : string();
1422 (i + 2 < argc) ? os::utf8_argv(i + 2) : string();
1425 int const remove = 1 + it->second(arg, arg2, batch);
1427 pimpl_->batch_commands.push_back(batch);
1429 // Now, remove used arguments by shifting
1430 // the following ones remove places down.
1432 os::remove_internal_args(i, remove);
1434 for (int j = i; j < argc; ++j)
1435 argv[j] = argv[j + remove];
1442 FuncStatus getStatus(FuncRequest const & action)
1445 return theApp()->getStatus(action);
1449 DispatchResult const & dispatch(FuncRequest const & action)
1452 return theApp()->dispatch(action);
1456 void dispatch(FuncRequest const & action, DispatchResult & dr)
1459 theApp()->dispatch(action, dr);
1463 vector<string> & theFilesToLoad()
1465 LAPPERR(singleton_);
1466 return singleton_->pimpl_->files_to_load_;
1470 BufferList & theBufferList()
1472 LAPPERR(singleton_);
1473 return singleton_->pimpl_->buffer_list_;
1477 Server & theServer()
1479 // FIXME: this should not be use_gui dependent
1481 LAPPERR(singleton_);
1482 return *singleton_->pimpl_->lyx_server_;
1486 ServerSocket & theServerSocket()
1488 // FIXME: this should not be use_gui dependent
1490 LAPPERR(singleton_);
1491 return *singleton_->pimpl_->lyx_socket_;
1495 KeyMap & theTopLevelKeymap()
1497 LAPPERR(singleton_);
1498 return singleton_->pimpl_->toplevel_keymap_;
1502 Converters & theConverters()
1504 LAPPERR(singleton_);
1505 return singleton_->pimpl_->converters_;
1509 Converters & theSystemConverters()
1511 LAPPERR(singleton_);
1512 return singleton_->pimpl_->system_converters_;
1516 Movers & theMovers()
1518 LAPPERR(singleton_);
1519 return singleton_->pimpl_->movers_;
1523 Mover const & getMover(string const & fmt)
1525 LAPPERR(singleton_);
1526 return singleton_->pimpl_->movers_(fmt);
1530 void setMover(string const & fmt, string const & command)
1532 LAPPERR(singleton_);
1533 singleton_->pimpl_->movers_.set(fmt, command);
1537 Movers & theSystemMovers()
1539 LAPPERR(singleton_);
1540 return singleton_->pimpl_->system_movers_;
1544 Messages const & getMessages(string const & language)
1546 LAPPERR(singleton_);
1547 return singleton_->messages(language);
1551 Messages const & getGuiMessages()
1553 LAPPERR(singleton_);
1554 return singleton_->messages(Messages::guiLanguage());
1558 Session & theSession()
1560 LAPPERR(singleton_);
1561 return *singleton_->pimpl_->session_.get();
1565 LaTeXFonts & theLaTeXFonts()
1567 LAPPERR(singleton_);
1568 if (!singleton_->pimpl_->latexfonts_)
1569 singleton_->pimpl_->latexfonts_ = new LaTeXFonts;
1570 return *singleton_->pimpl_->latexfonts_;
1574 CmdDef & theTopLevelCmdDef()
1576 LAPPERR(singleton_);
1577 return singleton_->pimpl_->toplevel_cmddef_;
1581 SpellChecker * theSpellChecker()
1583 if (!singleton_->pimpl_->spell_checker_)
1585 return singleton_->pimpl_->spell_checker_;
1589 void setSpellChecker()
1591 SpellChecker::ChangeNumber speller_change_number =singleton_->pimpl_->spell_checker_ ?
1592 singleton_->pimpl_->spell_checker_->changeNumber() : 0;
1594 if (lyxrc.spellchecker == "native") {
1595 #if defined(USE_MACOSX_PACKAGING)
1596 if (!singleton_->pimpl_->apple_spell_checker_)
1597 singleton_->pimpl_->apple_spell_checker_ = new AppleSpellChecker;
1598 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->apple_spell_checker_;
1600 singleton_->pimpl_->spell_checker_ = 0;
1602 } else if (lyxrc.spellchecker == "aspell") {
1603 #if defined(USE_ASPELL)
1604 if (!singleton_->pimpl_->aspell_checker_)
1605 singleton_->pimpl_->aspell_checker_ = new AspellChecker;
1606 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->aspell_checker_;
1608 singleton_->pimpl_->spell_checker_ = 0;
1610 } else if (lyxrc.spellchecker == "enchant") {
1611 #if defined(USE_ENCHANT)
1612 if (!singleton_->pimpl_->enchant_checker_)
1613 singleton_->pimpl_->enchant_checker_ = new EnchantChecker;
1614 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->enchant_checker_;
1616 singleton_->pimpl_->spell_checker_ = 0;
1618 } else if (lyxrc.spellchecker == "hunspell") {
1619 #if defined(USE_HUNSPELL)
1620 if (!singleton_->pimpl_->hunspell_checker_)
1621 singleton_->pimpl_->hunspell_checker_ = new HunspellChecker;
1622 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->hunspell_checker_;
1624 singleton_->pimpl_->spell_checker_ = 0;
1627 singleton_->pimpl_->spell_checker_ = 0;
1629 if (singleton_->pimpl_->spell_checker_) {
1630 singleton_->pimpl_->spell_checker_->changeNumber(speller_change_number);
1631 singleton_->pimpl_->spell_checker_->advanceChangeNumber();