JSON_SETTINGS Class Reference

#include <json_settings.h>

Inheritance diagram for JSON_SETTINGS:

Public Member Functions
	JSON_SETTINGS (const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion)
	JSON_SETTINGS (const wxString &aFilename, SETTINGS_LOC aLocation, int aSchemaVersion, bool aCreateIfMissing, bool aCreateIfDefault, bool aWriteFile)
virtual	~JSON_SETTINGS ()
wxString	GetFilename () const
wxString	GetFullFilename () const
void	SetFilename (const wxString &aFilename)
void	SetLocation (SETTINGS_LOC aLocation)
SETTINGS_LOC	GetLocation () const
void	SetLegacyFilename (const wxString &aFilename)
bool	IsReadOnly () const
void	SetReadOnly (bool aReadOnly)
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.
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<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.
bool	Migrate ()
	Migrates the schema of this settings from the version in the file to the latest version.
virtual bool	MigrateFromLegacy (wxConfigBase *aLegacyConfig)
	Migrates from wxConfig to JSON-based configuration.
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)
template<>
std::optional< wxString >	Get (const std::string &aPath) const
template<>
void	Set (const std::string &aPath, wxString aVal)
template<>
KICOMMON_API void	Set (const std::string &aPath, wxString aVal)

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.

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_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.
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

Friends
class	NESTED_SETTINGS

Detailed Description

Definition at line 66 of file json_settings.h.

Constructor & Destructor Documentation

JSON_SETTINGS() [1/2]

JSON_SETTINGS::JSON_SETTINGS ( const wxString &  aFilename, SETTINGS_LOC  aLocation, int  aSchemaVersion  )

inline

Definition at line 71 of file json_settings.h.

JSON_SETTINGS() [2/2]

JSON_SETTINGS::JSON_SETTINGS	(	const wxString &	aFilename,
		SETTINGS_LOC	aLocation,
		int	aSchemaVersion,
		bool	aCreateIfMissing,
		bool	aCreateIfDefault,
		bool	aWriteFile
	)

Definition at line 67 of file json_settings.cpp.

References GetFullFilename(), m_internals, m_params, m_schemaVersion, and traceSettings.

~JSON_SETTINGS()

JSON_SETTINGS::~JSON_SETTINGS ( )

virtual

Definition at line 99 of file json_settings.cpp.

References m_params.

Member Function Documentation

AddNestedSettings()

void JSON_SETTINGS::AddNestedSettings

(

NESTED_SETTINGS *

aSettings

)

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

aSettings	is the settings object to take ownership of
aTarget	is a pointer to update to the passed in settings

Definition at line 862 of file json_settings.cpp.

References GetFilename(), m_nested_settings, and traceSettings.

Referenced by NESTED_SETTINGS::SetParent().

At()

nlohmann::json & JSON_SETTINGS::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.

Definition at line 117 of file json_settings.cpp.

References m_internals.

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

Contains()

bool JSON_SETTINGS::Contains

(

const std::string &

aPath

)

const

Definition at line 123 of file json_settings.cpp.

References m_internals, and JSON_SETTINGS_INTERNALS::PointerFromString().

Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::migrateBomSettings(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), and SETTINGS_MANAGER::SaveColorSettings().

fetchOrDefault()

template<typename ResultType >

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

staticprotected

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

Template Parameters

ResultType

is the type of the retrieved value.

Parameters

aJson	is the object to act on .
aKey	is the object key to retrieve the value for.

Returns

the result, or aDefault if aKey is not found.

Definition at line 908 of file json_settings.cpp.

FormatAsString()

const std::string JSON_SETTINGS::FormatAsString

(

)

Definition at line 509 of file json_settings.cpp.

References dummy, m_internals, and Store().

Referenced by ROUTER_TOOL::saveRouterDebugLog().

fromLegacy()

template<typename ValueType >

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

protected

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

Template Parameters

ValueType

is the basic type of the value

Parameters

aConfig	is the legacy config to read from
aKey	is the key (within the current path) to read
aDest	is a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 774 of file json_settings.cpp.

fromLegacyColor()

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

protected

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

Parameters

aConfig	is the legacy config to read from
aKey	is the key (within the current path) to read
aDest	is a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 834 of file json_settings.cpp.

References color.

Referenced by APP_SETTINGS_BASE::migrateWindowConfig().

fromLegacyString()

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

protected

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

Parameters

