Container for ERC settings. More...

#include <erc_settings.h>

Inheritance diagram for ERC_SETTINGS:

Public Member Functions
	ERC_SETTINGS (JSON_SETTINGS *aParent, const std::string &aPath)

virtual	~ERC_SETTINGS ()

bool	operator== (const ERC_SETTINGS &other) const

bool	operator!= (const ERC_SETTINGS &other) const

bool	IsTestEnabled (int aErrorCode) const

SEVERITY	GetSeverity (int aErrorCode) const

void	SetSeverity (int aErrorCode, SEVERITY aSeverity)

void	ResetPinMap ()

PIN_ERROR	GetPinMapValue (int aFirstType, int aSecondType) const

PIN_ERROR	GetPinMapValue (ELECTRICAL_PINTYPE aFirstType, ELECTRICAL_PINTYPE aSecondType) const

void	SetPinMapValue (int aFirstType, int aSecondType, PIN_ERROR aValue)

void	SetPinMapValue (ELECTRICAL_PINTYPE aFirstType, ELECTRICAL_PINTYPE aSecondType, PIN_ERROR aValue)

int	GetPinMinDrive (ELECTRICAL_PINTYPE aFirstType, ELECTRICAL_PINTYPE aSecondType) const

bool	LoadFromFile (const wxString &aDirectory="") override
	Loads the JSON document from the parent and then calls Load() More...

bool	SaveToFile (const wxString &aDirectory="", bool aForce=false) override
	Calls Store() and then saves the JSON document contents into the parent JSON_SETTINGS. More...

void	SetParent (JSON_SETTINGS *aParent, bool aLoadFromFile=true)

JSON_SETTINGS *	GetParent ()

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

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

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

void	ResetToDefaults ()
	Resets all parameters to default values. More...

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

template<typename ValueType >
std::optional< ValueType >	Get (const std::string &aPath) const
	Fetches a value from within the JSON document. More...

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

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

template<>
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. More...

virtual bool	MigrateFromLegacy (wxConfigBase *aLegacyConfig)
	Migrates from wxConfig to JSON-based configuration. More...

void	AddNestedSettings (NESTED_SETTINGS *aSettings)
	Transfers ownership of a given NESTED_SETTINGS to this object. More...

void	ReleaseNestedSettings (NESTED_SETTINGS *aSettings)
	Saves and frees a nested settings object, if it exists within this one. More...

void	SetManager (SETTINGS_MANAGER *aManager)

const std::string	FormatAsString () const

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

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

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

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

Public Attributes
std::map< int, SEVERITY >	m_ERCSeverities

std::set< wxString >	m_ErcExclusions

PIN_ERROR	m_PinMap [ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]

