qt-creator/tests/manual/trk/trkdevice.cpp

/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/

#include "trkdevice.h"
#include "trkutils.h"

#include <QtCore/QString>
#include <QtCore/QDebug>
#include <QtCore/QQueue>
#include <QtCore/QHash>
#include <QtCore/QMap>

#ifdef Q_OS_WIN
#  include <windows.h>
#else
#  include <QtCore/QFile>

#  include <stdio.h>
#  include <sys/ioctl.h>
#  include <termios.h>
#  include <errno.h>
#  include <string.h>
#endif

enum { TimerInterval = 100 };

#ifdef Q_OS_WIN

// Format windows error from GetLastError() value: TODO: Use the one provided by the utisl lib.
QString winErrorMessage(unsigned long error)
{
    QString rc = QString::fromLatin1("#%1: ").arg(error);
    ushort *lpMsgBuf;

    const int len = FormatMessage(
            FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
            NULL, error, 0, (LPTSTR)&lpMsgBuf, 0, NULL);
    if (len) {
        rc = QString::fromUtf16(lpMsgBuf, len);
        LocalFree(lpMsgBuf);
    } else {
        rc += QString::fromLatin1("<unknown error>");
    }
    return rc;
}

// Non-blocking replacement for win-api ReadFile function
BOOL WINAPI TryReadFile(HANDLE          hFile,
                        LPVOID          lpBuffer,
                        DWORD           nNumberOfBytesToRead,
                        LPDWORD         lpNumberOfBytesRead,
                        LPOVERLAPPED    lpOverlapped)
{
    COMSTAT comStat;
    if (!ClearCommError(hFile, NULL, &comStat)){
        qDebug() << "ClearCommError() failed";
        return FALSE;
    }
    if (comStat.cbInQue == 0) {
        *lpNumberOfBytesRead = 0;
        return FALSE;
    }
    return ReadFile(hFile,
                    lpBuffer,
                    qMin(comStat.cbInQue, nNumberOfBytesToRead),
                    lpNumberOfBytesRead,
                    lpOverlapped);
}
#endif

namespace trk {

struct TrkDevicePrivate {
    TrkDevicePrivate();
#ifdef Q_OS_WIN
    HANDLE hdevice;
#else
    QFile file;
#endif

