All: Reformat according to new standard
This commit is contained in:
pre-commit-ci[bot]
committed by
Kacper Donat
Kacper Donat
parent
eafd18dac0
commit
25c3ba7338
@@ -33,209 +33,211 @@
|
||||
|
||||
#include "App/Metadata.h"
|
||||
|
||||
namespace Gui {
|
||||
namespace Gui
|
||||
{
|
||||
|
||||
/**
|
||||
* \class PreferencePack A collection of user preferences stored in files on disk
|
||||
*/
|
||||
class GuiExport PreferencePack
|
||||
{
|
||||
|
||||
public:
|
||||
/**
|
||||
* \class PreferencePack A collection of user preferences stored in files on disk
|
||||
*/
|
||||
class GuiExport PreferencePack {
|
||||
|
||||
public:
|
||||
|
||||
/**
|
||||
* Construct a preferencePack from a directory
|
||||
*
|
||||
* \param path A path to a mod directory that contains a preferencePack
|
||||
* \param metadata The metadata from the package.xml file describing this preferencePack
|
||||
*/
|
||||
PreferencePack(const std::filesystem::path& path, const App::Metadata& metadata);
|
||||
|
||||
~PreferencePack() = default;
|
||||
|
||||
/**
|
||||
* Get the name of the PreferencePack
|
||||
*/
|
||||
std::string name() const;
|
||||
|
||||
/**
|
||||
* Apply the PreferencePack over the top of the current preferences set
|
||||
* \returns True if the preferencePack was applied, or false if not
|
||||
*/
|
||||
bool apply() const;
|
||||
|
||||
/**
|
||||
* Get the complete metadata object for this preference pack
|
||||
*/
|
||||
App::Metadata metadata() const;
|
||||
|
||||
private:
|
||||
|
||||
void applyConfigChanges() const;
|
||||
|
||||
std::filesystem::path _path;
|
||||
App::Metadata _metadata;
|
||||
|
||||
};
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* \class PreferencePackManager handles storable and loadable collections of user preferences
|
||||
* Construct a preferencePack from a directory
|
||||
*
|
||||
* This class provides some additional utility functions for allowing users to save their current
|
||||
* preferences as a PreferencePack based on a set of template files provided either in the main
|
||||
* FreeCAD distribution, or inside various installed mods.
|
||||
* \param path A path to a mod directory that contains a preferencePack
|
||||
* \param metadata The metadata from the package.xml file describing this preferencePack
|
||||
*/
|
||||
class GuiExport PreferencePackManager {
|
||||
public:
|
||||
PreferencePackManager();
|
||||
~PreferencePackManager() = default;
|
||||
PreferencePack(const std::filesystem::path& path, const App::Metadata& metadata);
|
||||
|
||||
/**
|
||||
* Rescan the preferencePack directory and update the available PreferencePacks
|
||||
*/
|
||||
void rescan();
|
||||
~PreferencePack() = default;
|
||||
|
||||
/**
|
||||
* Get an alphabetical list of names of all visible PreferencePacks
|
||||
*/
|
||||
std::vector<std::string> preferencePackNames() const;
|
||||
/**
|
||||
* Get the name of the PreferencePack
|
||||
*/
|
||||
std::string name() const;
|
||||
|
||||
/**
|
||||
* Get a map of all visible PreferencePack names and their associated packs
|
||||
*/
|
||||
std::map<std::string, PreferencePack> preferencePacks() const;
|
||||
/**
|
||||
* Apply the PreferencePack over the top of the current preferences set
|
||||
* \returns True if the preferencePack was applied, or false if not
|
||||
*/
|
||||
bool apply() const;
|
||||
|
||||
/**
|
||||
* Apply the named preferencePack
|
||||
* \return True if the preferencePack was applied, or false if it was not
|
||||
*/
|
||||
bool apply(const std::string& preferencePackName) const;
|
||||
/**
|
||||
* Get the complete metadata object for this preference pack
|
||||
*/
|
||||
App::Metadata metadata() const;
|
||||
|
||||
/**
|
||||
* Check the visibility of the specified pack
|
||||
* \return True if the preferencePack is visible, or false if not. All packs are visible by default,
|
||||
* but can be marked as "invisible" (i.e. not returned by the manager in lists of packs) by using the
|
||||
* toggleVisibility function.
|
||||
*/
|
||||
bool isVisible(const std::string& addonName, const std::string& preferencePackName) const;
|
||||
private:
|
||||
void applyConfigChanges() const;
|
||||
|
||||
/**
|
||||
* Toggle the visibility of the named preference pack in a named addon
|
||||
*/
|
||||
void toggleVisibility(const std::string& addonName, const std::string& preferencePackName);
|
||||
|
||||
/**
|
||||
* Deletes the user-saved pack specified by name
|
||||
*/
|
||||
void deleteUserPack(const std::string& name);
|
||||
std::filesystem::path _path;
|
||||
App::Metadata _metadata;
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* \struct TemplateFile A file containing a set of preferences that can be saved into
|
||||
* a PreferencePack
|
||||
*
|
||||
* PreferencePacks can contain any parameters at all, but inside FreeCAD there is no
|
||||
* centralized list of all of these parameters, and at any given time the user.cfg file
|
||||
* usually does not store a value for all possible parameters. Instead, it simply allows
|
||||
* calling code to use whatever default values that code sets. This is all completely
|
||||
* hidden from the users: FreeCAD behaves as though those values exist in the config file.
|
||||
*
|
||||
* When a user saves their current configuration as a pack, they likely expect that saved
|
||||
* configuration to include those default values, so that if they later apply their saved
|
||||
* configuration those defaults are restored. To enable this a set of template files
|
||||
* listing default values for various types of parameters can be used. Each file is
|
||||
* presented to the user as a checkable box when saving a new preferences pack, and the
|
||||
* intention is that these files will list out the various user-facing parameters that
|
||||
* someone might want to save into a preferences pack.
|
||||
*
|
||||
* These files are themselves valid user.cfg files, that if loaded and applied will result
|
||||
* in the default values of their contained variables being set. For this to work, these
|
||||
* files should be kept up-to-date with the default values set in the code. They are not
|
||||
* required to contain an exhaustive listing of all possible parameters: in most cases it
|
||||
* is enough that they list the variables that a user would expect for a given name. For
|
||||
* example, "Sketcher Colors.cfg" should list out all of the default colors used in
|
||||
* Sketcher that a user can set in Preferences, but it is not necessary that it contain any
|
||||
* color that is only used internally, and it should not include things like fonts, or
|
||||
* behavior information.
|
||||
*
|
||||
* The base FreeCAD installation includes default templates in:
|
||||
* $INSTALL_DIR/data/Gui/PreferencePackTemplates/
|
||||
*
|
||||
* External add-ons are also searched for any directory called PreferencePackTemplates or
|
||||
* preference_pack_templates -- either of which is expected to contain appearance and/or
|
||||
* behavior subdirectories. In this way external add-ons can allow a user to easily save
|
||||
* their preferences to a PreferencePack, or even to add additional templates representing
|
||||
* sets of core FreeCAD preferences.
|
||||
*/
|
||||
struct TemplateFile {
|
||||
std::string group; // Generally the Add-On/Mod/Package name
|
||||
std::string name;
|
||||
std::filesystem::path path;
|
||||
};
|
||||
/**
|
||||
* \class PreferencePackManager handles storable and loadable collections of user preferences
|
||||
*
|
||||
* This class provides some additional utility functions for allowing users to save their current
|
||||
* preferences as a PreferencePack based on a set of template files provided either in the main
|
||||
* FreeCAD distribution, or inside various installed mods.
|
||||
*/
|
||||
class GuiExport PreferencePackManager
|
||||
{
|
||||
public:
|
||||
PreferencePackManager();
|
||||
~PreferencePackManager() = default;
|
||||
|
||||
/**
|
||||
* Save current settings as a (possibly new) preferencePack
|
||||
*
|
||||
* If the named preferencePack does not exist, this creates it on disk. If it does exist, this overwrites the original.
|
||||
*/
|
||||
void save(const std::string& name, const std::string& directory, const std::vector<TemplateFile>& templates);
|
||||
/**
|
||||
* Rescan the preferencePack directory and update the available PreferencePacks
|
||||
*/
|
||||
void rescan();
|
||||
|
||||
/**
|
||||
* Get an alphabetical list of names of all visible PreferencePacks
|
||||
*/
|
||||
std::vector<std::string> preferencePackNames() const;
|
||||
|
||||
/**
|
||||
* Get a map of all visible PreferencePack names and their associated packs
|
||||
*/
|
||||
std::map<std::string, PreferencePack> preferencePacks() const;
|
||||
|
||||
/**
|
||||
* Apply the named preferencePack
|
||||
* \return True if the preferencePack was applied, or false if it was not
|
||||
*/
|
||||
bool apply(const std::string& preferencePackName) const;
|
||||
|
||||
/**
|
||||
* Check the visibility of the specified pack
|
||||
* \return True if the preferencePack is visible, or false if not. All packs are visible by
|
||||
* default, but can be marked as "invisible" (i.e. not returned by the manager in lists of
|
||||
* packs) by using the toggleVisibility function.
|
||||
*/
|
||||
bool isVisible(const std::string& addonName, const std::string& preferencePackName) const;
|
||||
|
||||
/**
|
||||
* Toggle the visibility of the named preference pack in a named addon
|
||||
*/
|
||||
void toggleVisibility(const std::string& addonName, const std::string& preferencePackName);
|
||||
|
||||
/**
|
||||
* Deletes the user-saved pack specified by name
|
||||
*/
|
||||
void deleteUserPack(const std::string& name);
|
||||
|
||||
|
||||
std::vector<TemplateFile> templateFiles(bool rescan = false);
|
||||
|
||||
/**
|
||||
* Get a list of all available config file backups. Backups are currently stored for one week.
|
||||
*/
|
||||
std::vector<std::filesystem::path> configBackups() const;
|
||||
|
||||
/**
|
||||
* Import an existing config file as a preference pack with a given name.
|
||||
*/
|
||||
void importConfig(const std::string &packName, const std::filesystem::path &path);
|
||||
|
||||
/**
|
||||
* Get a list of all mod directories.
|
||||
*/
|
||||
std::vector<std::filesystem::path> modPaths() const;
|
||||
|
||||
/**
|
||||
* Get the path to the saved preference packs.
|
||||
*/
|
||||
std::filesystem::path getSavedPreferencePacksPath() const;
|
||||
|
||||
/**
|
||||
* Get the path to the preference packs of the resource directory.
|
||||
*/
|
||||
std::filesystem::path getResourcePreferencePacksPath() const;
|
||||
|
||||
/**
|
||||
* Collect all preference packs of a directory.
|
||||
*/
|
||||
std::vector<std::string> getPacksFromDirectory(const std::filesystem::path& path) const;
|
||||
|
||||
private:
|
||||
|
||||
void FindPreferencePacksInPackage(const std::filesystem::path& mod);
|
||||
void TryFindPreferencePacksInPackage(const std::filesystem::path& mod);
|
||||
|
||||
void BackupCurrentConfig() const;
|
||||
|
||||
void DeleteOldBackups() const;
|
||||
|
||||
void AddPackToMetadata(const std::string &packName) const;
|
||||
|
||||
std::vector<std::filesystem::path> _preferencePackPaths;
|
||||
std::vector<TemplateFile> _templateFiles;
|
||||
std::map<std::string, PreferencePack> _preferencePacks;
|
||||
mutable std::mutex _mutex;
|
||||
|
||||
/**
|
||||
* \struct TemplateFile A file containing a set of preferences that can be saved into
|
||||
* a PreferencePack
|
||||
*
|
||||
* PreferencePacks can contain any parameters at all, but inside FreeCAD there is no
|
||||
* centralized list of all of these parameters, and at any given time the user.cfg file
|
||||
* usually does not store a value for all possible parameters. Instead, it simply allows
|
||||
* calling code to use whatever default values that code sets. This is all completely
|
||||
* hidden from the users: FreeCAD behaves as though those values exist in the config file.
|
||||
*
|
||||
* When a user saves their current configuration as a pack, they likely expect that saved
|
||||
* configuration to include those default values, so that if they later apply their saved
|
||||
* configuration those defaults are restored. To enable this a set of template files
|
||||
* listing default values for various types of parameters can be used. Each file is
|
||||
* presented to the user as a checkable box when saving a new preferences pack, and the
|
||||
* intention is that these files will list out the various user-facing parameters that
|
||||
* someone might want to save into a preferences pack.
|
||||
*
|
||||
* These files are themselves valid user.cfg files, that if loaded and applied will result
|
||||
* in the default values of their contained variables being set. For this to work, these
|
||||
* files should be kept up-to-date with the default values set in the code. They are not
|
||||
* required to contain an exhaustive listing of all possible parameters: in most cases it
|
||||
* is enough that they list the variables that a user would expect for a given name. For
|
||||
* example, "Sketcher Colors.cfg" should list out all of the default colors used in
|
||||
* Sketcher that a user can set in Preferences, but it is not necessary that it contain any
|
||||
* color that is only used internally, and it should not include things like fonts, or
|
||||
* behavior information.
|
||||
*
|
||||
* The base FreeCAD installation includes default templates in:
|
||||
* $INSTALL_DIR/data/Gui/PreferencePackTemplates/
|
||||
*
|
||||
* External add-ons are also searched for any directory called PreferencePackTemplates or
|
||||
* preference_pack_templates -- either of which is expected to contain appearance and/or
|
||||
* behavior subdirectories. In this way external add-ons can allow a user to easily save
|
||||
* their preferences to a PreferencePack, or even to add additional templates representing
|
||||
* sets of core FreeCAD preferences.
|
||||
*/
|
||||
struct TemplateFile
|
||||
{
|
||||
std::string group; // Generally the Add-On/Mod/Package name
|
||||
std::string name;
|
||||
std::filesystem::path path;
|
||||
};
|
||||
|
||||
}
|
||||
/**
|
||||
* Save current settings as a (possibly new) preferencePack
|
||||
*
|
||||
* If the named preferencePack does not exist, this creates it on disk. If it does exist, this
|
||||
* overwrites the original.
|
||||
*/
|
||||
void save(
|
||||
const std::string& name,
|
||||
const std::string& directory,
|
||||
const std::vector<TemplateFile>& templates
|
||||
);
|
||||
|
||||
Q_DECLARE_METATYPE(Gui::PreferencePackManager::TemplateFile) // So it can be used with QVariant
|
||||
|
||||
std::vector<TemplateFile> templateFiles(bool rescan = false);
|
||||
|
||||
/**
|
||||
* Get a list of all available config file backups. Backups are currently stored for one week.
|
||||
*/
|
||||
std::vector<std::filesystem::path> configBackups() const;
|
||||
|
||||
/**
|
||||
* Import an existing config file as a preference pack with a given name.
|
||||
*/
|
||||
void importConfig(const std::string& packName, const std::filesystem::path& path);
|
||||
|
||||
/**
|
||||
* Get a list of all mod directories.
|
||||
*/
|
||||
std::vector<std::filesystem::path> modPaths() const;
|
||||
|
||||
/**
|
||||
* Get the path to the saved preference packs.
|
||||
*/
|
||||
std::filesystem::path getSavedPreferencePacksPath() const;
|
||||
|
||||
/**
|
||||
* Get the path to the preference packs of the resource directory.
|
||||
*/
|
||||
std::filesystem::path getResourcePreferencePacksPath() const;
|
||||
|
||||
/**
|
||||
* Collect all preference packs of a directory.
|
||||
*/
|
||||
std::vector<std::string> getPacksFromDirectory(const std::filesystem::path& path) const;
|
||||
|
||||
private:
|
||||
void FindPreferencePacksInPackage(const std::filesystem::path& mod);
|
||||
void TryFindPreferencePacksInPackage(const std::filesystem::path& mod);
|
||||
|
||||
void BackupCurrentConfig() const;
|
||||
|
||||
void DeleteOldBackups() const;
|
||||
|
||||
void AddPackToMetadata(const std::string& packName) const;
|
||||
|
||||
std::vector<std::filesystem::path> _preferencePackPaths;
|
||||
std::vector<TemplateFile> _templateFiles;
|
||||
std::map<std::string, PreferencePack> _preferencePacks;
|
||||
mutable std::mutex _mutex;
|
||||
};
|
||||
|
||||
} // namespace Gui
|
||||
|
||||
Q_DECLARE_METATYPE(Gui::PreferencePackManager::TemplateFile) // So it can be used with QVariant
|
||||
|
||||
|
||||
#endif
|
||||
|
||||
Reference in New Issue
Block a user