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
 
int GetSeverity (int aErrorCode) const
 
void SetSeverity (int aErrorCode, int 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)
 
JSON_SETTINGSGetParent ()
 
wxString GetFilename () const
 
wxString GetFullFilename () const
 
void SetFilename (const wxString &aFilename)
 
SETTINGS_LOC GetLocation () const
 
void SetLegacyFilename (const wxString &aFilename)
 
bool IsReadOnly () const
 
void SetReadOnly (bool aReadOnly)
 
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...
 
OPT< 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 >
OPT< ValueType > Get (const std::string &aPath) const
 Fetches a value from within the JSON document. More...
 
template<>
OPT< 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)
 

Static Public Member Functions

static nlohmann::json::json_pointer PointerFromString (std::string aPath)
 Builds a JSON pointer based on a given string. More...
 
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, int > m_Severities
 
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
 

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::vector< nlohmann::json::json_pointer > m_preserved_paths
 A list of JSON pointers that are preserved during a read-update-write to disk. 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...
 

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 97 of file erc_settings.h.

Constructor & Destructor Documentation

◆ ERC_SETTINGS()

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

Definition at line 84 of file erc_settings.cpp.

84  :
85  NESTED_SETTINGS( "erc", ercSettingsSchemaVersion, aParent, aPath )
86 {
87  ResetPinMap();
88 
89  for( int i = ERCE_FIRST; i <= ERCE_LAST; ++i )
91 
92  // Error is the default setting so set non-error priorities here.
102 
103  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "rule_severities",
104  [&]() -> nlohmann::json
105  {
106  nlohmann::json ret = {};
107 
108  for( const RC_ITEM& item : ERC_ITEM::GetItemsWithSeverities() )
109  {
110  int code = item.GetErrorCode();
111 
112  if( !m_Severities.count( code ) )
113  continue;
114 
115  wxString name = item.GetSettingsKey();
116 
117  ret[std::string( name.ToUTF8() )] =
118  SeverityToString( static_cast<SEVERITY>( m_Severities[code] ) );
119  }
120 
121  return ret;
122  },
123  [&]( const nlohmann::json& aJson )
124  {
125  if( !aJson.is_object() )
126  return;
127 
128  for( const RC_ITEM& item : ERC_ITEM::GetItemsWithSeverities() )
129  {
130  int code = item.GetErrorCode();
131  wxString name = item.GetSettingsKey();
132 
133  std::string key( name.ToUTF8() );
134 
135  if( aJson.contains( key ) )
136  m_Severities[code] = SeverityFromString( aJson[key] );
137  }
138  },
139  {} ) );
140 
141  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "erc_exclusions",
142  [&]() -> nlohmann::json
143  {
144  nlohmann::json js = nlohmann::json::array();
145 
146  for( const auto& entry : m_ErcExclusions )
147  js.push_back( entry );
148 
149  return js;
150  },
151  [&]( const nlohmann::json& aObj )
152  {
153  m_ErcExclusions.clear();
154 
155  if( !aObj.is_array() )
156  return;
157 
158  for( const nlohmann::json& entry : aObj )
159  {
160  if( entry.empty() )
161  continue;
162 
163  m_ErcExclusions.insert( entry.get<wxString>() );
164  }
165  },
166  {} ) );
167 
168  m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "pin_map",
169  [&]() -> nlohmann::json
170  {
171  nlohmann::json ret = nlohmann::json::array();
172 
173  for( int i = 0; i < ELECTRICAL_PINTYPES_TOTAL; i++ )
174  {
175  nlohmann::json inner = nlohmann::json::array();
176 
177  for( int j = 0; j < ELECTRICAL_PINTYPES_TOTAL; j++ )
178  inner.push_back( static_cast<int>( GetPinMapValue( i, j ) ) );
179 
180  ret.push_back( inner );
181  }
182 
183  return ret;
184  },
185  [&]( const nlohmann::json& aJson )
186  {
187  if( !aJson.is_array() || aJson.size() != ELECTRICAL_PINTYPES_TOTAL )
188  return;
189 
190  for( size_t i = 0; i < ELECTRICAL_PINTYPES_TOTAL; i++ )
191  {
192  if( i > aJson.size() - 1 )
193  break;
194 
195  nlohmann::json inner = aJson[i];
196 
197  if( !inner.is_array() || inner.size() != ELECTRICAL_PINTYPES_TOTAL )
198  return;
199 
200  for( size_t j = 0; j < ELECTRICAL_PINTYPES_TOTAL; j++ )
201  {
202  if( inner[j].is_number_integer() )
203  {
204  int val = inner[j].get<int>();
205 
206  if( val >= 0 && val <= static_cast<int>( PIN_ERROR::UNCONNECTED ) )
207  SetPinMapValue( i, j, static_cast<PIN_ERROR>( val ) );
208  }
209  }
210  }
211  },
212  {} ) );
213 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
static std::vector< std::reference_wrapper< RC_ITEM > > GetItemsWithSeverities()
Definition: erc_item.h:50
A holder for a rule check item, DRC in Pcbnew or ERC in Eeschema.
Definition: rc_item.h:72
nlohmann::json json
Definition: gerbview.cpp:39
Library symbol changed from current symbol in schematic or the library symbol link no longer valid.
Definition: erc_settings.h:65
std::set< wxString > m_ErcExclusions
Definition: erc_settings.h:158
void ResetPinMap()
const int ercSettingsSchemaVersion
2 labels are equal for case insensitive comparisons.
Definition: erc_settings.h:49
std::map< int, int > m_Severities
Definition: erc_settings.h:157
A wire connected to a bus doesn't match the bus.
Definition: erc_settings.h:56
A no connect symbol is not connected to anything.
Definition: erc_settings.h:47
A global label is unique.
Definition: erc_settings.h:62
A no connect symbol is connected to more than 1 pin.
Definition: erc_settings.h:46
wxString SeverityToString(const SEVERITY &aSeverity)
Definition: ui_common.cpp:47
const char * name
Definition: DXF_plotter.cpp:59
SEVERITY SeverityFromString(const wxString &aSeverity)
Definition: ui_common.cpp:36
void SetPinMapValue(int aFirstType, int aSecondType, PIN_ERROR aValue)
Definition: erc_settings.h:137
NESTED_SETTINGS(const std::string &aName, int aSchemaVersion, JSON_SETTINGS *aParent, const std::string &aPath)
PIN_ERROR GetPinMapValue(int aFirstType, int aSecondType) const
Definition: erc_settings.h:125
#define ELECTRICAL_PINTYPES_TOTAL
Definition: pin_type.h:51
Conflicting drivers (labels, etc) on a subgraph.
Definition: erc_settings.h:55

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

