settings.h

/*
    Drumstick MIDI File Player Multiplatform Program
    Copyright (C) 2006-2024, Pedro Lopez-Cabanillas <plcl@users.sf.net>

    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 3 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, see <http://www.gnu.org/licenses/>.
*/

#ifndef PORTABLESETTINGS_H
#define PORTABLESETTINGS_H

#include <QObject>
#include <QSettings>
#include <QString>
#include <QTranslator>
#include <drumstick/backendmanager.h>
#include <drumstick/pianokeybd.h>
#include <drumstick/pianopalette.h>

using namespace drumstick::widgets;

class Settings : public QObject
{
    Q_OBJECT

public:
    QByteArray mainWindowGeometry() const;
    void setMainWindowGeometry(const QByteArray &geometry);

    QByteArray mainWindowState() const;
    void setMainWindowState(const QByteArray &state);

    QString lastDirectory() const;
    void setLastDirectory(const QString &lastDirectory);

    QString lastOutputBackend() const;
    void setLastOutputBackend(const QString &lastOutputBackend);

    QString lastOutputConnection() const;
    void setLastOutputConnection(const QString &lastOutputConnection);

    bool advanced() const;
    void setAdvanced(bool advanced);

    QVariantMap settingsMap() const;

    QString language() const;
    void setLanguage(const QString &language);

    QString lastPlayList() const;
    void setLastPlayList(const QString &lastPlayList);

    int drumsChannel() const;
    void setDrumsChannel(int drumsChannel);

    bool velocityColor() const;
    void setVelocityColor(bool velocityColor);

    bool winSnap() const;
    void setWinSnap(bool winSnap);

    int highlightPaletteId() const;
    void setHighlightPaletteId(int paletteId);

    bool showStatusBar() const;
    void setShowStatusBar(bool showStatusBar);

    bool showToolBar() const;
    void setShowToolBar(bool showToolBar);

    int availablePalettes() const;
    PianoPalette getPalette(int pal);
    QList<QString> availablePaletteNames(bool forHighlight);
    void retranslatePalettes();

    LabelVisibility namesVisibility() const;
    void setNamesVisibility(const LabelVisibility namesVisibility);

    QFont notesFont() const;
    void setNotesFont(const QFont &namesFont);

    bool getDarkMode() const;
    void setDarkMode(bool darkMode);

    QFont lyricsFont() const;
    void setLyricsFont(const QFont &lyricsFont);

    QColor getFutureColor() const;
    void setFutureColor(const QColor &futureColor);

    QColor getPastColor() const;
    void setPastColor(const QColor &pastColor);

    QColor getSingleColor() const;
    void setSingleColor(const QColor &singleColor);

    bool getAutoPlay() const;
    void setAutoPlay(bool autoPlay);

    bool autoAdvance() const;
    void setAutoAdvance(bool autoAdvance);

    bool useInternalIcons() const;
    void setInternalIcons(bool internalIcons);

    QString getStyle() const;
    void setStyle(const QString &style);

    int getSysexResetMessage() const;
    void setSysexResetMessage(const int sysexResetMessage);

    const QStringList &toolbarActions() const;
    void setToolbarActions(const QStringList &newToolbarActions);

    int toolbarButtonStyle() const;
    void setToolbarButtonStyle(int newToolbarButtonStyle);

    // static methods
    inline static const QString QSTR_DOMAIN = QStringLiteral("drumstick.sourceforge.net");
    inline static const QString QSTR_APPNAME = QStringLiteral(
        "Drumstick Multiplatform MIDI File Player");

    static Settings *instance();
    static void setPortableConfig(const QString fileName = QString());
    static QString dataDirectory();
    static QString localeDirectory();
    static QString drumstickLocales();
    static QString systemLocales();

    const QByteArray &channelsWindowGeometry() const;
    void setChannelsWindowGeometry(const QByteArray &newChannelsWindowGeometry);

    const QByteArray &channelsWindowState() const;
    void setChannelsWindowState(const QByteArray &newChannelsWindowState);

