KiCad PCB EDA Suite
ERC_SETTINGS Class Reference

Container for ERC settings. More...

#include <erc_settings.h>

Inheritance diagram for ERC_SETTINGS:
NESTED_SETTINGS JSON_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_SETTINGSGetParent ()
 
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::jsonAt (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_INTERNALSInternals ()
 
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::jsonGetJson (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, SEVERITYm_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_SETTINGSm_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_MANAGERm_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_INTERNALSm_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.

87 :
88 NESTED_SETTINGS( "erc", ercSettingsSchemaVersion, aParent, aPath )
89{
91
92 for( int i = ERCE_FIRST; i <= ERCE_LAST; ++i )
94
95 // Error is the default setting so set non-error priorities here.
109
110 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "rule_severities",
111 [&]() -> nlohmann::json
112 {
113 nlohmann::json ret = {};
114
115 for( const RC_ITEM& item : ERC_ITEM::GetItemsWithSeverities() )
116 {
117 wxString name = item.GetSettingsKey();
118 int code = item.GetErrorCode();
119
120 if( name.IsEmpty() || m_ERCSeverities.count( code ) == 0 )
121 continue;
122
123 ret[std::string( name.ToUTF8() )] = SeverityToString( m_ERCSeverities[code] );
124 }
125
126 return ret;
127 },
128 [&]( const nlohmann::json& aJson )
129 {
130 if( !aJson.is_object() )
131 return;
132
133 for( const RC_ITEM& item : ERC_ITEM::GetItemsWithSeverities() )
134 {
135 int code = item.GetErrorCode();
136 wxString name = item.GetSettingsKey();
137
138 std::string key( name.ToUTF8() );
139
140 if( aJson.contains( key ) )
141 m_ERCSeverities[code] = SeverityFromString( aJson[key] );
142 }
143 },
144 {} ) );
145
146 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "erc_exclusions",
147 [&]() -> nlohmann::json
148 {
149 nlohmann::json js = nlohmann::json::array();
150
151 for( const auto& entry : m_ErcExclusions )
152 js.push_back( entry );
153
154 return js;
155 },
156 [&]( const nlohmann::json& aObj )
157 {
158 m_ErcExclusions.clear();
159
160 if( !aObj.is_array() )
161 return;
162
163 for( const nlohmann::json& entry : aObj )
164 {
165 if( entry.empty() )
166 continue;
167
168 m_ErcExclusions.insert( entry.get<wxString>() );
169 }
170 },
171 {} ) );
172
173 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "pin_map",
174 [&]() -> nlohmann::json
175 {
176 nlohmann::json ret = nlohmann::json::array();
177
178 for( int i = 0; i < ELECTRICAL_PINTYPES_TOTAL; i++ )
179 {
180 nlohmann::json inner = nlohmann::json::array();
181
182 for( int j = 0; j < ELECTRICAL_PINTYPES_TOTAL; j++ )
183 inner.push_back( static_cast<int>( GetPinMapValue( i, j ) ) );
184
185 ret.push_back( inner );
186 }
187
188 return ret;
189 },
190 [&]( const nlohmann::json& aJson )
191 {
192 if( !aJson.is_array() || aJson.size() != ELECTRICAL_PINTYPES_TOTAL )
193 return;
194
195 for( size_t i = 0; i < ELECTRICAL_PINTYPES_TOTAL; i++ )
196 {
197 if( i > aJson.size() - 1 )
198 break;
199
200 nlohmann::json inner = aJson[i];
201
202 if( !inner.is_array() || inner.size() != ELECTRICAL_PINTYPES_TOTAL )
203 return;
204
205 for( size_t j = 0; j < ELECTRICAL_PINTYPES_TOTAL; j++ )
206 {
207 if( inner[j].is_number_integer() )
208 {
209 int val = inner[j].get<int>();
210
211 if( val >= 0 && val <= static_cast<int>( PIN_ERROR::UNCONNECTED ) )
212 SetPinMapValue( i, j, static_cast<PIN_ERROR>( val ) );
213 }
214 }
215 }
216 },
217 {} ) );
218}
const char * name
Definition: DXF_plotter.cpp:56
static std::vector< std::reference_wrapper< RC_ITEM > > GetItemsWithSeverities()
Definition: erc_item.h:76
void ResetPinMap()
PIN_ERROR GetPinMapValue(int aFirstType, int aSecondType) const
Definition: erc_settings.h:141
std::map< int, SEVERITY > m_ERCSeverities
Definition: erc_settings.h:173
std::set< wxString > m_ErcExclusions
Definition: erc_settings.h:174
void SetPinMapValue(int aFirstType, int aSecondType, PIN_ERROR aValue)
Definition: erc_settings.h:153
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
friend class NESTED_SETTINGS
Definition: json_settings.h:62
A holder for a rule check item, DRC in Pcbnew or ERC in Eeschema.
Definition: rc_item.h:75
const int ercSettingsSchemaVersion
@ ERCE_UNSPECIFIED
Definition: erc_settings.h:38
@ ERCE_DRIVER_CONFLICT
Conflicting drivers (labels, etc) on a subgraph.
Definition: erc_settings.h:61
@ ERCE_SIMILAR_LABELS
2 labels are equal for case insensitive comparisons.
Definition: erc_settings.h:51
@ ERCE_FIRST
Definition: erc_settings.h:39
@ ERCE_ENDPOINT_OFF_GRID
Pin or wire-end off grid.
Definition: erc_settings.h:41
@ ERCE_LAST
Definition: erc_settings.h:81
@ ERCE_BUS_ENTRY_CONFLICT
A wire connected to a bus doesn't match the bus.
Definition: erc_settings.h:62
@ ERCE_GLOBLABEL
A global label is unique.
Definition: erc_settings.h:69
@ ERCE_NOCONNECT_NOT_CONNECTED
A no connect symbol is not connected to anything.
Definition: erc_settings.h:49
@ ERCE_NOCONNECT_CONNECTED
A no connect symbol is connected to more than 1 pin.
Definition: erc_settings.h:48
@ ERCE_PIN_TO_PIN_WARNING
Definition: erc_settings.h:85
@ ERCE_MISSING_INPUT_PIN
Symbol has input pins that are not placed.
Definition: erc_settings.h:55
@ ERCE_MISSING_UNIT
Symbol has units that are not placed on the schematic.
Definition: erc_settings.h:57
@ ERCE_MISSING_BIDI_PIN
Symbol has bi-directional pins that are not placed.
Definition: erc_settings.h:56
@ ERCE_LIB_SYMBOL_ISSUES
Library symbol changed from current symbol in schematic or the library symbol link no longer valid.
Definition: erc_settings.h:73
PIN_ERROR
The values a pin-to-pin entry in the pin matrix can take on.
Definition: erc_settings.h:93
nlohmann::json json
Definition: gerbview.cpp:44
#define ELECTRICAL_PINTYPES_TOTAL
Definition: pin_type.h:53
@ RPT_SEVERITY_WARNING
@ RPT_SEVERITY_ERROR
@ RPT_SEVERITY_UNDEFINED
wxString SeverityToString(const SEVERITY &aSeverity)
Definition: ui_common.cpp:59

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.