    QByteArray trkReadBuffer;
    bool trkWriteBusy;
    int timerId;
    bool serialFrame;
    bool verbose;
    QString errorString;
};

TrkDevicePrivate::TrkDevicePrivate() :
#ifdef Q_OS_WIN
    hdevice(INVALID_HANDLE_VALUE),
#endif
    trkWriteBusy(false),
    timerId(-1),
    serialFrame(true),
    verbose(false)
{

}

TrkDevice::TrkDevice(QObject *parent) :
    QObject(parent),
    d(new TrkDevicePrivate)
{
}

bool TrkDevice::open(const QString &port, QString *errorMessage)
{
    close();
#ifdef Q_OS_WIN
    d->hdevice = CreateFile(port.toStdWString().c_str(),
                           GENERIC_READ | GENERIC_WRITE,
                           0,
                           NULL,
                           OPEN_EXISTING,
                           FILE_ATTRIBUTE_NORMAL,
                           NULL);

    if (INVALID_HANDLE_VALUE == d->hdevice) {
        *errorMessage = QString::fromLatin1("Could not open device '%1': %2").arg(port, winErrorMessage(GetLastError()));
        return false;
    }
    d->timerId = startTimer(TimerInterval);
    return true;
#else
    d->file.setFileName(port);
    if (!d->file.open(QIODevice::ReadWrite|QIODevice::Unbuffered)) {
        *errorMessage = QString::fromLatin1("Cannot open %1: %2").arg(port, d->file.errorString());
        return false;
    }

    struct termios termInfo;
    if (tcgetattr(d->file.handle(), &termInfo) < 0) {
        *errorMessage = QString::fromLatin1("Unable to retrieve terminal settings: %1 %2").arg(errno).arg(QString::fromAscii(strerror(errno)));
        return false;
    }
    // Turn off terminal echo as not get messages back, among other things
    termInfo.c_cflag|=CREAD|CLOCAL;
    termInfo.c_lflag&=(~(ICANON|ECHO|ECHOE|ECHOK|ECHONL|ISIG));
    termInfo.c_iflag&=(~(INPCK|IGNPAR|PARMRK|ISTRIP|ICRNL|IXANY));
    termInfo.c_oflag&=(~OPOST);
    termInfo.c_cc[VMIN]=0;
    termInfo.c_cc[VINTR] = _POSIX_VDISABLE;
    termInfo.c_cc[VQUIT] = _POSIX_VDISABLE;
    termInfo.c_cc[VSTART] = _POSIX_VDISABLE;
    termInfo.c_cc[VSTOP] = _POSIX_VDISABLE;
    termInfo.c_cc[VSUSP] = _POSIX_VDISABLE;
    if (tcsetattr(d->file.handle(), TCSAFLUSH, &termInfo) < 0) {
        *errorMessage = QString::fromLatin1("Unable to apply terminal settings: %1 %2").arg(errno).arg(QString::fromAscii(strerror(errno)));
        return false;
    }
    d->timerId = startTimer(TimerInterval);
    return true;
#endif
}


TrkDevice::~TrkDevice()
{
    close();
    delete d;
}

void TrkDevice::close()
{
    if (!isOpen())
        return;
    if (d->timerId != -1) {
        killTimer(d->timerId);
        d->timerId = -1;
    }
#ifdef Q_OS_WIN
    CloseHandle(d->hdevice);
    d->hdevice = INVALID_HANDLE_VALUE;
#else
    d->file.close();
#endif
    if (d->verbose)
        qDebug() << "Close";
}

bool TrkDevice::isOpen() const
{
#ifdef Q_OS_WIN
    return d->hdevice != INVALID_HANDLE_VALUE;
#else
    return d->file.isOpen();
#endif
}

QString TrkDevice::errorString() const
{
    return d->errorString;
}

bool TrkDevice::serialFrame() const
{
    return d->serialFrame;
}

void TrkDevice::setSerialFrame(bool f)
{
    d->serialFrame = f;
}

bool TrkDevice::verbose() const
{
    return d->verbose;
}

void TrkDevice::setVerbose(bool b)
{
    d->verbose = b;
}

bool TrkDevice::write(const QByteArray &data, QString *errorMessage)
{
    if (d->verbose)
        qDebug() << ">WRITE" << data.toHex();
#ifdef Q_OS_WIN
    DWORD charsWritten;
    if (!WriteFile(d->hdevice, data.data(), data.size(), &charsWritten, NULL)) {
        *errorMessage = QString::fromLatin1("Error writing data: %1").arg(winErrorMessage(GetLastError()));
        return false;
    }
    FlushFileBuffers(d->hdevice);
    return true;
#else
    if (d->file.write(data) == -1 || !d->file.flush()) {
        *errorMessage = QString::fromLatin1("Cannot write: %1").arg(d->file.errorString());
        return false;
    }
    return  true;
#endif
}

#ifndef Q_OS_WIN
static inline int bytesAvailable(int fileNo)
{
    int numBytes;
    const int rc = ioctl(fileNo, FIONREAD, &numBytes);
    if (rc < 0)
        numBytes=0;
    return numBytes;
}
#endif

void TrkDevice::tryTrkRead()
{
#ifdef Q_OS_WIN
    const DWORD BUFFERSIZE = 1024;
    char buffer[BUFFERSIZE];
    DWORD charsRead;
    DWORD totalCharsRead = 0;

    while (TryReadFile(d->hdevice, buffer, BUFFERSIZE, &charsRead, NULL)) {
        totalCharsRead += charsRead;
        d->trkReadBuffer.append(buffer, charsRead);
        if (isValidTrkResult(d->trkReadBuffer, d->serialFrame))
            break;
    }
    if (d->verbose && totalCharsRead)
        qDebug() << "Read" << d->trkReadBuffer.toHex();
    if (!totalCharsRead)
        return;
    const ushort len = isValidTrkResult(d->trkReadBuffer, d->serialFrame);
    if (!len) {
        const QString msg = QString::fromLatin1("Partial message: %1").arg(stringFromArray(d->trkReadBuffer));
        emitError(msg);
        return;
    }
#else
    const int size = bytesAvailable(d->file.handle());
    if (!size)
        return;
    const QByteArray data = d->file.read(size);
    d->trkReadBuffer.append(data);
    const ushort len = isValidTrkResult(d->trkReadBuffer, d->serialFrame);
    if (!len) {
        if (d->trkReadBuffer.size() > 10) {
            const QString msg = QString::fromLatin1("Unable to extract message from '%1' '%2'").
                             arg(QLatin1String(d->trkReadBuffer.toHex())).arg(QString::fromAscii(d->trkReadBuffer));
            emitError(msg);
        }
        return;
    }
#endif // Q_OS_WIN
    TrkResult r;
    while (extractResult(&d->trkReadBuffer, d->serialFrame, &r)) {
        if (d->verbose)
            qDebug() << "Read TrkResult " << r.data.toHex();
        emit messageReceived(r);
    }
}

void TrkDevice::timerEvent(QTimerEvent *)
{
    tryTrkRead();
}

void TrkDevice::emitError(const QString &s)
{
    d->errorString = s;
    qWarning("%s\n", qPrintable(s));
    emit error(s);
}

/* A message to be send to TRK, triggering a callback on receipt
 * of the answer. */
struct TrkMessage {
    typedef TrkFunctor1<const TrkResult &> Callback;

