main_window.cpp

/*******************************************************************
 * Purpose:
 *     Background events handling for Main Window.
 *
 *******************************************************************
 * Author: Usama
 *
 *******************************************************************
 * Changes:
 *     Date         Changed by      Description
 *     ----         ----------      -----------
 *
 *******************************************************************/

#include "main_window.h"
#include "ui_main_window.h"

#include <QFileDialog>
#include <QScrollBar>
#include <QDir>
#include <QDateTime>


#define DUMP_FILES_FOLDER      "dump-files"


MainWindow::MainWindow(QWidget *parent)
    : QMainWindow(parent)
    , ui(new Ui::MainWindow) {

    ui->setupUi(this);

    m_start_button_initial_text = ui->serialPortStartButton->text();
    m_start_button_stop_text = "STOP";

    m_dump_file = nullptr;
    m_dump_stream = nullptr;

    m_serial = new SerialInterface();

    setUiBaudRate       ( m_serial->getBaudRate()       );
    setUiDataBits       ( m_serial->getDataBits()       );
    setUiParity         ( m_serial->getParity()         );
    setUiStopBits       ( m_serial->getStopBits()       );
    setUiLineEnding     ( m_serial->getLineEnding()     );
    setUiInterlinedelay ( m_serial->getInterlineDelay() );

    connectUiEventReceivers();
    connectSerialPortSignals();

    m_serial->startInterface();
}

MainWindow::~MainWindow() {
    delete ui;
}

// -------------------------------
// Setting-up Events' Handlers
// ----------------------------
void MainWindow::connectUiEventReceivers() {

    // -----------------------
    // Buttons
    // ---------------------
    connect(ui->serialPortStartButton,      &QPushButton::clicked, this, &MainWindow::onUiSerialPortStartButtonClicked);
    connect(ui->transmitTextSendButton,     &QPushButton::clicked, this, &MainWindow::onUiTransmitTextSendButtonClicked);
    connect(ui->transmitTextSendFileButton, &QPushButton::clicked, this, &MainWindow::onUiTransmitTextSendFileButtonClicked);
    connect(ui->receiveTextClearButton,     &QPushButton::clicked, this, &MainWindow::onUiReceiveTextClearButtonClicked);

    // -----------------------
    // ComboBox - Serial Port
    // ---------------------
    connect(ui->serialPortComboBox, &QComboBox::currentIndexChanged, this, &MainWindow::onUiSerialPortComboBoxSelectionChanged);

    // -----------------------
    // TextEdit
    // ---------------------
    connect(ui->transmitTextEdit, &QTextEdit::textChanged, this, &MainWindow::onUiSendTextEditTextChanged);

    // -----------------------
    // Action Triggers - Baud Rates
    // ---------------------
    connect(ui->actionBaudRate_300,    &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_600,    &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_1200,   &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_1800,   &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_2400,   &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_4800,   &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_7200,   &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_9600,   &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_14400,  &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_19200,  &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_28800,  &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_38400,  &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_57600,  &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_115200, &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_230400, &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_460800, &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_921600, &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_1M,     &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);
    connect(ui->actionBaudRate_2M,     &QAction::triggered, this, &MainWindow::onUiBaudRateActionTriggered);

    // -----------------------
    // Action Triggers - Data Bits
    // ---------------------
    connect(ui->actionDataBits_5, &QAction::triggered, this, &MainWindow::onUiDataBitsActionTriggered);
    connect(ui->actionDataBits_6, &QAction::triggered, this, &MainWindow::onUiDataBitsActionTriggered);
    connect(ui->actionDataBits_7, &QAction::triggered, this, &MainWindow::onUiDataBitsActionTriggered);
    connect(ui->actionDataBits_8, &QAction::triggered, this, &MainWindow::onUiDataBitsActionTriggered);

    // -----------------------
    // Action Triggers - Parity
    // ---------------------
    connect(ui->actionParity_None, &QAction::triggered, this, &MainWindow::onUiParityActionTriggered);
    connect(ui->actionParity_Even, &QAction::triggered, this, &MainWindow::onUiParityActionTriggered);
    connect(ui->actionParity_Odd,  &QAction::triggered, this, &MainWindow::onUiParityActionTriggered);

    // -----------------------
    // Action Triggers - Stop Bits
    // ---------------------
    connect(ui->actionStopBits_1,   &QAction::triggered, this, &MainWindow::onUiStopBitsActionTriggered);
    connect(ui->actionStopBits_1_5, &QAction::triggered, this, &MainWindow::onUiStopBitsActionTriggered);
    connect(ui->actionStopBits_2,   &QAction::triggered, this, &MainWindow::onUiStopBitsActionTriggered);

    // -----------------------
    // Action Triggers - Line Ending
    // ---------------------
    connect(ui->actionLineEnding_None, &QAction::triggered, this, &MainWindow::onUiLineEndingActionTriggered);
    connect(ui->actionLineEnding_CR,   &QAction::triggered, this, &MainWindow::onUiLineEndingActionTriggered);
    connect(ui->actionLineEnding_LF,   &QAction::triggered, this, &MainWindow::onUiLineEndingActionTriggered);
    connect(ui->actionLineEnding_CRLF, &QAction::triggered, this, &MainWindow::onUiLineEndingActionTriggered);

    // -----------------------
    // Action Triggers - Inter-line Delays
    // ---------------------
    connect(ui->actionInterlineDelay_1ms,    &QAction::triggered, this, &MainWindow::onUiInterlineDelayActionTriggered);
    connect(ui->actionInterlineDelay_5ms,    &QAction::triggered, this, &MainWindow::onUiInterlineDelayActionTriggered);
    connect(ui->actionInterlineDelay_10ms,   &QAction::triggered, this, &MainWindow::onUiInterlineDelayActionTriggered);
    connect(ui->actionInterlineDelay_20ms,   &QAction::triggered, this, &MainWindow::onUiInterlineDelayActionTriggered);
    connect(ui->actionInterlineDelay_50ms,   &QAction::triggered, this, &MainWindow::onUiInterlineDelayActionTriggered);
    connect(ui->actionInterlineDelay_100ms,  &QAction::triggered, this, &MainWindow::onUiInterlineDelayActionTriggered);
    connect(ui->actionInterlineDelay_200ms,  &QAction::triggered, this, &MainWindow::onUiInterlineDelayActionTriggered);
    connect(ui->actionInterlineDelay_500ms,  &QAction::triggered, this, &MainWindow::onUiInterlineDelayActionTriggered);
    connect(ui->actionInterlineDelay_1sec,   &QAction::triggered, this, &MainWindow::onUiInterlineDelayActionTriggered);
    connect(ui->actionInterlineDelay_2sec,   &QAction::triggered, this, &MainWindow::onUiInterlineDelayActionTriggered);
    connect(ui->actionInterlineDelay_Custom, &QAction::triggered, this, &MainWindow::onUiInterlineDelayActionTriggered);
}