Static Public Attributes
static int	m_PinMinDrive [ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
	Look up table which gives the minimal drive for a pair of connected pins on a net. More...

Protected Member Functions
void	registerMigration (int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
	Registers a migration from one schema version to another. More...

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

bool	fromLegacyString (wxConfigBase *aConfig, const std::string &aKey, const std::string &aDest)
	Translates a legacy wxConfig string value to a given JSON pointer value. More...

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

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

Protected Attributes
JSON_SETTINGS *	m_parent
	A pointer to the parent object to load and store from. More...

std::string	m_path
	The path (in pointer format) of where to store this document in the parent. More...

wxString	m_filename
	The filename (not including path) of this settings file (inicode) More...

wxString	m_legacy_filename
	The filename of the wxConfig legacy file (if different from m_filename) More...

SETTINGS_LOC	m_location
	The location of this settings file (. More...

std::vector< PARAM_BASE * >	m_params
	The list of parameters (owned by this object) More...

std::vector< NESTED_SETTINGS * >	m_nested_settings
	Nested settings files that live inside this one, if any. More...

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

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

bool	m_writeFile
	Whether or not the backing store file should be written. More...

bool	m_deleteLegacyAfterMigration
	Whether or not to delete legacy file after migration. More...

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

int	m_schemaVersion
	Version of this settings schema. More...

SETTINGS_MANAGER *	m_manager
	A pointer to the settings manager managing this file (may be null) More...

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

std::unique_ptr< JSON_SETTINGS_INTERNALS >	m_internals

Static Private Attributes
static PIN_ERROR	m_defaultPinMap [ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
	Default Look up table which gives the ERC error level for a pair of connected pins. More...

Detailed Description

Container for ERC settings.

Currently only stores flags about checks to run, but could later be expanded to contain the matrix of electrical pin types.

Definition at line 113 of file erc_settings.h.

Constructor & Destructor Documentation

◆ ERC_SETTINGS()

ERC_SETTINGS::ERC_SETTINGS	(	JSON_SETTINGS *	aParent,
		const std::string &	aPath
	)

Definition at line 87 of file erc_settings.cpp.

 :
 NESTED_SETTINGS( "erc", ercSettingsSchemaVersion, aParent, aPath )
{
 ResetPinMap();
 
 for( int i = ERCE_FIRST; i <= ERCE_LAST; ++i )
 m_ERCSeverities[ i ] = RPT_SEVERITY_ERROR;
 
 // Error is the default setting so set non-error priorities here.
 m_ERCSeverities[ERCE_UNSPECIFIED] = RPT_SEVERITY_UNDEFINED;
 m_ERCSeverities[ERCE_ENDPOINT_OFF_GRID] = RPT_SEVERITY_WARNING;
 m_ERCSeverities[ERCE_PIN_TO_PIN_WARNING] = RPT_SEVERITY_WARNING;
 m_ERCSeverities[ERCE_SIMILAR_LABELS] = RPT_SEVERITY_WARNING;
 m_ERCSeverities[ERCE_GLOBLABEL] = RPT_SEVERITY_WARNING;
 m_ERCSeverities[ERCE_DRIVER_CONFLICT] = RPT_SEVERITY_WARNING;
 m_ERCSeverities[ERCE_BUS_ENTRY_CONFLICT] = RPT_SEVERITY_WARNING;
 m_ERCSeverities[ERCE_LIB_SYMBOL_ISSUES] = RPT_SEVERITY_WARNING;
 m_ERCSeverities[ERCE_NOCONNECT_CONNECTED] = RPT_SEVERITY_WARNING;
 m_ERCSeverities[ERCE_NOCONNECT_NOT_CONNECTED] = RPT_SEVERITY_WARNING;
 m_ERCSeverities[ERCE_MISSING_UNIT] = RPT_SEVERITY_WARNING;
 m_ERCSeverities[ERCE_MISSING_INPUT_PIN] = RPT_SEVERITY_WARNING;
 m_ERCSeverities[ERCE_MISSING_BIDI_PIN] = RPT_SEVERITY_WARNING;
 
 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "rule_severities",
 [&]() -> nlohmann::json
 {
 nlohmann::json ret = {};
 
 for( const RC_ITEM& item : ERC_ITEM::GetItemsWithSeverities() )
 {
 wxString name = item.GetSettingsKey();
 int code = item.GetErrorCode();
 
 if( name.IsEmpty() || m_ERCSeverities.count( code ) == 0 )
 continue;
 
 ret[std::string( name.ToUTF8() )] = SeverityToString( m_ERCSeverities[code] );
 }
 
 return ret;
 },
 [&]( const nlohmann::json& aJson )
 {
 if( !aJson.is_object() )
 return;
 
 for( const RC_ITEM& item : ERC_ITEM::GetItemsWithSeverities() )
 {
 int code = item.GetErrorCode();
 wxString name = item.GetSettingsKey();
 
 std::string key( name.ToUTF8() );
 
 if( aJson.contains( key ) )
 m_ERCSeverities[code] = SeverityFromString( aJson[key] );
 }
 },
  {} ) );
 
 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "erc_exclusions",
 [&]() -> nlohmann::json
 {
 nlohmann::json js = nlohmann::json::array();
 
 for( const auto& entry : m_ErcExclusions )
 js.push_back( entry );
 
 return js;
 },
 [&]( const nlohmann::json& aObj )
 {
 m_ErcExclusions.clear();
 
 if( !aObj.is_array() )
 return;
 
 for( const nlohmann::json& entry : aObj )
 {
 if( entry.empty() )
 continue;
 
 m_ErcExclusions.insert( entry.get<wxString>() );
 }
 },
 {} ) );
 
 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "pin_map",
  [&]() -> nlohmann::json
 {
 nlohmann::json ret = nlohmann::json::array();
 
 for( int i = 0; i < ELECTRICAL_PINTYPES_TOTAL; i++ )
 {
 nlohmann::json inner = nlohmann::json::array();
 
 for( int j = 0; j < ELECTRICAL_PINTYPES_TOTAL; j++ )
 inner.push_back( static_cast<int>( GetPinMapValue( i, j ) ) );
 
 ret.push_back( inner );
 }
 
 return ret;
 },
 [&]( const nlohmann::json& aJson )
 {
 if( !aJson.is_array() || aJson.size() != ELECTRICAL_PINTYPES_TOTAL )
 return;
 
 for( size_t i = 0; i < ELECTRICAL_PINTYPES_TOTAL; i++ )
 {
 if( i > aJson.size() - 1 )
 break;
 
 nlohmann::json inner = aJson[i];
 
 if( !inner.is_array() || inner.size() != ELECTRICAL_PINTYPES_TOTAL )
 return;
 
 for( size_t j = 0; j < ELECTRICAL_PINTYPES_TOTAL; j++ )
 {
 if( inner[j].is_number_integer() )
 {
 int val = inner[j].get<int>();
 
 if( val >= 0 && val <= static_cast<int>( PIN_ERROR::UNCONNECTED ) )
 SetPinMapValue( i, j, static_cast<PIN_ERROR>( val ) );
 }
 }
 }
 },
 {} ) );
}

References ELECTRICAL_PINTYPES_TOTAL, ERCE_BUS_ENTRY_CONFLICT, ERCE_DRIVER_CONFLICT, ERCE_ENDPOINT_OFF_GRID, ERCE_FIRST, ERCE_GLOBLABEL, ERCE_LAST, ERCE_LIB_SYMBOL_ISSUES, ERCE_MISSING_BIDI_PIN, ERCE_MISSING_INPUT_PIN, ERCE_MISSING_UNIT, ERCE_NOCONNECT_CONNECTED, ERCE_NOCONNECT_NOT_CONNECTED, ERCE_PIN_TO_PIN_WARNING, ERCE_SIMILAR_LABELS, ERCE_UNSPECIFIED, ERC_ITEM::GetItemsWithSeverities(), GetPinMapValue(), m_ErcExclusions, m_ERCSeverities, JSON_SETTINGS::m_params, name, ResetPinMap(), RPT_SEVERITY_ERROR, RPT_SEVERITY_UNDEFINED, RPT_SEVERITY_WARNING, SetPinMapValue(), SeverityToString(), and UNCONNECTED.

◆ ~ERC_SETTINGS()

ERC_SETTINGS::~ERC_SETTINGS ( )

virtual