    const QByteArray &helpWindowGeometry() const;
    void setHelpWindowGeometry(const QByteArray &newHelpWindowGeometry);

    const QByteArray &helpWindowState() const;
    void setHelpWindowState(const QByteArray &newHelpWindowState);

    const QByteArray &lyricsWindowGeometry() const;
    void setLyricsWindowGeometry(const QByteArray &newLyricsWindowGeometry);

    const QByteArray &lyricsWindowState() const;
    void setLyricsWindowState(const QByteArray &newLyricsWindowState);

    const QByteArray &pianoWindowGeometry() const;
    void setPianoWindowGeometry(const QByteArray &newPianoWindowGeometry);

    const QByteArray &pianoWindowState() const;
    void setPianoWindowState(const QByteArray &newPianoWindowState);

    int helpWindowFontSize() const;
    void setHelpWindowFontSize(int newHelpWindowFontSize);

    void loadTranslations();

    int soloVolumeReduction() const;
    void setSoloVolumeReduction(int newSoloVolumeReduction);

    bool autoSongSettings() const;
    void setAutoSongSettings(bool newAutoSongSettings);

    bool octaveSubscript() const;
    void setOctaveSubscript(bool newOctaveSubscript);

    bool snappedTogether() const;
    void setSnappedTogether(bool newSnappedTogether);

    QColor highlightColor() const;
    void setHighlightColor(const QColor &newHighlightColor);

signals:
    void ValuesChanged();

public slots:
    void ResetDefaults();
    void ReadSettings();
    void ReadFromFile(const QString &filepath);
    void SaveSettings();
    void SaveToFile(const QString &filepath);

private:
    explicit Settings(QObject *parent = nullptr);
    void internalRead(QSettings &settings);
    void internalSave(QSettings &settings);
    void forceSettings(QSettings &settings);

    QByteArray m_mainWindowGeometry;
    QByteArray m_mainWindowState;
    QByteArray m_channelsWindowGeometry;
    QByteArray m_channelsWindowState;
    QByteArray m_helpWindowGeometry;
    QByteArray m_helpWindowState;
    QByteArray m_lyricsWindowGeometry;
    QByteArray m_lyricsWindowState;
    QByteArray m_pianoWindowGeometry;
    QByteArray m_pianoWindowState;
    QString m_lastDirectory;
    QString m_lastOutputBackend;
    QString m_lastOutputConnection;
    QString m_lastPlayList;
    QString m_style;

    bool m_advanced;
    int m_highlightPaletteId;
    bool m_velocityColor;
    bool m_showStatusBar;
    bool m_showToolBar;
    bool m_winSnap;
    bool m_snappedTogether;
    bool m_darkMode;
    int m_drumsChannel;
    bool m_autoPlay;
    bool m_autoAdvance;
    bool m_internalIcons;
    int m_sysexResetMessage;
    int m_helpWindowFontSize;
    int m_soloVolumeReduction;
    bool m_autoSongSettings;
    bool m_octaveSubscript;
    LabelVisibility m_namesVisibility;
    QFont m_notesFont;
    QFont m_lyricsFont;
    QColor m_futureColor;
    QColor m_pastColor;
    QColor m_singleColor;
    QColor m_highlightColor;
    QString m_language;
    QVariantMap m_settingsMap;
    QVariantMap m_defaultsMap;

    QList<PianoPalette> m_paletteList {
        PianoPalette(PAL_SINGLE),
        PianoPalette(PAL_DOUBLE),
        PianoPalette(PAL_CHANNELS),
        PianoPalette(PAL_SCALE),
        PianoPalette(PAL_KEYS),
        PianoPalette(PAL_FONT),
        PianoPalette(PAL_HISCALE)
    };

    QStringList m_toolbarActions;
    int m_toolbarButtonStyle;
    QPointer<QTranslator> m_trq, m_trp, m_trl;
};

#endif // PORTABLESETTINGS_H