void MainWindow::connectSerialPortSignals() {
    connect(m_serial, &SerialInterface::serialPortAdded,          this, &MainWindow::onSerialPortAdded);
    connect(m_serial, &SerialInterface::serialPortRemoved,        this, &MainWindow::onSerialPortRemoved);
    connect(m_serial, &SerialInterface::portOpened,               this, &MainWindow::onSerialPortOpened);
    connect(m_serial, &SerialInterface::portClosed,               this, &MainWindow::onSerialPortClosed);
    connect(m_serial, &SerialInterface::fileTxnPercentageUpdated, this, &MainWindow::onSerialPortFileTransmitPercentageUpdated);
    connect(m_serial, &SerialInterface::dataReceived,             this, &MainWindow::onSerialPortDataReceived);
    connect(m_serial, &SerialInterface::errorOccurred,            this, &MainWindow::onSerialPortErrorOccurred);
}

// -------------------------------
// Handling Events
// ----------------------------
void MainWindow::closeEvent(QCloseEvent *) {
    m_serial->stopInterface();
}

// -------------------------------
// Handling Events - Button Clicks
// ----------------------------
void MainWindow::onUiSerialPortStartButtonClicked() {
    if (ui->serialPortStartButton->text() == m_start_button_initial_text) {
        m_serial->startSerialPort();
    } else {
        m_serial->stopSerialPort();
    }
}

void MainWindow::onUiTransmitTextSendButtonClicked() {
    m_serial->sendTextLineToSerialPort(ui->transmitTextEdit->toPlainText());
    ui->transmitTextEdit->clear();
}

void MainWindow::onUiTransmitTextSendFileButtonClicked() {
    QString filename =
            QFileDialog::getOpenFileName(
                this,
                tr("Open text file for transmission"),
                ".",
                tr("Text Files (*.txt *.serial *.commands *.list *.1553 *.1553commands *.1553-commands)"));

    if (!filename.isNull() && !filename.isEmpty()) {
        m_serial->sendTextFileToSerialPort(filename);
    }
}

void MainWindow::onUiReceiveTextClearButtonClicked() {
    ui->receivedTextEdit->clear();
}