Definition at line 221 of file erc_settings.cpp.

{
 if( m_parent )
 {
 m_parent->ReleaseNestedSettings( this );
 m_parent = nullptr;
 }
}

References NESTED_SETTINGS::m_parent, and JSON_SETTINGS::ReleaseNestedSettings().

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

{
 wxLogTrace( traceSettings, wxT( "AddNestedSettings %s" ), aSettings->GetFilename() );
 m_nested_settings.push_back( aSettings );
}

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

Referenced by NESTED_SETTINGS::SetParent().

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

{
 return m_internals->At( aPath );
}

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(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

◆ Contains()

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

inherited

Definition at line 117 of file json_settings.cpp.

{
 return m_internals->contains( JSON_SETTINGS_INTERNALS::PointerFromString( aPath ) );
}

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(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), and SETTINGS_MANAGER::SaveColorSettings().

◆ fetchOrDefault()

template<typename ResultType >

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

{
 ResultType ret = aDefault;
 
 try
 {
 if( aJson.contains( aKey ) )
 ret = aJson.at( aKey ).get<ResultType>();
 }
 catch( ... )
 {
 }
 
 return ret;
}

◆ FormatAsString()

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

inherited

Definition at line 478 of file json_settings.cpp.

{
 LOCALE_IO dummy;
 
 std::stringstream buffer;
 buffer << std::setw( 2 ) << *m_internals << std::endl;
 
 return buffer.str();
}

References dummy, and JSON_SETTINGS::m_internals.

Referenced by ROUTER_TOOL::saveRouterDebugLog().

◆ fromLegacy()

template<typename ValueType >

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

{
 ValueType val;
 
 if( aConfig->Read( aKey, &val ) )
 {
 try
 {
 ( *m_internals )[aDest] = val;
 }
 catch( ... )
 {
 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
 return false;
 }
 
 return true;
 }
 
 return false;
}

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

{
 wxString str;
 
 if( aConfig->Read( aKey, &str ) )
 {
 KIGFX::COLOR4D color;
 color.SetFromWxString( str );
 
 try
 {
 nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
 ( *m_internals )[aDest] = js;
 }
 catch( ... )
 {
 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
 return false;
 }
 
 return true;
 }
 
 return false;
}

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

{
 wxString str;
 
 if( aConfig->Read( aKey, &str ) )
 {
 try
 {
 ( *m_internals )[aDest] = str.ToUTF8();
 }
 catch( ... )
 {
 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
 return false;
 }
 
 return true;
 }
 
 return false;
}

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

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

inherited

Definition at line 820 of file json_settings.cpp.

{
 if( std::optional<nlohmann::json> opt_json = GetJson( aPath ) )
 return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
 
 return std::nullopt;
}

References JSON_SETTINGS::GetJson().

◆ Get() [2/2]

template<typename ValueType >

template std::optional< unsigned long long > JSON_SETTINGS::Get< unsigned long long > ( 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 541 of file json_settings.cpp.

{
 if( std::optional<nlohmann::json> ret = GetJson( aPath ) )
 {
 try
 {
 return ret->get<ValueType>();
 }
 catch( ... )
 {
 }
 }
 
 return std::nullopt;
}

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

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const

inlineprotectedvirtualinherited

Reimplemented in DATABASE_LIB_SETTINGS, PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 275 of file json_settings.h.

 {
 return wxT( "json" );
 }

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

◆ GetFilename()

wxString JSON_SETTINGS::GetFilename ( ) const

inlineinherited

Definition at line 73 of file json_settings.h.

73{ return m_filename; }

JSON_SETTINGS::m_filename

wxString m_filename

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

Definition: json_settings.h:297

References JSON_SETTINGS::m_filename.

Referenced by JSON_SETTINGS::AddNestedSettings(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), SETTINGS_MANAGER::loadColorSettingsByName(), NESTED_SETTINGS::LoadFromFile(), EESCHEMA_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), PANEL_COLOR_SETTINGS::OnLeftDownTheme(), PANEL_COLOR_SETTINGS::OnThemeChanged(), DIALOG_PLOT_SCHEMATIC::plotSchematic(), 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 105 of file json_settings.cpp.

{
 return wxString( m_filename + "." + getFileExt() );
}

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

Referenced by JSON_SETTINGS::JSON_SETTINGS(), JSON_SETTINGS::LoadFromFile(), NESTED_SETTINGS::LoadFromFile(), and JSON_SETTINGS::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

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

Returns: a JSON object from within this one

Definition at line 521 of file json_settings.cpp.

{
 nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
 
 if( m_internals->contains( ptr ) )
 {
 try
 {
 return std::optional<nlohmann::json>{ m_internals->at( ptr ) };
 }
 catch( ... )
 {
 }
 }
 
 return std::optional<nlohmann::json>{};
}

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

 {
 return wxEmptyString;
 }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const

inlineinherited

Definition at line 80 of file json_settings.h.

80{ return m_location; }

JSON_SETTINGS::m_location

SETTINGS_LOC m_location

The location of this settings file (.

Definition: json_settings.h:303

References JSON_SETTINGS::m_location.

Referenced by SETTINGS_MANAGER::GetPathForSettingsFile().

◆ GetParent()

JSON_SETTINGS * NESTED_SETTINGS::GetParent ( void )

inlineinherited

Definition at line 54 of file nested_settings.h.

 {
 return m_parent;
 }

References NESTED_SETTINGS::m_parent.

Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile().

◆ GetPinMapValue() [1/2]

PIN_ERROR ERC_SETTINGS::GetPinMapValue	(	ELECTRICAL_PINTYPE	aFirstType,
		ELECTRICAL_PINTYPE	aSecondType
	)		const

inline

Definition at line 148 of file erc_settings.h.

 {
 return m_PinMap[static_cast<int>( aFirstType )][static_cast<int>( aSecondType )];
 }

References m_PinMap.

◆ GetPinMapValue() [2/2]

PIN_ERROR ERC_SETTINGS::GetPinMapValue	(	int	aFirstType,
		int	aSecondType
	)		const

inline

Definition at line 141 of file erc_settings.h.

 {
 wxASSERT( aFirstType < ELECTRICAL_PINTYPES_TOTAL
 && aSecondType < ELECTRICAL_PINTYPES_TOTAL );
 return m_PinMap[aFirstType][aSecondType];
 }

References ELECTRICAL_PINTYPES_TOTAL, and m_PinMap.

Referenced by PANEL_SETUP_PINMAP::changeErrorLevel(), ERC_SETTINGS(), PANEL_SETUP_PINMAP::reBuildMatrixPanel(), and ERC_TESTER::TestPinToPin().

◆ GetPinMinDrive()

int ERC_SETTINGS::GetPinMinDrive	(	ELECTRICAL_PINTYPE	aFirstType,
		ELECTRICAL_PINTYPE	aSecondType
	)		const

inline

Definition at line 166 of file erc_settings.h.

 {
 return m_PinMinDrive[static_cast<int>( aFirstType )][static_cast<int>( aSecondType )];
 }

References m_PinMinDrive.

◆ GetSeverity()

SEVERITY ERC_SETTINGS::GetSeverity ( int aErrorCode ) const

Definition at line 231 of file erc_settings.cpp.

{
 // Special-case pin-to-pin errors:
 // Ignore-or-not is controlled by ERCE_PIN_TO_PIN_WARNING (for both)
 // Warning-or-error is controlled by which errorCode it is
 if( aErrorCode == ERCE_PIN_TO_PIN_ERROR )
 {
 wxASSERT( m_ERCSeverities.count( ERCE_PIN_TO_PIN_WARNING ) );
 
 if( m_ERCSeverities.at( ERCE_PIN_TO_PIN_WARNING ) == RPT_SEVERITY_IGNORE )
 return RPT_SEVERITY_IGNORE;
 else
 return RPT_SEVERITY_ERROR;
 }
 else if( aErrorCode == ERCE_PIN_TO_PIN_WARNING )
 {
 wxASSERT( m_ERCSeverities.count( ERCE_PIN_TO_PIN_WARNING ) );
 
 if( m_ERCSeverities.at( ERCE_PIN_TO_PIN_WARNING ) == RPT_SEVERITY_IGNORE )
 return RPT_SEVERITY_IGNORE;
 else
 return RPT_SEVERITY_WARNING;
 }
 
 wxCHECK_MSG( m_ERCSeverities.count( aErrorCode ), RPT_SEVERITY_IGNORE,
 wxS( "Missing severity from map in ERC_SETTINGS!" ) );
 
 return m_ERCSeverities.at( aErrorCode );
}

References ERCE_PIN_TO_PIN_ERROR, ERCE_PIN_TO_PIN_WARNING, m_ERCSeverities, RPT_SEVERITY_ERROR, RPT_SEVERITY_IGNORE, and RPT_SEVERITY_WARNING.

Referenced by SHEETLIST_ERC_ITEMS_PROVIDER::GetCount(), SCH_MARKER::GetSeverity(), SCH_EDIT_FRAME::GetSeverity(), IsTestEnabled(), DIALOG_ERC::OnERCItemRClick(), DIALOG_ERC::OnRunERCClick(), SHEETLIST_ERC_ITEMS_PROVIDER::SetSeverities(), and DIALOG_ERC::writeReport().

◆ Internals()

JSON_SETTINGS_INTERNALS * JSON_SETTINGS::Internals ( )

inherited

Definition at line 123 of file json_settings.cpp.

{
 return m_internals.get();
}

References JSON_SETTINGS::m_internals.

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

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const

inlineinherited

Definition at line 84 of file json_settings.h.

84{ return !m_writeFile; }

JSON_SETTINGS::m_writeFile

bool m_writeFile

Whether or not the backing store file should be written.

Definition: json_settings.h:321

References JSON_SETTINGS::m_writeFile.

Referenced by 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().

◆ IsTestEnabled()

bool ERC_SETTINGS::IsTestEnabled ( int aErrorCode ) const

inline

Definition at line 130 of file erc_settings.h.

 {
 return GetSeverity( aErrorCode ) != RPT_SEVERITY_IGNORE;
 }

References GetSeverity(), and RPT_SEVERITY_IGNORE.

Referenced by CONNECTION_GRAPH::ercCheckHierSheets(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckNoConnects(), CONNECTION_GRAPH::RunERC(), DIALOG_ERC::testErc(), ERC_TESTER::TestMissingUnits(), and ERC_TESTER::TestPinToPin().

◆ Load()

void JSON_SETTINGS::Load ( )

virtualinherited

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

Definition at line 129 of file json_settings.cpp.

{
 for( auto param : m_params )
 {
 try
 {
 param->Load( this, m_resetParamsIfMissing );
 }
 catch( ... )
 {
 // Skip unreadable parameters in file
 wxLogTrace( traceSettings, wxT( "param '%s' load err" ), param->GetJsonPath().c_str() );
 }
 }
}

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

◆ LoadFromFile()

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

overridevirtualinherited

Loads the JSON document from the parent and then calls Load()

Parameters

aDirectory

Reimplemented from JSON_SETTINGS.

Definition at line 43 of file nested_settings.cpp.

{
 m_internals->clear();
 bool success = false;
 
 if( m_parent )
 {
 nlohmann::json::json_pointer ptr = m_internals->PointerFromString( m_path );
 
 if( m_parent->m_internals->contains( ptr ) )
 {
 try
 {
 m_internals->update( m_parent->m_internals->at( ptr ) );
 
 wxLogTrace( traceSettings, wxT( "Loaded NESTED_SETTINGS %s" ), GetFilename() );
 
 success = true;
 }
 catch( ... )
 {
 wxLogTrace( traceSettings, wxT( "NESTED_SETTINGS %s: Could not load from %s at %s" ),
 m_filename, m_parent->GetFilename(), m_path );
 }
 }
 }
 
 if( success )
 {
 int filever = -1;
 
 try
 {
 filever = m_internals->Get<int>( "meta.version" );
 }
 catch( ... )
 {
 wxLogTrace( traceSettings, wxT( "%s: nested settings version could not be read!" ),
 m_filename );
 success = false;
 }
 
 if( filever >= 0 && filever < m_schemaVersion )
 {
 wxLogTrace( traceSettings, wxT( "%s: attempting migration from version %d to %d" ),
 m_filename, filever, m_schemaVersion );
 
 if( !Migrate() )
 {
 wxLogTrace( traceSettings, wxT( "%s: migration failed!" ), GetFullFilename() );
 success = false;
 }
 }
 else if( filever > m_schemaVersion )
 {
 wxLogTrace( traceSettings,
 wxT( "%s: warning: nested settings version %d is newer than latest (%d)" ),
 m_filename, filever, m_schemaVersion );
 }
 else if( filever >= 0 )
 {
 wxLogTrace( traceSettings, wxT( "%s: schema version %d is current" ),
 m_filename, filever );
 }
 }
 
 Load();
 
 return success;
}

References JSON_SETTINGS::GetFilename(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_filename, JSON_SETTINGS::m_internals, NESTED_SETTINGS::m_parent, NESTED_SETTINGS::m_path, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::Migrate(), and traceSettings.

Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), and NESTED_SETTINGS::SetParent().

◆ LoadFromRawFile()

bool JSON_SETTINGS::LoadFromRawFile ( const wxString & aPath )

inherited

Definition at line 489 of file json_settings.cpp.

{
 try
 {
 wxFFileInputStream fp( aPath, wxT( "rt" ) );
 wxStdInputStream fstream( fp );
 
 if( fp.IsOk() )
 {
 *static_cast<nlohmann::json*>( m_internals.get() ) =
 nlohmann::json::parse( fstream, nullptr,
 /* allow_exceptions = */ true,
 /* ignore_comments = */ true );
 }
 else
 {
 return false;
 }
 }
 catch( nlohmann::json::parse_error& error )
 {
 wxLogTrace( traceSettings, wxT( "Json parse error reading %s: %s" ), aPath, error.what() );
 
 return false;
 }
 
 // Now that we have new data in the JSON structure, load the params again
 Load();
 return true;
}

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

{
 int filever = m_internals->Get<int>( "meta.version" );
 
 while( filever < m_schemaVersion )
 {
 if( !m_migrators.count( filever ) )
 {
 wxLogTrace( traceSettings, wxT( "Migrator missing for %s version %d!" ),
 typeid( *this ).name(), filever );
 return false;
 }
 
 std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
 
 if( pair.second() )
 {
 wxLogTrace( traceSettings, wxT( "Migrated %s from %d to %d" ), typeid( *this ).name(),
 filever, pair.first );
 filever = pair.first;
 m_internals->At( "meta.version" ) = filever;
 }
 else
 {
 wxLogTrace( traceSettings, wxT( "Migration failed for %s from %d to %d" ),
 typeid( *this ).name(), filever, pair.first );
 return false;
 }
 }
 
 return true;
}

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

{
 wxLogTrace( traceSettings,
 wxT( "MigrateFromLegacy() not implemented for %s" ), typeid( *this ).name() );
 return false;
}

References traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ operator!=()

bool ERC_SETTINGS::operator!= ( const ERC_SETTINGS & other ) const

inline

Definition at line 125 of file erc_settings.h.

 {
 return !( other == *this );
 }

◆ operator==()

bool ERC_SETTINGS::operator== ( const ERC_SETTINGS & other ) const

inline

Definition at line 120 of file erc_settings.h.

 {
 return ( other.m_ERCSeverities == m_ERCSeverities );
 }

References m_ERCSeverities.

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

{
 wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
 wxASSERT( aNewSchemaVersion <= m_schemaVersion );
 m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
}

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(), NET_SETTINGS::NET_SETTINGS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS(), 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 797 of file json_settings.cpp.

{
 if( !aSettings || !m_manager )
 return;
 
 auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
 [&aSettings]( const JSON_SETTINGS* aPtr ) {
 return aPtr == aSettings;
 } );
 
 if( it != m_nested_settings.end() )
 {
 wxLogTrace( traceSettings, wxT( "Flush and release %s" ), ( *it )->GetFilename() );
 ( *it )->SaveToFile();
 m_nested_settings.erase( it );
 }
 
 aSettings->SetParent( nullptr );
}

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

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

◆ ResetPinMap()

void ERC_SETTINGS::ResetPinMap ( )

Definition at line 268 of file erc_settings.cpp.

{
 memcpy( m_PinMap, m_defaultPinMap, sizeof( m_PinMap ) );
}

References m_defaultPinMap, and m_PinMap.

Referenced by ERC_SETTINGS(), and PANEL_SETUP_PINMAP::ResetPanel().

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )

inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 367 of file json_settings.cpp.

{
 for( auto param : m_params )
 param->SetDefault();
}

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 NESTED_SETTINGS::SaveToFile	(	const wxString &	aDirectory = `""`,
		bool	aForce = `false`
	)

overridevirtualinherited

Calls Store() and then saves the JSON document contents into the parent JSON_SETTINGS.

Parameters

aDirectory is ignored

Returns: true if the document contents were updated

Reimplemented from JSON_SETTINGS.

Definition at line 115 of file nested_settings.cpp.

{
 if( !m_parent )
 return false;
 
 LOCALE_IO dummy;
 
 try
 {
 bool modified = Store();
 
 auto jsonObjectInParent = m_parent->GetJson( m_path );
 
 if( !jsonObjectInParent )
 modified = true;
 else if( !nlohmann::json::diff( *m_internals, jsonObjectInParent.value() ).empty() )
 modified = true;
 
 if( modified || aForce )
 {
 ( *m_parent->m_internals )[m_path].update( *m_internals );
 
 wxLogTrace( traceSettings, wxS( "Stored NESTED_SETTINGS %s with schema %d" ),
 GetFilename(),
 m_schemaVersion );
 }
 
 return modified;
 }
 catch( ... )
 {
 wxLogTrace( traceSettings, wxS( "NESTED_SETTINGS %s: Could not store to %s at %s" ),
 m_filename,
 m_parent->GetFilename(),
 m_path );
 
 return false;
 }
}

References dummy, JSON_SETTINGS::GetFilename(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::m_filename, JSON_SETTINGS::m_internals, NESTED_SETTINGS::m_parent, NESTED_SETTINGS::m_path, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::Store(), and traceSettings.

◆ Set() [1/3]

template<typename ValueType >

template void JSON_SETTINGS::Set< const char * >	(	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 571 of file json_settings.cpp.

{
 m_internals->SetFromString( aPath, aVal );
}

References JSON_SETTINGS::m_internals.

◆ Set() [2/3]

template<>

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

inherited

Definition at line 829 of file json_settings.cpp.

{
 ( *m_internals )[aPath] = aVal.ToUTF8();
}

◆ Set() [3/3]

template<>

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

inherited

◆ SetFilename()

void JSON_SETTINGS::SetFilename ( const wxString & aFilename )

inlineinherited

Definition at line 77 of file json_settings.h.

77{ m_filename = aFilename; }

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

aObj	is the source object
aTarget	is the storage destination

Returns: True if set, false if not

Definition at line 656 of file json_settings.cpp.

{
 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
 
 if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
 {
 aTarget = aObj.at( ptr ).get<bool>();
 return true;
 }
 
 return false;
}

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

{
 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
 
 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
 {
 aTarget = aObj.at( ptr ).get<int>();
 return true;
 }
 
 return false;
}

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

{
 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
 
 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
 {
 aTarget = aObj.at( ptr ).get<unsigned int>();
 return true;
 }
 
 return false;
}

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

{
 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
 
 if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
 {
 aTarget = aObj.at( ptr ).get<wxString>();
 return true;
 }
 
 return false;
}

References JSON_SETTINGS_INTERNALS::PointerFromString().

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

◆ SetLegacyFilename()

void JSON_SETTINGS::SetLegacyFilename ( const wxString & aFilename )

inlineinherited

Definition at line 82 of file json_settings.h.

82{ m_legacy_filename = aFilename; }

JSON_SETTINGS::m_legacy_filename

wxString m_legacy_filename

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

Definition: json_settings.h:300

References JSON_SETTINGS::m_legacy_filename.

Referenced by SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS().

◆ SetLocation()

void JSON_SETTINGS::SetLocation ( SETTINGS_LOC aLocation )

inlineinherited

Definition at line 79 of file json_settings.h.

79{ m_location = aLocation; }

References JSON_SETTINGS::m_location.

Referenced by COLOR_SETTINGS::COLOR_SETTINGS().

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER * aManager )

inlineinherited

Definition at line 191 of file json_settings.h.

 {
 m_manager = aManager;
 }

References JSON_SETTINGS::m_manager.

◆ SetParent()

void NESTED_SETTINGS::SetParent	(	JSON_SETTINGS *	aParent,
		bool	aLoadFromFile = `true`
	)

inherited

Definition at line 156 of file nested_settings.cpp.

{
 m_parent = aParent;
 
 if( m_parent )
 {
 m_parent->AddNestedSettings( this );
 
 // In case we were created after the parent's ctor
 if( aLoadFromFile )
 LoadFromFile();
 }
}

References JSON_SETTINGS::AddNestedSettings(), NESTED_SETTINGS::LoadFromFile(), and NESTED_SETTINGS::m_parent.

Referenced by BOARD::ClearProject(), NESTED_SETTINGS::NESTED_SETTINGS(), and JSON_SETTINGS::ReleaseNestedSettings().

◆ SetPinMapValue() [1/2]

void ERC_SETTINGS::SetPinMapValue	(	ELECTRICAL_PINTYPE	aFirstType,
		ELECTRICAL_PINTYPE	aSecondType,
		PIN_ERROR	aValue
	)

inline

Definition at line 160 of file erc_settings.h.

 {
 m_PinMap[static_cast<int>( aFirstType )][static_cast<int>( aSecondType )] = aValue;
 }

References m_PinMap.

◆ SetPinMapValue() [2/2]

void ERC_SETTINGS::SetPinMapValue	(	int	aFirstType,
		int	aSecondType,
		PIN_ERROR	aValue
	)

inline

Definition at line 153 of file erc_settings.h.

 {
 wxASSERT( aFirstType < ELECTRICAL_PINTYPES_TOTAL
 && aSecondType < ELECTRICAL_PINTYPES_TOTAL );
 m_PinMap[aFirstType][aSecondType] = aValue;
 }

References ELECTRICAL_PINTYPES_TOTAL, and m_PinMap.

Referenced by PANEL_SETUP_PINMAP::changeErrorLevel(), and ERC_SETTINGS().

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool aReadOnly )

inlineinherited

Definition at line 85 of file json_settings.h.

85{ m_writeFile = !aReadOnly; }

References JSON_SETTINGS::m_writeFile.

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

◆ SetSeverity()

void ERC_SETTINGS::SetSeverity	(	int	aErrorCode,
		SEVERITY	aSeverity
	)

Definition at line 262 of file erc_settings.cpp.

{
 m_ERCSeverities[ aErrorCode ] = aSeverity;
}

References m_ERCSeverities.

Referenced by DIALOG_ERC::OnERCItemRClick().

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

Definition at line 353 of file json_settings.cpp.

{
 bool modified = false;
 
 for( auto param : m_params )
 {
 modified |= !param->MatchesFile( this );
 param->Store( this );
 }
 
 return modified;
}

References JSON_SETTINGS::m_params.

Referenced by 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 318 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 312 of file json_settings.h.

Referenced by JSON_SETTINGS::SaveToFile().

◆ m_defaultPinMap

PIN_ERROR ERC_SETTINGS::m_defaultPinMap

staticprivate

Initial value:

=
{
 
 { OK, OK, OK, OK, OK, OK, WAR, OK, OK, OK, OK, ERR },
 { OK, ERR, OK, WAR, OK, OK, WAR, OK, ERR, ERR, ERR, ERR },
 { OK, OK, OK, OK, OK, OK, WAR, OK, WAR, OK, WAR, ERR },
 { OK, WAR, OK, OK, OK, OK, WAR, WAR, ERR, WAR, WAR, ERR },
 { OK, OK, OK, OK, OK, OK, WAR, OK, OK, OK, OK, ERR },
 { OK, OK, OK, OK, OK, OK, OK, OK, OK, OK, OK, ERR },
 { WAR, WAR, WAR, WAR, WAR, OK, WAR, WAR, WAR, WAR, WAR, ERR },
 { OK, OK, OK, WAR, OK, OK, WAR, OK, OK, OK, OK, ERR },
 { OK, ERR, WAR, ERR, OK, OK, WAR, OK, ERR, ERR, ERR, ERR },
 { OK, ERR, OK, WAR, OK, OK, WAR, OK, ERR, OK, OK, ERR },
 { OK, ERR, WAR, WAR, OK, OK, WAR, OK, ERR, OK, OK, ERR },
 { ERR, ERR, ERR, ERR, ERR, ERR, ERR, ERR, ERR, ERR, ERR, ERR }
}

Default Look up table which gives the ERC error level for a pair of connected pins.

Definition at line 182 of file erc_settings.h.

Referenced by ResetPinMap().

◆ m_deleteLegacyAfterMigration

bool JSON_SETTINGS::m_deleteLegacyAfterMigration

protectedinherited

Whether or not to delete legacy file after migration.

Definition at line 324 of file json_settings.h.

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

◆ m_ErcExclusions

std::set<wxString> ERC_SETTINGS::m_ErcExclusions

Definition at line 174 of file erc_settings.h.

Referenced by ERC_SETTINGS(), SCH_EDIT_FRAME::RecordERCExclusions(), and SCHEMATIC::ResolveERCExclusions().

◆ m_ERCSeverities

std::map<int, SEVERITY> ERC_SETTINGS::m_ERCSeverities

Definition at line 173 of file erc_settings.h.

Referenced by BOOST_FIXTURE_TEST_CASE(), DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP(), ERC_SETTINGS(), GetSeverity(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), operator==(), and SetSeverity().

◆ m_filename

wxString JSON_SETTINGS::m_filename

protectedinherited

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

Definition at line 297 of file json_settings.h.

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

◆ m_internals

std::unique_ptr<JSON_SETTINGS_INTERNALS> JSON_SETTINGS::m_internals

protectedinherited

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

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

◆ m_location

SETTINGS_LOC JSON_SETTINGS::m_location

protectedinherited

The location of this settings file (.

See also: SETTINGS_LOC)

Definition at line 303 of file json_settings.h.

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

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), JSON_SETTINGS::ReleaseNestedSettings(), and JSON_SETTINGS::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 336 of file json_settings.h.

