KiCad PCB EDA Suite
NET_SETTINGS Class Reference

NET_SETTINGS stores various net-related settings in a project context. More...

#include <net_settings.h>

Inheritance diagram for NET_SETTINGS:
NESTED_SETTINGS JSON_SETTINGS

Public Member Functions

 NET_SETTINGS (JSON_SETTINGS *aParent, const std::string &aPath)
 
virtual ~NET_SETTINGS ()
 
std::shared_ptr< NETCLASSGetEffectiveNetClass (const wxString &aNetName) 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 ParseBusVector (const wxString &aBus, wxString *aName, std::vector< wxString > *aMemberList)
 Parse a bus vector (e.g. More...
 
static bool ParseBusGroup (const wxString &aGroup, wxString *name, std::vector< wxString > *aMemberList)
 Parse a bus group label into the name and a list of components. 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< wxString, std::shared_ptr< NETCLASS > > m_NetClasses
 
std::shared_ptr< NETCLASSm_DefaultNetClass
 
std::vector< std::pair< std::unique_ptr< EDA_COMBINED_MATCHER >, wxString > > m_NetClassPatternAssignments
 
std::map< wxString, wxString > m_NetClassLabelAssignments
 
std::map< wxString, KIGFX::COLOR4Dm_NetColorAssignments
 A map of fully-qualified net names to colors used in the board context. 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
 

Private Member Functions

bool migrateSchema0to1 ()
 
bool migrateSchema2to3 ()
 

Detailed Description

NET_SETTINGS stores various net-related settings in a project context.

These settings are accessible and editable from both the schematic and PCB editors.

Definition at line 33 of file net_settings.h.

Constructor & Destructor Documentation

◆ NET_SETTINGS()

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

Definition at line 57 of file net_settings.cpp.

57 :
58 NESTED_SETTINGS( "net_settings", netSettingsSchemaVersion, aParent, aPath )
59{
60 m_DefaultNetClass = std::make_shared<NETCLASS>( NETCLASS::Default );
61 m_DefaultNetClass->SetDescription( _( "This is the default net class." ) );
62
63 auto saveNetclass =
64 []( nlohmann::json& json_array, const std::shared_ptr<NETCLASS>& nc )
65 {
66 // Note: we're in common/, but we do happen to know which of these
67 // fields are used in which units system.
68 nlohmann::json nc_json = {
69 { "name", nc->GetName().ToUTF8() },
70 { "wire_width", schIUScale.IUToMils( nc->GetWireWidth() ) },
71 { "bus_width", schIUScale.IUToMils( nc->GetBusWidth() ) },
72 { "line_style", nc->GetLineStyle() },
73 { "schematic_color", nc->GetSchematicColor() },
74 { "pcb_color", nc->GetPcbColor() }
75 };
76
77 auto saveInPcbUnits =
78 []( nlohmann::json& json, const std::string& aKey, int aValue )
79 {
80 json.push_back( { aKey, pcbIUScale.IUTomm( aValue ) } );
81 };
82
83 if( nc->HasClearance() )
84 saveInPcbUnits( nc_json, "clearance", nc->GetClearance() );
85
86 if( nc->HasTrackWidth() )
87 saveInPcbUnits( nc_json, "track_width", nc->GetTrackWidth() );
88
89 if( nc->HasViaDiameter() )
90 saveInPcbUnits( nc_json, "via_diameter", nc->GetViaDiameter() );
91
92 if( nc->HasViaDrill() )
93 saveInPcbUnits( nc_json, "via_drill", nc->GetViaDrill() );
94
95 if( nc->HasuViaDiameter() )
96 saveInPcbUnits( nc_json, "microvia_diameter", nc->GetuViaDiameter() );
97
98 if( nc->HasuViaDrill() )
99 saveInPcbUnits( nc_json, "microvia_drill", nc->GetuViaDrill() );
100
101 if( nc->HasDiffPairWidth() )
102 saveInPcbUnits( nc_json, "diff_pair_width", nc->GetDiffPairWidth() );
103
104 if( nc->HasDiffPairGap() )
105 saveInPcbUnits( nc_json, "diff_pair_gap", nc->GetDiffPairGap() );
106
107 if( nc->HasDiffPairViaGap() )
108 saveInPcbUnits( nc_json, "diff_pair_via_gap", nc->GetDiffPairViaGap() );
109
110 json_array.push_back( nc_json );
111 };
112
113 auto readNetClass =
114 []( const nlohmann::json& entry )
115 {
116 wxString name = entry["name"];
117
118 std::shared_ptr<NETCLASS> nc = std::make_shared<NETCLASS>( name );
119
120 if( auto value = getInPcbUnits( entry, "clearance" ) )
121 nc->SetClearance( *value );
122
123 if( auto value = getInPcbUnits( entry, "track_width" ) )
124 nc->SetTrackWidth( *value );
125
126 if( auto value = getInPcbUnits( entry, "via_diameter" ) )
127 nc->SetViaDiameter( *value );
128
129 if( auto value = getInPcbUnits( entry, "via_drill" ) )
130 nc->SetViaDrill( *value );
131
132 if( auto value = getInPcbUnits( entry, "microvia_diameter" ) )
133 nc->SetuViaDiameter( *value );
134
135 if( auto value = getInPcbUnits( entry, "microvia_drill" ) )
136 nc->SetuViaDrill( *value );
137
138 if( auto value = getInPcbUnits( entry, "diff_pair_width" ) )
139 nc->SetDiffPairWidth( *value );
140
141 if( auto value = getInPcbUnits( entry, "diff_pair_gap" ) )
142 nc->SetDiffPairGap( *value );
143
144 if( auto value = getInPcbUnits( entry, "diff_pair_via_gap" ) )
145 nc->SetDiffPairViaGap( *value );
146
147 nc->SetWireWidth( getInSchUnits( entry, "wire_width", nc->GetWireWidth() ) );
148 nc->SetBusWidth( getInSchUnits( entry, "bus_width", nc->GetBusWidth() ) );
149
150 if( entry.contains( "line_style" ) && entry["line_style"].is_number() )
151 nc->SetLineStyle( entry["line_style"].get<int>() );
152
153 if( entry.contains( "pcb_color" ) && entry["pcb_color"].is_string() )
154 nc->SetPcbColor( entry["pcb_color"].get<KIGFX::COLOR4D>() );
155
156 if( entry.contains( "schematic_color" )
157 && entry["schematic_color"].is_string() )
158 {
159 nc->SetSchematicColor( entry["schematic_color"].get<KIGFX::COLOR4D>() );
160 }
161
162 return nc;
163 };
164
165 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "classes",
166 [&]() -> nlohmann::json
167 {
168 nlohmann::json ret = nlohmann::json::array();
169
171 saveNetclass( ret, m_DefaultNetClass );
172
173 for( const auto& [ name, netclass ] : m_NetClasses )
174 saveNetclass( ret, netclass );
175
176 return ret;
177 },
178 [&]( const nlohmann::json& aJson )
179 {
180 if( !aJson.is_array() )
181 return;
182
183 m_NetClasses.clear();
184
185 for( const nlohmann::json& entry : aJson )
186 {
187 if( !entry.is_object() || !entry.contains( "name" ) )
188 continue;
189
190 std::shared_ptr<NETCLASS> nc = readNetClass( entry );
191
192 if( nc->GetName() == NETCLASS::Default )
194 else
195 m_NetClasses[ nc->GetName() ] = nc;
196 }
197 },
198 {} ) );
199
200 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "net_colors",
201 [&]() -> nlohmann::json
202 {
203 nlohmann::json ret = {};
204
205 for( const auto& [ netname, color ] : m_NetColorAssignments )
206 {
207 std::string key( netname.ToUTF8() );
208 ret[key] = color;
209 }
210
211 return ret;
212 },
213 [&]( const nlohmann::json& aJson )
214 {
215 if( !aJson.is_object() )
216 return;
217
218 m_NetColorAssignments.clear();
219
220 for( const auto& pair : aJson.items() )
221 {
222 wxString key( pair.key().c_str(), wxConvUTF8 );
223 m_NetColorAssignments[key] = pair.value().get<KIGFX::COLOR4D>();
224 }
225 },
226 {} ) );
227
228 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "netclass_assignments",
229 [&]() -> nlohmann::json
230 {
231 nlohmann::json ret = {};
232
233 for( const auto& [ netname, netclassName ] : m_NetClassLabelAssignments )
234 {
235 std::string key( netname.ToUTF8() );
236 ret[key] = netclassName;
237 }
238
239 return ret;
240 },
241 [&]( const nlohmann::json& aJson )
242 {
243 if( !aJson.is_object() )
244 return;
245
247
248 for( const auto& pair : aJson.items() )
249 {
250 wxString key( pair.key().c_str(), wxConvUTF8 );
251 m_NetClassLabelAssignments[key] = pair.value().get<wxString>();
252 }
253 },
254 {} ) );
255
256 m_params.emplace_back( new PARAM_LAMBDA<nlohmann::json>( "netclass_patterns",
257 [&]() -> nlohmann::json
258 {
259 nlohmann::json ret = nlohmann::json::array();
260
261 for( const auto& [ matcher, netclassName ] : m_NetClassPatternAssignments )
262 {
263 nlohmann::json pattern_json = {
264 { "pattern", matcher->GetPattern().ToUTF8() },
265 { "netclass", netclassName.ToUTF8() }
266 };
267
268 ret.push_back( pattern_json );
269 }
270
271 return ret;
272 },
273 [&]( const nlohmann::json& aJson )
274 {
275 if( !aJson.is_array() )
276 return;
277
279
280 for( const nlohmann::json& entry : aJson )
281 {
282 if( !entry.is_object() )
283 continue;
284
285 if( entry.contains( "pattern" ) && entry["pattern"].is_string()
286 && entry.contains( "netclass" ) && entry["netclass"].is_string() )
287 {
288 wxString pattern = entry["pattern"].get<wxString>();
289 wxString netclass = entry["netclass"].get<wxString>();
290
292 {
293 std::make_unique<EDA_COMBINED_MATCHER>( pattern, CTX_NETCLASS ),
294 netclass
295 } );
296 }
297 }
298 },
299 {} ) );
300
301 registerMigration( 0, 1, std::bind( &NET_SETTINGS::migrateSchema0to1, this ) );
302 registerMigration( 2, 3, std::bind( &NET_SETTINGS::migrateSchema2to3, this ) );
303}
int color
Definition: DXF_plotter.cpp:57
const char * name
Definition: DXF_plotter.cpp:56
constexpr EDA_IU_SCALE schIUScale
Definition: base_units.h:111
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:109
std::vector< PARAM_BASE * > m_params
The list of parameters (owned by this object)
void registerMigration(int aOldSchemaVersion, int aNewSchemaVersion, std::function< bool(void)> aMigrator)
Registers a migration from one schema version to another.
friend class NESTED_SETTINGS
Definition: json_settings.h:62
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
static const char Default[]
the name of the default NETCLASS
Definition: netclass.h:49
std::shared_ptr< NETCLASS > m_DefaultNetClass
Definition: net_settings.h:42
std::map< wxString, KIGFX::COLOR4D > m_NetColorAssignments
A map of fully-qualified net names to colors used in the board context.
Definition: net_settings.h:55
std::map< wxString, wxString > m_NetClassLabelAssignments
Definition: net_settings.h:47
bool migrateSchema0to1()
bool migrateSchema2to3()
std::vector< std::pair< std::unique_ptr< EDA_COMBINED_MATCHER >, wxString > > m_NetClassPatternAssignments
Definition: net_settings.h:45
std::map< wxString, std::shared_ptr< NETCLASS > > m_NetClasses
Definition: net_settings.h:41
#define _(s)
@ CTX_NETCLASS
nlohmann::json json
Definition: gerbview.cpp:44
const int netSettingsSchemaVersion
static int getInSchUnits(const nlohmann::json &aObj, const std::string &aKey, int aDefault)
static std::optional< int > getInPcbUnits(const nlohmann::json &aObj, const std::string &aKey, std::optional< int > aDefault=std::optional< int >())
constexpr double IUTomm(int iu) const
Definition: base_units.h:87
constexpr int IUToMils(int iu) const
Definition: base_units.h:100