aConfig	is the legacy config to read from
aKey	is the key (within the current path) to read
aDest	is a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 810 of file json_settings.cpp.

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

Get() [1/2]

template<>

template std::optional< wxAuiPaneInfo > JSON_SETTINGS::Get< wxAuiPaneInfo >

(

const std::string &

aPath

)

const

Definition at line 892 of file json_settings.cpp.

References GetJson().

Get() [2/2]

template<typename ValueType >

template KICOMMON_API std::optional< wxAuiPaneInfo > JSON_SETTINGS::Get< wxAuiPaneInfo >

(

const std::string &

aPath

)

const

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

ValueType

is the type to cast to

Parameters

aPath

is the path within the document to retrieve

Returns

a value from within this document

Definition at line 574 of file json_settings.cpp.

References GetJson().

Referenced by 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_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< ValueType >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().

getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const

inlineprotectedvirtual

Reimplemented in DATABASE_LIB_SETTINGS, HTTP_LIB_SETTINGS, PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 282 of file json_settings.h.

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

GetFilename()

wxString JSON_SETTINGS::GetFilename ( ) const

inline

Definition at line 80 of file json_settings.h.

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

GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename

(

)

const

Definition at line 108 of file json_settings.cpp.

References getFileExt(), and m_filename.

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

GetJson()

std::optional< nlohmann::json > JSON_SETTINGS::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.

Parameters

aPath

is a string containing one or more keys separated by '.'

Returns

a JSON object from within this one

Definition at line 554 of file json_settings.cpp.

References m_internals.

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

getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const

inlineprotectedvirtual

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 287 of file json_settings.h.

Referenced by LoadFromFile().

GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const

inline

Definition at line 87 of file json_settings.h.

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

Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals

(

)

Definition at line 129 of file json_settings.cpp.

References m_internals.

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

IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const

inline

Definition at line 91 of file json_settings.h.

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

Load()

void JSON_SETTINGS::Load ( )

virtual

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

Definition at line 135 of file json_settings.cpp.

References m_params, m_resetParamsIfMissing, and traceSettings.

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), LoadFromRawFile(), PCB_TEST_FRAME_BASE::LoadSettings(), COLOR_SETTINGS::migrateSchema0to1(), PANEL_3D_DISPLAY_OPTIONS::ResetPanel(), PANEL_3D_OPENGL_OPTIONS::ResetPanel(), PANEL_3D_RAYTRACING_OPTIONS::ResetPanel(), PANEL_EESCHEMA_ANNOTATION_OPTIONS::ResetPanel(), PANEL_EESCHEMA_DISPLAY_OPTIONS::ResetPanel(), PANEL_EESCHEMA_EDITING_OPTIONS::ResetPanel(), PANEL_SYM_DISPLAY_OPTIONS::ResetPanel(), PANEL_SYM_EDITING_OPTIONS::ResetPanel(), PANEL_GERBVIEW_DISPLAY_OPTIONS::ResetPanel(), PANEL_PL_EDITOR_DISPLAY_OPTIONS::ResetPanel(), PANEL_EDIT_OPTIONS::ResetPanel(), PANEL_FP_EDITOR_DEFAULTS::ResetPanel(), PANEL_PCB_DISPLAY_OPTIONS::ResetPanel(), PANEL_PCBNEW_DISPLAY_ORIGIN::ResetPanel(), SETTINGS_MANAGER::SaveColorSettings(), and SETTINGS_MANAGER::SETTINGS_MANAGER().

LoadFromFile()

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

virtual

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

Parameters

aDirectory

is the path to the file

Returns

true if the file was found on disk and loaded or migrated

Reimplemented in BOARD_DESIGN_SETTINGS, and NESTED_SETTINGS.

Definition at line 152 of file json_settings.cpp.

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

Referenced by SETTINGS_MANAGER::LoadProject(), SETTINGS_MANAGER::loadProjectFile(), SETTINGS_MANAGER::MigrateIfNeeded(), SAVE_AS_TRAVERSER::OnFile(), and SETTINGS_MANAGER::SaveColorSettings().

LoadFromRawFile()

bool JSON_SETTINGS::LoadFromRawFile

(

const wxString &

aPath

)

Definition at line 522 of file json_settings.cpp.

References Load(), m_internals, and traceSettings.

Migrate()

bool JSON_SETTINGS::Migrate

(

)

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 671 of file json_settings.cpp.

