KiCad PCB EDA Suite
|
#include <settings_manager.h>
Public Member Functions | |
SETTINGS_MANAGER (bool aHeadless=false) | |
~SETTINGS_MANAGER () | |
bool | IsOK () |
void | SetKiway (KIWAY *aKiway) |
Associate this setting manager with the given Kiway. | |
template<typename T> | |
T * | RegisterSettings (T *aSettings, bool aLoadNow=true) |
Take ownership of the pointer passed in. | |
void | Load () |
void | Load (JSON_SETTINGS *aSettings) |
void | Save () |
void | Save (JSON_SETTINGS *aSettings) |
void | FlushAndRelease (JSON_SETTINGS *aSettings, bool aSave=true) |
If the given settings object is registered, save it to disk and unregister it. | |
void | ResetToDefaults () |
Reset all program settings to defaults. | |
void | ClearFileHistory () |
Clear saved file history from all settings files. | |
template<typename T> | |
T * | GetAppSettings (const char *aFilename) |
Return a handle to the a given settings by type. | |
template<typename T> | |
T * | GetToolbarSettings (const wxString &aFilename) |
Return a handle to the given toolbar settings. | |
COLOR_SETTINGS * | GetColorSettings (const wxString &aName) |
Retrieve a color settings object that applications can read colors from. | |
std::vector< COLOR_SETTINGS * > | GetColorSettingsList () |
void | SaveColorSettings (COLOR_SETTINGS *aSettings, const std::string &aNamespace="") |
Safely save a COLOR_SETTINGS to disk, preserving any changes outside the given namespace. | |
COLOR_SETTINGS * | AddNewColorSettings (const wxString &aFilename) |
Register a new color settings object with the given filename. | |
COLOR_SETTINGS * | GetMigratedColorSettings () |
Return a color theme for storing colors migrated from legacy (5.x and earlier) settings, creating the theme if necessary. | |
COMMON_SETTINGS * | GetCommonSettings () const |
Retrieve the common settings shared by all applications. | |
wxString | GetPathForSettingsFile (JSON_SETTINGS *aSettings) |
Return the path a given settings file should be loaded from / stored to. | |
bool | MigrateIfNeeded () |
Handle the initialization of the user settings directory and migration from previous KiCad versions as needed. | |
void | SetMigrationSource (const wxString &aSource) |
Helper for DIALOG_MIGRATE_SETTINGS to specify a source for migration. | |
void | SetMigrateLibraryTables (bool aMigrate=true) |
bool | GetPreviousVersionPaths (std::vector< wxString > *aName=nullptr) |
Retrieve the name of the most recent previous KiCad version that can be found in the user settings directory. | |
void | ReloadColorSettings () |
Re-scan the color themes directory, reloading any changes it finds. | |
bool | LoadProject (const wxString &aFullPath, bool aSetActive=true) |
Load a project or sets up a new project with a specified path. | |
bool | UnloadProject (PROJECT *aProject, bool aSave=true) |
Save, unload and unregister the given PROJECT. | |
bool | IsProjectOpen () const |
Helper for checking if we have a project open. | |
bool | IsProjectOpenNotDummy () const |
Helper for checking if we have a project open that is not a dummy project. | |
PROJECT & | Prj () const |
A helper while we are not MDI-capable – return the one and only project. | |
PROJECT * | GetProject (const wxString &aFullPath) const |
Retrieve a loaded project by name. | |
std::vector< wxString > | GetOpenProjects () const |
bool | SaveProject (const wxString &aFullPath=wxEmptyString, PROJECT *aProject=nullptr) |
Save a loaded project. | |
void | SaveProjectAs (const wxString &aFullPath, PROJECT *aProject=nullptr) |
Set the currently loaded project path and saves it (pointers remain valid). | |
void | SaveProjectCopy (const wxString &aFullPath, PROJECT *aProject=nullptr) |
Save a copy of the current project under the given path. | |
wxString | GetProjectBackupsPath () const |
bool | BackupProject (REPORTER &aReporter, wxFileName &aTarget) const |
Create a backup archive of the current project. | |
bool | TriggerBackupIfNeeded (REPORTER &aReporter) const |
Call BackupProject() if a new backup is needed according to the current backup policy. | |
Static Public Member Functions | |
static bool | IsSettingsPathValid (const wxString &aPath) |
Check if a given path is probably a valid KiCad configuration directory. | |
static wxString | GetColorSettingsPath () |
Return the path where color scheme files are stored; creating it if missing (normally . | |
static wxString | GetToolbarSettingsPath () |
Return the path where toolbar configuration files are stored; creating it if missing (normally . | |
static std::string | GetSettingsVersion () |
Parse the current KiCad build version and extracts the major and minor revision to use as the name of the settings directory for this KiCad version. | |
static wxString | GetUserSettingsPath () |
A proxy for PATHS::GetUserSettingsPath() rather than fighting swig. | |
Private Member Functions | |
JSON_SETTINGS * | registerSettings (JSON_SETTINGS *aSettings, bool aLoadNow=true) |
COLOR_SETTINGS * | loadColorSettingsByName (const wxString &aName) |
Attempt to load a color theme by name (the color theme directory and .json ext are assumed). | |
COLOR_SETTINGS * | registerColorSettings (const wxString &aFilename, bool aAbsolutePath=false) |
void | loadAllColorSettings () |
bool | loadProjectFile (PROJECT &aProject) |
Register a PROJECT_FILE and attempt to load it from disk. | |
bool | unloadProjectFile (PROJECT *aProject, bool aSave) |
Optionally save, unload and unregister the given PROJECT_FILE. | |
void | registerBuiltinColorSettings () |
Static Private Member Functions | |
static int | compareVersions (const std::string &aFirst, const std::string &aSecond) |
Compare two settings versions, like "5.99" and "6.0". | |
static bool | extractVersion (const std::string &aVersionString, int *aMajor=nullptr, int *aMinor=nullptr) |
Extract the numeric version from a given settings string. | |
Private Attributes | |
bool | m_headless |
True if running outside a UI context. | |
KIWAY * | m_kiway |
The kiway this settings manager interacts with. | |
std::vector< std::unique_ptr< JSON_SETTINGS > > | m_settings |
std::unordered_map< wxString, COLOR_SETTINGS * > | m_color_settings |
std::unordered_map< size_t, JSON_SETTINGS * > | m_app_settings_cache |
Cache for app settings. | |
std::mutex | m_app_settings_mutex |
COMMON_SETTINGS * | m_common_settings |
wxString | m_migration_source |
bool | m_migrateLibraryTables |
If true, the symbol and footprint library tables will be migrated from the previous version. | |
bool | m_ok |
True if settings loaded successfully at construction. | |
std::vector< std::unique_ptr< PROJECT > > | m_projects_list |
Loaded projects (ownership here). | |
std::map< wxString, PROJECT * > | m_projects |
Loaded projects, mapped according to project full name. | |
std::map< wxString, PROJECT_FILE * > | m_project_files |
Loaded project files, mapped according to project full name. | |
Static Private Attributes | |
static wxString | backupDateTimeFormat = wxT( "%Y-%m-%d_%H%M%S" ) |
Definition at line 48 of file settings_manager.h.
SETTINGS_MANAGER::SETTINGS_MANAGER | ( | bool | aHeadless = false | ) |
Definition at line 55 of file settings_manager.cpp.
References GetPathForSettingsFile(), m_common_settings, m_headless, m_kiway, m_migrateLibraryTables, m_migration_source, m_ok, MigrateIfNeeded(), registerBuiltinColorSettings(), RegisterSettings(), and Save().
SETTINGS_MANAGER::~SETTINGS_MANAGER | ( | ) |
Definition at line 89 of file settings_manager.cpp.
References m_color_settings, m_projects, m_projects_list, m_settings, and project.
COLOR_SETTINGS * SETTINGS_MANAGER::AddNewColorSettings | ( | const wxString & | aFilename | ) |
Register a new color settings object with the given filename.
aFilename | is the location to store the new settings object. |
Definition at line 358 of file settings_manager.cpp.
References registerColorSettings().
Referenced by FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), and PANEL_COLOR_SETTINGS::OnThemeChanged().
bool SETTINGS_MANAGER::BackupProject | ( | REPORTER & | aReporter, |
wxFileName & | aTarget ) const |
Create a backup archive of the current project.
aReporter | is used for progress reporting. |
aTarget | is the full path to the backup file. If empty, will generate and return the full path to the backup file. |
Definition at line 1302 of file settings_manager.cpp.
References PROJECT_ARCHIVER::Archive(), FILEEXT::ArchiveFileExtension, backupDateTimeFormat, GetProjectBackupsPath(), Prj(), and traceSettings.
Referenced by TriggerBackupIfNeeded().
void SETTINGS_MANAGER::ClearFileHistory | ( | ) |
Clear saved file history from all settings files.
Definition at line 125 of file settings_manager.cpp.
References GetPathForSettingsFile(), m_settings, path, and USER.
Referenced by PANEL_MAINTENANCE::onClearFileHistory().
|
staticprivate |
Compare two settings versions, like "5.99" and "6.0".
Definition at line 896 of file settings_manager.cpp.
References extractVersion(), and traceSettings.
Referenced by GetPreviousVersionPaths().
|
staticprivate |
Extract the numeric version from a given settings string.
aVersionString | is the string to split at the ".". |
aMajor | will store the first part. |
aMinor | will store the second part. |
Definition at line 936 of file settings_manager.cpp.
Referenced by compareVersions(), and GetPreviousVersionPaths().
void SETTINGS_MANAGER::FlushAndRelease | ( | JSON_SETTINGS * | aSettings, |
bool | aSave = true ) |
If the given settings object is registered, save it to disk and unregister it.
aSettings | is the object to release |
Definition at line 225 of file settings_manager.cpp.
References GetPathForSettingsFile(), m_app_settings_cache, m_settings, and traceSettings.
Referenced by BIN_MOD::End(), CV::IFACE::OnKifaceStart(), PCB::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), and unloadProjectFile().
Return a handle to the a given settings by type.
If the settings have already been loaded, returns the existing pointer. If the settings have not been loaded, creates a new object owned by the settings manager and returns a pointer to it.
T | is a type derived from APP_SETTINGS_BASE. |
aFilename | is used to find the correct settings under clang (where RTTI doesn't work across compile boundaries). |
Definition at line 117 of file settings_manager.h.
References m_app_settings_cache, m_app_settings_mutex, m_settings, and T.
Referenced by FOOTPRINT_EDIT_FRAME::config(), PCB_BASE_FRAME::GetFootprintEditorSettings(), PCB_BASE_FRAME::GetPcbNewSettings(), PCB_BASE_FRAME::GetViewerSettingsBase(), gvconfig(), FOOTPRINT_PREVIEW_PANEL::New(), and KIGFX::PCB_PAINTER::viewer_settings().
COLOR_SETTINGS * SETTINGS_MANAGER::GetColorSettings | ( | const wxString & | aName | ) |
Retrieve a color settings object that applications can read colors from.
If the given settings file cannot be found, returns the default settings.
aName | is the name of the color scheme to load. |
Definition at line 251 of file settings_manager.cpp.
References COLOR_SETTINGS::COLOR_BUILTIN_DEFAULT, DEFAULT_THEME, loadColorSettingsByName(), m_color_settings, registerColorSettings(), JSON_SETTINGS::SetFilename(), and JSON_SETTINGS::SetReadOnly().
Referenced by GetColorSettings(), and PCB_TEST_FRAME_BASE::LoadSettings().
|
inline |
Definition at line 215 of file settings_manager.h.
References m_color_settings.
|
static |
Return the path where color scheme files are stored; creating it if missing (normally .
/colors/ under the user settings path).
Definition at line 847 of file settings_manager.cpp.
References PATHS::GetUserSettingsPath(), path, and traceSettings.
Referenced by GetPathForSettingsFile(), loadAllColorSettings(), loadColorSettingsByName(), PANEL_COLOR_SETTINGS::OnBtnOpenThemeFolderClicked(), PANEL_COLOR_SETTINGS::OnThemeChanged(), and SaveColorSettings().
|
inline |
Retrieve the common settings shared by all applications.
Definition at line 264 of file settings_manager.h.
References m_common_settings.
Referenced by GetLanguage(), PANEL_PLUGIN_SETTINGS::TransferDataFromWindow(), PANEL_PLUGIN_SETTINGS::TransferDataToWindow(), and TriggerBackupIfNeeded().
COLOR_SETTINGS * SETTINGS_MANAGER::GetMigratedColorSettings | ( | ) |
Return a color theme for storing colors migrated from legacy (5.x and earlier) settings, creating the theme if necessary.
This theme will be called "user.json" / "User".
Definition at line 367 of file settings_manager.cpp.
References m_color_settings, registerColorSettings(), Save(), and COLOR_SETTINGS::SetName().
Referenced by EESCHEMA_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), and PCBNEW_SETTINGS::MigrateFromLegacy().
std::vector< wxString > SETTINGS_MANAGER::GetOpenProjects | ( | ) | const |
Definition at line 1127 of file settings_manager.cpp.
References m_projects.
Referenced by KICAD_MANAGER_FRAME::canCloseWindow(), and KICAD_MANAGER_FRAME::SaveSettings().
wxString SETTINGS_MANAGER::GetPathForSettingsFile | ( | JSON_SETTINGS * | aSettings | ) |
Return the path a given settings file should be loaded from / stored to.
aSettings | is the settings object. |
Definition at line 483 of file settings_manager.cpp.
References COLORS, GetColorSettingsPath(), JSON_SETTINGS::GetLocation(), PROJECT::GetProjectPath(), GetToolbarSettingsPath(), PATHS::GetUserSettingsPath(), NONE, Prj(), PROJECT, TOOLBARS, and USER.
Referenced by ClearFileHistory(), FlushAndRelease(), Load(), Load(), MigrateIfNeeded(), PANEL_COLOR_SETTINGS::OnThemeChanged(), registerSettings(), ResetToDefaults(), Save(), Save(), SETTINGS_MANAGER(), and unloadProjectFile().
bool SETTINGS_MANAGER::GetPreviousVersionPaths | ( | std::vector< wxString > * | aName = nullptr | ) |
Retrieve the name of the most recent previous KiCad version that can be found in the user settings directory.
For legacy versions (5.x, and 5.99 builds before this code was written), this will return "5.x".
aName | is filled with the name of the previous version, if one exists. |
Definition at line 692 of file settings_manager.cpp.
References PATHS::CalculateUserSettingsPath(), compareVersions(), extractVersion(), GetSettingsVersion(), IsSettingsPathValid(), and traceSettings.
PROJECT * SETTINGS_MANAGER::GetProject | ( | const wxString & | aFullPath | ) | const |
Retrieve a loaded project by name.
aFullPath | is the full path including name and extension to the project file. |
Definition at line 1118 of file settings_manager.cpp.
References m_projects.
Referenced by CLI::JOBSET_RUN_COMMAND::doPerform(), EESCHEMA_HELPERS::GetDefaultProject(), GetDefaultProject(), LoadBoard(), EESCHEMA_HELPERS::LoadSchematic(), and NewBoard().
wxString SETTINGS_MANAGER::GetProjectBackupsPath | ( | ) | const |
Definition at line 1293 of file settings_manager.cpp.
References PROJECT::GetProjectName(), PROJECT::GetProjectPath(), Prj(), and PROJECT_BACKUPS_DIR_SUFFIX.
Referenced by BackupProject(), and TriggerBackupIfNeeded().
|
static |
Parse the current KiCad build version and extracts the major and minor revision to use as the name of the settings directory for this KiCad version.
Definition at line 889 of file settings_manager.cpp.
References GetMajorMinorVersion().
Referenced by GetPreviousVersionPaths(), and DIALOG_MIGRATE_SETTINGS::TransferDataToWindow().
Return a handle to the given toolbar settings.
If the settings have already been loaded, returns the existing pointer. If the settings have not been loaded, creates a new object owned by the settings manager and returns a pointer to it.
T | is a type derived from TOOLBAR_SETTINGS. |
aFilename | is used to find the correct settings under clang (where RTTI doesn't work across compile boundaries). |
Definition at line 173 of file settings_manager.h.
References m_settings, RegisterSettings(), and T.
Referenced by CVPCB_MAINFRAME::CVPCB_MAINFRAME(), and EVT_TOOL_RANGE().
|
static |
Return the path where toolbar configuration files are stored; creating it if missing (normally .
/toolbars/ under the user settings path).
Definition at line 868 of file settings_manager.cpp.
References PATHS::GetUserSettingsPath(), path, and traceSettings.
Referenced by GetPathForSettingsFile().
|
static |
A proxy for PATHS::GetUserSettingsPath() rather than fighting swig.
Definition at line 1528 of file settings_manager.cpp.
References PATHS::GetUserSettingsPath().
|
inline |
Definition at line 58 of file settings_manager.h.
References m_ok.
bool SETTINGS_MANAGER::IsProjectOpen | ( | ) | const |
Helper for checking if we have a project open.
Definition at line 1105 of file settings_manager.cpp.
References m_projects.
Referenced by FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_BASE_EDIT_FRAME::doCloseWindow(), and KICAD_MANAGER_FRAME::GetProjectFileName().
bool SETTINGS_MANAGER::IsProjectOpenNotDummy | ( | ) | const |
Helper for checking if we have a project open that is not a dummy project.
Definition at line 1111 of file settings_manager.cpp.
References m_projects.
|
static |
Check if a given path is probably a valid KiCad configuration directory.
Actually it just checks if a file called "kicad_common" exists, because that's probably good enough for now.
aPath | is the path to check. |
Definition at line 834 of file settings_manager.cpp.
Referenced by GetPreviousVersionPaths(), and DIALOG_MIGRATE_SETTINGS::validatePath().
void SETTINGS_MANAGER::Load | ( | ) |
Definition at line 157 of file settings_manager.cpp.
References GetPathForSettingsFile(), and m_settings.
Referenced by init_unit_test(), and PGM_BASE::InitPgm().
void SETTINGS_MANAGER::Load | ( | JSON_SETTINGS * | aSettings | ) |
Definition at line 175 of file settings_manager.cpp.
References GetPathForSettingsFile(), and m_settings.
|
private |
Definition at line 387 of file settings_manager.cpp.
References GetColorSettingsPath(), PATHS::GetDefault3rdPartyPath(), PGM_BASE::GetLocalEnvVariables(), PATHS::GetStockDataPath(), ENV_VAR::GetVersionedEnvVarName(), Pgm(), registerBuiltinColorSettings(), registerColorSettings(), and JSON_SETTINGS::SetReadOnly().
Referenced by ReloadColorSettings().
|
private |
Attempt to load a color theme by name (the color theme directory and .json ext are assumed).
aName | is the filename of the color theme (without the extension or path). |
Definition at line 290 of file settings_manager.cpp.
References GetColorSettingsPath(), JSON_SETTINGS::GetFilename(), m_color_settings, RegisterSettings(), and traceSettings.
Referenced by GetColorSettings().
bool SETTINGS_MANAGER::LoadProject | ( | const wxString & | aFullPath, |
bool | aSetActive = true ) |
Load a project or sets up a new project with a specified path.
aFullPath | is the full path to the project. |
aSetActive | if true will set the loaded project as the active project. |
Definition at line 966 of file settings_manager.cpp.
References FILEEXT::LegacyProjectFileExtension, JSON_SETTINGS::LoadFromFile(), loadProjectFile(), m_kiway, m_projects, m_projects_list, path, project, PROJECT_VAR_NAME, FILEEXT::ProjectFileExtension, RegisterSettings(), traceSettings, unloadProjectFile(), and LOCKFILE::Valid().
Referenced by BOOST_AUTO_TEST_CASE(), KICAD_MANAGER_FRAME::CreateNewProject(), EESCHEMA_HELPERS::GetDefaultProject(), GetDefaultProject(), PGM_BASE::InitPgm(), KI_TEST::LoadBoard(), LoadBoard(), KICAD_MANAGER_FRAME::LoadProject(), EESCHEMA_HELPERS::LoadSchematic(), KI_TEST::LoadSchematic(), NewBoard(), SCH_EDIT_FRAME::OnImportProject(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH::readSchematicFromFile(), and UnloadProject().
|
private |
Register a PROJECT_FILE and attempt to load it from disk.
aProject | is the project object to load the file for. |
Definition at line 1234 of file settings_manager.cpp.
References PROJECT::GetProjectFullName(), JSON_SETTINGS::LoadFromFile(), m_project_files, path, RegisterSettings(), PROJECT_FILE::SetProject(), and PROJECT::setProjectFile().
Referenced by LoadProject().
bool SETTINGS_MANAGER::MigrateIfNeeded | ( | ) |
Handle the initialization of the user settings directory and migration from previous KiCad versions as needed.
This method will check for the existence of the user settings path for this KiCad version. If it exists, settings load will proceed normally using that path.
If that directory is empty or does not exist, the migration wizard will be launched, which will give users the option to migrate settings from a previous KiCad version (if one is found), manually specify a directory to migrate from, or start with default settings.
Definition at line 589 of file settings_manager.cpp.
References DisplayErrorMessage(), MIGRATION_TRAVERSER::GetErrors(), GetPathForSettingsFile(), PATHS::GetUserSettingsPath(), JSON_SETTINGS::LoadFromFile(), COMMON_SETTINGS::m_Env, m_headless, m_migrateLibraryTables, m_migration_source, path, JSON_SETTINGS::SaveToFile(), DIALOG_SHIM::ShowModal(), traceSettings, and COMMON_SETTINGS::ENVIRONMENT::vars.
Referenced by SETTINGS_MANAGER().
PROJECT & SETTINGS_MANAGER::Prj | ( | ) | const |
A helper while we are not MDI-capable – return the one and only project.
Definition at line 1097 of file settings_manager.cpp.
References m_projects_list.
Referenced by BackupProject(), BOOST_AUTO_TEST_CASE(), PCB_NET_INSPECTOR_PANEL::buildColumns(), PCB_NET_INSPECTOR_PANEL::buildNetsList(), PCBNEW_JOBS_HANDLER::getBoard(), GetPathForSettingsFile(), GetProjectBackupsPath(), EESCHEMA_JOBS_HANDLER::getSchematic(), API_HANDLER_COMMON::handleExpandTextVariables(), API_HANDLER_COMMON::handleGetNetClasses(), API_HANDLER_COMMON::handleGetTextVariables(), API_HANDLER_COMMON::handleSetNetClasses(), API_HANDLER_COMMON::handleSetTextVariables(), KI_TEST::LoadBoard(), KI_TEST::LoadSchematic(), PCB_NET_INSPECTOR_PANEL::netFilterMatches(), PCB_NET_INSPECTOR_PANEL::OnBoardChanged(), PCB_NET_INSPECTOR_PANEL::OnConfigButton(), LIB_TREE::onDetailsLink(), PCB_EDIT_FRAME::OpenProjectFiles(), KIWAY::Prj(), SCH::readSchematicFromFile(), SaveProject(), SaveProjectAs(), SaveProjectCopy(), PCB_NET_INSPECTOR_PANEL::SaveSettings(), and TriggerBackupIfNeeded().
|
private |
Definition at line 380 of file settings_manager.cpp.
References COLOR_SETTINGS::CreateBuiltinColorSettings(), m_color_settings, and RegisterSettings().
Referenced by loadAllColorSettings(), and SETTINGS_MANAGER().
|
private |
Definition at line 345 of file settings_manager.cpp.
References m_color_settings, and RegisterSettings().
Referenced by AddNewColorSettings(), GetColorSettings(), GetMigratedColorSettings(), and loadAllColorSettings().
|
inline |
Take ownership of the pointer passed in.
aSettings | is a settings object to register. |
Definition at line 74 of file settings_manager.h.
References registerSettings(), and T.
Referenced by BMP2CMP::IFACE::CreateKiWindow(), GetToolbarSettings(), init_unit_test(), loadColorSettingsByName(), LoadProject(), loadProjectFile(), PCB_TEST_FRAME_BASE::LoadSettings(), CV::IFACE::OnKifaceStart(), GERBV::IFACE::OnKifaceStart(), PCB::IFACE::OnKifaceStart(), PCBCALC::IFACE::OnKifaceStart(), PGE::IFACE::OnKifaceStart(), SCH::IFACE::OnKifaceStart(), PGM_KICAD::OnPgmInit(), PGM_SINGLE_TOP::OnPgmInit(), registerBuiltinColorSettings(), registerColorSettings(), PCB_TEST_FRAME_BASE::SetBoard(), and SETTINGS_MANAGER().
|
private |
Definition at line 140 of file settings_manager.cpp.
References GetPathForSettingsFile(), m_settings, and traceSettings.
Referenced by RegisterSettings().
void SETTINGS_MANAGER::ReloadColorSettings | ( | ) |
Re-scan the color themes directory, reloading any changes it finds.
Definition at line 436 of file settings_manager.cpp.
References loadAllColorSettings(), and m_color_settings.
Referenced by PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), and KICAD_MANAGER_CONTROL::ShowPluginManager().
void SETTINGS_MANAGER::ResetToDefaults | ( | ) |
Reset all program settings to defaults.
Definition at line 105 of file settings_manager.cpp.
References COLORS, GetPathForSettingsFile(), m_settings, path, and USER.
Referenced by PANEL_MAINTENANCE::onResetAll().
void SETTINGS_MANAGER::Save | ( | ) |
Definition at line 188 of file settings_manager.cpp.
References GetPathForSettingsFile(), and m_settings.
Referenced by GetMigratedColorSettings(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), SETTINGS_MANAGER(), EDA_BASE_FRAME::ShowPreferences(), PANEL_COMMON_SETTINGS::TransferDataFromWindow(), PANEL_MAINTENANCE::TransferDataFromWindow(), and SYMBOL_EDIT_FRAME::~SYMBOL_EDIT_FRAME().
void SETTINGS_MANAGER::Save | ( | JSON_SETTINGS * | aSettings | ) |
Definition at line 209 of file settings_manager.cpp.
References GetPathForSettingsFile(), m_settings, and traceSettings.
void SETTINGS_MANAGER::SaveColorSettings | ( | COLOR_SETTINGS * | aSettings, |
const std::string & | aNamespace = "" ) |
Safely save a COLOR_SETTINGS to disk, preserving any changes outside the given namespace.
A color settings namespace is one of the top-level JSON objects like "board", etc. This will perform a read-modify-write
aSettings | is a pointer to a valid COLOR_SETTINGS object managed by SETTINGS_MANAGER. |
aNamespace | is the namespace of settings to save. |
Definition at line 443 of file settings_manager.cpp.
References JSON_SETTINGS::Contains(), GetColorSettingsPath(), JSON_SETTINGS::GetFilename(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::Internals(), JSON_SETTINGS::IsReadOnly(), JSON_SETTINGS::Load(), JSON_SETTINGS::LoadFromFile(), m_color_settings, path, JSON_SETTINGS::SaveToFile(), JSON_SETTINGS::Store(), and traceSettings.
Referenced by EESCHEMA_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), PANEL_COLOR_SETTINGS::saveCurrentTheme(), GERBVIEW_FRAME::SaveSettings(), and BOARD_ADAPTER::SetLayerColors().
bool SETTINGS_MANAGER::SaveProject | ( | const wxString & | aFullPath = wxEmptyString, |
PROJECT * | aProject = nullptr ) |
Save a loaded project.
aFullPath | is the project name to save. If empty, will save the first loaded project. |
aProject | is the project to save, or nullptr to save the active project (Prj() return). |
Definition at line 1142 of file settings_manager.cpp.
References PROJECT::GetLocalSettings(), PROJECT::GetProjectFullName(), PROJECT::GetProjectPath(), PROJECT::IsReadOnly(), m_project_files, path, Prj(), project, and PROJECT_LOCAL_SETTINGS::SaveToFile().
Referenced by KICAD_MANAGER_FRAME::CloseProject(), KICAD_MANAGER_FRAME::CreateNewProject(), API_HANDLER_COMMON::handleSetTextVariables(), DIALOG_CONFIG_EQUFILES::OnOkClick(), SCH_EDIT_FRAME::OpenProjectFiles(), PROJECT::PinLibrary(), PCB_EDIT_FRAME::SavePcbFile(), SaveProjectAs(), PCB_EDIT_FRAME::SaveProjectLocalSettings(), SCH_EDIT_FRAME::saveProjectSettings(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), and PROJECT::UnpinLibrary().
void SETTINGS_MANAGER::SaveProjectAs | ( | const wxString & | aFullPath, |
PROJECT * | aProject = nullptr ) |
Set the currently loaded project path and saves it (pointers remain valid).
aFullPath | is the full filename to set for the project. |
aProject | is the project to save, or nullptr to save the active project (Prj() return). |
Definition at line 1169 of file settings_manager.cpp.
References PROJECT::GetLocalSettings(), PROJECT::GetProjectFullName(), PROJECT::IsReadOnly(), m_project_files, m_projects, Prj(), project, SaveProject(), PROJECT_LOCAL_SETTINGS::SaveToFile(), JSON_SETTINGS::SetFilename(), PROJECT::setProjectFullName(), and JSON_SETTINGS::SetReadOnly().
Referenced by SaveBoard(), PCB_EDIT_FRAME::SavePcbFile(), and SCH_EDIT_FRAME::SaveProject().
void SETTINGS_MANAGER::SaveProjectCopy | ( | const wxString & | aFullPath, |
PROJECT * | aProject = nullptr ) |
Save a copy of the current project under the given path.
aFullPath | is the full filename to set for the project. |
aProject | is the project to save, or nullptr to save the active project (Prj() return). |
Definition at line 1208 of file settings_manager.cpp.
References PROJECT::GetLocalSettings(), PROJECT::GetProjectFullName(), m_project_files, Prj(), project, PROJECT_LOCAL_SETTINGS::SaveToFile(), and JSON_SETTINGS::SetFilename().
Referenced by PCB_EDIT_FRAME::SavePcbCopy(), and SCH_EDIT_FRAME::SaveProject().
|
inline |
Associate this setting manager with the given Kiway.
aKiway | is the kiway this settings manager should use |
Definition at line 65 of file settings_manager.h.
References m_kiway.
Referenced by PGM_KICAD::OnPgmInit(), and PGM_SINGLE_TOP::OnPgmInit().
|
inline |
Definition at line 296 of file settings_manager.h.
References m_migrateLibraryTables.
|
inline |
Helper for DIALOG_MIGRATE_SETTINGS to specify a source for migration.
aSource | is a directory containing settings files to migrate from (can be empty). |
Definition at line 294 of file settings_manager.h.
References m_migration_source.
bool SETTINGS_MANAGER::TriggerBackupIfNeeded | ( | REPORTER & | aReporter | ) | const |
Call BackupProject() if a new backup is needed according to the current backup policy.
aReporter | is used for progress reporting. |
Definition at line 1366 of file settings_manager.cpp.
References PROJECT_ARCHIVER::AreZipArchivesIdentical(), backupDateTimeFormat, BackupProject(), delta, COMMON_SETTINGS::AUTO_BACKUP::enabled, GetCommonSettings(), GetProjectBackupsPath(), PROJECT::GetProjectName(), COMMON_SETTINGS::AUTO_BACKUP::limit_daily_files, COMMON_SETTINGS::AUTO_BACKUP::limit_total_files, COMMON_SETTINGS::AUTO_BACKUP::limit_total_size, COMMON_SETTINGS::m_Backup, COMMON_SETTINGS::AUTO_BACKUP::min_interval, Prj(), and traceSettings.
Referenced by KICAD_MANAGER_FRAME::CloseProject(), PCB_EDIT_FRAME::DoAutoSave(), and SCH_EDIT_FRAME::doAutoSave().
bool SETTINGS_MANAGER::UnloadProject | ( | PROJECT * | aProject, |
bool | aSave = true ) |
Save, unload and unregister the given PROJECT.
aProject | is the project object to unload. |
aSave | if true will save the project before unloading. |
Definition at line 1054 of file settings_manager.cpp.
References PROJECT::GetProjectFullName(), LoadProject(), m_kiway, m_projects, m_projects_list, PROJECT_VAR_NAME, traceSettings, and unloadProjectFile().
Referenced by KICAD_MANAGER_FRAME::CloseProject(), PCB_BASE_EDIT_FRAME::doCloseWindow(), KI_TEST::LoadSchematic(), SCH_EDIT_FRAME::OnImportProject(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().
|
private |
Optionally save, unload and unregister the given PROJECT_FILE.
aProject | is the project object to unload the file for. |
aSave | if true will save the project file before unloading. |
Definition at line 1252 of file settings_manager.cpp.
References FlushAndRelease(), PROJECT::GetLocalSettings(), GetPathForSettingsFile(), PROJECT::GetProjectFullName(), m_project_files, m_settings, name, PROJECT_FILE::ShouldAutoSave(), and PROJECT_LOCAL_SETTINGS::ShouldAutoSave().
Referenced by LoadProject(), and UnloadProject().
Definition at line 547 of file settings_manager.h.
Referenced by BackupProject(), and TriggerBackupIfNeeded().
|
private |
Cache for app settings.
Definition at line 524 of file settings_manager.h.
Referenced by FlushAndRelease(), and GetAppSettings().
|
private |
Definition at line 525 of file settings_manager.h.
Referenced by GetAppSettings().
|
private |
Definition at line 521 of file settings_manager.h.
Referenced by GetColorSettings(), GetColorSettingsList(), GetMigratedColorSettings(), loadColorSettingsByName(), registerBuiltinColorSettings(), registerColorSettings(), ReloadColorSettings(), SaveColorSettings(), and ~SETTINGS_MANAGER().
|
private |
Definition at line 528 of file settings_manager.h.
Referenced by GetCommonSettings(), and SETTINGS_MANAGER().
|
private |
True if running outside a UI context.
Definition at line 514 of file settings_manager.h.
Referenced by MigrateIfNeeded(), and SETTINGS_MANAGER().
|
private |
The kiway this settings manager interacts with.
Definition at line 517 of file settings_manager.h.
Referenced by LoadProject(), SetKiway(), SETTINGS_MANAGER(), and UnloadProject().
|
private |
If true, the symbol and footprint library tables will be migrated from the previous version.
Definition at line 533 of file settings_manager.h.
Referenced by MigrateIfNeeded(), SetMigrateLibraryTables(), and SETTINGS_MANAGER().
|
private |
Definition at line 530 of file settings_manager.h.
Referenced by MigrateIfNeeded(), SetMigrationSource(), and SETTINGS_MANAGER().
|
private |
True if settings loaded successfully at construction.
Definition at line 536 of file settings_manager.h.
Referenced by IsOK(), and SETTINGS_MANAGER().
|
private |
Loaded project files, mapped according to project full name.
Definition at line 545 of file settings_manager.h.
Referenced by loadProjectFile(), SaveProject(), SaveProjectAs(), SaveProjectCopy(), and unloadProjectFile().
|
private |
Loaded projects, mapped according to project full name.
Definition at line 542 of file settings_manager.h.
Referenced by GetOpenProjects(), GetProject(), IsProjectOpen(), IsProjectOpenNotDummy(), LoadProject(), SaveProjectAs(), UnloadProject(), and ~SETTINGS_MANAGER().
|
private |
Loaded projects (ownership here).
Definition at line 539 of file settings_manager.h.
Referenced by LoadProject(), Prj(), UnloadProject(), and ~SETTINGS_MANAGER().
|
private |
Definition at line 519 of file settings_manager.h.
Referenced by ClearFileHistory(), FlushAndRelease(), GetAppSettings(), GetToolbarSettings(), Load(), Load(), registerSettings(), ResetToDefaults(), Save(), Save(), unloadProjectFile(), and ~SETTINGS_MANAGER().