/*

  Copyright © 2018 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 "datarecorder.h"

#include <QtDebug>

DataRecorder::DataRecorder(QObject *parent) :

    QObject(parent),

    fileStream(&file)

{

    lastNumChannels = 0;

    disableBuffering = false;

    windowsLE = false;

}

{

    Q_ASSERT(!file.isOpen());

    _sep =  separator;

    // open file

    file.setFileName(fileName);

    if (!file.open(QIODevice::WriteOnly))

    {

        qCritical() << "Opening file " << fileName

                    << " for recording failed with error: " << file.error();

        return false;

    }

    // write header line

    if (!channelNames.isEmpty())

    {

        fileStream << channelNames.join(_sep);

        fileStream << le();

        lastNumChannels = channelNames.length();

    }

    return true;

}

void DataRecorder::feedIn(const SamplePack& data)

{

    Q_ASSERT(file.isOpen());    // recorder should be disconnected before stopping recording

    Q_ASSERT(!data.hasX());     // NYI

    // check if number of channels has changed during recording and warn

    unsigned numChannels = data.numChannels();

    if (lastNumChannels != 0 && numChannels != lastNumChannels)

    {

        qWarning() << "Number of channels changed from " << lastNumChannels

                   << " to " << numChannels <<

            " during recording, CSV file is corrupted but no data will be lost.";

    }

    lastNumChannels = numChannels;

    // write data

    unsigned numSamples = data.numSamples();

    for (unsigned int i = 0; i < numSamples; i++)

    {

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

        {

            fileStream << data.data(ci)[i];

            if (ci != numChannels-1) fileStream << _sep;

        }

        fileStream << le();

    }

    if (disableBuffering) fileStream.flush();

}

void DataRecorder::stopRecording()

{

    Q_ASSERT(file.isOpen());

    file.close();

    lastNumChannels = 0;

}

const char* DataRecorder::le() const

{

    return windowsLE ? "\r\n" : "\n";

}

  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 DATARECORDER_H

#define DATARECORDER_H

#include <QObject>

#include <QFile>

#include <QTextStream>

#include "sink.h"

/**

 * Implemented as a `Sink` that writes incoming data to a file. Before

 * connecting a `Source` recording must be started with the `startRecording`

 * method. Also before calling `stopRecording`, recorder should be disconnected

 * from source.

 */

class DataRecorder : public QObject, public Sink

{

    Q_OBJECT

public:

    explicit DataRecorder(QObject *parent = 0);

    /// Disables file buffering

    bool disableBuffering;

    /**

     * Use CR+LF as line ending. `false` by default.

     *

     * @note Toggling this variable during a recording will result in

     * a corrupted file. Care must be taken at higher (UI) levels.

     */

    bool windowsLE;

    /**

     * @brief Starts recording data to a file in CSV format.

     *

     * File is opened and header line (names of channels) is written. After

     * calling this function recorder should be connected to a `Source`.

     *

     * @param fileName name of the recording file

     * @param separator column separator

     * @param channelNames names of the channels for header line, if empty no header line is written

     * @return false if file operation fails (read only etc.)

     */

    /**

     * @brief Adds data to a channel.

     *

     * Multiple rows of data can be added at a time. Each channels

     * data should be ordered consecutively in the `data` array:

     *

     * [CH0_SMP0, CH0_SMP1 ... CH0_SMPN, CH1_SMP0, CH1_SMP1, ... , CHN_SMPN]

     *

     * If `numOfChannels` changes during recording, no data will be

     * lost (ie. it will be written to the file) but this will produce

     * an invalid CSV file. An error message will be written to the

     * console.

     *

     * @param data samples array

     * @param length number of samples in `data`, must be multiple of `numOfChannels`

     * @param numOfChannels how many channels samples this data carries

     */

    void addData(double* data, unsigned length, unsigned numOfChannels);

    /// Stops recording, closes file.

    void stopRecording();

protected:

    virtual void feedIn(const SamplePack& data);

private:

    unsigned lastNumChannels;   ///< used for error message only

    QFile file;

    QTextStream fileStream;

    QString _sep;

    /// Returns the selected line ending.

    const char* le() const;

};

#endif // DATARECORDER_H

#include <QMessageBox>

#include <QFileDialog>

#include <QRegularExpression>

#include <QtDebug>

#include "recordpanel.h"

#include "ui_recordpanel.h"

#include "setting_defines.h"

