JOBSET Class Reference

#include <jobset.h>

Inheritance diagram for JOBSET:

Public Member Functions
	JOBSET (const wxString &aFilename)
virtual	~JOBSET ()
std::vector< JOBSET_JOB > &	GetJobs ()
std::vector< JOBSET_JOB >	GetJobsForOutput (JOBSET_OUTPUT *aOutput)
std::vector< JOBSET_OUTPUT > &	GetOutputs ()
JOBSET_OUTPUT *	GetOutput (wxString &aOutput)
bool	SaveToFile (const wxString &aDirectory="", bool aForce=false) override
	Calls Store() and then writes the contents of the JSON document to a file.
void	SetDirty ()
bool	GetDirty () const
wxString	GetFullName () const
void	AddNewJob (wxString aType, JOB *aJob)
JOBSET_OUTPUT	AddNewJobOutput (JOBSET_OUTPUT_TYPE aType, JOBS_OUTPUT_HANDLER *aJobOutput)
void	RemoveOutput (JOBSET_OUTPUT *aOutput)
void	MoveJobUp (size_t aJobIdx)
void	MoveJobDown (size_t aJobIdx)
void	RemoveJob (size_t aJobIdx)
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()
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<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)
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)

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
wxString	getFileExt () const override
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	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_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

Private Attributes
std::vector< JOBSET_JOB >	m_jobs
std::vector< JOBSET_OUTPUT >	m_outputs
bool	m_dirty
wxString	m_fileNameWithoutPath

Detailed Description

Definition at line 69 of file jobset.h.

Constructor & Destructor Documentation

JOBSET()

JOBSET::JOBSET

(

const wxString &

aFilename

)

Definition at line 112 of file jobset.cpp.

References m_fileNameWithoutPath, m_jobs, m_outputs, and JSON_SETTINGS::m_params.

~JOBSET()

virtual JOBSET::~JOBSET ( )

inlinevirtual

Definition at line 74 of file jobset.h.

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

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

Definition at line 870 of file json_settings.cpp.

References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::m_nested_settings, and traceSettings.

Referenced by NESTED_SETTINGS::SetParent().

AddNewJob()

void JOBSET::AddNewJob	(	wxString	aType,
		JOB *	aJob
	)

Definition at line 129 of file jobset.cpp.

References m_jobs, and SetDirty().

AddNewJobOutput()

JOBSET_OUTPUT JOBSET::AddNewJobOutput	(	JOBSET_OUTPUT_TYPE	aType,
		JOBS_OUTPUT_HANDLER *	aJobOutput
	)

Definition at line 136 of file jobset.cpp.

References m_outputs, and SetDirty().

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

References JSON_SETTINGS::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

inherited

Definition at line 124 of file json_settings.cpp.

References JSON_SETTINGS::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()  )

staticprotectedinherited

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

FormatAsString()

const std::string JSON_SETTINGS::FormatAsString ( )

inherited

Definition at line 515 of file json_settings.cpp.

References dummy, JSON_SETTINGS::m_internals, and JSON_SETTINGS::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  )

protectedinherited

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

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

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 842 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  )

protectedinherited

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 818 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

inherited

Definition at line 900 of file json_settings.cpp.

References JSON_SETTINGS::GetJson().

Get() [2/2]

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

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

References JSON_SETTINGS::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().

GetDirty()

bool JOBSET::GetDirty ( ) const

inline

Definition at line 90 of file jobset.h.

getFileExt()

wxString JOBSET::getFileExt ( ) const

overrideprotectedvirtual

Reimplemented from JSON_SETTINGS.

Definition at line 123 of file jobset.cpp.

References FILEEXT::KiCadJobSetFileExtension.

GetFilename()

wxString JSON_SETTINGS::GetFilename ( ) const

inlineinherited

Definition at line 80 of file json_settings.h.

Referenced by JSON_SETTINGS::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

inherited

Definition at line 109 of file json_settings.cpp.

