the Free Software Foundation, either version 3 of the License, or

  (at your option) any later version.

  serialplot is distributed in the hope that it will be useful,

  but WITHOUT ANY WARRANTY; without even the implied warranty of

  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License

  along with serialplot.  If not, see <http://www.gnu.org/licenses/>.

*/

#include "abstractreader.h"

AbstractReader::AbstractReader(QIODevice* device, QObject* parent) :

    QObject(parent)

{

    _device = device;

}

void AbstractReader::pause(bool enabled)

{

    paused = enabled;

}

#include "source.h"

/**

 * All reader classes must inherit this class.

 */

class AbstractReader : public QObject, public Source

{

    Q_OBJECT

public:

    explicit AbstractReader(QIODevice* device, QObject* parent = 0);

    /**

     * Returns a widget to be shown in data format panel when reader

     * is selected.

     */

    virtual QWidget* settingsWidget() = 0;

    /// Reader should only read when enabled. Default state should be

    /// 'disabled'.

    virtual void enable(bool enabled = true) = 0;

    /// None of the current readers support X channel at the moment

    bool hasX() const final { return false; };

signals:

    // TODO: should we keep this?

    void numOfChannelsChanged(unsigned);

public slots:

    /**

     * Pauses the reading.

     *

     * Reader should actually continue reading to keep the

     * synchronization but shouldn't commit data.

     */

    void pause(bool enabled);

protected:

    QIODevice* _device;

    bool paused;

};

#endif // ABSTRACTREADER_H

                _numChannels = value;

                updateNumChannels(); // TODO: setting numchannels = 0, should remove all buffers

                                     // do we want this?

                autoNumOfChannels = (_numChannels == NUMOFCHANNELS_AUTO);

                if (!autoNumOfChannels)

                {

                    emit numOfChannelsChanged(value);

                }

            });

    connect(&_settingsWidget, &AsciiReaderSettings::delimiterChanged,

            [this](QChar d)

            {

                delimiter = d;

            });

    connect(device, &QIODevice::aboutToClose, [this](){discardFirstLine=true;});

}

QWidget* AsciiReader::settingsWidget()

{

    return &_settingsWidget;

}

// TODO: this could be a part of AbstractReader

void AsciiReader::enable(bool enabled)

{

    if (enabled)

    {

        discardFirstLine = true;

        QObject::connect(_device, &QIODevice::readyRead,

                         this, &AsciiReader::onDataReady);

    }

    else

    {

        QObject::disconnect(_device, 0, this, 0);

        disconnectSinks();

    }

}

void AsciiReader::onDataReady()

