KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | List of all members
COMMON_SETTINGS Class Reference

#include <common_settings.h>

Inheritance diagram for COMMON_SETTINGS:
JSON_SETTINGS

Classes

struct  API
 
struct  APPEARANCE
 
struct  AUTO_BACKUP
 
struct  DO_NOT_SHOW_AGAIN
 
struct  EMBED_FILE_DEFAULTS
 
struct  ENVIRONMENT
 
struct  GIT
 
struct  GIT_REPOSITORY
 
struct  GRAPHICS
 
struct  INPUT
 
struct  LEGACY_3D_SEARCH_PATH
 
struct  PACKAGE_MANAGER
 
struct  SESSION
 
struct  SPACEMOUSE
 
struct  SYSTEM
 

Public Member Functions

 COMMON_SETTINGS ()
 
virtual ~COMMON_SETTINGS ()
 
COMMON_SETTINGS_INTERNALS & CsInternals ()
 
const COMMON_SETTINGS_INTERNALS & CsInternals () const
 
virtual bool MigrateFromLegacy (wxConfigBase *aLegacyConfig) override
 Migrates from wxConfig to JSON-based configuration.
 
void InitializeEnvironment ()
 Creates the built-in environment variables and sets their default values.
 
bool AutosaveUsesLocalHistory () const
 The backup format is the single switch that selects the autosave mechanism: the incremental format records git local history while the zip format falls back to legacy recovery files.
 
wxString GetFilename () const
 
wxString GetFullFilename () const
 
void SetFilename (const wxString &aFilename)
 
void SetLocation (SETTINGS_LOC aLocation)
 
SETTINGS_LOC GetLocation () const
 
virtual const PROJECT * GetOwningProject () const
 Project-located settings override this to report the project they belong to so their save path is resolved against that project rather than the active one.
 
void SetLegacyFilename (const wxString &aFilename)
 
bool IsReadOnly () const
 
void SetReadOnly (bool aReadOnly)
 
bool ResetsParamsIfMissing () const
 
nlohmann::json & At (const std::string &aPath)
 Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these functions take a string that is passed to PointerFromString internally.
 
bool Contains (const std::string &aPath) const
 
JSON_SETTINGS_INTERNALS * Internals ()
 
virtual void Load ()
 Updates the parameters of this object based on the current JSON document contents.
 
virtual bool Store ()
 Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER.
 
virtual bool LoadFromFile (const wxString &aDirectory="")
 Loads the backing file from disk and then calls Load()
 
virtual bool SaveToFile (const wxString &aDirectory="", bool aForce=false)
 Calls Store() and then writes the contents of the JSON document to a file.
 
bool IsFileSynced () const
 
void ResetToDefaults ()
 Resets all parameters to default values.
 
std::optional< nlohmann::json > GetJson (const std::string &aPath) const
 Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects.
 
template<typename ValueType>
std::optional< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document.
 
template<>
std::optional< wxString > Get (const std::string &aPath) const
 
template<>
KICOMMON_API std::optional< wxString > Get (const std::string &aPath) const
 
template<typename ValueType>
void Set (const std::string &aPath, ValueType aVal)
 Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle.
 
template<>
void Set (const std::string &aPath, wxString aVal)
 
template<>
KICOMMON_API void Set (const std::string &aPath, wxString aVal)
 
virtual std::map< std::string, nlohmann::json > GetFileHistories ()
 
bool Migrate ()
 Migrates the schema of this settings from the version in the file to the latest version.
 
void AddNestedSettings (NESTED_SETTINGS *aSettings)
 Transfers ownership of a given NESTED_SETTINGS to this object.
 
void ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
 Saves and frees a nested settings object, if it exists within this one.
 
void SetManager (SETTINGS_MANAGER *aManager)
 
const std::string FormatAsString ()
 
bool LoadFromRawFile (const wxString &aPath)
 

Static Public Member Functions

static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, wxString &aTarget)
 Sets the given string if the given key/path is present.
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, bool &aTarget)
 Sets the given bool if the given key/path is present.
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, int &aTarget)
 Sets the given int if the given key/path is present.
 
static bool SetIfPresent (const nlohmann::json &aObj, const std::string &aPath, unsigned int &aTarget)
 Sets the given unsigned int if the given key/path is present.
 

Public Attributes

APPEARANCE m_Appearance
 
AUTO_BACKUP m_Backup
 
ENVIRONMENT m_Env
 
INPUT m_Input
 
SPACEMOUSE m_SpaceMouse
 
GRAPHICS m_Graphics
 
SESSION m_Session
 
SYSTEM m_System
 
DO_NOT_SHOW_AGAIN m_DoNotShowAgain
 
EMBED_FILE_DEFAULTS m_EmbedFileDefaults
 
PACKAGE_MANAGER m_PackageManager
 
GIT m_Git
 
API m_Api
 
std::vector< wxString > m_Extra3DSearchDirs
 Extra directories to search for 3D models, added by the user through the 3D model migration dialog.
 
std::unique_ptr< COMMON_SETTINGS_INTERNALS > m_csInternals
 

Protected Member Functions