References JSON_SETTINGS::getFileExt(), and JSON_SETTINGS::m_filename.

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

GetFullName()

wxString JOBSET::GetFullName ( ) const

inline

Definition at line 92 of file jobset.h.

GetJobs()

std::vector< JOBSET_JOB > & JOBSET::GetJobs ( )

inline

Definition at line 76 of file jobset.h.

Referenced by DIALOG_JOB_OUTPUT::TransferDataToWindow().

GetJobsForOutput()

std::vector< JOBSET_JOB > JOBSET::GetJobsForOutput

(

JOBSET_OUTPUT *

aOutput

)

Definition at line 213 of file jobset.cpp.

References m_jobs, and JOBSET_OUTPUT::m_only.

Referenced by JOBS_RUNNER::RunJobsForOutput().

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

aPath

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

Returns

a JSON object from within this one

Definition at line 560 of file json_settings.cpp.

References JSON_SETTINGS::m_internals.

Referenced by JSON_SETTINGS::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

inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 287 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile().

GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const

inlineinherited

Definition at line 87 of file json_settings.h.

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

GetOutput()

JOBSET_OUTPUT * JOBSET::GetOutput

(

wxString &

aOutput

)

Definition at line 195 of file jobset.cpp.

References m_outputs.

Referenced by CLI::JOBSET_RUN_COMMAND::doPerform().

GetOutputs()

std::vector< JOBSET_OUTPUT > & JOBSET::GetOutputs ( )

inline

Definition at line 83 of file jobset.h.

Referenced by JOBS_RUNNER::RunJobsAllOutputs().

Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )

inherited

Definition at line 130 of file json_settings.cpp.

References JSON_SETTINGS::m_internals.

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

IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const

inlineinherited

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 ( )

virtualinherited

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

Definition at line 136 of file json_settings.cpp.

References JSON_SETTINGS::m_params, JSON_SETTINGS::m_resetParamsIfMissing, and traceSettings.

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::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 = "" )

virtualinherited

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

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

Referenced by CLI::JOBSET_RUN_COMMAND::doPerform(), 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 )

inherited

Definition at line 528 of file json_settings.cpp.

References JSON_SETTINGS::Load(), JSON_SETTINGS::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 677 of file json_settings.cpp.

References JSON_SETTINGS::m_internals, JSON_SETTINGS::m_migrators, JSON_SETTINGS::m_schemaVersion, and traceSettings.

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

MigrateFromLegacy()

bool JSON_SETTINGS::MigrateFromLegacy ( wxConfigBase *  aLegacyConfig )

virtualinherited

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

References traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile().

MoveJobDown()

void JOBSET::MoveJobDown

(

size_t

aJobIdx

)

Definition at line 166 of file jobset.cpp.

References m_jobs, and SetDirty().

MoveJobUp()

void JOBSET::MoveJobUp

(

size_t

aJobIdx

)

Definition at line 156 of file jobset.cpp.

References m_jobs, and SetDirty().

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

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

References JSON_SETTINGS::m_migrators, and JSON_SETTINGS::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(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_FILE::PROJECT_FILE(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

ReleaseNestedSettings()

void JSON_SETTINGS::ReleaseNestedSettings ( NESTED_SETTINGS *  aSettings )

inherited

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

References JSON_SETTINGS::m_manager, JSON_SETTINGS::m_modified, JSON_SETTINGS::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().

RemoveJob()

void JOBSET::RemoveJob

(

size_t

aJobIdx

)

Definition at line 176 of file jobset.cpp.

References m_jobs, and SetDirty().

RemoveOutput()

void JOBSET::RemoveOutput

(

JOBSET_OUTPUT *

aOutput

)

Definition at line 146 of file jobset.cpp.

References JOBSET_OUTPUT::m_id, and m_outputs.

ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )

inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 387 of file json_settings.cpp.

References JSON_SETTINGS::m_params.

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

SaveToFile()

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

overridevirtual

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 from JSON_SETTINGS.

Definition at line 183 of file jobset.cpp.

References m_dirty, and JSON_SETTINGS::SaveToFile().

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

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

References JSON_SETTINGS::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  )

