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"
26 #include "ConverterCache.h"
27 #include "Converter.h"
28 #include "CutAndPaste.h"
29 #include "EnchantChecker.h"
31 #include "ErrorList.h"
33 #include "FuncStatus.h"
34 #include "HunspellChecker.h"
37 #include "LaTeXFonts.h"
38 #include "LayoutFile.h"
41 #include "LyXAction.h"
43 #include "ModuleList.h"
46 #include "ServerSocket.h"
50 #include "frontends/alert.h"
51 #include "frontends/Application.h"
53 #include "support/ConsoleApplication.h"
54 #include "support/lassert.h"
55 #include "support/debug.h"
56 #include "support/environment.h"
57 #include "support/ExceptionMessage.h"
58 #include "support/filetools.h"
59 #include "support/gettext.h"
60 #include "support/lstrings.h"
61 #include "support/Messages.h"
62 #include "support/os.h"
63 #include "support/Package.h"
64 #include "support/unique_ptr.h"
76 using namespace lyx::support;
78 #if defined (USE_MACOSX_PACKAGING)
79 #include <crt_externs.h>
84 namespace Alert = frontend::Alert;
85 namespace os = support::os;
89 // Are we using the GUI at all? We default to true and this is changed
90 // to false when the export feature is used.
95 // Report on the terminal about spawned commands. The default is false
96 // and can be changed with the option -v (--verbose).
101 // We default to open documents in an already running instance, provided that
102 // the lyxpipe has been setup. This can be overridden either on the command
103 // line or through preference settings.
105 RunMode run_mode = PREFERRED;
108 // Tell what files can be silently overwritten during batch export.
109 // Possible values are: NO_FILES, MAIN_FILE, ALL_FILES, UNSPECIFIED.
110 // Unless specified on command line (through the -f switch) or through the
111 // environment variable LYX_FORCE_OVERWRITE, the default will be MAIN_FILE.
113 OverwriteFiles force_overwrite = UNSPECIFIED;
118 // Filled with the command line arguments "foo" of "-sysdir foo" or
120 string cl_system_support;
121 string cl_user_support;
125 LyX * singleton_ = 0;
127 void showFileError(string const & error)
129 Alert::warning(_("Could not read configuration file"),
130 bformat(_("Error while reading the configuration file\n%1$s.\n"
131 "Please check your installation."), from_utf8(error)));
136 /// The main application class private implementation.
139 : latexfonts_(0), spell_checker_(0), apple_spell_checker_(0), aspell_checker_(0), enchant_checker_(0), hunspell_checker_(0)
145 delete apple_spell_checker_;
146 delete aspell_checker_;
147 delete enchant_checker_;
148 delete hunspell_checker_;
152 BufferList buffer_list_;
154 KeyMap toplevel_keymap_;
156 CmdDef toplevel_cmddef_;
158 unique_ptr<Server> lyx_server_;
160 unique_ptr<ServerSocket> lyx_socket_;
162 unique_ptr<frontend::Application> application_;
163 /// lyx session, containing lastfiles, lastfilepos, and lastopened
164 unique_ptr<Session> session_;
166 /// Files to load at start.
167 vector<string> files_to_load_;
169 /// The messages translators.
170 map<string, Messages> messages_;
172 /// The file converters.
173 Converters converters_;
175 // The system converters copy after reading lyxrc.defaults.
176 Converters system_converters_;
181 Movers system_movers_;
183 /// the parsed command line batch command if any
184 vector<string> batch_commands;
187 LaTeXFonts * latexfonts_;
190 SpellChecker * spell_checker_;
192 SpellChecker * apple_spell_checker_;
194 SpellChecker * aspell_checker_;
196 SpellChecker * enchant_checker_;
198 SpellChecker * hunspell_checker_;
202 /// The main application class for console mode
203 class LyXConsoleApp : public ConsoleApplication
206 LyXConsoleApp(LyX * lyx, int & argc, char * argv[])
207 : ConsoleApplication(lyx_package, argc, argv), lyx_(lyx),
208 argc_(argc), argv_(argv)
213 int const exit_status = lyx_->execWithoutGui(argc_, argv_);
224 frontend::Application * theApp()
227 return singleton_->pimpl_->application_.get();
240 void lyx_exit(int exit_code)
243 // Something wrong happened so better save everything, just in
248 // Properly crash in debug mode in order to get a useful backtrace.
252 // In release mode, try to exit gracefully.
254 theApp()->exit(exit_code);
268 Messages & LyX::messages(string const & language)
270 map<string, Messages>::iterator it = pimpl_->messages_.find(language);
272 if (it != pimpl_->messages_.end())
275 pair<map<string, Messages>::iterator, bool> result =
276 pimpl_->messages_.insert(make_pair(language, Messages(language)));
278 LATTEST(result.second);
279 return result.first->second;
283 int LyX::exec(int & argc, char * argv[])
285 // Minimal setting of locale before parsing command line
287 init_package(os::utf8_argv(0), string(), string());
288 // we do not get to this point when init_package throws an exception
290 } catch (ExceptionMessage const & message) {
291 LYXERR(Debug::LOCALE, message.title_ + ", " + message.details_);
294 // Here we need to parse the command line. At least
295 // we need to parse for "-dbg" and "-help"
296 easyParse(argc, argv);
299 init_package(os::utf8_argv(0), cl_system_support, cl_user_support);
300 } catch (ExceptionMessage const & message) {
301 if (message.type_ == ErrorException) {
302 Alert::error(message.title_, message.details_);
304 } else if (message.type_ == WarningException) {
305 Alert::warning(message.title_, message.details_);
309 // Reinit the messages machinery in case package() knows
310 // something interesting about the locale directory.
314 LyXConsoleApp app(this, argc, argv);
316 // Reestablish our defaults, as Qt overwrites them
317 // after creating app
323 // Let the frontend parse and remove all arguments that it knows
324 pimpl_->application_.reset(createApplication(argc, argv));
326 // Reestablish our defaults, as Qt overwrites them
327 // after createApplication()
330 // Parse and remove all known arguments in the LyX singleton
331 // Give an error for all remaining ones.
332 int exit_status = init(argc, argv);
334 // Kill the application object before exiting.
335 pimpl_->application_.reset();
341 // If not otherwise specified by a command line option or
342 // by preferences, we default to reuse a running instance.
343 if (run_mode == PREFERRED)
344 run_mode = USE_REMOTE;
347 /* Create a CoreApplication class that will provide the main event loop
348 * and the socket callback registering. With Qt, only QtCore
349 * library would be needed.
350 * When this is done, a server_mode could be created and the following two
351 * line would be moved out from here.
352 * However, note that the first of the two lines below triggers the
353 * "single instance" behavior, which should occur right at this point.
355 // Note: socket callback must be registered after init(argc, argv)
356 // such that package().temp_dir() is properly initialized.
357 pimpl_->lyx_server_.reset(new Server(lyxrc.lyxpipes));
358 pimpl_->lyx_socket_.reset(new ServerSocket(
359 FileName(package().temp_dir().absFileName() + "/lyxsocket")));
361 // Start the real execution loop.
362 if (!theServer().deferredLoadingToOtherInstance())
363 exit_status = pimpl_->application_->exec();
364 else if (!pimpl_->files_to_load_.empty()) {
365 vector<string>::const_iterator it = pimpl_->files_to_load_.begin();
366 vector<string>::const_iterator end = pimpl_->files_to_load_.end();
367 lyxerr << _("The following files could not be loaded:") << endl;
368 for (; it != end; ++it)
369 lyxerr << *it << endl;
378 void LyX::prepareExit()
380 // Clear the clipboard and selection stack:
381 cap::clearCutStack();
382 cap::clearSelection();
384 // Write the index file of the converter cache
385 ConverterCache::get().writeIndex();
387 // close buffers first
388 pimpl_->buffer_list_.closeAll();
390 // register session changes and shutdown server and socket
392 if (pimpl_->session_)
393 pimpl_->session_->writeFile();
394 pimpl_->session_.reset();
395 pimpl_->lyx_server_.reset();
396 pimpl_->lyx_socket_.reset();
399 // do any other cleanup procedures now
400 if (package().temp_dir() != package().system_temp_dir()) {
401 string const abs_tmpdir = package().temp_dir().absFileName();
402 if (!contains(package().temp_dir().absFileName(), "lyx_tmpdir")) {
403 docstring const msg =
404 bformat(_("%1$s does not appear like a LyX created temporary directory."),
405 from_utf8(abs_tmpdir));
406 Alert::warning(_("Cannot remove temporary directory"), msg);
408 LYXERR(Debug::INFO, "Deleting tmp dir "
409 << package().temp_dir().absFileName());
410 if (!package().temp_dir().destroyDirectory()) {
411 LYXERR0(bformat(_("Unable to remove the temporary directory %1$s"),
412 from_utf8(package().temp_dir().absFileName())));
417 // Kill the application object before exiting. This avoids crashes
418 // when exiting on Linux.
419 pimpl_->application_.reset();
423 void LyX::earlyExit(int status)
425 LATTEST(pimpl_->application_.get());
426 // LyX::pimpl_::application_ is not initialised at this
427 // point so it's safe to just exit after some cleanup.
433 int LyX::init(int & argc, char * argv[])
435 // check for any spurious extra arguments
436 // other than documents
437 for (int argi = 1; argi < argc ; ++argi) {
438 if (argv[argi][0] == '-') {
440 bformat(_("Wrong command line option `%1$s'. Exiting."),
441 from_utf8(os::utf8_argv(argi)))) << endl;
446 // Initialization of LyX (reads lyxrc and more)
447 LYXERR(Debug::INIT, "Initializing LyX::init...");
448 bool success = init();
449 LYXERR(Debug::INIT, "Initializing LyX::init...done");
453 // Remaining arguments are assumed to be files to load.
454 for (int argi = 1; argi < argc; ++argi)
455 pimpl_->files_to_load_.push_back(os::utf8_argv(argi));
457 if (!use_gui && pimpl_->files_to_load_.empty()) {
458 lyxerr << to_utf8(_("Missing filename for this operation.")) << endl;
463 pimpl_->files_to_load_.push_back(
464 i18nLibFileSearch("examples", "splash.lyx").absFileName());
471 int LyX::execWithoutGui(int & argc, char * argv[])
473 int exit_status = init(argc, argv);
479 // Used to keep track of which buffers were explicitly loaded by user request.
480 // This is necessary because master and child document buffers are loaded, even
481 // if they were not named on the command line. We do not want to dispatch to
483 vector<Buffer *> command_line_buffers;
485 // Load the files specified on the command line
486 vector<string>::const_iterator it = pimpl_->files_to_load_.begin();
487 vector<string>::const_iterator end = pimpl_->files_to_load_.end();
488 for (; it != end; ++it) {
489 // get absolute path of file and add ".lyx" to the filename if necessary
490 FileName fname = fileSearch(string(), os::internal_path(*it), "lyx",
496 Buffer * buf = pimpl_->buffer_list_.newBuffer(fname.absFileName());
497 LYXERR(Debug::FILES, "Loading " << fname);
498 if (buf && buf->loadLyXFile() == Buffer::ReadSuccess) {
499 ErrorList const & el = buf->errorList("Parse");
500 for(ErrorItem const & e : el)
502 command_line_buffers.push_back(buf);
505 pimpl_->buffer_list_.release(buf);
506 docstring const error_message =
507 bformat(_("LyX failed to load the following file: %1$s"),
508 from_utf8(fname.absFileName()));
509 lyxerr << to_utf8(error_message) << endl;
510 exit_status = 1; // failed
514 if (exit_status || pimpl_->batch_commands.empty() || pimpl_->buffer_list_.empty()) {
519 // Iterate through the buffers that were specified on the command line
520 bool final_success = false;
521 vector<Buffer *>::iterator buf_it = command_line_buffers.begin();
522 for (; buf_it != command_line_buffers.end(); ++buf_it) {
523 Buffer * buf = *buf_it;
524 vector<string>::const_iterator bcit = pimpl_->batch_commands.begin();
525 vector<string>::const_iterator bcend = pimpl_->batch_commands.end();
527 for (; bcit != bcend; ++bcit) {
528 LYXERR(Debug::ACTION, "Buffer::dispatch: cmd: " << *bcit);
529 buf->dispatch(*bcit, dr);
530 final_success |= !dr.error();
534 return !final_success;
538 void execBatchCommands()
541 singleton_->execCommands();
545 void LyX::execCommands()
547 // The advantage of doing this here is that the event loop
548 // is already started. So any need for interaction will be
551 // if reconfiguration is needed.
552 if (LayoutFileList::get().empty()) {
553 switch (Alert::prompt(
554 _("No textclass is found"),
555 _("LyX will only have minimal functionality because no textclasses "
556 "have been found. You can either try to reconfigure LyX normally, "
557 "try to reconfigure without checking your LaTeX installation, or continue."),
564 // regular reconfigure
565 lyx::dispatch(FuncRequest(LFUN_RECONFIGURE, ""));
568 // reconfigure --without-latex-config
569 lyx::dispatch(FuncRequest(LFUN_RECONFIGURE,
570 " --without-latex-config"));
577 // create the first main window
578 lyx::dispatch(FuncRequest(LFUN_WINDOW_NEW, geometryArg));
580 if (!pimpl_->files_to_load_.empty()) {
581 // if some files were specified at command-line we assume that the
582 // user wants to edit *these* files and not to restore the session.
583 for (size_t i = 0; i != pimpl_->files_to_load_.size(); ++i) {
585 FuncRequest(LFUN_FILE_OPEN, pimpl_->files_to_load_[i]));
587 // clear this list to save a few bytes of RAM
588 pimpl_->files_to_load_.clear();
590 pimpl_->application_->restoreGuiSession();
592 // Execute batch commands if available
593 if (pimpl_->batch_commands.empty())
596 vector<string>::const_iterator bcit = pimpl_->batch_commands.begin();
597 vector<string>::const_iterator bcend = pimpl_->batch_commands.end();
598 for (; bcit != bcend; ++bcit) {
599 LYXERR(Debug::INIT, "About to handle -x '" << *bcit << '\'');
600 lyx::dispatch(lyxaction.lookupFunc(*bcit));
608 The SIGHUP signal does not exist on Windows and does not need to be handled.
610 Windows handles SIGFPE and SIGSEGV signals as expected.
612 Ctrl+C interrupts (mapped to SIGINT by Windows' POSIX compatability layer)
613 cause a new thread to be spawned. This may well result in unexpected
614 behaviour by the single-threaded LyX.
616 SIGTERM signals will come only from another process actually sending
617 that signal using 'raise' in Windows' POSIX compatability layer. It will
618 not come from the general "terminate process" methods that everyone
619 actually uses (and which can't be trapped). Killing an app 'politely' on
620 Windows involves first sending a WM_CLOSE message, something that is
621 caught already by the Qt frontend.
623 For more information see:
625 http://aspn.activestate.com/ASPN/Mail/Message/ActiveTcl/2034055
626 ...signals are mostly useless on Windows for a variety of reasons that are
629 'UNIX Application Migration Guide, Chapter 9'
630 http://msdn.microsoft.com/library/en-us/dnucmg/html/UCMGch09.asp
632 'How To Terminate an Application "Cleanly" in Win32'
633 http://support.microsoft.com/default.aspx?scid=kb;en-us;178893
637 static void error_handler(int err_sig)
639 // Throw away any signals other than the first one received.
640 static sig_atomic_t handling_error = false;
643 handling_error = true;
645 // We have received a signal indicating a fatal error, so
646 // try and save the data ASAP.
649 // These lyxerr calls may or may not work:
651 // Signals are asynchronous, so the main program may be in a very
652 // fragile state when a signal is processed and thus while a signal
653 // handler function executes.
654 // In general, therefore, we should avoid performing any
655 // I/O operations or calling most library and system functions from
658 // This shouldn't matter here, however, as we've already invoked
664 msg = _("SIGHUP signal caught!\nBye.");
668 msg = _("SIGFPE signal caught!\nBye.");
671 msg = _("SIGSEGV signal caught!\n"
672 "Sorry, you have found a bug in LyX, "
673 "hope you have not lost any data.\n"
674 "Please read the bug-reporting instructions "
675 "in 'Help->Introduction' and send us a bug report, "
676 "if necessary. Thanks!\nBye.");
685 lyxerr << "\nlyx: " << msg << endl;
686 // try to make a GUI message
687 Alert::error(_("LyX crashed!"), msg, true);
690 // Deinstall the signal handlers
692 signal(SIGHUP, SIG_DFL);
694 signal(SIGINT, SIG_DFL);
695 signal(SIGFPE, SIG_DFL);
696 signal(SIGSEGV, SIG_DFL);
697 signal(SIGTERM, SIG_DFL);
700 if (err_sig == SIGSEGV ||
701 (err_sig != SIGHUP && !getEnv("LYXDEBUG").empty())) {
703 if (err_sig == SIGSEGV || !getEnv("LYXDEBUG").empty()) {
706 // with abort() it crashes again.
719 void LyX::printError(ErrorItem const & ei)
721 docstring tmp = _("LyX: ") + ei.error + char_type(':')
723 cerr << to_utf8(tmp) << endl;
726 #if defined (USE_MACOSX_PACKAGING)
728 // Unexposed--extract an environment variable name from its NAME=VALUE
730 std::string varname(const char* line)
732 size_t nameLen = strcspn(line, "=");
733 if (nameLen == strlen(line)) {
734 return std::string();
736 return std::string(line, nameLen);
741 void cleanDuplicateEnvVars()
743 std::set<std::string> seen;
744 std::set<std::string> dupes;
746 // Create a list of the environment variables that appear more than once
747 for (char **read = *_NSGetEnviron(); *read; read++) {
748 std::string name = varname(*read);
749 if (name.size() == 0) {
752 if (seen.find(name) != seen.end()) {
759 // Loop over the list of duplicated variables
760 std::set<std::string>::iterator dupe = dupes.begin();
761 std::set<std::string>::iterator const dend = dupes.end();
762 for (; dupe != dend; ++dupe) {
763 const char *name = (*dupe).c_str();
764 char *val = getenv(name);
766 LYXERR(Debug::INIT, "Duplicate environment variable: " << name);
767 // unsetenv removes *all* instances of the variable from the environment
770 // replace with the value from getenv (in practice appears to be the
771 // first value in the list)
772 setenv(name, val, 0);
779 static void initTemplatePath()
781 FileName const package_template_path =
782 FileName(addName(package().system_support().absFileName(), "templates"));
784 if (lyxrc.template_path.empty()) {
785 lyxrc.template_path = package_template_path.absFileName();
787 #if defined (USE_MACOSX_PACKAGING)
788 FileName const user_template_path =
789 FileName(addName(package().user_support().absFileName(), "templates"));
791 if (package_template_path != FileName(lyxrc.template_path) &&
792 user_template_path != FileName(lyxrc.template_path))
796 FileName const user_template_link =
797 FileName(addName(user_template_path.absFileName(),"SystemTemplates"));
798 if (user_template_link.isSymLink() && !equivalent(user_template_link, package_template_path)) {
799 user_template_link.removeFile();
801 if (!user_template_link.exists()) {
802 if (!package_template_path.link(user_template_link)) {
803 FileName const user_support = package().user_support();
804 if (user_support.exists() && user_support.isDirectory()) {
805 LYXERR(Debug::INIT, "Cannot create symlink " + user_template_link.absFileName());
806 lyxrc.template_path = package_template_path.absFileName();
810 LYXERR(Debug::INIT, "Symlink \"" << user_template_link.absFileName() << "\" created.");
812 lyxrc.template_path = user_template_path.absFileName();
820 signal(SIGHUP, error_handler);
822 signal(SIGFPE, error_handler);
823 signal(SIGSEGV, error_handler);
824 signal(SIGINT, error_handler);
825 signal(SIGTERM, error_handler);
826 // SIGPIPE can be safely ignored.
828 #if defined (USE_MACOSX_PACKAGING)
829 cleanDuplicateEnvVars();
832 lyxrc.tempdir_path = package().temp_dir().absFileName();
833 lyxrc.document_path = ".";
835 if (lyxrc.example_path.empty()) {
836 lyxrc.example_path = addPath(package().system_support().absFileName(),
841 // init LyXDir environment variable
842 string const lyx_dir = package().lyx_dir().absFileName();
843 LYXERR(Debug::INIT, "Setting LyXDir... to \"" << lyx_dir << "\"");
844 if (!setEnv("LyXDir", lyx_dir))
845 LYXERR(Debug::INIT, "\t... failed!");
847 if (package().explicit_user_support() && getEnv(LYX_USERDIR_VER).empty()) {
848 // -userdir was given on the command line.
849 // Make it available to child processes, otherwise tex2lyx
850 // would not find all layout files, and other converters might
852 string const user_dir = package().user_support().absFileName();
853 LYXERR(Debug::INIT, "Setting " LYX_USERDIR_VER "... to \""
855 if (!setEnv(LYX_USERDIR_VER, user_dir))
856 LYXERR(Debug::INIT, "\t... failed!");
860 // Read configuration files
863 // This one may have been distributed along with LyX.
864 if (!readRcFile("lyxrc.dist"))
867 // Set the PATH correctly.
868 #if !defined (USE_POSIX_PACKAGING) && !defined (USE_HAIKU_PACKAGING)
869 // Add the directory containing the LyX executable to the path
870 // so that LyX can find things like tex2lyx.
871 if (package().build_support().empty())
872 prependEnvPath("PATH", package().binary_dir().absFileName());
874 if (!lyxrc.path_prefix.empty())
875 prependEnvPath("PATH", replaceEnvironmentPath(lyxrc.path_prefix));
877 // Check that user LyX directory is ok.
879 string const lock_file = package().getConfigureLockName();
880 int fd = fileLock(lock_file.c_str());
882 if (queryUserLyXDir(package().explicit_user_support())) {
883 package().reconfigureUserLyXDir("");
884 // Now the user directory is present on first start.
887 fileUnlock(fd, lock_file.c_str());
891 // No need for a splash when there is no GUI
893 // Default is to overwrite the main file during export, unless
894 // the -f switch was specified or LYX_FORCE_OVERWRITE was set
895 if (force_overwrite == UNSPECIFIED) {
896 string const what = getEnv("LYX_FORCE_OVERWRITE");
898 force_overwrite = ALL_FILES;
899 else if (what == "none")
900 force_overwrite = NO_FILES;
902 force_overwrite = MAIN_FILE;
906 // This one is generated in user_support directory by lib/configure.py.
907 if (!readRcFile("lyxrc.defaults"))
910 // Query the OS to know what formats are viewed natively
911 formats.setAutoOpen();
913 // Read lyxrc.dist again to be able to override viewer auto-detection.
914 readRcFile("lyxrc.dist");
916 system_lyxrc = lyxrc;
917 system_formats = formats;
918 pimpl_->system_converters_ = pimpl_->converters_;
919 pimpl_->system_movers_ = pimpl_->movers_;
920 system_lcolor = lcolor;
922 // This one is edited through the preferences dialog.
923 if (!readRcFile("preferences", true))
926 // The language may have been set to someting useful through prefs
929 if (!readEncodingsFile("encodings", "unicodesymbols"))
931 if (!readLanguagesFile("languages"))
934 LYXERR(Debug::INIT, "Reading layouts...");
936 LayoutFileList::get().read();
938 theModuleList.read();
940 // read keymap and ui files in batch mode as well
941 // because InsetInfo needs to know these to produce
942 // the correct output
944 // Set up command definitions
945 pimpl_->toplevel_cmddef_.read(lyxrc.def_file);
949 pimpl_->toplevel_keymap_.read("site");
950 pimpl_->toplevel_keymap_.read(lyxrc.bind_file);
951 // load user bind file user.bind
952 pimpl_->toplevel_keymap_.read("user", 0, KeyMap::MissingOK);
954 if (lyxerr.debugging(Debug::LYXRC))
957 os::windows_style_tex_paths(lyxrc.windows_style_tex_paths);
958 // Prepend path prefix a second time to take the user preferences into a account
959 if (!lyxrc.path_prefix.empty())
960 prependEnvPath("PATH", replaceEnvironmentPath(lyxrc.path_prefix));
962 FileName const document_path(lyxrc.document_path);
963 if (document_path.exists() && document_path.isDirectory())
964 package().document_dir() = document_path;
966 package().set_temp_dir(createLyXTmpDir(FileName(lyxrc.tempdir_path)));
967 if (package().temp_dir().empty()) {
968 Alert::error(_("Could not create temporary directory"),
969 bformat(_("Could not create a temporary directory in\n"
971 "Make sure that this path exists and is writable and try again."),
972 from_utf8(lyxrc.tempdir_path)));
973 // createLyXTmpDir() tries sufficiently hard to create a
974 // usable temp dir, so the probability to come here is
975 // close to zero. We therefore don't try to overcome this
976 // problem with e.g. asking the user for a new path and
977 // trying again but simply exit.
981 LYXERR(Debug::INIT, "LyX tmp dir: `"
982 << package().temp_dir().absFileName() << '\'');
984 LYXERR(Debug::INIT, "Reading session information '.lyx/session'...");
985 pimpl_->session_.reset(new Session(lyxrc.num_lastfiles));
987 // This must happen after package initialization and after lyxrc is
988 // read, therefore it can't be done by a static object.
989 ConverterCache::init();
995 void emergencyCleanup()
997 // what to do about tmpfiles is non-obvious. we would
998 // like to delete any we find, but our lyxdir might
999 // contain documents etc. which might be helpful on
1002 singleton_->pimpl_->buffer_list_.emergencyWriteAll();
1004 if (singleton_->pimpl_->lyx_server_)
1005 singleton_->pimpl_->lyx_server_->emergencyCleanup();
1006 singleton_->pimpl_->lyx_server_.reset();
1007 singleton_->pimpl_->lyx_socket_.reset();
1012 bool LyX::queryUserLyXDir(bool explicit_userdir)
1014 // Does user directory exist?
1015 FileName const sup = package().user_support();
1016 if (sup.exists() && sup.isDirectory()) {
1017 first_start = false;
1019 return configFileNeedsUpdate("lyxrc.defaults")
1020 || configFileNeedsUpdate("lyxmodules.lst")
1021 || configFileNeedsUpdate("textclass.lst")
1022 || configFileNeedsUpdate("packages.lst");
1025 first_start = !explicit_userdir;
1027 // If the user specified explicitly a directory, ask whether
1028 // to create it. If the user says "no", then exit.
1029 if (explicit_userdir &&
1031 _("Missing user LyX directory"),
1032 bformat(_("You have specified a non-existent user "
1033 "LyX directory, %1$s.\n"
1034 "It is needed to keep your own configuration."),
1035 from_utf8(package().user_support().absFileName())),
1037 _("&Create directory"),
1039 lyxerr << to_utf8(_("No user LyX directory. Exiting.")) << endl;
1040 earlyExit(EXIT_FAILURE);
1043 lyxerr << to_utf8(bformat(_("LyX: Creating directory %1$s"),
1044 from_utf8(sup.absFileName()))) << endl;
1046 if (!sup.createDirectory(0755)) {
1047 // Failed, so let's exit.
1048 lyxerr << to_utf8(_("Failed to create directory. Exiting."))
1050 earlyExit(EXIT_FAILURE);
1057 bool LyX::readRcFile(string const & name, bool check_format)
1059 LYXERR(Debug::INIT, "About to read " << name << "... ");
1061 FileName const lyxrc_path = libFileSearch(string(), name);
1062 if (lyxrc_path.empty()) {
1063 LYXERR(Debug::INIT, "Not found." << lyxrc_path);
1065 // This was the previous logic, but can it be right??
1068 LYXERR(Debug::INIT, "Found in " << lyxrc_path);
1069 bool const success = lyxrc.read(lyxrc_path, check_format);
1071 showFileError(name);
1075 // Read the languages file `name'
1076 bool LyX::readLanguagesFile(string const & name)
1078 LYXERR(Debug::INIT, "About to read " << name << "...");
1080 FileName const lang_path = libFileSearch(string(), name);
1081 if (lang_path.empty()) {
1082 showFileError(name);
1085 languages.read(lang_path);
1090 // Read the encodings file `name'
1091 bool LyX::readEncodingsFile(string const & enc_name,
1092 string const & symbols_name)
1094 LYXERR(Debug::INIT, "About to read " << enc_name << " and "
1095 << symbols_name << "...");
1097 FileName const symbols_path = libFileSearch(string(), symbols_name);
1098 if (symbols_path.empty()) {
1099 showFileError(symbols_name);
1103 FileName const enc_path = libFileSearch(string(), enc_name);
1104 if (enc_path.empty()) {
1105 showFileError(enc_name);
1108 encodings.read(enc_path, symbols_path);
1115 /// return the the number of arguments consumed
1116 typedef function<int(string const &, string const &, string &)> cmd_helper;
1118 int parse_dbg(string const & arg, string const &, string &)
1121 cout << to_utf8(_("List of supported debug flags:")) << endl;
1122 Debug::showTags(cout);
1125 lyxerr << to_utf8(bformat(_("Setting debug level to %1$s"), from_utf8(arg))) << endl;
1127 lyxerr.setLevel(Debug::value(arg));
1128 Debug::showLevel(lyxerr, lyxerr.level());
1133 int parse_help(string const &, string const &, string &)
1136 to_utf8(_("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
1137 "Command line switches (case sensitive):\n"
1138 "\t-help summarize LyX usage\n"
1139 "\t-userdir dir set user directory to dir\n"
1140 "\t-sysdir dir set system directory to dir\n"
1141 "\t-geometry WxH+X+Y set geometry of the main window\n"
1142 "\t-dbg feature[,feature]...\n"
1143 " select the features to debug.\n"
1144 " Type `lyx -dbg' to see the list of features\n"
1145 "\t-x [--execute] command\n"
1146 " where command is a lyx command.\n"
1147 "\t-e [--export] fmt\n"
1148 " where fmt is the export format of choice. Look in\n"
1149 " Tools->Preferences->File Handling->File Formats->Short Name\n"
1150 " to see which parameter (which differs from the format name\n"
1151 " in the File->Export menu) should be passed.\n"
1152 " Note that the order of -e and -x switches matters.\n"
1153 "\t-E [--export-to] fmt filename\n"
1154 " where fmt is the export format of choice (see --export),\n"
1155 " and filename is the destination filename.\n"
1156 "\t-i [--import] fmt file.xxx\n"
1157 " where fmt is the import format of choice\n"
1158 " and file.xxx is the file to be imported.\n"
1159 "\t-f [--force-overwrite] what\n"
1160 " where what is either `all', `main' or `none',\n"
1161 " specifying whether all files, main file only, or no files,\n"
1162 " respectively, are to be overwritten during a batch export.\n"
1163 " Anything else is equivalent to `all', but is not consumed.\n"
1164 "\t-n [--no-remote]\n"
1165 " open documents in a new instance\n"
1167 " open documents in an already running instance\n"
1168 " (a working lyxpipe is needed)\n"
1169 "\t-v [--verbose]\n"
1170 " report on terminal about spawned commands.\n"
1171 "\t-batch execute commands without launching GUI and exit.\n"
1172 "\t-version summarize version and build info\n"
1173 "Check the LyX man page for more details.")) << endl;
1179 int parse_version(string const &, string const &, string &)
1181 cout << "LyX " << lyx_version
1182 << " (" << lyx_release_date << ")" << endl;
1183 if (string(lyx_git_commit_hash) != "none")
1184 cout << to_utf8(_(" Git commit hash "))
1185 << string(lyx_git_commit_hash).substr(0,8) << endl;
1186 cout << lyx_version_info << endl;
1192 int parse_sysdir(string const & arg, string const &, string &)
1195 Alert::error(_("No system directory"),
1196 _("Missing directory for -sysdir switch"));
1199 cl_system_support = arg;
1204 int parse_userdir(string const & arg, string const &, string &)
1207 Alert::error(_("No user directory"),
1208 _("Missing directory for -userdir switch"));
1211 cl_user_support = arg;
1216 int parse_execute(string const & arg, string const &, string & batch)
1219 Alert::error(_("Incomplete command"),
1220 _("Missing command string after --execute switch"));
1228 int parse_export_to(string const & type, string const & output_file, string & batch)
1231 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1232 "--export-to switch")) << endl;
1235 if (output_file.empty()) {
1236 lyxerr << to_utf8(_("Missing destination filename after "
1237 "--export-to switch")) << endl;
1240 batch = "buffer-export " + type + " " + output_file;
1246 int parse_export(string const & type, string const &, string & batch)
1249 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1250 "--export switch")) << endl;
1253 batch = "buffer-export " + type;
1259 int parse_import(string const & type, string const & file, string & batch)
1262 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1263 "--import switch")) << endl;
1267 lyxerr << to_utf8(_("Missing filename for --import")) << endl;
1270 batch = "buffer-import " + type + ' ' + file;
1275 int parse_geometry(string const & arg1, string const &, string &)
1278 // don't remove "-geometry", it will be pruned out later in the
1279 // frontend if need be.
1284 int parse_batch(string const &, string const &, string &)
1291 int parse_noremote(string const &, string const &, string &)
1293 run_mode = NEW_INSTANCE;
1298 int parse_remote(string const &, string const &, string &)
1300 run_mode = USE_REMOTE;
1305 int parse_verbose(string const &, string const &, string &)
1312 int parse_force(string const & arg, string const &, string &)
1315 force_overwrite = ALL_FILES;
1317 } else if (arg == "main") {
1318 force_overwrite = MAIN_FILE;
1320 } else if (arg == "none") {
1321 force_overwrite = NO_FILES;
1324 force_overwrite = ALL_FILES;
1332 void LyX::easyParse(int & argc, char * argv[])
1334 map<string, cmd_helper> cmdmap;
1336 cmdmap["-dbg"] = parse_dbg;
1337 cmdmap["-help"] = parse_help;
1338 cmdmap["--help"] = parse_help;
1339 cmdmap["-version"] = parse_version;
1340 cmdmap["--version"] = parse_version;
1341 cmdmap["-sysdir"] = parse_sysdir;
1342 cmdmap["-userdir"] = parse_userdir;
1343 cmdmap["-x"] = parse_execute;
1344 cmdmap["--execute"] = parse_execute;
1345 cmdmap["-e"] = parse_export;
1346 cmdmap["--export"] = parse_export;
1347 cmdmap["-E"] = parse_export_to;
1348 cmdmap["--export-to"] = parse_export_to;
1349 cmdmap["-i"] = parse_import;
1350 cmdmap["--import"] = parse_import;
1351 cmdmap["-geometry"] = parse_geometry;
1352 cmdmap["-batch"] = parse_batch;
1353 cmdmap["-f"] = parse_force;
1354 cmdmap["--force-overwrite"] = parse_force;
1355 cmdmap["-n"] = parse_noremote;
1356 cmdmap["--no-remote"] = parse_noremote;
1357 cmdmap["-r"] = parse_remote;
1358 cmdmap["--remote"] = parse_remote;
1359 cmdmap["-v"] = parse_verbose;
1360 cmdmap["--verbose"] = parse_verbose;
1362 for (int i = 1; i < argc; ++i) {
1363 map<string, cmd_helper>::const_iterator it
1364 = cmdmap.find(argv[i]);
1366 // don't complain if not found - may be parsed later
1367 if (it == cmdmap.end())
1371 (i + 1 < argc) ? os::utf8_argv(i + 1) : string();
1373 (i + 2 < argc) ? os::utf8_argv(i + 2) : string();
1376 int const remove = 1 + it->second(arg, arg2, batch);
1378 pimpl_->batch_commands.push_back(batch);
1380 // Now, remove used arguments by shifting
1381 // the following ones remove places down.
1383 os::remove_internal_args(i, remove);
1385 for (int j = i; j < argc; ++j)
1386 argv[j] = argv[j + remove];
1393 FuncStatus getStatus(FuncRequest const & action)
1396 return theApp()->getStatus(action);
1400 DispatchResult const & dispatch(FuncRequest const & action)
1403 return theApp()->dispatch(action);
1407 void dispatch(FuncRequest const & action, DispatchResult & dr)
1410 theApp()->dispatch(action, dr);
1414 vector<string> & theFilesToLoad()
1416 LAPPERR(singleton_);
1417 return singleton_->pimpl_->files_to_load_;
1421 BufferList & theBufferList()
1423 LAPPERR(singleton_);
1424 return singleton_->pimpl_->buffer_list_;
1428 Server & theServer()
1430 // FIXME: this should not be use_gui dependent
1432 LAPPERR(singleton_);
1433 return *singleton_->pimpl_->lyx_server_;
1437 ServerSocket & theServerSocket()
1439 // FIXME: this should not be use_gui dependent
1441 LAPPERR(singleton_);
1442 return *singleton_->pimpl_->lyx_socket_;
1446 KeyMap & theTopLevelKeymap()
1448 LAPPERR(singleton_);
1449 return singleton_->pimpl_->toplevel_keymap_;
1453 Converters & theConverters()
1455 LAPPERR(singleton_);
1456 return singleton_->pimpl_->converters_;
1460 Converters & theSystemConverters()
1462 LAPPERR(singleton_);
1463 return singleton_->pimpl_->system_converters_;
1467 Movers & theMovers()
1469 LAPPERR(singleton_);
1470 return singleton_->pimpl_->movers_;
1474 Mover const & getMover(string const & fmt)
1476 LAPPERR(singleton_);
1477 return singleton_->pimpl_->movers_(fmt);
1481 void setMover(string const & fmt, string const & command)
1483 LAPPERR(singleton_);
1484 singleton_->pimpl_->movers_.set(fmt, command);
1488 Movers & theSystemMovers()
1490 LAPPERR(singleton_);
1491 return singleton_->pimpl_->system_movers_;
1495 Messages const & getMessages(string const & language)
1497 LAPPERR(singleton_);
1498 return singleton_->messages(language);
1502 Messages const & getGuiMessages()
1504 LAPPERR(singleton_);
1505 return singleton_->messages(Messages::guiLanguage());
1509 Session & theSession()
1511 LAPPERR(singleton_);
1512 return *singleton_->pimpl_->session_.get();
1516 LaTeXFonts & theLaTeXFonts()
1518 LAPPERR(singleton_);
1519 if (!singleton_->pimpl_->latexfonts_)
1520 singleton_->pimpl_->latexfonts_ = new LaTeXFonts;
1521 return *singleton_->pimpl_->latexfonts_;
1525 CmdDef & theTopLevelCmdDef()
1527 LAPPERR(singleton_);
1528 return singleton_->pimpl_->toplevel_cmddef_;
1532 SpellChecker * theSpellChecker()
1534 if (!singleton_->pimpl_->spell_checker_)
1536 return singleton_->pimpl_->spell_checker_;
1540 void setSpellChecker()
1542 SpellChecker::ChangeNumber speller_change_number =singleton_->pimpl_->spell_checker_ ?
1543 singleton_->pimpl_->spell_checker_->changeNumber() : 0;
1545 if (lyxrc.spellchecker == "native") {
1546 #if defined(USE_MACOSX_PACKAGING)
1547 if (!singleton_->pimpl_->apple_spell_checker_)
1548 singleton_->pimpl_->apple_spell_checker_ = new AppleSpellChecker;
1549 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->apple_spell_checker_;
1551 singleton_->pimpl_->spell_checker_ = 0;
1553 } else if (lyxrc.spellchecker == "aspell") {
1554 #if defined(USE_ASPELL)
1555 if (!singleton_->pimpl_->aspell_checker_)
1556 singleton_->pimpl_->aspell_checker_ = new AspellChecker;
1557 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->aspell_checker_;
1559 singleton_->pimpl_->spell_checker_ = 0;
1561 } else if (lyxrc.spellchecker == "enchant") {
1562 #if defined(USE_ENCHANT)
1563 if (!singleton_->pimpl_->enchant_checker_)
1564 singleton_->pimpl_->enchant_checker_ = new EnchantChecker;
1565 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->enchant_checker_;
1567 singleton_->pimpl_->spell_checker_ = 0;
1569 } else if (lyxrc.spellchecker == "hunspell") {
1570 #if defined(USE_HUNSPELL)
1571 if (!singleton_->pimpl_->hunspell_checker_)
1572 singleton_->pimpl_->hunspell_checker_ = new HunspellChecker;
1573 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->hunspell_checker_;
1575 singleton_->pimpl_->spell_checker_ = 0;
1578 singleton_->pimpl_->spell_checker_ = 0;
1580 if (singleton_->pimpl_->spell_checker_) {
1581 singleton_->pimpl_->spell_checker_->changeNumber(speller_change_number);
1582 singleton_->pimpl_->spell_checker_->advanceChangeNumber();