void registerMigration (int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
 Registers a migration from one schema version to another.
 
template<typename ValueType>
bool fromLegacy (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig value to a given JSON pointer value.
 
bool fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy wxConfig string value to a given JSON pointer value.
 
bool fromLegacyColor (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
 Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value.
 
virtual wxString getFileExt () const
 
virtual wxString getLegacyFileExt () const
 

Static Protected Member Functions

template<typename ResultType>
static ResultType fetchOrDefault (const nlohmann::json &aJson, const std::string &aKey, ResultType aDefault=ResultType())
 Helper to retrieve a value from a JSON object (dictionary) as a certain result type.
 

Protected Attributes

wxString m_filename
 The filename (not including path) of this settings file (inicode)
 
wxString m_legacy_filename
 The filename of the wxConfig legacy file (if different from m_filename)
 
SETTINGS_LOC m_location
 The location of this settings file (.
 
std::vector< PARAM_BASE * > m_params
 The list of parameters (owned by this object)
 
std::vector< NESTED_SETTINGS * > m_nested_settings
 Nested settings files that live inside this one, if any.
 
bool m_createIfMissing
 Whether or not the backing store file should be created it if doesn't exist.
 
bool m_createIfDefault
 Whether or not the backing store file should be created if all parameters are still at their default values.
 
bool m_writeFile
 Whether or not the backing store file should be written.
 
bool m_modified
 True if the JSON data store has been written to since the last file write.
 
bool m_fileSynced
 True once the store has been synchronized with an on-disk file (loaded or saved)
 
bool m_deleteLegacyAfterMigration
 Whether or not to delete legacy file after migration.
 
bool m_resetParamsIfMissing
 Whether or not to set parameters to their default value if missing from JSON on Load()
 
int m_schemaVersion
 Version of this settings schema.
 
bool m_isFutureFormat
 Set to true if this settings is loaded from a file with a newer schema version than is known.
 
SETTINGS_MANAGER * m_manager
 A pointer to the settings manager managing this file (may be null)
 
std::map< int, std::pair< int, std::function< bool()> > > m_migrators
 A map of starting schema version to a pair of <ending version, migrator function>
 
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals
 

Private Member Functions

bool migrateSchema0to1 ()
 
bool migrateSchema1to2 ()
 
bool migrateSchema2to3 ()
 
bool migrateSchema3to4 ()
 
bool migrateSchema4to5 ()
 
bool migrateSchema5to6 ()
 
bool readLegacy3DResolverCfg (const wxString &aPath, std::vector< LEGACY_3D_SEARCH_PATH > &aSearchPaths)
 

Static Private Member Functions

static bool getLegacy3DHollerith (const std::string &aString, size_t &aIndex, wxString &aResult)
 

Detailed Description

Definition at line 57 of file common_settings.h.

Constructor & Destructor Documentation

◆ COMMON_SETTINGS()

COMMON_SETTINGS::COMMON_SETTINGS ( )

Definition at line 52 of file common_settings.cpp.

References AUTO, commonSchemaVersion, INCREMENTAL, JSON_SETTINGS::JSON_SETTINGS(), LIGHT, m_Api, m_Appearance, m_Backup, m_csInternals, m_DoNotShowAgain, m_Env, m_Graphics, m_Input, m_PackageManager, JSON_SETTINGS::m_params, m_Session, m_SpaceMouse, m_System, PROJECT_DIR, USER, USER_DIR, and ZIP.

◆ ~COMMON_SETTINGS()

COMMON_SETTINGS::~COMMON_SETTINGS ( )
virtualdefault

Member Function Documentation

◆ AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings ( NESTED_SETTINGS * aSettings)
inherited

Transfers ownership of a given NESTED_SETTINGS to this object.

Can be used to construct a NESTED_SETTINGS without the parent object needing to know about the implementation of the nested object;

Parameters
aSettingsis the settings object to take ownership of
aTargetis a pointer to update to the passed in settings

Definition at line 970 of file json_settings.cpp.

References GetFilename(), m_nested_settings, NESTED_SETTINGS, and traceSettings.

◆ At()

nlohmann::json & JSON_SETTINGS::At ( const std::string & aPath)
inherited

Wrappers for the underlying JSON API so that most consumers don't need json.hpp All of these functions take a string that is passed to PointerFromString internally.

Definition at line 128 of file json_settings.cpp.

References m_internals.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::migrateBomSettings(), GERBVIEW_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), and PCBNEW_SETTINGS::PCBNEW_SETTINGS().

◆ AutosaveUsesLocalHistory()

bool COMMON_SETTINGS::AutosaveUsesLocalHistory ( ) const
inline

The backup format is the single switch that selects the autosave mechanism: the incremental format records git local history while the zip format falls back to legacy recovery files.

Either mechanism requires backups to be enabled.

Returns
true when autosave should commit to the git local history.

Definition at line 233 of file common_settings.h.

References INCREMENTAL, and m_Backup.

Referenced by EDA_BASE_FRAME::doAutoSave(), KICAD_MANAGER_FRAME::doReCreateMenuBar(), PCB_EDIT_FRAME::doReCreateMenuBar(), SCH_EDIT_FRAME::doReCreateMenuBar(), localHistoryEnabled(), PCB_EDIT_FRAME::ProjectChanged(), and SCHEMATIC::SaveToHistory().

◆ Contains()

bool JSON_SETTINGS::Contains ( const std::string & aPath) const
inherited

Definition at line 134 of file json_settings.cpp.

References m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), GERBVIEW_SETTINGS::GetFileHistories(), GetFileHistories(), BOARD_DESIGN_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::migrateBomSettings(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema5to6(), and SETTINGS_MANAGER::SaveColorSettings().

◆ CsInternals() [1/2]

COMMON_SETTINGS_INTERNALS & COMMON_SETTINGS::CsInternals ( )
inline

Definition at line 216 of file common_settings.h.

References m_csInternals.

Referenced by DIALOG_GIT_COMMIT::DIALOG_GIT_COMMIT(), DIALOG_SHIM::LoadControlState(), DIALOG_SHIM::SaveControlState(), and DIALOG_GIT_COMMIT::~DIALOG_GIT_COMMIT().

◆ CsInternals() [2/2]

const COMMON_SETTINGS_INTERNALS & COMMON_SETTINGS::CsInternals ( ) const
inline

Definition at line 217 of file common_settings.h.

References m_csInternals.

◆ fetchOrDefault()

template<typename ResultType>
template KICOMMON_API bool JSON_SETTINGS::fetchOrDefault ( const nlohmann::json & aJson,
const std::string & aKey,
ResultType aDefault = ResultType() )
staticprotectedinherited

Helper to retrieve a value from a JSON object (dictionary) as a certain result type.

Template Parameters
ResultTypeis the type of the retrieved value.
Parameters
aJsonis the object to act on .
aKeyis the object key to retrieve the value for.
Returns
the result, or aDefault if aKey is not found.

Definition at line 1023 of file json_settings.cpp.

◆ FormatAsString()

const std::string JSON_SETTINGS::FormatAsString ( )
inherited

Definition at line 601 of file json_settings.cpp.

References dummy, m_internals, and Store().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ fromLegacy()

template<typename ValueType>
template KICOMMON_API bool JSON_SETTINGS::fromLegacy< bool > ( wxConfigBase * aConfig,
const std::string & aKey,
const std::string & aDest )
protectedinherited

Translates a legacy wxConfig value to a given JSON pointer value.

Template Parameters
ValueTypeis the basic type of the value
Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 879 of file json_settings.cpp.

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy(), BITMAP2CMP_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), CVPCB_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PL_EDITOR_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyColor()

bool JSON_SETTINGS::fromLegacyColor ( wxConfigBase * aConfig,
const std::string & aKey,
const std::string & aDest )
protectedinherited

Translates a legacy COLOR4D stored in a wxConfig string to a given JSON pointer value.

Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 942 of file json_settings.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::b, KIGFX::COLOR4D::g, KIGFX::COLOR4D::r, and KIGFX::COLOR4D::SetFromWxString().

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

◆ fromLegacyString()

bool JSON_SETTINGS::fromLegacyString ( wxConfigBase * aConfig,
const std::string & aKey,
const std::string & aDest )
protectedinherited

Translates a legacy wxConfig string value to a given JSON pointer value.

Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 918 of file json_settings.cpp.

Referenced by APP_SETTINGS_BASE::MigrateFromLegacy(), BITMAP2CMP_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), and APP_SETTINGS_BASE::migrateWindowConfig().

◆ Get() [1/3]

template<>
std::optional< wxString > JSON_SETTINGS::Get ( const std::string & aPath) const
inherited

Definition at line 1006 of file json_settings.cpp.

References GetJson().

◆ Get() [2/3]

template<typename ValueType>
template KICOMMON_API std::optional< wxAuiPaneInfo > JSON_SETTINGS::Get< wxAuiPaneInfo > ( const std::string & aPath) const
inherited

Fetches a value from within the JSON document.

Will return an empty optional if the value is not found or a mismatching type.

Template Parameters
ValueTypeis the type to cast to
Parameters
aPathis the path within the document to retrieve
Returns
a value from within this document

Definition at line 666 of file json_settings.cpp.

References GetJson().

Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), BOOST_AUTO_TEST_CASE(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), JSON_SETTINGS::Get< KIGFX::COLOR4D >(), JSON_SETTINGS::Get< KIGFX::CROSS_HAIR_MODE >(), JSON_SETTINGS::Get< nlohmann::json >(), JSON_SETTINGS::Get< std::string >(), COLOR_MAP_PARAM::Load(), PARAM< ValueType >::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< ValueType >::Load(), PARAM_SCALED< ValueType >::Load(), COLOR_MAP_PARAM::MatchesFile(), PARAM< ValueType >::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), EESCHEMA_SETTINGS::migrateBomSettings(), COMMON_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::migrateLibTreeWidth(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::SaveAs(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ Get() [3/3]

template<>
template std::optional< wxAuiPaneInfo > JSON_SETTINGS::Get< wxAuiPaneInfo > ( const std::string & aPath) const
inherited

References KICOMMON_API.

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in DATABASE_LIB_SETTINGS, HTTP_LIB_SETTINGS, JOBSET, PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 312 of file json_settings.h.

Referenced by GetFullFilename(), LoadFromFile(), and SaveToFile().

◆ GetFileHistories()

std::map< std::string, nlohmann::json > JSON_SETTINGS::GetFileHistories ( )
virtualinherited

Reimplemented in GERBVIEW_SETTINGS.

Definition at line 430 of file json_settings.cpp.

References Contains(), and GetJson().

Referenced by GERBVIEW_SETTINGS::GetFileHistories().

◆ GetFilename()

wxString JSON_SETTINGS::GetFilename ( ) const
inlineinherited

Definition at line 88 of file json_settings.h.

References m_filename.

Referenced by AddNestedSettings(), SETTINGS_MANAGER::loadAllColorSettings(), SETTINGS_MANAGER::loadColorSettingsByName(), NESTED_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), PANEL_GERBVIEW_COLOR_SETTINGS::PANEL_GERBVIEW_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), PCB_PLOTTER::PlotJobToPlotOpts(), DIALOG_PLOT_SCHEMATIC::plotSchematic(), PROJECT_FILE::SaveAs(), SETTINGS_MANAGER::SaveColorSettings(), DIALOG_PRINT::SavePrintOptions(), DIALOG_PRINT_PCBNEW::saveSettings(), NESTED_SETTINGS::SaveToFile(), PANEL_PL_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), and PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow().

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 119 of file json_settings.cpp.

