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"
39 # include "MenuBackend.h"
41 #include "ToolbarDefaults.h"
46 extern void LoadLyXFile(string const &);
50 string system_tempdir;
51 string user_lyxdir; // Default $HOME/.lyx
53 // Should this be kept global? Asger says Yes.
56 LastFiles * lastfiles;
58 // This is the global bufferlist object
59 BufferList bufferlist;
61 LyXServer * lyxserver = 0;
62 // this should be static, but I need it in buffer.C
63 bool finished = false; // flag, that we are quitting the program
65 // convenient to have it here.
66 kb_keymap * toplevel_keymap;
69 LyX::LyX(int * argc, char * argv[])
71 // Prevent crash with --help
75 // Here we need to parse the command line. At least
76 // we need to parse for "-dbg" and "-help"
77 bool gui = easyParse(argc, argv);
79 // Global bindings (this must be done as early as possible.) (Lgb)
80 toplevel_keymap = new kb_keymap;
81 defaultKeyBindings(toplevel_keymap);
83 // Make the GUI object, and let it take care of the
84 // command line arguments that concerns it.
85 lyxerr[Debug::INIT] << "Initializing LyXGUI..." << endl;
86 lyxGUI = new LyXGUI(this, argc, argv, gui);
87 lyxerr[Debug::INIT] << "Initializing LyXGUI...done" << endl;
89 // Now the GUI and LyX have taken care of their arguments, so
90 // the only thing left on the command line should be
91 // filenames. Let's check anyway.
92 for (int argi = 1; argi < *argc ; ++argi) {
93 if (argv[argi][0] == '-') {
94 lyxerr << _("Wrong command line option `")
96 << _("'. Exiting.") << endl;
101 // Initialization of LyX (reads lyxrc and more)
102 lyxerr[Debug::INIT] << "Initializing LyX::init..." << endl;
103 init(argc, argv, gui);
104 lyxerr[Debug::INIT] << "Initializing LyX::init...done" << endl;
108 // Load the files specified in the command line.
110 lyxerr[Debug::INFO] << "Opening document..." << endl;
111 else if ((*argc) > 2)
112 lyxerr[Debug::INFO] << "Opening documents..." << endl;
114 Buffer * last_loaded = 0;
116 for (int argi = (*argc) - 1; argi >= 1; --argi) {
117 Buffer * loadb = bufferlist.loadLyXFile(argv[argi]);
124 string splash = i18nLibFileSearch("examples", "splash.lyx");
125 lyxerr[Debug::INIT] << "Opening splash document "
126 << splash << "..." << endl;
127 Buffer * loadb = bufferlist.loadLyXFile(splash);
133 if (last_loaded != 0) {
134 lyxerr[Debug::INIT] << "Yes we loaded some files." << endl;
136 lyxGUI->regBuf(last_loaded);
139 // Execute batch commands if available
140 if (!batch_command.empty()) {
141 lyxerr << "About to handle -x '" << batch_command << "'" << endl;
143 // no buffer loaded, create one
145 last_loaded = bufferlist.newFile("tmpfile", string());
147 // try to dispatch to last loaded buffer first
148 bool dispatched = last_loaded->Dispatch(batch_command);
150 // if this was successful, return.
151 // Maybe we could do something more clever than aborting...
153 lyxerr << "We are done!" << endl;
157 // otherwise, let the GUI handle the batch command
158 lyxGUI->regBuf(last_loaded);
159 lyxGUI->getLyXView()->getLyXFunc()->Dispatch(batch_command);
164 // Let the ball begin...
169 // A destructor is always necessary (asierra-970604)
177 extern "C" void error_handler(int err_sig);
179 void LyX::init(int */*argc*/, char **argv, bool gui)
181 // Install the signal handlers
182 signal(SIGHUP, error_handler);
183 signal(SIGFPE, error_handler);
184 signal(SIGSEGV, error_handler);
185 signal(SIGINT, error_handler);
186 signal(SIGTERM, error_handler);
189 // Determine path of binary
193 string binpath = subst(argv[0], '\\', '/');
194 string binname = OnlyFilename(argv[0]);
195 // Sorry for system specific code. (SMiyata)
196 if (suffixIs(binname, ".exe"))
197 binname.erase(binname.length()-4, string::npos);
199 binpath = ExpandPath(binpath); // This expands ./ and ~/
201 if (!AbsolutePath(binpath)) {
202 string binsearchpath = GetEnvPath("PATH");
203 // This will make "src/lyx" work always :-)
204 binsearchpath += ";.";
205 binpath = FileOpenSearch(binsearchpath, argv[0]);
208 fullbinpath = binpath;
209 binpath = MakeAbsPath(OnlyPath(binpath));
211 // In case we are running in place and compiled with shared libraries
212 if (suffixIs(binpath, "/.libs/"))
213 binpath.erase(binpath.length()-6, string::npos);
215 if (binpath.empty()) {
216 lyxerr << _("Warning: could not determine path of binary.")
218 << _("If you have problems, try starting LyX with an absolute path.")
221 lyxerr[Debug::INIT] << "Path of binary: " << binpath << endl;
224 // Determine system directory.
227 // Directories are searched in this order:
228 // 1) -sysdir command line parameter
229 // 2) LYX_DIR_11x environment variable
230 // 3) Maybe <path of binary>/TOP_SRCDIR/lib
231 // 4) <path of binary>/../share/<name of binary>/
232 // 4a) repeat 4 after following the Symlink if <path of
233 // binary> is a symbolic link.
234 // 5) hardcoded lyx_dir
235 // The directory is checked for the presence of the file
236 // "chkconfig.ltx", and if that is present, the directory
237 // is accepted as the system directory.
238 // If no chkconfig.ltx file is found, a warning is given,
239 // and the hardcoded lyx_dir is used.
241 // If we had a command line switch, system_lyxdir is already set
243 if (!system_lyxdir.empty())
244 searchpath= MakeAbsPath(system_lyxdir) + ';';
246 // LYX_DIR_11x environment variable
247 string lyxdir = GetEnvPath("LYX_DIR_11x");
249 if (!lyxdir.empty()) {
250 lyxerr[Debug::INIT] << "LYX_DIR_11x: " << lyxdir << endl;
251 searchpath += lyxdir + ';';
254 // <path of binary>/TOP_SRCDIR/lib
255 build_lyxdir = MakeAbsPath("../lib", binpath);
256 if (!FileSearch(build_lyxdir, "lyxrc.defaults").empty()) {
257 searchpath += MakeAbsPath(AddPath(TOP_SRCDIR, "lib"),
259 lyxerr[Debug::INIT] << "Checking whether LyX is run in "
260 "place... yes" << endl;
263 << "Checking whether LyX is run in place... no"
265 build_lyxdir.erase();
270 // Path of binary/../share/name of binary/
271 searchpath += NormalizePath(AddPath(binpath, "../share/") +
272 OnlyFilename(binname)) + ';';
275 FileInfo file(fullbinpath, true);
276 FollowLink = file.isLink();
279 if (LyXReadLink(fullbinpath, Link)) {
281 binpath = MakeAbsPath(OnlyPath(fullbinpath));
287 } while (FollowLink);
290 searchpath += LYX_DIR;
292 // If debugging, show complete search path
293 lyxerr[Debug::INIT] << "System directory search path: "
294 << searchpath << endl;
296 string const filename = "chkconfig.ltx";
297 string temp = FileOpenSearch(searchpath, filename, string());
298 system_lyxdir = OnlyPath(temp);
300 // Reduce "path/../path" stuff out of system directory
301 system_lyxdir = NormalizePath(system_lyxdir);
303 bool path_shown = false;
305 // Warn if environment variable is set, but unusable
306 if (!lyxdir.empty()) {
307 if (system_lyxdir != NormalizePath(lyxdir)) {
308 lyxerr <<_("LYX_DIR_11x environment variable no good.")
310 << _("System directory set to: ")
311 << system_lyxdir << endl;
316 // Warn the user if we couldn't find "chkconfig.ltx"
317 if (system_lyxdir == "./") {
318 lyxerr <<_("LyX Warning! Couldn't determine system directory.")
319 <<_("Try the '-sysdir' command line parameter or")
320 <<_("set the environment variable LYX_DIR_11x to the "
321 "LyX system directory")
322 << _("containing the file `chkconfig.ltx'.") << endl;
324 lyxerr << _("Using built-in default ")
325 << LYX_DIR << _(" but expect problems.")
328 lyxerr << _("Expect problems.") << endl;
329 system_lyxdir = LYX_DIR;
333 // Report the system directory if debugging is on
335 lyxerr[Debug::INIT] << "System directory: '"
336 << system_lyxdir << '\'' << endl;
339 // Determine user lyx-dir
342 // Directories are searched in this order:
343 // 1) -userdir command line parameter
344 // 2) LYX_USERDIR_11x environment variable
345 // 3) $HOME/.<name of binary>
347 // If we had a command line switch, user_lyxdir is already set
348 bool explicit_userdir = true;
349 if (user_lyxdir.empty()) {
351 // LYX_USERDIR_11x environment variable
352 user_lyxdir = GetEnvPath("LYX_USERDIR_11x");
355 if (user_lyxdir.empty())
356 user_lyxdir = AddPath(GetEnvPath("HOME"),
357 string(".") + PACKAGE);
358 explicit_userdir = false;
361 lyxerr[Debug::INIT] << "User LyX directory: '"
362 << user_lyxdir << '\'' << endl;
364 // Check that user LyX directory is ok.
365 queryUserLyXDir(explicit_userdir);
368 // Load the layouts first
371 lyxerr[Debug::INIT] << "Reading layouts..." << endl;
375 // Shine up lyxrc defaults
378 // Default template path: system_dir/templates
379 if (lyxrc.template_path.empty()){
380 lyxrc.template_path = AddPath(system_lyxdir, "templates");
383 // Default lastfiles file: $HOME/.lyx/lastfiles
384 if (lyxrc.lastfiles.empty()){
385 lyxrc.lastfiles = AddName(user_lyxdir, "lastfiles");
388 // Disable gui when either lyxrc or easyparse says so
390 lyxrc.use_gui = false;
392 // Calculate screen dpi as average of x-DPI and y-DPI:
394 lyxrc.dpi = getScreenDPI();
395 lyxerr[Debug::INIT] << "DPI setting detected to be "
396 << lyxrc.dpi + 0.5 << endl;
398 lyxrc.dpi = 1; // I hope this is safe
402 // Read configuration files
405 ReadRcFile("lyxrc.defaults");
408 // Ensure that we have really read a bind file, so that LyX is
410 if (!lyxrc.hasBindFile)
411 lyxrc.ReadBindFile();
414 ReadUIFile(lyxrc.ui_file);
416 // Bind the X dead keys to the corresponding LyX functions if
418 if (lyxrc.override_x_deadkeys)
419 deadKeyBindings(toplevel_keymap);
421 if (lyxerr.debugging(Debug::LYXRC)) {
425 // Create temp directory
426 system_tempdir = CreateLyXTmpDir(lyxrc.tempdir_path);
427 if (lyxerr.debugging(Debug::INIT)) {
428 lyxerr << "LyX tmp dir: `" << system_tempdir << '\'' << endl;
431 // load the lastfiles mini-database
432 lyxerr[Debug::INIT] << "Reading lastfiles `"
433 << lyxrc.lastfiles << "'..." << endl;
434 lastfiles = new LastFiles(lyxrc.lastfiles,
435 lyxrc.check_lastfiles,
436 lyxrc.num_lastfiles);
438 // start up the lyxserver. (is this a bit early?) (Lgb)
439 // 0.12 this will be way to early, we need the GUI to be initialized
440 // first, so move it for now.
441 // lyxserver = new LyXServer;
444 // These are the default bindings known to LyX
445 void LyX::defaultKeyBindings(kb_keymap * kbmap)
447 kbmap->bind("Right", LFUN_RIGHT);
448 kbmap->bind("Left", LFUN_LEFT);
449 kbmap->bind("Up", LFUN_UP);
450 kbmap->bind("Down", LFUN_DOWN);
452 kbmap->bind("Tab", LFUN_TAB);
454 kbmap->bind("Home", LFUN_HOME);
455 kbmap->bind("End", LFUN_END);
456 kbmap->bind("Prior", LFUN_PRIOR);
457 kbmap->bind("Next", LFUN_NEXT);
459 kbmap->bind("Return", LFUN_BREAKPARAGRAPH);
460 kbmap->bind("~C-~S-~M-nobreakspace", LFUN_PROTECTEDSPACE);
462 kbmap->bind("Delete", LFUN_DELETE);
463 kbmap->bind("BackSpace", LFUN_BACKSPACE);
465 // kbmap->bindings to enable the use of the numeric keypad
467 kbmap->bind("KP_0", LFUN_SELFINSERT);
468 kbmap->bind("KP_Decimal", LFUN_SELFINSERT);
469 kbmap->bind("KP_Enter", LFUN_SELFINSERT);
470 kbmap->bind("KP_1", LFUN_SELFINSERT);
471 kbmap->bind("KP_2", LFUN_SELFINSERT);
472 kbmap->bind("KP_3", LFUN_SELFINSERT);
473 kbmap->bind("KP_4", LFUN_SELFINSERT);
474 kbmap->bind("KP_5", LFUN_SELFINSERT);
475 kbmap->bind("KP_6", LFUN_SELFINSERT);
476 kbmap->bind("KP_Add", LFUN_SELFINSERT);
477 kbmap->bind("KP_7", LFUN_SELFINSERT);
478 kbmap->bind("KP_8", LFUN_SELFINSERT);
479 kbmap->bind("KP_9", LFUN_SELFINSERT);
480 kbmap->bind("KP_Divide", LFUN_SELFINSERT);
481 kbmap->bind("KP_Multiply", LFUN_SELFINSERT);
482 kbmap->bind("KP_Subtract", LFUN_SELFINSERT);
484 /* Most self-insert keys are handled in the 'default:' section of
485 * WorkAreaKeyPress - so we don't have to define them all.
486 * However keys explicit decleared as self-insert are
487 * handled seperatly (LFUN_SELFINSERT.) Lgb. */
489 kbmap->bind("C-Tab", LFUN_TABINSERT); // ale970515
490 kbmap->bind("S-Tab", LFUN_SHIFT_TAB); // jug20000522
493 // LyX can optionally take over the handling of deadkeys
494 void LyX::deadKeyBindings(kb_keymap * kbmap)
496 // bindKeyings for transparent handling of deadkeys
497 // The keysyms are gotten from XFree86 X11R6
498 kbmap->bind("~C-~S-~M-dead_acute", LFUN_ACUTE);
499 kbmap->bind("~C-~S-~M-dead_breve", LFUN_BREVE);
500 kbmap->bind("~C-~S-~M-dead_caron", LFUN_CARON);
501 kbmap->bind("~C-~S-~M-dead_cedilla", LFUN_CEDILLA);
502 kbmap->bind("~C-~S-~M-dead_abovering", LFUN_CIRCLE);
503 kbmap->bind("~C-~S-~M-dead_circumflex", LFUN_CIRCUMFLEX);
504 kbmap->bind("~C-~S-~M-dead_abovedot", LFUN_DOT);
505 kbmap->bind("~C-~S-~M-dead_grave", LFUN_GRAVE);
506 kbmap->bind("~C-~S-~M-dead_doubleacute", LFUN_HUNG_UMLAUT);
507 kbmap->bind("~C-~S-~M-dead_macron", LFUN_MACRON);
508 // nothing with this name
509 // kbmap->bind("~C-~S-~M-dead_special_caron", LFUN_SPECIAL_CARON);
510 kbmap->bind("~C-~S-~M-dead_tilde", LFUN_TILDE);
511 kbmap->bind("~C-~S-~M-dead_diaeresis", LFUN_UMLAUT);
512 // nothing with this name either...
513 //kbmap->bind("~C-~S-~M-dead_underbar", LFUN_UNDERBAR);
514 kbmap->bind("~C-~S-~M-dead_belowdot", LFUN_UNDERDOT);
515 kbmap->bind("~C-~S-~M-dead_tie", LFUN_TIE);
516 kbmap->bind("~C-~S-~M-dead_ogonek", LFUN_OGONEK);
521 // This one is not allowed to use anything on the main form, since that
522 // one does not exist yet. (Asger)
523 void LyX::queryUserLyXDir(bool explicit_userdir)
525 // Does user directory exist?
526 FileInfo fileInfo(user_lyxdir);
527 if (fileInfo.isOK() && fileInfo.isDir()) {
535 // Different wording if the user specifically requested a directory
536 if (!AskQuestion( explicit_userdir
537 ? _("You have specified an invalid LyX directory.")
538 : _("You don't have a personal LyX directory.") ,
540 _("It is needed to keep your own configuration."),
541 _("Should I try to set it up for you (recommended)?"))) {
542 lyxerr << _("Running without personal LyX directory.") << endl;
543 // No, let's use $HOME instead.
544 user_lyxdir = GetEnvPath("HOME");
548 // Tell the user what is going on
549 lyxerr << _("LyX: Creating directory ") << user_lyxdir
550 << _(" and running configure...") << endl;
552 // Create directory structure
553 if (!createDirectory(user_lyxdir, 0755)) {
554 // Failed, let's use $HOME instead.
555 user_lyxdir = GetEnvPath("HOME");
556 lyxerr << _("Failed. Will use ") << user_lyxdir
557 << _(" instead.") << endl;
561 // Run configure in user lyx directory
563 system(AddName(system_lyxdir, "configure").c_str());
564 lyxerr << "LyX: " << _("Done!") << endl;
568 // Read the rc file `name'
569 void LyX::ReadRcFile(string const & name)
571 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
573 string lyxrc_path = LibFileSearch(string(), name);
574 if (!lyxrc_path.empty()){
575 lyxerr[Debug::INIT] << "Found " << name
576 << " in " << lyxrc_path << endl;
577 if (lyxrc.read(lyxrc_path) < 0) {
578 WriteAlert(_("LyX Warning!"),
579 _("Error while reading ")+lyxrc_path+".",
580 _("Using built-in defaults."));
583 lyxerr[Debug::INIT] << "Could not find " << name << endl;
587 // Read the ui file `name'
588 void LyX::ReadUIFile(string const & name)
596 struct keyword_item uitags[ui_last-1] = {
597 { "menuset", ui_menuset },
598 { "toolbar", ui_toolbar }
601 lyxerr[Debug::INIT] << "About to read " << name << "..." << endl;
603 string ui_path = LibFileSearch("ui", name, "ui");
605 if (ui_path.empty()) {
606 lyxerr[Debug::INIT] << "Could not find " << name << endl;
610 lyxerr[Debug::INIT] << "Found " << name
611 << " in " << ui_path << endl;
612 LyXLex lex(uitags, ui_last - 1);
613 lex.setFile(ui_path);
614 if (lyxerr.debugging(Debug::PARSER))
615 lex.printTable(lyxerr);
621 menubackend.read(lex);
624 // Skip any menu definition and fall over to toolbar.
625 // This is a hack, but it is supposed to go away...
628 if (!lex.IsOK()) return;
630 while (lex.lex() != ui_toolbar);
634 toolbardefaults.read(lex);
638 lex.printError("LyX::ReadUFile: "
639 "Unknown menu tag: `$$Token'");
646 // Set debugging level and report result to user
647 void setDebuggingLevel(string const & dbgLevel)
649 lyxerr << _("Setting debug level to ") << dbgLevel << endl;
650 lyxerr.level(Debug::value(dbgLevel));
651 Debug::showLevel(lyxerr, lyxerr.level());
655 // Give command line help
656 void commandLineHelp()
658 lyxerr << "LyX " LYX_VERSION << " of " LYX_RELEASE << endl;
660 _("Usage: lyx [ command line switches ] [ name.lyx ... ]\n"
661 "Command line switches (case sensitive):\n"
662 "\t-help summarize LyX usage\n"
663 "\t-userdir dir try to set user directory to dir\n"
664 "\t-sysdir dir try to set system directory to dir\n"
665 "\t-geometry WxH+X+Y set geometry of the main window\n"
666 "\t-dbg feature[,feature]...\n"
667 " select the features to debug.\n"
668 " Type `lyx -dbg' to see the list of features\n"
669 "Check the LyX man page for more options.") << endl;
672 bool LyX::easyParse(int * argc, char * argv[])
675 int removeargs = 0; // used when options are read
676 for(int i = 1; i < *argc; ++i) {
677 string arg = argv[i];
679 // Check for -dbg int
682 setDebuggingLevel(argv[i + 1]);
685 lyxerr << _("List of supported debug flags:")
687 Debug::showTags(lyxerr);
691 // Check for "-sysdir"
692 else if (arg == "-sysdir") {
694 system_lyxdir = argv[i + 1];
697 lyxerr << _("Missing directory for -sysdir switch!")
702 // Check for "-userdir"
703 else if (arg == "-userdir") {
705 user_lyxdir = argv[i + 1];
708 lyxerr << _("Missing directory for -userdir switch!")
713 // Check for --help or -help
714 else if (arg == "--help" || arg == "-help") {
718 // Check for "-nw": No XWindows as for emacs this should
719 // give a LyX that could be used in a terminal window.
720 //else if (arg == "-nw") {
724 // Check for "-x": Execute commands
725 else if (arg == "-x" || arg == "--execute") {
727 batch_command = string(argv[i + 1]);
731 lyxerr << _("Missing command string after -x switch!") << endl;
733 // Argh. Setting gui to false segfaults..
737 else if (arg == "-e" || arg == "--export") {
739 string type(argv[i+1]);
744 else if (type == "ps")
746 else if (type == "text" || type == "txt")
749 if (type == "latex" || type == "postscript"
750 || type == "linuxdoc" || type == "docbook"
751 || type == "ascii" || type == "html")
752 batch_command = "buffer-export " + type;
754 lyxerr << _("Unknown file type '")
755 << type << _("' after ")
756 << arg << _(" switch!") << endl;
758 lyxerr << _("Missing file type [eg latex, "
760 << arg << _(" switch!") << endl;
762 else if (arg == "--import") {
764 string type(argv[i+1]);
765 string file(argv[i+2]);
768 batch_command = "buffer-import " + type + " " + file;
769 lyxerr << "batch_command: "
770 << batch_command << endl;
773 lyxerr << _("Missing type [eg latex, "
775 << arg << _(" switch!") << endl;
778 if (removeargs > 0) {
779 // Now, remove used arguments by shifting
780 // the following ones removeargs places down.
781 (*argc) -= removeargs;
782 for (int j = i; j < (*argc); ++j)
783 argv[j] = argv[j + removeargs];
784 --i; // After shift, check this number again.
795 void error_handler(int err_sig)
799 lyxerr << "\nlyx: SIGHUP signal caught" << endl;
805 lyxerr << "\nlyx: SIGFPE signal caught" << endl;
808 lyxerr << "\nlyx: SIGSEGV signal caught" << endl;
810 "Sorry, you have found a bug in LyX."
811 " If possible, please read 'Known bugs'\n"
812 "under the Help menu and then send us "
813 "a full bug report. Thanks!" << endl;
820 // Deinstall the signal handlers
821 signal(SIGHUP, SIG_DFL);
822 signal(SIGINT, SIG_DFL);
823 signal(SIGFPE, SIG_DFL);
824 signal(SIGSEGV, SIG_DFL);
825 signal(SIGTERM, SIG_DFL);
827 bufferlist.emergencyWriteAll();
829 lyxerr << "Bye." << endl;
830 if(err_sig!= SIGHUP &&
831 (!GetEnv("LYXDEBUG").empty() || err_sig == SIGSEGV))