/*

  Copyright © 2019 Hasan Yavuz Özderya

  This file is part of serialplot.

  serialplot is free software: you can redistribute it and/or modify

  it under the terms of the GNU General Public License as published by

  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;

}

void AbstractReader::enable(bool enabled)

{

    if (enabled)

    {

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

                         this, &AbstractReader::onDataReady);

    }

    else

    {

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

        disconnectSinks();

    }

}

void AbstractReader::onDataReady()

{

}

/*

  Copyright © 2019 Hasan Yavuz Özderya

  This file is part of serialplot.

  serialplot is free software: you can redistribute it and/or modify

  it under the terms of the GNU General Public License as published by

  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/>.

*/

#ifndef ABSTRACTREADER_H

#define ABSTRACTREADER_H

#include <QObject>

#include <QIODevice>

#include <QWidget>

#include <QTimer>

#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);

    /// 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:

    /// Reader should read from this device in `readData()` function.

    QIODevice* _device;

    /// Reader should check this variable to determine if reading is

    /// paused in `readData()`

    bool paused;

    /**

     * Called when `readyRead` is signaled by the device. This is

     * where the implementors should read the data and return the

     * exact number of bytes read from the device.

     */

    virtual unsigned readData() = 0;

private:

private slots:

    void onDataReady();

};

#endif // ABSTRACTREADER_H

/*

  This file is part of serialplot.

  serialplot is free software: you can redistribute it and/or modify

  it under the terms of the GNU General Public License as published by

  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 "dataformatpanel.h"

#include "ui_dataformatpanel.h"

#include <QRadioButton>

#include <QtDebug>

#include "utils.h"

#include "setting_defines.h"

DataFormatPanel::DataFormatPanel(QSerialPort* port, QWidget *parent) :

    QWidget(parent),

    ui(new Ui::DataFormatPanel),

    bsReader(port, this),

    asciiReader(port, this),

    framedReader(port, this),

    demoReader(port, this)

{

    ui->setupUi(this);

    serialPort = port;

    paused = false;

    readerBeforeDemo = nullptr;

    // initalize default reader

    currentReader = &bsReader;

    bsReader.enable();

    ui->rbBinary->setChecked(true);

    ui->horizontalLayout->addWidget(bsReader.settingsWidget(), 1);

    // initalize reader selection buttons

    connect(ui->rbBinary, &QRadioButton::toggled, [this](bool checked)

            {

                if (checked) selectReader(&bsReader);

            });

    connect(ui->rbAscii, &QRadioButton::toggled, [this](bool checked)

            {

                if (checked) selectReader(&asciiReader);

            });

    connect(ui->rbFramed, &QRadioButton::toggled, [this](bool checked)

            {

                if (checked) selectReader(&framedReader);

            });

}

DataFormatPanel::~DataFormatPanel()

{

    delete ui;

}

unsigned DataFormatPanel::numChannels() const

{

    return currentReader->numChannels();

}

Source* DataFormatPanel::activeSource()

{

    return currentReader;

}

void DataFormatPanel::pause(bool enabled)

{

    paused = enabled;

    currentReader->pause(enabled);

    demoReader.pause(enabled);

}

void DataFormatPanel::enableDemo(bool demoEnabled)

{

    if (demoEnabled)

    {

        readerBeforeDemo = currentReader;

        demoReader.setNumChannels(readerBeforeDemo->numChannels());

        selectReader(&demoReader);

    }

    else

    {

        Q_ASSERT(readerBeforeDemo != nullptr);

        selectReader(readerBeforeDemo);

    }

    // disable/enable reader selection buttons during/after demo

    ui->rbAscii->setDisabled(demoEnabled);

    ui->rbBinary->setDisabled(demoEnabled);

    ui->rbFramed->setDisabled(demoEnabled);

}

bool DataFormatPanel::isDemoEnabled() const

{

    return currentReader == &demoReader;

}

void DataFormatPanel::selectReader(AbstractReader* reader)

{

    currentReader->enable(false);

    reader->enable();

    // re-connect signals

    disconnect(currentReader, 0, this, 0);

    // switch the settings widget

    ui->horizontalLayout->removeWidget(currentReader->settingsWidget());

    currentReader->settingsWidget()->hide();

    ui->horizontalLayout->addWidget(reader->settingsWidget(), 1);

    reader->settingsWidget()->show();

    reader->pause(paused);

    currentReader = reader;

    emit sourceChanged(currentReader);

}

void DataFormatPanel::saveSettings(QSettings* settings)

{

    settings->beginGroup(SettingGroup_DataFormat);

    // save selected data format (current reader)

    QString format;

    AbstractReader* selectedReader = isDemoEnabled() ? readerBeforeDemo : currentReader;

    if (selectedReader == &bsReader)

    {

        format = "binary";

    }

    else if (selectedReader == &asciiReader)

    {

        format = "ascii";

    }

    else // framed reader

    {

        format = "custom";

    }

    settings->setValue(SG_DataFormat_Format, format);

    settings->endGroup();

    // save reader settings

    bsReader.saveSettings(settings);

    asciiReader.saveSettings(settings);

    framedReader.saveSettings(settings);

}

void DataFormatPanel::loadSettings(QSettings* settings)

{

    settings->beginGroup(SettingGroup_DataFormat);

    // load selected format

    QString format = settings->value(

        SG_DataFormat_Format, QString()).toString();

    if (format == "binary")

    {

        selectReader(&bsReader);

        ui->rbBinary->setChecked(true);

    }

    else if (format == "ascii")

    {

        selectReader(&asciiReader);

        ui->rbAscii->setChecked(true);

    }

    else if (format == "custom")

    {

        selectReader(&framedReader);

        ui->rbFramed->setChecked(true);

    } // else current selection stays

    settings->endGroup();

    // load reader settings

    bsReader.loadSettings(settings);

    asciiReader.loadSettings(settings);

    framedReader.loadSettings(settings);

}

/*

  This file is part of serialplot.

  serialplot is free software: you can redistribute it and/or modify

  it under the terms of the GNU General Public License as published by

  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/>.

*/