222{
223 if( m_parent )
224 {
226 m_parent = nullptr;
227 }
228}
void ReleaseNestedSettings(NESTED_SETTINGS *aSettings)
Saves and frees a nested settings object, if it exists within this one.
JSON_SETTINGS * m_parent
A pointer to the parent object to load and store from.

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
aSettingsis the settings object to take ownership of
aTargetis a pointer to update to the passed in settings

Definition at line 790 of file json_settings.cpp.

791{
792 wxLogTrace( traceSettings, wxT( "AddNestedSettings %s" ), aSettings->GetFilename() );
793 m_nested_settings.push_back( aSettings );
794}
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
wxString GetFilename() const
Definition: json_settings.h:73
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

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.

112{
113 return m_internals->At( aPath );
114}
std::unique_ptr< JSON_SETTINGS_INTERNALS > m_internals

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

◆ 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
ResultTypeis the type of the retrieved value.
Parameters
aJsonis the object to act on .
aKeyis the object key to retrieve the value for.
Returns
the result, or aDefault if aKey is not found.

Definition at line 849 of file json_settings.cpp.

851{
852 ResultType ret = aDefault;
853
854 try
855 {
856 if( aJson.contains( aKey ) )
857 ret = aJson.at( aKey ).get<ResultType>();
858 }
859 catch( ... )
860 {
861 }
862
863 return ret;
864}

