OpenRGB/qt/OpenRGBZoneInitializationDialog/OpenRGBZoneInitializationDialog.cpp

/*---------------------------------------------------------*\
| OpenRGBZoneInitializationDialog.cpp                       |
|                                                           |
|   User interface for initializing zones                   |
|                                                           |
|   This file is part of the OpenRGB project                |
|   SPDX-License-Identifier: GPL-2.0-or-later               |
\*---------------------------------------------------------*/

#include "OpenRGBZoneInitializationDialog.h"
#include "ResourceManager.h"
#include "SettingsManager.h"
#include "LogManager.h"
#include "OpenRGBDialog.h"

#include "ui_OpenRGBZoneInitializationDialog.h"

#include <QDialog>
#include <QFile>
#include <QSpinBox>

void OpenRGBZoneInitializationDialog::RunChecks(QWidget *parent)
{
    /*---------------------------------------------------------*\
    | Determine if we should run (user setting)                 |
    \*---------------------------------------------------------*/
    SettingsManager* settings_manager = ResourceManager::get()->GetSettingsManager();
    json ui_settings = settings_manager->GetSettings("UserInterface");

    if(!ui_settings.is_null() && ui_settings.contains("run_zone_checks"))
    {
        json run_zone_checks = ui_settings["run_zone_checks"];

        if(!run_zone_checks.is_null() && run_zone_checks.is_boolean())
        {
            bool should_run = run_zone_checks;

            if(!should_run)
            {
                LOG_DEBUG("[OpenRGBZoneInitializationDialog] Skipping zones sizes checks.");
                return;
            }
        }
    }

    LOG_DEBUG("[OpenRGBZoneInitializationDialog] Running zones sizes checks...");

    /*-----------------------------------------------------*\
    | Collect the unconfigured zones                        |
    \*-----------------------------------------------------*/
    std::vector<RGBController*>& controllers = ResourceManager::get()->GetRGBControllers();

    std::vector<std::tuple<RGBController*, unsigned int>> unconfigured_zones;

    for(RGBController* controller: controllers)
    {
        for(unsigned int zone_index = 0; zone_index < controller->GetZoneCount(); zone_index++)
        {
            /*---------------------------------------------*\
            | Consider unconfigured if zone has manually    |
            | configurable size but has not been manually   |
            | configured                                    |
            \*---------------------------------------------*/
            if((controller->GetZoneFlags(zone_index) & (ZONE_FLAG_MANUALLY_CONFIGURABLE_SIZE | ZONE_FLAG_MANUALLY_CONFIGURABLE_SIZE_EFFECTS_ONLY))
            && !(controller->GetZoneFlags(zone_index) & ZONE_FLAG_MANUALLY_CONFIGURED_SIZE))
            {
                unconfigured_zones.push_back({controller, zone_index});
            }
        }
    }

    LOG_DEBUG("[OpenRGBZoneInitializationDialog] Zones checks finished: %d unconfigured zone(s).", unconfigured_zones.size());

    /*-----------------------------------------------------*\
    | Show the configuration tool GUI if we have some       |
    | unconfigured zones                                    |
    \*-----------------------------------------------------*/
    if(!unconfigured_zones.empty())
    {
        QDialog* dialog = new QDialog(parent);
        dialog->setWindowTitle(tr("Zone Initialization"));

        dialog->setMinimumSize(600,480);
        dialog->setModal(true);

        QVBoxLayout* dialog_layout = new QVBoxLayout(dialog);

        OpenRGBZoneInitializationDialog* widget = new OpenRGBZoneInitializationDialog(dialog, unconfigured_zones);

        dialog_layout->addWidget(widget);

        connect(widget, &OpenRGBZoneInitializationDialog::CloseRequest, [=](){
            dialog->reject();
        });

        dialog->exec();
    }
}