RecordPanel::RecordPanel(Stream* stream, QWidget *parent) :

    QWidget(parent),

    ui(new Ui::RecordPanel),

    recordToolBar(tr("Record Toolbar")),

    recordAction(QIcon::fromTheme("media-record"), tr("Record"), this),

    recorder(this)

{

    overwriteSelected = false;

    _stream = stream;

    ui->setupUi(this);

    recordToolBar.setObjectName("tbRecord");

    recordAction.setCheckable(true);

    recordToolBar.addAction(&recordAction);

    ui->pbRecord->setDefaultAction(&recordAction);

    connect(ui->pbBrowse, &QPushButton::clicked,

            this, &RecordPanel::selectFile);

    connect(&recordAction, &QAction::triggered,

            this, &RecordPanel::onRecord);

    connect(ui->cbRecordPaused, SIGNAL(toggled(bool)),

            this, SIGNAL(recordPausedChanged(bool)));

    connect(ui->cbDisableBuffering, &QCheckBox::toggled,

            [this](bool enabled)

            {

                recorder.disableBuffering = enabled;

            });

    connect(ui->cbWindowsLE, &QCheckBox::toggled,

            [this](bool enabled)

            {

                recorder.windowsLE = enabled;

            });

    connect(&recordAction, &QAction::toggled, ui->cbWindowsLE, &QWidget::setDisabled);

}

RecordPanel::~RecordPanel()

{

    delete ui;

}

QToolBar* RecordPanel::toolbar()

{

    return &recordToolBar;

}

bool RecordPanel::recordPaused()

{

    return ui->cbRecordPaused->isChecked();

}

bool RecordPanel::selectFile()

{

    QString fileName = QFileDialog::getSaveFileName(

        parentWidget(), tr("Select recording file"));

    if (fileName.isEmpty())

    {

        return false;

    }

    else

    {

        selectedFile = fileName;

        ui->lbFileName->setText(selectedFile);

        overwriteSelected = QFile::exists(fileName);

        return true;

    }

}

void RecordPanel::onRecord(bool start)