Referenced by JSON_SETTINGS::Migrate(), and JSON_SETTINGS::registerMigration().

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

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

◆ m_params

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

protectedinherited

The list of parameters (owned by this object)

Definition at line 306 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(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), GERBVIEW_SETTINGS::GERBVIEW_SETTINGS(), COLOR_SETTINGS::GetDefaultColor(), COLOR_SETTINGS::initFromOther(), JSON_SETTINGS::JSON_SETTINGS(), KICAD_SETTINGS::KICAD_SETTINGS(), JSON_SETTINGS::Load(), NET_SETTINGS::NET_SETTINGS(), NGSPICE_SIMULATOR_SETTINGS::NGSPICE_SIMULATOR_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(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), SPICE_SIMULATOR_SETTINGS::SPICE_SIMULATOR_SETTINGS(), JSON_SETTINGS::Store(), SYMBOL_EDITOR_SETTINGS::SYMBOL_EDITOR_SETTINGS(), and JSON_SETTINGS::~JSON_SETTINGS().

◆ m_parent

JSON_SETTINGS* NESTED_SETTINGS::m_parent

protectedinherited

A pointer to the parent object to load and store from.

Definition at line 62 of file nested_settings.h.

Referenced by NESTED_SETTINGS::GetParent(), NESTED_SETTINGS::LoadFromFile(), NESTED_SETTINGS::SaveToFile(), NESTED_SETTINGS::SetParent(), BOARD_DESIGN_SETTINGS::~BOARD_DESIGN_SETTINGS(), ~ERC_SETTINGS(), NESTED_SETTINGS::~NESTED_SETTINGS(), NET_SETTINGS::~NET_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().