◆ FormatAsString()

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

Definition at line 478 of file json_settings.cpp.

479{
481
482 std::stringstream buffer;
483 buffer << std::setw( 2 ) << *m_internals << std::endl;
484
485 return buffer.str();
486}
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:41
std::vector< FAB_LAYER_COLOR > dummy

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
ValueTypeis the basic type of the value
Parameters
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 702 of file json_settings.cpp.

704{
705 ValueType val;
706
707 if( aConfig->Read( aKey, &val ) )
708 {
709 try
710 {
711 ( *m_internals )[aDest] = val;
712 }
713 catch( ... )
714 {
715 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
716 return false;
717 }
718
719 return true;
720 }
721
722 return false;
723}

◆ fromLegacyColor()

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

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

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

Definition at line 762 of file json_settings.cpp.

764{
765 wxString str;
766
767 if( aConfig->Read( aKey, &str ) )
768 {
770 color.SetFromWxString( str );
771
772 try
773 {
774 nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
775 ( *m_internals )[aDest] = js;
776 }
777 catch( ... )
778 {
779 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
780 return false;
781 }
782
783 return true;
784 }
785
786 return false;
787}
int color
Definition: DXF_plotter.cpp:57
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:102

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
aConfigis the legacy config to read from
aKeyis the key (within the current path) to read
aDestis a string that will form a JSON pointer (key1.key2.key3) to write to

Definition at line 738 of file json_settings.cpp.

740{
741 wxString str;
742
743 if( aConfig->Read( aKey, &str ) )
744 {
745 try
746 {
747 ( *m_internals )[aDest] = str.ToUTF8();
748 }
749 catch( ... )
750 {
751 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
752 return false;
753 }
754
755 return true;
756 }
757
758 return false;
759}

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.

821{
822 if( std::optional<nlohmann::json> opt_json = GetJson( aPath ) )
823 return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
824
825 return std::nullopt;
826}
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....

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
ValueTypeis the type to cast to
Parameters
aPathis the path within the document to retrieve
Returns
a value from within this document

Definition at line 541 of file json_settings.cpp.

542{
543 if( std::optional<nlohmann::json> ret = GetJson( aPath ) )
544 {
545 try
546 {
547 return ret->get<ValueType>();
548 }
549 catch( ... )
550 {
551 }
552 }
553
554 return std::nullopt;
555}

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.

276 {
277 return wxT( "json" );
278 }

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 105 of file json_settings.cpp.

106{
107 return wxString( m_filename + "." + getFileExt() );
108}
virtual wxString getFileExt() const

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

522{
523 nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
524
525 if( m_internals->contains( ptr ) )
526 {
527 try
528 {
529 return std::optional<nlohmann::json>{ m_internals->at( ptr ) };
530 }
531 catch( ... )
532 {
533 }
534 }
535
536 return std::optional<nlohmann::json>{};
537}

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.

