/*

  Copyright © 2017 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;

}

{

    Q_ASSERT(!file.isOpen());

    // 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 << "\n";

        lastNumChannels = channelNames.length();

    }

    return true;

}

void DataRecorder::addData(double* data, unsigned length, unsigned numOfChannels)

{

    Q_ASSERT(length > 0);

    Q_ASSERT(length % numOfChannels == 0);

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

    {

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

                   << " to " << numOfChannels <<

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

    }

    lastNumChannels = numOfChannels;

    unsigned numOfSamples = length / numOfChannels; // per channel

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

    {

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

        {

            fileStream << data[ci * numOfSamples + i];

        }

        fileStream << '\n';

    }

    if (disableBuffering) fileStream.flush();

}

void DataRecorder::stopRecording()

{

    Q_ASSERT(file.isOpen());

    file.close();

    lastNumChannels = 0;

}

/*

  Copyright © 2017 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 DATARECORDER_H

#define DATARECORDER_H

#include <QObject>

#include <QFile>

#include <QTextStream>

class DataRecorder : public QObject

{

    Q_OBJECT

public:

    explicit DataRecorder(QObject *parent = 0);

    /// Disables file buffering

    bool disableBuffering;

    /**

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

     *

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

     *

     * @param fileName name of the recording file

     * @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();

private:

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

    QFile file;

    QTextStream fileStream;

};

#endif // DATARECORDER_H

/*

  Copyright © 2017 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 "recordpanel.h"

#include "ui_recordpanel.h"

#include <QIcon>

#include <QFile>

#include <QFileInfo>

#include <QMessageBox>

#include <QFileDialog>

#include <QRegularExpression>

#include <QtDebug>

RecordPanel::RecordPanel(DataRecorder* recorder, ChannelManager* channelMan, QWidget *parent) :

    QWidget(parent),

    ui(new Ui::RecordPanel),

    recordToolBar(tr("Record Toolbar")),

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

{

    overwriteSelected = false;

    _recorder = recorder;

    _channelMan = channelMan;

    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;

            });

}

RecordPanel::~RecordPanel()

{

    delete ui;

}

QToolBar* RecordPanel::toolbar()

{

    return &recordToolBar;

}

bool RecordPanel::isRecording()

{

    return recordAction.isChecked();

}

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;

    }

    // check file name

    bool canceled = false;

    if (selectedFile.isEmpty() && !selectFile())

    {

        canceled = true;

    }

    if (!overwriteSelected && QFile::exists(selectedFile))

    {

        if (ui->cbAutoIncrement->isChecked())

        {

            // TODO: should we increment even if user selected to replace?

            canceled = !incrementFileName();

        }

        else

        {

            canceled = !confirmOverwrite(selectedFile);

        }

    }

    overwriteSelected = false;

    if (canceled)

    {

        recordAction.setChecked(false);

    }

    else

    {

        startRecording();

    }

}

bool RecordPanel::incrementFileName(void)

{

    QFileInfo fileInfo(selectedFile);

    QString base = fileInfo.completeBaseName();

    QRegularExpression regex("(.*?)(\\d+)(?!.*\\d)(.*)");

    auto match = regex.match(base);

    if (match.hasMatch())

    {

        bool ok;

        int fileNum = match.captured(2).toInt(&ok);

        base = match.captured(1) + QString::number(fileNum + 1) + match.captured(3);

    }

    else

    {

        base += "_1";

    }

    QString suffix = fileInfo.suffix();;

    if (!suffix.isEmpty())

    {

        suffix = "." + suffix;

    }

    QString autoFileName = fileInfo.path() + "/" + base + suffix;

    // check if auto generated file name exists, ask user another name

    if (QFile::exists(autoFileName))

    {

        if (!confirmOverwrite(autoFileName))

        {

            return false;

        }

    }

    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 = _channelMan->infoModel()->channelNames();

    }

    emit recordStarted();

}

void RecordPanel::stopRecording(void)

{

    emit recordStopped();

    _recorder->stopRecording();

}

void RecordPanel::onPortClose()

{

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

    {

        stopRecording();

        recordAction.setChecked(false);

    }

}

/*

  Copyright © 2017 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 RECORDPANEL_H

#define RECORDPANEL_H

#include <QWidget>

#include <QString>

#include <QToolBar>

#include <QAction>

#include "datarecorder.h"

#include "channelmanager.h"

namespace Ui {

class RecordPanel;

}

class RecordPanel : public QWidget

{

    Q_OBJECT

public:

    explicit RecordPanel(DataRecorder* recorder, ChannelManager* channelMan,

                         QWidget* parent = 0);

    ~RecordPanel();

    QToolBar* toolbar();

    bool isRecording();

    bool recordPaused();

signals:

    void recordStarted();

    void recordStopped();

    void recordPausedChanged(bool enabled);

public slots:

    /// Must be called when port is closed

    void onPortClose();

private:

    Ui::RecordPanel *ui;

    QToolBar recordToolBar;

    QAction recordAction;

    QString selectedFile;

    bool overwriteSelected;

    DataRecorder* _recorder;

    ChannelManager* _channelMan;

    /**

     * @brief Increments the file name.

     *

     * If file name doesn't have a number at the end of it, a number is appended

     * with underscore starting from 1.

     *

     * @return false if user cancels

     */

    bool incrementFileName(void);

    /**

     * @brief Used to ask user confirmation if auto generated file

     * name exists.

     *

     * If user confirms overwrite, `selectedFile` is set to

     * `fileName`. User is also given option to select file and is

     * shown a file select dialog in this case.

     *

     * @param fileName auto generated file name.

     * @return false if user cancels

     */

    bool confirmOverwrite(QString fileName);

    void startRecording(void);

    void stopRecording(void);

