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_);
300 // Here we need to parse the command line. At least
301 // we need to parse for "-dbg" and "-help"
302 easyParse(argc, argv);
305 init_package(os::utf8_argv(0),
306 cl_system_support, cl_user_support,
307 top_build_dir_is_one_level_up);
308 } catch (ExceptionMessage const & message) {
309 if (message.type_ == ErrorException) {
310 Alert::error(message.title_, message.details_);
312 } else if (message.type_ == WarningException) {
313 Alert::warning(message.title_, message.details_);
317 // Reinit the messages machinery in case package() knows
318 // something interesting about the locale directory.
322 // FIXME: create a ConsoleApplication
323 int exit_status = init(argc, argv);
329 // this is correct, since return values are inverted.
330 exit_status = !loadFiles();
332 if (pimpl_->batch_commands.empty() || pimpl_->buffer_list_.empty()) {
337 BufferList::iterator begin = pimpl_->buffer_list_.begin();
339 bool final_success = false;
340 for (BufferList::iterator I = begin; I != pimpl_->buffer_list_.end(); ++I) {
342 if (buf != buf->masterBuffer())
344 vector<string>::const_iterator bcit = pimpl_->batch_commands.begin();
345 vector<string>::const_iterator bcend = pimpl_->batch_commands.end();
347 for (; bcit != bcend; bcit++) {
348 LYXERR(Debug::ACTION, "Buffer::dispatch: cmd: " << *bcit);
349 buf->dispatch(*bcit, dr);
350 final_success |= !dr.error();
354 return !final_success;
357 // Let the frontend parse and remove all arguments that it knows
358 pimpl_->application_.reset(createApplication(argc, argv));
360 // Reestablish our defaults, as Qt overwrites them
361 // after createApplication()
364 // Parse and remove all known arguments in the LyX singleton
365 // Give an error for all remaining ones.
366 int exit_status = init(argc, argv);
368 // Kill the application object before exiting.
369 pimpl_->application_.reset();
375 // If not otherwise specified by a command line option or
376 // by preferences, we default to reuse a running instance.
377 if (run_mode == PREFERRED)
378 run_mode = USE_REMOTE;
381 /* Create a CoreApplication class that will provide the main event loop
382 * and the socket callback registering. With Qt4, only QtCore
383 * library would be needed.
384 * When this is done, a server_mode could be created and the following two
385 * line would be moved out from here.
386 * However, note that the first of the two lines below triggers the
387 * "single instance" behavior, which should occur right at this point.
389 // Note: socket callback must be registered after init(argc, argv)
390 // such that package().temp_dir() is properly initialized.
391 pimpl_->lyx_server_.reset(new Server(lyxrc.lyxpipes));
392 pimpl_->lyx_socket_.reset(new ServerSocket(
393 FileName(package().temp_dir().absFileName() + "/lyxsocket")));
395 // Start the real execution loop.
396 if (!theServer().deferredLoadingToOtherInstance())
397 exit_status = pimpl_->application_->exec();
398 else if (!pimpl_->files_to_load_.empty()) {
399 vector<string>::const_iterator it = pimpl_->files_to_load_.begin();
400 vector<string>::const_iterator end = pimpl_->files_to_load_.end();
401 lyxerr << _("The following files could not be loaded:") << endl;
402 for (; it != end; ++it)
403 lyxerr << *it << endl;
412 void LyX::prepareExit()
414 // Clear the clipboard and selection stack:
415 cap::clearCutStack();
416 cap::clearSelection();
418 // Write the index file of the converter cache
419 ConverterCache::get().writeIndex();
421 // close buffers first
422 pimpl_->buffer_list_.closeAll();
424 // register session changes and shutdown server and socket
426 if (pimpl_->session_)
427 pimpl_->session_->writeFile();
428 pimpl_->session_.reset();
429 pimpl_->lyx_server_.reset();
430 pimpl_->lyx_socket_.reset();
433 // do any other cleanup procedures now
434 if (package().temp_dir() != package().system_temp_dir()) {
435 string const abs_tmpdir = package().temp_dir().absFileName();
436 if (!contains(package().temp_dir().absFileName(), "lyx_tmpdir")) {
437 docstring const msg =
438 bformat(_("%1$s does not appear like a LyX created temporary directory."),
439 from_utf8(abs_tmpdir));
440 Alert::warning(_("Cannot remove temporary directory"), msg);
442 LYXERR(Debug::INFO, "Deleting tmp dir "
443 << package().temp_dir().absFileName());
444 if (!package().temp_dir().destroyDirectory()) {
445 docstring const msg =
446 bformat(_("Unable to remove the temporary directory %1$s"),
447 from_utf8(package().temp_dir().absFileName()));
448 Alert::warning(_("Unable to remove temporary directory"), msg);
453 // Kill the application object before exiting. This avoids crashes
454 // when exiting on Linux.
455 if (pimpl_->application_)
456 pimpl_->application_.reset();
460 void LyX::earlyExit(int status)
462 LASSERT(pimpl_->application_.get(), /**/);
463 // LyX::pimpl_::application_ is not initialised at this
464 // point so it's safe to just exit after some cleanup.
470 int LyX::init(int & argc, char * argv[])
472 // check for any spurious extra arguments
473 // other than documents
474 for (int argi = 1; argi < argc ; ++argi) {
475 if (argv[argi][0] == '-') {
477 bformat(_("Wrong command line option `%1$s'. Exiting."),
478 from_utf8(os::utf8_argv(argi)))) << endl;
483 // Initialization of LyX (reads lyxrc and more)
484 LYXERR(Debug::INIT, "Initializing LyX::init...");
485 bool success = init();
486 LYXERR(Debug::INIT, "Initializing LyX::init...done");
490 // Remaining arguments are assumed to be files to load.
491 for (int argi = 1; argi < argc; ++argi)
492 pimpl_->files_to_load_.push_back(os::utf8_argv(argi));
495 pimpl_->files_to_load_.push_back(
496 i18nLibFileSearch("examples", "splash.lyx").absFileName());
503 bool LyX::loadFiles()
505 LASSERT(!use_gui, /**/);
507 vector<string>::const_iterator it = pimpl_->files_to_load_.begin();
508 vector<string>::const_iterator end = pimpl_->files_to_load_.end();
510 for (; it != end; ++it) {
511 // get absolute path of file and add ".lyx" to
512 // the filename if necessary
513 FileName fname = fileSearch(string(), os::internal_path(*it), "lyx",
519 Buffer * buf = pimpl_->buffer_list_.newBuffer(fname.absFileName(), false);
520 if (buf->loadLyXFile() == Buffer::ReadSuccess) {
521 ErrorList const & el = buf->errorList("Parse");
523 for_each(el.begin(), el.end(),
524 bind(&LyX::printError, this, _1));
527 pimpl_->buffer_list_.release(buf);
535 void execBatchCommands()
537 LASSERT(singleton_, /**/);
538 singleton_->execCommands();
542 void LyX::execCommands()
544 // The advantage of doing this here is that the event loop
545 // is already started. So any need for interaction will be
548 // if reconfiguration is needed.
549 if (LayoutFileList::get().empty()) {
550 switch (Alert::prompt(
551 _("No textclass is found"),
552 _("LyX will only have minimal functionality because no textclasses "
553 "have been found. You can either try to reconfigure LyX normally, "
554 "try to reconfigure without checking your LaTeX installation, or continue."),
561 // regular reconfigure
562 lyx::dispatch(FuncRequest(LFUN_RECONFIGURE, ""));
565 // reconfigure --without-latex-config
566 lyx::dispatch(FuncRequest(LFUN_RECONFIGURE,
567 " --without-latex-config"));
574 // create the first main window
575 lyx::dispatch(FuncRequest(LFUN_WINDOW_NEW, geometryArg));
577 if (!pimpl_->files_to_load_.empty()) {
578 // if some files were specified at command-line we assume that the
579 // user wants to edit *these* files and not to restore the session.
580 for (size_t i = 0; i != pimpl_->files_to_load_.size(); ++i) {
582 FuncRequest(LFUN_FILE_OPEN, pimpl_->files_to_load_[i]));
584 // clear this list to save a few bytes of RAM
585 pimpl_->files_to_load_.clear();
587 pimpl_->application_->restoreGuiSession();
589 // Execute batch commands if available
590 if (pimpl_->batch_commands.empty())
593 vector<string>::const_iterator bcit = pimpl_->batch_commands.begin();
594 vector<string>::const_iterator bcend = pimpl_->batch_commands.end();
595 for (; bcit != bcend; bcit++) {
596 LYXERR(Debug::INIT, "About to handle -x '" << *bcit << '\'');
597 lyx::dispatch(lyxaction.lookupFunc(*bcit));
605 The SIGHUP signal does not exist on Windows and does not need to be handled.
607 Windows handles SIGFPE and SIGSEGV signals as expected.
609 Ctrl+C interrupts (mapped to SIGINT by Windows' POSIX compatability layer)
610 cause a new thread to be spawned. This may well result in unexpected
611 behaviour by the single-threaded LyX.
613 SIGTERM signals will come only from another process actually sending
614 that signal using 'raise' in Windows' POSIX compatability layer. It will
615 not come from the general "terminate process" methods that everyone
616 actually uses (and which can't be trapped). Killing an app 'politely' on
617 Windows involves first sending a WM_CLOSE message, something that is
618 caught already by the Qt frontend.
620 For more information see:
622 http://aspn.activestate.com/ASPN/Mail/Message/ActiveTcl/2034055
623 ...signals are mostly useless on Windows for a variety of reasons that are
626 'UNIX Application Migration Guide, Chapter 9'
627 http://msdn.microsoft.com/library/en-us/dnucmg/html/UCMGch09.asp
629 'How To Terminate an Application "Cleanly" in Win32'
630 http://support.microsoft.com/default.aspx?scid=kb;en-us;178893
634 static void error_handler(int err_sig)
636 // Throw away any signals other than the first one received.
637 static sig_atomic_t handling_error = false;
640 handling_error = true;
642 // We have received a signal indicating a fatal error, so
643 // try and save the data ASAP.
646 // These lyxerr calls may or may not work:
648 // Signals are asynchronous, so the main program may be in a very
649 // fragile state when a signal is processed and thus while a signal
650 // handler function executes.
651 // In general, therefore, we should avoid performing any
652 // I/O operations or calling most library and system functions from
655 // This shouldn't matter here, however, as we've already invoked
661 msg = _("SIGHUP signal caught!\nBye.");
665 msg = _("SIGFPE signal caught!\nBye.");
668 msg = _("SIGSEGV signal caught!\n"
669 "Sorry, you have found a bug in LyX, "
670 "hope you have not lost any data.\n"
671 "Please read the bug-reporting instructions "
672 "in 'Help->Introduction' and send us a bug report, "
673 "if necessary. Thanks!\nBye.");
682 lyxerr << "\nlyx: " << msg << endl;
683 // try to make a GUI message
684 Alert::error(_("LyX crashed!"), msg);
687 // Deinstall the signal handlers
689 signal(SIGHUP, SIG_DFL);
691 signal(SIGINT, SIG_DFL);
692 signal(SIGFPE, SIG_DFL);
693 signal(SIGSEGV, SIG_DFL);
694 signal(SIGTERM, SIG_DFL);
697 if (err_sig == SIGSEGV ||
698 (err_sig != SIGHUP && !getEnv("LYXDEBUG").empty())) {
700 if (err_sig == SIGSEGV || !getEnv("LYXDEBUG").empty()) {
703 // with abort() it crashes again.
716 void LyX::printError(ErrorItem const & ei)
718 docstring tmp = _("LyX: ") + ei.error + char_type(':')
720 cerr << to_utf8(tmp) << endl;
727 signal(SIGHUP, error_handler);
729 signal(SIGFPE, error_handler);
730 signal(SIGSEGV, error_handler);
731 signal(SIGINT, error_handler);
732 signal(SIGTERM, error_handler);
733 // SIGPIPE can be safely ignored.
735 lyxrc.tempdir_path = package().temp_dir().absFileName();
736 lyxrc.document_path = package().document_dir().absFileName();
738 if (lyxrc.example_path.empty()) {
739 lyxrc.example_path = addPath(package().system_support().absFileName(),
742 if (lyxrc.template_path.empty()) {
743 lyxrc.template_path = addPath(package().system_support().absFileName(),
747 // init LyXDir environment variable
748 string const lyx_dir = package().lyx_dir().absFileName();
749 LYXERR(Debug::INIT, "Setting LyXDir... to \"" << lyx_dir << "\"");
750 if (!setEnv("LyXDir", lyx_dir))
751 LYXERR(Debug::INIT, "\t... failed!");
754 // Read configuration files
757 // This one may have been distributed along with LyX.
758 if (!readRcFile("lyxrc.dist"))
761 // Set the language defined by the distributor.
764 // Set the PATH correctly.
765 #if !defined (USE_POSIX_PACKAGING)
766 // Add the directory containing the LyX executable to the path
767 // so that LyX can find things like tex2lyx.
768 if (package().build_support().empty())
769 prependEnvPath("PATH", package().binary_dir().absFileName());
771 if (!lyxrc.path_prefix.empty())
772 prependEnvPath("PATH", replaceEnvironmentPath(lyxrc.path_prefix));
774 // Check that user LyX directory is ok.
775 if (queryUserLyXDir(package().explicit_user_support()))
776 reconfigureUserLyXDir();
779 // No need for a splash when there is no GUI
781 // Default is to overwrite the main file during export, unless
782 // the -f switch was specified or LYX_FORCE_OVERWRITE was set
783 if (force_overwrite == UNSPECIFIED) {
784 string const what = getEnv("LYX_FORCE_OVERWRITE");
786 force_overwrite = ALL_FILES;
787 else if (what == "none")
788 force_overwrite = NO_FILES;
790 force_overwrite = MAIN_FILE;
794 // This one is generated in user_support directory by lib/configure.py.
795 if (!readRcFile("lyxrc.defaults"))
798 // Query the OS to know what formats are viewed natively
799 formats.setAutoOpen();
801 // Read lyxrc.dist again to be able to override viewer auto-detection.
802 readRcFile("lyxrc.dist");
804 // Set again the language defined by the distributor.
807 system_lyxrc = lyxrc;
808 system_formats = formats;
809 pimpl_->system_converters_ = pimpl_->converters_;
810 pimpl_->system_movers_ = pimpl_->movers_;
811 system_lcolor = lcolor;
813 // This one is edited through the preferences dialog.
814 if (!readRcFile("preferences", true))
817 if (!readEncodingsFile("encodings", "unicodesymbols"))
819 if (!readLanguagesFile("languages"))
822 // Set the language defined by the user.
825 LYXERR(Debug::INIT, "Reading layouts...");
827 LayoutFileList::get().read();
829 theModuleList.read();
831 // read keymap and ui files in batch mode as well
832 // because InsetInfo needs to know these to produce
833 // the correct output
835 // Set up command definitions
836 pimpl_->toplevel_cmddef_.read(lyxrc.def_file);
840 pimpl_->toplevel_keymap_.read("site");
841 pimpl_->toplevel_keymap_.read(lyxrc.bind_file);
842 // load user bind file user.bind
843 pimpl_->toplevel_keymap_.read("user", 0, KeyMap::MissingOK);
845 if (lyxerr.debugging(Debug::LYXRC))
848 os::windows_style_tex_paths(lyxrc.windows_style_tex_paths);
849 if (!lyxrc.path_prefix.empty())
850 prependEnvPath("PATH", replaceEnvironmentPath(lyxrc.path_prefix));
852 FileName const document_path(lyxrc.document_path);
853 if (document_path.exists() && document_path.isDirectory())
854 package().document_dir() = document_path;
856 package().set_temp_dir(createLyXTmpDir(FileName(lyxrc.tempdir_path)));
857 if (package().temp_dir().empty()) {
858 Alert::error(_("Could not create temporary directory"),
859 bformat(_("Could not create a temporary directory in\n"
861 "Make sure that this path exists and is writable and try again."),
862 from_utf8(lyxrc.tempdir_path)));
863 // createLyXTmpDir() tries sufficiently hard to create a
864 // usable temp dir, so the probability to come here is
865 // close to zero. We therefore don't try to overcome this
866 // problem with e.g. asking the user for a new path and
867 // trying again but simply exit.
871 LYXERR(Debug::INIT, "LyX tmp dir: `"
872 << package().temp_dir().absFileName() << '\'');
874 LYXERR(Debug::INIT, "Reading session information '.lyx/session'...");
875 pimpl_->session_.reset(new Session(lyxrc.num_lastfiles));
877 // This must happen after package initialization and after lyxrc is
878 // read, therefore it can't be done by a static object.
879 ConverterCache::init();
885 void emergencyCleanup()
887 // what to do about tmpfiles is non-obvious. we would
888 // like to delete any we find, but our lyxdir might
889 // contain documents etc. which might be helpful on
892 singleton_->pimpl_->buffer_list_.emergencyWriteAll();
894 if (singleton_->pimpl_->lyx_server_)
895 singleton_->pimpl_->lyx_server_->emergencyCleanup();
896 singleton_->pimpl_->lyx_server_.reset();
897 singleton_->pimpl_->lyx_socket_.reset();
902 // return true if file does not exist or is older than configure.py.
903 static bool needsUpdate(string const & file)
905 // We cannot initialize configure_script directly because the package
906 // is not initialized yet when static objects are constructed.
907 static FileName configure_script;
908 static bool firstrun = true;
911 FileName(addName(package().system_support().absFileName(),
917 FileName(addName(package().user_support().absFileName(), file));
918 return !absfile.exists()
919 || configure_script.lastModified() > absfile.lastModified();
923 bool LyX::queryUserLyXDir(bool explicit_userdir)
925 // Does user directory exist?
926 FileName const sup = package().user_support();
927 if (sup.exists() && sup.isDirectory()) {
930 return needsUpdate("lyxrc.defaults")
931 || needsUpdate("lyxmodules.lst")
932 || needsUpdate("textclass.lst")
933 || needsUpdate("packages.lst");
936 first_start = !explicit_userdir;
938 // If the user specified explicitly a directory, ask whether
939 // to create it. If the user says "no", then exit.
940 if (explicit_userdir &&
942 _("Missing user LyX directory"),
943 bformat(_("You have specified a non-existent user "
944 "LyX directory, %1$s.\n"
945 "It is needed to keep your own configuration."),
946 from_utf8(package().user_support().absFileName())),
948 _("&Create directory"),
950 lyxerr << to_utf8(_("No user LyX directory. Exiting.")) << endl;
951 earlyExit(EXIT_FAILURE);
954 lyxerr << to_utf8(bformat(_("LyX: Creating directory %1$s"),
955 from_utf8(sup.absFileName()))) << endl;
957 if (!sup.createDirectory(0755)) {
958 // Failed, so let's exit.
959 lyxerr << to_utf8(_("Failed to create directory. Exiting."))
961 earlyExit(EXIT_FAILURE);
968 bool LyX::readRcFile(string const & name, bool check_format)
970 LYXERR(Debug::INIT, "About to read " << name << "... ");
972 FileName const lyxrc_path = libFileSearch(string(), name);
973 if (lyxrc_path.empty()) {
974 LYXERR(Debug::INIT, "Not found." << lyxrc_path);
976 // This was the previous logic, but can it be right??
979 LYXERR(Debug::INIT, "Found in " << lyxrc_path);
980 bool const success = lyxrc.read(lyxrc_path, check_format);
986 // Read the languages file `name'
987 bool LyX::readLanguagesFile(string const & name)
989 LYXERR(Debug::INIT, "About to read " << name << "...");
991 FileName const lang_path = libFileSearch(string(), name);
992 if (lang_path.empty()) {
996 languages.read(lang_path);
1001 // Read the encodings file `name'
1002 bool LyX::readEncodingsFile(string const & enc_name,
1003 string const & symbols_name)
1005 LYXERR(Debug::INIT, "About to read " << enc_name << " and "
1006 << symbols_name << "...");
1008 FileName const symbols_path = libFileSearch(string(), symbols_name);
1009 if (symbols_path.empty()) {
1010 showFileError(symbols_name);
1014 FileName const enc_path = libFileSearch(string(), enc_name);
1015 if (enc_path.empty()) {
1016 showFileError(enc_name);
1019 encodings.read(enc_path, symbols_path);
1026 /// return the the number of arguments consumed
1027 typedef boost::function<int(string const &, string const &, string &)> cmd_helper;
1029 int parse_dbg(string const & arg, string const &, string &)
1032 lyxerr << to_utf8(_("List of supported debug flags:")) << endl;
1033 Debug::showTags(lyxerr);
1036 lyxerr << to_utf8(bformat(_("Setting debug level to %1$s"), from_utf8(arg))) << endl;
1038 lyxerr.setLevel(Debug::value(arg));
1039 Debug::showLevel(lyxerr, lyxerr.level());
1044 int parse_help(string const &, string const &, string &)
1047 to_utf8(_("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
1048 "Command line switches (case sensitive):\n"
1049 "\t-help summarize LyX usage\n"
1050 "\t-userdir dir set user directory to dir\n"
1051 "\t-sysdir dir set system directory to dir\n"
1052 "\t-geometry WxH+X+Y set geometry of the main window\n"
1053 "\t-dbg feature[,feature]...\n"
1054 " select the features to debug.\n"
1055 " Type `lyx -dbg' to see the list of features\n"
1056 "\t-x [--execute] command\n"
1057 " where command is a lyx command.\n"
1058 "\t-e [--export] fmt\n"
1059 " where fmt is the export format of choice.\n"
1060 " Look on Tools->Preferences->File formats->Format\n"
1061 " to get an idea which parameters should be passed.\n"
1062 " Note that the order of -e and -x switches matters.\n"
1063 "\t-i [--import] fmt file.xxx\n"
1064 " where fmt is the import format of choice\n"
1065 " and file.xxx is the file to be imported.\n"
1066 "\t-f [--force-overwrite] what\n"
1067 " where what is either `all', `main' or `none',\n"
1068 " specifying whether all files, main file only, or no files,\n"
1069 " respectively, are to be overwritten during a batch export.\n"
1070 " Anything else is equivalent to `all', but is not consumed.\n"
1071 "\t-n [--no-remote]\n"
1072 " open documents in a new instance\n"
1074 " open documents in an already running instance\n"
1075 " (a working lyxpipe is needed)\n"
1076 "\t-batch execute commands without launching GUI and exit.\n"
1077 "\t-version summarize version and build info\n"
1078 "Check the LyX man page for more details.")) << endl;
1084 int parse_version(string const &, string const &, string &)
1086 lyxerr << "LyX " << lyx_version
1087 << " (" << lyx_release_date << ")" << endl;
1088 lyxerr << "Built on " << __DATE__ << ", " << __TIME__ << endl;
1090 lyxerr << lyx_version_info << endl;
1096 int parse_sysdir(string const & arg, string const &, string &)
1099 Alert::error(_("No system directory"),
1100 _("Missing directory for -sysdir switch"));
1103 cl_system_support = arg;
1108 int parse_userdir(string const & arg, string const &, string &)
1111 Alert::error(_("No user directory"),
1112 _("Missing directory for -userdir switch"));
1115 cl_user_support = arg;
1120 int parse_execute(string const & arg, string const &, string & batch)
1123 Alert::error(_("Incomplete command"),
1124 _("Missing command string after --execute switch"));
1132 int parse_export(string const & type, string const &, string & batch)
1135 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1136 "--export switch")) << endl;
1139 batch = "buffer-export " + type;
1145 int parse_import(string const & type, string const & file, string & batch)
1148 lyxerr << to_utf8(_("Missing file type [eg latex, ps...] after "
1149 "--import switch")) << endl;
1153 lyxerr << to_utf8(_("Missing filename for --import")) << endl;
1157 batch = "buffer-import " + type + ' ' + file;
1162 int parse_geometry(string const & arg1, string const &, string &)
1165 // don't remove "-geometry", it will be pruned out later in the
1166 // frontend if need be.
1171 int parse_batch(string const &, string const &, string &)
1178 int parse_noremote(string const &, string const &, string &)
1180 run_mode = NEW_INSTANCE;
1185 int parse_remote(string const &, string const &, string &)
1187 run_mode = USE_REMOTE;
1192 int parse_force(string const & arg, string const &, string &)
1195 force_overwrite = ALL_FILES;
1197 } else if (arg == "main") {
1198 force_overwrite = MAIN_FILE;
1200 } else if (arg == "none") {
1201 force_overwrite = NO_FILES;
1204 force_overwrite = ALL_FILES;
1212 void LyX::easyParse(int & argc, char * argv[])
1214 map<string, cmd_helper> cmdmap;
1216 cmdmap["-dbg"] = parse_dbg;
1217 cmdmap["-help"] = parse_help;
1218 cmdmap["--help"] = parse_help;
1219 cmdmap["-version"] = parse_version;
1220 cmdmap["--version"] = parse_version;
1221 cmdmap["-sysdir"] = parse_sysdir;
1222 cmdmap["-userdir"] = parse_userdir;
1223 cmdmap["-x"] = parse_execute;
1224 cmdmap["--execute"] = parse_execute;
1225 cmdmap["-e"] = parse_export;
1226 cmdmap["--export"] = parse_export;
1227 cmdmap["-i"] = parse_import;
1228 cmdmap["--import"] = parse_import;
1229 cmdmap["-geometry"] = parse_geometry;
1230 cmdmap["-batch"] = parse_batch;
1231 cmdmap["-f"] = parse_force;
1232 cmdmap["--force-overwrite"] = parse_force;
1233 cmdmap["-n"] = parse_noremote;
1234 cmdmap["--no-remote"] = parse_noremote;
1235 cmdmap["-r"] = parse_remote;
1236 cmdmap["--remote"] = parse_remote;
1238 for (int i = 1; i < argc; ++i) {
1239 map<string, cmd_helper>::const_iterator it
1240 = cmdmap.find(argv[i]);
1242 // don't complain if not found - may be parsed later
1243 if (it == cmdmap.end())
1247 (i + 1 < argc) ? os::utf8_argv(i + 1) : string();
1249 (i + 2 < argc) ? os::utf8_argv(i + 2) : string();
1252 int const remove = 1 + it->second(arg, arg2, batch);
1254 pimpl_->batch_commands.push_back(batch);
1256 // Now, remove used arguments by shifting
1257 // the following ones remove places down.
1259 os::remove_internal_args(i, remove);
1261 for (int j = i; j < argc; ++j)
1262 argv[j] = argv[j + remove];
1269 FuncStatus getStatus(FuncRequest const & action)
1271 LASSERT(theApp(), /**/);
1272 return theApp()->getStatus(action);
1276 void dispatch(FuncRequest const & action)
1278 LASSERT(theApp(), /**/);
1279 return theApp()->dispatch(action);
1283 void dispatch(FuncRequest const & action, DispatchResult & dr)
1285 LASSERT(theApp(), /**/);
1286 return theApp()->dispatch(action, dr);
1290 vector<string> & theFilesToLoad()
1292 LASSERT(singleton_, /**/);
1293 return singleton_->pimpl_->files_to_load_;
1297 BufferList & theBufferList()
1299 LASSERT(singleton_, /**/);
1300 return singleton_->pimpl_->buffer_list_;
1304 Server & theServer()
1306 // FIXME: this should not be use_gui dependent
1307 LASSERT(use_gui, /**/);
1308 LASSERT(singleton_, /**/);
1309 return *singleton_->pimpl_->lyx_server_.get();
1313 ServerSocket & theServerSocket()
1315 // FIXME: this should not be use_gui dependent
1316 LASSERT(use_gui, /**/);
1317 LASSERT(singleton_, /**/);
1318 return *singleton_->pimpl_->lyx_socket_.get();
1322 KeyMap & theTopLevelKeymap()
1324 LASSERT(singleton_, /**/);
1325 return singleton_->pimpl_->toplevel_keymap_;
1329 Converters & theConverters()
1331 LASSERT(singleton_, /**/);
1332 return singleton_->pimpl_->converters_;
1336 Converters & theSystemConverters()
1338 LASSERT(singleton_, /**/);
1339 return singleton_->pimpl_->system_converters_;
1343 Movers & theMovers()
1345 LASSERT(singleton_, /**/);
1346 return singleton_->pimpl_->movers_;
1350 Mover const & getMover(string const & fmt)
1352 LASSERT(singleton_, /**/);
1353 return singleton_->pimpl_->movers_(fmt);
1357 void setMover(string const & fmt, string const & command)
1359 LASSERT(singleton_, /**/);
1360 singleton_->pimpl_->movers_.set(fmt, command);
1364 Movers & theSystemMovers()
1366 LASSERT(singleton_, /**/);
1367 return singleton_->pimpl_->system_movers_;
1371 Messages const & getMessages(string const & language)
1373 LASSERT(singleton_, /**/);
1374 return singleton_->messages(language);
1378 Messages const & getGuiMessages()
1380 LASSERT(singleton_, /**/);
1381 return singleton_->pimpl_->messages_["GUI"];
1385 graphics::Previews & thePreviews()
1387 LASSERT(singleton_, /**/);
1388 return singleton_->pimpl_->preview_;
1392 Session & theSession()
1394 LASSERT(singleton_, /**/);
1395 return *singleton_->pimpl_->session_.get();
1399 CmdDef & theTopLevelCmdDef()
1401 LASSERT(singleton_, /**/);
1402 return singleton_->pimpl_->toplevel_cmddef_;
1406 SpellChecker * theSpellChecker()
1408 if (!singleton_->pimpl_->spell_checker_)
1410 return singleton_->pimpl_->spell_checker_;
1414 void setSpellChecker()
1416 SpellChecker::ChangeNumber speller_change_number =singleton_->pimpl_->spell_checker_ ?
1417 singleton_->pimpl_->spell_checker_->changeNumber() : 0;
1419 if (lyxrc.spellchecker == "native") {
1420 #if defined(USE_MACOSX_PACKAGING)
1421 if (!singleton_->pimpl_->apple_spell_checker_)
1422 singleton_->pimpl_->apple_spell_checker_ = new AppleSpellChecker();
1423 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->apple_spell_checker_;
1425 singleton_->pimpl_->spell_checker_ = 0;
1427 } else if (lyxrc.spellchecker == "aspell") {
1428 #if defined(USE_ASPELL)
1429 if (!singleton_->pimpl_->aspell_checker_)
1430 singleton_->pimpl_->aspell_checker_ = new AspellChecker();
1431 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->aspell_checker_;
1433 singleton_->pimpl_->spell_checker_ = 0;
1435 } else if (lyxrc.spellchecker == "enchant") {
1436 #if defined(USE_ENCHANT)
1437 if (!singleton_->pimpl_->enchant_checker_)
1438 singleton_->pimpl_->enchant_checker_ = new EnchantChecker();
1439 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->enchant_checker_;
1441 singleton_->pimpl_->spell_checker_ = 0;
1443 } else if (lyxrc.spellchecker == "hunspell") {
1444 #if defined(USE_HUNSPELL)
1445 if (!singleton_->pimpl_->hunspell_checker_)
1446 singleton_->pimpl_->hunspell_checker_ = new HunspellChecker();
1447 singleton_->pimpl_->spell_checker_ = singleton_->pimpl_->hunspell_checker_;
1449 singleton_->pimpl_->spell_checker_ = 0;
1452 singleton_->pimpl_->spell_checker_ = 0;
1454 if (singleton_->pimpl_->spell_checker_) {
1455 singleton_->pimpl_->spell_checker_->changeNumber(speller_change_number);
1456 singleton_->pimpl_->spell_checker_->advanceChangeNumber();