// -------------------------------
// Handling Events - Combo Box
// ----------------------------
void MainWindow::onUiSerialPortComboBoxSelectionChanged() {
    if (ui->serialPortComboBox->count() > 0) {
        ui->serialPortStartButton->setEnabled(true);
        ui->transmitTextSendButton->setEnabled(false);
        ui->transmitTextSendFileButton->setEnabled(false);

        m_serial->setSerialPort(ui->serialPortComboBox->currentText());
    } else {
        ui->serialPortStartButton->setEnabled(false);
        ui->transmitTextSendButton->setEnabled(false);
        ui->transmitTextSendFileButton->setEnabled(false);
    }
}

// -------------------------------
// Handling Events - Text Edit
// ----------------------------
void MainWindow::onUiSendTextEditTextChanged() {
    QString text = ui->transmitTextEdit->toPlainText();

    if (text.endsWith("\r\n") ||
        text.endsWith("\r")   ||
        text.endsWith("\n")) {

        text.remove("\r\n").remove("\r").remove("\n");

        ui->transmitTextEdit->setText(text);

        onUiTransmitTextSendButtonClicked();
    }
}

// -------------------------------
// Handling Events - Menu Actions
// ----------------------------
void MainWindow::onUiBaudRateActionTriggered(bool checked) {
    QAction *action = (QAction *)sender();
    BaudRate baud_rate = static_cast<BaudRate>(action->text().remove(',').remove(' ').toInt());

    if (checked) {
        m_serial->setBaudRate(baud_rate);
    }

    setUiBaudRate(m_serial->getBaudRate());
}

void MainWindow::onUiDataBitsActionTriggered(bool checked) {
    QAction *action = (QAction *)sender();
    DataBits data_bits = static_cast<DataBits>(action->text().remove(',').remove(' ').toInt());

    if (checked) {
        m_serial->setDataBits(data_bits);
    }

    setUiDataBits(m_serial->getDataBits());
}

void MainWindow::onUiParityActionTriggered(bool checked) {
    QAction *action = (QAction *)sender();
    QString parity_str = action->text().trimmed().remove(' ').toLower();

    if (checked) {
        if (parity_str == "none") {
            m_serial->setParity(Parity::None);
        } else if (parity_str == "even") {
            m_serial->setParity(Parity::Even);
        } else if (parity_str == "odd") {
            m_serial->setParity(Parity::Odd);
        }
    }

    setUiParity(m_serial->getParity());
}

void MainWindow::onUiStopBitsActionTriggered(bool checked) {
    QAction *action = (QAction *)sender();
    float stop_bits = action->text().trimmed().remove(' ').toFloat();

    if (checked) {
        if (stop_bits == 1) {
            m_serial->setStopBits(StopBits::One);
        } else if (stop_bits == 1.5) {
            m_serial->setStopBits(StopBits::OnePtFive);
        } else if (stop_bits == 2) {
            m_serial->setStopBits(StopBits::Two);
        }
    }

    setUiStopBits(m_serial->getStopBits());
}

void MainWindow::onUiLineEndingActionTriggered(bool checked) {
    QAction *action = (QAction *)sender();
    QString line_ending = action->text().remove(QRegularExpression(" .*$")).trimmed().toLower();

    if (checked) {
        if (line_ending == "none") {
            m_serial->setLineEnding(LineEnding::None);
        } else if (line_ending == "cr") {
            m_serial->setLineEnding(LineEnding::CR);
        } else if (line_ending == "lf") {
            m_serial->setLineEnding(LineEnding::LF);
        } else if (line_ending == "crlf") {
            m_serial->setLineEnding(LineEnding::CRLF);
        }
    }

    setUiLineEnding(m_serial->getLineEnding());
}

void MainWindow::onUiInterlineDelayActionTriggered(bool checked) {
    QAction *action = (QAction *)sender();
    QString delay_str = action->text().trimmed().remove(QRegularExpression(" .*$")).trimmed().toLower();

    if (checked) {
        if (delay_str == "custom") {
            //-- TODO:
            //      Addition of getting custom value to be done at a later stage
        } else {
            unsigned int delay_val = delay_str.toUInt();
            m_serial->setInterlineDelay(delay_val);
        }
    }

    setUiInterlinedelay(m_serial->getInterlineDelay());
}

// -------------------------------
// Handling Events - Serial Port
// ----------------------------
void MainWindow::onSerialPortAdded(const QString& port_name) {
    ui->serialPortComboBox->addItem(port_name);
}