#ifndef DATAFORMATPANEL_H

#define DATAFORMATPANEL_H

#include <QWidget>

#include <QButtonGroup>

#include <QSerialPort>

#include <QList>

#include <QSettings>

#include <QtGlobal>

#include "binarystreamreader.h"

#include "asciireader.h"

#include "demoreader.h"

#include "framedreader.h"

#include "datarecorder.h"

namespace Ui {

class DataFormatPanel;

}

class DataFormatPanel : public QWidget

{

    Q_OBJECT

public:

    explicit DataFormatPanel(QSerialPort* port, QWidget* parent = 0);

    ~DataFormatPanel();

    /// Returns currently selected number of channels

    unsigned numChannels() const;

    /// Returns active source (reader)

    Source* activeSource();

    /// Stores data format panel settings into a `QSettings`

    void saveSettings(QSettings* settings);

    /// Loads data format panel settings from a `QSettings`.

    void loadSettings(QSettings* settings);

public slots:

    void pause(bool);

    void enableDemo(bool); // demo shouldn't be enabled when port is open

signals:

    /// Active (selected) reader has changed.

    void sourceChanged(Source* source);

private:

    Ui::DataFormatPanel *ui;

    QSerialPort* serialPort;

    BinaryStreamReader bsReader;

    AsciiReader asciiReader;

    FramedReader framedReader;

    /// Currently selected reader

    AbstractReader* currentReader;

    /// Disable current reader and enable a another one

    void selectReader(AbstractReader* reader);

    bool paused;

    DemoReader demoReader;

    AbstractReader* readerBeforeDemo;

    bool isDemoEnabled() const;

};

#endif // DATAFORMATPANEL_H

#include "defines.h"

#include "version.h"

#include "setting_defines.h"

#if defined(Q_OS_WIN) && defined(QT_STATIC)

#include <QtPlugin>

Q_IMPORT_PLUGIN(QWindowsIntegrationPlugin)

#endif

// TODO: depends on tab insertion order, a better solution would be to use object names

