/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the tools applications of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** 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.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include "trkutils.h"

#include <ctype.h>

#include <QtCore/QCoreApplication>

#include <QtCore/QDebug>

#include <QtCore/QDate>

#include <QtCore/QDateTime>

#include <QtCore/QTime>

#define logMessage(s)  do { qDebug() << "TRKCLIENT: " << s; } while (0)

namespace trk {

Library::Library() : codeseg(0), dataseg(0), pid(0)

{

}

Library::Library(const TrkResult &result) : codeseg(0), dataseg(0), pid(0)

{

    if (result.data.size() < 20) {

        qWarning("Invalid trk creation notification received.");

        return;

    }

    const char *data = result.data.constData();

    pid = extractInt(data + 2);

    codeseg = extractInt(data + 10);

    dataseg = extractInt(data + 14);

    const uint len = extractShort(data + 18);

    name = result.data.mid(20, len);

}

TrkAppVersion::TrkAppVersion()

{

    reset();

}

void TrkAppVersion::reset()

{

    trkMajor = trkMinor= protocolMajor = protocolMinor = 0;

}

Session::Session()

{

    reset();

}

void Session::reset()

{

    cpuMajor = 0;

    cpuMinor = 0;

    bigEndian = 0;

    defaultTypeSize = 0;

    fpTypeSize = 0;

    extended1TypeSize = 0;

    extended2TypeSize = 0;

    pid = 0;

    mainTid = 0;

    tid = 0;

    codeseg = 0;

    dataseg = 0;

    libraries.clear();

    trkAppVersion.reset();

}

static QString formatCpu(int major, int minor)

{

    //: CPU description of an S60 device

    //: %1 major verison, %2 minor version

    //: %3 real name of major verison, %4 real name of minor version

    const QString str = QCoreApplication::translate("trk::Session", "CPU: v%1.%2%3%4");

    QString majorStr;

    QString minorStr;

    switch (major) {

    case 0x04:

        majorStr = " ARM";

        break;

    }

    switch (minor) {

    case 0x00:

        minorStr = " 920T";

        break;

    }

    return str.arg(major).arg(minor).arg(majorStr).arg(minorStr);

 }

QString formatTrkVersion(const TrkAppVersion &version)

{

    QString str = QCoreApplication::translate("trk::Session",

                                              "App TRK: v%1.%2 TRK protocol: v%3.%4");

    str = str.arg(version.trkMajor).arg(version.trkMinor);

    return str.arg(version.protocolMajor).arg(version.protocolMinor);

}

QString Session::deviceDescription(unsigned verbose) const

{

    if (!cpuMajor)

        return QString();

    //: s60description

    //: description of an S60 device

    //: %1 CPU description, %2 endianness

    //: %3 default type size (if any), %4 float size (if any)

    //: %5 TRK version

    QString msg = QCoreApplication::translate("trk::Session", "%1, %2%3%4, %5");

    QString endianness = bigEndian

                         ? QCoreApplication::translate("trk::Session", "big endian")

                         : QCoreApplication::translate("trk::Session", "little endian");

    msg = msg.arg(formatCpu(cpuMajor, cpuMinor)).arg(endianness);

    //: The separator in a list of strings

    QString defaultTypeSizeStr;

    QString fpTypeSizeStr;

    if (verbose && defaultTypeSize)

        //: will be inserted into s60description

        defaultTypeSizeStr = QCoreApplication::translate("trk::Session", ", type size: %1").arg(defaultTypeSize);

    if (verbose && fpTypeSize)

        //: will be inserted into s60description

        fpTypeSizeStr = QCoreApplication::translate("trk::Session", ", float size: %1").arg(fpTypeSize);

    msg = msg.arg(defaultTypeSizeStr).arg(fpTypeSizeStr);

    return msg.arg(formatTrkVersion(trkAppVersion));

}

QByteArray Session::gdbLibraryList() const

{

    const int count = libraries.size();

    QByteArray response = "l<library-list>";

    for (int i = 0; i != count; ++i) {

        const trk::Library &lib = libraries.at(i);

        response += "<library name=\"";

        response += lib.name;

        response += "\">";

        response += "<section address=\"0x";

        response += trk::hexNumber(lib.codeseg);

        response += "\"/>";

        response += "<section address=\"0x";

        response += trk::hexNumber(lib.dataseg);

        response += "\"/>";

        response += "<section address=\"0x";

        response += trk::hexNumber(lib.dataseg);

        response += "\"/>";

        response += "</library>";

    }

    response += "</library-list>";

    return response;

}

QByteArray Session::gdbQsDllInfo(int start, int count) const

{

    // Happens with  gdb 6.4.50.20060226-cvs / CodeSourcery.

    // Never made it into FSF gdb that got qXfer:libraries:read instead.

    // http://sourceware.org/ml/gdb/2007-05/msg00038.html

    // Name=hexname,TextSeg=textaddr[,DataSeg=dataaddr]

    const int libraryCount = libraries.size();

    const int end = count < 0 ? libraryCount : qMin(libraryCount, start + count);

    QByteArray response(1, end == libraryCount ? 'l' : 'm');

    for (int i = start; i < end; ++i) {

        if (i != start)

            response += ';';

        const Library &lib = libraries.at(i);

        response += "Name=";

        response += lib.name.toHex();

        response += ",TextSeg=";

        response += hexNumber(lib.codeseg);

        response += ",DataSeg=";

        response += hexNumber(lib.dataseg);

    }

    return response;

}

QString Session::toString() const

{

    QString rc;

    QTextStream str(&rc);

    str << "Session: " << deviceDescription(false) << '\n'

            << "pid: " << pid <<  "main thread: " << mainTid

            << " current thread: " << tid << ' ';

    str.setIntegerBase(16);

    str << " code: 0x" << codeseg << " data: 0x" << dataseg << '\n';

    if (const int libCount = libraries.size()) {

        str << "Libraries:\n";

        for (int i = 0; i < libCount; i++)

            str << " #" << i << ' ' << libraries.at(i).name

                << " code: 0x" << libraries.at(i).codeseg

                << " data: 0x" << libraries.at(i).dataseg << '\n';

    }

    if (const int moduleCount = modules.size()) {

        str << "Modules:\n";

        for (int i = 0; i < moduleCount; i++)

            str << " #" << i << ' ' << modules.at(i) << '\n';

    }

    str.setIntegerBase(10);

    if (!addressToBP.isEmpty()) {

        typedef QHash<uint, uint>::const_iterator BP_ConstIterator;

        str << "Breakpoints:\n";

        const BP_ConstIterator cend = addressToBP.constEnd();

        for (BP_ConstIterator it = addressToBP.constBegin(); it != cend; ++it) {

            str.setIntegerBase(16);

            str << "  0x" << it.key();

            str.setIntegerBase(10);

            str << ' ' << it.value() << '\n';

        }

    }

    return rc;

}

// --------------

QByteArray decode7d(const QByteArray &ba)

{

    QByteArray res;

    res.reserve(ba.size());

    for (int i = 0; i < ba.size(); ++i) {

        byte c = byte(ba.at(i));

        if (c == 0x7d) {

            ++i;

            c = 0x20 ^ byte(ba.at(i));

        }

        res.append(c);

    }

    return res;

}

QByteArray encode7d(const QByteArray &ba)

{

    QByteArray res;

    res.reserve(ba.size() + 2);

    for (int i = 0; i < ba.size(); ++i) {

        byte c = byte(ba.at(i));

        if (c == 0x7e || c == 0x7d) {

            res.append(0x7d);

            res.append(0x20 ^ c);

        } else {

            res.append(c);

        }

    }

    return res;

}

// FIXME: Use the QByteArray based version below?

static inline QString stringFromByte(byte c)

{

    return QString::fromLatin1("%1").arg(c, 2, 16, QChar('0'));

}

SYMBIANUTILS_EXPORT QString stringFromArray(const QByteArray &ba, int maxLen)

{

    QString str;

    QString ascii;

    const int size = maxLen == -1 ? ba.size() : qMin(ba.size(), maxLen);

    for (int i = 0; i < size; ++i) {

        const int c = byte(ba.at(i));

        str += QString::fromAscii("%1 ").arg(c, 2, 16, QChar('0'));

        ascii += QChar(c).isPrint() ? QChar(c) : QChar('.');

    }

    if (size != ba.size()) {

        str += QLatin1String("...");

        ascii += QLatin1String("...");

    }

    return str + QLatin1String("  ") + ascii;

}

SYMBIANUTILS_EXPORT QByteArray hexNumber(uint n, int digits)

{

    QByteArray ba = QByteArray::number(n, 16);

    if (digits == 0 || ba.size() == digits)

        return ba;

    return QByteArray(digits - ba.size(), '0') + ba;

}

SYMBIANUTILS_EXPORT QByteArray hexxNumber(uint n, int digits)

{

    return "0x" + hexNumber(n, digits);

}

TrkResult::TrkResult() :