◆ ~ERC_SETTINGS()

ERC_SETTINGS::~ERC_SETTINGS ( )
virtual

Definition at line 216 of file erc_settings.cpp.

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

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

657 {
658  wxLogTrace( traceSettings, "AddNestedSettings %s", aSettings->GetFilename() );
659  m_nested_settings.push_back( aSettings );
660 }
wxString GetFilename() const
Definition: json_settings.h:64
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
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().

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

570 {
571  ValueType val;
572 
573  if( aConfig->Read( aKey, &val ) )
574  {
575  try
576  {
577  ( *this )[PointerFromString( aDest )] = val;
578  }
579  catch( ... )
580  {
581  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
582  return false;
583  }
584 
585  return true;
586  }
587 
588  return false;
589 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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

630 {
631  wxString str;
632 
633  if( aConfig->Read( aKey, &str ) )
634  {
636  color.SetFromWxString( str );
637 
638  try
639  {
640  nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
641  ( *this )[PointerFromString( aDest )] = js;
642  }
643  catch( ... )
644  {
645  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
646  return false;
647  }
648 
649  return true;
650  }
651 
652  return false;
653 }
int color
Definition: DXF_plotter.cpp:60
nlohmann::json json
Definition: gerbview.cpp:39
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:100

References color, and JSON_SETTINGS::PointerFromString().

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

606 {
607  wxString str;
608 
609  if( aConfig->Read( aKey, &str ) )
610  {
611  try
612  {
613  ( *this )[PointerFromString( aDest )] = str.ToUTF8();
614  }
615  catch( ... )
616  {
617  wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
618  return false;
619  }
620 
621  return true;
622  }
623 
624  return false;
625 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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

◆ Get() [1/2]

template<typename ValueType >
OPT<ValueType> JSON_SETTINGS::Get ( const std::string &  aPath) const
inlineinherited

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

125  {
126  if( OPT<nlohmann::json> ret = GetJson( aPath ) )
127  {
128  try
129  {
130  return ret->get<ValueType>();
131  }
132  catch( ... )
133  {
134  }
135  }
136 
137  return NULLOPT;
138  }
OPT< 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....
const auto NULLOPT
Definition: optional.h:9
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

Referenced by PARAM< wxString >::Load(), COLOR_MAP_PARAM::Load(), PARAM_ENUM< EnumType >::Load(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_SCALED< ValueType >::Load(), BOARD_DESIGN_SETTINGS::LoadFromFile(), PARAM< wxString >::MatchesFile(), COLOR_MAP_PARAM::MatchesFile(), PARAM_PATH::MatchesFile(), PARAM_ENUM< EnumType >::MatchesFile(), PARAM_LAMBDA< nlohmann::json >::MatchesFile(), and PARAM_SCALED< ValueType >::MatchesFile().

◆ Get() [2/2]

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

Definition at line 686 of file json_settings.cpp.

687 {
688  if( OPT<nlohmann::json> opt_json = GetJson( aPath ) )
689  return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
690 
691  return NULLOPT;
692 }
OPT< 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....
const auto NULLOPT
Definition: optional.h:9
boost::optional< T > OPT
Definition: optional.h:7

References JSON_SETTINGS::GetJson(), and NULLOPT.

◆ getFileExt()

virtual wxString JSON_SETTINGS::getFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 274 of file json_settings.h.

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

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

◆ GetFilename()

◆ GetFullFilename()

wxString JSON_SETTINGS::GetFullFilename ( ) const
inherited

Definition at line 79 of file json_settings.cpp.

80 {
81  return wxString( m_filename + "." + getFileExt() );
82 }
wxString m_filename
The filename (not including path) of this settings file (inicode)
virtual wxString getFileExt() const

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

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

◆ GetJson()

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

418 {
419  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
420 
421  if( this->contains( ptr ) )
422  {
423  try
424  {
425  return OPT<nlohmann::json>{ this->at( ptr ) };
426  }
427  catch( ... )
428  {
429  }
430  }
431 
432  return OPT<nlohmann::json>{};
433 }
bool contains(const _Container &__container, _Value __value)
Returns true if the container contains the given value.
Definition: kicad_algo.h:81
boost::optional< T > OPT
Definition: optional.h:7
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References alg::contains(), and JSON_SETTINGS::PointerFromString().

Referenced by JSON_SETTINGS::Get(), PARAM_LAMBDA< nlohmann::json >::Load(), PARAM_LIST< wxString >::Load(), PARAM_MAP< Value >::Load(), PARAM_WXSTRING_MAP::Load(), PARAM_LAMBDA< nlohmann::json >::MatchesFile(), PARAM_LIST< wxString >::MatchesFile(), PARAM_PATH_LIST::MatchesFile(), PARAM_MAP< Value >::MatchesFile(), and PARAM_WXSTRING_MAP::MatchesFile().

◆ getLegacyFileExt()

virtual wxString JSON_SETTINGS::getLegacyFileExt ( ) const
inlineprotectedvirtualinherited

Reimplemented in PROJECT_FILE, and PROJECT_LOCAL_SETTINGS.

Definition at line 279 of file json_settings.h.

280  {
281  return wxEmptyString;
282  }

Referenced by JSON_SETTINGS::LoadFromFile().

◆ GetLocation()

SETTINGS_LOC JSON_SETTINGS::GetLocation ( ) const
inlineinherited

Definition at line 70 of file json_settings.h.

70 { 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  }
JSON_SETTINGS * m_parent
A pointer to the parent object to load and store from.

References NESTED_SETTINGS::m_parent.

Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile().

◆ GetPinMapValue() [1/2]

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

Definition at line 125 of file erc_settings.h.

126  {
127  wxASSERT( aFirstType < ELECTRICAL_PINTYPES_TOTAL
128  && aSecondType < ELECTRICAL_PINTYPES_TOTAL );
129  return m_PinMap[aFirstType][aSecondType];
130  }
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:160
#define ELECTRICAL_PINTYPES_TOTAL
Definition: pin_type.h:51

References ELECTRICAL_PINTYPES_TOTAL, and m_PinMap.

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

◆ GetPinMapValue() [2/2]

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

Definition at line 132 of file erc_settings.h.

133  {
134  return m_PinMap[static_cast<int>( aFirstType )][static_cast<int>( aSecondType )];
135  }
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:160

References m_PinMap.

◆ GetPinMinDrive()

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

Definition at line 150 of file erc_settings.h.

151  {
152  return m_PinMinDrive[static_cast<int>( aFirstType )][static_cast<int>( aSecondType )];
153  }
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:162

References m_PinMinDrive.

◆ GetSeverity()

int ERC_SETTINGS::GetSeverity ( int  aErrorCode) const

Definition at line 226 of file erc_settings.cpp.

227 {
228  // Special-case pin-to-pin errors:
229  // Ignore-or-not is controlled by ERCE_PIN_TO_PIN_WARNING (for both)
230  // Warning-or-error is controlled by which errorCode it is
231  if( aErrorCode == ERCE_PIN_TO_PIN_ERROR )
232  {
233  wxASSERT( m_Severities.count( ERCE_PIN_TO_PIN_WARNING ) );
234 
236  return RPT_SEVERITY_IGNORE;
237  else
238  return RPT_SEVERITY_ERROR;
239  }
240  else if( aErrorCode == ERCE_PIN_TO_PIN_WARNING )
241  {
242  wxASSERT( m_Severities.count( ERCE_PIN_TO_PIN_WARNING ) );
243 
245  return RPT_SEVERITY_IGNORE;
246  else
247  return RPT_SEVERITY_WARNING;
248  }
249 
250  wxCHECK_MSG( m_Severities.count( aErrorCode ), RPT_SEVERITY_IGNORE,
251  "Missing severity from map in ERC_SETTINGS!" );
252 
253  return m_Severities.at( aErrorCode );
254 }
std::map< int, int > m_Severities
Definition: erc_settings.h:157

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

Referenced by SHEETLIST_ERC_ITEMS_PROVIDER::GetCount(), IsTestEnabled(), DIALOG_ERC::OnERCItemRClick(), SHEETLIST_ERC_ITEMS_PROVIDER::SetSeverities(), and DIALOG_ERC::writeReport().

◆ IsReadOnly()

bool JSON_SETTINGS::IsReadOnly ( ) const
inlineinherited

◆ IsTestEnabled()

bool ERC_SETTINGS::IsTestEnabled ( int  aErrorCode) const
inline

Definition at line 114 of file erc_settings.h.

115  {
116  return GetSeverity( aErrorCode ) != RPT_SEVERITY_IGNORE;
117  }
int GetSeverity(int aErrorCode) const

References GetSeverity(), and RPT_SEVERITY_IGNORE.

Referenced by CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckNoConnects(), and CONNECTION_GRAPH::RunERC().

◆ Load()

void JSON_SETTINGS::Load ( )
virtualinherited

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

Definition at line 85 of file json_settings.cpp.

86 {
87  for( auto param : m_params )
88  {
89  try
90  {
91  param->Load( this, m_resetParamsIfMissing );
92  }
93  catch( ... )
94  {
95  // Skip unreadable parameters in file
96  wxLogTrace( traceSettings, "param '%s' load err", param->GetJsonPath().c_str() );
97  }
98  }
99 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
bool m_resetParamsIfMissing
Whether or not to set parameters to their default value if missing from JSON on Load()
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

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

Referenced by COLOR_SETTINGS::CreateBuiltinColorSettings(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), COLOR_SETTINGS::migrateSchema0to1(), 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 42 of file nested_settings.cpp.

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

References MULTIVECTOR< T, FIRST_TYPE_VAL, LAST_TYPE_VAL >::clear(), JSON_SETTINGS::GetFilename(), JSON_SETTINGS::GetFullFilename(), JSON_SETTINGS::Load(), JSON_SETTINGS::m_filename, NESTED_SETTINGS::m_parent, NESTED_SETTINGS::m_path, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::Migrate(), JSON_SETTINGS::PointerFromString(), and traceSettings.

Referenced by BOARD_DESIGN_SETTINGS::LoadFromFile(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), PNS::ROUTING_SETTINGS::ROUTING_SETTINGS(), NESTED_SETTINGS::SetParent(), and SCHEMATIC::SetProject().

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

446 {
447  int filever = at( PointerFromString( "meta.version" ) ).get<int>();
448 
449  while( filever < m_schemaVersion )
450  {
451  if( !m_migrators.count( filever ) )
452  {
453  wxLogTrace( traceSettings, "Migrator missing for %s version %d!",
454  typeid( *this ).name(), filever );
455  return false;
456  }
457 
458  std::pair<int, std::function<bool()>> pair = m_migrators.at( filever );
459 
460  if( pair.second() )
461  {
462  wxLogTrace( traceSettings, "Migrated %s from %d to %d", typeid( *this ).name(),
463  filever, pair.first );
464  filever = pair.first;
465  ( *this )[PointerFromString( "meta.version" )] = filever;
466  }
467  else
468  {
469  wxLogTrace( traceSettings, "Migration failed for %s from %d to %d",
470  typeid( *this ).name(), filever, pair.first );
471  return false;
472  }
473  }
474 
475  return true;
476 }
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>
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
int m_schemaVersion
Version of this settings schema.

References JSON_SETTINGS::m_migrators, JSON_SETTINGS::m_schemaVersion, JSON_SETTINGS::PointerFromString(), and traceSettings.

Referenced by NESTED_SETTINGS::LoadFromFile(), and JSON_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 PCBNEW_SETTINGS, EESCHEMA_SETTINGS, APP_SETTINGS_BASE, PCB_CALCULATOR_SETTINGS, COMMON_SETTINGS, EDA_3D_VIEWER_SETTINGS, PROJECT_FILE, COLOR_SETTINGS, PROJECT_LOCAL_SETTINGS, SYMBOL_EDITOR_SETTINGS, GERBVIEW_SETTINGS, FOOTPRINT_EDITOR_SETTINGS, CVPCB_SETTINGS, BITMAP2CMP_SETTINGS, PL_EDITOR_SETTINGS, and KICAD_SETTINGS.

Definition at line 479 of file json_settings.cpp.

480 {
481  wxLogTrace( traceSettings,
482  "MigrateFromLegacy() not implemented for %s", typeid( *this ).name() );
483  return false;
484 }
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.

References traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ operator!=()

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

Definition at line 109 of file erc_settings.h.

110  {
111  return !( other == *this );
112  }

◆ operator==()

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

Definition at line 104 of file erc_settings.h.

105  {
106  return ( other.m_Severities == m_Severities );
107  }
std::map< int, int > m_Severities
Definition: erc_settings.h:157

References m_Severities.

◆ PointerFromString()

nlohmann::json::json_pointer JSON_SETTINGS::PointerFromString ( std::string  aPath)
staticinherited

Builds a JSON pointer based on a given string.

Parameters
aPathis the path in the form "key1.key2.key3"
Returns
a JSON pointer that can be used to index into a JSON object

Definition at line 487 of file json_settings.cpp.

488 {
489  std::replace( aPath.begin(), aPath.end(), '.', '/' );
490  aPath.insert( 0, "/" );
491 
492  nlohmann::json::json_pointer p;
493 
494  try
495  {
496  p = nlohmann::json::json_pointer( aPath );
497  }
498  catch( ... )
499  {
500  wxASSERT_MSG( false, wxT( "Invalid pointer path in PointerFromString!" ) );
501  }
502 
503  return p;
504 }

Referenced by JSON_SETTINGS::fromLegacy(), JSON_SETTINGS::fromLegacyColor(), JSON_SETTINGS::fromLegacyString(), JSON_SETTINGS::GetJson(), JSON_SETTINGS::JSON_SETTINGS(), NESTED_SETTINGS::LoadFromFile(), JSON_SETTINGS::LoadFromFile(), BOARD_DESIGN_SETTINGS::LoadFromFile(), JSON_SETTINGS::Migrate(), APP_SETTINGS_BASE::migrateFindReplace(), FOOTPRINT_EDITOR_SETTINGS::MigrateFromLegacy(), GERBVIEW_SETTINGS::MigrateFromLegacy(), PROJECT_FILE::MigrateFromLegacy(), EDA_3D_VIEWER_SETTINGS::MigrateFromLegacy(), COMMON_SETTINGS::MigrateFromLegacy(), PCB_CALCULATOR_SETTINGS::MigrateFromLegacy(), APP_SETTINGS_BASE::MigrateFromLegacy(), EESCHEMA_SETTINGS::MigrateFromLegacy(), PCBNEW_SETTINGS::MigrateFromLegacy(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), PROJECT_LOCAL_SETTINGS::SaveToFile(), PROJECT_FILE::SaveToFile(), JSON_SETTINGS::Set(), and JSON_SETTINGS::SetIfPresent().

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

438 {
439  wxASSERT( aNewSchemaVersion > aOldSchemaVersion );
440  wxASSERT( aNewSchemaVersion <= m_schemaVersion );
441  m_migrators[aOldSchemaVersion] = std::make_pair( aNewSchemaVersion, aMigrator );
442 }
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>
int m_schemaVersion
Version of this settings schema.

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

Referenced by BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS(), COLOR_SETTINGS::COLOR_SETTINGS(), COMMON_SETTINGS::COMMON_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_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 663 of file json_settings.cpp.

664 {
665  if( !aSettings )
666  return;
667 
668  auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
669  [&aSettings]( const JSON_SETTINGS* aPtr ) {
670  return aPtr == aSettings;
671  } );
672 
673  if( it != m_nested_settings.end() )
674  {
675  wxLogTrace( traceSettings, "Flush and release %s", ( *it )->GetFilename() );
676  ( *it )->SaveToFile();
677  m_nested_settings.erase( it );
678  }
679 
680  aSettings->SetParent( nullptr );
681 }
std::vector< NESTED_SETTINGS * > m_nested_settings
Nested settings files that live inside this one, if any.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
void SetParent(JSON_SETTINGS *aParent)

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

Referenced by BOARD::ClearProject(), 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 263 of file erc_settings.cpp.

264 {
265  memcpy( m_PinMap, m_defaultPinMap, sizeof( m_PinMap ) );
266 }
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:166
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:160

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

312 {
313  for( auto param : m_params )
314  param->SetDefault();
315 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by EDA_3D_VIEWER::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 117 of file nested_settings.cpp.

118 {
119  if( !m_parent )
120  return false;
121 
122  bool modified = Store();
123 
124  try
125  {
126  nlohmann::json patch =
127  nlohmann::json::diff( *this, ( *m_parent )[PointerFromString( m_path )] );
128  modified |= !patch.empty();
129  }
130  catch( ... )
131  {
132  modified = true;
133  }
134 
135  if( !modified && !aForce )
136  return false;
137 
138  try
139  {
140  ( *m_parent )[PointerFromString( m_path ) ].update( *this );
141 
142  wxLogTrace( traceSettings, "Stored NESTED_SETTINGS %s with schema %d",
144  }
145  catch( ... )
146  {
147  wxLogTrace( traceSettings, "NESTED_SETTINGS %s: Could not store to %s at %s",
149  }
150 
151  return modified;
152 }
virtual bool Store()
Stores the current parameters into the JSON document represented by this object Note: this doesn't do...
wxString GetFilename() const
Definition: json_settings.h:64
nlohmann::json json
Definition: gerbview.cpp:39
wxString m_filename
The filename (not including path) of this settings file (inicode)
JSON_SETTINGS * m_parent
A pointer to the parent object to load and store from.
std::string m_path
The path (in pointer format) of where to store this document in the parent.
const wxChar *const traceSettings
Flag to enable debug output of settings operations and management.
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.
int m_schemaVersion
Version of this settings schema.

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

◆ Set() [1/3]

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

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

149  {
150  ( *this )[PointerFromString( aPath ) ] = aVal;
151  }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

Referenced by COLOR_MAP_PARAM::Store(), PARAM< wxString >::Store(), PARAM_PATH::Store(), PARAM_ENUM< EnumType >::Store(), PARAM_LAMBDA< nlohmann::json >::Store(), PARAM_SCALED< ValueType >::Store(), PARAM_LIST< wxString >::Store(), PARAM_PATH_LIST::Store(), PARAM_MAP< Value >::Store(), and PARAM_WXSTRING_MAP::Store().

◆ Set() [2/3]

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

◆ Set() [3/3]

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

Definition at line 695 of file json_settings.cpp.

696 {
697  ( *this )[PointerFromString( std::move( aPath ) ) ] = aVal.ToUTF8();
698 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetFilename()

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

Definition at line 68 of file json_settings.h.

68 { m_filename = aFilename; }
wxString m_filename
The filename (not including path) of this settings file (inicode)

References JSON_SETTINGS::m_filename.

Referenced by SETTINGS_MANAGER::SaveProjectAs().

◆ SetIfPresent() [1/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 507 of file json_settings.cpp.

509 {
510  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
511 
512  if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
513  {
514  aTarget = aObj.at( ptr ).get<wxString>();
515  return true;
516  }
517 
518  return false;
519 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

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

◆ SetIfPresent() [2/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 522 of file json_settings.cpp.

524 {
525  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
526 
527  if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
528  {
529  aTarget = aObj.at( ptr ).get<bool>();
530  return true;
531  }
532 
533  return false;
534 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetIfPresent() [3/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 537 of file json_settings.cpp.

539 {
540  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
541 
542  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
543  {
544  aTarget = aObj.at( ptr ).get<int>();
545  return true;
546  }
547 
548  return false;
549 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetIfPresent() [4/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 552 of file json_settings.cpp.

554 {
555  nlohmann::json::json_pointer ptr = PointerFromString( aPath );
556 
557  if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
558  {
559  aTarget = aObj.at( ptr ).get<unsigned int>();
560  return true;
561  }
562 
563  return false;
564 }
static nlohmann::json::json_pointer PointerFromString(std::string aPath)
Builds a JSON pointer based on a given string.

References JSON_SETTINGS::PointerFromString().

◆ SetLegacyFilename()

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

Definition at line 72 of file json_settings.h.

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

◆ SetManager()

void JSON_SETTINGS::SetManager ( SETTINGS_MANAGER aManager)
inlineinherited

Definition at line 188 of file json_settings.h.

189  {
190  m_manager = aManager;
191  }
SETTINGS_MANAGER * m_manager
A pointer to the settings manager managing this file (may be null)

References JSON_SETTINGS::m_manager.

◆ SetParent()

void NESTED_SETTINGS::SetParent ( JSON_SETTINGS aParent)
inherited

Definition at line 155 of file nested_settings.cpp.

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

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

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

◆ SetPinMapValue() [1/2]

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

Definition at line 137 of file erc_settings.h.

138  {
139  wxASSERT( aFirstType < ELECTRICAL_PINTYPES_TOTAL
140  && aSecondType < ELECTRICAL_PINTYPES_TOTAL );
141  m_PinMap[aFirstType][aSecondType] = aValue;
142  }
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:160
#define ELECTRICAL_PINTYPES_TOTAL
Definition: pin_type.h:51

References ELECTRICAL_PINTYPES_TOTAL, and m_PinMap.

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

◆ SetPinMapValue() [2/2]

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

Definition at line 144 of file erc_settings.h.

146  {
147  m_PinMap[static_cast<int>( aFirstType )][static_cast<int>( aSecondType )] = aValue;
148  }
PIN_ERROR m_PinMap[ELECTRICAL_PINTYPES_TOTAL][ELECTRICAL_PINTYPES_TOTAL]
Definition: erc_settings.h:160

References m_PinMap.

◆ SetReadOnly()

void JSON_SETTINGS::SetReadOnly ( bool  aReadOnly)
inlineinherited

Definition at line 75 of file json_settings.h.

75 { m_writeFile = !aReadOnly; }
bool m_writeFile
Whether or not the backing store file should be written.

References JSON_SETTINGS::m_writeFile.

Referenced by PANEL_COLOR_SETTINGS::OnThemeChanged().

◆ SetSeverity()

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

Definition at line 257 of file erc_settings.cpp.

258 {
259  m_Severities[ aErrorCode ] = aSeverity;
260 }
std::map< int, int > m_Severities
Definition: erc_settings.h:157

References m_Severities.

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

298 {
299  bool modified = false;
300 
301  for( auto param : m_params )
302  {
303  modified |= !param->MatchesFile( this );
304  param->Store( this );
305  }
306 
307  return modified;
308 }
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)

References JSON_SETTINGS::m_params.

Referenced by PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), SETTINGS_MANAGER::SaveColorSettings(), NESTED_SETTINGS::SaveToFile(), and JSON_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 306 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 300 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, WAR, OK, OK, OK, OK, ERR },
{ OK, ERR, OK, WAR, OK, WAR, OK, ERR, ERR, ERR, ERR },
{ OK, OK, OK, OK, OK, WAR, OK, WAR, OK, WAR, ERR },
{ OK, WAR, OK, OK, OK, WAR, WAR, ERR, WAR, WAR, ERR },
{ OK, OK, OK, OK, OK, WAR, OK, OK, OK, OK, ERR },
{ WAR, WAR, WAR, WAR, WAR, WAR, WAR, WAR, WAR, WAR, ERR },
{ OK, OK, OK, WAR, OK, WAR, OK, OK, OK, OK, ERR },
{ OK, ERR, WAR, ERR, OK, WAR, OK, ERR, ERR, ERR, ERR },
{ OK, ERR, OK, WAR, OK, WAR, OK, ERR, OK, OK, ERR },
{ OK, ERR, WAR, WAR, OK, WAR, OK, ERR, OK, OK, 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 166 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 312 of file json_settings.h.

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

◆ m_ErcExclusions

std::set<wxString> ERC_SETTINGS::m_ErcExclusions

◆ m_filename

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

Referenced by JSON_SETTINGS::GetLocation().

◆ m_manager

SETTINGS_MANAGER* JSON_SETTINGS::m_manager
protectedinherited

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

Definition at line 321 of file json_settings.h.

Referenced by FOOTPRINT_EDITOR_SETTINGS::migrateSchema0to1(), COLOR_SETTINGS::migrateSchema0to1(), 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 327 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 297 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, DRV, NOD, DRV, DRV, DRV, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, DRV, DRV, DRV, DRV, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, NPI },
{ NOD, DRV, NOD, NOD, NOD, NOD, NOD, DRV, NOD, NOD, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, DRV, DRV, DRV, DRV, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, NPI },
{ DRV, DRV, DRV, DRV, DRV, DRV, NOD, DRV, DRV, DRV, 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 162 of file erc_settings.h.

Referenced by GetPinMinDrive().

◆ m_preserved_paths

std::vector<nlohmann::json::json_pointer> JSON_SETTINGS::m_preserved_paths
protectedinherited

A list of JSON pointers that are preserved during a read-update-write to disk.

Definition at line 324 of file json_settings.h.

◆ 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 315 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_Severities

std::map<int, int> ERC_SETTINGS::m_Severities

◆ m_writeFile

bool JSON_SETTINGS::m_writeFile
protectedinherited

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