◆ m_path

std::string NESTED_SETTINGS::m_path

protectedinherited

The path (in pointer format) of where to store this document in the parent.

Definition at line 65 of file nested_settings.h.

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

◆ m_PinMap

PIN_ERROR ERC_SETTINGS::m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]

Definition at line 176 of file erc_settings.h.

Referenced by GetPinMapValue(), DIALOG_SCHEMATIC_SETUP::onAuxiliaryAction(), ResetPinMap(), and SetPinMapValue().

◆ m_PinMinDrive

int ERC_SETTINGS::m_PinMinDrive

static

Initial value:

=
{
 
 { NOD, DRV, DRV, DRV, DRV, NOD, DRV, NOD, DRV, DRV, DRV, NPI },
 { DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, DRV, DRV, NPI },
 { DRV, DRV, DRV, DRV, DRV, NOD, DRV, NOD, DRV, DRV, DRV, NPI },
 { DRV, DRV, DRV, DRV, DRV, NOD, DRV, NOD, DRV, DRV, DRV, NPI },
 { DRV, DRV, DRV, DRV, DRV, NOD, DRV, NOD, DRV, DRV, DRV, NPI },
 { NOD, NOD, NOD, NOD, NOD, NOD, NOD, NOD, NOD, NOD, NOD, NPI },
 { DRV, DRV, DRV, DRV, DRV, NOD, DRV, NOD, DRV, DRV, DRV, NPI },
 { NOD, DRV, NOD, NOD, NOD, NOD, NOD, NOD, DRV, NOD, NOD, NPI },
 { DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, DRV, DRV, NPI },
 { DRV, DRV, DRV, DRV, DRV, NOD, DRV, NOD, DRV, DRV, DRV, NPI },
 { DRV, DRV, DRV, DRV, DRV, NOD, DRV, NOD, DRV, DRV, DRV, NPI },
 { NPI, NPI, NPI, NPI, NPI, NPI, NPI, NPI, NPI, NPI, NPI, NPI }
}