void MainWindow::onSerialPortRemoved(const QString& port_name) {
    for (int index = 0; index < ui->serialPortComboBox->count(); index++) {
        if (ui->serialPortComboBox->itemText(index) == port_name) {
            ui->serialPortComboBox->removeItem(index);
            break;
        }
    }
}

void MainWindow::onSerialPortOpened() {
    QDateTime dt = QDateTime::currentDateTime();

    QString filename = DUMP_FILES_FOLDER;
    filename += "/dump - " + dt.toString("yyyy_MM_dd - hh_mm_ss") + ".dump";

    QDir dir = QDir();

    if (!dir.exists(DUMP_FILES_FOLDER)) {
        dir.mkdir(DUMP_FILES_FOLDER);
    }

    m_dump_file = new QFile(filename);

    if (m_dump_file->open(QIODevice::WriteOnly)) {
        m_dump_stream = new QTextStream(m_dump_file);
        ui->receiveDumpFilenameLabel->setText("Dump File: " + filename);
    } else {
        delete (m_dump_file);
        m_dump_file = nullptr;
    }

    setUiForPortOpened();
}

void MainWindow::onSerialPortClosed() {
    if (m_dump_stream != nullptr) {
        m_dump_stream->flush();
        delete (m_dump_stream);
        m_dump_stream = nullptr;
    }

    if (m_dump_file != nullptr) {
        m_dump_file->close();
        delete (m_dump_file);
        m_dump_file = nullptr;
    }

    setUiForPortClosed();
}

void MainWindow::onSerialPortFileTransmitPercentageUpdated(float percentage) {
    int max_value = ui->transmitFileProgressBar->maximum();
    int min_value = ui->transmitFileProgressBar->minimum();
    int current_value = min_value + (int)((max_value - min_value) * percentage);

    ui->transmitFileProgressBar->setValue(current_value);

    if (current_value < max_value) {
        ui->transmitFileProgressBar->setEnabled(true);
    } else {
        ui->transmitFileProgressBar->setEnabled(false);
    }
}

void MainWindow::onSerialPortDataReceived(const QString& text) {
    ui->receivedTextEdit->setText(ui->receivedTextEdit->toPlainText() + text);
    ui->receivedTextEdit->verticalScrollBar()->setValue(ui->receivedTextEdit->verticalScrollBar()->maximum());

    if (m_dump_stream != nullptr) {
        *m_dump_stream << text;
        m_dump_stream->flush();
    }
}

void MainWindow::onSerialPortErrorOccurred(const QString& error_message) {
    ui->statusbar->showMessage(error_message);
}

// -------------------------------
// Setting-up GUI Elements
// ----------------------------
void MainWindow::setUiBaudRate(BaudRate baud_rate) {
    ui->actionBaudRate_300->setChecked(baud_rate == BaudRate::_300);
    ui->actionBaudRate_600->setChecked(baud_rate == BaudRate::_600);

    ui->actionBaudRate_1200->setChecked(baud_rate == BaudRate::_1200);
    ui->actionBaudRate_1800->setChecked(baud_rate == BaudRate::_1800);
    ui->actionBaudRate_2400->setChecked(baud_rate == BaudRate::_2400);
    ui->actionBaudRate_4800->setChecked(baud_rate == BaudRate::_4800);
    ui->actionBaudRate_7200->setChecked(baud_rate == BaudRate::_7200);
    ui->actionBaudRate_9600->setChecked(baud_rate == BaudRate::_9600);

    ui->actionBaudRate_14400->setChecked(baud_rate == BaudRate::_14400);
    ui->actionBaudRate_19200->setChecked(baud_rate == BaudRate::_19200);
    ui->actionBaudRate_28800->setChecked(baud_rate == BaudRate::_28800);
    ui->actionBaudRate_38400->setChecked(baud_rate == BaudRate::_38400);
    ui->actionBaudRate_57600->setChecked(baud_rate == BaudRate::_57600);

    ui->actionBaudRate_115200->setChecked(baud_rate == BaudRate::_115200);
    ui->actionBaudRate_230400->setChecked(baud_rate == BaudRate::_230400);
    ui->actionBaudRate_460800->setChecked(baud_rate == BaudRate::_460800);
    ui->actionBaudRate_921600->setChecked(baud_rate == BaudRate::_921600);

    ui->actionBaudRate_1M->setChecked(baud_rate == BaudRate::_1000000);
    ui->actionBaudRate_2M->setChecked(baud_rate == BaudRate::_2000000);
}

