btconfig.h

Go to the documentation of this file.

/*********
*
* In the name of the Father, and of the Son, and of the Holy Spirit.
*
* This file is part of BibleTime's source code, https://bibletime.info/
*
* Copyright 1999-2021 by the BibleTime developers.
* The BibleTime source code is licensed under the GNU General Public License
* version 2.0.
*
**********/
 
#pragma once
 
#include "btconfigcore.h"
 
#include <QCoreApplication>
#include <QFont>
#include <QHash>
#include <QList>
#include <QMap>
#include <QMetaType>
#include <QPair>
#include <QString>
#include <QStringList>
#include "../../util/btassert.h"
#include "../btglobal.h"
 
 
class CSwordModuleInfo;
class Language;
class QKeySequence;
namespace sword { class ListKey; }
 
class BtConfig: public BtConfigCore {
 
    Q_DECLARE_TR_FUNCTIONS(BtConfig)
 
    friend class BibleTimeApp;
 
public: // types:
 
    /*!
    * The first parameter indicates whether the custom font should be used or not.
    * The second parameter is the custom font that has been set.
    */
    using FontSettingsPair = QPair<bool, QFont>;
    using StringMap = QMap<QString, QString>;
    using ShortcutsMap = QHash<QString, QList<QKeySequence> >;
 
private: // types:
 
    enum InitState {
        INIT_NEED_UNIMPLEMENTED_BACKWARD_MIGRATE = -2,
        INIT_OK = 0,
        INIT_NEED_UNIMPLEMENTED_FORWARD_MIGRATE = 2,
    };
 
public: // methods:
 
    static BtConfig & getInstance();
 
    /**
      \returns the key of the current session.
    */
    QString const & currentSessionKey() const { return m_currentSessionKey; }
 
    /**
      \returns the name of the current session.
    */
    QString currentSessionName() const {
        auto it(m_sessionNames.constFind(m_currentSessionKey));
        BT_ASSERT(it != m_sessionNames.constEnd());
        return it.value();
    }
 
    /** \returns a hashmap with the keys and printable names of the sessions. */
    QHash<QString, QString> sessionNames() const { return m_sessionNames; }
 
    /**
      \brief Notifies the configuration system that the session settings
             should be read from and saved to the given session.
 
      \pre The session with the given key must exist.
      \param[in] key the key of the session to switch to.
      \post the sessionValue() and value() methods will work with the settings
            of the given session.
    */
    void setCurrentSession(const QString & key);
 
    /**
      \brief Creates a new session with the given name.
 
      \pre The given name must not be an empty string.
      \param[in] name the name of the session
      \returns the key of the created session.
    */
    QString addSession(const QString & name);
 
    /**
      \brief Deletes the session with the given key.
 
      \pre The session with the given key must exist.
      \pre The session with the given key must not be the current session.
      \param[in] key the key of the session to delete.
      \post The session with the given key and its settings are deleted.
      \returns whether deleting the session was successful.
    */
    void deleteSession(const QString & key);
 
    BtConfigCore session() const;
 
    /*!
     * \brief Function to set a module decryption key.
     *
     * This helper function will set a module decryption key
     * in the configuration. Any previous key will be overwritten.
     *
     * \param[in] name Name of module to set the key for
     * \param[in] key Decryption key to set as string
     */
    void setModuleEncryptionKey(const QString & name, const QString & key);
 
    /*!
     * \brief Function to get a module decryption key.
     *
     * This helper function will retrieve a previously set
     * module decryption key from the configuration. If the key
     * is not set it will return a null string.
     *
     * \param[in] name Name of module to retrieve the key for
     * \returns Decryption key as a string
     */
    QString getModuleEncryptionKey(const QString & name);
 
    /*!
     * \brief Gets the shortcuts for the given group.
     *
     * Returns a hash of shortcuts for strings for the respective
     * shortcut group.
     * \param[in] shortcutGroup The group to retrieve shortcuts for.
     * \returns Hash of strings and lists of shortcuts.
     */
    ShortcutsMap getShortcuts(QString const & shortcutGroup);
 
    /*!
     * \brief Sets the shortcuts for the given group.
     *
     * Writes a hash of shortcuts for strings for the respective
     * shortcut group.
     * \param[in] shortcutGroup The group to retrieve shortcuts for.
     * \param[in] Hash of strings and lists of shortcuts to write.
     */
    void setShortcuts(QString const & shortcutGroup,
                      ShortcutsMap const & shortcuts);
 
    /** \returns FilterOptions structure containing filter settings. */
    static FilterOptions loadFilterOptionsFromGroup(BtConfigCore const & group);
 
    FilterOptions getFilterOptions() const {
        auto const group = const_cast<BtConfig *>(this)->session();
        return loadFilterOptionsFromGroup(group);
    }
 