    code(0),

    token(0),

    isDebugOutput(false)

{

}

void TrkResult::clear()

{

    code = token= 0;

    isDebugOutput = false;

    data.clear();

    cookie = QVariant();

}

QString TrkResult::toString() const

{

    QString res = stringFromByte(code);

    res += QLatin1String(" [");

    res += stringFromByte(token);

    res += QLatin1Char(']');

    res += QLatin1Char(' ');

    res += stringFromArray(data);

    return res;

}

QByteArray frameMessage(byte command, byte token, const QByteArray &data, bool serialFrame)

{

    byte s = command + token;

    for (int i = 0; i != data.size(); ++i)

        s += data.at(i);

    byte checksum = 255 - (s & 0xff);

    //int x = s + ~s;

    //logMessage("check: " << s << checksum << x;

    QByteArray response;

    response.reserve(data.size() + 3);

    response.append(char(command));

    response.append(char(token));

    response.append(data);

    response.append(char(checksum));

    QByteArray encodedData = encode7d(response);

    QByteArray ba;

    ba.reserve(encodedData.size() + 6);

    if (serialFrame) {

        ba.append(char(0x01));

        ba.append(char(0x90));

        const ushort encodedSize = encodedData.size() + 2; // 2 x 0x7e

        appendShort(&ba, encodedSize, BigEndian);

    }

    ba.append(char(0x7e));

    ba.append(encodedData);

    ba.append(char(0x7e));

    return ba;

}

/* returns 0 if array doesn't represent a result,

otherwise returns the length of the result data */

ushort isValidTrkResult(const QByteArray &buffer, bool serialFrame, ushort& mux)

{

    if (serialFrame) {

        // Serial protocol with length info

        if (buffer.length() < 4)

            return 0;

        mux = extractShort(buffer.data());

        const ushort len = extractShort(buffer.data() + 2);

        return (buffer.size() >= len + 4) ? len : ushort(0);

    }

    // Frameless protocol without length info

    const char delimiter = char(0x7e);

    const int firstDelimiterPos = buffer.indexOf(delimiter);

    // Regular message delimited by 0x7e..0x7e

    if (firstDelimiterPos == 0) {

        mux = MuxTrk;

        const int endPos = buffer.indexOf(delimiter, firstDelimiterPos + 1);

        return endPos != -1 ? endPos + 1 - firstDelimiterPos : 0;

    }

    // Some ASCII log message up to first delimiter or all

    return firstDelimiterPos != -1 ? firstDelimiterPos : buffer.size();

}

bool extractResult(QByteArray *buffer, bool serialFrame, TrkResult *result, bool &linkEstablishmentMode, QByteArray *rawData)

{

    result->clear();

    if(rawData)

        rawData->clear();

    ushort len = isValidTrkResult(*buffer, serialFrame, result->multiplex);

    // handle receiving application output, which is not a regular command

    const int delimiterPos = serialFrame ? 4 : 0;

    if (linkEstablishmentMode) {