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

**

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

**

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

#ifndef TRKDEVICE_H

#define TRKDEVICE_H

#include "symbianutils_global.h"

#include "callback.h"

#include <QtCore/QObject>

#include <QtCore/QVariant>

#include <QtCore/QByteArray>

#include <QtCore/QSharedPointer>

QT_BEGIN_NAMESPACE

class QIODevice;

QT_END_NAMESPACE

namespace trk {

struct TrkResult;

struct TrkMessage;

struct TrkDevicePrivate;

/* TrkDevice: Implements a Windows COM or Linux device for

 * Trk communications. Provides synchronous write and asynchronous

 * read operation.

 * The serialFrames property specifies whether packets are encapsulated in

 * "0x90 <length>" frames, which is currently the case for serial ports.

 * Contains a write message queue allowing

 * for queueing messages with a notification callback. If the message receives

 * an ACK, the callback is invoked.

 * The special message TRK_WRITE_QUEUE_NOOP_CODE code can be used for synchronization.

 * The respective  message will not be sent, the callback is just invoked.

 * Note that calling open/close in quick succession can cause crashes

 * due to the use of queused signals. */

enum { TRK_WRITE_QUEUE_NOOP_CODE = 0x7f };

typedef trk::Callback<const TrkResult &> TrkCallback;

class SYMBIANUTILS_EXPORT TrkDevice : public QObject

{

    Q_OBJECT

    Q_PROPERTY(bool serialFrame READ serialFrame WRITE setSerialFrame)

    Q_PROPERTY(bool verbose READ verbose WRITE setVerbose)

    Q_PROPERTY(QString port READ port WRITE setPort)

public:

    explicit TrkDevice(QObject *parent = 0);

    virtual ~TrkDevice();

    bool open(QString *errorMessage);

    bool isOpen() const;

    QString port() const;

    void setPort(const QString &p);

    QString errorString() const;

    bool serialFrame() const;

    void setSerialFrame(bool f);

    int verbose() const;

    void setVerbose(int b);

    // Enqueue a message with a notification callback.

    void sendTrkMessage(unsigned char code,

                        TrkCallback callBack = TrkCallback(),

                        const QByteArray &data = QByteArray(),

                        const QVariant &cookie = QVariant());

    // Enqeue an initial ping

    void sendTrkInitialPing();

    // Send an Ack synchronously, bypassing the queue

    bool sendTrkAck(unsigned char token);

public slots:

    void clearWriteQueue();

signals:

    void messageReceived(const trk::TrkResult &result);

    // Emitted with the contents of messages enclosed in 07e, not for log output

    void rawDataReceived(const QByteArray &data);

    void error(const QString &msg);

    void logMessage(const QString &msg);

private slots:

    void slotMessageReceived(const trk::TrkResult &result, const QByteArray &a);

protected slots:

    void emitError(const QString &msg);

    void emitLogMessage(const QString &msg);

public slots:

    void close();

private:

    void readMessages();

    TrkDevicePrivate *d;

};

} // namespace trk

#endif // TRKDEVICE_H