References getFileExt(), and m_filename.

Referenced by JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), and SaveToFile().

◆ GetJson()

std::optional< nlohmann::json > JSON_SETTINGS::GetJson ( const std::string & aPath) const
inherited

Fetches a JSON object that is a subset of this JSON_SETTINGS object, using a path of the form "key1.key2.key3" to refer to nested objects.

Parameters
aPathis a string containing one or more keys separated by '.'
Returns
a JSON object from within this one

Definition at line 646 of file json_settings.cpp.

References m_internals.

Referenced by Get(), GERBVIEW_SETTINGS::GetFileHistories(), GetFileHistories(), PARAM_LAMBDA< ValueType >::Load(), PARAM_LIST< Type >::Load(), PARAM_MAP< Value >::Load(), PARAM_SET< Type >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< Type >::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_SET< Type >::MatchesFile(), PARAM_WXSTRING_MAP::MatchesFile(), and SETTINGS_MANAGER::SaveColorSettings().

◆ getLegacy3DHollerith()

bool COMMON_SETTINGS::getLegacy3DHollerith ( const std::string & aString,
size_t & aIndex,
wxString & aResult )
staticprivate

Definition at line 976 of file common_settings.cpp.

References traceSettings.

Referenced by readLegacy3DResolverCfg().

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 317 of file json_settings.h.

Referenced by LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 95 of file json_settings.h.

References m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile(), and COLOR_SETTINGS::migrateSchema0to1().

◆ GetOwningProject()

virtual const PROJECT * JSON_SETTINGS::GetOwningProject ( ) const
inlinevirtualinherited

Project-located settings override this to report the project they belong to so their save path is resolved against that project rather than the active one.

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 101 of file json_settings.h.

References PROJECT.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ InitializeEnvironment()

void COMMON_SETTINGS::InitializeEnvironment ( )

Creates the built-in environment variables and sets their default values.

Definition at line 840 of file common_settings.cpp.

References PATHS::GetDefault3rdPartyPath(), PATHS::GetStock3dmodelsPath(), PATHS::GetStockDesignBlocksPath(), PATHS::GetStockFootprintsPath(), PATHS::GetStockSymbolsPath(), PATHS::GetStockTemplatesPath(), PATHS::GetUserTemplatesPath(), ENV_VAR::GetVersionedEnvVarName(), m_Env, and traceEnvVars.

Referenced by PGM_BASE::InitPgm().

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )
inherited

Definition at line 140 of file json_settings.cpp.

References m_internals.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), NET_SETTINGS::CopyFrom(), COLOR_SETTINGS::migrateSchema0to1(), PCBNEW_JOBS_HANDLER::runPcbMerge(), EESCHEMA_JOBS_HANDLER::runSchMerge(), and SETTINGS_MANAGER::SaveColorSettings().

◆ IsFileSynced()

bool JSON_SETTINGS::IsFileSynced ( ) const
inlineinherited
Returns
true once the in-memory store has been synchronized with an on-disk file, either by loading an existing file or by a successful save

