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, 555 insertions, 0 deletions

diff --git a/examples/serialport/blockingmaster/blockingmaster.pro b/examples/serialport/blockingmaster/blockingmaster.pro
new file mode 100644
index 00000000..5f21cdbf
--- /dev/null
+++ b/examples/serialport/blockingmaster/blockingmaster.pro
@@ -0,0 +1,17 @@
+greaterThan(QT_MAJOR_VERSION, 4) {
+    QT       += widgets serialport
+} else {
+    include($$QTSERIALPORT_PROJECT_ROOT/src/serialport/qt4support/serialport.prf)
+}
+
+TARGET = blockingmaster
+TEMPLATE = app
+
+HEADERS += \
+    dialog.h \
+    masterthread.h
+
+SOURCES += \
+    main.cpp \
+    dialog.cpp \
+    masterthread.cpp
diff --git a/examples/serialport/blockingmaster/dialog.cpp b/examples/serialport/blockingmaster/dialog.cpp
new file mode 100644
index 00000000..7cd04e02
--- /dev/null
+++ b/examples/serialport/blockingmaster/dialog.cpp
@@ -0,0 +1,138 @@
+/****************************************************************************
+**
+** 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())
+    , waitResponseLabel(new QLabel(tr("Wait response, msec:")))
+    , waitResponseSpinBox(new QSpinBox())
+    , requestLabel(new QLabel(tr("Request:")))
+    , requestLineEdit(new QLineEdit(tr("Who are you?")))
+    , trafficLabel(new QLabel(tr("No traffic.")))
+    , statusLabel(new QLabel(tr("Status: Not running.")))
+    , runButton(new QPushButton(tr("Start")))
+{
+    foreach (const QSerialPortInfo &info, QSerialPortInfo::availablePorts())
+        serialPortComboBox->addItem(info.portName());
+
+    waitResponseSpinBox->setRange(0, 10000);
+    waitResponseSpinBox->setValue(1000);
+
+    QGridLayout *mainLayout = new QGridLayout;
+    mainLayout->addWidget(serialPortLabel, 0, 0);
+    mainLayout->addWidget(serialPortComboBox, 0, 1);
+    mainLayout->addWidget(waitResponseLabel, 1, 0);
+    mainLayout->addWidget(waitResponseSpinBox, 1, 1);
+    mainLayout->addWidget(runButton, 0, 2, 2, 1);
+    mainLayout->addWidget(requestLabel, 2, 0);
+    mainLayout->addWidget(requestLineEdit, 2, 1, 1, 3);
+    mainLayout->addWidget(trafficLabel, 3, 0, 1, 4);
+    mainLayout->addWidget(statusLabel, 4, 0, 1, 5);
+    setLayout(mainLayout);
+
+    setWindowTitle(tr("Blocking Master"));
+    serialPortComboBox->setFocus();
+
+    connect(runButton, SIGNAL(clicked()),
+            this, SLOT(transaction()));
+    connect(&thread, SIGNAL(response(QString)),
+            this, SLOT(showResponse(QString)));
+    connect(&thread, SIGNAL(error(QString)),
+            this, SLOT(processError(QString)));
+    connect(&thread, SIGNAL(timeout(QString)),
+            this, SLOT(processTimeout(QString)));
+}
+
+void Dialog::transaction()
+{
+    setControlsEnabled(false);
+    statusLabel->setText(tr("Status: Running, connected to port %1.")
+                         .arg(serialPortComboBox->currentText()));
+    thread.transaction(serialPortComboBox->currentText(),
+                       waitResponseSpinBox->value(),
+                       requestLineEdit->text());
+}
+
+void Dialog::showResponse(const QString &s)
+{
+    setControlsEnabled(true);
+    trafficLabel->setText(tr("Traffic, transaction #%1:"
+                             "\n\r-request: %2"
+                             "\n\r-response: %3")
+                          .arg(++transactionCount).arg(requestLineEdit->text()).arg(s));
+}
+
+void Dialog::processError(const QString &s)
+{
+    setControlsEnabled(true);
+    statusLabel->setText(tr("Status: Not running, %1.").arg(s));
+    trafficLabel->setText(tr("No traffic."));
+}
+
+void Dialog::processTimeout(const QString &s)
+{
+    setControlsEnabled(true);
+    statusLabel->setText(tr("Status: Running, %1.").arg(s));
+    trafficLabel->setText(tr("No traffic."));
+}
+
+void Dialog::setControlsEnabled(bool enable)
+{
+    runButton->setEnabled(enable);
+    serialPortComboBox->setEnabled(enable);
+    waitResponseSpinBox->setEnabled(enable);
+    requestLineEdit->setEnabled(enable);
+}
diff --git a/examples/serialport/blockingmaster/dialog.h b/examples/serialport/blockingmaster/dialog.h
new file mode 100644
index 00000000..14d1e56f
--- /dev/null
+++ b/examples/serialport/blockingmaster/dialog.h
@@ -0,0 +1,90 @@
+/****************************************************************************
+**
+** 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 "masterthread.h"
+
+QT_BEGIN_NAMESPACE
+
+class QLabel;
+class QLineEdit;
+class QSpinBox;
+class QPushButton;
+class QComboBox;
+
+QT_END_NAMESPACE
+
+class Dialog : public QDialog
+{
+    Q_OBJECT
+
+public:
+    Dialog(QWidget *parent = 0);
+
+private slots:
+    void transaction();
+    void showResponse(const QString &s);
+    void processError(const QString &s);
+    void processTimeout(const QString &s);
+
+private:
+    void setControlsEnabled(bool enable);
+
+private:
+    int transactionCount;
+    QLabel *serialPortLabel;
+    QComboBox *serialPortComboBox;
+    QLabel *waitResponseLabel;
+    QSpinBox *waitResponseSpinBox;
+    QLabel *requestLabel;
+    QLineEdit *requestLineEdit;
+    QLabel *trafficLabel;
+    QLabel *statusLabel;
+    QPushButton *runButton;
+
+    MasterThread thread;
+};
+
+#endif // DIALOG_H
diff --git a/examples/serialport/blockingmaster/main.cpp b/examples/serialport/blockingmaster/main.cpp
new file mode 100644
index 00000000..fc2e334e
--- /dev/null
+++ b/examples/serialport/blockingmaster/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/blockingmaster/masterthread.cpp b/examples/serialport/blockingmaster/masterthread.cpp
new file mode 100644
index 00000000..061ddd6e
--- /dev/null
+++ b/examples/serialport/blockingmaster/masterthread.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 "masterthread.h"
+
+#include <QtSerialPort/QSerialPort>
+
+#include <QTime>
+
+QT_USE_NAMESPACE
+
+MasterThread::MasterThread(QObject *parent)
+    : QThread(parent), waitTimeout(0), quit(false)
+{
+}
+
+//! [0]
+MasterThread::~MasterThread()
+{
+    mutex.lock();
+    quit = true;
+    cond.wakeOne();
+    mutex.unlock();
+    wait();
+}
+//! [0]
+
+//! [1] //! [2]
+void MasterThread::transaction(const QString &portName, int waitTimeout, const QString &request)
+{
+    //! [1]
+    QMutexLocker locker(&mutex);
+    this->portName = portName;
+    this->waitTimeout = waitTimeout;
+    this->request = request;
+    //! [3]
+    if (!isRunning())
+        start();
+    else
+        cond.wakeOne();
+}
+//! [2] //! [3]
+
+//! [4]
+void MasterThread::run()
+{
+    bool currentPortNameChanged = false;
+
+    mutex.lock();
+    //! [4] //! [5]
+    QString currentPortName;
+    if (currentPortName != portName) {
+        currentPortName = portName;
+        currentPortNameChanged = true;
+    }
+
+    int currentWaitTimeout = waitTimeout;
+    QString currentRequest = request;
+    mutex.unlock();
+    //! [5] //! [6]
+    QSerialPort serial;
+
+    while (!quit) {
+        //![6] //! [7]
+        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;
+            }
+        }
+        //! [7] //! [8]
+        // write request
+        QByteArray requestData = currentRequest.toLocal8Bit();
+        serial.write(requestData);
+        if (serial.waitForBytesWritten(waitTimeout)) {
+            //! [8] //! [10]
+            // read response
+            if (serial.waitForReadyRead(currentWaitTimeout)) {
+                QByteArray responseData = serial.readAll();
+                while (serial.waitForReadyRead(10))
+                    responseData += serial.readAll();
+
+                QString response(responseData);
+                //! [12]
+                emit this->response(response);
+                //! [10] //! [11] //! [12]
+            } else {
+                emit timeout(tr("Wait read response timeout %1")
+                             .arg(QTime::currentTime().toString()));
+            }
+            //! [9] //! [11]
+        } else {
+            emit timeout(tr("Wait write request timeout %1")
+                         .arg(QTime::currentTime().toString()));
+        }
+        //! [9]  //! [13]
+        mutex.lock();
+        cond.wait(&mutex);
+        if (currentPortName != portName) {
+            currentPortName = portName;
+            currentPortNameChanged = true;
+        } else {
+            currentPortNameChanged = false;
+        }
+        currentWaitTimeout = waitTimeout;
+        currentRequest = request;
+        mutex.unlock();
+    }
+    //! [13]
+}
diff --git a/examples/serialport/blockingmaster/masterthread.h b/examples/serialport/blockingmaster/masterthread.h
new file mode 100644
index 00000000..ebbd43de
--- /dev/null
+++ b/examples/serialport/blockingmaster/masterthread.h
@@ -0,0 +1,76 @@
+/****************************************************************************
+**
+** 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 MASTERTHREAD_H
+#define MASTERTHREAD_H
+
+#include <QThread>
+#include <QMutex>
+#include <QWaitCondition>
+
+//! [0]
+class MasterThread : public QThread
+{
+    Q_OBJECT
+
+public:
+    MasterThread(QObject *parent = 0);
+    ~MasterThread();
+
+    void transaction(const QString &portName, int waitTimeout, const QString &request);
+    void run();
+
+signals:
+    void response(const QString &s);
+    void error(const QString &s);
+    void timeout(const QString &s);
+
+private:
+    QString portName;
+    QString request;
+    int waitTimeout;
+    QMutex mutex;
+    QWaitCondition cond;
+    bool quit;
+};
+//! [0]
+
+#endif // MASTERTHREAD_H