{

    while(_device->canReadLine())

    {

        QString line = QString(_device->readLine());

        // discard only once when we just started reading

        if (discardFirstLine)

  serialplot is distributed in the hope that it will be useful,

  but WITHOUT ANY WARRANTY; without even the implied warranty of

  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License

  along with serialplot.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef ASCIIREADER_H

#define ASCIIREADER_H

#include <QSettings>

#include "abstractreader.h"

#include "asciireadersettings.h"

class AsciiReader : public AbstractReader

{

    Q_OBJECT

public:

    explicit AsciiReader(QIODevice* device, QObject *parent = 0);

    QWidget* settingsWidget();

    void enable(bool enabled = true);

    /// Stores settings into a `QSettings`

    void saveSettings(QSettings* settings);

    /// Loads settings from a `QSettings`.

    void loadSettings(QSettings* settings);

private:

    AsciiReaderSettings _settingsWidget;

    /// number of channels will be determined from incoming data

    unsigned autoNumOfChannels;

    QChar delimiter; ///< selected column delimiter

    // We may have (usually true) started reading in the middle of a

    // line, so its a better idea to just discard first line.

    bool discardFirstLine;

private slots:

    void onDataReady();

};

#endif // ASCIIREADER_H

    // initial number format selection

    onNumberFormatChanged(_settingsWidget.numberFormat());

    connect(&_settingsWidget, &BinaryStreamReaderSettings::numberFormatChanged,

            this, &BinaryStreamReader::onNumberFormatChanged);

    // enable skip byte and sample buttons

    connect(&_settingsWidget, &BinaryStreamReaderSettings::skipByteRequested,

            [this]()

            {

                skipByteRequested = true;

            });

    connect(&_settingsWidget, &BinaryStreamReaderSettings::skipSampleRequested,

            [this]()

            {

                skipSampleRequested = true;

            });

}

QWidget* BinaryStreamReader::settingsWidget()

{

    return &_settingsWidget;

}

void BinaryStreamReader::enable(bool enabled)

{

    if (enabled)

    {

        QObject::connect(_device, &QIODevice::readyRead,

                         this, &BinaryStreamReader::onDataReady);

    }

    else

    {

        QObject::disconnect(_device, 0, this, 0);

        disconnectSinks();

    }

}

void BinaryStreamReader::onNumberFormatChanged(NumberFormat numberFormat)

{

    switch(numberFormat)

    {

        case NumberFormat_uint8:

            sampleSize = 1;

            readSample = &BinaryStreamReader::readSampleAs<quint8>;

            break;

        case NumberFormat_int8:

            sampleSize = 1;

  You should have received a copy of the GNU General Public License

  along with serialplot.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef BINARYSTREAMREADER_H

#define BINARYSTREAMREADER_H

#include <QSettings>

#include "abstractreader.h"

#include "binarystreamreadersettings.h"

/**

 * Reads a simple stream of samples in binary form from the

 * device. There is no means of synchronization other than a button

 * that should be manually triggered by user.

 */

class BinaryStreamReader : public AbstractReader

{

    Q_OBJECT

public:

    explicit BinaryStreamReader(QIODevice* device, QObject *parent = 0);

    QWidget* settingsWidget();

    void enable(bool enabled = true);

    /// Stores settings into a `QSettings`

    void saveSettings(QSettings* settings);

    /// Loads settings from a `QSettings`.

    void loadSettings(QSettings* settings);

private:

    BinaryStreamReaderSettings _settingsWidget;

    unsigned sampleSize;

    bool skipByteRequested;

    bool skipSampleRequested;

    /// points to the readSampleAs function for currently selected number format

    double (BinaryStreamReader::*readSample)();

    /**

     * Reads 1 sample from the device in given format.

     *

     * @note Device should already have enough bytes present before

     * calling this function.

     */

    template<typename T> double readSampleAs();

private slots:

    void onNumberFormatChanged(NumberFormat numberFormat);

    void onNumOfChannelsChanged(unsigned value);

    void onDataReady();

};

#endif // BINARYSTREAMREADER_H

    count = 0;

    timer.setInterval(100);

    connect(&timer, &QTimer::timeout,

            this, &DemoReader::demoTimerTimeout);

}

QWidget* DemoReader::settingsWidget()

{

    return &_settingsWidget;

}

void DemoReader::enable(bool enabled)

{

    if (enabled)

    {

        timer.start();

    }

    else

    {

        timer.stop();

        disconnectSinks();

    }

}

void DemoReader::setNumChannels(unsigned value)

{

    _settingsWidget.setNumChannels(value);

}

void DemoReader::demoTimerTimeout()

{

    const double period = 100;

    count++;

    if (count >= 100) count = 0;

    if (!paused)

    {

        SamplePack samples(1, _numChannels);

        for (unsigned ci = 0; ci < _numChannels; ci++)

        {

            // we are calculating the fourier components of square wave

            samples.data(ci)[0] = 4*sin(2*M_PI*double((ci+1)*count)/period)/((2*(ci+1))*M_PI);

        }

        feedOut(samples);

    }

}

void DemoReader::onNumChannelsChanged(unsigned value)

#define DEMOREADER_H

#include <QTimer>

#include "abstractreader.h"

#include "demoreadersettings.h"

/**

 * This is a special case of reader implementation and should be used

 * with care.

 *

 * There is no settings widget. Number of channels should be set from

 * currently selected actual readers settings widget.

 *

 * This reader should not be enabled when port is open!

 */

class DemoReader : public AbstractReader

{

    Q_OBJECT

public:

    explicit DemoReader(QIODevice* device, QObject* parent = 0);

    QWidget* settingsWidget();

    void enable(bool enabled = true);

public slots:

    void setNumChannels(unsigned value);

private:

    DemoReaderSettings _settingsWidget;

    QTimer timer;

    int count;

private slots:

    void demoTimerTimeout();

    void onNumChannelsChanged(unsigned value);

};

#endif // DEMOREADER_H

    // init reader state

    reset();

}

void FramedReader::enable(bool enabled)

{

    if (enabled)

    {

        connect(_device, &QIODevice::readyRead,

                this, &FramedReader::onDataReady);

    }

    else

    {

        QObject::disconnect(_device, 0, this, 0);

        disconnectSinks();

    }

}

QWidget* FramedReader::settingsWidget()

{

    return &_settingsWidget;

}

void FramedReader::onNumberFormatChanged(NumberFormat numberFormat)

{

    switch(numberFormat)

    {

        case NumberFormat_uint8:

            sampleSize = 1;

            readSample = &FramedReader::readSampleAs<quint8>;

            break;

        case NumberFormat_int8:

            sampleSize = 1;

            readSample = &FramedReader::readSampleAs<qint8>;

            break;

        case NumberFormat_uint16:

            sampleSize = 2;

            readSample = &FramedReader::readSampleAs<quint16>;

            break;

        case NumberFormat_int16:

            sampleSize = 2;

            readSample = &FramedReader::readSampleAs<qint16>;

            break;

        case NumberFormat_uint32:

            sampleSize = 4;

            readSample = &FramedReader::readSampleAs<quint32>;

            break;

  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License

  along with serialplot.  If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef FRAMEDREADER_H

#define FRAMEDREADER_H

#include <QSettings>

#include "abstractreader.h"

#include "framedreadersettings.h"

/**

 * Reads data in a customizable framed format.

 */

class FramedReader : public AbstractReader

{

    Q_OBJECT

public:

    explicit FramedReader(QIODevice* device, QObject *parent = 0);

    QWidget* settingsWidget();

    void enable(bool enabled = true);

    /// Stores settings into a `QSettings`

    void saveSettings(QSettings* settings);

    /// Loads settings from a `QSettings`.

    void loadSettings(QSettings* settings);

private:

    /// bit wise fields for `settingsValid` member

    enum SettingInvalidFlag

    {

        SYNCWORD_INVALID = 1,

        FRAMESIZE_INVALID = 2

    };

    // settings related members

    FramedReaderSettings _settingsWidget;

    unsigned sampleSize;

    unsigned settingsInvalid;   /// settings are all valid if this is 0, if not no reading is done

    QByteArray syncWord;

    bool checksumEnabled;

    bool hasSizeByte;

    unsigned frameSize;

    bool debugModeEnabled;

    /// Checks the validity of syncWord and frameSize then shows an

    /// error message. Also updates `settingsInvalid`. If settings are

    /// valid `settingsInvalid` should be `0`.

    void checkSettings();

    // read state related members

    unsigned sync_i; /// sync byte index to be read next

    bool gotSync;    /// indicates if sync word is captured

    bool gotSize;    /// indicates if size is captured, ignored if size byte is disabled (fixed size)

    unsigned calcChecksum;

    void reset();    /// Resets the reading state. Used in case of error or setting change.

    /// points to the readSampleAs function for currently selected number format

    double (FramedReader::*readSample)();

    template<typename T> double readSampleAs();

    /// reads payload portion of the frame, calculates checksum and commits data