const QMap<int, QString> panelSettingMap({

        {0, "Port"},

        {1, "DataFormat"},

        {2, "Plot"},

        {3, "Commands"},

        {4, "Record"},

        {5, "TextView"},

        {6, "Log"}

    });

MainWindow::MainWindow(QWidget *parent) :

    QMainWindow(parent),

    ui(new Ui::MainWindow),

    aboutDialog(this),

    portControl(&serialPort),

    secondaryPlot(NULL),

    snapshotMan(this, &stream),

    commandPanel(&serialPort),

    dataFormatPanel(&serialPort),

    recordPanel(&stream),

    textView(&stream),

    updateCheckDialog(this)

{

    ui->setupUi(this);

    plotMan = new PlotManager(ui->plotArea, &plotMenu, &stream);

    ui->tabWidget->insertTab(0, &portControl, "Port");

    ui->tabWidget->insertTab(1, &dataFormatPanel, "Data Format");

    ui->tabWidget->insertTab(2, &plotControlPanel, "Plot");

    ui->tabWidget->insertTab(3, &commandPanel, "Commands");

    ui->tabWidget->insertTab(4, &recordPanel, "Record");

    ui->tabWidget->insertTab(5, &textView, "Text View");

    ui->tabWidget->setCurrentIndex(0);

    auto tbPortControl = portControl.toolBar();

    addToolBar(tbPortControl);

    addToolBar(recordPanel.toolbar());

    ui->plotToolBar->addAction(snapshotMan.takeSnapshotAction());

    menuBar()->insertMenu(ui->menuHelp->menuAction(), snapshotMan.menu());

    menuBar()->insertMenu(ui->menuHelp->menuAction(), commandPanel.menu());

    connect(&commandPanel, &CommandPanel::focusRequested, [this]()

            {

                this->ui->tabWidget->setCurrentWidget(&commandPanel);

                this->ui->tabWidget->showTabs();

            });

    tbPortControl->setObjectName("tbPortControl");

    ui->plotToolBar->setObjectName("tbPlot");

    setupAboutDialog();

    // init view menu

    ui->menuBar->insertMenu(ui->menuSecondary->menuAction(), &plotMenu);

    plotMenu.addSeparator();

    QMenu* tbMenu = plotMenu.addMenu("Toolbars");

    tbMenu->addAction(ui->plotToolBar->toggleViewAction());

    tbMenu->addAction(portControl.toolBar()->toggleViewAction());

    // init secondary plot menu

    auto group = new QActionGroup(this);

    group->addAction(ui->actionVertical);

    group->addAction(ui->actionHorizontal);

    // init UI signals

    // Secondary plot menu signals

    connect(ui->actionBarPlot, &QAction::triggered,

            this, &MainWindow::showBarPlot);

    connect(ui->actionVertical, &QAction::triggered,

            [this](bool checked)

            {

                if (checked) ui->splitter->setOrientation(Qt::Vertical);

            });

    connect(ui->actionHorizontal, &QAction::triggered,

            [this](bool checked)

            {

                if (checked) ui->splitter->setOrientation(Qt::Horizontal);

            });

    // Help menu signals

    QObject::connect(ui->actionHelpAbout, &QAction::triggered,

              &aboutDialog, &QWidget::show);

    QObject::connect(ui->actionCheckUpdate, &QAction::triggered,

              &updateCheckDialog, &QWidget::show);

    QObject::connect(ui->actionReportBug, &QAction::triggered,

                     [](){QDesktopServices::openUrl(QUrl(BUG_REPORT_URL));});

    // File menu signals

    QObject::connect(ui->actionExportCsv, &QAction::triggered,

                     this, &MainWindow::onExportCsv);

    QObject::connect(ui->actionSaveSettings, &QAction::triggered,

                     this, &MainWindow::onSaveSettings);

    QObject::connect(ui->actionLoadSettings, &QAction::triggered,

                     this, &MainWindow::onLoadSettings);

    ui->actionQuit->setShortcutContext(Qt::ApplicationShortcut);

    QObject::connect(ui->actionQuit, &QAction::triggered,

                     this, &MainWindow::close);

    // port control signals

    QObject::connect(&portControl, &PortControl::portToggled,

                     this, &MainWindow::onPortToggled);

    // plot control signals

    connect(&plotControlPanel, &PlotControlPanel::numOfSamplesChanged,

            this, &MainWindow::onNumOfSamplesChanged);

    connect(&plotControlPanel, &PlotControlPanel::numOfSamplesChanged,

            plotMan, &PlotManager::setNumOfSamples);

    connect(&plotControlPanel, &PlotControlPanel::yScaleChanged,

            plotMan, &PlotManager::setYAxis);

    connect(&plotControlPanel, &PlotControlPanel::xScaleChanged,

            &stream, &Stream::setXAxis);

    connect(&plotControlPanel, &PlotControlPanel::xScaleChanged,

            plotMan, &PlotManager::setXAxis);

    connect(&plotControlPanel, &PlotControlPanel::plotWidthChanged,

            plotMan, &PlotManager::setPlotWidth);

    // plot toolbar signals

    QObject::connect(ui->actionClear, SIGNAL(triggered(bool)),

                     this, SLOT(clearPlot()));

    QObject::connect(snapshotMan.takeSnapshotAction(), &QAction::triggered,

                     plotMan, &PlotManager::flashSnapshotOverlay);

    QObject::connect(ui->actionPause, &QAction::triggered,

                     &stream, &Stream::pause);

    QObject::connect(ui->actionPause, &QAction::triggered,

                     [this](bool enabled)

                     {

                         if (enabled && !recordPanel.recordPaused())

                         {

                             dataFormatPanel.pause(true);

                         }

                         else

                         {

                             dataFormatPanel.pause(false);

                         }

                     });

    QObject::connect(&recordPanel, &RecordPanel::recordPausedChanged,

                     [this](bool enabled)

                     {

                         if (ui->actionPause->isChecked() && enabled)

                         {

                             dataFormatPanel.pause(false);

                         }

                     });

    connect(&serialPort, &QIODevice::aboutToClose,

            &recordPanel, &RecordPanel::onPortClose);

    // init plot

    numOfSamples = plotControlPanel.numOfSamples();

    stream.setNumSamples(numOfSamples);

    plotControlPanel.setChannelInfoModel(stream.infoModel());

    // init scales

    stream.setXAxis(plotControlPanel.xAxisAsIndex(),

                    plotControlPanel.xMin(), plotControlPanel.xMax());

    plotMan->setYAxis(plotControlPanel.autoScale(),

                      plotControlPanel.yMin(), plotControlPanel.yMax());

    plotMan->setXAxis(plotControlPanel.xAxisAsIndex(),

                      plotControlPanel.xMin(), plotControlPanel.xMax());

    plotMan->setNumOfSamples(numOfSamples);

    plotMan->setPlotWidth(plotControlPanel.plotWidth());

    // Init sps (sample per second) counter

    spsLabel.setText("0sps");

    ui->statusBar->addPermanentWidget(&spsLabel);

    connect(&sampleCounter, &SampleCounter::spsChanged,

            this, &MainWindow::onSpsChanged);

    // init demo

    QObject::connect(ui->actionDemoMode, &QAction::toggled,

                     this, &MainWindow::enableDemo);

    QObject::connect(ui->actionDemoMode, &QAction::toggled,

                     plotMan, &PlotManager::showDemoIndicator);

    // init stream connections

    connect(&dataFormatPanel, &DataFormatPanel::sourceChanged,

            this, &MainWindow::onSourceChanged);

    onSourceChanged(dataFormatPanel.activeSource());

    // load default settings

    QSettings settings("serialplot", "serialplot");

    loadAllSettings(&settings);

    // ensure command panel has 1 command if none loaded

    if (!commandPanel.numOfCommands())

    {

        commandPanel.newCommandAction()->trigger();

    }

    // Important: This should be after newCommandAction is triggered

    // (above) we don't want user to be greeted with command panel on

    // the very first run.

    connect(commandPanel.newCommandAction(), &QAction::triggered, [this]()

            {

                this->ui->tabWidget->setCurrentWidget(&commandPanel);

                this->ui->tabWidget->showTabs();

            });

}