References _, color, CTX_NETCLASS, NETCLASS::Default, getInPcbUnits(), getInSchUnits(), EDA_IU_SCALE::IUToMils(), EDA_IU_SCALE::IUTomm(), m_DefaultNetClass, m_NetClasses, m_NetClassLabelAssignments, m_NetClassPatternAssignments, m_NetColorAssignments, JSON_SETTINGS::m_params, migrateSchema0to1(), migrateSchema2to3(), name, pcbIUScale, JSON_SETTINGS::registerMigration(), and schIUScale.

◆ ~NET_SETTINGS()

NET_SETTINGS::~NET_SETTINGS ( )
virtual

Definition at line 306 of file net_settings.cpp.

307{
308 // Release early before destroying members
309 if( m_parent )
310 {
312 m_parent = nullptr;
313 }
314}
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 783 of file json_settings.cpp.

784{
785 wxLogTrace( traceSettings, wxT( "AddNestedSettings %s" ), aSettings->GetFilename() );
786 m_nested_settings.push_back( aSettings );
787}
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 842 of file json_settings.cpp.

844{
845 ResultType ret = aDefault;
846
847 try
848 {
849 if( aJson.contains( aKey ) )
850 ret = aJson.at( aKey ).get<ResultType>();
851 }
852 catch( ... )
853 {
854 }
855
856 return ret;
857}

