trunk/src/qsamplerOptionsForm.cpp

// qsamplerOptionsForm.cpp
//
/****************************************************************************
   Copyright (C) 2004-2020, rncbc aka Rui Nuno Capela. All rights reserved.
   Copyright (C) 2007, Christian Schoenebeck

   This program 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 2
   of the License, or (at your option) any later version.

   This program 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 this program; if not, write to the Free Software Foundation, Inc.,
   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

*****************************************************************************/

#include "qsamplerOptionsForm.h"

#include "qsamplerAbout.h"
#include "qsamplerOptions.h"

#include "qsamplerPaletteForm.h"

#include <QMessageBox>
#include <QFontDialog>
#include <QFileDialog>

#include <QStyleFactory>


// Default (empty/blank) name.
static const char *g_pszDefName = QT_TRANSLATE_NOOP("qsamplerOptionsForm", "(default)");


namespace QSampler {

//-------------------------------------------------------------------------
// QSampler::OptionsForm -- Options form implementation.
//

OptionsForm::OptionsForm ( QWidget* pParent )
        : QDialog(pParent)
{
        m_ui.setupUi(this);

        // No settings descriptor initially (the caller will set it).
        m_pOptions = nullptr;

        // Initialize dirty control state.
        m_iDirtySetup = 0;
        m_iDirtyCount = 0;

        // Set dialog validators...
        m_ui.ServerPortComboBox->setValidator(
                new QIntValidator(m_ui.ServerPortComboBox));

        // Try to restore old window positioning.
        adjustSize();

        QObject::connect(m_ui.ServerHostComboBox,
                SIGNAL(editTextChanged(const QString&)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.ServerPortComboBox,
                SIGNAL(editTextChanged(const QString&)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.ServerTimeoutSpinBox,
                SIGNAL(valueChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.ServerStartCheckBox,
                SIGNAL(stateChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.ServerCmdLineComboBox,
                SIGNAL(editTextChanged(const QString&)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.StartDelaySpinBox,
                SIGNAL(valueChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.MessagesLogCheckBox,
                SIGNAL(stateChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.MessagesLogPathComboBox,
                SIGNAL(editTextChanged(const QString&)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.MessagesLogPathToolButton,
                SIGNAL(clicked()),
                SLOT(browseMessagesLogPath()));
        QObject::connect(m_ui.DisplayFontPushButton,
                SIGNAL(clicked()),
                SLOT(chooseDisplayFont()));
        QObject::connect(m_ui.DisplayEffectCheckBox,
                SIGNAL(toggled(bool)),
                SLOT(toggleDisplayEffect(bool)));
        QObject::connect(m_ui.AutoRefreshCheckBox,
                SIGNAL(stateChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.AutoRefreshTimeSpinBox,
                SIGNAL(valueChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.MaxVolumeSpinBox,
                SIGNAL(valueChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.MessagesFontPushButton,
                SIGNAL(clicked()),
                SLOT(chooseMessagesFont()));
        QObject::connect(m_ui.MessagesLimitCheckBox,
                SIGNAL(stateChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.MessagesLimitLinesSpinBox,
                SIGNAL(valueChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.ConfirmRemoveCheckBox,
                SIGNAL(stateChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.ConfirmResetCheckBox,
                SIGNAL(stateChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.ConfirmRestartCheckBox,
                SIGNAL(stateChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.ConfirmErrorCheckBox,
                SIGNAL(stateChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.KeepOnTopCheckBox,
                SIGNAL(stateChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.StdoutCaptureCheckBox,
                SIGNAL(stateChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.MaxRecentFilesSpinBox,
                SIGNAL(valueChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.CompletePathCheckBox,
                SIGNAL(stateChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.InstrumentNamesCheckBox,
                SIGNAL(stateChanged(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.CustomColorThemeComboBox,
                SIGNAL(activated(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.CustomColorThemeToolButton,
                SIGNAL(clicked()),
                SLOT(editCustomColorThemes()));
        QObject::connect(m_ui.CustomStyleThemeComboBox,
                SIGNAL(activated(int)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.BaseFontSizeComboBox,
                SIGNAL(editTextChanged(const QString&)),
                SLOT(optionsChanged()));
        QObject::connect(m_ui.MaxVoicesSpinBox,
                SIGNAL(valueChanged(int)),
                SLOT(maxVoicesChanged(int)));
        QObject::connect(m_ui.MaxStreamsSpinBox,
                SIGNAL(valueChanged(int)),
                SLOT(maxStreamsChanged(int)));
        QObject::connect(m_ui.DialogButtonBox,
                SIGNAL(accepted()),
                SLOT(accept()));
        QObject::connect(m_ui.DialogButtonBox,
                SIGNAL(rejected()),
                SLOT(reject()));
}

OptionsForm::~OptionsForm()
{
}

// Populate (setup) dialog controls from settings descriptors.
void OptionsForm::setup ( Options *pOptions )
{
        // Set reference descriptor.
        m_pOptions = pOptions;

        // Start clean.
        m_iDirtyCount = 0;
        // Avoid nested changes.
        m_iDirtySetup++;

        // Load combo box history...
        m_pOptions->loadComboBoxHistory(m_ui.ServerHostComboBox);
        m_pOptions->loadComboBoxHistory(m_ui.ServerPortComboBox);
        m_pOptions->loadComboBoxHistory(m_ui.ServerCmdLineComboBox);
        m_pOptions->loadComboBoxHistory(m_ui.MessagesLogPathComboBox);

        // Load Server settings...
        m_ui.ServerHostComboBox->setEditText(m_pOptions->sServerHost);
        m_ui.ServerPortComboBox->setEditText(QString::number(m_pOptions->iServerPort));
        m_ui.ServerTimeoutSpinBox->setValue(m_pOptions->iServerTimeout);
        m_ui.ServerStartCheckBox->setChecked(m_pOptions->bServerStart);
        m_ui.ServerCmdLineComboBox->setEditText(m_pOptions->sServerCmdLine);
        m_ui.StartDelaySpinBox->setValue(m_pOptions->iStartDelay);

        // Logging options...
        m_ui.MessagesLogCheckBox->setChecked(m_pOptions->bMessagesLog);
        m_ui.MessagesLogPathComboBox->setEditText(m_pOptions->sMessagesLogPath);

        // Load Display options...
        QFont font;
        QPalette pal;

        // Display font.
        if (m_pOptions->sDisplayFont.isEmpty()
                || !font.fromString(m_pOptions->sDisplayFont))
                font = QFont("Sans Serif", 8);
        m_ui.DisplayFontTextLabel->setFont(font);
        m_ui.DisplayFontTextLabel->setText(font.family()
                + ' ' + QString::number(font.pointSize()));

        // Display effect.
        m_ui.DisplayEffectCheckBox->setChecked(m_pOptions->bDisplayEffect);
        toggleDisplayEffect(m_pOptions->bDisplayEffect);

        // Auto-refresh and maximum volume options.
        m_ui.AutoRefreshCheckBox->setChecked(m_pOptions->bAutoRefresh);
        m_ui.AutoRefreshTimeSpinBox->setValue(m_pOptions->iAutoRefreshTime);
        m_ui.MaxVolumeSpinBox->setValue(m_pOptions->iMaxVolume);

        // Messages font.
        if (m_pOptions->sMessagesFont.isEmpty()
                || !font.fromString(m_pOptions->sMessagesFont))
                font = QFont("Monospace", 8);
        pal = m_ui.MessagesFontTextLabel->palette();
        pal.setColor(QPalette::Background, pal.base().color());
        m_ui.MessagesFontTextLabel->setPalette(pal);
        m_ui.MessagesFontTextLabel->setFont(font);
        m_ui.MessagesFontTextLabel->setText(font.family()
                + ' ' + QString::number(font.pointSize()));

        // Messages limit option.
        m_ui.MessagesLimitCheckBox->setChecked(m_pOptions->bMessagesLimit);
        m_ui.MessagesLimitLinesSpinBox->setValue(m_pOptions->iMessagesLimitLines);

        // Other options finally.
        m_ui.ConfirmRemoveCheckBox->setChecked(m_pOptions->bConfirmRemove);
        m_ui.ConfirmRestartCheckBox->setChecked(m_pOptions->bConfirmRestart);
        m_ui.ConfirmResetCheckBox->setChecked(m_pOptions->bConfirmReset);
        m_ui.ConfirmErrorCheckBox->setChecked(m_pOptions->bConfirmError);
        m_ui.KeepOnTopCheckBox->setChecked(m_pOptions->bKeepOnTop);
        m_ui.StdoutCaptureCheckBox->setChecked(m_pOptions->bStdoutCapture);
        m_ui.CompletePathCheckBox->setChecked(m_pOptions->bCompletePath);
        m_ui.InstrumentNamesCheckBox->setChecked(m_pOptions->bInstrumentNames);
        m_ui.MaxRecentFilesSpinBox->setValue(m_pOptions->iMaxRecentFiles);
        if (m_pOptions->iBaseFontSize > 0)
                m_ui.BaseFontSizeComboBox->setEditText(QString::number(m_pOptions->iBaseFontSize));
        else
                m_ui.BaseFontSizeComboBox->setCurrentIndex(0);

#ifndef CONFIG_LIBGIG
        m_ui.InstrumentNamesCheckBox->setEnabled(false);
#endif

        bMaxVoicesModified = bMaxStreamsModified = false;
#ifdef CONFIG_MAX_VOICES
        const bool bMaxVoicesSupported =
                m_pOptions->getEffectiveMaxVoices() >= 0;
        const bool bMaxStreamsSupported =
                m_pOptions->getEffectiveMaxStreams() >= 0;

        m_ui.MaxVoicesSpinBox->setEnabled(bMaxVoicesSupported);
        m_ui.MaxVoicesSpinBox->setValue(m_pOptions->getMaxVoices());
        if (!bMaxVoicesSupported)
                m_ui.MaxVoicesSpinBox->setToolTip(
                        tr("This parameter is not supported by the current sampler "
                           "version in use.")
                );
        else
                m_ui.MaxVoicesSpinBox->setToolTip(
                        tr("The max. amount of voices the sampler shall process "
                           "simultaneously.")
                );

        m_ui.MaxStreamsSpinBox->setEnabled(bMaxStreamsSupported);
        m_ui.MaxStreamsSpinBox->setValue(m_pOptions->getMaxStreams());
        if (!bMaxStreamsSupported)
                m_ui.MaxStreamsSpinBox->setToolTip(
                        tr("This parameter is not supported by the current sampler "
                           "version in use.")
                );
        else
                m_ui.MaxStreamsSpinBox->setToolTip(
                        tr("The max. amount of disk streams the sampler shall process "
                           "simultaneously.")
                );
#else
        m_ui.MaxVoicesSpinBox->setEnabled(false);
        m_ui.MaxStreamsSpinBox->setEnabled(false);
        m_ui.MaxVoicesSpinBox->setToolTip(
                tr("QSampler was built without support for this parameter.")
        );
        m_ui.MaxStreamsSpinBox->setToolTip(
                tr("QSampler was built without support for this parameter.")
        );
#endif // CONFIG_MAX_VOICES

        // Custom display options...
        resetCustomColorThemes(m_pOptions->sCustomColorTheme);
        resetCustomStyleThemes(m_pOptions->sCustomStyleTheme);

        // Done.
        m_iDirtySetup--;
        stabilizeForm();
}


// Accept settings (OK button slot).
void OptionsForm::accept (void)
{
        // Save options...
        if (m_iDirtyCount > 0) {
                // Server settings....
                m_pOptions->sServerHost    = m_ui.ServerHostComboBox->currentText().trimmed();
                m_pOptions->iServerPort    = m_ui.ServerPortComboBox->currentText().toInt();
                m_pOptions->iServerTimeout = m_ui.ServerTimeoutSpinBox->value();
                m_pOptions->bServerStart   = m_ui.ServerStartCheckBox->isChecked();
                m_pOptions->sServerCmdLine = m_ui.ServerCmdLineComboBox->currentText().trimmed();
                m_pOptions->iStartDelay    = m_ui.StartDelaySpinBox->value();
                // Logging options...
                m_pOptions->bMessagesLog   = m_ui.MessagesLogCheckBox->isChecked();
                m_pOptions->sMessagesLogPath = m_ui.MessagesLogPathComboBox->currentText();
                // Channels options...
                m_pOptions->sDisplayFont   = m_ui.DisplayFontTextLabel->font().toString();
                m_pOptions->bDisplayEffect = m_ui.DisplayEffectCheckBox->isChecked();
                m_pOptions->bAutoRefresh   = m_ui.AutoRefreshCheckBox->isChecked();
                m_pOptions->iAutoRefreshTime = m_ui.AutoRefreshTimeSpinBox->value();
                m_pOptions->iMaxVolume     = m_ui.MaxVolumeSpinBox->value();
                // Messages options...
                m_pOptions->sMessagesFont  = m_ui.MessagesFontTextLabel->font().toString();
                m_pOptions->bMessagesLimit = m_ui.MessagesLimitCheckBox->isChecked();
                m_pOptions->iMessagesLimitLines = m_ui.MessagesLimitLinesSpinBox->value();
                // Other options...
                m_pOptions->bConfirmRemove = m_ui.ConfirmRemoveCheckBox->isChecked();
                m_pOptions->bConfirmRestart = m_ui.ConfirmRestartCheckBox->isChecked();
                m_pOptions->bConfirmReset  = m_ui.ConfirmResetCheckBox->isChecked();
                m_pOptions->bConfirmError  = m_ui.ConfirmErrorCheckBox->isChecked();
                m_pOptions->bKeepOnTop     = m_ui.KeepOnTopCheckBox->isChecked();
                m_pOptions->bStdoutCapture = m_ui.StdoutCaptureCheckBox->isChecked();
                m_pOptions->bCompletePath  = m_ui.CompletePathCheckBox->isChecked();
                m_pOptions->bInstrumentNames = m_ui.InstrumentNamesCheckBox->isChecked();
                m_pOptions->iMaxRecentFiles  = m_ui.MaxRecentFilesSpinBox->value();
                m_pOptions->iBaseFontSize  = m_ui.BaseFontSizeComboBox->currentText().toInt();
                // Custom color/style theme options...
                if (m_ui.CustomStyleThemeComboBox->currentIndex() > 0)
                        m_pOptions->sCustomStyleTheme = m_ui.CustomStyleThemeComboBox->currentText();
                else
                        m_pOptions->sCustomStyleTheme.clear();
                if (m_ui.CustomColorThemeComboBox->currentIndex() > 0)
                        m_pOptions->sCustomColorTheme = m_ui.CustomColorThemeComboBox->currentText();
                else
                        m_pOptions->sCustomColorTheme.clear();
                // Reset dirty flag.
                m_iDirtyCount = 0;
        }

        // If the user modified the limits, apply them to the sampler
        // (and store it later in qsampler's configuration)
        if (bMaxVoicesModified && m_ui.MaxVoicesSpinBox->isEnabled())
                m_pOptions->setMaxVoices(m_ui.MaxVoicesSpinBox->value());
        if (bMaxStreamsModified && m_ui.MaxStreamsSpinBox->isEnabled())
                m_pOptions->setMaxStreams(m_ui.MaxStreamsSpinBox->value());

        // Save combobox history...
        m_pOptions->saveComboBoxHistory(m_ui.ServerHostComboBox);
        m_pOptions->saveComboBoxHistory(m_ui.ServerPortComboBox);
        m_pOptions->saveComboBoxHistory(m_ui.ServerCmdLineComboBox);
        m_pOptions->saveComboBoxHistory(m_ui.MessagesLogPathComboBox);

        // Save/commit to disk.
        m_pOptions->saveOptions();

        // Just go with dialog acceptance.
        QDialog::accept();
}


// Reject settings (Cancel button slot).
void OptionsForm::reject (void)
{
        bool bReject = true;

        // Check if there's any pending changes...
        if (m_iDirtyCount > 0) {
                switch (QMessageBox::warning(this,
                        tr("Warning"),
                        tr("Some settings have been changed.\n\n"
                        "Do you want to apply the changes?"),
                        QMessageBox::Apply |
                        QMessageBox::Discard |
                        QMessageBox::Cancel)) {
                case QMessageBox::Apply:
                        accept();
                        return;
                case QMessageBox::Discard:
                        break;
                default:    // Cancel.
                        bReject = false;
                }
        }

        if (bReject)
                QDialog::reject();
}


// Dirty up settings.
void OptionsForm::optionsChanged (void)
{
        if (m_iDirtySetup > 0)
                return;

        m_iDirtyCount++;
        stabilizeForm();
}


// Stabilize current form state.
void OptionsForm::stabilizeForm (void)
{
        bool bValid = (m_iDirtyCount > 0);

        bool bEnabled = m_ui.ServerStartCheckBox->isChecked();
        m_ui.ServerCmdLineTextLabel->setEnabled(bEnabled);
        m_ui.ServerCmdLineComboBox->setEnabled(bEnabled);
        m_ui.StartDelayTextLabel->setEnabled(bEnabled);
        m_ui.StartDelaySpinBox->setEnabled(bEnabled);

        bEnabled = m_ui.MessagesLogCheckBox->isChecked();
        m_ui.MessagesLogPathComboBox->setEnabled(bEnabled);
        m_ui.MessagesLogPathToolButton->setEnabled(bEnabled);
        if (bEnabled && bValid) {
                const QString& sPath = m_ui.MessagesLogPathComboBox->currentText();
                bValid = !sPath.isEmpty();
        }

        m_ui.AutoRefreshTimeSpinBox->setEnabled(
                m_ui.AutoRefreshCheckBox->isChecked());
        m_ui.MessagesLimitLinesSpinBox->setEnabled(
                m_ui.MessagesLimitCheckBox->isChecked());

        m_ui.DialogButtonBox->button(QDialogButtonBox::Ok)->setEnabled(bValid);
}


// Messages log path browse slot.
void OptionsForm::browseMessagesLogPath (void)
{
        QString sFileName = QFileDialog::getSaveFileName(
                this,                                                                                   // Parent.
                tr("Messages Log"),                                             // Caption.
                m_ui.MessagesLogPathComboBox->currentText(),    // Start here.
                tr("Log files") + " (*.log)"                    // Filter (log files)
        );

        if (!sFileName.isEmpty()) {
                m_ui.MessagesLogPathComboBox->setEditText(sFileName);
                m_ui.MessagesLogPathComboBox->setFocus();
                optionsChanged();
        }
}


// The channel display font selection dialog.
void OptionsForm::chooseDisplayFont (void)
{
        bool  bOk  = false;
        QFont font = QFontDialog::getFont(&bOk,
                m_ui.DisplayFontTextLabel->font(), this);
        if (bOk) {
                m_ui.DisplayFontTextLabel->setFont(font);
                m_ui.DisplayFontTextLabel->setText(font.family()
                        + ' ' + QString::number(font.pointSize()));
                optionsChanged();
        }
}


// The messages font selection dialog.
void OptionsForm::chooseMessagesFont (void)
{
        bool  bOk  = false;
        QFont font = QFontDialog::getFont(&bOk,
                m_ui.MessagesFontTextLabel->font(), this);
        if (bOk) {
                m_ui.MessagesFontTextLabel->setFont(font);
                m_ui.MessagesFontTextLabel->setText(font.family()
                        + ' ' + QString::number(font.pointSize()));
                optionsChanged();
        }
}


// The channel display effect demo changer.
void OptionsForm::toggleDisplayEffect ( bool bOn )
{
        QPalette pal;
        pal.setColor(QPalette::Foreground, Qt::green);
        if (bOn) {
                QPixmap pm(":/images/displaybg1.png");
                pal.setBrush(QPalette::Background, QBrush(pm));
        } else {
                pal.setColor(QPalette::Background, Qt::black);
        }
        m_ui.DisplayFontTextLabel->setPalette(pal);

        optionsChanged();
}

void OptionsForm::maxVoicesChanged(int /*iMaxVoices*/)
{
        bMaxVoicesModified = true;
        optionsChanged();
}

void OptionsForm::maxStreamsChanged(int /*iMaxStreams*/)
{
        bMaxStreamsModified = true;
        optionsChanged();
}


// Custom color palette theme manager.
void OptionsForm::editCustomColorThemes (void)
{
        PaletteForm form(this);
        form.setSettings(&m_pOptions->settings());

        QString sCustomColorTheme;
        int iDirtyCustomColorTheme = 0;

        const int iCustomColorTheme
                = m_ui.CustomColorThemeComboBox->currentIndex();
        if (iCustomColorTheme > 0) {
                sCustomColorTheme = m_ui.CustomColorThemeComboBox->itemText(
                        iCustomColorTheme);
                form.setPaletteName(sCustomColorTheme);
        }

        if (form.exec() == QDialog::Accepted) {
                sCustomColorTheme = form.paletteName();
                ++iDirtyCustomColorTheme;
        }

        if (iDirtyCustomColorTheme > 0 || form.isDirty()) {
                resetCustomColorThemes(sCustomColorTheme);
                optionsChanged();
        }
}


// Custom color palette themes settler.
void OptionsForm::resetCustomColorThemes (
        const QString& sCustomColorTheme )
{
        m_ui.CustomColorThemeComboBox->clear();
        m_ui.CustomColorThemeComboBox->addItem(
                tr(g_pszDefName));
        m_ui.CustomColorThemeComboBox->addItems(
                PaletteForm::namedPaletteList(&m_pOptions->settings()));

        int iCustomColorTheme = 0;
        if (!sCustomColorTheme.isEmpty()) {
                iCustomColorTheme = m_ui.CustomColorThemeComboBox->findText(
                        sCustomColorTheme);
                if (iCustomColorTheme < 0)
                        iCustomColorTheme = 0;
        }
        m_ui.CustomColorThemeComboBox->setCurrentIndex(iCustomColorTheme);
}


// Custom widget style themes settler.
void OptionsForm::resetCustomStyleThemes (
        const QString& sCustomStyleTheme )
{
        m_ui.CustomStyleThemeComboBox->clear();
        m_ui.CustomStyleThemeComboBox->addItem(
                tr(g_pszDefName));
        m_ui.CustomStyleThemeComboBox->addItems(QStyleFactory::keys());

        int iCustomStyleTheme = 0;
        if (!sCustomStyleTheme.isEmpty()) {
                iCustomStyleTheme = m_ui.CustomStyleThemeComboBox->findText(
                        sCustomStyleTheme);
                if (iCustomStyleTheme < 0)
                        iCustomStyleTheme = 0;
        }
        m_ui.CustomStyleThemeComboBox->setCurrentIndex(iCustomStyleTheme);
}


} // namespace QSampler

// end of qsamplerOptionsForm.cpp