References m_internals, m_migrators, m_schemaVersion, and traceSettings.

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

MigrateFromLegacy()

bool JSON_SETTINGS::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig )

virtual

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

aLegacyConfig

is a wxConfigBase holding a loaded configuration to migrate

Returns

true if migration was successful

Reimplemented in PROJECT_FILE, APP_SETTINGS_BASE, COLOR_SETTINGS, EDA_3D_VIEWER_SETTINGS, BITMAP2CMP_SETTINGS, EESCHEMA_SETTINGS, SYMBOL_EDITOR_SETTINGS, GERBVIEW_SETTINGS, FOOTPRINT_EDITOR_SETTINGS, PROJECT_LOCAL_SETTINGS, COMMON_SETTINGS, CVPCB_SETTINGS, KICAD_SETTINGS, PL_EDITOR_SETTINGS, PCB_CALCULATOR_SETTINGS, and PCBNEW_SETTINGS.

Definition at line 705 of file json_settings.cpp.

References traceSettings.

Referenced by LoadFromFile().

registerMigration()

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

protected

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

aOldSchemaVersion	is the starting schema version for this migration
aNewSchemaVersion	is the ending schema version for this migration
aMigrator	is a function that performs the migration and returns true if successful

Definition at line 662 of file json_settings.cpp.

References m_migrators, and m_schemaVersion.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings

(

NESTED_SETTINGS *

aSettings

)

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

Parameters

aSettings

is a pointer to a NESTED_SETTINGS that has already been added to this one

Definition at line 869 of file json_settings.cpp.

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

Referenced by BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS(), ERC_SETTINGS::~ERC_SETTINGS(), NESTED_SETTINGS::~NESTED_SETTINGS(), NET_SETTINGS::~NET_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().

ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults

(

)

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 386 of file json_settings.cpp.

References m_params.

Referenced by EDA_3D_VIEWER_FRAME::Process_Special_Functions(), PANEL_COMMON_SETTINGS::ResetPanel(), and PANEL_MOUSE_SETTINGS::ResetPanel().

SaveToFile()

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

virtual

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

Parameters

aDirectory

is the directory to save to, including trailing separator

Returns

true if the file was saved

Reimplemented in PROJECT_FILE, PROJECT_LOCAL_SETTINGS, and NESTED_SETTINGS.

Definition at line 393 of file json_settings.cpp.

References dummy, getFileExt(), GetFullFilename(), m_createIfDefault, m_createIfMissing, m_filename, m_internals, m_nested_settings, m_params, m_writeFile, path, Store(), and traceSettings.

Referenced by KICAD_MANAGER_FRAME::CreateNewProject(), LoadFromFile(), KICAD_MANAGER_FRAME::LoadProject(), SETTINGS_MANAGER::MigrateIfNeeded(), PANEL_COLOR_SETTINGS::OnThemeChanged(), PROJECT::PinLibrary(), PROJECT_FILE::SaveAs(), PROJECT_LOCAL_SETTINGS::SaveAs(), SETTINGS_MANAGER::SaveColorSettings(), 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
	)

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

Template Parameters

ValueType

is the type to store

Parameters

aPath	is a path to store in the form "key1.key2.key3"
aVal	is the value to store

Definition at line 625 of file json_settings.cpp.

References m_internals.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), BOARD_DESIGN_SETTINGS::LoadFromFile(), APP_SETTINGS_BASE::migrateFindReplace(), PROJECT_FILE::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), SYMBOL_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), KICAD_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), BOARD_DESIGN_SETTINGS::migrateSchema0to1(), FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), 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_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< ValueType >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< Type >::Store(), PARAM_SET< Type >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().

Set() [2/3]

template<>

void JSON_SETTINGS::Set	(	const std::string &	aPath,
		wxString	aVal
	)

Definition at line 901 of file json_settings.cpp.

Set() [3/3]

template<>

KICOMMON_API void JSON_SETTINGS::Set	(	const std::string &	aPath,
		wxString	aVal
	)

SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString &  aFilename )

inline

Definition at line 84 of file json_settings.h.

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  )

static

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

Parameters

aObj	is the source object
aTarget	is the storage destination

Returns

True if set, false if not

Definition at line 728 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  )

static

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

Parameters

aObj	is the source object
aTarget	is the storage destination

Returns

True if set, false if not

Definition at line 743 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  )

