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.
21 #include "buffer_funcs.h"
22 #include "bufferlist.h"
23 #include "converter.h"
26 #include "errorlist.h"
31 #include "lastfiles.h"
36 #include "lyxtextclasslist.h"
37 #include "lyxserver.h"
38 #include "MenuBackend.h"
39 #include "ToolbarBackend.h"
41 #include "frontends/Alert.h"
42 #include "frontends/lyx_gui.h"
44 #include "support/FileInfo.h"
45 #include "support/filetools.h"
46 #include "support/lyxlib.h"
47 #include "support/os.h"
48 #include "support/path.h"
49 #include "support/path_defines.h"
51 #include <boost/bind.hpp>
56 using lyx::support::AddName;
57 using lyx::support::AddPath;
58 using lyx::support::bformat;
59 using lyx::support::createDirectory;
60 using lyx::support::CreateLyXTmpDir;
61 using lyx::support::FileInfo;
62 using lyx::support::FileSearch;
63 using lyx::support::GetEnv;
64 using lyx::support::GetEnvPath;
65 using lyx::support::i18nLibFileSearch;
66 using lyx::support::LibFileSearch;
67 using lyx::support::Path;
68 using lyx::support::rtrim;
69 using lyx::support::setLyxPaths;
70 using lyx::support::system_lyxdir;
71 using lyx::support::user_lyxdir;
73 namespace os = lyx::support::os;
79 #ifndef CXX_GLOBAL_CSTD
86 extern void QuitLyX();
88 extern LyXServer * lyxserver;
92 boost::scoped_ptr<LastFiles> lastfiles;
94 // This is the global bufferlist object
95 BufferList bufferlist;
97 // convenient to have it here.
98 boost::scoped_ptr<kb_keymap> toplevel_keymap;
102 void showFileError(string const & error)
104 Alert::warning(_("Could not read configuration file"),
105 bformat(_("Error while reading the configuration file\n%1$s.\n"
106 "Please check your installation."), error));
112 LyX::LyX(int & argc, char * argv[])
114 // Here we need to parse the command line. At least
115 // we need to parse for "-dbg" and "-help"
116 bool const want_gui = easyParse(argc, argv);
118 // set the DisplayTranslator only once; should that be done here??
119 // if this should not be in this file, please also remove
120 // #include "graphics/GraphicsTypes.h" at the top -- Rob Lahaye.
121 lyx::graphics::setDisplayTranslator();
124 lyx_gui::parse_init(argc, argv);
126 // check for any spurious extra arguments
127 // other than documents
128 for (int argi = 1; argi < argc ; ++argi) {
129 if (argv[argi][0] == '-') {
130 lyxerr << bformat(_("Wrong command line option `%1$s'. Exiting."),
136 // Initialization of LyX (reads lyxrc and more)
137 lyxerr[Debug::INIT] << "Initializing LyX::init..." << endl;
139 lyxerr[Debug::INIT] << "Initializing LyX::init...done" << endl;
142 lyx_gui::parse_lyxrc();
144 vector<string> files;
146 for (int argi = argc - 1; argi >= 1; --argi)
147 files.push_back(argv[argi]);
150 files.push_back(i18nLibFileSearch("examples", "splash.lyx"));
152 // Execute batch commands if available
153 if (!batch_command.empty()) {
155 lyxerr[Debug::INIT] << "About to handle -x '"
156 << batch_command << '\'' << endl;
158 Buffer * last_loaded = 0;
160 vector<string>::const_iterator it = files.begin();
161 vector<string>::const_iterator end = files.end();
163 for (; it != end; ++it) {
164 // get absolute path of file and add ".lyx" to
165 // the filename if necessary
166 string s = FileSearch(string(), *it, "lyx");
168 last_loaded = newFile(*it, string(), true);
170 Buffer * buf = bufferlist.newBuffer(s, false);
171 buf->error.connect(boost::bind(&LyX::printError, this, _1));
172 if (loadLyXFile(buf, s))
175 bufferlist.release(buf);
179 // try to dispatch to last loaded buffer first
181 bool success = false;
182 if (last_loaded->dispatch(batch_command, &success)) {
187 files.clear(); // the files are already loaded
190 lyx_gui::start(batch_command, files);
196 static void error_handler(int err_sig)
200 lyxerr << "\nlyx: SIGHUP signal caught" << endl;
206 lyxerr << "\nlyx: SIGFPE signal caught" << endl;
209 lyxerr << "\nlyx: SIGSEGV signal caught" << endl;
211 "Sorry, you have found a bug in LyX. "
212 "Please read the bug-reporting instructions "
213 "in Help->Introduction and send us a bug report, "
214 "if necessary. Thanks !" << endl;
221 // Deinstall the signal handlers
222 signal(SIGHUP, SIG_DFL);
223 signal(SIGINT, SIG_DFL);
224 signal(SIGFPE, SIG_DFL);
225 signal(SIGSEGV, SIG_DFL);
226 signal(SIGTERM, SIG_DFL);
228 LyX::emergencyCleanup();
230 lyxerr << "Bye." << endl;
231 if (err_sig!= SIGHUP &&
232 (!GetEnv("LYXDEBUG").empty() || err_sig == SIGSEGV))
233 lyx::support::abort();
240 void LyX::printError(ErrorItem const & ei)
242 std::cerr << _("LyX: ") << ei.error
243 << ':' << ei.description << std::endl;
248 void LyX::init(bool gui)
250 signal(SIGHUP, error_handler);
251 signal(SIGFPE, error_handler);
252 signal(SIGSEGV, error_handler);
253 signal(SIGINT, error_handler);
254 signal(SIGTERM, error_handler);
256 bool const explicit_userdir = setLyxPaths();
258 // Check that user LyX directory is ok. We don't do that if
259 // running in batch mode.
261 queryUserLyXDir(explicit_userdir);
266 // Disable gui when easyparse says so
267 lyx_gui::use_gui = gui;
269 if (lyxrc.template_path.empty()) {
270 lyxrc.template_path = AddPath(system_lyxdir(), "templates");
273 if (lyxrc.lastfiles.empty()) {
274 lyxrc.lastfiles = AddName(user_lyxdir(), "lastfiles");
277 if (lyxrc.roman_font_name.empty())
278 lyxrc.roman_font_name = lyx_gui::roman_font_name();
279 if (lyxrc.sans_font_name.empty())
280 lyxrc.sans_font_name = lyx_gui::sans_font_name();
281 if (lyxrc.typewriter_font_name.empty())
282 lyxrc.typewriter_font_name = lyx_gui::typewriter_font_name();
285 // Read configuration files
288 readRcFile("lyxrc.defaults");
289 system_lyxrc = lyxrc;
290 system_formats = formats;
291 system_converters = converters;
292 system_lcolor = lcolor;
294 string prefsfile = "preferences";
295 // back compatibility to lyxs < 1.1.6
296 if (LibFileSearch(string(), prefsfile).empty())
298 if (!LibFileSearch(string(), prefsfile).empty())
299 readRcFile(prefsfile);
301 readEncodingsFile("encodings");
302 readLanguagesFile("languages");
305 lyxerr[Debug::INIT] << "Reading layouts..." << endl;
310 toplevel_keymap.reset(new kb_keymap);
311 defaultKeyBindings(toplevel_keymap.get());
312 toplevel_keymap->read(lyxrc.bind_file);
315 readUIFile(lyxrc.ui_file);
318 if (lyxerr.debugging(Debug::LYXRC))
321 os::setTmpDir(CreateLyXTmpDir(lyxrc.tempdir_path));
322 if (lyxerr.debugging(Debug::INIT)) {
323 lyxerr << "LyX tmp dir: `" << os::getTmpDir() << '\'' << endl;
326 lyxerr[Debug::INIT] << "Reading lastfiles `"
327 << lyxrc.lastfiles << "'..." << endl;
328 lastfiles.reset(new LastFiles(lyxrc.lastfiles,
329 lyxrc.check_lastfiles,
330 lyxrc.num_lastfiles));
334 void LyX::defaultKeyBindings(kb_keymap * kbmap)
336 kbmap->bind("Right", LFUN_RIGHT);
337 kbmap->bind("Left", LFUN_LEFT);
338 kbmap->bind("Up", LFUN_UP);
339 kbmap->bind("Down", LFUN_DOWN);
341 kbmap->bind("Tab", LFUN_CELL_FORWARD);
342 kbmap->bind("ISO_Left_Tab", LFUN_CELL_FORWARD); // jbl 2001-23-02
344 kbmap->bind("Home", LFUN_HOME);
345 kbmap->bind("End", LFUN_END);
346 kbmap->bind("Prior", LFUN_PRIOR);
347 kbmap->bind("Next", LFUN_NEXT);
349 kbmap->bind("Return", LFUN_BREAKPARAGRAPH);
350 //kbmap->bind("~C-~S-~M-nobreakspace", LFUN_PROTECTEDSPACE);
352 kbmap->bind("Delete", LFUN_DELETE);
353 kbmap->bind("BackSpace", LFUN_BACKSPACE);
355 // sub- and superscript -MV
356 kbmap->bind("~S-underscore", LFUN_SUBSCRIPT);
357 kbmap->bind("~S-asciicircum", LFUN_SUPERSCRIPT);
359 // kbmap->bindings to enable the use of the numeric keypad
361 //kbmap->bind("KP_0", LFUN_SELFINSERT);
362 //kbmap->bind("KP_Decimal", LFUN_SELFINSERT);
363 kbmap->bind("KP_Enter", LFUN_BREAKPARAGRAPH);
364 //kbmap->bind("KP_1", LFUN_SELFINSERT);
365 //kbmap->bind("KP_2", LFUN_SELFINSERT);
366 //kbmap->bind("KP_3", LFUN_SELFINSERT);
367 //kbmap->bind("KP_4", LFUN_SELFINSERT);
368 //kbmap->bind("KP_5", LFUN_SELFINSERT);
369 //kbmap->bind("KP_6", LFUN_SELFINSERT);
370 //kbmap->bind("KP_Add", LFUN_SELFINSERT);
371 //kbmap->bind("KP_7", LFUN_SELFINSERT);
372 //kbmap->bind("KP_8", LFUN_SELFINSERT);
373 //kbmap->bind("KP_9", LFUN_SELFINSERT);
374 //kbmap->bind("KP_Divide", LFUN_SELFINSERT);
375 //kbmap->bind("KP_Multiply", LFUN_SELFINSERT);
376 //kbmap->bind("KP_Subtract", LFUN_SELFINSERT);
377 kbmap->bind("KP_Right", LFUN_RIGHT);
378 kbmap->bind("KP_Left", LFUN_LEFT);
379 kbmap->bind("KP_Up", LFUN_UP);
380 kbmap->bind("KP_Down", LFUN_DOWN);
381 kbmap->bind("KP_Home", LFUN_HOME);
382 kbmap->bind("KP_End", LFUN_END);
383 kbmap->bind("KP_Prior", LFUN_PRIOR);
384 kbmap->bind("KP_Next", LFUN_NEXT);
386 kbmap->bind("C-Tab", LFUN_CELL_SPLIT); // ale970515
387 kbmap->bind("S-Tab", LFUN_CELL_BACKWARD); // jug20000522
388 kbmap->bind("S-ISO_Left_Tab", LFUN_CELL_BACKWARD); // jbl 2001-23-02
392 void LyX::emergencyCleanup()
394 // what to do about tmpfiles is non-obvious. we would
395 // like to delete any we find, but our lyxdir might
396 // contain documents etc. which might be helpful on
399 bufferlist.emergencyWriteAll();
401 lyxserver->emergencyCleanup();
405 void LyX::deadKeyBindings(kb_keymap * kbmap)
407 // bindKeyings for transparent handling of deadkeys
408 // The keysyms are gotten from XFree86 X11R6
409 kbmap->bind("~C-~S-~M-dead_acute", LFUN_ACUTE);
410 kbmap->bind("~C-~S-~M-dead_breve", LFUN_BREVE);
411 kbmap->bind("~C-~S-~M-dead_caron", LFUN_CARON);
412 kbmap->bind("~C-~S-~M-dead_cedilla", LFUN_CEDILLA);
413 kbmap->bind("~C-~S-~M-dead_abovering", LFUN_CIRCLE);
414 kbmap->bind("~C-~S-~M-dead_circumflex", LFUN_CIRCUMFLEX);
415 kbmap->bind("~C-~S-~M-dead_abovedot", LFUN_DOT);
416 kbmap->bind("~C-~S-~M-dead_grave", LFUN_GRAVE);
417 kbmap->bind("~C-~S-~M-dead_doubleacute", LFUN_HUNG_UMLAUT);
418 kbmap->bind("~C-~S-~M-dead_macron", LFUN_MACRON);
419 // nothing with this name
420 // kbmap->bind("~C-~S-~M-dead_special_caron", LFUN_SPECIAL_CARON);
421 kbmap->bind("~C-~S-~M-dead_tilde", LFUN_TILDE);
422 kbmap->bind("~C-~S-~M-dead_diaeresis", LFUN_UMLAUT);
423 // nothing with this name either...
424 //kbmap->bind("~C-~S-~M-dead_underbar", LFUN_UNDERBAR);
425 kbmap->bind("~C-~S-~M-dead_belowdot", LFUN_UNDERDOT);
426 kbmap->bind("~C-~S-~M-dead_tie", LFUN_TIE);
427 kbmap->bind("~C-~S-~M-dead_ogonek", LFUN_OGONEK);
431 void LyX::queryUserLyXDir(bool explicit_userdir)
433 string const configure_script = AddName(system_lyxdir(), "configure");
435 // Does user directory exist?
436 FileInfo fileInfo(user_lyxdir());
437 if (fileInfo.isOK() && fileInfo.isDir()) {
439 FileInfo script(configure_script);
440 FileInfo defaults(AddName(user_lyxdir(), "lyxrc.defaults"));
441 if (defaults.isOK() && script.isOK()
442 && defaults.getModificationTime() < script.getModificationTime()) {
443 lyxerr << _("LyX: reconfiguring user directory")
445 Path p(user_lyxdir());
446 ::system(configure_script.c_str());
447 lyxerr << "LyX: " << _("Done!") << endl;
452 first_start = !explicit_userdir;
454 lyxerr << bformat(_("LyX: Creating directory %1$s"
455 " and running configure..."), user_lyxdir()) << endl;
457 if (!createDirectory(user_lyxdir(), 0755)) {
458 // Failed, let's use $HOME instead.
459 user_lyxdir(GetEnvPath("HOME"));
460 lyxerr << bformat(_("Failed. Will use %1$s instead."),
461 user_lyxdir()) << endl;
465 // Run configure in user lyx directory
466 Path p(user_lyxdir());
467 ::system(configure_script.c_str());
468 lyxerr << "LyX: " << _("Done!") << endl;
472 void LyX::readRcFile(string const & name)
474 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
476 string const lyxrc_path = LibFileSearch(string(), name);
477 if (!lyxrc_path.empty()) {
479 lyxerr[Debug::INIT] << "Found " << name
480 << " in " << lyxrc_path << endl;
482 if (lyxrc.read(lyxrc_path) >= 0)
490 // Read the ui file `name'
491 void LyX::readUIFile(string const & name)
501 struct keyword_item uitags[ui_last - 1] = {
502 { "include", ui_include },
503 { "menuset", ui_menuset },
504 { "toolbar", ui_toolbar },
505 { "toolbars", ui_toolbars }
508 // Ensure that a file is read only once (prevents include loops)
509 static std::list<string> uifiles;
510 std::list<string>::const_iterator it = uifiles.begin();
511 std::list<string>::const_iterator end = uifiles.end();
512 it = std::find(it, end, name);
514 lyxerr[Debug::INIT] << "UI file '" << name
515 << "' has been read already. "
516 << "Is this an include loop?"
521 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
523 string const ui_path = LibFileSearch("ui", name, "ui");
525 if (ui_path.empty()) {
526 lyxerr[Debug::INIT] << "Could not find " << name << endl;
530 uifiles.push_back(name);
532 lyxerr[Debug::INIT] << "Found " << name
533 << " in " << ui_path << endl;
534 LyXLex lex(uitags, ui_last - 1);
535 lex.setFile(ui_path);
537 lyxerr << "Unable to set LyXLeX for ui file: " << ui_path
541 if (lyxerr.debugging(Debug::PARSER))
542 lex.printTable(lyxerr);
548 string const file = lex.getString();
553 menubackend.read(lex);
557 toolbarbackend.read(lex);
561 toolbarbackend.readToolbars(lex);
565 if (!rtrim(lex.getString()).empty())
566 lex.printError("LyX::ReadUIFile: "
567 "Unknown menu tag: `$$Token'");
574 // Read the languages file `name'
575 void LyX::readLanguagesFile(string const & name)
577 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
579 string const lang_path = LibFileSearch(string(), name);
580 if (lang_path.empty()) {
584 languages.read(lang_path);
588 // Read the encodings file `name'
589 void LyX::readEncodingsFile(string const & name)
591 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
593 string const enc_path = LibFileSearch(string(), name);
594 if (enc_path.empty()) {
598 encodings.read(enc_path);
607 /// return the the number of arguments consumed
608 typedef boost::function<int(string const &, string const &)> cmd_helper;
610 int parse_dbg(string const & arg, string const &)
613 lyxerr << _("List of supported debug flags:") << endl;
614 Debug::showTags(lyxerr);
617 lyxerr << bformat(_("Setting debug level to %1$s"), arg) << endl;
619 lyxerr.level(Debug::value(arg));
620 Debug::showLevel(lyxerr, lyxerr.level());
625 int parse_help(string const &, string const &)
628 _("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
629 "Command line switches (case sensitive):\n"
630 "\t-help summarize LyX usage\n"
631 "\t-userdir dir try to set user directory to dir\n"
632 "\t-sysdir dir try to set system directory to dir\n"
633 "\t-geometry WxH+X+Y set geometry of the main window\n"
634 "\t-dbg feature[,feature]...\n"
635 " select the features to debug.\n"
636 " Type `lyx -dbg' to see the list of features\n"
637 "\t-x [--execute] command\n"
638 " where command is a lyx command.\n"
639 "\t-e [--export] fmt\n"
640 " where fmt is the export format of choice.\n"
641 "\t-i [--import] fmt file.xxx\n"
642 " where fmt is the import format of choice\n"
643 " and file.xxx is the file to be imported.\n"
644 "\t-version summarize version and build info\n"
645 "Check the LyX man page for more details.") << endl;
650 int parse_version(string const &, string const &)
652 lyxerr << "LyX " << lyx_version
653 << " of " << lyx_release_date << endl;
654 lyxerr << "Built on " << __DATE__ << ", " << __TIME__ << endl;
656 lyxerr << lyx_version_info << endl;
661 int parse_sysdir(string const & arg, string const &)
664 lyxerr << _("Missing directory for -sysdir switch") << endl;
671 int parse_userdir(string const & arg, string const &)
674 lyxerr << _("Missing directory for -userdir switch") << endl;
681 int parse_execute(string const & arg, string const &)
684 lyxerr << _("Missing command string after --execute switch") << endl;
688 // Argh. Setting gui to false segfaults..
689 // FIXME: when ? how ?
694 int parse_export(string const & type, string const &)
697 lyxerr << _("Missing file type [eg latex, ps...] after "
698 "--export switch") << endl;
701 batch = "buffer-export " + type;
706 int parse_import(string const & type, string const & file)
709 lyxerr << _("Missing file type [eg latex, ps...] after "
710 "--import switch") << endl;
714 lyxerr << _("Missing filename for --import") << endl;
718 batch = "buffer-import " + type + ' ' + file;
725 bool LyX::easyParse(int & argc, char * argv[])
727 std::map<string, cmd_helper> cmdmap;
729 cmdmap["-dbg"] = parse_dbg;
730 cmdmap["-help"] = parse_help;
731 cmdmap["--help"] = parse_help;
732 cmdmap["-version"] = parse_version;
733 cmdmap["--version"] = parse_version;
734 cmdmap["-sysdir"] = parse_sysdir;
735 cmdmap["-userdir"] = parse_userdir;
736 cmdmap["-x"] = parse_execute;
737 cmdmap["--execute"] = parse_execute;
738 cmdmap["-e"] = parse_export;
739 cmdmap["--export"] = parse_export;
740 cmdmap["-i"] = parse_import;
741 cmdmap["--import"] = parse_import;
743 for (int i = 1; i < argc; ++i) {
744 std::map<string, cmd_helper>::const_iterator it
745 = cmdmap.find(argv[i]);
747 // don't complain if not found - may be parsed later
748 if (it == cmdmap.end())
751 string arg((i + 1 < argc) ? argv[i + 1] : "");
752 string arg2((i + 2 < argc) ? argv[i + 2] : "");
754 int const remove = 1 + it->second(arg, arg2);
756 // Now, remove used arguments by shifting
757 // the following ones remove places down.
759 for (int j = i; j < argc; ++j)
760 argv[j] = argv[j + remove];
764 batch_command = batch;