void MainWindow::setUiDataBits(DataBits data_bits) {
    ui->actionDataBits_5->setChecked(data_bits == DataBits::_5);
    ui->actionDataBits_6->setChecked(data_bits == DataBits::_6);
    ui->actionDataBits_7->setChecked(data_bits == DataBits::_7);
    ui->actionDataBits_8->setChecked(data_bits == DataBits::_8);
}

void MainWindow::setUiParity(Parity parity) {
    ui->actionParity_None->setChecked(parity == Parity::None);
    ui->actionParity_Even->setChecked(parity == Parity::Even);
    ui->actionParity_Odd->setChecked(parity == Parity::Odd);
}

void MainWindow::setUiStopBits(StopBits stop_bits) {
    ui->actionStopBits_1->setChecked(stop_bits == StopBits::One);
    ui->actionStopBits_1_5->setChecked(stop_bits == StopBits::OnePtFive);
    ui->actionStopBits_2->setChecked(stop_bits == StopBits::Two);
}

void MainWindow::setUiLineEnding(LineEnding line_ending) {
    ui->actionLineEnding_None->setChecked(line_ending == LineEnding::None);
    ui->actionLineEnding_CR->setChecked(line_ending == LineEnding::CR);
    ui->actionLineEnding_LF->setChecked(line_ending == LineEnding::LF);
    ui->actionLineEnding_CRLF->setChecked(line_ending == LineEnding::CRLF);
}

void MainWindow::setUiInterlinedelay(unsigned int delay_ms) {

    if ( delay_ms == 1    ||
         delay_ms == 5    ||
         delay_ms == 10   ||
         delay_ms == 20   ||
         delay_ms == 50   ||
         delay_ms == 100  ||
         delay_ms == 200  ||
         delay_ms == 500  ||
         delay_ms == 1000 ||
         delay_ms == 2000 ) {

        ui->actionInterlineDelay_1ms->setChecked(delay_ms == 1);
        ui->actionInterlineDelay_5ms->setChecked(delay_ms == 5);

        ui->actionInterlineDelay_10ms->setChecked(delay_ms == 10);
        ui->actionInterlineDelay_20ms->setChecked(delay_ms == 20);
        ui->actionInterlineDelay_50ms->setChecked(delay_ms == 50);

        ui->actionInterlineDelay_100ms->setChecked(delay_ms == 100);
        ui->actionInterlineDelay_200ms->setChecked(delay_ms == 200);
        ui->actionInterlineDelay_500ms->setChecked(delay_ms == 500);

        ui->actionInterlineDelay_1sec->setChecked(delay_ms == 1000);
        ui->actionInterlineDelay_2sec->setChecked(delay_ms == 2000);

        ui->actionInterlineDelay_Custom->setChecked(false);

    } else {

        ui->actionInterlineDelay_1ms->setChecked(false);
        ui->actionInterlineDelay_5ms->setChecked(false);

        ui->actionInterlineDelay_10ms->setChecked(false);
        ui->actionInterlineDelay_20ms->setChecked(false);
        ui->actionInterlineDelay_50ms->setChecked(false);

        ui->actionInterlineDelay_100ms->setChecked(false);
        ui->actionInterlineDelay_200ms->setChecked(false);
        ui->actionInterlineDelay_500ms->setChecked(false);

        ui->actionInterlineDelay_1sec->setChecked(false);
        ui->actionInterlineDelay_2sec->setChecked(false);

        ui->actionInterlineDelay_Custom->setChecked(true);

    }
}

void MainWindow::setUiForPortOpened() {
    ui->menuBaudRate->setEnabled(false);
    ui->menuDataBits->setEnabled(false);
    ui->menuParity->setEnabled(false);
    ui->menuStopBits->setEnabled(false);

    ui->serialPortComboBox->setEnabled(false);
    ui->serialPortStartButton->setText(m_start_button_stop_text);

    ui->transmitTextEdit->setEnabled(true);
    ui->transmitTextSendButton->setEnabled(true);
    ui->transmitTextSendFileButton->setEnabled(true);

    ui->receivedTextEdit->setEnabled(true);
}

void MainWindow::setUiForPortClosed() {
    ui->menuBaudRate->setEnabled(true);
    ui->menuDataBits->setEnabled(true);
    ui->menuParity->setEnabled(true);
    ui->menuStopBits->setEnabled(true);

    ui->serialPortComboBox->setEnabled(true);
    ui->serialPortStartButton->setText(m_start_button_initial_text);

    ui->transmitTextEdit->setEnabled(false);
    ui->transmitTextSendButton->setEnabled(false);
    ui->transmitTextSendFileButton->setEnabled(false);

    ui->receivedTextEdit->setEnabled(false);
}