Definition at line 156 of file json_settings.h.

References m_fileSynced.

Referenced by reloadFromFile().

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const
inlineinherited

Definition at line 105 of file json_settings.h.

References m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::GetSettingsDropdownName(), PANEL_COLOR_SETTINGS::OnThemeChanged(), APPEARANCE_CONTROLS::rebuildLayers(), SETTINGS_MANAGER::SaveColorSettings(), and APPEARANCE_CONTROLS::syncColorsAndVisibility().

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

Updates the parameters of this object based on the current JSON document contents.

Definition at line 146 of file json_settings.cpp.

References m_params, m_resetParamsIfMissing, and traceSettings.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), NET_SETTINGS::CopyFrom(), COLOR_SETTINGS::CreateBuiltinColorSettings(), BOARD_DESIGN_SETTINGS::LoadFromFile(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), LoadFromRawFile(), PCB_TEST_FRAME_BASE::LoadSettings(), PCBNEW_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_3D_DISPLAY_OPTIONS::ResetPanel(), PANEL_3D_OPENGL_OPTIONS::ResetPanel(), PANEL_3D_RAYTRACING_OPTIONS::ResetPanel(), PANEL_DISPLAY_OPTIONS::ResetPanel(), PANEL_EDIT_OPTIONS::ResetPanel(), PANEL_EESCHEMA_DISPLAY_OPTIONS::ResetPanel(), PANEL_EESCHEMA_EDITING_OPTIONS::ResetPanel(), PANEL_FP_EDITOR_FIELD_DEFAULTS::ResetPanel(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::ResetPanel(), PANEL_FP_USER_LAYER_NAMES::ResetPanel(), PANEL_GERBVIEW_DISPLAY_OPTIONS::ResetPanel(), PANEL_PCBNEW_DISPLAY_ORIGIN::ResetPanel(), PANEL_PL_EDITOR_DISPLAY_OPTIONS::ResetPanel(), PANEL_SYM_DISPLAY_OPTIONS::ResetPanel(), PANEL_SYM_EDITING_OPTIONS::ResetPanel(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadFromFile()

bool JSON_SETTINGS::LoadFromFile ( const wxString & aDirectory = "")
virtualinherited

Loads the backing file from disk and then calls Load()

Parameters
aDirectoryis the path to the file
Returns
true if the file was found on disk and loaded or migrated

Reimplemented in BOARD_DESIGN_SETTINGS, NESTED_SETTINGS, and PROJECT_FILE.

Definition at line 163 of file json_settings.cpp.

References getFileExt(), GetFullFilename(), getLegacyFileExt(), Load(), m_deleteLegacyAfterMigration, m_filename, m_fileSynced, m_internals, m_isFutureFormat, m_legacy_filename, m_modified, m_nested_settings, m_schemaVersion, m_writeFile, Migrate(), MigrateFromLegacy(), NESTED_SETTINGS, path, SaveToFile(), and traceSettings.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), CLI::JOBSET_RUN_COMMAND::doPerform(), PROJECT_FILE::LoadFromFile(), SETTINGS_MANAGER::LoadProject(), SETTINGS_MANAGER::MigrateFromPreviousVersion(), PROJECT_TREE_TRAVERSER::OnFile(), reloadFromFile(), and SETTINGS_MANAGER::SaveColorSettings().

◆ LoadFromRawFile()

bool JSON_SETTINGS::LoadFromRawFile ( const wxString & aPath)
inherited

Definition at line 614 of file json_settings.cpp.

References Load(), m_internals, and traceSettings.

◆ Migrate()

bool JSON_SETTINGS::Migrate ( )
inherited

Migrates the schema of this settings from the version in the file to the latest version.

Schema migration doesn't need to be used every time a setting is added! This is intended to be more of an "escape hatch" in the event that we decide to move settings around or make other changes to a settings file format that can't simply be handled by loading a new default

Returns
true if migration was successful

Definition at line 769 of file json_settings.cpp.

References m_internals, m_migrators, m_schemaVersion, and traceSettings.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), LoadFromFile(), and NESTED_SETTINGS::LoadFromFile().

◆ MigrateFromLegacy()

bool COMMON_SETTINGS::MigrateFromLegacy ( wxConfigBase * aLegacyConfig)
overridevirtual

Migrates from wxConfig to JSON-based configuration.

Should be implemented by any subclasses of JSON_SETTINGS that map to a legacy (wxConfig-based) config file.

Parameters
aLegacyConfigis a wxConfigBase holding a loaded configuration to migrate
Returns
true if migration was successful

Reimplemented from JSON_SETTINGS.

Definition at line 758 of file common_settings.cpp.

References JSON_SETTINGS::fromLegacy(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::Get(), index, JSON_SETTINGS::m_internals, JSON_SETTINGS::Set(), traceSettings, and versionedEnvVarRegex().

◆ migrateSchema0to1()

bool COMMON_SETTINGS::migrateSchema0to1 ( )
private

Schema version 0 to 1:

mousewheel_pan is replaced by explicit settings for scroll wheel behavior

Definition at line 518 of file common_settings.cpp.

References JSON_SETTINGS::m_internals, and traceSettings.

◆ migrateSchema1to2()

bool COMMON_SETTINGS::migrateSchema1to2 ( )
private

Definition at line 560 of file common_settings.cpp.

References DRAG_ANY, JSON_SETTINGS::m_internals, SELECT, and traceSettings.

◆ migrateSchema2to3()

bool COMMON_SETTINGS::migrateSchema2to3 ( )
private

Definition at line 587 of file common_settings.cpp.

References PATHS::GetUserSettingsPath(), m_Env, path, readLegacy3DResolverCfg(), and traceEnvVars.

◆ migrateSchema3to4()

bool COMMON_SETTINGS::migrateSchema3to4 ( )
private

Definition at line 634 of file common_settings.cpp.

References JSON_SETTINGS::m_internals, and traceSettings.

◆ migrateSchema4to5()

bool COMMON_SETTINGS::migrateSchema4to5 ( )
private

Definition at line 694 of file common_settings.cpp.

References JSON_SETTINGS::m_internals, and traceSettings.

◆ migrateSchema5to6()

bool COMMON_SETTINGS::migrateSchema5to6 ( )
private

Definition at line 734 of file common_settings.cpp.

References JSON_SETTINGS::Contains(), JSON_SETTINGS::Set(), traceSettings, and ZIP.

◆ readLegacy3DResolverCfg()

bool COMMON_SETTINGS::readLegacy3DResolverCfg ( const wxString & aPath,
std::vector< LEGACY_3D_SEARCH_PATH > & aSearchPaths )
private

Definition at line 875 of file common_settings.cpp.

References FN_NORMALIZE_FLAGS, getLegacy3DHollerith(), ENV_VAR::GetVersionedEnvVarName(), COMMON_SETTINGS::LEGACY_3D_SEARCH_PATH::m_Alias, COMMON_SETTINGS::LEGACY_3D_SEARCH_PATH::m_Description, COMMON_SETTINGS::LEGACY_3D_SEARCH_PATH::m_Pathvar, path, and traceSettings.

Referenced by migrateSchema2to3().

◆ registerMigration()

void JSON_SETTINGS::registerMigration ( int aOldSchemaVersion,
int aNewSchemaVersion,
std::function< bool(void)> aMigrator )
protectedinherited

Registers a migration from one schema version to another.

If the schema version in the file loaded from disk is less than the schema version of the JSON_SETTINGS class, migration functions will be called one after the other until the data is up-to-date.

Parameters
aOldSchemaVersionis the starting schema version for this migration
aNewSchemaVersionis the ending schema version for this migration
aMigratoris a function that performs the migration and returns true if successful

Definition at line 760 of file json_settings.cpp.

References m_migrators, and m_schemaVersion.

Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), MIGRATING_NESTED_SETTINGS::MIGRATING_NESTED_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::PROJECT_FILE(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), and TUNING_PROFILES::TUNING_PROFILES().