Look up table which gives the minimal drive for a pair of connected pins on a net.

The initial state of a net is NOC (Net with No Connection). It can be updated to NPI (Pin Isolated), NET_NC (Net with a no connect symbol), NOD (Not Driven) or DRV (DRIven). It can be updated to NET_NC with no error only if there is only one pin in net. Nets are OK when their final state is NET_NC or DRV. Nets with the state NOD have no valid source signal.

Definition at line 178 of file erc_settings.h.

Referenced by GetPinMinDrive().

◆ 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 327 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 330 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 321 of file json_settings.h.

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ERC_SETTINGS()

◆ ~ERC_SETTINGS()

Member Function Documentation

◆ AddNestedSettings()

◆ At()

◆ Contains()

◆ fetchOrDefault()

◆ FormatAsString()

◆ fromLegacy()

◆ fromLegacyColor()

◆ fromLegacyString()

◆ Get() [1/2]

◆ Get() [2/2]

◆ getFileExt()

◆ GetFilename()

◆ GetFullFilename()

◆ GetJson()

◆ getLegacyFileExt()

◆ GetLocation()

◆ GetParent()

◆ GetPinMapValue() [1/2]

◆ GetPinMapValue() [2/2]

◆ GetPinMinDrive()

◆ GetSeverity()

