Add a new simple and command line writer example

Change-Id: I5d893d18477790def27bfa1fa051d459a8193db5
Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com>
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>

5 files changed, 194 insertions, 1 deletions

diff --git a/examples/serialport/cwritersync/cwritersync.pro b/examples/serialport/cwritersync/cwritersync.pro
new file mode 100644
index 0000000..14cba72
--- /dev/null
+++ b/examples/serialport/cwritersync/cwritersync.pro
@@ -0,0 +1,16 @@
+QT = core
+
+greaterThan(QT_MAJOR_VERSION, 4) {
+    QT       += serialport
+} else {
+    include($$QTSERIALPORT_PROJECT_ROOT/src/serialport/qt4support/serialport.prf)
+}
+
+CONFIG += console
+CONFIG -= app_bundle
+
+TARGET = cwritersync
+TEMPLATE = app
+
+SOURCES += \
+    main.cpp
diff --git a/examples/serialport/cwritersync/main.cpp b/examples/serialport/cwritersync/main.cpp
new file mode 100644
index 0000000..756bbff
--- /dev/null
+++ b/examples/serialport/cwritersync/main.cpp
@@ -0,0 +1,131 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Laszlo Papp <lpapp@kde.org>
+** 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 <QtSerialPort/QSerialPort>
+
+#include <QTextStream>
+#include <QCoreApplication>
+#include <QFile>
+#include <QStringList>
+
+QT_USE_NAMESPACE
+
+int main(int argc, char *argv[])
+{
+    QCoreApplication coreApplication(argc, argv);
+    int argumentCount = QCoreApplication::arguments().size();
+    QStringList argumentList = QCoreApplication::arguments();
+
+    QTextStream standardOutput(stdout);
+
+    if (argumentCount == 1) {
+        standardOutput << QObject::tr("Usage: %1 <serialportname> [baudrate]").arg(argumentList.first()) << endl;
+        return 1;
+    }
+
+    QSerialPort serialPort;
+    QString serialPortName = argumentList.at(1);
+    serialPort.setPortName(serialPortName);
+
+    if (!serialPort.open(QIODevice::WriteOnly)) {
+        standardOutput << QObject::tr("Failed to open port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        return 1;
+    }
+
+    int serialPortBaudRate = (argumentCount > 2) ? argumentList.at(2).toInt() : QSerialPort::Baud9600;
+    if (!serialPort.setBaudRate(serialPortBaudRate)) {
+        standardOutput << QObject::tr("Failed to set 9600 baud for port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        return 1;
+    }
+
+    if (!serialPort.setDataBits(QSerialPort::Data8)) {
+        standardOutput << QObject::tr("Failed to set 8 data bits for port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        return 1;
+    }
+
+    if (!serialPort.setParity(QSerialPort::NoParity)) {
+        standardOutput << QObject::tr("Failed to set no parity for port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        return 1;
+    }
+
+    if (!serialPort.setStopBits(QSerialPort::OneStop)) {
+        standardOutput << QObject::tr("Failed to set 1 stop bit for port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        return 1;
+    }
+
+    if (!serialPort.setFlowControl(QSerialPort::NoFlowControl)) {
+        standardOutput << QObject::tr("Failed to set no flow control for port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        return 1;
+    }
+
+    QFile dataFile;
+    if (!dataFile.open(stdin, QIODevice::ReadOnly)) {
+        standardOutput << QObject::tr("Failed to open stdin for reading") << endl;
+        return 1;
+    }
+
+    QByteArray writeData(dataFile.readAll());
+
+    if (writeData.isEmpty()) {
+        standardOutput << QObject::tr("Either no data was currently available on the standard input for reading, or an error occurred for port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        dataFile.close();
+        return 1;
+    }
+
+    dataFile.close();
+
+    qint64 bytesWritten = serialPort.write(writeData);
+
+    if (bytesWritten == -1) {
+        standardOutput << QObject::tr("Failed to write the data to port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        return 1;
+    } else if (bytesWritten != writeData.size()) {
+        standardOutput << QObject::tr("Failed to write all the data to port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        return 1;
+    } else if (!serialPort.waitForBytesWritten(5000)) {
+        standardOutput << QObject::tr("Operation timed out or an error occurred for port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        return 1;
+    }
+
+    standardOutput << QObject::tr("Data successfully sent to port %1").arg(serialPortName) << endl;
+
+    return 0;
+}
diff --git a/examples/serialport/doc/cwritersync.qdoc b/examples/serialport/doc/cwritersync.qdoc
new file mode 100644
index 0000000..05858ef
--- /dev/null
+++ b/examples/serialport/doc/cwritersync.qdoc
@@ -0,0 +1,45 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Laszlo Papp <lpapp@kde.org>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** 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 Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \example cwritersync
+    \title Command Line Writer Sync Example
+    \ingroup qtserialport-examples
+
+    The Command Line Writer Sync example shows how to use the QSerialPort class
+    for sending data synchronously over the selected serial port with the
+    desired settings.
+
+    \image cwritersync-example.png Screenshot of the Command Line Writer Sync example
+
+    This command line writer sync example sends data synchronously over the
+    selected serial port in a console, provided by the QSerialPort class.
+
+    For sending data synchronously over the selected serial port, use the
+    \l{QIODevice::write()}{write()} and
+    \l{QIODevice::waitForBytesWritten()}{waitForBytesWritten()} methods.
+*/
diff --git a/examples/serialport/examples.qdoc b/examples/serialport/examples.qdoc
index ac95f5a..fe15a6a 100644
--- a/examples/serialport/examples.qdoc
+++ b/examples/serialport/examples.qdoc
@@ -38,6 +38,7 @@
     \li \l blockingmaster
     \li \l blockingslave
     \li \l cenumerator
+    \li \l cwritersync
     \li \l enumerator
     \li \l terminal
     \endlist
diff --git a/examples/serialport/serialport.pro b/examples/serialport/serialport.pro
index 32e50b2..0bc821f 100644
--- a/examples/serialport/serialport.pro
+++ b/examples/serialport/serialport.pro
@@ -1,6 +1,6 @@
 TEMPLATE = subdirs
 CONFIG += ordered
-SUBDIRS = cenumerator
+SUBDIRS = cenumerator cwritersync
 greaterThan(QT_MAJOR_VERSION, 4) {
     !isEmpty(QT.widgets.name):SUBDIRS += enumerator terminal blockingmaster blockingslave
 } else {