281 {
282 return wxEmptyString;
283 }

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; }
SETTINGS_LOC m_location
The location of this settings file (.

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.

55 {
56 return m_parent;
57 }

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.

149 {
150 return m_PinMap[static_cast<int>( aFirstType )][static_cast<int>( aSecondType )];
151 }
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:176

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.

142 {
143 wxASSERT( aFirstType < ELECTRICAL_PINTYPES_TOTAL
144 && aSecondType < ELECTRICAL_PINTYPES_TOTAL );
145 return m_PinMap[aFirstType][aSecondType];
146 }

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.

167 {
168 return m_PinMinDrive[static_cast<int>( aFirstType )][static_cast<int>( aSecondType )];
169 }
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.
Definition: erc_settings.h:178

References m_PinMinDrive.

◆ GetSeverity()

SEVERITY ERC_SETTINGS::GetSeverity ( int  aErrorCode) const

Definition at line 231 of file erc_settings.cpp.

232{
233 // Special-case pin-to-pin errors:
234 // Ignore-or-not is controlled by ERCE_PIN_TO_PIN_WARNING (for both)
235 // Warning-or-error is controlled by which errorCode it is
236 if( aErrorCode == ERCE_PIN_TO_PIN_ERROR )
237 {
238 wxASSERT( m_ERCSeverities.count( ERCE_PIN_TO_PIN_WARNING ) );
239
241 return RPT_SEVERITY_IGNORE;
242 else
243 return RPT_SEVERITY_ERROR;
244 }
245 else if( aErrorCode == ERCE_PIN_TO_PIN_WARNING )
246 {
247 wxASSERT( m_ERCSeverities.count( ERCE_PIN_TO_PIN_WARNING ) );
248
250 return RPT_SEVERITY_IGNORE;
251 else
253 }
254
255 wxCHECK_MSG( m_ERCSeverities.count( aErrorCode ), RPT_SEVERITY_IGNORE,
256 wxS( "Missing severity from map in ERC_SETTINGS!" ) );
257
258 return m_ERCSeverities.at( aErrorCode );
259}
@ ERCE_PIN_TO_PIN_ERROR
Definition: erc_settings.h:86
@ RPT_SEVERITY_IGNORE

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.

124{
125 return m_internals.get();
126}

References JSON_SETTINGS::m_internals.

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

◆ IsReadOnly()

◆ IsTestEnabled()

bool ERC_SETTINGS::IsTestEnabled ( int  aErrorCode) const
inline

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

130{
131 for( auto param : m_params )
132 {
133 try
134 {
135 param->Load( this, m_resetParamsIfMissing );
136 }
137 catch( ... )
138 {
139 // Skip unreadable parameters in file
140 wxLogTrace( traceSettings, wxT( "param '%s' load err" ), param->GetJsonPath().c_str() );
141 }
142 }
143}
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()

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(), 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_DISPLAY_OPTIONS::ResetPanel(), PANEL_EDIT_OPTIONS::ResetPanel(), PANEL_FP_EDITOR_DEFAULTS::ResetPanel(), PANEL_PCBNEW_DISPLAY_ORIGIN::ResetPanel(), and SETTINGS_MANAGER::SaveColorSettings().

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

44{
45 m_internals->clear();
46 bool success = false;
47
48 if( m_parent )
49 {
50 nlohmann::json::json_pointer ptr = m_internals->PointerFromString( m_path );
51
52 if( m_parent->m_internals->contains( ptr ) )
53 {
54 try
55 {
56 m_internals->update( m_parent->m_internals->at( ptr ) );
57
58 wxLogTrace( traceSettings, wxT( "Loaded NESTED_SETTINGS %s" ), GetFilename() );
59
60 success = true;
61 }
62 catch( ... )
63 {
64 wxLogTrace( traceSettings, wxT( "NESTED_SETTINGS %s: Could not load from %s at %s" ),
66 }
67 }
68 }
69
70 if( success )
71 {
72 int filever = -1;
73
74 try
75 {
76 filever = m_internals->Get<int>( "meta.version" );
77 }
78 catch( ... )
79 {
80 wxLogTrace( traceSettings, wxT( "%s: nested settings version could not be read!" ),
81 m_filename );
82 success = false;
83 }
84
85 if( filever >= 0 && filever < m_schemaVersion )
86 {
87 wxLogTrace( traceSettings, wxT( "%s: attempting migration from version %d to %d" ),
88 m_filename, filever, m_schemaVersion );
89
90 if( !Migrate() )
91 {
92 wxLogTrace( traceSettings, wxT( "%s: migration failed!" ), GetFullFilename() );
93 success = false;
94 }
95 }
96 else if( filever > m_schemaVersion )
97 {
98 wxLogTrace( traceSettings,
99 wxT( "%s: warning: nested settings version %d is newer than latest (%d)" ),
100 m_filename, filever, m_schemaVersion );
101 }
102 else if( filever >= 0 )
103 {
104 wxLogTrace( traceSettings, wxT( "%s: schema version %d is current" ),
105 m_filename, filever );
106 }
107 }
108
109 Load();
110
111 return success;
112}
virtual void Load()
Updates the parameters of this object based on the current JSON document contents.
wxString GetFullFilename() const
bool Migrate()
Migrates the schema of this settings from the version in the file to the latest version.
int m_schemaVersion
Version of this settings schema.
std::string m_path
The path (in pointer format) of where to store this document in the parent.

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.

490{
491 try
492 {
493 wxFFileInputStream fp( aPath, wxT( "rt" ) );
494 wxStdInputStream fstream( fp );
495
496 if( fp.IsOk() )
497 {
498 *static_cast<nlohmann::json*>( m_internals.get() ) =
499 nlohmann::json::parse( fstream, nullptr,
500 /* allow_exceptions = */ true,
501 /* ignore_comments = */ true );
502 }
503 else
504 {
505 return false;
506 }
507 }
508 catch( nlohmann::json::parse_error& error )
509 {
510 wxLogTrace( traceSettings, wxT( "Json parse error reading %s: %s" ), aPath, error.what() );
511
512 return false;
513 }
514
515 // Now that we have new data in the JSON structure, load the params again
516 Load();
517 return true;
518}
bool parse(std::istream &aStream, bool aVerbose)
Parse a PCB or footprint file from the given input stream.

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.

600{
601 int filever = m_internals->Get<int>( "meta.version" );
602
603 while( filever < m_schemaVersion )
604 {
605 if( !m_migrators.count( filever ) )
606 {
607 wxLogTrace( traceSettings, wxT( "Migrator missing for %s version %d!" ),
608 typeid( *this ).name(), filever );
609 return false;
610 }
611
612 std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
613
614 if( pair.second() )
615 {
616 wxLogTrace( traceSettings, wxT( "Migrated %s from %d to %d" ), typeid( *this ).name(),
617 filever, pair.first );
618 filever = pair.first;
619 m_internals->At( "meta.version" ) = filever;
620 }
621 else
622 {
623 wxLogTrace( traceSettings, wxT( "Migration failed for %s from %d to %d" ),
624 typeid( *this ).name(), filever, pair.first );
625 return false;
626 }
627 }
628
629 return true;
630}
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>

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

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

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.

126 {
127 return !( other == *this );
128 }

◆ operator==()

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

Definition at line 120 of file erc_settings.h.

121 {
122 return ( other.m_ERCSeverities == m_ERCSeverities );
123 }

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
aOldSchemaVersionis the starting schema version for this migration
aNewSchemaVersionis the ending schema version for this migration
aMigratoris a function that performs the migration and returns true if successful

Definition at line 590 of file json_settings.cpp.

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

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
aSettingsis a pointer to a NESTED_SETTINGS that has already been added to this one

Definition at line 797 of file json_settings.cpp.

798{
799 if( !aSettings || !m_manager )
800 return;
801
802 auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
803 [&aSettings]( const JSON_SETTINGS* aPtr ) {
804 return aPtr == aSettings;
805 } );
806
807 if( it != m_nested_settings.end() )
808 {
809 wxLogTrace( traceSettings, wxT( "Flush and release %s" ), ( *it )->GetFilename() );
810 ( *it )->SaveToFile();
811 m_nested_settings.erase( it );
812 }
813
814 aSettings->SetParent( nullptr );
815}
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)
void SetParent(JSON_SETTINGS *aParent, bool aLoadFromFile=true)

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.