inherited

Definition at line 909 of file json_settings.cpp.

Set() [3/3]

template<>

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

inherited

SetDirty()

void JOBSET::SetDirty ( )

inline

Definition at line 89 of file jobset.h.

Referenced by AddNewJob(), AddNewJobOutput(), MoveJobDown(), MoveJobUp(), and RemoveJob().

SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString &  aFilename )

inlineinherited

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  )

staticinherited

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 736 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

aObj	is the source object
aTarget	is the storage destination

Returns

True if set, false if not

Definition at line 751 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

aObj	is the source object
aTarget	is the storage destination

Returns

True if set, false if not

Definition at line 766 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

aObj	is the source object
aTarget	is the storage destination

Returns

True if set, false if not

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

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

Definition at line 198 of file json_settings.h.

SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly )

inlineinherited

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 ( )

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

References JSON_SETTINGS::m_modified, and JSON_SETTINGS::m_params.

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

Member Data Documentation

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

Referenced by JSON_SETTINGS::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 319 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration

protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 334 of file json_settings.h.

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

m_dirty

bool JOBSET::m_dirty

private

Definition at line 110 of file jobset.h.

Referenced by SaveToFile().

m_filename

wxString JSON_SETTINGS::m_filename

protectedinherited

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(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::operator=(), JSON_SETTINGS::SaveToFile(), and NESTED_SETTINGS::SaveToFile().

m_fileNameWithoutPath

wxString JOBSET::m_fileNameWithoutPath

private

Definition at line 111 of file jobset.h.

Referenced by JOBSET().

m_internals

std::unique_ptr<JSON_SETTINGS_INTERNALS> JSON_SETTINGS::m_internals

protectedinherited

Definition at line 348 of file json_settings.h.

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

m_jobs

std::vector<JOBSET_JOB> JOBSET::m_jobs

private

Definition at line 107 of file jobset.h.

Referenced by AddNewJob(), GetJobsForOutput(), JOBSET(), MoveJobDown(), MoveJobUp(), and RemoveJob().

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

Referenced by JSON_SETTINGS::LoadFromFile().

m_location

SETTINGS_LOC JSON_SETTINGS::m_location

protectedinherited

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

protectedinherited

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

Definition at line 343 of file json_settings.h.

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

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

Referenced by JSON_SETTINGS::Migrate(), and JSON_SETTINGS::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 331 of file json_settings.h.

Referenced by JSON_SETTINGS::LoadFromFile(), JSON_SETTINGS::ReleaseNestedSettings(), JSON_SETTINGS::SaveToFile(), and JSON_SETTINGS::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 316 of file json_settings.h.

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

m_outputs

std::vector<JOBSET_OUTPUT> JOBSET::m_outputs

private

Definition at line 108 of file jobset.h.

Referenced by AddNewJobOutput(), GetOutput(), JOBSET(), and RemoveOutput().

m_params

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

protectedinherited

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(), JOBSET(), JSON_SETTINGS::JSON_SETTINGS(), KICAD_SETTINGS::KICAD_SETTINGS(), JSON_SETTINGS::Load(), 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(), JSON_SETTINGS::ResetToDefaults(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), JSON_SETTINGS::SaveToFile(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SPICE_SETTINGS::SPICE_SETTINGS(), JSON_SETTINGS::Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), and JSON_SETTINGS::~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 337 of file json_settings.h.

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

m_schemaVersion

int JSON_SETTINGS::m_schemaVersion

protectedinherited

Version of this settings schema.

Definition at line 340 of file json_settings.h.

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

m_writeFile

bool JSON_SETTINGS::m_writeFile

protectedinherited

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(), JSON_SETTINGS::LoadFromFile(), and JSON_SETTINGS::SaveToFile().

---

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

• jobset.h
• jobset.cpp