Fix examples directory layout

Move examples into a dedicated 'serialport' directory. This is
in line with what the other modules do, and makes sure that
the examples show up  in a sensible place even for the 'combined'
source packages.

Task-number: QTBUG-30912
Change-Id: Iefa2b634df3d2eb34f655b34f6fb24a224b78869
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
Reviewed-by: Laszlo Papp <lpapp@kde.org>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>

6 files changed, 584 insertions, 0 deletions

diff --git a/examples/serialport/slave/dialog.cpp b/examples/serialport/slave/dialog.cpp
new file mode 100644
index 0000000..06a2a15
--- /dev/null
+++ b/examples/serialport/slave/dialog.cpp
@@ -0,0 +1,182 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Denis Shienkov <denis.shienkov@gmail.com>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtSerialPort module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "dialog.h"
+
+#include <QLabel>
+#include <QLineEdit>
+#include <QComboBox>
+#include <QSpinBox>
+#include <QPushButton>
+#include <QGridLayout>
+
+#include <QtSerialPort/QSerialPortInfo>
+
+QT_USE_NAMESPACE
+
+Dialog::Dialog(QWidget *parent)
+    : QDialog(parent)
+    , transactionCount(0)
+    , serialPortLabel(new QLabel(tr("Serial port:")))
+    , serialPortComboBox(new QComboBox())
+    , waitRequestLabel(new QLabel(tr("Wait request, msec:")))
+    , waitRequestSpinBox(new QSpinBox())
+    , responseLabel(new QLabel(tr("Response:")))
+    , responseLineEdit(new QLineEdit(tr("Hello, I'm Slave.")))
+    , trafficLabel(new QLabel(tr("No traffic.")))
+    , statusLabel(new QLabel(tr("Status: Not running.")))
+    , runButton(new QPushButton(tr("Start")))
+{
+    waitRequestSpinBox->setRange(0, 10000);
+    waitRequestSpinBox->setValue(20);
+
+    foreach (const QSerialPortInfo &info, QSerialPortInfo::availablePorts())
+        serialPortComboBox->addItem(info.portName());
+
+    QGridLayout *mainLayout = new QGridLayout;
+    mainLayout->addWidget(serialPortLabel, 0, 0);
+    mainLayout->addWidget(serialPortComboBox, 0, 1);
+    mainLayout->addWidget(waitRequestLabel, 1, 0);
+    mainLayout->addWidget(waitRequestSpinBox, 1, 1);
+    mainLayout->addWidget(runButton, 0, 2, 2, 1);
+    mainLayout->addWidget(responseLabel, 2, 0);
+    mainLayout->addWidget(responseLineEdit, 2, 1, 1, 3);
+    mainLayout->addWidget(trafficLabel, 3, 0, 1, 4);
+    mainLayout->addWidget(statusLabel, 4, 0, 1, 5);
+    setLayout(mainLayout);
+
+    setWindowTitle(tr("Slave"));
+    serialPortComboBox->setFocus();
+
+    timer.setSingleShot(true);
+
+    connect(runButton, SIGNAL(clicked()),
+            this, SLOT(startSlave()));
+    connect(&serial, SIGNAL(readyRead()),
+            this, SLOT(readRequest()));
+    connect(&timer, SIGNAL(timeout()),
+            this, SLOT(processTimeout()));
+
+    connect(serialPortComboBox, SIGNAL(currentIndexChanged(QString)),
+            this, SLOT(activateRunButton()));
+    connect(waitRequestSpinBox, SIGNAL(valueChanged(int)),
+            this, SLOT(activateRunButton()));
+    connect(responseLineEdit, SIGNAL(textChanged(QString)),
+            this, SLOT(activateRunButton()));
+}
+
+void Dialog::startSlave()
+{
+    if (serial.portName() != serialPortComboBox->currentText()) {
+        serial.close();
+        serial.setPortName(serialPortComboBox->currentText());
+
+        if (!serial.open(QIODevice::ReadWrite)) {
+            processError(tr("Can't open %1, error code %2")
+                         .arg(serial.portName()).arg(serial.error()));
+            return;
+        }
+
+        if (!serial.setBaudRate(QSerialPort::Baud9600)) {
+            processError(tr("Can't set baud rate 9600 baud to port %1, error code %2")
+                         .arg(serial.portName()).arg(serial.error()));
+            return;
+        }
+
+        if (!serial.setDataBits(QSerialPort::Data8)) {
+            processError(tr("Can't set 8 data bits to port %1, error code %2")
+                         .arg(serial.portName()).arg(serial.error()));
+            return;
+        }
+
+        if (!serial.setParity(QSerialPort::NoParity)) {
+            processError(tr("Can't set no patity to port %1, error code %2")
+                         .arg(serial.portName()).arg(serial.error()));
+            return;
+        }
+
+        if (!serial.setStopBits(QSerialPort::OneStop)) {
+            processError(tr("Can't set 1 stop bit to port %1, error code %2")
+                         .arg(serial.portName()).arg(serial.error()));
+            return;
+        }
+
+        if (!serial.setFlowControl(QSerialPort::NoFlowControl)) {
+            processError(tr("Can't set no flow control to port %1, error code %2")
+                         .arg(serial.portName()).arg(serial.error()));
+            return;
+        }
+    }
+
+    runButton->setEnabled(false);
+    statusLabel->setText(tr("Status: Running, connected to port %1.")
+                         .arg(serialPortComboBox->currentText()));
+}
+
+void Dialog::readRequest()
+{
+    if (!timer.isActive())
+        timer.start(waitRequestSpinBox->value());
+    request.append(serial.readAll());
+}
+
+void Dialog::processTimeout()
+{
+    serial.write(responseLineEdit->text().toLocal8Bit());
+
+    trafficLabel->setText(tr("Traffic, transaction #%1:"
+                             "\n\r-request: %2"
+                             "\n\r-response: %3")
+                          .arg(++transactionCount).arg(QString(request)).arg(responseLineEdit->text()));
+    request.clear();
+}
+
+void Dialog::activateRunButton()
+{
+    runButton->setEnabled(true);
+}
+
+void Dialog::processError(const QString &s)
+{
+    activateRunButton();
+    statusLabel->setText(tr("Status: Not running, %1.").arg(s));
+    trafficLabel->setText(tr("No traffic."));
+}
diff --git a/examples/serialport/slave/dialog.h b/examples/serialport/slave/dialog.h
new file mode 100644
index 0000000..6aafb2b
--- /dev/null
+++ b/examples/serialport/slave/dialog.h
@@ -0,0 +1,95 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Denis Shienkov <denis.shienkov@gmail.com>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtSerialPort module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef DIALOG_H
+#define DIALOG_H
+
+#include <QDialog>
+#include <QTimer>
+
+#include <QtSerialPort/QSerialPort>
+
+QT_USE_NAMESPACE
+
+QT_BEGIN_NAMESPACE
+
+class QLabel;
+class QLineEdit;
+class QComboBox;
+class QSpinBox;
+class QPushButton;
+
+QT_END_NAMESPACE
+
+class Dialog : public QDialog
+{
+    Q_OBJECT
+
+public:
+    Dialog(QWidget *parent = 0);
+
+private slots:
+    void startSlave();
+    void readRequest();
+    void processTimeout();
+    void activateRunButton();
+
+private:
+    void processError(const QString &s);
+
+private:
+    int transactionCount;
+    QLabel *serialPortLabel;
+    QComboBox *serialPortComboBox;
+    QLabel *waitRequestLabel;
+    QSpinBox *waitRequestSpinBox;
+    QLabel *responseLabel;
+    QLineEdit *responseLineEdit;
+    QLabel *trafficLabel;
+    QLabel *statusLabel;
+    QPushButton *runButton;
+
+    QSerialPort serial;
+    QByteArray request;
+    QTimer timer;
+};
+
+#endif // DIALOG_H
diff --git a/examples/serialport/slave/main.cpp b/examples/serialport/slave/main.cpp
new file mode 100644
index 0000000..fc2e334
--- /dev/null
+++ b/examples/serialport/slave/main.cpp
@@ -0,0 +1,52 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Denis Shienkov <denis.shienkov@gmail.com>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtSerialPort module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QApplication>
+
+#include "dialog.h"
+
+int main(int argc, char *argv[])
+{
+    QApplication app(argc, argv);
+    Dialog dialog;
+    dialog.show();
+    return app.exec();
+}
diff --git a/examples/serialport/slave/slave.pro b/examples/serialport/slave/slave.pro
new file mode 100644
index 0000000..df996ac
--- /dev/null
+++ b/examples/serialport/slave/slave.pro
@@ -0,0 +1,15 @@
+greaterThan(QT_MAJOR_VERSION, 4) {
+    QT       += widgets serialport
+} else {
+    include($$QTSERIALPORT_PROJECT_ROOT/src/serialport/qt4support/serialport.prf)
+}
+
+TARGET = slave
+TEMPLATE = app
+
+HEADERS += \
+    dialog.h
+
+SOURCES += \
+    main.cpp \
+    dialog.cpp
diff --git a/examples/serialport/slave/slavethread.cpp b/examples/serialport/slave/slavethread.cpp
new file mode 100644
index 0000000..a0177ff
--- /dev/null
+++ b/examples/serialport/slave/slavethread.cpp
@@ -0,0 +1,167 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Denis Shienkov <denis.shienkov@gmail.com>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtSerialPort module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "slavethread.h"
+
+#include <QtSerialPort/QSerialPort>
+
+#include <QTime>
+
+QT_USE_NAMESPACE
+
+SlaveThread::SlaveThread(QObject *parent)
+    : QThread(parent), waitTimeout(0), quit(false)
+{
+}
+
+SlaveThread::~SlaveThread()
+{
+    mutex.lock();
+    quit = true;
+    mutex.unlock();
+    wait();
+}
+
+void SlaveThread::startSlave(const QString &portName, int waitTimeout, const QString &response)
+{
+    QMutexLocker locker(&mutex);
+    this->portName = portName;
+    this->waitTimeout = waitTimeout;
+    this->response = response;
+
+    if (!isRunning())
+        start();
+}
+
+void SlaveThread::run()
+{
+    bool currentPortNameChanged = false;
+
+    mutex.lock();
+    QString currentPortName;
+    if (currentPortName != portName) {
+        currentPortName = portName;
+        currentPortNameChanged = true;
+    }
+
+    int currentWaitTimeout = waitTimeout;
+    QString currentRespone = response;
+    mutex.unlock();
+
+    QSerialPort serial;
+
+    while (!quit) {
+
+        if (currentPortNameChanged) {
+            serial.close();
+            serial.setPortName(currentPortName);
+
+            if (!serial.open(QIODevice::ReadWrite)) {
+                emit error(tr("Can't open %1, error code %2")
+                           .arg(portName).arg(serial.error()));
+                return;
+            }
+
+            if (!serial.setBaudRate(QSerialPort::Baud9600)) {
+                emit error(tr("Can't set baud rate 9600 baud to port %1, error code %2")
+                           .arg(portName).arg(serial.error()));
+                return;
+            }
+
+            if (!serial.setDataBits(QSerialPort::Data8)) {
+                emit error(tr("Can't set 8 data bits to port %1, error code %2")
+                           .arg(portName).arg(serial.error()));
+                return;
+            }
+
+            if (!serial.setParity(QSerialPort::NoParity)) {
+                emit error(tr("Can't set no patity to port %1, error code %2")
+                           .arg(portName).arg(serial.error()));
+                return;
+            }
+
+            if (!serial.setStopBits(QSerialPort::OneStop)) {
+                emit error(tr("Can't set 1 stop bit to port %1, error code %2")
+                           .arg(portName).arg(serial.error()));
+                return;
+            }
+
+            if (!serial.setFlowControl(QSerialPort::NoFlowControl)) {
+                emit error(tr("Can't set no flow control to port %1, error code %2")
+                           .arg(portName).arg(serial.error()));
+                return;
+            }
+        }
+
+        if (serial.waitForReadyRead(currentWaitTimeout)) {
+
+            // read all request
+            QByteArray requestData = serial.readAll();
+            while (serial.waitForReadyRead(10))
+                requestData += serial.readAll();
+
+            // write all response
+            QByteArray responseData = currentRespone.toLocal8Bit();
+            serial.write(responseData);
+            if (serial.waitForBytesWritten(waitTimeout)) {
+                QString request(requestData);
+                emit this->request(request);
+            } else {
+                emit timeout(tr("Wait write response timeout %1")
+                             .arg(QTime::currentTime().toString()));
+            }
+        } else {
+            emit timeout(tr("Wait read request timeout %1")
+                         .arg(QTime::currentTime().toString()));
+        }
+
+        mutex.lock();
+        if (currentPortName != portName) {
+            currentPortName = portName;
+            currentPortNameChanged = true;
+        } else {
+            currentPortNameChanged = false;
+        }
+        currentWaitTimeout = waitTimeout;
+        currentRespone = response;
+        mutex.unlock();
+    }
+}
diff --git a/examples/serialport/slave/slavethread.h b/examples/serialport/slave/slavethread.h
new file mode 100644
index 0000000..3ed1e0c
--- /dev/null
+++ b/examples/serialport/slave/slavethread.h
@@ -0,0 +1,73 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Denis Shienkov <denis.shienkov@gmail.com>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtSerialPort module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** 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, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef SLAVETHREAD_H
+#define SLAVETHREAD_H
+
+#include <QThread>
+#include <QMutex>
+#include <QWaitCondition>
+
+class SlaveThread : public QThread
+{
+    Q_OBJECT
+
+public:
+    SlaveThread(QObject *parent = 0);
+    ~SlaveThread();
+
+    void startSlave(const QString &portName, int waitTimeout, const QString &response);
+    void run();
+
+signals:
+    void request(const QString &s);
+    void error(const QString &s);
+    void timeout(const QString &s);
+
+private:
+    QString portName;
+    QString response;
+    int waitTimeout;
+    QMutex mutex;
+    bool quit;
+};
+
+#endif // SLAVETHREAD_H