    explicit TrkMessage(unsigned char code = 0u,
                        unsigned char token = 0u,
                        Callback callback = Callback());

    unsigned char code;
    unsigned char token;
    QByteArray data;
    QVariant cookie;
    Callback callback;
    bool invokeOnNAK;
};

TrkMessage::TrkMessage(unsigned char c,
                        unsigned char t,
                        Callback cb) :
    code(c),
    token(t),
    callback(cb),
    invokeOnNAK(false)
{
}

// ------- TrkWriteQueueDevice

struct TrkWriteQueueDevicePrivate {
    typedef QMap<unsigned char, TrkMessage> TokenMessageMap;
    TrkWriteQueueDevicePrivate();

    unsigned char trkWriteToken;
    QQueue<TrkMessage> trkWriteQueue;
    TokenMessageMap writtenTrkMessages;
    bool trkWriteBusy;
};

TrkWriteQueueDevicePrivate::TrkWriteQueueDevicePrivate() :
    trkWriteToken(0),
    trkWriteBusy(false)
{
}

TrkWriteQueueDevice::TrkWriteQueueDevice(QObject *parent) :
    TrkDevice(parent),
    qd(new TrkWriteQueueDevicePrivate)
{
    connect(this, SIGNAL(messageReceived(TrkResult)), this, SLOT(slotHandleResult(TrkResult)));
}

TrkWriteQueueDevice::~TrkWriteQueueDevice()
{
    delete qd;
}

unsigned char TrkWriteQueueDevice::nextTrkWriteToken()
{
    ++qd->trkWriteToken;
    if (qd->trkWriteToken == 0)
        ++qd->trkWriteToken;
    return qd->trkWriteToken;
}

void TrkWriteQueueDevice::sendTrkMessage(unsigned char code, Callback callback,
                                         const QByteArray &data, const QVariant &cookie,
                                         bool invokeOnNAK)
{
    TrkMessage msg(code, nextTrkWriteToken(), callback);
    msg.data = data;
    msg.cookie = cookie;
    msg.invokeOnNAK = invokeOnNAK;
    queueTrkMessage(msg);
}

void TrkWriteQueueDevice::sendTrkInitialPing()
{
    const TrkMessage msg(0, 0); // Ping, reset sequence count
    queueTrkMessage(msg);
}

bool TrkWriteQueueDevice::sendTrkAck(unsigned char token)
{
    TrkMessage msg(0x80, token);
    msg.token = token;
    msg.data.append('\0');
    // The acknowledgement must not be queued!
    return trkWriteRawMessage(msg);
    // 01 90 00 07 7e 80 01 00 7d 5e 7e
}

void TrkWriteQueueDevice::queueTrkMessage(const TrkMessage &msg)
{
    qd->trkWriteQueue.append(msg);
}

void TrkWriteQueueDevice::tryTrkWrite()
{
    // Invoked from timer, try to flush out message queue
    if (qd->trkWriteBusy)
        return;
    if (qd->trkWriteQueue.isEmpty())
        return;

    const TrkMessage msg = qd->trkWriteQueue.dequeue();
    trkWrite(msg);
}

bool TrkWriteQueueDevice::trkWriteRawMessage(const TrkMessage &msg)
{
    const QByteArray ba = frameMessage(msg.code, msg.token, msg.data, serialFrame());
    if (verbose())
         qDebug() << ("WRITE: " + stringFromArray(ba));
    QString errorMessage;
    const bool rc = write(ba, &errorMessage);
    if (!rc)
        emitError(errorMessage);
    return rc;
}

bool TrkWriteQueueDevice::trkWrite(const TrkMessage &msg)
{
    qd->writtenTrkMessages.insert(msg.token, msg);
    qd->trkWriteBusy = true;
    return trkWriteRawMessage(msg);
}

void TrkWriteQueueDevice::timerEvent(QTimerEvent *ev)
{
    tryTrkWrite();
    TrkDevice::timerEvent(ev);
}

void TrkWriteQueueDevice::slotHandleResult(const TrkResult &result)
{
    qd->trkWriteBusy = false;
    if (result.code != TrkNotifyAck && result.code != TrkNotifyNak)
        return;
    // Find which request the message belongs to and invoke callback
    // if ACK or on NAK if desired.
    const TrkWriteQueueDevicePrivate::TokenMessageMap::iterator it = qd->writtenTrkMessages.find(result.token);
    if (it == qd->writtenTrkMessages.end())
        return;
    const bool invokeCB = it.value().callback
                          && (result.code == TrkNotifyAck || it.value().invokeOnNAK);

    if (invokeCB) {
        TrkResult result1 = result;
        result1.cookie = it.value().cookie;
        it.value().callback(result1);
    }
    qd->writtenTrkMessages.erase(it);
}

} // namespace tr