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"
46 extern void LoadLyXFile(string const &);
47 extern void QuitLyX();
51 string system_tempdir;
52 string user_lyxdir; // Default $HOME/.lyx
54 // Should this be kept global? Asger says Yes.
57 LastFiles * lastfiles;
59 // This is the global bufferlist object
60 BufferList bufferlist;
62 LyXServer * lyxserver = 0;
63 // this should be static, but I need it in buffer.C
64 bool finished = false; // flag, that we are quitting the program
66 // convenient to have it here.
67 kb_keymap * toplevel_keymap;
70 LyX::LyX(int * argc, char * argv[])
72 // Prevent crash with --help
76 // Here we need to parse the command line. At least
77 // we need to parse for "-dbg" and "-help"
78 bool gui = easyParse(argc, argv);
80 // Global bindings (this must be done as early as possible.) (Lgb)
81 toplevel_keymap = new kb_keymap;
82 defaultKeyBindings(toplevel_keymap);
84 // Make the GUI object, and let it take care of the
85 // command line arguments that concerns it.
86 lyxerr[Debug::INIT] << "Initializing LyXGUI..." << endl;
87 lyxGUI = new LyXGUI(this, argc, argv, gui);
88 lyxerr[Debug::INIT] << "Initializing LyXGUI...done" << endl;
90 // Now the GUI and LyX have taken care of their arguments, so
91 // the only thing left on the command line should be
92 // filenames. Let's check anyway.
93 for (int argi = 1; argi < *argc ; ++argi) {
94 if (argv[argi][0] == '-') {
95 lyxerr << _("Wrong command line option `")
97 << _("'. Exiting.") << endl;
102 // Initialization of LyX (reads lyxrc and more)
103 lyxerr[Debug::INIT] << "Initializing LyX::init..." << endl;
104 init(argc, argv, gui);
105 lyxerr[Debug::INIT] << "Initializing LyX::init...done" << endl;
109 // Load the files specified in the command line.
111 lyxerr[Debug::INFO] << "Opening document..." << endl;
112 else if ((*argc) > 2)
113 lyxerr[Debug::INFO] << "Opening documents..." << endl;
115 Buffer * last_loaded = 0;
117 for (int argi = (*argc) - 1; argi >= 1; --argi) {
118 Buffer * loadb = bufferlist.loadLyXFile(argv[argi]);
125 string splash = i18nLibFileSearch("examples", "splash.lyx");
126 lyxerr[Debug::INIT] << "Opening splash document "
127 << splash << "..." << endl;
128 Buffer * loadb = bufferlist.loadLyXFile(splash);
134 if (last_loaded != 0) {
135 lyxerr[Debug::INIT] << "Yes we loaded some files." << endl;
137 lyxGUI->regBuf(last_loaded);
140 // Execute batch commands if available
141 if (!batch_command.empty()) {
142 lyxerr << "About to handle -x '"
143 << batch_command << "'" << endl;
145 // no buffer loaded, create one
147 last_loaded = bufferlist.newFile("tmpfile", string());
149 // try to dispatch to last loaded buffer first
150 bool dispatched = last_loaded->Dispatch(batch_command);
152 // if this was successful, return.
153 // Maybe we could do something more clever than aborting...
155 lyxerr << "We are done!" << endl;
160 // otherwise, let the GUI handle the batch command
161 lyxGUI->regBuf(last_loaded);
162 lyxGUI->getLyXView()->getLyXFunc()->Dispatch(batch_command);
167 // Let the ball begin...
172 // A destructor is always necessary (asierra-970604)
180 extern "C" void error_handler(int err_sig);
182 void LyX::init(int */*argc*/, char **argv, bool gui)
184 // Install the signal handlers
185 signal(SIGHUP, error_handler);
186 signal(SIGFPE, error_handler);
187 signal(SIGSEGV, error_handler);
188 signal(SIGINT, error_handler);
189 signal(SIGTERM, error_handler);
192 // Determine path of binary
196 string binpath = subst(argv[0], '\\', '/');
197 string binname = OnlyFilename(argv[0]);
198 // Sorry for system specific code. (SMiyata)
199 if (suffixIs(binname, ".exe"))
200 binname.erase(binname.length()-4, string::npos);
202 binpath = ExpandPath(binpath); // This expands ./ and ~/
204 if (!AbsolutePath(binpath)) {
205 string binsearchpath = GetEnvPath("PATH");
206 // This will make "src/lyx" work always :-)
207 binsearchpath += ";.";
208 binpath = FileOpenSearch(binsearchpath, argv[0]);
211 fullbinpath = binpath;
212 binpath = MakeAbsPath(OnlyPath(binpath));
214 // In case we are running in place and compiled with shared libraries
215 if (suffixIs(binpath, "/.libs/"))
216 binpath.erase(binpath.length()-6, string::npos);
218 if (binpath.empty()) {
219 lyxerr << _("Warning: could not determine path of binary.")
221 << _("If you have problems, try starting LyX with an absolute path.")
224 lyxerr[Debug::INIT] << "Path of binary: " << binpath << endl;
227 // Determine system directory.
230 // Directories are searched in this order:
231 // 1) -sysdir command line parameter
232 // 2) LYX_DIR_11x environment variable
233 // 3) Maybe <path of binary>/TOP_SRCDIR/lib
234 // 4) <path of binary>/../share/<name of binary>/
235 // 4a) repeat 4 after following the Symlink if <path of
236 // binary> is a symbolic link.
237 // 5) hardcoded lyx_dir
238 // The directory is checked for the presence of the file
239 // "chkconfig.ltx", and if that is present, the directory
240 // is accepted as the system directory.
241 // If no chkconfig.ltx file is found, a warning is given,
242 // and the hardcoded lyx_dir is used.
244 // If we had a command line switch, system_lyxdir is already set
246 if (!system_lyxdir.empty())
247 searchpath= MakeAbsPath(system_lyxdir) + ';';
249 // LYX_DIR_11x environment variable
250 string lyxdir = GetEnvPath("LYX_DIR_11x");
252 if (!lyxdir.empty()) {
253 lyxerr[Debug::INIT] << "LYX_DIR_11x: " << lyxdir << endl;
254 searchpath += lyxdir + ';';
257 // <path of binary>/TOP_SRCDIR/lib
258 build_lyxdir = MakeAbsPath("../lib", binpath);
259 if (!FileSearch(build_lyxdir, "lyxrc.defaults").empty()) {
260 searchpath += MakeAbsPath(AddPath(TOP_SRCDIR, "lib"),
262 lyxerr[Debug::INIT] << "Checking whether LyX is run in "
263 "place... yes" << endl;
266 << "Checking whether LyX is run in place... no"
268 build_lyxdir.erase();
273 // Path of binary/../share/name of binary/
274 searchpath += NormalizePath(AddPath(binpath, "../share/") +
275 OnlyFilename(binname)) + ';';
278 FileInfo file(fullbinpath, true);
279 FollowLink = file.isLink();
282 if (LyXReadLink(fullbinpath, Link)) {
284 binpath = MakeAbsPath(OnlyPath(fullbinpath));
290 } while (FollowLink);
293 searchpath += LYX_DIR;
295 // If debugging, show complete search path
296 lyxerr[Debug::INIT] << "System directory search path: "
297 << searchpath << endl;
299 string const filename = "chkconfig.ltx";
300 string temp = FileOpenSearch(searchpath, filename, string());
301 system_lyxdir = OnlyPath(temp);
303 // Reduce "path/../path" stuff out of system directory
304 system_lyxdir = NormalizePath(system_lyxdir);
306 bool path_shown = false;
308 // Warn if environment variable is set, but unusable
309 if (!lyxdir.empty()) {
310 if (system_lyxdir != NormalizePath(lyxdir)) {
311 lyxerr <<_("LYX_DIR_11x environment variable no good.")
313 << _("System directory set to: ")
314 << system_lyxdir << endl;
319 // Warn the user if we couldn't find "chkconfig.ltx"
320 if (system_lyxdir == "./") {
321 lyxerr <<_("LyX Warning! Couldn't determine system directory.")
322 <<_("Try the '-sysdir' command line parameter or")
323 <<_("set the environment variable LYX_DIR_11x to the "
324 "LyX system directory")
325 << _("containing the file `chkconfig.ltx'.") << endl;
327 lyxerr << _("Using built-in default ")
328 << LYX_DIR << _(" but expect problems.")
331 lyxerr << _("Expect problems.") << endl;
332 system_lyxdir = LYX_DIR;
336 // Report the system directory if debugging is on
338 lyxerr[Debug::INIT] << "System directory: '"
339 << system_lyxdir << '\'' << endl;
342 // Determine user lyx-dir
345 // Directories are searched in this order:
346 // 1) -userdir command line parameter
347 // 2) LYX_USERDIR_11x environment variable
348 // 3) $HOME/.<name of binary>
350 // If we had a command line switch, user_lyxdir is already set
351 bool explicit_userdir = true;
352 if (user_lyxdir.empty()) {
354 // LYX_USERDIR_11x environment variable
355 user_lyxdir = GetEnvPath("LYX_USERDIR_11x");
358 if (user_lyxdir.empty())
359 user_lyxdir = AddPath(GetEnvPath("HOME"),
360 string(".") + PACKAGE);
361 explicit_userdir = false;
364 lyxerr[Debug::INIT] << "User LyX directory: '"
365 << user_lyxdir << '\'' << endl;
367 // Check that user LyX directory is ok.
368 queryUserLyXDir(explicit_userdir);
371 // Shine up lyxrc defaults
374 // Default template path: system_dir/templates
375 if (lyxrc.template_path.empty()){
376 lyxrc.template_path = AddPath(system_lyxdir, "templates");
379 // Default lastfiles file: $HOME/.lyx/lastfiles
380 if (lyxrc.lastfiles.empty()){
381 lyxrc.lastfiles = AddName(user_lyxdir, "lastfiles");
384 // Disable gui when either lyxrc or easyparse says so
386 lyxrc.use_gui = false;
388 // Calculate screen dpi as average of x-DPI and y-DPI:
390 lyxrc.dpi = getScreenDPI();
391 lyxerr[Debug::INIT] << "DPI setting detected to be "
392 << lyxrc.dpi + 0.5 << endl;
394 lyxrc.dpi = 1; // I hope this is safe
398 // Read configuration files
401 ReadRcFile("lyxrc.defaults");
402 system_lyxrc = lyxrc;
403 // If there is a preferences file we read that instead
404 // of the old lyxrc file.
405 if (!ReadRcFile("preferences"))
412 ReadEncodingsFile("encodings");
414 ReadLangugesFile("languages");
417 lyxerr[Debug::INIT] << "Reading layouts..." << endl;
420 // Ensure that we have really read a bind file, so that LyX is
422 if (!lyxrc.hasBindFile)
423 lyxrc.ReadBindFile();
426 ReadUIFile(lyxrc.ui_file);
428 // Bind the X dead keys to the corresponding LyX functions if
430 if (lyxrc.override_x_deadkeys)
431 deadKeyBindings(toplevel_keymap);
433 if (lyxerr.debugging(Debug::LYXRC)) {
437 // Create temp directory
438 system_tempdir = CreateLyXTmpDir(lyxrc.tempdir_path);
439 if (lyxerr.debugging(Debug::INIT)) {
440 lyxerr << "LyX tmp dir: `" << system_tempdir << '\'' << endl;
443 // load the lastfiles mini-database
444 lyxerr[Debug::INIT] << "Reading lastfiles `"
445 << lyxrc.lastfiles << "'..." << endl;
446 lastfiles = new LastFiles(lyxrc.lastfiles,
447 lyxrc.check_lastfiles,
448 lyxrc.num_lastfiles);
450 // start up the lyxserver. (is this a bit early?) (Lgb)
451 // 0.12 this will be way to early, we need the GUI to be initialized
452 // first, so move it for now.
453 // lyxserver = new LyXServer;
457 // These are the default bindings known to LyX
458 void LyX::defaultKeyBindings(kb_keymap * kbmap)
460 kbmap->bind("Right", LFUN_RIGHT);
461 kbmap->bind("Left", LFUN_LEFT);
462 kbmap->bind("Up", LFUN_UP);
463 kbmap->bind("Down", LFUN_DOWN);
465 kbmap->bind("Tab", LFUN_TAB);
467 kbmap->bind("Home", LFUN_HOME);
468 kbmap->bind("End", LFUN_END);
469 kbmap->bind("Prior", LFUN_PRIOR);
470 kbmap->bind("Next", LFUN_NEXT);
472 kbmap->bind("Return", LFUN_BREAKPARAGRAPH);
473 kbmap->bind("~C-~S-~M-nobreakspace", LFUN_PROTECTEDSPACE);
475 kbmap->bind("Delete", LFUN_DELETE);
476 kbmap->bind("BackSpace", LFUN_BACKSPACE);
478 // kbmap->bindings to enable the use of the numeric keypad
480 kbmap->bind("KP_0", LFUN_SELFINSERT);
481 kbmap->bind("KP_Decimal", LFUN_SELFINSERT);
482 kbmap->bind("KP_Enter", LFUN_SELFINSERT);
483 kbmap->bind("KP_1", LFUN_SELFINSERT);
484 kbmap->bind("KP_2", LFUN_SELFINSERT);
485 kbmap->bind("KP_3", LFUN_SELFINSERT);
486 kbmap->bind("KP_4", LFUN_SELFINSERT);
487 kbmap->bind("KP_5", LFUN_SELFINSERT);
488 kbmap->bind("KP_6", LFUN_SELFINSERT);
489 kbmap->bind("KP_Add", LFUN_SELFINSERT);
490 kbmap->bind("KP_7", LFUN_SELFINSERT);
491 kbmap->bind("KP_8", LFUN_SELFINSERT);
492 kbmap->bind("KP_9", LFUN_SELFINSERT);
493 kbmap->bind("KP_Divide", LFUN_SELFINSERT);
494 kbmap->bind("KP_Multiply", LFUN_SELFINSERT);
495 kbmap->bind("KP_Subtract", LFUN_SELFINSERT);
497 /* Most self-insert keys are handled in the 'default:' section of
498 * WorkAreaKeyPress - so we don't have to define them all.
499 * However keys explicit decleared as self-insert are
500 * handled seperatly (LFUN_SELFINSERT.) Lgb. */
502 kbmap->bind("C-Tab", LFUN_TABINSERT); // ale970515
503 kbmap->bind("S-Tab", LFUN_SHIFT_TAB); // jug20000522
507 // LyX can optionally take over the handling of deadkeys
508 void LyX::deadKeyBindings(kb_keymap * kbmap)
510 // bindKeyings for transparent handling of deadkeys
511 // The keysyms are gotten from XFree86 X11R6
512 kbmap->bind("~C-~S-~M-dead_acute", LFUN_ACUTE);
513 kbmap->bind("~C-~S-~M-dead_breve", LFUN_BREVE);
514 kbmap->bind("~C-~S-~M-dead_caron", LFUN_CARON);
515 kbmap->bind("~C-~S-~M-dead_cedilla", LFUN_CEDILLA);
516 kbmap->bind("~C-~S-~M-dead_abovering", LFUN_CIRCLE);
517 kbmap->bind("~C-~S-~M-dead_circumflex", LFUN_CIRCUMFLEX);
518 kbmap->bind("~C-~S-~M-dead_abovedot", LFUN_DOT);
519 kbmap->bind("~C-~S-~M-dead_grave", LFUN_GRAVE);
520 kbmap->bind("~C-~S-~M-dead_doubleacute", LFUN_HUNG_UMLAUT);
521 kbmap->bind("~C-~S-~M-dead_macron", LFUN_MACRON);
522 // nothing with this name
523 // kbmap->bind("~C-~S-~M-dead_special_caron", LFUN_SPECIAL_CARON);
524 kbmap->bind("~C-~S-~M-dead_tilde", LFUN_TILDE);
525 kbmap->bind("~C-~S-~M-dead_diaeresis", LFUN_UMLAUT);
526 // nothing with this name either...
527 //kbmap->bind("~C-~S-~M-dead_underbar", LFUN_UNDERBAR);
528 kbmap->bind("~C-~S-~M-dead_belowdot", LFUN_UNDERDOT);
529 kbmap->bind("~C-~S-~M-dead_tie", LFUN_TIE);
530 kbmap->bind("~C-~S-~M-dead_ogonek", LFUN_OGONEK);
534 // This one is not allowed to use anything on the main form, since that
535 // one does not exist yet. (Asger)
536 void LyX::queryUserLyXDir(bool explicit_userdir)
538 // Does user directory exist?
539 FileInfo fileInfo(user_lyxdir);
540 if (fileInfo.isOK() && fileInfo.isDir()) {
548 // Different wording if the user specifically requested a directory
549 if (!AskQuestion( explicit_userdir
550 ? _("You have specified an invalid LyX directory.")
551 : _("You don't have a personal LyX directory.") ,
553 _("It is needed to keep your own configuration."),
554 _("Should I try to set it up for you (recommended)?"))) {
555 lyxerr << _("Running without personal LyX directory.") << endl;
556 // No, let's use $HOME instead.
557 user_lyxdir = GetEnvPath("HOME");
561 // Tell the user what is going on
562 lyxerr << _("LyX: Creating directory ") << user_lyxdir
563 << _(" and running configure...") << endl;
565 // Create directory structure
566 if (!createDirectory(user_lyxdir, 0755)) {
567 // Failed, let's use $HOME instead.
568 user_lyxdir = GetEnvPath("HOME");
569 lyxerr << _("Failed. Will use ") << user_lyxdir
570 << _(" instead.") << endl;
574 // Run configure in user lyx directory
576 ::system(AddName(system_lyxdir, "configure").c_str());
577 lyxerr << "LyX: " << _("Done!") << endl;
581 // Read the rc file `name'
582 bool LyX::ReadRcFile(string const & name)
584 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
586 string lyxrc_path = LibFileSearch(string(), name);
587 if (!lyxrc_path.empty()){
588 lyxerr[Debug::INIT] << "Found " << name
589 << " in " << lyxrc_path << endl;
590 if (lyxrc.read(lyxrc_path) < 0) {
591 WriteAlert(_("LyX Warning!"),
592 _("Error while reading ")+lyxrc_path+".",
593 _("Using built-in defaults."));
598 lyxerr[Debug::INIT] << "Could not find " << name << endl;
603 // Read the ui file `name'
604 void LyX::ReadUIFile(string const & name)
612 struct keyword_item uitags[ui_last-1] = {
613 { "menuset", ui_menuset },
614 { "toolbar", ui_toolbar }
617 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
619 string ui_path = LibFileSearch("ui", name, "ui");
621 if (ui_path.empty()) {
622 lyxerr[Debug::INIT] << "Could not find " << name << endl;
623 menubackend.defaults();
627 lyxerr[Debug::INIT] << "Found " << name
628 << " in " << ui_path << endl;
629 LyXLex lex(uitags, ui_last - 1);
630 lex.setFile(ui_path);
632 lyxerr << "Unable to set LyXLeX for ui file: " << ui_path
636 if (lyxerr.debugging(Debug::PARSER))
637 lex.printTable(lyxerr);
642 menubackend.read(lex);
646 toolbardefaults.read(lex);
650 lex.printError("LyX::ReadUFile: "
651 "Unknown menu tag: `$$Token'");
658 // Read the languages file `name'
659 void LyX::ReadLangugesFile(string const & name)
661 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
663 string lang_path = LibFileSearch(string(), name);
664 if (lang_path.empty()) {
665 lyxerr[Debug::INIT] << "Could not find " << name << endl;
666 languages.setDefaults();
669 languages.read(lang_path);
673 // Read the encodings file `name'
674 void LyX::ReadEncodingsFile(string const & name)
676 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
678 string enc_path = LibFileSearch(string(), name);
679 if (enc_path.empty()) {
680 lyxerr[Debug::INIT] << "Could not find " << name << endl;
683 encodings.read(enc_path);
687 // Set debugging level and report result to user
689 void setDebuggingLevel(string const & dbgLevel)
691 lyxerr << _("Setting debug level to ") << dbgLevel << endl;
692 lyxerr.level(Debug::value(dbgLevel));
693 Debug::showLevel(lyxerr, lyxerr.level());
697 // Give command line help
699 void commandLineHelp()
701 lyxerr << "LyX " LYX_VERSION << " of " LYX_RELEASE << endl;
703 _("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
704 "Command line switches (case sensitive):\n"
705 "\t-help summarize LyX usage\n"
706 "\t-userdir dir try to set user directory to dir\n"
707 "\t-sysdir dir try to set system directory to dir\n"
708 "\t-geometry WxH+X+Y set geometry of the main window\n"
709 "\t-dbg feature[,feature]...\n"
710 " select the features to debug.\n"
711 " Type `lyx -dbg' to see the list of features\n"
712 "Check the LyX man page for more options.") << endl;
716 bool LyX::easyParse(int * argc, char * argv[])
719 int removeargs = 0; // used when options are read
720 for (int i = 1; i < *argc; ++i) {
721 string arg = argv[i];
723 // Check for -dbg int
726 setDebuggingLevel(argv[i + 1]);
729 lyxerr << _("List of supported debug flags:")
731 Debug::showTags(lyxerr);
735 // Check for "-sysdir"
736 else if (arg == "-sysdir") {
738 system_lyxdir = argv[i + 1];
741 lyxerr << _("Missing directory for -sysdir switch!")
746 // Check for "-userdir"
747 else if (arg == "-userdir") {
749 user_lyxdir = argv[i + 1];
752 lyxerr << _("Missing directory for -userdir switch!")
757 // Check for --help or -help
758 else if (arg == "--help" || arg == "-help") {
762 // Check for "-nw": No XWindows as for emacs this should
763 // give a LyX that could be used in a terminal window.
764 //else if (arg == "-nw") {
768 // Check for "-x": Execute commands
769 else if (arg == "-x" || arg == "--execute") {
771 batch_command = string(argv[i + 1]);
775 lyxerr << _("Missing command string after -x switch!") << endl;
777 // Argh. Setting gui to false segfaults..
781 else if (arg == "-e" || arg == "--export") {
783 string type(argv[i+1]);
785 batch_command = "buffer-export " + type;
788 lyxerr << _("Missing file type [eg latex, "
790 << arg << _(" switch!") << endl;
792 else if (arg == "--import") {
794 string type(argv[i+1]);
795 string file(argv[i+2]);
798 batch_command = "buffer-import " + type + " " + file;
799 lyxerr << "batch_command: "
800 << batch_command << endl;
803 lyxerr << _("Missing type [eg latex, "
805 << arg << _(" switch!") << endl;
808 if (removeargs > 0) {
809 // Now, remove used arguments by shifting
810 // the following ones removeargs places down.
811 (*argc) -= removeargs;
812 for (int j = i; j < (*argc); ++j)
813 argv[j] = argv[j + removeargs];
814 --i; // After shift, check this number again.
825 void error_handler(int err_sig)
829 lyxerr << "\nlyx: SIGHUP signal caught" << endl;
835 lyxerr << "\nlyx: SIGFPE signal caught" << endl;
838 lyxerr << "\nlyx: SIGSEGV signal caught" << endl;
840 "Sorry, you have found a bug in LyX."
841 " If possible, please read 'Known bugs'\n"
842 "under the Help menu and then send us "
843 "a full bug report. Thanks!" << endl;
850 // Deinstall the signal handlers
851 signal(SIGHUP, SIG_DFL);
852 signal(SIGINT, SIG_DFL);
853 signal(SIGFPE, SIG_DFL);
854 signal(SIGSEGV, SIG_DFL);
855 signal(SIGTERM, SIG_DFL);
857 bufferlist.emergencyWriteAll();
859 lyxerr << "Bye." << endl;
860 if (err_sig!= SIGHUP &&
861 (!GetEnv("LYXDEBUG").empty() || err_sig == SIGSEGV))