◆ ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS * aSettings)
inherited

Saves and frees a nested settings object, if it exists within this one.

Parameters
aSettingsis a pointer to a NESTED_SETTINGS that has already been added to this one

Definition at line 977 of file json_settings.cpp.

References JSON_SETTINGS(), m_manager, m_modified, m_nested_settings, NESTED_SETTINGS, NESTED_SETTINGS::SetParent(), and traceSettings.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ~JSON_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().

◆ ResetsParamsIfMissing()

bool JSON_SETTINGS::ResetsParamsIfMissing ( ) const
inlineinherited
Returns
true if a param absent from the file is reset to its default on load, meaning an absent key whose value equals the default is a faithful round-trip of the file. When false (e.g. board design settings), an absent key preserves the loaded value, so absent-and-default must still be treated as a change.

Definition at line 114 of file json_settings.h.

References m_resetParamsIfMissing.

Referenced by COLOR_MAP_PARAM::MatchesFile(), PARAM< ValueType >::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), PARAM_LIST< Type >::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_SCALED< ValueType >::MatchesFile(), PARAM_SET< Type >::MatchesFile(), and PARAM_WXSTRING_MAP::MatchesFile().

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 423 of file json_settings.cpp.

References m_params.

Referenced by BOOST_AUTO_TEST_CASE(), PANEL_COMMON_SETTINGS::ResetPanel(), PANEL_MAINTENANCE::ResetPanel(), PANEL_MOUSE_SETTINGS::ResetPanel(), and PANEL_SPACEMOUSE::ResetPanel().

◆ SaveToFile()

bool JSON_SETTINGS::SaveToFile ( const wxString & aDirectory = "",
bool aForce = false )
virtualinherited

Calls Store() and then writes the contents of the JSON document to a file.

Parameters
aDirectoryis the directory to save to, including trailing separator
Returns
true if the file was saved

Reimplemented in JOBSET, NESTED_SETTINGS, PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 444 of file json_settings.cpp.

References KIPLATFORM::IO::AtomicWriteFile(), dummy, getFileExt(), GetFullFilename(), m_createIfDefault, m_createIfMissing, m_filename, m_fileSynced, m_internals, m_modified, m_nested_settings, m_params, m_writeFile, NESTED_SETTINGS, path, JSON_SETTINGS_INTERNALS::PointerFromString(), Store(), and traceSettings.

Referenced by STARTWIZARD_PROVIDER_SETTINGS::ApplyDefaults(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KICAD_MANAGER_FRAME::CreateNewProject(), STARTWIZARD_PROVIDER_SETTINGS::Finish(), LoadFromFile(), KICAD_MANAGER_FRAME::LoadProject(), SETTINGS_MANAGER::MigrateFromPreviousVersion(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PROJECT::PinLibrary(), reloadFromFile(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveColorSettings(), JOBSET::SaveToFile(), PROJECT_FILE::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PGM_BASE::SetLanguage(), and PROJECT::UnpinLibrary().

◆ Set() [1/3]

template<typename ValueType>
template KICOMMON_API void JSON_SETTINGS::Set< wxAuiPaneInfo > ( const std::string & aPath,
ValueType aVal )
inherited

Stores a value into the JSON document Will throw an exception if ValueType isn't something that the library can handle.

Template Parameters
ValueTypeis the type to store
Parameters
aPathis a path to store in the form "key1.key2.key3"
aValis the value to store

Definition at line 721 of file json_settings.cpp.

References m_internals.

Referenced by BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), JSON_SETTINGS::Set< KIGFX::COLOR4D >(), JSON_SETTINGS::Set< KIGFX::CROSS_HAIR_MODE >(), JSON_SETTINGS::Set< nlohmann::json >(), JSON_SETTINGS::Set< std::string >(), BOARD_DESIGN_SETTINGS::LoadFromFile(), APP_SETTINGS_BASE::migrateFindReplace(), APP_SETTINGS_BASE::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema5to6(), MIGRATING_NESTED_SETTINGS::MIGRATING_NESTED_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), PROJECT_FILE::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), COLOR_MAP_PARAM::Store(), PARAM< ValueType >::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_LIST< Type >::Store(), PARAM_MAP< Value >::Store(), PARAM_PATH::Store(), PARAM_PATH_LIST::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_SET< Type >::Store(), and PARAM_WXSTRING_MAP::Store().

◆ Set() [2/3]

template<>
void JSON_SETTINGS::Set ( const std::string & aPath,
wxString aVal )
inherited

Definition at line 1016 of file json_settings.cpp.

◆ Set() [3/3]

template<>
KICOMMON_API void JSON_SETTINGS::Set ( const std::string & aPath,
wxString aVal )
inherited

References KICOMMON_API.

◆ SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString & aFilename)
inlineinherited

Definition at line 92 of file json_settings.h.

References m_filename.

