gdbmi.cpp 12.6 KB
Newer Older
1
/**************************************************************************
con's avatar
con committed
2 3 4
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
con's avatar
con committed
6
**
7
** Contact: Nokia Corporation (qt-info@nokia.com)
con's avatar
con committed
8
**
9
**
10
** GNU Lesser General Public License Usage
11
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
29
** Nokia at qt-info@nokia.com.
con's avatar
con committed
30
**
31
**************************************************************************/
hjk's avatar
hjk committed
32

con's avatar
con committed
33
#include "gdbmi.h"
hjk's avatar
hjk committed
34 35

#include <utils/qtcassert.h>
con's avatar
con committed
36 37

#include <QtCore/QByteArray>
38
#include <QtCore/QRegExp>
con's avatar
con committed
39 40
#include <QtCore/QTextStream>

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
41 42
#include <ctype.h>

con's avatar
con committed
43 44 45
namespace Debugger {
namespace Internal {

46 47 48 49 50 51
void skipCommas(const char *&from, const char *to)
{
    while (*from == ',' && from != to)
        ++from;
}

52
QTextStream &operator<<(QTextStream &os, const GdbMi &mi)
con's avatar
con committed
53 54 55 56
{
    return os << mi.toString();
}

57
void GdbMi::parseResultOrValue(const char *&from, const char *to)
con's avatar
con committed
58
{
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
59
    while (from != to && isspace(*from))
con's avatar
con committed
60 61
        ++from;

62
    //qDebug() << "parseResultOrValue: " << QByteArray(from, to - from);
con's avatar
con committed
63 64
    parseValue(from, to);
    if (isValid()) {
65
        //qDebug() << "no valid result in " << QByteArray(from, to - from);
con's avatar
con committed
66 67 68 69
        return;
    }
    if (from == to || *from == '(')
        return;
70
    const char *ptr = from;
con's avatar
con committed
71 72 73 74 75 76 77 78 79 80 81 82
    while (ptr < to && *ptr != '=') {
        //qDebug() << "adding" << QChar(*ptr) << "to name";
        ++ptr;
    }
    m_name = QByteArray(from, ptr - from);
    from = ptr;
    if (from < to && *from == '=') {
        ++from;
        parseValue(from, to);
    }
}

83
QByteArray GdbMi::parseCString(const char *&from, const char *to)
con's avatar
con committed
84 85
{
    QByteArray result;
86
    //qDebug() << "parseCString: " << QByteArray(from, to - from);
con's avatar
con committed
87 88
    if (*from != '"') {
        qDebug() << "MI Parse Error, double quote expected";
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
89
        ++from; // So we don't hang
con's avatar
con committed
90 91
        return QByteArray();
    }
92
    const char *ptr = from;
con's avatar
con committed
93 94 95 96 97 98 99
    ++ptr;
    while (ptr < to) {
        if (*ptr == '"') {
            ++ptr;
            result = QByteArray(from + 1, ptr - from - 2);
            break;
        }
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
100
        if (*ptr == '\\') {
con's avatar
con committed
101
            ++ptr;
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
102 103 104 105 106 107
            if (ptr == to) {
                qDebug() << "MI Parse Error, unterminated backslash escape";
                from = ptr; // So we don't hang
                return QByteArray();
            }
        }
con's avatar
con committed
108 109
        ++ptr;
    }
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
110
    from = ptr;
con's avatar
con committed
111

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
    int idx = result.indexOf('\\');
    if (idx >= 0) {
        char *dst = result.data() + idx;
        const char *src = dst + 1, *end = result.data() + result.length();
        do {
            char c = *src++;
            switch (c) {
                case 'a': *dst++ = '\a'; break;
                case 'b': *dst++ = '\b'; break;
                case 'f': *dst++ = '\f'; break;
                case 'n': *dst++ = '\n'; break;
                case 'r': *dst++ = '\r'; break;
                case 't': *dst++ = '\t'; break;
                case 'v': *dst++ = '\v'; break;
                case '"': *dst++ = '"'; break;
                case '\\': *dst++ = '\\'; break;
                default:
                    {
                        int chars = 0;
                        uchar prod = 0;
                        forever {
                            if (c < '0' || c > '7') {
                                --src;
                                break;
                            }
                            prod = prod * 8 + c - '0';
                            if (++chars == 3 || src == end)
                                break;
                            c = *src++;
                        }
                        if (!chars) {
                            qDebug() << "MI Parse Error, unrecognized backslash escape";
                            return QByteArray();
                        }
                        *dst++ = prod;
                    }
            }
            while (src != end) {
                char c = *src++;
                if (c == '\\')
                    break;
                *dst++ = c;
            }
        } while (src != end);
        *dst = 0;
        result.truncate(dst - result.data());
con's avatar
con committed
158 159 160 161 162
    }

    return result;
}

163
void GdbMi::parseValue(const char *&from, const char *to)
con's avatar
con committed
164
{
165
    //qDebug() << "parseValue: " << QByteArray(from, to - from);
con's avatar
con committed
166
    switch (*from) {
hjk's avatar
hjk committed
167 168 169 170 171 172 173 174 175 176 177 178
        case '{':
            parseTuple(from, to);
            break;
        case '[':
            parseList(from, to);
            break;
        case '"':
            m_type = Const;
            m_data = parseCString(from, to);
            break;
        default:
            break;
con's avatar
con committed
179 180 181 182
    }
}


183
void GdbMi::parseTuple(const char *&from, const char *to)
con's avatar
con committed
184
{
185
    //qDebug() << "parseTuple: " << QByteArray(from, to - from);
186
    QTC_CHECK(*from == '{');
con's avatar
con committed
187 188 189 190
    ++from;
    parseTuple_helper(from, to);
}

191
void GdbMi::parseTuple_helper(const char *&from, const char *to)
con's avatar
con committed
192
{
193
    skipCommas(from, to);
194
    //qDebug() << "parseTuple_helper: " << QByteArray(from, to - from);
con's avatar
con committed
195 196 197 198 199 200 201 202 203 204 205 206
    m_type = Tuple;
    while (from < to) {
        if (*from == '}') {
            ++from;
            break;
        }
        GdbMi child;
        child.parseResultOrValue(from, to);
        //qDebug() << "\n=======\n" << qPrintable(child.toString()) << "\n========\n";
        if (!child.isValid())
            return;
        m_children += child;
207
        skipCommas(from, to);
con's avatar
con committed
208 209 210
    }
}

211
void GdbMi::parseList(const char *&from, const char *to)
con's avatar
con committed
212
{
213
    //qDebug() << "parseList: " << QByteArray(from, to - from);
214
    QTC_CHECK(*from == '[');
con's avatar
con committed
215 216
    ++from;
    m_type = List;
217
    skipCommas(from, to);
con's avatar
con committed
218 219 220 221 222 223 224 225 226
    while (from < to) {
        if (*from == ']') {
            ++from;
            break;
        }
        GdbMi child;
        child.parseResultOrValue(from, to);
        if (child.isValid())
            m_children += child;
227
        skipCommas(from, to);
con's avatar
con committed
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
    }
}

static QByteArray ind(int indent)
{
    return QByteArray(2 * indent, ' ');
}

void GdbMi::dumpChildren(QByteArray * str, bool multiline, int indent) const
{
    for (int i = 0; i < m_children.size(); ++i) {
        if (i != 0) {
            *str += ',';
            if (multiline)
                *str += '\n';
        }
        if (multiline)
            *str += ind(indent);
        *str += m_children.at(i).toString(multiline, indent);
    }
}

250 251 252 253 254 255 256
class MyString : public QString {
public:
    ushort at(int i) const { return constData()[i].unicode(); }
};

template<class ST, typename CT>
inline ST escapeCStringTpl(const ST &ba)
257
{
258
    ST ret;
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
259 260
    ret.reserve(ba.length() * 2);
    for (int i = 0; i < ba.length(); ++i) {
261
        CT c = ba.at(i);
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
        switch (c) {
            case '\\': ret += "\\\\"; break;
            case '\a': ret += "\\a"; break;
            case '\b': ret += "\\b"; break;
            case '\f': ret += "\\f"; break;
            case '\n': ret += "\\n"; break;
            case '\r': ret += "\\r"; break;
            case '\t': ret += "\\t"; break;
            case '\v': ret += "\\v"; break;
            case '"': ret += "\\\""; break;
            default:
                if (c < 32 || c == 127) {
                    ret += '\\';
                    ret += '0' + (c >> 6);
                    ret += '0' + ((c >> 3) & 7);
                    ret += '0' + (c & 7);
                } else {
                    ret += c;
                }
        }
    }
    return ret;
284 285
}

286 287 288 289 290 291 292 293 294 295
QString GdbMi::escapeCString(const QString &ba)
{
    return escapeCStringTpl<MyString, ushort>(static_cast<const MyString &>(ba));
}

QByteArray GdbMi::escapeCString(const QByteArray &ba)
{
    return escapeCStringTpl<QByteArray, uchar>(ba);
}

con's avatar
con committed
296 297 298 299
QByteArray GdbMi::toString(bool multiline, int indent) const
{
    QByteArray result;
    switch (m_type) {
hjk's avatar
hjk committed
300 301 302 303 304 305
        case Invalid:
            if (multiline)
                result += ind(indent) + "Invalid\n";
            else
                result += "Invalid";
            break;
306
        case Const:
hjk's avatar
hjk committed
307
            if (!m_name.isEmpty())
308 309
                result += m_name + '=';
            result += '"' + escapeCString(m_data) + '"';
hjk's avatar
hjk committed
310 311 312
            break;
        case Tuple:
            if (!m_name.isEmpty())
313
                result += m_name + '=';
hjk's avatar
hjk committed
314 315 316
            if (multiline) {
                result += "{\n";
                dumpChildren(&result, multiline, indent + 1);
317
                result += '\n' + ind(indent) + '}';
hjk's avatar
hjk committed
318
            } else {
319
                result += '{';
hjk's avatar
hjk committed
320
                dumpChildren(&result, multiline, indent + 1);
321
                result += '}';
hjk's avatar
hjk committed
322 323 324 325
            }
            break;
        case List:
            if (!m_name.isEmpty())
326
                result += m_name + '=';
hjk's avatar
hjk committed
327 328 329
            if (multiline) {
                result += "[\n";
                dumpChildren(&result, multiline, indent + 1);
330
                result += '\n' + ind(indent) + ']';
hjk's avatar
hjk committed
331
            } else {
332
                result += '[';
hjk's avatar
hjk committed
333
                dumpChildren(&result, multiline, indent + 1);
334
                result += ']';
hjk's avatar
hjk committed
335 336
            }
            break;
con's avatar
con committed
337 338 339 340 341 342
    }
    return result;
}

void GdbMi::fromString(const QByteArray &ba)
{
343 344
    const char *from = ba.constBegin();
    const char *to = ba.constEnd();
con's avatar
con committed
345 346 347
    parseResultOrValue(from, to);
}

348 349 350 351 352 353 354
void GdbMi::fromStringMultiple(const QByteArray &ba)
{
    const char *from = ba.constBegin();
    const char *to = ba.constEnd();
    parseTuple_helper(from, to);
}

355
GdbMi GdbMi::findChild(const char *name) const
con's avatar
con committed
356 357 358 359 360 361 362
{
    for (int i = 0; i < m_children.size(); ++i)
        if (m_children.at(i).m_name == name)
            return m_children.at(i);
    return GdbMi();
}

363 364 365 366 367 368 369
qulonglong GdbMi::toAddress() const
{
    QByteArray ba = m_data;
    if (ba.endsWith('L'))
        ba.chop(1);
    if (ba.startsWith('*') || ba.startsWith('@'))
        ba = ba.mid(1);
370
    return ba.toULongLong(0, 0);
371 372
}

con's avatar
con committed
373 374
//////////////////////////////////////////////////////////////////////////////////
//
hjk's avatar
hjk committed
375
// GdbResponse
con's avatar
con committed
376 377 378
//
//////////////////////////////////////////////////////////////////////////////////

379
QByteArray GdbResponse::stringFromResultClass(GdbResultClass resultClass)
con's avatar
con committed
380 381 382 383 384 385 386 387 388
{
    switch (resultClass) {
        case GdbResultDone: return "done";
        case GdbResultRunning: return "running";
        case GdbResultConnected: return "connected";
        case GdbResultError: return "error";
        case GdbResultExit: return "exit";
        default: return "unknown";
    }
389
}
con's avatar
con committed
390

hjk's avatar
hjk committed
391
QByteArray GdbResponse::toString() const
con's avatar
con committed
392 393 394 395 396 397 398 399 400 401 402 403
{
    QByteArray result;
    if (token != -1)
        result = QByteArray::number(token);
    result += '^';
    result += stringFromResultClass(resultClass);
    if (data.isValid())
        result += ',' + data.toString();
    result += '\n';
    return result;
}

404 405 406 407 408 409 410 411

//////////////////////////////////////////////////////////////////////////////////
//
// GdbResponse
//
//////////////////////////////////////////////////////////////////////////////////

void extractGdbVersion(const QString &msg,
412
    int *gdbVersion, int *gdbBuildVersion, bool *isMacGdb, bool *isQnxGdb)
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
{
    const QChar dot(QLatin1Char('.'));

    QString cleaned;
    QString build;
    bool inClean = true;
    foreach (QChar c, msg) {
        if (inClean && !cleaned.isEmpty() && c != dot && (c.isPunct() || c.isSpace()))
            inClean = false;
        if (inClean) {
            if (c.isDigit())
                cleaned.append(c);
            else if (!cleaned.isEmpty() && !cleaned.endsWith(dot))
                cleaned.append(dot);
        } else {
            if (c.isDigit())
                build.append(c);
            else if (!build.isEmpty() && !build.endsWith(dot))
                build.append(dot);
        }
    }

    *isMacGdb = msg.contains(QLatin1String("Apple version"));
436
    *isQnxGdb = msg.contains(QLatin1String("qnx-nto"));
437 438 439 440 441 442 443 444 445 446 447 448 449

    *gdbVersion = 10000 * cleaned.section(dot, 0, 0).toInt()
                  + 100 * cleaned.section(dot, 1, 1).toInt()
                    + 1 * cleaned.section(dot, 2, 2).toInt();
    if (cleaned.count(dot) >= 3)
        *gdbBuildVersion = cleaned.section(dot, 3, 3).toInt();
    else
        *gdbBuildVersion = build.section(dot, 0, 0).toInt();

    if (*isMacGdb)
        *gdbBuildVersion = build.section(dot, 1, 1).toInt();
}

con's avatar
con committed
450 451
} // namespace Internal
} // namespace Debugger