1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2000 The LyX Team.
9 * ====================================================== */
17 #pragma implementation
25 #include "lyx_gui_misc.h"
27 #include "support/path.h"
28 #include "support/filetools.h"
29 #include "bufferlist.h"
31 #include "support/FileInfo.h"
32 #include "lastfiles.h"
34 #include "lyxserver.h"
38 #include "MenuBackend.h"
39 #include "ToolbarDefaults.h"
42 #include "converter.h"
44 #include "support/os.h"
48 #ifndef CXX_GLOBAL_CSTD
52 extern void LoadLyXFile(string const &);
53 extern void QuitLyX();
57 string system_tempdir;
58 string user_lyxdir; // Default $HOME/.lyx
60 // Should this be kept global? Asger says Yes.
63 LastFiles * lastfiles;
65 // This is the global bufferlist object
66 BufferList bufferlist;
68 LyXServer * lyxserver = 0;
69 // this should be static, but I need it in buffer.C
70 bool finished = false; // flag, that we are quitting the program
72 // convenient to have it here.
73 boost::scoped_ptr<kb_keymap> toplevel_keymap;
76 LyX::LyX(int * argc, char * argv[])
78 // Prevent crash with --help
82 // Here we need to parse the command line. At least
83 // we need to parse for "-dbg" and "-help"
84 bool gui = easyParse(argc, argv);
86 // Global bindings (this must be done as early as possible.) (Lgb)
87 toplevel_keymap.reset(new kb_keymap);
88 defaultKeyBindings(toplevel_keymap.get());
90 // Make the GUI object, and let it take care of the
91 // command line arguments that concerns it.
92 lyxerr[Debug::INIT] << "Initializing LyXGUI..." << endl;
93 lyxGUI = new LyXGUI(this, argc, argv, gui);
94 lyxerr[Debug::INIT] << "Initializing LyXGUI...done" << endl;
96 // Now the GUI and LyX have taken care of their arguments, so
97 // the only thing left on the command line should be
98 // filenames. Let's check anyway.
99 for (int argi = 1; argi < *argc ; ++argi) {
100 if (argv[argi][0] == '-') {
101 lyxerr << _("Wrong command line option `")
103 << _("'. Exiting.") << endl;
108 // Initialization of LyX (reads lyxrc and more)
109 lyxerr[Debug::INIT] << "Initializing LyX::init..." << endl;
111 lyxerr[Debug::INIT] << "Initializing LyX::init...done" << endl;
115 // Load the files specified in the command line.
117 lyxerr[Debug::INFO] << "Opening document..." << endl;
118 else if ((*argc) > 2)
119 lyxerr[Debug::INFO] << "Opening documents..." << endl;
121 Buffer * last_loaded = 0;
123 for (int argi = (*argc) - 1; argi >= 1; --argi) {
124 Buffer * loadb = bufferlist.loadLyXFile(argv[argi]);
131 string splash = i18nLibFileSearch("examples", "splash.lyx");
132 lyxerr[Debug::INIT] << "Opening splash document "
133 << splash << "..." << endl;
134 Buffer * loadb = bufferlist.loadLyXFile(splash);
140 if (last_loaded != 0) {
141 lyxerr[Debug::INIT] << "Yes we loaded some files." << endl;
143 lyxGUI->regBuf(last_loaded);
146 // Execute batch commands if available
147 if (!batch_command.empty()) {
148 lyxerr << "About to handle -x '"
149 << batch_command << "'" << endl;
151 // no buffer loaded, create one
153 last_loaded = bufferlist.newFile("tmpfile", string());
155 // try to dispatch to last loaded buffer first
156 bool dispatched = last_loaded->Dispatch(batch_command);
158 // if this was successful, return.
159 // Maybe we could do something more clever than aborting...
161 lyxerr << "We are done!" << endl;
166 // otherwise, let the GUI handle the batch command
167 lyxGUI->regBuf(last_loaded);
168 lyxGUI->getLyXView()->getLyXFunc()->Dispatch(batch_command);
173 // Let the ball begin...
178 // A destructor is always necessary (asierra-970604)
186 extern "C" void error_handler(int err_sig);
188 void LyX::init(bool gui)
190 // Install the signal handlers
191 signal(SIGHUP, error_handler);
192 signal(SIGFPE, error_handler);
193 signal(SIGSEGV, error_handler);
194 signal(SIGINT, error_handler);
195 signal(SIGTERM, error_handler);
198 // Determine path of binary
202 string binpath = os::binpath();
203 string binname = os::binname();
204 fullbinpath = binpath;
206 if (binpath.empty()) {
207 lyxerr << _("Warning: could not determine path of binary.")
209 << _("If you have problems, try starting LyX with an absolute path.")
212 lyxerr[Debug::INIT] << "Path of binary: " << binpath << endl;
215 // Determine system directory.
218 // Directories are searched in this order:
219 // 1) -sysdir command line parameter
220 // 2) LYX_DIR_11x environment variable
221 // 3) Maybe <path of binary>/TOP_SRCDIR/lib
222 // 4) <path of binary>/../share/<name of binary>/
223 // 4a) repeat 4 after following the Symlink if <path of
224 // binary> is a symbolic link.
225 // 5) hardcoded lyx_dir
226 // The directory is checked for the presence of the file
227 // "chkconfig.ltx", and if that is present, the directory
228 // is accepted as the system directory.
229 // If no chkconfig.ltx file is found, a warning is given,
230 // and the hardcoded lyx_dir is used.
232 // If we had a command line switch, system_lyxdir is already set
234 if (!system_lyxdir.empty())
235 searchpath= MakeAbsPath(system_lyxdir) + ';';
237 // LYX_DIR_11x environment variable
238 string lyxdir = GetEnvPath("LYX_DIR_11x");
240 if (!lyxdir.empty()) {
241 lyxerr[Debug::INIT] << "LYX_DIR_11x: " << lyxdir << endl;
242 searchpath += lyxdir + ';';
245 // <path of binary>/TOP_SRCDIR/lib
246 build_lyxdir = MakeAbsPath("../lib", binpath);
247 if (!FileSearch(build_lyxdir, "lyxrc.defaults").empty()) {
248 searchpath += MakeAbsPath(AddPath(TOP_SRCDIR, "lib"),
250 lyxerr[Debug::INIT] << "Checking whether LyX is run in "
251 "place... yes" << endl;
254 << "Checking whether LyX is run in place... no"
256 build_lyxdir.erase();
261 // Path of binary/../share/name of binary/
262 searchpath += NormalizePath(AddPath(binpath, "../share/") +
263 OnlyFilename(binname)) + ';';
266 FileInfo file(fullbinpath, true);
267 FollowLink = file.isLink();
270 if (LyXReadLink(fullbinpath, Link)) {
272 binpath = MakeAbsPath(OnlyPath(fullbinpath));
278 } while (FollowLink);
281 searchpath += LYX_DIR;
283 // If debugging, show complete search path
284 lyxerr[Debug::INIT] << "System directory search path: "
285 << searchpath << endl;
287 string const filename = "chkconfig.ltx";
288 string temp = FileOpenSearch(searchpath, filename, string());
289 system_lyxdir = OnlyPath(temp);
291 // Reduce "path/../path" stuff out of system directory
292 system_lyxdir = NormalizePath(system_lyxdir);
294 bool path_shown = false;
296 // Warn if environment variable is set, but unusable
297 if (!lyxdir.empty()) {
298 if (system_lyxdir != NormalizePath(lyxdir)) {
299 lyxerr <<_("LYX_DIR_11x environment variable no good.")
301 << _("System directory set to: ")
302 << system_lyxdir << endl;
307 // Warn the user if we couldn't find "chkconfig.ltx"
308 if (system_lyxdir == "./") {
309 lyxerr <<_("LyX Warning! Couldn't determine system directory. ")
310 <<_("Try the '-sysdir' command line parameter or ")
311 <<_("set the environment variable LYX_DIR_11x to the "
312 "LyX system directory ")
313 << _("containing the file `chkconfig.ltx'.") << endl;
315 lyxerr << _("Using built-in default ")
316 << LYX_DIR << _(" but expect problems.")
319 lyxerr << _("Expect problems.") << endl;
320 system_lyxdir = LYX_DIR;
324 // Report the system directory if debugging is on
326 lyxerr[Debug::INIT] << "System directory: '"
327 << system_lyxdir << '\'' << endl;
330 // Determine user lyx-dir
333 // Directories are searched in this order:
334 // 1) -userdir command line parameter
335 // 2) LYX_USERDIR_11x environment variable
336 // 3) $HOME/.<name of binary>
338 // If we had a command line switch, user_lyxdir is already set
339 bool explicit_userdir = true;
340 if (user_lyxdir.empty()) {
342 // LYX_USERDIR_11x environment variable
343 user_lyxdir = GetEnvPath("LYX_USERDIR_11x");
346 if (user_lyxdir.empty())
347 user_lyxdir = AddPath(GetEnvPath("HOME"),
348 string(".") + PACKAGE);
349 explicit_userdir = false;
352 lyxerr[Debug::INIT] << "User LyX directory: '"
353 << user_lyxdir << '\'' << endl;
355 // Check that user LyX directory is ok. We don't do that if
356 // running in batch mode.
358 queryUserLyXDir(explicit_userdir);
363 // Shine up lyxrc defaults
366 // Default template path: system_dir/templates
367 if (lyxrc.template_path.empty()){
368 lyxrc.template_path = AddPath(system_lyxdir, "templates");
371 // Default lastfiles file: $HOME/.lyx/lastfiles
372 if (lyxrc.lastfiles.empty()){
373 lyxrc.lastfiles = AddName(user_lyxdir, "lastfiles");
376 // Disable gui when either lyxrc or easyparse says so
378 lyxrc.use_gui = false;
380 // Calculate screen dpi as average of x-DPI and y-DPI:
382 lyxrc.dpi = getScreenDPI();
383 lyxerr[Debug::INIT] << "DPI setting detected to be "
384 << lyxrc.dpi + 0.5 << endl;
386 lyxrc.dpi = 1; // I hope this is safe
390 // Read configuration files
393 ReadRcFile("lyxrc.defaults");
394 system_lyxrc = lyxrc;
395 system_formats = formats;
396 system_converters = converters;
397 system_lcolor = lcolor;
399 // If there is a preferences file we read that instead
400 // of the old lyxrc file.
401 if (!ReadRcFile("preferences"))
405 ReadEncodingsFile("encodings");
407 ReadLanguagesFile("languages");
410 lyxerr[Debug::INIT] << "Reading layouts..." << endl;
413 // Ensure that we have really read a bind file, so that LyX is
415 lyxrc.readBindFileIfNeeded();
418 ReadUIFile(lyxrc.ui_file);
420 // Bind the X dead keys to the corresponding LyX functions if
422 if (lyxrc.override_x_deadkeys)
423 deadKeyBindings(toplevel_keymap.get());
425 if (lyxerr.debugging(Debug::LYXRC)) {
429 // Create temp directory
430 os::setTmpDir(CreateLyXTmpDir(lyxrc.tempdir_path));
431 system_tempdir = os::getTmpDir();
432 if (lyxerr.debugging(Debug::INIT)) {
433 lyxerr << "LyX tmp dir: `" << system_tempdir << '\'' << endl;
436 // load the lastfiles mini-database
437 lyxerr[Debug::INIT] << "Reading lastfiles `"
438 << lyxrc.lastfiles << "'..." << endl;
439 lastfiles = new LastFiles(lyxrc.lastfiles,
440 lyxrc.check_lastfiles,
441 lyxrc.num_lastfiles);
443 // start up the lyxserver. (is this a bit early?) (Lgb)
444 // 0.12 this will be way to early, we need the GUI to be initialized
445 // first, so move it for now.
446 // lyxserver = new LyXServer;
450 // These are the default bindings known to LyX
451 void LyX::defaultKeyBindings(kb_keymap * kbmap)
453 kbmap->bind("Right", LFUN_RIGHT);
454 kbmap->bind("Left", LFUN_LEFT);
455 kbmap->bind("Up", LFUN_UP);
456 kbmap->bind("Down", LFUN_DOWN);
458 kbmap->bind("Tab", LFUN_TAB);
459 kbmap->bind("ISO_Left_Tab", LFUN_TAB); // jbl 2001-23-02
461 kbmap->bind("Home", LFUN_HOME);
462 kbmap->bind("End", LFUN_END);
463 kbmap->bind("Prior", LFUN_PRIOR);
464 kbmap->bind("Next", LFUN_NEXT);
466 kbmap->bind("Return", LFUN_BREAKPARAGRAPH);
467 kbmap->bind("~C-~S-~M-nobreakspace", LFUN_PROTECTEDSPACE);
469 kbmap->bind("Delete", LFUN_DELETE);
470 kbmap->bind("BackSpace", LFUN_BACKSPACE);
472 // kbmap->bindings to enable the use of the numeric keypad
474 kbmap->bind("KP_0", LFUN_SELFINSERT);
475 kbmap->bind("KP_Decimal", LFUN_SELFINSERT);
476 kbmap->bind("KP_Enter", LFUN_SELFINSERT);
477 kbmap->bind("KP_1", LFUN_SELFINSERT);
478 kbmap->bind("KP_2", LFUN_SELFINSERT);
479 kbmap->bind("KP_3", LFUN_SELFINSERT);
480 kbmap->bind("KP_4", LFUN_SELFINSERT);
481 kbmap->bind("KP_5", LFUN_SELFINSERT);
482 kbmap->bind("KP_6", LFUN_SELFINSERT);
483 kbmap->bind("KP_Add", LFUN_SELFINSERT);
484 kbmap->bind("KP_7", LFUN_SELFINSERT);
485 kbmap->bind("KP_8", LFUN_SELFINSERT);
486 kbmap->bind("KP_9", LFUN_SELFINSERT);
487 kbmap->bind("KP_Divide", LFUN_SELFINSERT);
488 kbmap->bind("KP_Multiply", LFUN_SELFINSERT);
489 kbmap->bind("KP_Subtract", LFUN_SELFINSERT);
491 /* Most self-insert keys are handled in the 'default:' section of
492 * WorkAreaKeyPress - so we don't have to define them all.
493 * However keys explicit decleared as self-insert are
494 * handled seperatly (LFUN_SELFINSERT.) Lgb. */
496 kbmap->bind("C-Tab", LFUN_TABINSERT); // ale970515
497 kbmap->bind("S-Tab", LFUN_SHIFT_TAB); // jug20000522
498 kbmap->bind("S-ISO_Left_Tab", LFUN_SHIFT_TAB); // jbl 2001-23-02
502 // LyX can optionally take over the handling of deadkeys
503 void LyX::deadKeyBindings(kb_keymap * kbmap)
505 // bindKeyings for transparent handling of deadkeys
506 // The keysyms are gotten from XFree86 X11R6
507 kbmap->bind("~C-~S-~M-dead_acute", LFUN_ACUTE);
508 kbmap->bind("~C-~S-~M-dead_breve", LFUN_BREVE);
509 kbmap->bind("~C-~S-~M-dead_caron", LFUN_CARON);
510 kbmap->bind("~C-~S-~M-dead_cedilla", LFUN_CEDILLA);
511 kbmap->bind("~C-~S-~M-dead_abovering", LFUN_CIRCLE);
512 kbmap->bind("~C-~S-~M-dead_circumflex", LFUN_CIRCUMFLEX);
513 kbmap->bind("~C-~S-~M-dead_abovedot", LFUN_DOT);
514 kbmap->bind("~C-~S-~M-dead_grave", LFUN_GRAVE);
515 kbmap->bind("~C-~S-~M-dead_doubleacute", LFUN_HUNG_UMLAUT);
516 kbmap->bind("~C-~S-~M-dead_macron", LFUN_MACRON);
517 // nothing with this name
518 // kbmap->bind("~C-~S-~M-dead_special_caron", LFUN_SPECIAL_CARON);
519 kbmap->bind("~C-~S-~M-dead_tilde", LFUN_TILDE);
520 kbmap->bind("~C-~S-~M-dead_diaeresis", LFUN_UMLAUT);
521 // nothing with this name either...
522 //kbmap->bind("~C-~S-~M-dead_underbar", LFUN_UNDERBAR);
523 kbmap->bind("~C-~S-~M-dead_belowdot", LFUN_UNDERDOT);
524 kbmap->bind("~C-~S-~M-dead_tie", LFUN_TIE);
525 kbmap->bind("~C-~S-~M-dead_ogonek", LFUN_OGONEK);
529 // This one is not allowed to use anything on the main form, since that
530 // one does not exist yet. (Asger)
531 void LyX::queryUserLyXDir(bool explicit_userdir)
533 // Does user directory exist?
534 FileInfo fileInfo(user_lyxdir);
535 if (fileInfo.isOK() && fileInfo.isDir()) {
543 // Different wording if the user specifically requested a directory
544 if (!AskQuestion( explicit_userdir
545 ? _("You have specified an invalid LyX directory.")
546 : _("You don't have a personal LyX directory.") ,
548 _("It is needed to keep your own configuration."),
549 _("Should I try to set it up for you (recommended)?"))) {
550 lyxerr << _("Running without personal LyX directory.") << endl;
551 // No, let's use $HOME instead.
552 user_lyxdir = GetEnvPath("HOME");
556 // Tell the user what is going on
557 lyxerr << _("LyX: Creating directory ") << user_lyxdir
558 << _(" and running configure...") << endl;
560 // Create directory structure
561 if (!createDirectory(user_lyxdir, 0755)) {
562 // Failed, let's use $HOME instead.
563 user_lyxdir = GetEnvPath("HOME");
564 lyxerr << _("Failed. Will use ") << user_lyxdir
565 << _(" instead.") << endl;
569 // Run configure in user lyx directory
571 ::system(AddName(system_lyxdir, "configure").c_str());
572 lyxerr << "LyX: " << _("Done!") << endl;
576 // Read the rc file `name'
577 bool LyX::ReadRcFile(string const & name)
579 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
581 string lyxrc_path = LibFileSearch(string(), name);
582 if (!lyxrc_path.empty()){
583 lyxerr[Debug::INIT] << "Found " << name
584 << " in " << lyxrc_path << endl;
585 if (lyxrc.read(lyxrc_path) < 0) {
586 WriteAlert(_("LyX Warning!"),
587 _("Error while reading ")+lyxrc_path+".",
588 _("Using built-in defaults."));
593 lyxerr[Debug::INIT] << "Could not find " << name << endl;
598 // Read the ui file `name'
599 void LyX::ReadUIFile(string const & name)
607 struct keyword_item uitags[ui_last-1] = {
608 { "menuset", ui_menuset },
609 { "toolbar", ui_toolbar }
612 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
614 string ui_path = LibFileSearch("ui", name, "ui");
616 if (ui_path.empty()) {
617 lyxerr[Debug::INIT] << "Could not find " << name << endl;
618 menubackend.defaults();
622 lyxerr[Debug::INIT] << "Found " << name
623 << " in " << ui_path << endl;
624 LyXLex lex(uitags, ui_last - 1);
625 lex.setFile(ui_path);
627 lyxerr << "Unable to set LyXLeX for ui file: " << ui_path
631 if (lyxerr.debugging(Debug::PARSER))
632 lex.printTable(lyxerr);
637 menubackend.read(lex);
641 toolbardefaults.read(lex);
645 if(!strip(lex.GetString()).empty())
646 lex.printError("LyX::ReadUIFile: "
647 "Unknown menu tag: `$$Token'");
654 // Read the languages file `name'
655 void LyX::ReadLanguagesFile(string const & name)
657 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
659 string lang_path = LibFileSearch(string(), name);
660 if (lang_path.empty()) {
661 lyxerr[Debug::INIT] << "Could not find " << name << endl;
662 languages.setDefaults();
665 languages.read(lang_path);
669 // Read the encodings file `name'
670 void LyX::ReadEncodingsFile(string const & name)
672 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
674 string enc_path = LibFileSearch(string(), name);
675 if (enc_path.empty()) {
676 lyxerr[Debug::INIT] << "Could not find " << name << endl;
679 encodings.read(enc_path);
685 // Set debugging level and report result to user
686 void setDebuggingLevel(string const & dbgLevel)
688 lyxerr << _("Setting debug level to ") << dbgLevel << endl;
689 lyxerr.level(Debug::value(dbgLevel));
690 Debug::showLevel(lyxerr, lyxerr.level());
694 // Give command line help
695 void commandLineHelp()
697 lyxerr << "LyX " LYX_VERSION << " of " LYX_RELEASE << endl;
699 _("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
700 "Command line switches (case sensitive):\n"
701 "\t-help summarize LyX usage\n"
702 "\t-userdir dir try to set user directory to dir\n"
703 "\t-sysdir dir try to set system directory to dir\n"
704 "\t-geometry WxH+X+Y set geometry of the main window\n"
705 "\t-dbg feature[,feature]...\n"
706 " select the features to debug.\n"
707 " Type `lyx -dbg' to see the list of features\n"
708 "\t-x [--execute] command\n"
709 " where command is a lyx command.\n"
710 "\t-e [--export] fmt\n"
711 " where fmt is the export format of choice.\n"
712 "\t-i [--import] fmt file.xxx\n"
713 " where fmt is the import format of choice\n"
714 " and file.xxx is the file to be imported.\n"
715 "Check the LyX man page for more details.") << endl;
721 bool LyX::easyParse(int * argc, char * argv[])
724 int removeargs = 0; // used when options are read
725 for (int i = 1; i < *argc; ++i) {
726 string arg = argv[i];
728 // Check for -dbg int
731 setDebuggingLevel(argv[i + 1]);
734 lyxerr << _("List of supported debug flags:")
736 Debug::showTags(lyxerr);
740 // Check for "-sysdir"
741 else if (arg == "-sysdir") {
743 system_lyxdir = argv[i + 1];
746 lyxerr << _("Missing directory for -sysdir switch!")
751 // Check for "-userdir"
752 else if (arg == "-userdir") {
754 user_lyxdir = argv[i + 1];
757 lyxerr << _("Missing directory for -userdir switch!")
762 // Check for --help or -help
763 else if (arg == "--help" || arg == "-help") {
767 // Check for "-nw": No XWindows as for emacs this should
768 // give a LyX that could be used in a terminal window.
769 //else if (arg == "-nw") {
773 // Check for "-x": Execute commands
774 else if (arg == "-x" || arg == "--execute") {
776 batch_command = string(argv[i + 1]);
780 lyxerr << _("Missing command string after -x switch!") << endl;
782 // Argh. Setting gui to false segfaults..
786 else if (arg == "-e" || arg == "--export") {
788 string type(argv[i+1]);
790 batch_command = "buffer-export " + type;
793 lyxerr << _("Missing file type [eg latex, "
795 << arg << _(" switch!") << endl;
797 else if (arg == "-i" || arg == "--import") {
799 string type(argv[i+1]);
800 string file(argv[i+2]);
803 batch_command = "buffer-import " + type + " " + file;
804 lyxerr << "batch_command: "
805 << batch_command << endl;
808 lyxerr << _("Missing type [eg latex, "
810 << arg << _(" switch!") << endl;
813 if (removeargs > 0) {
814 // Now, remove used arguments by shifting
815 // the following ones removeargs places down.
816 (*argc) -= removeargs;
817 for (int j = i; j < (*argc); ++j)
818 argv[j] = argv[j + removeargs];
819 --i; // After shift, check this number again.
830 void error_handler(int err_sig)
834 lyxerr << "\nlyx: SIGHUP signal caught" << endl;
840 lyxerr << "\nlyx: SIGFPE signal caught" << endl;
843 lyxerr << "\nlyx: SIGSEGV signal caught" << endl;
845 "Sorry, you have found a bug in LyX."
846 " If possible, please read 'Known bugs'\n"
847 "under the Help menu and then send us "
848 "a full bug report. Thanks!" << endl;
855 // Deinstall the signal handlers
856 signal(SIGHUP, SIG_DFL);
857 signal(SIGINT, SIG_DFL);
858 signal(SIGFPE, SIG_DFL);
859 signal(SIGSEGV, SIG_DFL);
860 signal(SIGTERM, SIG_DFL);
862 bufferlist.emergencyWriteAll();
864 lyxerr << "Bye." << endl;
865 if (err_sig!= SIGHUP &&
866 (!GetEnv("LYXDEBUG").empty() || err_sig == SIGSEGV))