MainWindow::~MainWindow()

{

    if (serialPort.isOpen())

    {

        serialPort.close();

    }

    delete plotMan;

    delete ui;

    ui = NULL; // we check if ui is deleted in messageHandler

}

void MainWindow::closeEvent(QCloseEvent * event)

{

    // save snapshots

    if (!snapshotMan.isAllSaved())

    {

        auto clickedButton = QMessageBox::warning(

            this, "Closing SerialPlot",

            "There are un-saved snapshots. If you close you will loose the data.",

            QMessageBox::Discard, QMessageBox::Cancel);

        if (clickedButton == QMessageBox::Cancel)

        {

            event->ignore();

            return;

        }

    }

    // save settings

    QSettings settings("serialplot", "serialplot");

    saveAllSettings(&settings);

    settings.sync();

    if (settings.status() != QSettings::NoError)

    {

        QString errorText;

        if (settings.status() == QSettings::AccessError)

        {

            QString file = settings.fileName();

            errorText = QString("Serialplot cannot save settings due to access error. \

This happens if you have run serialplot as root (with sudo for ex.) previously. \

Try fixing the permissions of file: %1, or just delete it.").arg(file);

        }

        else

        {

            errorText = QString("Serialplot cannot save settings due to unknown error: %1").\

                arg(settings.status());

        }

        auto button = QMessageBox::critical(

            NULL,

            "Failed to save settings!", errorText,

            QMessageBox::Cancel | QMessageBox::Ok);

        if (button == QMessageBox::Cancel)

        {

            event->ignore();

            return;

        }

    }

    QMainWindow::closeEvent(event);

}

void MainWindow::setupAboutDialog()

{

    Ui_AboutDialog uiAboutDialog;

    uiAboutDialog.setupUi(&aboutDialog);

    QObject::connect(uiAboutDialog.pbAboutQt, &QPushButton::clicked,

                     [](){ QApplication::aboutQt();});

    QString aboutText = uiAboutDialog.lbAbout->text();

    aboutText.replace("$VERSION_STRING$", VERSION_STRING);

    aboutText.replace("$VERSION_REVISION$", VERSION_REVISION);

    uiAboutDialog.lbAbout->setText(aboutText);

}

void MainWindow::onPortToggled(bool open)

{

    // make sure demo mode is disabled

    if (open && isDemoRunning()) enableDemo(false);

    ui->actionDemoMode->setEnabled(!open);

}

void MainWindow::onSourceChanged(Source* source)

{

    source->connectSink(&stream);

    source->connectSink(&sampleCounter);

}

void MainWindow::clearPlot()

{

    stream.clear();

    plotMan->replot();

}

void MainWindow::onNumOfSamplesChanged(int value)

{

    numOfSamples = value;

    stream.setNumSamples(value);

    plotMan->replot();

}

void MainWindow::onSpsChanged(float sps)

{

    int precision = sps < 1. ? 3 : 0;

    spsLabel.setText(QString::number(sps, 'f', precision) + "sps");

}

bool MainWindow::isDemoRunning()

{

    return ui->actionDemoMode->isChecked();

}

void MainWindow::enableDemo(bool enabled)

{

    if (enabled)

    {

        if (!serialPort.isOpen())

        {

            dataFormatPanel.enableDemo(true);

        }

        else

        {

            ui->actionDemoMode->setChecked(false);

        }

    }

    else

    {

        dataFormatPanel.enableDemo(false);

        ui->actionDemoMode->setChecked(false);

    }

}

void MainWindow::showSecondary(QWidget* wid)

{

    if (secondaryPlot != NULL)

    {

        secondaryPlot->deleteLater();

    }

    secondaryPlot = wid;

    ui->splitter->addWidget(wid);

    ui->splitter->setStretchFactor(0, 1);

    ui->splitter->setStretchFactor(1, 0);

}

void MainWindow::hideSecondary()

{

    if (secondaryPlot == NULL)

    {

        qFatal("Secondary plot doesn't exist!");

    }

    secondaryPlot->deleteLater();

    secondaryPlot = NULL;

}

void MainWindow::showBarPlot(bool show)

{