diff options
author | Laszlo Papp <lpapp@kde.org> | 2013-09-02 08:13:06 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-09-04 14:59:53 +0200 |
commit | 6bd56edb87f14074a15fde141d9d6f52d01de366 (patch) | |
tree | 48c2bdd8bb1c812721f2abbf44740f5c77e21696 | |
parent | ab919b700600f8f6555b4848655f15559c9861ee (diff) | |
download | qtserialport-6bd56edb87f14074a15fde141d9d6f52d01de366.tar.gz |
Use the term 'directions' for representing the directions
1) The previous 'dir' is incorrect because it should be plural for consistency
based upon the other variable names.
2) 'dir' can be misleading in the context where such a term is also used for
representing a directory, like in our case.
Change-Id: I650cc64c2669286a4d7ef071a2ab3b7b63228977
Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com>
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
-rw-r--r-- | src/serialport/qserialport.cpp | 36 | ||||
-rw-r--r-- | src/serialport/qserialport.h | 8 | ||||
-rw-r--r-- | src/serialport/qserialport_symbian.cpp | 10 | ||||
-rw-r--r-- | src/serialport/qserialport_symbian_p.h | 4 | ||||
-rw-r--r-- | src/serialport/qserialport_unix.cpp | 12 | ||||
-rw-r--r-- | src/serialport/qserialport_unix_p.h | 4 | ||||
-rw-r--r-- | src/serialport/qserialport_win.cpp | 10 | ||||
-rw-r--r-- | src/serialport/qserialport_win_p.h | 4 | ||||
-rw-r--r-- | src/serialport/qserialport_wince.cpp | 6 |
9 files changed, 47 insertions, 47 deletions
diff --git a/src/serialport/qserialport.cpp b/src/serialport/qserialport.cpp index 86d0d37..fb5615f 100644 --- a/src/serialport/qserialport.cpp +++ b/src/serialport/qserialport.cpp @@ -539,27 +539,27 @@ bool QSerialPort::settingsRestoredOnClose() const \warning Returns equal baud rate in any direction on Windows, Windows CE, and Symbian. */ -bool QSerialPort::setBaudRate(qint32 baudRate, Directions dir) +bool QSerialPort::setBaudRate(qint32 baudRate, Directions directions) { Q_D(QSerialPort); - if (d->setBaudRate(baudRate, dir)) { - if (dir & QSerialPort::Input) { + if (d->setBaudRate(baudRate, directions)) { + if (directions & QSerialPort::Input) { if (d->inputBaudRate != baudRate) d->inputBaudRate = baudRate; else - dir &= ~QSerialPort::Input; + directions &= ~QSerialPort::Input; } - if (dir & QSerialPort::Output) { + if (directions & QSerialPort::Output) { if (d->outputBaudRate != baudRate) d->outputBaudRate = baudRate; else - dir &= ~QSerialPort::Output; + directions &= ~QSerialPort::Output; } - if (dir) - emit baudRateChanged(baudRate, dir); + if (directions) + emit baudRateChanged(baudRate, directions); return true; } @@ -567,20 +567,20 @@ bool QSerialPort::setBaudRate(qint32 baudRate, Directions dir) return false; } -qint32 QSerialPort::baudRate(Directions dir) const +qint32 QSerialPort::baudRate(Directions directions) const { Q_D(const QSerialPort); - if (dir == QSerialPort::AllDirections) + if (directions == QSerialPort::AllDirections) return d->inputBaudRate == d->outputBaudRate ? d->inputBaudRate : QSerialPort::UnknownBaud; - return dir & QSerialPort::Input ? d->inputBaudRate : d->outputBaudRate; + return directions & QSerialPort::Input ? d->inputBaudRate : d->outputBaudRate; } /*! - \fn void QSerialPort::baudRateChanged(qint32 baudRate, Directions dir) + \fn void QSerialPort::baudRateChanged(qint32 baudRate, Directions directions) This signal is emitted after the baud rate has been changed. The new baud - rate is passed as \a baudRate and directions as \a dir. + rate is passed as \a baudRate and directions as \a directions. \sa QSerialPort::baudRate */ @@ -856,18 +856,18 @@ bool QSerialPort::flush() /*! Discards all characters from the output or input buffer, depending on - a given direction \a dir. Including clear an internal class buffers and + given directions \a directions. Including clear an internal class buffers and the UART (driver) buffers. Also terminate pending read or write operations. If successful, returns true; otherwise returns false. */ -bool QSerialPort::clear(Directions dir) +bool QSerialPort::clear(Directions directions) { Q_D(QSerialPort); - if (dir & Input) + if (directions & Input) d->readBuffer.clear(); - if (dir & Output) + if (directions & Output) d->writeBuffer.clear(); - return d->clear(dir); + return d->clear(directions); } /*! diff --git a/src/serialport/qserialport.h b/src/serialport/qserialport.h index 8b1c272..eb2baa3 100644 --- a/src/serialport/qserialport.h +++ b/src/serialport/qserialport.h @@ -177,8 +177,8 @@ public: void setSettingsRestoredOnClose(bool restore); bool settingsRestoredOnClose() const; - bool setBaudRate(qint32 baudRate, Directions dir = AllDirections); - qint32 baudRate(Directions dir = AllDirections) const; + bool setBaudRate(qint32 baudRate, Directions directions = AllDirections); + qint32 baudRate(Directions directions = AllDirections) const; bool setDataBits(DataBits dataBits); DataBits dataBits() const; @@ -201,7 +201,7 @@ public: PinoutSignals pinoutSignals(); bool flush(); - bool clear(Directions dir = AllDirections); + bool clear(Directions directions = AllDirections); bool atEnd() const Q_DECL_OVERRIDE; bool setDataErrorPolicy(DataErrorPolicy policy = IgnorePolicy); @@ -226,7 +226,7 @@ public: bool setBreakEnabled(bool set = true); Q_SIGNALS: - void baudRateChanged(qint32 baudRate, QSerialPort::Directions dir); + void baudRateChanged(qint32 baudRate, QSerialPort::Directions directions); void dataBitsChanged(QSerialPort::DataBits dataBits); void parityChanged(QSerialPort::Parity parity); void stopBitsChanged(QSerialPort::StopBits stopBits); diff --git a/src/serialport/qserialport_symbian.cpp b/src/serialport/qserialport_symbian.cpp index df348b8..50359de 100644 --- a/src/serialport/qserialport_symbian.cpp +++ b/src/serialport/qserialport_symbian.cpp @@ -213,12 +213,12 @@ bool QSerialPortPrivate::flush() return false; } -bool QSerialPortPrivate::clear(QSerialPort::Directions dir) +bool QSerialPortPrivate::clear(QSerialPort::Directions directions) { TUint flags = 0; - if (dir & QSerialPort::Input) + if (directions & QSerialPort::Input) flags |= KCommResetRx; - if (dir & QSerialPort::Output) + if (directions & QSerialPort::Output) flags |= KCommResetTx; TInt r = descriptor.ResetBuffers(flags); return r == KErrNone; @@ -277,11 +277,11 @@ bool QSerialPortPrivate::waitForBytesWritten(int msec) return false; } -bool QSerialPortPrivate::setBaudRate(qint32 baudRate, QSerialPort::Directions dir) +bool QSerialPortPrivate::setBaudRate(qint32 baudRate, QSerialPort::Directions directions) { Q_Q(QSerialPort); - if (dir != QSerialPort::AllDirections) { + if (directions != QSerialPort::AllDirections) { q->setError(QSerialPort::UnsupportedOperationError); return false; } diff --git a/src/serialport/qserialport_symbian_p.h b/src/serialport/qserialport_symbian_p.h index d709236..c56ddae 100644 --- a/src/serialport/qserialport_symbian_p.h +++ b/src/serialport/qserialport_symbian_p.h @@ -64,7 +64,7 @@ public: bool setRequestToSend(bool set); bool flush(); - bool clear(QSerialPort::Directions dir); + bool clear(QSerialPort::Directions directions); bool sendBreak(int duration); bool setBreakEnabled(bool set); @@ -80,7 +80,7 @@ public: bool waitForReadyRead(int msec); bool waitForBytesWritten(int msec); - bool setBaudRate(qint32 baudRate, QSerialPort::Directions dir); + bool setBaudRate(qint32 baudRate, QSerialPort::Directions directions); bool setDataBits(QSerialPort::DataBits dataBits); bool setParity(QSerialPort::Parity parity); bool setStopBits(QSerialPort::StopBits stopBits); diff --git a/src/serialport/qserialport_unix.cpp b/src/serialport/qserialport_unix.cpp index 0176e5f..be0467b 100644 --- a/src/serialport/qserialport_unix.cpp +++ b/src/serialport/qserialport_unix.cpp @@ -332,10 +332,10 @@ bool QSerialPortPrivate::flush() #endif } -bool QSerialPortPrivate::clear(QSerialPort::Directions dir) +bool QSerialPortPrivate::clear(QSerialPort::Directions directions) { - return ::tcflush(descriptor, (dir == QSerialPort::AllDirections) - ? TCIOFLUSH : (dir & QSerialPort::Input) ? TCIFLUSH : TCOFLUSH) != -1; + return ::tcflush(descriptor, (directions == QSerialPort::AllDirections) + ? TCIOFLUSH : (directions & QSerialPort::Input) ? TCIFLUSH : TCOFLUSH) != -1; } bool QSerialPortPrivate::sendBreak(int duration) @@ -486,7 +486,7 @@ bool QSerialPortPrivate::waitForBytesWritten(int msecs) return false; } -bool QSerialPortPrivate::setBaudRate(qint32 baudRate, QSerialPort::Directions dir) +bool QSerialPortPrivate::setBaudRate(qint32 baudRate, QSerialPort::Directions directions) { Q_Q(QSerialPort); @@ -507,8 +507,8 @@ bool QSerialPortPrivate::setBaudRate(qint32 baudRate, QSerialPort::Directions di } #endif // prepare to set standard baud rate - ret = !(((dir & QSerialPort::Input) && ::cfsetispeed(¤tTermios, unixBaudRate) < 0) - || ((dir & QSerialPort::Output) && ::cfsetospeed(¤tTermios, unixBaudRate) < 0)); + ret = !(((directions & QSerialPort::Input) && ::cfsetispeed(¤tTermios, unixBaudRate) < 0) + || ((directions & QSerialPort::Output) && ::cfsetospeed(¤tTermios, unixBaudRate) < 0)); } else { // try prepate to set custom baud rate #ifdef Q_OS_LINUX diff --git a/src/serialport/qserialport_unix_p.h b/src/serialport/qserialport_unix_p.h index 0c723a9..83f89e3 100644 --- a/src/serialport/qserialport_unix_p.h +++ b/src/serialport/qserialport_unix_p.h @@ -96,7 +96,7 @@ public: bool setRequestToSend(bool set); bool flush(); - bool clear(QSerialPort::Directions dir); + bool clear(QSerialPort::Directions directions); bool sendBreak(int duration); bool setBreakEnabled(bool set); @@ -112,7 +112,7 @@ public: bool waitForReadyRead(int msecs); bool waitForBytesWritten(int msecs); - bool setBaudRate(qint32 baudRate, QSerialPort::Directions dir); + bool setBaudRate(qint32 baudRate, QSerialPort::Directions directions); bool setDataBits(QSerialPort::DataBits dataBits); bool setParity(QSerialPort::Parity parity); bool setStopBits(QSerialPort::StopBits stopBits); diff --git a/src/serialport/qserialport_win.cpp b/src/serialport/qserialport_win.cpp index f0b5e96..c515e82 100644 --- a/src/serialport/qserialport_win.cpp +++ b/src/serialport/qserialport_win.cpp @@ -367,14 +367,14 @@ bool QSerialPortPrivate::flush() return startAsyncWrite() && ::FlushFileBuffers(descriptor); } -bool QSerialPortPrivate::clear(QSerialPort::Directions dir) +bool QSerialPortPrivate::clear(QSerialPort::Directions directions) { DWORD flags = 0; - if (dir & QSerialPort::Input) { + if (directions & QSerialPort::Input) { flags |= PURGE_RXABORT | PURGE_RXCLEAR; actualReadBufferSize = 0; } - if (dir & QSerialPort::Output) { + if (directions & QSerialPort::Output) { flags |= PURGE_TXABORT | PURGE_TXCLEAR; actualWriteBufferSize = 0; acyncWritePosition = 0; @@ -546,11 +546,11 @@ bool QSerialPortPrivate::waitForBytesWritten(int msecs) #endif // #ifndef Q_OS_WINCE -bool QSerialPortPrivate::setBaudRate(qint32 baudRate, QSerialPort::Directions dir) +bool QSerialPortPrivate::setBaudRate(qint32 baudRate, QSerialPort::Directions directions) { Q_Q(QSerialPort); - if (dir != QSerialPort::AllDirections) { + if (directions != QSerialPort::AllDirections) { q->setError(QSerialPort::UnsupportedOperationError); return false; } diff --git a/src/serialport/qserialport_win_p.h b/src/serialport/qserialport_win_p.h index 9735e9f..24e7289 100644 --- a/src/serialport/qserialport_win_p.h +++ b/src/serialport/qserialport_win_p.h @@ -77,7 +77,7 @@ public: bool setRequestToSend(bool set); bool flush(); - bool clear(QSerialPort::Directions dir); + bool clear(QSerialPort::Directions directions); bool sendBreak(int duration); bool setBreakEnabled(bool set); @@ -93,7 +93,7 @@ public: bool waitForReadyRead(int msec); bool waitForBytesWritten(int msec); - bool setBaudRate(qint32 baudRate, QSerialPort::Directions dir); + bool setBaudRate(qint32 baudRate, QSerialPort::Directions directions); bool setDataBits(QSerialPort::DataBits dataBits); bool setParity(QSerialPort::Parity parity); bool setStopBits(QSerialPort::StopBits stopBits); diff --git a/src/serialport/qserialport_wince.cpp b/src/serialport/qserialport_wince.cpp index 2123d17..e99c6aa 100644 --- a/src/serialport/qserialport_wince.cpp +++ b/src/serialport/qserialport_wince.cpp @@ -241,12 +241,12 @@ bool QSerialPortPrivate::flush() return notifyWrite() && ::FlushFileBuffers(descriptor); } -bool QSerialPortPrivate::clear(QSerialPort::Directions dir) +bool QSerialPortPrivate::clear(QSerialPort::Directions directions) { DWORD flags = 0; - if (dir & QSerialPort::Input) + if (directions & QSerialPort::Input) flags |= PURGE_RXABORT | PURGE_RXCLEAR; - if (dir & QSerialPort::Output) + if (directions & QSerialPort::Output) flags |= PURGE_TXABORT | PURGE_TXCLEAR; return ::PurgeComm(descriptor, flags); } |