    /**
       \brief Saves the current filter options.
       \param[in] options The filter options to save.
    */
    static void storeFilterOptionsToGroup(FilterOptions const & options,
                                          BtConfigCore & group);
 
    /** \returns DisplayOptions structure containing display settings. */
    static DisplayOptions loadDisplayOptionsFromGroup(
            BtConfigCore const & group);
 
    DisplayOptions getDisplayOptions() const {
        auto const group = const_cast<BtConfig *>(this)->session();
        return loadDisplayOptionsFromGroup(group);
    }
 
    /**
       \brief Saves the current display options.
       \param[in] options The display options to save.
    */
    static void storeDisplayOptionsToGroup(DisplayOptions const & options,
                                           BtConfigCore & group);
 
    /*!
     * Returns a default font that is suitable for the current language.
     * \returns QFont suitable for current language.
     */
    QFont const & getDefaultFont() const { return m_defaultFont; }
 
    /// \todo: put FontSettingsPair in QVariant directly
    /*!
     * \brief Set font for a language.
     *
     * Sets a FontSettingsPair for the language given.
     * \param[in] language pointer to a language to set the font for
     * \param[in] fontSettings FontSettingsPair to set
     */
    void setFontForLanguage(Language const & language,
                            FontSettingsPair const & fontSettings);
 
    /*!
     * \brief Get font for a language.
     *
     * Gets a FontSettingsPair for the language given. If no font has been saved
     * a default font is returned.
     * \param[in] language pointer to a language to get the font for.
     * \returns FontSettingsPair for given language
     */
    FontSettingsPair getFontForLanguage(Language const & language);
 
    /// \todo: unit test these functions
    /*!
     * Returns the searchScopes for the current locale.
     *
     * This function retrieves the search scopes of the
     * "properties/searchScopes" property and converts them
     * to the current locale.
     *
     * \returns Search scopes in current locale.
     */
    StringMap getSearchScopesForCurrentLocale(const QStringList& scopeModules);
 
    /*!
     * Sets the searchScopes given in the current locale.
     *
     * This function sets the search scopes of the
     * "properties/searchScopes" property, the scopes are
     * converted to the english locale before saving them.
     *
     * \param[in] searchScopes Search scopes in any locale.
     */
    void setSearchScopesWithCurrentLocale(const QStringList& scopeModules, StringMap searchScopes);
 
    /** \returns the configured language code for book names. */
    QString booknameLanguage();
 
    /*
     * Ensure that the verse range is valid for at least one of the scopeModules
     */
    static sword::ListKey parseVerseListWithModules(const QString& data, const QStringList& scopeModules);
 
    /*!
      * Deletes the searchScopes given in the current locale.
      */
    void deleteSearchScopesWithCurrentLocale();
 
    /*!
     * \brief Returns default sword module info class for a given module type.
     *
     * This is basically a convenience function for getting the respective
     * "settings/defaults/ *" variable and searching that module manually.
     * If module is not installed 0 will be returned.
     * \param[in] moduleType module type to return the default sword module info for
     * \returns sword module info pointer or 0
     */
    CSwordModuleInfo * getDefaultSwordModuleByType(const QString & moduleType);
 
    /*!
     * \brief Sets the default sword module for a module type.
     *
     * This is basically a convenience function for setting the "settings/defaults/ *"
     * variables to the module->name() string manually.
     * 0 is allowed as the module, then the default module will be unset.
     * \param[in] moduleType module type to set
     * \param[in] module the sword module info to set as default module
     */
    void setDefaultSwordModuleByType(const QString & moduleType,
                                     const CSwordModuleInfo * const module);
 
private: // methods:
 
    explicit BtConfig(const QString & settingsFile);
 
    static InitState initBtConfig();
    static void forceMigrate();
 
    static void destroyInstance();
 
private: // fields:
 
    static BtConfig * m_instance; //!< singleton instance
 
    QFont m_defaultFont; //!< default font used when no special one is set
    QHash<Language const *, FontSettingsPair> m_fontCache; //!< a cache for the fonts saved in the configuration file for speed
 
    static StringMap m_defaultSearchScopes;
 
    QHash<QString, QString> m_sessionNames;
    QString m_currentSessionKey;
 
}; /* class BtConfig */
 
// declare types used in configuration as metatype so they can be saved directly into the configuration
Q_DECLARE_METATYPE(BtConfig::StringMap)
Q_DECLARE_METATYPE(QList<int>)
 
/*!
 * \brief This is a shortchand for BtConfig::getInstance().
 * \returns BtConfig singleton instance.
 */
inline BtConfig & btConfig() {
    return BtConfig::getInstance();
}