OpenRGBZoneInitializationDialog::OpenRGBZoneInitializationDialog(QWidget *parent,  const std::vector<std::tuple<RGBController*, unsigned int>>& unconfigured_zones) :
    QWidget(parent),
    ui(new Ui::OpenRGBZoneInitializationDialog),
    unconfigured_zones(unconfigured_zones)
{
    ui->setupUi(this);

    /*---------------------------------------------------------*\
    | Set the table view settings (headers, resize behavior...) |
    \*---------------------------------------------------------*/
    ui->zones_table->setColumnCount(3);
    ui->zones_table->verticalHeader()->setVisible(false);
    ui->zones_table->setSelectionMode(QAbstractItemView::SelectionMode::NoSelection);
    ui->zones_table->setSelectionBehavior(QAbstractItemView::SelectionBehavior::SelectRows);

    ui->zones_table->horizontalHeader()->setSectionResizeMode(0, QHeaderView::Stretch);
    ui->zones_table->horizontalHeader()->setSectionResizeMode(1, QHeaderView::Stretch);
    ui->zones_table->horizontalHeader()->setSectionResizeMode(2, QHeaderView::Fixed);

    ui->zones_table->setHorizontalHeaderLabels({tr("Controller"), tr("Zone"), tr("Size")});

    /*---------------------------------------------------------*\
    | Fill the table with widgets (labels, spinbox)             |
    \*---------------------------------------------------------*/
    for(const std::tuple<RGBController*, unsigned int>& tuple: unconfigured_zones)
    {
        CreateZoneWidget(std::get<0>(tuple), std::get<1>(tuple));
    }
}

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

void OpenRGBZoneInitializationDialog::changeEvent(QEvent *event)
{
    if(event->type() == QEvent::LanguageChange)
    {
        ui->retranslateUi(this);
    }
}

void OpenRGBZoneInitializationDialog::CreateZoneWidget(RGBController* controller, unsigned int zone_index)
{
    /*---------------------------------------------------------*\
    | Labels: controller name + zone name                       |
    \*---------------------------------------------------------*/
    QLabel* controller_label = new QLabel(this);
    controller_label->setText(QString::fromStdString(controller->GetName()));

    QLabel* zone_label = new QLabel(this);
    zone_label->setText(QString::fromStdString(controller->GetZoneName(zone_index)));

    /*---------------------------------------------------------*\
    | Spin box: controls the zone size                          |
    \*---------------------------------------------------------*/
    QSpinBox* spin_box = new QSpinBox(this);
    spin_box->setValue(0);
    spin_box->setMinimum(controller->GetZoneLEDsMin(zone_index));
    spin_box->setMaximum(controller->GetZoneLEDsMax(zone_index));

    /*---------------------------------------------------------*\
    | Insert labels + spinbox                                   |
    \*---------------------------------------------------------*/
    int row = ui->zones_table->rowCount();

    ui->zones_table->insertRow(row);
    ui->zones_table->setCellWidget(row, 0, controller_label);
    ui->zones_table->setCellWidget(row, 1, zone_label);
    ui->zones_table->setCellWidget(row, 2, spin_box);
}

void OpenRGBZoneInitializationDialog::on_save_button_clicked()
{
    /*---------------------------------------------------------*\
    | Resize what needs to be resized                           |
    \*---------------------------------------------------------*/
    for(unsigned int i = 0; i < unconfigured_zones.size(); i++)
    {
        unsigned int new_size = ((QSpinBox*)ui->zones_table->cellWidget(i,2))->value();

        RGBController* controller = std::get<0>(unconfigured_zones[i]);
        unsigned int zone_index = std::get<1>(unconfigured_zones[i]);

        controller->ResizeZone(zone_index, new_size);
    }

    /*---------------------------------------------------------*\
    | Save the configuration                                    |
    \*---------------------------------------------------------*/
    ProfileManager* profile_manager = ResourceManager::get()->GetProfileManager();

    if(profile_manager != NULL)
    {
        profile_manager->SaveConfiguration();
    }

    /*---------------------------------------------------------*\
    | Save the "Do not show again" checkbox state, then close   |
    \*---------------------------------------------------------*/
    SaveDoNotRunState();

    emit CloseRequest();
}

void OpenRGBZoneInitializationDialog::on_ignore_button_clicked()
{
    /*---------------------------------------------------------*\
    | Save the "Do not show again" checkbox state, then close   |
    \*---------------------------------------------------------*/
    SaveDoNotRunState();

    emit CloseRequest();
}

void OpenRGBZoneInitializationDialog::SaveDoNotRunState()
{
    /*---------------------------------------------------------*\
    | Save the "Do not show again" checkbox state in            |
    | settings manager                                          |
    \*---------------------------------------------------------*/
    SettingsManager* settings_manager = ResourceManager::get()->GetSettingsManager();
    json ui_settings = settings_manager->GetSettings("UserInterface");

    bool state = ui->do_not_show_again_checkbox->checkState() == Qt::Checked;

    ui_settings["run_zone_checks"] = !state;

    settings_manager->SetSettings("UserInterface", ui_settings);
    settings_manager->SaveSettings();
}