1de2a4ff14
- In some cases, it makes sense to close Calamares automatically when it is done. Set *quit-at-end* to do so -- although this probably also means you should remove the *finished* page.
129 lines
4.2 KiB
C++
129 lines
4.2 KiB
C++
/* === This file is part of Calamares - <https://github.com/calamares> ===
|
|
*
|
|
* Copyright 2019, Dominic Hayes <ferenosdev@outlook.com>
|
|
* Copyright 2019, Gabriel Craciunescu <crazy@frugalware.org>
|
|
* Copyright 2014-2015, Teo Mrnjavac <teo@kde.org>
|
|
* Copyright 2017-2018, Adriaan de Groot <groot@kde.org>
|
|
*
|
|
* Calamares 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.
|
|
*
|
|
* Calamares 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 Calamares. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef SETTINGS_H
|
|
#define SETTINGS_H
|
|
|
|
#include "DllMacro.h"
|
|
#include "modulesystem/Actions.h"
|
|
|
|
#include <QObject>
|
|
#include <QStringList>
|
|
|
|
|
|
namespace Calamares
|
|
{
|
|
|
|
struct DLLEXPORT InstanceDescription
|
|
{
|
|
InstanceDescription( const QVariantMap& );
|
|
|
|
QString module; ///< Module name (e.g. "welcome")
|
|
QString id; ///< Id, to distinguish multiple instances (e.g. "one", for "welcome@one")
|
|
QString config; ///< Config-file name (for multiple instances)
|
|
int weight;
|
|
};
|
|
|
|
class DLLEXPORT Settings : public QObject
|
|
{
|
|
Q_OBJECT
|
|
explicit Settings( const QString& settingsFilePath, bool debugMode );
|
|
|
|
public:
|
|
static Settings* instance();
|
|
/// @brief Find a settings.conf, following @p debugMode
|
|
static Settings* init( bool debugMode );
|
|
/// @brief Explicif filename, debug is always true (for testing)
|
|
static Settings* init( const QString& filename );
|
|
|
|
QStringList modulesSearchPaths() const;
|
|
|
|
using InstanceDescriptionList = QList< InstanceDescription >;
|
|
InstanceDescriptionList customModuleInstances() const;
|
|
|
|
using ModuleSequence = QList< QPair< ModuleSystem::Action, QStringList > >;
|
|
ModuleSequence modulesSequence() const;
|
|
|
|
QString brandingComponentName() const;
|
|
|
|
/** @brief Is this a debugging run?
|
|
*
|
|
* Returns true if Calamares is in debug mode. In debug mode,
|
|
* modules and settings are loaded from more locations, to help
|
|
* development and debugging.
|
|
*/
|
|
bool debugMode() const { return m_debug; }
|
|
|
|
/** @brief Distinguish "install" from "OEM" modes.
|
|
*
|
|
* Returns true in "install" mode, which is where actions happen
|
|
* in a chroot -- the target system, which exists separately from
|
|
* the source system. In "OEM" mode, returns false and most actions
|
|
* apply to the *current* (host) system.
|
|
*/
|
|
bool doChroot() const { return m_doChroot; }
|
|
|
|
/** @brief Global setting of prompt-before-install.
|
|
*
|
|
* Returns true when the configuration is such that the user
|
|
* should be prompted one-last-time before any action is taken
|
|
* that really affects the machine.
|
|
*/
|
|
bool showPromptBeforeExecution() const { return m_promptInstall; }
|
|
|
|
/** @brief Distinguish between "install" and "setup" modes.
|
|
*
|
|
* This influences user-visible strings, for instance using the
|
|
* word "setup" instead of "install" where relevant.
|
|
*/
|
|
bool isSetupMode() const { return m_isSetupMode; }
|
|
|
|
/** @brief Global setting of disable-cancel: can't cancel ever. */
|
|
bool disableCancel() const { return m_disableCancel; }
|
|
/** @brief Temporary setting of disable-cancel: can't cancel during exec. */
|
|
bool disableCancelDuringExec() const { return m_disableCancelDuringExec; }
|
|
|
|
/** @brief Is quit-at-end set? (Quit automatically when done) */
|
|
bool quitAtEnd() const { return m_quitAtEnd; }
|
|
|
|
private:
|
|
static Settings* s_instance;
|
|
|
|
QStringList m_modulesSearchPaths;
|
|
|
|
InstanceDescriptionList m_customModuleInstances;
|
|
ModuleSequence m_modulesSequence;
|
|
|
|
QString m_brandingComponentName;
|
|
|
|
bool m_debug;
|
|
bool m_doChroot;
|
|
bool m_isSetupMode;
|
|
bool m_promptInstall;
|
|
bool m_disableCancel;
|
|
bool m_disableCancelDuringExec;
|
|
bool m_quitAtEnd;
|
|
};
|
|
|
|
} // namespace Calamares
|
|
|
|
#endif // SETTINGS_H
|