private slots:

    /**

     * @brief Opens up the file select dialog

     *

     * If you cancel the selection operation, currently selected file is not

     * changed.

     *

     * @return true if file selected, false if user cancels

     */

    bool selectFile();

    void onRecord(bool start);

};

#endif // RECORDPANEL_H

<?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>532</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>

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

       <property name="toolTip">

        <string>Increments file name automatically everytime a new recording starts</string>

       </property>

       <property name="text">

        <string>Auto increment file name</string>

       </property>

       <property name="checked">

        <bool>true</bool>

       </property>

      </widget>

     </item>

     <item>

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

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

       <property name="text">

        <string>Stop recording when port closed</string>

       </property>

       <property name="checked">

        <bool>true</bool>

       </property>

      </widget>

     </item>

     <item>

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

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

       <property name="toolTip">

        <string>Do not buffer when writing to file. Check this if you are using other software to open the file during recording.</string>

       </property>

       <property name="text">

        <string>Disable buffering</string>

       </property>

      </widget>

     </item>

     <item>

      <spacer name="verticalSpacer">

       <property name="orientation">

        <enum>Qt::Vertical</enum>

       </property>

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

        <size>

         <width>20</width>

        </size>

       </property>

      </spacer>

     </item>

    </layout>

   </item>

   <item>

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

     <item>

      <widget class="QToolButton" name="pbRecord">

       <property name="minimumSize">

        <size>

         <width>85</width>

         <height>50</height>

        </size>

       </property>

       <property name="toolTip">

        <string>Start/Stop Recording</string>

       </property>

       <property name="text">

        <string>Record</string>

       </property>

      </widget>

     </item>

     <item>

      <spacer name="verticalSpacer_2">

       <property name="orientation">

        <enum>Qt::Vertical</enum>

       </property>

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

        <size>

         <width>20</width>

        </size>

       </property>

      </spacer>

     </item>

    </layout>

   </item>

  </layout>

 </widget>

 <resources/>

 <connections/>

</ui>