Referenced by SETTINGS_MANAGER::GetColorSettings(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveProjectAs(), and SETTINGS_MANAGER::SaveProjectCopy().

◆ SetIfPresent() [1/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json & aObj,
const std::string & aPath,
bool & aTarget )
staticinherited

Sets the given bool if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 833 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [2/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json & aObj,
const std::string & aPath,
int & aTarget )
staticinherited

Sets the given int if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 848 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [3/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json & aObj,
const std::string & aPath,
unsigned int & aTarget )
staticinherited

Sets the given unsigned int if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 863 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [4/4]

bool JSON_SETTINGS::SetIfPresent ( const nlohmann::json & aObj,
const std::string & aPath,
wxString & aTarget )
staticinherited

Sets the given string if the given key/path is present.

Parameters
aObjis the source object
aTargetis the storage destination
Returns
True if set, false if not

Definition at line 818 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const wxString & aFilename)
inlineinherited

Definition at line 103 of file json_settings.h.

References m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC aLocation)
inlineinherited

Definition at line 94 of file json_settings.h.

References m_location.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), and COLOR_SETTINGS::migrateSchema0to1().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER * aManager)
inlineinherited

Definition at line 228 of file json_settings.h.

References m_manager.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool aReadOnly)
inlineinherited

Definition at line 106 of file json_settings.h.

References m_writeFile.

Referenced by SETTINGS_MANAGER::GetColorSettings(), SETTINGS_MANAGER::loadAllColorSettings(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PROJECT_FILE::SaveAs(), and SETTINGS_MANAGER::SaveProjectAs().

◆ Store()

bool JSON_SETTINGS::Store ( )
virtualinherited

Stores the current parameters into the JSON document represented by this object Note: this doesn't do any writing to disk; that's handled by SETTINGS_MANAGER.

Returns
true if any part of the JSON document has been updated since the last save to disk

Definition at line 403 of file json_settings.cpp.

References m_modified, m_params, and traceSettings.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), NET_SETTINGS::CopyFrom(), FormatAsString(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), PCBNEW_JOBS_HANDLER::runPcbMerge(), EESCHEMA_JOBS_HANDLER::runSchMerge(), SETTINGS_MANAGER::SaveColorSettings(), SaveToFile(), and NESTED_SETTINGS::SaveToFile().

Member Data Documentation

◆ m_Api

API COMMON_SETTINGS::m_Api

Definition at line 272 of file common_settings.h.

Referenced by COMMON_SETTINGS(), EDA_BASE_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::configureToolbars(), SCH_EDIT_FRAME::configureToolbars(), PGM_BASE::InitPgm(), PLUGIN_CONTENT_MANAGER::ShowApiEnablePromptIfNeeded(), PANEL_PLUGIN_SETTINGS::TransferDataFromWindow(), and PANEL_PLUGIN_SETTINGS::TransferDataToWindow().

◆ m_Appearance

APPEARANCE COMMON_SETTINGS::m_Appearance

Definition at line 260 of file common_settings.h.

Referenced by ACTION_TOOLBAR::Add(), ACTION_TOOLBAR_PALETTE::AddAction(), KIUI::AddBitmapToMenuItem(), ACTION_TOOLBAR::AddButton(), ACTION_TOOLBAR::AddGroup(), PANEL_COMMON_SETTINGS::applySettingsToPanel(), COMMON_SETTINGS(), EDA_DRAW_FRAME::CommonSettingsChanged(), KICAD_MANAGER_FRAME::CommonSettingsChanged(), KIGFX::GAL::computeWorldScale(), ACTION_TOOLBAR::doSelectAction(), getKiCadConfiguredScale(), KIGFX::PCB_RENDER_SETTINGS::LoadColors(), EDA_DRAW_FRAME::LoadSettings(), PCB_EDIT_FRAME::PrepareLayerIndicator(), ACTION_TOOLBAR::RefreshBitmaps(), PANEL_COMMON_SETTINGS::TransferDataFromWindow(), PANEL_PCBNEW_ACTION_PLUGINS::TransferDataToWindow(), and PANEL_SETUP_RULES::~PANEL_SETUP_RULES().

◆ m_Backup

AUTO_BACKUP COMMON_SETTINGS::m_Backup

Definition at line 261 of file common_settings.h.

Referenced by PANEL_COMMON_SETTINGS::applySettingsToPanel(), AutosaveUsesLocalHistory(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), KICAD_MANAGER_FRAME::CloseProject(), COMMON_SETTINGS(), EDA_BASE_FRAME::doAutoSave(), findAutosaveFilePairs(), SETTINGS_MANAGER::GetAutosaveRootForProject(), SETTINGS_MANAGER::GetBackupRootForProject(), SETTINGS_MANAGER::GetLocalHistoryDirForProject(), LOCAL_HISTORY::RunRegisteredSaversAsAutosaveFiles(), PANEL_COMMON_SETTINGS::TransferDataFromWindow(), and SETTINGS_MANAGER::TriggerBackupIfNeeded().

◆ m_createIfDefault

bool JSON_SETTINGS::m_createIfDefault
protectedinherited

Whether or not the backing store file should be created if all parameters are still at their default values.

Ignored if m_createIfMissing is false or m_writeFile is false.

Definition at line 355 of file json_settings.h.

Referenced by JSON_SETTINGS(), and SaveToFile().

◆ m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing
protectedinherited

Whether or not the backing store file should be created it if doesn't exist.

Definition at line 349 of file json_settings.h.

Referenced by JSON_SETTINGS(), and SaveToFile().

◆ m_csInternals

std::unique_ptr<COMMON_SETTINGS_INTERNALS> COMMON_SETTINGS::m_csInternals

Definition at line 278 of file common_settings.h.

Referenced by COMMON_SETTINGS(), CsInternals(), and CsInternals().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration
protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 367 of file json_settings.h.