{

    if (!start)

    {

        stopRecording();

        return;

    }

    bool canceled = false;

    if (ui->leSeparator->text().isEmpty())

    {

        QMessageBox::critical(this, "Error",

                              "Column separator cannot be empty! Please select a separator.");

    else

    {

        selectedFile = autoFileName;

    }

    ui->lbFileName->setText(selectedFile);

    return true;

}

bool RecordPanel::confirmOverwrite(QString fileName)

{

    // prepare message box

    QMessageBox mb(parentWidget());

    mb.setWindowTitle(tr("File Already Exists"));

    mb.setIcon(QMessageBox::Warning);

    mb.setText(tr("File (%1) already exists. How to continue?").arg(fileName));

    auto bCancel    = mb.addButton(QMessageBox::Cancel);

    auto bOverwrite = mb.addButton(tr("Overwrite"), QMessageBox::DestructiveRole);

    mb.addButton(tr("Select Another File"), QMessageBox::YesRole);

    mb.setEscapeButton(bCancel);

    // show message box

    mb.exec();

    if (mb.clickedButton() == bCancel)

    {

        return false;

    }

    else if (mb.clickedButton() == bOverwrite)

    {

        selectedFile = fileName;

        return true;

    }

    else                    // select button

    {

        return selectFile();

    }

}

void RecordPanel::startRecording(void)

{

    QStringList channelNames;

    if (ui->cbHeader->isChecked())

    {

        channelNames = _stream->infoModel()->channelNames();

    }

    {

        _stream->connectFollower(&recorder);

    }

}

void RecordPanel::stopRecording(void)

{

    recorder.stopRecording();

    _stream->disconnectFollower(&recorder);

}

void RecordPanel::onPortClose()

{

    if (recordAction.isChecked() && ui->cbStopOnClose->isChecked())

    {

        stopRecording();

        recordAction.setChecked(false);

    }

}

QString RecordPanel::getSeparator() const

{

    QString sep = ui->leSeparator->text();

    sep.replace("\\t", "\t");

    return sep;

}

void RecordPanel::saveSettings(QSettings* settings)

{

    settings->beginGroup(SettingGroup_Record);

    settings->setValue(SG_Record_AutoIncrement, ui->cbAutoIncrement->isChecked());

    settings->setValue(SG_Record_RecordPaused, ui->cbRecordPaused->isChecked());

    settings->setValue(SG_Record_StopOnClose, ui->cbStopOnClose->isChecked());

    settings->setValue(SG_Record_Header, ui->cbHeader->isChecked());

    settings->setValue(SG_Record_DisableBuffering, ui->cbDisableBuffering->isChecked());

    settings->setValue(SG_Record_Separator, ui->leSeparator->text());

    settings->endGroup();

}

void RecordPanel::loadSettings(QSettings* settings)

{

    settings->beginGroup(SettingGroup_Record);

    ui->cbAutoIncrement->setChecked(

        settings->value(SG_Record_AutoIncrement, ui->cbAutoIncrement->isChecked()).toBool());

    ui->cbRecordPaused->setChecked(

        settings->value(SG_Record_RecordPaused, ui->cbRecordPaused->isChecked()).toBool());

    ui->cbStopOnClose->setChecked(

        settings->value(SG_Record_StopOnClose, ui->cbStopOnClose->isChecked()).toBool());

<?xml version="1.0" encoding="UTF-8"?>

<ui version="4.0">

 <class>RecordPanel</class>

 <widget class="QWidget" name="RecordPanel">

  <property name="geometry">

   <rect>

    <x>0</x>

    <y>0</y>

    <width>627</width>

   </rect>

  </property>

  <property name="windowTitle">

   <string>Form</string>

  </property>

  <layout class="QHBoxLayout" name="horizontalLayout_2">

   <item>

    <layout class="QVBoxLayout" name="verticalLayout">

     <item>

      <layout class="QHBoxLayout" name="horizontalLayout">

       <item>

        <widget class="QPushButton" name="pbBrowse">

         <property name="toolTip">

          <string>Select record file</string>

         </property>

         <property name="text">

          <string>Browse</string>

         </property>

        </widget>

       </item>

       <item>

        <widget class="QLabel" name="lbFileName">

         <property name="sizePolicy">

          <sizepolicy hsizetype="MinimumExpanding" vsizetype="Preferred">

           <horstretch>0</horstretch>

           <verstretch>0</verstretch>

          </sizepolicy>

         </property>

         <property name="text">

          <string>Select file...</string>

         </property>

        </widget>

       </item>

      </layout>

     </item>

     <item>

      <layout class="QGridLayout" name="gridLayout">

       <item row="1" column="1">

        <widget class="QCheckBox" name="cbHeader">

         <property name="toolTip">

          <string>Channel names are written to the first line of record file</string>

         </property>

         <property name="text">

          <string>Write header line</string>

         </property>

         <property name="checked">

          <bool>true</bool>

         </property>

        </widget>

       </item>

       <item row="2" column="0">

        <widget class="QCheckBox" name="cbRecordPaused">

         <property name="toolTip">

          <string>Continue recording to file even when plotting is paused</string>

         </property>

         <property name="text">

          <string>Record while paused</string>

         </property>

         <property name="checked">

          <bool>true</bool>

         </property>

        </widget>

       </item>

       <item row="1" column="2">

        <spacer name="horizontalSpacer_2">

         <property name="orientation">

          <enum>Qt::Horizontal</enum>

         </property>

         <property name="sizeHint" stdset="0">

          <size>

           <width>1</width>

           <height>20</height>

          </size>

         </property>

        </spacer>

       </item>

      </layout>

     </item>

     <item>

      <layout class="QHBoxLayout" name="horizontalLayout_3">

       <item>

        <widget class="QLabel" name="label">

         <property name="text">

          <string>Column Separator:</string>

         </property>

        </widget>

       </item>

       <item>

        <widget class="QLineEdit" name="leSeparator">

         <property name="maximumSize">

          <size>

           <width>30</width>

           <height>16777215</height>

          </size>

         </property>

         <property name="toolTip">

          <string>For TAB character enter \t</string>

         </property>

         <property name="text">

          <string>,</string>

         </property>

        </widget>

       </item>

       <item>

        <spacer name="horizontalSpacer">

         <property name="orientation">

          <enum>Qt::Horizontal</enum>

         </property>

         <property name="sizeHint" stdset="0">

          <size>

           <width>40</width>

           <height>20</height>

          </size>

         </property>

        </spacer>

       </item>

      </layout>

     </item>

     <item>

      <spacer name="verticalSpacer">

       <property name="orientation">

        <enum>Qt::Vertical</enum>

       </property>

       <property name="sizeHint" stdset="0">