static

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

Parameters

aObj	is the source object
aTarget	is the storage destination

Returns

True if set, false if not

Definition at line 758 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  )

static

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

Parameters

aObj	is the source object
aTarget	is the storage destination

Returns

True if set, false if not

Definition at line 713 of file json_settings.cpp.

References JSON_SETTINGS_INTERNALS::PointerFromString().

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

SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const wxString &  aFilename )

inline

Definition at line 89 of file json_settings.h.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC  aLocation )

inline

Definition at line 86 of file json_settings.h.

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

SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER *  aManager )

inline

Definition at line 198 of file json_settings.h.

SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly )

inline

Definition at line 92 of file json_settings.h.

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

Store()

bool JSON_SETTINGS::Store ( )

virtual

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 was updated

Definition at line 372 of file json_settings.cpp.

References m_params.

Referenced by FormatAsString(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), SaveToFile(), and NESTED_SETTINGS::SaveToFile().

Friends And Related Function Documentation

NESTED_SETTINGS

friend class NESTED_SETTINGS

friend

Definition at line 69 of file json_settings.h.

Member Data Documentation

m_createIfDefault

bool JSON_SETTINGS::m_createIfDefault

protected

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 325 of file json_settings.h.

Referenced by SaveToFile().

m_createIfMissing

bool JSON_SETTINGS::m_createIfMissing

protected

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

Definition at line 319 of file json_settings.h.

Referenced by SaveToFile().

m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration

protected

Whether or not to delete legacy file after migration.

Definition at line 331 of file json_settings.h.

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

m_filename

wxString JSON_SETTINGS::m_filename

protected

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

Definition at line 304 of file json_settings.h.

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

m_internals

std::unique_ptr<JSON_SETTINGS_INTERNALS> JSON_SETTINGS::m_internals

protected

Definition at line 345 of file json_settings.h.

Referenced by At(), Contains(), FormatAsString(), GetJson(), Internals(), JSON_SETTINGS(), LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), LoadFromRawFile(), Migrate(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::migrateSchema0to1(), NET_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema0to1(), COMMON_SETTINGS::migrateSchema1to2(), NET_SETTINGS::migrateSchema2to3(), SaveToFile(), NESTED_SETTINGS::SaveToFile(), and Set().

m_legacy_filename

wxString JSON_SETTINGS::m_legacy_filename

protected

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

Definition at line 307 of file json_settings.h.

Referenced by LoadFromFile().

m_location

SETTINGS_LOC JSON_SETTINGS::m_location

protected

The location of this settings file (.

See also

SETTINGS_LOC)

Definition at line 310 of file json_settings.h.

m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager

protected

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

Definition at line 340 of file json_settings.h.

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

m_migrators

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

protected

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

Definition at line 343 of file json_settings.h.

Referenced by Migrate(), and registerMigration().

m_nested_settings

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

protected

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

Definition at line 316 of file json_settings.h.

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

m_params

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

protected

The list of parameters (owned by this object)

Definition at line 313 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(), COLOR_SETTINGS::CreateBuiltinColorSettings(), CVPCB_SETTINGS::CVPCB_SETTINGS(), DATABASE_LIB_SETTINGS::DATABASE_LIB_SETTINGS(), EDA_3D_VIEWER_SETTINGS::EDA_3D_VIEWER_SETTINGS(), EESCHEMA_SETTINGS::EESCHEMA_SETTINGS(), ERC_SETTINGS::ERC_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), GERBVIEW_SETTINGS::GERBVIEW_SETTINGS(), COLOR_SETTINGS::GetDefaultColor(), HTTP_LIB_SETTINGS::HTTP_LIB_SETTINGS(), COLOR_SETTINGS::initFromOther(), 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(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SPICE_SETTINGS::SPICE_SETTINGS(), Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), and ~JSON_SETTINGS().

m_resetParamsIfMissing

bool JSON_SETTINGS::m_resetParamsIfMissing

protected

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

Definition at line 334 of file json_settings.h.

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), and Load().

m_schemaVersion

int JSON_SETTINGS::m_schemaVersion

protected

Version of this settings schema.

Definition at line 337 of file json_settings.h.

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

m_writeFile

bool JSON_SETTINGS::m_writeFile

protected

Whether or not the backing store file should be written.

Definition at line 328 of file json_settings.h.

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

---

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

• json_settings.h
• json_settings.cpp