269{
270 memcpy( m_PinMap, m_defaultPinMap, sizeof( m_PinMap ) );
271}
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.
Definition: erc_settings.h:182

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.

368{
369 for( auto param : m_params )
370 param->SetDefault();
371}

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
aDirectoryis ignored
Returns
true if the document contents were updated

Reimplemented from JSON_SETTINGS.

Definition at line 115 of file nested_settings.cpp.

116{
117 if( !m_parent )
118 return false;
119
121
122 try
123 {
124 bool modified = Store();
125
126 auto jsonObjectInParent = m_parent->GetJson( m_path );
127
128 if( !jsonObjectInParent )
129 modified = true;
130 else if( !nlohmann::json::diff( *m_internals, jsonObjectInParent.value() ).empty() )
131 modified = true;
132
133 if( modified || aForce )
134 {
135 ( *m_parent->m_internals )[m_path].update( *m_internals );
136
137 wxLogTrace( traceSettings, wxS( "Stored NESTED_SETTINGS %s with schema %d" ),
138 GetFilename(),
140 }
141
142 return modified;
143 }
144 catch( ... )
145 {
146 wxLogTrace( traceSettings, wxS( "NESTED_SETTINGS %s: Could not store to %s at %s" ),
149 m_path );
150
151 return false;
152 }
153}
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...

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
ValueTypeis the type to store
Parameters
aPathis a path to store in the form "key1.key2.key3"
aValis the value to store

Definition at line 571 of file json_settings.cpp.

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

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(), and PARAM_MAP< Value >::Store().

◆ Set() [2/3]

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

Definition at line 829 of file json_settings.cpp.

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

◆ Set() [3/3]

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

◆ SetFilename()

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

◆ SetIfPresent() [1/4]

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

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

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

Definition at line 656 of file json_settings.cpp.

658{
659 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
660
661 if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
662 {
663 aTarget = aObj.at( ptr ).get<bool>();
664 return true;
665 }
666
667 return false;
668}

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [2/4]

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

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

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

Definition at line 671 of file json_settings.cpp.

673{
674 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
675
676 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
677 {
678 aTarget = aObj.at( ptr ).get<int>();
679 return true;
680 }
681
682 return false;
683}

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [3/4]

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

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

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

Definition at line 686 of file json_settings.cpp.

688{
689 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
690
691 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
692 {
693 aTarget = aObj.at( ptr ).get<unsigned int>();
694 return true;
695 }
696
697 return false;
698}

References JSON_SETTINGS_INTERNALS::PointerFromString().

◆ SetIfPresent() [4/4]

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

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

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

Definition at line 641 of file json_settings.cpp.

643{
644 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
645
646 if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
647 {
648 aTarget = aObj.at( ptr ).get<wxString>();
649 return true;
650 }
651
652 return false;
653}

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; }
wxString m_legacy_filename
The filename of the wxConfig legacy file (if different from m_filename)

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.