Referenced by JSON_SETTINGS(), LoadFromFile(), PROJECT_FILE::PROJECT_FILE(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ m_DoNotShowAgain

DO_NOT_SHOW_AGAIN COMMON_SETTINGS::m_DoNotShowAgain

Definition at line 268 of file common_settings.h.

Referenced by STARTWIZARD_PROVIDER_PRIVACY::ApplyDefaults(), COMMON_SETTINGS(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), STARTWIZARD_PROVIDER_PRIVACY::Finish(), STARTWIZARD_PROVIDER_PRIVACY::NeedsUserInput(), DIALOG_CONFIGURE_PATHS::OnGridCellChanging(), and PCB_CONTROL::unfilledZoneCheck().

◆ m_EmbedFileDefaults

EMBED_FILE_DEFAULTS COMMON_SETTINGS::m_EmbedFileDefaults

Definition at line 269 of file common_settings.h.

Referenced by FILEDLG_HOOK_EMBED_FILE::choiceRef().

◆ m_Env

ENVIRONMENT COMMON_SETTINGS::m_Env

Definition at line 262 of file common_settings.h.

Referenced by BOOST_AUTO_TEST_CASE(), COMMON_SETTINGS(), PGM_BASE::GetLocalEnvVariables(), InitializeEnvironment(), SETTINGS_MANAGER::MigrateFromPreviousVersion(), and migrateSchema2to3().

◆ m_Extra3DSearchDirs

std::vector<wxString> COMMON_SETTINGS::m_Extra3DSearchDirs

Extra directories to search for 3D models, added by the user through the 3D model migration dialog.

Persists across sessions.

Definition at line 276 of file common_settings.h.

Referenced by DIALOG_MIGRATE_3D_MODELS::buildCatalog(), and DIALOG_MIGRATE_3D_MODELS::OnAddSearchDirectoryClick().

◆ m_filename

wxString JSON_SETTINGS::m_filename
protectedinherited

The filename (not including path) of this settings file (inicode)

Definition at line 334 of file json_settings.h.

Referenced by APP_SETTINGS_BASE::addParamsForWindow(), COLOR_SETTINGS::COLOR_SETTINGS(), APP_SETTINGS_BASE::DefaultGridSizeList(), APP_SETTINGS_BASE::DefaultZoomList(), GetFilename(), GetFullFilename(), JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::operator=(), SaveToFile(), NESTED_SETTINGS::SaveToFile(), and SetFilename().

◆ m_fileSynced

bool JSON_SETTINGS::m_fileSynced
protectedinherited

True once the store has been synchronized with an on-disk file (loaded or saved)

Definition at line 364 of file json_settings.h.

Referenced by IsFileSynced(), JSON_SETTINGS(), LoadFromFile(), and SaveToFile().

◆ m_Git

GIT COMMON_SETTINGS::m_Git

Definition at line 271 of file common_settings.h.

Referenced by GIT_CONFIG_HANDLER::GetUserConfig(), PROJECT_TREE_PANE::onGitSyncTimer(), PROJECT_TREE_PANE::onRight(), PANEL_GIT_REPOS::TransferDataFromWindow(), and PANEL_GIT_REPOS::TransferDataToWindow().

◆ m_Graphics

GRAPHICS COMMON_SETTINGS::m_Graphics

Definition at line 265 of file common_settings.h.

Referenced by PANEL_COMMON_SETTINGS::applySettingsToPanel(), COMMON_SETTINGS(), EDA_DRAW_FRAME::loadCanvasTypeSetting(), PANEL_EESCHEMA_COLOR_SETTINGS::PANEL_EESCHEMA_COLOR_SETTINGS(), GAL_DISPLAY_OPTIONS_IMPL::ReadCommonConfig(), and PANEL_COMMON_SETTINGS::TransferDataFromWindow().

◆ m_Input

INPUT COMMON_SETTINGS::m_Input

Definition at line 263 of file common_settings.h.

Referenced by PANEL_COMMON_SETTINGS::applySettingsToPanel(), PANEL_MOUSE_SETTINGS::applySettingsToPanel(), COMMON_SETTINGS(), TOOLS_HOLDER::CommonSettingsChanged(), EDA_DRAW_PANEL_GAL::GetVcSettings(), SCH_DRAWING_TOOLS::ImportSheet(), EDA_3D_VIEWER_FRAME::loadCommonSettings(), KIGFX::WX_VIEW_CONTROLS::LoadSettings(), PANEL_PREVIEW_3D_MODEL::loadSettings(), EESCHEMA_SETTINGS::MigrateFromLegacy(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceReferenceImage(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), PANEL_COMMON_SETTINGS::TransferDataFromWindow(), PANEL_MOUSE_SETTINGS::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ m_internals

std::unique_ptr<JSON_SETTINGS_INTERNALS> JSON_SETTINGS::m_internals
protectedinherited

Definition at line 384 of file json_settings.h.

Referenced by At(), Contains(), FormatAsString(), GetJson(), Internals(), JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), LoadFromRawFile(), Migrate(), COMMON_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COLOR_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema0to1(), EDA_3D_VIEWER_SETTINGS::migrateSchema0to1(), NET_SETTINGS::migrateSchema0to1(), TUNING_PROFILES::migrateSchema0to1(), PROJECT_FILE::migrateSchema1To2(), COMMON_SETTINGS::migrateSchema1to2(), TUNING_PROFILES::migrateSchema1to2(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema2To3(), PROJECT_FILE::migrateSchema2To3(), NET_SETTINGS::migrateSchema2to3(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema3To4(), COMMON_SETTINGS::migrateSchema3to4(), NET_SETTINGS::migrateSchema3to4(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema4To5(), COMMON_SETTINGS::migrateSchema4to5(), NET_SETTINGS::migrateSchema4to5(), SaveToFile(), NESTED_SETTINGS::SaveToFile(), and Set().

◆ m_isFutureFormat

bool JSON_SETTINGS::m_isFutureFormat
protectedinherited

Set to true if this settings is loaded from a file with a newer schema version than is known.

Definition at line 376 of file json_settings.h.

Referenced by JSON_SETTINGS(), LoadFromFile(), PROJECT_FILE::ShouldAutoSave(), and PROJECT_LOCAL_SETTINGS::ShouldAutoSave().

◆ m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename
protectedinherited

The filename of the wxConfig legacy file (if different from m_filename)

Definition at line 337 of file json_settings.h.

Referenced by JSON_SETTINGS(), LoadFromFile(), and SetLegacyFilename().

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location
protectedinherited

The location of this settings file (.

See also
SETTINGS_LOC)

Definition at line 340 of file json_settings.h.

Referenced by GetLocation(), JSON_SETTINGS(), and SetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

A pointer to the settings manager managing this file (may be null)

Definition at line 379 of file json_settings.h.

Referenced by JSON_SETTINGS(), COLOR_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), ReleaseNestedSettings(), and SetManager().

◆ m_migrators

std::map<int, std::pair<int, std::function<bool()> > > JSON_SETTINGS::m_migrators
protectedinherited

A map of starting schema version to a pair of <ending version, migrator function>

Definition at line 382 of file json_settings.h.

Referenced by Migrate(), and registerMigration().

◆ m_modified

bool JSON_SETTINGS::m_modified
protectedinherited

True if the JSON data store has been written to since the last file write.

Definition at line 361 of file json_settings.h.

Referenced by TEST_JSON_SETTINGS::ClearModified(), DISK_SETTINGS::ForceModified(), TEST_JSON_SETTINGS::IsModified(), JSON_SETTINGS(), LoadFromFile(), ReleaseNestedSettings(), SaveToFile(), and Store().

◆ m_nested_settings

std::vector<NESTED_SETTINGS*> JSON_SETTINGS::m_nested_settings
protectedinherited

Nested settings files that live inside this one, if any.

Definition at line 346 of file json_settings.h.

Referenced by AddNestedSettings(), LoadFromFile(), ReleaseNestedSettings(), SaveToFile(), and ~JSON_SETTINGS().

◆ m_PackageManager

PACKAGE_MANAGER COMMON_SETTINGS::m_PackageManager

Definition at line 270 of file common_settings.h.

Referenced by COMMON_SETTINGS(), PANEL_PACKAGES_VIEW::SetSashOnIdle(), and PANEL_PACKAGES_VIEW::~PANEL_PACKAGES_VIEW().

◆ m_params

std::vector<PARAM_BASE*> JSON_SETTINGS::m_params
protectedinherited

The list of parameters (owned by this object)

Definition at line 343 of file json_settings.h.

Referenced by APP_SETTINGS_BASE::addParamsForWindow(), APP_SETTINGS_BASE::APP_SETTINGS_BASE(), BITMAP2CMP_SETTINGS::BITMAP2CMP_SETTINGS(), BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), COMMON_SETTINGS::COMMON_SETTINGS(), COMPONENT_CLASS_SETTINGS::COMPONENT_CLASS_SETTINGS(), COLOR_SETTINGS::CreateBuiltinColorSettings(), CVPCB_SETTINGS::CVPCB_SETTINGS(), DATABASE_LIB_SETTINGS::DATABASE_LIB_SETTINGS(), DISK_PARENT_SETTINGS::DISK_PARENT_SETTINGS(), DISK_SETTINGS::DISK_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), ERC_SETTINGS::ERC_SETTINGS(), FLUSH_TEST_SETTINGS::FLUSH_TEST_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), GERBVIEW_SETTINGS::GERBVIEW_SETTINGS(), COLOR_SETTINGS::GetDefaultColor(), HTTP_LIB_SETTINGS::HTTP_LIB_SETTINGS(), COLOR_SETTINGS::initFromOther(), JOBSET::JOBSET(), JSON_SETTINGS(), KICAD_SETTINGS::KICAD_SETTINGS(), Load(), NET_SETTINGS::NET_SETTINGS(), NGSPICE_SETTINGS::NGSPICE_SETTINGS(), PCB_CALCULATOR_SETTINGS::PCB_CALCULATOR_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PL_EDITOR_SETTINGS::PL_EDITOR_SETTINGS(), PROJECT_FILE::PROJECT_FILE(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), ResetToDefaults(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), SaveToFile(), NESTED_SETTINGS::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SPICE_SETTINGS::SPICE_SETTINGS(), Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), TEST_NESTED_SETTINGS::TEST_NESTED_SETTINGS(), TOOLBAR_SETTINGS::TOOLBAR_SETTINGS(), TUNING_PROFILES::TUNING_PROFILES(), and ~JSON_SETTINGS().