◆ Internals()

◆ IsReadOnly()

◆ IsTestEnabled()

◆ Load()

◆ LoadFromFile()

◆ LoadFromRawFile()

◆ Migrate()

◆ MigrateFromLegacy()

◆ operator!=()

◆ operator==()

◆ registerMigration()

◆ ReleaseNestedSettings()

◆ ResetPinMap()

◆ ResetToDefaults()

◆ SaveToFile()

◆ Set() [1/3]

◆ Set() [2/3]

◆ Set() [3/3]

◆ SetFilename()

◆ SetIfPresent() [1/4]

◆ SetIfPresent() [2/4]

◆ SetIfPresent() [3/4]

◆ SetIfPresent() [4/4]

◆ SetLegacyFilename()

◆ SetLocation()

◆ SetManager()

◆ SetParent()

◆ SetPinMapValue() [1/2]

◆ SetPinMapValue() [2/2]

◆ SetReadOnly()

◆ SetSeverity()

◆ Store()

Member Data Documentation

◆ m_createIfDefault

◆ m_createIfMissing

◆ m_defaultPinMap

◆ m_deleteLegacyAfterMigration

◆ m_ErcExclusions

◆ m_ERCSeverities

◆ m_filename

◆ m_internals

◆ m_legacy_filename

◆ m_location

◆ m_manager

◆ m_migrators

◆ m_nested_settings