◆ FormatAsString()

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

Definition at line 471 of file json_settings.cpp.

472{
474
475 std::stringstream buffer;
476 buffer << std::setw( 2 ) << *m_internals << std::endl;
477
478 return buffer.str();
479}
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:41
static LIB_SYMBOL * dummy()
Used to draw a dummy shape when a LIB_SYMBOL is not found in library.
Definition: sch_symbol.cpp:74

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

697{
698 ValueType val;
699
700 if( aConfig->Read( aKey, &val ) )
701 {
702 try
703 {
704 ( *m_internals )[aDest] = val;
705 }
706 catch( ... )
707 {
708 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacy!" ) );
709 return false;
710 }
711
712 return true;
713 }
714
715 return false;
716}

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

757{
758 wxString str;
759
760 if( aConfig->Read( aKey, &str ) )
761 {
763 color.SetFromWxString( str );
764
765 try
766 {
767 nlohmann::json js = nlohmann::json::array( { color.r, color.g, color.b, color.a } );
768 ( *m_internals )[aDest] = js;
769 }
770 catch( ... )
771 {
772 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyColor!" ) );
773 return false;
774 }
775
776 return true;
777 }
778
779 return false;
780}

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

733{
734 wxString str;
735
736 if( aConfig->Read( aKey, &str ) )
737 {
738 try
739 {
740 ( *m_internals )[aDest] = str.ToUTF8();
741 }
742 catch( ... )
743 {
744 wxASSERT_MSG( false, wxT( "Could not write value in fromLegacyString!" ) );
745 return false;
746 }
747
748 return true;
749 }
750
751 return false;
752}

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

