qt-creator/src/plugins/debugger/gdb/abstractplaingdbadapter.cpp

/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** No Commercial Usage
**
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**************************************************************************/

#include "abstractplaingdbadapter.h"
#include "gdbmi.h"
#include "gdbengine.h"
#include "debuggerstartparameters.h"
#include "debuggeractions.h"
#include "debuggercore.h"
#include "debuggerstringutils.h"

#include <QDir>
#include <QFile>
#include <QTemporaryFile>

#include <utils/qtcassert.h>

namespace Debugger {
namespace Internal {

#define CB(callback) \
    static_cast<GdbEngine::AdapterCallback>(&AbstractPlainGdbAdapter::callback), \
    STRINGIFY(callback)

AbstractPlainGdbAdapter::AbstractPlainGdbAdapter(GdbEngine *engine,
                                                 QObject *parent)
    : AbstractGdbAdapter(engine, parent)
{
}

void AbstractPlainGdbAdapter::setupInferior()
{
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
    if (!startParameters().processArgs.isEmpty()) {
        QString args = startParameters().processArgs;
        m_engine->postCommand("-exec-arguments " + toLocalEncoding(args));
    }
    m_engine->postCommand("-file-exec-and-symbols \"" + execFilePath() + '"',
        CB(handleFileExecAndSymbols));
}

void AbstractPlainGdbAdapter::handleFileExecAndSymbols(const GdbResponse &response)
{
    QTC_ASSERT(state() == InferiorSetupRequested, qDebug() << state());
    if (response.resultClass == GdbResultDone) {
        if (infoTargetNecessary()) {
            // Old gdbs do not announce the PID for programs without pthreads.
            // Note that successfully preloading the debugging helpers will
            // automatically load pthreads, so this will be unnecessary.
            if (m_engine->m_gdbVersion < 70000)
                m_engine->postCommand("info target", CB(handleInfoTarget));
        }
        //if (m_engine->isSlaveEngine())
            //m_engine->postCommand("qmlb", GdbEngine::ConsoleCommand);
            //m_engine->postCommand("rbreak QScript::FunctionWrapper::proxyCall");
         //   m_engine->postCommand("-break-insert -f 'myns::QScript::FunctionWrapper::proxyCall'");
        m_engine->handleInferiorPrepared();
    } else {
        QByteArray ba = response.data.findChild("msg").data();
        QString msg = fromLocalEncoding(ba);
        // Extend the message a bit in unknown cases.
        if (!ba.endsWith("File format not recognized"))
            msg = tr("Starting executable failed:\n") + msg;
        m_engine->notifyInferiorSetupFailed(msg);
    }
}

void AbstractPlainGdbAdapter::runEngine()
{
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    QString fileName;
    {
        QTemporaryFile symbols(QDir::tempPath() + "/gdb_ns_");
        symbols.open();
        fileName = symbols.fileName();
    }
    m_engine->postCommand("maint print msymbols " + fileName.toLocal8Bit(),
        CB(handleNamespaceExtraction1), fileName);
    //m_engine->postCommand("print QString", CB(handleNamespaceExtraction));
}

void AbstractPlainGdbAdapter::handleNamespaceExtraction1(const GdbResponse &response)
{
    QFile file(response.cookie.toString());
    file.open(QIODevice::ReadOnly);
    QByteArray ba = file.readAll();
    int pos = ba.indexOf("7QString9fromAscii");
    int pos1 = pos - 1;
    while (pos1 > 0 && ba.at(pos1) != 'N' && ba.at(pos1) > '@')
        --pos1;
    ++pos1;
    const QByteArray ns = ba.mid(pos1, pos - pos1);
    if (!ns.isEmpty())
        m_engine->setQtNamespace(ns + "::");
    if (m_engine->isSlaveEngine()) {
        for (int i = 1; i <= 8; ++i) {
            m_engine->postCommand("-break-insert -f '" + m_engine->qtNamespace()
                 + "QScript::qScriptBreaker" + QByteArray::number(i) + "'",
                 CB(handleFindScriptBreaker), i);
        }
    } else {
        doRunEngine();
    }
    file.remove();
}

void AbstractPlainGdbAdapter::handleNamespaceExtraction(const GdbResponse &response)
{
    if (response.resultClass == GdbResultDone) {
        // $1 = {void (myns::QString * const, const char *)} 0x8058e2c <QString>"}
        const QByteArray ba = response.data.findChild("consolestreamoutput").data();
        const int posQString = ba.indexOf("QString");
        const int posNs = ba.lastIndexOf('(', posQString) + 1;
        const QByteArray ns = ba.mid(posNs, posQString - posNs);
        if (!ns.isEmpty())
            m_engine->setQtNamespace(ns);
    }
    if (m_engine->isSlaveEngine()) {
        for (int i = 1; i <= 8; ++i) {
            m_engine->postCommand("-break-insert -f '" + m_engine->qtNamespace()
                 + "QScript::qScriptBreaker" + QByteArray::number(i) + "'",
                 CB(handleFindScriptBreaker), i);
        }
    } else {
        doRunEngine();
    }
}

void AbstractPlainGdbAdapter::handleFindScriptBreaker(const GdbResponse &response)
{
    //QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    if (response.resultClass == GdbResultDone) {
        const int qmlBpType = response.cookie.toInt();
        // 20^done,bkpt={number="2",type="breakpoint",disp="keep",enabled="y",
        // addr="<PENDING>",pending="'myns::QScript::qScriptBreaker'"
        const GdbMi bkpt = response.data.findChild("bkpt");
        const GdbMi number = bkpt.findChild("number");
        const int bpnr = number.data().toInt();
        m_engine->addQmlBreakpointNumber(qmlBpType, bpnr);
        //m_engine->postCommand("disable " + number.data());
        switch (qmlBpType) {
            case 5:
                m_engine->postCommand("enable " + number.data());
                m_engine->postCommand("command " + number.data() +
                    //"\necho \"STEP NOW\"\nfinish\nend")
                        "\nup"
                        "\necho \"YYY\""
                        "\ntbreak"
                        "\ncommands"
                            "\necho \"XXX\""
                            "\nstep"
                        "\nend"
                        "\ncontinue"
                    "\nend");
                break;
            default:
                //m_engine->postCommand("command " + number.data() +
                //    "\nfinish\nend");
                break;
        }
    }
    if (response.cookie.toInt() == 8)
        doRunEngine();
}

void AbstractPlainGdbAdapter::doRunEngine()
{
    m_engine->postCommand("-exec-run", GdbEngine::RunRequest, CB(handleExecRun));
}

void AbstractPlainGdbAdapter::handleExecRun(const GdbResponse &response)
{
    QTC_ASSERT(state() == EngineRunRequested, qDebug() << state());
    if (response.resultClass == GdbResultRunning) {
        m_engine->notifyEngineRunAndInferiorRunOk();
        //showStatusMessage(tr("Running..."));
        showMessage(_("INFERIOR STARTED"));
        showMessage(msgInferiorSetupOk(), StatusBar);
        // FIXME: That's the wrong place for it.
        if (debuggerCore()->boolSetting(EnableReverseDebugging))
            m_engine->postCommand("target record");
    } else {
        QString msg = fromLocalEncoding(response.data.findChild("msg").data());
        //QTC_ASSERT(status() == InferiorRunOk, /**/);
        //interruptInferior();
        showMessage(msg);
        m_engine->notifyEngineRunFailed();
    }
}

void AbstractPlainGdbAdapter::handleInfoTarget(const GdbResponse &response)
{
    if (response.resultClass == GdbResultDone) {
        // [some leading stdout here]
        // >&"        Entry point: 0x80831f0  0x08048134 - 0x08048147 is .interp\n"
        // [some trailing stdout here]
        QString msg = _(response.data.findChild("consolestreamoutput").data());
        QRegExp needle(_("\\bEntry point: 0x([0-9a-f]+)\\b"));
        if (needle.indexIn(msg) != -1) {
            m_engine->m_entryPoint =
                    "0x" + needle.cap(1).toLatin1().rightJustified(sizeof(void *) * 2, '0');
            m_engine->postCommand("tbreak *0x" + needle.cap(1).toAscii());
            // Do nothing here - inferiorPrepared handles the sequencing.
        } else {
            m_engine->notifyInferiorSetupFailed(_("Parsing start address failed"));
        }
    } else if (response.resultClass == GdbResultError) {
        m_engine->notifyInferiorSetupFailed(_("Fetching start address failed"));
    }
}

} // namespace Debugger
} // namespace Internal