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 "LayoutFile.h"
40 #include "LyXAction.h"
42 #include "ModuleList.h"
45 #include "ServerSocket.h"
48 #include "frontends/alert.h"
49 #include "frontends/Application.h"
51 #include "graphics/Previews.h"
53 #include "support/lassert.h"
54 #include "support/debug.h"
55 #include "support/environment.h"
56 #include "support/ExceptionMessage.h"
57 #include "support/filetools.h"
58 #include "support/gettext.h"
59 #include "support/lstrings.h"
60 #include "support/Messages.h"
61 #include "support/os.h"
62 #include "support/Package.h"
63 #include "support/Path.h"
64 #include "support/Systemcall.h"
66 #include "support/bind.h"
67 #include <boost/scoped_ptr.hpp>
78 using namespace lyx::support;
82 namespace Alert = frontend::Alert;
83 namespace os = support::os;
87 // Are we using the GUI at all? We default to true and this is changed
88 // to false when the export feature is used.
93 // We default to open documents in an already running instance, provided that
94 // the lyxpipe has been setup. This can be overridden either on the command
95 // line or through preference settings.
97 RunMode run_mode = PREFERRED;
100 // Tell what files can be silently overwritten during batch export.
101 // Possible values are: NO_FILES, MAIN_FILE, ALL_FILES, UNSPECIFIED.
102 // Unless specified on command line (through the -f switch) or through the
103 // environment variable LYX_FORCE_OVERWRITE, the default will be MAIN_FILE.
105 OverwriteFiles force_overwrite = UNSPECIFIED;
110 // Filled with the command line arguments "foo" of "-sysdir foo" or
112 string cl_system_support;
113 string cl_user_support;
117 LyX * singleton_ = 0;
119 void showFileError(string const & error)
121 Alert::warning(_("Could not read configuration file"),
122 bformat(_("Error while reading the configuration file\n%1$s.\n"
123 "Please check your installation."), from_utf8(error)));
127 void reconfigureUserLyXDir()
129 string const configure_command = package().configure_command();
131 lyxerr << to_utf8(_("LyX: reconfiguring user directory")) << endl;
132 PathChanger p(package().user_support());
134 one.startscript(Systemcall::Wait, configure_command);
135 lyxerr << "LyX: " << to_utf8(_("Done!")) << endl;
140 /// The main application class private implementation.
143 Impl() : spell_checker_(0), apple_spell_checker_(0), aspell_checker_(0), enchant_checker_(0), hunspell_checker_(0)
145 // Set the default User Interface language as soon as possible.
146 // The language used will be derived from the environment
148 messages_["GUI"] = Messages();
153 delete apple_spell_checker_;
154 delete aspell_checker_;
155 delete enchant_checker_;
156 delete hunspell_checker_;
160 BufferList buffer_list_;
162 KeyMap toplevel_keymap_;
164 CmdDef toplevel_cmddef_;
166 boost::scoped_ptr<Server> lyx_server_;
168 boost::scoped_ptr<ServerSocket> lyx_socket_;
170 boost::scoped_ptr<frontend::Application> application_;
171 /// lyx session, containing lastfiles, lastfilepos, and lastopened
172 boost::scoped_ptr<Session> session_;
174 /// Files to load at start.
175 vector<string> files_to_load_;
177 /// The messages translators.
178 map<string, Messages> messages_;
180 /// The file converters.
181 Converters converters_;
183 // The system converters copy after reading lyxrc.defaults.
184 Converters system_converters_;
189 Movers system_movers_;
191 /// has this user started lyx for the first time?
193 /// the parsed command line batch command if any
194 vector<string> batch_commands;
197 graphics::Previews preview_;
199 SpellChecker * spell_checker_;
201 SpellChecker * apple_spell_checker_;
203 SpellChecker * aspell_checker_;
205 SpellChecker * enchant_checker_;
207 SpellChecker * hunspell_checker_;
211 frontend::Application * theApp()
214 return singleton_->pimpl_->application_.get();
227 void lyx_exit(int exit_code)
230 // Something wrong happened so better save everything, just in
235 // Properly crash in debug mode in order to get a useful backtrace.
239 // In release mode, try to exit gracefully.
241 theApp()->exit(exit_code);
255 Messages & LyX::messages(string const & language)
257 map<string, Messages>::iterator it = pimpl_->messages_.find(language);
259 if (it != pimpl_->messages_.end())
262 pair<map<string, Messages>::iterator, bool> result =
263 pimpl_->messages_.insert(make_pair(language, Messages(language)));
265 LASSERT(result.second, /**/);
266 return result.first->second;
270 void setRcGuiLanguage()
272 LASSERT(singleton_, /**/);
273 if (lyxrc.gui_language == "auto")
275 Language const * language = languages.getLanguage(lyxrc.gui_language);
277 LYXERR(Debug::LOCALE, "Setting LANGUAGE to " << language->code());
278 if (!setEnv("LANGUAGE", language->code()))
279 LYXERR(Debug::LOCALE, "\t... failed!");
281 LYXERR(Debug::LOCALE, "Setting LC_ALL to en_US");
282 if (!setEnv("LC_ALL", "en_US"))
283 LYXERR(Debug::LOCALE, "\t... failed!");
285 singleton_->pimpl_->messages_["GUI"] = Messages();
289 int LyX::exec(int & argc, char * argv[])
291 // Minimal setting of locale before parsing command line
293 init_package(os::utf8_argv(0), string(), string(),
294 top_build_dir_is_one_level_up);
295 } catch (ExceptionMessage const & message) {
296 LYXERR(Debug::LOCALE, message.title_ + ", " + message.details_);
298 // no console and no Qt here so use a simple message box
299 MessageBoxA(0, to_ascii(message.details_).c_str(), to_ascii(message.title_).c_str(), 0);
305 // Here we need to parse the command line. At least
306 // we need to parse for "-dbg" and "-help"
307 easyParse(argc, argv);
310 init_package(os::utf8_argv(0),
311 cl_system_support, cl_user_support,
312 top_build_dir_is_one_level_up);
313 } catch (ExceptionMessage const & message) {
314 if (message.type_ == ErrorException) {
315 Alert::error(message.title_, message.details_);
317 } else if (message.type_ == WarningException) {
318 Alert::warning(message.title_, message.details_);
322 // Reinit the messages machinery in case package() knows
323 // something interesting about the locale directory.
327 // FIXME: create a ConsoleApplication
328 int exit_status = init(argc, argv);
334 // this is correct, since return values are inverted.
335 exit_status = !loadFiles();
337 if (pimpl_->batch_commands.empty() || pimpl_->buffer_list_.empty()) {
342 BufferList::iterator begin = pimpl_->buffer_list_.begin();
344 bool final_success = false;
345 for (BufferList::iterator I = begin; I != pimpl_->buffer_list_.end(); ++I) {
347 if (buf != buf->masterBuffer())
349 vector<string>::const_iterator bcit = pimpl_->batch_commands.begin();
350 vector<string>::const_iterator bcend = pimpl_->batch_commands.end();
352 for (; bcit != bcend; bcit++) {
353 LYXERR(Debug::ACTION, "Buffer::dispatch: cmd: " << *bcit);
354 buf->dispatch(*bcit, dr);
355 final_success |= !dr.error();
359 return !final_success;
362 // Let the frontend parse and remove all arguments that it knows
363 pimpl_->application_.reset(createApplication(argc, argv));
365 // Reestablish our defaults, as Qt overwrites them
366 // after createApplication()
369 // Parse and remove all known arguments in the LyX singleton
370 // Give an error for all remaining ones.
371 int exit_status = init(argc, argv);
373 // Kill the application object before exiting.
374 pimpl_->application_.reset();
380 // If not otherwise specified by a command line option or
381 // by preferences, we default to reuse a running instance.
382 if (run_mode == PREFERRED)
383 run_mode = USE_REMOTE;
386 /* Create a CoreApplication class that will provide the main event loop
387 * and the socket callback registering. With Qt4, only QtCore
388 * library would be needed.
389 * When this is done, a server_mode could be created and the following two
390 * line would be moved out from here.
391 * However, note that the first of the two lines below triggers the
392 * "single instance" behavior, which should occur right at this point.
394 // Note: socket callback must be registered after init(argc, argv)
395 // such that package().temp_dir() is properly initialized.
396 pimpl_->lyx_server_.reset(new Server(lyxrc.lyxpipes));
397 pimpl_->lyx_socket_.reset(new ServerSocket(
398 FileName(package().temp_dir().absFileName() + "/lyxsocket")));
400 // Start the real execution loop.
401 if (!theServer().deferredLoadingToOtherInstance())
402 exit_status = pimpl_->application_->exec();
403 else if (!pimpl_->files_to_load_.empty()) {
404 vector<string>::const_iterator it = pimpl_->files_to_load_.begin();
405 vector<string>::const_iterator end = pimpl_->files_to_load_.end();
406 lyxerr << _("The following files could not be loaded:") << endl;
407 for (; it != end; ++it)
408 lyxerr << *it << endl;
417 void LyX::prepareExit()
419 // Clear the clipboard and selection stack:
420 cap::clearCutStack();
421 cap::clearSelection();
423 // Write the index file of the converter cache
424 ConverterCache::get().writeIndex();
426 // close buffers first
427 pimpl_->buffer_list_.closeAll();
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(package().temp_dir().absFileName(), "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 "
448 << package().temp_dir().absFileName());
449 if (!package().temp_dir().destroyDirectory()) {
450 docstring const msg =
451 bformat(_("Unable to remove the temporary directory %1$s"),
452 from_utf8(package().temp_dir().absFileName()));
453 Alert::warning(_("Unable to remove temporary directory"), msg);
458 // Kill the application object before exiting. This avoids crashes
459 // when exiting on Linux.
460 if (pimpl_->application_)
461 pimpl_->application_.reset();
465 void LyX::earlyExit(int status)
467 LASSERT(pimpl_->application_.get(), /**/);
468 // LyX::pimpl_::application_ is not initialised at this
469 // point so it's safe to just exit after some cleanup.
475 int LyX::init(int & argc, char * argv[])
477 // check for any spurious extra arguments
478 // other than documents
479 for (int argi = 1; argi < argc ; ++argi) {
480 if (argv[argi][0] == '-') {
482 bformat(_("Wrong command line option `%1$s'. Exiting."),
483 from_utf8(os::utf8_argv(argi)))) << endl;
488 // Initialization of LyX (reads lyxrc and more)
489 LYXERR(Debug::INIT, "Initializing LyX::init...");
490 bool success = init();
491 LYXERR(Debug::INIT, "Initializing LyX::init...done");
495 // Remaining arguments are assumed to be files to load.
496 for (int argi = 1; argi < argc; ++argi)
497 pimpl_->files_to_load_.push_back(os::utf8_argv(argi));
500 pimpl_->files_to_load_.push_back(
501 i18nLibFileSearch("examples", "splash.lyx").absFileName());
508 bool LyX::loadFiles()
510 LASSERT(!use_gui, /**/);
512 vector<string>::const_iterator it = pimpl_->files_to_load_.begin();
513 vector<string>::const_iterator end = pimpl_->files_to_load_.end();
515 for (; it != end; ++it) {
516 // get absolute path of file and add ".lyx" to
517 // the filename if necessary
518 FileName fname = fileSearch(string(), os::internal_path(*it), "lyx",
524 Buffer * buf = pimpl_->buffer_list_.newBuffer(fname.absFileName(), false);
525 if (buf->loadLyXFile() == Buffer::ReadSuccess) {
526 ErrorList const & el = buf->errorList("Parse");
528 for_each(el.begin(), el.end(),
529 bind(&LyX::printError, this, _1));
532 pimpl_->buffer_list_.release(buf);
540 void execBatchCommands()
542 LASSERT(singleton_, /**/);
543 singleton_->execCommands();
547 void LyX::execCommands()
549 // The advantage of doing this here is that the event loop
550 // is already started. So any need for interaction will be
553 // if reconfiguration is needed.
554 if (LayoutFileList::get().empty()) {
555 switch (Alert::prompt(
556 _("No textclass is found"),
557 _("LyX will only have minimal functionality because no textclasses "
558 "have been found. You can either try to reconfigure LyX normally, "
559 "try to reconfigure without checking your LaTeX installation, or continue."),
566 // regular reconfigure
567 lyx::dispatch(FuncRequest(LFUN_RECONFIGURE, ""));
570 // reconfigure --without-latex-config
571 lyx::dispatch(FuncRequest(LFUN_RECONFIGURE,
572 " --without-latex-config"));
579 // create the first main window
580 lyx::dispatch(FuncRequest(LFUN_WINDOW_NEW, geometryArg));
582 if (!pimpl_->files_to_load_.empty()) {
583 // if some files were specified at command-line we assume that the
584 // user wants to edit *these* files and not to restore the session.
585 for (size_t i = 0; i != pimpl_->files_to_load_.size(); ++i) {
587 FuncRequest(LFUN_FILE_OPEN, pimpl_->files_to_load_[i]));
589 // clear this list to save a few bytes of RAM
590 pimpl_->files_to_load_.clear();
592 pimpl_->application_->restoreGuiSession();
594 // Execute batch commands if available
595 if (pimpl_->batch_commands.empty())
598 vector<string>::const_iterator bcit = pimpl_->batch_commands.begin();
599 vector<string>::const_iterator bcend = pimpl_->batch_commands.end();
600 for (; bcit != bcend; bcit++) {
601 LYXERR(Debug::INIT, "About to handle -x '" << *bcit << '\'');
602 lyx::dispatch(lyxaction.lookupFunc(*bcit));
610 The SIGHUP signal does not exist on Windows and does not need to be handled.
612 Windows handles SIGFPE and SIGSEGV signals as expected.
614 Ctrl+C interrupts (mapped to SIGINT by Windows' POSIX compatability layer)
615 cause a new thread to be spawned. This may well result in unexpected
616 behaviour by the single-threaded LyX.
618 SIGTERM signals will come only from another process actually sending
619 that signal using 'raise' in Windows' POSIX compatability layer. It will
620 not come from the general "terminate process" methods that everyone
621 actually uses (and which can't be trapped). Killing an app 'politely' on
622 Windows involves first sending a WM_CLOSE message, something that is
623 caught already by the Qt frontend.
625 For more information see:
627 http://aspn.activestate.com/ASPN/Mail/Message/ActiveTcl/2034055
628 ...signals are mostly useless on Windows for a variety of reasons that are
631 'UNIX Application Migration Guide, Chapter 9'
632 http://msdn.microsoft.com/library/en-us/dnucmg/html/UCMGch09.asp
634 'How To Terminate an Application "Cleanly" in Win32'
635 http://support.microsoft.com/default.aspx?scid=kb;en-us;178893
639 static void error_handler(int err_sig)
641 // Throw away any signals other than the first one received.
642 static sig_atomic_t handling_error = false;
645 handling_error = true;
647 // We have received a signal indicating a fatal error, so
648 // try and save the data ASAP.
651 // These lyxerr calls may or may not work:
653 // Signals are asynchronous, so the main program may be in a very
654 // fragile state when a signal is processed and thus while a signal
655 // handler function executes.
656 // In general, therefore, we should avoid performing any
657 // I/O operations or calling most library and system functions from
660 // This shouldn't matter here, however, as we've already invoked
666 msg = _("SIGHUP signal caught!\nBye.");
670 msg = _("SIGFPE signal caught!\nBye.");
673 msg = _("SIGSEGV signal caught!\n"
674 "Sorry, you have found a bug in LyX, "
675 "hope you have not lost any data.\n"
676 "Please read the bug-reporting instructions "
677 "in 'Help->Introduction' and send us a bug report, "
678 "if necessary. Thanks!\nBye.");
687 lyxerr << "\nlyx: " << msg << endl;
688 // try to make a GUI message
689 Alert::error(_("LyX crashed!"), msg);
692 // Deinstall the signal handlers
694 signal(SIGHUP, SIG_DFL);
696 signal(SIGINT, SIG_DFL);
697 signal(SIGFPE, SIG_DFL);
698 signal(SIGSEGV, SIG_DFL);
699 signal(SIGTERM, SIG_DFL);
702 if (err_sig == SIGSEGV ||
703 (err_sig != SIGHUP && !getEnv("LYXDEBUG").empty())) {
705 if (err_sig == SIGSEGV || !getEnv("LYXDEBUG").empty()) {
708 // with abort() it crashes again.
721 void LyX::printError(ErrorItem const & ei)
723 docstring tmp = _("LyX: ") + ei.error + char_type(':')
725 cerr << to_utf8(tmp) << endl;
732 signal(SIGHUP, error_handler);
734 signal(SIGFPE, error_handler);
735 signal(SIGSEGV, error_handler);
736 signal(SIGINT, error_handler);
737 signal(SIGTERM, error_handler);
738 // SIGPIPE can be safely ignored.
740 lyxrc.tempdir_path = package().temp_dir().absFileName();
741 lyxrc.document_path = package().document_dir().absFileName();
743 if (lyxrc.example_path.empty()) {
744 lyxrc.example_path = addPath(package().system_support().absFileName(),
747 if (lyxrc.template_path.empty()) {
748 lyxrc.template_path = addPath(package().system_support().absFileName(),
752 // init LyXDir environment variable
753 string const lyx_dir = package().lyx_dir().absFileName();
754 LYXERR(Debug::INIT, "Setting LyXDir... to \"" << lyx_dir << "\"");
755 if (!setEnv("LyXDir", lyx_dir))
756 LYXERR(Debug::INIT, "\t... failed!");
759 // Read configuration files
762 // This one may have been distributed along with LyX.
763 if (!readRcFile("lyxrc.dist"))
766 // Set the language defined by the distributor.
769 // Set the PATH correctly.
770 #if !defined (USE_POSIX_PACKAGING)
771 // Add the directory containing the LyX executable to the path
772 // so that LyX can find things like tex2lyx.
773 if (package().build_support().empty())
774 prependEnvPath("PATH", package().binary_dir().absFileName());
776 if (!lyxrc.path_prefix.empty())
777 prependEnvPath("PATH", replaceEnvironmentPath(lyxrc.path_prefix));
779 // Check that user LyX directory is ok.
780 if (queryUserLyXDir(package().explicit_user_support()))
781 reconfigureUserLyXDir();
784 // No need for a splash when there is no GUI
786 // Default is to overwrite the main file during export, unless
787 // the -f switch was specified or LYX_FORCE_OVERWRITE was set
788 if (force_overwrite == UNSPECIFIED) {
789 string const what = getEnv("LYX_FORCE_OVERWRITE");
791 force_overwrite = ALL_FILES;
792 else if (what == "none")
793 force_overwrite = NO_FILES;
795 force_overwrite = MAIN_FILE;
799 // This one is generated in user_support directory by lib/configure.py.
800 if (!readRcFile("lyxrc.defaults"))
803 // Query the OS to know what formats are viewed natively
804 formats.setAutoOpen();
806 // Read lyxrc.dist again to be able to override viewer auto-detection.
807 readRcFile("lyxrc.dist");
809 // Set again the language defined by the distributor.
812 system_lyxrc = lyxrc;
813 system_formats = formats;
814 pimpl_->system_converters_ = pimpl_->converters_;
815 pimpl_->system_movers_ = pimpl_->movers_;
816 system_lcolor = lcolor;
818 // This one is edited through the preferences dialog.
819 if (!readRcFile("preferences", true))
822 if (!readEncodingsFile("encodings", "unicodesymbols"))
824 if (!readLanguagesFile("languages"))
827 // Set the language defined by the user.
830 LYXERR(Debug::INIT, "Reading layouts...");
832 LayoutFileList::get().read();
834 theModuleList.read();
836 // read keymap and ui files in batch mode as well
837 // because InsetInfo needs to know these to produce
838 // the correct output
840 // Set up command definitions
841 pimpl_->toplevel_cmddef_.read(lyxrc.def_file);
845 pimpl_->toplevel_keymap_.read("site");
846 pimpl_->toplevel_keymap_.read(lyxrc.bind_file);
847 // load user bind file user.bind
848 pimpl_->toplevel_keymap_.read("user", 0, KeyMap::MissingOK);
850 if (lyxerr.debugging(Debug::LYXRC))
853 os::windows_style_tex_paths(lyxrc.windows_style_tex_paths);
854 if (!lyxrc.path_prefix.empty())
855 prependEnvPath("PATH", replaceEnvironmentPath(lyxrc.path_prefix));
857 FileName const document_path(lyxrc.document_path);
858 if (document_path.exists() && document_path.isDirectory())
859 package().document_dir() = document_path;
861 package().set_temp_dir(createLyXTmpDir(FileName(lyxrc.tempdir_path)));
862 if (package().temp_dir().empty()) {
863 Alert::error(_("Could not create temporary directory"),
864 bformat(_("Could not create a temporary directory in\n"
866 "Make sure that this path exists and is writable and try again."),
867 from_utf8(lyxrc.tempdir_path)));
868 // createLyXTmpDir() tries sufficiently hard to create a
869 // usable temp dir, so the probability to come here is
870 // close to zero. We therefore don't try to overcome this
871 // problem with e.g. asking the user for a new path and
872 // trying again but simply exit.
876 LYXERR(Debug::INIT, "LyX tmp dir: `"
877 << package().temp_dir().absFileName() << '\'');
879 LYXERR(Debug::INIT, "Reading session information '.lyx/session'...");
880 pimpl_->session_.reset(new Session(lyxrc.num_lastfiles));
882 // This must happen after package initialization and after lyxrc is
883 // read, therefore it can't be done by a static object.
884 ConverterCache::init();
890 void emergencyCleanup()
892 // what to do about tmpfiles is non-obvious. we would
893 // like to delete any we find, but our lyxdir might
894 // contain documents etc. which might be helpful on
897 singleton_->pimpl_->buffer_list_.emergencyWriteAll();
899 if (singleton_->pimpl_->lyx_server_)
900 singleton_->pimpl_->lyx_server_->emergencyCleanup();
901 singleton_->pimpl_->lyx_server_.reset();
902 singleton_->pimpl_->lyx_socket_.reset();
907 // return true if file does not exist or is older than configure.py.
908 static bool needsUpdate(string const & file)
910 // We cannot initialize configure_script directly because the package
911 // is not initialized yet when static objects are constructed.
912 static FileName configure_script;
913 static bool firstrun = true;
916 FileName(addName(package().system_support().absFileName(),
922 FileName(addName(package().user_support().absFileName(), file));
923 return !absfile.exists()
924 || configure_script.lastModified() > absfile.lastModified();
928 bool LyX::queryUserLyXDir(bool explicit_userdir)
930 // Does user directory exist?
931 FileName const sup = package().user_support();
932 if (sup.exists() && sup.isDirectory()) {
935 return needsUpdate("lyxrc.defaults")
936 || needsUpdate("lyxmodules.lst")
937 || needsUpdate("textclass.lst")
938 || needsUpdate("packages.lst");
941 first_start = !explicit_userdir;
943 // If the user specified explicitly a directory, ask whether
944 // to create it. If the user says "no", then exit.
945 if (explicit_userdir &&
947 _("Missing user LyX directory"),
948 bformat(_("You have specified a non-existent user "
949 "LyX directory, %1$s.\n"
950 "It is needed to keep your own configuration."),
951 from_utf8(package().user_support().absFileName())),
953 _("&Create directory"),
955 lyxerr << to_utf8(_("No user LyX directory. Exiting.")) << endl;
956 earlyExit(EXIT_FAILURE);
959 lyxerr << to_utf8(bformat(_("LyX: Creating directory %1$s"),
960 from_utf8(sup.absFileName()))) << endl;
962 if (!sup.createDirectory(0755)) {
963 // Failed, so let's exit.
964 lyxerr << to_utf8(_("Failed to create directory. Exiting."))
966 earlyExit(EXIT_FAILURE);
973 bool LyX::readRcFile(string const & name, bool check_format)
975 LYXERR(Debug::INIT, "About to read " << name << "... ");
977 FileName const lyxrc_path = libFileSearch(string(), name);
978 if (lyxrc_path.empty()) {
979 LYXERR(Debug::INIT, "Not found." << lyxrc_path);
981 // This was the previous logic, but can it be right??
984 LYXERR(Debug::INIT, "Found in " << lyxrc_path);
985 bool const success = lyxrc.read(lyxrc_path, check_format);
991 // Read the languages file `name'
992 bool LyX::readLanguagesFile(string const & name)
994 LYXERR(Debug::INIT, "About to read " << name << "...");
996 FileName const lang_path = libFileSearch(string(), name);
997 if (lang_path.empty()) {
1001 languages.read(lang_path);
1006 // Read the encodings file `name'
1007 bool LyX::readEncodingsFile(string const & enc_name,
1008 string const & symbols_name)
1010 LYXERR(Debug::INIT, "About to read " << enc_name << " and "
1011 << symbols_name << "...");
1013 FileName const symbols_path = libFileSearch(string(), symbols_name);
1014 if (symbols_path.empty()) {
1015 showFileError(symbols_name);
1019 FileName const enc_path = libFileSearch(string(), enc_name);
1020 if (enc_path.empty()) {
1021 showFileError(enc_name);
1024 encodings.read(enc_path, symbols_path);
1031 /// return the the number of arguments consumed
1032 typedef boost::function<int(string const &, string const &, string &)> cmd_helper;
1034 int parse_dbg(string const & arg, string const &, string &)
1037 lyxerr << to_utf8(_("List of supported debug flags:")) << endl;
1038 Debug::showTags(lyxerr);
1041 lyxerr << to_utf8(bformat(_("Setting debug level to %1$s"), from_utf8(arg))) << endl;
1043 lyxerr.setLevel(Debug::value(arg));
1044 Debug::showLevel(lyxerr, lyxerr.level());
1049 int parse_help(string const &, string const &, string &)
1052 to_utf8(_("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
1053 "Command line switches (case sensitive):\n"
1054 "\t-help summarize LyX usage\n"
1055 "\t-userdir dir set user directory to dir\n"
1056 "\t-sysdir dir set system directory to dir\n"
1057 "\t-geometry WxH+X+Y set geometry of the main window\n"
1058 "\t-dbg feature[,feature]...\n"
1059 " select the features to debug.\n"
1060 " Type `lyx -dbg' to see the list of features\n"
1061 "\t-x [--execute] command\n"
1062 " where command is a lyx command.\n"
1063 "\t-e [--export] fmt\n"
1064 " where fmt is the export format of choice.\n"
1065 " Look on Tools->Preferences->File formats->Format\n"
1066 " to get an idea which parameters should be passed.\n"
1067 " Note that the order of -e and -x switches matters.\n"
1068 "\t-i [--import] fmt file.xxx\n"
1069 " where fmt is the import format of choice\n"
1070 " and file.xxx is the file to be imported.\n"
1071 "\t-f [--force-overwrite] what\n"
1072 " where what is either `all', `main' or `none',\n"
1073 " specifying whether all files, main file only, or no files,\n"
1074 " respectively, are to be overwritten during a batch export.\n"
1075 " Anything else is equivalent to `all', but is not consumed.\n"
1076 "\t-n [--no-remote]\n"
1077 " open documents in a new instance\n"
1079 " open documents in an already running instance\n"
1080 " (a working lyxpipe is needed)\n"
1081 "\t-batch execute commands without launching GUI and exit.\n"
1082 "\t-version summarize version and build info\n"
1083 "Check the LyX man page for more details.")) << endl;
1089 int parse_version(string const &, string const &, string &)
1091 lyxerr << "LyX " << lyx_version
1092 << " (" << lyx_release_date << ")" << endl;
1093 lyxerr << "Built on " << __DATE__ << ", " << __TIME__ << endl;
1095 lyxerr << lyx_version_info << endl;
1101 int parse_sysdir(string const & arg, string const &, string &)
1104 Alert::error(_("No system directory"),
1105 _("Missing directory for -sysdir switch"));
1108 cl_system_support = arg;
1113 int parse_userdir(string const & arg, string const &, string &)
1116 Alert::error(_("No user directory"),
1117 _("Missing directory for -userdir switch"));
1120 cl_user_support = arg;
1125 int parse_execute(string const & arg, string const &, string & batch)
1128 Alert::error(_("Incomplete command"),
1129 _("Missing command string after --execute switch"));
1137 int parse_export(string const & type, string const &, string & batch)
1140 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1141 "--export switch")) << endl;
1144 batch = "buffer-export " + type;
1150 int parse_import(string const & type, string const & file, string & batch)
1153 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1154 "--import switch")) << endl;
1158 lyxerr << to_utf8(_("Missing filename for --import")) << endl;
1162 batch = "buffer-import " + type + ' ' + file;
1167 int parse_geometry(string const & arg1, string const &, string &)
1170 // don't remove "-geometry", it will be pruned out later in the
1171 // frontend if need be.
1176 int parse_batch(string const &, string const &, string &)
1183 int parse_noremote(string const &, string const &, string &)
1185 run_mode = NEW_INSTANCE;
1190 int parse_remote(string const &, string const &, string &)
1192 run_mode = USE_REMOTE;
1197 int parse_force(string const & arg, string const &, string &)
1200 force_overwrite = ALL_FILES;
1202 } else if (arg == "main") {
1203 force_overwrite = MAIN_FILE;
1205 } else if (arg == "none") {
1206 force_overwrite = NO_FILES;
1209 force_overwrite = ALL_FILES;
1217 void LyX::easyParse(int & argc, char * argv[])
1219 map<string, cmd_helper> cmdmap;
1221 cmdmap["-dbg"] = parse_dbg;
1222 cmdmap["-help"] = parse_help;
1223 cmdmap["--help"] = parse_help;
1224 cmdmap["-version"] = parse_version;
1225 cmdmap["--version"] = parse_version;
1226 cmdmap["-sysdir"] = parse_sysdir;
1227 cmdmap["-userdir"] = parse_userdir;
1228 cmdmap["-x"] = parse_execute;
1229 cmdmap["--execute"] = parse_execute;
1230 cmdmap["-e"] = parse_export;
1231 cmdmap["--export"] = parse_export;
1232 cmdmap["-i"] = parse_import;
1233 cmdmap["--import"] = parse_import;
1234 cmdmap["-geometry"] = parse_geometry;
1235 cmdmap["-batch"] = parse_batch;
1236 cmdmap["-f"] = parse_force;
1237 cmdmap["--force-overwrite"] = parse_force;
1238 cmdmap["-n"] = parse_noremote;
1239 cmdmap["--no-remote"] = parse_noremote;
1240 cmdmap["-r"] = parse_remote;
1241 cmdmap["--remote"] = parse_remote;
1243 for (int i = 1; i < argc; ++i) {
1244 map<string, cmd_helper>::const_iterator it
1245 = cmdmap.find(argv[i]);
1247 // don't complain if not found - may be parsed later
1248 if (it == cmdmap.end())
1252 (i + 1 < argc) ? os::utf8_argv(i + 1) : string();
1254 (i + 2 < argc) ? os::utf8_argv(i + 2) : string();
1257 int const remove = 1 + it->second(arg, arg2, batch);
1259 pimpl_->batch_commands.push_back(batch);
1261 // Now, remove used arguments by shifting
1262 // the following ones remove places down.
1264 os::remove_internal_args(i, remove);
1266 for (int j = i; j < argc; ++j)
1267 argv[j] = argv[j + remove];
1274 FuncStatus getStatus(FuncRequest const & action)
1276 LASSERT(theApp(), /**/);
1277 return theApp()->getStatus(action);
1281 void dispatch(FuncRequest const & action)
1283 LASSERT(theApp(), /**/);
1284 return theApp()->dispatch(action);
1288 void dispatch(FuncRequest const & action, DispatchResult & dr)
1290 LASSERT(theApp(), /**/);
1291 return theApp()->dispatch(action, dr);
1295 vector<string> & theFilesToLoad()
1297 LASSERT(singleton_, /**/);
1298 return singleton_->pimpl_->files_to_load_;
1302 BufferList & theBufferList()
1304 LASSERT(singleton_, /**/);
1305 return singleton_->pimpl_->buffer_list_;
1309 Server & theServer()
1311 // FIXME: this should not be use_gui dependent
1312 LASSERT(use_gui, /**/);
1313 LASSERT(singleton_, /**/);
1314 return *singleton_->pimpl_->lyx_server_.get();
1318 ServerSocket & theServerSocket()
1320 // FIXME: this should not be use_gui dependent
1321 LASSERT(use_gui, /**/);
1322 LASSERT(singleton_, /**/);
1323 return *singleton_->pimpl_->lyx_socket_.get();
1327 KeyMap & theTopLevelKeymap()
1329 LASSERT(singleton_, /**/);
1330 return singleton_->pimpl_->toplevel_keymap_;
1334 Converters & theConverters()
1336 LASSERT(singleton_, /**/);
1337 return singleton_->pimpl_->converters_;
1341 Converters & theSystemConverters()
1343 LASSERT(singleton_, /**/);
1344 return singleton_->pimpl_->system_converters_;
1348 Movers & theMovers()
1350 LASSERT(singleton_, /**/);
1351 return singleton_->pimpl_->movers_;
1355 Mover const & getMover(string const & fmt)
1357 LASSERT(singleton_, /**/);
1358 return singleton_->pimpl_->movers_(fmt);
1362 void setMover(string const & fmt, string const & command)
1364 LASSERT(singleton_, /**/);
1365 singleton_->pimpl_->movers_.set(fmt, command);
1369 Movers & theSystemMovers()
1371 LASSERT(singleton_, /**/);
1372 return singleton_->pimpl_->system_movers_;
1376 Messages const & getMessages(string const & language)
1378 LASSERT(singleton_, /**/);
1379 return singleton_->messages(language);
1383 Messages const & getGuiMessages()
1385 LASSERT(singleton_, /**/);
1386 return singleton_->pimpl_->messages_["GUI"];
1390 graphics::Previews & thePreviews()
1392 LASSERT(singleton_, /**/);
1393 return singleton_->pimpl_->preview_;
1397 Session & theSession()
1399 LASSERT(singleton_, /**/);
1400 return *singleton_->pimpl_->session_.get();
1404 CmdDef & theTopLevelCmdDef()
1406 LASSERT(singleton_, /**/);
1407 return singleton_->pimpl_->toplevel_cmddef_;
1411 SpellChecker * theSpellChecker()
1413 if (!singleton_->pimpl_->spell_checker_)
1415 return singleton_->pimpl_->spell_checker_;
1419 void setSpellChecker()
1421 SpellChecker::ChangeNumber speller_change_number =singleton_->pimpl_->spell_checker_ ?
1422 singleton_->pimpl_->spell_checker_->changeNumber() : 0;
1424 if (lyxrc.spellchecker == "native") {
1425 #if defined(USE_MACOSX_PACKAGING)
1426 if (!singleton_->pimpl_->apple_spell_checker_)
1427 singleton_->pimpl_->apple_spell_checker_ = new AppleSpellChecker();
1428 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->apple_spell_checker_;
1430 singleton_->pimpl_->spell_checker_ = 0;
1432 } else if (lyxrc.spellchecker == "aspell") {
1433 #if defined(USE_ASPELL)
1434 if (!singleton_->pimpl_->aspell_checker_)
1435 singleton_->pimpl_->aspell_checker_ = new AspellChecker();
1436 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->aspell_checker_;
1438 singleton_->pimpl_->spell_checker_ = 0;
1440 } else if (lyxrc.spellchecker == "enchant") {
1441 #if defined(USE_ENCHANT)
1442 if (!singleton_->pimpl_->enchant_checker_)
1443 singleton_->pimpl_->enchant_checker_ = new EnchantChecker();
1444 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->enchant_checker_;
1446 singleton_->pimpl_->spell_checker_ = 0;
1448 } else if (lyxrc.spellchecker == "hunspell") {
1449 #if defined(USE_HUNSPELL)
1450 if (!singleton_->pimpl_->hunspell_checker_)
1451 singleton_->pimpl_->hunspell_checker_ = new HunspellChecker();
1452 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->hunspell_checker_;
1454 singleton_->pimpl_->spell_checker_ = 0;
1457 singleton_->pimpl_->spell_checker_ = 0;
1459 if (singleton_->pimpl_->spell_checker_) {
1460 singleton_->pimpl_->spell_checker_->changeNumber(speller_change_number);
1461 singleton_->pimpl_->spell_checker_->advanceChangeNumber();