192 {
193 m_manager = aManager;
194 }

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.

157{
158 m_parent = aParent;
159
160 if( m_parent )
161 {
163
164 // In case we were created after the parent's ctor
165 if( aLoadFromFile )
166 LoadFromFile();
167 }
168}
void AddNestedSettings(NESTED_SETTINGS *aSettings)
Transfers ownership of a given NESTED_SETTINGS to this object.
bool LoadFromFile(const wxString &aDirectory="") override
Loads the JSON document from the parent and then calls Load()

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.

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

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.

154 {
155 wxASSERT( aFirstType < ELECTRICAL_PINTYPES_TOTAL
156 && aSecondType < ELECTRICAL_PINTYPES_TOTAL );
157 m_PinMap[aFirstType][aSecondType] = aValue;
158 }

References ELECTRICAL_PINTYPES_TOTAL, and m_PinMap.

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

◆ SetReadOnly()

◆ SetSeverity()

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

Definition at line 262 of file erc_settings.cpp.

263{
264 m_ERCSeverities[ aErrorCode ] = aSeverity;
265}

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.

354{
355 bool modified = false;
356
357 for( auto param : m_params )
358 {
359 modified |= !param->MatchesFile( this );
360 param->Store( this );
361 }
362
363 return modified;
364}

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 }
}
#define ERR
#define WAR

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

◆ m_ERCSeverities

◆ m_filename

◆ m_internals

◆ 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

◆ m_parent

◆ 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

◆ 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 }
}
#define DRV
Definition: erc_settings.h:102
#define NOD
Definition: erc_settings.h:104
#define NPI
Types of drive on a net (used for legacy ERC)
Definition: erc_settings.h:101

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

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

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