814{
815 if( std::optional<nlohmann::json> opt_json = GetJson( aPath ) )
816 return wxString( opt_json->get<std::string>().c_str(), wxConvUTF8 );
817
818 return std::nullopt;
819}
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 534 of file json_settings.cpp.

535{
536 if( std::optional<nlohmann::json> ret = GetJson( aPath ) )
537 {
538 try
539 {
540 return ret->get<ValueType>();
541 }
542 catch( ... )
543 {
544 }
545 }
546
547 return std::nullopt;
548}

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

◆ GetEffectiveNetClass()

std::shared_ptr< NETCLASS > NET_SETTINGS::GetEffectiveNetClass ( const wxString &  aNetName) const

Definition at line 372 of file net_settings.cpp.

373{
374 auto getNetclass =
375 [&]( const wxString& netclass )
376 {
377 auto ii = m_NetClasses.find( netclass );
378
379 if( ii == m_NetClasses.end() )
380 return m_DefaultNetClass;
381 else
382 return ii->second;
383 };
384
385 auto it = m_NetClassLabelAssignments.find( aNetName );
386
387 if( it != m_NetClassLabelAssignments.end() )
388 return getNetclass( it->second );
389
390 for( const auto& [ matcher, netclassName ] : m_NetClassPatternAssignments )
391 {
392 int matches;
393 int offset;
394
395 if( matcher->Find( aNetName, matches, offset ) && offset == 0 )
396 return getNetclass( netclassName );
397 }
398
399 return m_DefaultNetClass;
400}

References m_DefaultNetClass, m_NetClasses, m_NetClassLabelAssignments, and m_NetClassPatternAssignments.

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

515{
516 nlohmann::json::json_pointer ptr = m_internals->PointerFromString( aPath );
517
518 if( m_internals->contains( ptr ) )
519 {
520 try
521 {
522 return std::optional<nlohmann::json>{ m_internals->at( ptr ) };
523 }
524 catch( ... )
525 {
526 }
527 }
528
529 return std::optional<nlohmann::json>{};
530}

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

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

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

483{
484 try
485 {
486 wxFFileInputStream fp( aPath, wxT( "rt" ) );
487 wxStdInputStream fstream( fp );
488
489 if( fp.IsOk() )
490 {
491 *static_cast<nlohmann::json*>( m_internals.get() ) =
492 nlohmann::json::parse( fstream, nullptr,
493 /* allow_exceptions = */ true,
494 /* ignore_comments = */ true );
495 }
496 else
497 {
498 return false;
499 }
500 }
501 catch( nlohmann::json::parse_error& error )
502 {
503 wxLogTrace( traceSettings, wxT( "Json parse error reading %s: %s" ), aPath, error.what() );
504
505 return false;
506 }
507
508 // Now that we have new data in the JSON structure, load the params again
509 Load();
510 return true;
511}
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 592 of file json_settings.cpp.

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

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

References traceSettings.

Referenced by JSON_SETTINGS::LoadFromFile().

◆ migrateSchema0to1()

bool NET_SETTINGS::migrateSchema0to1 ( )
private

Definition at line 317 of file net_settings.cpp.

318{
319 if( m_internals->contains( "classes" ) && m_internals->At( "classes" ).is_array() )
320 {
321 for( auto& netClass : m_internals->At( "classes" ).items() )
322 {
323 if( netClass.value().contains( "nets" ) && netClass.value()["nets"].is_array() )
324 {
325 nlohmann::json migrated = nlohmann::json::array();
326
327 for( auto& net : netClass.value()["nets"].items() )
328 migrated.push_back( ConvertToNewOverbarNotation( net.value().get<wxString>() ) );
329
330 netClass.value()["nets"] = migrated;
331 }
332 }
333 }
334
335 return true;
336}
wxString ConvertToNewOverbarNotation(const wxString &aOldStr)
Convert the old ~...~ overbar notation to the new ~{...} one.

References ConvertToNewOverbarNotation(), and JSON_SETTINGS::m_internals.

Referenced by NET_SETTINGS().

◆ migrateSchema2to3()

bool NET_SETTINGS::migrateSchema2to3 ( )
private

Definition at line 339 of file net_settings.cpp.

340{
341 if( m_internals->contains( "classes" ) && m_internals->At( "classes" ).is_array() )
342 {
343 nlohmann::json patterns = nlohmann::json::array();
344
345 for( auto& netClass : m_internals->At( "classes" ).items() )
346 {
347 if( netClass.value().contains( "name" )
348 && netClass.value().contains( "nets" )
349 && netClass.value()["nets"].is_array() )
350 {
351 wxString netClassName = netClass.value()["name"].get<wxString>();
352
353 for( auto& net : netClass.value()["nets"].items() )
354 {
355 nlohmann::json pattern_json = {
356 { "pattern", net.value().get<wxString>() },
357 { "netclass", netClassName }
358 };
359
360 patterns.push_back( pattern_json );
361 }
362 }
363 }
364
365 m_internals->SetFromString( "netclass_patterns", patterns );
366 }
367
368 return true;
369}

References JSON_SETTINGS::m_internals.

Referenced by NET_SETTINGS().

◆ ParseBusGroup()

bool NET_SETTINGS::ParseBusGroup ( const wxString &  aGroup,
wxString *  name,
std::vector< wxString > *  aMemberList 
)
static

Parse a bus group label into the name and a list of components.

Parameters
aGroupis the input label, e.g. "USB{DP DM}"
nameis the output group name, e.g. "USB"
aMemberListis a list of member strings, e.g. "DP", "DM"
Returns
true if aGroup was successfully parsed

Definition at line 540 of file net_settings.cpp.

542{
543 size_t groupLen = aGroup.length();
544 size_t i = 0;
545 wxString prefix;
546 wxString tmp;
547 int braceNesting = 0;
548
549 prefix.reserve( groupLen );
550
551 // Parse prefix
552 //
553 for( ; i < groupLen; ++i )
554 {
555 if( aGroup[i] == '{' )
556 {
557 if( i > 0 && isSuperSubOverbar( aGroup[i-1] ) )
558 braceNesting++;
559 else
560 break;
561 }
562 else if( aGroup[i] == '}' )
563 {
564 braceNesting--;
565 }
566
567 if( aGroup[i] == ' ' || aGroup[i] == '[' || aGroup[i] == ']' )
568 return false;
569
570 prefix += aGroup[i];
571 }
572
573 if( braceNesting != 0 )
574 return false;
575
576 if( aName )
577 *aName = prefix;
578
579 // Parse members
580 //
581 i++; // '{' character
582
583 if( i >= groupLen )
584 return false;
585
586 for( ; i < groupLen; ++i )
587 {
588 if( aGroup[i] == '{' )
589 {
590 if( i > 0 && isSuperSubOverbar( aGroup[i-1] ) )
591 braceNesting++;
592 else
593 return false;
594 }
595 else if( aGroup[i] == '}' )
596 {
597 if( braceNesting )
598 {
599 braceNesting--;
600 }
601 else
602 {
603 if( aMemberList && !tmp.IsEmpty() )
604 aMemberList->push_back( EscapeString( tmp, CTX_NETNAME ) );
605
606 return true;
607 }
608 }
609
610 // Commas aren't strictly legal, but we can be pretty sure what the author had in mind.
611 if( aGroup[i] == ' ' || aGroup[i] == ',' )
612 {
613 if( aMemberList && !tmp.IsEmpty() )
614 aMemberList->push_back( EscapeString( tmp, CTX_NETNAME ) );
615
616 tmp.Clear();
617 continue;
618 }
619
620 tmp += aGroup[i];
621 }
622
623 return false;
624}
static bool isSuperSubOverbar(wxChar c)
wxString EscapeString(const wxString &aSource, ESCAPE_CONTEXT aContext)
The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are:...
@ CTX_NETNAME
Definition: string_utils.h:54

References CTX_NETNAME, EscapeString(), and isSuperSubOverbar().

Referenced by SCH_CONNECTION::AppendInfoToMsgPanel(), SCH_EDITOR_CONTROL::AssignNetclass(), SCH_EDIT_TOOL::ChangeTextType(), SCH_CONNECTION::ConfigureFromLabel(), SCH_CONNECTION::IsBusLabel(), and SCH_NETNAME_VALIDATOR::IsValid().

◆ ParseBusVector()

bool NET_SETTINGS::ParseBusVector ( const wxString &  aBus,
wxString *  aName,
std::vector< wxString > *  aMemberList 
)
static

Parse a bus vector (e.g.

A[7..0]) into name, begin, and end.

Ensure that begin and end are positive and that end > begin.

Parameters
aBusis a bus vector label string
aNameout is the bus name, e.g. "A"
aMemberListis a list of member strings, e.g. "A7", "A6", and so on
Returns
true if aBus was successfully parsed

Definition at line 409 of file net_settings.cpp.

411{
412 auto isDigit = []( wxChar c )
413 {
414 static wxString digits( wxT( "0123456789" ) );
415 return digits.Contains( c );
416 };
417
418 size_t busLen = aBus.length();
419 size_t i = 0;
420 wxString prefix;
421 wxString suffix;
422 wxString tmp;
423 long begin = 0;
424 long end = 0;
425 int braceNesting = 0;
426
427 prefix.reserve( busLen );
428
429 // Parse prefix
430 //
431 for( ; i < busLen; ++i )
432 {
433 if( aBus[i] == '{' )
434 {
435 if( i > 0 && isSuperSubOverbar( aBus[i-1] ) )
436 braceNesting++;
437 else
438 return false;
439 }
440 else if( aBus[i] == '}' )
441 {
442 braceNesting--;
443 }
444
445 if( aBus[i] == ' ' || aBus[i] == ']' )
446 return false;
447
448 if( aBus[i] == '[' )
449 break;
450
451 prefix += aBus[i];
452 }
453
454 // Parse start number
455 //
456 i++; // '[' character
457
458 if( i >= busLen )
459 return false;
460
461 for( ; i < busLen; ++i )
462 {
463 if( aBus[i] == '.' && i + 1 < busLen && aBus[i+1] == '.' )
464 {
465 tmp.ToLong( &begin );
466 i += 2;
467 break;
468 }
469
470 if( !isDigit( aBus[i] ) )
471 return false;
472
473 tmp += aBus[i];
474 }
475
476 // Parse end number
477 //
478 tmp = wxEmptyString;
479
480 if( i >= busLen )
481 return false;
482
483 for( ; i < busLen; ++i )
484 {
485 if( aBus[i] == ']' )
486 {
487 tmp.ToLong( &end );
488 ++i;
489 break;
490 }
491
492 if( !isDigit( aBus[i] ) )
493 return false;
494
495 tmp += aBus[i];
496 }
497
498 // Parse suffix
499 //
500 for( ; i < busLen; ++i )
501 {
502 if( aBus[i] == '}' )
503 {
504 braceNesting--;
505 suffix += aBus[i];
506 }
507 else
508 {
509 return false;
510 }
511 }
512
513 if( braceNesting != 0 )
514 return false;
515
516 if( begin == end )
517 return false;
518 else if( begin > end )
519 std::swap( begin, end );
520
521 if( aName )
522 *aName = prefix;
523
524 if( aMemberList )
525 {
526 for( long idx = begin; idx <= end; ++idx )
527 {
528 wxString str = prefix;
529 str << idx;
530 str << suffix;
531
532 aMemberList->emplace_back( str );
533 }
534 }
535
536 return true;
537}
bool isDigit(char cc)
Definition: dsnlexer.cpp:447

References isDigit(), and isSuperSubOverbar().

Referenced by SCH_EDITOR_CONTROL::AssignNetclass(), SCH_CONNECTION::ConfigureFromLabel(), SCH_CONNECTION::IsBusLabel(), SCH_NETNAME_VALIDATOR::IsValid(), and SCH_EAGLE_PLUGIN::translateEagleBusName().

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

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

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

791{
792 if( !aSettings || !m_manager )
793 return;
794
795 auto it = std::find_if( m_nested_settings.begin(), m_nested_settings.end(),
796 [&aSettings]( const JSON_SETTINGS* aPtr ) {
797 return aPtr == aSettings;
798 } );
799
800 if( it != m_nested_settings.end() )
801 {
802 wxLogTrace( traceSettings, wxT( "Flush and release %s" ), ( *it )->GetFilename() );
803 ( *it )->SaveToFile();
804 m_nested_settings.erase( it );
805 }
806
807 aSettings->SetParent( nullptr );
808}
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::~ERC_SETTINGS(), NESTED_SETTINGS::~NESTED_SETTINGS(), ~NET_SETTINGS(), and SCHEMATIC_SETTINGS::~SCHEMATIC_SETTINGS().

◆ ResetToDefaults()

void JSON_SETTINGS::ResetToDefaults ( )
inherited

Resets all parameters to default values.

Does NOT write to file or update underlying JSON.

Definition at line 364 of file json_settings.cpp.

365{
366 for( auto param : m_params )
367 param->SetDefault();
368}

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, "Stored NESTED_SETTINGS %s with schema %d",
138 GetFilename(),
140 }
141
142 return modified;
143 }
144 catch( ... )
145 {
146 wxLogTrace( traceSettings, "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 564 of file json_settings.cpp.

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

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

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

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

651{
652 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
653
654 if( aObj.contains( ptr ) && aObj.at( ptr ).is_boolean() )
655 {
656 aTarget = aObj.at( ptr ).get<bool>();
657 return true;
658 }
659
660 return false;
661}

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

666{
667 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
668
669 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_integer() )
670 {
671 aTarget = aObj.at( ptr ).get<int>();
672 return true;
673 }
674
675 return false;
676}

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

681{
682 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
683
684 if( aObj.contains( ptr ) && aObj.at( ptr ).is_number_unsigned() )
685 {
686 aTarget = aObj.at( ptr ).get<unsigned int>();
687 return true;
688 }
689
690 return false;
691}

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

636{
637 nlohmann::json::json_pointer ptr = JSON_SETTINGS_INTERNALS::PointerFromString( aPath );
638
639 if( aObj.contains( ptr ) && aObj.at( ptr ).is_string() )
640 {
641 aTarget = aObj.at( ptr ).get<wxString>();
642 return true;
643 }
644
645 return false;
646}

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

◆ SetReadOnly()

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

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

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_DefaultNetClass

std::shared_ptr<NETCLASS> NET_SETTINGS::m_DefaultNetClass

Definition at line 42 of file net_settings.h.

Referenced by GetEffectiveNetClass(), and NET_SETTINGS().

◆ 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_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_NetClasses

std::map<wxString, std::shared_ptr<NETCLASS> > NET_SETTINGS::m_NetClasses

Definition at line 41 of file net_settings.h.

Referenced by GetEffectiveNetClass(), and NET_SETTINGS().

◆ m_NetClassLabelAssignments

std::map<wxString, wxString> NET_SETTINGS::m_NetClassLabelAssignments

Definition at line 47 of file net_settings.h.

Referenced by GetEffectiveNetClass(), and NET_SETTINGS().

◆ m_NetClassPatternAssignments

std::vector<std::pair<std::unique_ptr<EDA_COMBINED_MATCHER>, wxString> > NET_SETTINGS::m_NetClassPatternAssignments

Definition at line 45 of file net_settings.h.

Referenced by GetEffectiveNetClass(), and NET_SETTINGS().

◆ m_NetColorAssignments

std::map<wxString, KIGFX::COLOR4D> NET_SETTINGS::m_NetColorAssignments

A map of fully-qualified net names to colors used in the board context.

Since these color overrides are for the board, buses are not included here. Only nets that the user has assigned custom colors to will be in this list. Nets that no longer exist will be deleted during a netlist read in Pcbnew.

Definition at line 55 of file net_settings.h.

Referenced by NET_SETTINGS().

◆ 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_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: