kdbg/mainwndbase.cpp

   1 /*
   2  * Copyright Johannes Sixt
   3  * This file is licensed under the GNU General Public License Version 2.
   4  * See the file COPYING in the toplevel directory of the source directory.
   5  */
   6
   7 #include <kapplication.h>
   8 #include <klocale.h>                    /* i18n */
   9 #include <kconfig.h>
  10 #include <kmessagebox.h>
  11 #include <kstatusbar.h>
  12 #include <kfiledialog.h>
  13 #include <qtabdialog.h>
  14 #include <qfile.h>
  15 #include <qdragobject.h>
  16 #include "mainwndbase.h"
  17 #include "debugger.h"
  18 #include "gdbdriver.h"
  19 #include "xsldbgdriver.h"
  20 #include "prefdebugger.h"
  21 #include "prefmisc.h"
  22 #include "ttywnd.h"
  23 #include "commandids.h"
  24 #ifdef HAVE_CONFIG
  25 #include "config.h"
  26 #endif
  27 #include "mydebug.h"
  28 #ifdef HAVE_SYS_STAT_H
  29 #include <sys/stat.h>                   /* mknod(2) */
  30 #endif
  31 #ifdef HAVE_FCNTL_H
  32 #include <fcntl.h>                      /* open(2) */
  33 #endif
  34 #ifdef HAVE_UNISTD_H
  35 #include <unistd.h>                     /* getpid, unlink etc. */
  36 #endif
  37
  38 #define MAX_RECENT_FILES 4
  39
  40 WatchWindow::WatchWindow(QWidget* parent, const char* name, WFlags f) :
  41         QWidget(parent, name, f),
  42         m_watchEdit(this, "watch_edit"),
  43         m_watchAdd(i18n(" Add "), this, "watch_add"),
  44         m_watchDelete(i18n(" Del "), this, "watch_delete"),
  45         m_watchVariables(this, i18n("Expression"), "watch_variables"),
  46         m_watchV(this, 0),
  47         m_watchH(0)
  48 {
  49     // setup the layout
  50     m_watchAdd.setMinimumSize(m_watchAdd.sizeHint());
  51     m_watchDelete.setMinimumSize(m_watchDelete.sizeHint());
  52     m_watchV.addLayout(&m_watchH, 0);
  53     m_watchV.addWidget(&m_watchVariables, 10);
  54     m_watchH.addWidget(&m_watchEdit, 10);
  55     m_watchH.addWidget(&m_watchAdd, 0);
  56     m_watchH.addWidget(&m_watchDelete, 0);
  57
  58     connect(&m_watchEdit, SIGNAL(returnPressed()), SIGNAL(addWatch()));
  59     connect(&m_watchAdd, SIGNAL(clicked()), SIGNAL(addWatch()));
  60     connect(&m_watchDelete, SIGNAL(clicked()), SIGNAL(deleteWatch()));
  61     connect(&m_watchVariables, SIGNAL(currentChanged(QListViewItem*)),
  62             SLOT(slotWatchHighlighted()));
  63
  64     m_watchVariables.installEventFilter(this);
  65     setAcceptDrops(true);
  66 }
  67
  68 WatchWindow::~WatchWindow()
  69 {
  70 }
  71
  72 bool WatchWindow::eventFilter(QObject*, QEvent* ev)
  73 {
  74     if (ev->type() == QEvent::KeyPress)
  75     {
  76         QKeyEvent* kev = static_cast<QKeyEvent*>(ev);
  77         if (kev->key() == Key_Delete) {
  78             emit deleteWatch();
  79             return true;
  80         }
  81     }
  82     return false;
  83 }
  84
  85 void WatchWindow::dragEnterEvent(QDragEnterEvent* event)
  86 {
  87     event->accept(QTextDrag::canDecode(event));
  88 }
  89
  90 void WatchWindow::dropEvent(QDropEvent* event)
  91 {
  92     QString text;
  93     if (QTextDrag::decode(event, text))
  94     {
  95         // pick only the first line
  96         text = text.stripWhiteSpace();
  97         int pos = text.find('\n');
  98         if (pos > 0)
  99             text.truncate(pos);
 100         text = text.stripWhiteSpace();
 101         if (!text.isEmpty())
 102             emit textDropped(text);
 103     }
 104 }
 105
 106
 107 // place the text of the hightlighted watch expr in the edit field
 108 void WatchWindow::slotWatchHighlighted()
 109 {
 110     VarTree* expr = m_watchVariables.selectedItem();
 111     QString text = expr ? expr->computeExpr() : QString();
 112     m_watchEdit.setText(text);
 113 }
 114
 115
 116 const char defaultTermCmdStr[] = "xterm -name kdbgio -title %T -e sh -c %C";
 117 const char defaultSourceFilter[] = "*.c *.cc *.cpp *.c++ *.C *.CC";
 118 const char defaultHeaderFilter[] = "*.h *.hh *.hpp *.h++";
 119
 120
 121 DebuggerMainWndBase::DebuggerMainWndBase() :
 122         m_outputTermCmdStr(defaultTermCmdStr),
 123         m_outputTermProc(0),
 124         m_ttyLevel(-1),                 /* no tty yet */
 125 #ifdef GDB_TRANSCRIPT
 126         m_transcriptFile(GDB_TRANSCRIPT),
 127 #endif
 128         m_popForeground(false),
 129         m_backTimeout(1000),
 130         m_tabWidth(0),
 131         m_sourceFilter(defaultSourceFilter),
 132         m_headerFilter(defaultHeaderFilter),
 133         m_debugger(0)
 134 {
 135     m_statusActive = i18n("active");
 136 }
 137
 138 DebuggerMainWndBase::~DebuggerMainWndBase()
 139 {
 140     delete m_debugger;
 141
 142     // if the output window is open, close it
 143     if (m_outputTermProc != 0) {
 144         m_outputTermProc->disconnect(); /* ignore signals */
 145         m_outputTermProc->kill();
 146         shutdownTermWindow();
 147     }
 148 }
 149
 150 void DebuggerMainWndBase::setupDebugger(QWidget* parent,
 151                                         ExprWnd* localVars,
 152                                         ExprWnd* watchVars,
 153                                         QListBox* backtrace)
 154 {
 155     m_debugger = new KDebugger(parent, localVars, watchVars, backtrace);
 156
 157     QObject::connect(m_debugger, SIGNAL(updateStatusMessage()),
 158                      parent, SLOT(slotNewStatusMsg()));
 159     QObject::connect(m_debugger, SIGNAL(updateUI()),
 160                      parent, SLOT(updateUI()));
 161
 162     QObject::connect(m_debugger, SIGNAL(breakpointsChanged()),
 163                      parent, SLOT(updateLineItems()));
 164
 165     QObject::connect(m_debugger, SIGNAL(debuggerStarting()),
 166                      parent, SLOT(slotDebuggerStarting()));
 167 }
 168
 169
 170 void DebuggerMainWndBase::setCoreFile(const QString& corefile)
 171 {
 172     assert(m_debugger != 0);
 173     m_debugger->useCoreFile(corefile, true);
 174 }
 175
 176 void DebuggerMainWndBase::setRemoteDevice(const QString& remoteDevice)
 177 {
 178     if (m_debugger != 0) {
 179         m_debugger->setRemoteDevice(remoteDevice);
 180     }
 181 }
 182
 183 void DebuggerMainWndBase::overrideProgramArguments(const QString& args)
 184 {
 185     assert(m_debugger != 0);
 186     m_debugger->overrideProgramArguments(args);
 187 }
 188
 189 void DebuggerMainWndBase::setTranscript(const char* name)
 190 {
 191     m_transcriptFile = name;
 192     if (m_debugger != 0 && m_debugger->driver() != 0)
 193         m_debugger->driver()->setLogFileName(m_transcriptFile);
 194 }
 195
 196 const char OutputWindowGroup[] = "OutputWindow";
 197 const char TermCmdStr[] = "TermCmdStr";
 198 const char KeepScript[] = "KeepScript";
 199 const char DebuggerGroup[] = "Debugger";
 200 const char DebuggerCmdStr[] = "DebuggerCmdStr";
 201 const char PreferencesGroup[] = "Preferences";
 202 const char PopForeground[] = "PopForeground";
 203 const char BackTimeout[] = "BackTimeout";
 204 const char TabWidth[] = "TabWidth";
 205 const char FilesGroup[] = "Files";
 206 const char SourceFileFilter[] = "SourceFileFilter";
 207 const char HeaderFileFilter[] = "HeaderFileFilter";
 208 const char GeneralGroup[] = "General";
 209
 210 void DebuggerMainWndBase::saveSettings(KConfig* config)
 211 {
 212     if (m_debugger != 0) {
 213         m_debugger->saveSettings(config);
 214     }
 215
 216     KConfigGroupSaver g(config, OutputWindowGroup);
 217     config->writeEntry(TermCmdStr, m_outputTermCmdStr);
 218
 219     config->setGroup(DebuggerGroup);
 220     config->writeEntry(DebuggerCmdStr, m_debuggerCmdStr);
 221
 222     config->setGroup(PreferencesGroup);
 223     config->writeEntry(PopForeground, m_popForeground);
 224     config->writeEntry(BackTimeout, m_backTimeout);
 225     config->writeEntry(TabWidth, m_tabWidth);
 226     config->writeEntry(SourceFileFilter, m_sourceFilter);
 227     config->writeEntry(HeaderFileFilter, m_headerFilter);
 228 }
 229
 230 void DebuggerMainWndBase::restoreSettings(KConfig* config)
 231 {
 232     if (m_debugger != 0) {
 233         m_debugger->restoreSettings(config);
 234     }
 235
 236     KConfigGroupSaver g(config, OutputWindowGroup);
 237     /*
 238      * For debugging and emergency purposes, let the config file override
 239      * the shell script that is used to keep the output window open. This
 240      * string must have EXACTLY 1 %s sequence in it.
 241      */
 242     setTerminalCmd(config->readEntry(TermCmdStr, defaultTermCmdStr));
 243     m_outputTermKeepScript = config->readEntry(KeepScript);
 244
 245     config->setGroup(DebuggerGroup);
 246     setDebuggerCmdStr(config->readEntry(DebuggerCmdStr));
 247
 248     config->setGroup(PreferencesGroup);
 249     m_popForeground = config->readBoolEntry(PopForeground, false);
 250     m_backTimeout = config->readNumEntry(BackTimeout, 1000);
 251     m_tabWidth = config->readNumEntry(TabWidth, 0);
 252     m_sourceFilter = config->readEntry(SourceFileFilter, m_sourceFilter);
 253     m_headerFilter = config->readEntry(HeaderFileFilter, m_headerFilter);
 254 }
 255
 256 void DebuggerMainWndBase::setAttachPid(const QString& pid)
 257 {
 258     assert(m_debugger != 0);
 259     m_debugger->setAttachPid(pid);
 260 }
 261
 262 bool DebuggerMainWndBase::debugProgram(const QString& executable,
 263                                        QCString lang, QWidget* parent)
 264 {
 265     assert(m_debugger != 0);
 266
 267     TRACE(QString().sprintf("trying language '%s'...", lang.data()));
 268     DebuggerDriver* driver = driverFromLang(lang);
 269
 270     if (driver == 0)
 271     {
 272         // see if there is a language in the per-program config file
 273         QString configName = m_debugger->getConfigForExe(executable);
 274         if (QFile::exists(configName))
 275         {
 276             KSimpleConfig c(configName, true);  // read-only
 277             c.setGroup(GeneralGroup);
 278
 279             // Using "GDB" as default here is for backwards compatibility:
 280             // The config file exists but doesn't have an entry,
 281             // so it must have been created by an old version of KDbg
 282             // that had only the GDB driver.
 283             lang = c.readEntry(KDebugger::DriverNameEntry, "GDB").latin1();
 284
 285             TRACE(QString().sprintf("...bad, trying config driver %s...",
 286                           lang.data()));
 287             driver = driverFromLang(lang);
 288         }
 289
 290     }
 291     if (driver == 0)
 292     {
 293         QCString name = driverNameFromFile(executable);
 294
 295         TRACE(QString().sprintf("...no luck, trying %s derived"
 296                                 " from file contents", name.data()));
 297         driver = driverFromLang(name);
 298     }
 299     if (driver == 0)
 300     {
 301         // oops
 302         QString msg = i18n("Don't know how to debug language `%1'");
 303         KMessageBox::sorry(parent, msg.arg(lang));
 304         return false;
 305     }
 306
 307     driver->setLogFileName(m_transcriptFile);
 308
 309     bool success = m_debugger->debugProgram(executable, driver);
 310
 311     if (!success)
 312     {
 313         delete driver;
 314
 315         QString msg = i18n("Could not start the debugger process.\n"
 316                            "Please shut down KDbg and resolve the problem.");
 317         KMessageBox::sorry(parent, msg);
 318     }
 319
 320     return success;
 321 }
 322
 323 // derive driver from language
 324 DebuggerDriver* DebuggerMainWndBase::driverFromLang(QCString lang)
 325 {
 326     // lang is needed in all lowercase
 327     lang = lang.lower();
 328
 329     // The following table relates languages and debugger drivers
 330     static const struct L {
 331         const char* shortest;   // abbreviated to this is still unique
 332         const char* full;       // full name of language
 333         int driver;
 334     } langs[] = {
 335         { "c",       "c++",     1 },
 336         { "f",       "fortran", 1 },
 337         { "p",       "python",  3 },
 338         { "x",       "xslt",    2 },
 339         // the following are actually driver names
 340         { "gdb",     "gdb",     1 },
 341         { "xsldbg",  "xsldbg",  2 },
 342     };
 343     const int N = sizeof(langs)/sizeof(langs[0]);
 344
 345     // lookup the language name
 346     int driverID = 0;
 347     for (int i = 0; i < N; i++)
 348     {
 349         const L& l = langs[i];
 350
 351         // shortest must match
 352         if (strncmp(l.shortest, lang, strlen(l.shortest)) != 0)
 353             continue;
 354
 355         // lang must not be longer than the full name, and it must match
 356         if (lang.length() <= strlen(l.full) &&
 357             strncmp(l.full, lang, lang.length()) == 0)
 358         {
 359             driverID = l.driver;
 360             break;
 361         }
 362     }
 363     DebuggerDriver* driver = 0;
 364     switch (driverID) {
 365     case 1:
 366         {
 367             GdbDriver* gdb = new GdbDriver;
 368             gdb->setDefaultInvocation(m_debuggerCmdStr);
 369             driver = gdb;
 370         }
 371         break;
 372     case 2:
 373         driver = new XsldbgDriver;
 374         break;
 375     default:
 376         // unknown language
 377         break;
 378     }
 379     return driver;
 380 }
 381
 382 /**
 383  * Try to guess the language to use from the contents of the file.
 384  */
 385 QCString DebuggerMainWndBase::driverNameFromFile(const QString& exe)
 386 {
 387     /* Inprecise but simple test to see if file is in XSLT language */
 388     if (exe.right(4).lower() == ".xsl")
 389         return "XSLT";
 390
 391     return "GDB";
 392 }
 393
 394 // helper that gets a file name (it only differs in the caption of the dialog)
 395 QString DebuggerMainWndBase::myGetFileName(QString caption,
 396                            QString dir, QString filter,
 397                            QWidget* parent)
 398 {
 399     QString filename;
 400     KFileDialog dlg(dir, filter, parent, "filedialog", true);
 401
 402     dlg.setCaption(caption);
 403
 404     if (dlg.exec() == QDialog::Accepted)
 405         filename = dlg.selectedFile();
 406
 407     return filename;
 408 }
 409
 410 void DebuggerMainWndBase::newStatusMsg(KStatusBar* statusbar)
 411 {
 412     QString msg = m_debugger->statusMessage();
 413     statusbar->changeItem(msg, ID_STATUS_MSG);
 414 }
 415
 416 void DebuggerMainWndBase::doGlobalOptions(QWidget* parent)
 417 {
 418     QTabDialog dlg(parent, "global_options", true);
 419     QString title = kapp->caption();
 420     title += i18n(": Global options");
 421     dlg.setCaption(title);
 422     dlg.setCancelButton(i18n("Cancel"));
 423     dlg.setOKButton(i18n("OK"));
 424
 425     PrefDebugger prefDebugger(&dlg);
 426     prefDebugger.setDebuggerCmd(m_debuggerCmdStr.isEmpty()  ?
 427                                 GdbDriver::defaultGdb()  :  m_debuggerCmdStr);
 428     prefDebugger.setTerminal(m_outputTermCmdStr);
 429
 430     PrefMisc prefMisc(&dlg);
 431     prefMisc.setPopIntoForeground(m_popForeground);
 432     prefMisc.setBackTimeout(m_backTimeout);
 433     prefMisc.setTabWidth(m_tabWidth);
 434     prefMisc.setSourceFilter(m_sourceFilter);
 435     prefMisc.setHeaderFilter(m_headerFilter);
 436
 437     dlg.addTab(&prefDebugger, i18n("&Debugger"));
 438     dlg.addTab(&prefMisc, i18n("&Miscellaneous"));
 439     if (dlg.exec() == QDialog::Accepted)
 440     {
 441         setDebuggerCmdStr(prefDebugger.debuggerCmd());
 442         setTerminalCmd(prefDebugger.terminal());
 443         m_popForeground = prefMisc.popIntoForeground();
 444         m_backTimeout = prefMisc.backTimeout();
 445         m_tabWidth = prefMisc.tabWidth();
 446         m_sourceFilter = prefMisc.sourceFilter();
 447         if (m_sourceFilter.isEmpty())
 448             m_sourceFilter = defaultSourceFilter;
 449         m_headerFilter = prefMisc.headerFilter();
 450         if (m_headerFilter.isEmpty())
 451             m_headerFilter = defaultHeaderFilter;
 452     }
 453 }
 454
 455 const char fifoNameBase[] = "/tmp/kdbgttywin%05d";
 456
 457 /*
 458  * We use the scope operator :: in this function, so that we don't
 459  * accidentally use the wrong close() function (I've been bitten ;-),
 460  * outch!) (We use it for all the libc functions, to be consistent...)
 461  */
 462 QString DebuggerMainWndBase::createOutputWindow()
 463 {
 464     // create a name for a fifo
 465     QString fifoName;
 466     fifoName.sprintf(fifoNameBase, ::getpid());
 467
 468     // create a fifo that will pass in the tty name
 469     ::unlink(fifoName);                 /* remove remnants */
 470 #ifdef HAVE_MKFIFO
 471     if (::mkfifo(fifoName, S_IRUSR|S_IWUSR) < 0) {
 472         // failed
 473         TRACE("mkfifo " + fifoName + " failed");
 474         return QString();
 475     }
 476 #else
 477     if (::mknod(fifoName, S_IFIFO | S_IRUSR|S_IWUSR, 0) < 0) {
 478         // failed
 479         TRACE("mknod " + fifoName + " failed");
 480         return QString();
 481     }
 482 #endif
 483
 484     m_outputTermProc = new KProcess;
 485
 486     {
 487         /*
 488          * Spawn an xterm that in turn runs a shell script that passes us
 489          * back the terminal name and then only sits and waits.
 490          */
 491         static const char shellScriptFmt[] =
 492             "tty>%s;"
 493             "trap \"\" INT QUIT TSTP;"  /* ignore various signals */
 494             "exec<&-;exec>&-;"          /* close stdin and stdout */
 495             "while :;do sleep 3600;done";
 496         // let config file override this script
 497         const char* fmt = shellScriptFmt;
 498         if (m_outputTermKeepScript.length() != 0) {
 499             fmt = m_outputTermKeepScript.data();
 500         }
 501
 502         QString shellScript;
 503         shellScript.sprintf(fmt, fifoName.data());
 504         TRACE("output window script is " + shellScript);
 505
 506         QString title = kapp->caption();
 507         title += i18n(": Program output");
 508
 509         // parse the command line specified in the preferences
 510         QStringList cmdParts = QStringList::split(' ', m_outputTermCmdStr);
 511
 512         /*
 513          * Build the argv array. Thereby substitute special sequences:
 514          */
 515         struct {
 516             char seq[4];
 517             QString replace;
 518         } substitute[] = {
 519             { "%T", title },
 520             { "%C", shellScript }
 521         };
 522
 523         for (QStringList::iterator i = cmdParts.begin(); i != cmdParts.end(); ++i)
 524         {
 525             QString& str = *i;
 526             for (int j = sizeof(substitute)/sizeof(substitute[0])-1; j >= 0; j--) {
 527                 int pos = str.find(substitute[j].seq);
 528                 if (pos >= 0) {
 529                     str.replace(pos, 2, substitute[j].replace);
 530                     break;              /* substitute only one sequence */
 531                 }
 532             }
 533             *m_outputTermProc << str;
 534         }
 535
 536     }
 537
 538     if (m_outputTermProc->start())
 539     {
 540         // read the ttyname from the fifo
 541         int f = ::open(fifoName, O_RDONLY);
 542         if (f < 0) {
 543             // error
 544             ::unlink(fifoName);
 545             return QString();
 546         }
 547
 548         char ttyname[50];
 549         int n = ::read(f, ttyname, sizeof(ttyname)-sizeof(char));   /* leave space for '\0' */
 550
 551         ::close(f);
 552         ::unlink(fifoName);
 553
 554         if (n < 0) {
 555             // error
 556             return QString();
 557         }
 558
 559         // remove whitespace
 560         ttyname[n] = '\0';
 561         QString tty = QString(ttyname).stripWhiteSpace();
 562         TRACE("tty=" + tty);
 563         return tty;
 564     }
 565     else
 566     {
 567         // error, could not start xterm
 568         TRACE("fork failed for fifo " + fifoName);
 569         ::unlink(fifoName);
 570         shutdownTermWindow();
 571         return QString();
 572     }
 573 }
 574
 575 void DebuggerMainWndBase::shutdownTermWindow()
 576 {
 577     delete m_outputTermProc;
 578     m_outputTermProc = 0;
 579 }
 580
 581 void DebuggerMainWndBase::setTerminalCmd(const QString& cmd)
 582 {
 583     m_outputTermCmdStr = cmd;
 584     // revert to default if empty
 585     if (m_outputTermCmdStr.isEmpty()) {
 586         m_outputTermCmdStr = defaultTermCmdStr;
 587     }
 588 }
 589
 590 void DebuggerMainWndBase::slotDebuggerStarting()
 591 {
 592     if (m_debugger == 0)                /* paranoia check */
 593         return;
 594
 595     if (m_ttyLevel == m_debugger->ttyLevel())
 596     {
 597     }
 598     else
 599     {
 600         // shut down terminal emulations we will not need
 601         switch (m_ttyLevel) {
 602         case KDebugger::ttySimpleOutputOnly:
 603             ttyWindow()->deactivate();
 604             break;
 605         case KDebugger::ttyFull:
 606             if (m_outputTermProc != 0) {
 607                 m_outputTermProc->kill();
 608                 // will be deleted in slot
 609             }
 610             break;
 611         default: break;
 612         }
 613
 614         m_ttyLevel = m_debugger->ttyLevel();
 615
 616         QString ttyName;
 617         switch (m_ttyLevel) {
 618         case KDebugger::ttySimpleOutputOnly:
 619             ttyName = ttyWindow()->activate();
 620             break;
 621         case KDebugger::ttyFull:
 622             if (m_outputTermProc == 0) {
 623                 // create an output window
 624                 ttyName = createOutputWindow();
 625                 TRACE(ttyName.isEmpty() ?
 626                       "createOuputWindow failed" : "successfully created output window");
 627             }
 628             break;
 629         default: break;
 630         }
 631
 632         m_debugger->setTerminal(ttyName);
 633     }
 634 }
 635
 636 void DebuggerMainWndBase::setDebuggerCmdStr(const QString& cmd)
 637 {
 638     m_debuggerCmdStr = cmd;
 639     // make empty if it is the default
 640     if (m_debuggerCmdStr == GdbDriver::defaultGdb()) {
 641         m_debuggerCmdStr = QString();
 642     }
 643 }
 644
 645
 646 #include "mainwndbase.moc"