◆ m_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing
protectedinherited

Whether or not to set parameters to their default value if missing from JSON on Load()

Definition at line 370 of file json_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), JSON_SETTINGS(), Load(), ResetsParamsIfMissing(), and TEST_NESTED_SETTINGS::TEST_NESTED_SETTINGS().

◆ m_schemaVersion

int JSON_SETTINGS::m_schemaVersion
protectedinherited

Version of this settings schema.

Definition at line 373 of file json_settings.h.

Referenced by JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), Migrate(), registerMigration(), and NESTED_SETTINGS::SaveToFile().

◆ m_Session

SESSION COMMON_SETTINGS::m_Session

Definition at line 266 of file common_settings.h.

Referenced by DESIGN_BLOCK_TREE_MODEL_ADAPTER::AddLibraries(), FP_TREE_MODEL_ADAPTER::AddLibraries(), SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), PANEL_COMMON_SETTINGS::applySettingsToPanel(), CVPCB_MAINFRAME::BuildLibrariesList(), COMMON_SETTINGS(), PCB_BASE_FRAME::GetLibraryItemsForListDialog(), SCH_BASE_FRAME::GetLibraryItemsForListDialog(), PANEL_SYMBOL_CHOOSER::PANEL_SYMBOL_CHOOSER(), PROJECT::PinLibrary(), SYMBOL_VIEWER_FRAME::ReCreateLibList(), FOOTPRINT_VIEWER_FRAME::ReCreateLibraryList(), FP_TREE_SYNCHRONIZING_ADAPTER::Sync(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::Sync(), PANEL_COMMON_SETTINGS::TransferDataFromWindow(), and PROJECT::UnpinLibrary().

◆ m_SpaceMouse

SPACEMOUSE COMMON_SETTINGS::m_SpaceMouse

Definition at line 264 of file common_settings.h.

Referenced by PANEL_SPACEMOUSE::applySettingsToPanel(), COMMON_SETTINGS(), SPNAV_2D_PLUGIN::OnPan(), and PANEL_SPACEMOUSE::TransferDataFromWindow().

◆ m_System

SYSTEM COMMON_SETTINGS::m_System

Definition at line 267 of file common_settings.h.

Referenced by PANEL_COMMON_SETTINGS::applySettingsToPanel(), PANEL_MAINTENANCE::applySettingsToPanel(), PROJECT_PCB::Cleanup3DCache(), COMMON_SETTINGS(), EDA_BASE_FRAME::CommonSettingsChanged(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDA_BASE_FRAME::GetAutoSaveInterval(), PGM_BASE::loadCommonSettings(), EDA_BASE_FRAME::LoadSettings(), APP_SETTINGS_BASE::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PGM_BASE::ReadPdfBrowserInfos(), PANEL_COMMON_SETTINGS::ResetPanel(), PGM_BASE::SaveCommonSettings(), PGM_BASE::SetLanguage(), PGM_BASE::SetTextEditor(), PANEL_COMMON_SETTINGS::TransferDataFromWindow(), PANEL_MAINTENANCE::TransferDataFromWindow(), PANEL_COMMON_SETTINGS::TransferDataToWindow(), and PGM_BASE::WritePdfBrowserInfos().

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

Whether or not the backing store file should be written.

Definition at line 358 of file json_settings.h.

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), COLOR_SETTINGS::initFromOther(), IsReadOnly(), JSON_SETTINGS(), LoadFromFile(), SaveToFile(), and SetReadOnly().

The documentation for this class was generated from the following files: